@vroomchart/core-wasm 0.1.0 → 0.1.2

package/dist/index.d.ts

@@ -9,7 +9,13 @@ declare enum ColorKey {
     Crosshair = 6,
     TooltipBg = 7,
     TooltipText = 8,
-    CrosshairTarget = 9
+    CrosshairTarget = 9,
+    BorderBull = 10,
+    BorderBear = 11,
+    WickBull = 12,
+    WickBear = 13,
+    AccentBull = 14,
+    AccentBear = 15
 }
 /** OHLCV readout for the candle under the crosshair. */
 type CrosshairCandle = {
@@ -20,6 +26,16 @@ type CrosshairCandle = {
     close: number;
     volume: number;
 };
+/**
+ * What the crosshair currently snaps to. `timeMs` is the snapped slot's
+ * period-start time — set even in the empty space ahead of the most recent
+ * candle. `candle` holds the OHLCV when a real candle sits at that slot, and is
+ * null when the crosshair is parked on a future candle-aligned slot.
+ */
+type CrosshairInfo = {
+    timeMs: number;
+    candle: CrosshairCandle | null;
+};
 /** Axis region sizes in CSS px, for hit-testing gestures on the JS side. */
 type AxisMetrics = {
     yAxisWidth: number;
@@ -62,6 +78,18 @@ interface VroomChartHandle {
     scalePriceAxis(dy: number): void;
     /** Drag-on-x-axis time scaling; dx>0 widens the time window. */
     scaleTimeAxis(dx: number): void;
+    /**
+     * Drag the separator between the price pane and the below-chart indicator
+     * band. dy>0 (drag down) grows the price pane and shrinks the indicator band,
+     * preserving candle pixel scale (the price range adjusts instead).
+     */
+    resizeIndicatorPane(dy: number): void;
+    /**
+     * Scale the y-axis of the below-chart indicator pane containing `y` (px).
+     * dy>0 (drag down) zooms out (widens the value range); dy<0 zooms in. RSI
+     * scales about 50, MACD about its zero line. No-op when `y` is not over a pane.
+     */
+    scaleIndicatorAxis(y: number, dy: number): void;
     /** Current axis dimensions for hit-testing in JS gestures. */
     getAxisMetrics(): AxisMetrics;
     /** Show the crosshair at (x, y) CSS px (y already lifted above the pointer). */
@@ -70,6 +98,12 @@ interface VroomChartHandle {
     clearCrosshair(): void;
     /** OHLCV of the candle the crosshair snaps to, or null when inactive. */
     getCrosshairCandle(): CrosshairCandle | null;
+    /**
+     * The slot the crosshair snaps to (real candle or future candle-aligned
+     * slot), or null when inactive. Unlike getCrosshairCandle this reports a
+     * timeMs even in the empty space ahead of the most recent candle.
+     */
+    getCrosshairInfo(): CrosshairInfo | null;
     setRSI(enabled: boolean, period: number, upperBand: number, lowerBand: number, maEnabled: boolean, maPeriod: number): void;
     setMACD(enabled: boolean, fast: number, slow: number, signal: number): void;
     setOverlays(overlays: OverlaySpec[]): void;
@@ -121,10 +155,22 @@ type VroomColor = string | number;
 type VroomTheme = {
     /** Chart + axis-strip background. */
     background?: VroomColor;
-    /** Up candles (also bull wicks, bull volume bars, rising price indicator). */
+    /** Up candle body fill. Wick and border default to this unless overridden. */
     bull?: VroomColor;
-    /** Down candles (also bear wicks, bear volume bars, falling price indicator). */
+    /** Down candle body fill. Wick and border default to this unless overridden. */
     bear?: VroomColor;
+    /** Generic up color for the price indicator, volume bars, and MACD histogram. Defaults to teal-green; independent of `bull`. */
+    accentBull?: VroomColor;
+    /** Generic down color for the price indicator, volume bars, and MACD histogram. Defaults to red; independent of `bear`. */
+    accentBear?: VroomColor;
+    /** Up candle body 1px border. Defaults to the bull fill color. */
+    borderBull?: VroomColor;
+    /** Down candle body 1px border. Defaults to the bear fill color. */
+    borderBear?: VroomColor;
+    /** Up candle wick color. Defaults to the bull fill color. */
+    wickBull?: VroomColor;
+    /** Down candle wick color. Defaults to the bear fill color. */
+    wickBear?: VroomColor;
     /** Gridlines. */
     grid?: VroomColor;
     /** Axis label text (price + time). */
@@ -138,7 +184,7 @@ type VroomTheme = {
 declare const BYTES_PER_CANDLE = 48;
 /** Serialize candles into the packed little-endian buffer the core expects. */
 declare function packCandles(candles: Candle[]): ArrayBuffer;
-/** Decode the packed buffer back to candles (used by the Canvas2D stub core). */
+/** Decode the packed buffer back to candles (inverse of packCandles). */
 declare function unpackCandles(buf: ArrayBuffer): Candle[];
 
 declare const COLOR_KEYS: Record<keyof VroomTheme, ColorKey>;
@@ -160,24 +206,19 @@ type LoadVroomOptions = {
     /**
      * Override where the Skia-WASM core is loaded from. By default the core uses
      * the WASM build bundled in this package (turnkey, no asset hosting needed);
-     * pass `wasm` to load it from your own URLs instead. On load failure the
-     * Canvas2D stub is used unless `fallbackToStub: false`.
+     * pass `wasm` to load it from your own URLs instead.
      */
     wasm?: WasmConfig;
-    /** When wasm loading fails, fall back to the stub (default true). */
-    fallbackToStub?: boolean;
-    /** Force the Canvas2D stub instead of the WASM core (tests / SSR). */
-    forceStub?: boolean;
 };
 /**
  * Load the chart core. Cached: repeated calls share one module instance.
  *
- * Defaults to the real Skia-WASM core bundled in this package. Pass
- * `forceStub` for the Canvas2D stub, or `wasm` to load the core from custom
- * URLs. WASM load failures fall back to the stub unless `fallbackToStub: false`.
+ * Resolves to the Skia-WASM core bundled in this package, or the core at the
+ * URLs in `opts.wasm`. The returned promise rejects if the WASM module fails to
+ * load (and the cache is cleared so a later call can retry).
  */
 declare function loadVroom(opts?: LoadVroomOptions): Promise<VroomModule>;
 /** Test/HMR helper: drop the cached module so the next loadVroom() re-creates it. */
 declare function resetVroomForTesting(): void;
 
-export { type AxisMetrics, BYTES_PER_CANDLE, COLOR_KEYS, ColorKey, type CrosshairCandle, type LoadVroomOptions, type OverlaySpec, type VroomChartHandle, type VroomModule, type WasmConfig, applyTheme, argbToCss, loadVroom, packCandles, parseColor, resetVroomForTesting, unpackCandles };
+export { type AxisMetrics, BYTES_PER_CANDLE, COLOR_KEYS, ColorKey, type CrosshairCandle, type CrosshairInfo, type LoadVroomOptions, type OverlaySpec, type VroomChartHandle, type VroomModule, type WasmConfig, applyTheme, argbToCss, loadVroom, packCandles, parseColor, resetVroomForTesting, unpackCandles };