@teambit/docs 1.0.107 → 1.0.108

package/default-doc-reader.ts

@@ -0,0 +1,29 @@
+import { resolve } from 'path';
+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';
+
+export class DefaultDocReader implements DocReader {
+  constructor(private pkg: PkgMain, private compiler: CompilerMain, private workspace: Workspace) {}
+
+  async read(path: string, contents: Buffer, component: Component) {
+    const packageName = this.pkg.getPackageName(component);
+    const distPath = this.compiler.getDistPathBySrcPath(component, path);
+    // eslint-disable-next-line
+    const docsModule = require(resolve(`${this.workspace.path}/node_modules/${packageName}/${distPath}`));
+    return Doc.from(path, {
+      labels: docsModule.labels || docsModule.default?.labels,
+      description: docsModule.abstract || docsModule.default?.abstract || docsModule.description,
+      displayName: docsModule.displayName || docsModule.default?.componentDisplayName,
+    });
+  }
+
+  readonly supportedExtensions = ['.ts', '.js', '.jsx', '.tsx'];
+
+  isFormatSupported(format: string) {
+    return this.supportedExtensions.includes(format);
+  }
+}

package/dist/default-doc-reader.js

@@ -29,15 +29,14 @@ class DefaultDocReader {
     _defineProperty(this, "supportedExtensions", ['.ts', '.js', '.jsx', '.tsx']);
   }
   async read(path, contents, component) {
-    var _docsModule$default, _docsModule$default2, _docsModule$default3;
     const packageName = this.pkg.getPackageName(component);
     const distPath = this.compiler.getDistPathBySrcPath(component, path);
     // eslint-disable-next-line
     const docsModule = require((0, _path().resolve)(`${this.workspace.path}/node_modules/${packageName}/${distPath}`));
     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)
