@colyseus/schema 4.0.0 → 4.0.2

package/lib/src/decoder/DecodeOperation.js

@@ -0,0 +1,248 @@
+import { OPERATION } from "../encoding/spec";
+import { Schema } from "../Schema";
+import { decode } from "../encoding/decode";
+import { $childType, $deleteByIndex, $getByIndex, $refId } from "../types/symbols";
+import { getType } from "../types/registry";
+export const DEFINITION_MISMATCH = -1;
+export function decodeValue(decoder, operation, ref, index, type, bytes, it, allChanges) {
+    const $root = decoder.root;
+    const previousValue = ref[$getByIndex](index);
+    let value;
+    if ((operation & OPERATION.DELETE) === OPERATION.DELETE) {
+        // Flag `refId` for garbage collection.
+        const previousRefId = previousValue?.[$refId];
+        if (previousRefId !== undefined) {
+            $root.removeRef(previousRefId);
+        }
+        //
+        // Delete operations
+        //
+        if (operation !== OPERATION.DELETE_AND_ADD) {
+            ref[$deleteByIndex](index);
+        }
+        value = undefined;
+    }
+    if (operation === OPERATION.DELETE) {
+        //
+        // Don't do anything
+        //
+    }
+    else if (Schema.is(type)) {
+        const refId = decode.number(bytes, it);
+        value = $root.refs.get(refId);
+        if ((operation & OPERATION.ADD) === OPERATION.ADD) {
+            const childType = decoder.getInstanceType(bytes, it, type);
+            if (!value) {
+                value = decoder.createInstanceOfType(childType);
+            }
+            $root.addRef(refId, value, (value !== previousValue || // increment ref count if value has changed
+                (operation === OPERATION.DELETE_AND_ADD && value === previousValue) // increment ref count if the same instance is being added again
+            ));
+        }
+    }
+    else if (typeof (type) === "string") {
+        //
+        // primitive value (number, string, boolean, etc)
+        //
+        value = decode[type](bytes, it);
+    }
+    else {
+        const typeDef = getType(Object.keys(type)[0]);
+        const refId = decode.number(bytes, it);
+        const valueRef = ($root.refs.has(refId))
+            ? previousValue || $root.refs.get(refId)
+            : new typeDef.constructor();
+        value = valueRef.clone(true);
+        value[$childType] = Object.values(type)[0]; // cache childType for ArraySchema and MapSchema
+        if (previousValue) {
+            let previousRefId = previousValue[$refId];
+            if (previousRefId !== undefined && refId !== previousRefId) {
+                //
+                // enqueue onRemove if structure has been replaced.
+                //
+                const entries = previousValue.entries();
+                let iter;
+                while ((iter = entries.next()) && !iter.done) {
+                    const [key, value] = iter.value;
+                    // if value is a schema, remove its reference
+                    if (typeof (value) === "object") {
+                        previousRefId = value[$refId];
+                        $root.removeRef(previousRefId);
+                    }
+                    allChanges.push({
+                        ref: previousValue,
+                        refId: previousRefId,
+                        op: OPERATION.DELETE,
+                        field: key,
+                        value: undefined,
+                        previousValue: value,
+                    });
+                }
+            }
+        }
+        $root.addRef(refId, value, (valueRef !== previousValue ||
+            (operation === OPERATION.DELETE_AND_ADD && valueRef === previousValue)));
+    }
+    return { value, previousValue };
+}
+export const decodeSchemaOperation = function (decoder, bytes, it, ref, allChanges) {
+    const first_byte = bytes[it.offset++];
+    const metadata = ref.constructor[Symbol.metadata];
+    // "compressed" index + operation
+    const operation = (first_byte >> 6) << 6;
+    const index = first_byte % (operation || 255);
+    // skip early if field is not defined
+    const field = metadata[index];
+    if (field === undefined) {
+        console.warn("@colyseus/schema: field not defined at", { index, ref: ref.constructor.name, metadata });
+        return DEFINITION_MISMATCH;
+    }
+    const { value, previousValue } = decodeValue(decoder, operation, ref, index, field.type, bytes, it, allChanges);
+    if (value !== null && value !== undefined) {
+        ref[field.name] = value;
+    }
+    // add change
+    if (previousValue !== value) {
+        allChanges.push({
+            ref,
+            refId: decoder.currentRefId,
+            op: operation,
+            field: field.name,
+            value,
+            previousValue,
+        });
+    }
+};
+export const decodeKeyValueOperation = function (decoder, bytes, it, ref, allChanges) {
+    // "uncompressed" index + operation (array/map items)
+    const operation = bytes[it.offset++];
+    if (operation === OPERATION.CLEAR) {
+        //
+        // When decoding:
+        // - enqueue items for DELETE callback.
+        // - flag child items for garbage collection.
+        //
+        decoder.removeChildRefs(ref, allChanges);
+        ref.clear();
+        return;
+    }
+    const index = decode.number(bytes, it);
+    const type = ref[$childType];
+    let dynamicIndex;
+    if ((operation & OPERATION.ADD) === OPERATION.ADD) { // ADD or DELETE_AND_ADD
+        if (typeof (ref['set']) === "function") {
+            dynamicIndex = decode.string(bytes, it); // MapSchema
+            ref['setIndex'](index, dynamicIndex);
+        }
+        else {
+            dynamicIndex = index; // ArraySchema
+        }
+    }
+    else {
+        // get dynamic index from "ref"
+        dynamicIndex = ref['getIndex'](index);
+    }
+    const { value, previousValue } = decodeValue(decoder, operation, ref, index, type, bytes, it, allChanges);
+    if (value !== null && value !== undefined) {
+        if (typeof (ref['set']) === "function") {
+            // MapSchema
+            ref['$items'].set(dynamicIndex, value);
+        }
+        else if (typeof (ref['$setAt']) === "function") {
+            // ArraySchema
+            ref['$setAt'](index, value, operation);
+        }
+        else if (typeof (ref['add']) === "function") {
+            // CollectionSchema && SetSchema
+            const index = ref.add(value);
+            if (typeof (index) === "number") {
+                ref['setIndex'](index, index);
+            }
+        }
+    }
+    // add change
+    if (previousValue !== value) {
+        allChanges.push({
+            ref,
+            refId: decoder.currentRefId,
+            op: operation,
+            field: "", // FIXME: remove this
+            dynamicIndex,
+            value,
+            previousValue,
+        });
+    }
+};
+export const decodeArray = function (decoder, bytes, it, ref, allChanges) {
+    // "uncompressed" index + operation (array/map items)
+    let operation = bytes[it.offset++];
+    let index;
+    if (operation === OPERATION.CLEAR) {
+        //
+        // When decoding:
+        // - enqueue items for DELETE callback.
+        // - flag child items for garbage collection.
+        //
+        decoder.removeChildRefs(ref, allChanges);
+        ref.clear();
+        return;
+    }
+    else if (operation === OPERATION.REVERSE) {
+        ref.reverse();
+        return;
+    }
+    else if (operation === OPERATION.DELETE_BY_REFID) {
+        // TODO: refactor here, try to follow same flow as below
+        const refId = decode.number(bytes, it);
+        const previousValue = decoder.root.refs.get(refId);
+        index = ref.findIndex((value) => value === previousValue);
+        ref[$deleteByIndex](index);
+        allChanges.push({
+            ref,
+            refId: decoder.currentRefId,
+            op: OPERATION.DELETE,
+            field: "", // FIXME: remove this
+            dynamicIndex: index,
+            value: undefined,
+            previousValue,
+        });
+        return;
+    }
+    else if (operation === OPERATION.ADD_BY_REFID) {
+        const refId = decode.number(bytes, it);
+        const itemByRefId = decoder.root.refs.get(refId);
+        // if item already exists, use existing index
+        if (itemByRefId) {
+            index = ref.findIndex((value) => value === itemByRefId);
+        }
+        // fallback to use last index
+        if (index === -1 || index === undefined) {
+            index = ref.length;
+        }
+    }
+    else {
+        index = decode.number(bytes, it);
+    }
+    const type = ref[$childType];
+    let dynamicIndex = index;
+    const { value, previousValue } = decodeValue(decoder, operation, ref, index, type, bytes, it, allChanges);
+    if (value !== null && value !== undefined &&
+        value !== previousValue // avoid setting same value twice (if index === 0 it will result in a "unshift" for ArraySchema)
+    ) {
+        // ArraySchema
+        ref['$setAt'](index, value, operation);
+    }
+    // add change
+    if (previousValue !== value) {
+        allChanges.push({
+            ref,
+            refId: decoder.currentRefId,
+            op: operation,
+            field: "", // FIXME: remove this
+            dynamicIndex,
+            value,
+            previousValue,
+        });
+    }
+};
+//# sourceMappingURL=DecodeOperation.js.map

