lightweight-charts-indicators 0.13.2 → 0.14.0

package/dist/index.cjs

@@ -1099,6 +1099,7 @@ __export(src_exports, {
   QuasimodoPattern: () => QuasimodoPattern,
   RCI3Lines: () => RCI3Lines,
   RCIRibbon: () => RCIRibbon,
+  REFERENCE_NAMES: () => REFERENCE_NAMES,
   RMAATRBands: () => RMAATRBands,
   RMITrendSniper: () => RMITrendSniper,
   ROC: () => ROC,
@@ -48304,6 +48305,178 @@ var candlestickPortAllPatterns = {
   indicator: buildIndicator(allPatternsScript, "All Patterns")
 };
 
+// src/reference-names.ts
+var REFERENCE_NAMES = {
+  "24-hour-volume": ["24-hour volume", "24H vol"],
+  "abandoned-baby-bearish": ["Abandoned baby (bearish)", "Abandoned baby (bear)"],
+  "abandoned-baby-bullish": ["Abandoned baby (bullish)", "Abandoned baby (bull)"],
+  "accumulation-distribution": ["Accumulation/distribution", "Accum/dist"],
+  "adr": ["Average daily range", "ADR"],
+  "adr-bars": ["Advance-decline ratio (bars)", "ADR (bars)"],
+  "adx": ["Average directional index", "ADX"],
+  "all-patterns": ["All candlestick patterns", "All candlestick patterns"],
+  "alma": ["Arnaud Legoux moving average", "ALMA"],
+  "aroon": ["Aroon", "Aroon"],
+  "aroon-oscillator": ["Aroon oscillator", "Aroon osc"],
+  "atr": ["Average true range", "ATR"],
+  "auto-fib-extension": ["Auto fib extension", "Auto fib extension"],
+  "auto-fib-retracement": ["Auto fib retracement", "Auto fib retracement"],
+  "auto-key-levels": ["Auto key levels", "Auto key levels"],
+  "auto-pitchfork": ["Auto pitchfork", "Auto pitchfork"],
+  "auto-trend-detector": ["Auto trend detector", "ATD"],
+  "awesome-oscillator": ["Awesome oscillator", "AO"],
+  "bb": ["Bollinger Bands", "BB"],
+  "bb-bandwidth": ["Bollinger BandWidth", "BBW"],
+  "bb-bars": ["Bollinger Bars", "Bollinger bars"],
+  "bb-percent-b": ["Bollinger Bands %b", "BB %b"],
+  "bbtrend": ["BBTrend", "BBTrend"],
+  "bop": ["Balance of power", "Balance of power"],
+  "bull-bear-power": ["Bull bear power", "BBP"],
+  "cci": ["Commodity channel index", "CCI"],
+  "chaikin-mf": ["Chaikin money flow", "CMF"],
+  "chaikin-osc": ["Chaikin oscillator", "Chaikin osc"],
+  "chande-kroll-stop": ["Chande Kroll stop", "Chande Kroll stop"],
+  "chande-mo": ["Chande momentum oscillator", "ChandeMO"],
+  "chandelier": ["Chandelier exit", "Chandelier"],
+  "chop-zone": ["Chop zone", "Chop zone"],
+  "choppiness": ["Choppiness index", "CHOP"],
+  "connors-rsi": ["Connors RSI", "CRSI"],
+  "coppock-curve": ["Coppock curve", "Coppock curve"],
+  "correlation-coefficient": ["Correlation coefficient", "CC"],
+  "cvd": ["Cumulative volume delta", "CVD"],
+  "dark-cloud-cover": ["Dark cloud cover (bearish)", "Dark cloud cover (bear)"],
+  "dema": ["Double exponential moving average", "DEMA"],
+  "dmi": ["Directional movement index", "DMI"],
+  "doji": ["Doji (neutral)", "Doji"],
+  "doji-star-bearish": ["Doji star (bearish)", "Doji star (bear)"],
+  "doji-star-bullish": ["Doji star (bullish)", "Doji star (bull)"],
+  "donchian": ["Donchian channels", "DC"],
+  "downside-tasuki-gap": ["Downside Tasuki gap (bearish)", "Downside Tasuki gap (bear)"],
+  "dpo": ["Detrended price oscillator", "DPO"],
+  "dragonfly-doji": ["Dragonfly Doji (bullish)", "Dragonfly Doji (bull)"],
+  "elder-force": ["Elder's force index", "EFI"],
+  "ema": ["Exponential moving average", "EMA"],
+  "engulfing-bearish": ["Engulfing (bearish)", "Engulfing (bear)"],
+  "engulfing-bullish": ["Engulfing (bullish)", "Engulfing (bull)"],
+  "envelope": ["Envelope", "Env"],
+  "eom": ["Ease of movement", "EOM"],
+  "evening-doji-star": ["Evening Doji star (bearish)", "Evening Doji star (bear)"],
+  "evening-star": ["Evening star (bearish)", "Evening star (bear)"],
+  "falling-three-methods": ["Falling three methods (bearish)", "Falling three methods (bear)"],
+  "falling-window": ["Falling window (bearish)", "Falling window (bear)"],
+  "fisher-transform": ["Fisher transform", "Fisher"],
+  "gaps": ["Gaps", "Gaps"],
+  "gravestone-doji": ["Gravestone Doji (bearish)", "Gravestone Doji (bear)"],
+  "hammer": ["Hammer (bullish)", "Hammer (bull)"],
+  "hanging-man": ["Hanging man (bearish)", "Hanging man (bear)"],
+  "harami-bearish": ["Harami (bearish)", "Harami (bear)"],
+  "harami-bullish": ["Harami (bullish)", "Harami (bull)"],
+  "harami-cross-bearish": ["Harami cross (bearish)", "Harami cross (bear)"],
+  "harami-cross-bullish": ["Harami cross (bullish)", "Harami cross (bull)"],
+  "hist-volatility": ["Historical volatility", "HV"],
+  "hma": ["Hull moving average", "HMA"],
+  "ichimoku": ["Ichimoku cloud", "Ichimoku"],
+  "inverted-hammer": ["Inverted hammer (bullish)", "Inverted hammer (bull)"],
+  "kama": ["Kaufman's adaptive moving average", "KAMA"],
+  "keltner": ["Keltner channels", "KC"],
+  "kicking-bearish": ["Kicking (bearish)", "Kicking (bear)"],
+  "kicking-bullish": ["Kicking (bullish)", "Kicking (bull)"],
+  "klinger": ["Klinger oscillator", "Klinger oscillator"],
+  "kst": ["Know sure thing", "KST"],
+  "linreg-channel": ["Linear regression channel", "Lin reg channel"],
+  "long-lower-shadow": ["Long lower shadow (bullish)", "Long lower shadow (bull)"],
+  "long-upper-shadow": ["Long upper shadow (bearish)", "Long upper shadow (bear)"],
+  "lsma": ["Least squares moving average", "LSMA"],
+  "ma-cross": ["Moving average crossover", "Moving average crossover"],
+  "ma-ribbon": ["Moving average ribbon", "MA ribbon"],
+  "macd": ["Moving average convergence divergence", "MACD"],
+  "marubozu-black": ["Marubozu black (bearish)", "Marubozu black (bear)"],
+  "marubozu-white": ["Marubozu white (bullish)", "Marubozu white (bull)"],
+  "mass-index": ["Mass index", "Mass index"],
+  "mc-ginley-dynamic": ["McGinley dynamic", "McGinley dynamic"],
+  "median": ["Median", "Median"],
+  "mfi": ["Money flow index", "MFI"],
+  "momentum": ["Momentum", "Mom"],
+  "moon-phases": ["Moon phases", "Moon phases"],
+  "morning-doji-star": ["Morning Doji star (bullish)", "Morning Doji star (bull)"],
+  "morning-star": ["Morning star (bullish)", "Morning star (bull)"],
+  "multi-time-period-charts": ["Multi-time period charts", "MTPC"],
+  "net-volume": ["Net volume", "Net volume"],
+  "nvi": ["Negative volume index", "NVI"],
+  "obv": ["On-balance volume", "OBV"],
+  "on-neck": ["On-neck (bearish)", "On-neck (bear)"],
+  "parabolic-sar": ["Parabolic SAR", "SAR"],
+  "performance": ["Performance", "Performance"],
+  "piercing": ["Piercing (bullish)", "Piercing (bull)"],
+  "pivot-points-high-low": ["Pivot points high low", "Pivots HL"],
+  "pivot-points-standard": ["Pivot points standard", "Pivots"],
+  "pmo": ["Price momentum oscillator", "PMO"],
+  "price-oscillator": ["Price oscillator", "PPO"],
+  "prings-special-k": ["Pring's special K", "Special K"],
+  "pvi": ["Positive volume index", "PVI"],
+  "pvt": ["Price-volume trend", "PVT"],
+  "rci": ["Rank correlation index", "RCI"],
+  "rci-ribbon": ["RCI ribbon", "RCI ribbon"],
+  "relative-volume-at-time": ["Relative volume at time", "Rel vol"],
+  "rising-three-methods": ["Rising three methods (bullish)", "Rising three methods (bull)"],
+  "rising-window": ["Rising window (bullish)", "Rising window (bull)"],
+  "rob-booker-ziv-ghost-pivots": ["Rob Booker \u2014 Ziv ghost pivots", "RB Ghost pivots"],
+  "roc": ["Rate of change", "ROC"],
+  "rsi": ["Relative strength index", "RSI"],
+  "rsi-divergence-indicator": ["RSI divergence indicator", "RSI divergence"],
+  "rvi": ["Relative vigor index", "RVGI"],
+  "rvol": ["Relative volatility index", "Rel volatility idx"],
+  "seasonality": ["Seasonality", "Seasonality"],
+  "shooting-star": ["Shooting star (bearish)", "Shooting star (bear)"],
+  "sma": ["Simple moving average", "SMA"],
+  "smi": ["Stochastic momentum index", "Stoch MI"],
+  "smi-ergodic": ["SMI ergodic indicator", "SMII"],
+  "smi-ergodic-osc": ["SMI ergodic oscillator", "SMIO"],
+  "smma": ["Smoothed moving average", "Smoothed MA"],
+  "spinning-top-black": ["Spinning top black (neutral)", "Spinning top black"],
+  "spinning-top-white": ["Spinning top white (neutral)", "Spinning top white"],
+  "stoch": ["Stochastic", "Stoch"],
+  "stoch-rsi": ["Stochastic RSI", "Stoch RSI"],
+  "supertrend": ["Supertrend", "Supertrend"],
+  "technicals": ["Technical ratings", "Technicals"],
+  "tema": ["Triple exponential moving average", "TEMA"],
+  "three-black-crows": ["Three black crows (bearish)", "Three black crows (bear)"],
+  "three-white-soldiers": ["Three white soldiers (bullish)", "Three white soldiers (bull)"],
+  "trading-sessions": ["Trading sessions", "Trading sessions"],
+  "trend-strength": ["Trend strength index", "TSI"],
+  "tri-star-bearish": ["Tri-star (bearish)", "Tri-star (bear)"],
+  "tri-star-bullish": ["Tri-star (bullish)", "Tri-star (bull)"],
+  "trix": ["TRIX", "TRIX"],
+  "tsi": ["True strength index", "TSI"],
+  "twap": ["Time-weighted average price", "TWAP"],
+  "tweezer-bottom": ["Tweezer bottom (bullish)", "Tweezer bottom (bull)"],
+  "tweezer-top": ["Tweezer top (bearish)", "Tweezer top (bear)"],
+  "ulcer-index": ["Ulcer index", "Ulcer index"],
+  "ultimate-osc": ["Ultimate oscillator", "UO"],
+  "up-down-volume": ["Up/down volume", "Up/dn vol"],
+  "upside-tasuki-gap": ["Upside Tasuki gap (bullish)", "Upside Tasuki gap (bull)"],
+  "visible-average-price": ["Visible average price", "Avg price"],
+  "volatility-stop": ["Volatility stop", "VStop"],
+  "volume-delta": ["Volume delta", "Volume delta"],
+  "volume-osc": ["Percentage volume oscillator", "PVO"],
+  "vortex": ["Vortex indicator", "VI"],
+  "vwap": ["Volume-weighted average price", "VWAP"],
+  "vwma": ["Volume-weighted moving average", "VWMA"],
+  "williams-alligator": ["Williams alligator", "Alligator"],
+  "williams-fractals": ["Williams fractal", "Fractal"],
+  "williams-r": ["Williams percent range", "Williams %R"],
+  "wma": ["Weighted moving average", "WMA"],
+  "woodies-cci": ["Woodies CCI", "Woodies CCI"],
+  "zigzag": ["Zigzag", "Zigzag"]
+};
+function withReferenceNames(entry) {
+  const names = REFERENCE_NAMES[entry.id];
+  if (!names)
+    return entry;
+  const [title, shortTitle] = names;
+  return { ...entry, name: title, shortName: shortTitle, metadata: { ...entry.metadata, title, shortTitle } };
+}
+
 // src/standard/aroon-oscillator.ts
 var defaultInputs403 = {
   length: 14
@@ -49537,7 +49710,8 @@ function calculate416(bars, inputs = {}, chart) {
     plots: {},
     lines: [],
     labels: [],
-    linefills: []
+    linefills: [],
+    alertCalls: []
   };
   if (n === 0)
     return empty;
@@ -49662,6 +49836,10 @@ function calculate416(bars, inputs = {}, chart) {
   const lastTime = bars[n - 1].time;
   const labelTime = left ? lineLast.time1 : !cfg.extendRight ? lineLast.time2 : lastTime;
   const fmt2 = (v) => import_oakscriptjs381.str.tostring(v, "mintick", tick);
+  const alertCalls = [];
+  const ticker = tickerOf(chart);
+  const c0 = bars[n - 1].close;
+  const c1 = n > 1 ? bars[n - 2].close : NaN;
   let other = null;
   for (const k of PROCESS_ORDER) {
     if (!cfg[`show_${k}`])
@@ -49669,6 +49847,9 @@ function calculate416(bars, inputs = {}, chart) {
     const m = cfg[`value_${k}`];
     const css2 = cfg[`color_${k}`];
     const r = base + (cfg.reverse ? -1 : 1) * diff * m;
+    if (gt19(r, c0) && gt19(c1, r) || gt19(c0, r) && gt19(r, c1)) {
+      alertCalls.push({ time: bars[n - 1].time, message: "Autofib: " + ticker + " crossing level " + import_oakscriptjs381.str.tostring(m), freq: "once_per_bar" });
+    }
     const id = {
       time1: lineLast.time1,
       price1: r,
@@ -49696,9 +49877,9 @@ function calculate416(bars, inputs = {}, chart) {
       linefills.push({ line1: id, line2: other, color: import_oakscriptjs381.color.new(css2, cfg.backgroundTransparency) });
     other = id;
   }
-  return { ...empty, lines, labels, linefills };
+  return { ...empty, lines, labels, linefills, alertCalls };
 }
-var AutoFibExtension = { calculate: calculate416, metadata: metadata416, defaultInputs: defaultInputs416, inputConfig: inputConfig416, plotConfig: plotConfig416 };
+var AutoFibExtension = { calculate: calculate416, metadata: metadata416, defaultInputs: defaultInputs416, inputConfig: inputConfig416, plotConfig: plotConfig416, hasAlertFunction: true };
 
 // src/standard/auto-fib-retracement.ts
 var import_oakscriptjs382 = require("oakscriptjs");
@@ -49873,7 +50054,7 @@ function calculate417(bars, inputs = {}, chart) {
   const tick = mintickOf(chart);
   const meta = { title: metadata417.title, shorttitle: metadata417.shortTitle, overlay: metadata417.overlay };
   if (n === 0)
-    return { metadata: meta, plots: {}, lines: [], labels: [], linefills: [] };
+    return { metadata: meta, plots: {}, lines: [], labels: [], linefills: [], alertCalls: [] };
   const toMs = chart?.timeUnit === "ms" ? 1 : 1e3;
   const timeMs = (t) => t * toMs;
   const extending = cfg.extendLeft && cfg.extendRight ? "both" : cfg.extendLeft ? "left" : cfg.extendRight ? "right" : "none";
@@ -49890,6 +50071,8 @@ function calculate417(bars, inputs = {}, chart) {
   let height = NaN;
   const levelLines = /* @__PURE__ */ new Map();
   const levelLabels = /* @__PURE__ */ new Map();
+  const alertCalls = [];
+  const ticker = tickerOf(chart);
   for (let i = 0; i < n; i++) {
     (0, import_oakscriptjs382.setDrawingBar)(i, i === n - 1);
     if (i === n - 1 && zigZag.pivots.length < 2) {
@@ -49940,6 +50123,11 @@ function calculate417(bars, inputs = {}, chart) {
       const m = cfg[`value_${k}`];
       const css2 = cfg[`color_${k}`];
       const r = startPrice + height * m;
+      const c0 = bars[i].close;
+      const c1 = i > 0 ? bars[i - 1].close : NaN;
+      if (gt20(r, c0) && gt20(c1, r) || gt20(c0, r) && gt20(r, c1)) {
+        alertCalls.push({ time: bars[i].time, message: "Autofib: " + ticker + " crossing level " + import_oakscriptjs382.str.tostring(m), freq: "once_per_bar" });
+      }
       let id = levelLines.get(k);
       if (!id) {
         id = (0, import_oakscriptjs382.holdDrawing)(import_oakscriptjs382.line.new(timeMs(s.time), s.price, timeMs(bars[i].time), r, "bar_time", extending, css2, "solid", 1));
@@ -49973,10 +50161,11 @@ function calculate417(bars, inputs = {}, chart) {
     plots: {},
     lines: out.lines ?? [],
     labels: out.labels ?? [],
-    linefills: out.linefills ?? []
+    linefills: out.linefills ?? [],
+    alertCalls
   };
 }
-var AutoFibRetracement = { calculate: calculate417, metadata: metadata417, defaultInputs: defaultInputs417, inputConfig: inputConfig417, plotConfig: plotConfig417 };
+var AutoFibRetracement = { calculate: calculate417, metadata: metadata417, defaultInputs: defaultInputs417, inputConfig: inputConfig417, plotConfig: plotConfig417, hasAlertFunction: true };
 
 // src/standard/auto-pitchfork.ts
 var import_oakscriptjs383 = require("oakscriptjs");
@@ -153737,7 +153926,8 @@ function calculate1214(bars, inputs = {}) {
       hl2: hl25,
       hlc3: hlc32,
       ohlc4,
-      hlcc4
+      hlcc4,
+      volume: b.volume ?? NaN
     };
     const src = srcVals[cfg.trendSource] ?? b.close;
     let rs;
@@ -324813,6 +325003,7 @@ var registryPart11 = [
     inputConfig: inputConfig416,
     plotConfig: plotConfig416,
     defaultInputs: { ...defaultInputs416 },
+    hasAlertFunction: true,
     calculate: calculate416
   },
   {
@@ -324827,6 +325018,7 @@ var registryPart11 = [
     inputConfig: inputConfig417,
     plotConfig: plotConfig417,
     defaultInputs: { ...defaultInputs417 },
+    hasAlertFunction: true,
     calculate: calculate417
   },
   {
@@ -325096,5 +325288,5 @@ var registryPart11 = [
     calculate: calculate435
   }
 ];
-var indicatorRegistry = [...registryPart1, ...registryPart11, ...registryPart2, ...registryPart3, ...registryPart4, ...registryPart5, ...registryPart6, ...registryPart7, ...registryPart8, ...registryPart9, ...registryPart10];
-var version = "0.13.2";
+var indicatorRegistry = [...registryPart1, ...registryPart11, ...registryPart2, ...registryPart3, ...registryPart4, ...registryPart5, ...registryPart6, ...registryPart7, ...registryPart8, ...registryPart9, ...registryPart10].map(withReferenceNames);
+var version = "0.14.0";

package/dist/index.d.ts

@@ -729,6 +729,7 @@ export type { RealtimeVolumeBarsInputs } from './community/realtime-volume-bars'
 export type { VolumaticSRLevelsInputs } from './community/volumatic-sr-levels';
 export type { VwapMvwapEmaCrossoverInputs } from './community/vwap-mvwap-ema-crossover';
 export type { VolumeFootprintInputs } from './community/volume-footprint';
+export { REFERENCE_NAMES } from './reference-names';
 export { candlestickPortIndicators, candlestickPortEntries, candlestickPortAllPatterns } from './candlestick-port/adapter';
 export declare const Hammer: import("./candlestick-port/adapter").PortIndicator;
 export declare const ShootingStar: import("./candlestick-port/adapter").PortIndicator;
@@ -775,7 +776,7 @@ export declare const UpsideTasukiGap: import("./candlestick-port/adapter").PortI
 export declare const FallingThreeMethods: import("./candlestick-port/adapter").PortIndicator;
 export declare const RisingThreeMethods: import("./candlestick-port/adapter").PortIndicator;
 export declare const AllPatterns: import("./candlestick-port/adapter").PortIndicator;
-export type { MarkerData, MarkerPosition, MarkerShape, PineSize, BarColorData, BgColorData, PlotCandleData, PlotBarData, LabelData, LabelStyle, LineDrawingData, BoxData, LinefillData, PolylineData, TableData, TableCell, TableCellData, TableMergeData, TablePosition, } from './types';
+export type { MarkerData, MarkerPosition, MarkerShape, PineSize, BarColorData, BgColorData, PlotCandleData, PlotBarData, LabelData, LabelStyle, LineDrawingData, BoxData, LinefillData, PolylineData, TableData, TableCell, TableCellData, TableMergeData, TablePosition, AlertCall, } from './types';
 export { barInterval, barTime } from './bar-time';
 export { AroonOscillator, calculate as calculateAroonOscillator } from './standard/aroon-oscillator';
 export type { AroonOscillatorInputs } from './standard/aroon-oscillator';
@@ -3357,6 +3358,11 @@ export interface IndicatorRegistryEntry {
         title: string;
         message?: string;
     }[];
+    /**
+     * True when the indicator calls PineScript `alert()`: an alert can watch "Any alert() function call". The result of
+     * `calculate` then has an `alertCalls` array (bar time, message, frequency of each call).
+     */
+    hasAlertFunction?: boolean;
     /** `chart`: what the caller knows about the chart and its symbol (tick, time zone, ...), see ChartContext */
     calculate: (bars: Bar[], inputs?: any, chart?: ChartContext) => any;
 }
@@ -3365,5 +3371,5 @@ export type { ChartContext, VisibleRange, SymbolRequest, SymbolInfo } from './ch
 export { MissingSymbolDataError, symbolBarsOf } from './chart-context';
 export { mintickOf, timezoneOf, tickeridOf, tickerOf, symbolTypeOf, currencyOf, basecurrencyOf, rootOf, foregroundColorOf, backgroundColorOf, lastBarConfirmedOf, nowOf, visibleRangeOf, } from './chart-context';
 export { securityOther, securityOtherValues, securityLowerTf, otherSymbolChart, spreadSymbols, spreadBars, spreadOptions, type OtherSymbolOptions, type OtherSymbolChart, type SymbolCalendar, } from './other-symbol';
-export declare const version = "0.13.2";
+export declare const version = "0.14.0";
 //# sourceMappingURL=index.d.ts.map