@teambit/semantics.entities.semantic-schema 0.0.18 → 0.0.21

package/api-schema.ts

@@ -9,7 +9,8 @@ import {
   Module,
   TypeRefSchema,
   TypeSchema,
-  VariableSchema,
+  UnresolvedSchema,
+  VariableLikeSchema,
 } from './schemas';
 import { Location, SchemaNode } from './schema-node';
 import { schemaObjToInstance } from './class-transformers';
@@ -53,10 +54,11 @@ export class APISchema extends SchemaNode {
       getSection(ClassSchema, 'Classes') +
       getSection(InterfaceSchema, 'Interfaces') +
       getSection(FunctionLikeSchema, 'Functions') +
-      getSection(VariableSchema, 'Variables') +
+      getSection(VariableLikeSchema, 'Variables') +
       getSection(TypeSchema, 'Types') +
       getSection(EnumSchema, 'Enums') +
-      getSection(TypeRefSchema, 'TypeReferences')
+      getSection(TypeRefSchema, 'TypeReferences') +
+      getSection(UnresolvedSchema, 'Unresolved')
     );
   }
 

package/class-transformers/schema-obj-to-class.ts

@@ -2,6 +2,7 @@ import { plainToInstance, TransformationType, ClassConstructor } from 'class-tra
 import { compact } from 'lodash';
 import { SchemaNode } from '../schema-node';
 import * as Schemas from '../schemas';
