openalgo-charts 1.8.8 → 1.8.9

package/README.md

@@ -9,7 +9,7 @@ Professional interactive charts, 102 built-in indicators plus your own custom on
 [![npm version](https://img.shields.io/npm/v/openalgo-charts.svg?color=cb3837&label=npm)](https://www.npmjs.com/package/openalgo-charts)
 [![license](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](./LICENSE)
 [![bundle](https://img.shields.io/badge/brotli-61%20KB%20base%20%C2%B7%20122%20KB%20all%20tiers-brightgreen.svg)](#size-budget)
-[![tests](https://img.shields.io/badge/tests-2466%20passing-brightgreen.svg)](#develop)
+[![tests](https://img.shields.io/badge/tests-2586%20passing-brightgreen.svg)](#develop)
 [![dependencies](https://img.shields.io/badge/runtime%20deps-0-brightgreen.svg)](#principles)
 
 [**Documentation**](https://marketcalls.github.io/openalgo-charts/)  ·  [**Live examples**](https://marketcalls.github.io/openalgo-charts/examples)  ·  [**Getting started**](./docs/getting-started.md)  ·  [**Architecture**](./ARCHITECTURE.md)
@@ -62,7 +62,7 @@ in front of npm rather than being places you upload to. A chart is one HTML file
 ```html
 <div id="chart" style="width:100vw;height:100vh"></div>
 <script type="module">
-  import { createChart } from 'https://unpkg.com/openalgo-charts@1.8.8/dist/openalgo-charts.mjs';
+  import { createChart } from 'https://unpkg.com/openalgo-charts@1.8.9/dist/openalgo-charts.mjs';
   const chart = createChart(document.getElementById('chart'), { timezone: 'Asia/Kolkata' });
   chart.addSeries('candlestick').setData(bars);
 </script>
@@ -79,14 +79,14 @@ Import only what you use. Each tier is a separate bundle that registers into the
 
 | Import | Contents | Brotli |
 |---|---|---|
-| `openalgo-charts` | Engine, 13 chart types, panes &amp; scales, primitives, registries, chart state, chart linking, bar cache, interval registry, trading overlay, OpenAlgo feeds | 60.6 KB |
+| `openalgo-charts` | Engine, 13 chart types, panes &amp; scales, primitives, registries, chart state, chart linking, bar cache, interval registry, trading overlay, OpenAlgo feeds | 60.8 KB |
 | `openalgo-charts/indicators` | 102 built-in indicators, the `registerIndicator` contract for your own, and the Tier-2 (external-data) contract | 27.3 KB |
 | `openalgo-charts/draw` | 43 drawing tools + a headless drawing controller and clipboard | 13.1 KB |
 | `openalgo-charts/transform` | Heikin Ashi, Renko, Range bars, Line Break, Point &amp; Figure, Kagi | 2.7 KB |
 | `openalgo-charts/profile` | Volume Profile, Market Profile (TPO), Footprint, order flow | 10.7 KB |
 | `openalgo-charts/trade` | Order / position / bracket tools + DOM ladder | 7.6 KB |
 
-Everything together is **121.90 KB Brotli**. Figures are the measured `size-limit` output. The trade tier is listed as its delta over the base, so loading base + trade costs 68.18 KB.
+Everything together is **122.15 KB Brotli**. Figures are the measured `size-limit` output. The trade tier is listed as its delta over the base, so loading base + trade costs 68.43 KB.
 
 ## What's built
 
@@ -227,13 +227,13 @@ Enforced in CI by [`size-limit`](./.size-limit.json). Nothing is excluded, becau
 
 | Bundle | Limit | Actual |
 |---|---|---|
-| Base engine | 62 KB | 60.57 KB |
-| Base + trade | 70 KB | 68.18 KB |
+| Base engine | 62 KB | 60.83 KB |
+| Base + trade | 70 KB | 68.43 KB |
 | Indicators tier | 30 KB | 27.27 KB |
 | Draw tier | 14 KB | 13.13 KB |
 | Transform tier | 5 KB | 2.66 KB |
 | Profile tier | 11 KB | 10.66 KB |
-| **Everything** | **124 KB** | **121.90 KB** |
+| **Everything** | **124 KB** | **122.15 KB** |
 
 ## Documentation
 
@@ -273,7 +273,7 @@ cd examples/yfinance && pip install -r requirements.txt && python server.py
 ```bash
 npm install        # install dev toolchain
 npm run typecheck  # strict TypeScript check
-npm test           # unit tests (vitest) - 2466 across 137 files
+npm test           # unit tests (vitest) - 2586 across 140 files
 npm run build      # Rollup -> dist/ (minified ESM per tier + types)
 npm run size       # size-limit (Brotli) against the budget
 npm run e2e        # Playwright Chromium smoke tests
@@ -290,7 +290,7 @@ npm run verify     # typecheck + test + build + size
 
 ## Status &amp; limitations
 
-Version **1.8.8**. All engine build phases are implemented with 2466 unit tests across 137 files.
+Version **1.8.9**. All engine build phases are implemented with 2586 unit tests across 140 files.
 
 Known gaps, stated plainly:
 

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 /** Library version string. Matches package.json (published npm release). */
-declare const VERSION = "1.8.8";
+declare const VERSION = "1.8.9";
 /** Returns the current library version. */
 declare function version(): string;
 
@@ -125,8 +125,24 @@ interface PriceScaleOptions {
     /** Fraction of pane height kept empty at top/bottom (default 0.1 each). */
     marginTop: number;
     marginBottom: number;
-    /** Instrument tick size (minMove), e.g. 0.05. 0 → infer from range. */
+    /**
+     * Instrument tick size (minMove), e.g. 0.05. 0 → infer from range.
+     *
+     * A property of the instrument and not of the axis, so it belongs only on a
+     * scale that quotes one. An oscillator's pane reads in its own units and is
+     * left at 0 there, which is why `Chart.setPriceScaleOptions` withholds it
+     * from those panes rather than broadcasting it like the rest of this block.
+     */
     minMove: number;
+    /**
+     * Least decimals a scale with no tick will print. 0 leaves the span to
+     * decide alone, which is right for a price axis and too coarse for a bounded
+     * oscillator: see `precision()`.
+     *
+     * Ignored once `minMove` is set, because a declared tick is a stronger
+     * statement about the instrument than a floor is about the axis.
+     */
+    minPrecision: number;
     /** Linear, logarithmic or rebased (percentage / indexed-to-100) price↔y mapping. */
     mode: PriceScaleMode;
     /** Flip the axis (price increases downward) — for spread/short views. */
@@ -293,6 +309,15 @@ declare class PriceScale {
      * price tick size means nothing: precision comes from the transformed span
      * instead, with two decimals as the floor traders expect of a percentage
      * ("+3.42%") and more only when the visible band is tighter than that.
+     *
+     * A scale carrying no tick is not quoting an instrument, so the span is all
+     * there is to go on. That alone reads too coarse on a bounded oscillator: an
+     * RSI spanning 0 to 100 implies a step of 1 and prints a whole-number ladder,
+     * so a reading of 62.24 lands on a rung labelled "62" and a trader comparing
+     * it to a 70 level is reading a number that has been rounded past the part
+     * they care about. `minPrecision` is the floor for that case, and it is the
+     * same two decimals the percent branch above already settles on for the same
+     * reason.
      */
     precision(): number;
     /**
@@ -1643,7 +1668,12 @@ interface IndicatorCalcContext {
     /** Chart wall clock in UTC seconds, the clock the countdown row reads. */
     now(): number;
     /**
-     * The instrument's tick size, from the pane's price scale `minMove`.
+     * The instrument's tick size, from the **price pane's** `minMove`.
+     *
+     * The price pane and not the indicator's own, because `calc` runs on the
+     * instrument's bars whichever pane the plot lands in, and a study pane is not
+     * quoted in the instrument's tick: an RSI is a dimensionless 0..100 band, so
+     * its scale carries no tick at all to read.
      *
      * `undefined` when the host has not told the chart what it is, which is the
      * honest answer rather than a guessed 0.01: an indicator sizing a range in
@@ -2349,8 +2379,12 @@ interface IndicatorHost {
     /** Emit on the chart's event bus (indicator alerts, and `attach`'s own events). */
     emit?(event: string, payload: unknown): void;
     /**
-     * Tick size of the pane's price scale, or undefined when none is set.
+     * Tick size of the named pane's price scale, or undefined when none is set.
      * Optional so a host predating it still satisfies this interface.
+     *
+     * Per pane, and the panes genuinely differ: a pane that does not quote the
+     * instrument has no tick to report. Pane 0 is the price pane, so it is the
+     * one to ask for the instrument's own step.
      */
     tickSize?(paneIndex: number): number | undefined;
     /** Pin a pane's price scale to a fixed range, or release it with `null`. */
@@ -3139,7 +3173,8 @@ interface ChartOptions {
     /**
      * Default price-scale options applied to every pane (tick size `minMove`,
      * `mode: 'linear' | 'logarithmic' | 'percentage' | 'indexed-to-100'`,
-     * `inverted`, and top/bottom margins).
+     * `inverted`, and top/bottom margins). `minMove` is the instrument's, so it
+     * lands only on panes that quote it, see `setPriceScaleOptions`.
      * Tune a single pane later via `chart.panes()[n].priceScale.setOptions(...)`.
      */
     priceScale?: Partial<PriceScaleOptions>;
@@ -3350,6 +3385,8 @@ declare class Chart {
     private _dragStartX;
     private _dragStartY;
     private _lastDragY;
+    /** Pointers whose gesture the missed-release recovery already ended. */
+    private readonly _endedPointers;
     private readonly _pointers;
     private _pinch;
     private _pinchPane;
@@ -3417,6 +3454,16 @@ declare class Chart {
     private _axisStartSpacing;
     private _priceFormatter;
     private _priceScaleOptions;
+    /**
+     * The panes whose numbers are the instrument's price, which is what decides
+     * whether a chart-wide `minMove` reaches them (see `_scalePatchFor`).
+     *
+     * Held by pane identity rather than by index, for the reason spelled out in
+     * `_createSeries`: `removePane` splices the array and `movePane` swaps two
+     * entries, so a pane's slot number is not the pane. Weak because a removed
+     * pane is destroyed and nothing else keeps it alive.
+     */
+    private readonly _pricePanes;
     private _timeFormatter;
     private _timezone;
     private _leftAxisWidth;
@@ -3704,8 +3751,41 @@ declare class Chart {
      *    the right. Plot margins want this.
      *  - `'all'`: the hidden overlay scales too. Almost nothing should: an
      *    overlay's margins are its creator's placement, see `Pane.axisScales`.
+     *
+     * `minMove` is the one field no scope carries onto a pane that does not quote
+     * the instrument, whichever scope is asked for: see `_scalePatchFor`. Every
+     * other field is a property of the axis and reaches exactly as far as `scope`
+     * says.
      */
     setPriceScaleOptions(patch: Partial<PriceScaleOptions>, scope?: 'primary' | 'axes' | 'all'): void;
+    /**
+     * A chart-wide price-scale patch as one pane should receive it.
+     *
+     * Every field in it describes the axis, except `minMove`, which describes the
+     * **instrument**: it is the step the symbol trades in, 0.05 on an NSE equity.
+     * A pane that plots something else is quoted in its own units, so handing it
+     * that step is not a coarse answer but an answer to a different question. It
+     * shipped as one: a host setting the instrument's 0.10 tick chart-wide made
+     * `PriceScale.precision` report one decimal on *every* pane, so a William VIX
+     * Fix reading 0.61 was labelled "0.6" and an RSI ladder read "70.0, 50.0,
+     * 30.0". Withheld, those axes fall back to inferring precision from the range
+     * they actually cover, which is the reading their own numbers imply.
+     *
+     * Only the chart-wide setters filter. An axis named outright
+     * (`setPriceAxisOptions`, a series' `priceFormat`) is the caller saying what
+     * that one axis quotes, and is obeyed.
+     */
+    private _scalePatchFor;
+    /**
+     * Record that a pane quotes the instrument, and hand it the tick it was not
+     * given while it did not.
+     *
+     * Pane 0 is one from birth. Any other pane starts out an indicator's, so a
+     * host adding a second symbol to a pane of its own has to be able to promote
+     * one after the fact, or the comparison would lose the tick-sized axis it has
+     * always had.
+     */
+    private _claimPricePane;
     /** The primary pane's price-scale options (what the Scales tab reads). */
     priceScaleOptions(): PriceScaleOptions;
     /**