@xyo-network/schema-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 +0 -135
- package/package.json +19 -23
package/README.md
CHANGED
|
@@ -38,141 +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
|
-
### schema
|
|
50
|
-
|
|
51
|
-
### .temp-typedoc
|
|
52
|
-
|
|
53
|
-
### functions
|
|
54
|
-
|
|
55
|
-
### <a id="SchemaPayloadPlugin"></a>SchemaPayloadPlugin
|
|
56
|
-
|
|
57
|
-
[**@xyo-network/schema-payload-plugin**](#../README)
|
|
58
|
-
|
|
59
|
-
***
|
|
60
|
-
|
|
61
|
-
```ts
|
|
62
|
-
function SchemaPayloadPlugin(): PayloadPlugin<SchemaPayload>;
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
## Returns
|
|
66
|
-
|
|
67
|
-
`PayloadPlugin`\<[`SchemaPayload`](#../type-aliases/SchemaPayload)\>
|
|
68
|
-
|
|
69
|
-
### <a id="schemaPayloadTemplate"></a>schemaPayloadTemplate
|
|
70
|
-
|
|
71
|
-
[**@xyo-network/schema-payload-plugin**](#../README)
|
|
72
|
-
|
|
73
|
-
***
|
|
74
|
-
|
|
75
|
-
```ts
|
|
76
|
-
function schemaPayloadTemplate(): SchemaPayload;
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
## Returns
|
|
80
|
-
|
|
81
|
-
[`SchemaPayload`](#../type-aliases/SchemaPayload)
|
|
82
|
-
|
|
83
|
-
### type-aliases
|
|
84
|
-
|
|
85
|
-
### <a id="SchemaPayload"></a>SchemaPayload
|
|
86
|
-
|
|
87
|
-
[**@xyo-network/schema-payload-plugin**](#../README)
|
|
88
|
-
|
|
89
|
-
***
|
|
90
|
-
|
|
91
|
-
```ts
|
|
92
|
-
type SchemaPayload = Payload<{
|
|
93
|
-
definition: {
|
|
94
|
-
[key: string]: unknown;
|
|
95
|
-
$id?: string;
|
|
96
|
-
};
|
|
97
|
-
extends?: string;
|
|
98
|
-
name?: string;
|
|
99
|
-
version?: number;
|
|
100
|
-
}, SchemaSchema>;
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
### <a id="SchemaSchema"></a>SchemaSchema
|
|
104
|
-
|
|
105
|
-
[**@xyo-network/schema-payload-plugin**](#../README)
|
|
106
|
-
|
|
107
|
-
***
|
|
108
|
-
|
|
109
|
-
```ts
|
|
110
|
-
type SchemaSchema = typeof SchemaSchema;
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
### variables
|
|
114
|
-
|
|
115
|
-
### <a id="SchemaSchema"></a>SchemaSchema
|
|
116
|
-
|
|
117
|
-
[**@xyo-network/schema-payload-plugin**](#../README)
|
|
118
|
-
|
|
119
|
-
***
|
|
120
|
-
|
|
121
|
-
```ts
|
|
122
|
-
const SchemaSchema: "network.xyo.schema" & object;
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
## Type Declaration
|
|
126
|
-
|
|
127
|
-
### \_\_schema
|
|
128
|
-
|
|
129
|
-
```ts
|
|
130
|
-
readonly __schema: true;
|
|
131
|
-
```
|
|
132
|
-
|
|
133
|
-
### <a id="isSchemaPayload"></a>isSchemaPayload
|
|
134
|
-
|
|
135
|
-
[**@xyo-network/schema-payload-plugin**](#../README)
|
|
136
|
-
|
|
137
|
-
***
|
|
138
|
-
|
|
139
|
-
```ts
|
|
140
|
-
const isSchemaPayload: (x?) => x is SchemaPayload;
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
Identity function for determining if an object is an Schema
|
|
144
|
-
|
|
145
|
-
## Parameters
|
|
146
|
-
|
|
147
|
-
### x?
|
|
148
|
-
|
|
149
|
-
`unknown`
|
|
150
|
-
|
|
151
|
-
## Returns
|
|
152
|
-
|
|
153
|
-
`x is SchemaPayload`
|
|
154
|
-
|
|
155
|
-
### <a id="isSchemaPayloadWithSources"></a>isSchemaPayloadWithSources
|
|
156
|
-
|
|
157
|
-
[**@xyo-network/schema-payload-plugin**](#../README)
|
|
158
|
-
|
|
159
|
-
***
|
|
160
|
-
|
|
161
|
-
```ts
|
|
162
|
-
const isSchemaPayloadWithSources: (x?) => x is WithSources<SchemaPayload>;
|
|
163
|
-
```
|
|
164
|
-
|
|
165
|
-
Identity function for determining if an object is an Schema with sources
|
|
166
|
-
|
|
167
|
-
## Parameters
|
|
168
|
-
|
|
169
|
-
### x?
|
|
170
|
-
|
|
171
|
-
`unknown`
|
|
172
|
-
|
|
173
|
-
## Returns
|
|
174
|
-
|
|
175
|
-
`x is WithSources<SchemaPayload>`
|
|
176
41
|
|
|
177
42
|
|
|
178
43
|
[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xyo-network/schema-payload-plugin",
|
|
3
|
-
"version": "5.
|
|
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,35 +34,33 @@
|
|
|
36
34
|
"README.md"
|
|
37
35
|
],
|
|
38
36
|
"dependencies": {
|
|
39
|
-
"@xyo-network/payload-
|
|
40
|
-
"@xyo-network/payload-
|
|
37
|
+
"@xyo-network/payload-plugin": "~5.4.0",
|
|
38
|
+
"@xyo-network/payload-model": "~5.4.0"
|
|
41
39
|
},
|
|
42
40
|
"devDependencies": {
|
|
43
41
|
"@opentelemetry/api": "^1.9.1",
|
|
44
|
-
"@types/node": "^25.
|
|
45
|
-
"@xylabs/sdk-js": "^5.0.
|
|
46
|
-
"@xylabs/
|
|
47
|
-
"@xylabs/
|
|
48
|
-
"@xylabs/
|
|
49
|
-
"@xylabs/vitest-
|
|
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.
|
|
60
|
-
"vitest": "~4.1.
|
|
61
|
-
"zod": "^4.3.6"
|
|
51
|
+
"vite": "^8.0.8",
|
|
52
|
+
"vitest": "~4.1.4",
|
|
53
|
+
"zod": "^4.3.6",
|
|
54
|
+
"@xyo-network/hash": "~5.4.0",
|
|
55
|
+
"@xyo-network/payload-builder": "~5.4.0",
|
|
56
|
+
"@xyo-network/payload-validator": "~5.4.0",
|
|
57
|
+
"@xyo-network/wasm": "~5.4.0"
|
|
62
58
|
},
|
|
63
59
|
"peerDependencies": {
|
|
64
|
-
"@xyo-network/payload-builder": "~5.
|
|
65
|
-
"@xyo-network/payload-validator": "~5.
|
|
60
|
+
"@xyo-network/payload-builder": "~5.4",
|
|
61
|
+
"@xyo-network/payload-validator": "~5.4"
|
|
66
62
|
},
|
|
67
63
|
"publishConfig": {
|
|
68
64
|
"access": "public"
|
|
69
65
|
}
|
|
70
|
-
}
|
|
66
|
+
}
|