mobx-state-tree 7.0.2 → 7.1.0

package/dist/core/mst-operations.d.ts

@@ -340,7 +340,7 @@ export declare function isAlive(target: IAnyStateTreeNode): boolean;
 export declare function addDisposer(target: IAnyStateTreeNode, disposer: IDisposer): IDisposer;
 /**
  * Returns the environment of the current state tree, or throws. For more info on environments,
- * see [Dependency injection](https://github.com/mobxjs/mobx-state-tree#dependency-injection)
+ * see [Dependency injection](/concepts/dependency-injection)
  *
  * Please note that in child nodes access to the root is only possible
  * once the `afterAttach` hook has fired

package/dist/core/type/type.d.ts

@@ -1,4 +1,4 @@
-import { IValidationContext, IValidationResult, IStateTreeNode, ModelPrimitive } from "../../internal";
+import { IValidationContext, IValidationResult, IStateTreeNode, ObjectNode, ModelPrimitive, AnyNode } from "../../internal";
 import type { WritableKeys } from "ts-essentials";
 /**
  * A state tree node value.
@@ -154,6 +154,8 @@ export type SnapshotOut<T> = T extends {
  * ```
  */
 export type SnapshotOrInstance<T> = SnapshotIn<T> | Instance<T>;
+export declare function canApplyDirectSnapshot(childType: IAnyType, childNode: AnyNode, newValue: any): childNode is ObjectNode<any, any, any>;
+export declare function resolveDirectApplyType(type: IAnyType): IAnyType;
 /**
  * Returns if a given value represents a type.
  *

package/dist/mobx-state-tree.js

@@ -795,7 +795,7 @@ function addDisposer(target, disposer) {
 }
 /**
  * Returns the environment of the current state tree, or throws. For more info on environments,
- * see [Dependency injection](https://github.com/mobxjs/mobx-state-tree#dependency-injection)
+ * see [Dependency injection](/concepts/dependency-injection)
  *
  * Please note that in child nodes access to the root is only possible
  * once the `afterAttach` hook has fired
@@ -2169,6 +2169,17 @@ var ObjectNode = /** @class */ (function (_super) {
             return this._internalEventsRegister(InternalEvents.Patch, handler);
         }
     });
+    Object.defineProperty(ObjectNode.prototype, "hasPatchSubscribers", {
+        enumerable: false,
+        configurable: true,
+        writable: true,
+        value: function () {
+            if (this._internalEventsHasSubscribers(InternalEvents.Patch)) {
+                return true;
+            }
+            return this.parent ? this.parent.hasPatchSubscribers() : false;
+        }
+    });
     Object.defineProperty(ObjectNode.prototype, "emitPatch", {
         enumerable: false,
         configurable: true,
@@ -2381,6 +2392,7 @@ var TypeFlags;
     TypeFlags[TypeFlags["Lazy"] = 1048576] = "Lazy";
     TypeFlags[TypeFlags["Finite"] = 2097152] = "Finite";
     TypeFlags[TypeFlags["Float"] = 4194304] = "Float";
+    TypeFlags[TypeFlags["BigInt"] = 8388608] = "BigInt";
 })(TypeFlags || (TypeFlags = {}));
 /**
  * @internal
@@ -2697,6 +2709,38 @@ var SimpleType = /** @class */ (function (_super) {
     });
     return SimpleType;
 }(BaseType));
