mobx-state-tree 7.0.2 → 7.2.0

package/dist/mobx-state-tree.umd.js

@@ -795,7 +795,7 @@
     }
     /**
      * 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
@@ -1542,6 +1542,12 @@
                 writable: true,
                 value: false
             });
+            Object.defineProperty(_this, "_endOfActionCallbacks", {
+                enumerable: true,
+                configurable: true,
+                writable: true,
+                value: void 0
+            });
             Object.defineProperty(_this, "_observableInstanceState", {
                 enumerable: true,
                 configurable: true,
@@ -1612,8 +1618,8 @@
                         id = childNode.value;
                     }
                 }
-                if (typeof id !== "string" && typeof id !== "number") {
-                    throw new MstError("Instance identifier '".concat(_this.identifierAttribute, "' for type '").concat(_this.type.name, "' must be a string or a number"));
+                if (typeof id !== "string" && typeof id !== "number" && typeof id !== "bigint") {
+                    throw new MstError("Instance identifier '".concat(_this.identifierAttribute, "' for type '").concat(_this.type.name, "' must be a string, a number or a bigint"));
                 }
                 // normalize internal identifier to string
                 _this.identifier = normalizeIdentifier(id);
@@ -1751,6 +1757,33 @@
             enumerable: false,
             configurable: true
         });
+        Object.defineProperty(ObjectNode.prototype, "enqueueEndOfAction", {
+            enumerable: false,
+            configurable: true,
+            writable: true,
+            value: function (callback) {
+                var root = this.root;
+                if (!root._endOfActionCallbacks) {
+                    root._endOfActionCallbacks = [];
+                }
+                root._endOfActionCallbacks.push(callback);
+            }
+        });
+        Object.defineProperty(ObjectNode.prototype, "flushEndOfActionCallbacks", {
+            enumerable: false,
+            configurable: true,
+            writable: true,
+            value: function () {
+                var root = this.root;
+                while (root._endOfActionCallbacks && root._endOfActionCallbacks.length > 0) {
+                    var callbacks = root._endOfActionCallbacks;
+                    root._endOfActionCallbacks = undefined;
+                    callbacks.forEach(function (callback) {
+                        callback();
+                    });
+                }
+            }
+        });
         Object.defineProperty(ObjectNode.prototype, "clearParent", {
             enumerable: false,
             configurable: true,
@@ -2169,6 +2202,17 @@
                 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 +2425,7 @@
         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 +2742,38 @@
         });
         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.
      *
@@ -3188,9 +3265,10 @@
         var baseIsRunningAction = node._isRunningAction;
         node._isRunningAction = true;
         var previousContext = currentActionContext;
+        var isRootActionContext = !previousContext;
         currentActionContext = context;
         try {
-            return runMiddleWares(node, context, fn);
+            return runMiddleWares(node, context, fn, isRootActionContext);
         }
         finally {
             currentActionContext = previousContext;
@@ -3344,17 +3422,44 @@
         });
         return CollectedMiddlewares;
     }());
-    function runMiddleWares(node, baseCall, originalFn) {
+    function runMiddleWares(node, baseCall, originalFn, isRootActionContext) {
+        function runInActionScope(call, fn) {
+            var execute = function () {
+                var result;
+                var error;
+                try {
+                    result = fn.apply(null, call.args);
+                }
+                catch (e) {
+                    error = e;
+                }
+                if (isRootActionContext || !call.parentActionEvent) {
+                    try {
+                        node.root.flushEndOfActionCallbacks();
+                    }
+                    catch (flushError) {
+                        if (!error) {
+                            error = flushError;
+                        }
+                    }
+                }
+                if (error) {
+                    throw error;
+                }
+                return result;
+            };
+            return call.name ? mobx.action(call.name, execute)() : mobx.action(execute)();
+        }
         var middlewares = new CollectedMiddlewares(node, originalFn);
         // Short circuit
         if (middlewares.isEmpty)
-            return mobx.action(originalFn).apply(null, baseCall.args);
+            return runInActionScope(baseCall, originalFn);
         var result = null;
         function runNextMiddleware(call) {
             var middleware = middlewares.getNextMiddleware();
             var handler = middleware && middleware.handler;
             if (!handler) {
-                return mobx.action(originalFn).apply(null, call.args);
+                return runInActionScope(call, originalFn);
             }
             // skip hooks if asked to
             if (!middleware.includeHooks && Hook[call.name]) {
@@ -3390,6 +3495,9 @@
                     throw new MstError("The next() and abort() callback within the middleware ".concat(handler.name, " for the action: \"").concat(call.name, "\" on the node: ").concat(node2.type.name, " were invoked."));
                 }
             }
+            if (abortInvoked && (isRootActionContext || !call.parentActionEvent)) {
+                return runInActionScope(call, function () { return result; });
+            }
             return result;
         }
         return runNextMiddleware(baseCall);
@@ -4046,6 +4154,7 @@
             typeof value === "string" ||
             typeof value === "number" ||
             typeof value === "boolean" ||
+            typeof value === "bigint" ||
             (includeDate && value instanceof Date));
     }
     /**
@@ -4908,6 +5017,8 @@
     /**
      * `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 })
@@ -5358,23 +5469,33 @@
             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", {
@@ -5700,9 +5821,52 @@
             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", {
@@ -5774,6 +5938,31 @@
         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++) {
@@ -6419,10 +6608,25 @@
             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;
                 });
             }
         });
@@ -6713,6 +6917,37 @@
      */
     // 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
