openalgo-script 0.1.0-alpha.1 → 0.2.0

package/dist/adapters/charts/markers.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Declared markers into the chart's bar anchored markers.
+ *
+ * **A marker is a discrete event with a label, not a column of prices.** Its
+ * declaration fixes where it sits, what shape it is drawn as and what colour it
+ * is, all before bar 0; only the text is read per bar, and a bar whose channel
+ * holds no string has no marker at all (`compiled-program.md` 2.8). So this
+ * walks one string channel per call site and produces an entry for each bar that
+ * wrote one, which is why a `signal()` under an `if` marks the bars the branch
+ * was taken and nothing anywhere else.
+ *
+ * **The text cannot travel in the values table**, which holds numbers, so the
+ * markers are built here, once per calculation, and left in the run record that
+ * `produced.ts` keeps for the hook to read.
+ *
+ * **Two of the chart's words are not the language's, and the translation is
+ * here.** A position is `"above"` in the language and `aboveBar` on the chart;
+ * `"price"` names no price for the language to put a marker at, so it becomes
+ * the chart's in-bar position rather than a price this module chose. A shape is
+ * the same word in both worlds for nine of the ten, and the tenth, `"label"`, is
+ * a plate whose tail points at the anchor, so the side the marker sits on is
+ * what decides which of the chart's two plates it is.
+ *
+ * A marker is anchored to a bar's time rather than to its index, because an
+ * index moves when more history loads and a time does not.
+ */
+import type { CompiledProgram } from '../../core/emit/index.js';
+import type { ChartBar } from './contract.js';
+import type { InputLookup } from './fields.js';
+import type { Columns } from './run.js';
+import type { ChartMarker } from './surfaces.js';
+/**
+ * Every marker the run produced, oldest bar first.
+ *
+ * The bars are walked once per call site rather than once in total, so the
+ * entries of one call site are contiguous; the sort afterwards is what puts the
+ * whole set in bar order, and it is stable, so two call sites that marked one
+ * bar stay in declaration order on it.
+ */
+export declare function buildMarkers(program: CompiledProgram, lookup: InputLookup, bars: readonly ChartBar[], columns: Columns, defaultColour: string): readonly ChartMarker[];
+//# sourceMappingURL=markers.d.ts.map

package/dist/adapters/charts/markers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markers.d.ts","sourceRoot":"","sources":["../../../src/adapters/charts/markers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,OAAO,KAAK,EAAE,eAAe,EAAU,MAAM,0BAA0B,CAAC;AAExE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,KAAK,EAAE,WAAW,EAAyC,MAAM,eAAe,CAAC;AA6BxF;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,eAAe,EACxB,MAAM,EAAE,WAAW,EACnB,IAAI,EAAE,SAAS,QAAQ,EAAE,EACzB,OAAO,EAAE,OAAO,EAChB,aAAa,EAAE,MAAM,GACpB,SAAS,WAAW,EAAE,CAaxB"}

package/dist/adapters/charts/markers.js

@@ -0,0 +1,75 @@
+import { cssColour } from './colours.js';
+import { colourField, stringField } from './fields.js';
+/** The language's three positions, in the chart's own words. */
+const POSITIONS = {
+    above: 'aboveBar',
+    below: 'belowBar',
+    price: 'inBar',
+};
+/** The nine shapes both worlds spell the same way. */
+const SHAPES = [
+    'arrowUp',
+    'arrowDown',
+    'triangleUp',
+    'triangleDown',
+    'circle',
+    'square',
+    'diamond',
+    'cross',
+    'flag',
+];
+/** Which plate a `"label"` is: the tail points at the bar from where it sits. */
+const PLATES = {
+    aboveBar: 'labelDown',
+    belowBar: 'labelUp',
+    inBar: 'text',
+};
+/**
+ * Every marker the run produced, oldest bar first.
+ *
+ * The bars are walked once per call site rather than once in total, so the
+ * entries of one call site are contiguous; the sort afterwards is what puts the
+ * whole set in bar order, and it is stable, so two call sites that marked one
+ * bar stay in declaration order on it.
+ */
+export function buildMarkers(program, lookup, bars, columns, defaultColour) {
+    const out = [];
+    for (const declared of program.outputs.markers) {
+        const style = styleOf(declared, lookup, defaultColour);
+        const column = columns[declared.channel] ?? [];
+        for (let index = 0; index < bars.length; index += 1) {
+            const text = column[index];
+            const bar = bars[index];
+            if (typeof text !== 'string' || bar === undefined)
+                continue;
+            out.push({ index, marker: { ...style, time: bar.time, text } });
+        }
+    }
+    return out.sort((a, b) => a.index - b.index).map((one) => one.marker);
+}
+/** The part of a marker that is declared once and is the same on every bar. */
+function styleOf(declared, lookup, defaultColour) {
+    const colour = colourField(declared.color, lookup);
+    const written = stringField(declared.position, lookup, 'above');
+    // A declaration a host cannot draw takes the default rather than stopping the
+    // study: the compiler refuses an unknown one with OS3008, so a value arriving
+    // here that is not in the set came from a hand edited program.
+    const position = POSITIONS[written] ?? 'aboveBar';
+    return {
+        position,
+        shape: shapeOf(stringField(declared.shape, lookup, 'label'), position),
+        // The language has no marker size and the chart needs one, so every marker
+        // is drawn at the size the chart's own studies use.
+        size: 'small',
+        // `signal`'s colour defaults to absence, which `stdlib.md` 14.3 reads as the
+        // host's own default for a marker. The chart has no default of its own to
+        // fall back to, so a host that has one states it.
+        color: colour === undefined ? defaultColour : cssColour(colour),
+    };
+}
+function shapeOf(written, position) {
+    if (SHAPES.includes(written))
+        return written;
+    return PLATES[position];
+}
+//# sourceMappingURL=markers.js.map

