@teambit/schema 0.0.551 → 0.0.556

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.551",
+  "version": "0.0.556",
   "homepage": "https://bit.dev/teambit/semantics/schema",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.semantics",
     "name": "schema",
-    "version": "0.0.551"
+    "version": "0.0.556"
   },
   "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.551",
-    "@teambit/cli": "0.0.382",
-    "@teambit/envs": "0.0.551",
-    "@teambit/graphql": "0.0.551"
+    "@teambit/component": "0.0.556",
+    "@teambit/cli": "0.0.387",
+    "@teambit/envs": "0.0.556",
+    "@teambit/graphql": "0.0.556"
   },
   "devDependencies": {
     "@types/mocha": "5.2.7",
@@ -27,7 +27,7 @@
     "@types/node": "12.20.4"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.169",
+    "@teambit/legacy": "1.0.173",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -55,12 +55,18 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.169",
+        "@teambit/legacy": "1.0.173",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }
     }
   },
+  "files": [
+    "dist",
+    "!dist/tsconfig.tsbuildinfo",
+    "README.md",
+    "README.mdx"
+  ],
   "private": false,
   "engines": {
     "node": ">=12.22.0"

package/exceptions/index.ts

@@ -1 +0,0 @@
-export { ParserNotFound } from './parser-not-found';

package/exceptions/parser-not-found.ts

@@ -1,8 +0,0 @@
-export class ParserNotFound extends Error {
-  constructor(readonly filePath: string) {
-    super(`
-no parser is configured to apply on file path: ${filePath}.\n
-please use an extension to handle your file extension formats.
-`);
-  }
-}

package/index.ts

@@ -1,6 +0,0 @@
-export { Parser } from './parser';
-export { SchemaExtractor } from './schema-extractor';
-export { Export, Module, StaticProperties } from './schemas';
-export type { SchemaMain } from './schema.main.runtime';
-export { SchemaAspect } from './schema.aspect';
-export { SemanticSchema } from './semantic-schema';

package/parser.ts

@@ -1,13 +0,0 @@
-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/schema-extractor.ts

@@ -1,9 +0,0 @@
-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/schema.aspect.ts

@@ -1,5 +0,0 @@
-import { Aspect } from '@teambit/harmony';
-
-export const SchemaAspect = Aspect.create({
-  id: 'teambit.semantics/schema',
-});

package/schema.graphql.ts

@@ -1,35 +0,0 @@
-import { ComponentFactory } from '@teambit/component';
-import gql from 'graphql-tag';
-
-import { SchemaMain } from './schema.main.runtime';
-
-export function schemaSchema(schema: SchemaMain) {
-  return {
-    typeDefs: gql`
-      extend type ComponentHost {
-        getSchema(id: String!): SchemaDocs
-      }
-
-      type SchemaDocs {
-        exports: [String]
-      }
-    `,
-    resolvers: {
-      ComponentHost: {
-        getSchema: async (host: ComponentFactory, { id }: { id: string }) => {
-          const componentId = await host.resolveComponentId(id);
-          const component = await host.get(componentId);
-          const empty = {
-            exports: [],
-          };
-
-          if (!component) return empty;
-          const docs = await schema.getSchema(component);
-          if (!docs) return empty;
-
-          return docs;
-        },
-      },
-    },
-  };
-}

package/schema.main.runtime.ts

@@ -1,109 +0,0 @@
-import { MainRuntime } from '@teambit/cli';
-import { Component } from '@teambit/component';
-import { Slot, SlotRegistry } from '@teambit/harmony';
-import GraphqlAspect, { GraphqlMain } from '@teambit/graphql';
-import { EnvsAspect, EnvsMain } from '@teambit/envs';
-import { Parser } from './parser';
-import { SchemaAspect } from './schema.aspect';
-import { Module } from './schemas';
-import { SemanticSchema } from './semantic-schema';
-import { SchemaExtractor } from './schema-extractor';
-import { schemaSchema } from './schema.graphql';
-
-export type ParserSlot = SlotRegistry<Parser>;
-
-export type SchemaConfig = {
-  /**
-   * default parser
-   */
-  defaultParser: string;
-};
-
-/**
- * extension for extracting component schemas.
- */
-export class SchemaMain {
-  constructor(
-    /**
-     * parsers slot.
-     */
-    private parserSlot: ParserSlot,
-
-    private envs: EnvsMain,
-
-    private config: SchemaConfig
-  ) {}
-
-  /**
-   * get the default parser.
-   */
-  getDefaultParser(): Parser {
-    return this.parserSlot.get(this.config.defaultParser) as Parser;
-  }
-
-  /**
-   * parse a module into a component schema.
-   */
-  parseModule(path: string): Module {
-    const parsers = this.parserSlot.toArray();
-    let maybeParser = parsers.find(([, parser]) => {
-      const match = path.match(parser.extension);
-      return match;
-    });
-
-    if (!maybeParser) {
-      maybeParser = [this.config.defaultParser, this.getDefaultParser()];
-    }
-
-    const [, parser] = maybeParser;
-    return parser.parseModule(path);
-  }
-
-  /**
-   * get a schema of a component.
-   * @param component target component.
-   */
-  async getSchema(component: Component): Promise<SemanticSchema> {
-    const env = this.envs.getEnv(component).env;
-    if (typeof env.getSchemaExtractor === 'undefined') {
-      throw new Error(`No SchemaExtractor defined for ${env.name}`);
-    }
-    const schemaExtractor: SchemaExtractor = env.getSchemaExtractor();
-    await schemaExtractor.extract(component);
-
-    return {
-      exports: [],
-    };
-  }
-
-  /**
-   * register a new parser.
-   */
-  registerParser(parser: Parser): SchemaMain {
-    this.parserSlot.register(parser);
-    return this;
-  }
-
-  static runtime = MainRuntime;
-
-  static dependencies = [EnvsAspect, GraphqlAspect];
-
-  static defaultConfig = {
-    defaultParser: 'teambit.typescript/typescript',
-  };
-
-  static slots = [Slot.withType<Parser>()];
-
-  static async provider([envs, graphql]: [EnvsMain, GraphqlMain], config: SchemaConfig, [parserSlot]: [ParserSlot]) {
-    const schema = new SchemaMain(parserSlot, envs, config);
-    graphql.register(schemaSchema(schema));
-    // workspace.onComponentLoad(async (component) => {
-    //   const apiSchema = await schema.getSchema(component);
-    //   return {};
-    // });
-
-    return schema;
-  }
-}
-
-SchemaAspect.addRuntime(SchemaMain);

package/schema.service.ts

@@ -1,10 +0,0 @@
-import { EnvService, ExecutionContext } from '@teambit/envs';
-// import { APISchema } from './schema';
-
-export class SchemaService implements EnvService<{}> {
-  name = 'schema';
-
-  async run(context: ExecutionContext) {
-    return { errors: [], context };
-  }
-}

package/schemas/export.ts

@@ -1,20 +0,0 @@
-type Primitive = string | number | boolean | null | undefined;
-export type StaticProperties = Map<string, Primitive>;
-
-export class Export {
-  constructor(
-    /**
-     * 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
-  ) {}
-}

package/schemas/index.ts

@@ -1,2 +0,0 @@
-export { Module } from './module';
-export { Export, StaticProperties } from './export';

package/schemas/module.ts

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

package/semantic-schema.ts

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

package/tsconfig.json

@@ -1,35 +0,0 @@
-{
-  "compilerOptions": {
-    "lib": [
-      "es2019",
-      "DOM",
-      "ES6",
-      "DOM.Iterable",
-      "ScriptHost"
-    ],
-    "target": "es2015",
-    "module": "commonjs",
-    "jsx": "react",
-    "declaration": true,
-    "sourceMap": true,
-    "skipLibCheck": true,
-    "moduleResolution": "node",
-    "esModuleInterop": true,
-    "outDir": "dist",
-    "composite": true,
-    "emitDeclarationOnly": true,
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "allowSyntheticDefaultImports": true,
-    "strictPropertyInitialization": false,
-    "strict": true,
-    "noImplicitAny": false,
-    "rootDir": ".",
-    "removeComments": true,
-    "preserveConstEnums": true,
-    "resolveJsonModule": true
-  },
-  "exclude": [
-    "dist"
-  ]
-}

package/types/asset.d.ts

@@ -1,29 +0,0 @@
-declare module '*.png' {
-  const value: any;
-  export = value;
-}
-declare module '*.svg' {
-  import type { FunctionComponent, SVGProps } from 'react';
-
-  export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
-  const src: string;
-  export default src;
-}
-
-// @TODO Gilad
-declare module '*.jpg' {
-  const value: any;
-  export = value;
-}
-declare module '*.jpeg' {
-  const value: any;
-  export = value;
-}
-declare module '*.gif' {
-  const value: any;
-  export = value;
-}
-declare module '*.bmp' {
-  const value: any;
-  export = value;
-}

package/types/style.d.ts

@@ -1,42 +0,0 @@
-declare module '*.module.css' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-declare module '*.module.scss' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-declare module '*.module.sass' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.module.less' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.less' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.css' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.sass' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.scss' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.mdx' {
-  const component: any;
-  export default component;
-}