@jbrowse/mobx-state-tree 5.6.9 → 5.7.0

package/esm/core/node/scalar-node.js

@@ -0,0 +1,86 @@
+import { action } from "mobx";
+import { BaseNode } from "./BaseNode.js";
+import { NodeLifeCycle, devMode, fail, freeze } from "../../internal.js";
+/**
+ * @internal
+ * @hidden
+ */
+export class ScalarNode extends BaseNode {
+    constructor(simpleType, parent, subpath, environment, initialSnapshot) {
+        super(simpleType, parent, subpath, environment);
+        try {
+            this.storedValue = simpleType.createNewInstance(initialSnapshot);
+        }
+        catch (e) {
+            // short-cut to die the instance, to avoid the snapshot computed starting to throw...
+            this.state = NodeLifeCycle.DEAD;
+            throw e;
+        }
+        this.state = NodeLifeCycle.CREATED;
+        // for scalar nodes there's no point in firing this event since it would fire on the constructor, before
+        // anybody can actually register for/listen to it
+        // this.fireHook(Hook.AfterCreate)
+        this.finalizeCreation();
+    }
+    get root() {
+        // future optimization: store root ref in the node and maintain it
+        if (!this.parent) {
+            throw fail(`This scalar node is not part of a tree`);
+        }
+        return this.parent.root;
+    }
+    setParent(newParent, subpath) {
+        const parentChanged = this.parent !== newParent;
+        const subpathChanged = this.subpath !== subpath;
+        if (!parentChanged && !subpathChanged) {
+            return;
+        }
+        if (devMode()) {
+            if (!subpath) {
+                // istanbul ignore next
+                throw fail("assertion failed: subpath expected");
+            }
+            if (!newParent) {
+                // istanbul ignore next
+                throw fail("assertion failed: parent expected");
+            }
+            if (parentChanged) {
+                // istanbul ignore next
+                throw fail("assertion failed: scalar nodes cannot change their parent");
+            }
+        }
+        this.environment = undefined; // use parent's
+        this.baseSetParent(this.parent, subpath);
+    }
+    get snapshot() {
+        return freeze(this.getSnapshot());
+    }
+    getSnapshot() {
+        return this.type.getSnapshot(this);
+    }
+    toString() {
+        const path = (this.isAlive ? this.path : this.pathUponDeath) || "<root>";
+        return `${this.type.name}@${path}${this.isAlive ? "" : " [dead]"}`;
+    }
+    die() {
+        if (!this.isAlive || this.state === NodeLifeCycle.DETACHING) {
+            return;
+        }
+        this.aboutToDie();
+        this.finalizeDeath();
+    }
+    finalizeCreation() {
+        this.baseFinalizeCreation();
+    }
+    aboutToDie() {
+        this.baseAboutToDie();
+    }
+    finalizeDeath() {
+        this.baseFinalizeDeath();
+    }
+    fireHook(name) {
+        this.fireInternalHook(name);
+    }
+}
+ScalarNode.prototype.die = action(ScalarNode.prototype.die);
+//# sourceMappingURL=scalar-node.js.map

