@jbrowse/mobx-state-tree 5.6.3 → 5.6.9

package/dist/core/node/node-utils.d.ts

@@ -0,0 +1,83 @@
+import type { AnyNode, AnyObjectNode, IAnyComplexType, IAnyType, IChildNodesMap, IType, Instance, STNValue } from "../../internal.ts";
+/**
+ * @internal
+ * @hidden
+ */
+export declare enum NodeLifeCycle {
+    INITIALIZING = 0,// setting up
+    CREATED = 1,// afterCreate has run
+    FINALIZED = 2,// afterAttach has run
+    DETACHING = 3,// being detached from the tree
+    DEAD = 4
+}
+/** @hidden */
+declare const $stateTreeNodeType: unique symbol;
+/**
+ * Common interface that represents a node instance.
+ * @hidden
+ */
+export interface IStateTreeNode<IT extends IAnyType = IAnyType> {
+    /**
+     * @internal
+     */
+    readonly $treenode?: any;
+    readonly [$stateTreeNodeType]?: [IT] | [any];
+}
+/** @hidden */
+export type TypeOfValue<T extends IAnyStateTreeNode> = T extends IStateTreeNode<infer IT> ? IT : never;
+/**
+ * Represents any state tree node instance.
+ * @hidden
+ */
+export interface IAnyStateTreeNode extends STNValue<any, IAnyType> {
+}
+/**
+ * Returns true if the given value is a node in a state tree.
+ * More precisely, that is, if the value is an instance of a
+ * `types.model`, `types.array` or `types.map`.
+ *
+ * @param value
+ * @returns true if the value is a state tree node.
+ */
+export declare function isStateTreeNode<IT extends IAnyComplexType = IAnyComplexType>(value: any): value is STNValue<Instance<IT>, IT>;
+/**
+ * @internal
+ * @hidden
+ */
+export declare function assertIsStateTreeNode(value: IAnyStateTreeNode, argNumber: number | number[]): void;
+/**
+ * @internal
+ * @hidden
+ */
+export declare function getStateTreeNode(value: IAnyStateTreeNode): AnyObjectNode;
+/**
+ * @internal
+ * @hidden
+ */
+export declare function getStateTreeNodeSafe(value: IAnyStateTreeNode): AnyObjectNode | null;
+/**
+ * @internal
+ * @hidden
+ */
+export declare function toJSON<S>(this: IStateTreeNode<IType<any, S, any>>): S;
+/**
+ * @internal
+ * @hidden
+ */
+export declare function getRelativePathBetweenNodes(base: AnyObjectNode, target: AnyObjectNode): string;
+/**
+ * @internal
+ * @hidden
+ */
+export declare function resolveNodeByPath(base: AnyObjectNode, path: string, failIfResolveFails?: boolean): AnyNode | undefined;
+/**
+ * @internal
+ * @hidden
+ */
+export declare function resolveNodeByPathParts(base: AnyObjectNode, pathParts: string[], failIfResolveFails?: boolean): AnyNode | undefined;
+/**
+ * @internal
+ * @hidden
+ */
+export declare function convertChildNodesToArray(childNodes: IChildNodesMap | null): AnyNode[];
+export {};

package/dist/core/node/node-utils.js

