@teambit/docs 1.0.108 → 1.0.109

package/dist/{preview-1703647408454.js → preview-1703698405864.js}

@@ -1,5 +1,5 @@
-import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.docs_docs@1.0.108/dist/docs.composition.js';
-import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.docs_docs@1.0.108/dist/docs.docs.mdx';
+import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.docs_docs@1.0.109/dist/docs.composition.js';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.docs_docs@1.0.109/dist/docs.docs.mdx';
 
 export const compositions = [compositions_0];
 export const overview = [overview_0];

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/docs",
-  "version": "1.0.108",
+  "version": "1.0.109",
   "homepage": "https://bit.cloud/teambit/docs/docs",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.docs",
     "name": "docs",
-    "version": "1.0.108"
+    "version": "1.0.109"
   },
   "dependencies": {
     "graphql-tag": "2.12.1",
@@ -18,20 +18,20 @@
     "@teambit/docs.ui.overview-compare": "1.0.10",
     "@teambit/component.ui.component-meta": "0.0.358",
     "@teambit/base-ui.loaders.skeleton": "1.0.1",
-    "@teambit/compiler": "1.0.108",
-    "@teambit/component": "1.0.108",
-    "@teambit/pkg": "1.0.108",
-    "@teambit/workspace": "1.0.108",
-    "@teambit/cli": "0.0.840",
-    "@teambit/dev-files": "1.0.108",
-    "@teambit/envs": "1.0.108",
-    "@teambit/graphql": "1.0.108",
-    "@teambit/logger": "0.0.933",
-    "@teambit/preview": "1.0.108",
-    "@teambit/scope": "1.0.108",
-    "@teambit/component-compare": "1.0.108",
-    "@teambit/ui": "1.0.108",
-    "@teambit/pubsub": "1.0.108",
+    "@teambit/compiler": "1.0.109",
+    "@teambit/component": "1.0.109",
+    "@teambit/pkg": "1.0.109",
+    "@teambit/workspace": "1.0.109",
+    "@teambit/cli": "0.0.841",
+    "@teambit/dev-files": "1.0.109",
+    "@teambit/envs": "1.0.109",
+    "@teambit/graphql": "1.0.109",
+    "@teambit/logger": "0.0.934",
+    "@teambit/preview": "1.0.109",
+    "@teambit/scope": "1.0.109",
+    "@teambit/component-compare": "1.0.109",
+    "@teambit/ui": "1.0.109",
+    "@teambit/pubsub": "1.0.109",
     "@teambit/compositions.panels.composition-gallery": "0.0.202",
     "@teambit/react.ui.docs.properties-table": "0.0.22",
     "@teambit/preview.ui.component-preview": "1.0.3"
@@ -44,7 +44,7 @@
     "@types/testing-library__jest-dom": "^5.9.5",
     "@teambit/docs.content.docs-overview": "1.95.9",
     "@teambit/component-id": "1.2.0",
-    "@teambit/harmony.envs.core-aspect-env": "0.0.13"
+    "@teambit/harmony.envs.core-aspect-env": "0.0.14"
   },
   "peerDependencies": {
     "react": "^17.0.0 || ^18.0.0",

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 { Doc } from '@teambit/docs.entities.doc';
-import { DocReader } from './doc-reader';
-
-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-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 '@teambit/docs.entities.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.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.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,234 +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 { Component, ComponentMap, IComponent } from '@teambit/component';
-import ScopeAspect, { ScopeMain } from '@teambit/scope';
-import { PkgAspect, PkgMain } from '@teambit/pkg';
-import type { Environment } from '@teambit/envs';
-import { GraphqlAspect, GraphqlMain } from '@teambit/graphql';
-import { PreviewAspect, PreviewMain } from '@teambit/preview';
-import DevFilesAspect, { DevFilesMain } from '@teambit/dev-files';
-import { ComponentLoadOptions } from '@teambit/legacy/dist/consumer/component/component-loader';
-import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
-import { Workspace, WorkspaceAspect } from '@teambit/workspace';
-import { Doc, DocPropList } from '@teambit/docs.entities.doc';
-import { isFunction } from 'lodash';
-import { EnvsAspect, EnvsMain } from '@teambit/envs';
-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';
-
-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 envs: EnvsMain,
-
-    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.getDevFiles(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;
-    return desc || '';
-  }
-
-  async getTemplate(env: Environment): Promise<string | undefined> {
-    if (env.getDocsTemplate && isFunction(env.getDocsTemplate)) {
-      return env.getDocsTemplate();
-    }
-    return undefined;
-  }
-
-  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) {
-        // it's ok to fail here.
-        this.logger.debug(`docs.main.runtime.computeDoc caught an error: ${err.message}`);
-        return null;
-      }
-    }
-
-    return null;
-  }
-
-  getDoc(component: IComponent) {
-    const docData = component.get(DocsAspect.id)?.data?.doc;
-    if (!docData) return null;
-    return new Doc(docData.filePath, new DocPropList(docData.props));
-  }
-
-  getPatterns() {
-    return this.patterns;
-  }
-
-  getComponentDevPatterns(component: Component) {
-    const env = this.envs.calculateEnv(component, { skipWarnings: !!this.workspace?.inInstallContext }).env;
-    const componentEnvDocsDevPatterns: string[] = env.getDocsDevPatterns ? env.getDocsDevPatterns(component) : [];
-    const componentPatterns = componentEnvDocsDevPatterns.concat(this.getPatterns());
-    return { name: 'docs', pattern: componentPatterns };
-  }
-
-  getDevPatternToRegister() {
-    return this.getComponentDevPatterns.bind(this);
-  }
-  /**
-   * 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,
-    EnvsAspect,
-    ScopeAspect,
-  ];
-
-  static defaultConfig = {
-    patterns: ['**/*.docs.*'],
-  };
-
-  static async provider(
-    [preview, graphql, workspace, pkg, compiler, loggerAspect, devFiles, envs, scope]: [
-      PreviewMain,
-      GraphqlMain,
-      Workspace,
-      PkgMain,
-      CompilerMain,
-      LoggerMain,
-      DevFilesMain,
-      EnvsMain,
-      ScopeMain
-    ],
-    config: DocsConfig,
-    [docPropSlot, docReaderSlot]: [DocPropSlot, DocReaderSlot]
-  ) {
-    const logger = loggerAspect.createLogger(DocsAspect.id);
-    const docs = new DocsMain(
-      config.patterns,
-      preview,
-      pkg,
-      compiler,
-      workspace,
-      logger,
-      devFiles,
-      envs,
-      docPropSlot,
-      docReaderSlot
-    );
-    docs.registerDocReader(new DefaultDocReader(pkg, compiler, workspace));
-    devFiles.registerDevPattern(docs.getDevPatternToRegister());
-
-    const computeDocsOnLoad = async (component: Component, opts?: ComponentLoadOptions) => {
-      if (opts?.loadDocs === false) return undefined;
-      // const docFiles = await docs.computeDocs(component);
-      const doc = await docs.computeDoc(component);
-
-      return {
-        doc: doc?.toObject(),
-        // docFiles
-      };
-    };
-
-    if (workspace) {
-      workspace.registerOnComponentLoad(computeDocsOnLoad);
-    }
-    if (scope) {
-      scope.registerOnCompAspectReCalc(computeDocsOnLoad);
-    }
-
-    graphql.register(docsSchema(docs));
-
-    preview.registerDefinition(new DocsPreviewDefinition(docs));
-    return docs;
-  }
-}
-
-DocsAspect.addRuntime(DocsMain);

