@xyo-network/diviner-forecasting-model 5.3.25 → 5.3.26

package/README.md

@@ -1,23 +1,418 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/diviner-forecasting-model
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Primary SDK for using XYO Protocol 2.0
+
+## Install
+
+Using npm:
 
-Version: 5.0.2
+```sh
+npm install {{name}}
+```
 
-Primary SDK for using XYO Protocol 2.0
+Using yarn:
 
-## Documentation
+```sh
+yarn add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__diviner-forecasting-model)
+Using pnpm:
+
+```sh
+pnpm add {{name}}
+```
+
+Using bun:
+
+```sh
+bun add {{name}}
+```
 
-Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
+## Reference
+
+### packages
+
+  ### modules
+
+    ### packages
+
+      ### diviner
+
+        ### packages
+
+          ### forecasting
+
+            ### packages
+
+              ### model
+
+                ### .temp-typedoc
+
+                  ### functions
+
+                    ### <a id="isForecastPayload"></a>isForecastPayload
+
+[**@xyo-network/diviner-forecasting-model**](#../README)
+
+***
+
+```ts
+function isForecastPayload(x?): x is ForecastPayload;
+```
+
+## Parameters
+
+### x?
+
+`Payload` \| `null`
+
+## Returns
+
+`x is ForecastPayload`
+
+                    ### <a id="isForecastingDivinerQueryPayload"></a>isForecastingDivinerQueryPayload
+
+[**@xyo-network/diviner-forecasting-model**](#../README)
+
+***
+
+```ts
+function isForecastingDivinerQueryPayload(x?): x is ForecastingDivinerQueryPayload;
+```
+
+## Parameters
+
+### x?
+
+`Payload` \| `null`
+
+## Returns
+
+`x is ForecastingDivinerQueryPayload`
+
+                  ### interfaces
+
+                    ### <a id="Forecast"></a>Forecast
+
+[**@xyo-network/diviner-forecasting-model**](#../README)
+
+***
+
+## Properties
+
+### error?
+
+```ts
+optional error?: number;
+```
+
+***
+
+### timestamp?
+
+```ts
+optional timestamp?: number;
+```
+
+***
+
+### value
+
+```ts
+value: number;
+```
+
+                    ### <a id="ForecastingSettings"></a>ForecastingSettings
+
+[**@xyo-network/diviner-forecasting-model**](#../README)
+
+***
+
+## Properties
+
+### batchLimit?
+
+```ts
+optional batchLimit?: number;
+```
+
+***
+
+### forecastingMethod?
+
+```ts
+optional forecastingMethod?: string;
+```
+
+***
+
+### forecastingSteps?
+
+```ts
+optional forecastingSteps?: number;
+```
+
+***
+
+### maxTrainingLength?
+
+```ts
+optional maxTrainingLength?: number;
+```
+
+***
+
+### timestamp?
+
+```ts
+optional timestamp?: number;
+```
+
+***
+
+### windowSize?
+
+```ts
+optional windowSize?: number;
+```
+
+***
+
+### witnessAddresses?
+
+```ts
+optional witnessAddresses?: BrandedAddress[];
+```
+
+***
+
+### witnessSchema?
+
+```ts
+optional witnessSchema?: Schema;
+```
+
+                    ### <a id="TransformerSettings"></a>TransformerSettings
+
+[**@xyo-network/diviner-forecasting-model**](#../README)
+
+***
+
+## Properties
+
+### jsonPathExpression?
+
+```ts
+optional jsonPathExpression?: string;
+```
+
+                  ### type-aliases
+
+                    ### <a id="ForecastPayload"></a>ForecastPayload
+
+[**@xyo-network/diviner-forecasting-model**](#../README)
+
+***
+
+```ts
+type ForecastPayload = Payload<{
+  schema: ForecastPayloadSchema;
+  sources: string[];
+  values: Forecast[];
+}>;
+```
+
+                    ### <a id="ForecastPayloadSchema"></a>ForecastPayloadSchema
+
+[**@xyo-network/diviner-forecasting-model**](#../README)
+
+***
+
+```ts
+type ForecastPayloadSchema = typeof ForecastPayloadSchema;
+```
+
+                    ### <a id="ForecastingDivinerConfig"></a>ForecastingDivinerConfig
+
+[**@xyo-network/diviner-forecasting-model**](#../README)
+
+***
+
+```ts
+type ForecastingDivinerConfig = DivinerConfig<object & ForecastingSettings & TransformerSettings>;
+```
+
+                    ### <a id="ForecastingDivinerConfigSchema"></a>ForecastingDivinerConfigSchema
+
+[**@xyo-network/diviner-forecasting-model**](#../README)
+
+***
+
+```ts
+type ForecastingDivinerConfigSchema = typeof ForecastingDivinerConfigSchema;
+```
+
+                    ### <a id="ForecastingDivinerQueryPayload"></a>ForecastingDivinerQueryPayload
+
+[**@xyo-network/diviner-forecasting-model**](#../README)
+
+***
+
+```ts
+type ForecastingDivinerQueryPayload = Query<object & Partial<ForecastingSettings>>;
+```
+
+                    ### <a id="ForecastingDivinerQuerySchema"></a>ForecastingDivinerQuerySchema
+
+[**@xyo-network/diviner-forecasting-model**](#../README)
+
+***
+
+```ts
+type ForecastingDivinerQuerySchema = typeof ForecastingDivinerQuerySchema;
+```
+
+                    ### <a id="ForecastingDivinerSchema"></a>ForecastingDivinerSchema
+
+[**@xyo-network/diviner-forecasting-model**](#../README)
+
+***
+
+```ts
+type ForecastingDivinerSchema = typeof ForecastingDivinerSchema;
+```
+
+                    ### <a id="ForecastingMethod"></a>ForecastingMethod
+
+[**@xyo-network/diviner-forecasting-model**](#../README)
+
+***
+
+```ts
+type ForecastingMethod = (payloads, transformers) => Promisable<Forecast[]>;
+```
+
+## Parameters
+
+### payloads
+
+`Payload`[]
+
+### transformers
+
+[`PayloadValueTransformer`](#PayloadValueTransformer)
+
+## Returns
+
+`Promisable`\<[`Forecast`](#../interfaces/Forecast)[]\>
+
+                    ### <a id="PayloadValueTransformer"></a>PayloadValueTransformer
+
+[**@xyo-network/diviner-forecasting-model**](#../README)
+
+***
+
+```ts
+type PayloadValueTransformer = (payload) => number;
+```
+
+## Parameters
+
+### payload
+
+`Payload`
+
+## Returns
+
+`number`
+
+                  ### variables
+
+                    ### <a id="ForecastPayloadSchema"></a>ForecastPayloadSchema
+
+[**@xyo-network/diviner-forecasting-model**](#../README)
+
+***
+
+```ts
+const ForecastPayloadSchema: string & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                    ### <a id="ForecastingDivinerConfigSchema"></a>ForecastingDivinerConfigSchema
+
+[**@xyo-network/diviner-forecasting-model**](#../README)
+
+***
+
+```ts
+const ForecastingDivinerConfigSchema: string & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                    ### <a id="ForecastingDivinerQuerySchema"></a>ForecastingDivinerQuerySchema
+
+[**@xyo-network/diviner-forecasting-model**](#../README)
+
+***
+
+```ts
+const ForecastingDivinerQuerySchema: string & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                    ### <a id="ForecastingDivinerSchema"></a>ForecastingDivinerSchema
+
+[**@xyo-network/diviner-forecasting-model**](#../README)
+
+***
+
+```ts
+const ForecastingDivinerSchema: "network.xyo.diviner.forecasting" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
 
-## Credits
+```ts
+readonly __schema: true;
+```
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/diviner-forecasting-model.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/diviner-forecasting-model
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/diviner-forecasting-model.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-forecasting-model",
-  "version": "5.3.25",
+  "version": "5.3.26",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -22,11 +22,11 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
+      "import": "./dist/neutral/index.mjs",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
@@ -36,25 +36,25 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/diviner-model": "~5.3.25",
-    "@xyo-network/module-model": "~5.3.25",
-    "@xyo-network/payload-model": "~5.3.25"
+    "@xyo-network/diviner-model": "~5.3.26",
+    "@xyo-network/module-model": "~5.3.26",
+    "@xyo-network/payload-model": "~5.3.26"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.1",
-    "@types/node": "^25.5.0",
-    "@xylabs/sdk-js": "^5.0.93",
-    "@xylabs/ts-scripts-common": "~7.6.16",
-    "@xylabs/ts-scripts-pnpm": "~7.6.16",
-    "@xylabs/tsconfig": "~7.6.16",
+    "@types/node": "^25.5.2",
+    "@xylabs/sdk-js": "^5.0.94",
+    "@xylabs/ts-scripts-common": "~7.7.5",
+    "@xylabs/ts-scripts-pnpm": "~7.7.5",
+    "@xylabs/tsconfig": "~7.7.5",
     "acorn": "^8.16.0",
     "axios": "^1.14.0",
     "esbuild": "^0.28.0",
     "typescript": "~5.9.3",
     "zod": "^4.3.6",
-    "@xyo-network/module-model": "~5.3.25",
-    "@xyo-network/diviner-model": "~5.3.25",
-    "@xyo-network/payload-model": "~5.3.25"
+    "@xyo-network/diviner-model": "~5.3.26",
+    "@xyo-network/module-model": "~5.3.26",
+    "@xyo-network/payload-model": "~5.3.26"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",