@tony01/astroneum 0.4.1-beta.2 → 0.4.1-beta.25

package/dist/{Indicator-BBI3L_lx.d.ts → Indicator-BQQcVGGT.d.ts}

@@ -1,5 +1,3 @@
-import react__default from 'react';
-
 type Nullable<T> = T | null;
 
 interface NeighborData<D> {
@@ -7,9 +5,9 @@ interface NeighborData<D> {
     current: D;
     next: D;
 }
-type Timestamp$1 = number;
+type Timestamp = number;
 interface CandleData {
-    timestamp: Timestamp$1;
+    timestamp: Timestamp;
     open: number;
     high: number;
     low: number;
@@ -309,21 +307,6 @@ interface Styles {
     overlay: OverlayStyle;
 }
 
-type Price = number & {
-    readonly _brand: 'Price';
-};
-type Volume = number & {
-    readonly _brand: 'Volume';
-};
-type Timestamp = number & {
-    readonly _brand: 'Timestamp';
-};
-interface IndicatorDef {
-    name: string;
-    calcParams?: number[];
-}
-/** Canonical timespan identifiers — aligned with engine PeriodType */
-type Timespan = 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year';
 interface SymbolInfo {
     ticker: string;
     name?: string;
@@ -337,217 +320,13 @@ interface SymbolInfo {
     logo?: string;
     [key: string]: unknown;
 }
+
+type PeriodType = 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year';
 interface Period {
     multiplier: number;
-    /** Canonical timespan — maps directly to engine PeriodType */
-    timespan: Timespan;
+    timespan: PeriodType;
     text: string;
 }
-type DatafeedSubscribeCallback = (data: CandleData) => void;
-interface Datafeed {
-    searchSymbols(search?: string): Promise<SymbolInfo[]>;
-    getHistoryData(symbol: SymbolInfo, period: Period, from: number, to: number): Promise<CandleData[]>;
-    subscribe(symbol: SymbolInfo, period: Period, callback: DatafeedSubscribeCallback): void;
-    unsubscribe(symbol: SymbolInfo, period: Period): void;
-}
-interface AstroneumOptions {
-    styles?: DeepPartial<Styles>;
-    watermark?: string | Node;
-    theme?: string;
-    locale?: string;
-    drawingBarVisible?: boolean;
-    symbol: SymbolInfo;
-    period: Period;
-    periods?: Period[];
-    timezone?: string;
-    mainIndicators?: IndicatorDef[];
-    subIndicators?: string[];
-    plugins?: ChartPlugin[];
-    datafeed: Datafeed;
-    /** Inline styles applied to the root `.astroneum` container element. */
-    style?: react__default.CSSProperties;
-    /** Additional class names applied to the root `.astroneum` container element. */
-    className?: string;
-    /**
-     * Make the chart canvas focusable + emit an `aria-live` summary of the
-     * crosshair OHLCV. Off by default to avoid surprising existing apps.
-     * When `true`, the chart container gets `tabindex=0`, `role="img"`,
-     * and an `aria-label` describing the current symbol. Cursor moves
-     * announce OHLCV through a visually-hidden polite live region.
-     */
-    accessible?: boolean;
-    /**
-     * Optional ARIA label override for the chart canvas. Only used when
-     * `accessible` is true. Defaults to a string built from the symbol
-     * ticker and current period.
-     */
-    ariaLabel?: string;
-    /**
-     * Bar rendering style. Defaults to 'candle' (standard candlesticks).
-     * 'heikin_ashi' transforms OHLC data with the Heikin-Ashi formula
-     * before rendering — no datafeed changes required.
-     */
-    barStyle?: 'candle' | 'heikin_ashi';
-    /**
-     * Price axis scale mode. Defaults to 'linear' (absolute price).
-     * 'log' uses logarithmic scale (useful for long-term charts).
-     * 'percent' shows percentage change from the first visible bar.
-     */
-    priceScale?: 'linear' | 'log' | 'percent';
-    initialHistory?: 'all' | 'none';
-}
-/**
- * Serialised chart state — drawings, indicators, and the user-facing
- * surface settings (theme, locale, timezone, symbol, period, styles).
- *
- * The shape is intentionally simple JSON so it can be persisted to
- * `localStorage`, a URL, or a backend. The `version` field lets the
- * library evolve the format without breaking older payloads.
- */
-interface SerializedChartState {
-    version: 1;
-    theme: string;
-    locale: string;
-    timezone: string;
-    symbol: SymbolInfo;
-    period: Period;
-    styles: DeepPartial<Styles>;
-    mainIndicators: IndicatorDef[];
-    subIndicators: string[];
-    overlays: Array<{
-        name: string;
-        points?: ReadonlyArray<{
-            timestamp?: number;
-            value?: number;
-            dataIndex?: number;
-        }>;
-        styles?: unknown;
-        lock?: boolean;
-        visible?: boolean;
-    }>;
-}
-interface AstroneumHandle {
-    setTheme(theme: string): void;
-    getTheme(): string;
-    setStyles(styles: DeepPartial<Styles>): void;
-    getStyles(): Styles;
-    setLocale(locale: string): void;
-    getLocale(): string;
-    setTimezone(timezone: string): void;
-    getTimezone(): string;
-    setSymbol(symbol: SymbolInfo): void;
-    getSymbol(): SymbolInfo;
-    setPeriod(period: Period): void;
-    getPeriod(): Period;
-    getDataListLength(): number;
-    getLastDataTimestamp(): number | null;
-    /**
-     * Capture the chart's current user-visible state as a JSON-safe object.
-     * Includes theme, locale, timezone, symbol, period, styles, indicators,
-     * and drawing overlays. Pair with `loadState()` to restore.
-     */
-    serializeState(): SerializedChartState;
-    /**
-     * Restore a previously-captured state. Best-effort: missing or unknown
-     * indicator / overlay names are silently skipped, matching the engine's
-     * behaviour for unregistered names.
-     */
-    loadState(state: SerializedChartState): void;
-    /**
-     * Subscribe to crosshair moves. Returns an unsubscribe function.
-     * Callback receives the crosshair data (or null when it leaves the chart).
-     * Returns a Coordinate-like object with the timestamp + price at cursor.
-     */
-    onCrosshairMove(callback: (data: unknown) => void): () => void;
-    /**
-     * Programmatically set the crosshair position on this chart.
-     * Used internally by MultiChartLayout for crosshair sync.
-     */
-    setCrosshair(data: unknown): void;
-    /** Lock or unlock ALL drawing overlays at once. */
-    lockAllDrawings(locked: boolean): void;
-    createIndicator(value: string | IndicatorCreate, isStack?: boolean, paneOptions?: PaneOptions): Nullable<string>;
-    removeIndicator(filter?: IndicatorFilter): boolean;
-    createOverlay(value: string | OverlayCreate | Array<string | OverlayCreate>): Nullable<string> | Array<Nullable<string>>;
-    removeOverlay(filter?: OverlayFilter): boolean;
-    getDataList(): CandleData[];
-    resetData(): void;
-    resize(): void;
-}
-interface Viewport {
-    /** Minimum (bottom) visible price in canvas coordinates. */
-    priceMin: Price;
-    /** Maximum (top) visible price in canvas coordinates. */
-    priceMax: Price;
-    /** Earliest visible candle timestamp (ms). */
-    timeMin: Timestamp;
-    /** Latest visible candle timestamp (ms). */
-    timeMax: Timestamp;
-    /** Physical canvas resolution [width, height] in device pixels. */
-    resolution: readonly [width: number, height: number];
-}
-interface IndicatorPlugin<TOutput> {
-    /** Unique registry name — used as the indicator identifier in the engine. */
-    name: string;
-    /** Short display name shown in the chart legend. */
-    shortName?: string;
-    /** Default calculation parameters (can be overridden by the user). */
-    calcParams?: number[];
-    /**
-     * Pure calculation function. Must NOT mutate `data`.
-     * Called on every data update; keep it fast (O(n) or better).
-     */
-    calc(data: CandleData[], params: number[]): TOutput[];
-    /** Canvas 2D renderer — for lightweight overlays and small datasets. */
-    render2D?(ctx: CanvasRenderingContext2D, output: TOutput[], viewport: Viewport): void;
-    /**
-     * WebGL2 renderer — for high-density or GPU-accelerated rendering.
-     * Astroneum reuses a stable per-indicator vbo and falls back to render2D when WebGL2 is unavailable.
-     */
-    renderGL?(gl: WebGL2RenderingContext, output: TOutput[], viewport: Viewport, vbo: WebGLBuffer): void;
-}
-interface ChartPluginContext {
-    /** The chart instance mounted by Astroneum. */
-    chart: Chart;
-    /** Register a typed indicator plugin at runtime. */
-    registerIndicatorPlugin: (plugin: IndicatorPlugin<unknown>) => void;
-    /** Batch register typed indicator plugins at runtime. */
-    registerIndicatorPlugins: (plugins: ReadonlyArray<IndicatorPlugin<unknown>>) => void;
-}
-interface ChartPlugin {
-    /** Optional plugin label for diagnostics and debugging. */
-    name?: string;
-    /** Indicator plugins to register before this chart starts creating indicators. */
-    indicators?: ReadonlyArray<IndicatorPlugin<unknown>>;
-    /** Optional lifecycle hook called once after the chart is initialized. */
-    onInit?: (context: ChartPluginContext) => void | (() => void);
-}
-interface ChartEventMap {
-    /** Fired when the active symbol changes. */
-    'symbol-change': SymbolInfo;
-    /** Fired when the active period / timeframe changes. */
-    'period-change': Period;
-    /** Fired on every crosshair move; null when the crosshair leaves the chart. */
-    'crosshair-move': Coordinate | null;
-    /** Fired when the user zooms the chart. */
-    'zoom': {
-        scale: number;
-        anchor: ZoomAnchor;
-    };
-    /** Fired when a historical data batch is loaded. */
-    'data-load': {
-        type: 'init' | 'forward' | 'backward';
-        count: number;
-    };
-    /** Fired when a real-time tick arrives from the datafeed subscription. */
-    'tick': CandleData;
-    /** Fired when the user starts drawing an overlay (value = overlay type name). */
-    'drawing-start': string;
-    /** Fired when the user finishes drawing (value = overlay id). */
-    'drawing-end': string;
-    /** Fired when the active theme changes (value = theme name). */
-    'theme-change': string;
-}
 
 type DataLoadType = 'init' | 'forward' | 'backward' | 'update';
 type DataLoadMore = boolean | {
@@ -676,6 +455,30 @@ interface Formatter {
     formatBigNumber: FormatBigNumber;
     formatExtendText: FormatExtendText;
 }
+interface Locales {
+    time: string;
+    open: string;
+    high: string;
+    low: string;
+    close: string;
+    volume: string;
+    change: string;
+    turnover: string;
+    second: string;
+    minute: string;
+    hour: string;
+    day: string;
+    week: string;
+    month: string;
+    year: string;
+    [key: string]: string;
+}
+type LayoutChildType = 'candle' | 'indicator' | 'xAxis';
+interface LayoutChild {
+    type: LayoutChildType;
+    content?: Array<string | IndicatorCreate>;
+    options?: PaneOptions;
+}
 interface DecimalFold {
     threshold: number;
     format: (value: string | number) => string;
@@ -689,6 +492,16 @@ interface ZoomAnchor {
     main: ZoomAnchorType;
     xAxis: ZoomAnchorType;
 }
+interface Options {
+    locale?: string;
+    timezone?: string;
+    styles?: string | DeepPartial<Styles>;
+    formatter?: Partial<Formatter>;
+    thousandsSeparator?: Partial<ThousandsSeparator>;
+    decimalFold?: Partial<DecimalFold>;
+    zoomAnchor?: ZoomAnchorType | Partial<ZoomAnchor>;
+    layout?: LayoutChild[];
+}
 
 interface YAxisTemplate extends AxisTemplate {
     /**
@@ -876,6 +689,8 @@ interface Store {
     setPeriod: (period: Period) => void;
     getPeriod: () => Nullable<Period>;
     getDataList: () => CandleData[];
+    replaceBars: (data: readonly CandleData[]) => void;
+    updateBar: (data: CandleData) => void;
     setOffsetRightDistance: (distance: number) => void;
     getOffsetRightDistance: () => number;
     setMaxOffsetLeftDistance: (distance: number) => void;
@@ -885,6 +700,7 @@ interface Store {
     setBarSpace: (space: number) => void;
     getBarSpace: () => BarSpace;
     getVisibleRange: () => VisibleRange;
+    setViewportState: (barSpace: number, rightOffsetBarCount: number) => void;
     setDataLoader: (dataLoader: DataLoader) => void;
     overrideIndicator: (override: IndicatorCreate) => boolean;
     removeIndicator: (filter?: IndicatorFilter) => boolean;
@@ -904,14 +720,22 @@ interface ConvertFilter {
     paneId?: string;
     absolute?: boolean;
 }
+interface ChartViewportState {
+    readonly version: 1;
+    readonly barSpace: number;
+    readonly rightOffsetBarCount: number;
+}
 interface Chart extends Store {
     id: string;
+    getBars: () => readonly CandleData[];
     getDom: (paneId?: string, position?: DomPosition) => Nullable<HTMLElement>;
     getSize: (paneId?: string, position?: DomPosition) => Nullable<Bounding>;
     createIndicator: (value: string | IndicatorCreate, isStack?: boolean, paneOptions?: PaneOptions) => Nullable<string>;
     getIndicators: (filter?: IndicatorFilter) => Indicator[];
     createOverlay: (value: string | OverlayCreate | Array<string | OverlayCreate>) => Nullable<string> | Array<Nullable<string>>;
     getOverlays: (filter?: OverlayFilter) => Overlay[];
+    getViewportState: () => ChartViewportState;
+    setViewportState: (state: ChartViewportState) => void;
     setPaneOptions: (options: PaneOptions) => void;
     getPaneOptions: (id?: string) => Nullable<PaneOptions> | PaneOptions[];
     scrollByDistance: (distance: number, animationDuration?: number) => void;
@@ -1178,4 +1002,4 @@ type IndicatorTemplate<D = unknown, C = unknown, E = unknown> = ExcludePickParti
 type IndicatorCreate<D = unknown, C = unknown, E = unknown> = ExcludePickPartial<Omit<Indicator<D, C, E>, 'result'>, 'name'>;
 type IndicatorFilter = Partial<Pick<Indicator, 'id' | 'paneId' | 'name'>>;
 
-export type { AstroneumOptions as A, CandleData as C, Datafeed as D, IndicatorTemplate as I, Nullable as N, OverlayTemplate as O, Price as P, SerializedChartState as S, Timestamp as T, Volume as V, XAxisTemplate as X, YAxisTemplate as Y, AstroneumHandle as a, IndicatorPlugin as b, Chart as c, Period as d, SymbolInfo as e, ChartEventMap as f, ChartPlugin as g, ChartPluginContext as h, DatafeedSubscribeCallback as i, Viewport as j };
+export type { ActionType as A, Bounding as B, Chart as C, DeepPartial as D, IndicatorCreate as I, Locales as L, Nullable as N, OverlayCreate as O, PaneOptions as P, Styles as S, XAxisTemplate as X, YAxisTemplate as Y, ZoomAnchor as Z, CandleData as a, IndicatorFilter as b, Indicator as c, OverlayFilter as d, Coordinate as e, IndicatorTemplate as f, OverlayTemplate as g, Options as h, ChartViewportState as i, Period as j, PeriodType as k, SymbolInfo as l };