@xyo-network/payload-validator 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.
- package/README.md +223 -10
- package/package.json +12 -12
package/README.md
CHANGED
|
@@ -1,23 +1,236 @@
|
|
|
1
|
+
[![logo][]](https://xyo.network)
|
|
2
|
+
|
|
1
3
|
# @xyo-network/payload-validator
|
|
2
4
|
|
|
3
|
-
[![
|
|
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:
|
|
4
13
|
|
|
5
|
-
|
|
14
|
+
```sh
|
|
15
|
+
npm install {{name}}
|
|
16
|
+
```
|
|
6
17
|
|
|
7
|
-
|
|
18
|
+
Using yarn:
|
|
8
19
|
|
|
9
|
-
|
|
20
|
+
```sh
|
|
21
|
+
yarn add {{name}}
|
|
22
|
+
```
|
|
10
23
|
|
|
11
|
-
|
|
24
|
+
Using pnpm:
|
|
25
|
+
|
|
26
|
+
```sh
|
|
27
|
+
pnpm add {{name}}
|
|
28
|
+
```
|
|
29
|
+
|
|
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
|
-
|
|
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
|
+
### validator
|
|
54
|
+
|
|
55
|
+
### .temp-typedoc
|
|
56
|
+
|
|
57
|
+
### classes
|
|
58
|
+
|
|
59
|
+
### <a id="PayloadValidator"></a>PayloadValidator
|
|
60
|
+
|
|
61
|
+
[**@xyo-network/payload-validator**](#../README)
|
|
62
|
+
|
|
63
|
+
***
|
|
64
|
+
|
|
65
|
+
## Extends
|
|
66
|
+
|
|
67
|
+
- `ValidatorBase`\<`T`\>
|
|
68
|
+
|
|
69
|
+
## Type Parameters
|
|
70
|
+
|
|
71
|
+
### T
|
|
72
|
+
|
|
73
|
+
`T` *extends* `Payload` = `Payload`
|
|
74
|
+
|
|
75
|
+
## Implements
|
|
76
|
+
|
|
77
|
+
- `Validator`\<`T`\>
|
|
78
|
+
|
|
79
|
+
## Constructors
|
|
80
|
+
|
|
81
|
+
### Constructor
|
|
82
|
+
|
|
83
|
+
```ts
|
|
84
|
+
new PayloadValidator<T>(payload): PayloadValidator<T>;
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Parameters
|
|
88
|
+
|
|
89
|
+
#### payload
|
|
90
|
+
|
|
91
|
+
`T`
|
|
92
|
+
|
|
93
|
+
### Returns
|
|
94
|
+
|
|
95
|
+
`PayloadValidator`\<`T`\>
|
|
96
|
+
|
|
97
|
+
### Overrides
|
|
98
|
+
|
|
99
|
+
```ts
|
|
100
|
+
ValidatorBase<T>.constructor
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
## Properties
|
|
104
|
+
|
|
105
|
+
### schemaNameValidatorFactory
|
|
106
|
+
|
|
107
|
+
```ts
|
|
108
|
+
protected static schemaNameValidatorFactory: AllValidatorFactory = defaultSchemaNameValidatorFactory;
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
***
|
|
112
|
+
|
|
113
|
+
### payload
|
|
114
|
+
|
|
115
|
+
```ts
|
|
116
|
+
protected payload: Payload;
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
## Accessors
|
|
120
|
+
|
|
121
|
+
### schemaValidator
|
|
122
|
+
|
|
123
|
+
### Get Signature
|
|
124
|
+
|
|
125
|
+
```ts
|
|
126
|
+
get schemaValidator(): AllValidator;
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
#### Returns
|
|
130
|
+
|
|
131
|
+
[`AllValidator`](#../type-aliases/AllValidator)
|
|
132
|
+
|
|
133
|
+
## Methods
|
|
134
|
+
|
|
135
|
+
### setSchemaNameValidatorFactory()
|
|
136
|
+
|
|
137
|
+
```ts
|
|
138
|
+
static setSchemaNameValidatorFactory(factory): void;
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### Parameters
|
|
142
|
+
|
|
143
|
+
#### factory
|
|
144
|
+
|
|
145
|
+
[`AllValidatorFactory`](#../type-aliases/AllValidatorFactory)
|
|
146
|
+
|
|
147
|
+
### Returns
|
|
148
|
+
|
|
149
|
+
`void`
|
|
150
|
+
|
|
151
|
+
***
|
|
152
|
+
|
|
153
|
+
### schemaName()
|
|
154
|
+
|
|
155
|
+
```ts
|
|
156
|
+
schemaName(): Error[];
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
### Returns
|
|
160
|
+
|
|
161
|
+
`Error`[]
|
|
162
|
+
|
|
163
|
+
***
|
|
164
|
+
|
|
165
|
+
### validate()
|
|
166
|
+
|
|
167
|
+
```ts
|
|
168
|
+
validate(): Promisable<Error[]>;
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### Returns
|
|
172
|
+
|
|
173
|
+
`Promisable`\<`Error`[]\>
|
|
174
|
+
|
|
175
|
+
### Implementation of
|
|
176
|
+
|
|
177
|
+
```ts
|
|
178
|
+
Validator.validate
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
### Overrides
|
|
182
|
+
|
|
183
|
+
```ts
|
|
184
|
+
ValidatorBase.validate
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
### type-aliases
|
|
188
|
+
|
|
189
|
+
### <a id="AllValidator"></a>AllValidator
|
|
190
|
+
|
|
191
|
+
[**@xyo-network/payload-validator**](#../README)
|
|
192
|
+
|
|
193
|
+
***
|
|
194
|
+
|
|
195
|
+
```ts
|
|
196
|
+
type AllValidator = object;
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
## Methods
|
|
200
|
+
|
|
201
|
+
### all()
|
|
202
|
+
|
|
203
|
+
```ts
|
|
204
|
+
all(): Error[];
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
### Returns
|
|
208
|
+
|
|
209
|
+
`Error`[]
|
|
210
|
+
|
|
211
|
+
### <a id="AllValidatorFactory"></a>AllValidatorFactory
|
|
212
|
+
|
|
213
|
+
[**@xyo-network/payload-validator**](#../README)
|
|
214
|
+
|
|
215
|
+
***
|
|
216
|
+
|
|
217
|
+
```ts
|
|
218
|
+
type AllValidatorFactory = (schema) => AllValidator;
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
## Parameters
|
|
222
|
+
|
|
223
|
+
### schema
|
|
224
|
+
|
|
225
|
+
`string`
|
|
226
|
+
|
|
227
|
+
## Returns
|
|
18
228
|
|
|
19
|
-
|
|
229
|
+
[`AllValidator`](#AllValidator)
|
|
20
230
|
|
|
21
|
-
[Made with 🔥 and ❄️ by XYO](https://xyo.network)
|
|
22
231
|
|
|
23
|
-
[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
|
|
232
|
+
[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
|
|
233
|
+
[npm-badge]: https://img.shields.io/npm/v/@xyo-network/payload-validator.svg
|
|
234
|
+
[npm-link]: https://www.npmjs.com/package/@xyo-network/payload-validator
|
|
235
|
+
[license-badge]: https://img.shields.io/npm/l/@xyo-network/payload-validator.svg
|
|
236
|
+
[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-validator",
|
|
3
|
-
"version": "5.3.
|
|
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/payload-model": "~5.3.
|
|
40
|
-
"@xyo-network/schema-name-validator": "~5.3.
|
|
39
|
+
"@xyo-network/payload-model": "~5.3.26",
|
|
40
|
+
"@xyo-network/schema-name-validator": "~5.3.26"
|
|
41
41
|
},
|
|
42
42
|
"devDependencies": {
|
|
43
43
|
"@opentelemetry/api": "^1.9.1",
|
|
44
|
-
"@types/node": "^25.5.
|
|
45
|
-
"@xylabs/sdk-js": "^5.0.
|
|
46
|
-
"@xylabs/ts-scripts-common": "~7.
|
|
47
|
-
"@xylabs/ts-scripts-pnpm": "~7.
|
|
48
|
-
"@xylabs/tsconfig": "~7.
|
|
49
|
-
"@xylabs/vitest-extended": "~5.0.
|
|
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/
|
|
58
|
-
"@xyo-network/
|
|
57
|
+
"@xyo-network/schema-name-validator": "~5.3.26",
|
|
58
|
+
"@xyo-network/payload-model": "~5.3.26"
|
|
59
59
|
},
|
|
60
60
|
"peerDependencies": {
|
|
61
61
|
"@xylabs/sdk-js": "^5",
|