@colyseus/schema 2.0.32 → 3.0.0-alpha.0

package/lib/Reflection.js

@@ -5,16 +5,14 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Reflection = exports.ReflectionType = exports.ReflectionField = void 0;
 const annotations_1 = require("./annotations");
+const Metadata_1 = require("./Metadata");
+const ArraySchema_1 = require("./types/custom/ArraySchema");
+const Encoder_1 = require("./encoder/Encoder");
+const Decoder_1 = require("./decoder/Decoder");
 const Schema_1 = require("./Schema");
-const ArraySchema_1 = require("./types/ArraySchema");
-const typeRegistry_1 = require("./types/typeRegistry");
-const reflectionContext = { context: new annotations_1.Context() };
 /**
  * Reflection
  */
@@ -22,16 +20,13 @@ class ReflectionField extends Schema_1.Schema {
 }
 exports.ReflectionField = ReflectionField;
 __decorate([
-    (0, annotations_1.type)("string", reflectionContext),
-    __metadata("design:type", String)
+    (0, annotations_1.type)("string")
 ], ReflectionField.prototype, "name", void 0);
 __decorate([
-    (0, annotations_1.type)("string", reflectionContext),
-    __metadata("design:type", String)
+    (0, annotations_1.type)("string")
 ], ReflectionField.prototype, "type", void 0);
 __decorate([
-    (0, annotations_1.type)("number", reflectionContext),
-    __metadata("design:type", Number)
+    (0, annotations_1.type)("number")
 ], ReflectionField.prototype, "referencedType", void 0);
 class ReflectionType extends Schema_1.Schema {
     constructor() {
@@ -41,39 +36,46 @@ class ReflectionType extends Schema_1.Schema {
 }
 exports.ReflectionType = ReflectionType;
 __decorate([
-    (0, annotations_1.type)("number", reflectionContext),
-    __metadata("design:type", Number)
+    (0, annotations_1.type)("number")
 ], ReflectionType.prototype, "id", void 0);
 __decorate([
-    (0, annotations_1.type)([ReflectionField], reflectionContext),
-    __metadata("design:type", ArraySchema_1.ArraySchema)
+    (0, annotations_1.type)("number")
+], ReflectionType.prototype, "extendsId", void 0);
+__decorate([
+    (0, annotations_1.type)([ReflectionField])
 ], ReflectionType.prototype, "fields", void 0);
 class Reflection extends Schema_1.Schema {
     constructor() {
         super(...arguments);
         this.types = new ArraySchema_1.ArraySchema();
     }
-    static encode(instance) {
-        const rootSchemaType = instance.constructor;
+    static encode(instance, context) {
+        if (!context) {
+            context = new annotations_1.TypeContext(instance.constructor);
+        }
         const reflection = new Reflection();
-        reflection.rootType = rootSchemaType._typeid;
-        const buildType = (currentType, schema) => {
-            for (let fieldName in schema) {
+        const encoder = new Encoder_1.Encoder(reflection);
+        const buildType = (currentType, metadata) => {
+            for (const fieldName in metadata) {
+                // skip fields from parent classes
+                if (!Object.prototype.hasOwnProperty.call(metadata, fieldName)) {
+                    continue;
+                }
                 const field = new ReflectionField();
                 field.name = fieldName;
                 let fieldType;
-                if (typeof (schema[fieldName]) === "string") {
-                    fieldType = schema[fieldName];
+                const type = metadata[fieldName].type;
+                if (typeof (type) === "string") {
+                    fieldType = type;
                 }
                 else {
-                    const type = schema[fieldName];
                     let childTypeSchema;
                     //
                     // TODO: refactor below.
                     //
                     if (Schema_1.Schema.is(type)) {
                         fieldType = "ref";
-                        childTypeSchema = schema[fieldName];
+                        childTypeSchema = type;
                     }
                     else {
                         fieldType = Object.keys(type)[0];
@@ -85,7 +87,7 @@ class Reflection extends Schema_1.Schema {
                         }
                     }
                     field.referencedType = (childTypeSchema)
-                        ? childTypeSchema._typeid
+                        ? context.getTypeId(childTypeSchema)
                         : -1;
                 }
                 field.type = fieldType;
@@ -93,21 +95,35 @@ class Reflection extends Schema_1.Schema {
             }
             reflection.types.push(currentType);
         };
-        const types = rootSchemaType._context?.types;
-        for (let typeid in types) {
+        for (let typeid in context.types) {
+            const klass = context.types[typeid];
             const type = new ReflectionType();
             type.id = Number(typeid);
-            buildType(type, types[typeid]._definition.schema);
+            // support inheritance
+            const inheritFrom = Object.getPrototypeOf(klass);
+            if (inheritFrom !== Schema_1.Schema) {
+                type.extendsId = context.schemas.get(inheritFrom);
+            }
+            buildType(type, klass[Symbol.metadata]);
         }
-        return reflection.encodeAll();
+        const it = { offset: 0 };
+        const buf = encoder.encodeAll(it);
+        return Buffer.from(buf, 0, it.offset);
     }
     static decode(bytes, it) {
-        const context = new annotations_1.Context();
         const reflection = new Reflection();
-        reflection.decode(bytes, it);
+        const reflectionDecoder = new Decoder_1.Decoder(reflection);
+        reflectionDecoder.decode(bytes, it);
+        const context = new annotations_1.TypeContext();
         const schemaTypes = reflection.types.reduce((types, reflectionType) => {
-            const schema = class _ extends Schema_1.Schema {
+            const parentKlass = types[reflectionType.extendsId] || Schema_1.Schema;
+            const schema = class _ extends parentKlass {
             };
+            // const _metadata = Object.create(_classSuper[Symbol.metadata] ?? null);
+            const _metadata = parentKlass && parentKlass[Symbol.metadata] || Object.create(null);
+            Object.defineProperty(schema, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+            // register for inheritance support
+            annotations_1.TypeContext.register(schema);
             const typeid = reflectionType.id;
             types[typeid] = schema;
             context.add(schema, typeid);
@@ -115,7 +131,11 @@ class Reflection extends Schema_1.Schema {
         }, {});
         reflection.types.forEach((reflectionType) => {
             const schemaType = schemaTypes[reflectionType.id];
-            reflectionType.fields.forEach(field => {
+            const metadata = schemaType[Symbol.metadata];
+            const parentKlass = reflection.types[reflectionType.extendsId];
+            const parentFieldIndex = parentKlass && parentKlass.fields.length || 0;
+            reflectionType.fields.forEach((field, i) => {
+                const fieldIndex = parentFieldIndex + i;
                 if (field.referencedType !== undefined) {
                     let fieldType = field.type;
                     let refType = schemaTypes[field.referencedType];
@@ -126,41 +146,25 @@ class Reflection extends Schema_1.Schema {
                         refType = typeInfo[1];
                     }
                     if (fieldType === "ref") {
-                        (0, annotations_1.type)(refType, { context })(schemaType.prototype, field.name);
+                        // type(refType)(schemaType.prototype, field.name);
+                        Metadata_1.Metadata.addField(metadata, fieldIndex, field.name, refType);
                     }
                     else {
-                        (0, annotations_1.type)({ [fieldType]: refType }, { context })(schemaType.prototype, field.name);
+                        // type({ [fieldType]: refType } as DefinitionType)(schemaType.prototype, field.name);
+                        Metadata_1.Metadata.addField(metadata, fieldIndex, field.name, { [fieldType]: refType });
                     }
                 }
                 else {
-                    (0, annotations_1.type)(field.type, { context })(schemaType.prototype, field.name);
+                    // type(field.type as PrimitiveType)(schemaType.prototype, field.name);
+                    Metadata_1.Metadata.addField(metadata, fieldIndex, field.name, field.type);
                 }
             });
         });
-        const rootType = schemaTypes[reflection.rootType];
-        const rootInstance = new rootType();
-        /**
-         * auto-initialize referenced types on root type
-         * to allow registering listeners immediatelly on client-side
-         */
-        for (let fieldName in rootType._definition.schema) {
-            const fieldType = rootType._definition.schema[fieldName];
-            if (typeof (fieldType) !== "string") {
-                rootInstance[fieldName] = (typeof (fieldType) === "function")
-                    ? new fieldType() // is a schema reference
-                    : new ((0, typeRegistry_1.getType)(Object.keys(fieldType)[0])).constructor(); // is a "collection"
-            }
-        }
-        return rootInstance;
+        return new (schemaTypes[0])();
     }
 }
 exports.Reflection = Reflection;
 __decorate([
-    (0, annotations_1.type)([ReflectionType], reflectionContext),
-    __metadata("design:type", ArraySchema_1.ArraySchema)
+    (0, annotations_1.type)([ReflectionType])
 ], Reflection.prototype, "types", void 0);
-__decorate([
-    (0, annotations_1.type)("number", reflectionContext),
-    __metadata("design:type", Number)
-], Reflection.prototype, "rootType", void 0);
 //# sourceMappingURL=Reflection.js.map

package/lib/Reflection.js.map

@@ -1 +1 @@
-{"version":3,"file":"Reflection.js","sourceRoot":"","sources":["../src/Reflection.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+CAA6E;AAC7E,qCAAkC;AAClC,qDAAkD;AAClD,uDAA+C;AAG/C,MAAM,iBAAiB,GAAG,EAAE,OAAO,EAAE,IAAI,qBAAO,EAAE,EAAE,CAAC;AAErD;;GAEG;AACH,MAAa,eAAgB,SAAQ,eAAM;CAS1C;AATD,0CASC;AAPG;IADC,IAAA,kBAAI,EAAC,QAAQ,EAAE,iBAAiB,CAAC;;6CACrB;AAGb;IADC,IAAA,kBAAI,EAAC,QAAQ,EAAE,iBAAiB,CAAC;;6CACrB;AAGb;IADC,IAAA,kBAAI,EAAC,QAAQ,EAAE,iBAAiB,CAAC;;uDACX;AAG3B,MAAa,cAAe,SAAQ,eAAM;IAA1C;;QAKI,WAAM,GAAiC,IAAI,yBAAW,EAAmB,CAAC;IAC9E,CAAC;CAAA;AAND,wCAMC;AAJG;IADC,IAAA,kBAAI,EAAC,QAAQ,EAAE,iBAAiB,CAAC;;0CACvB;AAGX;IADC,IAAA,kBAAI,EAAC,CAAE,eAAe,CAAE,EAAE,iBAAiB,CAAC;8BACrC,yBAAW;8CAAuD;AAG9E,MAAa,UAAW,SAAQ,eAAM;IAAtC;;QAEI,UAAK,GAAgC,IAAI,yBAAW,EAAkB,CAAC;IA8H3E,CAAC;IAzHG,MAAM,CAAC,MAAM,CAAE,QAAgB;QAC3B,MAAM,cAAc,GAAG,QAAQ,CAAC,WAA4B,CAAC;QAE7D,MAAM,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;QACpC,UAAU,CAAC,QAAQ,GAAG,cAAc,CAAC,OAAO,CAAC;QAE7C,MAAM,SAAS,GAAG,CAAC,WAA2B,EAAE,MAAW,EAAE,EAAE;YAC3D,KAAK,IAAI,SAAS,IAAI,MAAM,EAAE,CAAC;gBAC3B,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;gBACpC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;gBAEvB,IAAI,SAAiB,CAAC;gBAEtB,IAAI,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;oBAC1C,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;gBAElC,CAAC;qBAAM,CAAC;oBACJ,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;oBAC/B,IAAI,eAA8B,CAAC;oBAEnC,EAAE;oBACF,wBAAwB;oBACxB,EAAE;oBACF,IAAI,eAAM,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;wBAClB,SAAS,GAAG,KAAK,CAAC;wBAClB,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;oBAExC,CAAC;yBAAM,CAAC;wBACJ,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;wBAEjC,IAAI,OAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;4BACvC,SAAS,IAAI,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,eAAe;wBAEvD,CAAC;6BAAM,CAAC;4BACJ,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;wBACtC,CAAC;oBACL,CAAC;oBAED,KAAK,CAAC,cAAc,GAAG,CAAC,eAAe,CAAC;wBACpC,CAAC,CAAC,eAAe,CAAC,OAAO;wBACzB,CAAC,CAAC,CAAC,CAAC,CAAC;gBACb,CAAC;gBAED,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;gBACvB,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACnC,CAAC;YAED,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACvC,CAAC,CAAA;QAED,MAAM,KAAK,GAAG,cAAc,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC7C,KAAK,IAAI,MAAM,IAAI,KAAK,EAAE,CAAC;YACvB,MAAM,IAAI,GAAG,IAAI,cAAc,EAAE,CAAC;YAClC,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;YACzB,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACtD,CAAC;QAED,OAAO,UAAU,CAAC,SAAS,EAAE,CAAC;IAClC,CAAC;IAED,MAAM,CAAC,MAAM,CAA4B,KAAe,EAAE,EAAa;QACnE,MAAM,OAAO,GAAG,IAAI,qBAAO,EAAE,CAAC;QAE9B,MAAM,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;QACpC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAE7B,MAAM,WAAW,GAAG,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,cAAc,EAAE,EAAE;YAClE,MAAM,MAAM,GAAkB,MAAM,CAAE,SAAQ,eAAM;aAAG,CAAC;YACxD,MAAM,MAAM,GAAG,cAAc,CAAC,EAAE,CAAC;YACjC,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,CAAA;YACtB,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAC5B,OAAO,KAAK,CAAC;QACjB,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE;YACxC,MAAM,UAAU,GAAG,WAAW,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;YAElD,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBAClC,IAAI,KAAK,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;oBACrC,IAAI,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC;oBAC3B,IAAI,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;oBAEhD,sCAAsC;oBACtC,IAAI,CAAC,OAAO,EAAE,CAAC;wBACX,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;wBACvC,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;wBACxB,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;oBAC1B,CAAC;oBAED,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;wBACtB,IAAA,kBAAI,EAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;oBAEjE,CAAC;yBAAM,CAAC;wBACJ,IAAA,kBAAI,EAAC,EAAE,CAAC,SAAS,CAAC,EAAE,OAAO,EAAoB,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;oBACpG,CAAC;gBAEL,CAAC;qBAAM,CAAC;oBACJ,IAAA,kBAAI,EAAC,KAAK,CAAC,IAAqB,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;gBACrF,CAAC;YACL,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAA;QAEF,MAAM,QAAQ,GAAQ,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QACvD,MAAM,YAAY,GAAG,IAAI,QAAQ,EAAE,CAAC;QAEpC;;;WAGG;QACH,KAAK,IAAI,SAAS,IAAI,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;YAChD,MAAM,SAAS,GAAG,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAEzD,IAAI,OAAM,CAAC,SAAS,CAAC,KAAK,QAAQ,EAAE,CAAC;gBACjC,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,UAAU,CAAC;oBACzD,CAAC,CAAC,IAAK,SAAiB,EAAE,CAAC,wBAAwB;oBACnD,CAAC,CAAC,IAAI,CAAC,IAAA,sBAAO,EAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,oBAAoB;YACtF,CAAC;QACL,CAAC;QAED,OAAO,YAAY,CAAC;IACxB,CAAC;CACJ;AAhID,gCAgIC;AA9HG;IADC,IAAA,kBAAI,EAAC,CAAE,cAAc,CAAE,EAAE,iBAAiB,CAAC;8BACrC,yBAAW;yCAAqD;AAGvE;IADC,IAAA,kBAAI,EAAC,QAAQ,EAAE,iBAAiB,CAAC;;4CACjB","sourcesContent":["import { type, PrimitiveType, Context, DefinitionType } from \"./annotations\";\nimport { Schema } from \"./Schema\";\nimport { ArraySchema } from \"./types/ArraySchema\";\nimport { getType } from \"./types/typeRegistry\";\nimport { Iterator } from \"./encoding/decode\";\n\nconst reflectionContext = { context: new Context() };\n\n/**\n * Reflection\n */\nexport class ReflectionField extends Schema {\n    @type(\"string\", reflectionContext)\n    name: string;\n\n    @type(\"string\", reflectionContext)\n    type: string;\n\n    @type(\"number\", reflectionContext)\n    referencedType: number;\n}\n\nexport class ReflectionType extends Schema {\n    @type(\"number\", reflectionContext)\n    id: number;\n\n    @type([ ReflectionField ], reflectionContext)\n    fields: ArraySchema<ReflectionField> = new ArraySchema<ReflectionField>();\n}\n\nexport class Reflection extends Schema {\n    @type([ ReflectionType ], reflectionContext)\n    types: ArraySchema<ReflectionType> = new ArraySchema<ReflectionType>();\n\n    @type(\"number\", reflectionContext)\n    rootType: number;\n\n    static encode (instance: Schema) {\n        const rootSchemaType = instance.constructor as typeof Schema;\n\n        const reflection = new Reflection();\n        reflection.rootType = rootSchemaType._typeid;\n\n        const buildType = (currentType: ReflectionType, schema: any) => {\n            for (let fieldName in schema) {\n                const field = new ReflectionField();\n                field.name = fieldName;\n\n                let fieldType: string;\n\n                if (typeof (schema[fieldName]) === \"string\") {\n                    fieldType = schema[fieldName];\n\n                } else {\n                    const type = schema[fieldName];\n                    let childTypeSchema: typeof Schema;\n\n                    //\n                    // TODO: refactor below.\n                    //\n                    if (Schema.is(type)) {\n                        fieldType = \"ref\";\n                        childTypeSchema = schema[fieldName];\n\n                    } else {\n                        fieldType = Object.keys(type)[0];\n\n                        if (typeof(type[fieldType]) === \"string\") {\n                            fieldType += \":\" + type[fieldType]; // array:string\n\n                        } else {\n                            childTypeSchema = type[fieldType];\n                        }\n                    }\n\n                    field.referencedType = (childTypeSchema)\n                        ? childTypeSchema._typeid\n                        : -1;\n                }\n\n                field.type = fieldType;\n                currentType.fields.push(field);\n            }\n\n            reflection.types.push(currentType);\n        }\n\n        const types = rootSchemaType._context?.types;\n        for (let typeid in types) {\n            const type = new ReflectionType();\n            type.id = Number(typeid);\n            buildType(type, types[typeid]._definition.schema);\n        }\n\n        return reflection.encodeAll();\n    }\n\n    static decode<T extends Schema = Schema>(bytes: number[], it?: Iterator): T {\n        const context = new Context();\n\n        const reflection = new Reflection();\n        reflection.decode(bytes, it);\n\n        const schemaTypes = reflection.types.reduce((types, reflectionType) => {\n            const schema: typeof Schema = class _ extends Schema {};\n            const typeid = reflectionType.id;\n            types[typeid] = schema\n            context.add(schema, typeid);\n            return types;\n        }, {});\n\n        reflection.types.forEach((reflectionType) => {\n            const schemaType = schemaTypes[reflectionType.id];\n\n            reflectionType.fields.forEach(field => {\n                if (field.referencedType !== undefined) {\n                    let fieldType = field.type;\n                    let refType = schemaTypes[field.referencedType];\n\n                    // map or array of primitive type (-1)\n                    if (!refType) {\n                        const typeInfo = field.type.split(\":\");\n                        fieldType = typeInfo[0];\n                        refType = typeInfo[1];\n                    }\n\n                    if (fieldType === \"ref\") {\n                        type(refType, { context })(schemaType.prototype, field.name);\n\n                    } else {\n                        type({ [fieldType]: refType } as DefinitionType, { context })(schemaType.prototype, field.name);\n                    }\n\n                } else {\n                    type(field.type as PrimitiveType, { context })(schemaType.prototype, field.name);\n                }\n            });\n        })\n\n        const rootType: any = schemaTypes[reflection.rootType];\n        const rootInstance = new rootType();\n\n        /**\n         * auto-initialize referenced types on root type\n         * to allow registering listeners immediatelly on client-side\n         */\n        for (let fieldName in rootType._definition.schema) {\n            const fieldType = rootType._definition.schema[fieldName];\n\n            if (typeof(fieldType) !== \"string\") {\n                rootInstance[fieldName] = (typeof (fieldType) === \"function\")\n                    ? new (fieldType as any)() // is a schema reference\n                    : new (getType(Object.keys(fieldType)[0])).constructor(); // is a \"collection\"\n            }\n        }\n\n        return rootInstance;\n    }\n}\n"]}
+{"version":3,"file":"Reflection.js","sourceRoot":"","sources":["../src/Reflection.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+CAAiF;AACjF,yCAAsC;AACtC,4DAAyD;AAEzD,+CAA4C;AAC5C,+CAA4C;AAC5C,qCAAkC;AAElC;;GAEG;AACH,MAAa,eAAgB,SAAQ,eAAM;CAI1C;AAJD,0CAIC;AAHmB;IAAf,IAAA,kBAAI,EAAC,QAAQ,CAAC;6CAAc;AACb;IAAf,IAAA,kBAAI,EAAC,QAAQ,CAAC;6CAAc;AACb;IAAf,IAAA,kBAAI,EAAC,QAAQ,CAAC;uDAAwB;AAG3C,MAAa,cAAe,SAAQ,eAAM;IAA1C;;QAG+B,WAAM,GAAG,IAAI,yBAAW,EAAmB,CAAC;IAC3E,CAAC;CAAA;AAJD,wCAIC;AAHmB;IAAf,IAAA,kBAAI,EAAC,QAAQ,CAAC;0CAAY;AACX;IAAf,IAAA,kBAAI,EAAC,QAAQ,CAAC;iDAAmB;AACP;IAA1B,IAAA,kBAAI,EAAC,CAAE,eAAe,CAAE,CAAC;8CAA6C;AAG3E,MAAa,UAAW,SAAQ,eAAM;IAAtC;;QAC8B,UAAK,GAAgC,IAAI,yBAAW,EAAkB,CAAC;IA+IrG,CAAC;IA7IG,MAAM,CAAC,MAAM,CAAE,QAAgB,EAAE,OAAqB;QAClD,IAAI,CAAC,OAAO,EAAE,CAAC;YACX,OAAO,GAAG,IAAI,yBAAW,CAAC,QAAQ,CAAC,WAA4B,CAAC,CAAC;QACrE,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,IAAI,iBAAO,CAAC,UAAU,CAAC,CAAC;QAExC,MAAM,SAAS,GAAG,CAAC,WAA2B,EAAE,QAAkB,EAAE,EAAE;YAClE,KAAK,MAAM,SAAS,IAAI,QAAQ,EAAE,CAAC;gBAC/B,kCAAkC;gBAClC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,EAAE,CAAC;oBAC7D,SAAS;gBACb,CAAC;gBAED,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;gBACpC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;gBAEvB,IAAI,SAAiB,CAAC;gBAEtB,MAAM,IAAI,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC;gBAEtC,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,QAAQ,EAAE,CAAC;oBAC7B,SAAS,GAAG,IAAI,CAAC;gBAErB,CAAC;qBAAM,CAAC;oBACJ,IAAI,eAA8B,CAAC;oBAEnC,EAAE;oBACF,wBAAwB;oBACxB,EAAE;oBACF,IAAI,eAAM,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;wBAClB,SAAS,GAAG,KAAK,CAAC;wBAClB,eAAe,GAAG,IAAqB,CAAC;oBAE5C,CAAC;yBAAM,CAAC;wBACJ,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;wBAEjC,IAAI,OAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;4BACvC,SAAS,IAAI,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,eAAe;wBAEvD,CAAC;6BAAM,CAAC;4BACJ,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;wBACtC,CAAC;oBACL,CAAC;oBAED,KAAK,CAAC,cAAc,GAAG,CAAC,eAAe,CAAC;wBACpC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,eAAe,CAAC;wBACpC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACb,CAAC;gBAED,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;gBACvB,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACnC,CAAC;YAED,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACvC,CAAC,CAAA;QAED,KAAK,IAAI,MAAM,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAC/B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACpC,MAAM,IAAI,GAAG,IAAI,cAAc,EAAE,CAAC;YAClC,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;YAEzB,sBAAsB;YACtB,MAAM,WAAW,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YACjD,IAAI,WAAW,KAAK,eAAM,EAAE,CAAC;gBACzB,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YACtD,CAAC;YAED,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC5C,CAAC;QAED,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;QACzB,MAAM,GAAG,GAAG,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAClC,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM,CAAC,MAAM,CAA4B,KAAa,EAAE,EAAa;QACjE,MAAM,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;QAEpC,MAAM,iBAAiB,GAAG,IAAI,iBAAO,CAAC,UAAU,CAAC,CAAC;QAClD,iBAAiB,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAEpC,MAAM,OAAO,GAAG,IAAI,yBAAW,EAAE,CAAC;QAElC,MAAM,WAAW,GAAG,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,cAAc,EAAE,EAAE;YAClE,MAAM,WAAW,GAAkB,KAAK,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,eAAM,CAAC;YAC7E,MAAM,MAAM,GAAkB,MAAM,CAAE,SAAQ,WAAW;aAAG,CAAC;YAE7D,yEAAyE;YACzE,MAAM,SAAS,GAAG,WAAW,IAAI,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACrF,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAA;YAE1H,mCAAmC;YACnC,yBAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAE7B,MAAM,MAAM,GAAG,cAAc,CAAC,EAAE,CAAC;YACjC,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,CAAA;YACtB,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAC5B,OAAO,KAAK,CAAC;QACjB,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE;YACxC,MAAM,UAAU,GAAG,WAAW,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;YAClD,MAAM,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAE7C,MAAM,WAAW,GAAG,UAAU,CAAC,KAAK,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;YAC/D,MAAM,gBAAgB,GAAG,WAAW,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC;YAEvE,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;gBACvC,MAAM,UAAU,GAAG,gBAAgB,GAAG,CAAC,CAAC;gBAExC,IAAI,KAAK,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;oBACrC,IAAI,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC;oBAC3B,IAAI,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;oBAEhD,sCAAsC;oBACtC,IAAI,CAAC,OAAO,EAAE,CAAC;wBACX,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;wBACvC,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;wBACxB,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;oBAC1B,CAAC;oBAED,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;wBACtB,mDAAmD;wBACnD,mBAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,UAAU,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;oBAEjE,CAAC;yBAAM,CAAC;wBACJ,sFAAsF;wBACtF,mBAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,UAAU,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,OAAO,EAAoB,CAAC,CAAC;oBACpG,CAAC;gBAEL,CAAC;qBAAM,CAAC;oBACJ,uEAAuE;oBACvE,mBAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,UAAU,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAqB,CAAC,CAAC;gBACrF,CAAC;YACL,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAClC,CAAC;CACJ;AAhJD,gCAgJC;AA/I6B;IAAzB,IAAA,kBAAI,EAAC,CAAE,cAAc,CAAE,CAAC;yCAAwE","sourcesContent":["import { type, PrimitiveType, DefinitionType, TypeContext } from \"./annotations\";\nimport { Metadata } from \"./Metadata\";\nimport { ArraySchema } from \"./types/custom/ArraySchema\";\nimport { Iterator } from \"./encoding/decode\";\nimport { Encoder } from \"./encoder/Encoder\";\nimport { Decoder } from \"./decoder/Decoder\";\nimport { Schema } from \"./Schema\";\n\n/**\n * Reflection\n */\nexport class ReflectionField extends Schema {\n    @type(\"string\") name: string;\n    @type(\"string\") type: string;\n    @type(\"number\") referencedType: number;\n}\n\nexport class ReflectionType extends Schema {\n    @type(\"number\") id: number;\n    @type(\"number\") extendsId: number;\n    @type([ ReflectionField ]) fields = new ArraySchema<ReflectionField>();\n}\n\nexport class Reflection extends Schema {\n    @type([ ReflectionType ]) types: ArraySchema<ReflectionType> = new ArraySchema<ReflectionType>();\n\n    static encode (instance: Schema, context?: TypeContext) {\n        if (!context) {\n            context = new TypeContext(instance.constructor as typeof Schema);\n        }\n\n        const reflection = new Reflection();\n        const encoder = new Encoder(reflection);\n\n        const buildType = (currentType: ReflectionType, metadata: Metadata) => {\n            for (const fieldName in metadata) {\n                // skip fields from parent classes\n                if (!Object.prototype.hasOwnProperty.call(metadata, fieldName)) {\n                    continue;\n                }\n\n                const field = new ReflectionField();\n                field.name = fieldName;\n\n                let fieldType: string;\n\n                const type = metadata[fieldName].type;\n\n                if (typeof (type) === \"string\") {\n                    fieldType = type;\n\n                } else {\n                    let childTypeSchema: typeof Schema;\n\n                    //\n                    // TODO: refactor below.\n                    //\n                    if (Schema.is(type)) {\n                        fieldType = \"ref\";\n                        childTypeSchema = type as typeof Schema;\n\n                    } else {\n                        fieldType = Object.keys(type)[0];\n\n                        if (typeof(type[fieldType]) === \"string\") {\n                            fieldType += \":\" + type[fieldType]; // array:string\n\n                        } else {\n                            childTypeSchema = type[fieldType];\n                        }\n                    }\n\n                    field.referencedType = (childTypeSchema)\n                        ? context.getTypeId(childTypeSchema)\n                        : -1;\n                }\n\n                field.type = fieldType;\n                currentType.fields.push(field);\n            }\n\n            reflection.types.push(currentType);\n        }\n\n        for (let typeid in context.types) {\n            const klass = context.types[typeid];\n            const type = new ReflectionType();\n            type.id = Number(typeid);\n\n            // support inheritance\n            const inheritFrom = Object.getPrototypeOf(klass);\n            if (inheritFrom !== Schema) {\n                type.extendsId = context.schemas.get(inheritFrom);\n            }\n\n            buildType(type, klass[Symbol.metadata]);\n        }\n\n        const it = { offset: 0 };\n        const buf = encoder.encodeAll(it);\n        return Buffer.from(buf, 0, it.offset);\n    }\n\n    static decode<T extends Schema = Schema>(bytes: Buffer, it?: Iterator): T {\n        const reflection = new Reflection();\n\n        const reflectionDecoder = new Decoder(reflection);\n        reflectionDecoder.decode(bytes, it);\n\n        const context = new TypeContext();\n\n        const schemaTypes = reflection.types.reduce((types, reflectionType) => {\n            const parentKlass: typeof Schema = types[reflectionType.extendsId] || Schema;\n            const schema: typeof Schema = class _ extends parentKlass {};\n\n            // const _metadata = Object.create(_classSuper[Symbol.metadata] ?? null);\n            const _metadata = parentKlass && parentKlass[Symbol.metadata] || Object.create(null);\n            Object.defineProperty(schema, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata })\n\n            // register for inheritance support\n            TypeContext.register(schema);\n\n            const typeid = reflectionType.id;\n            types[typeid] = schema\n            context.add(schema, typeid);\n            return types;\n        }, {});\n\n        reflection.types.forEach((reflectionType) => {\n            const schemaType = schemaTypes[reflectionType.id];\n            const metadata = schemaType[Symbol.metadata];\n\n            const parentKlass = reflection.types[reflectionType.extendsId];\n            const parentFieldIndex = parentKlass && parentKlass.fields.length || 0;\n\n            reflectionType.fields.forEach((field, i) => {\n                const fieldIndex = parentFieldIndex + i;\n\n                if (field.referencedType !== undefined) {\n                    let fieldType = field.type;\n                    let refType = schemaTypes[field.referencedType];\n\n                    // map or array of primitive type (-1)\n                    if (!refType) {\n                        const typeInfo = field.type.split(\":\");\n                        fieldType = typeInfo[0];\n                        refType = typeInfo[1];\n                    }\n\n                    if (fieldType === \"ref\") {\n                        // type(refType)(schemaType.prototype, field.name);\n                        Metadata.addField(metadata, fieldIndex, field.name, refType);\n\n                    } else {\n                        // type({ [fieldType]: refType } as DefinitionType)(schemaType.prototype, field.name);\n                        Metadata.addField(metadata, fieldIndex, field.name, { [fieldType]: refType } as DefinitionType);\n                    }\n\n                } else {\n                    // type(field.type as PrimitiveType)(schemaType.prototype, field.name);\n                    Metadata.addField(metadata, fieldIndex, field.name, field.type as PrimitiveType);\n                }\n            });\n        });\n\n        return new (schemaTypes[0])();\n    }\n}\n"]}

package/lib/Schema.d.ts

@@ -1,47 +1,39 @@
-import { OPERATION } from './spec';
-import { ClientWithSessionId, Context, SchemaDefinition, DefinitionType } from "./annotations";
-import type { Iterator } from "./encoding/decode";
-import { ChangeTree, Ref } from "./changes/ChangeTree";
+import { OPERATION } from './encoding/spec';
+import { DefinitionType } from "./annotations";
 import { NonFunctionPropNames, ToJSON } from './types/HelperTypes';
-export interface DataChange<T = any, F = string> {
-    refId: number;
-    op: OPERATION;
-    field: F;
-    dynamicIndex?: number | string;
-    value: T;
-    previousValue: T;
-}
-export interface SchemaDecoderCallbacks<TValue = any, TKey = any> {
-    $callbacks: {
-        [operation: number]: Array<(item: TValue, key: TKey) => void>;
-    };
-    onAdd(callback: (item: any, key: any) => void, ignoreExisting?: boolean): () => void;
-    onRemove(callback: (item: any, key: any) => void): () => void;
-    onChange(callback: (item: any, key: any) => void): () => void;
-    clone(decoding?: boolean): SchemaDecoderCallbacks;
-    clear(changes?: DataChange[]): any;
-    decode?(byte: any, it: Iterator): any;
-}
+import { ChangeTree, Ref } from './encoder/ChangeTree';
+import { $decoder, $deleteByIndex, $encoder, $filter, $getByIndex, $track } from './types/symbols';
+import { StateView } from './encoder/StateView';
 /**
  * Schema encoder / decoder
  */
 export declare abstract class Schema {
-    static _typeid: number;
-    static _context: Context;
-    static _definition: SchemaDefinition;
-    static onError(e: any): void;
+    static [$encoder]: import("./encoder/EncodeOperation").EncodeOperation<any>;
+    static [$decoder]: import("./decoder/DecodeOperation").DecodeOperation<any>;
+    /**
+     * Assign the property descriptors required to track changes on this instance.
+     * @param instance
+     */
+    static initialize(instance: any): void;
     static is(type: DefinitionType): boolean;
-    protected $changes: ChangeTree;
-    protected $callbacks: {
-        [op: number]: Array<Function>;
-    };
-    onChange(callback: () => void): () => void;
-    onRemove(callback: () => void): () => void;
+    /**
+     * Track property changes
+     */
+    static [$track](changeTree: ChangeTree, index: number, operation?: OPERATION): void;
+    /**
+     * Determine if a property must be filtered.
+     * - If returns false, the property is NOT going to be encoded.
+     * - If returns true, the property is going to be encoded.
+     *
+     * Encoding with "filters" happens in two steps:
+     * - First, the encoder iterates over all "not owned" properties and encodes them.
+     * - Then, the encoder iterates over all "owned" properties per instance and encodes them.
+     */
+    static [$filter](ref: Schema, index: number, view: StateView): boolean;
     constructor(...args: any[]);
     assign(props: {
         [prop in NonFunctionPropNames<this>]?: this[prop];
     } | ToJSON<this>): this;
-    protected get _definition(): SchemaDefinition;
     /**
      * (Server-side): Flag a property to be encoded for the next patch.
      * @param instance Schema instance
@@ -49,24 +41,20 @@ export declare abstract class Schema {
      * @param operation OPERATION to perform (detected automatically)
      */
     setDirty<K extends NonFunctionPropNames<this>>(property: K | number, operation?: OPERATION): void;
-    /**
-     * Client-side: listen for changes on property.
-     * @param prop the property name
-     * @param callback callback to be triggered on property change
-     * @param immediate trigger immediatelly if property has been already set.
-     */
-    listen<K extends NonFunctionPropNames<this>>(prop: K, callback: (value: this[K], previousValue: this[K]) => void, immediate?: boolean): () => boolean;
-    decode(bytes: number[], it?: Iterator, ref?: Ref): DataChange<any, string>[];
-    encode(encodeAll?: boolean, bytes?: number[], useFilters?: boolean): number[];
-    encodeAll(useFilters?: boolean): number[];
-    applyFilters(client: ClientWithSessionId, encodeAll?: boolean): number[];
     clone(): this;
     toJSON(): ToJSON<this>;
     discardAllChanges(): void;
-    protected getByIndex(index: number): any;
-    protected deleteByIndex(index: number): void;
-    private tryEncodeTypeId;
-    private getSchemaType;
-    private createTypeInstance;
-    private _triggerChanges;
+    protected [$getByIndex](index: number): any;
+    protected [$deleteByIndex](index: number): void;
+    static debugRefIds(instance: Ref, jsonContents?: boolean, level?: number): string;
+    /**
+     * Return a string representation of the changes on a Schema instance.
+     * The list of changes is cleared after each encode.
+     *
+     * @param instance Schema instance
+     * @param isEncodeAll Return "full encode" instead of current change set.
+     * @returns
+     */
+    static debugChanges(instance: Ref, isEncodeAll?: boolean): string;
+    static debugChangesDeep(ref: Ref): string;
 }