@xyo-network/schema-payload-plugin 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 +169 -10
  2. package/package.json +10 -10
package/README.md CHANGED
@@ -1,23 +1,182 @@
1
+ [![logo][]](https://xyo.network)
2
+
1
3
  # @xyo-network/schema-payload-plugin
2
4
 
3
- [![logo][]](https://xyo.network)
5
+ [![npm][npm-badge]][npm-link]
6
+ [![license][license-badge]][license-link]
7
+
8
+ > Typescript/Javascript Plugins for XYO Platform
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
- Typescript/Javascript Plugins for XYO Platform
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__schema-payload-plugin)
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
+ ### 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
18
174
 
19
- ## Credits
175
+ `x is WithSources<SchemaPayload>`
20
176
 
21
- [Made with 🔥 and ❄️ by XYO](https://xyo.network)
22
177
 
23
- [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
178
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
179
+ [npm-badge]: https://img.shields.io/npm/v/@xyo-network/schema-payload-plugin.svg
180
+ [npm-link]: https://www.npmjs.com/package/@xyo-network/schema-payload-plugin
181
+ [license-badge]: https://img.shields.io/npm/l/@xyo-network/schema-payload-plugin.svg
182
+ [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/schema-payload-plugin",
3
- "version": "5.3.24",
3
+ "version": "5.3.26",
4
4
  "description": "Typescript/Javascript Plugins for XYO Platform",
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.24",
40
- "@xyo-network/payload-plugin": "~5.3.24"
39
+ "@xyo-network/payload-plugin": "~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",