@teambit/api-reference 1.0.510 → 1.0.512

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 (4) hide show
  1. package/artifacts/__bit_junit.xml +1 -1
  2. package/package.json +27 -27
  3. package/artifacts/schema.json +0 -1260
  4. /package/dist/{preview-1736705249371.js → preview-1736824735631.js} +0 -0
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.510" tests="0" failures="0" errors="0" skipped="0"/>
3
+ <testsuite name="teambit.api-reference/api-reference@1.0.512" tests="0" failures="0" errors="0" skipped="0"/>
4
4
  </testsuites>
package/package.json CHANGED
@@ -1,42 +1,42 @@
1
1
  {
2
2
  "name": "@teambit/api-reference",
3
- "version": "1.0.510",
3
+ "version": "1.0.512",
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.510"
9
+ "version": "1.0.512"
10
10
  },
11
11
  "dependencies": {
12
12
  "lodash": "4.17.21",
13
13
  "@teambit/harmony": "0.4.6",
14
- "@teambit/api-reference.hooks.use-api-renderers": "0.0.17",
15
- "@teambit/api-reference.models.api-node-renderer": "0.0.34",
16
- "@teambit/api-reference.renderers.class": "0.0.57",
17
- "@teambit/api-reference.renderers.decorator": "0.0.13",
18
- "@teambit/api-reference.renderers.enum": "0.0.57",
19
- "@teambit/api-reference.renderers.function": "0.0.59",
20
- "@teambit/api-reference.renderers.inference-type": "0.0.41",
21
- "@teambit/api-reference.renderers.interface": "0.0.57",
22
- "@teambit/api-reference.renderers.parameter": "0.0.44",
23
- "@teambit/api-reference.renderers.this": "0.0.44",
24
- "@teambit/api-reference.renderers.type-array": "0.0.36",
25
- "@teambit/api-reference.renderers.type-intersection": "0.0.36",
26
- "@teambit/api-reference.renderers.type-literal": "0.0.48",
27
- "@teambit/api-reference.renderers.type-ref": "0.0.72",
28
- "@teambit/api-reference.renderers.type-union": "0.0.36",
29
- "@teambit/api-reference.renderers.type": "0.0.55",
30
- "@teambit/api-reference.renderers.unresolved": "0.0.55",
31
- "@teambit/api-reference.renderers.variable": "0.0.55",
32
- "@teambit/api-reference.sections.api-reference-page": "0.0.84",
14
+ "@teambit/api-reference.hooks.use-api-renderers": "0.0.18",
15
+ "@teambit/api-reference.models.api-node-renderer": "0.0.35",
16
+ "@teambit/api-reference.renderers.class": "0.0.58",
17
+ "@teambit/api-reference.renderers.decorator": "0.0.14",
18
+ "@teambit/api-reference.renderers.enum": "0.0.58",
19
+ "@teambit/api-reference.renderers.function": "0.0.60",
20
+ "@teambit/api-reference.renderers.inference-type": "0.0.42",
21
+ "@teambit/api-reference.renderers.interface": "0.0.58",
22
+ "@teambit/api-reference.renderers.parameter": "0.0.45",
23
+ "@teambit/api-reference.renderers.this": "0.0.45",
24
+ "@teambit/api-reference.renderers.type-array": "0.0.37",
25
+ "@teambit/api-reference.renderers.type-intersection": "0.0.37",
26
+ "@teambit/api-reference.renderers.type-literal": "0.0.49",
27
+ "@teambit/api-reference.renderers.type-ref": "0.0.73",
28
+ "@teambit/api-reference.renderers.type-union": "0.0.37",
29
+ "@teambit/api-reference.renderers.type": "0.0.56",
30
+ "@teambit/api-reference.renderers.unresolved": "0.0.56",
31
+ "@teambit/api-reference.renderers.variable": "0.0.56",
32
+ "@teambit/api-reference.sections.api-reference-page": "0.0.86",
33
33
  "@teambit/api-reference.sections.api-reference-section": "0.0.15",
34
- "@teambit/code": "1.0.510",
35
- "@teambit/component": "1.0.510",
36
- "@teambit/semantics.entities.semantic-schema": "0.0.76",
37
- "@teambit/tagged-exports": "0.0.22",
38
- "@teambit/ui": "1.0.510",
39
- "@teambit/workspace": "1.0.510"
34
+ "@teambit/code": "1.0.512",
35
+ "@teambit/component": "1.0.512",
36
+ "@teambit/semantics.entities.semantic-schema": "0.0.77",
37
+ "@teambit/tagged-exports": "0.0.23",
38
+ "@teambit/ui": "1.0.512",
39
+ "@teambit/workspace": "1.0.512"
40
40
  },
