@teambit/api-reference 1.0.252 → 1.0.254

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 (8) hide show
  1. package/api-reference.ui.runtime.tsx +11 -5
  2. package/artifacts/__bit_junit.xml +1 -1
  3. package/artifacts/schema.json +205 -131
  4. package/dist/api-reference.ui.runtime.d.ts +4 -2
  5. package/dist/api-reference.ui.runtime.js +14 -5
  6. package/dist/api-reference.ui.runtime.js.map +1 -1
  7. package/package.json +7 -6
  8. /package/dist/{preview-1713957392636.js → preview-1714101543527.js} +0 -0
package/api-reference.ui.runtime.tsx CHANGED
@@ -26,14 +26,20 @@ import { decoratorRenderer } from '@teambit/api-reference.renderers.decorator';
26
26
  import { SchemaNodeConstructor, SchemaRegistry, Schemas } from '@teambit/semantics.entities.semantic-schema';
27
27
  import { CodeAspect, CodeUI } from '@teambit/code';
28
28
  import { TaggedExports } from '@teambit/tagged-exports';
29
+ import { WorkspaceAspect, WorkspaceUI } from '@teambit/workspace';
29
30
 
30
31
  import { APIReferenceAspect } from './api-reference.aspect';
31
32
 
32
33
  export type APINodeRendererSlot = SlotRegistry<APINodeRenderer[]>;
