@colyseus/schema 2.0.31 → 3.0.0-alpha.0

package/lib/encoder/Encoder.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="node" />
+import type { Schema } from "../Schema";
+import { TypeContext } from "../annotations";
+import type { Iterator } from "../encoding/decode";
+import { OPERATION } from '../encoding/spec';
+import { Root } from "./ChangeTree";
+import { StateView } from "./StateView";
+export declare class Encoder<T extends Schema = any> {
+    static BUFFER_SIZE: number;
+    sharedBuffer: Buffer;
+    context: TypeContext;
+    state: T;
+    $root: Root;
+    constructor(root: T);
+    protected setRoot(state: T): void;
+    encode(it?: Iterator, view?: StateView, bytes?: Buffer, changeTrees?: Map<import("./ChangeTree").ChangeTree<any>, Map<number, OPERATION>>): Buffer;
+    encodeAll(it?: Iterator): Buffer;
+    encodeAllView(view: StateView, sharedOffset: number, it: Iterator, bytes?: Buffer): Buffer;
+    encodeView(view: StateView, sharedOffset: number, it: Iterator, bytes?: Buffer): Buffer;
+    onEndEncode(changeTrees?: Map<import("./ChangeTree").ChangeTree<any>, Map<number, OPERATION>>): void;
+    discardChanges(): void;
+    tryEncodeTypeId(bytes: Buffer, baseType: typeof Schema, targetType: typeof Schema, it: Iterator): void;
+}

package/lib/encoder/Encoder.js

@@ -0,0 +1,192 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Encoder = void 0;
+const annotations_1 = require("../annotations");
+const symbols_1 = require("../types/symbols");
+const encode = require("../encoding/encode");
+const spec_1 = require("../encoding/spec");
+const ChangeTree_1 = require("./ChangeTree");
+const utils_1 = require("../utils");
+class Encoder {
+    static { this.BUFFER_SIZE = 8 * 1024; } // 8KB
+    constructor(root) {
+        this.sharedBuffer = Buffer.allocUnsafeSlow(Encoder.BUFFER_SIZE);
+        this.setRoot(root);
+        //
+        // TODO: cache and restore "Context" based on root schema
+        // (to avoid creating a new context for every new room)
+        //
+        this.context = new annotations_1.TypeContext(root.constructor);
+        // console.log(">>>>>>>>>>>>>>>> Encoder types");
+        // this.context.schemas.forEach((id, schema) => {
+        //     console.log("type:", id, schema.name, Object.keys(schema[Symbol.metadata]));
+        // });
+    }
+    setRoot(state) {
+        this.$root = new ChangeTree_1.Root();
+        this.state = state;
+        state[symbols_1.$changes].setRoot(this.$root);
+    }
+    encode(it = { offset: 0 }, view, bytes = this.sharedBuffer, changeTrees = this.$root.changes) {
+        const initialOffset = it.offset; // cache current offset in case we need to resize the buffer
+        const isEncodeAll = this.$root.allChanges === changeTrees;
+        const hasView = (view !== undefined);
+        const rootChangeTree = this.state[symbols_1.$changes];
+        const changeTreesIterator = changeTrees.entries();
+        for (const [changeTree, changes] of changeTreesIterator) {
+            const ref = changeTree.ref;
+            const ctor = ref['constructor'];
+            const encoder = ctor[symbols_1.$encoder];
+            const filter = ctor[symbols_1.$filter];
+            if (hasView) {
+                if (!view.items.has(changeTree)) {
+                    view.invisible.add(changeTree);
+                    continue; // skip this change tree
+                }
+                else if (view.invisible.has(changeTree)) {
+                    view.invisible.delete(changeTree); // remove from invisible list
+                }
+            }
+            // skip root `refId` if it's the first change tree
+            if (it.offset !== initialOffset || changeTree !== rootChangeTree) {
+                bytes[it.offset++] = spec_1.SWITCH_TO_STRUCTURE & 255;
+                encode.number(bytes, changeTree.refId, it);
+            }
+            const changesIterator = changes.entries();
+            for (const [fieldIndex, operation] of changesIterator) {
+                //
+                // 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 (filter && !filter(ref, fieldIndex, view)) {
+                    // console.log("SKIP FIELD:", { ref: changeTree.ref.constructor.name, fieldIndex, })
+                    // console.log("ADD AS INVISIBLE:", fieldIndex, changeTree.ref.constructor.name)
+                    // view?.invisible.add(changeTree);
+                    continue;
+                }
+                // console.log("WILL ENCODE", {
+                //     ref: changeTree.ref.constructor.name,
+                //     fieldIndex,
+                //     operation: OPERATION[operation],
+                // });
+                encoder(this, bytes, changeTree, fieldIndex, operation, it, isEncodeAll, hasView);
+            }
+        }
+        if (it.offset > bytes.byteLength) {
+            const newSize = (0, utils_1.getNextPowerOf2)(this.sharedBuffer.byteLength * 2);
+            console.warn("@colyseus/schema encode buffer overflow. Current buffer size: " + bytes.byteLength + ", encoding offset: " + it.offset + ", new size: " + newSize);
+            //
+            // resize buffer and re-encode (TODO: can we avoid re-encoding here?)
+            //
+            this.sharedBuffer = Buffer.allocUnsafeSlow(newSize);
+            return this.encode({ offset: initialOffset }, view);
+        }
+        else {
+            //
+            // only clear changes after making sure buffer resize is not required.
+            //
+            if (!isEncodeAll && !hasView) {
+                //
+                // FIXME: avoid iterating over change trees twice.
+                //
+                this.onEndEncode(changeTrees);
+            }
+            // return bytes;
+            return bytes.slice(0, it.offset);
+        }
+    }
+    encodeAll(it = { offset: 0 }) {
+        // console.log(`encodeAll(), this.$root.allChanges (${this.$root.allChanges.size})`);
+        // Array.from(this.$root.allChanges.entries()).map((item) => {
+        //     console.log("->", item[0].refId, item[0].ref.toJSON());
+        // });
+        return this.encode(it, undefined, this.sharedBuffer, this.$root.allChanges);
+    }
+    encodeAllView(view, sharedOffset, it, bytes = this.sharedBuffer) {
+        const viewOffset = it.offset;
+        // console.log(`encodeAllView(), this.$root.allFilteredChanges (${this.$root.allFilteredChanges.size})`);
+        // this.debugAllFilteredChanges();
+        // try to encode "filtered" changes
+        this.encode(it, view, bytes, this.$root.allFilteredChanges);
+        return Buffer.concat([
+            bytes.slice(0, sharedOffset),
+            bytes.slice(viewOffset, it.offset)
+        ]);
+    }
+    // debugAllFilteredChanges() {
+    //     Array.from(this.$root.allFilteredChanges.entries()).map((item) => {
+    //         console.log("->", { refId: item[0].refId }, item[0].ref.toJSON());
+    //         if (Array.isArray(item[0].ref.toJSON())) {
+    //             item[1].forEach((op, key) => {
+    //                 console.log("  ->", { key, op: OPERATION[op] });
+    //             })
+    //         }
+    //     });
+    // }
+    encodeView(view, sharedOffset, it, bytes = this.sharedBuffer) {
+        const viewOffset = it.offset;
+        // try to encode "filtered" changes
+        this.encode(it, view, bytes, this.$root.filteredChanges);
+        // encode visibility changes (add/remove for this view)
+        const viewChangesIterator = view.changes.entries();
+        for (const [changeTree, changes] of viewChangesIterator) {
+            if (changes.size === 0) {
+                // FIXME: avoid having empty changes if no changes were made
+                // console.log("changes.size === 0", changeTree.ref.constructor.name);
+                continue;
+            }
+            const ref = changeTree.ref;
+            const ctor = ref['constructor'];
+            const encoder = ctor[symbols_1.$encoder];
+            bytes[it.offset++] = spec_1.SWITCH_TO_STRUCTURE & 255;
+            encode.number(bytes, changeTree.refId, it);
+            const changesIterator = changes.entries();
+            for (const [fieldIndex, operation] of changesIterator) {
+                // isEncodeAll = false
+                // hasView = true
+                encoder(this, bytes, changeTree, fieldIndex, operation, it, false, true);
+            }
+        }
+        //
+        // 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();
+        return Buffer.concat([
+            bytes.slice(0, sharedOffset),
+            bytes.slice(viewOffset, it.offset)
+        ]);
+    }
+    onEndEncode(changeTrees = this.$root.changes) {
+        const changeTreesIterator = changeTrees.entries();
+        for (const [changeTree, _] of changeTreesIterator) {
+            changeTree.endEncode();
+        }
+    }
+    discardChanges() {
+        // discard shared changes
+        if (this.$root.changes.size > 0) {
+            this.onEndEncode(this.$root.changes);
+            this.$root.changes.clear();
+        }
+        // discard filtered changes
+        if (this.$root.filteredChanges.size > 0) {
+            this.onEndEncode(this.$root.filteredChanges);
+            this.$root.filteredChanges.clear();
+        }
+    }
+    tryEncodeTypeId(bytes, baseType, targetType, it) {
+        const baseTypeId = this.context.getTypeId(baseType);
+        const targetTypeId = this.context.getTypeId(targetType);
+        if (baseTypeId !== targetTypeId) {
+            bytes[it.offset++] = spec_1.TYPE_ID & 255;
+            encode.number(bytes, targetTypeId, it);
+        }
+    }
+}
+exports.Encoder = Encoder;
+//# sourceMappingURL=Encoder.js.map