@@ -0,0 +1,165 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeLifeCycle = void 0;
+exports.isStateTreeNode = isStateTreeNode;
+exports.assertIsStateTreeNode = assertIsStateTreeNode;
+exports.getStateTreeNode = getStateTreeNode;
+exports.getStateTreeNodeSafe = getStateTreeNodeSafe;
+exports.toJSON = toJSON;
+exports.getRelativePathBetweenNodes = getRelativePathBetweenNodes;
+exports.resolveNodeByPath = resolveNodeByPath;
+exports.resolveNodeByPathParts = resolveNodeByPathParts;
+exports.convertChildNodesToArray = convertChildNodesToArray;
+const internal_ts_1 = require("../../internal.js");
+/**
+ * @internal
+ * @hidden
+ */
+var NodeLifeCycle;
+(function (NodeLifeCycle) {
+    NodeLifeCycle[NodeLifeCycle["INITIALIZING"] = 0] = "INITIALIZING";
+    NodeLifeCycle[NodeLifeCycle["CREATED"] = 1] = "CREATED";
+    NodeLifeCycle[NodeLifeCycle["FINALIZED"] = 2] = "FINALIZED";
+    NodeLifeCycle[NodeLifeCycle["DETACHING"] = 3] = "DETACHING";
+    NodeLifeCycle[NodeLifeCycle["DEAD"] = 4] = "DEAD"; // no coming back from this one
+})(NodeLifeCycle || (exports.NodeLifeCycle = NodeLifeCycle = {}));
+/**
+ * Returns true if the given value is a node in a state tree.
+ * More precisely, that is, if the value is an instance of a
+ * `types.model`, `types.array` or `types.map`.
+ *
+ * @param value
+ * @returns true if the value is a state tree node.
+ */
+function isStateTreeNode(value) {
+    return !!(value && value.$treenode);
+}
+/**
+ * @internal
+ * @hidden
+ */
+function assertIsStateTreeNode(value, argNumber) {
+    (0, internal_ts_1.assertArg)(value, isStateTreeNode, "mobx-state-tree node", argNumber);
+}
+/**
+ * @internal
+ * @hidden
+ */
+function getStateTreeNode(value) {
+    if (!isStateTreeNode(value)) {
+        // istanbul ignore next
+        throw (0, internal_ts_1.fail)(`Value ${value} is no MST Node`);
+    }
+    return value.$treenode;
+}
+/**
+ * @internal
+ * @hidden
+ */
+function getStateTreeNodeSafe(value) {
+    return (value && value.$treenode) || null;
+}
+/**
+ * @internal
+ * @hidden
+ */
+function toJSON() {
+    return getStateTreeNode(this).snapshot;
+}
+const doubleDot = (_) => "..";
+/**
+ * @internal
+ * @hidden
+ */
+function getRelativePathBetweenNodes(base, target) {
+    // PRE condition target is (a child of) base!
+    if (base.root !== target.root) {
+        throw (0, internal_ts_1.fail)(`Cannot calculate relative path: objects '${base}' and '${target}' are not part of the same object tree`);
+    }
+    const baseParts = (0, internal_ts_1.splitJsonPath)(base.path);
+    const targetParts = (0, internal_ts_1.splitJsonPath)(target.path);
+    let common = 0;
+    for (; common < baseParts.length; common++) {
+        if (baseParts[common] !== targetParts[common]) {
+            break;
+        }
+    }
+    // TODO: assert that no targetParts paths are "..", "." or ""!
+    return (baseParts.slice(common).map(doubleDot).join("/") +
+        (0, internal_ts_1.joinJsonPath)(targetParts.slice(common)));
+}
+/**
+ * @internal
+ * @hidden
+ */
+function resolveNodeByPath(base, path, failIfResolveFails = true) {
+    return resolveNodeByPathParts(base, (0, internal_ts_1.splitJsonPath)(path), failIfResolveFails);
+}
+/**
+ * @internal
+ * @hidden
+ */
+function resolveNodeByPathParts(base, pathParts, failIfResolveFails = true) {
+    let current = base;
+    try {
+        for (let i = 0; i < pathParts.length; i++) {
+            const part = pathParts[i];
+            if (part === "..") {
+                current = current.parent;
+                if (current) {
+                    continue;
+                } // not everything has a parent
+            }
+            else if (part === ".") {
+                continue;
+            }
+            else if (current) {
+                if (current instanceof internal_ts_1.ScalarNode) {
+                    // check if the value of a scalar resolves to a state tree node (e.g. references)
+                    // then we can continue resolving...
+                    const value = current.value;
+                    if (isStateTreeNode(value)) {
+                        current = getStateTreeNode(value);
+                        // fall through
+                    }
+                }
+                if (current instanceof internal_ts_1.ObjectNode) {
+                    const subType = current.getChildType(part);
+                    if (subType) {
+                        current = current.getChildNode(part);
+                        if (current) {
+                            continue;
+                        }
+                    }
+                }
+            }
+            throw (0, internal_ts_1.fail)(`Could not resolve '${part}' in path '${(0, internal_ts_1.joinJsonPath)(pathParts.slice(0, i)) || "/"}' while resolving '${(0, internal_ts_1.joinJsonPath)(pathParts)}'`);
+        }
+    }
+    catch (e) {
+        if (!failIfResolveFails) {
+            return undefined;
+        }
+        throw e;
+    }
+    return current;
+}
+/**
+ * @internal
+ * @hidden
+ */
+function convertChildNodesToArray(childNodes) {
+    if (!childNodes) {
+        return internal_ts_1.EMPTY_ARRAY;
+    }
+    const keys = Object.keys(childNodes);
+    if (!keys.length) {
+        return internal_ts_1.EMPTY_ARRAY;
+    }
+    const result = new Array(keys.length);
+    keys.forEach((key, index) => {
+        result[index] = childNodes[key];
+    });
+    return result;
+}
+//# sourceMappingURL=node-utils.js.map