package/lib/src/decoder/DecodeOperation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DecodeOperation.js","sourceRoot":"","sources":["../../../src/decoder/DecodeOperation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE7C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAGnC,OAAO,EAAY,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAMnF,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAa5C,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,CAAC;AAUtC,MAAM,UAAU,WAAW,CACvB,OAAgB,EAChB,SAAoB,EACpB,GAAM,EACN,KAAa,EACb,IAAS,EACT,KAAiB,EACjB,EAAY,EACZ,UAAwB;IAExB,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAC3B,MAAM,aAAa,GAAI,GAAW,CAAC,WAAW,CAAC,CAAC,KAAK,CAAM,CAAC;IAE5D,IAAI,KAAU,CAAC;IAEf,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,KAAK,SAAS,CAAC,MAAM,EACvD,CAAC;QACG,uCAAuC;QACvC,MAAM,aAAa,GAAG,aAAa,EAAE,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAAC,KAAK,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAAC,CAAC;QAEpE,EAAE;QACF,oBAAoB;QACpB,EAAE;QACF,IAAI,SAAS,KAAK,SAAS,CAAC,cAAc,EAAE,CAAC;YACxC,GAAW,CAAC,cAAc,CAAC,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC;QAED,KAAK,GAAG,SAAS,CAAC;IACtB,CAAC;IAED,IAAI,SAAS,KAAK,SAAS,CAAC,MAAM,EAAE,CAAC;QACjC,EAAE;QACF,oBAAoB;QACpB,EAAE;IAEN,CAAC;SAAM,IAAI,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACvC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAE9B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,GAAG,EAAE,CAAC;YAChD,MAAM,SAAS,GAAG,OAAO,CAAC,eAAe,CAAC,KAAK,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;YAC3D,IAAI,CAAC,KAAK,EAAE,CAAC;gBACT,KAAK,GAAG,OAAO,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;YACpD,CAAC;YAED,KAAK,CAAC,MAAM,CACR,KAAK,EACL,KAAK,EACL,CACI,KAAK,KAAK,aAAa,IAAI,2CAA2C;gBACtE,CAAC,SAAS,KAAK,SAAS,CAAC,cAAc,IAAI,KAAK,KAAK,aAAa,CAAC,CAAC,gEAAgE;aACvI,CACJ,CAAC;QACN,CAAC;IAEL,CAAC;SAAM,IAAI,OAAM,CAAC,IAAI,CAAC,KAAK,QAAQ,EAAE,CAAC;QACnC,EAAE;QACF,iDAAiD;QACjD,EAAE;QACF,KAAK,GAAI,MAAc,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAE7C,CAAC;SAAM,CAAC;QACJ,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9C,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAEvC,MAAM,QAAQ,GAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACzC,CAAC,CAAC,aAAa,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;YACxC,CAAC,CAAC,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;QAEhC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC7B,KAAK,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,gDAAgD;QAE5F,IAAI,aAAa,EAAE,CAAC;YAChB,IAAI,aAAa,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;YAE1C,IAAI,aAAa,KAAK,SAAS,IAAI,KAAK,KAAK,aAAa,EAAE,CAAC;gBACzD,EAAE;gBACF,mDAAmD;gBACnD,EAAE;gBACF,MAAM,OAAO,GAAkC,aAAqB,CAAC,OAAO,EAAE,CAAC;gBAC/E,IAAI,IAAgC,CAAC;gBACrC,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;oBAC3C,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;oBAEhC,6CAA6C;oBAC7C,IAAI,OAAM,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,CAAC;wBAC7B,aAAa,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;wBAC9B,KAAK,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;oBACnC,CAAC;oBAED,UAAU,CAAC,IAAI,CAAC;wBACZ,GAAG,EAAE,aAAa;wBAClB,KAAK,EAAE,aAAa;wBACpB,EAAE,EAAE,SAAS,CAAC,MAAM;wBACpB,KAAK,EAAE,GAAG;wBACV,KAAK,EAAE,SAAS;wBAChB,aAAa,EAAE,KAAK;qBACvB,CAAC,CAAC;gBACP,CAAC;YAEL,CAAC;QACL,CAAC;QAED,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,CACvB,QAAQ,KAAK,aAAa;YAC1B,CAAC,SAAS,KAAK,SAAS,CAAC,cAAc,IAAI,QAAQ,KAAK,aAAa,CAAC,CACzE,CAAC,CAAC;IACP,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;AACpC,CAAC;AAED,MAAM,CAAC,MAAM,qBAAqB,GAAoB,UAClD,OAAqB,EACrB,KAAiB,EACjB,EAAY,EACZ,GAAM,EACN,UAAwB;IAExB,MAAM,UAAU,GAAG,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;IACtC,MAAM,QAAQ,GAAc,GAAG,CAAC,WAA6B,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAE/E,iCAAiC;IACjC,MAAM,SAAS,GAAG,CAAC,UAAU,IAAI,CAAC,CAAC,IAAI,CAAC,CAAA;IACxC,MAAM,KAAK,GAAG,UAAU,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,CAAC;IAE9C,qCAAqC;IACrC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC9B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACtB,OAAO,CAAC,IAAI,CAAC,wCAAwC,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QACvG,OAAO,mBAAmB,CAAC;IAC/B,CAAC;IAED,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,GAAG,WAAW,CACxC,OAAO,EACP,SAAS,EACT,GAAG,EACH,KAAK,EACL,KAAK,CAAC,IAAI,EACV,KAAK,EACL,EAAE,EACF,UAAU,CACb,CAAC;IAEF,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxC,GAAG,CAAC,KAAK,CAAC,IAAe,CAAC,GAAG,KAAK,CAAC;IACvC,CAAC;IAED,aAAa;IACb,IAAI,aAAa,KAAK,KAAK,EAAE,CAAC;QAC1B,UAAU,CAAC,IAAI,CAAC;YACZ,GAAG;YACH,KAAK,EAAE,OAAO,CAAC,YAAY;YAC3B,EAAE,EAAE,SAAS;YACb,KAAK,EAAE,KAAK,CAAC,IAAI;YACjB,KAAK;YACL,aAAa;SAChB,CAAC,CAAC;IACP,CAAC;AACL,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,uBAAuB,GAAoB,UACpD,OAAqB,EACrB,KAAiB,EACjB,EAAY,EACZ,GAAQ,EACR,UAAwB;IAExB,qDAAqD;IACrD,MAAM,SAAS,GAAG,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;IAErC,IAAI,SAAS,KAAK,SAAS,CAAC,KAAK,EAAE,CAAC;QAChC,EAAE;QACF,iBAAiB;QACjB,uCAAuC;QACvC,6CAA6C;QAC7C,EAAE;QACF,OAAO,CAAC,eAAe,CAAC,GAA4B,EAAE,UAAU,CAAC,CAAC;QAEjE,GAAW,CAAC,KAAK,EAAE,CAAC;QACrB,OAAO;IACX,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACvC,MAAM,IAAI,GAAI,GAAW,CAAC,UAAU,CAAC,CAAC;IAEtC,IAAI,YAA6B,CAAC;IAElC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,wBAAwB;QACzE,IAAI,OAAM,CAAE,GAAW,CAAC,KAAK,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC;YAC7C,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY;YACpD,GAAW,CAAC,UAAU,CAAC,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QAClD,CAAC;aAAM,CAAC;YACJ,YAAY,GAAG,KAAK,CAAC,CAAC,cAAc;QACxC,CAAC;IACL,CAAC;SAAM,CAAC;QACJ,+BAA+B;QAC/B,YAAY,GAAI,GAAW,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC;IACnD,CAAC;IAED,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,GAAG,WAAW,CACxC,OAAO,EACP,SAAS,EACT,GAAG,EACH,KAAK,EACL,IAAI,EACJ,KAAK,EACL,EAAE,EACF,UAAU,CACb,CAAC;IAEF,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxC,IAAI,OAAM,CAAE,GAAW,CAAC,KAAK,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC;YAC7C,YAAY;YACX,GAAW,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,YAAsB,EAAE,KAAK,CAAC,CAAC;QAE9D,CAAC;aAAM,IAAI,OAAM,CAAE,GAAW,CAAC,QAAQ,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC;YACvD,cAAc;YACb,GAAW,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;QAEpD,CAAC;aAAM,IAAI,OAAM,CAAE,GAAW,CAAC,KAAK,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC;YACpD,gCAAgC;YAChC,MAAM,KAAK,GAAI,GAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAEtC,IAAI,OAAM,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,CAAC;gBAC5B,GAAW,CAAC,UAAU,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YAC3C,CAAC;QACL,CAAC;IACL,CAAC;IAED,aAAa;IACb,IAAI,aAAa,KAAK,KAAK,EAAE,CAAC;QAC1B,UAAU,CAAC,IAAI,CAAC;YACZ,GAAG;YACH,KAAK,EAAE,OAAO,CAAC,YAAY;YAC3B,EAAE,EAAE,SAAS;YACb,KAAK,EAAE,EAAE,EAAE,qBAAqB;YAChC,YAAY;YACZ,KAAK;YACL,aAAa;SAChB,CAAC,CAAC;IACP,CAAC;AACL,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,WAAW,GAAoB,UACxC,OAAqB,EACrB,KAAiB,EACjB,EAAY,EACZ,GAAgB,EAChB,UAAwB;IAExB,qDAAqD;IACrD,IAAI,SAAS,GAAG,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;IACnC,IAAI,KAAa,CAAC;IAElB,IAAI,SAAS,KAAK,SAAS,CAAC,KAAK,EAAE,CAAC;QAChC,EAAE;QACF,iBAAiB;QACjB,uCAAuC;QACvC,6CAA6C;QAC7C,EAAE;QACF,OAAO,CAAC,eAAe,CAAC,GAA4B,EAAE,UAAU,CAAC,CAAC;QACjE,GAAmB,CAAC,KAAK,EAAE,CAAC;QAC7B,OAAO;IAEX,CAAC;SAAM,IAAI,SAAS,KAAK,SAAS,CAAC,OAAO,EAAE,CAAC;QACxC,GAAmB,CAAC,OAAO,EAAE,CAAC;QAC/B,OAAO;IAEX,CAAC;SAAM,IAAI,SAAS,KAAK,SAAS,CAAC,eAAe,EAAE,CAAC;QACjD,wDAAwD;QACxD,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACvC,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACnD,KAAK,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,aAAa,CAAC,CAAC;QAC1D,GAAG,CAAC,cAAc,CAAC,CAAC,KAAK,CAAC,CAAC;QAC3B,UAAU,CAAC,IAAI,CAAC;YACZ,GAAG;YACH,KAAK,EAAE,OAAO,CAAC,YAAY;YAC3B,EAAE,EAAE,SAAS,CAAC,MAAM;YACpB,KAAK,EAAE,EAAE,EAAE,qBAAqB;YAChC,YAAY,EAAE,KAAK;YACnB,KAAK,EAAE,SAAS;YAChB,aAAa;SAChB,CAAC,CAAC;QAEH,OAAO;IAEX,CAAC;SAAM,IAAI,SAAS,KAAK,SAAS,CAAC,YAAY,EAAE,CAAC;QAC9C,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACvC,MAAM,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAEjD,6CAA6C;QAC7C,IAAI,WAAW,EAAE,CAAC;YACd,KAAK,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,WAAW,CAAC,CAAC;QAC5D,CAAC;QAED,6BAA6B;QAC7B,IAAI,KAAK,KAAK,CAAC,CAAC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACtC,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC;QACvB,CAAC;IAEL,CAAC;SAAM,CAAC;QACJ,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACrC,CAAC;IAED,MAAM,IAAI,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC;IAE7B,IAAI,YAAY,GAAoB,KAAK,CAAC;IAE1C,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,GAAG,WAAW,CACxC,OAAO,EACP,SAAS,EACT,GAAG,EACH,KAAK,EACL,IAAI,EACJ,KAAK,EACL,EAAE,EACF,UAAU,CACb,CAAC;IAEF,IACI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS;QACrC,KAAK,KAAK,aAAa,CAAC,gGAAgG;MAC1H,CAAC;QACC,cAAc;QACb,GAAmB,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;IAC5D,CAAC;IAED,aAAa;IACb,IAAI,aAAa,KAAK,KAAK,EAAE,CAAC;QAC1B,UAAU,CAAC,IAAI,CAAC;YACZ,GAAG;YACH,KAAK,EAAE,OAAO,CAAC,YAAY;YAC3B,EAAE,EAAE,SAAS;YACb,KAAK,EAAE,EAAE,EAAE,qBAAqB;YAChC,YAAY;YACZ,KAAK;YACL,aAAa;SAChB,CAAC,CAAC;IACP,CAAC;AACL,CAAC,CAAA","sourcesContent":["import { OPERATION } from \"../encoding/spec\";\nimport { Metadata } from \"../Metadata\";\nimport { Schema } from \"../Schema\";\nimport type { Ref } from \"../encoder/ChangeTree\";\nimport type { Decoder } from \"./Decoder\";\nimport { Iterator, decode } from \"../encoding/decode\";\nimport { $childType, $deleteByIndex, $getByIndex, $refId } from \"../types/symbols\";\n\nimport type { MapSchema } from \"../types/custom/MapSchema\";\nimport type { ArraySchema } from \"../types/custom/ArraySchema\";\nimport type { CollectionSchema } from \"../types/custom/CollectionSchema\";\n\nimport { getType } from \"../types/registry\";\nimport { Collection } from \"../types/HelperTypes\";\n\nexport interface DataChange<T = any, F = string> {\n    ref: Ref,\n    refId: number,\n    op: OPERATION,\n    field: F;\n    dynamicIndex?: number | string;\n    value: T;\n    previousValue: T;\n}\n\nexport const DEFINITION_MISMATCH = -1;\n\nexport type DecodeOperation<T extends Schema = any> = (\n    decoder: Decoder<T>,\n    bytes: Uint8Array,\n    it: Iterator,\n    ref: Ref,\n    allChanges: DataChange[],\n) => number | void;\n\nexport function decodeValue<T extends Ref>(\n    decoder: Decoder,\n    operation: OPERATION,\n    ref: T,\n    index: number,\n    type: any,\n    bytes: Uint8Array,\n    it: Iterator,\n    allChanges: DataChange[],\n) {\n    const $root = decoder.root;\n    const previousValue = (ref as any)[$getByIndex](index) as T;\n\n    let value: any;\n\n    if ((operation & OPERATION.DELETE) === OPERATION.DELETE)\n    {\n        // Flag `refId` for garbage collection.\n        const previousRefId = previousValue?.[$refId];\n        if (previousRefId !== undefined) { $root.removeRef(previousRefId); }\n\n        //\n        // Delete operations\n        //\n        if (operation !== OPERATION.DELETE_AND_ADD) {\n            (ref as any)[$deleteByIndex](index);\n        }\n\n        value = undefined;\n    }\n\n    if (operation === OPERATION.DELETE) {\n        //\n        // Don't do anything\n        //\n\n    } else if (Schema.is(type)) {\n        const refId = decode.number(bytes, it);\n        value = $root.refs.get(refId);\n\n        if ((operation & OPERATION.ADD) === OPERATION.ADD) {\n            const childType = decoder.getInstanceType(bytes, it, type);\n            if (!value) {\n                value = decoder.createInstanceOfType(childType);\n            }\n\n            $root.addRef(\n                refId,\n                value,\n                (\n                    value !== previousValue || // increment ref count if value has changed\n                    (operation === OPERATION.DELETE_AND_ADD && value === previousValue) // increment ref count if the same instance is being added again\n                )\n            );\n        }\n\n    } else if (typeof(type) === \"string\") {\n        //\n        // primitive value (number, string, boolean, etc)\n        //\n        value = (decode as any)[type](bytes, it);\n\n    } else {\n        const typeDef = getType(Object.keys(type)[0]);\n        const refId = decode.number(bytes, it);\n\n        const valueRef: Ref = ($root.refs.has(refId))\n            ? previousValue || $root.refs.get(refId)\n            : new typeDef.constructor();\n\n        value = valueRef.clone(true);\n        value[$childType] = Object.values(type)[0]; // cache childType for ArraySchema and MapSchema\n\n        if (previousValue) {\n            let previousRefId = previousValue[$refId];\n\n            if (previousRefId !== undefined && refId !== previousRefId) {\n                //\n                // enqueue onRemove if structure has been replaced.\n                //\n                const entries: IterableIterator<[any, any]> = (previousValue as any).entries();\n                let iter: IteratorResult<[any, any]>;\n                while ((iter = entries.next()) && !iter.done) {\n                    const [key, value] = iter.value;\n\n                    // if value is a schema, remove its reference\n                    if (typeof(value) === \"object\") {\n                        previousRefId = value[$refId];\n                        $root.removeRef(previousRefId);\n                    }\n\n                    allChanges.push({\n                        ref: previousValue,\n                        refId: previousRefId,\n                        op: OPERATION.DELETE,\n                        field: key,\n                        value: undefined,\n                        previousValue: value,\n                    });\n                }\n\n            }\n        }\n\n        $root.addRef(refId, value, (\n            valueRef !== previousValue ||\n            (operation === OPERATION.DELETE_AND_ADD && valueRef === previousValue)\n        ));\n    }\n\n    return { value, previousValue };\n}\n\nexport const decodeSchemaOperation: DecodeOperation = function <T extends Schema>(\n    decoder: Decoder<any>,\n    bytes: Uint8Array,\n    it: Iterator,\n    ref: T,\n    allChanges: DataChange[],\n) {\n    const first_byte = bytes[it.offset++];\n    const metadata: Metadata = (ref.constructor as typeof Schema)[Symbol.metadata];\n\n    // \"compressed\" index + operation\n    const operation = (first_byte >> 6) << 6\n    const index = first_byte % (operation || 255);\n\n    // skip early if field is not defined\n    const field = metadata[index];\n    if (field === undefined) {\n        console.warn(\"@colyseus/schema: field not defined at\", { index, ref: ref.constructor.name, metadata });\n        return DEFINITION_MISMATCH;\n    }\n\n    const { value, previousValue } = decodeValue(\n        decoder,\n        operation,\n        ref,\n        index,\n        field.type,\n        bytes,\n        it,\n        allChanges,\n    );\n\n    if (value !== null && value !== undefined) {\n        ref[field.name as keyof T] = value;\n    }\n\n    // add change\n    if (previousValue !== value) {\n        allChanges.push({\n            ref,\n            refId: decoder.currentRefId,\n            op: operation,\n            field: field.name,\n            value,\n            previousValue,\n        });\n    }\n}\n\nexport const decodeKeyValueOperation: DecodeOperation = function (\n    decoder: Decoder<any>,\n    bytes: Uint8Array,\n    it: Iterator,\n    ref: Ref,\n    allChanges: DataChange[]\n) {\n    // \"uncompressed\" index + operation (array/map items)\n    const operation = bytes[it.offset++];\n\n    if (operation === OPERATION.CLEAR) {\n        //\n        // When decoding:\n        // - enqueue items for DELETE callback.\n        // - flag child items for garbage collection.\n        //\n        decoder.removeChildRefs(ref as unknown as Collection, allChanges);\n\n        (ref as any).clear();\n        return;\n    }\n\n    const index = decode.number(bytes, it);\n    const type = (ref as any)[$childType];\n\n    let dynamicIndex: number | string;\n\n    if ((operation & OPERATION.ADD) === OPERATION.ADD) { // ADD or DELETE_AND_ADD\n        if (typeof((ref as any)['set']) === \"function\") {\n            dynamicIndex = decode.string(bytes, it); // MapSchema\n            (ref as any)['setIndex'](index, dynamicIndex);\n        } else {\n            dynamicIndex = index; // ArraySchema\n        }\n    } else {\n        // get dynamic index from \"ref\"\n        dynamicIndex = (ref as any)['getIndex'](index);\n    }\n\n    const { value, previousValue } = decodeValue(\n        decoder,\n        operation,\n        ref,\n        index,\n        type,\n        bytes,\n        it,\n        allChanges,\n    );\n\n    if (value !== null && value !== undefined) {\n        if (typeof((ref as any)['set']) === \"function\") {\n            // MapSchema\n            (ref as any)['$items'].set(dynamicIndex as string, value);\n\n        } else if (typeof((ref as any)['$setAt']) === \"function\") {\n            // ArraySchema\n            (ref as any)['$setAt'](index, value, operation);\n\n        } else if (typeof((ref as any)['add']) === \"function\") {\n            // CollectionSchema && SetSchema\n            const index = (ref as any).add(value);\n\n            if (typeof(index) === \"number\") {\n                (ref as any)['setIndex'](index, index);\n            }\n        }\n    }\n\n    // add change\n    if (previousValue !== value) {\n        allChanges.push({\n            ref,\n            refId: decoder.currentRefId,\n            op: operation,\n            field: \"\", // FIXME: remove this\n            dynamicIndex,\n            value,\n            previousValue,\n        });\n    }\n}\n\nexport const decodeArray: DecodeOperation = function (\n    decoder: Decoder<any>,\n    bytes: Uint8Array,\n    it: Iterator,\n    ref: ArraySchema,\n    allChanges: DataChange[]\n) {\n    // \"uncompressed\" index + operation (array/map items)\n    let operation = bytes[it.offset++];\n    let index: number;\n\n    if (operation === OPERATION.CLEAR) {\n        //\n        // When decoding:\n        // - enqueue items for DELETE callback.\n        // - flag child items for garbage collection.\n        //\n        decoder.removeChildRefs(ref as unknown as Collection, allChanges);\n        (ref as ArraySchema).clear();\n        return;\n\n    } else if (operation === OPERATION.REVERSE) {\n        (ref as ArraySchema).reverse();\n        return;\n\n    } else if (operation === OPERATION.DELETE_BY_REFID) {\n        // TODO: refactor here, try to follow same flow as below\n        const refId = decode.number(bytes, it);\n        const previousValue = decoder.root.refs.get(refId);\n        index = ref.findIndex((value) => value === previousValue);\n        ref[$deleteByIndex](index);\n        allChanges.push({\n            ref,\n            refId: decoder.currentRefId,\n            op: OPERATION.DELETE,\n            field: \"\", // FIXME: remove this\n            dynamicIndex: index,\n            value: undefined,\n            previousValue,\n        });\n\n        return;\n\n    } else if (operation === OPERATION.ADD_BY_REFID) {\n        const refId = decode.number(bytes, it);\n        const itemByRefId = decoder.root.refs.get(refId);\n\n        // if item already exists, use existing index\n        if (itemByRefId) {\n            index = ref.findIndex((value) => value === itemByRefId);\n        }\n\n        // fallback to use last index\n        if (index === -1 || index === undefined) {\n            index = ref.length;\n        }\n\n    } else {\n        index = decode.number(bytes, it);\n    }\n\n    const type = ref[$childType];\n\n    let dynamicIndex: number | string = index;\n\n    const { value, previousValue } = decodeValue(\n        decoder,\n        operation,\n        ref,\n        index,\n        type,\n        bytes,\n        it,\n        allChanges,\n    );\n\n    if (\n        value !== null && value !== undefined &&\n        value !== previousValue // avoid setting same value twice (if index === 0 it will result in a \"unshift\" for ArraySchema)\n    ) {\n        // ArraySchema\n        (ref as ArraySchema)['$setAt'](index, value, operation);\n    }\n\n    // add change\n    if (previousValue !== value) {\n        allChanges.push({\n            ref,\n            refId: decoder.currentRefId,\n            op: operation,\n            field: \"\", // FIXME: remove this\n            dynamicIndex,\n            value,\n            previousValue,\n        });\n    }\n}"]}

