@teambit/docs 0.0.785 → 0.0.786

package/dist/docs.d.ts

@@ -1,4 +1,13 @@
-import React from 'react';
+import React, { ReactElement } from 'react';
+export declare type Example = {
+    title?: string;
+    description?: ReactElement;
+    scope?: {
+        [key: string]: any;
+    };
+    jsx?: JSX.Element;
+    code: string;
+};
 export declare type Docs = {
     /**
      * default is the docs content.
@@ -12,4 +21,8 @@ export declare type Docs = {
      * array of labels.
      */
     labels: string[];
+    /**
+     * @deprecated
+     */
+    examples: Example[];
 };

package/dist/docs.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["docs.ts"],"sourcesContent":["import React from 'react';\n\nexport type Docs = {\n  /**\n   * default is the docs content.\n   */\n  default: React.ComponentType;\n\n  /**\n   * component abstract.\n   */\n  abstract: string;\n\n  /**\n   * array of labels.\n   */\n  labels: string[];\n};\n"],"mappings":""}
+{"version":3,"names":[],"sources":["docs.ts"],"sourcesContent":["import React, { ReactElement } from 'react';\n\nexport type Example = {\n  title?: string;\n  description?: ReactElement;\n  scope?: { [key: string]: any };\n  jsx?: JSX.Element;\n  code: string;\n};\n\nexport type Docs = {\n  /**\n   * default is the docs content.\n   */\n  default: React.ComponentType;\n\n  /**\n   * component abstract.\n   */\n  abstract: string;\n\n  /**\n   * array of labels.\n   */\n  labels: string[];\n\n  /**\n   * @deprecated\n   */\n  examples: Example[];\n};\n"],"mappings":""}

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

@@ -1,5 +1,14 @@
+import React from 'react';
 import { RenderingContext, PreviewPreview, PreviewModule } from '@teambit/preview';
 import { ComponentID } from '@teambit/component-id';
+import type { Docs } from './docs';
+export declare type DocsRootProps = {
+    Provider: React.ComponentType | undefined;
+    componentId: string;
+    docs: Docs | undefined;
+    compositions: any;
+    context: RenderingContext;
+};
 export declare class DocsPreview {
     /**
      * preview extension.

package/dist/docs.preview.runtime.js

@@ -60,7 +60,25 @@ class DocsPreview {
     this.preview = preview;
     (0, _defineProperty2().default)(this, "render", (componentId, modules, [compositions], context) => {
       const docsModule = this.selectPreviewModel(componentId.fullName, modules);
-      modules.mainModule.default(NoopProvider, componentId.toString(), docsModule, compositions, context);
+      const isObject = !!modules.mainModule.default.apiObject;
+      /**
+       * for backwards compatibility - can be removed end of 2022
+       */
+
+      if (!isObject) {
+        const docsPropsArray = [NoopProvider, componentId.toString(), docsModule, compositions, context];
+        modules.mainModule.default(...docsPropsArray);
+        return;
+      }
+
+      const docsProps = {
+        Provider: NoopProvider,
+        componentId: componentId.toString(),
+        docs: docsModule,
+        compositions,
+        context
+      };
+      modules.mainModule.default(docsProps);
     });
   }
 

package/dist/docs.preview.runtime.js.map