41
41
  "devDependencies": {
42
42
  "@types/lodash": "4.14.165",
package/artifacts/schema.json DELETED
@@ -1,1260 +0,0 @@
1
- {
2
- "__schema": "APISchema",
3
- "location": {
4
- "filePath": "index.ts",
5
- "line": 1,
6
- "character": 1
7
- },
8
- "module": {
9
- "__schema": "ModuleSchema",
10
- "location": {
11
- "filePath": "index.ts",
12
- "line": 1,
13
- "character": 1
14
- },
15
- "exports": [
16
- {
17
- "__schema": "ExportSchema",
18
- "location": {
19
- "filePath": "index.ts",
20
- "line": 3,
21
- "character": 15
22
- },
23
- "signature": "class APIReferenceUI",
24
- "name": "APIReferenceUI",
25
- "exportNode": {
26
- "__schema": "ClassSchema",
27
- "location": {
28
- "filePath": "api-reference.ui.runtime.tsx",
29
- "line": 34,
30
- "character": 1
31
- },
32
- "signature": "class APIReferenceUI",
33
- "name": "APIReferenceUI",
34
- "members": [
35
- {
36
- "__schema": "ConstructorSchema",
37
- "location": {
38
- "filePath": "api-reference.ui.runtime.tsx",
39
- "line": 35,
40
- "character": 3
41
- },
42
- "signature": "constructor APIReferenceUI(host: string, apiNodeRendererSlot: APINodeRendererSlot, code: CodeUI, workspace: WorkspaceUI): APIReferenceUI",
43
- "name": "constructor",
44
- "params": [
45
- {
46
- "__schema": "ParameterSchema",
47
- "location": {
48
- "filePath": "api-reference.ui.runtime.tsx",
49
- "line": 36,
50
- "character": 5
51
- },
52
- "name": "host",
53
- "type": {
54
- "__schema": "KeywordTypeSchema",
55
- "location": {
56
- "filePath": "api-reference.ui.runtime.tsx",
57
- "line": 36,
58
- "character": 19
59
- },
60
- "name": "string"
61
- },
62
- "isOptional": false,
63
- "isSpread": false
64
- },
65
- {
66
- "__schema": "ParameterSchema",
67
- "location": {
68
- "filePath": "api-reference.ui.runtime.tsx",
69
- "line": 37,
70
- "character": 5
71
- },
72
- "name": "apiNodeRendererSlot",
73
- "type": {
74
- "__schema": "TypeRefSchema",
75
- "location": {
76
- "filePath": "api-reference.ui.runtime.tsx",
77
- "line": 37,
78
- "character": 34
79
- },
80
- "name": "APINodeRendererSlot"
81
- },
82
- "isOptional": false,
83
- "isSpread": false
84
- },
85
- {
86
- "__schema": "ParameterSchema",
87
- "location": {
88
- "filePath": "api-reference.ui.runtime.tsx",
89
- "line": 38,
90
- "character": 5
91
- },
92
- "name": "code",
93
- "type": {
94
- "__schema": "TypeRefSchema",
95
- "location": {
96
- "filePath": "api-reference.ui.runtime.tsx",
97
- "line": 38,
98
- "character": 19
99
- },
100
- "name": "CodeUI"
101
- },
102
- "isOptional": false,
103
- "isSpread": false
104
- },
105
- {
106
- "__schema": "ParameterSchema",
107
- "location": {
108
- "filePath": "api-reference.ui.runtime.tsx",
109
- "line": 39,
110
- "character": 5
111
- },
112
- "name": "workspace",
113
- "type": {
114
- "__schema": "TypeRefSchema",
115
- "location": {
116
- "filePath": "api-reference.ui.runtime.tsx",
117
- "line": 39,
118
- "character": 24
119
- },
120
- "name": "WorkspaceUI"
121
- },
122
- "isOptional": false,
123
- "isSpread": false
124
- }
125
- ],
126
- "returnType": {
127
- "__schema": "ThisTypeSchema",
128
- "location": {
129
- "filePath": "api-reference.ui.runtime.tsx",
130
- "line": 34,
131
- "character": 1
132
- },
133
- "name": "APIReferenceUI"
134
- },
135
- "modifiers": []
136
- },
137
- {
138
- "__schema": "VariableLikeSchema",
139
- "location": {
140
- "filePath": "api-reference.ui.runtime.tsx",
141
- "line": 42,
142
- "character": 3
143
- },
144
- "signature": "(property) APIReferenceUI.dependencies: Aspect[]",
145
- "name": "dependencies",
146
- "type": {
147
- "__schema": "InferenceTypeSchema",
148
- "location": {
149
- "filePath": "api-reference.ui.runtime.tsx",
150
- "line": 42,
151
- "character": 3
152
- },
153
- "type": "Aspect[]"
154
- },
155
- "isOptional": true,
156
- "defaultValue": "[ComponentAspect, CodeAspect, WorkspaceAspect]"
157
- },
158
- {
159
- "__schema": "VariableLikeSchema",
160
- "location": {
161
- "filePath": "api-reference.ui.runtime.tsx",
162
- "line": 43,
163
- "character": 3
164
- },
165
- "signature": "(property) APIReferenceUI.runtime: RuntimeDefinition",
166
- "name": "runtime",
167
- "type": {
168
- "__schema": "InferenceTypeSchema",
169
- "location": {
170
- "filePath": "api-reference.ui.runtime.tsx",
171
- "line": 43,
172
- "character": 3
173
- },
174
- "type": "RuntimeDefinition"
175
- },
176
- "isOptional": true,
177
- "defaultValue": "UIRuntime"
178
- },
179
- {
180
- "__schema": "VariableLikeSchema",
181
- "location": {
182
- "filePath": "api-reference.ui.runtime.tsx",
183
- "line": 44,
184
- "character": 3
185
- },
186
- "signature": "(property) APIReferenceUI.slots: ((registerFn: () => string) => SlotRegistry<APINodeRenderer[]>)[]",
187
- "name": "slots",
188
- "type": {
189
- "__schema": "InferenceTypeSchema",
190
- "location": {
191
- "filePath": "api-reference.ui.runtime.tsx",
192
- "line": 44,
193
- "character": 3
194
- },
195
- "type": "((registerFn: () => string) => SlotRegistry<APINodeRenderer[]>)[]"
196
- },
197
- "isOptional": true,
198
- "defaultValue": "[Slot.withType<APINodeRenderer[]>()]"
199
- },
200
- {
201
- "__schema": "ReactSchema",
202
- "location": {
203
- "filePath": "api-reference.ui.runtime.tsx",
204
- "line": 46,
205
- "character": 3
206
- },
207
- "signature": "(method) APIReferenceUI.getAPIPage(): React.JSX.Element",
208
- "name": "getAPIPage",
209
- "returnType": {
210
- "__schema": "TypeRefSchema",
211
- "location": {
212
- "filePath": "api-reference.ui.runtime.tsx",
213
- "line": 46,
214
- "character": 3
215
- },
216
- "name": "React.JSX.Element",
217
- "packageName": "react"
218
- },
219
- "modifiers": []
220
- },
221
- {
222
- "__schema": "VariableLikeSchema",
223
- "location": {
224
- "filePath": "api-reference.ui.runtime.tsx",
225
- "line": 55,
226
- "character": 3
227
- },
228
- "signature": "(property) APIReferenceUI.TaggedAPIPage: ({ componentId }: {\n componentId: string;\n}) => React.JSX.Element",
229
- "name": "TaggedAPIPage",
230
- "type": {
231
- "__schema": "InferenceTypeSchema",
232
- "location": {
233
- "filePath": "api-reference.ui.runtime.tsx",
234
- "line": 55,
235
- "character": 3
236
- },
237
- "type": "({ componentId }: {\n componentId: string;\n}) => React.JSX.Element"
238
- },
239
- "isOptional": true,
240
- "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 }"
241
- },
242
- {
243
- "__schema": "FunctionLikeSchema",
244
- "location": {
245
- "filePath": "api-reference.ui.runtime.tsx",
246
- "line": 63,
247
- "character": 3
248
- },
249
- "signature": "(method) APIReferenceUI.registerSchemaClass(schema: SchemaNodeConstructor): void",
250
- "name": "registerSchemaClass",
251
- "params": [
252
- {
253
- "__schema": "ParameterSchema",
254
- "location": {
255
- "filePath": "api-reference.ui.runtime.tsx",
256
- "line": 63,
257
- "character": 23
258
- },
259
- "name": "schema",
260
- "type": {
261
- "__schema": "TypeRefSchema",
262
- "location": {
263
- "filePath": "api-reference.ui.runtime.tsx",
264
- "line": 63,
265
- "character": 31
266
- },
267
- "name": "SchemaNodeConstructor"
268
- },
269
- "isOptional": false,
270
- "isSpread": false
271
- }
272
- ],
273
- "returnType": {
274
- "__schema": "InferenceTypeSchema",
275
- "location": {
276
- "filePath": "api-reference.ui.runtime.tsx",
277
- "line": 63,
278
- "character": 3
279
- },
280
- "type": "void"
281
- },
282
- "modifiers": []
283
- },
284
- {
285
- "__schema": "FunctionLikeSchema",
286
- "location": {
287
- "filePath": "api-reference.ui.runtime.tsx",
288
- "line": 67,
289
- "character": 3
290
- },
291
- "signature": "(method) APIReferenceUI.getSchemaClasses(): () => Record<string, SchemaNodeConstructor>",
292
- "name": "getSchemaClasses",
293
- "params": [],
294
- "returnType": {
295
- "__schema": "InferenceTypeSchema",
296
- "location": {
297
- "filePath": "api-reference.ui.runtime.tsx",
298
- "line": 67,
299
- "character": 3
300
- },
301
- "type": "() => Record<string, SchemaNodeConstructor>"
302
- },
303
- "modifiers": []
304
- },
305
- {
306
- "__schema": "FunctionLikeSchema",
307
- "location": {
308
- "filePath": "api-reference.ui.runtime.tsx",
309
- "line": 71,
310
- "character": 3
311
- },
312
- "signature": "(method) APIReferenceUI.registerAPINodeRenderer(apiNodeRenderers: APINodeRenderer[]): void",
313
- "name": "registerAPINodeRenderer",
314
- "params": [
315
- {
316
- "__schema": "ParameterSchema",
317
- "location": {
318
- "filePath": "api-reference.ui.runtime.tsx",
319
- "line": 71,
320
- "character": 27
321
- },
322
- "name": "apiNodeRenderers",
323
- "type": {
324
- "__schema": "TypeArraySchema",
325
- "location": {
326
- "filePath": "api-reference.ui.runtime.tsx",
327
- "line": 71,
328
- "character": 45
329
- },
330
- "type": {
331
- "__schema": "TypeRefSchema",
332
- "location": {
333
- "filePath": "api-reference.ui.runtime.tsx",
334
- "line": 71,
335
- "character": 45
336
- },
337
- "name": "APINodeRenderer"
338
- }
339
- },
340
- "isOptional": false,
341
- "isSpread": false
342
- }
343
- ],
344
- "returnType": {
345
- "__schema": "InferenceTypeSchema",
346
- "location": {
347
- "filePath": "api-reference.ui.runtime.tsx",
348
- "line": 71,
349
- "character": 3
350
- },
351
- "type": "void"
352
- },
353
- "modifiers": []
354
- },
355
- {
356
- "__schema": "VariableLikeSchema",
357
- "location": {
358
- "filePath": "api-reference.ui.runtime.tsx",
359
- "line": 75,
360
- "character": 3
361
- },
362
- "signature": "(property) APIReferenceUI.apiNodeRenderers: APINodeRenderer[]",
363
- "name": "apiNodeRenderers",
364
- "type": {
365
- "__schema": "TypeArraySchema",
366
- "location": {
367
- "filePath": "api-reference.ui.runtime.tsx",
368
- "line": 75,
369
- "character": 21
370
- },
371
- "type": {
372
- "__schema": "TypeRefSchema",
373
- "location": {
374
- "filePath": "api-reference.ui.runtime.tsx",
375
- "line": 75,
376
- "character": 21
377
- },
378
- "name": "APINodeRenderer"
379
- }
380
- },
381
- "isOptional": true,
382
- "defaultValue": "[\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 ]"
383
- },
384
- {
385
- "__schema": "FunctionLikeSchema",
386
- "location": {
387
- "filePath": "api-reference.ui.runtime.tsx",
388
- "line": 94,
389
- "character": 3
390
- },
391
- "signature": "(method) APIReferenceUI.provider([componentUI, codeUI, workspaceUI]: [ComponentUI, CodeUI, WorkspaceUI], _: any, [apiNodeRendererSlot]: [APINodeRendererSlot], harmony: Harmony): Promise<APIReferenceUI>",
392
- "name": "provider",
393
- "params": [
394
- {
395
- "__schema": "ParameterSchema",
396
- "location": {
397
- "filePath": "api-reference.ui.runtime.tsx",
398
- "line": 95,
399
- "character": 5
400
- },
401
- "name": "[ componentUI, codeUI, workspaceUI ]",
402
- "type": {
403
- "__schema": "TupleTypeSchema",
404
- "location": {
405
- "filePath": "api-reference.ui.runtime.tsx",
406
- "line": 95,
407
- "character": 41
408
- },
409
- "elements": [
410
- {
411
- "__schema": "TypeRefSchema",
412
- "location": {
413
- "filePath": "api-reference.ui.runtime.tsx",
414
- "line": 95,
415
- "character": 42
416
- },
417
- "name": "ComponentUI"
418
- },
419
- {
420
- "__schema": "TypeRefSchema",
421
- "location": {
422
- "filePath": "api-reference.ui.runtime.tsx",
423
- "line": 95,
424
- "character": 55
425
- },
426
- "name": "CodeUI"
427
- },
428
- {
429
- "__schema": "TypeRefSchema",
430
- "location": {
431
- "filePath": "api-reference.ui.runtime.tsx",
432
- "line": 95,
433
- "character": 63
434
- },
435
- "name": "WorkspaceUI"
436
- }
437
- ]
438
- },
439
- "isOptional": false,
440
- "isSpread": false
441
- },
442
- {
443
- "__schema": "ParameterSchema",
444
- "location": {
445
- "filePath": "api-reference.ui.runtime.tsx",
446
- "line": 96,
447
- "character": 5
448
- },
449
- "name": "_",
450
- "type": {
451
- "__schema": "InferenceTypeSchema",
452
- "location": {
453
- "filePath": "api-reference.ui.runtime.tsx",
454
- "line": 96,
455
- "character": 5
456
- },
457
- "type": "any"
458
- },
459
- "isOptional": false,
460
- "isSpread": false
461
- },
462
- {
463
- "__schema": "ParameterSchema",
464
- "location": {
465
- "filePath": "api-reference.ui.runtime.tsx",
466
- "line": 97,
467
- "character": 5
468
- },
469
- "name": "[ apiNodeRendererSlot ]",
470
- "type": {
471
- "__schema": "TupleTypeSchema",
472
- "location": {
473
- "filePath": "api-reference.ui.runtime.tsx",
474
- "line": 97,
475
- "character": 28
476
- },
477
- "elements": [
478
- {
479
- "__schema": "TypeRefSchema",
480
- "location": {
481
- "filePath": "api-reference.ui.runtime.tsx",
482
- "line": 97,
483
- "character": 29
484
- },
485
- "name": "APINodeRendererSlot"
486
- }
487
- ]
488
- },
489
- "isOptional": false,
490
- "isSpread": false
491
- },
492
- {
493
- "__schema": "ParameterSchema",
494
- "location": {
495
- "filePath": "api-reference.ui.runtime.tsx",
496
- "line": 98,
497
- "character": 5
498
- },
499
- "name": "harmony",
500
- "type": {
501
- "__schema": "TypeRefSchema",
502
- "location": {
503
- "filePath": "api-reference.ui.runtime.tsx",
504
- "line": 98,
505
- "character": 14
506
- },
507
- "name": "Harmony"
508
- },
509
- "isOptional": false,
510
- "isSpread": false
511
- }
512
- ],
513
- "returnType": {
514
- "__schema": "InferenceTypeSchema",
515
- "location": {
516
- "filePath": "api-reference.ui.runtime.tsx",
517
- "line": 94,
518
- "character": 3
519
- },
520
- "type": "Promise<APIReferenceUI>"
521
- },
522
- "modifiers": [
523
- "static",
524
- "async"
525
- ]
526
- }
527
- ],
528
- "extendsNodes": [],
529
- "implementNodes": []
530
- }
531
- },
532
- {
533
- "__schema": "ExportSchema",
534
- "location": {
535
- "filePath": "index.ts",
536
- "line": 3,
537
- "character": 31
538
- },
539
- "signature": "type APINodeRendererSlot = SlotRegistry<APINodeRenderer[]>",
540
- "name": "APINodeRendererSlot",
541
- "exportNode": {
542
- "__schema": "TypeSchema",
543
- "location": {
544
- "filePath": "api-reference.ui.runtime.tsx",
545
- "line": 33,
546
- "character": 1
547
- },
548
- "signature": "type APINodeRendererSlot = SlotRegistry<APINodeRenderer[]>",
549
- "name": "APINodeRendererSlot",
550
- "type": {
551
- "__schema": "TypeRefSchema",
552
- "location": {
553
- "filePath": "api-reference.ui.runtime.tsx",
554
- "line": 33,
555
- "character": 35
556
- },
557
- "name": "SlotRegistry",
558
- "typeArgs": [
559
- {
560
- "__schema": "TypeArraySchema",
561
- "location": {
562
- "filePath": "api-reference.ui.runtime.tsx",
563
- "line": 33,
564
- "character": 48
565
- },
566
- "type": {
567
- "__schema": "TypeRefSchema",
568
- "location": {
569
- "filePath": "api-reference.ui.runtime.tsx",
570
- "line": 33,
571
- "character": 48
572
- },
573
- "name": "APINodeRenderer"
574
- }
575
- }
576
- ]
577
- }
578
- }
579
- },
580
- {
581
- "__schema": "UnImplementedSchema",
582
- "location": {
583
- "filePath": "index.ts",
584
- "line": 4,
585
- "character": 16
586
- },
587
- "name": "APIReferenceAspect",
588
- "type": "Identifier"
589
- },
590
- {
591
- "__schema": "ExportSchema",
592
- "location": {
593
- "filePath": "index.ts",
594
- "line": 5,
595
- "character": 10
596
- },
597
- "signature": "const APIReferenceAspect: Aspect",
598
- "name": "APIReferenceAspect",
599
- "exportNode": {
600
- "__schema": "VariableLikeSchema",
601
- "location": {
602
- "filePath": "api-reference.aspect.ts",
603
- "line": 3,
604
- "character": 14
605
- },
606
- "signature": "const APIReferenceAspect: Aspect",
607
- "name": "APIReferenceAspect",
608
- "type": {
609
- "__schema": "TypeRefSchema",
610
- "location": {
611
- "filePath": "api-reference.aspect.ts",
612
- "line": 3,
613
- "character": 14
614
- },
615
- "name": "Aspect",
616
- "componentId": {
617
- "scope": "teambit.harmony",
618
- "name": "harmony",
619
- "version": "0.4.6"
620
- }
621
- },
622
- "isOptional": false,
623
- "defaultValue": "Aspect.create({\n id: 'teambit.api-reference/api-reference',\n})"
624
- }
625
- }
626
- ],
627
- "internals": []
628
- },
629
- "internals": [
630
- {
631
- "__schema": "ModuleSchema",
632
- "location": {
633
- "filePath": "api-reference.ui.runtime.tsx",
634
- "line": 1,
635
- "character": 1
636
- },
637
- "exports": [
638
- {
639
- "__schema": "TypeSchema",
640
- "location": {
641
- "filePath": "api-reference.ui.runtime.tsx",
642
- "line": 33,
643
- "character": 1
644
- },
645
- "signature": "type APINodeRendererSlot = SlotRegistry<APINodeRenderer[]>",
646
- "name": "APINodeRendererSlot",
647
- "type": {
648
- "__schema": "TypeRefSchema",
649
- "location": {
650
- "filePath": "api-reference.ui.runtime.tsx",
651
- "line": 33,
652
- "character": 35
653
- },
654
- "name": "SlotRegistry",
655
- "typeArgs": [
656
- {
657
- "__schema": "TypeArraySchema",
658
- "location": {
659
- "filePath": "api-reference.ui.runtime.tsx",
660
- "line": 33,
661
- "character": 48
662
- },
663
- "type": {
664
- "__schema": "TypeRefSchema",
665
- "location": {
666
- "filePath": "api-reference.ui.runtime.tsx",
667
- "line": 33,
668
- "character": 48
669
- },
670
- "name": "APINodeRenderer"
671
- }
672
- }
673
- ]
674
- }
675
- },
676
- {
677
- "__schema": "ClassSchema",
678
- "location": {
679
- "filePath": "api-reference.ui.runtime.tsx",
680
- "line": 34,
681
- "character": 1
682
- },
683
- "signature": "class APIReferenceUI",
684
- "name": "APIReferenceUI",
685
- "members": [
686
- {
687
- "__schema": "ConstructorSchema",
688
- "location": {
689
- "filePath": "api-reference.ui.runtime.tsx",
690
- "line": 35,
691
- "character": 3
692
- },
693
- "signature": "constructor APIReferenceUI(host: string, apiNodeRendererSlot: APINodeRendererSlot, code: CodeUI, workspace: WorkspaceUI): APIReferenceUI",
694
- "name": "constructor",
695
- "params": [
696
- {
697
- "__schema": "ParameterSchema",
698
- "location": {
699
- "filePath": "api-reference.ui.runtime.tsx",
700
- "line": 36,
701
- "character": 5
702
- },
703
- "name": "host",
704
- "type": {
705
- "__schema": "KeywordTypeSchema",
706
- "location": {
707
- "filePath": "api-reference.ui.runtime.tsx",
708
- "line": 36,
709
- "character": 19
710
- },
711
- "name": "string"
712
- },
713
- "isOptional": false,
714
- "isSpread": false
715
- },
716
- {
717
- "__schema": "ParameterSchema",
718
- "location": {
719
- "filePath": "api-reference.ui.runtime.tsx",
720
- "line": 37,
721
- "character": 5
722
- },
723
- "name": "apiNodeRendererSlot",
724
- "type": {
725
- "__schema": "TypeRefSchema",
726
- "location": {
727
- "filePath": "api-reference.ui.runtime.tsx",
728
- "line": 37,
729
- "character": 34
730
- },
731
- "name": "APINodeRendererSlot"
732
- },
733
- "isOptional": false,
734
- "isSpread": false
735
- },
736
- {
737
- "__schema": "ParameterSchema",
738
- "location": {
739
- "filePath": "api-reference.ui.runtime.tsx",
740
- "line": 38,
741
- "character": 5
742
- },
743
- "name": "code",
744
- "type": {
745
- "__schema": "TypeRefSchema",
746
- "location": {
747
- "filePath": "api-reference.ui.runtime.tsx",
748
- "line": 38,
749
- "character": 19
750
- },
751
- "name": "CodeUI"
752
- },
753
- "isOptional": false,
754
- "isSpread": false
755
- },
756
- {
757
- "__schema": "ParameterSchema",
758
- "location": {
759
- "filePath": "api-reference.ui.runtime.tsx",
760
- "line": 39,
761
- "character": 5
762
- },
763
- "name": "workspace",
764
- "type": {
765
- "__schema": "TypeRefSchema",
766
- "location": {
767
- "filePath": "api-reference.ui.runtime.tsx",
768
- "line": 39,
769
- "character": 24
770
- },
771
- "name": "WorkspaceUI"
772
- },
773
- "isOptional": false,
774
- "isSpread": false
775
- }
776
- ],
777
- "returnType": {
778
- "__schema": "ThisTypeSchema",
779
- "location": {
780
- "filePath": "api-reference.ui.runtime.tsx",
781
- "line": 34,
782
- "character": 1
783
- },
784
- "name": "APIReferenceUI"
785
- },
786
- "modifiers": []
787
- },
788
- {
789
- "__schema": "VariableLikeSchema",
790
- "location": {
791
- "filePath": "api-reference.ui.runtime.tsx",
792
- "line": 42,
793
- "character": 3
794
- },
795
- "signature": "(property) APIReferenceUI.dependencies: Aspect[]",
796
- "name": "dependencies",
797
- "type": {
798
- "__schema": "InferenceTypeSchema",
799
- "location": {
800
- "filePath": "api-reference.ui.runtime.tsx",
801
- "line": 42,
802
- "character": 3
803
- },
804
- "type": "Aspect[]"
805
- },
806
- "isOptional": true,
807
- "defaultValue": "[ComponentAspect, CodeAspect, WorkspaceAspect]"
808
- },
809
- {
810
- "__schema": "VariableLikeSchema",
811
- "location": {
812
- "filePath": "api-reference.ui.runtime.tsx",
813
- "line": 43,
814
- "character": 3
815
- },
816
- "signature": "(property) APIReferenceUI.runtime: RuntimeDefinition",
817
- "name": "runtime",
818
- "type": {
819
- "__schema": "InferenceTypeSchema",
820
- "location": {
821
- "filePath": "api-reference.ui.runtime.tsx",
822
- "line": 43,
823
- "character": 3
824
- },
825
- "type": "RuntimeDefinition"
826
- },
827
- "isOptional": true,
828
- "defaultValue": "UIRuntime"
829
- },
830
- {
831
- "__schema": "VariableLikeSchema",
832
- "location": {
833
- "filePath": "api-reference.ui.runtime.tsx",
834
- "line": 44,
835
- "character": 3
836
- },
837
- "signature": "(property) APIReferenceUI.slots: ((registerFn: () => string) => SlotRegistry<APINodeRenderer[]>)[]",
838
- "name": "slots",
839
- "type": {
840
- "__schema": "InferenceTypeSchema",
841
- "location": {
842
- "filePath": "api-reference.ui.runtime.tsx",
843
- "line": 44,
844
- "character": 3
845
- },
846
- "type": "((registerFn: () => string) => SlotRegistry<APINodeRenderer[]>)[]"
847
- },
848
- "isOptional": true,
849
- "defaultValue": "[Slot.withType<APINodeRenderer[]>()]"
850
- },
851
- {
852
- "__schema": "ReactSchema",
853
- "location": {
854
- "filePath": "api-reference.ui.runtime.tsx",
855
- "line": 46,
856
- "character": 3
857
- },
858
- "signature": "(method) APIReferenceUI.getAPIPage(): React.JSX.Element",
859
- "name": "getAPIPage",
860
- "returnType": {
861
- "__schema": "TypeRefSchema",
862
- "location": {
863
- "filePath": "api-reference.ui.runtime.tsx",
864
- "line": 46,
865
- "character": 3
866
- },
867
- "name": "React.JSX.Element",
868
- "packageName": "react"
869
- },
870
- "modifiers": []
871
- },
872
- {
873
- "__schema": "VariableLikeSchema",
874
- "location": {
875
- "filePath": "api-reference.ui.runtime.tsx",
876
- "line": 55,
877
- "character": 3
878
- },
879
- "signature": "(property) APIReferenceUI.TaggedAPIPage: ({ componentId }: {\n componentId: string;\n}) => React.JSX.Element",
880
- "name": "TaggedAPIPage",
881
- "type": {
882
- "__schema": "InferenceTypeSchema",
883
- "location": {
884
- "filePath": "api-reference.ui.runtime.tsx",
885
- "line": 55,
886
- "character": 3
887
- },
888
- "type": "({ componentId }: {\n componentId: string;\n}) => React.JSX.Element"
889
- },
890
- "isOptional": true,
891
- "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 }"
892
- },
893
- {
894
- "__schema": "FunctionLikeSchema",
895
- "location": {
896
- "filePath": "api-reference.ui.runtime.tsx",
897
- "line": 63,
898
- "character": 3
899
- },
900
- "signature": "(method) APIReferenceUI.registerSchemaClass(schema: SchemaNodeConstructor): void",
901
- "name": "registerSchemaClass",
902
- "params": [
903
- {
904
- "__schema": "ParameterSchema",
905
- "location": {
906
- "filePath": "api-reference.ui.runtime.tsx",
907
- "line": 63,
908
- "character": 23
909
- },
910
- "name": "schema",
911
- "type": {
912
- "__schema": "TypeRefSchema",
913
- "location": {
914
- "filePath": "api-reference.ui.runtime.tsx",
915
- "line": 63,
916
- "character": 31
917
- },
918
- "name": "SchemaNodeConstructor"
919
- },
920
- "isOptional": false,
921
- "isSpread": false
922
- }
923
- ],
924
- "returnType": {
925
- "__schema": "InferenceTypeSchema",
926
- "location": {
927
- "filePath": "api-reference.ui.runtime.tsx",
928
- "line": 63,
929
- "character": 3
930
- },
931
- "type": "void"
932
- },
933
- "modifiers": []
934
- },
935
- {
936
- "__schema": "FunctionLikeSchema",
937
- "location": {
938
- "filePath": "api-reference.ui.runtime.tsx",
939
- "line": 67,
940
- "character": 3
941
- },
942
- "signature": "(method) APIReferenceUI.getSchemaClasses(): () => Record<string, SchemaNodeConstructor>",
943
- "name": "getSchemaClasses",
944
- "params": [],
945
- "returnType": {
946
- "__schema": "InferenceTypeSchema",
947
- "location": {
948
- "filePath": "api-reference.ui.runtime.tsx",
949
- "line": 67,
950
- "character": 3
951
- },
952
- "type": "() => Record<string, SchemaNodeConstructor>"
953
- },
954
- "modifiers": []
955
- },
956
- {
957
- "__schema": "FunctionLikeSchema",
958
- "location": {
959
- "filePath": "api-reference.ui.runtime.tsx",
960
- "line": 71,
961
- "character": 3
962
- },
963
- "signature": "(method) APIReferenceUI.registerAPINodeRenderer(apiNodeRenderers: APINodeRenderer[]): void",
964
- "name": "registerAPINodeRenderer",
965
- "params": [
966
- {
967
- "__schema": "ParameterSchema",
968
- "location": {
969
- "filePath": "api-reference.ui.runtime.tsx",
970
- "line": 71,
971
- "character": 27
972
- },
973
- "name": "apiNodeRenderers",
974
- "type": {
975
- "__schema": "TypeArraySchema",
976
- "location": {
977
- "filePath": "api-reference.ui.runtime.tsx",
978
- "line": 71,
979
- "character": 45
980
- },
981
- "type": {
982
- "__schema": "TypeRefSchema",
983
- "location": {
984
- "filePath": "api-reference.ui.runtime.tsx",
985
- "line": 71,
986
- "character": 45
987
- },
988
- "name": "APINodeRenderer"
989
- }
990
- },
991
- "isOptional": false,
992
- "isSpread": false
993
- }
994
- ],
995
- "returnType": {
996
- "__schema": "InferenceTypeSchema",
997
- "location": {
998
- "filePath": "api-reference.ui.runtime.tsx",
999
- "line": 71,
1000
- "character": 3
1001
- },
1002
- "type": "void"
1003
- },
1004
- "modifiers": []
1005
- },
1006
- {
1007
- "__schema": "VariableLikeSchema",
1008
- "location": {
1009
- "filePath": "api-reference.ui.runtime.tsx",
1010
- "line": 75,
1011
- "character": 3
1012
- },
1013
- "signature": "(property) APIReferenceUI.apiNodeRenderers: APINodeRenderer[]",
1014
- "name": "apiNodeRenderers",
1015
- "type": {
1016
- "__schema": "TypeArraySchema",
1017
- "location": {
1018
- "filePath": "api-reference.ui.runtime.tsx",
1019
- "line": 75,
1020
- "character": 21
1021
- },
1022
- "type": {
1023
- "__schema": "TypeRefSchema",
1024
- "location": {
1025
- "filePath": "api-reference.ui.runtime.tsx",
1026
- "line": 75,
1027
- "character": 21
1028
- },
1029
- "name": "APINodeRenderer"
1030
- }
1031
- },
1032
- "isOptional": true,
1033
- "defaultValue": "[\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 ]"
1034
- },
1035
- {
1036
- "__schema": "FunctionLikeSchema",
1037
- "location": {
1038
- "filePath": "api-reference.ui.runtime.tsx",
1039
- "line": 94,
1040
- "character": 3
1041
- },
1042
- "signature": "(method) APIReferenceUI.provider([componentUI, codeUI, workspaceUI]: [ComponentUI, CodeUI, WorkspaceUI], _: any, [apiNodeRendererSlot]: [APINodeRendererSlot], harmony: Harmony): Promise<APIReferenceUI>",
1043
- "name": "provider",
1044
- "params": [
1045
- {
1046
- "__schema": "ParameterSchema",
1047
- "location": {
1048
- "filePath": "api-reference.ui.runtime.tsx",
1049
- "line": 95,
1050
- "character": 5
1051
- },
1052
- "name": "[ componentUI, codeUI, workspaceUI ]",
1053
- "type": {
1054
- "__schema": "TupleTypeSchema",
1055
- "location": {
1056
- "filePath": "api-reference.ui.runtime.tsx",
1057
- "line": 95,
1058
- "character": 41
1059
- },
1060
- "elements": [
1061
- {
1062
- "__schema": "TypeRefSchema",
1063
- "location": {
1064
- "filePath": "api-reference.ui.runtime.tsx",
1065
- "line": 95,
1066
- "character": 42
1067
- },
1068
- "name": "ComponentUI"
1069
- },
1070
- {
1071
- "__schema": "TypeRefSchema",
1072
- "location": {
1073
- "filePath": "api-reference.ui.runtime.tsx",
1074
- "line": 95,
1075
- "character": 55
1076
- },
1077
- "name": "CodeUI"
1078
- },
1079
- {
1080
- "__schema": "TypeRefSchema",
1081
- "location": {
1082
- "filePath": "api-reference.ui.runtime.tsx",
1083
- "line": 95,
1084
- "character": 63
1085
- },
1086
- "name": "WorkspaceUI"
1087
- }
1088
- ]
1089
- },
1090
- "isOptional": false,
1091
- "isSpread": false
1092
- },
1093
- {
1094
- "__schema": "ParameterSchema",
1095
- "location": {
1096
- "filePath": "api-reference.ui.runtime.tsx",
1097
- "line": 96,
1098
- "character": 5
1099
- },
1100
- "name": "_",
1101
- "type": {
1102
- "__schema": "InferenceTypeSchema",
1103
- "location": {
1104
- "filePath": "api-reference.ui.runtime.tsx",
1105
- "line": 96,
1106
- "character": 5
1107
- },
1108
- "type": "any"
1109
- },
1110
- "isOptional": false,
1111
- "isSpread": false
1112
- },
1113
- {
1114
- "__schema": "ParameterSchema",
1115
- "location": {
1116
- "filePath": "api-reference.ui.runtime.tsx",
1117
- "line": 97,
1118
- "character": 5
1119
- },
1120
- "name": "[ apiNodeRendererSlot ]",
1121
- "type": {
1122
- "__schema": "TupleTypeSchema",
1123
- "location": {
1124
- "filePath": "api-reference.ui.runtime.tsx",
1125
- "line": 97,
1126
- "character": 28
1127
- },
1128
- "elements": [
1129
- {
1130
- "__schema": "TypeRefSchema",
1131
- "location": {
1132
- "filePath": "api-reference.ui.runtime.tsx",
1133
- "line": 97,
1134
- "character": 29
1135
- },
1136
- "name": "APINodeRendererSlot"
1137
- }
1138
- ]
1139
- },
1140
- "isOptional": false,
1141
- "isSpread": false
1142
- },
1143
- {
1144
- "__schema": "ParameterSchema",
1145
- "location": {
1146
- "filePath": "api-reference.ui.runtime.tsx",
1147
- "line": 98,
1148
- "character": 5
1149
- },
1150
- "name": "harmony",
1151
- "type": {
1152
- "__schema": "TypeRefSchema",
1153
- "location": {
1154
- "filePath": "api-reference.ui.runtime.tsx",
1155
- "line": 98,
1156
- "character": 14
1157
- },
1158
- "name": "Harmony"
1159
- },
1160
- "isOptional": false,
1161
- "isSpread": false
1162
- }
1163
- ],
1164
- "returnType": {
1165
- "__schema": "InferenceTypeSchema",
1166
- "location": {
1167
- "filePath": "api-reference.ui.runtime.tsx",
1168
- "line": 94,
1169
- "character": 3
1170
- },
1171
- "type": "Promise<APIReferenceUI>"
1172
- },
1173
- "modifiers": [
1174
- "static",
1175
- "async"
1176
- ]
1177
- }
1178
- ],
1179
- "extendsNodes": [],
1180
- "implementNodes": []
1181
- },
1182
- {
1183
- "__schema": "UnImplementedSchema",
1184
- "location": {
1185
- "filePath": "api-reference.ui.runtime.tsx",
1186
- "line": 115,
1187
- "character": 16
1188
- },
1189
- "name": "APIReferenceUI",
1190
- "type": "Identifier"
1191
- }
1192
- ],
1193
- "internals": [
1194
- {
1195
- "__schema": "UnImplementedSchema",
1196
- "location": {
1197
- "filePath": "api-reference.ui.runtime.tsx",
1198
- "line": 117,
1199
- "character": 1
1200
- },
1201
- "name": "APIReferenceAspect.addRuntime(APIReferenceUI);",
1202
- "type": "ExpressionStatement"
1203
- }
1204
- ]
1205
- },
1206
- {
1207
- "__schema": "ModuleSchema",
1208
- "location": {
1209
- "filePath": "api-reference.aspect.ts",
1210
- "line": 1,
1211
- "character": 1
1212
- },
1213
- "exports": [
1214
- {
1215
- "__schema": "VariableLikeSchema",
1216
- "location": {
1217
- "filePath": "api-reference.aspect.ts",
1218
- "line": 3,
1219
- "character": 14
1220
- },
1221
- "signature": "const APIReferenceAspect: Aspect",
1222
- "name": "APIReferenceAspect",
1223
- "type": {
1224
- "__schema": "TypeRefSchema",
1225
- "location": {
1226
- "filePath": "api-reference.aspect.ts",
1227
- "line": 3,
1228
- "character": 14
1229
- },
1230
- "name": "Aspect",
1231
- "componentId": {
1232
- "scope": "teambit.harmony",
1233
- "name": "harmony",
1234
- "version": "0.4.6"
1235
- }
1236
- },
1237
- "isOptional": false,
1238
- "defaultValue": "Aspect.create({\n id: 'teambit.api-reference/api-reference',\n})"
1239
- },
1240
- {
1241
- "__schema": "UnImplementedSchema",
1242
- "location": {
1243
- "filePath": "api-reference.aspect.ts",
1244
- "line": 7,
1245
- "character": 16
1246
- },
1247
- "name": "APIReferenceAspect",
1248
- "type": "Identifier"
1249
- }
1250
- ],
1251
- "internals": []
1252
- }
1253
- ],
1254
- "componentId": {
1255
- "scope": "teambit.api-reference",
1256
- "name": "api-reference",
1257
- "version": "1.0.510"
1258
- },
1259
- "taggedModuleExports": []
1260
- }