package/dist/adapters/charts/markers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markers.js","sourceRoot":"","sources":["../../../src/adapters/charts/markers.ts"],"names":[],"mappings":"AA2BA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAKvD,gEAAgE;AAChE,MAAM,SAAS,GAAkD;IAC/D,KAAK,EAAE,UAAU;IACjB,KAAK,EAAE,UAAU;IACjB,KAAK,EAAE,OAAO;CACf,CAAC;AAEF,sDAAsD;AACtD,MAAM,MAAM,GAAsB;IAChC,SAAS;IACT,WAAW;IACX,YAAY;IACZ,cAAc;IACd,QAAQ;IACR,QAAQ;IACR,SAAS;IACT,OAAO;IACP,MAAM;CACP,CAAC;AAEF,iFAAiF;AACjF,MAAM,MAAM,GAA4D;IACtE,QAAQ,EAAE,WAAW;IACrB,QAAQ,EAAE,SAAS;IACnB,KAAK,EAAE,MAAM;CACd,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAC1B,OAAwB,EACxB,MAAmB,EACnB,IAAyB,EACzB,OAAgB,EAChB,aAAqB;IAErB,MAAM,GAAG,GAA+D,EAAE,CAAC;IAC3E,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QAC/C,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;QACvD,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAC/C,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;YACpD,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;YAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;YACxB,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,GAAG,KAAK,SAAS;gBAAE,SAAS;YAC5D,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QAClE,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AACxE,CAAC;AAED,+EAA+E;AAC/E,SAAS,OAAO,CACd,QAAgB,EAChB,MAAmB,EACnB,aAAqB;IAErB,MAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACnD,MAAM,OAAO,GAAG,WAAW,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAChE,8EAA8E;IAC9E,8EAA8E;IAC9E,+DAA+D;IAC/D,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,UAAU,CAAC;IAClD,OAAO;QACL,QAAQ;QACR,KAAK,EAAE,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC;QACtE,2EAA2E;QAC3E,oDAAoD;QACpD,IAAI,EAAE,OAAO;QACb,6EAA6E;QAC7E,0EAA0E;QAC1E,kDAAkD;QAClD,KAAK,EAAE,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC;KAChE,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,OAAe,EAAE,QAA6B;IAC7D,IAAI,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC;QAAE,OAAO,OAA2B,CAAC;IACjE,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC;AAC1B,CAAC"}

package/dist/adapters/charts/paint.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Bar colouring and the pane background, and the rule for who owns the candles.
+ *
+ * Both are one colour per bar on one channel, so both ride the values table as
+ * the two number columns a colour packs into, and both are read back as a column
+ * of colours the length of the bars. A bar the script left alone has an absent
+ * channel, and absence on a drawing surface is a gap: the bar keeps its own
+ * colour and the column behind it stays unshaded, which is the `null` the chart
+ * reads for exactly that.
+ *
+ * **Bar colouring is a statement about the price bars themselves, and they are
+ * not the study's to own.** A pane may hold several studies and the instrument's
+ * candles are one object, so two studies painting them is not two drawings that
+ * overlap, it is two answers to one question. The rule is
+ * `compiled-program.md` 11's: the owner is the study latest in the chart's own
+ * study order that paints, and every other study's bar colouring is not drawn.
+ *
+ * Two things follow, and both are the point of having a rule at all. It is
+ * decided from the list of studies, which is what the legend shows and what the
+ * user reorders, rather than from the order the calculations happened to return
+ * in, so it does not change when one study is slower than another on one frame.
+ * And it changes only when the user adds, removes or reorders a study, so the
+ * candles do not flicker between two colourings while both studies keep
+ * recomputing. A chart that arbitrates between publishers itself applies that
+ * rule from its own list and this descriptor simply states what it wants;
+ * `candleOwner` is the same rule for a host whose chart does not.
+ *
+ * A background needs no such rule. It is drawn behind everything in its own
+ * pane, a colour carries its own alpha in this language, and two translucent
+ * shadings compose the way any two drawings in a pane do.
+ */
+import type { CompiledProgram } from '../../core/emit/index.js';
+import type { ColumnSpec } from './columns.js';
+import type { ChartSurfaceContext } from './surfaces.js';
+/** A column of colours, one per bar, `null` where the script painted none. */
+export type Painting = (ctx: ChartSurfaceContext) => readonly (string | null)[];
+export interface PaintBuild {
+    readonly columns: readonly ColumnSpec[];
+    readonly barColors: Painting | undefined;
+    readonly background: Painting | undefined;
+}
+export declare function buildPaint(program: CompiledProgram): PaintBuild;
+/** A study on the chart, as the ownership rule reads one. */
+export interface Painter {
+    readonly id: string;
+    /** The study's own `barColors`, or nothing where it declares none. */
+    readonly barColors?: unknown;
+}
+/**
+ * Which study's bar colouring is drawn, given the chart's own study order.
+ *
+ * The list is the host's, oldest first, which is the order a legend lists them
+ * and the order a user changes deliberately. The answer is the last study in it
+ * that paints: a study added on top of another is the one whose colouring the
+ * user just asked to see, and adding a study that paints nothing changes
+ * nothing.
+ *
+ * Nothing is returned when no study paints, which is the ordinary case.
+ */
+export declare function candleOwner(studies: readonly Painter[]): string | undefined;
+//# sourceMappingURL=paint.d.ts.map