package/docs.preview-definition.ts

@@ -1,38 +0,0 @@
-import { Component, ComponentMap } from '@teambit/component';
-import type { Environment, 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';
-  readonly include = ['compositions'];
-  readonly includePeers = true;
-
-  constructor(
-    /**
-     * docs extension.
-     */
-    private docs: DocsMain
-  ) {}
-
-  /**
-   * application root
-   */
-  async renderTemplatePath(context: ExecutionContext): Promise<string | undefined> {
-    return this.renderTemplatePathByEnv(context.env);
-  }
-
-  async renderTemplatePathByEnv(env: Environment): Promise<string | undefined> {
-    return this.docs.getTemplate(env);
-  }
-
-  /**
-   * files to load.
-   */
-  async getModuleMap(components: Component[]): Promise<ComponentMap<AbstractVinyl[]>> {
-    const map = this.docs.getDocsMap(components);
-    return map;
-  }
-}

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,38 +0,0 @@
-import React, { ReactElement } from 'react';
-
-export type Example = {
-  title?: string;
-  description?: ReactElement;
-  scope?: { [key: string]: any };
-  jsx?: JSX.Element;
-  code: string;
-};
-
-export type Docs = {
-  /**
-   * default is the docs content.
-   */
-  default: React.ComponentType;
-
-  /**
-   * component abstract.
-   */
-  abstract: string;
-
-  /**
-   * array of labels.
-   */
-  labels: string[];
-
-  /**
-   * @deprecated
-   */
-  examples: Example[];
-};
-
-export const defaultDocs: Docs = {
-  default: () => null,
-  labels: [],
-  abstract: '',
-  examples: [],
-};

package/index.ts

@@ -1,21 +0,0 @@
-import { DocsAspect } from './docs.aspect';
-
-/**
- * Doc entity.
- * @deprecated - please dont use this. use directly from @teambit/docs.entities.doc.
- */
-export { Doc, DocProp, DocPropList } from '@teambit/docs.entities.doc';
-
-export type { DocsMain } from './docs.main.runtime';
-export type { DocsUI } from './docs.ui.runtime';
-export type { DocsPreview, DocsRootProps } from './docs.preview.runtime';
-export type { DocReader } from './doc-reader';
-export type { Docs, Example } from './docs';
-export { defaultDocs } from './docs';
-
-export type { TitleBadgeSlot, TitleBadge, OverviewOptionsSlot, OverviewOptions } from './overview';
-export { BadgePosition } from './overview';
-export { Overview } from './overview';
-
-export { DocsAspect };
-export default DocsAspect;