+import { UnknownSchema } from '../schemas/unknown-schema';
 
 export function schemaObjArrayToInstances({ value, type }: { value: SchemaNode[]; type: TransformationType }) {
   if (type !== TransformationType.PLAIN_TO_CLASS) {
@@ -31,15 +32,18 @@ function transformFromObjectToInstance(obj: Record<string, any>): SchemaNode {
     throw new Error(`fatal: "__schema" is missing, make sure the transformer is set on SchemaNode type`);
   }
   const SchemaClass = getClassBySchemaName(obj.__schema);
+  if (!SchemaClass) {
+    // for backward and forward compatibility, to not break the users, it's better to return an unknown schema than throwing.
+    return new UnknownSchema(obj.location || { path: '', line: 0, character: 0 }, obj.__schema, obj);
+  }
   return plainToInstance(SchemaClass, obj);
 }
 
-function getClassBySchemaName(schemaName: string): ClassConstructor<SchemaNode> {
+function getClassBySchemaName(schemaName: string): ClassConstructor<SchemaNode> | null {
   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 null;
   }
   return schemaClass;
 }

package/dist/api-schema.js

@@ -40,10 +40,11 @@ class APISchema extends schema_node_1.SchemaNode {
             getSection(schemas_1.ClassSchema, 'Classes') +
             getSection(schemas_1.InterfaceSchema, 'Interfaces') +
             getSection(schemas_1.FunctionLikeSchema, 'Functions') +
-            getSection(schemas_1.VariableSchema, 'Variables') +
+            getSection(schemas_1.VariableLikeSchema, 'Variables') +
             getSection(schemas_1.TypeSchema, 'Types') +
             getSection(schemas_1.EnumSchema, 'Enums') +
-            getSection(schemas_1.TypeRefSchema, 'TypeReferences'));
+            getSection(schemas_1.TypeRefSchema, 'TypeReferences') +
+            getSection(schemas_1.UnresolvedSchema, 'Unresolved'));
     }
     listSignatures() {
         return this.module.exports.map((exp) => exp.signature);

package/dist/api-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"api-schema.js","sourceRoot":"","sources":["../api-schema.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAA+D;AAC/D,kDAA0B;AAE1B,uCASmB;AACnB,+CAAqD;AACrD,6DAA2D;AAC3D,kFAAkF;AAElF,MAAa,SAAU,SAAQ,wBAAU;IAOvC,YAAqB,QAAkB,EAAE,MAAc,EAAE,WAAwB;QAC/E,KAAK,EAAE,CAAC;QADW,aAAQ,GAAR,QAAQ,CAAU;QAErC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,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,KAAK,GAAG,eAAK,CAAC,OAAO,CAAC,iBAAiB,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC9E,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,KAAK;YACL,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;YAC/B,UAAU,CAAC,uBAAa,EAAE,gBAAgB,CAAC,CAC5C,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;AAlDC;IADC,IAAA,6BAAS,EAAC,wCAAmB,CAAC;yCACP;AAGxB;IADC,IAAA,6BAAS,EAAC,4CAAsB,CAAC;8CACA;AALpC,8BAoDC"}
+{"version":3,"file":"api-schema.js","sourceRoot":"","sources":["../api-schema.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAA+D;AAC/D,kDAA0B;AAE1B,uCAUmB;AACnB,+CAAqD;AACrD,6DAA2D;AAC3D,kFAAkF;AAElF,MAAa,SAAU,SAAQ,wBAAU;IAOvC,YAAqB,QAAkB,EAAE,MAAc,EAAE,WAAwB;QAC/E,KAAK,EAAE,CAAC;QADW,aAAQ,GAAR,QAAQ,CAAU;QAErC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,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,KAAK,GAAG,eAAK,CAAC,OAAO,CAAC,iBAAiB,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC9E,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,KAAK;YACL,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,4BAAkB,EAAE,WAAW,CAAC;YAC3C,UAAU,CAAC,oBAAU,EAAE,OAAO,CAAC;YAC/B,UAAU,CAAC,oBAAU,EAAE,OAAO,CAAC;YAC/B,UAAU,CAAC,uBAAa,EAAE,gBAAgB,CAAC;YAC3C,UAAU,CAAC,0BAAgB,EAAE,YAAY,CAAC,CAC3C,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;AAnDC;IADC,IAAA,6BAAS,EAAC,wCAAmB,CAAC;yCACP;AAGxB;IADC,IAAA,6BAAS,EAAC,4CAAsB,CAAC;8CACA;AALpC,8BAqDC"}

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

@@ -23,6 +23,7 @@ exports.schemaObjToInstance = exports.schemaObjArrayToInstances = void 0;
 const class_transformer_1 = require("class-transformer");
 const lodash_1 = require("lodash");
 const Schemas = __importStar(require("../schemas"));
+const unknown_schema_1 = require("../schemas/unknown-schema");
 function schemaObjArrayToInstances({ value, type }) {
     if (type !== class_transformer_1.TransformationType.PLAIN_TO_CLASS) {
         return value;
@@ -45,14 +46,17 @@ function transformFromObjectToInstance(obj) {
         throw new Error(`fatal: "__schema" is missing, make sure the transformer is set on SchemaNode type`);
     }
     const SchemaClass = getClassBySchemaName(obj.__schema);
+    if (!SchemaClass) {
+        // for backward and forward compatibility, to not break the users, it's better to return an unknown schema than throwing.
+        return new unknown_schema_1.UnknownSchema(obj.location || { path: '', line: 0, character: 0 }, obj.__schema, obj);
+    }
     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 null;
     }
     return schemaClass;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"schema-obj-to-class.js","sourceRoot":"","sources":["../../class-transformers/schema-obj-to-class.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,yDAA0F;AAC1F,mCAAiC;AAEjC,oDAAsC;AAEtC,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,EAClC,KAAK,EACL,IAAI,GAIL;IACC,IAAI,IAAI,KAAK,sCAAkB,CAAC,cAAc,EAAE;QAC9C,OAAO,KAAK,CAAC;KACd;IACD,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,SAAS,CAAC;KAClB;IACD,OAAO,6BAA6B,CAAC,KAAK,CAAC,CAAC;AAC9C,CAAC;AAdD,kDAcC;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"}
+{"version":3,"file":"schema-obj-to-class.js","sourceRoot":"","sources":["../../class-transformers/schema-obj-to-class.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,yDAA0F;AAC1F,mCAAiC;AAEjC,oDAAsC;AACtC,8DAA0D;AAE1D,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,EAClC,KAAK,EACL,IAAI,GAIL;IACC,IAAI,IAAI,KAAK,sCAAkB,CAAC,cAAc,EAAE;QAC9C,OAAO,KAAK,CAAC;KACd;IACD,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,SAAS,CAAC;KAClB;IACD,OAAO,6BAA6B,CAAC,KAAK,CAAC,CAAC;AAC9C,CAAC;AAdD,kDAcC;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,IAAI,CAAC,WAAW,EAAE;QAChB,yHAAyH;QACzH,OAAO,IAAI,8BAAa,CAAC,GAAG,CAAC,QAAQ,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;KAClG;IACD,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,OAAO,IAAI,CAAC;KACb;IACD,OAAO,WAAW,CAAC;AACrB,CAAC"}

package/dist/schema-node.d.ts

@@ -13,7 +13,10 @@ export declare abstract class SchemaNode {
     toObject(): Record<string, any>;
 }
 export declare type Location = {
-    file: string;
+    /**
+     * file-path relative to the component root-dir. normalized to Linux.
+     */
+    filePath: string;
     line: number;
     character: number;
 };

package/dist/schemas/docs/doc.d.ts

@@ -2,9 +2,10 @@ import { Location, SchemaNode } from '../../schema-node';
 import { TagName, TagSchema } from './tag';
 export declare class DocSchema extends SchemaNode {
     readonly location: Location;
+    readonly raw: string;
     readonly comment?: string;
     readonly tags?: TagSchema[];
-    constructor(location: Location, comment?: string, tags?: TagSchema[]);
+    constructor(location: Location, raw: string, comment?: string, tags?: TagSchema[]);
     toString(): string;
     hasTag(tagName: TagName): boolean;
     findTag(tagName: TagName): TagSchema;

package/dist/schemas/docs/doc.js

@@ -11,9 +11,10 @@ const class_transformer_1 = require("class-transformer");
 const class_transformers_1 = require("../../class-transformers");
 const schema_node_1 = require("../../schema-node");
 class DocSchema extends schema_node_1.SchemaNode {
-    constructor(location, comment, tags) {
+    constructor(location, raw, comment, tags) {
         super();
         this.location = location;
+        this.raw = raw;
         this.comment = comment;
         this.tags = tags;
     }

package/dist/schemas/docs/doc.js.map

@@ -1 +1 @@
-{"version":3,"file":"doc.js","sourceRoot":"","sources":["../../../schemas/docs/doc.ts"],"names":[],"mappings":";;;;;;;;;AAAA,yDAA8C;AAC9C,iEAAqE;AACrE,mDAAyD;AAGzD,MAAa,SAAU,SAAQ,wBAAU;IAGvC,YAAqB,QAAkB,EAAW,OAAgB,EAAE,IAAkB;QACpF,KAAK,EAAE,CAAC;QADW,aAAQ,GAAR,QAAQ,CAAU;QAAW,YAAO,GAAP,OAAO,CAAS;QAEhE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,QAAQ;QACN,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACxD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAChF,OAAO,GAAG,OAAO,GAAG,IAAI,EAAE,CAAC;IAC7B,CAAC;IAED,MAAM,CAAC,OAAgB;QACrB,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IACxC,CAAC;IAED,OAAO,CAAC,OAAgB;;QACtB,OAAO,MAAA,IAAI,CAAC,IAAI,0CAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAnBC;IADC,IAAA,6BAAS,EAAC,8CAAyB,CAAC;uCACT;AAF9B,8BAqBC"}
+{"version":3,"file":"doc.js","sourceRoot":"","sources":["../../../schemas/docs/doc.ts"],"names":[],"mappings":";;;;;;;;;AAAA,yDAA8C;AAC9C,iEAAqE;AACrE,mDAAyD;AAGzD,MAAa,SAAU,SAAQ,wBAAU;IAGvC,YAAqB,QAAkB,EAAW,GAAW,EAAW,OAAgB,EAAE,IAAkB;QAC1G,KAAK,EAAE,CAAC;QADW,aAAQ,GAAR,QAAQ,CAAU;QAAW,QAAG,GAAH,GAAG,CAAQ;QAAW,YAAO,GAAP,OAAO,CAAS;QAEtF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,QAAQ;QACN,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACxD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAChF,OAAO,GAAG,OAAO,GAAG,IAAI,EAAE,CAAC;IAC7B,CAAC;IAED,MAAM,CAAC,OAAgB;QACrB,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IACxC,CAAC;IAED,OAAO,CAAC,OAAgB;;QACtB,OAAO,MAAA,IAAI,CAAC,IAAI,0CAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAnBC;IADC,IAAA,6BAAS,EAAC,8CAAyB,CAAC;uCACT;AAF9B,8BAqBC"}

package/dist/schemas/docs/index.d.ts

@@ -1,3 +1,4 @@
 export { DocSchema } from './doc';
 export { TagSchema } from './tag';
 export { ReturnTagSchema } from './return-tag';
+export { PropertyLikeTagSchema } from './property-like-tag';

package/dist/schemas/docs/index.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReturnTagSchema = exports.TagSchema = exports.DocSchema = void 0;
+exports.PropertyLikeTagSchema = exports.ReturnTagSchema = exports.TagSchema = exports.DocSchema = void 0;
 var doc_1 = require("./doc");
 Object.defineProperty(exports, "DocSchema", { enumerable: true, get: function () { return doc_1.DocSchema; } });
 var tag_1 = require("./tag");
 Object.defineProperty(exports, "TagSchema", { enumerable: true, get: function () { return tag_1.TagSchema; } });
 var return_tag_1 = require("./return-tag");
 Object.defineProperty(exports, "ReturnTagSchema", { enumerable: true, get: function () { return return_tag_1.ReturnTagSchema; } });
+var property_like_tag_1 = require("./property-like-tag");
+Object.defineProperty(exports, "PropertyLikeTagSchema", { enumerable: true, get: function () { return property_like_tag_1.PropertyLikeTagSchema; } });
 //# sourceMappingURL=index.js.map

package/dist/schemas/docs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../schemas/docs/index.ts"],"names":[],"mappings":";;;AAAA,6BAAkC;AAAzB,gGAAA,SAAS,OAAA;AAClB,6BAAkC;AAAzB,gGAAA,SAAS,OAAA;AAClB,2CAA+C;AAAtC,6GAAA,eAAe,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../schemas/docs/index.ts"],"names":[],"mappings":";;;AAAA,6BAAkC;AAAzB,gGAAA,SAAS,OAAA;AAClB,6BAAkC;AAAzB,gGAAA,SAAS,OAAA;AAClB,2CAA+C;AAAtC,6GAAA,eAAe,OAAA;AACxB,yDAA4D;AAAnD,0HAAA,qBAAqB,OAAA"}

package/dist/schemas/docs/property-like-tag.d.ts

@@ -0,0 +1,13 @@
+import { Location, SchemaNode } from '../../schema-node';
+import { TagSchema } from './tag';
+/**
+ * e.g. `@param myParam {string} some comment`
+ */
+export declare class PropertyLikeTagSchema extends TagSchema {
+    readonly location: Location;
+    readonly paramName: string;
+    readonly comment?: string;
+    readonly type?: SchemaNode;
+    constructor(location: Location, paramName: string, comment?: string, type?: SchemaNode);
+    toString(): string;
+}

package/dist/schemas/docs/property-like-tag.js

@@ -0,0 +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.PropertyLikeTagSchema = void 0;
+const class_transformer_1 = require("class-transformer");
+const tag_1 = require("./tag");
+const class_transformers_1 = require("../../class-transformers");
+/**
+ * e.g. `@param myParam {string} some comment`
+ */
+class PropertyLikeTagSchema extends tag_1.TagSchema {
+    constructor(location, paramName, comment, type) {
+        super(location, tag_1.TagName.parameter, comment);
+        this.location = location;
+        this.paramName = paramName;
+        this.comment = comment;
+        this.type = type;
+    }
+    toString() {
+        const comment = this.comment ? ` ${this.comment}` : '';
+        const type = this.type ? ` {${this.type.toString()}} ` : '';
+        return `@${this.tagName} ${this.paramName}${type} ${comment}`;
+    }
+}
+__decorate([
+    (0, class_transformer_1.Transform)(class_transformers_1.schemaObjToInstance)
+], PropertyLikeTagSchema.prototype, "type", void 0);
+exports.PropertyLikeTagSchema = PropertyLikeTagSchema;
+//# sourceMappingURL=property-like-tag.js.map

package/dist/schemas/docs/property-like-tag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"property-like-tag.js","sourceRoot":"","sources":["../../../schemas/docs/property-like-tag.ts"],"names":[],"mappings":";;;;;;;;;AAAA,yDAA8C;AAE9C,+BAA2C;AAC3C,iEAA+D;AAE/D;;GAEG;AACH,MAAa,qBAAsB,SAAQ,eAAS;IAGlD,YAAqB,QAAkB,EAAW,SAAiB,EAAW,OAAgB,EAAE,IAAiB;QAC/G,KAAK,CAAC,QAAQ,EAAE,aAAO,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QADzB,aAAQ,GAAR,QAAQ,CAAU;QAAW,cAAS,GAAT,SAAS,CAAQ;QAAW,YAAO,GAAP,OAAO,CAAS;QAE5F,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,QAAQ;QACN,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5D,OAAO,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,OAAO,EAAE,CAAC;IAChE,CAAC;CACF;AAXC;IADC,IAAA,6BAAS,EAAC,wCAAmB,CAAC;mDACJ;AAF7B,sDAaC"}

package/dist/schemas/docs/return-tag.d.ts

@@ -1,13 +1,12 @@
 import { Location, SchemaNode } from '../../schema-node';
-import { TagName, TagSchema } from './tag';
+import { TagSchema } from './tag';
 /**
  * e.g. `@return {string} some comment`
  */
 export declare class ReturnTagSchema extends TagSchema {
     readonly location: Location;
-    readonly tagName: TagName;
     readonly comment?: string;
     readonly type?: SchemaNode;
-    constructor(location: Location, tagName?: TagName, comment?: string, type?: SchemaNode);
+    constructor(location: Location, comment?: string, type?: SchemaNode);
     toString(): string;
 }

package/dist/schemas/docs/return-tag.js

@@ -1,15 +1,22 @@
 "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.ReturnTagSchema = void 0;
+const class_transformer_1 = require("class-transformer");
 const tag_1 = require("./tag");
+const class_transformers_1 = require("../../class-transformers");
 /**
  * e.g. `@return {string} some comment`
  */
 class ReturnTagSchema extends tag_1.TagSchema {
-    constructor(location, tagName = tag_1.TagName.return, comment, type) {
-        super(location, tagName, comment);
+    constructor(location, comment, type) {
+        super(location, tag_1.TagName.return, comment);
         this.location = location;
-        this.tagName = tagName;
         this.comment = comment;
         this.type = type;
     }
@@ -18,5 +25,8 @@ class ReturnTagSchema extends tag_1.TagSchema {
         return `@${this.tagName}${comment}`;
     }
 }
+__decorate([
+    (0, class_transformer_1.Transform)(class_transformers_1.schemaObjToInstance)
+], ReturnTagSchema.prototype, "type", void 0);
 exports.ReturnTagSchema = ReturnTagSchema;
 //# sourceMappingURL=return-tag.js.map

package/dist/schemas/docs/return-tag.js.map

@@ -1 +1 @@
-{"version":3,"file":"return-tag.js","sourceRoot":"","sources":["../../../schemas/docs/return-tag.ts"],"names":[],"mappings":";;;AACA,+BAA2C;AAE3C;;GAEG;AACH,MAAa,eAAgB,SAAQ,eAAS;IAC5C,YACW,QAAkB,EAClB,UAAU,aAAO,CAAC,MAAM,EACxB,OAAgB,EAChB,IAAiB;QAE1B,KAAK,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QALzB,aAAQ,GAAR,QAAQ,CAAU;QAClB,YAAO,GAAP,OAAO,CAAiB;QACxB,YAAO,GAAP,OAAO,CAAS;QAChB,SAAI,GAAJ,IAAI,CAAa;IAG5B,CAAC;IAED,QAAQ;QACN,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvD,OAAO,IAAI,IAAI,CAAC,OAAO,GAAG,OAAO,EAAE,CAAC;IACtC,CAAC;CACF;AAdD,0CAcC"}
+{"version":3,"file":"return-tag.js","sourceRoot":"","sources":["../../../schemas/docs/return-tag.ts"],"names":[],"mappings":";;;;;;;;;AAAA,yDAA8C;AAE9C,+BAA2C;AAC3C,iEAA+D;AAE/D;;GAEG;AACH,MAAa,eAAgB,SAAQ,eAAS;IAG5C,YAAqB,QAAkB,EAAW,OAAgB,EAAE,IAAiB;QACnF,KAAK,CAAC,QAAQ,EAAE,aAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QADtB,aAAQ,GAAR,QAAQ,CAAU;QAAW,YAAO,GAAP,OAAO,CAAS;QAEhE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,QAAQ;QACN,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvD,OAAO,IAAI,IAAI,CAAC,OAAO,GAAG,OAAO,EAAE,CAAC;IACtC,CAAC;CACF;AAVC;IADC,IAAA,6BAAS,EAAC,wCAAmB,CAAC;6CACJ;AAF7B,0CAYC"}

package/dist/schemas/index.d.ts

@@ -1,7 +1,7 @@
 export { Module } from './module';
 export { FunctionLikeSchema, Modifier } from './function-like';
 export { TypeRefSchema } from './type-ref';
-export { VariableSchema } from './variable';
+export { VariableLikeSchema } from './variable-like';
 export { ClassSchema } from './class';
 export { ConstructorSchema } from './constructor';
 export { TypeSchema } from './type';
@@ -27,4 +27,6 @@ export { IndexedAccessSchema } from './indexed-access-type';
 export { TemplateLiteralTypeSchema } from './template-literal-type';
 export { TemplateLiteralTypeSpanSchema } from './template-literal-type-span';
 export { ThisTypeSchema } from './this-type';
+export { UnknownSchema } from './unknown-schema';
+export { UnresolvedSchema } from './unresolved-schema';
 export * from './docs';

package/dist/schemas/index.js

@@ -10,15 +10,15 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ThisTypeSchema = exports.TemplateLiteralTypeSpanSchema = exports.TemplateLiteralTypeSchema = 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 = void 0;
+exports.UnresolvedSchema = exports.UnknownSchema = exports.ThisTypeSchema = exports.TemplateLiteralTypeSpanSchema = exports.TemplateLiteralTypeSchema = 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.VariableLikeSchema = exports.TypeRefSchema = exports.FunctionLikeSchema = exports.Module = void 0;
 var module_1 = require("./module");
 Object.defineProperty(exports, "Module", { enumerable: true, get: function () { return module_1.Module; } });
 var function_like_1 = require("./function-like");
 Object.defineProperty(exports, "FunctionLikeSchema", { enumerable: true, get: function () { return function_like_1.FunctionLikeSchema; } });
 var type_ref_1 = require("./type-ref");
 Object.defineProperty(exports, "TypeRefSchema", { enumerable: true, get: function () { return type_ref_1.TypeRefSchema; } });
-var variable_1 = require("./variable");
-Object.defineProperty(exports, "VariableSchema", { enumerable: true, get: function () { return variable_1.VariableSchema; } });
+var variable_like_1 = require("./variable-like");
+Object.defineProperty(exports, "VariableLikeSchema", { enumerable: true, get: function () { return variable_like_1.VariableLikeSchema; } });
 var class_1 = require("./class");
 Object.defineProperty(exports, "ClassSchema", { enumerable: true, get: function () { return class_1.ClassSchema; } });
 var constructor_1 = require("./constructor");
@@ -69,5 +69,9 @@ var template_literal_type_span_1 = require("./template-literal-type-span");
 Object.defineProperty(exports, "TemplateLiteralTypeSpanSchema", { enumerable: true, get: function () { return template_literal_type_span_1.TemplateLiteralTypeSpanSchema; } });
 var this_type_1 = require("./this-type");
 Object.defineProperty(exports, "ThisTypeSchema", { enumerable: true, get: function () { return this_type_1.ThisTypeSchema; } });
+var unknown_schema_1 = require("./unknown-schema");
+Object.defineProperty(exports, "UnknownSchema", { enumerable: true, get: function () { return unknown_schema_1.UnknownSchema; } });
+var unresolved_schema_1 = require("./unresolved-schema");
+Object.defineProperty(exports, "UnresolvedSchema", { enumerable: true, get: function () { return unresolved_schema_1.UnresolvedSchema; } });
 __exportStar(require("./docs"), exports);
 //# sourceMappingURL=index.js.map

package/dist/schemas/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../schemas/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,mCAAkC;AAAzB,gGAAA,MAAM,OAAA;AACf,iDAA+D;AAAtD,mHAAA,kBAAkB,OAAA;AAC3B,uCAA2C;AAAlC,yGAAA,aAAa,OAAA;AACtB,uCAA4C;AAAnC,0GAAA,cAAc,OAAA;AACvB,iCAAsC;AAA7B,oGAAA,WAAW,OAAA;AACpB,6CAAkD;AAAzC,gHAAA,iBAAiB,OAAA;AAC1B,+BAAoC;AAA3B,kGAAA,UAAU,OAAA;AACnB,yDAA6D;AAApD,2HAAA,sBAAsB,OAAA;AAC/B,2CAA+C;AAAtC,6GAAA,eAAe,OAAA;AACxB,+CAAmD;AAA1C,iHAAA,iBAAiB,OAAA;AAC1B,qDAAyD;AAAhD,uHAAA,oBAAoB,OAAA;AAC7B,yCAA8C;AAArC,4GAAA,eAAe,OAAA;AACxB,+CAAmD;AAA1C,iHAAA,iBAAiB,OAAA;AAC1B,+CAAmD;AAA1C,iHAAA,iBAAiB,OAAA;AAC1B,2CAA+C;AAAtC,6GAAA,eAAe,OAAA;AACxB,mDAAuD;AAA9C,qHAAA,mBAAmB,OAAA;AAC5B,+CAAmD;AAA1C,iHAAA,iBAAiB,OAAA;AAC1B,+CAAmD;AAA1C,iHAAA,iBAAiB,OAAA;AAC1B,2CAA+C;AAAtC,6GAAA,eAAe,OAAA;AACxB,iDAAqD;AAA5C,mHAAA,kBAAkB,OAAA;AAC3B,2CAA+C;AAAtC,6GAAA,eAAe,OAAA;AACxB,yCAA8C;AAArC,4GAAA,eAAe,OAAA;AACxB,+BAAoC;AAA3B,kGAAA,UAAU,OAAA;AACnB,2DAA+D;AAAtD,6HAAA,uBAAuB,OAAA;AAChC,mDAAuD;AAA9C,qHAAA,mBAAmB,OAAA;AAC5B,6DAA4D;AAAnD,0HAAA,mBAAmB,OAAA;AAC5B,iEAAoE;AAA3D,kIAAA,yBAAyB,OAAA;AAClC,2EAA6E;AAApE,2IAAA,6BAA6B,OAAA;AACtC,yCAA6C;AAApC,2GAAA,cAAc,OAAA;AACvB,yCAAuB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../schemas/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,mCAAkC;AAAzB,gGAAA,MAAM,OAAA;AACf,iDAA+D;AAAtD,mHAAA,kBAAkB,OAAA;AAC3B,uCAA2C;AAAlC,yGAAA,aAAa,OAAA;AACtB,iDAAqD;AAA5C,mHAAA,kBAAkB,OAAA;AAC3B,iCAAsC;AAA7B,oGAAA,WAAW,OAAA;AACpB,6CAAkD;AAAzC,gHAAA,iBAAiB,OAAA;AAC1B,+BAAoC;AAA3B,kGAAA,UAAU,OAAA;AACnB,yDAA6D;AAApD,2HAAA,sBAAsB,OAAA;AAC/B,2CAA+C;AAAtC,6GAAA,eAAe,OAAA;AACxB,+CAAmD;AAA1C,iHAAA,iBAAiB,OAAA;AAC1B,qDAAyD;AAAhD,uHAAA,oBAAoB,OAAA;AAC7B,yCAA8C;AAArC,4GAAA,eAAe,OAAA;AACxB,+CAAmD;AAA1C,iHAAA,iBAAiB,OAAA;AAC1B,+CAAmD;AAA1C,iHAAA,iBAAiB,OAAA;AAC1B,2CAA+C;AAAtC,6GAAA,eAAe,OAAA;AACxB,mDAAuD;AAA9C,qHAAA,mBAAmB,OAAA;AAC5B,+CAAmD;AAA1C,iHAAA,iBAAiB,OAAA;AAC1B,+CAAmD;AAA1C,iHAAA,iBAAiB,OAAA;AAC1B,2CAA+C;AAAtC,6GAAA,eAAe,OAAA;AACxB,iDAAqD;AAA5C,mHAAA,kBAAkB,OAAA;AAC3B,2CAA+C;AAAtC,6GAAA,eAAe,OAAA;AACxB,yCAA8C;AAArC,4GAAA,eAAe,OAAA;AACxB,+BAAoC;AAA3B,kGAAA,UAAU,OAAA;AACnB,2DAA+D;AAAtD,6HAAA,uBAAuB,OAAA;AAChC,mDAAuD;AAA9C,qHAAA,mBAAmB,OAAA;AAC5B,6DAA4D;AAAnD,0HAAA,mBAAmB,OAAA;AAC5B,iEAAoE;AAA3D,kIAAA,yBAAyB,OAAA;AAClC,2EAA6E;AAApE,2IAAA,6BAA6B,OAAA;AACtC,yCAA6C;AAApC,2GAAA,cAAc,OAAA;AACvB,mDAAiD;AAAxC,+GAAA,aAAa,OAAA;AACtB,yDAAuD;AAA9C,qHAAA,gBAAgB,OAAA;AACzB,yCAAuB"}

package/dist/schemas/unknown-schema.d.ts

@@ -0,0 +1,13 @@
+import { Location, SchemaNode } from '../schema-node';
+/**
+ * needed for better backward and forward compatibility.
+ * in case a previous version of the semantic-schema had a schema class that doesn't exist anymore, then it'll be
+ * wrapped in this class.
+ */
+export declare class UnknownSchema extends SchemaNode {
+    readonly location: Location;
+    readonly schemaName: string;
+    readonly schemaObj: Record<string, any>;
+    constructor(location: Location, schemaName: string, schemaObj: Record<string, any>);
+    toString(): string;
+}

package/dist/schemas/unknown-schema.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnknownSchema = void 0;
+const schema_node_1 = require("../schema-node");
+/**
+ * needed for better backward and forward compatibility.
+ * in case a previous version of the semantic-schema had a schema class that doesn't exist anymore, then it'll be
+ * wrapped in this class.
+ */
+class UnknownSchema extends schema_node_1.SchemaNode {
+    constructor(location, schemaName, schemaObj) {
+        super();
+        this.location = location;
+        this.schemaName = schemaName;
+        this.schemaObj = schemaObj;
+    }
+    toString() {
+        return `<<unknown schema ${this.schemaName}>>`;
+    }
+}
+exports.UnknownSchema = UnknownSchema;
+//# sourceMappingURL=unknown-schema.js.map

package/dist/schemas/unknown-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unknown-schema.js","sourceRoot":"","sources":["../../schemas/unknown-schema.ts"],"names":[],"mappings":";;;AAAA,gDAAsD;AAEtD;;;;GAIG;AACH,MAAa,aAAc,SAAQ,wBAAU;IAC3C,YAAqB,QAAkB,EAAW,UAAkB,EAAW,SAA8B;QAC3G,KAAK,EAAE,CAAC;QADW,aAAQ,GAAR,QAAQ,CAAU;QAAW,eAAU,GAAV,UAAU,CAAQ;QAAW,cAAS,GAAT,SAAS,CAAqB;IAE7G,CAAC;IAED,QAAQ;QACN,OAAO,oBAAoB,IAAI,CAAC,UAAU,IAAI,CAAC;IACjD,CAAC;CACF;AARD,sCAQC"}

package/dist/schemas/unresolved-schema.d.ts

@@ -0,0 +1,11 @@
+import { Location, SchemaNode } from '../schema-node';
+/**
+ * needed for cases when the exported entity could not be resolved.
+ * e.g. exporting mdx variables in the main index.ts file.
+ */
+export declare class UnresolvedSchema extends SchemaNode {
+    readonly location: Location;
+    readonly name: string;
+    constructor(location: Location, name: string);
+    toString(): string;
+}

package/dist/schemas/unresolved-schema.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnresolvedSchema = void 0;
+const schema_node_1 = require("../schema-node");
+/**
+ * needed for cases when the exported entity could not be resolved.
+ * e.g. exporting mdx variables in the main index.ts file.
+ */
+class UnresolvedSchema extends schema_node_1.SchemaNode {
+    constructor(location, name) {
+        super();
+        this.location = location;
+        this.name = name;
+    }
+    toString() {
+        return this.name;
+    }
+}
+exports.UnresolvedSchema = UnresolvedSchema;
+//# sourceMappingURL=unresolved-schema.js.map

package/dist/schemas/unresolved-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unresolved-schema.js","sourceRoot":"","sources":["../../schemas/unresolved-schema.ts"],"names":[],"mappings":";;;AAAA,gDAAsD;AAEtD;;;GAGG;AACH,MAAa,gBAAiB,SAAQ,wBAAU;IAC9C,YAAqB,QAAkB,EAAW,IAAY;QAC5D,KAAK,EAAE,CAAC;QADW,aAAQ,GAAR,QAAQ,CAAU;QAAW,SAAI,GAAJ,IAAI,CAAQ;IAE9D,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;CACF;AARD,4CAQC"}

package/dist/schemas/{variable.d.ts → variable-like.d.ts}

@@ -2,7 +2,7 @@ import { Location, SchemaNode } from '../schema-node';
 /**
  * can be also a property or property-signature
  */
-export declare class VariableSchema extends SchemaNode {
+export declare class VariableLikeSchema extends SchemaNode {
     readonly location: Location;
     readonly name: string;
     readonly signature: string;

package/dist/schemas/{variable.js → variable-like.js}

@@ -9,7 +9,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VariableSchema = void 0;
+exports.VariableLikeSchema = void 0;
 const class_transformer_1 = require("class-transformer");
 const chalk_1 = __importDefault(require("chalk"));
 const schema_node_1 = require("../schema-node");
@@ -17,7 +17,7 @@ const class_transformers_1 = require("../class-transformers");
 /**
  * can be also a property or property-signature
  */
-class VariableSchema extends schema_node_1.SchemaNode {
+class VariableLikeSchema extends schema_node_1.SchemaNode {
     constructor(location, name, signature, type, isOptional) {
         super();
         this.location = location;
@@ -32,6 +32,6 @@ class VariableSchema extends schema_node_1.SchemaNode {
 }
 __decorate([
     (0, class_transformer_1.Transform)(class_transformers_1.schemaObjToInstance)
-], VariableSchema.prototype, "type", void 0);
-exports.VariableSchema = VariableSchema;
-//# sourceMappingURL=variable.js.map
+], VariableLikeSchema.prototype, "type", void 0);
+exports.VariableLikeSchema = VariableLikeSchema;
+//# sourceMappingURL=variable-like.js.map

package/dist/schemas/variable-like.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"variable-like.js","sourceRoot":"","sources":["../../schemas/variable-like.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAA8C;AAC9C,kDAA0B;AAC1B,gDAAsD;AACtD,8DAA4D;AAE5D;;GAEG;AACH,MAAa,kBAAmB,SAAQ,wBAAU;IAGhD,YACW,QAAkB,EAClB,IAAY,EACZ,SAAiB,EAC1B,IAAgB,EACP,UAAmB;QAE5B,KAAK,EAAE,CAAC;QANC,aAAQ,GAAR,QAAQ,CAAU;QAClB,SAAI,GAAJ,IAAI,CAAQ;QACZ,cAAS,GAAT,SAAS,CAAQ;QAEjB,eAAU,GAAV,UAAU,CAAS;QAG5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,QAAQ;QACN,OAAO,GAAG,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;IAC1F,CAAC;CACF;AAfC;IADC,IAAA,6BAAS,EAAC,wCAAmB,CAAC;gDACd;AAFnB,gDAiBC"}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/semantics.entities.semantic-schema",
-  "version": "0.0.18",
+  "version": "0.0.21",
   "homepage": "https://bit.dev/teambit/semantics/entities/semantic-schema",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.semantics",
     "name": "entities/semantic-schema",
-    "version": "0.0.18"
+    "version": "0.0.21"
   },
   "dependencies": {
     "chalk": "2.4.2",

package/{preview-1654572446572.js → preview-1655263660719.js}

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

package/schema-node.ts

@@ -19,4 +19,11 @@ export abstract class SchemaNode {
   }
 }
 
-export type Location = { file: string; line: number; character: number };
+export type Location = {
+  /**
+   * file-path relative to the component root-dir. normalized to Linux.
+   */
+  filePath: string;
+  line: number;
+  character: number;
+};

package/schemas/docs/doc.ts

@@ -6,7 +6,7 @@ import { TagName, TagSchema } from './tag';
 export class DocSchema extends SchemaNode {
   @Transform(schemaObjArrayToInstances)
   readonly tags?: TagSchema[];
-  constructor(readonly location: Location, readonly comment?: string, tags?: TagSchema[]) {
+  constructor(readonly location: Location, readonly raw: string, readonly comment?: string, tags?: TagSchema[]) {
     super();
     this.tags = tags;
   }

package/schemas/docs/index.ts

@@ -1,3 +1,4 @@
 export { DocSchema } from './doc';
 export { TagSchema } from './tag';
 export { ReturnTagSchema } from './return-tag';
+export { PropertyLikeTagSchema } from './property-like-tag';

package/schemas/docs/property-like-tag.ts

@@ -0,0 +1,22 @@
+import { Transform } from 'class-transformer';
+import { Location, SchemaNode } from '../../schema-node';
+import { TagName, TagSchema } from './tag';
+import { schemaObjToInstance } from '../../class-transformers';
+
+/**
+ * e.g. `@param myParam {string} some comment`
+ */
+export class PropertyLikeTagSchema extends TagSchema {
+  @Transform(schemaObjToInstance)
+  readonly type?: SchemaNode;
+  constructor(readonly location: Location, readonly paramName: string, readonly comment?: string, type?: SchemaNode) {
+    super(location, TagName.parameter, comment);
+    this.type = type;
+  }
+
+  toString() {
+    const comment = this.comment ? ` ${this.comment}` : '';
+    const type = this.type ? ` {${this.type.toString()}} ` : '';
+    return `@${this.tagName} ${this.paramName}${type} ${comment}`;
+  }
+}

package/schemas/docs/return-tag.ts

@@ -1,17 +1,17 @@
+import { Transform } from 'class-transformer';
 import { Location, SchemaNode } from '../../schema-node';
 import { TagName, TagSchema } from './tag';
+import { schemaObjToInstance } from '../../class-transformers';
 
 /**
  * e.g. `@return {string} some comment`
  */
 export class ReturnTagSchema extends TagSchema {
-  constructor(
-    readonly location: Location,
-    readonly tagName = TagName.return,
-    readonly comment?: string,
-    readonly type?: SchemaNode
-  ) {
-    super(location, tagName, comment);
+  @Transform(schemaObjToInstance)
+  readonly type?: SchemaNode;
+  constructor(readonly location: Location, readonly comment?: string, type?: SchemaNode) {
+    super(location, TagName.return, comment);
+    this.type = type;
   }
 
   toString() {

package/schemas/index.ts

@@ -1,7 +1,7 @@
 export { Module } from './module';
 export { FunctionLikeSchema, Modifier } from './function-like';
 export { TypeRefSchema } from './type-ref';
-export { VariableSchema } from './variable';
+export { VariableLikeSchema } from './variable-like';
 export { ClassSchema } from './class';
 export { ConstructorSchema } from './constructor';
 export { TypeSchema } from './type';
@@ -27,4 +27,6 @@ export { IndexedAccessSchema } from './indexed-access-type';
 export { TemplateLiteralTypeSchema } from './template-literal-type';
 export { TemplateLiteralTypeSpanSchema } from './template-literal-type-span';
 export { ThisTypeSchema } from './this-type';
+export { UnknownSchema } from './unknown-schema';
+export { UnresolvedSchema } from './unresolved-schema';
 export * from './docs';

package/schemas/unknown-schema.ts

@@ -0,0 +1,16 @@
+import { Location, SchemaNode } from '../schema-node';
+
+/**
+ * needed for better backward and forward compatibility.
+ * in case a previous version of the semantic-schema had a schema class that doesn't exist anymore, then it'll be
+ * wrapped in this class.
+ */
+export class UnknownSchema extends SchemaNode {
+  constructor(readonly location: Location, readonly schemaName: string, readonly schemaObj: Record<string, any>) {
+    super();
+  }
+
+  toString() {
+    return `<<unknown schema ${this.schemaName}>>`;
+  }
+}

package/schemas/unresolved-schema.ts

@@ -0,0 +1,15 @@
+import { Location, SchemaNode } from '../schema-node';
+
+/**
+ * needed for cases when the exported entity could not be resolved.
+ * e.g. exporting mdx variables in the main index.ts file.
+ */
+export class UnresolvedSchema extends SchemaNode {
+  constructor(readonly location: Location, readonly name: string) {
+    super();
+  }
+
+  toString() {
+    return this.name;
+  }
+}

package/schemas/{variable.ts → variable-like.ts}

@@ -6,7 +6,7 @@ import { schemaObjToInstance } from '../class-transformers';
 /**
  * can be also a property or property-signature
  */
-export class VariableSchema extends SchemaNode {
+export class VariableLikeSchema extends SchemaNode {
   @Transform(schemaObjToInstance)
   type: SchemaNode;
   constructor(

package/dist/schemas/variable.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"variable.js","sourceRoot":"","sources":["../../schemas/variable.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAA8C;AAC9C,kDAA0B;AAC1B,gDAAsD;AACtD,8DAA4D;AAE5D;;GAEG;AACH,MAAa,cAAe,SAAQ,wBAAU;IAG5C,YACW,QAAkB,EAClB,IAAY,EACZ,SAAiB,EAC1B,IAAgB,EACP,UAAmB;QAE5B,KAAK,EAAE,CAAC;QANC,aAAQ,GAAR,QAAQ,CAAU;QAClB,SAAI,GAAJ,IAAI,CAAQ;QACZ,cAAS,GAAT,SAAS,CAAQ;QAEjB,eAAU,GAAV,UAAU,CAAS;QAG5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,QAAQ;QACN,OAAO,GAAG,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;IAC1F,CAAC;CACF;AAfC;IADC,IAAA,6BAAS,EAAC,wCAAmB,CAAC;4CACd;AAFnB,wCAiBC"}