package/dist/adapters/charts/paint.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paint.d.ts","sourceRoot":"","sources":["../../../src/adapters/charts/paint.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,OAAO,KAAK,EAAE,eAAe,EAAS,MAAM,0BAA0B,CAAC;AAEvE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAMzD,8EAA8E;AAC9E,MAAM,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,mBAAmB,KAAK,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC;AAEhF,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,OAAO,EAAE,SAAS,UAAU,EAAE,CAAC;IACxC,QAAQ,CAAC,SAAS,EAAE,QAAQ,GAAG,SAAS,CAAC;IACzC,QAAQ,CAAC,UAAU,EAAE,QAAQ,GAAG,SAAS,CAAC;CAC3C;AAED,wBAAgB,UAAU,CAAC,OAAO,EAAE,eAAe,GAAG,UAAU,CAQ/D;AAmBD,6DAA6D;AAC7D,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,sEAAsE;IACtE,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,SAAS,OAAO,EAAE,GAAG,MAAM,GAAG,SAAS,CAM3E"}

package/dist/adapters/charts/paint.js

@@ -0,0 +1,47 @@
+import { colourAt, colourColumns } from './columns.js';
+/** The key each paint channel's two colour columns travel under. */
+const BAR_COLOR = 'openscript:barColor';
+const BACKGROUND = 'openscript:background';
+export function buildPaint(program) {
+    const bar = oneOf(program.outputs.barColor, BAR_COLOR);
+    const pane = oneOf(program.outputs.background, BACKGROUND);
+    return {
+        columns: [...bar.columns, ...pane.columns],
+        barColors: bar.read,
+        background: pane.read,
+    };
+}
+function oneOf(paint, key) {
+    if (paint === null)
+        return { columns: [], read: undefined };
+    return {
+        columns: colourColumns(key, paint.channel),
+        read: (ctx) => {
+            const out = new Array(ctx.bars.length);
+            for (let index = 0; index < out.length; index += 1) {
+                out[index] = colourAt(ctx.values, index, key) ?? null;
+            }
+            return out;
+        },
+    };
+}
+/**
+ * Which study's bar colouring is drawn, given the chart's own study order.
+ *
+ * The list is the host's, oldest first, which is the order a legend lists them
+ * and the order a user changes deliberately. The answer is the last study in it
+ * that paints: a study added on top of another is the one whose colouring the
+ * user just asked to see, and adding a study that paints nothing changes
+ * nothing.
+ *
+ * Nothing is returned when no study paints, which is the ordinary case.
+ */
+export function candleOwner(studies) {
+    for (let index = studies.length - 1; index >= 0; index -= 1) {
+        const study = studies[index];
+        if (study !== undefined && study.barColors !== undefined)
+            return study.id;
+    }
+    return undefined;
+}
+//# sourceMappingURL=paint.js.map

