@jbrowse/mobx-state-tree 6.2.0 → 6.3.0

package/dist/mobx-state-tree.mjs

@@ -480,30 +480,20 @@ function getIdentifier(target) {
     return getStateTreeNode(target).identifier;
 }
 /**
- * Tests if a reference is valid (pointing to an existing node and optionally if alive) and returns such reference if the check passes,
- * else it returns undefined.
- *
- * @param getter Function to access the reference.
- * @param checkIfAlive true to also make sure the referenced node is alive (default), false to skip this check.
- * @returns
+ * Resolves a reference getter to the referenced node, or `undefined` when the
+ * reference is empty, dangling, or (with `checkIfAlive`) points at a dead node.
+ * Backs both {@link tryReference} and {@link isValidReference}.
  */
-function tryReference(getter, checkIfAlive = true) {
+function resolveReference(getter, checkIfAlive) {
     try {
         const node = getter();
         if (node === undefined || node === null) {
             return undefined;
         }
-        else if (isStateTreeNode(node)) {
-            if (!checkIfAlive) {
-                return node;
-            }
-            else {
-                return isAlive(node) ? node : undefined;
-            }
-        }
-        else {
+        if (!isStateTreeNode(node)) {
             throw fail("The reference to be checked is not one of node, null or undefined");
         }
+        return !checkIfAlive || isAlive(node) ? node : undefined;
     }
     catch (e) {
         if (e instanceof InvalidReferenceError) {
@@ -512,6 +502,17 @@ function tryReference(getter, checkIfAlive = true) {
         throw e;
     }
 }
+/**
+ * Tests if a reference is valid (pointing to an existing node and optionally if alive) and returns such reference if the check passes,
+ * else it returns undefined.
+ *
+ * @param getter Function to access the reference.
+ * @param checkIfAlive true to also make sure the referenced node is alive (default), false to skip this check.
+ * @returns
+ */
+function tryReference(getter, checkIfAlive = true) {
+    return resolveReference(getter, checkIfAlive);
+}
 /**
  * Tests if a reference is valid (pointing to an existing node and optionally if alive) and returns if the check passes or not.
  *
@@ -520,24 +521,7 @@ function tryReference(getter, checkIfAlive = true) {
  * @returns
  */
 function isValidReference(getter, checkIfAlive = true) {
-    try {
-        const node = getter();
-        if (node === undefined || node === null) {
-            return false;
-        }
-        else if (isStateTreeNode(node)) {
-            return checkIfAlive ? isAlive(node) : true;
-        }
-        else {
-            throw fail("The reference to be checked is not one of node, null or undefined");
-        }
-    }
-    catch (e) {
-        if (e instanceof InvalidReferenceError) {
-            return false;
-        }
-        throw e;
-    }
+    return resolveReference(getter, checkIfAlive) !== undefined;
 }
 /**
  * Try to resolve a given path relative to a given node.
@@ -1959,7 +1943,6 @@ function assertIsType(type, argNumber) {
     assertArg(type, isType, "mobx-state-tree type", argNumber);
 }
 
-const runningActions = new Map();
 /**
  * Note: Consider migrating to `createActionTrackingMiddleware2`, it is easier to use.
  *
@@ -1975,6 +1958,12 @@ const runningActions = new Map();
  * @returns
  */
 function createActionTrackingMiddleware(hooks) {
+    // per middleware, not per module: the entries hold the `context` this
+    // middleware's own onStart returned, so two middlewares on one tree would
+    // otherwise overwrite each other's context and then delete the shared entry —
+    // whichever saw `flow_return` second dereferenced `undefined`.
+    // createActionTrackingMiddleware2 scopes its map the same way.
+    const runningActions = new Map();
     return function actionTrackingMiddleware(call, next, _abort) {
         switch (call.type) {
             case "action": {
@@ -2697,6 +2686,8 @@ function shortenPrintValue(valueInString) {
 }
 function toErrorString(error) {
     const { value } = error;
+    // every context entry carries a type: they are built by getContextForPath and
+    // by typecheck's initial `[{ path: "", type }]`
     const type = error.context[error.context.length - 1].type;
     const fullPath = error.context
         .map(({ path }) => path)
@@ -2708,14 +2699,21 @@ function toErrorString(error) {
         : isPrimitive(value)
             ? "value"
             : "snapshot";
-    const isSnapshotCompatible = type && isStateTreeNode(value) && type.is(getStateTreeNode(value).snapshot);
-    return `${pathPrefix}${currentTypename} ${shortenPrintValue(prettyPrintValue(value))} is not assignable ${type ? `to type: \`${type.name}\`` : ``}${error.message ? ` (${error.message})` : ""}${type
-        ? isPrimitiveType(type) || isPrimitive(value)
-            ? `.`
-            : `, expected an instance of \`${type.name}\` or a snapshot like \`${shortenPrintValue(type.describe())}\` instead.${isSnapshotCompatible
-                ? " (Note that a snapshot of the provided value is compatible with the targeted type)"
-                : ""}`
-        : `.`}`;
+    let expectation;
+    if (isPrimitiveType(type) || isPrimitive(value)) {
+        expectation = ".";
+    }
+    else {
+        // `isPrimitiveType` is declared `(type: IT) => type is IT`, so its negative
+        // branch narrows to `never` rather than to "some non-primitive type"; the
+        // annotation restores the type it actually has here.
+        const complexType = type;
+        const isSnapshotCompatible = isStateTreeNode(value) && complexType.is(getStateTreeNode(value).snapshot);
+        expectation = `, expected an instance of \`${complexType.name}\` or a snapshot like \`${shortenPrintValue(complexType.describe())}\` instead.${isSnapshotCompatible
+            ? " (Note that a snapshot of the provided value is compatible with the targeted type)"
+            : ""}`;
+    }
+    return `${pathPrefix}${currentTypename} ${shortenPrintValue(prettyPrintValue(value))} is not assignable to type: \`${type.name}\`${error.message ? ` (${error.message})` : ""}${expectation}`;
 }
 /**
  * @internal
@@ -3544,6 +3542,8 @@ function createFlowSpawner(name, generator) {
     const spawner = function flowSpawner(...flowArgs) {
         // Implementation based on https://github.com/tj/co/blob/master/index.js
         const runId = getNextActionId();
+        // no `!`: the guard below is the point, and asserting non-null first made it
+        // dead to the checker while leaving it live at runtime
         const parentContext = getCurrentActionContext();
         if (!parentContext) {
             throw fail("a mst flow must always have a parent context");
@@ -3812,8 +3812,10 @@ class SnapshotProcessor extends BaseType {
         return sn;
     }
     _fixNode(node) {
-        // the node has to use these methods rather than the original type ones
-        proxyNodeTypeMethods(node.type, this, "create");
+        // the node's type is the *inner* type, so `getType(instance).create(...)`
+        // would bypass the processors — point it at ours instead
+        const nodeType = node.type;
+        nodeType.create = this.create.bind(this);
         if (node instanceof ObjectNode) {
             node.hasSnapshotPostProcessor = !!this._processors.postProcessor;
         }
@@ -3882,11 +3884,6 @@ class SnapshotProcessor extends BaseType {
         return this._subtype.isMatchingSnapshotId(current, processedSn);
     }
 }
-function proxyNodeTypeMethods(nodeType, snapshotProcessorType, ...methods) {
-    for (const method of methods) {
-        nodeType[method] = snapshotProcessorType[method].bind(snapshotProcessorType);
-    }
-}
 /**
  * `types.snapshotProcessor` - Runs a pre/post snapshot processor before/after serializing a given type.
  *
@@ -3937,6 +3934,41 @@ function snapshotProcessor(type, processors, name) {
     return new SnapshotProcessor(type, processors, name);
 }
 
+/**
+ * Append `hooks` to a collection type's initializer list. `EMPTY_ARRAY` is the
+ * shared default, so a type that never calls `.hooks()` allocates nothing.
+ *
+ * @internal
+ * @hidden
+ */
+function appendHookInitializer(current, hooks) {
+    return current.length > 0 ? [...current, hooks] : [hooks];
+}
+/**
+ * Install every hook the type's initializers produce onto `instance` as an MST
+ * action, mirroring how a model's `.actions()` members are attached.
+ *
+ * @internal
+ * @hidden
+ */
+function installHookInitializers(hookInitializers, instance) {
+    const addProp = !devMode() ? addHiddenFinalProp : addHiddenWritableProp;
+    for (const initializer of hookInitializers) {
+        const hooks = initializer(instance);
+        for (const name of Object.keys(hooks)) {
+            const hook = hooks[name];
+            addProp(instance, name, createActionInvoker(instance, name, hook));
+        }
+    }
+}
+/**
+ * The empty initializer list every collection type starts with.
+ *
+ * @internal
+ * @hidden
+ */
+const NO_HOOK_INITIALIZERS = EMPTY_ARRAY;
+
 const needsIdentifierError = `Map.put can only be used to store complex values that have an identifier type attribute`;
 function tryCollectModelTypes(type, modelTypes) {
     const subtypes = type.getSubTypes();
@@ -4033,24 +4065,21 @@ class MSTMap extends ObservableMap {
  */
 class MapType extends ComplexType {
     _subType;
+    hookInitializers;
     identifierMode = MapIdentifierMode.UNKNOWN;
     mapIdentifierAttribute = undefined;
     flags = TypeFlags.Map;
-    hookInitializers = [];
-    constructor(_subType, hookInitializers = []) {
+    constructor(_subType, hookInitializers = NO_HOOK_INITIALIZERS) {
         super();
         this._subType = _subType;
-        this._determineIdentifierMode();
         this.hookInitializers = hookInitializers;
+        this._determineIdentifierMode();
     }
     computeName() {
         return `Map<string, ${this._subType.name}>`;
     }
     hooks(hooks) {
-        const hookInitializers = this.hookInitializers.length > 0
-            ? this.hookInitializers.concat(hooks)
-            : [hooks];
-        return new MapType(this._subType, hookInitializers);
+        return new MapType(this._subType, appendHookInitializer(this.hookInitializers, hooks));
     }
     instantiate(parent, subpath, environment, initialValue) {
         this._determineIdentifierMode();
@@ -4093,15 +4122,7 @@ class MapType extends ComplexType {
     }
     finalizeNewInstance(node, instance) {
         _interceptReads(instance, node.unbox);
-        const type = node.type;
-        type.hookInitializers.forEach(initializer => {
-            const hooks = initializer(instance);
-            Object.keys(hooks).forEach(name => {
-                const hook = hooks[name];
-                const actionInvoker = createActionInvoker(instance, name, hook);
-                (!devMode() ? addHiddenFinalProp : addHiddenWritableProp)(instance, name, actionInvoker);
-            });
-        });
+        installHookInitializers(node.type.hookInitializers, instance);
         intercept(instance, this.willChange);
         observe(instance, this.didChange);
     }
@@ -4302,9 +4323,9 @@ function isMapType(type) {
  */
 class ArrayType extends ComplexType {
     _subType;
+    hookInitializers;
     flags = TypeFlags.Array;
-    hookInitializers = [];
-    constructor(_subType, hookInitializers = []) {
+    constructor(_subType, hookInitializers = NO_HOOK_INITIALIZERS) {
         super();
         this._subType = _subType;
         this.hookInitializers = hookInitializers;
@@ -4313,10 +4334,7 @@ class ArrayType extends ComplexType {
         return `${this._subType.name}[]`;
     }
     hooks(hooks) {
-        const hookInitializers = this.hookInitializers.length > 0
-            ? this.hookInitializers.concat(hooks)
-            : [hooks];
-        return new ArrayType(this._subType, hookInitializers);
+        return new ArrayType(this._subType, appendHookInitializer(this.hookInitializers, hooks));
     }
     instantiate(parent, subpath, environment, initialValue) {
         return createObjectNode(this, parent, subpath, environment, initialValue);
@@ -4336,15 +4354,7 @@ class ArrayType extends ComplexType {
     }
     finalizeNewInstance(node, instance) {
         _getAdministration(instance).dehancer = node.unbox;
-        const type = node.type;
-        type.hookInitializers.forEach(initializer => {
-            const hooks = initializer(instance);
-            Object.keys(hooks).forEach(name => {
-                const hook = hooks[name];
-                const actionInvoker = createActionInvoker(instance, name, hook);
-                (!devMode() ? addHiddenFinalProp : addHiddenWritableProp)(instance, name, actionInvoker);
-            });
-        });
+        installHookInitializers(node.type.hookInitializers, instance);
         intercept(instance, this.willChange);
         observe(instance, this.didChange);
     }
@@ -4720,8 +4730,7 @@ function getPropObservables(storedValue) {
 function objectTypeToString() {
     return getStateTreeNode(this).toString();
 }
-const defaultObjectOptions = {
-    name: "AnonymousModel"};
+const ANONYMOUS_MODEL_NAME = "AnonymousModel";
 /**
  * A plain loop rather than `forAllProps`, which allocated a closure and made an
  * indirect call per property. This runs once per `types.model()` over every
@@ -4807,7 +4816,7 @@ class ModelType extends ComplexType {
         // `??`, not `||`: `types.model("", {})` names the model "". The old
         // `Object.assign(this, defaults, opts)` below overwrote the `||` fallback
         // with opts.name afterwards, so that only worked by accident.
-        super(opts.name ?? defaultObjectOptions.name);
+        super(opts.name ?? ANONYMOUS_MODEL_NAME);
         // Every field is assigned here, unconditionally and in a fixed order,
         // rather than by `Object.assign(this, defaultObjectOptions, opts)`. `opts`
         // carries a different key set at each of the three call sites — `model()`,
@@ -4947,19 +4956,7 @@ class ModelType extends ComplexType {
     }
     extend(fn) {
         const initializer = (self) => {
-            const { actions, views, state, ...rest } = fn(self);
-            for (const key in rest) {
-                throw fail(`The \`extend\` function should return an object with a subset of the fields 'actions', 'views' and 'state'. Found invalid key '${key}'`);
-            }
-            if (state) {
-                this.instantiateVolatileState(self, state);
-            }
-            if (views) {
-                this.instantiateViews(self, views);
-            }
-            if (actions) {
-                this.instantiateActions(self, actions);
-            }
+            this.applyExtension(self, fn(self), "The `extend` function");
             return self;
         };
         return this.cloneAndEnhance({ initializers: [initializer] });
@@ -4980,9 +4977,17 @@ class ModelType extends ComplexType {
      * are permitted (see extendInstance, which runs this in an action context).
      */
     applyExtensionToInstance(self, extension) {
+        this.applyExtension(self, extension, "extendInstance");
+    }
+    /**
+     * Materializes an `{ actions, views, state }` bundle onto an instance. Shared
+     * by `.extend()` (at creation time) and `applyExtensionToInstance` (on a live
+     * instance); `subject` only names the caller in the invalid-key error.
+     */
+    applyExtension(self, extension, subject) {
         const { actions, views, state, ...rest } = extension;
         for (const key in rest) {
-            throw fail(`extendInstance should return an object with a subset of the fields 'actions', 'views' and 'state'. Found invalid key '${key}'`);
+            throw fail(`${subject} should return an object with a subset of the fields 'actions', 'views' and 'state'. Found invalid key '${key}'`);
         }
         if (state) {
             this.instantiateVolatileState(self, state);
@@ -5272,7 +5277,7 @@ function model(...args) {
     if (devMode() && typeof args[0] !== "string" && args[1]) {
         throw fail("Model creation failed. First argument must be a string when two arguments are provided");
     }
-    const name = typeof args[0] === "string" ? args.shift() : "AnonymousModel";
+    const name = typeof args[0] === "string" ? args.shift() : ANONYMOUS_MODEL_NAME;
     const properties = args.shift() || {};
     return new ModelType({ name, properties });
 }
@@ -5286,7 +5291,7 @@ function model(...args) {
 function compose(...args) {
     // TODO: just join the base type names if no name is provided
     const hasTypename = typeof args[0] === "string";
-    const typeName = hasTypename ? args[0] : "AnonymousModel";
+    const typeName = hasTypename ? args[0] : ANONYMOUS_MODEL_NAME;
     if (hasTypename) {
         args.shift();
     }
@@ -5512,6 +5517,12 @@ function getPrimitiveFactoryFromValue(value) {
 /**
  * Returns if a given value represents a primitive type.
  *
+ * Returns a plain `boolean`, not a `type is IT` predicate: with the parameter
+ * typed as `IT`, narrowing to `IT` was a no-op in the positive branch while
+ * collapsing the negative one to `never`, so `if (!isX(t)) { t.name }` failed
+ * to compile. Guards with a distinct narrowing target (`isArrayType`,
+ * `isMapType`, `isModelType`) keep their predicate.
+ *
  * @param type
  * @returns
  */
@@ -5576,6 +5587,12 @@ function literal(value) {
 /**
  * Returns if a given value represents a literal type.
  *
+ * Returns a plain `boolean`, not a `type is IT` predicate: with the parameter
+ * typed as `IT`, narrowing to `IT` was a no-op in the positive branch while
+ * collapsing the negative one to `never`, so `if (!isX(t)) { t.name }` failed
+ * to compile. Guards with a distinct narrowing target (`isArrayType`,
+ * `isMapType`, `isModelType`) keep their predicate.
+ *
  * @param type
  * @returns
  */
@@ -5655,6 +5672,12 @@ function refinement(...args) {
 /**
  * Returns if a given value is a refinement type.
  *
+ * Returns a plain `boolean`, not a `type is IT` predicate: with the parameter
+ * typed as `IT`, narrowing to `IT` was a no-op in the positive branch while
+ * collapsing the negative one to `never`, so `if (!isX(t)) { t.name }` failed
+ * to compile. Guards with a distinct narrowing target (`isArrayType`,
+ * `isMapType`, `isModelType`) keep their predicate.
+ *
  * @param type
  * @returns
  */
@@ -5992,7 +6015,8 @@ class Union extends BaseType {
         // - A failure is the definitive, scoped error only when every member is
         //   discriminated; otherwise a catch-all could still accept the value, so
         //   fall through to full validation.
-        if (isPlainObject(value) && !isStateTreeNode(value)) {
+        const isSnapshotObject = isPlainObject(value) && !isStateTreeNode(value);
+        if (isSnapshotObject) {
             const discriminator = value.type;
             if (typeof discriminator === "string") {
                 const candidate = this._findCandidateByTypeDiscriminator(discriminator);
@@ -6008,7 +6032,7 @@ class Union extends BaseType {
         // for plain-object snapshots, prefer union members whose literal-typed
         // discriminator properties match the value (e.g. {type: "MsaView"})
         // so error output is scoped to the intended branch instead of every member
-        const candidates = isPlainObject(value) && !isStateTreeNode(value)
+        const candidates = isSnapshotObject
             ? this._types.filter(t => this.snapshotLooksLikeType(value, t))
             : [];
         const typesToValidate = candidates.length > 0 ? candidates : this._types;
@@ -6078,6 +6102,12 @@ function union(...args) {
 /**
  * Returns if a given value represents a union type.
  *
+ * Returns a plain `boolean`, not a `type is IT` predicate: with the parameter
+ * typed as `IT`, narrowing to `IT` was a no-op in the positive branch while
+ * collapsing the negative one to `never`, so `if (!isX(t)) { t.name }` failed
+ * to compile. Guards with a distinct narrowing target (`isArrayType`,
+ * `isMapType`, `isModelType`) keep their predicate.
+ *
  * @param type
  * @returns
  */
@@ -6256,6 +6286,12 @@ const undefinedAsOptionalValues = [undefined];
 /**
  * Returns if a value represents an optional type.
  *
+ * Returns a plain `boolean`, not a `type is IT` predicate: with the parameter
+ * typed as `IT`, narrowing to `IT` was a no-op in the positive branch while
+ * collapsing the negative one to `never`, so `if (!isX(t)) { t.name }` failed
+ * to compile. Guards with a distinct narrowing target (`isArrayType`,
+ * `isMapType`, `isModelType`) keep their predicate.
+ *
  * @template IT
  * @param type
  * @returns
@@ -6502,6 +6538,12 @@ function late(nameOrType, maybeType) {
 /**
  * Returns if a given value represents a late type.
  *
+ * Returns a plain `boolean`, not a `type is IT` predicate: with the parameter
+ * typed as `IT`, narrowing to `IT` was a no-op in the positive branch while
+ * collapsing the negative one to `never`, so `if (!isX(t)) { t.name }` failed
+ * to compile. Guards with a distinct narrowing target (`isArrayType`,
+ * `isMapType`, `isModelType`) keep their predicate.
+ *
  * @param type
  * @returns
  */
@@ -6670,6 +6712,12 @@ function frozen(arg) {
 /**
  * Returns if a given value represents a frozen type.
  *
+ * Returns a plain `boolean`, not a `type is IT` predicate: with the parameter
+ * typed as `IT`, narrowing to `IT` was a no-op in the positive branch while
+ * collapsing the negative one to `never`, so `if (!isX(t)) { t.name }` failed
+ * to compile. Guards with a distinct narrowing target (`isArrayType`,
+ * `isMapType`, `isModelType`) keep their predicate.
+ *
  * @param type
  * @returns
  */
@@ -6900,9 +6948,6 @@ class BaseReferenceType extends SimpleType {
  * @hidden
  */
 class IdentifierReferenceType extends BaseReferenceType {
-    constructor(targetType, onInvalidated) {
-        super(targetType, onInvalidated);
-    }
     getValue(storedRefNode) {
         if (!storedRefNode.isAlive) {
             return undefined;
@@ -7018,6 +7063,12 @@ function reference(subType, options) {
 /**
  * Returns if a given value represents a reference type.
  *
+ * Returns a plain `boolean`, not a `type is IT` predicate: with the parameter
+ * typed as `IT`, narrowing to `IT` was a no-op in the positive branch while
+ * collapsing the negative one to `never`, so `if (!isX(t)) { t.name }` failed
+ * to compile. Guards with a distinct narrowing target (`isArrayType`,
+ * `isMapType`, `isModelType`) keep their predicate.
+ *
  * @param type
  * @returns
  */
@@ -7150,6 +7201,12 @@ const identifierNumber = new IdentifierNumberType();
 /**
  * Returns if a given value represents an identifier type.
  *
+ * Returns a plain `boolean`, not a `type is IT` predicate: with the parameter
+ * typed as `IT`, narrowing to `IT` was a no-op in the positive branch while
+ * collapsing the negative one to `never`, so `if (!isX(t)) { t.name }` failed
+ * to compile. Guards with a distinct narrowing target (`isArrayType`,
+ * `isMapType`, `isModelType`) keep their predicate.
+ *
  * @param type
  * @returns
  */