@xyo-network/payload-builder 5.3.24 → 5.3.26

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/README.md +1353 -10
  2. package/package.json +12 -12
package/README.md CHANGED
@@ -1,23 +1,1366 @@
1
+ [![logo][]](https://xyo.network)
2
+
1
3
  # @xyo-network/payload-builder
2
4
 
3
- [![logo][]](https://xyo.network)
5
+ [![npm][npm-badge]][npm-link]
6
+ [![license][license-badge]][license-link]
7
+
8
+ > Primary SDK for using XYO Protocol 2.0
9
+
10
+ ## Install
11
+
12
+ Using npm:
13
+
14
+ ```sh
15
+ npm install {{name}}
16
+ ```
17
+
18
+ Using yarn:
4
19
 
5
- Version: 5.0.2
20
+ ```sh
21
+ yarn add {{name}}
22
+ ```
6
23
 
7
- Primary SDK for using XYO Protocol 2.0
24
+ Using pnpm:
8
25
 
9
- ## Documentation
26
+ ```sh
27
+ pnpm add {{name}}
28
+ ```
10
29
 
11
- [TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__payload-builder)
30
+ Using bun:
31
+
32
+ ```sh
33
+ bun add {{name}}
34
+ ```
12
35
 
13
- Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
14
36
 
15
37
  ## License
16
38
 
17
- > See the [LICENSE](LICENSE) file for license details
39
+ See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
40
+
41
+ ## Reference
42
+
43
+ ### packages
44
+
45
+ ### protocol
46
+
47
+ ### packages
48
+
49
+ ### payload
50
+
51
+ ### packages
52
+
53
+ ### builder
54
+
55
+ ### .temp-typedoc
56
+
57
+ ### classes
58
+
59
+ ### <a id="PayloadBuilder"></a>PayloadBuilder
60
+
61
+ [**@xyo-network/payload-builder**](#../README)
62
+
63
+ ***
64
+
65
+ ## Type Parameters
66
+
67
+ ### T
68
+
69
+ `T` *extends* `Payload` = `Payload`\<`AnyObject`\>
70
+
71
+ ### R
72
+
73
+ `R` = `T`
74
+
75
+ ## Constructors
76
+
77
+ ### Constructor
78
+
79
+ ```ts
80
+ new PayloadBuilder<T, R>(options): PayloadBuilder<T, R>;
81
+ ```
82
+
83
+ ### Parameters
84
+
85
+ #### options
86
+
87
+ [`PayloadBuilderOptions`](#../interfaces/PayloadBuilderOptions)
88
+
89
+ ### Returns
90
+
91
+ `PayloadBuilder`\<`T`, `R`\>
92
+
93
+ ## Properties
94
+
95
+ ### options
96
+
97
+ ```ts
98
+ readonly options: PayloadBuilderOptions;
99
+ ```
100
+
101
+ ***
102
+
103
+ ### \_fields?
104
+
105
+ ```ts
106
+ protected optional _fields?: WithoutStorageMeta<WithoutClientMeta<WithoutSchema<T>>>;
107
+ ```
108
+
109
+ ***
110
+
111
+ ### \_meta?
112
+
113
+ ```ts
114
+ protected optional _meta?: DeepPickStartsWith<T, "$">;
115
+ ```
116
+
117
+ ***
118
+
119
+ ### \_schema
120
+
121
+ ```ts
122
+ protected _schema: Schema;
123
+ ```
124
+
125
+ ## Methods
126
+
127
+ ### addHashMeta()
128
+
129
+ ### Call Signature
130
+
131
+ ```ts
132
+ static addHashMeta<T>(payload): Promise<WithHashMeta<T>>;
133
+ ```
134
+
135
+ #### Type Parameters
136
+
137
+ ##### T
138
+
139
+ `T` *extends* `Payload`
140
+
141
+ #### Parameters
142
+
143
+ ##### payload
144
+
145
+ `T`
146
+
147
+ #### Returns
148
+
149
+ `Promise`\<`WithHashMeta`\<`T`\>\>
150
+
151
+ ### Call Signature
152
+
153
+ ```ts
154
+ static addHashMeta<T>(payloads): Promise<WithHashMeta<T>[]>;
155
+ ```
156
+
157
+ #### Type Parameters
158
+
159
+ ##### T
160
+
161
+ `T` *extends* `Payload`
162
+
163
+ #### Parameters
164
+
165
+ ##### payloads
166
+
167
+ `T`[]
168
+
169
+ #### Returns
170
+
171
+ `Promise`\<`WithHashMeta`\<`T`\>[]\>
172
+
173
+ ***
174
+
175
+ ### addStorageMeta()
176
+
177
+ ### Call Signature
178
+
179
+ ```ts
180
+ static addStorageMeta<T>(payload, index?): Promise<WithStorageMeta<T>>;
181
+ ```
182
+
183
+ #### Type Parameters
184
+
185
+ ##### T
186
+
187
+ `T` *extends* `Payload`
188
+
189
+ #### Parameters
190
+
191
+ ##### payload
192
+
193
+ `T`
194
+
195
+ ##### index?
196
+
197
+ `number`
198
+
199
+ #### Returns
200
+
201
+ `Promise`\<`WithStorageMeta`\<`T`\>\>
202
+
203
+ ### Call Signature
204
+
205
+ ```ts
206
+ static addStorageMeta<T>(payloads): Promise<WithStorageMeta<T>[]>;
207
+ ```
208
+
209
+ #### Type Parameters
210
+
211
+ ##### T
212
+
213
+ `T` *extends* `Payload`
214
+
215
+ #### Parameters
216
+
217
+ ##### payloads
218
+
219
+ `T`[]
220
+
221
+ #### Returns
222
+
223
+ `Promise`\<`WithStorageMeta`\<`T`\>[]\>
224
+
225
+ ***
226
+
227
+ ### compareStorageMeta()
228
+
229
+ ```ts
230
+ static compareStorageMeta(
231
+ a,
232
+ b,
233
+ comparer?): number;
234
+ ```
235
+
236
+ ### Parameters
237
+
238
+ #### a
239
+
240
+ `WithStorageMeta`\<`Payload`\>
241
+
242
+ #### b
243
+
244
+ `WithStorageMeta`\<`Payload`\>
245
+
246
+ #### comparer?
247
+
248
+ `Compare`\<`Sequence`\> = `SequenceComparer.local`
249
+
250
+ ### Returns
251
+
252
+ `number`
253
+
254
+ ***
255
+
256
+ ### dataHash()
257
+
258
+ ```ts
259
+ static dataHash<T>(payload): Promise<BrandedHash>;
260
+ ```
261
+
262
+ ### Type Parameters
263
+
264
+ #### T
265
+
266
+ `T` *extends* `Payload`
267
+
268
+ ### Parameters
269
+
270
+ #### payload
271
+
272
+ `T`
273
+
274
+ ### Returns
275
+
276
+ `Promise`\<`BrandedHash`\>
277
+
278
+ ***
279
+
280
+ ### dataHashPairs()
281
+
282
+ ```ts
283
+ static dataHashPairs<T>(payloads): Promise<[T, BrandedHash][]>;
284
+ ```
285
+
286
+ ### Type Parameters
287
+
288
+ #### T
289
+
290
+ `T` *extends* `Payload`
291
+
292
+ ### Parameters
293
+
294
+ #### payloads
295
+
296
+ `T`[]
297
+
298
+ ### Returns
299
+
300
+ `Promise`\<\[`T`, `BrandedHash`\][]\>
301
+
302
+ ***
303
+
304
+ ### dataHashableFields()
305
+
306
+ ```ts
307
+ static dataHashableFields<T>(schema, payload): Promisable<WithoutMeta<T>>;
308
+ ```
309
+
310
+ ### Type Parameters
311
+
312
+ #### T
313
+
314
+ `T` *extends* `Payload`
315
+
316
+ ### Parameters
317
+
318
+ #### schema
319
+
320
+ `Schema`
321
+
322
+ #### payload
323
+
324
+ `WithoutSchema`\<`T`\>
325
+
326
+ ### Returns
327
+
328
+ `Promisable`\<`WithoutMeta`\<`T`\>\>
329
+
330
+ ***
331
+
332
+ ### dataHashes()
333
+
334
+ ### Call Signature
335
+
336
+ ```ts
337
+ static dataHashes(payloads): Promise<undefined>;
338
+ ```
339
+
340
+ #### Parameters
341
+
342
+ ##### payloads
343
+
344
+ `undefined`
345
+
346
+ #### Returns
347
+
348
+ `Promise`\<`undefined`\>
349
+
350
+ ### Call Signature
351
+
352
+ ```ts
353
+ static dataHashes<T>(payloads): Promise<BrandedHash[]>;
354
+ ```
355
+
356
+ #### Type Parameters
357
+
358
+ ##### T
359
+
360
+ `T` *extends* `Payload`
361
+
362
+ #### Parameters
363
+
364
+ ##### payloads
365
+
366
+ `T`[]
367
+
368
+ #### Returns
369
+
370
+ `Promise`\<`BrandedHash`[]\>
371
+
372
+ ***
373
+
374
+ ### filterExclude()
375
+
376
+ ```ts
377
+ static filterExclude<T>(payloads?, hash): Promise<T[]>;
378
+ ```
379
+
380
+ ### Type Parameters
381
+
382
+ #### T
383
+
384
+ `T` *extends* `Payload`
385
+
386
+ ### Parameters
387
+
388
+ #### payloads?
389
+
390
+ `T`[] = `[]`
391
+
392
+ #### hash
393
+
394
+ `BrandedHash` \| `BrandedHash`[]
395
+
396
+ ### Returns
397
+
398
+ `Promise`\<`T`[]\>
399
+
400
+ ***
401
+
402
+ ### filterExcludeByDataHash()
403
+
404
+ ```ts
405
+ static filterExcludeByDataHash<T>(payloads?, hash): Promise<T[]>;
406
+ ```
407
+
408
+ ### Type Parameters
409
+
410
+ #### T
411
+
412
+ `T` *extends* `Payload`
413
+
414
+ ### Parameters
415
+
416
+ #### payloads?
417
+
418
+ `T`[] = `[]`
419
+
420
+ #### hash
421
+
422
+ `BrandedHash` \| `BrandedHash`[]
423
+
424
+ ### Returns
425
+
426
+ `Promise`\<`T`[]\>
427
+
428
+ ***
429
+
430
+ ### filterIncludeByDataHash()
431
+
432
+ ```ts
433
+ static filterIncludeByDataHash<T>(payloads?, hash): Promise<T[]>;
434
+ ```
435
+
436
+ ### Type Parameters
437
+
438
+ #### T
439
+
440
+ `T` *extends* `Payload`
441
+
442
+ ### Parameters
443
+
444
+ #### payloads?
445
+
446
+ `T`[] = `[]`
447
+
448
+ #### hash
449
+
450
+ `BrandedHash` \| `BrandedHash`[]
451
+
452
+ ### Returns
453
+
454
+ `Promise`\<`T`[]\>
455
+
456
+ ***
457
+
458
+ ### filterIncludeByEitherHash()
459
+
460
+ ```ts
461
+ static filterIncludeByEitherHash<T>(payloads?, hash): Promise<T[]>;
462
+ ```
463
+
464
+ ### Type Parameters
465
+
466
+ #### T
467
+
468
+ `T` *extends* `Payload`
469
+
470
+ ### Parameters
471
+
472
+ #### payloads?
473
+
474
+ `T`[] = `[]`
475
+
476
+ #### hash
477
+
478
+ `BrandedHash` \| `BrandedHash`[]
479
+
480
+ ### Returns
481
+
482
+ `Promise`\<`T`[]\>
483
+
484
+ ***
485
+
486
+ ### findByDataHash()
487
+
488
+ ```ts
489
+ static findByDataHash<T>(payloads?, hash): Promise<T | undefined>;
490
+ ```
491
+
492
+ ### Type Parameters
493
+
494
+ #### T
495
+
496
+ `T` *extends* `Payload`
497
+
498
+ ### Parameters
499
+
500
+ #### payloads?
501
+
502
+ `T`[] = `[]`
503
+
504
+ #### hash
505
+
506
+ `BrandedHash`
507
+
508
+ ### Returns
509
+
510
+ `Promise`\<`T` \| `undefined`\>
511
+
512
+ ***
513
+
514
+ ### hash()
515
+
516
+ ```ts
517
+ static hash<T>(payload): Promise<BrandedHash>;
518
+ ```
519
+
520
+ ### Type Parameters
521
+
522
+ #### T
523
+
524
+ `T` *extends* `Payload`
525
+
526
+ ### Parameters
527
+
528
+ #### payload
529
+
530
+ `T`
531
+
532
+ ### Returns
533
+
534
+ `Promise`\<`BrandedHash`\>
535
+
536
+ ***
537
+
538
+ ### hashPairs()
539
+
540
+ ```ts
541
+ static hashPairs<T>(payloads): Promise<[T, BrandedHash][]>;
542
+ ```
543
+
544
+ Creates an array of payload/hash tuples based on the payloads passed in
545
+
546
+ ### Type Parameters
547
+
548
+ #### T
549
+
550
+ `T` *extends* `Payload`
551
+
552
+ ### Parameters
553
+
554
+ #### payloads
555
+
556
+ `T`[]
557
+
558
+ ### Returns
559
+
560
+ `Promise`\<\[`T`, `BrandedHash`\][]\>
561
+
562
+ An array of payload/hash tuples
563
+
564
+ ***
565
+
566
+ ### hashableFields()
567
+
568
+ ```ts
569
+ static hashableFields<T>(payload): WithoutStorageMeta<T>;
570
+ ```
571
+
572
+ ### Type Parameters
573
+
574
+ #### T
575
+
576
+ `T` *extends* `Payload`
577
+
578
+ ### Parameters
579
+
580
+ #### payload
581
+
582
+ `T`
583
+
584
+ ### Returns
585
+
586
+ `WithoutStorageMeta`\<`T`\>
587
+
588
+ ***
589
+
590
+ ### hashes()
591
+
592
+ ### Call Signature
593
+
594
+ ```ts
595
+ static hashes(payloads): Promise<undefined>;
596
+ ```
597
+
598
+ #### Parameters
599
+
600
+ ##### payloads
601
+
602
+ `undefined`
603
+
604
+ #### Returns
605
+
606
+ `Promise`\<`undefined`\>
607
+
608
+ ### Call Signature
609
+
610
+ ```ts
611
+ static hashes<T>(payloads): Promise<BrandedHash[]>;
612
+ ```
613
+
614
+ #### Type Parameters
615
+
616
+ ##### T
617
+
618
+ `T` *extends* `Payload`
619
+
620
+ #### Parameters
621
+
622
+ ##### payloads
623
+
624
+ `T`[]
625
+
626
+ #### Returns
627
+
628
+ `Promise`\<`BrandedHash`[]\>
629
+
630
+ ***
631
+
632
+ ### omitClientMeta()
633
+
634
+ ### Call Signature
635
+
636
+ ```ts
637
+ static omitClientMeta<T>(payloads, maxDepth?): WithoutClientMeta<T>[];
638
+ ```
639
+
640
+ #### Type Parameters
641
+
642
+ ##### T
643
+
644
+ `T` *extends* `Payload`
645
+
646
+ #### Parameters
647
+
648
+ ##### payloads
649
+
650
+ `T`[]
651
+
652
+ ##### maxDepth?
653
+
654
+ `number`
655
+
656
+ #### Returns
657
+
658
+ `WithoutClientMeta`\<`T`\>[]
659
+
660
+ ### Call Signature
661
+
662
+ ```ts
663
+ static omitClientMeta<T>(payloads, maxDepth?): WithoutClientMeta<T>[];
664
+ ```
665
+
666
+ #### Type Parameters
667
+
668
+ ##### T
669
+
670
+ `T` *extends* `object`
671
+
672
+ #### Parameters
673
+
674
+ ##### payloads
675
+
676
+ `T`[]
677
+
678
+ ##### maxDepth?
679
+
680
+ `number`
681
+
682
+ #### Returns
683
+
684
+ `WithoutClientMeta`\<`T`\>[]
685
+
686
+ ### Call Signature
687
+
688
+ ```ts
689
+ static omitClientMeta<T>(payload, maxDepth?): WithoutClientMeta<T>;
690
+ ```
691
+
692
+ #### Type Parameters
693
+
694
+ ##### T
695
+
696
+ `T` *extends* `Payload`
697
+
698
+ #### Parameters
699
+
700
+ ##### payload
701
+
702
+ `T`
703
+
704
+ ##### maxDepth?
705
+
706
+ `number`
707
+
708
+ #### Returns
709
+
710
+ `WithoutClientMeta`\<`T`\>
711
+
712
+ ### Call Signature
713
+
714
+ ```ts
715
+ static omitClientMeta<T>(payload, maxDepth?): WithoutClientMeta<T>;
716
+ ```
717
+
718
+ #### Type Parameters
719
+
720
+ ##### T
721
+
722
+ `T` *extends* `object`
723
+
724
+ #### Parameters
725
+
726
+ ##### payload
727
+
728
+ `T`
729
+
730
+ ##### maxDepth?
731
+
732
+ `number`
733
+
734
+ #### Returns
735
+
736
+ `WithoutClientMeta`\<`T`\>
737
+
738
+ ***
739
+
740
+ ### omitMeta()
741
+
742
+ ### Call Signature
743
+
744
+ ```ts
745
+ static omitMeta<T>(payloads, maxDepth?): WithoutMeta<T>[];
746
+ ```
747
+
748
+ #### Type Parameters
749
+
750
+ ##### T
751
+
752
+ `T` *extends* `Payload`
753
+
754
+ #### Parameters
755
+
756
+ ##### payloads
757
+
758
+ `T`[]
759
+
760
+ ##### maxDepth?
761
+
762
+ `number`
763
+
764
+ #### Returns
765
+
766
+ `WithoutMeta`\<`T`\>[]
767
+
768
+ ### Call Signature
769
+
770
+ ```ts
771
+ static omitMeta<T>(payloads, maxDepth?): WithoutMeta<T>[];
772
+ ```
773
+
774
+ #### Type Parameters
775
+
776
+ ##### T
777
+
778
+ `T` *extends* `object`
779
+
780
+ #### Parameters
781
+
782
+ ##### payloads
783
+
784
+ `T`[]
785
+
786
+ ##### maxDepth?
787
+
788
+ `number`
789
+
790
+ #### Returns
791
+
792
+ `WithoutMeta`\<`T`\>[]
793
+
794
+ ### Call Signature
795
+
796
+ ```ts
797
+ static omitMeta<T>(payload, maxDepth?): WithoutMeta<T>;
798
+ ```
799
+
800
+ #### Type Parameters
801
+
802
+ ##### T
803
+
804
+ `T` *extends* `Payload`
805
+
806
+ #### Parameters
807
+
808
+ ##### payload
809
+
810
+ `T`
811
+
812
+ ##### maxDepth?
813
+
814
+ `number`
815
+
816
+ #### Returns
817
+
818
+ `WithoutMeta`\<`T`\>
819
+
820
+ ### Call Signature
821
+
822
+ ```ts
823
+ static omitMeta<T>(payload, maxDepth?): WithoutMeta<T>;
824
+ ```
825
+
826
+ #### Type Parameters
827
+
828
+ ##### T
829
+
830
+ `T` *extends* `object`
831
+
832
+ #### Parameters
833
+
834
+ ##### payload
835
+
836
+ `T`
837
+
838
+ ##### maxDepth?
839
+
840
+ `number`
841
+
842
+ #### Returns
843
+
844
+ `WithoutMeta`\<`T`\>
845
+
846
+ ***
847
+
848
+ ### omitPrivateStorageMeta()
849
+
850
+ ### Call Signature
851
+
852
+ ```ts
853
+ static omitPrivateStorageMeta<T>(payloads, maxDepth?): WithoutPrivateStorageMeta<T>[];
854
+ ```
855
+
856
+ #### Type Parameters
857
+
858
+ ##### T
859
+
860
+ `T` *extends* `Payload`
861
+
862
+ #### Parameters
863
+
864
+ ##### payloads
865
+
866
+ `T`[]
867
+
868
+ ##### maxDepth?
869
+
870
+ `number`
871
+
872
+ #### Returns
873
+
874
+ `WithoutPrivateStorageMeta`\<`T`\>[]
875
+
876
+ ### Call Signature
877
+
878
+ ```ts
879
+ static omitPrivateStorageMeta<T>(payloads, maxDepth?): WithoutPrivateStorageMeta<T>[];
880
+ ```
881
+
882
+ #### Type Parameters
883
+
884
+ ##### T
885
+
886
+ `T` *extends* `object`
887
+
888
+ #### Parameters
889
+
890
+ ##### payloads
891
+
892
+ `T`[]
893
+
894
+ ##### maxDepth?
895
+
896
+ `number`
897
+
898
+ #### Returns
899
+
900
+ `WithoutPrivateStorageMeta`\<`T`\>[]
901
+
902
+ ### Call Signature
903
+
904
+ ```ts
905
+ static omitPrivateStorageMeta<T>(payload, maxDepth?): WithoutPrivateStorageMeta<T>;
906
+ ```
907
+
908
+ #### Type Parameters
909
+
910
+ ##### T
911
+
912
+ `T` *extends* `Payload`
913
+
914
+ #### Parameters
915
+
916
+ ##### payload
917
+
918
+ `T`
919
+
920
+ ##### maxDepth?
921
+
922
+ `number`
923
+
924
+ #### Returns
925
+
926
+ `WithoutPrivateStorageMeta`\<`T`\>
927
+
928
+ ### Call Signature
929
+
930
+ ```ts
931
+ static omitPrivateStorageMeta<T>(payload, maxDepth?): WithoutPrivateStorageMeta<T>;
932
+ ```
933
+
934
+ #### Type Parameters
935
+
936
+ ##### T
937
+
938
+ `T` *extends* `object`
939
+
940
+ #### Parameters
941
+
942
+ ##### payload
943
+
944
+ `T`
945
+
946
+ ##### maxDepth?
947
+
948
+ `number`
949
+
950
+ #### Returns
951
+
952
+ `WithoutPrivateStorageMeta`\<`T`\>
953
+
954
+ ***
955
+
956
+ ### omitStorageMeta()
957
+
958
+ ### Call Signature
959
+
960
+ ```ts
961
+ static omitStorageMeta<T>(payloads, maxDepth?): WithoutStorageMeta<T[number]>[];
962
+ ```
963
+
964
+ #### Type Parameters
965
+
966
+ ##### T
967
+
968
+ `T` *extends* `object`[]
969
+
970
+ #### Parameters
971
+
972
+ ##### payloads
973
+
974
+ `T`
975
+
976
+ ##### maxDepth?
977
+
978
+ `number`
979
+
980
+ #### Returns
981
+
982
+ `WithoutStorageMeta`\<`T`\[`number`\]\>[]
983
+
984
+ ### Call Signature
985
+
986
+ ```ts
987
+ static omitStorageMeta<T>(payloads, maxDepth?): WithoutStorageMeta<T[number]>[];
988
+ ```
989
+
990
+ #### Type Parameters
991
+
992
+ ##### T
993
+
994
+ `T` *extends* `Payload`[]
995
+
996
+ #### Parameters
997
+
998
+ ##### payloads
999
+
1000
+ `T`
1001
+
1002
+ ##### maxDepth?
1003
+
1004
+ `number`
1005
+
1006
+ #### Returns
1007
+
1008
+ `WithoutStorageMeta`\<`T`\[`number`\]\>[]
1009
+
1010
+ ### Call Signature
1011
+
1012
+ ```ts
1013
+ static omitStorageMeta<T>(payload, maxDepth?): WithoutStorageMeta<T>;
1014
+ ```
1015
+
1016
+ #### Type Parameters
1017
+
1018
+ ##### T
1019
+
1020
+ `T` *extends* `object`
1021
+
1022
+ #### Parameters
1023
+
1024
+ ##### payload
1025
+
1026
+ `T`
1027
+
1028
+ ##### maxDepth?
1029
+
1030
+ `number`
1031
+
1032
+ #### Returns
1033
+
1034
+ `WithoutStorageMeta`\<`T`\>
1035
+
1036
+ ### Call Signature
1037
+
1038
+ ```ts
1039
+ static omitStorageMeta<T>(payload, maxDepth?): WithoutStorageMeta<T>;
1040
+ ```
1041
+
1042
+ #### Type Parameters
1043
+
1044
+ ##### T
1045
+
1046
+ `T` *extends* `Payload`
1047
+
1048
+ #### Parameters
1049
+
1050
+ ##### payload
1051
+
1052
+ `T`
1053
+
1054
+ ##### maxDepth?
1055
+
1056
+ `number`
1057
+
1058
+ #### Returns
1059
+
1060
+ `WithoutStorageMeta`\<`T`\>
1061
+
1062
+ ***
1063
+
1064
+ ### pickClientMeta()
1065
+
1066
+ ### Call Signature
1067
+
1068
+ ```ts
1069
+ static pickClientMeta<T>(payloads, maxDepth?): WithOnlyClientMeta<T>[];
1070
+ ```
1071
+
1072
+ #### Type Parameters
1073
+
1074
+ ##### T
1075
+
1076
+ `T` *extends* `Payload`
1077
+
1078
+ #### Parameters
1079
+
1080
+ ##### payloads
1081
+
1082
+ `T`[]
1083
+
1084
+ ##### maxDepth?
1085
+
1086
+ `number`
1087
+
1088
+ #### Returns
1089
+
1090
+ `WithOnlyClientMeta`\<`T`\>[]
1091
+
1092
+ ### Call Signature
1093
+
1094
+ ```ts
1095
+ static pickClientMeta<T>(payload, maxDepth?): WithOnlyClientMeta<T>;
1096
+ ```
1097
+
1098
+ #### Type Parameters
1099
+
1100
+ ##### T
1101
+
1102
+ `T` *extends* `Payload`
1103
+
1104
+ #### Parameters
1105
+
1106
+ ##### payload
1107
+
1108
+ `T`
1109
+
1110
+ ##### maxDepth?
1111
+
1112
+ `number`
1113
+
1114
+ #### Returns
1115
+
1116
+ `WithOnlyClientMeta`\<`T`\>
1117
+
1118
+ ***
1119
+
1120
+ ### sortByStorageMeta()
1121
+
1122
+ ```ts
1123
+ static sortByStorageMeta<T>(
1124
+ payloads,
1125
+ direction?,
1126
+ comparer?): WithStorageMeta<T>[];
1127
+ ```
1128
+
1129
+ ### Type Parameters
1130
+
1131
+ #### T
1132
+
1133
+ `T` *extends* `Payload`
1134
+
1135
+ ### Parameters
1136
+
1137
+ #### payloads
1138
+
1139
+ `WithStorageMeta`\<`T`\>[]
1140
+
1141
+ #### direction?
1142
+
1143
+ `-1` \| `1`
1144
+
1145
+ #### comparer?
1146
+
1147
+ `Compare`\<`Sequence`\> = `SequenceComparer.local`
1148
+
1149
+ ### Returns
1150
+
1151
+ `WithStorageMeta`\<`T`\>[]
1152
+
1153
+ ***
1154
+
1155
+ ### toAllHashMap()
1156
+
1157
+ ```ts
1158
+ static toAllHashMap<T>(payloads): Promise<Record<BrandedHash, T>>;
1159
+ ```
1160
+
1161
+ ### Type Parameters
1162
+
1163
+ #### T
1164
+
1165
+ `T` *extends* `Payload`
1166
+
1167
+ ### Parameters
1168
+
1169
+ #### payloads
1170
+
1171
+ `T`[]
1172
+
1173
+ ### Returns
1174
+
1175
+ `Promise`\<`Record`\<`BrandedHash`, `T`\>\>
1176
+
1177
+ ***
1178
+
1179
+ ### toDataHashMap()
1180
+
1181
+ ```ts
1182
+ static toDataHashMap<T>(objs): Promise<Record<BrandedHash, T>>;
1183
+ ```
1184
+
1185
+ ### Type Parameters
1186
+
1187
+ #### T
1188
+
1189
+ `T` *extends* `Payload`
1190
+
1191
+ ### Parameters
1192
+
1193
+ #### objs
1194
+
1195
+ `T`[]
1196
+
1197
+ ### Returns
1198
+
1199
+ `Promise`\<`Record`\<`BrandedHash`, `T`\>\>
1200
+
1201
+ ***
1202
+
1203
+ ### toHashMap()
1204
+
1205
+ ```ts
1206
+ static toHashMap<T>(objs): Promise<Record<BrandedHash, T>>;
1207
+ ```
1208
+
1209
+ Creates an object map of payload hashes to payloads based on the payloads passed in
1210
+
1211
+ ### Type Parameters
1212
+
1213
+ #### T
1214
+
1215
+ `T` *extends* `Payload`
1216
+
1217
+ ### Parameters
1218
+
1219
+ #### objs
1220
+
1221
+ `T`[]
1222
+
1223
+ Any array of payloads
1224
+
1225
+ ### Returns
1226
+
1227
+ `Promise`\<`Record`\<`BrandedHash`, `T`\>\>
1228
+
1229
+ A map of hashes to payloads
1230
+
1231
+ ***
1232
+
1233
+ ### build()
1234
+
1235
+ ```ts
1236
+ build(): R;
1237
+ ```
1238
+
1239
+ ### Returns
1240
+
1241
+ `R`
1242
+
1243
+ ***
1244
+
1245
+ ### dataHashableFields()
1246
+
1247
+ ```ts
1248
+ dataHashableFields(): Promise<WithoutMeta<T>>;
1249
+ ```
1250
+
1251
+ ### Returns
1252
+
1253
+ `Promise`\<`WithoutMeta`\<`T`\>\>
1254
+
1255
+ ***
1256
+
1257
+ ### fields()
1258
+
1259
+ ```ts
1260
+ fields(fields): PayloadBuilder<T, R>;
1261
+ ```
1262
+
1263
+ ### Parameters
1264
+
1265
+ #### fields
1266
+
1267
+ `WithoutSchema`\<`WithoutStorageMeta`\<`WithoutClientMeta`\<`T`\>\>\>
1268
+
1269
+ ### Returns
1270
+
1271
+ `PayloadBuilder`\<`T`, `R`\>
1272
+
1273
+ ***
1274
+
1275
+ ### meta()
1276
+
1277
+ ```ts
1278
+ meta(meta): PayloadBuilder<T, R>;
1279
+ ```
1280
+
1281
+ ### Parameters
1282
+
1283
+ #### meta
1284
+
1285
+ `DeepPickStartsWith`\<`T`\>
1286
+
1287
+ ### Returns
1288
+
1289
+ `PayloadBuilder`\<`T`, `R`\>
1290
+
1291
+ ***
1292
+
1293
+ ### schema()
1294
+
1295
+ ```ts
1296
+ schema(value): void;
1297
+ ```
1298
+
1299
+ ### Parameters
1300
+
1301
+ #### value
1302
+
1303
+ `Schema`
1304
+
1305
+ ### Returns
1306
+
1307
+ `void`
1308
+
1309
+ ### functions
1310
+
1311
+ ### <a id="omitSchema"></a>omitSchema
1312
+
1313
+ [**@xyo-network/payload-builder**](#../README)
1314
+
1315
+ ***
1316
+
1317
+ ```ts
1318
+ function omitSchema<T>(payload): WithoutSchema<T>;
1319
+ ```
1320
+
1321
+ ## Type Parameters
1322
+
1323
+ ### T
1324
+
1325
+ `T` *extends* `WithOptionalSchema`
1326
+
1327
+ ## Parameters
1328
+
1329
+ ### payload
1330
+
1331
+ `T`
1332
+
1333
+ ## Returns
1334
+
1335
+ `WithoutSchema`\<`T`\>
1336
+
1337
+ ### interfaces
1338
+
1339
+ ### <a id="PayloadBuilderOptions"></a>PayloadBuilderOptions
1340
+
1341
+ [**@xyo-network/payload-builder**](#../README)
1342
+
1343
+ ***
1344
+
1345
+ ## Properties
1346
+
1347
+ ### logger?
1348
+
1349
+ ```ts
1350
+ readonly optional logger?: Logger;
1351
+ ```
1352
+
1353
+ ***
1354
+
1355
+ ### schema
18
1356
 
19
- ## Credits
1357
+ ```ts
1358
+ readonly schema: Schema;
1359
+ ```
20
1360
 
21
- [Made with 🔥 and ❄️ by XYO](https://xyo.network)
22
1361
 
23
- [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
1362
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
1363
+ [npm-badge]: https://img.shields.io/npm/v/@xyo-network/payload-builder.svg
1364
+ [npm-link]: https://www.npmjs.com/package/@xyo-network/payload-builder
1365
+ [license-badge]: https://img.shields.io/npm/l/@xyo-network/payload-builder.svg
1366
+ [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/payload-builder",
3
- "version": "5.3.24",
3
+ "version": "5.3.26",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -22,11 +22,11 @@
22
22
  "exports": {
23
23
  ".": {
24
24
  "types": "./dist/neutral/index.d.ts",
25
+ "import": "./dist/neutral/index.mjs",
25
26
  "default": "./dist/neutral/index.mjs"
26
27
  },
27
28
  "./package.json": "./package.json"
28
29
  },
29
- "module": "dist/neutral/index.mjs",
30
30
  "types": "dist/neutral/index.d.ts",
31
31
  "files": [
32
32
  "dist",
@@ -36,17 +36,17 @@
36
36
  "README.md"
37
37
  ],
38
38
  "dependencies": {
39
- "@xyo-network/hash": "~5.3.24",
40
- "@xyo-network/payload-model": "~5.3.24"
39
+ "@xyo-network/hash": "~5.3.26",
40
+ "@xyo-network/payload-model": "~5.3.26"
41
41
  },
42
42
  "devDependencies": {
43
43
  "@opentelemetry/api": "^1.9.1",
44
- "@types/node": "^25.5.0",
45
- "@xylabs/sdk-js": "^5.0.93",
46
- "@xylabs/ts-scripts-common": "~7.6.16",
47
- "@xylabs/ts-scripts-pnpm": "~7.6.16",
48
- "@xylabs/tsconfig": "~7.6.16",
49
- "@xylabs/vitest-extended": "~5.0.93",
44
+ "@types/node": "^25.5.2",
45
+ "@xylabs/sdk-js": "^5.0.94",
46
+ "@xylabs/ts-scripts-common": "~7.7.5",
47
+ "@xylabs/ts-scripts-pnpm": "~7.7.5",
48
+ "@xylabs/tsconfig": "~7.7.5",
49
+ "@xylabs/vitest-extended": "~5.0.94",
50
50
  "acorn": "^8.16.0",
51
51
  "axios": "^1.14.0",
52
52
  "esbuild": "^0.28.0",
@@ -54,8 +54,8 @@
54
54
  "vite": "^8.0.3",
55
55
  "vitest": "~4.1.2",
56
56
  "zod": "^4.3.6",
57
- "@xyo-network/hash": "~5.3.24",
58
- "@xyo-network/payload-model": "~5.3.24"
57
+ "@xyo-network/hash": "~5.3.26",
58
+ "@xyo-network/payload-model": "~5.3.26"
59
59
  },
60
60
  "peerDependencies": {
61
61
  "@xylabs/sdk-js": "^5",