@teambit/docs 0.0.553 → 0.0.557

package/dist/doc/doc-prop.d.ts

@@ -1,7 +1,21 @@
 import type { Serializable } from '@teambit/toolbox.types.serializable';
 export declare class DocProp {
+    /**
+     * name of the doc property.
+     */
     readonly name: string;
+    /**
+     * value of the doc property.
+     */
     readonly value: Serializable;
-    constructor(name: string, value: Serializable);
+    constructor(
+    /**
+     * name of the doc property.
+     */
+    name: string, 
+    /**
+     * value of the doc property.
+     */
+    value: Serializable);
     getAs<T>(): T;
 }

package/dist/doc/doc.d.ts

@@ -8,8 +8,17 @@ export declare class Doc {
         filePath: string;
         props: import("./doc-prop").DocProp[];
     };
+    /**
+     * shorthand for getting the component description.
+     */
     get description(): string;
+    /**
+     * shorthand for getting the component labels.
+     */
     get labels(): string[];
+    /**
+     * shorthand for getting the component labels.
+     */
     get displayName(): import("./doc-prop").DocProp | undefined;
     static from(path: string, propObject: SerializableMap): Doc;
 }

package/dist/doc-module.d.ts

@@ -1,6 +1,16 @@
 export declare class DocModule {
     readonly path: string;
+    /**
+     * original doc module.
+     */
     readonly module: any;
-    constructor(path: string, module: any);
+    constructor(path: string, 
+    /**
+     * original doc module.
+     */
+    module: any);
+    /**
+     * get the abstract.
+     */
     get abstract(): any;
 }

package/dist/doc-reader.d.ts

@@ -2,6 +2,13 @@
 import type { Component } from '@teambit/component';
 import { Doc } from './doc';
 export interface DocReader {
+    /**
+     * read a component doc.
+     * @TODO refactor to virtual-file component after @david completes.
+     */
     read(path: string, contents: Buffer, component: Component): Promise<Doc>;
+    /**
+     * determine which file formats are supported by the doc reader.
+     */
     isFormatSupported(ext: string): boolean;
 }

package/dist/docs.d.ts

@@ -1,6 +1,15 @@
 import React from 'react';
 export declare type Docs = {
+    /**
+     * default is the docs content.
+     */
     default: React.ComponentType;
+    /**
+     * component abstract.
+     */
     abstract: string;
+    /**
+     * array of labels.
+     */
     labels: string[];
 };

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

@@ -19,10 +19,19 @@ export declare type DocProp = {};
 export declare type DocPropSlot = SlotRegistry<DocProp>;
 export declare type DocReaderSlot = SlotRegistry<DocReader>;
 export declare type DocsConfig = {
+    /**
+     * glob patterns to identify doc files.
+     */
     patterns: string[];
 };