package/lib/src/decoder/Decoder.d.ts

@@ -0,0 +1,21 @@
+import { TypeContext } from "../types/TypeContext";
+import { Schema } from "../Schema";
+import type { Ref } from "../encoder/ChangeTree";
+import type { Iterator } from "../encoding/decode";
+import { ReferenceTracker } from "./ReferenceTracker";
+import { type DataChange } from "./DecodeOperation";
+import { Collection } from "../types/HelperTypes";
+export declare class Decoder<T extends Schema = any> {
+    context: TypeContext;
+    state: T;
+    root: ReferenceTracker;
+    currentRefId: number;
+    triggerChanges?: (allChanges: DataChange[]) => void;
+    constructor(root: T, context?: TypeContext);
+    protected setState(root: T): void;
+    decode(bytes: Uint8Array, it?: Iterator, ref?: Ref): DataChange<any, string>[];
+    skipCurrentStructure(bytes: Uint8Array, it: Iterator, totalBytes: number): void;
+    getInstanceType(bytes: Uint8Array, it: Iterator, defaultType: typeof Schema): typeof Schema;
+    createInstanceOfType(type: typeof Schema): Schema;
+    removeChildRefs(ref: Collection, allChanges: DataChange[]): void;
+}

package/lib/src/decoder/Decoder.js

