mobx 6.3.6 → 6.3.10

package/dist/types/observableobject.d.ts

@@ -27,7 +27,7 @@ export declare type IObjectWillChange<T = any> = {
 };
 export declare class ObservableObjectAdministration implements IInterceptable<IObjectWillChange>, IListenable {
     target_: any;
-    values_: Map<string | number | symbol, ObservableValue<any> | ComputedValue<any>>;
+    values_: Map<PropertyKey, ObservableValue<any> | ComputedValue<any>>;
     name_: string;
     defaultAnnotation_: Annotation;
     keysAtom_: IAtom;
@@ -37,7 +37,7 @@ export declare class ObservableObjectAdministration implements IInterceptable<IO
     isPlainObject_: boolean;
     appliedAnnotations_?: object;
     private pendingKeys_;
-    constructor(target_: any, values_: Map<string | number | symbol, ObservableValue<any> | ComputedValue<any>>, name_: string, defaultAnnotation_?: Annotation);
+    constructor(target_: any, values_: Map<PropertyKey, ObservableValue<any> | ComputedValue<any>>, name_: string, defaultAnnotation_?: Annotation);
     getObservablePropValue_(key: PropertyKey): any;
     setObservablePropValue_(key: PropertyKey, newValue: any): boolean | null;
     get_(key: PropertyKey): any;
@@ -87,7 +87,7 @@ export declare class ObservableObjectAdministration implements IInterceptable<IO
     observe_(callback: (changes: IObjectDidChange) => void, fireImmediately?: boolean): Lambda;
     intercept_(handler: any): Lambda;
     notifyPropertyAddition_(key: PropertyKey, value: any): void;
-    ownKeys_(): PropertyKey[];
+    ownKeys_(): ArrayLike<string | symbol>;
     keys_(): PropertyKey[];
 }
 export interface IIsObservableObject {

package/dist/utils/utils.d.ts

@@ -4,8 +4,8 @@ export declare const assign: {
     <T_2, U_2, V_1, W>(target: T_2, source1: U_2, source2: V_1, source3: W): T_2 & U_2 & V_1 & W;
     (target: object, ...sources: any[]): any;
 };
-export declare const getDescriptor: (o: any, p: string | number | symbol) => PropertyDescriptor | undefined;
-export declare const defineProperty: (o: any, p: string | number | symbol, attributes: PropertyDescriptor & ThisType<any>) => any;
+export declare const getDescriptor: (o: any, p: PropertyKey) => PropertyDescriptor | undefined;
+export declare const defineProperty: <T>(o: T, p: PropertyKey, attributes: PropertyDescriptor & ThisType<any>) => T;
 export declare const objectPrototype: Object;
 export declare const EMPTY_ARRAY: never[];
 export declare const EMPTY_OBJECT: {};
@@ -36,7 +36,7 @@ export declare function isES6Set(thing: any): thing is Set<any>;
  * Returns the following: own enumerable keys and symbols.
  */
 export declare function getPlainObjectKeys(object: any): (string | symbol)[];
-export declare const ownKeys: (target: any) => PropertyKey[];
+export declare const ownKeys: (target: any) => Array<string | symbol>;
 export declare function stringifyKey(key: any): string;
 export declare function toPrimitive(value: any): any;
 export declare function hasProp(target: Object, prop: PropertyKey): boolean;

package/package.json

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

package/src/api/intercept.ts

@@ -24,15 +24,15 @@ export function intercept<T>(
     handler: IInterceptor<IArrayWillChange<T> | IArrayWillSplice<T>>
 ): Lambda
 export function intercept<K, V>(
-    observableMap: ObservableMap<K, V>,
+    observableMap: ObservableMap<K, V> | Map<K, V>,
     handler: IInterceptor<IMapWillChange<K, V>>
 ): Lambda
 export function intercept<V>(
-    observableMap: ObservableSet<V>,
+    observableSet: ObservableSet<V> | Set<V>,
     handler: IInterceptor<ISetWillChange<V>>
 ): Lambda
 export function intercept<K, V>(
-    observableMap: ObservableMap<K, V>,
+    observableMap: ObservableMap<K, V> | Map<K, V>,
     property: K,
     handler: IInterceptor<IValueWillChange<V>>
 ): Lambda
@@ -40,7 +40,7 @@ export function intercept(object: object, handler: IInterceptor<IObjectWillChang
 export function intercept<T extends object, K extends keyof T>(
     object: T,
     property: K,
-    handler: IInterceptor<IValueWillChange<any>>
+    handler: IInterceptor<IValueWillChange<T[K]>>
 ): Lambda
 export function intercept(thing, propOrHandler?, handler?): Lambda {
     if (isFunction(handler)) return interceptProperty(thing, propOrHandler, handler)

package/src/api/observe.ts

@@ -25,17 +25,18 @@ export function observe<T>(
     fireImmediately?: boolean
 ): Lambda
 export function observe<V>(
-    observableMap: ObservableSet<V>,
+    // ObservableSet/ObservableMap are required despite they implement Set/Map: https://github.com/mobxjs/mobx/pull/3180#discussion_r746542929
+    observableSet: ObservableSet<V> | Set<V>,
     listener: (change: ISetDidChange<V>) => void,
     fireImmediately?: boolean
 ): Lambda
 export function observe<K, V>(
-    observableMap: ObservableMap<K, V>,
+    observableMap: ObservableMap<K, V> | Map<K, V>,
     listener: (change: IMapDidChange<K, V>) => void,
     fireImmediately?: boolean
 ): Lambda
 export function observe<K, V>(
-    observableMap: ObservableMap<K, V>,
+    observableMap: ObservableMap<K, V> | Map<K, V>,
     property: K,
     listener: (change: IValueDidChange<V>) => void,
     fireImmediately?: boolean

package/src/api/when.ts

@@ -69,7 +69,7 @@ function whenPromise(
         return die(`the options 'onError' and 'promise' cannot be combined`)
     let cancel
     const res = new Promise((resolve, reject) => {
-        let disposer = _when(predicate, resolve, { ...opts, onError: reject })
+        let disposer = _when(predicate, resolve as Lambda, { ...opts, onError: reject })
         cancel = () => {
             disposer()
             reject(new Error("WHEN_CANCELLED"))

package/src/core/atom.ts

@@ -17,7 +17,7 @@ import {
 export const $mobx = Symbol("mobx administration")
 
 export interface IAtom extends IObservable {
-    reportObserved()
+    reportObserved(): boolean
     reportChanged()
 }
 

package/src/core/computedvalue.ts

@@ -98,7 +98,7 @@ export class ComputedValue<T> implements IObservable, IComputedValue<T>, IDeriva
     isTracing_: TraceMode = TraceMode.NONE
     scope_: Object | undefined
     private equals_: IEqualsComparer<any>
-    private requiresReaction_: boolean
+    private requiresReaction_: boolean | undefined
     keepAlive_: boolean
 
     /**
@@ -129,7 +129,7 @@ export class ComputedValue<T> implements IObservable, IComputedValue<T>, IDeriva
                 ? comparer.structural
                 : comparer.default)
         this.scope_ = options.context
-        this.requiresReaction_ = !!options.requiresReaction
+        this.requiresReaction_ = options.requiresReaction
         this.keepAlive_ = !!options.keepAlive
     }
 
@@ -293,7 +293,7 @@ export class ComputedValue<T> implements IObservable, IComputedValue<T>, IDeriva
                 `[mobx.trace] Computed value '${this.name_}' is being read outside a reactive context. Doing a full recompute.`
             )
         }
-        if (globalState.computedRequiresReaction || this.requiresReaction_) {
+        if (typeof this.requiresReaction_ === "boolean" ? this.requiresReaction_ : globalState.computedRequiresReaction) {
             console.warn(
                 `[mobx] Computed value '${this.name_}' is being read outside a reactive context. Doing a full recompute.`
             )

package/src/types/dynamicobject.ts

@@ -61,7 +61,7 @@ const objectProxyTraps: ProxyHandler<any> = {
         // null (intercepted) -> true (success)
         return getAdm(target).defineProperty_(name, descriptor) ?? true
     },
-    ownKeys(target: IIsObservableObject): PropertyKey[] {
+    ownKeys(target: IIsObservableObject): ArrayLike<string | symbol> {
         if (__DEV__ && globalState.trackingDerivation)
             warnAboutProxyRequirement(
                 "iterate keys to detect added / removed properties. Use 'keys' from 'mobx' instead."

package/src/types/observablearray.ts

@@ -175,7 +175,8 @@ export class ObservableArrayAdministration
     }
 
     setArrayLength_(newLength: number) {
-        if (typeof newLength !== "number" || isNaN(newLength) || newLength < 0) die("Out of range: " + newLength)
+        if (typeof newLength !== "number" || isNaN(newLength) || newLength < 0)
+            die("Out of range: " + newLength)
         let currentLength = this.values_.length
         if (newLength === currentLength) return
         else if (newLength > currentLength) {
@@ -235,9 +236,12 @@ export class ObservableArrayAdministration
         if (newItems.length < MAX_SPLICE_SIZE) {
             return this.values_.splice(index, deleteCount, ...newItems)
         } else {
+            // The items removed by the splice
             const res = this.values_.slice(index, index + deleteCount)
+            // The items that that should remain at the end of the array
             let oldItems = this.values_.slice(index + deleteCount)
-            this.values_.length = index + newItems.length - deleteCount
+            // New length is the previous length + addition count - deletion count
+            this.values_.length += newItems.length - deleteCount
             for (let i = 0; i < newItems.length; i++) this.values_[index + i] = newItems[i]
             for (let i = 0; i < oldItems.length; i++)
                 this.values_[index + newItems.length + i] = oldItems[i]

package/src/types/observablemap.ts

@@ -33,7 +33,8 @@ import {
     die,
     isFunction,
     UPDATE,
-    IAtom
+    IAtom,
+    PureSpyEvent
 } from "../internal"
 
 export interface IKeyValueMap<V = any> {
@@ -85,7 +86,8 @@ export type IObservableMapInitialValues<K = any, V = any> =
 // just extend Map? See also https://gist.github.com/nestharus/13b4d74f2ef4a2f4357dbd3fc23c1e54
 // But: https://github.com/mobxjs/mobx/issues/1556
 export class ObservableMap<K = any, V = any>
-    implements Map<K, V>, IInterceptable<IMapWillChange<K, V>>, IListenable {
+    implements Map<K, V>, IInterceptable<IMapWillChange<K, V>>, IListenable
+{
     [$mobx] = ObservableMapMarker
     data_: Map<K, ObservableValue<V>>
     hasMap_: Map<K, ObservableValue<boolean>> // hasMap, not hashMap >-).
@@ -175,7 +177,7 @@ export class ObservableMap<K = any, V = any>
                       }
                     : null
 
-            if (__DEV__ && notifySpy) spyReportStart(change!)
+            if (__DEV__ && notifySpy) spyReportStart(change! as PureSpyEvent) // TODO fix type
             transaction(() => {
                 this.keysAtom_.reportChanged()
                 this.hasMap_.get(key)?.setNewValue_(false)
@@ -208,7 +210,7 @@ export class ObservableMap<K = any, V = any>
                           newValue
                       }
                     : null
-            if (__DEV__ && notifySpy) spyReportStart(change!)
+            if (__DEV__ && notifySpy) spyReportStart(change! as PureSpyEvent) // TODO fix type
             observable.setNewValue_(newValue as V)
             if (notify) notifyListeners(this, change)
             if (__DEV__ && notifySpy) spyReportEnd()
@@ -242,7 +244,7 @@ export class ObservableMap<K = any, V = any>
                       newValue
                   }
                 : null
-        if (__DEV__ && notifySpy) spyReportStart(change!)
+        if (__DEV__ && notifySpy) spyReportStart(change! as PureSpyEvent) // TODO fix type
         if (notify) notifyListeners(this, change)
         if (__DEV__ && notifySpy) spyReportEnd()
     }
@@ -308,7 +310,7 @@ export class ObservableMap<K = any, V = any>
         transaction(() => {
             if (isPlainObject(other))
                 getPlainObjectKeys(other).forEach((key: any) =>
-                    this.set((key as any) as K, other[key])
+                    this.set(key as any as K, other[key])
                 )
             else if (Array.isArray(other)) other.forEach(([key, value]) => this.set(key, value))
             else if (isES6Map(other)) {

package/src/types/observableobject.ts

@@ -88,7 +88,8 @@ export type IObjectWillChange<T = any> =
 const REMOVE = "remove"
 
 export class ObservableObjectAdministration
-    implements IInterceptable<IObjectWillChange>, IListenable {
+    implements IInterceptable<IObjectWillChange>, IListenable
+{
     keysAtom_: IAtom
     changeListeners_
     interceptors_
@@ -590,7 +591,7 @@ export class ObservableObjectAdministration
         this.keysAtom_.reportChanged()
     }
 
-    ownKeys_(): PropertyKey[] {
+    ownKeys_(): ArrayLike<string | symbol> {
         this.keysAtom_.reportObserved()
         return ownKeys(this.target_)
     }

package/src/utils/eq.ts

@@ -28,7 +28,7 @@ function eq(a: any, b: any, depth: number, aStack?: any[], bStack?: any[]) {
     if (a !== a) return b !== b
     // Exhaust primitive checks
     const type = typeof a
-    if (!isFunction(type) && type !== "object" && typeof b != "object") return false
+    if (type !== "function" && type !== "object" && typeof b != "object") return false
 
     // Compare `[[Class]]` names.
     const className = toString.call(a)

package/src/utils/utils.ts

@@ -34,7 +34,7 @@ export function warnAboutProxyRequirement(msg: string) {
     if (__DEV__ && globalState.verifyProxies) {
         die(
             "MobX is currently configured to be able to run in ES5 mode, but in ES5 MobX won't be able to " +
-                msg
+            msg
         )
     }
 }
@@ -55,7 +55,7 @@ export function once(func: Lambda): Lambda {
     }
 }
 
-export const noop = () => {}
+export const noop = () => { }
 
 export function isFunction(fn: any): fn is Function {
     return typeof fn === "function"
@@ -84,7 +84,8 @@ export function isPlainObject(value) {
     if (!isObject(value)) return false
     const proto = Object.getPrototypeOf(value)
     if (proto == null) return true
-    return proto.constructor?.toString() === plainObjectString
+    const protoConstructor = Object.hasOwnProperty.call(proto, "constructor") && proto.constructor;
+    return typeof protoConstructor === "function" && protoConstructor.toString() === plainObjectString
 }
 
 // https://stackoverflow.com/a/37865170
@@ -149,12 +150,12 @@ export function getPlainObjectKeys(object) {
 
 // From Immer utils
 // Returns all own keys, including non-enumerable and symbolic
-export const ownKeys: (target: any) => PropertyKey[] =
+export const ownKeys: (target: any) => Array<string | symbol> =
     typeof Reflect !== "undefined" && Reflect.ownKeys
         ? Reflect.ownKeys
         : hasGetOwnPropertySymbols
-        ? obj => Object.getOwnPropertyNames(obj).concat(Object.getOwnPropertySymbols(obj) as any)
-        : /* istanbul ignore next */ Object.getOwnPropertyNames
+            ? obj => Object.getOwnPropertyNames(obj).concat(Object.getOwnPropertySymbols(obj) as any)
+            : /* istanbul ignore next */ Object.getOwnPropertyNames
 
 export function stringifyKey(key: any): string {
     if (typeof key === "string") return key