@teambit/api-reference 1.0.228 → 1.0.230
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/artifacts/__bit_junit.xml +1 -1
- package/artifacts/schema.json +101 -17
- package/dist/api-reference.aspect.d.ts +3 -0
- package/dist/api-reference.ui.runtime.d.ts +25 -0
- package/dist/index.d.ts +4 -0
- package/package.json +6 -6
- package/tsconfig.json +1 -13
- /package/dist/{preview-1712805335812.js → preview-1712891953391.js} +0 -0
|
@@ -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.
|
|
3
|
+
<testsuite name="teambit.api-reference/api-reference@1.0.230" tests="0" failures="0" errors="0" skipped="0"/>
|
|
4
4
|
</testsuites>
|
package/artifacts/schema.json
CHANGED
|
@@ -88,7 +88,11 @@
|
|
|
88
88
|
"line": 34,
|
|
89
89
|
"character": 101
|
|
90
90
|
},
|
|
91
|
-
"name": "CodeUI"
|
|
91
|
+
"name": "CodeUI",
|
|
92
|
+
"componentId": {
|
|
93
|
+
"scope": "teambit.component",
|
|
94
|
+
"name": "code"
|
|
95
|
+
}
|
|
92
96
|
},
|
|
93
97
|
"isOptional": false,
|
|
94
98
|
"isSpread": false
|
|
@@ -235,7 +239,12 @@
|
|
|
235
239
|
"line": 57,
|
|
236
240
|
"character": 31
|
|
237
241
|
},
|
|
238
|
-
"name": "SchemaNodeConstructor"
|
|
242
|
+
"name": "SchemaNodeConstructor",
|
|
243
|
+
"componentId": {
|
|
244
|
+
"scope": "teambit.semantics",
|
|
245
|
+
"name": "entities/semantic-schema",
|
|
246
|
+
"version": "0.0.68"
|
|
247
|
+
}
|
|
239
248
|
},
|
|
240
249
|
"isOptional": false,
|
|
241
250
|
"isSpread": false
|
|
@@ -305,7 +314,12 @@
|
|
|
305
314
|
"line": 65,
|
|
306
315
|
"character": 45
|
|
307
316
|
},
|
|
308
|
-
"name": "APINodeRenderer"
|
|
317
|
+
"name": "APINodeRenderer",
|
|
318
|
+
"componentId": {
|
|
319
|
+
"scope": "teambit.api-reference",
|
|
320
|
+
"name": "models/api-node-renderer",
|
|
321
|
+
"version": "0.0.25"
|
|
322
|
+
}
|
|
309
323
|
}
|
|
310
324
|
},
|
|
311
325
|
"isOptional": false,
|
|
@@ -346,7 +360,12 @@
|
|
|
346
360
|
"line": 69,
|
|
347
361
|
"character": 21
|
|
348
362
|
},
|
|
349
|
-
"name": "APINodeRenderer"
|
|
363
|
+
"name": "APINodeRenderer",
|
|
364
|
+
"componentId": {
|
|
365
|
+
"scope": "teambit.api-reference",
|
|
366
|
+
"name": "models/api-node-renderer",
|
|
367
|
+
"version": "0.0.25"
|
|
368
|
+
}
|
|
350
369
|
}
|
|
351
370
|
},
|
|
352
371
|
"isOptional": true,
|
|
@@ -385,7 +404,11 @@
|
|
|
385
404
|
"line": 89,
|
|
386
405
|
"character": 29
|
|
387
406
|
},
|
|
388
|
-
"name": "ComponentUI"
|
|
407
|
+
"name": "ComponentUI",
|
|
408
|
+
"componentId": {
|
|
409
|
+
"scope": "teambit.component",
|
|
410
|
+
"name": "component"
|
|
411
|
+
}
|
|
389
412
|
},
|
|
390
413
|
{
|
|
391
414
|
"__schema": "TypeRefSchema",
|
|
@@ -394,7 +417,11 @@
|
|
|
394
417
|
"line": 89,
|
|
395
418
|
"character": 42
|
|
396
419
|
},
|
|
397
|
-
"name": "CodeUI"
|
|
420
|
+
"name": "CodeUI",
|
|
421
|
+
"componentId": {
|
|
422
|
+
"scope": "teambit.component",
|
|
423
|
+
"name": "code"
|
|
424
|
+
}
|
|
398
425
|
}
|
|
399
426
|
]
|
|
400
427
|
},
|
|
@@ -466,7 +493,12 @@
|
|
|
466
493
|
"line": 92,
|
|
467
494
|
"character": 14
|
|
468
495
|
},
|
|
469
|
-
"name": "Harmony"
|
|
496
|
+
"name": "Harmony",
|
|
497
|
+
"componentId": {
|
|
498
|
+
"scope": "teambit.harmony",
|
|
499
|
+
"name": "harmony",
|
|
500
|
+
"version": "0.4.6"
|
|
501
|
+
}
|
|
470
502
|
},
|
|
471
503
|
"isOptional": false,
|
|
472
504
|
"isSpread": false
|
|
@@ -507,6 +539,11 @@
|
|
|
507
539
|
"character": 35
|
|
508
540
|
},
|
|
509
541
|
"name": "SlotRegistry",
|
|
542
|
+
"componentId": {
|
|
543
|
+
"scope": "teambit.harmony",
|
|
544
|
+
"name": "harmony",
|
|
545
|
+
"version": "0.4.6"
|
|
546
|
+
},
|
|
510
547
|
"typeArgs": [
|
|
511
548
|
{
|
|
512
549
|
"__schema": "TypeArraySchema",
|
|
@@ -522,7 +559,12 @@
|
|
|
522
559
|
"line": 32,
|
|
523
560
|
"character": 48
|
|
524
561
|
},
|
|
525
|
-
"name": "APINodeRenderer"
|
|
562
|
+
"name": "APINodeRenderer",
|
|
563
|
+
"componentId": {
|
|
564
|
+
"scope": "teambit.api-reference",
|
|
565
|
+
"name": "models/api-node-renderer",
|
|
566
|
+
"version": "0.0.25"
|
|
567
|
+
}
|
|
526
568
|
}
|
|
527
569
|
}
|
|
528
570
|
]
|
|
@@ -593,6 +635,11 @@
|
|
|
593
635
|
"character": 35
|
|
594
636
|
},
|
|
595
637
|
"name": "SlotRegistry",
|
|
638
|
+
"componentId": {
|
|
639
|
+
"scope": "teambit.harmony",
|
|
640
|
+
"name": "harmony",
|
|
641
|
+
"version": "0.4.6"
|
|
642
|
+
},
|
|
596
643
|
"typeArgs": [
|
|
597
644
|
{
|
|
598
645
|
"__schema": "TypeArraySchema",
|
|
@@ -608,7 +655,12 @@
|
|
|
608
655
|
"line": 32,
|
|
609
656
|
"character": 48
|
|
610
657
|
},
|
|
611
|
-
"name": "APINodeRenderer"
|
|
658
|
+
"name": "APINodeRenderer",
|
|
659
|
+
"componentId": {
|
|
660
|
+
"scope": "teambit.api-reference",
|
|
661
|
+
"name": "models/api-node-renderer",
|
|
662
|
+
"version": "0.0.25"
|
|
663
|
+
}
|
|
612
664
|
}
|
|
613
665
|
}
|
|
614
666
|
]
|
|
@@ -689,7 +741,11 @@
|
|
|
689
741
|
"line": 34,
|
|
690
742
|
"character": 101
|
|
691
743
|
},
|
|
692
|
-
"name": "CodeUI"
|
|
744
|
+
"name": "CodeUI",
|
|
745
|
+
"componentId": {
|
|
746
|
+
"scope": "teambit.component",
|
|
747
|
+
"name": "code"
|
|
748
|
+
}
|
|
693
749
|
},
|
|
694
750
|
"isOptional": false,
|
|
695
751
|
"isSpread": false
|
|
@@ -836,7 +892,12 @@
|
|
|
836
892
|
"line": 57,
|
|
837
893
|
"character": 31
|
|
838
894
|
},
|
|
839
|
-
"name": "SchemaNodeConstructor"
|
|
895
|
+
"name": "SchemaNodeConstructor",
|
|
896
|
+
"componentId": {
|
|
897
|
+
"scope": "teambit.semantics",
|
|
898
|
+
"name": "entities/semantic-schema",
|
|
899
|
+
"version": "0.0.68"
|
|
900
|
+
}
|
|
840
901
|
},
|
|
841
902
|
"isOptional": false,
|
|
842
903
|
"isSpread": false
|
|
@@ -906,7 +967,12 @@
|
|
|
906
967
|
"line": 65,
|
|
907
968
|
"character": 45
|
|
908
969
|
},
|
|
909
|
-
"name": "APINodeRenderer"
|
|
970
|
+
"name": "APINodeRenderer",
|
|
971
|
+
"componentId": {
|
|
972
|
+
"scope": "teambit.api-reference",
|
|
973
|
+
"name": "models/api-node-renderer",
|
|
974
|
+
"version": "0.0.25"
|
|
975
|
+
}
|
|
910
976
|
}
|
|
911
977
|
},
|
|
912
978
|
"isOptional": false,
|
|
@@ -947,7 +1013,12 @@
|
|
|
947
1013
|
"line": 69,
|
|
948
1014
|
"character": 21
|
|
949
1015
|
},
|
|
950
|
-
"name": "APINodeRenderer"
|
|
1016
|
+
"name": "APINodeRenderer",
|
|
1017
|
+
"componentId": {
|
|
1018
|
+
"scope": "teambit.api-reference",
|
|
1019
|
+
"name": "models/api-node-renderer",
|
|
1020
|
+
"version": "0.0.25"
|
|
1021
|
+
}
|
|
951
1022
|
}
|
|
952
1023
|
},
|
|
953
1024
|
"isOptional": true,
|
|
@@ -986,7 +1057,11 @@
|
|
|
986
1057
|
"line": 89,
|
|
987
1058
|
"character": 29
|
|
988
1059
|
},
|
|
989
|
-
"name": "ComponentUI"
|
|
1060
|
+
"name": "ComponentUI",
|
|
1061
|
+
"componentId": {
|
|
1062
|
+
"scope": "teambit.component",
|
|
1063
|
+
"name": "component"
|
|
1064
|
+
}
|
|
990
1065
|
},
|
|
991
1066
|
{
|
|
992
1067
|
"__schema": "TypeRefSchema",
|
|
@@ -995,7 +1070,11 @@
|
|
|
995
1070
|
"line": 89,
|
|
996
1071
|
"character": 42
|
|
997
1072
|
},
|
|
998
|
-
"name": "CodeUI"
|
|
1073
|
+
"name": "CodeUI",
|
|
1074
|
+
"componentId": {
|
|
1075
|
+
"scope": "teambit.component",
|
|
1076
|
+
"name": "code"
|
|
1077
|
+
}
|
|
999
1078
|
}
|
|
1000
1079
|
]
|
|
1001
1080
|
},
|
|
@@ -1067,7 +1146,12 @@
|
|
|
1067
1146
|
"line": 92,
|
|
1068
1147
|
"character": 14
|
|
1069
1148
|
},
|
|
1070
|
-
"name": "Harmony"
|
|
1149
|
+
"name": "Harmony",
|
|
1150
|
+
"componentId": {
|
|
1151
|
+
"scope": "teambit.harmony",
|
|
1152
|
+
"name": "harmony",
|
|
1153
|
+
"version": "0.4.6"
|
|
1154
|
+
}
|
|
1071
1155
|
},
|
|
1072
1156
|
"isOptional": false,
|
|
1073
1157
|
"isSpread": false
|
|
@@ -1166,7 +1250,7 @@
|
|
|
1166
1250
|
"componentId": {
|
|
1167
1251
|
"scope": "teambit.api-reference",
|
|
1168
1252
|
"name": "api-reference",
|
|
1169
|
-
"version": "1.0.
|
|
1253
|
+
"version": "1.0.230"
|
|
1170
1254
|
},
|
|
1171
1255
|
"taggedModuleExports": []
|
|
1172
1256
|
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { ComponentUI } from '@teambit/component';
|
|
2
|
+
import { Harmony, SlotRegistry } from '@teambit/harmony';
|
|
3
|
+
import { APINodeRenderer } from '@teambit/api-reference.models.api-node-renderer';
|
|
4
|
+
import { SchemaNodeConstructor, SchemaRegistry } from '@teambit/semantics.entities.semantic-schema';
|
|
5
|
+
import { CodeUI } from '@teambit/code';
|
|
6
|
+
export type APINodeRendererSlot = SlotRegistry<APINodeRenderer[]>;
|
|
7
|
+
export declare class APIReferenceUI {
|
|
8
|
+
private host;
|
|
9
|
+
private apiNodeRendererSlot;
|
|
10
|
+
private code;
|
|
11
|
+
constructor(host: string, apiNodeRendererSlot: APINodeRendererSlot, code: CodeUI);
|
|
12
|
+
static dependencies: import("@teambit/harmony").Aspect[];
|
|
13
|
+
static runtime: import("@teambit/harmony").RuntimeDefinition;
|
|
14
|
+
static slots: ((registerFn: () => string) => SlotRegistry<APINodeRenderer[]>)[];
|
|
15
|
+
getAPIPage(): import("react/jsx-runtime").JSX.Element;
|
|
16
|
+
TaggedAPIPage: ({ componentId }: {
|
|
17
|
+
componentId: string;
|
|
18
|
+
}) => import("react/jsx-runtime").JSX.Element;
|
|
19
|
+
registerSchemaClass(schema: SchemaNodeConstructor): void;
|
|
20
|
+
getSchemaClasses(): typeof SchemaRegistry.schemas;
|
|
21
|
+
registerAPINodeRenderer(apiNodeRenderers: APINodeRenderer[]): void;
|
|
22
|
+
apiNodeRenderers: APINodeRenderer[];
|
|
23
|
+
static provider([componentUI, codeUI]: [ComponentUI, CodeUI], _: any, [apiNodeRendererSlot]: [APINodeRendererSlot], harmony: Harmony): Promise<APIReferenceUI>;
|
|
24
|
+
}
|
|
25
|
+
export default APIReferenceUI;
|
package/dist/index.d.ts
ADDED
package/package.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@teambit/api-reference",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.230",
|
|
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.
|
|
9
|
+
"version": "1.0.230"
|
|
10
10
|
},
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"lodash": "4.17.21",
|
|
@@ -31,17 +31,17 @@
|
|
|
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.
|
|
35
|
-
"@teambit/component": "1.0.
|
|
34
|
+
"@teambit/code": "1.0.230",
|
|
35
|
+
"@teambit/component": "1.0.230",
|
|
36
36
|
"@teambit/semantics.entities.semantic-schema": "0.0.68",
|
|
37
37
|
"@teambit/tagged-exports": "0.0.10",
|
|
38
|
-
"@teambit/ui": "1.0.
|
|
38
|
+
"@teambit/ui": "1.0.230"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
41
|
"@types/lodash": "4.14.165",
|
|
42
42
|
"@types/mocha": "9.1.0",
|
|
43
43
|
"chai": "4.3.0",
|
|
44
|
-
"@teambit/harmony.envs.core-aspect-env": "0.0.
|
|
44
|
+
"@teambit/harmony.envs.core-aspect-env": "0.0.33"
|
|
45
45
|
},
|
|
46
46
|
"peerDependencies": {
|
|
47
47
|
"react": "^17.0.0 || ^18.0.0",
|
package/tsconfig.json
CHANGED
|
@@ -20,8 +20,7 @@
|
|
|
20
20
|
"emitDeclarationOnly": true,
|
|
21
21
|
"strict": true,
|
|
22
22
|
"strictPropertyInitialization": false,
|
|
23
|
-
"noImplicitAny": false
|
|
24
|
-
"composite": true
|
|
23
|
+
"noImplicitAny": false
|
|
25
24
|
},
|
|
26
25
|
"exclude": [
|
|
27
26
|
"artifacts",
|
|
@@ -36,16 +35,5 @@
|
|
|
36
35
|
"include": [
|
|
37
36
|
"**/*",
|
|
38
37
|
"**/*.json"
|
|
39
|
-
],
|
|
40
|
-
"references": [
|
|
41
|
-
{
|
|
42
|
-
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_code@1.0.228"
|
|
43
|
-
},
|
|
44
|
-
{
|
|
45
|
-
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_component@1.0.228"
|
|
46
|
-
},
|
|
47
|
-
{
|
|
48
|
-
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.ui-foundation_ui@1.0.228"
|
|
49
|
-
}
|
|
50
38
|
]
|
|
51
39
|
}
|
|
File without changes
|