package/lib/encoder/Encoder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Encoder.js","sourceRoot":"","sources":["../../src/encoder/Encoder.ts"],"names":[],"mappings":";;;AACA,gDAA6C;AAC7C,8CAA+D;AAE/D,6CAA6C;AAG7C,2CAA2E;AAC3E,6CAAoC;AACpC,oCAA2C;AAI3C,MAAa,OAAO;aACT,gBAAW,GAAG,CAAC,GAAG,IAAI,AAAX,CAAY,GAAA,MAAM;IAQpC,YAAY,IAAO;QAPnB,iBAAY,GAAG,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAQvD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEnB,EAAE;QACF,yDAAyD;QACzD,uDAAuD;QACvD,EAAE;QACF,IAAI,CAAC,OAAO,GAAG,IAAI,yBAAW,CAAC,IAAI,CAAC,WAA4B,CAAC,CAAC;QAElE,iDAAiD;QACjD,iDAAiD;QACjD,mFAAmF;QACnF,MAAM;IACV,CAAC;IAES,OAAO,CAAC,KAAQ;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,iBAAI,EAAE,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,KAAK,CAAC,kBAAQ,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;IAED,MAAM,CACF,KAAe,EAAE,MAAM,EAAE,CAAC,EAAE,EAC5B,IAAgB,EAChB,KAAK,GAAG,IAAI,CAAC,YAAY,EACzB,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO;QAEhC,MAAM,aAAa,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC,4DAA4D;QAE7F,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,KAAK,WAAW,CAAC;QAC1D,MAAM,OAAO,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;QACrC,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAQ,CAAC,CAAC;QAE5C,MAAM,mBAAmB,GAAG,WAAW,CAAC,OAAO,EAAE,CAAC;QAElD,KAAK,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,mBAAmB,EAAE,CAAC;YACtD,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC;YAE3B,MAAM,IAAI,GAAG,GAAG,CAAC,aAAa,CAAC,CAAC;YAChC,MAAM,OAAO,GAAG,IAAI,CAAC,kBAAQ,CAAC,CAAC;YAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAO,CAAC,CAAC;YAE7B,IAAI,OAAO,EAAE,CAAC;gBACV,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC9B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;oBAC/B,SAAS,CAAC,wBAAwB;gBAEtC,CAAC;qBAAM,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;oBACxC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,6BAA6B;gBACpE,CAAC;YACL,CAAC;YAED,kDAAkD;YAClD,IAAI,EAAE,CAAC,MAAM,KAAK,aAAa,IAAI,UAAU,KAAK,cAAc,EAAE,CAAC;gBAC/D,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,0BAAmB,GAAG,GAAG,CAAC;gBAC/C,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YAC/C,CAAC;YAED,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;YAE1C,KAAK,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,IAAI,eAAe,EAAE,CAAC;gBACpD,EAAE;gBACF,+EAA+E;gBAC/E,wDAAwD;gBACxD,EAAE;gBACF,mEAAmE;gBACnE,oDAAoD;gBACpD,EAAE;gBACF,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,CAAC;oBAC3C,oFAAoF;oBAEpF,gFAAgF;oBAChF,mCAAmC;oBACnC,SAAS;gBACb,CAAC;gBAED,+BAA+B;gBAC/B,4CAA4C;gBAC5C,kBAAkB;gBAClB,uCAAuC;gBACvC,MAAM;gBAEN,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,EAAE,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;YACtF,CAAC;QACL,CAAC;QAED,IAAI,EAAE,CAAC,MAAM,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;YAC/B,MAAM,OAAO,GAAG,IAAA,uBAAe,EAAC,IAAI,CAAC,YAAY,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;YAClE,OAAO,CAAC,IAAI,CAAC,gEAAgE,GAAG,KAAK,CAAC,UAAU,GAAG,qBAAqB,GAAG,EAAE,CAAC,MAAM,GAAG,cAAc,GAAG,OAAO,CAAC,CAAC;YAEjK,EAAE;YACF,qEAAqE;YACrE,EAAE;YACF,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;YACpD,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,aAAa,EAAE,EAAE,IAAI,CAAC,CAAC;QAExD,CAAC;aAAM,CAAC;YACJ,EAAE;YACF,sEAAsE;YACtE,EAAE;YACF,IAAI,CAAC,WAAW,IAAI,CAAC,OAAO,EAAE,CAAC;gBAC3B,EAAE;gBACF,kDAAkD;gBAClD,EAAE;gBACF,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;YAClC,CAAC;YAED,gBAAgB;YAChB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC;QACrC,CAAC;IACL,CAAC;IAED,SAAS,CAAC,KAAe,EAAE,MAAM,EAAE,CAAC,EAAE;QAClC,qFAAqF;QAErF,8DAA8D;QAC9D,8DAA8D;QAC9D,MAAM;QAEN,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAChF,CAAC;IAED,aAAa,CAAC,IAAe,EAAE,YAAoB,EAAE,EAAY,EAAE,KAAK,GAAG,IAAI,CAAC,YAAY;QACxF,MAAM,UAAU,GAAG,EAAE,CAAC,MAAM,CAAC;QAE7B,yGAAyG;QACzG,kCAAkC;QAElC,mCAAmC;QACnC,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;QAE5D,OAAO,MAAM,CAAC,MAAM,CAAC;YACjB,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC;YAC5B,KAAK,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,CAAC,MAAM,CAAC;SACrC,CAAC,CAAC;IACP,CAAC;IAGD,8BAA8B;IAC9B,0EAA0E;IAC1E,6EAA6E;IAC7E,qDAAqD;IACrD,6CAA6C;IAC7C,mEAAmE;IACnE,iBAAiB;IACjB,YAAY;IACZ,UAAU;IACV,IAAI;IAEJ,UAAU,CAAC,IAAe,EAAE,YAAoB,EAAE,EAAY,EAAE,KAAK,GAAG,IAAI,CAAC,YAAY;QACrF,MAAM,UAAU,GAAG,EAAE,CAAC,MAAM,CAAC;QAE7B,mCAAmC;QACnC,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAEzD,uDAAuD;QACvD,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACnD,KAAK,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,mBAAmB,EAAE,CAAC;YACtD,IAAI,OAAO,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;gBACrB,4DAA4D;gBAC5D,sEAAsE;gBACtE,SAAS;YACb,CAAC;YAED,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC;YAE3B,MAAM,IAAI,GAAG,GAAG,CAAC,aAAa,CAAC,CAAC;YAChC,MAAM,OAAO,GAAG,IAAI,CAAC,kBAAQ,CAAC,CAAC;YAE/B,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,0BAAmB,GAAG,GAAG,CAAC;YAC/C,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YAE3C,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;YAE1C,KAAK,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,IAAI,eAAe,EAAE,CAAC;gBACpD,sBAAsB;gBACtB,iBAAiB;gBACjB,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YAC7E,CAAC;QACL,CAAC;QAED,EAAE;QACF,4DAA4D;QAC5D,uDAAuD;QACvD,EAAE;QACF,sCAAsC;QACtC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QAErB,OAAO,MAAM,CAAC,MAAM,CAAC;YACjB,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC;YAC5B,KAAK,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,CAAC,MAAM,CAAC;SACrC,CAAC,CAAC;IACP,CAAC;IAED,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO;QACxC,MAAM,mBAAmB,GAAG,WAAW,CAAC,OAAO,EAAE,CAAC;QAClD,KAAK,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,mBAAmB,EAAE,CAAC;YAChD,UAAU,CAAC,SAAS,EAAE,CAAC;QAC3B,CAAC;IACL,CAAC;IAED,cAAc;QACV,yBAAyB;QACzB,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACrC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QAC/B,CAAC;QACD,2BAA2B;QAC3B,IAAI,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YACtC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;YAC7C,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QACvC,CAAC;IACL,CAAC;IAED,eAAe,CAAE,KAAa,EAAE,QAAuB,EAAE,UAAyB,EAAE,EAAY;QAC5F,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,UAAU,KAAK,YAAY,EAAE,CAAC;YAC9B,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,cAAO,GAAG,GAAG,CAAC;YACnC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC;QAC3C,CAAC;IACL,CAAC;;AAvOL,0BAwOC","sourcesContent":["import type { Schema } from \"../Schema\";\nimport { TypeContext } from \"../annotations\";\nimport { $changes, $encoder, $filter } from \"../types/symbols\";\n\nimport * as encode from \"../encoding/encode\";\nimport type { Iterator } from \"../encoding/decode\";\n\nimport { OPERATION, SWITCH_TO_STRUCTURE, TYPE_ID } from '../encoding/spec';\nimport { Root } from \"./ChangeTree\";\nimport { getNextPowerOf2 } from \"../utils\";\nimport { StateView } from \"./StateView\";\nimport { Metadata } from \"../Metadata\";\n\nexport class Encoder<T extends Schema = any> {\n    static BUFFER_SIZE = 8 * 1024;// 8KB\n    sharedBuffer = Buffer.allocUnsafeSlow(Encoder.BUFFER_SIZE);\n\n    context: TypeContext;\n    state: T;\n\n    $root: Root;\n\n    constructor(root: T) {\n        this.setRoot(root);\n\n        //\n        // TODO: cache and restore \"Context\" based on root schema\n        // (to avoid creating a new context for every new room)\n        //\n        this.context = new TypeContext(root.constructor as typeof Schema);\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 setRoot(state: T) {\n        this.$root = new Root();\n        this.state = state;\n        state[$changes].setRoot(this.$root);\n    }\n\n    encode(\n        it: Iterator = { offset: 0 },\n        view?: StateView,\n        bytes = this.sharedBuffer,\n        changeTrees = this.$root.changes\n    ): Buffer {\n        const initialOffset = it.offset; // cache current offset in case we need to resize the buffer\n\n        const isEncodeAll = this.$root.allChanges === changeTrees;\n        const hasView = (view !== undefined);\n        const rootChangeTree = this.state[$changes];\n\n        const changeTreesIterator = changeTrees.entries();\n\n        for (const [changeTree, changes] of changeTreesIterator) {\n            const ref = changeTree.ref;\n\n            const ctor = ref['constructor'];\n            const encoder = ctor[$encoder];\n            const filter = ctor[$filter];\n\n            if (hasView) {\n                if (!view.items.has(changeTree)) {\n                    view.invisible.add(changeTree);\n                    continue; // skip this change tree\n\n                } else if (view.invisible.has(changeTree)) {\n                    view.invisible.delete(changeTree); // remove from invisible list\n                }\n            }\n\n            // skip root `refId` if it's the first change tree\n            if (it.offset !== initialOffset || changeTree !== rootChangeTree) {\n                bytes[it.offset++] = SWITCH_TO_STRUCTURE & 255;\n                encode.number(bytes, changeTree.refId, it);\n            }\n\n            const changesIterator = changes.entries();\n\n            for (const [fieldIndex, operation] of changesIterator) {\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 (filter && !filter(ref, fieldIndex, view)) {\n                    // console.log(\"SKIP FIELD:\", { ref: changeTree.ref.constructor.name, fieldIndex, })\n\n                    // console.log(\"ADD AS INVISIBLE:\", fieldIndex, changeTree.ref.constructor.name)\n                    // view?.invisible.add(changeTree);\n                    continue;\n                }\n\n                // console.log(\"WILL ENCODE\", {\n                //     ref: changeTree.ref.constructor.name,\n                //     fieldIndex,\n                //     operation: OPERATION[operation],\n                // });\n\n                encoder(this, bytes, changeTree, fieldIndex, operation, it, isEncodeAll, hasView);\n            }\n        }\n\n        if (it.offset > bytes.byteLength) {\n            const newSize = getNextPowerOf2(this.sharedBuffer.byteLength * 2);\n            console.warn(\"@colyseus/schema encode buffer overflow. Current buffer size: \" + bytes.byteLength + \", encoding offset: \" + it.offset + \", new size: \" + newSize);\n\n            //\n            // resize buffer and re-encode (TODO: can we avoid re-encoding here?)\n            //\n            this.sharedBuffer = Buffer.allocUnsafeSlow(newSize);\n            return this.encode({ offset: initialOffset }, view);\n\n        } else {\n            //\n            // only clear changes after making sure buffer resize is not required.\n            //\n            if (!isEncodeAll && !hasView) {\n                //\n                // FIXME: avoid iterating over change trees twice.\n                //\n                this.onEndEncode(changeTrees);\n            }\n\n            // return bytes;\n            return bytes.slice(0, it.offset);\n        }\n    }\n\n    encodeAll(it: Iterator = { offset: 0 }) {\n        // console.log(`encodeAll(), this.$root.allChanges (${this.$root.allChanges.size})`);\n\n        // Array.from(this.$root.allChanges.entries()).map((item) => {\n        //     console.log(\"->\", item[0].refId, item[0].ref.toJSON());\n        // });\n\n        return this.encode(it, undefined, this.sharedBuffer, this.$root.allChanges);\n    }\n\n    encodeAllView(view: StateView, sharedOffset: number, it: Iterator, bytes = this.sharedBuffer) {\n        const viewOffset = it.offset;\n\n        // console.log(`encodeAllView(), this.$root.allFilteredChanges (${this.$root.allFilteredChanges.size})`);\n        // this.debugAllFilteredChanges();\n\n        // try to encode \"filtered\" changes\n        this.encode(it, view, bytes, this.$root.allFilteredChanges);\n\n        return Buffer.concat([\n            bytes.slice(0, sharedOffset),\n            bytes.slice(viewOffset, it.offset)\n        ]);\n    }\n\n\n    // debugAllFilteredChanges() {\n    //     Array.from(this.$root.allFilteredChanges.entries()).map((item) => {\n    //         console.log(\"->\", { refId: item[0].refId }, item[0].ref.toJSON());\n    //         if (Array.isArray(item[0].ref.toJSON())) {\n    //             item[1].forEach((op, key) => {\n    //                 console.log(\"  ->\", { key, op: OPERATION[op] });\n    //             })\n    //         }\n    //     });\n    // }\n\n    encodeView(view: StateView, sharedOffset: number, it: Iterator, bytes = this.sharedBuffer) {\n        const viewOffset = it.offset;\n\n        // try to encode \"filtered\" changes\n        this.encode(it, view, bytes, this.$root.filteredChanges);\n\n        // encode visibility changes (add/remove for this view)\n        const viewChangesIterator = view.changes.entries();\n        for (const [changeTree, changes] of viewChangesIterator) {\n            if (changes.size === 0) {\n                // FIXME: avoid having empty changes if no changes were made\n                // console.log(\"changes.size === 0\", 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\n            bytes[it.offset++] = SWITCH_TO_STRUCTURE & 255;\n            encode.number(bytes, changeTree.refId, it);\n\n            const changesIterator = changes.entries();\n\n            for (const [fieldIndex, operation] of changesIterator) {\n                // isEncodeAll = false\n                // hasView = true\n                encoder(this, bytes, changeTree, fieldIndex, operation, it, false, true);\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        return Buffer.concat([\n            bytes.slice(0, sharedOffset),\n            bytes.slice(viewOffset, it.offset)\n        ]);\n    }\n\n    onEndEncode(changeTrees = this.$root.changes) {\n        const changeTreesIterator = changeTrees.entries();\n        for (const [changeTree, _] of changeTreesIterator) {\n            changeTree.endEncode();\n        }\n    }\n\n    discardChanges() {\n        // discard shared changes\n        if (this.$root.changes.size > 0) {\n            this.onEndEncode(this.$root.changes);\n            this.$root.changes.clear();\n        }\n        // discard filtered changes\n        if (this.$root.filteredChanges.size > 0) {\n            this.onEndEncode(this.$root.filteredChanges);\n            this.$root.filteredChanges.clear();\n        }\n    }\n\n    tryEncodeTypeId (bytes: Buffer, baseType: typeof Schema, targetType: typeof Schema, it: Iterator) {\n        const baseTypeId = this.context.getTypeId(baseType);\n        const targetTypeId = this.context.getTypeId(targetType);\n\n        if (baseTypeId !== targetTypeId) {\n            bytes[it.offset++] = TYPE_ID & 255;\n            encode.number(bytes, targetTypeId, it);\n        }\n    }\n}"]}

