@teambit/docs 0.0.714 → 0.0.717

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/dist/docs.main.runtime.d.ts +8 -3
  2. package/dist/docs.main.runtime.js +28 -10
  3. package/dist/docs.main.runtime.js.map +1 -1
  4. package/dist/overview/overview.js +2 -1
  5. package/dist/overview/overview.js.map +1 -1
  6. package/overview/overview.tsx +1 -0
  7. package/package-tar/teambit-docs-0.0.717.tgz +0 -0
  8. package/package.json +18 -18
  9. package/{preview-1650684349376.js → preview-1650916592801.js} +2 -2
  10. package/package-tar/teambit-docs-0.0.714.tgz +0 -0
package/dist/docs.main.runtime.d.ts CHANGED
@@ -10,6 +10,7 @@ import { DevFilesMain } from '@teambit/dev-files';
10
10
  import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
11
11
  import { Workspace } from '@teambit/workspace';
12
12
  import { Doc } from '@teambit/docs.entities.doc';
13
+ import { EnvsMain } from '@teambit/envs';
13
14
  import { DocReader } from './doc-reader';
14
15
  export declare type ComponentDocs = {
15
16
  files: string[];
@@ -38,13 +39,14 @@ export declare class DocsMain {
38
39
  private workspace;
39
40
  private logger;
40
41
  private devFiles;
42
+ private envs;
41
43
  private docPropSlot;
42
44
  private docReaderSlot;
43
45
  constructor(patterns: string[],
44
46
  /**
45
47
  * envs extension.
46
48
  */
47
- preview: PreviewMain, pkg: PkgMain, compiler: CompilerMain, workspace: Workspace, logger: Logger, devFiles: DevFilesMain, docPropSlot: DocPropSlot, docReaderSlot: DocReaderSlot);
49
+ preview: PreviewMain, pkg: PkgMain, compiler: CompilerMain, workspace: Workspace, logger: Logger, devFiles: DevFilesMain, envs: EnvsMain, docPropSlot: DocPropSlot, docReaderSlot: DocReaderSlot);
48
50
  /**
49
51
  * returns an array of doc file paths for a set of components.
50
52
  */
@@ -62,6 +64,8 @@ export declare class DocsMain {
62
64
  computeDoc(component: Component): Promise<Doc | null>;
63
65
  getDoc(component: Component): Doc | null;
64
66
  getPatterns(): string[];
67
+ getComponentDevPatterns(component: Component): string[];
68
+ getDevPatternToRegister(): (component: Component) => string[];
65
69
  /**
66
70
  * register a new doc reader. this allows to support further
67
71
  * documentation file formats.
@@ -73,13 +77,14 @@ export declare class DocsMain {
73
77
  static defaultConfig: {
74
78
  patterns: string[];
75
79
  };
76
- static provider([preview, graphql, workspace, pkg, compiler, loggerAspect, devFiles]: [
80
+ static provider([preview, graphql, workspace, pkg, compiler, loggerAspect, devFiles, envs]: [
77
81
  PreviewMain,
78
82
  GraphqlMain,
79
83
  Workspace,
80
84
  PkgMain,
81
85
  CompilerMain,
82
86
  LoggerMain,
83
- DevFilesMain
87
+ DevFilesMain,
88
+ EnvsMain
84
89
  ], config: DocsConfig, [docPropSlot, docReaderSlot]: [DocPropSlot, DocReaderSlot]): Promise<DocsMain>;
85
90
  }
package/dist/docs.main.runtime.js CHANGED
@@ -64,7 +64,7 @@ function _compiler() {
64
64
  }
65
65
 
66
66
  function _component() {
67
- const data = _interopRequireWildcard(require("@teambit/component"));
67
+ const data = require("@teambit/component");
68
68
 
69
69
  _component = function () {
70
70
  return data;
@@ -133,6 +133,16 @@ function _docsEntities() {
133
133
  return data;
134
134
  }
135
135
 
136
+ function _envs() {
137
+ const data = require("@teambit/envs");
138
+
139
+ _envs = function () {
140
+ return data;
141
+ };
142
+
143
+ return data;
144
+ }
145
+
136
146
  function _docs() {
137
147
  const data = require("./docs.aspect");
138
148
 
@@ -183,10 +193,6 @@ function _exceptions() {
183
193
  return data;
184
194
  }
185
195
 
186
- function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
187
-
188
- function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
189
-
190
196
  /**
191
197
  * the component documentation extension.
192
198
  */
@@ -195,7 +201,7 @@ class DocsMain {
195
201
  /**
196
202
  * envs extension.
197
203
  */
198
- preview, pkg, compiler, workspace, logger, devFiles, docPropSlot, docReaderSlot) {
204
+ preview, pkg, compiler, workspace, logger, devFiles, envs, docPropSlot, docReaderSlot) {
199
205
  this.patterns = patterns;
200
206
  this.preview = preview;
201
207
  this.pkg = pkg;
@@ -203,6 +209,7 @@ class DocsMain {
203
209
  this.workspace = workspace;
204
210
  this.logger = logger;
205
211
  this.devFiles = devFiles;
212
+ this.envs = envs;
206
213
  this.docPropSlot = docPropSlot;
207
214
  this.docReaderSlot = docReaderSlot;
208
215
  }
@@ -282,6 +289,17 @@ class DocsMain {
282
289
  getPatterns() {
283
290
  return this.patterns;
284
291
  }
292
+
293
+ getComponentDevPatterns(component) {
294
+ const env = this.envs.calculateEnv(component).env;
295
+ const componentEnvDocsDevPatterns = env.getDocsDevPatterns ? env.getDocsDevPatterns(component) : [];
296
+ const componentPatterns = componentEnvDocsDevPatterns.concat(this.getPatterns());
297
+ return componentPatterns;
298
+ }
299
+
300
+ getDevPatternToRegister() {
301
+ return this.getComponentDevPatterns.bind(this);
302
+ }
285
303
  /**
286
304
  * register a new doc reader. this allows to support further
287
305
  * documentation file formats.
@@ -293,11 +311,11 @@ class DocsMain {
293
311
  return this;
294
312
  }
295
313
 
296
- static async provider([preview, graphql, workspace, pkg, compiler, loggerAspect, devFiles], config, [docPropSlot, docReaderSlot]) {
314
+ static async provider([preview, graphql, workspace, pkg, compiler, loggerAspect, devFiles, envs], config, [docPropSlot, docReaderSlot]) {
297
315
  const logger = loggerAspect.createLogger(_docs().DocsAspect.id);
298
- const docs = new DocsMain(config.patterns, preview, pkg, compiler, workspace, logger, devFiles, docPropSlot, docReaderSlot);
316
+ const docs = new DocsMain(config.patterns, preview, pkg, compiler, workspace, logger, devFiles, envs, docPropSlot, docReaderSlot);
299
317
  docs.registerDocReader(new (_defaultDocReader().DefaultDocReader)(pkg, compiler, workspace));
300
- devFiles.registerDevPattern(config.patterns);
318
+ devFiles.registerDevPattern(docs.getDevPatternToRegister());
301
319
 
302
320
  if (workspace) {
303
321
  workspace.onComponentLoad(async component => {
@@ -318,7 +336,7 @@ class DocsMain {
318
336
  exports.DocsMain = DocsMain;
319
337
  (0, _defineProperty2().default)(DocsMain, "slots", [_harmony().Slot.withType(), _harmony().Slot.withType()]);
320
338
  (0, _defineProperty2().default)(DocsMain, "runtime", _cli().MainRuntime);
321
- (0, _defineProperty2().default)(DocsMain, "dependencies", [_preview().PreviewAspect, _graphql().GraphqlAspect, _workspace().WorkspaceAspect, _pkg().PkgAspect, _compiler().CompilerAspect, _logger().LoggerAspect, _devFiles().default, _component().default]);
339
+ (0, _defineProperty2().default)(DocsMain, "dependencies", [_preview().PreviewAspect, _graphql().GraphqlAspect, _workspace().WorkspaceAspect, _pkg().PkgAspect, _compiler().CompilerAspect, _logger().LoggerAspect, _devFiles().default, _envs().EnvsAspect]);
322
340
  (0, _defineProperty2().default)(DocsMain, "defaultConfig", {
323
341
  patterns: ['**/*.docs.*']
324
342
  });
package/dist/docs.main.runtime.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["docs.main.runtime.ts"],"names":["DocsMain","constructor","patterns","preview","pkg","compiler","workspace","logger","devFiles","docPropSlot","docReaderSlot","getDocsMap","components","ComponentMap","as","component","getDocsFiles","computeDevFiles","docFiles","get","DocsAspect","id","state","filesystem","files","filter","file","includes","relative","getDescription","componentDoc","getDoc","desc","description","consumerComponent","_consumer","fromJsDocs","docs","find","doc","getTemplate","env","getDocsTemplate","getDocReader","extension","values","docReader","isFormatSupported","computeDoc","length","docFile","extname","FileExtensionNotSupported","read","contents","err","error","docData","aspects","data","Doc","filePath","DocPropList","props","getPatterns","registerDocReader","register","provider","graphql","loggerAspect","config","createLogger","DefaultDocReader","registerDevPattern","onComponentLoad","toObject","registerDefinition","DocsPreviewDefinition","Slot","withType","MainRuntime","PreviewAspect","GraphqlAspect","WorkspaceAspect","PkgAspect","CompilerAspect","LoggerAspect","DevFilesAspect","ComponentAspect","addRuntime"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAEA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAGA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAEA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;;;;;AAoBA;AACA;AACA;AACO,MAAMA,QAAN,CAAe;AACpBC,EAAAA,WAAW,CACDC,QADC;AAET;AACJ;AACA;AACYC,EAAAA,OALC,EAODC,GAPC,EASDC,QATC,EAWDC,SAXC,EAaDC,MAbC,EAeDC,QAfC,EAiBDC,WAjBC,EAmBDC,aAnBC,EAoBT;AAAA,SAnBQR,QAmBR,GAnBQA,QAmBR;AAAA,SAfQC,OAeR,GAfQA,OAeR;AAAA,SAbQC,GAaR,GAbQA,GAaR;AAAA,SAXQC,QAWR,GAXQA,QAWR;AAAA,SATQC,SASR,GATQA,SASR;AAAA,SAPQC,MAOR,GAPQA,MAOR;AAAA,SALQC,QAKR,GALQA,QAKR;AAAA,SAHQC,WAGR,GAHQA,WAGR;AAAA,SADQC,aACR,GADQA,aACR;AAAE;AAEJ;AACF;AACA;;;AACEC,EAAAA,UAAU,CAACC,UAAD,EAAyD;AACjE,WAAOC,0BAAaC,EAAb,CAAiCF,UAAjC,EAA8CG,SAAD,IAAe;AACjE,aAAO,KAAKC,YAAL,CAAkBD,SAAlB,CAAP;AACD,KAFM,CAAP;AAGD;;AAEDC,EAAAA,YAAY,CAACD,SAAD,EAAwC;AAClD,UAAMP,QAAQ,GAAG,KAAKA,QAAL,CAAcS,eAAd,CAA8BF,SAA9B,CAAjB;AACA,UAAMG,QAAQ,GAAGV,QAAQ,CAACW,GAAT,CAAaC,mBAAWC,EAAxB,CAAjB;AACA,WAAON,SAAS,CAACO,KAAV,CAAgBC,UAAhB,CAA2BC,KAA3B,CAAiCC,MAAjC,CAAyCC,IAAD,IAAUR,QAAQ,CAACS,QAAT,CAAkBD,IAAI,CAACE,QAAvB,CAAlD,CAAP;AACD;AAED;AACF;AACA;;;AACsB,QAAdC,cAAc,CAACd,SAAD,EAAwC;AAAA;;AAC1D,UAAMe,YAAY,GAAG,KAAKC,MAAL,CAAYhB,SAAZ,CAArB;AACA,UAAMiB,IAAI,GAAGF,YAAH,aAAGA,YAAH,uBAAGA,YAAY,CAAEG,WAA3B;AACA,QAAID,IAAJ,EAAU,OAAOA,IAAP;AACV,UAAME,iBAAoC,GAAGnB,SAAS,CAACO,KAAV,CAAgBa,SAA7D;AACA,UAAMC,UAAU,4BAAGF,iBAAiB,CAACG,IAArB,0DAAG,sBAAwBC,IAAxB,CAA8BC,GAAD,IAASA,GAAG,CAACN,WAA1C,CAAnB;AAEA,WAAO,CAAAG,UAAU,SAAV,IAAAA,UAAU,WAAV,YAAAA,UAAU,CAAEH,WAAZ,KAA2B,EAAlC;AACD;;AAEgB,QAAXO,WAAW,CAACC,GAAD,EAAmB;AAClC,WAAOA,GAAG,CAACC,eAAJ,EAAP;AACD;;AAEDC,EAAAA,YAAY,CAACC,SAAD,EAAoB;AAC9B,WAAO,KAAKlC,aAAL,CAAmBmC,MAAnB,GAA4BP,IAA5B,CAAkCQ,SAAD,IAAeA,SAAS,CAACC,iBAAV,CAA4BH,SAA5B,CAAhD,CAAP;AACD;AAED;AACF;AACA;;;AACkB,QAAVI,UAAU,CAACjC,SAAD,EAAuB;AACrC,UAAMG,QAAQ,GAAG,KAAKF,YAAL,CAAkBD,SAAlB,CAAjB;;AACA,QAAIG,QAAQ,CAAC+B,MAAb,EAAqB;AACnB;AACA,YAAMC,OAAO,GAAGhC,QAAQ,CAAC,CAAD,CAAxB;;AAEA,UAAI;AACF,cAAM4B,SAAS,GAAG,KAAKH,YAAL,CAAkBO,OAAO,CAACC,OAA1B,CAAlB;AACA,YAAI,CAACL,SAAL,EAAgB,MAAM,KAAIM,uCAAJ,EAA8BF,OAAO,CAACtB,QAAtC,EAAgDsB,OAAO,CAACC,OAAxD,CAAN;AAChB,cAAMZ,GAAG,GAAG,MAAMO,SAAS,CAACO,IAAV,CAAeH,OAAO,CAACtB,QAAvB,EAAiCsB,OAAO,CAACI,QAAzC,EAAmDvC,SAAnD,CAAlB;AACA,eAAOwB,GAAP;AACD,OALD,CAKE,OAAOgB,GAAP,EAAiB;AACjB,aAAKhD,MAAL,CAAYiD,KAAZ,CAAkB,8CAAlB,EAAkED,GAAlE;AACA,eAAO,IAAP;AACD;AACF;;AAED,WAAO,IAAP;AACD;;AAEDxB,EAAAA,MAAM,CAAChB,SAAD,EAAuB;AAAA;;AAC3B,UAAM0C,OAAO,4BAAG1C,SAAS,CAACO,KAAV,CAAgBoC,OAAhB,CAAwBvC,GAAxB,CAA4BC,mBAAWC,EAAvC,CAAH,oFAAG,sBAA4CsC,IAA/C,2DAAG,uBAAkDpB,GAAlE;AACA,QAAI,CAACkB,OAAL,EAAc,OAAO,IAAP;AACd,WAAO,KAAIG,mBAAJ,EAAQH,OAAO,CAACI,QAAhB,EAA0B,KAAIC,2BAAJ,EAAgBL,OAAO,CAACM,KAAxB,CAA1B,CAAP;AACD;;AAEDC,EAAAA,WAAW,GAAG;AACZ,WAAO,KAAK9D,QAAZ;AACD;AAED;AACF;AACA;AACA;;;AACE+D,EAAAA,iBAAiB,CAACnB,SAAD,EAAuB;AACtC,SAAKpC,aAAL,CAAmBwD,QAAnB,CAA4BpB,SAA5B;AACA,WAAO,IAAP;AACD;;AAoBoB,eAARqB,QAAQ,CACnB,CAAChE,OAAD,EAAUiE,OAAV,EAAmB9D,SAAnB,EAA8BF,GAA9B,EAAmCC,QAAnC,EAA6CgE,YAA7C,EAA2D7D,QAA3D,CADmB,EAUnB8D,MAVmB,EAWnB,CAAC7D,WAAD,EAAcC,aAAd,CAXmB,EAYnB;AACA,UAAMH,MAAM,GAAG8D,YAAY,CAACE,YAAb,CAA0BnD,mBAAWC,EAArC,CAAf;AACA,UAAMgB,IAAI,GAAG,IAAIrC,QAAJ,CACXsE,MAAM,CAACpE,QADI,EAGXC,OAHW,EAKXC,GALW,EAOXC,QAPW,EASXC,SATW,EAWXC,MAXW,EAaXC,QAbW,EAeXC,WAfW,EAiBXC,aAjBW,CAAb;AAmBA2B,IAAAA,IAAI,CAAC4B,iBAAL,CAAuB,KAAIO,oCAAJ,EAAqBpE,GAArB,EAA0BC,QAA1B,EAAoCC,SAApC,CAAvB;AACAE,IAAAA,QAAQ,CAACiE,kBAAT,CAA4BH,MAAM,CAACpE,QAAnC;;AAEA,QAAII,SAAJ,EAAe;AACbA,MAAAA,SAAS,CAACoE,eAAV,CAA0B,MAAO3D,SAAP,IAAqB;AAC7C,cAAMwB,GAAG,GAAG,MAAMF,IAAI,CAACW,UAAL,CAAgBjC,SAAhB,CAAlB;AAEA,eAAO;AACLwB,UAAAA,GAAG,EAAEA,GAAF,aAAEA,GAAF,uBAAEA,GAAG,CAAEoC,QAAL;AADA,SAAP;AAGD,OAND;AAOD;;AAEDP,IAAAA,OAAO,CAACF,QAAR,CAAiB,yBAAW7B,IAAX,CAAjB;AAEAlC,IAAAA,OAAO,CAACyE,kBAAR,CAA2B,KAAIC,8BAAJ,EAA0BxC,IAA1B,CAA3B;AACA,WAAOA,IAAP;AACD;;AAzKmB;;;gCAATrC,Q,WAqGI,CAAC8E,gBAAKC,QAAL,EAAD,EAA2BD,gBAAKC,QAAL,EAA3B,C;gCArGJ/E,Q,aAuGMgF,kB;gCAvGNhF,Q,kBAwGW,CACpBiF,wBADoB,EAEpBC,wBAFoB,EAGpBC,4BAHoB,EAIpBC,gBAJoB,EAKpBC,0BALoB,EAMpBC,sBANoB,EAOpBC,mBAPoB,EAQpBC,oBARoB,C;gCAxGXxF,Q,mBAmHY;AACrBE,EAAAA,QAAQ,EAAE,CAAC,aAAD;AADW,C;;AAyDzBkB,mBAAWqE,UAAX,CAAsBzF,QAAtB","sourcesContent":["import { Slot, SlotRegistry } from '@teambit/harmony';\nimport { MainRuntime } from '@teambit/cli';\nimport { LoggerAspect, LoggerMain, Logger } from '@teambit/logger';\nimport { CompilerAspect, CompilerMain } from '@teambit/compiler';\nimport ComponentAspect, { Component, ComponentMap } from '@teambit/component';\nimport { PkgAspect, PkgMain } from '@teambit/pkg';\nimport type { Environment } from '@teambit/envs';\nimport { GraphqlAspect, GraphqlMain } from '@teambit/graphql';\nimport { PreviewAspect, PreviewMain } from '@teambit/preview';\nimport DevFilesAspect, { DevFilesMain } from '@teambit/dev-files';\nimport { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';\nimport ConsumerComponent from '@teambit/legacy/dist/consumer/component';\nimport { Workspace, WorkspaceAspect } from '@teambit/workspace';\nimport { Doc, DocPropList } from '@teambit/docs.entities.doc';\nimport { DocsAspect } from './docs.aspect';\nimport { DocsPreviewDefinition } from './docs.preview-definition';\nimport { docsSchema } from './docs.graphql';\nimport { DocReader } from './doc-reader';\nimport { DefaultDocReader } from './default-doc-reader';\nimport { FileExtensionNotSupported } from './exceptions';\n\nexport type ComponentDocs = {\n files: string[];\n component: Component;\n};\n\nexport type DocProp = {};\n\nexport type DocPropSlot = SlotRegistry<DocProp>;\n\nexport type DocReaderSlot = SlotRegistry<DocReader>;\n\nexport type DocsConfig = {\n /**\n * glob patterns to identify doc files.\n */\n patterns: string[];\n};\n\n/**\n * the component documentation extension.\n */\nexport class DocsMain {\n constructor(\n private patterns: string[],\n /**\n * envs extension.\n */\n private preview: PreviewMain,\n\n private pkg: PkgMain,\n\n private compiler: CompilerMain,\n\n private workspace: Workspace,\n\n private logger: Logger,\n\n private devFiles: DevFilesMain,\n\n private docPropSlot: DocPropSlot,\n\n private docReaderSlot: DocReaderSlot\n ) {}\n\n /**\n * returns an array of doc file paths for a set of components.\n */\n getDocsMap(components: Component[]): ComponentMap<AbstractVinyl[]> {\n return ComponentMap.as<AbstractVinyl[]>(components, (component) => {\n return this.getDocsFiles(component);\n });\n }\n\n getDocsFiles(component: Component): AbstractVinyl[] {\n const devFiles = this.devFiles.computeDevFiles(component);\n const docFiles = devFiles.get(DocsAspect.id);\n return component.state.filesystem.files.filter((file) => docFiles.includes(file.relative));\n }\n\n /**\n * compute the description of the component from its source code and docs file.\n */\n async getDescription(component: Component): Promise<string> {\n const componentDoc = this.getDoc(component);\n const desc = componentDoc?.description;\n if (desc) return desc;\n const consumerComponent: ConsumerComponent = component.state._consumer;\n const fromJsDocs = consumerComponent.docs?.find((doc) => doc.description);\n\n return fromJsDocs?.description || '';\n }\n\n async getTemplate(env: Environment) {\n return env.getDocsTemplate();\n }\n\n getDocReader(extension: string) {\n return this.docReaderSlot.values().find((docReader) => docReader.isFormatSupported(extension));\n }\n\n /**\n * compute a doc for a component.\n */\n async computeDoc(component: Component) {\n const docFiles = this.getDocsFiles(component);\n if (docFiles.length) {\n // currently taking the the first docs file found with an abstract. (we support only one)\n const docFile = docFiles[0];\n\n try {\n const docReader = this.getDocReader(docFile.extname);\n if (!docReader) throw new FileExtensionNotSupported(docFile.relative, docFile.extname);\n const doc = await docReader.read(docFile.relative, docFile.contents, component);\n return doc;\n } catch (err: any) {\n this.logger.error('docs.main.runtime.computeDoc caught an error', err);\n return null;\n }\n }\n\n return null;\n }\n\n getDoc(component: Component) {\n const docData = component.state.aspects.get(DocsAspect.id)?.data?.doc;\n if (!docData) return null;\n return new Doc(docData.filePath, new DocPropList(docData.props));\n }\n\n getPatterns() {\n return this.patterns;\n }\n\n /**\n * register a new doc reader. this allows to support further\n * documentation file formats.\n */\n registerDocReader(docReader: DocReader) {\n this.docReaderSlot.register(docReader);\n return this;\n }\n\n static slots = [Slot.withType<DocProp>(), Slot.withType<DocReader>()];\n\n static runtime = MainRuntime;\n static dependencies = [\n PreviewAspect,\n GraphqlAspect,\n WorkspaceAspect,\n PkgAspect,\n CompilerAspect,\n LoggerAspect,\n DevFilesAspect,\n ComponentAspect,\n ];\n\n static defaultConfig = {\n patterns: ['**/*.docs.*'],\n };\n\n static async provider(\n [preview, graphql, workspace, pkg, compiler, loggerAspect, devFiles]: [\n PreviewMain,\n GraphqlMain,\n Workspace,\n PkgMain,\n CompilerMain,\n LoggerMain,\n DevFilesMain\n ],\n config: DocsConfig,\n [docPropSlot, docReaderSlot]: [DocPropSlot, DocReaderSlot]\n ) {\n const logger = loggerAspect.createLogger(DocsAspect.id);\n const docs = new DocsMain(\n config.patterns,\n\n preview,\n\n pkg,\n\n compiler,\n\n workspace,\n\n logger,\n\n devFiles,\n\n docPropSlot,\n\n docReaderSlot\n );\n docs.registerDocReader(new DefaultDocReader(pkg, compiler, workspace));\n devFiles.registerDevPattern(config.patterns);\n\n if (workspace) {\n workspace.onComponentLoad(async (component) => {\n const doc = await docs.computeDoc(component);\n\n return {\n doc: doc?.toObject(),\n };\n });\n }\n\n graphql.register(docsSchema(docs));\n\n preview.registerDefinition(new DocsPreviewDefinition(docs));\n return docs;\n }\n}\n\nDocsAspect.addRuntime(DocsMain);\n"]}
1
+ {"version":3,"sources":["docs.main.runtime.ts"],"names":["DocsMain","constructor","patterns","preview","pkg","compiler","workspace","logger","devFiles","envs","docPropSlot","docReaderSlot","getDocsMap","components","ComponentMap","as","component","getDocsFiles","computeDevFiles","docFiles","get","DocsAspect","id","state","filesystem","files","filter","file","includes","relative","getDescription","componentDoc","getDoc","desc","description","consumerComponent","_consumer","fromJsDocs","docs","find","doc","getTemplate","env","getDocsTemplate","getDocReader","extension","values","docReader","isFormatSupported","computeDoc","length","docFile","extname","FileExtensionNotSupported","read","contents","err","error","docData","aspects","data","Doc","filePath","DocPropList","props","getPatterns","getComponentDevPatterns","calculateEnv","componentEnvDocsDevPatterns","getDocsDevPatterns","componentPatterns","concat","getDevPatternToRegister","bind","registerDocReader","register","provider","graphql","loggerAspect","config","createLogger","DefaultDocReader","registerDevPattern","onComponentLoad","toObject","registerDefinition","DocsPreviewDefinition","Slot","withType","MainRuntime","PreviewAspect","GraphqlAspect","WorkspaceAspect","PkgAspect","CompilerAspect","LoggerAspect","DevFilesAspect","EnvsAspect","addRuntime"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAEA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAGA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAEA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAoBA;AACA;AACA;AACO,MAAMA,QAAN,CAAe;AACpBC,EAAAA,WAAW,CACDC,QADC;AAET;AACJ;AACA;AACYC,EAAAA,OALC,EAODC,GAPC,EASDC,QATC,EAWDC,SAXC,EAaDC,MAbC,EAeDC,QAfC,EAiBDC,IAjBC,EAmBDC,WAnBC,EAqBDC,aArBC,EAsBT;AAAA,SArBQT,QAqBR,GArBQA,QAqBR;AAAA,SAjBQC,OAiBR,GAjBQA,OAiBR;AAAA,SAfQC,GAeR,GAfQA,GAeR;AAAA,SAbQC,QAaR,GAbQA,QAaR;AAAA,SAXQC,SAWR,GAXQA,SAWR;AAAA,SATQC,MASR,GATQA,MASR;AAAA,SAPQC,QAOR,GAPQA,QAOR;AAAA,SALQC,IAKR,GALQA,IAKR;AAAA,SAHQC,WAGR,GAHQA,WAGR;AAAA,SADQC,aACR,GADQA,aACR;AAAE;AAEJ;AACF;AACA;;;AACEC,EAAAA,UAAU,CAACC,UAAD,EAAyD;AACjE,WAAOC,0BAAaC,EAAb,CAAiCF,UAAjC,EAA8CG,SAAD,IAAe;AACjE,aAAO,KAAKC,YAAL,CAAkBD,SAAlB,CAAP;AACD,KAFM,CAAP;AAGD;;AAEDC,EAAAA,YAAY,CAACD,SAAD,EAAwC;AAClD,UAAMR,QAAQ,GAAG,KAAKA,QAAL,CAAcU,eAAd,CAA8BF,SAA9B,CAAjB;AACA,UAAMG,QAAQ,GAAGX,QAAQ,CAACY,GAAT,CAAaC,mBAAWC,EAAxB,CAAjB;AACA,WAAON,SAAS,CAACO,KAAV,CAAgBC,UAAhB,CAA2BC,KAA3B,CAAiCC,MAAjC,CAAyCC,IAAD,IAAUR,QAAQ,CAACS,QAAT,CAAkBD,IAAI,CAACE,QAAvB,CAAlD,CAAP;AACD;AAED;AACF;AACA;;;AACsB,QAAdC,cAAc,CAACd,SAAD,EAAwC;AAAA;;AAC1D,UAAMe,YAAY,GAAG,KAAKC,MAAL,CAAYhB,SAAZ,CAArB;AACA,UAAMiB,IAAI,GAAGF,YAAH,aAAGA,YAAH,uBAAGA,YAAY,CAAEG,WAA3B;AACA,QAAID,IAAJ,EAAU,OAAOA,IAAP;AACV,UAAME,iBAAoC,GAAGnB,SAAS,CAACO,KAAV,CAAgBa,SAA7D;AACA,UAAMC,UAAU,4BAAGF,iBAAiB,CAACG,IAArB,0DAAG,sBAAwBC,IAAxB,CAA8BC,GAAD,IAASA,GAAG,CAACN,WAA1C,CAAnB;AAEA,WAAO,CAAAG,UAAU,SAAV,IAAAA,UAAU,WAAV,YAAAA,UAAU,CAAEH,WAAZ,KAA2B,EAAlC;AACD;;AAEgB,QAAXO,WAAW,CAACC,GAAD,EAAmB;AAClC,WAAOA,GAAG,CAACC,eAAJ,EAAP;AACD;;AAEDC,EAAAA,YAAY,CAACC,SAAD,EAAoB;AAC9B,WAAO,KAAKlC,aAAL,CAAmBmC,MAAnB,GAA4BP,IAA5B,CAAkCQ,SAAD,IAAeA,SAAS,CAACC,iBAAV,CAA4BH,SAA5B,CAAhD,CAAP;AACD;AAED;AACF;AACA;;;AACkB,QAAVI,UAAU,CAACjC,SAAD,EAAuB;AACrC,UAAMG,QAAQ,GAAG,KAAKF,YAAL,CAAkBD,SAAlB,CAAjB;;AACA,QAAIG,QAAQ,CAAC+B,MAAb,EAAqB;AACnB;AACA,YAAMC,OAAO,GAAGhC,QAAQ,CAAC,CAAD,CAAxB;;AAEA,UAAI;AACF,cAAM4B,SAAS,GAAG,KAAKH,YAAL,CAAkBO,OAAO,CAACC,OAA1B,CAAlB;AACA,YAAI,CAACL,SAAL,EAAgB,MAAM,KAAIM,uCAAJ,EAA8BF,OAAO,CAACtB,QAAtC,EAAgDsB,OAAO,CAACC,OAAxD,CAAN;AAChB,cAAMZ,GAAG,GAAG,MAAMO,SAAS,CAACO,IAAV,CAAeH,OAAO,CAACtB,QAAvB,EAAiCsB,OAAO,CAACI,QAAzC,EAAmDvC,SAAnD,CAAlB;AACA,eAAOwB,GAAP;AACD,OALD,CAKE,OAAOgB,GAAP,EAAiB;AACjB,aAAKjD,MAAL,CAAYkD,KAAZ,CAAkB,8CAAlB,EAAkED,GAAlE;AACA,eAAO,IAAP;AACD;AACF;;AAED,WAAO,IAAP;AACD;;AAEDxB,EAAAA,MAAM,CAAChB,SAAD,EAAuB;AAAA;;AAC3B,UAAM0C,OAAO,4BAAG1C,SAAS,CAACO,KAAV,CAAgBoC,OAAhB,CAAwBvC,GAAxB,CAA4BC,mBAAWC,EAAvC,CAAH,oFAAG,sBAA4CsC,IAA/C,2DAAG,uBAAkDpB,GAAlE;AACA,QAAI,CAACkB,OAAL,EAAc,OAAO,IAAP;AACd,WAAO,KAAIG,mBAAJ,EAAQH,OAAO,CAACI,QAAhB,EAA0B,KAAIC,2BAAJ,EAAgBL,OAAO,CAACM,KAAxB,CAA1B,CAAP;AACD;;AAEDC,EAAAA,WAAW,GAAG;AACZ,WAAO,KAAK/D,QAAZ;AACD;;AAEDgE,EAAAA,uBAAuB,CAAClD,SAAD,EAAuB;AAC5C,UAAM0B,GAAG,GAAG,KAAKjC,IAAL,CAAU0D,YAAV,CAAuBnD,SAAvB,EAAkC0B,GAA9C;AACA,UAAM0B,2BAAqC,GAAG1B,GAAG,CAAC2B,kBAAJ,GAAyB3B,GAAG,CAAC2B,kBAAJ,CAAuBrD,SAAvB,CAAzB,GAA6D,EAA3G;AACA,UAAMsD,iBAAiB,GAAGF,2BAA2B,CAACG,MAA5B,CAAmC,KAAKN,WAAL,EAAnC,CAA1B;AACA,WAAOK,iBAAP;AACD;;AAEDE,EAAAA,uBAAuB,GAAG;AACxB,WAAO,KAAKN,uBAAL,CAA6BO,IAA7B,CAAkC,IAAlC,CAAP;AACD;AACD;AACF;AACA;AACA;;;AACEC,EAAAA,iBAAiB,CAAC3B,SAAD,EAAuB;AACtC,SAAKpC,aAAL,CAAmBgE,QAAnB,CAA4B5B,SAA5B;AACA,WAAO,IAAP;AACD;;AAoBoB,eAAR6B,QAAQ,CACnB,CAACzE,OAAD,EAAU0E,OAAV,EAAmBvE,SAAnB,EAA8BF,GAA9B,EAAmCC,QAAnC,EAA6CyE,YAA7C,EAA2DtE,QAA3D,EAAqEC,IAArE,CADmB,EAWnBsE,MAXmB,EAYnB,CAACrE,WAAD,EAAcC,aAAd,CAZmB,EAanB;AACA,UAAMJ,MAAM,GAAGuE,YAAY,CAACE,YAAb,CAA0B3D,mBAAWC,EAArC,CAAf;AACA,UAAMgB,IAAI,GAAG,IAAItC,QAAJ,CACX+E,MAAM,CAAC7E,QADI,EAGXC,OAHW,EAKXC,GALW,EAOXC,QAPW,EASXC,SATW,EAWXC,MAXW,EAaXC,QAbW,EAeXC,IAfW,EAiBXC,WAjBW,EAmBXC,aAnBW,CAAb;AAqBA2B,IAAAA,IAAI,CAACoC,iBAAL,CAAuB,KAAIO,oCAAJ,EAAqB7E,GAArB,EAA0BC,QAA1B,EAAoCC,SAApC,CAAvB;AACAE,IAAAA,QAAQ,CAAC0E,kBAAT,CAA4B5C,IAAI,CAACkC,uBAAL,EAA5B;;AAEA,QAAIlE,SAAJ,EAAe;AACbA,MAAAA,SAAS,CAAC6E,eAAV,CAA0B,MAAOnE,SAAP,IAAqB;AAC7C,cAAMwB,GAAG,GAAG,MAAMF,IAAI,CAACW,UAAL,CAAgBjC,SAAhB,CAAlB;AAEA,eAAO;AACLwB,UAAAA,GAAG,EAAEA,GAAF,aAAEA,GAAF,uBAAEA,GAAG,CAAE4C,QAAL;AADA,SAAP;AAGD,OAND;AAOD;;AAEDP,IAAAA,OAAO,CAACF,QAAR,CAAiB,yBAAWrC,IAAX,CAAjB;AAEAnC,IAAAA,OAAO,CAACkF,kBAAR,CAA2B,KAAIC,8BAAJ,EAA0BhD,IAA1B,CAA3B;AACA,WAAOA,IAAP;AACD;;AAxLmB;;;gCAATtC,Q,WAiHI,CAACuF,gBAAKC,QAAL,EAAD,EAA2BD,gBAAKC,QAAL,EAA3B,C;gCAjHJxF,Q,aAmHMyF,kB;gCAnHNzF,Q,kBAoHW,CACpB0F,wBADoB,EAEpBC,wBAFoB,EAGpBC,4BAHoB,EAIpBC,gBAJoB,EAKpBC,0BALoB,EAMpBC,sBANoB,EAOpBC,mBAPoB,EAQpBC,kBARoB,C;gCApHXjG,Q,mBA+HY;AACrBE,EAAAA,QAAQ,EAAE,CAAC,aAAD;AADW,C;;AA4DzBmB,mBAAW6E,UAAX,CAAsBlG,QAAtB","sourcesContent":["import { Slot, SlotRegistry } from '@teambit/harmony';\nimport { MainRuntime } from '@teambit/cli';\nimport { LoggerAspect, LoggerMain, Logger } from '@teambit/logger';\nimport { CompilerAspect, CompilerMain } from '@teambit/compiler';\nimport { Component, ComponentMap } from '@teambit/component';\nimport { PkgAspect, PkgMain } from '@teambit/pkg';\nimport type { Environment } from '@teambit/envs';\nimport { GraphqlAspect, GraphqlMain } from '@teambit/graphql';\nimport { PreviewAspect, PreviewMain } from '@teambit/preview';\nimport DevFilesAspect, { DevFilesMain } from '@teambit/dev-files';\nimport { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';\nimport ConsumerComponent from '@teambit/legacy/dist/consumer/component';\nimport { Workspace, WorkspaceAspect } from '@teambit/workspace';\nimport { Doc, DocPropList } from '@teambit/docs.entities.doc';\nimport { EnvsAspect, EnvsMain } from '@teambit/envs';\nimport { DocsAspect } from './docs.aspect';\nimport { DocsPreviewDefinition } from './docs.preview-definition';\nimport { docsSchema } from './docs.graphql';\nimport { DocReader } from './doc-reader';\nimport { DefaultDocReader } from './default-doc-reader';\nimport { FileExtensionNotSupported } from './exceptions';\n\nexport type ComponentDocs = {\n files: string[];\n component: Component;\n};\n\nexport type DocProp = {};\n\nexport type DocPropSlot = SlotRegistry<DocProp>;\n\nexport type DocReaderSlot = SlotRegistry<DocReader>;\n\nexport type DocsConfig = {\n /**\n * glob patterns to identify doc files.\n */\n patterns: string[];\n};\n\n/**\n * the component documentation extension.\n */\nexport class DocsMain {\n constructor(\n private patterns: string[],\n /**\n * envs extension.\n */\n private preview: PreviewMain,\n\n private pkg: PkgMain,\n\n private compiler: CompilerMain,\n\n private workspace: Workspace,\n\n private logger: Logger,\n\n private devFiles: DevFilesMain,\n\n private envs: EnvsMain,\n\n private docPropSlot: DocPropSlot,\n\n private docReaderSlot: DocReaderSlot\n ) {}\n\n /**\n * returns an array of doc file paths for a set of components.\n */\n getDocsMap(components: Component[]): ComponentMap<AbstractVinyl[]> {\n return ComponentMap.as<AbstractVinyl[]>(components, (component) => {\n return this.getDocsFiles(component);\n });\n }\n\n getDocsFiles(component: Component): AbstractVinyl[] {\n const devFiles = this.devFiles.computeDevFiles(component);\n const docFiles = devFiles.get(DocsAspect.id);\n return component.state.filesystem.files.filter((file) => docFiles.includes(file.relative));\n }\n\n /**\n * compute the description of the component from its source code and docs file.\n */\n async getDescription(component: Component): Promise<string> {\n const componentDoc = this.getDoc(component);\n const desc = componentDoc?.description;\n if (desc) return desc;\n const consumerComponent: ConsumerComponent = component.state._consumer;\n const fromJsDocs = consumerComponent.docs?.find((doc) => doc.description);\n\n return fromJsDocs?.description || '';\n }\n\n async getTemplate(env: Environment) {\n return env.getDocsTemplate();\n }\n\n getDocReader(extension: string) {\n return this.docReaderSlot.values().find((docReader) => docReader.isFormatSupported(extension));\n }\n\n /**\n * compute a doc for a component.\n */\n async computeDoc(component: Component) {\n const docFiles = this.getDocsFiles(component);\n if (docFiles.length) {\n // currently taking the the first docs file found with an abstract. (we support only one)\n const docFile = docFiles[0];\n\n try {\n const docReader = this.getDocReader(docFile.extname);\n if (!docReader) throw new FileExtensionNotSupported(docFile.relative, docFile.extname);\n const doc = await docReader.read(docFile.relative, docFile.contents, component);\n return doc;\n } catch (err: any) {\n this.logger.error('docs.main.runtime.computeDoc caught an error', err);\n return null;\n }\n }\n\n return null;\n }\n\n getDoc(component: Component) {\n const docData = component.state.aspects.get(DocsAspect.id)?.data?.doc;\n if (!docData) return null;\n return new Doc(docData.filePath, new DocPropList(docData.props));\n }\n\n getPatterns() {\n return this.patterns;\n }\n\n getComponentDevPatterns(component: Component) {\n const env = this.envs.calculateEnv(component).env;\n const componentEnvDocsDevPatterns: string[] = env.getDocsDevPatterns ? env.getDocsDevPatterns(component) : [];\n const componentPatterns = componentEnvDocsDevPatterns.concat(this.getPatterns());\n return componentPatterns;\n }\n\n getDevPatternToRegister() {\n return this.getComponentDevPatterns.bind(this);\n }\n /**\n * register a new doc reader. this allows to support further\n * documentation file formats.\n */\n registerDocReader(docReader: DocReader) {\n this.docReaderSlot.register(docReader);\n return this;\n }\n\n static slots = [Slot.withType<DocProp>(), Slot.withType<DocReader>()];\n\n static runtime = MainRuntime;\n static dependencies = [\n PreviewAspect,\n GraphqlAspect,\n WorkspaceAspect,\n PkgAspect,\n CompilerAspect,\n LoggerAspect,\n DevFilesAspect,\n EnvsAspect,\n ];\n\n static defaultConfig = {\n patterns: ['**/*.docs.*'],\n };\n\n static async provider(\n [preview, graphql, workspace, pkg, compiler, loggerAspect, devFiles, envs]: [\n PreviewMain,\n GraphqlMain,\n Workspace,\n PkgMain,\n CompilerMain,\n LoggerMain,\n DevFilesMain,\n EnvsMain\n ],\n config: DocsConfig,\n [docPropSlot, docReaderSlot]: [DocPropSlot, DocReaderSlot]\n ) {\n const logger = loggerAspect.createLogger(DocsAspect.id);\n const docs = new DocsMain(\n config.patterns,\n\n preview,\n\n pkg,\n\n compiler,\n\n workspace,\n\n logger,\n\n devFiles,\n\n envs,\n\n docPropSlot,\n\n docReaderSlot\n );\n docs.registerDocReader(new DefaultDocReader(pkg, compiler, workspace));\n devFiles.registerDevPattern(docs.getDevPatternToRegister());\n\n if (workspace) {\n workspace.onComponentLoad(async (component) => {\n const doc = await docs.computeDoc(component);\n\n return {\n doc: doc?.toObject(),\n };\n });\n }\n\n graphql.register(docsSchema(docs));\n\n preview.registerDefinition(new DocsPreviewDefinition(docs));\n return docs;\n }\n}\n\nDocsAspect.addRuntime(DocsMain);\n"]}
package/dist/overview/overview.js CHANGED
@@ -151,7 +151,8 @@ function Overview({
151
151
  labels: component.labels,
152
152
  packageName: component.packageName,
153
153
  titleBadges: badges,
154
- componentDescriptor: componentDescriptor
154
+ componentDescriptor: componentDescriptor,
155
+ deprecation: component.deprecation
155
156
  }), /*#__PURE__*/_react().default.createElement(_previewUi().ComponentPreview, {
156
157
  component: component,
157
158
  style: {
package/dist/overview/overview.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["overview.tsx"],"names":["ENV_LIST_WITH_DOCS_TEMPLATE","ENV_ASPECT_NAME","Overview","titleBadges","component","ComponentContext","componentDescriptor","lanesModel","currentLane","viewedLane","envType","get","type","showHeaderOutsideIframe","preview","includesEnvTemplate","includes","buildStatus","host","margin","badges","values","styles","overviewWrapper","componentOverviewBlock","displayName","version","description","labels","packageName","width","height"],"mappings":";;;;;;;;;;;;;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAEA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;;;;;AAEA,MAAMA,2BAA2B,GAAG,CAAC,OAAD,EAAU,KAAV,EAAiB,QAAjB,EAA2B,KAA3B,EAAkC,MAAlC,EAA0C,MAA1C,EAAkD,KAAlD,EAAyD,cAAzD,CAApC,C,CAA8G;;AAE9G,MAAMC,eAAe,GAAG,mBAAxB;;AAQO,SAASC,QAAT,CAAkB;AAAEC,EAAAA;AAAF,CAAlB,EAAkD;AAAA;;AACvD,QAAMC,SAAS,GAAG,yBAAWC,6BAAX,CAAlB;AACA,QAAMC,mBAAmB,GAAG,0CAA5B;AACA,QAAMC,UAAU,GAAG,iCAAnB;AACA,QAAMC,WAAW,GAAGD,UAAH,aAAGA,UAAH,uBAAGA,UAAU,CAAEE,UAAhC;AAEA,QAAMC,OAAe,GAAGJ,mBAAH,aAAGA,mBAAH,gDAAGA,mBAAmB,CAAEK,GAArB,CAA8BV,eAA9B,CAAH,0DAAG,sBAAgDW,IAAxE;AACA,QAAMC,uBAAuB,GAC3B,CAAAT,SAAS,SAAT,IAAAA,SAAS,WAAT,kCAAAA,SAAS,CAAEU,OAAX,0EAAoBC,mBAApB,MAA4C,KAA5C,IAAqD,CAACf,2BAA2B,CAACgB,QAA5B,CAAqCN,OAArC,CADxD;AAGA,MAAI,CAAAN,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEa,WAAX,MAA2B,SAA3B,IAAwC,CAAAb,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEc,IAAX,MAAoB,qBAAhE,EACE,oBACE,+BAAC,qCAAD;AAAmB,IAAA,KAAK,EAAE;AAAEC,MAAAA,MAAM,EAAE;AAAV,KAA1B;AAA8C,IAAA,MAAM,EAAC,YAArD;AAAkE,IAAA,KAAK,EAAC;AAAxE,iCADF;AAKF,MAAI,CAAAf,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEa,WAAX,MAA2B,QAA3B,IAAuC,CAAAb,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEc,IAAX,MAAoB,qBAA/D,EACE,oBACE,+BAAC,qCAAD;AACE,IAAA,KAAK,EAAE;AAAEC,MAAAA,MAAM,EAAE;AAAV,KADT;AAEE,IAAA,MAAM,EAAC,SAFT;AAGE,IAAA,KAAK,EAAC;AAHR,IADF;;AAQF,MAAIN,uBAAJ,EAA6B;AAC3B,UAAMO,MAAM,GAAG,uBAAQjB,WAAW,CAACkB,MAAZ,EAAR,CAAf;AAEA,wBACE;AAAK,MAAA,SAAS,EAAEC,0BAAOC;AAAvB,oBACE,+BAAC,yBAAD;AAAgB,MAAA,IAAI,EAAEf;AAAtB,MADF,eAEE,+BAAC,qBAAD;AAAW,MAAA,gBAAgB;AAA3B,MAFF,eAGE,+BAAC,gCAAD;AACE,MAAA,SAAS,EAAEc,0BAAOE,sBADpB;AAEE,MAAA,WAAW,EAAEpB,SAAS,CAACqB,WAFzB;AAGE,MAAA,OAAO,EAAErB,SAAS,CAACsB,OAHrB;AAIE,MAAA,QAAQ,EAAEtB,SAAS,CAACuB,WAJtB;AAKE,MAAA,MAAM,EAAEvB,SAAS,CAACwB,MALpB;AAME,MAAA,WAAW,EAAExB,SAAS,CAACyB,WANzB;AAOE,MAAA,WAAW,EAAET,MAPf;AAQE,MAAA,mBAAmB,EAAEd;AARvB,MAHF,eAaE,+BAAC,6BAAD;AACE,MAAA,SAAS,EAAEF,SADb;AAEE,MAAA,KAAK,EAAE;AAAE0B,QAAAA,KAAK,EAAE,MAAT;AAAiBC,QAAAA,MAAM,EAAE;AAAzB,OAFT;AAGE,MAAA,WAAW,EAAC,UAHd;AAIE,MAAA,iBAAiB,MAJnB;AAKE,MAAA,SAAS,EAAC;AALZ,MAbF,CADF;AAuBD;;AAED,SAAOvB,WAAW,gBAChB;AAAK,IAAA,SAAS,EAAEc,0BAAOC;AAAvB,kBACE,+BAAC,yBAAD;AAAgB,IAAA,IAAI,EAAEf;AAAtB,IADF,eAEE,+BAAC,qBAAD;AAAW,IAAA,gBAAgB;AAA3B,IAFF,eAGE,+BAAC,6BAAD;AACE,IAAA,SAAS,EAAEJ,SADb;AAEE,IAAA,KAAK,EAAE;AAAE0B,MAAAA,KAAK,EAAE,MAAT;AAAiBC,MAAAA,MAAM,EAAE;AAAzB,KAFT;AAGE,IAAA,WAAW,EAAC,UAHd;AAIE,IAAA,iBAAiB,MAJnB;AAKE,IAAA,SAAS,EAAC;AALZ,IAHF,CADgB,gBAahB,+BAAC,6BAAD;AACE,IAAA,SAAS,EAAE3B,SADb;AAEE,IAAA,KAAK,EAAE;AAAE0B,MAAAA,KAAK,EAAE,MAAT;AAAiBC,MAAAA,MAAM,EAAE;AAAzB,KAFT;AAGE,IAAA,WAAW,EAAC,UAHd;AAIE,IAAA,iBAAiB;AAJnB,IAbF;AAoBD","sourcesContent":["import React, { useContext } from 'react';\nimport flatten from 'lodash.flatten';\nimport { ComponentContext, useComponentDescriptor } from '@teambit/component';\nimport type { SlotRegistry } from '@teambit/harmony';\nimport { ComponentPreview } from '@teambit/preview.ui.component-preview';\nimport { StatusMessageCard } from '@teambit/design.ui.surfaces.status-message-card';\nimport { ComponentOverview, TitleBadge } from '@teambit/component.ui.component-meta';\nimport { LaneBreadcrumb, useLanesContext } from '@teambit/lanes.ui.lanes';\nimport { Separator } from '@teambit/design.ui.separator';\nimport styles from './overview.module.scss';\n\nconst ENV_LIST_WITH_DOCS_TEMPLATE = ['react', 'env', 'aspect', 'lit', 'html', 'node', 'mdx', 'react-native']; // envs using react based docs\n\nconst ENV_ASPECT_NAME = 'teambit.envs/envs';\n\nexport type TitleBadgeSlot = SlotRegistry<TitleBadge[]>;\n\nexport type OverviewProps = {\n titleBadges: TitleBadgeSlot;\n};\n\nexport function Overview({ titleBadges }: OverviewProps) {\n const component = useContext(ComponentContext);\n const componentDescriptor = useComponentDescriptor();\n const lanesModel = useLanesContext();\n const currentLane = lanesModel?.viewedLane;\n\n const envType: string = componentDescriptor?.get<any>(ENV_ASPECT_NAME)?.type;\n const showHeaderOutsideIframe =\n component?.preview?.includesEnvTemplate === false || !ENV_LIST_WITH_DOCS_TEMPLATE.includes(envType);\n\n if (component?.buildStatus === 'pending' && component?.host === 'teambit.scope/scope')\n return (\n <StatusMessageCard style={{ margin: 'auto' }} status=\"PROCESSING\" title=\"component preview pending\">\n this might take some time\n </StatusMessageCard>\n );\n if (component?.buildStatus === 'failed' && component?.host === 'teambit.scope/scope')\n return (\n <StatusMessageCard\n style={{ margin: 'auto' }}\n status=\"FAILURE\"\n title=\"failed to get component preview \"\n ></StatusMessageCard>\n );\n\n if (showHeaderOutsideIframe) {\n const badges = flatten(titleBadges.values());\n\n return (\n <div className={styles.overviewWrapper}>\n <LaneBreadcrumb lane={currentLane} />\n <Separator isPresentational />\n <ComponentOverview\n className={styles.componentOverviewBlock}\n displayName={component.displayName}\n version={component.version}\n abstract={component.description}\n labels={component.labels}\n packageName={component.packageName}\n titleBadges={badges}\n componentDescriptor={componentDescriptor}\n />\n <ComponentPreview\n component={component}\n style={{ width: '100%', height: '100%' }}\n previewName=\"overview\"\n fullContentHeight\n scrolling=\"no\"\n />\n </div>\n );\n }\n\n return currentLane ? (\n <div className={styles.overviewWrapper}>\n <LaneBreadcrumb lane={currentLane} />\n <Separator isPresentational />\n <ComponentPreview\n component={component}\n style={{ width: '100%', height: '100%' }}\n previewName=\"overview\"\n fullContentHeight\n scrolling=\"no\"\n />\n </div>\n ) : (\n <ComponentPreview\n component={component}\n style={{ width: '100%', height: '100%' }}\n previewName=\"overview\"\n fullContentHeight\n />\n );\n}\n"]}
1
+ {"version":3,"sources":["overview.tsx"],"names":["ENV_LIST_WITH_DOCS_TEMPLATE","ENV_ASPECT_NAME","Overview","titleBadges","component","ComponentContext","componentDescriptor","lanesModel","currentLane","viewedLane","envType","get","type","showHeaderOutsideIframe","preview","includesEnvTemplate","includes","buildStatus","host","margin","badges","values","styles","overviewWrapper","componentOverviewBlock","displayName","version","description","labels","packageName","deprecation","width","height"],"mappings":";;;;;;;;;;;;;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAEA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;;;;;AAEA,MAAMA,2BAA2B,GAAG,CAAC,OAAD,EAAU,KAAV,EAAiB,QAAjB,EAA2B,KAA3B,EAAkC,MAAlC,EAA0C,MAA1C,EAAkD,KAAlD,EAAyD,cAAzD,CAApC,C,CAA8G;;AAE9G,MAAMC,eAAe,GAAG,mBAAxB;;AAQO,SAASC,QAAT,CAAkB;AAAEC,EAAAA;AAAF,CAAlB,EAAkD;AAAA;;AACvD,QAAMC,SAAS,GAAG,yBAAWC,6BAAX,CAAlB;AACA,QAAMC,mBAAmB,GAAG,0CAA5B;AACA,QAAMC,UAAU,GAAG,iCAAnB;AACA,QAAMC,WAAW,GAAGD,UAAH,aAAGA,UAAH,uBAAGA,UAAU,CAAEE,UAAhC;AAEA,QAAMC,OAAe,GAAGJ,mBAAH,aAAGA,mBAAH,gDAAGA,mBAAmB,CAAEK,GAArB,CAA8BV,eAA9B,CAAH,0DAAG,sBAAgDW,IAAxE;AACA,QAAMC,uBAAuB,GAC3B,CAAAT,SAAS,SAAT,IAAAA,SAAS,WAAT,kCAAAA,SAAS,CAAEU,OAAX,0EAAoBC,mBAApB,MAA4C,KAA5C,IAAqD,CAACf,2BAA2B,CAACgB,QAA5B,CAAqCN,OAArC,CADxD;AAGA,MAAI,CAAAN,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEa,WAAX,MAA2B,SAA3B,IAAwC,CAAAb,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEc,IAAX,MAAoB,qBAAhE,EACE,oBACE,+BAAC,qCAAD;AAAmB,IAAA,KAAK,EAAE;AAAEC,MAAAA,MAAM,EAAE;AAAV,KAA1B;AAA8C,IAAA,MAAM,EAAC,YAArD;AAAkE,IAAA,KAAK,EAAC;AAAxE,iCADF;AAKF,MAAI,CAAAf,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEa,WAAX,MAA2B,QAA3B,IAAuC,CAAAb,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEc,IAAX,MAAoB,qBAA/D,EACE,oBACE,+BAAC,qCAAD;AACE,IAAA,KAAK,EAAE;AAAEC,MAAAA,MAAM,EAAE;AAAV,KADT;AAEE,IAAA,MAAM,EAAC,SAFT;AAGE,IAAA,KAAK,EAAC;AAHR,IADF;;AAQF,MAAIN,uBAAJ,EAA6B;AAC3B,UAAMO,MAAM,GAAG,uBAAQjB,WAAW,CAACkB,MAAZ,EAAR,CAAf;AAEA,wBACE;AAAK,MAAA,SAAS,EAAEC,0BAAOC;AAAvB,oBACE,+BAAC,yBAAD;AAAgB,MAAA,IAAI,EAAEf;AAAtB,MADF,eAEE,+BAAC,qBAAD;AAAW,MAAA,gBAAgB;AAA3B,MAFF,eAGE,+BAAC,gCAAD;AACE,MAAA,SAAS,EAAEc,0BAAOE,sBADpB;AAEE,MAAA,WAAW,EAAEpB,SAAS,CAACqB,WAFzB;AAGE,MAAA,OAAO,EAAErB,SAAS,CAACsB,OAHrB;AAIE,MAAA,QAAQ,EAAEtB,SAAS,CAACuB,WAJtB;AAKE,MAAA,MAAM,EAAEvB,SAAS,CAACwB,MALpB;AAME,MAAA,WAAW,EAAExB,SAAS,CAACyB,WANzB;AAOE,MAAA,WAAW,EAAET,MAPf;AAQE,MAAA,mBAAmB,EAAEd,mBARvB;AASE,MAAA,WAAW,EAAEF,SAAS,CAAC0B;AATzB,MAHF,eAcE,+BAAC,6BAAD;AACE,MAAA,SAAS,EAAE1B,SADb;AAEE,MAAA,KAAK,EAAE;AAAE2B,QAAAA,KAAK,EAAE,MAAT;AAAiBC,QAAAA,MAAM,EAAE;AAAzB,OAFT;AAGE,MAAA,WAAW,EAAC,UAHd;AAIE,MAAA,iBAAiB,MAJnB;AAKE,MAAA,SAAS,EAAC;AALZ,MAdF,CADF;AAwBD;;AAED,SAAOxB,WAAW,gBAChB;AAAK,IAAA,SAAS,EAAEc,0BAAOC;AAAvB,kBACE,+BAAC,yBAAD;AAAgB,IAAA,IAAI,EAAEf;AAAtB,IADF,eAEE,+BAAC,qBAAD;AAAW,IAAA,gBAAgB;AAA3B,IAFF,eAGE,+BAAC,6BAAD;AACE,IAAA,SAAS,EAAEJ,SADb;AAEE,IAAA,KAAK,EAAE;AAAE2B,MAAAA,KAAK,EAAE,MAAT;AAAiBC,MAAAA,MAAM,EAAE;AAAzB,KAFT;AAGE,IAAA,WAAW,EAAC,UAHd;AAIE,IAAA,iBAAiB,MAJnB;AAKE,IAAA,SAAS,EAAC;AALZ,IAHF,CADgB,gBAahB,+BAAC,6BAAD;AACE,IAAA,SAAS,EAAE5B,SADb;AAEE,IAAA,KAAK,EAAE;AAAE2B,MAAAA,KAAK,EAAE,MAAT;AAAiBC,MAAAA,MAAM,EAAE;AAAzB,KAFT;AAGE,IAAA,WAAW,EAAC,UAHd;AAIE,IAAA,iBAAiB;AAJnB,IAbF;AAoBD","sourcesContent":["import React, { useContext } from 'react';\nimport flatten from 'lodash.flatten';\nimport { ComponentContext, useComponentDescriptor } from '@teambit/component';\nimport type { SlotRegistry } from '@teambit/harmony';\nimport { ComponentPreview } from '@teambit/preview.ui.component-preview';\nimport { StatusMessageCard } from '@teambit/design.ui.surfaces.status-message-card';\nimport { ComponentOverview, TitleBadge } from '@teambit/component.ui.component-meta';\nimport { LaneBreadcrumb, useLanesContext } from '@teambit/lanes.ui.lanes';\nimport { Separator } from '@teambit/design.ui.separator';\nimport styles from './overview.module.scss';\n\nconst ENV_LIST_WITH_DOCS_TEMPLATE = ['react', 'env', 'aspect', 'lit', 'html', 'node', 'mdx', 'react-native']; // envs using react based docs\n\nconst ENV_ASPECT_NAME = 'teambit.envs/envs';\n\nexport type TitleBadgeSlot = SlotRegistry<TitleBadge[]>;\n\nexport type OverviewProps = {\n titleBadges: TitleBadgeSlot;\n};\n\nexport function Overview({ titleBadges }: OverviewProps) {\n const component = useContext(ComponentContext);\n const componentDescriptor = useComponentDescriptor();\n const lanesModel = useLanesContext();\n const currentLane = lanesModel?.viewedLane;\n\n const envType: string = componentDescriptor?.get<any>(ENV_ASPECT_NAME)?.type;\n const showHeaderOutsideIframe =\n component?.preview?.includesEnvTemplate === false || !ENV_LIST_WITH_DOCS_TEMPLATE.includes(envType);\n\n if (component?.buildStatus === 'pending' && component?.host === 'teambit.scope/scope')\n return (\n <StatusMessageCard style={{ margin: 'auto' }} status=\"PROCESSING\" title=\"component preview pending\">\n this might take some time\n </StatusMessageCard>\n );\n if (component?.buildStatus === 'failed' && component?.host === 'teambit.scope/scope')\n return (\n <StatusMessageCard\n style={{ margin: 'auto' }}\n status=\"FAILURE\"\n title=\"failed to get component preview \"\n ></StatusMessageCard>\n );\n\n if (showHeaderOutsideIframe) {\n const badges = flatten(titleBadges.values());\n\n return (\n <div className={styles.overviewWrapper}>\n <LaneBreadcrumb lane={currentLane} />\n <Separator isPresentational />\n <ComponentOverview\n className={styles.componentOverviewBlock}\n displayName={component.displayName}\n version={component.version}\n abstract={component.description}\n labels={component.labels}\n packageName={component.packageName}\n titleBadges={badges}\n componentDescriptor={componentDescriptor}\n deprecation={component.deprecation}\n />\n <ComponentPreview\n component={component}\n style={{ width: '100%', height: '100%' }}\n previewName=\"overview\"\n fullContentHeight\n scrolling=\"no\"\n />\n </div>\n );\n }\n\n return currentLane ? (\n <div className={styles.overviewWrapper}>\n <LaneBreadcrumb lane={currentLane} />\n <Separator isPresentational />\n <ComponentPreview\n component={component}\n style={{ width: '100%', height: '100%' }}\n previewName=\"overview\"\n fullContentHeight\n scrolling=\"no\"\n />\n </div>\n ) : (\n <ComponentPreview\n component={component}\n style={{ width: '100%', height: '100%' }}\n previewName=\"overview\"\n fullContentHeight\n />\n );\n}\n"]}
package/overview/overview.tsx CHANGED
@@ -60,6 +60,7 @@ export function Overview({ titleBadges }: OverviewProps) {
60
60
  packageName={component.packageName}
61
61
  titleBadges={badges}
62
62
  componentDescriptor={componentDescriptor}
63
+ deprecation={component.deprecation}
63
64
  />
64
65
  <ComponentPreview
65
66
  component={component}
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@teambit/docs",
3
- "version": "0.0.714",
3
+ "version": "0.0.717",
4
4
  "homepage": "https://bit.dev/teambit/docs/docs",
5
5
  "main": "dist/index.js",
6
6
  "componentId": {
7
7
  "scope": "teambit.docs",
8
8
  "name": "docs",
9
- "version": "0.0.714"
9
+ "version": "0.0.717"
10
10
  },
11
11
  "dependencies": {
12
12
  "graphql-tag": "2.12.1",
@@ -14,24 +14,24 @@
14
14
  "@babel/runtime": "7.12.18",
15
15
  "core-js": "^3.0.0",
16
16
  "@teambit/harmony": "0.3.3",
17
- "@teambit/compiler": "0.0.714",
18
- "@teambit/component": "0.0.714",
17
+ "@teambit/compiler": "0.0.717",
18
+ "@teambit/component": "0.0.717",
19
19
  "@teambit/docs.entities.doc": "0.0.3",
20
- "@teambit/pkg": "0.0.714",
21
- "@teambit/workspace": "0.0.714",
22
- "@teambit/cli": "0.0.476",
23
- "@teambit/dev-files": "0.0.714",
24
- "@teambit/envs": "0.0.714",
25
- "@teambit/graphql": "0.0.714",
26
- "@teambit/logger": "0.0.568",
27
- "@teambit/preview": "0.0.714",
20
+ "@teambit/pkg": "0.0.717",
21
+ "@teambit/workspace": "0.0.717",
22
+ "@teambit/cli": "0.0.477",
23
+ "@teambit/dev-files": "0.0.717",
24
+ "@teambit/envs": "0.0.717",
25
+ "@teambit/graphql": "0.0.717",
26
+ "@teambit/logger": "0.0.569",
27
+ "@teambit/preview": "0.0.717",
28
28
  "@teambit/component-id": "0.0.402",
29
- "@teambit/component.ui.component-meta": "0.0.35",
30
- "@teambit/ui": "0.0.714",
31
- "@teambit/pubsub": "0.0.714",
29
+ "@teambit/component.ui.component-meta": "0.0.37",
30
+ "@teambit/ui": "0.0.717",
31
+ "@teambit/pubsub": "0.0.717",
32
32
  "@teambit/design.ui.separator": "0.0.354",
33
33
  "@teambit/design.ui.surfaces.status-message-card": "0.0.7",
34
- "@teambit/lanes.ui.lanes": "0.0.42",
34
+ "@teambit/lanes.ui.lanes": "0.0.44",
35
35
  "@teambit/preview.ui.component-preview": "0.0.492"
36
36
  },
37
37
  "devDependencies": {
@@ -45,7 +45,7 @@
45
45
  "@teambit/docs.content.docs-overview": "1.95.9"
46
46
  },
47
47
  "peerDependencies": {
48
- "@teambit/legacy": "1.0.256",
48
+ "@teambit/legacy": "1.0.257",
49
49
  "react-dom": "^16.8.0 || ^17.0.0",
50
50
  "react": "^16.8.0 || ^17.0.0"
51
51
  },
@@ -73,7 +73,7 @@
73
73
  "react": "-"
74
74
  },
75
75
  "peerDependencies": {
76
- "@teambit/legacy": "1.0.256",
76
+ "@teambit/legacy": "1.0.257",
77
77
  "react-dom": "^16.8.0 || ^17.0.0",
78
78
  "react": "^16.8.0 || ^17.0.0"
79
79
  }
package/{preview-1650684349376.js → preview-1650916592801.js} RENAMED
@@ -1,2 +1,2 @@
1
- export const compositions = [require('/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.docs_docs@0.0.714/dist/docs.composition.js')]
2
- export const overview = [require('/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.docs_docs@0.0.714/dist/docs.docs.mdx')]
1
+ export const compositions = [require('/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.docs_docs@0.0.717/dist/docs.composition.js')]
2
+ export const overview = [require('/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.docs_docs@0.0.717/dist/docs.docs.mdx')]