@xyo-network/diviner-forecasting-method-arima 5.3.25 → 5.3.26

package/README.md

@@ -1,23 +1,179 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/diviner-forecasting-method-arima
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> XYO Archivist
+
+## Install
+
+Using npm:
+
+```sh
+npm install {{name}}
+```
+
+Using yarn:
 
-Version: 5.0.2
+```sh
+yarn add {{name}}
+```
 
-XYO Archivist
+Using pnpm:
 
-## Documentation
+```sh
+pnpm add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__diviner-forecasting-method-arima)
+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
+
+              ### arima
+
+                ### .temp-typedoc
+
+                  ### functions
+
+                    ### <a id="configurableArima"></a>configurableArima
+
+[**@xyo-network/diviner-forecasting-method-arima**](#../README)
+
+***
+
+```ts
+function configurableArima(opts?, predictionSteps?): ForecastingMethod;
+```
+
+## Parameters
+
+### opts?
+
+`ARIMAOptions` = `commonOpts`
+
+### predictionSteps?
+
+`number` = `10`
+
+## Returns
+
+`ForecastingMethod`
+
+                  ### type-aliases
+
+                    ### <a id="PredictionPayload"></a>PredictionPayload
+
+[**@xyo-network/diviner-forecasting-method-arima**](#../README)
+
+***
+
+```ts
+type PredictionPayload = Payload<{
+  error?: number;
+  value: number;
+}>;
+```
+
+                  ### variables
+
+                    ### <a id="arimaForecastingMethod"></a>arimaForecastingMethod
+
+[**@xyo-network/diviner-forecasting-method-arima**](#../README)
+
+***
+
+```ts
+const arimaForecastingMethod: ForecastingMethod;
+```
+
+                    ### <a id="arimaForecastingName"></a>arimaForecastingName
+
+[**@xyo-network/diviner-forecasting-method-arima**](#../README)
+
+***
+
+```ts
+const arimaForecastingName: "arimaForecasting" = 'arimaForecasting';
+```
+
+                    ### <a id="arimaOpts"></a>arimaOpts
+
+[**@xyo-network/diviner-forecasting-method-arima**](#../README)
+
+***
+
+```ts
+const arimaOpts: ARIMAOptions;
+```
+
+                    ### <a id="commonOpts"></a>commonOpts
+
+[**@xyo-network/diviner-forecasting-method-arima**](#../README)
+
+***
+
+```ts
+const commonOpts: ARIMAOptions;
+```
+
+                    ### <a id="seasonalArimaForecastingMethod"></a>seasonalArimaForecastingMethod
+
+[**@xyo-network/diviner-forecasting-method-arima**](#../README)
+
+***
+
+```ts
+const seasonalArimaForecastingMethod: ForecastingMethod;
+```
+
+                    ### <a id="seasonalArimaForecastingName"></a>seasonalArimaForecastingName
+
+[**@xyo-network/diviner-forecasting-method-arima**](#../README)
+
+***
+
+```ts
+const seasonalArimaForecastingName: "seasonalArimaForecasting" = 'seasonalArimaForecasting';
+```
+
+                    ### <a id="seasonalArimaOpts"></a>seasonalArimaOpts
+
+[**@xyo-network/diviner-forecasting-method-arima**](#../README)
+
+***
 
-## Credits
+```ts
+const seasonalArimaOpts: ARIMAOptions;
+```
 
-[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-method-arima.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/diviner-forecasting-method-arima
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/diviner-forecasting-method-arima.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json.schemastore.org/package.json",
   "name": "@xyo-network/diviner-forecasting-method-arima",
-  "version": "5.3.25",
+  "version": "5.3.26",
   "description": "XYO Archivist",
   "license": "LGPL-3.0-only",
   "author": "Arie Trouw",
@@ -10,11 +10,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",
@@ -25,17 +25,17 @@
   ],
   "dependencies": {
     "arima": "~0.2.8",
-    "@xyo-network/diviner-forecasting-model": "~5.3.25",
-    "@xyo-network/payload-model": "~5.3.25"
+    "@xyo-network/diviner-forecasting-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",
-    "@xylabs/vitest-extended": "~5.0.93",
+    "@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",
+    "@xylabs/vitest-extended": "~5.0.94",
     "acorn": "^8.16.0",
     "arima": "~0.2.8",
     "axios": "^1.14.0",
@@ -44,8 +44,8 @@
     "vite": "^8.0.3",
     "vitest": "~4.1.2",
     "zod": "^4.3.6",
-    "@xyo-network/diviner-forecasting-model": "~5.3.25",
-    "@xyo-network/payload-model": "~5.3.25"
+    "@xyo-network/diviner-forecasting-model": "~5.3.26",
+    "@xyo-network/payload-model": "~5.3.26"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",