@xyo-network/diviner-forecasting-model 4.0.2 → 4.1.0

package/dist/neutral/index.d.ts

@@ -0,0 +1,59 @@
+import { DivinerConfig } from '@xyo-network/diviner-model';
+import { ModuleIdentifier } from '@xyo-network/module-model';
+import { Address } from '@xylabs/hex';
+import { Schema, Payload, Query } from '@xyo-network/payload-model';
+import { Promisable } from '@xylabs/promise';
+
+declare const ForecastingDivinerSchema: "network.xyo.diviner.forecasting";
+type ForecastingDivinerSchema = typeof ForecastingDivinerSchema;
+
+interface ForecastingSettings {
+    batchLimit?: number;
+    forecastingMethod?: string;
+    forecastingSteps?: number;
+    maxTrainingLength?: number;
+    timestamp?: number;
+    windowSize?: number;
+    witnessAddresses?: Address[];
+    witnessSchema?: Schema;
+}
+
+interface TransformerSettings {
+    jsonPathExpression?: string;
+}
+
+type ForecastingDivinerConfigSchema = `${ForecastingDivinerSchema}.config`;
+declare const ForecastingDivinerConfigSchema: ForecastingDivinerConfigSchema;
+type ForecastingDivinerConfig = DivinerConfig<{
+    boundWitnessDiviner?: ModuleIdentifier;
+    schema: ForecastingDivinerConfigSchema;
+} & ForecastingSettings & TransformerSettings>;
+
+interface Forecast {
+    error?: number;
+    timestamp?: number;
+    value: number;
+}
+
+type ForecastPayloadSchema = `${ForecastingDivinerSchema}.forecast`;
+declare const ForecastPayloadSchema: ForecastPayloadSchema;
+type ForecastPayload = Payload<{
+    schema: ForecastPayloadSchema;
+    sources: string[];
+    values: Forecast[];
+}>;
+declare const isForecastPayload: (x?: Payload | null) => x is ForecastPayload;
+
+type PayloadValueTransformer = (payload: Payload) => number;
+
+type ForecastingMethod = (payloads: Payload[], transformers: PayloadValueTransformer) => Promisable<Forecast[]>;
+
+type ForecastingDivinerQuerySchema = `${ForecastingDivinerSchema}.query`;
+declare const ForecastingDivinerQuerySchema: ForecastingDivinerQuerySchema;
+type ForecastingDivinerQueryPayload = Query<{
+    schema: ForecastingDivinerQuerySchema;
+} & Partial<ForecastingSettings>>;
+declare const isForecastingDivinerQueryPayload: (x?: Payload | null) => x is ForecastingDivinerQueryPayload;
+
+export { ForecastPayloadSchema, ForecastingDivinerConfigSchema, ForecastingDivinerQuerySchema, ForecastingDivinerSchema, isForecastPayload, isForecastingDivinerQueryPayload };
+export type { Forecast, ForecastPayload, ForecastingDivinerConfig, ForecastingDivinerQueryPayload, ForecastingMethod, ForecastingSettings, PayloadValueTransformer, TransformerSettings };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-forecasting-model",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,23 +21,23 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.ts",
+      "types": "./dist/neutral/index.d.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "dist/neutral/index.mjs",
-  "types": "dist/types/index.d.ts",
+  "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/hex": "^4.12.33",
-    "@xylabs/promise": "^4.12.33",
-    "@xyo-network/diviner-model": "^4.0.2",
-    "@xyo-network/module-model": "^4.0.2",
-    "@xyo-network/payload-model": "^4.0.2"
+    "@xylabs/hex": "^4.13.15",
+    "@xylabs/promise": "^4.13.15",
+    "@xyo-network/diviner-model": "^4.1.0",
+    "@xyo-network/module-model": "^4.1.0",
+    "@xyo-network/payload-model": "^4.1.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^6.5.12",
-    "@xylabs/tsconfig": "^6.5.12",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
+    "@xylabs/tsconfig": "^7.0.0-rc.20",
     "typescript": "^5.8.3"
   },
   "publishConfig": {