@xyo-network/react-schema 2.25.12 → 2.25.15

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 (2) hide show
  1. package/dist/docs.json +695 -0
  2. package/package.json +12 -5
package/dist/docs.json ADDED
@@ -0,0 +1,695 @@
1
+ {
2
+ "id": 0,
3
+ "name": "@xyo-network/react-schema",
4
+ "kind": 1,
5
+ "kindString": "Project",
6
+ "flags": {},
7
+ "originalName": "",
8
+ "children": [
9
+ {
10
+ "id": 16,
11
+ "name": "SchemaContextState",
12
+ "kind": 256,
13
+ "kindString": "Interface",
14
+ "flags": {},
15
+ "children": [
16
+ {
17
+ "id": 21,
18
+ "name": "provided",
19
+ "kind": 1024,
20
+ "kindString": "Property",
21
+ "flags": {},
22
+ "sources": [
23
+ {
24
+ "fileName": "shared/dist/esm/contexts/contextEx/State.d.ts",
25
+ "line": 2,
26
+ "character": 4
27
+ }
28
+ ],
29
+ "type": {
30
+ "type": "intrinsic",
31
+ "name": "boolean"
32
+ },
33
+ "inheritedFrom": {
34
+ "type": "reference",
35
+ "name": "ContextExState.provided"
36
+ }
37
+ },
38
+ {
39
+ "id": 17,
40
+ "name": "schema",
41
+ "kind": 1024,
42
+ "kindString": "Property",
43
+ "flags": {
44
+ "isOptional": true
45
+ },
46
+ "comment": {
47
+ "tags": [
48
+ {
49
+ "tag": "field",
50
+ "text": "The currently selected XYO Schema"
51
+ }
52
+ ]
53
+ },
54
+ "sources": [
55
+ {
56
+ "fileName": "schema/src/contexts/Schema/State.ts",
57
+ "line": 6,
58
+ "character": 2
59
+ }
60
+ ],
61
+ "type": {
62
+ "type": "intrinsic",
63
+ "name": "string"
64
+ }
65
+ },
66
+ {
67
+ "id": 18,
68
+ "name": "schemaList",
69
+ "kind": 1024,
70
+ "kindString": "Property",
71
+ "flags": {
72
+ "isOptional": true
73
+ },
74
+ "comment": {
75
+ "tags": [
76
+ {
77
+ "tag": "field",
78
+ "text": "The list of known available schema"
79
+ }
80
+ ]
81
+ },
82
+ "sources": [
83
+ {
84
+ "fileName": "schema/src/contexts/Schema/State.ts",
85
+ "line": 8,
86
+ "character": 2
87
+ }
88
+ ],
89
+ "type": {
90
+ "type": "array",
91
+ "elementType": {
92
+ "type": "intrinsic",
93
+ "name": "string"
94
+ }
95
+ }
96
+ },
97
+ {
98
+ "id": 19,
99
+ "name": "setSchema",
100
+ "kind": 1024,
101
+ "kindString": "Property",
102
+ "flags": {
103
+ "isOptional": true
104
+ },
105
+ "comment": {
106
+ "tags": [
107
+ {
108
+ "tag": "field",
109
+ "text": "Function to set the selected Schema"
110
+ }
111
+ ]
112
+ },
113
+ "sources": [
114
+ {
115
+ "fileName": "schema/src/contexts/Schema/State.ts",
116
+ "line": 10,
117
+ "character": 2
118
+ }
119
+ ],
120
+ "type": {
121
+ "type": "reference",
122
+ "typeArguments": [
123
+ {
124
+ "type": "intrinsic",
125
+ "name": "string"
126
+ }
127
+ ],
128
+ "qualifiedName": "React.Dispatch",
129
+ "package": "@types/react",
130
+ "name": "Dispatch"
131
+ }
132
+ },
133
+ {
134
+ "id": 20,
135
+ "name": "setSchemaList",
136
+ "kind": 1024,
137
+ "kindString": "Property",
138
+ "flags": {
139
+ "isOptional": true
140
+ },
141
+ "comment": {
142
+ "tags": [
143
+ {
144
+ "tag": "field",
145
+ "text": "Function to set the list of known available schema"
146
+ }
147
+ ]
148
+ },
149
+ "sources": [
150
+ {
151
+ "fileName": "schema/src/contexts/Schema/State.ts",
152
+ "line": 12,
153
+ "character": 2
154
+ }
155
+ ],
156
+ "type": {
157
+ "type": "reference",
158
+ "typeArguments": [
159
+ {
160
+ "type": "array",
161
+ "elementType": {
162
+ "type": "intrinsic",
163
+ "name": "string"
164
+ }
165
+ }
166
+ ],
167
+ "qualifiedName": "React.Dispatch",
168
+ "package": "@types/react",
169
+ "name": "Dispatch"
170
+ }
171
+ }
172
+ ],
173
+ "groups": [
174
+ {
175
+ "title": "Properties",
176
+ "kind": 1024,
177
+ "children": [
178
+ 21,
179
+ 17,
180
+ 18,
181
+ 19,
182
+ 20
183
+ ]
184
+ }
185
+ ],
186
+ "sources": [
187
+ {
188
+ "fileName": "schema/src/contexts/Schema/State.ts",
189
+ "line": 4,
190
+ "character": 17
191
+ }
192
+ ],
193
+ "extendedTypes": [
194
+ {
195
+ "type": "reference",
196
+ "name": "ContextExState"
197
+ }
198
+ ]
199
+ },
200
+ {
201
+ "id": 12,
202
+ "name": "SchemaProviderProps",
203
+ "kind": 256,
204
+ "kindString": "Interface",
205
+ "flags": {},
206
+ "children": [
207
+ {
208
+ "id": 13,
209
+ "name": "defaultSchema",
210
+ "kind": 1024,
211
+ "kindString": "Property",
212
+ "flags": {
213
+ "isOptional": true
214
+ },
215
+ "sources": [
216
+ {
217
+ "fileName": "schema/src/contexts/Schema/Provider/Props.tsx",
218
+ "line": 2,
219
+ "character": 2
220
+ }
221
+ ],
222
+ "type": {
223
+ "type": "intrinsic",
224
+ "name": "string"
225
+ }
226
+ },
227
+ {
228
+ "id": 14,
229
+ "name": "knownSchemaList",
230
+ "kind": 1024,
231
+ "kindString": "Property",
232
+ "flags": {
233
+ "isOptional": true
234
+ },
235
+ "sources": [
236
+ {
237
+ "fileName": "schema/src/contexts/Schema/Provider/Props.tsx",
238
+ "line": 3,
239
+ "character": 2
240
+ }
241
+ ],
242
+ "type": {
243
+ "type": "array",
244
+ "elementType": {
245
+ "type": "intrinsic",
246
+ "name": "string"
247
+ }
248
+ }
249
+ }
250
+ ],
251
+ "groups": [
252
+ {
253
+ "title": "Properties",
254
+ "kind": 1024,
255
+ "children": [
256
+ 13,
257
+ 14
258
+ ]
259
+ }
260
+ ],
261
+ "sources": [
262
+ {
263
+ "fileName": "schema/src/contexts/Schema/Provider/Props.tsx",
264
+ "line": 1,
265
+ "character": 17
266
+ }
267
+ ]
268
+ },
269
+ {
270
+ "id": 1,
271
+ "name": "SchemaSelectExProps",
272
+ "kind": 4194304,
273
+ "kindString": "Type alias",
274
+ "flags": {},
275
+ "sources": [
276
+ {
277
+ "fileName": "schema/src/components/SelectEx/SchemaSelectEx.tsx",
278
+ "line": 6,
279
+ "character": 12
280
+ }
281
+ ],
282
+ "type": {
283
+ "type": "reference",
284
+ "typeArguments": [
285
+ {
286
+ "type": "intrinsic",
287
+ "name": "string"
288
+ }
289
+ ],
290
+ "qualifiedName": "SelectExProps",
291
+ "package": "@xylabs/sdk-react",
292
+ "name": "SelectExProps"
293
+ }
294
+ },
295
+ {
296
+ "id": 3,
297
+ "name": "SchemaContext",
298
+ "kind": 32,
299
+ "kindString": "Variable",
300
+ "flags": {
301
+ "isConst": true
302
+ },
303
+ "sources": [
304
+ {
305
+ "fileName": "schema/src/contexts/Schema/Context.ts",
306
+ "line": 5,
307
+ "character": 13
308
+ }
309
+ ],
310
+ "type": {
311
+ "type": "reference",
312
+ "typeArguments": [
313
+ {
314
+ "type": "intersection",
315
+ "types": [
316
+ {
317
+ "type": "reference",
318
+ "id": 16,
319
+ "name": "SchemaContextState"
320
+ },
321
+ {
322
+ "type": "reference",
323
+ "name": "ContextExState"
324
+ }
325
+ ]
326
+ }
327
+ ],
328
+ "qualifiedName": "React.Context",
329
+ "package": "@types/react",
330
+ "name": "Context"
331
+ },
332
+ "defaultValue": "..."
333
+ },
334
+ {
335
+ "id": 11,
336
+ "name": "SchemaMemoryProvider",
337
+ "kind": 32,
338
+ "kindString": "Variable",
339
+ "flags": {
340
+ "isConst": true
341
+ },
342
+ "sources": [
343
+ {
344
+ "fileName": "schema/src/contexts/Schema/Provider/Memory.tsx",
345
+ "line": 8,
346
+ "character": 13
347
+ }
348
+ ],
349
+ "type": {
350
+ "type": "reference",
351
+ "typeArguments": [
352
+ {
353
+ "type": "reference",
354
+ "typeArguments": [
355
+ {
356
+ "type": "reference",
357
+ "id": 12,
358
+ "name": "SchemaProviderProps"
359
+ }
360
+ ],
361
+ "qualifiedName": "WithChildren",
362
+ "package": "@xylabs/sdk-react",
363
+ "name": "WithChildren"
364
+ }
365
+ ],
366
+ "qualifiedName": "React.FC",
367
+ "package": "@types/react",
368
+ "name": "React.FC"
369
+ },
370
+ "defaultValue": "..."
371
+ },
372
+ {
373
+ "id": 15,
374
+ "name": "SchemaRouteProvider",
375
+ "kind": 32,
376
+ "kindString": "Variable",
377
+ "flags": {
378
+ "isConst": true
379
+ },
380
+ "sources": [
381
+ {
382
+ "fileName": "schema/src/contexts/Schema/Provider/Route.tsx",
383
+ "line": 56,
384
+ "character": 13
385
+ }
386
+ ],
387
+ "type": {
388
+ "type": "reference",
389
+ "typeArguments": [
390
+ {
391
+ "type": "reference",
392
+ "typeArguments": [
393
+ {
394
+ "type": "reference",
395
+ "id": 12,
396
+ "name": "SchemaProviderProps"
397
+ }
398
+ ],
399
+ "qualifiedName": "WithChildren",
400
+ "package": "@xylabs/sdk-react",
401
+ "name": "WithChildren"
402
+ }
403
+ ],
404
+ "qualifiedName": "React.FC",
405
+ "package": "@types/react",
406
+ "name": "React.FC"
407
+ },
408
+ "defaultValue": "..."
409
+ },
410
+ {
411
+ "id": 2,
412
+ "name": "SchemaSelectEx",
413
+ "kind": 32,
414
+ "kindString": "Variable",
415
+ "flags": {
416
+ "isConst": true
417
+ },
418
+ "sources": [
419
+ {
420
+ "fileName": "schema/src/components/SelectEx/SchemaSelectEx.tsx",
421
+ "line": 8,
422
+ "character": 13
423
+ }
424
+ ],
425
+ "type": {
426
+ "type": "reference",
427
+ "typeArguments": [
428
+ {
429
+ "type": "reference",
430
+ "id": 1,
431
+ "name": "SchemaSelectExProps"
432
+ }
433
+ ],
434
+ "qualifiedName": "React.FC",
435
+ "package": "@types/react",
436
+ "name": "React.FC"
437
+ },
438
+ "defaultValue": "..."
439
+ },
440
+ {
441
+ "id": 22,
442
+ "name": "useSchema",
443
+ "kind": 64,
444
+ "kindString": "Function",
445
+ "flags": {},
446
+ "sources": [
447
+ {
448
+ "fileName": "schema/src/contexts/Schema/use.ts",
449
+ "line": 6,
450
+ "character": 13
451
+ }
452
+ ],
453
+ "signatures": [
454
+ {
455
+ "id": 23,
456
+ "name": "useSchema",
457
+ "kind": 4096,
458
+ "kindString": "Call signature",
459
+ "flags": {},
460
+ "parameters": [
461
+ {
462
+ "id": 24,
463
+ "name": "required",
464
+ "kind": 32768,
465
+ "kindString": "Parameter",
466
+ "flags": {},
467
+ "type": {
468
+ "type": "intrinsic",
469
+ "name": "boolean"
470
+ },
471
+ "defaultValue": "false"
472
+ }
473
+ ],
474
+ "type": {
475
+ "type": "reference",
476
+ "typeArguments": [
477
+ {
478
+ "type": "reference",
479
+ "id": 16,
480
+ "name": "SchemaContextState"
481
+ },
482
+ {
483
+ "type": "literal",
484
+ "value": "provided"
485
+ }
486
+ ],
487
+ "qualifiedName": "Omit",
488
+ "package": "typescript",
489
+ "name": "Omit"
490
+ }
491
+ }
492
+ ]
493
+ },
494
+ {
495
+ "id": 4,
496
+ "name": "useSchemaDefinitions",
497
+ "kind": 64,
498
+ "kindString": "Function",
499
+ "flags": {},
500
+ "sources": [
501
+ {
502
+ "fileName": "schema/src/contexts/Schema/Hooks/useSchemaDefinitions.tsx",
503
+ "line": 8,
504
+ "character": 13
505
+ }
506
+ ],
507
+ "signatures": [
508
+ {
509
+ "id": 5,
510
+ "name": "useSchemaDefinitions",
511
+ "kind": 4096,
512
+ "kindString": "Call signature",
513
+ "flags": {},
514
+ "type": {
515
+ "type": "union",
516
+ "types": [
517
+ {
518
+ "type": "intrinsic",
519
+ "name": "undefined"
520
+ },
521
+ {
522
+ "type": "array",
523
+ "elementType": {
524
+ "type": "reference",
525
+ "qualifiedName": "XyoSchemaPayload",
526
+ "package": "@xyo-network/core",
527
+ "name": "XyoSchemaPayload"
528
+ }
529
+ }
530
+ ]
531
+ }
532
+ }
533
+ ]
534
+ },
535
+ {
536
+ "id": 6,
537
+ "name": "useSchemaList",
538
+ "kind": 64,
539
+ "kindString": "Function",
540
+ "flags": {},
541
+ "sources": [
542
+ {
543
+ "fileName": "schema/src/contexts/Schema/Hooks/useSchemaList.tsx",
544
+ "line": 6,
545
+ "character": 13
546
+ }
547
+ ],
548
+ "signatures": [
549
+ {
550
+ "id": 7,
551
+ "name": "useSchemaList",
552
+ "kind": 4096,
553
+ "kindString": "Call signature",
554
+ "flags": {},
555
+ "parameters": [
556
+ {
557
+ "id": 8,
558
+ "name": "knownSchemaList",
559
+ "kind": 32768,
560
+ "kindString": "Parameter",
561
+ "flags": {
562
+ "isOptional": true
563
+ },
564
+ "type": {
565
+ "type": "array",
566
+ "elementType": {
567
+ "type": "intrinsic",
568
+ "name": "string"
569
+ }
570
+ }
571
+ }
572
+ ],
573
+ "type": {
574
+ "type": "tuple",
575
+ "elements": [
576
+ {
577
+ "type": "union",
578
+ "types": [
579
+ {
580
+ "type": "intrinsic",
581
+ "name": "undefined"
582
+ },
583
+ {
584
+ "type": "array",
585
+ "elementType": {
586
+ "type": "intrinsic",
587
+ "name": "string"
588
+ }
589
+ }
590
+ ]
591
+ },
592
+ {
593
+ "type": "reference",
594
+ "typeArguments": [
595
+ {
596
+ "type": "array",
597
+ "elementType": {
598
+ "type": "intrinsic",
599
+ "name": "string"
600
+ }
601
+ }
602
+ ],
603
+ "qualifiedName": "React.Dispatch",
604
+ "package": "@types/react",
605
+ "name": "Dispatch"
606
+ }
607
+ ]
608
+ }
609
+ }
610
+ ]
611
+ },
612
+ {
613
+ "id": 9,
614
+ "name": "useSchemaStats",
615
+ "kind": 64,
616
+ "kindString": "Function",
617
+ "flags": {},
618
+ "sources": [
619
+ {
620
+ "fileName": "schema/src/contexts/Schema/Hooks/useSchemaStats.tsx",
621
+ "line": 7,
622
+ "character": 13
623
+ }
624
+ ],
625
+ "signatures": [
626
+ {
627
+ "id": 10,
628
+ "name": "useSchemaStats",
629
+ "kind": 4096,
630
+ "kindString": "Call signature",
631
+ "flags": {},
632
+ "type": {
633
+ "type": "union",
634
+ "types": [
635
+ {
636
+ "type": "intrinsic",
637
+ "name": "undefined"
638
+ },
639
+ {
640
+ "type": "reference",
641
+ "qualifiedName": "XyoArchivistArchivePayloadSchemaStats",
642
+ "package": "@xyo-network/api",
643
+ "name": "XyoArchivistArchivePayloadSchemaStats"
644
+ }
645
+ ]
646
+ }
647
+ }
648
+ ]
649
+ }
650
+ ],
651
+ "groups": [
652
+ {
653
+ "title": "Interfaces",
654
+ "kind": 256,
655
+ "children": [
656
+ 16,
657
+ 12
658
+ ]
659
+ },
660
+ {
661
+ "title": "Type aliases",
662
+ "kind": 4194304,
663
+ "children": [
664
+ 1
665
+ ]
666
+ },
667
+ {
668
+ "title": "Variables",
669
+ "kind": 32,
670
+ "children": [
671
+ 3,
672
+ 11,
673
+ 15,
674
+ 2
675
+ ]
676
+ },
677
+ {
678
+ "title": "Functions",
679
+ "kind": 64,
680
+ "children": [
681
+ 22,
682
+ 4,
683
+ 6,
684
+ 9
685
+ ]
686
+ }
687
+ ],
688
+ "sources": [
689
+ {
690
+ "fileName": "schema/src/index.ts",
691
+ "line": 1,
692
+ "character": 0
693
+ }
694
+ ]
695
+ }
package/package.json CHANGED
@@ -16,10 +16,10 @@
16
16
  "@xylabs/sdk-react": "^2.12.8",
