@xyo-network/id-payload-plugin 5.3.30 → 5.4.0

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/README.md CHANGED
@@ -38,199 +38,6 @@ bun add {{name}}
38
38
 
39
39
  See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
40
40
 
41
- ## Reference
42
-
43
- ### packages
44
-
45
- ### core-payload-plugins
46
-
47
- ### packages
48
-
49
- ### id
50
-
51
- ### .temp-typedoc
52
-
53
- ### functions
54
-
55
- ### <a id="IdPayloadPlugin"></a>IdPayloadPlugin
56
-
57
- [**@xyo-network/id-payload-plugin**](#../README)
58
-
59
- ***
60
-
61
- ```ts
62
- function IdPayloadPlugin(): PayloadPlugin<Id>;
63
- ```
64
-
65
- ## Returns
66
-
67
- `PayloadPlugin`\<[`Id`](#../type-aliases/Id)\>
68
-
69
- ### <a id="idPayloadTemplate"></a>idPayloadTemplate
70
-
71
- [**@xyo-network/id-payload-plugin**](#../README)
72
-
73
- ***
74
-
75
- ```ts
76
- function idPayloadTemplate(): Id;
77
- ```
78
-
79
- ## Returns
80
-
81
- [`Id`](#../type-aliases/Id)
82
-
83
- ### type-aliases
84
-
85
- ### <a id="Id"></a>Id
86
-
87
- [**@xyo-network/id-payload-plugin**](#../README)
88
-
89
- ***
90
-
91
- ```ts
92
- type Id = Payload<IdFields, IdSchema>;
93
- ```
94
-
95
- The ID Payload
96
-
97
- ### <a id="IdFields"></a>IdFields
98
-
99
- [**@xyo-network/id-payload-plugin**](#../README)
100
-
101
- ***
102
-
103
- ```ts
104
- type IdFields = object;
105
- ```
106
-
107
- The fields of an ID Payload
108
-
109
- ## Properties
110
-
111
- ### salt
112
-
113
- ```ts
114
- salt: string;
115
- ```
116
-
117
- ### <a id="IdPayload"></a>IdPayload
118
-
119
- [**@xyo-network/id-payload-plugin**](#../README)
120
-
121
- ***
122
-
123
- ```ts
124
- type IdPayload = Id;
125
- ```
126
-
127
- ## Deprecated
128
-
129
- Use `Id` instead
130
-
131
- ### <a id="IdSchema"></a>IdSchema
132
-
133
- [**@xyo-network/id-payload-plugin**](#../README)
134
-
135
- ***
136
-
137
- ```ts
138
- type IdSchema = typeof IdSchema;
139
- ```
140
-
141
- ### variables
142
-
143
- ### <a id="IdSchema"></a>IdSchema
144
-
145
- [**@xyo-network/id-payload-plugin**](#../README)
146
-
147
- ***
148
-
149
- ```ts
150
- const IdSchema: "network.xyo.id" & object;
151
- ```
152
-
153
- ## Type Declaration
154
-
155
- ### \_\_schema
156
-
157
- ```ts
158
- readonly __schema: true;
159
- ```
160
-
161
- ### <a id="asId"></a>asId
162
-
163
- [**@xyo-network/id-payload-plugin**](#../README)
164
-
165
- ***
166
-
167
- ```ts
168
- const asId: AsTypeFunction<Id>;
169
- ```
170
-
171
- ### <a id="asOptionalId"></a>asOptionalId
172
-
173
- [**@xyo-network/id-payload-plugin**](#../README)
174
-
175
- ***
176
-
177
- ```ts
178
- const asOptionalId: (value) => Id | undefined;
179
- ```
180
-
181
- ## Parameters
182
-
183
- ### value
184
-
185
- `AnyNonPromise`
186
-
187
- ## Returns
188
-
189
- [`Id`](#../type-aliases/Id) \| `undefined`
190
-
191
- ### <a id="isId"></a>isId
192
-
193
- [**@xyo-network/id-payload-plugin**](#../README)
194
-
195
- ***
196
-
197
- ```ts
198
- const isId: (x?) => x is Id;
199
- ```
200
-
201
- Identity helper for ID Payload
202
-
203
- ## Parameters
204
-
205
- ### x?
206
-
207
- `unknown`
208
-
209
- ## Returns
210
-
211
- `x is Id`
212
-
213
- ### <a id="isIdWithSources"></a>isIdWithSources
214
-
215
- [**@xyo-network/id-payload-plugin**](#../README)
216
-
217
- ***
218
-
219
- ```ts
220
- const isIdWithSources: (x?) => x is WithSources<WithSources<Id>>;
221
- ```
222
-
223
- Identity helper for ID Payload with sources
224
-
225
- ## Parameters
226
-
227
- ### x?
228
-
229
- `unknown`
230
-
231
- ## Returns
232
-
233
- `x is WithSources<WithSources<Id>>`
234
41
 
235
42
 
236
43
  [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
@@ -3,9 +3,9 @@ import { IdSchema } from './Schema.ts';
3
3
  /**
4
4
  * The fields of an ID Payload
5
5
  */
6
- export type IdFields = {
6
+ export interface IdFields {
7
7
  salt: string;
8
- };
8
+ }
9
9
  /**
10
10
  * The ID Payload
11
11
  */
@@ -1 +1 @@
1
- {"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,OAAO,EACP,WAAW,EACZ,MAAM,4BAA4B,CAAA;AAMnC,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAEtC;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,EAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;AAE5C;;GAEG;AAEH,MAAM,MAAM,SAAS,GAAG,EAAE,CAAA;AAE1B;;GAEG;AACH,eAAO,MAAM,IAAI,iCAAsC,CAAA;AACvD,eAAO,MAAM,IAAI,6CAA+B,CAAA;AAChD,eAAO,MAAM,YAAY,mEAAuC,CAAA;AAEhE;;GAEG;AACH,eAAO,MAAM,eAAe,2DAA8D,CAAA"}
1
+ {"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,OAAO,EACP,WAAW,EACZ,MAAM,4BAA4B,CAAA;AAMnC,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAEtC;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,MAAM,EAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;AAE5C;;GAEG;AAEH,MAAM,MAAM,SAAS,GAAG,EAAE,CAAA;AAE1B;;GAEG;AACH,eAAO,MAAM,IAAI,iCAAsC,CAAA;AACvD,eAAO,MAAM,IAAI,6CAA+B,CAAA;AAChD,eAAO,MAAM,YAAY,mEAAuC,CAAA;AAEhE;;GAEG;AACH,eAAO,MAAM,eAAe,2DAA8D,CAAA"}
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/Payload.ts","../../src/Schema.ts","../../src/Plugin.ts","../../src/Template.ts"],"sourcesContent":["import { AsObjectFactory } from '@xylabs/sdk-js'\nimport type {\n Payload,\n WithSources,\n} from '@xyo-network/payload-model'\nimport {\n isPayloadOfSchemaType,\n isPayloadOfSchemaTypeWithSources,\n} from '@xyo-network/payload-model'\n\nimport { IdSchema } from './Schema.ts'\n\n/**\n * The fields of an ID Payload\n */\nexport type IdFields = {\n salt: string\n}\n\n/**\n * The ID Payload\n */\nexport type Id = Payload<IdFields, IdSchema>\n\n/**\n * @deprecated Use `Id` instead\n */\n\nexport type IdPayload = Id\n\n/**\n * Identity helper for ID Payload\n */\nexport const isId = isPayloadOfSchemaType<Id>(IdSchema)\nexport const asId = AsObjectFactory.create(isId)\nexport const asOptionalId = AsObjectFactory.createOptional(isId)\n\n/**\n * Identity helper for ID Payload with sources\n */\nexport const isIdWithSources = isPayloadOfSchemaTypeWithSources<WithSources<Id>>(IdSchema)\n","import { asSchema } from '@xyo-network/payload-model'\n\nexport const IdSchema = asSchema('network.xyo.id', true)\nexport type IdSchema = typeof IdSchema\n","import { createPayloadPlugin } from '@xyo-network/payload-plugin'\n\nimport type { Id } from './Payload.ts'\nimport { IdSchema } from './Schema.ts'\nimport { idPayloadTemplate } from './Template.ts'\n\nexport const IdPayloadPlugin = () =>\n createPayloadPlugin<Id>({\n schema: IdSchema,\n template: idPayloadTemplate,\n })\n","import type { Id } from './Payload.ts'\nimport { IdSchema } from './Schema.ts'\n\nexport const idPayloadTemplate = (): Id => ({\n salt: '',\n schema: IdSchema,\n})\n"],"mappings":";AAAA,SAAS,uBAAuB;AAKhC;AAAA,EACE;AAAA,EACA;AAAA,OACK;;;ACRP,SAAS,gBAAgB;AAElB,IAAM,WAAW,SAAS,kBAAkB,IAAI;;;AD+BhD,IAAM,OAAO,sBAA0B,QAAQ;AAC/C,IAAM,OAAO,gBAAgB,OAAO,IAAI;AACxC,IAAM,eAAe,gBAAgB,eAAe,IAAI;AAKxD,IAAM,kBAAkB,iCAAkD,QAAQ;;;AExCzF,SAAS,2BAA2B;;;ACG7B,IAAM,oBAAoB,OAAW;AAAA,EAC1C,MAAM;AAAA,EACN,QAAQ;AACV;;;ADAO,IAAM,kBAAkB,MAC7B,oBAAwB;AAAA,EACtB,QAAQ;AAAA,EACR,UAAU;AACZ,CAAC;","names":[]}
1
+ {"version":3,"sources":["../../src/Payload.ts","../../src/Schema.ts","../../src/Plugin.ts","../../src/Template.ts"],"sourcesContent":["import { AsObjectFactory } from '@xylabs/sdk-js'\nimport type {\n Payload,\n WithSources,\n} from '@xyo-network/payload-model'\nimport {\n isPayloadOfSchemaType,\n isPayloadOfSchemaTypeWithSources,\n} from '@xyo-network/payload-model'\n\nimport { IdSchema } from './Schema.ts'\n\n/**\n * The fields of an ID Payload\n */\nexport interface IdFields {\n salt: string\n}\n\n/**\n * The ID Payload\n */\nexport type Id = Payload<IdFields, IdSchema>\n\n/**\n * @deprecated Use `Id` instead\n */\n\nexport type IdPayload = Id\n\n/**\n * Identity helper for ID Payload\n */\nexport const isId = isPayloadOfSchemaType<Id>(IdSchema)\nexport const asId = AsObjectFactory.create(isId)\nexport const asOptionalId = AsObjectFactory.createOptional(isId)\n\n/**\n * Identity helper for ID Payload with sources\n */\nexport const isIdWithSources = isPayloadOfSchemaTypeWithSources<WithSources<Id>>(IdSchema)\n","import { asSchema } from '@xyo-network/payload-model'\n\nexport const IdSchema = asSchema('network.xyo.id', true)\nexport type IdSchema = typeof IdSchema\n","import { createPayloadPlugin } from '@xyo-network/payload-plugin'\n\nimport type { Id } from './Payload.ts'\nimport { IdSchema } from './Schema.ts'\nimport { idPayloadTemplate } from './Template.ts'\n\nexport const IdPayloadPlugin = () =>\n createPayloadPlugin<Id>({\n schema: IdSchema,\n template: idPayloadTemplate,\n })\n","import type { Id } from './Payload.ts'\nimport { IdSchema } from './Schema.ts'\n\nexport const idPayloadTemplate = (): Id => ({\n salt: '',\n schema: IdSchema,\n})\n"],"mappings":";AAAA,SAAS,uBAAuB;AAKhC;AAAA,EACE;AAAA,EACA;AAAA,OACK;;;ACRP,SAAS,gBAAgB;AAElB,IAAM,WAAW,SAAS,kBAAkB,IAAI;;;AD+BhD,IAAM,OAAO,sBAA0B,QAAQ;AAC/C,IAAM,OAAO,gBAAgB,OAAO,IAAI;AACxC,IAAM,eAAe,gBAAgB,eAAe,IAAI;AAKxD,IAAM,kBAAkB,iCAAkD,QAAQ;;;AExCzF,SAAS,2BAA2B;;;ACG7B,IAAM,oBAAoB,OAAW;AAAA,EAC1C,MAAM;AAAA,EACN,QAAQ;AACV;;;ADAO,IAAM,kBAAkB,MAC7B,oBAAwB;AAAA,EACtB,QAAQ;AAAA,EACR,UAAU;AACZ,CAAC;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/id-payload-plugin",
3
- "version": "5.3.30",
3
+ "version": "5.4.0",
4
4
  "description": "Typescript/Javascript Plugins for XYO Platform",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -22,12 +22,10 @@
22
22
  "exports": {
23
23
  ".": {
24
24
  "types": "./dist/neutral/index.d.ts",
25
- "import": "./dist/neutral/index.mjs",
26
25
  "default": "./dist/neutral/index.mjs"
27
26
  },
28
27
  "./package.json": "./package.json"
29
28
  },
30
- "types": "dist/neutral/index.d.ts",
31
29
  "files": [
32
30
  "dist",
33
31
  "!**/*.bench.*",
@@ -36,36 +34,34 @@
36
34
  "README.md"
37
35
  ],
38
36
  "dependencies": {
39
- "@xyo-network/payload-model": "~5.3.30",
40
- "@xyo-network/payload-plugin": "~5.3.30"
37
+ "@xyo-network/payload-model": "~5.4.0",
38
+ "@xyo-network/payload-plugin": "~5.4.0"
41
39
  },
42
40
  "devDependencies": {
43
41
  "@opentelemetry/api": "^1.9.1",
44
- "@types/node": "^25.5.2",
45
- "@xylabs/sdk-js": "^5.0.95",
46
- "@xylabs/ts-scripts-common": "~7.8.6",
47
- "@xylabs/ts-scripts-pnpm": "~7.8.6",
48
- "@xylabs/tsconfig": "~7.8.6",
49
- "@xylabs/vitest-extended": "~5.0.95",
50
- "@xylabs/vitest-matchers": "~5.0.95",
51
- "@xyo-network/hash": "~5.3.30",
52
- "@xyo-network/payload-builder": "~5.3.30",
53
- "@xyo-network/payload-validator": "~5.3.30",
54
- "@xyo-network/wasm": "~5.3.30",
55
- "axios": "^1.14.0",
42
+ "@types/node": "^25.6.0",
43
+ "@xylabs/sdk-js": "^5.0.97",
44
+ "@xylabs/toolchain": "~7.10.8",
45
+ "@xylabs/tsconfig": "~7.10.8",
46
+ "@xylabs/vitest-extended": "~5.0.97",
47
+ "@xylabs/vitest-matchers": "~5.0.97",
56
48
  "esbuild": "^0.28.0",
57
49
  "pako": "~2.1.0",
58
50
  "typescript": "~5.9.3",
59
- "vite": "^8.0.5",
60
- "vitest": "~4.1.2",
61
- "zod": "^4.3.6"
51
+ "vite": "^8.0.8",
52
+ "vitest": "~4.1.4",
53
+ "zod": "^4.3.6",
54
+ "@xyo-network/payload-builder": "~5.4.0",
55
+ "@xyo-network/hash": "~5.4.0",
56
+ "@xyo-network/wasm": "~5.4.0",
57
+ "@xyo-network/payload-validator": "~5.4.0"
62
58
  },
63
59
  "peerDependencies": {
64
- "@xylabs/sdk-js": "^5",
65
- "@xyo-network/payload-builder": "~5.3",
66
- "@xyo-network/payload-validator": "~5.3"
60
+ "@xylabs/sdk-js": "^5.0.97",
61
+ "@xyo-network/payload-builder": "~5.4",
62
+ "@xyo-network/payload-validator": "~5.4"
67
63
  },
68
64
  "publishConfig": {
69
65
  "access": "public"
70
66
  }
71
- }
67
+ }