package/dist/core/node/node-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"node-utils.js","sourceRoot":"","sources":["../../../src/core/node/node-utils.ts"],"names":[],"mappings":";;;AAqEA,0CAIC;AAMD,sDAKC;AAMD,4CAMC;AAMD,oDAIC;AAMD,wBAEC;AAQD,kEAwBC;AAMD,8CAMC;AAMD,wDAiDC;AAMD,4DAiBC;AA5OD,mDAQ0B;AAa1B;;;GAGG;AACH,IAAY,aAMX;AAND,WAAY,aAAa;IACvB,iEAAY,CAAA;IACZ,uDAAO,CAAA;IACP,2DAAS,CAAA;IACT,2DAAS,CAAA;IACT,iDAAI,CAAA,CAAC,+BAA+B;AACtC,CAAC,EANW,aAAa,6BAAb,aAAa,QAMxB;AA8BD;;;;;;;GAOG;AACH,SAAgB,eAAe,CAC7B,KAAU;IAEV,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,KAAK,CAAC,SAAS,CAAC,CAAA;AACrC,CAAC;AAED;;;GAGG;AACH,SAAgB,qBAAqB,CACnC,KAAwB,EACxB,SAA4B;IAE5B,IAAA,uBAAS,EAAC,KAAK,EAAE,eAAe,EAAE,sBAAsB,EAAE,SAAS,CAAC,CAAA;AACtE,CAAC;AAED;;;GAGG;AACH,SAAgB,gBAAgB,CAAC,KAAwB;IACvD,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,uBAAuB;QACvB,MAAM,IAAA,kBAAI,EAAC,SAAS,KAAK,iBAAiB,CAAC,CAAA;IAC7C,CAAC;IACD,OAAO,KAAK,CAAC,SAAU,CAAA;AACzB,CAAC;AAED;;;GAGG;AACH,SAAgB,oBAAoB,CAClC,KAAwB;IAExB,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC,SAAS,CAAC,IAAI,IAAI,CAAA;AAC3C,CAAC;AAED;;;GAGG;AACH,SAAgB,MAAM;IACpB,OAAO,gBAAgB,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAA;AACxC,CAAC;AAED,MAAM,SAAS,GAAG,CAAC,CAAM,EAAE,EAAE,CAAC,IAAI,CAAA;AAElC;;;GAGG;AACH,SAAgB,2BAA2B,CACzC,IAAmB,EACnB,MAAqB;IAErB,6CAA6C;IAC7C,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC;QAC9B,MAAM,IAAA,kBAAI,EACR,4CAA4C,IAAI,UAAU,MAAM,wCAAwC,CACzG,CAAA;IACH,CAAC;IAED,MAAM,SAAS,GAAG,IAAA,2BAAa,EAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC1C,MAAM,WAAW,GAAG,IAAA,2BAAa,EAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC9C,IAAI,MAAM,GAAG,CAAC,CAAA;IACd,OAAO,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC;QAC3C,IAAI,SAAS,CAAC,MAAM,CAAC,KAAK,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9C,MAAK;QACP,CAAC;IACH,CAAC;IACD,8DAA8D;IAC9D,OAAO,CACL,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;QAChD,IAAA,0BAAY,EAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CACxC,CAAA;AACH,CAAC;AAED;;;GAGG;AACH,SAAgB,iBAAiB,CAC/B,IAAmB,EACnB,IAAY,EACZ,qBAA8B,IAAI;IAElC,OAAO,sBAAsB,CAAC,IAAI,EAAE,IAAA,2BAAa,EAAC,IAAI,CAAC,EAAE,kBAAkB,CAAC,CAAA;AAC9E,CAAC;AAED;;;GAGG;AACH,SAAgB,sBAAsB,CACpC,IAAmB,EACnB,SAAmB,EACnB,qBAA8B,IAAI;IAElC,IAAI,OAAO,GAAmB,IAAI,CAAA;IAClC,IAAI,CAAC;QACH,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC1C,MAAM,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;YACzB,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;gBAClB,OAAO,GAAG,OAAQ,CAAC,MAAM,CAAA;gBACzB,IAAI,OAAO,EAAE,CAAC;oBACZ,SAAQ;gBACV,CAAC,CAAC,8BAA8B;YAClC,CAAC;iBAAM,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;gBACxB,SAAQ;YACV,CAAC;iBAAM,IAAI,OAAO,EAAE,CAAC;gBACnB,IAAI,OAAO,YAAY,wBAAU,EAAE,CAAC;oBAClC,iFAAiF;oBACjF,oCAAoC;oBACpC,MAAM,KAAK,GAAQ,OAAO,CAAC,KAAK,CAAA;oBAChC,IAAI,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;wBAC3B,OAAO,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAA;wBACjC,eAAe;oBACjB,CAAC;gBACH,CAAC;gBACD,IAAI,OAAO,YAAY,wBAAU,EAAE,CAAC;oBAClC,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;oBAC1C,IAAI,OAAO,EAAE,CAAC;wBACZ,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;wBACpC,IAAI,OAAO,EAAE,CAAC;4BACZ,SAAQ;wBACV,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YACD,MAAM,IAAA,kBAAI,EACR,sBAAsB,IAAI,cACxB,IAAA,0BAAY,EAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,GACzC,sBAAsB,IAAA,0BAAY,EAAC,SAAS,CAAC,GAAG,CACjD,CAAA;QACH,CAAC;IACH,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxB,OAAO,SAAS,CAAA;QAClB,CAAC;QACD,MAAM,CAAC,CAAA;IACT,CAAC;IACD,OAAO,OAAQ,CAAA;AACjB,CAAC;AAED;;;GAGG;AACH,SAAgB,wBAAwB,CACtC,UAAiC;IAEjC,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,yBAAwB,CAAA;IACjC,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IACpC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACjB,OAAO,yBAAwB,CAAA;IACjC,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAc,CAAA;IAClD,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;QAC1B,MAAM,CAAC,KAAK,CAAC,GAAG,UAAW,CAAC,GAAG,CAAC,CAAA;IAClC,CAAC,CAAC,CAAA;IACF,OAAO,MAAM,CAAA;AACf,CAAC"}

