mobx 6.0.0 → 6.0.4

package/dist/utils/utils.d.ts

@@ -30,7 +30,7 @@ export declare function isGenerator(obj: any): boolean;
 export declare function addHiddenProp(object: any, propName: PropertyKey, value: any): void;
 export declare function addHiddenFinalProp(object: any, propName: PropertyKey, value: any): void;
 export declare function assertPropertyConfigurable(object: any, prop: PropertyKey): void;
-export declare function createInstanceofPredicate<T>(name: string, clazz: new (...args: any[]) => T): (x: any) => x is T;
+export declare function createInstanceofPredicate<T>(name: string, theClass: new (...args: any[]) => T): (x: any) => x is T;
 export declare function isES6Map(thing: any): boolean;
 export declare function isES6Set(thing: any): thing is Set<any>;
 /**

package/package.json

@@ -1,143 +1,77 @@
 {
-  "name": "mobx",
-  "version": "6.0.0",
-  "description": "Simple, scalable state management.",
-  "main": "dist/index.js",
-  "module": "dist/mobx.esm.js",
-  "umd:main": "dist/mobx.umd.production.min.js",
-  "unpkg": "dist/mobx.umd.production.min.js",
-  "jsnext:main": "dist/mobx.esm.js",
-  "react-native": "dist/mobx.esm.js",
-  "source": "src/mobx.ts",
-  "typings": "dist/mobx.d.ts",
-  "sideEffects": false,
-  "scripts": {
-    "test": "jest",
-    "lint": "eslint src/**/*.ts",
-    "watch": "jest --watch",
-    "perf": "yarn build && yarn test:performance proxy && yarn test:performance legacy",
-    "test:mixed-versions": "jest --testRegex mixed-versions",
-    "test:check": "yarn test:types && yarn lint",
-    "test:types": "tsc --noEmit && yarn test:flow",
-    "test:flow": "yarn build && flow check",
-    "test:coverage": "yarn test -i --coverage",
-    "test:performance": "PERSIST=true time node --expose-gc test/perf/index.js",
-    "test:size": "yarn build && yarn import-size --report . observable computed autorun action",
-    "test:codemod": "cd packages/mobx-undecorate && yarn test",
-    "prettier": "prettier --write **/*.{js,ts,md}",
-    "prebuild": "rimraf lib",
-    "build": "tsdx build --name mobx --format esm,cjs,umd",
-    "postbuild": "cp flow-typed/mobx.js dist/index.js.flow",
-    "release": "node scripts/publish.js",
-    "publish-script": "yarn release",
-    "docs:build": "yarn --cwd website build",
-    "docs:start": "yarn --cwd website start",
-    "docs:publish": "yarn --cwd website publish-gh-pages",
-    "prepare": "yarn dedup && yarn --cwd website install",
-    "dedup": "npx yarn-deduplicate --strategy fewer yarn.lock"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/mobxjs/mobx.git"
-  },
-  "author": "Michel Weststrate",
-  "license": "MIT",
-  "funding": {
-    "type": "opencollective",
-    "url": "https://opencollective.com/mobx"
-  },
-  "bugs": {
-    "url": "https://github.com/mobxjs/mobx/issues"
-  },
-  "files": [
-    "src",
-    "dist",
-    "LICENSE",
-    "README.md"
-  ],
-  "homepage": "https://mobx.js.org/",
-  "dependencies": {},
-  "devDependencies": {
-    "@babel/core": "^7.9.0",
-    "@babel/plugin-proposal-class-properties": "^7.8.3",
-    "@babel/plugin-proposal-decorators": "^7.8.3",
-    "@babel/plugin-transform-runtime": "^7.9.0",
-    "@babel/preset-env": "^7.9.5",
-    "@babel/preset-typescript": "^7.9.0",
-    "@babel/runtime": "^7.9.2",
-    "@types/jest": "^25.2.1",
-    "@types/node": "^11.15.12",
-    "@typescript-eslint/eslint-plugin": "^2.29.0",
-    "@typescript-eslint/parser": "^4.1.1",
-    "babel-jest": "^25.4.0",
-    "conditional-type-checks": "^1.0.5",
-    "coveralls": "^3.1.0",
-    "eslint": "^6.8.0",
-    "flow-bin": "^0.123.0",
-    "husky": "^4.2.5",
-    "import-size": "^1.0.2",
-    "iterall": "^1.3.0",
-    "jest": "^25.4.0",
-    "jscodeshift": "^0.7.0",
-    "lint-staged": "^10.1.7",
-    "prettier": "^2.0.5",
-    "pretty-quick": "2.0.1",
-    "prompts": "^2.3.2",
-    "semver": "^7.3.2",
-    "serializr": "^2.0.3",
-    "shelljs": "^0.8.4",
-    "tape": "^5.0.0",
-    "ts-jest": "^25.4.0",
-    "tsdx": "^0.13.2",
-    "typescript": "^4.0.2"
-  },
-  "keywords": [
-    "mobx",
-    "mobservable",
-    "observable",
-    "react-component",
-    "react",
-    "reactjs",
-    "reactive",
-    "model",
-    "frp",
-    "functional-reactive-programming",
-    "state management",
-    "data flow"
-  ],
-  "jest": {
-    "globals": {
-      "__DEV__": true,
-      "ts-jest": {
-        "tsConfig": "tsconfig.test.json"
-      }
-    },
-    "setupFilesAfterEnv": [
-      "<rootDir>/test/setup.js"
+    "name": "mobx",
+    "version": "6.0.4",
+    "description": "Simple, scalable state management.",
+    "source": "src/mobx.ts",
+    "main": "dist/index.js",
+    "umd:main": "dist/mobx.umd.production.min.js",
+    "unpkg": "dist/mobx.umd.production.min.js",
+    "jsdelivr": "dist/mobx.umd.production.min.js",
+    "jsnext:main": "dist/mobx.esm.production.min.js",
+    "module": "dist/mobx.esm.js",
+    "react-native": "dist/mobx.esm.js",
+    "types": "dist/mobx.d.ts",
+    "typings": "dist/mobx.d.ts",
+    "files": [
+        "src",
+        "dist",
+        "LICENSE",
+        "CHANGELOG.md",
+        "README.md"
     ],
-    "transform": {
-      "^.+\\.tsx?$": "ts-jest",
-      "^.+\\.jsx?$": "babel-jest"
+    "sideEffects": false,
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/mobxjs/mobx.git"
     },
-    "testRegex": "test/v[4|5]/base/.*\\.(t|j)sx?$",
-    "moduleFileExtensions": [
-      "ts",
-      "tsx",
-      "js",
-      "jsx",
-      "json"
-    ],
-    "testPathIgnorePatterns": [
-      "/node_modules/",
-      "/\\./"
+    "author": "Michel Weststrate",
+    "license": "MIT",
+    "funding": {
+        "type": "opencollective",
+        "url": "https://opencollective.com/mobx"
+    },
+    "bugs": {
+        "url": "https://github.com/mobxjs/mobx/issues"
+    },
+    "homepage": "https://mobx.js.org/",
+    "dependencies": {},
+    "devDependencies": {
+        "@babel/core": "^7.9.0",
+        "@babel/plugin-proposal-class-properties": "^7.8.3",
+        "@babel/plugin-proposal-decorators": "^7.8.3",
+        "@babel/plugin-transform-runtime": "^7.9.0",
+        "@babel/preset-env": "^7.9.5",
+        "@babel/preset-typescript": "^7.9.0",
+        "@babel/runtime": "^7.9.2",
+        "conditional-type-checks": "^1.0.5",
+        "flow-bin": "^0.123.0"
+    },
+    "keywords": [
+        "mobx",
+        "mobservable",
+        "observable",
+        "react-component",
+        "react",
+        "reactjs",
+        "reactive",
+        "model",
+        "frp",
+        "functional-reactive-programming",
+        "state management",
+        "data flow"
     ],
-    "watchPathIgnorePatterns": [
-      "<rootDir>/node_modules/"
-    ]
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "pretty-quick --staged"
+    "scripts": {
+        "test": "jest",
+        "lint": "eslint src/**/*",
+        "build": "node ../../scripts/build.js mobx",
+        "build:test": "yarn build --target test",
+        "perf": "scripts/perf.sh",
+        "test:performance": "yarn perf proxy && yarn perf legacy",
+        "test:mixed-versions": "yarn test --testRegex mixed-versions",
+        "test:types": "tsc --noEmit",
+        "test:flow": "flow check",
+        "test:coverage": "yarn test -i --coverage",
+        "test:size": "yarn import-size --report . observable computed autorun action",
+        "prepublish": "node ./scripts/prepublish.js && yarn build --target publish"
     }
-  }
-}
+}

