@jbrowse/mobx-state-tree 5.6.3 → 5.6.6

package/dist/types/complex-types/array.js

@@ -0,0 +1,352 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArrayType = void 0;
+exports.array = array;
+exports.isArrayType = isArrayType;
+const mobx_1 = require("mobx");
+const internal_ts_1 = require("../../internal.js");
+/**
+ * @internal
+ * @hidden
+ */
+class ArrayType extends internal_ts_1.ComplexType {
+    _subType;
+    flags = internal_ts_1.TypeFlags.Array;
+    hookInitializers = [];
+    constructor(name, _subType, hookInitializers = []) {
+        super(name);
+        this._subType = _subType;
+        this.hookInitializers = hookInitializers;
+    }
+    hooks(hooks) {
+        const hookInitializers = this.hookInitializers.length > 0
+            ? this.hookInitializers.concat(hooks)
+            : [hooks];
+        return new ArrayType(this.name, this._subType, hookInitializers);
+    }
+    instantiate(parent, subpath, environment, initialValue) {
+        return (0, internal_ts_1.createObjectNode)(this, parent, subpath, environment, initialValue);
+    }
+    initializeChildNodes(objNode, snapshot = []) {
+        const subType = objNode.type._subType;
+        const result = {};
+        snapshot.forEach((item, index) => {
+            const subpath = "" + index;
+            result[subpath] = subType.instantiate(objNode, subpath, undefined, item);
+        });
+        return result;
+    }
+    createNewInstance(childNodes) {
+        const options = { ...internal_ts_1.mobxShallow, name: this.name };
+        return mobx_1.observable.array((0, internal_ts_1.convertChildNodesToArray)(childNodes), options);
+    }
+    finalizeNewInstance(node, instance) {
+        (0, mobx_1._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 = (0, internal_ts_1.createActionInvoker)(instance, name, hook);
+                (!(0, internal_ts_1.devMode)() ? internal_ts_1.addHiddenFinalProp : internal_ts_1.addHiddenWritableProp)(instance, name, actionInvoker);
+            });
+        });
+        (0, mobx_1.intercept)(instance, this.willChange);
+        (0, mobx_1.observe)(instance, this.didChange);
+    }
+    describe() {
+        return this.name;
+    }
+    getChildren(node) {
+        return node.storedValue.slice();
+    }
+    getChildNode(node, key) {
+        const index = Number(key);
+        if (index < node.storedValue.length) {
+            return node.storedValue[index];
+        }
+        throw (0, internal_ts_1.fail)("Not a child: " + key);
+    }
+    willChange(change) {
+        const node = (0, internal_ts_1.getStateTreeNode)(change.object);
+        node.assertWritable({ subpath: "" + change.index });
+        const subType = node.type._subType;
+        const childNodes = node.getChildren();
+        switch (change.type) {
+            case "update":
+                {
+                    if (change.newValue === change.object[change.index]) {
+                        return null;
+                    }
+                    const updatedNodes = reconcileArrayChildren(node, subType, [childNodes[change.index]], [change.newValue], [change.index]);
+                    if (!updatedNodes) {
+                        return null;
+                    }
+                    change.newValue = updatedNodes[0];
+                }
+                break;
+            case "splice":
+                {
+                    const { index, removedCount, added } = change;
+                    const addedNodes = reconcileArrayChildren(node, subType, childNodes.slice(index, index + removedCount), added, added.map((_, i) => index + i));
+                    if (!addedNodes) {
+                        return null;
+                    }
+                    change.added = addedNodes;
+                    // update paths of remaining items
+                    for (let i = index + removedCount; i < childNodes.length; i++) {
+                        childNodes[i].setParent(node, "" + (i + added.length - removedCount));
+                    }
+                }
+                break;
+        }
+        return change;
+    }
+    getSnapshot(node) {
+        return node.getChildren().map(childNode => childNode.snapshot);
+    }
+    processInitialSnapshot(childNodes) {
+        const processed = [];
+        Object.keys(childNodes).forEach(key => {
+            processed.push(childNodes[key].getSnapshot());
+        });
+        return processed;
+    }
+    didChange(change) {
+        const node = (0, internal_ts_1.getStateTreeNode)(change.object);
+        switch (change.type) {
+            case "update":
+                return void node.emitPatch({
+                    op: "replace",
+                    path: "" + change.index,
+                    value: change.newValue.snapshot,
+                    oldValue: change.oldValue ? change.oldValue.snapshot : undefined
+                }, node);
+            case "splice":
+                for (let i = change.removedCount - 1; i >= 0; i--) {
+                    node.emitPatch({
+                        op: "remove",
+                        path: "" + (change.index + i),
+                        oldValue: change.removed[i].snapshot
+                    }, node);
+                }
+                for (let i = 0; i < change.addedCount; i++) {
+                    node.emitPatch({
+                        op: "add",
+                        path: "" + (change.index + i),
+                        value: node.getChildNode("" + (change.index + i)).snapshot,
+                        oldValue: undefined
+                    }, node);
+                }
+                return;
+        }
+    }
+    applyPatchLocally(node, subpath, patch) {
+        const target = node.storedValue;
+        const index = subpath === "-" ? target.length : Number(subpath);
+        switch (patch.op) {
+            case "replace":
+                target[index] = patch.value;
+                break;
+            case "add":
+                target.splice(index, 0, patch.value);
+                break;
+            case "remove":
+                target.splice(index, 1);
+                break;
+        }
+    }
+    applySnapshot(node, snapshot) {
+        (0, internal_ts_1.typecheckInternal)(this, snapshot);
+        const target = node.storedValue;
+        target.replace(snapshot);
+    }
+    getChildType() {
+        return this._subType;
+    }
+    isValidSnapshot(value, context) {
+        if (!(0, internal_ts_1.isArray)(value)) {
+            return (0, internal_ts_1.typeCheckFailure)(context, value, "Value is not an array");
+        }
+        for (let i = 0; i < value.length; i++) {
+            (0, internal_ts_1.getContextForPath)(context, "" + i, this._subType);
+            const errors = this._subType.validate(value[i], context);
+            (0, internal_ts_1.popContext)(context);
+            if (errors.length > 0) {
+                return errors;
+            }
+        }
+        return (0, internal_ts_1.typeCheckSuccess)();
+    }
+    getDefaultSnapshot() {
+        return internal_ts_1.EMPTY_ARRAY;
+    }
+    removeChild(node, subpath) {
+        node.storedValue.splice(Number(subpath), 1);
+    }
+}
+exports.ArrayType = ArrayType;
+ArrayType.prototype.applySnapshot = (0, mobx_1.action)(ArrayType.prototype.applySnapshot);
+/**
+ * `types.array` - Creates an index based collection type who's children are all of a uniform declared type.
+ *
+ * This type will always produce [observable arrays](https://mobx.js.org/api.html#observablearray)
+ *
+ * Example:
+ * ```ts
+ * const Todo = types.model({
+ *   task: types.string
+ * })
+ *
+ * const TodoStore = types.model({
+ *   todos: types.array(Todo)
+ * })
+ *
+ * const s = TodoStore.create({ todos: [] })
+ * unprotect(s) // needed to allow modifying outside of an action
+ * s.todos.push({ task: "Grab coffee" })
+ * console.log(s.todos[0]) // prints: "Grab coffee"
+ * ```
+ *
+ * @param subtype
+ * @returns
+ */
+function array(subtype) {
+    (0, internal_ts_1.assertIsType)(subtype, 1);
+    return new ArrayType(`${subtype.name}[]`, subtype);
+}
+function reconcileArrayChildren(parent, childType, oldNodes, newValues, newPaths) {
+    let nothingChanged = true;
+    for (let i = 0;; i++) {
+        const hasNewNode = i <= newValues.length - 1;
+        const oldNode = oldNodes[i];
+        let newValue = hasNewNode ? newValues[i] : undefined;
+        const newPath = "" + newPaths[i];
+        // for some reason, instead of newValue we got a node, fallback to the storedValue
+        // TODO: https://github.com/mobxjs/mobx-state-tree/issues/340#issuecomment-325581681
+        if ((0, internal_ts_1.isNode)(newValue)) {
+            newValue = newValue.storedValue;
+        }
+        if (!oldNode && !hasNewNode) {
+            // both are empty, end
+            break;
+        }
+        else if (!hasNewNode) {
+            // new one does not exists
+            nothingChanged = false;
+            oldNodes.splice(i, 1);
+            if (oldNode instanceof internal_ts_1.ObjectNode) {
+                // since it is going to be returned by pop/splice/shift better create it before killing it
+                // so it doesn't end up in an undead state
+                oldNode.createObservableInstanceIfNeeded();
+            }
+            oldNode.die();
+            i--;
+        }
+        else if (!oldNode) {
+            // there is no old node, create it
+            // check if already belongs to the same parent. if so, avoid pushing item in. only swapping can occur.
+            if ((0, internal_ts_1.isStateTreeNode)(newValue) &&
+                (0, internal_ts_1.getStateTreeNode)(newValue).parent === parent) {
+                // this node is owned by this parent, but not in the reconcilable set, so it must be double
+                throw (0, internal_ts_1.fail)(`Cannot add an object to a state tree if it is already part of the same or another state tree. Tried to assign an object to '${parent.path}/${newPath}', but it lives already at '${(0, internal_ts_1.getStateTreeNode)(newValue).path}'`);
+            }
+            nothingChanged = false;
+            const newNode = valueAsNode(childType, parent, newPath, newValue);
+            oldNodes.splice(i, 0, newNode);
+        }
+        else if (areSame(oldNode, newValue)) {
+            // both are the same, reconcile
+            oldNodes[i] = valueAsNode(childType, parent, newPath, newValue, oldNode);
+        }
+        else {
+            // nothing to do, try to reorder
+            let oldMatch = undefined;
+            // find a possible candidate to reuse
+            for (let j = i; j < oldNodes.length; j++) {
+                if (areSame(oldNodes[j], newValue)) {
+                    oldMatch = oldNodes.splice(j, 1)[0];
+                    break;
+                }
+            }
+            nothingChanged = false;
+            const newNode = valueAsNode(childType, parent, newPath, newValue, oldMatch);
+            oldNodes.splice(i, 0, newNode);
+        }
+    }
+    return nothingChanged ? null : oldNodes;
+}
+/**
+ * Convert a value to a node at given parent and subpath. Attempts to reuse old node if possible and given.
+ */
+function valueAsNode(childType, parent, subpath, newValue, oldNode) {
+    // ensure the value is valid-ish
+    (0, internal_ts_1.typecheckInternal)(childType, newValue);
+    function getNewNode() {
+        // the new value has a MST node
+        if ((0, internal_ts_1.isStateTreeNode)(newValue)) {
+            const childNode = (0, internal_ts_1.getStateTreeNode)(newValue);
+            childNode.assertAlive(internal_ts_1.EMPTY_OBJECT);
+            // the node lives here
+            if (childNode.parent !== null && childNode.parent === parent) {
+                childNode.setParent(parent, subpath);
+                return childNode;
+            }
+        }
+        // there is old node and new one is a value/snapshot
+        if (oldNode) {
+            return childType.reconcile(oldNode, newValue, parent, subpath);
+        }
+        // nothing to do, create from scratch
+        return childType.instantiate(parent, subpath, undefined, newValue);
+    }
+    const newNode = getNewNode();
+    if (oldNode && oldNode !== newNode) {
+        if (oldNode instanceof internal_ts_1.ObjectNode) {
+            // since it is going to be returned by pop/splice/shift better create it before killing it
+            // so it doesn't end up in an undead state
+            oldNode.createObservableInstanceIfNeeded();
+        }
+        oldNode.die();
+    }
+    return newNode;
+}
+/**
+ * Check if a node holds a value.
+ */
+function areSame(oldNode, newValue) {
+    // never consider dead old nodes for reconciliation
+    if (!oldNode.isAlive) {
+        return false;
+    }
+    // the new value has the same node
+    if ((0, internal_ts_1.isStateTreeNode)(newValue)) {
+        const newNode = (0, internal_ts_1.getStateTreeNode)(newValue);
+        return newNode.isAlive && newNode === oldNode;
+    }
+    // the provided value is the snapshot of the old node
+    if (oldNode.snapshot === newValue) {
+        return true;
+    }
+    // Non object nodes don't get reconciled
+    if (!(oldNode instanceof internal_ts_1.ObjectNode)) {
+        return false;
+    }
+    const oldNodeType = oldNode.getReconciliationType();
+    // new value is a snapshot with the correct identifier
+    return (oldNode.identifier !== null &&
+        oldNode.identifierAttribute &&
+        (0, internal_ts_1.isPlainObject)(newValue) &&
+        oldNodeType.is(newValue) &&
+        oldNodeType.isMatchingSnapshotId(oldNode, newValue));
+}
+/**
+ * Returns if a given value represents an array type.
+ *
+ * @param type
+ * @returns `true` if the type is an array type.
+ */
+function isArrayType(type) {
+    return (0, internal_ts_1.isType)(type) && (type.flags & internal_ts_1.TypeFlags.Array) > 0;
+}
+//# sourceMappingURL=array.js.map