package/dist/core/node/object-node.d.ts

@@ -0,0 +1,99 @@
+import { BaseNode, ComplexType, Hook, IdentifierCache } from "../../internal.ts";
+import type { AnyNode, IAnyType, IDisposer, IJsonPatch, IMiddleware, IMiddlewareEvent, IMiddlewareHandler, IReversibleJsonPatch, IStateTreeNode, IType, ReferenceIdentifier } from "../../internal.ts";
+/**
+ * @internal
+ * @hidden
+ */
+export interface IChildNodesMap {
+    [key: string]: AnyNode;
+}
+/**
+ * @internal
+ * @hidden
+ */
+export declare class ObjectNode<C, S, T> extends BaseNode<C, S, T> {
+    readonly type: ComplexType<C, S, T>;
+    storedValue: T & IStateTreeNode<IType<C, S, T>>;
+    readonly nodeId: number;
+    readonly identifierAttribute?: string;
+    readonly identifier: string | null;
+    readonly unnormalizedIdentifier: ReferenceIdentifier | null;
+    identifierCache?: IdentifierCache;
+    isProtectionEnabled: boolean;
+    middlewares?: IMiddleware[];
+    hasSnapshotPostProcessor: boolean;
+    private _applyPatches?;
+    applyPatches(patches: IJsonPatch[]): void;
+    private _applySnapshot?;
+    applySnapshot(snapshot: C): void;
+    private _autoUnbox;
+    _isRunningAction: boolean;
+    private _hasSnapshotReaction;
+    private _observableInstanceState;
+    private _childNodes;
+    private _initialSnapshot;
+    private _cachedInitialSnapshot?;
+    private _cachedInitialSnapshotCreated;
+    private _snapshotComputed;
+    constructor(complexType: ComplexType<C, S, T>, parent: AnyObjectNode | null, subpath: string, environment: any, initialValue: C);
+    createObservableInstanceIfNeeded(fireHooks?: boolean): void;
+    createObservableInstance(fireHooks?: boolean): void;
+    get root(): AnyObjectNode;
+    clearParent(): void;
+    setParent(newParent: AnyObjectNode, subpath: string): void;
+    protected fireHook(name: Hook): void;
+    private _snapshotUponDeath?;
+    get snapshot(): S;
+    getSnapshot(): S;
+    private _getActualSnapshot;
+    private _getCachedInitialSnapshot;
+    private isRunningAction;
+    assertAlive(context: AssertAliveContext): void;
+    private _getAssertAliveError;
+    getChildNode(subpath: string): AnyNode;
+    getChildren(): ReadonlyArray<AnyNode>;
+    getChildType(propertyName?: string): IAnyType;
+    get isProtected(): boolean;
+    assertWritable(context: AssertAliveContext): void;
+    removeChild(subpath: string): void;
+    unbox(childNode: AnyNode | undefined): AnyNode | undefined;
+    toString(): string;
+    finalizeCreation(): void;
+    detach(): void;
+    private preboot;
+    die(): void;
+    aboutToDie(): void;
+    finalizeDeath(): void;
+    onSnapshot(onChange: (snapshot: S) => void): IDisposer;
+    protected emitSnapshot(snapshot: S): void;
+    onPatch(handler: (patch: IJsonPatch, reversePatch: IJsonPatch) => void): IDisposer;
+    emitPatch(basePatch: IReversibleJsonPatch, source: AnyNode): void;
+    hasDisposer(disposer: () => void): boolean;
+    addDisposer(disposer: () => void): void;
+    removeDisposer(disposer: () => void): void;
+    private removeMiddleware;
+    addMiddleWare(handler: IMiddlewareHandler, includeHooks?: boolean): IDisposer;
+    applyPatchLocally(subpath: string, patch: IJsonPatch): void;
+    private _addSnapshotReaction;
+    private _internalEvents?;
+    private _internalEventsHasSubscribers;
+    private _internalEventsRegister;
+    private _internalEventsHas;
+    private _internalEventsUnregister;
+    private _internalEventsEmit;
+    private _internalEventsClear;
+    private _internalEventsClearAll;
+}
+/**
+ * @internal
+ * @hidden
+ */
+export type AnyObjectNode = ObjectNode<any, any, any>;
+/**
+ * @internal
+ * @hidden
+ */
+export interface AssertAliveContext {
+    subpath?: string;
+    actionContext?: IMiddlewareEvent;
+}