package/lib/encoder/StateView.d.ts

@@ -0,0 +1,21 @@
+import { ChangeTree, Ref } from "./ChangeTree";
+import { OPERATION } from "../encoding/spec";
+export declare class StateView {
+    /**
+     * List of ChangeTree's that are visible to this view
+     */
+    items: WeakSet<ChangeTree>;
+    /**
+     * List of ChangeTree's that are invisible to this view
+     */
+    invisible: WeakSet<ChangeTree>;
+    tags?: WeakMap<ChangeTree, Set<number>>;
+    /**
+     * Manual "ADD" operations for changes per ChangeTree, specific to this view.
+     * (This is used to force encoding a property, even if it was not changed)
+     */
+    changes: Map<ChangeTree<any>, Map<number, OPERATION>>;
+    add(obj: Ref, tag?: number): this;
+    protected addParent(changeTree: ChangeTree, tag: number): void;
+    remove(obj: Ref, tag?: number): this;
+}

package/lib/encoder/StateView.js

@@ -0,0 +1,196 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StateView = void 0;
+const symbols_1 = require("../types/symbols");
+const annotations_1 = require("../annotations");
+const spec_1 = require("../encoding/spec");
+const Metadata_1 = require("../Metadata");
+class StateView {
+    constructor() {
+        /**
+         * List of ChangeTree's that are visible to this view
+         */
+        this.items = new WeakSet();
+        /**
+         * List of ChangeTree's that are invisible to this view
+         */
+        this.invisible = new WeakSet();
+        /**
+         * Manual "ADD" operations for changes per ChangeTree, specific to this view.
+         * (This is used to force encoding a property, even if it was not changed)
+         */
+        this.changes = new Map();
+    }
+    // TODO: allow to set multiple tags at once
+    add(obj, tag = annotations_1.DEFAULT_VIEW_TAG) {
+        if (!obj[symbols_1.$changes]) {
+            console.warn("StateView#add(), invalid object:", obj);
+            return this;
+        }
+        let changeTree = obj[symbols_1.$changes];
+        this.items.add(changeTree);
+        // Add children of this ChangeTree to this view
+        changeTree.forEachChild((change, _) => this.add(change.ref, tag));
+        // FIXME: ArraySchema/MapSchema does not have metadata
+        const metadata = obj.constructor[Symbol.metadata];
+        // add parent ChangeTree's, if they are invisible to this view
+        // TODO: REFACTOR addParent()
+        this.addParent(changeTree, tag);
+        //
+        // TODO: when adding an item of a MapSchema, the changes may not
+        // be set (only the parent's changes are set)
+        //
+        let changes = this.changes.get(changeTree);
+        if (changes === undefined) {
+            changes = new Map();
+            this.changes.set(changeTree, changes);
+        }
+        // set tag
+        if (tag !== annotations_1.DEFAULT_VIEW_TAG) {
+            if (!this.tags) {
+                this.tags = new WeakMap();
+            }
+            let tags;
+            if (!this.tags.has(changeTree)) {
+                tags = new Set();
+                this.tags.set(changeTree, tags);
+            }
+            else {
+                tags = this.tags.get(changeTree);
+            }
+            tags.add(tag);
+            // console.log("BY TAG:", tag);
+            // Ref: add tagged properties
+            metadata?.[-3]?.[tag]?.forEach((index) => {
+                if (changeTree.getChange(index) !== spec_1.OPERATION.DELETE) {
+                    changes.set(index, spec_1.OPERATION.ADD);
+                }
+            });
+        }
+        else {
+            // console.log("DEFAULT TAG", changeTree.allChanges);
+            // // add default tag properties
+            // metadata?.[-3]?.[DEFAULT_VIEW_TAG]?.forEach((index) => {
+            //     if (changeTree.getChange(index) !== OPERATION.DELETE) {
+            //         changes.set(index, OPERATION.ADD);
+            //     }
+            // });
+            const allChangesSet = (changeTree.isFiltered || changeTree.isPartiallyFiltered)
+                ? changeTree.allFilteredChanges
+                : changeTree.allChanges;
+            const it = allChangesSet.keys();
+            const isInvisible = this.invisible.has(changeTree);
+            for (const index of it) {
+                if ((isInvisible || metadata?.[metadata?.[index]].tag === tag) &&
+                    changeTree.getChange(index) !== spec_1.OPERATION.DELETE) {
+                    changes.set(index, spec_1.OPERATION.ADD);
+                }
+            }
+        }
+        // TODO: avoid unnecessary iteration here
+        while (changeTree.parent &&
+            (changeTree = changeTree.parent[symbols_1.$changes]) &&
+            (changeTree.isFiltered || changeTree.isPartiallyFiltered)) {
+            this.items.add(changeTree);
+        }
+        return this;
+    }
+    addParent(changeTree, tag) {
+        const parentRef = changeTree.parent;
+        if (!parentRef) {
+            return;
+        }
+        const parentChangeTree = parentRef[symbols_1.$changes];
+        const parentIndex = changeTree.parentIndex;
+        if (!this.invisible.has(parentChangeTree)) {
+            // parent is already available, no need to add it!
+            return;
+        }
+        this.addParent(parentChangeTree, tag);
+        // add parent's tag properties
+        if (parentChangeTree.getChange(parentIndex) !== spec_1.OPERATION.DELETE) {
+            let parentChanges = this.changes.get(parentChangeTree);
+            if (parentChanges === undefined) {
+                parentChanges = new Map();
+                this.changes.set(parentChangeTree, parentChanges);
+            }
+            // console.log("add parent change", {
+            //     parentIndex,
+            //     parentChanges,
+            //     parentChange: (
+            //         parentChangeTree.getChange(parentIndex) &&
+            //         OPERATION[parentChangeTree.getChange(parentIndex)]
+            //     ),
+            // })
+            if (!this.tags) {
+                this.tags = new WeakMap();
+            }
+            let tags;
+            if (!this.tags.has(parentChangeTree)) {
+                tags = new Set();
+                this.tags.set(parentChangeTree, tags);
+            }
+            else {
+                tags = this.tags.get(parentChangeTree);
+            }
+            tags.add(tag);
+            parentChanges.set(parentIndex, spec_1.OPERATION.ADD);
+        }
+    }
+    remove(obj, tag = annotations_1.DEFAULT_VIEW_TAG) {
+        const changeTree = obj[symbols_1.$changes];
+        if (!changeTree) {
+            console.warn("StateView#remove(), invalid object:", obj);
+            return this;
+        }
+        this.items.delete(changeTree);
+        const ref = changeTree.ref;
+        const metadata = ref.constructor[Symbol.metadata];
+        let changes = this.changes.get(changeTree);
+        if (changes === undefined) {
+            changes = new Map();
+            this.changes.set(changeTree, changes);
+        }
+        if (tag === annotations_1.DEFAULT_VIEW_TAG) {
+            // parent is collection (Map/Array)
+            const parent = changeTree.parent;
+            if (!Metadata_1.Metadata.isValidInstance(parent)) {
+                const parentChangeTree = parent[symbols_1.$changes];
+                let changes = this.changes.get(parentChangeTree);
+                if (changes === undefined) {
+                    changes = new Map();
+                    this.changes.set(parentChangeTree, changes);
+                }
+                // DELETE / DELETE BY REF ID
+                changes.set(changeTree.parentIndex, spec_1.OPERATION.DELETE);
+            }
+            else {
+                // delete all "tagged" properties.
+                metadata[-2].forEach((index) => changes.set(index, spec_1.OPERATION.DELETE));
+            }
+        }
+        else {
+            // delete only tagged properties
+            metadata[-3][tag].forEach((index) => changes.set(index, spec_1.OPERATION.DELETE));
+        }
+        // remove tag
+        if (this.tags && this.tags.has(changeTree)) {
+            const tags = this.tags.get(changeTree);
+            if (tag === undefined) {
+                // delete all tags
+                this.tags.delete(changeTree);
+            }
+            else {
+                // delete specific tag
+                tags.delete(tag);
+                // if tag set is empty, delete it entirely
+                if (tags.size === 0) {
+                    this.tags.delete(changeTree);
+                }
+            }
+        }
+        return this;
+    }
+}
+exports.StateView = StateView;
+//# sourceMappingURL=StateView.js.map

