mobx 6.5.0 → 6.6.2

package/dist/types/observablemap.d.ts

@@ -3,7 +3,9 @@ export interface IKeyValueMap<V = any> {
     [key: string]: V;
 }
 export declare type IMapEntry<K = any, V = any> = [K, V];
+export declare type IReadonlyMapEntry<K = any, V = any> = readonly [K, V];
 export declare type IMapEntries<K = any, V = any> = IMapEntry<K, V>[];
+export declare type IReadonlyMapEntries<K = any, V = any> = IReadonlyMapEntry<K, V>[];
 export declare type IMapDidChange<K = any, V = any> = {
     observableKind: "map";
     debugObjectName: string;
@@ -32,7 +34,7 @@ export interface IMapWillChange<K = any, V = any> {
 }
 export declare const ADD = "add";
 export declare const DELETE = "delete";
-export declare type IObservableMapInitialValues<K = any, V = any> = IMapEntries<K, V> | IKeyValueMap<V> | Map<K, V>;
+export declare type IObservableMapInitialValues<K = any, V = any> = IMapEntries<K, V> | IReadonlyMapEntries<K, V> | IKeyValueMap<V> | Map<K, V>;
 export declare class ObservableMap<K = any, V = any> implements Map<K, V>, IInterceptable<IMapWillChange<K, V>>, IListenable {
     enhancer_: IEnhancer<V>;
     name_: string;

package/package.json

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

package/src/api/decorators.ts

@@ -51,7 +51,7 @@ function assertNotDecorated(prototype: object, annotation: Annotation, key: Prop
             `Cannot apply '@${requestedAnnotationType}' to '${fieldName}':` +
                 `\nThe field is already decorated with '@${currentAnnotationType}'.` +
                 `\nRe-decorating fields is not allowed.` +
-                `\nUse '@override' decorator for methods overriden by subclass.`
+                `\nUse '@override' decorator for methods overridden by subclass.`
         )
     }
 }

package/src/api/observable.ts

@@ -136,6 +136,11 @@ function createObservable(v: any, arg2?: any, arg3?: any) {
 }
 Object.assign(createObservable, observableDecoratorAnnotation)
 
+export interface IObservableValueFactory {
+    <T>(value: T, options?: CreateObservableOptions): IObservableValue<T>
+    <T>(value?: T, options?: CreateObservableOptions): IObservableValue<T | undefined>
+}
+
 export interface IObservableFactory extends Annotation, PropertyDecorator {
     <T = any>(value: T[], options?: CreateObservableOptions): IObservableArray<T>
     <T = any>(value: Set<T>, options?: CreateObservableOptions): ObservableSet<T>
@@ -146,7 +151,7 @@ export interface IObservableFactory extends Annotation, PropertyDecorator {
         options?: CreateObservableOptions
     ): T
 
-    box: <T = any>(value?: T, options?: CreateObservableOptions) => IObservableValue<T>
+    box: IObservableValueFactory
     array: <T = any>(initialValues?: T[], options?: CreateObservableOptions) => IObservableArray<T>
     set: <T = any>(
         initialValues?: IObservableSetInitialValues<T>,
@@ -175,7 +180,7 @@ export interface IObservableFactory extends Annotation, PropertyDecorator {
 }
 
 const observableFactories: IObservableFactory = {
-    box<T = any>(value?: T, options?: CreateObservableOptions): IObservableValue<T> {
+    box<T = any>(value: T, options?: CreateObservableOptions): IObservableValue<T> {
         const o = asCreateObservableOptions(options)
         return new ObservableValue(value, getEnhancerFromOptions(o), o.name, true, o.equals)
     },
@@ -201,7 +206,7 @@ const observableFactories: IObservableFactory = {
         const o = asCreateObservableOptions(options)
         return new ObservableSet<T>(initialValues, getEnhancerFromOptions(o), o.name)
     },
-    object<T = any>(
+    object<T extends object = any>(
         props: T,
         decorators?: AnnotationsMap<T, never>,
         options?: CreateObservableOptions

package/src/mobx.ts

@@ -2,7 +2,7 @@
  * (c) Michel Weststrate 2015 - 2020
  * MIT Licensed
  *
- * Welcome to the mobx sources! To get an global overview of how MobX internally works,
+ * Welcome to the mobx sources! To get a global overview of how MobX internally works,
  * this is a good place to start:
  * https://medium.com/@mweststrate/becoming-fully-reactive-an-in-depth-explanation-of-mobservable-55995262a254#.xvbh6qd74
  *

package/src/types/legacyobservablearray.ts

@@ -14,6 +14,21 @@ import {
     defineProperty
 } from "../internal"
 
+// Bug in safari 9.* (or iOS 9 safari mobile). See #364
+const ENTRY_0 = createArrayEntryDescriptor(0)
+
+const safariPrototypeSetterInheritanceBug = (() => {
+    let v = false
+    const p = {}
+    Object.defineProperty(p, "0", {
+        set: () => {
+            v = true
+        }
+    })
+    Object.create(p)["0"] = 1
+    return v === false
+})()
+
 /**
  * This array buffer contains two lists of properties, so that all arrays
  * can recycle their property definitions, which significantly improves performance of creating
@@ -57,6 +72,12 @@ class LegacyObservableArray<T> extends StubArray {
             this.spliceWithArray(0, 0, initialValues)
             allowStateChangesEnd(prev)
         }
+
+        if (safariPrototypeSetterInheritanceBug) {
+            // Seems that Safari won't use numeric prototype setter untill any * numeric property is
+            // defined on the instance. After that it works fine, even if this property is deleted.
+            Object.defineProperty(this, "0", ENTRY_0)
+        }
     }
 
     concat(...arrays: T[][]): T[] {

package/src/types/observablemap.ts

@@ -43,7 +43,9 @@ 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 IMapDidChange<K = any, V = any> = { observableKind: "map"; debugObjectName: string } & (
     | {
@@ -81,14 +83,14 @@ export const DELETE = "delete"
 
 export type IObservableMapInitialValues<K = any, V = any> =
     | IMapEntries<K, V>
+    | IReadonlyMapEntries<K, V>
     | IKeyValueMap<V>
     | Map<K, V>
 
 // 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 >-).

package/src/types/observableobject.ts

@@ -776,7 +776,7 @@ function assertAnnotable(
             `Cannot apply '${requestedAnnotationType}' to '${fieldName}':` +
                 `\nThe field is already annotated with '${currentAnnotationType}'.` +
                 `\nRe-annotating fields is not allowed.` +
-                `\nUse 'override' annotation for methods overriden by subclass.`
+                `\nUse 'override' annotation for methods overridden by subclass.`
         )
     }
 }