package/dist/adapters/charts/paint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paint.js","sourceRoot":"","sources":["../../../src/adapters/charts/paint.ts"],"names":[],"mappings":"AAgCA,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAIvD,oEAAoE;AACpE,MAAM,SAAS,GAAG,qBAAqB,CAAC;AACxC,MAAM,UAAU,GAAG,uBAAuB,CAAC;AAW3C,MAAM,UAAU,UAAU,CAAC,OAAwB;IACjD,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACvD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAC3D,OAAO;QACL,OAAO,EAAE,CAAC,GAAG,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAC1C,SAAS,EAAE,GAAG,CAAC,IAAI;QACnB,UAAU,EAAE,IAAI,CAAC,IAAI;KACtB,CAAC;AACJ,CAAC;AAED,SAAS,KAAK,CACZ,KAAmB,EACnB,GAAW;IAEX,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IAC5D,OAAO;QACL,OAAO,EAAE,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC;QAC1C,IAAI,EAAE,CAAC,GAAwB,EAA8B,EAAE;YAC7D,MAAM,GAAG,GAAG,IAAI,KAAK,CAAgB,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACtD,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,GAAG,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;gBACnD,GAAG,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC;YACxD,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;KACF,CAAC;AACJ,CAAC;AASD;;;;;;;;;;GAUG;AACH,MAAM,UAAU,WAAW,CAAC,OAA2B;IACrD,KAAK,IAAI,KAAK,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QAC5D,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QAC7B,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS;YAAE,OAAO,KAAK,CAAC,EAAE,CAAC;IAC5E,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/dist/adapters/charts/plots.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Declared plots into the chart's plots.
+ *
+ * This is the part of the mapping that is a rename and a table. A plot names a
+ * style, a width, a dash pattern, a scale, an offset and a colour, and every one
+ * of those is a field the chart's plot spec already has. Three places are not a
+ * rename and are worth knowing:
+ *
+ * **A colour a script wrote as an `input()` becomes the settings key rather than
+ * a value.** The chart generates an appearance row per plot, and a descriptor
+ * that already declares a colour input owns that key, so pointing the plot at
+ * the script's own key makes one row drive both the drawn line and the value the
+ * engine computes with. A generated row beside it would shadow the script's, and
+ * changing the script's would silently stop working.
+ *
+ * **A colour a script computed per bar is not a value at all.** It arrives on a
+ * channel, travels as two number columns and is read back by the per-bar colour
+ * callback, which is the only shape a chart's values table has room for.
+ *
+ * **Scale formatting belongs to a scale and not to a series.** A study's own
+ * `precision` and `format` are its pane's, so they reach only the plots that
+ * stay in that pane: setting them on a plot drawn over the price pane would
+ * reformat the instrument's own axis, which is what OS8007 warns a script about
+ * at compile time.
+ */
+import type { CompiledProgram } from '../../core/emit/index.js';
+import type { ColumnSpec } from './columns.js';
+import type { ChartPlot } from './contract.js';
+import type { InputLookup } from './fields.js';
+export interface PlotsBuild {
+    readonly plots: readonly ChartPlot[];
+    readonly columns: readonly ColumnSpec[];
+}
+/**
+ * `ownPane` is whether the study draws in a pane of its own, which is what
+ * decides whether the study's own scale formatting reaches a plot at all.
+ */
+export declare function buildPlots(program: CompiledProgram, lookup: InputLookup, ownPane: boolean): PlotsBuild;
+//# sourceMappingURL=plots.d.ts.map

package/dist/adapters/charts/plots.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plots.d.ts","sourceRoot":"","sources":["../../../src/adapters/charts/plots.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,OAAO,KAAK,EAAE,eAAe,EAAQ,MAAM,0BAA0B,CAAC;AAItE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAGV,SAAS,EAKV,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AA6B/C,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,SAAS,SAAS,EAAE,CAAC;IACrC,QAAQ,CAAC,OAAO,EAAE,SAAS,UAAU,EAAE,CAAC;CACzC;AAED;;;GAGG;AACH,wBAAgB,UAAU,CACxB,OAAO,EAAE,eAAe,EACxB,MAAM,EAAE,WAAW,EACnB,OAAO,EAAE,OAAO,GACf,UAAU,CASZ"}

package/dist/adapters/charts/plots.js