package/esm/core/node/scalar-node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scalar-node.js","sourceRoot":"","sources":["../../../src/core/node/scalar-node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AAE7B,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAExC,OAAO,EAGL,aAAa,EACb,OAAO,EACP,IAAI,EACJ,MAAM,EACP,MAAM,mBAAmB,CAAA;AAE1B;;;GAGG;AACH,MAAM,OAAO,UAAoB,SAAQ,QAAiB;IASxD,YACE,UAA+B,EAC/B,MAA4B,EAC5B,OAAe,EACf,WAAgB,EAChB,eAAkB;QAElB,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,CAAA;QAC/C,IAAI,CAAC;YACH,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAA;QAClE,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,qFAAqF;YACrF,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,IAAI,CAAA;YAC/B,MAAM,CAAC,CAAA;QACT,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,OAAO,CAAA;QAClC,wGAAwG;QACxG,iDAAiD;QACjD,kCAAkC;QAElC,IAAI,CAAC,gBAAgB,EAAE,CAAA;IACzB,CAAC;IAED,IAAI,IAAI;QACN,kEAAkE;QAClE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,IAAI,CAAC,wCAAwC,CAAC,CAAA;QACtD,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAA;IACzB,CAAC;IAED,SAAS,CAAC,SAAwB,EAAE,OAAe;QACjD,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,KAAK,SAAS,CAAA;QAC/C,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,KAAK,OAAO,CAAA;QAE/C,IAAI,CAAC,aAAa,IAAI,CAAC,cAAc,EAAE,CAAC;YACtC,OAAM;QACR,CAAC;QAED,IAAI,OAAO,EAAE,EAAE,CAAC;YACd,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,uBAAuB;gBACvB,MAAM,IAAI,CAAC,oCAAoC,CAAC,CAAA;YAClD,CAAC;YACD,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,uBAAuB;gBACvB,MAAM,IAAI,CAAC,mCAAmC,CAAC,CAAA;YACjD,CAAC;YACD,IAAI,aAAa,EAAE,CAAC;gBAClB,uBAAuB;gBACvB,MAAM,IAAI,CAAC,2DAA2D,CAAC,CAAA;YACzE,CAAC;QACH,CAAC;QAED,IAAI,CAAC,WAAW,GAAG,SAAS,CAAA,CAAC,eAAe;QAC5C,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC1C,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;IACnC,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;IACpC,CAAC;IAED,QAAQ;QACN,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,QAAQ,CAAA;QACxE,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,CAAA;IACpE,CAAC;IAED,GAAG;QACD,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,KAAK,aAAa,CAAC,SAAS,EAAE,CAAC;YAC5D,OAAM;QACR,CAAC;QACD,IAAI,CAAC,UAAU,EAAE,CAAA;QACjB,IAAI,CAAC,aAAa,EAAE,CAAA;IACtB,CAAC;IAED,gBAAgB;QACd,IAAI,CAAC,oBAAoB,EAAE,CAAA;IAC7B,CAAC;IAED,UAAU;QACR,IAAI,CAAC,cAAc,EAAE,CAAA;IACvB,CAAC;IAED,aAAa;QACX,IAAI,CAAC,iBAAiB,EAAE,CAAA;IAC1B,CAAC;IAES,QAAQ,CAAC,IAAU;QAC3B,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;IAC7B,CAAC;CACF;AACD,UAAU,CAAC,SAAS,CAAC,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA","sourcesContent":["import { action } from \"mobx\"\n\nimport { BaseNode } from \"./BaseNode.ts\"\nimport { SimpleType } from \"../type/type.ts\"\nimport {\n  type AnyObjectNode,\n  Hook,\n  NodeLifeCycle,\n  devMode,\n  fail,\n  freeze\n} from \"../../internal.ts\"\n\n/**\n * @internal\n * @hidden\n */\nexport class ScalarNode<C, S, T> extends BaseNode<C, S, T> {\n  // note about hooks:\n  // - afterCreate is not emmited in scalar nodes, since it would be emitted in the\n  //   constructor, before it can be subscribed by anybody\n  // - afterCreationFinalization could be emitted, but there's no need for it right now\n  // - beforeDetach is never emitted for scalar nodes, since they cannot be detached\n\n  declare readonly type: SimpleType<C, S, T>\n\n  constructor(\n    simpleType: SimpleType<C, S, T>,\n    parent: AnyObjectNode | null,\n    subpath: string,\n    environment: any,\n    initialSnapshot: C\n  ) {\n    super(simpleType, parent, subpath, environment)\n    try {\n      this.storedValue = simpleType.createNewInstance(initialSnapshot)\n    } catch (e) {\n      // short-cut to die the instance, to avoid the snapshot computed starting to throw...\n      this.state = NodeLifeCycle.DEAD\n      throw e\n    }\n\n    this.state = NodeLifeCycle.CREATED\n    // for scalar nodes there's no point in firing this event since it would fire on the constructor, before\n    // anybody can actually register for/listen to it\n    // this.fireHook(Hook.AfterCreate)\n\n    this.finalizeCreation()\n  }\n\n  get root(): AnyObjectNode {\n    // future optimization: store root ref in the node and maintain it\n    if (!this.parent) {\n      throw fail(`This scalar node is not part of a tree`)\n    }\n    return this.parent.root\n  }\n\n  setParent(newParent: AnyObjectNode, subpath: string): void {\n    const parentChanged = this.parent !== newParent\n    const subpathChanged = this.subpath !== subpath\n\n    if (!parentChanged && !subpathChanged) {\n      return\n    }\n\n    if (devMode()) {\n      if (!subpath) {\n        // istanbul ignore next\n        throw fail(\"assertion failed: subpath expected\")\n      }\n      if (!newParent) {\n        // istanbul ignore next\n        throw fail(\"assertion failed: parent expected\")\n      }\n      if (parentChanged) {\n        // istanbul ignore next\n        throw fail(\"assertion failed: scalar nodes cannot change their parent\")\n      }\n    }\n\n    this.environment = undefined // use parent's\n    this.baseSetParent(this.parent, subpath)\n  }\n\n  get snapshot(): S {\n    return freeze(this.getSnapshot())\n  }\n\n  getSnapshot(): S {\n    return this.type.getSnapshot(this)\n  }\n\n  toString(): string {\n    const path = (this.isAlive ? this.path : this.pathUponDeath) || \"<root>\"\n    return `${this.type.name}@${path}${this.isAlive ? \"\" : \" [dead]\"}`\n  }\n\n  die(): void {\n    if (!this.isAlive || this.state === NodeLifeCycle.DETACHING) {\n      return\n    }\n    this.aboutToDie()\n    this.finalizeDeath()\n  }\n\n  finalizeCreation(): void {\n    this.baseFinalizeCreation()\n  }\n\n  aboutToDie(): void {\n    this.baseAboutToDie()\n  }\n\n  finalizeDeath(): void {\n    this.baseFinalizeDeath()\n  }\n\n  protected fireHook(name: Hook): void {\n    this.fireInternalHook(name)\n  }\n}\nScalarNode.prototype.die = action(ScalarNode.prototype.die)\n"]}

