@colyseus/schema 4.0.0 → 4.0.2

package/lib/src/encoder/EncodeOperation.js

@@ -0,0 +1,132 @@
+import { OPERATION } from "../encoding/spec";
+import { $childType, $getByIndex, $refId } from "../types/symbols";
+import { encode } from "../encoding/encode";
+export function encodeValue(encoder, bytes, type, value, operation, it) {
+    if (typeof (type) === "string") {
+        encode[type]?.(bytes, value, it);
+    }
+    else if (type[Symbol.metadata] !== undefined) {
+        //
+        // Encode refId for this instance.
+        // The actual instance is going to be encoded on next `changeTree` iteration.
+        //
+        encode.number(bytes, value[$refId], it);
+        // Try to encode inherited TYPE_ID if it's an ADD operation.
+        if ((operation & OPERATION.ADD) === OPERATION.ADD) {
+            encoder.tryEncodeTypeId(bytes, type, value.constructor, it);
+        }
+    }
+    else {
+        //
+        // Encode refId for this instance.
+        // The actual instance is going to be encoded on next `changeTree` iteration.
+        //
+        encode.number(bytes, value[$refId], it);
+    }
+}
+/**
+ * Used for Schema instances.
+ * @private
+ */
+export const encodeSchemaOperation = function (encoder, bytes, changeTree, index, operation, it, _, __, metadata) {
+    // "compress" field index + operation
+    bytes[it.offset++] = (index | operation) & 255;
+    // Do not encode value for DELETE operations
+    if (operation === OPERATION.DELETE) {
+        return;
+    }
+    const ref = changeTree.ref;
+    const field = metadata[index];
+    // TODO: inline this function call small performance gain
+    encodeValue(encoder, bytes, metadata[index].type, ref[field.name], operation, it);
+};
+/**
+ * Used for collections (MapSchema, CollectionSchema, SetSchema)
+ * @private
+ */
+export const encodeKeyValueOperation = function (encoder, bytes, changeTree, index, operation, it) {
+    // encode operation
+    bytes[it.offset++] = operation & 255;
+    // encode index
+    encode.number(bytes, index, it);
+    // Do not encode value for DELETE operations
+    if (operation === OPERATION.DELETE) {
+        return;
+    }
+    const ref = changeTree.ref;
+    //
+    // encode "alias" for dynamic fields (maps)
+    //
+    if ((operation & OPERATION.ADD) === OPERATION.ADD) { // ADD or DELETE_AND_ADD
+        if (typeof (ref['set']) === "function") {
+            //
+            // MapSchema dynamic key
+            //
+            const dynamicIndex = changeTree.ref['$indexes'].get(index);
+            encode.string(bytes, dynamicIndex, it);
+        }
+    }
+    const type = ref[$childType];
+    const value = ref[$getByIndex](index);
+    // try { throw new Error(); } catch (e) {
+    //     // only print if not coming from Reflection.ts
+    //     if (!e.stack.includes("src/Reflection.ts")) {
+    //         console.log("encodeKeyValueOperation -> ", {
+    //             ref: changeTree.ref.constructor.name,
+    //             field,
+    //             operation: OPERATION[operation],
+    //             value: value?.toJSON(),
+    //             items: ref.toJSON(),
+    //         });
+    //     }
+    // }
+    // TODO: inline this function call small performance gain
+    encodeValue(encoder, bytes, type, value, operation, it);
+};
+/**
+ * Used for collections (MapSchema, ArraySchema, etc.)
+ * @private
+ */
+export const encodeArray = function (encoder, bytes, changeTree, field, operation, it, isEncodeAll, hasView) {
+    const ref = changeTree.ref;
+    const useOperationByRefId = hasView && changeTree.isFiltered && (typeof (changeTree.getType(field)) !== "string");
+    let refOrIndex;
+    if (useOperationByRefId) {
+        const item = ref['tmpItems'][field];
+        // Skip encoding if item is undefined (e.g. when clear() is called)
+        if (!item) {
+            return;
+        }
+        refOrIndex = item[$refId];
+        if (operation === OPERATION.DELETE) {
+            operation = OPERATION.DELETE_BY_REFID;
+        }
+        else if (operation === OPERATION.ADD) {
+            operation = OPERATION.ADD_BY_REFID;
+        }
+    }
+    else {
+        refOrIndex = field;
+    }
+    // encode operation
+    bytes[it.offset++] = operation & 255;
+    // encode index
+    encode.number(bytes, refOrIndex, it);
+    // Do not encode value for DELETE operations
+    if (operation === OPERATION.DELETE || operation === OPERATION.DELETE_BY_REFID) {
+        return;
+    }
+    const type = changeTree.getType(field);
+    const value = changeTree.getValue(field, isEncodeAll);
+    // console.log({ type, field, value });
+    // console.log("encodeArray -> ", {
+    //     ref: changeTree.ref.constructor.name,
+    //     field,
+    //     operation: OPERATION[operation],
+    //     value: value?.toJSON(),
+    //     items: ref.toJSON(),
+    // });
+    // TODO: inline this function call small performance gain
+    encodeValue(encoder, bytes, type, value, operation, it);
+};
+//# sourceMappingURL=EncodeOperation.js.map