33
34
  export class APIReferenceUI {
34
- constructor(private host: string, private apiNodeRendererSlot: APINodeRendererSlot, private code: CodeUI) {}
35
+ constructor(
36
+ private host: string,
37
+ private apiNodeRendererSlot: APINodeRendererSlot,
38
+ private code: CodeUI,
39
+ private workspace: WorkspaceUI
40
+ ) {}
35
41
 
36
- static dependencies = [ComponentAspect, CodeAspect];
42
+ static dependencies = [ComponentAspect, CodeAspect, WorkspaceAspect];
37
43
  static runtime = UIRuntime;
38
44
  static slots = [Slot.withType<APINodeRenderer[]>()];
39
45
 
@@ -49,7 +55,7 @@ export class APIReferenceUI {
49
55
  TaggedAPIPage = ({ componentId }: { componentId: string }) => {
50
56
  return (
51
57
  <APIRefRenderersProvider nodeRenderers={flatten(this.apiNodeRendererSlot.values())}>
52
- <TaggedExports componentId={componentId} />
58
+ <TaggedExports componentId={componentId} showBanner={Boolean(this.workspace)} />
53
59
  </APIRefRenderersProvider>
54
60
  );
55
61
  };
@@ -86,14 +92,14 @@ export class APIReferenceUI {
86
92
  ];
87
93
 
88
94
  static async provider(
89
- [componentUI, codeUI]: [ComponentUI, CodeUI],
95
+ [componentUI, codeUI, workspaceUI]: [ComponentUI, CodeUI, WorkspaceUI],
90
96
  _,
91
97
  [apiNodeRendererSlot]: [APINodeRendererSlot],
92
98
  harmony: Harmony
93
99
  ) {
94
100
  const { config } = harmony;
95
101
  const host = String(config.get('teambit.harmony/bit'));
96
- const apiReferenceUI = new APIReferenceUI(host, apiNodeRendererSlot, codeUI);
102
+ const apiReferenceUI = new APIReferenceUI(host, apiNodeRendererSlot, codeUI, workspaceUI);
97
103
  apiReferenceUI.registerAPINodeRenderer(apiReferenceUI.apiNodeRenderers);
98
104
  const apiReferenceSection = new APIRefSection(apiReferenceUI);
99
105
  componentUI.registerNavigation(apiReferenceSection.navigationLink, apiReferenceSection.order);
package/artifacts/__bit_junit.xml CHANGED
@@ -1,4 +1,4 @@
1
1
  <?xml version="1.0" encoding="UTF-8"?>
2
2
  <testsuites tests="0" failures="0" errors="0" skipped="0">
3
- <testsuite name="teambit.api-reference/api-reference@1.0.252" tests="0" failures="0" errors="0" skipped="0"/>
3
+ <testsuite name="teambit.api-reference/api-reference@1.0.254" tests="0" failures="0" errors="0" skipped="0"/>
4
4
  </testsuites>
package/artifacts/schema.json CHANGED
@@ -17,7 +17,7 @@
17
17
  "__schema": "ClassSchema",
18
18
  "location": {
19
19
  "filePath": "api-reference.ui.runtime.tsx",
20
- "line": 33,
20
+ "line": 34,
21
21
  "character": 1
22
22
  },
23
23
  "signature": "class APIReferenceUI",
@@ -27,26 +27,26 @@
27
27
  "__schema": "ConstructorSchema",
28
28
  "location": {
29
29
  "filePath": "api-reference.ui.runtime.tsx",
30
- "line": 34,
30
+ "line": 35,
31
31
  "character": 3
32
32
  },
33
- "signature": "constructor APIReferenceUI(host: string, apiNodeRendererSlot: APINodeRendererSlot, code: CodeUI): APIReferenceUI",
33
+ "signature": "constructor APIReferenceUI(host: string, apiNodeRendererSlot: APINodeRendererSlot, code: CodeUI, workspace: WorkspaceUI): APIReferenceUI",
34
34
  "name": "constructor",
35
35
  "params": [
36
36
  {
37
37
  "__schema": "ParameterSchema",
38
38
  "location": {
39
39
  "filePath": "api-reference.ui.runtime.tsx",
40
- "line": 34,
41
- "character": 15
40
+ "line": 36,
41
+ "character": 5
42
42
  },
43
43
  "name": "host",
44
44
  "type": {
45
45
  "__schema": "KeywordTypeSchema",
46
46
  "location": {
47
47
  "filePath": "api-reference.ui.runtime.tsx",
48
- "line": 34,
49
- "character": 29
48
+ "line": 36,
49
+ "character": 19
50
50
  },
51
51
  "name": "string"
52
52
  },
@@ -57,16 +57,16 @@
57
57
  "__schema": "ParameterSchema",
58
58
  "location": {
59
59
  "filePath": "api-reference.ui.runtime.tsx",
60
- "line": 34,
61
- "character": 37
60
+ "line": 37,
61
+ "character": 5
62
62
  },
63
63
  "name": "apiNodeRendererSlot",
64
64
  "type": {
65
65
  "__schema": "TypeRefSchema",
66
66
  "location": {
67
67
  "filePath": "api-reference.ui.runtime.tsx",
68
- "line": 34,
69
- "character": 66
68
+ "line": 37,
69
+ "character": 34
70
70
  },
71
71
  "name": "APINodeRendererSlot"
72
72
  },
@@ -77,16 +77,16 @@
77
77
  "__schema": "ParameterSchema",
78
78
  "location": {
79
79
  "filePath": "api-reference.ui.runtime.tsx",
80
- "line": 34,
81
- "character": 87
80
+ "line": 38,
81
+ "character": 5
82
82
  },
83
83
  "name": "code",
84
84
  "type": {
85
85
  "__schema": "TypeRefSchema",
86
86
  "location": {
87
87
  "filePath": "api-reference.ui.runtime.tsx",
88
- "line": 34,
89
- "character": 101
88
+ "line": 38,
89
+ "character": 19
90
90
  },
91
91
  "name": "CodeUI",
92
92
  "componentId": {
@@ -96,13 +96,37 @@
96
96
  },
97
97
  "isOptional": false,
98
98
  "isSpread": false
99
+ },
100
+ {
101
+ "__schema": "ParameterSchema",
102
+ "location": {
103
+ "filePath": "api-reference.ui.runtime.tsx",
104
+ "line": 39,
105
+ "character": 5
106
+ },
107
+ "name": "workspace",
108
+ "type": {
109
+ "__schema": "TypeRefSchema",
110
+ "location": {
111
+ "filePath": "api-reference.ui.runtime.tsx",
112
+ "line": 39,
113
+ "character": 24
114
+ },
115
+ "name": "WorkspaceUI",
116
+ "componentId": {
117
+ "scope": "teambit.workspace",
118
+ "name": "workspace"
119
+ }
120
+ },
121
+ "isOptional": false,
122
+ "isSpread": false
99
123
  }
100
124
  ],
101
125
  "returnType": {
102
126
  "__schema": "ThisTypeSchema",
103
127
  "location": {
104
128
  "filePath": "api-reference.ui.runtime.tsx",
105
- "line": 33,
129
+ "line": 34,
106
130
  "character": 1
107
131
  },
108
132
  "name": "APIReferenceUI"
@@ -113,7 +137,7 @@
113
137
  "__schema": "VariableLikeSchema",
114
138
  "location": {
115
139
  "filePath": "api-reference.ui.runtime.tsx",
116
- "line": 36,
140
+ "line": 42,
117
141
  "character": 3
118
142
  },
119
143
  "signature": "(property) APIReferenceUI.dependencies: Aspect[]",
@@ -122,19 +146,19 @@
122
146
  "__schema": "InferenceTypeSchema",
123
147
  "location": {
124
148
  "filePath": "api-reference.ui.runtime.tsx",
125
- "line": 36,
149
+ "line": 42,
126
150
  "character": 3
127
151
  },
128
152
  "type": "Aspect[]"
129
153
  },
130
154
  "isOptional": true,
131
- "defaultValue": "[ComponentAspect, CodeAspect]"
155
+ "defaultValue": "[ComponentAspect, CodeAspect, WorkspaceAspect]"
132
156
  },
133
157
  {
134
158
  "__schema": "VariableLikeSchema",
135
159
  "location": {
136
160
  "filePath": "api-reference.ui.runtime.tsx",
137
- "line": 37,
161
+ "line": 43,
138
162
  "character": 3
139
163
  },
140
164
  "signature": "(property) APIReferenceUI.runtime: RuntimeDefinition",
@@ -143,7 +167,7 @@
143
167
  "__schema": "InferenceTypeSchema",
144
168
  "location": {
145
169
  "filePath": "api-reference.ui.runtime.tsx",
146
- "line": 37,
170
+ "line": 43,
147
171
  "character": 3
148
172
  },
149
173
  "type": "RuntimeDefinition"
@@ -155,7 +179,7 @@
155
179
  "__schema": "VariableLikeSchema",
156
180
  "location": {
157
181
  "filePath": "api-reference.ui.runtime.tsx",
158
- "line": 38,
182
+ "line": 44,
159
183
  "character": 3
160
184
  },
161
185
  "signature": "(property) APIReferenceUI.slots: ((registerFn: () => string) => SlotRegistry<APINodeRenderer[]>)[]",
@@ -164,7 +188,7 @@
164
188
  "__schema": "InferenceTypeSchema",
165
189
  "location": {
166
190
  "filePath": "api-reference.ui.runtime.tsx",
167
- "line": 38,
191
+ "line": 44,
168
192
  "character": 3
169
193
  },
170
194
  "type": "((registerFn: () => string) => SlotRegistry<APINodeRenderer[]>)[]"
@@ -176,7 +200,7 @@
176
200
  "__schema": "ReactSchema",
177
201
  "location": {
178
202
  "filePath": "api-reference.ui.runtime.tsx",
179
- "line": 40,
203
+ "line": 46,
180
204
  "character": 3
181
205
  },
182
206
  "signature": "(method) APIReferenceUI.getAPIPage(): React.JSX.Element",
@@ -185,7 +209,7 @@
185
209
  "__schema": "TypeRefSchema",
186
210
  "location": {
187
211
  "filePath": "api-reference.ui.runtime.tsx",
188
- "line": 40,
212
+ "line": 46,
189
213
  "character": 3
190
214
  },
191
215
  "name": "React.JSX.Element",
@@ -197,7 +221,7 @@
197
221
  "__schema": "VariableLikeSchema",
198
222
  "location": {
199
223
  "filePath": "api-reference.ui.runtime.tsx",
200
- "line": 49,
224
+ "line": 55,
201
225
  "character": 3
202
226
  },
203
227
  "signature": "(property) APIReferenceUI.TaggedAPIPage: ({ componentId }: {\n componentId: string;\n}) => React.JSX.Element",
@@ -206,19 +230,19 @@
206
230
  "__schema": "InferenceTypeSchema",
207
231
  "location": {
208
232
  "filePath": "api-reference.ui.runtime.tsx",
209
- "line": 49,
233
+ "line": 55,
210
234
  "character": 3
211
235
  },
212
236
  "type": "({ componentId }: {\n componentId: string;\n}) => React.JSX.Element"
213
237
  },
214
238
  "isOptional": true,
215
- "defaultValue": "({ componentId }: { componentId: string }) => {\n return (\n <APIRefRenderersProvider nodeRenderers={flatten(this.apiNodeRendererSlot.values())}>\n <TaggedExports componentId={componentId} />\n </APIRefRenderersProvider>\n );\n }"
239
+ "defaultValue": "({ componentId }: { componentId: string }) => {\n return (\n <APIRefRenderersProvider nodeRenderers={flatten(this.apiNodeRendererSlot.values())}>\n <TaggedExports componentId={componentId} showBanner={Boolean(this.workspace)} />\n </APIRefRenderersProvider>\n );\n }"
216
240
  },
217
241
  {
218
242
  "__schema": "FunctionLikeSchema",
219
243
  "location": {
220
244
  "filePath": "api-reference.ui.runtime.tsx",
221
- "line": 57,
245
+ "line": 63,
222
246
  "character": 3
223
247
  },
224
248
  "signature": "(method) APIReferenceUI.registerSchemaClass(schema: SchemaNodeConstructor): void",
@@ -228,7 +252,7 @@
228
252
  "__schema": "ParameterSchema",
229
253
  "location": {
230
254
  "filePath": "api-reference.ui.runtime.tsx",
231
- "line": 57,
255
+ "line": 63,
232
256
  "character": 23
233
257
  },
234
258
  "name": "schema",
@@ -236,7 +260,7 @@
236
260
  "__schema": "TypeRefSchema",
237
261
  "location": {
238
262
  "filePath": "api-reference.ui.runtime.tsx",
239
- "line": 57,
263
+ "line": 63,
240
264
  "character": 31
241
265
  },
242
266
  "name": "SchemaNodeConstructor",
@@ -254,7 +278,7 @@
254
278
  "__schema": "InferenceTypeSchema",
255
279
  "location": {
256
280
  "filePath": "api-reference.ui.runtime.tsx",
257
- "line": 57,
281
+ "line": 63,
258
282
  "character": 3
259
283
  },
260
284
  "type": "void"
@@ -265,7 +289,7 @@
265
289
  "__schema": "FunctionLikeSchema",
266
290
  "location": {
267
291
  "filePath": "api-reference.ui.runtime.tsx",
268
- "line": 61,
292
+ "line": 67,
269
293
  "character": 3
270
294
  },
271
295
  "signature": "(method) APIReferenceUI.getSchemaClasses(): () => Record<string, SchemaNodeConstructor>",
@@ -275,7 +299,7 @@
275
299
  "__schema": "InferenceTypeSchema",
276
300
  "location": {
277
301
  "filePath": "api-reference.ui.runtime.tsx",
278
- "line": 61,
302
+ "line": 67,
279
303
  "character": 3
280
304
  },
281
305
  "type": "() => Record<string, SchemaNodeConstructor>"
@@ -286,7 +310,7 @@
286
310
  "__schema": "FunctionLikeSchema",
287
311
  "location": {
288
312
  "filePath": "api-reference.ui.runtime.tsx",
289
- "line": 65,
313
+ "line": 71,
290
314
  "character": 3
291
315
  },
292
316
  "signature": "(method) APIReferenceUI.registerAPINodeRenderer(apiNodeRenderers: APINodeRenderer[]): void",
@@ -296,7 +320,7 @@
296
320
  "__schema": "ParameterSchema",
297
321
  "location": {
298
322
  "filePath": "api-reference.ui.runtime.tsx",
299
- "line": 65,
323
+ "line": 71,
300
324
  "character": 27
301
325
  },
302
326
  "name": "apiNodeRenderers",
@@ -304,14 +328,14 @@
304
328
  "__schema": "TypeArraySchema",
305
329
  "location": {
306
330
  "filePath": "api-reference.ui.runtime.tsx",
307
- "line": 65,
331
+ "line": 71,
308
332
  "character": 45
309
333
  },
310
334
  "type": {
311
335
  "__schema": "TypeRefSchema",
312
336
  "location": {
313
337
  "filePath": "api-reference.ui.runtime.tsx",
314
- "line": 65,
338
+ "line": 71,
315
339
  "character": 45
316
340
  },
317
341
  "name": "APINodeRenderer",
@@ -330,7 +354,7 @@
330
354
  "__schema": "InferenceTypeSchema",
331
355
  "location": {
332
356
  "filePath": "api-reference.ui.runtime.tsx",
333
- "line": 65,
357
+ "line": 71,
334
358
  "character": 3
335
359
  },
336
360
  "type": "void"
@@ -341,7 +365,7 @@
341
365
  "__schema": "VariableLikeSchema",
342
366
  "location": {
343
367
  "filePath": "api-reference.ui.runtime.tsx",
344
- "line": 69,
368
+ "line": 75,
345
369
  "character": 3
346
370
  },
347
371
  "signature": "(property) APIReferenceUI.apiNodeRenderers: APINodeRenderer[]",
@@ -350,14 +374,14 @@
350
374
  "__schema": "TypeArraySchema",
351
375
  "location": {
352
376
  "filePath": "api-reference.ui.runtime.tsx",
353
- "line": 69,
377
+ "line": 75,
354
378
  "character": 21
355
379
  },
356
380
  "type": {
357
381
  "__schema": "TypeRefSchema",
358
382
  "location": {
359
383
  "filePath": "api-reference.ui.runtime.tsx",
360
- "line": 69,
384
+ "line": 75,
361
385
  "character": 21
362
386
  },
363
387
  "name": "APINodeRenderer",
@@ -375,34 +399,34 @@
375
399
  "__schema": "FunctionLikeSchema",
376
400
  "location": {
377
401
  "filePath": "api-reference.ui.runtime.tsx",
378
- "line": 88,
402
+ "line": 94,
379
403
  "character": 3
380
404
  },
381
- "signature": "(method) APIReferenceUI.provider([componentUI, codeUI]: [ComponentUI, CodeUI], _: any, [apiNodeRendererSlot]: [APINodeRendererSlot], harmony: Harmony): Promise<APIReferenceUI>",
405
+ "signature": "(method) APIReferenceUI.provider([componentUI, codeUI, workspaceUI]: [ComponentUI, CodeUI, WorkspaceUI], _: any, [apiNodeRendererSlot]: [APINodeRendererSlot], harmony: Harmony): Promise<APIReferenceUI>",
382
406
  "name": "provider",
383
407
  "params": [
384
408
  {
385
409
  "__schema": "ParameterSchema",
386
410
  "location": {
387
411
  "filePath": "api-reference.ui.runtime.tsx",
388
- "line": 89,
412
+ "line": 95,
389
413
  "character": 5
390
414
  },
391
- "name": "[ componentUI, codeUI ]",
415
+ "name": "[ componentUI, codeUI, workspaceUI ]",
392
416
  "type": {
393
417
  "__schema": "TupleTypeSchema",
394
418
  "location": {
395
419
  "filePath": "api-reference.ui.runtime.tsx",
396
- "line": 89,
397
- "character": 28
420
+ "line": 95,
421
+ "character": 41
398
422
  },
399
423
  "elements": [
400
424
  {
401
425
  "__schema": "TypeRefSchema",
402
426
  "location": {
403
427
  "filePath": "api-reference.ui.runtime.tsx",
404
- "line": 89,
405
- "character": 29
428
+ "line": 95,
429
+ "character": 42
406
430
  },
407
431
  "name": "ComponentUI",
408
432
  "componentId": {
@@ -414,14 +438,27 @@
414
438
  "__schema": "TypeRefSchema",
415
439
  "location": {
416
440
  "filePath": "api-reference.ui.runtime.tsx",
417
- "line": 89,
418
- "character": 42
441
+ "line": 95,
442
+ "character": 55
419
443
  },
420
444
  "name": "CodeUI",
421
445
  "componentId": {
422
446
  "scope": "teambit.component",
423
447
  "name": "code"
424
448
  }
449
+ },
450
+ {
451
+ "__schema": "TypeRefSchema",
452
+ "location": {
453
+ "filePath": "api-reference.ui.runtime.tsx",
454
+ "line": 95,
455
+ "character": 63
456
+ },
457
+ "name": "WorkspaceUI",
458
+ "componentId": {
459
+ "scope": "teambit.workspace",
460
+ "name": "workspace"
461
+ }
425
462
  }
426
463
  ]
427
464
  },
@@ -432,7 +469,7 @@
432
469
  "__schema": "ParameterSchema",
433
470
  "location": {
434
471
  "filePath": "api-reference.ui.runtime.tsx",
435
- "line": 90,
472
+ "line": 96,
436
473
  "character": 5
437
474
  },
438
475
  "name": "_",
@@ -440,7 +477,7 @@
440
477
  "__schema": "InferenceTypeSchema",
441
478
  "location": {
442
479
  "filePath": "api-reference.ui.runtime.tsx",
443
- "line": 90,
480
+ "line": 96,
444
481
  "character": 5
445
482
  },
446
483
  "type": "any"
@@ -452,7 +489,7 @@
452
489
  "__schema": "ParameterSchema",
453
490
  "location": {
454
491
  "filePath": "api-reference.ui.runtime.tsx",
455
- "line": 91,
492
+ "line": 97,
456
493
  "character": 5
457
494
  },
458
495
  "name": "[ apiNodeRendererSlot ]",
@@ -460,7 +497,7 @@
460
497
  "__schema": "TupleTypeSchema",
461
498
  "location": {
462
499
  "filePath": "api-reference.ui.runtime.tsx",
463
- "line": 91,
500
+ "line": 97,
464
501
  "character": 28
465
502
  },
466
503
  "elements": [
@@ -468,7 +505,7 @@
468
505
  "__schema": "TypeRefSchema",
469
506
  "location": {
470
507
  "filePath": "api-reference.ui.runtime.tsx",
471
- "line": 91,
508
+ "line": 97,
472
509
  "character": 29
473
510
  },
474
511
  "name": "APINodeRendererSlot"
@@ -482,7 +519,7 @@
482
519
  "__schema": "ParameterSchema",
483
520
  "location": {
484
521
  "filePath": "api-reference.ui.runtime.tsx",
485
- "line": 92,
522
+ "line": 98,
486
523
  "character": 5
487
524
  },
488
525
  "name": "harmony",
@@ -490,7 +527,7 @@
490
527
  "__schema": "TypeRefSchema",
491
528
  "location": {
492
529
  "filePath": "api-reference.ui.runtime.tsx",
493
- "line": 92,
530
+ "line": 98,
494
531
  "character": 14
495
532
  },
496
533
  "name": "Harmony",
@@ -508,7 +545,7 @@
508
545
  "__schema": "InferenceTypeSchema",
509
546
  "location": {
510
547
  "filePath": "api-reference.ui.runtime.tsx",
511
- "line": 88,
548
+ "line": 94,
512
549
  "character": 3
513
550
  },
514
551
  "type": "Promise<APIReferenceUI>"
@@ -526,7 +563,7 @@
526
563
  "__schema": "TypeSchema",
527
564
  "location": {
528
565
  "filePath": "api-reference.ui.runtime.tsx",
529
- "line": 32,
566
+ "line": 33,
530
567
  "character": 1
531
568
  },
532
569
  "signature": "type APINodeRendererSlot = SlotRegistry<APINodeRenderer[]>",
@@ -535,7 +572,7 @@
535
572
  "__schema": "TypeRefSchema",
536
573
  "location": {
537
574
  "filePath": "api-reference.ui.runtime.tsx",
538
- "line": 32,
575
+ "line": 33,
539
576
  "character": 35
540
577
  },
541
578
  "name": "SlotRegistry",
@@ -549,14 +586,14 @@
549
586
  "__schema": "TypeArraySchema",
550
587
  "location": {
551
588
  "filePath": "api-reference.ui.runtime.tsx",
552
- "line": 32,
589
+ "line": 33,
553
590
  "character": 48
554
591
  },
555
592
  "type": {
556
593
  "__schema": "TypeRefSchema",
557
594
  "location": {
558
595
  "filePath": "api-reference.ui.runtime.tsx",
559
- "line": 32,
596
+ "line": 33,
560
597
  "character": 48
561
598
  },
562
599
  "name": "APINodeRenderer",
@@ -622,7 +659,7 @@
622
659
  "__schema": "TypeSchema",
623
660
  "location": {
624
661
  "filePath": "api-reference.ui.runtime.tsx",
625
- "line": 32,
662
+ "line": 33,
626
663
  "character": 1
627
664
  },
628
665
  "signature": "type APINodeRendererSlot = SlotRegistry<APINodeRenderer[]>",
@@ -631,7 +668,7 @@
631
668
  "__schema": "TypeRefSchema",
632
669
  "location": {
633
670
  "filePath": "api-reference.ui.runtime.tsx",
634
- "line": 32,
671
+ "line": 33,
635
672
  "character": 35
636
673
  },
637
674
  "name": "SlotRegistry",
@@ -645,14 +682,14 @@
645
682
  "__schema": "TypeArraySchema",
646
683
  "location": {
647
684
  "filePath": "api-reference.ui.runtime.tsx",
648
- "line": 32,
685
+ "line": 33,
649
686
  "character": 48
650
687
  },
651
688
  "type": {
652
689
  "__schema": "TypeRefSchema",
653
690
  "location": {
654
691
  "filePath": "api-reference.ui.runtime.tsx",
655
- "line": 32,
692
+ "line": 33,
656
693
  "character": 48
657
694
  },
658
695
  "name": "APINodeRenderer",
@@ -670,7 +707,7 @@
670
707
  "__schema": "ClassSchema",
671
708
  "location": {
672
709
  "filePath": "api-reference.ui.runtime.tsx",
673
- "line": 33,
710
+ "line": 34,
674
711
  "character": 1
675
712
  },
676
713
  "signature": "class APIReferenceUI",
@@ -680,26 +717,26 @@
680
717
  "__schema": "ConstructorSchema",
681
718
  "location": {
682
719
  "filePath": "api-reference.ui.runtime.tsx",
683
- "line": 34,
720
+ "line": 35,
684
721
  "character": 3
685
722
  },
686
- "signature": "constructor APIReferenceUI(host: string, apiNodeRendererSlot: APINodeRendererSlot, code: CodeUI): APIReferenceUI",
723
+ "signature": "constructor APIReferenceUI(host: string, apiNodeRendererSlot: APINodeRendererSlot, code: CodeUI, workspace: WorkspaceUI): APIReferenceUI",
687
724
  "name": "constructor",
688
725
  "params": [
689
726
  {
690
727
  "__schema": "ParameterSchema",
691
728
  "location": {
692
729
  "filePath": "api-reference.ui.runtime.tsx",
693
- "line": 34,
694
- "character": 15
730
+ "line": 36,
731
+ "character": 5
695
732
  },
696
733
  "name": "host",
697
734
  "type": {
698
735
  "__schema": "KeywordTypeSchema",
699
736
  "location": {
700
737
  "filePath": "api-reference.ui.runtime.tsx",
701
- "line": 34,
702
- "character": 29
738
+ "line": 36,
739
+ "character": 19
703
740
  },
704
741
  "name": "string"
705
742
  },
@@ -710,16 +747,16 @@
710
747
  "__schema": "ParameterSchema",
711
748
  "location": {
712
749
  "filePath": "api-reference.ui.runtime.tsx",
713
- "line": 34,
714
- "character": 37
750
+ "line": 37,
751
+ "character": 5
715
752
  },
716
753
  "name": "apiNodeRendererSlot",
717
754
  "type": {
718
755
  "__schema": "TypeRefSchema",
719
756
  "location": {
720
757
  "filePath": "api-reference.ui.runtime.tsx",
721
- "line": 34,
722
- "character": 66
758
+ "line": 37,
759
+ "character": 34
723
760
  },
724
761
  "name": "APINodeRendererSlot"
725
762
  },
@@ -730,16 +767,16 @@
730
767
  "__schema": "ParameterSchema",
731
768
  "location": {
732
769
  "filePath": "api-reference.ui.runtime.tsx",
733
- "line": 34,
734
- "character": 87
770
+ "line": 38,
771
+ "character": 5
735
772
  },
736
773
  "name": "code",
737
774
  "type": {
738
775
  "__schema": "TypeRefSchema",
739
776
  "location": {
740
777
  "filePath": "api-reference.ui.runtime.tsx",
741
- "line": 34,
742
- "character": 101
778
+ "line": 38,
779
+ "character": 19
743
780
  },
744
781
  "name": "CodeUI",
745
782
  "componentId": {
@@ -749,13 +786,37 @@
749
786
  },
750
787
  "isOptional": false,
751
788
  "isSpread": false
789
+ },
790
+ {
791
+ "__schema": "ParameterSchema",
792
+ "location": {
793
+ "filePath": "api-reference.ui.runtime.tsx",
794
+ "line": 39,
795
+ "character": 5
796
+ },
797
+ "name": "workspace",
798
+ "type": {
799
+ "__schema": "TypeRefSchema",
800
+ "location": {
801
+ "filePath": "api-reference.ui.runtime.tsx",
802
+ "line": 39,
803
+ "character": 24
804
+ },
805
+ "name": "WorkspaceUI",
806
+ "componentId": {
807
+ "scope": "teambit.workspace",
808
+ "name": "workspace"
809
+ }
810
+ },
811
+ "isOptional": false,
812
+ "isSpread": false
752
813
  }
753
814
  ],
754
815
  "returnType": {
755
816
  "__schema": "ThisTypeSchema",
756
817
  "location": {
757
818
  "filePath": "api-reference.ui.runtime.tsx",
758
- "line": 33,
819
+ "line": 34,
759
820
  "character": 1
760
821
  },
761
822
  "name": "APIReferenceUI"
@@ -766,7 +827,7 @@
766
827
  "__schema": "VariableLikeSchema",
767
828
  "location": {
768
829
  "filePath": "api-reference.ui.runtime.tsx",
769
- "line": 36,
830
+ "line": 42,
770
831
  "character": 3
771
832
  },
772
833
  "signature": "(property) APIReferenceUI.dependencies: Aspect[]",
@@ -775,19 +836,19 @@
775
836
  "__schema": "InferenceTypeSchema",
776
837
  "location": {
777
838
  "filePath": "api-reference.ui.runtime.tsx",
778
- "line": 36,
839
+ "line": 42,
779
840
  "character": 3
780
841
  },
781
842
  "type": "Aspect[]"
782
843
  },
783
844
  "isOptional": true,
784
- "defaultValue": "[ComponentAspect, CodeAspect]"
845
+ "defaultValue": "[ComponentAspect, CodeAspect, WorkspaceAspect]"
785
846
  },
786
847
  {
787
848
  "__schema": "VariableLikeSchema",
788
849
  "location": {
789
850
  "filePath": "api-reference.ui.runtime.tsx",
790
- "line": 37,
851
+ "line": 43,
791
852
  "character": 3
792
853
  },
793
854
  "signature": "(property) APIReferenceUI.runtime: RuntimeDefinition",
@@ -796,7 +857,7 @@
796
857
  "__schema": "InferenceTypeSchema",
797
858
  "location": {
798
859
  "filePath": "api-reference.ui.runtime.tsx",
799
- "line": 37,
860
+ "line": 43,
800
861
  "character": 3
801
862
  },
802
863
  "type": "RuntimeDefinition"
@@ -808,7 +869,7 @@
808
869
  "__schema": "VariableLikeSchema",
809
870
  "location": {
810
871
  "filePath": "api-reference.ui.runtime.tsx",
811
- "line": 38,
872
+ "line": 44,
812
873
  "character": 3
813
874
  },
814
875
  "signature": "(property) APIReferenceUI.slots: ((registerFn: () => string) => SlotRegistry<APINodeRenderer[]>)[]",
@@ -817,7 +878,7 @@
817
878
  "__schema": "InferenceTypeSchema",
818
879
  "location": {
819
880
  "filePath": "api-reference.ui.runtime.tsx",
820
- "line": 38,
881
+ "line": 44,
821
882
  "character": 3
822
883
  },
823
884
  "type": "((registerFn: () => string) => SlotRegistry<APINodeRenderer[]>)[]"
@@ -829,7 +890,7 @@
829
890
  "__schema": "ReactSchema",
830
891
  "location": {
831
892
  "filePath": "api-reference.ui.runtime.tsx",
832
- "line": 40,
893
+ "line": 46,
833
894
  "character": 3
834
895
  },
835
896
  "signature": "(method) APIReferenceUI.getAPIPage(): React.JSX.Element",
@@ -838,7 +899,7 @@
838
899
  "__schema": "TypeRefSchema",
839
900
  "location": {
840
901
  "filePath": "api-reference.ui.runtime.tsx",
841
- "line": 40,
902
+ "line": 46,
842
903
  "character": 3
843
904
  },
844
905
  "name": "React.JSX.Element",
@@ -850,7 +911,7 @@
850
911
  "__schema": "VariableLikeSchema",
851
912
  "location": {
852
913
  "filePath": "api-reference.ui.runtime.tsx",
853
- "line": 49,
914
+ "line": 55,
854
915
  "character": 3
855
916
  },
856
917
  "signature": "(property) APIReferenceUI.TaggedAPIPage: ({ componentId }: {\n componentId: string;\n}) => React.JSX.Element",
@@ -859,19 +920,19 @@
859
920
  "__schema": "InferenceTypeSchema",
860
921
  "location": {
861
922
  "filePath": "api-reference.ui.runtime.tsx",
862
- "line": 49,
923
+ "line": 55,
863
924
  "character": 3
864
925
  },
865
926
  "type": "({ componentId }: {\n componentId: string;\n}) => React.JSX.Element"
866
927
  },
867
928
  "isOptional": true,
868
- "defaultValue": "({ componentId }: { componentId: string }) => {\n return (\n <APIRefRenderersProvider nodeRenderers={flatten(this.apiNodeRendererSlot.values())}>\n <TaggedExports componentId={componentId} />\n </APIRefRenderersProvider>\n );\n }"
929
+ "defaultValue": "({ componentId }: { componentId: string }) => {\n return (\n <APIRefRenderersProvider nodeRenderers={flatten(this.apiNodeRendererSlot.values())}>\n <TaggedExports componentId={componentId} showBanner={Boolean(this.workspace)} />\n </APIRefRenderersProvider>\n );\n }"
869
930
  },
870
931
  {
871
932
  "__schema": "FunctionLikeSchema",
872
933
  "location": {
873
934
  "filePath": "api-reference.ui.runtime.tsx",
874
- "line": 57,
935
+ "line": 63,
875
936
  "character": 3
876
937
  },
877
938
  "signature": "(method) APIReferenceUI.registerSchemaClass(schema: SchemaNodeConstructor): void",
@@ -881,7 +942,7 @@
881
942
  "__schema": "ParameterSchema",
882
943
  "location": {
883
944
  "filePath": "api-reference.ui.runtime.tsx",
884
- "line": 57,
945
+ "line": 63,
885
946
  "character": 23
886
947
  },
887
948
  "name": "schema",
@@ -889,7 +950,7 @@
889
950
  "__schema": "TypeRefSchema",
890
951
  "location": {
891
952
  "filePath": "api-reference.ui.runtime.tsx",
892
- "line": 57,
953
+ "line": 63,
893
954
  "character": 31
894
955
  },
895
956
  "name": "SchemaNodeConstructor",
@@ -907,7 +968,7 @@
907
968
  "__schema": "InferenceTypeSchema",
908
969
  "location": {
909
970
  "filePath": "api-reference.ui.runtime.tsx",
910
- "line": 57,
971
+ "line": 63,
911
972
  "character": 3
912
973
  },
913
974
  "type": "void"
@@ -918,7 +979,7 @@
918
979
  "__schema": "FunctionLikeSchema",
919
980
  "location": {
920
981
  "filePath": "api-reference.ui.runtime.tsx",
921
- "line": 61,
982
+ "line": 67,
922
983
  "character": 3
923
984
  },
924
985
  "signature": "(method) APIReferenceUI.getSchemaClasses(): () => Record<string, SchemaNodeConstructor>",
@@ -928,7 +989,7 @@
928
989
  "__schema": "InferenceTypeSchema",
929
990
  "location": {
930
991
  "filePath": "api-reference.ui.runtime.tsx",
931
- "line": 61,
992
+ "line": 67,
932
993
  "character": 3
933
994
  },
934
995
  "type": "() => Record<string, SchemaNodeConstructor>"
@@ -939,7 +1000,7 @@
939
1000
  "__schema": "FunctionLikeSchema",
940
1001
  "location": {
941
1002
  "filePath": "api-reference.ui.runtime.tsx",
942
- "line": 65,
1003
+ "line": 71,
943
1004
  "character": 3
944
1005
  },
945
1006
  "signature": "(method) APIReferenceUI.registerAPINodeRenderer(apiNodeRenderers: APINodeRenderer[]): void",
@@ -949,7 +1010,7 @@
949
1010
  "__schema": "ParameterSchema",
950
1011
  "location": {
951
1012
  "filePath": "api-reference.ui.runtime.tsx",
952
- "line": 65,
1013
+ "line": 71,
953
1014
  "character": 27
954
1015
  },
955
1016
  "name": "apiNodeRenderers",
@@ -957,14 +1018,14 @@
957
1018
  "__schema": "TypeArraySchema",
958
1019
  "location": {
959
1020
  "filePath": "api-reference.ui.runtime.tsx",
960
- "line": 65,
1021
+ "line": 71,
961
1022
  "character": 45
962
1023
  },
963
1024
  "type": {
964
1025
  "__schema": "TypeRefSchema",
965
1026
  "location": {
966
1027
  "filePath": "api-reference.ui.runtime.tsx",
967
- "line": 65,
1028
+ "line": 71,
968
1029
  "character": 45
969
1030
  },
970
1031
  "name": "APINodeRenderer",
@@ -983,7 +1044,7 @@
983
1044
  "__schema": "InferenceTypeSchema",
984
1045
  "location": {
985
1046
  "filePath": "api-reference.ui.runtime.tsx",
986
- "line": 65,
1047
+ "line": 71,
987
1048
  "character": 3
988
1049
  },
989
1050
  "type": "void"
@@ -994,7 +1055,7 @@
994
1055
  "__schema": "VariableLikeSchema",
995
1056
  "location": {
996
1057
  "filePath": "api-reference.ui.runtime.tsx",
997
- "line": 69,
1058
+ "line": 75,
998
1059
  "character": 3
999
1060
  },
1000
1061
  "signature": "(property) APIReferenceUI.apiNodeRenderers: APINodeRenderer[]",
@@ -1003,14 +1064,14 @@
1003
1064
  "__schema": "TypeArraySchema",
1004
1065
  "location": {
1005
1066
  "filePath": "api-reference.ui.runtime.tsx",
1006
- "line": 69,
1067
+ "line": 75,
1007
1068
  "character": 21
1008
1069
  },
1009
1070
  "type": {
1010
1071
  "__schema": "TypeRefSchema",
1011
1072
  "location": {
1012
1073
  "filePath": "api-reference.ui.runtime.tsx",
1013
- "line": 69,
1074
+ "line": 75,
1014
1075
  "character": 21
1015
1076
  },
1016
1077
  "name": "APINodeRenderer",
@@ -1028,34 +1089,34 @@
1028
1089
  "__schema": "FunctionLikeSchema",
1029
1090
  "location": {
1030
1091
  "filePath": "api-reference.ui.runtime.tsx",
1031
- "line": 88,
1092
+ "line": 94,
1032
1093
  "character": 3
1033
1094
  },
1034
- "signature": "(method) APIReferenceUI.provider([componentUI, codeUI]: [ComponentUI, CodeUI], _: any, [apiNodeRendererSlot]: [APINodeRendererSlot], harmony: Harmony): Promise<APIReferenceUI>",
1095
+ "signature": "(method) APIReferenceUI.provider([componentUI, codeUI, workspaceUI]: [ComponentUI, CodeUI, WorkspaceUI], _: any, [apiNodeRendererSlot]: [APINodeRendererSlot], harmony: Harmony): Promise<APIReferenceUI>",
1035
1096
  "name": "provider",
1036
1097
  "params": [
1037
1098
  {
1038
1099
  "__schema": "ParameterSchema",
1039
1100
  "location": {
1040
1101
  "filePath": "api-reference.ui.runtime.tsx",
1041
- "line": 89,
1102
+ "line": 95,
1042
1103
  "character": 5
1043
1104
  },
1044
- "name": "[ componentUI, codeUI ]",
1105
+ "name": "[ componentUI, codeUI, workspaceUI ]",
1045
1106
  "type": {
1046
1107
  "__schema": "TupleTypeSchema",
1047
1108
  "location": {
1048
1109
  "filePath": "api-reference.ui.runtime.tsx",
1049
- "line": 89,
1050
- "character": 28
1110
+ "line": 95,
1111
+ "character": 41
1051
1112
  },
1052
1113
  "elements": [
1053
1114
  {
1054
1115
  "__schema": "TypeRefSchema",
1055
1116
  "location": {
1056
1117
  "filePath": "api-reference.ui.runtime.tsx",
1057
- "line": 89,
1058
- "character": 29
1118
+ "line": 95,
1119
+ "character": 42
1059
1120
  },
1060
1121
  "name": "ComponentUI",
1061
1122
  "componentId": {
@@ -1067,14 +1128,27 @@
1067
1128
  "__schema": "TypeRefSchema",
1068
1129
  "location": {
1069
1130
  "filePath": "api-reference.ui.runtime.tsx",
1070
- "line": 89,
1071
- "character": 42
1131
+ "line": 95,
1132
+ "character": 55
1072
1133
  },
1073
1134
  "name": "CodeUI",
1074
1135
  "componentId": {
1075
1136
  "scope": "teambit.component",
1076
1137
  "name": "code"
1077
1138
  }
1139
+ },
1140
+ {
1141
+ "__schema": "TypeRefSchema",
1142
+ "location": {
1143
+ "filePath": "api-reference.ui.runtime.tsx",
1144
+ "line": 95,
1145
+ "character": 63
1146
+ },
1147
+ "name": "WorkspaceUI",
1148
+ "componentId": {
1149
+ "scope": "teambit.workspace",
1150
+ "name": "workspace"
1151
+ }
1078
1152
  }
1079
1153
  ]
1080
1154
  },
@@ -1085,7 +1159,7 @@
1085
1159
  "__schema": "ParameterSchema",
1086
1160
  "location": {
1087
1161
  "filePath": "api-reference.ui.runtime.tsx",
1088
- "line": 90,
1162
+ "line": 96,
1089
1163
  "character": 5
1090
1164
  },
1091
1165
  "name": "_",
@@ -1093,7 +1167,7 @@
1093
1167
  "__schema": "InferenceTypeSchema",
1094
1168
  "location": {
1095
1169
  "filePath": "api-reference.ui.runtime.tsx",
1096
- "line": 90,
1170
+ "line": 96,
1097
1171
  "character": 5
1098
1172
  },
1099
1173
  "type": "any"
@@ -1105,7 +1179,7 @@
1105
1179
  "__schema": "ParameterSchema",
1106
1180
  "location": {
1107
1181
  "filePath": "api-reference.ui.runtime.tsx",
1108
- "line": 91,
1182
+ "line": 97,
1109
1183
  "character": 5
1110
1184
  },
1111
1185
  "name": "[ apiNodeRendererSlot ]",
@@ -1113,7 +1187,7 @@
1113
1187
  "__schema": "TupleTypeSchema",
1114
1188
  "location": {
1115
1189
  "filePath": "api-reference.ui.runtime.tsx",
1116
- "line": 91,
1190
+ "line": 97,
1117
1191
  "character": 28
1118
1192
  },
1119
1193
  "elements": [
@@ -1121,7 +1195,7 @@
1121
1195
  "__schema": "TypeRefSchema",
1122
1196
  "location": {
1123
1197
  "filePath": "api-reference.ui.runtime.tsx",
1124
- "line": 91,
1198
+ "line": 97,
1125
1199
  "character": 29
1126
1200
  },
1127
1201
  "name": "APINodeRendererSlot"
@@ -1135,7 +1209,7 @@
1135
1209
  "__schema": "ParameterSchema",
1136
1210
  "location": {
1137
1211
  "filePath": "api-reference.ui.runtime.tsx",
1138
- "line": 92,
1212
+ "line": 98,
1139
1213
  "character": 5
1140
1214
  },
1141
1215
  "name": "harmony",
@@ -1143,7 +1217,7 @@
1143
1217
  "__schema": "TypeRefSchema",
1144
1218
  "location": {
1145
1219
  "filePath": "api-reference.ui.runtime.tsx",
1146
- "line": 92,
1220
+ "line": 98,
1147
1221
  "character": 14
1148
1222
  },
1149
1223
  "name": "Harmony",
@@ -1161,7 +1235,7 @@
1161
1235
  "__schema": "InferenceTypeSchema",
1162
1236
  "location": {
1163
1237
  "filePath": "api-reference.ui.runtime.tsx",
1164
- "line": 88,
1238
+ "line": 94,
1165
1239
  "character": 3
1166
1240
  },
1167
1241
  "type": "Promise<APIReferenceUI>"
@@ -1179,7 +1253,7 @@
1179
1253
  "__schema": "UnImplementedSchema",
1180
1254
  "location": {
1181
1255
  "filePath": "api-reference.ui.runtime.tsx",
1182
- "line": 109,
1256
+ "line": 115,
1183
1257
  "character": 16
1184
1258
  },
1185
1259
  "name": "APIReferenceUI",
@@ -1191,7 +1265,7 @@
1191
1265
  "__schema": "UnImplementedSchema",
1192
1266
  "location": {
1193
1267
  "filePath": "api-reference.ui.runtime.tsx",
1194
- "line": 111,
1268
+ "line": 117,
1195
1269
  "character": 1
1196
1270
  },
1197
1271
  "name": "APIReferenceAspect.addRuntime(APIReferenceUI);",
@@ -1250,7 +1324,7 @@
1250
1324
  "componentId": {
1251
1325
  "scope": "teambit.api-reference",
1252
1326
  "name": "api-reference",
1253
- "version": "1.0.252"
1327
+ "version": "1.0.254"
1254
1328
  },
1255
1329
  "taggedModuleExports": []
1256
1330
  }
package/dist/api-reference.ui.runtime.d.ts CHANGED
@@ -3,12 +3,14 @@ import { Harmony, SlotRegistry } from '@teambit/harmony';
3
3
  import { APINodeRenderer } from '@teambit/api-reference.models.api-node-renderer';
4
4
  import { SchemaNodeConstructor, SchemaRegistry } from '@teambit/semantics.entities.semantic-schema';
5
5
  import { CodeUI } from '@teambit/code';
6
+ import { WorkspaceUI } from '@teambit/workspace';
6
7
  export type APINodeRendererSlot = SlotRegistry<APINodeRenderer[]>;
7
8
  export declare class APIReferenceUI {
8
9
  private host;
9
10
  private apiNodeRendererSlot;
10
11
  private code;
11
- constructor(host: string, apiNodeRendererSlot: APINodeRendererSlot, code: CodeUI);
12
+ private workspace;
13
+ constructor(host: string, apiNodeRendererSlot: APINodeRendererSlot, code: CodeUI, workspace: WorkspaceUI);
12
14
  static dependencies: import("@teambit/harmony").Aspect[];
13
15
  static runtime: import("@teambit/harmony").RuntimeDefinition;
14
16
  static slots: ((registerFn: () => string) => SlotRegistry<APINodeRenderer[]>)[];
@@ -20,6 +22,6 @@ export declare class APIReferenceUI {
20
22
  getSchemaClasses(): typeof SchemaRegistry.schemas;
21
23
  registerAPINodeRenderer(apiNodeRenderers: APINodeRenderer[]): void;
22
24
  apiNodeRenderers: APINodeRenderer[];
23
- static provider([componentUI, codeUI]: [ComponentUI, CodeUI], _: any, [apiNodeRendererSlot]: [APINodeRendererSlot], harmony: Harmony): Promise<APIReferenceUI>;
25
+ static provider([componentUI, codeUI, workspaceUI]: [ComponentUI, CodeUI, WorkspaceUI], _: any, [apiNodeRendererSlot]: [APINodeRendererSlot], harmony: Harmony): Promise<APIReferenceUI>;
24
26
  }
25
27
  export default APIReferenceUI;
package/dist/api-reference.ui.runtime.js CHANGED
@@ -193,6 +193,13 @@ function _taggedExports() {
193
193
  };
194
194
  return data;
195
195
  }
196
+ function _workspace() {
197
+ const data = require("@teambit/workspace");
198
+ _workspace = function () {
199
+ return data;
200
+ };
201
+ return data;
202
+ }
196
203
  function _apiReference() {
197
204
  const data = require("./api-reference.aspect");
198
205
  _apiReference = function () {
@@ -205,17 +212,19 @@ function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key i
205
212
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
206
213
  function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
207
214
  class APIReferenceUI {
208
- constructor(host, apiNodeRendererSlot, code) {
215
+ constructor(host, apiNodeRendererSlot, code, workspace) {
209
216
  this.host = host;
210
217
  this.apiNodeRendererSlot = apiNodeRendererSlot;
211
218
  this.code = code;
219
+ this.workspace = workspace;
212
220
  _defineProperty(this, "TaggedAPIPage", ({
213
221
  componentId
214
222
  }) => {
215
223
  return /*#__PURE__*/_react().default.createElement(_apiReferenceHooks().APIRefRenderersProvider, {
216
224
  nodeRenderers: (0, _lodash().flatten)(this.apiNodeRendererSlot.values())
217
225
  }, /*#__PURE__*/_react().default.createElement(_taggedExports().TaggedExports, {
218
- componentId: componentId
226
+ componentId: componentId,
227
+ showBanner: Boolean(this.workspace)
219
228
  }));
220
229
  });
221
230
  _defineProperty(this, "apiNodeRenderers", [_apiReferenceRenderers().classRenderer, _apiReferenceRenderers3().typeRenderer, _apiReferenceRenderers2().interfaceRenderer, _apiReferenceRenderers6().variableRenderer, _apiReferenceRenderers4().functionRenderer, _apiReferenceRenderers5().enumRenderer, _apiReferenceRenderers7().unresolvedRenderer, _apiReferenceRenderers8().typeRefRenderer, _apiReferenceRenderers10().typeIntersectionRenderer, _apiReferenceRenderers9().typeUnionRenderer, _apiReferenceRenderers12().parameterRenderer, _apiReferenceRenderers11().typeLiteralRenderer, _apiReferenceRenderers13().inferenceTypeRenderer, _apiReferenceRenderers14().typeArrayRenderer, _apiReferenceRenderers15().thisRenderer, _apiReferenceRenderers16().decoratorRenderer]);
@@ -236,12 +245,12 @@ class APIReferenceUI {
236
245
  registerAPINodeRenderer(apiNodeRenderers) {
237
246
  this.apiNodeRendererSlot.register(apiNodeRenderers);
238
247
  }
239
- static async provider([componentUI, codeUI], _, [apiNodeRendererSlot], harmony) {
248
+ static async provider([componentUI, codeUI, workspaceUI], _, [apiNodeRendererSlot], harmony) {
240
249
  const {
241
250
  config
242
251
  } = harmony;
243
252
  const host = String(config.get('teambit.harmony/bit'));
244
- const apiReferenceUI = new APIReferenceUI(host, apiNodeRendererSlot, codeUI);
253
+ const apiReferenceUI = new APIReferenceUI(host, apiNodeRendererSlot, codeUI, workspaceUI);
245
254
  apiReferenceUI.registerAPINodeRenderer(apiReferenceUI.apiNodeRenderers);
246
255
  const apiReferenceSection = new (_apiReferenceSections2().APIRefSection)(apiReferenceUI);
247
256
  componentUI.registerNavigation(apiReferenceSection.navigationLink, apiReferenceSection.order);
@@ -254,7 +263,7 @@ class APIReferenceUI {
254
263
  }
255
264
  }
256
265
  exports.APIReferenceUI = APIReferenceUI;
257
- _defineProperty(APIReferenceUI, "dependencies", [_component().ComponentAspect, _code().CodeAspect]);
266
+ _defineProperty(APIReferenceUI, "dependencies", [_component().ComponentAspect, _code().CodeAspect, _workspace().WorkspaceAspect]);
258
267
  _defineProperty(APIReferenceUI, "runtime", _ui().UIRuntime);
259
268
  _defineProperty(APIReferenceUI, "slots", [_harmony().Slot.withType()]);
260
269
  var _default = exports.default = APIReferenceUI;
package/dist/api-reference.ui.runtime.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"names":["_react","data","_interopRequireDefault","require","_lodash","_component","_ui","_apiReferenceSections","_apiReferenceSections2","_harmony","_apiReferenceRenderers","_apiReferenceRenderers2","_apiReferenceRenderers3","_apiReferenceRenderers4","_apiReferenceRenderers5","_apiReferenceRenderers6","_apiReferenceRenderers7","_apiReferenceRenderers8","_apiReferenceRenderers9","_apiReferenceRenderers10","_apiReferenceRenderers11","_apiReferenceRenderers12","_apiReferenceRenderers13","_apiReferenceRenderers14","_apiReferenceRenderers15","_apiReferenceHooks","_apiReferenceRenderers16","_semanticsEntities","_code","_taggedExports","_apiReference","obj","__esModule","default","_defineProperty","key","value","_toPropertyKey","Object","defineProperty","enumerable","configurable","writable","t","i","_toPrimitive","r","e","Symbol","toPrimitive","call","TypeError","String","Number","APIReferenceUI","constructor","host","apiNodeRendererSlot","code","componentId","createElement","APIRefRenderersProvider","nodeRenderers","flatten","values","TaggedExports","classRenderer","typeRenderer","interfaceRenderer","variableRenderer","functionRenderer","enumRenderer","unresolvedRenderer","typeRefRenderer","typeIntersectionRenderer","typeUnionRenderer","parameterRenderer","typeLiteralRenderer","inferenceTypeRenderer","typeArrayRenderer","thisRenderer","decoratorRenderer","getAPIPage","EditorProvider","getCodeEditorProvider","APIRefPage","rendererSlot","registerSchemaClass","schema","SchemaRegistry","register","getSchemaClasses","schemas","registerAPINodeRenderer","apiNodeRenderers","provider","componentUI","codeUI","_","harmony","config","get","apiReferenceUI","apiReferenceSection","APIRefSection","registerNavigation","navigationLink","order","registerRoute","route","Schemas","forEach","Schema","exports","ComponentAspect","CodeAspect","UIRuntime","Slot","withType","_default","APIReferenceAspect","addRuntime"],"sources":["api-reference.ui.runtime.tsx"],"sourcesContent":["import React from 'react';\nimport { flatten } from 'lodash';\nimport { ComponentAspect, ComponentUI } from '@teambit/component';\nimport { UIRuntime } from '@teambit/ui';\nimport { APIRefPage } from '@teambit/api-reference.sections.api-reference-page';\nimport { APIRefSection } from '@teambit/api-reference.sections.api-reference-section';\nimport { Harmony, Slot, SlotRegistry } from '@teambit/harmony';\nimport { APINodeRenderer } from '@teambit/api-reference.models.api-node-renderer';\nimport { classRenderer } from '@teambit/api-reference.renderers.class';\nimport { interfaceRenderer } from '@teambit/api-reference.renderers.interface';\nimport { typeRenderer } from '@teambit/api-reference.renderers.type';\nimport { functionRenderer } from '@teambit/api-reference.renderers.function';\nimport { enumRenderer } from '@teambit/api-reference.renderers.enum';\nimport { variableRenderer } from '@teambit/api-reference.renderers.variable';\nimport { unresolvedRenderer } from '@teambit/api-reference.renderers.unresolved';\nimport { typeRefRenderer } from '@teambit/api-reference.renderers.type-ref';\nimport { typeUnionRenderer } from '@teambit/api-reference.renderers.type-union';\nimport { typeIntersectionRenderer } from '@teambit/api-reference.renderers.type-intersection';\nimport { typeLiteralRenderer } from '@teambit/api-reference.renderers.type-literal';\nimport { parameterRenderer } from '@teambit/api-reference.renderers.parameter';\nimport { inferenceTypeRenderer } from '@teambit/api-reference.renderers.inference-type';\nimport { typeArrayRenderer } from '@teambit/api-reference.renderers.type-array';\nimport { thisRenderer } from '@teambit/api-reference.renderers.this';\nimport { APIRefRenderersProvider } from '@teambit/api-reference.hooks.use-api-renderers';\nimport { decoratorRenderer } from '@teambit/api-reference.renderers.decorator';\nimport { SchemaNodeConstructor, SchemaRegistry, Schemas } from '@teambit/semantics.entities.semantic-schema';\nimport { CodeAspect, CodeUI } from '@teambit/code';\nimport { TaggedExports } from '@teambit/tagged-exports';\n\nimport { APIReferenceAspect } from './api-reference.aspect';\n\nexport type APINodeRendererSlot = SlotRegistry<APINodeRenderer[]>;\nexport class APIReferenceUI {\n constructor(private host: string, private apiNodeRendererSlot: APINodeRendererSlot, private code: CodeUI) {}\n\n static dependencies = [ComponentAspect, CodeAspect];\n static runtime = UIRuntime;\n static slots = [Slot.withType<APINodeRenderer[]>()];\n\n getAPIPage() {\n const EditorProvider = this.code.getCodeEditorProvider();\n return (\n <EditorProvider>\n <APIRefPage host={this.host} rendererSlot={this.apiNodeRendererSlot} />\n </EditorProvider>\n );\n }\n\n TaggedAPIPage = ({ componentId }: { componentId: string }) => {\n return (\n <APIRefRenderersProvider nodeRenderers={flatten(this.apiNodeRendererSlot.values())}>\n <TaggedExports componentId={componentId} />\n </APIRefRenderersProvider>\n );\n };\n\n registerSchemaClass(schema: SchemaNodeConstructor) {\n SchemaRegistry.register(schema);\n }\n\n getSchemaClasses() {\n return SchemaRegistry.schemas;\n }\n\n registerAPINodeRenderer(apiNodeRenderers: APINodeRenderer[]) {\n this.apiNodeRendererSlot.register(apiNodeRenderers);\n }\n\n apiNodeRenderers: APINodeRenderer[] = [\n classRenderer,\n typeRenderer,\n interfaceRenderer,\n variableRenderer,\n functionRenderer,\n enumRenderer,\n unresolvedRenderer,\n typeRefRenderer,\n typeIntersectionRenderer,\n typeUnionRenderer,\n parameterRenderer,\n typeLiteralRenderer,\n inferenceTypeRenderer,\n typeArrayRenderer,\n thisRenderer,\n decoratorRenderer,\n ];\n\n static async provider(\n [componentUI, codeUI]: [ComponentUI, CodeUI],\n _,\n [apiNodeRendererSlot]: [APINodeRendererSlot],\n harmony: Harmony\n ) {\n const { config } = harmony;\n const host = String(config.get('teambit.harmony/bit'));\n const apiReferenceUI = new APIReferenceUI(host, apiNodeRendererSlot, codeUI);\n apiReferenceUI.registerAPINodeRenderer(apiReferenceUI.apiNodeRenderers);\n const apiReferenceSection = new APIRefSection(apiReferenceUI);\n componentUI.registerNavigation(apiReferenceSection.navigationLink, apiReferenceSection.order);\n componentUI.registerRoute(apiReferenceSection.route);\n // register all default schema classes\n Object.values(Schemas).forEach((Schema) => {\n apiReferenceUI.registerSchemaClass(Schema);\n });\n return apiReferenceUI;\n }\n}\n\nexport default APIReferenceUI;\n\nAPIReferenceAspect.addRuntime(APIReferenceUI);\n"],"mappings":";;;;;;AAAA,SAAAA,OAAA;EAAA,MAAAC,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAH,MAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAG,QAAA;EAAA,MAAAH,IAAA,GAAAE,OAAA;EAAAC,OAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAI,WAAA;EAAA,MAAAJ,IAAA,GAAAE,OAAA;EAAAE,UAAA,YAAAA,CAAA;IAAA,OAAAJ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAK,IAAA;EAAA,MAAAL,IAAA,GAAAE,OAAA;EAAAG,GAAA,YAAAA,CAAA;IAAA,OAAAL,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAM,sBAAA;EAAA,MAAAN,IAAA,GAAAE,OAAA;EAAAI,qBAAA,YAAAA,CAAA;IAAA,OAAAN,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAO,uBAAA;EAAA,MAAAP,IAAA,GAAAE,OAAA;EAAAK,sBAAA,YAAAA,CAAA;IAAA,OAAAP,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAQ,SAAA;EAAA,MAAAR,IAAA,GAAAE,OAAA;EAAAM,QAAA,YAAAA,CAAA;IAAA,OAAAR,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAS,uBAAA;EAAA,MAAAT,IAAA,GAAAE,OAAA;EAAAO,sBAAA,YAAAA,CAAA;IAAA,OAAAT,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAU,wBAAA;EAAA,MAAAV,IAAA,GAAAE,OAAA;EAAAQ,uBAAA,YAAAA,CAAA;IAAA,OAAAV,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAW,wBAAA;EAAA,MAAAX,IAAA,GAAAE,OAAA;EAAAS,uBAAA,YAAAA,CAAA;IAAA,OAAAX,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAY,wBAAA;EAAA,MAAAZ,IAAA,GAAAE,OAAA;EAAAU,uBAAA,YAAAA,CAAA;IAAA,OAAAZ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAa,wBAAA;EAAA,MAAAb,IAAA,GAAAE,OAAA;EAAAW,uBAAA,YAAAA,CAAA;IAAA,OAAAb,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAc,wBAAA;EAAA,MAAAd,IAAA,GAAAE,OAAA;EAAAY,uBAAA,YAAAA,CAAA;IAAA,OAAAd,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAe,wBAAA;EAAA,MAAAf,IAAA,GAAAE,OAAA;EAAAa,uBAAA,YAAAA,CAAA;IAAA,OAAAf,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAgB,wBAAA;EAAA,MAAAhB,IAAA,GAAAE,OAAA;EAAAc,uBAAA,YAAAA,CAAA;IAAA,OAAAhB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAiB,wBAAA;EAAA,MAAAjB,IAAA,GAAAE,OAAA;EAAAe,uBAAA,YAAAA,CAAA;IAAA,OAAAjB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAkB,yBAAA;EAAA,MAAAlB,IAAA,GAAAE,OAAA;EAAAgB,wBAAA,YAAAA,CAAA;IAAA,OAAAlB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAmB,yBAAA;EAAA,MAAAnB,IAAA,GAAAE,OAAA;EAAAiB,wBAAA,YAAAA,CAAA;IAAA,OAAAnB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAoB,yBAAA;EAAA,MAAApB,IAAA,GAAAE,OAAA;EAAAkB,wBAAA,YAAAA,CAAA;IAAA,OAAApB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAqB,yBAAA;EAAA,MAAArB,IAAA,GAAAE,OAAA;EAAAmB,wBAAA,YAAAA,CAAA;IAAA,OAAArB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAsB,yBAAA;EAAA,MAAAtB,IAAA,GAAAE,OAAA;EAAAoB,wBAAA,YAAAA,CAAA;IAAA,OAAAtB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAuB,yBAAA;EAAA,MAAAvB,IAAA,GAAAE,OAAA;EAAAqB,wBAAA,YAAAA,CAAA;IAAA,OAAAvB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAwB,mBAAA;EAAA,MAAAxB,IAAA,GAAAE,OAAA;EAAAsB,kBAAA,YAAAA,CAAA;IAAA,OAAAxB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAyB,yBAAA;EAAA,MAAAzB,IAAA,GAAAE,OAAA;EAAAuB,wBAAA,YAAAA,CAAA;IAAA,OAAAzB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAA0B,mBAAA;EAAA,MAAA1B,IAAA,GAAAE,OAAA;EAAAwB,kBAAA,YAAAA,CAAA;IAAA,OAAA1B,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAA2B,MAAA;EAAA,MAAA3B,IAAA,GAAAE,OAAA;EAAAyB,KAAA,YAAAA,CAAA;IAAA,OAAA3B,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAA4B,eAAA;EAAA,MAAA5B,IAAA,GAAAE,OAAA;EAAA0B,cAAA,YAAAA,CAAA;IAAA,OAAA5B,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAA6B,cAAA;EAAA,MAAA7B,IAAA,GAAAE,OAAA;EAAA2B,aAAA,YAAAA,CAAA;IAAA,OAAA7B,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAA4D,SAAAC,uBAAA6B,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,KAAAE,OAAA,EAAAF,GAAA;AAAA,SAAAG,gBAAAH,GAAA,EAAAI,GAAA,EAAAC,KAAA,IAAAD,GAAA,GAAAE,cAAA,CAAAF,GAAA,OAAAA,GAAA,IAAAJ,GAAA,IAAAO,MAAA,CAAAC,cAAA,CAAAR,GAAA,EAAAI,GAAA,IAAAC,KAAA,EAAAA,KAAA,EAAAI,UAAA,QAAAC,YAAA,QAAAC,QAAA,oBAAAX,GAAA,CAAAI,GAAA,IAAAC,KAAA,WAAAL,GAAA;AAAA,SAAAM,eAAAM,CAAA,QAAAC,CAAA,GAAAC,YAAA,CAAAF,CAAA,uCAAAC,CAAA,GAAAA,CAAA,GAAAA,CAAA;AAAA,SAAAC,aAAAF,CAAA,EAAAG,CAAA,2BAAAH,CAAA,KAAAA,CAAA,SAAAA,CAAA,MAAAI,CAAA,GAAAJ,CAAA,CAAAK,MAAA,CAAAC,WAAA,kBAAAF,CAAA,QAAAH,CAAA,GAAAG,CAAA,CAAAG,IAAA,CAAAP,CAAA,EAAAG,CAAA,uCAAAF,CAAA,SAAAA,CAAA,YAAAO,SAAA,yEAAAL,CAAA,GAAAM,MAAA,GAAAC,MAAA,EAAAV,CAAA;AAGrD,MAAMW,cAAc,CAAC;EAC1BC,WAAWA,CAASC,IAAY,EAAUC,mBAAwC,EAAUC,IAAY,EAAE;IAAA,KAAtFF,IAAY,GAAZA,IAAY;IAAA,KAAUC,mBAAwC,GAAxCA,mBAAwC;IAAA,KAAUC,IAAY,GAAZA,IAAY;IAAAxB,eAAA,wBAexF,CAAC;MAAEyB;IAAqC,CAAC,KAAK;MAC5D,oBACE3D,MAAA,GAAAiC,OAAA,CAAA2B,aAAA,CAACnC,kBAAA,GAAAoC,uBAAuB;QAACC,aAAa,EAAE,IAAAC,iBAAO,EAAC,IAAI,CAACN,mBAAmB,CAACO,MAAM,CAAC,CAAC;MAAE,gBACjFhE,MAAA,GAAAiC,OAAA,CAAA2B,aAAA,CAAC/B,cAAA,GAAAoC,aAAa;QAACN,WAAW,EAAEA;MAAY,CAAE,CACnB,CAAC;IAE9B,CAAC;IAAAzB,eAAA,2BAcqC,CACpCgC,sCAAa,EACbC,sCAAY,EACZC,2CAAiB,EACjBC,0CAAgB,EAChBC,0CAAgB,EAChBC,sCAAY,EACZC,4CAAkB,EAClBC,yCAAe,EACfC,mDAAwB,EACxBC,2CAAiB,EACjBC,4CAAiB,EACjBC,8CAAmB,EACnBC,gDAAqB,EACrBC,4CAAiB,EACjBC,uCAAY,EACZC,4CAAiB,CAClB;EApD0G;EAM3GC,UAAUA,CAAA,EAAG;IACX,MAAMC,cAAc,GAAG,IAAI,CAACzB,IAAI,CAAC0B,qBAAqB,CAAC,CAAC;IACxD,oBACEpF,MAAA,GAAAiC,OAAA,CAAA2B,aAAA,CAACuB,cAAc,qBACbnF,MAAA,GAAAiC,OAAA,CAAA2B,aAAA,CAACrD,qBAAA,GAAA8E,UAAU;MAAC7B,IAAI,EAAE,IAAI,CAACA,IAAK;MAAC8B,YAAY,EAAE,IAAI,CAAC7B;IAAoB,CAAE,CACxD,CAAC;EAErB;EAUA8B,mBAAmBA,CAACC,MAA6B,EAAE;IACjDC,mCAAc,CAACC,QAAQ,CAACF,MAAM,CAAC;EACjC;EAEAG,gBAAgBA,CAAA,EAAG;IACjB,OAAOF,mCAAc,CAACG,OAAO;EAC/B;EAEAC,uBAAuBA,CAACC,gBAAmC,EAAE;IAC3D,IAAI,CAACrC,mBAAmB,CAACiC,QAAQ,CAACI,gBAAgB,CAAC;EACrD;EAqBA,aAAaC,QAAQA,CACnB,CAACC,WAAW,EAAEC,MAAM,CAAwB,EAC5CC,CAAC,EACD,CAACzC,mBAAmB,CAAwB,EAC5C0C,OAAgB,EAChB;IACA,MAAM;MAAEC;IAAO,CAAC,GAAGD,OAAO;IAC1B,MAAM3C,IAAI,GAAGJ,MAAM,CAACgD,MAAM,CAACC,GAAG,CAAC,qBAAqB,CAAC,CAAC;IACtD,MAAMC,cAAc,GAAG,IAAIhD,cAAc,CAACE,IAAI,EAAEC,mBAAmB,EAAEwC,MAAM,CAAC;IAC5EK,cAAc,CAACT,uBAAuB,CAACS,cAAc,CAACR,gBAAgB,CAAC;IACvE,MAAMS,mBAAmB,GAAG,KAAIC,sCAAa,EAACF,cAAc,CAAC;IAC7DN,WAAW,CAACS,kBAAkB,CAACF,mBAAmB,CAACG,cAAc,EAAEH,mBAAmB,CAACI,KAAK,CAAC;IAC7FX,WAAW,CAACY,aAAa,CAACL,mBAAmB,CAACM,KAAK,CAAC;IACpD;IACAvE,MAAM,CAAC0B,MAAM,CAAC8C,4BAAO,CAAC,CAACC,OAAO,CAAEC,MAAM,IAAK;MACzCV,cAAc,CAACf,mBAAmB,CAACyB,MAAM,CAAC;IAC5C,CAAC,CAAC;IACF,OAAOV,cAAc;EACvB;AACF;AAACW,OAAA,CAAA3D,cAAA,GAAAA,cAAA;AAAApB,eAAA,CA1EYoB,cAAc,kBAGH,CAAC4D,4BAAe,EAAEC,kBAAU,CAAC;AAAAjF,eAAA,CAHxCoB,cAAc,aAIR8D,eAAS;AAAAlF,eAAA,CAJfoB,cAAc,WAKV,CAAC+D,eAAI,CAACC,QAAQ,CAAoB,CAAC,CAAC;AAAA,IAAAC,QAAA,GAAAN,OAAA,CAAAhF,OAAA,GAuEtCqB,cAAc;AAE7BkE,kCAAkB,CAACC,UAAU,CAACnE,cAAc,CAAC","ignoreList":[]}
1
+ {"version":3,"names":["_react","data","_interopRequireDefault","require","_lodash","_component","_ui","_apiReferenceSections","_apiReferenceSections2","_harmony","_apiReferenceRenderers","_apiReferenceRenderers2","_apiReferenceRenderers3","_apiReferenceRenderers4","_apiReferenceRenderers5","_apiReferenceRenderers6","_apiReferenceRenderers7","_apiReferenceRenderers8","_apiReferenceRenderers9","_apiReferenceRenderers10","_apiReferenceRenderers11","_apiReferenceRenderers12","_apiReferenceRenderers13","_apiReferenceRenderers14","_apiReferenceRenderers15","_apiReferenceHooks","_apiReferenceRenderers16","_semanticsEntities","_code","_taggedExports","_workspace","_apiReference","obj","__esModule","default","_defineProperty","key","value","_toPropertyKey","Object","defineProperty","enumerable","configurable","writable","t","i","_toPrimitive","r","e","Symbol","toPrimitive","call","TypeError","String","Number","APIReferenceUI","constructor","host","apiNodeRendererSlot","code","workspace","componentId","createElement","APIRefRenderersProvider","nodeRenderers","flatten","values","TaggedExports","showBanner","Boolean","classRenderer","typeRenderer","interfaceRenderer","variableRenderer","functionRenderer","enumRenderer","unresolvedRenderer","typeRefRenderer","typeIntersectionRenderer","typeUnionRenderer","parameterRenderer","typeLiteralRenderer","inferenceTypeRenderer","typeArrayRenderer","thisRenderer","decoratorRenderer","getAPIPage","EditorProvider","getCodeEditorProvider","APIRefPage","rendererSlot","registerSchemaClass","schema","SchemaRegistry","register","getSchemaClasses","schemas","registerAPINodeRenderer","apiNodeRenderers","provider","componentUI","codeUI","workspaceUI","_","harmony","config","get","apiReferenceUI","apiReferenceSection","APIRefSection","registerNavigation","navigationLink","order","registerRoute","route","Schemas","forEach","Schema","exports","ComponentAspect","CodeAspect","WorkspaceAspect","UIRuntime","Slot","withType","_default","APIReferenceAspect","addRuntime"],"sources":["api-reference.ui.runtime.tsx"],"sourcesContent":["import React from 'react';\nimport { flatten } from 'lodash';\nimport { ComponentAspect, ComponentUI } from '@teambit/component';\nimport { UIRuntime } from '@teambit/ui';\nimport { APIRefPage } from '@teambit/api-reference.sections.api-reference-page';\nimport { APIRefSection } from '@teambit/api-reference.sections.api-reference-section';\nimport { Harmony, Slot, SlotRegistry } from '@teambit/harmony';\nimport { APINodeRenderer } from '@teambit/api-reference.models.api-node-renderer';\nimport { classRenderer } from '@teambit/api-reference.renderers.class';\nimport { interfaceRenderer } from '@teambit/api-reference.renderers.interface';\nimport { typeRenderer } from '@teambit/api-reference.renderers.type';\nimport { functionRenderer } from '@teambit/api-reference.renderers.function';\nimport { enumRenderer } from '@teambit/api-reference.renderers.enum';\nimport { variableRenderer } from '@teambit/api-reference.renderers.variable';\nimport { unresolvedRenderer } from '@teambit/api-reference.renderers.unresolved';\nimport { typeRefRenderer } from '@teambit/api-reference.renderers.type-ref';\nimport { typeUnionRenderer } from '@teambit/api-reference.renderers.type-union';\nimport { typeIntersectionRenderer } from '@teambit/api-reference.renderers.type-intersection';\nimport { typeLiteralRenderer } from '@teambit/api-reference.renderers.type-literal';\nimport { parameterRenderer } from '@teambit/api-reference.renderers.parameter';\nimport { inferenceTypeRenderer } from '@teambit/api-reference.renderers.inference-type';\nimport { typeArrayRenderer } from '@teambit/api-reference.renderers.type-array';\nimport { thisRenderer } from '@teambit/api-reference.renderers.this';\nimport { APIRefRenderersProvider } from '@teambit/api-reference.hooks.use-api-renderers';\nimport { decoratorRenderer } from '@teambit/api-reference.renderers.decorator';\nimport { SchemaNodeConstructor, SchemaRegistry, Schemas } from '@teambit/semantics.entities.semantic-schema';\nimport { CodeAspect, CodeUI } from '@teambit/code';\nimport { TaggedExports } from '@teambit/tagged-exports';\nimport { WorkspaceAspect, WorkspaceUI } from '@teambit/workspace';\n\nimport { APIReferenceAspect } from './api-reference.aspect';\n\nexport type APINodeRendererSlot = SlotRegistry<APINodeRenderer[]>;\nexport class APIReferenceUI {\n constructor(\n private host: string,\n private apiNodeRendererSlot: APINodeRendererSlot,\n private code: CodeUI,\n private workspace: WorkspaceUI\n ) {}\n\n static dependencies = [ComponentAspect, CodeAspect, WorkspaceAspect];\n static runtime = UIRuntime;\n static slots = [Slot.withType<APINodeRenderer[]>()];\n\n getAPIPage() {\n const EditorProvider = this.code.getCodeEditorProvider();\n return (\n <EditorProvider>\n <APIRefPage host={this.host} rendererSlot={this.apiNodeRendererSlot} />\n </EditorProvider>\n );\n }\n\n TaggedAPIPage = ({ componentId }: { componentId: string }) => {\n return (\n <APIRefRenderersProvider nodeRenderers={flatten(this.apiNodeRendererSlot.values())}>\n <TaggedExports componentId={componentId} showBanner={Boolean(this.workspace)} />\n </APIRefRenderersProvider>\n );\n };\n\n registerSchemaClass(schema: SchemaNodeConstructor) {\n SchemaRegistry.register(schema);\n }\n\n getSchemaClasses() {\n return SchemaRegistry.schemas;\n }\n\n registerAPINodeRenderer(apiNodeRenderers: APINodeRenderer[]) {\n this.apiNodeRendererSlot.register(apiNodeRenderers);\n }\n\n apiNodeRenderers: APINodeRenderer[] = [\n classRenderer,\n typeRenderer,\n interfaceRenderer,\n variableRenderer,\n functionRenderer,\n enumRenderer,\n unresolvedRenderer,\n typeRefRenderer,\n typeIntersectionRenderer,\n typeUnionRenderer,\n parameterRenderer,\n typeLiteralRenderer,\n inferenceTypeRenderer,\n typeArrayRenderer,\n thisRenderer,\n decoratorRenderer,\n ];\n\n static async provider(\n [componentUI, codeUI, workspaceUI]: [ComponentUI, CodeUI, WorkspaceUI],\n _,\n [apiNodeRendererSlot]: [APINodeRendererSlot],\n harmony: Harmony\n ) {\n const { config } = harmony;\n const host = String(config.get('teambit.harmony/bit'));\n const apiReferenceUI = new APIReferenceUI(host, apiNodeRendererSlot, codeUI, workspaceUI);\n apiReferenceUI.registerAPINodeRenderer(apiReferenceUI.apiNodeRenderers);\n const apiReferenceSection = new APIRefSection(apiReferenceUI);\n componentUI.registerNavigation(apiReferenceSection.navigationLink, apiReferenceSection.order);\n componentUI.registerRoute(apiReferenceSection.route);\n // register all default schema classes\n Object.values(Schemas).forEach((Schema) => {\n apiReferenceUI.registerSchemaClass(Schema);\n });\n return apiReferenceUI;\n }\n}\n\nexport default APIReferenceUI;\n\nAPIReferenceAspect.addRuntime(APIReferenceUI);\n"],"mappings":";;;;;;AAAA,SAAAA,OAAA;EAAA,MAAAC,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAH,MAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAG,QAAA;EAAA,MAAAH,IAAA,GAAAE,OAAA;EAAAC,OAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAI,WAAA;EAAA,MAAAJ,IAAA,GAAAE,OAAA;EAAAE,UAAA,YAAAA,CAAA;IAAA,OAAAJ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAK,IAAA;EAAA,MAAAL,IAAA,GAAAE,OAAA;EAAAG,GAAA,YAAAA,CAAA;IAAA,OAAAL,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAM,sBAAA;EAAA,MAAAN,IAAA,GAAAE,OAAA;EAAAI,qBAAA,YAAAA,CAAA;IAAA,OAAAN,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAO,uBAAA;EAAA,MAAAP,IAAA,GAAAE,OAAA;EAAAK,sBAAA,YAAAA,CAAA;IAAA,OAAAP,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAQ,SAAA;EAAA,MAAAR,IAAA,GAAAE,OAAA;EAAAM,QAAA,YAAAA,CAAA;IAAA,OAAAR,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAS,uBAAA;EAAA,MAAAT,IAAA,GAAAE,OAAA;EAAAO,sBAAA,YAAAA,CAAA;IAAA,OAAAT,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAU,wBAAA;EAAA,MAAAV,IAAA,GAAAE,OAAA;EAAAQ,uBAAA,YAAAA,CAAA;IAAA,OAAAV,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAW,wBAAA;EAAA,MAAAX,IAAA,GAAAE,OAAA;EAAAS,uBAAA,YAAAA,CAAA;IAAA,OAAAX,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAY,wBAAA;EAAA,MAAAZ,IAAA,GAAAE,OAAA;EAAAU,uBAAA,YAAAA,CAAA;IAAA,OAAAZ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAa,wBAAA;EAAA,MAAAb,IAAA,GAAAE,OAAA;EAAAW,uBAAA,YAAAA,CAAA;IAAA,OAAAb,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAc,wBAAA;EAAA,MAAAd,IAAA,GAAAE,OAAA;EAAAY,uBAAA,YAAAA,CAAA;IAAA,OAAAd,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAe,wBAAA;EAAA,MAAAf,IAAA,GAAAE,OAAA;EAAAa,uBAAA,YAAAA,CAAA;IAAA,OAAAf,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAgB,wBAAA;EAAA,MAAAhB,IAAA,GAAAE,OAAA;EAAAc,uBAAA,YAAAA,CAAA;IAAA,OAAAhB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAiB,wBAAA;EAAA,MAAAjB,IAAA,GAAAE,OAAA;EAAAe,uBAAA,YAAAA,CAAA;IAAA,OAAAjB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAkB,yBAAA;EAAA,MAAAlB,IAAA,GAAAE,OAAA;EAAAgB,wBAAA,YAAAA,CAAA;IAAA,OAAAlB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAmB,yBAAA;EAAA,MAAAnB,IAAA,GAAAE,OAAA;EAAAiB,wBAAA,YAAAA,CAAA;IAAA,OAAAnB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAoB,yBAAA;EAAA,MAAApB,IAAA,GAAAE,OAAA;EAAAkB,wBAAA,YAAAA,CAAA;IAAA,OAAApB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAqB,yBAAA;EAAA,MAAArB,IAAA,GAAAE,OAAA;EAAAmB,wBAAA,YAAAA,CAAA;IAAA,OAAArB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAsB,yBAAA;EAAA,MAAAtB,IAAA,GAAAE,OAAA;EAAAoB,wBAAA,YAAAA,CAAA;IAAA,OAAAtB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAuB,yBAAA;EAAA,MAAAvB,IAAA,GAAAE,OAAA;EAAAqB,wBAAA,YAAAA,CAAA;IAAA,OAAAvB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAwB,mBAAA;EAAA,MAAAxB,IAAA,GAAAE,OAAA;EAAAsB,kBAAA,YAAAA,CAAA;IAAA,OAAAxB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAyB,yBAAA;EAAA,MAAAzB,IAAA,GAAAE,OAAA;EAAAuB,wBAAA,YAAAA,CAAA;IAAA,OAAAzB,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAA0B,mBAAA;EAAA,MAAA1B,IAAA,GAAAE,OAAA;EAAAwB,kBAAA,YAAAA,CAAA;IAAA,OAAA1B,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAA2B,MAAA;EAAA,MAAA3B,IAAA,GAAAE,OAAA;EAAAyB,KAAA,YAAAA,CAAA;IAAA,OAAA3B,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAA4B,eAAA;EAAA,MAAA5B,IAAA,GAAAE,OAAA;EAAA0B,cAAA,YAAAA,CAAA;IAAA,OAAA5B,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAA6B,WAAA;EAAA,MAAA7B,IAAA,GAAAE,OAAA;EAAA2B,UAAA,YAAAA,CAAA;IAAA,OAAA7B,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAA8B,cAAA;EAAA,MAAA9B,IAAA,GAAAE,OAAA;EAAA4B,aAAA,YAAAA,CAAA;IAAA,OAAA9B,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAA4D,SAAAC,uBAAA8B,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,KAAAE,OAAA,EAAAF,GAAA;AAAA,SAAAG,gBAAAH,GAAA,EAAAI,GAAA,EAAAC,KAAA,IAAAD,GAAA,GAAAE,cAAA,CAAAF,GAAA,OAAAA,GAAA,IAAAJ,GAAA,IAAAO,MAAA,CAAAC,cAAA,CAAAR,GAAA,EAAAI,GAAA,IAAAC,KAAA,EAAAA,KAAA,EAAAI,UAAA,QAAAC,YAAA,QAAAC,QAAA,oBAAAX,GAAA,CAAAI,GAAA,IAAAC,KAAA,WAAAL,GAAA;AAAA,SAAAM,eAAAM,CAAA,QAAAC,CAAA,GAAAC,YAAA,CAAAF,CAAA,uCAAAC,CAAA,GAAAA,CAAA,GAAAA,CAAA;AAAA,SAAAC,aAAAF,CAAA,EAAAG,CAAA,2BAAAH,CAAA,KAAAA,CAAA,SAAAA,CAAA,MAAAI,CAAA,GAAAJ,CAAA,CAAAK,MAAA,CAAAC,WAAA,kBAAAF,CAAA,QAAAH,CAAA,GAAAG,CAAA,CAAAG,IAAA,CAAAP,CAAA,EAAAG,CAAA,uCAAAF,CAAA,SAAAA,CAAA,YAAAO,SAAA,yEAAAL,CAAA,GAAAM,MAAA,GAAAC,MAAA,EAAAV,CAAA;AAGrD,MAAMW,cAAc,CAAC;EAC1BC,WAAWA,CACDC,IAAY,EACZC,mBAAwC,EACxCC,IAAY,EACZC,SAAsB,EAC9B;IAAA,KAJQH,IAAY,GAAZA,IAAY;IAAA,KACZC,mBAAwC,GAAxCA,mBAAwC;IAAA,KACxCC,IAAY,GAAZA,IAAY;IAAA,KACZC,SAAsB,GAAtBA,SAAsB;IAAAzB,eAAA,wBAgBhB,CAAC;MAAE0B;IAAqC,CAAC,KAAK;MAC5D,oBACE7D,MAAA,GAAAkC,OAAA,CAAA4B,aAAA,CAACrC,kBAAA,GAAAsC,uBAAuB;QAACC,aAAa,EAAE,IAAAC,iBAAO,EAAC,IAAI,CAACP,mBAAmB,CAACQ,MAAM,CAAC,CAAC;MAAE,gBACjFlE,MAAA,GAAAkC,OAAA,CAAA4B,aAAA,CAACjC,cAAA,GAAAsC,aAAa;QAACN,WAAW,EAAEA,WAAY;QAACO,UAAU,EAAEC,OAAO,CAAC,IAAI,CAACT,SAAS;MAAE,CAAE,CACxD,CAAC;IAE9B,CAAC;IAAAzB,eAAA,2BAcqC,CACpCmC,sCAAa,EACbC,sCAAY,EACZC,2CAAiB,EACjBC,0CAAgB,EAChBC,0CAAgB,EAChBC,sCAAY,EACZC,4CAAkB,EAClBC,yCAAe,EACfC,mDAAwB,EACxBC,2CAAiB,EACjBC,4CAAiB,EACjBC,8CAAmB,EACnBC,gDAAqB,EACrBC,4CAAiB,EACjBC,uCAAY,EACZC,4CAAiB,CAClB;EApDE;EAMHC,UAAUA,CAAA,EAAG;IACX,MAAMC,cAAc,GAAG,IAAI,CAAC5B,IAAI,CAAC6B,qBAAqB,CAAC,CAAC;IACxD,oBACExF,MAAA,GAAAkC,OAAA,CAAA4B,aAAA,CAACyB,cAAc,qBACbvF,MAAA,GAAAkC,OAAA,CAAA4B,aAAA,CAACvD,qBAAA,GAAAkF,UAAU;MAAChC,IAAI,EAAE,IAAI,CAACA,IAAK;MAACiC,YAAY,EAAE,IAAI,CAAChC;IAAoB,CAAE,CACxD,CAAC;EAErB;EAUAiC,mBAAmBA,CAACC,MAA6B,EAAE;IACjDC,mCAAc,CAACC,QAAQ,CAACF,MAAM,CAAC;EACjC;EAEAG,gBAAgBA,CAAA,EAAG;IACjB,OAAOF,mCAAc,CAACG,OAAO;EAC/B;EAEAC,uBAAuBA,CAACC,gBAAmC,EAAE;IAC3D,IAAI,CAACxC,mBAAmB,CAACoC,QAAQ,CAACI,gBAAgB,CAAC;EACrD;EAqBA,aAAaC,QAAQA,CACnB,CAACC,WAAW,EAAEC,MAAM,EAAEC,WAAW,CAAqC,EACtEC,CAAC,EACD,CAAC7C,mBAAmB,CAAwB,EAC5C8C,OAAgB,EAChB;IACA,MAAM;MAAEC;IAAO,CAAC,GAAGD,OAAO;IAC1B,MAAM/C,IAAI,GAAGJ,MAAM,CAACoD,MAAM,CAACC,GAAG,CAAC,qBAAqB,CAAC,CAAC;IACtD,MAAMC,cAAc,GAAG,IAAIpD,cAAc,CAACE,IAAI,EAAEC,mBAAmB,EAAE2C,MAAM,EAAEC,WAAW,CAAC;IACzFK,cAAc,CAACV,uBAAuB,CAACU,cAAc,CAACT,gBAAgB,CAAC;IACvE,MAAMU,mBAAmB,GAAG,KAAIC,sCAAa,EAACF,cAAc,CAAC;IAC7DP,WAAW,CAACU,kBAAkB,CAACF,mBAAmB,CAACG,cAAc,EAAEH,mBAAmB,CAACI,KAAK,CAAC;IAC7FZ,WAAW,CAACa,aAAa,CAACL,mBAAmB,CAACM,KAAK,CAAC;IACpD;IACA3E,MAAM,CAAC2B,MAAM,CAACiD,4BAAO,CAAC,CAACC,OAAO,CAAEC,MAAM,IAAK;MACzCV,cAAc,CAAChB,mBAAmB,CAAC0B,MAAM,CAAC;IAC5C,CAAC,CAAC;IACF,OAAOV,cAAc;EACvB;AACF;AAACW,OAAA,CAAA/D,cAAA,GAAAA,cAAA;AAAApB,eAAA,CA/EYoB,cAAc,kBAQH,CAACgE,4BAAe,EAAEC,kBAAU,EAAEC,4BAAe,CAAC;AAAAtF,eAAA,CARzDoB,cAAc,aASRmE,eAAS;AAAAvF,eAAA,CATfoB,cAAc,WAUV,CAACoE,eAAI,CAACC,QAAQ,CAAoB,CAAC,CAAC;AAAA,IAAAC,QAAA,GAAAP,OAAA,CAAApF,OAAA,GAuEtCqB,cAAc;AAE7BuE,kCAAkB,CAACC,UAAU,CAACxE,cAAc,CAAC","ignoreList":[]}
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@teambit/api-reference",
3
- "version": "1.0.252",
3
+ "version": "1.0.254",
4
4
  "homepage": "https://bit.cloud/teambit/api-reference/api-reference",
5
5
  "main": "dist/index.js",
6
6
  "componentId": {
7
7
  "scope": "teambit.api-reference",
8
8
  "name": "api-reference",
9
- "version": "1.0.252"
9
+ "version": "1.0.254"
10
10
  },
11
11
  "dependencies": {
12
12
  "lodash": "4.17.21",
@@ -31,11 +31,12 @@
31
31
  "@teambit/api-reference.renderers.variable": "0.0.40",
32
32
  "@teambit/api-reference.sections.api-reference-page": "0.0.66",
33
33
  "@teambit/api-reference.sections.api-reference-section": "0.0.14",
34
- "@teambit/code": "1.0.252",
35
- "@teambit/component": "1.0.252",
34
+ "@teambit/code": "1.0.254",
35
+ "@teambit/component": "1.0.254",
36
36
  "@teambit/semantics.entities.semantic-schema": "0.0.68",
37
- "@teambit/tagged-exports": "0.0.10",
38
- "@teambit/ui": "1.0.252"
37
+ "@teambit/tagged-exports": "0.0.11",
38
+ "@teambit/ui": "1.0.254",
39
+ "@teambit/workspace": "1.0.254"
39
40
  },
40
41
  "devDependencies": {
41
42
  "@types/lodash": "4.14.165",