@@ -0,0 +1,114 @@
+import { TypeContext } from "../types/TypeContext";
+import { $childType, $decoder, $onDecodeEnd, $refId } from "../types/symbols";
+import { decode } from "../encoding/decode";
+import { OPERATION, SWITCH_TO_STRUCTURE, TYPE_ID } from '../encoding/spec';
+import { ReferenceTracker } from "./ReferenceTracker";
+import { DEFINITION_MISMATCH } from "./DecodeOperation";
+export class Decoder {
+    constructor(root, context) {
+        this.currentRefId = 0;
+        this.setState(root);
+        this.context = context || new TypeContext(root.constructor);
+        // console.log(">>>>>>>>>>>>>>>> Decoder types");
+        // this.context.schemas.forEach((id, schema) => {
+        //     console.log("type:", id, schema.name, Object.keys(schema[Symbol.metadata]));
+        // });
+    }
+    setState(root) {
+        this.state = root;
+        this.root = new ReferenceTracker();
+        this.root.addRef(0, root);
+    }
+    decode(bytes, it = { offset: 0 }, ref = this.state) {
+        const allChanges = [];
+        const $root = this.root;
+        const totalBytes = bytes.byteLength;
+        let decoder = ref['constructor'][$decoder];
+        this.currentRefId = 0;
+        while (it.offset < totalBytes) {
+            //
+            // Peek ahead, check if it's a switch to a different structure
+            //
+            if (bytes[it.offset] == SWITCH_TO_STRUCTURE) {
+                it.offset++;
+                ref[$onDecodeEnd]?.();
+                const nextRefId = decode.number(bytes, it);
+                const nextRef = $root.refs.get(nextRefId);
+                //
+                // Trying to access a reference that haven't been decoded yet.
+                //
+                if (!nextRef) {
+                    // throw new Error(`"refId" not found: ${nextRefId}`);
+                    console.error(`"refId" not found: ${nextRefId}`, { previousRef: ref, previousRefId: this.currentRefId });
+                    console.warn("Please report this issue to the developers.");
+                    this.skipCurrentStructure(bytes, it, totalBytes);
+                }
+                else {
+                    ref = nextRef;
+                    decoder = ref.constructor[$decoder];
+                    this.currentRefId = nextRefId;
+                }
+                continue;
+            }
+            const result = decoder(this, bytes, it, ref, allChanges);
+            if (result === DEFINITION_MISMATCH) {
+                console.warn("@colyseus/schema: definition mismatch");
+                this.skipCurrentStructure(bytes, it, totalBytes);
+                continue;
+            }
+        }
+        // FIXME: DRY with SWITCH_TO_STRUCTURE block.
+        ref[$onDecodeEnd]?.();
+        // trigger changes
+        this.triggerChanges?.(allChanges);
+        // drop references of unused schemas
+        $root.garbageCollectDeletedRefs();
+        return allChanges;
+    }
+    skipCurrentStructure(bytes, it, totalBytes) {
+        //
+        // keep skipping next bytes until reaches a known structure
+        // by local decoder.
+        //
+        const nextIterator = { offset: it.offset };
+        while (it.offset < totalBytes) {
+            if (bytes[it.offset] === SWITCH_TO_STRUCTURE) {
+                nextIterator.offset = it.offset + 1;
+                if (this.root.refs.has(decode.number(bytes, nextIterator))) {
+                    break;
+                }
+            }
+            it.offset++;
+        }
+    }
+    getInstanceType(bytes, it, defaultType) {
+        let type;
+        if (bytes[it.offset] === TYPE_ID) {
+            it.offset++;
+            const type_id = decode.number(bytes, it);
+            type = this.context.get(type_id);
+        }
+        return type || defaultType;
+    }
+    createInstanceOfType(type) {
+        return new type();
+    }
+    removeChildRefs(ref, allChanges) {
+        const needRemoveRef = typeof (ref[$childType]) !== "string";
+        const refId = ref[$refId];
+        ref.forEach((value, key) => {
+            allChanges.push({
+                ref: ref,
+                refId,
+                op: OPERATION.DELETE,
+                field: key,
+                value: undefined,
+                previousValue: value
+            });
+            if (needRemoveRef) {
+                this.root.removeRef(value[$refId]);
+            }
+        });
+    }
+}
+//# sourceMappingURL=Decoder.js.map