package/lib/src/encoder/EncodeOperation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EncodeOperation.js","sourceRoot":"","sources":["../../../src/encoder/EncodeOperation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAY,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE7E,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAsB5C,MAAM,UAAU,WAAW,CACvB,OAAgB,EAChB,KAAiB,EACjB,IAAS,EACT,KAAU,EACV,SAAoB,EACpB,EAAY;IAEZ,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,QAAQ,EAAE,CAAC;QAC5B,MAAc,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;IAE9C,CAAC;SAAM,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,SAAS,EAAE,CAAC;QAC7C,EAAE;QACF,kCAAkC;QAClC,6EAA6E;QAC7E,EAAE;QACF,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;QAExC,4DAA4D;QAC5D,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,GAAG,EAAE,CAAC;YAChD,OAAO,CAAC,eAAe,CAAC,KAAK,EAAE,IAAqB,EAAE,KAAK,CAAC,WAA4B,EAAE,EAAE,CAAC,CAAC;QAClG,CAAC;IAEL,CAAC;SAAM,CAAC;QACJ,EAAE;QACF,kCAAkC;QAClC,6EAA6E;QAC7E,EAAE;QACF,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;IAC5C,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAoB,UAClD,OAAgB,EAChB,KAAiB,EACjB,UAAyB,EACzB,KAAa,EACb,SAAoB,EACpB,EAAY,EACZ,CAAM,EACN,EAAO,EACP,QAAkB;IAElB,qCAAqC;IACrC,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,KAAK,GAAG,SAAS,CAAC,GAAG,GAAG,CAAC;IAE/C,4CAA4C;IAC5C,IAAI,SAAS,KAAK,SAAS,CAAC,MAAM,EAAE,CAAC;QACjC,OAAO;IACX,CAAC;IAED,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC;IAC3B,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAE9B,yDAAyD;IACzD,WAAW,CACP,OAAO,EACP,KAAK,EACL,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,EACpB,GAAG,CAAC,KAAK,CAAC,IAAe,CAAC,EAC1B,SAAS,EACT,EAAE,CACL,CAAC;AACN,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAoB,UACpD,OAAgB,EAChB,KAAiB,EACjB,UAAsB,EACtB,KAAa,EACb,SAAoB,EACpB,EAAY;IAEZ,mBAAmB;IACnB,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,SAAS,GAAG,GAAG,CAAC;IAErC,eAAe;IACf,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;IAEhC,4CAA4C;IAC5C,IAAI,SAAS,KAAK,SAAS,CAAC,MAAM,EAAE,CAAC;QACjC,OAAO;IACX,CAAC;IAED,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC;IAE3B,EAAE;IACF,2CAA2C;IAC3C,EAAE;IACF,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,wBAAwB;QACzE,IAAI,OAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC;YACpC,EAAE;YACF,wBAAwB;YACxB,EAAE;YACF,MAAM,YAAY,GAAG,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAC3D,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC;QAC3C,CAAC;IACL,CAAC;IAED,MAAM,IAAI,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC;IAC7B,MAAM,KAAK,GAAG,GAAG,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC;IAEtC,yCAAyC;IACzC,qDAAqD;IACrD,oDAAoD;IACpD,uDAAuD;IACvD,oDAAoD;IACpD,qBAAqB;IACrB,+CAA+C;IAC/C,sCAAsC;IACtC,mCAAmC;IACnC,cAAc;IACd,QAAQ;IACR,IAAI;IAEJ,yDAAyD;IACzD,WAAW,CACP,OAAO,EACP,KAAK,EACL,IAAI,EACJ,KAAK,EACL,SAAS,EACT,EAAE,CACL,CAAC;AACN,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAoB,UACxC,OAAgB,EAChB,KAAiB,EACjB,UAAmC,EACnC,KAAa,EACb,SAAoB,EACpB,EAAY,EACZ,WAAoB,EACpB,OAAgB;IAEhB,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC;IAC3B,MAAM,mBAAmB,GAAG,OAAO,IAAI,UAAU,CAAC,UAAU,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC;IAElH,IAAI,UAAkB,CAAC;IAEvB,IAAI,mBAAmB,EAAE,CAAC;QACtB,MAAM,IAAI,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC;QAEpC,mEAAmE;QACnE,IAAI,CAAC,IAAI,EAAE,CAAC;YAAC,OAAO;QAAC,CAAC;QAEtB,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QAE1B,IAAI,SAAS,KAAK,SAAS,CAAC,MAAM,EAAE,CAAC;YACjC,SAAS,GAAG,SAAS,CAAC,eAAe,CAAC;QAE1C,CAAC;aAAM,IAAI,SAAS,KAAK,SAAS,CAAC,GAAG,EAAE,CAAC;YACrC,SAAS,GAAG,SAAS,CAAC,YAAY,CAAC;QACvC,CAAC;IAEL,CAAC;SAAM,CAAC;QACJ,UAAU,GAAG,KAAK,CAAC;IACvB,CAAC;IAED,mBAAmB;IACnB,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,SAAS,GAAG,GAAG,CAAC;IAErC,eAAe;IACf,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;IAErC,4CAA4C;IAC5C,IAAI,SAAS,KAAK,SAAS,CAAC,MAAM,IAAI,SAAS,KAAK,SAAS,CAAC,eAAe,EAAE,CAAC;QAC5E,OAAO;IACX,CAAC;IAED,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACvC,MAAM,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IAEtD,uCAAuC;IAEvC,mCAAmC;IACnC,4CAA4C;IAC5C,aAAa;IACb,uCAAuC;IACvC,8BAA8B;IAC9B,2BAA2B;IAC3B,MAAM;IAEN,yDAAyD;IACzD,WAAW,CACP,OAAO,EACP,KAAK,EACL,IAAI,EACJ,KAAK,EACL,SAAS,EACT,EAAE,CACL,CAAC;AACN,CAAC,CAAA","sourcesContent":["import { OPERATION } from \"../encoding/spec\";\nimport { $changes, $childType, $getByIndex, $refId } from \"../types/symbols\";\n\nimport { encode } from \"../encoding/encode\";\n\nimport type { ChangeTree, Ref } from \"./ChangeTree\";\nimport type { Encoder } from \"./Encoder\";\nimport type { Schema } from \"../Schema\";\n\nimport type { Iterator } from \"../encoding/decode\";\nimport type { ArraySchema } from \"../types/custom/ArraySchema\";\nimport type { Metadata } from \"../Metadata\";\n\nexport type EncodeOperation<T extends Ref = any> = (\n    encoder: Encoder,\n    bytes: Uint8Array,\n    changeTree: ChangeTree<T>,\n    index: number,\n    operation: OPERATION,\n    it: Iterator,\n    isEncodeAll: boolean,\n    hasView: boolean,\n    metadata?: Metadata,\n) => void;\n\nexport function encodeValue(\n    encoder: Encoder,\n    bytes: Uint8Array,\n    type: any,\n    value: any,\n    operation: OPERATION,\n    it: Iterator,\n) {\n    if (typeof (type) === \"string\") {\n        (encode as any)[type]?.(bytes, value, it);\n\n    } else if (type[Symbol.metadata] !== undefined) {\n        //\n        // Encode refId for this instance.\n        // The actual instance is going to be encoded on next `changeTree` iteration.\n        //\n        encode.number(bytes, value[$refId], it);\n\n        // Try to encode inherited TYPE_ID if it's an ADD operation.\n        if ((operation & OPERATION.ADD) === OPERATION.ADD) {\n            encoder.tryEncodeTypeId(bytes, type as typeof Schema, value.constructor as typeof Schema, it);\n        }\n\n    } else {\n        //\n        // Encode refId for this instance.\n        // The actual instance is going to be encoded on next `changeTree` iteration.\n        //\n        encode.number(bytes, value[$refId], it);\n    }\n}\n\n/**\n * Used for Schema instances.\n * @private\n */\nexport const encodeSchemaOperation: EncodeOperation = function <T extends Schema> (\n    encoder: Encoder,\n    bytes: Uint8Array,\n    changeTree: ChangeTree<T>,\n    index: number,\n    operation: OPERATION,\n    it: Iterator,\n    _: any,\n    __: any,\n    metadata: Metadata,\n) {\n    // \"compress\" field index + operation\n    bytes[it.offset++] = (index | operation) & 255;\n\n    // Do not encode value for DELETE operations\n    if (operation === OPERATION.DELETE) {\n        return;\n    }\n\n    const ref = changeTree.ref;\n    const field = metadata[index];\n\n    // TODO: inline this function call small performance gain\n    encodeValue(\n        encoder,\n        bytes,\n        metadata[index].type,\n        ref[field.name as keyof T],\n        operation,\n        it\n    );\n}\n\n/**\n * Used for collections (MapSchema, CollectionSchema, SetSchema)\n * @private\n */\nexport const encodeKeyValueOperation: EncodeOperation = function (\n    encoder: Encoder,\n    bytes: Uint8Array,\n    changeTree: ChangeTree,\n    index: number,\n    operation: OPERATION,\n    it: Iterator,\n) {\n    // encode operation\n    bytes[it.offset++] = operation & 255;\n\n    // encode index\n    encode.number(bytes, index, it);\n\n    // Do not encode value for DELETE operations\n    if (operation === OPERATION.DELETE) {\n        return;\n    }\n\n    const ref = changeTree.ref;\n\n    //\n    // encode \"alias\" for dynamic fields (maps)\n    //\n    if ((operation & OPERATION.ADD) === OPERATION.ADD) { // ADD or DELETE_AND_ADD\n        if (typeof(ref['set']) === \"function\") {\n            //\n            // MapSchema dynamic key\n            //\n            const dynamicIndex = changeTree.ref['$indexes'].get(index);\n            encode.string(bytes, dynamicIndex, it);\n        }\n    }\n\n    const type = ref[$childType];\n    const value = ref[$getByIndex](index);\n\n    // try { throw new Error(); } catch (e) {\n    //     // only print if not coming from Reflection.ts\n    //     if (!e.stack.includes(\"src/Reflection.ts\")) {\n    //         console.log(\"encodeKeyValueOperation -> \", {\n    //             ref: changeTree.ref.constructor.name,\n    //             field,\n    //             operation: OPERATION[operation],\n    //             value: value?.toJSON(),\n    //             items: ref.toJSON(),\n    //         });\n    //     }\n    // }\n\n    // TODO: inline this function call small performance gain\n    encodeValue(\n        encoder,\n        bytes,\n        type,\n        value,\n        operation,\n        it\n    );\n}\n\n/**\n * Used for collections (MapSchema, ArraySchema, etc.)\n * @private\n */\nexport const encodeArray: EncodeOperation = function (\n    encoder: Encoder,\n    bytes: Uint8Array,\n    changeTree: ChangeTree<ArraySchema>,\n    field: number,\n    operation: OPERATION,\n    it: Iterator,\n    isEncodeAll: boolean,\n    hasView: boolean,\n) {\n    const ref = changeTree.ref;\n    const useOperationByRefId = hasView && changeTree.isFiltered && (typeof (changeTree.getType(field)) !== \"string\");\n\n    let refOrIndex: number;\n\n    if (useOperationByRefId) {\n        const item = ref['tmpItems'][field];\n\n        // Skip encoding if item is undefined (e.g. when clear() is called)\n        if (!item) { return; }\n\n        refOrIndex = item[$refId];\n\n        if (operation === OPERATION.DELETE) {\n            operation = OPERATION.DELETE_BY_REFID;\n\n        } else if (operation === OPERATION.ADD) {\n            operation = OPERATION.ADD_BY_REFID;\n        }\n\n    } else {\n        refOrIndex = field;\n    }\n\n    // encode operation\n    bytes[it.offset++] = operation & 255;\n\n    // encode index\n    encode.number(bytes, refOrIndex, it);\n\n    // Do not encode value for DELETE operations\n    if (operation === OPERATION.DELETE || operation === OPERATION.DELETE_BY_REFID) {\n        return;\n    }\n\n    const type = changeTree.getType(field);\n    const value = changeTree.getValue(field, isEncodeAll);\n\n    // console.log({ type, field, value });\n\n    // console.log(\"encodeArray -> \", {\n    //     ref: changeTree.ref.constructor.name,\n    //     field,\n    //     operation: OPERATION[operation],\n    //     value: value?.toJSON(),\n    //     items: ref.toJSON(),\n    // });\n\n    // TODO: inline this function call small performance gain\n    encodeValue(\n        encoder,\n        bytes,\n        type,\n        value,\n        operation,\n        it\n    );\n}"]}