package/esm/core/process.d.ts

@@ -0,0 +1,50 @@
+/**
+ * @deprecated has been renamed to `flow()`.
+ * @hidden
+ */
+export declare function process<R>(generator: () => IterableIterator<any>): () => Promise<R>;
+/**
+ * @deprecated has been renamed to `flow()`.
+ * @hidden
+ */
+export declare function process<A1>(generator: (a1: A1) => IterableIterator<any>): (a1: A1) => Promise<any>;
+/**
+ * @deprecated has been renamed to `flow()`.
+ * @hidden
+ */
+export declare function process<A1, A2>(generator: (a1: A1, a2: A2) => IterableIterator<any>): (a1: A1, a2: A2) => Promise<any>;
+/**
+ * @deprecated has been renamed to `flow()`.
+ * @hidden
+ */
+export declare function process<A1, A2, A3>(generator: (a1: A1, a2: A2, a3: A3) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3) => Promise<any>;
+/**
+ * @deprecated has been renamed to `flow()`.
+ * @hidden
+ */
+export declare function process<A1, A2, A3, A4>(generator: (a1: A1, a2: A2, a3: A3, a4: A4) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3, a4: A4) => Promise<any>;
+/**
+ * @deprecated has been renamed to `flow()`.
+ * @hidden
+ */
+export declare function process<A1, A2, A3, A4, A5>(generator: (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5) => Promise<any>;
+/**
+ * @deprecated has been renamed to `flow()`.
+ * @hidden
+ */
+export declare function process<A1, A2, A3, A4, A5, A6>(generator: (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6) => Promise<any>;
+/**
+ * @deprecated has been renamed to `flow()`.
+ * @hidden
+ */
+export declare function process<A1, A2, A3, A4, A5, A6, A7>(generator: (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7) => Promise<any>;
+/**
+ * @deprecated has been renamed to `flow()`.
+ * @hidden
+ */
+export declare function process<A1, A2, A3, A4, A5, A6, A7, A8>(generator: (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7, a8: A8) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7, a8: A8) => Promise<any>;
+/**
+ * @internal
+ * @hidden
+ */
+export declare function createProcessSpawner(name: string, generator: Function): (this: any, ...flowArgs: any[]) => Promise<unknown>;

package/esm/core/process.js

@@ -0,0 +1,35 @@
+import { createFlowSpawner, deprecated, flow } from "../internal.js";
+// based on: https://github.com/mobxjs/mobx-utils/blob/master/src/async-action.ts
+/*
+    All contents of this file are deprecated.
+
+    The term `process` has been replaced with `flow` to avoid conflicts with the
+    global `process` object.
+
+    Refer to `flow.ts` for any further changes to this implementation.
+*/
+const DEPRECATION_MESSAGE = "See https://github.com/mobxjs/mobx-state-tree/issues/399 for more information. " +
+    "Note that the middleware event types starting with `process` now start with `flow`.";
+/**
+ * @hidden
+ *
+ * @deprecated has been renamed to `flow()`.
+ * See https://github.com/mobxjs/mobx-state-tree/issues/399 for more information.
+ * Note that the middleware event types starting with `process` now start with `flow`.
+ *
+ * @returns {Promise}
+ */
+export function process(asyncAction) {
+    deprecated("process", "`process()` has been renamed to `flow()`. " + DEPRECATION_MESSAGE);
+    return flow(asyncAction);
+}
+/**
+ * @internal
+ * @hidden
+ */
+export function createProcessSpawner(name, generator) {
+    deprecated("process", "`createProcessSpawner()` has been renamed to `createFlowSpawner()`. " +
+        DEPRECATION_MESSAGE);
+    return createFlowSpawner(name, generator);
+}
+//# sourceMappingURL=process.js.map

package/esm/core/process.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"process.js","sourceRoot":"","sources":["../../src/core/process.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAEpE,iFAAiF;AACjF;;;;;;;EAOE;AAEF,MAAM,mBAAmB,GACvB,iFAAiF;IACjF,qFAAqF,CAAA;AAkGvF;;;;;;;;GAQG;AACH,MAAM,UAAU,OAAO,CAAC,WAAgB;IACtC,UAAU,CACR,SAAS,EACT,4CAA4C,GAAG,mBAAmB,CACnE,CAAA;IACD,OAAO,IAAI,CAAC,WAAW,CAAC,CAAA;AAC1B,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAY,EAAE,SAAmB;IACpE,UAAU,CACR,SAAS,EACT,sEAAsE;QACpE,mBAAmB,CACtB,CAAA;IACD,OAAO,iBAAiB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAA;AAC3C,CAAC","sourcesContent":["import { createFlowSpawner, deprecated, flow } from \"../internal.ts\"\n\n// based on: https://github.com/mobxjs/mobx-utils/blob/master/src/async-action.ts\n/*\n    All contents of this file are deprecated.\n\n    The term `process` has been replaced with `flow` to avoid conflicts with the\n    global `process` object.\n\n    Refer to `flow.ts` for any further changes to this implementation.\n*/\n\nconst DEPRECATION_MESSAGE =\n  \"See https://github.com/mobxjs/mobx-state-tree/issues/399 for more information. \" +\n  \"Note that the middleware event types starting with `process` now start with `flow`.\"\n\n/**\n * @deprecated has been renamed to `flow()`.\n * @hidden\n */\nexport function process<R>(\n  generator: () => IterableIterator<any>\n): () => Promise<R>\n/**\n * @deprecated has been renamed to `flow()`.\n * @hidden\n */\nexport function process<A1>(\n  generator: (a1: A1) => IterableIterator<any>\n): (a1: A1) => Promise<any>\n/**\n * @deprecated has been renamed to `flow()`.\n * @hidden\n */\nexport function process<A1, A2>(\n  generator: (a1: A1, a2: A2) => IterableIterator<any>\n): (a1: A1, a2: A2) => Promise<any>\n/**\n * @deprecated has been renamed to `flow()`.\n * @hidden\n */\nexport function process<A1, A2, A3>(\n  generator: (a1: A1, a2: A2, a3: A3) => IterableIterator<any>\n): (a1: A1, a2: A2, a3: A3) => Promise<any>\n/**\n * @deprecated has been renamed to `flow()`.\n * @hidden\n */\nexport function process<A1, A2, A3, A4>(\n  generator: (a1: A1, a2: A2, a3: A3, a4: A4) => IterableIterator<any>\n): (a1: A1, a2: A2, a3: A3, a4: A4) => Promise<any>\n/**\n * @deprecated has been renamed to `flow()`.\n * @hidden\n */\nexport function process<A1, A2, A3, A4, A5>(\n  generator: (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5) => IterableIterator<any>\n): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5) => Promise<any>\n/**\n * @deprecated has been renamed to `flow()`.\n * @hidden\n */\nexport function process<A1, A2, A3, A4, A5, A6>(\n  generator: (\n    a1: A1,\n    a2: A2,\n    a3: A3,\n    a4: A4,\n    a5: A5,\n    a6: A6\n  ) => IterableIterator<any>\n): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6) => Promise<any>\n/**\n * @deprecated has been renamed to `flow()`.\n * @hidden\n */\nexport function process<A1, A2, A3, A4, A5, A6, A7>(\n  generator: (\n    a1: A1,\n    a2: A2,\n    a3: A3,\n    a4: A4,\n    a5: A5,\n    a6: A6,\n    a7: A7\n  ) => IterableIterator<any>\n): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7) => Promise<any>\n/**\n * @deprecated has been renamed to `flow()`.\n * @hidden\n */\nexport function process<A1, A2, A3, A4, A5, A6, A7, A8>(\n  generator: (\n    a1: A1,\n    a2: A2,\n    a3: A3,\n    a4: A4,\n    a5: A5,\n    a6: A6,\n    a7: A7,\n    a8: A8\n  ) => IterableIterator<any>\n): (\n  a1: A1,\n  a2: A2,\n  a3: A3,\n  a4: A4,\n  a5: A5,\n  a6: A6,\n  a7: A7,\n  a8: A8\n) => Promise<any>\n/**\n * @hidden\n *\n * @deprecated has been renamed to `flow()`.\n * See https://github.com/mobxjs/mobx-state-tree/issues/399 for more information.\n * Note that the middleware event types starting with `process` now start with `flow`.\n *\n * @returns {Promise}\n */\nexport function process(asyncAction: any): any {\n  deprecated(\n    \"process\",\n    \"`process()` has been renamed to `flow()`. \" + DEPRECATION_MESSAGE\n  )\n  return flow(asyncAction)\n}\n\n/**\n * @internal\n * @hidden\n */\nexport function createProcessSpawner(name: string, generator: Function) {\n  deprecated(\n    \"process\",\n    \"`createProcessSpawner()` has been renamed to `createFlowSpawner()`. \" +\n      DEPRECATION_MESSAGE\n  )\n  return createFlowSpawner(name, generator)\n}\n"]}

package/esm/core/type/type-checker.d.ts

@@ -0,0 +1,69 @@
+import { type ExtractCSTWithSTN, type IAnyType } from "../../internal.ts";
+/** Validation context entry, this is, where the validation should run against which type */
+export interface IValidationContextEntry {
+    /** Subpath where the validation should be run, or an empty string to validate it all */
+    path: string;
+    /** Type to validate the subpath against */
+    type: IAnyType;
+}
+/** Array of validation context entries */
+export type IValidationContext = IValidationContextEntry[];
+/** Type validation error */
+export interface IValidationError {
+    /** Validation context */
+    context: IValidationContext;
+    /** Value that was being validated, either a snapshot or an instance */
+    value: any;
+    /** Error message */
+    message?: string;
+}
+/** Type validation result, which is an array of type validation errors */
+export type IValidationResult = IValidationError[];
+/**
+ * @internal
+ * @hidden
+ */
+export declare function prettyPrintValue(value: any): string;
+/**
+ * @internal
+ * @hidden
+ * Pushes a new entry onto the context array (mutates in place for performance).
+ * Returns the same context array for chaining.
+ */
+export declare function getContextForPath(context: IValidationContext, path: string, type: IAnyType): IValidationContext;
+/**
+ * @internal
+ * @hidden
+ * Pops the last entry from the context array (mutates in place).
+ * Must be called after validation to restore context state.
+ */
+export declare function popContext(context: IValidationContext): void;
+/**
+ * @internal
+ * @hidden
+ */
+export declare function typeCheckSuccess(): IValidationResult;
+/**
+ * @internal
+ * @hidden
+ */
+export declare function typeCheckFailure(context: IValidationContext, value: any, message?: string): IValidationResult;
+/**
+ * @internal
+ * @hidden
+ */
+export declare function flattenTypeErrors(errors: IValidationResult[]): IValidationResult;
+/**
+ * @internal
+ * @hidden
+ */
+export declare function typecheckInternal<IT extends IAnyType>(type: IAnyType, value: ExtractCSTWithSTN<IT>): void;
+/**
+ * Run's the typechecker for the given type on the given value, which can be a snapshot or an instance.
+ * Throws if the given value is not according the provided type specification.
+ * Use this if you need typechecks even in a production build (by default all automatic runtime type checks will be skipped in production builds)
+ *
+ * @param type Type to check against.
+ * @param value Value to be checked, either a snapshot or an instance.
+ */
+export declare function typecheck<IT extends IAnyType>(type: IT, value: ExtractCSTWithSTN<IT>): void;

package/esm/core/type/type-checker.js

@@ -0,0 +1,144 @@
+import { EMPTY_ARRAY, fail, getStateTreeNode, isPrimitive, isPrimitiveType, isStateTreeNode, isTypeCheckingEnabled } from "../../internal.js";
+const MAX_STRINGIFY_DEPTH = 3;
+function safeStringify(value) {
+    try {
+        const ancestors = [];
+        return JSON.stringify(value, function (_key, val) {
+            if (val !== null && typeof val === "object") {
+                while (ancestors.length > 0 &&
+                    ancestors[ancestors.length - 1] !== this) {
+                    ancestors.pop();
+                }
+                if (ancestors.length >= MAX_STRINGIFY_DEPTH) {
+                    return Array.isArray(val) ? "[…]" : "{…}";
+                }
+                ancestors.push(val);
+            }
+            return val;
+        });
+    }
+    catch (e) {
+        // istanbul ignore next
+        return `<Unserializable: ${e}>`;
+    }
+}
+/**
+ * @internal
+ * @hidden
+ */
+export function prettyPrintValue(value) {
+    return typeof value === "function"
+        ? `<function${value.name ? " " + value.name : ""}>`
+        : isStateTreeNode(value)
+            ? `<${value}>`
+            : `\`${safeStringify(value)}\``;
+}
+function shortenPrintValue(valueInString) {
+    return valueInString.length < 280
+        ? valueInString
+        : `${valueInString.substring(0, 272)}......${valueInString.substring(valueInString.length - 8)}`;
+}
+function toErrorString(error) {
+    const { value } = error;
+    const type = error.context[error.context.length - 1].type;
+    const fullPath = error.context
+        .map(({ path }) => path)
+        .filter(path => path.length > 0)
+        .join("/");
+    const pathPrefix = fullPath.length > 0 ? `at path "/${fullPath}" ` : ``;
+    const currentTypename = isStateTreeNode(value)
+        ? `value of type ${getStateTreeNode(value).type.name}:`
+        : 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)"
+                        : "")
+            : `.`));
+}
+/**
+ * @internal
+ * @hidden
+ * Pushes a new entry onto the context array (mutates in place for performance).
+ * Returns the same context array for chaining.
+ */
+export function getContextForPath(context, path, type) {
+    context.push({ path, type });
+    return context;
+}
+/**
+ * @internal
+ * @hidden
+ * Pops the last entry from the context array (mutates in place).
+ * Must be called after validation to restore context state.
+ */
+export function popContext(context) {
+    context.pop();
+}
+/**
+ * @internal
+ * @hidden
+ */
+export function typeCheckSuccess() {
+    return EMPTY_ARRAY;
+}
+/**
+ * @internal
+ * @hidden
+ */
+export function typeCheckFailure(context, value, message) {
+    // Clone context since it may be mutated after this error is created
+    return [{ context: context.slice(), value, message }];
+}
+/**
+ * @internal
+ * @hidden
+ */
+export function flattenTypeErrors(errors) {
+    return errors.flat();
+}
+// TODO; doublecheck: typecheck should only needed to be invoked from: type.create and array / map / value.property will change
+/**
+ * @internal
+ * @hidden
+ */
+export function typecheckInternal(type, value) {
+    // runs typeChecking if it is in dev-mode or through a process.env.ENABLE_TYPE_CHECK flag
+    if (isTypeCheckingEnabled()) {
+        typecheck(type, value);
+    }
+}
+/**
+ * Run's the typechecker for the given type on the given value, which can be a snapshot or an instance.
+ * Throws if the given value is not according the provided type specification.
+ * Use this if you need typechecks even in a production build (by default all automatic runtime type checks will be skipped in production builds)
+ *
+ * @param type Type to check against.
+ * @param value Value to be checked, either a snapshot or an instance.
+ */
+export function typecheck(type, value) {
+    const errors = type.validate(value, [{ path: "", type }]);
+    if (errors.length > 0) {
+        throw fail(validationErrorsToString(type, value, errors));
+    }
+}
+const MAX_ERRORS_REPORTED = 10;
+function validationErrorsToString(type, value, errors) {
+    if (errors.length === 0) {
+        return undefined;
+    }
+    const shown = errors.slice(0, MAX_ERRORS_REPORTED).map(toErrorString);
+    const overflow = errors.length - shown.length;
+    if (overflow > 0) {
+        shown.push(`(… and ${overflow} more error${overflow === 1 ? "" : "s"})`);
+    }
+    return (`Error while converting ${shortenPrintValue(prettyPrintValue(value))} to \`${type.name}\`:\n\n    ` + shown.join("\n    "));
+}
+//# sourceMappingURL=type-checker.js.map