package/lib/src/decoder/Decoder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Decoder.js","sourceRoot":"","sources":["../../../src/decoder/Decoder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAY,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAGxF,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAG3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,mBAAmB,EAAyC,MAAM,mBAAmB,CAAC;AAG/F,MAAM,OAAO,OAAO;IAUhB,YAAY,IAAO,EAAE,OAAqB;QAJ1C,iBAAY,GAAW,CAAC,CAAC;QAKrB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAEpB,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,IAAI,WAAW,CAAC,IAAI,CAAC,WAA4B,CAAC,CAAC;QAE7E,iDAAiD;QACjD,iDAAiD;QACjD,mFAAmF;QACnF,MAAM;IACV,CAAC;IAES,QAAQ,CAAC,IAAO;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,IAAI,GAAG,IAAI,gBAAgB,EAAE,CAAC;QACnC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED,MAAM,CACF,KAAiB,EACjB,KAAe,EAAE,MAAM,EAAE,CAAC,EAAE,EAC5B,MAAW,IAAI,CAAC,KAAK;QAErB,MAAM,UAAU,GAAiB,EAAE,CAAC;QAEpC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC;QACxB,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QAEpC,IAAI,OAAO,GAAoB,GAAG,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5D,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QAEtB,OAAO,EAAE,CAAC,MAAM,GAAG,UAAU,EAAE,CAAC;YAC5B,EAAE;YACF,8DAA8D;YAC9D,EAAE;YACF,IAAI,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,mBAAmB,EAAE,CAAC;gBAC1C,EAAE,CAAC,MAAM,EAAE,CAAC;gBAEX,GAAW,CAAC,YAAY,CAAC,EAAE,EAAE,CAAA;gBAE9B,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBAC3C,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBAE1C,EAAE;gBACF,8DAA8D;gBAC9D,EAAE;gBACF,IAAI,CAAC,OAAO,EAAE,CAAC;oBACX,sDAAsD;oBACtD,OAAO,CAAC,KAAK,CAAC,sBAAsB,SAAS,EAAE,EAAE,EAAE,WAAW,EAAE,GAAG,EAAE,aAAa,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;oBACzG,OAAO,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;oBAC5D,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;gBAErD,CAAC;qBAAM,CAAC;oBACJ,GAAG,GAAG,OAAO,CAAC;oBACd,OAAO,GAAG,GAAG,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;oBACpC,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;gBAClC,CAAC;gBAED,SAAS;YACb,CAAC;YAED,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;YAEzD,IAAI,MAAM,KAAK,mBAAmB,EAAE,CAAC;gBACjC,OAAO,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;gBACtD,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;gBACjD,SAAS;YACb,CAAC;QACL,CAAC;QAED,6CAA6C;QAC5C,GAAW,CAAC,YAAY,CAAC,EAAE,EAAE,CAAA;QAE9B,kBAAkB;QAClB,IAAI,CAAC,cAAc,EAAE,CAAC,UAAU,CAAC,CAAC;QAElC,oCAAoC;QACpC,KAAK,CAAC,yBAAyB,EAAE,CAAC;QAElC,OAAO,UAAU,CAAC;IACtB,CAAC;IAED,oBAAoB,CAAC,KAAiB,EAAE,EAAY,EAAE,UAAkB;QACpE,EAAE;QACF,2DAA2D;QAC3D,oBAAoB;QACpB,EAAE;QACF,MAAM,YAAY,GAAa,EAAE,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC;QACrD,OAAO,EAAE,CAAC,MAAM,GAAG,UAAU,EAAE,CAAC;YAC5B,IAAI,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,mBAAmB,EAAE,CAAC;gBAC3C,YAAY,CAAC,MAAM,GAAG,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;gBACpC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC;oBACzD,MAAM;gBACV,CAAC;YACL,CAAC;YACD,EAAE,CAAC,MAAM,EAAE,CAAC;QAChB,CAAC;IACL,CAAC;IAED,eAAe,CAAC,KAAiB,EAAE,EAAY,EAAE,WAA0B;QACvE,IAAI,IAAmB,CAAC;QAExB,IAAI,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,OAAO,EAAE,CAAC;YAC/B,EAAE,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YACzC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACrC,CAAC;QAED,OAAO,IAAI,IAAI,WAAW,CAAC;IAC/B,CAAC;IAED,oBAAoB,CAAE,IAAmB;QACrC,OAAO,IAAK,IAAY,EAAE,CAAC;IAC/B,CAAC;IAED,eAAe,CAAC,GAAe,EAAE,UAAwB;QACrD,MAAM,aAAa,GAAG,OAAO,CAAE,GAAW,CAAC,UAAU,CAAC,CAAC,KAAK,QAAQ,CAAC;QACrE,MAAM,KAAK,GAAI,GAAW,CAAC,MAAM,CAAC,CAAC;QAEnC,GAAG,CAAC,OAAO,CAAC,CAAC,KAAU,EAAE,GAAQ,EAAE,EAAE;YACjC,UAAU,CAAC,IAAI,CAAC;gBACZ,GAAG,EAAE,GAAU;gBACf,KAAK;gBACL,EAAE,EAAE,SAAS,CAAC,MAAM;gBACpB,KAAK,EAAE,GAAG;gBACV,KAAK,EAAE,SAAS;gBAChB,aAAa,EAAE,KAAK;aACvB,CAAC,CAAC;YAEH,IAAI,aAAa,EAAE,CAAC;gBAChB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;YACvC,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;CAEJ","sourcesContent":["import { TypeContext } from \"../types/TypeContext\";\nimport { $changes, $childType, $decoder, $onDecodeEnd, $refId } from \"../types/symbols\";\nimport { Schema } from \"../Schema\";\n\nimport { decode } from \"../encoding/decode\";\nimport { OPERATION, SWITCH_TO_STRUCTURE, TYPE_ID } from '../encoding/spec';\nimport type { Ref } from \"../encoder/ChangeTree\";\nimport type { Iterator } from \"../encoding/decode\";\nimport { ReferenceTracker } from \"./ReferenceTracker\";\nimport { DEFINITION_MISMATCH, type DataChange, type DecodeOperation } from \"./DecodeOperation\";\nimport { Collection } from \"../types/HelperTypes\";\n\nexport class Decoder<T extends Schema = any> {\n    context: TypeContext;\n\n    state: T;\n    root: ReferenceTracker;\n\n    currentRefId: number = 0;\n\n    triggerChanges?: (allChanges: DataChange[]) => void;\n\n    constructor(root: T, context?: TypeContext) {\n        this.setState(root);\n\n        this.context = context || new TypeContext(root.constructor as typeof Schema);\n\n        // console.log(\">>>>>>>>>>>>>>>> Decoder types\");\n        // this.context.schemas.forEach((id, schema) => {\n        //     console.log(\"type:\", id, schema.name, Object.keys(schema[Symbol.metadata]));\n        // });\n    }\n\n    protected setState(root: T) {\n        this.state = root;\n        this.root = new ReferenceTracker();\n        this.root.addRef(0, root);\n    }\n\n    decode(\n        bytes: Uint8Array,\n        it: Iterator = { offset: 0 },\n        ref: Ref = this.state,\n    ) {\n        const allChanges: DataChange[] = [];\n\n        const $root = this.root;\n        const totalBytes = bytes.byteLength;\n\n        let decoder: DecodeOperation = ref['constructor'][$decoder];\n\n        this.currentRefId = 0;\n\n        while (it.offset < totalBytes) {\n            //\n            // Peek ahead, check if it's a switch to a different structure\n            //\n            if (bytes[it.offset] == SWITCH_TO_STRUCTURE) {\n                it.offset++;\n\n                (ref as any)[$onDecodeEnd]?.()\n\n                const nextRefId = decode.number(bytes, it);\n                const nextRef = $root.refs.get(nextRefId);\n\n                //\n                // Trying to access a reference that haven't been decoded yet.\n                //\n                if (!nextRef) {\n                    // throw new Error(`\"refId\" not found: ${nextRefId}`);\n                    console.error(`\"refId\" not found: ${nextRefId}`, { previousRef: ref, previousRefId: this.currentRefId });\n                    console.warn(\"Please report this issue to the developers.\");\n                    this.skipCurrentStructure(bytes, it, totalBytes);\n\n                } else {\n                    ref = nextRef;\n                    decoder = ref.constructor[$decoder];\n                    this.currentRefId = nextRefId;\n                }\n\n                continue;\n            }\n\n            const result = decoder(this, bytes, it, ref, allChanges);\n\n            if (result === DEFINITION_MISMATCH) {\n                console.warn(\"@colyseus/schema: definition mismatch\");\n                this.skipCurrentStructure(bytes, it, totalBytes);\n                continue;\n            }\n        }\n\n        // FIXME: DRY with SWITCH_TO_STRUCTURE block.\n        (ref as any)[$onDecodeEnd]?.()\n\n        // trigger changes\n        this.triggerChanges?.(allChanges);\n\n        // drop references of unused schemas\n        $root.garbageCollectDeletedRefs();\n\n        return allChanges;\n    }\n\n    skipCurrentStructure(bytes: Uint8Array, it: Iterator, totalBytes: number) {\n        //\n        // keep skipping next bytes until reaches a known structure\n        // by local decoder.\n        //\n        const nextIterator: Iterator = { offset: it.offset };\n        while (it.offset < totalBytes) {\n            if (bytes[it.offset] === SWITCH_TO_STRUCTURE) {\n                nextIterator.offset = it.offset + 1;\n                if (this.root.refs.has(decode.number(bytes, nextIterator))) {\n                    break;\n                }\n            }\n            it.offset++;\n        }\n    }\n\n    getInstanceType(bytes: Uint8Array, it: Iterator, defaultType: typeof Schema): typeof Schema {\n        let type: typeof Schema;\n\n        if (bytes[it.offset] === TYPE_ID) {\n            it.offset++;\n            const type_id = decode.number(bytes, it);\n            type = this.context.get(type_id);\n        }\n\n        return type || defaultType;\n    }\n\n    createInstanceOfType (type: typeof Schema): Schema {\n        return new (type as any)();\n    }\n\n    removeChildRefs(ref: Collection, allChanges: DataChange[]) {\n        const needRemoveRef = typeof ((ref as any)[$childType]) !== \"string\";\n        const refId = (ref as Ref)[$refId];\n\n        ref.forEach((value: any, key: any) => {\n            allChanges.push({\n                ref: ref as Ref,\n                refId,\n                op: OPERATION.DELETE,\n                field: key,\n                value: undefined,\n                previousValue: value\n            });\n\n            if (needRemoveRef) {\n                this.root.removeRef(value[$refId]);\n            }\n        });\n    }\n\n}\n"]}