package/lib/src/encoder/Encoder.d.ts

@@ -0,0 +1,22 @@
+import type { Schema } from "../Schema";
+import { TypeContext } from "../types/TypeContext";
+import type { Iterator } from "../encoding/decode";
+import { Root } from "./Root";
+import type { StateView } from "./StateView";
+import type { ChangeSetName } from "./ChangeTree";
+export declare class Encoder<T extends Schema = any> {
+    static BUFFER_SIZE: number;
+    sharedBuffer: Uint8Array;
+    context: TypeContext;
+    state: T;
+    root: Root;
+    constructor(state: T);
+    protected setState(state: T): void;
+    encode(it?: Iterator, view?: StateView, buffer?: Uint8Array, changeSetName?: ChangeSetName, isEncodeAll?: boolean, initialOffset?: number): Uint8Array;
+    encodeAll(it?: Iterator, buffer?: Uint8Array): Uint8Array<ArrayBufferLike>;
+    encodeAllView(view: StateView, sharedOffset: number, it: Iterator, bytes?: Uint8Array): Uint8Array<ArrayBufferLike>;
+    encodeView(view: StateView, sharedOffset: number, it: Iterator, bytes?: Uint8Array): Uint8Array<ArrayBufferLike>;
+    discardChanges(): void;
+    tryEncodeTypeId(bytes: Uint8Array, baseType: typeof Schema, targetType: typeof Schema, it: Iterator): void;
+    get hasChanges(): boolean;
+}

