@teambit/docs 1.0.371 → 1.0.373

package/artifacts/schema.json

@@ -1747,7 +1747,7 @@
                 "line": 24,
                 "character": 3
               },
-              "signature": "(property) DocsPreview.render: (componentId: ComponentID, envId: string, modules: PreviewModule, [compositions]: [any], context: RenderingContext) => void",
+              "signature": "(property) DocsPreview.render: (componentId: ComponentID, envId: string, modules: PreviewModule, [compositionsFromParams]: [any], context: RenderingContext) => void",
               "name": "render",
               "type": {
                 "__schema": "InferenceTypeSchema",
@@ -1756,16 +1756,16 @@
                   "line": 24,
                   "character": 3
                 },
-                "type": "(componentId: ComponentID, envId: string, modules: PreviewModule, [compositions]: [any], context: RenderingContext) => void"
+                "type": "(componentId: ComponentID, envId: string, modules: PreviewModule, [compositionsFromParams]: [any], context: RenderingContext) => void"
               },
               "isOptional": true,
-              "defaultValue": "(\n    componentId: ComponentID,\n    envId: string,\n    modules: PreviewModule,\n    [compositions]: [any],\n    context: RenderingContext\n  ) => {\n    const docsModule = this.selectPreviewModel(componentId.fullName, modules);\n\n    const mainModule = modules.modulesMap[envId] || modules.modulesMap.default;\n    let defaultExports = mainModule.default;\n    // Sometime when using ESM (package.json with type:\"module\") the default export is nested under \"default\"\n    if (typeof defaultExports !== 'function' && defaultExports.default) {\n      defaultExports = defaultExports.default;\n    }\n    // @ts-ignore Gilad - to fix.\n    const isObject = !!defaultExports.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      // @ts-ignore Gilad - to fix. it happens because defaultExports might be a func or an object (handled above)\n      defaultExports(...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    // @ts-ignore Gilad - to fix. it happens because defaultExports might be a func or an object (handled above)\n    defaultExports(docsProps);\n  }"
+              "defaultValue": "(\n    componentId: ComponentID,\n    envId: string,\n    modules: PreviewModule,\n    [compositionsFromParams]: [any],\n    context: RenderingContext\n  ) => {\n    const docsModule = this.selectPreviewModel(componentId.fullName, modules);\n    const compositions = compositionsFromParams || [];\n\n    const mainModule = modules.modulesMap[envId] || modules.modulesMap.default;\n    let defaultExports = mainModule.default;\n    // Sometime when using ESM (package.json with type:\"module\") the default export is nested under \"default\"\n    if (typeof defaultExports !== 'function' && defaultExports.default) {\n      defaultExports = defaultExports.default;\n    }\n    // @ts-ignore Gilad - to fix.\n    const isObject = !!defaultExports.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      // @ts-ignore Gilad - to fix. it happens because defaultExports might be a func or an object (handled above)\n      defaultExports(...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    // @ts-ignore Gilad - to fix. it happens because defaultExports might be a func or an object (handled above)\n    defaultExports(docsProps);\n  }"
             },
             {
               "__schema": "FunctionLikeSchema",
               "location": {
                 "filePath": "docs.preview.runtime.tsx",
-                "line": 69,
+                "line": 70,
                 "character": 3
               },
               "signature": "(method) DocsPreview.selectPreviewModel(componentId: string, modules: PreviewModule): ModuleFile<any> | undefined",
@@ -1775,7 +1775,7 @@
                   "__schema": "ParameterSchema",
                   "location": {
                     "filePath": "docs.preview.runtime.tsx",
-                    "line": 69,
+                    "line": 70,
                     "character": 22
                   },
                   "name": "componentId",
@@ -1783,7 +1783,7 @@
                     "__schema": "KeywordTypeSchema",
                     "location": {
                       "filePath": "docs.preview.runtime.tsx",
-                      "line": 69,
+                      "line": 70,
                       "character": 35
                     },
                     "name": "string"
@@ -1795,7 +1795,7 @@
                   "__schema": "ParameterSchema",
                   "location": {
                     "filePath": "docs.preview.runtime.tsx",
-                    "line": 69,
+                    "line": 70,
                     "character": 43
                   },
                   "name": "modules",
@@ -1803,7 +1803,7 @@
                     "__schema": "TypeRefSchema",
                     "location": {
                       "filePath": "docs.preview.runtime.tsx",
-                      "line": 69,
+                      "line": 70,
                       "character": 52
                     },
                     "name": "PreviewModule"
@@ -1816,7 +1816,7 @@
                 "__schema": "InferenceTypeSchema",
                 "location": {
                   "filePath": "docs.preview.runtime.tsx",
-                  "line": 69,
+                  "line": 70,
                   "character": 3
                 },
                 "type": "ModuleFile<any> | undefined"
@@ -1827,7 +1827,7 @@
               "__schema": "VariableLikeSchema",
               "location": {
                 "filePath": "docs.preview.runtime.tsx",
-                "line": 77,
+                "line": 78,
                 "character": 3
               },
               "signature": "(property) DocsPreview.runtime: RuntimeDefinition",
@@ -1836,7 +1836,7 @@
                 "__schema": "InferenceTypeSchema",
                 "location": {
                   "filePath": "docs.preview.runtime.tsx",
-                  "line": 77,
+                  "line": 78,
                   "character": 3
                 },
                 "type": "RuntimeDefinition"
@@ -1848,7 +1848,7 @@
               "__schema": "VariableLikeSchema",
               "location": {
                 "filePath": "docs.preview.runtime.tsx",
-                "line": 78,
+                "line": 79,
                 "character": 3
               },
               "signature": "(property) DocsPreview.dependencies: Aspect[]",
@@ -1857,7 +1857,7 @@
                 "__schema": "InferenceTypeSchema",
                 "location": {
                   "filePath": "docs.preview.runtime.tsx",
-                  "line": 78,
+                  "line": 79,
                   "character": 3
                 },
                 "type": "Aspect[]"
@@ -1869,7 +1869,7 @@
               "__schema": "FunctionLikeSchema",
               "location": {
                 "filePath": "docs.preview.runtime.tsx",
-                "line": 80,
+                "line": 81,
                 "character": 3
               },
               "signature": "(method) DocsPreview.provider([preview]: [PreviewPreview]): Promise<DocsPreview>",
@@ -1879,7 +1879,7 @@
                   "__schema": "ParameterSchema",
                   "location": {
                     "filePath": "docs.preview.runtime.tsx",
-                    "line": 80,
+                    "line": 81,
                     "character": 25
                   },
                   "name": "[ preview ]",
@@ -1887,7 +1887,7 @@
                     "__schema": "TupleTypeSchema",
                     "location": {
                       "filePath": "docs.preview.runtime.tsx",
-                      "line": 80,
+                      "line": 81,
                       "character": 36
                     },
                     "elements": [
@@ -1895,7 +1895,7 @@
                         "__schema": "TypeRefSchema",
                         "location": {
                           "filePath": "docs.preview.runtime.tsx",
-                          "line": 80,
+                          "line": 81,
                           "character": 37
                         },
                         "name": "PreviewPreview"
@@ -1910,7 +1910,7 @@
                 "__schema": "InferenceTypeSchema",
                 "location": {
                   "filePath": "docs.preview.runtime.tsx",
-                  "line": 80,
+                  "line": 81,
                   "character": 3
                 },
                 "type": "Promise<DocsPreview>"
@@ -1940,7 +1940,7 @@
             "line": 8,
             "character": 1
           },
-          "signature": "type DocsRootProps = {\n    Provider: React.ComponentType | undefined;\n    componentId: string;\n    docs: Docs | undefined;\n    compositions: any;\n    context: RenderingContext;\n}",
+          "signature": "type DocsRootProps = {\n    Provider: React.ComponentType | undefined;\n    componentId: string;\n    docs: Docs | undefined;\n    compositions?: any;\n    context: RenderingContext;\n}",
           "name": "DocsRootProps",
           "type": {
             "__schema": "TypeLiteralSchema",
@@ -2055,18 +2055,18 @@
                   "line": 12,
                   "character": 3
                 },
-                "signature": "(property) compositions: any",
+                "signature": "(property) compositions?: any",
                 "name": "compositions",
                 "type": {
                   "__schema": "KeywordTypeSchema",
                   "location": {
                     "filePath": "docs.preview.runtime.tsx",
                     "line": 12,
-                    "character": 17
+                    "character": 18
                   },
                   "name": "any"
                 },
-                "isOptional": false
+                "isOptional": true
               },
               {
                 "__schema": "VariableLikeSchema",
@@ -4997,7 +4997,7 @@
             "line": 8,
             "character": 1
           },
