@teambit/docs 1.0.666 → 1.0.668

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

@@ -3,7 +3,7 @@ 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';
+import type { DocReader } from './doc-reader';
 export declare class DefaultDocReader implements DocReader {
     private pkg;
     private compiler;

package/dist/default-doc-reader.js.map

@@ -1 +1 @@
-{"version":3,"names":["_path","data","require","_docsEntities","_defineProperty","e","r","t","_toPropertyKey","Object","defineProperty","value","enumerable","configurable","writable","i","_toPrimitive","Symbol","toPrimitive","call","TypeError","String","Number","DefaultDocReader","constructor","pkg","compiler","workspace","read","path","contents","component","packageName","getPackageName","distPath","getDistPathBySrcPath","docsModule","resolve","Doc","from","labels","default","description","abstract","displayName","componentDisplayName","isFormatSupported","format","supportedExtensions","includes","exports"],"sources":["default-doc-reader.ts"],"sourcesContent":["import { resolve } from 'path';\nimport type { PkgMain } from '@teambit/pkg';\nimport type { Component } from '@teambit/component';\nimport type { CompilerMain } from '@teambit/compiler';\nimport type { Workspace } from '@teambit/workspace';\nimport { Doc } from '@teambit/docs.entities.doc';\nimport { DocReader } from './doc-reader';\n\nexport class DefaultDocReader implements DocReader {\n  constructor(\n    private pkg: PkgMain,\n    private compiler: CompilerMain,\n    private workspace: Workspace\n  ) {}\n\n  async read(path: string, contents: Buffer, component: Component) {\n    const packageName = this.pkg.getPackageName(component);\n    const distPath = this.compiler.getDistPathBySrcPath(component, path);\n    // eslint-disable-next-line\n    const docsModule = require(resolve(`${this.workspace.path}/node_modules/${packageName}/${distPath}`));\n    return Doc.from(path, {\n      labels: docsModule.labels || docsModule.default?.labels,\n      description: docsModule.abstract || docsModule.default?.abstract || docsModule.description,\n      displayName: docsModule.displayName || docsModule.default?.componentDisplayName,\n    });\n  }\n\n  readonly supportedExtensions = ['.ts', '.js', '.jsx', '.tsx'];\n\n  isFormatSupported(format: string) {\n    return this.supportedExtensions.includes(format);\n  }\n}\n"],"mappings":";;;;;;AAAA,SAAAA,MAAA;EAAA,MAAAC,IAAA,GAAAC,OAAA;EAAAF,KAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAKA,SAAAE,cAAA;EAAA,MAAAF,IAAA,GAAAC,OAAA;EAAAC,aAAA,YAAAA,CAAA;IAAA,OAAAF,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAAiD,SAAAG,gBAAAC,CAAA,EAAAC,CAAA,EAAAC,CAAA,YAAAD,CAAA,GAAAE,cAAA,CAAAF,CAAA,MAAAD,CAAA,GAAAI,MAAA,CAAAC,cAAA,CAAAL,CAAA,EAAAC,CAAA,IAAAK,KAAA,EAAAJ,CAAA,EAAAK,UAAA,MAAAC,YAAA,MAAAC,QAAA,UAAAT,CAAA,CAAAC,CAAA,IAAAC,CAAA,EAAAF,CAAA;AAAA,SAAAG,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,MAAAF,CAAA,GAAAE,CAAA,CAAAU,MAAA,CAAAC,WAAA,kBAAAb,CAAA,QAAAU,CAAA,GAAAV,CAAA,CAAAc,IAAA,CAAAZ,CAAA,EAAAD,CAAA,uCAAAS,CAAA,SAAAA,CAAA,YAAAK,SAAA,yEAAAd,CAAA,GAAAe,MAAA,GAAAC,MAAA,EAAAf,CAAA;AAG1C,MAAMgB,gBAAgB,CAAsB;EACjDC,WAAWA,CACDC,GAAY,EACZC,QAAsB,EACtBC,SAAoB,EAC5B;IAAA,KAHQF,GAAY,GAAZA,GAAY;IAAA,KACZC,QAAsB,GAAtBA,QAAsB;IAAA,KACtBC,SAAoB,GAApBA,SAAoB;IAAAvB,eAAA,8BAeC,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC;EAd1D;EAEH,MAAMwB,IAAIA,CAACC,IAAY,EAAEC,QAAgB,EAAEC,SAAoB,EAAE;IAC/D,MAAMC,WAAW,GAAG,IAAI,CAACP,GAAG,CAACQ,cAAc,CAACF,SAAS,CAAC;IACtD,MAAMG,QAAQ,GAAG,IAAI,CAACR,QAAQ,CAACS,oBAAoB,CAACJ,SAAS,EAAEF,IAAI,CAAC;IACpE;IACA,MAAMO,UAAU,GAAGlC,OAAO,CAAC,IAAAmC,eAAO,EAAC,GAAG,IAAI,CAACV,SAAS,CAACE,IAAI,iBAAiBG,WAAW,IAAIE,QAAQ,EAAE,CAAC,CAAC;IACrG,OAAOI,mBAAG,CAACC,IAAI,CAACV,IAAI,EAAE;MACpBW,MAAM,EAAEJ,UAAU,CAACI,MAAM,IAAIJ,UAAU,CAACK,OAAO,EAAED,MAAM;MACvDE,WAAW,EAAEN,UAAU,CAACO,QAAQ,IAAIP,UAAU,CAACK,OAAO,EAAEE,QAAQ,IAAIP,UAAU,CAACM,WAAW;MAC1FE,WAAW,EAAER,UAAU,CAACQ,WAAW,IAAIR,UAAU,CAACK,OAAO,EAAEI;IAC7D,CAAC,CAAC;EACJ;EAIAC,iBAAiBA,CAACC,MAAc,EAAE;IAChC,OAAO,IAAI,CAACC,mBAAmB,CAACC,QAAQ,CAACF,MAAM,CAAC;EAClD;AACF;AAACG,OAAA,CAAA3B,gBAAA,GAAAA,gBAAA","ignoreList":[]}
+{"version":3,"names":["_path","data","require","_docsEntities","_defineProperty","e","r","t","_toPropertyKey","Object","defineProperty","value","enumerable","configurable","writable","i","_toPrimitive","Symbol","toPrimitive","call","TypeError","String","Number","DefaultDocReader","constructor","pkg","compiler","workspace","read","path","contents","component","packageName","getPackageName","distPath","getDistPathBySrcPath","docsModule","resolve","Doc","from","labels","default","description","abstract","displayName","componentDisplayName","isFormatSupported","format","supportedExtensions","includes","exports"],"sources":["default-doc-reader.ts"],"sourcesContent":["import { resolve } from 'path';\nimport type { PkgMain } from '@teambit/pkg';\nimport type { Component } from '@teambit/component';\nimport type { CompilerMain } from '@teambit/compiler';\nimport type { Workspace } from '@teambit/workspace';\nimport { Doc } from '@teambit/docs.entities.doc';\nimport type { DocReader } from './doc-reader';\n\nexport class DefaultDocReader implements DocReader {\n  constructor(\n    private pkg: PkgMain,\n    private compiler: CompilerMain,\n    private workspace: Workspace\n  ) {}\n\n  async read(path: string, contents: Buffer, component: Component) {\n    const packageName = this.pkg.getPackageName(component);\n    const distPath = this.compiler.getDistPathBySrcPath(component, path);\n    // eslint-disable-next-line\n    const docsModule = require(resolve(`${this.workspace.path}/node_modules/${packageName}/${distPath}`));\n    return Doc.from(path, {\n      labels: docsModule.labels || docsModule.default?.labels,\n      description: docsModule.abstract || docsModule.default?.abstract || docsModule.description,\n      displayName: docsModule.displayName || docsModule.default?.componentDisplayName,\n    });\n  }\n\n  readonly supportedExtensions = ['.ts', '.js', '.jsx', '.tsx'];\n\n  isFormatSupported(format: string) {\n    return this.supportedExtensions.includes(format);\n  }\n}\n"],"mappings":";;;;;;AAAA,SAAAA,MAAA;EAAA,MAAAC,IAAA,GAAAC,OAAA;EAAAF,KAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAKA,SAAAE,cAAA;EAAA,MAAAF,IAAA,GAAAC,OAAA;EAAAC,aAAA,YAAAA,CAAA;IAAA,OAAAF,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAAiD,SAAAG,gBAAAC,CAAA,EAAAC,CAAA,EAAAC,CAAA,YAAAD,CAAA,GAAAE,cAAA,CAAAF,CAAA,MAAAD,CAAA,GAAAI,MAAA,CAAAC,cAAA,CAAAL,CAAA,EAAAC,CAAA,IAAAK,KAAA,EAAAJ,CAAA,EAAAK,UAAA,MAAAC,YAAA,MAAAC,QAAA,UAAAT,CAAA,CAAAC,CAAA,IAAAC,CAAA,EAAAF,CAAA;AAAA,SAAAG,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,MAAAF,CAAA,GAAAE,CAAA,CAAAU,MAAA,CAAAC,WAAA,kBAAAb,CAAA,QAAAU,CAAA,GAAAV,CAAA,CAAAc,IAAA,CAAAZ,CAAA,EAAAD,CAAA,uCAAAS,CAAA,SAAAA,CAAA,YAAAK,SAAA,yEAAAd,CAAA,GAAAe,MAAA,GAAAC,MAAA,EAAAf,CAAA;AAG1C,MAAMgB,gBAAgB,CAAsB;EACjDC,WAAWA,CACDC,GAAY,EACZC,QAAsB,EACtBC,SAAoB,EAC5B;IAAA,KAHQF,GAAY,GAAZA,GAAY;IAAA,KACZC,QAAsB,GAAtBA,QAAsB;IAAA,KACtBC,SAAoB,GAApBA,SAAoB;IAAAvB,eAAA,8BAeC,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC;EAd1D;EAEH,MAAMwB,IAAIA,CAACC,IAAY,EAAEC,QAAgB,EAAEC,SAAoB,EAAE;IAC/D,MAAMC,WAAW,GAAG,IAAI,CAACP,GAAG,CAACQ,cAAc,CAACF,SAAS,CAAC;IACtD,MAAMG,QAAQ,GAAG,IAAI,CAACR,QAAQ,CAACS,oBAAoB,CAACJ,SAAS,EAAEF,IAAI,CAAC;IACpE;IACA,MAAMO,UAAU,GAAGlC,OAAO,CAAC,IAAAmC,eAAO,EAAC,GAAG,IAAI,CAACV,SAAS,CAACE,IAAI,iBAAiBG,WAAW,IAAIE,QAAQ,EAAE,CAAC,CAAC;IACrG,OAAOI,mBAAG,CAACC,IAAI,CAACV,IAAI,EAAE;MACpBW,MAAM,EAAEJ,UAAU,CAACI,MAAM,IAAIJ,UAAU,CAACK,OAAO,EAAED,MAAM;MACvDE,WAAW,EAAEN,UAAU,CAACO,QAAQ,IAAIP,UAAU,CAACK,OAAO,EAAEE,QAAQ,IAAIP,UAAU,CAACM,WAAW;MAC1FE,WAAW,EAAER,UAAU,CAACQ,WAAW,IAAIR,UAAU,CAACK,OAAO,EAAEI;IAC7D,CAAC,CAAC;EACJ;EAIAC,iBAAiBA,CAACC,MAAc,EAAE;IAChC,OAAO,IAAI,CAACC,mBAAmB,CAACC,QAAQ,CAACF,MAAM,CAAC;EAClD;AACF;AAACG,OAAA,CAAA3B,gBAAA,GAAAA,gBAAA","ignoreList":[]}

package/dist/doc-reader.d.ts

@@ -1,5 +1,5 @@
 import type { Component } from '@teambit/component';
-import { Doc } from '@teambit/docs.entities.doc';
+import type { Doc } from '@teambit/docs.entities.doc';
 export interface DocReader {
     /**
      * read a component doc.

package/dist/doc-reader.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["doc-reader.ts"],"sourcesContent":["import type { Component } from '@teambit/component';\nimport { Doc } from '@teambit/docs.entities.doc';\n\nexport interface DocReader {\n  /**\n   * read a component doc.\n   * @TODO refactor to virtual-file component after @david completes.\n   */\n  read(path: string, contents: Buffer, component: Component): Promise<Doc>;\n\n  /**\n   * determine which file formats are supported by the doc reader.\n   */\n  isFormatSupported(ext: string): boolean;\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"names":[],"sources":["doc-reader.ts"],"sourcesContent":["import type { Component } from '@teambit/component';\nimport type { Doc } from '@teambit/docs.entities.doc';\n\nexport interface DocReader {\n  /**\n   * read a component doc.\n   * @TODO refactor to virtual-file component after @david completes.\n   */\n  read(path: string, contents: Buffer, component: Component): Promise<Doc>;\n\n  /**\n   * determine which file formats are supported by the doc reader.\n   */\n  isFormatSupported(ext: string): boolean;\n}\n"],"mappings":"","ignoreList":[]}

package/dist/docs.d.ts

@@ -1,4 +1,5 @@
-import React, { ReactElement } from 'react';
+import type { ReactElement } from 'react';
+import type React from 'react';
 export type Example = {
     title?: string;
     description?: ReactElement;

package/dist/docs.graphql.d.ts

@@ -1,5 +1,5 @@
-import { Component } from '@teambit/component';
-import { DocsMain } from './docs.main.runtime';
+import type { Component } from '@teambit/component';
+import type { DocsMain } from './docs.main.runtime';
 export declare function docsSchema(docs: DocsMain): {
     typeDefs: import("graphql").DocumentNode;
     resolvers: {

package/dist/docs.graphql.js.map

@@ -1 +1 @@
-{"version":3,"names":["_graphqlTag","data","require","docsSchema","docs","typeDefs","gql","resolvers","Component","description","component","getDescription","labels","doc","getDoc"],"sources":["docs.graphql.ts"],"sourcesContent":["import { gql } from 'graphql-tag';\nimport { Component } from '@teambit/component';\nimport { DocsMain } from './docs.main.runtime';\n\nexport function docsSchema(docs: DocsMain) {\n  return {\n    typeDefs: gql`\n      extend type Component {\n        description: String\n        labels: [String]\n      }\n    `,\n    resolvers: {\n      Component: {\n        description: (component: Component) => {\n          return docs.getDescription(component);\n        },\n\n        labels: (component: Component) => {\n          const doc = docs.getDoc(component);\n          return doc?.labels || [];\n        },\n      },\n    },\n  };\n}\n"],"mappings":";;;;;;AAAA,SAAAA,YAAA;EAAA,MAAAC,IAAA,GAAAC,OAAA;EAAAF,WAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAIO,SAASE,UAAUA,CAACC,IAAc,EAAE;EACzC,OAAO;IACLC,QAAQ,EAAE,IAAAC,iBAAG;AACjB;AACA;AACA;AACA;AACA,KAAK;IACDC,SAAS,EAAE;MACTC,SAAS,EAAE;QACTC,WAAW,EAAGC,SAAoB,IAAK;UACrC,OAAON,IAAI,CAACO,cAAc,CAACD,SAAS,CAAC;QACvC,CAAC;QAEDE,MAAM,EAAGF,SAAoB,IAAK;UAChC,MAAMG,GAAG,GAAGT,IAAI,CAACU,MAAM,CAACJ,SAAS,CAAC;UAClC,OAAOG,GAAG,EAAED,MAAM,IAAI,EAAE;QAC1B;MACF;IACF;EACF,CAAC;AACH","ignoreList":[]}
+{"version":3,"names":["_graphqlTag","data","require","docsSchema","docs","typeDefs","gql","resolvers","Component","description","component","getDescription","labels","doc","getDoc"],"sources":["docs.graphql.ts"],"sourcesContent":["import { gql } from 'graphql-tag';\nimport type { Component } from '@teambit/component';\nimport type { DocsMain } from './docs.main.runtime';\n\nexport function docsSchema(docs: DocsMain) {\n  return {\n    typeDefs: gql`\n      extend type Component {\n        description: String\n        labels: [String]\n      }\n    `,\n    resolvers: {\n      Component: {\n        description: (component: Component) => {\n          return docs.getDescription(component);\n        },\n\n        labels: (component: Component) => {\n          const doc = docs.getDoc(component);\n          return doc?.labels || [];\n        },\n      },\n    },\n  };\n}\n"],"mappings":";;;;;;AAAA,SAAAA,YAAA;EAAA,MAAAC,IAAA,GAAAC,OAAA;EAAAF,WAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAIO,SAASE,UAAUA,CAACC,IAAc,EAAE;EACzC,OAAO;IACLC,QAAQ,EAAE,IAAAC,iBAAG;AACjB;AACA;AACA;AACA;AACA,KAAK;IACDC,SAAS,EAAE;MACTC,SAAS,EAAE;QACTC,WAAW,EAAGC,SAAoB,IAAK;UACrC,OAAON,IAAI,CAACO,cAAc,CAACD,SAAS,CAAC;QACvC,CAAC;QAEDE,MAAM,EAAGF,SAAoB,IAAK;UAChC,MAAMG,GAAG,GAAGT,IAAI,CAACU,MAAM,CAACJ,SAAS,CAAC;UAClC,OAAOG,GAAG,EAAED,MAAM,IAAI,EAAE;QAC1B;MACF;IACF;EACF,CAAC;AACH","ignoreList":[]}

package/dist/docs.js.map

@@ -1 +1 @@
-{"version":3,"names":["defaultDocs","exports","default","labels","abstract","examples"],"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\nexport const defaultDocs: Docs = {\n  default: () => null,\n  labels: [],\n  abstract: '',\n  examples: [],\n};\n"],"mappings":";;;;;;AAgCO,MAAMA,WAAiB,GAAAC,OAAA,CAAAD,WAAA,GAAG;EAC/BE,OAAO,EAAEA,CAAA,KAAM,IAAI;EACnBC,MAAM,EAAE,EAAE;EACVC,QAAQ,EAAE,EAAE;EACZC,QAAQ,EAAE;AACZ,CAAC","ignoreList":[]}
+{"version":3,"names":["defaultDocs","exports","default","labels","abstract","examples"],"sources":["docs.ts"],"sourcesContent":["import type { ReactElement } from 'react';\nimport type React 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\nexport const defaultDocs: Docs = {\n  default: () => null,\n  labels: [],\n  abstract: '',\n  examples: [],\n};\n"],"mappings":";;;;;;AAiCO,MAAMA,WAAiB,GAAAC,OAAA,CAAAD,WAAA,GAAG;EAC/BE,OAAO,EAAEA,CAAA,KAAM,IAAI;EACnBC,MAAM,EAAE,EAAE;EACVC,QAAQ,EAAE,EAAE;EACZC,QAAQ,EAAE;AACZ,CAAC","ignoreList":[]}

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

@@ -1,18 +1,18 @@
-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/component.sources';
-import { Workspace } from '@teambit/workspace';
+import type { SlotRegistry } from '@teambit/harmony';
+import type { LoggerMain, Logger } from '@teambit/logger';
+import type { CompilerMain } from '@teambit/compiler';
+import type { Component, IComponent } from '@teambit/component';
+import { ComponentMap } from '@teambit/component';
+import type { ScopeMain } from '@teambit/scope';
+import type { PkgMain } from '@teambit/pkg';
+import type { Environment, EnvsMain } from '@teambit/envs';
+import type { GraphqlMain } from '@teambit/graphql';
+import type { PreviewMain } from '@teambit/preview';
+import type { DevFilesMain } from '@teambit/dev-files';
+import type { AbstractVinyl } from '@teambit/component.sources';
+import type { Workspace } from '@teambit/workspace';
 import { Doc } from '@teambit/docs.entities.doc';
-import { EnvsMain } from '@teambit/envs';
-import { DocReader } from './doc-reader';
+import type { DocReader } from './doc-reader';
 export type ComponentDocs = {
     files: string[];
     component: Component;

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

@@ -1 +1 @@
-{"version":3,"names":["_harmony","data","require","_cli","_logger","_compiler","_component","_scope","_pkg","_graphql","_preview","_devFiles","_workspace","_docsEntities","_lodash","_envs","_docs","_docs2","_docs3","_defaultDocReader","_exceptions","_defineProperty","e","r","t","_toPropertyKey","Object","defineProperty","value","enumerable","configurable","writable","i","_toPrimitive","Symbol","toPrimitive","call","TypeError","String","Number","DocsMain","constructor","patterns","preview","pkg","compiler","workspace","logger","devFiles","envs","docPropSlot","docReaderSlot","getDocsMap","components","ComponentMap","as","component","getDocsFiles","getDevFiles","docFiles","get","DocsAspect","id","state","filesystem","files","filter","file","includes","relative","getDescription","componentDoc","getDoc","desc","description","getTemplate","env","getDocsTemplate","isFunction","undefined","getDocReader","extension","values","find","docReader","isFormatSupported","computeDoc","length","docFile","extname","FileExtensionNotSupported","doc","read","contents","err","debug","message","docData","Doc","filePath","DocPropList","props","getPatterns","getComponentDevPatterns","calculateEnv","skipWarnings","inInstallContext","componentEnvDocsDevPatterns","getDocsDevPatterns","componentPatterns","concat","name","pattern","getDevPatternToRegister","bind","registerDocReader","register","provider","graphql","loggerAspect","scope","config","createLogger","docs","DefaultDocReader","registerDevPattern","computeDocsOnLoad","opts","loadDocs","toObject","registerOnComponentLoad","registerOnCompAspectReCalc","docsSchema","registerDefinition","DocsPreviewDefinition","exports","Slot","withType","MainRuntime","PreviewAspect","GraphqlAspect","WorkspaceAspect","PkgAspect","CompilerAspect","LoggerAspect","DevFilesAspect","EnvsAspect","ScopeAspect","addRuntime"],"sources":["docs.main.runtime.ts"],"sourcesContent":["import { Slot, SlotRegistry } from '@teambit/harmony';\nimport { MainRuntime } from '@teambit/cli';\nimport { LoggerAspect, LoggerMain, Logger } from '@teambit/logger';\nimport { CompilerAspect, CompilerMain } from '@teambit/compiler';\nimport { Component, ComponentMap, IComponent } from '@teambit/component';\nimport { ScopeAspect, ScopeMain } from '@teambit/scope';\nimport { PkgAspect, PkgMain } from '@teambit/pkg';\nimport type { Environment } from '@teambit/envs';\nimport { GraphqlAspect, GraphqlMain } from '@teambit/graphql';\nimport { PreviewAspect, PreviewMain } from '@teambit/preview';\nimport { DevFilesAspect, DevFilesMain } from '@teambit/dev-files';\nimport { ComponentLoadOptions } from '@teambit/legacy.consumer-component';\nimport { AbstractVinyl } from '@teambit/component.sources';\nimport { Workspace, WorkspaceAspect } from '@teambit/workspace';\nimport { Doc, DocPropList } from '@teambit/docs.entities.doc';\nimport { isFunction } from 'lodash';\nimport { EnvsAspect, EnvsMain } from '@teambit/envs';\nimport { DocsAspect } from './docs.aspect';\nimport { DocsPreviewDefinition } from './docs.preview-definition';\nimport { docsSchema } from './docs.graphql';\nimport { DocReader } from './doc-reader';\nimport { DefaultDocReader } from './default-doc-reader';\nimport { FileExtensionNotSupported } from './exceptions';\n\nexport type ComponentDocs = {\n  files: string[];\n  component: Component;\n};\n\nexport type DocProp = {};\n\nexport type DocPropSlot = SlotRegistry<DocProp>;\n\nexport type DocReaderSlot = SlotRegistry<DocReader>;\n\nexport type DocsConfig = {\n  /**\n   * glob patterns to identify doc files.\n   */\n  patterns: string[];\n};\n\n/**\n * the component documentation extension.\n */\nexport class DocsMain {\n  constructor(\n    private patterns: string[],\n    /**\n     * envs extension.\n     */\n    private preview: PreviewMain,\n\n    private pkg: PkgMain,\n\n    private compiler: CompilerMain,\n\n    private workspace: Workspace,\n\n    private logger: Logger,\n\n    private devFiles: DevFilesMain,\n\n    private envs: EnvsMain,\n\n    private docPropSlot: DocPropSlot,\n\n    private docReaderSlot: DocReaderSlot\n  ) {}\n\n  /**\n   * returns an array of doc file paths for a set of components.\n   */\n  getDocsMap(components: Component[]): ComponentMap<AbstractVinyl[]> {\n    return ComponentMap.as<AbstractVinyl[]>(components, (component) => {\n      return this.getDocsFiles(component);\n    });\n  }\n\n  getDocsFiles(component: Component): AbstractVinyl[] {\n    const devFiles = this.devFiles.getDevFiles(component);\n    const docFiles = devFiles.get(DocsAspect.id);\n    return component.state.filesystem.files.filter((file) => docFiles.includes(file.relative));\n  }\n\n  /**\n   * compute the description of the component from its source code and docs file.\n   */\n  async getDescription(component: Component): Promise<string> {\n    const componentDoc = this.getDoc(component);\n    const desc = componentDoc?.description;\n    return desc || '';\n  }\n\n  async getTemplate(env: Environment): Promise<string | undefined> {\n    if (env.getDocsTemplate && isFunction(env.getDocsTemplate)) {\n      return env.getDocsTemplate();\n    }\n    return undefined;\n  }\n\n  getDocReader(extension: string) {\n    return this.docReaderSlot.values().find((docReader) => docReader.isFormatSupported(extension));\n  }\n\n  /**\n   * compute a doc for a component.\n   */\n  async computeDoc(component: Component) {\n    const docFiles = this.getDocsFiles(component);\n    if (docFiles.length) {\n      // currently taking the the first docs file found with an abstract. (we support only one)\n      const docFile = docFiles[0];\n\n      try {\n        const docReader = this.getDocReader(docFile.extname);\n        if (!docReader) throw new FileExtensionNotSupported(docFile.relative, docFile.extname);\n        const doc = await docReader.read(docFile.relative, docFile.contents, component);\n        return doc;\n      } catch (err: any) {\n        // it's ok to fail here.\n        this.logger.debug(`docs.main.runtime.computeDoc caught an error: ${err.message}`);\n        return null;\n      }\n    }\n\n    return null;\n  }\n\n  getDoc(component: IComponent) {\n    const docData = component.get(DocsAspect.id)?.data?.doc;\n    if (!docData) return null;\n    return new Doc(docData.filePath, new DocPropList(docData.props));\n  }\n\n  getPatterns() {\n    return this.patterns;\n  }\n\n  getComponentDevPatterns(component: Component) {\n    const env = this.envs.calculateEnv(component, { skipWarnings: !!this.workspace?.inInstallContext }).env;\n    const componentEnvDocsDevPatterns: string[] = env.getDocsDevPatterns ? env.getDocsDevPatterns(component) : [];\n    const componentPatterns = componentEnvDocsDevPatterns.concat(this.getPatterns());\n    return { name: 'docs', pattern: componentPatterns };\n  }\n\n  getDevPatternToRegister() {\n    return this.getComponentDevPatterns.bind(this);\n  }\n  /**\n   * register a new doc reader. this allows to support further\n   * documentation file formats.\n   */\n  registerDocReader(docReader: DocReader) {\n    this.docReaderSlot.register(docReader);\n    return this;\n  }\n\n  static slots = [Slot.withType<DocProp>(), Slot.withType<DocReader>()];\n\n  static runtime = MainRuntime;\n  static dependencies = [\n    PreviewAspect,\n    GraphqlAspect,\n    WorkspaceAspect,\n    PkgAspect,\n    CompilerAspect,\n    LoggerAspect,\n    DevFilesAspect,\n    EnvsAspect,\n    ScopeAspect,\n  ];\n\n  static defaultConfig = {\n    patterns: ['**/*.docs.*'],\n  };\n\n  static async provider(\n    [preview, graphql, workspace, pkg, compiler, loggerAspect, devFiles, envs, scope]: [\n      PreviewMain,\n      GraphqlMain,\n      Workspace,\n      PkgMain,\n      CompilerMain,\n      LoggerMain,\n      DevFilesMain,\n      EnvsMain,\n      ScopeMain,\n    ],\n    config: DocsConfig,\n    [docPropSlot, docReaderSlot]: [DocPropSlot, DocReaderSlot]\n  ) {\n    const logger = loggerAspect.createLogger(DocsAspect.id);\n    const docs = new DocsMain(\n      config.patterns,\n      preview,\n      pkg,\n      compiler,\n      workspace,\n      logger,\n      devFiles,\n      envs,\n      docPropSlot,\n      docReaderSlot\n    );\n    docs.registerDocReader(new DefaultDocReader(pkg, compiler, workspace));\n    devFiles.registerDevPattern(docs.getDevPatternToRegister());\n\n    const computeDocsOnLoad = async (component: Component, opts?: ComponentLoadOptions) => {\n      if (opts?.loadDocs === false) return undefined;\n      // const docFiles = await docs.computeDocs(component);\n      const doc = await docs.computeDoc(component);\n\n      return {\n        doc: doc?.toObject(),\n        // docFiles\n      };\n    };\n\n    if (workspace) {\n      workspace.registerOnComponentLoad(computeDocsOnLoad);\n    }\n    if (scope) {\n      scope.registerOnCompAspectReCalc(computeDocsOnLoad);\n    }\n\n    graphql.register(() => docsSchema(docs));\n\n    preview.registerDefinition(new DocsPreviewDefinition(docs));\n    return docs;\n  }\n}\n\nDocsAspect.addRuntime(DocsMain);\n"],"mappings":";;;;;;AAAA,SAAAA,SAAA;EAAA,MAAAC,IAAA,GAAAC,OAAA;EAAAF,QAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAE,KAAA;EAAA,MAAAF,IAAA,GAAAC,OAAA;EAAAC,IAAA,YAAAA,CAAA;IAAA,OAAAF,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAG,QAAA;EAAA,MAAAH,IAAA,GAAAC,OAAA;EAAAE,OAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAI,UAAA;EAAA,MAAAJ,IAAA,GAAAC,OAAA;EAAAG,SAAA,YAAAA,CAAA;IAAA,OAAAJ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAK,WAAA;EAAA,MAAAL,IAAA,GAAAC,OAAA;EAAAI,UAAA,YAAAA,CAAA;IAAA,OAAAL,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAM,OAAA;EAAA,MAAAN,IAAA,GAAAC,OAAA;EAAAK,MAAA,YAAAA,CAAA;IAAA,OAAAN,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAO,KAAA;EAAA,MAAAP,IAAA,GAAAC,OAAA;EAAAM,IAAA,YAAAA,CAAA;IAAA,OAAAP,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAQ,SAAA;EAAA,MAAAR,IAAA,GAAAC,OAAA;EAAAO,QAAA,YAAAA,CAAA;IAAA,OAAAR,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAS,SAAA;EAAA,MAAAT,IAAA,GAAAC,OAAA;EAAAQ,QAAA,YAAAA,CAAA;IAAA,OAAAT,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAU,UAAA;EAAA,MAAAV,IAAA,GAAAC,OAAA;EAAAS,SAAA,YAAAA,CAAA;IAAA,OAAAV,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAGA,SAAAW,WAAA;EAAA,MAAAX,IAAA,GAAAC,OAAA;EAAAU,UAAA,YAAAA,CAAA;IAAA,OAAAX,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAY,cAAA;EAAA,MAAAZ,IAAA,GAAAC,OAAA;EAAAW,aAAA,YAAAA,CAAA;IAAA,OAAAZ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAa,QAAA;EAAA,MAAAb,IAAA,GAAAC,OAAA;EAAAY,OAAA,YAAAA,CAAA;IAAA,OAAAb,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAc,MAAA;EAAA,MAAAd,IAAA,GAAAC,OAAA;EAAAa,KAAA,YAAAA,CAAA;IAAA,OAAAd,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAe,MAAA;EAAA,MAAAf,IAAA,GAAAC,OAAA;EAAAc,KAAA,YAAAA,CAAA;IAAA,OAAAf,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAgB,OAAA;EAAA,MAAAhB,IAAA,GAAAC,OAAA;EAAAe,MAAA,YAAAA,CAAA;IAAA,OAAAhB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAiB,OAAA;EAAA,MAAAjB,IAAA,GAAAC,OAAA;EAAAgB,MAAA,YAAAA,CAAA;IAAA,OAAAjB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAkB,kBAAA;EAAA,MAAAlB,IAAA,GAAAC,OAAA;EAAAiB,iBAAA,YAAAA,CAAA;IAAA,OAAAlB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAmB,YAAA;EAAA,MAAAnB,IAAA,GAAAC,OAAA;EAAAkB,WAAA,YAAAA,CAAA;IAAA,OAAAnB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAAyD,SAAAoB,gBAAAC,CAAA,EAAAC,CAAA,EAAAC,CAAA,YAAAD,CAAA,GAAAE,cAAA,CAAAF,CAAA,MAAAD,CAAA,GAAAI,MAAA,CAAAC,cAAA,CAAAL,CAAA,EAAAC,CAAA,IAAAK,KAAA,EAAAJ,CAAA,EAAAK,UAAA,MAAAC,YAAA,MAAAC,QAAA,UAAAT,CAAA,CAAAC,CAAA,IAAAC,CAAA,EAAAF,CAAA;AAAA,SAAAG,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,MAAAF,CAAA,GAAAE,CAAA,CAAAU,MAAA,CAAAC,WAAA,kBAAAb,CAAA,QAAAU,CAAA,GAAAV,CAAA,CAAAc,IAAA,CAAAZ,CAAA,EAAAD,CAAA,uCAAAS,CAAA,SAAAA,CAAA,YAAAK,SAAA,yEAAAd,CAAA,GAAAe,MAAA,GAAAC,MAAA,EAAAf,CAAA;AAoBzD;AACA;AACA;AACO,MAAMgB,QAAQ,CAAC;EACpBC,WAAWA,CACDC,QAAkB;EAC1B;AACJ;AACA;EACYC,OAAoB,EAEpBC,GAAY,EAEZC,QAAsB,EAEtBC,SAAoB,EAEpBC,MAAc,EAEdC,QAAsB,EAEtBC,IAAc,EAEdC,WAAwB,EAExBC,aAA4B,EACpC;IAAA,KArBQT,QAAkB,GAAlBA,QAAkB;IAAA,KAIlBC,OAAoB,GAApBA,OAAoB;IAAA,KAEpBC,GAAY,GAAZA,GAAY;IAAA,KAEZC,QAAsB,GAAtBA,QAAsB;IAAA,KAEtBC,SAAoB,GAApBA,SAAoB;IAAA,KAEpBC,MAAc,GAAdA,MAAc;IAAA,KAEdC,QAAsB,GAAtBA,QAAsB;IAAA,KAEtBC,IAAc,GAAdA,IAAc;IAAA,KAEdC,WAAwB,GAAxBA,WAAwB;IAAA,KAExBC,aAA4B,GAA5BA,aAA4B;EACnC;;EAEH;AACF;AACA;EACEC,UAAUA,CAACC,UAAuB,EAAiC;IACjE,OAAOC,yBAAY,CAACC,EAAE,CAAkBF,UAAU,EAAGG,SAAS,IAAK;MACjE,OAAO,IAAI,CAACC,YAAY,CAACD,SAAS,CAAC;IACrC,CAAC,CAAC;EACJ;EAEAC,YAAYA,CAACD,SAAoB,EAAmB;IAClD,MAAMR,QAAQ,GAAG,IAAI,CAACA,QAAQ,CAACU,WAAW,CAACF,SAAS,CAAC;IACrD,MAAMG,QAAQ,GAAGX,QAAQ,CAACY,GAAG,CAACC,kBAAU,CAACC,EAAE,CAAC;IAC5C,OAAON,SAAS,CAACO,KAAK,CAACC,UAAU,CAACC,KAAK,CAACC,MAAM,CAAEC,IAAI,IAAKR,QAAQ,CAACS,QAAQ,CAACD,IAAI,CAACE,QAAQ,CAAC,CAAC;EAC5F;;EAEA;AACF;AACA;EACE,MAAMC,cAAcA,CAACd,SAAoB,EAAmB;IAC1D,MAAMe,YAAY,GAAG,IAAI,CAACC,MAAM,CAAChB,SAAS,CAAC;IAC3C,MAAMiB,IAAI,GAAGF,YAAY,EAAEG,WAAW;IACtC,OAAOD,IAAI,IAAI,EAAE;EACnB;EAEA,MAAME,WAAWA,CAACC,GAAgB,EAA+B;IAC/D,IAAIA,GAAG,CAACC,eAAe,IAAI,IAAAC,oBAAU,EAACF,GAAG,CAACC,eAAe,CAAC,EAAE;MAC1D,OAAOD,GAAG,CAACC,eAAe,CAAC,CAAC;IAC9B;IACA,OAAOE,SAAS;EAClB;EAEAC,YAAYA,CAACC,SAAiB,EAAE;IAC9B,OAAO,IAAI,CAAC9B,aAAa,CAAC+B,MAAM,CAAC,CAAC,CAACC,IAAI,CAAEC,SAAS,IAAKA,SAAS,CAACC,iBAAiB,CAACJ,SAAS,CAAC,CAAC;EAChG;;EAEA;AACF;AACA;EACE,MAAMK,UAAUA,CAAC9B,SAAoB,EAAE;IACrC,MAAMG,QAAQ,GAAG,IAAI,CAACF,YAAY,CAACD,SAAS,CAAC;IAC7C,IAAIG,QAAQ,CAAC4B,MAAM,EAAE;MACnB;MACA,MAAMC,OAAO,GAAG7B,QAAQ,CAAC,CAAC,CAAC;MAE3B,IAAI;QACF,MAAMyB,SAAS,GAAG,IAAI,CAACJ,YAAY,CAACQ,OAAO,CAACC,OAAO,CAAC;QACpD,IAAI,CAACL,SAAS,EAAE,MAAM,KAAIM,uCAAyB,EAACF,OAAO,CAACnB,QAAQ,EAAEmB,OAAO,CAACC,OAAO,CAAC;QACtF,MAAME,GAAG,GAAG,MAAMP,SAAS,CAACQ,IAAI,CAACJ,OAAO,CAACnB,QAAQ,EAAEmB,OAAO,CAACK,QAAQ,EAAErC,SAAS,CAAC;QAC/E,OAAOmC,GAAG;MACZ,CAAC,CAAC,OAAOG,GAAQ,EAAE;QACjB;QACA,IAAI,CAAC/C,MAAM,CAACgD,KAAK,CAAC,iDAAiDD,GAAG,CAACE,OAAO,EAAE,CAAC;QACjF,OAAO,IAAI;MACb;IACF;IAEA,OAAO,IAAI;EACb;EAEAxB,MAAMA,CAAChB,SAAqB,EAAE;IAC5B,MAAMyC,OAAO,GAAGzC,SAAS,CAACI,GAAG,CAACC,kBAAU,CAACC,EAAE,CAAC,EAAE7D,IAAI,EAAE0F,GAAG;IACvD,IAAI,CAACM,OAAO,EAAE,OAAO,IAAI;IACzB,OAAO,KAAIC,mBAAG,EAACD,OAAO,CAACE,QAAQ,EAAE,KAAIC,2BAAW,EAACH,OAAO,CAACI,KAAK,CAAC,CAAC;EAClE;EAEAC,WAAWA,CAAA,EAAG;IACZ,OAAO,IAAI,CAAC5D,QAAQ;EACtB;EAEA6D,uBAAuBA,CAAC/C,SAAoB,EAAE;IAC5C,MAAMoB,GAAG,GAAG,IAAI,CAAC3B,IAAI,CAACuD,YAAY,CAAChD,SAAS,EAAE;MAAEiD,YAAY,EAAE,CAAC,CAAC,IAAI,CAAC3D,SAAS,EAAE4D;IAAiB,CAAC,CAAC,CAAC9B,GAAG;IACvG,MAAM+B,2BAAqC,GAAG/B,GAAG,CAACgC,kBAAkB,GAAGhC,GAAG,CAACgC,kBAAkB,CAACpD,SAAS,CAAC,GAAG,EAAE;IAC7G,MAAMqD,iBAAiB,GAAGF,2BAA2B,CAACG,MAAM,CAAC,IAAI,CAACR,WAAW,CAAC,CAAC,CAAC;IAChF,OAAO;MAAES,IAAI,EAAE,MAAM;MAAEC,OAAO,EAAEH;IAAkB,CAAC;EACrD;EAEAI,uBAAuBA,CAAA,EAAG;IACxB,OAAO,IAAI,CAACV,uBAAuB,CAACW,IAAI,CAAC,IAAI,CAAC;EAChD;EACA;AACF;AACA;AACA;EACEC,iBAAiBA,CAAC/B,SAAoB,EAAE;IACtC,IAAI,CAACjC,aAAa,CAACiE,QAAQ,CAAChC,SAAS,CAAC;IACtC,OAAO,IAAI;EACb;EAqBA,aAAaiC,QAAQA,CACnB,CAAC1E,OAAO,EAAE2E,OAAO,EAAExE,SAAS,EAAEF,GAAG,EAAEC,QAAQ,EAAE0E,YAAY,EAAEvE,QAAQ,EAAEC,IAAI,EAAEuE,KAAK,CAU/E,EACDC,MAAkB,EAClB,CAACvE,WAAW,EAAEC,aAAa,CAA+B,EAC1D;IACA,MAAMJ,MAAM,GAAGwE,YAAY,CAACG,YAAY,CAAC7D,kBAAU,CAACC,EAAE,CAAC;IACvD,MAAM6D,IAAI,GAAG,IAAInF,QAAQ,CACvBiF,MAAM,CAAC/E,QAAQ,EACfC,OAAO,EACPC,GAAG,EACHC,QAAQ,EACRC,SAAS,EACTC,MAAM,EACNC,QAAQ,EACRC,IAAI,EACJC,WAAW,EACXC,aACF,CAAC;IACDwE,IAAI,CAACR,iBAAiB,CAAC,KAAIS,oCAAgB,EAAChF,GAAG,EAAEC,QAAQ,EAAEC,SAAS,CAAC,CAAC;IACtEE,QAAQ,CAAC6E,kBAAkB,CAACF,IAAI,CAACV,uBAAuB,CAAC,CAAC,CAAC;IAE3D,MAAMa,iBAAiB,GAAG,MAAAA,CAAOtE,SAAoB,EAAEuE,IAA2B,KAAK;MACrF,IAAIA,IAAI,EAAEC,QAAQ,KAAK,KAAK,EAAE,OAAOjD,SAAS;MAC9C;MACA,MAAMY,GAAG,GAAG,MAAMgC,IAAI,CAACrC,UAAU,CAAC9B,SAAS,CAAC;MAE5C,OAAO;QACLmC,GAAG,EAAEA,GAAG,EAAEsC,QAAQ,CAAC;QACnB;MACF,CAAC;IACH,CAAC;IAED,IAAInF,SAAS,EAAE;MACbA,SAAS,CAACoF,uBAAuB,CAACJ,iBAAiB,CAAC;IACtD;IACA,IAAIN,KAAK,EAAE;MACTA,KAAK,CAACW,0BAA0B,CAACL,iBAAiB,CAAC;IACrD;IAEAR,OAAO,CAACF,QAAQ,CAAC,MAAM,IAAAgB,mBAAU,EAACT,IAAI,CAAC,CAAC;IAExChF,OAAO,CAAC0F,kBAAkB,CAAC,KAAIC,8BAAqB,EAACX,IAAI,CAAC,CAAC;IAC3D,OAAOA,IAAI;EACb;AACF;AAACY,OAAA,CAAA/F,QAAA,GAAAA,QAAA;AAAAnB,eAAA,CA1LYmB,QAAQ,WAiHJ,CAACgG,eAAI,CAACC,QAAQ,CAAU,CAAC,EAAED,eAAI,CAACC,QAAQ,CAAY,CAAC,CAAC;AAAApH,eAAA,CAjH1DmB,QAAQ,aAmHFkG,kBAAW;AAAArH,eAAA,CAnHjBmB,QAAQ,kBAoHG,CACpBmG,wBAAa,EACbC,wBAAa,EACbC,4BAAe,EACfC,gBAAS,EACTC,0BAAc,EACdC,sBAAY,EACZC,0BAAc,EACdC,kBAAU,EACVC,oBAAW,CACZ;AAAA9H,eAAA,CA9HUmB,QAAQ,mBAgII;EACrBE,QAAQ,EAAE,CAAC,aAAa;AAC1B,CAAC;AA0DHmB,kBAAU,CAACuF,UAAU,CAAC5G,QAAQ,CAAC","ignoreList":[]}
+{"version":3,"names":["_harmony","data","require","_cli","_logger","_compiler","_component","_scope","_pkg","_graphql","_preview","_devFiles","_workspace","_docsEntities","_lodash","_envs","_docs","_docs2","_docs3","_defaultDocReader","_exceptions","_defineProperty","e","r","t","_toPropertyKey","Object","defineProperty","value","enumerable","configurable","writable","i","_toPrimitive","Symbol","toPrimitive","call","TypeError","String","Number","DocsMain","constructor","patterns","preview","pkg","compiler","workspace","logger","devFiles","envs","docPropSlot","docReaderSlot","getDocsMap","components","ComponentMap","as","component","getDocsFiles","getDevFiles","docFiles","get","DocsAspect","id","state","filesystem","files","filter","file","includes","relative","getDescription","componentDoc","getDoc","desc","description","getTemplate","env","getDocsTemplate","isFunction","undefined","getDocReader","extension","values","find","docReader","isFormatSupported","computeDoc","length","docFile","extname","FileExtensionNotSupported","doc","read","contents","err","debug","message","docData","Doc","filePath","DocPropList","props","getPatterns","getComponentDevPatterns","calculateEnv","skipWarnings","inInstallContext","componentEnvDocsDevPatterns","getDocsDevPatterns","componentPatterns","concat","name","pattern","getDevPatternToRegister","bind","registerDocReader","register","provider","graphql","loggerAspect","scope","config","createLogger","docs","DefaultDocReader","registerDevPattern","computeDocsOnLoad","opts","loadDocs","toObject","registerOnComponentLoad","registerOnCompAspectReCalc","docsSchema","registerDefinition","DocsPreviewDefinition","exports","Slot","withType","MainRuntime","PreviewAspect","GraphqlAspect","WorkspaceAspect","PkgAspect","CompilerAspect","LoggerAspect","DevFilesAspect","EnvsAspect","ScopeAspect","addRuntime"],"sources":["docs.main.runtime.ts"],"sourcesContent":["import type { SlotRegistry } from '@teambit/harmony';\nimport { Slot } from '@teambit/harmony';\nimport { MainRuntime } from '@teambit/cli';\nimport type { LoggerMain, Logger } from '@teambit/logger';\nimport { LoggerAspect } from '@teambit/logger';\nimport type { CompilerMain } from '@teambit/compiler';\nimport { CompilerAspect } from '@teambit/compiler';\nimport type { Component, IComponent } from '@teambit/component';\nimport { ComponentMap } from '@teambit/component';\nimport type { ScopeMain } from '@teambit/scope';\nimport { ScopeAspect } from '@teambit/scope';\nimport type { PkgMain } from '@teambit/pkg';\nimport { PkgAspect } from '@teambit/pkg';\nimport type { Environment, EnvsMain } from '@teambit/envs';\nimport type { GraphqlMain } from '@teambit/graphql';\nimport { GraphqlAspect } from '@teambit/graphql';\nimport type { PreviewMain } from '@teambit/preview';\nimport { PreviewAspect } from '@teambit/preview';\nimport type { DevFilesMain } from '@teambit/dev-files';\nimport { DevFilesAspect } from '@teambit/dev-files';\nimport type { ComponentLoadOptions } from '@teambit/legacy.consumer-component';\nimport type { AbstractVinyl } from '@teambit/component.sources';\nimport type { Workspace } from '@teambit/workspace';\nimport { WorkspaceAspect } from '@teambit/workspace';\nimport { Doc, DocPropList } from '@teambit/docs.entities.doc';\nimport { isFunction } from 'lodash';\nimport { EnvsAspect } from '@teambit/envs';\nimport { DocsAspect } from './docs.aspect';\nimport { DocsPreviewDefinition } from './docs.preview-definition';\nimport { docsSchema } from './docs.graphql';\nimport type { DocReader } from './doc-reader';\nimport { DefaultDocReader } from './default-doc-reader';\nimport { FileExtensionNotSupported } from './exceptions';\n\nexport type ComponentDocs = {\n  files: string[];\n  component: Component;\n};\n\nexport type DocProp = {};\n\nexport type DocPropSlot = SlotRegistry<DocProp>;\n\nexport type DocReaderSlot = SlotRegistry<DocReader>;\n\nexport type DocsConfig = {\n  /**\n   * glob patterns to identify doc files.\n   */\n  patterns: string[];\n};\n\n/**\n * the component documentation extension.\n */\nexport class DocsMain {\n  constructor(\n    private patterns: string[],\n    /**\n     * envs extension.\n     */\n    private preview: PreviewMain,\n\n    private pkg: PkgMain,\n\n    private compiler: CompilerMain,\n\n    private workspace: Workspace,\n\n    private logger: Logger,\n\n    private devFiles: DevFilesMain,\n\n    private envs: EnvsMain,\n\n    private docPropSlot: DocPropSlot,\n\n    private docReaderSlot: DocReaderSlot\n  ) {}\n\n  /**\n   * returns an array of doc file paths for a set of components.\n   */\n  getDocsMap(components: Component[]): ComponentMap<AbstractVinyl[]> {\n    return ComponentMap.as<AbstractVinyl[]>(components, (component) => {\n      return this.getDocsFiles(component);\n    });\n  }\n\n  getDocsFiles(component: Component): AbstractVinyl[] {\n    const devFiles = this.devFiles.getDevFiles(component);\n    const docFiles = devFiles.get(DocsAspect.id);\n    return component.state.filesystem.files.filter((file) => docFiles.includes(file.relative));\n  }\n\n  /**\n   * compute the description of the component from its source code and docs file.\n   */\n  async getDescription(component: Component): Promise<string> {\n    const componentDoc = this.getDoc(component);\n    const desc = componentDoc?.description;\n    return desc || '';\n  }\n\n  async getTemplate(env: Environment): Promise<string | undefined> {\n    if (env.getDocsTemplate && isFunction(env.getDocsTemplate)) {\n      return env.getDocsTemplate();\n    }\n    return undefined;\n  }\n\n  getDocReader(extension: string) {\n    return this.docReaderSlot.values().find((docReader) => docReader.isFormatSupported(extension));\n  }\n\n  /**\n   * compute a doc for a component.\n   */\n  async computeDoc(component: Component) {\n    const docFiles = this.getDocsFiles(component);\n    if (docFiles.length) {\n      // currently taking the the first docs file found with an abstract. (we support only one)\n      const docFile = docFiles[0];\n\n      try {\n        const docReader = this.getDocReader(docFile.extname);\n        if (!docReader) throw new FileExtensionNotSupported(docFile.relative, docFile.extname);\n        const doc = await docReader.read(docFile.relative, docFile.contents, component);\n        return doc;\n      } catch (err: any) {\n        // it's ok to fail here.\n        this.logger.debug(`docs.main.runtime.computeDoc caught an error: ${err.message}`);\n        return null;\n      }\n    }\n\n    return null;\n  }\n\n  getDoc(component: IComponent) {\n    const docData = component.get(DocsAspect.id)?.data?.doc;\n    if (!docData) return null;\n    return new Doc(docData.filePath, new DocPropList(docData.props));\n  }\n\n  getPatterns() {\n    return this.patterns;\n  }\n\n  getComponentDevPatterns(component: Component) {\n    const env = this.envs.calculateEnv(component, { skipWarnings: !!this.workspace?.inInstallContext }).env;\n    const componentEnvDocsDevPatterns: string[] = env.getDocsDevPatterns ? env.getDocsDevPatterns(component) : [];\n    const componentPatterns = componentEnvDocsDevPatterns.concat(this.getPatterns());\n    return { name: 'docs', pattern: componentPatterns };\n  }\n\n  getDevPatternToRegister() {\n    return this.getComponentDevPatterns.bind(this);\n  }\n  /**\n   * register a new doc reader. this allows to support further\n   * documentation file formats.\n   */\n  registerDocReader(docReader: DocReader) {\n    this.docReaderSlot.register(docReader);\n    return this;\n  }\n\n  static slots = [Slot.withType<DocProp>(), Slot.withType<DocReader>()];\n\n  static runtime = MainRuntime;\n  static dependencies = [\n    PreviewAspect,\n    GraphqlAspect,\n    WorkspaceAspect,\n    PkgAspect,\n    CompilerAspect,\n    LoggerAspect,\n    DevFilesAspect,\n    EnvsAspect,\n    ScopeAspect,\n  ];\n\n  static defaultConfig = {\n    patterns: ['**/*.docs.*'],\n  };\n\n  static async provider(\n    [preview, graphql, workspace, pkg, compiler, loggerAspect, devFiles, envs, scope]: [\n      PreviewMain,\n      GraphqlMain,\n      Workspace,\n      PkgMain,\n      CompilerMain,\n      LoggerMain,\n      DevFilesMain,\n      EnvsMain,\n      ScopeMain,\n    ],\n    config: DocsConfig,\n    [docPropSlot, docReaderSlot]: [DocPropSlot, DocReaderSlot]\n  ) {\n    const logger = loggerAspect.createLogger(DocsAspect.id);\n    const docs = new DocsMain(\n      config.patterns,\n      preview,\n      pkg,\n      compiler,\n      workspace,\n      logger,\n      devFiles,\n      envs,\n      docPropSlot,\n      docReaderSlot\n    );\n    docs.registerDocReader(new DefaultDocReader(pkg, compiler, workspace));\n    devFiles.registerDevPattern(docs.getDevPatternToRegister());\n\n    const computeDocsOnLoad = async (component: Component, opts?: ComponentLoadOptions) => {\n      if (opts?.loadDocs === false) return undefined;\n      // const docFiles = await docs.computeDocs(component);\n      const doc = await docs.computeDoc(component);\n\n      return {\n        doc: doc?.toObject(),\n        // docFiles\n      };\n    };\n\n    if (workspace) {\n      workspace.registerOnComponentLoad(computeDocsOnLoad);\n    }\n    if (scope) {\n      scope.registerOnCompAspectReCalc(computeDocsOnLoad);\n    }\n\n    graphql.register(() => docsSchema(docs));\n\n    preview.registerDefinition(new DocsPreviewDefinition(docs));\n    return docs;\n  }\n}\n\nDocsAspect.addRuntime(DocsMain);\n"],"mappings":";;;;;;AACA,SAAAA,SAAA;EAAA,MAAAC,IAAA,GAAAC,OAAA;EAAAF,QAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAE,KAAA;EAAA,MAAAF,IAAA,GAAAC,OAAA;EAAAC,IAAA,YAAAA,CAAA;IAAA,OAAAF,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAG,QAAA;EAAA,MAAAH,IAAA,GAAAC,OAAA;EAAAE,OAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAI,UAAA;EAAA,MAAAJ,IAAA,GAAAC,OAAA;EAAAG,SAAA,YAAAA,CAAA;IAAA,OAAAJ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAK,WAAA;EAAA,MAAAL,IAAA,GAAAC,OAAA;EAAAI,UAAA,YAAAA,CAAA;IAAA,OAAAL,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAM,OAAA;EAAA,MAAAN,IAAA,GAAAC,OAAA;EAAAK,MAAA,YAAAA,CAAA;IAAA,OAAAN,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAO,KAAA;EAAA,MAAAP,IAAA,GAAAC,OAAA;EAAAM,IAAA,YAAAA,CAAA;IAAA,OAAAP,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAGA,SAAAQ,SAAA;EAAA,MAAAR,IAAA,GAAAC,OAAA;EAAAO,QAAA,YAAAA,CAAA;IAAA,OAAAR,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAS,SAAA;EAAA,MAAAT,IAAA,GAAAC,OAAA;EAAAQ,QAAA,YAAAA,CAAA;IAAA,OAAAT,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAU,UAAA;EAAA,MAAAV,IAAA,GAAAC,OAAA;EAAAS,SAAA,YAAAA,CAAA;IAAA,OAAAV,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAIA,SAAAW,WAAA;EAAA,MAAAX,IAAA,GAAAC,OAAA;EAAAU,UAAA,YAAAA,CAAA;IAAA,OAAAX,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAY,cAAA;EAAA,MAAAZ,IAAA,GAAAC,OAAA;EAAAW,aAAA,YAAAA,CAAA;IAAA,OAAAZ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAa,QAAA;EAAA,MAAAb,IAAA,GAAAC,OAAA;EAAAY,OAAA,YAAAA,CAAA;IAAA,OAAAb,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAc,MAAA;EAAA,MAAAd,IAAA,GAAAC,OAAA;EAAAa,KAAA,YAAAA,CAAA;IAAA,OAAAd,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAe,MAAA;EAAA,MAAAf,IAAA,GAAAC,OAAA;EAAAc,KAAA,YAAAA,CAAA;IAAA,OAAAf,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAgB,OAAA;EAAA,MAAAhB,IAAA,GAAAC,OAAA;EAAAe,MAAA,YAAAA,CAAA;IAAA,OAAAhB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAiB,OAAA;EAAA,MAAAjB,IAAA,GAAAC,OAAA;EAAAgB,MAAA,YAAAA,CAAA;IAAA,OAAAjB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAkB,kBAAA;EAAA,MAAAlB,IAAA,GAAAC,OAAA;EAAAiB,iBAAA,YAAAA,CAAA;IAAA,OAAAlB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAmB,YAAA;EAAA,MAAAnB,IAAA,GAAAC,OAAA;EAAAkB,WAAA,YAAAA,CAAA;IAAA,OAAAnB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAAyD,SAAAoB,gBAAAC,CAAA,EAAAC,CAAA,EAAAC,CAAA,YAAAD,CAAA,GAAAE,cAAA,CAAAF,CAAA,MAAAD,CAAA,GAAAI,MAAA,CAAAC,cAAA,CAAAL,CAAA,EAAAC,CAAA,IAAAK,KAAA,EAAAJ,CAAA,EAAAK,UAAA,MAAAC,YAAA,MAAAC,QAAA,UAAAT,CAAA,CAAAC,CAAA,IAAAC,CAAA,EAAAF,CAAA;AAAA,SAAAG,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,MAAAF,CAAA,GAAAE,CAAA,CAAAU,MAAA,CAAAC,WAAA,kBAAAb,CAAA,QAAAU,CAAA,GAAAV,CAAA,CAAAc,IAAA,CAAAZ,CAAA,EAAAD,CAAA,uCAAAS,CAAA,SAAAA,CAAA,YAAAK,SAAA,yEAAAd,CAAA,GAAAe,MAAA,GAAAC,MAAA,EAAAf,CAAA;AAoBzD;AACA;AACA;AACO,MAAMgB,QAAQ,CAAC;EACpBC,WAAWA,CACDC,QAAkB;EAC1B;AACJ;AACA;EACYC,OAAoB,EAEpBC,GAAY,EAEZC,QAAsB,EAEtBC,SAAoB,EAEpBC,MAAc,EAEdC,QAAsB,EAEtBC,IAAc,EAEdC,WAAwB,EAExBC,aAA4B,EACpC;IAAA,KArBQT,QAAkB,GAAlBA,QAAkB;IAAA,KAIlBC,OAAoB,GAApBA,OAAoB;IAAA,KAEpBC,GAAY,GAAZA,GAAY;IAAA,KAEZC,QAAsB,GAAtBA,QAAsB;IAAA,KAEtBC,SAAoB,GAApBA,SAAoB;IAAA,KAEpBC,MAAc,GAAdA,MAAc;IAAA,KAEdC,QAAsB,GAAtBA,QAAsB;IAAA,KAEtBC,IAAc,GAAdA,IAAc;IAAA,KAEdC,WAAwB,GAAxBA,WAAwB;IAAA,KAExBC,aAA4B,GAA5BA,aAA4B;EACnC;;EAEH;AACF;AACA;EACEC,UAAUA,CAACC,UAAuB,EAAiC;IACjE,OAAOC,yBAAY,CAACC,EAAE,CAAkBF,UAAU,EAAGG,SAAS,IAAK;MACjE,OAAO,IAAI,CAACC,YAAY,CAACD,SAAS,CAAC;IACrC,CAAC,CAAC;EACJ;EAEAC,YAAYA,CAACD,SAAoB,EAAmB;IAClD,MAAMR,QAAQ,GAAG,IAAI,CAACA,QAAQ,CAACU,WAAW,CAACF,SAAS,CAAC;IACrD,MAAMG,QAAQ,GAAGX,QAAQ,CAACY,GAAG,CAACC,kBAAU,CAACC,EAAE,CAAC;IAC5C,OAAON,SAAS,CAACO,KAAK,CAACC,UAAU,CAACC,KAAK,CAACC,MAAM,CAAEC,IAAI,IAAKR,QAAQ,CAACS,QAAQ,CAACD,IAAI,CAACE,QAAQ,CAAC,CAAC;EAC5F;;EAEA;AACF;AACA;EACE,MAAMC,cAAcA,CAACd,SAAoB,EAAmB;IAC1D,MAAMe,YAAY,GAAG,IAAI,CAACC,MAAM,CAAChB,SAAS,CAAC;IAC3C,MAAMiB,IAAI,GAAGF,YAAY,EAAEG,WAAW;IACtC,OAAOD,IAAI,IAAI,EAAE;EACnB;EAEA,MAAME,WAAWA,CAACC,GAAgB,EAA+B;IAC/D,IAAIA,GAAG,CAACC,eAAe,IAAI,IAAAC,oBAAU,EAACF,GAAG,CAACC,eAAe,CAAC,EAAE;MAC1D,OAAOD,GAAG,CAACC,eAAe,CAAC,CAAC;IAC9B;IACA,OAAOE,SAAS;EAClB;EAEAC,YAAYA,CAACC,SAAiB,EAAE;IAC9B,OAAO,IAAI,CAAC9B,aAAa,CAAC+B,MAAM,CAAC,CAAC,CAACC,IAAI,CAAEC,SAAS,IAAKA,SAAS,CAACC,iBAAiB,CAACJ,SAAS,CAAC,CAAC;EAChG;;EAEA;AACF;AACA;EACE,MAAMK,UAAUA,CAAC9B,SAAoB,EAAE;IACrC,MAAMG,QAAQ,GAAG,IAAI,CAACF,YAAY,CAACD,SAAS,CAAC;IAC7C,IAAIG,QAAQ,CAAC4B,MAAM,EAAE;MACnB;MACA,MAAMC,OAAO,GAAG7B,QAAQ,CAAC,CAAC,CAAC;MAE3B,IAAI;QACF,MAAMyB,SAAS,GAAG,IAAI,CAACJ,YAAY,CAACQ,OAAO,CAACC,OAAO,CAAC;QACpD,IAAI,CAACL,SAAS,EAAE,MAAM,KAAIM,uCAAyB,EAACF,OAAO,CAACnB,QAAQ,EAAEmB,OAAO,CAACC,OAAO,CAAC;QACtF,MAAME,GAAG,GAAG,MAAMP,SAAS,CAACQ,IAAI,CAACJ,OAAO,CAACnB,QAAQ,EAAEmB,OAAO,CAACK,QAAQ,EAAErC,SAAS,CAAC;QAC/E,OAAOmC,GAAG;MACZ,CAAC,CAAC,OAAOG,GAAQ,EAAE;QACjB;QACA,IAAI,CAAC/C,MAAM,CAACgD,KAAK,CAAC,iDAAiDD,GAAG,CAACE,OAAO,EAAE,CAAC;QACjF,OAAO,IAAI;MACb;IACF;IAEA,OAAO,IAAI;EACb;EAEAxB,MAAMA,CAAChB,SAAqB,EAAE;IAC5B,MAAMyC,OAAO,GAAGzC,SAAS,CAACI,GAAG,CAACC,kBAAU,CAACC,EAAE,CAAC,EAAE7D,IAAI,EAAE0F,GAAG;IACvD,IAAI,CAACM,OAAO,EAAE,OAAO,IAAI;IACzB,OAAO,KAAIC,mBAAG,EAACD,OAAO,CAACE,QAAQ,EAAE,KAAIC,2BAAW,EAACH,OAAO,CAACI,KAAK,CAAC,CAAC;EAClE;EAEAC,WAAWA,CAAA,EAAG;IACZ,OAAO,IAAI,CAAC5D,QAAQ;EACtB;EAEA6D,uBAAuBA,CAAC/C,SAAoB,EAAE;IAC5C,MAAMoB,GAAG,GAAG,IAAI,CAAC3B,IAAI,CAACuD,YAAY,CAAChD,SAAS,EAAE;MAAEiD,YAAY,EAAE,CAAC,CAAC,IAAI,CAAC3D,SAAS,EAAE4D;IAAiB,CAAC,CAAC,CAAC9B,GAAG;IACvG,MAAM+B,2BAAqC,GAAG/B,GAAG,CAACgC,kBAAkB,GAAGhC,GAAG,CAACgC,kBAAkB,CAACpD,SAAS,CAAC,GAAG,EAAE;IAC7G,MAAMqD,iBAAiB,GAAGF,2BAA2B,CAACG,MAAM,CAAC,IAAI,CAACR,WAAW,CAAC,CAAC,CAAC;IAChF,OAAO;MAAES,IAAI,EAAE,MAAM;MAAEC,OAAO,EAAEH;IAAkB,CAAC;EACrD;EAEAI,uBAAuBA,CAAA,EAAG;IACxB,OAAO,IAAI,CAACV,uBAAuB,CAACW,IAAI,CAAC,IAAI,CAAC;EAChD;EACA;AACF;AACA;AACA;EACEC,iBAAiBA,CAAC/B,SAAoB,EAAE;IACtC,IAAI,CAACjC,aAAa,CAACiE,QAAQ,CAAChC,SAAS,CAAC;IACtC,OAAO,IAAI;EACb;EAqBA,aAAaiC,QAAQA,CACnB,CAAC1E,OAAO,EAAE2E,OAAO,EAAExE,SAAS,EAAEF,GAAG,EAAEC,QAAQ,EAAE0E,YAAY,EAAEvE,QAAQ,EAAEC,IAAI,EAAEuE,KAAK,CAU/E,EACDC,MAAkB,EAClB,CAACvE,WAAW,EAAEC,aAAa,CAA+B,EAC1D;IACA,MAAMJ,MAAM,GAAGwE,YAAY,CAACG,YAAY,CAAC7D,kBAAU,CAACC,EAAE,CAAC;IACvD,MAAM6D,IAAI,GAAG,IAAInF,QAAQ,CACvBiF,MAAM,CAAC/E,QAAQ,EACfC,OAAO,EACPC,GAAG,EACHC,QAAQ,EACRC,SAAS,EACTC,MAAM,EACNC,QAAQ,EACRC,IAAI,EACJC,WAAW,EACXC,aACF,CAAC;IACDwE,IAAI,CAACR,iBAAiB,CAAC,KAAIS,oCAAgB,EAAChF,GAAG,EAAEC,QAAQ,EAAEC,SAAS,CAAC,CAAC;IACtEE,QAAQ,CAAC6E,kBAAkB,CAACF,IAAI,CAACV,uBAAuB,CAAC,CAAC,CAAC;IAE3D,MAAMa,iBAAiB,GAAG,MAAAA,CAAOtE,SAAoB,EAAEuE,IAA2B,KAAK;MACrF,IAAIA,IAAI,EAAEC,QAAQ,KAAK,KAAK,EAAE,OAAOjD,SAAS;MAC9C;MACA,MAAMY,GAAG,GAAG,MAAMgC,IAAI,CAACrC,UAAU,CAAC9B,SAAS,CAAC;MAE5C,OAAO;QACLmC,GAAG,EAAEA,GAAG,EAAEsC,QAAQ,CAAC;QACnB;MACF,CAAC;IACH,CAAC;IAED,IAAInF,SAAS,EAAE;MACbA,SAAS,CAACoF,uBAAuB,CAACJ,iBAAiB,CAAC;IACtD;IACA,IAAIN,KAAK,EAAE;MACTA,KAAK,CAACW,0BAA0B,CAACL,iBAAiB,CAAC;IACrD;IAEAR,OAAO,CAACF,QAAQ,CAAC,MAAM,IAAAgB,mBAAU,EAACT,IAAI,CAAC,CAAC;IAExChF,OAAO,CAAC0F,kBAAkB,CAAC,KAAIC,8BAAqB,EAACX,IAAI,CAAC,CAAC;IAC3D,OAAOA,IAAI;EACb;AACF;AAACY,OAAA,CAAA/F,QAAA,GAAAA,QAAA;AAAAnB,eAAA,CA1LYmB,QAAQ,WAiHJ,CAACgG,eAAI,CAACC,QAAQ,CAAU,CAAC,EAAED,eAAI,CAACC,QAAQ,CAAY,CAAC,CAAC;AAAApH,eAAA,CAjH1DmB,QAAQ,aAmHFkG,kBAAW;AAAArH,eAAA,CAnHjBmB,QAAQ,kBAoHG,CACpBmG,wBAAa,EACbC,wBAAa,EACbC,4BAAe,EACfC,gBAAS,EACTC,0BAAc,EACdC,sBAAY,EACZC,0BAAc,EACdC,kBAAU,EACVC,oBAAW,CACZ;AAAA9H,eAAA,CA9HUmB,QAAQ,mBAgII;EACrBE,QAAQ,EAAE,CAAC,aAAa;AAC1B,CAAC;AA0DHmB,kBAAU,CAACuF,UAAU,CAAC5G,QAAQ,CAAC","ignoreList":[]}

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

@@ -1,8 +1,8 @@
-import { Component, ComponentMap } from '@teambit/component';
+import type { Component, ComponentMap } from '@teambit/component';
 import type { Environment, ExecutionContext } from '@teambit/envs';
-import { PreviewDefinition } from '@teambit/preview';
-import { AbstractVinyl } from '@teambit/component.sources';
-import { DocsMain } from './docs.main.runtime';
+import type { PreviewDefinition } from '@teambit/preview';
+import type { AbstractVinyl } from '@teambit/component.sources';
+import type { DocsMain } from './docs.main.runtime';
 export declare class DocsPreviewDefinition implements PreviewDefinition {
     /**
      * docs extension.

package/dist/docs.preview-definition.js.map

@@ -1 +1 @@
-{"version":3,"names":["DocsPreviewDefinition","constructor","docs","_defineProperty","renderTemplatePath","context","renderTemplatePathByEnv","env","getTemplate","getModuleMap","components","map","getDocsMap","exports"],"sources":["docs.preview-definition.ts"],"sourcesContent":["import { Component, ComponentMap } from '@teambit/component';\nimport type { Environment, ExecutionContext } from '@teambit/envs';\nimport { PreviewDefinition } from '@teambit/preview';\nimport { AbstractVinyl } from '@teambit/component.sources';\n\nimport { DocsMain } from './docs.main.runtime';\n\nexport class DocsPreviewDefinition implements PreviewDefinition {\n  readonly prefix = 'overview';\n  readonly include = ['compositions'];\n  readonly includePeers = true;\n\n  constructor(\n    /**\n     * docs extension.\n     */\n    private docs: DocsMain\n  ) {}\n\n  /**\n   * application root\n   */\n  async renderTemplatePath(context: ExecutionContext): Promise<string | undefined> {\n    return this.renderTemplatePathByEnv(context.env);\n  }\n\n  async renderTemplatePathByEnv(env: Environment): Promise<string | undefined> {\n    return this.docs.getTemplate(env);\n  }\n\n  /**\n   * files to load.\n   */\n  async getModuleMap(components: Component[]): Promise<ComponentMap<AbstractVinyl[]>> {\n    const map = this.docs.getDocsMap(components);\n    return map;\n  }\n}\n"],"mappings":";;;;;;;;;AAOO,MAAMA,qBAAqB,CAA8B;EAK9DC,WAAWA;EACT;AACJ;AACA;EACYC,IAAc,EACtB;IAAA,KADQA,IAAc,GAAdA,IAAc;IAAAC,eAAA,iBARN,UAAU;IAAAA,eAAA,kBACT,CAAC,cAAc,CAAC;IAAAA,eAAA,uBACX,IAAI;EAOzB;;EAEH;AACF;AACA;EACE,MAAMC,kBAAkBA,CAACC,OAAyB,EAA+B;IAC/E,OAAO,IAAI,CAACC,uBAAuB,CAACD,OAAO,CAACE,GAAG,CAAC;EAClD;EAEA,MAAMD,uBAAuBA,CAACC,GAAgB,EAA+B;IAC3E,OAAO,IAAI,CAACL,IAAI,CAACM,WAAW,CAACD,GAAG,CAAC;EACnC;;EAEA;AACF;AACA;EACE,MAAME,YAAYA,CAACC,UAAuB,EAA0C;IAClF,MAAMC,GAAG,GAAG,IAAI,CAACT,IAAI,CAACU,UAAU,CAACF,UAAU,CAAC;IAC5C,OAAOC,GAAG;EACZ;AACF;AAACE,OAAA,CAAAb,qBAAA,GAAAA,qBAAA","ignoreList":[]}
+{"version":3,"names":["DocsPreviewDefinition","constructor","docs","_defineProperty","renderTemplatePath","context","renderTemplatePathByEnv","env","getTemplate","getModuleMap","components","map","getDocsMap","exports"],"sources":["docs.preview-definition.ts"],"sourcesContent":["import type { Component, ComponentMap } from '@teambit/component';\nimport type { Environment, ExecutionContext } from '@teambit/envs';\nimport type { PreviewDefinition } from '@teambit/preview';\nimport type { AbstractVinyl } from '@teambit/component.sources';\n\nimport type { DocsMain } from './docs.main.runtime';\n\nexport class DocsPreviewDefinition implements PreviewDefinition {\n  readonly prefix = 'overview';\n  readonly include = ['compositions'];\n  readonly includePeers = true;\n\n  constructor(\n    /**\n     * docs extension.\n     */\n    private docs: DocsMain\n  ) {}\n\n  /**\n   * application root\n   */\n  async renderTemplatePath(context: ExecutionContext): Promise<string | undefined> {\n    return this.renderTemplatePathByEnv(context.env);\n  }\n\n  async renderTemplatePathByEnv(env: Environment): Promise<string | undefined> {\n    return this.docs.getTemplate(env);\n  }\n\n  /**\n   * files to load.\n   */\n  async getModuleMap(components: Component[]): Promise<ComponentMap<AbstractVinyl[]>> {\n    const map = this.docs.getDocsMap(components);\n    return map;\n  }\n}\n"],"mappings":";;;;;;;;;AAOO,MAAMA,qBAAqB,CAA8B;EAK9DC,WAAWA;EACT;AACJ;AACA;EACYC,IAAc,EACtB;IAAA,KADQA,IAAc,GAAdA,IAAc;IAAAC,eAAA,iBARN,UAAU;IAAAA,eAAA,kBACT,CAAC,cAAc,CAAC;IAAAA,eAAA,uBACX,IAAI;EAOzB;;EAEH;AACF;AACA;EACE,MAAMC,kBAAkBA,CAACC,OAAyB,EAA+B;IAC/E,OAAO,IAAI,CAACC,uBAAuB,CAACD,OAAO,CAACE,GAAG,CAAC;EAClD;EAEA,MAAMD,uBAAuBA,CAACC,GAAgB,EAA+B;IAC3E,OAAO,IAAI,CAACL,IAAI,CAACM,WAAW,CAACD,GAAG,CAAC;EACnC;;EAEA;AACF;AACA;EACE,MAAME,YAAYA,CAACC,UAAuB,EAA0C;IAClF,MAAMC,GAAG,GAAG,IAAI,CAACT,IAAI,CAACU,UAAU,CAACF,UAAU,CAAC;IAC5C,OAAOC,GAAG;EACZ;AACF;AAACE,OAAA,CAAAb,qBAAA,GAAAA,qBAAA","ignoreList":[]}

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

@@ -1,6 +1,6 @@
 import React from 'react';
-import { RenderingContext, PreviewPreview, PreviewModule } from '@teambit/preview';
-import { ComponentID } from '@teambit/component-id';
+import type { RenderingContext, PreviewPreview, PreviewModule } from '@teambit/preview';
+import type { ComponentID } from '@teambit/component-id';
 import type { Docs } from './docs';
 export type DocsRootProps = {
     Provider: React.ComponentType | undefined;

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","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":[]}
+{"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 type { ReactNode } from 'react';\nimport React from 'react';\nimport type { RenderingContext, PreviewPreview, PreviewModule } from '@teambit/preview';\nimport { PreviewAspect, PreviewRuntime } from '@teambit/preview';\nimport type { 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":";;;;;;AACA,SAAAA,OAAA;EAAA,MAAAC,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAH,MAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,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/docs.service.d.ts

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

package/dist/docs.service.js.map

@@ -1 +1 @@
-{"version":3,"names":["DocsService","constructor","_defineProperty","run","context","env","getDocsTemplate","exports"],"sources":["docs.service.ts"],"sourcesContent":["import { EnvService, ExecutionContext } from '@teambit/envs';\n\nexport class DocsService implements EnvService<any> {\n  name = 'docs';\n\n  async run(context: ExecutionContext) {\n    return context.env.getDocsTemplate?.();\n  }\n}\n"],"mappings":";;;;;;;;;AAEO,MAAMA,WAAW,CAA4B;EAAAC,YAAA;IAAAC,eAAA,eAC3C,MAAM;EAAA;EAEb,MAAMC,GAAGA,CAACC,OAAyB,EAAE;IACnC,OAAOA,OAAO,CAACC,GAAG,CAACC,eAAe,GAAG,CAAC;EACxC;AACF;AAACC,OAAA,CAAAP,WAAA,GAAAA,WAAA","ignoreList":[]}
+{"version":3,"names":["DocsService","constructor","_defineProperty","run","context","env","getDocsTemplate","exports"],"sources":["docs.service.ts"],"sourcesContent":["import type { EnvService, ExecutionContext } from '@teambit/envs';\n\nexport class DocsService implements EnvService<any> {\n  name = 'docs';\n\n  async run(context: ExecutionContext) {\n    return context.env.getDocsTemplate?.();\n  }\n}\n"],"mappings":";;;;;;;;;AAEO,MAAMA,WAAW,CAA4B;EAAAC,YAAA;IAAAC,eAAA,eAC3C,MAAM;EAAA;EAEb,MAAMC,GAAGA,CAACC,OAAyB,EAAE;IACnC,OAAOA,OAAO,CAACC,GAAG,CAACC,eAAe,GAAG,CAAC;EACxC;AACF;AAACC,OAAA,CAAAP,WAAA,GAAAA,WAAA","ignoreList":[]}

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

@@ -1,9 +1,9 @@
-import React, { ComponentType } from 'react';
-import { ComponentUI } from '@teambit/component';
-import { SlotRegistry } from '@teambit/harmony';
-import { ComponentCompareUI } from '@teambit/component-compare';
-import { UseSandboxPermission } from '@teambit/preview.ui.component-preview';
-import { APIReferenceUI } from '@teambit/api-reference';
+import type { ComponentType } from 'react';
+import type { ComponentUI } from '@teambit/component';
+import type { SlotRegistry } from '@teambit/harmony';
+import type { ComponentCompareUI } from '@teambit/component-compare';
+import type { UseSandboxPermission } from '@teambit/preview.ui.component-preview';
+import type { APIReferenceUI } from '@teambit/api-reference';
 import type { TitleBadgeSlot, TitleBadge, OverviewOptionsSlot, OverviewOptions } from './overview';
 export type UsePreviewSandboxSlot = SlotRegistry<UseSandboxPermission>;
 export declare class DocsUI {
@@ -20,9 +20,9 @@ export declare class DocsUI {
      */
     listTitleBadges(): TitleBadge[];
     private _emptyState?;
-    registerEmptyState(emptyState: ComponentType): React.ComponentType;
+    registerEmptyState(emptyState: ComponentType): ComponentType;
     registerPreviewSandbox(useSandboxPermission: UseSandboxPermission): void;
-    getEmptyState(): React.ComponentType | undefined;
+    getEmptyState(): ComponentType | undefined;
     getDocsCompare(): import("react/jsx-runtime").JSX.Element;
     registerOverviewOptions(options: OverviewOptions): void;
     static dependencies: import("@teambit/harmony").Aspect[];

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

@@ -1 +1 @@
-{"version":3,"names":["_react","data","_interopRequireDefault","require","_lodash","_component","_harmony","_ui","_componentCompare","_docsUi","_docsUi2","_apiReference","_docs","_overview","e","__esModule","default","_defineProperty","r","t","_toPropertyKey","Object","defineProperty","value","enumerable","configurable","writable","i","_toPrimitive","Symbol","toPrimitive","call","TypeError","String","Number","DocsUI","constructor","titleBadgeSlot","overviewOptionsSlot","usePreviewSandboxSlot","registerTitleBadge","titleBadges","badges","Array","isArray","register","listTitleBadges","flatten","values","registerEmptyState","emptyState","_emptyState","registerPreviewSandbox","useSandboxPermission","getEmptyState","getDocsCompare","createElement","OverviewCompare","overviewOptions","registerOverviewOptions","options","provider","component","componentCompare","apiRef","config","docs","section","OverviewSection","compareSection","OverviewCompareSection","registerRoute","route","registerNavigation","navigationLink","order","registerRoutes","manager","componentModel","host","add","exports","ComponentAspect","ComponentCompareAspect","APIReferenceAspect","UIRuntime","Slot","withType","_default","DocsAspect","addRuntime"],"sources":["docs.ui.runtime.tsx"],"sourcesContent":["import React, { ComponentType } from 'react';\nimport { flatten } from 'lodash';\nimport { ComponentAspect, ComponentUI } from '@teambit/component';\nimport { Slot, SlotRegistry } from '@teambit/harmony';\nimport { UIRuntime } from '@teambit/ui';\nimport { ComponentCompareAspect, ComponentCompareUI } from '@teambit/component-compare';\nimport { OverviewCompare } from '@teambit/docs.ui.overview-compare';\nimport { OverviewCompareSection } from '@teambit/docs.ui.overview-compare-section';\nimport { UseSandboxPermission } from '@teambit/preview.ui.component-preview';\nimport { APIReferenceAspect, APIReferenceUI } from '@teambit/api-reference';\nimport { DocsAspect } from './docs.aspect';\nimport { OverviewSection } from './overview.section';\nimport type { TitleBadgeSlot, TitleBadge, OverviewOptionsSlot, OverviewOptions } from './overview';\n\nexport type UsePreviewSandboxSlot = SlotRegistry<UseSandboxPermission>;\n\nexport class DocsUI {\n  constructor(\n    readonly titleBadgeSlot: TitleBadgeSlot,\n    readonly overviewOptionsSlot: OverviewOptionsSlot,\n    private usePreviewSandboxSlot: UsePreviewSandboxSlot\n  ) {}\n\n  /**\n   * register a new title badge into the overview section of a component.\n   */\n  registerTitleBadge(titleBadges: TitleBadge | TitleBadge[]) {\n    const badges = Array.isArray(titleBadges) ? titleBadges : [titleBadges];\n    this.titleBadgeSlot.register(badges);\n    return this;\n  }\n\n  /**\n   * list all title badges registered.\n   */\n  listTitleBadges() {\n    return flatten(this.titleBadgeSlot.values());\n  }\n\n  private _emptyState?: ComponentType;\n\n  registerEmptyState(emptyState: ComponentType) {\n    return (this._emptyState = emptyState);\n  }\n\n  registerPreviewSandbox(useSandboxPermission: UseSandboxPermission) {\n    this.usePreviewSandboxSlot.register(useSandboxPermission);\n  }\n\n  getEmptyState() {\n    return this._emptyState;\n  }\n\n  getDocsCompare() {\n    return <OverviewCompare titleBadges={this.titleBadgeSlot} overviewOptions={this.overviewOptionsSlot} />;\n  }\n\n  registerOverviewOptions(options: OverviewOptions) {\n    this.overviewOptionsSlot.register(options);\n  }\n\n  static dependencies = [ComponentAspect, ComponentCompareAspect, APIReferenceAspect];\n\n  static runtime = UIRuntime;\n\n  static slots = [Slot.withType<TitleBadge>(), Slot.withType<OverviewOptions>(), Slot.withType<UseSandboxPermission>()];\n\n  static async provider(\n    [component, componentCompare, apiRef]: [ComponentUI, ComponentCompareUI, APIReferenceUI],\n    config,\n    [titleBadgeSlot, overviewOptionsSlot, usePreviewSandboxSlot]: [\n      TitleBadgeSlot,\n      OverviewOptionsSlot,\n      UsePreviewSandboxSlot,\n    ]\n  ) {\n    const docs = new DocsUI(titleBadgeSlot, overviewOptionsSlot, usePreviewSandboxSlot);\n    const section = new OverviewSection(titleBadgeSlot, overviewOptionsSlot, docs, apiRef, usePreviewSandboxSlot);\n    const compareSection = new OverviewCompareSection(docs);\n    component.registerRoute(section.route);\n    component.registerNavigation(section.navigationLink, section.order);\n    componentCompare.registerNavigation(compareSection);\n    componentCompare.registerRoutes([compareSection.route]);\n    docs.registerPreviewSandbox((manager, componentModel) => {\n      if (componentModel?.host === 'teambit.scope/scope') {\n        manager.add('allow-scripts');\n        manager.add('allow-same-origin');\n      }\n    });\n    return docs;\n  }\n}\n\nexport default DocsUI;\n\nDocsAspect.addRuntime(DocsUI);\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,QAAA;EAAA,MAAAH,IAAA,GAAAE,OAAA;EAAAC,OAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAI,WAAA;EAAA,MAAAJ,IAAA,GAAAE,OAAA;EAAAE,UAAA,YAAAA,CAAA;IAAA,OAAAJ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAK,SAAA;EAAA,MAAAL,IAAA,GAAAE,OAAA;EAAAG,QAAA,YAAAA,CAAA;IAAA,OAAAL,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAM,IAAA;EAAA,MAAAN,IAAA,GAAAE,OAAA;EAAAI,GAAA,YAAAA,CAAA;IAAA,OAAAN,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAO,kBAAA;EAAA,MAAAP,IAAA,GAAAE,OAAA;EAAAK,iBAAA,YAAAA,CAAA;IAAA,OAAAP,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAQ,QAAA;EAAA,MAAAR,IAAA,GAAAE,OAAA;EAAAM,OAAA,YAAAA,CAAA;IAAA,OAAAR,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAS,SAAA;EAAA,MAAAT,IAAA,GAAAE,OAAA;EAAAO,QAAA,YAAAA,CAAA;IAAA,OAAAT,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAU,cAAA;EAAA,MAAAV,IAAA,GAAAE,OAAA;EAAAQ,aAAA,YAAAA,CAAA;IAAA,OAAAV,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAW,MAAA;EAAA,MAAAX,IAAA,GAAAE,OAAA;EAAAS,KAAA,YAAAA,CAAA;IAAA,OAAAX,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAY,UAAA;EAAA,MAAAZ,IAAA,GAAAE,OAAA;EAAAU,SAAA,YAAAA,CAAA;IAAA,OAAAZ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAAqD,SAAAC,uBAAAY,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;AAK9C,MAAMgB,MAAM,CAAC;EAClBC,WAAWA,CACAC,cAA8B,EAC9BC,mBAAwC,EACzCC,qBAA4C,EACpD;IAAA,KAHSF,cAA8B,GAA9BA,cAA8B;IAAA,KAC9BC,mBAAwC,GAAxCA,mBAAwC;IAAA,KACzCC,qBAA4C,GAA5CA,qBAA4C;IAAAtB,eAAA;EACnD;;EAEH;AACF;AACA;EACEuB,kBAAkBA,CAACC,WAAsC,EAAE;IACzD,MAAMC,MAAM,GAAGC,KAAK,CAACC,OAAO,CAACH,WAAW,CAAC,GAAGA,WAAW,GAAG,CAACA,WAAW,CAAC;IACvE,IAAI,CAACJ,cAAc,CAACQ,QAAQ,CAACH,MAAM,CAAC;IACpC,OAAO,IAAI;EACb;;EAEA;AACF;AACA;EACEI,eAAeA,CAAA,EAAG;IAChB,OAAO,IAAAC,iBAAO,EAAC,IAAI,CAACV,cAAc,CAACW,MAAM,CAAC,CAAC,CAAC;EAC9C;EAIAC,kBAAkBA,CAACC,UAAyB,EAAE;IAC5C,OAAQ,IAAI,CAACC,WAAW,GAAGD,UAAU;EACvC;EAEAE,sBAAsBA,CAACC,oBAA0C,EAAE;IACjE,IAAI,CAACd,qBAAqB,CAACM,QAAQ,CAACQ,oBAAoB,CAAC;EAC3D;EAEAC,aAAaA,CAAA,EAAG;IACd,OAAO,IAAI,CAACH,WAAW;EACzB;EAEAI,cAAcA,CAAA,EAAG;IACf,oBAAOvD,MAAA,GAAAgB,OAAA,CAAAwC,aAAA,CAAC/C,OAAA,GAAAgD,eAAe;MAAChB,WAAW,EAAE,IAAI,CAACJ,cAAe;MAACqB,eAAe,EAAE,IAAI,CAACpB;IAAoB,CAAE,CAAC;EACzG;EAEAqB,uBAAuBA,CAACC,OAAwB,EAAE;IAChD,IAAI,CAACtB,mBAAmB,CAACO,QAAQ,CAACe,OAAO,CAAC;EAC5C;EAQA,aAAaC,QAAQA,CACnB,CAACC,SAAS,EAAEC,gBAAgB,EAAEC,MAAM,CAAoD,EACxFC,MAAM,EACN,CAAC5B,cAAc,EAAEC,mBAAmB,EAAEC,qBAAqB,CAI1D,EACD;IACA,MAAM2B,IAAI,GAAG,IAAI/B,MAAM,CAACE,cAAc,EAAEC,mBAAmB,EAAEC,qBAAqB,CAAC;IACnF,MAAM4B,OAAO,GAAG,KAAIC,2BAAe,EAAC/B,cAAc,EAAEC,mBAAmB,EAAE4B,IAAI,EAAEF,MAAM,EAAEzB,qBAAqB,CAAC;IAC7G,MAAM8B,cAAc,GAAG,KAAIC,iCAAsB,EAACJ,IAAI,CAAC;IACvDJ,SAAS,CAACS,aAAa,CAACJ,OAAO,CAACK,KAAK,CAAC;IACtCV,SAAS,CAACW,kBAAkB,CAACN,OAAO,CAACO,cAAc,EAAEP,OAAO,CAACQ,KAAK,CAAC;IACnEZ,gBAAgB,CAACU,kBAAkB,CAACJ,cAAc,CAAC;IACnDN,gBAAgB,CAACa,cAAc,CAAC,CAACP,cAAc,CAACG,KAAK,CAAC,CAAC;IACvDN,IAAI,CAACd,sBAAsB,CAAC,CAACyB,OAAO,EAAEC,cAAc,KAAK;MACvD,IAAIA,cAAc,EAAEC,IAAI,KAAK,qBAAqB,EAAE;QAClDF,OAAO,CAACG,GAAG,CAAC,eAAe,CAAC;QAC5BH,OAAO,CAACG,GAAG,CAAC,mBAAmB,CAAC;MAClC;IACF,CAAC,CAAC;IACF,OAAOd,IAAI;EACb;AACF;AAACe,OAAA,CAAA9C,MAAA,GAAAA,MAAA;AAAAlB,eAAA,CA3EYkB,MAAM,kBA6CK,CAAC+C,4BAAe,EAAEC,0CAAsB,EAAEC,kCAAkB,CAAC;AAAAnE,eAAA,CA7CxEkB,MAAM,aA+CAkD,eAAS;AAAApE,eAAA,CA/CfkB,MAAM,WAiDF,CAACmD,eAAI,CAACC,QAAQ,CAAa,CAAC,EAAED,eAAI,CAACC,QAAQ,CAAkB,CAAC,EAAED,eAAI,CAACC,QAAQ,CAAuB,CAAC,CAAC;AAAA,IAAAC,QAAA,GAAAP,OAAA,CAAAjE,OAAA,GA4BxGmB,MAAM;AAErBsD,kBAAU,CAACC,UAAU,CAACvD,MAAM,CAAC","ignoreList":[]}
+{"version":3,"names":["_react","data","_interopRequireDefault","require","_lodash","_component","_harmony","_ui","_componentCompare","_docsUi","_docsUi2","_apiReference","_docs","_overview","e","__esModule","default","_defineProperty","r","t","_toPropertyKey","Object","defineProperty","value","enumerable","configurable","writable","i","_toPrimitive","Symbol","toPrimitive","call","TypeError","String","Number","DocsUI","constructor","titleBadgeSlot","overviewOptionsSlot","usePreviewSandboxSlot","registerTitleBadge","titleBadges","badges","Array","isArray","register","listTitleBadges","flatten","values","registerEmptyState","emptyState","_emptyState","registerPreviewSandbox","useSandboxPermission","getEmptyState","getDocsCompare","createElement","OverviewCompare","overviewOptions","registerOverviewOptions","options","provider","component","componentCompare","apiRef","config","docs","section","OverviewSection","compareSection","OverviewCompareSection","registerRoute","route","registerNavigation","navigationLink","order","registerRoutes","manager","componentModel","host","add","exports","ComponentAspect","ComponentCompareAspect","APIReferenceAspect","UIRuntime","Slot","withType","_default","DocsAspect","addRuntime"],"sources":["docs.ui.runtime.tsx"],"sourcesContent":["import type { ComponentType } from 'react';\nimport React from 'react';\nimport { flatten } from 'lodash';\nimport type { ComponentUI } from '@teambit/component';\nimport { ComponentAspect } from '@teambit/component';\nimport type { SlotRegistry } from '@teambit/harmony';\nimport { Slot } from '@teambit/harmony';\nimport { UIRuntime } from '@teambit/ui';\nimport type { ComponentCompareUI } from '@teambit/component-compare';\nimport { ComponentCompareAspect } from '@teambit/component-compare';\nimport { OverviewCompare } from '@teambit/docs.ui.overview-compare';\nimport { OverviewCompareSection } from '@teambit/docs.ui.overview-compare-section';\nimport type { UseSandboxPermission } from '@teambit/preview.ui.component-preview';\nimport type { APIReferenceUI } from '@teambit/api-reference';\nimport { APIReferenceAspect } from '@teambit/api-reference';\nimport { DocsAspect } from './docs.aspect';\nimport { OverviewSection } from './overview.section';\nimport type { TitleBadgeSlot, TitleBadge, OverviewOptionsSlot, OverviewOptions } from './overview';\n\nexport type UsePreviewSandboxSlot = SlotRegistry<UseSandboxPermission>;\n\nexport class DocsUI {\n  constructor(\n    readonly titleBadgeSlot: TitleBadgeSlot,\n    readonly overviewOptionsSlot: OverviewOptionsSlot,\n    private usePreviewSandboxSlot: UsePreviewSandboxSlot\n  ) {}\n\n  /**\n   * register a new title badge into the overview section of a component.\n   */\n  registerTitleBadge(titleBadges: TitleBadge | TitleBadge[]) {\n    const badges = Array.isArray(titleBadges) ? titleBadges : [titleBadges];\n    this.titleBadgeSlot.register(badges);\n    return this;\n  }\n\n  /**\n   * list all title badges registered.\n   */\n  listTitleBadges() {\n    return flatten(this.titleBadgeSlot.values());\n  }\n\n  private _emptyState?: ComponentType;\n\n  registerEmptyState(emptyState: ComponentType) {\n    return (this._emptyState = emptyState);\n  }\n\n  registerPreviewSandbox(useSandboxPermission: UseSandboxPermission) {\n    this.usePreviewSandboxSlot.register(useSandboxPermission);\n  }\n\n  getEmptyState() {\n    return this._emptyState;\n  }\n\n  getDocsCompare() {\n    return <OverviewCompare titleBadges={this.titleBadgeSlot} overviewOptions={this.overviewOptionsSlot} />;\n  }\n\n  registerOverviewOptions(options: OverviewOptions) {\n    this.overviewOptionsSlot.register(options);\n  }\n\n  static dependencies = [ComponentAspect, ComponentCompareAspect, APIReferenceAspect];\n\n  static runtime = UIRuntime;\n\n  static slots = [Slot.withType<TitleBadge>(), Slot.withType<OverviewOptions>(), Slot.withType<UseSandboxPermission>()];\n\n  static async provider(\n    [component, componentCompare, apiRef]: [ComponentUI, ComponentCompareUI, APIReferenceUI],\n    config,\n    [titleBadgeSlot, overviewOptionsSlot, usePreviewSandboxSlot]: [\n      TitleBadgeSlot,\n      OverviewOptionsSlot,\n      UsePreviewSandboxSlot,\n    ]\n  ) {\n    const docs = new DocsUI(titleBadgeSlot, overviewOptionsSlot, usePreviewSandboxSlot);\n    const section = new OverviewSection(titleBadgeSlot, overviewOptionsSlot, docs, apiRef, usePreviewSandboxSlot);\n    const compareSection = new OverviewCompareSection(docs);\n    component.registerRoute(section.route);\n    component.registerNavigation(section.navigationLink, section.order);\n    componentCompare.registerNavigation(compareSection);\n    componentCompare.registerRoutes([compareSection.route]);\n    docs.registerPreviewSandbox((manager, componentModel) => {\n      if (componentModel?.host === 'teambit.scope/scope') {\n        manager.add('allow-scripts');\n        manager.add('allow-same-origin');\n      }\n    });\n    return docs;\n  }\n}\n\nexport default DocsUI;\n\nDocsAspect.addRuntime(DocsUI);\n"],"mappings":";;;;;;AACA,SAAAA,OAAA;EAAA,MAAAC,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAH,MAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAG,QAAA;EAAA,MAAAH,IAAA,GAAAE,OAAA;EAAAC,OAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAI,WAAA;EAAA,MAAAJ,IAAA,GAAAE,OAAA;EAAAE,UAAA,YAAAA,CAAA;IAAA,OAAAJ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAK,SAAA;EAAA,MAAAL,IAAA,GAAAE,OAAA;EAAAG,QAAA,YAAAA,CAAA;IAAA,OAAAL,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAM,IAAA;EAAA,MAAAN,IAAA,GAAAE,OAAA;EAAAI,GAAA,YAAAA,CAAA;IAAA,OAAAN,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAO,kBAAA;EAAA,MAAAP,IAAA,GAAAE,OAAA;EAAAK,iBAAA,YAAAA,CAAA;IAAA,OAAAP,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAQ,QAAA;EAAA,MAAAR,IAAA,GAAAE,OAAA;EAAAM,OAAA,YAAAA,CAAA;IAAA,OAAAR,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAS,SAAA;EAAA,MAAAT,IAAA,GAAAE,OAAA;EAAAO,QAAA,YAAAA,CAAA;IAAA,OAAAT,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAGA,SAAAU,cAAA;EAAA,MAAAV,IAAA,GAAAE,OAAA;EAAAQ,aAAA,YAAAA,CAAA;IAAA,OAAAV,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAW,MAAA;EAAA,MAAAX,IAAA,GAAAE,OAAA;EAAAS,KAAA,YAAAA,CAAA;IAAA,OAAAX,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAY,UAAA;EAAA,MAAAZ,IAAA,GAAAE,OAAA;EAAAU,SAAA,YAAAA,CAAA;IAAA,OAAAZ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAAqD,SAAAC,uBAAAY,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;AAK9C,MAAMgB,MAAM,CAAC;EAClBC,WAAWA,CACAC,cAA8B,EAC9BC,mBAAwC,EACzCC,qBAA4C,EACpD;IAAA,KAHSF,cAA8B,GAA9BA,cAA8B;IAAA,KAC9BC,mBAAwC,GAAxCA,mBAAwC;IAAA,KACzCC,qBAA4C,GAA5CA,qBAA4C;IAAAtB,eAAA;EACnD;;EAEH;AACF;AACA;EACEuB,kBAAkBA,CAACC,WAAsC,EAAE;IACzD,MAAMC,MAAM,GAAGC,KAAK,CAACC,OAAO,CAACH,WAAW,CAAC,GAAGA,WAAW,GAAG,CAACA,WAAW,CAAC;IACvE,IAAI,CAACJ,cAAc,CAACQ,QAAQ,CAACH,MAAM,CAAC;IACpC,OAAO,IAAI;EACb;;EAEA;AACF;AACA;EACEI,eAAeA,CAAA,EAAG;IAChB,OAAO,IAAAC,iBAAO,EAAC,IAAI,CAACV,cAAc,CAACW,MAAM,CAAC,CAAC,CAAC;EAC9C;EAIAC,kBAAkBA,CAACC,UAAyB,EAAE;IAC5C,OAAQ,IAAI,CAACC,WAAW,GAAGD,UAAU;EACvC;EAEAE,sBAAsBA,CAACC,oBAA0C,EAAE;IACjE,IAAI,CAACd,qBAAqB,CAACM,QAAQ,CAACQ,oBAAoB,CAAC;EAC3D;EAEAC,aAAaA,CAAA,EAAG;IACd,OAAO,IAAI,CAACH,WAAW;EACzB;EAEAI,cAAcA,CAAA,EAAG;IACf,oBAAOvD,MAAA,GAAAgB,OAAA,CAAAwC,aAAA,CAAC/C,OAAA,GAAAgD,eAAe;MAAChB,WAAW,EAAE,IAAI,CAACJ,cAAe;MAACqB,eAAe,EAAE,IAAI,CAACpB;IAAoB,CAAE,CAAC;EACzG;EAEAqB,uBAAuBA,CAACC,OAAwB,EAAE;IAChD,IAAI,CAACtB,mBAAmB,CAACO,QAAQ,CAACe,OAAO,CAAC;EAC5C;EAQA,aAAaC,QAAQA,CACnB,CAACC,SAAS,EAAEC,gBAAgB,EAAEC,MAAM,CAAoD,EACxFC,MAAM,EACN,CAAC5B,cAAc,EAAEC,mBAAmB,EAAEC,qBAAqB,CAI1D,EACD;IACA,MAAM2B,IAAI,GAAG,IAAI/B,MAAM,CAACE,cAAc,EAAEC,mBAAmB,EAAEC,qBAAqB,CAAC;IACnF,MAAM4B,OAAO,GAAG,KAAIC,2BAAe,EAAC/B,cAAc,EAAEC,mBAAmB,EAAE4B,IAAI,EAAEF,MAAM,EAAEzB,qBAAqB,CAAC;IAC7G,MAAM8B,cAAc,GAAG,KAAIC,iCAAsB,EAACJ,IAAI,CAAC;IACvDJ,SAAS,CAACS,aAAa,CAACJ,OAAO,CAACK,KAAK,CAAC;IACtCV,SAAS,CAACW,kBAAkB,CAACN,OAAO,CAACO,cAAc,EAAEP,OAAO,CAACQ,KAAK,CAAC;IACnEZ,gBAAgB,CAACU,kBAAkB,CAACJ,cAAc,CAAC;IACnDN,gBAAgB,CAACa,cAAc,CAAC,CAACP,cAAc,CAACG,KAAK,CAAC,CAAC;IACvDN,IAAI,CAACd,sBAAsB,CAAC,CAACyB,OAAO,EAAEC,cAAc,KAAK;MACvD,IAAIA,cAAc,EAAEC,IAAI,KAAK,qBAAqB,EAAE;QAClDF,OAAO,CAACG,GAAG,CAAC,eAAe,CAAC;QAC5BH,OAAO,CAACG,GAAG,CAAC,mBAAmB,CAAC;MAClC;IACF,CAAC,CAAC;IACF,OAAOd,IAAI;EACb;AACF;AAACe,OAAA,CAAA9C,MAAA,GAAAA,MAAA;AAAAlB,eAAA,CA3EYkB,MAAM,kBA6CK,CAAC+C,4BAAe,EAAEC,0CAAsB,EAAEC,kCAAkB,CAAC;AAAAnE,eAAA,CA7CxEkB,MAAM,aA+CAkD,eAAS;AAAApE,eAAA,CA/CfkB,MAAM,WAiDF,CAACmD,eAAI,CAACC,QAAQ,CAAa,CAAC,EAAED,eAAI,CAACC,QAAQ,CAAkB,CAAC,EAAED,eAAI,CAACC,QAAQ,CAAuB,CAAC,CAAC;AAAA,IAAAC,QAAA,GAAAP,OAAA,CAAAjE,OAAA,GA4BxGmB,MAAM;AAErBsD,kBAAU,CAACC,UAAU,CAACvD,MAAM,CAAC","ignoreList":[]}

package/dist/overview/overview.d.ts

@@ -1,7 +1,8 @@
-import React, { ComponentType } from 'react';
+import type { ComponentType } from 'react';
+import React from 'react';
 import type { SlotRegistry } from '@teambit/harmony';
-import { ComponentPreviewProps } from '@teambit/preview.ui.component-preview';
-import { UsePreviewSandboxSlot } from '@teambit/compositions';
+import type { ComponentPreviewProps } from '@teambit/preview.ui.component-preview';
+import type { UsePreviewSandboxSlot } from '@teambit/compositions';
 export declare enum BadgePosition {
     Title = 0,
     SubTitle = 1,

package/dist/overview/overview.js.map

@@ -1 +1 @@
-{"version":3,"names":["_react","data","_interopRequireWildcard","require","_classnames","_interopRequireDefault","_lodash","_component","_previewUi","_componentUi","_compositionsPanels","_baseReactThemes","_workspaceUi","_readmeSkeleton","_overviewModule","_excluded","e","__esModule","default","t","WeakMap","r","n","o","i","f","__proto__","has","get","set","hasOwnProperty","call","Object","defineProperty","getOwnPropertyDescriptor","_extends","assign","bind","arguments","length","apply","_objectWithoutProperties","_objectWithoutPropertiesLoose","getOwnPropertySymbols","indexOf","propertyIsEnumerable","BadgePosition","exports","Overview","titleBadges","overviewOptions","previewProps","getEmptyState","TaggedAPI","usePreviewSandboxSlot","component","useContext","ComponentContext","componentDescriptor","useComponentDescriptor","theme","useThemePicker","currentTheme","current","overviewProps","flatten","values","showHeader","preview","legacyHeader","EmptyState","buildFailed","buildStatus","toLowerCase","host","isScaling","Boolean","includesEnvTemplate","defaultLoadingState","React","useMemo","isMinimal","useWorkspaceMode","isLoading","setLoading","useState","previewSandboxHooks","sandboxValue","setSandboxValue","iframeQueryParams","onlyOverview","skipIncludes","overviewPropsValues","themeParams","themeName","_ref","onLoad","style","rest","onPreviewLoad","useCallback","props","useEffect","id","toString","createElement","className","classNames","styles","overviewWrapper","noOverflow","key","SandboxPermissionsAggregator","hooks","onSandboxChange","ComponentOverview","componentOverviewBlock","legacyPreview","displayName","version","abstract","description","labels","packageName","readme","ReadmeSkeleton","CompositionGallerySkeleton","compositionsLength","Math","min","compositions","Fragment","ComponentPreview","previewName","pubsub","queryParams","viewport","fullContentHeight","disableScroll","sandbox","width","height","minHeight","undefined","CompositionGallery","componentId"],"sources":["overview.tsx"],"sourcesContent":["/* eslint-disable complexity */\nimport React, { useContext, ComponentType, useState } from 'react';\nimport classNames from 'classnames';\nimport { flatten } from 'lodash';\n// import { Icon } from '@teambit/design.elements.icon';\n// import { LinkedHeading } from '@teambit/documenter.ui.linked-heading';\nimport { ComponentContext, useComponentDescriptor } from '@teambit/component';\nimport type { SlotRegistry } from '@teambit/harmony';\nimport {\n  ComponentPreview,\n  ComponentPreviewProps,\n  SandboxPermissionsAggregator,\n} from '@teambit/preview.ui.component-preview';\n// import { StatusMessageCard } from '@teambit/design.ui.surfaces.status-message-card';\nimport { ComponentOverview } from '@teambit/component.ui.component-meta';\nimport { CompositionGallery, CompositionGallerySkeleton } from '@teambit/compositions.panels.composition-gallery';\nimport { useThemePicker } from '@teambit/base-react.themes.theme-switcher';\nimport { useWorkspaceMode } from '@teambit/workspace.ui.use-workspace-mode';\nimport { UsePreviewSandboxSlot } from '@teambit/compositions';\nimport { ReadmeSkeleton } from './readme-skeleton';\nimport styles from './overview.module.scss';\n\nexport enum BadgePosition {\n  Title,\n  SubTitle,\n  Labels,\n  Package,\n}\n\nexport type TitleBadge = {\n  component: ComponentType<any>;\n  weight?: number;\n  position?: BadgePosition;\n};\n\nexport type TitleBadgeSlot = SlotRegistry<TitleBadge[]>;\n\nexport type OverviewOptions = () => { queryParams?: string };\n\nexport type OverviewOptionsSlot = SlotRegistry<OverviewOptions>;\n\nexport type OverviewProps = {\n  titleBadges: TitleBadgeSlot;\n  overviewOptions: OverviewOptionsSlot;\n  previewProps?: Partial<ComponentPreviewProps>;\n  getEmptyState?: () => ComponentType | undefined;\n  TaggedAPI?: React.ComponentType<{ componentId: string }>;\n  usePreviewSandboxSlot?: UsePreviewSandboxSlot;\n};\n\nexport function Overview({\n  titleBadges,\n  overviewOptions,\n  previewProps,\n  getEmptyState,\n  TaggedAPI,\n  usePreviewSandboxSlot,\n}: OverviewProps) {\n  const component = useContext(ComponentContext);\n  const componentDescriptor = useComponentDescriptor();\n  const theme = useThemePicker();\n  const currentTheme = theme?.current;\n  const overviewProps = flatten(overviewOptions.values())[0];\n  const showHeader = !component.preview?.legacyHeader;\n  const EmptyState = getEmptyState && getEmptyState();\n  const buildFailed = component.buildStatus?.toLowerCase() !== 'succeed' && component?.host === 'teambit.scope/scope';\n  const isScaling = Boolean(component.preview?.isScaling);\n  const includesEnvTemplate = Boolean(component.preview?.includesEnvTemplate);\n  const defaultLoadingState = React.useMemo(() => {\n    return isScaling && !includesEnvTemplate;\n  }, [isScaling, includesEnvTemplate]);\n  const { isMinimal } = useWorkspaceMode();\n  const [isLoading, setLoading] = useState(defaultLoadingState);\n  const previewSandboxHooks = usePreviewSandboxSlot?.values() ?? [];\n  const [sandboxValue, setSandboxValue] = useState('');\n  const iframeQueryParams = `onlyOverview=${component.preview?.onlyOverview || 'false'}&skipIncludes=${\n    component.preview?.skipIncludes || component.preview?.onlyOverview\n  }`;\n\n  const overviewPropsValues = overviewProps && overviewProps();\n\n  const themeParams = currentTheme?.themeName ? `theme=${currentTheme?.themeName}` : '';\n\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  const { onLoad, style, ...rest } = previewProps || {};\n\n  const onPreviewLoad = React.useCallback(\n    (e, props) => {\n      setLoading(false);\n      onLoad?.(e, props);\n    },\n    [onLoad]\n  );\n\n  React.useEffect(() => {\n    if (!isLoading && defaultLoadingState) setLoading(true);\n    if (isLoading && !defaultLoadingState) setLoading(false);\n  }, [component.id.toString(), defaultLoadingState]);\n\n  return (\n    <div\n      className={classNames(styles.overviewWrapper, isLoading && styles.noOverflow)}\n      key={`${component.id.toString()}`}\n    >\n      <SandboxPermissionsAggregator\n        hooks={previewSandboxHooks}\n        onSandboxChange={setSandboxValue}\n        component={component}\n      />\n      {showHeader && (\n        <ComponentOverview\n          className={classNames(styles.componentOverviewBlock, !isScaling && styles.legacyPreview)}\n          displayName={component.displayName}\n          version={component.version}\n          abstract={component.description}\n          labels={component.labels}\n          packageName={component.packageName}\n          titleBadges={flatten(titleBadges.values())}\n          componentDescriptor={componentDescriptor}\n          component={component}\n        />\n      )}\n      {!buildFailed && (\n        <div className={styles.readme}>\n          {isLoading && (\n            <ReadmeSkeleton>\n              <CompositionGallerySkeleton compositionsLength={Math.min(component.compositions.length, 3)} />\n            </ReadmeSkeleton>\n          )}\n          {!isMinimal ? (\n            <>\n              <ComponentPreview\n                onLoad={onPreviewLoad}\n                previewName=\"overview\"\n                pubsub={true}\n                queryParams={[iframeQueryParams, themeParams, overviewPropsValues?.queryParams || '']}\n                viewport={null}\n                fullContentHeight\n                disableScroll={true}\n                sandbox={sandboxValue}\n                {...rest}\n                component={component}\n                style={{ width: '100%', height: '100%', minHeight: !isScaling ? 500 : undefined }}\n              />\n              {component.preview?.onlyOverview && !isLoading && <CompositionGallery component={component} />}\n            </>\n          ) : (\n            <>\n              {component.preview?.onlyOverview && !isLoading && <CompositionGallery component={component} />}\n              <ComponentPreview\n                onLoad={onPreviewLoad}\n                previewName=\"overview\"\n                pubsub={true}\n                queryParams={[iframeQueryParams, themeParams, overviewPropsValues?.queryParams || '']}\n                viewport={null}\n                fullContentHeight\n                disableScroll={true}\n                sandbox={sandboxValue}\n                {...rest}\n                component={component}\n                style={{ width: '100%', height: '100%', minHeight: !isScaling ? 500 : undefined }}\n              />\n            </>\n          )}\n          {component.preview?.onlyOverview && !isLoading && TaggedAPI && (\n            <TaggedAPI componentId={component.id.toString()} />\n          )}\n        </div>\n      )}\n      {buildFailed && EmptyState && <EmptyState />}\n    </div>\n  );\n}\n"],"mappings":";;;;;;;AACA,SAAAA,OAAA;EAAA,MAAAC,IAAA,GAAAC,uBAAA,CAAAC,OAAA;EAAAH,MAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAG,YAAA;EAAA,MAAAH,IAAA,GAAAI,sBAAA,CAAAF,OAAA;EAAAC,WAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAK,QAAA;EAAA,MAAAL,IAAA,GAAAE,OAAA;EAAAG,OAAA,YAAAA,CAAA;IAAA,OAAAL,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAGA,SAAAM,WAAA;EAAA,MAAAN,IAAA,GAAAE,OAAA;EAAAI,UAAA,YAAAA,CAAA;IAAA,OAAAN,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAO,WAAA;EAAA,MAAAP,IAAA,GAAAE,OAAA;EAAAK,UAAA,YAAAA,CAAA;IAAA,OAAAP,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAMA,SAAAQ,aAAA;EAAA,MAAAR,IAAA,GAAAE,OAAA;EAAAM,YAAA,YAAAA,CAAA;IAAA,OAAAR,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAS,oBAAA;EAAA,MAAAT,IAAA,GAAAE,OAAA;EAAAO,mBAAA,YAAAA,CAAA;IAAA,OAAAT,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAU,iBAAA;EAAA,MAAAV,IAAA,GAAAE,OAAA;EAAAQ,gBAAA,YAAAA,CAAA;IAAA,OAAAV,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAW,aAAA;EAAA,MAAAX,IAAA,GAAAE,OAAA;EAAAS,YAAA,YAAAA,CAAA;IAAA,OAAAX,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAY,gBAAA;EAAA,MAAAZ,IAAA,GAAAE,OAAA;EAAAU,eAAA,YAAAA,CAAA;IAAA,OAAAZ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAa,gBAAA;EAAA,MAAAb,IAAA,GAAAI,sBAAA,CAAAF,OAAA;EAAAW,eAAA,YAAAA,CAAA;IAAA,OAAAb,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAA4C,MAAAc,SAAA;AApB5C;AAIA;AACA;AAQA;AAAA,SAAAV,uBAAAW,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,SAAAd,wBAAAc,CAAA,EAAAG,CAAA,6BAAAC,OAAA,MAAAC,CAAA,OAAAD,OAAA,IAAAE,CAAA,OAAAF,OAAA,YAAAlB,uBAAA,YAAAA,CAAAc,CAAA,EAAAG,CAAA,SAAAA,CAAA,IAAAH,CAAA,IAAAA,CAAA,CAAAC,UAAA,SAAAD,CAAA,MAAAO,CAAA,EAAAC,CAAA,EAAAC,CAAA,KAAAC,SAAA,QAAAR,OAAA,EAAAF,CAAA,iBAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,SAAAS,CAAA,MAAAF,CAAA,GAAAJ,CAAA,GAAAG,CAAA,GAAAD,CAAA,QAAAE,CAAA,CAAAI,GAAA,CAAAX,CAAA,UAAAO,CAAA,CAAAK,GAAA,CAAAZ,CAAA,GAAAO,CAAA,CAAAM,GAAA,CAAAb,CAAA,EAAAS,CAAA,gBAAAN,CAAA,IAAAH,CAAA,gBAAAG,CAAA,OAAAW,cAAA,CAAAC,IAAA,CAAAf,CAAA,EAAAG,CAAA,OAAAK,CAAA,IAAAD,CAAA,GAAAS,MAAA,CAAAC,cAAA,KAAAD,MAAA,CAAAE,wBAAA,CAAAlB,CAAA,EAAAG,CAAA,OAAAK,CAAA,CAAAI,GAAA,IAAAJ,CAAA,CAAAK,GAAA,IAAAN,CAAA,CAAAE,CAAA,EAAAN,CAAA,EAAAK,CAAA,IAAAC,CAAA,CAAAN,CAAA,IAAAH,CAAA,CAAAG,CAAA,WAAAM,CAAA,KAAAT,CAAA,EAAAG,CAAA;AAAA,SAAAgB,SAAA,WAAAA,QAAA,GAAAH,MAAA,CAAAI,MAAA,GAAAJ,MAAA,CAAAI,MAAA,CAAAC,IAAA,eAAAf,CAAA,aAAAN,CAAA,MAAAA,CAAA,GAAAsB,SAAA,CAAAC,MAAA,EAAAvB,CAAA,UAAAG,CAAA,GAAAmB,SAAA,CAAAtB,CAAA,YAAAK,CAAA,IAAAF,CAAA,OAAAW,cAAA,CAAAC,IAAA,CAAAZ,CAAA,EAAAE,CAAA,MAAAC,CAAA,CAAAD,CAAA,IAAAF,CAAA,CAAAE,CAAA,aAAAC,CAAA,KAAAa,QAAA,CAAAK,KAAA,OAAAF,SAAA;AAAA,SAAAG,yBAAAzB,CAAA,EAAAG,CAAA,gBAAAH,CAAA,iBAAAO,CAAA,EAAAF,CAAA,EAAAG,CAAA,GAAAkB,6BAAA,CAAA1B,CAAA,EAAAG,CAAA,OAAAa,MAAA,CAAAW,qBAAA,QAAArB,CAAA,GAAAU,MAAA,CAAAW,qBAAA,CAAA3B,CAAA,QAAAK,CAAA,MAAAA,CAAA,GAAAC,CAAA,CAAAiB,MAAA,EAAAlB,CAAA,IAAAE,CAAA,GAAAD,CAAA,CAAAD,CAAA,UAAAF,CAAA,CAAAyB,OAAA,CAAArB,CAAA,QAAAsB,oBAAA,CAAAd,IAAA,CAAAf,CAAA,EAAAO,CAAA,MAAAC,CAAA,CAAAD,CAAA,IAAAP,CAAA,CAAAO,CAAA,aAAAC,CAAA;AAAA,SAAAkB,8BAAArB,CAAA,EAAAL,CAAA,gBAAAK,CAAA,iBAAAF,CAAA,gBAAAG,CAAA,IAAAD,CAAA,SAAAS,cAAA,CAAAC,IAAA,CAAAV,CAAA,EAAAC,CAAA,gBAAAN,CAAA,CAAA4B,OAAA,CAAAtB,CAAA,aAAAH,CAAA,CAAAG,CAAA,IAAAD,CAAA,CAAAC,CAAA,YAAAH,CAAA;AAAA,IASY2B,aAAa,GAAAC,OAAA,CAAAD,aAAA,0BAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAA,OAAbA,aAAa;AAAA;AA4BlB,SAASE,QAAQA,CAAC;EACvBC,WAAW;EACXC,eAAe;EACfC,YAAY;EACZC,aAAa;EACbC,SAAS;EACTC;AACa,CAAC,EAAE;EAChB,MAAMC,SAAS,GAAG,IAAAC,mBAAU,EAACC,6BAAgB,CAAC;EAC9C,MAAMC,mBAAmB,GAAG,IAAAC,mCAAsB,EAAC,CAAC;EACpD,MAAMC,KAAK,GAAG,IAAAC,iCAAc,EAAC,CAAC;EAC9B,MAAMC,YAAY,GAAGF,KAAK,EAAEG,OAAO;EACnC,MAAMC,aAAa,GAAG,IAAAC,iBAAO,EAACf,eAAe,CAACgB,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;EAC1D,MAAMC,UAAU,GAAG,CAACZ,SAAS,CAACa,OAAO,EAAEC,YAAY;EACnD,MAAMC,UAAU,GAAGlB,aAAa,IAAIA,aAAa,CAAC,CAAC;EACnD,MAAMmB,WAAW,GAAGhB,SAAS,CAACiB,WAAW,EAAEC,WAAW,CAAC,CAAC,KAAK,SAAS,IAAIlB,SAAS,EAAEmB,IAAI,KAAK,qBAAqB;EACnH,MAAMC,SAAS,GAAGC,OAAO,CAACrB,SAAS,CAACa,OAAO,EAAEO,SAAS,CAAC;EACvD,MAAME,mBAAmB,GAAGD,OAAO,CAACrB,SAAS,CAACa,OAAO,EAAES,mBAAmB,CAAC;EAC3E,MAAMC,mBAAmB,GAAGC,gBAAK,CAACC,OAAO,CAAC,MAAM;IAC9C,OAAOL,SAAS,IAAI,CAACE,mBAAmB;EAC1C,CAAC,EAAE,CAACF,SAAS,EAAEE,mBAAmB,CAAC,CAAC;EACpC,MAAM;IAAEI;EAAU,CAAC,GAAG,IAAAC,+BAAgB,EAAC,CAAC;EACxC,MAAM,CAACC,SAAS,EAAEC,UAAU,CAAC,GAAG,IAAAC,iBAAQ,EAACP,mBAAmB,CAAC;EAC7D,MAAMQ,mBAAmB,GAAGhC,qBAAqB,EAAEY,MAAM,CAAC,CAAC,IAAI,EAAE;EACjE,MAAM,CAACqB,YAAY,EAAEC,eAAe,CAAC,GAAG,IAAAH,iBAAQ,EAAC,EAAE,CAAC;EACpD,MAAMI,iBAAiB,GAAG,gBAAgBlC,SAAS,CAACa,OAAO,EAAEsB,YAAY,IAAI,OAAO,iBAClFnC,SAAS,CAACa,OAAO,EAAEuB,YAAY,IAAIpC,SAAS,CAACa,OAAO,EAAEsB,YAAY,EAClE;EAEF,MAAME,mBAAmB,GAAG5B,aAAa,IAAIA,aAAa,CAAC,CAAC;EAE5D,MAAM6B,WAAW,GAAG/B,YAAY,EAAEgC,SAAS,GAAG,SAAShC,YAAY,EAAEgC,SAAS,EAAE,GAAG,EAAE;;EAErF;EACA,MAAAC,IAAA,GAAmC5C,YAAY,IAAI,CAAC,CAAC;IAA/C;MAAE6C,MAAM;MAAEC;IAAe,CAAC,GAAAF,IAAA;IAANG,IAAI,GAAAzD,wBAAA,CAAAsD,IAAA,EAAAhF,SAAA;EAE9B,MAAMoF,aAAa,GAAGpB,gBAAK,CAACqB,WAAW,CACrC,CAACpF,CAAC,EAAEqF,KAAK,KAAK;IACZjB,UAAU,CAAC,KAAK,CAAC;IACjBY,MAAM,GAAGhF,CAAC,EAAEqF,KAAK,CAAC;EACpB,CAAC,EACD,CAACL,MAAM,CACT,CAAC;EAEDjB,gBAAK,CAACuB,SAAS,CAAC,MAAM;IACpB,IAAI,CAACnB,SAAS,IAAIL,mBAAmB,EAAEM,UAAU,CAAC,IAAI,CAAC;IACvD,IAAID,SAAS,IAAI,CAACL,mBAAmB,EAAEM,UAAU,CAAC,KAAK,CAAC;EAC1D,CAAC,EAAE,CAAC7B,SAAS,CAACgD,EAAE,CAACC,QAAQ,CAAC,CAAC,EAAE1B,mBAAmB,CAAC,CAAC;EAElD,oBACE9E,MAAA,GAAAkB,OAAA,CAAAuF,aAAA;IACEC,SAAS,EAAE,IAAAC,qBAAU,EAACC,yBAAM,CAACC,eAAe,EAAE1B,SAAS,IAAIyB,yBAAM,CAACE,UAAU,CAAE;IAC9EC,GAAG,EAAE,GAAGxD,SAAS,CAACgD,EAAE,CAACC,QAAQ,CAAC,CAAC;EAAG,gBAElCxG,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAACjG,UAAA,GAAAwG,4BAA4B;IAC3BC,KAAK,EAAE3B,mBAAoB;IAC3B4B,eAAe,EAAE1B,eAAgB;IACjCjC,SAAS,EAAEA;EAAU,CACtB,CAAC,EACDY,UAAU,iBACTnE,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAAChG,YAAA,GAAA0G,iBAAiB;IAChBT,SAAS,EAAE,IAAAC,qBAAU,EAACC,yBAAM,CAACQ,sBAAsB,EAAE,CAACzC,SAAS,IAAIiC,yBAAM,CAACS,aAAa,CAAE;IACzFC,WAAW,EAAE/D,SAAS,CAAC+D,WAAY;IACnCC,OAAO,EAAEhE,SAAS,CAACgE,OAAQ;IAC3BC,QAAQ,EAAEjE,SAAS,CAACkE,WAAY;IAChCC,MAAM,EAAEnE,SAAS,CAACmE,MAAO;IACzBC,WAAW,EAAEpE,SAAS,CAACoE,WAAY;IACnC1E,WAAW,EAAE,IAAAgB,iBAAO,EAAChB,WAAW,CAACiB,MAAM,CAAC,CAAC,CAAE;IAC3CR,mBAAmB,EAAEA,mBAAoB;IACzCH,SAAS,EAAEA;EAAU,CACtB,CACF,EACA,CAACgB,WAAW,iBACXvE,MAAA,GAAAkB,OAAA,CAAAuF,aAAA;IAAKC,SAAS,EAAEE,yBAAM,CAACgB;EAAO,GAC3BzC,SAAS,iBACRnF,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAAC5F,eAAA,GAAAgH,cAAc,qBACb7H,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAAC/F,mBAAA,GAAAoH,0BAA0B;IAACC,kBAAkB,EAAEC,IAAI,CAACC,GAAG,CAAC1E,SAAS,CAAC2E,YAAY,CAAC3F,MAAM,EAAE,CAAC;EAAE,CAAE,CAC/E,CACjB,EACA,CAAC0C,SAAS,gBACTjF,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAAAzG,MAAA,GAAAkB,OAAA,CAAAiH,QAAA,qBACEnI,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAACjG,UAAA,GAAA4H,gBAAgB,EAAAjG,QAAA;IACf6D,MAAM,EAAEG,aAAc;IACtBkC,WAAW,EAAC,UAAU;IACtBC,MAAM,EAAE,IAAK;IACbC,WAAW,EAAE,CAAC9C,iBAAiB,EAAEI,WAAW,EAAED,mBAAmB,EAAE2C,WAAW,IAAI,EAAE,CAAE;IACtFC,QAAQ,EAAE,IAAK;IACfC,iBAAiB;IACjBC,aAAa,EAAE,IAAK;IACpBC,OAAO,EAAEpD;EAAa,GAClBW,IAAI;IACR3C,SAAS,EAAEA,SAAU;IACrB0C,KAAK,EAAE;MAAE2C,KAAK,EAAE,MAAM;MAAEC,MAAM,EAAE,MAAM;MAAEC,SAAS,EAAE,CAACnE,SAAS,GAAG,GAAG,GAAGoE;IAAU;EAAE,EACnF,CAAC,EACDxF,SAAS,CAACa,OAAO,EAAEsB,YAAY,IAAI,CAACP,SAAS,iBAAInF,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAAC/F,mBAAA,GAAAsI,kBAAkB;IAACzF,SAAS,EAAEA;EAAU,CAAE,CAC7F,CAAC,gBAEHvD,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAAAzG,MAAA,GAAAkB,OAAA,CAAAiH,QAAA,QACG5E,SAAS,CAACa,OAAO,EAAEsB,YAAY,IAAI,CAACP,SAAS,iBAAInF,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAAC/F,mBAAA,GAAAsI,kBAAkB;IAACzF,SAAS,EAAEA;EAAU,CAAE,CAAC,eAC9FvD,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAACjG,UAAA,GAAA4H,gBAAgB,EAAAjG,QAAA;IACf6D,MAAM,EAAEG,aAAc;IACtBkC,WAAW,EAAC,UAAU;IACtBC,MAAM,EAAE,IAAK;IACbC,WAAW,EAAE,CAAC9C,iBAAiB,EAAEI,WAAW,EAAED,mBAAmB,EAAE2C,WAAW,IAAI,EAAE,CAAE;IACtFC,QAAQ,EAAE,IAAK;IACfC,iBAAiB;IACjBC,aAAa,EAAE,IAAK;IACpBC,OAAO,EAAEpD;EAAa,GAClBW,IAAI;IACR3C,SAAS,EAAEA,SAAU;IACrB0C,KAAK,EAAE;MAAE2C,KAAK,EAAE,MAAM;MAAEC,MAAM,EAAE,MAAM;MAAEC,SAAS,EAAE,CAACnE,SAAS,GAAG,GAAG,GAAGoE;IAAU;EAAE,EACnF,CACD,CACH,EACAxF,SAAS,CAACa,OAAO,EAAEsB,YAAY,IAAI,CAACP,SAAS,IAAI9B,SAAS,iBACzDrD,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAACpD,SAAS;IAAC4F,WAAW,EAAE1F,SAAS,CAACgD,EAAE,CAACC,QAAQ,CAAC;EAAE,CAAE,CAEjD,CACN,EACAjC,WAAW,IAAID,UAAU,iBAAItE,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAACnC,UAAU,MAAE,CACxC,CAAC;AAEV","ignoreList":[]}
+{"version":3,"names":["_react","data","_interopRequireWildcard","require","_classnames","_interopRequireDefault","_lodash","_component","_previewUi","_componentUi","_compositionsPanels","_baseReactThemes","_workspaceUi","_readmeSkeleton","_overviewModule","_excluded","e","__esModule","default","t","WeakMap","r","n","o","i","f","__proto__","has","get","set","hasOwnProperty","call","Object","defineProperty","getOwnPropertyDescriptor","_extends","assign","bind","arguments","length","apply","_objectWithoutProperties","_objectWithoutPropertiesLoose","getOwnPropertySymbols","indexOf","propertyIsEnumerable","BadgePosition","exports","Overview","titleBadges","overviewOptions","previewProps","getEmptyState","TaggedAPI","usePreviewSandboxSlot","component","useContext","ComponentContext","componentDescriptor","useComponentDescriptor","theme","useThemePicker","currentTheme","current","overviewProps","flatten","values","showHeader","preview","legacyHeader","EmptyState","buildFailed","buildStatus","toLowerCase","host","isScaling","Boolean","includesEnvTemplate","defaultLoadingState","React","useMemo","isMinimal","useWorkspaceMode","isLoading","setLoading","useState","previewSandboxHooks","sandboxValue","setSandboxValue","iframeQueryParams","onlyOverview","skipIncludes","overviewPropsValues","themeParams","themeName","_ref","onLoad","style","rest","onPreviewLoad","useCallback","props","useEffect","id","toString","createElement","className","classNames","styles","overviewWrapper","noOverflow","key","SandboxPermissionsAggregator","hooks","onSandboxChange","ComponentOverview","componentOverviewBlock","legacyPreview","displayName","version","abstract","description","labels","packageName","readme","ReadmeSkeleton","CompositionGallerySkeleton","compositionsLength","Math","min","compositions","Fragment","ComponentPreview","previewName","pubsub","queryParams","viewport","fullContentHeight","disableScroll","sandbox","width","height","minHeight","undefined","CompositionGallery","componentId"],"sources":["overview.tsx"],"sourcesContent":["/* eslint-disable complexity */\nimport type { ComponentType } from 'react';\nimport React, { useContext, useState } from 'react';\nimport classNames from 'classnames';\nimport { flatten } from 'lodash';\n// import { Icon } from '@teambit/design.elements.icon';\n// import { LinkedHeading } from '@teambit/documenter.ui.linked-heading';\nimport { ComponentContext, useComponentDescriptor } from '@teambit/component';\nimport type { SlotRegistry } from '@teambit/harmony';\nimport type { ComponentPreviewProps } from '@teambit/preview.ui.component-preview';\nimport { ComponentPreview, SandboxPermissionsAggregator } from '@teambit/preview.ui.component-preview';\n// import { StatusMessageCard } from '@teambit/design.ui.surfaces.status-message-card';\nimport { ComponentOverview } from '@teambit/component.ui.component-meta';\nimport { CompositionGallery, CompositionGallerySkeleton } from '@teambit/compositions.panels.composition-gallery';\nimport { useThemePicker } from '@teambit/base-react.themes.theme-switcher';\nimport { useWorkspaceMode } from '@teambit/workspace.ui.use-workspace-mode';\nimport type { UsePreviewSandboxSlot } from '@teambit/compositions';\nimport { ReadmeSkeleton } from './readme-skeleton';\nimport styles from './overview.module.scss';\n\nexport enum BadgePosition {\n  Title,\n  SubTitle,\n  Labels,\n  Package,\n}\n\nexport type TitleBadge = {\n  component: ComponentType<any>;\n  weight?: number;\n  position?: BadgePosition;\n};\n\nexport type TitleBadgeSlot = SlotRegistry<TitleBadge[]>;\n\nexport type OverviewOptions = () => { queryParams?: string };\n\nexport type OverviewOptionsSlot = SlotRegistry<OverviewOptions>;\n\nexport type OverviewProps = {\n  titleBadges: TitleBadgeSlot;\n  overviewOptions: OverviewOptionsSlot;\n  previewProps?: Partial<ComponentPreviewProps>;\n  getEmptyState?: () => ComponentType | undefined;\n  TaggedAPI?: React.ComponentType<{ componentId: string }>;\n  usePreviewSandboxSlot?: UsePreviewSandboxSlot;\n};\n\nexport function Overview({\n  titleBadges,\n  overviewOptions,\n  previewProps,\n  getEmptyState,\n  TaggedAPI,\n  usePreviewSandboxSlot,\n}: OverviewProps) {\n  const component = useContext(ComponentContext);\n  const componentDescriptor = useComponentDescriptor();\n  const theme = useThemePicker();\n  const currentTheme = theme?.current;\n  const overviewProps = flatten(overviewOptions.values())[0];\n  const showHeader = !component.preview?.legacyHeader;\n  const EmptyState = getEmptyState && getEmptyState();\n  const buildFailed = component.buildStatus?.toLowerCase() !== 'succeed' && component?.host === 'teambit.scope/scope';\n  const isScaling = Boolean(component.preview?.isScaling);\n  const includesEnvTemplate = Boolean(component.preview?.includesEnvTemplate);\n  const defaultLoadingState = React.useMemo(() => {\n    return isScaling && !includesEnvTemplate;\n  }, [isScaling, includesEnvTemplate]);\n  const { isMinimal } = useWorkspaceMode();\n  const [isLoading, setLoading] = useState(defaultLoadingState);\n  const previewSandboxHooks = usePreviewSandboxSlot?.values() ?? [];\n  const [sandboxValue, setSandboxValue] = useState('');\n  const iframeQueryParams = `onlyOverview=${component.preview?.onlyOverview || 'false'}&skipIncludes=${\n    component.preview?.skipIncludes || component.preview?.onlyOverview\n  }`;\n\n  const overviewPropsValues = overviewProps && overviewProps();\n\n  const themeParams = currentTheme?.themeName ? `theme=${currentTheme?.themeName}` : '';\n\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  const { onLoad, style, ...rest } = previewProps || {};\n\n  const onPreviewLoad = React.useCallback(\n    (e, props) => {\n      setLoading(false);\n      onLoad?.(e, props);\n    },\n    [onLoad]\n  );\n\n  React.useEffect(() => {\n    if (!isLoading && defaultLoadingState) setLoading(true);\n    if (isLoading && !defaultLoadingState) setLoading(false);\n  }, [component.id.toString(), defaultLoadingState]);\n\n  return (\n    <div\n      className={classNames(styles.overviewWrapper, isLoading && styles.noOverflow)}\n      key={`${component.id.toString()}`}\n    >\n      <SandboxPermissionsAggregator\n        hooks={previewSandboxHooks}\n        onSandboxChange={setSandboxValue}\n        component={component}\n      />\n      {showHeader && (\n        <ComponentOverview\n          className={classNames(styles.componentOverviewBlock, !isScaling && styles.legacyPreview)}\n          displayName={component.displayName}\n          version={component.version}\n          abstract={component.description}\n          labels={component.labels}\n          packageName={component.packageName}\n          titleBadges={flatten(titleBadges.values())}\n          componentDescriptor={componentDescriptor}\n          component={component}\n        />\n      )}\n      {!buildFailed && (\n        <div className={styles.readme}>\n          {isLoading && (\n            <ReadmeSkeleton>\n              <CompositionGallerySkeleton compositionsLength={Math.min(component.compositions.length, 3)} />\n            </ReadmeSkeleton>\n          )}\n          {!isMinimal ? (\n            <>\n              <ComponentPreview\n                onLoad={onPreviewLoad}\n                previewName=\"overview\"\n                pubsub={true}\n                queryParams={[iframeQueryParams, themeParams, overviewPropsValues?.queryParams || '']}\n                viewport={null}\n                fullContentHeight\n                disableScroll={true}\n                sandbox={sandboxValue}\n                {...rest}\n                component={component}\n                style={{ width: '100%', height: '100%', minHeight: !isScaling ? 500 : undefined }}\n              />\n              {component.preview?.onlyOverview && !isLoading && <CompositionGallery component={component} />}\n            </>\n          ) : (\n            <>\n              {component.preview?.onlyOverview && !isLoading && <CompositionGallery component={component} />}\n              <ComponentPreview\n                onLoad={onPreviewLoad}\n                previewName=\"overview\"\n                pubsub={true}\n                queryParams={[iframeQueryParams, themeParams, overviewPropsValues?.queryParams || '']}\n                viewport={null}\n                fullContentHeight\n                disableScroll={true}\n                sandbox={sandboxValue}\n                {...rest}\n                component={component}\n                style={{ width: '100%', height: '100%', minHeight: !isScaling ? 500 : undefined }}\n              />\n            </>\n          )}\n          {component.preview?.onlyOverview && !isLoading && TaggedAPI && (\n            <TaggedAPI componentId={component.id.toString()} />\n          )}\n        </div>\n      )}\n      {buildFailed && EmptyState && <EmptyState />}\n    </div>\n  );\n}\n"],"mappings":";;;;;;;AAEA,SAAAA,OAAA;EAAA,MAAAC,IAAA,GAAAC,uBAAA,CAAAC,OAAA;EAAAH,MAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAG,YAAA;EAAA,MAAAH,IAAA,GAAAI,sBAAA,CAAAF,OAAA;EAAAC,WAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAK,QAAA;EAAA,MAAAL,IAAA,GAAAE,OAAA;EAAAG,OAAA,YAAAA,CAAA;IAAA,OAAAL,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAGA,SAAAM,WAAA;EAAA,MAAAN,IAAA,GAAAE,OAAA;EAAAI,UAAA,YAAAA,CAAA;IAAA,OAAAN,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAGA,SAAAO,WAAA;EAAA,MAAAP,IAAA,GAAAE,OAAA;EAAAK,UAAA,YAAAA,CAAA;IAAA,OAAAP,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAQ,aAAA;EAAA,MAAAR,IAAA,GAAAE,OAAA;EAAAM,YAAA,YAAAA,CAAA;IAAA,OAAAR,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAS,oBAAA;EAAA,MAAAT,IAAA,GAAAE,OAAA;EAAAO,mBAAA,YAAAA,CAAA;IAAA,OAAAT,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAU,iBAAA;EAAA,MAAAV,IAAA,GAAAE,OAAA;EAAAQ,gBAAA,YAAAA,CAAA;IAAA,OAAAV,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAW,aAAA;EAAA,MAAAX,IAAA,GAAAE,OAAA;EAAAS,YAAA,YAAAA,CAAA;IAAA,OAAAX,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAY,gBAAA;EAAA,MAAAZ,IAAA,GAAAE,OAAA;EAAAU,eAAA,YAAAA,CAAA;IAAA,OAAAZ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAa,gBAAA;EAAA,MAAAb,IAAA,GAAAI,sBAAA,CAAAF,OAAA;EAAAW,eAAA,YAAAA,CAAA;IAAA,OAAAb,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAA4C,MAAAc,SAAA;AAlB5C;AAKA;AACA;AAKA;AAAA,SAAAV,uBAAAW,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,SAAAd,wBAAAc,CAAA,EAAAG,CAAA,6BAAAC,OAAA,MAAAC,CAAA,OAAAD,OAAA,IAAAE,CAAA,OAAAF,OAAA,YAAAlB,uBAAA,YAAAA,CAAAc,CAAA,EAAAG,CAAA,SAAAA,CAAA,IAAAH,CAAA,IAAAA,CAAA,CAAAC,UAAA,SAAAD,CAAA,MAAAO,CAAA,EAAAC,CAAA,EAAAC,CAAA,KAAAC,SAAA,QAAAR,OAAA,EAAAF,CAAA,iBAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,SAAAS,CAAA,MAAAF,CAAA,GAAAJ,CAAA,GAAAG,CAAA,GAAAD,CAAA,QAAAE,CAAA,CAAAI,GAAA,CAAAX,CAAA,UAAAO,CAAA,CAAAK,GAAA,CAAAZ,CAAA,GAAAO,CAAA,CAAAM,GAAA,CAAAb,CAAA,EAAAS,CAAA,gBAAAN,CAAA,IAAAH,CAAA,gBAAAG,CAAA,OAAAW,cAAA,CAAAC,IAAA,CAAAf,CAAA,EAAAG,CAAA,OAAAK,CAAA,IAAAD,CAAA,GAAAS,MAAA,CAAAC,cAAA,KAAAD,MAAA,CAAAE,wBAAA,CAAAlB,CAAA,EAAAG,CAAA,OAAAK,CAAA,CAAAI,GAAA,IAAAJ,CAAA,CAAAK,GAAA,IAAAN,CAAA,CAAAE,CAAA,EAAAN,CAAA,EAAAK,CAAA,IAAAC,CAAA,CAAAN,CAAA,IAAAH,CAAA,CAAAG,CAAA,WAAAM,CAAA,KAAAT,CAAA,EAAAG,CAAA;AAAA,SAAAgB,SAAA,WAAAA,QAAA,GAAAH,MAAA,CAAAI,MAAA,GAAAJ,MAAA,CAAAI,MAAA,CAAAC,IAAA,eAAAf,CAAA,aAAAN,CAAA,MAAAA,CAAA,GAAAsB,SAAA,CAAAC,MAAA,EAAAvB,CAAA,UAAAG,CAAA,GAAAmB,SAAA,CAAAtB,CAAA,YAAAK,CAAA,IAAAF,CAAA,OAAAW,cAAA,CAAAC,IAAA,CAAAZ,CAAA,EAAAE,CAAA,MAAAC,CAAA,CAAAD,CAAA,IAAAF,CAAA,CAAAE,CAAA,aAAAC,CAAA,KAAAa,QAAA,CAAAK,KAAA,OAAAF,SAAA;AAAA,SAAAG,yBAAAzB,CAAA,EAAAG,CAAA,gBAAAH,CAAA,iBAAAO,CAAA,EAAAF,CAAA,EAAAG,CAAA,GAAAkB,6BAAA,CAAA1B,CAAA,EAAAG,CAAA,OAAAa,MAAA,CAAAW,qBAAA,QAAArB,CAAA,GAAAU,MAAA,CAAAW,qBAAA,CAAA3B,CAAA,QAAAK,CAAA,MAAAA,CAAA,GAAAC,CAAA,CAAAiB,MAAA,EAAAlB,CAAA,IAAAE,CAAA,GAAAD,CAAA,CAAAD,CAAA,UAAAF,CAAA,CAAAyB,OAAA,CAAArB,CAAA,QAAAsB,oBAAA,CAAAd,IAAA,CAAAf,CAAA,EAAAO,CAAA,MAAAC,CAAA,CAAAD,CAAA,IAAAP,CAAA,CAAAO,CAAA,aAAAC,CAAA;AAAA,SAAAkB,8BAAArB,CAAA,EAAAL,CAAA,gBAAAK,CAAA,iBAAAF,CAAA,gBAAAG,CAAA,IAAAD,CAAA,SAAAS,cAAA,CAAAC,IAAA,CAAAV,CAAA,EAAAC,CAAA,gBAAAN,CAAA,CAAA4B,OAAA,CAAAtB,CAAA,aAAAH,CAAA,CAAAG,CAAA,IAAAD,CAAA,CAAAC,CAAA,YAAAH,CAAA;AAAA,IASY2B,aAAa,GAAAC,OAAA,CAAAD,aAAA,0BAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAA,OAAbA,aAAa;AAAA;AA4BlB,SAASE,QAAQA,CAAC;EACvBC,WAAW;EACXC,eAAe;EACfC,YAAY;EACZC,aAAa;EACbC,SAAS;EACTC;AACa,CAAC,EAAE;EAChB,MAAMC,SAAS,GAAG,IAAAC,mBAAU,EAACC,6BAAgB,CAAC;EAC9C,MAAMC,mBAAmB,GAAG,IAAAC,mCAAsB,EAAC,CAAC;EACpD,MAAMC,KAAK,GAAG,IAAAC,iCAAc,EAAC,CAAC;EAC9B,MAAMC,YAAY,GAAGF,KAAK,EAAEG,OAAO;EACnC,MAAMC,aAAa,GAAG,IAAAC,iBAAO,EAACf,eAAe,CAACgB,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;EAC1D,MAAMC,UAAU,GAAG,CAACZ,SAAS,CAACa,OAAO,EAAEC,YAAY;EACnD,MAAMC,UAAU,GAAGlB,aAAa,IAAIA,aAAa,CAAC,CAAC;EACnD,MAAMmB,WAAW,GAAGhB,SAAS,CAACiB,WAAW,EAAEC,WAAW,CAAC,CAAC,KAAK,SAAS,IAAIlB,SAAS,EAAEmB,IAAI,KAAK,qBAAqB;EACnH,MAAMC,SAAS,GAAGC,OAAO,CAACrB,SAAS,CAACa,OAAO,EAAEO,SAAS,CAAC;EACvD,MAAME,mBAAmB,GAAGD,OAAO,CAACrB,SAAS,CAACa,OAAO,EAAES,mBAAmB,CAAC;EAC3E,MAAMC,mBAAmB,GAAGC,gBAAK,CAACC,OAAO,CAAC,MAAM;IAC9C,OAAOL,SAAS,IAAI,CAACE,mBAAmB;EAC1C,CAAC,EAAE,CAACF,SAAS,EAAEE,mBAAmB,CAAC,CAAC;EACpC,MAAM;IAAEI;EAAU,CAAC,GAAG,IAAAC,+BAAgB,EAAC,CAAC;EACxC,MAAM,CAACC,SAAS,EAAEC,UAAU,CAAC,GAAG,IAAAC,iBAAQ,EAACP,mBAAmB,CAAC;EAC7D,MAAMQ,mBAAmB,GAAGhC,qBAAqB,EAAEY,MAAM,CAAC,CAAC,IAAI,EAAE;EACjE,MAAM,CAACqB,YAAY,EAAEC,eAAe,CAAC,GAAG,IAAAH,iBAAQ,EAAC,EAAE,CAAC;EACpD,MAAMI,iBAAiB,GAAG,gBAAgBlC,SAAS,CAACa,OAAO,EAAEsB,YAAY,IAAI,OAAO,iBAClFnC,SAAS,CAACa,OAAO,EAAEuB,YAAY,IAAIpC,SAAS,CAACa,OAAO,EAAEsB,YAAY,EAClE;EAEF,MAAME,mBAAmB,GAAG5B,aAAa,IAAIA,aAAa,CAAC,CAAC;EAE5D,MAAM6B,WAAW,GAAG/B,YAAY,EAAEgC,SAAS,GAAG,SAAShC,YAAY,EAAEgC,SAAS,EAAE,GAAG,EAAE;;EAErF;EACA,MAAAC,IAAA,GAAmC5C,YAAY,IAAI,CAAC,CAAC;IAA/C;MAAE6C,MAAM;MAAEC;IAAe,CAAC,GAAAF,IAAA;IAANG,IAAI,GAAAzD,wBAAA,CAAAsD,IAAA,EAAAhF,SAAA;EAE9B,MAAMoF,aAAa,GAAGpB,gBAAK,CAACqB,WAAW,CACrC,CAACpF,CAAC,EAAEqF,KAAK,KAAK;IACZjB,UAAU,CAAC,KAAK,CAAC;IACjBY,MAAM,GAAGhF,CAAC,EAAEqF,KAAK,CAAC;EACpB,CAAC,EACD,CAACL,MAAM,CACT,CAAC;EAEDjB,gBAAK,CAACuB,SAAS,CAAC,MAAM;IACpB,IAAI,CAACnB,SAAS,IAAIL,mBAAmB,EAAEM,UAAU,CAAC,IAAI,CAAC;IACvD,IAAID,SAAS,IAAI,CAACL,mBAAmB,EAAEM,UAAU,CAAC,KAAK,CAAC;EAC1D,CAAC,EAAE,CAAC7B,SAAS,CAACgD,EAAE,CAACC,QAAQ,CAAC,CAAC,EAAE1B,mBAAmB,CAAC,CAAC;EAElD,oBACE9E,MAAA,GAAAkB,OAAA,CAAAuF,aAAA;IACEC,SAAS,EAAE,IAAAC,qBAAU,EAACC,yBAAM,CAACC,eAAe,EAAE1B,SAAS,IAAIyB,yBAAM,CAACE,UAAU,CAAE;IAC9EC,GAAG,EAAE,GAAGxD,SAAS,CAACgD,EAAE,CAACC,QAAQ,CAAC,CAAC;EAAG,gBAElCxG,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAACjG,UAAA,GAAAwG,4BAA4B;IAC3BC,KAAK,EAAE3B,mBAAoB;IAC3B4B,eAAe,EAAE1B,eAAgB;IACjCjC,SAAS,EAAEA;EAAU,CACtB,CAAC,EACDY,UAAU,iBACTnE,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAAChG,YAAA,GAAA0G,iBAAiB;IAChBT,SAAS,EAAE,IAAAC,qBAAU,EAACC,yBAAM,CAACQ,sBAAsB,EAAE,CAACzC,SAAS,IAAIiC,yBAAM,CAACS,aAAa,CAAE;IACzFC,WAAW,EAAE/D,SAAS,CAAC+D,WAAY;IACnCC,OAAO,EAAEhE,SAAS,CAACgE,OAAQ;IAC3BC,QAAQ,EAAEjE,SAAS,CAACkE,WAAY;IAChCC,MAAM,EAAEnE,SAAS,CAACmE,MAAO;IACzBC,WAAW,EAAEpE,SAAS,CAACoE,WAAY;IACnC1E,WAAW,EAAE,IAAAgB,iBAAO,EAAChB,WAAW,CAACiB,MAAM,CAAC,CAAC,CAAE;IAC3CR,mBAAmB,EAAEA,mBAAoB;IACzCH,SAAS,EAAEA;EAAU,CACtB,CACF,EACA,CAACgB,WAAW,iBACXvE,MAAA,GAAAkB,OAAA,CAAAuF,aAAA;IAAKC,SAAS,EAAEE,yBAAM,CAACgB;EAAO,GAC3BzC,SAAS,iBACRnF,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAAC5F,eAAA,GAAAgH,cAAc,qBACb7H,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAAC/F,mBAAA,GAAAoH,0BAA0B;IAACC,kBAAkB,EAAEC,IAAI,CAACC,GAAG,CAAC1E,SAAS,CAAC2E,YAAY,CAAC3F,MAAM,EAAE,CAAC;EAAE,CAAE,CAC/E,CACjB,EACA,CAAC0C,SAAS,gBACTjF,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAAAzG,MAAA,GAAAkB,OAAA,CAAAiH,QAAA,qBACEnI,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAACjG,UAAA,GAAA4H,gBAAgB,EAAAjG,QAAA;IACf6D,MAAM,EAAEG,aAAc;IACtBkC,WAAW,EAAC,UAAU;IACtBC,MAAM,EAAE,IAAK;IACbC,WAAW,EAAE,CAAC9C,iBAAiB,EAAEI,WAAW,EAAED,mBAAmB,EAAE2C,WAAW,IAAI,EAAE,CAAE;IACtFC,QAAQ,EAAE,IAAK;IACfC,iBAAiB;IACjBC,aAAa,EAAE,IAAK;IACpBC,OAAO,EAAEpD;EAAa,GAClBW,IAAI;IACR3C,SAAS,EAAEA,SAAU;IACrB0C,KAAK,EAAE;MAAE2C,KAAK,EAAE,MAAM;MAAEC,MAAM,EAAE,MAAM;MAAEC,SAAS,EAAE,CAACnE,SAAS,GAAG,GAAG,GAAGoE;IAAU;EAAE,EACnF,CAAC,EACDxF,SAAS,CAACa,OAAO,EAAEsB,YAAY,IAAI,CAACP,SAAS,iBAAInF,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAAC/F,mBAAA,GAAAsI,kBAAkB;IAACzF,SAAS,EAAEA;EAAU,CAAE,CAC7F,CAAC,gBAEHvD,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAAAzG,MAAA,GAAAkB,OAAA,CAAAiH,QAAA,QACG5E,SAAS,CAACa,OAAO,EAAEsB,YAAY,IAAI,CAACP,SAAS,iBAAInF,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAAC/F,mBAAA,GAAAsI,kBAAkB;IAACzF,SAAS,EAAEA;EAAU,CAAE,CAAC,eAC9FvD,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAACjG,UAAA,GAAA4H,gBAAgB,EAAAjG,QAAA;IACf6D,MAAM,EAAEG,aAAc;IACtBkC,WAAW,EAAC,UAAU;IACtBC,MAAM,EAAE,IAAK;IACbC,WAAW,EAAE,CAAC9C,iBAAiB,EAAEI,WAAW,EAAED,mBAAmB,EAAE2C,WAAW,IAAI,EAAE,CAAE;IACtFC,QAAQ,EAAE,IAAK;IACfC,iBAAiB;IACjBC,aAAa,EAAE,IAAK;IACpBC,OAAO,EAAEpD;EAAa,GAClBW,IAAI;IACR3C,SAAS,EAAEA,SAAU;IACrB0C,KAAK,EAAE;MAAE2C,KAAK,EAAE,MAAM;MAAEC,MAAM,EAAE,MAAM;MAAEC,SAAS,EAAE,CAACnE,SAAS,GAAG,GAAG,GAAGoE;IAAU;EAAE,EACnF,CACD,CACH,EACAxF,SAAS,CAACa,OAAO,EAAEsB,YAAY,IAAI,CAACP,SAAS,IAAI9B,SAAS,iBACzDrD,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAACpD,SAAS;IAAC4F,WAAW,EAAE1F,SAAS,CAACgD,EAAE,CAACC,QAAQ,CAAC;EAAE,CAAE,CAEjD,CACN,EACAjC,WAAW,IAAID,UAAU,iBAAItE,MAAA,GAAAkB,OAAA,CAAAuF,aAAA,CAACnC,UAAU,MAAE,CACxC,CAAC;AAEV","ignoreList":[]}

package/dist/overview.section.d.ts

@@ -1,7 +1,7 @@
-import { Section } from '@teambit/component';
-import { APIReferenceUI } from '@teambit/api-reference';
-import { TitleBadgeSlot, OverviewOptionsSlot } from './overview';
-import { DocsUI, UsePreviewSandboxSlot } from './docs.ui.runtime';
+import type { Section } from '@teambit/component';
+import type { APIReferenceUI } from '@teambit/api-reference';
+import type { TitleBadgeSlot, OverviewOptionsSlot } from './overview';
+import type { DocsUI, UsePreviewSandboxSlot } from './docs.ui.runtime';
 export declare class OverviewSection implements Section {
     /**
      * title badge slot.

package/dist/overview.section.js.map

@@ -1 +1 @@
-{"version":3,"names":["_react","data","_interopRequireDefault","require","_overview","e","__esModule","default","_defineProperty","r","t","_toPropertyKey","Object","defineProperty","value","enumerable","configurable","writable","i","_toPrimitive","Symbol","toPrimitive","call","TypeError","String","Number","OverviewSection","constructor","titleBadgeSlot","overviewOptionsSlot","docs","apiRef","usePreviewSandboxSlot","href","exact","children","index","element","createElement","Overview","titleBadges","overviewOptions","getEmptyState","bind","TaggedAPI","TaggedAPIPage","exports"],"sources":["overview.section.tsx"],"sourcesContent":["import React from 'react';\nimport { Section } from '@teambit/component';\nimport { APIReferenceUI } from '@teambit/api-reference';\nimport { Overview, TitleBadgeSlot, OverviewOptionsSlot } from './overview';\nimport { DocsUI, UsePreviewSandboxSlot } from './docs.ui.runtime';\n\nexport class OverviewSection implements Section {\n  constructor(\n    /**\n     * title badge slot.\n     */\n    private titleBadgeSlot: TitleBadgeSlot,\n    private overviewOptionsSlot: OverviewOptionsSlot,\n    private docs: DocsUI,\n    private apiRef: APIReferenceUI,\n    private usePreviewSandboxSlot: UsePreviewSandboxSlot\n  ) {}\n\n  navigationLink = {\n    href: '.',\n    exact: true,\n    children: 'Overview',\n  };\n\n  route = {\n    index: true,\n    element: (\n      <Overview\n        titleBadges={this.titleBadgeSlot}\n        overviewOptions={this.overviewOptionsSlot}\n        getEmptyState={this.docs.getEmptyState.bind(this.docs)}\n        TaggedAPI={this.apiRef.TaggedAPIPage}\n        usePreviewSandboxSlot={this.usePreviewSandboxSlot}\n      />\n    ),\n  };\n\n  order = 10;\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;AAGA,SAAAG,UAAA;EAAA,MAAAH,IAAA,GAAAE,OAAA;EAAAC,SAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAA2E,SAAAC,uBAAAG,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;AAGpE,MAAMgB,eAAe,CAAoB;EAC9CC,WAAWA;EACT;AACJ;AACA;EACYC,cAA8B,EAC9BC,mBAAwC,EACxCC,IAAY,EACZC,MAAsB,EACtBC,qBAA4C,EACpD;IAAA,KALQJ,cAA8B,GAA9BA,cAA8B;IAAA,KAC9BC,mBAAwC,GAAxCA,mBAAwC;IAAA,KACxCC,IAAY,GAAZA,IAAY;IAAA,KACZC,MAAsB,GAAtBA,MAAsB;IAAA,KACtBC,qBAA4C,GAA5CA,qBAA4C;IAAAxB,eAAA,yBAGrC;MACfyB,IAAI,EAAE,GAAG;MACTC,KAAK,EAAE,IAAI;MACXC,QAAQ,EAAE;IACZ,CAAC;IAAA3B,eAAA,gBAEO;MACN4B,KAAK,EAAE,IAAI;MACXC,OAAO,eACLrC,MAAA,GAAAO,OAAA,CAAA+B,aAAA,CAAClC,SAAA,GAAAmC,QAAQ;QACPC,WAAW,EAAE,IAAI,CAACZ,cAAe;QACjCa,eAAe,EAAE,IAAI,CAACZ,mBAAoB;QAC1Ca,aAAa,EAAE,IAAI,CAACZ,IAAI,CAACY,aAAa,CAACC,IAAI,CAAC,IAAI,CAACb,IAAI,CAAE;QACvDc,SAAS,EAAE,IAAI,CAACb,MAAM,CAACc,aAAc;QACrCb,qBAAqB,EAAE,IAAI,CAACA;MAAsB,CACnD;IAEL,CAAC;IAAAxB,eAAA,gBAEO,EAAE;EArBP;AAsBL;AAACsC,OAAA,CAAApB,eAAA,GAAAA,eAAA","ignoreList":[]}
+{"version":3,"names":["_react","data","_interopRequireDefault","require","_overview","e","__esModule","default","_defineProperty","r","t","_toPropertyKey","Object","defineProperty","value","enumerable","configurable","writable","i","_toPrimitive","Symbol","toPrimitive","call","TypeError","String","Number","OverviewSection","constructor","titleBadgeSlot","overviewOptionsSlot","docs","apiRef","usePreviewSandboxSlot","href","exact","children","index","element","createElement","Overview","titleBadges","overviewOptions","getEmptyState","bind","TaggedAPI","TaggedAPIPage","exports"],"sources":["overview.section.tsx"],"sourcesContent":["import React from 'react';\nimport type { Section } from '@teambit/component';\nimport type { APIReferenceUI } from '@teambit/api-reference';\nimport type { TitleBadgeSlot, OverviewOptionsSlot } from './overview';\nimport { Overview } from './overview';\nimport type { DocsUI, UsePreviewSandboxSlot } from './docs.ui.runtime';\n\nexport class OverviewSection implements Section {\n  constructor(\n    /**\n     * title badge slot.\n     */\n    private titleBadgeSlot: TitleBadgeSlot,\n    private overviewOptionsSlot: OverviewOptionsSlot,\n    private docs: DocsUI,\n    private apiRef: APIReferenceUI,\n    private usePreviewSandboxSlot: UsePreviewSandboxSlot\n  ) {}\n\n  navigationLink = {\n    href: '.',\n    exact: true,\n    children: 'Overview',\n  };\n\n  route = {\n    index: true,\n    element: (\n      <Overview\n        titleBadges={this.titleBadgeSlot}\n        overviewOptions={this.overviewOptionsSlot}\n        getEmptyState={this.docs.getEmptyState.bind(this.docs)}\n        TaggedAPI={this.apiRef.TaggedAPIPage}\n        usePreviewSandboxSlot={this.usePreviewSandboxSlot}\n      />\n    ),\n  };\n\n  order = 10;\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;AAIA,SAAAG,UAAA;EAAA,MAAAH,IAAA,GAAAE,OAAA;EAAAC,SAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAAsC,SAAAC,uBAAAG,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;AAG/B,MAAMgB,eAAe,CAAoB;EAC9CC,WAAWA;EACT;AACJ;AACA;EACYC,cAA8B,EAC9BC,mBAAwC,EACxCC,IAAY,EACZC,MAAsB,EACtBC,qBAA4C,EACpD;IAAA,KALQJ,cAA8B,GAA9BA,cAA8B;IAAA,KAC9BC,mBAAwC,GAAxCA,mBAAwC;IAAA,KACxCC,IAAY,GAAZA,IAAY;IAAA,KACZC,MAAsB,GAAtBA,MAAsB;IAAA,KACtBC,qBAA4C,GAA5CA,qBAA4C;IAAAxB,eAAA,yBAGrC;MACfyB,IAAI,EAAE,GAAG;MACTC,KAAK,EAAE,IAAI;MACXC,QAAQ,EAAE;IACZ,CAAC;IAAA3B,eAAA,gBAEO;MACN4B,KAAK,EAAE,IAAI;MACXC,OAAO,eACLrC,MAAA,GAAAO,OAAA,CAAA+B,aAAA,CAAClC,SAAA,GAAAmC,QAAQ;QACPC,WAAW,EAAE,IAAI,CAACZ,cAAe;QACjCa,eAAe,EAAE,IAAI,CAACZ,mBAAoB;QAC1Ca,aAAa,EAAE,IAAI,CAACZ,IAAI,CAACY,aAAa,CAACC,IAAI,CAAC,IAAI,CAACb,IAAI,CAAE;QACvDc,SAAS,EAAE,IAAI,CAACb,MAAM,CAACc,aAAc;QACrCb,qBAAqB,EAAE,IAAI,CAACA;MAAsB,CACnD;IAEL,CAAC;IAAAxB,eAAA,gBAEO,EAAE;EArBP;AAsBL;AAACsC,OAAA,CAAApB,eAAA,GAAAA,eAAA","ignoreList":[]}

package/dist/{preview-1753803956605.js → preview-1753833698619.js}

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

package/docs.preview.runtime.tsx

@@ -1,6 +1,8 @@
-import React, { ReactNode } from 'react';
-import { PreviewAspect, RenderingContext, PreviewPreview, PreviewRuntime, PreviewModule } from '@teambit/preview';
-import { ComponentID } from '@teambit/component-id';
+import type { ReactNode } from 'react';
+import React from 'react';
+import type { RenderingContext, PreviewPreview, PreviewModule } from '@teambit/preview';
+import { PreviewAspect, PreviewRuntime } from '@teambit/preview';
+import type { ComponentID } from '@teambit/component-id';
 
 import { DocsAspect } from './docs.aspect';
 import type { Docs } from './docs';

package/docs.ui.runtime.tsx

@@ -1,13 +1,18 @@
-import React, { ComponentType } from 'react';
+import type { ComponentType } from 'react';
+import React from 'react';
 import { flatten } from 'lodash';
-import { ComponentAspect, ComponentUI } from '@teambit/component';
-import { Slot, SlotRegistry } from '@teambit/harmony';
+import type { ComponentUI } from '@teambit/component';
+import { ComponentAspect } from '@teambit/component';
+import type { SlotRegistry } from '@teambit/harmony';
+import { Slot } from '@teambit/harmony';
 import { UIRuntime } from '@teambit/ui';
-import { ComponentCompareAspect, ComponentCompareUI } from '@teambit/component-compare';
+import type { ComponentCompareUI } from '@teambit/component-compare';
+import { ComponentCompareAspect } from '@teambit/component-compare';
 import { OverviewCompare } from '@teambit/docs.ui.overview-compare';
 import { OverviewCompareSection } from '@teambit/docs.ui.overview-compare-section';
-import { UseSandboxPermission } from '@teambit/preview.ui.component-preview';
-import { APIReferenceAspect, APIReferenceUI } from '@teambit/api-reference';
+import type { UseSandboxPermission } from '@teambit/preview.ui.component-preview';
+import type { APIReferenceUI } from '@teambit/api-reference';
+import { APIReferenceAspect } from '@teambit/api-reference';
 import { DocsAspect } from './docs.aspect';
 import { OverviewSection } from './overview.section';
 import type { TitleBadgeSlot, TitleBadge, OverviewOptionsSlot, OverviewOptions } from './overview';

package/overview/overview.tsx

@@ -1,22 +1,20 @@
 /* eslint-disable complexity */
-import React, { useContext, ComponentType, useState } from 'react';
+import type { ComponentType } from 'react';
+import React, { useContext, useState } from 'react';
 import classNames from 'classnames';
 import { flatten } from 'lodash';
 // import { Icon } from '@teambit/design.elements.icon';
 // import { LinkedHeading } from '@teambit/documenter.ui.linked-heading';
 import { ComponentContext, useComponentDescriptor } from '@teambit/component';
 import type { SlotRegistry } from '@teambit/harmony';
-import {
-  ComponentPreview,
-  ComponentPreviewProps,
-  SandboxPermissionsAggregator,
-} from '@teambit/preview.ui.component-preview';
+import type { ComponentPreviewProps } from '@teambit/preview.ui.component-preview';
+import { ComponentPreview, SandboxPermissionsAggregator } from '@teambit/preview.ui.component-preview';
 // import { StatusMessageCard } from '@teambit/design.ui.surfaces.status-message-card';
 import { ComponentOverview } from '@teambit/component.ui.component-meta';
 import { CompositionGallery, CompositionGallerySkeleton } from '@teambit/compositions.panels.composition-gallery';
 import { useThemePicker } from '@teambit/base-react.themes.theme-switcher';
 import { useWorkspaceMode } from '@teambit/workspace.ui.use-workspace-mode';
-import { UsePreviewSandboxSlot } from '@teambit/compositions';
+import type { UsePreviewSandboxSlot } from '@teambit/compositions';
 import { ReadmeSkeleton } from './readme-skeleton';
 import styles from './overview.module.scss';
 

package/overview.section.tsx

@@ -1,8 +1,9 @@
 import React from 'react';
-import { Section } from '@teambit/component';
-import { APIReferenceUI } from '@teambit/api-reference';
-import { Overview, TitleBadgeSlot, OverviewOptionsSlot } from './overview';
-import { DocsUI, UsePreviewSandboxSlot } from './docs.ui.runtime';
+import type { Section } from '@teambit/component';
+import type { APIReferenceUI } from '@teambit/api-reference';
+import type { TitleBadgeSlot, OverviewOptionsSlot } from './overview';
+import { Overview } from './overview';
+import type { DocsUI, UsePreviewSandboxSlot } from './docs.ui.runtime';
 
 export class OverviewSection implements Section {
   constructor(

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/docs",
-  "version": "1.0.666",
+  "version": "1.0.668",
   "homepage": "https://bit.cloud/teambit/docs/docs",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.docs",
     "name": "docs",
-    "version": "1.0.666"
+    "version": "1.0.668"
   },
   "dependencies": {
     "graphql-tag": "2.12.1",
@@ -14,32 +14,32 @@
     "classnames": "2.2.6",
     "@teambit/docs.entities.doc": "0.0.12",
     "@teambit/harmony": "0.4.7",
-    "@teambit/component.sources": "0.0.109",
-    "@teambit/legacy.consumer-component": "0.0.58",
     "@teambit/docs.ui.overview-compare-section": "0.0.101",
     "@teambit/docs.ui.overview-compare": "1.0.12",
-    "@teambit/preview.ui.component-preview": "1.0.25",
     "@teambit/base-react.themes.theme-switcher": "1.1.2",
     "@teambit/component.ui.component-meta": "0.0.367",
     "@teambit/compositions.panels.composition-gallery": "0.0.220",
     "@teambit/workspace.ui.use-workspace-mode": "0.0.2",
     "@teambit/base-ui.loaders.skeleton": "1.0.1",
-    "@teambit/compiler": "1.0.666",
-    "@teambit/component": "1.0.666",
-    "@teambit/pkg": "1.0.666",
-    "@teambit/workspace": "1.0.666",
-    "@teambit/cli": "0.0.1243",
-    "@teambit/dev-files": "1.0.666",
-    "@teambit/envs": "1.0.666",
-    "@teambit/graphql": "1.0.666",
-    "@teambit/logger": "0.0.1336",
-    "@teambit/preview": "1.0.666",
-    "@teambit/scope": "1.0.666",
-    "@teambit/api-reference": "1.0.666",
-    "@teambit/component-compare": "1.0.666",
-    "@teambit/ui": "1.0.666",
-    "@teambit/pubsub": "1.0.666",
-    "@teambit/compositions": "1.0.666"
+    "@teambit/compiler": "1.0.668",
+    "@teambit/component": "1.0.668",
+    "@teambit/pkg": "1.0.668",
+    "@teambit/workspace": "1.0.668",
+    "@teambit/cli": "0.0.1245",
+    "@teambit/component.sources": "0.0.110",
+    "@teambit/dev-files": "1.0.668",
+    "@teambit/envs": "1.0.668",
+    "@teambit/graphql": "1.0.668",
+    "@teambit/legacy.consumer-component": "0.0.59",
+    "@teambit/logger": "0.0.1338",
+    "@teambit/preview": "1.0.668",
+    "@teambit/scope": "1.0.668",
+    "@teambit/api-reference": "1.0.668",
+    "@teambit/component-compare": "1.0.668",
+    "@teambit/preview.ui.component-preview": "1.0.26",
+    "@teambit/ui": "1.0.668",
+    "@teambit/pubsub": "1.0.668",
+    "@teambit/compositions": "1.0.668"
   },
   "devDependencies": {
     "@types/lodash": "4.14.165",