@colyseus/schema 2.0.4 → 2.0.5

package/README.md

@@ -7,10 +7,6 @@
     An incremental binary state serializer with delta encoding for games.<br>
     Although it was born to be used on <a href="https://github.com/colyseus/colyseus">Colyseus</a>, this library can be used as standalone.
   </p>
-
-  <a href="https://travis-ci.org/colyseus/schema">
-    <img src="https://img.shields.io/travis/colyseus/schema.svg?style=for-the-badge" alt="Build status" />
-  </a>
 </div>
 
 ## Defining Schema

package/build/cjs/index.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-/*! *****************************************************************************
+/******************************************************************************
 Copyright (c) Microsoft Corporation.
 
 Permission to use, copy, modify, and/or distribute this software for any
@@ -40,10 +40,14 @@ function __decorate(decorators, target, key, desc) {
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
 
-function __spreadArray(to, from) {
-    for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
-        to[j] = from[i];
-    return to;
+function __spreadArray(to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
 }
 
 // export const SWITCH_TO_STRUCTURE = 193; (easily collides with DELETE_AND_ADD + fieldIndex = 2)
@@ -210,7 +214,7 @@ var ChangeTree = /** @class */ (function () {
             ? fieldName
             : this.indexes[fieldName];
         if (index === undefined) {
-            console.warn("@colyseus/schema " + this.ref.constructor.name + ": trying to delete non-existing index: " + fieldName + " (" + index + ")");
+            console.warn("@colyseus/schema ".concat(this.ref.constructor.name, ": trying to delete non-existing index: ").concat(fieldName, " (").concat(index, ")"));
             return;
         }
         var previousValue = this.getValue(index);
@@ -282,7 +286,7 @@ var ChangeTree = /** @class */ (function () {
     };
     ChangeTree.prototype.assertValidIndex = function (index, fieldName) {
         if (index === undefined) {
-            throw new Error("ChangeTree: missing index for field \"" + fieldName + "\"");
+            throw new Error("ChangeTree: missing index for field \"".concat(fieldName, "\""));
         }
     };
     return ChangeTree;
@@ -520,7 +524,7 @@ var ArraySchema = /** @class */ (function () {
         for (var _i = 0; _i < arguments.length; _i++) {
             items[_i] = arguments[_i];
         }
-        return new (ArraySchema.bind.apply(ArraySchema, __spreadArray([void 0], (_a = Array.from(this.$items.values())).concat.apply(_a, items))))();
+        return new (ArraySchema.bind.apply(ArraySchema, __spreadArray([void 0], (_a = Array.from(this.$items.values())).concat.apply(_a, items), false)))();
     };
     /**
      * Adds all the elements of an array separated by the specified separator string.
@@ -560,7 +564,7 @@ var ArraySchema = /** @class */ (function () {
      * @param end The end of the specified portion of the array. This is exclusive of the element at the index 'end'.
      */
     ArraySchema.prototype.slice = function (start, end) {
-        return new (ArraySchema.bind.apply(ArraySchema, __spreadArray([void 0], Array.from(this.$items.values()).slice(start, end))))();
+        return new (ArraySchema.bind.apply(ArraySchema, __spreadArray([void 0], Array.from(this.$items.values()).slice(start, end), false)))();
     };
     /**
      * Sorts an array.
@@ -589,10 +593,6 @@ var ArraySchema = /** @class */ (function () {
      */
     ArraySchema.prototype.splice = function (start, deleteCount) {
         if (deleteCount === void 0) { deleteCount = this.length - start; }
-        var items = [];
-        for (var _i = 2; _i < arguments.length; _i++) {
-            items[_i - 2] = arguments[_i];
-        }
         var indexes = Array.from(this.$items.keys());
         var removedItems = [];
         for (var i = start; i < start + deleteCount; i++) {
@@ -687,7 +687,7 @@ var ArraySchema = /** @class */ (function () {
      * @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
      */
     ArraySchema.prototype.reduce = function (callbackfn, initialValue) {
-        return Array.from(this.$items.values()).reduce(callbackfn, initialValue);
+        return Array.prototype.reduce.apply(Array.from(this.$items.values()), arguments);
     };
     /**
      * Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
@@ -695,7 +695,7 @@ var ArraySchema = /** @class */ (function () {
      * @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
      */
     ArraySchema.prototype.reduceRight = function (callbackfn, initialValue) {
-        return Array.from(this.$items.values()).reduceRight(callbackfn, initialValue);
+        return Array.prototype.reduceRight.apply(Array.from(this.$items.values()), arguments);
     };
     /**
      * Returns the value of the first element in the array where predicate is true, and undefined
@@ -762,9 +762,6 @@ var ArraySchema = /** @class */ (function () {
     ArraySchema.prototype[Symbol.iterator] = function () {
         return Array.from(this.$items.values())[Symbol.iterator]();
     };
-    ArraySchema.prototype[Symbol.unscopables] = function () {
-        return this.$items[Symbol.unscopables]();
-    };
     /**
      * Returns an iterable of key, value pairs for every entry in the array
      */
@@ -844,12 +841,12 @@ var ArraySchema = /** @class */ (function () {
     ArraySchema.prototype.clone = function (isDecoding) {
         var cloned;
         if (isDecoding) {
-            cloned = new (ArraySchema.bind.apply(ArraySchema, __spreadArray([void 0], Array.from(this.$items.values()))))();
+            cloned = new (ArraySchema.bind.apply(ArraySchema, __spreadArray([void 0], Array.from(this.$items.values()), false)))();
         }
         else {
             cloned = new (ArraySchema.bind.apply(ArraySchema, __spreadArray([void 0], this.map(function (item) { return ((item['$changes'])
                 ? item.clone()
-                : item); }))))();
+                : item); }), false)))();
         }
         return cloned;
     };
@@ -896,7 +893,8 @@ var MapSchema = /** @class */ (function () {
         this.$indexes = new Map();
         this.$refId = 0;
         if (initialValues) {
-            if (initialValues instanceof Map) {
+            if (initialValues instanceof Map ||
+                initialValues instanceof MapSchema) {
                 initialValues.forEach(function (v, k) { return _this.set(k, v); });
             }
             else {
@@ -926,7 +924,7 @@ var MapSchema = /** @class */ (function () {
     });
     MapSchema.prototype.set = function (key, value) {
         if (value === undefined || value === null) {
-            throw new Error("MapSchema#set('" + key + "', " + value + "): trying to set " + value + " value on '" + key + "'.");
+            throw new Error("MapSchema#set('".concat(key, "', ").concat(value, "): trying to set ").concat(value, " value on '").concat(key, "'."));
         }
         // get "index" for this value.
         var hasIndex = typeof (this.$changes.indexes[key]) !== "undefined";
@@ -1121,7 +1119,7 @@ var SchemaDefinition = /** @class */ (function () {
             return true;
         }
         else {
-            console.warn("@filterChildren: field '" + field + "' can't have children. Ignoring filter.");
+            console.warn("@filterChildren: field '".concat(field, "' can't have children. Ignoring filter."));
         }
     };
     SchemaDefinition.prototype.getChildrenFilter = function (field) {
@@ -1191,7 +1189,7 @@ function type(type, options) {
         var constructor = target.constructor;
         constructor._context = context;
         if (!type) {
-            throw new Error(constructor.name + ": @type() reference provided for \"" + field + "\" is undefined. Make sure you don't have any circular dependencies.");
+            throw new Error("".concat(constructor.name, ": @type() reference provided for \"").concat(field, "\" is undefined. Make sure you don't have any circular dependencies."));
         }
         /*
          * static schema
@@ -1213,11 +1211,11 @@ function type(type, options) {
                 // trying to define same property multiple times across inheritance.
                 // https://github.com/colyseus/colyseus-unity3d/issues/131#issuecomment-814308572
                 try {
-                    throw new Error("@colyseus/schema: Duplicate '" + field + "' definition on '" + constructor.name + "'.\nCheck @type() annotation");
+                    throw new Error("@colyseus/schema: Duplicate '".concat(field, "' definition on '").concat(constructor.name, "'.\nCheck @type() annotation"));
                 }
                 catch (e) {
                     var definitionAtLine = e.stack.split("\n")[4].trim();
-                    throw new Error(e.message + " " + definitionAtLine);
+                    throw new Error("".concat(e.message, " ").concat(definitionAtLine));
                 }
             }
         }
@@ -1241,7 +1239,7 @@ function type(type, options) {
             };
             return;
         }
-        var fieldCached = "_" + field;
+        var fieldCached = "_".concat(field);
         definition.descriptors[fieldCached] = {
             enumerable: false,
             configurable: false,
@@ -1263,7 +1261,7 @@ function type(type, options) {
                     value !== null) {
                     // automaticallty transform Array into ArraySchema
                     if (isArray && !(value instanceof ArraySchema)) {
-                        value = new (ArraySchema.bind.apply(ArraySchema, __spreadArray([void 0], value)))();
+                        value = new (ArraySchema.bind.apply(ArraySchema, __spreadArray([void 0], value, false)))();
                     }
                     // automaticallty transform Map into MapSchema
                     if (isMap && !(value instanceof MapSchema)) {
@@ -1288,7 +1286,7 @@ function type(type, options) {
                         value['$changes'].setParent(this, this.$changes.root, this._definition.indexes[field]);
                     }
                 }
-                else {
+                else if (this[fieldCached]) {
                     //
                     // Setting a field to `null` or `undefined` will delete it.
                     //
@@ -1334,7 +1332,7 @@ function deprecated(throws) {
         definition.deprecated[field] = true;
         if (throws) {
             definition.descriptors[field] = {
-                get: function () { throw new Error(field + " is deprecated."); },
+                get: function () { throw new Error("".concat(field, " is deprecated.")); },
                 set: function (value) { },
                 enumerable: false,
                 configurable: true
@@ -2307,7 +2305,7 @@ function assertType(value, type, klass, field) {
         case "float64":
             typeofTarget = "number";
             if (isNaN(value)) {
-                console.log("trying to encode \"NaN\" in " + klass.constructor.name + "#" + field);
+                console.log("trying to encode \"NaN\" in ".concat(klass.constructor.name, "#").concat(field));
             }
             break;
         case "string":
@@ -2319,13 +2317,13 @@ function assertType(value, type, klass, field) {
             return;
     }
     if (typeof (value) !== typeofTarget && (!allowNull || (allowNull && value !== null))) {
-        var foundValue = "'" + JSON.stringify(value) + "'" + ((value && value.constructor && " (" + value.constructor.name + ")") || '');
-        throw new EncodeSchemaError("a '" + typeofTarget + "' was expected, but " + foundValue + " was provided in " + klass.constructor.name + "#" + field);
+        var foundValue = "'".concat(JSON.stringify(value), "'").concat((value && value.constructor && " (".concat(value.constructor.name, ")")) || '');
+        throw new EncodeSchemaError("a '".concat(typeofTarget, "' was expected, but ").concat(foundValue, " was provided in ").concat(klass.constructor.name, "#").concat(field));
     }
 }
 function assertInstanceType(value, type, klass, field) {
     if (!(value instanceof type)) {
-        throw new EncodeSchemaError("a '" + type.name + "' was expected, but '" + value.constructor.name + "' was provided in " + klass.constructor.name + "#" + field);
+        throw new EncodeSchemaError("a '".concat(type.name, "' was expected, but '").concat(value.constructor.name, "' was provided in ").concat(klass.constructor.name, "#").concat(field));
     }
 }
 function encodePrimitiveType(type, bytes, value, klass, field) {
@@ -2335,7 +2333,7 @@ function encodePrimitiveType(type, bytes, value, klass, field) {
         encodeFunc(bytes, value);
     }
     else {
-        throw new EncodeSchemaError("a '" + type + "' was expected, but " + value + " was provided in " + klass.constructor.name + "#" + field);
+        throw new EncodeSchemaError("a '".concat(type, "' was expected, but ").concat(value, " was provided in ").concat(klass.constructor.name, "#").concat(field));
     }
 }
 function decodePrimitiveType(type, bytes, it) {
@@ -2424,6 +2422,7 @@ var Schema = /** @class */ (function () {
         return function () { return spliceOne(_this.$callbacks[attr], _this.$callbacks[attr].indexOf(callback)); };
     };
     Schema.prototype.decode = function (bytes, it, ref) {
+        var _a;
         if (it === void 0) { it = { offset: 0 }; }
         if (ref === void 0) { ref = this; }
         var allChanges = [];
@@ -2440,7 +2439,7 @@ var Schema = /** @class */ (function () {
                 // Trying to access a reference that haven't been decoded yet.
                 //
                 if (!nextRef) {
-                    throw new Error("\"refId\" not found: " + refId);
+                    throw new Error("\"refId\" not found: ".concat(refId));
                 }
                 ref = nextRef;
                 continue;
@@ -2483,7 +2482,7 @@ var Schema = /** @class */ (function () {
                 }
             }
             else {
-                previousValue = ref["_" + fieldName];
+                previousValue = ref["_".concat(fieldName)];
             }
             //
             // Delete operations
@@ -2563,7 +2562,7 @@ var Schema = /** @class */ (function () {
                         var entries = previousValue.entries();
                         var iter = void 0;
                         while ((iter = entries.next()) && !iter.done) {
-                            var _a = iter.value, key = _a[0], value_1 = _a[1];
+                            var key = (_a = iter.value, _a[0]), value_1 = _a[1];
                             allChanges.push({
                                 refId: refId_2,
                                 op: exports.OPERATION.DELETE,
@@ -2590,6 +2589,7 @@ var Schema = /** @class */ (function () {
                     var key = dynamicIndex;
                     // ref.set(key, value);
                     ref['$items'].set(key, value);
+                    ref['$changes'].allChanges.add(fieldIndex);
                 }
                 else if (ref instanceof ArraySchema) {
                     // const key = ref['$indexes'][field];
@@ -2742,7 +2742,7 @@ var Schema = /** @class */ (function () {
                     //
                     // ensure a ArraySchema has been provided
                     //
-                    assertInstanceType(ref["_" + field], definition.constructor, ref, field);
+                    assertInstanceType(ref["_".concat(field)], definition.constructor, ref, field);
                     //
                     // Encode refId for this instance.
                     // The actual instance is going to be encoded on next `changeTree` iteration.
@@ -2944,11 +2944,12 @@ var Schema = /** @class */ (function () {
         return filteredBytes;
     };
     Schema.prototype.clone = function () {
+        var _a;
         var cloned = new (this.constructor);
         var schema = this._definition.schema;
         for (var field in schema) {
             if (typeof (this[field]) === "object" &&
-                typeof (this[field].clone) === "function") {
+                typeof ((_a = this[field]) === null || _a === void 0 ? void 0 : _a.clone) === "function") {
                 // deep clone
                 cloned[field] = this[field].clone();
             }
@@ -2967,7 +2968,7 @@ var Schema = /** @class */ (function () {
             if (!deprecated[field] && this[field] !== null && typeof (this[field]) !== "undefined") {
                 obj[field] = (typeof (this[field]['toJSON']) === "function")
                     ? this[field]['toJSON']()
-                    : this["_" + field];
+                    : this["_".concat(field)];
             }
         }
         return obj;
@@ -3002,7 +3003,7 @@ var Schema = /** @class */ (function () {
         return instance;
     };
     Schema.prototype._triggerChanges = function (changes) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         var uniqueRefIds = new Set();
         var $refs = this.$changes.root.refs;
         var _loop_2 = function (i) {
@@ -3025,7 +3026,7 @@ var Schema = /** @class */ (function () {
                 if (!uniqueRefIds.has(refId)) {
                     try {
                         // trigger onChange
-                        (_d = (_c = $callbacks) === null || _c === void 0 ? void 0 : _c[exports.OPERATION.REPLACE]) === null || _d === void 0 ? void 0 : _d.forEach(function (callback) {
+                        (_c = $callbacks === null || $callbacks === void 0 ? void 0 : $callbacks[exports.OPERATION.REPLACE]) === null || _c === void 0 ? void 0 : _c.forEach(function (callback) {
                             return callback(changes);
                         });
                     }
@@ -3035,7 +3036,7 @@ var Schema = /** @class */ (function () {
                 }
                 try {
                     if ($callbacks.hasOwnProperty(change.field)) {
-                        (_e = $callbacks[change.field]) === null || _e === void 0 ? void 0 : _e.forEach(function (callback) {
+                        (_d = $callbacks[change.field]) === null || _d === void 0 ? void 0 : _d.forEach(function (callback) {
                             return callback(change.value, change.previousValue);
                         });
                     }
@@ -3048,7 +3049,7 @@ var Schema = /** @class */ (function () {
                 // is a collection of items
                 if (change.op === exports.OPERATION.ADD && change.previousValue === undefined) {
                     // triger onAdd
-                    (_f = $callbacks[exports.OPERATION.ADD]) === null || _f === void 0 ? void 0 : _f.forEach(function (callback) { var _a; return callback(change.value, (_a = change.dynamicIndex) !== null && _a !== void 0 ? _a : change.field); });
+                    (_e = $callbacks[exports.OPERATION.ADD]) === null || _e === void 0 ? void 0 : _e.forEach(function (callback) { var _a; return callback(change.value, (_a = change.dynamicIndex) !== null && _a !== void 0 ? _a : change.field); });
                 }
                 else if (change.op === exports.OPERATION.DELETE) {
                     //
@@ -3057,20 +3058,20 @@ var Schema = /** @class */ (function () {
                     //
                     if (change.previousValue !== undefined) {
                         // triger onRemove
-                        (_g = $callbacks[exports.OPERATION.DELETE]) === null || _g === void 0 ? void 0 : _g.forEach(function (callback) { var _a; return callback(change.previousValue, (_a = change.dynamicIndex) !== null && _a !== void 0 ? _a : change.field); });
+                        (_f = $callbacks[exports.OPERATION.DELETE]) === null || _f === void 0 ? void 0 : _f.forEach(function (callback) { var _a; return callback(change.previousValue, (_a = change.dynamicIndex) !== null && _a !== void 0 ? _a : change.field); });
                     }
                 }
                 else if (change.op === exports.OPERATION.DELETE_AND_ADD) {
                     // triger onRemove
                     if (change.previousValue !== undefined) {
-                        (_h = $callbacks[exports.OPERATION.DELETE]) === null || _h === void 0 ? void 0 : _h.forEach(function (callback) { var _a; return callback(change.previousValue, (_a = change.dynamicIndex) !== null && _a !== void 0 ? _a : change.field); });
+                        (_g = $callbacks[exports.OPERATION.DELETE]) === null || _g === void 0 ? void 0 : _g.forEach(function (callback) { var _a; return callback(change.previousValue, (_a = change.dynamicIndex) !== null && _a !== void 0 ? _a : change.field); });
                     }
                     // triger onAdd
-                    (_j = $callbacks[exports.OPERATION.ADD]) === null || _j === void 0 ? void 0 : _j.forEach(function (callback) { var _a; return callback(change.value, (_a = change.dynamicIndex) !== null && _a !== void 0 ? _a : change.field); });
+                    (_h = $callbacks[exports.OPERATION.ADD]) === null || _h === void 0 ? void 0 : _h.forEach(function (callback) { var _a; return callback(change.value, (_a = change.dynamicIndex) !== null && _a !== void 0 ? _a : change.field); });
                 }
                 // trigger onChange
                 if (change.value !== change.previousValue) {
-                    (_k = $callbacks[exports.OPERATION.REPLACE]) === null || _k === void 0 ? void 0 : _k.forEach(function (callback) { var _a; return callback(change.value, (_a = change.dynamicIndex) !== null && _a !== void 0 ? _a : change.field); });
+                    (_j = $callbacks[exports.OPERATION.REPLACE]) === null || _j === void 0 ? void 0 : _j.forEach(function (callback) { var _a; return callback(change.value, (_a = change.dynamicIndex) !== null && _a !== void 0 ? _a : change.field); });
                 }
             }
             uniqueRefIds.add(refId);