package/dist/types/complex-types/array.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"array.js","sourceRoot":"","sources":["../../../src/types/complex-types/array.ts"],"names":[],"mappings":";;;AA4XA,sBAGC;AA4KD,kCAIC;AA/iBD,+BAWa;AAEb,mDAsC0B;AA2C1B;;;GAGG;AACH,MAAa,SAA+B,SAAQ,yBAInD;IAKoB;IAJV,KAAK,GAAG,uBAAS,CAAC,KAAK,CAAA;IACf,gBAAgB,GAAuC,EAAE,CAAA;IAC1E,YACE,IAAY,EACK,QAAY,EAC7B,mBAAuD,EAAE;QAEzD,KAAK,CAAC,IAAI,CAAC,CAAA;QAHM,aAAQ,GAAR,QAAQ,CAAI;QAI7B,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAA;IAC1C,CAAC;IAED,KAAK,CAAC,KAAkC;QACtC,MAAM,gBAAgB,GACpB,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC;YAC9B,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,KAAK,CAAC;YACrC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;QACb,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAA;IAClE,CAAC;IAED,WAAW,CACT,MAA4B,EAC5B,OAAe,EACf,WAAgB,EAChB,YAAmC;QAEnC,OAAO,IAAA,8BAAgB,EAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,CAAC,CAAA;IAC3E,CAAC;IAED,oBAAoB,CAClB,OAAkB,EAClB,WAAsB,EAAE;QAExB,MAAM,OAAO,GAAI,OAAO,CAAC,IAAa,CAAC,QAAQ,CAAA;QAC/C,MAAM,MAAM,GAAmB,EAAE,CAAA;QACjC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YAC/B,MAAM,OAAO,GAAG,EAAE,GAAG,KAAK,CAAA;YAC1B,MAAM,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,CAAA;QAC1E,CAAC,CAAC,CAAA;QACF,OAAO,MAAM,CAAA;IACf,CAAC;IAED,iBAAiB,CAAC,UAA0B;QAC1C,MAAM,OAAO,GAAG,EAAE,GAAG,yBAAW,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAA;QACnD,OAAO,iBAAU,CAAC,KAAK,CACrB,IAAA,sCAAwB,EAAC,UAAU,CAAC,EACpC,OAAO,CACK,CAAA;IAChB,CAAC;IAED,mBAAmB,CAAC,IAAe,EAAE,QAAmB;QACtD,IAAA,yBAAkB,EAAC,QAAQ,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAA;QAElD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAY,CAAA;QAC9B,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;YAC1C,MAAM,KAAK,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAA;YACnC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;gBAChC,MAAM,IAAI,GAAG,KAAK,CAAC,IAA0B,CAAE,CAAA;gBAC/C,MAAM,aAAa,GAAG,IAAA,iCAAmB,EACvC,QAA6B,EAC7B,IAAI,EACJ,IAAI,CACL,CACA;gBAAA,CAAC,CAAC,IAAA,qBAAO,GAAE,CAAC,CAAC,CAAC,gCAAkB,CAAC,CAAC,CAAC,mCAAqB,CAAC,CACxD,QAAQ,EACR,IAAI,EACJ,aAAa,CACd,CAAA;YACH,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,IAAA,gBAAS,EAAC,QAAqC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;QACjE,IAAA,cAAO,EAAC,QAAqC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;IAChE,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAED,WAAW,CAAC,IAAe;QACzB,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAA;IACjC,CAAC;IAED,YAAY,CAAC,IAAe,EAAE,GAAW;QACvC,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;QACzB,IAAI,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;YACpC,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;QAChC,CAAC;QACD,MAAM,IAAA,kBAAI,EAAC,eAAe,GAAG,GAAG,CAAC,CAAA;IACnC,CAAC;IAED,UAAU,CACR,MAA6D;QAE7D,MAAM,IAAI,GAAG,IAAA,8BAAgB,EAAC,MAAM,CAAC,MAA8B,CAAC,CAAA;QACpE,IAAI,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,EAAE,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,CAAA;QACnD,MAAM,OAAO,GAAI,IAAI,CAAC,IAAa,CAAC,QAAQ,CAAA;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,EAAE,CAAA;QAErC,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;YACpB,KAAK,QAAQ;gBACX,CAAC;oBACC,IAAI,MAAM,CAAC,QAAQ,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;wBACpD,OAAO,IAAI,CAAA;oBACb,CAAC;oBAED,MAAM,YAAY,GAAG,sBAAsB,CACzC,IAAI,EACJ,OAAO,EACP,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAC1B,CAAC,MAAM,CAAC,QAAQ,CAAC,EACjB,CAAC,MAAM,CAAC,KAAK,CAAC,CACf,CAAA;oBACD,IAAI,CAAC,YAAY,EAAE,CAAC;wBAClB,OAAO,IAAI,CAAA;oBACb,CAAC;oBACD,MAAM,CAAC,QAAQ,GAAG,YAAY,CAAC,CAAC,CAAC,CAAA;gBACnC,CAAC;gBACD,MAAK;YACP,KAAK,QAAQ;gBACX,CAAC;oBACC,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,GAAG,MAAM,CAAA;oBAE7C,MAAM,UAAU,GAAG,sBAAsB,CACvC,IAAI,EACJ,OAAO,EACP,UAAU,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,YAAY,CAAC,EAC7C,KAAK,EACL,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,CAAC,CAC/B,CAAA;oBACD,IAAI,CAAC,UAAU,EAAE,CAAC;wBAChB,OAAO,IAAI,CAAA;oBACb,CAAC;oBACD,MAAM,CAAC,KAAK,GAAG,UAAU,CAAA;oBAEzB,kCAAkC;oBAClC,KAAK,IAAI,CAAC,GAAG,KAAK,GAAG,YAAY,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;wBAC9D,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CACrB,IAAI,EACJ,EAAE,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,YAAY,CAAC,CACvC,CAAA;oBACH,CAAC;gBACH,CAAC;gBACD,MAAK;QACT,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAED,WAAW,CAAC,IAAe;QACzB,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;IAChE,CAAC;IAED,sBAAsB,CAAC,UAA0B;QAC/C,MAAM,SAAS,GAAc,EAAE,CAAA;QAC/B,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACpC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC,CAAA;QAC/C,CAAC,CAAC,CAAA;QACF,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,SAAS,CAAC,MAAwD;QAChE,MAAM,IAAI,GAAG,IAAA,8BAAgB,EAAC,MAAM,CAAC,MAA2B,CAAC,CAAA;QACjE,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;YACpB,KAAK,QAAQ;gBACX,OAAO,KAAK,IAAI,CAAC,SAAS,CACxB;oBACE,EAAE,EAAE,SAAS;oBACb,IAAI,EAAE,EAAE,GAAG,MAAM,CAAC,KAAK;oBACvB,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ;oBAC/B,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;iBACjE,EACD,IAAI,CACL,CAAA;YACH,KAAK,QAAQ;gBACX,KAAK,IAAI,CAAC,GAAG,MAAM,CAAC,YAAY,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;oBAClD,IAAI,CAAC,SAAS,CACZ;wBACE,EAAE,EAAE,QAAQ;wBACZ,IAAI,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC;wBAC7B,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ;qBACrC,EACD,IAAI,CACL,CAAA;gBACH,CAAC;gBACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC;oBAC3C,IAAI,CAAC,SAAS,CACZ;wBACE,EAAE,EAAE,KAAK;wBACT,IAAI,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC;wBAC7B,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ;wBAC1D,QAAQ,EAAE,SAAS;qBACpB,EACD,IAAI,CACL,CAAA;gBACH,CAAC;gBACD,OAAM;QACV,CAAC;IACH,CAAC;IAED,iBAAiB,CAAC,IAAe,EAAE,OAAe,EAAE,KAAiB;QACnE,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAA;QAC/B,MAAM,KAAK,GAAG,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QAC/D,QAAQ,KAAK,CAAC,EAAE,EAAE,CAAC;YACjB,KAAK,SAAS;gBACZ,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,KAAK,CAAA;gBAC3B,MAAK;YACP,KAAK,KAAK;gBACR,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;gBACpC,MAAK;YACP,KAAK,QAAQ;gBACX,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;gBACvB,MAAK;QACT,CAAC;IACH,CAAC;IAED,aAAa,CAAC,IAAe,EAAE,QAAmB;QAChD,IAAA,+BAAiB,EAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;QACjC,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAA;QAC/B,MAAM,CAAC,OAAO,CAAC,QAAe,CAAC,CAAA;IACjC,CAAC;IAED,YAAY;QACV,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAED,eAAe,CACb,KAAgB,EAChB,OAA2B;QAE3B,IAAI,CAAC,IAAA,qBAAO,EAAC,KAAK,CAAC,EAAE,CAAC;YACpB,OAAO,IAAA,8BAAgB,EAAC,OAAO,EAAE,KAAK,EAAE,uBAAuB,CAAC,CAAA;QAClE,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,IAAA,+BAAiB,EAAC,OAAO,EAAE,EAAE,GAAG,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;YACjD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAA;YACxD,IAAA,wBAAU,EAAC,OAAO,CAAC,CAAA;YACnB,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACtB,OAAO,MAAM,CAAA;YACf,CAAC;QACH,CAAC;QACD,OAAO,IAAA,8BAAgB,GAAE,CAAA;IAC3B,CAAC;IAED,kBAAkB;QAChB,OAAO,yBAAwB,CAAA;IACjC,CAAC;IAED,WAAW,CAAC,IAAe,EAAE,OAAe;QAC1C,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAA;IAC7C,CAAC;CACF;AA/PD,8BA+PC;AACD,SAAS,CAAC,SAAS,CAAC,aAAa,GAAG,IAAA,aAAM,EAAC,SAAS,CAAC,SAAS,CAAC,aAAa,CAAC,CAAA;AAE7E;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,KAAK,CAAsB,OAAW;IACpD,IAAA,0BAAY,EAAC,OAAO,EAAE,CAAC,CAAC,CAAA;IACxB,OAAO,IAAI,SAAS,CAAK,GAAG,OAAO,CAAC,IAAI,IAAI,EAAE,OAAO,CAAC,CAAA;AACxD,CAAC;AAED,SAAS,sBAAsB,CAC7B,MAAqB,EACrB,SAA8B,EAC9B,QAAmB,EACnB,SAAe,EACf,QAA6B;IAE7B,IAAI,cAAc,GAAG,IAAI,CAAA;IAEzB,KAAK,IAAI,CAAC,GAAG,CAAC,GAAI,CAAC,EAAE,EAAE,CAAC;QACtB,MAAM,UAAU,GAAG,CAAC,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,CAAA;QAC5C,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAA;QAC3B,IAAI,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QACpD,MAAM,OAAO,GAAG,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAA;QAEhC,kFAAkF;QAClF,oFAAoF;QACpF,IAAI,IAAA,oBAAM,EAAC,QAAQ,CAAC,EAAE,CAAC;YACrB,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAA;QACjC,CAAC;QAED,IAAI,CAAC,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;YAC5B,sBAAsB;YACtB,MAAK;QACP,CAAC;aAAM,IAAI,CAAC,UAAU,EAAE,CAAC;YACvB,0BAA0B;YAC1B,cAAc,GAAG,KAAK,CAAA;YACtB,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;YACrB,IAAI,OAAO,YAAY,wBAAU,EAAE,CAAC;gBAClC,0FAA0F;gBAC1F,0CAA0C;gBAC1C,OAAO,CAAC,gCAAgC,EAAE,CAAA;YAC5C,CAAC;YACD,OAAO,CAAC,GAAG,EAAE,CAAA;YACb,CAAC,EAAE,CAAA;QACL,CAAC;aAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YACpB,kCAAkC;YAClC,sGAAsG;YACtG,IACE,IAAA,6BAAe,EAAC,QAAQ,CAAC;gBACzB,IAAA,8BAAgB,EAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,MAAM,EAC5C,CAAC;gBACD,2FAA2F;gBAC3F,MAAM,IAAA,kBAAI,EACR,+HACE,MAAM,CAAC,IACT,IAAI,OAAO,+BAA+B,IAAA,8BAAgB,EAAC,QAAQ,CAAC,CAAC,IAAI,GAAG,CAC7E,CAAA;YACH,CAAC;YACD,cAAc,GAAG,KAAK,CAAA;YACtB,MAAM,OAAO,GAAG,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;YACjE,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAA;QAChC,CAAC;aAAM,IAAI,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC;YACtC,+BAA+B;YAC/B,QAAQ,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;QAC1E,CAAC;aAAM,CAAC;YACN,gCAAgC;YAChC,IAAI,QAAQ,GAAG,SAAS,CAAA;YAExB,qCAAqC;YACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACzC,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC;oBACnC,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;oBACnC,MAAK;gBACP,CAAC;YACH,CAAC;YAED,cAAc,GAAG,KAAK,CAAA;YACtB,MAAM,OAAO,GAAG,WAAW,CACzB,SAAS,EACT,MAAM,EACN,OAAO,EACP,QAAQ,EACR,QAAQ,CACT,CAAA;YACD,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAA;QAChC,CAAC;IACH,CAAC;IAED,OAAO,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAA;AACzC,CAAC;AAED;;GAEG;AACH,SAAS,WAAW,CAClB,SAAmB,EACnB,MAAqB,EACrB,OAAe,EACf,QAAa,EACb,OAAiB;IAEjB,gCAAgC;IAChC,IAAA,+BAAiB,EAAC,SAAS,EAAE,QAAQ,CAAC,CAAA;IAEtC,SAAS,UAAU;QACjB,+BAA+B;QAC/B,IAAI,IAAA,6BAAe,EAAC,QAAQ,CAAC,EAAE,CAAC;YAC9B,MAAM,SAAS,GAAG,IAAA,8BAAgB,EAAC,QAAQ,CAAC,CAAA;YAC5C,SAAS,CAAC,WAAW,CAAC,0BAAY,CAAC,CAAA;YAEnC,sBAAsB;YACtB,IAAI,SAAS,CAAC,MAAM,KAAK,IAAI,IAAI,SAAS,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;gBAC7D,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;gBACpC,OAAO,SAAS,CAAA;YAClB,CAAC;QACH,CAAC;QACD,oDAAoD;QACpD,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,SAAS,CAAC,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QAChE,CAAC;QAED,qCAAqC;QACrC,OAAO,SAAS,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;IACpE,CAAC;IAED,MAAM,OAAO,GAAG,UAAU,EAAE,CAAA;IAC5B,IAAI,OAAO,IAAI,OAAO,KAAK,OAAO,EAAE,CAAC;QACnC,IAAI,OAAO,YAAY,wBAAU,EAAE,CAAC;YAClC,0FAA0F;YAC1F,0CAA0C;YAC1C,OAAO,CAAC,gCAAgC,EAAE,CAAA;QAC5C,CAAC;QACD,OAAO,CAAC,GAAG,EAAE,CAAA;IACf,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC;AAED;;GAEG;AACH,SAAS,OAAO,CAAC,OAAgB,EAAE,QAAa;IAC9C,mDAAmD;IACnD,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACrB,OAAO,KAAK,CAAA;IACd,CAAC;IAED,kCAAkC;IAClC,IAAI,IAAA,6BAAe,EAAC,QAAQ,CAAC,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,IAAA,8BAAgB,EAAC,QAAQ,CAAC,CAAA;QAC1C,OAAO,OAAO,CAAC,OAAO,IAAI,OAAO,KAAK,OAAO,CAAA;IAC/C,CAAC;IAED,qDAAqD;IACrD,IAAI,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAClC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,wCAAwC;IACxC,IAAI,CAAC,CAAC,OAAO,YAAY,wBAAU,CAAC,EAAE,CAAC;QACrC,OAAO,KAAK,CAAA;IACd,CAAC;IAED,MAAM,WAAW,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAA;IACnD,sDAAsD;IACtD,OAAO,CACL,OAAO,CAAC,UAAU,KAAK,IAAI;QAC3B,OAAO,CAAC,mBAAmB;QAC3B,IAAA,2BAAa,EAAC,QAAQ,CAAC;QACvB,WAAW,CAAC,EAAE,CAAC,QAAQ,CAAC;QACvB,WAAmB,CAAC,oBAAoB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAC7D,CAAA;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CACzB,IAAc;IAEd,OAAO,IAAA,oBAAM,EAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,uBAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;AAC3D,CAAC"}

