@teambit/docs 1.0.226 → 1.0.228

package/dist/{preview-1712632644937.js → preview-1712805335812.js}

@@ -1,5 +1,5 @@
-import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.docs_docs@1.0.226/dist/docs.composition.js';
-import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.docs_docs@1.0.226/dist/docs.docs.mdx';
+import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.docs_docs@1.0.228/dist/docs.composition.js';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.docs_docs@1.0.228/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.226",
+  "version": "1.0.228",
   "homepage": "https://bit.cloud/teambit/docs/docs",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.docs",
     "name": "docs",
-    "version": "1.0.226"
+    "version": "1.0.228"
   },
   "dependencies": {
     "graphql-tag": "2.12.1",
@@ -19,21 +19,21 @@
     "@teambit/base-react.themes.theme-switcher": "1.0.2",
     "@teambit/component.ui.component-meta": "0.0.358",
     "@teambit/base-ui.loaders.skeleton": "1.0.1",
-    "@teambit/compiler": "1.0.226",
-    "@teambit/component": "1.0.226",
-    "@teambit/pkg": "1.0.226",
-    "@teambit/workspace": "1.0.226",
-    "@teambit/cli": "0.0.859",
-    "@teambit/dev-files": "1.0.226",
-    "@teambit/envs": "1.0.226",
-    "@teambit/graphql": "1.0.226",
-    "@teambit/logger": "0.0.952",
-    "@teambit/preview": "1.0.226",
-    "@teambit/scope": "1.0.226",
-    "@teambit/api-reference": "1.0.226",
-    "@teambit/component-compare": "1.0.226",
-    "@teambit/ui": "1.0.226",
-    "@teambit/pubsub": "1.0.226",
+    "@teambit/compiler": "1.0.228",
+    "@teambit/component": "1.0.228",
+    "@teambit/pkg": "1.0.228",
+    "@teambit/workspace": "1.0.228",
+    "@teambit/cli": "0.0.861",
+    "@teambit/dev-files": "1.0.228",
+    "@teambit/envs": "1.0.228",
+    "@teambit/graphql": "1.0.228",
+    "@teambit/logger": "0.0.954",
+    "@teambit/preview": "1.0.228",
+    "@teambit/scope": "1.0.228",
+    "@teambit/api-reference": "1.0.228",
+    "@teambit/component-compare": "1.0.228",
+    "@teambit/ui": "1.0.228",
+    "@teambit/pubsub": "1.0.228",
     "@teambit/compositions.panels.composition-gallery": "0.0.211",
     "@teambit/preview.ui.component-preview": "1.0.5"
   },
@@ -44,7 +44,7 @@
     "chai": "4.3.0",
     "@teambit/docs.content.docs-overview": "1.95.9",
     "@teambit/component-id": "1.2.0",
-    "@teambit/harmony.envs.core-aspect-env": "0.0.27"
+    "@teambit/harmony.envs.core-aspect-env": "0.0.30"
   },
   "peerDependencies": {
     "react": "^17.0.0 || ^18.0.0",

package/tsconfig.json

@@ -20,7 +20,8 @@
     "emitDeclarationOnly": true,
     "strict": true,
     "strictPropertyInitialization": false,
-    "noImplicitAny": false
+    "noImplicitAny": false,
+    "composite": true
   },
   "exclude": [
     "artifacts",
@@ -35,5 +36,52 @@
   "include": [
     "**/*",
     "**/*.json"
+  ],
+  "references": [
+    {
+      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.compilation_compiler@1.0.228"
+    },
+    {
+      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_component@1.0.228"
+    },
+    {
+      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.pkg_pkg@1.0.228"
+    },
+    {
+      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.workspace_workspace@1.0.228"
+    },
+    {
+      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cli@0.0.861"
+    },
+    {
+      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_dev-files@1.0.228"
+    },
+    {
+      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.envs_envs@1.0.228"
+    },
+    {
+      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_graphql@1.0.228"
+    },
+    {
+      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_logger@0.0.954"
+    },
+    {
+      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.preview_preview@1.0.228"
+    },
+    {
+      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.scope_scope@1.0.228"
+    },
+    {
+      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.api-reference_api-reference@1.0.228"
+    },
+    {
+      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_component-compare@1.0.228"
+    },
+    {
+      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.ui-foundation_ui@1.0.228"
+    },
+    {
+      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_pubsub@1.0.228"
+    }
   ]
 }