+      labels: docsModule.labels || docsModule.default?.labels,
+      description: docsModule.abstract || docsModule.default?.abstract || docsModule.description,
+      displayName: docsModule.displayName || docsModule.default?.componentDisplayName
     });
   }
   isFormatSupported(format) {

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

@@ -1 +1 @@
-{"version":3,"names":["_path","data","require","_docsEntities","_defineProperty","obj","key","value","_toPropertyKey","Object","defineProperty","enumerable","configurable","writable","t","i","_toPrimitive","String","r","e","Symbol","toPrimitive","call","TypeError","Number","DefaultDocReader","constructor","pkg","compiler","workspace","read","path","contents","component","_docsModule$default","_docsModule$default2","_docsModule$default3","packageName","getPackageName","distPath","getDistPathBySrcPath","docsModule","resolve","Doc","from","labels","default","description","abstract","displayName","componentDisplayName","isFormatSupported","format","supportedExtensions","includes","exports"],"sources":["default-doc-reader.ts"],"sourcesContent":["import { resolve } from 'path';\nimport type { PkgMain } from '@teambit/pkg';\nimport type { Component } from '@teambit/component';\nimport type { CompilerMain } from '@teambit/compiler';\nimport type { Workspace } from '@teambit/workspace';\nimport { Doc } from '@teambit/docs.entities.doc';\nimport { DocReader } from './doc-reader';\n\nexport class DefaultDocReader implements DocReader {\n  constructor(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"],"mappings":";;;;;;AAAA,SAAAA,MAAA;EAAA,MAAAC,IAAA,GAAAC,OAAA;EAAAF,KAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAKA,SAAAE,cAAA;EAAA,MAAAF,IAAA,GAAAC,OAAA;EAAAC,aAAA,YAAAA,CAAA;IAAA,OAAAF,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAAiD,SAAAG,gBAAAC,GAAA,EAAAC,GAAA,EAAAC,KAAA,IAAAD,GAAA,GAAAE,cAAA,CAAAF,GAAA,OAAAA,GAAA,IAAAD,GAAA,IAAAI,MAAA,CAAAC,cAAA,CAAAL,GAAA,EAAAC,GAAA,IAAAC,KAAA,EAAAA,KAAA,EAAAI,UAAA,QAAAC,YAAA,QAAAC,QAAA,oBAAAR,GAAA,CAAAC,GAAA,IAAAC,KAAA,WAAAF,GAAA;AAAA,SAAAG,eAAAM,CAAA,QAAAC,CAAA,GAAAC,YAAA,CAAAF,CAAA,uCAAAC,CAAA,GAAAA,CAAA,GAAAE,MAAA,CAAAF,CAAA;AAAA,SAAAC,aAAAF,CAAA,EAAAI,CAAA,2BAAAJ,CAAA,KAAAA,CAAA,SAAAA,CAAA,MAAAK,CAAA,GAAAL,CAAA,CAAAM,MAAA,CAAAC,WAAA,kBAAAF,CAAA,QAAAJ,CAAA,GAAAI,CAAA,CAAAG,IAAA,CAAAR,CAAA,EAAAI,CAAA,uCAAAH,CAAA,SAAAA,CAAA,YAAAQ,SAAA,yEAAAL,CAAA,GAAAD,MAAA,GAAAO,MAAA,EAAAV,CAAA;AAG1C,MAAMW,gBAAgB,CAAsB;EACjDC,WAAWA,CAASC,GAAY,EAAUC,QAAsB,EAAUC,SAAoB,EAAE;IAAA,KAA5EF,GAAY,GAAZA,GAAY;IAAA,KAAUC,QAAsB,GAAtBA,QAAsB;IAAA,KAAUC,SAAoB,GAApBA,SAAoB;IAAAzB,eAAA,8BAc/D,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC;EAdoC;EAEjG,MAAM0B,IAAIA,CAACC,IAAY,EAAEC,QAAgB,EAAEC,SAAoB,EAAE;IAAA,IAAAC,mBAAA,EAAAC,oBAAA,EAAAC,oBAAA;IAC/D,MAAMC,WAAW,GAAG,IAAI,CAACV,GAAG,CAACW,cAAc,CAACL,SAAS,CAAC;IACtD,MAAMM,QAAQ,GAAG,IAAI,CAACX,QAAQ,CAACY,oBAAoB,CAACP,SAAS,EAAEF,IAAI,CAAC;IACpE;IACA,MAAMU,UAAU,GAAGvC,OAAO,CAAC,IAAAwC,eAAO,EAAE,GAAE,IAAI,CAACb,SAAS,CAACE,IAAK,iBAAgBM,WAAY,IAAGE,QAAS,EAAC,CAAC,CAAC;IACrG,OAAOI,mBAAG,CAACC,IAAI,CAACb,IAAI,EAAE;MACpBc,MAAM,EAAEJ,UAAU,CAACI,MAAM,MAAAX,mBAAA,GAAIO,UAAU,CAACK,OAAO,cAAAZ,mBAAA,uBAAlBA,mBAAA,CAAoBW,MAAM;MACvDE,WAAW,EAAEN,UAAU,CAACO,QAAQ,MAAAb,oBAAA,GAAIM,UAAU,CAACK,OAAO,cAAAX,oBAAA,uBAAlBA,oBAAA,CAAoBa,QAAQ,KAAIP,UAAU,CAACM,WAAW;MAC1FE,WAAW,EAAER,UAAU,CAACQ,WAAW,MAAAb,oBAAA,GAAIK,UAAU,CAACK,OAAO,cAAAV,oBAAA,uBAAlBA,oBAAA,CAAoBc,oBAAoB;IACjF,CAAC,CAAC;EACJ;EAIAC,iBAAiBA,CAACC,MAAc,EAAE;IAChC,OAAO,IAAI,CAACC,mBAAmB,CAACC,QAAQ,CAACF,MAAM,CAAC;EAClD;AACF;AAACG,OAAA,CAAA9B,gBAAA,GAAAA,gBAAA"}
+{"version":3,"names":["_path","data","require","_docsEntities","_defineProperty","obj","key","value","_toPropertyKey","Object","defineProperty","enumerable","configurable","writable","t","i","_toPrimitive","String","r","e","Symbol","toPrimitive","call","TypeError","Number","DefaultDocReader","constructor","pkg","compiler","workspace","read","path","contents","component","packageName","getPackageName","distPath","getDistPathBySrcPath","docsModule","resolve","Doc","from","labels","default","description","abstract","displayName","componentDisplayName","isFormatSupported","format","supportedExtensions","includes","exports"],"sources":["default-doc-reader.ts"],"sourcesContent":["import { resolve } from 'path';\nimport type { PkgMain } from '@teambit/pkg';\nimport type { Component } from '@teambit/component';\nimport type { CompilerMain } from '@teambit/compiler';\nimport type { Workspace } from '@teambit/workspace';\nimport { Doc } from '@teambit/docs.entities.doc';\nimport { DocReader } from './doc-reader';\n\nexport class DefaultDocReader implements DocReader {\n  constructor(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"],"mappings":";;;;;;AAAA,SAAAA,MAAA;EAAA,MAAAC,IAAA,GAAAC,OAAA;EAAAF,KAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAKA,SAAAE,cAAA;EAAA,MAAAF,IAAA,GAAAC,OAAA;EAAAC,aAAA,YAAAA,CAAA;IAAA,OAAAF,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAAiD,SAAAG,gBAAAC,GAAA,EAAAC,GAAA,EAAAC,KAAA,IAAAD,GAAA,GAAAE,cAAA,CAAAF,GAAA,OAAAA,GAAA,IAAAD,GAAA,IAAAI,MAAA,CAAAC,cAAA,CAAAL,GAAA,EAAAC,GAAA,IAAAC,KAAA,EAAAA,KAAA,EAAAI,UAAA,QAAAC,YAAA,QAAAC,QAAA,oBAAAR,GAAA,CAAAC,GAAA,IAAAC,KAAA,WAAAF,GAAA;AAAA,SAAAG,eAAAM,CAAA,QAAAC,CAAA,GAAAC,YAAA,CAAAF,CAAA,uCAAAC,CAAA,GAAAA,CAAA,GAAAE,MAAA,CAAAF,CAAA;AAAA,SAAAC,aAAAF,CAAA,EAAAI,CAAA,2BAAAJ,CAAA,KAAAA,CAAA,SAAAA,CAAA,MAAAK,CAAA,GAAAL,CAAA,CAAAM,MAAA,CAAAC,WAAA,kBAAAF,CAAA,QAAAJ,CAAA,GAAAI,CAAA,CAAAG,IAAA,CAAAR,CAAA,EAAAI,CAAA,uCAAAH,CAAA,SAAAA,CAAA,YAAAQ,SAAA,yEAAAL,CAAA,GAAAD,MAAA,GAAAO,MAAA,EAAAV,CAAA;AAG1C,MAAMW,gBAAgB,CAAsB;EACjDC,WAAWA,CAASC,GAAY,EAAUC,QAAsB,EAAUC,SAAoB,EAAE;IAAA,KAA5EF,GAAY,GAAZA,GAAY;IAAA,KAAUC,QAAsB,GAAtBA,QAAsB;IAAA,KAAUC,SAAoB,GAApBA,SAAoB;IAAAzB,eAAA,8BAc/D,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC;EAdoC;EAEjG,MAAM0B,IAAIA,CAACC,IAAY,EAAEC,QAAgB,EAAEC,SAAoB,EAAE;IAC/D,MAAMC,WAAW,GAAG,IAAI,CAACP,GAAG,CAACQ,cAAc,CAACF,SAAS,CAAC;IACtD,MAAMG,QAAQ,GAAG,IAAI,CAACR,QAAQ,CAACS,oBAAoB,CAACJ,SAAS,EAAEF,IAAI,CAAC;IACpE;IACA,MAAMO,UAAU,GAAGpC,OAAO,CAAC,IAAAqC,eAAO,EAAE,GAAE,IAAI,CAACV,SAAS,CAACE,IAAK,iBAAgBG,WAAY,IAAGE,QAAS,EAAC,CAAC,CAAC;IACrG,OAAOI,mBAAG,CAACC,IAAI,CAACV,IAAI,EAAE;MACpBW,MAAM,EAAEJ,UAAU,CAACI,MAAM,IAAIJ,UAAU,CAACK,OAAO,EAAED,MAAM;MACvDE,WAAW,EAAEN,UAAU,CAACO,QAAQ,IAAIP,UAAU,CAACK,OAAO,EAAEE,QAAQ,IAAIP,UAAU,CAACM,WAAW;MAC1FE,WAAW,EAAER,UAAU,CAACQ,WAAW,IAAIR,UAAU,CAACK,OAAO,EAAEI;IAC7D,CAAC,CAAC;EACJ;EAIAC,iBAAiBA,CAACC,MAAc,EAAE;IAChC,OAAO,IAAI,CAACC,mBAAmB,CAACC,QAAQ,CAACF,MAAM,CAAC;EAClD;AACF;AAACG,OAAA,CAAA3B,gBAAA,GAAAA,gBAAA"}

package/dist/doc-module.js

@@ -18,8 +18,7 @@ class DocModule {
    * get the abstract.
    */
   get abstract() {
-    var _this$module$default;
-    return this.module.abstract || ((_this$module$default = this.module.default) === null || _this$module$default === void 0 ? void 0 : _this$module$default.abstract);
+    return this.module.abstract || this.module.default?.abstract;
   }
 }
 exports.DocModule = DocModule;

package/dist/doc-module.js.map

@@ -1 +1 @@
-{"version":3,"names":["DocModule","constructor","path","module","abstract","_this$module$default","default","exports"],"sources":["doc-module.ts"],"sourcesContent":["export class DocModule {\n  constructor(\n    readonly path: string,\n\n    /**\n     * original doc module.\n     */\n    readonly module: any\n  ) {}\n\n  /**\n   * get the abstract.\n   */\n  get abstract() {\n    return this.module.abstract || this.module.default?.abstract;\n  }\n}\n"],"mappings":";;;;;;AAAO,MAAMA,SAAS,CAAC;EACrBC,WAAWA,CACAC,IAAY;EAErB;AACJ;AACA;EACaC,MAAW,EACpB;IAAA,KANSD,IAAY,GAAZA,IAAY;IAAA,KAKZC,MAAW,GAAXA,MAAW;EACnB;;EAEH;AACF;AACA;EACE,IAAIC,QAAQA,CAAA,EAAG;IAAA,IAAAC,oBAAA;IACb,OAAO,IAAI,CAACF,MAAM,CAACC,QAAQ,MAAAC,oBAAA,GAAI,IAAI,CAACF,MAAM,CAACG,OAAO,cAAAD,oBAAA,uBAAnBA,oBAAA,CAAqBD,QAAQ;EAC9D;AACF;AAACG,OAAA,CAAAP,SAAA,GAAAA,SAAA"}
+{"version":3,"names":["DocModule","constructor","path","module","abstract","default","exports"],"sources":["doc-module.ts"],"sourcesContent":["export class DocModule {\n  constructor(\n    readonly path: string,\n\n    /**\n     * original doc module.\n     */\n    readonly module: any\n  ) {}\n\n  /**\n   * get the abstract.\n   */\n  get abstract() {\n    return this.module.abstract || this.module.default?.abstract;\n  }\n}\n"],"mappings":";;;;;;AAAO,MAAMA,SAAS,CAAC;EACrBC,WAAWA,CACAC,IAAY;EAErB;AACJ;AACA;EACaC,MAAW,EACpB;IAAA,KANSD,IAAY,GAAZA,IAAY;IAAA,KAKZC,MAAW,GAAXA,MAAW;EACnB;;EAEH;AACF;AACA;EACE,IAAIC,QAAQA,CAAA,EAAG;IACb,OAAO,IAAI,CAACD,MAAM,CAACC,QAAQ,IAAI,IAAI,CAACD,MAAM,CAACE,OAAO,EAAED,QAAQ;EAC9D;AACF;AAACE,OAAA,CAAAN,SAAA,GAAAA,SAAA"}

package/dist/docs.composition.d.ts

@@ -1,2 +1,2 @@
-import React from 'react';
-export declare const Logo: () => React.JSX.Element;
+/// <reference types="react" />
+export declare const Logo: () => JSX.Element;

package/dist/docs.d.ts

@@ -1,5 +1,5 @@
 import React, { ReactElement } from 'react';
-export declare type Example = {
+export type Example = {
     title?: string;
     description?: ReactElement;
     scope?: {
@@ -8,7 +8,7 @@ export declare type Example = {
     jsx?: JSX.Element;
     code: string;
 };
-export declare type Docs = {
+export type Docs = {
     /**
      * default is the docs content.
      */

package/dist/docs.graphql.js

@@ -27,7 +27,7 @@ function docsSchema(docs) {
         },
         labels: component => {
           const doc = docs.getDoc(component);
-          return (doc === null || doc === void 0 ? void 0 : doc.labels) || [];
+          return doc?.labels || [];
         }
       }
     }

package/dist/docs.graphql.js.map

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

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

@@ -13,14 +13,14 @@ import { Workspace } from '@teambit/workspace';
 import { Doc } from '@teambit/docs.entities.doc';
 import { EnvsMain } from '@teambit/envs';
 import { DocReader } from './doc-reader';
-export declare type ComponentDocs = {
+export type ComponentDocs = {
     files: string[];
     component: Component;
 };
-export declare type DocProp = {};
-export declare type DocPropSlot = SlotRegistry<DocProp>;
-export declare type DocReaderSlot = SlotRegistry<DocReader>;
-export declare type DocsConfig = {
+export type DocProp = {};
+export type DocPropSlot = SlotRegistry<DocProp>;
+export type DocReaderSlot = SlotRegistry<DocReader>;
+export type DocsConfig = {
     /**
      * glob patterns to identify doc files.
      */
@@ -58,21 +58,18 @@ export declare class DocsMain {
      */
     getDescription(component: Component): Promise<string>;
     getTemplate(env: Environment): Promise<string | undefined>;
-    getDocReader(extension: string): DocReader | undefined;
+    getDocReader(extension: string): DocReader;
     /**
      * compute a doc for a component.
      */
-    computeDoc(component: Component): Promise<Doc | null>;
-    getDoc(component: IComponent): Doc | null;
+    computeDoc(component: Component): Promise<Doc>;
+    getDoc(component: IComponent): Doc;
     getPatterns(): string[];
     getComponentDevPatterns(component: Component): {
         name: string;
         pattern: string[];
     };
-    getDevPatternToRegister(): (component: Component) => {
-        name: string;
-        pattern: string[];
-    };
+    getDevPatternToRegister(): any;
     /**
      * register a new doc reader. this allows to support further
      * documentation file formats.

package/dist/docs.main.runtime.js

@@ -181,7 +181,7 @@ class DocsMain {
    */
   async getDescription(component) {
     const componentDoc = this.getDoc(component);
-    const desc = componentDoc === null || componentDoc === void 0 ? void 0 : componentDoc.description;
+    const desc = componentDoc?.description;
     return desc || '';
   }
   async getTemplate(env) {
@@ -216,8 +216,7 @@ class DocsMain {
     return null;
   }
   getDoc(component) {
-    var _component$get;
-    const docData = (_component$get = component.get(_docs().DocsAspect.id)) === null || _component$get === void 0 || (_component$get = _component$get.data) === null || _component$get === void 0 ? void 0 : _component$get.doc;
+    const docData = component.get(_docs().DocsAspect.id)?.data?.doc;
     if (!docData) return null;
     return new (_docsEntities().Doc)(docData.filePath, new (_docsEntities().DocPropList)(docData.props));
   }
@@ -225,9 +224,8 @@ class DocsMain {
     return this.patterns;
   }
   getComponentDevPatterns(component) {
-    var _this$workspace;
     const env = this.envs.calculateEnv(component, {
-      skipWarnings: !!((_this$workspace = this.workspace) !== null && _this$workspace !== void 0 && _this$workspace.inInstallContext)
+      skipWarnings: !!this.workspace?.inInstallContext
     }).env;
     const componentEnvDocsDevPatterns = env.getDocsDevPatterns ? env.getDocsDevPatterns(component) : [];
     const componentPatterns = componentEnvDocsDevPatterns.concat(this.getPatterns());
@@ -253,11 +251,11 @@ class DocsMain {
     docs.registerDocReader(new (_defaultDocReader().DefaultDocReader)(pkg, compiler, workspace));
     devFiles.registerDevPattern(docs.getDevPatternToRegister());
     const computeDocsOnLoad = async (component, opts) => {
-      if ((opts === null || opts === void 0 ? void 0 : opts.loadDocs) === false) return undefined;
+      if (opts?.loadDocs === false) return undefined;
       // const docFiles = await docs.computeDocs(component);
       const doc = await docs.computeDoc(component);
       return {
-        doc: doc === null || doc === void 0 ? void 0 : doc.toObject()
+        doc: doc?.toObject()
         // docFiles
       };
     };

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

@@ -1 +1 @@
-{"version":3,"names":["_harmony","data","require","_cli","_logger","_compiler","_component","_scope","_interopRequireDefault","_pkg","_graphql","_preview","_devFiles","_workspace","_docsEntities","_lodash","_envs","_docs","_docs2","_docs3","_defaultDocReader","_exceptions","obj","__esModule","default","_defineProperty","key","value","_toPropertyKey","Object","defineProperty","enumerable","configurable","writable","t","i","_toPrimitive","String","r","e","Symbol","toPrimitive","call","TypeError","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","_component$get","docData","Doc","filePath","DocPropList","props","getPatterns","getComponentDevPatterns","_this$workspace","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,GAAAO,sBAAA,CAAAN,OAAA;EAAAK,MAAA,YAAAA,CAAA;IAAA,OAAAN,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAQ,KAAA;EAAA,MAAAR,IAAA,GAAAC,OAAA;EAAAO,IAAA,YAAAA,CAAA;IAAA,OAAAR,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAS,SAAA;EAAA,MAAAT,IAAA,GAAAC,OAAA;EAAAQ,QAAA,YAAAA,CAAA;IAAA,OAAAT,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAU,SAAA;EAAA,MAAAV,IAAA,GAAAC,OAAA;EAAAS,QAAA,YAAAA,CAAA;IAAA,OAAAV,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAW,UAAA;EAAA,MAAAX,IAAA,GAAAO,sBAAA,CAAAN,OAAA;EAAAU,SAAA,YAAAA,CAAA;IAAA,OAAAX,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAGA,SAAAY,WAAA;EAAA,MAAAZ,IAAA,GAAAC,OAAA;EAAAW,UAAA,YAAAA,CAAA;IAAA,OAAAZ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAa,cAAA;EAAA,MAAAb,IAAA,GAAAC,OAAA;EAAAY,aAAA,YAAAA,CAAA;IAAA,OAAAb,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAc,QAAA;EAAA,MAAAd,IAAA,GAAAC,OAAA;EAAAa,OAAA,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,MAAA;EAAA,MAAAhB,IAAA,GAAAC,OAAA;EAAAe,KAAA,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;AACA,SAAAkB,OAAA;EAAA,MAAAlB,IAAA,GAAAC,OAAA;EAAAiB,MAAA,YAAAA,CAAA;IAAA,OAAAlB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAmB,kBAAA;EAAA,MAAAnB,IAAA,GAAAC,OAAA;EAAAkB,iBAAA,YAAAA,CAAA;IAAA,OAAAnB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAoB,YAAA;EAAA,MAAApB,IAAA,GAAAC,OAAA;EAAAmB,WAAA,YAAAA,CAAA;IAAA,OAAApB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAAyD,SAAAO,uBAAAc,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,KAAAE,OAAA,EAAAF,GAAA;AAAA,SAAAG,gBAAAH,GAAA,EAAAI,GAAA,EAAAC,KAAA,IAAAD,GAAA,GAAAE,cAAA,CAAAF,GAAA,OAAAA,GAAA,IAAAJ,GAAA,IAAAO,MAAA,CAAAC,cAAA,CAAAR,GAAA,EAAAI,GAAA,IAAAC,KAAA,EAAAA,KAAA,EAAAI,UAAA,QAAAC,YAAA,QAAAC,QAAA,oBAAAX,GAAA,CAAAI,GAAA,IAAAC,KAAA,WAAAL,GAAA;AAAA,SAAAM,eAAAM,CAAA,QAAAC,CAAA,GAAAC,YAAA,CAAAF,CAAA,uCAAAC,CAAA,GAAAA,CAAA,GAAAE,MAAA,CAAAF,CAAA;AAAA,SAAAC,aAAAF,CAAA,EAAAI,CAAA,2BAAAJ,CAAA,KAAAA,CAAA,SAAAA,CAAA,MAAAK,CAAA,GAAAL,CAAA,CAAAM,MAAA,CAAAC,WAAA,kBAAAF,CAAA,QAAAJ,CAAA,GAAAI,CAAA,CAAAG,IAAA,CAAAR,CAAA,EAAAI,CAAA,uCAAAH,CAAA,SAAAA,CAAA,YAAAQ,SAAA,yEAAAL,CAAA,GAAAD,MAAA,GAAAO,MAAA,EAAAV,CAAA;AAoBzD;AACA;AACA;AACO,MAAMW,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,aAAZA,YAAY,uBAAZA,YAAY,CAAEG,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,CAAE,iDAAgDD,GAAG,CAACE,OAAQ,EAAC,CAAC;QACjF,OAAO,IAAI;MACb;IACF;IAEA,OAAO,IAAI;EACb;EAEAxB,MAAMA,CAAChB,SAAqB,EAAE;IAAA,IAAAyC,cAAA;IAC5B,MAAMC,OAAO,IAAAD,cAAA,GAAGzC,SAAS,CAACI,GAAG,CAACC,kBAAU,CAACC,EAAE,CAAC,cAAAmC,cAAA,gBAAAA,cAAA,GAA5BA,cAAA,CAA8BrG,IAAI,cAAAqG,cAAA,uBAAlCA,cAAA,CAAoCN,GAAG;IACvD,IAAI,CAACO,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,CAAC7D,QAAQ;EACtB;EAEA8D,uBAAuBA,CAAChD,SAAoB,EAAE;IAAA,IAAAiD,eAAA;IAC5C,MAAM7B,GAAG,GAAG,IAAI,CAAC3B,IAAI,CAACyD,YAAY,CAAClD,SAAS,EAAE;MAAEmD,YAAY,EAAE,CAAC,GAAAF,eAAA,GAAC,IAAI,CAAC3D,SAAS,cAAA2D,eAAA,eAAdA,eAAA,CAAgBG,gBAAgB;IAAC,CAAC,CAAC,CAAChC,GAAG;IACvG,MAAMiC,2BAAqC,GAAGjC,GAAG,CAACkC,kBAAkB,GAAGlC,GAAG,CAACkC,kBAAkB,CAACtD,SAAS,CAAC,GAAG,EAAE;IAC7G,MAAMuD,iBAAiB,GAAGF,2BAA2B,CAACG,MAAM,CAAC,IAAI,CAACT,WAAW,CAAC,CAAC,CAAC;IAChF,OAAO;MAAEU,IAAI,EAAE,MAAM;MAAEC,OAAO,EAAEH;IAAkB,CAAC;EACrD;EAEAI,uBAAuBA,CAAA,EAAG;IACxB,OAAO,IAAI,CAACX,uBAAuB,CAACY,IAAI,CAAC,IAAI,CAAC;EAChD;EACA;AACF;AACA;AACA;EACEC,iBAAiBA,CAACjC,SAAoB,EAAE;IACtC,IAAI,CAACjC,aAAa,CAACmE,QAAQ,CAAClC,SAAS,CAAC;IACtC,OAAO,IAAI;EACb;EAqBA,aAAamC,QAAQA,CACnB,CAAC5E,OAAO,EAAE6E,OAAO,EAAE1E,SAAS,EAAEF,GAAG,EAAEC,QAAQ,EAAE4E,YAAY,EAAEzE,QAAQ,EAAEC,IAAI,EAAEyE,KAAK,CAU/E,EACDC,MAAkB,EAClB,CAACzE,WAAW,EAAEC,aAAa,CAA+B,EAC1D;IACA,MAAMJ,MAAM,GAAG0E,YAAY,CAACG,YAAY,CAAC/D,kBAAU,CAACC,EAAE,CAAC;IACvD,MAAM+D,IAAI,GAAG,IAAIrF,QAAQ,CACvBmF,MAAM,CAACjF,QAAQ,EACfC,OAAO,EACPC,GAAG,EACHC,QAAQ,EACRC,SAAS,EACTC,MAAM,EACNC,QAAQ,EACRC,IAAI,EACJC,WAAW,EACXC,aACF,CAAC;IACD0E,IAAI,CAACR,iBAAiB,CAAC,KAAIS,oCAAgB,EAAClF,GAAG,EAAEC,QAAQ,EAAEC,SAAS,CAAC,CAAC;IACtEE,QAAQ,CAAC+E,kBAAkB,CAACF,IAAI,CAACV,uBAAuB,CAAC,CAAC,CAAC;IAE3D,MAAMa,iBAAiB,GAAG,MAAAA,CAAOxE,SAAoB,EAAEyE,IAA2B,KAAK;MACrF,IAAI,CAAAA,IAAI,aAAJA,IAAI,uBAAJA,IAAI,CAAEC,QAAQ,MAAK,KAAK,EAAE,OAAOnD,SAAS;MAC9C;MACA,MAAMY,GAAG,GAAG,MAAMkC,IAAI,CAACvC,UAAU,CAAC9B,SAAS,CAAC;MAE5C,OAAO;QACLmC,GAAG,EAAEA,GAAG,aAAHA,GAAG,uBAAHA,GAAG,CAAEwC,QAAQ,CAAC;QACnB;MACF,CAAC;IACH,CAAC;IAED,IAAIrF,SAAS,EAAE;MACbA,SAAS,CAACsF,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;IAElClF,OAAO,CAAC4F,kBAAkB,CAAC,KAAIC,8BAAqB,EAACX,IAAI,CAAC,CAAC;IAC3D,OAAOA,IAAI;EACb;AACF;AAACY,OAAA,CAAAjG,QAAA,GAAAA,QAAA;AAAApB,eAAA,CA1LYoB,QAAQ,WAiHJ,CAACkG,eAAI,CAACC,QAAQ,CAAU,CAAC,EAAED,eAAI,CAACC,QAAQ,CAAY,CAAC,CAAC;AAAAvH,eAAA,CAjH1DoB,QAAQ,aAmHFoG,kBAAW;AAAAxH,eAAA,CAnHjBoB,QAAQ,kBAoHG,CACpBqG,wBAAa,EACbC,wBAAa,EACbC,4BAAe,EACfC,gBAAS,EACTC,0BAAc,EACdC,sBAAY,EACZC,mBAAc,EACdC,kBAAU,EACVC,gBAAW,CACZ;AAAAjI,eAAA,CA9HUoB,QAAQ,mBAgII;EACrBE,QAAQ,EAAE,CAAC,aAAa;AAC1B,CAAC;AA0DHmB,kBAAU,CAACyF,UAAU,CAAC9G,QAAQ,CAAC"}
+{"version":3,"names":["_harmony","data","require","_cli","_logger","_compiler","_component","_scope","_interopRequireDefault","_pkg","_graphql","_preview","_devFiles","_workspace","_docsEntities","_lodash","_envs","_docs","_docs2","_docs3","_defaultDocReader","_exceptions","obj","__esModule","default","_defineProperty","key","value","_toPropertyKey","Object","defineProperty","enumerable","configurable","writable","t","i","_toPrimitive","String","r","e","Symbol","toPrimitive","call","TypeError","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,GAAAO,sBAAA,CAAAN,OAAA;EAAAK,MAAA,YAAAA,CAAA;IAAA,OAAAN,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAQ,KAAA;EAAA,MAAAR,IAAA,GAAAC,OAAA;EAAAO,IAAA,YAAAA,CAAA;IAAA,OAAAR,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAS,SAAA;EAAA,MAAAT,IAAA,GAAAC,OAAA;EAAAQ,QAAA,YAAAA,CAAA;IAAA,OAAAT,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAU,SAAA;EAAA,MAAAV,IAAA,GAAAC,OAAA;EAAAS,QAAA,YAAAA,CAAA;IAAA,OAAAV,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAW,UAAA;EAAA,MAAAX,IAAA,GAAAO,sBAAA,CAAAN,OAAA;EAAAU,SAAA,YAAAA,CAAA;IAAA,OAAAX,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAGA,SAAAY,WAAA;EAAA,MAAAZ,IAAA,GAAAC,OAAA;EAAAW,UAAA,YAAAA,CAAA;IAAA,OAAAZ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAa,cAAA;EAAA,MAAAb,IAAA,GAAAC,OAAA;EAAAY,aAAA,YAAAA,CAAA;IAAA,OAAAb,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAc,QAAA;EAAA,MAAAd,IAAA,GAAAC,OAAA;EAAAa,OAAA,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,MAAA;EAAA,MAAAhB,IAAA,GAAAC,OAAA;EAAAe,KAAA,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;AACA,SAAAkB,OAAA;EAAA,MAAAlB,IAAA,GAAAC,OAAA;EAAAiB,MAAA,YAAAA,CAAA;IAAA,OAAAlB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAmB,kBAAA;EAAA,MAAAnB,IAAA,GAAAC,OAAA;EAAAkB,iBAAA,YAAAA,CAAA;IAAA,OAAAnB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAoB,YAAA;EAAA,MAAApB,IAAA,GAAAC,OAAA;EAAAmB,WAAA,YAAAA,CAAA;IAAA,OAAApB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAAyD,SAAAO,uBAAAc,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,KAAAE,OAAA,EAAAF,GAAA;AAAA,SAAAG,gBAAAH,GAAA,EAAAI,GAAA,EAAAC,KAAA,IAAAD,GAAA,GAAAE,cAAA,CAAAF,GAAA,OAAAA,GAAA,IAAAJ,GAAA,IAAAO,MAAA,CAAAC,cAAA,CAAAR,GAAA,EAAAI,GAAA,IAAAC,KAAA,EAAAA,KAAA,EAAAI,UAAA,QAAAC,YAAA,QAAAC,QAAA,oBAAAX,GAAA,CAAAI,GAAA,IAAAC,KAAA,WAAAL,GAAA;AAAA,SAAAM,eAAAM,CAAA,QAAAC,CAAA,GAAAC,YAAA,CAAAF,CAAA,uCAAAC,CAAA,GAAAA,CAAA,GAAAE,MAAA,CAAAF,CAAA;AAAA,SAAAC,aAAAF,CAAA,EAAAI,CAAA,2BAAAJ,CAAA,KAAAA,CAAA,SAAAA,CAAA,MAAAK,CAAA,GAAAL,CAAA,CAAAM,MAAA,CAAAC,WAAA,kBAAAF,CAAA,QAAAJ,CAAA,GAAAI,CAAA,CAAAG,IAAA,CAAAR,CAAA,EAAAI,CAAA,uCAAAH,CAAA,SAAAA,CAAA,YAAAQ,SAAA,yEAAAL,CAAA,GAAAD,MAAA,GAAAO,MAAA,EAAAV,CAAA;AAoBzD;AACA;AACA;AACO,MAAMW,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,CAAE,iDAAgDD,GAAG,CAACE,OAAQ,EAAC,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,EAAElE,IAAI,EAAE+F,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;AAAApB,eAAA,CA1LYoB,QAAQ,WAiHJ,CAACgG,eAAI,CAACC,QAAQ,CAAU,CAAC,EAAED,eAAI,CAACC,QAAQ,CAAY,CAAC,CAAC;AAAArH,eAAA,CAjH1DoB,QAAQ,aAmHFkG,kBAAW;AAAAtH,eAAA,CAnHjBoB,QAAQ,kBAoHG,CACpBmG,wBAAa,EACbC,wBAAa,EACbC,4BAAe,EACfC,gBAAS,EACTC,0BAAc,EACdC,sBAAY,EACZC,mBAAc,EACdC,kBAAU,EACVC,gBAAW,CACZ;AAAA/H,eAAA,CA9HUoB,QAAQ,mBAgII;EACrBE,QAAQ,EAAE,CAAC,aAAa;AAC1B,CAAC;AA0DHmB,kBAAU,CAACuF,UAAU,CAAC5G,QAAQ,CAAC"}

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

@@ -2,7 +2,7 @@ import React from 'react';
 import { RenderingContext, PreviewPreview, PreviewModule } from '@teambit/preview';
 import { ComponentID } from '@teambit/component-id';
 import type { Docs } from './docs';
-export declare type DocsRootProps = {
+export type DocsRootProps = {
     Provider: React.ComponentType | undefined;
     componentId: string;
     docs: Docs | undefined;
@@ -20,7 +20,7 @@ export declare class DocsPreview {
      */
     preview: PreviewPreview);
     render: (componentId: ComponentID, envId: string, modules: PreviewModule, [compositions]: [any], context: RenderingContext) => void;
-    selectPreviewModel(componentId: string, modules: PreviewModule): import("@teambit/preview").ModuleFile<any> | undefined;
+    selectPreviewModel(componentId: string, modules: PreviewModule): import("@teambit/preview").ModuleFile<any>;
     static runtime: import("@teambit/harmony").RuntimeDefinition;
     static dependencies: import("@teambit/harmony").Aspect[];
     static provider([preview]: [PreviewPreview]): Promise<DocsPreview>;

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

@@ -15,9 +15,9 @@ export declare class DocsUI {
      */
     listTitleBadges(): TitleBadge[];
     private _emptyState?;
-    registerEmptyState(emptyState: ComponentType): React.ComponentType<{}>;
-    getEmptyState(): React.ComponentType<{}> | undefined;
-    getDocsCompare(): React.JSX.Element;
+    registerEmptyState(emptyState: ComponentType): React.ComponentType;
+    getEmptyState(): React.ComponentType;
+    getDocsCompare(): JSX.Element;
     registerOverviewOptions(options: OverviewOptions): void;
     static dependencies: import("@teambit/harmony").Aspect[];
     static runtime: import("@teambit/harmony").RuntimeDefinition;

package/dist/overview/overview.d.ts

@@ -1,4 +1,4 @@
-import React, { ComponentType } from 'react';
+import { ComponentType } from 'react';
 import type { SlotRegistry } from '@teambit/harmony';
 import { ComponentPreviewProps } from '@teambit/preview.ui.component-preview';
 export declare enum BadgePosition {
@@ -7,20 +7,20 @@ export declare enum BadgePosition {
     Labels = 2,
     Package = 3
 }
-export declare type TitleBadge = {
+export type TitleBadge = {
     component: ComponentType<any>;
     weight?: number;
     position?: BadgePosition;
 };
-export declare type TitleBadgeSlot = SlotRegistry<TitleBadge[]>;
-export declare type OverviewOptions = () => {
+export type TitleBadgeSlot = SlotRegistry<TitleBadge[]>;
+export type OverviewOptions = () => {
     queryParams?: string;
 };
-export declare type OverviewOptionsSlot = SlotRegistry<OverviewOptions>;
-export declare type OverviewProps = {
+export type OverviewOptionsSlot = SlotRegistry<OverviewOptions>;
+export type OverviewProps = {
     titleBadges: TitleBadgeSlot;
     overviewOptions: OverviewOptionsSlot;
     previewProps?: Partial<ComponentPreviewProps>;
     getEmptyState?: () => ComponentType | undefined;
 };
-export declare function Overview({ titleBadges, overviewOptions, previewProps, getEmptyState }: OverviewProps): React.JSX.Element;
+export declare function Overview({ titleBadges, overviewOptions, previewProps, getEmptyState }: OverviewProps): JSX.Element;

package/dist/overview/overview.js

@@ -97,20 +97,19 @@ function Overview({
   previewProps,
   getEmptyState
 }) {
-  var _component$preview, _component$buildStatu, _component$preview2, _component$preview3, _component$preview4, _component$preview5, _component$preview6;
   const component = (0, _react().useContext)(_component().ComponentContext);
   const componentDescriptor = (0, _component().useComponentDescriptor)();
   const overviewProps = (0, _lodash().flatten)(overviewOptions.values())[0];
-  const showHeader = !((_component$preview = component.preview) !== null && _component$preview !== void 0 && _component$preview.legacyHeader);
+  const showHeader = !component.preview?.legacyHeader;
   const EmptyState = getEmptyState && getEmptyState();
-  const buildFailed = ((_component$buildStatu = component.buildStatus) === null || _component$buildStatu === void 0 ? void 0 : _component$buildStatu.toLowerCase()) !== 'succeed' && (component === null || component === void 0 ? void 0 : component.host) === 'teambit.scope/scope';
-  const isScaling = Boolean((_component$preview2 = component.preview) === null || _component$preview2 === void 0 ? void 0 : _component$preview2.isScaling);
-  const includesEnvTemplate = Boolean((_component$preview3 = component.preview) === null || _component$preview3 === void 0 ? void 0 : _component$preview3.includesEnvTemplate);
+  const buildFailed = component.buildStatus?.toLowerCase() !== 'succeed' && component?.host === 'teambit.scope/scope';
+  const isScaling = Boolean(component.preview?.isScaling);
+  const includesEnvTemplate = Boolean(component.preview?.includesEnvTemplate);
   const defaultLoadingState = _react().default.useMemo(() => {
     return isScaling && !includesEnvTemplate;
   }, [isScaling, includesEnvTemplate]);
   const [isLoading, setLoading] = (0, _react().useState)(defaultLoadingState);
-  const iframeQueryParams = `skipIncludes=${((_component$preview4 = component.preview) === null || _component$preview4 === void 0 ? void 0 : _component$preview4.skipIncludes) || 'false'}`;
+  const iframeQueryParams = `skipIncludes=${component.preview?.skipIncludes || 'false'}`;
   const overviewPropsValues = overviewProps && overviewProps();
 
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -122,7 +121,7 @@ function Overview({
     rest = _objectWithoutProperties(_ref, _excluded);
   const onPreviewLoad = _react().default.useCallback((e, props) => {
     setLoading(false);
-    onLoad === null || onLoad === void 0 || onLoad(e, props);
+    onLoad?.(e, props);
   }, [onLoad]);
   _react().default.useEffect(() => {
     if (!isLoading && defaultLoadingState) setLoading(true);
@@ -149,7 +148,7 @@ function Overview({
     onLoad: onPreviewLoad,
     previewName: "overview",
     pubsub: true,
-    queryParams: [iframeQueryParams, (overviewPropsValues === null || overviewPropsValues === void 0 ? void 0 : overviewPropsValues.queryParams) || ''],
+    queryParams: [iframeQueryParams, overviewPropsValues?.queryParams || ''],
     viewport: null,
     fullContentHeight: true,
     disableScroll: true
@@ -160,10 +159,10 @@ function Overview({
       height: '100%',
       minHeight: !isScaling ? 500 : undefined
     }
-  })), ((_component$preview5 = component.preview) === null || _component$preview5 === void 0 ? void 0 : _component$preview5.skipIncludes) && /*#__PURE__*/_react().default.createElement(_compositionsPanels().CompositionGallery, {
+  })), component.preview?.skipIncludes && /*#__PURE__*/_react().default.createElement(_compositionsPanels().CompositionGallery, {
     isLoading: isLoading,
     component: component
-  }), ((_component$preview6 = component.preview) === null || _component$preview6 === void 0 ? void 0 : _component$preview6.skipIncludes) && /*#__PURE__*/_react().default.createElement(_reactUiDocs().PropertiesTable, {
+  }), component.preview?.skipIncludes && /*#__PURE__*/_react().default.createElement(_reactUiDocs().PropertiesTable, {
     className: _overviewModule().default.overviewPropsTable,
     componentId: component.id.toString()
   })), buildFailed && EmptyState && /*#__PURE__*/_react().default.createElement(EmptyState, null));

package/dist/overview/overview.js.map

@@ -1 +1 @@
-{"version":3,"names":["_react","data","_interopRequireWildcard","require","_classnames","_interopRequireDefault","_lodash","_reactUiDocs","_component","_previewUi","_componentUi","_compositionsPanels","_readmeSkeleton","_overviewModule","_excluded","obj","__esModule","default","_getRequireWildcardCache","e","WeakMap","r","t","has","get","n","__proto__","a","Object","defineProperty","getOwnPropertyDescriptor","u","prototype","hasOwnProperty","call","i","set","_extends","assign","bind","target","arguments","length","source","key","apply","_objectWithoutProperties","excluded","_objectWithoutPropertiesLoose","getOwnPropertySymbols","sourceSymbolKeys","indexOf","propertyIsEnumerable","sourceKeys","keys","BadgePosition","exports","Overview","titleBadges","overviewOptions","previewProps","getEmptyState","_component$preview","_component$buildStatu","_component$preview2","_component$preview3","_component$preview4","_component$preview5","_component$preview6","component","useContext","ComponentContext","componentDescriptor","useComponentDescriptor","overviewProps","flatten","values","showHeader","preview","legacyHeader","EmptyState","buildFailed","buildStatus","toLowerCase","host","isScaling","Boolean","includesEnvTemplate","defaultLoadingState","React","useMemo","isLoading","setLoading","useState","iframeQueryParams","skipIncludes","overviewPropsValues","_ref","onLoad","style","rest","onPreviewLoad","useCallback","props","useEffect","id","toString","createElement","className","styles","overviewWrapper","ComponentOverview","classNames","componentOverviewBlock","legacyPreview","displayName","version","abstract","description","labels","packageName","readme","ReadmeSkeleton","CompositionGallerySkeleton","compositionsLength","Math","min","compositions","ComponentPreview","previewName","pubsub","queryParams","viewport","fullContentHeight","disableScroll","width","height","minHeight","undefined","CompositionGallery","PropertiesTable","overviewPropsTable","componentId"],"sources":["overview.tsx"],"sourcesContent":["import React, { useContext, ComponentType, useState } from 'react';\nimport classNames from 'classnames';\nimport { flatten } from 'lodash';\n// import { Icon } from '@teambit/design.elements.icon';\nimport { PropertiesTable } from '@teambit/react.ui.docs.properties-table';\n// import { LinkedHeading } from '@teambit/documenter.ui.linked-heading';\nimport { ComponentContext, useComponentDescriptor } from '@teambit/component';\nimport type { SlotRegistry } from '@teambit/harmony';\nimport { ComponentPreview, ComponentPreviewProps } from '@teambit/preview.ui.component-preview';\n// import { StatusMessageCard } from '@teambit/design.ui.surfaces.status-message-card';\nimport { ComponentOverview } from '@teambit/component.ui.component-meta';\nimport { CompositionGallery, CompositionGallerySkeleton } from '@teambit/compositions.panels.composition-gallery';\nimport { ReadmeSkeleton } from './readme-skeleton';\nimport styles from './overview.module.scss';\n\nexport enum BadgePosition {\n  Title,\n  SubTitle,\n  Labels,\n  Package,\n}\n\nexport type TitleBadge = {\n  component: ComponentType<any>;\n  weight?: number;\n  position?: BadgePosition;\n};\n\nexport type TitleBadgeSlot = SlotRegistry<TitleBadge[]>;\n\nexport type OverviewOptions = () => { queryParams?: string };\n\nexport type OverviewOptionsSlot = SlotRegistry<OverviewOptions>;\n\nexport type OverviewProps = {\n  titleBadges: TitleBadgeSlot;\n  overviewOptions: OverviewOptionsSlot;\n  previewProps?: Partial<ComponentPreviewProps>;\n  getEmptyState?: () => ComponentType | undefined;\n};\n\nexport function Overview({ titleBadges, overviewOptions, previewProps, getEmptyState }: OverviewProps) {\n  const component = useContext(ComponentContext);\n  const componentDescriptor = useComponentDescriptor();\n  const overviewProps = flatten(overviewOptions.values())[0];\n  const showHeader = !component.preview?.legacyHeader;\n  const EmptyState = getEmptyState && getEmptyState();\n  const buildFailed = component.buildStatus?.toLowerCase() !== 'succeed' && component?.host === 'teambit.scope/scope';\n  const isScaling = Boolean(component.preview?.isScaling);\n  const includesEnvTemplate = Boolean(component.preview?.includesEnvTemplate);\n  const defaultLoadingState = React.useMemo(() => {\n    return isScaling && !includesEnvTemplate;\n  }, [isScaling, includesEnvTemplate]);\n\n  const [isLoading, setLoading] = useState(defaultLoadingState);\n\n  const iframeQueryParams = `skipIncludes=${component.preview?.skipIncludes || 'false'}`;\n\n  const overviewPropsValues = overviewProps && overviewProps();\n\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  const { onLoad, style, ...rest } = previewProps || {};\n\n  const onPreviewLoad = React.useCallback(\n    (e, props) => {\n      setLoading(false);\n      onLoad?.(e, props);\n    },\n    [onLoad]\n  );\n\n  React.useEffect(() => {\n    if (!isLoading && defaultLoadingState) setLoading(true);\n    if (isLoading && !defaultLoadingState) setLoading(false);\n  }, [component.id.toString(), defaultLoadingState]);\n\n  return (\n    <div className={styles.overviewWrapper} key={`${component.id.toString()}`}>\n      {showHeader && (\n        <ComponentOverview\n          className={classNames(styles.componentOverviewBlock, !isScaling && styles.legacyPreview)}\n          displayName={component.displayName}\n          version={component.version}\n          abstract={component.description}\n          labels={component.labels}\n          packageName={component.packageName}\n          titleBadges={flatten(titleBadges.values())}\n          componentDescriptor={componentDescriptor}\n          component={component}\n        />\n      )}\n      {!buildFailed && (\n        <div className={styles.readme}>\n          {isLoading && (\n            <ReadmeSkeleton>\n              <CompositionGallerySkeleton compositionsLength={Math.min(component.compositions.length, 3)} />\n            </ReadmeSkeleton>\n          )}\n          <ComponentPreview\n            onLoad={onPreviewLoad}\n            previewName=\"overview\"\n            pubsub={true}\n            queryParams={[iframeQueryParams, overviewPropsValues?.queryParams || '']}\n            viewport={null}\n            fullContentHeight\n            disableScroll={true}\n            {...rest}\n            component={component}\n            style={{ width: '100%', height: '100%', minHeight: !isScaling ? 500 : undefined }}\n          />\n          {component.preview?.skipIncludes && <CompositionGallery isLoading={isLoading} component={component} />}\n          {component.preview?.skipIncludes && (\n            <PropertiesTable className={styles.overviewPropsTable} componentId={component.id.toString()} />\n          )}\n        </div>\n      )}\n      {buildFailed && EmptyState && <EmptyState />}\n    </div>\n  );\n}\n"],"mappings":";;;;;;;AAAA,SAAAA,OAAA;EAAA,MAAAC,IAAA,GAAAC,uBAAA,CAAAC,OAAA;EAAAH,MAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAG,YAAA;EAAA,MAAAH,IAAA,GAAAI,sBAAA,CAAAF,OAAA;EAAAC,WAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAK,QAAA;EAAA,MAAAL,IAAA,GAAAE,OAAA;EAAAG,OAAA,YAAAA,CAAA;IAAA,OAAAL,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAM,aAAA;EAAA,MAAAN,IAAA,GAAAE,OAAA;EAAAI,YAAA,YAAAA,CAAA;IAAA,OAAAN,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAO,WAAA;EAAA,MAAAP,IAAA,GAAAE,OAAA;EAAAK,UAAA,YAAAA,CAAA;IAAA,OAAAP,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAQ,WAAA;EAAA,MAAAR,IAAA,GAAAE,OAAA;EAAAM,UAAA,YAAAA,CAAA;IAAA,OAAAR,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAS,aAAA;EAAA,MAAAT,IAAA,GAAAE,OAAA;EAAAO,YAAA,YAAAA,CAAA;IAAA,OAAAT,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAU,oBAAA;EAAA,MAAAV,IAAA,GAAAE,OAAA;EAAAQ,mBAAA,YAAAA,CAAA;IAAA,OAAAV,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAW,gBAAA;EAAA,MAAAX,IAAA,GAAAE,OAAA;EAAAS,eAAA,YAAAA,CAAA;IAAA,OAAAX,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAY,gBAAA;EAAA,MAAAZ,IAAA,GAAAI,sBAAA,CAAAF,OAAA;EAAAU,eAAA,YAAAA,CAAA;IAAA,OAAAZ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAA4C,MAAAa,SAAA,wBAV5C;AAEA;AAIA;AAAA,SAAAT,uBAAAU,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,KAAAE,OAAA,EAAAF,GAAA;AAAA,SAAAG,yBAAAC,CAAA,6BAAAC,OAAA,mBAAAC,CAAA,OAAAD,OAAA,IAAAE,CAAA,OAAAF,OAAA,YAAAF,wBAAA,YAAAA,CAAAC,CAAA,WAAAA,CAAA,GAAAG,CAAA,GAAAD,CAAA,KAAAF,CAAA;AAAA,SAAAjB,wBAAAiB,CAAA,EAAAE,CAAA,SAAAA,CAAA,IAAAF,CAAA,IAAAA,CAAA,CAAAH,UAAA,SAAAG,CAAA,eAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,WAAAF,OAAA,EAAAE,CAAA,QAAAG,CAAA,GAAAJ,wBAAA,CAAAG,CAAA,OAAAC,CAAA,IAAAA,CAAA,CAAAC,GAAA,CAAAJ,CAAA,UAAAG,CAAA,CAAAE,GAAA,CAAAL,CAAA,OAAAM,CAAA,KAAAC,SAAA,UAAAC,CAAA,GAAAC,MAAA,CAAAC,cAAA,IAAAD,MAAA,CAAAE,wBAAA,WAAAC,CAAA,IAAAZ,CAAA,oBAAAY,CAAA,IAAAH,MAAA,CAAAI,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAf,CAAA,EAAAY,CAAA,SAAAI,CAAA,GAAAR,CAAA,GAAAC,MAAA,CAAAE,wBAAA,CAAAX,CAAA,EAAAY,CAAA,UAAAI,CAAA,KAAAA,CAAA,CAAAX,GAAA,IAAAW,CAAA,CAAAC,GAAA,IAAAR,MAAA,CAAAC,cAAA,CAAAJ,CAAA,EAAAM,CAAA,EAAAI,CAAA,IAAAV,CAAA,CAAAM,CAAA,IAAAZ,CAAA,CAAAY,CAAA,YAAAN,CAAA,CAAAR,OAAA,GAAAE,CAAA,EAAAG,CAAA,IAAAA,CAAA,CAAAc,GAAA,CAAAjB,CAAA,EAAAM,CAAA,GAAAA,CAAA;AAAA,SAAAY,SAAA,IAAAA,QAAA,GAAAT,MAAA,CAAAU,MAAA,GAAAV,MAAA,CAAAU,MAAA,CAAAC,IAAA,eAAAC,MAAA,aAAAL,CAAA,MAAAA,CAAA,GAAAM,SAAA,CAAAC,MAAA,EAAAP,CAAA,UAAAQ,MAAA,GAAAF,SAAA,CAAAN,CAAA,YAAAS,GAAA,IAAAD,MAAA,QAAAf,MAAA,CAAAI,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAS,MAAA,EAAAC,GAAA,KAAAJ,MAAA,CAAAI,GAAA,IAAAD,MAAA,CAAAC,GAAA,gBAAAJ,MAAA,YAAAH,QAAA,CAAAQ,KAAA,OAAAJ,SAAA;AAAA,SAAAK,yBAAAH,MAAA,EAAAI,QAAA,QAAAJ,MAAA,yBAAAH,MAAA,GAAAQ,6BAAA,CAAAL,MAAA,EAAAI,QAAA,OAAAH,GAAA,EAAAT,CAAA,MAAAP,MAAA,CAAAqB,qBAAA,QAAAC,gBAAA,GAAAtB,MAAA,CAAAqB,qBAAA,CAAAN,MAAA,QAAAR,CAAA,MAAAA,CAAA,GAAAe,gBAAA,CAAAR,MAAA,EAAAP,CAAA,MAAAS,GAAA,GAAAM,gBAAA,CAAAf,CAAA,OAAAY,QAAA,CAAAI,OAAA,CAAAP,GAAA,uBAAAhB,MAAA,CAAAI,SAAA,CAAAoB,oBAAA,CAAAlB,IAAA,CAAAS,MAAA,EAAAC,GAAA,aAAAJ,MAAA,CAAAI,GAAA,IAAAD,MAAA,CAAAC,GAAA,cAAAJ,MAAA;AAAA,SAAAQ,8BAAAL,MAAA,EAAAI,QAAA,QAAAJ,MAAA,yBAAAH,MAAA,WAAAa,UAAA,GAAAzB,MAAA,CAAA0B,IAAA,CAAAX,MAAA,OAAAC,GAAA,EAAAT,CAAA,OAAAA,CAAA,MAAAA,CAAA,GAAAkB,UAAA,CAAAX,MAAA,EAAAP,CAAA,MAAAS,GAAA,GAAAS,UAAA,CAAAlB,CAAA,OAAAY,QAAA,CAAAI,OAAA,CAAAP,GAAA,kBAAAJ,MAAA,CAAAI,GAAA,IAAAD,MAAA,CAAAC,GAAA,YAAAJ,MAAA;AAAA,IAMYe,aAAa,GAAAC,OAAA,CAAAD,aAAA,0BAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAA,OAAbA,aAAa;AAAA;AA0BlB,SAASE,QAAQA,CAAC;EAAEC,WAAW;EAAEC,eAAe;EAAEC,YAAY;EAAEC;AAA6B,CAAC,EAAE;EAAA,IAAAC,kBAAA,EAAAC,qBAAA,EAAAC,mBAAA,EAAAC,mBAAA,EAAAC,mBAAA,EAAAC,mBAAA,EAAAC,mBAAA;EACrG,MAAMC,SAAS,GAAG,IAAAC,mBAAU,EAACC,6BAAgB,CAAC;EAC9C,MAAMC,mBAAmB,GAAG,IAAAC,mCAAsB,EAAC,CAAC;EACpD,MAAMC,aAAa,GAAG,IAAAC,iBAAO,EAAChB,eAAe,CAACiB,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;EAC1D,MAAMC,UAAU,GAAG,GAAAf,kBAAA,GAACO,SAAS,CAACS,OAAO,cAAAhB,kBAAA,eAAjBA,kBAAA,CAAmBiB,YAAY;EACnD,MAAMC,UAAU,GAAGnB,aAAa,IAAIA,aAAa,CAAC,CAAC;EACnD,MAAMoB,WAAW,GAAG,EAAAlB,qBAAA,GAAAM,SAAS,CAACa,WAAW,cAAAnB,qBAAA,uBAArBA,qBAAA,CAAuBoB,WAAW,CAAC,CAAC,MAAK,SAAS,IAAI,CAAAd,SAAS,aAATA,SAAS,uBAATA,SAAS,CAAEe,IAAI,MAAK,qBAAqB;EACnH,MAAMC,SAAS,GAAGC,OAAO,EAAAtB,mBAAA,GAACK,SAAS,CAACS,OAAO,cAAAd,mBAAA,uBAAjBA,mBAAA,CAAmBqB,SAAS,CAAC;EACvD,MAAME,mBAAmB,GAAGD,OAAO,EAAArB,mBAAA,GAACI,SAAS,CAACS,OAAO,cAAAb,mBAAA,uBAAjBA,mBAAA,CAAmBsB,mBAAmB,CAAC;EAC3E,MAAMC,mBAAmB,GAAGC,gBAAK,CAACC,OAAO,CAAC,MAAM;IAC9C,OAAOL,SAAS,IAAI,CAACE,mBAAmB;EAC1C,CAAC,EAAE,CAACF,SAAS,EAAEE,mBAAmB,CAAC,CAAC;EAEpC,MAAM,CAACI,SAAS,EAAEC,UAAU,CAAC,GAAG,IAAAC,iBAAQ,EAACL,mBAAmB,CAAC;EAE7D,MAAMM,iBAAiB,GAAI,gBAAe,EAAA5B,mBAAA,GAAAG,SAAS,CAACS,OAAO,cAAAZ,mBAAA,uBAAjBA,mBAAA,CAAmB6B,YAAY,KAAI,OAAQ,EAAC;EAEtF,MAAMC,mBAAmB,GAAGtB,aAAa,IAAIA,aAAa,CAAC,CAAC;;EAE5D;EACA,MAAAuB,IAAA,GAAmCrC,YAAY,IAAI,CAAC,CAAC;IAA/C;MAAEsC,MAAM;MAAEC;IAAe,CAAC,GAAAF,IAAA;IAANG,IAAI,GAAAtD,wBAAA,CAAAmD,IAAA,EAAAnF,SAAA;EAE9B,MAAMuF,aAAa,GAAGZ,gBAAK,CAACa,WAAW,CACrC,CAACnF,CAAC,EAAEoF,KAAK,KAAK;IACZX,UAAU,CAAC,KAAK,CAAC;IACjBM,MAAM,aAANA,MAAM,eAANA,MAAM,CAAG/E,CAAC,EAAEoF,KAAK,CAAC;EACpB,CAAC,EACD,CAACL,MAAM,CACT,CAAC;EAEDT,gBAAK,CAACe,SAAS,CAAC,MAAM;IACpB,IAAI,CAACb,SAAS,IAAIH,mBAAmB,EAAEI,UAAU,CAAC,IAAI,CAAC;IACvD,IAAID,SAAS,IAAI,CAACH,mBAAmB,EAAEI,UAAU,CAAC,KAAK,CAAC;EAC1D,CAAC,EAAE,CAACvB,SAAS,CAACoC,EAAE,CAACC,QAAQ,CAAC,CAAC,EAAElB,mBAAmB,CAAC,CAAC;EAElD,oBACExF,MAAA,GAAAiB,OAAA,CAAA0F,aAAA;IAAKC,SAAS,EAAEC,yBAAM,CAACC,eAAgB;IAAClE,GAAG,EAAG,GAAEyB,SAAS,CAACoC,EAAE,CAACC,QAAQ,CAAC,CAAE;EAAE,GACvE7B,UAAU,iBACT7E,MAAA,GAAAiB,OAAA,CAAA0F,aAAA,CAACjG,YAAA,GAAAqG,iBAAiB;IAChBH,SAAS,EAAE,IAAAI,qBAAU,EAACH,yBAAM,CAACI,sBAAsB,EAAE,CAAC5B,SAAS,IAAIwB,yBAAM,CAACK,aAAa,CAAE;IACzFC,WAAW,EAAE9C,SAAS,CAAC8C,WAAY;IACnCC,OAAO,EAAE/C,SAAS,CAAC+C,OAAQ;IAC3BC,QAAQ,EAAEhD,SAAS,CAACiD,WAAY;IAChCC,MAAM,EAAElD,SAAS,CAACkD,MAAO;IACzBC,WAAW,EAAEnD,SAAS,CAACmD,WAAY;IACnC9D,WAAW,EAAE,IAAAiB,iBAAO,EAACjB,WAAW,CAACkB,MAAM,CAAC,CAAC,CAAE;IAC3CJ,mBAAmB,EAAEA,mBAAoB;IACzCH,SAAS,EAAEA;EAAU,CACtB,CACF,EACA,CAACY,WAAW,iBACXjF,MAAA,GAAAiB,OAAA,CAAA0F,aAAA;IAAKC,SAAS,EAAEC,yBAAM,CAACY;EAAO,GAC3B9B,SAAS,iBACR3F,MAAA,GAAAiB,OAAA,CAAA0F,aAAA,CAAC/F,eAAA,GAAA8G,cAAc,qBACb1H,MAAA,GAAAiB,OAAA,CAAA0F,aAAA,CAAChG,mBAAA,GAAAgH,0BAA0B;IAACC,kBAAkB,EAAEC,IAAI,CAACC,GAAG,CAACzD,SAAS,CAAC0D,YAAY,CAACrF,MAAM,EAAE,CAAC;EAAE,CAAE,CAC/E,CACjB,eACD1C,MAAA,GAAAiB,OAAA,CAAA0F,aAAA,CAAClG,UAAA,GAAAuH,gBAAgB,EAAA3F,QAAA;IACf6D,MAAM,EAAEG,aAAc;IACtB4B,WAAW,EAAC,UAAU;IACtBC,MAAM,EAAE,IAAK;IACbC,WAAW,EAAE,CAACrC,iBAAiB,EAAE,CAAAE,mBAAmB,aAAnBA,mBAAmB,uBAAnBA,mBAAmB,CAAEmC,WAAW,KAAI,EAAE,CAAE;IACzEC,QAAQ,EAAE,IAAK;IACfC,iBAAiB;IACjBC,aAAa,EAAE;EAAK,GAChBlC,IAAI;IACR/B,SAAS,EAAEA,SAAU;IACrB8B,KAAK,EAAE;MAAEoC,KAAK,EAAE,MAAM;MAAEC,MAAM,EAAE,MAAM;MAAEC,SAAS,EAAE,CAACpD,SAAS,GAAG,GAAG,GAAGqD;IAAU;EAAE,EACnF,CAAC,EACD,EAAAvE,mBAAA,GAAAE,SAAS,CAACS,OAAO,cAAAX,mBAAA,uBAAjBA,mBAAA,CAAmB4B,YAAY,kBAAI/F,MAAA,GAAAiB,OAAA,CAAA0F,aAAA,CAAChG,mBAAA,GAAAgI,kBAAkB;IAAChD,SAAS,EAAEA,SAAU;IAACtB,SAAS,EAAEA;EAAU,CAAE,CAAC,EACrG,EAAAD,mBAAA,GAAAC,SAAS,CAACS,OAAO,cAAAV,mBAAA,uBAAjBA,mBAAA,CAAmB2B,YAAY,kBAC9B/F,MAAA,GAAAiB,OAAA,CAAA0F,aAAA,CAACpG,YAAA,GAAAqI,eAAe;IAAChC,SAAS,EAAEC,yBAAM,CAACgC,kBAAmB;IAACC,WAAW,EAAEzE,SAAS,CAACoC,EAAE,CAACC,QAAQ,CAAC;EAAE,CAAE,CAE7F,CACN,EACAzB,WAAW,IAAID,UAAU,iBAAIhF,MAAA,GAAAiB,OAAA,CAAA0F,aAAA,CAAC3B,UAAU,MAAE,CACxC,CAAC;AAEV"}
+{"version":3,"names":["_react","data","_interopRequireWildcard","require","_classnames","_interopRequireDefault","_lodash","_reactUiDocs","_component","_previewUi","_componentUi","_compositionsPanels","_readmeSkeleton","_overviewModule","_excluded","obj","__esModule","default","_getRequireWildcardCache","e","WeakMap","r","t","has","get","n","__proto__","a","Object","defineProperty","getOwnPropertyDescriptor","u","prototype","hasOwnProperty","call","i","set","_extends","assign","bind","target","arguments","length","source","key","apply","_objectWithoutProperties","excluded","_objectWithoutPropertiesLoose","getOwnPropertySymbols","sourceSymbolKeys","indexOf","propertyIsEnumerable","sourceKeys","keys","BadgePosition","exports","Overview","titleBadges","overviewOptions","previewProps","getEmptyState","component","useContext","ComponentContext","componentDescriptor","useComponentDescriptor","overviewProps","flatten","values","showHeader","preview","legacyHeader","EmptyState","buildFailed","buildStatus","toLowerCase","host","isScaling","Boolean","includesEnvTemplate","defaultLoadingState","React","useMemo","isLoading","setLoading","useState","iframeQueryParams","skipIncludes","overviewPropsValues","_ref","onLoad","style","rest","onPreviewLoad","useCallback","props","useEffect","id","toString","createElement","className","styles","overviewWrapper","ComponentOverview","classNames","componentOverviewBlock","legacyPreview","displayName","version","abstract","description","labels","packageName","readme","ReadmeSkeleton","CompositionGallerySkeleton","compositionsLength","Math","min","compositions","ComponentPreview","previewName","pubsub","queryParams","viewport","fullContentHeight","disableScroll","width","height","minHeight","undefined","CompositionGallery","PropertiesTable","overviewPropsTable","componentId"],"sources":["overview.tsx"],"sourcesContent":["import React, { useContext, ComponentType, useState } from 'react';\nimport classNames from 'classnames';\nimport { flatten } from 'lodash';\n// import { Icon } from '@teambit/design.elements.icon';\nimport { PropertiesTable } from '@teambit/react.ui.docs.properties-table';\n// import { LinkedHeading } from '@teambit/documenter.ui.linked-heading';\nimport { ComponentContext, useComponentDescriptor } from '@teambit/component';\nimport type { SlotRegistry } from '@teambit/harmony';\nimport { ComponentPreview, ComponentPreviewProps } from '@teambit/preview.ui.component-preview';\n// import { StatusMessageCard } from '@teambit/design.ui.surfaces.status-message-card';\nimport { ComponentOverview } from '@teambit/component.ui.component-meta';\nimport { CompositionGallery, CompositionGallerySkeleton } from '@teambit/compositions.panels.composition-gallery';\nimport { ReadmeSkeleton } from './readme-skeleton';\nimport styles from './overview.module.scss';\n\nexport enum BadgePosition {\n  Title,\n  SubTitle,\n  Labels,\n  Package,\n}\n\nexport type TitleBadge = {\n  component: ComponentType<any>;\n  weight?: number;\n  position?: BadgePosition;\n};\n\nexport type TitleBadgeSlot = SlotRegistry<TitleBadge[]>;\n\nexport type OverviewOptions = () => { queryParams?: string };\n\nexport type OverviewOptionsSlot = SlotRegistry<OverviewOptions>;\n\nexport type OverviewProps = {\n  titleBadges: TitleBadgeSlot;\n  overviewOptions: OverviewOptionsSlot;\n  previewProps?: Partial<ComponentPreviewProps>;\n  getEmptyState?: () => ComponentType | undefined;\n};\n\nexport function Overview({ titleBadges, overviewOptions, previewProps, getEmptyState }: OverviewProps) {\n  const component = useContext(ComponentContext);\n  const componentDescriptor = useComponentDescriptor();\n  const overviewProps = flatten(overviewOptions.values())[0];\n  const showHeader = !component.preview?.legacyHeader;\n  const EmptyState = getEmptyState && getEmptyState();\n  const buildFailed = component.buildStatus?.toLowerCase() !== 'succeed' && component?.host === 'teambit.scope/scope';\n  const isScaling = Boolean(component.preview?.isScaling);\n  const includesEnvTemplate = Boolean(component.preview?.includesEnvTemplate);\n  const defaultLoadingState = React.useMemo(() => {\n    return isScaling && !includesEnvTemplate;\n  }, [isScaling, includesEnvTemplate]);\n\n  const [isLoading, setLoading] = useState(defaultLoadingState);\n\n  const iframeQueryParams = `skipIncludes=${component.preview?.skipIncludes || 'false'}`;\n\n  const overviewPropsValues = overviewProps && overviewProps();\n\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  const { onLoad, style, ...rest } = previewProps || {};\n\n  const onPreviewLoad = React.useCallback(\n    (e, props) => {\n      setLoading(false);\n      onLoad?.(e, props);\n    },\n    [onLoad]\n  );\n\n  React.useEffect(() => {\n    if (!isLoading && defaultLoadingState) setLoading(true);\n    if (isLoading && !defaultLoadingState) setLoading(false);\n  }, [component.id.toString(), defaultLoadingState]);\n\n  return (\n    <div className={styles.overviewWrapper} key={`${component.id.toString()}`}>\n      {showHeader && (\n        <ComponentOverview\n          className={classNames(styles.componentOverviewBlock, !isScaling && styles.legacyPreview)}\n          displayName={component.displayName}\n          version={component.version}\n          abstract={component.description}\n          labels={component.labels}\n          packageName={component.packageName}\n          titleBadges={flatten(titleBadges.values())}\n          componentDescriptor={componentDescriptor}\n          component={component}\n        />\n      )}\n      {!buildFailed && (\n        <div className={styles.readme}>\n          {isLoading && (\n            <ReadmeSkeleton>\n              <CompositionGallerySkeleton compositionsLength={Math.min(component.compositions.length, 3)} />\n            </ReadmeSkeleton>\n          )}\n          <ComponentPreview\n            onLoad={onPreviewLoad}\n            previewName=\"overview\"\n            pubsub={true}\n            queryParams={[iframeQueryParams, overviewPropsValues?.queryParams || '']}\n            viewport={null}\n            fullContentHeight\n            disableScroll={true}\n            {...rest}\n            component={component}\n            style={{ width: '100%', height: '100%', minHeight: !isScaling ? 500 : undefined }}\n          />\n          {component.preview?.skipIncludes && <CompositionGallery isLoading={isLoading} component={component} />}\n          {component.preview?.skipIncludes && (\n            <PropertiesTable className={styles.overviewPropsTable} componentId={component.id.toString()} />\n          )}\n        </div>\n      )}\n      {buildFailed && EmptyState && <EmptyState />}\n    </div>\n  );\n}\n"],"mappings":";;;;;;;AAAA,SAAAA,OAAA;EAAA,MAAAC,IAAA,GAAAC,uBAAA,CAAAC,OAAA;EAAAH,MAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAG,YAAA;EAAA,MAAAH,IAAA,GAAAI,sBAAA,CAAAF,OAAA;EAAAC,WAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAK,QAAA;EAAA,MAAAL,IAAA,GAAAE,OAAA;EAAAG,OAAA,YAAAA,CAAA;IAAA,OAAAL,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAM,aAAA;EAAA,MAAAN,IAAA,GAAAE,OAAA;EAAAI,YAAA,YAAAA,CAAA;IAAA,OAAAN,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAO,WAAA;EAAA,MAAAP,IAAA,GAAAE,OAAA;EAAAK,UAAA,YAAAA,CAAA;IAAA,OAAAP,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAQ,WAAA;EAAA,MAAAR,IAAA,GAAAE,OAAA;EAAAM,UAAA,YAAAA,CAAA;IAAA,OAAAR,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAS,aAAA;EAAA,MAAAT,IAAA,GAAAE,OAAA;EAAAO,YAAA,YAAAA,CAAA;IAAA,OAAAT,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAU,oBAAA;EAAA,MAAAV,IAAA,GAAAE,OAAA;EAAAQ,mBAAA,YAAAA,CAAA;IAAA,OAAAV,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAW,gBAAA;EAAA,MAAAX,IAAA,GAAAE,OAAA;EAAAS,eAAA,YAAAA,CAAA;IAAA,OAAAX,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAY,gBAAA;EAAA,MAAAZ,IAAA,GAAAI,sBAAA,CAAAF,OAAA;EAAAU,eAAA,YAAAA,CAAA;IAAA,OAAAZ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAA4C,MAAAa,SAAA,wBAV5C;AAEA;AAIA;AAAA,SAAAT,uBAAAU,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,KAAAE,OAAA,EAAAF,GAAA;AAAA,SAAAG,yBAAAC,CAAA,6BAAAC,OAAA,mBAAAC,CAAA,OAAAD,OAAA,IAAAE,CAAA,OAAAF,OAAA,YAAAF,wBAAA,YAAAA,CAAAC,CAAA,WAAAA,CAAA,GAAAG,CAAA,GAAAD,CAAA,KAAAF,CAAA;AAAA,SAAAjB,wBAAAiB,CAAA,EAAAE,CAAA,SAAAA,CAAA,IAAAF,CAAA,IAAAA,CAAA,CAAAH,UAAA,SAAAG,CAAA,eAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,WAAAF,OAAA,EAAAE,CAAA,QAAAG,CAAA,GAAAJ,wBAAA,CAAAG,CAAA,OAAAC,CAAA,IAAAA,CAAA,CAAAC,GAAA,CAAAJ,CAAA,UAAAG,CAAA,CAAAE,GAAA,CAAAL,CAAA,OAAAM,CAAA,KAAAC,SAAA,UAAAC,CAAA,GAAAC,MAAA,CAAAC,cAAA,IAAAD,MAAA,CAAAE,wBAAA,WAAAC,CAAA,IAAAZ,CAAA,oBAAAY,CAAA,IAAAH,MAAA,CAAAI,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAf,CAAA,EAAAY,CAAA,SAAAI,CAAA,GAAAR,CAAA,GAAAC,MAAA,CAAAE,wBAAA,CAAAX,CAAA,EAAAY,CAAA,UAAAI,CAAA,KAAAA,CAAA,CAAAX,GAAA,IAAAW,CAAA,CAAAC,GAAA,IAAAR,MAAA,CAAAC,cAAA,CAAAJ,CAAA,EAAAM,CAAA,EAAAI,CAAA,IAAAV,CAAA,CAAAM,CAAA,IAAAZ,CAAA,CAAAY,CAAA,YAAAN,CAAA,CAAAR,OAAA,GAAAE,CAAA,EAAAG,CAAA,IAAAA,CAAA,CAAAc,GAAA,CAAAjB,CAAA,EAAAM,CAAA,GAAAA,CAAA;AAAA,SAAAY,SAAA,IAAAA,QAAA,GAAAT,MAAA,CAAAU,MAAA,GAAAV,MAAA,CAAAU,MAAA,CAAAC,IAAA,eAAAC,MAAA,aAAAL,CAAA,MAAAA,CAAA,GAAAM,SAAA,CAAAC,MAAA,EAAAP,CAAA,UAAAQ,MAAA,GAAAF,SAAA,CAAAN,CAAA,YAAAS,GAAA,IAAAD,MAAA,QAAAf,MAAA,CAAAI,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAS,MAAA,EAAAC,GAAA,KAAAJ,MAAA,CAAAI,GAAA,IAAAD,MAAA,CAAAC,GAAA,gBAAAJ,MAAA,YAAAH,QAAA,CAAAQ,KAAA,OAAAJ,SAAA;AAAA,SAAAK,yBAAAH,MAAA,EAAAI,QAAA,QAAAJ,MAAA,yBAAAH,MAAA,GAAAQ,6BAAA,CAAAL,MAAA,EAAAI,QAAA,OAAAH,GAAA,EAAAT,CAAA,MAAAP,MAAA,CAAAqB,qBAAA,QAAAC,gBAAA,GAAAtB,MAAA,CAAAqB,qBAAA,CAAAN,MAAA,QAAAR,CAAA,MAAAA,CAAA,GAAAe,gBAAA,CAAAR,MAAA,EAAAP,CAAA,MAAAS,GAAA,GAAAM,gBAAA,CAAAf,CAAA,OAAAY,QAAA,CAAAI,OAAA,CAAAP,GAAA,uBAAAhB,MAAA,CAAAI,SAAA,CAAAoB,oBAAA,CAAAlB,IAAA,CAAAS,MAAA,EAAAC,GAAA,aAAAJ,MAAA,CAAAI,GAAA,IAAAD,MAAA,CAAAC,GAAA,cAAAJ,MAAA;AAAA,SAAAQ,8BAAAL,MAAA,EAAAI,QAAA,QAAAJ,MAAA,yBAAAH,MAAA,WAAAa,UAAA,GAAAzB,MAAA,CAAA0B,IAAA,CAAAX,MAAA,OAAAC,GAAA,EAAAT,CAAA,OAAAA,CAAA,MAAAA,CAAA,GAAAkB,UAAA,CAAAX,MAAA,EAAAP,CAAA,MAAAS,GAAA,GAAAS,UAAA,CAAAlB,CAAA,OAAAY,QAAA,CAAAI,OAAA,CAAAP,GAAA,kBAAAJ,MAAA,CAAAI,GAAA,IAAAD,MAAA,CAAAC,GAAA,YAAAJ,MAAA;AAAA,IAMYe,aAAa,GAAAC,OAAA,CAAAD,aAAA,0BAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAA,OAAbA,aAAa;AAAA;AA0BlB,SAASE,QAAQA,CAAC;EAAEC,WAAW;EAAEC,eAAe;EAAEC,YAAY;EAAEC;AAA6B,CAAC,EAAE;EACrG,MAAMC,SAAS,GAAG,IAAAC,mBAAU,EAACC,6BAAgB,CAAC;EAC9C,MAAMC,mBAAmB,GAAG,IAAAC,mCAAsB,EAAC,CAAC;EACpD,MAAMC,aAAa,GAAG,IAAAC,iBAAO,EAACT,eAAe,CAACU,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;EAC1D,MAAMC,UAAU,GAAG,CAACR,SAAS,CAACS,OAAO,EAAEC,YAAY;EACnD,MAAMC,UAAU,GAAGZ,aAAa,IAAIA,aAAa,CAAC,CAAC;EACnD,MAAMa,WAAW,GAAGZ,SAAS,CAACa,WAAW,EAAEC,WAAW,CAAC,CAAC,KAAK,SAAS,IAAId,SAAS,EAAEe,IAAI,KAAK,qBAAqB;EACnH,MAAMC,SAAS,GAAGC,OAAO,CAACjB,SAAS,CAACS,OAAO,EAAEO,SAAS,CAAC;EACvD,MAAME,mBAAmB,GAAGD,OAAO,CAACjB,SAAS,CAACS,OAAO,EAAES,mBAAmB,CAAC;EAC3E,MAAMC,mBAAmB,GAAGC,gBAAK,CAACC,OAAO,CAAC,MAAM;IAC9C,OAAOL,SAAS,IAAI,CAACE,mBAAmB;EAC1C,CAAC,EAAE,CAACF,SAAS,EAAEE,mBAAmB,CAAC,CAAC;EAEpC,MAAM,CAACI,SAAS,EAAEC,UAAU,CAAC,GAAG,IAAAC,iBAAQ,EAACL,mBAAmB,CAAC;EAE7D,MAAMM,iBAAiB,GAAI,gBAAezB,SAAS,CAACS,OAAO,EAAEiB,YAAY,IAAI,OAAQ,EAAC;EAEtF,MAAMC,mBAAmB,GAAGtB,aAAa,IAAIA,aAAa,CAAC,CAAC;;EAE5D;EACA,MAAAuB,IAAA,GAAmC9B,YAAY,IAAI,CAAC,CAAC;IAA/C;MAAE+B,MAAM;MAAEC;IAAe,CAAC,GAAAF,IAAA;IAANG,IAAI,GAAA/C,wBAAA,CAAA4C,IAAA,EAAA5E,SAAA;EAE9B,MAAMgF,aAAa,GAAGZ,gBAAK,CAACa,WAAW,CACrC,CAAC5E,CAAC,EAAE6E,KAAK,KAAK;IACZX,UAAU,CAAC,KAAK,CAAC;IACjBM,MAAM,GAAGxE,CAAC,EAAE6E,KAAK,CAAC;EACpB,CAAC,EACD,CAACL,MAAM,CACT,CAAC;EAEDT,gBAAK,CAACe,SAAS,CAAC,MAAM;IACpB,IAAI,CAACb,SAAS,IAAIH,mBAAmB,EAAEI,UAAU,CAAC,IAAI,CAAC;IACvD,IAAID,SAAS,IAAI,CAACH,mBAAmB,EAAEI,UAAU,CAAC,KAAK,CAAC;EAC1D,CAAC,EAAE,CAACvB,SAAS,CAACoC,EAAE,CAACC,QAAQ,CAAC,CAAC,EAAElB,mBAAmB,CAAC,CAAC;EAElD,oBACEjF,MAAA,GAAAiB,OAAA,CAAAmF,aAAA;IAAKC,SAAS,EAAEC,yBAAM,CAACC,eAAgB;IAAC3D,GAAG,EAAG,GAAEkB,SAAS,CAACoC,EAAE,CAACC,QAAQ,CAAC,CAAE;EAAE,GACvE7B,UAAU,iBACTtE,MAAA,GAAAiB,OAAA,CAAAmF,aAAA,CAAC1F,YAAA,GAAA8F,iBAAiB;IAChBH,SAAS,EAAE,IAAAI,qBAAU,EAACH,yBAAM,CAACI,sBAAsB,EAAE,CAAC5B,SAAS,IAAIwB,yBAAM,CAACK,aAAa,CAAE;IACzFC,WAAW,EAAE9C,SAAS,CAAC8C,WAAY;IACnCC,OAAO,EAAE/C,SAAS,CAAC+C,OAAQ;IAC3BC,QAAQ,EAAEhD,SAAS,CAACiD,WAAY;IAChCC,MAAM,EAAElD,SAAS,CAACkD,MAAO;IACzBC,WAAW,EAAEnD,SAAS,CAACmD,WAAY;IACnCvD,WAAW,EAAE,IAAAU,iBAAO,EAACV,WAAW,CAACW,MAAM,CAAC,CAAC,CAAE;IAC3CJ,mBAAmB,EAAEA,mBAAoB;IACzCH,SAAS,EAAEA;EAAU,CACtB,CACF,EACA,CAACY,WAAW,iBACX1E,MAAA,GAAAiB,OAAA,CAAAmF,aAAA;IAAKC,SAAS,EAAEC,yBAAM,CAACY;EAAO,GAC3B9B,SAAS,iBACRpF,MAAA,GAAAiB,OAAA,CAAAmF,aAAA,CAACxF,eAAA,GAAAuG,cAAc,qBACbnH,MAAA,GAAAiB,OAAA,CAAAmF,aAAA,CAACzF,mBAAA,GAAAyG,0BAA0B;IAACC,kBAAkB,EAAEC,IAAI,CAACC,GAAG,CAACzD,SAAS,CAAC0D,YAAY,CAAC9E,MAAM,EAAE,CAAC;EAAE,CAAE,CAC/E,CACjB,eACD1C,MAAA,GAAAiB,OAAA,CAAAmF,aAAA,CAAC3F,UAAA,GAAAgH,gBAAgB,EAAApF,QAAA;IACfsD,MAAM,EAAEG,aAAc;IACtB4B,WAAW,EAAC,UAAU;IACtBC,MAAM,EAAE,IAAK;IACbC,WAAW,EAAE,CAACrC,iBAAiB,EAAEE,mBAAmB,EAAEmC,WAAW,IAAI,EAAE,CAAE;IACzEC,QAAQ,EAAE,IAAK;IACfC,iBAAiB;IACjBC,aAAa,EAAE;EAAK,GAChBlC,IAAI;IACR/B,SAAS,EAAEA,SAAU;IACrB8B,KAAK,EAAE;MAAEoC,KAAK,EAAE,MAAM;MAAEC,MAAM,EAAE,MAAM;MAAEC,SAAS,EAAE,CAACpD,SAAS,GAAG,GAAG,GAAGqD;IAAU;EAAE,EACnF,CAAC,EACDrE,SAAS,CAACS,OAAO,EAAEiB,YAAY,iBAAIxF,MAAA,GAAAiB,OAAA,CAAAmF,aAAA,CAACzF,mBAAA,GAAAyH,kBAAkB;IAAChD,SAAS,EAAEA,SAAU;IAACtB,SAAS,EAAEA;EAAU,CAAE,CAAC,EACrGA,SAAS,CAACS,OAAO,EAAEiB,YAAY,iBAC9BxF,MAAA,GAAAiB,OAAA,CAAAmF,aAAA,CAAC7F,YAAA,GAAA8H,eAAe;IAAChC,SAAS,EAAEC,yBAAM,CAACgC,kBAAmB;IAACC,WAAW,EAAEzE,SAAS,CAACoC,EAAE,CAACC,QAAQ,CAAC;EAAE,CAAE,CAE7F,CACN,EACAzB,WAAW,IAAID,UAAU,iBAAIzE,MAAA,GAAAiB,OAAA,CAAAmF,aAAA,CAAC3B,UAAU,MAAE,CACxC,CAAC;AAEV"}

package/dist/overview/readme-skeleton.d.ts

@@ -1,4 +1,4 @@
 import React from 'react';
 export declare function ReadmeSkeleton({ children }: {
     children?: React.ReactNode;
-}): React.JSX.Element;
+}): JSX.Element;

package/dist/overview.section.d.ts

@@ -1,4 +1,4 @@
-import React from 'react';
+/// <reference types="react" />
 import { Section } from '@teambit/component';
 import { TitleBadgeSlot, OverviewOptionsSlot } from './overview';
 import { DocsUI } from './docs.ui.runtime';
@@ -21,7 +21,7 @@ export declare class OverviewSection implements Section {
     };
     route: {
         index: boolean;
-        element: React.JSX.Element;
+        element: JSX.Element;
     };
     order: number;
 }

package/dist/{preview-1703590665075.js → preview-1703647408454.js}

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

package/doc-module.ts

@@ -0,0 +1,17 @@
+export class DocModule {
+  constructor(
+    readonly path: string,
+
+    /**
+     * original doc module.
+     */
+    readonly module: any
+  ) {}
+
+  /**
+   * get the abstract.
+   */
+  get abstract() {
+    return this.module.abstract || this.module.default?.abstract;
+  }
+}

package/doc-reader.ts

@@ -0,0 +1,15 @@
+import type { Component } from '@teambit/component';
+import { Doc } from '@teambit/docs.entities.doc';
+
+export interface DocReader {
+  /**
+   * read a component doc.
+   * @TODO refactor to virtual-file component after @david completes.
+   */
+  read(path: string, contents: Buffer, component: Component): Promise<Doc>;
+
+  /**
+   * determine which file formats are supported by the doc reader.
+   */
+  isFormatSupported(ext: string): boolean;
+}

package/docs.aspect.ts

@@ -0,0 +1,9 @@
+import { Aspect } from '@teambit/harmony';
+
+export const DocsAspect = Aspect.create({
+  id: 'teambit.docs/docs',
+  dependencies: [],
+  defaultConfig: {},
+});
+
+export default DocsAspect;

package/docs.graphql.ts

@@ -0,0 +1,26 @@
+import gql from 'graphql-tag';
+import { Component } from '@teambit/component';
+import { DocsMain } from './docs.main.runtime';
+
+export function docsSchema(docs: DocsMain) {
+  return {
+    typeDefs: gql`
+      extend type Component {
+        description: String
+        labels: [String]
+      }
+    `,
+    resolvers: {
+      Component: {
+        description: (component: Component) => {
+          return docs.getDescription(component);
+        },
+
+        labels: (component: Component) => {
+          const doc = docs.getDoc(component);
+          return doc?.labels || [];
+        },
+      },
+    },
+  };
+}

package/docs.main.runtime.ts

@@ -0,0 +1,234 @@
+import { Slot, SlotRegistry } from '@teambit/harmony';
+import { MainRuntime } from '@teambit/cli';
+import { LoggerAspect, LoggerMain, Logger } from '@teambit/logger';
+import { CompilerAspect, CompilerMain } from '@teambit/compiler';
+import { Component, ComponentMap, IComponent } from '@teambit/component';
+import ScopeAspect, { ScopeMain } from '@teambit/scope';
+import { PkgAspect, PkgMain } from '@teambit/pkg';
+import type { Environment } from '@teambit/envs';
+import { GraphqlAspect, GraphqlMain } from '@teambit/graphql';
+import { PreviewAspect, PreviewMain } from '@teambit/preview';
+import DevFilesAspect, { DevFilesMain } from '@teambit/dev-files';
+import { ComponentLoadOptions } from '@teambit/legacy/dist/consumer/component/component-loader';
+import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
+import { Workspace, WorkspaceAspect } from '@teambit/workspace';
+import { Doc, DocPropList } from '@teambit/docs.entities.doc';
+import { isFunction } from 'lodash';
+import { EnvsAspect, EnvsMain } from '@teambit/envs';
+import { DocsAspect } from './docs.aspect';
+import { DocsPreviewDefinition } from './docs.preview-definition';
+import { docsSchema } from './docs.graphql';
+import { DocReader } from './doc-reader';
+import { DefaultDocReader } from './default-doc-reader';
+import { FileExtensionNotSupported } from './exceptions';
+
+export type ComponentDocs = {
+  files: string[];
+  component: Component;
+};
+
+export type DocProp = {};
+
+export type DocPropSlot = SlotRegistry<DocProp>;
+
+export type DocReaderSlot = SlotRegistry<DocReader>;
+
+export type DocsConfig = {
+  /**
+   * glob patterns to identify doc files.
+   */
+  patterns: string[];
+};
+
+/**
+ * the component documentation extension.
+ */
+export class DocsMain {
+  constructor(
+    private patterns: string[],
+    /**
+     * envs extension.
+     */
+    private preview: PreviewMain,
+
+    private pkg: PkgMain,
+
+    private compiler: CompilerMain,
+
+    private workspace: Workspace,
+
+    private logger: Logger,
+
+    private devFiles: DevFilesMain,
+
+    private envs: EnvsMain,
+
+    private docPropSlot: DocPropSlot,
+
+    private docReaderSlot: DocReaderSlot
+  ) {}
+
+  /**
+   * returns an array of doc file paths for a set of components.
+   */
+  getDocsMap(components: Component[]): ComponentMap<AbstractVinyl[]> {
+    return ComponentMap.as<AbstractVinyl[]>(components, (component) => {
+      return this.getDocsFiles(component);
+    });
+  }
+
+  getDocsFiles(component: Component): AbstractVinyl[] {
+    const devFiles = this.devFiles.getDevFiles(component);
+    const docFiles = devFiles.get(DocsAspect.id);
+    return component.state.filesystem.files.filter((file) => docFiles.includes(file.relative));
+  }
+
+  /**
+   * compute the description of the component from its source code and docs file.
+   */
+  async getDescription(component: Component): Promise<string> {
+    const componentDoc = this.getDoc(component);
+    const desc = componentDoc?.description;
+    return desc || '';
+  }
+
+  async getTemplate(env: Environment): Promise<string | undefined> {
+    if (env.getDocsTemplate && isFunction(env.getDocsTemplate)) {
+      return env.getDocsTemplate();
+    }
+    return undefined;
+  }
+
+  getDocReader(extension: string) {
+    return this.docReaderSlot.values().find((docReader) => docReader.isFormatSupported(extension));
+  }
+
+  /**
+   * compute a doc for a component.
+   */
+  async computeDoc(component: Component) {
+    const docFiles = this.getDocsFiles(component);
+    if (docFiles.length) {
+      // currently taking the the first docs file found with an abstract. (we support only one)
+      const docFile = docFiles[0];
+
+      try {
+        const docReader = this.getDocReader(docFile.extname);
+        if (!docReader) throw new FileExtensionNotSupported(docFile.relative, docFile.extname);
+        const doc = await docReader.read(docFile.relative, docFile.contents, component);
+        return doc;
+      } catch (err: any) {
+        // it's ok to fail here.
+        this.logger.debug(`docs.main.runtime.computeDoc caught an error: ${err.message}`);
+        return null;
+      }
+    }
+
+    return null;
+  }
+
+  getDoc(component: IComponent) {
+    const docData = component.get(DocsAspect.id)?.data?.doc;
+    if (!docData) return null;
+    return new Doc(docData.filePath, new DocPropList(docData.props));
+  }
+
+  getPatterns() {
+    return this.patterns;
+  }
+
+  getComponentDevPatterns(component: Component) {
+    const env = this.envs.calculateEnv(component, { skipWarnings: !!this.workspace?.inInstallContext }).env;
+    const componentEnvDocsDevPatterns: string[] = env.getDocsDevPatterns ? env.getDocsDevPatterns(component) : [];
+    const componentPatterns = componentEnvDocsDevPatterns.concat(this.getPatterns());
+    return { name: 'docs', pattern: componentPatterns };
+  }
+
+  getDevPatternToRegister() {
+    return this.getComponentDevPatterns.bind(this);
+  }
+  /**
+   * register a new doc reader. this allows to support further
+   * documentation file formats.
+   */
+  registerDocReader(docReader: DocReader) {
+    this.docReaderSlot.register(docReader);
+    return this;
+  }
+
+  static slots = [Slot.withType<DocProp>(), Slot.withType<DocReader>()];
+
+  static runtime = MainRuntime;
+  static dependencies = [
+    PreviewAspect,
+    GraphqlAspect,
+    WorkspaceAspect,
+    PkgAspect,
+    CompilerAspect,
+    LoggerAspect,
+    DevFilesAspect,
+    EnvsAspect,
+    ScopeAspect,
+  ];
+
+  static defaultConfig = {
+    patterns: ['**/*.docs.*'],
+  };
+
+  static async provider(
+    [preview, graphql, workspace, pkg, compiler, loggerAspect, devFiles, envs, scope]: [
+      PreviewMain,
+      GraphqlMain,
+      Workspace,
+      PkgMain,
+      CompilerMain,
+      LoggerMain,
+      DevFilesMain,
+      EnvsMain,
+      ScopeMain
+    ],
+    config: DocsConfig,
+    [docPropSlot, docReaderSlot]: [DocPropSlot, DocReaderSlot]
+  ) {
+    const logger = loggerAspect.createLogger(DocsAspect.id);
+    const docs = new DocsMain(
+      config.patterns,
+      preview,
+      pkg,
+      compiler,
+      workspace,
+      logger,
+      devFiles,
+      envs,
+      docPropSlot,
+      docReaderSlot
+    );
+    docs.registerDocReader(new DefaultDocReader(pkg, compiler, workspace));
+    devFiles.registerDevPattern(docs.getDevPatternToRegister());
+
+    const computeDocsOnLoad = async (component: Component, opts?: ComponentLoadOptions) => {
+      if (opts?.loadDocs === false) return undefined;
+      // const docFiles = await docs.computeDocs(component);
+      const doc = await docs.computeDoc(component);
+
+      return {
+        doc: doc?.toObject(),
+        // docFiles
+      };
+    };
+
+    if (workspace) {
+      workspace.registerOnComponentLoad(computeDocsOnLoad);
+    }
+    if (scope) {
+      scope.registerOnCompAspectReCalc(computeDocsOnLoad);
+    }
+
+    graphql.register(docsSchema(docs));
+
+    preview.registerDefinition(new DocsPreviewDefinition(docs));
+    return docs;
+  }
+}
+
+DocsAspect.addRuntime(DocsMain);

package/docs.preview-definition.ts

@@ -0,0 +1,38 @@
+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 { DocsMain } from './docs.main.runtime';
+
+export class DocsPreviewDefinition implements PreviewDefinition {
+  readonly prefix = 'overview';
+  readonly include = ['compositions'];
+  readonly includePeers = true;
+
+  constructor(
+    /**
+     * docs extension.
+     */
+    private docs: DocsMain
+  ) {}
+
+  /**
+   * application root
+   */
+  async renderTemplatePath(context: ExecutionContext): Promise<string | undefined> {
+    return this.renderTemplatePathByEnv(context.env);
+  }
+
+  async renderTemplatePathByEnv(env: Environment): Promise<string | undefined> {
+    return this.docs.getTemplate(env);
+  }
+
+  /**
+   * files to load.
+   */
+  async getModuleMap(components: Component[]): Promise<ComponentMap<AbstractVinyl[]>> {
+    const map = this.docs.getDocsMap(components);
+    return map;
+  }
+}

package/docs.service.ts

@@ -0,0 +1,9 @@
+import { EnvService, ExecutionContext } from '@teambit/envs';
+
+export class DocsService implements EnvService<any> {
+  name = 'docs';
+
+  async run(context: ExecutionContext) {
+    return context.env.getDocsTemplate();
+  }
+}

package/docs.ts

@@ -0,0 +1,38 @@
+import React, { ReactElement } from 'react';
+
+export type Example = {
+  title?: string;
+  description?: ReactElement;
+  scope?: { [key: string]: any };
+  jsx?: JSX.Element;
+  code: string;
+};
+
+export type Docs = {
+  /**
+   * default is the docs content.
+   */
+  default: React.ComponentType;
+
+  /**
+   * component abstract.
+   */
+  abstract: string;
+
+  /**
+   * array of labels.
+   */
+  labels: string[];
+
+  /**
+   * @deprecated
+   */
+  examples: Example[];
+};
+
+export const defaultDocs: Docs = {
+  default: () => null,
+  labels: [],
+  abstract: '',
+  examples: [],
+};

package/index.ts

@@ -0,0 +1,21 @@
+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, DocsRootProps } from './docs.preview.runtime';
+export type { DocReader } from './doc-reader';
+export type { Docs, Example } from './docs';
+export { defaultDocs } from './docs';
+
+export type { TitleBadgeSlot, TitleBadge, OverviewOptionsSlot, OverviewOptions } from './overview';
+export { BadgePosition } from './overview';
+export { Overview } from './overview';
+
+export { DocsAspect };
+export default DocsAspect;

package/package.json

@@ -1,59 +1,57 @@
 {
   "name": "@teambit/docs",
-  "version": "1.0.107",
+  "version": "1.0.108",
   "homepage": "https://bit.cloud/teambit/docs/docs",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.docs",
     "name": "docs",
-    "version": "1.0.107"
+    "version": "1.0.108"
   },
   "dependencies": {
     "graphql-tag": "2.12.1",
     "lodash": "4.17.21",
     "classnames": "2.2.6",
-    "core-js": "^3.0.0",
-    "@babel/runtime": "7.20.0",
     "@teambit/docs.entities.doc": "0.0.12",
     "@teambit/harmony": "0.4.6",
-    "@teambit/component-id": "1.2.0",
     "@teambit/docs.ui.overview-compare-section": "0.0.100",
     "@teambit/docs.ui.overview-compare": "1.0.10",
     "@teambit/component.ui.component-meta": "0.0.358",
     "@teambit/base-ui.loaders.skeleton": "1.0.1",
-    "@teambit/compiler": "1.0.107",
-    "@teambit/component": "1.0.107",
-    "@teambit/pkg": "1.0.107",
-    "@teambit/workspace": "1.0.107",
-    "@teambit/cli": "0.0.839",
-    "@teambit/dev-files": "1.0.107",
-    "@teambit/envs": "1.0.107",
-    "@teambit/graphql": "1.0.107",
-    "@teambit/logger": "0.0.932",
-    "@teambit/preview": "1.0.107",
-    "@teambit/scope": "1.0.107",
-    "@teambit/component-compare": "1.0.107",
-    "@teambit/ui": "1.0.107",
-    "@teambit/pubsub": "1.0.107",
-    "@teambit/compositions.panels.composition-gallery": "0.0.201",
-    "@teambit/preview.ui.component-preview": "1.0.3",
-    "@teambit/react.ui.docs.properties-table": "0.0.22"
+    "@teambit/compiler": "1.0.108",
+    "@teambit/component": "1.0.108",
+    "@teambit/pkg": "1.0.108",
+    "@teambit/workspace": "1.0.108",
+    "@teambit/cli": "0.0.840",
+    "@teambit/dev-files": "1.0.108",
+    "@teambit/envs": "1.0.108",
+    "@teambit/graphql": "1.0.108",
+    "@teambit/logger": "0.0.933",
+    "@teambit/preview": "1.0.108",
+    "@teambit/scope": "1.0.108",
+    "@teambit/component-compare": "1.0.108",
+    "@teambit/ui": "1.0.108",
+    "@teambit/pubsub": "1.0.108",
+    "@teambit/compositions.panels.composition-gallery": "0.0.202",
+    "@teambit/react.ui.docs.properties-table": "0.0.22",
+    "@teambit/preview.ui.component-preview": "1.0.3"
   },
   "devDependencies": {
-    "@types/react-dom": "^17.0.5",
-    "@types/react": "^17.0.8",
     "@types/lodash": "4.14.165",
     "@types/classnames": "2.2.11",
     "@types/mocha": "9.1.0",
-    "@types/node": "12.20.4",
-    "@types/jest": "^26.0.0",
-    "@types/testing-library__jest-dom": "5.9.5",
-    "@teambit/docs.content.docs-overview": "1.95.9"
+    "@types/jest": "^29.2.2",
+    "@types/testing-library__jest-dom": "^5.9.5",
+    "@teambit/docs.content.docs-overview": "1.95.9",
+    "@teambit/component-id": "1.2.0",
+    "@teambit/harmony.envs.core-aspect-env": "0.0.13"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.624",
-    "react": "^16.8.0 || ^17.0.0",
-    "react-dom": "^16.8.0 || ^17.0.0"
+    "react": "^17.0.0 || ^18.0.0",
+    "react-dom": "^17.0.0 || ^18.0.0",
+    "@types/react": "^18.2.12",
+    "@types/react-dom": "^18.2.5",
+    "@teambit/legacy": "1.0.624"
   },
   "license": "Apache-2.0",
   "optionalDependencies": {},
@@ -67,7 +65,7 @@
   },
   "private": false,
   "engines": {
-    "node": ">=12.22.0"
+    "node": ">=16.0.0"
   },
   "repository": {
     "type": "git",
@@ -76,12 +74,9 @@
   "keywords": [
     "bit",
     "bit-aspect",
+    "bit-core-aspect",
     "components",
     "collaboration",
-    "web",
-    "react",
-    "react-components",
-    "angular",
-    "angular-components"
+    "web"
   ]
 }

package/tsconfig.json

@@ -1,38 +1,33 @@
 {
   "compilerOptions": {
     "lib": [
-      "es2019",
-      "DOM",
-      "ES6",
-      "DOM.Iterable",
-      "ScriptHost"
+      "esnext",
+      "dom",
+      "dom.Iterable"
     ],
-    "target": "es2015",
-    "module": "CommonJS",
-    "jsx": "react",
-    "allowJs": true,
-    "composite": true,
+    "target": "es2020",
+    "module": "es2020",
+    "jsx": "react-jsx",
     "declaration": true,
     "sourceMap": true,
-    "skipLibCheck": true,
     "experimentalDecorators": true,
-    "outDir": "dist",
+    "skipLibCheck": true,
     "moduleResolution": "node",
     "esModuleInterop": true,
-    "rootDir": ".",
     "resolveJsonModule": true,
-    "emitDeclarationOnly": true,
-    "emitDecoratorMetadata": true,
-    "allowSyntheticDefaultImports": true,
-    "strictPropertyInitialization": false,
-    "strict": true,
-    "noImplicitAny": false,
-    "preserveConstEnums": true
+    "allowJs": true,
+    "outDir": "dist",
+    "emitDeclarationOnly": true
   },
   "exclude": [
+    "artifacts",
+    "public",
     "dist",
+    "node_modules",
+    "package.json",
     "esm.mjs",
-    "package.json"
+    "**/*.cjs",
+    "./dist"
   ],
   "include": [
     "**/*",

package/types/asset.d.ts

@@ -5,12 +5,12 @@ declare module '*.png' {
 declare module '*.svg' {
   import type { FunctionComponent, SVGProps } from 'react';
 
-  export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
+  export const ReactComponent: FunctionComponent<
+    SVGProps<SVGSVGElement> & { title?: string }
+  >;
   const src: string;
   export default src;
 }
-
-// @TODO Gilad
 declare module '*.jpg' {
   const value: any;
   export = value;
@@ -27,3 +27,15 @@ declare module '*.bmp' {
   const value: any;
   export = value;
 }
+declare module '*.otf' {
+  const value: any;
+  export = value;
+}
+declare module '*.woff' {
+  const value: any;
+  export = value;
+}
+declare module '*.woff2' {
+  const value: any;
+  export = value;
+}