package/lib/src/encoder/Encoder.js

@@ -0,0 +1,204 @@
+import { TypeContext } from "../types/TypeContext";
+import { $changes, $encoder, $filter, $getByIndex, $refId } from "../types/symbols";
+import { encode } from "../encoding/encode";
+import { OPERATION, SWITCH_TO_STRUCTURE, TYPE_ID } from '../encoding/spec';
+import { Root } from "./Root";
+import { createChangeTreeList } from "./ChangeTree";
+function concatBytes(a, b) {
+    const result = new Uint8Array(a.length + b.length);
+    result.set(a, 0);
+    result.set(b, a.length);
+    return result;
+}
+export class Encoder {
+    static { this.BUFFER_SIZE = 8 * 1024; } // 8KB
+    constructor(state) {
+        this.sharedBuffer = new Uint8Array(Encoder.BUFFER_SIZE);
+        //
+        // Use .cache() here to avoid re-creating a new context for every new room instance.
+        //
+        // We may need to make this optional in case of dynamically created
+        // schemas - which would lead to memory leaks
+        //
+        this.context = TypeContext.cache(state.constructor);
+        this.root = new Root(this.context);
+        this.setState(state);
+        // console.log(">>>>>>>>>>>>>>>> Encoder types");
+        // this.context.schemas.forEach((id, schema) => {
+        //     console.log("type:", id, schema.name, Object.keys(schema[Symbol.metadata]));
+        // });
+    }
+    setState(state) {
+        this.state = state;
+        this.state[$changes].setRoot(this.root);
+    }
+    encode(it = { offset: 0 }, view, buffer = this.sharedBuffer, changeSetName = "changes", isEncodeAll = changeSetName === "allChanges", initialOffset = it.offset // cache current offset in case we need to resize the buffer
+    ) {
+        const hasView = (view !== undefined);
+        const rootChangeTree = this.state[$changes];
+        let current = this.root[changeSetName];
+        while (current = current.next) {
+            const changeTree = current.changeTree;
+            if (hasView) {
+                if (!view.isChangeTreeVisible(changeTree)) {
+                    // console.log("MARK AS INVISIBLE:", { ref: changeTree.ref.constructor.name, refId: changeTree.ref[$refId], raw: changeTree.ref.toJSON() });
+                    view.invisible.add(changeTree);
+                    continue; // skip this change tree
+                }
+                view.invisible.delete(changeTree); // remove from invisible list
+            }
+            const changeSet = changeTree[changeSetName];
+            const ref = changeTree.ref;
+            // TODO: avoid iterating over change tree if no changes were made
+            const numChanges = changeSet.operations.length;
+            if (numChanges === 0) {
+                continue;
+            }
+            const ctor = ref.constructor;
+            const encoder = ctor[$encoder];
+            const filter = ctor[$filter];
+            const metadata = ctor[Symbol.metadata];
+            // skip root `refId` if it's the first change tree
+            // (unless it "hasView", which will need to revisit the root)
+            if (hasView || it.offset > initialOffset || changeTree !== rootChangeTree) {
+                buffer[it.offset++] = SWITCH_TO_STRUCTURE & 255;
+                encode.number(buffer, ref[$refId], it);
+            }
+            for (let j = 0; j < numChanges; j++) {
+                const fieldIndex = changeSet.operations[j];
+                if (fieldIndex < 0) {
+                    // "pure" operation without fieldIndex (e.g. CLEAR, REVERSE, etc.)
+                    // encode and continue early - no need to reach $filter check
+                    buffer[it.offset++] = Math.abs(fieldIndex) & 255;
+                    continue;
+                }
+                const operation = (isEncodeAll)
+                    ? OPERATION.ADD
+                    : changeTree.indexedOperations[fieldIndex];
+                //
+                // first pass (encodeAll), identify "filtered" operations without encoding them
+                // they will be encoded per client, based on their view.
+                //
+                // TODO: how can we optimize filtering out "encode all" operations?
+                // TODO: avoid checking if no view tags were defined
+                //
+                if (fieldIndex === undefined || operation === undefined || (filter && !filter(ref, fieldIndex, view))) {
+                    // console.log("ADD AS INVISIBLE:", fieldIndex, changeTree.ref.constructor.name)
+                    // view?.invisible.add(changeTree);
+                    continue;
+                }
+                encoder(this, buffer, changeTree, fieldIndex, operation, it, isEncodeAll, hasView, metadata);
+            }
+        }
+        if (it.offset > buffer.byteLength) {
+            // we can assume that n + 1 BUFFER_SIZE will suffice given that we are likely done with encoding at this point
+            // multiples of BUFFER_SIZE are faster to allocate than arbitrary sizes
+            const newSize = Math.ceil(it.offset / Encoder.BUFFER_SIZE) * Encoder.BUFFER_SIZE;
+            console.warn(`@colyseus/schema buffer overflow. Encoded state is higher than default BUFFER_SIZE. Use the following to increase default BUFFER_SIZE:
+
+    import { Encoder } from "@colyseus/schema";
+    Encoder.BUFFER_SIZE = ${Math.round(newSize / 1024)} * 1024; // ${Math.round(newSize / 1024)} KB
+`);
+            //
+            // resize buffer and re-encode (TODO: can we avoid re-encoding here?)
+            // -> No we probably can't unless we catch the need for resize before encoding which is likely more computationally expensive than resizing on demand
+            //
+            const newBuffer = new Uint8Array(newSize);
+            newBuffer.set(buffer); // copy previous encoding steps beyond the initialOffset
+            buffer = newBuffer;
+            // assign resized buffer to local sharedBuffer
+            if (buffer === this.sharedBuffer) {
+                this.sharedBuffer = buffer;
+            }
+            return this.encode({ offset: initialOffset }, view, buffer, changeSetName, isEncodeAll);
+        }
+        else {
+            return buffer.subarray(0, it.offset);
+        }
+    }
+    encodeAll(it = { offset: 0 }, buffer = this.sharedBuffer) {
+        return this.encode(it, undefined, buffer, "allChanges", true);
+    }
+    encodeAllView(view, sharedOffset, it, bytes = this.sharedBuffer) {
+        const viewOffset = it.offset;
+        // try to encode "filtered" changes
+        this.encode(it, view, bytes, "allFilteredChanges", true, viewOffset);
+        return concatBytes(bytes.subarray(0, sharedOffset), bytes.subarray(viewOffset, it.offset));
+    }
+    encodeView(view, sharedOffset, it, bytes = this.sharedBuffer) {
+        const viewOffset = it.offset;
+        // encode visibility changes (add/remove for this view)
+        for (const [refId, changes] of view.changes) {
+            const changeTree = this.root.changeTrees[refId];
+            if (changeTree === undefined) {
+                // detached instance, remove from view and skip.
+                // console.log("detached instance, remove from view and skip.", refId);
+                view.changes.delete(refId);
+                continue;
+            }
+            const keys = Object.keys(changes);
+            if (keys.length === 0) {
+                // FIXME: avoid having empty changes if no changes were made
+                // console.log("changes.size === 0, skip", refId, changeTree.ref.constructor.name);
+                continue;
+            }
+            const ref = changeTree.ref;
+            const ctor = ref.constructor;
+            const encoder = ctor[$encoder];
+            const metadata = ctor[Symbol.metadata];
+            bytes[it.offset++] = SWITCH_TO_STRUCTURE & 255;
+            encode.number(bytes, ref[$refId], it);
+            for (let i = 0, numChanges = keys.length; i < numChanges; i++) {
+                const index = Number(keys[i]);
+                // workaround when using view.add() on item that has been deleted from state (see test "adding to view item that has been removed from state")
+                const value = changeTree.ref[$getByIndex](index);
+                const operation = (value !== undefined && changes[index]) || OPERATION.DELETE;
+                // isEncodeAll = false
+                // hasView = true
+                encoder(this, bytes, changeTree, index, operation, it, false, true, metadata);
+            }
+        }
+        //
+        // TODO: only clear view changes after all views are encoded
+        // (to allow re-using StateView's for multiple clients)
+        //
+        // clear "view" changes after encoding
+        view.changes.clear();
+        // try to encode "filtered" changes
+        this.encode(it, view, bytes, "filteredChanges", false, viewOffset);
+        return concatBytes(bytes.subarray(0, sharedOffset), bytes.subarray(viewOffset, it.offset));
+    }
+    discardChanges() {
+        // discard shared changes
+        let current = this.root.changes.next;
+        while (current) {
+            current.changeTree.endEncode('changes');
+            current = current.next;
+        }
+        this.root.changes = createChangeTreeList();
+        // discard filtered changes
+        current = this.root.filteredChanges.next;
+        while (current) {
+            current.changeTree.endEncode('filteredChanges');
+            current = current.next;
+        }
+        this.root.filteredChanges = createChangeTreeList();
+    }
+    tryEncodeTypeId(bytes, baseType, targetType, it) {
+        const baseTypeId = this.context.getTypeId(baseType);
+        const targetTypeId = this.context.getTypeId(targetType);
+        if (targetTypeId === undefined) {
+            console.warn(`@colyseus/schema WARNING: Class "${targetType.name}" is not registered on TypeRegistry - Please either tag the class with @entity or define a @type() field.`);
+            return;
+        }
+        if (baseTypeId !== targetTypeId) {
+            bytes[it.offset++] = TYPE_ID & 255;
+            encode.number(bytes, targetTypeId, it);
+        }
+    }
+    get hasChanges() {
+        return (this.root.changes.next !== undefined ||
+            this.root.filteredChanges.next !== undefined);
+    }
+}
+//# sourceMappingURL=Encoder.js.map