package/lib/encoder/StateView.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StateView.js","sourceRoot":"","sources":["../../src/encoder/StateView.ts"],"names":[],"mappings":";;;AACA,8CAA4C;AAC5C,gDAAkD;AAClD,2CAA6C;AAC7C,0CAAuC;AAEvC,MAAa,SAAS;IAAtB;QACI;;WAEG;QACH,UAAK,GAAwB,IAAI,OAAO,EAAc,CAAC;QAEvD;;WAEG;QACH,cAAS,GAAwB,IAAI,OAAO,EAAc,CAAC;QAI3D;;;WAGG;QACH,YAAO,GAAG,IAAI,GAAG,EAAsC,CAAC;IA6M5D,CAAC;IA3MG,2CAA2C;IAC3C,GAAG,CAAC,GAAQ,EAAE,MAAc,8BAAgB;QACxC,IAAI,CAAC,GAAG,CAAC,kBAAQ,CAAC,EAAE,CAAC;YACjB,OAAO,CAAC,IAAI,CAAC,kCAAkC,EAAE,GAAG,CAAC,CAAC;YACtD,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,IAAI,UAAU,GAAe,GAAG,CAAC,kBAAQ,CAAC,CAAC;QAC3C,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAE3B,+CAA+C;QAC/C,UAAU,CAAC,YAAY,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAClC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QAE/B,sDAAsD;QACtD,MAAM,QAAQ,GAAa,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAE5D,8DAA8D;QAC9D,6BAA6B;QAC7B,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QAEhC,EAAE;QACF,gEAAgE;QAChE,6CAA6C;QAC7C,EAAE;QACF,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC3C,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,GAAG,IAAI,GAAG,EAAqB,CAAC;YACvC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;QACzC,CAAC;QAED,UAAU;QACV,IAAI,GAAG,KAAK,8BAAgB,EAAE,CAAC;YAC3B,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gBACb,IAAI,CAAC,IAAI,GAAG,IAAI,OAAO,EAA2B,CAAC;YACvD,CAAC;YACD,IAAI,IAAiB,CAAC;YACtB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC7B,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;gBACzB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YACpC,CAAC;iBAAM,CAAC;gBACJ,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACrC,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAEd,+BAA+B;YAE/B,6BAA6B;YAC7B,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBACrC,IAAI,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,gBAAS,CAAC,MAAM,EAAE,CAAC;oBACnD,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,gBAAS,CAAC,GAAG,CAAC,CAAA;gBACrC,CAAC;YACL,CAAC,CAAC,CAAC;QAEP,CAAC;aAAM,CAAC;YAEJ,qDAAqD;YAErD,gCAAgC;YAChC,2DAA2D;YAC3D,8DAA8D;YAC9D,6CAA6C;YAC7C,QAAQ;YACR,MAAM;YAEN,MAAM,aAAa,GAAG,CAAC,UAAU,CAAC,UAAU,IAAI,UAAU,CAAC,mBAAmB,CAAC;gBAC3E,CAAC,CAAC,UAAU,CAAC,kBAAkB;gBAC/B,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC;YAC5B,MAAM,EAAE,GAAG,aAAa,CAAC,IAAI,EAAE,CAAC;YAChC,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAEnD,KAAK,MAAM,KAAK,IAAI,EAAE,EAAE,CAAC;gBACrB,IACI,CAAC,WAAW,IAAI,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC;oBAC1D,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,gBAAS,CAAC,MAAM,EAClD,CAAC;oBACC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,gBAAS,CAAC,GAAG,CAAC,CAAC;gBACtC,CAAC;YACL,CAAC;QACL,CAAC;QAED,yCAAyC;QACzC,OACI,UAAU,CAAC,MAAM;YACjB,CAAC,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,kBAAQ,CAAC,CAAC;YAC1C,CAAC,UAAU,CAAC,UAAU,IAAI,UAAU,CAAC,mBAAmB,CAAC,EAC3D,CAAC;YACC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC/B,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAES,SAAS,CAAC,UAAsB,EAAE,GAAW;QACnD,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC;QACpC,IAAI,CAAC,SAAS,EAAE,CAAC;YAAC,OAAO;QAAC,CAAC;QAE3B,MAAM,gBAAgB,GAAG,SAAS,CAAC,kBAAQ,CAAC,CAAC;QAC7C,MAAM,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;QAE3C,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACxC,kDAAkD;YAClD,OAAO;QACX,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;QAEtC,8BAA8B;QAC9B,IAAI,gBAAgB,CAAC,SAAS,CAAC,WAAW,CAAC,KAAK,gBAAS,CAAC,MAAM,EAAE,CAAC;YAE/D,IAAI,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;YACvD,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gBAC9B,aAAa,GAAG,IAAI,GAAG,EAAqB,CAAC;gBAC7C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC;YACtD,CAAC;YAED,qCAAqC;YACrC,mBAAmB;YACnB,qBAAqB;YACrB,sBAAsB;YACtB,qDAAqD;YACrD,6DAA6D;YAC7D,SAAS;YACT,KAAK;YAEL,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gBAAC,IAAI,CAAC,IAAI,GAAG,IAAI,OAAO,EAA2B,CAAC;YAAC,CAAC;YACvE,IAAI,IAAiB,CAAC;YACtB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBACnC,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;gBACzB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;YAC1C,CAAC;iBAAM,CAAC;gBACJ,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;YAC3C,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAEd,aAAa,CAAC,GAAG,CAAC,WAAW,EAAE,gBAAS,CAAC,GAAG,CAAC,CAAC;QAClD,CAAC;IAEL,CAAC;IAED,MAAM,CAAC,GAAQ,EAAE,MAAc,8BAAgB;QAC3C,MAAM,UAAU,GAAG,GAAG,CAAC,kBAAQ,CAAC,CAAC;QACjC,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,GAAG,CAAC,CAAC;YACzD,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAE9B,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC;QAC3B,MAAM,QAAQ,GAAa,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAE5D,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC3C,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,GAAG,IAAI,GAAG,EAAqB,CAAC;YACvC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;QACzC,CAAC;QAED,IAAI,GAAG,KAAK,8BAAgB,EAAE,CAAC;YAC3B,mCAAmC;YACnC,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;YACjC,IAAI,CAAC,mBAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;gBACpC,MAAM,gBAAgB,GAAG,MAAM,CAAC,kBAAQ,CAAC,CAAC;gBAC1C,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;gBACjD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;oBACxB,OAAO,GAAG,IAAI,GAAG,EAAqB,CAAC;oBACvC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAA;gBAC/C,CAAC;gBACD,4BAA4B;gBAC5B,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,EAAE,gBAAS,CAAC,MAAM,CAAC,CAAC;YAE1D,CAAC;iBAAM,CAAC;gBACJ,kCAAkC;gBAClC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAC3B,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,gBAAS,CAAC,MAAM,CAAC,CAAC,CAAC;YAC9C,CAAC;QAGL,CAAC;aAAM,CAAC;YACJ,gCAAgC;YAChC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAChC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,gBAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QAC9C,CAAC;QAED,aAAa;QACb,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACvC,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;gBACpB,kBAAkB;gBAClB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACjC,CAAC;iBAAM,CAAC;gBACJ,sBAAsB;gBACtB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBAEjB,0CAA0C;gBAC1C,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;oBAClB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;gBACjC,CAAC;YACL,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AA9ND,8BA8NC","sourcesContent":["import { ChangeTree, Ref } from \"./ChangeTree\";\nimport { $changes } from \"../types/symbols\";\nimport { DEFAULT_VIEW_TAG } from \"../annotations\";\nimport { OPERATION } from \"../encoding/spec\";\nimport { Metadata } from \"../Metadata\";\n\nexport class StateView {\n    /**\n     * List of ChangeTree's that are visible to this view\n     */\n    items: WeakSet<ChangeTree> = new WeakSet<ChangeTree>();\n\n    /**\n     * List of ChangeTree's that are invisible to this view\n     */\n    invisible: WeakSet<ChangeTree> = new WeakSet<ChangeTree>();\n\n    tags?: WeakMap<ChangeTree, Set<number>>; // TODO: use bit manipulation instead of Set<number> ()\n\n    /**\n     * Manual \"ADD\" operations for changes per ChangeTree, specific to this view.\n     * (This is used to force encoding a property, even if it was not changed)\n     */\n    changes = new Map<ChangeTree, Map<number, OPERATION>>();\n\n    // TODO: allow to set multiple tags at once\n    add(obj: Ref, tag: number = DEFAULT_VIEW_TAG) {\n        if (!obj[$changes]) {\n            console.warn(\"StateView#add(), invalid object:\", obj);\n            return this;\n        }\n\n        let changeTree: ChangeTree = obj[$changes];\n        this.items.add(changeTree);\n\n        // Add children of this ChangeTree to this view\n        changeTree.forEachChild((change, _) =>\n            this.add(change.ref, tag));\n\n        // FIXME: ArraySchema/MapSchema does not have metadata\n        const metadata: Metadata = obj.constructor[Symbol.metadata];\n\n        // add parent ChangeTree's, if they are invisible to this view\n        // TODO: REFACTOR addParent()\n        this.addParent(changeTree, tag);\n\n        //\n        // TODO: when adding an item of a MapSchema, the changes may not\n        // be set (only the parent's changes are set)\n        //\n        let changes = this.changes.get(changeTree);\n        if (changes === undefined) {\n            changes = new Map<number, OPERATION>();\n            this.changes.set(changeTree, changes)\n        }\n\n        // set tag\n        if (tag !== DEFAULT_VIEW_TAG) {\n            if (!this.tags) {\n                this.tags = new WeakMap<ChangeTree, Set<number>>();\n            }\n            let tags: Set<number>;\n            if (!this.tags.has(changeTree)) {\n                tags = new Set<number>();\n                this.tags.set(changeTree, tags);\n            } else {\n                tags = this.tags.get(changeTree);\n            }\n            tags.add(tag);\n\n            // console.log(\"BY TAG:\", tag);\n\n            // Ref: add tagged properties\n            metadata?.[-3]?.[tag]?.forEach((index) => {\n                if (changeTree.getChange(index) !== OPERATION.DELETE) {\n                    changes.set(index, OPERATION.ADD)\n                }\n            });\n\n        } else {\n\n            // console.log(\"DEFAULT TAG\", changeTree.allChanges);\n\n            // // add default tag properties\n            // metadata?.[-3]?.[DEFAULT_VIEW_TAG]?.forEach((index) => {\n            //     if (changeTree.getChange(index) !== OPERATION.DELETE) {\n            //         changes.set(index, OPERATION.ADD);\n            //     }\n            // });\n\n            const allChangesSet = (changeTree.isFiltered || changeTree.isPartiallyFiltered)\n                ? changeTree.allFilteredChanges\n                : changeTree.allChanges;\n            const it = allChangesSet.keys();\n            const isInvisible = this.invisible.has(changeTree);\n\n            for (const index of it) {\n                if (\n                    (isInvisible || metadata?.[metadata?.[index]].tag === tag) &&\n                    changeTree.getChange(index) !== OPERATION.DELETE\n                ) {\n                    changes.set(index, OPERATION.ADD);\n                }\n            }\n        }\n\n        // TODO: avoid unnecessary iteration here\n        while (\n            changeTree.parent &&\n            (changeTree = changeTree.parent[$changes]) &&\n            (changeTree.isFiltered || changeTree.isPartiallyFiltered)\n        ) {\n            this.items.add(changeTree);\n        }\n\n        return this;\n    }\n\n    protected addParent(changeTree: ChangeTree, tag: number) {\n        const parentRef = changeTree.parent;\n        if (!parentRef) { return; }\n\n        const parentChangeTree = parentRef[$changes];\n        const parentIndex = changeTree.parentIndex;\n\n        if (!this.invisible.has(parentChangeTree)) {\n            // parent is already available, no need to add it!\n            return;\n        }\n\n        this.addParent(parentChangeTree, tag);\n\n        // add parent's tag properties\n        if (parentChangeTree.getChange(parentIndex) !== OPERATION.DELETE) {\n\n            let parentChanges = this.changes.get(parentChangeTree);\n            if (parentChanges === undefined) {\n                parentChanges = new Map<number, OPERATION>();\n                this.changes.set(parentChangeTree, parentChanges);\n            }\n\n            // console.log(\"add parent change\", {\n            //     parentIndex,\n            //     parentChanges,\n            //     parentChange: (\n            //         parentChangeTree.getChange(parentIndex) &&\n            //         OPERATION[parentChangeTree.getChange(parentIndex)]\n            //     ),\n            // })\n\n            if (!this.tags) { this.tags = new WeakMap<ChangeTree, Set<number>>(); }\n            let tags: Set<number>;\n            if (!this.tags.has(parentChangeTree)) {\n                tags = new Set<number>();\n                this.tags.set(parentChangeTree, tags);\n            } else {\n                tags = this.tags.get(parentChangeTree);\n            }\n            tags.add(tag);\n\n            parentChanges.set(parentIndex, OPERATION.ADD);\n        }\n\n    }\n\n    remove(obj: Ref, tag: number = DEFAULT_VIEW_TAG) {\n        const changeTree = obj[$changes];\n        if (!changeTree) {\n            console.warn(\"StateView#remove(), invalid object:\", obj);\n            return this;\n        }\n\n        this.items.delete(changeTree);\n\n        const ref = changeTree.ref;\n        const metadata: Metadata = ref.constructor[Symbol.metadata];\n\n        let changes = this.changes.get(changeTree);\n        if (changes === undefined) {\n            changes = new Map<number, OPERATION>();\n            this.changes.set(changeTree, changes)\n        }\n\n        if (tag === DEFAULT_VIEW_TAG) {\n            // parent is collection (Map/Array)\n            const parent = changeTree.parent;\n            if (!Metadata.isValidInstance(parent)) {\n                const parentChangeTree = parent[$changes];\n                let changes = this.changes.get(parentChangeTree);\n                if (changes === undefined) {\n                    changes = new Map<number, OPERATION>();\n                    this.changes.set(parentChangeTree, changes)\n                }\n                // DELETE / DELETE BY REF ID\n                changes.set(changeTree.parentIndex, OPERATION.DELETE);\n\n            } else {\n                // delete all \"tagged\" properties.\n                metadata[-2].forEach((index) =>\n                    changes.set(index, OPERATION.DELETE));\n            }\n\n\n        } else {\n            // delete only tagged properties\n            metadata[-3][tag].forEach((index) =>\n                changes.set(index, OPERATION.DELETE));\n        }\n\n        // remove tag\n        if (this.tags && this.tags.has(changeTree)) {\n            const tags = this.tags.get(changeTree);\n            if (tag === undefined) {\n                // delete all tags\n                this.tags.delete(changeTree);\n            } else {\n                // delete specific tag\n                tags.delete(tag);\n\n                // if tag set is empty, delete it entirely\n                if (tags.size === 0) {\n                    this.tags.delete(changeTree);\n                }\n            }\n        }\n\n        return this;\n    }\n}"]}