+function canApplyDirectSnapshot(childType, childNode, newValue) {
+    var reconciliationType = childNode.getReconciliationType();
+    var expectedReconciliationType = resolveDirectApplyType(childType);
+    // Only types that reconcile as the same transparent-wrapper-adjusted type can safely reuse
+    // the existing child node. Wrappers with their own validation or snapshot semantics
+    // intentionally keep a distinct reconciliation type so they fall back to the validated path.
+    var hasMatchingReconciliationType = reconciliationType === expectedReconciliationType;
+    return (childNode instanceof ObjectNode &&
+        hasMatchingReconciliationType &&
+        reconciliationType instanceof ComplexType &&
+        isMutable(newValue) &&
+        !isStateTreeNode(newValue) &&
+        reconciliationType.isMatchingSnapshotId(childNode, newValue));
+}
+function resolveDirectApplyType(type) {
+    var subTypes = type.getSubTypes();
+    if (!subTypes ||
+        Array.isArray(subTypes) ||
+        subTypes === cannotDetermineSubtype ||
+        !canUnwrapDirectApplyType(type)) {
+        return type;
+    }
+    // Only unwrap wrappers that are transparent for direct apply. Wrappers with their own
+    // validation or snapshot processing must keep their wrapper identity here.
+    return resolveDirectApplyType(subTypes);
+}
+function canUnwrapDirectApplyType(type) {
+    var transparentWrapperFlags = TypeFlags.Optional | TypeFlags.Late;
+    var nonTransparentWrapperFlags = TypeFlags.Refinement | TypeFlags.SnapshotProcessor | TypeFlags.Union;
+    return ((type.flags & transparentWrapperFlags) > 0 &&
+        (type.flags & nonTransparentWrapperFlags) === 0);
+}
 /**
  * Returns if a given value represents a type.
  *
@@ -4046,6 +4090,7 @@ function isPrimitive(value, includeDate) {
         typeof value === "string" ||
         typeof value === "number" ||
         typeof value === "boolean" ||
+        typeof value === "bigint" ||
         (includeDate && value instanceof Date));
 }
 /**
@@ -4930,6 +4975,8 @@ function proxyNodeTypeMethods(nodeType, snapshotProcessorType) {
 /**
  * `types.snapshotProcessor` - Runs a pre/post snapshot processor before/after serializing a given type.
  *
+ * [See known issue with `applySnapshot` and `preProcessSnapshot`](https://github.com/mobxjs/mobx-state-tree/issues/1317)
+ *
  * Example:
  * ```ts
  * const Todo1 = types.model({ text: types.string })
@@ -5380,23 +5427,33 @@ var MapType = /** @class */ (function (_super) {
         configurable: true,
         writable: true,
         value: function (node, snapshot) {
-            typecheckInternal(this, snapshot);
+            if (!isPlainObject(snapshot)) {
+                typecheckInternal(this, snapshot);
+                return;
+            }
             var target = node.storedValue;
-            var currentKeys = {};
+            var childType = this.getChildType();
             Array.from(target.keys()).forEach(function (key) {
-                currentKeys[key] = false;
-            });
-            if (snapshot) {
-                // Don't use target.replace, as it will throw away all existing items first
-                for (var key in snapshot) {
-                    target.set(key, snapshot[key]);
-                    currentKeys["" + key] = true;
-                }
-            }
-            Object.keys(currentKeys).forEach(function (key) {
-                if (currentKeys[key] === false)
+                if (!Object.prototype.hasOwnProperty.call(snapshot, key)) {
                     target.delete(key);
+                    return;
+                }
+                var childNode = node.getChildNode(key);
+                var newValue = snapshot[key];
+                if (childNode.snapshot === newValue)
+                    return;
+                if (canApplyDirectSnapshot(childType, childNode, newValue)) {
+                    childNode.applySnapshot(newValue);
+                }
+                else {
+                    target.set(key, newValue);
+                }
             });
+            for (var key in snapshot) {
+                if (!Object.prototype.hasOwnProperty.call(snapshot, key) || target.has(key))
+                    continue;
+                target.set(key, snapshot[key]);
+            }
         }
     });
     Object.defineProperty(MapType.prototype, "getChildType", {
@@ -5722,9 +5779,52 @@ var ArrayType = /** @class */ (function (_super) {
         configurable: true,
         writable: true,
         value: function (node, snapshot) {
-            typecheckInternal(this, snapshot);
+            if (!isArray(snapshot)) {
+                typecheckInternal(this, snapshot);
+                return;
+            }
             var target = node.storedValue;
-            target.replace(snapshot);
+            var childNodes = node.getChildren();
+            var oldLength = childNodes.length;
+            var newLength = snapshot.length;
+            var childType = this.getChildType();
+            var minLength = Math.min(oldLength, newLength);
+            var firstChangedIndex = findFirstChangedIndex(childNodes, snapshot, minLength);
+            // If all array items are the same and the length did not change, there is nothing to do.
+            if (firstChangedIndex === oldLength && firstChangedIndex === newLength) {
+                return;
+            }
+            // Preserve the old "always replace" behavior for length changes and when patches are being
+            // observed, since those cases are more sensitive to patch shape (for example, splice
+            // would otherwise emit add/remove patch sequences) and benchmark variance.
+            if (oldLength !== newLength || node.hasPatchSubscribers()) {
+                target.replace(snapshot);
+                return;
+            }
+            // When every changed entry can reuse its existing child node, update them in place
+            // instead of going through array replacement/splice.
+            if (canApplyDirectSnapshotsInRange(childType, childNodes, snapshot, firstChangedIndex)) {
+                applyDirectSnapshotsInRange(childNodes, snapshot, firstChangedIndex);
+                return;
+            }
+            var oldEnd = oldLength - 1;
+            var newEnd = newLength - 1;
+            while (oldEnd >= firstChangedIndex &&
+                newEnd >= firstChangedIndex &&
+                childNodes[oldEnd].snapshot === snapshot[newEnd]) {
+                oldEnd--;
+                newEnd--;
+            }
+            // Trim the unchanged suffix too, so we only replace the minimal changed window.
+            var replacedCount = oldEnd >= firstChangedIndex ? oldEnd - firstChangedIndex + 1 : 0;
+            var replacementSnapshots = newEnd >= firstChangedIndex
+                ? snapshot.slice(firstChangedIndex, newEnd + 1)
+                : EMPTY_ARRAY;
+            if (replacedCount === 1 && replacementSnapshots.length === 1) {
+                target[firstChangedIndex] = replacementSnapshots[0];
+                return;
+            }
+            target.splice.apply(target, __spreadArray([firstChangedIndex, replacedCount], __read(replacementSnapshots), false));
         }
     });
     Object.defineProperty(ArrayType.prototype, "getChildType", {
@@ -5796,6 +5896,31 @@ function array(subtype) {
     assertIsType(subtype, 1);
     return new ArrayType("".concat(subtype.name, "[]"), subtype);
 }
+function findFirstChangedIndex(childNodes, snapshot, length) {
+    var index = 0;
+    while (index < length && childNodes[index].snapshot === snapshot[index]) {
+        index++;
+    }
+    return index;
+}
+function canApplyDirectSnapshotsInRange(childType, childNodes, snapshot, startIndex) {
+    for (var i = startIndex; i < childNodes.length; i++) {
+        if (childNodes[i].snapshot === snapshot[i])
+            continue;
+        if (!canApplyDirectSnapshot(childType, childNodes[i], snapshot[i])) {
+            return false;
+        }
+    }
+    return true;
+}
+function applyDirectSnapshotsInRange(childNodes, snapshot, startIndex) {
+    for (var i = startIndex; i < childNodes.length; i++) {
+        var childNode = childNodes[i];
+        if (childNode.snapshot === snapshot[i])
+            continue;
+        childNode.applySnapshot(snapshot[i]);
+    }
+}
 function reconcileArrayChildren(parent, childType, oldNodes, newValues, newPaths) {
     var nothingChanged = true;
     for (var i = 0;; i++) {
@@ -6441,10 +6566,25 @@ var ModelType = /** @class */ (function (_super) {
         configurable: true,
         writable: true,
         value: function (node, snapshot) {
-            typecheckInternal(this, snapshot);
             var preProcessedSnapshot = this.applySnapshotPreProcessor(snapshot);
-            this.forAllProps(function (name) {
-                node.storedValue[name] = preProcessedSnapshot[name];
+            var isPreProcessedSnapshotNonPlain = !isPlainObject(preProcessedSnapshot);
+            // Fast-path plain-object snapshots, but still validate when preprocessing is required
+            // or when preprocessing produces an invalid model snapshot.
+            if (!isPlainObject(snapshot) || isPreProcessedSnapshotNonPlain) {
+                typecheckInternal(this, snapshot);
+                if (isPreProcessedSnapshotNonPlain)
+                    return;
+            }
+            this.forAllProps(function (name, childType) {
+                var childNode = node.getChildNode(name);
+                var newValue = preProcessedSnapshot[name];
+                if (childNode.snapshot === newValue)
+                    return;
+                if (canApplyDirectSnapshot(childType, childNode, newValue)) {
+                    childNode.applySnapshot(newValue);
+                    return;
+                }
+                node.storedValue[name] = newValue;
             });
         }
     });
@@ -6735,6 +6875,37 @@ var float = new CoreType("float", TypeFlags.Float, function (v) { return isFloat
  */
 // tslint:disable-next-line:variable-name
 var finite = new CoreType("finite", TypeFlags.Finite, function (v) { return isFinite(v); });
+var _BigIntPrimitive = new CoreType("bigint", TypeFlags.BigInt, function (v) {
+    if (typeof v === "bigint") {
+        return true;
+    }
+    if (typeof v === "string" || typeof v === "number") {
+        try {
+            // BigInt primitive constructor verifies whether the value is a valid integer
+            BigInt(v);
+            return true;
+        }
+        catch (_a) { }
+    }
+    return false;
+}, function (v) { return (typeof v === "bigint" ? v : BigInt(v)); });
+_BigIntPrimitive.getSnapshot = function (node) {
+    return String(node.storedValue);
+};
+/**
+ * `types.bigint` - Creates a type that can only contain a bigint value.
+ * Snapshots serialize to string (JSON-safe) and deserialize from string, number or bigint.
+ *
+ * Example:
+ * ```ts
+ * const BigId = types.model({
+ *   id: types.identifier,
+ *   value: types.bigint
+ * })
+ * getSnapshot(store).value // "0" (string, JSON-safe)
+ * ```
+ */
+var bigint = _BigIntPrimitive;
 /**
  * `types.boolean` - Creates a type that can only contain a boolean value.
  * This type is used for boolean values by default
@@ -6786,6 +6957,8 @@ function getPrimitiveFactoryFromValue(value) {
             return number; // In the future, isInteger(value) ? integer : number would be interesting, but would be too breaking for now
         case "boolean":
             return boolean;
+        case "bigint":
+            return bigint;
         case "object":
             if (value instanceof Date)
                 return DatePrimitive;
@@ -6805,7 +6978,8 @@ function isPrimitiveType(type) {
                 TypeFlags.Number |
                 TypeFlags.Integer |
                 TypeFlags.Boolean |
-                TypeFlags.Date)) >
+                TypeFlags.Date |
+                TypeFlags.BigInt)) >
             0);
 }
 
@@ -8636,6 +8810,7 @@ var types = {
     integer: integer,
     float: float,
     finite: finite,
+    bigint: bigint,
     Date: DatePrimitive,
     map: map,
     array: array,