@@ -1 +1 @@
-{"version":3,"names":["DocsPreview","constructor","preview","componentId","modules","compositions","context","docsModule","selectPreviewModel","fullName","mainModule","default","NoopProvider","toString","relevant","componentMap","undefined","provider","docsPreview","registerPreview","name","render","bind","include","PreviewRuntime","PreviewAspect","DocsAspect","addRuntime","children"],"sources":["docs.preview.runtime.tsx"],"sourcesContent":["import React, { ReactNode } from 'react';\nimport { PreviewAspect, RenderingContext, PreviewPreview, PreviewRuntime, PreviewModule } from '@teambit/preview';\nimport { ComponentID } from '@teambit/component-id';\n\nimport { DocsAspect } from './docs.aspect';\n\nexport class DocsPreview {\n  constructor(\n    /**\n     * preview extension.\n     */\n    private preview: PreviewPreview\n  ) {}\n\n  render = (componentId: ComponentID, modules: PreviewModule, [compositions]: [any], context: RenderingContext) => {\n    const docsModule = this.selectPreviewModel(componentId.fullName, modules);\n\n    modules.mainModule.default(NoopProvider, componentId.toString(), docsModule, compositions, context);\n  };\n\n  selectPreviewModel(componentId: string, modules: PreviewModule) {\n    const relevant = modules.componentMap[componentId];\n    if (!relevant) return undefined;\n\n    // only one doc file is supported.\n    return relevant[0];\n  }\n\n  static runtime = PreviewRuntime;\n  static dependencies = [PreviewAspect];\n\n  static async provider([preview]: [PreviewPreview]) {\n    const docsPreview = new DocsPreview(preview);\n    preview.registerPreview({\n      name: 'overview',\n      render: docsPreview.render.bind(docsPreview),\n      selectPreviewModel: docsPreview.selectPreviewModel.bind(docsPreview),\n      include: ['compositions'],\n    });\n\n    return docsPreview;\n  }\n}\n\nDocsAspect.addRuntime(DocsPreview);\n\nfunction NoopProvider({ children }: { children: ReactNode }) {\n  return <>{children}</>;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAGA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEO,MAAMA,WAAN,CAAkB;EACvBC,WAAW;EACT;AACJ;AACA;EACYC,OAJC,EAKT;IAAA,KADQA,OACR,GADQA,OACR;IAAA,gDAEO,CAACC,WAAD,EAA2BC,OAA3B,EAAmD,CAACC,YAAD,CAAnD,EAA0EC,OAA1E,KAAwG;MAC/G,MAAMC,UAAU,GAAG,KAAKC,kBAAL,CAAwBL,WAAW,CAACM,QAApC,EAA8CL,OAA9C,CAAnB;MAEAA,OAAO,CAACM,UAAR,CAAmBC,OAAnB,CAA2BC,YAA3B,EAAyCT,WAAW,CAACU,QAAZ,EAAzC,EAAiEN,UAAjE,EAA6EF,YAA7E,EAA2FC,OAA3F;IACD,CANC;EAAE;;EAQJE,kBAAkB,CAACL,WAAD,EAAsBC,OAAtB,EAA8C;IAC9D,MAAMU,QAAQ,GAAGV,OAAO,CAACW,YAAR,CAAqBZ,WAArB,CAAjB;IACA,IAAI,CAACW,QAAL,EAAe,OAAOE,SAAP,CAF+C,CAI9D;;IACA,OAAOF,QAAQ,CAAC,CAAD,CAAf;EACD;;EAKoB,aAARG,QAAQ,CAAC,CAACf,OAAD,CAAD,EAA8B;IACjD,MAAMgB,WAAW,GAAG,IAAIlB,WAAJ,CAAgBE,OAAhB,CAApB;IACAA,OAAO,CAACiB,eAAR,CAAwB;MACtBC,IAAI,EAAE,UADgB;MAEtBC,MAAM,EAAEH,WAAW,CAACG,MAAZ,CAAmBC,IAAnB,CAAwBJ,WAAxB,CAFc;MAGtBV,kBAAkB,EAAEU,WAAW,CAACV,kBAAZ,CAA+Bc,IAA/B,CAAoCJ,WAApC,CAHE;MAItBK,OAAO,EAAE,CAAC,cAAD;IAJa,CAAxB;IAOA,OAAOL,WAAP;EACD;;AAnCsB;;;gCAAZlB,W,aAsBMwB,yB;gCAtBNxB,W,kBAuBW,CAACyB,wBAAD,C;;AAexBC,kBAAA,CAAWC,UAAX,CAAsB3B,WAAtB;;AAEA,SAASY,YAAT,CAAsB;EAAEgB;AAAF,CAAtB,EAA6D;EAC3D,oBAAO,gEAAGA,QAAH,CAAP;AACD"}
+{"version":3,"names":["DocsPreview","constructor","preview","componentId","modules","compositions","context","docsModule","selectPreviewModel","fullName","isObject","mainModule","default","apiObject","docsPropsArray","NoopProvider","toString","docsProps","Provider","docs","relevant","componentMap","undefined","provider","docsPreview","registerPreview","name","render","bind","include","PreviewRuntime","PreviewAspect","DocsAspect","addRuntime","children"],"sources":["docs.preview.runtime.tsx"],"sourcesContent":["import React, { ReactNode } from 'react';\nimport { PreviewAspect, RenderingContext, PreviewPreview, PreviewRuntime, PreviewModule } from '@teambit/preview';\nimport { ComponentID } from '@teambit/component-id';\n\nimport { DocsAspect } from './docs.aspect';\nimport type { Docs } from './docs';\n\nexport type DocsRootProps = {\n  Provider: React.ComponentType | undefined;\n  componentId: string;\n  docs: Docs | undefined;\n  compositions: any;\n  context: RenderingContext;\n};\n\nexport class DocsPreview {\n  constructor(\n    /**\n     * preview extension.\n     */\n    private preview: PreviewPreview\n  ) {}\n\n  render = (componentId: ComponentID, modules: PreviewModule, [compositions]: [any], context: RenderingContext) => {\n    const docsModule = this.selectPreviewModel(componentId.fullName, modules);\n\n    const isObject = !!modules.mainModule.default.apiObject;\n\n    /**\n     * for backwards compatibility - can be removed end of 2022\n     */\n    if (!isObject) {\n      const docsPropsArray = [\n        NoopProvider as React.ComponentType,\n        componentId.toString(),\n        docsModule as Docs,\n        compositions,\n        context,\n      ];\n      modules.mainModule.default(...docsPropsArray);\n      return;\n    }\n\n    const docsProps: DocsRootProps = {\n      Provider: NoopProvider as React.ComponentType,\n      componentId: componentId.toString(),\n      docs: docsModule as Docs,\n      compositions,\n      context,\n    };\n\n    modules.mainModule.default(docsProps);\n  };\n\n  selectPreviewModel(componentId: string, modules: PreviewModule) {\n    const relevant = modules.componentMap[componentId];\n    if (!relevant) return undefined;\n\n    // only one doc file is supported.\n    return relevant[0];\n  }\n\n  static runtime = PreviewRuntime;\n  static dependencies = [PreviewAspect];\n\n  static async provider([preview]: [PreviewPreview]) {\n    const docsPreview = new DocsPreview(preview);\n    preview.registerPreview({\n      name: 'overview',\n      render: docsPreview.render.bind(docsPreview),\n      selectPreviewModel: docsPreview.selectPreviewModel.bind(docsPreview),\n      include: ['compositions'],\n    });\n\n    return docsPreview;\n  }\n}\n\nDocsAspect.addRuntime(DocsPreview);\n\nfunction NoopProvider({ children }: { children: ReactNode }) {\n  return <>{children}</>;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAGA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAWO,MAAMA,WAAN,CAAkB;EACvBC,WAAW;EACT;AACJ;AACA;EACYC,OAJC,EAKT;IAAA,KADQA,OACR,GADQA,OACR;IAAA,gDAEO,CAACC,WAAD,EAA2BC,OAA3B,EAAmD,CAACC,YAAD,CAAnD,EAA0EC,OAA1E,KAAwG;MAC/G,MAAMC,UAAU,GAAG,KAAKC,kBAAL,CAAwBL,WAAW,CAACM,QAApC,EAA8CL,OAA9C,CAAnB;MAEA,MAAMM,QAAQ,GAAG,CAAC,CAACN,OAAO,CAACO,UAAR,CAAmBC,OAAnB,CAA2BC,SAA9C;MAEA;AACJ;AACA;;MACI,IAAI,CAACH,QAAL,EAAe;QACb,MAAMI,cAAc,GAAG,CACrBC,YADqB,EAErBZ,WAAW,CAACa,QAAZ,EAFqB,EAGrBT,UAHqB,EAIrBF,YAJqB,EAKrBC,OALqB,CAAvB;QAOAF,OAAO,CAACO,UAAR,CAAmBC,OAAnB,CAA2B,GAAGE,cAA9B;QACA;MACD;;MAED,MAAMG,SAAwB,GAAG;QAC/BC,QAAQ,EAAEH,YADqB;QAE/BZ,WAAW,EAAEA,WAAW,CAACa,QAAZ,EAFkB;QAG/BG,IAAI,EAAEZ,UAHyB;QAI/BF,YAJ+B;QAK/BC;MAL+B,CAAjC;MAQAF,OAAO,CAACO,UAAR,CAAmBC,OAAnB,CAA2BK,SAA3B;IACD,CA/BC;EAAE;;EAiCJT,kBAAkB,CAACL,WAAD,EAAsBC,OAAtB,EAA8C;IAC9D,MAAMgB,QAAQ,GAAGhB,OAAO,CAACiB,YAAR,CAAqBlB,WAArB,CAAjB;IACA,IAAI,CAACiB,QAAL,EAAe,OAAOE,SAAP,CAF+C,CAI9D;;IACA,OAAOF,QAAQ,CAAC,CAAD,CAAf;EACD;;EAKoB,aAARG,QAAQ,CAAC,CAACrB,OAAD,CAAD,EAA8B;IACjD,MAAMsB,WAAW,GAAG,IAAIxB,WAAJ,CAAgBE,OAAhB,CAApB;IACAA,OAAO,CAACuB,eAAR,CAAwB;MACtBC,IAAI,EAAE,UADgB;MAEtBC,MAAM,EAAEH,WAAW,CAACG,MAAZ,CAAmBC,IAAnB,CAAwBJ,WAAxB,CAFc;MAGtBhB,kBAAkB,EAAEgB,WAAW,CAAChB,kBAAZ,CAA+BoB,IAA/B,CAAoCJ,WAApC,CAHE;MAItBK,OAAO,EAAE,CAAC,cAAD;IAJa,CAAxB;IAOA,OAAOL,WAAP;EACD;;AA5DsB;;;gCAAZxB,W,aA+CM8B,yB;gCA/CN9B,W,kBAgDW,CAAC+B,wBAAD,C;;AAexBC,kBAAA,CAAWC,UAAX,CAAsBjC,WAAtB;;AAEA,SAASe,YAAT,CAAsB;EAAEmB;AAAF,CAAtB,EAA6D;EAC3D,oBAAO,gEAAGA,QAAH,CAAP;AACD"}

package/dist/index.d.ts

@@ -6,8 +6,9 @@ import { DocsAspect } from './docs.aspect';
 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 } from './docs.preview.runtime';
+export type { DocsPreview, DocsRootProps } from './docs.preview.runtime';
 export type { DocReader } from './doc-reader';
+export type { Docs, Example } from './docs';
 export type { TitleBadgeSlot } from './overview';
 export { Overview } from './overview';
 export { DocsAspect };

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["DocsAspect"],"sources":["index.ts"],"sourcesContent":["import { DocsAspect } from './docs.aspect';\n\n/**\n * Doc entity.\n * @deprecated - please dont use this. use directly from @teambit/docs.entities.doc.\n */\nexport { Doc, DocProp, DocPropList } from '@teambit/docs.entities.doc';\n\nexport type { DocsMain } from './docs.main.runtime';\nexport type { DocsUI } from './docs.ui.runtime';\nexport type { DocsPreview } from './docs.preview.runtime';\nexport type { DocReader } from './doc-reader';\n\nexport type { TitleBadgeSlot } from './overview';\nexport { Overview } from './overview';\n\nexport { DocsAspect };\nexport default DocsAspect;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAMA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAQA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAZA;AACA;AACA;AACA;eAYeA,kB"}
+{"version":3,"names":["DocsAspect"],"sources":["index.ts"],"sourcesContent":["import { DocsAspect } from './docs.aspect';\n\n/**\n * Doc entity.\n * @deprecated - please dont use this. use directly from @teambit/docs.entities.doc.\n */\nexport { Doc, DocProp, DocPropList } from '@teambit/docs.entities.doc';\n\nexport type { DocsMain } from './docs.main.runtime';\nexport type { DocsUI } from './docs.ui.runtime';\nexport type { DocsPreview, DocsRootProps } from './docs.preview.runtime';\nexport type { DocReader } from './doc-reader';\nexport type { Docs, Example } from './docs';\n\nexport type { TitleBadgeSlot } from './overview';\nexport { Overview } from './overview';\n\nexport { DocsAspect };\nexport default DocsAspect;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAMA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AASA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAbA;AACA;AACA;AACA;eAaeA,kB"}

package/docs.preview.runtime.tsx

@@ -3,6 +3,15 @@ import { PreviewAspect, RenderingContext, PreviewPreview, PreviewRuntime, Previe
 import { ComponentID } from '@teambit/component-id';
 
 import { DocsAspect } from './docs.aspect';
+import type { Docs } from './docs';
+
+export type DocsRootProps = {
+  Provider: React.ComponentType | undefined;
+  componentId: string;
+  docs: Docs | undefined;
+  compositions: any;
+  context: RenderingContext;
+};
 
 export class DocsPreview {
   constructor(
@@ -15,7 +24,32 @@ export class DocsPreview {
   render = (componentId: ComponentID, modules: PreviewModule, [compositions]: [any], context: RenderingContext) => {
     const docsModule = this.selectPreviewModel(componentId.fullName, modules);
 
-    modules.mainModule.default(NoopProvider, componentId.toString(), docsModule, compositions, context);
+    const isObject = !!modules.mainModule.default.apiObject;
+
+    /**
+     * for backwards compatibility - can be removed end of 2022
+     */
+    if (!isObject) {
+      const docsPropsArray = [
+        NoopProvider as React.ComponentType,
+        componentId.toString(),
+        docsModule as Docs,
+        compositions,
+        context,
+      ];
+      modules.mainModule.default(...docsPropsArray);
+      return;
+    }
+
+    const docsProps: DocsRootProps = {
+      Provider: NoopProvider as React.ComponentType,
+      componentId: componentId.toString(),
+      docs: docsModule as Docs,
+      compositions,
+      context,
+    };
+
+    modules.mainModule.default(docsProps);
   };
 
   selectPreviewModel(componentId: string, modules: PreviewModule) {

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/docs",
-  "version": "0.0.785",
+  "version": "0.0.786",
   "homepage": "https://bit.dev/teambit/docs/docs",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.docs",
     "name": "docs",
-    "version": "0.0.785"
+    "version": "0.0.786"
   },
   "dependencies": {
     "graphql-tag": "2.12.1",
@@ -15,23 +15,23 @@
     "core-js": "^3.0.0",
     "@teambit/harmony": "0.3.3",
     "@teambit/design.ui.separator": "0.0.354",
-    "@teambit/compiler": "0.0.785",
-    "@teambit/component": "0.0.785",
+    "@teambit/compiler": "0.0.786",
+    "@teambit/component": "0.0.786",
     "@teambit/docs.entities.doc": "0.0.3",
-    "@teambit/pkg": "0.0.785",
-    "@teambit/workspace": "0.0.785",
+    "@teambit/pkg": "0.0.786",
+    "@teambit/workspace": "0.0.786",
     "@teambit/docs.ui.overview-compare": "0.0.26",
     "@teambit/cli": "0.0.519",
-    "@teambit/dev-files": "0.0.785",
-    "@teambit/envs": "0.0.785",
-    "@teambit/graphql": "0.0.785",
+    "@teambit/dev-files": "0.0.786",
+    "@teambit/envs": "0.0.786",
+    "@teambit/graphql": "0.0.786",
     "@teambit/logger": "0.0.612",
-    "@teambit/preview": "0.0.785",
+    "@teambit/preview": "0.0.786",
     "@teambit/component-id": "0.0.402",
-    "@teambit/component-compare": "0.0.33",
+    "@teambit/component-compare": "0.0.34",
     "@teambit/component.ui.component-meta": "0.0.79",
-    "@teambit/ui": "0.0.785",
-    "@teambit/pubsub": "0.0.785",
+    "@teambit/ui": "0.0.786",
+    "@teambit/pubsub": "0.0.786",
     "@teambit/design.ui.surfaces.status-message-card": "0.0.8",
     "@teambit/lanes.ui.lanes": "0.0.87",
     "@teambit/preview.ui.component-preview": "0.0.493"

package/{preview-1657337177086.js → preview-1657510339341.js}

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