package/lib/encoding/assert.d.ts

@@ -0,0 +1,9 @@
+import { Schema } from "../Schema";
+import { CollectionSchema } from "../types/custom/CollectionSchema";
+import { MapSchema } from "../types/custom/MapSchema";
+import { SetSchema } from "../types/custom/SetSchema";
+import { ArraySchema } from "../types/custom/ArraySchema";
+export declare class EncodeSchemaError extends Error {
+}
+export declare function assertType(value: any, type: string, klass: Schema, field: string | number): void;
+export declare function assertInstanceType(value: Schema, type: typeof Schema | typeof ArraySchema | typeof MapSchema | typeof CollectionSchema | typeof SetSchema, klass: Schema, field: string | number): void;

package/lib/encoding/assert.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertInstanceType = exports.assertType = exports.EncodeSchemaError = void 0;
+class EncodeSchemaError extends Error {
+}
+exports.EncodeSchemaError = EncodeSchemaError;
+function assertType(value, type, klass, field) {
+    let typeofTarget;
+    let allowNull = false;
+    switch (type) {
+        case "number":
+        case "int8":
+        case "uint8":
+        case "int16":
+        case "uint16":
+        case "int32":
+        case "uint32":
+        case "int64":
+        case "uint64":
+        case "float32":
+        case "float64":
+            typeofTarget = "number";
+            if (isNaN(value)) {
+                console.log(`trying to encode "NaN" in ${klass.constructor.name}#${field}`);
+            }
+            break;
+        case "string":
+            typeofTarget = "string";
+            allowNull = true;
+            break;
+        case "boolean":
+            // boolean is always encoded as true/false based on truthiness
+            return;
+    }
+    if (typeof (value) !== typeofTarget && (!allowNull || (allowNull && value !== null))) {
+        let foundValue = `'${JSON.stringify(value)}'${(value && value.constructor && ` (${value.constructor.name})`) || ''}`;
+        throw new EncodeSchemaError(`a '${typeofTarget}' was expected, but ${foundValue} was provided in ${klass.constructor.name}#${field}`);
+    }
+}
+exports.assertType = assertType;
+function assertInstanceType(value, type, klass, field) {
+    if (!(value instanceof type)) {
+        throw new EncodeSchemaError(`a '${type.name}' was expected, but '${value && value.constructor.name}' was provided in ${klass.constructor.name}#${field}`);
+    }
+}
+exports.assertInstanceType = assertInstanceType;
+//# sourceMappingURL=assert.js.map

