@colyseus/schema 1.1.0-alpha.1 → 2.0.2

package/lib/Schema.js

@@ -41,9 +41,10 @@ var MapSchema_1 = require("./types/MapSchema");
 var CollectionSchema_1 = require("./types/CollectionSchema");
 var SetSchema_1 = require("./types/SetSchema");
 var ChangeTree_1 = require("./changes/ChangeTree");
-var EventEmitter_1 = require("./events/EventEmitter");
 var filters_1 = require("./filters");
-var types_1 = require("./types");
+var typeRegistry_1 = require("./types/typeRegistry");
+var ReferenceTracker_1 = require("./changes/ReferenceTracker");
+var utils_1 = require("./types/utils");
 var EncodeSchemaError = /** @class */ (function (_super) {
     __extends(EncodeSchemaError, _super);
     function EncodeSchemaError() {
@@ -115,12 +116,17 @@ var Schema = /** @class */ (function () {
         // fix enumerability of fields for end-user
         Object.defineProperties(this, {
             $changes: {
-                value: new ChangeTree_1.ChangeTree(this, undefined, new ChangeTree_1.Root()),
+                value: new ChangeTree_1.ChangeTree(this, undefined, new ReferenceTracker_1.ReferenceTracker()),
                 enumerable: false,
                 writable: true
             },
-            $listeners: {
-                value: {},
+            // $listeners: {
+            //     value: undefined,
+            //     enumerable: false,
+            //     writable: true
+            // },
+            $callbacks: {
+                value: undefined,
                 enumerable: false,
                 writable: true
             },
@@ -143,6 +149,12 @@ var Schema = /** @class */ (function () {
         return (type['_definition'] &&
             type['_definition'].schema !== undefined);
     };
+    Schema.prototype.onChange = function (callback) {
+        return utils_1.addCallback((this.$callbacks || (this.$callbacks = [])), spec_1.OPERATION.REPLACE, callback);
+    };
+    Schema.prototype.onRemove = function (callback) {
+        return utils_1.addCallback((this.$callbacks || (this.$callbacks = [])), spec_1.OPERATION.DELETE, callback);
+    };
     Schema.prototype.assign = function (props) {
         Object.assign(this, props);
         return this;
@@ -152,27 +164,35 @@ var Schema = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    /**
+     * (Server-side): Flag a property to be encoded for the next patch.
+     * @param instance Schema instance
+     * @param property string representing the property name, or number representing the index of the property.
+     * @param operation OPERATION to perform (detected automatically)
+     */
+    Schema.prototype.setDirty = function (property, operation) {
+        this.$changes.change(property, operation);
+    };
     Schema.prototype.listen = function (attr, callback) {
         var _this = this;
-        if (!this.$listeners[attr]) {
-            this.$listeners[attr] = new EventEmitter_1.EventEmitter();
+        if (!this.$callbacks) {
+            this.$callbacks = {};
+        }
+        if (!this.$callbacks[attr]) {
+            this.$callbacks[attr] = [];
         }
-        this.$listeners[attr].register(callback);
+        this.$callbacks[attr].push(callback);
         // return un-register callback.
-        return function () {
-            return _this.$listeners[attr].remove(callback);
-        };
+        return function () { return utils_1.spliceOne(_this.$callbacks[attr], _this.$callbacks[attr].indexOf(callback)); };
     };
-    Schema.prototype.decode = function (bytes, it, ref, allChanges) {
+    Schema.prototype.decode = function (bytes, it, ref) {
         if (it === void 0) { it = { offset: 0 }; }
         if (ref === void 0) { ref = this; }
-        if (allChanges === void 0) { allChanges = new Map(); }
+        var allChanges = [];
         var $root = this.$changes.root;
         var totalBytes = bytes.length;
         var refId = 0;
-        var changes = [];
         $root.refs.set(refId, this);
-        allChanges.set(refId, changes);
         while (it.offset < totalBytes) {
             var byte = bytes[it.offset++];
             if (byte == spec_1.SWITCH_TO_STRUCTURE) {
@@ -185,9 +205,6 @@ var Schema = /** @class */ (function () {
                     throw new Error("\"refId\" not found: " + refId);
                 }
                 ref = nextRef;
-                // create empty list of changes for this refId.
-                changes = [];
-                allChanges.set(refId, changes);
                 continue;
             }
             var changeTree = ref['$changes'];
@@ -201,7 +218,7 @@ var Schema = /** @class */ (function () {
                 // The `.clear()` method is calling `$root.removeRef(refId)` for
                 // each item inside this collection
                 //
-                ref.clear(true);
+                ref.clear(allChanges);
                 continue;
             }
             var fieldIndex = (isSchema)
@@ -276,9 +293,8 @@ var Schema = /** @class */ (function () {
                         value = this.createTypeInstance(childType);
                         value.$changes.refId = refId_1;
                         if (previousValue) {
-                            value.onChange = previousValue.onChange;
-                            value.onRemove = previousValue.onRemove;
-                            value.$listeners = previousValue.$listeners;
+                            value.$callbacks = previousValue.$callbacks;
+                            // value.$listeners = previousValue.$listeners;
                             if (previousValue['$changes'].refId &&
                                 refId_1 !== previousValue['$changes'].refId) {
                                 $root.removeRef(previousValue['$changes'].refId);
@@ -295,7 +311,7 @@ var Schema = /** @class */ (function () {
                 value = decodePrimitiveType(type, bytes, it);
             }
             else {
-                var typeDef = types_1.getType(Object.keys(type)[0]);
+                var typeDef = typeRegistry_1.getType(Object.keys(type)[0]);
                 var refId_2 = decode.number(bytes, it);
                 var valueRef = ($root.refs.has(refId_2))
                     ? previousValue || $root.refs.get(refId_2)
@@ -304,40 +320,29 @@ var Schema = /** @class */ (function () {
                 value.$changes.refId = refId_2;
                 // preserve schema callbacks
                 if (previousValue) {
-                    value.onAdd = previousValue.onAdd;
-                    value.onRemove = previousValue.onRemove;
-                    value.onChange = previousValue.onChange;
+                    value['$callbacks'] = previousValue['$callbacks'];
                     if (previousValue['$changes'].refId &&
                         refId_2 !== previousValue['$changes'].refId) {
                         $root.removeRef(previousValue['$changes'].refId);
                         //
                         // Trigger onRemove if structure has been replaced.
                         //
-                        var deletes = [];
                         var entries = previousValue.entries();
                         var iter = void 0;
                         while ((iter = entries.next()) && !iter.done) {
                             var _a = __read(iter.value, 2), key = _a[0], value_1 = _a[1];
-                            deletes.push({
+                            allChanges.push({
+                                refId: refId_2,
                                 op: spec_1.OPERATION.DELETE,
                                 field: key,
                                 value: undefined,
                                 previousValue: value_1,
                             });
                         }
-                        allChanges.set(previousValue['$changes'].refId, deletes);
                     }
                 }
                 $root.addRef(refId_2, value, (valueRef !== previousValue));
-                //
-                // TODO: deprecate proxies on next version.
-                // get proxy to target value.
-                //
-                if (typeDef.getProxy) {
-                    value = typeDef.getProxy(value);
-                }
             }
-            var hasChange = (previousValue !== value);
             if (value !== null &&
                 value !== undefined) {
                 if (value['$changes']) {
@@ -345,14 +350,7 @@ var Schema = /** @class */ (function () {
                 }
                 if (ref instanceof Schema) {
                     ref[fieldName] = value;
-                    //
-                    // FIXME: use `_field` instead of `field`.
-                    //
-                    // `field` is going to use the setter of the PropertyDescriptor
-                    // and create a proxy for array/map. This is only useful for
-                    // backwards-compatibility with @colyseus/schema@0.5.x
-                    //
-                    // // ref[_field] = value;
+                    // ref[`_${fieldName}`] = value;
                 }
                 else if (ref instanceof MapSchema_1.MapSchema) {
                     // const key = ref['$indexes'].get(field);
@@ -366,19 +364,20 @@ var Schema = /** @class */ (function () {
                     // ref[key] = value;
                     ref.setAt(fieldIndex, value);
                 }
-                else if (ref instanceof CollectionSchema_1.CollectionSchema ||
-                    ref instanceof SetSchema_1.SetSchema) {
+                else if (ref instanceof CollectionSchema_1.CollectionSchema) {
                     var index = ref.add(value);
                     ref['setIndex'](fieldIndex, index);
                 }
+                else if (ref instanceof SetSchema_1.SetSchema) {
+                    var index = ref.add(value);
+                    if (index !== false) {
+                        ref['setIndex'](fieldIndex, index);
+                    }
+                }
             }
-            if (hasChange
-            // &&
-            // (
-            //     this.onChange || ref.$listeners[field]
-            // )
-            ) {
-                changes.push({
+            if (previousValue !== value) {
+                allChanges.push({
+                    refId: refId,
                     op: operation,
                     field: fieldName,
                     dynamicIndex: dynamicIndex,
@@ -506,7 +505,7 @@ var Schema = /** @class */ (function () {
                     //
                     // Custom type (MapSchema, ArraySchema, etc)
                     //
-                    var definition = types_1.getType(Object.keys(type)[0]);
+                    var definition = typeRegistry_1.getType(Object.keys(type)[0]);
                     //
                     // ensure a ArraySchema has been provided
                     //
@@ -532,6 +531,7 @@ var Schema = /** @class */ (function () {
         return this.encode(true, [], useFilters);
     };
     Schema.prototype.applyFilters = function (client, encodeAll) {
+        var _a, _b;
         if (encodeAll === void 0) { encodeAll = false; }
         var root = this;
         var refIdsDissallowed = new Set();
@@ -651,7 +651,7 @@ var Schema = /** @class */ (function () {
                         //
                         // use cached bytes directly if is from Schema type.
                         //
-                        filteredBytes = filteredBytes.concat(changeTree.caches[fieldIndex]);
+                        filteredBytes.push.apply(filteredBytes, (_a = changeTree.caches[fieldIndex]) !== null && _a !== void 0 ? _a : []);
                         containerIndexes.add(fieldIndex);
                     }
                     else {
@@ -659,7 +659,7 @@ var Schema = /** @class */ (function () {
                             //
                             // use cached bytes if already has the field
                             //
-                            filteredBytes = filteredBytes.concat(changeTree.caches[fieldIndex]);
+                            filteredBytes.push.apply(filteredBytes, (_b = changeTree.caches[fieldIndex]) !== null && _b !== void 0 ? _b : []);
                         }
                         else {
                             //
@@ -728,20 +728,6 @@ var Schema = /** @class */ (function () {
         }
         return cloned;
     };
-    Schema.prototype.triggerAll = function () {
-        // skip if haven't received any remote refs yet.
-        if (this.$changes.root.refs.size === 0) {
-            return;
-        }
-        var allChanges = new Map();
-        Schema.prototype._triggerAllFillChanges.call(this, this, allChanges);
-        try {
-            Schema.prototype._triggerChanges.call(this, allChanges);
-        }
-        catch (e) {
-            Schema.onError(e);
-        }
-    };
     Schema.prototype.toJSON = function () {
         var schema = this._definition.schema;
         var deprecated = this._definition.deprecated;
@@ -784,111 +770,81 @@ var Schema = /** @class */ (function () {
         instance.$changes.root = this.$changes.root;
         return instance;
     };
-    Schema.prototype._triggerAllFillChanges = function (ref, allChanges) {
-        if (allChanges.has(ref['$changes'].refId)) {
-            return;
-        }
-        var changes = [];
-        allChanges.set(ref['$changes'].refId || 0, changes);
-        if (ref instanceof Schema) {
-            var schema = ref._definition.schema;
-            for (var fieldName in schema) {
-                var _field = "_" + fieldName;
-                var value = ref[_field];
-                if (value !== undefined) {
-                    changes.push({
-                        op: spec_1.OPERATION.ADD,
-                        field: fieldName,
-                        value: value,
-                        previousValue: undefined
-                    });
-                    if (value['$changes'] !== undefined) {
-                        Schema.prototype._triggerAllFillChanges.call(this, value, allChanges);
+    Schema.prototype._triggerChanges = function (changes) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+        var uniqueRefIds = new Set();
+        var $refs = this.$changes.root.refs;
+        var _loop_2 = function (i) {
+            var change = changes[i];
+            var refId = change.refId;
+            var ref = $refs.get(refId);
+            var $callbacks = ref['$callbacks'];
+            //
+            // trigger onRemove on child structure.
+            //
+            if ((change.op & spec_1.OPERATION.DELETE) === spec_1.OPERATION.DELETE &&
+                change.previousValue instanceof Schema) {
+                (_b = (_a = change.previousValue['$callbacks']) === null || _a === void 0 ? void 0 : _a[spec_1.OPERATION.DELETE]) === null || _b === void 0 ? void 0 : _b.forEach(function (callback) { return callback(); });
+            }
+            // no callbacks defined, skip this structure!
+            if (!$callbacks) {
+                return "continue";
+            }
+            if (ref instanceof Schema) {
+                if (!uniqueRefIds.has(refId)) {
+                    try {
+                        // trigger onChange
+                        (_d = (_c = $callbacks) === null || _c === void 0 ? void 0 : _c[spec_1.OPERATION.REPLACE]) === null || _d === void 0 ? void 0 : _d.forEach(function (callback) {
+                            return callback(changes);
+                        });
+                    }
+                    catch (e) {
+                        Schema.onError(e);
                     }
                 }
-            }
-        }
-        else {
-            var entries = ref.entries();
-            var iter = void 0;
-            while ((iter = entries.next()) && !iter.done) {
-                var _a = __read(iter.value, 2), key = _a[0], value = _a[1];
-                changes.push({
-                    op: spec_1.OPERATION.ADD,
-                    field: key,
-                    dynamicIndex: key,
-                    value: value,
-                    previousValue: undefined,
-                });
-                if (value['$changes'] !== undefined) {
-                    Schema.prototype._triggerAllFillChanges.call(this, value, allChanges);
+                try {
+                    (_e = $callbacks[change.op]) === null || _e === void 0 ? void 0 : _e.forEach(function (callback) {
+                        return callback(change.value, change.previousValue);
+                    });
+                }
+                catch (e) {
+                    Schema.onError(e);
                 }
             }
-        }
-    };
-    Schema.prototype._triggerChanges = function (allChanges) {
-        var _this = this;
-        allChanges.forEach(function (changes, refId) {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
-            if (changes.length > 0) {
-                var ref = _this.$changes.root.refs.get(refId);
-                var isSchema = ref instanceof Schema;
-                for (var i = 0; i < changes.length; i++) {
-                    var change = changes[i];
-                    var listener = ref['$listeners'] && ref['$listeners'][change.field];
-                    if (!isSchema) {
-                        if (change.op === spec_1.OPERATION.ADD && change.previousValue === undefined) {
-                            (_b = (_a = ref).onAdd) === null || _b === void 0 ? void 0 : _b.call(_a, change.value, (_c = change.dynamicIndex) !== null && _c !== void 0 ? _c : change.field);
-                        }
-                        else if (change.op === spec_1.OPERATION.DELETE) {
-                            //
-                            // FIXME: `previousValue` should always be avaiiable.
-                            // ADD + DELETE operations are still encoding DELETE operation.
-                            //
-                            if (change.previousValue !== undefined) {
-                                (_e = (_d = ref).onRemove) === null || _e === void 0 ? void 0 : _e.call(_d, change.previousValue, (_f = change.dynamicIndex) !== null && _f !== void 0 ? _f : change.field);
-                            }
-                        }
-                        else if (change.op === spec_1.OPERATION.DELETE_AND_ADD) {
-                            if (change.previousValue !== undefined) {
-                                (_h = (_g = ref).onRemove) === null || _h === void 0 ? void 0 : _h.call(_g, change.previousValue, change.dynamicIndex);
-                            }
-                            (_k = (_j = ref).onAdd) === null || _k === void 0 ? void 0 : _k.call(_j, change.value, change.dynamicIndex);
-                        }
-                        else if (change.op === spec_1.OPERATION.REPLACE ||
-                            change.value !== change.previousValue) {
-                            (_m = (_l = ref).onChange) === null || _m === void 0 ? void 0 : _m.call(_l, change.value, change.dynamicIndex);
-                        }
-                    }
+            else {
+                // is a collection of items
+                if (change.op === spec_1.OPERATION.ADD && change.previousValue === undefined) {
+                    // triger onAdd
+                    (_f = $callbacks[spec_1.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); });
+                }
+                else if (change.op === spec_1.OPERATION.DELETE) {
                     //
-                    // trigger onRemove on child structure.
+                    // FIXME: `previousValue` should always be available.
+                    // ADD + DELETE operations are still encoding DELETE operation.
                     //
-                    if ((change.op & spec_1.OPERATION.DELETE) === spec_1.OPERATION.DELETE &&
-                        change.previousValue instanceof Schema &&
-                        change.previousValue.onRemove) {
-                        change.previousValue.onRemove();
-                    }
-                    if (listener) {
-                        try {
-                            listener.invoke(change.value, change.previousValue);
-                        }
-                        catch (e) {
-                            Schema.onError(e);
-                        }
+                    if (change.previousValue !== undefined) {
+                        // triger onRemove
+                        (_g = $callbacks[spec_1.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); });
                     }
                 }
-                if (isSchema) {
-                    if (ref.onChange) {
-                        try {
-                            ref.onChange(changes);
-                        }
-                        catch (e) {
-                            Schema.onError(e);
-                        }
+                else if (change.op === spec_1.OPERATION.DELETE_AND_ADD) {
+                    // triger onRemove
+                    if (change.previousValue !== undefined) {
+                        (_h = $callbacks[spec_1.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); });
                     }
+                    // triger onAdd
+                    (_j = $callbacks[spec_1.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); });
+                }
+                // trigger onChange
+                if (change.value !== change.previousValue) {
+                    (_k = $callbacks[spec_1.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); });
                 }
             }
-        });
+            uniqueRefIds.add(refId);
+        };
+        for (var i = 0; i < changes.length; i++) {
+            _loop_2(i);
+        }
     };
     Schema._definition = annotations_1.SchemaDefinition.create();
     return Schema;