@colyseus/schema 2.0.32 → 3.0.0-alpha.1

package/lib/decoder/DecodeOperation.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="node" />
+import { OPERATION } from "../encoding/spec";
+import { Schema } from "../Schema";
+import type { Ref } from "../encoder/ChangeTree";
+import type { Decoder } from "./Decoder";
+import * as decode from "../encoding/decode";
+export interface DataChange<T = any, F = string> {
+    ref: Ref;
+    refId: number;
+    op: OPERATION;
+    field: F;
+    dynamicIndex?: number | string;
+    value: T;
+    previousValue: T;
+}
+export declare const DEFINITION_MISMATCH = -1;
+export type DecodeOperation<T extends Schema = any> = (decoder: Decoder<T>, bytes: Buffer, it: decode.Iterator, ref: Ref, allChanges: DataChange[]) => number | void;
+export declare function decodeValue(decoder: Decoder, operation: OPERATION, ref: Ref, index: number, type: any, bytes: Buffer, it: decode.Iterator, allChanges: DataChange[]): {
+    value: any;
+    previousValue: any;
+};
+export declare const decodeSchemaOperation: DecodeOperation;
+export declare const decodeKeyValueOperation: DecodeOperation;
+export declare const decodeArray: DecodeOperation;

package/lib/decoder/DecodeOperation.js

@@ -0,0 +1,256 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decodeArray = exports.decodeKeyValueOperation = exports.decodeSchemaOperation = exports.decodeValue = exports.DEFINITION_MISMATCH = void 0;
+const spec_1 = require("../encoding/spec");
+const Schema_1 = require("../Schema");
+const decode = require("../encoding/decode");
+const symbols_1 = require("../types/symbols");
+const registry_1 = require("../types/registry");
+exports.DEFINITION_MISMATCH = -1;
+function decodeValue(decoder, operation, ref, index, type, bytes, it, allChanges) {
+    const $root = decoder.$root;
+    const previousValue = ref[symbols_1.$getByIndex](index);
+    let value;
+    if ((operation & spec_1.OPERATION.DELETE) === spec_1.OPERATION.DELETE) {
+        // Flag `refId` for garbage collection.
+        const previousRefId = $root.refIds.get(previousValue);
+        if (previousRefId !== undefined) {
+            $root.removeRef(previousRefId);
+        }
+        //
+        // Delete operations
+        //
+        if (operation !== spec_1.OPERATION.DELETE_AND_ADD) {
+            ref[symbols_1.$deleteByIndex](index);
+            // //
+            // // FIXME: is this in the correct place?
+            // //      (This is sounding like a workaround just for ArraySchema, see
+            // //       "should splice and move" test on ArraySchema.test.ts)
+            // //
+            // allChanges.push({
+            //     ref,
+            //     refId: decoder.currentRefId,
+            //     op: OPERATION.DELETE,
+            //     field: index as unknown as string,
+            //     value: undefined,
+            //     previousValue,
+            // });
+        }
+        value = null;
+    }
+    if (operation === spec_1.OPERATION.DELETE) {
+        //
+        // Don't do anything
+        //
+    }
+    else if (Schema_1.Schema.is(type)) {
+        const refId = decode.number(bytes, it);
+        value = $root.refs.get(refId);
+        if (previousValue) {
+            const previousRefId = $root.refIds.get(previousValue);
+            if (previousRefId &&
+                refId !== previousRefId &&
+                // FIXME: we may need to check for REPLACE operation as well
+                ((operation & spec_1.OPERATION.DELETE) === spec_1.OPERATION.DELETE)) {
+                $root.removeRef(previousRefId);
+            }
+        }
+        if ((operation & spec_1.OPERATION.ADD) === spec_1.OPERATION.ADD) {
+            const childType = decoder.getInstanceType(bytes, it, type);
+            if (!value) {
+                value = decoder.createInstanceOfType(childType);
+            }
+            $root.addRef(refId, value, (value !== previousValue));
+        }
+    }
+    else if (typeof (type) === "string") {
+        //
+        // primitive value (number, string, boolean, etc)
+        //
+        value = decode[type](bytes, it);
+    }
+    else {
+        const typeDef = (0, registry_1.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[symbols_1.$childType] = Object.values(type)[0]; // cache childType for ArraySchema and MapSchema
+        if (previousValue) {
+            let previousRefId = $root.refIds.get(previousValue);
+            if (previousRefId !== undefined && refId !== previousRefId) {
+                $root.removeRef(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
+                    // FIXME: not sure if this is necessary, add more tests to confirm
+                    if (typeof (value) === "object") {
+                        previousRefId = $root.refIds.get(value);
+                        $root.removeRef(previousRefId);
+                    }
+                    allChanges.push({
+                        ref: previousValue,
+                        refId: previousRefId,
+                        op: spec_1.OPERATION.DELETE,
+                        field: key,
+                        value: undefined,
+                        previousValue: value,
+                    });
+                }
+            }
+        }
+        $root.addRef(refId, value, (valueRef !== previousValue));
+    }
+    return { value, previousValue };
+}
+exports.decodeValue = decodeValue;
+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) {
+        return exports.DEFINITION_MISMATCH;
+    }
+    const { value, previousValue } = decodeValue(decoder, operation, ref, index, metadata[field].type, bytes, it, allChanges);
+    if (value !== null && value !== undefined) {
+        ref[field] = value;
+    }
+    // add change
+    if (previousValue !== value) {
+        allChanges.push({
+            ref,
+            refId: decoder.currentRefId,
+            op: operation,
+            field: field,
+            value,
+            previousValue,
+        });
+    }
+};
+exports.decodeSchemaOperation = decodeSchemaOperation;
+const decodeKeyValueOperation = function (decoder, bytes, it, ref, allChanges) {
+    // "uncompressed" index + operation (array/map items)
+    const operation = bytes[it.offset++];
+    if (operation === spec_1.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[symbols_1.$childType];
+    let dynamicIndex;
+    if ((operation & spec_1.OPERATION.ADD) === spec_1.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,
+        });
+    }
+};
+exports.decodeKeyValueOperation = decodeKeyValueOperation;
+const decodeArray = function (decoder, bytes, it, ref, allChanges) {
+    // "uncompressed" index + operation (array/map items)
+    const operation = bytes[it.offset++];
+    if (operation === spec_1.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 === spec_1.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);
+        const index = ref.findIndex((value) => value === previousValue);
+        ref[symbols_1.$deleteByIndex](index);
+        allChanges.push({
+            ref,
+            refId: decoder.currentRefId,
+            op: spec_1.OPERATION.DELETE,
+            field: "", // FIXME: remove this
+            dynamicIndex: index,
+            value: undefined,
+            previousValue,
+        });
+        return;
+    }
+    const index = decode.number(bytes, it);
+    const type = ref[symbols_1.$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,
+        });
+    }
+};
+exports.decodeArray = decodeArray;
+//# sourceMappingURL=DecodeOperation.js.map