package/lib/src/encoder/Encoder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Encoder.js","sourceRoot":"","sources":["../../../src/encoder/Encoder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAEpF,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAG5C,OAAO,EAAE,SAAS,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3E,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAI9B,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAEpD,SAAS,WAAW,CAAC,CAAa,EAAE,CAAa;IAC7C,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;IACnD,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACjB,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;IACxB,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,MAAM,OAAO,OAAO;aACT,gBAAW,GAAG,CAAC,GAAG,IAAI,AAAX,CAAY,GAAC,MAAM;IAQrC,YAAY,KAAQ;QAPpB,iBAAY,GAAe,IAAI,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAQ3D,EAAE;QACF,oFAAoF;QACpF,EAAE;QACF,mEAAmE;QACnE,6CAA6C;QAC7C,EAAE;QACF,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,WAA4B,CAAC,CAAC;QACrE,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEnC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAErB,iDAAiD;QACjD,iDAAiD;QACjD,mFAAmF;QACnF,MAAM;IACV,CAAC;IAES,QAAQ,CAAC,KAAQ;QACvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,CACF,KAAe,EAAE,MAAM,EAAE,CAAC,EAAE,EAC5B,IAAgB,EAChB,SAAqB,IAAI,CAAC,YAAY,EACtC,gBAA+B,SAAS,EACxC,WAAW,GAAG,aAAa,KAAK,YAAY,EAC5C,aAAa,GAAG,EAAE,CAAC,MAAM,CAAC,4DAA4D;;QAEtF,MAAM,OAAO,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;QACrC,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAE5C,IAAI,OAAO,GAAoC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAExE,OAAO,OAAO,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;YAC5B,MAAM,UAAU,GAAI,OAA0B,CAAC,UAAU,CAAC;YAE1D,IAAI,OAAO,EAAE,CAAC;gBACV,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,EAAE,CAAC;oBACxC,4IAA4I;oBAC5I,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;oBAC/B,SAAS,CAAC,wBAAwB;gBACtC,CAAC;gBACD,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,6BAA6B;YACpE,CAAC;YAED,MAAM,SAAS,GAAG,UAAU,CAAC,aAAa,CAAC,CAAC;YAC5C,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC;YAE3B,iEAAiE;YACjE,MAAM,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC;YAC/C,IAAI,UAAU,KAAK,CAAC,EAAE,CAAC;gBAAC,SAAS;YAAC,CAAC;YAEnC,MAAM,IAAI,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;YAC7B,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAEvC,kDAAkD;YAClD,6DAA6D;YAC7D,IAAI,OAAO,IAAI,EAAE,CAAC,MAAM,GAAG,aAAa,IAAI,UAAU,KAAK,cAAc,EAAE,CAAC;gBACxE,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,mBAAmB,GAAG,GAAG,CAAC;gBAChD,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;YAC3C,CAAC;YAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC;gBAClC,MAAM,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;gBAE3C,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;oBACjB,kEAAkE;oBAClE,6DAA6D;oBAC7D,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC;oBACjD,SAAS;gBACb,CAAC;gBAED,MAAM,SAAS,GAAG,CAAC,WAAW,CAAC;oBAC3B,CAAC,CAAC,SAAS,CAAC,GAAG;oBACf,CAAC,CAAC,UAAU,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;gBAE/C,EAAE;gBACF,+EAA+E;gBAC/E,wDAAwD;gBACxD,EAAE;gBACF,mEAAmE;gBACnE,oDAAoD;gBACpD,EAAE;gBACF,IAAI,UAAU,KAAK,SAAS,IAAI,SAAS,KAAK,SAAS,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;oBACpG,gFAAgF;oBAChF,mCAAmC;oBACnC,SAAS;gBACb,CAAC;gBAED,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;YACjG,CAAC;QACL,CAAC;QAED,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;YAChC,8GAA8G;YAC9G,uEAAuE;YACvE,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC;YAEjF,OAAO,CAAC,IAAI,CAAC;;;4BAGG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,eAAe,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC;CAC9F,CAAC,CAAC;YAES,EAAE;YACF,qEAAqE;YACrE,qJAAqJ;YACrJ,EAAE;YACF,MAAM,SAAS,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;YAC1C,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,wDAAwD;YAC/E,MAAM,GAAG,SAAS,CAAC;YAEnB,8CAA8C;YAC9C,IAAI,MAAM,KAAK,IAAI,CAAC,YAAY,EAAE,CAAC;gBAC/B,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC;YAC/B,CAAC;YAED,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,aAAa,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;QAE5F,CAAC;aAAM,CAAC;YAEJ,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC;QACzC,CAAC;IACL,CAAC;IAED,SAAS,CACL,KAAe,EAAE,MAAM,EAAE,CAAC,EAAE,EAC5B,SAAqB,IAAI,CAAC,YAAY;QAEtC,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;IAClE,CAAC;IAED,aAAa,CACT,IAAe,EACf,YAAoB,EACpB,EAAY,EACZ,QAAoB,IAAI,CAAC,YAAY;QAErC,MAAM,UAAU,GAAG,EAAE,CAAC,MAAM,CAAC;QAE7B,mCAAmC;QACnC,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,oBAAoB,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;QAErE,OAAO,WAAW,CACd,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,YAAY,CAAC,EAC/B,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,CAAC,MAAM,CAAC,CACxC,CAAC;IACN,CAAC;IAED,UAAU,CACN,IAAe,EACf,YAAoB,EACpB,EAAY,EACZ,QAAoB,IAAI,CAAC,YAAY;QAErC,MAAM,UAAU,GAAG,EAAE,CAAC,MAAM,CAAC;QAE7B,uDAAuD;QACvD,KAAK,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAC1C,MAAM,UAAU,GAAe,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;YAE5D,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;gBAC3B,gDAAgD;gBAChD,uEAAuE;gBACvE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC3B,SAAS;YACb,CAAC;YAED,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAClC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACpB,4DAA4D;gBAC5D,mFAAmF;gBACnF,SAAS;YACb,CAAC;YAED,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC;YAE3B,MAAM,IAAI,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC/B,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAEvC,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,mBAAmB,GAAG,GAAG,CAAC;YAC/C,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;YAEtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,GAAG,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC5D,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9B,8IAA8I;gBAC9I,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC;gBACjD,MAAM,SAAS,GAAG,CAAC,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,SAAS,CAAC,MAAM,CAAC;gBAE9E,sBAAsB;gBACtB,iBAAiB;gBACjB,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;YAClF,CAAC;QACL,CAAC;QAED,EAAE;QACF,4DAA4D;QAC5D,uDAAuD;QACvD,EAAE;QACF,sCAAsC;QACtC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QAErB,mCAAmC;QACnC,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,iBAAiB,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;QAEnE,OAAO,WAAW,CACd,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,YAAY,CAAC,EAC/B,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,CAAC,MAAM,CAAC,CACxC,CAAC;IACN,CAAC;IAED,cAAc;QACV,yBAAyB;QACzB,IAAI,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QACrC,OAAO,OAAO,EAAE,CAAC;YACb,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;YACxC,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;QAC3B,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,oBAAoB,EAAE,CAAC;QAE3C,2BAA2B;QAC3B,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;QACzC,OAAO,OAAO,EAAE,CAAC;YACb,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;YAChD,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;QAC3B,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,eAAe,GAAG,oBAAoB,EAAE,CAAC;IACvD,CAAC;IAED,eAAe,CACX,KAAiB,EACjB,QAAuB,EACvB,UAAyB,EACzB,EAAY;QAEZ,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACpD,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAExD,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO,CAAC,IAAI,CAAC,oCAAoC,UAAU,CAAC,IAAI,2GAA2G,CAAC,CAAC;YAC7K,OAAO;QACX,CAAC;QAED,IAAI,UAAU,KAAK,YAAY,EAAE,CAAC;YAC9B,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,OAAO,GAAG,GAAG,CAAC;YACnC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC;QAC3C,CAAC;IACL,CAAC;IAED,IAAI,UAAU;QACV,OAAO,CACH,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS;YACpC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,KAAK,SAAS,CAC/C,CAAC;IACN,CAAC","sourcesContent":["import type { Schema } from \"../Schema\";\nimport { TypeContext } from \"../types/TypeContext\";\nimport { $changes, $encoder, $filter, $getByIndex, $refId } from \"../types/symbols\";\n\nimport { encode } from \"../encoding/encode\";\nimport type { Iterator } from \"../encoding/decode\";\n\nimport { OPERATION, SWITCH_TO_STRUCTURE, TYPE_ID } from '../encoding/spec';\nimport { Root } from \"./Root\";\n\nimport type { StateView } from \"./StateView\";\nimport type { ChangeSetName, ChangeTree, ChangeTreeList, ChangeTreeNode } from \"./ChangeTree\";\nimport { createChangeTreeList } from \"./ChangeTree\";\n\nfunction concatBytes(a: Uint8Array, b: Uint8Array): Uint8Array {\n    const result = new Uint8Array(a.length + b.length);\n    result.set(a, 0);\n    result.set(b, a.length);\n    return result;\n}\n\nexport class Encoder<T extends Schema = any> {\n    static BUFFER_SIZE = 8 * 1024; // 8KB\n    sharedBuffer: Uint8Array = new Uint8Array(Encoder.BUFFER_SIZE);\n\n    context: TypeContext;\n    state: T;\n\n    root: Root;\n\n    constructor(state: T) {\n        //\n        // Use .cache() here to avoid re-creating a new context for every new room instance.\n        //\n        // We may need to make this optional in case of dynamically created\n        // schemas - which would lead to memory leaks\n        //\n        this.context = TypeContext.cache(state.constructor as typeof Schema);\n        this.root = new Root(this.context);\n\n        this.setState(state);\n\n        // console.log(\">>>>>>>>>>>>>>>> Encoder 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(state: T) {\n        this.state = state;\n        this.state[$changes].setRoot(this.root);\n    }\n\n    encode(\n        it: Iterator = { offset: 0 },\n        view?: StateView,\n        buffer: Uint8Array = this.sharedBuffer,\n        changeSetName: ChangeSetName = \"changes\",\n        isEncodeAll = changeSetName === \"allChanges\",\n        initialOffset = it.offset // cache current offset in case we need to resize the buffer\n    ): Uint8Array {\n        const hasView = (view !== undefined);\n        const rootChangeTree = this.state[$changes];\n\n        let current: ChangeTreeList | ChangeTreeNode = this.root[changeSetName];\n\n        while (current = current.next) {\n            const changeTree = (current as ChangeTreeNode).changeTree;\n\n            if (hasView) {\n                if (!view.isChangeTreeVisible(changeTree)) {\n                    // console.log(\"MARK AS INVISIBLE:\", { ref: changeTree.ref.constructor.name, refId: changeTree.ref[$refId], raw: changeTree.ref.toJSON() });\n                    view.invisible.add(changeTree);\n                    continue; // skip this change tree\n                }\n                view.invisible.delete(changeTree); // remove from invisible list\n            }\n\n            const changeSet = changeTree[changeSetName];\n            const ref = changeTree.ref;\n\n            // TODO: avoid iterating over change tree if no changes were made\n            const numChanges = changeSet.operations.length;\n            if (numChanges === 0) { continue; }\n\n            const ctor = ref.constructor;\n            const encoder = ctor[$encoder];\n            const filter = ctor[$filter];\n            const metadata = ctor[Symbol.metadata];\n\n            // skip root `refId` if it's the first change tree\n            // (unless it \"hasView\", which will need to revisit the root)\n            if (hasView || it.offset > initialOffset || changeTree !== rootChangeTree) {\n                buffer[it.offset++] = SWITCH_TO_STRUCTURE & 255;\n                encode.number(buffer, ref[$refId], it);\n            }\n\n            for (let j = 0; j < numChanges; j++) {\n                const fieldIndex = changeSet.operations[j];\n\n                if (fieldIndex < 0) {\n                    // \"pure\" operation without fieldIndex (e.g. CLEAR, REVERSE, etc.)\n                    // encode and continue early - no need to reach $filter check\n                    buffer[it.offset++] = Math.abs(fieldIndex) & 255;\n                    continue;\n                }\n\n                const operation = (isEncodeAll)\n                    ? OPERATION.ADD\n                    : changeTree.indexedOperations[fieldIndex];\n\n                //\n                // first pass (encodeAll), identify \"filtered\" operations without encoding them\n                // they will be encoded per client, based on their view.\n                //\n                // TODO: how can we optimize filtering out \"encode all\" operations?\n                // TODO: avoid checking if no view tags were defined\n                //\n                if (fieldIndex === undefined || operation === undefined || (filter && !filter(ref, fieldIndex, view))) {\n                    // console.log(\"ADD AS INVISIBLE:\", fieldIndex, changeTree.ref.constructor.name)\n                    // view?.invisible.add(changeTree);\n                    continue;\n                }\n\n                encoder(this, buffer, changeTree, fieldIndex, operation, it, isEncodeAll, hasView, metadata);\n            }\n        }\n\n        if (it.offset > buffer.byteLength) {\n            // we can assume that n + 1 BUFFER_SIZE will suffice given that we are likely done with encoding at this point\n            // multiples of BUFFER_SIZE are faster to allocate than arbitrary sizes\n            const newSize = Math.ceil(it.offset / Encoder.BUFFER_SIZE) * Encoder.BUFFER_SIZE;\n\n            console.warn(`@colyseus/schema buffer overflow. Encoded state is higher than default BUFFER_SIZE. Use the following to increase default BUFFER_SIZE:\n\n    import { Encoder } from \"@colyseus/schema\";\n    Encoder.BUFFER_SIZE = ${Math.round(newSize / 1024)} * 1024; // ${Math.round(newSize / 1024)} KB\n`);\n\n            //\n            // resize buffer and re-encode (TODO: can we avoid re-encoding here?)\n            // -> No we probably can't unless we catch the need for resize before encoding which is likely more computationally expensive than resizing on demand\n            //\n            const newBuffer = new Uint8Array(newSize);\n            newBuffer.set(buffer); // copy previous encoding steps beyond the initialOffset\n            buffer = newBuffer;\n\n            // assign resized buffer to local sharedBuffer\n            if (buffer === this.sharedBuffer) {\n                this.sharedBuffer = buffer;\n            }\n\n            return this.encode({ offset: initialOffset }, view, buffer, changeSetName, isEncodeAll);\n\n        } else {\n\n            return buffer.subarray(0, it.offset);\n        }\n    }\n\n    encodeAll(\n        it: Iterator = { offset: 0 },\n        buffer: Uint8Array = this.sharedBuffer\n    ) {\n        return this.encode(it, undefined, buffer, \"allChanges\", true);\n    }\n\n    encodeAllView(\n        view: StateView,\n        sharedOffset: number,\n        it: Iterator,\n        bytes: Uint8Array = this.sharedBuffer\n    ) {\n        const viewOffset = it.offset;\n\n        // try to encode \"filtered\" changes\n        this.encode(it, view, bytes, \"allFilteredChanges\", true, viewOffset);\n\n        return concatBytes(\n            bytes.subarray(0, sharedOffset),\n            bytes.subarray(viewOffset, it.offset)\n        );\n    }\n\n    encodeView(\n        view: StateView,\n        sharedOffset: number,\n        it: Iterator,\n        bytes: Uint8Array = this.sharedBuffer\n    ) {\n        const viewOffset = it.offset;\n\n        // encode visibility changes (add/remove for this view)\n        for (const [refId, changes] of view.changes) {\n            const changeTree: ChangeTree = this.root.changeTrees[refId];\n\n            if (changeTree === undefined) {\n                // detached instance, remove from view and skip.\n                // console.log(\"detached instance, remove from view and skip.\", refId);\n                view.changes.delete(refId);\n                continue;\n            }\n\n            const keys = Object.keys(changes);\n            if (keys.length === 0) {\n                // FIXME: avoid having empty changes if no changes were made\n                // console.log(\"changes.size === 0, skip\", refId, changeTree.ref.constructor.name);\n                continue;\n            }\n\n            const ref = changeTree.ref;\n\n            const ctor = ref.constructor;\n            const encoder = ctor[$encoder];\n            const metadata = ctor[Symbol.metadata];\n\n            bytes[it.offset++] = SWITCH_TO_STRUCTURE & 255;\n            encode.number(bytes, ref[$refId], it);\n\n            for (let i = 0, numChanges = keys.length; i < numChanges; i++) {\n                const index = Number(keys[i]);\n                // workaround when using view.add() on item that has been deleted from state (see test \"adding to view item that has been removed from state\")\n                const value = changeTree.ref[$getByIndex](index);\n                const operation = (value !== undefined && changes[index]) || OPERATION.DELETE;\n\n                // isEncodeAll = false\n                // hasView = true\n                encoder(this, bytes, changeTree, index, operation, it, false, true, metadata);\n            }\n        }\n\n        //\n        // TODO: only clear view changes after all views are encoded\n        // (to allow re-using StateView's for multiple clients)\n        //\n        // clear \"view\" changes after encoding\n        view.changes.clear();\n\n        // try to encode \"filtered\" changes\n        this.encode(it, view, bytes, \"filteredChanges\", false, viewOffset);\n\n        return concatBytes(\n            bytes.subarray(0, sharedOffset),\n            bytes.subarray(viewOffset, it.offset)\n        );\n    }\n\n    discardChanges() {\n        // discard shared changes\n        let current = this.root.changes.next;\n        while (current) {\n            current.changeTree.endEncode('changes');\n            current = current.next;\n        }\n        this.root.changes = createChangeTreeList();\n\n        // discard filtered changes\n        current = this.root.filteredChanges.next;\n        while (current) {\n            current.changeTree.endEncode('filteredChanges');\n            current = current.next;\n        }\n        this.root.filteredChanges = createChangeTreeList();\n    }\n\n    tryEncodeTypeId(\n        bytes: Uint8Array,\n        baseType: typeof Schema,\n        targetType: typeof Schema,\n        it: Iterator\n    ) {\n        const baseTypeId = this.context.getTypeId(baseType);\n        const targetTypeId = this.context.getTypeId(targetType);\n\n        if (targetTypeId === undefined) {\n            console.warn(`@colyseus/schema WARNING: Class \"${targetType.name}\" is not registered on TypeRegistry - Please either tag the class with @entity or define a @type() field.`);\n            return;\n        }\n\n        if (baseTypeId !== targetTypeId) {\n            bytes[it.offset++] = TYPE_ID & 255;\n            encode.number(bytes, targetTypeId, it);\n        }\n    }\n\n    get hasChanges() {\n        return (\n            this.root.changes.next !== undefined ||\n            this.root.filteredChanges.next !== undefined\n        );\n    }\n}\n"]}

