@colyseus/schema 4.0.3 → 4.0.5

package/build/Schema.d.ts

@@ -20,6 +20,13 @@ export declare class Schema<C = any> implements IRef {
      */
     static initialize(instance: any): void;
     static is(type: DefinitionType): boolean;
+    /**
+     * Check if a value is an instance of Schema.
+     * This method uses duck-typing to avoid issues with multiple @colyseus/schema versions.
+     * @param obj Value to check
+     * @returns true if the value is a Schema instance
+     */
+    static isSchema(obj: any): obj is Schema;
     /**
      * Track property changes
      */

package/build/decoder/strategy/Callbacks.d.ts

@@ -10,6 +10,7 @@ import { ArraySchema } from "../../types/custom/ArraySchema.js";
 import { type SchemaCallbackProxy } from "./getDecoderStateCallbacks.js";
 type PropertyChangeCallback<K> = (currentValue: K, previousValue: K) => void;
 type KeyValueCallback<K, V> = (key: K, value: V) => void;
+type ValueKeyCallback<V, K> = (value: V, key: K) => void;
 type InstanceChangeCallback = () => void;
 type PublicPropNames<T> = Exclude<NonFunctionPropNames<T>, typeof $refId> & string;
 type CollectionPropNames<T> = Exclude<{
@@ -17,32 +18,6 @@ type CollectionPropNames<T> = Exclude<{
 }[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>;
@@ -78,19 +53,19 @@ export declare class StateCallbackStrategy<TState extends Schema> {
     /**
      * 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;
+    onAdd<K extends CollectionPropNames<TState>>(property: K, handler: ValueKeyCallback<CollectionValueType<TState, K>, CollectionKeyType<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;
+    onAdd<TInstance extends Schema, K extends CollectionPropNames<TInstance>>(instance: TInstance, property: K, handler: ValueKeyCallback<CollectionValueType<TInstance, K>, CollectionKeyType<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;
+    onRemove<K extends CollectionPropNames<TState>>(property: K, handler: ValueKeyCallback<CollectionValueType<TState, K>, CollectionKeyType<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;
+    onRemove<TInstance extends Schema, K extends CollectionPropNames<TInstance>>(instance: TInstance, property: K, handler: ValueKeyCallback<CollectionValueType<TInstance, K>, CollectionKeyType<TInstance, K>>): () => void;
     /**
      * Bind properties from a Schema instance to a target object.
      * Changes will be automatically reflected on the target object.
@@ -113,13 +88,13 @@ export declare const Callbacks: {
      * callbacks.listen("currentTurn", (currentValue, previousValue) => { ... });
      *
      * // Listen to collection additions
-     * callbacks.onAdd("entities", (sessionId, entity) => {
+     * callbacks.onAdd("entities", (entity, sessionId) => {
      *     // Nested property listening
      *     callbacks.listen(entity, "hp", (currentHp, previousHp) => { ... });
      * });
      *
      * // Listen to collection removals
-     * callbacks.onRemove("entities", (sessionId, entity) => { ... });
+     * callbacks.onRemove("entities", (entity, sessionId) => { ... });
      *
      * // Listen to any property change on an instance
      * callbacks.onChange(entity, () => { ... });

package/build/index.cjs

@@ -3668,6 +3668,15 @@ class Schema {
     static is(type) {
         return typeof (type[Symbol.metadata]) === "object";
     }
+    /**
+     * Check if a value is an instance of Schema.
+     * This method uses duck-typing to avoid issues with multiple @colyseus/schema versions.
+     * @param obj Value to check
+     * @returns true if the value is a Schema instance
+     */
+    static isSchema(obj) {
+        return typeof obj?.assign === "function";
+    }
     /**
      * Track property changes
      */
@@ -4872,13 +4881,13 @@ function getDecoderStateCallbacks(decoder) {
             // trigger onRemove on child structure.
             //
             if ((change.op & exports.OPERATION.DELETE) === exports.OPERATION.DELETE &&
-                change.previousValue instanceof Schema) {
+                Schema.isSchema(change.previousValue)) {
                 const deleteCallbacks = callbacks[change.previousValue[$refId]]?.[exports.OPERATION.DELETE];
                 for (let i = deleteCallbacks?.length - 1; i >= 0; i--) {
                     deleteCallbacks[i]();
                 }
             }
-            if (ref instanceof Schema) {
+            if (Schema.isSchema(ref)) {
                 //
                 // Handle schema instance
                 //
@@ -5122,32 +5131,6 @@ function getRawChangesCallback(decoder, callback) {
     decoder.triggerChanges = callback;
 }
 
-/**
- * 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);
- * ```
- */
 class StateCallbackStrategy {
     decoder;
     uniqueRefIds = new Set();
@@ -5186,7 +5169,7 @@ class StateCallbackStrategy {
             immediate = immediate && this.isTriggering === false;
             if (operation === exports.OPERATION.ADD && immediate) {
                 collection.forEach((value, key) => {
-                    handler(key, value);
+                    handler(value, key);
                 });
             }
             return this.addCallback(collection[$refId], operation, handler);
@@ -5288,7 +5271,7 @@ class StateCallbackStrategy {
             // trigger onRemove on child structure.
             //
             if ((change.op & exports.OPERATION.DELETE) === exports.OPERATION.DELETE &&
-                change.previousValue instanceof Schema) {
+                Schema.isSchema(change.previousValue)) {
                 const childRefId = change.previousValue[$refId];
                 const deleteCallbacks = this.callbacks[childRefId]?.[exports.OPERATION.DELETE];
                 if (deleteCallbacks) {
@@ -5297,7 +5280,7 @@ class StateCallbackStrategy {
                     }
                 }
             }
-            if (ref instanceof Schema) {
+            if (Schema.isSchema(ref)) {
                 //
                 // Handle Schema instance
                 //
@@ -5342,11 +5325,11 @@ class StateCallbackStrategy {
                     // FIXME: `previousValue` should always be available.
                     //
                     if (change.previousValue !== undefined) {
-                        // trigger onRemove (key, value)
+                        // trigger onRemove (value, key)
                         const deleteCallbacks = $callbacks[exports.OPERATION.DELETE];
                         if (deleteCallbacks) {
                             for (let j = deleteCallbacks.length - 1; j >= 0; j--) {
-                                deleteCallbacks[j](dynamicIndex, change.previousValue);
+                                deleteCallbacks[j](change.previousValue, dynamicIndex);
                             }
                         }
                     }
@@ -5356,7 +5339,7 @@ class StateCallbackStrategy {
                         if (addCallbacks) {
                             this.isTriggering = true;
                             for (let j = addCallbacks.length - 1; j >= 0; j--) {
-                                addCallbacks[j](dynamicIndex, change.value);
+                                addCallbacks[j](change.value, dynamicIndex);
                             }
                             this.isTriggering = false;
                         }
@@ -5364,12 +5347,12 @@ class StateCallbackStrategy {
                 }
                 else if ((change.op & exports.OPERATION.ADD) === exports.OPERATION.ADD &&
                     change.previousValue !== change.value) {
-                    // trigger onAdd (key, value)
+                    // trigger onAdd (value, key)
                     const addCallbacks = $callbacks[exports.OPERATION.ADD];
                     if (addCallbacks) {
                         this.isTriggering = true;
                         for (let j = addCallbacks.length - 1; j >= 0; j--) {
-                            addCallbacks[j](dynamicIndex, change.value);
+                            addCallbacks[j](change.value, dynamicIndex);
                         }
                         this.isTriggering = false;
                     }
@@ -5403,13 +5386,13 @@ const Callbacks = {
      * callbacks.listen("currentTurn", (currentValue, previousValue) => { ... });
      *
      * // Listen to collection additions
-     * callbacks.onAdd("entities", (sessionId, entity) => {
+     * callbacks.onAdd("entities", (entity, sessionId) => {
      *     // Nested property listening
      *     callbacks.listen(entity, "hp", (currentHp, previousHp) => { ... });
      * });
      *
      * // Listen to collection removals
-     * callbacks.onRemove("entities", (sessionId, entity) => { ... });
+     * callbacks.onRemove("entities", (entity, sessionId) => { ... });
      *
      * // Listen to any property change on an instance
      * callbacks.onChange(entity, () => { ... });