@@ -6764,6 +6999,8 @@
                 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;
@@ -6783,7 +7020,8 @@
                     TypeFlags.Number |
                     TypeFlags.Integer |
                     TypeFlags.Boolean |
-                    TypeFlags.Date)) >
+                    TypeFlags.Date |
+                    TypeFlags.BigInt)) >
                 0);
     }
 
@@ -7937,7 +8175,7 @@
             value: function (value, context) {
                 return isValidIdentifier(value)
                     ? typeCheckSuccess()
-                    : typeCheckFailure(context, value, "Value is not a valid identifier, which is a string or a number");
+                    : typeCheckFailure(context, value, "Value is not a valid identifier, which is a string, number or a bigint");
             }
         });
         Object.defineProperty(BaseReferenceType.prototype, "fireInvalidated", {
@@ -8026,6 +8264,23 @@
                         onRefTargetDestroyedHookDisposer();
                     }
                 });
+                var scheduleRetryAfterReconciliation = function () {
+                    var retry = function () {
+                        if (!storedRefNode.isAlive) {
+                            return;
+                        }
+                        if (_this.getSnapshot(storedRefNode) !== identifier) {
+                            return;
+                        }
+                        startWatching(false);
+                    };
+                    if (getCurrentActionContext()) {
+                        storedRefNode.root.enqueueEndOfAction(retry);
+                    }
+                    else {
+                        setImmediateWithFallback(retry);
+                    }
+                };
                 var startWatching = function (sync) {
                     // re-create hook in case the stored ref gets reattached
                     if (onRefTargetDestroyedHookDisposer) {
@@ -8043,12 +8298,13 @@
                             refTargetNodeExists = storedRefNode.root.identifierCache.has(_this.targetType, normalizeIdentifier(identifier));
                         }
                         if (!refTargetNodeExists) {
-                            // we cannot change the reference in sync mode
-                            // since we are in the middle of a reconciliation/instantiation and the change would be overwritten
-                            // for those cases just let the wrong reference be assigned and fail upon usage
-                            // (like current references do)
-                            // this means that effectively this code will only run when it is created from a snapshot
-                            if (!sync) {
+                            // if the tree is already attached we may still be in the middle of a reconcile/applySnapshot,
+                            // so wait until the current MST action finishes before deciding whether to invalidate or
+                            // attach a watcher to a target that appeared later in the same action.
+                            if (sync) {
+                                scheduleRetryAfterReconciliation();
+                            }
+                            else {
                                 _this.fireInvalidated("invalidSnapshotReference", storedRefNode, identifier, null);
                             }
                         }
@@ -8398,7 +8654,7 @@
      * Inside a state tree, for each type can exist only one instance for each given identifier.
      * For example there couldn't be 2 instances of user with id 1. If you need more, consider using references.
      * Identifier can be used only as type property of a model.
-     * This type accepts as parameter the value type of the identifier field that can be either string or number.
+     * This type accepts as parameter the value type of the identifier field that can be either string, number or bigint.
      *
      * Example:
      * ```ts
@@ -8425,6 +8681,110 @@
      * @returns
      */
     var identifierNumber = new IdentifierNumberType();
+    /**
+     * @internal
+     * @hidden
+     * IdentifierBigintType uses SimpleType<bigint | string | number, string, bigint> so snapshots serialize to string (JSON-safe).
+     */
+    var IdentifierBigintType = /** @class */ (function (_super) {
+        __extends(IdentifierBigintType, _super);
+        function IdentifierBigintType() {
+            var _this = _super.call(this, "identifierBigint") || this;
+            Object.defineProperty(_this, "flags", {
+                enumerable: true,
+                configurable: true,
+                writable: true,
+                value: TypeFlags.Identifier
+            });
+            return _this;
+        }
+        Object.defineProperty(IdentifierBigintType.prototype, "createNewInstance", {
+            enumerable: false,
+            configurable: true,
+            writable: true,
+            value: function (snapshot) {
+                if (typeof snapshot === "bigint")
+                    return snapshot;
+                return BigInt(snapshot);
+            }
+        });
+        Object.defineProperty(IdentifierBigintType.prototype, "instantiate", {
+            enumerable: false,
+            configurable: true,
+            writable: true,
+            value: function (parent, subpath, environment, initialValue) {
+                if (!parent || !(parent.type instanceof ModelType))
+                    throw new MstError("Identifier types can only be instantiated as direct child of a model type");
+                return createScalarNode(this, parent, subpath, environment, initialValue);
+            }
+        });
+        Object.defineProperty(IdentifierBigintType.prototype, "reconcile", {
+            enumerable: false,
+            configurable: true,
+            writable: true,
+            value: function (current, newValue, parent, subpath) {
+                var currentVal = current.storedValue;
+                var newVal = typeof newValue === "bigint" ? newValue : BigInt(newValue);
+                if (currentVal !== newVal)
+                    throw new MstError("Tried to change identifier from '".concat(currentVal, "' to '").concat(newVal, "'. Changing identifiers is not allowed."));
+                current.setParent(parent, subpath);
+                return current;
+            }
+        });
+        Object.defineProperty(IdentifierBigintType.prototype, "isValidSnapshot", {
+            enumerable: false,
+            configurable: true,
+            writable: true,
+            value: function (value, context) {
+                if (typeof value === "bigint") {
+                    return typeCheckSuccess();
+                }
+                if (typeof value === "string" || typeof value === "number") {
+                    try {
+                        // BigInt primitive constructor verifies whether the value is a valid integer
+                        BigInt(value);
+                        return typeCheckSuccess();
+                    }
+                    catch (e) {
+                        var errorMessage = e instanceof Error ? e.message : String(e);
+                        return typeCheckFailure(context, value, "Value is not a valid ".concat(this.describe(), ": ").concat(errorMessage));
+                    }
+                }
+                return typeCheckFailure(context, value, "Value is not a valid ".concat(this.describe(), ", expected a bigint, a string or a number"));
+            }
+        });
+        Object.defineProperty(IdentifierBigintType.prototype, "getSnapshot", {
+            enumerable: false,
+            configurable: true,
+            writable: true,
+            value: function (node) {
+                return String(node.storedValue);
+            }
+        });
+        Object.defineProperty(IdentifierBigintType.prototype, "describe", {
+            enumerable: false,
+            configurable: true,
+            writable: true,
+            value: function () {
+                return "identifierBigint";
+            }
+        });
+        return IdentifierBigintType;
+    }(SimpleType));
+    /**
+     * `types.identifierBigint` - Similar to `types.identifier`. Snapshots serialize to string (JSON-safe) and deserialize from string, number or bigint.
+     *
+     * Example:
+     * ```ts
+     *  const Todo = types.model("Todo", {
+     *      id: types.identifierBigint,
+     *      title: types.string
+     *  })
+     * ```
+     *
+     * @returns
+     */
+    var identifierBigint = new IdentifierBigintType();
     /**
      * Returns if a given value represents an identifier type.
      *
@@ -8446,14 +8806,14 @@
      * @hidden
      */
     function isValidIdentifier(id) {
-        return typeof id === "string" || typeof id === "number";
+        return typeof id === "string" || typeof id === "number" || typeof id === "bigint";
     }
     /**
      * @internal
      * @hidden
      */
     function assertIsValidIdentifier(id, argNumber) {
-        assertArg(id, isValidIdentifier, "string or number (identifier)", argNumber);
+        assertArg(id, isValidIdentifier, "string, number or bigint (identifier)", argNumber);
     }
 
     /**
@@ -8614,12 +8974,14 @@
         integer: integer,
         float: float,
         finite: finite,
+        bigint: bigint,
         Date: DatePrimitive,
         map: map,
         array: array,
         frozen: frozen,
         identifier: identifier,
         identifierNumber: identifierNumber,
+        identifierBigint: identifierBigint,
         late: late,
         lazy: lazy,
         undefined: undefinedType,