package/dist/default-doc-reader.d.ts

@@ -1,16 +0,0 @@
-/// <reference types="node" />
-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 declare class DefaultDocReader implements DocReader {
-    private pkg;
-    private compiler;
-    private workspace;
-    constructor(pkg: PkgMain, compiler: CompilerMain, workspace: Workspace);
-    read(path: string, contents: Buffer, component: Component): Promise<Doc>;
-    readonly supportedExtensions: string[];
-    isFormatSupported(format: string): boolean;
-}

package/dist/doc-module.d.ts

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

package/dist/doc-reader.d.ts

@@ -1,14 +0,0 @@
-/// <reference types="node" />
-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/dist/docs-store.d.ts

@@ -1 +0,0 @@
-export declare function addDocs(docs: any[]): void;

package/dist/docs.aspect.d.ts

@@ -1,3 +0,0 @@
-import { Aspect } from '@teambit/harmony';
-export declare const DocsAspect: Aspect;
-export default DocsAspect;

package/dist/docs.composition.d.ts

@@ -1 +0,0 @@
-export declare const Logo: () => import("react/jsx-runtime").JSX.Element;

package/dist/docs.d.ts

@@ -1,29 +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 declare const defaultDocs: Docs;

package/dist/docs.data.d.ts

@@ -1,9 +0,0 @@
-export declare const docsMock: {
-    title: string;
-    subTitle: string;
-    labels: string[];
-    installMethods: {
-        title: string;
-        content: string;
-    }[];
-};

package/dist/docs.graphql.d.ts

@@ -1,11 +0,0 @@
-import { Component } from '@teambit/component';
-import { DocsMain } from './docs.main.runtime';
-export declare function docsSchema(docs: DocsMain): {
-    typeDefs: import("graphql").DocumentNode;
-    resolvers: {
-        Component: {
-            description: (component: Component) => Promise<string>;
-            labels: (component: Component) => string[];
-        };
-    };
-};

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

@@ -1,98 +0,0 @@
-import { SlotRegistry } from '@teambit/harmony';
-import { LoggerMain, Logger } from '@teambit/logger';
-import { CompilerMain } from '@teambit/compiler';
-import { Component, ComponentMap, IComponent } from '@teambit/component';
-import { ScopeMain } from '@teambit/scope';
-import { PkgMain } from '@teambit/pkg';
-import type { Environment } from '@teambit/envs';
-import { GraphqlMain } from '@teambit/graphql';
-import { PreviewMain } from '@teambit/preview';
-import { DevFilesMain } from '@teambit/dev-files';
-import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
-import { Workspace } from '@teambit/workspace';
-import { Doc } from '@teambit/docs.entities.doc';
-import { EnvsMain } from '@teambit/envs';
-import { DocReader } from './doc-reader';
-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 declare class DocsMain {
-    private patterns;
-    /**
-     * envs extension.
-     */
-    private preview;
-    private pkg;
-    private compiler;
-    private workspace;
-    private logger;
-    private devFiles;
-    private envs;
-    private docPropSlot;
-    private docReaderSlot;
-    constructor(patterns: string[], 
-    /**
-     * envs extension.
-     */
-    preview: PreviewMain, pkg: PkgMain, compiler: CompilerMain, workspace: Workspace, logger: Logger, devFiles: DevFilesMain, envs: EnvsMain, 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(env: Environment): Promise<string | undefined>;
-    getDocReader(extension: string): DocReader | undefined;
-    /**
-     * compute a doc for a component.
-     */
-    computeDoc(component: Component): Promise<Doc | null>;
-    getDoc(component: IComponent): Doc | null;
-    getPatterns(): string[];
-    getComponentDevPatterns(component: Component): {
-        name: string;
-        pattern: string[];
-    };
-    getDevPatternToRegister(): (component: Component) => {
-        name: string;
-        pattern: 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;
-    static dependencies: import("@teambit/harmony").Aspect[];
-    static defaultConfig: {
-        patterns: string[];
-    };
-    static 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]): Promise<DocsMain>;
-}

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

