@teambit/semantics.entities.semantic-schema 0.0.19 → 0.0.20

package/api-schema.ts

@@ -9,6 +9,7 @@ import {
   Module,
   TypeRefSchema,
   TypeSchema,
+  UnresolvedSchema,
   VariableLikeSchema,
 } from './schemas';
 import { Location, SchemaNode } from './schema-node';
@@ -56,7 +57,8 @@ export class APISchema extends SchemaNode {
       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

@@ -34,7 +34,7 @@ function transformFromObjectToInstance(obj: Record<string, any>): SchemaNode {
   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 || { file: '', line: 0, character: 0 }, obj.__schema, obj);
+    return new UnknownSchema(obj.location || { path: '', line: 0, character: 0 }, obj.__schema, obj);
   }
   return plainToInstance(SchemaClass, obj);
 }

package/dist/api-schema.js

@@ -43,7 +43,8 @@ class APISchema extends schema_node_1.SchemaNode {
             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,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,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

@@ -48,7 +48,7 @@ function transformFromObjectToInstance(obj) {
     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 || { file: '', line: 0, character: 0 }, obj.__schema, obj);
+        return new unknown_schema_1.UnknownSchema(obj.location || { path: '', line: 0, character: 0 }, obj.__schema, obj);
     }
     return (0, class_transformer_1.plainToInstance)(SchemaClass, obj);
 }

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/index.d.ts

@@ -28,4 +28,5 @@ 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,7 +10,7 @@ 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.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;
+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");
@@ -71,5 +71,7 @@ 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,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,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/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/package.json

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

package/{preview-1654745302834.js → preview-1654831618244.js}

@@ -1 +1 @@
-export const overview = [require('/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.semantics_entities_semantic-schema@0.0.19/dist/semantic-schema.docs.md')]
+export const overview = [require('/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.semantics_entities_semantic-schema@0.0.20/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/index.ts

@@ -28,4 +28,5 @@ 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/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;
+  }
+}