package/lib/src/decoder/ReferenceTracker.d.ts

@@ -0,0 +1,25 @@
+import { Ref } from "../encoder/ChangeTree";
+/**
+ * Used for decoding only.
+ */
+export type SchemaCallbacks = {
+    [field: string | number]: Function[];
+};
+export declare class ReferenceTracker {
+    refs: Map<number, Ref>;
+    refCount: {
+        [refId: number]: number;
+    };
+    deletedRefs: Set<number>;
+    callbacks: {
+        [refId: number]: SchemaCallbacks;
+    };
+    protected nextUniqueId: number;
+    getNextUniqueId(): number;
+    addRef(refId: number, ref: Ref, incrementCount?: boolean): void;
+    removeRef(refId: number): void;
+    clearRefs(): void;
+    garbageCollectDeletedRefs(): void;
+    addCallback(refId: number, fieldOrOperation: string | number, callback: Function): () => void;
+    removeCallback(refId: number, field: string | number, callback: Function): void;
+}

package/lib/src/decoder/ReferenceTracker.js

@@ -0,0 +1,135 @@
+import { $childType, $refId } from "../types/symbols";
+import { spliceOne } from "../types/utils";
+import { OPERATION } from "../encoding/spec";
+class DecodingWarning extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "DecodingWarning";
+    }
+}
+export class ReferenceTracker {
+    constructor() {
+        //
+        // Relation of refId => Schema structure
+        // For direct access of structures during decoding time.
+        //
+        this.refs = new Map();
+        this.refCount = {};
+        this.deletedRefs = new Set();
+        this.callbacks = {};
+        this.nextUniqueId = 0;
+    }
+    getNextUniqueId() {
+        return this.nextUniqueId++;
+    }
+    // for decoding
+    addRef(refId, ref, incrementCount = true) {
+        this.refs.set(refId, ref);
+        ref[$refId] = refId;
+        if (incrementCount) {
+            this.refCount[refId] = (this.refCount[refId] || 0) + 1;
+        }
+        if (this.deletedRefs.has(refId)) {
+            this.deletedRefs.delete(refId);
+        }
+    }
+    // for decoding
+    removeRef(refId) {
+        const refCount = this.refCount[refId];
+        if (refCount === undefined) {
+            try {
+                throw new DecodingWarning("trying to remove refId that doesn't exist: " + refId);
+            }
+            catch (e) {
+                console.warn(e);
+            }
+            return;
+        }
+        if (refCount === 0) {
+            try {
+                const ref = this.refs.get(refId);
+                throw new DecodingWarning(`trying to remove refId '${refId}' with 0 refCount (${ref.constructor.name}: ${JSON.stringify(ref)})`);
+            }
+            catch (e) {
+                console.warn(e);
+            }
+            return;
+        }
+        if ((this.refCount[refId] = refCount - 1) <= 0) {
+            this.deletedRefs.add(refId);
+        }
+    }
+    clearRefs() {
+        this.refs.clear();
+        this.deletedRefs.clear();
+        this.callbacks = {};
+        this.refCount = {};
+    }
+    // for decoding
+    garbageCollectDeletedRefs() {
+        this.deletedRefs.forEach((refId) => {
+            //
+            // Skip active references.
+            //
+            if (this.refCount[refId] > 0) {
+                return;
+            }
+            const ref = this.refs.get(refId);
+            //
+            // Ensure child schema instances have their references removed as well.
+            //
+            if (ref.constructor[Symbol.metadata] !== undefined) {
+                const metadata = ref.constructor[Symbol.metadata];
+                for (const index in metadata) {
+                    const field = metadata[index].name;
+                    const child = ref[field];
+                    if (typeof (child) === "object" && child) {
+                        const childRefId = child[$refId];
+                        if (childRefId !== undefined && !this.deletedRefs.has(childRefId)) {
+                            this.removeRef(childRefId);
+                        }
+                    }
+                }
+            }
+            else {
+                if (typeof (ref[$childType]) === "function") {
+                    Array.from(ref.values())
+                        .forEach((child) => {
+                        const childRefId = child[$refId];
+                        if (childRefId !== undefined && !this.deletedRefs.has(childRefId)) {
+                            this.removeRef(childRefId);
+                        }
+                    });
+                }
+            }
+            this.refs.delete(refId); // remove ref
+            delete this.refCount[refId]; // remove ref count
+            delete this.callbacks[refId]; // remove callbacks
+        });
+        // clear deleted refs.
+        this.deletedRefs.clear();
+    }
+    addCallback(refId, fieldOrOperation, callback) {
+        if (refId === undefined) {
+            const name = (typeof (fieldOrOperation) === "number")
+                ? OPERATION[fieldOrOperation]
+                : fieldOrOperation;
+            throw new Error(`Can't addCallback on '${name}' (refId is undefined)`);
+        }
+        if (!this.callbacks[refId]) {
+            this.callbacks[refId] = {};
+        }
+        if (!this.callbacks[refId][fieldOrOperation]) {
+            this.callbacks[refId][fieldOrOperation] = [];
+        }
+        this.callbacks[refId][fieldOrOperation].push(callback);
+        return () => this.removeCallback(refId, fieldOrOperation, callback);
+    }
+    removeCallback(refId, field, callback) {
+        const index = this.callbacks?.[refId]?.[field]?.indexOf(callback);
+        if (index !== undefined && index !== -1) {
+            spliceOne(this.callbacks[refId][field], index);
+        }
+    }
+}
+//# sourceMappingURL=ReferenceTracker.js.map

