@xyo-network/diviner-forecasting-model 5.3.30 → 5.4.1

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 -371
  2. package/package.json +15 -19
package/README.md CHANGED
@@ -38,377 +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
- ### forecasting
54
-
55
- ### packages
56
-
57
- ### model
58
-
59
- ### .temp-typedoc
60
-
61
- ### functions
62
-
63
- ### <a id="isForecastPayload"></a>isForecastPayload
64
-
65
- [**@xyo-network/diviner-forecasting-model**](#../README)
66
-
67
- ***
68
-
69
- ```ts
70
- function isForecastPayload(x?): x is ForecastPayload;
71
- ```
72
-
73
- ## Parameters
74
-
75
- ### x?
76
-
77
- `Payload` \| `null`
78
-
79
- ## Returns
80
-
81
- `x is ForecastPayload`
82
-
83
- ### <a id="isForecastingDivinerQueryPayload"></a>isForecastingDivinerQueryPayload
84
-
85
- [**@xyo-network/diviner-forecasting-model**](#../README)
86
-
87
- ***
88
-
89
- ```ts
90
- function isForecastingDivinerQueryPayload(x?): x is ForecastingDivinerQueryPayload;
91
- ```
92
-
93
- ## Parameters
94
-
95
- ### x?
96
-
97
- `Payload` \| `null`
98
-
99
- ## Returns
100
-
101
- `x is ForecastingDivinerQueryPayload`
102
-
103
- ### interfaces
104
-
105
- ### <a id="Forecast"></a>Forecast
106
-
107
- [**@xyo-network/diviner-forecasting-model**](#../README)
108
-
109
- ***
110
-
111
- ## Properties
112
-
113
- ### error?
114
-
115
- ```ts
116
- optional error?: number;
117
- ```
118
-
119
- ***
120
-
121
- ### timestamp?
122
-
123
- ```ts
124
- optional timestamp?: number;
125
- ```
126
-
127
- ***
128
-
129
- ### value
130
-
131
- ```ts
132
- value: number;
133
- ```
134
-
135
- ### <a id="ForecastingSettings"></a>ForecastingSettings
136
-
137
- [**@xyo-network/diviner-forecasting-model**](#../README)
138
-
139
- ***
140
-
141
- ## Properties
142
-
143
- ### batchLimit?
144
-
145
- ```ts
146
- optional batchLimit?: number;
147
- ```
148
-
149
- ***
150
-
151
- ### forecastingMethod?
152
-
153
- ```ts
154
- optional forecastingMethod?: string;
155
- ```
156
-
157
- ***
158
-
159
- ### forecastingSteps?
160
-
161
- ```ts
162
- optional forecastingSteps?: number;
163
- ```
164
-
165
- ***
166
-
167
- ### maxTrainingLength?
168
-
169
- ```ts
170
- optional maxTrainingLength?: number;
171
- ```
172
-
173
- ***
174
-
175
- ### timestamp?
176
-
177
- ```ts
178
- optional timestamp?: number;
179
- ```
180
-
181
- ***
182
-
183
- ### windowSize?
184
-
185
- ```ts
186
- optional windowSize?: number;
187
- ```
188
-
189
- ***
190
-
191
- ### witnessAddresses?
192
-
193
- ```ts
194
- optional witnessAddresses?: BrandedAddress[];
195
- ```
196
-
197
- ***
198
-
199
- ### witnessSchema?
200
-
201
- ```ts
202
- optional witnessSchema?: Schema;
203
- ```
204
-
205
- ### <a id="TransformerSettings"></a>TransformerSettings
206
-
207
- [**@xyo-network/diviner-forecasting-model**](#../README)
208
-
209
- ***
210
-
211
- ## Properties
212
-
213
- ### jsonPathExpression?
214
-
215
- ```ts
216
- optional jsonPathExpression?: string;
217
- ```
218
-
219
- ### type-aliases
220
-
221
- ### <a id="ForecastPayload"></a>ForecastPayload
222
-
223
- [**@xyo-network/diviner-forecasting-model**](#../README)
224
-
225
- ***
226
-
227
- ```ts
228
- type ForecastPayload = Payload<{
229
- schema: ForecastPayloadSchema;
230
- sources: string[];
231
- values: Forecast[];
232
- }>;
233
- ```
234
-
235
- ### <a id="ForecastPayloadSchema"></a>ForecastPayloadSchema
236
-
237
- [**@xyo-network/diviner-forecasting-model**](#../README)
238
-
239
- ***
240
-
241
- ```ts
242
- type ForecastPayloadSchema = typeof ForecastPayloadSchema;
243
- ```
244
-
245
- ### <a id="ForecastingDivinerConfig"></a>ForecastingDivinerConfig
246
-
247
- [**@xyo-network/diviner-forecasting-model**](#../README)
248
-
249
- ***
250
-
251
- ```ts
252
- type ForecastingDivinerConfig = DivinerConfig<object & ForecastingSettings & TransformerSettings>;
253
- ```
254
-
255
- ### <a id="ForecastingDivinerConfigSchema"></a>ForecastingDivinerConfigSchema
256
-
257
- [**@xyo-network/diviner-forecasting-model**](#../README)
258
-
259
- ***
260
-
261
- ```ts
262
- type ForecastingDivinerConfigSchema = typeof ForecastingDivinerConfigSchema;
263
- ```
264
-
265
- ### <a id="ForecastingDivinerQueryPayload"></a>ForecastingDivinerQueryPayload
266
-
267
- [**@xyo-network/diviner-forecasting-model**](#../README)
268
-
269
- ***
270
-
271
- ```ts
272
- type ForecastingDivinerQueryPayload = Query<object & Partial<ForecastingSettings>>;
273
- ```
274
-
275
- ### <a id="ForecastingDivinerQuerySchema"></a>ForecastingDivinerQuerySchema
276
-
277
- [**@xyo-network/diviner-forecasting-model**](#../README)
278
-
279
- ***
280
-
281
- ```ts
282
- type ForecastingDivinerQuerySchema = typeof ForecastingDivinerQuerySchema;
283
- ```
284
-
285
- ### <a id="ForecastingDivinerSchema"></a>ForecastingDivinerSchema
286
-
287
- [**@xyo-network/diviner-forecasting-model**](#../README)
288
-
289
- ***
290
-
291
- ```ts
292
- type ForecastingDivinerSchema = typeof ForecastingDivinerSchema;
293
- ```
294
-
295
- ### <a id="ForecastingMethod"></a>ForecastingMethod
296
-
297
- [**@xyo-network/diviner-forecasting-model**](#../README)
298
-
299
- ***
300
-
301
- ```ts
302
- type ForecastingMethod = (payloads, transformers) => Promisable<Forecast[]>;
303
- ```
304
-
305
- ## Parameters
306
-
307
- ### payloads
308
-
309
- `Payload`[]
310
-
311
- ### transformers
312
-
313
- [`PayloadValueTransformer`](#PayloadValueTransformer)
314
-
315
- ## Returns
316
-
317
- `Promisable`\<[`Forecast`](#../interfaces/Forecast)[]\>
318
-
319
- ### <a id="PayloadValueTransformer"></a>PayloadValueTransformer
320
-
321
- [**@xyo-network/diviner-forecasting-model**](#../README)
322
-
323
- ***
324
-
325
- ```ts
326
- type PayloadValueTransformer = (payload) => number;
327
- ```
328
-
329
- ## Parameters
330
-
331
- ### payload
332
-
333
- `Payload`
334
-
335
- ## Returns
336
-
337
- `number`
338
-
339
- ### variables
340
-
341
- ### <a id="ForecastPayloadSchema"></a>ForecastPayloadSchema
342
-
343
- [**@xyo-network/diviner-forecasting-model**](#../README)
344
-
345
- ***
346
-
347
- ```ts
348
- const ForecastPayloadSchema: string & object;
349
- ```
350
-
351
- ## Type Declaration
352
-
353
- ### \_\_schema
354
-
355
- ```ts
356
- readonly __schema: true;
357
- ```
358
-
359
- ### <a id="ForecastingDivinerConfigSchema"></a>ForecastingDivinerConfigSchema
360
-
361
- [**@xyo-network/diviner-forecasting-model**](#../README)
362
-
363
- ***
364
-
365
- ```ts
366
- const ForecastingDivinerConfigSchema: string & object;
367
- ```
368
-
369
- ## Type Declaration
370
-
371
- ### \_\_schema
372
-
373
- ```ts
374
- readonly __schema: true;
375
- ```
376
-
377
- ### <a id="ForecastingDivinerQuerySchema"></a>ForecastingDivinerQuerySchema
378
-
379
- [**@xyo-network/diviner-forecasting-model**](#../README)
380
-
381
- ***
382
-
383
- ```ts
384
- const ForecastingDivinerQuerySchema: string & object;
385
- ```
386
-
387
- ## Type Declaration
388
-
389
- ### \_\_schema
390
-
391
- ```ts
392
- readonly __schema: true;
393
- ```
394
-
395
- ### <a id="ForecastingDivinerSchema"></a>ForecastingDivinerSchema
396
-
397
- [**@xyo-network/diviner-forecasting-model**](#../README)
398
-
399
- ***
400
-
401
- ```ts
402
- const ForecastingDivinerSchema: "network.xyo.diviner.forecasting" & object;
403
- ```
404
-
405
- ## Type Declaration
406
-
407
- ### \_\_schema
408
-
409
- ```ts
410
- readonly __schema: true;
411
- ```
412
41
 
413
42
 
414
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-forecasting-model",
3
- "version": "5.3.30",
3
+ "version": "5.4.1",
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,30 +34,28 @@
36
34
  "README.md"
37
35
  ],
38
36
  "dependencies": {
39
- "@xyo-network/diviner-model": "~5.3.30",
40
- "@xyo-network/module-model": "~5.3.30",
41
- "@xyo-network/payload-model": "~5.3.30"
37
+ "@xyo-network/diviner-model": "~5.4.1",
38
+ "@xyo-network/module-model": "~5.4.1",
39
+ "@xyo-network/payload-model": "~5.4.1"
42
40
  },
43
41
  "devDependencies": {
44
42
  "@opentelemetry/api": "^1.9.1",
45
- "@xylabs/sdk-js": "^5.0.95",
46
- "@xylabs/ts-scripts-common": "~7.8.6",
47
- "@xylabs/ts-scripts-pnpm": "~7.8.6",
48
- "@xylabs/tsconfig": "~7.8.6",
49
- "@xyo-network/account-model": "~5.3.30",
50
- "@xyo-network/manifest-model": "~5.3.30",
51
- "@xyo-network/previous-hash-store-model": "~5.3.30",
52
- "axios": "^1.14.0",
43
+ "@xylabs/sdk-js": "^5.0.97",
44
+ "@xylabs/toolchain": "~7.10.8",
45
+ "@xylabs/tsconfig": "~7.10.8",
53
46
  "pako": "~2.1.0",
54
47
  "typescript": "~5.9.3",
55
- "zod": "^4.3.6"
48
+ "zod": "^4.3.6",
49
+ "@xyo-network/manifest-model": "~5.4.1",
50
+ "@xyo-network/previous-hash-store-model": "~5.4.1",
51
+ "@xyo-network/account-model": "~5.4.1"
56
52
  },
57
53
  "peerDependencies": {
58
- "@xylabs/sdk-js": "^5",
59
- "@xyo-network/account-model": "~5.3",
60
- "@xyo-network/manifest-model": "~5.3"
54
+ "@xylabs/sdk-js": "^5.0.97",
55
+ "@xyo-network/account-model": "~5.4",
56
+ "@xyo-network/manifest-model": "~5.4"
61
57
  },
62
58
  "publishConfig": {
63
59
  "access": "public"
64
60
  }
65
- }
61
+ }