Fix to typedefs for Typescript 2.7 by runningskull · Pull Request #637 · mobxjs/mobx-state-tree

runningskull · 2018-02-02T19:27:48Z

Related to #629 and #635.

These changes compile using the latest typescript (usingnpm run quick-build) but I don't know enough to know if they're correct or if a there's a better alternative.

runningskull · 2018-02-02T19:30:07Z

packages/mobx-state-tree/src/types/complex-types/model.ts

    const properties = args.shift() || {}
-    return new ModelType({ name, properties })
+    const config = {name: (name as string), properties} as ModelTypeConfig
+    return new ModelType(config)


This and above fixes the error: src/types/complex-types/model.ts(483,17): error TS2394: Overload signature is not compatible with function implementation.

You may simply change
export function model(...args: any[]) {
to
export function model(...args: any[]): IModelType<Snapshot<any>, any> {

runningskull · 2018-02-02T19:30:23Z

packages/mobx-state-tree/src/utils.ts

        const current = b[i]
        for (let key in current) {
-            const descriptor = Object.getOwnPropertyDescriptor(current, key)
+            const descriptor = Object.getOwnPropertyDescriptor(current, key) || {}


This fixes the error src/utils.ts(55,26): error TS2532: Object is possibly 'undefined'.

you may also do:
if (descriptor && "get" in descriptor) {

runningskull · 2018-02-02T19:30:36Z

packages/mobx-state-tree/src/types/complex-types/model.ts

    props<SP, TP>(
        properties: { [K in keyof TP]: IType<any, TP[K]> } & { [K in keyof SP]: IType<SP[K], any> }
-    ): IModelType<S & SP, T & TP> {
+    ): IModelType<S & SP & Snapshot<SP>, T & TP> {


Solution from #635

https://github.com/runningskull/mobx-state-tree/blob/0812fa2771659ef1e8819040d3b78266a130733c/packages/mobx-state-tree/src/types/complex-types/model.ts#L454-L463

I have no idea why,
But uncommenting the additional props declaration also fix this issue

(done in latest commit)

@mweststrate wdys?

I have the impression that property types are broken completely with TS 2.7, are you guys experiencing the same? I mean even x: types.number get's infered to x: any on the IModelType. Maybe we should just wait for TS 2.8 where we can fix this properly? cc @mattiamanzati

@mweststrate
check this out
http://www.typescriptlang.org/play/#src=type%20IModelProperties%3CT%3E%20%3D%20%7B%20%5BK%20in%20keyof%20T%5D%3A%20T%5BK%5D%20%7D%0D%0Afunction%20inferer%3CT%3E(properties%3A%20IModelProperties%3CT%3E)%3A%20IModelProperties%3CT%3E%20%7B%0D%0A%20%20%20%20return%20properties%0D%0A%7D%0D%0A%0D%0A%2F%2F%20if%20you%20hover%20a%20you%20will%20see%20that%20prop1%20and%20prop2%20are%20inferred%20as%20any%0D%0Aconst%20a%20%3D%20inferer(%7B%0D%0A%20%20%20%20prop1%3A%20%22asd%22%2C%0D%0A%20%20%20%20prop2%3A%201%0D%0A%7D)%3B%0D%0A%0D%0Atype%20IMGOODTYPE%20%3D%20IModelProperties%3C%7B%20a%3A%20string%20%7D%3E%3B%0D%0A%2F%2F%20but%20here%2C%20the%20original%20type%20of%20prop1%20and%20prop2%20are%20restored%20%0D%0Atype%20imgoodTYPEEevenahasbadone%20%3D%20typeof%20a%3B

type IModelProperties<T> = { [K in keyof T]: T[K] }; function inferer<T>(properties: IModelProperties<T>): IModelProperties<T> { return properties; } // if you hover a you will see that prop1 and prop2 are: // inferred as any on typescript 2.7.1 // inferred as string and number on typescript 2.6.2 const a = inferer({ prop1: "asd", prop2: 1, }); type IMGOODTYPE = IModelProperties<{ a: string }>; // but here, the original type of prop1 and prop2 are restored, // even in typescript 2.7.1 type imgoodTYPEEevenahasbadone = typeof a;

Bnaya · 2018-02-03T00:02:41Z

packages/mobx-state-tree/package.json

    "tslib": "^1.7.1",
    "tslint": "^3.15.1",
-    "typescript": "^2.4.2"
+    "typescript": "^2.7.1"


Its a yarn project,
You'll need to upgrade via yarn for the lock file to be updated

(done in latest commit)

Bnaya · 2018-02-03T00:15:25Z

packages/mobx-state-tree/src/types/complex-types/model.ts

    const properties = args.shift() || {}
-    return new ModelType({ name, properties })
+    const config = {name: (name as string), properties} as ModelTypeConfig
+    return new ModelType(config)


You may simply change
export function model(...args: any[]) {
to
export function model(...args: any[]): IModelType<Snapshot<any>, any> {

Bnaya · 2018-02-03T00:18:15Z

packages/mobx-state-tree/src/utils.ts

        const current = b[i]
        for (let key in current) {
-            const descriptor = Object.getOwnPropertyDescriptor(current, key)
+            const descriptor = Object.getOwnPropertyDescriptor(current, key) || {}


you may also do:
if (descriptor && "get" in descriptor) {

Bnaya · 2018-02-03T00:31:09Z

packages/mobx-state-tree/src/types/complex-types/model.ts

    props<SP, TP>(
        properties: { [K in keyof TP]: IType<any, TP[K]> } & { [K in keyof SP]: IType<SP[K], any> }
-    ): IModelType<S & SP, T & TP> {
+    ): IModelType<S & SP & Snapshot<SP>, T & TP> {


https://github.com/runningskull/mobx-state-tree/blob/0812fa2771659ef1e8819040d3b78266a130733c/packages/mobx-state-tree/src/types/complex-types/model.ts#L454-L463

I have no idea why,
But uncommenting the additional props declaration also fix this issue

mweststrate · 2018-02-05T14:46:20Z

Hey @runningskull, what is the status of this PR?

runningskull · 2018-02-07T03:55:38Z

Hey @mweststrate sorry for the delay. I just pushed up the solutions that @Bnaya recommended.

Building works great, but it looks like the tests are still failing due to some problem w/ type definitions, but I'm not exactly sure why. I can investigate some more later, but perhaps you'll know straight away: I put some details about it at runningskull#1

abelkbil · 2018-02-08T05:05:21Z

@runningskull @Bnaya How this issue is fixed. I use version 1.3.1. I get same issue. What should I do

mweststrate · 2018-03-07T19:12:58Z

Closing this, in favor of #667 which seemed to behave more consistently when trying out. Thanks for the investigation though! And let's hope 2.8 lands soon :)

runningskull commented Feb 2, 2018

View reviewed changes

Bnaya reviewed Feb 3, 2018

View reviewed changes

fix to typedefs for Typescript 2.7

49f5915

runningskull force-pushed the ts2.7-typedef-fix branch from 0812fa2 to 49f5915 Compare February 7, 2018 03:28

ianschmitz mentioned this pull request Mar 5, 2018

Typescript 2.7-rc compilation errors #629

Closed

mweststrate closed this Mar 7, 2018

Conversation

runningskull commented Feb 2, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mweststrate commented Feb 5, 2018

Uh oh!

runningskull commented Feb 7, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

abelkbil commented Feb 8, 2018

Uh oh!

mweststrate commented Mar 7, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Comments

runningskull commented Feb 2, 2018 •

edited

Loading

runningskull commented Feb 7, 2018 •

edited

Loading