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

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/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/semantics.entities.semantic-schema",
-  "version": "0.0.20",
+  "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.20"
+    "version": "0.0.21"
   },
   "dependencies": {
     "chalk": "2.4.2",

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

@@ -1 +1 @@
-export const overview = [require('/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.semantics_entities_semantic-schema@0.0.20/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/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() {