@colyseus/schema 3.0.0-alpha.12 → 3.0.0-alpha.14

package/build/umd/index.js

@@ -3994,29 +3994,26 @@
                     // Handle schema instance
                     //
                     if (!uniqueRefIds.has(refId)) {
-                        try {
-                            // trigger onChange
-                            const replaceCallbacks = $callbacks?.[exports.OPERATION.REPLACE];
-                            for (let i = replaceCallbacks?.length - 1; i >= 0; i--) {
-                                replaceCallbacks[i]();
-                            }
-                        }
-                        catch (e) {
-                            console.error(e);
+                        // trigger onChange
+                        const replaceCallbacks = $callbacks?.[exports.OPERATION.REPLACE];
+                        for (let i = replaceCallbacks?.length - 1; i >= 0; i--) {
+                            replaceCallbacks[i]();
+                            // try {
+                            // } catch (e) {
+                            //     console.error(e);
+                            // }
                         }
                     }
-                    try {
-                        if ($callbacks.hasOwnProperty(change.field)) {
-                            const fieldCallbacks = $callbacks[change.field];
-                            for (let i = fieldCallbacks?.length - 1; i >= 0; i--) {
-                                fieldCallbacks[i](change.value, change.previousValue);
-                            }
+                    if ($callbacks.hasOwnProperty(change.field)) {
+                        const fieldCallbacks = $callbacks[change.field];
+                        for (let i = fieldCallbacks?.length - 1; i >= 0; i--) {
+                            fieldCallbacks[i](change.value, change.previousValue);
+                            // try {
+                            // } catch (e) {
+                            //     console.error(e);
+                            // }
                         }
                     }
-                    catch (e) {
-                        //
-                        console.error(e);
-                    }
                 }
                 else {
                     //
@@ -4094,12 +4091,15 @@
                         return $root.addCallback($root.refIds.get(context.instance), exports.OPERATION.REPLACE, callback);
                     },
                     bindTo: function bindTo(targetObject, properties) {
-                        // return $root.addCallback(
-                        //     $root.refIds.get(context.instance),
-                        //     OPERATION.BIND,
-                        //     callback
-                        // );
-                        console.log("bindTo", targetObject, properties);
+                        //
+                        // TODO: refactor this implementation. There is room for improvement here.
+                        //
+                        if (!properties) {
+                            properties = Object.keys(metadata);
+                        }
+                        return $root.addCallback($root.refIds.get(context.instance), exports.OPERATION.REPLACE, () => {
+                            properties.forEach((prop) => targetObject[prop] = context.instance[prop]);
+                        });
                     }
                 }, {
                     get(target, prop) {
@@ -4190,7 +4190,10 @@
         function $(instance) {
             return getProxy(undefined, { instance });
         }
-        return $(decoder.state);
+        return {
+            $,
+            $state: $(decoder.state),
+        };
     }
 
     function getRawChangesCallback(decoder, callback) {

package/lib/decoder/strategy/StateCallbacks.d.ts

@@ -3,15 +3,49 @@ import { Decoder } from "../Decoder";
 import { Schema } from "../../Schema";
 export type CallbackProxy<T> = unknown extends T ? InstanceCallback<T> & CollectionCallback<any, any> : T extends Collection<infer K, infer V, infer _> ? CollectionCallback<K, V> : InstanceCallback<T>;
 type InstanceCallback<T> = {
+    /**
+     * Trigger callback when value of a property changes.
+     *
+     * @param prop name of the property
+     * @param callback callback to be triggered on property change
+     * @param immediate trigger immediatelly if property has been already set.
+     */
     listen<K extends NonFunctionPropNames<T>>(prop: K, callback: (value: T[K], previousValue: T[K]) => void, immediate?: boolean): any;
+    /**
+     * Trigger callback whenever any property changed within this instance.
+     *
+     * @param prop name of the property
+     * @param callback callback to be triggered on property change
+     * @param immediate trigger immediatelly if property has been already set.
+     */
     onChange(callback: () => void): void;
+    /**
+     * Bind properties to another object. Changes on the properties will be reflected on the target object.
+     *
+     * @param targetObject object to bind properties to
+     * @param properties list of properties to bind. If not provided, all properties will be bound.
+     */
     bindTo(targetObject: any, properties?: Array<NonFunctionPropNames<T>>): void;
 } & {
     [K in NonFunctionNonPrimitivePropNames<T>]: CallbackProxy<T[K]>;
 };
 type CollectionCallback<K, V> = {
+    /**
+     * Trigger callback when an item has been added to the collection.
+     *
+     * @param callback
+     * @param immediate
+     */
     onAdd(callback: (item: V, index: K) => void, immediate?: boolean): void;
+    /**
+     * Trigger callback when an item has been removed to the collection.
+     *
+     * @param callback
+     */
     onRemove(callback: (item: V, index: K) => void): void;
 };
-export declare function getStateCallbacks<T extends Schema>(decoder: Decoder<T>): CallbackProxy<T>;
+export declare function getStateCallbacks<T extends Schema>(decoder: Decoder<T>): {
+    $: (<F extends Schema>(instance: F) => CallbackProxy<F>);
+    $state: CallbackProxy<T>;
+};
 export {};

package/lib/decoder/strategy/StateCallbacks.js

@@ -32,29 +32,26 @@ function getStateCallbacks(decoder) {
                 // Handle schema instance
                 //
                 if (!uniqueRefIds.has(refId)) {
-                    try {
-                        // trigger onChange
-                        const replaceCallbacks = $callbacks?.[spec_1.OPERATION.REPLACE];
-                        for (let i = replaceCallbacks?.length - 1; i >= 0; i--) {
-                            replaceCallbacks[i]();
-                        }
-                    }
-                    catch (e) {
-                        console.error(e);
+                    // trigger onChange
+                    const replaceCallbacks = $callbacks?.[spec_1.OPERATION.REPLACE];
+                    for (let i = replaceCallbacks?.length - 1; i >= 0; i--) {
+                        replaceCallbacks[i]();
+                        // try {
+                        // } catch (e) {
+                        //     console.error(e);
+                        // }
                     }
                 }
-                try {
-                    if ($callbacks.hasOwnProperty(change.field)) {
-                        const fieldCallbacks = $callbacks[change.field];
-                        for (let i = fieldCallbacks?.length - 1; i >= 0; i--) {
-                            fieldCallbacks[i](change.value, change.previousValue);
-                        }
+                if ($callbacks.hasOwnProperty(change.field)) {
+                    const fieldCallbacks = $callbacks[change.field];
+                    for (let i = fieldCallbacks?.length - 1; i >= 0; i--) {
+                        fieldCallbacks[i](change.value, change.previousValue);
+                        // try {
+                        // } catch (e) {
+                        //     console.error(e);
+                        // }
                     }
                 }
-                catch (e) {
-                    //
-                    console.error(e);
-                }
             }
             else {
                 //
@@ -132,12 +129,15 @@ function getStateCallbacks(decoder) {
                     return $root.addCallback($root.refIds.get(context.instance), spec_1.OPERATION.REPLACE, callback);
                 },
                 bindTo: function bindTo(targetObject, properties) {
-                    // return $root.addCallback(
-                    //     $root.refIds.get(context.instance),
-                    //     OPERATION.BIND,
-                    //     callback
-                    // );
-                    console.log("bindTo", targetObject, properties);
+                    //
+                    // TODO: refactor this implementation. There is room for improvement here.
+                    //
+                    if (!properties) {
+                        properties = Object.keys(metadata);
+                    }
+                    return $root.addCallback($root.refIds.get(context.instance), spec_1.OPERATION.REPLACE, () => {
+                        properties.forEach((prop) => targetObject[prop] = context.instance[prop]);
+                    });
                 }
             }, {
                 get(target, prop) {
@@ -228,7 +228,10 @@ function getStateCallbacks(decoder) {
     function $(instance) {
         return getProxy(undefined, { instance });
     }
-    return $(decoder.state);
+    return {
+        $,
+        $state: $(decoder.state),
+    };
 }
 exports.getStateCallbacks = getStateCallbacks;
 //# sourceMappingURL=StateCallbacks.js.map

package/lib/decoder/strategy/StateCallbacks.js.map

@@ -1 +1 @@
-{"version":3,"file":"StateCallbacks.js","sourceRoot":"","sources":["../../../src/decoder/strategy/StateCallbacks.ts"],"names":[],"mappings":";;;AAKA,8CAAgD;AAEhD,yCAAsC;AA2CtC,SAAgB,iBAAiB,CAAmB,OAAmB;IACnE,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAC3B,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;IAElC,IAAI,iBAAiB,GAAG,KAAK,CAAC;IAE9B,OAAO,CAAC,cAAc,GAAG,UAAU,UAAwB;QACvD,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU,CAAC;QAEvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAChD,MAAM,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;YAC7B,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;YAC3B,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;YACvB,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;YAEpC,IAAI,CAAC,UAAU,EAAE,CAAC;gBAAC,SAAS;YAAC,CAAC;YAE9B,EAAE;YACF,uCAAuC;YACvC,EAAE;YACF,IACI,CAAC,MAAM,CAAC,EAAE,GAAG,gBAAS,CAAC,MAAM,CAAC,KAAK,gBAAS,CAAC,MAAM;gBACnD,MAAM,CAAC,aAAa,YAAY,eAAM,EACxC,CAAC;gBACC,MAAM,eAAe,GAAG,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,gBAAS,CAAC,MAAM,CAAC,CAAC;gBAC9F,KAAK,IAAI,CAAC,GAAG,eAAe,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;oBACpD,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC;gBACzB,CAAC;YACL,CAAC;YAED,IAAI,GAAG,YAAY,eAAM,EAAE,CAAC;gBACxB,EAAE;gBACF,yBAAyB;gBACzB,EAAE;gBAEF,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC3B,IAAI,CAAC;wBACD,mBAAmB;wBACnB,MAAM,gBAAgB,GAAG,UAAU,EAAE,CAAC,gBAAS,CAAC,OAAO,CAAC,CAAC;wBACzD,KAAK,IAAI,CAAC,GAAG,gBAAgB,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;4BACrD,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC;wBAC1B,CAAC;oBAEL,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACT,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBACrB,CAAC;gBACL,CAAC;gBAED,IAAI,CAAC;oBACD,IAAI,UAAU,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;wBAC1C,MAAM,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;wBAChD,KAAK,IAAI,CAAC,GAAG,cAAc,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;4BACnD,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC;wBAC1D,CAAC;oBACL,CAAC;gBAEL,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACT,EAAE;oBACF,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACrB,CAAC;YAEL,CAAC;iBAAM,CAAC;gBACJ,EAAE;gBACF,6BAA6B;gBAC7B,EAAE;gBAEF,IAAI,MAAM,CAAC,EAAE,KAAK,gBAAS,CAAC,GAAG,IAAI,MAAM,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;oBACpE,eAAe;oBAEf,iBAAiB,GAAG,IAAI,CAAC;oBACzB,MAAM,YAAY,GAAG,UAAU,CAAC,gBAAS,CAAC,GAAG,CAAC,CAAC;oBAC/C,KAAK,IAAI,CAAC,GAAG,YAAY,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;wBACjD,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,YAAY,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;oBACvE,CAAC;oBACD,iBAAiB,GAAG,KAAK,CAAC;gBAE9B,CAAC;qBAAM,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,gBAAS,CAAC,MAAM,CAAC,KAAK,gBAAS,CAAC,MAAM,EAAE,CAAC;oBAC7D,EAAE;oBACF,qDAAqD;oBACrD,EAAE;oBACF,IAAI,MAAM,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;wBACrC,kBAAkB;wBAClB,MAAM,eAAe,GAAG,UAAU,CAAC,gBAAS,CAAC,MAAM,CAAC,CAAC;wBACrD,KAAK,IAAI,CAAC,GAAG,eAAe,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;4BACpD,eAAe,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC,YAAY,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;wBAClF,CAAC;oBACL,CAAC;oBAED,mCAAmC;oBACnC,iDAAiD;oBACjD,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,gBAAS,CAAC,GAAG,CAAC,KAAK,gBAAS,CAAC,GAAG,EAAE,CAAC;wBAChD,MAAM,YAAY,GAAG,UAAU,CAAC,gBAAS,CAAC,GAAG,CAAC,CAAC;wBAC/C,KAAK,IAAI,CAAC,GAAG,YAAY,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;4BACjD,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,YAAY,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;wBACvE,CAAC;oBACL,CAAC;gBACL,CAAC;gBAED,mBAAmB;gBACnB,IAAI,MAAM,CAAC,KAAK,KAAK,MAAM,CAAC,aAAa,EAAE,CAAC;oBACxC,MAAM,gBAAgB,GAAG,UAAU,CAAC,gBAAS,CAAC,OAAO,CAAC,CAAC;oBACvD,KAAK,IAAI,CAAC,GAAG,gBAAgB,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;wBACrD,gBAAgB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,YAAY,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;oBAC3E,CAAC;gBACL,CAAC;YACL,CAAC;YAED,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;IACL,CAAC,CAAC;IAEF,SAAS,QAAQ,CAAC,cAAyC,EAAE,OAAoB;QAC7E,IAAI,QAAQ,GAAa,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,cAAc,CAAC;QAC1F,IAAI,YAAY,GAAG,CACf,CAAC,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,KAAK,UAAU,CAAC;YACzE,CAAC,cAAc,IAAI,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,WAAW,CAAC,CAC/E,CAAC;QAEF,IAAI,QAAQ,IAAI,CAAC,YAAY,EAAE,CAAC;YAE5B,MAAM,KAAK,GAAG,UACV,GAAQ,EACR,IAAY,EACZ,QAAkD,EAAE,SAAkB;gBAEtE,oBAAoB;gBACpB,IACI,SAAS;oBACT,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,SAAS;oBACpC,CAAC,iBAAiB,CAAC,8EAA8E;kBACnG,CAAC;oBACC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC;gBAChD,CAAC;gBACD,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;YACpE,CAAC,CAAA;YAED;;eAEG;YACH,OAAO,IAAI,KAAK,CAAC;gBACb,MAAM,EAAE,SAAS,MAAM,CAAC,IAAY,EAAE,QAAkD,EAAE,YAAqB,IAAI;oBAC/G,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;wBACnB,OAAO,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;oBAE9D,CAAC;yBAAM,CAAC;wBACJ,uCAAuC;wBACvC,OAAO,CAAC,mBAAmB,CAAC,CAAC,GAAQ,EAAE,QAAiB,EAAE,EAAE,CACxD,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,IAAI,QAAQ,CAAC,CAAC,CAAC;oBAC3D,CAAC;gBACL,CAAC;gBACD,QAAQ,EAAE,SAAS,QAAQ,CAAC,QAAoB;oBAC5C,OAAO,KAAK,CAAC,WAAW,CACpB,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAClC,gBAAS,CAAC,OAAO,EACjB,QAAQ,CACX,CAAC;gBACN,CAAC;gBACD,MAAM,EAAE,SAAS,MAAM,CAAC,YAAiB,EAAE,UAAqB;oBAC5D,4BAA4B;oBAC5B,0CAA0C;oBAC1C,sBAAsB;oBACtB,eAAe;oBACf,KAAK;oBACL,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC;gBACpD,CAAC;aACJ,EAAE;gBACC,GAAG,CAAC,MAAM,EAAE,IAAY;oBACpB,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;wBACjB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC;wBAC1C,MAAM,mBAAmB,GAAgC,CACrD,CAAC,QAA+C,EAAE,EAAE;4BAChD,MAAM,MAAM,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;gCACzD,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gCAEvB,2CAA2C;gCAC3C,sCAAsC;gCACtC,gCAAgC;gCAChC,EAAE;gCACF,MAAM,EAAE,EAAE,CAAC;4BACf,CAAC,EAAE,KAAK,CAAC,CAAC;4BAEV,qBAAqB;4BACrB,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,SAAS,EAAE,CAAC;gCAC3C,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;4BAC7B,CAAC;wBACL,CAAC,CACJ,CAAC;wBACF,OAAO,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE;4BACjC,QAAQ;4BACR,cAAc,EAAE,OAAO,CAAC,QAAQ;4BAChC,mBAAmB;yBACtB,CAAC,CAAC;oBAEP,CAAC;yBAAM,CAAC;wBACJ,yBAAyB;wBACzB,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;oBACxB,CAAC;gBACL,CAAC;gBACD,GAAG,CAAC,MAAM,EAAE,IAAY,IAAI,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC;gBAClE,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;gBAClD,cAAc,CAAC,CAAC,EAAE,EAAE,IAAI,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;aAC5D,CAAC,CAAC;QAEP,CAAC;aAAM,CAAC;YACJ;;eAEG;YAEH,MAAM,KAAK,GAAG,UAAU,GAAQ,EAAE,QAAwC,EAAE,SAAkB;gBAC1F,qCAAqC;gBACrC,IAAI,SAAS,EAAE,CAAC;oBACX,GAAmB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBAC3D,CAAC;gBACD,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,gBAAS,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YAC7E,CAAC,CAAC;YAEF,MAAM,QAAQ,GAAG,UAAU,GAAQ,EAAE,QAAwC;gBACzE,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,gBAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YAChF,CAAC,CAAC;YAEF,OAAO,IAAI,KAAK,CAAC;gBACb,KAAK,EAAE,UAAS,QAA8B,EAAE,YAAqB,IAAI;oBACrE,EAAE;oBACF,gDAAgD;oBAChD,kFAAkF;oBAClF,EAAE;oBACF,0FAA0F;oBAC1F,EAAE;oBACF,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;wBAC9B,uCAAuC;wBACvC,OAAO,CAAC,mBAAmB,CAAC,CAAC,GAAQ,EAAE,QAAiB,EAAE,EAAE,CACxD,KAAK,CAAC,GAAG,EAAE,QAAQ,EAAE,SAAS,IAAI,QAAQ,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;oBAE3E,CAAC;yBAAM,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;wBAC1B,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,IAAI,CAAC,iBAAiB,CAAC,CAAC;oBACvE,CAAC;gBACL,CAAC;gBACD,QAAQ,EAAE,UAAS,QAA8B;oBAC7C,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;wBAC9B,uCAAuC;wBACvC,OAAO,CAAC,mBAAmB,CAAC,CAAC,GAAQ,EAAE,EAAE,CACrC,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;oBAEjC,CAAC;yBAAM,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;wBAC1B,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;oBACzC,CAAC;gBACL,CAAC;aACJ,EAAE;gBACC,GAAG,CAAC,MAAM,EAAE,IAAY;oBACpB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;wBAChB,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,yDAAyD,CAAC,CAAC;oBACpG,CAAC;oBACD,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;gBACxB,CAAC;gBACD,GAAG,CAAC,MAAM,EAAE,IAAI,IAAI,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC;gBACxD,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;gBAClD,cAAc,CAAC,CAAC,EAAE,EAAE,IAAI,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;aAC5D,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IAED,SAAS,CAAC,CAAI,QAAW;QACrB,OAAO,QAAQ,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAqB,CAAC;IACjE,CAAC;IAED,OAAO,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC5B,CAAC;AA1QD,8CA0QC","sourcesContent":["import { Metadata } from \"../../Metadata\";\nimport { Collection, NonFunctionNonPrimitivePropNames, NonFunctionPropNames } from \"../../types/HelperTypes\";\nimport { Ref } from \"../../encoder/ChangeTree\";\nimport { Decoder } from \"../Decoder\";\nimport { DataChange } from \"../DecodeOperation\";\nimport { OPERATION } from \"../../encoding/spec\";\nimport { DefinitionType } from \"../../annotations\";\nimport { Schema } from \"../../Schema\";\nimport type { ArraySchema } from \"../../types/custom/ArraySchema\";\n\n//\n// Discussion: https://github.com/colyseus/schema/issues/155\n//\n// Main points:\n// - Decouple structures from their callbacks.\n// - Registering deep callbacks can be confusing.\n// - Avoid closures by allowing to pass a context. (https://github.com/colyseus/schema/issues/155#issuecomment-1804694081)\n//\n\nexport type CallbackProxy<T> = unknown extends T // is \"any\"?\n    ? InstanceCallback<T> & CollectionCallback<any, any>\n    : T extends Collection<infer K, infer V, infer _>\n        ? CollectionCallback<K, V>\n        : InstanceCallback<T>\n\ntype InstanceCallback<T> = {\n    listen<K extends NonFunctionPropNames<T>>(\n        prop: K,\n        callback: (value: T[K], previousValue: T[K]) => void,\n        immediate?: boolean,\n    )\n    onChange(callback: () => void): void;\n    bindTo(targetObject: any, properties?: Array<NonFunctionPropNames<T>>): void;\n} & {\n    [K in NonFunctionNonPrimitivePropNames<T>]: CallbackProxy<T[K]>;\n}\n\ntype CollectionCallback<K, V> = {\n    onAdd(callback: (item: V, index: K) => void, immediate?: boolean): void;\n    onRemove(callback: (item: V, index: K) => void): void;\n};\n\ntype OnInstanceAvailableCallback = (callback: (ref: Ref, existing: boolean) => void) => void;\n\ntype CallContext = {\n    instance?: any,\n    parentInstance?: any,\n    onInstanceAvailable?: OnInstanceAvailableCallback,\n}\n\nexport function getStateCallbacks<T extends Schema>(decoder: Decoder<T>): CallbackProxy<T> {\n    const $root = decoder.root;\n    const callbacks = $root.callbacks;\n\n    let isTriggeringOnAdd = false;\n\n    decoder.triggerChanges = function (allChanges: DataChange[]) {\n        const uniqueRefIds = new Set<number>();\n\n        for (let i = 0, l = allChanges.length; i < l; i++) {\n            const change = allChanges[i];\n            const refId = change.refId;\n            const ref = change.ref;\n            const $callbacks = callbacks[refId];\n\n            if (!$callbacks) { continue; }\n\n            //\n            // trigger onRemove on child structure.\n            //\n            if (\n                (change.op & OPERATION.DELETE) === OPERATION.DELETE &&\n                change.previousValue instanceof Schema\n            ) {\n                const deleteCallbacks = callbacks[$root.refIds.get(change.previousValue)]?.[OPERATION.DELETE];\n                for (let i = deleteCallbacks?.length - 1; i >= 0; i--) {\n                    deleteCallbacks[i]();\n                }\n            }\n\n            if (ref instanceof Schema) {\n                //\n                // Handle schema instance\n                //\n\n                if (!uniqueRefIds.has(refId)) {\n                    try {\n                        // trigger onChange\n                        const replaceCallbacks = $callbacks?.[OPERATION.REPLACE];\n                        for (let i = replaceCallbacks?.length - 1; i >= 0; i--) {\n                            replaceCallbacks[i]();\n                        }\n\n                    } catch (e) {\n                        console.error(e);\n                    }\n                }\n\n                try {\n                    if ($callbacks.hasOwnProperty(change.field)) {\n                        const fieldCallbacks = $callbacks[change.field];\n                        for (let i = fieldCallbacks?.length - 1; i >= 0; i--) {\n                            fieldCallbacks[i](change.value, change.previousValue);\n                        }\n                    }\n\n                } catch (e) {\n                    //\n                    console.error(e);\n                }\n\n            } else {\n                //\n                // Handle collection of items\n                //\n\n                if (change.op === OPERATION.ADD && change.previousValue === undefined) {\n                    // triger onAdd\n\n                    isTriggeringOnAdd = true;\n                    const addCallbacks = $callbacks[OPERATION.ADD];\n                    for (let i = addCallbacks?.length - 1; i >= 0; i--) {\n                        addCallbacks[i](change.value, change.dynamicIndex ?? change.field);\n                    }\n                    isTriggeringOnAdd = false;\n\n                } else if ((change.op & OPERATION.DELETE) === OPERATION.DELETE) {\n                    //\n                    // FIXME: `previousValue` should always be available.\n                    //\n                    if (change.previousValue !== undefined) {\n                        // triger onRemove\n                        const deleteCallbacks = $callbacks[OPERATION.DELETE];\n                        for (let i = deleteCallbacks?.length - 1; i >= 0; i--) {\n                            deleteCallbacks[i](change.previousValue, change.dynamicIndex ?? change.field);\n                        }\n                    }\n\n                    // Handle DELETE_AND_ADD operations\n                    // FIXME: should we set \"isTriggeringOnAdd\" here?\n                    if ((change.op & OPERATION.ADD) === OPERATION.ADD) {\n                        const addCallbacks = $callbacks[OPERATION.ADD];\n                        for (let i = addCallbacks?.length - 1; i >= 0; i--) {\n                            addCallbacks[i](change.value, change.dynamicIndex ?? change.field);\n                        }\n                    }\n                }\n\n                // trigger onChange\n                if (change.value !== change.previousValue) {\n                    const replaceCallbacks = $callbacks[OPERATION.REPLACE];\n                    for (let i = replaceCallbacks?.length - 1; i >= 0; i--) {\n                        replaceCallbacks[i](change.value, change.dynamicIndex ?? change.field);\n                    }\n                }\n            }\n\n            uniqueRefIds.add(refId);\n        }\n    };\n\n    function getProxy(metadataOrType: Metadata | DefinitionType, context: CallContext) {\n        let metadata: Metadata = context.instance?.constructor[Symbol.metadata] || metadataOrType;\n        let isCollection = (\n            (context.instance && typeof (context.instance['forEach']) === \"function\") ||\n            (metadataOrType && typeof (metadataOrType[Symbol.metadata]) === \"undefined\")\n        );\n\n        if (metadata && !isCollection) {\n\n            const onAdd = function (\n                ref: Ref,\n                prop: string,\n                callback: (value: any, previousValue: any) => void, immediate: boolean\n            ) {\n                // immediate trigger\n                if (\n                    immediate &&\n                    context.instance[prop] !== undefined &&\n                    !isTriggeringOnAdd // FIXME: This is a workaround (https://github.com/colyseus/schema/issues/147)\n                ) {\n                    callback(context.instance[prop], undefined);\n                }\n                return $root.addCallback($root.refIds.get(ref), prop, callback);\n            }\n\n            /**\n             * Schema instances\n             */\n            return new Proxy({\n                listen: function listen(prop: string, callback: (value: any, previousValue: any) => void, immediate: boolean = true) {\n                    if (context.instance) {\n                        return onAdd(context.instance, prop, callback, immediate);\n\n                    } else {\n                        // collection instance not received yet\n                        context.onInstanceAvailable((ref: Ref, existing: boolean) =>\n                            onAdd(ref, prop, callback, immediate && existing));\n                    }\n                },\n                onChange: function onChange(callback: () => void) {\n                    return $root.addCallback(\n                        $root.refIds.get(context.instance),\n                        OPERATION.REPLACE,\n                        callback\n                    );\n                },\n                bindTo: function bindTo(targetObject: any, properties?: string[]) {\n                    // return $root.addCallback(\n                    //     $root.refIds.get(context.instance),\n                    //     OPERATION.BIND,\n                    //     callback\n                    // );\n                    console.log(\"bindTo\", targetObject, properties);\n                }\n            }, {\n                get(target, prop: string) {\n                    if (metadata[prop]) {\n                        const instance = context.instance?.[prop];\n                        const onInstanceAvailable: OnInstanceAvailableCallback = (\n                            (callback: (ref: Ref, existing: boolean) => void) => {\n                                const unbind = $(context.instance).listen(prop, (value, _) => {\n                                    callback(value, false);\n\n                                    // FIXME: by \"unbinding\" the callback here,\n                                    // it will not support when the server\n                                    // re-instantiates the instance.\n                                    //\n                                    unbind?.();\n                                }, false);\n\n                                // has existing value\n                                if ($root.refIds.get(instance) !== undefined) {\n                                    callback(instance, true);\n                                }\n                            }\n                        );\n                        return getProxy(metadata[prop].type, {\n                            instance,\n                            parentInstance: context.instance,\n                            onInstanceAvailable,\n                        });\n\n                    } else {\n                        // accessing the function\n                        return target[prop];\n                    }\n                },\n                has(target, prop: string) { return metadata[prop] !== undefined; },\n                set(_, _1, _2) { throw new Error(\"not allowed\"); },\n                deleteProperty(_, _1) { throw new Error(\"not allowed\"); },\n            });\n\n        } else {\n            /**\n             * Collection instances\n             */\n\n            const onAdd = function (ref: Ref, callback: (value: any, key: any) => void, immediate: boolean) {\n                // Trigger callback on existing items\n                if (immediate) {\n                    (ref as ArraySchema).forEach((v, k) => callback(v, k));\n                }\n                return $root.addCallback($root.refIds.get(ref), OPERATION.ADD, callback);\n            };\n\n            const onRemove = function (ref: Ref, callback: (value: any, key: any) => void) {\n                return $root.addCallback($root.refIds.get(ref), OPERATION.DELETE, callback);\n            };\n\n            return new Proxy({\n                onAdd: function(callback: (value, key) => void, immediate: boolean = true) {\n                    //\n                    // https://github.com/colyseus/schema/issues/147\n                    // If parent instance has \"onAdd\" registered, avoid triggering immediate callback.\n                    //\n                    // FIXME: \"isTriggeringOnAdd\" is a workaround. We should find a better way to handle this.\n                    //\n                    if (context.onInstanceAvailable) {\n                        // collection instance not received yet\n                        context.onInstanceAvailable((ref: Ref, existing: boolean) =>\n                            onAdd(ref, callback, immediate && existing && !isTriggeringOnAdd));\n\n                    } else if (context.instance) {\n                        onAdd(context.instance, callback, immediate && !isTriggeringOnAdd);\n                    }\n                },\n                onRemove: function(callback: (value, key) => void) {\n                    if (context.onInstanceAvailable) {\n                        // collection instance not received yet\n                        context.onInstanceAvailable((ref: Ref) =>\n                            onRemove(ref, callback));\n\n                    } else if (context.instance) {\n                        onRemove(context.instance, callback);\n                    }\n                },\n            }, {\n                get(target, prop: string) {\n                    if (!target[prop]) {\n                        throw new Error(`Can't access '${prop}' through callback proxy. access the instance directly.`);\n                    }\n                    return target[prop];\n                },\n                has(target, prop) { return target[prop] !== undefined; },\n                set(_, _1, _2) { throw new Error(\"not allowed\"); },\n                deleteProperty(_, _1) { throw new Error(\"not allowed\"); },\n            });\n        }\n    }\n\n    function $<T>(instance: T): CallbackProxy<T> {\n        return getProxy(undefined, { instance }) as CallbackProxy<T>;\n    }\n\n    return $(decoder.state);\n}"]}
+{"version":3,"file":"StateCallbacks.js","sourceRoot":"","sources":["../../../src/decoder/strategy/StateCallbacks.ts"],"names":[],"mappings":";;;AAKA,8CAAgD;AAEhD,yCAAsC;AAmFtC,SAAgB,iBAAiB,CAC7B,OAAmB;IAKnB,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAC3B,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;IAElC,IAAI,iBAAiB,GAAG,KAAK,CAAC;IAE9B,OAAO,CAAC,cAAc,GAAG,UAAU,UAAwB;QACvD,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU,CAAC;QAEvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAChD,MAAM,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;YAC7B,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;YAC3B,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;YACvB,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;YAEpC,IAAI,CAAC,UAAU,EAAE,CAAC;gBAAC,SAAS;YAAC,CAAC;YAE9B,EAAE;YACF,uCAAuC;YACvC,EAAE;YACF,IACI,CAAC,MAAM,CAAC,EAAE,GAAG,gBAAS,CAAC,MAAM,CAAC,KAAK,gBAAS,CAAC,MAAM;gBACnD,MAAM,CAAC,aAAa,YAAY,eAAM,EACxC,CAAC;gBACC,MAAM,eAAe,GAAG,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,gBAAS,CAAC,MAAM,CAAC,CAAC;gBAC9F,KAAK,IAAI,CAAC,GAAG,eAAe,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;oBACpD,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC;gBACzB,CAAC;YACL,CAAC;YAED,IAAI,GAAG,YAAY,eAAM,EAAE,CAAC;gBACxB,EAAE;gBACF,yBAAyB;gBACzB,EAAE;gBAEF,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC3B,mBAAmB;oBACnB,MAAM,gBAAgB,GAAG,UAAU,EAAE,CAAC,gBAAS,CAAC,OAAO,CAAC,CAAC;oBACzD,KAAK,IAAI,CAAC,GAAG,gBAAgB,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;wBACrD,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC;wBACtB,QAAQ;wBACR,gBAAgB;wBAChB,wBAAwB;wBACxB,IAAI;oBACR,CAAC;gBACL,CAAC;gBAED,IAAI,UAAU,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC1C,MAAM,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;oBAChD,KAAK,IAAI,CAAC,GAAG,cAAc,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;wBACnD,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC;wBACtD,QAAQ;wBACR,gBAAgB;wBAChB,wBAAwB;wBACxB,IAAI;oBACR,CAAC;gBACL,CAAC;YAGL,CAAC;iBAAM,CAAC;gBACJ,EAAE;gBACF,6BAA6B;gBAC7B,EAAE;gBAEF,IAAI,MAAM,CAAC,EAAE,KAAK,gBAAS,CAAC,GAAG,IAAI,MAAM,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;oBACpE,eAAe;oBAEf,iBAAiB,GAAG,IAAI,CAAC;oBACzB,MAAM,YAAY,GAAG,UAAU,CAAC,gBAAS,CAAC,GAAG,CAAC,CAAC;oBAC/C,KAAK,IAAI,CAAC,GAAG,YAAY,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;wBACjD,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,YAAY,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;oBACvE,CAAC;oBACD,iBAAiB,GAAG,KAAK,CAAC;gBAE9B,CAAC;qBAAM,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,gBAAS,CAAC,MAAM,CAAC,KAAK,gBAAS,CAAC,MAAM,EAAE,CAAC;oBAC7D,EAAE;oBACF,qDAAqD;oBACrD,EAAE;oBACF,IAAI,MAAM,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;wBACrC,kBAAkB;wBAClB,MAAM,eAAe,GAAG,UAAU,CAAC,gBAAS,CAAC,MAAM,CAAC,CAAC;wBACrD,KAAK,IAAI,CAAC,GAAG,eAAe,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;4BACpD,eAAe,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC,YAAY,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;wBAClF,CAAC;oBACL,CAAC;oBAED,mCAAmC;oBACnC,iDAAiD;oBACjD,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,gBAAS,CAAC,GAAG,CAAC,KAAK,gBAAS,CAAC,GAAG,EAAE,CAAC;wBAChD,MAAM,YAAY,GAAG,UAAU,CAAC,gBAAS,CAAC,GAAG,CAAC,CAAC;wBAC/C,KAAK,IAAI,CAAC,GAAG,YAAY,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;4BACjD,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,YAAY,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;wBACvE,CAAC;oBACL,CAAC;gBACL,CAAC;gBAED,mBAAmB;gBACnB,IAAI,MAAM,CAAC,KAAK,KAAK,MAAM,CAAC,aAAa,EAAE,CAAC;oBACxC,MAAM,gBAAgB,GAAG,UAAU,CAAC,gBAAS,CAAC,OAAO,CAAC,CAAC;oBACvD,KAAK,IAAI,CAAC,GAAG,gBAAgB,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;wBACrD,gBAAgB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,YAAY,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;oBAC3E,CAAC;gBACL,CAAC;YACL,CAAC;YAED,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;IACL,CAAC,CAAC;IAEF,SAAS,QAAQ,CAAC,cAAyC,EAAE,OAAoB;QAC7E,IAAI,QAAQ,GAAa,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,cAAc,CAAC;QAC1F,IAAI,YAAY,GAAG,CACf,CAAC,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,KAAK,UAAU,CAAC;YACzE,CAAC,cAAc,IAAI,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,WAAW,CAAC,CAC/E,CAAC;QAEF,IAAI,QAAQ,IAAI,CAAC,YAAY,EAAE,CAAC;YAE5B,MAAM,KAAK,GAAG,UACV,GAAQ,EACR,IAAY,EACZ,QAAkD,EAAE,SAAkB;gBAEtE,oBAAoB;gBACpB,IACI,SAAS;oBACT,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,SAAS;oBACpC,CAAC,iBAAiB,CAAC,8EAA8E;kBACnG,CAAC;oBACC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC;gBAChD,CAAC;gBACD,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;YACpE,CAAC,CAAA;YAED;;eAEG;YACH,OAAO,IAAI,KAAK,CAAC;gBACb,MAAM,EAAE,SAAS,MAAM,CAAC,IAAY,EAAE,QAAkD,EAAE,YAAqB,IAAI;oBAC/G,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;wBACnB,OAAO,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;oBAE9D,CAAC;yBAAM,CAAC;wBACJ,uCAAuC;wBACvC,OAAO,CAAC,mBAAmB,CAAC,CAAC,GAAQ,EAAE,QAAiB,EAAE,EAAE,CACxD,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,IAAI,QAAQ,CAAC,CAAC,CAAC;oBAC3D,CAAC;gBACL,CAAC;gBACD,QAAQ,EAAE,SAAS,QAAQ,CAAC,QAAoB;oBAC5C,OAAO,KAAK,CAAC,WAAW,CACpB,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAClC,gBAAS,CAAC,OAAO,EACjB,QAAQ,CACX,CAAC;gBACN,CAAC;gBACD,MAAM,EAAE,SAAS,MAAM,CAAC,YAAiB,EAAE,UAAqB;oBAC5D,EAAE;oBACF,0EAA0E;oBAC1E,EAAE;oBACF,IAAI,CAAC,UAAU,EAAE,CAAC;wBACd,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;oBACvC,CAAC;oBACD,OAAO,KAAK,CAAC,WAAW,CACpB,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAClC,gBAAS,CAAC,OAAO,EACjB,GAAG,EAAE;wBACD,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CACxB,YAAY,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAA;oBACpD,CAAC,CACJ,CAAC;gBACN,CAAC;aACJ,EAAE;gBACC,GAAG,CAAC,MAAM,EAAE,IAAY;oBACpB,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;wBACjB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC;wBAC1C,MAAM,mBAAmB,GAAgC,CACrD,CAAC,QAA+C,EAAE,EAAE;4BAChD,MAAM,MAAM,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;gCACzD,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gCAEvB,2CAA2C;gCAC3C,sCAAsC;gCACtC,gCAAgC;gCAChC,EAAE;gCACF,MAAM,EAAE,EAAE,CAAC;4BACf,CAAC,EAAE,KAAK,CAAC,CAAC;4BAEV,qBAAqB;4BACrB,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,SAAS,EAAE,CAAC;gCAC3C,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;4BAC7B,CAAC;wBACL,CAAC,CACJ,CAAC;wBACF,OAAO,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE;4BACjC,QAAQ;4BACR,cAAc,EAAE,OAAO,CAAC,QAAQ;4BAChC,mBAAmB;yBACtB,CAAC,CAAC;oBAEP,CAAC;yBAAM,CAAC;wBACJ,yBAAyB;wBACzB,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;oBACxB,CAAC;gBACL,CAAC;gBACD,GAAG,CAAC,MAAM,EAAE,IAAY,IAAI,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC;gBAClE,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;gBAClD,cAAc,CAAC,CAAC,EAAE,EAAE,IAAI,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;aAC5D,CAAC,CAAC;QAEP,CAAC;aAAM,CAAC;YACJ;;eAEG;YAEH,MAAM,KAAK,GAAG,UAAU,GAAQ,EAAE,QAAwC,EAAE,SAAkB;gBAC1F,qCAAqC;gBACrC,IAAI,SAAS,EAAE,CAAC;oBACX,GAAmB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBAC3D,CAAC;gBACD,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,gBAAS,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YAC7E,CAAC,CAAC;YAEF,MAAM,QAAQ,GAAG,UAAU,GAAQ,EAAE,QAAwC;gBACzE,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,gBAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YAChF,CAAC,CAAC;YAEF,OAAO,IAAI,KAAK,CAAC;gBACb,KAAK,EAAE,UAAS,QAA8B,EAAE,YAAqB,IAAI;oBACrE,EAAE;oBACF,gDAAgD;oBAChD,kFAAkF;oBAClF,EAAE;oBACF,0FAA0F;oBAC1F,EAAE;oBACF,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;wBAC9B,uCAAuC;wBACvC,OAAO,CAAC,mBAAmB,CAAC,CAAC,GAAQ,EAAE,QAAiB,EAAE,EAAE,CACxD,KAAK,CAAC,GAAG,EAAE,QAAQ,EAAE,SAAS,IAAI,QAAQ,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;oBAE3E,CAAC;yBAAM,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;wBAC1B,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,IAAI,CAAC,iBAAiB,CAAC,CAAC;oBACvE,CAAC;gBACL,CAAC;gBACD,QAAQ,EAAE,UAAS,QAA8B;oBAC7C,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;wBAC9B,uCAAuC;wBACvC,OAAO,CAAC,mBAAmB,CAAC,CAAC,GAAQ,EAAE,EAAE,CACrC,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;oBAEjC,CAAC;yBAAM,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;wBAC1B,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;oBACzC,CAAC;gBACL,CAAC;aACJ,EAAE;gBACC,GAAG,CAAC,MAAM,EAAE,IAAY;oBACpB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;wBAChB,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,yDAAyD,CAAC,CAAC;oBACpG,CAAC;oBACD,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;gBACxB,CAAC;gBACD,GAAG,CAAC,MAAM,EAAE,IAAI,IAAI,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC;gBACxD,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;gBAClD,cAAc,CAAC,CAAC,EAAE,EAAE,IAAI,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;aAC5D,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IAED,SAAS,CAAC,CAAI,QAAW;QACrB,OAAO,QAAQ,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAqB,CAAC;IACjE,CAAC;IAED,OAAO;QACH,CAAC;QACD,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;KAC3B,CAAC;AACN,CAAC;AAxRD,8CAwRC","sourcesContent":["import { Metadata } from \"../../Metadata\";\nimport { Collection, NonFunctionNonPrimitivePropNames, NonFunctionPropNames } from \"../../types/HelperTypes\";\nimport { Ref } from \"../../encoder/ChangeTree\";\nimport { Decoder } from \"../Decoder\";\nimport { DataChange } from \"../DecodeOperation\";\nimport { OPERATION } from \"../../encoding/spec\";\nimport { DefinitionType } from \"../../annotations\";\nimport { Schema } from \"../../Schema\";\nimport type { ArraySchema } from \"../../types/custom/ArraySchema\";\n\n//\n// Discussion: https://github.com/colyseus/schema/issues/155\n//\n// Main points:\n// - Decouple structures from their callbacks.\n// - Registering deep callbacks can be confusing.\n// - Avoid closures by allowing to pass a context. (https://github.com/colyseus/schema/issues/155#issuecomment-1804694081)\n//\n\nexport type CallbackProxy<T> = unknown extends T // is \"any\"?\n    ? InstanceCallback<T> & CollectionCallback<any, any>\n    : T extends Collection<infer K, infer V, infer _>\n        ? CollectionCallback<K, V>\n        : InstanceCallback<T>;\n\ntype InstanceCallback<T> = {\n    /**\n     * Trigger callback when value of a property changes.\n     *\n     * @param prop name of the property\n     * @param callback callback to be triggered on property change\n     * @param immediate trigger immediatelly if property has been already set.\n     */\n    listen<K extends NonFunctionPropNames<T>>(\n        prop: K,\n        callback: (value: T[K], previousValue: T[K]) => void,\n        immediate?: boolean,\n    )\n    /**\n     * Trigger callback whenever any property changed within this instance.\n     *\n     * @param prop name of the property\n     * @param callback callback to be triggered on property change\n     * @param immediate trigger immediatelly if property has been already set.\n     */\n    onChange(callback: () => void): void;\n\n    /**\n     * Bind properties to another object. Changes on the properties will be reflected on the target object.\n     *\n     * @param targetObject object to bind properties to\n     * @param properties list of properties to bind. If not provided, all properties will be bound.\n     */\n    bindTo(targetObject: any, properties?: Array<NonFunctionPropNames<T>>): void;\n} & {\n    [K in NonFunctionNonPrimitivePropNames<T>]: CallbackProxy<T[K]>;\n}\n\ntype CollectionCallback<K, V> = {\n    /**\n     * Trigger callback when an item has been added to the collection.\n     *\n     * @param callback\n     * @param immediate\n     */\n    onAdd(callback: (item: V, index: K) => void, immediate?: boolean): void;\n\n    /**\n     * Trigger callback when an item has been removed to the collection.\n     *\n     * @param callback\n     */\n    onRemove(callback: (item: V, index: K) => void): void;\n\n    // /**\n    //  * Trigger callback when an item has been removed to the collection.\n    //  *\n    //  * @param callback\n    //  */\n    // onChange(callback: (item: V, index: K) => void): void;\n};\n\ntype OnInstanceAvailableCallback = (callback: (ref: Ref, existing: boolean) => void) => void;\n\ntype CallContext = {\n    instance?: any,\n    parentInstance?: any,\n    onInstanceAvailable?: OnInstanceAvailableCallback,\n}\n\nexport function getStateCallbacks<T extends Schema>(\n    decoder: Decoder<T>\n): {\n    $: (<F extends Schema>(instance: F) => CallbackProxy<F>),\n    $state: CallbackProxy<T>,\n} {\n    const $root = decoder.root;\n    const callbacks = $root.callbacks;\n\n    let isTriggeringOnAdd = false;\n\n    decoder.triggerChanges = function (allChanges: DataChange[]) {\n        const uniqueRefIds = new Set<number>();\n\n        for (let i = 0, l = allChanges.length; i < l; i++) {\n            const change = allChanges[i];\n            const refId = change.refId;\n            const ref = change.ref;\n            const $callbacks = callbacks[refId];\n\n            if (!$callbacks) { continue; }\n\n            //\n            // trigger onRemove on child structure.\n            //\n            if (\n                (change.op & OPERATION.DELETE) === OPERATION.DELETE &&\n                change.previousValue instanceof Schema\n            ) {\n                const deleteCallbacks = callbacks[$root.refIds.get(change.previousValue)]?.[OPERATION.DELETE];\n                for (let i = deleteCallbacks?.length - 1; i >= 0; i--) {\n                    deleteCallbacks[i]();\n                }\n            }\n\n            if (ref instanceof Schema) {\n                //\n                // Handle schema instance\n                //\n\n                if (!uniqueRefIds.has(refId)) {\n                    // trigger onChange\n                    const replaceCallbacks = $callbacks?.[OPERATION.REPLACE];\n                    for (let i = replaceCallbacks?.length - 1; i >= 0; i--) {\n                        replaceCallbacks[i]();\n                        // try {\n                        // } catch (e) {\n                        //     console.error(e);\n                        // }\n                    }\n                }\n\n                if ($callbacks.hasOwnProperty(change.field)) {\n                    const fieldCallbacks = $callbacks[change.field];\n                    for (let i = fieldCallbacks?.length - 1; i >= 0; i--) {\n                        fieldCallbacks[i](change.value, change.previousValue);\n                        // try {\n                        // } catch (e) {\n                        //     console.error(e);\n                        // }\n                    }\n                }\n\n\n            } else {\n                //\n                // Handle collection of items\n                //\n\n                if (change.op === OPERATION.ADD && change.previousValue === undefined) {\n                    // triger onAdd\n\n                    isTriggeringOnAdd = true;\n                    const addCallbacks = $callbacks[OPERATION.ADD];\n                    for (let i = addCallbacks?.length - 1; i >= 0; i--) {\n                        addCallbacks[i](change.value, change.dynamicIndex ?? change.field);\n                    }\n                    isTriggeringOnAdd = false;\n\n                } else if ((change.op & OPERATION.DELETE) === OPERATION.DELETE) {\n                    //\n                    // FIXME: `previousValue` should always be available.\n                    //\n                    if (change.previousValue !== undefined) {\n                        // triger onRemove\n                        const deleteCallbacks = $callbacks[OPERATION.DELETE];\n                        for (let i = deleteCallbacks?.length - 1; i >= 0; i--) {\n                            deleteCallbacks[i](change.previousValue, change.dynamicIndex ?? change.field);\n                        }\n                    }\n\n                    // Handle DELETE_AND_ADD operations\n                    // FIXME: should we set \"isTriggeringOnAdd\" here?\n                    if ((change.op & OPERATION.ADD) === OPERATION.ADD) {\n                        const addCallbacks = $callbacks[OPERATION.ADD];\n                        for (let i = addCallbacks?.length - 1; i >= 0; i--) {\n                            addCallbacks[i](change.value, change.dynamicIndex ?? change.field);\n                        }\n                    }\n                }\n\n                // trigger onChange\n                if (change.value !== change.previousValue) {\n                    const replaceCallbacks = $callbacks[OPERATION.REPLACE];\n                    for (let i = replaceCallbacks?.length - 1; i >= 0; i--) {\n                        replaceCallbacks[i](change.value, change.dynamicIndex ?? change.field);\n                    }\n                }\n            }\n\n            uniqueRefIds.add(refId);\n        }\n    };\n\n    function getProxy(metadataOrType: Metadata | DefinitionType, context: CallContext) {\n        let metadata: Metadata = context.instance?.constructor[Symbol.metadata] || metadataOrType;\n        let isCollection = (\n            (context.instance && typeof (context.instance['forEach']) === \"function\") ||\n            (metadataOrType && typeof (metadataOrType[Symbol.metadata]) === \"undefined\")\n        );\n\n        if (metadata && !isCollection) {\n\n            const onAdd = function (\n                ref: Ref,\n                prop: string,\n                callback: (value: any, previousValue: any) => void, immediate: boolean\n            ) {\n                // immediate trigger\n                if (\n                    immediate &&\n                    context.instance[prop] !== undefined &&\n                    !isTriggeringOnAdd // FIXME: This is a workaround (https://github.com/colyseus/schema/issues/147)\n                ) {\n                    callback(context.instance[prop], undefined);\n                }\n                return $root.addCallback($root.refIds.get(ref), prop, callback);\n            }\n\n            /**\n             * Schema instances\n             */\n            return new Proxy({\n                listen: function listen(prop: string, callback: (value: any, previousValue: any) => void, immediate: boolean = true) {\n                    if (context.instance) {\n                        return onAdd(context.instance, prop, callback, immediate);\n\n                    } else {\n                        // collection instance not received yet\n                        context.onInstanceAvailable((ref: Ref, existing: boolean) =>\n                            onAdd(ref, prop, callback, immediate && existing));\n                    }\n                },\n                onChange: function onChange(callback: () => void) {\n                    return $root.addCallback(\n                        $root.refIds.get(context.instance),\n                        OPERATION.REPLACE,\n                        callback\n                    );\n                },\n                bindTo: function bindTo(targetObject: any, properties?: string[]) {\n                    //\n                    // TODO: refactor this implementation. There is room for improvement here.\n                    //\n                    if (!properties) {\n                        properties = Object.keys(metadata);\n                    }\n                    return $root.addCallback(\n                        $root.refIds.get(context.instance),\n                        OPERATION.REPLACE,\n                        () => {\n                            properties.forEach((prop) =>\n                                targetObject[prop] = context.instance[prop])\n                        }\n                    );\n                }\n            }, {\n                get(target, prop: string) {\n                    if (metadata[prop]) {\n                        const instance = context.instance?.[prop];\n                        const onInstanceAvailable: OnInstanceAvailableCallback = (\n                            (callback: (ref: Ref, existing: boolean) => void) => {\n                                const unbind = $(context.instance).listen(prop, (value, _) => {\n                                    callback(value, false);\n\n                                    // FIXME: by \"unbinding\" the callback here,\n                                    // it will not support when the server\n                                    // re-instantiates the instance.\n                                    //\n                                    unbind?.();\n                                }, false);\n\n                                // has existing value\n                                if ($root.refIds.get(instance) !== undefined) {\n                                    callback(instance, true);\n                                }\n                            }\n                        );\n                        return getProxy(metadata[prop].type, {\n                            instance,\n                            parentInstance: context.instance,\n                            onInstanceAvailable,\n                        });\n\n                    } else {\n                        // accessing the function\n                        return target[prop];\n                    }\n                },\n                has(target, prop: string) { return metadata[prop] !== undefined; },\n                set(_, _1, _2) { throw new Error(\"not allowed\"); },\n                deleteProperty(_, _1) { throw new Error(\"not allowed\"); },\n            });\n\n        } else {\n            /**\n             * Collection instances\n             */\n\n            const onAdd = function (ref: Ref, callback: (value: any, key: any) => void, immediate: boolean) {\n                // Trigger callback on existing items\n                if (immediate) {\n                    (ref as ArraySchema).forEach((v, k) => callback(v, k));\n                }\n                return $root.addCallback($root.refIds.get(ref), OPERATION.ADD, callback);\n            };\n\n            const onRemove = function (ref: Ref, callback: (value: any, key: any) => void) {\n                return $root.addCallback($root.refIds.get(ref), OPERATION.DELETE, callback);\n            };\n\n            return new Proxy({\n                onAdd: function(callback: (value, key) => void, immediate: boolean = true) {\n                    //\n                    // https://github.com/colyseus/schema/issues/147\n                    // If parent instance has \"onAdd\" registered, avoid triggering immediate callback.\n                    //\n                    // FIXME: \"isTriggeringOnAdd\" is a workaround. We should find a better way to handle this.\n                    //\n                    if (context.onInstanceAvailable) {\n                        // collection instance not received yet\n                        context.onInstanceAvailable((ref: Ref, existing: boolean) =>\n                            onAdd(ref, callback, immediate && existing && !isTriggeringOnAdd));\n\n                    } else if (context.instance) {\n                        onAdd(context.instance, callback, immediate && !isTriggeringOnAdd);\n                    }\n                },\n                onRemove: function(callback: (value, key) => void) {\n                    if (context.onInstanceAvailable) {\n                        // collection instance not received yet\n                        context.onInstanceAvailable((ref: Ref) =>\n                            onRemove(ref, callback));\n\n                    } else if (context.instance) {\n                        onRemove(context.instance, callback);\n                    }\n                },\n            }, {\n                get(target, prop: string) {\n                    if (!target[prop]) {\n                        throw new Error(`Can't access '${prop}' through callback proxy. access the instance directly.`);\n                    }\n                    return target[prop];\n                },\n                has(target, prop) { return target[prop] !== undefined; },\n                set(_, _1, _2) { throw new Error(\"not allowed\"); },\n                deleteProperty(_, _1) { throw new Error(\"not allowed\"); },\n            });\n        }\n    }\n\n    function $<T>(instance: T): CallbackProxy<T> {\n        return getProxy(undefined, { instance }) as CallbackProxy<T>;\n    }\n\n    return {\n        $,\n        $state: $(decoder.state),\n    };\n}"]}

package/lib/index.d.ts

@@ -21,7 +21,7 @@ export { Reflection, ReflectionType, ReflectionField, } from "./Reflection";
 export { Metadata } from "./Metadata";
 export { type, deprecated, defineTypes, view, TypeContext, } from "./annotations";
 export type { DefinitionType, PrimitiveType, Definition, } from "./annotations";
-export { getStateCallbacks } from "./decoder/strategy/StateCallbacks";
+export { getStateCallbacks, CallbackProxy } from "./decoder/strategy/StateCallbacks";
 export { getRawChangesCallback } from "./decoder/strategy/RawChanges";
 export { Encoder } from "./encoder/Encoder";
 export { encodeSchemaOperation, encodeArray as encodeKeyValueOperation } from "./encoder/EncodeOperation";

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mCAAkC;AAAzB,gGAAA,MAAM,OAAA;AAGf,6CAAyH;AAChH,uFADA,gBAAM,OACA;AAAE,yFADA,kBAAQ,OACA;AAAE,yFADA,kBAAQ,OACA;AAAE,wFADA,iBAAO,OACA;AAAE,4FADA,qBAAW,OACA;AAAE,+FADA,wBAAc,OACA;AAAE,yFADA,kBAAQ,OACA;AAAE,2FADA,oBAAU,OACA;AAE/F,wDAAoD;AAC3C,0FADA,qBAAS,OACA;AAElB,4DAAyD;AAChD,4FADA,yBAAW,OACA;AAEpB,sEAAmE;AAC1D,iGADA,mCAAgB,OACA;AAEzB,wDAAqD;AAC5C,0FADA,qBAAS,OACA;AAElB,+CAAgD;AACvC,6FADA,uBAAY,OACA;AAErB,IAAA,uBAAY,EAAC,KAAK,EAAE,EAAE,WAAW,EAAE,qBAAS,EAAE,CAAC,CAAC;AAChD,IAAA,uBAAY,EAAC,OAAO,EAAE,EAAE,WAAW,EAAE,yBAAW,EAAE,CAAC,CAAC;AACpD,IAAA,uBAAY,EAAC,KAAK,EAAE,EAAE,WAAW,EAAE,qBAAS,EAAE,CAAC,CAAC;AAChD,IAAA,uBAAY,EAAC,YAAY,EAAE,EAAE,WAAW,EAAE,mCAAgB,GAAG,CAAC,CAAC;AAE/D,QAAQ;AACR,iCAAsC;AAA7B,oGAAA,WAAW,OAAA;AAIpB,4CAA4C;AAEnC,wBAAM;AADf,4CAA4C;AAC3B,wBAAM;AAEvB,aAAa;AACb,2CAIsB;AAHlB,wGAAA,UAAU,OAAA;AACV,4GAAA,cAAc,OAAA;AACd,6GAAA,eAAe,OAAA;AAGnB,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AAEjB,6CASuB;AARnB,cAAc;AACd,mGAAA,IAAI,OAAA;AACJ,yGAAA,UAAU,OAAA;AACV,0GAAA,WAAW,OAAA;AACX,mGAAA,IAAI,OAAA;AAEJ,YAAY;AACZ,0GAAA,WAAW,OAAA;AAMf,oEAAsE;AAA7D,mHAAA,iBAAiB,OAAA;AAC1B,4DAAsE;AAA7D,mHAAA,qBAAqB,OAAA;AAE9B,6CAA4C;AAAnC,kGAAA,OAAO,OAAA;AAChB,6DAA0G;AAAjG,wHAAA,qBAAqB,OAAA;AAAE,0HAAA,WAAW,OAA2B;AACtE,mDAAuD;AAA9C,wGAAA,UAAU,OAAA;AACnB,iDAAgD;AAAvC,sGAAA,SAAS,OAAA;AAElB,6CAA4C;AAAnC,kGAAA,OAAO,OAAA;AAChB,6DAA2F;AAAlF,wHAAA,qBAAqB,OAAA;AAAE,0HAAA,uBAAuB,OAAA;AAEvD,wCAA4C;AAAnC,iGAAA,SAAS,OAAA","sourcesContent":["export { Schema } from \"./Schema\";\nexport type { DataChange } from \"./decoder/DecodeOperation\";\n\nimport { $track, $encoder, $decoder, $filter, $getByIndex, $deleteByIndex, $changes, $childType } from \"./types/symbols\";\nexport { $track, $encoder, $decoder, $filter, $getByIndex, $deleteByIndex, $changes, $childType };\n\nimport { MapSchema } from \"./types/custom/MapSchema\"\nexport { MapSchema };\n\nimport { ArraySchema } from \"./types/custom/ArraySchema\";\nexport { ArraySchema };\n\nimport { CollectionSchema } from \"./types/custom/CollectionSchema\";\nexport { CollectionSchema };\n\nimport { SetSchema } from \"./types/custom/SetSchema\";\nexport { SetSchema };\n\nimport { registerType } from \"./types/registry\";\nexport { registerType };\n\nregisterType(\"map\", { constructor: MapSchema });\nregisterType(\"array\", { constructor: ArraySchema });\nregisterType(\"set\", { constructor: SetSchema });\nregisterType(\"collection\", { constructor: CollectionSchema, });\n\n// Utils\nexport { dumpChanges } from \"./utils\";\n\n// Encoder / Decoder\nexport type { Iterator } from \"./encoding/decode\";\nimport * as encode from \"./encoding/encode\";\nimport * as decode from \"./encoding/decode\";\nexport { encode, decode };\n\n// Reflection\nexport {\n    Reflection,\n    ReflectionType,\n    ReflectionField,\n} from \"./Reflection\";\n\nexport { Metadata } from \"./Metadata\";\n\nexport {\n    // Annotations\n    type,\n    deprecated,\n    defineTypes,\n    view,\n\n    // Internals\n    TypeContext,\n} from \"./annotations\";\n\n// Annotation types\nexport type { DefinitionType, PrimitiveType, Definition, } from \"./annotations\";\n\nexport { getStateCallbacks } from \"./decoder/strategy/StateCallbacks\";\nexport { getRawChangesCallback } from \"./decoder/strategy/RawChanges\";\n\nexport { Encoder } from \"./encoder/Encoder\";\nexport { encodeSchemaOperation, encodeArray as encodeKeyValueOperation } from \"./encoder/EncodeOperation\";\nexport { ChangeTree, Ref } from \"./encoder/ChangeTree\";\nexport { StateView } from \"./encoder/StateView\";\n\nexport { Decoder } from \"./decoder/Decoder\";\nexport { decodeSchemaOperation, decodeKeyValueOperation } from \"./decoder/DecodeOperation\";\n\nexport { OPERATION } from \"./encoding/spec\";"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mCAAkC;AAAzB,gGAAA,MAAM,OAAA;AAGf,6CAAyH;AAChH,uFADA,gBAAM,OACA;AAAE,yFADA,kBAAQ,OACA;AAAE,yFADA,kBAAQ,OACA;AAAE,wFADA,iBAAO,OACA;AAAE,4FADA,qBAAW,OACA;AAAE,+FADA,wBAAc,OACA;AAAE,yFADA,kBAAQ,OACA;AAAE,2FADA,oBAAU,OACA;AAE/F,wDAAoD;AAC3C,0FADA,qBAAS,OACA;AAElB,4DAAyD;AAChD,4FADA,yBAAW,OACA;AAEpB,sEAAmE;AAC1D,iGADA,mCAAgB,OACA;AAEzB,wDAAqD;AAC5C,0FADA,qBAAS,OACA;AAElB,+CAAgD;AACvC,6FADA,uBAAY,OACA;AAErB,IAAA,uBAAY,EAAC,KAAK,EAAE,EAAE,WAAW,EAAE,qBAAS,EAAE,CAAC,CAAC;AAChD,IAAA,uBAAY,EAAC,OAAO,EAAE,EAAE,WAAW,EAAE,yBAAW,EAAE,CAAC,CAAC;AACpD,IAAA,uBAAY,EAAC,KAAK,EAAE,EAAE,WAAW,EAAE,qBAAS,EAAE,CAAC,CAAC;AAChD,IAAA,uBAAY,EAAC,YAAY,EAAE,EAAE,WAAW,EAAE,mCAAgB,GAAG,CAAC,CAAC;AAE/D,QAAQ;AACR,iCAAsC;AAA7B,oGAAA,WAAW,OAAA;AAIpB,4CAA4C;AAEnC,wBAAM;AADf,4CAA4C;AAC3B,wBAAM;AAEvB,aAAa;AACb,2CAIsB;AAHlB,wGAAA,UAAU,OAAA;AACV,4GAAA,cAAc,OAAA;AACd,6GAAA,eAAe,OAAA;AAGnB,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AAEjB,6CASuB;AARnB,cAAc;AACd,mGAAA,IAAI,OAAA;AACJ,yGAAA,UAAU,OAAA;AACV,0GAAA,WAAW,OAAA;AACX,mGAAA,IAAI,OAAA;AAEJ,YAAY;AACZ,0GAAA,WAAW,OAAA;AAMf,oEAAqF;AAA5E,mHAAA,iBAAiB,OAAA;AAC1B,4DAAsE;AAA7D,mHAAA,qBAAqB,OAAA;AAE9B,6CAA4C;AAAnC,kGAAA,OAAO,OAAA;AAChB,6DAA0G;AAAjG,wHAAA,qBAAqB,OAAA;AAAE,0HAAA,WAAW,OAA2B;AACtE,mDAAuD;AAA9C,wGAAA,UAAU,OAAA;AACnB,iDAAgD;AAAvC,sGAAA,SAAS,OAAA;AAElB,6CAA4C;AAAnC,kGAAA,OAAO,OAAA;AAChB,6DAA2F;AAAlF,wHAAA,qBAAqB,OAAA;AAAE,0HAAA,uBAAuB,OAAA;AAEvD,wCAA4C;AAAnC,iGAAA,SAAS,OAAA","sourcesContent":["export { Schema } from \"./Schema\";\nexport type { DataChange } from \"./decoder/DecodeOperation\";\n\nimport { $track, $encoder, $decoder, $filter, $getByIndex, $deleteByIndex, $changes, $childType } from \"./types/symbols\";\nexport { $track, $encoder, $decoder, $filter, $getByIndex, $deleteByIndex, $changes, $childType };\n\nimport { MapSchema } from \"./types/custom/MapSchema\"\nexport { MapSchema };\n\nimport { ArraySchema } from \"./types/custom/ArraySchema\";\nexport { ArraySchema };\n\nimport { CollectionSchema } from \"./types/custom/CollectionSchema\";\nexport { CollectionSchema };\n\nimport { SetSchema } from \"./types/custom/SetSchema\";\nexport { SetSchema };\n\nimport { registerType } from \"./types/registry\";\nexport { registerType };\n\nregisterType(\"map\", { constructor: MapSchema });\nregisterType(\"array\", { constructor: ArraySchema });\nregisterType(\"set\", { constructor: SetSchema });\nregisterType(\"collection\", { constructor: CollectionSchema, });\n\n// Utils\nexport { dumpChanges } from \"./utils\";\n\n// Encoder / Decoder\nexport type { Iterator } from \"./encoding/decode\";\nimport * as encode from \"./encoding/encode\";\nimport * as decode from \"./encoding/decode\";\nexport { encode, decode };\n\n// Reflection\nexport {\n    Reflection,\n    ReflectionType,\n    ReflectionField,\n} from \"./Reflection\";\n\nexport { Metadata } from \"./Metadata\";\n\nexport {\n    // Annotations\n    type,\n    deprecated,\n    defineTypes,\n    view,\n\n    // Internals\n    TypeContext,\n} from \"./annotations\";\n\n// Annotation types\nexport type { DefinitionType, PrimitiveType, Definition, } from \"./annotations\";\n\nexport { getStateCallbacks, CallbackProxy } from \"./decoder/strategy/StateCallbacks\";\nexport { getRawChangesCallback } from \"./decoder/strategy/RawChanges\";\n\nexport { Encoder } from \"./encoder/Encoder\";\nexport { encodeSchemaOperation, encodeArray as encodeKeyValueOperation } from \"./encoder/EncodeOperation\";\nexport { ChangeTree, Ref } from \"./encoder/ChangeTree\";\nexport { StateView } from \"./encoder/StateView\";\n\nexport { Decoder } from \"./decoder/Decoder\";\nexport { decodeSchemaOperation, decodeKeyValueOperation } from \"./decoder/DecodeOperation\";\n\nexport { OPERATION } from \"./encoding/spec\";"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@colyseus/schema",
-  "version": "3.0.0-alpha.12",
+  "version": "3.0.0-alpha.14",
   "description": "Binary state serializer with delta encoding for games",
   "bin": {
     "schema-codegen": "./bin/schema-codegen"

package/src/decoder/strategy/StateCallbacks.ts

@@ -21,23 +21,63 @@ export type CallbackProxy<T> = unknown extends T // is "any"?
     ? InstanceCallback<T> & CollectionCallback<any, any>
     : T extends Collection<infer K, infer V, infer _>
         ? CollectionCallback<K, V>
-        : InstanceCallback<T>
+        : InstanceCallback<T>;
 
 type InstanceCallback<T> = {
+    /**
+     * Trigger callback when value of a property changes.
+     *
+     * @param prop name of the property
+     * @param callback callback to be triggered on property change
+     * @param immediate trigger immediatelly if property has been already set.
+     */
     listen<K extends NonFunctionPropNames<T>>(
         prop: K,
         callback: (value: T[K], previousValue: T[K]) => void,
         immediate?: boolean,
     )
+    /**
+     * Trigger callback whenever any property changed within this instance.
+     *
+     * @param prop name of the property
+     * @param callback callback to be triggered on property change
+     * @param immediate trigger immediatelly if property has been already set.
+     */
     onChange(callback: () => void): void;
+
+    /**
+     * Bind properties to another object. Changes on the properties will be reflected on the target object.
+     *
+     * @param targetObject object to bind properties to
+     * @param properties list of properties to bind. If not provided, all properties will be bound.
+     */
     bindTo(targetObject: any, properties?: Array<NonFunctionPropNames<T>>): void;
 } & {
     [K in NonFunctionNonPrimitivePropNames<T>]: CallbackProxy<T[K]>;
 }
 
 type CollectionCallback<K, V> = {
+    /**
+     * Trigger callback when an item has been added to the collection.
+     *
+     * @param callback
+     * @param immediate
+     */
     onAdd(callback: (item: V, index: K) => void, immediate?: boolean): void;
+
+    /**
+     * Trigger callback when an item has been removed to the collection.
+     *
+     * @param callback
+     */
     onRemove(callback: (item: V, index: K) => void): void;
+
+    // /**
+    //  * Trigger callback when an item has been removed to the collection.
+    //  *
+    //  * @param callback
+    //  */
+    // onChange(callback: (item: V, index: K) => void): void;
 };
 
 type OnInstanceAvailableCallback = (callback: (ref: Ref, existing: boolean) => void) => void;
@@ -48,7 +88,12 @@ type CallContext = {
     onInstanceAvailable?: OnInstanceAvailableCallback,
 }
 
-export function getStateCallbacks<T extends Schema>(decoder: Decoder<T>): CallbackProxy<T> {
+export function getStateCallbacks<T extends Schema>(
+    decoder: Decoder<T>
+): {
+    $: (<F extends Schema>(instance: F) => CallbackProxy<F>),
+    $state: CallbackProxy<T>,
+} {
     const $root = decoder.root;
     const callbacks = $root.callbacks;
 
@@ -84,31 +129,29 @@ export function getStateCallbacks<T extends Schema>(decoder: Decoder<T>): Callba
                 //
 
                 if (!uniqueRefIds.has(refId)) {
-                    try {
-                        // trigger onChange
-                        const replaceCallbacks = $callbacks?.[OPERATION.REPLACE];
-                        for (let i = replaceCallbacks?.length - 1; i >= 0; i--) {
-                            replaceCallbacks[i]();
-                        }
-
-                    } catch (e) {
-                        console.error(e);
+                    // trigger onChange
+                    const replaceCallbacks = $callbacks?.[OPERATION.REPLACE];
+                    for (let i = replaceCallbacks?.length - 1; i >= 0; i--) {
+                        replaceCallbacks[i]();
+                        // try {
+                        // } catch (e) {
+                        //     console.error(e);
+                        // }
                     }
                 }
 
-                try {
-                    if ($callbacks.hasOwnProperty(change.field)) {
-                        const fieldCallbacks = $callbacks[change.field];
-                        for (let i = fieldCallbacks?.length - 1; i >= 0; i--) {
-                            fieldCallbacks[i](change.value, change.previousValue);
-                        }
+                if ($callbacks.hasOwnProperty(change.field)) {
+                    const fieldCallbacks = $callbacks[change.field];
+                    for (let i = fieldCallbacks?.length - 1; i >= 0; i--) {
+                        fieldCallbacks[i](change.value, change.previousValue);
+                        // try {
+                        // } catch (e) {
+                        //     console.error(e);
+                        // }
                     }
-
-                } catch (e) {
-                    //
-                    console.error(e);
                 }
 
+
             } else {
                 //
                 // Handle collection of items
@@ -206,12 +249,20 @@ export function getStateCallbacks<T extends Schema>(decoder: Decoder<T>): Callba
                     );
                 },
                 bindTo: function bindTo(targetObject: any, properties?: string[]) {
-                    // return $root.addCallback(
-                    //     $root.refIds.get(context.instance),
-                    //     OPERATION.BIND,
-                    //     callback
-                    // );
-                    console.log("bindTo", targetObject, properties);
+                    //
+                    // TODO: refactor this implementation. There is room for improvement here.
+                    //
+                    if (!properties) {
+                        properties = Object.keys(metadata);
+                    }
+                    return $root.addCallback(
+                        $root.refIds.get(context.instance),
+                        OPERATION.REPLACE,
+                        () => {
+                            properties.forEach((prop) =>
+                                targetObject[prop] = context.instance[prop])
+                        }
+                    );
                 }
             }, {
                 get(target, prop: string) {
@@ -313,5 +364,8 @@ export function getStateCallbacks<T extends Schema>(decoder: Decoder<T>): Callba
         return getProxy(undefined, { instance }) as CallbackProxy<T>;
     }
 
-    return $(decoder.state);
+    return {
+        $,
+        $state: $(decoder.state),
+    };
 }

package/src/index.ts

@@ -56,7 +56,7 @@ export {
 // Annotation types
 export type { DefinitionType, PrimitiveType, Definition, } from "./annotations";
 
-export { getStateCallbacks } from "./decoder/strategy/StateCallbacks";
+export { getStateCallbacks, CallbackProxy } from "./decoder/strategy/StateCallbacks";
 export { getRawChangesCallback } from "./decoder/strategy/RawChanges";
 
 export { Encoder } from "./encoder/Encoder";