@colyseus/schema 4.0.29 → 4.0.31

package/build/encoder/ChangeTree.d.ts

@@ -110,6 +110,15 @@ export declare class ChangeTree<T extends Ref = any> {
      * Add a parent to the chain
      */
     addParent(parent: Ref, index: number): void;
+    /**
+     * Move `parent`'s existing chain entry to `index`, skipping the work
+     * `addParent` does. `parent` must already be a parent of this tree.
+     *
+     * Called by collections whose wire slots shift (ArraySchema): StateView
+     * addresses per-view ADD/DELETE by that index, so it has to follow the
+     * element it names.
+     */
+    setParentIndex(parent: Ref, index: number): void;
     /**
      * Remove a parent from the chain
      * @param parent - The parent to remove

package/build/index.cjs

@@ -1452,6 +1452,33 @@ class ChangeTree {
             next: this.parentChain
         };
     }
+    /**
+     * Move `parent`'s existing chain entry to `index`, skipping the work
+     * `addParent` does. `parent` must already be a parent of this tree.
+     *
+     * Called by collections whose wire slots shift (ArraySchema): StateView
+     * addresses per-view ADD/DELETE by that index, so it has to follow the
+     * element it names.
+     */
+    setParentIndex(parent, index) {
+        const chain = this.parentChain;
+        if (chain === undefined) {
+            return;
+        }
+        if (chain.next === undefined) {
+            chain.index = index; // sole parent, so it is `parent`
+            return;
+        }
+        // Shared instance — move only the entry `parent` owns. Matching goes
+        // through `$changes` because ArraySchema arrives proxied (see
+        // removeParent below).
+        for (let entry = chain; entry !== undefined; entry = entry.next) {
+            if (entry.ref[$changes] === parent[$changes]) {
+                entry.index = index;
+                return;
+            }
+        }
+    }
     /**
      * Remove a parent from the chain
      * @param parent - The parent to remove
@@ -2088,6 +2115,39 @@ class ArraySchema {
     get length() {
         return this.items.length;
     }
+    /**
+     * Re-point children at their wire slot. `ChangeTree.parentIndex` caches
+     * the slot a child holds in `tmpItems`, and StateView addresses per-view
+     * ADD/DELETE with it — so a reorder that leaves it behind aims those ops
+     * at whichever element inherited the slot (issue #231).
+     *
+     * The filter check is a correctness boundary, not a tunable: StateView is
+     * the only reader, and an array without `filteredChanges` never has a slot
+     * read back. Everything else stops at that check instead of walking its
+     * children every tick.
+     *
+     * Callers name the lowest slot that moved as `from`. Compaction cannot, so
+     * it hands over the pre-compaction layout as `staged` and the unchanged
+     * prefix is skipped instead. Either way tail churn walks nothing.
+     */
+    $reindexChildren(from, staged) {
+        if (this[$changes].filteredChanges === undefined) {
+            return;
+        } // nothing will read the cache
+        if (typeof this[$childType] === "string") {
+            return;
+        } // primitives have no child tree
+        const tmpItems = this.tmpItems;
+        const length = tmpItems.length;
+        if (staged !== undefined) {
+            while (from < length && tmpItems[from] === staged[from]) {
+                from++;
+            }
+        }
+        for (let i = from; i < length; i++) {
+            tmpItems[i]?.[$changes]?.setParentIndex(this, i);
+        }
+    }
     push(...values) {
         let length = this.tmpItems.length;
         const changeTree = this[$changes];
@@ -2220,6 +2280,7 @@ class ArraySchema {
         this[$changes].operation(exports.OPERATION.REVERSE);
         this.items.reverse();
         this.tmpItems.reverse();
+        this.$reindexChildren(0);
         return this;
     }
     /**
@@ -2263,6 +2324,7 @@ class ArraySchema {
         // wouldn't OPERATION.MOVE make more sense here?
         sortedItems.forEach((_, i) => changeTree.change(i, exports.OPERATION.REPLACE));
         this.tmpItems.sort(compareFn);
+        this.$reindexChildren(0);
         this.isMovingItems = false;
         return this;
     }
@@ -2358,6 +2420,7 @@ class ArraySchema {
             changeTree.change(index, exports.OPERATION.ADD);
         });
         this.tmpItems.unshift(...items);
+        this.$reindexChildren(0); // from 0: nothing above placed the new items either
         return this.items.unshift(...items);
     }
     /**
@@ -2629,7 +2692,13 @@ class ArraySchema {
         this.tmpItems[index] = undefined; // TODO: do not try to get "tmpItems" at decoding time.
     }
     [$onEncodeEnd]() {
+        const staged = this.tmpItems;
         this.tmpItems = this.items.slice();
+        // Compaction just closed the staged holes — everything above the
+        // lowest one slid down a slot. There is no cheap "were there any"
+        // test to gate this on: `deletedIndexes` is an object here, and a
+        // `for...in` probe measured slower than the prefix scan it skips.
+        this.$reindexChildren(0, staged);
         this.deletedIndexes = {};
     }
     [$onDecodeEnd]() {
@@ -2779,6 +2848,37 @@ class MapSchema {
     get(key) {
         return this.$items.get(key);
     }
+    /**
+     * Returns the value for `key` if present. Otherwise inserts `defaultValue`
+     * (tracked as an ADD change, like `set()`) and returns it.
+     *
+     * Mirrors `Map.prototype.getOrInsert` (TC39 "upsert" proposal, typed in
+     * TypeScript 6's standard library).
+     */
+    getOrInsert(key, defaultValue) {
+        if (this.$items.has(key)) {
+            return this.$items.get(key);
+        }
+        this.set(key, defaultValue);
+        return defaultValue;
+    }
+    /**
+     * Returns the value for `key` if present. Otherwise computes a value via
+     * `callbackfn(key)`, inserts it (tracked as an ADD change, like `set()`)
+     * and returns it. The callback is only invoked when the key is missing.
+     *
+     * Mirrors `Map.prototype.getOrInsertComputed` (TC39 "upsert" proposal,
+     * typed in TypeScript 6's standard library).
+     */
+    getOrInsertComputed(key, callbackfn) {
+        if (this.$items.has(key)) {
+            return this.$items.get(key);
+        }
+        const value = callbackfn(key);
+        // per spec: overwrites even if callbackfn itself inserted `key`
+        this.set(key, value);
+        return value;
+    }
     delete(key) {
         if (!this.$items.has(key)) {
             return false;