+/**
+ * the component documentation extension.
+ */
 export declare class DocsMain {
     private patterns;
+    /**
+     * envs extension.
+     */
     private preview;
     private pkg;
     private compiler;
@@ -31,15 +40,32 @@ export declare class DocsMain {
     private devFiles;
     private docPropSlot;
     private docReaderSlot;
-    constructor(patterns: string[], preview: PreviewMain, pkg: PkgMain, compiler: CompilerMain, workspace: Workspace, logger: Logger, devFiles: DevFilesMain, docPropSlot: DocPropSlot, docReaderSlot: DocReaderSlot);
+    constructor(patterns: string[], 
+    /**
+     * envs extension.
+     */
+    preview: PreviewMain, pkg: PkgMain, compiler: CompilerMain, workspace: Workspace, logger: Logger, devFiles: DevFilesMain, docPropSlot: DocPropSlot, docReaderSlot: DocReaderSlot);
+    /**
+     * returns an array of doc file paths for a set of components.
+     */
     getDocsMap(components: Component[]): ComponentMap<AbstractVinyl[]>;
     getDocsFiles(component: Component): AbstractVinyl[];
+    /**
+     * compute the description of the component from its source code and docs file.
+     */
     getDescription(component: Component): Promise<string>;
     getTemplate(context: ExecutionContext): Promise<any>;
     getDocReader(extension: string): DocReader | undefined;
+    /**
+     * compute a doc for a component.
+     */
     computeDoc(component: Component): Promise<Doc | null>;
     getDoc(component: Component): Doc | null;
     getPatterns(): string[];
+    /**
+     * register a new doc reader. this allows to support further
+     * documentation file formats.
+     */
     registerDocReader(docReader: DocReader): this;
     static slots: ((registerFn: () => string) => SlotRegistry<DocProp>)[];
     static runtime: import("@teambit/harmony").RuntimeDefinition;

package/dist/docs.preview-definition.d.ts

@@ -4,9 +4,16 @@ import { PreviewDefinition } from '@teambit/preview';
 import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
 import { DocsMain } from './docs.main.runtime';
 export declare class DocsPreviewDefinition implements PreviewDefinition {
+    /**
+     * docs extension.
+     */
     private docs;
     readonly prefix = "overview";
-    constructor(docs: DocsMain);
+    constructor(
+    /**
+     * docs extension.
+     */
+    docs: DocsMain);
     renderTemplatePath(context: ExecutionContext): Promise<string>;
     getModuleMap(components: Component[]): Promise<ComponentMap<AbstractVinyl[]>>;
 }

package/dist/docs.preview.runtime.d.ts

@@ -1,7 +1,14 @@
 import { RenderingContext, PreviewPreview, PreviewModule } from '@teambit/preview';
 export declare class DocsPreview {
+    /**
+     * preview extension.
+     */
     private preview;
-    constructor(preview: PreviewPreview);
+    constructor(
+    /**
+     * preview extension.
+     */
+    preview: PreviewPreview);
     render: (componentId: string, modules: PreviewModule, [compositions]: [any], context: RenderingContext) => void;
     selectPreviewModel(componentId: string, modules: PreviewModule): import("@teambit/preview").ModuleFile<any> | undefined;
     static runtime: import("@teambit/harmony").RuntimeDefinition;

package/dist/overview.section.d.ts

@@ -1,8 +1,15 @@
 import { Section } from '@teambit/component';
 import { DocsUI } from './docs.ui.runtime';
 export declare class OverviewSection implements Section {
+    /**
+     * docs ui extension.
+     */
     private docs;
-    constructor(docs: DocsUI);
+    constructor(
+    /**
+     * docs ui extension.
+     */
+    docs: DocsUI);
     navigationLink: {
         href: string;
         exact: boolean;

package/package.json

@@ -1,33 +1,33 @@
 {
   "name": "@teambit/docs",
-  "version": "0.0.553",
+  "version": "0.0.557",
   "homepage": "https://bit.dev/teambit/docs/docs",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.docs",
     "name": "docs",
-    "version": "0.0.553"
+    "version": "0.0.557"
   },
   "dependencies": {
     "@teambit/harmony": "0.2.11",
     "graphql-tag": "2.12.1",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/compiler": "0.0.553",
-    "@teambit/component": "0.0.553",
-    "@teambit/pkg": "0.0.553",
-    "@teambit/workspace": "0.0.553",
-    "@teambit/cli": "0.0.384",
-    "@teambit/dev-files": "0.0.553",
-    "@teambit/envs": "0.0.553",
-    "@teambit/graphql": "0.0.553",
-    "@teambit/logger": "0.0.469",
-    "@teambit/preview": "0.0.553",
-    "@teambit/ui": "0.0.553",
-    "@teambit/toolbox.types.serializable": "0.0.458",
-    "@teambit/pubsub": "0.0.553",
+    "@teambit/compiler": "0.0.557",
+    "@teambit/component": "0.0.557",
+    "@teambit/pkg": "0.0.557",
+    "@teambit/workspace": "0.0.557",
+    "@teambit/cli": "0.0.388",
+    "@teambit/dev-files": "0.0.557",
+    "@teambit/envs": "0.0.557",
+    "@teambit/graphql": "0.0.557",
+    "@teambit/logger": "0.0.473",
+    "@teambit/preview": "0.0.557",
+    "@teambit/ui": "0.0.557",
+    "@teambit/toolbox.types.serializable": "0.0.462",
     "@teambit/design.ui.surfaces.status-message-card": "0.0.6",
-    "@teambit/preview.ui.component-preview": "0.0.461"
+    "@teambit/preview.ui.component-preview": "0.0.465",
+    "@teambit/pubsub": "0.0.557"
   },
   "devDependencies": {
     "@types/react-dom": "^17.0.5",
@@ -38,7 +38,7 @@
     "@types/node": "12.20.4"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.170",
+    "@teambit/legacy": "1.0.174",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -66,12 +66,20 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.170",
+        "@teambit/legacy": "1.0.174",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }
     }
   },
+  "files": [
+    "dist",
+    "!dist/tsconfig.tsbuildinfo",
+    "README.md",
+    "README.mdx",
+    "*.js",
+    "*.json"
+  ],
   "private": false,
   "engines": {
     "node": ">=12.22.0"

package/tsconfig.json

@@ -15,9 +15,9 @@
     "skipLibCheck": true,
     "moduleResolution": "node",
     "esModuleInterop": true,
-    "outDir": "dist",
     "composite": true,
     "emitDeclarationOnly": true,
+    "outDir": "dist",
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true,
     "allowSyntheticDefaultImports": true,
@@ -25,7 +25,6 @@
     "strict": true,
     "noImplicitAny": false,
     "rootDir": ".",
-    "removeComments": true,
     "preserveConstEnums": true,
     "resolveJsonModule": true
   },

package/default-doc-reader.ts

@@ -1,29 +0,0 @@
-import { resolve } from 'path';
-import type { PkgMain } from '@teambit/pkg';
-import type { Component } from '@teambit/component';
-import type { CompilerMain } from '@teambit/compiler';
-import type { Workspace } from '@teambit/workspace';
-import { DocReader } from './doc-reader';
-import { Doc } from './doc';
-
-export class DefaultDocReader implements DocReader {
-  constructor(private pkg: PkgMain, private compiler: CompilerMain, private workspace: Workspace) {}
-
-  async read(path: string, contents: Buffer, component: Component) {
-    const packageName = this.pkg.getPackageName(component);
-    const distPath = this.compiler.getDistPathBySrcPath(component, path);
-    // eslint-disable-next-line
-    const docsModule = require(resolve(`${this.workspace.path}/node_modules/${packageName}/${distPath}`));
-    return Doc.from(path, {
-      labels: docsModule.labels || docsModule.default?.labels,
-      description: docsModule.abstract || docsModule.default?.abstract || docsModule.description,
-      displayName: docsModule.displayName || docsModule.default?.componentDisplayName,
-    });
-  }
-
-  readonly supportedExtensions = ['.ts', '.js', '.jsx', '.tsx'];
-
-  isFormatSupported(format: string) {
-    return this.supportedExtensions.includes(format);
-  }
-}

package/doc/doc-prop-list.ts

@@ -1,20 +0,0 @@
-import { DocProp } from './doc-prop';
-
-export class DocPropList {
-  constructor(readonly docProps: DocProp[]) {}
-
-  get(name: string) {
-    return this.docProps.find((docProp) => docProp.name === name);
-  }
-
-  static from(object: any): DocPropList {
-    const props = Object.keys(object)
-      .map((key) => {
-        if (!object[key]) return undefined;
-        return new DocProp(key, object[key]);
-      })
-      .filter((prop) => !!prop) as DocProp[];
-
-    return new DocPropList(props);
-  }
-}

package/doc/doc-prop.ts

@@ -1,19 +0,0 @@
-import type { Serializable } from '@teambit/toolbox.types.serializable';
-
-export class DocProp {
-  constructor(
-    /**
-     * name of the doc property.
-     */
-    readonly name: string,
-
-    /**
-     * value of the doc property.
-     */
-    readonly value: Serializable
-  ) {}
-
-  getAs<T>() {
-    return this.value as T;
-  }
-}

package/doc/doc.ts

@@ -1,42 +0,0 @@
-import type { SerializableMap } from '@teambit/toolbox.types.serializable';
-import { DocPropList } from './doc-prop-list';
-
-export class Doc {
-  constructor(readonly filePath: string, readonly props: DocPropList) {}
-
-  toObject() {
-    return {
-      filePath: this.filePath,
-      props: this.props.docProps,
-    };
-  }
-
-  /**
-   * shorthand for getting the component description.
-   */
-  get description(): string {
-    const value = this.props.get('description')?.value;
-    if (!value) return '';
-    return value as string;
-  }
-
-  /**
-   * shorthand for getting the component labels.
-   */
-  get labels() {
-    const value = this.props.get('labels')?.value;
-    if (!value) return [];
-    return value as string[];
-  }
-
-  /**
-   * shorthand for getting the component labels.
-   */
-  get displayName() {
-    return this.props.get('displayName');
-  }
-
-  static from(path: string, propObject: SerializableMap) {
-    return new Doc(path, DocPropList.from(propObject));
-  }
-}

package/doc/index.ts

@@ -1,3 +0,0 @@
-export { Doc } from './doc';
-export { DocProp } from './doc-prop';
-export { DocPropList } from './doc-prop-list';

package/doc-module.ts

@@ -1,17 +0,0 @@
-export class DocModule {
-  constructor(
-    readonly path: string,
-
-    /**
-     * original doc module.
-     */
-    readonly module: any
-  ) {}
-
-  /**
-   * get the abstract.
-   */
-  get abstract() {
-    return this.module.abstract || this.module.default?.abstract;
-  }
-}

package/doc-reader.ts

@@ -1,15 +0,0 @@
-import type { Component } from '@teambit/component';
-import { Doc } from './doc';
-
-export interface DocReader {
-  /**
-   * read a component doc.
-   * @TODO refactor to virtual-file component after @david completes.
-   */
-  read(path: string, contents: Buffer, component: Component): Promise<Doc>;
-
-  /**
-   * determine which file formats are supported by the doc reader.
-   */
-  isFormatSupported(ext: string): boolean;
-}

package/docs-store.tsx

@@ -1,9 +0,0 @@
-import React from 'react';
-import ReactDOM from 'react-dom';
-
-// let docs = [];
-
-export function addDocs(docs: any[]) {
-  const Doc = docs[0];
-  ReactDOM.render(<Doc />, document.getElementById('root'));
-}

package/docs.aspect.ts

@@ -1,9 +0,0 @@
-import { Aspect } from '@teambit/harmony';
-
-export const DocsAspect = Aspect.create({
-  id: 'teambit.docs/docs',
-  dependencies: [],
-  defaultConfig: {},
-});
-
-export default DocsAspect;

package/docs.data.tsx

@@ -1,13 +0,0 @@
-export const docsMock = {
-  title: 'Radio',
-  subTitle:
-    'Radio Buttons are graphical interface elements that allow user to choose only one of a predefined set of mutually exclusive options.',
-  labels: ['chart', 'graph', 'ui-components', 'react'],
-  installMethods: [
-    { title: 'install package', content: '@google.material-ui/radio' },
-    {
-      title: 'Import from CDN',
-      content: 'https://esm.bit.dev/@google/material-ui/radio/',
-    },
-  ],
-};

package/docs.graphql.ts

@@ -1,26 +0,0 @@
-import gql from 'graphql-tag';
-import { Component } from '@teambit/component';
-import { DocsMain } from './docs.main.runtime';
-
-export function docsSchema(docs: DocsMain) {
-  return {
-    typeDefs: gql`
-      extend type Component {
-        description: String
-        labels: [String]
-      }
-    `,
-    resolvers: {
-      Component: {
-        description: (component: Component) => {
-          return docs.getDescription(component);
-        },
-
-        labels: (component: Component) => {
-          const doc = docs.getDoc(component);
-          return doc?.labels || [];
-        },
-      },
-    },
-  };
-}

package/docs.main.runtime.ts

@@ -1,215 +0,0 @@
-import { Slot, SlotRegistry } from '@teambit/harmony';
-import { MainRuntime } from '@teambit/cli';
-import { LoggerAspect, LoggerMain, Logger } from '@teambit/logger';
-import { CompilerAspect, CompilerMain } from '@teambit/compiler';
-import ComponentAspect, { Component, ComponentMap } from '@teambit/component';
-import { PkgAspect, PkgMain } from '@teambit/pkg';
-import { ExecutionContext } from '@teambit/envs';
-import { GraphqlAspect, GraphqlMain } from '@teambit/graphql';
-import { PreviewAspect, PreviewMain } from '@teambit/preview';
-import DevFilesAspect, { DevFilesMain } from '@teambit/dev-files';
-import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
-import ConsumerComponent from '@teambit/legacy/dist/consumer/component';
-import { Workspace, WorkspaceAspect } from '@teambit/workspace';
-import { DocsAspect } from './docs.aspect';
-import { DocsPreviewDefinition } from './docs.preview-definition';
-import { docsSchema } from './docs.graphql';
-import { DocReader } from './doc-reader';
-import { DefaultDocReader } from './default-doc-reader';
-import { FileExtensionNotSupported } from './exceptions';
-import { Doc, DocPropList } from './doc';
-
-export type ComponentDocs = {
-  files: string[];
-  component: Component;
-};
-
-export type DocProp = {};
-
-export type DocPropSlot = SlotRegistry<DocProp>;
-
-export type DocReaderSlot = SlotRegistry<DocReader>;
-
-export type DocsConfig = {
-  /**
-   * glob patterns to identify doc files.
-   */
-  patterns: string[];
-};
-
-/**
- * the component documentation extension.
- */
-export class DocsMain {
-  constructor(
-    private patterns: string[],
-    /**
-     * envs extension.
-     */
-    private preview: PreviewMain,
-
-    private pkg: PkgMain,
-
-    private compiler: CompilerMain,
-
-    private workspace: Workspace,
-
-    private logger: Logger,
-
-    private devFiles: DevFilesMain,
-
-    private docPropSlot: DocPropSlot,
-
-    private docReaderSlot: DocReaderSlot
-  ) {}
-
-  /**
-   * returns an array of doc file paths for a set of components.
-   */
-  getDocsMap(components: Component[]): ComponentMap<AbstractVinyl[]> {
-    return ComponentMap.as<AbstractVinyl[]>(components, (component) => {
-      return this.getDocsFiles(component);
-    });
-  }
-
-  getDocsFiles(component: Component): AbstractVinyl[] {
-    const devFiles = this.devFiles.computeDevFiles(component);
-    const docFiles = devFiles.get(DocsAspect.id);
-    return component.state.filesystem.files.filter((file) => docFiles.includes(file.relative));
-  }
-
-  /**
-   * compute the description of the component from its source code and docs file.
-   */
-  async getDescription(component: Component): Promise<string> {
-    const componentDoc = this.getDoc(component);
-    const desc = componentDoc?.description;
-    if (desc) return desc;
-    const consumerComponent: ConsumerComponent = component.state._consumer;
-    const fromJsDocs = consumerComponent.docs?.find((doc) => doc.description);
-
-    return fromJsDocs?.description || '';
-  }
-
-  async getTemplate(context: ExecutionContext) {
-    return context.env.getDocsTemplate();
-  }
-
-  getDocReader(extension: string) {
-    return this.docReaderSlot.values().find((docReader) => docReader.isFormatSupported(extension));
-  }
-
-  /**
-   * compute a doc for a component.
-   */
-  async computeDoc(component: Component) {
-    const docFiles = this.getDocsFiles(component);
-    if (docFiles.length) {
-      // currently taking the the first docs file found with an abstract. (we support only one)
-      const docFile = docFiles[0];
-
-      try {
-        const docReader = this.getDocReader(docFile.extname);
-        if (!docReader) throw new FileExtensionNotSupported(docFile.relative, docFile.extname);
-        const doc = await docReader.read(docFile.relative, docFile.contents, component);
-        return doc;
-      } catch (err: any) {
-        this.logger.error('docs.main.runtime.computeDoc caught an error', err);
-        return null;
-      }
-    }
-
-    return null;
-  }
-
-  getDoc(component: Component) {
-    const docData = component.state.aspects.get(DocsAspect.id)?.data?.doc;
-    if (!docData) return null;
-    return new Doc(docData.filePath, new DocPropList(docData.props));
-  }
-
-  getPatterns() {
-    return this.patterns;
-  }
-
-  /**
-   * register a new doc reader. this allows to support further
-   * documentation file formats.
-   */
-  registerDocReader(docReader: DocReader) {
-    this.docReaderSlot.register(docReader);
-    return this;
-  }
-
-  static slots = [Slot.withType<DocProp>(), Slot.withType<DocReader>()];
-
-  static runtime = MainRuntime;
-  static dependencies = [
-    PreviewAspect,
-    GraphqlAspect,
-    WorkspaceAspect,
-    PkgAspect,
-    CompilerAspect,
-    LoggerAspect,
-    DevFilesAspect,
-    ComponentAspect,
-  ];
-
-  static defaultConfig = {
-    patterns: ['**/*.docs.*'],
-  };
-
-  static async provider(
-    [preview, graphql, workspace, pkg, compiler, loggerAspect, devFiles]: [
-      PreviewMain,
-      GraphqlMain,
-      Workspace,
-      PkgMain,
-      CompilerMain,
-      LoggerMain,
-      DevFilesMain
-    ],
-    config: DocsConfig,
-    [docPropSlot, docReaderSlot]: [DocPropSlot, DocReaderSlot]
-  ) {
-    const logger = loggerAspect.createLogger(DocsAspect.id);
-    const docs = new DocsMain(
-      config.patterns,
-
-      preview,
-
-      pkg,
-
-      compiler,
-
-      workspace,
-
-      logger,
-
-      devFiles,
-
-      docPropSlot,
-
-      docReaderSlot
-    );
-    docs.registerDocReader(new DefaultDocReader(pkg, compiler, workspace));
-    devFiles.registerDevPattern(config.patterns);
-
-    if (workspace) {
-      workspace.onComponentLoad(async (component) => {
-        const doc = await docs.computeDoc(component);
-
-        return {
-          doc: doc?.toObject(),
-        };
-      });
-    }
-
-    graphql.register(docsSchema(docs));
-
-    preview.registerDefinition(new DocsPreviewDefinition(docs));
-    return docs;
-  }
-}
-
-DocsAspect.addRuntime(DocsMain);

package/docs.preview-definition.ts

@@ -1,26 +0,0 @@
-import { Component, ComponentMap } from '@teambit/component';
-import { ExecutionContext } from '@teambit/envs';
-import { PreviewDefinition } from '@teambit/preview';
-import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
-
-import { DocsMain } from './docs.main.runtime';
-
-export class DocsPreviewDefinition implements PreviewDefinition {
-  readonly prefix = 'overview';
-
-  constructor(
-    /**
-     * docs extension.
-     */
-    private docs: DocsMain
-  ) {}
-
-  async renderTemplatePath(context: ExecutionContext): Promise<string> {
-    return this.docs.getTemplate(context);
-  }
-
-  async getModuleMap(components: Component[]): Promise<ComponentMap<AbstractVinyl[]>> {
-    const map = this.docs.getDocsMap(components);
-    return map.filter((value) => value.length !== 0);
-  }
-}

package/docs.preview.runtime.tsx

@@ -1,48 +0,0 @@
-import React, { ReactNode } from 'react';
-import { PreviewAspect, RenderingContext, PreviewPreview, PreviewRuntime, PreviewModule } from '@teambit/preview';
-
-import { DocsAspect } from './docs.aspect';
-
-export class DocsPreview {
-  constructor(
-    /**
-     * preview extension.
-     */
-    private preview: PreviewPreview
-  ) {}
-
-  render = (componentId: string, modules: PreviewModule, [compositions]: [any], context: RenderingContext) => {
-    const docsModule = this.selectPreviewModel(componentId, modules);
-
-    modules.mainModule.default(NoopProvider, componentId, docsModule, compositions, context);
-  };
-
-  selectPreviewModel(componentId: string, modules: PreviewModule) {
-    const relevant = modules.componentMap[componentId];
-    if (!relevant) return undefined;
-
-    // only one doc file is supported.
-    return relevant[0];
-  }
-
-  static runtime = PreviewRuntime;
-  static dependencies = [PreviewAspect];
-
-  static async provider([preview]: [PreviewPreview]) {
-    const docsPreview = new DocsPreview(preview);
-    preview.registerPreview({
-      name: 'overview',
-      render: docsPreview.render.bind(docsPreview),
-      selectPreviewModel: docsPreview.selectPreviewModel.bind(docsPreview),
-      include: ['compositions'],
-    });
-
-    return docsPreview;
-  }
-}
-
-DocsAspect.addRuntime(DocsPreview);
-
-function NoopProvider({ children }: { children: ReactNode }) {
-  return <>{children}</>;
-}

package/docs.service.ts

@@ -1,9 +0,0 @@
-import { EnvService, ExecutionContext } from '@teambit/envs';
-
-export class DocsService implements EnvService<any> {
-  name = 'docs';
-
-  async run(context: ExecutionContext) {
-    return context.env.getDocsTemplate();
-  }
-}

package/docs.ts

@@ -1,18 +0,0 @@
-import React from 'react';
-
-export type Docs = {
-  /**
-   * default is the docs content.
-   */
-  default: React.ComponentType;
-
-  /**
-   * component abstract.
-   */
-  abstract: string;
-
-  /**
-   * array of labels.
-   */
-  labels: string[];
-};

package/docs.ui.runtime.tsx

@@ -1,25 +0,0 @@
-import { ComponentAspect, ComponentUI } from '@teambit/component';
-import { UIRuntime } from '@teambit/ui';
-
-import { DocsAspect } from './docs.aspect';
-import { OverviewSection } from './overview.section';
-
-export class DocsUI {
-  static dependencies = [ComponentAspect];
-
-  static runtime = UIRuntime;
-
-  static async provider([component]: [ComponentUI]) {
-    const docs = new DocsUI();
-    const section = new OverviewSection(docs);
-
-    component.registerRoute(section.route);
-    component.registerNavigation(section.navigationLink, section.order);
-
-    return docs;
-  }
-}
-
-export default DocsUI;
-
-DocsAspect.addRuntime(DocsUI);

package/events/click-inside-an-iframe.ts

@@ -1,14 +0,0 @@
-/* eslint-disable max-classes-per-file */
-import { BitBaseEvent } from '@teambit/pubsub';
-
-class ClickInsideAnIframeEventData {
-  constructor(private clickEvent: any) {}
-}
-
-export class ClickInsideAnIframeEvent extends BitBaseEvent<ClickInsideAnIframeEventData> {
-  static readonly TYPE = 'click-inside-an-iframe';
-
-  constructor(readonly timestamp = Date.now(), readonly clickEvent) {
-    super(ClickInsideAnIframeEvent.TYPE, '0.0.1', timestamp, new ClickInsideAnIframeEventData(clickEvent));
-  }
-}

package/events/index.ts

@@ -1 +0,0 @@
-export * from './click-inside-an-iframe';

package/exceptions/doc-read-error.ts

@@ -1,5 +0,0 @@
-export class DocReadError extends Error {
-  constructor(filePath: string, error: Error) {
-    super(`failed reading doc in file path: ${filePath} with error: ${error}`);
-  }
-}

package/exceptions/file-extension-not-supported.ts

@@ -1,6 +0,0 @@
-export class FileExtensionNotSupported extends Error {
-  constructor(filePath: string, extension: string) {
-    super(`failed reading doc file: ${filePath} as file extension ${extension} is not supported
-by any of registered component doc readers. To register a doc reader please use the 'registerDocReader' API of the teambit.docs/docs.`);
-  }
-}

package/exceptions/index.ts

@@ -1,2 +0,0 @@
-export { FileExtensionNotSupported } from './file-extension-not-supported';
-export { DocReadError } from './doc-read-error';

package/index.ts

@@ -1,9 +0,0 @@
-import { DocsAspect } from './docs.aspect';
-
-export type { DocsMain } from './docs.main.runtime';
-export type { DocsUI } from './docs.ui.runtime';
-export type { DocsPreview } from './docs.preview.runtime';
-export type { DocReader } from './doc-reader';
-export { Doc, DocProp, DocPropList } from './doc';
-export { DocsAspect };
-export default DocsAspect;

package/overview/index.ts

@@ -1 +0,0 @@
-export { Overview } from './overview';

package/overview/overview.tsx

@@ -1,23 +0,0 @@
-import React, { useContext } from 'react';
-import { ComponentContext } from '@teambit/component';
-import { ComponentPreview } from '@teambit/preview.ui.component-preview';
-import { StatusMessageCard } from '@teambit/design.ui.surfaces.status-message-card';
-
-export function Overview() {
-  const component = useContext(ComponentContext);
-  if (component?.buildStatus === 'pending' && component?.host === 'teambit.scope/scope')
-    return (
-      <StatusMessageCard style={{ margin: 'auto' }} status="PROCESSING" title="component preview pending">
-        this might take some time
-      </StatusMessageCard>
-    );
-  if (component?.buildStatus === 'failed' && component?.host === 'teambit.scope/scope')
-    return (
-      <StatusMessageCard
-        style={{ margin: 'auto' }}
-        status="FAILURE"
-        title="failed to get component preview "
-      ></StatusMessageCard>
-    );
-  return <ComponentPreview component={component} style={{ width: '100%', height: '100%' }} previewName="overview" />;
-}

package/overview.section.tsx

@@ -1,28 +0,0 @@
-import { Section } from '@teambit/component';
-import React from 'react';
-
-import { DocsUI } from './docs.ui.runtime';
-import { Overview } from './overview';
-
-export class OverviewSection implements Section {
-  constructor(
-    /**
-     * docs ui extension.
-     */
-    private docs: DocsUI
-  ) {}
-
-  navigationLink = {
-    href: '',
-    exact: true,
-    children: 'Overview',
-  };
-
-  route = {
-    path: '',
-    exact: true,
-    children: <Overview />,
-  };
-
-  order = 10;
-}

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;
-}