@steerprotocol/app-loader 3.0.0 → 3.0.2

package/README.md

@@ -26,8 +26,9 @@ Use the root import for typical Node usage.
 
 ```ts
 import { loadWasm } from '@steerprotocol/app-loader';
+import type { WasmModule } from '@steerprotocol/app-loader';
 
-const bundle = await loadWasm('/absolute/path/to/bundle.wasm');
+const bundle: WasmModule = await loadWasm('/absolute/path/to/bundle.wasm');
 bundle.initialize('{"example":true}');
 ```
 
@@ -46,6 +47,9 @@ If you want an explicit Node-only import:
 
 ```ts
 import { loadWasm } from '@steerprotocol/app-loader/node';
+import type { WasmModule } from '@steerprotocol/app-loader/node';
+
+const bundle: WasmModule = await loadWasm('/absolute/path/to/bundle.wasm');
 ```
 
 ### Browser
@@ -54,9 +58,10 @@ The browser entry supports `ArrayBuffer` and remote URL loading.
 
 ```ts
 import { loadWasm } from '@steerprotocol/app-loader';
+import type { WasmModule } from '@steerprotocol/app-loader';
 
 const response = await fetch('/bundle.wasm');
-const bundle = await loadWasm(await response.arrayBuffer());
+const bundle: WasmModule = await loadWasm(await response.arrayBuffer());
 bundle.initialize('{"example":true}');
 ```
 
@@ -64,6 +69,10 @@ If you want to pin the browser-specific entrypoint:
 
 ```ts
 import { loadWasm } from '@steerprotocol/app-loader/browser';
+import type { WasmModule } from '@steerprotocol/app-loader/browser';
+
+const response = await fetch('/bundle.wasm');
+const bundle: WasmModule = await loadWasm(await response.arrayBuffer());
 ```
 
 ### Browser `ccxt`
@@ -88,9 +97,27 @@ Main exports:
 
 - `loadWasm(input, imports?)`
 - `loadWasmSync(input, imports?)`
+- `WasmModule` (type-only export)
 - `Candle`
 - `RawTradeData`
 
+`WasmModule` is a type-only export. Strict TypeScript consumers, including projects using
+`moduleResolution: "NodeNext"`, `module: "NodeNext"`, and `verbatimModuleSyntax: true`, must import it with
+`import type`:
+
+```ts
+import { loadWasm } from '@steerprotocol/app-loader';
+import type { WasmModule } from '@steerprotocol/app-loader';
+```
+
+The same rule applies to `@steerprotocol/app-loader/node` and `@steerprotocol/app-loader/browser`.
+
+The non-type-only form is not the supported pattern for strict TS consumers:
+
+```ts
+import { WasmModule, loadWasm } from '@steerprotocol/app-loader';
+```
+
 The returned wasm wrapper exposes the module surface when available, including:
 
 - `initialize(config)`