package/dist/types/complex-types/map.d.ts

@@ -0,0 +1,110 @@
+import { type IInterceptor, type IKeyValueMap, type IMapDidChange, type IMapWillChange, type Lambda, ObservableMap } from "mobx";
+import { type AnyNode, type AnyObjectNode, ComplexType, type ExtractCSTWithSTN, type IAnyType, type IChildNodesMap, type IHooksGetter, type IJsonPatch, type IType, type IValidationContext, type IValidationResult, TypeFlags } from "../../internal.ts";
+/** @hidden */
+export interface IMapType<IT extends IAnyType> extends IType<IKeyValueMap<IT["CreationType"]> | undefined, IKeyValueMap<IT["SnapshotType"]>, IMSTMap<IT>> {
+    hooks(hooks: IHooksGetter<IMSTMap<IT>>): IMapType<IT>;
+}
+/** @hidden */
+export interface IMSTMap<IT extends IAnyType> {
+    clear(): void;
+    delete(key: string): boolean;
+    forEach(callbackfn: (value: IT["Type"], key: string | number, map: this) => void, thisArg?: any): void;
+    get(key: string | number): IT["Type"] | undefined;
+    has(key: string | number): boolean;
+    set(key: string | number, value: ExtractCSTWithSTN<IT>): this;
+    readonly size: number;
+    put(value: ExtractCSTWithSTN<IT>): IT["Type"];
+    keys(): IterableIterator<string>;
+    values(): IterableIterator<IT["Type"]>;
+    entries(): IterableIterator<[string, IT["Type"]]>;
+    [Symbol.iterator](): IterableIterator<[string, IT["Type"]]>;
+    /** Merge another object into this map, returns self. */
+    merge(other: IMSTMap<IType<any, any, IT["TypeWithoutSTN"]>> | IKeyValueMap<ExtractCSTWithSTN<IT>> | any): this;
+    replace(values: IMSTMap<IType<any, any, IT["TypeWithoutSTN"]>> | IKeyValueMap<ExtractCSTWithSTN<IT>> | any): this;
+    toJSON(): IKeyValueMap<IT["SnapshotType"]>;
+    toString(): string;
+    [Symbol.toStringTag]: "Map";
+    /**
+     * Observes this object. Triggers for the events 'add', 'update' and 'delete'.
+     * See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/observe
+     * for callback details
+     */
+    observe(listener: (changes: IMapDidChange<string, IT["Type"]>) => void, fireImmediately?: boolean): Lambda;
+    intercept(handler: IInterceptor<IMapWillChange<string, IT["Type"]>>): Lambda;
+}
+/**
+ * @internal
+ * @hidden
+ */
+export declare enum MapIdentifierMode {
+    UNKNOWN = 0,
+    YES = 1,
+    NO = 2
+}
+/**
+ * @internal
+ * @hidden
+ */
+export declare class MapType<IT extends IAnyType> extends ComplexType<IKeyValueMap<IT["CreationType"]> | undefined, IKeyValueMap<IT["SnapshotType"]>, IMSTMap<IT>> {
+    private readonly _subType;
+    identifierMode: MapIdentifierMode;
+    mapIdentifierAttribute: string | undefined;
+    readonly flags = TypeFlags.Map;
+    private readonly hookInitializers;
+    constructor(name: string, _subType: IAnyType, hookInitializers?: Array<IHooksGetter<IMSTMap<IT>>>);
+    hooks(hooks: IHooksGetter<IMSTMap<IT>>): MapType<IT>;
+    instantiate(parent: AnyObjectNode | null, subpath: string, environment: any, initialValue: this["C"] | this["T"]): this["N"];
+    private _determineIdentifierMode;
+    initializeChildNodes(objNode: this["N"], initialSnapshot?: this["C"]): IChildNodesMap;
+    createNewInstance(childNodes: IChildNodesMap): this["T"];
+    finalizeNewInstance(node: this["N"], instance: ObservableMap<string, any>): void;
+    describe(): string;
+    getChildren(node: this["N"]): ReadonlyArray<AnyNode>;
+    getChildNode(node: this["N"], key: string): AnyNode;
+    willChange(change: IMapWillChange<string, AnyNode>): IMapWillChange<string, AnyNode> | null;
+    private processIdentifier;
+    getSnapshot(node: this["N"]): this["S"];
+    processInitialSnapshot(childNodes: IChildNodesMap): this["S"];
+    didChange(change: IMapDidChange<string, AnyNode>): void;
+    applyPatchLocally(node: this["N"], subpath: string, patch: IJsonPatch): void;
+    applySnapshot(node: this["N"], snapshot: this["C"]): void;
+    getChildType(): IAnyType;
+    isValidSnapshot(value: this["C"], context: IValidationContext): IValidationResult;
+    getDefaultSnapshot(): this["C"];
+    removeChild(node: this["N"], subpath: string): void;
+}
+/**
+ * `types.map` - Creates a key based collection type who's children are all of a uniform declared type.
+ * If the type stored in a map has an identifier, it is mandatory to store the child under that identifier in the map.
+ *
+ * This type will always produce [observable maps](https://mobx.js.org/api.html#observablemap)
+ *
+ * Example:
+ * ```ts
+ * const Todo = types.model({
+ *   id: types.identifier,
+ *   task: types.string
+ * })
+ *
+ * const TodoStore = types.model({
+ *   todos: types.map(Todo)
+ * })
+ *
+ * const s = TodoStore.create({ todos: {} })
+ * unprotect(s)
+ * s.todos.set(17, { task: "Grab coffee", id: 17 })
+ * s.todos.put({ task: "Grab cookie", id: 18 }) // put will infer key from the identifier
+ * console.log(s.todos.get(17).task) // prints: "Grab coffee"
+ * ```
+ *
+ * @param subtype
+ * @returns
+ */
+export declare function map<IT extends IAnyType>(subtype: IT): IMapType<IT>;
+/**
+ * Returns if a given value represents a map type.
+ *
+ * @param type
+ * @returns `true` if it is a map type.
+ */
+export declare function isMapType<Items extends IAnyType = IAnyType>(type: IAnyType): type is IMapType<Items>;