package/lib/decoder/DecodeOperation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DecodeOperation.js","sourceRoot":"","sources":["../../src/decoder/DecodeOperation.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAE7C,sCAAmC;AAGnC,6CAA6C;AAC7C,8CAAqF;AAMrF,gDAA4C;AAa/B,QAAA,mBAAmB,GAAG,CAAC,CAAC,CAAC;AAUtC,SAAgB,WAAW,CACvB,OAAgB,EAChB,SAAoB,EACpB,GAAQ,EACR,KAAa,EACb,IAAS,EACT,KAAa,EACb,EAAmB,EACnB,UAAwB;IAExB,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;IAC5B,MAAM,aAAa,GAAG,GAAG,CAAC,qBAAW,CAAC,CAAC,KAAK,CAAC,CAAC;IAE9C,IAAI,KAAU,CAAC;IAEf,IAAI,CAAC,SAAS,GAAG,gBAAS,CAAC,MAAM,CAAC,KAAK,gBAAS,CAAC,MAAM,EACvD,CAAC;QACG,uCAAuC;QACvC,MAAM,aAAa,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QACtD,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,gBAAS,CAAC,cAAc,EAAE,CAAC;YACzC,GAAG,CAAC,wBAAc,CAAC,CAAC,KAAK,CAAC,CAAC;YAE3B,KAAK;YACL,0CAA0C;YAC1C,wEAAwE;YACxE,iEAAiE;YACjE,KAAK;YACL,oBAAoB;YACpB,WAAW;YACX,mCAAmC;YACnC,4BAA4B;YAC5B,yCAAyC;YACzC,wBAAwB;YACxB,qBAAqB;YACrB,MAAM;QACV,CAAC;QAED,KAAK,GAAG,IAAI,CAAC;IACjB,CAAC;IAED,IAAI,SAAS,KAAK,gBAAS,CAAC,MAAM,EAAE,CAAC;QACjC,EAAE;QACF,oBAAoB;QACpB,EAAE;IAEN,CAAC;SAAM,IAAI,eAAM,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,aAAa,EAAE,CAAC;YAChB,MAAM,aAAa,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YACtD,IACI,aAAa;gBACb,KAAK,KAAK,aAAa;gBACvB,4DAA4D;gBAC5D,CAAC,CAAC,SAAS,GAAG,gBAAS,CAAC,MAAM,CAAC,KAAK,gBAAS,CAAC,MAAM,CAAC,EACvD,CAAC;gBACC,KAAK,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;YACnC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,SAAS,GAAG,gBAAS,CAAC,GAAG,CAAC,KAAK,gBAAS,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,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,KAAK,KAAK,aAAa,CAAC,CAAC,CAAC;QAC1D,CAAC;IAGL,CAAC;SAAM,IAAI,OAAM,CAAC,IAAI,CAAC,KAAK,QAAQ,EAAE,CAAC;QACnC,EAAE;QACF,iDAAiD;QACjD,EAAE;QACF,KAAK,GAAG,MAAM,CAAC,IAAc,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAE9C,CAAC;SAAM,CAAC;QACJ,MAAM,OAAO,GAAG,IAAA,kBAAO,EAAC,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,oBAAU,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,gDAAgD;QAE5F,IAAI,aAAa,EAAE,CAAC;YAChB,IAAI,aAAa,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YAEpD,IAAI,aAAa,KAAK,SAAS,IAAI,KAAK,KAAK,aAAa,EAAE,CAAC;gBACzD,KAAK,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;gBAE/B,EAAE;gBACF,mDAAmD;gBACnD,EAAE;gBACF,MAAM,OAAO,GAAiC,aAAa,CAAC,OAAO,EAAE,CAAC;gBACtE,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,kEAAkE;oBAClE,IAAI,OAAM,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,CAAC;wBAC7B,aAAa,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;wBACxC,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,gBAAS,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,CAAC,QAAQ,KAAK,aAAa,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;AACpC,CAAC;AAnID,kCAmIC;AAEM,MAAM,qBAAqB,GAAoB,UAClD,OAAqB,EACrB,KAAa,EACb,EAAmB,EACnB,GAAQ,EACR,UAAwB;IAExB,MAAM,UAAU,GAAG,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;IACtC,MAAM,QAAQ,GAAa,GAAG,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAE/D,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;QAAC,OAAO,2BAAmB,CAAC;IAAC,CAAC;IAExD,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,GAAG,WAAW,CACxC,OAAO,EACP,SAAS,EACT,GAAG,EACH,KAAK,EACL,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,EACpB,KAAK,EACL,EAAE,EACF,UAAU,CACb,CAAC;IAEF,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxC,GAAG,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;IACvB,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;YACZ,KAAK;YACL,aAAa;SAChB,CAAC,CAAC;IACP,CAAC;AACL,CAAC,CAAA;AA5CY,QAAA,qBAAqB,yBA4CjC;AAEM,MAAM,uBAAuB,GAAoB,UACpD,OAAqB,EACrB,KAAa,EACb,EAAmB,EACnB,GAAQ,EACR,UAAwB;IAExB,qDAAqD;IACrD,MAAM,SAAS,GAAG,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;IAErC,IAAI,SAAS,KAAK,gBAAS,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,GAAG,GAAG,CAAC,oBAAU,CAAC,CAAC;IAE7B,IAAI,YAA6B,CAAC;IAElC,IAAI,CAAC,SAAS,GAAG,gBAAS,CAAC,GAAG,CAAC,KAAK,gBAAS,CAAC,GAAG,EAAE,CAAC,CAAC,wBAAwB;QACzE,IAAI,OAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC;YACpC,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY;YACrD,GAAG,CAAC,UAAU,CAAC,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QACzC,CAAC;aAAM,CAAC;YACJ,YAAY,GAAG,KAAK,CAAC,CAAC,cAAc;QACxC,CAAC;IACL,CAAC;SAAM,CAAC;QACJ,+BAA+B;QAC/B,YAAY,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC;IAC1C,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,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC;YACpC,YAAY;YACX,GAAiB,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,YAAsB,EAAE,KAAK,CAAC,CAAC;QAEpE,CAAC;aAAM,IAAI,OAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC;YAC9C,cAAc;YACb,GAAmB,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;QAE5D,CAAC;aAAM,IAAI,OAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC;YAC3C,gCAAgC;YAChC,MAAM,KAAK,GAAI,GAAwB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAEnD,IAAI,OAAM,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,CAAC;gBAC7B,GAAG,CAAC,UAAU,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YAClC,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;AAjFY,QAAA,uBAAuB,2BAiFnC;AAEM,MAAM,WAAW,GAAoB,UACxC,OAAqB,EACrB,KAAa,EACb,EAAmB,EACnB,GAAgB,EAChB,UAAwB;IAExB,qDAAqD;IACrD,MAAM,SAAS,GAAG,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;IAErC,IAAI,SAAS,KAAK,gBAAS,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,gBAAS,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,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACpD,MAAM,KAAK,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,aAAa,CAAC,CAAC;QAChE,GAAG,CAAC,wBAAc,CAAC,CAAC,KAAK,CAAC,CAAC;QAC3B,UAAU,CAAC,IAAI,CAAC;YACZ,GAAG;YACH,KAAK,EAAE,OAAO,CAAC,YAAY;YAC3B,EAAE,EAAE,gBAAS,CAAC,MAAM;YACpB,KAAK,EAAE,EAAE,EAAE,qBAAqB;YAChC,YAAY,EAAE,KAAK;YACnB,KAAK,EAAE,SAAS;YAChB,aAAa;SAChB,CAAC,CAAC;QACH,OAAO;IACX,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACvC,MAAM,IAAI,GAAG,GAAG,CAAC,oBAAU,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;AA1EY,QAAA,WAAW,eA0EvB","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 * as decode from \"../encoding/decode\";\nimport { $changes, $childType, $deleteByIndex, $getByIndex } 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: Buffer,\n    it: decode.Iterator,\n    ref: Ref,\n    allChanges: DataChange[],\n) => number | void;\n\nexport function decodeValue(\n    decoder: Decoder,\n    operation: OPERATION,\n    ref: Ref,\n    index: number,\n    type: any,\n    bytes: Buffer,\n    it: decode.Iterator,\n    allChanges: DataChange[],\n) {\n    const $root = decoder.$root;\n    const previousValue = ref[$getByIndex](index);\n\n    let value: any;\n\n    if ((operation & OPERATION.DELETE) === OPERATION.DELETE)\n    {\n        // Flag `refId` for garbage collection.\n        const previousRefId = $root.refIds.get(previousValue);\n        if (previousRefId !== undefined) { $root.removeRef(previousRefId); }\n\n        //\n        // Delete operations\n        //\n        if (operation !== OPERATION.DELETE_AND_ADD) {\n            ref[$deleteByIndex](index);\n\n            // //\n            // // FIXME: is this in the correct place?\n            // //      (This is sounding like a workaround just for ArraySchema, see\n            // //       \"should splice and move\" test on ArraySchema.test.ts)\n            // //\n            // allChanges.push({\n            //     ref,\n            //     refId: decoder.currentRefId,\n            //     op: OPERATION.DELETE,\n            //     field: index as unknown as string,\n            //     value: undefined,\n            //     previousValue,\n            // });\n        }\n\n        value = null;\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 (previousValue) {\n            const previousRefId = $root.refIds.get(previousValue);\n            if (\n                previousRefId &&\n                refId !== previousRefId &&\n                // FIXME: we may need to check for REPLACE operation as well\n                ((operation & OPERATION.DELETE) === OPERATION.DELETE)\n            ) {\n                $root.removeRef(previousRefId);\n            }\n        }\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(refId, value, (value !== previousValue));\n        }\n\n\n    } else if (typeof(type) === \"string\") {\n        //\n        // primitive value (number, string, boolean, etc)\n        //\n        value = decode[type as string](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 = $root.refIds.get(previousValue);\n\n            if (previousRefId !== undefined && refId !== previousRefId) {\n                $root.removeRef(previousRefId);\n\n                //\n                // enqueue onRemove if structure has been replaced.\n                //\n                const entries: IterableIterator<[any, any]> = previousValue.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                    // FIXME: not sure if this is necessary, add more tests to confirm\n                    if (typeof(value) === \"object\") {\n                        previousRefId = $root.refIds.get(value);\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, (valueRef !== previousValue));\n    }\n\n    return { value, previousValue };\n}\n\nexport const decodeSchemaOperation: DecodeOperation = function (\n    decoder: Decoder<any>,\n    bytes: Buffer,\n    it: decode.Iterator,\n    ref: Ref,\n    allChanges: DataChange[],\n) {\n    const first_byte = bytes[it.offset++];\n    const metadata: Metadata = ref['constructor'][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) { return DEFINITION_MISMATCH; }\n\n    const { value, previousValue } = decodeValue(\n        decoder,\n        operation,\n        ref,\n        index,\n        metadata[field].type,\n        bytes,\n        it,\n        allChanges,\n    );\n\n    if (value !== null && value !== undefined) {\n        ref[field] = 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,\n            value,\n            previousValue,\n        });\n    }\n}\n\nexport const decodeKeyValueOperation: DecodeOperation = function (\n    decoder: Decoder<any>,\n    bytes: Buffer,\n    it: decode.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[$childType];\n\n    let dynamicIndex: number | string;\n\n    if ((operation & OPERATION.ADD) === OPERATION.ADD) { // ADD or DELETE_AND_ADD\n        if (typeof(ref['set']) === \"function\") {\n            dynamicIndex = decode.string(bytes, it); // MapSchema\n            ref['setIndex'](index, dynamicIndex);\n        } else {\n            dynamicIndex = index; // ArraySchema\n        }\n    } else {\n        // get dynamic index from \"ref\"\n        dynamicIndex = ref['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['set']) === \"function\") {\n            // MapSchema\n            (ref as MapSchema)['$items'].set(dynamicIndex as string, value);\n\n        } else if (typeof(ref['$setAt']) === \"function\") {\n            // ArraySchema\n            (ref as ArraySchema)['$setAt'](index, value, operation);\n\n        } else if (typeof(ref['add']) === \"function\") {\n            // CollectionSchema && SetSchema\n            const index = (ref as CollectionSchema).add(value);\n\n            if (typeof(index) === \"number\") {\n                ref['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: Buffer,\n    it: decode.Iterator,\n    ref: ArraySchema,\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        (ref as ArraySchema).clear();\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        const 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        return;\n    }\n\n    const index = decode.number(bytes, it);\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/decoder/Decoder.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="node" />
+import { TypeContext } from "../annotations";
+import { Schema } from "../Schema";
+import { Ref } from "../encoder/ChangeTree";
+import { Iterator } from "../encoding/decode";
+import { ReferenceTracker } from "./ReferenceTracker";
+import { 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 setRoot(root: T): void;
+    decode(bytes: Buffer, it?: Iterator, ref?: Ref): DataChange<any, string>[];
+    getInstanceType(bytes: Buffer, it: Iterator, defaultType: typeof Schema): typeof Schema;
+    createInstanceOfType(type: typeof Schema): Schema;
+    removeChildRefs(ref: Collection, allChanges: DataChange[]): void;
+}

