@xyo-network/id-payload-plugin 2.56.2 → 2.57.5

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 (14) hide show
  1. package/dist/docs.json +169 -50
  2. package/docs/assets/highlight.css +22 -0
  3. package/docs/assets/main.js +58 -0
  4. package/docs/assets/search.js +1 -0
  5. package/docs/assets/style.css +1367 -0
  6. package/docs/functions/IdPayloadPlugin.html +50 -0
  7. package/docs/functions/idPayloadTemplate.html +50 -0
  8. package/docs/index.html +57 -0
  9. package/docs/modules.html +72 -0
  10. package/docs/types/IdPayload.html +46 -0
  11. package/docs/types/IdSchema.html +47 -0
  12. package/docs/variables/IdSchema-1.html +47 -0
  13. package/package.json +5 -5
  14. package/typedoc.json +5 -0
package/dist/docs.json CHANGED
@@ -1,23 +1,22 @@
1
1
  {
2
2
  "id": 0,
3
3
  "name": "@xyo-network/id-payload-plugin",
4
+ "variant": "project",
4
5
  "kind": 1,
5
- "kindString": "Project",
6
6
  "flags": {},
7
- "originalName": "",
8
7
  "children": [
9
8
  {
10
9
  "id": 17,
11
10
  "name": "default",
11
+ "variant": "reference",
12
12
  "kind": 8388608,
13
- "kindString": "Reference",
14
13
  "flags": {},
15
14
  "sources": [
16
15
  {
17
16
  "fileName": "index.ts",
18
17
  "line": 10,
19
18
  "character": 0,
20
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a3368b410/packages/plugins/packages/payload/packages/id/src/index.ts#L10"
19
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/plugins/packages/payload/packages/id/src/index.ts#L10"
21
20
  }
22
21
  ],
23
22
  "target": 1
@@ -25,41 +24,45 @@
25
24
  {
26
25
  "id": 6,
27
26
  "name": "IdPayload",
27
+ "variant": "declaration",
28
28
  "kind": 4194304,
29
- "kindString": "Type alias",
30
29
  "flags": {},
31
30
  "sources": [
32
31
  {
33
32
  "fileName": "Payload.ts",
34
33
  "line": 5,
35
34
  "character": 12,
36
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a3368b410/packages/plugins/packages/payload/packages/id/src/Payload.ts#L5"
35
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/plugins/packages/payload/packages/id/src/Payload.ts#L5"
37
36
  }
38
37
  ],
39
38
  "type": {
40
39
  "type": "reference",
40
+ "target": {
41
+ "sourceFileName": "../../../../../protocol/packages/payload/packages/model/src/Payload.ts",
42
+ "qualifiedName": "Payload"
43
+ },
41
44
  "typeArguments": [
42
45
  {
43
46
  "type": "reflection",
44
47
  "declaration": {
45
48
  "id": 7,
46
49
  "name": "__type",
50
+ "variant": "declaration",
47
51
  "kind": 65536,
48
- "kindString": "Type literal",
49
52
  "flags": {},
50
53
  "children": [
51
54
  {
52
55
  "id": 8,
53
56
  "name": "salt",
57
+ "variant": "declaration",
54
58
  "kind": 1024,
55
- "kindString": "Property",
56
59
  "flags": {},
57
60
  "sources": [
58
61
  {
59
62
  "fileName": "Payload.ts",
60
63
  "line": 6,
61
64
  "character": 2,
62
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a3368b410/packages/plugins/packages/payload/packages/id/src/Payload.ts#L6"
65
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/plugins/packages/payload/packages/id/src/Payload.ts#L6"
63
66
  }
64
67
  ],
65
68
  "type": {
@@ -70,21 +73,22 @@
70
73
  {
71
74
  "id": 9,
72
75
  "name": "schema",
76
+ "variant": "declaration",
73
77
  "kind": 1024,
74
- "kindString": "Property",
75
78
  "flags": {},
76
79
  "sources": [
77
80
  {
78
81
  "fileName": "Payload.ts",
79
82
  "line": 7,
80
83
  "character": 2,
81
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a3368b410/packages/plugins/packages/payload/packages/id/src/Payload.ts#L7"
84
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/plugins/packages/payload/packages/id/src/Payload.ts#L7"
82
85
  }
83
86
  ],
84
87
  "type": {
85
88
  "type": "reference",
86
- "id": 10,
87
- "name": "IdSchema"
89
+ "target": 10,
90
+ "name": "IdSchema",
91
+ "package": "@xyo-network/id-payload-plugin"
88
92
  }
89
93
  }
90
94
  ],
@@ -102,33 +106,34 @@
102
106
  "fileName": "Payload.ts",
103
107
  "line": 5,
104
108
  "character": 32,
105
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a3368b410/packages/plugins/packages/payload/packages/id/src/Payload.ts#L5"
109
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/plugins/packages/payload/packages/id/src/Payload.ts#L5"
106
110
  }
107
111
  ]
108
112
  }
109
113
  }
110
114
  ],
111
- "name": "Payload"
115
+ "name": "Payload",
116
+ "package": "@xyo-network/payload-model"
112
117
  }
113
118
  },
114
119
  {
115
120
  "id": 11,
116
121
  "name": "IdSchema",
122
+ "variant": "declaration",
117
123
  "kind": 4194304,
118
- "kindString": "Type alias",
119
124
  "flags": {},
120
125
  "sources": [
121
126
  {
122
127
  "fileName": "Schema.ts",
123
128
  "line": 1,
124
129
  "character": 12,
125
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a3368b410/packages/plugins/packages/payload/packages/id/src/Schema.ts#L1"
130
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/plugins/packages/payload/packages/id/src/Schema.ts#L1"
126
131
  },
127
132
  {
128
133
  "fileName": "Schema.ts",
129
134
  "line": 2,
130
135
  "character": 13,
131
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a3368b410/packages/plugins/packages/payload/packages/id/src/Schema.ts#L2"
136
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/plugins/packages/payload/packages/id/src/Schema.ts#L2"
132
137
  }
133
138
  ],
134
139
  "type": {
@@ -139,21 +144,21 @@
139
144
  {
140
145
  "id": 10,
141
146
  "name": "IdSchema",
147
+ "variant": "declaration",
142
148
  "kind": 32,
143
- "kindString": "Variable",
144
149
  "flags": {},
145
150
  "sources": [
146
151
  {
147
152
  "fileName": "Schema.ts",
148
153
  "line": 1,
149
154
  "character": 12,
150
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a3368b410/packages/plugins/packages/payload/packages/id/src/Schema.ts#L1"
155
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/plugins/packages/payload/packages/id/src/Schema.ts#L1"
151
156
  },
152
157
  {
153
158
  "fileName": "Schema.ts",
154
159
  "line": 2,
155
160
  "character": 13,
156
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a3368b410/packages/plugins/packages/payload/packages/id/src/Schema.ts#L2"
161
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/plugins/packages/payload/packages/id/src/Schema.ts#L2"
157
162
  }
158
163
  ],
159
164
  "type": {
@@ -164,59 +169,81 @@
164
169
  {
165
170
  "id": 1,
166
171
  "name": "IdPayloadPlugin",
172
+ "variant": "declaration",
167
173
  "kind": 64,
168
- "kindString": "Function",
169
174
  "flags": {},
170
175
  "sources": [
171
176
  {
172
177
  "fileName": "Plugin.ts",
173
178
  "line": 7,
174
179
  "character": 13,
175
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a3368b410/packages/plugins/packages/payload/packages/id/src/Plugin.ts#L7"
180
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/plugins/packages/payload/packages/id/src/Plugin.ts#L7"
176
181
  }
177
182
  ],
178
183
  "signatures": [
179
184
  {
180
185
  "id": 2,
181
186
  "name": "IdPayloadPlugin",
187
+ "variant": "signature",
182
188
  "kind": 4096,
183
- "kindString": "Call signature",
184
189
  "flags": {},
190
+ "sources": [
191
+ {
192
+ "fileName": "Plugin.ts",
193
+ "line": 7,
194
+ "character": 31,
195
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/plugins/packages/payload/packages/id/src/Plugin.ts#L7"
196
+ }
197
+ ],
185
198
  "type": {
186
199
  "type": "reference",
200
+ "target": {
201
+ "sourceFileName": "../../../../../sdk/packages/payload-plugin/src/Plugin.ts",
202
+ "qualifiedName": "PayloadPlugin"
203
+ },
187
204
  "typeArguments": [
188
205
  {
189
206
  "type": "intersection",
190
207
  "types": [
191
208
  {
192
209
  "type": "reference",
193
- "name": "SchemaFields"
210
+ "target": {
211
+ "sourceFileName": "../../../../../protocol/packages/payload/packages/model/src/Payload.ts",
212
+ "qualifiedName": "SchemaFields"
213
+ },
214
+ "name": "SchemaFields",
215
+ "package": "@xyo-network/payload-model"
194
216
  },
195
217
  {
196
218
  "type": "reference",
197
- "name": "PayloadFields"
219
+ "target": {
220
+ "sourceFileName": "../../../../../protocol/packages/payload/packages/model/src/Payload.ts",
221
+ "qualifiedName": "PayloadFields"
222
+ },
223
+ "name": "PayloadFields",
224
+ "package": "@xyo-network/payload-model"
198
225
  },
199
226
  {
200
227
  "type": "reflection",
201
228
  "declaration": {
202
229
  "id": 3,
203
230
  "name": "__type",
231
+ "variant": "declaration",
204
232
  "kind": 65536,
205
- "kindString": "Type literal",
206
233
  "flags": {},
207
234
  "children": [
208
235
  {
209
236
  "id": 4,
210
237
  "name": "salt",
238
+ "variant": "declaration",
211
239
  "kind": 1024,
212
- "kindString": "Property",
213
240
  "flags": {},
214
241
  "sources": [
215
242
  {
216
243
  "fileName": "Payload.ts",
217
244
  "line": 6,
218
245
  "character": 2,
219
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a3368b410/packages/plugins/packages/payload/packages/id/src/Payload.ts#L6"
246
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/plugins/packages/payload/packages/id/src/Payload.ts#L6"
220
247
  }
221
248
  ],
222
249
  "type": {
@@ -227,15 +254,15 @@
227
254
  {
228
255
  "id": 5,
229
256
  "name": "schema",
257
+ "variant": "declaration",
230
258
  "kind": 1024,
231
- "kindString": "Property",
232
259
  "flags": {},
233
260
  "sources": [
234
261
  {
235
262
  "fileName": "Payload.ts",
236
263
  "line": 7,
237
264
  "character": 2,
238
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a3368b410/packages/plugins/packages/payload/packages/id/src/Payload.ts#L7"
265
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/plugins/packages/payload/packages/id/src/Payload.ts#L7"
239
266
  }
240
267
  ],
241
268
  "type": {
@@ -258,7 +285,7 @@
258
285
  "fileName": "Payload.ts",
259
286
  "line": 5,
260
287
  "character": 32,
261
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a3368b410/packages/plugins/packages/payload/packages/id/src/Payload.ts#L5"
288
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/plugins/packages/payload/packages/id/src/Payload.ts#L5"
262
289
  }
263
290
  ]
264
291
  }
@@ -266,7 +293,8 @@
266
293
  ]
267
294
  }
268
295
  ],
269
- "name": "PayloadPlugin"
296
+ "name": "PayloadPlugin",
297
+ "package": "@xyo-network/payload-plugin"
270
298
  }
271
299
  }
272
300
  ]
@@ -274,56 +302,74 @@
274
302
  {
275
303
  "id": 12,
276
304
  "name": "idPayloadTemplate",
305
+ "variant": "declaration",
277
306
  "kind": 64,
278
- "kindString": "Function",
279
307
  "flags": {},
280
308
  "sources": [
281
309
  {
282
310
  "fileName": "Template.ts",
283
311
  "line": 4,
284
312
  "character": 13,
285
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a3368b410/packages/plugins/packages/payload/packages/id/src/Template.ts#L4"
313
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/plugins/packages/payload/packages/id/src/Template.ts#L4"
286
314
  }
287
315
  ],
288
316
  "signatures": [
289
317
  {
290
318
  "id": 13,
291
319
  "name": "idPayloadTemplate",
320
+ "variant": "signature",
292
321
  "kind": 4096,
293
- "kindString": "Call signature",
294
322
  "flags": {},
323
+ "sources": [
324
+ {
325
+ "fileName": "Template.ts",
326
+ "line": 4,
327
+ "character": 33,
328
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/plugins/packages/payload/packages/id/src/Template.ts#L4"
329
+ }
330
+ ],
295
331
  "type": {
296
332
  "type": "intersection",
297
333
  "types": [
298
334
  {
299
335
  "type": "reference",
300
- "name": "SchemaFields"
336
+ "target": {
337
+ "sourceFileName": "../../../../../protocol/packages/payload/packages/model/src/Payload.ts",
338
+ "qualifiedName": "SchemaFields"
339
+ },
340
+ "name": "SchemaFields",
341
+ "package": "@xyo-network/payload-model"
301
342
  },
302
343
  {
303
344
  "type": "reference",
304
- "name": "PayloadFields"
345
+ "target": {
346
+ "sourceFileName": "../../../../../protocol/packages/payload/packages/model/src/Payload.ts",
347
+ "qualifiedName": "PayloadFields"
348
+ },
349
+ "name": "PayloadFields",
350
+ "package": "@xyo-network/payload-model"
305
351
  },
306
352
  {
307
353
  "type": "reflection",
308
354
  "declaration": {
309
355
  "id": 14,
310
356
  "name": "__type",
357
+ "variant": "declaration",
311
358
  "kind": 65536,
312
- "kindString": "Type literal",
313
359
  "flags": {},
314
360
  "children": [
315
361
  {
316
362
  "id": 15,
317
363
  "name": "salt",
364
+ "variant": "declaration",
318
365
  "kind": 1024,
319
- "kindString": "Property",
320
366
  "flags": {},
321
367
  "sources": [
322
368
  {
323
369
  "fileName": "Payload.ts",
324
370
  "line": 6,
325
371
  "character": 2,
326
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a3368b410/packages/plugins/packages/payload/packages/id/src/Payload.ts#L6"
372
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/plugins/packages/payload/packages/id/src/Payload.ts#L6"
327
373
  }
328
374
  ],
329
375
  "type": {
@@ -334,15 +380,15 @@
334
380
  {
335
381
  "id": 16,
336
382
  "name": "schema",
383
+ "variant": "declaration",
337
384
  "kind": 1024,
338
- "kindString": "Property",
339
385
  "flags": {},
340
386
  "sources": [
341
387
  {
342
388
  "fileName": "Payload.ts",
343
389
  "line": 7,
344
390
  "character": 2,
345
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a3368b410/packages/plugins/packages/payload/packages/id/src/Payload.ts#L7"
391
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/plugins/packages/payload/packages/id/src/Payload.ts#L7"
346
392
  }
347
393
  ],
348
394
  "type": {
@@ -365,7 +411,7 @@
365
411
  "fileName": "Payload.ts",
366
412
  "line": 5,
367
413
  "character": 32,
368
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a3368b410/packages/plugins/packages/payload/packages/id/src/Payload.ts#L5"
414
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/plugins/packages/payload/packages/id/src/Payload.ts#L5"
369
415
  }
370
416
  ]
371
417
  }
@@ -404,12 +450,85 @@
404
450
  ]
405
451
  }
406
452
  ],
407
- "sources": [
453
+ "packageName": "@xyo-network/id-payload-plugin",
454
+ "readme": [
408
455
  {
409
- "fileName": "index.ts",
410
- "line": 1,
411
- "character": 0,
412
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a3368b410/packages/plugins/packages/payload/packages/id/src/index.ts#L1"
456
+ "kind": "text",
457
+ "text": "[![logo][]](https://xyo.network)\n\nPart of [sdk-xyo-clint-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)\n\n## License\n\n> See the [LICENSE](LICENSE) file for license details\n\n## Credits\n\n[Made with 🔥 and ❄️ by XYO](https://xyo.network)\n\n[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png"
458
+ }
459
+ ],
460
+ "symbolIdMap": {
461
+ "0": {
462
+ "sourceFileName": "src/index.ts",
463
+ "qualifiedName": ""
464
+ },
465
+ "1": {
466
+ "sourceFileName": "src/Plugin.ts",
467
+ "qualifiedName": "IdPayloadPlugin"
468
+ },
469
+ "2": {
470
+ "sourceFileName": "src/Plugin.ts",
471
+ "qualifiedName": "IdPayloadPlugin"
472
+ },
473
+ "3": {
474
+ "sourceFileName": "src/Payload.ts",
475
+ "qualifiedName": "__type"
476
+ },
477
+ "4": {
478
+ "sourceFileName": "src/Payload.ts",
479
+ "qualifiedName": "__type.salt"
480
+ },
481
+ "5": {
482
+ "sourceFileName": "src/Payload.ts",
483
+ "qualifiedName": "__type.schema"
484
+ },
485
+ "6": {
486
+ "sourceFileName": "src/Payload.ts",
487
+ "qualifiedName": "IdPayload"
488
+ },
489
+ "7": {
490
+ "sourceFileName": "src/Payload.ts",
491
+ "qualifiedName": "__type"
492
+ },
493
+ "8": {
494
+ "sourceFileName": "src/Payload.ts",
495
+ "qualifiedName": "__type.salt"
496
+ },
497
+ "9": {
498
+ "sourceFileName": "src/Payload.ts",
499
+ "qualifiedName": "__type.schema"
500
+ },
501
+ "10": {
502
+ "sourceFileName": "src/Schema.ts",
503
+ "qualifiedName": "IdSchema"
504
+ },
505
+ "11": {
506
+ "sourceFileName": "src/Schema.ts",
507
+ "qualifiedName": "IdSchema"
508
+ },
509
+ "12": {
510
+ "sourceFileName": "src/Template.ts",
511
+ "qualifiedName": "idPayloadTemplate"
512
+ },
513
+ "13": {
514
+ "sourceFileName": "src/Template.ts",
515
+ "qualifiedName": "idPayloadTemplate"
516
+ },
517
+ "14": {
518
+ "sourceFileName": "src/Payload.ts",
519
+ "qualifiedName": "__type"
520
+ },
521
+ "15": {
522
+ "sourceFileName": "src/Payload.ts",
523
+ "qualifiedName": "__type.salt"
524
+ },
525
+ "16": {
526
+ "sourceFileName": "src/Payload.ts",
527
+ "qualifiedName": "__type.schema"
528
+ },
529
+ "17": {
530
+ "sourceFileName": "src/index.ts",
531
+ "qualifiedName": "default"
413
532
  }
414
- ]
533
+ }
415
534
  }
package/docs/assets/highlight.css ADDED
@@ -0,0 +1,22 @@
1
+ :root {
2
+ --light-code-background: #FFFFFF;
3
+ --dark-code-background: #1E1E1E;
4
+ }
5
+
6
+ @media (prefers-color-scheme: light) { :root {
7
+ --code-background: var(--light-code-background);
8
+ } }
9
+
10
+ @media (prefers-color-scheme: dark) { :root {
11
+ --code-background: var(--dark-code-background);
12
+ } }
13
+
14
+ :root[data-theme='light'] {
15
+ --code-background: var(--light-code-background);
16
+ }
17
+
18
+ :root[data-theme='dark'] {
19
+ --code-background: var(--dark-code-background);
20
+ }
21
+
22
+ pre, code { background: var(--code-background); }