package/lib/src/encoder/Root.d.ts

@@ -0,0 +1,28 @@
+import { TypeContext } from "../types/TypeContext";
+import { ChangeTree, ChangeTreeList, ChangeSetName, type ChangeTreeNode } from "./ChangeTree";
+export declare class Root {
+    types: TypeContext;
+    protected nextUniqueId: number;
+    refCount: {
+        [id: number]: number;
+    };
+    changeTrees: {
+        [refId: number]: ChangeTree;
+    };
+    allChanges: ChangeTreeList;
+    allFilteredChanges: ChangeTreeList;
+    changes: ChangeTreeList;
+    filteredChanges: ChangeTreeList;
+    constructor(types: TypeContext);
+    getNextUniqueId(): number;
+    add(changeTree: ChangeTree): boolean;
+    remove(changeTree: ChangeTree): number;
+    recursivelyMoveNextToParent(changeTree: ChangeTree): void;
+    moveNextToParent(changeTree: ChangeTree): void;
+    moveNextToParentInChangeTreeList(changeSetName: ChangeSetName, changeTree: ChangeTree): void;
+    enqueueChangeTree(changeTree: ChangeTree, changeSet: 'changes' | 'filteredChanges' | 'allFilteredChanges' | 'allChanges', queueRootNode?: ChangeTreeNode): void;
+    protected addToChangeTreeList(list: ChangeTreeList, changeTree: ChangeTree): ChangeTreeNode;
+    protected updatePositionsAfterRemoval(list: ChangeTreeList, removedPosition: number): void;
+    protected updatePositionsAfterMove(list: ChangeTreeList, node: ChangeTreeNode, newPosition: number): void;
+    removeChangeFromChangeSet(changeSetName: ChangeSetName, changeTree: ChangeTree): boolean;
+}