@@ -0,0 +1,117 @@
+import { buildCandle } from './candles.js';
+import { cssColour } from './colours.js';
+import { colourAt, colourColumns } from './columns.js';
+import { boolField, colourField, isReference, numberField, stringField } from './fields.js';
+/**
+ * The seven styles a plot declaration may carry, in the chart's spelling.
+ *
+ * A name that is not one of them is drawn as a line. Load-time verification
+ * enumerates a channel's type and not a plot's, so a program can reach here
+ * carrying a style no engine has, and there is no catalogue code for a declared
+ * plot style a host cannot draw. A line is the least wrong thing to draw and
+ * inventing a code to refuse it is not this adapter's to do.
+ */
+const SERIES_TYPES = {
+    line: 'line',
+    lineWithMarkers: 'line-markers',
+    step: 'step',
+    area: 'area',
+    histogram: 'histogram',
+    column: 'column',
+    candle: 'candlestick',
+};
+const SCALES = {
+    right: 'right',
+    left: 'left',
+    none: '',
+};
+const LINE_STYLES = ['solid', 'dashed', 'dotted'];
+/**
+ * `ownPane` is whether the study draws in a pane of its own, which is what
+ * decides whether the study's own scale formatting reaches a plot at all.
+ */
+export function buildPlots(program, lookup, ownPane) {
+    const plots = [];
+    const columns = [];
+    for (const declared of program.outputs.plots) {
+        const built = onePlot(program, declared, lookup, ownPane);
+        plots.push(built.plot);
+        columns.push(...built.columns);
+    }
+    return { plots, columns };
+}
+function onePlot(program, declared, lookup, ownPane) {
+    const key = declared.key;
+    const title = stringField(declared.title, lookup, key);
+    const overlay = boolField(declared.overlay, lookup);
+    const inOwnPane = ownPane && overlay !== true;
+    const offset = numberField(declared.offset, lookup, 0);
+    const columns = [{ key, channel: declared.channel, part: 'value' }];
+    const candle = declared.ohlc === null ? undefined : buildCandle(key, declared.ohlc, lookup);
+    if (candle !== undefined)
+        columns.push(...candle.columns);
+    if (declared.colorChannel !== null)
+        columns.push(...colourColumns(key, declared.colorChannel));
+    // A constant colour is nothing when the script named none, which leaves the
+    // colour to the host's palette, and nothing when a channel carries it per bar,
+    // because a constant beside a per-bar colour is a colour the plot never draws.
+    const constant = candle === undefined && declared.colorChannel === null
+        ? colourField(declared.color, lookup)
+        : undefined;
+    const style = {
+        title,
+        lineWidth: numberField(declared.width, lookup, 1.5),
+        lineStyle: lineStyleOf(stringField(declared.lineStyle, lookup, 'solid')),
+        ...(candle?.style ?? {}),
+        ...(constant === undefined ? {} : { color: cssColour(constant) }),
+    };
+    const format = priceFormatOf(program, declared, lookup, inOwnPane);
+    const plot = {
+        key,
+        type: SERIES_TYPES[declared.type] ?? 'line',
+        title,
+        style,
+        priceScaleId: SCALES[stringField(declared.scale, lookup, 'right')] ?? 'right',
+        ...(format === undefined ? {} : { priceFormat: format }),
+        ...(overlay === undefined ? {} : { overlay }),
+        ...(offset === 0 ? {} : { offset }),
+        ...(isReference(declared.color) ? { colorKey: declared.color.input } : {}),
+        ...(candle === undefined ? {} : { ohlc: candle.ohlc }),
+        ...(candle?.colorParts === undefined ? {} : { colorParts: candle.colorParts }),
+        ...(declared.colorChannel === null
+            ? {}
+            : {
+                colorBy: (ctx) => colourAt(ctx.values, ctx.index, key),
+            }),
+    };
+    return { plot, columns };
+}
+function lineStyleOf(value) {
+    return LINE_STYLES.includes(value) ? value : 'solid';
+}
+/**
+ * The value formatting of the scale this plot maps to.
+ *
+ * The plot's own `format` and `precision` win. The study's own are applied only
+ * where the plot stays in the study's pane, so an overlaid column leaves the
+ * instrument's axis exactly as the chart already formats it.
+ */
+function priceFormatOf(program, declared, lookup, inOwnPane) {
+    const format = declared.priceFormat !== null
+        ? stringField(declared.priceFormat, lookup, 'price')
+        : inOwnPane
+            ? stringField(program.meta.format, lookup, 'price')
+            : undefined;
+    if (format === undefined)
+        return undefined;
+    if (format === 'volume')
+        return { type: 'volume' };
+    const precision = declared.precision !== null
+        ? numberField(declared.precision, lookup, 4)
+        : inOwnPane
+            ? numberField(program.meta.precision, lookup, 4)
+            : undefined;
+    const type = format === 'percent' ? 'percent' : 'price';
+    return precision === undefined ? { type } : { type, precision };
+}
+//# sourceMappingURL=plots.js.map