-          "signature": "type DocsRootProps = {\n    Provider: React.ComponentType | undefined;\n    componentId: string;\n    docs: Docs | undefined;\n    compositions: any;\n    context: RenderingContext;\n}",
+          "signature": "type DocsRootProps = {\n    Provider: React.ComponentType | undefined;\n    componentId: string;\n    docs: Docs | undefined;\n    compositions?: any;\n    context: RenderingContext;\n}",
           "name": "DocsRootProps",
           "type": {
             "__schema": "TypeLiteralSchema",
@@ -5112,18 +5112,18 @@
                   "line": 12,
                   "character": 3
                 },
-                "signature": "(property) compositions: any",
+                "signature": "(property) compositions?: any",
                 "name": "compositions",
                 "type": {
                   "__schema": "KeywordTypeSchema",
                   "location": {
                     "filePath": "docs.preview.runtime.tsx",
                     "line": 12,
-                    "character": 17
+                    "character": 18
                   },
                   "name": "any"
                 },
-                "isOptional": false
+                "isOptional": true
               },
               {
                 "__schema": "VariableLikeSchema",
@@ -5211,7 +5211,7 @@
                 "line": 24,
                 "character": 3
               },
-              "signature": "(property) DocsPreview.render: (componentId: ComponentID, envId: string, modules: PreviewModule, [compositions]: [any], context: RenderingContext) => void",
+              "signature": "(property) DocsPreview.render: (componentId: ComponentID, envId: string, modules: PreviewModule, [compositionsFromParams]: [any], context: RenderingContext) => void",
               "name": "render",
               "type": {
                 "__schema": "InferenceTypeSchema",
@@ -5220,16 +5220,16 @@
                   "line": 24,
                   "character": 3
                 },
