@teambit/semantics.entities.semantic-schema 0.0.10 → 0.0.13

package/api-schema.ts

@@ -1,21 +1,25 @@
+import { Transform, plainToInstance } from 'class-transformer';
 import chalk from 'chalk';
 import {
   ClassSchema,
-  Export,
+  EnumSchema,
   FunctionLikeSchema,
   InterfaceSchema,
   Module,
   TypeSchema,
   VariableSchema,
 } from './schemas';
-import { SchemaNode } from './schema-node';
+import { Location, SchemaNode } from './schema-node';
+import { schemaObjToInstance } from './schema-obj-to-class';
 
-export type PlainSemanticSchema = {
-  exports?: Export[];
-};
+export class APISchema extends SchemaNode {
+  @Transform(schemaObjToInstance)
+  readonly module: Module;
 
-export class APISchema implements SchemaNode {
-  constructor(readonly module: Module) {}
+  constructor(readonly location: Location, module: Module) {
+    super();
+    this.module = module;
+  }
 
   toString() {
     return JSON.stringify(
@@ -25,20 +29,13 @@ export class APISchema implements SchemaNode {
     );
   }
 
-  toObject() {
-    return {
-      constructorName: this.constructor.name,
-      module: this.module.toObject(),
-      filename: '',
-    };
-  }
-
   toStringPerType() {
     const getSection = (ClassObj, sectionName: string) => {
       const objects = this.module.exports.filter((exp) => exp instanceof ClassObj);
       if (!objects.length) {
         return '';
       }
+
       return `${chalk.green.bold(sectionName)}\n${objects.map((c) => c.toString()).join('\n')}\n\n`;
     };
 
@@ -48,17 +45,16 @@ export class APISchema implements SchemaNode {
       getSection(InterfaceSchema, 'Interfaces') +
       getSection(FunctionLikeSchema, 'Functions') +
       getSection(VariableSchema, 'Variables') +
-      getSection(TypeSchema, 'Types')
+      getSection(TypeSchema, 'Types') +
+      getSection(EnumSchema, 'Enums')
     );
   }
 
   listSignatures() {
-    return this.module.exports.map((exp) => exp.getSignature?.());
+    return this.module.exports.map((exp) => exp.signature);
   }
 
-  static fromSchema() {}
-
-  // static from(plainSchema: PlainSemanticSchema) {
-  //   return new APISchema(plainSchema.exports);
-  // }
+  static fromObject(obj: Record<string, any>): APISchema {
+    return plainToInstance(APISchema, obj);
+  }
 }

package/dist/api-schema.d.ts

@@ -1,24 +1,11 @@
-import { Export, Module } from './schemas';
-import { SchemaNode } from './schema-node';
-export declare type PlainSemanticSchema = {
-    exports?: Export[];
-};
-export declare class APISchema implements SchemaNode {
+import { Module } from './schemas';
+import { Location, SchemaNode } from './schema-node';
+export declare class APISchema extends SchemaNode {
+    readonly location: Location;
     readonly module: Module;
-    constructor(module: Module);
+    constructor(location: Location, module: Module);
     toString(): string;
-    toObject(): {
-        constructorName: string;
-        module: {
-            constructorName: string;
-            namespace: string;
-            exports: (Record<string, any> & {
-                constructorName: string;
-            })[];
-        };
-        filename: string;
-    };
     toStringPerType(): string;
     listSignatures(): string[];
-    static fromSchema(): void;
+    static fromObject(obj: Record<string, any>): APISchema;
 }

package/dist/api-schema.js

@@ -1,25 +1,29 @@
 "use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    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 __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.APISchema = void 0;
+const class_transformer_1 = require("class-transformer");
 const chalk_1 = __importDefault(require("chalk"));
 const schemas_1 = require("./schemas");
-class APISchema {
-    constructor(module) {
+const schema_node_1 = require("./schema-node");
+const schema_obj_to_class_1 = require("./schema-obj-to-class");
+class APISchema extends schema_node_1.SchemaNode {
+    constructor(location, module) {
+        super();
+        this.location = location;
         this.module = module;
     }
     toString() {
         return JSON.stringify(this.module.exports.map((exp) => exp.toObject()), undefined, 2);
     }
-    toObject() {
-        return {
-            constructorName: this.constructor.name,
-            module: this.module.toObject(),
-            filename: '',
-        };
-    }
     toStringPerType() {
         const getSection = (ClassObj, sectionName) => {
             const objects = this.module.exports.filter((exp) => exp instanceof ClassObj);
@@ -33,12 +37,18 @@ class APISchema {
             getSection(schemas_1.InterfaceSchema, 'Interfaces') +
             getSection(schemas_1.FunctionLikeSchema, 'Functions') +
             getSection(schemas_1.VariableSchema, 'Variables') +
-            getSection(schemas_1.TypeSchema, 'Types'));
+            getSection(schemas_1.TypeSchema, 'Types') +
+            getSection(schemas_1.EnumSchema, 'Enums'));
     }
     listSignatures() {
-        return this.module.exports.map((exp) => { var _a; return (_a = exp.getSignature) === null || _a === void 0 ? void 0 : _a.call(exp); });
+        return this.module.exports.map((exp) => exp.signature);
+    }
+    static fromObject(obj) {
+        return (0, class_transformer_1.plainToInstance)(APISchema, obj);
     }
-    static fromSchema() { }
 }
+__decorate([
+    (0, class_transformer_1.Transform)(schema_obj_to_class_1.schemaObjToInstance)
+], APISchema.prototype, "module", void 0);
 exports.APISchema = APISchema;
 //# sourceMappingURL=api-schema.js.map

package/dist/api-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"api-schema.js","sourceRoot":"","sources":["../api-schema.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAC1B,uCAQmB;AAOnB,MAAa,SAAS;IACpB,YAAqB,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;IAAG,CAAC;IAEvC,QAAQ;QACN,OAAO,IAAI,CAAC,SAAS,CACnB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,EAChD,SAAS,EACT,CAAC,CACF,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,OAAO;YACL,eAAe,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;YACtC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;YAC9B,QAAQ,EAAE,EAAE;SACb,CAAC;IACJ,CAAC;IAED,eAAe;QACb,MAAM,UAAU,GAAG,CAAC,QAAQ,EAAE,WAAmB,EAAE,EAAE;YACnD,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,YAAY,QAAQ,CAAC,CAAC;YAC7E,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;gBACnB,OAAO,EAAE,CAAC;aACX;YACD,OAAO,GAAG,eAAK,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;QAChG,CAAC,CAAC;QAEF,OAAO,CACL,UAAU,CAAC,gBAAM,EAAE,YAAY,CAAC;YAChC,UAAU,CAAC,qBAAW,EAAE,SAAS,CAAC;YAClC,UAAU,CAAC,yBAAe,EAAE,YAAY,CAAC;YACzC,UAAU,CAAC,4BAAkB,EAAE,WAAW,CAAC;YAC3C,UAAU,CAAC,wBAAc,EAAE,WAAW,CAAC;YACvC,UAAU,CAAC,oBAAU,EAAE,OAAO,CAAC,CAChC,CAAC;IACJ,CAAC;IAED,cAAc;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,WAAC,OAAA,MAAA,GAAG,CAAC,YAAY,+CAAhB,GAAG,CAAiB,CAAA,EAAA,CAAC,CAAC;IAChE,CAAC;IAED,MAAM,CAAC,UAAU,KAAI,CAAC;CAKvB;AA/CD,8BA+CC"}
+{"version":3,"file":"api-schema.js","sourceRoot":"","sources":["../api-schema.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAA+D;AAC/D,kDAA0B;AAC1B,uCAQmB;AACnB,+CAAqD;AACrD,+DAA4D;AAE5D,MAAa,SAAU,SAAQ,wBAAU;IAIvC,YAAqB,QAAkB,EAAE,MAAc;QACrD,KAAK,EAAE,CAAC;QADW,aAAQ,GAAR,QAAQ,CAAU;QAErC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,SAAS,CACnB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,EAChD,SAAS,EACT,CAAC,CACF,CAAC;IACJ,CAAC;IAED,eAAe;QACb,MAAM,UAAU,GAAG,CAAC,QAAQ,EAAE,WAAmB,EAAE,EAAE;YACnD,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,YAAY,QAAQ,CAAC,CAAC;YAC7E,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;gBACnB,OAAO,EAAE,CAAC;aACX;YAED,OAAO,GAAG,eAAK,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;QAChG,CAAC,CAAC;QAEF,OAAO,CACL,UAAU,CAAC,gBAAM,EAAE,YAAY,CAAC;YAChC,UAAU,CAAC,qBAAW,EAAE,SAAS,CAAC;YAClC,UAAU,CAAC,yBAAe,EAAE,YAAY,CAAC;YACzC,UAAU,CAAC,4BAAkB,EAAE,WAAW,CAAC;YAC3C,UAAU,CAAC,wBAAc,EAAE,WAAW,CAAC;YACvC,UAAU,CAAC,oBAAU,EAAE,OAAO,CAAC;YAC/B,UAAU,CAAC,oBAAU,EAAE,OAAO,CAAC,CAChC,CAAC;IACJ,CAAC;IAED,cAAc;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACzD,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,GAAwB;QACxC,OAAO,IAAA,mCAAe,EAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IACzC,CAAC;CACF;AA3CC;IADC,IAAA,6BAAS,EAAC,yCAAmB,CAAC;yCACP;AAF1B,8BA6CC"}

package/dist/{schemas/export.d.ts → export.d.ts}

@@ -1,15 +1,14 @@
-import { SchemaNode } from '../schema-node';
 declare type Primitive = string | number | boolean | null | undefined;
 export declare type StaticProperties = Map<string, Primitive>;
-export declare class Export implements SchemaNode {
+/**
+ * @todo: this was implemented before all other schemas and is used only for composition.
+ * it needs to be align with other schemas.
+ */
+export declare class Export {
     /**
      * named export identifier of the module export.
      */
     readonly identifier: string;
-    /**
-     * API node.
-     */
-    readonly nodes?: SchemaNode[];
     /**
      * static properties attached to this export
      * @example
@@ -23,10 +22,6 @@ export declare class Export implements SchemaNode {
      * named export identifier of the module export.
      */
     identifier: string, 
-    /**
-     * API node.
-     */
-    nodes?: SchemaNode[], 
     /**
      * static properties attached to this export
      * @example

package/dist/{schemas/export.js → export.js}

@@ -1,16 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Export = void 0;
+/**
+ * @todo: this was implemented before all other schemas and is used only for composition.
+ * it needs to be align with other schemas.
+ */
 class Export {
     constructor(
     /**
      * named export identifier of the module export.
      */
     identifier, 
-    /**
-     * API node.
-     */
-    nodes, 
     /**
      * static properties attached to this export
      * @example
@@ -20,7 +20,6 @@ class Export {
      */
     staticProperties) {
         this.identifier = identifier;
-        this.nodes = nodes;
         this.staticProperties = staticProperties;
     }
     toObject() {

package/dist/export.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"export.js","sourceRoot":"","sources":["../export.ts"],"names":[],"mappings":";;;AAGA;;;GAGG;AACH,MAAa,MAAM;IACjB;IACE;;OAEG;IACM,UAAkB;IAE3B;;;;;;OAMG;IACM,gBAAmC;QATnC,eAAU,GAAV,UAAU,CAAQ;QASlB,qBAAgB,GAAhB,gBAAgB,CAAmB;IAC3C,CAAC;IAEJ,QAAQ;QACN,OAAO;YACL,eAAe,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;YACtC,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC;IACJ,CAAC;CACF;AAvBD,wBAuBC"}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export { APISchema } from './api-schema';
+export { Export, StaticProperties } from './export';
 export type { SchemaNode, Location } from './schema-node';
-export { Export, Module, StaticProperties, FunctionLikeSchema, Modifier, TypeRefSchema, VariableSchema, ClassSchema, ConstructorSchema, TypeSchema, TypeIntersectionSchema, TypeUnionSchema, TypeLiteralSchema, IndexSignatureSchema, InterfaceSchema, GetAccessorSchema, SetAccessorSchema, TypeQuerySchema, InferenceTypeSchema, LiteralTypeSchema, KeywordTypeSchema, TypeArraySchema, TypeOperatorSchema, TupleTypeSchema, ParameterSchema, } from './schemas';
+export { Module, FunctionLikeSchema, Modifier, TypeRefSchema, VariableSchema, ClassSchema, ConstructorSchema, TypeSchema, TypeIntersectionSchema, TypeUnionSchema, TypeLiteralSchema, IndexSignatureSchema, InterfaceSchema, GetAccessorSchema, SetAccessorSchema, TypeQuerySchema, InferenceTypeSchema, LiteralTypeSchema, KeywordTypeSchema, TypeArraySchema, TypeOperatorSchema, TupleTypeSchema, ParameterSchema, EnumSchema, ParenthesizedTypeSchema, TypePredicateSchema, IndexedAccessSchema, } from './schemas';
 export type { JSONSchema, JSONSchemaObject } from './json-schema';

package/dist/index.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ParameterSchema = exports.TupleTypeSchema = exports.TypeOperatorSchema = exports.TypeArraySchema = exports.KeywordTypeSchema = exports.LiteralTypeSchema = exports.InferenceTypeSchema = exports.TypeQuerySchema = exports.SetAccessorSchema = exports.GetAccessorSchema = exports.InterfaceSchema = exports.IndexSignatureSchema = exports.TypeLiteralSchema = exports.TypeUnionSchema = exports.TypeIntersectionSchema = exports.TypeSchema = exports.ConstructorSchema = exports.ClassSchema = exports.VariableSchema = exports.TypeRefSchema = exports.FunctionLikeSchema = exports.Module = exports.Export = exports.APISchema = void 0;
+exports.IndexedAccessSchema = exports.TypePredicateSchema = exports.ParenthesizedTypeSchema = exports.EnumSchema = exports.ParameterSchema = exports.TupleTypeSchema = exports.TypeOperatorSchema = exports.TypeArraySchema = exports.KeywordTypeSchema = exports.LiteralTypeSchema = exports.InferenceTypeSchema = exports.TypeQuerySchema = exports.SetAccessorSchema = exports.GetAccessorSchema = exports.InterfaceSchema = exports.IndexSignatureSchema = exports.TypeLiteralSchema = exports.TypeUnionSchema = exports.TypeIntersectionSchema = exports.TypeSchema = exports.ConstructorSchema = exports.ClassSchema = exports.VariableSchema = exports.TypeRefSchema = exports.FunctionLikeSchema = exports.Module = exports.Export = exports.APISchema = void 0;
 var api_schema_1 = require("./api-schema");
 Object.defineProperty(exports, "APISchema", { enumerable: true, get: function () { return api_schema_1.APISchema; } });
+var export_1 = require("./export");
+Object.defineProperty(exports, "Export", { enumerable: true, get: function () { return export_1.Export; } });
 var schemas_1 = require("./schemas");
-Object.defineProperty(exports, "Export", { enumerable: true, get: function () { return schemas_1.Export; } });
 Object.defineProperty(exports, "Module", { enumerable: true, get: function () { return schemas_1.Module; } });
 Object.defineProperty(exports, "FunctionLikeSchema", { enumerable: true, get: function () { return schemas_1.FunctionLikeSchema; } });
 Object.defineProperty(exports, "TypeRefSchema", { enumerable: true, get: function () { return schemas_1.TypeRefSchema; } });
@@ -27,4 +28,8 @@ Object.defineProperty(exports, "TypeArraySchema", { enumerable: true, get: funct
 Object.defineProperty(exports, "TypeOperatorSchema", { enumerable: true, get: function () { return schemas_1.TypeOperatorSchema; } });
 Object.defineProperty(exports, "TupleTypeSchema", { enumerable: true, get: function () { return schemas_1.TupleTypeSchema; } });
 Object.defineProperty(exports, "ParameterSchema", { enumerable: true, get: function () { return schemas_1.ParameterSchema; } });
+Object.defineProperty(exports, "EnumSchema", { enumerable: true, get: function () { return schemas_1.EnumSchema; } });
+Object.defineProperty(exports, "ParenthesizedTypeSchema", { enumerable: true, get: function () { return schemas_1.ParenthesizedTypeSchema; } });
+Object.defineProperty(exports, "TypePredicateSchema", { enumerable: true, get: function () { return schemas_1.TypePredicateSchema; } });
+Object.defineProperty(exports, "IndexedAccessSchema", { enumerable: true, get: function () { return schemas_1.IndexedAccessSchema; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,2CAAyC;AAAhC,uGAAA,SAAS,OAAA;AAElB,qCA0BmB;AAzBjB,iGAAA,MAAM,OAAA;AACN,iGAAA,MAAM,OAAA;AAEN,6GAAA,kBAAkB,OAAA;AAElB,wGAAA,aAAa,OAAA;AACb,yGAAA,cAAc,OAAA;AACd,sGAAA,WAAW,OAAA;AACX,4GAAA,iBAAiB,OAAA;AACjB,qGAAA,UAAU,OAAA;AACV,iHAAA,sBAAsB,OAAA;AACtB,0GAAA,eAAe,OAAA;AACf,4GAAA,iBAAiB,OAAA;AACjB,+GAAA,oBAAoB,OAAA;AACpB,0GAAA,eAAe,OAAA;AACf,4GAAA,iBAAiB,OAAA;AACjB,4GAAA,iBAAiB,OAAA;AACjB,0GAAA,eAAe,OAAA;AACf,8GAAA,mBAAmB,OAAA;AACnB,4GAAA,iBAAiB,OAAA;AACjB,4GAAA,iBAAiB,OAAA;AACjB,0GAAA,eAAe,OAAA;AACf,6GAAA,kBAAkB,OAAA;AAClB,0GAAA,eAAe,OAAA;AACf,0GAAA,eAAe,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,2CAAyC;AAAhC,uGAAA,SAAS,OAAA;AAClB,mCAAoD;AAA3C,gGAAA,MAAM,OAAA;AAEf,qCA4BmB;AA3BjB,iGAAA,MAAM,OAAA;AACN,6GAAA,kBAAkB,OAAA;AAElB,wGAAA,aAAa,OAAA;AACb,yGAAA,cAAc,OAAA;AACd,sGAAA,WAAW,OAAA;AACX,4GAAA,iBAAiB,OAAA;AACjB,qGAAA,UAAU,OAAA;AACV,iHAAA,sBAAsB,OAAA;AACtB,0GAAA,eAAe,OAAA;AACf,4GAAA,iBAAiB,OAAA;AACjB,+GAAA,oBAAoB,OAAA;AACpB,0GAAA,eAAe,OAAA;AACf,4GAAA,iBAAiB,OAAA;AACjB,4GAAA,iBAAiB,OAAA;AACjB,0GAAA,eAAe,OAAA;AACf,8GAAA,mBAAmB,OAAA;AACnB,4GAAA,iBAAiB,OAAA;AACjB,4GAAA,iBAAiB,OAAA;AACjB,0GAAA,eAAe,OAAA;AACf,6GAAA,kBAAkB,OAAA;AAClB,0GAAA,eAAe,OAAA;AACf,0GAAA,eAAe,OAAA;AACf,qGAAA,UAAU,OAAA;AACV,kHAAA,uBAAuB,OAAA;AACvB,8GAAA,mBAAmB,OAAA;AACnB,8GAAA,mBAAmB,OAAA"}

package/dist/schema-node.d.ts

@@ -1,13 +1,14 @@
 /**
- * an interface for implementing a new schema node.
+ * a convenient abstract class for all schema to extend.
+ * the reason for having it as an abstract class and not an interface, for now, is mostly for the `__schema` prop.
+ * this way it won't need to be implemented in each one of the subclasses.
  */
-export interface SchemaNode {
-    readonly location?: Location;
-    getSignature?(): string;
-    toString(): string;
-    toObject(): Record<string, any> & {
-        constructorName: string;
-    };
+export declare abstract class SchemaNode {
+    readonly __schema: string;
+    abstract readonly location: Location;
+    readonly signature?: string;
+    abstract toString(): string;
+    toObject(): Record<string, any>;
 }
 export declare type Location = {
     file: string;

package/dist/schema-node.js

@@ -1,3 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaNode = void 0;
+const class_transformer_1 = require("class-transformer");
+/**
+ * a convenient abstract class for all schema to extend.
+ * the reason for having it as an abstract class and not an interface, for now, is mostly for the `__schema` prop.
+ * this way it won't need to be implemented in each one of the subclasses.
+ */
+class SchemaNode {
+    constructor() {
+        this.__schema = this.constructor.name;
+    }
+    toObject() {
+        return (0, class_transformer_1.instanceToPlain)(this);
+    }
+}
+exports.SchemaNode = SchemaNode;
 //# sourceMappingURL=schema-node.js.map

package/dist/schema-node.js.map

@@ -1 +1 @@
-{"version":3,"file":"schema-node.js","sourceRoot":"","sources":["../schema-node.ts"],"names":[],"mappings":""}
+{"version":3,"file":"schema-node.js","sourceRoot":"","sources":["../schema-node.ts"],"names":[],"mappings":";;;AAAA,yDAAoD;AAEpD;;;;GAIG;AACH,MAAsB,UAAU;IAAhC;QACW,aAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAS5C,CAAC;IAHC,QAAQ;QACN,OAAO,IAAA,mCAAe,EAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;CACF;AAVD,gCAUC"}

package/dist/schema-obj-to-class.d.ts

@@ -0,0 +1,10 @@
+import { TransformationType } from 'class-transformer';
+import { SchemaNode } from './schema-node';
+export declare function schemaObjArrayToInstances({ value, type }: {
+    value: SchemaNode[];
+    type: TransformationType;
+}): SchemaNode[];
+export declare function schemaObjToInstance({ value, type }: {
+    value: Record<string, any>;
+    type: TransformationType;
+}): Record<string, any>;

package/dist/schema-obj-to-class.js

@@ -0,0 +1,56 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.schemaObjToInstance = exports.schemaObjArrayToInstances = void 0;
+const class_transformer_1 = require("class-transformer");
+const lodash_1 = require("lodash");
+const Schemas = __importStar(require("./schemas"));
+function schemaObjArrayToInstances({ value, type }) {
+    if (type !== class_transformer_1.TransformationType.PLAIN_TO_CLASS) {
+        return value;
+    }
+    return value.map((obj) => transformFromObjectToInstance(obj));
+}
+exports.schemaObjArrayToInstances = schemaObjArrayToInstances;
+function schemaObjToInstance({ value, type }) {
+    if (type !== class_transformer_1.TransformationType.PLAIN_TO_CLASS) {
+        return value;
+    }
+    return transformFromObjectToInstance(value);
+}
+exports.schemaObjToInstance = schemaObjToInstance;
+function transformFromObjectToInstance(obj) {
+    if (!obj.__schema) {
+        throw new Error(`fatal: "__schema" is missing, make sure the transformer is set on SchemaNode type`);
+    }
+    const SchemaClass = getClassBySchemaName(obj.__schema);
+    return (0, class_transformer_1.plainToInstance)(SchemaClass, obj);
+}
+function getClassBySchemaName(schemaName) {
+    const schemasClasses = (0, lodash_1.compact)(Object.values(Schemas));
+    const schemaClass = schemasClasses.find((schema) => schema.name === schemaName);
+    if (!schemaClass) {
+        throw new Error(`unable to find schema "${schemaName}". the following schemas are supported:
+${schemasClasses.map((s) => s.name).join(', ')}`);
+    }
+    return schemaClass;
+}
+//# sourceMappingURL=schema-obj-to-class.js.map

package/dist/schema-obj-to-class.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-obj-to-class.js","sourceRoot":"","sources":["../schema-obj-to-class.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,yDAA0F;AAC1F,mCAAiC;AAEjC,mDAAqC;AAErC,SAAgB,yBAAyB,CAAC,EAAE,KAAK,EAAE,IAAI,EAAqD;IAC1G,IAAI,IAAI,KAAK,sCAAkB,CAAC,cAAc,EAAE;QAC9C,OAAO,KAAK,CAAC;KACd;IACD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,6BAA6B,CAAC,GAAG,CAAC,CAAC,CAAC;AAChE,CAAC;AALD,8DAKC;AAED,SAAgB,mBAAmB,CAAC,EAAE,KAAK,EAAE,IAAI,EAA4D;IAC3G,IAAI,IAAI,KAAK,sCAAkB,CAAC,cAAc,EAAE;QAC9C,OAAO,KAAK,CAAC;KACd;IACD,OAAO,6BAA6B,CAAC,KAAK,CAAC,CAAC;AAC9C,CAAC;AALD,kDAKC;AAED,SAAS,6BAA6B,CAAC,GAAwB;IAC7D,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,mFAAmF,CAAC,CAAC;KACtG;IACD,MAAM,WAAW,GAAG,oBAAoB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACvD,OAAO,IAAA,mCAAe,EAAC,WAAW,EAAE,GAAG,CAAC,CAAC;AAC3C,CAAC;AAED,SAAS,oBAAoB,CAAC,UAAkB;IAC9C,MAAM,cAAc,GAAG,IAAA,gBAAO,EAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IACvD,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;IAChF,IAAI,CAAC,WAAW,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,0BAA0B,UAAU;EACtD,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;KAC/C;IACD,OAAO,WAAW,CAAC;AACrB,CAAC"}

package/dist/schemas/class.d.ts

@@ -1,15 +1,8 @@
 import { Location, SchemaNode } from '../schema-node';
-export declare class ClassSchema implements SchemaNode {
+export declare class ClassSchema extends SchemaNode {
     readonly className: string;
-    readonly members: SchemaNode[];
     readonly location: Location;
+    readonly members: SchemaNode[];
     constructor(className: string, members: SchemaNode[], location: Location);
-    toObject(): {
-        constructorName: string;
-        name: string;
-        members: (Record<string, any> & {
-            constructorName: string;
-        })[];
-    };
     toString(): string;
 }

package/dist/schemas/class.js

@@ -1,27 +1,33 @@
 "use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    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 __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClassSchema = void 0;
+const class_transformer_1 = require("class-transformer");
 const chalk_1 = __importDefault(require("chalk"));
-class ClassSchema {
+const schema_node_1 = require("../schema-node");
+const schema_obj_to_class_1 = require("../schema-obj-to-class");
+class ClassSchema extends schema_node_1.SchemaNode {
     constructor(className, members, location) {
+        super();
         this.className = className;
-        this.members = members;
         this.location = location;
-    }
-    toObject() {
-        return {
-            constructorName: this.constructor.name,
-            name: this.className,
-            members: this.members.map((member) => member.toObject()),
-        };
+        this.members = members;
     }
     toString() {
         const membersStr = this.members.map((m) => `* ${m.toString()}`).join('\n');
         return `${chalk_1.default.bold.underline(this.className)}\n${membersStr}`;
     }
 }
+__decorate([
+    (0, class_transformer_1.Transform)(schema_obj_to_class_1.schemaObjArrayToInstances)
+], ClassSchema.prototype, "members", void 0);
 exports.ClassSchema = ClassSchema;
 //# sourceMappingURL=class.js.map

package/dist/schemas/class.js.map

@@ -1 +1 @@
-{"version":3,"file":"class.js","sourceRoot":"","sources":["../../schemas/class.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAG1B,MAAa,WAAW;IACtB,YAAqB,SAAiB,EAAW,OAAqB,EAAW,QAAkB;QAA9E,cAAS,GAAT,SAAS,CAAQ;QAAW,YAAO,GAAP,OAAO,CAAc;QAAW,aAAQ,GAAR,QAAQ,CAAU;IAAG,CAAC;IAEvG,QAAQ;QACN,OAAO;YACL,eAAe,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;YACtC,IAAI,EAAE,IAAI,CAAC,SAAS;YACpB,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;SACzD,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3E,OAAO,GAAG,eAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,UAAU,EAAE,CAAC;IAClE,CAAC;CACF;AAfD,kCAeC"}
+{"version":3,"file":"class.js","sourceRoot":"","sources":["../../schemas/class.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAA8C;AAC9C,kDAA0B;AAC1B,gDAAsD;AACtD,gEAAmE;AAEnE,MAAa,WAAY,SAAQ,wBAAU;IAGzC,YAAqB,SAAiB,EAAE,OAAqB,EAAW,QAAkB;QACxF,KAAK,EAAE,CAAC;QADW,cAAS,GAAT,SAAS,CAAQ;QAAkC,aAAQ,GAAR,QAAQ,CAAU;QAExF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,QAAQ;QACN,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3E,OAAO,GAAG,eAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,UAAU,EAAE,CAAC;IAClE,CAAC;CACF;AAVC;IADC,IAAA,6BAAS,EAAC,+CAAyB,CAAC;4CACN;AAFjC,kCAYC"}

package/dist/schemas/constructor.d.ts

@@ -1,19 +1,8 @@
-import { SchemaNode } from '../schema-node';
+import { Location, SchemaNode } from '../schema-node';
 import { ParameterSchema } from './parameter';
-export declare class ConstructorSchema implements SchemaNode {
+export declare class ConstructorSchema extends SchemaNode {
+    readonly location: Location;
     readonly params: ParameterSchema[];
-    constructor(params: ParameterSchema[]);
+    constructor(location: Location, params: ParameterSchema[]);
     toString(): string;
-    toObject(): {
-        constructorName: string;
-        args: {
-            constructorName: string;
-            name: string;
-            type: Record<string, any> & {
-                constructorName: string;
-            };
-            defaultValue: any;
-            description: string;
-        }[];
-    };
 }

package/dist/schemas/constructor.js

@@ -1,24 +1,32 @@
 "use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    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 __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConstructorSchema = void 0;
+const class_transformer_1 = require("class-transformer");
 const chalk_1 = __importDefault(require("chalk"));
-class ConstructorSchema {
-    constructor(params) {
+const schema_node_1 = require("../schema-node");
+const schema_obj_to_class_1 = require("../schema-obj-to-class");
+class ConstructorSchema extends schema_node_1.SchemaNode {
+    constructor(location, params) {
+        super();
+        this.location = location;
         this.params = params;
     }
     toString() {
         const paramsStr = this.params.map((param) => param.toString()).join(', ');
         return `${chalk_1.default.bold('constructor')}(${paramsStr})`;
     }
-    toObject() {
-        return {
-            constructorName: this.constructor.name,
-            args: this.params.map((arg) => arg.toObject()),
-        };
-    }
 }
+__decorate([
+    (0, class_transformer_1.Transform)(schema_obj_to_class_1.schemaObjArrayToInstances)
+], ConstructorSchema.prototype, "params", void 0);
 exports.ConstructorSchema = ConstructorSchema;
 //# sourceMappingURL=constructor.js.map

package/dist/schemas/constructor.js.map

@@ -1 +1 @@
-{"version":3,"file":"constructor.js","sourceRoot":"","sources":["../../schemas/constructor.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAI1B,MAAa,iBAAiB;IAC5B,YAAqB,MAAyB;QAAzB,WAAM,GAAN,MAAM,CAAmB;IAAG,CAAC;IAElD,QAAQ;QACN,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1E,OAAO,GAAG,eAAK,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,SAAS,GAAG,CAAC;IACtD,CAAC;IAED,QAAQ;QACN,OAAO;YACL,eAAe,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;YACtC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;SAC/C,CAAC;IACJ,CAAC;CACF;AAdD,8CAcC"}
+{"version":3,"file":"constructor.js","sourceRoot":"","sources":["../../schemas/constructor.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAA8C;AAC9C,kDAA0B;AAC1B,gDAAsD;AAEtD,gEAAmE;AAEnE,MAAa,iBAAkB,SAAQ,wBAAU;IAG/C,YAAqB,QAAkB,EAAE,MAAyB;QAChE,KAAK,EAAE,CAAC;QADW,aAAQ,GAAR,QAAQ,CAAU;QAErC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,QAAQ;QACN,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1E,OAAO,GAAG,eAAK,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,SAAS,GAAG,CAAC;IACtD,CAAC;CACF;AAVC;IADC,IAAA,6BAAS,EAAC,+CAAyB,CAAC;iDACF;AAFrC,8CAYC"}

package/dist/schemas/enum.d.ts

@@ -0,0 +1,8 @@
+import { Location, SchemaNode } from '../schema-node';
+export declare class EnumSchema extends SchemaNode {
+    readonly location: Location;
+    readonly name: string;
+    readonly members: string[];
+    constructor(location: Location, name: string, members: string[]);
+    toString(): string;
+}

package/dist/schemas/enum.js

@@ -1 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnumSchema = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const schema_node_1 = require("../schema-node");
+class EnumSchema extends schema_node_1.SchemaNode {
+    constructor(location, name, members) {
+        super();
+        this.location = location;
+        this.name = name;
+        this.members = members;
+    }
+    toString() {
+        const membersStr = this.members.map((m) => `* ${m.toString()}`).join('\n');
+        return `${chalk_1.default.bold.underline(this.name)}\n${membersStr}`;
+    }
+}
+exports.EnumSchema = EnumSchema;
 //# sourceMappingURL=enum.js.map

package/dist/schemas/enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"enum.js","sourceRoot":"","sources":["../../schemas/enum.ts"],"names":[],"mappings":""}
+{"version":3,"file":"enum.js","sourceRoot":"","sources":["../../schemas/enum.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAC1B,gDAAsD;AAEtD,MAAa,UAAW,SAAQ,wBAAU;IACxC,YAAqB,QAAkB,EAAW,IAAY,EAAW,OAAiB;QACxF,KAAK,EAAE,CAAC;QADW,aAAQ,GAAR,QAAQ,CAAU;QAAW,SAAI,GAAJ,IAAI,CAAQ;QAAW,YAAO,GAAP,OAAO,CAAU;IAE1F,CAAC;IAED,QAAQ;QACN,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3E,OAAO,GAAG,eAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,UAAU,EAAE,CAAC;IAC7D,CAAC;CACF;AATD,gCASC"}

package/dist/schemas/function-like.d.ts

@@ -1,26 +1,18 @@
 import { Location, SchemaNode } from '../schema-node';
 import { ParameterSchema } from './parameter';
-export declare type Modifier = 'static' | 'public' | 'private' | 'protected' | 'readonly' | 'abstract' | 'async' | 'override';
-export declare class FunctionLikeSchema implements SchemaNode {
+export declare type Modifier = 'static' | 'public' | 'private' | 'protected' | 'readonly' | 'abstract' | 'async' | 'override' | 'export';
+/**
+ * function-like can be a function, method, arrow-function, variable-function, etc.
+ */
+export declare class FunctionLikeSchema extends SchemaNode {
+    readonly location: Location;
     readonly name: string;
-    readonly params: ParameterSchema[];
-    readonly returnType: SchemaNode;
     readonly signature: string;
-    readonly location: Location;
     readonly modifiers: Modifier[];
-    constructor(name: string, params: ParameterSchema[], returnType: SchemaNode, signature: string, location: Location, modifiers?: Modifier[]);
-    serialize(): void;
-    toJsonSchema(): void;
+    readonly returnType: SchemaNode;
+    readonly params: ParameterSchema[];
+    constructor(location: Location, name: string, params: ParameterSchema[], returnType: SchemaNode, signature: string, modifiers?: Modifier[]);
     getSignature(): string;
-    toObject(): {
-        constructorName: string;
-        name: string;
-        params: ParameterSchema[];
-        returnType: Record<string, any> & {
-            constructorName: string;
-        };
-        signature: string;
-        modifiers: Modifier[];
-    };
     toString(): string;
+    private modifiersToString;
 }