@@ -1,28 +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 declare class DocsPreviewDefinition implements PreviewDefinition {
-    /**
-     * docs extension.
-     */
-    private docs;
-    readonly prefix = "overview";
-    readonly include: string[];
-    readonly includePeers = true;
-    constructor(
-    /**
-     * docs extension.
-     */
-    docs: DocsMain);
-    /**
-     * application root
-     */
-    renderTemplatePath(context: ExecutionContext): Promise<string | undefined>;
-    renderTemplatePathByEnv(env: Environment): Promise<string | undefined>;
-    /**
-     * files to load.
-     */
-    getModuleMap(components: Component[]): Promise<ComponentMap<AbstractVinyl[]>>;
-}

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

@@ -1,27 +0,0 @@
-import React from 'react';
-import { RenderingContext, PreviewPreview, PreviewModule } from '@teambit/preview';
-import { ComponentID } from '@teambit/component-id';
-import type { Docs } from './docs';
-export type DocsRootProps = {
-    Provider: React.ComponentType | undefined;
-    componentId: string;
-    docs: Docs | undefined;
-    compositions: any;
-    context: RenderingContext;
-};
-export declare class DocsPreview {
-    /**
-     * preview extension.
-     */
-    private preview;
-    constructor(
-    /**
-     * preview extension.
-     */
-    preview: PreviewPreview);
-    render: (componentId: ComponentID, envId: 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;
-    static dependencies: import("@teambit/harmony").Aspect[];
-    static provider([preview]: [PreviewPreview]): Promise<DocsPreview>;
-}

package/dist/docs.service.d.ts

@@ -1,5 +0,0 @@
-import { EnvService, ExecutionContext } from '@teambit/envs';
-export declare class DocsService implements EnvService<any> {
-    name: string;
-    run(context: ExecutionContext): Promise<any>;
-}

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

@@ -1,28 +0,0 @@
-import React, { ComponentType } from 'react';
-import { ComponentUI } from '@teambit/component';
-import { ComponentCompareUI } from '@teambit/component-compare';
-import { APIReferenceUI } from '@teambit/api-reference';
-import type { TitleBadgeSlot, TitleBadge, OverviewOptionsSlot, OverviewOptions } from './overview';
-export declare class DocsUI {
-    readonly titleBadgeSlot: TitleBadgeSlot;
-    readonly overviewOptionsSlot: OverviewOptionsSlot;
-    constructor(titleBadgeSlot: TitleBadgeSlot, overviewOptionsSlot: OverviewOptionsSlot);
-    /**
-     * register a new title badge into the overview section of a component.
-     */
-    registerTitleBadge(titleBadges: TitleBadge | TitleBadge[]): this;
-    /**
-     * list all title badges registered.
-     */
-    listTitleBadges(): TitleBadge[];
-    private _emptyState?;
-    registerEmptyState(emptyState: ComponentType): React.ComponentType;
-    getEmptyState(): React.ComponentType | undefined;
-    getDocsCompare(): import("react/jsx-runtime").JSX.Element;
-    registerOverviewOptions(options: OverviewOptions): void;
-    static dependencies: import("@teambit/harmony").Aspect[];
-    static runtime: import("@teambit/harmony").RuntimeDefinition;
-    static slots: (((registerFn: () => string) => import("@teambit/harmony").SlotRegistry<TitleBadge>) | ((registerFn: () => string) => import("@teambit/harmony").SlotRegistry<OverviewOptions>))[];
-    static provider([component, componentCompare, apiRef]: [ComponentUI, ComponentCompareUI, APIReferenceUI], config: any, [titleBadgeSlot, overviewOptionsSlot]: [TitleBadgeSlot, OverviewOptionsSlot]): Promise<DocsUI>;
-}
-export default DocsUI;

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

@@ -1,12 +0,0 @@
-import { BitBaseEvent } from '@teambit/pubsub';
-declare class ClickInsideAnIframeEventData {
-    private clickEvent;
-    constructor(clickEvent: any);
-}
-export declare class ClickInsideAnIframeEvent extends BitBaseEvent<ClickInsideAnIframeEventData> {
-    readonly timestamp: number;
-    readonly clickEvent: any;
-    static readonly TYPE = "click-inside-an-iframe";
-    constructor(timestamp: number, clickEvent: any);
-}
-export {};

package/dist/events/index.d.ts

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

package/dist/exceptions/doc-read-error.d.ts

@@ -1,3 +0,0 @@
-export declare class DocReadError extends Error {
-    constructor(filePath: string, error: Error);
-}

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

@@ -1,3 +0,0 @@
-export declare class FileExtensionNotSupported extends Error {
-    constructor(filePath: string, extension: string);
-}

package/dist/exceptions/index.d.ts

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

package/dist/index.d.ts

@@ -1,17 +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;

package/dist/overview/index.d.ts

@@ -1,2 +0,0 @@
-export { Overview, BadgePosition } from './overview';
-export type { TitleBadgeSlot, TitleBadge, OverviewOptionsSlot, OverviewOptions } from './overview';

package/dist/overview/overview.d.ts

@@ -1,29 +0,0 @@
-import React, { ComponentType } from 'react';
-import type { SlotRegistry } from '@teambit/harmony';
-import { ComponentPreviewProps } from '@teambit/preview.ui.component-preview';
-export declare enum BadgePosition {
-    Title = 0,
-    SubTitle = 1,
-    Labels = 2,
-    Package = 3
-}
-export type TitleBadge = {
-    component: ComponentType<any>;
-    weight?: number;
-    position?: BadgePosition;
-};
-export type TitleBadgeSlot = SlotRegistry<TitleBadge[]>;
-export type OverviewOptions = () => {
-    queryParams?: string;
-};
-export type OverviewOptionsSlot = SlotRegistry<OverviewOptions>;
-export type OverviewProps = {
-    titleBadges: TitleBadgeSlot;
-    overviewOptions: OverviewOptionsSlot;
-    previewProps?: Partial<ComponentPreviewProps>;
-    getEmptyState?: () => ComponentType | undefined;
-    TaggedAPI?: React.ComponentType<{
-        componentId: string;
-    }>;
-};
-export declare function Overview({ titleBadges, overviewOptions, previewProps, getEmptyState, TaggedAPI }: OverviewProps): import("react/jsx-runtime").JSX.Element;

package/dist/overview/readme-skeleton.d.ts

@@ -1,4 +0,0 @@
-import React from 'react';
-export declare function ReadmeSkeleton({ children }: {
-    children?: React.ReactNode;
-}): import("react/jsx-runtime").JSX.Element;

package/dist/overview.section.d.ts

@@ -1,28 +0,0 @@
-import { Section } from '@teambit/component';
-import { APIReferenceUI } from '@teambit/api-reference';
-import { TitleBadgeSlot, OverviewOptionsSlot } from './overview';
-import { DocsUI } from './docs.ui.runtime';
-export declare class OverviewSection implements Section {
-    /**
-     * title badge slot.
-     */
-    private titleBadgeSlot;
-    private overviewOptionsSlot;
-    private docs;
-    private apiRef;
-    constructor(
-    /**
-     * title badge slot.
-     */
-    titleBadgeSlot: TitleBadgeSlot, overviewOptionsSlot: OverviewOptionsSlot, docs: DocsUI, apiRef: APIReferenceUI);
-    navigationLink: {
-        href: string;
-        exact: boolean;
-        children: string;
-    };
-    route: {
-        index: boolean;
-        element: import("react/jsx-runtime").JSX.Element;
-    };
-    order: number;
-}