mobx 6.13.6 → 6.15.0

package/dist/types/observablemap.d.ts

@@ -5,7 +5,7 @@ export interface IKeyValueMap<V = any> {
 export type IMapEntry<K = any, V = any> = [K, V];
 export type IReadonlyMapEntry<K = any, V = any> = readonly [K, V];
 export type IMapEntries<K = any, V = any> = IMapEntry<K, V>[];
-export type IReadonlyMapEntries<K = any, V = any> = IReadonlyMapEntry<K, V>[];
+export type IReadonlyMapEntries<K = any, V = any> = readonly IReadonlyMapEntry<K, V>[];
 export type IMapDidChange<K = any, V = any> = {
     observableKind: "map";
     debugObjectName: string;

package/dist/types/observableset.d.ts

@@ -13,15 +13,17 @@ export type ISetDidChange<T = any> = {
     type: "delete";
     oldValue: T;
 };
-export type ISetWillChange<T = any> = {
+export type ISetWillDeleteChange<T = any> = {
     type: "delete";
     object: ObservableSet<T>;
     oldValue: T;
-} | {
+};
+export type ISetWillAddChange<T = any> = {
     type: "add";
     object: ObservableSet<T>;
     newValue: T;
 };
+export type ISetWillChange<T = any> = ISetWillDeleteChange<T> | ISetWillAddChange<T>;
 export declare class ObservableSet<T = any> implements Set<T>, IInterceptable<ISetWillChange>, IListenable {
     name_: string;
     [$mobx]: {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mobx",
-    "version": "6.13.6",
+    "version": "6.15.0",
     "description": "Simple, scalable state management.",
     "source": "src/mobx.ts",
     "main": "dist/index.js",

package/src/api/observable.ts

@@ -3,6 +3,9 @@ import {
     IEqualsComparer,
     IObservableArray,
     IObservableMapInitialValues,
+    IMapEntries,
+    IReadonlyMapEntries,
+    IKeyValueMap,
     IObservableSetInitialValues,
     IObservableValue,
     ObservableMap,
@@ -151,6 +154,24 @@ export interface IObservableValueFactory {
     <T>(value?: T, options?: CreateObservableOptions): IObservableValue<T | undefined>
 }
 
+export interface IObservableMapFactory {
+    <K = any, V = any>(): ObservableMap<K, V>
+    <K, V>(initialValues?: IMapEntries<K, V>, options?: CreateObservableOptions): ObservableMap<
+        K,
+        V
+    >
+    <K, V>(
+        initialValues?: IReadonlyMapEntries<K, V>,
+        options?: CreateObservableOptions
+    ): ObservableMap<K, V>
+    <K, V>(initialValues?: IKeyValueMap<V>, options?: CreateObservableOptions): ObservableMap<K, V>
+    <K, V>(initialValues?: Map<K, V>, options?: CreateObservableOptions): ObservableMap<K, V>
+    <K = any, V = any>(initialValues: undefined, options?: CreateObservableOptions): ObservableMap<
+        K,
+        V
+    >
+}
+
 export interface IObservableFactory
     extends Annotation,
         PropertyDecorator,
@@ -172,10 +193,7 @@ export interface IObservableFactory
         initialValues?: IObservableSetInitialValues<T>,
         options?: CreateObservableOptions
     ) => ObservableSet<T>
-    map: <K = any, V = any>(
-        initialValues?: IObservableMapInitialValues<K, V>,
-        options?: CreateObservableOptions
-    ) => ObservableMap<K, V>
+    map: IObservableMapFactory
     object: <T = any>(
         props: T,
         decorators?: AnnotationsMap<T, never>,

package/src/core/reaction.ts

@@ -240,6 +240,10 @@ export class Reaction implements IDerivation, IReactionPublic {
         abortSignal?.addEventListener?.("abort", dispose)
         dispose[$mobx] = this
 
+        if ("dispose" in Symbol && typeof Symbol.dispose === "symbol") {
+            dispose[Symbol.dispose] = dispose
+        }
+
         return dispose
     }
 

package/src/types/autoannotation.ts

@@ -10,7 +10,8 @@ import {
     autoAction,
     isGenerator,
     MakeResult,
-    die
+    die,
+    isAction
 } from "../internal"
 
 const AUTO = "true"
@@ -40,7 +41,9 @@ function make_(
     // lone setter -> action setter
     if (descriptor.set) {
         // TODO make action applicable to setter and delegate to action.make_
-        const set = createAction(key.toString(), descriptor.set) as (v: any) => void
+        const set = isAction(descriptor.set)
+            ? descriptor.set // See #4553
+            : (createAction(key.toString(), descriptor.set) as (v: any) => void)
         // own
         if (source === adm.target_) {
             return adm.defineProperty_(key, {

package/src/types/observablemap.ts

@@ -46,7 +46,7 @@ export interface IKeyValueMap<V = any> {
 export type IMapEntry<K = any, V = any> = [K, V]
 export type IReadonlyMapEntry<K = any, V = any> = readonly [K, V]
 export type IMapEntries<K = any, V = any> = IMapEntry<K, V>[]
-export type IReadonlyMapEntries<K = any, V = any> = IReadonlyMapEntry<K, V>[]
+export type IReadonlyMapEntries<K = any, V = any> = readonly IReadonlyMapEntry<K, V>[]
 
 export type IMapDidChange<K = any, V = any> = { observableKind: "map"; debugObjectName: string } & (
     | {

package/src/types/observableset.ts

@@ -51,17 +51,20 @@ export type ISetDidChange<T = any> =
           oldValue: T
       }
 
+export type ISetWillDeleteChange<T = any> = {
+    type: "delete"
+    object: ObservableSet<T>
+    oldValue: T
+};
+export type ISetWillAddChange<T = any> = {
+    type: "add"
+    object: ObservableSet<T>
+    newValue: T
+};
+
 export type ISetWillChange<T = any> =
-    | {
-          type: "delete"
-          object: ObservableSet<T>
-          oldValue: T
-      }
-    | {
-          type: "add"
-          object: ObservableSet<T>
-          newValue: T
-      }
+    | ISetWillDeleteChange<T>
+    | ISetWillAddChange<T>
 
 export class ObservableSet<T = any> implements Set<T>, IInterceptable<ISetWillChange>, IListenable {
     [$mobx] = ObservableSetMarker
@@ -120,7 +123,7 @@ export class ObservableSet<T = any> implements Set<T>, IInterceptable<ISetWillCh
     add(value: T) {
         checkIfStateModificationsAreAllowed(this.atom_)
         if (hasInterceptors(this)) {
-            const change = interceptChange<ISetWillChange<T>>(this, {
+            const change = interceptChange<ISetWillAddChange<T>>(this, {
                 type: ADD,
                 object: this,
                 newValue: value
@@ -128,8 +131,10 @@ export class ObservableSet<T = any> implements Set<T>, IInterceptable<ISetWillCh
             if (!change) {
                 return this
             }
-            // ideally, value = change.value would be done here, so that values can be
-            // changed by interceptor. Same applies for other Set and Map api's.
+
+            // implemented reassignment same as it's done for ObservableMap
+            value = change.newValue!;
+
         }
         if (!this.has(value)) {
             transaction(() => {
@@ -164,7 +169,7 @@ export class ObservableSet<T = any> implements Set<T>, IInterceptable<ISetWillCh
 
     delete(value: T) {
         if (hasInterceptors(this)) {
-            const change = interceptChange<ISetWillChange<T>>(this, {
+            const change = interceptChange<ISetWillDeleteChange<T>>(this, {
                 type: DELETE,
                 object: this,
                 oldValue: value

package/src/types/observablevalue.ts

@@ -83,7 +83,7 @@ export class ObservableValue<T>
                 object: this,
                 observableKind: "value",
                 debugObjectName: this.name_,
-                newValue: "" + this.value_
+                newValue: "" + this.value_?.toString()
             })
         }
     }

package/src/utils/eq.ts

@@ -17,6 +17,8 @@ export function deepEqual(a: any, b: any, depth: number = -1): boolean {
 }
 
 // Copied from https://github.com/jashkenas/underscore/blob/5c237a7c682fb68fd5378203f0bf22dce1624854/underscore.js#L1186-L1289
+// Modified: "Deep compare objects" part to iterate over keys in forward order instead of reverse order.
+//
 // Internal recursive comparison function for `isEqual`.
 function eq(a: any, b: any, depth: number, aStack?: any[], bStack?: any[]) {
     // Identical objects are equal. `0 === -0`, but they aren't identical.
@@ -149,15 +151,14 @@ function eq(a: any, b: any, depth: number, aStack?: any[], bStack?: any[]) {
     } else {
         // Deep compare objects.
         const keys = Object.keys(a)
-        let key
-        length = keys.length
+        const length = keys.length
         // Ensure that both objects contain the same number of properties before comparing deep equality.
         if (Object.keys(b).length !== length) {
             return false
         }
-        while (length--) {
+        for (let i = 0; i < length; i++) {
             // Deep compare each member
-            key = keys[length]
+            const key = keys[i]
             if (!(hasProp(b, key) && eq(a[key], b[key], depth - 1, aStack, bStack))) {
                 return false
             }