@teambit/api-reference 1.0.257 → 1.0.259

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.
@@ -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.257" tests="0" failures="0" errors="0" skipped="0"/>
3
+ <testsuite name="teambit.api-reference/api-reference@1.0.259" tests="0" failures="0" errors="0" skipped="0"/>
4
4
  </testsuites>
@@ -14,597 +14,615 @@
14
14
  },
15
15
  "exports": [
16
16
  {
17
- "__schema": "ClassSchema",
17
+ "__schema": "ExportSchema",
18
18
  "location": {
19
- "filePath": "api-reference.ui.runtime.tsx",
20
- "line": 34,
21
- "character": 1
19
+ "filePath": "index.ts",
20
+ "line": 3,
21
+ "character": 15
22
22
  },
23
- "signature": "class APIReferenceUI",
24
23
  "name": "APIReferenceUI",
25
- "members": [
26
- {
27
- "__schema": "ConstructorSchema",
28
- "location": {
29
- "filePath": "api-reference.ui.runtime.tsx",
30
- "line": 35,
31
- "character": 3
32
- },
33
- "signature": "constructor APIReferenceUI(host: string, apiNodeRendererSlot: APINodeRendererSlot, code: CodeUI, workspace: WorkspaceUI): APIReferenceUI",
34
- "name": "constructor",
35
- "params": [
36
- {
37
- "__schema": "ParameterSchema",
38
- "location": {
39
- "filePath": "api-reference.ui.runtime.tsx",
40
- "line": 36,
41
- "character": 5
42
- },
43
- "name": "host",
44
- "type": {
45
- "__schema": "KeywordTypeSchema",
24
+ "exportNode": {
25
+ "__schema": "ClassSchema",
26
+ "location": {
27
+ "filePath": "api-reference.ui.runtime.tsx",
28
+ "line": 34,
29
+ "character": 1
30
+ },
31
+ "signature": "class APIReferenceUI",
32
+ "name": "APIReferenceUI",
33
+ "members": [
34
+ {
35
+ "__schema": "ConstructorSchema",
36
+ "location": {
37
+ "filePath": "api-reference.ui.runtime.tsx",
38
+ "line": 35,
39
+ "character": 3
40
+ },
41
+ "signature": "constructor APIReferenceUI(host: string, apiNodeRendererSlot: APINodeRendererSlot, code: CodeUI, workspace: WorkspaceUI): APIReferenceUI",
42
+ "name": "constructor",
43
+ "params": [
44
+ {
45
+ "__schema": "ParameterSchema",
46
46
  "location": {
47
47
  "filePath": "api-reference.ui.runtime.tsx",
48
48
  "line": 36,
49
- "character": 19
49
+ "character": 5
50
50
  },
51
- "name": "string"
52
- },
53
- "isOptional": false,
54
- "isSpread": false
55
- },
56
- {
57
- "__schema": "ParameterSchema",
58
- "location": {
59
- "filePath": "api-reference.ui.runtime.tsx",
60
- "line": 37,
61
- "character": 5
51
+ "name": "host",
52
+ "type": {
53
+ "__schema": "KeywordTypeSchema",
54
+ "location": {
55
+ "filePath": "api-reference.ui.runtime.tsx",
56
+ "line": 36,
57
+ "character": 19
58
+ },
59
+ "name": "string"
60
+ },
61
+ "isOptional": false,
62
+ "isSpread": false
62
63
  },
63
- "name": "apiNodeRendererSlot",
64
- "type": {
65
- "__schema": "TypeRefSchema",
64
+ {
65
+ "__schema": "ParameterSchema",
66
66
  "location": {
67
67
  "filePath": "api-reference.ui.runtime.tsx",
68
68
  "line": 37,
69
- "character": 34
69
+ "character": 5
70
70
  },
71
- "name": "APINodeRendererSlot"
72
- },
73
- "isOptional": false,
74
- "isSpread": false
75
- },
76
- {
77
- "__schema": "ParameterSchema",
78
- "location": {
79
- "filePath": "api-reference.ui.runtime.tsx",
80
- "line": 38,
81
- "character": 5
71
+ "name": "apiNodeRendererSlot",
72
+ "type": {
73
+ "__schema": "TypeRefSchema",
74
+ "location": {
75
+ "filePath": "api-reference.ui.runtime.tsx",
76
+ "line": 37,
77
+ "character": 34
78
+ },
79
+ "name": "APINodeRendererSlot"
80
+ },
81
+ "isOptional": false,
82
+ "isSpread": false
82
83
  },
83
- "name": "code",
84
- "type": {
85
- "__schema": "TypeRefSchema",
84
+ {
85
+ "__schema": "ParameterSchema",
86
86
  "location": {
87
87
  "filePath": "api-reference.ui.runtime.tsx",
88
88
  "line": 38,
89
- "character": 19
89
+ "character": 5
90
90
  },
91
- "name": "CodeUI",
92
- "componentId": {
93
- "scope": "teambit.component",
94
- "name": "code"
95
- }
96
- },
97
- "isOptional": false,
98
- "isSpread": false
99
- },
100
- {
101
- "__schema": "ParameterSchema",
102
- "location": {
103
- "filePath": "api-reference.ui.runtime.tsx",
104
- "line": 39,
105
- "character": 5
91
+ "name": "code",
92
+ "type": {
93
+ "__schema": "TypeRefSchema",
94
+ "location": {
95
+ "filePath": "api-reference.ui.runtime.tsx",
96
+ "line": 38,
97
+ "character": 19
98
+ },
99
+ "name": "CodeUI",
100
+ "componentId": {
101
+ "scope": "teambit.component",
102
+ "name": "code"
103
+ }
104
+ },
105
+ "isOptional": false,
106
+ "isSpread": false
106
107
  },
107
- "name": "workspace",
108
- "type": {
109
- "__schema": "TypeRefSchema",
108
+ {
109
+ "__schema": "ParameterSchema",
110
110
  "location": {
111
111
  "filePath": "api-reference.ui.runtime.tsx",
112
112
  "line": 39,
113
- "character": 24
113
+ "character": 5
114
114
  },
115
- "name": "WorkspaceUI",
116
- "componentId": {
117
- "scope": "teambit.workspace",
118
- "name": "workspace"
119
- }
115
+ "name": "workspace",
116
+ "type": {
117
+ "__schema": "TypeRefSchema",
118
+ "location": {
119
+ "filePath": "api-reference.ui.runtime.tsx",
120
+ "line": 39,
121
+ "character": 24
122
+ },
123
+ "name": "WorkspaceUI",
124
+ "componentId": {
125
+ "scope": "teambit.workspace",
126
+ "name": "workspace"
127
+ }
128
+ },
129
+ "isOptional": false,
130
+ "isSpread": false
131
+ }
132
+ ],
133
+ "returnType": {
134
+ "__schema": "ThisTypeSchema",
135
+ "location": {
136
+ "filePath": "api-reference.ui.runtime.tsx",
137
+ "line": 34,
138
+ "character": 1
120
139
  },
121
- "isOptional": false,
122
- "isSpread": false
123
- }
124
- ],
125
- "returnType": {
126
- "__schema": "ThisTypeSchema",
127
- "location": {
128
- "filePath": "api-reference.ui.runtime.tsx",
129
- "line": 34,
130
- "character": 1
140
+ "name": "APIReferenceUI"
131
141
  },
132
- "name": "APIReferenceUI"
133
- },
134
- "modifiers": []
135
- },
136
- {
137
- "__schema": "VariableLikeSchema",
138
- "location": {
139
- "filePath": "api-reference.ui.runtime.tsx",
140
- "line": 42,
141
- "character": 3
142
+ "modifiers": []
142
143
  },
143
- "signature": "(property) APIReferenceUI.dependencies: Aspect[]",
144
- "name": "dependencies",
145
- "type": {
146
- "__schema": "InferenceTypeSchema",
144
+ {
145
+ "__schema": "VariableLikeSchema",
147
146
  "location": {
148
147
  "filePath": "api-reference.ui.runtime.tsx",
149
148
  "line": 42,
150
149
  "character": 3
151
150
  },
152
- "type": "Aspect[]"
153
- },
154
- "isOptional": true,
155
- "defaultValue": "[ComponentAspect, CodeAspect, WorkspaceAspect]"
156
- },
157
- {
158
- "__schema": "VariableLikeSchema",
159
- "location": {
160
- "filePath": "api-reference.ui.runtime.tsx",
161
- "line": 43,
162
- "character": 3
151
+ "signature": "(property) APIReferenceUI.dependencies: Aspect[]",
152
+ "name": "dependencies",
153
+ "type": {
154
+ "__schema": "InferenceTypeSchema",
155
+ "location": {
156
+ "filePath": "api-reference.ui.runtime.tsx",
157
+ "line": 42,
158
+ "character": 3
159
+ },
160
+ "type": "Aspect[]"
161
+ },
162
+ "isOptional": true,
163
+ "defaultValue": "[ComponentAspect, CodeAspect, WorkspaceAspect]"
163
164
  },
164
- "signature": "(property) APIReferenceUI.runtime: RuntimeDefinition",
165
- "name": "runtime",
166
- "type": {
167
- "__schema": "InferenceTypeSchema",
165
+ {
166
+ "__schema": "VariableLikeSchema",
168
167
  "location": {
169
168
  "filePath": "api-reference.ui.runtime.tsx",
170
169
  "line": 43,
171
170
  "character": 3
172
171
  },
173
- "type": "RuntimeDefinition"
174
- },
175
- "isOptional": true,
176
- "defaultValue": "UIRuntime"
177
- },
178
- {
179
- "__schema": "VariableLikeSchema",
180
- "location": {
181
- "filePath": "api-reference.ui.runtime.tsx",
182
- "line": 44,
183
- "character": 3
172
+ "signature": "(property) APIReferenceUI.runtime: RuntimeDefinition",
173
+ "name": "runtime",
174
+ "type": {
175
+ "__schema": "InferenceTypeSchema",
176
+ "location": {
177
+ "filePath": "api-reference.ui.runtime.tsx",
178
+ "line": 43,
179
+ "character": 3
180
+ },
181
+ "type": "RuntimeDefinition"
182
+ },
183
+ "isOptional": true,
184
+ "defaultValue": "UIRuntime"
184
185
  },
185
- "signature": "(property) APIReferenceUI.slots: ((registerFn: () => string) => SlotRegistry<APINodeRenderer[]>)[]",
186
- "name": "slots",
187
- "type": {
188
- "__schema": "InferenceTypeSchema",
186
+ {
187
+ "__schema": "VariableLikeSchema",
189
188
  "location": {
190
189
  "filePath": "api-reference.ui.runtime.tsx",
191
190
  "line": 44,
192
191
  "character": 3
193
192
  },
194
- "type": "((registerFn: () => string) => SlotRegistry<APINodeRenderer[]>)[]"
195
- },
196
- "isOptional": true,
197
- "defaultValue": "[Slot.withType<APINodeRenderer[]>()]"
198
- },
199
- {
200
- "__schema": "ReactSchema",
201
- "location": {
202
- "filePath": "api-reference.ui.runtime.tsx",
203
- "line": 46,
204
- "character": 3
193
+ "signature": "(property) APIReferenceUI.slots: ((registerFn: () => string) => SlotRegistry<APINodeRenderer[]>)[]",
194
+ "name": "slots",
195
+ "type": {
196
+ "__schema": "InferenceTypeSchema",
197
+ "location": {
198
+ "filePath": "api-reference.ui.runtime.tsx",
199
+ "line": 44,
200
+ "character": 3
201
+ },
202
+ "type": "((registerFn: () => string) => SlotRegistry<APINodeRenderer[]>)[]"
203
+ },
204
+ "isOptional": true,
205
+ "defaultValue": "[Slot.withType<APINodeRenderer[]>()]"
205
206
  },
206
- "signature": "(method) APIReferenceUI.getAPIPage(): React.JSX.Element",
207
- "name": "getAPIPage",
208
- "returnType": {
209
- "__schema": "TypeRefSchema",
207
+ {
208
+ "__schema": "ReactSchema",
210
209
  "location": {
211
210
  "filePath": "api-reference.ui.runtime.tsx",
212
211
  "line": 46,
213
212
  "character": 3
214
213
  },
215
- "name": "React.JSX.Element",
216
- "packageName": "react"
217
- },
218
- "modifiers": []
219
- },
220
- {
221
- "__schema": "VariableLikeSchema",
222
- "location": {
223
- "filePath": "api-reference.ui.runtime.tsx",
224
- "line": 55,
225
- "character": 3
214
+ "signature": "(method) APIReferenceUI.getAPIPage(): React.JSX.Element",
215
+ "name": "getAPIPage",
216
+ "returnType": {
217
+ "__schema": "TypeRefSchema",
218
+ "location": {
219
+ "filePath": "api-reference.ui.runtime.tsx",
220
+ "line": 46,
221
+ "character": 3
222
+ },
223
+ "name": "React.JSX.Element",
224
+ "packageName": "react"
225
+ },
226
+ "modifiers": []
226
227
  },
227
- "signature": "(property) APIReferenceUI.TaggedAPIPage: ({ componentId }: {\n componentId: string;\n}) => React.JSX.Element",
228
- "name": "TaggedAPIPage",
229
- "type": {
230
- "__schema": "InferenceTypeSchema",
228
+ {
229
+ "__schema": "VariableLikeSchema",
231
230
  "location": {
232
231
  "filePath": "api-reference.ui.runtime.tsx",
233
232
  "line": 55,
234
233
  "character": 3
235
234
  },
236
- "type": "({ componentId }: {\n componentId: string;\n}) => React.JSX.Element"
237
- },
238
- "isOptional": true,
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 }"
240
- },
241
- {
242
- "__schema": "FunctionLikeSchema",
243
- "location": {
244
- "filePath": "api-reference.ui.runtime.tsx",
245
- "line": 63,
246
- "character": 3
247
- },
248
- "signature": "(method) APIReferenceUI.registerSchemaClass(schema: SchemaNodeConstructor): void",
249
- "name": "registerSchemaClass",
250
- "params": [
251
- {
252
- "__schema": "ParameterSchema",
235
+ "signature": "(property) APIReferenceUI.TaggedAPIPage: ({ componentId }: {\n componentId: string;\n}) => React.JSX.Element",
236
+ "name": "TaggedAPIPage",
237
+ "type": {
238
+ "__schema": "InferenceTypeSchema",
253
239
  "location": {
254
240
  "filePath": "api-reference.ui.runtime.tsx",
255
- "line": 63,
256
- "character": 23
241
+ "line": 55,
242
+ "character": 3
257
243
  },
258
- "name": "schema",
259
- "type": {
260
- "__schema": "TypeRefSchema",
244
+ "type": "({ componentId }: {\n componentId: string;\n}) => React.JSX.Element"
245
+ },
246
+ "isOptional": true,
247
+ "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 }"
248
+ },
249
+ {
250
+ "__schema": "FunctionLikeSchema",
251
+ "location": {
252
+ "filePath": "api-reference.ui.runtime.tsx",
253
+ "line": 63,
254
+ "character": 3
255
+ },
256
+ "signature": "(method) APIReferenceUI.registerSchemaClass(schema: SchemaNodeConstructor): void",
257
+ "name": "registerSchemaClass",
258
+ "params": [
259
+ {
260
+ "__schema": "ParameterSchema",
261
261
  "location": {
262
262
  "filePath": "api-reference.ui.runtime.tsx",
263
263
  "line": 63,
264
- "character": 31
264
+ "character": 23
265
265
  },
266
- "name": "SchemaNodeConstructor",
267
- "componentId": {
268
- "scope": "teambit.semantics",
269
- "name": "entities/semantic-schema",
270
- "version": "0.0.68"
271
- }
266
+ "name": "schema",
267
+ "type": {
268
+ "__schema": "TypeRefSchema",
269
+ "location": {
270
+ "filePath": "api-reference.ui.runtime.tsx",
271
+ "line": 63,
272
+ "character": 31
273
+ },
274
+ "name": "SchemaNodeConstructor",
275
+ "componentId": {
276
+ "scope": "teambit.semantics",
277
+ "name": "entities/semantic-schema",
278
+ "version": "0.0.69"
279
+ }
280
+ },
281
+ "isOptional": false,
282
+ "isSpread": false
283
+ }
284
+ ],
285
+ "returnType": {
286
+ "__schema": "InferenceTypeSchema",
287
+ "location": {
288
+ "filePath": "api-reference.ui.runtime.tsx",
289
+ "line": 63,
290
+ "character": 3
272
291
  },
273
- "isOptional": false,
274
- "isSpread": false
275
- }
276
- ],
277
- "returnType": {
278
- "__schema": "InferenceTypeSchema",
279
- "location": {
280
- "filePath": "api-reference.ui.runtime.tsx",
281
- "line": 63,
282
- "character": 3
292
+ "type": "void"
283
293
  },
284
- "type": "void"
285
- },
286
- "modifiers": []
287
- },
288
- {
289
- "__schema": "FunctionLikeSchema",
290
- "location": {
291
- "filePath": "api-reference.ui.runtime.tsx",
292
- "line": 67,
293
- "character": 3
294
+ "modifiers": []
294
295
  },
295
- "signature": "(method) APIReferenceUI.getSchemaClasses(): () => Record<string, SchemaNodeConstructor>",
296
- "name": "getSchemaClasses",
297
- "params": [],
298
- "returnType": {
299
- "__schema": "InferenceTypeSchema",
296
+ {
297
+ "__schema": "FunctionLikeSchema",
300
298
  "location": {
301
299
  "filePath": "api-reference.ui.runtime.tsx",
302
300
  "line": 67,
303
301
  "character": 3
304
302
  },
305
- "type": "() => Record<string, SchemaNodeConstructor>"
306
- },
307
- "modifiers": []
308
- },
309
- {
310
- "__schema": "FunctionLikeSchema",
311
- "location": {
312
- "filePath": "api-reference.ui.runtime.tsx",
313
- "line": 71,
314
- "character": 3
315
- },
316
- "signature": "(method) APIReferenceUI.registerAPINodeRenderer(apiNodeRenderers: APINodeRenderer[]): void",
317
- "name": "registerAPINodeRenderer",
318
- "params": [
319
- {
320
- "__schema": "ParameterSchema",
303
+ "signature": "(method) APIReferenceUI.getSchemaClasses(): () => Record<string, SchemaNodeConstructor>",
304
+ "name": "getSchemaClasses",
305
+ "params": [],
306
+ "returnType": {
307
+ "__schema": "InferenceTypeSchema",
321
308
  "location": {
322
309
  "filePath": "api-reference.ui.runtime.tsx",
323
- "line": 71,
324
- "character": 27
310
+ "line": 67,
311
+ "character": 3
325
312
  },
326
- "name": "apiNodeRenderers",
327
- "type": {
328
- "__schema": "TypeArraySchema",
313
+ "type": "() => Record<string, SchemaNodeConstructor>"
314
+ },
315
+ "modifiers": []
316
+ },
317
+ {
318
+ "__schema": "FunctionLikeSchema",
319
+ "location": {
320
+ "filePath": "api-reference.ui.runtime.tsx",
321
+ "line": 71,
322
+ "character": 3
323
+ },
324
+ "signature": "(method) APIReferenceUI.registerAPINodeRenderer(apiNodeRenderers: APINodeRenderer[]): void",
325
+ "name": "registerAPINodeRenderer",
326
+ "params": [
327
+ {
328
+ "__schema": "ParameterSchema",
329
329
  "location": {
330
330
  "filePath": "api-reference.ui.runtime.tsx",
331
331
  "line": 71,
332
- "character": 45
332
+ "character": 27
333
333
  },
334
+ "name": "apiNodeRenderers",
334
335
  "type": {
335
- "__schema": "TypeRefSchema",
336
+ "__schema": "TypeArraySchema",
336
337
  "location": {
337
338
  "filePath": "api-reference.ui.runtime.tsx",
338
339
  "line": 71,
339
340
  "character": 45
340
341
  },
341
- "name": "APINodeRenderer",
342
- "componentId": {
343
- "scope": "teambit.api-reference",
344
- "name": "models/api-node-renderer",
345
- "version": "0.0.25"
342
+ "type": {
343
+ "__schema": "TypeRefSchema",
344
+ "location": {
345
+ "filePath": "api-reference.ui.runtime.tsx",
346
+ "line": 71,
347
+ "character": 45
348
+ },
349
+ "name": "APINodeRenderer",
350
+ "componentId": {
351
+ "scope": "teambit.api-reference",
352
+ "name": "models/api-node-renderer",
353
+ "version": "0.0.26"
354
+ }
346
355
  }
347
- }
356
+ },
357
+ "isOptional": false,
358
+ "isSpread": false
359
+ }
360
+ ],
361
+ "returnType": {
362
+ "__schema": "InferenceTypeSchema",
363
+ "location": {
364
+ "filePath": "api-reference.ui.runtime.tsx",
365
+ "line": 71,
366
+ "character": 3
348
367
  },
349
- "isOptional": false,
350
- "isSpread": false
351
- }
352
- ],
353
- "returnType": {
354
- "__schema": "InferenceTypeSchema",
355
- "location": {
356
- "filePath": "api-reference.ui.runtime.tsx",
357
- "line": 71,
358
- "character": 3
368
+ "type": "void"
359
369
  },
360
- "type": "void"
361
- },
362
- "modifiers": []
363
- },
364
- {
365
- "__schema": "VariableLikeSchema",
366
- "location": {
367
- "filePath": "api-reference.ui.runtime.tsx",
368
- "line": 75,
369
- "character": 3
370
+ "modifiers": []
370
371
  },
371
- "signature": "(property) APIReferenceUI.apiNodeRenderers: APINodeRenderer[]",
372
- "name": "apiNodeRenderers",
373
- "type": {
374
- "__schema": "TypeArraySchema",
372
+ {
373
+ "__schema": "VariableLikeSchema",
375
374
  "location": {
376
375
  "filePath": "api-reference.ui.runtime.tsx",
377
376
  "line": 75,
378
- "character": 21
377
+ "character": 3
379
378
  },
379
+ "signature": "(property) APIReferenceUI.apiNodeRenderers: APINodeRenderer[]",
380
+ "name": "apiNodeRenderers",
380
381
  "type": {
381
- "__schema": "TypeRefSchema",
382
+ "__schema": "TypeArraySchema",
382
383
  "location": {
383
384
  "filePath": "api-reference.ui.runtime.tsx",
384
385
  "line": 75,
385
386
  "character": 21
386
387
  },
387
- "name": "APINodeRenderer",
388
- "componentId": {
389
- "scope": "teambit.api-reference",
390
- "name": "models/api-node-renderer",
391
- "version": "0.0.25"
388
+ "type": {
389
+ "__schema": "TypeRefSchema",
390
+ "location": {
391
+ "filePath": "api-reference.ui.runtime.tsx",
392
+ "line": 75,
393
+ "character": 21
394
+ },
395
+ "name": "APINodeRenderer",
396
+ "componentId": {
397
+ "scope": "teambit.api-reference",
398
+ "name": "models/api-node-renderer",
399
+ "version": "0.0.26"
400
+ }
392
401
  }
393
- }
394
- },
395
- "isOptional": true,
396
- "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 ]"
397
- },
398
- {
399
- "__schema": "FunctionLikeSchema",
400
- "location": {
401
- "filePath": "api-reference.ui.runtime.tsx",
402
- "line": 94,
403
- "character": 3
402
+ },
403
+ "isOptional": true,
404
+ "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 ]"
404
405
  },
405
- "signature": "(method) APIReferenceUI.provider([componentUI, codeUI, workspaceUI]: [ComponentUI, CodeUI, WorkspaceUI], _: any, [apiNodeRendererSlot]: [APINodeRendererSlot], harmony: Harmony): Promise<APIReferenceUI>",
406
- "name": "provider",
407
- "params": [
408
- {
409
- "__schema": "ParameterSchema",
410
- "location": {
411
- "filePath": "api-reference.ui.runtime.tsx",
412
- "line": 95,
413
- "character": 5
414
- },
415
- "name": "[ componentUI, codeUI, workspaceUI ]",
416
- "type": {
417
- "__schema": "TupleTypeSchema",
406
+ {
407
+ "__schema": "FunctionLikeSchema",
408
+ "location": {
409
+ "filePath": "api-reference.ui.runtime.tsx",
410
+ "line": 94,
411
+ "character": 3
412
+ },
413
+ "signature": "(method) APIReferenceUI.provider([componentUI, codeUI, workspaceUI]: [ComponentUI, CodeUI, WorkspaceUI], _: any, [apiNodeRendererSlot]: [APINodeRendererSlot], harmony: Harmony): Promise<APIReferenceUI>",
414
+ "name": "provider",
415
+ "params": [
416
+ {
417
+ "__schema": "ParameterSchema",
418
418
  "location": {
419
419
  "filePath": "api-reference.ui.runtime.tsx",
420
420
  "line": 95,
421
- "character": 41
421
+ "character": 5
422
422
  },
423
- "elements": [
424
- {
425
- "__schema": "TypeRefSchema",
426
- "location": {
427
- "filePath": "api-reference.ui.runtime.tsx",
428
- "line": 95,
429
- "character": 42
430
- },
431
- "name": "ComponentUI",
432
- "componentId": {
433
- "scope": "teambit.component",
434
- "name": "component"
435
- }
423
+ "name": "[ componentUI, codeUI, workspaceUI ]",
424
+ "type": {
425
+ "__schema": "TupleTypeSchema",
426
+ "location": {
427
+ "filePath": "api-reference.ui.runtime.tsx",
428
+ "line": 95,
429
+ "character": 41
436
430
  },
437
- {
438
- "__schema": "TypeRefSchema",
439
- "location": {
440
- "filePath": "api-reference.ui.runtime.tsx",
441
- "line": 95,
442
- "character": 55
431
+ "elements": [
432
+ {
433
+ "__schema": "TypeRefSchema",
434
+ "location": {
435
+ "filePath": "api-reference.ui.runtime.tsx",
436
+ "line": 95,
437
+ "character": 42
438
+ },
439
+ "name": "ComponentUI",
440
+ "componentId": {
441
+ "scope": "teambit.component",
442
+ "name": "component"
443
+ }
443
444
  },
444
- "name": "CodeUI",
445
- "componentId": {
446
- "scope": "teambit.component",
447
- "name": "code"
448
- }
449
- },
450
- {
451
- "__schema": "TypeRefSchema",
452
- "location": {
453
- "filePath": "api-reference.ui.runtime.tsx",
454
- "line": 95,
455
- "character": 63
445
+ {
446
+ "__schema": "TypeRefSchema",
447
+ "location": {
448
+ "filePath": "api-reference.ui.runtime.tsx",
449
+ "line": 95,
450
+ "character": 55
451
+ },
452
+ "name": "CodeUI",
453
+ "componentId": {
454
+ "scope": "teambit.component",
455
+ "name": "code"
456
+ }
456
457
  },
457
- "name": "WorkspaceUI",
458
- "componentId": {
459
- "scope": "teambit.workspace",
460
- "name": "workspace"
458
+ {
459
+ "__schema": "TypeRefSchema",
460
+ "location": {
461
+ "filePath": "api-reference.ui.runtime.tsx",
462
+ "line": 95,
463
+ "character": 63
464
+ },
465
+ "name": "WorkspaceUI",
466
+ "componentId": {
467
+ "scope": "teambit.workspace",
468
+ "name": "workspace"
469
+ }
461
470
  }
462
- }
463
- ]
464
- },
465
- "isOptional": false,
466
- "isSpread": false
467
- },
468
- {
469
- "__schema": "ParameterSchema",
470
- "location": {
471
- "filePath": "api-reference.ui.runtime.tsx",
472
- "line": 96,
473
- "character": 5
471
+ ]
472
+ },
473
+ "isOptional": false,
474
+ "isSpread": false
474
475
  },
475
- "name": "_",
476
- "type": {
477
- "__schema": "InferenceTypeSchema",
476
+ {
477
+ "__schema": "ParameterSchema",
478
478
  "location": {
479
479
  "filePath": "api-reference.ui.runtime.tsx",
480
480
  "line": 96,
481
481
  "character": 5
482
482
  },
483
- "type": "any"
484
- },
485
- "isOptional": false,
486
- "isSpread": false
487
- },
488
- {
489
- "__schema": "ParameterSchema",
490
- "location": {
491
- "filePath": "api-reference.ui.runtime.tsx",
492
- "line": 97,
493
- "character": 5
483
+ "name": "_",
484
+ "type": {
485
+ "__schema": "InferenceTypeSchema",
486
+ "location": {
487
+ "filePath": "api-reference.ui.runtime.tsx",
488
+ "line": 96,
489
+ "character": 5
490
+ },
491
+ "type": "any"
492
+ },
493
+ "isOptional": false,
494
+ "isSpread": false
494
495
  },
495
- "name": "[ apiNodeRendererSlot ]",
496
- "type": {
497
- "__schema": "TupleTypeSchema",
496
+ {
497
+ "__schema": "ParameterSchema",
498
498
  "location": {
499
499
  "filePath": "api-reference.ui.runtime.tsx",
500
500
  "line": 97,
501
- "character": 28
501
+ "character": 5
502
502
  },
503
- "elements": [
504
- {
505
- "__schema": "TypeRefSchema",
506
- "location": {
507
- "filePath": "api-reference.ui.runtime.tsx",
508
- "line": 97,
509
- "character": 29
510
- },
511
- "name": "APINodeRendererSlot"
512
- }
513
- ]
514
- },
515
- "isOptional": false,
516
- "isSpread": false
517
- },
518
- {
519
- "__schema": "ParameterSchema",
520
- "location": {
521
- "filePath": "api-reference.ui.runtime.tsx",
522
- "line": 98,
523
- "character": 5
503
+ "name": "[ apiNodeRendererSlot ]",
504
+ "type": {
505
+ "__schema": "TupleTypeSchema",
506
+ "location": {
507
+ "filePath": "api-reference.ui.runtime.tsx",
508
+ "line": 97,
509
+ "character": 28
510
+ },
511
+ "elements": [
512
+ {
513
+ "__schema": "TypeRefSchema",
514
+ "location": {
515
+ "filePath": "api-reference.ui.runtime.tsx",
516
+ "line": 97,
517
+ "character": 29
518
+ },
519
+ "name": "APINodeRendererSlot"
520
+ }
521
+ ]
522
+ },
523
+ "isOptional": false,
524
+ "isSpread": false
524
525
  },
525
- "name": "harmony",
526
- "type": {
527
- "__schema": "TypeRefSchema",
526
+ {
527
+ "__schema": "ParameterSchema",
528
528
  "location": {
529
529
  "filePath": "api-reference.ui.runtime.tsx",
530
530
  "line": 98,
531
- "character": 14
531
+ "character": 5
532
532
  },
533
- "name": "Harmony",
534
- "componentId": {
535
- "scope": "teambit.harmony",
536
- "name": "harmony",
537
- "version": "0.4.6"
538
- }
533
+ "name": "harmony",
534
+ "type": {
535
+ "__schema": "TypeRefSchema",
536
+ "location": {
537
+ "filePath": "api-reference.ui.runtime.tsx",
538
+ "line": 98,
539
+ "character": 14
540
+ },
541
+ "name": "Harmony",
542
+ "componentId": {
543
+ "scope": "teambit.harmony",
544
+ "name": "harmony",
545
+ "version": "0.4.6"
546
+ }
547
+ },
548
+ "isOptional": false,
549
+ "isSpread": false
550
+ }
551
+ ],
552
+ "returnType": {
553
+ "__schema": "InferenceTypeSchema",
554
+ "location": {
555
+ "filePath": "api-reference.ui.runtime.tsx",
556
+ "line": 94,
557
+ "character": 3
539
558
  },
540
- "isOptional": false,
541
- "isSpread": false
542
- }
543
- ],
544
- "returnType": {
545
- "__schema": "InferenceTypeSchema",
546
- "location": {
547
- "filePath": "api-reference.ui.runtime.tsx",
548
- "line": 94,
549
- "character": 3
559
+ "type": "Promise<APIReferenceUI>"
550
560
  },
551
- "type": "Promise<APIReferenceUI>"
552
- },
553
- "modifiers": [
554
- "static",
555
- "async"
556
- ]
557
- }
558
- ],
559
- "extendsNodes": [],
560
- "implementNodes": []
561
+ "modifiers": [
562
+ "static",
563
+ "async"
564
+ ]
565
+ }
566
+ ],
567
+ "extendsNodes": [],
568
+ "implementNodes": []
569
+ }
561
570
  },
562
571
  {
563
- "__schema": "TypeSchema",
572
+ "__schema": "ExportSchema",
564
573
  "location": {
565
- "filePath": "api-reference.ui.runtime.tsx",
566
- "line": 33,
567
- "character": 1
574
+ "filePath": "index.ts",
575
+ "line": 3,
576
+ "character": 31
568
577
  },
569
- "signature": "type APINodeRendererSlot = SlotRegistry<APINodeRenderer[]>",
570
578
  "name": "APINodeRendererSlot",
571
- "type": {
572
- "__schema": "TypeRefSchema",
579
+ "exportNode": {
580
+ "__schema": "TypeSchema",
573
581
  "location": {
574
582
  "filePath": "api-reference.ui.runtime.tsx",
575
583
  "line": 33,
576
- "character": 35
577
- },
578
- "name": "SlotRegistry",
579
- "componentId": {
580
- "scope": "teambit.harmony",
581
- "name": "harmony",
582
- "version": "0.4.6"
584
+ "character": 1
583
585
  },
584
- "typeArgs": [
585
- {
586
- "__schema": "TypeArraySchema",
587
- "location": {
588
- "filePath": "api-reference.ui.runtime.tsx",
589
- "line": 33,
590
- "character": 48
591
- },
592
- "type": {
593
- "__schema": "TypeRefSchema",
586
+ "signature": "type APINodeRendererSlot = SlotRegistry<APINodeRenderer[]>",
587
+ "name": "APINodeRendererSlot",
588
+ "type": {
589
+ "__schema": "TypeRefSchema",
590
+ "location": {
591
+ "filePath": "api-reference.ui.runtime.tsx",
592
+ "line": 33,
593
+ "character": 35
594
+ },
595
+ "name": "SlotRegistry",
596
+ "componentId": {
597
+ "scope": "teambit.harmony",
598
+ "name": "harmony",
599
+ "version": "0.4.6"
600
+ },
601
+ "typeArgs": [
602
+ {
603
+ "__schema": "TypeArraySchema",
594
604
  "location": {
595
605
  "filePath": "api-reference.ui.runtime.tsx",
596
606
  "line": 33,
597
607
  "character": 48
598
608
  },
599
- "name": "APINodeRenderer",
600
- "componentId": {
601
- "scope": "teambit.api-reference",
602
- "name": "models/api-node-renderer",
603
- "version": "0.0.25"
609
+ "type": {
610
+ "__schema": "TypeRefSchema",
611
+ "location": {
612
+ "filePath": "api-reference.ui.runtime.tsx",
613
+ "line": 33,
614
+ "character": 48
615
+ },
616
+ "name": "APINodeRenderer",
617
+ "componentId": {
618
+ "scope": "teambit.api-reference",
619
+ "name": "models/api-node-renderer",
620
+ "version": "0.0.26"
621
+ }
604
622
  }
605
623
  }
606
- }
607
- ]
624
+ ]
625
+ }
608
626
  }
609
627
  },
610
628
  {
@@ -618,30 +636,39 @@
618
636
  "type": "Identifier"
619
637
  },
620
638
  {
621
- "__schema": "VariableLikeSchema",
639
+ "__schema": "ExportSchema",
622
640
  "location": {
623
- "filePath": "api-reference.aspect.ts",
624
- "line": 3,
625
- "character": 14
641
+ "filePath": "index.ts",
642
+ "line": 5,
643
+ "character": 10
626
644
  },
627
- "signature": "const APIReferenceAspect: Aspect",
628
645
  "name": "APIReferenceAspect",
629
- "type": {
630
- "__schema": "TypeRefSchema",
646
+ "exportNode": {
647
+ "__schema": "VariableLikeSchema",
631
648
  "location": {
632
649
  "filePath": "api-reference.aspect.ts",
633
650
  "line": 3,
634
651
  "character": 14
635
652
  },
636
- "name": "Aspect",
637
- "componentId": {
638
- "scope": "teambit.harmony",
639
- "name": "harmony",
640
- "version": "0.4.6"
641
- }
642
- },
643
- "isOptional": false,
644
- "defaultValue": "Aspect.create({\n id: 'teambit.api-reference/api-reference',\n})"
653
+ "signature": "const APIReferenceAspect: Aspect",
654
+ "name": "APIReferenceAspect",
655
+ "type": {
656
+ "__schema": "TypeRefSchema",
657
+ "location": {
658
+ "filePath": "api-reference.aspect.ts",
659
+ "line": 3,
660
+ "character": 14
661
+ },
662
+ "name": "Aspect",
663
+ "componentId": {
664
+ "scope": "teambit.harmony",
665
+ "name": "harmony",
666
+ "version": "0.4.6"
667
+ }
668
+ },
669
+ "isOptional": false,
670
+ "defaultValue": "Aspect.create({\n id: 'teambit.api-reference/api-reference',\n})"
671
+ }
645
672
  }
646
673
  ],
647
674
  "internals": []
@@ -696,7 +723,7 @@
696
723
  "componentId": {
697
724
  "scope": "teambit.api-reference",
698
725
  "name": "models/api-node-renderer",
699
- "version": "0.0.25"
726
+ "version": "0.0.26"
700
727
  }
701
728
  }
702
729
  }
@@ -957,7 +984,7 @@
957
984
  "componentId": {
958
985
  "scope": "teambit.semantics",
959
986
  "name": "entities/semantic-schema",
960
- "version": "0.0.68"
987
+ "version": "0.0.69"
961
988
  }
962
989
  },
963
990
  "isOptional": false,
@@ -1032,7 +1059,7 @@
1032
1059
  "componentId": {
1033
1060
  "scope": "teambit.api-reference",
1034
1061
  "name": "models/api-node-renderer",
1035
- "version": "0.0.25"
1062
+ "version": "0.0.26"
1036
1063
  }
1037
1064
  }
1038
1065
  },
@@ -1078,7 +1105,7 @@
1078
1105
  "componentId": {
1079
1106
  "scope": "teambit.api-reference",
1080
1107
  "name": "models/api-node-renderer",
1081
- "version": "0.0.25"
1108
+ "version": "0.0.26"
1082
1109
  }
1083
1110
  }
1084
1111
  },
@@ -1324,7 +1351,7 @@
1324
1351
  "componentId": {
1325
1352
  "scope": "teambit.api-reference",
1326
1353
  "name": "api-reference",
1327
- "version": "1.0.257"
1354
+ "version": "1.0.259"
1328
1355
  },
1329
1356
  "taggedModuleExports": []
1330
1357
  }
package/package.json CHANGED
@@ -1,42 +1,42 @@
1
1
  {
2
2
  "name": "@teambit/api-reference",
3
- "version": "1.0.257",
3
+ "version": "1.0.259",
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.257"
9
+ "version": "1.0.259"
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.8",
15
- "@teambit/api-reference.models.api-node-renderer": "0.0.25",
16
- "@teambit/api-reference.renderers.class": "0.0.41",
17
- "@teambit/api-reference.renderers.decorator": "0.0.2",
18
- "@teambit/api-reference.renderers.enum": "0.0.41",
19
- "@teambit/api-reference.renderers.function": "0.0.44",
20
- "@teambit/api-reference.renderers.inference-type": "0.0.27",
21
- "@teambit/api-reference.renderers.interface": "0.0.41",
22
- "@teambit/api-reference.renderers.parameter": "0.0.35",
23
- "@teambit/api-reference.renderers.this": "0.0.29",
24
- "@teambit/api-reference.renderers.type-array": "0.0.27",
25
- "@teambit/api-reference.renderers.type-intersection": "0.0.27",
26
- "@teambit/api-reference.renderers.type-literal": "0.0.36",
27
- "@teambit/api-reference.renderers.type-ref": "0.0.57",
28
- "@teambit/api-reference.renderers.type-union": "0.0.27",
29
- "@teambit/api-reference.renderers.type": "0.0.40",
30
- "@teambit/api-reference.renderers.unresolved": "0.0.40",
31
- "@teambit/api-reference.renderers.variable": "0.0.40",
32
- "@teambit/api-reference.sections.api-reference-page": "0.0.66",
14
+ "@teambit/api-reference.hooks.use-api-renderers": "0.0.9",
15
+ "@teambit/api-reference.models.api-node-renderer": "0.0.26",
16
+ "@teambit/api-reference.renderers.class": "0.0.42",
17
+ "@teambit/api-reference.renderers.decorator": "0.0.3",
18
+ "@teambit/api-reference.renderers.enum": "0.0.42",
19
+ "@teambit/api-reference.renderers.function": "0.0.45",
20
+ "@teambit/api-reference.renderers.inference-type": "0.0.28",
21
+ "@teambit/api-reference.renderers.interface": "0.0.42",
22
+ "@teambit/api-reference.renderers.parameter": "0.0.36",
23
+ "@teambit/api-reference.renderers.this": "0.0.30",
24
+ "@teambit/api-reference.renderers.type-array": "0.0.28",
25
+ "@teambit/api-reference.renderers.type-intersection": "0.0.28",
26
+ "@teambit/api-reference.renderers.type-literal": "0.0.37",
27
+ "@teambit/api-reference.renderers.type-ref": "0.0.58",
28
+ "@teambit/api-reference.renderers.type-union": "0.0.28",
29
+ "@teambit/api-reference.renderers.type": "0.0.41",
30
+ "@teambit/api-reference.renderers.unresolved": "0.0.41",
31
+ "@teambit/api-reference.renderers.variable": "0.0.41",
32
+ "@teambit/api-reference.sections.api-reference-page": "0.0.67",
33
33
  "@teambit/api-reference.sections.api-reference-section": "0.0.14",
34
- "@teambit/code": "1.0.257",
35
- "@teambit/component": "1.0.257",
36
- "@teambit/semantics.entities.semantic-schema": "0.0.68",
37
- "@teambit/tagged-exports": "0.0.11",
38
- "@teambit/ui": "1.0.257",
39
- "@teambit/workspace": "1.0.257"
34
+ "@teambit/code": "1.0.259",
35
+ "@teambit/component": "1.0.259",
36
+ "@teambit/semantics.entities.semantic-schema": "0.0.69",
37
+ "@teambit/tagged-exports": "0.0.12",
38
+ "@teambit/ui": "1.0.259",
39
+ "@teambit/workspace": "1.0.259"
40
40
  },
41
41
  "devDependencies": {
42
42
  "@types/lodash": "4.14.165",