@colyseus/schema 3.0.2 → 3.0.4

package/README.md

@@ -9,13 +9,14 @@
 
 # Features
 
-- Flexible Schema Definition
-- Optimized Data Encoding
-- Automatic State Synchronization
-- Client-side Change Detection
-- Per-client portions of the state
-- Type Safety
-- *...decoders available for multiple languages (C#, Lua, Haxe)*
+- **Incremental State Synchronization**: Send only the properties that have changed.
+- **Trigger Callbacks at Decoding**: [Bring your own](https://docs.colyseus.io/state/callbacks/custom) callback system at decoding, or use the built-in one.
+- **Instance Reference Tracking**: Share references of the same instance across the state.
+- **State Views**: Filter properties that should be sent only to specific clients.
+- **Reflection**: Encode/Decode schema definitions.
+- **Schema Generation**: Generate client-side schema files for strictly typed languages.
+- **Type Safety**: Strictly typed schema definitions.
+- **Multiple Language Support**: Decoders available for multiple languages ([C#](https://github.com/colyseus/colyseus-unity-sdk/tree/master/Assets/Colyseus/Runtime/Colyseus/Serializer/Schema), [Lua](https://github.com/colyseus/colyseus-defold/tree/master/colyseus/serializer/schema), [Haxe](https://github.com/colyseus/colyseus-haxe/tree/master/src/io/colyseus/serializer/schema)).
 
 ## Schema definition
 

package/build/cjs/index.js

@@ -1547,7 +1547,7 @@ function decodeValue(decoder, operation, ref, index, type, bytes, it, allChanges
             //     previousValue,
             // });
         }
-        value = null;
+        value = undefined;
     }
     if (operation === exports.OPERATION.DELETE) ;
     else if (Schema.is(type)) {
@@ -1861,6 +1861,9 @@ class ArraySchema {
             // type format: { array: "string" }
             (type['array'] !== undefined));
     }
+    static from(iterable) {
+        return new ArraySchema(...Array.from(iterable));
+    }
     constructor(...items) {
         this.items = [];
         this.tmpItems = [];
@@ -2227,8 +2230,8 @@ class ArraySchema {
     lastIndexOf(searchElement, fromIndex = this.length - 1) {
         return this.items.lastIndexOf(searchElement, fromIndex);
     }
-    every(callbackfn, thisArg) {
-        return this.items.every(callbackfn, thisArg);
+    every(predicate, thisArg) {
+        return this.items.every(predicate, thisArg);
     }
     /**
      * Determines whether the specified callback function returns true for any element of an array.
@@ -2410,6 +2413,9 @@ class ArraySchema {
     //
     with(index, value) {
         const copy = this.items.slice();
+        // Allow negative indexing from the end
+        if (index < 0)
+            index += this.length;
         copy[index] = value;
         return new ArraySchema(...copy);
     }
@@ -4485,7 +4491,10 @@ function getDecoderStateCallbacks(decoder) {
                     }
                 }
                 // trigger onChange
-                if (change.value !== change.previousValue) {
+                if (change.value !== change.previousValue &&
+                    // FIXME: see "should not encode item if added and removed at the same patch" test case.
+                    // some "ADD" + "DELETE" operations on same patch are being encoded as "DELETE"
+                    (change.value !== undefined || change.previousValue !== undefined)) {
                     const replaceCallbacks = $callbacks[exports.OPERATION.REPLACE];
                     for (let i = replaceCallbacks?.length - 1; i >= 0; i--) {
                         replaceCallbacks[i](change.value, change.dynamicIndex ?? change.field);
@@ -4598,6 +4607,9 @@ function getDecoderStateCallbacks(decoder) {
             const onRemove = function (ref, callback) {
                 return $root.addCallback($root.refIds.get(ref), exports.OPERATION.DELETE, callback);
             };
+            const onChange = function (ref, callback) {
+                return $root.addCallback($root.refIds.get(ref), exports.OPERATION.REPLACE, callback);
+            };
             return new Proxy({
                 onAdd: function (callback, immediate = true) {
                     //
@@ -4629,6 +4641,19 @@ function getDecoderStateCallbacks(decoder) {
                         return onRemove(context.instance, callback);
                     }
                 },
+                onChange: function (callback) {
+                    if (context.onInstanceAvailable) {
+                        // collection instance not received yet
+                        let detachCallback = () => { };
+                        context.onInstanceAvailable((ref) => {
+                            detachCallback = onChange(ref, callback);
+                        });
+                        return () => detachCallback();
+                    }
+                    else if (context.instance) {
+                        return onChange(context.instance, callback);
+                    }
+                },
             }, {
                 get(target, prop) {
                     if (!target[prop]) {