mobx 6.1.8 → 6.3.2

package/CHANGELOG.md

@@ -1,5 +1,57 @@
 # mobx
 
+## 6.3.2
+
+### Patch Changes
+
+-   [`4011b378`](https://github.com/mobxjs/mobx/commit/4011b3789d57e3dab0b85a835fe2979033133ce9) [#2949](https://github.com/mobxjs/mobx/pull/2949) Thanks [@urugator](https://github.com/urugator)! - fix #2948: flow ignores `autoBind` option
+
+## 6.3.1
+
+### Patch Changes
+
+-   [`d678ebd7`](https://github.com/mobxjs/mobx/commit/d678ebd7e54efb3aeae4541f87f5bcf93a623ec6) [#2944](https://github.com/mobxjs/mobx/pull/2944) Thanks [@urugator](https://github.com/urugator)! - Fix [#2941](https://github.com/mobxjs/mobx/issues/2941) - flow.bound replaces method on proto with bound function
+
+## 6.3.0
+
+### Minor Changes
+
+-   [`035bf409`](https://github.com/mobxjs/mobx/commit/035bf4096dd72d296af1fc25304adaade73cc7eb) [#2906](https://github.com/mobxjs/mobx/pull/2906) Thanks [@urugator](https://github.com/urugator)! - Provide `flow.bound` annotation/decorator
+
+### Patch Changes
+
+-   [`3dedb4d4`](https://github.com/mobxjs/mobx/commit/3dedb4d4b5376f3991183923838da942a9a81506) [#2904](https://github.com/mobxjs/mobx/pull/2904) Thanks [@ahoisl](https://github.com/ahoisl)! - Make toJS work with computed value props
+
+## 6.2.0
+
+### Minor Changes
+
+-   [`bc8db3df`](https://github.com/mobxjs/mobx/commit/bc8db3df9405034999f8feb8c95ba8045c7ae008) [#2779](https://github.com/mobxjs/mobx/pull/2779) Thanks [@urugator](https://github.com/urugator)! - In mobx5 all own properties were by default observable regardless of their value. Since mobx6 we treat functional properties as `action`s or to be precise `autoAction`s. `autoAction` provides `action`'s benefits to your functions, without the need to explicitely annotate them as `actions`.
+    We think this is useful, but as a consequence, such properties are no longer `observable` and therefore non-writable and also non-enumerable. This turned out to be suprising and inconvinient to some users:
+    https://github.com/mobxjs/mobx/discussions/2760
+    https://github.com/mobxjs/mobx/discussions/2586
+    https://github.com/mobxjs/mobx/issues/2835
+    https://github.com/mobxjs/mobx/issues/2629
+    https://github.com/mobxjs/mobx/issues/2551
+    https://github.com/mobxjs/mobx/issues/2637
+    So we decided to change it: All _own_ props _including functions_ are `observable` (enumerable, writable) as in v5, but additionally all functions that become part of deeply observable structure are by default converted to `autoAction`/`flow`.
+    Note that `deep` option affects this conversion in the same way as it affects conversion of other values (object/array/map/set).
+
+    -   by default all functions are converted to `autoAction`s/`flow`s
+    -   by default all originally _own_ props are now observable and enumerable (as in pre v6)
+    -   `deep: false` ignores _all_ property values (including functions that would be previously converted to `autoAction`/`flow`)
+    -   by default _lone_ setters are converted to `action`s
+
+### Patch Changes
+
+-   [`16cab8b1`](https://github.com/mobxjs/mobx/commit/16cab8b14cf4a0d995d3f367123abfab5aed8326) [#2806](https://github.com/mobxjs/mobx/pull/2806) Thanks [@urugator](https://github.com/urugator)! - Annotations refactor - reduced code duplication
+
+*   [`6b324edc`](https://github.com/mobxjs/mobx/commit/6b324edc69e7e9041a01e20d2e86f424046f3e25) [#2873](https://github.com/mobxjs/mobx/pull/2873) Thanks [@urugator](https://github.com/urugator)! - Fix [#2871](https://github.com/mobxjs/mobx/issues/2871): `toJS` throws with `configure({ useProxies: "ifavailable" })`
+
+-   [`b5141883`](https://github.com/mobxjs/mobx/commit/b5141883434cba86b257d68a7badff5038c14296) [#2872](https://github.com/mobxjs/mobx/pull/2872) Thanks [@urugator](https://github.com/urugator)! - Fix [#2859](https://github.com/mobxjs/mobx/issues/2859): Trace log only if derivation is actually about to re-run
+
+*   [`0945c265`](https://github.com/mobxjs/mobx/commit/0945c26513057457e1534a80558a3eb98487dc96) [#2840](https://github.com/mobxjs/mobx/pull/2840) Thanks [@iChenLei](https://github.com/iChenLei)! - export IComputedFactory typescript type definition
+
 ## 6.1.8
 
 ### Patch Changes
@@ -145,12 +197,12 @@ Support the ongoing maintenance at: https://opencollective.com/mobx
 
 ### New features
 
--   [`makeObservable(target, annotations)`](./docs/observable-state.md#makeobservable) is now the recommended way to make objects with a fixed shape observable, such as classes.
--   [`makeAutoObservable(target)`](./docs/observable-state.md#makeautoobservable) will automatically determine the annotations used by `makeObservable`. Methods will be marked as 'autoAction', so that they can be used both from a computed value or as standalone method.
--   MobX 6 can be used in both modern environments, and environments that don't support Proxy. So both MobX 4 and 5 users can upgrade to 6. See [proxy support](./docs/configuration.md#proxy-support) for more details.
+-   [`makeObservable(target, annotations)`](../../docs/observable-state.md#makeobservable) is now the recommended way to make objects with a fixed shape observable, such as classes.
+-   [`makeAutoObservable(target)`](../../docs/observable-state.md#makeautoobservable) will automatically determine the annotations used by `makeObservable`. Methods will be marked as 'autoAction', so that they can be used both from a computed value or as standalone method.
+-   MobX 6 can be used in both modern environments, and environments that don't support Proxy. So both MobX 4 and 5 users can upgrade to 6. See [proxy support](../../docs/configuration.md#proxy-support) for more details.
 -   `observable.array` now supports `{ proxy: false }` as option.
 -   `reaction`'s effect function now receives the previous value seen by the reaction as second argument.
--   `flow` can now be used as annotation as well. You might need `flowResult` in case you use TypeScript to extract the correct result type. [details](./docs/actions.md#using-flow-instead-of-async--await-).
+-   `flow` can now be used as annotation as well. You might need `flowResult` in case you use TypeScript to extract the correct result type. [details](../../docs/actions.md#using-flow-instead-of-async--await-).
 
 ### Breaking changes
 
@@ -158,7 +210,7 @@ Support the ongoing maintenance at: https://opencollective.com/mobx
 
 -   The `decorate` API has been removed, and needs to be replaced by `makeObservable` in the constructor of the targeted class. It accepts the same arguments. The `mobx-undecorate` can transform this automatically.
 -   When using `extendObservable` / `observable`, fields that contained functions used to be turned into observables. This is no longer the case, they will be converted into `autoActions`.
--   [Strict mode](./docs/configuration.md#enforceactions) for actions is now enabled by default in `observed` mode.
+-   [Strict mode](../../docs/configuration.md#enforceactions) for actions is now enabled by default in `observed` mode.
 -   `toJS` no longer takes any options. It no longer converts Maps and Sets to plain data structures. Generic, flexible serialization of data structures is out of scope for the MobX project, and writing custom serialization methods is a much more scalable approach to serialization (tip: leverage `computed`s to define how class instances should be serialized).
 -   The methods `intercept` and `observe` are no longer exposed on observable arrays, maps and boxed observables. Import them as utility from mobx instead: `import { observe, intercept } from "mobx"`, and pass the collection as first argument: `observer(collection, callback)`. Note that we still recommend to avoid these APIs.
 -   `observableMap.toPOJO()`, `observableMap.toJS()` have been dropped. Use `new Map(observableMap)` instead if you want to convert an observable map to a plain Map shallowly.

package/README.md

@@ -28,10 +28,11 @@ MobX is made possible by the generosity of the sponsors below, and many other [i
 
 **🥈Silver sponsors (\$100+ pm):**<br/>
 <a href="https://www.codefirst.co.uk/"><img src="https://mobx.js.org/assets/codefirst.png" align="center" width="100" title="CodeFirst" alt="CodeFirst"/></a>
-<a href="https://www.dcslsoftware.com/"><img src="https://mobx.js.org/assets/dcsl.png" align="center" width="100" title="DCSL Software" alt="DCSL Software"/></a>
+<a href="https://www.dcsl.com/"><img src="https://mobx.js.org/assets/dcsl.png" align="center" width="100" title="DCSL Guidesmiths" alt="DCSL Guidesmiths"/></a>
 <a href="https://www.bugsnag.com/platforms/react-error-reporting?utm_source=MobX&utm_medium=Website&utm_content=open-source&utm_campaign=2019-community&utm_term=20190913"><img src="https://mobx.js.org/assets/bugsnag.jpg" align="center" width="100" title="Bugsnag" alt="Bugsnag"/></a>
 <a href="https://curology.com/blog/tech"><img src="https://mobx.js.org/assets/curology.png" align="center" width="100" title="Curology" alt="Curology"/></a>
 <a href="https://modulz.app/"><img src="https://mobx.js.org/assets/modulz.png" align="center" width="100" title="Modulz" alt="Modulz"/></a>
+<a href="https://space307.com/?utm_source=sponsorship&utm_medium=mobx&utm_campaign=readme"><img src="https://mobx.js.org/assets/space307.png" align="center" width="100" title="Space307" alt="Space307"/></a>
 
 **🥉Bronze sponsors (\$500+ total contributions):**<br/>
 <a href="https://mantro.net/jobs/warlock"><img src="https://mobx.js.org/assets/mantro.png" align="center" width="100" title="mantro GmbH" alt="mantro GmbH"></a>

package/dist/api/annotation.d.ts

@@ -1,7 +1,12 @@
 import { ObservableObjectAdministration } from "../internal";
+export declare const enum MakeResult {
+    Cancel = 0,
+    Break = 1,
+    Continue = 2
+}
 export declare type Annotation = {
     annotationType_: string;
-    make_(adm: ObservableObjectAdministration, key: PropertyKey): void;
+    make_(adm: ObservableObjectAdministration, key: PropertyKey, descriptor: PropertyDescriptor, source: object): MakeResult;
     extend_(adm: ObservableObjectAdministration, key: PropertyKey, descriptor: PropertyDescriptor, proxyTrap: boolean): boolean | null;
     options_?: any;
 };
@@ -9,16 +14,5 @@ export declare type AnnotationMapEntry = Annotation | true | false;
 export declare type AnnotationsMap<T, AdditionalFields extends PropertyKey> = {
     [P in Exclude<keyof T, "toString">]?: AnnotationMapEntry;
 } & Record<AdditionalFields, AnnotationMapEntry>;
-/**
- * Infers the best fitting annotation from property descriptor or false if the field shoudn't be annotated
- * - getter(+setter) -> computed
- * - setter w/o getter -> false (ignore)
- * - flow -> false (ignore)
- * - generator -> flow
- * - action -> false (ignore)
- * - function -> action (optionally bound)
- * - other -> defaultAnnotation
- */
-export declare function inferAnnotationFromDescriptor(desc: PropertyDescriptor, defaultAnnotation: Annotation, autoBind: boolean): Annotation | false;
 export declare function isAnnotation(thing: any): boolean;
 export declare function isAnnotationMapEntry(thing: any): boolean;

package/dist/api/flow.d.ts

@@ -10,6 +10,7 @@ export declare type CancellablePromise<T> = Promise<T> & {
 };
 interface Flow extends Annotation, PropertyDecorator {
     <R, Args extends any[]>(generator: (...args: Args) => Generator<any, R, any> | AsyncGenerator<any, R, any>): (...args: Args) => CancellablePromise<R>;
+    bound: Annotation & PropertyDecorator;
 }
 export declare const flow: Flow;
 export declare function flowResult<T>(result: T): T extends Generator<any, infer R, any> ? CancellablePromise<R> : T extends CancellablePromise<any> ? T : never;

package/dist/api/object-api.d.ts

@@ -32,3 +32,5 @@ export declare function has<T extends Object>(obj: T, key: string): boolean;
 export declare function get<K, V>(obj: ObservableMap<K, V>, key: K): V | undefined;
 export declare function get<T>(obj: IObservableArray<T>, index: number): T | undefined;
 export declare function get<T extends Object>(obj: T, key: string): any;
+export declare function apiDefineProperty(obj: Object, key: PropertyKey, descriptor: PropertyDescriptor): any;
+export declare function apiOwnKeys(obj: Object): any;

package/dist/errors.d.ts

@@ -34,6 +34,8 @@ declare const niceErrors: {
     readonly 35: "There are multiple, different versions of MobX active. Make sure MobX is loaded only once or use `configure({ isolateGlobalState: true })`";
     readonly 36: "isolateGlobalState should be called before MobX is running any reactions";
     readonly 37: (method: any) => string;
+    readonly 38: "'ownKeys()' can only be used on observable objects";
+    readonly 39: "'defineProperty()' can only be used on observable objects";
 };
 declare const errors: typeof niceErrors;
 export declare function die(error: string | keyof typeof errors, ...args: any[]): never;

package/dist/internal.d.ts

@@ -10,6 +10,7 @@ export * from "./types/actionannotation";
 export * from "./types/flowannotation";
 export * from "./types/computedannotation";
 export * from "./types/observableannotation";
+export * from "./types/autoannotation";
 export * from "./api/observable";
 export * from "./api/computed";
 export * from "./core/action";