package/dist/adapters/charts/plots.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plots.js","sourceRoot":"","sources":["../../../src/adapters/charts/plots.ts"],"names":[],"mappings":"AA0BA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAWvD,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAG5F;;;;;;;;GAQG;AACH,MAAM,YAAY,GAA8C;IAC9D,IAAI,EAAE,MAAM;IACZ,eAAe,EAAE,cAAc;IAC/B,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,aAAa;CACtB,CAAC;AAEF,MAAM,MAAM,GAAgD;IAC1D,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,EAAE;CACT,CAAC;AAEF,MAAM,WAAW,GAAsB,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAOrE;;;GAGG;AACH,MAAM,UAAU,UAAU,CACxB,OAAwB,EACxB,MAAmB,EACnB,OAAgB;IAEhB,MAAM,KAAK,GAAgB,EAAE,CAAC;IAC9B,MAAM,OAAO,GAAiB,EAAE,CAAC;IACjC,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QAC7C,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAC1D,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvB,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;AAC5B,CAAC;AAED,SAAS,OAAO,CACd,OAAwB,EACxB,QAAc,EACd,MAAmB,EACnB,OAAgB;IAEhB,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;IACzB,MAAM,KAAK,GAAG,WAAW,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;IACvD,MAAM,OAAO,GAAG,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACpD,MAAM,SAAS,GAAG,OAAO,IAAI,OAAO,KAAK,IAAI,CAAC;IAC9C,MAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAEvD,MAAM,OAAO,GAAiB,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IAClF,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5F,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAC1D,IAAI,QAAQ,CAAC,YAAY,KAAK,IAAI;QAAE,OAAO,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC;IAE/F,4EAA4E;IAC5E,+EAA+E;IAC/E,+EAA+E;IAC/E,MAAM,QAAQ,GACZ,MAAM,KAAK,SAAS,IAAI,QAAQ,CAAC,YAAY,KAAK,IAAI;QACpD,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QACrC,CAAC,CAAC,SAAS,CAAC;IAEhB,MAAM,KAAK,GAAqB;QAC9B,KAAK;QACL,SAAS,EAAE,WAAW,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC;QACnD,SAAS,EAAE,WAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QACxE,GAAG,CAAC,MAAM,EAAE,KAAK,IAAI,EAAE,CAAC;QACxB,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;KAClE,CAAC;IAEF,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IACnE,MAAM,IAAI,GAAc;QACtB,GAAG;QACH,IAAI,EAAE,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,MAAM;QAC3C,KAAK;QACL,KAAK;QACL,YAAY,EAAE,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,OAAO;QAC7E,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC;QACxD,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC;QAC7C,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;QACnC,GAAG,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1E,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC;QACtD,GAAG,CAAC,MAAM,EAAE,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC;QAC9E,GAAG,CAAC,QAAQ,CAAC,YAAY,KAAK,IAAI;YAChC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC;gBACE,OAAO,EAAE,CAAC,GAAsB,EAAsB,EAAE,CACtD,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC;aACvC,CAAC;KACP,CAAC;IACF,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AAC3B,CAAC;AAED,SAAS,WAAW,CAAC,KAAa;IAChC,OAAO,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAE,KAAwB,CAAC,CAAC,CAAC,OAAO,CAAC;AAC3E,CAAC;AAED;;;;;;GAMG;AACH,SAAS,aAAa,CACpB,OAAwB,EACxB,QAAc,EACd,MAAmB,EACnB,SAAkB;IAElB,MAAM,MAAM,GACV,QAAQ,CAAC,WAAW,KAAK,IAAI;QAC3B,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC;QACpD,CAAC,CAAC,SAAS;YACT,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC;YACnD,CAAC,CAAC,SAAS,CAAC;IAClB,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC3C,IAAI,MAAM,KAAK,QAAQ;QAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAEnD,MAAM,SAAS,GACb,QAAQ,CAAC,SAAS,KAAK,IAAI;QACzB,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC;QAC5C,CAAC,CAAC,SAAS;YACT,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC;YAChD,CAAC,CAAC,SAAS,CAAC;IAElB,MAAM,IAAI,GAAG,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC;IACxD,OAAO,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;AAClE,CAAC"}

package/dist/adapters/charts/produced.d.ts

@@ -0,0 +1,57 @@
+/**
+ * What one calculation produced that no column of numbers can carry.
+ *
+ * A chart's calculation returns a table of numbers, and five of the things a
+ * study emits are not numbers: a marker's text, a cell's text, a drawing's
+ * caption, a drawing's geometry and an alert's message. The chart reads each of
+ * those from its own hook, and **those hooks are handed the run rather than the
+ * study**: the bars, the table the calculation just returned, and the settings
+ * it was run with. There is no per-instance store among them, so there is
+ * nowhere for the calculation to leave the answer and nowhere for the hook to
+ * pick it up.
+ *
+ * This is that place, and it is deliberately the only one. An alert's message
+ * was thought to have no way across for exactly the reason above, and was
+ * dropped for the life of this adapter: the entry carried the declared title
+ * and every notification a user received was the same sentence, whatever the
+ * script had computed from the bar that fired. The alert's own context carries
+ * the settings, so it reaches this record like every other hook.
+ *
+ * **The settings object is the instance.** A chart resolves one settings object
+ * per study instance and hands the same object to the calculation and to every
+ * hook that follows it, so its identity is what tells three moving averages of
+ * one script apart. A map keyed on it therefore holds one record per instance,
+ * and holds it only while the chart still holds the settings: the map is weak,
+ * so an instance the chart has dropped takes its record with it and nothing
+ * here has to be told about removal.
+ *
+ * **A hook that finds no record draws nothing.** That is the honest answer to a
+ * hook called before any calculation has run, and it is a gap rather than
+ * somebody else's markers, which is what a single latched record would give on
+ * a chart holding two studies.
+ */
+import type { Value } from '../../core/engine/index.js';
+import type { ChartSettings } from './contract.js';
+import type { ChartDrawing, ChartGrid, ChartMarker } from './surfaces.js';
+/**
+ * One declared alert's message channel, whole, as the run left it.
+ *
+ * It is the engine's own column and not a copy of it. A message is a string per
+ * bar and the alert that carries it fires on a handful of bars out of a hundred
+ * thousand, so building a second column here would cost the length of the
+ * history to answer a question about one bar.
+ */
+export type MessageColumn = readonly Value[];
+/** One run's non-numeric output, as the hooks that follow it read it. */
+export interface Produced {
+    readonly markers: readonly ChartMarker[];
+    readonly table: ChartGrid | null;
+    readonly drawings: readonly ChartDrawing[];
+    /** One entry per declared alert, in the order `outputs.alerts` declares them. */
+    readonly messages: readonly MessageColumn[];
+}
+/** What the calculation just produced, against the settings it was run with. */
+export declare function remember(settings: ChartSettings, produced: Produced): void;
+/** What the last calculation for this instance produced, or nothing. */
+export declare function producedFor(settings: ChartSettings): Produced;
+//# sourceMappingURL=produced.d.ts.map

