mobx-state-tree 7.1.0 → 7.2.0

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

@@ -1538,6 +1538,12 @@ var ObjectNode = /** @class */ (function (_super) {
             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,
@@ -1608,8 +1614,8 @@ var ObjectNode = /** @class */ (function (_super) {
                     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);
@@ -1747,6 +1753,33 @@ var ObjectNode = /** @class */ (function (_super) {
         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,
@@ -3228,9 +3261,10 @@ function runWithActionContext(context, fn) {
     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;
@@ -3384,17 +3418,44 @@ var CollectedMiddlewares = /** @class */ (function () {
     });
     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 ? action(call.name, execute)() : action(execute)();
+    }
     var middlewares = new CollectedMiddlewares(node, originalFn);
     // Short circuit
     if (middlewares.isEmpty)
-        return 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 action(originalFn).apply(null, call.args);
+            return runInActionScope(call, originalFn);
         }
         // skip hooks if asked to
         if (!middleware.includeHooks && Hook[call.name]) {
@@ -3430,6 +3491,9 @@ function runMiddleWares(node, baseCall, originalFn) {
                 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);
@@ -8129,7 +8193,7 @@ var BaseReferenceType = /** @class */ (function (_super) {
         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", {
@@ -8218,6 +8282,23 @@ var BaseReferenceType = /** @class */ (function (_super) {
                     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) {
@@ -8235,12 +8316,13 @@ var BaseReferenceType = /** @class */ (function (_super) {
                         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);
                         }
                     }
@@ -8590,7 +8672,7 @@ var IdentifierNumberType = /** @class */ (function (_super) {
  * 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
@@ -8617,6 +8699,110 @@ var identifier = new IdentifierType();
  * @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.
  *
@@ -8638,14 +8824,14 @@ function normalizeIdentifier(id) {
  * @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);
 }
 
 /**
@@ -8813,6 +8999,7 @@ var types = {
     frozen: frozen,
     identifier: identifier,
     identifierNumber: identifierNumber,
+    identifierBigint: identifierBigint,
     late: late,
     lazy: lazy,
     undefined: undefinedType,

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

@@ -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,
@@ -3232,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;
@@ -3388,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]) {
@@ -3434,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);
@@ -8111,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", {
@@ -8200,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) {
@@ -8217,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);
                             }
                         }
@@ -8572,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
@@ -8599,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.
      *
@@ -8620,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);
     }
 
     /**
@@ -8795,6 +8981,7 @@
         frozen: frozen,
         identifier: identifier,
         identifierNumber: identifierNumber,
+        identifierBigint: identifierBigint,
         late: late,
         lazy: lazy,
         undefined: undefinedType,