@xyo-network/diviner-schema-list-model 5.3.25 → 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 +234 -10
  2. package/package.json +13 -13
package/README.md CHANGED
@@ -1,23 +1,247 @@
1
+ [![logo][]](https://xyo.network)
2
+
1
3
  # @xyo-network/diviner-schema-list-model
2
4
 
3
- [![logo][]](https://xyo.network)
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
- Version: 5.0.2
14
+ ```sh
15
+ npm install {{name}}
16
+ ```
6
17
 
7
- Primary SDK for using XYO Protocol 2.0
18
+ Using yarn:
8
19
 
9
- ## Documentation
20
+ ```sh
21
+ yarn add {{name}}
22
+ ```
10
23
 
11
- [TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__diviner-schema-list-model)
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
- > 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
+ ### modules
46
+
47
+ ### packages
48
+
49
+ ### diviner
50
+
51
+ ### packages
52
+
53
+ ### schemalist
54
+
55
+ ### packages
56
+
57
+ ### model
58
+
59
+ ### .temp-typedoc
60
+
61
+ ### functions
62
+
63
+ ### <a id="isSchemaListPayload"></a>isSchemaListPayload
64
+
65
+ [**@xyo-network/diviner-schema-list-model**](#../README)
66
+
67
+ ***
68
+
69
+ ```ts
70
+ function isSchemaListPayload(x?): x is SchemaListPayload;
71
+ ```
72
+
73
+ ## Parameters
74
+
75
+ ### x?
76
+
77
+ `Payload` \| `null`
78
+
79
+ ## Returns
80
+
81
+ `x is SchemaListPayload`
82
+
83
+ ### <a id="isSchemaListQueryPayload"></a>isSchemaListQueryPayload
84
+
85
+ [**@xyo-network/diviner-schema-list-model**](#../README)
86
+
87
+ ***
88
+
89
+ ```ts
90
+ function isSchemaListQueryPayload(x?): x is SchemaListQueryPayload;
91
+ ```
92
+
93
+ ## Parameters
94
+
95
+ ### x?
96
+
97
+ `Payload` \| `null`
98
+
99
+ ## Returns
100
+
101
+ `x is SchemaListQueryPayload`
102
+
103
+ ### type-aliases
104
+
105
+ ### <a id="SchemaListDivinerConfig"></a>SchemaListDivinerConfig
106
+
107
+ [**@xyo-network/diviner-schema-list-model**](#../README)
108
+
109
+ ***
110
+
111
+ ```ts
112
+ type SchemaListDivinerConfig<T> = DivinerConfig<T & object>;
113
+ ```
114
+
115
+ ## Type Parameters
116
+
117
+ ### T
118
+
119
+ `T` *extends* `Payload` = `Payload`
120
+
121
+ ### <a id="SchemaListDivinerConfigSchema"></a>SchemaListDivinerConfigSchema
122
+
123
+ [**@xyo-network/diviner-schema-list-model**](#../README)
124
+
125
+ ***
126
+
127
+ ```ts
128
+ type SchemaListDivinerConfigSchema = typeof SchemaListDivinerConfigSchema;
129
+ ```
130
+
131
+ ### <a id="SchemaListDivinerParams"></a>SchemaListDivinerParams
132
+
133
+ [**@xyo-network/diviner-schema-list-model**](#../README)
134
+
135
+ ***
136
+
137
+ ```ts
138
+ type SchemaListDivinerParams = DivinerParams<AnyConfigSchema<SchemaListDivinerConfig>>;
139
+ ```
140
+
141
+ ### <a id="SchemaListDivinerSchema"></a>SchemaListDivinerSchema
142
+
143
+ [**@xyo-network/diviner-schema-list-model**](#../README)
144
+
145
+ ***
146
+
147
+ ```ts
148
+ type SchemaListDivinerSchema = typeof SchemaListDivinerSchema;
149
+ ```
150
+
151
+ ### <a id="SchemaListPayload"></a>SchemaListPayload
152
+
153
+ [**@xyo-network/diviner-schema-list-model**](#../README)
154
+
155
+ ***
156
+
157
+ ```ts
158
+ type SchemaListPayload = Payload<{
159
+ schema: SchemaListDivinerSchema;
160
+ schemas: string[];
161
+ }>;
162
+ ```
163
+
164
+ ### <a id="SchemaListQueryPayload"></a>SchemaListQueryPayload
165
+
166
+ [**@xyo-network/diviner-schema-list-model**](#../README)
167
+
168
+ ***
169
+
170
+ ```ts
171
+ type SchemaListQueryPayload = Query<{
172
+ schema: SchemaListQuerySchema;
173
+ }>;
174
+ ```
175
+
176
+ ### <a id="SchemaListQuerySchema"></a>SchemaListQuerySchema
177
+
178
+ [**@xyo-network/diviner-schema-list-model**](#../README)
179
+
180
+ ***
181
+
182
+ ```ts
183
+ type SchemaListQuerySchema = typeof SchemaListQuerySchema;
184
+ ```
185
+
186
+ ### variables
187
+
188
+ ### <a id="SchemaListDivinerConfigSchema"></a>SchemaListDivinerConfigSchema
189
+
190
+ [**@xyo-network/diviner-schema-list-model**](#../README)
191
+
192
+ ***
193
+
194
+ ```ts
195
+ const SchemaListDivinerConfigSchema: string & object;
196
+ ```
197
+
198
+ ## Type Declaration
199
+
200
+ ### \_\_schema
201
+
202
+ ```ts
203
+ readonly __schema: true;
204
+ ```
205
+
206
+ ### <a id="SchemaListDivinerSchema"></a>SchemaListDivinerSchema
207
+
208
+ [**@xyo-network/diviner-schema-list-model**](#../README)
209
+
210
+ ***
211
+
212
+ ```ts
213
+ const SchemaListDivinerSchema: "network.xyo.diviner.schema.list" & object;
214
+ ```
215
+
216
+ ## Type Declaration
217
+
218
+ ### \_\_schema
219
+
220
+ ```ts
221
+ readonly __schema: true;
222
+ ```
223
+
224
+ ### <a id="SchemaListQuerySchema"></a>SchemaListQuerySchema
225
+
226
+ [**@xyo-network/diviner-schema-list-model**](#../README)
227
+
228
+ ***
229
+
230
+ ```ts
231
+ const SchemaListQuerySchema: string & object;
232
+ ```
233
+
234
+ ## Type Declaration
235
+
236
+ ### \_\_schema
18
237
 
19
- ## Credits
238
+ ```ts
239
+ readonly __schema: true;
240
+ ```
20
241
 
21
- [Made with 🔥 and ❄️ by XYO](https://xyo.network)
22
242
 
23
- [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
243
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
244
+ [npm-badge]: https://img.shields.io/npm/v/@xyo-network/diviner-schema-list-model.svg
245
+ [npm-link]: https://www.npmjs.com/package/@xyo-network/diviner-schema-list-model
246
+ [license-badge]: https://img.shields.io/npm/l/@xyo-network/diviner-schema-list-model.svg
247
+ [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/diviner-schema-list-model",
3
- "version": "5.3.25",
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,25 +36,25 @@
36
36
  "README.md"
37
37
  ],
38
38
  "dependencies": {
39
- "@xyo-network/diviner-model": "~5.3.25",
40
- "@xyo-network/module-model": "~5.3.25",
41
- "@xyo-network/payload-model": "~5.3.25"
39
+ "@xyo-network/module-model": "~5.3.26",
40
+ "@xyo-network/diviner-model": "~5.3.26",
41
+ "@xyo-network/payload-model": "~5.3.26"
42
42
  },
43
43
  "devDependencies": {
44
44
  "@opentelemetry/api": "^1.9.1",
45
- "@types/node": "^25.5.0",
46
- "@xylabs/sdk-js": "^5.0.93",
47
- "@xylabs/ts-scripts-common": "~7.6.16",
48
- "@xylabs/ts-scripts-pnpm": "~7.6.16",
49
- "@xylabs/tsconfig": "~7.6.16",
45
+ "@types/node": "^25.5.2",
46
+ "@xylabs/sdk-js": "^5.0.94",
47
+ "@xylabs/ts-scripts-common": "~7.7.5",
48
+ "@xylabs/ts-scripts-pnpm": "~7.7.5",
49
+ "@xylabs/tsconfig": "~7.7.5",
50
50
  "acorn": "^8.16.0",
51
51
  "axios": "^1.14.0",
52
52
  "esbuild": "^0.28.0",
53
53
  "typescript": "~5.9.3",
54
54
  "zod": "^4.3.6",
55
- "@xyo-network/module-model": "~5.3.25",
56
- "@xyo-network/diviner-model": "~5.3.25",
57
- "@xyo-network/payload-model": "~5.3.25"
55
+ "@xyo-network/module-model": "~5.3.26",
56
+ "@xyo-network/diviner-model": "~5.3.26",
57
+ "@xyo-network/payload-model": "~5.3.26"
58
58
  },
59
59
  "peerDependencies": {
60
60
  "@xylabs/sdk-js": "^5",