@jbrowse/mobx-state-tree 5.6.3 → 5.6.9

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

@@ -0,0 +1,361 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MapType = exports.MapIdentifierMode = void 0;
+exports.map = map;
+exports.isMapType = isMapType;
+const mobx_1 = require("mobx");
+const internal_ts_1 = require("../../internal.js");
+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();
+    if (subtypes === internal_ts_1.cannotDetermineSubtype) {
+        return false;
+    }
+    if (subtypes) {
+        const subtypesArray = (0, internal_ts_1.asArray)(subtypes);
+        for (const subtype of subtypesArray) {
+            if (!tryCollectModelTypes(subtype, modelTypes)) {
+                return false;
+            }
+        }
+    }
+    if (type instanceof internal_ts_1.ModelType) {
+        modelTypes.push(type);
+    }
+    return true;
+}
+/**
+ * @internal
+ * @hidden
+ */
+var MapIdentifierMode;
+(function (MapIdentifierMode) {
+    MapIdentifierMode[MapIdentifierMode["UNKNOWN"] = 0] = "UNKNOWN";
+    MapIdentifierMode[MapIdentifierMode["YES"] = 1] = "YES";
+    MapIdentifierMode[MapIdentifierMode["NO"] = 2] = "NO";
+})(MapIdentifierMode || (exports.MapIdentifierMode = MapIdentifierMode = {}));
+class MSTMap extends mobx_1.ObservableMap {
+    constructor(initialData, name) {
+        super(initialData, mobx_1.observable.ref.enhancer, name);
+    }
+    get(key) {
+        // maybe this is over-enthousiastic? normalize numeric keys to strings
+        return super.get("" + key);
+    }
+    has(key) {
+        return super.has("" + key);
+    }
+    delete(key) {
+        return super.delete("" + key);
+    }
+    set(key, value) {
+        return super.set("" + key, value);
+    }
+    put(value) {
+        if (!value) {
+            throw (0, internal_ts_1.fail)(`Map.put cannot be used to set empty values`);
+        }
+        if ((0, internal_ts_1.isStateTreeNode)(value)) {
+            const node = (0, internal_ts_1.getStateTreeNode)(value);
+            if ((0, internal_ts_1.devMode)()) {
+                if (!node.identifierAttribute) {
+                    throw (0, internal_ts_1.fail)(needsIdentifierError);
+                }
+            }
+            if (node.identifier === null) {
+                throw (0, internal_ts_1.fail)(needsIdentifierError);
+            }
+            this.set(node.identifier, value);
+            return value;
+        }
+        else if (!(0, internal_ts_1.isMutable)(value)) {
+            throw (0, internal_ts_1.fail)(`Map.put can only be used to store complex values`);
+        }
+        else {
+            const mapNode = (0, internal_ts_1.getStateTreeNode)(this);
+            const mapType = mapNode.type;
+            if (mapType.identifierMode !== MapIdentifierMode.YES) {
+                throw (0, internal_ts_1.fail)(needsIdentifierError);
+            }
+            const idAttr = mapType.mapIdentifierAttribute;
+            const id = value[idAttr];
+            if (!(0, internal_ts_1.isValidIdentifier)(id)) {
+                // try again but this time after creating a node for the value
+                // since it might be an optional identifier
+                const newNode = this.put(mapType.getChildType().create(value, mapNode.environment));
+                return this.put((0, internal_ts_1.getSnapshot)(newNode));
+            }
+            const key = (0, internal_ts_1.normalizeIdentifier)(id);
+            this.set(key, value);
+            return this.get(key);
+        }
+    }
+}
+/**
+ * @internal
+ * @hidden
+ */
+class MapType extends internal_ts_1.ComplexType {
+    _subType;
+    identifierMode = MapIdentifierMode.UNKNOWN;
+    mapIdentifierAttribute = undefined;
+    flags = internal_ts_1.TypeFlags.Map;
+    hookInitializers = [];
+    constructor(name, _subType, hookInitializers = []) {
+        super(name);
+        this._subType = _subType;
+        this._determineIdentifierMode();
+        this.hookInitializers = hookInitializers;
+    }
+    hooks(hooks) {
+        const hookInitializers = this.hookInitializers.length > 0
+            ? this.hookInitializers.concat(hooks)
+            : [hooks];
+        return new MapType(this.name, this._subType, hookInitializers);
+    }
+    instantiate(parent, subpath, environment, initialValue) {
+        this._determineIdentifierMode();
+        return (0, internal_ts_1.createObjectNode)(this, parent, subpath, environment, initialValue);
+    }
+    _determineIdentifierMode() {
+        if (this.identifierMode !== MapIdentifierMode.UNKNOWN) {
+            return;
+        }
+        const modelTypes = [];
+        if (tryCollectModelTypes(this._subType, modelTypes)) {
+            const identifierAttribute = modelTypes.reduce((current, type) => {
+                if (!type.identifierAttribute) {
+                    return current;
+                }
+                if (current && current !== type.identifierAttribute) {
+                    throw (0, internal_ts_1.fail)(`The objects in a map should all have the same identifier attribute, expected '${current}', but child of type '${type.name}' declared attribute '${type.identifierAttribute}' as identifier`);
+                }
+                return type.identifierAttribute;
+            }, undefined);
+            if (identifierAttribute) {
+                this.identifierMode = MapIdentifierMode.YES;
+                this.mapIdentifierAttribute = identifierAttribute;
+            }
+            else {
+                this.identifierMode = MapIdentifierMode.NO;
+            }
+        }
+    }
+    initializeChildNodes(objNode, initialSnapshot = {}) {
+        const subType = objNode.type._subType;
+        const result = {};
+        Object.keys(initialSnapshot).forEach(name => {
+            result[name] = subType.instantiate(objNode, name, undefined, initialSnapshot[name]);
+        });
+        return result;
+    }
+    createNewInstance(childNodes) {
+        return new MSTMap(childNodes, this.name);
+    }
+    finalizeNewInstance(node, instance) {
+        (0, mobx_1._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 = (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 as ObservableMap<any>).values()
+        return (0, mobx_1.values)(node.storedValue);
+    }
+    getChildNode(node, key) {
+        const childNode = node.storedValue.get("" + key);
+        if (!childNode) {
+            throw (0, internal_ts_1.fail)("Not a child " + key);
+        }
+        return childNode;
+    }
+    willChange(change) {
+        const node = (0, internal_ts_1.getStateTreeNode)(change.object);
+        const key = change.name;
+        node.assertWritable({ subpath: key });
+        const mapType = node.type;
+        const subType = mapType._subType;
+        switch (change.type) {
+            case "update":
+                {
+                    const { newValue } = change;
+                    const oldValue = change.object.get(key);
+                    if (newValue === oldValue) {
+                        return null;
+                    }
+                    (0, internal_ts_1.typecheckInternal)(subType, newValue);
+                    change.newValue = subType.reconcile(node.getChildNode(key), change.newValue, node, key);
+                    mapType.processIdentifier(key, change.newValue);
+                }
+                break;
+            case "add":
+                {
+                    (0, internal_ts_1.typecheckInternal)(subType, change.newValue);
+                    change.newValue = subType.instantiate(node, key, undefined, change.newValue);
+                    mapType.processIdentifier(key, change.newValue);
+                }
+                break;
+        }
+        return change;
+    }
+    processIdentifier(expected, node) {
+        if (this.identifierMode === MapIdentifierMode.YES &&
+            node instanceof internal_ts_1.ObjectNode) {
+            const identifier = node.identifier;
+            if (identifier !== expected) {
+                throw (0, internal_ts_1.fail)(`A map of objects containing an identifier should always store the object under their own identifier. Trying to store key '${identifier}', but expected: '${expected}'`);
+            }
+        }
+    }
+    getSnapshot(node) {
+        const res = {};
+        node.getChildren().forEach(childNode => {
+            res[childNode.subpath] = childNode.snapshot;
+        });
+        return res;
+    }
+    processInitialSnapshot(childNodes) {
+        const processed = {};
+        Object.keys(childNodes).forEach(key => {
+            processed[key] = 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: (0, internal_ts_1.escapeJsonPath)(change.name),
+                    value: change.newValue.snapshot,
+                    oldValue: change.oldValue ? change.oldValue.snapshot : undefined
+                }, node);
+            case "add":
+                return void node.emitPatch({
+                    op: "add",
+                    path: (0, internal_ts_1.escapeJsonPath)(change.name),
+                    value: change.newValue.snapshot,
+                    oldValue: undefined
+                }, node);
+            case "delete":
+                // a node got deleted, get the old snapshot and make the node die
+                const oldSnapshot = change.oldValue.snapshot;
+                change.oldValue.die();
+                // emit the patch
+                return void node.emitPatch({
+                    op: "remove",
+                    path: (0, internal_ts_1.escapeJsonPath)(change.name),
+                    oldValue: oldSnapshot
+                }, node);
+        }
+    }
+    applyPatchLocally(node, subpath, patch) {
+        const target = node.storedValue;
+        switch (patch.op) {
+            case "add":
+            case "replace":
+                target.set(subpath, patch.value);
+                break;
+            case "remove":
+                target.delete(subpath);
+                break;
+        }
+    }
+    applySnapshot(node, snapshot) {
+        (0, internal_ts_1.typecheckInternal)(this, snapshot);
+        const target = node.storedValue;
+        const currentKeys = {};
+        Array.from(target.keys()).forEach(key => {
+            currentKeys[key] = false;
+        });
+        if (snapshot) {
+            // Don't use target.replace, as it will throw away all existing items first
+            for (const key in snapshot) {
+                target.set(key, snapshot[key]);
+                currentKeys["" + key] = true;
+            }
+        }
+        Object.keys(currentKeys).forEach(key => {
+            if (currentKeys[key] === false) {
+                target.delete(key);
+            }
+        });
+    }
+    getChildType() {
+        return this._subType;
+    }
+    isValidSnapshot(value, context) {
+        if (!(0, internal_ts_1.isPlainObject)(value)) {
+            return (0, internal_ts_1.typeCheckFailure)(context, value, "Value is not a plain object");
+        }
+        for (const key of Object.keys(value)) {
+            (0, internal_ts_1.getContextForPath)(context, key, this._subType);
+            const errors = this._subType.validate(value[key], 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_OBJECT;
+    }
+    removeChild(node, subpath) {
+        node.storedValue.delete(subpath);
+    }
+}
+exports.MapType = MapType;
+MapType.prototype.applySnapshot = (0, mobx_1.action)(MapType.prototype.applySnapshot);
+/**
+ * `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
+ */
+function map(subtype) {
+    return new MapType(`Map<string, ${subtype.name}>`, subtype);
+}
+/**
+ * Returns if a given value represents a map type.
+ *
+ * @param type
+ * @returns `true` if it is a map type.
+ */
+function isMapType(type) {
+    return (0, internal_ts_1.isType)(type) && (type.flags & internal_ts_1.TypeFlags.Map) > 0;
+}
+//# sourceMappingURL=map.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"map.js","sourceRoot":"","sources":["../../../src/types/complex-types/map.ts"],"names":[],"mappings":";;;AAsjBA,kBAEC;AAQD,8BAIC;AApkBD,+BAca;AAEb,mDAwC0B;AA6D1B,MAAM,oBAAoB,GAAG,yFAAyF,CAAA;AAEtH,SAAS,oBAAoB,CAC3B,IAAc,EACd,UAAgC;IAEhC,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAA;IACnC,IAAI,QAAQ,KAAK,oCAAsB,EAAE,CAAC;QACxC,OAAO,KAAK,CAAA;IACd,CAAC;IACD,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,aAAa,GAAG,IAAA,qBAAO,EAAC,QAAQ,CAAC,CAAA;QACvC,KAAK,MAAM,OAAO,IAAI,aAAa,EAAE,CAAC;YACpC,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,UAAU,CAAC,EAAE,CAAC;gBAC/C,OAAO,KAAK,CAAA;YACd,CAAC;QACH,CAAC;IACH,CAAC;IACD,IAAI,IAAI,YAAY,uBAAS,EAAE,CAAC;QAC9B,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACvB,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;;GAGG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,+DAAO,CAAA;IACP,uDAAG,CAAA;IACH,qDAAE,CAAA;AACJ,CAAC,EAJW,iBAAiB,iCAAjB,iBAAiB,QAI5B;AAED,MAAM,MAA4B,SAAQ,oBAA0B;IAClE,YACE,WAAkE,EAClE,IAAa;QAEb,KAAK,CAAC,WAAW,EAAG,iBAAU,CAAC,GAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;IAC5D,CAAC;IAED,GAAG,CAAC,GAAW;QACb,sEAAsE;QACtE,OAAO,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,CAAA;IAC5B,CAAC;IAED,GAAG,CAAC,GAAW;QACb,OAAO,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,CAAA;IAC5B,CAAC;IAED,MAAM,CAAC,GAAW;QAChB,OAAO,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,CAAC,CAAA;IAC/B,CAAC;IAED,GAAG,CAAC,GAAW,EAAE,KAA4B;QAC3C,OAAO,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,EAAE,KAAK,CAAC,CAAA;IACnC,CAAC;IAED,GAAG,CAAC,KAA4B;QAC9B,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAA,kBAAI,EAAC,4CAA4C,CAAC,CAAA;QAC1D,CAAC;QACD,IAAI,IAAA,6BAAe,EAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,GAAG,IAAA,8BAAgB,EAAC,KAAK,CAAC,CAAA;YACpC,IAAI,IAAA,qBAAO,GAAE,EAAE,CAAC;gBACd,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;oBAC9B,MAAM,IAAA,kBAAI,EAAC,oBAAoB,CAAC,CAAA;gBAClC,CAAC;YACH,CAAC;YACD,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;gBAC7B,MAAM,IAAA,kBAAI,EAAC,oBAAoB,CAAC,CAAA;YAClC,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;YAChC,OAAO,KAAY,CAAA;QACrB,CAAC;aAAM,IAAI,CAAC,IAAA,uBAAS,EAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAA,kBAAI,EAAC,kDAAkD,CAAC,CAAA;QAChE,CAAC;aAAM,CAAC;YACN,MAAM,OAAO,GAAG,IAAA,8BAAgB,EAAC,IAAyB,CAAC,CAAA;YAC3D,MAAM,OAAO,GAAG,OAAO,CAAC,IAAoB,CAAA;YAE5C,IAAI,OAAO,CAAC,cAAc,KAAK,iBAAiB,CAAC,GAAG,EAAE,CAAC;gBACrD,MAAM,IAAA,kBAAI,EAAC,oBAAoB,CAAC,CAAA;YAClC,CAAC;YAED,MAAM,MAAM,GAAG,OAAO,CAAC,sBAAuB,CAAA;YAC9C,MAAM,EAAE,GAAI,KAAa,CAAC,MAAM,CAAC,CAAA;YACjC,IAAI,CAAC,IAAA,+BAAiB,EAAC,EAAE,CAAC,EAAE,CAAC;gBAC3B,8DAA8D;gBAC9D,2CAA2C;gBAC3C,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CACtB,OAAO,CAAC,YAAY,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,WAAW,CAAC,CAC1D,CAAA;gBACD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAA,yBAAW,EAAC,OAAO,CAAC,CAAC,CAAA;YACvC,CAAC;YACD,MAAM,GAAG,GAAG,IAAA,iCAAmB,EAAC,EAAE,CAAC,CAAA;YACnC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;YACpB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAQ,CAAA;QAC7B,CAAC;IACH,CAAC;CACF;AAED;;;GAGG;AACH,MAAa,OAA6B,SAAQ,yBAIjD;IASoB;IARnB,cAAc,GAAsB,iBAAiB,CAAC,OAAO,CAAA;IAC7D,sBAAsB,GAAuB,SAAS,CAAA;IAC7C,KAAK,GAAG,uBAAS,CAAC,GAAG,CAAA;IAEb,gBAAgB,GAAqC,EAAE,CAAA;IAExE,YACE,IAAY,EACK,QAAkB,EACnC,mBAAqD,EAAE;QAEvD,KAAK,CAAC,IAAI,CAAC,CAAA;QAHM,aAAQ,GAAR,QAAQ,CAAU;QAInC,IAAI,CAAC,wBAAwB,EAAE,CAAA;QAC/B,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAA;IAC1C,CAAC;IAED,KAAK,CAAC,KAAgC;QACpC,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,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAA;IAChE,CAAC;IAED,WAAW,CACT,MAA4B,EAC5B,OAAe,EACf,WAAgB,EAChB,YAAmC;QAEnC,IAAI,CAAC,wBAAwB,EAAE,CAAA;QAC/B,OAAO,IAAA,8BAAgB,EAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,CAAC,CAAA;IAC3E,CAAC;IAEO,wBAAwB;QAC9B,IAAI,IAAI,CAAC,cAAc,KAAK,iBAAiB,CAAC,OAAO,EAAE,CAAC;YACtD,OAAM;QACR,CAAC;QAED,MAAM,UAAU,GAAoB,EAAE,CAAA;QACtC,IAAI,oBAAoB,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,CAAC;YACpD,MAAM,mBAAmB,GAAuB,UAAU,CAAC,MAAM,CAC/D,CAAC,OAA6C,EAAE,IAAI,EAAE,EAAE;gBACtD,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;oBAC9B,OAAO,OAAO,CAAA;gBAChB,CAAC;gBACD,IAAI,OAAO,IAAI,OAAO,KAAK,IAAI,CAAC,mBAAmB,EAAE,CAAC;oBACpD,MAAM,IAAA,kBAAI,EACR,iFAAiF,OAAO,yBAAyB,IAAI,CAAC,IAAI,yBAAyB,IAAI,CAAC,mBAAmB,iBAAiB,CAC7L,CAAA;gBACH,CAAC;gBACD,OAAO,IAAI,CAAC,mBAAmB,CAAA;YACjC,CAAC,EACD,SAAiD,CAClD,CAAA;YAED,IAAI,mBAAmB,EAAE,CAAC;gBACxB,IAAI,CAAC,cAAc,GAAG,iBAAiB,CAAC,GAAG,CAAA;gBAC3C,IAAI,CAAC,sBAAsB,GAAG,mBAAmB,CAAA;YACnD,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,cAAc,GAAG,iBAAiB,CAAC,EAAE,CAAA;YAC5C,CAAC;QACH,CAAC;IACH,CAAC;IAED,oBAAoB,CAClB,OAAkB,EAClB,kBAA6B,EAAE;QAE/B,MAAM,OAAO,GAAI,OAAO,CAAC,IAAa,CAAC,QAAQ,CAAA;QAC/C,MAAM,MAAM,GAAmB,EAAE,CAAA;QACjC,MAAM,CAAC,IAAI,CAAC,eAAgB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YAC3C,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,WAAW,CAChC,OAAO,EACP,IAAI,EACJ,SAAS,EACT,eAAe,CAAC,IAAI,CAAC,CACtB,CAAA;QACH,CAAC,CAAC,CAAA;QAEF,OAAO,MAAM,CAAA;IACf,CAAC;IAED,iBAAiB,CAAC,UAA0B;QAC1C,OAAO,IAAI,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAQ,CAAA;IACjD,CAAC;IAED,mBAAmB,CACjB,IAAe,EACf,QAAoC;QAEpC,IAAA,sBAAe,EAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;QAErC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAY,CAAA;QAC9B,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;YAC1C,MAAM,KAAK,GAAG,WAAW,CAAC,QAAkC,CAAC,CAAA;YAC7D,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,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;QACpC,IAAA,cAAO,EAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;IACnC,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAED,WAAW,CAAC,IAAe;QACzB,2DAA2D;QAC3D,OAAO,IAAA,aAAM,EAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IACjC,CAAC;IAED,YAAY,CAAC,IAAe,EAAE,GAAW;QACvC,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,CAAA;QAChD,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAA,kBAAI,EAAC,cAAc,GAAG,GAAG,CAAC,CAAA;QAClC,CAAC;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,UAAU,CACR,MAAuC;QAEvC,MAAM,IAAI,GAAG,IAAA,8BAAgB,EAAC,MAAM,CAAC,MAA2B,CAAC,CAAA;QACjE,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAA;QACvB,IAAI,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAA;QACrC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAY,CAAA;QACjC,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAA;QAEhC,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;YACpB,KAAK,QAAQ;gBACX,CAAC;oBACC,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAA;oBAC3B,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;oBACvC,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;wBAC1B,OAAO,IAAI,CAAA;oBACb,CAAC;oBACD,IAAA,+BAAiB,EAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;oBACpC,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC,SAAS,CACjC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EACtB,MAAM,CAAC,QAAQ,EACf,IAAI,EACJ,GAAG,CACJ,CAAA;oBACD,OAAO,CAAC,iBAAiB,CAAC,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;gBACjD,CAAC;gBACD,MAAK;YACP,KAAK,KAAK;gBACR,CAAC;oBACC,IAAA,+BAAiB,EAAC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;oBAC3C,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC,WAAW,CACnC,IAAI,EACJ,GAAG,EACH,SAAS,EACT,MAAM,CAAC,QAAQ,CAChB,CAAA;oBACD,OAAO,CAAC,iBAAiB,CAAC,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;gBACjD,CAAC;gBACD,MAAK;QACT,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAEO,iBAAiB,CAAC,QAAgB,EAAE,IAAa;QACvD,IACE,IAAI,CAAC,cAAc,KAAK,iBAAiB,CAAC,GAAG;YAC7C,IAAI,YAAY,wBAAU,EAC1B,CAAC;YACD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAW,CAAA;YACnC,IAAI,UAAU,KAAK,QAAQ,EAAE,CAAC;gBAC5B,MAAM,IAAA,kBAAI,EACR,6HAA6H,UAAU,qBAAqB,QAAQ,GAAG,CACxK,CAAA;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,WAAW,CAAC,IAAe;QACzB,MAAM,GAAG,GAAQ,EAAE,CAAA;QACnB,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;YACrC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAA;QAC7C,CAAC,CAAC,CAAA;QACF,OAAO,GAAG,CAAA;IACZ,CAAC;IAED,sBAAsB,CAAC,UAA0B;QAC/C,MAAM,SAAS,GAAQ,EAAE,CAAA;QACzB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACpC,SAAS,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,CAAA;QAChD,CAAC,CAAC,CAAA;QACF,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,SAAS,CAAC,MAAsC;QAC9C,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,IAAA,4BAAc,EAAC,MAAM,CAAC,IAAI,CAAC;oBACjC,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,KAAK;gBACR,OAAO,KAAK,IAAI,CAAC,SAAS,CACxB;oBACE,EAAE,EAAE,KAAK;oBACT,IAAI,EAAE,IAAA,4BAAc,EAAC,MAAM,CAAC,IAAI,CAAC;oBACjC,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ;oBAC/B,QAAQ,EAAE,SAAS;iBACpB,EACD,IAAI,CACL,CAAA;YACH,KAAK,QAAQ;gBACX,iEAAiE;gBACjE,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAA;gBAC5C,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAA;gBACrB,iBAAiB;gBACjB,OAAO,KAAK,IAAI,CAAC,SAAS,CACxB;oBACE,EAAE,EAAE,QAAQ;oBACZ,IAAI,EAAE,IAAA,4BAAc,EAAC,MAAM,CAAC,IAAI,CAAC;oBACjC,QAAQ,EAAE,WAAW;iBACtB,EACD,IAAI,CACL,CAAA;QACL,CAAC;IACH,CAAC;IAED,iBAAiB,CAAC,IAAe,EAAE,OAAe,EAAE,KAAiB;QACnE,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAA;QAC/B,QAAQ,KAAK,CAAC,EAAE,EAAE,CAAC;YACjB,KAAK,KAAK,CAAC;YACX,KAAK,SAAS;gBACZ,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;gBAChC,MAAK;YACP,KAAK,QAAQ;gBACX,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;gBACtB,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,WAAW,GAA+B,EAAE,CAAA;QAClD,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACtC,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;QAC1B,CAAC,CAAC,CAAA;QACF,IAAI,QAAQ,EAAE,CAAC;YACb,2EAA2E;YAC3E,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;gBAC3B,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAA;gBAC9B,WAAW,CAAC,EAAE,GAAG,GAAG,CAAC,GAAG,IAAI,CAAA;YAC9B,CAAC;QACH,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACrC,IAAI,WAAW,CAAC,GAAG,CAAC,KAAK,KAAK,EAAE,CAAC;gBAC/B,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YACpB,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,YAAY;QACV,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAED,eAAe,CACb,KAAgB,EAChB,OAA2B;QAE3B,IAAI,CAAC,IAAA,2BAAa,EAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,IAAA,8BAAgB,EAAC,OAAO,EAAE,KAAK,EAAE,6BAA6B,CAAC,CAAA;QACxE,CAAC;QAED,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACrC,IAAA,+BAAiB,EAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;YAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAA;YAC1D,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,0BAAyB,CAAA;IAClC,CAAC;IAED,WAAW,CAAC,IAAe,EAAE,OAAe;QAC1C,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAClC,CAAC;CACF;AAzTD,0BAyTC;AACD,OAAO,CAAC,SAAS,CAAC,aAAa,GAAG,IAAA,aAAM,EAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,CAAA;AAEzE;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,SAAgB,GAAG,CAAsB,OAAW;IAClD,OAAO,IAAI,OAAO,CAAK,eAAe,OAAO,CAAC,IAAI,GAAG,EAAE,OAAO,CAAC,CAAA;AACjE,CAAC;AAED;;;;;GAKG;AACH,SAAgB,SAAS,CACvB,IAAc;IAEd,OAAO,IAAA,oBAAM,EAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,uBAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;AACzD,CAAC"}

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

@@ -0,0 +1,192 @@
+import { type AnyNode, type AnyObjectNode, ComplexType, type FunctionWithFlag, type IAnyType, type IChildNodesMap, type IJsonPatch, type IStateTreeNode, type IType, type IValidationContext, type IValidationResult, type Instance, TypeFlags, type _CustomOrOther, type _NotCustomized } from "../../internal.ts";
+/** @hidden */
+export interface ModelProperties {
+    [key: string]: IAnyType;
+}
+/** @hidden */
+export type ModelPrimitive = string | number | boolean | Date;
+/** @hidden */
+export interface ModelPropertiesDeclaration {
+    [key: string]: ModelPrimitive | IAnyType;
+}
+/**
+ * Unmaps syntax property declarations to a map of { propName: IType }
+ *
+ * @hidden
+ */
+export type ModelPropertiesDeclarationToProperties<T extends ModelPropertiesDeclaration> = T extends {
+    [k: string]: IAnyType;
+} ? T : {
+    [K in keyof T]: T[K] extends IAnyType ? T[K] : T[K] extends string ? IType<string | undefined, string, string> : T[K] extends number ? IType<number | undefined, number, number> : T[K] extends boolean ? IType<boolean | undefined, boolean, boolean> : T[K] extends Date ? IType<number | Date | undefined, number, Date> : never;
+};
+/**
+ * Checks if a value is optional (undefined, any or unknown).
+ * @hidden
+ *
+ * Examples:
+ * - string = false
+ * - undefined = true
+ * - string | undefined = true
+ * - string & undefined = false, but we don't care
+ * - any = true
+ * - unknown = true
+ */
+type IsOptionalValue<C, TV, FV> = undefined extends C ? TV : FV;
+/**
+ * Name of the properties of an object that can't be set to undefined, any or unknown
+ * @hidden
+ */
+type DefinablePropsNames<T> = {
+    [K in keyof T]: IsOptionalValue<T[K], never, K>;
+}[keyof T];
+/** @hidden */
+export declare const $nonEmptyObject: unique symbol;
+/** @hidden */
+export interface NonEmptyObject {
+    [$nonEmptyObject]?: any;
+}
+/** @hidden */
+export type ExtractCFromProps<P extends ModelProperties> = {
+    [k in keyof P]: P[k]["CreationType"];
+};
+/** @hidden */
+export type ModelCreationType<PC> = {
+    [P in DefinablePropsNames<PC>]: PC[P];
+} & Partial<PC> & NonEmptyObject;
+/** @hidden */
+export type ModelCreationType2<P extends ModelProperties, CustomC> = keyof P extends never ? IStateTreeNode : _CustomOrOther<CustomC, ModelCreationType<ExtractCFromProps<P>>>;
+/** @hidden */
+export type ModelSnapshotType<P extends ModelProperties> = {
+    [K in keyof P]: P[K]["SnapshotType"];
+} & NonEmptyObject;
+/** @hidden */
+export type ModelSnapshotType2<P extends ModelProperties, CustomS> = _CustomOrOther<CustomS, ModelSnapshotType<P>>;
+/**
+ * @hidden
+ * we keep this separate from ModelInstanceType to shorten model instance types generated declarations
+ */
+export type ModelInstanceTypeProps<P extends ModelProperties> = {
+    [K in keyof P]: P[K]["Type"];
+} & NonEmptyObject;
+/**
+ * @hidden
+ * do not transform this to an interface or model instance type generated declarations will be longer
+ */
+export type ModelInstanceType<P extends ModelProperties, O> = ModelInstanceTypeProps<P> & O;
+/** @hidden */
+export interface ModelActions {
+    [key: string]: FunctionWithFlag;
+}
+export interface IModelType<PROPS extends ModelProperties, OTHERS, CustomC = _NotCustomized, CustomS = _NotCustomized> extends IType<ModelCreationType2<PROPS, CustomC>, ModelSnapshotType2<PROPS, CustomS>, ModelInstanceType<PROPS, OTHERS>> {
+    readonly properties: PROPS;
+    named(newName: string): IModelType<PROPS, OTHERS, CustomC, CustomS>;
+    props<PROPS2 extends ModelPropertiesDeclaration>(props: PROPS2): IModelType<PROPS & ModelPropertiesDeclarationToProperties<PROPS2>, OTHERS, CustomC, CustomS>;
+    views<V extends object>(fn: (self: Instance<this>) => V): IModelType<PROPS, OTHERS & V, CustomC, CustomS>;
+    actions<A extends ModelActions>(fn: (self: Instance<this>) => A): IModelType<PROPS, OTHERS & A, CustomC, CustomS>;
+    volatile<TP extends object>(fn: (self: Instance<this>) => TP): IModelType<PROPS, OTHERS & TP, CustomC, CustomS>;
+    extend<A extends ModelActions = {}, V extends object = {}, VS extends object = {}>(fn: (self: Instance<this>) => {
+        actions?: A;
+        views?: V;
+        state?: VS;
+    }): IModelType<PROPS, OTHERS & A & V & VS, CustomC, CustomS>;
+    preProcessSnapshot<NewC = ModelCreationType2<PROPS, CustomC>>(fn: (snapshot: NewC) => ModelCreationType2<PROPS, CustomC>): IModelType<PROPS, OTHERS, NewC, CustomS>;
+    postProcessSnapshot<NewS = ModelSnapshotType2<PROPS, CustomS>>(fn: (snapshot: ModelSnapshotType2<PROPS, CustomS>) => NewS): IModelType<PROPS, OTHERS, CustomC, NewS>;
+}
+/**
+ * Any model type.
+ */
+export interface IAnyModelType extends IModelType<any, any, any, any> {
+}
+/** @hidden */
+export type ExtractProps<T extends IAnyModelType> = T extends IModelType<infer P, any, any, any> ? P : never;
+/** @hidden */
+export type ExtractOthers<T extends IAnyModelType> = T extends IModelType<any, infer O, any, any> ? O : never;
+/**
+ * @internal
+ * @hidden
+ */
+export interface ModelTypeConfig {
+    name?: string;
+    properties?: ModelPropertiesDeclaration;
+    initializers?: ReadonlyArray<(instance: any) => any>;
+    preProcessor?: (snapshot: any) => any;
+    postProcessor?: (snapshot: any) => any;
+}
+/**
+ * @internal
+ * @hidden
+ */
+export declare class ModelType<PROPS extends ModelProperties, OTHERS, CustomC, CustomS, MT extends IModelType<PROPS, OTHERS, CustomC, CustomS>> extends ComplexType<ModelCreationType2<PROPS, CustomC>, ModelSnapshotType2<PROPS, CustomS>, ModelInstanceType<PROPS, OTHERS>> implements IModelType<PROPS, OTHERS, CustomC, CustomS> {
+    readonly flags = TypeFlags.Object;
+    readonly initializers: ((instance: any) => any)[];
+    readonly properties: PROPS;
+    private preProcessor;
+    private postProcessor;
+    readonly propertyNames: string[];
+    constructor(opts: ModelTypeConfig);
+    private _getIdentifierAttribute;
+    cloneAndEnhance(opts: ModelTypeConfig): IAnyModelType;
+    actions<A extends ModelActions>(fn: (self: Instance<this>) => A): IAnyModelType;
+    private instantiateActions;
+    named: MT["named"];
+    props: MT["props"];
+    volatile<TP extends object>(fn: (self: Instance<this>) => TP): IAnyModelType;
+    private instantiateVolatileState;
+    extend<A extends ModelActions = {}, V extends object = {}, VS extends object = {}>(fn: (self: Instance<this>) => {
+        actions?: A;
+        views?: V;
+        state?: VS;
+    }): IAnyModelType;
+    views<V extends object>(fn: (self: Instance<this>) => V): IAnyModelType;
+    private instantiateViews;
+    preProcessSnapshot: MT["preProcessSnapshot"];
+    postProcessSnapshot: MT["postProcessSnapshot"];
+    instantiate(parent: AnyObjectNode | null, subpath: string, environment: any, initialValue: this["C"] | this["T"]): this["N"];
+    initializeChildNodes(objNode: this["N"], initialSnapshot?: any): IChildNodesMap;
+    createNewInstance(childNodes: IChildNodesMap): this["T"];
+    finalizeNewInstance(node: this["N"], instance: this["T"]): void;
+    private willChange;
+    private didChange;
+    getChildren(node: this["N"]): ReadonlyArray<AnyNode>;
+    getChildNode(node: this["N"], key: string): AnyNode;
+    getSnapshot(node: this["N"], applyPostProcess?: boolean): this["S"];
+    processInitialSnapshot(childNodes: IChildNodesMap): this["S"];
+    applyPatchLocally(node: this["N"], subpath: string, patch: IJsonPatch): void;
+    applySnapshot(node: this["N"], snapshot: this["C"]): void;
+    applySnapshotPreProcessor(snapshot: any): any;
+    applySnapshotPostProcessor(snapshot: any): any;
+    getChildType(propertyName: string): IAnyType;
+    isValidSnapshot(value: this["C"], context: IValidationContext): IValidationResult;
+    private forAllProps;
+    describe(): string;
+    getDefaultSnapshot(): this["C"];
+    removeChild(node: this["N"], subpath: string): void;
+}
+export declare function model<P extends ModelPropertiesDeclaration = {}>(name: string, properties?: P): IModelType<ModelPropertiesDeclarationToProperties<P>, {}>;
+export declare function model<P extends ModelPropertiesDeclaration = {}>(properties?: P): IModelType<ModelPropertiesDeclarationToProperties<P>, {}>;
+/** @hidden */
+export type _CustomJoin<A, B> = A extends _NotCustomized ? B : A & B;
+export declare function compose<PA extends ModelProperties, OA, FCA, FSA, PB extends ModelProperties, OB, FCB, FSB>(name: string, A: IModelType<PA, OA, FCA, FSA>, B: IModelType<PB, OB, FCB, FSB>): IModelType<PA & PB, OA & OB, _CustomJoin<FCA, FCB>, _CustomJoin<FSA, FSB>>;
+export declare function compose<PA extends ModelProperties, OA, FCA, FSA, PB extends ModelProperties, OB, FCB, FSB>(A: IModelType<PA, OA, FCA, FSA>, B: IModelType<PB, OB, FCB, FSB>): IModelType<PA & PB, OA & OB, _CustomJoin<FCA, FCB>, _CustomJoin<FSA, FSB>>;
+export declare function compose<PA extends ModelProperties, OA, FCA, FSA, PB extends ModelProperties, OB, FCB, FSB, PC extends ModelProperties, OC, FCC, FSC>(name: string, A: IModelType<PA, OA, FCA, FSA>, B: IModelType<PB, OB, FCB, FSB>, C: IModelType<PC, OC, FCC, FSC>): IModelType<PA & PB & PC, OA & OB & OC, _CustomJoin<FCA, _CustomJoin<FCB, FCC>>, _CustomJoin<FSA, _CustomJoin<FSB, FSC>>>;
+export declare function compose<PA extends ModelProperties, OA, FCA, FSA, PB extends ModelProperties, OB, FCB, FSB, PC extends ModelProperties, OC, FCC, FSC>(A: IModelType<PA, OA, FCA, FSA>, B: IModelType<PB, OB, FCB, FSB>, C: IModelType<PC, OC, FCC, FSC>): IModelType<PA & PB & PC, OA & OB & OC, _CustomJoin<FCA, _CustomJoin<FCB, FCC>>, _CustomJoin<FSA, _CustomJoin<FSB, FSC>>>;
+export declare function compose<PA extends ModelProperties, OA, FCA, FSA, PB extends ModelProperties, OB, FCB, FSB, PC extends ModelProperties, OC, FCC, FSC, PD extends ModelProperties, OD, FCD, FSD>(name: string, A: IModelType<PA, OA, FCA, FSA>, B: IModelType<PB, OB, FCB, FSB>, C: IModelType<PC, OC, FCC, FSC>, D: IModelType<PD, OD, FCD, FSD>): IModelType<PA & PB & PC & PD, OA & OB & OC & OD, _CustomJoin<FCA, _CustomJoin<FCB, _CustomJoin<FCC, FCD>>>, _CustomJoin<FSA, _CustomJoin<FSB, _CustomJoin<FSC, FSD>>>>;
+export declare function compose<PA extends ModelProperties, OA, FCA, FSA, PB extends ModelProperties, OB, FCB, FSB, PC extends ModelProperties, OC, FCC, FSC, PD extends ModelProperties, OD, FCD, FSD>(A: IModelType<PA, OA, FCA, FSA>, B: IModelType<PB, OB, FCB, FSB>, C: IModelType<PC, OC, FCC, FSC>, D: IModelType<PD, OD, FCD, FSD>): IModelType<PA & PB & PC & PD, OA & OB & OC & OD, _CustomJoin<FCA, _CustomJoin<FCB, _CustomJoin<FCC, FCD>>>, _CustomJoin<FSA, _CustomJoin<FSB, _CustomJoin<FSC, FSD>>>>;
+export declare function compose<PA extends ModelProperties, OA, FCA, FSA, PB extends ModelProperties, OB, FCB, FSB, PC extends ModelProperties, OC, FCC, FSC, PD extends ModelProperties, OD, FCD, FSD, PE extends ModelProperties, OE, FCE, FSE>(name: string, A: IModelType<PA, OA, FCA, FSA>, B: IModelType<PB, OB, FCB, FSB>, C: IModelType<PC, OC, FCC, FSC>, D: IModelType<PD, OD, FCD, FSD>, E: IModelType<PE, OE, FCE, FSE>): IModelType<PA & PB & PC & PD & PE, OA & OB & OC & OD & OE, _CustomJoin<FCA, _CustomJoin<FCB, _CustomJoin<FCC, _CustomJoin<FCD, FCE>>>>, _CustomJoin<FSA, _CustomJoin<FSB, _CustomJoin<FSC, _CustomJoin<FSD, FSE>>>>>;
+export declare function compose<PA extends ModelProperties, OA, FCA, FSA, PB extends ModelProperties, OB, FCB, FSB, PC extends ModelProperties, OC, FCC, FSC, PD extends ModelProperties, OD, FCD, FSD, PE extends ModelProperties, OE, FCE, FSE>(A: IModelType<PA, OA, FCA, FSA>, B: IModelType<PB, OB, FCB, FSB>, C: IModelType<PC, OC, FCC, FSC>, D: IModelType<PD, OD, FCD, FSD>, E: IModelType<PE, OE, FCE, FSE>): IModelType<PA & PB & PC & PD & PE, OA & OB & OC & OD & OE, _CustomJoin<FCA, _CustomJoin<FCB, _CustomJoin<FCC, _CustomJoin<FCD, FCE>>>>, _CustomJoin<FSA, _CustomJoin<FSB, _CustomJoin<FSC, _CustomJoin<FSD, FSE>>>>>;
+export declare function compose<PA extends ModelProperties, OA, FCA, FSA, PB extends ModelProperties, OB, FCB, FSB, PC extends ModelProperties, OC, FCC, FSC, PD extends ModelProperties, OD, FCD, FSD, PE extends ModelProperties, OE, FCE, FSE, PF extends ModelProperties, OF, FCF, FSF>(name: string, A: IModelType<PA, OA, FCA, FSA>, B: IModelType<PB, OB, FCB, FSB>, C: IModelType<PC, OC, FCC, FSC>, D: IModelType<PD, OD, FCD, FSD>, E: IModelType<PE, OE, FCE, FSE>, F: IModelType<PF, OF, FCF, FSF>): IModelType<PA & PB & PC & PD & PE & PF, OA & OB & OC & OD & OE & OF, _CustomJoin<FCA, _CustomJoin<FCB, _CustomJoin<FCC, _CustomJoin<FCD, _CustomJoin<FCE, FCF>>>>>, _CustomJoin<FSA, _CustomJoin<FSB, _CustomJoin<FSC, _CustomJoin<FSD, _CustomJoin<FSE, FSF>>>>>>;
+export declare function compose<PA extends ModelProperties, OA, FCA, FSA, PB extends ModelProperties, OB, FCB, FSB, PC extends ModelProperties, OC, FCC, FSC, PD extends ModelProperties, OD, FCD, FSD, PE extends ModelProperties, OE, FCE, FSE, PF extends ModelProperties, OF, FCF, FSF>(A: IModelType<PA, OA, FCA, FSA>, B: IModelType<PB, OB, FCB, FSB>, C: IModelType<PC, OC, FCC, FSC>, D: IModelType<PD, OD, FCD, FSD>, E: IModelType<PE, OE, FCE, FSE>, F: IModelType<PF, OF, FCF, FSF>): IModelType<PA & PB & PC & PD & PE & PF, OA & OB & OC & OD & OE & OF, _CustomJoin<FCA, _CustomJoin<FCB, _CustomJoin<FCC, _CustomJoin<FCD, _CustomJoin<FCE, FCF>>>>>, _CustomJoin<FSA, _CustomJoin<FSB, _CustomJoin<FSC, _CustomJoin<FSD, _CustomJoin<FSE, FSF>>>>>>;
+export declare function compose<PA extends ModelProperties, OA, FCA, FSA, PB extends ModelProperties, OB, FCB, FSB, PC extends ModelProperties, OC, FCC, FSC, PD extends ModelProperties, OD, FCD, FSD, PE extends ModelProperties, OE, FCE, FSE, PF extends ModelProperties, OF, FCF, FSF, PG extends ModelProperties, OG, FCG, FSG>(name: string, A: IModelType<PA, OA, FCA, FSA>, B: IModelType<PB, OB, FCB, FSB>, C: IModelType<PC, OC, FCC, FSC>, D: IModelType<PD, OD, FCD, FSD>, E: IModelType<PE, OE, FCE, FSE>, F: IModelType<PF, OF, FCF, FSF>, G: IModelType<PG, OG, FCG, FSG>): IModelType<PA & PB & PC & PD & PE & PF & PG, OA & OB & OC & OD & OE & OF & OG, _CustomJoin<FCA, _CustomJoin<FCB, _CustomJoin<FCC, _CustomJoin<FCD, _CustomJoin<FCE, _CustomJoin<FCF, FCG>>>>>>, _CustomJoin<FSA, _CustomJoin<FSB, _CustomJoin<FSC, _CustomJoin<FSD, _CustomJoin<FSE, _CustomJoin<FSF, FSG>>>>>>>;
+export declare function compose<PA extends ModelProperties, OA, FCA, FSA, PB extends ModelProperties, OB, FCB, FSB, PC extends ModelProperties, OC, FCC, FSC, PD extends ModelProperties, OD, FCD, FSD, PE extends ModelProperties, OE, FCE, FSE, PF extends ModelProperties, OF, FCF, FSF, PG extends ModelProperties, OG, FCG, FSG>(A: IModelType<PA, OA, FCA, FSA>, B: IModelType<PB, OB, FCB, FSB>, C: IModelType<PC, OC, FCC, FSC>, D: IModelType<PD, OD, FCD, FSD>, E: IModelType<PE, OE, FCE, FSE>, F: IModelType<PF, OF, FCF, FSF>, G: IModelType<PG, OG, FCG, FSG>): IModelType<PA & PB & PC & PD & PE & PF & PG, OA & OB & OC & OD & OE & OF & OG, _CustomJoin<FCA, _CustomJoin<FCB, _CustomJoin<FCC, _CustomJoin<FCD, _CustomJoin<FCE, _CustomJoin<FCF, FCG>>>>>>, _CustomJoin<FSA, _CustomJoin<FSB, _CustomJoin<FSC, _CustomJoin<FSD, _CustomJoin<FSE, _CustomJoin<FSF, FSG>>>>>>>;
+export declare function compose<PA extends ModelProperties, OA, FCA, FSA, PB extends ModelProperties, OB, FCB, FSB, PC extends ModelProperties, OC, FCC, FSC, PD extends ModelProperties, OD, FCD, FSD, PE extends ModelProperties, OE, FCE, FSE, PF extends ModelProperties, OF, FCF, FSF, PG extends ModelProperties, OG, FCG, FSG, PH extends ModelProperties, OH, FCH, FSH>(name: string, A: IModelType<PA, OA, FCA, FSA>, B: IModelType<PB, OB, FCB, FSB>, C: IModelType<PC, OC, FCC, FSC>, D: IModelType<PD, OD, FCD, FSD>, E: IModelType<PE, OE, FCE, FSE>, F: IModelType<PF, OF, FCF, FSF>, G: IModelType<PG, OG, FCG, FSG>, H: IModelType<PH, OH, FCH, FSH>): IModelType<PA & PB & PC & PD & PE & PF & PG & PH, OA & OB & OC & OD & OE & OF & OG & OH, _CustomJoin<FCA, _CustomJoin<FCB, _CustomJoin<FCC, _CustomJoin<FCD, _CustomJoin<FCE, _CustomJoin<FCF, _CustomJoin<FCG, FCH>>>>>>>, _CustomJoin<FSA, _CustomJoin<FSB, _CustomJoin<FSC, _CustomJoin<FSD, _CustomJoin<FSE, _CustomJoin<FSF, _CustomJoin<FSG, FSH>>>>>>>>;
+export declare function compose<PA extends ModelProperties, OA, FCA, FSA, PB extends ModelProperties, OB, FCB, FSB, PC extends ModelProperties, OC, FCC, FSC, PD extends ModelProperties, OD, FCD, FSD, PE extends ModelProperties, OE, FCE, FSE, PF extends ModelProperties, OF, FCF, FSF, PG extends ModelProperties, OG, FCG, FSG, PH extends ModelProperties, OH, FCH, FSH>(A: IModelType<PA, OA, FCA, FSA>, B: IModelType<PB, OB, FCB, FSB>, C: IModelType<PC, OC, FCC, FSC>, D: IModelType<PD, OD, FCD, FSD>, E: IModelType<PE, OE, FCE, FSE>, F: IModelType<PF, OF, FCF, FSF>, G: IModelType<PG, OG, FCG, FSG>, H: IModelType<PH, OH, FCH, FSH>): IModelType<PA & PB & PC & PD & PE & PF & PG & PH, OA & OB & OC & OD & OE & OF & OG & OH, _CustomJoin<FCA, _CustomJoin<FCB, _CustomJoin<FCC, _CustomJoin<FCD, _CustomJoin<FCE, _CustomJoin<FCF, _CustomJoin<FCG, FCH>>>>>>>, _CustomJoin<FSA, _CustomJoin<FSB, _CustomJoin<FSC, _CustomJoin<FSD, _CustomJoin<FSE, _CustomJoin<FSF, _CustomJoin<FSG, FSH>>>>>>>>;
+export declare function compose<PA extends ModelProperties, OA, FCA, FSA, PB extends ModelProperties, OB, FCB, FSB, PC extends ModelProperties, OC, FCC, FSC, PD extends ModelProperties, OD, FCD, FSD, PE extends ModelProperties, OE, FCE, FSE, PF extends ModelProperties, OF, FCF, FSF, PG extends ModelProperties, OG, FCG, FSG, PH extends ModelProperties, OH, FCH, FSH, PI extends ModelProperties, OI, FCI, FSI>(name: string, A: IModelType<PA, OA, FCA, FSA>, B: IModelType<PB, OB, FCB, FSB>, C: IModelType<PC, OC, FCC, FSC>, D: IModelType<PD, OD, FCD, FSD>, E: IModelType<PE, OE, FCE, FSE>, F: IModelType<PF, OF, FCF, FSF>, G: IModelType<PG, OG, FCG, FSG>, H: IModelType<PH, OH, FCH, FSH>, I: IModelType<PI, OI, FCI, FSI>): IModelType<PA & PB & PC & PD & PE & PF & PG & PH & PI, OA & OB & OC & OD & OE & OF & OG & OH & OI, _CustomJoin<FCA, _CustomJoin<FCB, _CustomJoin<FCC, _CustomJoin<FCD, _CustomJoin<FCE, _CustomJoin<FCF, _CustomJoin<FCG, _CustomJoin<FCH, FCI>>>>>>>>, _CustomJoin<FSA, _CustomJoin<FSB, _CustomJoin<FSC, _CustomJoin<FSD, _CustomJoin<FSE, _CustomJoin<FSF, _CustomJoin<FSG, _CustomJoin<FSH, FSI>>>>>>>>>;
+export declare function compose<PA extends ModelProperties, OA, FCA, FSA, PB extends ModelProperties, OB, FCB, FSB, PC extends ModelProperties, OC, FCC, FSC, PD extends ModelProperties, OD, FCD, FSD, PE extends ModelProperties, OE, FCE, FSE, PF extends ModelProperties, OF, FCF, FSF, PG extends ModelProperties, OG, FCG, FSG, PH extends ModelProperties, OH, FCH, FSH, PI extends ModelProperties, OI, FCI, FSI>(A: IModelType<PA, OA, FCA, FSA>, B: IModelType<PB, OB, FCB, FSB>, C: IModelType<PC, OC, FCC, FSC>, D: IModelType<PD, OD, FCD, FSD>, E: IModelType<PE, OE, FCE, FSE>, F: IModelType<PF, OF, FCF, FSF>, G: IModelType<PG, OG, FCG, FSG>, H: IModelType<PH, OH, FCH, FSH>, I: IModelType<PI, OI, FCI, FSI>): IModelType<PA & PB & PC & PD & PE & PF & PG & PH & PI, OA & OB & OC & OD & OE & OF & OG & OH & OI, _CustomJoin<FCA, _CustomJoin<FCB, _CustomJoin<FCC, _CustomJoin<FCD, _CustomJoin<FCE, _CustomJoin<FCF, _CustomJoin<FCG, _CustomJoin<FCH, FCI>>>>>>>>, _CustomJoin<FSA, _CustomJoin<FSB, _CustomJoin<FSC, _CustomJoin<FSD, _CustomJoin<FSE, _CustomJoin<FSF, _CustomJoin<FSG, _CustomJoin<FSH, FSI>>>>>>>>>;
+/**
+ * Returns if a given value represents a model type.
+ *
+ * @param type
+ * @returns
+ */
+export declare function isModelType<IT extends IAnyModelType = IAnyModelType>(type: IAnyType): type is IT;
+export {};