package/lib/encoding/assert.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert.js","sourceRoot":"","sources":["../../src/encoding/assert.ts"],"names":[],"mappings":";;;AAMA,MAAa,iBAAkB,SAAQ,KAAK;CAAG;AAA/C,8CAA+C;AAE/C,SAAgB,UAAU,CAAC,KAAU,EAAE,IAAY,EAAE,KAAa,EAAE,KAAsB;IACtF,IAAI,YAAoB,CAAC;IACzB,IAAI,SAAS,GAAY,KAAK,CAAC;IAE/B,QAAQ,IAAI,EAAE,CAAC;QACX,KAAK,QAAQ,CAAC;QACd,KAAK,MAAM,CAAC;QACZ,KAAK,OAAO,CAAC;QACb,KAAK,OAAO,CAAC;QACb,KAAK,QAAQ,CAAC;QACd,KAAK,OAAO,CAAC;QACb,KAAK,QAAQ,CAAC;QACd,KAAK,OAAO,CAAC;QACb,KAAK,QAAQ,CAAC;QACd,KAAK,SAAS,CAAC;QACf,KAAK,SAAS;YACV,YAAY,GAAG,QAAQ,CAAC;YACxB,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;gBACf,OAAO,CAAC,GAAG,CAAC,6BAA6B,KAAK,CAAC,WAAW,CAAC,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC;YAChF,CAAC;YACD,MAAM;QACV,KAAK,QAAQ;YACT,YAAY,GAAG,QAAQ,CAAC;YACxB,SAAS,GAAG,IAAI,CAAC;YACjB,MAAM;QACV,KAAK,SAAS;YACV,8DAA8D;YAC9D,OAAO;IACf,CAAC;IAED,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,YAAY,IAAI,CAAC,CAAC,SAAS,IAAI,CAAC,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,EAAE,CAAC;QACnF,IAAI,UAAU,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,WAAW,IAAI,KAAK,KAAK,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC;QACrH,MAAM,IAAI,iBAAiB,CAAC,MAAM,YAAY,uBAAuB,UAAU,oBAAoB,KAAK,CAAC,WAAW,CAAC,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC;IAC1I,CAAC;AACL,CAAC;AAlCD,gCAkCC;AAED,SAAgB,kBAAkB,CAC9B,KAAa,EACb,IAIsB,EACtB,KAAa,EACb,KAAsB;IAEtB,IAAI,CAAC,CAAC,KAAK,YAAY,IAAI,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,iBAAiB,CAAC,MAAM,IAAI,CAAC,IAAI,wBAAwB,KAAK,IAAK,KAAa,CAAC,WAAW,CAAC,IAAI,qBAAqB,KAAK,CAAC,WAAW,CAAC,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC;IACvK,CAAC;AACL,CAAC;AAbD,gDAaC","sourcesContent":["import { Schema } from \"../Schema\";\nimport { CollectionSchema } from \"../types/custom/CollectionSchema\";\nimport { MapSchema } from \"../types/custom/MapSchema\";\nimport { SetSchema } from \"../types/custom/SetSchema\";\nimport { ArraySchema } from \"../types/custom/ArraySchema\";\n\nexport class EncodeSchemaError extends Error {}\n\nexport function assertType(value: any, type: string, klass: Schema, field: string | number) {\n    let typeofTarget: string;\n    let allowNull: boolean = false;\n\n    switch (type) {\n        case \"number\":\n        case \"int8\":\n        case \"uint8\":\n        case \"int16\":\n        case \"uint16\":\n        case \"int32\":\n        case \"uint32\":\n        case \"int64\":\n        case \"uint64\":\n        case \"float32\":\n        case \"float64\":\n            typeofTarget = \"number\";\n            if (isNaN(value)) {\n                console.log(`trying to encode \"NaN\" in ${klass.constructor.name}#${field}`);\n            }\n            break;\n        case \"string\":\n            typeofTarget = \"string\";\n            allowNull = true;\n            break;\n        case \"boolean\":\n            // boolean is always encoded as true/false based on truthiness\n            return;\n    }\n\n    if (typeof (value) !== typeofTarget && (!allowNull || (allowNull && value !== null))) {\n        let foundValue = `'${JSON.stringify(value)}'${(value && value.constructor && ` (${value.constructor.name})`) || ''}`;\n        throw new EncodeSchemaError(`a '${typeofTarget}' was expected, but ${foundValue} was provided in ${klass.constructor.name}#${field}`);\n    }\n}\n\nexport function assertInstanceType(\n    value: Schema,\n    type: typeof Schema\n        | typeof ArraySchema\n        | typeof MapSchema\n        | typeof CollectionSchema\n        | typeof SetSchema,\n    klass: Schema,\n    field: string | number,\n) {\n    if (!(value instanceof type)) {\n        throw new EncodeSchemaError(`a '${type.name}' was expected, but '${value && (value as any).constructor.name}' was provided in ${klass.constructor.name}#${field}`);\n    }\n}"]}

package/lib/encoding/decode.js

@@ -23,7 +23,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.switchStructureCheck = exports.arrayCheck = exports.numberCheck = exports.number = exports.stringCheck = exports.string = exports.boolean = exports.readFloat64 = exports.readFloat32 = exports.uint64 = exports.int64 = exports.float64 = exports.float32 = exports.uint32 = exports.int32 = exports.uint16 = exports.int16 = exports.uint8 = exports.int8 = void 0;
-const spec_1 = require("../spec");
+const spec_1 = require("./spec");
 function utf8Read(bytes, offset, length) {
     var string = '', chr = 0;
     for (var i = offset, end = offset + length; i < end; i++) {