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

package/schemas/type-ref.ts

@@ -1,6 +1,8 @@
+import { Transform } from 'class-transformer';
 import { ComponentID } from '@teambit/component';
 import chalk from 'chalk';
-import { SchemaNode } from '../schema-node';
+import { Location, SchemaNode } from '../schema-node';
+import { schemaObjArrayToInstances } from '../schema-obj-to-class';
 
 export type PlainTypeRefSchema = {
   name: string;
@@ -8,8 +10,21 @@ export type PlainTypeRefSchema = {
   packageName?: string;
 };
 
-export 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 class TypeRefSchema extends SchemaNode {
+  @Transform(schemaObjArrayToInstances)
+  /**
+   *  optional type arguments, e.g. type Foo = Bar<X, Y>. The X and Y are type arguments.
+   */
+  typeArgs?: SchemaNode[];
+
   constructor(
+    readonly location: Location,
     /**
      * name of the reference to type.
      */
@@ -24,23 +39,27 @@ export class TypeRefSchema implements SchemaNode {
      * target package name. existing if type is defined in different package.
      */
     readonly packageName?: string
-  ) {}
-
-  toObject() {
-    return {
-      constructorName: this.constructor.name,
-      name: this.name,
-      componentId: this.componentId,
-      packageName: this.packageName,
-    };
+  ) {
+    super();
   }
 
   toString() {
+    const name = this.nameToString();
+    if (!this.typeArgs) {
+      return name;
+    }
+    const args = this.typeArgs.map((arg) => arg.toString()).join(', ');
+    return `${name}<${args}>`;
+  }
+
+  private nameToString() {
     if (this.componentId) {
-      return `${this.componentId}/${this.name}`;
+      const compStr = chalk.dim(`(component: ${this.componentId.toStringWithoutVersion()})`);
+      return `${compStr} ${this.name}`;
     }
     if (this.packageName) {
-      return `${chalk.dim(this.packageName)}/${this.name}`;
+      const pkgStr = chalk.dim(`(package: ${this.packageName})`);
+      return `${pkgStr} ${this.name}`;
     }
     return this.name;
   }
@@ -52,11 +71,11 @@ export class TypeRefSchema implements SchemaNode {
     return !this.componentId && !this.packageName;
   }
 
-  static from(plainSchema: PlainTypeRefSchema) {
-    return new TypeRefSchema(
-      plainSchema.name,
-      plainSchema.componentId ? ComponentID.fromString(plainSchema.componentId) : undefined,
-      plainSchema.packageName
-    );
-  }
+  // static from(plainSchema: PlainTypeRefSchema) {
+  //   return new TypeRefSchema(
+  //     plainSchema.name,
+  //     plainSchema.componentId ? ComponentID.fromString(plainSchema.componentId) : undefined,
+  //     plainSchema.packageName
+  //   );
+  // }
 }

package/schemas/type-union.ts

@@ -1,12 +1,13 @@
-import { SchemaNode } from '../schema-node';
+import { Transform } from 'class-transformer';
+import { Location, SchemaNode } from '../schema-node';
+import { schemaObjArrayToInstances } from '../schema-obj-to-class';
 
-export class TypeUnionSchema implements SchemaNode {
-  constructor(private types: SchemaNode[]) {}
-  toObject() {
-    return {
-      constructorName: this.constructor.name,
-      types: this.types.map((type) => type.toObject()),
-    };
+export class TypeUnionSchema extends SchemaNode {
+  @Transform(schemaObjArrayToInstances)
+  readonly types: SchemaNode[];
+  constructor(readonly location: Location, types: SchemaNode[]) {
+    super();
+    this.types = types;
   }
   toString() {
     return `${this.types.map((type) => type.toString()).join(' | ')}`;

package/schemas/type.ts

@@ -1,16 +1,16 @@
+import { Transform } from 'class-transformer';
 import chalk from 'chalk';
-import { SchemaNode } from '../schema-node';
+import { Location, SchemaNode } from '../schema-node';
+import { schemaObjToInstance } from '../schema-obj-to-class';
 
-export class TypeSchema implements SchemaNode {
-  constructor(private name: string, private type: SchemaNode, private signature: string) {}
-  toObject() {
-    return {
-      constructorName: this.constructor.name,
-      name: this.name,
-      type: this.type.toObject(),
-      signature: this.signature,
-    };
+export class TypeSchema extends SchemaNode {
+  @Transform(schemaObjToInstance)
+  readonly type: SchemaNode;
+  constructor(readonly location: Location, readonly name: string, type: SchemaNode, readonly signature: string) {
+    super();
+    this.type = type;
   }
+
   toString() {
     return `${chalk.bold(this.name)}: ${this.type.toString()}`;
   }

package/schemas/variable.ts

@@ -1,19 +1,17 @@
+import { Transform } from 'class-transformer';
 import chalk from 'chalk';
-import { SchemaNode } from '../schema-node';
+import { Location, SchemaNode } from '../schema-node';
+import { schemaObjToInstance } from '../schema-obj-to-class';
 
-export class VariableSchema implements SchemaNode {
-  constructor(readonly name: string, private signature: string, private type: SchemaNode) {}
-  getSignature() {
-    return this.signature;
-  }
-
-  toObject() {
-    return {
-      constructorName: this.constructor.name,
-      name: this.name,
-      signature: this.signature,
-      type: this.type.toObject(),
-    };
+/**
+ * can be also a property.
+ */
+export class VariableSchema extends SchemaNode {
+  @Transform(schemaObjToInstance)
+  type: SchemaNode;
+  constructor(readonly location: Location, readonly name: string, readonly signature: string, type: SchemaNode) {
+    super();
+    this.type = type;
   }
 
   toString() {

package/tsconfig.json

@@ -14,6 +14,7 @@
     "declaration": true,
     "sourceMap": true,
     "skipLibCheck": true,
+    "experimentalDecorators": true,
     "outDir": "dist",
     "moduleResolution": "node",
     "esModuleInterop": true,

package/dist/schemas/export.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"export.js","sourceRoot":"","sources":["../../schemas/export.ts"],"names":[],"mappings":";;;AAKA,MAAa,MAAM;IACjB;IACE;;OAEG;IACM,UAAkB;IAE3B;;OAEG;IACM,KAAoB;IAE7B;;;;;;OAMG;IACM,gBAAmC;QAdnC,eAAU,GAAV,UAAU,CAAQ;QAKlB,UAAK,GAAL,KAAK,CAAe;QASpB,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;AA5BD,wBA4BC"}