package/lib/decoder/Decoder.js

@@ -0,0 +1,114 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Decoder = void 0;
+const annotations_1 = require("../annotations");
+const symbols_1 = require("../types/symbols");
+const decode = require("../encoding/decode");
+const spec_1 = require("../encoding/spec");
+const ReferenceTracker_1 = require("./ReferenceTracker");
+const DecodeOperation_1 = require("./DecodeOperation");
+class Decoder {
+    constructor(root, context) {
+        this.currentRefId = 0;
+        this.setRoot(root);
+        this.context = context || new annotations_1.TypeContext(root.constructor);
+        // console.log(">>>>>>>>>>>>>>>> Decoder types");
+        // this.context.schemas.forEach((id, schema) => {
+        //     console.log("type:", id, schema.name, Object.keys(schema[Symbol.metadata]));
+        // });
+    }
+    setRoot(root) {
+        this.state = root;
+        this.$root = new ReferenceTracker_1.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'][symbols_1.$decoder];
+        this.currentRefId = 0;
+        while (it.offset < totalBytes) {
+            //
+            // Peek ahead, check if it's a switch to a different structure
+            //
+            if (bytes[it.offset] == spec_1.SWITCH_TO_STRUCTURE) {
+                it.offset++;
+                this.currentRefId = decode.number(bytes, it);
+                const nextRef = $root.refs.get(this.currentRefId);
+                //
+                // Trying to access a reference that haven't been decoded yet.
+                //
+                if (!nextRef) {
+                    throw new Error(`"refId" not found: ${this.currentRefId}`);
+                }
+                ref[symbols_1.$onDecodeEnd]?.();
+                ref = nextRef;
+                decoder = ref['constructor'][symbols_1.$decoder];
+                continue;
+            }
+            const result = decoder(this, bytes, it, ref, allChanges);
+            if (result === DecodeOperation_1.DEFINITION_MISMATCH) {
+                console.warn("@colyseus/schema: definition mismatch");
+                //
+                // keep skipping next bytes until reaches a known structure
+                // by local decoder.
+                //
+                const nextIterator = { offset: it.offset };
+                while (it.offset < totalBytes) {
+                    if (decode.switchStructureCheck(bytes, it)) {
+                        nextIterator.offset = it.offset + 1;
+                        if ($root.refs.has(decode.number(bytes, nextIterator))) {
+                            break;
+                        }
+                    }
+                    it.offset++;
+                }
+                continue;
+            }
+        }
+        // FIXME: DRY with SWITCH_TO_STRUCTURE block.
+        ref[symbols_1.$onDecodeEnd]?.();
+        // trigger changes
+        this.triggerChanges?.(allChanges);
+        // drop references of unused schemas
+        $root.garbageCollectDeletedRefs();
+        return allChanges;
+    }
+    getInstanceType(bytes, it, defaultType) {
+        let type;
+        if (bytes[it.offset] === spec_1.TYPE_ID) {
+            it.offset++;
+            const type_id = decode.number(bytes, it);
+            type = this.context.get(type_id);
+        }
+        return type || defaultType;
+    }
+    createInstanceOfType(type) {
+        // let instance: Schema = new (type as any)();
+        // // assign root on $changes
+        // instance[$changes].root = this.root[$changes].root;
+        // return instance;
+        return new type();
+    }
+    removeChildRefs(ref, allChanges) {
+        const changeTree = ref[symbols_1.$changes];
+        const needRemoveRef = typeof (ref[symbols_1.$childType]) !== "string";
+        const refId = changeTree.refId;
+        ref.forEach((value, key) => {
+            allChanges.push({
+                ref: value,
+                refId,
+                op: spec_1.OPERATION.DELETE,
+                field: key,
+                value: undefined,
+                previousValue: value
+            });
+            if (needRemoveRef) {
+                this.$root.removeRef(this.$root.refIds.get(value));
+            }
+        });
+    }
+}
+exports.Decoder = Decoder;
+//# sourceMappingURL=Decoder.js.map

