oakscriptjs 0.11.6 → 0.12.0

package/src/types/metadata.ts

@@ -184,6 +184,8 @@ export interface PlotData {
  * Horizontal line data
  */
 export interface HLineData {
+    /** Id of the declaration that produced it (its config entry) */
+    id?: string;
   /** Y-axis value */
   value: number;
   /** Line options */
@@ -194,6 +196,8 @@ export interface HLineData {
  * Fill data (area between two plots)
  */
 export interface FillData {
+    /** Id of the declaration that produced it (its config entry) */
+    id?: string;
   /** First plot index or name */
   plot1: number | string;
   /** Second plot index or name */
@@ -345,6 +349,8 @@ export interface ArrowData {
  * Per-bar candle color (barcolor() output)
  */
 export interface BarColorData {
+    /** Id of the declaration that produced it (its config entry) */
+    id?: string;
   /** Time of the colored bar (offset already applied) */
   time: number;
   /** Color */
@@ -355,6 +361,8 @@ export interface BarColorData {
  * Per-bar background color (bgcolor() output)
  */
 export interface BgColorData {
+    /** Id of the declaration that produced it (its config entry) */
+    id?: string;
   /** Time of the colored bar (offset already applied) */
   time: number;
   /** Color (with its transparency) */

package/src/utils/index.ts

@@ -8,6 +8,7 @@ import { sma, ema, wma, rma } from '../ta/index.js';
 import { Series } from '../runtime/series.js';
 import type { SourceType } from '../input.js';
 import { isDeleted } from '../drawing/registry.js';
+import { externalSource } from './source-resolver.js';
 
 /**
  * Validates that a series has sufficient data for a given length
@@ -197,6 +198,9 @@ export function getSource(
       case 'hlcc4': return ohlc.high.map((h, i) => (h + ohlc.low[i]! + ohlc.close[i]! + ohlc.close[i]!) / 4);
       case 'volume': return ohlc.volume ?? ohlc.close.map(() => NaN);
     }
+    const ext = externalSource(source);
+    if (!ext) return ohlc.close;
+    return ohlc.close.map((_, i) => (ext as ArrayLike<number>)[i] ?? NaN);
   } else {
     const bars = data as Bar[];
     switch (source) {
@@ -210,6 +214,10 @@ export function getSource(
       case 'hlcc4': return bars.map(b => (b.high + b.low + b.close + b.close) / 4);
       case 'volume': return bars.map(b => b.volume ?? NaN);
     }
+    // Another source (study on study), else close.
+    const ext = externalSource(source);
+    if (!ext) return bars.map(b => b.close);
+    return bars.map((_, i) => (ext as ArrayLike<number>)[i] ?? NaN);
   }
 }
 
@@ -248,7 +256,13 @@ export function getSourceSeries(
     case 'ohlc4': return open.add(high).add(low).add(close).div(4);
     case 'hlcc4': return high.add(low).add(close).add(close).div(4);
     case 'volume': return Series.fromBars(bars, 'volume');
-    default: return close;
+    default: {
+      // Another source (study on study), else close.
+      const ext = externalSource(source);
+      if (!ext) return close;
+      const values = Array.from({ length: bars.length }, (_, i) => ext[i] ?? NaN);
+      return new Series(bars, (_bar, i) => values[i] ?? NaN);
+    }
   }
 }
 

package/src/utils/source-resolver.ts

@@ -0,0 +1,29 @@
+/**
+ * Sources other than the bar fields: a study calculated on another study's output (PineScript hosts call it "study
+ * on study"). A source input then holds a host name such as `"<sourceId>$<plotIndex>"`; the host resolves it to
+ * values aligned with the bars it passes to the calculation (`NaN` where there is no value).
+ *
+ * The host sets the resolver around a calculation and clears it after; a name it does not know falls back to
+ * `close`, as before.
+ */
+
+/** Values of a source by name, aligned with the bars of the calculation; null/undefined = unknown name. */
+export type SourceResolver = (name: string) => ArrayLike<number> | null | undefined;
+
+let resolver: SourceResolver | null = null;
+
+/** Built-in sources (bar fields and their averages). */
+export const BUILTIN_SOURCES: ReadonlySet<string> = new Set([
+  'open', 'high', 'low', 'close', 'hl2', 'hlc3', 'ohlc4', 'hlcc4', 'volume',
+]);
+
+/** Set (or clear with null) how source names other than the built-ins are read. */
+export function setSourceResolver(fn: SourceResolver | null): void {
+  resolver = fn;
+}
+
+/** Values of a non built-in source name, or null when no resolver knows it. */
+export function externalSource(name: string): ArrayLike<number> | null {
+  if (!resolver || BUILTIN_SOURCES.has(name)) return null;
+  return resolver(name) ?? null;
+}