package/dist/adapters/charts/produced.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"produced.d.ts","sourceRoot":"","sources":["../../../src/adapters/charts/produced.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE1E;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,KAAK,EAAE,CAAC;AAE7C,yEAAyE;AACzE,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,OAAO,EAAE,SAAS,WAAW,EAAE,CAAC;IACzC,QAAQ,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;IACjC,QAAQ,CAAC,QAAQ,EAAE,SAAS,YAAY,EAAE,CAAC;IAC3C,iFAAiF;IACjF,QAAQ,CAAC,QAAQ,EAAE,SAAS,aAAa,EAAE,CAAC;CAC7C;AAMD,gFAAgF;AAChF,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,aAAa,EAAE,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAE1E;AAED,wEAAwE;AACxE,wBAAgB,WAAW,CAAC,QAAQ,EAAE,aAAa,GAAG,QAAQ,CAE7D"}

package/dist/adapters/charts/produced.js

@@ -0,0 +1,11 @@
+const NOTHING = { markers: [], table: null, drawings: [], messages: [] };
+const runs = new WeakMap();
+/** What the calculation just produced, against the settings it was run with. */
+export function remember(settings, produced) {
+    runs.set(settings, produced);
+}
+/** What the last calculation for this instance produced, or nothing. */
+export function producedFor(settings) {
+    return runs.get(settings) ?? NOTHING;
+}
+//# sourceMappingURL=produced.js.map

package/dist/adapters/charts/produced.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"produced.js","sourceRoot":"","sources":["../../../src/adapters/charts/produced.ts"],"names":[],"mappings":"AAuDA,MAAM,OAAO,GAAa,EAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;AAEnF,MAAM,IAAI,GAAG,IAAI,OAAO,EAA2B,CAAC;AAEpD,gFAAgF;AAChF,MAAM,UAAU,QAAQ,CAAC,QAAuB,EAAE,QAAkB;IAClE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAC/B,CAAC;AAED,wEAAwE;AACxE,MAAM,UAAU,WAAW,CAAC,QAAuB;IACjD,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,OAAO,CAAC;AACvC,CAAC"}

package/dist/adapters/charts/requests.d.ts

