@teambit/docs 0.0.802 → 0.0.805

package/dist/docs.compare.section.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
-import { TitleBadgeSlot } from '@teambit/docs';
 import { Section } from '@teambit/component';
+import { TitleBadgeSlot } from './overview';
 export declare class OverviewCompareSection implements Section {
     private titleBadgeSlot;
     constructor(titleBadgeSlot: TitleBadgeSlot);

package/dist/docs.compare.section.js.map

@@ -1 +1 @@
-{"version":3,"names":["OverviewCompareSection","constructor","titleBadgeSlot","href","children","exact","order","path","element"],"sources":["docs.compare.section.tsx"],"sourcesContent":["import React from 'react';\nimport { TitleBadgeSlot } from '@teambit/docs';\nimport { Section } from '@teambit/component';\nimport { OverviewCompare } from '@teambit/docs.ui.overview-compare';\n\nexport class OverviewCompareSection implements Section {\n  constructor(private titleBadgeSlot: TitleBadgeSlot) {}\n\n  navigationLink = {\n    href: '.',\n    children: 'Overview',\n    exact: true,\n    order: 0,\n  };\n\n  route = {\n    path: '*',\n    element: <OverviewCompare titleBadges={this.titleBadgeSlot} />,\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAGA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEO,MAAMA,sBAAN,CAAgD;EACrDC,WAAW,CAASC,cAAT,EAAyC;IAAA,KAAhCA,cAAgC,GAAhCA,cAAgC;IAAA,wDAEnC;MACfC,IAAI,EAAE,GADS;MAEfC,QAAQ,EAAE,UAFK;MAGfC,KAAK,EAAE,IAHQ;MAIfC,KAAK,EAAE;IAJQ,CAFmC;IAAA,+CAS5C;MACNC,IAAI,EAAE,GADA;MAENC,OAAO,eAAE,+BAAC,yBAAD;QAAiB,WAAW,EAAE,KAAKN;MAAnC;IAFH,CAT4C;EAAE;;AADD"}
+{"version":3,"names":["OverviewCompareSection","constructor","titleBadgeSlot","href","children","exact","order","path","element"],"sources":["docs.compare.section.tsx"],"sourcesContent":["import React from 'react';\nimport { Section } from '@teambit/component';\nimport { OverviewCompare } from '@teambit/docs.ui.overview-compare';\nimport { TitleBadgeSlot } from './overview';\n\nexport class OverviewCompareSection implements Section {\n  constructor(private titleBadgeSlot: TitleBadgeSlot) {}\n\n  navigationLink = {\n    href: '.',\n    children: 'Overview',\n    exact: true,\n    order: 0,\n  };\n\n  route = {\n    path: '*',\n    element: <OverviewCompare titleBadges={this.titleBadgeSlot} />,\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAGO,MAAMA,sBAAN,CAAgD;EACrDC,WAAW,CAASC,cAAT,EAAyC;IAAA,KAAhCA,cAAgC,GAAhCA,cAAgC;IAAA,wDAEnC;MACfC,IAAI,EAAE,GADS;MAEfC,QAAQ,EAAE,UAFK;MAGfC,KAAK,EAAE,IAHQ;MAIfC,KAAK,EAAE;IAJQ,CAFmC;IAAA,+CAS5C;MACNC,IAAI,EAAE,GADA;MAENC,OAAO,eAAE,+BAAC,yBAAD;QAAiB,WAAW,EAAE,KAAKN;MAAnC;IAFH,CAT4C;EAAE;;AADD"}

package/dist/docs.main.runtime.js

@@ -319,7 +319,8 @@ class DocsMain {
     devFiles.registerDevPattern(docs.getDevPatternToRegister());
 
     if (workspace) {
-      workspace.onComponentLoad(async component => {
+      workspace.onComponentLoad(async (component, opts) => {
+        if ((opts === null || opts === void 0 ? void 0 : opts.loadDocs) === false) return undefined;
         const doc = await docs.computeDoc(component);
         return {
           doc: doc === null || doc === void 0 ? void 0 : doc.toObject()

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

@@ -1 +1 @@
-{"version":3,"names":["DocsMain","constructor","patterns","preview","pkg","compiler","workspace","logger","devFiles","envs","docPropSlot","docReaderSlot","getDocsMap","components","ComponentMap","as","component","getDocsFiles","computeDevFiles","docFiles","get","DocsAspect","id","state","filesystem","files","filter","file","includes","relative","getDescription","componentDoc","getDoc","desc","description","consumerComponent","_consumer","fromJsDocs","docs","find","doc","getTemplate","env","getDocsTemplate","getDocReader","extension","values","docReader","isFormatSupported","computeDoc","length","docFile","extname","FileExtensionNotSupported","read","contents","err","debug","message","docData","data","Doc","filePath","DocPropList","props","getPatterns","getComponentDevPatterns","calculateEnv","componentEnvDocsDevPatterns","getDocsDevPatterns","componentPatterns","concat","getDevPatternToRegister","bind","registerDocReader","register","provider","graphql","loggerAspect","config","createLogger","DefaultDocReader","registerDevPattern","onComponentLoad","toObject","docsSchema","registerDefinition","DocsPreviewDefinition","Slot","withType","MainRuntime","PreviewAspect","GraphqlAspect","WorkspaceAspect","PkgAspect","CompilerAspect","LoggerAspect","DevFilesAspect","EnvsAspect","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 { 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 { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';\nimport ConsumerComponent from '@teambit/legacy/dist/consumer/component';\nimport { Workspace, WorkspaceAspect } from '@teambit/workspace';\nimport { Doc, DocPropList } from '@teambit/docs.entities.doc';\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.computeDevFiles(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    if (desc) return desc;\n    const consumerComponent: ConsumerComponent = component.state._consumer;\n    const fromJsDocs = consumerComponent.docs?.find((doc) => doc.description);\n\n    return fromJsDocs?.description || '';\n  }\n\n  async getTemplate(env: Environment) {\n    return env.getDocsTemplate();\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).env;\n    const componentEnvDocsDevPatterns: string[] = env.getDocsDevPatterns ? env.getDocsDevPatterns(component) : [];\n    const componentPatterns = componentEnvDocsDevPatterns.concat(this.getPatterns());\n    return 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  ];\n\n  static defaultConfig = {\n    patterns: ['**/*.docs.*'],\n  };\n\n  static async provider(\n    [preview, graphql, workspace, pkg, compiler, loggerAspect, devFiles, envs]: [\n      PreviewMain,\n      GraphqlMain,\n      Workspace,\n      PkgMain,\n      CompilerMain,\n      LoggerMain,\n      DevFilesMain,\n      EnvsMain\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\n      preview,\n\n      pkg,\n\n      compiler,\n\n      workspace,\n\n      logger,\n\n      devFiles,\n\n      envs,\n\n      docPropSlot,\n\n      docReaderSlot\n    );\n    docs.registerDocReader(new DefaultDocReader(pkg, compiler, workspace));\n    devFiles.registerDevPattern(docs.getDevPatternToRegister());\n\n    if (workspace) {\n      workspace.onComponentLoad(async (component) => {\n        const doc = await docs.computeDoc(component);\n\n        return {\n          doc: doc?.toObject(),\n        };\n      });\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;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAGA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAoBA;AACA;AACA;AACO,MAAMA,QAAN,CAAe;EACpBC,WAAW,CACDC,QADC;EAET;AACJ;AACA;EACYC,OALC,EAODC,GAPC,EASDC,QATC,EAWDC,SAXC,EAaDC,MAbC,EAeDC,QAfC,EAiBDC,IAjBC,EAmBDC,WAnBC,EAqBDC,aArBC,EAsBT;IAAA,KArBQT,QAqBR,GArBQA,QAqBR;IAAA,KAjBQC,OAiBR,GAjBQA,OAiBR;IAAA,KAfQC,GAeR,GAfQA,GAeR;IAAA,KAbQC,QAaR,GAbQA,QAaR;IAAA,KAXQC,SAWR,GAXQA,SAWR;IAAA,KATQC,MASR,GATQA,MASR;IAAA,KAPQC,QAOR,GAPQA,QAOR;IAAA,KALQC,IAKR,GALQA,IAKR;IAAA,KAHQC,WAGR,GAHQA,WAGR;IAAA,KADQC,aACR,GADQA,aACR;EAAE;EAEJ;AACF;AACA;;;EACEC,UAAU,CAACC,UAAD,EAAyD;IACjE,OAAOC,yBAAA,CAAaC,EAAb,CAAiCF,UAAjC,EAA8CG,SAAD,IAAe;MACjE,OAAO,KAAKC,YAAL,CAAkBD,SAAlB,CAAP;IACD,CAFM,CAAP;EAGD;;EAEDC,YAAY,CAACD,SAAD,EAAwC;IAClD,MAAMR,QAAQ,GAAG,KAAKA,QAAL,CAAcU,eAAd,CAA8BF,SAA9B,CAAjB;IACA,MAAMG,QAAQ,GAAGX,QAAQ,CAACY,GAAT,CAAaC,kBAAA,CAAWC,EAAxB,CAAjB;IACA,OAAON,SAAS,CAACO,KAAV,CAAgBC,UAAhB,CAA2BC,KAA3B,CAAiCC,MAAjC,CAAyCC,IAAD,IAAUR,QAAQ,CAACS,QAAT,CAAkBD,IAAI,CAACE,QAAvB,CAAlD,CAAP;EACD;EAED;AACF;AACA;;;EACsB,MAAdC,cAAc,CAACd,SAAD,EAAwC;IAAA;;IAC1D,MAAMe,YAAY,GAAG,KAAKC,MAAL,CAAYhB,SAAZ,CAArB;IACA,MAAMiB,IAAI,GAAGF,YAAH,aAAGA,YAAH,uBAAGA,YAAY,CAAEG,WAA3B;IACA,IAAID,IAAJ,EAAU,OAAOA,IAAP;IACV,MAAME,iBAAoC,GAAGnB,SAAS,CAACO,KAAV,CAAgBa,SAA7D;IACA,MAAMC,UAAU,4BAAGF,iBAAiB,CAACG,IAArB,0DAAG,sBAAwBC,IAAxB,CAA8BC,GAAD,IAASA,GAAG,CAACN,WAA1C,CAAnB;IAEA,OAAO,CAAAG,UAAU,SAAV,IAAAA,UAAU,WAAV,YAAAA,UAAU,CAAEH,WAAZ,KAA2B,EAAlC;EACD;;EAEgB,MAAXO,WAAW,CAACC,GAAD,EAAmB;IAClC,OAAOA,GAAG,CAACC,eAAJ,EAAP;EACD;;EAEDC,YAAY,CAACC,SAAD,EAAoB;IAC9B,OAAO,KAAKlC,aAAL,CAAmBmC,MAAnB,GAA4BP,IAA5B,CAAkCQ,SAAD,IAAeA,SAAS,CAACC,iBAAV,CAA4BH,SAA5B,CAAhD,CAAP;EACD;EAED;AACF;AACA;;;EACkB,MAAVI,UAAU,CAACjC,SAAD,EAAuB;IACrC,MAAMG,QAAQ,GAAG,KAAKF,YAAL,CAAkBD,SAAlB,CAAjB;;IACA,IAAIG,QAAQ,CAAC+B,MAAb,EAAqB;MACnB;MACA,MAAMC,OAAO,GAAGhC,QAAQ,CAAC,CAAD,CAAxB;;MAEA,IAAI;QACF,MAAM4B,SAAS,GAAG,KAAKH,YAAL,CAAkBO,OAAO,CAACC,OAA1B,CAAlB;QACA,IAAI,CAACL,SAAL,EAAgB,MAAM,KAAIM,uCAAJ,EAA8BF,OAAO,CAACtB,QAAtC,EAAgDsB,OAAO,CAACC,OAAxD,CAAN;QAChB,MAAMZ,GAAG,GAAG,MAAMO,SAAS,CAACO,IAAV,CAAeH,OAAO,CAACtB,QAAvB,EAAiCsB,OAAO,CAACI,QAAzC,EAAmDvC,SAAnD,CAAlB;QACA,OAAOwB,GAAP;MACD,CALD,CAKE,OAAOgB,GAAP,EAAiB;QACjB;QACA,KAAKjD,MAAL,CAAYkD,KAAZ,CAAmB,iDAAgDD,GAAG,CAACE,OAAQ,EAA/E;QACA,OAAO,IAAP;MACD;IACF;;IAED,OAAO,IAAP;EACD;;EAED1B,MAAM,CAAChB,SAAD,EAAwB;IAAA;;IAC5B,MAAM2C,OAAO,qBAAG3C,SAAS,CAACI,GAAV,CAAcC,kBAAA,CAAWC,EAAzB,CAAH,0EAAG,eAA8BsC,IAAjC,wDAAG,oBAAoCpB,GAApD;IACA,IAAI,CAACmB,OAAL,EAAc,OAAO,IAAP;IACd,OAAO,KAAIE,mBAAJ,EAAQF,OAAO,CAACG,QAAhB,EAA0B,KAAIC,2BAAJ,EAAgBJ,OAAO,CAACK,KAAxB,CAA1B,CAAP;EACD;;EAEDC,WAAW,GAAG;IACZ,OAAO,KAAK/D,QAAZ;EACD;;EAEDgE,uBAAuB,CAAClD,SAAD,EAAuB;IAC5C,MAAM0B,GAAG,GAAG,KAAKjC,IAAL,CAAU0D,YAAV,CAAuBnD,SAAvB,EAAkC0B,GAA9C;IACA,MAAM0B,2BAAqC,GAAG1B,GAAG,CAAC2B,kBAAJ,GAAyB3B,GAAG,CAAC2B,kBAAJ,CAAuBrD,SAAvB,CAAzB,GAA6D,EAA3G;IACA,MAAMsD,iBAAiB,GAAGF,2BAA2B,CAACG,MAA5B,CAAmC,KAAKN,WAAL,EAAnC,CAA1B;IACA,OAAOK,iBAAP;EACD;;EAEDE,uBAAuB,GAAG;IACxB,OAAO,KAAKN,uBAAL,CAA6BO,IAA7B,CAAkC,IAAlC,CAAP;EACD;EACD;AACF;AACA;AACA;;;EACEC,iBAAiB,CAAC3B,SAAD,EAAuB;IACtC,KAAKpC,aAAL,CAAmBgE,QAAnB,CAA4B5B,SAA5B;IACA,OAAO,IAAP;EACD;;EAoBoB,aAAR6B,QAAQ,CACnB,CAACzE,OAAD,EAAU0E,OAAV,EAAmBvE,SAAnB,EAA8BF,GAA9B,EAAmCC,QAAnC,EAA6CyE,YAA7C,EAA2DtE,QAA3D,EAAqEC,IAArE,CADmB,EAWnBsE,MAXmB,EAYnB,CAACrE,WAAD,EAAcC,aAAd,CAZmB,EAanB;IACA,MAAMJ,MAAM,GAAGuE,YAAY,CAACE,YAAb,CAA0B3D,kBAAA,CAAWC,EAArC,CAAf;IACA,MAAMgB,IAAI,GAAG,IAAItC,QAAJ,CACX+E,MAAM,CAAC7E,QADI,EAGXC,OAHW,EAKXC,GALW,EAOXC,QAPW,EASXC,SATW,EAWXC,MAXW,EAaXC,QAbW,EAeXC,IAfW,EAiBXC,WAjBW,EAmBXC,aAnBW,CAAb;IAqBA2B,IAAI,CAACoC,iBAAL,CAAuB,KAAIO,oCAAJ,EAAqB7E,GAArB,EAA0BC,QAA1B,EAAoCC,SAApC,CAAvB;IACAE,QAAQ,CAAC0E,kBAAT,CAA4B5C,IAAI,CAACkC,uBAAL,EAA5B;;IAEA,IAAIlE,SAAJ,EAAe;MACbA,SAAS,CAAC6E,eAAV,CAA0B,MAAOnE,SAAP,IAAqB;QAC7C,MAAMwB,GAAG,GAAG,MAAMF,IAAI,CAACW,UAAL,CAAgBjC,SAAhB,CAAlB;QAEA,OAAO;UACLwB,GAAG,EAAEA,GAAF,aAAEA,GAAF,uBAAEA,GAAG,CAAE4C,QAAL;QADA,CAAP;MAGD,CAND;IAOD;;IAEDP,OAAO,CAACF,QAAR,CAAiB,IAAAU,mBAAA,EAAW/C,IAAX,CAAjB;IAEAnC,OAAO,CAACmF,kBAAR,CAA2B,KAAIC,8BAAJ,EAA0BjD,IAA1B,CAA3B;IACA,OAAOA,IAAP;EACD;;AAzLmB;;;gCAATtC,Q,WAkHI,CAACwF,eAAA,CAAKC,QAAL,EAAD,EAA2BD,eAAA,CAAKC,QAAL,EAA3B,C;gCAlHJzF,Q,aAoHM0F,kB;gCApHN1F,Q,kBAqHW,CACpB2F,wBADoB,EAEpBC,wBAFoB,EAGpBC,4BAHoB,EAIpBC,gBAJoB,EAKpBC,0BALoB,EAMpBC,sBANoB,EAOpBC,mBAPoB,EAQpBC,kBARoB,C;gCArHXlG,Q,mBAgIY;EACrBE,QAAQ,EAAE,CAAC,aAAD;AADW,C;;AA4DzBmB,kBAAA,CAAW8E,UAAX,CAAsBnG,QAAtB"}
+{"version":3,"names":["DocsMain","constructor","patterns","preview","pkg","compiler","workspace","logger","devFiles","envs","docPropSlot","docReaderSlot","getDocsMap","components","ComponentMap","as","component","getDocsFiles","computeDevFiles","docFiles","get","DocsAspect","id","state","filesystem","files","filter","file","includes","relative","getDescription","componentDoc","getDoc","desc","description","consumerComponent","_consumer","fromJsDocs","docs","find","doc","getTemplate","env","getDocsTemplate","getDocReader","extension","values","docReader","isFormatSupported","computeDoc","length","docFile","extname","FileExtensionNotSupported","read","contents","err","debug","message","docData","data","Doc","filePath","DocPropList","props","getPatterns","getComponentDevPatterns","calculateEnv","componentEnvDocsDevPatterns","getDocsDevPatterns","componentPatterns","concat","getDevPatternToRegister","bind","registerDocReader","register","provider","graphql","loggerAspect","config","createLogger","DefaultDocReader","registerDevPattern","onComponentLoad","opts","loadDocs","undefined","toObject","docsSchema","registerDefinition","DocsPreviewDefinition","Slot","withType","MainRuntime","PreviewAspect","GraphqlAspect","WorkspaceAspect","PkgAspect","CompilerAspect","LoggerAspect","DevFilesAspect","EnvsAspect","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 { 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 { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';\nimport ConsumerComponent from '@teambit/legacy/dist/consumer/component';\nimport { Workspace, WorkspaceAspect } from '@teambit/workspace';\nimport { Doc, DocPropList } from '@teambit/docs.entities.doc';\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.computeDevFiles(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    if (desc) return desc;\n    const consumerComponent: ConsumerComponent = component.state._consumer;\n    const fromJsDocs = consumerComponent.docs?.find((doc) => doc.description);\n\n    return fromJsDocs?.description || '';\n  }\n\n  async getTemplate(env: Environment) {\n    return env.getDocsTemplate();\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).env;\n    const componentEnvDocsDevPatterns: string[] = env.getDocsDevPatterns ? env.getDocsDevPatterns(component) : [];\n    const componentPatterns = componentEnvDocsDevPatterns.concat(this.getPatterns());\n    return 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  ];\n\n  static defaultConfig = {\n    patterns: ['**/*.docs.*'],\n  };\n\n  static async provider(\n    [preview, graphql, workspace, pkg, compiler, loggerAspect, devFiles, envs]: [\n      PreviewMain,\n      GraphqlMain,\n      Workspace,\n      PkgMain,\n      CompilerMain,\n      LoggerMain,\n      DevFilesMain,\n      EnvsMain\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\n      preview,\n\n      pkg,\n\n      compiler,\n\n      workspace,\n\n      logger,\n\n      devFiles,\n\n      envs,\n\n      docPropSlot,\n\n      docReaderSlot\n    );\n    docs.registerDocReader(new DefaultDocReader(pkg, compiler, workspace));\n    devFiles.registerDevPattern(docs.getDevPatternToRegister());\n\n    if (workspace) {\n      workspace.onComponentLoad(async (component, opts) => {\n        if (opts?.loadDocs === false) return undefined;\n        const doc = await docs.computeDoc(component);\n\n        return {\n          doc: doc?.toObject(),\n        };\n      });\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;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAGA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAoBA;AACA;AACA;AACO,MAAMA,QAAN,CAAe;EACpBC,WAAW,CACDC,QADC;EAET;AACJ;AACA;EACYC,OALC,EAODC,GAPC,EASDC,QATC,EAWDC,SAXC,EAaDC,MAbC,EAeDC,QAfC,EAiBDC,IAjBC,EAmBDC,WAnBC,EAqBDC,aArBC,EAsBT;IAAA,KArBQT,QAqBR,GArBQA,QAqBR;IAAA,KAjBQC,OAiBR,GAjBQA,OAiBR;IAAA,KAfQC,GAeR,GAfQA,GAeR;IAAA,KAbQC,QAaR,GAbQA,QAaR;IAAA,KAXQC,SAWR,GAXQA,SAWR;IAAA,KATQC,MASR,GATQA,MASR;IAAA,KAPQC,QAOR,GAPQA,QAOR;IAAA,KALQC,IAKR,GALQA,IAKR;IAAA,KAHQC,WAGR,GAHQA,WAGR;IAAA,KADQC,aACR,GADQA,aACR;EAAE;EAEJ;AACF;AACA;;;EACEC,UAAU,CAACC,UAAD,EAAyD;IACjE,OAAOC,yBAAA,CAAaC,EAAb,CAAiCF,UAAjC,EAA8CG,SAAD,IAAe;MACjE,OAAO,KAAKC,YAAL,CAAkBD,SAAlB,CAAP;IACD,CAFM,CAAP;EAGD;;EAEDC,YAAY,CAACD,SAAD,EAAwC;IAClD,MAAMR,QAAQ,GAAG,KAAKA,QAAL,CAAcU,eAAd,CAA8BF,SAA9B,CAAjB;IACA,MAAMG,QAAQ,GAAGX,QAAQ,CAACY,GAAT,CAAaC,kBAAA,CAAWC,EAAxB,CAAjB;IACA,OAAON,SAAS,CAACO,KAAV,CAAgBC,UAAhB,CAA2BC,KAA3B,CAAiCC,MAAjC,CAAyCC,IAAD,IAAUR,QAAQ,CAACS,QAAT,CAAkBD,IAAI,CAACE,QAAvB,CAAlD,CAAP;EACD;EAED;AACF;AACA;;;EACsB,MAAdC,cAAc,CAACd,SAAD,EAAwC;IAAA;;IAC1D,MAAMe,YAAY,GAAG,KAAKC,MAAL,CAAYhB,SAAZ,CAArB;IACA,MAAMiB,IAAI,GAAGF,YAAH,aAAGA,YAAH,uBAAGA,YAAY,CAAEG,WAA3B;IACA,IAAID,IAAJ,EAAU,OAAOA,IAAP;IACV,MAAME,iBAAoC,GAAGnB,SAAS,CAACO,KAAV,CAAgBa,SAA7D;IACA,MAAMC,UAAU,4BAAGF,iBAAiB,CAACG,IAArB,0DAAG,sBAAwBC,IAAxB,CAA8BC,GAAD,IAASA,GAAG,CAACN,WAA1C,CAAnB;IAEA,OAAO,CAAAG,UAAU,SAAV,IAAAA,UAAU,WAAV,YAAAA,UAAU,CAAEH,WAAZ,KAA2B,EAAlC;EACD;;EAEgB,MAAXO,WAAW,CAACC,GAAD,EAAmB;IAClC,OAAOA,GAAG,CAACC,eAAJ,EAAP;EACD;;EAEDC,YAAY,CAACC,SAAD,EAAoB;IAC9B,OAAO,KAAKlC,aAAL,CAAmBmC,MAAnB,GAA4BP,IAA5B,CAAkCQ,SAAD,IAAeA,SAAS,CAACC,iBAAV,CAA4BH,SAA5B,CAAhD,CAAP;EACD;EAED;AACF;AACA;;;EACkB,MAAVI,UAAU,CAACjC,SAAD,EAAuB;IACrC,MAAMG,QAAQ,GAAG,KAAKF,YAAL,CAAkBD,SAAlB,CAAjB;;IACA,IAAIG,QAAQ,CAAC+B,MAAb,EAAqB;MACnB;MACA,MAAMC,OAAO,GAAGhC,QAAQ,CAAC,CAAD,CAAxB;;MAEA,IAAI;QACF,MAAM4B,SAAS,GAAG,KAAKH,YAAL,CAAkBO,OAAO,CAACC,OAA1B,CAAlB;QACA,IAAI,CAACL,SAAL,EAAgB,MAAM,KAAIM,uCAAJ,EAA8BF,OAAO,CAACtB,QAAtC,EAAgDsB,OAAO,CAACC,OAAxD,CAAN;QAChB,MAAMZ,GAAG,GAAG,MAAMO,SAAS,CAACO,IAAV,CAAeH,OAAO,CAACtB,QAAvB,EAAiCsB,OAAO,CAACI,QAAzC,EAAmDvC,SAAnD,CAAlB;QACA,OAAOwB,GAAP;MACD,CALD,CAKE,OAAOgB,GAAP,EAAiB;QACjB;QACA,KAAKjD,MAAL,CAAYkD,KAAZ,CAAmB,iDAAgDD,GAAG,CAACE,OAAQ,EAA/E;QACA,OAAO,IAAP;MACD;IACF;;IAED,OAAO,IAAP;EACD;;EAED1B,MAAM,CAAChB,SAAD,EAAwB;IAAA;;IAC5B,MAAM2C,OAAO,qBAAG3C,SAAS,CAACI,GAAV,CAAcC,kBAAA,CAAWC,EAAzB,CAAH,0EAAG,eAA8BsC,IAAjC,wDAAG,oBAAoCpB,GAApD;IACA,IAAI,CAACmB,OAAL,EAAc,OAAO,IAAP;IACd,OAAO,KAAIE,mBAAJ,EAAQF,OAAO,CAACG,QAAhB,EAA0B,KAAIC,2BAAJ,EAAgBJ,OAAO,CAACK,KAAxB,CAA1B,CAAP;EACD;;EAEDC,WAAW,GAAG;IACZ,OAAO,KAAK/D,QAAZ;EACD;;EAEDgE,uBAAuB,CAAClD,SAAD,EAAuB;IAC5C,MAAM0B,GAAG,GAAG,KAAKjC,IAAL,CAAU0D,YAAV,CAAuBnD,SAAvB,EAAkC0B,GAA9C;IACA,MAAM0B,2BAAqC,GAAG1B,GAAG,CAAC2B,kBAAJ,GAAyB3B,GAAG,CAAC2B,kBAAJ,CAAuBrD,SAAvB,CAAzB,GAA6D,EAA3G;IACA,MAAMsD,iBAAiB,GAAGF,2BAA2B,CAACG,MAA5B,CAAmC,KAAKN,WAAL,EAAnC,CAA1B;IACA,OAAOK,iBAAP;EACD;;EAEDE,uBAAuB,GAAG;IACxB,OAAO,KAAKN,uBAAL,CAA6BO,IAA7B,CAAkC,IAAlC,CAAP;EACD;EACD;AACF;AACA;AACA;;;EACEC,iBAAiB,CAAC3B,SAAD,EAAuB;IACtC,KAAKpC,aAAL,CAAmBgE,QAAnB,CAA4B5B,SAA5B;IACA,OAAO,IAAP;EACD;;EAoBoB,aAAR6B,QAAQ,CACnB,CAACzE,OAAD,EAAU0E,OAAV,EAAmBvE,SAAnB,EAA8BF,GAA9B,EAAmCC,QAAnC,EAA6CyE,YAA7C,EAA2DtE,QAA3D,EAAqEC,IAArE,CADmB,EAWnBsE,MAXmB,EAYnB,CAACrE,WAAD,EAAcC,aAAd,CAZmB,EAanB;IACA,MAAMJ,MAAM,GAAGuE,YAAY,CAACE,YAAb,CAA0B3D,kBAAA,CAAWC,EAArC,CAAf;IACA,MAAMgB,IAAI,GAAG,IAAItC,QAAJ,CACX+E,MAAM,CAAC7E,QADI,EAGXC,OAHW,EAKXC,GALW,EAOXC,QAPW,EASXC,SATW,EAWXC,MAXW,EAaXC,QAbW,EAeXC,IAfW,EAiBXC,WAjBW,EAmBXC,aAnBW,CAAb;IAqBA2B,IAAI,CAACoC,iBAAL,CAAuB,KAAIO,oCAAJ,EAAqB7E,GAArB,EAA0BC,QAA1B,EAAoCC,SAApC,CAAvB;IACAE,QAAQ,CAAC0E,kBAAT,CAA4B5C,IAAI,CAACkC,uBAAL,EAA5B;;IAEA,IAAIlE,SAAJ,EAAe;MACbA,SAAS,CAAC6E,eAAV,CAA0B,OAAOnE,SAAP,EAAkBoE,IAAlB,KAA2B;QACnD,IAAI,CAAAA,IAAI,SAAJ,IAAAA,IAAI,WAAJ,YAAAA,IAAI,CAAEC,QAAN,MAAmB,KAAvB,EAA8B,OAAOC,SAAP;QAC9B,MAAM9C,GAAG,GAAG,MAAMF,IAAI,CAACW,UAAL,CAAgBjC,SAAhB,CAAlB;QAEA,OAAO;UACLwB,GAAG,EAAEA,GAAF,aAAEA,GAAF,uBAAEA,GAAG,CAAE+C,QAAL;QADA,CAAP;MAGD,CAPD;IAQD;;IAEDV,OAAO,CAACF,QAAR,CAAiB,IAAAa,mBAAA,EAAWlD,IAAX,CAAjB;IAEAnC,OAAO,CAACsF,kBAAR,CAA2B,KAAIC,8BAAJ,EAA0BpD,IAA1B,CAA3B;IACA,OAAOA,IAAP;EACD;;AA1LmB;;;gCAATtC,Q,WAkHI,CAAC2F,eAAA,CAAKC,QAAL,EAAD,EAA2BD,eAAA,CAAKC,QAAL,EAA3B,C;gCAlHJ5F,Q,aAoHM6F,kB;gCApHN7F,Q,kBAqHW,CACpB8F,wBADoB,EAEpBC,wBAFoB,EAGpBC,4BAHoB,EAIpBC,gBAJoB,EAKpBC,0BALoB,EAMpBC,sBANoB,EAOpBC,mBAPoB,EAQpBC,kBARoB,C;gCArHXrG,Q,mBAgIY;EACrBE,QAAQ,EAAE,CAAC,aAAD;AADW,C;;AA6DzBmB,kBAAA,CAAWiF,UAAX,CAAsBtG,QAAtB"}

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

@@ -1,18 +1,17 @@
 import { ComponentUI } from '@teambit/component';
-import type { TitleBadge } from '@teambit/component.ui.component-meta';
 import { ComponentCompareUI } from '@teambit/component-compare';
-import { TitleBadgeSlot } from './overview';
+import type { TitleBadgeSlot, TitleBadge } from './overview';
 export declare class DocsUI {
     readonly titleBadgeSlot: TitleBadgeSlot;
     constructor(titleBadgeSlot: TitleBadgeSlot);
     /**
      * register a new title badge into the overview section of a component.
      */
-    registerTitleBadge(...titleBadge: TitleBadge[]): this;
+    registerTitleBadge(titleBadges: TitleBadge | TitleBadge[]): this;
     /**
      * list all title badges registered.
      */
-    listTitleBadges(): TitleBadgeSlot;
+    listTitleBadges(): TitleBadge[];
     static dependencies: import("@teambit/harmony").Aspect[];
     static runtime: import("@teambit/harmony").RuntimeDefinition;
     static slots: ((registerFn: () => string) => import("@teambit/harmony").SlotRegistry<TitleBadge>)[];

package/dist/docs.ui.runtime.js

@@ -21,6 +21,16 @@ function _defineProperty2() {
   return data;
 }
 
+function _lodash() {
+  const data = require("lodash");
+
+  _lodash = function () {
+    return data;
+  };
+
+  return data;
+}
+
 function _component() {
   const data = require("@teambit/component");
 
@@ -100,8 +110,9 @@ class DocsUI {
    */
 
 
-  registerTitleBadge(...titleBadge) {
-    this.titleBadgeSlot.register(titleBadge);
+  registerTitleBadge(titleBadges) {
+    const badges = Array.isArray(titleBadges) ? titleBadges : [titleBadges];
+    this.titleBadgeSlot.register(badges);
     return this;
   }
   /**
@@ -110,12 +121,12 @@ class DocsUI {
 
 
   listTitleBadges() {
-    return this.titleBadgeSlot;
+    return (0, _lodash().flatten)(this.titleBadgeSlot.values());
   }
 
   static async provider([component, componentCompare], config, [titleBadgeSlot]) {
     const docs = new DocsUI(titleBadgeSlot);
-    const section = new (_overview().OverviewSection)(docs);
+    const section = new (_overview().OverviewSection)(titleBadgeSlot);
     const compareSection = new (_docsCompare().OverviewCompareSection)(titleBadgeSlot);
     component.registerRoute(section.route);
     component.registerNavigation(section.navigationLink, section.order);

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

@@ -1 +1 @@
-{"version":3,"names":["DocsUI","constructor","titleBadgeSlot","registerTitleBadge","titleBadge","register","listTitleBadges","provider","component","componentCompare","config","docs","section","OverviewSection","compareSection","OverviewCompareSection","registerRoute","route","registerNavigation","navigationLink","order","props","registerRoutes","ComponentAspect","ComponentCompareAspect","UIRuntime","Slot","withType","DocsAspect","addRuntime"],"sources":["docs.ui.runtime.tsx"],"sourcesContent":["import { ComponentAspect, ComponentUI } from '@teambit/component';\nimport { Slot } from '@teambit/harmony';\nimport type { TitleBadge } from '@teambit/component.ui.component-meta';\nimport { UIRuntime } from '@teambit/ui';\nimport ComponentCompareAspect, { ComponentCompareUI } from '@teambit/component-compare';\n\nimport { DocsAspect } from './docs.aspect';\nimport { OverviewSection } from './overview.section';\nimport { TitleBadgeSlot } from './overview';\nimport { OverviewCompareSection } from './docs.compare.section';\n\nexport class DocsUI {\n  constructor(readonly titleBadgeSlot: TitleBadgeSlot) {}\n\n  /**\n   * register a new title badge into the overview section of a component.\n   */\n  registerTitleBadge(...titleBadge: TitleBadge[]) {\n    this.titleBadgeSlot.register(titleBadge);\n    return this;\n  }\n\n  /**\n   * list all title badges registered.\n   */\n  listTitleBadges() {\n    return this.titleBadgeSlot;\n  }\n\n  static dependencies = [ComponentAspect, ComponentCompareAspect];\n\n  static runtime = UIRuntime;\n\n  static slots = [Slot.withType<TitleBadge>()];\n\n  static async provider(\n    [component, componentCompare]: [ComponentUI, ComponentCompareUI],\n    config,\n    [titleBadgeSlot]: [TitleBadgeSlot]\n  ) {\n    const docs = new DocsUI(titleBadgeSlot);\n    const section = new OverviewSection(docs);\n    const compareSection = new OverviewCompareSection(titleBadgeSlot);\n\n    component.registerRoute(section.route);\n    component.registerNavigation(section.navigationLink, section.order);\n    componentCompare.registerNavigation({\n      props: compareSection.navigationLink,\n      order: compareSection.navigationLink.order,\n    });\n    componentCompare.registerRoutes([compareSection.route]);\n    return docs;\n  }\n}\n\nexport default DocsUI;\n\nDocsAspect.addRuntime(DocsUI);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEO,MAAMA,MAAN,CAAa;EAClBC,WAAW,CAAUC,cAAV,EAA0C;IAAA,KAAhCA,cAAgC,GAAhCA,cAAgC;EAAE;EAEvD;AACF;AACA;;;EACEC,kBAAkB,CAAC,GAAGC,UAAJ,EAA8B;IAC9C,KAAKF,cAAL,CAAoBG,QAApB,CAA6BD,UAA7B;IACA,OAAO,IAAP;EACD;EAED;AACF;AACA;;;EACEE,eAAe,GAAG;IAChB,OAAO,KAAKJ,cAAZ;EACD;;EAQoB,aAARK,QAAQ,CACnB,CAACC,SAAD,EAAYC,gBAAZ,CADmB,EAEnBC,MAFmB,EAGnB,CAACR,cAAD,CAHmB,EAInB;IACA,MAAMS,IAAI,GAAG,IAAIX,MAAJ,CAAWE,cAAX,CAAb;IACA,MAAMU,OAAO,GAAG,KAAIC,2BAAJ,EAAoBF,IAApB,CAAhB;IACA,MAAMG,cAAc,GAAG,KAAIC,qCAAJ,EAA2Bb,cAA3B,CAAvB;IAEAM,SAAS,CAACQ,aAAV,CAAwBJ,OAAO,CAACK,KAAhC;IACAT,SAAS,CAACU,kBAAV,CAA6BN,OAAO,CAACO,cAArC,EAAqDP,OAAO,CAACQ,KAA7D;IACAX,gBAAgB,CAACS,kBAAjB,CAAoC;MAClCG,KAAK,EAAEP,cAAc,CAACK,cADY;MAElCC,KAAK,EAAEN,cAAc,CAACK,cAAf,CAA8BC;IAFH,CAApC;IAIAX,gBAAgB,CAACa,cAAjB,CAAgC,CAACR,cAAc,CAACG,KAAhB,CAAhC;IACA,OAAON,IAAP;EACD;;AAzCiB;;;gCAAPX,M,kBAkBW,CAACuB,4BAAD,EAAkBC,2BAAlB,C;gCAlBXxB,M,aAoBMyB,e;gCApBNzB,M,WAsBI,CAAC0B,eAAA,CAAKC,QAAL,EAAD,C;eAsBF3B,M;;;AAEf4B,kBAAA,CAAWC,UAAX,CAAsB7B,MAAtB"}
+{"version":3,"names":["DocsUI","constructor","titleBadgeSlot","registerTitleBadge","titleBadges","badges","Array","isArray","register","listTitleBadges","flatten","values","provider","component","componentCompare","config","docs","section","OverviewSection","compareSection","OverviewCompareSection","registerRoute","route","registerNavigation","navigationLink","order","props","registerRoutes","ComponentAspect","ComponentCompareAspect","UIRuntime","Slot","withType","DocsAspect","addRuntime"],"sources":["docs.ui.runtime.tsx"],"sourcesContent":["import { flatten } from 'lodash';\nimport { ComponentAspect, ComponentUI } from '@teambit/component';\nimport { Slot } from '@teambit/harmony';\nimport { UIRuntime } from '@teambit/ui';\nimport ComponentCompareAspect, { ComponentCompareUI } from '@teambit/component-compare';\n\nimport { DocsAspect } from './docs.aspect';\nimport { OverviewSection } from './overview.section';\nimport type { TitleBadgeSlot, TitleBadge } from './overview';\nimport { OverviewCompareSection } from './docs.compare.section';\n\nexport class DocsUI {\n  constructor(readonly titleBadgeSlot: TitleBadgeSlot) {}\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  static dependencies = [ComponentAspect, ComponentCompareAspect];\n\n  static runtime = UIRuntime;\n\n  static slots = [Slot.withType<TitleBadge>()];\n\n  static async provider(\n    [component, componentCompare]: [ComponentUI, ComponentCompareUI],\n    config,\n    [titleBadgeSlot]: [TitleBadgeSlot]\n  ) {\n    const docs = new DocsUI(titleBadgeSlot);\n    const section = new OverviewSection(titleBadgeSlot);\n    const compareSection = new OverviewCompareSection(titleBadgeSlot);\n\n    component.registerRoute(section.route);\n    component.registerNavigation(section.navigationLink, section.order);\n    componentCompare.registerNavigation({\n      props: compareSection.navigationLink,\n      order: compareSection.navigationLink.order,\n    });\n    componentCompare.registerRoutes([compareSection.route]);\n    return docs;\n  }\n}\n\nexport default DocsUI;\n\nDocsAspect.addRuntime(DocsUI);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEO,MAAMA,MAAN,CAAa;EAClBC,WAAW,CAAUC,cAAV,EAA0C;IAAA,KAAhCA,cAAgC,GAAhCA,cAAgC;EAAE;EAEvD;AACF;AACA;;;EACEC,kBAAkB,CAACC,WAAD,EAAyC;IACzD,MAAMC,MAAM,GAAGC,KAAK,CAACC,OAAN,CAAcH,WAAd,IAA6BA,WAA7B,GAA2C,CAACA,WAAD,CAA1D;IACA,KAAKF,cAAL,CAAoBM,QAApB,CAA6BH,MAA7B;IACA,OAAO,IAAP;EACD;EAED;AACF;AACA;;;EACEI,eAAe,GAAG;IAChB,OAAO,IAAAC,iBAAA,EAAQ,KAAKR,cAAL,CAAoBS,MAApB,EAAR,CAAP;EACD;;EAQoB,aAARC,QAAQ,CACnB,CAACC,SAAD,EAAYC,gBAAZ,CADmB,EAEnBC,MAFmB,EAGnB,CAACb,cAAD,CAHmB,EAInB;IACA,MAAMc,IAAI,GAAG,IAAIhB,MAAJ,CAAWE,cAAX,CAAb;IACA,MAAMe,OAAO,GAAG,KAAIC,2BAAJ,EAAoBhB,cAApB,CAAhB;IACA,MAAMiB,cAAc,GAAG,KAAIC,qCAAJ,EAA2BlB,cAA3B,CAAvB;IAEAW,SAAS,CAACQ,aAAV,CAAwBJ,OAAO,CAACK,KAAhC;IACAT,SAAS,CAACU,kBAAV,CAA6BN,OAAO,CAACO,cAArC,EAAqDP,OAAO,CAACQ,KAA7D;IACAX,gBAAgB,CAACS,kBAAjB,CAAoC;MAClCG,KAAK,EAAEP,cAAc,CAACK,cADY;MAElCC,KAAK,EAAEN,cAAc,CAACK,cAAf,CAA8BC;IAFH,CAApC;IAIAX,gBAAgB,CAACa,cAAjB,CAAgC,CAACR,cAAc,CAACG,KAAhB,CAAhC;IACA,OAAON,IAAP;EACD;;AA1CiB;;;gCAAPhB,M,kBAmBW,CAAC4B,4BAAD,EAAkBC,2BAAlB,C;gCAnBX7B,M,aAqBM8B,e;gCArBN9B,M,WAuBI,CAAC+B,eAAA,CAAKC,QAAL,EAAD,C;eAsBFhC,M;;;AAEfiC,kBAAA,CAAWC,UAAX,CAAsBlC,MAAtB"}

package/dist/index.d.ts

@@ -10,7 +10,7 @@ export type { DocsPreview, DocsRootProps } from './docs.preview.runtime';
 export type { DocReader } from './doc-reader';
 export type { Docs, Example } from './docs';
 export { defaultDocs } from './docs';
-export type { TitleBadgeSlot } from './overview';
-export { Overview } from './overview';
+export type { TitleBadgeSlot, TitleBadge } from './overview';
+export { Overview, BadgePosition } from './overview';
 export { DocsAspect };
 export default DocsAspect;

package/dist/index.js

@@ -3,6 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "BadgePosition", {
+  enumerable: true,
+  get: function () {
+    return _overview().BadgePosition;
+  }
+});
 Object.defineProperty(exports, "Doc", {
   enumerable: true,
   get: function () {

package/dist/index.js.map

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

package/dist/overview/index.d.ts

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

package/dist/overview/index.js

@@ -3,6 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "BadgePosition", {
+  enumerable: true,
+  get: function () {
+    return _overview().BadgePosition;
+  }
+});
 Object.defineProperty(exports, "Overview", {
   enumerable: true,
   get: function () {

package/dist/overview/index.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["export { Overview } from './overview';\nexport type { TitleBadgeSlot } from './overview';\n"],"mappings":";;;;;;;;;;;;AAAA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA"}
+{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["export { Overview, BadgePosition } from './overview';\nexport type { TitleBadgeSlot, TitleBadge } from './overview';\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA"}

package/dist/overview/overview.d.ts

@@ -1,6 +1,17 @@
-/// <reference types="react" />
+import { ComponentType } from 'react';
 import type { SlotRegistry } from '@teambit/harmony';
-import { TitleBadge } from '@teambit/component.ui.component-meta';
+export declare enum BadgePosition {
+    Title = 0,
+    SubTitle = 1,
+    Labels = 2,
+    Package = 3,
+    ElementsPackage = 4
+}
+export declare type TitleBadge = {
+    component: ComponentType<any>;
+    weight?: number;
+    position?: BadgePosition;
+};
 export declare type TitleBadgeSlot = SlotRegistry<TitleBadge[]>;
 export declare type OverviewProps = {
     titleBadges: TitleBadgeSlot;

package/dist/overview/overview.js

@@ -9,6 +9,7 @@ require("core-js/modules/es.array.iterator.js");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.BadgePosition = void 0;
 exports.Overview = Overview;
 
 function _react() {
@@ -22,7 +23,7 @@ function _react() {
 }
 
 function _lodash() {
-  const data = _interopRequireDefault(require("lodash.flatten"));
+  const data = require("lodash");
 
   _lodash = function () {
     return data;
@@ -105,6 +106,17 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
 
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
+let BadgePosition;
+exports.BadgePosition = BadgePosition;
+
+(function (BadgePosition) {
+  BadgePosition[BadgePosition["Title"] = 0] = "Title";
+  BadgePosition[BadgePosition["SubTitle"] = 1] = "SubTitle";
+  BadgePosition[BadgePosition["Labels"] = 2] = "Labels";
+  BadgePosition[BadgePosition["Package"] = 3] = "Package";
+  BadgePosition[BadgePosition["ElementsPackage"] = 4] = "ElementsPackage";
+})(BadgePosition || (exports.BadgePosition = BadgePosition = {}));
+
 function Overview({
   titleBadges
 }) {
@@ -142,7 +154,7 @@ function Overview({
     abstract: component.description,
     labels: component.labels,
     packageName: component.packageName,
-    titleBadges: (0, _lodash().default)(titleBadges.values()),
+    titleBadges: (0, _lodash().flatten)(titleBadges.values()),
     componentDescriptor: componentDescriptor,
     component: component
   }), /*#__PURE__*/_react().default.createElement(_previewUi().ComponentPreview, {

package/dist/overview/overview.js.map

@@ -1 +1 @@
-{"version":3,"names":["Overview","titleBadges","component","useContext","ComponentContext","componentDescriptor","useComponentDescriptor","lanesModel","useLanesContext","currentLane","viewedLane","showHeader","preview","legacyHeader","buildStatus","host","margin","styles","overviewWrapper","componentOverviewBlock","displayName","version","description","labels","packageName","flatten","values","width","height"],"sources":["overview.tsx"],"sourcesContent":["import React, { useContext } from 'react';\nimport flatten from 'lodash.flatten';\nimport { ComponentContext, useComponentDescriptor } from '@teambit/component';\nimport type { SlotRegistry } from '@teambit/harmony';\nimport { ComponentPreview } from '@teambit/preview.ui.component-preview';\nimport { StatusMessageCard } from '@teambit/design.ui.surfaces.status-message-card';\nimport { ComponentOverview, TitleBadge } from '@teambit/component.ui.component-meta';\nimport { LaneBreadcrumb, useLanesContext } from '@teambit/lanes.ui.lanes';\nimport { Separator } from '@teambit/design.ui.separator';\nimport styles from './overview.module.scss';\n\nexport type TitleBadgeSlot = SlotRegistry<TitleBadge[]>;\n\nexport type OverviewProps = {\n  titleBadges: TitleBadgeSlot;\n};\n\nexport function Overview({ titleBadges }: OverviewProps) {\n  const component = useContext(ComponentContext);\n  const componentDescriptor = useComponentDescriptor();\n  const lanesModel = useLanesContext();\n  const currentLane = lanesModel?.viewedLane;\n\n  const showHeader = !component.preview?.legacyHeader;\n\n  if (component?.buildStatus === 'pending' && component?.host === 'teambit.scope/scope')\n    return (\n      <StatusMessageCard style={{ margin: 'auto' }} status=\"PROCESSING\" title=\"component preview pending\">\n        this might take some time\n      </StatusMessageCard>\n    );\n\n  if (component?.buildStatus === 'failed' && component?.host === 'teambit.scope/scope')\n    return <StatusMessageCard style={{ margin: 'auto' }} status=\"FAILURE\" title=\"failed to get component preview \" />;\n\n  return (\n    <div className={styles.overviewWrapper}>\n      {currentLane && <LaneBreadcrumb lane={currentLane} />}\n      {currentLane && <Separator isPresentational />}\n      {showHeader && (\n        <ComponentOverview\n          className={styles.componentOverviewBlock}\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      <ComponentPreview\n        component={component}\n        style={{ width: '100%', height: '100%' }}\n        previewName=\"overview\"\n        fullContentHeight\n        scrolling=\"no\"\n      />\n    </div>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;AAAA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;;;;;AAQO,SAASA,QAAT,CAAkB;EAAEC;AAAF,CAAlB,EAAkD;EAAA;;EACvD,MAAMC,SAAS,GAAG,IAAAC,mBAAA,EAAWC,6BAAX,CAAlB;EACA,MAAMC,mBAAmB,GAAG,IAAAC,mCAAA,GAA5B;EACA,MAAMC,UAAU,GAAG,IAAAC,0BAAA,GAAnB;EACA,MAAMC,WAAW,GAAGF,UAAH,aAAGA,UAAH,uBAAGA,UAAU,CAAEG,UAAhC;EAEA,MAAMC,UAAU,GAAG,wBAACT,SAAS,CAACU,OAAX,+CAAC,mBAAmBC,YAApB,CAAnB;EAEA,IAAI,CAAAX,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEY,WAAX,MAA2B,SAA3B,IAAwC,CAAAZ,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEa,IAAX,MAAoB,qBAAhE,EACE,oBACE,+BAAC,qCAAD;IAAmB,KAAK,EAAE;MAAEC,MAAM,EAAE;IAAV,CAA1B;IAA8C,MAAM,EAAC,YAArD;IAAkE,KAAK,EAAC;EAAxE,+BADF;EAMF,IAAI,CAAAd,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEY,WAAX,MAA2B,QAA3B,IAAuC,CAAAZ,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEa,IAAX,MAAoB,qBAA/D,EACE,oBAAO,+BAAC,qCAAD;IAAmB,KAAK,EAAE;MAAEC,MAAM,EAAE;IAAV,CAA1B;IAA8C,MAAM,EAAC,SAArD;IAA+D,KAAK,EAAC;EAArE,EAAP;EAEF,oBACE;IAAK,SAAS,EAAEC,yBAAA,CAAOC;EAAvB,GACGT,WAAW,iBAAI,+BAAC,yBAAD;IAAgB,IAAI,EAAEA;EAAtB,EADlB,EAEGA,WAAW,iBAAI,+BAAC,qBAAD;IAAW,gBAAgB;EAA3B,EAFlB,EAGGE,UAAU,iBACT,+BAAC,gCAAD;IACE,SAAS,EAAEM,yBAAA,CAAOE,sBADpB;IAEE,WAAW,EAAEjB,SAAS,CAACkB,WAFzB;IAGE,OAAO,EAAElB,SAAS,CAACmB,OAHrB;IAIE,QAAQ,EAAEnB,SAAS,CAACoB,WAJtB;IAKE,MAAM,EAAEpB,SAAS,CAACqB,MALpB;IAME,WAAW,EAAErB,SAAS,CAACsB,WANzB;IAOE,WAAW,EAAE,IAAAC,iBAAA,EAAQxB,WAAW,CAACyB,MAAZ,EAAR,CAPf;IAQE,mBAAmB,EAAErB,mBARvB;IASE,SAAS,EAAEH;EATb,EAJJ,eAgBE,+BAAC,6BAAD;IACE,SAAS,EAAEA,SADb;IAEE,KAAK,EAAE;MAAEyB,KAAK,EAAE,MAAT;MAAiBC,MAAM,EAAE;IAAzB,CAFT;IAGE,WAAW,EAAC,UAHd;IAIE,iBAAiB,MAJnB;IAKE,SAAS,EAAC;EALZ,EAhBF,CADF;AA0BD"}
+{"version":3,"names":["BadgePosition","Overview","titleBadges","component","useContext","ComponentContext","componentDescriptor","useComponentDescriptor","lanesModel","useLanesContext","currentLane","viewedLane","showHeader","preview","legacyHeader","buildStatus","host","margin","styles","overviewWrapper","componentOverviewBlock","displayName","version","description","labels","packageName","flatten","values","width","height"],"sources":["overview.tsx"],"sourcesContent":["import React, { useContext, ComponentType } from 'react';\nimport { flatten } from 'lodash';\nimport { ComponentContext, useComponentDescriptor } from '@teambit/component';\nimport type { SlotRegistry } from '@teambit/harmony';\nimport { ComponentPreview } from '@teambit/preview.ui.component-preview';\nimport { StatusMessageCard } from '@teambit/design.ui.surfaces.status-message-card';\nimport { ComponentOverview } from '@teambit/component.ui.component-meta';\nimport { LaneBreadcrumb, useLanesContext } from '@teambit/lanes.ui.lanes';\nimport { Separator } from '@teambit/design.ui.separator';\nimport styles from './overview.module.scss';\n\nexport enum BadgePosition {\n  Title,\n  SubTitle,\n  Labels,\n  Package,\n  ElementsPackage,\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 OverviewProps = {\n  titleBadges: TitleBadgeSlot;\n};\n\nexport function Overview({ titleBadges }: OverviewProps) {\n  const component = useContext(ComponentContext);\n  const componentDescriptor = useComponentDescriptor();\n  const lanesModel = useLanesContext();\n  const currentLane = lanesModel?.viewedLane;\n\n  const showHeader = !component.preview?.legacyHeader;\n\n  if (component?.buildStatus === 'pending' && component?.host === 'teambit.scope/scope')\n    return (\n      <StatusMessageCard style={{ margin: 'auto' }} status=\"PROCESSING\" title=\"component preview pending\">\n        this might take some time\n      </StatusMessageCard>\n    );\n\n  if (component?.buildStatus === 'failed' && component?.host === 'teambit.scope/scope')\n    return <StatusMessageCard style={{ margin: 'auto' }} status=\"FAILURE\" title=\"failed to get component preview \" />;\n\n  return (\n    <div className={styles.overviewWrapper}>\n      {currentLane && <LaneBreadcrumb lane={currentLane} />}\n      {currentLane && <Separator isPresentational />}\n      {showHeader && (\n        <ComponentOverview\n          className={styles.componentOverviewBlock}\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      <ComponentPreview\n        component={component}\n        style={{ width: '100%', height: '100%' }}\n        previewName=\"overview\"\n        fullContentHeight\n        scrolling=\"no\"\n      />\n    </div>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;AAAA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;;;;;IAEYA,a;;;WAAAA,a;EAAAA,a,CAAAA,a;EAAAA,a,CAAAA,a;EAAAA,a,CAAAA,a;EAAAA,a,CAAAA,a;EAAAA,a,CAAAA,a;GAAAA,a,6BAAAA,a;;AAoBL,SAASC,QAAT,CAAkB;EAAEC;AAAF,CAAlB,EAAkD;EAAA;;EACvD,MAAMC,SAAS,GAAG,IAAAC,mBAAA,EAAWC,6BAAX,CAAlB;EACA,MAAMC,mBAAmB,GAAG,IAAAC,mCAAA,GAA5B;EACA,MAAMC,UAAU,GAAG,IAAAC,0BAAA,GAAnB;EACA,MAAMC,WAAW,GAAGF,UAAH,aAAGA,UAAH,uBAAGA,UAAU,CAAEG,UAAhC;EAEA,MAAMC,UAAU,GAAG,wBAACT,SAAS,CAACU,OAAX,+CAAC,mBAAmBC,YAApB,CAAnB;EAEA,IAAI,CAAAX,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEY,WAAX,MAA2B,SAA3B,IAAwC,CAAAZ,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEa,IAAX,MAAoB,qBAAhE,EACE,oBACE,+BAAC,qCAAD;IAAmB,KAAK,EAAE;MAAEC,MAAM,EAAE;IAAV,CAA1B;IAA8C,MAAM,EAAC,YAArD;IAAkE,KAAK,EAAC;EAAxE,+BADF;EAMF,IAAI,CAAAd,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEY,WAAX,MAA2B,QAA3B,IAAuC,CAAAZ,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEa,IAAX,MAAoB,qBAA/D,EACE,oBAAO,+BAAC,qCAAD;IAAmB,KAAK,EAAE;MAAEC,MAAM,EAAE;IAAV,CAA1B;IAA8C,MAAM,EAAC,SAArD;IAA+D,KAAK,EAAC;EAArE,EAAP;EAEF,oBACE;IAAK,SAAS,EAAEC,yBAAA,CAAOC;EAAvB,GACGT,WAAW,iBAAI,+BAAC,yBAAD;IAAgB,IAAI,EAAEA;EAAtB,EADlB,EAEGA,WAAW,iBAAI,+BAAC,qBAAD;IAAW,gBAAgB;EAA3B,EAFlB,EAGGE,UAAU,iBACT,+BAAC,gCAAD;IACE,SAAS,EAAEM,yBAAA,CAAOE,sBADpB;IAEE,WAAW,EAAEjB,SAAS,CAACkB,WAFzB;IAGE,OAAO,EAAElB,SAAS,CAACmB,OAHrB;IAIE,QAAQ,EAAEnB,SAAS,CAACoB,WAJtB;IAKE,MAAM,EAAEpB,SAAS,CAACqB,MALpB;IAME,WAAW,EAAErB,SAAS,CAACsB,WANzB;IAOE,WAAW,EAAE,IAAAC,iBAAA,EAAQxB,WAAW,CAACyB,MAAZ,EAAR,CAPf;IAQE,mBAAmB,EAAErB,mBARvB;IASE,SAAS,EAAEH;EATb,EAJJ,eAgBE,+BAAC,6BAAD;IACE,SAAS,EAAEA,SADb;IAEE,KAAK,EAAE;MAAEyB,KAAK,EAAE,MAAT;MAAiBC,MAAM,EAAE;IAAzB,CAFT;IAGE,WAAW,EAAC,UAHd;IAIE,iBAAiB,MAJnB;IAKE,SAAS,EAAC;EALZ,EAhBF,CADF;AA0BD"}

package/dist/overview.section.d.ts

@@ -1,16 +1,16 @@
 /// <reference types="react" />
 import { Section } from '@teambit/component';
-import { DocsUI } from './docs.ui.runtime';
+import { TitleBadgeSlot } from './overview';
 export declare class OverviewSection implements Section {
     /**
-     * docs ui extension.
+     * title badge slot.
      */
-    private docs;
+    private titleBadgeSlot;
     constructor(
     /**
-     * docs ui extension.
+     * title badge slot.
      */
-    docs: DocsUI);
+    titleBadgeSlot: TitleBadgeSlot);
     navigationLink: {
         href: string;
         exact: boolean;

package/dist/overview.section.js

@@ -40,10 +40,10 @@ function _overview() {
 class OverviewSection {
   constructor(
   /**
-   * docs ui extension.
+   * title badge slot.
    */
-  docs) {
-    this.docs = docs;
+  titleBadgeSlot) {
+    this.titleBadgeSlot = titleBadgeSlot;
     (0, _defineProperty2().default)(this, "navigationLink", {
       href: '.',
       exact: true,
@@ -52,7 +52,7 @@ class OverviewSection {
     (0, _defineProperty2().default)(this, "route", {
       index: true,
       element: /*#__PURE__*/_react().default.createElement(_overview().Overview, {
-        titleBadges: this.docs.titleBadgeSlot
+        titleBadges: this.titleBadgeSlot
       })
     });
     (0, _defineProperty2().default)(this, "order", 10);

package/dist/overview.section.js.map

@@ -1 +1 @@
-{"version":3,"names":["OverviewSection","constructor","docs","href","exact","children","index","element","titleBadgeSlot"],"sources":["overview.section.tsx"],"sourcesContent":["import { Section } from '@teambit/component';\nimport React from 'react';\n\nimport { DocsUI } from './docs.ui.runtime';\nimport { Overview } from './overview';\n\nexport class OverviewSection implements Section {\n  constructor(\n    /**\n     * docs ui extension.\n     */\n    private docs: DocsUI\n  ) {}\n\n  navigationLink = {\n    href: '.',\n    exact: true,\n    children: 'Overview',\n  };\n\n  route = {\n    index: true,\n    element: <Overview titleBadges={this.docs.titleBadgeSlot} />,\n  };\n\n  order = 10;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAGA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEO,MAAMA,eAAN,CAAyC;EAC9CC,WAAW;EACT;AACJ;AACA;EACYC,IAJC,EAKT;IAAA,KADQA,IACR,GADQA,IACR;IAAA,wDAEe;MACfC,IAAI,EAAE,GADS;MAEfC,KAAK,EAAE,IAFQ;MAGfC,QAAQ,EAAE;IAHK,CAFf;IAAA,+CAQM;MACNC,KAAK,EAAE,IADD;MAENC,OAAO,eAAE,+BAAC,oBAAD;QAAU,WAAW,EAAE,KAAKL,IAAL,CAAUM;MAAjC;IAFH,CARN;IAAA,+CAaM,EAbN;EAAE;;AAN0C"}
+{"version":3,"names":["OverviewSection","constructor","titleBadgeSlot","href","exact","children","index","element"],"sources":["overview.section.tsx"],"sourcesContent":["import React from 'react';\nimport { Section } from '@teambit/component';\nimport { Overview, TitleBadgeSlot } from './overview';\n\nexport class OverviewSection implements Section {\n  constructor(\n    /**\n     * title badge slot.\n     */\n    private titleBadgeSlot: TitleBadgeSlot\n  ) {}\n\n  navigationLink = {\n    href: '.',\n    exact: true,\n    children: 'Overview',\n  };\n\n  route = {\n    index: true,\n    element: <Overview titleBadges={this.titleBadgeSlot} />,\n  };\n\n  order = 10;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEO,MAAMA,eAAN,CAAyC;EAC9CC,WAAW;EACT;AACJ;AACA;EACYC,cAJC,EAKT;IAAA,KADQA,cACR,GADQA,cACR;IAAA,wDAEe;MACfC,IAAI,EAAE,GADS;MAEfC,KAAK,EAAE,IAFQ;MAGfC,QAAQ,EAAE;IAHK,CAFf;IAAA,+CAQM;MACNC,KAAK,EAAE,IADD;MAENC,OAAO,eAAE,+BAAC,oBAAD;QAAU,WAAW,EAAE,KAAKL;MAA5B;IAFH,CARN;IAAA,+CAaM,EAbN;EAAE;;AAN0C"}

package/docs.compare.section.tsx

@@ -1,7 +1,7 @@
 import React from 'react';
-import { TitleBadgeSlot } from '@teambit/docs';
 import { Section } from '@teambit/component';
 import { OverviewCompare } from '@teambit/docs.ui.overview-compare';
+import { TitleBadgeSlot } from './overview';
 
 export class OverviewCompareSection implements Section {
   constructor(private titleBadgeSlot: TitleBadgeSlot) {}

package/docs.ui.runtime.tsx

@@ -1,12 +1,12 @@
+import { flatten } from 'lodash';
 import { ComponentAspect, ComponentUI } from '@teambit/component';
 import { Slot } from '@teambit/harmony';
-import type { TitleBadge } from '@teambit/component.ui.component-meta';
 import { UIRuntime } from '@teambit/ui';
 import ComponentCompareAspect, { ComponentCompareUI } from '@teambit/component-compare';
 
 import { DocsAspect } from './docs.aspect';
 import { OverviewSection } from './overview.section';
-import { TitleBadgeSlot } from './overview';
+import type { TitleBadgeSlot, TitleBadge } from './overview';
 import { OverviewCompareSection } from './docs.compare.section';
 
 export class DocsUI {
@@ -15,8 +15,9 @@ export class DocsUI {
   /**
    * register a new title badge into the overview section of a component.
    */
-  registerTitleBadge(...titleBadge: TitleBadge[]) {
-    this.titleBadgeSlot.register(titleBadge);
+  registerTitleBadge(titleBadges: TitleBadge | TitleBadge[]) {
+    const badges = Array.isArray(titleBadges) ? titleBadges : [titleBadges];
+    this.titleBadgeSlot.register(badges);
     return this;
   }
 
@@ -24,7 +25,7 @@ export class DocsUI {
    * list all title badges registered.
    */
   listTitleBadges() {
-    return this.titleBadgeSlot;
+    return flatten(this.titleBadgeSlot.values());
   }
 
   static dependencies = [ComponentAspect, ComponentCompareAspect];
@@ -39,7 +40,7 @@ export class DocsUI {
     [titleBadgeSlot]: [TitleBadgeSlot]
   ) {
     const docs = new DocsUI(titleBadgeSlot);
-    const section = new OverviewSection(docs);
+    const section = new OverviewSection(titleBadgeSlot);
     const compareSection = new OverviewCompareSection(titleBadgeSlot);
 
     component.registerRoute(section.route);

package/overview/index.ts

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

package/overview/overview.tsx

@@ -1,14 +1,28 @@
-import React, { useContext } from 'react';
-import flatten from 'lodash.flatten';
+import React, { useContext, ComponentType } from 'react';
+import { flatten } from 'lodash';
 import { ComponentContext, useComponentDescriptor } from '@teambit/component';
 import type { SlotRegistry } from '@teambit/harmony';
 import { ComponentPreview } from '@teambit/preview.ui.component-preview';
 import { StatusMessageCard } from '@teambit/design.ui.surfaces.status-message-card';
-import { ComponentOverview, TitleBadge } from '@teambit/component.ui.component-meta';
+import { ComponentOverview } from '@teambit/component.ui.component-meta';
 import { LaneBreadcrumb, useLanesContext } from '@teambit/lanes.ui.lanes';
 import { Separator } from '@teambit/design.ui.separator';
 import styles from './overview.module.scss';
 
+export enum BadgePosition {
+  Title,
+  SubTitle,
+  Labels,
+  Package,
+  ElementsPackage,
+}
+
+export type TitleBadge = {
+  component: ComponentType<any>;
+  weight?: number;
+  position?: BadgePosition;
+};
+
 export type TitleBadgeSlot = SlotRegistry<TitleBadge[]>;
 
 export type OverviewProps = {

package/overview.section.tsx

@@ -1,15 +1,13 @@
-import { Section } from '@teambit/component';
 import React from 'react';
-
-import { DocsUI } from './docs.ui.runtime';
-import { Overview } from './overview';
+import { Section } from '@teambit/component';
+import { Overview, TitleBadgeSlot } from './overview';
 
 export class OverviewSection implements Section {
   constructor(
     /**
-     * docs ui extension.
+     * title badge slot.
      */
-    private docs: DocsUI
+    private titleBadgeSlot: TitleBadgeSlot
   ) {}
 
   navigationLink = {
@@ -20,7 +18,7 @@ export class OverviewSection implements Section {
 
   route = {
     index: true,
-    element: <Overview titleBadges={this.docs.titleBadgeSlot} />,
+    element: <Overview titleBadges={this.titleBadgeSlot} />,
   };
 
   order = 10;

package/package.json

@@ -1,45 +1,45 @@
 {
   "name": "@teambit/docs",
-  "version": "0.0.802",
+  "version": "0.0.805",
   "homepage": "https://bit.dev/teambit/docs/docs",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.docs",
     "name": "docs",
-    "version": "0.0.802"
+    "version": "0.0.805"
   },
   "dependencies": {
     "graphql-tag": "2.12.1",
-    "lodash.flatten": "4.4.0",
+    "lodash": "4.17.21",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
     "@teambit/harmony": "0.3.3",
     "@teambit/design.ui.separator": "0.0.354",
-    "@teambit/compiler": "0.0.802",
-    "@teambit/component": "0.0.802",
+    "@teambit/compiler": "0.0.805",
+    "@teambit/component": "0.0.805",
     "@teambit/docs.entities.doc": "0.0.4",
-    "@teambit/pkg": "0.0.802",
-    "@teambit/workspace": "0.0.802",
-    "@teambit/docs.ui.overview-compare": "0.0.42",
-    "@teambit/cli": "0.0.534",
-    "@teambit/dev-files": "0.0.802",
-    "@teambit/envs": "0.0.802",
-    "@teambit/graphql": "0.0.802",
-    "@teambit/logger": "0.0.627",
-    "@teambit/preview": "0.0.802",
+    "@teambit/pkg": "0.0.805",
+    "@teambit/workspace": "0.0.805",
+    "@teambit/docs.ui.overview-compare": "0.0.44",
+    "@teambit/cli": "0.0.536",
+    "@teambit/dev-files": "0.0.805",
+    "@teambit/envs": "0.0.805",
+    "@teambit/graphql": "0.0.805",
+    "@teambit/logger": "0.0.629",
+    "@teambit/preview": "0.0.805",
     "@teambit/component-id": "0.0.405",
-    "@teambit/component-compare": "0.0.50",
-    "@teambit/component.ui.component-meta": "0.0.95",
-    "@teambit/ui": "0.0.802",
-    "@teambit/pubsub": "0.0.802",
+    "@teambit/component-compare": "0.0.53",
+    "@teambit/ui": "0.0.805",
+    "@teambit/pubsub": "0.0.805",
+    "@teambit/component.ui.component-meta": "0.0.97",
     "@teambit/design.ui.surfaces.status-message-card": "0.0.8",
-    "@teambit/lanes.ui.lanes": "0.0.103",
+    "@teambit/lanes.ui.lanes": "0.0.105",
     "@teambit/preview.ui.component-preview": "0.0.494"
   },
   "devDependencies": {
     "@types/react-dom": "^17.0.5",
     "@types/react": "^17.0.8",
-    "@types/lodash.flatten": "4.4.6",
+    "@types/lodash": "4.14.165",
     "@types/mocha": "9.1.0",
     "@types/testing-library__jest-dom": "5.9.5",
     "@types/jest": "^26.0.0",
@@ -47,7 +47,7 @@
     "@teambit/docs.content.docs-overview": "1.95.9"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.316",
+    "@teambit/legacy": "1.0.319",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },

package/{preview-1659151732866.js → preview-1659456045857.js}

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