@teambit/schema 0.0.554 → 0.0.555

package/dist/parser.d.ts

@@ -1,5 +1,11 @@
 import { Module } from './schemas';
 export interface Parser {
+    /**
+     * regex to apply on which components compiler applies.
+     */
     extension: RegExp;
+    /**
+     * parse a module.
+     */
     parseModule(modulePath: string): Module;
 }

package/dist/schema-extractor.d.ts

@@ -1,5 +1,8 @@
 import { Component } from '@teambit/component';
 import { Module } from './schemas';
 export interface SchemaExtractor {
+    /**
+     * extract a semantic schema from a component.
+     */
     extract(component: Component): Promise<Module>;
 }

package/dist/schema.main.runtime.d.ts

@@ -7,16 +7,42 @@ import { Module } from './schemas';
 import { SemanticSchema } from './semantic-schema';
 export declare type ParserSlot = SlotRegistry<Parser>;
 export declare type SchemaConfig = {
+    /**
+     * default parser
+     */
     defaultParser: string;
 };
+/**
+ * extension for extracting component schemas.
+ */
 export declare class SchemaMain {
+    /**
+     * parsers slot.
+     */
     private parserSlot;
     private envs;
     private config;
-    constructor(parserSlot: ParserSlot, envs: EnvsMain, config: SchemaConfig);
+    constructor(
+    /**
+     * parsers slot.
+     */
+    parserSlot: ParserSlot, envs: EnvsMain, config: SchemaConfig);
+    /**
+     * get the default parser.
+     */
     getDefaultParser(): Parser;
+    /**
+     * parse a module into a component schema.
+     */
     parseModule(path: string): Module;
+    /**
+     * get a schema of a component.
+     * @param component target component.
+     */
     getSchema(component: Component): Promise<SemanticSchema>;
+    /**
+     * register a new parser.
+     */
     registerParser(parser: Parser): SchemaMain;
     static runtime: import("@teambit/harmony").RuntimeDefinition;
     static dependencies: import("@teambit/harmony").Aspect[];

package/dist/schemas/export.d.ts

@@ -1,8 +1,30 @@
 declare type Primitive = string | number | boolean | null | undefined;
 export declare type StaticProperties = Map<string, Primitive>;
 export declare class Export {
+    /**
+     * named export identifier of the module export.
+     */
     readonly identifier: string;
+    /**
+     * static properties attached to this export
+     * @example
+     * export hello = () => {};
+     * hello.value = "text"; // <-- staticProperty
+     * hello.count = 3; // <-- static property
+     */
     readonly staticProperties?: StaticProperties | undefined;
-    constructor(identifier: string, staticProperties?: StaticProperties | undefined);
+    constructor(
+    /**
+     * named export identifier of the module export.
+     */
+    identifier: string, 
+    /**
+     * static properties attached to this export
+     * @example
+     * export hello = () => {};
+     * hello.value = "text"; // <-- staticProperty
+     * hello.count = 3; // <-- static property
+     */
+    staticProperties?: StaticProperties | undefined);
 }
 export {};

package/dist/schemas/module.d.ts

@@ -1,5 +1,12 @@
 import { Export } from './export';
 export declare class Module {
+    /**
+     * all module exports.
+     */
     readonly exports: Export[];
-    constructor(exports: Export[]);
+    constructor(
+    /**
+     * all module exports.
+     */
+    exports: Export[]);
 }

package/dist/semantic-schema.d.ts

@@ -1,3 +1,6 @@
+/**
+ * describes the semantic schema of a component.
+ */
 export interface SemanticSchema {
     exports: [];
 }

package/package.json

@@ -1,22 +1,22 @@
 {
   "name": "@teambit/schema",
-  "version": "0.0.554",
+  "version": "0.0.555",
   "homepage": "https://bit.dev/teambit/semantics/schema",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.semantics",
     "name": "schema",
-    "version": "0.0.554"
+    "version": "0.0.555"
   },
   "dependencies": {
     "@teambit/harmony": "0.2.11",
     "graphql-tag": "2.12.1",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/component": "0.0.554",
-    "@teambit/cli": "0.0.385",
-    "@teambit/envs": "0.0.554",
-    "@teambit/graphql": "0.0.554"
+    "@teambit/component": "0.0.555",
+    "@teambit/cli": "0.0.386",
+    "@teambit/envs": "0.0.555",
+    "@teambit/graphql": "0.0.555"
   },
   "devDependencies": {
     "@types/mocha": "5.2.7",
@@ -27,7 +27,7 @@
     "@types/node": "12.20.4"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.171",
+    "@teambit/legacy": "1.0.172",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -55,7 +55,7 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.171",
+        "@teambit/legacy": "1.0.172",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }

package/tsconfig.json

@@ -25,7 +25,6 @@
     "strict": true,
     "noImplicitAny": false,
     "rootDir": ".",
-    "removeComments": true,
     "preserveConstEnums": true,
     "resolveJsonModule": true
   },