package/lib/src/decoder/ReferenceTracker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReferenceTracker.js","sourceRoot":"","sources":["../../../src/decoder/ReferenceTracker.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAEtD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAK7C,MAAM,eAAgB,SAAQ,KAAK;IAC/B,YAAY,OAAe;QACvB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;IAClC,CAAC;CACJ;AAQD,MAAM,OAAO,gBAAgB;IAA7B;QACI,EAAE;QACF,wCAAwC;QACxC,wDAAwD;QACxD,EAAE;QACK,SAAI,GAAG,IAAI,GAAG,EAAe,CAAC;QAE9B,aAAQ,GAAiC,EAAE,CAAC;QAC5C,gBAAW,GAAG,IAAI,GAAG,EAAU,CAAC;QAEhC,cAAS,GAAyC,EAAE,CAAC;QAClD,iBAAY,GAAW,CAAC,CAAC;IAgIvC,CAAC;IA9HG,eAAe;QACX,OAAO,IAAI,CAAC,YAAY,EAAE,CAAC;IAC/B,CAAC;IAED,eAAe;IACf,MAAM,CAAC,KAAa,EAAE,GAAQ,EAAE,iBAA0B,IAAI;QAC1D,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAC1B,GAAG,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;QAEpB,IAAI,cAAc,EAAE,CAAC;YACjB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QAC3D,CAAC;QAED,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC;IACL,CAAC;IAED,eAAe;IACf,SAAS,CAAC,KAAa;QACnB,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAEtC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzB,IAAI,CAAC;gBACD,MAAM,IAAI,eAAe,CAAC,6CAA6C,GAAG,KAAK,CAAC,CAAC;YACrF,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACT,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACpB,CAAC;YACD,OAAO;QACX,CAAC;QAED,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;YACjB,IAAI,CAAC;gBACD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACjC,MAAM,IAAI,eAAe,CAAC,2BAA2B,KAAK,sBAAsB,GAAG,CAAC,WAAW,CAAC,IAAI,KAAK,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACrI,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACT,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACpB,CAAC;YACD,OAAO;QACX,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,QAAQ,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7C,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACL,CAAC;IAED,SAAS;QACL,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QAClB,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;IACvB,CAAC;IAED,eAAe;IACf,yBAAyB;QACrB,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC/B,EAAE;YACF,0BAA0B;YAC1B,EAAE;YACF,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBAAC,OAAO;YAAC,CAAC;YAEzC,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAEjC,EAAE;YACF,uEAAuE;YACvE,EAAE;YACF,IAAK,GAAG,CAAC,WAA6B,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,SAAS,EAAE,CAAC;gBACpE,MAAM,QAAQ,GAAc,GAAG,CAAC,WAA6B,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;gBAC/E,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;oBAC3B,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAsB,CAAC,CAAC,IAAI,CAAC;oBACpD,MAAM,KAAK,GAAG,GAAG,CAAC,KAAkB,CAAC,CAAC;oBACtC,IAAI,OAAM,CAAC,KAAK,CAAC,KAAK,QAAQ,IAAI,KAAK,EAAE,CAAC;wBACtC,MAAM,UAAU,GAAI,KAAa,CAAC,MAAM,CAAC,CAAC;wBAC1C,IAAI,UAAU,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;4BAChE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;wBAC/B,CAAC;oBACL,CAAC;gBACL,CAAC;YAEL,CAAC;iBAAM,CAAC;gBACJ,IAAI,OAAO,CAAE,GAAW,CAAC,UAAU,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC;oBACnD,KAAK,CAAC,IAAI,CAAE,GAAiB,CAAC,MAAM,EAAE,CAAC;yBAClC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;wBACf,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;wBACjC,IAAI,UAAU,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;4BAChE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;wBAC/B,CAAC;oBACL,CAAC,CAAC,CAAC;gBACX,CAAC;YACL,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,aAAa;YACtC,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,mBAAmB;YAChD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,mBAAmB;QACrD,CAAC,CAAC,CAAC;QAEH,sBAAsB;QACtB,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;IAC7B,CAAC;IAED,WAAW,CAAC,KAAa,EAAE,gBAAiC,EAAE,QAAkB;QAC5E,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACtB,MAAM,IAAI,GAAG,CAAC,OAAM,CAAC,gBAAgB,CAAC,KAAK,QAAQ,CAAC;gBAC5C,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC;gBAC7B,CAAC,CAAC,gBAAgB,CAAA;YAC1B,MAAM,IAAI,KAAK,CACX,yBAAyB,IAAI,wBAAwB,CACxD,CAAC;QACN,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;QAC/B,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,gBAAgB,CAAC,EAAE,CAAC;YAC3C,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvD,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IACxE,CAAC;IAED,cAAc,CAAC,KAAa,EAAE,KAAsB,EAAE,QAAkB;QACpE,MAAM,KAAK,GAAuB,IAAI,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QACtF,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACtC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;QACnD,CAAC;IACL,CAAC;CAEJ","sourcesContent":["import { Metadata } from \"../Metadata\";\nimport { $childType, $refId } from \"../types/symbols\";\nimport { Ref } from \"../encoder/ChangeTree\";\nimport { spliceOne } from \"../types/utils\";\nimport { OPERATION } from \"../encoding/spec\";\n\nimport type { MapSchema } from \"../types/custom/MapSchema\";\nimport type { Schema } from \"../Schema\";\n\nclass DecodingWarning extends Error {\n    constructor(message: string) {\n        super(message);\n        this.name = \"DecodingWarning\";\n    }\n}\n\n/**\n * Used for decoding only.\n */\n\nexport type SchemaCallbacks = { [field: string | number]: Function[] };\n\nexport class ReferenceTracker {\n    //\n    // Relation of refId => Schema structure\n    // For direct access of structures during decoding time.\n    //\n    public refs = new Map<number, Ref>();\n\n    public refCount: { [refId: number]: number; } = {};\n    public deletedRefs = new Set<number>();\n\n    public callbacks: { [refId: number]: SchemaCallbacks } = {};\n    protected nextUniqueId: number = 0;\n\n    getNextUniqueId() {\n        return this.nextUniqueId++;\n    }\n\n    // for decoding\n    addRef(refId: number, ref: Ref, incrementCount: boolean = true) {\n        this.refs.set(refId, ref);\n        ref[$refId] = refId;\n\n        if (incrementCount) {\n            this.refCount[refId] = (this.refCount[refId] || 0) + 1;\n        }\n\n        if (this.deletedRefs.has(refId)) {\n            this.deletedRefs.delete(refId);\n        }\n    }\n\n    // for decoding\n    removeRef(refId: number) {\n        const refCount = this.refCount[refId];\n\n        if (refCount === undefined) {\n            try {\n                throw new DecodingWarning(\"trying to remove refId that doesn't exist: \" + refId);\n            } catch (e) {\n                console.warn(e);\n            }\n            return;\n        }\n\n        if (refCount === 0) {\n            try {\n                const ref = this.refs.get(refId);\n                throw new DecodingWarning(`trying to remove refId '${refId}' with 0 refCount (${ref.constructor.name}: ${JSON.stringify(ref)})`);\n            } catch (e) {\n                console.warn(e);\n            }\n            return;\n        }\n\n        if ((this.refCount[refId] = refCount - 1) <= 0) {\n            this.deletedRefs.add(refId);\n        }\n    }\n\n    clearRefs() {\n        this.refs.clear();\n        this.deletedRefs.clear();\n        this.callbacks = {};\n        this.refCount = {};\n    }\n\n    // for decoding\n    garbageCollectDeletedRefs() {\n        this.deletedRefs.forEach((refId) => {\n            //\n            // Skip active references.\n            //\n            if (this.refCount[refId] > 0) { return; }\n\n            const ref = this.refs.get(refId);\n\n            //\n            // Ensure child schema instances have their references removed as well.\n            //\n            if ((ref.constructor as typeof Schema)[Symbol.metadata] !== undefined) {\n                const metadata: Metadata = (ref.constructor as typeof Schema)[Symbol.metadata];\n                for (const index in metadata) {\n                    const field = metadata[index as any as number].name;\n                    const child = ref[field as keyof Ref];\n                    if (typeof(child) === \"object\" && child) {\n                        const childRefId = (child as any)[$refId];\n                        if (childRefId !== undefined && !this.deletedRefs.has(childRefId)) {\n                            this.removeRef(childRefId);\n                        }\n                    }\n                }\n\n            } else {\n                if (typeof ((ref as any)[$childType]) === \"function\") {\n                    Array.from((ref as MapSchema).values())\n                        .forEach((child) => {\n                            const childRefId = child[$refId];\n                            if (childRefId !== undefined && !this.deletedRefs.has(childRefId)) {\n                                this.removeRef(childRefId);\n                            }\n                        });\n                }\n            }\n\n            this.refs.delete(refId); // remove ref\n            delete this.refCount[refId]; // remove ref count\n            delete this.callbacks[refId]; // remove callbacks\n        });\n\n        // clear deleted refs.\n        this.deletedRefs.clear();\n    }\n\n    addCallback(refId: number, fieldOrOperation: string | number, callback: Function) {\n        if (refId === undefined) {\n            const name = (typeof(fieldOrOperation) === \"number\")\n                    ? OPERATION[fieldOrOperation]\n                    : fieldOrOperation\n            throw new Error(\n                `Can't addCallback on '${name}' (refId is undefined)`\n            );\n        }\n        if (!this.callbacks[refId]) {\n            this.callbacks[refId] = {};\n        }\n        if (!this.callbacks[refId][fieldOrOperation]) {\n            this.callbacks[refId][fieldOrOperation] = [];\n        }\n        this.callbacks[refId][fieldOrOperation].push(callback);\n        return () => this.removeCallback(refId, fieldOrOperation, callback);\n    }\n\n    removeCallback(refId: number, field: string | number, callback: Function) {\n        const index: number | undefined = this.callbacks?.[refId]?.[field]?.indexOf(callback);\n        if (index !== undefined && index !== -1) {\n            spliceOne(this.callbacks[refId][field], index);\n        }\n    }\n\n}\n"]}