package/lib/decoder/Decoder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Decoder.js","sourceRoot":"","sources":["../../src/decoder/Decoder.ts"],"names":[],"mappings":";;;AAAA,gDAA6C;AAC7C,8CAAgF;AAGhF,6CAA6C;AAC7C,2CAA2E;AAG3E,yDAAsD;AACtD,uDAAqF;AAGrF,MAAa,OAAO;IAUhB,YAAY,IAAO,EAAE,OAAqB;QAJ1C,iBAAY,GAAW,CAAC,CAAC;QAKrB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,IAAI,yBAAW,CAAC,IAAI,CAAC,WAA4B,CAAC,CAAC;QAE7E,iDAAiD;QACjD,iDAAiD;QACjD,mFAAmF;QACnF,MAAM;IACV,CAAC;IAES,OAAO,CAAC,IAAO;QACrB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,IAAI,mCAAgB,EAAE,CAAC;QACpC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM,CACF,KAAa,EACb,KAAe,EAAE,MAAM,EAAE,CAAC,EAAE,EAC5B,MAAW,IAAI,CAAC,KAAK;QAErB,MAAM,UAAU,GAAiB,EAAE,CAAC;QAEpC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACzB,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QAEpC,IAAI,OAAO,GAAoB,GAAG,CAAC,aAAa,CAAC,CAAC,kBAAQ,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,0BAAmB,EAAE,CAAC;gBAC1C,EAAE,CAAC,MAAM,EAAE,CAAC;gBAEZ,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBAC7C,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAW,CAAC;gBAE5D,EAAE;gBACF,8DAA8D;gBAC9D,EAAE;gBACF,IAAI,CAAC,OAAO,EAAE,CAAC;oBAAC,MAAM,IAAI,KAAK,CAAC,sBAAsB,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;gBAAC,CAAC;gBAC7E,GAAG,CAAC,sBAAY,CAAC,EAAE,EAAE,CAAA;gBACrB,GAAG,GAAG,OAAO,CAAC;gBACd,OAAO,GAAG,GAAG,CAAC,aAAa,CAAC,CAAC,kBAAQ,CAAC,CAAC;gBAEvC,SAAS;YACb,CAAC;YAED,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;YAEzD,IAAI,MAAM,KAAK,qCAAmB,EAAE,CAAC;gBACjC,OAAO,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;gBAEtD,EAAE;gBACF,2DAA2D;gBAC3D,oBAAoB;gBACpB,EAAE;gBACF,MAAM,YAAY,GAAoB,EAAE,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC;gBAC5D,OAAO,EAAE,CAAC,MAAM,GAAG,UAAU,EAAE,CAAC;oBAC5B,IAAI,MAAM,CAAC,oBAAoB,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC;wBACzC,YAAY,CAAC,MAAM,GAAG,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;wBACpC,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC;4BACrD,MAAM;wBACV,CAAC;oBACL,CAAC;oBAED,EAAE,CAAC,MAAM,EAAE,CAAC;gBAChB,CAAC;gBACD,SAAS;YACb,CAAC;QACL,CAAC;QAED,6CAA6C;QAC7C,GAAG,CAAC,sBAAY,CAAC,EAAE,EAAE,CAAA;QAErB,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,eAAe,CAAC,KAAa,EAAE,EAAY,EAAE,WAA0B;QACnE,IAAI,IAAmB,CAAC;QAExB,IAAI,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,cAAO,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,8CAA8C;QAE9C,6BAA6B;QAC7B,sDAAsD;QAEtD,mBAAmB;QACnB,OAAO,IAAK,IAAY,EAAE,CAAC;IAC/B,CAAC;IAED,eAAe,CAAC,GAAe,EAAE,UAAwB;QACrD,MAAM,UAAU,GAAG,GAAG,CAAC,kBAAQ,CAAC,CAAC;QAEjC,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,oBAAU,CAAC,CAAC,KAAK,QAAQ,CAAC;QAC5D,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;QAE/B,GAAG,CAAC,OAAO,CAAC,CAAC,KAAU,EAAE,GAAQ,EAAE,EAAE;YACjC,UAAU,CAAC,IAAI,CAAC;gBACZ,GAAG,EAAE,KAAK;gBACV,KAAK;gBACL,EAAE,EAAE,gBAAS,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,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;YACvD,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;CAEJ;AA7ID,0BA6IC","sourcesContent":["import { TypeContext } from \"../annotations\";\nimport { $changes, $childType, $decoder, $onDecodeEnd } from \"../types/symbols\";\nimport { Schema } from \"../Schema\";\n\nimport * as decode from \"../encoding/decode\";\nimport { OPERATION, SWITCH_TO_STRUCTURE, TYPE_ID } from '../encoding/spec';\nimport { Ref } from \"../encoder/ChangeTree\";\nimport { Iterator } from \"../encoding/decode\";\nimport { ReferenceTracker } from \"./ReferenceTracker\";\nimport { DEFINITION_MISMATCH, DataChange, 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.setRoot(root);\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 setRoot(root: T) {\n        this.state = root;\n        this.$root = new ReferenceTracker();\n        this.$root.addRef(0, root);\n    }\n\n    decode(\n        bytes: Buffer,\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                this.currentRefId = decode.number(bytes, it);\n                const nextRef = $root.refs.get(this.currentRefId) as Schema;\n\n                //\n                // Trying to access a reference that haven't been decoded yet.\n                //\n                if (!nextRef) { throw new Error(`\"refId\" not found: ${this.currentRefId}`); }\n                ref[$onDecodeEnd]?.()\n                ref = nextRef;\n                decoder = ref['constructor'][$decoder];\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\n                //\n                // keep skipping next bytes until reaches a known structure\n                // by local decoder.\n                //\n                const nextIterator: decode.Iterator = { offset: it.offset };\n                while (it.offset < totalBytes) {\n                    if (decode.switchStructureCheck(bytes, it)) {\n                        nextIterator.offset = it.offset + 1;\n                        if ($root.refs.has(decode.number(bytes, nextIterator))) {\n                            break;\n                        }\n                    }\n\n                    it.offset++;\n                }\n                continue;\n            }\n        }\n\n        // FIXME: DRY with SWITCH_TO_STRUCTURE block.\n        ref[$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    getInstanceType(bytes: Buffer, 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        // let instance: Schema = new (type as any)();\n\n        // // assign root on $changes\n        // instance[$changes].root = this.root[$changes].root;\n\n        // return instance;\n        return new (type as any)();\n    }\n\n    removeChildRefs(ref: Collection, allChanges: DataChange[]) {\n        const changeTree = ref[$changes];\n\n        const needRemoveRef = typeof (ref[$childType]) !== \"string\";\n        const refId = changeTree.refId;\n\n        ref.forEach((value: any, key: any) => {\n            allChanges.push({\n                ref: value,\n                refId,\n                op: OPERATION.DELETE,\n                field: key,\n                value: undefined,\n                previousValue: value\n            });\n\n            if (needRemoveRef) {\n                this.$root.removeRef(this.$root.refIds.get(value));\n            }\n        });\n    }\n\n}\n\n"]}