package/src/api/annotation.ts

@@ -22,6 +22,6 @@ export type AnnotationMapEntry =
 // AdditionalFields can be used to declare additional keys that can be used, for example to be able to
 // declare annotations for private/ protected members, see #2339
 export type AnnotationsMap<T, AdditionalFields extends PropertyKey> = {
-    [P in keyof T]?: AnnotationMapEntry
+    [P in Exclude<keyof T, "toString">]?: AnnotationMapEntry
 } &
     Record<AdditionalFields, AnnotationMapEntry>

package/src/api/makeObservable.ts

@@ -91,7 +91,7 @@ export function makeProperty(
 ): void {
     const { target_: target } = adm
     const defaultAnnotation: Annotation | undefined = observable // ideally grap this from adm's defaultEnahncer instead!
-    const origAnnotation = annotation
+    const originAnnotation = annotation
     if (annotation === true) {
         annotation = getInferredAnnotation(descriptor, defaultAnnotation, autoBind)
     }
@@ -162,9 +162,9 @@ export function makeProperty(
                 die(
                     `Cannot decorate '${key.toString()}': observable cannot be used on setter / getter properties.`
                 )
-            // if the origAnnotation was true, preferred the adm's default enhancer over the inferred one
+            // if the originAnnotation was true, preferred the adm's default enhancer over the inferred one
             const enhancer =
-                origAnnotation === true
+                originAnnotation === true
                     ? adm.defaultEnhancer_
                     : getEnhancerFromAnnotation(annotation)
             adm.addObservableProp_(key, descriptor.value, enhancer)
@@ -182,7 +182,7 @@ export function makeProperty(
 
 // Hack based on https://github.com/Microsoft/TypeScript/issues/14829#issuecomment-322267089
 // We need this, because otherwise, AdditionalKeys is going to be inferred to be any
-// set of superfluos keys. But, we rather want to get a compile error unless AdditionalKeys is
+// set of superfluous keys. But, we rather want to get a compile error unless AdditionalKeys is
 // _explicity_ passed as generic argument
 // Fixes: https://github.com/mobxjs/mobx/issues/2325#issuecomment-691070022
 type NoInfer<T> = [T][T extends any ? 0 : never]
@@ -222,7 +222,7 @@ export function makeObservable<T, AdditionalKeys extends PropertyKey = never>(
 
 export function makeAutoObservable<T extends Object, AdditionalKeys extends PropertyKey = never>(
     target: T,
-    excludes?: AnnotationsMap<T, NoInfer<AdditionalKeys>>,
+    overrides?: AnnotationsMap<T, NoInfer<AdditionalKeys>>,
     options?: CreateObservableOptions
 ): T {
     const proto = Object.getPrototypeOf(target)
@@ -238,7 +238,7 @@ export function makeAutoObservable<T extends Object, AdditionalKeys extends Prop
         // shortcut, reuse inferred annotations for this type from the previous time
         annotations = proto[CACHED_ANNOTATIONS] as any
     } else {
-        annotations = { ...excludes }
+        annotations = { ...overrides }
         extractAnnotationsFromObject(target, annotations, options)
         if (!isPlain) {
             extractAnnotationsFromProto(proto, annotations, options)
@@ -255,9 +255,12 @@ function extractAnnotationsFromObject(
     options: CreateObservableOptions | undefined
 ) {
     const autoBind = !!options?.autoBind
-    const defaultAnnotation: Annotation = options?.deep
-        ? observable.deep
-        : options?.defaultDecorator ?? observable.deep
+    const defaultAnnotation: Annotation =
+        options?.deep === undefined
+            ? options?.defaultDecorator ?? observable.deep
+            : options?.deep
+            ? observable.deep
+            : observable.ref
     Object.entries(getOwnPropertyDescriptors(target)).forEach(([key, descriptor]) => {
         if (key in collector || key === "constructor") return
         collector[key] = getInferredAnnotation(descriptor, defaultAnnotation, autoBind)

package/src/core/action.ts

@@ -85,7 +85,7 @@ export interface IActionRunInfo {
 
 export function _startAction(
     actionName: string,
-    canRunAsDeriviation: boolean, // true for autoAction
+    canRunAsDerivation: boolean, // true for autoAction
     scope: any,
     args?: IArguments
 ): IActionRunInfo {
@@ -93,16 +93,16 @@ export function _startAction(
     let startTime_: number = 0
     if (__DEV__ && notifySpy_) {
         startTime_ = Date.now()
-        const flattendArgs = args ? Array.from(args) : EMPTY_ARRAY
+        const flattenedArgs = args ? Array.from(args) : EMPTY_ARRAY
         spyReportStart({
             type: ACTION,
             name: actionName,
             object: scope,
-            arguments: flattendArgs
+            arguments: flattenedArgs
         })
     }
     const prevDerivation_ = globalState.trackingDerivation
-    const runAsAction = !canRunAsDeriviation || !prevDerivation_
+    const runAsAction = !canRunAsDerivation || !prevDerivation_
     startBatch()
     let prevAllowStateChanges_ = globalState.allowStateChanges // by default preserve previous allow
     if (runAsAction) {

package/src/core/computedvalue.ts

@@ -109,7 +109,7 @@ export class ComputedValue<T> implements IObservable, IComputedValue<T>, IDeriva
      *
      * The `equals` property specifies the comparer function to use to determine if a newly produced
      * value differs from the previous value. Two comparers are provided in the library; `defaultComparer`
-     * compares based on identity comparison (===), and `structualComparer` deeply compares the structure.
+     * compares based on identity comparison (===), and `structuralComparer` deeply compares the structure.
      * Structural comparison can be convenient if you always produce a new aggregated object and
      * don't want to notify observers if it is structurally the same.
      * This is useful for working with vectors, mouse coordinates etc.

package/src/types/observableobject.ts

@@ -324,9 +324,14 @@ export function asObservableObject(
 
     if (__DEV__ && !Object.isExtensible(target))
         die("Cannot make the designated object observable; it is not extensible")
-    if (!isPlainObject(target))
-        name = (target.constructor.name || "ObservableObject") + "@" + getNextId()
-    if (!name) name = "ObservableObject@" + getNextId()
+
+    if (!name) {
+        if (isPlainObject(target)) {
+            name = "ObservableObject@" + getNextId()
+        } else {
+            name = (target.constructor.name || "ObservableObject") + "@" + getNextId()
+        }
+    }
 
     const adm = new ObservableObjectAdministration(
         target,

package/src/types/observablevalue.ts

@@ -59,7 +59,8 @@ export interface IObservableValue<T> {
 
 const CREATE = "create"
 
-export class ObservableValue<T> extends Atom
+export class ObservableValue<T>
+    extends Atom
     implements IObservableValue<T>, IInterceptable<IValueWillChange<T>>, IListenable {
     hasUnreportedChange_ = false
     interceptors_

package/src/utils/global.ts

@@ -1,4 +1,17 @@
-export function getGlobal(): any {
-    // @ts-ignore
-    return typeof global !== "undefined" ? global : window
+declare const window: any
+declare const self: any
+
+const mockGlobal = {}
+
+export function getGlobal() {
+    if (typeof window !== "undefined") {
+        return window
+    }
+    if (typeof global !== "undefined") {
+        return global
+    }
+    if (typeof self !== "undefined") {
+        return self
+    }
+    return mockGlobal
 }

package/src/utils/utils.ts

@@ -128,10 +128,10 @@ export function assertPropertyConfigurable(object: any, prop: PropertyKey) {
 
 export function createInstanceofPredicate<T>(
     name: string,
-    clazz: new (...args: any[]) => T
+    theClass: new (...args: any[]) => T
 ): (x: any) => x is T {
     const propName = "isMobX" + name
-    clazz.prototype[propName] = true
+    theClass.prototype[propName] = true
     return function (x) {
         return isObject(x) && x[propName] === true
     } as any