@teambit/docs 0.0.661 → 0.0.662

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

@@ -3,8 +3,8 @@ import type { PkgMain } from '@teambit/pkg';
 import type { Component } from '@teambit/component';
 import type { CompilerMain } from '@teambit/compiler';
 import type { Workspace } from '@teambit/workspace';
+import { Doc } from '@teambit/docs.entities.doc';
 import { DocReader } from './doc-reader';
-import { Doc } from './doc';
 export declare class DefaultDocReader implements DocReader {
     private pkg;
     private compiler;

package/dist/default-doc-reader.js

@@ -31,10 +31,10 @@ function _path() {
   return data;
 }
 
-function _doc() {
-  const data = require("./doc");
+function _docsEntities() {
+  const data = require("@teambit/docs.entities.doc");
 
-  _doc = function () {
+  _docsEntities = function () {
     return data;
   };
 
@@ -57,7 +57,7 @@ class DefaultDocReader {
 
     const docsModule = require((0, _path().resolve)(`${this.workspace.path}/node_modules/${packageName}/${distPath}`));
 
-    return _doc().Doc.from(path, {
+    return _docsEntities().Doc.from(path, {
       labels: docsModule.labels || ((_docsModule$default = docsModule.default) === null || _docsModule$default === void 0 ? void 0 : _docsModule$default.labels),
       description: docsModule.abstract || ((_docsModule$default2 = docsModule.default) === null || _docsModule$default2 === void 0 ? void 0 : _docsModule$default2.abstract) || docsModule.description,
       displayName: docsModule.displayName || ((_docsModule$default3 = docsModule.default) === null || _docsModule$default3 === void 0 ? void 0 : _docsModule$default3.componentDisplayName)

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

@@ -1 +1 @@
-{"version":3,"sources":["default-doc-reader.ts"],"names":["DefaultDocReader","constructor","pkg","compiler","workspace","read","path","contents","component","packageName","getPackageName","distPath","getDistPathBySrcPath","docsModule","require","Doc","from","labels","default","description","abstract","displayName","componentDisplayName","isFormatSupported","format","supportedExtensions","includes"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAMA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAEO,MAAMA,gBAAN,CAA4C;AACjDC,EAAAA,WAAW,CAASC,GAAT,EAA+BC,QAA/B,EAA+DC,SAA/D,EAAqF;AAAA,SAA5EF,GAA4E,GAA5EA,GAA4E;AAAA,SAAtDC,QAAsD,GAAtDA,QAAsD;AAAA,SAAtBC,SAAsB,GAAtBA,SAAsB;AAAA,iEAcjE,CAAC,KAAD,EAAQ,KAAR,EAAe,MAAf,EAAuB,MAAvB,CAdiE;AAAE;;AAExF,QAAJC,IAAI,CAACC,IAAD,EAAeC,QAAf,EAAiCC,SAAjC,EAAuD;AAAA;;AAC/D,UAAMC,WAAW,GAAG,KAAKP,GAAL,CAASQ,cAAT,CAAwBF,SAAxB,CAApB;AACA,UAAMG,QAAQ,GAAG,KAAKR,QAAL,CAAcS,oBAAd,CAAmCJ,SAAnC,EAA8CF,IAA9C,CAAjB,CAF+D,CAG/D;;AACA,UAAMO,UAAU,GAAGC,OAAO,CAAC,qBAAS,GAAE,KAAKV,SAAL,CAAeE,IAAK,iBAAgBG,WAAY,IAAGE,QAAS,EAAvE,CAAD,CAA1B;;AACA,WAAOI,WAAIC,IAAJ,CAASV,IAAT,EAAe;AACpBW,MAAAA,MAAM,EAAEJ,UAAU,CAACI,MAAX,4BAAqBJ,UAAU,CAACK,OAAhC,wDAAqB,oBAAoBD,MAAzC,CADY;AAEpBE,MAAAA,WAAW,EAAEN,UAAU,CAACO,QAAX,6BAAuBP,UAAU,CAACK,OAAlC,yDAAuB,qBAAoBE,QAA3C,KAAuDP,UAAU,CAACM,WAF3D;AAGpBE,MAAAA,WAAW,EAAER,UAAU,CAACQ,WAAX,6BAA0BR,UAAU,CAACK,OAArC,yDAA0B,qBAAoBI,oBAA9C;AAHO,KAAf,CAAP;AAKD;;AAIDC,EAAAA,iBAAiB,CAACC,MAAD,EAAiB;AAChC,WAAO,KAAKC,mBAAL,CAAyBC,QAAzB,CAAkCF,MAAlC,CAAP;AACD;;AAnBgD","sourcesContent":["import { resolve } from 'path';\nimport type { PkgMain } from '@teambit/pkg';\nimport type { Component } from '@teambit/component';\nimport type { CompilerMain } from '@teambit/compiler';\nimport type { Workspace } from '@teambit/workspace';\nimport { DocReader } from './doc-reader';\nimport { Doc } from './doc';\n\nexport class DefaultDocReader implements DocReader {\n  constructor(private pkg: PkgMain, private compiler: CompilerMain, private workspace: Workspace) {}\n\n  async read(path: string, contents: Buffer, component: Component) {\n    const packageName = this.pkg.getPackageName(component);\n    const distPath = this.compiler.getDistPathBySrcPath(component, path);\n    // eslint-disable-next-line\n    const docsModule = require(resolve(`${this.workspace.path}/node_modules/${packageName}/${distPath}`));\n    return Doc.from(path, {\n      labels: docsModule.labels || docsModule.default?.labels,\n      description: docsModule.abstract || docsModule.default?.abstract || docsModule.description,\n      displayName: docsModule.displayName || docsModule.default?.componentDisplayName,\n    });\n  }\n\n  readonly supportedExtensions = ['.ts', '.js', '.jsx', '.tsx'];\n\n  isFormatSupported(format: string) {\n    return this.supportedExtensions.includes(format);\n  }\n}\n"]}
+{"version":3,"sources":["default-doc-reader.ts"],"names":["DefaultDocReader","constructor","pkg","compiler","workspace","read","path","contents","component","packageName","getPackageName","distPath","getDistPathBySrcPath","docsModule","require","Doc","from","labels","default","description","abstract","displayName","componentDisplayName","isFormatSupported","format","supportedExtensions","includes"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAKA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAGO,MAAMA,gBAAN,CAA4C;AACjDC,EAAAA,WAAW,CAASC,GAAT,EAA+BC,QAA/B,EAA+DC,SAA/D,EAAqF;AAAA,SAA5EF,GAA4E,GAA5EA,GAA4E;AAAA,SAAtDC,QAAsD,GAAtDA,QAAsD;AAAA,SAAtBC,SAAsB,GAAtBA,SAAsB;AAAA,iEAcjE,CAAC,KAAD,EAAQ,KAAR,EAAe,MAAf,EAAuB,MAAvB,CAdiE;AAAE;;AAExF,QAAJC,IAAI,CAACC,IAAD,EAAeC,QAAf,EAAiCC,SAAjC,EAAuD;AAAA;;AAC/D,UAAMC,WAAW,GAAG,KAAKP,GAAL,CAASQ,cAAT,CAAwBF,SAAxB,CAApB;AACA,UAAMG,QAAQ,GAAG,KAAKR,QAAL,CAAcS,oBAAd,CAAmCJ,SAAnC,EAA8CF,IAA9C,CAAjB,CAF+D,CAG/D;;AACA,UAAMO,UAAU,GAAGC,OAAO,CAAC,qBAAS,GAAE,KAAKV,SAAL,CAAeE,IAAK,iBAAgBG,WAAY,IAAGE,QAAS,EAAvE,CAAD,CAA1B;;AACA,WAAOI,oBAAIC,IAAJ,CAASV,IAAT,EAAe;AACpBW,MAAAA,MAAM,EAAEJ,UAAU,CAACI,MAAX,4BAAqBJ,UAAU,CAACK,OAAhC,wDAAqB,oBAAoBD,MAAzC,CADY;AAEpBE,MAAAA,WAAW,EAAEN,UAAU,CAACO,QAAX,6BAAuBP,UAAU,CAACK,OAAlC,yDAAuB,qBAAoBE,QAA3C,KAAuDP,UAAU,CAACM,WAF3D;AAGpBE,MAAAA,WAAW,EAAER,UAAU,CAACQ,WAAX,6BAA0BR,UAAU,CAACK,OAArC,yDAA0B,qBAAoBI,oBAA9C;AAHO,KAAf,CAAP;AAKD;;AAIDC,EAAAA,iBAAiB,CAACC,MAAD,EAAiB;AAChC,WAAO,KAAKC,mBAAL,CAAyBC,QAAzB,CAAkCF,MAAlC,CAAP;AACD;;AAnBgD","sourcesContent":["import { resolve } from 'path';\nimport type { PkgMain } from '@teambit/pkg';\nimport type { Component } from '@teambit/component';\nimport type { CompilerMain } from '@teambit/compiler';\nimport type { Workspace } from '@teambit/workspace';\nimport { Doc } from '@teambit/docs.entities.doc';\nimport { DocReader } from './doc-reader';\n\nexport class DefaultDocReader implements DocReader {\n  constructor(private pkg: PkgMain, private compiler: CompilerMain, private workspace: Workspace) {}\n\n  async read(path: string, contents: Buffer, component: Component) {\n    const packageName = this.pkg.getPackageName(component);\n    const distPath = this.compiler.getDistPathBySrcPath(component, path);\n    // eslint-disable-next-line\n    const docsModule = require(resolve(`${this.workspace.path}/node_modules/${packageName}/${distPath}`));\n    return Doc.from(path, {\n      labels: docsModule.labels || docsModule.default?.labels,\n      description: docsModule.abstract || docsModule.default?.abstract || docsModule.description,\n      displayName: docsModule.displayName || docsModule.default?.componentDisplayName,\n    });\n  }\n\n  readonly supportedExtensions = ['.ts', '.js', '.jsx', '.tsx'];\n\n  isFormatSupported(format: string) {\n    return this.supportedExtensions.includes(format);\n  }\n}\n"]}

package/dist/doc-reader.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import type { Component } from '@teambit/component';
-import { Doc } from './doc';
+import { Doc } from '@teambit/docs.entities.doc';
 export interface DocReader {
     /**
      * read a component doc.

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

@@ -9,8 +9,8 @@ import { PreviewMain } from '@teambit/preview';
 import { DevFilesMain } from '@teambit/dev-files';
 import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
 import { Workspace } from '@teambit/workspace';
+import { Doc } from '@teambit/docs.entities.doc';
 import { DocReader } from './doc-reader';
-import { Doc } from './doc';
 export declare type ComponentDocs = {
     files: string[];
     component: Component;

package/dist/docs.main.runtime.js

@@ -123,6 +123,16 @@ function _workspace() {
   return data;
 }
 
+function _docsEntities() {
+  const data = require("@teambit/docs.entities.doc");
+
+  _docsEntities = function () {
+    return data;
+  };
+
+  return data;
+}
+
 function _docs() {
   const data = require("./docs.aspect");
 
@@ -173,16 +183,6 @@ function _exceptions() {
   return data;
 }
 
-function _doc() {
-  const data = require("./doc");
-
-  _doc = function () {
-    return data;
-  };
-
-  return data;
-}
-
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
 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; }
@@ -276,7 +276,7 @@ class DocsMain {
 
     const docData = (_component$state$aspe = component.state.aspects.get(_docs().DocsAspect.id)) === null || _component$state$aspe === void 0 ? void 0 : (_component$state$aspe2 = _component$state$aspe.data) === null || _component$state$aspe2 === void 0 ? void 0 : _component$state$aspe2.doc;
     if (!docData) return null;
-    return new (_doc().Doc)(docData.filePath, new (_doc().DocPropList)(docData.props));
+    return new (_docsEntities().Doc)(docData.filePath, new (_docsEntities().DocPropList)(docData.props));
   }
 
   getPatterns() {

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

@@ -1 +1 @@
-{"version":3,"sources":["docs.main.runtime.ts"],"names":["DocsMain","constructor","patterns","preview","pkg","compiler","workspace","logger","devFiles","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","error","docData","aspects","data","Doc","filePath","DocPropList","props","getPatterns","registerDocReader","register","provider","graphql","loggerAspect","config","createLogger","DefaultDocReader","registerDevPattern","onComponentLoad","toObject","registerDefinition","DocsPreviewDefinition","Slot","withType","MainRuntime","PreviewAspect","GraphqlAspect","WorkspaceAspect","PkgAspect","CompilerAspect","LoggerAspect","DevFilesAspect","ComponentAspect","addRuntime"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAEA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAGA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAEA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;;;;;AAoBA;AACA;AACA;AACO,MAAMA,QAAN,CAAe;AACpBC,EAAAA,WAAW,CACDC,QADC;AAET;AACJ;AACA;AACYC,EAAAA,OALC,EAODC,GAPC,EASDC,QATC,EAWDC,SAXC,EAaDC,MAbC,EAeDC,QAfC,EAiBDC,WAjBC,EAmBDC,aAnBC,EAoBT;AAAA,SAnBQR,QAmBR,GAnBQA,QAmBR;AAAA,SAfQC,OAeR,GAfQA,OAeR;AAAA,SAbQC,GAaR,GAbQA,GAaR;AAAA,SAXQC,QAWR,GAXQA,QAWR;AAAA,SATQC,SASR,GATQA,SASR;AAAA,SAPQC,MAOR,GAPQA,MAOR;AAAA,SALQC,QAKR,GALQA,QAKR;AAAA,SAHQC,WAGR,GAHQA,WAGR;AAAA,SADQC,aACR,GADQA,aACR;AAAE;AAEJ;AACF;AACA;;;AACEC,EAAAA,UAAU,CAACC,UAAD,EAAyD;AACjE,WAAOC,0BAAaC,EAAb,CAAiCF,UAAjC,EAA8CG,SAAD,IAAe;AACjE,aAAO,KAAKC,YAAL,CAAkBD,SAAlB,CAAP;AACD,KAFM,CAAP;AAGD;;AAEDC,EAAAA,YAAY,CAACD,SAAD,EAAwC;AAClD,UAAMP,QAAQ,GAAG,KAAKA,QAAL,CAAcS,eAAd,CAA8BF,SAA9B,CAAjB;AACA,UAAMG,QAAQ,GAAGV,QAAQ,CAACW,GAAT,CAAaC,mBAAWC,EAAxB,CAAjB;AACA,WAAON,SAAS,CAACO,KAAV,CAAgBC,UAAhB,CAA2BC,KAA3B,CAAiCC,MAAjC,CAAyCC,IAAD,IAAUR,QAAQ,CAACS,QAAT,CAAkBD,IAAI,CAACE,QAAvB,CAAlD,CAAP;AACD;AAED;AACF;AACA;;;AACsB,QAAdC,cAAc,CAACd,SAAD,EAAwC;AAAA;;AAC1D,UAAMe,YAAY,GAAG,KAAKC,MAAL,CAAYhB,SAAZ,CAArB;AACA,UAAMiB,IAAI,GAAGF,YAAH,aAAGA,YAAH,uBAAGA,YAAY,CAAEG,WAA3B;AACA,QAAID,IAAJ,EAAU,OAAOA,IAAP;AACV,UAAME,iBAAoC,GAAGnB,SAAS,CAACO,KAAV,CAAgBa,SAA7D;AACA,UAAMC,UAAU,4BAAGF,iBAAiB,CAACG,IAArB,0DAAG,sBAAwBC,IAAxB,CAA8BC,GAAD,IAASA,GAAG,CAACN,WAA1C,CAAnB;AAEA,WAAO,CAAAG,UAAU,SAAV,IAAAA,UAAU,WAAV,YAAAA,UAAU,CAAEH,WAAZ,KAA2B,EAAlC;AACD;;AAEgB,QAAXO,WAAW,CAACC,GAAD,EAAmB;AAClC,WAAOA,GAAG,CAACC,eAAJ,EAAP;AACD;;AAEDC,EAAAA,YAAY,CAACC,SAAD,EAAoB;AAC9B,WAAO,KAAKlC,aAAL,CAAmBmC,MAAnB,GAA4BP,IAA5B,CAAkCQ,SAAD,IAAeA,SAAS,CAACC,iBAAV,CAA4BH,SAA5B,CAAhD,CAAP;AACD;AAED;AACF;AACA;;;AACkB,QAAVI,UAAU,CAACjC,SAAD,EAAuB;AACrC,UAAMG,QAAQ,GAAG,KAAKF,YAAL,CAAkBD,SAAlB,CAAjB;;AACA,QAAIG,QAAQ,CAAC+B,MAAb,EAAqB;AACnB;AACA,YAAMC,OAAO,GAAGhC,QAAQ,CAAC,CAAD,CAAxB;;AAEA,UAAI;AACF,cAAM4B,SAAS,GAAG,KAAKH,YAAL,CAAkBO,OAAO,CAACC,OAA1B,CAAlB;AACA,YAAI,CAACL,SAAL,EAAgB,MAAM,KAAIM,uCAAJ,EAA8BF,OAAO,CAACtB,QAAtC,EAAgDsB,OAAO,CAACC,OAAxD,CAAN;AAChB,cAAMZ,GAAG,GAAG,MAAMO,SAAS,CAACO,IAAV,CAAeH,OAAO,CAACtB,QAAvB,EAAiCsB,OAAO,CAACI,QAAzC,EAAmDvC,SAAnD,CAAlB;AACA,eAAOwB,GAAP;AACD,OALD,CAKE,OAAOgB,GAAP,EAAiB;AACjB,aAAKhD,MAAL,CAAYiD,KAAZ,CAAkB,8CAAlB,EAAkED,GAAlE;AACA,eAAO,IAAP;AACD;AACF;;AAED,WAAO,IAAP;AACD;;AAEDxB,EAAAA,MAAM,CAAChB,SAAD,EAAuB;AAAA;;AAC3B,UAAM0C,OAAO,4BAAG1C,SAAS,CAACO,KAAV,CAAgBoC,OAAhB,CAAwBvC,GAAxB,CAA4BC,mBAAWC,EAAvC,CAAH,oFAAG,sBAA4CsC,IAA/C,2DAAG,uBAAkDpB,GAAlE;AACA,QAAI,CAACkB,OAAL,EAAc,OAAO,IAAP;AACd,WAAO,KAAIG,UAAJ,EAAQH,OAAO,CAACI,QAAhB,EAA0B,KAAIC,kBAAJ,EAAgBL,OAAO,CAACM,KAAxB,CAA1B,CAAP;AACD;;AAEDC,EAAAA,WAAW,GAAG;AACZ,WAAO,KAAK9D,QAAZ;AACD;AAED;AACF;AACA;AACA;;;AACE+D,EAAAA,iBAAiB,CAACnB,SAAD,EAAuB;AACtC,SAAKpC,aAAL,CAAmBwD,QAAnB,CAA4BpB,SAA5B;AACA,WAAO,IAAP;AACD;;AAoBoB,eAARqB,QAAQ,CACnB,CAAChE,OAAD,EAAUiE,OAAV,EAAmB9D,SAAnB,EAA8BF,GAA9B,EAAmCC,QAAnC,EAA6CgE,YAA7C,EAA2D7D,QAA3D,CADmB,EAUnB8D,MAVmB,EAWnB,CAAC7D,WAAD,EAAcC,aAAd,CAXmB,EAYnB;AACA,UAAMH,MAAM,GAAG8D,YAAY,CAACE,YAAb,CAA0BnD,mBAAWC,EAArC,CAAf;AACA,UAAMgB,IAAI,GAAG,IAAIrC,QAAJ,CACXsE,MAAM,CAACpE,QADI,EAGXC,OAHW,EAKXC,GALW,EAOXC,QAPW,EASXC,SATW,EAWXC,MAXW,EAaXC,QAbW,EAeXC,WAfW,EAiBXC,aAjBW,CAAb;AAmBA2B,IAAAA,IAAI,CAAC4B,iBAAL,CAAuB,KAAIO,oCAAJ,EAAqBpE,GAArB,EAA0BC,QAA1B,EAAoCC,SAApC,CAAvB;AACAE,IAAAA,QAAQ,CAACiE,kBAAT,CAA4BH,MAAM,CAACpE,QAAnC;;AAEA,QAAII,SAAJ,EAAe;AACbA,MAAAA,SAAS,CAACoE,eAAV,CAA0B,MAAO3D,SAAP,IAAqB;AAC7C,cAAMwB,GAAG,GAAG,MAAMF,IAAI,CAACW,UAAL,CAAgBjC,SAAhB,CAAlB;AAEA,eAAO;AACLwB,UAAAA,GAAG,EAAEA,GAAF,aAAEA,GAAF,uBAAEA,GAAG,CAAEoC,QAAL;AADA,SAAP;AAGD,OAND;AAOD;;AAEDP,IAAAA,OAAO,CAACF,QAAR,CAAiB,yBAAW7B,IAAX,CAAjB;AAEAlC,IAAAA,OAAO,CAACyE,kBAAR,CAA2B,KAAIC,8BAAJ,EAA0BxC,IAA1B,CAA3B;AACA,WAAOA,IAAP;AACD;;AAzKmB;;;gCAATrC,Q,WAqGI,CAAC8E,gBAAKC,QAAL,EAAD,EAA2BD,gBAAKC,QAAL,EAA3B,C;gCArGJ/E,Q,aAuGMgF,kB;gCAvGNhF,Q,kBAwGW,CACpBiF,wBADoB,EAEpBC,wBAFoB,EAGpBC,4BAHoB,EAIpBC,gBAJoB,EAKpBC,0BALoB,EAMpBC,sBANoB,EAOpBC,mBAPoB,EAQpBC,oBARoB,C;gCAxGXxF,Q,mBAmHY;AACrBE,EAAAA,QAAQ,EAAE,CAAC,aAAD;AADW,C;;AAyDzBkB,mBAAWqE,UAAX,CAAsBzF,QAAtB","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 ComponentAspect, { Component, ComponentMap } 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 { 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';\nimport { Doc, DocPropList } from './doc';\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 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        this.logger.error('docs.main.runtime.computeDoc caught an error', err);\n        return null;\n      }\n    }\n\n    return null;\n  }\n\n  getDoc(component: Component) {\n    const docData = component.state.aspects.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  /**\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    ComponentAspect,\n  ];\n\n  static defaultConfig = {\n    patterns: ['**/*.docs.*'],\n  };\n\n  static async provider(\n    [preview, graphql, workspace, pkg, compiler, loggerAspect, devFiles]: [\n      PreviewMain,\n      GraphqlMain,\n      Workspace,\n      PkgMain,\n      CompilerMain,\n      LoggerMain,\n      DevFilesMain\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      docPropSlot,\n\n      docReaderSlot\n    );\n    docs.registerDocReader(new DefaultDocReader(pkg, compiler, workspace));\n    devFiles.registerDevPattern(config.patterns);\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"]}
+{"version":3,"sources":["docs.main.runtime.ts"],"names":["DocsMain","constructor","patterns","preview","pkg","compiler","workspace","logger","devFiles","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","error","docData","aspects","data","Doc","filePath","DocPropList","props","getPatterns","registerDocReader","register","provider","graphql","loggerAspect","config","createLogger","DefaultDocReader","registerDevPattern","onComponentLoad","toObject","registerDefinition","DocsPreviewDefinition","Slot","withType","MainRuntime","PreviewAspect","GraphqlAspect","WorkspaceAspect","PkgAspect","CompilerAspect","LoggerAspect","DevFilesAspect","ComponentAspect","addRuntime"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAEA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAGA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAEA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;;;;;AAoBA;AACA;AACA;AACO,MAAMA,QAAN,CAAe;AACpBC,EAAAA,WAAW,CACDC,QADC;AAET;AACJ;AACA;AACYC,EAAAA,OALC,EAODC,GAPC,EASDC,QATC,EAWDC,SAXC,EAaDC,MAbC,EAeDC,QAfC,EAiBDC,WAjBC,EAmBDC,aAnBC,EAoBT;AAAA,SAnBQR,QAmBR,GAnBQA,QAmBR;AAAA,SAfQC,OAeR,GAfQA,OAeR;AAAA,SAbQC,GAaR,GAbQA,GAaR;AAAA,SAXQC,QAWR,GAXQA,QAWR;AAAA,SATQC,SASR,GATQA,SASR;AAAA,SAPQC,MAOR,GAPQA,MAOR;AAAA,SALQC,QAKR,GALQA,QAKR;AAAA,SAHQC,WAGR,GAHQA,WAGR;AAAA,SADQC,aACR,GADQA,aACR;AAAE;AAEJ;AACF;AACA;;;AACEC,EAAAA,UAAU,CAACC,UAAD,EAAyD;AACjE,WAAOC,0BAAaC,EAAb,CAAiCF,UAAjC,EAA8CG,SAAD,IAAe;AACjE,aAAO,KAAKC,YAAL,CAAkBD,SAAlB,CAAP;AACD,KAFM,CAAP;AAGD;;AAEDC,EAAAA,YAAY,CAACD,SAAD,EAAwC;AAClD,UAAMP,QAAQ,GAAG,KAAKA,QAAL,CAAcS,eAAd,CAA8BF,SAA9B,CAAjB;AACA,UAAMG,QAAQ,GAAGV,QAAQ,CAACW,GAAT,CAAaC,mBAAWC,EAAxB,CAAjB;AACA,WAAON,SAAS,CAACO,KAAV,CAAgBC,UAAhB,CAA2BC,KAA3B,CAAiCC,MAAjC,CAAyCC,IAAD,IAAUR,QAAQ,CAACS,QAAT,CAAkBD,IAAI,CAACE,QAAvB,CAAlD,CAAP;AACD;AAED;AACF;AACA;;;AACsB,QAAdC,cAAc,CAACd,SAAD,EAAwC;AAAA;;AAC1D,UAAMe,YAAY,GAAG,KAAKC,MAAL,CAAYhB,SAAZ,CAArB;AACA,UAAMiB,IAAI,GAAGF,YAAH,aAAGA,YAAH,uBAAGA,YAAY,CAAEG,WAA3B;AACA,QAAID,IAAJ,EAAU,OAAOA,IAAP;AACV,UAAME,iBAAoC,GAAGnB,SAAS,CAACO,KAAV,CAAgBa,SAA7D;AACA,UAAMC,UAAU,4BAAGF,iBAAiB,CAACG,IAArB,0DAAG,sBAAwBC,IAAxB,CAA8BC,GAAD,IAASA,GAAG,CAACN,WAA1C,CAAnB;AAEA,WAAO,CAAAG,UAAU,SAAV,IAAAA,UAAU,WAAV,YAAAA,UAAU,CAAEH,WAAZ,KAA2B,EAAlC;AACD;;AAEgB,QAAXO,WAAW,CAACC,GAAD,EAAmB;AAClC,WAAOA,GAAG,CAACC,eAAJ,EAAP;AACD;;AAEDC,EAAAA,YAAY,CAACC,SAAD,EAAoB;AAC9B,WAAO,KAAKlC,aAAL,CAAmBmC,MAAnB,GAA4BP,IAA5B,CAAkCQ,SAAD,IAAeA,SAAS,CAACC,iBAAV,CAA4BH,SAA5B,CAAhD,CAAP;AACD;AAED;AACF;AACA;;;AACkB,QAAVI,UAAU,CAACjC,SAAD,EAAuB;AACrC,UAAMG,QAAQ,GAAG,KAAKF,YAAL,CAAkBD,SAAlB,CAAjB;;AACA,QAAIG,QAAQ,CAAC+B,MAAb,EAAqB;AACnB;AACA,YAAMC,OAAO,GAAGhC,QAAQ,CAAC,CAAD,CAAxB;;AAEA,UAAI;AACF,cAAM4B,SAAS,GAAG,KAAKH,YAAL,CAAkBO,OAAO,CAACC,OAA1B,CAAlB;AACA,YAAI,CAACL,SAAL,EAAgB,MAAM,KAAIM,uCAAJ,EAA8BF,OAAO,CAACtB,QAAtC,EAAgDsB,OAAO,CAACC,OAAxD,CAAN;AAChB,cAAMZ,GAAG,GAAG,MAAMO,SAAS,CAACO,IAAV,CAAeH,OAAO,CAACtB,QAAvB,EAAiCsB,OAAO,CAACI,QAAzC,EAAmDvC,SAAnD,CAAlB;AACA,eAAOwB,GAAP;AACD,OALD,CAKE,OAAOgB,GAAP,EAAiB;AACjB,aAAKhD,MAAL,CAAYiD,KAAZ,CAAkB,8CAAlB,EAAkED,GAAlE;AACA,eAAO,IAAP;AACD;AACF;;AAED,WAAO,IAAP;AACD;;AAEDxB,EAAAA,MAAM,CAAChB,SAAD,EAAuB;AAAA;;AAC3B,UAAM0C,OAAO,4BAAG1C,SAAS,CAACO,KAAV,CAAgBoC,OAAhB,CAAwBvC,GAAxB,CAA4BC,mBAAWC,EAAvC,CAAH,oFAAG,sBAA4CsC,IAA/C,2DAAG,uBAAkDpB,GAAlE;AACA,QAAI,CAACkB,OAAL,EAAc,OAAO,IAAP;AACd,WAAO,KAAIG,mBAAJ,EAAQH,OAAO,CAACI,QAAhB,EAA0B,KAAIC,2BAAJ,EAAgBL,OAAO,CAACM,KAAxB,CAA1B,CAAP;AACD;;AAEDC,EAAAA,WAAW,GAAG;AACZ,WAAO,KAAK9D,QAAZ;AACD;AAED;AACF;AACA;AACA;;;AACE+D,EAAAA,iBAAiB,CAACnB,SAAD,EAAuB;AACtC,SAAKpC,aAAL,CAAmBwD,QAAnB,CAA4BpB,SAA5B;AACA,WAAO,IAAP;AACD;;AAoBoB,eAARqB,QAAQ,CACnB,CAAChE,OAAD,EAAUiE,OAAV,EAAmB9D,SAAnB,EAA8BF,GAA9B,EAAmCC,QAAnC,EAA6CgE,YAA7C,EAA2D7D,QAA3D,CADmB,EAUnB8D,MAVmB,EAWnB,CAAC7D,WAAD,EAAcC,aAAd,CAXmB,EAYnB;AACA,UAAMH,MAAM,GAAG8D,YAAY,CAACE,YAAb,CAA0BnD,mBAAWC,EAArC,CAAf;AACA,UAAMgB,IAAI,GAAG,IAAIrC,QAAJ,CACXsE,MAAM,CAACpE,QADI,EAGXC,OAHW,EAKXC,GALW,EAOXC,QAPW,EASXC,SATW,EAWXC,MAXW,EAaXC,QAbW,EAeXC,WAfW,EAiBXC,aAjBW,CAAb;AAmBA2B,IAAAA,IAAI,CAAC4B,iBAAL,CAAuB,KAAIO,oCAAJ,EAAqBpE,GAArB,EAA0BC,QAA1B,EAAoCC,SAApC,CAAvB;AACAE,IAAAA,QAAQ,CAACiE,kBAAT,CAA4BH,MAAM,CAACpE,QAAnC;;AAEA,QAAII,SAAJ,EAAe;AACbA,MAAAA,SAAS,CAACoE,eAAV,CAA0B,MAAO3D,SAAP,IAAqB;AAC7C,cAAMwB,GAAG,GAAG,MAAMF,IAAI,CAACW,UAAL,CAAgBjC,SAAhB,CAAlB;AAEA,eAAO;AACLwB,UAAAA,GAAG,EAAEA,GAAF,aAAEA,GAAF,uBAAEA,GAAG,CAAEoC,QAAL;AADA,SAAP;AAGD,OAND;AAOD;;AAEDP,IAAAA,OAAO,CAACF,QAAR,CAAiB,yBAAW7B,IAAX,CAAjB;AAEAlC,IAAAA,OAAO,CAACyE,kBAAR,CAA2B,KAAIC,8BAAJ,EAA0BxC,IAA1B,CAA3B;AACA,WAAOA,IAAP;AACD;;AAzKmB;;;gCAATrC,Q,WAqGI,CAAC8E,gBAAKC,QAAL,EAAD,EAA2BD,gBAAKC,QAAL,EAA3B,C;gCArGJ/E,Q,aAuGMgF,kB;gCAvGNhF,Q,kBAwGW,CACpBiF,wBADoB,EAEpBC,wBAFoB,EAGpBC,4BAHoB,EAIpBC,gBAJoB,EAKpBC,0BALoB,EAMpBC,sBANoB,EAOpBC,mBAPoB,EAQpBC,oBARoB,C;gCAxGXxF,Q,mBAmHY;AACrBE,EAAAA,QAAQ,EAAE,CAAC,aAAD;AADW,C;;AAyDzBkB,mBAAWqE,UAAX,CAAsBzF,QAAtB","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 ComponentAspect, { Component, ComponentMap } 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 { 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 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        this.logger.error('docs.main.runtime.computeDoc caught an error', err);\n        return null;\n      }\n    }\n\n    return null;\n  }\n\n  getDoc(component: Component) {\n    const docData = component.state.aspects.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  /**\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    ComponentAspect,\n  ];\n\n  static defaultConfig = {\n    patterns: ['**/*.docs.*'],\n  };\n\n  static async provider(\n    [preview, graphql, workspace, pkg, compiler, loggerAspect, devFiles]: [\n      PreviewMain,\n      GraphqlMain,\n      Workspace,\n      PkgMain,\n      CompilerMain,\n      LoggerMain,\n      DevFilesMain\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      docPropSlot,\n\n      docReaderSlot\n    );\n    docs.registerDocReader(new DefaultDocReader(pkg, compiler, workspace));\n    devFiles.registerDevPattern(config.patterns);\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"]}

package/dist/index.d.ts

@@ -1,9 +1,13 @@
 import { DocsAspect } from './docs.aspect';
+/**
+ * Doc entity.
+ * @deprecated - please dont use this. use directly from @teambit/docs.entities.doc.
+ */
+export { Doc, DocProp, DocPropList } from '@teambit/docs.entities.doc';
 export type { DocsMain } from './docs.main.runtime';
 export type { DocsUI } from './docs.ui.runtime';
 export type { DocsPreview } from './docs.preview.runtime';
 export type { DocReader } from './doc-reader';
-export { Doc, DocProp, DocPropList } from './doc';
 export type { TitleBadgeSlot } from './overview';
 export { DocsAspect };
 export default DocsAspect;

package/dist/index.js

@@ -6,19 +6,19 @@ Object.defineProperty(exports, "__esModule", {
 Object.defineProperty(exports, "Doc", {
   enumerable: true,
   get: function () {
-    return _doc().Doc;
+    return _docsEntities().Doc;
   }
 });
 Object.defineProperty(exports, "DocProp", {
   enumerable: true,
   get: function () {
-    return _doc().DocProp;
+    return _docsEntities().DocProp;
   }
 });
 Object.defineProperty(exports, "DocPropList", {
   enumerable: true,
   get: function () {
-    return _doc().DocPropList;
+    return _docsEntities().DocPropList;
   }
 });
 Object.defineProperty(exports, "DocsAspect", {
@@ -39,16 +39,20 @@ function _docs() {
   return data;
 }
 
-function _doc() {
-  const data = require("./doc");
+function _docsEntities() {
+  const data = require("@teambit/docs.entities.doc");
 
-  _doc = function () {
+  _docsEntities = function () {
     return data;
   };
 
   return data;
 }
 
+/**
+ * Doc entity.
+ * @deprecated - please dont use this. use directly from @teambit/docs.entities.doc.
+ */
 var _default = _docs().DocsAspect;
 
 exports.default = _default;

package/dist/index.js.map

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

package/dist/overview/overview.js

@@ -101,26 +101,6 @@ function _designUi() {
   return data;
 }
 
-function _evangelistElements() {
-  const data = require("@teambit/evangelist.elements.icon");
-
-  _evangelistElements = function () {
-    return data;
-  };
-
-  return data;
-}
-
-function _designUiStyles() {
-  const data = require("@teambit/design.ui.styles.ellipsis");
-
-  _designUiStyles = function () {
-    return data;
-  };
-
-  return data;
-}
-
 function _overviewModule() {
   const data = _interopRequireDefault(require("./overview.module.scss"));
 
@@ -138,12 +118,12 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
 function Overview({
   titleBadges
 }) {
-  var _lanesModel$currentLa, _component$preview;
+  var _component$preview;
 
   const component = (0, _react().useContext)(_component().ComponentContext);
   const componentDescriptor = (0, _react().useContext)(_component().ComponentDescriptorContext);
   const lanesModel = (0, _lanesUi().useLanesContext)();
-  const laneId = lanesModel === null || lanesModel === void 0 ? void 0 : (_lanesModel$currentLa = lanesModel.currentLane) === null || _lanesModel$currentLa === void 0 ? void 0 : _lanesModel$currentLa.id;
+  const currentLane = lanesModel === null || lanesModel === void 0 ? void 0 : lanesModel.currentLane;
   const {
     data
   } = (0, _componentUiHooks().useFetchDocs)(component.id.toString());
@@ -168,8 +148,8 @@ function Overview({
     const badges = (0, _lodash().default)(titleBadges.values());
     return /*#__PURE__*/_react().default.createElement("div", {
       className: _overviewModule().default.overviewWrapper
-    }, laneId && /*#__PURE__*/_react().default.createElement(LaneOverview, {
-      laneId: laneId
+    }, /*#__PURE__*/_react().default.createElement(_lanesUi().LaneBreadcrumb, {
+      lane: currentLane
     }), /*#__PURE__*/_react().default.createElement(_designUi().Separator, {
       isPresentational: true
     }), /*#__PURE__*/_react().default.createElement(_componentUi().ComponentOverview, {
@@ -193,10 +173,10 @@ function Overview({
     }));
   }
 
-  return laneId ? /*#__PURE__*/_react().default.createElement("div", {
+  return currentLane ? /*#__PURE__*/_react().default.createElement("div", {
     className: _overviewModule().default.overviewWrapper
-  }, /*#__PURE__*/_react().default.createElement(LaneOverview, {
-    laneId: laneId
+  }, /*#__PURE__*/_react().default.createElement(_lanesUi().LaneBreadcrumb, {
+    lane: currentLane
   }), /*#__PURE__*/_react().default.createElement(_designUi().Separator, {
     isPresentational: true
   }), /*#__PURE__*/_react().default.createElement(_previewUi().ComponentPreview, {
@@ -219,16 +199,4 @@ function Overview({
   });
 }
 
-function LaneOverview({
-  laneId
-}) {
-  return /*#__PURE__*/_react().default.createElement("div", {
-    className: _overviewModule().default.lane
-  }, /*#__PURE__*/_react().default.createElement(_evangelistElements().Icon, {
-    of: "lane"
-  }), /*#__PURE__*/_react().default.createElement(_designUiStyles().Ellipsis, {
-    className: _overviewModule().default.laneName
-  }, laneId));
-}
-
 //# sourceMappingURL=overview.js.map

package/dist/overview/overview.js.map

@@ -1 +1 @@
-{"version":3,"sources":["overview.tsx"],"names":["Overview","titleBadges","component","ComponentContext","componentDescriptor","ComponentDescriptorContext","lanesModel","laneId","currentLane","id","data","toString","fetchComponent","buildStatus","host","margin","preview","includesEnvTemplate","labels","length","badges","values","styles","overviewWrapper","componentOverviewBlock","displayName","version","description","packageName","width","height","LaneOverview","lane","laneName"],"mappings":";;;;;;;;;;;;;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAEA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;;;;;AAQO,SAASA,QAAT,CAAkB;AAAEC,EAAAA;AAAF,CAAlB,EAAkD;AAAA;;AACvD,QAAMC,SAAS,GAAG,yBAAWC,6BAAX,CAAlB;AACA,QAAMC,mBAAmB,GAAG,yBAAWC,uCAAX,CAA5B;AACA,QAAMC,UAAU,GAAG,iCAAnB;AACA,QAAMC,MAAM,GAAGD,UAAH,aAAGA,UAAH,gDAAGA,UAAU,CAAEE,WAAf,0DAAG,sBAAyBC,EAAxC;AACA,QAAM;AAAEC,IAAAA;AAAF,MAAW,sCAAaR,SAAS,CAACO,EAAV,CAAaE,QAAb,EAAb,CAAjB;AACA,QAAMC,cAAc,GAAGF,IAAH,aAAGA,IAAH,uBAAGA,IAAI,CAAER,SAA7B;AACA,MAAI,CAAAA,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEW,WAAX,MAA2B,SAA3B,IAAwC,CAAAX,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEY,IAAX,MAAoB,qBAAhE,EACE,oBACE,+BAAC,qCAAD;AAAmB,IAAA,KAAK,EAAE;AAAEC,MAAAA,MAAM,EAAE;AAAV,KAA1B;AAA8C,IAAA,MAAM,EAAC,YAArD;AAAkE,IAAA,KAAK,EAAC;AAAxE,iCADF;AAKF,MAAI,CAAAb,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEW,WAAX,MAA2B,QAA3B,IAAuC,CAAAX,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEY,IAAX,MAAoB,qBAA/D,EACE,oBACE,+BAAC,qCAAD;AACE,IAAA,KAAK,EAAE;AAAEC,MAAAA,MAAM,EAAE;AAAV,KADT;AAEE,IAAA,MAAM,EAAC,SAFT;AAGE,IAAA,KAAK,EAAC;AAHR,IADF;;AAQF,MAAI,uBAAAb,SAAS,CAACc,OAAV,0EAAmBC,mBAAnB,MAA2C,KAA/C,EAAsD;AACpD,UAAMC,MAAM,GAAGhB,SAAS,CAACgB,MAAV,CAAiBC,MAAjB,GAA0B,CAA1B,GAA8BjB,SAAS,CAACgB,MAAxC,GAAiDN,cAAjD,aAAiDA,cAAjD,uBAAiDA,cAAc,CAAEM,MAAhF;AACA,UAAME,MAAM,GAAG,uBAAQnB,WAAW,CAACoB,MAAZ,EAAR,CAAf;AAEA,wBACE;AAAK,MAAA,SAAS,EAAEC,0BAAOC;AAAvB,OACGhB,MAAM,iBAAI,+BAAC,YAAD;AAAc,MAAA,MAAM,EAAEA;AAAtB,MADb,eAEE,+BAAC,qBAAD;AAAW,MAAA,gBAAgB;AAA3B,MAFF,eAGE,+BAAC,gCAAD;AACE,MAAA,SAAS,EAAEe,0BAAOE,sBADpB;AAEE,MAAA,WAAW,EAAEtB,SAAS,CAACuB,WAFzB;AAGE,MAAA,OAAO,EAAEvB,SAAS,CAACwB,OAHrB;AAIE,MAAA,QAAQ,EAAExB,SAAS,CAACyB,WAAV,KAAyBf,cAAzB,aAAyBA,cAAzB,uBAAyBA,cAAc,CAAEe,WAAzC,CAJZ;AAKE,MAAA,MAAM,EAAET,MAAM,IAAI,EALpB;AAME,MAAA,WAAW,EAAEhB,SAAS,CAAC0B,WANzB;AAOE,MAAA,WAAW,EAAER,MAPf;AAQE,MAAA,mBAAmB,EAAEhB;AARvB,MAHF,eAaE,+BAAC,6BAAD;AACE,MAAA,SAAS,EAAEF,SADb;AAEE,MAAA,KAAK,EAAE;AAAE2B,QAAAA,KAAK,EAAE,MAAT;AAAiBC,QAAAA,MAAM,EAAE;AAAzB,OAFT;AAGE,MAAA,WAAW,EAAC,UAHd;AAIE,MAAA,iBAAiB,MAJnB;AAKE,MAAA,SAAS,EAAC;AALZ,MAbF,CADF;AAuBD;;AAED,SAAOvB,MAAM,gBACX;AAAK,IAAA,SAAS,EAAEe,0BAAOC;AAAvB,kBACE,+BAAC,YAAD;AAAc,IAAA,MAAM,EAAEhB;AAAtB,IADF,eAEE,+BAAC,qBAAD;AAAW,IAAA,gBAAgB;AAA3B,IAFF,eAGE,+BAAC,6BAAD;AACE,IAAA,SAAS,EAAEL,SADb;AAEE,IAAA,KAAK,EAAE;AAAE2B,MAAAA,KAAK,EAAE,MAAT;AAAiBC,MAAAA,MAAM,EAAE;AAAzB,KAFT;AAGE,IAAA,WAAW,EAAC,UAHd;AAIE,IAAA,iBAAiB,MAJnB;AAKE,IAAA,SAAS,EAAC;AALZ,IAHF,CADW,gBAaX,+BAAC,6BAAD;AACE,IAAA,SAAS,EAAE5B,SADb;AAEE,IAAA,KAAK,EAAE;AAAE2B,MAAAA,KAAK,EAAE,MAAT;AAAiBC,MAAAA,MAAM,EAAE;AAAzB,KAFT;AAGE,IAAA,WAAW,EAAC,UAHd;AAIE,IAAA,iBAAiB;AAJnB,IAbF;AAoBD;;AAED,SAASC,YAAT,CAAsB;AAAExB,EAAAA;AAAF,CAAtB,EAAmE;AACjE,sBACE;AAAK,IAAA,SAAS,EAAEe,0BAAOU;AAAvB,kBACE,+BAAC,0BAAD;AAAM,IAAA,EAAE,EAAC;AAAT,IADF,eAEE,+BAAC,0BAAD;AAAU,IAAA,SAAS,EAAEV,0BAAOW;AAA5B,KAAuC1B,MAAvC,CAFF,CADF;AAMD","sourcesContent":["import React, { useContext } from 'react';\nimport flatten from 'lodash.flatten';\nimport { ComponentContext, ComponentDescriptorContext } 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 { useFetchDocs } from '@teambit/component.ui.hooks.use-fetch-docs';\nimport { useLanesContext } from '@teambit/lanes.ui.lanes';\nimport { Separator } from '@teambit/design.ui.separator';\nimport { Icon } from '@teambit/evangelist.elements.icon';\nimport { Ellipsis } from '@teambit/design.ui.styles.ellipsis';\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 = useContext(ComponentDescriptorContext);\n  const lanesModel = useLanesContext();\n  const laneId = lanesModel?.currentLane?.id;\n  const { data } = useFetchDocs(component.id.toString());\n  const fetchComponent = data?.component;\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  if (component?.buildStatus === 'failed' && component?.host === 'teambit.scope/scope')\n    return (\n      <StatusMessageCard\n        style={{ margin: 'auto' }}\n        status=\"FAILURE\"\n        title=\"failed to get component preview \"\n      ></StatusMessageCard>\n    );\n\n  if (component.preview?.includesEnvTemplate === false) {\n    const labels = component.labels.length > 0 ? component.labels : fetchComponent?.labels;\n    const badges = flatten(titleBadges.values());\n\n    return (\n      <div className={styles.overviewWrapper}>\n        {laneId && <LaneOverview laneId={laneId} />}\n        <Separator isPresentational />\n        <ComponentOverview\n          className={styles.componentOverviewBlock}\n          displayName={component.displayName}\n          version={component.version}\n          abstract={component.description || fetchComponent?.description}\n          labels={labels || []}\n          packageName={component.packageName}\n          titleBadges={badges}\n          componentDescriptor={componentDescriptor}\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\n  return laneId ? (\n    <div className={styles.overviewWrapper}>\n      <LaneOverview laneId={laneId} />\n      <Separator isPresentational />\n      <ComponentPreview\n        component={component}\n        style={{ width: '100%', height: '100%' }}\n        previewName=\"overview\"\n        fullContentHeight\n        scrolling=\"no\"\n      />\n    </div>\n  ) : (\n    <ComponentPreview\n      component={component}\n      style={{ width: '100%', height: '100%' }}\n      previewName=\"overview\"\n      fullContentHeight\n    />\n  );\n}\n\nfunction LaneOverview({ laneId }: { laneId: string }): JSX.Element {\n  return (\n    <div className={styles.lane}>\n      <Icon of=\"lane\"></Icon>\n      <Ellipsis className={styles.laneName}>{laneId}</Ellipsis>\n    </div>\n  );\n}\n"]}
+{"version":3,"sources":["overview.tsx"],"names":["Overview","titleBadges","component","ComponentContext","componentDescriptor","ComponentDescriptorContext","lanesModel","currentLane","data","id","toString","fetchComponent","buildStatus","host","margin","preview","includesEnvTemplate","labels","length","badges","values","styles","overviewWrapper","componentOverviewBlock","displayName","version","description","packageName","width","height"],"mappings":";;;;;;;;;;;;;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAEA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;;;;;AAQO,SAASA,QAAT,CAAkB;AAAEC,EAAAA;AAAF,CAAlB,EAAkD;AAAA;;AACvD,QAAMC,SAAS,GAAG,yBAAWC,6BAAX,CAAlB;AACA,QAAMC,mBAAmB,GAAG,yBAAWC,uCAAX,CAA5B;AACA,QAAMC,UAAU,GAAG,iCAAnB;AACA,QAAMC,WAAW,GAAGD,UAAH,aAAGA,UAAH,uBAAGA,UAAU,CAAEC,WAAhC;AACA,QAAM;AAAEC,IAAAA;AAAF,MAAW,sCAAaN,SAAS,CAACO,EAAV,CAAaC,QAAb,EAAb,CAAjB;AACA,QAAMC,cAAc,GAAGH,IAAH,aAAGA,IAAH,uBAAGA,IAAI,CAAEN,SAA7B;AACA,MAAI,CAAAA,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEU,WAAX,MAA2B,SAA3B,IAAwC,CAAAV,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEW,IAAX,MAAoB,qBAAhE,EACE,oBACE,+BAAC,qCAAD;AAAmB,IAAA,KAAK,EAAE;AAAEC,MAAAA,MAAM,EAAE;AAAV,KAA1B;AAA8C,IAAA,MAAM,EAAC,YAArD;AAAkE,IAAA,KAAK,EAAC;AAAxE,iCADF;AAKF,MAAI,CAAAZ,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEU,WAAX,MAA2B,QAA3B,IAAuC,CAAAV,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEW,IAAX,MAAoB,qBAA/D,EACE,oBACE,+BAAC,qCAAD;AACE,IAAA,KAAK,EAAE;AAAEC,MAAAA,MAAM,EAAE;AAAV,KADT;AAEE,IAAA,MAAM,EAAC,SAFT;AAGE,IAAA,KAAK,EAAC;AAHR,IADF;;AAQF,MAAI,uBAAAZ,SAAS,CAACa,OAAV,0EAAmBC,mBAAnB,MAA2C,KAA/C,EAAsD;AACpD,UAAMC,MAAM,GAAGf,SAAS,CAACe,MAAV,CAAiBC,MAAjB,GAA0B,CAA1B,GAA8BhB,SAAS,CAACe,MAAxC,GAAiDN,cAAjD,aAAiDA,cAAjD,uBAAiDA,cAAc,CAAEM,MAAhF;AACA,UAAME,MAAM,GAAG,uBAAQlB,WAAW,CAACmB,MAAZ,EAAR,CAAf;AAEA,wBACE;AAAK,MAAA,SAAS,EAAEC,0BAAOC;AAAvB,oBACE,+BAAC,yBAAD;AAAgB,MAAA,IAAI,EAAEf;AAAtB,MADF,eAEE,+BAAC,qBAAD;AAAW,MAAA,gBAAgB;AAA3B,MAFF,eAGE,+BAAC,gCAAD;AACE,MAAA,SAAS,EAAEc,0BAAOE,sBADpB;AAEE,MAAA,WAAW,EAAErB,SAAS,CAACsB,WAFzB;AAGE,MAAA,OAAO,EAAEtB,SAAS,CAACuB,OAHrB;AAIE,MAAA,QAAQ,EAAEvB,SAAS,CAACwB,WAAV,KAAyBf,cAAzB,aAAyBA,cAAzB,uBAAyBA,cAAc,CAAEe,WAAzC,CAJZ;AAKE,MAAA,MAAM,EAAET,MAAM,IAAI,EALpB;AAME,MAAA,WAAW,EAAEf,SAAS,CAACyB,WANzB;AAOE,MAAA,WAAW,EAAER,MAPf;AAQE,MAAA,mBAAmB,EAAEf;AARvB,MAHF,eAaE,+BAAC,6BAAD;AACE,MAAA,SAAS,EAAEF,SADb;AAEE,MAAA,KAAK,EAAE;AAAE0B,QAAAA,KAAK,EAAE,MAAT;AAAiBC,QAAAA,MAAM,EAAE;AAAzB,OAFT;AAGE,MAAA,WAAW,EAAC,UAHd;AAIE,MAAA,iBAAiB,MAJnB;AAKE,MAAA,SAAS,EAAC;AALZ,MAbF,CADF;AAuBD;;AAED,SAAOtB,WAAW,gBAChB;AAAK,IAAA,SAAS,EAAEc,0BAAOC;AAAvB,kBACE,+BAAC,yBAAD;AAAgB,IAAA,IAAI,EAAEf;AAAtB,IADF,eAEE,+BAAC,qBAAD;AAAW,IAAA,gBAAgB;AAA3B,IAFF,eAGE,+BAAC,6BAAD;AACE,IAAA,SAAS,EAAEL,SADb;AAEE,IAAA,KAAK,EAAE;AAAE0B,MAAAA,KAAK,EAAE,MAAT;AAAiBC,MAAAA,MAAM,EAAE;AAAzB,KAFT;AAGE,IAAA,WAAW,EAAC,UAHd;AAIE,IAAA,iBAAiB,MAJnB;AAKE,IAAA,SAAS,EAAC;AALZ,IAHF,CADgB,gBAahB,+BAAC,6BAAD;AACE,IAAA,SAAS,EAAE3B,SADb;AAEE,IAAA,KAAK,EAAE;AAAE0B,MAAAA,KAAK,EAAE,MAAT;AAAiBC,MAAAA,MAAM,EAAE;AAAzB,KAFT;AAGE,IAAA,WAAW,EAAC,UAHd;AAIE,IAAA,iBAAiB;AAJnB,IAbF;AAoBD","sourcesContent":["import React, { useContext } from 'react';\nimport flatten from 'lodash.flatten';\nimport { ComponentContext, ComponentDescriptorContext } 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 { useFetchDocs } from '@teambit/component.ui.hooks.use-fetch-docs';\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 = useContext(ComponentDescriptorContext);\n  const lanesModel = useLanesContext();\n  const currentLane = lanesModel?.currentLane;\n  const { data } = useFetchDocs(component.id.toString());\n  const fetchComponent = data?.component;\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  if (component?.buildStatus === 'failed' && component?.host === 'teambit.scope/scope')\n    return (\n      <StatusMessageCard\n        style={{ margin: 'auto' }}\n        status=\"FAILURE\"\n        title=\"failed to get component preview \"\n      ></StatusMessageCard>\n    );\n\n  if (component.preview?.includesEnvTemplate === false) {\n    const labels = component.labels.length > 0 ? component.labels : fetchComponent?.labels;\n    const badges = flatten(titleBadges.values());\n\n    return (\n      <div className={styles.overviewWrapper}>\n        <LaneBreadcrumb lane={currentLane} />\n        <Separator isPresentational />\n        <ComponentOverview\n          className={styles.componentOverviewBlock}\n          displayName={component.displayName}\n          version={component.version}\n          abstract={component.description || fetchComponent?.description}\n          labels={labels || []}\n          packageName={component.packageName}\n          titleBadges={badges}\n          componentDescriptor={componentDescriptor}\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\n  return currentLane ? (\n    <div className={styles.overviewWrapper}>\n      <LaneBreadcrumb lane={currentLane} />\n      <Separator isPresentational />\n      <ComponentPreview\n        component={component}\n        style={{ width: '100%', height: '100%' }}\n        previewName=\"overview\"\n        fullContentHeight\n        scrolling=\"no\"\n      />\n    </div>\n  ) : (\n    <ComponentPreview\n      component={component}\n      style={{ width: '100%', height: '100%' }}\n      previewName=\"overview\"\n      fullContentHeight\n    />\n  );\n}\n"]}

package/dist/overview/overview.module.scss

@@ -7,17 +7,4 @@
     margin: 0 auto;
     margin-bottom: 0;
   }
-  .lane {
-    display: flex;
-    align-items: center;
-    flex: 1;
-    min-width: 0;
-    padding: 24px 0px 16px 32px;
-    .laneName {
-      overflow: hidden;
-      white-space: nowrap;
-      font-size: large;
-      padding: 0px 8px;
-    }
-  }
 }

package/overview/overview.module.scss

@@ -7,17 +7,4 @@
     margin: 0 auto;
     margin-bottom: 0;
   }
-  .lane {
-    display: flex;
-    align-items: center;
-    flex: 1;
-    min-width: 0;
-    padding: 24px 0px 16px 32px;
-    .laneName {
-      overflow: hidden;
-      white-space: nowrap;
-      font-size: large;
-      padding: 0px 8px;
-    }
-  }
 }

package/overview/overview.tsx

@@ -6,10 +6,8 @@ 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 { useFetchDocs } from '@teambit/component.ui.hooks.use-fetch-docs';
-import { useLanesContext } from '@teambit/lanes.ui.lanes';
+import { LaneBreadcrumb, useLanesContext } from '@teambit/lanes.ui.lanes';
 import { Separator } from '@teambit/design.ui.separator';
-import { Icon } from '@teambit/evangelist.elements.icon';
-import { Ellipsis } from '@teambit/design.ui.styles.ellipsis';
 import styles from './overview.module.scss';
 
 export type TitleBadgeSlot = SlotRegistry<TitleBadge[]>;
@@ -22,7 +20,7 @@ export function Overview({ titleBadges }: OverviewProps) {
   const component = useContext(ComponentContext);
   const componentDescriptor = useContext(ComponentDescriptorContext);
   const lanesModel = useLanesContext();
-  const laneId = lanesModel?.currentLane?.id;
+  const currentLane = lanesModel?.currentLane;
   const { data } = useFetchDocs(component.id.toString());
   const fetchComponent = data?.component;
   if (component?.buildStatus === 'pending' && component?.host === 'teambit.scope/scope')
@@ -46,7 +44,7 @@ export function Overview({ titleBadges }: OverviewProps) {
 
     return (
       <div className={styles.overviewWrapper}>
-        {laneId && <LaneOverview laneId={laneId} />}
+        <LaneBreadcrumb lane={currentLane} />
         <Separator isPresentational />
         <ComponentOverview
           className={styles.componentOverviewBlock}
@@ -69,9 +67,9 @@ export function Overview({ titleBadges }: OverviewProps) {
     );
   }
 
-  return laneId ? (
+  return currentLane ? (
     <div className={styles.overviewWrapper}>
-      <LaneOverview laneId={laneId} />
+      <LaneBreadcrumb lane={currentLane} />
       <Separator isPresentational />
       <ComponentPreview
         component={component}
@@ -90,12 +88,3 @@ export function Overview({ titleBadges }: OverviewProps) {
     />
   );
 }
-
-function LaneOverview({ laneId }: { laneId: string }): JSX.Element {
-  return (
-    <div className={styles.lane}>
-      <Icon of="lane"></Icon>
-      <Ellipsis className={styles.laneName}>{laneId}</Ellipsis>
-    </div>
-  );
-}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/docs",
-  "version": "0.0.661",
+  "version": "0.0.662",
   "homepage": "https://bit.dev/teambit/docs/docs",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.docs",
     "name": "docs",
-    "version": "0.0.661"
+    "version": "0.0.662"
   },
   "dependencies": {
     "@teambit/harmony": "0.2.11",
@@ -14,27 +14,25 @@
     "lodash.flatten": "4.4.0",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/evangelist.elements.icon": "1.0.2",
-    "@teambit/compiler": "0.0.661",
-    "@teambit/component": "0.0.661",
-    "@teambit/pkg": "0.0.661",
-    "@teambit/workspace": "0.0.661",
+    "@teambit/compiler": "0.0.662",
+    "@teambit/component": "0.0.662",
+    "@teambit/docs.entities.doc": "0.0.2",
+    "@teambit/pkg": "0.0.662",
+    "@teambit/workspace": "0.0.662",
     "@teambit/cli": "0.0.449",
-    "@teambit/dev-files": "0.0.661",
-    "@teambit/envs": "0.0.661",
-    "@teambit/graphql": "0.0.661",
+    "@teambit/dev-files": "0.0.662",
+    "@teambit/envs": "0.0.662",
+    "@teambit/graphql": "0.0.662",
     "@teambit/logger": "0.0.539",
-    "@teambit/preview": "0.0.661",
+    "@teambit/preview": "0.0.662",
     "@teambit/component.ui.component-meta": "0.0.7",
-    "@teambit/ui": "0.0.661",
-    "@teambit/toolbox.types.serializable": "0.0.483",
-    "@teambit/pubsub": "0.0.661",
+    "@teambit/ui": "0.0.662",
     "@teambit/component.ui.hooks.use-fetch-docs": "0.0.3",
     "@teambit/design.ui.separator": "0.0.351",
-    "@teambit/design.ui.styles.ellipsis": "0.0.347",
     "@teambit/design.ui.surfaces.status-message-card": "0.0.7",
-    "@teambit/lanes.ui.lanes": "0.0.6",
-    "@teambit/preview.ui.component-preview": "0.0.491"
+    "@teambit/lanes.ui.lanes": "0.0.7",
+    "@teambit/preview.ui.component-preview": "0.0.491",
+    "@teambit/pubsub": "0.0.662"
   },
   "devDependencies": {
     "@types/react-dom": "^17.0.5",

package/dist/doc/doc-prop-list.d.ts

@@ -1,7 +0,0 @@
-import { DocProp } from './doc-prop';
-export declare class DocPropList {
-    readonly docProps: DocProp[];
-    constructor(docProps: DocProp[]);
-    get(name: string): DocProp | undefined;
-    static from(object: any): DocPropList;
-}

package/dist/doc/doc-prop-list.js

@@ -1,39 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.DocPropList = void 0;
-
-function _docProp() {
-  const data = require("./doc-prop");
-
-  _docProp = function () {
-    return data;
-  };
-
-  return data;
-}
-
-class DocPropList {
-  constructor(docProps) {
-    this.docProps = docProps;
-  }
-
-  get(name) {
-    return this.docProps.find(docProp => docProp.name === name);
-  }
-
-  static from(object) {
-    const props = Object.keys(object).map(key => {
-      if (!object[key]) return undefined;
-      return new (_docProp().DocProp)(key, object[key]);
-    }).filter(prop => !!prop);
-    return new DocPropList(props);
-  }
-
-}
-
-exports.DocPropList = DocPropList;
-
-//# sourceMappingURL=doc-prop-list.js.map

package/dist/doc/doc-prop-list.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["doc-prop-list.ts"],"names":["DocPropList","constructor","docProps","get","name","find","docProp","from","object","props","Object","keys","map","key","undefined","DocProp","filter","prop"],"mappings":";;;;;;;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAEO,MAAMA,WAAN,CAAkB;AACvBC,EAAAA,WAAW,CAAUC,QAAV,EAA+B;AAAA,SAArBA,QAAqB,GAArBA,QAAqB;AAAE;;AAE5CC,EAAAA,GAAG,CAACC,IAAD,EAAe;AAChB,WAAO,KAAKF,QAAL,CAAcG,IAAd,CAAoBC,OAAD,IAAaA,OAAO,CAACF,IAAR,KAAiBA,IAAjD,CAAP;AACD;;AAEU,SAAJG,IAAI,CAACC,MAAD,EAA2B;AACpC,UAAMC,KAAK,GAAGC,MAAM,CAACC,IAAP,CAAYH,MAAZ,EACXI,GADW,CACNC,GAAD,IAAS;AACZ,UAAI,CAACL,MAAM,CAACK,GAAD,CAAX,EAAkB,OAAOC,SAAP;AAClB,aAAO,KAAIC,kBAAJ,EAAYF,GAAZ,EAAiBL,MAAM,CAACK,GAAD,CAAvB,CAAP;AACD,KAJW,EAKXG,MALW,CAKHC,IAAD,IAAU,CAAC,CAACA,IALR,CAAd;AAOA,WAAO,IAAIjB,WAAJ,CAAgBS,KAAhB,CAAP;AACD;;AAhBsB","sourcesContent":["import { DocProp } from './doc-prop';\n\nexport class DocPropList {\n  constructor(readonly docProps: DocProp[]) {}\n\n  get(name: string) {\n    return this.docProps.find((docProp) => docProp.name === name);\n  }\n\n  static from(object: any): DocPropList {\n    const props = Object.keys(object)\n      .map((key) => {\n        if (!object[key]) return undefined;\n        return new DocProp(key, object[key]);\n      })\n      .filter((prop) => !!prop) as DocProp[];\n\n    return new DocPropList(props);\n  }\n}\n"]}

package/dist/doc/doc-prop.d.ts

@@ -1,21 +0,0 @@
-import type { Serializable } from '@teambit/toolbox.types.serializable';
-export declare class DocProp {
-    /**
-     * name of the doc property.
-     */
-    readonly name: string;
-    /**
-     * value of the doc property.
-     */
-    readonly value: Serializable;
-    constructor(
-    /**
-     * name of the doc property.
-     */
-    name: string, 
-    /**
-     * value of the doc property.
-     */
-    value: Serializable);
-    getAs<T>(): T;
-}

package/dist/doc/doc-prop.js

@@ -1,30 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.DocProp = void 0;
-
-class DocProp {
-  constructor(
-  /**
-   * name of the doc property.
-   */
-  name,
-  /**
-   * value of the doc property.
-   */
-  value) {
-    this.name = name;
-    this.value = value;
-  }
-
-  getAs() {
-    return this.value;
-  }
-
-}
-
-exports.DocProp = DocProp;
-
-//# sourceMappingURL=doc-prop.js.map

package/dist/doc/doc-prop.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["doc-prop.ts"],"names":["DocProp","constructor","name","value","getAs"],"mappings":";;;;;;;AAEO,MAAMA,OAAN,CAAc;AACnBC,EAAAA,WAAW;AACT;AACJ;AACA;AACaC,EAAAA,IAJA;AAMT;AACJ;AACA;AACaC,EAAAA,KATA,EAUT;AAAA,SANSD,IAMT,GANSA,IAMT;AAAA,SADSC,KACT,GADSA,KACT;AAAE;;AAEJC,EAAAA,KAAK,GAAM;AACT,WAAO,KAAKD,KAAZ;AACD;;AAfkB","sourcesContent":["import type { Serializable } from '@teambit/toolbox.types.serializable';\n\nexport class DocProp {\n  constructor(\n    /**\n     * name of the doc property.\n     */\n    readonly name: string,\n\n    /**\n     * value of the doc property.\n     */\n    readonly value: Serializable\n  ) {}\n\n  getAs<T>() {\n    return this.value as T;\n  }\n}\n"]}

package/dist/doc/doc.d.ts

@@ -1,24 +0,0 @@
-import type { SerializableMap } from '@teambit/toolbox.types.serializable';
-import { DocPropList } from './doc-prop-list';
-export declare class Doc {
-    readonly filePath: string;
-    readonly props: DocPropList;
-    constructor(filePath: string, props: DocPropList);
-    toObject(): {
-        filePath: string;
-        props: import("./doc-prop").DocProp[];
-    };
-    /**
-     * shorthand for getting the component description.
-     */
-    get description(): string;
-    /**
-     * shorthand for getting the component labels.
-     */
-    get labels(): string[];
-    /**
-     * shorthand for getting the component labels.
-     */
-    get displayName(): import("./doc-prop").DocProp | undefined;
-    static from(path: string, propObject: SerializableMap): Doc;
-}

package/dist/doc/doc.js

@@ -1,71 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Doc = void 0;
-
-function _docPropList() {
-  const data = require("./doc-prop-list");
-
-  _docPropList = function () {
-    return data;
-  };
-
-  return data;
-}
-
-class Doc {
-  constructor(filePath, props) {
-    this.filePath = filePath;
-    this.props = props;
-  }
-
-  toObject() {
-    return {
-      filePath: this.filePath,
-      props: this.props.docProps
-    };
-  }
-  /**
-   * shorthand for getting the component description.
-   */
-
-
-  get description() {
-    var _this$props$get;
-
-    const value = (_this$props$get = this.props.get('description')) === null || _this$props$get === void 0 ? void 0 : _this$props$get.value;
-    if (!value) return '';
-    return value;
-  }
-  /**
-   * shorthand for getting the component labels.
-   */
-
-
-  get labels() {
-    var _this$props$get2;
-
-    const value = (_this$props$get2 = this.props.get('labels')) === null || _this$props$get2 === void 0 ? void 0 : _this$props$get2.value;
-    if (!value) return [];
-    return value;
-  }
-  /**
-   * shorthand for getting the component labels.
-   */
-
-
-  get displayName() {
-    return this.props.get('displayName');
-  }
-
-  static from(path, propObject) {
-    return new Doc(path, _docPropList().DocPropList.from(propObject));
-  }
-
-}
-
-exports.Doc = Doc;
-
-//# sourceMappingURL=doc.js.map

package/dist/doc/doc.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["doc.ts"],"names":["Doc","constructor","filePath","props","toObject","docProps","description","value","get","labels","displayName","from","path","propObject","DocPropList"],"mappings":";;;;;;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAEO,MAAMA,GAAN,CAAU;AACfC,EAAAA,WAAW,CAAUC,QAAV,EAAqCC,KAArC,EAAyD;AAAA,SAA/CD,QAA+C,GAA/CA,QAA+C;AAAA,SAApBC,KAAoB,GAApBA,KAAoB;AAAE;;AAEtEC,EAAAA,QAAQ,GAAG;AACT,WAAO;AACLF,MAAAA,QAAQ,EAAE,KAAKA,QADV;AAELC,MAAAA,KAAK,EAAE,KAAKA,KAAL,CAAWE;AAFb,KAAP;AAID;AAED;AACF;AACA;;;AACiB,MAAXC,WAAW,GAAW;AAAA;;AACxB,UAAMC,KAAK,sBAAG,KAAKJ,KAAL,CAAWK,GAAX,CAAe,aAAf,CAAH,oDAAG,gBAA+BD,KAA7C;AACA,QAAI,CAACA,KAAL,EAAY,OAAO,EAAP;AACZ,WAAOA,KAAP;AACD;AAED;AACF;AACA;;;AACY,MAANE,MAAM,GAAG;AAAA;;AACX,UAAMF,KAAK,uBAAG,KAAKJ,KAAL,CAAWK,GAAX,CAAe,QAAf,CAAH,qDAAG,iBAA0BD,KAAxC;AACA,QAAI,CAACA,KAAL,EAAY,OAAO,EAAP;AACZ,WAAOA,KAAP;AACD;AAED;AACF;AACA;;;AACiB,MAAXG,WAAW,GAAG;AAChB,WAAO,KAAKP,KAAL,CAAWK,GAAX,CAAe,aAAf,CAAP;AACD;;AAEU,SAAJG,IAAI,CAACC,IAAD,EAAeC,UAAf,EAA4C;AACrD,WAAO,IAAIb,GAAJ,CAAQY,IAAR,EAAcE,2BAAYH,IAAZ,CAAiBE,UAAjB,CAAd,CAAP;AACD;;AArCc","sourcesContent":["import type { SerializableMap } from '@teambit/toolbox.types.serializable';\nimport { DocPropList } from './doc-prop-list';\n\nexport class Doc {\n  constructor(readonly filePath: string, readonly props: DocPropList) {}\n\n  toObject() {\n    return {\n      filePath: this.filePath,\n      props: this.props.docProps,\n    };\n  }\n\n  /**\n   * shorthand for getting the component description.\n   */\n  get description(): string {\n    const value = this.props.get('description')?.value;\n    if (!value) return '';\n    return value as string;\n  }\n\n  /**\n   * shorthand for getting the component labels.\n   */\n  get labels() {\n    const value = this.props.get('labels')?.value;\n    if (!value) return [];\n    return value as string[];\n  }\n\n  /**\n   * shorthand for getting the component labels.\n   */\n  get displayName() {\n    return this.props.get('displayName');\n  }\n\n  static from(path: string, propObject: SerializableMap) {\n    return new Doc(path, DocPropList.from(propObject));\n  }\n}\n"]}

package/dist/doc/index.d.ts

@@ -1,3 +0,0 @@
-export { Doc } from './doc';
-export { DocProp } from './doc-prop';
-export { DocPropList } from './doc-prop-list';

package/dist/doc/index.js

@@ -1,55 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "Doc", {
-  enumerable: true,
-  get: function () {
-    return _doc().Doc;
-  }
-});
-Object.defineProperty(exports, "DocProp", {
-  enumerable: true,
-  get: function () {
-    return _docProp().DocProp;
-  }
-});
-Object.defineProperty(exports, "DocPropList", {
-  enumerable: true,
-  get: function () {
-    return _docPropList().DocPropList;
-  }
-});
-
-function _doc() {
-  const data = require("./doc");
-
-  _doc = function () {
-    return data;
-  };
-
-  return data;
-}
-
-function _docProp() {
-  const data = require("./doc-prop");
-
-  _docProp = function () {
-    return data;
-  };
-
-  return data;
-}
-
-function _docPropList() {
-  const data = require("./doc-prop-list");
-
-  _docPropList = function () {
-    return data;
-  };
-
-  return data;
-}
-
-//# sourceMappingURL=index.js.map

package/dist/doc/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA","sourcesContent":["export { Doc } from './doc';\nexport { DocProp } from './doc-prop';\nexport { DocPropList } from './doc-prop-list';\n"]}

package/doc/doc-prop-list.ts

@@ -1,20 +0,0 @@
-import { DocProp } from './doc-prop';
-
-export class DocPropList {
-  constructor(readonly docProps: DocProp[]) {}
-
-  get(name: string) {
-    return this.docProps.find((docProp) => docProp.name === name);
-  }
-
-  static from(object: any): DocPropList {
-    const props = Object.keys(object)
-      .map((key) => {
-        if (!object[key]) return undefined;
-        return new DocProp(key, object[key]);
-      })
-      .filter((prop) => !!prop) as DocProp[];
-
-    return new DocPropList(props);
-  }
-}

package/doc/doc-prop.ts

@@ -1,19 +0,0 @@
-import type { Serializable } from '@teambit/toolbox.types.serializable';
-
-export class DocProp {
-  constructor(
-    /**
-     * name of the doc property.
-     */
-    readonly name: string,
-
-    /**
-     * value of the doc property.
-     */
-    readonly value: Serializable
-  ) {}
-
-  getAs<T>() {
-    return this.value as T;
-  }
-}

package/doc/doc.ts

@@ -1,42 +0,0 @@
-import type { SerializableMap } from '@teambit/toolbox.types.serializable';
-import { DocPropList } from './doc-prop-list';
-
-export class Doc {
-  constructor(readonly filePath: string, readonly props: DocPropList) {}
-
-  toObject() {
-    return {
-      filePath: this.filePath,
-      props: this.props.docProps,
-    };
-  }
-
-  /**
-   * shorthand for getting the component description.
-   */
-  get description(): string {
-    const value = this.props.get('description')?.value;
-    if (!value) return '';
-    return value as string;
-  }
-
-  /**
-   * shorthand for getting the component labels.
-   */
-  get labels() {
-    const value = this.props.get('labels')?.value;
-    if (!value) return [];
-    return value as string[];
-  }
-
-  /**
-   * shorthand for getting the component labels.
-   */
-  get displayName() {
-    return this.props.get('displayName');
-  }
-
-  static from(path: string, propObject: SerializableMap) {
-    return new Doc(path, DocPropList.from(propObject));
-  }
-}

package/doc/index.ts

@@ -1,3 +0,0 @@
-export { Doc } from './doc';
-export { DocProp } from './doc-prop';
-export { DocPropList } from './doc-prop-list';