@colyseus/schema 4.0.2 → 4.0.4

package/build/index.d.ts

@@ -0,0 +1,32 @@
+export { Schema } from "./Schema.js";
+export type { DataChange } from "./decoder/DecodeOperation.js";
+export type { ToJSON } from "./types/HelperTypes.js";
+import { MapSchema } from "./types/custom/MapSchema.js";
+export { MapSchema };
+import { ArraySchema } from "./types/custom/ArraySchema.js";
+export { ArraySchema };
+import { CollectionSchema } from "./types/custom/CollectionSchema.js";
+export { CollectionSchema };
+import { SetSchema } from "./types/custom/SetSchema.js";
+export { SetSchema };
+import { registerType, defineCustomTypes } from "./types/registry.js";
+export { registerType, defineCustomTypes };
+export { dumpChanges } from "./utils.js";
+export { $track, $encoder, $decoder, $filter, $getByIndex, $deleteByIndex, $changes, $childType, $refId } from "./types/symbols.js";
+export { encode } from "./encoding/encode.js";
+export { decode, type Iterator } from "./encoding/decode.js";
+export { Reflection, ReflectionType, ReflectionField, } from "./Reflection.js";
+export { Metadata } from "./Metadata.js";
+export { type, deprecated, defineTypes, view, schema, entity, type DefinitionType, type PrimitiveType, type Definition, type SchemaWithExtendsConstructor, type SchemaWithExtends, type SchemaType, } from "./annotations.js";
+export { TypeContext } from "./types/TypeContext.js";
+export type { InferValueType, InferSchemaInstanceType, AssignableProps } from "./types/HelperTypes.js";
+export { getDecoderStateCallbacks, type CallbackProxy, type SchemaCallback, type CollectionCallback, type SchemaCallbackProxy } from "./decoder/strategy/getDecoderStateCallbacks.js";
+export { Callbacks, StateCallbackStrategy } from "./decoder/strategy/Callbacks.js";
+export { getRawChangesCallback } from "./decoder/strategy/RawChanges.js";
+export { Encoder } from "./encoder/Encoder.js";
+export { encodeSchemaOperation, encodeArray, encodeKeyValueOperation } from "./encoder/EncodeOperation.js";
+export { ChangeTree, type Ref, type IRef, type ChangeSetName, type ChangeSet } from "./encoder/ChangeTree.js";
+export { StateView } from "./encoder/StateView.js";
+export { Decoder } from "./decoder/Decoder.js";
+export { decodeSchemaOperation, decodeKeyValueOperation } from "./decoder/DecodeOperation.js";
+export { OPERATION } from "./encoding/spec.js";

package/build/{umd/index.js → index.js}

@@ -5126,32 +5126,6 @@
         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();
@@ -5190,7 +5164,7 @@
                 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);
@@ -5346,11 +5320,11 @@
                         // 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);
                                 }
                             }
                         }
@@ -5360,7 +5334,7 @@
                             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;
                             }
@@ -5368,12 +5342,12 @@
                     }
                     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;
                         }
@@ -5407,13 +5381,13 @@
          * 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/{esm/index.mjs → index.mjs}

@@ -5120,32 +5120,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();
@@ -5184,7 +5158,7 @@ class StateCallbackStrategy {
             immediate = immediate && this.isTriggering === false;
             if (operation === OPERATION.ADD && immediate) {
                 collection.forEach((value, key) => {
-                    handler(key, value);
+                    handler(value, key);
                 });
             }
             return this.addCallback(collection[$refId], operation, handler);
@@ -5340,11 +5314,11 @@ class StateCallbackStrategy {
                     // FIXME: `previousValue` should always be available.
                     //
                     if (change.previousValue !== undefined) {
-                        // trigger onRemove (key, value)
+                        // trigger onRemove (value, key)
                         const deleteCallbacks = $callbacks[OPERATION.DELETE];
                         if (deleteCallbacks) {
                             for (let j = deleteCallbacks.length - 1; j >= 0; j--) {
-                                deleteCallbacks[j](dynamicIndex, change.previousValue);
+                                deleteCallbacks[j](change.previousValue, dynamicIndex);
                             }
                         }
                     }
@@ -5354,7 +5328,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;
                         }
@@ -5362,12 +5336,12 @@ class StateCallbackStrategy {
                 }
                 else if ((change.op & OPERATION.ADD) === OPERATION.ADD &&
                     change.previousValue !== change.value) {
-                    // trigger onAdd (key, value)
+                    // trigger onAdd (value, key)
                     const addCallbacks = $callbacks[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;
                     }
@@ -5401,13 +5375,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, () => { ... });