@teambit/docs 1.0.331 → 1.0.333

package/artifacts/schema.json

@@ -6667,7 +6667,7 @@
   "componentId": {
     "scope": "teambit.docs",
     "name": "docs",
-    "version": "1.0.331"
+    "version": "1.0.333"
   },
   "taggedModuleExports": []
 }

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

@@ -8,7 +8,7 @@ import type { Environment } from '@teambit/envs';
 import { GraphqlMain } from '@teambit/graphql';
 import { PreviewMain } from '@teambit/preview';
 import { DevFilesMain } from '@teambit/dev-files';
-import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
+import { AbstractVinyl } from '@teambit/component.sources';
 import { Workspace } from '@teambit/workspace';
 import { Doc } from '@teambit/docs.entities.doc';
 import { EnvsMain } from '@teambit/envs';

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/dist/consumer/component/component-loader';\nimport { AbstractVinyl } from '@teambit/legacy/dist/consumer/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,IAAAgB,mBAAU,EAACT,IAAI,CAAC,CAAC;IAElChF,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 { 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/dist/consumer/component/component-loader';\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,IAAAgB,mBAAU,EAACT,IAAI,CAAC,CAAC;IAElChF,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,7 +1,7 @@
 import { Component, ComponentMap } from '@teambit/component';
 import type { Environment, ExecutionContext } from '@teambit/envs';
 import { PreviewDefinition } from '@teambit/preview';
-import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
+import { AbstractVinyl } from '@teambit/component.sources';
 import { DocsMain } from './docs.main.runtime';
 export declare class DocsPreviewDefinition implements PreviewDefinition {
     /**

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/legacy/dist/consumer/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 { 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":[]}

package/dist/{preview-1720667996237.js → preview-1720754434554.js}

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

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/docs",
-  "version": "1.0.331",
+  "version": "1.0.333",
   "homepage": "https://bit.cloud/teambit/docs/docs",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.docs",
     "name": "docs",
-    "version": "1.0.331"
+    "version": "1.0.333"
   },
   "dependencies": {
     "graphql-tag": "2.12.1",
@@ -19,21 +19,22 @@
     "@teambit/base-react.themes.theme-switcher": "1.0.2",
     "@teambit/component.ui.component-meta": "0.0.358",
     "@teambit/base-ui.loaders.skeleton": "1.0.1",
-    "@teambit/compiler": "1.0.331",
-    "@teambit/component": "1.0.331",
-    "@teambit/pkg": "1.0.331",
-    "@teambit/workspace": "1.0.331",
-    "@teambit/cli": "0.0.908",
-    "@teambit/dev-files": "1.0.331",
-    "@teambit/envs": "1.0.331",
-    "@teambit/graphql": "1.0.331",
-    "@teambit/logger": "0.0.1001",
-    "@teambit/preview": "1.0.331",
-    "@teambit/scope": "1.0.331",
-    "@teambit/api-reference": "1.0.331",
-    "@teambit/component-compare": "1.0.331",
-    "@teambit/ui": "1.0.331",
-    "@teambit/pubsub": "1.0.331",
+    "@teambit/compiler": "1.0.333",
+    "@teambit/component": "1.0.333",
+    "@teambit/pkg": "1.0.333",
+    "@teambit/workspace": "1.0.333",
+    "@teambit/cli": "0.0.910",
+    "@teambit/component.sources": "0.0.2",
+    "@teambit/dev-files": "1.0.333",
+    "@teambit/envs": "1.0.333",
+    "@teambit/graphql": "1.0.333",
+    "@teambit/logger": "0.0.1003",
+    "@teambit/preview": "1.0.333",
+    "@teambit/scope": "1.0.333",
+    "@teambit/api-reference": "1.0.333",
+    "@teambit/component-compare": "1.0.333",
+    "@teambit/ui": "1.0.333",
+    "@teambit/pubsub": "1.0.333",
     "@teambit/compositions.panels.composition-gallery": "0.0.211",
     "@teambit/preview.ui.component-preview": "1.0.12"
   },