@colyseus/schema 3.0.23 → 3.0.24

package/build/umd/index.js

@@ -4738,13 +4738,25 @@
         }
         // TODO: allow to set multiple tags at once
         add(obj, tag = DEFAULT_VIEW_TAG, checkIncludeParent = true) {
-            if (!obj?.[$changes]) {
+            const changeTree = obj?.[$changes];
+            if (!changeTree) {
                 console.warn("StateView#add(), invalid object:", obj);
                 return this;
             }
+            else if (!changeTree.parent &&
+                changeTree.refId !== 0 // allow root object
+            ) {
+                /**
+                 * TODO: can we avoid this?
+                 *
+                 * When the "parent" structure has the @view() tag, it is currently
+                 * not possible to identify it has to be added to the view as well
+                 * (this.addParentOf() is not called).
+                 */
+                throw new Error(`Cannot add a detached instance to the StateView. Make sure to assign the "${changeTree.ref.constructor.name}" instance to the state before calling view.add()`);
+            }
             // FIXME: ArraySchema/MapSchema do not have metadata
             const metadata = obj.constructor[Symbol.metadata];
-            const changeTree = obj[$changes];
             this.visible.add(changeTree);
             // add to iterable list (only the explicitly added items)
             if (this.iterable && checkIncludeParent) {

package/lib/encoder/StateView.js

@@ -32,13 +32,25 @@ class StateView {
     }
     // TODO: allow to set multiple tags at once
     add(obj, tag = annotations_1.DEFAULT_VIEW_TAG, checkIncludeParent = true) {
-        if (!obj?.[symbols_1.$changes]) {
+        const changeTree = obj?.[symbols_1.$changes];
+        if (!changeTree) {
             console.warn("StateView#add(), invalid object:", obj);
             return this;
         }
+        else if (!changeTree.parent &&
+            changeTree.refId !== 0 // allow root object
+        ) {
+            /**
+             * TODO: can we avoid this?
+             *
+             * When the "parent" structure has the @view() tag, it is currently
+             * not possible to identify it has to be added to the view as well
+             * (this.addParentOf() is not called).
+             */
+            throw new Error(`Cannot add a detached instance to the StateView. Make sure to assign the "${changeTree.ref.constructor.name}" instance to the state before calling view.add()`);
+        }
         // FIXME: ArraySchema/MapSchema do not have metadata
         const metadata = obj.constructor[Symbol.metadata];
-        const changeTree = obj[symbols_1.$changes];
         this.visible.add(changeTree);
         // add to iterable list (only the explicitly added items)
         if (this.iterable && checkIncludeParent) {

package/lib/encoder/StateView.js.map

@@ -1 +1 @@
-{"version":3,"file":"StateView.js","sourceRoot":"","sources":["../../src/encoder/StateView.ts"],"names":[],"mappings":";;;AAOA,gCAEC;AARD,8CAAuF;AACvF,gDAAkD;AAClD,2CAA6C;AAC7C,0CAAuC;AACvC,0CAA2C;AAE3C,SAAgB,UAAU,CAAC,WAAoB,KAAK;IAChD,OAAO,IAAI,SAAS,CAAC,QAAQ,CAAC,CAAC;AACnC,CAAC;AAED,MAAa,SAAS;IAyBlB,YAAmB,WAAoB,KAAK;QAAzB,aAAQ,GAAR,QAAQ,CAAiB;QAlB5C;;WAEG;QACH,YAAO,GAAwB,IAAI,OAAO,EAAc,CAAC;QAEzD;;WAEG;QACH,cAAS,GAAwB,IAAI,OAAO,EAAc,CAAC;QAI3D;;;WAGG;QACH,YAAO,GAAG,IAAI,GAAG,EAA6B,CAAC;QAG3C,IAAI,QAAQ,EAAE,CAAC;YACX,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QACpB,CAAC;IACL,CAAC;IAED,2CAA2C;IAC3C,GAAG,CAAC,GAAQ,EAAE,MAAc,8BAAgB,EAAE,qBAA8B,IAAI;QAC5E,IAAI,CAAC,GAAG,EAAE,CAAC,kBAAQ,CAAC,EAAE,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC,kCAAkC,EAAE,GAAG,CAAC,CAAC;YACtD,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,oDAAoD;QACpD,MAAM,QAAQ,GAAa,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC5D,MAAM,UAAU,GAAe,GAAG,CAAC,kBAAQ,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAE7B,yDAAyD;QACzD,IAAI,IAAI,CAAC,QAAQ,IAAI,kBAAkB,EAAE,CAAC;YACtC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;QAED,0BAA0B;QAC1B,qCAAqC;QACrC,uCAAuC;QACvC,IAAI,kBAAkB,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;YAC1C,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QACtC,CAAC;QAED,EAAE;QACF,gEAAgE;QAChE,6CAA6C;QAC7C,EAAE;QACF,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACjD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAChD,CAAC;QAED,UAAU;QACV,IAAI,GAAG,KAAK,8BAAgB,EAAE,CAAC;YAC3B,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gBACb,IAAI,CAAC,IAAI,GAAG,IAAI,OAAO,EAA2B,CAAC;YACvD,CAAC;YACD,IAAI,IAAiB,CAAC;YACtB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC7B,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;gBACzB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YACpC,CAAC;iBAAM,CAAC;gBACJ,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACrC,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAEd,6BAA6B;YAC7B,QAAQ,EAAE,CAAC,gCAAsB,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBACzD,IAAI,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,gBAAS,CAAC,MAAM,EAAE,CAAC;oBACnD,OAAO,CAAC,KAAK,CAAC,GAAG,gBAAS,CAAC,GAAG,CAAC;gBACnC,CAAC;YACL,CAAC,CAAC,CAAC;QAEP,CAAC;aAAM,CAAC;YACJ,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACnD,MAAM,SAAS,GAAG,CAAC,UAAU,CAAC,eAAe,KAAK,SAAS,CAAC;gBACxD,CAAC,CAAC,UAAU,CAAC,kBAAkB;gBAC/B,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC;YAE5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC9D,MAAM,KAAK,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;gBACtC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;oBAAC,SAAS;gBAAC,CAAC,CAAC,2BAA2B;gBAElE,MAAM,EAAE,GAAG,UAAU,CAAC,iBAAiB,CAAC,KAAK,CAAC,IAAI,gBAAS,CAAC,GAAG,CAAC;gBAChE,MAAM,UAAU,GAAG,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC;gBACzC,IACI,CAAC,UAAU,CAAC,KAAK,IAAI,+FAA+F;oBACpH,CACI,WAAW,IAAI,8BAA8B;wBAC7C,UAAU,KAAK,SAAS,IAAI,2BAA2B;wBACvD,UAAU,KAAK,GAAG,CAAC,kBAAkB;qBACxC;oBACD,EAAE,KAAK,gBAAS,CAAC,MAAM,EACzB,CAAC;oBACC,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;gBACxB,CAAC;YACL,CAAC;QACL,CAAC;QAED,+CAA+C;QAC/C,UAAU,CAAC,YAAY,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YACtC,mDAAmD;YACnD,IACI,QAAQ;gBACR,QAAQ,CAAC,KAAK,CAAC,CAAC,GAAG,KAAK,SAAS;gBACjC,QAAQ,CAAC,KAAK,CAAC,CAAC,GAAG,KAAK,GAAG,EAC7B,CAAC;gBACC,OAAO;YACX,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IAChB,CAAC;IAES,WAAW,CAAC,eAA2B,EAAE,GAAW;QAC1D,MAAM,UAAU,GAAG,eAAe,CAAC,MAAM,CAAC,kBAAQ,CAAC,CAAC;QACpD,MAAM,WAAW,GAAG,eAAe,CAAC,WAAW,CAAC;QAEhD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YAChC,8CAA8C;YAC9C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAE7B,sBAAsB;YACtB,MAAM,gBAAgB,GAAe,UAAU,CAAC,MAAM,EAAE,CAAC,kBAAQ,CAAC,CAAC;YACnE,IAAI,gBAAgB,IAAI,CAAC,gBAAgB,CAAC,eAAe,KAAK,SAAS,CAAC,EAAE,CAAC;gBACvE,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;YACtC,CAAC;YAED,qDAAqD;YACrD,mDAAmD;QACvD,CAAC;QAED,8BAA8B;QAC9B,IAAI,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,KAAK,gBAAS,CAAC,MAAM,EAAE,CAAC;YACzD,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACjD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBACxB,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YAChD,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gBACb,IAAI,CAAC,IAAI,GAAG,IAAI,OAAO,EAA2B,CAAC;YACvD,CAAC;YAED,IAAI,IAAiB,CAAC;YACtB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC7B,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;gBACzB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YACpC,CAAC;iBAAM,CAAC;gBACJ,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACrC,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAEd,OAAO,CAAC,WAAW,CAAC,GAAG,gBAAS,CAAC,GAAG,CAAC;QACzC,CAAC;IACL,CAAC;IAID,MAAM,CAAC,GAAQ,EAAE,MAAc,8BAAgB,EAAE,WAAoB,KAAK;QACtE,MAAM,UAAU,GAAe,GAAG,CAAC,kBAAQ,CAAC,CAAC;QAC7C,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,GAAG,CAAC,CAAC;YACzD,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAEhC,4BAA4B;QAC5B,IACI,IAAI,CAAC,QAAQ;YACb,CAAC,QAAQ,CAAC,mEAAmE;UAC/E,CAAC;YACC,IAAA,iBAAS,EAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QACnD,CAAC;QAED,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC;QAC3B,MAAM,QAAQ,GAAa,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,6CAA6C;QAE1G,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACjD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAChD,CAAC;QAED,IAAI,GAAG,KAAK,8BAAgB,EAAE,CAAC;YAC3B,mCAAmC;YACnC,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;YACjC,IAAI,CAAC,mBAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;gBACpC,MAAM,gBAAgB,GAAG,MAAM,CAAC,kBAAQ,CAAC,CAAC;gBAC1C,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;gBACvD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;oBACxB,OAAO,GAAG,EAAE,CAAC;oBACb,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;gBACtD,CAAC;gBACD,4BAA4B;gBAC5B,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,gBAAS,CAAC,MAAM,CAAC;YAEvD,CAAC;iBAAM,CAAC;gBACJ,kCAAkC;gBAClC,QAAQ,EAAE,CAAC,2BAAiB,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAC5C,OAAO,CAAC,KAAK,CAAC,GAAG,gBAAS,CAAC,MAAM,CAAC,CAAC;YAC3C,CAAC;QAGL,CAAC;aAAM,CAAC;YACJ,gCAAgC;YAChC,QAAQ,EAAE,CAAC,gCAAsB,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CACtD,OAAO,CAAC,KAAK,CAAC,GAAG,gBAAS,CAAC,MAAM,CAAC,CAAC;QAC3C,CAAC;QAED,aAAa;QACb,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACvC,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;gBACpB,kBAAkB;gBAClB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACjC,CAAC;iBAAM,CAAC;gBACJ,sBAAsB;gBACtB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBAEjB,0CAA0C;gBAC1C,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;oBAClB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;gBACjC,CAAC;YACL,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,GAAG,CAAC,GAAQ;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,kBAAQ,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED,MAAM,CAAC,EAAO,EAAE,MAAc,8BAAgB;QAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,kBAAQ,CAAC,CAAC,CAAC;QAC1C,OAAO,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC;IACnC,CAAC;IAED,KAAK;QACD,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,0GAA0G,CAAC,CAAC;QAChI,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAChD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,8BAAgB,EAAE,IAAI,CAAC,CAAC;QACvD,CAAC;QAED,oBAAoB;QACpB,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IAC1B,CAAC;CACJ;AA1QD,8BA0QC","sourcesContent":["import { ChangeSet, ChangeTree, IndexedOperations, Ref } from \"./ChangeTree\";\nimport { $changes, $fieldIndexesByViewTag, $viewFieldIndexes } from \"../types/symbols\";\nimport { DEFAULT_VIEW_TAG } from \"../annotations\";\nimport { OPERATION } from \"../encoding/spec\";\nimport { Metadata } from \"../Metadata\";\nimport { spliceOne } from \"../types/utils\";\n\nexport function createView(iterable: boolean = false) {\n    return new StateView(iterable);\n}\n\nexport class StateView {\n    /**\n     * Iterable list of items that are visible to this view\n     * (Available only if constructed with `iterable: true`)\n     */\n    items: Ref[];\n\n    /**\n     * List of ChangeTree's that are visible to this view\n     */\n    visible: WeakSet<ChangeTree> = new WeakSet<ChangeTree>();\n\n    /**\n     * List of ChangeTree's that are invisible to this view\n     */\n    invisible: WeakSet<ChangeTree> = new WeakSet<ChangeTree>();\n\n    tags?: WeakMap<ChangeTree, Set<number>>; // TODO: use bit manipulation instead of Set<number> ()\n\n    /**\n     * Manual \"ADD\" operations for changes per ChangeTree, specific to this view.\n     * (This is used to force encoding a property, even if it was not changed)\n     */\n    changes = new Map<number, IndexedOperations>();\n\n    constructor(public iterable: boolean = false) {\n        if (iterable) {\n            this.items = [];\n        }\n    }\n\n    // TODO: allow to set multiple tags at once\n    add(obj: Ref, tag: number = DEFAULT_VIEW_TAG, checkIncludeParent: boolean = true) {\n        if (!obj?.[$changes]) {\n            console.warn(\"StateView#add(), invalid object:\", obj);\n            return this;\n        }\n\n        // FIXME: ArraySchema/MapSchema do not have metadata\n        const metadata: Metadata = obj.constructor[Symbol.metadata];\n        const changeTree: ChangeTree = obj[$changes];\n        this.visible.add(changeTree);\n\n        // add to iterable list (only the explicitly added items)\n        if (this.iterable && checkIncludeParent) {\n            this.items.push(obj);\n        }\n\n        // add parent ChangeTree's\n        // - if it was invisible to this view\n        // - if it were previously filtered out\n        if (checkIncludeParent && changeTree.parent) {\n            this.addParentOf(changeTree, tag);\n        }\n\n        //\n        // TODO: when adding an item of a MapSchema, the changes may not\n        // be set (only the parent's changes are set)\n        //\n        let changes = this.changes.get(changeTree.refId);\n        if (changes === undefined) {\n            changes = {};\n            this.changes.set(changeTree.refId, changes);\n        }\n\n        // set tag\n        if (tag !== DEFAULT_VIEW_TAG) {\n            if (!this.tags) {\n                this.tags = new WeakMap<ChangeTree, Set<number>>();\n            }\n            let tags: Set<number>;\n            if (!this.tags.has(changeTree)) {\n                tags = new Set<number>();\n                this.tags.set(changeTree, tags);\n            } else {\n                tags = this.tags.get(changeTree);\n            }\n            tags.add(tag);\n\n            // Ref: add tagged properties\n            metadata?.[$fieldIndexesByViewTag]?.[tag]?.forEach((index) => {\n                if (changeTree.getChange(index) !== OPERATION.DELETE) {\n                    changes[index] = OPERATION.ADD;\n                }\n            });\n\n        } else {\n            const isInvisible = this.invisible.has(changeTree);\n            const changeSet = (changeTree.filteredChanges !== undefined)\n                ? changeTree.allFilteredChanges\n                : changeTree.allChanges;\n\n            for (let i = 0, len = changeSet.operations.length; i < len; i++) {\n                const index = changeSet.operations[i];\n                if (index === undefined) { continue; } // skip \"undefined\" indexes\n\n                const op = changeTree.indexedOperations[index] ?? OPERATION.ADD;\n                const tagAtIndex = metadata?.[index].tag;\n                if (\n                    !changeTree.isNew && // new structures will be added as part of .encode() call, no need to force it to .encodeView()\n                    (\n                        isInvisible || // if \"invisible\", include all\n                        tagAtIndex === undefined || // \"all change\" with no tag\n                        tagAtIndex === tag // tagged property\n                    ) &&\n                    op !== OPERATION.DELETE\n                ) {\n                    changes[index] = op;\n                }\n            }\n        }\n\n        // Add children of this ChangeTree to this view\n        changeTree.forEachChild((change, index) => {\n            // Do not ADD children that don't have the same tag\n            if (\n                metadata &&\n                metadata[index].tag !== undefined &&\n                metadata[index].tag !== tag\n            ) {\n                return;\n            }\n            this.add(change.ref, tag, false);\n        });\n\n        return this;\n    }\n\n    protected addParentOf(childChangeTree: ChangeTree, tag: number) {\n        const changeTree = childChangeTree.parent[$changes];\n        const parentIndex = childChangeTree.parentIndex;\n\n        if (!this.visible.has(changeTree)) {\n            // view must have all \"changeTree\" parent tree\n            this.visible.add(changeTree);\n\n            // add parent's parent\n            const parentChangeTree: ChangeTree = changeTree.parent?.[$changes];\n            if (parentChangeTree && (parentChangeTree.filteredChanges !== undefined)) {\n                this.addParentOf(changeTree, tag);\n            }\n\n            // // parent is already available, no need to add it!\n            // if (!this.invisible.has(changeTree)) { return; }\n        }\n\n        // add parent's tag properties\n        if (changeTree.getChange(parentIndex) !== OPERATION.DELETE) {\n            let changes = this.changes.get(changeTree.refId);\n            if (changes === undefined) {\n                changes = {};\n                this.changes.set(changeTree.refId, changes);\n            }\n\n            if (!this.tags) {\n                this.tags = new WeakMap<ChangeTree, Set<number>>();\n            }\n\n            let tags: Set<number>;\n            if (!this.tags.has(changeTree)) {\n                tags = new Set<number>();\n                this.tags.set(changeTree, tags);\n            } else {\n                tags = this.tags.get(changeTree);\n            }\n            tags.add(tag);\n\n            changes[parentIndex] = OPERATION.ADD;\n        }\n    }\n\n    remove(obj: Ref, tag?: number): this; // hide _isClear parameter from public API\n    remove(obj: Ref, tag?: number, _isClear?: boolean): this;\n    remove(obj: Ref, tag: number = DEFAULT_VIEW_TAG, _isClear: boolean = false): this {\n        const changeTree: ChangeTree = obj[$changes];\n        if (!changeTree) {\n            console.warn(\"StateView#remove(), invalid object:\", obj);\n            return this;\n        }\n\n        this.visible.delete(changeTree);\n\n        // remove from iterable list\n        if (\n            this.iterable &&\n            !_isClear // no need to remove during clear(), as it will be cleared entirely\n        ) {\n            spliceOne(this.items, this.items.indexOf(obj));\n        }\n\n        const ref = changeTree.ref;\n        const metadata: Metadata = ref.constructor[Symbol.metadata]; // ArraySchema/MapSchema do not have metadata\n\n        let changes = this.changes.get(changeTree.refId);\n        if (changes === undefined) {\n            changes = {};\n            this.changes.set(changeTree.refId, changes);\n        }\n\n        if (tag === DEFAULT_VIEW_TAG) {\n            // parent is collection (Map/Array)\n            const parent = changeTree.parent;\n            if (!Metadata.isValidInstance(parent)) {\n                const parentChangeTree = parent[$changes];\n                let changes = this.changes.get(parentChangeTree.refId);\n                if (changes === undefined) {\n                    changes = {};\n                    this.changes.set(parentChangeTree.refId, changes);\n                }\n                // DELETE / DELETE BY REF ID\n                changes[changeTree.parentIndex] = OPERATION.DELETE;\n\n            } else {\n                // delete all \"tagged\" properties.\n                metadata?.[$viewFieldIndexes].forEach((index) =>\n                    changes[index] = OPERATION.DELETE);\n            }\n\n\n        } else {\n            // delete only tagged properties\n            metadata?.[$fieldIndexesByViewTag][tag].forEach((index) =>\n                changes[index] = OPERATION.DELETE);\n        }\n\n        // remove tag\n        if (this.tags && this.tags.has(changeTree)) {\n            const tags = this.tags.get(changeTree);\n            if (tag === undefined) {\n                // delete all tags\n                this.tags.delete(changeTree);\n            } else {\n                // delete specific tag\n                tags.delete(tag);\n\n                // if tag set is empty, delete it entirely\n                if (tags.size === 0) {\n                    this.tags.delete(changeTree);\n                }\n            }\n        }\n\n        return this;\n    }\n\n    has(obj: Ref) {\n        return this.visible.has(obj[$changes]);\n    }\n\n    hasTag(ob: Ref, tag: number = DEFAULT_VIEW_TAG) {\n        const tags = this.tags?.get(ob[$changes]);\n        return tags?.has(tag) ?? false;\n    }\n\n    clear() {\n        if (!this.iterable) {\n            throw new Error(\"StateView#clear() is only available for iterable StateView's. Use StateView(iterable: true) constructor.\");\n        }\n\n        for (let i = 0, l = this.items.length; i < l; i++) {\n            this.remove(this.items[i], DEFAULT_VIEW_TAG, true);\n        }\n\n        // clear items array\n        this.items.length = 0;\n    }\n}\n"]}
+{"version":3,"file":"StateView.js","sourceRoot":"","sources":["../../src/encoder/StateView.ts"],"names":[],"mappings":";;;AAOA,gCAEC;AARD,8CAAuF;AACvF,gDAAkD;AAClD,2CAA6C;AAC7C,0CAAuC;AACvC,0CAA2C;AAE3C,SAAgB,UAAU,CAAC,WAAoB,KAAK;IAChD,OAAO,IAAI,SAAS,CAAC,QAAQ,CAAC,CAAC;AACnC,CAAC;AAED,MAAa,SAAS;IAyBlB,YAAmB,WAAoB,KAAK;QAAzB,aAAQ,GAAR,QAAQ,CAAiB;QAlB5C;;WAEG;QACH,YAAO,GAAwB,IAAI,OAAO,EAAc,CAAC;QAEzD;;WAEG;QACH,cAAS,GAAwB,IAAI,OAAO,EAAc,CAAC;QAI3D;;;WAGG;QACH,YAAO,GAAG,IAAI,GAAG,EAA6B,CAAC;QAG3C,IAAI,QAAQ,EAAE,CAAC;YACX,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QACpB,CAAC;IACL,CAAC;IAED,2CAA2C;IAC3C,GAAG,CAAC,GAAQ,EAAE,MAAc,8BAAgB,EAAE,qBAA8B,IAAI;QAC5E,MAAM,UAAU,GAAe,GAAG,EAAE,CAAC,kBAAQ,CAAC,CAAC;QAE/C,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,OAAO,CAAC,IAAI,CAAC,kCAAkC,EAAE,GAAG,CAAC,CAAC;YACtD,OAAO,IAAI,CAAC;QAEhB,CAAC;aAAM,IACH,CAAC,UAAU,CAAC,MAAM;YAClB,UAAU,CAAC,KAAK,KAAK,CAAC,CAAC,oBAAoB;UAC7C,CAAC;YACC;;;;;;eAMG;YACH,MAAM,IAAI,KAAK,CACX,6EAA6E,UAAU,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,mDAAmD,CAClK,CAAC;QACN,CAAC;QAED,oDAAoD;QACpD,MAAM,QAAQ,GAAa,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC5D,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAE7B,yDAAyD;QACzD,IAAI,IAAI,CAAC,QAAQ,IAAI,kBAAkB,EAAE,CAAC;YACtC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;QAED,0BAA0B;QAC1B,qCAAqC;QACrC,uCAAuC;QACvC,IAAI,kBAAkB,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;YAC1C,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QACtC,CAAC;QAED,EAAE;QACF,gEAAgE;QAChE,6CAA6C;QAC7C,EAAE;QACF,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACjD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAChD,CAAC;QAED,UAAU;QACV,IAAI,GAAG,KAAK,8BAAgB,EAAE,CAAC;YAC3B,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gBACb,IAAI,CAAC,IAAI,GAAG,IAAI,OAAO,EAA2B,CAAC;YACvD,CAAC;YACD,IAAI,IAAiB,CAAC;YACtB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC7B,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;gBACzB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YACpC,CAAC;iBAAM,CAAC;gBACJ,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACrC,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAEd,6BAA6B;YAC7B,QAAQ,EAAE,CAAC,gCAAsB,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBACzD,IAAI,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,gBAAS,CAAC,MAAM,EAAE,CAAC;oBACnD,OAAO,CAAC,KAAK,CAAC,GAAG,gBAAS,CAAC,GAAG,CAAC;gBACnC,CAAC;YACL,CAAC,CAAC,CAAC;QAEP,CAAC;aAAM,CAAC;YACJ,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACnD,MAAM,SAAS,GAAG,CAAC,UAAU,CAAC,eAAe,KAAK,SAAS,CAAC;gBACxD,CAAC,CAAC,UAAU,CAAC,kBAAkB;gBAC/B,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC;YAE5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC9D,MAAM,KAAK,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;gBACtC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;oBAAC,SAAS;gBAAC,CAAC,CAAC,2BAA2B;gBAElE,MAAM,EAAE,GAAG,UAAU,CAAC,iBAAiB,CAAC,KAAK,CAAC,IAAI,gBAAS,CAAC,GAAG,CAAC;gBAChE,MAAM,UAAU,GAAG,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC;gBACzC,IACI,CAAC,UAAU,CAAC,KAAK,IAAI,+FAA+F;oBACpH,CACI,WAAW,IAAI,8BAA8B;wBAC7C,UAAU,KAAK,SAAS,IAAI,2BAA2B;wBACvD,UAAU,KAAK,GAAG,CAAC,kBAAkB;qBACxC;oBACD,EAAE,KAAK,gBAAS,CAAC,MAAM,EACzB,CAAC;oBACC,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;gBACxB,CAAC;YACL,CAAC;QACL,CAAC;QAED,+CAA+C;QAC/C,UAAU,CAAC,YAAY,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YACtC,mDAAmD;YACnD,IACI,QAAQ;gBACR,QAAQ,CAAC,KAAK,CAAC,CAAC,GAAG,KAAK,SAAS;gBACjC,QAAQ,CAAC,KAAK,CAAC,CAAC,GAAG,KAAK,GAAG,EAC7B,CAAC;gBACC,OAAO;YACX,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IAChB,CAAC;IAES,WAAW,CAAC,eAA2B,EAAE,GAAW;QAC1D,MAAM,UAAU,GAAG,eAAe,CAAC,MAAM,CAAC,kBAAQ,CAAC,CAAC;QACpD,MAAM,WAAW,GAAG,eAAe,CAAC,WAAW,CAAC;QAEhD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YAChC,8CAA8C;YAC9C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAE7B,sBAAsB;YACtB,MAAM,gBAAgB,GAAe,UAAU,CAAC,MAAM,EAAE,CAAC,kBAAQ,CAAC,CAAC;YACnE,IAAI,gBAAgB,IAAI,CAAC,gBAAgB,CAAC,eAAe,KAAK,SAAS,CAAC,EAAE,CAAC;gBACvE,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;YACtC,CAAC;YAED,qDAAqD;YACrD,mDAAmD;QACvD,CAAC;QAED,8BAA8B;QAC9B,IAAI,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,KAAK,gBAAS,CAAC,MAAM,EAAE,CAAC;YACzD,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACjD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBACxB,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YAChD,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gBACb,IAAI,CAAC,IAAI,GAAG,IAAI,OAAO,EAA2B,CAAC;YACvD,CAAC;YAED,IAAI,IAAiB,CAAC;YACtB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC7B,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;gBACzB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YACpC,CAAC;iBAAM,CAAC;gBACJ,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACrC,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAEd,OAAO,CAAC,WAAW,CAAC,GAAG,gBAAS,CAAC,GAAG,CAAC;QACzC,CAAC;IACL,CAAC;IAID,MAAM,CAAC,GAAQ,EAAE,MAAc,8BAAgB,EAAE,WAAoB,KAAK;QACtE,MAAM,UAAU,GAAe,GAAG,CAAC,kBAAQ,CAAC,CAAC;QAC7C,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,GAAG,CAAC,CAAC;YACzD,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAEhC,4BAA4B;QAC5B,IACI,IAAI,CAAC,QAAQ;YACb,CAAC,QAAQ,CAAC,mEAAmE;UAC/E,CAAC;YACC,IAAA,iBAAS,EAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QACnD,CAAC;QAED,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC;QAC3B,MAAM,QAAQ,GAAa,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,6CAA6C;QAE1G,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACjD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAChD,CAAC;QAED,IAAI,GAAG,KAAK,8BAAgB,EAAE,CAAC;YAC3B,mCAAmC;YACnC,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;YACjC,IAAI,CAAC,mBAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;gBACpC,MAAM,gBAAgB,GAAG,MAAM,CAAC,kBAAQ,CAAC,CAAC;gBAC1C,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;gBACvD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;oBACxB,OAAO,GAAG,EAAE,CAAC;oBACb,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;gBACtD,CAAC;gBACD,4BAA4B;gBAC5B,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,gBAAS,CAAC,MAAM,CAAC;YAEvD,CAAC;iBAAM,CAAC;gBACJ,kCAAkC;gBAClC,QAAQ,EAAE,CAAC,2BAAiB,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAC5C,OAAO,CAAC,KAAK,CAAC,GAAG,gBAAS,CAAC,MAAM,CAAC,CAAC;YAC3C,CAAC;QAGL,CAAC;aAAM,CAAC;YACJ,gCAAgC;YAChC,QAAQ,EAAE,CAAC,gCAAsB,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CACtD,OAAO,CAAC,KAAK,CAAC,GAAG,gBAAS,CAAC,MAAM,CAAC,CAAC;QAC3C,CAAC;QAED,aAAa;QACb,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACvC,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;gBACpB,kBAAkB;gBAClB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACjC,CAAC;iBAAM,CAAC;gBACJ,sBAAsB;gBACtB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBAEjB,0CAA0C;gBAC1C,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;oBAClB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;gBACjC,CAAC;YACL,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,GAAG,CAAC,GAAQ;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,kBAAQ,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED,MAAM,CAAC,EAAO,EAAE,MAAc,8BAAgB;QAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,kBAAQ,CAAC,CAAC,CAAC;QAC1C,OAAO,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC;IACnC,CAAC;IAED,KAAK;QACD,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,0GAA0G,CAAC,CAAC;QAChI,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAChD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,8BAAgB,EAAE,IAAI,CAAC,CAAC;QACvD,CAAC;QAED,oBAAoB;QACpB,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IAC1B,CAAC;CACJ;AA1RD,8BA0RC","sourcesContent":["import { ChangeSet, ChangeTree, IndexedOperations, Ref } from \"./ChangeTree\";\nimport { $changes, $fieldIndexesByViewTag, $viewFieldIndexes } from \"../types/symbols\";\nimport { DEFAULT_VIEW_TAG } from \"../annotations\";\nimport { OPERATION } from \"../encoding/spec\";\nimport { Metadata } from \"../Metadata\";\nimport { spliceOne } from \"../types/utils\";\n\nexport function createView(iterable: boolean = false) {\n    return new StateView(iterable);\n}\n\nexport class StateView {\n    /**\n     * Iterable list of items that are visible to this view\n     * (Available only if constructed with `iterable: true`)\n     */\n    items: Ref[];\n\n    /**\n     * List of ChangeTree's that are visible to this view\n     */\n    visible: WeakSet<ChangeTree> = new WeakSet<ChangeTree>();\n\n    /**\n     * List of ChangeTree's that are invisible to this view\n     */\n    invisible: WeakSet<ChangeTree> = new WeakSet<ChangeTree>();\n\n    tags?: WeakMap<ChangeTree, Set<number>>; // TODO: use bit manipulation instead of Set<number> ()\n\n    /**\n     * Manual \"ADD\" operations for changes per ChangeTree, specific to this view.\n     * (This is used to force encoding a property, even if it was not changed)\n     */\n    changes = new Map<number, IndexedOperations>();\n\n    constructor(public iterable: boolean = false) {\n        if (iterable) {\n            this.items = [];\n        }\n    }\n\n    // TODO: allow to set multiple tags at once\n    add(obj: Ref, tag: number = DEFAULT_VIEW_TAG, checkIncludeParent: boolean = true) {\n        const changeTree: ChangeTree = obj?.[$changes];\n\n        if (!changeTree) {\n            console.warn(\"StateView#add(), invalid object:\", obj);\n            return this;\n\n        } else if (\n            !changeTree.parent &&\n            changeTree.refId !== 0 // allow root object\n        ) {\n            /**\n             * TODO: can we avoid this?\n             *\n             * When the \"parent\" structure has the @view() tag, it is currently\n             * not possible to identify it has to be added to the view as well\n             * (this.addParentOf() is not called).\n             */\n            throw new Error(\n                `Cannot add a detached instance to the StateView. Make sure to assign the \"${changeTree.ref.constructor.name}\" instance to the state before calling view.add()`\n            );\n        }\n\n        // FIXME: ArraySchema/MapSchema do not have metadata\n        const metadata: Metadata = obj.constructor[Symbol.metadata];\n        this.visible.add(changeTree);\n\n        // add to iterable list (only the explicitly added items)\n        if (this.iterable && checkIncludeParent) {\n            this.items.push(obj);\n        }\n\n        // add parent ChangeTree's\n        // - if it was invisible to this view\n        // - if it were previously filtered out\n        if (checkIncludeParent && changeTree.parent) {\n            this.addParentOf(changeTree, tag);\n        }\n\n        //\n        // TODO: when adding an item of a MapSchema, the changes may not\n        // be set (only the parent's changes are set)\n        //\n        let changes = this.changes.get(changeTree.refId);\n        if (changes === undefined) {\n            changes = {};\n            this.changes.set(changeTree.refId, changes);\n        }\n\n        // set tag\n        if (tag !== DEFAULT_VIEW_TAG) {\n            if (!this.tags) {\n                this.tags = new WeakMap<ChangeTree, Set<number>>();\n            }\n            let tags: Set<number>;\n            if (!this.tags.has(changeTree)) {\n                tags = new Set<number>();\n                this.tags.set(changeTree, tags);\n            } else {\n                tags = this.tags.get(changeTree);\n            }\n            tags.add(tag);\n\n            // Ref: add tagged properties\n            metadata?.[$fieldIndexesByViewTag]?.[tag]?.forEach((index) => {\n                if (changeTree.getChange(index) !== OPERATION.DELETE) {\n                    changes[index] = OPERATION.ADD;\n                }\n            });\n\n        } else {\n            const isInvisible = this.invisible.has(changeTree);\n            const changeSet = (changeTree.filteredChanges !== undefined)\n                ? changeTree.allFilteredChanges\n                : changeTree.allChanges;\n\n            for (let i = 0, len = changeSet.operations.length; i < len; i++) {\n                const index = changeSet.operations[i];\n                if (index === undefined) { continue; } // skip \"undefined\" indexes\n\n                const op = changeTree.indexedOperations[index] ?? OPERATION.ADD;\n                const tagAtIndex = metadata?.[index].tag;\n                if (\n                    !changeTree.isNew && // new structures will be added as part of .encode() call, no need to force it to .encodeView()\n                    (\n                        isInvisible || // if \"invisible\", include all\n                        tagAtIndex === undefined || // \"all change\" with no tag\n                        tagAtIndex === tag // tagged property\n                    ) &&\n                    op !== OPERATION.DELETE\n                ) {\n                    changes[index] = op;\n                }\n            }\n        }\n\n        // Add children of this ChangeTree to this view\n        changeTree.forEachChild((change, index) => {\n            // Do not ADD children that don't have the same tag\n            if (\n                metadata &&\n                metadata[index].tag !== undefined &&\n                metadata[index].tag !== tag\n            ) {\n                return;\n            }\n            this.add(change.ref, tag, false);\n        });\n\n        return this;\n    }\n\n    protected addParentOf(childChangeTree: ChangeTree, tag: number) {\n        const changeTree = childChangeTree.parent[$changes];\n        const parentIndex = childChangeTree.parentIndex;\n\n        if (!this.visible.has(changeTree)) {\n            // view must have all \"changeTree\" parent tree\n            this.visible.add(changeTree);\n\n            // add parent's parent\n            const parentChangeTree: ChangeTree = changeTree.parent?.[$changes];\n            if (parentChangeTree && (parentChangeTree.filteredChanges !== undefined)) {\n                this.addParentOf(changeTree, tag);\n            }\n\n            // // parent is already available, no need to add it!\n            // if (!this.invisible.has(changeTree)) { return; }\n        }\n\n        // add parent's tag properties\n        if (changeTree.getChange(parentIndex) !== OPERATION.DELETE) {\n            let changes = this.changes.get(changeTree.refId);\n            if (changes === undefined) {\n                changes = {};\n                this.changes.set(changeTree.refId, changes);\n            }\n\n            if (!this.tags) {\n                this.tags = new WeakMap<ChangeTree, Set<number>>();\n            }\n\n            let tags: Set<number>;\n            if (!this.tags.has(changeTree)) {\n                tags = new Set<number>();\n                this.tags.set(changeTree, tags);\n            } else {\n                tags = this.tags.get(changeTree);\n            }\n            tags.add(tag);\n\n            changes[parentIndex] = OPERATION.ADD;\n        }\n    }\n\n    remove(obj: Ref, tag?: number): this; // hide _isClear parameter from public API\n    remove(obj: Ref, tag?: number, _isClear?: boolean): this;\n    remove(obj: Ref, tag: number = DEFAULT_VIEW_TAG, _isClear: boolean = false): this {\n        const changeTree: ChangeTree = obj[$changes];\n        if (!changeTree) {\n            console.warn(\"StateView#remove(), invalid object:\", obj);\n            return this;\n        }\n\n        this.visible.delete(changeTree);\n\n        // remove from iterable list\n        if (\n            this.iterable &&\n            !_isClear // no need to remove during clear(), as it will be cleared entirely\n        ) {\n            spliceOne(this.items, this.items.indexOf(obj));\n        }\n\n        const ref = changeTree.ref;\n        const metadata: Metadata = ref.constructor[Symbol.metadata]; // ArraySchema/MapSchema do not have metadata\n\n        let changes = this.changes.get(changeTree.refId);\n        if (changes === undefined) {\n            changes = {};\n            this.changes.set(changeTree.refId, changes);\n        }\n\n        if (tag === DEFAULT_VIEW_TAG) {\n            // parent is collection (Map/Array)\n            const parent = changeTree.parent;\n            if (!Metadata.isValidInstance(parent)) {\n                const parentChangeTree = parent[$changes];\n                let changes = this.changes.get(parentChangeTree.refId);\n                if (changes === undefined) {\n                    changes = {};\n                    this.changes.set(parentChangeTree.refId, changes);\n                }\n                // DELETE / DELETE BY REF ID\n                changes[changeTree.parentIndex] = OPERATION.DELETE;\n\n            } else {\n                // delete all \"tagged\" properties.\n                metadata?.[$viewFieldIndexes].forEach((index) =>\n                    changes[index] = OPERATION.DELETE);\n            }\n\n\n        } else {\n            // delete only tagged properties\n            metadata?.[$fieldIndexesByViewTag][tag].forEach((index) =>\n                changes[index] = OPERATION.DELETE);\n        }\n\n        // remove tag\n        if (this.tags && this.tags.has(changeTree)) {\n            const tags = this.tags.get(changeTree);\n            if (tag === undefined) {\n                // delete all tags\n                this.tags.delete(changeTree);\n            } else {\n                // delete specific tag\n                tags.delete(tag);\n\n                // if tag set is empty, delete it entirely\n                if (tags.size === 0) {\n                    this.tags.delete(changeTree);\n                }\n            }\n        }\n\n        return this;\n    }\n\n    has(obj: Ref) {\n        return this.visible.has(obj[$changes]);\n    }\n\n    hasTag(ob: Ref, tag: number = DEFAULT_VIEW_TAG) {\n        const tags = this.tags?.get(ob[$changes]);\n        return tags?.has(tag) ?? false;\n    }\n\n    clear() {\n        if (!this.iterable) {\n            throw new Error(\"StateView#clear() is only available for iterable StateView's. Use StateView(iterable: true) constructor.\");\n        }\n\n        for (let i = 0, l = this.items.length; i < l; i++) {\n            this.remove(this.items[i], DEFAULT_VIEW_TAG, true);\n        }\n\n        // clear items array\n        this.items.length = 0;\n    }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@colyseus/schema",
-  "version": "3.0.23",
+  "version": "3.0.24",
   "description": "Binary state serializer with delta encoding for games",
   "bin": {
     "schema-codegen": "./bin/schema-codegen",

package/src/encoder/StateView.ts

@@ -42,14 +42,30 @@ export class StateView {
 
     // TODO: allow to set multiple tags at once
     add(obj: Ref, tag: number = DEFAULT_VIEW_TAG, checkIncludeParent: boolean = true) {
-        if (!obj?.[$changes]) {
+        const changeTree: ChangeTree = obj?.[$changes];
+
+        if (!changeTree) {
             console.warn("StateView#add(), invalid object:", obj);
             return this;
+
+        } else if (
+            !changeTree.parent &&
+            changeTree.refId !== 0 // allow root object
+        ) {
+            /**
+             * TODO: can we avoid this?
+             *
+             * When the "parent" structure has the @view() tag, it is currently
+             * not possible to identify it has to be added to the view as well
+             * (this.addParentOf() is not called).
+             */
+            throw new Error(
+                `Cannot add a detached instance to the StateView. Make sure to assign the "${changeTree.ref.constructor.name}" instance to the state before calling view.add()`
+            );
         }
 
         // FIXME: ArraySchema/MapSchema do not have metadata
         const metadata: Metadata = obj.constructor[Symbol.metadata];
-        const changeTree: ChangeTree = obj[$changes];
         this.visible.add(changeTree);
 
         // add to iterable list (only the explicitly added items)