openalgo-charts 1.0.0

package/dist/transform/index.d.ts

@@ -0,0 +1,178 @@
+/**
+ * Internal time is always **UTC seconds** (integer). Feed adapters convert
+ * broker formats (IST strings, epoch ms) to this at the edge; see ARCHITECTURE.md §4.0.
+ */
+type UTCSeconds = number;
+/** A single OHLC(V) bar. `volume` is optional (not all feeds carry it). */
+interface Bar {
+    time: UTCSeconds;
+    open: number;
+    high: number;
+    low: number;
+    close: number;
+    volume?: number;
+}
+
+/**
+ * Series transform pipeline (ARCHITECTURE.md §6A, Family B). A transform
+ * re-buckets raw OHLC into a derived element series driven by price movement,
+ * not the clock. Transforms are incremental (streaming) so live ticks extend
+ * the series without recomputing history.
+ *
+ * Each derived element is a Bar carrying its source formation time. Because the
+ * time scale is index-based, derived elements get uniform spacing automatically
+ * (the "ordinal" axis); axis labels read each element's formation time. We only
+ * post-process times to be strictly increasing so the shared DataLayer keeps
+ * every element on its own logical index (no collisions when many elements form
+ * within one source bar).
+ */
+
+interface ISeriesTransform {
+    /** Reset to initial state (start of a fresh batch / re-subscribe). */
+    reset(): void;
+    /** Feed one source bar; return 0..n newly *completed* derived elements. */
+    push(bar: Bar): Bar[];
+    /** Optional: emit any in-progress element at end of data. */
+    flush?(): Bar[];
+}
+/**
+ * Make times strictly increasing (collisions bumped by +1s) so the DataLayer
+ * assigns one logical index per element. Labels stay within a few seconds of
+ * the real formation time.
+ */
+declare function ensureIncreasingTimes(bars: readonly Bar[]): Bar[];
+/** Run a transform over a full batch of bars (history load). */
+declare function runTransform(transform: ISeriesTransform, bars: readonly Bar[]): Bar[];
+
+/**
+ * Heikin Ashi (ARCHITECTURE.md §6A). 1:1 with input bars (keeps real times);
+ * renders with the candlestick renderer.
+ *   haClose = (o+h+l+c)/4
+ *   haOpen  = first: (o+c)/2 ; else (prevHaOpen + prevHaClose)/2
+ *   haHigh  = max(h, haOpen, haClose) ; haLow = min(l, haOpen, haClose)
+ */
+
+declare class HeikinAshiTransform implements ISeriesTransform {
+    private _prevOpen;
+    private _prevClose;
+    reset(): void;
+    push(bar: Bar): Bar[];
+}
+
+/**
+ * Renko bricks (ARCHITECTURE.md §6A). Each fixed box-size move of the close
+ * emits one brick. Renders with the candlestick renderer (brick = a body).
+ * Simplified single-box step (no 2× reversal rule) — deterministic and
+ * incremental for live updates.
+ */
+
+interface RenkoOptions {
+    boxSize: number;
+}
+declare class RenkoTransform implements ISeriesTransform {
+    private readonly _box;
+    private _edge;
+    constructor(options: RenkoOptions);
+    reset(): void;
+    push(bar: Bar): Bar[];
+}
+
+/**
+ * Range bars (ARCHITECTURE.md §6A). A new bar completes when its high−low
+ * reaches the configured range. Built from the close sequence; renders with the
+ * candlestick renderer. Incremental: the in-progress bar is emitted by flush().
+ */
+
+interface RangeOptions {
+    range: number;
+}
+declare class RangeBarsTransform implements ISeriesTransform {
+    private readonly _range;
+    private _cur;
+    constructor(options: RangeOptions);
+    reset(): void;
+    push(bar: Bar): Bar[];
+    flush(): Bar[];
+}
+
+/**
+ * Line Break (ARCHITECTURE.md §6A). A new line forms only when the close breaks
+ * beyond the extreme of the prior N lines (default 3). Renders with the
+ * candlestick renderer (each line = a body). Incremental.
+ */
+
+interface LineBreakOptions {
+    lines: number;
+}
+declare class LineBreakTransform implements ISeriesTransform {
+    private readonly _n;
+    private _lines;
+    constructor(options?: LineBreakOptions);
+    reset(): void;
+    push(bar: Bar): Bar[];
+}
+
+/**
+ * Point & Figure (ARCHITECTURE.md §6A). Columns of X (up) / O (down); a new
+ * column starts only after a reversal of `reversal` boxes. Each column is
+ * encoded as a Bar spanning the column's price range, with up = close ≥ open
+ * (X) and down = close < open (O). The point-figure renderer stacks the glyphs
+ * using `boxSize` from the series style.
+ */
+
+interface PointFigureOptions {
+    boxSize: number;
+    reversal: number;
+}
+declare class PointFigureTransform implements ISeriesTransform {
+    private readonly _box;
+    private readonly _reversal;
+    private _dir;
+    private _topBox;
+    private _botBox;
+    private _time;
+    constructor(options: PointFigureOptions);
+    reset(): void;
+    private _column;
+    push(bar: Bar): Bar[];
+    flush(): Bar[];
+}
+
+/**
+ * Kagi (ARCHITECTURE.md §6A). A continuous line that reverses direction only
+ * after a move of at least `reversal`. Turning points are emitted as vertices.
+ * Line thickness (yang/yin) is encoded in `volume` (1 = thick, 0 = thin) using
+ * a simplified rule: thick once the line exceeds the previous up-turn (higher
+ * shoulder), thin once it falls below the previous down-turn (lower waist).
+ * The kagi renderer connects vertices with a stepped line of varying width.
+ */
+
+interface KagiOptions {
+    reversal: number;
+}
+declare class KagiTransform implements ISeriesTransform {
+    private readonly _reversal;
+    private _dir;
+    private _ext;
+    private _prevShoulder;
+    private _prevWaist;
+    private _thick;
+    constructor(options: KagiOptions);
+    reset(): void;
+    push(bar: Bar): Bar[];
+    flush(): Bar[];
+}
+
+declare const TRANSFORM_TIER: "transform";
+/**
+ * Register the Family-B custom renderers (point-figure, kagi). Called as a side
+ * effect when this tier is imported, and also exported so consumers whose
+ * bundler aggressively tree-shakes a bare `import 'openalgo-charts/transform'`
+ * can call it explicitly. Idempotent.
+ *
+ * (Heikin Ashi / Renko / Range / Line Break render as a 'candlestick' series and
+ * need no new type — only P&F and Kagi have custom renderers.)
+ */
+declare function registerTransformChartTypes(): void;
+
+export { HeikinAshiTransform, type ISeriesTransform, type KagiOptions, KagiTransform, type LineBreakOptions, LineBreakTransform, type PointFigureOptions, PointFigureTransform, RangeBarsTransform, type RangeOptions, type RenkoOptions, RenkoTransform, TRANSFORM_TIER, ensureIncreasingTimes, registerTransformChartTypes, runTransform };

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "openalgo-charts",
+  "version": "1.0.0",
+  "description": "From-scratch, dependency-free canvas charting engine for OpenAlgo: professional-grade interactive rendering plus advanced on-chart trading.",
+  "license": "Apache-2.0",
+  "author": "marketcalls",
+  "homepage": "https://github.com/marketcalls/openalgo-charts#readme",
+  "repository": { "type": "git", "url": "git+https://github.com/marketcalls/openalgo-charts.git" },
+  "bugs": { "url": "https://github.com/marketcalls/openalgo-charts/issues" },
+  "keywords": ["charts", "charting", "candlestick", "trading", "finance", "canvas", "openalgo", "technical-analysis", "footprint", "renko", "heikin-ashi"],
+  "type": "module",
+  "module": "dist/openalgo-charts.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/openalgo-charts.mjs"
+    },
+    "./trade": {
+      "types": "./dist/trade/index.d.ts",
+      "import": "./dist/openalgo-charts.trade.mjs"
+    },
+    "./transform": {
+      "types": "./dist/transform/index.d.ts",
+      "import": "./dist/openalgo-charts.transform.mjs"
+    },
+    "./profile": {
+      "types": "./dist/profile/index.d.ts",
+      "import": "./dist/openalgo-charts.profile.mjs"
+    }
+  },
+  "files": [
+    "dist/**",
+    "!dist/openalgo-charts.all.mjs",
+    "!dist/openalgo-charts.all.mjs.map"
+  ],
+  "sideEffects": [
+    "**/transform/**",
+    "./dist/openalgo-charts.transform.mjs"
+  ],
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "rollup -c",
+    "build:watch": "rollup -c --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "e2e": "playwright test",
+    "size": "size-limit",
+    "docs": "typedoc",
+    "verify": "npm run typecheck && npm run test && npm run build && npm run size",
+    "prepublishOnly": "npm run verify"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.49.1",
+    "@rollup/plugin-terser": "0.4.4",
+    "@rollup/plugin-typescript": "12.1.2",
+    "@size-limit/file": "11.1.6",
+    "rimraf": "6.0.1",
+    "rollup": "4.30.1",
+    "rollup-plugin-dts": "6.1.1",
+    "size-limit": "11.1.6",
+    "tslib": "2.8.1",
+    "typedoc": "0.27.6",
+    "typescript": "5.7.3",
+    "vitest": "2.1.8"
+  }
+}