@xyo-network/diviner-payload-model 5.3.29 → 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.
Files changed (2) hide show
  1. package/README.md +0 -234
  2. package/package.json +13 -17
package/README.md CHANGED
@@ -38,240 +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
- ### modules
46
-
47
- ### packages
48
-
49
- ### diviner
50
-
51
- ### packages
52
-
53
- ### payload
54
-
55
- ### packages
56
-
57
- ### model
58
-
59
- ### .temp-typedoc
60
-
61
- ### type-aliases
62
-
63
- ### <a id="Order"></a>Order
64
-
65
- [**@xyo-network/diviner-payload-model**](#../README)
66
-
67
- ***
68
-
69
- ```ts
70
- type Order = "asc" | "desc";
71
- ```
72
-
73
- ### <a id="PayloadDivinerConfig"></a>PayloadDivinerConfig
74
-
75
- [**@xyo-network/diviner-payload-model**](#../README)
76
-
77
- ***
78
-
79
- ```ts
80
- type PayloadDivinerConfig<TAdditional, TSchema> = DivinerConfig<WithAdditional<{
81
- indexBatchSize?: number;
82
- maxIndexSize?: number;
83
- }, TAdditional>, TSchema extends void ? Schema : TSchema>;
84
- ```
85
-
86
- ## Type Parameters
87
-
88
- ### TAdditional
89
-
90
- `TAdditional` *extends* `EmptyObject` \| `void` = `void`
91
-
92
- ### TSchema
93
-
94
- `TSchema` *extends* `Schema` \| `void` = `void`
95
-
96
- ### <a id="PayloadDivinerConfigSchema"></a>PayloadDivinerConfigSchema
97
-
98
- [**@xyo-network/diviner-payload-model**](#../README)
99
-
100
- ***
101
-
102
- ```ts
103
- type PayloadDivinerConfigSchema = typeof PayloadDivinerConfigSchema;
104
- ```
105
-
106
- ### <a id="PayloadDivinerParams"></a>PayloadDivinerParams
107
-
108
- [**@xyo-network/diviner-payload-model**](#../README)
109
-
110
- ***
111
-
112
- ```ts
113
- type PayloadDivinerParams<T> = DivinerParams<T extends AnyConfigSchema<PayloadDivinerConfig> ? T : AnyConfigSchema<PayloadDivinerConfig>>;
114
- ```
115
-
116
- ## Type Parameters
117
-
118
- ### T
119
-
120
- `T` *extends*
121
- \| `AnyConfigSchema`\<[`PayloadDivinerConfig`](#PayloadDivinerConfig)\>
122
- \| `void` = `void`
123
-
124
- ### <a id="PayloadDivinerPredicate"></a>PayloadDivinerPredicate
125
-
126
- [**@xyo-network/diviner-payload-model**](#../README)
127
-
128
- ***
129
-
130
- ```ts
131
- type PayloadDivinerPredicate<T> = Partial<object & T>;
132
- ```
133
-
134
- ## Type Parameters
135
-
136
- ### T
137
-
138
- `T` *extends* `EmptyObject` = `EmptyObject`
139
-
140
- ### <a id="PayloadDivinerQueryPayload"></a>PayloadDivinerQueryPayload
141
-
142
- [**@xyo-network/diviner-payload-model**](#../README)
143
-
144
- ***
145
-
146
- ```ts
147
- type PayloadDivinerQueryPayload<T> = Query<object & PayloadDivinerPredicate<T>>;
148
- ```
149
-
150
- ## Type Parameters
151
-
152
- ### T
153
-
154
- `T` *extends* `EmptyObject` = `EmptyObject`
155
-
156
- ### <a id="PayloadDivinerQuerySchema"></a>PayloadDivinerQuerySchema
157
-
158
- [**@xyo-network/diviner-payload-model**](#../README)
159
-
160
- ***
161
-
162
- ```ts
163
- type PayloadDivinerQuerySchema = typeof PayloadDivinerQuerySchema;
164
- ```
165
-
166
- ### <a id="PayloadDivinerSchema"></a>PayloadDivinerSchema
167
-
168
- [**@xyo-network/diviner-payload-model**](#../README)
169
-
170
- ***
171
-
172
- ```ts
173
- type PayloadDivinerSchema = typeof PayloadDivinerSchema;
174
- ```
175
-
176
- ### <a id="SortDirection"></a>SortDirection
177
-
178
- [**@xyo-network/diviner-payload-model**](#../README)
179
-
180
- ***
181
-
182
- ```ts
183
- type SortDirection = "asc" | "desc";
184
- ```
185
-
186
- ## Deprecated
187
-
188
- use Order instead
189
-
190
- ### variables
191
-
192
- ### <a id="PayloadDivinerConfigSchema"></a>PayloadDivinerConfigSchema
193
-
194
- [**@xyo-network/diviner-payload-model**](#../README)
195
-
196
- ***
197
-
198
- ```ts
199
- const PayloadDivinerConfigSchema: string & object;
200
- ```
201
-
202
- ## Type Declaration
203
-
204
- ### \_\_schema
205
-
206
- ```ts
207
- readonly __schema: true;
208
- ```
209
-
210
- ### <a id="PayloadDivinerQuerySchema"></a>PayloadDivinerQuerySchema
211
-
212
- [**@xyo-network/diviner-payload-model**](#../README)
213
-
214
- ***
215
-
216
- ```ts
217
- const PayloadDivinerQuerySchema: string & object;
218
- ```
219
-
220
- ## Type Declaration
221
-
222
- ### \_\_schema
223
-
224
- ```ts
225
- readonly __schema: true;
226
- ```
227
-
228
- ### <a id="PayloadDivinerSchema"></a>PayloadDivinerSchema
229
-
230
- [**@xyo-network/diviner-payload-model**](#../README)
231
-
232
- ***
233
-
234
- ```ts
235
- const PayloadDivinerSchema: "network.xyo.diviner.payload" & object;
236
- ```
237
-
238
- ## Type Declaration
239
-
240
- ### \_\_schema
241
-
242
- ```ts
243
- readonly __schema: true;
244
- ```
245
-
246
- ### <a id="asPayloadDivinerQueryPayload"></a>asPayloadDivinerQueryPayload
247
-
248
- [**@xyo-network/diviner-payload-model**](#../README)
249
-
250
- ***
251
-
252
- ```ts
253
- const asPayloadDivinerQueryPayload: AsTypeFunction<PayloadDivinerQueryPayload<object>>;
254
- ```
255
-
256
- ### <a id="isPayloadDivinerQueryPayload"></a>isPayloadDivinerQueryPayload
257
-
258
- [**@xyo-network/diviner-payload-model**](#../README)
259
-
260
- ***
261
-
262
- ```ts
263
- const isPayloadDivinerQueryPayload: (x?) => x is PayloadDivinerQueryPayload<object>;
264
- ```
265
-
266
- ## Parameters
267
-
268
- ### x?
269
-
270
- `unknown`
271
-
272
- ## Returns
273
-
274
- `x is PayloadDivinerQueryPayload<object>`
275
41
 
276
42
 
277
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/diviner-payload-model",
3
- "version": "5.3.29",
3
+ "version": "5.4.0",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
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,28 +34,26 @@
36
34
  "README.md"
37
35
  ],
38
36
  "dependencies": {
39
- "@xyo-network/payload-model": "~5.3.29"
37
+ "@xyo-network/payload-model": "~5.4.0"
40
38
  },
41
39
  "devDependencies": {
42
40
  "@opentelemetry/api": "^1.9.1",
43
- "@xylabs/sdk-js": "^5.0.95",
44
- "@xylabs/ts-scripts-common": "~7.8.4",
45
- "@xylabs/ts-scripts-pnpm": "~7.8.4",
46
- "@xylabs/tsconfig": "~7.8.4",
47
- "axios": "^1.14.0",
41
+ "@xylabs/sdk-js": "^5.0.97",
42
+ "@xylabs/toolchain": "~7.10.8",
43
+ "@xylabs/tsconfig": "~7.10.8",
48
44
  "pako": "~2.1.0",
49
45
  "typescript": "~5.9.3",
50
46
  "zod": "^4.3.6",
51
- "@xyo-network/diviner-model": "~5.3.29",
52
- "@xyo-network/module-model": "~5.3.29",
53
- "@xyo-network/manifest-model": "~5.3.29",
54
- "@xyo-network/account-model": "~5.3.29",
55
- "@xyo-network/previous-hash-store-model": "~5.3.29"
47
+ "@xyo-network/account-model": "~5.4.0",
48
+ "@xyo-network/diviner-model": "~5.4.0",
49
+ "@xyo-network/manifest-model": "~5.4.0",
50
+ "@xyo-network/previous-hash-store-model": "~5.4.0",
51
+ "@xyo-network/module-model": "~5.4.0"
56
52
  },
57
53
  "peerDependencies": {
58
- "@xylabs/sdk-js": "^5",
59
- "@xyo-network/diviner-model": "~5.3.29",
60
- "@xyo-network/module-model": "~5.3.29"
54
+ "@xylabs/sdk-js": "^5.0.97",
55
+ "@xyo-network/diviner-model": "~5.4",
56
+ "@xyo-network/module-model": "~5.4"
61
57
  },
62
58
  "publishConfig": {
63
59
  "access": "public"