@@ -0,0 +1,114 @@
+/**
+ * Another instrument's bars: the one thing a study needs that the chart's own
+ * bars cannot answer.
+ *
+ * Everything else this adapter maps is computed from bars the chart already
+ * holds, this included where the read is of the chart's own instrument: the
+ * engine folds those itself and this is never asked. A read of **another**
+ * instrument is different, and the difference is the whole of this file.
+ *
+ * **The engine asks once and synchronously; the chart answers later.** A
+ * request's identity is fixed before bar 0 (`compiled-program.md` 2.16), so the
+ * engine settles the whole set at load and asks the host for each one there and
+ * then. A chart's transport is a promise. So the two are joined by a station
+ * that lives in the study instance's own store: the engine's question is
+ * answered from what the station holds now, which on the first pass is nothing,
+ * and the answer for a read nobody has fetched yet is `pending`. The read is
+ * absent, `req.isReady` is false, the rest of the study keeps drawing, and that
+ * is exactly what `stdlib.md` 15.5 describes.
+ *
+ * **The lifecycle is what has a transport, and it runs after the first
+ * calculation.** A chart computes a study once before it attaches its
+ * lifecycle, so a station that waited for a transport before answering would
+ * refuse the study at load rather than draw it while the bars arrive. Instead
+ * the first calculation records what it was asked for, the lifecycle brings the
+ * transport and fetches it, and the recompute it then asks for is the one that
+ * has the bars. A study is drawn twice and never refused for a fetch that had
+ * not happened yet.
+ *
+ * **A range is a floor, never a promise.** What the host is asked for is the
+ * chart's own span, extended back by the read's `warmup` in requested bars and
+ * forward to the end of the bucket the newest chart bar is inside, and then
+ * quantised to bucket boundaries. Quantising is what stops a fetch per bar: the
+ * range a chart asks for is then the same range for every bar inside one
+ * requested bar, and it widens once when a bucket closes. A host that serves
+ * less gets a read that is absent for longer, never a wrong number.
+ *
+ * **What was fetched keeps serving while the next fetch is in flight.** The
+ * alternative is a line that breaks every time a bucket closes, which looks like
+ * a defect in the study rather than a refresh in the transport. The first fetch
+ * has nothing to serve and is the only one that reads as pending.
+ *
+ * **A failure is the host's own words.** A transport that rejects is OS6009
+ * carrying the message it rejected with, which is the one the chart writes when
+ * a host registered no provider at all: `req.error(read)` then says so in the
+ * script, the data status says so to the user, and the study keeps drawing
+ * everything that does not depend on the read.
+ */
+import type { RequestProvider } from '../../core/engine/index.js';
+import type { ChartBar, ChartStore } from './contract.js';
+import type { ChartAttachContext } from './surfaces.js';
+export declare class Station {
+    private readonly entries;
+    /** What the last calculation asked about, keyed the same way. */
+    private readonly wanted;
+    private transport;
+    private closed;
+    private unsubscribe;
+    /**
+     * The provider the engine is loaded with, bound to the bars on screen.
+     *
+     * Asking for one is the start of a round: the engine is about to ask about
+     * every read this program makes, so what was wanted before this moment is
+     * what the previous program wanted. A setting that names a different
+     * instrument would otherwise leave the old one being fetched for as long as
+     * the study lives, and reported on.
+     */
+    provider(bars: readonly ChartBar[]): RequestProvider;
+    /**
+     * The range each read needs, against the bars as they now stand.
+     *
+     * A calculation that reused the held engine never asked the provider
+     * anything, so nothing would notice that the newest chart bar has moved into
+     * the next requested bucket. This is what notices: it widens what is wanted,
+     * and the fetch that follows asks for the recompute that reads it. An answer
+     * is never spliced into a run that is already past the bars it would have
+     * changed, which is `host-interface.md` 5.3.
+     */
+    extend(bars: readonly ChartBar[]): void;
+    /**
+     * After a calculation: start what is missing and say where the study stands.
+     *
+     * It is the end of the calculation rather than the middle of it because a
+     * fetch that resolves asks for a recompute, and asking for one from inside the
+     * calculation it would replace is a loop waiting to be written.
+     */
+    settle(): void;
+    /** The lifecycle, with the transport the first calculation did not have. */
+    open(ctx: ChartAttachContext): void;
+    /**
+     * The lifecycle is over: nothing in flight may write anything again.
+     *
+     * What was fetched is kept. A chart runs the lifecycle again after a settings
+     * change, and throwing the bars away there would put a network round trip
+     * behind moving a slider. A fetch that was in flight is marked as not in
+     * flight, so a station that is opened again starts it rather than waiting for
+     * an answer whose callback has been told to do nothing.
+     */
+    close(): void;
+    /** Every read the host refused, tried again from the beginning. */
+    private again;
+    private pump;
+    private fetch;
+    /** An answer, once the transport has one. */
+    private landed;
+    private refused;
+    private failed;
+    /** Where the study's own data stands, in the four words the chart has. */
+    private status;
+}
+/** The station this instance holds, created by whichever half arrives first. */
+export declare function stationIn(store: ChartStore): Station;
+/** The station this instance holds, when it has one. */
+export declare function stationOf(store: ChartStore): Station | undefined;
+//# sourceMappingURL=requests.d.ts.map

package/dist/adapters/charts/requests.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../src/adapters/charts/requests.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,OAAO,KAAK,EAGV,eAAe,EAEhB,MAAM,4BAA4B,CAAC;AAGpC,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC1D,OAAO,KAAK,EAAE,kBAAkB,EAAmB,MAAM,eAAe,CAAC;AAsCzE,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA4B;IACpD,iEAAiE;IACjE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA2B;IAClD,OAAO,CAAC,SAAS,CAAwB;IACzC,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,WAAW,CAA2B;IAE9C;;;;;;;;OAQG;IACH,QAAQ,CAAC,IAAI,EAAE,SAAS,QAAQ,EAAE,GAAG,eAAe;IAepD;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,SAAS,QAAQ,EAAE,GAAG,IAAI;IAYvC;;;;;;OAMG;IACH,MAAM,IAAI,IAAI;IAQd,4EAA4E;IAC5E,IAAI,CAAC,GAAG,EAAE,kBAAkB,GAAG,IAAI;IAyBnC;;;;;;;;OAQG;IACH,KAAK,IAAI,IAAI;IAQb,mEAAmE;IACnE,OAAO,CAAC,KAAK;IAQb,OAAO,CAAC,IAAI;IAYZ,OAAO,CAAC,KAAK;IAoBb,6CAA6C;IAC7C,OAAO,CAAC,MAAM;IAQd,OAAO,CAAC,OAAO;IAOf,OAAO,CAAC,MAAM;IAOd,0EAA0E;IAC1E,OAAO,CAAC,MAAM;CAaf;AAED,gFAAgF;AAChF,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAMpD;AAED,wDAAwD;AACxD,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,GAAG,SAAS,CAGhE"}