@colyseus/schema 4.0.2 → 4.0.3

package/lib/src/decoder/ReferenceTracker.js

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

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

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

package/lib/src/decoder/strategy/Callbacks.d.ts

@@ -1,154 +0,0 @@
-import { Collection, NonFunctionPropNames } from "../../types/HelperTypes";
-import { Ref } from "../../encoder/ChangeTree";
-import { Decoder } from "../Decoder";
-import { DataChange } from "../DecodeOperation";
-import { OPERATION } from "../../encoding/spec";
-import { Schema } from "../../Schema";
-import { $refId } from "../../types/symbols";
-import { MapSchema } from "../../types/custom/MapSchema";
-import { ArraySchema } from "../../types/custom/ArraySchema";
-import { type SchemaCallbackProxy } from "./getDecoderStateCallbacks";
-type PropertyChangeCallback<K> = (currentValue: K, previousValue: K) => void;
-type KeyValueCallback<K, V> = (key: K, value: V) => void;
-type InstanceChangeCallback = () => void;
-type PublicPropNames<T> = Exclude<NonFunctionPropNames<T>, typeof $refId> & string;
-type CollectionPropNames<T> = Exclude<{
-    [K in keyof T]: T[K] extends Collection<any, any> ? K : never;
-}[keyof T] & string, typeof $refId>;
-type CollectionValueType<T, K extends keyof T> = T[K] extends MapSchema<infer V, any> ? V : T[K] extends ArraySchema<infer V> ? V : T[K] extends Collection<any, infer V, any> ? V : never;
-type CollectionKeyType<T, K extends keyof T> = T[K] extends MapSchema<any, infer Key> ? Key : T[K] extends ArraySchema<any> ? number : T[K] extends Collection<infer Key, any, any> ? Key : never;
-/**
- * State Callbacks handler
- *
- * Usage:
- * ```ts
- * const $ = Callbacks.get(decoder);
- *
- * // Listen to property changes
- * $.listen("currentTurn", (currentValue, previousValue) => { ... });
- *
- * // Listen to collection additions
- * $.onAdd("entities", (sessionId, entity) => {
- *     // Nested property listening
- *     $.listen(entity, "hp", (currentHp, previousHp) => { ... });
- * });
- *
- * // Listen to collection removals
- * $.onRemove("entities", (sessionId, entity) => { ... });
- *
- * // Listen to any property change on an instance
- * $.onChange(entity, () => { ... });
- *
- * // Bind properties to another object
- * $.bindTo(player, playerVisual);
- * ```
- */
-export declare class StateCallbackStrategy<TState extends Schema> {
-    protected decoder: Decoder<TState>;
-    protected uniqueRefIds: Set<number>;
-    protected isTriggering: boolean;
-    constructor(decoder: Decoder<TState>);
-    protected get callbacks(): {
-        [refId: number]: import("../ReferenceTracker").SchemaCallbacks;
-    };
-    protected get state(): TState;
-    protected addCallback(refId: number, operationOrProperty: OPERATION | string, handler: Function): () => void;
-    protected addCallbackOrWaitCollectionAvailable<TInstance extends Schema, TReturn extends Ref>(instance: TInstance, propertyName: string, operation: OPERATION, handler: Function, immediate?: boolean): () => void;
-    /**
-     * Listen to property changes on the root state.
-     */
-    listen<K extends PublicPropNames<TState>>(property: K, handler: PropertyChangeCallback<TState[K]>, immediate?: boolean): () => void;
-    /**
-     * Listen to property changes on a nested instance.
-     */
-    listen<TInstance extends Schema, K extends PublicPropNames<TInstance>>(instance: TInstance, property: K, handler: PropertyChangeCallback<TInstance[K]>, immediate?: boolean): () => void;
-    protected listenInstance<TInstance extends Schema>(instance: TInstance, propertyName: string, handler: PropertyChangeCallback<any>, immediate?: boolean): () => void;
-    /**
-     * Listen to any property change on an instance.
-     */
-    onChange<TInstance extends Schema>(instance: TInstance, handler: InstanceChangeCallback): () => void;
-    /**
-     * Listen to item changes in a collection on root state.
-     */
-    onChange<K extends CollectionPropNames<TState>>(property: K, handler: KeyValueCallback<CollectionKeyType<TState, K>, CollectionValueType<TState, K>>): () => void;
-    /**
-     * Listen to item changes in a nested collection.
-     */
-    onChange<TInstance extends Schema, K extends CollectionPropNames<TInstance>>(instance: TInstance, property: K, handler: KeyValueCallback<CollectionKeyType<TInstance, K>, CollectionValueType<TInstance, K>>): () => void;
-    /**
-     * Listen to items added to a collection on root state.
-     */
-    onAdd<K extends CollectionPropNames<TState>>(property: K, handler: KeyValueCallback<CollectionKeyType<TState, K>, CollectionValueType<TState, K>>, immediate?: boolean): () => void;
-    /**
-     * Listen to items added to a nested collection.
-     */
-    onAdd<TInstance extends Schema, K extends CollectionPropNames<TInstance>>(instance: TInstance, property: K, handler: KeyValueCallback<CollectionKeyType<TInstance, K>, CollectionValueType<TInstance, K>>, immediate?: boolean): () => void;
-    /**
-     * Listen to items removed from a collection on root state.
-     */
-    onRemove<K extends CollectionPropNames<TState>>(property: K, handler: KeyValueCallback<CollectionKeyType<TState, K>, CollectionValueType<TState, K>>): () => void;
-    /**
-     * Listen to items removed from a nested collection.
-     */
-    onRemove<TInstance extends Schema, K extends CollectionPropNames<TInstance>>(instance: TInstance, property: K, handler: KeyValueCallback<CollectionKeyType<TInstance, K>, CollectionValueType<TInstance, K>>): () => void;
-    /**
-     * Bind properties from a Schema instance to a target object.
-     * Changes will be automatically reflected on the target object.
-     */
-    bindTo<TInstance extends Schema, TTarget>(from: TInstance, to: TTarget, properties?: string[], immediate?: boolean): () => void;
-    protected triggerChanges(allChanges: DataChange[]): void;
-}
-/**
- * Factory class for retrieving the callbacks API.
- */
-export declare const Callbacks: {
-    /**
-     * Get the new callbacks standard API.
-     *
-     * Usage:
-     * ```ts
-     * const callbacks = Callbacks.get(roomOrDecoder);
-     *
-     * // Listen to property changes
-     * callbacks.listen("currentTurn", (currentValue, previousValue) => { ... });
-     *
-     * // Listen to collection additions
-     * callbacks.onAdd("entities", (sessionId, entity) => {
-     *     // Nested property listening
-     *     callbacks.listen(entity, "hp", (currentHp, previousHp) => { ... });
-     * });
-     *
-     * // Listen to collection removals
-     * callbacks.onRemove("entities", (sessionId, entity) => { ... });
-     *
-     * // Listen to any property change on an instance
-     * callbacks.onChange(entity, () => { ... });
-     *
-     * // Bind properties to another object
-     * callbacks.bindTo(player, playerVisual);
-     * ```
-     *
-     * @param roomOrDecoder - Room or Decoder instance to get the callbacks for.
-     * @returns the new callbacks standard API.
-     */
-    get<T extends Schema>(roomOrDecoder: Decoder<T> | {
-        serializer: {
-            decoder: Decoder<T>;
-        };
-    }): StateCallbackStrategy<T>;
-    /**
-     * Get the legacy callbacks API.
-     *
-     * We aim to deprecate this API on 1.0, and iterate on improving Callbacks.get() API.
-     *
-     * @param roomOrDecoder - Room or Decoder instance to get the legacy callbacks for.
-     * @returns the legacy callbacks API.
-     */
-    getLegacy<T extends Schema>(roomOrDecoder: Decoder<T> | {
-        serializer: {
-            decoder: Decoder<T>;
-        };
-    }): SchemaCallbackProxy<T>;
-    getRawChanges(decoder: Decoder, callback: (changes: DataChange[]) => void): void;
-};
-export {};

