@teambit/semantics.entities.semantic-schema 0.0.9 → 0.0.12

package/dist/schemas/type-query.js

@@ -1,27 +1,34 @@
 "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;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TypeQuerySchema = void 0;
+const class_transformer_1 = require("class-transformer");
+const schema_node_1 = require("../schema-node");
+const schema_obj_to_class_1 = require("../schema-obj-to-class");
 /**
  * e.g. `typeof Foo`
  */
-class TypeQuerySchema {
-    constructor(type, signature) {
-        this.type = type;
+class TypeQuerySchema extends schema_node_1.SchemaNode {
+    constructor(location, type, signature) {
+        super();
+        this.location = location;
         this.signature = signature;
+        this.type = type;
     }
     getSignature() {
         return this.signature;
     }
-    toObject() {
-        return {
-            constructorName: this.constructor.name,
-            type: this.type,
-            signature: this.signature,
-        };
-    }
     toString() {
         return `typeof ${this.type.toString()}`;
     }
 }
+__decorate([
+    (0, class_transformer_1.Transform)(schema_obj_to_class_1.schemaObjToInstance)
+], TypeQuerySchema.prototype, "type", void 0);
 exports.TypeQuerySchema = TypeQuerySchema;
 //# sourceMappingURL=type-query.js.map

package/dist/schemas/type-query.js.map

@@ -1 +1 @@
-{"version":3,"file":"type-query.js","sourceRoot":"","sources":["../../schemas/type-query.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,MAAa,eAAe;IAC1B,YAAoB,IAAgB,EAAU,SAAiB;QAA3C,SAAI,GAAJ,IAAI,CAAY;QAAU,cAAS,GAAT,SAAS,CAAQ;IAAG,CAAC;IACnE,YAAY;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,QAAQ;QACN,OAAO;YACL,eAAe,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;YACtC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,OAAO,UAAU,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;IAC1C,CAAC;CACF;AAjBD,0CAiBC"}
+{"version":3,"file":"type-query.js","sourceRoot":"","sources":["../../schemas/type-query.ts"],"names":[],"mappings":";;;;;;;;;AAAA,yDAA8C;AAC9C,gDAAsD;AACtD,gEAA6D;AAE7D;;GAEG;AACH,MAAa,eAAgB,SAAQ,wBAAU;IAG7C,YAAqB,QAAkB,EAAE,IAAgB,EAAW,SAAiB;QACnF,KAAK,EAAE,CAAC;QADW,aAAQ,GAAR,QAAQ,CAAU;QAA6B,cAAS,GAAT,SAAS,CAAQ;QAEnF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IACD,YAAY;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,QAAQ;QACN,OAAO,UAAU,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;IAC1C,CAAC;CACF;AAZC;IADC,IAAA,6BAAS,EAAC,yCAAmB,CAAC;6CACL;AAF5B,0CAcC"}

package/dist/schemas/type-ref.d.ts

@@ -1,11 +1,18 @@
 import { ComponentID } from '@teambit/component';
-import { SchemaNode } from '../schema-node';
+import { Location, SchemaNode } from '../schema-node';
 export declare type PlainTypeRefSchema = {
     name: string;
     componentId?: string;
     packageName?: string;
 };
-export declare class TypeRefSchema implements SchemaNode {
+/**
+ * can be one of the following:
+ * 1. a reference to another "export" in the same component
+ * 2. a reference to another component.
+ * 3. a reference to a package.
+ */
+export declare class TypeRefSchema extends SchemaNode {
+    readonly location: Location;
     /**
      * name of the reference to type.
      */
@@ -18,7 +25,11 @@ export declare class TypeRefSchema implements SchemaNode {
      * target package name. existing if type is defined in different package.
      */
     readonly packageName?: string;
-    constructor(
+    /**
+     *  optional type arguments, e.g. type Foo = Bar<X, Y>. The X and Y are type arguments.
+     */
+    typeArgs?: SchemaNode[];
+    constructor(location: Location, 
     /**
      * name of the reference to type.
      */
@@ -31,16 +42,10 @@ export declare class TypeRefSchema implements SchemaNode {
      * target package name. existing if type is defined in different package.
      */
     packageName?: string);
-    toObject(): {
-        constructorName: string;
-        name: string;
-        componentId: ComponentID;
-        packageName: string;
-    };
     toString(): string;
+    private nameToString;
     /**
      * whether this type was already exported in this component
      */
     isFromThisComponent(): boolean;
-    static from(plainSchema: PlainTypeRefSchema): TypeRefSchema;
 }

package/dist/schemas/type-ref.js

@@ -1,13 +1,27 @@
 "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.TypeRefSchema = void 0;
-const component_1 = require("@teambit/component");
+const class_transformer_1 = require("class-transformer");
 const chalk_1 = __importDefault(require("chalk"));
-class TypeRefSchema {
-    constructor(
+const schema_node_1 = require("../schema-node");
+const schema_obj_to_class_1 = require("../schema-obj-to-class");
+/**
+ * can be one of the following:
+ * 1. a reference to another "export" in the same component
+ * 2. a reference to another component.
+ * 3. a reference to a package.
+ */
+class TypeRefSchema extends schema_node_1.SchemaNode {
+    constructor(location, 
     /**
      * name of the reference to type.
      */
@@ -20,24 +34,28 @@ class TypeRefSchema {
      * target package name. existing if type is defined in different package.
      */
     packageName) {
+        super();
+        this.location = location;
         this.name = name;
         this.componentId = componentId;
         this.packageName = packageName;
     }
-    toObject() {
-        return {
-            constructorName: this.constructor.name,
-            name: this.name,
-            componentId: this.componentId,
-            packageName: this.packageName,
-        };
-    }
     toString() {
+        const name = this.nameToString();
+        if (!this.typeArgs) {
+            return name;
+        }
+        const args = this.typeArgs.map((arg) => arg.toString()).join(', ');
+        return `${name}<${args}>`;
+    }
+    nameToString() {
         if (this.componentId) {
-            return `${this.componentId}/${this.name}`;
+            const compStr = chalk_1.default.dim(`(component: ${this.componentId.toStringWithoutVersion()})`);
+            return `${compStr} ${this.name}`;
         }
         if (this.packageName) {
-            return `${chalk_1.default.dim(this.packageName)}/${this.name}`;
+            const pkgStr = chalk_1.default.dim(`(package: ${this.packageName})`);
+            return `${pkgStr} ${this.name}`;
         }
         return this.name;
     }
@@ -47,9 +65,9 @@ class TypeRefSchema {
     isFromThisComponent() {
         return !this.componentId && !this.packageName;
     }
-    static from(plainSchema) {
-        return new TypeRefSchema(plainSchema.name, plainSchema.componentId ? component_1.ComponentID.fromString(plainSchema.componentId) : undefined, plainSchema.packageName);
-    }
 }
+__decorate([
+    (0, class_transformer_1.Transform)(schema_obj_to_class_1.schemaObjArrayToInstances)
+], TypeRefSchema.prototype, "typeArgs", void 0);
 exports.TypeRefSchema = TypeRefSchema;
 //# sourceMappingURL=type-ref.js.map

package/dist/schemas/type-ref.js.map

@@ -1 +1 @@
-{"version":3,"file":"type-ref.js","sourceRoot":"","sources":["../../schemas/type-ref.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAiD;AACjD,kDAA0B;AAS1B,MAAa,aAAa;IACxB;IACE;;OAEG;IACM,IAAY;IAErB;;OAEG;IACM,WAAyB;IAElC;;OAEG;IACM,WAAoB;QAVpB,SAAI,GAAJ,IAAI,CAAQ;QAKZ,gBAAW,GAAX,WAAW,CAAc;QAKzB,gBAAW,GAAX,WAAW,CAAS;IAC5B,CAAC;IAEJ,QAAQ;QACN,OAAO;YACL,eAAe,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;YACtC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,WAAW,EAAE,IAAI,CAAC,WAAW;SAC9B,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO,GAAG,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;SAC3C;QACD,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO,GAAG,eAAK,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;SACtD;QACD,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,mBAAmB;QACjB,OAAO,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;IAChD,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,WAA+B;QACzC,OAAO,IAAI,aAAa,CACtB,WAAW,CAAC,IAAI,EAChB,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,uBAAW,CAAC,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,EACrF,WAAW,CAAC,WAAW,CACxB,CAAC;IACJ,CAAC;CACF;AAnDD,sCAmDC"}
+{"version":3,"file":"type-ref.js","sourceRoot":"","sources":["../../schemas/type-ref.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAA8C;AAE9C,kDAA0B;AAC1B,gDAAsD;AACtD,gEAAmE;AAQnE;;;;;GAKG;AACH,MAAa,aAAc,SAAQ,wBAAU;IAO3C,YACW,QAAkB;IAC3B;;OAEG;IACM,IAAY;IAErB;;OAEG;IACM,WAAyB;IAElC;;OAEG;IACM,WAAoB;QAE7B,KAAK,EAAE,CAAC;QAhBC,aAAQ,GAAR,QAAQ,CAAU;QAIlB,SAAI,GAAJ,IAAI,CAAQ;QAKZ,gBAAW,GAAX,WAAW,CAAc;QAKzB,gBAAW,GAAX,WAAW,CAAS;IAG/B,CAAC;IAED,QAAQ;QACN,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QACjC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,OAAO,IAAI,CAAC;SACb;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnE,OAAO,GAAG,IAAI,IAAI,IAAI,GAAG,CAAC;IAC5B,CAAC;IAEO,YAAY;QAClB,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,OAAO,GAAG,eAAK,CAAC,GAAG,CAAC,eAAe,IAAI,CAAC,WAAW,CAAC,sBAAsB,EAAE,GAAG,CAAC,CAAC;YACvF,OAAO,GAAG,OAAO,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;SAClC;QACD,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,MAAM,GAAG,eAAK,CAAC,GAAG,CAAC,aAAa,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC;YAC3D,OAAO,GAAG,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;SACjC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,mBAAmB;QACjB,OAAO,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;IAChD,CAAC;CASF;AAzDC;IAJC,IAAA,6BAAS,EAAC,+CAAyB,CAAC;+CAIb;AAL1B,sCA8DC"}

package/dist/schemas/type-union.d.ts

@@ -1,12 +1,7 @@
-import { SchemaNode } from '../schema-node';
-export declare class TypeUnionSchema implements SchemaNode {
-    private types;
-    constructor(types: SchemaNode[]);
-    toObject(): {
-        constructorName: string;
-        types: (Record<string, any> & {
-            constructorName: string;
-        })[];
-    };
+import { Location, SchemaNode } from '../schema-node';
+export declare class TypeUnionSchema extends SchemaNode {
+    readonly location: Location;
+    readonly types: SchemaNode[];
+    constructor(location: Location, types: SchemaNode[]);
     toString(): string;
 }

package/dist/schemas/type-union.js

@@ -1,19 +1,27 @@
 "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;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TypeUnionSchema = void 0;
-class TypeUnionSchema {
-    constructor(types) {
+const class_transformer_1 = require("class-transformer");
+const schema_node_1 = require("../schema-node");
+const schema_obj_to_class_1 = require("../schema-obj-to-class");
+class TypeUnionSchema extends schema_node_1.SchemaNode {
+    constructor(location, types) {
+        super();
+        this.location = location;
         this.types = types;
     }
-    toObject() {
-        return {
-            constructorName: this.constructor.name,
-            types: this.types.map((type) => type.toObject()),
-        };
-    }
     toString() {
         return `${this.types.map((type) => type.toString()).join(' | ')}`;
     }
 }
+__decorate([
+    (0, class_transformer_1.Transform)(schema_obj_to_class_1.schemaObjArrayToInstances)
+], TypeUnionSchema.prototype, "types", void 0);
 exports.TypeUnionSchema = TypeUnionSchema;
 //# sourceMappingURL=type-union.js.map

package/dist/schemas/type-union.js.map

@@ -1 +1 @@
-{"version":3,"file":"type-union.js","sourceRoot":"","sources":["../../schemas/type-union.ts"],"names":[],"mappings":";;;AAEA,MAAa,eAAe;IAC1B,YAAoB,KAAmB;QAAnB,UAAK,GAAL,KAAK,CAAc;IAAG,CAAC;IAC3C,QAAQ;QACN,OAAO;YACL,eAAe,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;YACtC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;SACjD,CAAC;IACJ,CAAC;IACD,QAAQ;QACN,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;IACpE,CAAC;CACF;AAXD,0CAWC"}
+{"version":3,"file":"type-union.js","sourceRoot":"","sources":["../../schemas/type-union.ts"],"names":[],"mappings":";;;;;;;;;AAAA,yDAA8C;AAC9C,gDAAsD;AACtD,gEAAmE;AAEnE,MAAa,eAAgB,SAAQ,wBAAU;IAG7C,YAAqB,QAAkB,EAAE,KAAmB;QAC1D,KAAK,EAAE,CAAC;QADW,aAAQ,GAAR,QAAQ,CAAU;QAErC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IACD,QAAQ;QACN,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;IACpE,CAAC;CACF;AARC;IADC,IAAA,6BAAS,EAAC,+CAAyB,CAAC;8CACR;AAF/B,0CAUC"}

package/dist/schemas/type.d.ts

@@ -1,16 +1,9 @@
-import { SchemaNode } from '../schema-node';
-export declare class TypeSchema implements SchemaNode {
-    private name;
-    private type;
-    private signature;
-    constructor(name: string, type: SchemaNode, signature: string);
-    toObject(): {
-        constructorName: string;
-        name: string;
-        type: Record<string, any> & {
-            constructorName: string;
-        };
-        signature: string;
-    };
+import { Location, SchemaNode } from '../schema-node';
+export declare class TypeSchema extends SchemaNode {
+    readonly location: Location;
+    readonly name: string;
+    readonly signature: string;
+    readonly type: SchemaNode;
+    constructor(location: Location, name: string, type: SchemaNode, signature: string);
     toString(): string;
 }

package/dist/schemas/type.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.TypeSchema = void 0;
+const class_transformer_1 = require("class-transformer");
 const chalk_1 = __importDefault(require("chalk"));
-class TypeSchema {
-    constructor(name, type, signature) {
+const schema_node_1 = require("../schema-node");
+const schema_obj_to_class_1 = require("../schema-obj-to-class");
+class TypeSchema extends schema_node_1.SchemaNode {
+    constructor(location, name, type, signature) {
+        super();
+        this.location = location;
         this.name = name;
-        this.type = type;
         this.signature = signature;
-    }
-    toObject() {
-        return {
-            constructorName: this.constructor.name,
-            name: this.name,
-            type: this.type.toObject(),
-            signature: this.signature,
-        };
+        this.type = type;
     }
     toString() {
         return `${chalk_1.default.bold(this.name)}: ${this.type.toString()}`;
     }
 }
+__decorate([
+    (0, class_transformer_1.Transform)(schema_obj_to_class_1.schemaObjToInstance)
+], TypeSchema.prototype, "type", void 0);
 exports.TypeSchema = TypeSchema;
 //# sourceMappingURL=type.js.map

package/dist/schemas/type.js.map

@@ -1 +1 @@
-{"version":3,"file":"type.js","sourceRoot":"","sources":["../../schemas/type.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAG1B,MAAa,UAAU;IACrB,YAAoB,IAAY,EAAU,IAAgB,EAAU,SAAiB;QAAjE,SAAI,GAAJ,IAAI,CAAQ;QAAU,SAAI,GAAJ,IAAI,CAAY;QAAU,cAAS,GAAT,SAAS,CAAQ;IAAG,CAAC;IACzF,QAAQ;QACN,OAAO;YACL,eAAe,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;YACtC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAC1B,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC;IACJ,CAAC;IACD,QAAQ;QACN,OAAO,GAAG,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;IAC7D,CAAC;CACF;AAbD,gCAaC"}
+{"version":3,"file":"type.js","sourceRoot":"","sources":["../../schemas/type.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAA8C;AAC9C,kDAA0B;AAC1B,gDAAsD;AACtD,gEAA6D;AAE7D,MAAa,UAAW,SAAQ,wBAAU;IAGxC,YAAqB,QAAkB,EAAW,IAAY,EAAE,IAAgB,EAAW,SAAiB;QAC1G,KAAK,EAAE,CAAC;QADW,aAAQ,GAAR,QAAQ,CAAU;QAAW,SAAI,GAAJ,IAAI,CAAQ;QAA6B,cAAS,GAAT,SAAS,CAAQ;QAE1G,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,QAAQ;QACN,OAAO,GAAG,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;IAC7D,CAAC;CACF;AATC;IADC,IAAA,6BAAS,EAAC,yCAAmB,CAAC;wCACL;AAF5B,gCAWC"}

package/dist/schemas/variable.d.ts

@@ -1,17 +1,12 @@
-import { SchemaNode } from '../schema-node';
-export declare class VariableSchema implements SchemaNode {
+import { Location, SchemaNode } from '../schema-node';
+/**
+ * can be also a property.
+ */
+export declare class VariableSchema extends SchemaNode {
+    readonly location: Location;
     readonly name: string;
-    private signature;
-    private type;
-    constructor(name: string, signature: string, type: SchemaNode);
-    getSignature(): string;
-    toObject(): {
-        constructorName: string;
-        name: string;
-        signature: string;
-        type: Record<string, any> & {
-            constructorName: string;
-        };
-    };
+    readonly signature: string;
+    type: SchemaNode;
+    constructor(location: Location, name: string, signature: string, type: SchemaNode);
     toString(): string;
 }

package/dist/schemas/variable.js

@@ -1,30 +1,36 @@
 "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.VariableSchema = void 0;
+const class_transformer_1 = require("class-transformer");
 const chalk_1 = __importDefault(require("chalk"));
-class VariableSchema {
-    constructor(name, signature, type) {
+const schema_node_1 = require("../schema-node");
+const schema_obj_to_class_1 = require("../schema-obj-to-class");
+/**
+ * can be also a property.
+ */
+class VariableSchema extends schema_node_1.SchemaNode {
+    constructor(location, name, signature, type) {
+        super();
+        this.location = location;
         this.name = name;
         this.signature = signature;
         this.type = type;
     }
-    getSignature() {
-        return this.signature;
-    }
-    toObject() {
-        return {
-            constructorName: this.constructor.name,
-            name: this.name,
-            signature: this.signature,
-            type: this.type.toObject(),
-        };
-    }
     toString() {
         return `${chalk_1.default.bold(this.name)}: ${this.type.toString()}`;
     }
 }
+__decorate([
+    (0, class_transformer_1.Transform)(schema_obj_to_class_1.schemaObjToInstance)
+], VariableSchema.prototype, "type", void 0);
 exports.VariableSchema = VariableSchema;
 //# sourceMappingURL=variable.js.map

package/dist/schemas/variable.js.map

@@ -1 +1 @@
-{"version":3,"file":"variable.js","sourceRoot":"","sources":["../../schemas/variable.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAG1B,MAAa,cAAc;IACzB,YAAqB,IAAY,EAAU,SAAiB,EAAU,IAAgB;QAAjE,SAAI,GAAJ,IAAI,CAAQ;QAAU,cAAS,GAAT,SAAS,CAAQ;QAAU,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAC1F,YAAY;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,QAAQ;QACN,OAAO;YACL,eAAe,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;YACtC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;SAC3B,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,OAAO,GAAG,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;IAC7D,CAAC;CACF;AAlBD,wCAkBC"}
+{"version":3,"file":"variable.js","sourceRoot":"","sources":["../../schemas/variable.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAA8C;AAC9C,kDAA0B;AAC1B,gDAAsD;AACtD,gEAA6D;AAE7D;;GAEG;AACH,MAAa,cAAe,SAAQ,wBAAU;IAG5C,YAAqB,QAAkB,EAAW,IAAY,EAAW,SAAiB,EAAE,IAAgB;QAC1G,KAAK,EAAE,CAAC;QADW,aAAQ,GAAR,QAAQ,CAAU;QAAW,SAAI,GAAJ,IAAI,CAAQ;QAAW,cAAS,GAAT,SAAS,CAAQ;QAExF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,QAAQ;QACN,OAAO,GAAG,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;IAC7D,CAAC;CACF;AATC;IADC,IAAA,6BAAS,EAAC,yCAAmB,CAAC;4CACd;AAFnB,wCAWC"}

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

@@ -1,20 +1,17 @@
-import { SchemaNode } from '../schema-node';
-
 type Primitive = string | number | boolean | null | undefined;
 export type StaticProperties = Map<string, Primitive>;
 
-export 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 class Export {
   constructor(
     /**
      * named export identifier of the module export.
      */
     readonly identifier: string,
 
-    /**
-     * API node.
-     */
-    readonly nodes?: SchemaNode[],
-
     /**
      * static properties attached to this export
      * @example

package/index.ts

@@ -1,10 +1,9 @@
 export { APISchema } from './api-schema';
-export type { SchemaNode } from './schema-node';
+export { Export, StaticProperties } from './export';
+export type { SchemaNode, Location } from './schema-node';
 export {
-  Export,
   Module,
-  StaticProperties,
-  FunctionSchema,
+  FunctionLikeSchema,
   Modifier,
   TypeRefSchema,
   VariableSchema,
@@ -26,5 +25,9 @@ export {
   TypeOperatorSchema,
   TupleTypeSchema,
   ParameterSchema,
+  EnumSchema,
+  ParenthesizedTypeSchema,
+  TypePredicateSchema,
+  IndexedAccessSchema,
 } from './schemas';
 export type { JSONSchema, JSONSchemaObject } from './json-schema';

package/package.json

@@ -1,19 +1,22 @@
 {
   "name": "@teambit/semantics.entities.semantic-schema",
-  "version": "0.0.9",
+  "version": "0.0.12",
   "homepage": "https://bit.dev/teambit/semantics/entities/semantic-schema",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.semantics",
     "name": "entities/semantic-schema",
-    "version": "0.0.9"
+    "version": "0.0.12"
   },
   "dependencies": {
-    "chalk": "4.1.2",
-    "json-schema": "0.4.0"
+    "chalk": "2.4.2",
+    "class-transformer": "0.5.1",
+    "json-schema": "0.4.0",
+    "lodash": "4.17.21"
   },
   "devDependencies": {
     "@types/json-schema": "7.0.9",
+    "@types/lodash": "4.14.165",
     "@types/mocha": "9.1.0",
     "@babel/runtime": "7.12.18",
     "@types/node": "12.20.4",

package/{preview-1652498684867.js → preview-1653362849981.js}

@@ -1 +1 @@
-export const overview = [require('/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.semantics_entities_semantic-schema@0.0.9/dist/semantic-schema.docs.md')]
+export const overview = [require('/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.semantics_entities_semantic-schema@0.0.12/dist/semantic-schema.docs.md')]

package/schema-node.ts

@@ -1,10 +1,20 @@
+import { instanceToPlain } from 'class-transformer';
+
 /**
- * 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 {
-  getSignature?(): string;
+export abstract class SchemaNode {
+  readonly __schema = this.constructor.name;
+  abstract readonly location: Location;
+  readonly signature?: string;
 
-  toString(): string;
+  abstract toString(): string;
 
-  toObject(): Record<string, any> & { constructorName: string };
+  toObject() {
+    return instanceToPlain(this);
+  }
 }
+
+export type Location = { file: string; line: number; character: number };

package/schema-obj-to-class.ts

@@ -0,0 +1,36 @@
+import { plainToInstance, TransformationType, ClassConstructor } from 'class-transformer';
+import { compact } from 'lodash';
+import { SchemaNode } from './schema-node';
+import * as Schemas from './schemas';
+
+export function schemaObjArrayToInstances({ value, type }: { value: SchemaNode[]; type: TransformationType }) {
+  if (type !== TransformationType.PLAIN_TO_CLASS) {
+    return value;
+  }
+  return value.map((obj) => transformFromObjectToInstance(obj));
+}
+
+export function schemaObjToInstance({ value, type }: { value: Record<string, any>; type: TransformationType }) {
+  if (type !== TransformationType.PLAIN_TO_CLASS) {
+    return value;
+  }
+  return transformFromObjectToInstance(value);
+}
+
+function transformFromObjectToInstance(obj: Record<string, any>): SchemaNode {
+  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 plainToInstance(SchemaClass, obj);
+}
+
+function getClassBySchemaName(schemaName: string): ClassConstructor<SchemaNode> {
+  const schemasClasses = 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;
+}

package/schemas/class.ts

@@ -1,15 +1,14 @@
+import { Transform } from 'class-transformer';
 import chalk from 'chalk';
-import { SchemaNode } from '../schema-node';
+import { Location, SchemaNode } from '../schema-node';
+import { schemaObjArrayToInstances } from '../schema-obj-to-class';
 
-export class ClassSchema implements SchemaNode {
-  constructor(readonly className: string, readonly members: SchemaNode[]) {}
-
-  toObject() {
-    return {
-      constructorName: this.constructor.name,
-      name: this.className,
-      members: this.members.map((member) => member.toObject()),
-    };
+export class ClassSchema extends SchemaNode {
+  @Transform(schemaObjArrayToInstances)
+  readonly members: SchemaNode[];
+  constructor(readonly className: string, members: SchemaNode[], readonly location: Location) {
+    super();
+    this.members = members;
   }
 
   toString() {

package/schemas/constructor.ts

@@ -1,19 +1,19 @@
+import { Transform } from 'class-transformer';
 import chalk from 'chalk';
-import { SchemaNode } from '../schema-node';
+import { Location, SchemaNode } from '../schema-node';
 import { ParameterSchema } from './parameter';
+import { schemaObjArrayToInstances } from '../schema-obj-to-class';
 
-export class ConstructorSchema implements SchemaNode {
-  constructor(readonly params: ParameterSchema[]) {}
+export class ConstructorSchema extends SchemaNode {
+  @Transform(schemaObjArrayToInstances)
+  readonly params: ParameterSchema[];
+  constructor(readonly location: Location, params: ParameterSchema[]) {
+    super();
+    this.params = params;
+  }
 
   toString() {
     const paramsStr = this.params.map((param) => param.toString()).join(', ');
     return `${chalk.bold('constructor')}(${paramsStr})`;
   }
-
-  toObject() {
-    return {
-      constructorName: this.constructor.name,
-      args: this.params.map((arg) => arg.toObject()),
-    };
-  }
 }

package/schemas/enum.ts

@@ -0,0 +1,13 @@
+import chalk from 'chalk';
+import { Location, SchemaNode } from '../schema-node';
+
+export class EnumSchema extends SchemaNode {
+  constructor(readonly location: Location, readonly name: string, readonly members: string[]) {
+    super();
+  }
+
+  toString() {
+    const membersStr = this.members.map((m) => `* ${m.toString()}`).join('\n');
+    return `${chalk.bold.underline(this.name)}\n${membersStr}`;
+  }
+}