-                "type": "(componentId: ComponentID, envId: string, modules: PreviewModule, [compositions]: [any], context: RenderingContext) => void"
+                "type": "(componentId: ComponentID, envId: string, modules: PreviewModule, [compositionsFromParams]: [any], context: RenderingContext) => void"
               },
               "isOptional": true,
-              "defaultValue": "(\n    componentId: ComponentID,\n    envId: string,\n    modules: PreviewModule,\n    [compositions]: [any],\n    context: RenderingContext\n  ) => {\n    const docsModule = this.selectPreviewModel(componentId.fullName, modules);\n\n    const mainModule = modules.modulesMap[envId] || modules.modulesMap.default;\n    let defaultExports = mainModule.default;\n    // Sometime when using ESM (package.json with type:\"module\") the default export is nested under \"default\"\n    if (typeof defaultExports !== 'function' && defaultExports.default) {\n      defaultExports = defaultExports.default;\n    }\n    // @ts-ignore Gilad - to fix.\n    const isObject = !!defaultExports.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      // @ts-ignore Gilad - to fix. it happens because defaultExports might be a func or an object (handled above)\n      defaultExports(...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    // @ts-ignore Gilad - to fix. it happens because defaultExports might be a func or an object (handled above)\n    defaultExports(docsProps);\n  }"
+              "defaultValue": "(\n    componentId: ComponentID,\n    envId: string,\n    modules: PreviewModule,\n    [compositionsFromParams]: [any],\n    context: RenderingContext\n  ) => {\n    const docsModule = this.selectPreviewModel(componentId.fullName, modules);\n    const compositions = compositionsFromParams || [];\n\n    const mainModule = modules.modulesMap[envId] || modules.modulesMap.default;\n    let defaultExports = mainModule.default;\n    // Sometime when using ESM (package.json with type:\"module\") the default export is nested under \"default\"\n    if (typeof defaultExports !== 'function' && defaultExports.default) {\n      defaultExports = defaultExports.default;\n    }\n    // @ts-ignore Gilad - to fix.\n    const isObject = !!defaultExports.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      // @ts-ignore Gilad - to fix. it happens because defaultExports might be a func or an object (handled above)\n      defaultExports(...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    // @ts-ignore Gilad - to fix. it happens because defaultExports might be a func or an object (handled above)\n    defaultExports(docsProps);\n  }"
             },
             {
               "__schema": "FunctionLikeSchema",
               "location": {
                 "filePath": "docs.preview.runtime.tsx",
-                "line": 69,
+                "line": 70,
                 "character": 3
               },
               "signature": "(method) DocsPreview.selectPreviewModel(componentId: string, modules: PreviewModule): ModuleFile<any> | undefined",
@@ -5239,7 +5239,7 @@
                   "__schema": "ParameterSchema",
                   "location": {
                     "filePath": "docs.preview.runtime.tsx",
-                    "line": 69,
+                    "line": 70,
                     "character": 22
                   },
                   "name": "componentId",
@@ -5247,7 +5247,7 @@
                     "__schema": "KeywordTypeSchema",
                     "location": {
                       "filePath": "docs.preview.runtime.tsx",
-                      "line": 69,
+                      "line": 70,
                       "character": 35
                     },
                     "name": "string"
@@ -5259,7 +5259,7 @@
                   "__schema": "ParameterSchema",
                   "location": {
                     "filePath": "docs.preview.runtime.tsx",
-                    "line": 69,
+                    "line": 70,
                     "character": 43
                   },
                   "name": "modules",
@@ -5267,7 +5267,7 @@
                     "__schema": "TypeRefSchema",
                     "location": {
                       "filePath": "docs.preview.runtime.tsx",
-                      "line": 69,
+                      "line": 70,
                       "character": 52
                     },
                     "name": "PreviewModule"
@@ -5280,7 +5280,7 @@
                 "__schema": "InferenceTypeSchema",
                 "location": {
                   "filePath": "docs.preview.runtime.tsx",
-                  "line": 69,
+                  "line": 70,
                   "character": 3
                 },
                 "type": "ModuleFile<any> | undefined"
@@ -5291,7 +5291,7 @@
               "__schema": "VariableLikeSchema",
               "location": {
                 "filePath": "docs.preview.runtime.tsx",
-                "line": 77,
+                "line": 78,
                 "character": 3
               },
               "signature": "(property) DocsPreview.runtime: RuntimeDefinition",
@@ -5300,7 +5300,7 @@
                 "__schema": "InferenceTypeSchema",
                 "location": {
                   "filePath": "docs.preview.runtime.tsx",
-                  "line": 77,
+                  "line": 78,
                   "character": 3
                 },
                 "type": "RuntimeDefinition"
@@ -5312,7 +5312,7 @@
               "__schema": "VariableLikeSchema",
               "location": {
                 "filePath": "docs.preview.runtime.tsx",
-                "line": 78,
+                "line": 79,
                 "character": 3
               },
               "signature": "(property) DocsPreview.dependencies: Aspect[]",
@@ -5321,7 +5321,7 @@
                 "__schema": "InferenceTypeSchema",
                 "location": {
                   "filePath": "docs.preview.runtime.tsx",
-                  "line": 78,
+                  "line": 79,
                   "character": 3
                 },
                 "type": "Aspect[]"
@@ -5333,7 +5333,7 @@
               "__schema": "FunctionLikeSchema",
               "location": {
                 "filePath": "docs.preview.runtime.tsx",
-                "line": 80,
+                "line": 81,
                 "character": 3
               },
               "signature": "(method) DocsPreview.provider([preview]: [PreviewPreview]): Promise<DocsPreview>",
@@ -5343,7 +5343,7 @@
                   "__schema": "ParameterSchema",
                   "location": {
                     "filePath": "docs.preview.runtime.tsx",
-                    "line": 80,
+                    "line": 81,
                     "character": 25
                   },
                   "name": "[ preview ]",
@@ -5351,7 +5351,7 @@
                     "__schema": "TupleTypeSchema",
                     "location": {
                       "filePath": "docs.preview.runtime.tsx",
-                      "line": 80,
+                      "line": 81,
                       "character": 36
                     },
                     "elements": [
@@ -5359,7 +5359,7 @@
                         "__schema": "TypeRefSchema",
                         "location": {
                           "filePath": "docs.preview.runtime.tsx",
-                          "line": 80,
+                          "line": 81,
                           "character": 37
                         },
                         "name": "PreviewPreview"
@@ -5374,7 +5374,7 @@
                 "__schema": "InferenceTypeSchema",
                 "location": {
                   "filePath": "docs.preview.runtime.tsx",
-                  "line": 80,
+                  "line": 81,
                   "character": 3
                 },
                 "type": "Promise<DocsPreview>"
@@ -5394,7 +5394,7 @@
           "__schema": "UnImplementedSchema",
           "location": {
             "filePath": "docs.preview.runtime.tsx",
-            "line": 93,
+            "line": 94,
             "character": 1
           },
           "name": "DocsAspect.addRuntime(DocsPreview);",
@@ -5404,7 +5404,7 @@
           "__schema": "ReactSchema",
           "location": {
             "filePath": "docs.preview.runtime.tsx",
-            "line": 95,
+            "line": 96,
             "character": 1
           },
           "signature": "function NoopProvider({ children }: {\n    children: ReactNode;\n}): React.JSX.Element",
@@ -5413,7 +5413,7 @@
             "__schema": "ParameterSchema",
             "location": {
               "filePath": "docs.preview.runtime.tsx",
-              "line": 95,
+              "line": 96,
               "character": 23
             },
             "name": "{ children }",
@@ -5421,7 +5421,7 @@
               "__schema": "TypeLiteralSchema",
               "location": {
                 "filePath": "docs.preview.runtime.tsx",
-                "line": 95,
+                "line": 96,
                 "character": 37
               },
               "members": [
@@ -5429,7 +5429,7 @@
                   "__schema": "VariableLikeSchema",
                   "location": {
                     "filePath": "docs.preview.runtime.tsx",
-                    "line": 95,
+                    "line": 96,
                     "character": 39
                   },
                   "signature": "(property) children: React.ReactNode",
@@ -5438,7 +5438,7 @@
                     "__schema": "TypeRefSchema",
                     "location": {
                       "filePath": "docs.preview.runtime.tsx",
-                      "line": 95,
+                      "line": 96,
                       "character": 49
                     },
                     "name": "ReactNode"
@@ -5453,7 +5453,7 @@
                 "__schema": "VariableLikeSchema",
                 "location": {
                   "filePath": "docs.preview.runtime.tsx",
-                  "line": 95,
+                  "line": 96,
                   "character": 39
                 },
                 "signature": "(property) children: React.ReactNode",
@@ -5462,7 +5462,7 @@
                   "__schema": "TypeRefSchema",
                   "location": {
                     "filePath": "docs.preview.runtime.tsx",
-                    "line": 95,
+                    "line": 96,
                     "character": 49
                   },
                   "name": "ReactNode"
@@ -5476,7 +5476,7 @@
             "__schema": "TypeRefSchema",
             "location": {
               "filePath": "docs.preview.runtime.tsx",
-              "line": 95,
+              "line": 96,
               "character": 1
             },
             "name": "React.JSX.Element",
@@ -6667,7 +6667,7 @@
   "componentId": {
     "scope": "teambit.docs",
     "name": "docs",
-    "version": "1.0.371"
+    "version": "1.0.373"
   },
   "taggedModuleExports": []
 }

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

@@ -6,7 +6,7 @@ export type DocsRootProps = {
     Provider: React.ComponentType | undefined;
     componentId: string;
     docs: Docs | undefined;
-    compositions: any;
+    compositions?: any;
     context: RenderingContext;
 };
 export declare class DocsPreview {
@@ -19,7 +19,7 @@ export declare class DocsPreview {
      * preview extension.
      */
     preview: PreviewPreview);
-    render: (componentId: ComponentID, envId: string, modules: PreviewModule, [compositions]: [any], context: RenderingContext) => void;
+    render: (componentId: ComponentID, envId: string, modules: PreviewModule, [compositionsFromParams]: [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[];

package/dist/docs.preview.runtime.js

@@ -36,8 +36,9 @@ class DocsPreview {
    */
   preview) {
     this.preview = preview;
-    _defineProperty(this, "render", (componentId, envId, modules, [compositions], context) => {
+    _defineProperty(this, "render", (componentId, envId, modules, [compositionsFromParams], context) => {
       const docsModule = this.selectPreviewModel(componentId.fullName, modules);
+      const compositions = compositionsFromParams || [];
       const mainModule = modules.modulesMap[envId] || modules.modulesMap.default;
       let defaultExports = mainModule.default;
       // Sometime when using ESM (package.json with type:"module") the default export is nested under "default"

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

@@ -1 +1 @@
-{"version":3,"names":["_react","data","_interopRequireDefault","require","_preview","_docs","e","__esModule","default","_defineProperty","r","t","_toPropertyKey","Object","defineProperty","value","enumerable","configurable","writable","i","_toPrimitive","Symbol","toPrimitive","call","TypeError","String","Number","DocsPreview","constructor","preview","componentId","envId","modules","compositions","context","docsModule","selectPreviewModel","fullName","mainModule","modulesMap","defaultExports","isObject","apiObject","docsPropsArray","NoopProvider","toString","docsProps","Provider","docs","relevant","componentMap","undefined","provider","docsPreview","registerPreview","name","render","bind","include","exports","PreviewRuntime","PreviewAspect","DocsAspect","addRuntime","children","createElement","Fragment"],"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 = (\n    componentId: ComponentID,\n    envId: string,\n    modules: PreviewModule,\n    [compositions]: [any],\n    context: RenderingContext\n  ) => {\n    const docsModule = this.selectPreviewModel(componentId.fullName, modules);\n\n    const mainModule = modules.modulesMap[envId] || modules.modulesMap.default;\n    let defaultExports = mainModule.default;\n    // Sometime when using ESM (package.json with type:\"module\") the default export is nested under \"default\"\n    if (typeof defaultExports !== 'function' && defaultExports.default) {\n      defaultExports = defaultExports.default;\n    }\n    // @ts-ignore Gilad - to fix.\n    const isObject = !!defaultExports.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      // @ts-ignore Gilad - to fix. it happens because defaultExports might be a func or an object (handled above)\n      defaultExports(...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    // @ts-ignore Gilad - to fix. it happens because defaultExports might be a func or an object (handled above)\n    defaultExports(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,SAAAA,OAAA;EAAA,MAAAC,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAH,MAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAG,SAAA;EAAA,MAAAH,IAAA,GAAAE,OAAA;EAAAC,QAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAGA,SAAAI,MAAA;EAAA,MAAAJ,IAAA,GAAAE,OAAA;EAAAE,KAAA,YAAAA,CAAA;IAAA,OAAAJ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAA2C,SAAAC,uBAAAI,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,SAAAG,gBAAAH,CAAA,EAAAI,CAAA,EAAAC,CAAA,YAAAD,CAAA,GAAAE,cAAA,CAAAF,CAAA,MAAAJ,CAAA,GAAAO,MAAA,CAAAC,cAAA,CAAAR,CAAA,EAAAI,CAAA,IAAAK,KAAA,EAAAJ,CAAA,EAAAK,UAAA,MAAAC,YAAA,MAAAC,QAAA,UAAAZ,CAAA,CAAAI,CAAA,IAAAC,CAAA,EAAAL,CAAA;AAAA,SAAAM,eAAAD,CAAA,QAAAQ,CAAA,GAAAC,YAAA,CAAAT,CAAA,uCAAAQ,CAAA,GAAAA,CAAA,GAAAA,CAAA;AAAA,SAAAC,aAAAT,CAAA,EAAAD,CAAA,2BAAAC,CAAA,KAAAA,CAAA,SAAAA,CAAA,MAAAL,CAAA,GAAAK,CAAA,CAAAU,MAAA,CAAAC,WAAA,kBAAAhB,CAAA,QAAAa,CAAA,GAAAb,CAAA,CAAAiB,IAAA,CAAAZ,CAAA,EAAAD,CAAA,uCAAAS,CAAA,SAAAA,CAAA,YAAAK,SAAA,yEAAAd,CAAA,GAAAe,MAAA,GAAAC,MAAA,EAAAf,CAAA;AAWpC,MAAMgB,WAAW,CAAC;EACvBC,WAAWA;EACT;AACJ;AACA;EACYC,OAAuB,EAC/B;IAAA,KADQA,OAAuB,GAAvBA,OAAuB;IAAApB,eAAA,iBAGxB,CACPqB,WAAwB,EACxBC,KAAa,EACbC,OAAsB,EACtB,CAACC,YAAY,CAAQ,EACrBC,OAAyB,KACtB;MACH,MAAMC,UAAU,GAAG,IAAI,CAACC,kBAAkB,CAACN,WAAW,CAACO,QAAQ,EAAEL,OAAO,CAAC;MAEzE,MAAMM,UAAU,GAAGN,OAAO,CAACO,UAAU,CAACR,KAAK,CAAC,IAAIC,OAAO,CAACO,UAAU,CAAC/B,OAAO;MAC1E,IAAIgC,cAAc,GAAGF,UAAU,CAAC9B,OAAO;MACvC;MACA,IAAI,OAAOgC,cAAc,KAAK,UAAU,IAAIA,cAAc,CAAChC,OAAO,EAAE;QAClEgC,cAAc,GAAGA,cAAc,CAAChC,OAAO;MACzC;MACA;MACA,MAAMiC,QAAQ,GAAG,CAAC,CAACD,cAAc,CAACE,SAAS;;MAE3C;AACJ;AACA;MACI,IAAI,CAACD,QAAQ,EAAE;QACb,MAAME,cAAc,GAAG,CACrBC,YAAY,EACZd,WAAW,CAACe,QAAQ,CAAC,CAAC,EACtBV,UAAU,EACVF,YAAY,EACZC,OAAO,CACR;QACD;QACAM,cAAc,CAAC,GAAGG,cAAc,CAAC;QACjC;MACF;MAEA,MAAMG,SAAwB,GAAG;QAC/BC,QAAQ,EAAEH,YAAmC;QAC7Cd,WAAW,EAAEA,WAAW,CAACe,QAAQ,CAAC,CAAC;QACnCG,IAAI,EAAEb,UAAkB;QACxBF,YAAY;QACZC;MACF,CAAC;MACD;MACAM,cAAc,CAACM,SAAS,CAAC;IAC3B,CAAC;EA7CE;EA+CHV,kBAAkBA,CAACN,WAAmB,EAAEE,OAAsB,EAAE;IAC9D,MAAMiB,QAAQ,GAAGjB,OAAO,CAACkB,YAAY,CAACpB,WAAW,CAAC;IAClD,IAAI,CAACmB,QAAQ,EAAE,OAAOE,SAAS;;IAE/B;IACA,OAAOF,QAAQ,CAAC,CAAC,CAAC;EACpB;EAKA,aAAaG,QAAQA,CAAC,CAACvB,OAAO,CAAmB,EAAE;IACjD,MAAMwB,WAAW,GAAG,IAAI1B,WAAW,CAACE,OAAO,CAAC;IAC5CA,OAAO,CAACyB,eAAe,CAAC;MACtBC,IAAI,EAAE,UAAU;MAChBC,MAAM,EAAEH,WAAW,CAACG,MAAM,CAACC,IAAI,CAACJ,WAAW,CAAC;MAC5CjB,kBAAkB,EAAEiB,WAAW,CAACjB,kBAAkB,CAACqB,IAAI,CAACJ,WAAW,CAAC;MACpEK,OAAO,EAAE,CAAC,cAAc;IAC1B,CAAC,CAAC;IAEF,OAAOL,WAAW;EACpB;AACF;AAACM,OAAA,CAAAhC,WAAA,GAAAA,WAAA;AAAAlB,eAAA,CA3EYkB,WAAW,aA6DLiC,yBAAc;AAAAnD,eAAA,CA7DpBkB,WAAW,kBA8DA,CAACkC,wBAAa,CAAC;AAevCC,kBAAU,CAACC,UAAU,CAACpC,WAAW,CAAC;AAElC,SAASiB,YAAYA,CAAC;EAAEoB;AAAkC,CAAC,EAAE;EAC3D,oBAAOhE,MAAA,GAAAQ,OAAA,CAAAyD,aAAA,CAAAjE,MAAA,GAAAQ,OAAA,CAAA0D,QAAA,QAAGF,QAAW,CAAC;AACxB","ignoreList":[]}
+{"version":3,"names":["_react","data","_interopRequireDefault","require","_preview","_docs","e","__esModule","default","_defineProperty","r","t","_toPropertyKey","Object","defineProperty","value","enumerable","configurable","writable","i","_toPrimitive","Symbol","toPrimitive","call","TypeError","String","Number","DocsPreview","constructor","preview","componentId","envId","modules","compositionsFromParams","context","docsModule","selectPreviewModel","fullName","compositions","mainModule","modulesMap","defaultExports","isObject","apiObject","docsPropsArray","NoopProvider","toString","docsProps","Provider","docs","relevant","componentMap","undefined","provider","docsPreview","registerPreview","name","render","bind","include","exports","PreviewRuntime","PreviewAspect","DocsAspect","addRuntime","children","createElement","Fragment"],"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 = (\n    componentId: ComponentID,\n    envId: string,\n    modules: PreviewModule,\n    [compositionsFromParams]: [any],\n    context: RenderingContext\n  ) => {\n    const docsModule = this.selectPreviewModel(componentId.fullName, modules);\n    const compositions = compositionsFromParams || [];\n\n    const mainModule = modules.modulesMap[envId] || modules.modulesMap.default;\n    let defaultExports = mainModule.default;\n    // Sometime when using ESM (package.json with type:\"module\") the default export is nested under \"default\"\n    if (typeof defaultExports !== 'function' && defaultExports.default) {\n      defaultExports = defaultExports.default;\n    }\n    // @ts-ignore Gilad - to fix.\n    const isObject = !!defaultExports.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      // @ts-ignore Gilad - to fix. it happens because defaultExports might be a func or an object (handled above)\n      defaultExports(...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    // @ts-ignore Gilad - to fix. it happens because defaultExports might be a func or an object (handled above)\n    defaultExports(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,SAAAA,OAAA;EAAA,MAAAC,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAH,MAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAG,SAAA;EAAA,MAAAH,IAAA,GAAAE,OAAA;EAAAC,QAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAGA,SAAAI,MAAA;EAAA,MAAAJ,IAAA,GAAAE,OAAA;EAAAE,KAAA,YAAAA,CAAA;IAAA,OAAAJ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAA2C,SAAAC,uBAAAI,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,SAAAG,gBAAAH,CAAA,EAAAI,CAAA,EAAAC,CAAA,YAAAD,CAAA,GAAAE,cAAA,CAAAF,CAAA,MAAAJ,CAAA,GAAAO,MAAA,CAAAC,cAAA,CAAAR,CAAA,EAAAI,CAAA,IAAAK,KAAA,EAAAJ,CAAA,EAAAK,UAAA,MAAAC,YAAA,MAAAC,QAAA,UAAAZ,CAAA,CAAAI,CAAA,IAAAC,CAAA,EAAAL,CAAA;AAAA,SAAAM,eAAAD,CAAA,QAAAQ,CAAA,GAAAC,YAAA,CAAAT,CAAA,uCAAAQ,CAAA,GAAAA,CAAA,GAAAA,CAAA;AAAA,SAAAC,aAAAT,CAAA,EAAAD,CAAA,2BAAAC,CAAA,KAAAA,CAAA,SAAAA,CAAA,MAAAL,CAAA,GAAAK,CAAA,CAAAU,MAAA,CAAAC,WAAA,kBAAAhB,CAAA,QAAAa,CAAA,GAAAb,CAAA,CAAAiB,IAAA,CAAAZ,CAAA,EAAAD,CAAA,uCAAAS,CAAA,SAAAA,CAAA,YAAAK,SAAA,yEAAAd,CAAA,GAAAe,MAAA,GAAAC,MAAA,EAAAf,CAAA;AAWpC,MAAMgB,WAAW,CAAC;EACvBC,WAAWA;EACT;AACJ;AACA;EACYC,OAAuB,EAC/B;IAAA,KADQA,OAAuB,GAAvBA,OAAuB;IAAApB,eAAA,iBAGxB,CACPqB,WAAwB,EACxBC,KAAa,EACbC,OAAsB,EACtB,CAACC,sBAAsB,CAAQ,EAC/BC,OAAyB,KACtB;MACH,MAAMC,UAAU,GAAG,IAAI,CAACC,kBAAkB,CAACN,WAAW,CAACO,QAAQ,EAAEL,OAAO,CAAC;MACzE,MAAMM,YAAY,GAAGL,sBAAsB,IAAI,EAAE;MAEjD,MAAMM,UAAU,GAAGP,OAAO,CAACQ,UAAU,CAACT,KAAK,CAAC,IAAIC,OAAO,CAACQ,UAAU,CAAChC,OAAO;MAC1E,IAAIiC,cAAc,GAAGF,UAAU,CAAC/B,OAAO;MACvC;MACA,IAAI,OAAOiC,cAAc,KAAK,UAAU,IAAIA,cAAc,CAACjC,OAAO,EAAE;QAClEiC,cAAc,GAAGA,cAAc,CAACjC,OAAO;MACzC;MACA;MACA,MAAMkC,QAAQ,GAAG,CAAC,CAACD,cAAc,CAACE,SAAS;;MAE3C;AACJ;AACA;MACI,IAAI,CAACD,QAAQ,EAAE;QACb,MAAME,cAAc,GAAG,CACrBC,YAAY,EACZf,WAAW,CAACgB,QAAQ,CAAC,CAAC,EACtBX,UAAU,EACVG,YAAY,EACZJ,OAAO,CACR;QACD;QACAO,cAAc,CAAC,GAAGG,cAAc,CAAC;QACjC;MACF;MAEA,MAAMG,SAAwB,GAAG;QAC/BC,QAAQ,EAAEH,YAAmC;QAC7Cf,WAAW,EAAEA,WAAW,CAACgB,QAAQ,CAAC,CAAC;QACnCG,IAAI,EAAEd,UAAkB;QACxBG,YAAY;QACZJ;MACF,CAAC;MACD;MACAO,cAAc,CAACM,SAAS,CAAC;IAC3B,CAAC;EA9CE;EAgDHX,kBAAkBA,CAACN,WAAmB,EAAEE,OAAsB,EAAE;IAC9D,MAAMkB,QAAQ,GAAGlB,OAAO,CAACmB,YAAY,CAACrB,WAAW,CAAC;IAClD,IAAI,CAACoB,QAAQ,EAAE,OAAOE,SAAS;;IAE/B;IACA,OAAOF,QAAQ,CAAC,CAAC,CAAC;EACpB;EAKA,aAAaG,QAAQA,CAAC,CAACxB,OAAO,CAAmB,EAAE;IACjD,MAAMyB,WAAW,GAAG,IAAI3B,WAAW,CAACE,OAAO,CAAC;IAC5CA,OAAO,CAAC0B,eAAe,CAAC;MACtBC,IAAI,EAAE,UAAU;MAChBC,MAAM,EAAEH,WAAW,CAACG,MAAM,CAACC,IAAI,CAACJ,WAAW,CAAC;MAC5ClB,kBAAkB,EAAEkB,WAAW,CAAClB,kBAAkB,CAACsB,IAAI,CAACJ,WAAW,CAAC;MACpEK,OAAO,EAAE,CAAC,cAAc;IAC1B,CAAC,CAAC;IAEF,OAAOL,WAAW;EACpB;AACF;AAACM,OAAA,CAAAjC,WAAA,GAAAA,WAAA;AAAAlB,eAAA,CA5EYkB,WAAW,aA8DLkC,yBAAc;AAAApD,eAAA,CA9DpBkB,WAAW,kBA+DA,CAACmC,wBAAa,CAAC;AAevCC,kBAAU,CAACC,UAAU,CAACrC,WAAW,CAAC;AAElC,SAASkB,YAAYA,CAAC;EAAEoB;AAAkC,CAAC,EAAE;EAC3D,oBAAOjE,MAAA,GAAAQ,OAAA,CAAA0D,aAAA,CAAAlE,MAAA,GAAAQ,OAAA,CAAA2D,QAAA,QAAGF,QAAW,CAAC;AACxB","ignoreList":[]}

package/dist/{preview-1722880610382.js → preview-1723000713766.js}

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

package/docs.preview.runtime.tsx

@@ -9,7 +9,7 @@ export type DocsRootProps = {
   Provider: React.ComponentType | undefined;
   componentId: string;
   docs: Docs | undefined;
-  compositions: any;
+  compositions?: any;
   context: RenderingContext;
 };
 
@@ -25,10 +25,11 @@ export class DocsPreview {
     componentId: ComponentID,
     envId: string,
     modules: PreviewModule,
-    [compositions]: [any],
+    [compositionsFromParams]: [any],
     context: RenderingContext
   ) => {
     const docsModule = this.selectPreviewModel(componentId.fullName, modules);
+    const compositions = compositionsFromParams || [];
 
     const mainModule = modules.modulesMap[envId] || modules.modulesMap.default;
     let defaultExports = mainModule.default;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/docs",
-  "version": "1.0.371",
+  "version": "1.0.373",
   "homepage": "https://bit.cloud/teambit/docs/docs",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.docs",
     "name": "docs",
-    "version": "1.0.371"
+    "version": "1.0.373"
   },
   "dependencies": {
     "graphql-tag": "2.12.1",
@@ -19,22 +19,22 @@
     "@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.371",
-    "@teambit/component": "1.0.371",
-    "@teambit/pkg": "1.0.371",
-    "@teambit/workspace": "1.0.371",
-    "@teambit/cli": "0.0.948",
+    "@teambit/compiler": "1.0.373",
+    "@teambit/component": "1.0.373",
+    "@teambit/pkg": "1.0.373",
+    "@teambit/workspace": "1.0.373",
+    "@teambit/cli": "0.0.950",
     "@teambit/component.sources": "0.0.18",
-    "@teambit/dev-files": "1.0.371",
-    "@teambit/envs": "1.0.371",
-    "@teambit/graphql": "1.0.371",
-    "@teambit/logger": "0.0.1041",
-    "@teambit/preview": "1.0.371",
-    "@teambit/scope": "1.0.371",
-    "@teambit/api-reference": "1.0.371",
-    "@teambit/component-compare": "1.0.371",
-    "@teambit/ui": "1.0.371",
-    "@teambit/pubsub": "1.0.371",
+    "@teambit/dev-files": "1.0.373",
+    "@teambit/envs": "1.0.373",
+    "@teambit/graphql": "1.0.373",
+    "@teambit/logger": "0.0.1043",
+    "@teambit/preview": "1.0.373",
+    "@teambit/scope": "1.0.373",
+    "@teambit/api-reference": "1.0.373",
+    "@teambit/component-compare": "1.0.373",
+    "@teambit/ui": "1.0.373",
+    "@teambit/pubsub": "1.0.373",
     "@teambit/compositions.panels.composition-gallery": "0.0.211",
     "@teambit/preview.ui.component-preview": "1.0.12"
   },