@@ -113,19 +140,26 @@ npm run build
 npm test
 ```
 
-### Packed Consumer Smoke Tests
+An env-gated live repro for the deprecated Sushi Polygon v2 connector is enabled when
+`STEER_SUBGRAPH_STUDIO_KEY` is set (or `STEER_SUBGRAPH_GATEWAY_KEY` for local debugging). This connector is kept as historical evidence of a
+known-broken path and is not part of the supported execution contract.
+
+### Packed Consumer Checks
 
-These tests validate the packed artifact in real consumer fixtures for:
+These checks validate the packed artifact in consumer fixtures for:
 
 - Node ESM
 - Node CJS
-- Vite browser builds
+- Strict TypeScript NodeNext consumers
+- Vite browser bundler builds
+- Next.js browser bundler builds
 
 ```bash
 npm run test:consumers
 ```
 
-This command builds the package, packs it, installs the tarball into fixture apps, and runs each fixture check.
+This command builds the package, packs it, installs the tarball into fixture apps, validates the packed export artifacts,
+and runs each fixture check.
 
 ## Migration Notes
 

package/lib/Candle.d.ts

@@ -0,0 +1,46 @@
+import { RawTradeData } from './RawTradeData';
+/**
+ * OHLCV candle model.
+ */
+export declare class Candle {
+    timestamp: number;
+    high: number;
+    low: number;
+    open: number;
+    close: number;
+    volume: number;
+    /**
+     * Creates a candle instance.
+     * @param timestamp - Candle open timestamp in milliseconds.
+     * @param high - Highest traded price.
+     * @param low - Lowest traded price.
+     * @param open - Opening price.
+     * @param close - Closing price.
+     * @param volume - Total traded volume.
+     */
+    constructor(timestamp: number, high: number, low: number, open: number, close: number, volume: number);
+    /**
+     * Serializes the candle as JSON.
+     * @returns The candle as a JSON string.
+     */
+    toString(): string;
+}
+/**
+ * Encodes a candle into a fixed-width integer buffer.
+ * @param candle - Candle to encode.
+ * @returns The encoded candle buffer.
+ */
+export declare function encodeCandle(candle: Candle): Uint32Array;
+/**
+ * Decodes a fixed-width integer buffer into a candle.
+ * @param buffer - Encoded candle buffer.
+ * @returns The decoded candle.
+ */
+export declare function decodeCandle(buffer: Uint32Array): Candle;
+/**
+ * Aggregates raw trades into OHLCV candles.
+ * @param data - Raw trades sorted by timestamp.
+ * @param candleSize - Candle width expressed as a timestring.
+ * @returns Generated candles.
+ */
+export declare function generateCandles(data: RawTradeData[], candleSize: string): Candle[];

package/lib/RawTradeData.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Trade point model used as candle-generation input.
+ */
+export declare class RawTradeData {
+    timestamp: number;
+    price: number;
+    volume: number;
+    /**
+     * Creates a raw trade data point.
+     * @param timestamp - Trade timestamp.
+     * @param price - Trade price.
+     * @param volume - Trade volume.
+     */
+    constructor(timestamp: number, price: number, volume: number);
+}

package/lib/{WasmModule-MhaHnYBX.d.mts → WasmModule.d.ts}

@@ -1,32 +1,20 @@
-declare class RawTradeData {
-    timestamp: number;
-    price: number;
-    volume: number;
-    constructor(timestamp: number, price: number, volume: number);
-}
-
-declare class Candle {
-    timestamp: number;
-    high: number;
-    low: number;
-    open: number;
-    close: number;
-    volume: number;
-    constructor(timestamp: number, high: number, low: number, open: number, close: number, volume: number);
-    toString(): string;
-}
-
+/**
+ * Type declarations for the wasm exports surfaced by this package.
+ */
 declare function responseHandler(body: ArrayBuffer, statusCode: number, redirected: number, callbackID: number): void;
-declare function initialize(config: string): void;
+declare function initialize(config: string): boolean;
 declare function config(): string;
 declare function version(): number;
 declare function transform(): string;
-declare function execute(...params: number[] | string[] | ArrayBuffer[] | null[]): string;
+declare function execute(...params: Array<number | string | ArrayBuffer | null>): Promise<string | null>;
 declare function __new(size: number, id: number): number;
 declare function __pin(ptr: number): number;
 declare function __unpin(ptr: number): number;
 declare function reset(): void;
-type WasmModule = {
+/**
+ * Public shape of the wrapped wasm exports.
+ */
+export type WasmModule = {
     responseHandler: typeof responseHandler;
     initialize: typeof initialize;
     execute: typeof execute;
@@ -39,5 +27,4 @@ type WasmModule = {
     __unpin: typeof __unpin;
     reset: typeof reset;
 };
-
-export { Candle as C, RawTradeData as R, type WasmModule as W };
+export {};

package/lib/{node.d.mts → browser.d.ts}

@@ -1,6 +1,8 @@
-import { W as WasmModule } from './WasmModule-MhaHnYBX.mjs';
-export { C as Candle, R as RawTradeData } from './WasmModule-MhaHnYBX.mjs';
-
+/**
+ * Browser-only entrypoints for loading Steer wasm bundles.
+ */
+import { Candle, RawTradeData } from './internal/instantiate';
+import type { WasmModule } from './WasmModule';
 /**
  * Load a wasm bundle synchronously. Only accepts the actual binary data.
  * @param input - Wasm bundle data
@@ -9,11 +11,11 @@ export { C as Candle, R as RawTradeData } from './WasmModule-MhaHnYBX.mjs';
  */
 declare function loadWasmSync(input: ArrayBuffer, imports?: {}): WasmModule;
 /**
- * Load a wasm bundle asynchronously. Accepts the actual binary data or a file path/URL.
- * @param input - Wasm bundle data, file path, or URL
+ * Load a wasm bundle asynchronously. Accepts the actual binary data or URL.
+ * @param input - Wasm bundle data or URL
  * @param imports - Imports
  * @returns
  */
 declare function loadWasm(input: string | ArrayBuffer, imports?: {}): Promise<WasmModule>;
-
-export { WasmModule, loadWasm, loadWasmSync };
+export type { WasmModule } from './WasmModule';
+export { loadWasm, loadWasmSync, Candle, RawTradeData };