lightweight-charts-indicators 0.13.0 → 0.13.2

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))
   };
 }
@@ -303005,6 +303006,7 @@ function candlestickEntries(pairs) {
     inputConfig: ind.inputConfig,
     plotConfig: ind.plotConfig,
     defaultInputs: { ...ind.defaultInputs },
+    ...ind.alertConditions?.length ? { alertConditions: ind.alertConditions } : {},
     calculate: ind.calculate
   }));
 }
@@ -325095,4 +325097,4 @@ var registryPart11 = [
   }
 ];
 var indicatorRegistry = [...registryPart1, ...registryPart11, ...registryPart2, ...registryPart3, ...registryPart4, ...registryPart5, ...registryPart6, ...registryPart7, ...registryPart8, ...registryPart9, ...registryPart10];
-var version = "0.13.0";
+var version = "0.13.2";

package/dist/index.d.ts

@@ -3348,6 +3348,15 @@ 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;
+    }[];
     /** `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 +3365,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.0";
+export declare const version = "0.13.2";
 //# sourceMappingURL=index.d.ts.map