package/lib/src/decoder/strategy/Callbacks.js

@@ -1,336 +0,0 @@
-import { Decoder } from "../Decoder";
-import { OPERATION } from "../../encoding/spec";
-import { Schema } from "../../Schema";
-import { $refId } from "../../types/symbols";
-import { getDecoderStateCallbacks } from "./getDecoderStateCallbacks";
-import { getRawChangesCallback } from "./RawChanges";
-/**
- * State Callbacks handler
- *
- * Usage:
- * ```ts
- * const $ = Callbacks.get(decoder);
- *
- * // Listen to property changes
- * $.listen("currentTurn", (currentValue, previousValue) => { ... });
- *
- * // Listen to collection additions
- * $.onAdd("entities", (sessionId, entity) => {
- *     // Nested property listening
- *     $.listen(entity, "hp", (currentHp, previousHp) => { ... });
- * });
- *
- * // Listen to collection removals
- * $.onRemove("entities", (sessionId, entity) => { ... });
- *
- * // Listen to any property change on an instance
- * $.onChange(entity, () => { ... });
- *
- * // Bind properties to another object
- * $.bindTo(player, playerVisual);
- * ```
- */
-export class StateCallbackStrategy {
-    constructor(decoder) {
-        this.uniqueRefIds = new Set();
-        this.isTriggering = false;
-        this.decoder = decoder;
-        this.decoder.triggerChanges = this.triggerChanges.bind(this);
-    }
-    get callbacks() {
-        return this.decoder.root.callbacks;
-    }
-    get state() {
-        return this.decoder.state;
-    }
-    addCallback(refId, operationOrProperty, handler) {
-        const $root = this.decoder.root;
-        return $root.addCallback(refId, operationOrProperty, handler);
-    }
-    addCallbackOrWaitCollectionAvailable(instance, propertyName, operation, handler, immediate = true) {
-        let removeHandler = () => { };
-        const removeOnAdd = () => removeHandler();
-        const collection = instance[propertyName];
-        // Collection not available yet. Listen for its availability before attaching the handler.
-        if (collection === null || collection === undefined) {
-            removeHandler = this.addCallback(instance[$refId], propertyName, (value, _) => {
-                if (value !== null && value !== undefined) {
-                    removeHandler = this.addCallback(value[$refId], operation, handler);
-                }
-            });
-            return removeOnAdd;
-        }
-        else {
-            //
-            // Call immediately if collection is already available, if it's an ADD operation.
-            //
-            immediate = immediate && this.isTriggering === false;
-            if (operation === OPERATION.ADD && immediate) {
-                collection.forEach((value, key) => {
-                    handler(key, value);
-                });
-            }
-            return this.addCallback(collection[$refId], operation, handler);
-        }
-    }
-    listen(...args) {
-        if (typeof args[0] === 'string') {
-            // listen(property, handler, immediate?)
-            return this.listenInstance(this.state, args[0], args[1], args[2]);
-        }
-        else {
-            // listen(instance, property, handler, immediate?)
-            return this.listenInstance(args[0], args[1], args[2], args[3]);
-        }
-    }
-    listenInstance(instance, propertyName, handler, immediate = true) {
-        immediate = immediate && this.isTriggering === false;
-        //
-        // Call handler immediately if property is already available.
-        //
-        const currentValue = instance[propertyName];
-        if (immediate && currentValue !== null && currentValue !== undefined) {
-            handler(currentValue, undefined);
-        }
-        return this.addCallback(instance[$refId], propertyName, handler);
-    }
-    onChange(...args) {
-        if (args.length === 2 && typeof args[0] !== 'string') {
-            // onChange(instance, handler) - instance change
-            const instance = args[0];
-            const handler = args[1];
-            return this.addCallback(instance[$refId], OPERATION.REPLACE, handler);
-        }
-        if (typeof args[0] === 'string') {
-            // onChange(property, handler) - collection on root state
-            return this.addCallbackOrWaitCollectionAvailable(this.state, args[0], OPERATION.REPLACE, args[1]);
-        }
-        else {
-            // onChange(instance, property, handler) - nested collection
-            return this.addCallbackOrWaitCollectionAvailable(args[0], args[1], OPERATION.REPLACE, args[2]);
-        }
-    }
-    onAdd(...args) {
-        if (typeof args[0] === 'string') {
-            // onAdd(property, handler, immediate?) - collection on root state
-            return this.addCallbackOrWaitCollectionAvailable(this.state, args[0], OPERATION.ADD, args[1], args[2] !== false);
-        }
-        else {
-            // onAdd(instance, property, handler, immediate?) - nested collection
-            return this.addCallbackOrWaitCollectionAvailable(args[0], args[1], OPERATION.ADD, args[2], args[3] !== false);
-        }
-    }
-    onRemove(...args) {
-        if (typeof args[0] === 'string') {
-            // onRemove(property, handler) - collection on root state
-            return this.addCallbackOrWaitCollectionAvailable(this.state, args[0], OPERATION.DELETE, args[1]);
-        }
-        else {
-            // onRemove(instance, property, handler) - nested collection
-            return this.addCallbackOrWaitCollectionAvailable(args[0], args[1], OPERATION.DELETE, args[2]);
-        }
-    }
-    /**
-     * Bind properties from a Schema instance to a target object.
-     * Changes will be automatically reflected on the target object.
-     */
-    bindTo(from, to, properties, immediate = true) {
-        const metadata = from.constructor[Symbol.metadata];
-        // If no properties specified, bind all properties
-        if (!properties) {
-            properties = Object.keys(metadata)
-                .filter(key => !isNaN(Number(key)))
-                .map((index) => metadata[index].name);
-        }
-        const action = () => {
-            for (const prop of properties) {
-                const fromValue = from[prop];
-                if (fromValue !== undefined) {
-                    to[prop] = fromValue;
-                }
-            }
-        };
-        if (immediate) {
-            action();
-        }
-        return this.addCallback(from[$refId], OPERATION.REPLACE, action);
-    }
-    triggerChanges(allChanges) {
-        this.uniqueRefIds.clear();
-        for (let i = 0, l = allChanges.length; i < l; i++) {
-            const change = allChanges[i];
-            const refId = change.refId;
-            const ref = change.ref;
-            const $callbacks = this.callbacks[refId];
-            if (!$callbacks) {
-                continue;
-            }
-            //
-            // trigger onRemove on child structure.
-            //
-            if ((change.op & OPERATION.DELETE) === OPERATION.DELETE &&
-                change.previousValue instanceof Schema) {
-                const childRefId = change.previousValue[$refId];
-                const deleteCallbacks = this.callbacks[childRefId]?.[OPERATION.DELETE];
-                if (deleteCallbacks) {
-                    for (let j = deleteCallbacks.length - 1; j >= 0; j--) {
-                        deleteCallbacks[j]();
-                    }
-                }
-            }
-            if (ref instanceof Schema) {
-                //
-                // Handle Schema instance
-                //
-                if (!this.uniqueRefIds.has(refId)) {
-                    // trigger onChange
-                    const replaceCallbacks = $callbacks[OPERATION.REPLACE];
-                    if (replaceCallbacks) {
-                        for (let j = replaceCallbacks.length - 1; j >= 0; j--) {
-                            try {
-                                replaceCallbacks[j]();
-                            }
-                            catch (e) {
-                                console.error(e);
-                            }
-                        }
-                    }
-                }
-                // trigger field callbacks
-                const fieldCallbacks = $callbacks[change.field];
-                if (fieldCallbacks) {
-                    for (let j = fieldCallbacks.length - 1; j >= 0; j--) {
-                        try {
-                            this.isTriggering = true;
-                            fieldCallbacks[j](change.value, change.previousValue);
-                        }
-                        catch (e) {
-                            console.error(e);
-                        }
-                        finally {
-                            this.isTriggering = false;
-                        }
-                    }
-                }
-            }
-            else {
-                //
-                // Handle collection of items
-                //
-                const dynamicIndex = change.dynamicIndex ?? change.field;
-                if ((change.op & OPERATION.DELETE) === OPERATION.DELETE) {
-                    //
-                    // FIXME: `previousValue` should always be available.
-                    //
-                    if (change.previousValue !== undefined) {
-                        // trigger onRemove (key, value)
-                        const deleteCallbacks = $callbacks[OPERATION.DELETE];
-                        if (deleteCallbacks) {
-                            for (let j = deleteCallbacks.length - 1; j >= 0; j--) {
-                                deleteCallbacks[j](dynamicIndex, change.previousValue);
-                            }
-                        }
-                    }
-                    // Handle DELETE_AND_ADD operation
-                    if ((change.op & OPERATION.ADD) === OPERATION.ADD) {
-                        const addCallbacks = $callbacks[OPERATION.ADD];
-                        if (addCallbacks) {
-                            this.isTriggering = true;
-                            for (let j = addCallbacks.length - 1; j >= 0; j--) {
-                                addCallbacks[j](dynamicIndex, change.value);
-                            }
-                            this.isTriggering = false;
-                        }
-                    }
-                }
-                else if ((change.op & OPERATION.ADD) === OPERATION.ADD &&
-                    change.previousValue !== change.value) {
-                    // trigger onAdd (key, value)
-                    const addCallbacks = $callbacks[OPERATION.ADD];
-                    if (addCallbacks) {
-                        this.isTriggering = true;
-                        for (let j = addCallbacks.length - 1; j >= 0; j--) {
-                            addCallbacks[j](dynamicIndex, change.value);
-                        }
-                        this.isTriggering = false;
-                    }
-                }
-                // trigger onChange (key, value)
-                if (change.value !== change.previousValue) {
-                    const replaceCallbacks = $callbacks[OPERATION.REPLACE];
-                    if (replaceCallbacks) {
-                        for (let j = replaceCallbacks.length - 1; j >= 0; j--) {
-                            replaceCallbacks[j](dynamicIndex, change.value);
-                        }
-                    }
-                }
-            }
-            this.uniqueRefIds.add(refId);
-        }
-    }
-}
-/**
- * Factory class for retrieving the callbacks API.
- */
-export const Callbacks = {
-    /**
-     * Get the new callbacks standard API.
-     *
-     * Usage:
-     * ```ts
-     * const callbacks = Callbacks.get(roomOrDecoder);
-     *
-     * // Listen to property changes
-     * callbacks.listen("currentTurn", (currentValue, previousValue) => { ... });
-     *
-     * // Listen to collection additions
-     * callbacks.onAdd("entities", (sessionId, entity) => {
-     *     // Nested property listening
-     *     callbacks.listen(entity, "hp", (currentHp, previousHp) => { ... });
-     * });
-     *
-     * // Listen to collection removals
-     * callbacks.onRemove("entities", (sessionId, entity) => { ... });
-     *
-     * // Listen to any property change on an instance
-     * callbacks.onChange(entity, () => { ... });
-     *
-     * // Bind properties to another object
-     * callbacks.bindTo(player, playerVisual);
-     * ```
-     *
-     * @param roomOrDecoder - Room or Decoder instance to get the callbacks for.
-     * @returns the new callbacks standard API.
-     */
-    get(roomOrDecoder) {
-        if (roomOrDecoder instanceof Decoder) {
-            return new StateCallbackStrategy(roomOrDecoder);
-        }
-        else if (roomOrDecoder.serializer.decoder) {
-            return new StateCallbackStrategy(roomOrDecoder.serializer.decoder);
-        }
-        else {
-            throw new Error('Invalid room or decoder');
-        }
-    },
-    /**
-     * Get the legacy callbacks API.
-     *
-     * We aim to deprecate this API on 1.0, and iterate on improving Callbacks.get() API.
-     *
-     * @param roomOrDecoder - Room or Decoder instance to get the legacy callbacks for.
-     * @returns the legacy callbacks API.
-     */
-    getLegacy(roomOrDecoder) {
-        if (roomOrDecoder instanceof Decoder) {
-            return getDecoderStateCallbacks(roomOrDecoder);
-        }
-        else if (roomOrDecoder.serializer.decoder) {
-            return getDecoderStateCallbacks(roomOrDecoder.serializer.decoder);
-        }
-    },
-    getRawChanges(decoder, callback) {
-        return getRawChangesCallback(decoder, callback);
-    }
-};
-//# sourceMappingURL=Callbacks.js.map