package/lib/decoder/ReferenceTracker.d.ts

@@ -0,0 +1,26 @@
+import { Ref } from "../encoder/ChangeTree";
+/**
+ * Used for decoding only.
+ */
+export type SchemaCallbacks = {
+    [field: string | number]: Function[];
+};
+export declare class ReferenceTracker {
+    refs: Map<number, Ref>;
+    refIds: WeakMap<Ref, number>;
+    refCounts: {
+        [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/decoder/ReferenceTracker.js

@@ -0,0 +1,131 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReferenceTracker = void 0;
+const Metadata_1 = require("../Metadata");
+const symbols_1 = require("../types/symbols");
+const utils_1 = require("../types/utils");
+const spec_1 = require("../encoding/spec");
+class DecodingWarning extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "DecodingWarning";
+    }
+}
+class ReferenceTracker {
+    constructor() {
+        //
+        // Relation of refId => Schema structure
+        // For direct access of structures during decoding time.
+        //
+        this.refs = new Map();
+        this.refIds = new WeakMap();
+        this.refCounts = {};
+        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);
+        this.refIds.set(ref, refId);
+        if (incrementCount) {
+            this.refCounts[refId] = (this.refCounts[refId] || 0) + 1;
+        }
+        if (this.deletedRefs.has(refId)) {
+            this.deletedRefs.delete(refId);
+        }
+    }
+    // for decoding
+    removeRef(refId) {
+        const refCount = this.refCounts[refId];
+        if (refCount === undefined) {
+            try {
+                throw new DecodingWarning("trying to remove refId that doesn't exist");
+            }
+            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.refCounts[refId] = refCount - 1) <= 0) {
+            this.deletedRefs.add(refId);
+        }
+    }
+    clearRefs() {
+        this.refs.clear();
+        this.deletedRefs.clear();
+        this.refCounts = {};
+    }
+    // for decoding
+    garbageCollectDeletedRefs() {
+        this.deletedRefs.forEach((refId) => {
+            //
+            // Skip active references.
+            //
+            if (this.refCounts[refId] > 0) {
+                return;
+            }
+            const ref = this.refs.get(refId);
+            //
+            // Ensure child schema instances have their references removed as well.
+            //
+            if (Metadata_1.Metadata.isValidInstance(ref)) {
+                const metadata = ref['constructor'][Symbol.metadata];
+                for (const field in metadata) {
+                    const childRefId = typeof (ref[field]) === "object" && this.refIds.get(ref[field]);
+                    if (childRefId) {
+                        this.removeRef(childRefId);
+                    }
+                }
+            }
+            else {
+                if (typeof (Object.values(ref[symbols_1.$childType])[0]) === "function") {
+                    Array.from(ref.values())
+                        .forEach((child) => this.removeRef(this.refIds.get(child)));
+                }
+            }
+            this.refs.delete(refId); // remove ref
+            delete this.refCounts[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")
+                ? spec_1.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 !== -1) {
+            (0, utils_1.spliceOne)(this.callbacks[refId][field], index);
+        }
+    }
+}
+exports.ReferenceTracker = ReferenceTracker;
+//# sourceMappingURL=ReferenceTracker.js.map

package/lib/decoder/ReferenceTracker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReferenceTracker.js","sourceRoot":"","sources":["../../src/decoder/ReferenceTracker.ts"],"names":[],"mappings":";;;AAAA,0CAAuC;AACvC,8CAA8C;AAE9C,0CAA2C;AAE3C,2CAA6C;AAE7C,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,MAAa,gBAAgB;IAA7B;QACI,EAAE;QACF,wCAAwC;QACxC,wDAAwD;QACxD,EAAE;QACK,SAAI,GAAG,IAAI,GAAG,EAAe,CAAC;QAC9B,WAAM,GAAG,IAAI,OAAO,EAAe,CAAC;QAEpC,cAAS,GAAiC,EAAE,CAAC;QAC7C,gBAAW,GAAG,IAAI,GAAG,EAAU,CAAC;QAEhC,cAAS,GAAyC,EAAE,CAAC;QAClD,iBAAY,GAAW,CAAC,CAAC;IAsHvC,CAAC;IApHG,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,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAE5B,IAAI,cAAc,EAAE,CAAC;YACjB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QAC7D,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,SAAS,CAAC,KAAK,CAAC,CAAC;QAEvC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzB,IAAI,CAAC;gBACD,MAAM,IAAI,eAAe,CAAC,2CAA2C,CAAC,CAAC;YAC3E,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,SAAS,CAAC,KAAK,CAAC,GAAG,QAAQ,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9C,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;IACxB,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,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBAAC,OAAO;YAAC,CAAC;YAE1C,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAEjC,EAAE;YACF,uEAAuE;YACvE,EAAE;YACF,IAAI,mBAAQ,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChC,MAAM,QAAQ,GAAa,GAAG,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;gBAC/D,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;oBAC3B,MAAM,UAAU,GAAG,OAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;oBAClF,IAAI,UAAU,EAAE,CAAC;wBACb,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;oBAC/B,CAAC;gBACL,CAAC;YAEL,CAAC;iBAAM,CAAC;gBACJ,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,oBAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC;oBAC5D,KAAK,CAAC,IAAI,CAAE,GAAiB,CAAC,MAAM,EAAE,CAAC;yBAClC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACpE,CAAC;YACL,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,aAAa;YACtC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,mBAAmB;YACjD,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,gBAAS,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,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QAClE,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACf,IAAA,iBAAS,EAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;QACnD,CAAC;IACL,CAAC;CAEJ;AAlID,4CAkIC","sourcesContent":["import { Metadata } from \"../Metadata\";\nimport { $childType } from \"../types/symbols\";\nimport { Ref } from \"../encoder/ChangeTree\";\nimport { spliceOne } from \"../types/utils\";\nimport type { MapSchema } from \"../types/custom/MapSchema\";\nimport { OPERATION } from \"../encoding/spec\";\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    public refIds = new WeakMap<Ref, number>();\n\n    public refCounts: { [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        this.refIds.set(ref, refId);\n\n        if (incrementCount) {\n            this.refCounts[refId] = (this.refCounts[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.refCounts[refId];\n\n        if (refCount === undefined) {\n            try {\n                throw new DecodingWarning(\"trying to remove refId that doesn't exist\");\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.refCounts[refId] = refCount - 1) <= 0) {\n            this.deletedRefs.add(refId);\n        }\n    }\n\n    clearRefs() {\n        this.refs.clear();\n        this.deletedRefs.clear();\n        this.refCounts = {};\n    }\n\n    // for decoding\n    garbageCollectDeletedRefs() {\n        this.deletedRefs.forEach((refId) => {\n            //\n            // Skip active references.\n            //\n            if (this.refCounts[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 (Metadata.isValidInstance(ref)) {\n                const metadata: Metadata = ref['constructor'][Symbol.metadata];\n                for (const field in metadata) {\n                    const childRefId = typeof(ref[field]) === \"object\" && this.refIds.get(ref[field]);\n                    if (childRefId) {\n                        this.removeRef(childRefId);\n                    }\n                }\n\n            } else {\n                if (typeof (Object.values(ref[$childType])[0]) === \"function\") {\n                    Array.from((ref as MapSchema).values())\n                        .forEach((child) => this.removeRef(this.refIds.get(child)));\n                }\n            }\n\n            this.refs.delete(refId); // remove ref\n            delete this.refCounts[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 = this.callbacks?.[refId]?.[field]?.indexOf(callback);\n        if (index !== -1) {\n            spliceOne(this.callbacks[refId][field], index);\n        }\n    }\n\n}"]}