package/esm/core/type/type-checker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-checker.js","sourceRoot":"","sources":["../../../src/core/type/type-checker.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EAGX,IAAI,EACJ,gBAAgB,EAChB,WAAW,EACX,eAAe,EACf,eAAe,EACf,qBAAqB,EACtB,MAAM,mBAAmB,CAAA;AA0B1B,MAAM,mBAAmB,GAAG,CAAC,CAAA;AAE7B,SAAS,aAAa,CAAC,KAAU;IAC/B,IAAI,CAAC;QACH,MAAM,SAAS,GAAU,EAAE,CAAA;QAC3B,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,UAAU,IAAI,EAAE,GAAG;YAC9C,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5C,OACE,SAAS,CAAC,MAAM,GAAG,CAAC;oBACpB,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,IAAI,EACxC,CAAC;oBACD,SAAS,CAAC,GAAG,EAAE,CAAA;gBACjB,CAAC;gBACD,IAAI,SAAS,CAAC,MAAM,IAAI,mBAAmB,EAAE,CAAC;oBAC5C,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAA;gBAC3C,CAAC;gBACD,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YACrB,CAAC;YACD,OAAO,GAAG,CAAA;QACZ,CAAC,CAAC,CAAA;IACJ,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,uBAAuB;QACvB,OAAO,oBAAoB,CAAC,GAAG,CAAA;IACjC,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAU;IACzC,OAAO,OAAO,KAAK,KAAK,UAAU;QAChC,CAAC,CAAC,YAAY,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG;QACnD,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC;YACtB,CAAC,CAAC,IAAI,KAAK,GAAG;YACd,CAAC,CAAC,KAAK,aAAa,CAAC,KAAK,CAAC,IAAI,CAAA;AACrC,CAAC;AAED,SAAS,iBAAiB,CAAC,aAAqB;IAC9C,OAAO,aAAa,CAAC,MAAM,GAAG,GAAG;QAC/B,CAAC,CAAC,aAAa;QACf,CAAC,CAAC,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,SAAS,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAA;AACpG,CAAC;AAED,SAAS,aAAa,CAAC,KAAuB;IAC5C,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAA;IACvB,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAK,CAAA;IAC1D,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO;SAC3B,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC;SACvB,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;SAC/B,IAAI,CAAC,GAAG,CAAC,CAAA;IAEZ,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,QAAQ,IAAI,CAAC,CAAC,CAAC,EAAE,CAAA;IAEvE,MAAM,eAAe,GAAG,eAAe,CAAC,KAAK,CAAC;QAC5C,CAAC,CAAC,iBAAiB,gBAAgB,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,GAAG;QACvD,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC;YAClB,CAAC,CAAC,OAAO;YACT,CAAC,CAAC,UAAU,CAAA;IAChB,MAAM,oBAAoB,GACxB,IAAI,IAAI,eAAe,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAA;IAE7E,OAAO,CACL,GAAG,UAAU,GAAG,eAAe,IAAI,iBAAiB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,sBAC3E,IAAI,CAAC,CAAC,CAAC,cAAc,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,EACvC,EAAE;QACF,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5C,CAAC,IAAI;YACH,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,KAAK,CAAC;gBAC3C,CAAC,CAAC,GAAG;gBACL,CAAC,CAAC,+BAAgC,IAAiB,CAAC,IAAI,2BAA2B,iBAAiB,CAC/F,IAAiB,CAAC,QAAQ,EAAE,CAC9B,aAAa;oBACd,CAAC,oBAAoB;wBACnB,CAAC,CAAC,oFAAoF;wBACtF,CAAC,CAAC,EAAE,CAAC;YACX,CAAC,CAAC,GAAG,CAAC,CACT,CAAA;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAA2B,EAC3B,IAAY,EACZ,IAAc;IAEd,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;IAC5B,OAAO,OAAO,CAAA;AAChB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,OAA2B;IACpD,OAAO,CAAC,GAAG,EAAE,CAAA;AACf,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB;IAC9B,OAAO,WAAkB,CAAA;AAC3B,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAC9B,OAA2B,EAC3B,KAAU,EACV,OAAgB;IAEhB,oEAAoE;IACpE,OAAO,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAA;AACvD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAC/B,MAA2B;IAE3B,OAAO,MAAM,CAAC,IAAI,EAAE,CAAA;AACtB,CAAC;AAED,+HAA+H;AAC/H;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAC/B,IAAc,EACd,KAA4B;IAE5B,yFAAyF;IACzF,IAAI,qBAAqB,EAAE,EAAE,CAAC;QAC5B,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;IACxB,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,SAAS,CACvB,IAAQ,EACR,KAA4B;IAE5B,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;IAEzD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,CAAC,wBAAwB,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAA;IAC3D,CAAC;AACH,CAAC;AAED,MAAM,mBAAmB,GAAG,EAAE,CAAA;AAE9B,SAAS,wBAAwB,CAC/B,IAAQ,EACR,KAA4B,EAC5B,MAA0B;IAE1B,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAA;IACrE,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAA;IAC7C,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;QACjB,KAAK,CAAC,IAAI,CAAC,UAAU,QAAQ,cAAc,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAA;IAC1E,CAAC;IAED,OAAO,CACL,0BAA0B,iBAAiB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,SAClE,IAAI,CAAC,IACP,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CACrC,CAAA;AACH,CAAC","sourcesContent":["import {\n  EMPTY_ARRAY,\n  type ExtractCSTWithSTN,\n  type IAnyType,\n  fail,\n  getStateTreeNode,\n  isPrimitive,\n  isPrimitiveType,\n  isStateTreeNode,\n  isTypeCheckingEnabled\n} from \"../../internal.ts\"\n\n/** Validation context entry, this is, where the validation should run against which type */\nexport interface IValidationContextEntry {\n  /** Subpath where the validation should be run, or an empty string to validate it all */\n  path: string\n  /** Type to validate the subpath against */\n  type: IAnyType\n}\n\n/** Array of validation context entries */\nexport type IValidationContext = IValidationContextEntry[]\n\n/** Type validation error */\nexport interface IValidationError {\n  /** Validation context */\n  context: IValidationContext\n  /** Value that was being validated, either a snapshot or an instance */\n  value: any\n  /** Error message */\n  message?: string\n}\n\n/** Type validation result, which is an array of type validation errors */\nexport type IValidationResult = IValidationError[]\n\nconst MAX_STRINGIFY_DEPTH = 3\n\nfunction safeStringify(value: any) {\n  try {\n    const ancestors: any[] = []\n    return JSON.stringify(value, function (_key, val) {\n      if (val !== null && typeof val === \"object\") {\n        while (\n          ancestors.length > 0 &&\n          ancestors[ancestors.length - 1] !== this\n        ) {\n          ancestors.pop()\n        }\n        if (ancestors.length >= MAX_STRINGIFY_DEPTH) {\n          return Array.isArray(val) ? \"[…]\" : \"{…}\"\n        }\n        ancestors.push(val)\n      }\n      return val\n    })\n  } catch (e) {\n    // istanbul ignore next\n    return `<Unserializable: ${e}>`\n  }\n}\n\n/**\n * @internal\n * @hidden\n */\nexport function prettyPrintValue(value: any) {\n  return typeof value === \"function\"\n    ? `<function${value.name ? \" \" + value.name : \"\"}>`\n    : isStateTreeNode(value)\n      ? `<${value}>`\n      : `\\`${safeStringify(value)}\\``\n}\n\nfunction shortenPrintValue(valueInString: string) {\n  return valueInString.length < 280\n    ? valueInString\n    : `${valueInString.substring(0, 272)}......${valueInString.substring(valueInString.length - 8)}`\n}\n\nfunction toErrorString(error: IValidationError): string {\n  const { value } = error\n  const type = error.context[error.context.length - 1].type!\n  const fullPath = error.context\n    .map(({ path }) => path)\n    .filter(path => path.length > 0)\n    .join(\"/\")\n\n  const pathPrefix = fullPath.length > 0 ? `at path \"/${fullPath}\" ` : ``\n\n  const currentTypename = isStateTreeNode(value)\n    ? `value of type ${getStateTreeNode(value).type.name}:`\n    : isPrimitive(value)\n      ? \"value\"\n      : \"snapshot\"\n  const isSnapshotCompatible =\n    type && isStateTreeNode(value) && type.is(getStateTreeNode(value).snapshot)\n\n  return (\n    `${pathPrefix}${currentTypename} ${shortenPrintValue(prettyPrintValue(value))} is not assignable ${\n      type ? `to type: \\`${type.name}\\`` : ``\n    }` +\n    (error.message ? ` (${error.message})` : \"\") +\n    (type\n      ? isPrimitiveType(type) || isPrimitive(value)\n        ? `.`\n        : `, expected an instance of \\`${(type as IAnyType).name}\\` or a snapshot like \\`${shortenPrintValue(\n            (type as IAnyType).describe()\n          )}\\` instead.` +\n          (isSnapshotCompatible\n            ? \" (Note that a snapshot of the provided value is compatible with the targeted type)\"\n            : \"\")\n      : `.`)\n  )\n}\n\n/**\n * @internal\n * @hidden\n * Pushes a new entry onto the context array (mutates in place for performance).\n * Returns the same context array for chaining.\n */\nexport function getContextForPath(\n  context: IValidationContext,\n  path: string,\n  type: IAnyType\n): IValidationContext {\n  context.push({ path, type })\n  return context\n}\n\n/**\n * @internal\n * @hidden\n * Pops the last entry from the context array (mutates in place).\n * Must be called after validation to restore context state.\n */\nexport function popContext(context: IValidationContext): void {\n  context.pop()\n}\n\n/**\n * @internal\n * @hidden\n */\nexport function typeCheckSuccess(): IValidationResult {\n  return EMPTY_ARRAY as any\n}\n\n/**\n * @internal\n * @hidden\n */\nexport function typeCheckFailure(\n  context: IValidationContext,\n  value: any,\n  message?: string\n): IValidationResult {\n  // Clone context since it may be mutated after this error is created\n  return [{ context: context.slice(), value, message }]\n}\n\n/**\n * @internal\n * @hidden\n */\nexport function flattenTypeErrors(\n  errors: IValidationResult[]\n): IValidationResult {\n  return errors.flat()\n}\n\n// TODO; doublecheck: typecheck should only needed to be invoked from: type.create and array / map / value.property will change\n/**\n * @internal\n * @hidden\n */\nexport function typecheckInternal<IT extends IAnyType>(\n  type: IAnyType,\n  value: ExtractCSTWithSTN<IT>\n): void {\n  // runs typeChecking if it is in dev-mode or through a process.env.ENABLE_TYPE_CHECK flag\n  if (isTypeCheckingEnabled()) {\n    typecheck(type, value)\n  }\n}\n\n/**\n * Run's the typechecker for the given type on the given value, which can be a snapshot or an instance.\n * Throws if the given value is not according the provided type specification.\n * Use this if you need typechecks even in a production build (by default all automatic runtime type checks will be skipped in production builds)\n *\n * @param type Type to check against.\n * @param value Value to be checked, either a snapshot or an instance.\n */\nexport function typecheck<IT extends IAnyType>(\n  type: IT,\n  value: ExtractCSTWithSTN<IT>\n): void {\n  const errors = type.validate(value, [{ path: \"\", type }])\n\n  if (errors.length > 0) {\n    throw fail(validationErrorsToString(type, value, errors))\n  }\n}\n\nconst MAX_ERRORS_REPORTED = 10\n\nfunction validationErrorsToString<IT extends IAnyType>(\n  type: IT,\n  value: ExtractCSTWithSTN<IT>,\n  errors: IValidationError[]\n): string | undefined {\n  if (errors.length === 0) {\n    return undefined\n  }\n\n  const shown = errors.slice(0, MAX_ERRORS_REPORTED).map(toErrorString)\n  const overflow = errors.length - shown.length\n  if (overflow > 0) {\n    shown.push(`(… and ${overflow} more error${overflow === 1 ? \"\" : \"s\"})`)\n  }\n\n  return (\n    `Error while converting ${shortenPrintValue(prettyPrintValue(value))} to \\`${\n      type.name\n    }\\`:\\n\\n    ` + shown.join(\"\\n    \")\n  )\n}\n"]}