@teambit/docs 0.0.881 → 0.0.883
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.
- package/dist/default-doc-reader.js +2 -21
- package/dist/default-doc-reader.js.map +1 -1
- package/dist/doc-module.js +1 -6
- package/dist/doc-module.js.map +1 -1
- package/dist/docs-store.js +1 -9
- package/dist/docs-store.js.map +1 -1
- package/dist/docs.aspect.js +0 -5
- package/dist/docs.aspect.js.map +1 -1
- package/dist/docs.compare.section.js +0 -13
- package/dist/docs.compare.section.js.map +1 -1
- package/dist/docs.composition.js +0 -6
- package/dist/docs.composition.js.map +1 -1
- package/dist/docs.data.js.map +1 -1
- package/dist/docs.graphql.js +0 -5
- package/dist/docs.graphql.js.map +1 -1
- package/dist/docs.js.map +1 -1
- package/dist/docs.main.runtime.js +3 -85
- package/dist/docs.main.runtime.js.map +1 -1
- package/dist/docs.preview-definition.js +2 -13
- package/dist/docs.preview-definition.js.map +1 -1
- package/dist/docs.preview.runtime.js +3 -25
- package/dist/docs.preview.runtime.js.map +1 -1
- package/dist/docs.service.js +0 -9
- package/dist/docs.service.js.map +1 -1
- package/dist/docs.ui.runtime.js +2 -39
- package/dist/docs.ui.runtime.js.map +1 -1
- package/dist/events/click-inside-an-iframe.js +1 -12
- package/dist/events/click-inside-an-iframe.js.map +1 -1
- package/dist/events/index.js +0 -2
- package/dist/events/index.js.map +1 -1
- package/dist/exceptions/doc-read-error.js +0 -3
- package/dist/exceptions/doc-read-error.js.map +1 -1
- package/dist/exceptions/file-extension-not-supported.js +0 -3
- package/dist/exceptions/file-extension-not-supported.js.map +1 -1
- package/dist/exceptions/index.js +0 -6
- package/dist/exceptions/index.js.map +1 -1
- package/dist/index.js +0 -14
- package/dist/index.js.map +1 -1
- package/dist/overview/index.js +0 -3
- package/dist/overview/index.js.map +1 -1
- package/dist/overview/overview.js +0 -33
- package/dist/overview/overview.js.map +1 -1
- package/dist/overview.section.js +0 -13
- package/dist/overview.section.js.map +1 -1
- package/package-tar/teambit-docs-0.0.883.tgz +0 -0
- package/package.json +13 -13
- package/{preview-1666409808293.js → preview-1666582798766.js} +2 -2
- package/package-tar/teambit-docs-0.0.881.tgz +0 -0
|
@@ -1,198 +1,139 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
|
|
3
3
|
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
|
4
|
-
|
|
5
4
|
require("core-js/modules/es.symbol.description.js");
|
|
6
|
-
|
|
7
5
|
require("core-js/modules/es.array.iterator.js");
|
|
8
|
-
|
|
9
6
|
require("core-js/modules/es.promise.js");
|
|
10
|
-
|
|
11
7
|
Object.defineProperty(exports, "__esModule", {
|
|
12
8
|
value: true
|
|
13
9
|
});
|
|
14
10
|
exports.DocsMain = void 0;
|
|
15
|
-
|
|
16
11
|
function _defineProperty2() {
|
|
17
12
|
const data = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
|
|
18
|
-
|
|
19
13
|
_defineProperty2 = function () {
|
|
20
14
|
return data;
|
|
21
15
|
};
|
|
22
|
-
|
|
23
16
|
return data;
|
|
24
17
|
}
|
|
25
|
-
|
|
26
18
|
function _harmony() {
|
|
27
19
|
const data = require("@teambit/harmony");
|
|
28
|
-
|
|
29
20
|
_harmony = function () {
|
|
30
21
|
return data;
|
|
31
22
|
};
|
|
32
|
-
|
|
33
23
|
return data;
|
|
34
24
|
}
|
|
35
|
-
|
|
36
25
|
function _cli() {
|
|
37
26
|
const data = require("@teambit/cli");
|
|
38
|
-
|
|
39
27
|
_cli = function () {
|
|
40
28
|
return data;
|
|
41
29
|
};
|
|
42
|
-
|
|
43
30
|
return data;
|
|
44
31
|
}
|
|
45
|
-
|
|
46
32
|
function _logger() {
|
|
47
33
|
const data = require("@teambit/logger");
|
|
48
|
-
|
|
49
34
|
_logger = function () {
|
|
50
35
|
return data;
|
|
51
36
|
};
|
|
52
|
-
|
|
53
37
|
return data;
|
|
54
38
|
}
|
|
55
|
-
|
|
56
39
|
function _compiler() {
|
|
57
40
|
const data = require("@teambit/compiler");
|
|
58
|
-
|
|
59
41
|
_compiler = function () {
|
|
60
42
|
return data;
|
|
61
43
|
};
|
|
62
|
-
|
|
63
44
|
return data;
|
|
64
45
|
}
|
|
65
|
-
|
|
66
46
|
function _component() {
|
|
67
47
|
const data = require("@teambit/component");
|
|
68
|
-
|
|
69
48
|
_component = function () {
|
|
70
49
|
return data;
|
|
71
50
|
};
|
|
72
|
-
|
|
73
51
|
return data;
|
|
74
52
|
}
|
|
75
|
-
|
|
76
53
|
function _pkg() {
|
|
77
54
|
const data = require("@teambit/pkg");
|
|
78
|
-
|
|
79
55
|
_pkg = function () {
|
|
80
56
|
return data;
|
|
81
57
|
};
|
|
82
|
-
|
|
83
58
|
return data;
|
|
84
59
|
}
|
|
85
|
-
|
|
86
60
|
function _graphql() {
|
|
87
61
|
const data = require("@teambit/graphql");
|
|
88
|
-
|
|
89
62
|
_graphql = function () {
|
|
90
63
|
return data;
|
|
91
64
|
};
|
|
92
|
-
|
|
93
65
|
return data;
|
|
94
66
|
}
|
|
95
|
-
|
|
96
67
|
function _preview() {
|
|
97
68
|
const data = require("@teambit/preview");
|
|
98
|
-
|
|
99
69
|
_preview = function () {
|
|
100
70
|
return data;
|
|
101
71
|
};
|
|
102
|
-
|
|
103
72
|
return data;
|
|
104
73
|
}
|
|
105
|
-
|
|
106
74
|
function _devFiles() {
|
|
107
75
|
const data = _interopRequireDefault(require("@teambit/dev-files"));
|
|
108
|
-
|
|
109
76
|
_devFiles = function () {
|
|
110
77
|
return data;
|
|
111
78
|
};
|
|
112
|
-
|
|
113
79
|
return data;
|
|
114
80
|
}
|
|
115
|
-
|
|
116
81
|
function _workspace() {
|
|
117
82
|
const data = require("@teambit/workspace");
|
|
118
|
-
|
|
119
83
|
_workspace = function () {
|
|
120
84
|
return data;
|
|
121
85
|
};
|
|
122
|
-
|
|
123
86
|
return data;
|
|
124
87
|
}
|
|
125
|
-
|
|
126
88
|
function _docsEntities() {
|
|
127
89
|
const data = require("@teambit/docs.entities.doc");
|
|
128
|
-
|
|
129
90
|
_docsEntities = function () {
|
|
130
91
|
return data;
|
|
131
92
|
};
|
|
132
|
-
|
|
133
93
|
return data;
|
|
134
94
|
}
|
|
135
|
-
|
|
136
95
|
function _envs() {
|
|
137
96
|
const data = require("@teambit/envs");
|
|
138
|
-
|
|
139
97
|
_envs = function () {
|
|
140
98
|
return data;
|
|
141
99
|
};
|
|
142
|
-
|
|
143
100
|
return data;
|
|
144
101
|
}
|
|
145
|
-
|
|
146
102
|
function _docs() {
|
|
147
103
|
const data = require("./docs.aspect");
|
|
148
|
-
|
|
149
104
|
_docs = function () {
|
|
150
105
|
return data;
|
|
151
106
|
};
|
|
152
|
-
|
|
153
107
|
return data;
|
|
154
108
|
}
|
|
155
|
-
|
|
156
109
|
function _docs2() {
|
|
157
110
|
const data = require("./docs.preview-definition");
|
|
158
|
-
|
|
159
111
|
_docs2 = function () {
|
|
160
112
|
return data;
|
|
161
113
|
};
|
|
162
|
-
|
|
163
114
|
return data;
|
|
164
115
|
}
|
|
165
|
-
|
|
166
116
|
function _docs3() {
|
|
167
117
|
const data = require("./docs.graphql");
|
|
168
|
-
|
|
169
118
|
_docs3 = function () {
|
|
170
119
|
return data;
|
|
171
120
|
};
|
|
172
|
-
|
|
173
121
|
return data;
|
|
174
122
|
}
|
|
175
|
-
|
|
176
123
|
function _defaultDocReader() {
|
|
177
124
|
const data = require("./default-doc-reader");
|
|
178
|
-
|
|
179
125
|
_defaultDocReader = function () {
|
|
180
126
|
return data;
|
|
181
127
|
};
|
|
182
|
-
|
|
183
128
|
return data;
|
|
184
129
|
}
|
|
185
|
-
|
|
186
130
|
function _exceptions() {
|
|
187
131
|
const data = require("./exceptions");
|
|
188
|
-
|
|
189
132
|
_exceptions = function () {
|
|
190
133
|
return data;
|
|
191
134
|
};
|
|
192
|
-
|
|
193
135
|
return data;
|
|
194
136
|
}
|
|
195
|
-
|
|
196
137
|
/**
|
|
197
138
|
* the component documentation extension.
|
|
198
139
|
*/
|
|
@@ -213,30 +154,26 @@ class DocsMain {
|
|
|
213
154
|
this.docPropSlot = docPropSlot;
|
|
214
155
|
this.docReaderSlot = docReaderSlot;
|
|
215
156
|
}
|
|
157
|
+
|
|
216
158
|
/**
|
|
217
159
|
* returns an array of doc file paths for a set of components.
|
|
218
160
|
*/
|
|
219
|
-
|
|
220
|
-
|
|
221
161
|
getDocsMap(components) {
|
|
222
162
|
return _component().ComponentMap.as(components, component => {
|
|
223
163
|
return this.getDocsFiles(component);
|
|
224
164
|
});
|
|
225
165
|
}
|
|
226
|
-
|
|
227
166
|
getDocsFiles(component) {
|
|
228
167
|
const devFiles = this.devFiles.computeDevFiles(component);
|
|
229
168
|
const docFiles = devFiles.get(_docs().DocsAspect.id);
|
|
230
169
|
return component.state.filesystem.files.filter(file => docFiles.includes(file.relative));
|
|
231
170
|
}
|
|
171
|
+
|
|
232
172
|
/**
|
|
233
173
|
* compute the description of the component from its source code and docs file.
|
|
234
174
|
*/
|
|
235
|
-
|
|
236
|
-
|
|
237
175
|
async getDescription(component) {
|
|
238
176
|
var _consumerComponent$do;
|
|
239
|
-
|
|
240
177
|
const componentDoc = this.getDoc(component);
|
|
241
178
|
const desc = componentDoc === null || componentDoc === void 0 ? void 0 : componentDoc.description;
|
|
242
179
|
if (desc) return desc;
|
|
@@ -244,26 +181,21 @@ class DocsMain {
|
|
|
244
181
|
const fromJsDocs = (_consumerComponent$do = consumerComponent.docs) === null || _consumerComponent$do === void 0 ? void 0 : _consumerComponent$do.find(doc => doc.description);
|
|
245
182
|
return (fromJsDocs === null || fromJsDocs === void 0 ? void 0 : fromJsDocs.description) || '';
|
|
246
183
|
}
|
|
247
|
-
|
|
248
184
|
async getTemplate(env) {
|
|
249
185
|
return env.getDocsTemplate();
|
|
250
186
|
}
|
|
251
|
-
|
|
252
187
|
getDocReader(extension) {
|
|
253
188
|
return this.docReaderSlot.values().find(docReader => docReader.isFormatSupported(extension));
|
|
254
189
|
}
|
|
190
|
+
|
|
255
191
|
/**
|
|
256
192
|
* compute a doc for a component.
|
|
257
193
|
*/
|
|
258
|
-
|
|
259
|
-
|
|
260
194
|
async computeDoc(component) {
|
|
261
195
|
const docFiles = this.getDocsFiles(component);
|
|
262
|
-
|
|
263
196
|
if (docFiles.length) {
|
|
264
197
|
// currently taking the the first docs file found with an abstract. (we support only one)
|
|
265
198
|
const docFile = docFiles[0];
|
|
266
|
-
|
|
267
199
|
try {
|
|
268
200
|
const docReader = this.getDocReader(docFile.extname);
|
|
269
201
|
if (!docReader) throw new (_exceptions().FileExtensionNotSupported)(docFile.relative, docFile.extname);
|
|
@@ -275,29 +207,23 @@ class DocsMain {
|
|
|
275
207
|
return null;
|
|
276
208
|
}
|
|
277
209
|
}
|
|
278
|
-
|
|
279
210
|
return null;
|
|
280
211
|
}
|
|
281
|
-
|
|
282
212
|
getDoc(component) {
|
|
283
213
|
var _component$get, _component$get$data;
|
|
284
|
-
|
|
285
214
|
const docData = (_component$get = component.get(_docs().DocsAspect.id)) === null || _component$get === void 0 ? void 0 : (_component$get$data = _component$get.data) === null || _component$get$data === void 0 ? void 0 : _component$get$data.doc;
|
|
286
215
|
if (!docData) return null;
|
|
287
216
|
return new (_docsEntities().Doc)(docData.filePath, new (_docsEntities().DocPropList)(docData.props));
|
|
288
217
|
}
|
|
289
|
-
|
|
290
218
|
getPatterns() {
|
|
291
219
|
return this.patterns;
|
|
292
220
|
}
|
|
293
|
-
|
|
294
221
|
getComponentDevPatterns(component) {
|
|
295
222
|
const env = this.envs.calculateEnv(component).env;
|
|
296
223
|
const componentEnvDocsDevPatterns = env.getDocsDevPatterns ? env.getDocsDevPatterns(component) : [];
|
|
297
224
|
const componentPatterns = componentEnvDocsDevPatterns.concat(this.getPatterns());
|
|
298
225
|
return componentPatterns;
|
|
299
226
|
}
|
|
300
|
-
|
|
301
227
|
getDevPatternToRegister() {
|
|
302
228
|
return this.getComponentDevPatterns.bind(this);
|
|
303
229
|
}
|
|
@@ -305,19 +231,15 @@ class DocsMain {
|
|
|
305
231
|
* register a new doc reader. this allows to support further
|
|
306
232
|
* documentation file formats.
|
|
307
233
|
*/
|
|
308
|
-
|
|
309
|
-
|
|
310
234
|
registerDocReader(docReader) {
|
|
311
235
|
this.docReaderSlot.register(docReader);
|
|
312
236
|
return this;
|
|
313
237
|
}
|
|
314
|
-
|
|
315
238
|
static async provider([preview, graphql, workspace, pkg, compiler, loggerAspect, devFiles, envs], config, [docPropSlot, docReaderSlot]) {
|
|
316
239
|
const logger = loggerAspect.createLogger(_docs().DocsAspect.id);
|
|
317
240
|
const docs = new DocsMain(config.patterns, preview, pkg, compiler, workspace, logger, devFiles, envs, docPropSlot, docReaderSlot);
|
|
318
241
|
docs.registerDocReader(new (_defaultDocReader().DefaultDocReader)(pkg, compiler, workspace));
|
|
319
242
|
devFiles.registerDevPattern(docs.getDevPatternToRegister());
|
|
320
|
-
|
|
321
243
|
if (workspace) {
|
|
322
244
|
workspace.onComponentLoad(async (component, opts) => {
|
|
323
245
|
if ((opts === null || opts === void 0 ? void 0 : opts.loadDocs) === false) return undefined;
|
|
@@ -327,14 +249,11 @@ class DocsMain {
|
|
|
327
249
|
};
|
|
328
250
|
});
|
|
329
251
|
}
|
|
330
|
-
|
|
331
252
|
graphql.register((0, _docs3().docsSchema)(docs));
|
|
332
253
|
preview.registerDefinition(new (_docs2().DocsPreviewDefinition)(docs));
|
|
333
254
|
return docs;
|
|
334
255
|
}
|
|
335
|
-
|
|
336
256
|
}
|
|
337
|
-
|
|
338
257
|
exports.DocsMain = DocsMain;
|
|
339
258
|
(0, _defineProperty2().default)(DocsMain, "slots", [_harmony().Slot.withType(), _harmony().Slot.withType()]);
|
|
340
259
|
(0, _defineProperty2().default)(DocsMain, "runtime", _cli().MainRuntime);
|
|
@@ -342,7 +261,6 @@ exports.DocsMain = DocsMain;
|
|
|
342
261
|
(0, _defineProperty2().default)(DocsMain, "defaultConfig", {
|
|
343
262
|
patterns: ['**/*.docs.*']
|
|
344
263
|
});
|
|
345
|
-
|
|
346
264
|
_docs().DocsAspect.addRuntime(DocsMain);
|
|
347
265
|
|
|
348
266
|
//# sourceMappingURL=docs.main.runtime.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"names":["DocsMain","constructor","patterns","preview","pkg","compiler","workspace","logger","devFiles","envs","docPropSlot","docReaderSlot","getDocsMap","components","ComponentMap","as","component","getDocsFiles","computeDevFiles","docFiles","get","DocsAspect","id","state","filesystem","files","filter","file","includes","relative","getDescription","componentDoc","getDoc","desc","description","consumerComponent","_consumer","fromJsDocs","docs","find","doc","getTemplate","env","getDocsTemplate","getDocReader","extension","values","docReader","isFormatSupported","computeDoc","length","docFile","extname","FileExtensionNotSupported","read","contents","err","debug","message","docData","data","Doc","filePath","DocPropList","props","getPatterns","getComponentDevPatterns","calculateEnv","componentEnvDocsDevPatterns","getDocsDevPatterns","componentPatterns","concat","getDevPatternToRegister","bind","registerDocReader","register","provider","graphql","loggerAspect","config","createLogger","DefaultDocReader","registerDevPattern","onComponentLoad","opts","loadDocs","undefined","toObject","docsSchema","registerDefinition","DocsPreviewDefinition","Slot","withType","MainRuntime","PreviewAspect","GraphqlAspect","WorkspaceAspect","PkgAspect","CompilerAspect","LoggerAspect","DevFilesAspect","EnvsAspect","addRuntime"],"sources":["docs.main.runtime.ts"],"sourcesContent":["import { Slot, SlotRegistry } from '@teambit/harmony';\nimport { MainRuntime } from '@teambit/cli';\nimport { LoggerAspect, LoggerMain, Logger } from '@teambit/logger';\nimport { CompilerAspect, CompilerMain } from '@teambit/compiler';\nimport { Component, ComponentMap, IComponent } from '@teambit/component';\nimport { PkgAspect, PkgMain } from '@teambit/pkg';\nimport type { Environment } from '@teambit/envs';\nimport { GraphqlAspect, GraphqlMain } from '@teambit/graphql';\nimport { PreviewAspect, PreviewMain } from '@teambit/preview';\nimport DevFilesAspect, { DevFilesMain } from '@teambit/dev-files';\nimport { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';\nimport ConsumerComponent from '@teambit/legacy/dist/consumer/component';\nimport { Workspace, WorkspaceAspect } from '@teambit/workspace';\nimport { Doc, DocPropList } from '@teambit/docs.entities.doc';\nimport { EnvsAspect, EnvsMain } from '@teambit/envs';\nimport { DocsAspect } from './docs.aspect';\nimport { DocsPreviewDefinition } from './docs.preview-definition';\nimport { docsSchema } from './docs.graphql';\nimport { DocReader } from './doc-reader';\nimport { DefaultDocReader } from './default-doc-reader';\nimport { FileExtensionNotSupported } from './exceptions';\n\nexport type ComponentDocs = {\n files: string[];\n component: Component;\n};\n\nexport type DocProp = {};\n\nexport type DocPropSlot = SlotRegistry<DocProp>;\n\nexport type DocReaderSlot = SlotRegistry<DocReader>;\n\nexport type DocsConfig = {\n /**\n * glob patterns to identify doc files.\n */\n patterns: string[];\n};\n\n/**\n * the component documentation extension.\n */\nexport class DocsMain {\n constructor(\n private patterns: string[],\n /**\n * envs extension.\n */\n private preview: PreviewMain,\n\n private pkg: PkgMain,\n\n private compiler: CompilerMain,\n\n private workspace: Workspace,\n\n private logger: Logger,\n\n private devFiles: DevFilesMain,\n\n private envs: EnvsMain,\n\n private docPropSlot: DocPropSlot,\n\n private docReaderSlot: DocReaderSlot\n ) {}\n\n /**\n * returns an array of doc file paths for a set of components.\n */\n getDocsMap(components: Component[]): ComponentMap<AbstractVinyl[]> {\n return ComponentMap.as<AbstractVinyl[]>(components, (component) => {\n return this.getDocsFiles(component);\n });\n }\n\n getDocsFiles(component: Component): AbstractVinyl[] {\n const devFiles = this.devFiles.computeDevFiles(component);\n const docFiles = devFiles.get(DocsAspect.id);\n return component.state.filesystem.files.filter((file) => docFiles.includes(file.relative));\n }\n\n /**\n * compute the description of the component from its source code and docs file.\n */\n async getDescription(component: Component): Promise<string> {\n const componentDoc = this.getDoc(component);\n const desc = componentDoc?.description;\n if (desc) return desc;\n const consumerComponent: ConsumerComponent = component.state._consumer;\n const fromJsDocs = consumerComponent.docs?.find((doc) => doc.description);\n\n return fromJsDocs?.description || '';\n }\n\n async getTemplate(env: Environment) {\n return env.getDocsTemplate();\n }\n\n getDocReader(extension: string) {\n return this.docReaderSlot.values().find((docReader) => docReader.isFormatSupported(extension));\n }\n\n /**\n * compute a doc for a component.\n */\n async computeDoc(component: Component) {\n const docFiles = this.getDocsFiles(component);\n if (docFiles.length) {\n // currently taking the the first docs file found with an abstract. (we support only one)\n const docFile = docFiles[0];\n\n try {\n const docReader = this.getDocReader(docFile.extname);\n if (!docReader) throw new FileExtensionNotSupported(docFile.relative, docFile.extname);\n const doc = await docReader.read(docFile.relative, docFile.contents, component);\n return doc;\n } catch (err: any) {\n // it's ok to fail here.\n this.logger.debug(`docs.main.runtime.computeDoc caught an error: ${err.message}`);\n return null;\n }\n }\n\n return null;\n }\n\n getDoc(component: IComponent) {\n const docData = component.get(DocsAspect.id)?.data?.doc;\n if (!docData) return null;\n return new Doc(docData.filePath, new DocPropList(docData.props));\n }\n\n getPatterns() {\n return this.patterns;\n }\n\n getComponentDevPatterns(component: Component) {\n const env = this.envs.calculateEnv(component).env;\n const componentEnvDocsDevPatterns: string[] = env.getDocsDevPatterns ? env.getDocsDevPatterns(component) : [];\n const componentPatterns = componentEnvDocsDevPatterns.concat(this.getPatterns());\n return componentPatterns;\n }\n\n getDevPatternToRegister() {\n return this.getComponentDevPatterns.bind(this);\n }\n /**\n * register a new doc reader. this allows to support further\n * documentation file formats.\n */\n registerDocReader(docReader: DocReader) {\n this.docReaderSlot.register(docReader);\n return this;\n }\n\n static slots = [Slot.withType<DocProp>(), Slot.withType<DocReader>()];\n\n static runtime = MainRuntime;\n static dependencies = [\n PreviewAspect,\n GraphqlAspect,\n WorkspaceAspect,\n PkgAspect,\n CompilerAspect,\n LoggerAspect,\n DevFilesAspect,\n EnvsAspect,\n ];\n\n static defaultConfig = {\n patterns: ['**/*.docs.*'],\n };\n\n static async provider(\n [preview, graphql, workspace, pkg, compiler, loggerAspect, devFiles, envs]: [\n PreviewMain,\n GraphqlMain,\n Workspace,\n PkgMain,\n CompilerMain,\n LoggerMain,\n DevFilesMain,\n EnvsMain\n ],\n config: DocsConfig,\n [docPropSlot, docReaderSlot]: [DocPropSlot, DocReaderSlot]\n ) {\n const logger = loggerAspect.createLogger(DocsAspect.id);\n const docs = new DocsMain(\n config.patterns,\n\n preview,\n\n pkg,\n\n compiler,\n\n workspace,\n\n logger,\n\n devFiles,\n\n envs,\n\n docPropSlot,\n\n docReaderSlot\n );\n docs.registerDocReader(new DefaultDocReader(pkg, compiler, workspace));\n devFiles.registerDevPattern(docs.getDevPatternToRegister());\n\n if (workspace) {\n workspace.onComponentLoad(async (component, opts) => {\n if (opts?.loadDocs === false) return undefined;\n const doc = await docs.computeDoc(component);\n\n return {\n doc: doc?.toObject(),\n };\n });\n }\n\n graphql.register(docsSchema(docs));\n\n preview.registerDefinition(new DocsPreviewDefinition(docs));\n return docs;\n }\n}\n\nDocsAspect.addRuntime(DocsMain);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAGA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAoBA;AACA;AACA;AACO,MAAMA,QAAN,CAAe;EACpBC,WAAW,CACDC,QADC;EAET;AACJ;AACA;EACYC,OALC,EAODC,GAPC,EASDC,QATC,EAWDC,SAXC,EAaDC,MAbC,EAeDC,QAfC,EAiBDC,IAjBC,EAmBDC,WAnBC,EAqBDC,aArBC,EAsBT;IAAA,KArBQT,QAqBR,GArBQA,QAqBR;IAAA,KAjBQC,OAiBR,GAjBQA,OAiBR;IAAA,KAfQC,GAeR,GAfQA,GAeR;IAAA,KAbQC,QAaR,GAbQA,QAaR;IAAA,KAXQC,SAWR,GAXQA,SAWR;IAAA,KATQC,MASR,GATQA,MASR;IAAA,KAPQC,QAOR,GAPQA,QAOR;IAAA,KALQC,IAKR,GALQA,IAKR;IAAA,KAHQC,WAGR,GAHQA,WAGR;IAAA,KADQC,aACR,GADQA,aACR;EAAE;EAEJ;AACF;AACA;;;EACEC,UAAU,CAACC,UAAD,EAAyD;IACjE,OAAOC,yBAAA,CAAaC,EAAb,CAAiCF,UAAjC,EAA8CG,SAAD,IAAe;MACjE,OAAO,KAAKC,YAAL,CAAkBD,SAAlB,CAAP;IACD,CAFM,CAAP;EAGD;;EAEDC,YAAY,CAACD,SAAD,EAAwC;IAClD,MAAMR,QAAQ,GAAG,KAAKA,QAAL,CAAcU,eAAd,CAA8BF,SAA9B,CAAjB;IACA,MAAMG,QAAQ,GAAGX,QAAQ,CAACY,GAAT,CAAaC,kBAAA,CAAWC,EAAxB,CAAjB;IACA,OAAON,SAAS,CAACO,KAAV,CAAgBC,UAAhB,CAA2BC,KAA3B,CAAiCC,MAAjC,CAAyCC,IAAD,IAAUR,QAAQ,CAACS,QAAT,CAAkBD,IAAI,CAACE,QAAvB,CAAlD,CAAP;EACD;EAED;AACF;AACA;;;EACsB,MAAdC,cAAc,CAACd,SAAD,EAAwC;IAAA;;IAC1D,MAAMe,YAAY,GAAG,KAAKC,MAAL,CAAYhB,SAAZ,CAArB;IACA,MAAMiB,IAAI,GAAGF,YAAH,aAAGA,YAAH,uBAAGA,YAAY,CAAEG,WAA3B;IACA,IAAID,IAAJ,EAAU,OAAOA,IAAP;IACV,MAAME,iBAAoC,GAAGnB,SAAS,CAACO,KAAV,CAAgBa,SAA7D;IACA,MAAMC,UAAU,4BAAGF,iBAAiB,CAACG,IAArB,0DAAG,sBAAwBC,IAAxB,CAA8BC,GAAD,IAASA,GAAG,CAACN,WAA1C,CAAnB;IAEA,OAAO,CAAAG,UAAU,SAAV,IAAAA,UAAU,WAAV,YAAAA,UAAU,CAAEH,WAAZ,KAA2B,EAAlC;EACD;;EAEgB,MAAXO,WAAW,CAACC,GAAD,EAAmB;IAClC,OAAOA,GAAG,CAACC,eAAJ,EAAP;EACD;;EAEDC,YAAY,CAACC,SAAD,EAAoB;IAC9B,OAAO,KAAKlC,aAAL,CAAmBmC,MAAnB,GAA4BP,IAA5B,CAAkCQ,SAAD,IAAeA,SAAS,CAACC,iBAAV,CAA4BH,SAA5B,CAAhD,CAAP;EACD;EAED;AACF;AACA;;;EACkB,MAAVI,UAAU,CAACjC,SAAD,EAAuB;IACrC,MAAMG,QAAQ,GAAG,KAAKF,YAAL,CAAkBD,SAAlB,CAAjB;;IACA,IAAIG,QAAQ,CAAC+B,MAAb,EAAqB;MACnB;MACA,MAAMC,OAAO,GAAGhC,QAAQ,CAAC,CAAD,CAAxB;;MAEA,IAAI;QACF,MAAM4B,SAAS,GAAG,KAAKH,YAAL,CAAkBO,OAAO,CAACC,OAA1B,CAAlB;QACA,IAAI,CAACL,SAAL,EAAgB,MAAM,KAAIM,uCAAJ,EAA8BF,OAAO,CAACtB,QAAtC,EAAgDsB,OAAO,CAACC,OAAxD,CAAN;QAChB,MAAMZ,GAAG,GAAG,MAAMO,SAAS,CAACO,IAAV,CAAeH,OAAO,CAACtB,QAAvB,EAAiCsB,OAAO,CAACI,QAAzC,EAAmDvC,SAAnD,CAAlB;QACA,OAAOwB,GAAP;MACD,CALD,CAKE,OAAOgB,GAAP,EAAiB;QACjB;QACA,KAAKjD,MAAL,CAAYkD,KAAZ,CAAmB,iDAAgDD,GAAG,CAACE,OAAQ,EAA/E;QACA,OAAO,IAAP;MACD;IACF;;IAED,OAAO,IAAP;EACD;;EAED1B,MAAM,CAAChB,SAAD,EAAwB;IAAA;;IAC5B,MAAM2C,OAAO,qBAAG3C,SAAS,CAACI,GAAV,CAAcC,kBAAA,CAAWC,EAAzB,CAAH,0EAAG,eAA8BsC,IAAjC,wDAAG,oBAAoCpB,GAApD;IACA,IAAI,CAACmB,OAAL,EAAc,OAAO,IAAP;IACd,OAAO,KAAIE,mBAAJ,EAAQF,OAAO,CAACG,QAAhB,EAA0B,KAAIC,2BAAJ,EAAgBJ,OAAO,CAACK,KAAxB,CAA1B,CAAP;EACD;;EAEDC,WAAW,GAAG;IACZ,OAAO,KAAK/D,QAAZ;EACD;;EAEDgE,uBAAuB,CAAClD,SAAD,EAAuB;IAC5C,MAAM0B,GAAG,GAAG,KAAKjC,IAAL,CAAU0D,YAAV,CAAuBnD,SAAvB,EAAkC0B,GAA9C;IACA,MAAM0B,2BAAqC,GAAG1B,GAAG,CAAC2B,kBAAJ,GAAyB3B,GAAG,CAAC2B,kBAAJ,CAAuBrD,SAAvB,CAAzB,GAA6D,EAA3G;IACA,MAAMsD,iBAAiB,GAAGF,2BAA2B,CAACG,MAA5B,CAAmC,KAAKN,WAAL,EAAnC,CAA1B;IACA,OAAOK,iBAAP;EACD;;EAEDE,uBAAuB,GAAG;IACxB,OAAO,KAAKN,uBAAL,CAA6BO,IAA7B,CAAkC,IAAlC,CAAP;EACD;EACD;AACF;AACA;AACA;;;EACEC,iBAAiB,CAAC3B,SAAD,EAAuB;IACtC,KAAKpC,aAAL,CAAmBgE,QAAnB,CAA4B5B,SAA5B;IACA,OAAO,IAAP;EACD;;EAoBoB,aAAR6B,QAAQ,CACnB,CAACzE,OAAD,EAAU0E,OAAV,EAAmBvE,SAAnB,EAA8BF,GAA9B,EAAmCC,QAAnC,EAA6CyE,YAA7C,EAA2DtE,QAA3D,EAAqEC,IAArE,CADmB,EAWnBsE,MAXmB,EAYnB,CAACrE,WAAD,EAAcC,aAAd,CAZmB,EAanB;IACA,MAAMJ,MAAM,GAAGuE,YAAY,CAACE,YAAb,CAA0B3D,kBAAA,CAAWC,EAArC,CAAf;IACA,MAAMgB,IAAI,GAAG,IAAItC,QAAJ,CACX+E,MAAM,CAAC7E,QADI,EAGXC,OAHW,EAKXC,GALW,EAOXC,QAPW,EASXC,SATW,EAWXC,MAXW,EAaXC,QAbW,EAeXC,IAfW,EAiBXC,WAjBW,EAmBXC,aAnBW,CAAb;IAqBA2B,IAAI,CAACoC,iBAAL,CAAuB,KAAIO,oCAAJ,EAAqB7E,GAArB,EAA0BC,QAA1B,EAAoCC,SAApC,CAAvB;IACAE,QAAQ,CAAC0E,kBAAT,CAA4B5C,IAAI,CAACkC,uBAAL,EAA5B;;IAEA,IAAIlE,SAAJ,EAAe;MACbA,SAAS,CAAC6E,eAAV,CAA0B,OAAOnE,SAAP,EAAkBoE,IAAlB,KAA2B;QACnD,IAAI,CAAAA,IAAI,SAAJ,IAAAA,IAAI,WAAJ,YAAAA,IAAI,CAAEC,QAAN,MAAmB,KAAvB,EAA8B,OAAOC,SAAP;QAC9B,MAAM9C,GAAG,GAAG,MAAMF,IAAI,CAACW,UAAL,CAAgBjC,SAAhB,CAAlB;QAEA,OAAO;UACLwB,GAAG,EAAEA,GAAF,aAAEA,GAAF,uBAAEA,GAAG,CAAE+C,QAAL;QADA,CAAP;MAGD,CAPD;IAQD;;IAEDV,OAAO,CAACF,QAAR,CAAiB,IAAAa,mBAAA,EAAWlD,IAAX,CAAjB;IAEAnC,OAAO,CAACsF,kBAAR,CAA2B,KAAIC,8BAAJ,EAA0BpD,IAA1B,CAA3B;IACA,OAAOA,IAAP;EACD;;AA1LmB;;;gCAATtC,Q,WAkHI,CAAC2F,eAAA,CAAKC,QAAL,EAAD,EAA2BD,eAAA,CAAKC,QAAL,EAA3B,C;gCAlHJ5F,Q,aAoHM6F,kB;gCApHN7F,Q,kBAqHW,CACpB8F,wBADoB,EAEpBC,wBAFoB,EAGpBC,4BAHoB,EAIpBC,gBAJoB,EAKpBC,0BALoB,EAMpBC,sBANoB,EAOpBC,mBAPoB,EAQpBC,kBARoB,C;gCArHXrG,Q,mBAgIY;EACrBE,QAAQ,EAAE,CAAC,aAAD;AADW,C;;AA6DzBmB,kBAAA,CAAWiF,UAAX,CAAsBtG,QAAtB"}
|
|
1
|
+
{"version":3,"names":["DocsMain","constructor","patterns","preview","pkg","compiler","workspace","logger","devFiles","envs","docPropSlot","docReaderSlot","getDocsMap","components","ComponentMap","as","component","getDocsFiles","computeDevFiles","docFiles","get","DocsAspect","id","state","filesystem","files","filter","file","includes","relative","getDescription","componentDoc","getDoc","desc","description","consumerComponent","_consumer","fromJsDocs","docs","find","doc","getTemplate","env","getDocsTemplate","getDocReader","extension","values","docReader","isFormatSupported","computeDoc","length","docFile","extname","FileExtensionNotSupported","read","contents","err","debug","message","docData","data","Doc","filePath","DocPropList","props","getPatterns","getComponentDevPatterns","calculateEnv","componentEnvDocsDevPatterns","getDocsDevPatterns","componentPatterns","concat","getDevPatternToRegister","bind","registerDocReader","register","provider","graphql","loggerAspect","config","createLogger","DefaultDocReader","registerDevPattern","onComponentLoad","opts","loadDocs","undefined","toObject","docsSchema","registerDefinition","DocsPreviewDefinition","Slot","withType","MainRuntime","PreviewAspect","GraphqlAspect","WorkspaceAspect","PkgAspect","CompilerAspect","LoggerAspect","DevFilesAspect","EnvsAspect","addRuntime"],"sources":["docs.main.runtime.ts"],"sourcesContent":["import { Slot, SlotRegistry } from '@teambit/harmony';\nimport { MainRuntime } from '@teambit/cli';\nimport { LoggerAspect, LoggerMain, Logger } from '@teambit/logger';\nimport { CompilerAspect, CompilerMain } from '@teambit/compiler';\nimport { Component, ComponentMap, IComponent } from '@teambit/component';\nimport { PkgAspect, PkgMain } from '@teambit/pkg';\nimport type { Environment } from '@teambit/envs';\nimport { GraphqlAspect, GraphqlMain } from '@teambit/graphql';\nimport { PreviewAspect, PreviewMain } from '@teambit/preview';\nimport DevFilesAspect, { DevFilesMain } from '@teambit/dev-files';\nimport { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';\nimport ConsumerComponent from '@teambit/legacy/dist/consumer/component';\nimport { Workspace, WorkspaceAspect } from '@teambit/workspace';\nimport { Doc, DocPropList } from '@teambit/docs.entities.doc';\nimport { EnvsAspect, EnvsMain } from '@teambit/envs';\nimport { DocsAspect } from './docs.aspect';\nimport { DocsPreviewDefinition } from './docs.preview-definition';\nimport { docsSchema } from './docs.graphql';\nimport { DocReader } from './doc-reader';\nimport { DefaultDocReader } from './default-doc-reader';\nimport { FileExtensionNotSupported } from './exceptions';\n\nexport type ComponentDocs = {\n files: string[];\n component: Component;\n};\n\nexport type DocProp = {};\n\nexport type DocPropSlot = SlotRegistry<DocProp>;\n\nexport type DocReaderSlot = SlotRegistry<DocReader>;\n\nexport type DocsConfig = {\n /**\n * glob patterns to identify doc files.\n */\n patterns: string[];\n};\n\n/**\n * the component documentation extension.\n */\nexport class DocsMain {\n constructor(\n private patterns: string[],\n /**\n * envs extension.\n */\n private preview: PreviewMain,\n\n private pkg: PkgMain,\n\n private compiler: CompilerMain,\n\n private workspace: Workspace,\n\n private logger: Logger,\n\n private devFiles: DevFilesMain,\n\n private envs: EnvsMain,\n\n private docPropSlot: DocPropSlot,\n\n private docReaderSlot: DocReaderSlot\n ) {}\n\n /**\n * returns an array of doc file paths for a set of components.\n */\n getDocsMap(components: Component[]): ComponentMap<AbstractVinyl[]> {\n return ComponentMap.as<AbstractVinyl[]>(components, (component) => {\n return this.getDocsFiles(component);\n });\n }\n\n getDocsFiles(component: Component): AbstractVinyl[] {\n const devFiles = this.devFiles.computeDevFiles(component);\n const docFiles = devFiles.get(DocsAspect.id);\n return component.state.filesystem.files.filter((file) => docFiles.includes(file.relative));\n }\n\n /**\n * compute the description of the component from its source code and docs file.\n */\n async getDescription(component: Component): Promise<string> {\n const componentDoc = this.getDoc(component);\n const desc = componentDoc?.description;\n if (desc) return desc;\n const consumerComponent: ConsumerComponent = component.state._consumer;\n const fromJsDocs = consumerComponent.docs?.find((doc) => doc.description);\n\n return fromJsDocs?.description || '';\n }\n\n async getTemplate(env: Environment) {\n return env.getDocsTemplate();\n }\n\n getDocReader(extension: string) {\n return this.docReaderSlot.values().find((docReader) => docReader.isFormatSupported(extension));\n }\n\n /**\n * compute a doc for a component.\n */\n async computeDoc(component: Component) {\n const docFiles = this.getDocsFiles(component);\n if (docFiles.length) {\n // currently taking the the first docs file found with an abstract. (we support only one)\n const docFile = docFiles[0];\n\n try {\n const docReader = this.getDocReader(docFile.extname);\n if (!docReader) throw new FileExtensionNotSupported(docFile.relative, docFile.extname);\n const doc = await docReader.read(docFile.relative, docFile.contents, component);\n return doc;\n } catch (err: any) {\n // it's ok to fail here.\n this.logger.debug(`docs.main.runtime.computeDoc caught an error: ${err.message}`);\n return null;\n }\n }\n\n return null;\n }\n\n getDoc(component: IComponent) {\n const docData = component.get(DocsAspect.id)?.data?.doc;\n if (!docData) return null;\n return new Doc(docData.filePath, new DocPropList(docData.props));\n }\n\n getPatterns() {\n return this.patterns;\n }\n\n getComponentDevPatterns(component: Component) {\n const env = this.envs.calculateEnv(component).env;\n const componentEnvDocsDevPatterns: string[] = env.getDocsDevPatterns ? env.getDocsDevPatterns(component) : [];\n const componentPatterns = componentEnvDocsDevPatterns.concat(this.getPatterns());\n return componentPatterns;\n }\n\n getDevPatternToRegister() {\n return this.getComponentDevPatterns.bind(this);\n }\n /**\n * register a new doc reader. this allows to support further\n * documentation file formats.\n */\n registerDocReader(docReader: DocReader) {\n this.docReaderSlot.register(docReader);\n return this;\n }\n\n static slots = [Slot.withType<DocProp>(), Slot.withType<DocReader>()];\n\n static runtime = MainRuntime;\n static dependencies = [\n PreviewAspect,\n GraphqlAspect,\n WorkspaceAspect,\n PkgAspect,\n CompilerAspect,\n LoggerAspect,\n DevFilesAspect,\n EnvsAspect,\n ];\n\n static defaultConfig = {\n patterns: ['**/*.docs.*'],\n };\n\n static async provider(\n [preview, graphql, workspace, pkg, compiler, loggerAspect, devFiles, envs]: [\n PreviewMain,\n GraphqlMain,\n Workspace,\n PkgMain,\n CompilerMain,\n LoggerMain,\n DevFilesMain,\n EnvsMain\n ],\n config: DocsConfig,\n [docPropSlot, docReaderSlot]: [DocPropSlot, DocReaderSlot]\n ) {\n const logger = loggerAspect.createLogger(DocsAspect.id);\n const docs = new DocsMain(\n config.patterns,\n\n preview,\n\n pkg,\n\n compiler,\n\n workspace,\n\n logger,\n\n devFiles,\n\n envs,\n\n docPropSlot,\n\n docReaderSlot\n );\n docs.registerDocReader(new DefaultDocReader(pkg, compiler, workspace));\n devFiles.registerDevPattern(docs.getDevPatternToRegister());\n\n if (workspace) {\n workspace.onComponentLoad(async (component, opts) => {\n if (opts?.loadDocs === false) return undefined;\n const doc = await docs.computeDoc(component);\n\n return {\n doc: doc?.toObject(),\n };\n });\n }\n\n graphql.register(docsSchema(docs));\n\n preview.registerDefinition(new DocsPreviewDefinition(docs));\n return docs;\n }\n}\n\nDocsAspect.addRuntime(DocsMain);\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAEA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAGA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAEA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAoBA;AACA;AACA;AACO,MAAMA,QAAQ,CAAC;EACpBC,WAAW,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,UAAU,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,YAAY,CAACD,SAAoB,EAAmB;IAClD,MAAMR,QAAQ,GAAG,IAAI,CAACA,QAAQ,CAACU,eAAe,CAACF,SAAS,CAAC;IACzD,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,cAAc,CAACd,SAAoB,EAAmB;IAAA;IAC1D,MAAMe,YAAY,GAAG,IAAI,CAACC,MAAM,CAAChB,SAAS,CAAC;IAC3C,MAAMiB,IAAI,GAAGF,YAAY,aAAZA,YAAY,uBAAZA,YAAY,CAAEG,WAAW;IACtC,IAAID,IAAI,EAAE,OAAOA,IAAI;IACrB,MAAME,iBAAoC,GAAGnB,SAAS,CAACO,KAAK,CAACa,SAAS;IACtE,MAAMC,UAAU,4BAAGF,iBAAiB,CAACG,IAAI,0DAAtB,sBAAwBC,IAAI,CAAEC,GAAG,IAAKA,GAAG,CAACN,WAAW,CAAC;IAEzE,OAAO,CAAAG,UAAU,aAAVA,UAAU,uBAAVA,UAAU,CAAEH,WAAW,KAAI,EAAE;EACtC;EAEA,MAAMO,WAAW,CAACC,GAAgB,EAAE;IAClC,OAAOA,GAAG,CAACC,eAAe,EAAE;EAC9B;EAEAC,YAAY,CAACC,SAAiB,EAAE;IAC9B,OAAO,IAAI,CAAClC,aAAa,CAACmC,MAAM,EAAE,CAACP,IAAI,CAAEQ,SAAS,IAAKA,SAAS,CAACC,iBAAiB,CAACH,SAAS,CAAC,CAAC;EAChG;;EAEA;AACF;AACA;EACE,MAAMI,UAAU,CAACjC,SAAoB,EAAE;IACrC,MAAMG,QAAQ,GAAG,IAAI,CAACF,YAAY,CAACD,SAAS,CAAC;IAC7C,IAAIG,QAAQ,CAAC+B,MAAM,EAAE;MACnB;MACA,MAAMC,OAAO,GAAGhC,QAAQ,CAAC,CAAC,CAAC;MAE3B,IAAI;QACF,MAAM4B,SAAS,GAAG,IAAI,CAACH,YAAY,CAACO,OAAO,CAACC,OAAO,CAAC;QACpD,IAAI,CAACL,SAAS,EAAE,MAAM,KAAIM,uCAAyB,EAACF,OAAO,CAACtB,QAAQ,EAAEsB,OAAO,CAACC,OAAO,CAAC;QACtF,MAAMZ,GAAG,GAAG,MAAMO,SAAS,CAACO,IAAI,CAACH,OAAO,CAACtB,QAAQ,EAAEsB,OAAO,CAACI,QAAQ,EAAEvC,SAAS,CAAC;QAC/E,OAAOwB,GAAG;MACZ,CAAC,CAAC,OAAOgB,GAAQ,EAAE;QACjB;QACA,IAAI,CAACjD,MAAM,CAACkD,KAAK,CAAE,iDAAgDD,GAAG,CAACE,OAAQ,EAAC,CAAC;QACjF,OAAO,IAAI;MACb;IACF;IAEA,OAAO,IAAI;EACb;EAEA1B,MAAM,CAAChB,SAAqB,EAAE;IAAA;IAC5B,MAAM2C,OAAO,qBAAG3C,SAAS,CAACI,GAAG,CAACC,kBAAU,CAACC,EAAE,CAAC,0EAA5B,eAA8BsC,IAAI,wDAAlC,oBAAoCpB,GAAG;IACvD,IAAI,CAACmB,OAAO,EAAE,OAAO,IAAI;IACzB,OAAO,KAAIE,mBAAG,EAACF,OAAO,CAACG,QAAQ,EAAE,KAAIC,2BAAW,EAACJ,OAAO,CAACK,KAAK,CAAC,CAAC;EAClE;EAEAC,WAAW,GAAG;IACZ,OAAO,IAAI,CAAC/D,QAAQ;EACtB;EAEAgE,uBAAuB,CAAClD,SAAoB,EAAE;IAC5C,MAAM0B,GAAG,GAAG,IAAI,CAACjC,IAAI,CAAC0D,YAAY,CAACnD,SAAS,CAAC,CAAC0B,GAAG;IACjD,MAAM0B,2BAAqC,GAAG1B,GAAG,CAAC2B,kBAAkB,GAAG3B,GAAG,CAAC2B,kBAAkB,CAACrD,SAAS,CAAC,GAAG,EAAE;IAC7G,MAAMsD,iBAAiB,GAAGF,2BAA2B,CAACG,MAAM,CAAC,IAAI,CAACN,WAAW,EAAE,CAAC;IAChF,OAAOK,iBAAiB;EAC1B;EAEAE,uBAAuB,GAAG;IACxB,OAAO,IAAI,CAACN,uBAAuB,CAACO,IAAI,CAAC,IAAI,CAAC;EAChD;EACA;AACF;AACA;AACA;EACEC,iBAAiB,CAAC3B,SAAoB,EAAE;IACtC,IAAI,CAACpC,aAAa,CAACgE,QAAQ,CAAC5B,SAAS,CAAC;IACtC,OAAO,IAAI;EACb;EAoBA,aAAa6B,QAAQ,CACnB,CAACzE,OAAO,EAAE0E,OAAO,EAAEvE,SAAS,EAAEF,GAAG,EAAEC,QAAQ,EAAEyE,YAAY,EAAEtE,QAAQ,EAAEC,IAAI,CASxE,EACDsE,MAAkB,EAClB,CAACrE,WAAW,EAAEC,aAAa,CAA+B,EAC1D;IACA,MAAMJ,MAAM,GAAGuE,YAAY,CAACE,YAAY,CAAC3D,kBAAU,CAACC,EAAE,CAAC;IACvD,MAAMgB,IAAI,GAAG,IAAItC,QAAQ,CACvB+E,MAAM,CAAC7E,QAAQ,EAEfC,OAAO,EAEPC,GAAG,EAEHC,QAAQ,EAERC,SAAS,EAETC,MAAM,EAENC,QAAQ,EAERC,IAAI,EAEJC,WAAW,EAEXC,aAAa,CACd;IACD2B,IAAI,CAACoC,iBAAiB,CAAC,KAAIO,oCAAgB,EAAC7E,GAAG,EAAEC,QAAQ,EAAEC,SAAS,CAAC,CAAC;IACtEE,QAAQ,CAAC0E,kBAAkB,CAAC5C,IAAI,CAACkC,uBAAuB,EAAE,CAAC;IAE3D,IAAIlE,SAAS,EAAE;MACbA,SAAS,CAAC6E,eAAe,CAAC,OAAOnE,SAAS,EAAEoE,IAAI,KAAK;QACnD,IAAI,CAAAA,IAAI,aAAJA,IAAI,uBAAJA,IAAI,CAAEC,QAAQ,MAAK,KAAK,EAAE,OAAOC,SAAS;QAC9C,MAAM9C,GAAG,GAAG,MAAMF,IAAI,CAACW,UAAU,CAACjC,SAAS,CAAC;QAE5C,OAAO;UACLwB,GAAG,EAAEA,GAAG,aAAHA,GAAG,uBAAHA,GAAG,CAAE+C,QAAQ;QACpB,CAAC;MACH,CAAC,CAAC;IACJ;IAEAV,OAAO,CAACF,QAAQ,CAAC,IAAAa,mBAAU,EAAClD,IAAI,CAAC,CAAC;IAElCnC,OAAO,CAACsF,kBAAkB,CAAC,KAAIC,8BAAqB,EAACpD,IAAI,CAAC,CAAC;IAC3D,OAAOA,IAAI;EACb;AACF;AAAC;AAAA,gCA3LYtC,QAAQ,WAkHJ,CAAC2F,eAAI,CAACC,QAAQ,EAAW,EAAED,eAAI,CAACC,QAAQ,EAAa,CAAC;AAAA,gCAlH1D5F,QAAQ,aAoHF6F,kBAAW;AAAA,gCApHjB7F,QAAQ,kBAqHG,CACpB8F,wBAAa,EACbC,wBAAa,EACbC,4BAAe,EACfC,gBAAS,EACTC,0BAAc,EACdC,sBAAY,EACZC,mBAAc,EACdC,kBAAU,CACX;AAAA,gCA9HUrG,QAAQ,mBAgII;EACrBE,QAAQ,EAAE,CAAC,aAAa;AAC1B,CAAC;AA2DHmB,kBAAU,CAACiF,UAAU,CAACtG,QAAQ,CAAC"}
|
|
@@ -1,24 +1,18 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
|
|
3
3
|
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
|
4
|
-
|
|
5
4
|
require("core-js/modules/es.promise.js");
|
|
6
|
-
|
|
7
5
|
Object.defineProperty(exports, "__esModule", {
|
|
8
6
|
value: true
|
|
9
7
|
});
|
|
10
8
|
exports.DocsPreviewDefinition = void 0;
|
|
11
|
-
|
|
12
9
|
function _defineProperty2() {
|
|
13
10
|
const data = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
|
|
14
|
-
|
|
15
11
|
_defineProperty2 = function () {
|
|
16
12
|
return data;
|
|
17
13
|
};
|
|
18
|
-
|
|
19
14
|
return data;
|
|
20
15
|
}
|
|
21
|
-
|
|
22
16
|
class DocsPreviewDefinition {
|
|
23
17
|
constructor(
|
|
24
18
|
/**
|
|
@@ -30,30 +24,25 @@ class DocsPreviewDefinition {
|
|
|
30
24
|
(0, _defineProperty2().default)(this, "include", ['compositions']);
|
|
31
25
|
(0, _defineProperty2().default)(this, "includePeers", true);
|
|
32
26
|
}
|
|
27
|
+
|
|
33
28
|
/**
|
|
34
29
|
* application root
|
|
35
30
|
*/
|
|
36
|
-
|
|
37
|
-
|
|
38
31
|
async renderTemplatePath(context) {
|
|
39
32
|
return this.renderTemplatePathByEnv(context.env);
|
|
40
33
|
}
|
|
41
|
-
|
|
42
34
|
async renderTemplatePathByEnv(env) {
|
|
43
35
|
return this.docs.getTemplate(env);
|
|
44
36
|
}
|
|
37
|
+
|
|
45
38
|
/**
|
|
46
39
|
* files to load.
|
|
47
40
|
*/
|
|
48
|
-
|
|
49
|
-
|
|
50
41
|
async getModuleMap(components) {
|
|
51
42
|
const map = this.docs.getDocsMap(components);
|
|
52
43
|
return map;
|
|
53
44
|
}
|
|
54
|
-
|
|
55
45
|
}
|
|
56
|
-
|
|
57
46
|
exports.DocsPreviewDefinition = DocsPreviewDefinition;
|
|
58
47
|
|
|
59
48
|
//# sourceMappingURL=docs.preview-definition.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"names":["DocsPreviewDefinition","constructor","docs","renderTemplatePath","context","renderTemplatePathByEnv","env","getTemplate","getModuleMap","components","map","getDocsMap"],"sources":["docs.preview-definition.ts"],"sourcesContent":["import { Component, ComponentMap } from '@teambit/component';\nimport type { Environment, ExecutionContext } from '@teambit/envs';\nimport { PreviewDefinition } from '@teambit/preview';\nimport { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';\n\nimport { DocsMain } from './docs.main.runtime';\n\nexport class DocsPreviewDefinition implements PreviewDefinition {\n readonly prefix = 'overview';\n readonly include = ['compositions'];\n readonly includePeers = true;\n\n constructor(\n /**\n * docs extension.\n */\n private docs: DocsMain\n ) {}\n\n /**\n * application root\n */\n async renderTemplatePath(context: ExecutionContext): Promise<string> {\n return this.renderTemplatePathByEnv(context.env);\n }\n\n async renderTemplatePathByEnv(env: Environment) {\n return this.docs.getTemplate(env);\n }\n\n /**\n * files to load.\n */\n async getModuleMap(components: Component[]): Promise<ComponentMap<AbstractVinyl[]>> {\n const map = this.docs.getDocsMap(components);\n return map;\n }\n}\n"],"mappings":"
|
|
1
|
+
{"version":3,"names":["DocsPreviewDefinition","constructor","docs","renderTemplatePath","context","renderTemplatePathByEnv","env","getTemplate","getModuleMap","components","map","getDocsMap"],"sources":["docs.preview-definition.ts"],"sourcesContent":["import { Component, ComponentMap } from '@teambit/component';\nimport type { Environment, ExecutionContext } from '@teambit/envs';\nimport { PreviewDefinition } from '@teambit/preview';\nimport { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';\n\nimport { DocsMain } from './docs.main.runtime';\n\nexport class DocsPreviewDefinition implements PreviewDefinition {\n readonly prefix = 'overview';\n readonly include = ['compositions'];\n readonly includePeers = true;\n\n constructor(\n /**\n * docs extension.\n */\n private docs: DocsMain\n ) {}\n\n /**\n * application root\n */\n async renderTemplatePath(context: ExecutionContext): Promise<string> {\n return this.renderTemplatePathByEnv(context.env);\n }\n\n async renderTemplatePathByEnv(env: Environment) {\n return this.docs.getTemplate(env);\n }\n\n /**\n * files to load.\n */\n async getModuleMap(components: Component[]): Promise<ComponentMap<AbstractVinyl[]>> {\n const map = this.docs.getDocsMap(components);\n return map;\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;AAOO,MAAMA,qBAAqB,CAA8B;EAK9DC,WAAW;EACT;AACJ;AACA;EACYC,IAAc,EACtB;IAAA,KADQA,IAAc,GAAdA,IAAc;IAAA,gDARN,UAAU;IAAA,iDACT,CAAC,cAAc,CAAC;IAAA,sDACX,IAAI;EAOzB;;EAEH;AACF;AACA;EACE,MAAMC,kBAAkB,CAACC,OAAyB,EAAmB;IACnE,OAAO,IAAI,CAACC,uBAAuB,CAACD,OAAO,CAACE,GAAG,CAAC;EAClD;EAEA,MAAMD,uBAAuB,CAACC,GAAgB,EAAE;IAC9C,OAAO,IAAI,CAACJ,IAAI,CAACK,WAAW,CAACD,GAAG,CAAC;EACnC;;EAEA;AACF;AACA;EACE,MAAME,YAAY,CAACC,UAAuB,EAA0C;IAClF,MAAMC,GAAG,GAAG,IAAI,CAACR,IAAI,CAACS,UAAU,CAACF,UAAU,CAAC;IAC5C,OAAOC,GAAG;EACZ;AACF;AAAC"}
|
|
@@ -1,56 +1,40 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
|
|
3
3
|
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
|
4
|
-
|
|
5
4
|
require("core-js/modules/es.array.iterator.js");
|
|
6
|
-
|
|
7
5
|
require("core-js/modules/es.promise.js");
|
|
8
|
-
|
|
9
6
|
Object.defineProperty(exports, "__esModule", {
|
|
10
7
|
value: true
|
|
11
8
|
});
|
|
12
9
|
exports.DocsPreview = void 0;
|
|
13
|
-
|
|
14
10
|
function _defineProperty2() {
|
|
15
11
|
const data = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
|
|
16
|
-
|
|
17
12
|
_defineProperty2 = function () {
|
|
18
13
|
return data;
|
|
19
14
|
};
|
|
20
|
-
|
|
21
15
|
return data;
|
|
22
16
|
}
|
|
23
|
-
|
|
24
17
|
function _react() {
|
|
25
18
|
const data = _interopRequireDefault(require("react"));
|
|
26
|
-
|
|
27
19
|
_react = function () {
|
|
28
20
|
return data;
|
|
29
21
|
};
|
|
30
|
-
|
|
31
22
|
return data;
|
|
32
23
|
}
|
|
33
|
-
|
|
34
24
|
function _preview() {
|
|
35
25
|
const data = require("@teambit/preview");
|
|
36
|
-
|
|
37
26
|
_preview = function () {
|
|
38
27
|
return data;
|
|
39
28
|
};
|
|
40
|
-
|
|
41
29
|
return data;
|
|
42
30
|
}
|
|
43
|
-
|
|
44
31
|
function _docs() {
|
|
45
32
|
const data = require("./docs.aspect");
|
|
46
|
-
|
|
47
33
|
_docs = function () {
|
|
48
34
|
return data;
|
|
49
35
|
};
|
|
50
|
-
|
|
51
36
|
return data;
|
|
52
37
|
}
|
|
53
|
-
|
|
54
38
|
class DocsPreview {
|
|
55
39
|
constructor(
|
|
56
40
|
/**
|
|
@@ -61,16 +45,15 @@ class DocsPreview {
|
|
|
61
45
|
(0, _defineProperty2().default)(this, "render", (componentId, modules, [compositions], context) => {
|
|
62
46
|
const docsModule = this.selectPreviewModel(componentId.fullName, modules);
|
|
63
47
|
const isObject = !!modules.mainModule.default.apiObject;
|
|
48
|
+
|
|
64
49
|
/**
|
|
65
50
|
* for backwards compatibility - can be removed end of 2022
|
|
66
51
|
*/
|
|
67
|
-
|
|
68
52
|
if (!isObject) {
|
|
69
53
|
const docsPropsArray = [NoopProvider, componentId.toString(), docsModule, compositions, context];
|
|
70
54
|
modules.mainModule.default(...docsPropsArray);
|
|
71
55
|
return;
|
|
72
56
|
}
|
|
73
|
-
|
|
74
57
|
const docsProps = {
|
|
75
58
|
Provider: NoopProvider,
|
|
76
59
|
componentId: componentId.toString(),
|
|
@@ -81,14 +64,13 @@ class DocsPreview {
|
|
|
81
64
|
modules.mainModule.default(docsProps);
|
|
82
65
|
});
|
|
83
66
|
}
|
|
84
|
-
|
|
85
67
|
selectPreviewModel(componentId, modules) {
|
|
86
68
|
const relevant = modules.componentMap[componentId];
|
|
87
|
-
if (!relevant) return undefined;
|
|
69
|
+
if (!relevant) return undefined;
|
|
88
70
|
|
|
71
|
+
// only one doc file is supported.
|
|
89
72
|
return relevant[0];
|
|
90
73
|
}
|
|
91
|
-
|
|
92
74
|
static async provider([preview]) {
|
|
93
75
|
const docsPreview = new DocsPreview(preview);
|
|
94
76
|
preview.registerPreview({
|
|
@@ -99,15 +81,11 @@ class DocsPreview {
|
|
|
99
81
|
});
|
|
100
82
|
return docsPreview;
|
|
101
83
|
}
|
|
102
|
-
|
|
103
84
|
}
|
|
104
|
-
|
|
105
85
|
exports.DocsPreview = DocsPreview;
|
|
106
86
|
(0, _defineProperty2().default)(DocsPreview, "runtime", _preview().PreviewRuntime);
|
|
107
87
|
(0, _defineProperty2().default)(DocsPreview, "dependencies", [_preview().PreviewAspect]);
|
|
108
|
-
|
|
109
88
|
_docs().DocsAspect.addRuntime(DocsPreview);
|
|
110
|
-
|
|
111
89
|
function NoopProvider({
|
|
112
90
|
children
|
|
113
91
|
}) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"names":["DocsPreview","constructor","preview","componentId","modules","compositions","context","docsModule","selectPreviewModel","fullName","isObject","mainModule","default","apiObject","docsPropsArray","NoopProvider","toString","docsProps","Provider","docs","relevant","componentMap","undefined","provider","docsPreview","registerPreview","name","render","bind","include","PreviewRuntime","PreviewAspect","DocsAspect","addRuntime","children"],"sources":["docs.preview.runtime.tsx"],"sourcesContent":["import React, { ReactNode } from 'react';\nimport { PreviewAspect, RenderingContext, PreviewPreview, PreviewRuntime, PreviewModule } from '@teambit/preview';\nimport { ComponentID } from '@teambit/component-id';\n\nimport { DocsAspect } from './docs.aspect';\nimport type { Docs } from './docs';\n\nexport type DocsRootProps = {\n Provider: React.ComponentType | undefined;\n componentId: string;\n docs: Docs | undefined;\n compositions: any;\n context: RenderingContext;\n};\n\nexport class DocsPreview {\n constructor(\n /**\n * preview extension.\n */\n private preview: PreviewPreview\n ) {}\n\n render = (componentId: ComponentID, modules: PreviewModule, [compositions]: [any], context: RenderingContext) => {\n const docsModule = this.selectPreviewModel(componentId.fullName, modules);\n\n const isObject = !!modules.mainModule.default.apiObject;\n\n /**\n * for backwards compatibility - can be removed end of 2022\n */\n if (!isObject) {\n const docsPropsArray = [\n NoopProvider as React.ComponentType,\n componentId.toString(),\n docsModule as Docs,\n compositions,\n context,\n ];\n modules.mainModule.default(...docsPropsArray);\n return;\n }\n\n const docsProps: DocsRootProps = {\n Provider: NoopProvider as React.ComponentType,\n componentId: componentId.toString(),\n docs: docsModule as Docs,\n compositions,\n context,\n };\n\n modules.mainModule.default(docsProps);\n };\n\n selectPreviewModel(componentId: string, modules: PreviewModule) {\n const relevant = modules.componentMap[componentId];\n if (!relevant) return undefined;\n\n // only one doc file is supported.\n return relevant[0];\n }\n\n static runtime = PreviewRuntime;\n static dependencies = [PreviewAspect];\n\n static async provider([preview]: [PreviewPreview]) {\n const docsPreview = new DocsPreview(preview);\n preview.registerPreview({\n name: 'overview',\n render: docsPreview.render.bind(docsPreview),\n selectPreviewModel: docsPreview.selectPreviewModel.bind(docsPreview),\n include: ['compositions'],\n });\n\n return docsPreview;\n }\n}\n\nDocsAspect.addRuntime(DocsPreview);\n\nfunction NoopProvider({ children }: { children: ReactNode }) {\n return <>{children}</>;\n}\n"],"mappings":"
|
|
1
|
+
{"version":3,"names":["DocsPreview","constructor","preview","componentId","modules","compositions","context","docsModule","selectPreviewModel","fullName","isObject","mainModule","default","apiObject","docsPropsArray","NoopProvider","toString","docsProps","Provider","docs","relevant","componentMap","undefined","provider","docsPreview","registerPreview","name","render","bind","include","PreviewRuntime","PreviewAspect","DocsAspect","addRuntime","children"],"sources":["docs.preview.runtime.tsx"],"sourcesContent":["import React, { ReactNode } from 'react';\nimport { PreviewAspect, RenderingContext, PreviewPreview, PreviewRuntime, PreviewModule } from '@teambit/preview';\nimport { ComponentID } from '@teambit/component-id';\n\nimport { DocsAspect } from './docs.aspect';\nimport type { Docs } from './docs';\n\nexport type DocsRootProps = {\n Provider: React.ComponentType | undefined;\n componentId: string;\n docs: Docs | undefined;\n compositions: any;\n context: RenderingContext;\n};\n\nexport class DocsPreview {\n constructor(\n /**\n * preview extension.\n */\n private preview: PreviewPreview\n ) {}\n\n render = (componentId: ComponentID, modules: PreviewModule, [compositions]: [any], context: RenderingContext) => {\n const docsModule = this.selectPreviewModel(componentId.fullName, modules);\n\n const isObject = !!modules.mainModule.default.apiObject;\n\n /**\n * for backwards compatibility - can be removed end of 2022\n */\n if (!isObject) {\n const docsPropsArray = [\n NoopProvider as React.ComponentType,\n componentId.toString(),\n docsModule as Docs,\n compositions,\n context,\n ];\n modules.mainModule.default(...docsPropsArray);\n return;\n }\n\n const docsProps: DocsRootProps = {\n Provider: NoopProvider as React.ComponentType,\n componentId: componentId.toString(),\n docs: docsModule as Docs,\n compositions,\n context,\n };\n\n modules.mainModule.default(docsProps);\n };\n\n selectPreviewModel(componentId: string, modules: PreviewModule) {\n const relevant = modules.componentMap[componentId];\n if (!relevant) return undefined;\n\n // only one doc file is supported.\n return relevant[0];\n }\n\n static runtime = PreviewRuntime;\n static dependencies = [PreviewAspect];\n\n static async provider([preview]: [PreviewPreview]) {\n const docsPreview = new DocsPreview(preview);\n preview.registerPreview({\n name: 'overview',\n render: docsPreview.render.bind(docsPreview),\n selectPreviewModel: docsPreview.selectPreviewModel.bind(docsPreview),\n include: ['compositions'],\n });\n\n return docsPreview;\n }\n}\n\nDocsAspect.addRuntime(DocsPreview);\n\nfunction NoopProvider({ children }: { children: ReactNode }) {\n return <>{children}</>;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAGA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAWO,MAAMA,WAAW,CAAC;EACvBC,WAAW;EACT;AACJ;AACA;EACYC,OAAuB,EAC/B;IAAA,KADQA,OAAuB,GAAvBA,OAAuB;IAAA,gDAGxB,CAACC,WAAwB,EAAEC,OAAsB,EAAE,CAACC,YAAY,CAAQ,EAAEC,OAAyB,KAAK;MAC/G,MAAMC,UAAU,GAAG,IAAI,CAACC,kBAAkB,CAACL,WAAW,CAACM,QAAQ,EAAEL,OAAO,CAAC;MAEzE,MAAMM,QAAQ,GAAG,CAAC,CAACN,OAAO,CAACO,UAAU,CAACC,OAAO,CAACC,SAAS;;MAEvD;AACJ;AACA;MACI,IAAI,CAACH,QAAQ,EAAE;QACb,MAAMI,cAAc,GAAG,CACrBC,YAAY,EACZZ,WAAW,CAACa,QAAQ,EAAE,EACtBT,UAAU,EACVF,YAAY,EACZC,OAAO,CACR;QACDF,OAAO,CAACO,UAAU,CAACC,OAAO,CAAC,GAAGE,cAAc,CAAC;QAC7C;MACF;MAEA,MAAMG,SAAwB,GAAG;QAC/BC,QAAQ,EAAEH,YAAmC;QAC7CZ,WAAW,EAAEA,WAAW,CAACa,QAAQ,EAAE;QACnCG,IAAI,EAAEZ,UAAkB;QACxBF,YAAY;QACZC;MACF,CAAC;MAEDF,OAAO,CAACO,UAAU,CAACC,OAAO,CAACK,SAAS,CAAC;IACvC,CAAC;EA/BE;EAiCHT,kBAAkB,CAACL,WAAmB,EAAEC,OAAsB,EAAE;IAC9D,MAAMgB,QAAQ,GAAGhB,OAAO,CAACiB,YAAY,CAAClB,WAAW,CAAC;IAClD,IAAI,CAACiB,QAAQ,EAAE,OAAOE,SAAS;;IAE/B;IACA,OAAOF,QAAQ,CAAC,CAAC,CAAC;EACpB;EAKA,aAAaG,QAAQ,CAAC,CAACrB,OAAO,CAAmB,EAAE;IACjD,MAAMsB,WAAW,GAAG,IAAIxB,WAAW,CAACE,OAAO,CAAC;IAC5CA,OAAO,CAACuB,eAAe,CAAC;MACtBC,IAAI,EAAE,UAAU;MAChBC,MAAM,EAAEH,WAAW,CAACG,MAAM,CAACC,IAAI,CAACJ,WAAW,CAAC;MAC5ChB,kBAAkB,EAAEgB,WAAW,CAAChB,kBAAkB,CAACoB,IAAI,CAACJ,WAAW,CAAC;MACpEK,OAAO,EAAE,CAAC,cAAc;IAC1B,CAAC,CAAC;IAEF,OAAOL,WAAW;EACpB;AACF;AAAC;AAAA,gCA7DYxB,WAAW,aA+CL8B,yBAAc;AAAA,gCA/CpB9B,WAAW,kBAgDA,CAAC+B,wBAAa,CAAC;AAevCC,kBAAU,CAACC,UAAU,CAACjC,WAAW,CAAC;AAElC,SAASe,YAAY,CAAC;EAAEmB;AAAkC,CAAC,EAAE;EAC3D,oBAAO,gEAAGA,QAAQ,CAAI;AACxB"}
|
package/dist/docs.service.js
CHANGED
|
@@ -1,35 +1,26 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
|
|
3
3
|
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
|
4
|
-
|
|
5
4
|
require("core-js/modules/es.promise.js");
|
|
6
|
-
|
|
7
5
|
Object.defineProperty(exports, "__esModule", {
|
|
8
6
|
value: true
|
|
9
7
|
});
|
|
10
8
|
exports.DocsService = void 0;
|
|
11
|
-
|
|
12
9
|
function _defineProperty2() {
|
|
13
10
|
const data = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
|
|
14
|
-
|
|
15
11
|
_defineProperty2 = function () {
|
|
16
12
|
return data;
|
|
17
13
|
};
|
|
18
|
-
|
|
19
14
|
return data;
|
|
20
15
|
}
|
|
21
|
-
|
|
22
16
|
class DocsService {
|
|
23
17
|
constructor() {
|
|
24
18
|
(0, _defineProperty2().default)(this, "name", 'docs');
|
|
25
19
|
}
|
|
26
|
-
|
|
27
20
|
async run(context) {
|
|
28
21
|
return context.env.getDocsTemplate();
|
|
29
22
|
}
|
|
30
|
-
|
|
31
23
|
}
|
|
32
|
-
|
|
33
24
|
exports.DocsService = DocsService;
|
|
34
25
|
|
|
35
26
|
//# sourceMappingURL=docs.service.js.map
|
package/dist/docs.service.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"names":["DocsService","run","context","env","getDocsTemplate"],"sources":["docs.service.ts"],"sourcesContent":["import { EnvService, ExecutionContext } from '@teambit/envs';\n\nexport class DocsService implements EnvService<any> {\n name = 'docs';\n\n async run(context: ExecutionContext) {\n return context.env.getDocsTemplate();\n }\n}\n"],"mappings":"
|
|
1
|
+
{"version":3,"names":["DocsService","run","context","env","getDocsTemplate"],"sources":["docs.service.ts"],"sourcesContent":["import { EnvService, ExecutionContext } from '@teambit/envs';\n\nexport class DocsService implements EnvService<any> {\n name = 'docs';\n\n async run(context: ExecutionContext) {\n return context.env.getDocsTemplate();\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;AAEO,MAAMA,WAAW,CAA4B;EAAA;IAAA,8CAC3C,MAAM;EAAA;EAEb,MAAMC,GAAG,CAACC,OAAyB,EAAE;IACnC,OAAOA,OAAO,CAACC,GAAG,CAACC,eAAe,EAAE;EACtC;AACF;AAAC"}
|