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

package/api-schema.ts

@@ -1,24 +1,31 @@
 import { Transform, plainToInstance } from 'class-transformer';
 import chalk from 'chalk';
+import { ComponentID } from '@teambit/component-id';
 import {
   ClassSchema,
   EnumSchema,
   FunctionLikeSchema,
   InterfaceSchema,
   Module,
+  TypeRefSchema,
   TypeSchema,
   VariableSchema,
 } from './schemas';
 import { Location, SchemaNode } from './schema-node';
-import { schemaObjToInstance } from './schema-obj-to-class';
+import { schemaObjToInstance } from './class-transformers';
+import { componentIdTransformer } from './class-transformers/comp-id-transformer';
 
 export class APISchema extends SchemaNode {
   @Transform(schemaObjToInstance)
   readonly module: Module;
 
-  constructor(readonly location: Location, module: Module) {
+  @Transform(componentIdTransformer)
+  readonly componentId: ComponentID;
+
+  constructor(readonly location: Location, module: Module, componentId: ComponentID) {
     super();
     this.module = module;
+    this.componentId = componentId;
   }
 
   toString() {
@@ -30,6 +37,7 @@ export class APISchema extends SchemaNode {
   }
 
   toStringPerType() {
+    const title = chalk.inverse(`API Schema of ${this.componentId.toString()}\n`);
     const getSection = (ClassObj, sectionName: string) => {
       const objects = this.module.exports.filter((exp) => exp instanceof ClassObj);
       if (!objects.length) {
@@ -40,13 +48,15 @@ export class APISchema extends SchemaNode {
     };
 
     return (
+      title +
       getSection(Module, 'Namespaces') +
       getSection(ClassSchema, 'Classes') +
       getSection(InterfaceSchema, 'Interfaces') +
       getSection(FunctionLikeSchema, 'Functions') +
       getSection(VariableSchema, 'Variables') +
       getSection(TypeSchema, 'Types') +
-      getSection(EnumSchema, 'Enums')
+      getSection(EnumSchema, 'Enums') +
+      getSection(TypeRefSchema, 'TypeReferences')
     );
   }
 

package/class-transformers/comp-id-transformer.ts

@@ -0,0 +1,22 @@
+import { ComponentID, ComponentIdObj } from '@teambit/component-id';
+import { TransformationType } from 'class-transformer';
+
+export function componentIdTransformer({
+  value,
+  type,
+}: {
+  value: ComponentID | ComponentIdObj | undefined;
+  type: TransformationType;
+}): ComponentID | ComponentIdObj | undefined {
+  if (!value) {
+    return undefined;
+  }
+  if (type === TransformationType.PLAIN_TO_CLASS) {
+    return ComponentID.fromObject(value as ComponentIdObj);
+  }
+  if (type === TransformationType.CLASS_TO_CLASS) {
+    return value as ComponentID;
+  }
+  // it's CLASS_TO_PLAIN
+  return (value as ComponentID).toObject();
+}

package/class-transformers/index.ts

@@ -0,0 +1,2 @@
+export { schemaObjArrayToInstances, schemaObjToInstance } from './schema-obj-to-class';
+export { componentIdTransformer } from './comp-id-transformer';

package/{schema-obj-to-class.ts → class-transformers/schema-obj-to-class.ts}

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

package/dist/api-schema.d.ts

@@ -1,9 +1,11 @@
+import { ComponentID } from '@teambit/component-id';
 import { Module } from './schemas';
 import { Location, SchemaNode } from './schema-node';
 export declare class APISchema extends SchemaNode {
     readonly location: Location;
     readonly module: Module;
-    constructor(location: Location, module: Module);
+    readonly componentId: ComponentID;
+    constructor(location: Location, module: Module, componentId: ComponentID);
     toString(): string;
     toStringPerType(): string;
     listSignatures(): string[];

package/dist/api-schema.js

@@ -14,17 +14,20 @@ const class_transformer_1 = require("class-transformer");
 const chalk_1 = __importDefault(require("chalk"));
 const schemas_1 = require("./schemas");
 const schema_node_1 = require("./schema-node");
-const schema_obj_to_class_1 = require("./schema-obj-to-class");
+const class_transformers_1 = require("./class-transformers");
+const comp_id_transformer_1 = require("./class-transformers/comp-id-transformer");
 class APISchema extends schema_node_1.SchemaNode {
-    constructor(location, module) {
+    constructor(location, module, componentId) {
         super();
         this.location = location;
         this.module = module;
+        this.componentId = componentId;
     }
     toString() {
         return JSON.stringify(this.module.exports.map((exp) => exp.toObject()), undefined, 2);
     }
     toStringPerType() {
+        const title = chalk_1.default.inverse(`API Schema of ${this.componentId.toString()}\n`);
         const getSection = (ClassObj, sectionName) => {
             const objects = this.module.exports.filter((exp) => exp instanceof ClassObj);
             if (!objects.length) {
@@ -32,13 +35,15 @@ class APISchema extends schema_node_1.SchemaNode {
             }
             return `${chalk_1.default.green.bold(sectionName)}\n${objects.map((c) => c.toString()).join('\n')}\n\n`;
         };
-        return (getSection(schemas_1.Module, 'Namespaces') +
+        return (title +
+            getSection(schemas_1.Module, 'Namespaces') +
             getSection(schemas_1.ClassSchema, 'Classes') +
             getSection(schemas_1.InterfaceSchema, 'Interfaces') +
             getSection(schemas_1.FunctionLikeSchema, 'Functions') +
             getSection(schemas_1.VariableSchema, 'Variables') +
             getSection(schemas_1.TypeSchema, 'Types') +
-            getSection(schemas_1.EnumSchema, 'Enums'));
+            getSection(schemas_1.EnumSchema, 'Enums') +
+            getSection(schemas_1.TypeRefSchema, 'TypeReferences'));
     }
     listSignatures() {
         return this.module.exports.map((exp) => exp.signature);
@@ -48,7 +53,10 @@ class APISchema extends schema_node_1.SchemaNode {
     }
 }
 __decorate([
-    (0, class_transformer_1.Transform)(schema_obj_to_class_1.schemaObjToInstance)
+    (0, class_transformer_1.Transform)(class_transformers_1.schemaObjToInstance)
 ], APISchema.prototype, "module", void 0);
+__decorate([
+    (0, class_transformer_1.Transform)(comp_id_transformer_1.componentIdTransformer)
+], APISchema.prototype, "componentId", void 0);
 exports.APISchema = APISchema;
 //# sourceMappingURL=api-schema.js.map

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;AAC1B,uCAQmB;AACnB,+CAAqD;AACrD,+DAA4D;AAE5D,MAAa,SAAU,SAAQ,wBAAU;IAIvC,YAAqB,QAAkB,EAAE,MAAc;QACrD,KAAK,EAAE,CAAC;QADW,aAAQ,GAAR,QAAQ,CAAU;QAErC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,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,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,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,CAChC,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;AA3CC;IADC,IAAA,6BAAS,EAAC,yCAAmB,CAAC;yCACP;AAF1B,8BA6CC"}
+{"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"}

package/dist/class-transformers/comp-id-transformer.d.ts

@@ -0,0 +1,6 @@
+import { ComponentID, ComponentIdObj } from '@teambit/component-id';
+import { TransformationType } from 'class-transformer';
+export declare function componentIdTransformer({ value, type, }: {
+    value: ComponentID | ComponentIdObj | undefined;
+    type: TransformationType;
+}): ComponentID | ComponentIdObj | undefined;

package/dist/class-transformers/comp-id-transformer.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.componentIdTransformer = void 0;
+const component_id_1 = require("@teambit/component-id");
+const class_transformer_1 = require("class-transformer");
+function componentIdTransformer({ value, type, }) {
+    if (!value) {
+        return undefined;
+    }
+    if (type === class_transformer_1.TransformationType.PLAIN_TO_CLASS) {
+        return component_id_1.ComponentID.fromObject(value);
+    }
+    if (type === class_transformer_1.TransformationType.CLASS_TO_CLASS) {
+        return value;
+    }
+    // it's CLASS_TO_PLAIN
+    return value.toObject();
+}
+exports.componentIdTransformer = componentIdTransformer;
+//# sourceMappingURL=comp-id-transformer.js.map

package/dist/class-transformers/comp-id-transformer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"comp-id-transformer.js","sourceRoot":"","sources":["../../class-transformers/comp-id-transformer.ts"],"names":[],"mappings":";;;AAAA,wDAAoE;AACpE,yDAAuD;AAEvD,SAAgB,sBAAsB,CAAC,EACrC,KAAK,EACL,IAAI,GAIL;IACC,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,SAAS,CAAC;KAClB;IACD,IAAI,IAAI,KAAK,sCAAkB,CAAC,cAAc,EAAE;QAC9C,OAAO,0BAAW,CAAC,UAAU,CAAC,KAAuB,CAAC,CAAC;KACxD;IACD,IAAI,IAAI,KAAK,sCAAkB,CAAC,cAAc,EAAE;QAC9C,OAAO,KAAoB,CAAC;KAC7B;IACD,sBAAsB;IACtB,OAAQ,KAAqB,CAAC,QAAQ,EAAE,CAAC;AAC3C,CAAC;AAlBD,wDAkBC"}

package/dist/class-transformers/index.d.ts

@@ -0,0 +1,2 @@
+export { schemaObjArrayToInstances, schemaObjToInstance } from './schema-obj-to-class';
+export { componentIdTransformer } from './comp-id-transformer';

package/dist/class-transformers/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.componentIdTransformer = exports.schemaObjToInstance = exports.schemaObjArrayToInstances = void 0;
+var schema_obj_to_class_1 = require("./schema-obj-to-class");
+Object.defineProperty(exports, "schemaObjArrayToInstances", { enumerable: true, get: function () { return schema_obj_to_class_1.schemaObjArrayToInstances; } });
+Object.defineProperty(exports, "schemaObjToInstance", { enumerable: true, get: function () { return schema_obj_to_class_1.schemaObjToInstance; } });
+var comp_id_transformer_1 = require("./comp-id-transformer");
+Object.defineProperty(exports, "componentIdTransformer", { enumerable: true, get: function () { return comp_id_transformer_1.componentIdTransformer; } });
+//# sourceMappingURL=index.js.map

package/dist/class-transformers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../class-transformers/index.ts"],"names":[],"mappings":";;;AAAA,6DAAuF;AAA9E,gIAAA,yBAAyB,OAAA;AAAE,0HAAA,mBAAmB,OAAA;AACvD,6DAA+D;AAAtD,6HAAA,sBAAsB,OAAA"}

package/dist/{schema-obj-to-class.d.ts → class-transformers/schema-obj-to-class.d.ts}

@@ -1,10 +1,10 @@
 import { TransformationType } from 'class-transformer';
-import { SchemaNode } from './schema-node';
+import { SchemaNode } from '../schema-node';
 export declare function schemaObjArrayToInstances({ value, type }: {
     value: SchemaNode[];
     type: TransformationType;
 }): SchemaNode[];
-export declare function schemaObjToInstance({ value, type }: {
-    value: Record<string, any>;
+export declare function schemaObjToInstance({ value, type, }: {
+    value: Record<string, any> | undefined;
     type: TransformationType;
 }): Record<string, any>;

package/dist/{schema-obj-to-class.js → class-transformers/schema-obj-to-class.js}

@@ -22,7 +22,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.schemaObjToInstance = exports.schemaObjArrayToInstances = void 0;
 const class_transformer_1 = require("class-transformer");
 const lodash_1 = require("lodash");
-const Schemas = __importStar(require("./schemas"));
+const Schemas = __importStar(require("../schemas"));
 function schemaObjArrayToInstances({ value, type }) {
     if (type !== class_transformer_1.TransformationType.PLAIN_TO_CLASS) {
         return value;
@@ -30,10 +30,13 @@ function schemaObjArrayToInstances({ value, type }) {
     return value.map((obj) => transformFromObjectToInstance(obj));
 }
 exports.schemaObjArrayToInstances = schemaObjArrayToInstances;
-function schemaObjToInstance({ value, type }) {
+function schemaObjToInstance({ value, type, }) {
     if (type !== class_transformer_1.TransformationType.PLAIN_TO_CLASS) {
         return value;
     }
+    if (!value) {
+        return undefined;
+    }
     return transformFromObjectToInstance(value);
 }
 exports.schemaObjToInstance = schemaObjToInstance;

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

@@ -0,0 +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"}

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { APISchema } from './api-schema';
 export { Export, StaticProperties } from './export';
 export type { SchemaNode, Location } from './schema-node';
-export { Module, FunctionLikeSchema, Modifier, TypeRefSchema, VariableSchema, ClassSchema, ConstructorSchema, TypeSchema, TypeIntersectionSchema, TypeUnionSchema, TypeLiteralSchema, IndexSignatureSchema, InterfaceSchema, GetAccessorSchema, SetAccessorSchema, TypeQuerySchema, InferenceTypeSchema, LiteralTypeSchema, KeywordTypeSchema, TypeArraySchema, TypeOperatorSchema, TupleTypeSchema, ParameterSchema, EnumSchema, ParenthesizedTypeSchema, TypePredicateSchema, IndexedAccessSchema, } from './schemas';
-export type { JSONSchema, JSONSchemaObject } from './json-schema';
+export * from './schemas';
+export { TagName } from './schemas/docs/tag';

package/dist/index.js

@@ -1,35 +1,21 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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.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 = exports.Export = exports.APISchema = void 0;
+exports.TagName = exports.Export = exports.APISchema = void 0;
 var api_schema_1 = require("./api-schema");
 Object.defineProperty(exports, "APISchema", { enumerable: true, get: function () { return api_schema_1.APISchema; } });
 var export_1 = require("./export");
 Object.defineProperty(exports, "Export", { enumerable: true, get: function () { return export_1.Export; } });
-var schemas_1 = require("./schemas");
-Object.defineProperty(exports, "Module", { enumerable: true, get: function () { return schemas_1.Module; } });
-Object.defineProperty(exports, "FunctionLikeSchema", { enumerable: true, get: function () { return schemas_1.FunctionLikeSchema; } });
-Object.defineProperty(exports, "TypeRefSchema", { enumerable: true, get: function () { return schemas_1.TypeRefSchema; } });
-Object.defineProperty(exports, "VariableSchema", { enumerable: true, get: function () { return schemas_1.VariableSchema; } });
-Object.defineProperty(exports, "ClassSchema", { enumerable: true, get: function () { return schemas_1.ClassSchema; } });
-Object.defineProperty(exports, "ConstructorSchema", { enumerable: true, get: function () { return schemas_1.ConstructorSchema; } });
-Object.defineProperty(exports, "TypeSchema", { enumerable: true, get: function () { return schemas_1.TypeSchema; } });
-Object.defineProperty(exports, "TypeIntersectionSchema", { enumerable: true, get: function () { return schemas_1.TypeIntersectionSchema; } });
-Object.defineProperty(exports, "TypeUnionSchema", { enumerable: true, get: function () { return schemas_1.TypeUnionSchema; } });
-Object.defineProperty(exports, "TypeLiteralSchema", { enumerable: true, get: function () { return schemas_1.TypeLiteralSchema; } });
-Object.defineProperty(exports, "IndexSignatureSchema", { enumerable: true, get: function () { return schemas_1.IndexSignatureSchema; } });
-Object.defineProperty(exports, "InterfaceSchema", { enumerable: true, get: function () { return schemas_1.InterfaceSchema; } });
-Object.defineProperty(exports, "GetAccessorSchema", { enumerable: true, get: function () { return schemas_1.GetAccessorSchema; } });
-Object.defineProperty(exports, "SetAccessorSchema", { enumerable: true, get: function () { return schemas_1.SetAccessorSchema; } });
-Object.defineProperty(exports, "TypeQuerySchema", { enumerable: true, get: function () { return schemas_1.TypeQuerySchema; } });
-Object.defineProperty(exports, "InferenceTypeSchema", { enumerable: true, get: function () { return schemas_1.InferenceTypeSchema; } });
-Object.defineProperty(exports, "LiteralTypeSchema", { enumerable: true, get: function () { return schemas_1.LiteralTypeSchema; } });
-Object.defineProperty(exports, "KeywordTypeSchema", { enumerable: true, get: function () { return schemas_1.KeywordTypeSchema; } });
-Object.defineProperty(exports, "TypeArraySchema", { enumerable: true, get: function () { return schemas_1.TypeArraySchema; } });
-Object.defineProperty(exports, "TypeOperatorSchema", { enumerable: true, get: function () { return schemas_1.TypeOperatorSchema; } });
-Object.defineProperty(exports, "TupleTypeSchema", { enumerable: true, get: function () { return schemas_1.TupleTypeSchema; } });
-Object.defineProperty(exports, "ParameterSchema", { enumerable: true, get: function () { return schemas_1.ParameterSchema; } });
-Object.defineProperty(exports, "EnumSchema", { enumerable: true, get: function () { return schemas_1.EnumSchema; } });
-Object.defineProperty(exports, "ParenthesizedTypeSchema", { enumerable: true, get: function () { return schemas_1.ParenthesizedTypeSchema; } });
-Object.defineProperty(exports, "TypePredicateSchema", { enumerable: true, get: function () { return schemas_1.TypePredicateSchema; } });
-Object.defineProperty(exports, "IndexedAccessSchema", { enumerable: true, get: function () { return schemas_1.IndexedAccessSchema; } });
+__exportStar(require("./schemas"), exports);
+var tag_1 = require("./schemas/docs/tag");
+Object.defineProperty(exports, "TagName", { enumerable: true, get: function () { return tag_1.TagName; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,2CAAyC;AAAhC,uGAAA,SAAS,OAAA;AAClB,mCAAoD;AAA3C,gGAAA,MAAM,OAAA;AAEf,qCA4BmB;AA3BjB,iGAAA,MAAM,OAAA;AACN,6GAAA,kBAAkB,OAAA;AAElB,wGAAA,aAAa,OAAA;AACb,yGAAA,cAAc,OAAA;AACd,sGAAA,WAAW,OAAA;AACX,4GAAA,iBAAiB,OAAA;AACjB,qGAAA,UAAU,OAAA;AACV,iHAAA,sBAAsB,OAAA;AACtB,0GAAA,eAAe,OAAA;AACf,4GAAA,iBAAiB,OAAA;AACjB,+GAAA,oBAAoB,OAAA;AACpB,0GAAA,eAAe,OAAA;AACf,4GAAA,iBAAiB,OAAA;AACjB,4GAAA,iBAAiB,OAAA;AACjB,0GAAA,eAAe,OAAA;AACf,8GAAA,mBAAmB,OAAA;AACnB,4GAAA,iBAAiB,OAAA;AACjB,4GAAA,iBAAiB,OAAA;AACjB,0GAAA,eAAe,OAAA;AACf,6GAAA,kBAAkB,OAAA;AAClB,0GAAA,eAAe,OAAA;AACf,0GAAA,eAAe,OAAA;AACf,qGAAA,UAAU,OAAA;AACV,kHAAA,uBAAuB,OAAA;AACvB,8GAAA,mBAAmB,OAAA;AACnB,8GAAA,mBAAmB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,2CAAyC;AAAhC,uGAAA,SAAS,OAAA;AAClB,mCAAoD;AAA3C,gGAAA,MAAM,OAAA;AAEf,4CAA0B;AAC1B,0CAA6C;AAApC,8FAAA,OAAO,OAAA"}

package/dist/schema-node.d.ts

@@ -1,3 +1,4 @@
+import { DocSchema } from './schemas';
 /**
  * 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.
@@ -6,6 +7,7 @@
 export declare abstract class SchemaNode {
     readonly __schema: string;
     abstract readonly location: Location;
+    readonly doc?: DocSchema;
     readonly signature?: string;
     abstract toString(): string;
     toObject(): Record<string, any>;

package/dist/schema-node.js.map

@@ -1 +1 @@
-{"version":3,"file":"schema-node.js","sourceRoot":"","sources":["../schema-node.ts"],"names":[],"mappings":";;;AAAA,yDAAoD;AAEpD;;;;GAIG;AACH,MAAsB,UAAU;IAAhC;QACW,aAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAS5C,CAAC;IAHC,QAAQ;QACN,OAAO,IAAA,mCAAe,EAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;CACF;AAVD,gCAUC"}
+{"version":3,"file":"schema-node.js","sourceRoot":"","sources":["../schema-node.ts"],"names":[],"mappings":";;;AAAA,yDAAoD;AAGpD;;;;GAIG;AACH,MAAsB,UAAU;IAAhC;QACW,aAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAU5C,CAAC;IAHC,QAAQ;QACN,OAAO,IAAA,mCAAe,EAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;CACF;AAXD,gCAWC"}

package/dist/schemas/class.d.ts

@@ -1,8 +1,10 @@
 import { Location, SchemaNode } from '../schema-node';
+import { DocSchema } from './docs';
 export declare class ClassSchema extends SchemaNode {
     readonly className: string;
     readonly location: Location;
     readonly members: SchemaNode[];
-    constructor(className: string, members: SchemaNode[], location: Location);
+    readonly doc?: DocSchema;
+    constructor(className: string, members: SchemaNode[], location: Location, doc?: DocSchema);
     toString(): string;
 }

package/dist/schemas/class.js

@@ -13,13 +13,14 @@ exports.ClassSchema = void 0;
 const class_transformer_1 = require("class-transformer");
 const chalk_1 = __importDefault(require("chalk"));
 const schema_node_1 = require("../schema-node");
-const schema_obj_to_class_1 = require("../schema-obj-to-class");
+const class_transformers_1 = require("../class-transformers");
 class ClassSchema extends schema_node_1.SchemaNode {
-    constructor(className, members, location) {
+    constructor(className, members, location, doc) {
         super();
         this.className = className;
         this.location = location;
         this.members = members;
+        this.doc = doc;
     }
     toString() {
         const membersStr = this.members.map((m) => `* ${m.toString()}`).join('\n');
@@ -27,7 +28,10 @@ class ClassSchema extends schema_node_1.SchemaNode {
     }
 }
 __decorate([
-    (0, class_transformer_1.Transform)(schema_obj_to_class_1.schemaObjArrayToInstances)
+    (0, class_transformer_1.Transform)(class_transformers_1.schemaObjArrayToInstances)
 ], ClassSchema.prototype, "members", void 0);
+__decorate([
+    (0, class_transformer_1.Transform)(class_transformers_1.schemaObjToInstance)
+], ClassSchema.prototype, "doc", void 0);
 exports.ClassSchema = ClassSchema;
 //# sourceMappingURL=class.js.map

package/dist/schemas/class.js.map

@@ -1 +1 @@
-{"version":3,"file":"class.js","sourceRoot":"","sources":["../../schemas/class.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAA8C;AAC9C,kDAA0B;AAC1B,gDAAsD;AACtD,gEAAmE;AAEnE,MAAa,WAAY,SAAQ,wBAAU;IAGzC,YAAqB,SAAiB,EAAE,OAAqB,EAAW,QAAkB;QACxF,KAAK,EAAE,CAAC;QADW,cAAS,GAAT,SAAS,CAAQ;QAAkC,aAAQ,GAAR,QAAQ,CAAU;QAExF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,QAAQ;QACN,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3E,OAAO,GAAG,eAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,UAAU,EAAE,CAAC;IAClE,CAAC;CACF;AAVC;IADC,IAAA,6BAAS,EAAC,+CAAyB,CAAC;4CACN;AAFjC,kCAYC"}
+{"version":3,"file":"class.js","sourceRoot":"","sources":["../../schemas/class.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAA8C;AAC9C,kDAA0B;AAC1B,gDAAsD;AACtD,8DAAuF;AAGvF,MAAa,WAAY,SAAQ,wBAAU;IAOzC,YAAqB,SAAiB,EAAE,OAAqB,EAAW,QAAkB,EAAE,GAAe;QACzG,KAAK,EAAE,CAAC;QADW,cAAS,GAAT,SAAS,CAAQ;QAAkC,aAAQ,GAAR,QAAQ,CAAU;QAExF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED,QAAQ;QACN,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3E,OAAO,GAAG,eAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,UAAU,EAAE,CAAC;IAClE,CAAC;CACF;AAfC;IADC,IAAA,6BAAS,EAAC,8CAAyB,CAAC;4CACN;AAG/B;IADC,IAAA,6BAAS,EAAC,wCAAmB,CAAC;wCACN;AAL3B,kCAiBC"}

package/dist/schemas/constructor.js

@@ -13,7 +13,7 @@ exports.ConstructorSchema = void 0;
 const class_transformer_1 = require("class-transformer");
 const chalk_1 = __importDefault(require("chalk"));
 const schema_node_1 = require("../schema-node");
-const schema_obj_to_class_1 = require("../schema-obj-to-class");
+const class_transformers_1 = require("../class-transformers");
 class ConstructorSchema extends schema_node_1.SchemaNode {
     constructor(location, params) {
         super();
@@ -26,7 +26,7 @@ class ConstructorSchema extends schema_node_1.SchemaNode {
     }
 }
 __decorate([
-    (0, class_transformer_1.Transform)(schema_obj_to_class_1.schemaObjArrayToInstances)
+    (0, class_transformer_1.Transform)(class_transformers_1.schemaObjArrayToInstances)
 ], ConstructorSchema.prototype, "params", void 0);
 exports.ConstructorSchema = ConstructorSchema;
 //# sourceMappingURL=constructor.js.map

package/dist/schemas/constructor.js.map

@@ -1 +1 @@
-{"version":3,"file":"constructor.js","sourceRoot":"","sources":["../../schemas/constructor.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAA8C;AAC9C,kDAA0B;AAC1B,gDAAsD;AAEtD,gEAAmE;AAEnE,MAAa,iBAAkB,SAAQ,wBAAU;IAG/C,YAAqB,QAAkB,EAAE,MAAyB;QAChE,KAAK,EAAE,CAAC;QADW,aAAQ,GAAR,QAAQ,CAAU;QAErC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,QAAQ;QACN,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1E,OAAO,GAAG,eAAK,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,SAAS,GAAG,CAAC;IACtD,CAAC;CACF;AAVC;IADC,IAAA,6BAAS,EAAC,+CAAyB,CAAC;iDACF;AAFrC,8CAYC"}
+{"version":3,"file":"constructor.js","sourceRoot":"","sources":["../../schemas/constructor.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAA8C;AAC9C,kDAA0B;AAC1B,gDAAsD;AAEtD,8DAAkE;AAElE,MAAa,iBAAkB,SAAQ,wBAAU;IAG/C,YAAqB,QAAkB,EAAE,MAAyB;QAChE,KAAK,EAAE,CAAC;QADW,aAAQ,GAAR,QAAQ,CAAU;QAErC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,QAAQ;QACN,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1E,OAAO,GAAG,eAAK,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,SAAS,GAAG,CAAC;IACtD,CAAC;CACF;AAVC;IADC,IAAA,6BAAS,EAAC,8CAAyB,CAAC;iDACF;AAFrC,8CAYC"}

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

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

package/dist/schemas/docs/doc.js

@@ -0,0 +1,37 @@
+"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.DocSchema = void 0;
+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) {
+        super();
+        this.location = location;
+        this.comment = comment;
+        this.tags = tags;
+    }
+    toString() {
+        const comment = this.comment ? `${this.comment}\n` : '';
+        const tags = this.tags ? this.tags.map((tag) => tag.toString()).join('\n') : '';
+        return `${comment}${tags}`;
+    }
+    hasTag(tagName) {
+        return Boolean(this.findTag(tagName));
+    }
+    findTag(tagName) {
+        var _a;
+        return (_a = this.tags) === null || _a === void 0 ? void 0 : _a.find((tag) => tag.tagName === tagName);
+    }
+}
+__decorate([
+    (0, class_transformer_1.Transform)(class_transformers_1.schemaObjArrayToInstances)
+], DocSchema.prototype, "tags", void 0);
+exports.DocSchema = DocSchema;
+//# sourceMappingURL=doc.js.map

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

@@ -0,0 +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"}

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

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

package/dist/schemas/docs/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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; } });
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,13 @@
+import { Location, SchemaNode } from '../../schema-node';
+import { TagName, 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);
+    toString(): string;
+}

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

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReturnTagSchema = void 0;
+const tag_1 = require("./tag");
+/**
+ * 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);
+        this.location = location;
+        this.tagName = tagName;
+        this.comment = comment;
+        this.type = type;
+    }
+    toString() {
+        const comment = this.comment ? ` ${this.comment}` : '';
+        return `@${this.tagName}${comment}`;
+    }
+}
+exports.ReturnTagSchema = ReturnTagSchema;
+//# sourceMappingURL=return-tag.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,33 @@
+import { Location, SchemaNode } from '../../schema-node';
+/**
+ * e.g. `@deprecated please use something else`
+ */
+export declare class TagSchema extends SchemaNode {
+    readonly location: Location;
+    readonly tagName: TagName | string;
+    readonly comment?: string;
+    constructor(location: Location, tagName: TagName | string, comment?: string);
+    toString(): string;
+}
+export declare enum TagName {
+    augments = "augments",
+    author = "author",
+    class = "class",
+    callback = "callback",
+    public = "public",
+    private = "private",
+    protected = "protected",
+    readonly = "readonly",
+    override = "override",
+    see = "see",
+    enum = "enum",
+    parameter = "parameter",
+    this = "this",
+    type = "type",
+    template = "template",
+    typedef = "typedef",
+    property = "property",
+    implements = "implements",
+    return = "return",
+    deprecated = "deprecated"
+}