17
17
  "@xyo-network/api": "^2.20.33",
18
18
  "@xyo-network/core": "^2.20.33",
19
- "@xyo-network/react-archive": "^2.25.12",
20
- "@xyo-network/react-archivist-api": "^2.25.12",
21
- "@xyo-network/react-shared": "^2.25.12",
22
- "@xyo-network/react-theme": "^2.25.12",
19
+ "@xyo-network/react-archive": "^2.25.15",
20
+ "@xyo-network/react-archivist-api": "^2.25.15",
21
+ "@xyo-network/react-shared": "^2.25.15",
22
+ "@xyo-network/react-theme": "^2.25.15",
23
23
  "@xyo-network/utils": "^2.20.33",
24
24
  "lodash": "^4.17.21",
25
25
  "react": "^18.1.0",
@@ -100,10 +100,17 @@
100
100
  },
101
101
  "scripts": {
102
102
  "lint-pkg": "npmPkgJsonLint .",
103
+ "gen:docs:package": "typedoc src/index.ts --json dist/docs.json",
104
+ "clean:package": "rimraf -q ./dist && rimraf -q ./build",
105
+ "fix:package": "yarn fix",
106
+ "lint:package": "yarn lint",
107
+ "deps:package": "depcheck $INIT_CWD",
108
+ "updo3:package": "yarn updo3",
109
+ "build:package": "yarn clean:package && tsc -p tsconfig.build.cjs.json && tsc -p tsconfig.build.esm.json && yarn gen:docs:package",
103
110
  "license": "yarn license-checker --exclude \"MIT, ISC, Apache-2.0, BSD, BSD-2-Clause, CC-BY-4.0, Unlicense, CC-BY-3.0, CC0-1.0\""
104
111
  },
105
112
  "sideEffects": false,
106
113
  "types": "dist/esm/index.d.ts",
107
- "version": "2.25.12",
114
+ "version": "2.25.15",
108
115
  "packageManager": "yarn@3.1.1"
109
116
  }