@colyseus/schema 3.0.22 → 3.0.24

package/build/esm/index.mjs

@@ -1829,7 +1829,7 @@ class ArraySchema {
         return (!view ||
             typeof (ref[$childType]) === "string" ||
             // view.items.has(ref[$getByIndex](index)[$changes])
-            view.items.has(ref['tmpItems'][index]?.[$changes]));
+            view.visible.has(ref['tmpItems'][index]?.[$changes]));
     }
     static is(type) {
         return (
@@ -2485,7 +2485,7 @@ class MapSchema {
     static [(_a$3 = $encoder, _b$3 = $decoder, $filter)](ref, index, view) {
         return (!view ||
             typeof (ref[$childType]) === "string" ||
-            view.items.has((ref[$getByIndex](index) ?? ref.deletedItems[index])[$changes]));
+            view.visible.has((ref[$getByIndex](index) ?? ref.deletedItems[index])[$changes]));
     }
     static is(type) {
         return type['map'] !== undefined;
@@ -3102,7 +3102,7 @@ class Schema {
         }
         else if (tag === DEFAULT_VIEW_TAG) {
             // view pass: default tag
-            return view.items.has(ref[$changes]);
+            return view.visible.has(ref[$changes]);
         }
         else {
             // view pass: custom tag
@@ -3315,7 +3315,7 @@ class CollectionSchema {
     static [(_a$1 = $encoder, _b$1 = $decoder, $filter)](ref, index, view) {
         return (!view ||
             typeof (ref[$childType]) === "string" ||
-            view.items.has((ref[$getByIndex](index) ?? ref.deletedItems[index])[$changes]));
+            view.visible.has((ref[$getByIndex](index) ?? ref.deletedItems[index])[$changes]));
     }
     static is(type) {
         return type['collection'] !== undefined;
@@ -3475,7 +3475,7 @@ class SetSchema {
     static [(_a = $encoder, _b = $decoder, $filter)](ref, index, view) {
         return (!view ||
             typeof (ref[$childType]) === "string" ||
-            view.items.has((ref[$getByIndex](index) ?? ref.deletedItems[index])[$changes]));
+            view.visible.has((ref[$getByIndex](index) ?? ref.deletedItems[index])[$changes]));
     }
     static is(type) {
         return type['set'] !== undefined;
@@ -3795,7 +3795,7 @@ class Encoder {
         for (let i = 0, numChangeTrees = changeTrees.length; i < numChangeTrees; i++) {
             const changeTree = changeTrees[i];
             if (hasView) {
-                if (!view.items.has(changeTree)) {
+                if (!view.visible.has(changeTree)) {
                     view.invisible.add(changeTree);
                     continue; // skip this change tree
                 }
@@ -4711,11 +4711,12 @@ function getRawChangesCallback(decoder, callback) {
 }
 
 class StateView {
-    constructor() {
+    constructor(iterable = false) {
+        this.iterable = iterable;
         /**
          * List of ChangeTree's that are visible to this view
          */
-        this.items = new WeakSet();
+        this.visible = new WeakSet();
         /**
          * List of ChangeTree's that are invisible to this view
          */
@@ -4725,17 +4726,36 @@ class StateView {
          * (This is used to force encoding a property, even if it was not changed)
          */
         this.changes = new Map();
+        if (iterable) {
+            this.items = [];
+        }
     }
     // 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.items.add(changeTree);
+        this.visible.add(changeTree);
+        // add to iterable list (only the explicitly added items)
+        if (this.iterable && checkIncludeParent) {
+            this.items.push(obj);
+        }
         // add parent ChangeTree's
         // - if it was invisible to this view
         // - if it were previously filtered out
@@ -4809,9 +4829,9 @@ class StateView {
     addParentOf(childChangeTree, tag) {
         const changeTree = childChangeTree.parent[$changes];
         const parentIndex = childChangeTree.parentIndex;
-        if (!this.items.has(changeTree)) {
+        if (!this.visible.has(changeTree)) {
             // view must have all "changeTree" parent tree
-            this.items.add(changeTree);
+            this.visible.add(changeTree);
             // add parent's parent
             const parentChangeTree = changeTree.parent?.[$changes];
             if (parentChangeTree && (parentChangeTree.filteredChanges !== undefined)) {
@@ -4842,13 +4862,19 @@ class StateView {
             changes[parentIndex] = OPERATION.ADD;
         }
     }
-    remove(obj, tag = DEFAULT_VIEW_TAG) {
+    remove(obj, tag = DEFAULT_VIEW_TAG, _isClear = false) {
         const changeTree = obj[$changes];
         if (!changeTree) {
             console.warn("StateView#remove(), invalid object:", obj);
             return this;
         }
-        this.items.delete(changeTree);
+        this.visible.delete(changeTree);
+        // remove from iterable list
+        if (this.iterable &&
+            !_isClear // no need to remove during clear(), as it will be cleared entirely
+        ) {
+            spliceOne(this.items, this.items.indexOf(obj));
+        }
         const ref = changeTree.ref;
         const metadata = ref.constructor[Symbol.metadata]; // ArraySchema/MapSchema do not have metadata
         let changes = this.changes.get(changeTree.refId);
@@ -4897,12 +4923,22 @@ class StateView {
         return this;
     }
     has(obj) {
-        return this.items.has(obj[$changes]);
+        return this.visible.has(obj[$changes]);
     }
     hasTag(ob, tag = DEFAULT_VIEW_TAG) {
         const tags = this.tags?.get(ob[$changes]);
         return tags?.has(tag) ?? false;
     }
+    clear() {
+        if (!this.iterable) {
+            throw new Error("StateView#clear() is only available for iterable StateView's. Use StateView(iterable: true) constructor.");
+        }
+        for (let i = 0, l = this.items.length; i < l; i++) {
+            this.remove(this.items[i], DEFAULT_VIEW_TAG, true);
+        }
+        // clear items array
+        this.items.length = 0;
+    }
 }
 
 registerType("map", { constructor: MapSchema });