lightweight-charts-indicators 0.13.1 → 0.13.3

package/dist/candlestick-port/adapter.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Adapter: fits the oakscriptjs candlestick port (PatternDef + patternScript)
+ * to this repo's `calculate(bars, inputs, chart): IndicatorResult` registry convention.
+ *
+ * Each pattern runs through `executeScript(() => patternScript(def), bars, inputs)`, which returns the
+ * IndicatorResult shape of this package (markers, bgColors, barColors); the result is passed through.
+ */
+import { type AlertConditionConfig } from 'oakscriptjs/script';
 import type { ChartContext } from '../chart-context';
 import type { Bar, IndicatorResult, InputConfig, PlotConfig } from 'oakscriptjs';
 import type { BarColorData, BgColorData, MarkerData } from '../types';
@@ -16,6 +24,8 @@ export interface PortIndicator {
     inputConfig: InputConfig[];
     plotConfig: PlotConfig[];
     defaultInputs: Record<string, unknown>;
+    /** The script's alertcondition() declarations; the result's `alerts` gives the bars on which each one is true. */
+    alertConditions: AlertConditionConfig[];
     calculate: (bars: Bar[], inputs?: Record<string, unknown>, chart?: ChartContext) => PortResult;
 }
 export interface PortEntry {

package/dist/candlestick-port/adapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../src/candlestick-port/adapter.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,KAAK,EAAE,GAAG,EAAE,eAAe,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACjF,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAKtE,MAAM,MAAM,UAAU,GAAG,eAAe,GAAG;IACzC,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,SAAS,EAAE,YAAY,EAAE,CAAC;CAC3B,CAAC;AAQF,qFAAqF;AACrF,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IAClE,WAAW,EAAE,WAAW,EAAE,CAAC;IAC3B,UAAU,EAAE,UAAU,EAAE,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,EAAE,YAAY,KAAK,UAAU,CAAC;CAChG;AAiFD,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,aAAa,CAAC;CAC1B;AAED,4DAA4D;AAC5D,eAAO,MAAM,yBAAyB,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAM,CAAC;AAE3E,oDAAoD;AACpD,eAAO,MAAM,sBAAsB,EAAE,SAAS,EAK5C,CAAC;AAEH,gHAAgH;AAChH,eAAO,MAAM,0BAA0B,EAAE,SAIxC,CAAC"}
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../src/candlestick-port/adapter.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAAiB,KAAK,oBAAoB,EAAwB,MAAM,oBAAoB,CAAC;AACpG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,KAAK,EAAE,GAAG,EAAE,eAAe,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACjF,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAKtE,MAAM,MAAM,UAAU,GAAG,eAAe,GAAG;IACzC,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,SAAS,EAAE,YAAY,EAAE,CAAC;CAC3B,CAAC;AAQF,qFAAqF;AACrF,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IAClE,WAAW,EAAE,WAAW,EAAE,CAAC;IAC3B,UAAU,EAAE,UAAU,EAAE,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,kHAAkH;IAClH,eAAe,EAAE,oBAAoB,EAAE,CAAC;IACxC,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,EAAE,YAAY,KAAK,UAAU,CAAC;CAChG;AAkFD,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,aAAa,CAAC;CAC1B;AAED,4DAA4D;AAC5D,eAAO,MAAM,yBAAyB,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAM,CAAC;AAE3E,oDAAoD;AACpD,eAAO,MAAM,sBAAsB,EAAE,SAAS,EAK5C,CAAC;AAEH,gHAAgH;AAChH,eAAO,MAAM,0BAA0B,EAAE,SAIxC,CAAC"}

package/dist/index.cjs

@@ -48236,6 +48236,7 @@ function buildIndicator(body, shortName) {
     inputConfig: probe.inputConfig,
     plotConfig: probe.plotConfig,
     defaultInputs: probe.defaultInputs,
+    alertConditions: probe.alertConfig,
     calculate: (bars, inputs = {}, chart) => convert((0, import_script30.executeScript)(body, bars, inputs, chart))
   };
 }
@@ -49536,7 +49537,8 @@ function calculate416(bars, inputs = {}, chart) {
     plots: {},
     lines: [],
     labels: [],
-    linefills: []
+    linefills: [],
+    alertCalls: []
   };
   if (n === 0)
     return empty;
@@ -49661,6 +49663,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}`])
@@ -49668,6 +49674,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,
@@ -49695,9 +49704,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");
@@ -49872,7 +49881,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";
@@ -49889,6 +49898,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) {
@@ -49939,6 +49950,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));
@@ -49972,10 +49988,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");
@@ -153736,7 +153753,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;
@@ -303005,6 +303023,7 @@ function candlestickEntries(pairs) {
     inputConfig: ind.inputConfig,
     plotConfig: ind.plotConfig,
     defaultInputs: { ...ind.defaultInputs },
+    ...ind.alertConditions?.length ? { alertConditions: ind.alertConditions } : {},
     calculate: ind.calculate
   }));
 }
@@ -324811,6 +324830,7 @@ var registryPart11 = [
     inputConfig: inputConfig416,
     plotConfig: plotConfig416,
     defaultInputs: { ...defaultInputs416 },
+    hasAlertFunction: true,
     calculate: calculate416
   },
   {
@@ -324825,6 +324845,7 @@ var registryPart11 = [
     inputConfig: inputConfig417,
     plotConfig: plotConfig417,
     defaultInputs: { ...defaultInputs417 },
+    hasAlertFunction: true,
     calculate: calculate417
   },
   {
@@ -325095,4 +325116,4 @@ var registryPart11 = [
   }
 ];
 var indicatorRegistry = [...registryPart1, ...registryPart11, ...registryPart2, ...registryPart3, ...registryPart4, ...registryPart5, ...registryPart6, ...registryPart7, ...registryPart8, ...registryPart9, ...registryPart10];
-var version = "0.13.1";
+var version = "0.13.3";

package/dist/index.d.ts

@@ -775,7 +775,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';
@@ -3348,6 +3348,20 @@ export interface IndicatorRegistryEntry {
      * `MissingSymbolDataError` that lists the same requests.
      */
     requiredSymbols?: (inputs: any, chart?: ChartContext) => SymbolRequest[];
+    /**
+     * The alert conditions the indicator declares (PineScript `alertcondition()`): id, title and default message. The
+     * result of `calculate` has an `alerts` array with, per condition id, the times of the bars on which it is true.
+     */
+    alertConditions?: {
+        id: string;
+        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;
 }
@@ -3356,5 +3370,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.1";
+export declare const version = "0.13.3";
 //# sourceMappingURL=index.d.ts.map