@xyo-network/react-network 2.25.11 → 2.25.14

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