openalgo-script 0.1.0-alpha.1 → 0.4.0

package/dist/adapters/charts/run.js

@@ -0,0 +1,148 @@
+import { load, utcTime } from '../../core/engine/index.js';
+import { hostBar, hostNow, stateFor } from './bars.js';
+import { refused, stopped } from './errors.js';
+import { stationIn, stationOf } from './requests.js';
+import { engineSettings, signatureOf } from './settings.js';
+/** The store key. Namespaced, because the store belongs to the host as well. */
+const HELD = 'openscript';
+export function fullRun(program, bars, settings, store, ctx, options) {
+    const station = stationIn(store);
+    const engine = start(program, settings, ctx, options, station.provider(bars));
+    const result = engine.run(bars.map(hostBar), bars.map((_, index) => stateFor(index, bars, ctx)));
+    if (result.diagnostic !== undefined)
+        throw stopped(result.diagnostic);
+    const held = {
+        engine,
+        signature: signatureOf(program, settings),
+        count: bars.length,
+        firstTime: bars[0]?.time ?? 0,
+        lastTime: bars[bars.length - 1]?.time ?? 0,
+    };
+    store[HELD] = held;
+    station.settle();
+    return outputOf(program, engine);
+}
+/**
+ * The bars from `from` onwards, or nothing when the held engine cannot serve
+ * them.
+ *
+ * `from` is the previously last bar, which may have been replaced rather than
+ * followed, so it is re-executed rather than appended: that is step 1 of the bar
+ * cycle and the reason a moving bar draws the same study however many ticks it
+ * took.
+ */
+export function tailRun(program, bars, from, settings, store, ctx, 
+// Held for the shape of the pair: a full recompute reads the host's options
+// and a tail run reads the engine it already built from them.
+_options) {
+    const held = store[HELD];
+    if (held === undefined || held.engine.failed)
+        return null;
+    if (held.count !== from + 1 || from < 0 || bars.length < held.count)
+        return null;
+    if (held.signature !== signatureOf(program, settings))
+        return null;
+    if ((bars[0]?.time ?? 0) !== held.firstTime)
+        return null;
+    if ((bars[from]?.time ?? 0) !== held.lastTime)
+        return null;
+    for (let index = from; index < bars.length; index += 1) {
+        const bar = bars[index];
+        if (bar === undefined)
+            return null;
+        const state = stateFor(index, bars, ctx);
+        const result = index === from
+            ? held.engine.update(hostBar(bar), state)
+            : held.engine.append(hostBar(bar), state);
+        if (result.diagnostic !== undefined)
+            throw stopped(result.diagnostic);
+    }
+    held.count = bars.length;
+    held.lastTime = bars[bars.length - 1]?.time ?? held.lastTime;
+    // The provider was not asked anything this time, so the station is told where
+    // the newest bar now stands rather than working it out from a question.
+    const station = stationOf(store);
+    station?.extend(bars);
+    station?.settle();
+    return outputOf(program, held.engine);
+}
+/**
+ * A held engine is dropped when the descriptor's instance goes away.
+ *
+ * The station goes with it, because a fetch still in flight would otherwise ask
+ * a chart that has removed this study to recompute it.
+ */
+export function release(store) {
+    delete store[HELD];
+    stationOf(store)?.close();
+}
+function outputOf(program, engine) {
+    const columns = [];
+    for (let channel = 0; channel < program.channels.length; channel += 1) {
+        columns.push(engine.column(channel));
+    }
+    // The grids and the objects are read once, here. Reading either per bar would
+    // cost the length of the history to display the last state of it, which is
+    // `tables.ts`'s own first paragraph.
+    return { columns, tables: engine.tables(), drawings: engine.drawings() };
+}
+function start(program, settings, ctx, options, requests) {
+    const loaded = load(program, {
+        settings: engineSettings(program, settings),
+        host: hostFor(ctx, options, requests),
+        time: timeFor(options, ctx?.timezone ?? ''),
+        ...(options.limits === undefined ? {} : { limits: options.limits }),
+        ...(options.source === undefined ? {} : { source: options.source }),
+        ...(options.clock === undefined ? {} : { clock: options.clock }),
+    });
+    if (!loaded.ok)
+        throw refused(loaded.diagnostic);
+    return loaded.engine;
+}
+/**
+ * The host the engine reads, which always serves requests.
+ *
+ * A chart offers the transport whether or not its own host registered a
+ * provider, and it refuses with its own words when none was registered. So the
+ * capability is declared here rather than withheld: a study that reads another
+ * instrument then draws everything that does not depend on the read and puts
+ * the chart's own sentence in `req.error`, instead of being refused at load
+ * with OS6006 naming a capability the chart does have.
+ */
+function hostFor(ctx, options, requests) {
+    const instrument = {
+        ...(options.instrument ?? {}),
+        ...(ctx?.symbol === undefined ? {} : { symbol: ctx.symbol }),
+        ...(ctx?.interval === undefined ? {} : { interval: ctx.interval }),
+        ...(ctx?.tickSize === undefined ? {} : { tickSize: ctx.tickSize }),
+        // The chart states the zone it labels its own axis in, and every calendar
+        // and session call reads in it. Leaving it out left the engine reading the
+        // record's zone or nothing, so a session study could be an offset away from
+        // the chart it was drawn on.
+        ...(ctx === undefined || ctx.timezone === '' ? {} : { timezone: ctx.timezone }),
+    };
+    return {
+        instrument,
+        requestBars: requests,
+        ...(ctx === undefined ? {} : { now: hostNow(ctx.now()) }),
+        ...(options.orders === undefined ? {} : { route: options.orders }),
+    };
+}
+function timeFor(options, timezone) {
+    const resolve = options.resolveTime;
+    if (resolve === undefined)
+        return utcTime;
+    return (text) => {
+        try {
+            const seconds = resolve(text, timezone);
+            return Number.isFinite(seconds) ? hostNow(seconds) : null;
+        }
+        catch {
+            // A host's conversion refuses an unreadable string by throwing. That is a
+            // value the input's own validation has to refuse, not a failure of the
+            // chart, so it becomes absence and OS6019 names the key and the value.
+            return null;
+        }
+    };
+}
+//# sourceMappingURL=run.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"run.js","sourceRoot":"","sources":["../../../src/adapters/charts/run.ts"],"names":[],"mappings":"AAmCA,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAG3D,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAEvD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAkG5D,gFAAgF;AAChF,MAAM,IAAI,GAAG,YAAY,CAAC;AAoB1B,MAAM,UAAU,OAAO,CACrB,OAAwB,EACxB,IAAyB,EACzB,QAAuB,EACvB,KAAiB,EACjB,GAAiC,EACjC,OAA4B;IAE5B,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9E,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CACvB,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EACjB,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,CACnD,CAAC;IACF,IAAI,MAAM,CAAC,UAAU,KAAK,SAAS;QAAE,MAAM,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAEtE,MAAM,IAAI,GAAS;QACjB,MAAM;QACN,SAAS,EAAE,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC;QACzC,KAAK,EAAE,IAAI,CAAC,MAAM;QAClB,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,CAAC;QAC7B,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,IAAI,IAAI,CAAC;KAC3C,CAAC;IACF,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IACnB,OAAO,CAAC,MAAM,EAAE,CAAC;IACjB,OAAO,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,OAAO,CACrB,OAAwB,EACxB,IAAyB,EACzB,IAAY,EACZ,QAAuB,EACvB,KAAiB,EACjB,GAAiC;AACjC,4EAA4E;AAC5E,8DAA8D;AAC9D,QAA6B;IAE7B,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAqB,CAAC;IAC7C,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC;IAC1D,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC;IACjF,IAAI,IAAI,CAAC,SAAS,KAAK,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC;QAAE,OAAO,IAAI,CAAC;IACnE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,SAAS;QAAE,OAAO,IAAI,CAAC;IACzD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,QAAQ;QAAE,OAAO,IAAI,CAAC;IAE3D,KAAK,IAAI,KAAK,GAAG,IAAI,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACvD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,IAAI,GAAG,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC;QACnC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QACzC,MAAM,MAAM,GACV,KAAK,KAAK,IAAI;YACZ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC;YACzC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;QAC9C,IAAI,MAAM,CAAC,UAAU,KAAK,SAAS;YAAE,MAAM,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACxE,CAAC;IAED,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC;IACzB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC;IAC7D,8EAA8E;IAC9E,wEAAwE;IACxE,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;IACjC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IACtB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;AACxC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,KAAiB;IACvC,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC;IACnB,SAAS,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC;AAC5B,CAAC;AAED,SAAS,QAAQ,CAAC,OAAwB,EAAE,MAAc;IACxD,MAAM,OAAO,GAAyB,EAAE,CAAC;IACzC,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,IAAI,CAAC,EAAE,CAAC;QACtE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IACvC,CAAC;IACD,8EAA8E;IAC9E,2EAA2E;IAC3E,qCAAqC;IACrC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;AAC3E,CAAC;AAED,SAAS,KAAK,CACZ,OAAwB,EACxB,QAAuB,EACvB,GAAiC,EACjC,OAA4B,EAC5B,QAAyB;IAEzB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE;QAC3B,QAAQ,EAAE,cAAc,CAAC,OAAO,EAAE,QAAQ,CAAC;QAC3C,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC;QACrC,IAAI,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,IAAI,EAAE,CAAC;QAC3C,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;QACnE,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;QACnE,GAAG,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;KACjE,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,EAAE;QAAE,MAAM,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACjD,OAAO,MAAM,CAAC,MAAM,CAAC;AACvB,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,OAAO,CACd,GAAiC,EACjC,OAA4B,EAC5B,QAAyB;IAEzB,MAAM,UAAU,GAAe;QAC7B,GAAG,CAAC,OAAO,CAAC,UAAU,IAAI,EAAE,CAAC;QAC7B,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC;QAC5D,GAAG,CAAC,GAAG,EAAE,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC;QAClE,GAAG,CAAC,GAAG,EAAE,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC;QAClE,0EAA0E;QAC1E,2EAA2E;QAC3E,4EAA4E;QAC5E,6BAA6B;QAC7B,GAAG,CAAC,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,QAAQ,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC;KAChF,CAAC;IACF,OAAO;QACL,UAAU;QACV,WAAW,EAAE,QAAQ;QACrB,GAAG,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC;QACzD,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;KACnE,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,OAA4B,EAAE,QAAgB;IAC7D,MAAM,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IACpC,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO,OAAO,CAAC;IAC1C,OAAO,CAAC,IAAY,EAAiB,EAAE;QACrC,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YACxC,OAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5D,CAAC;QAAC,MAAM,CAAC;YACP,0EAA0E;YAC1E,uEAAuE;YACvE,uEAAuE;YACvE,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,78 @@
+/**
+ * The declared inputs, in both directions.
+ *
+ * Out: one settings row per `input()` call, which is the whole of the generated
+ * settings dialog. The program already carries the label, the group, the help
+ * text, the bounds and the choices, because a settings dialog and a legend have
+ * to exist before the first bar runs, so nothing here decides anything. It
+ * translates a `kind` into the control a chart renders.
+ *
+ * Back in: what a dialog stored, turned into the values the engine validates.
+ * Two kinds need work and the rest pass through untouched. A colour arrives as a
+ * CSS string and has to become four numbers. A choice arrives as a string even
+ * when the script wrote numbers, because a select control has string values, so
+ * the stored string is matched against the declared options and the option's own
+ * value is what the engine is given.
+ *
+ * **A value the host stored and this module cannot convert is passed through
+ * rather than replaced.** The engine refuses it with OS6019, naming the key and
+ * the rule it broke. Substituting the default here would be a settings dialog
+ * that silently ignores what a user typed, which is the failure `2.6` is written
+ * to prevent, and it would hide it one layer further down than the engine does.
+ *
+ * **And a stored value the engine will refuse is not a value this adapter has.**
+ * The declared shape is built before anything runs, so a settings map holding a
+ * precision of 99 against an input declared `max = 8` put 99 into
+ * `plots[0].priceFormat`, which a host can show in a legend or on a price scale
+ * before the calculation that refuses it has been asked for. What a stored value
+ * is worth has one answer and it is the engine's own: `checkSetting` is the
+ * function the load refuses with, asked here before the load exists. A value it
+ * will not take reads as the **declared default** in the declared shape, and
+ * travels to the engine exactly as the host stored it, so the run still stops
+ * with OS6019 naming the key and the bound.
+ *
+ * Neither half of that is a fallback. The value is not repaired, because the
+ * same map still refuses; and the shape is not withheld, because the settings
+ * dialog a reader corrects the value in is built from the descriptor, and a
+ * study that refuses to describe itself is one whose bad setting cannot be
+ * reached. What a host is handed meanwhile is the shape the script declared,
+ * which is the shape the study has until a settings map the engine takes
+ * arrives.
+ */
+import type { CompiledInput, CompiledProgram } from '../../core/emit/index.js';
+import type { Value } from '../../core/engine/index.js';
+import type { ChartInput, ChartSettings } from './contract.js';
+import type { InputLookup } from './fields.js';
+/** One settings row per declared input, in source order. */
+export declare function inputRows(program: CompiledProgram): readonly ChartInput[];
+/**
+ * What the engine is handed as the host's settings.
+ *
+ * Only the declared keys travel. A chart's settings object also carries the
+ * generated per-plot appearance keys and the chart's timezone, and an engine
+ * given those would have nothing to do with them; leaving them out keeps the
+ * two vocabularies from having to agree on anything but the input keys.
+ */
+export declare function engineSettings(program: CompiledProgram, settings: ChartSettings): Record<string, unknown>;
+/** The value each declared input currently holds, for a declaration field. */
+export declare function lookupFor(program: CompiledProgram, settings: ChartSettings): InputLookup;
+/**
+ * A comparable spelling of every declared input's value.
+ *
+ * The incremental path is only valid while the engine it holds was loaded from
+ * the same settings, and comparing the two spellings is cheaper and safer than
+ * trusting a chart to have told us that a settings change happened.
+ *
+ * **It spells what the engine is handed, not what the declared shape shows.**
+ * Those part company the moment a stored value is one the engine refuses: every
+ * refused value shows the same declared default, so a signature taken from the
+ * shape would read a change from a setting that runs to one that cannot as no
+ * change at all, keep the held engine and go on drawing the old numbers instead
+ * of reporting OS6019. The kind is spelled beside the value for the same
+ * reason: a stored `7` and a stored `"7"` are one quotation mark apart, and one
+ * of them is refused.
+ */
+export declare function signatureOf(program: CompiledProgram, settings: ChartSettings): string;
+/** The declared default, as the value model holds it. */
+export declare function defaultValue(declared: CompiledInput): Value;
+//# sourceMappingURL=settings.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../../src/adapters/charts/settings.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAY,MAAM,0BAA0B,CAAC;AAEzF,OAAO,KAAK,EAAe,KAAK,EAAE,MAAM,4BAA4B,CAAC;AAErE,OAAO,KAAK,EAAE,UAAU,EAAE,aAAa,EAAe,MAAM,eAAe,CAAC;AAC5E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAc/C,4DAA4D;AAC5D,wBAAgB,SAAS,CAAC,OAAO,EAAE,eAAe,GAAG,SAAS,UAAU,EAAE,CAIzE;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,OAAO,EAAE,eAAe,EACxB,QAAQ,EAAE,aAAa,GACtB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAOzB;AAED,8EAA8E;AAC9E,wBAAgB,SAAS,CAAC,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,aAAa,GAAG,WAAW,CAMxF;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,aAAa,GAAG,MAAM,CAMrF;AAED,yDAAyD;AACzD,wBAAgB,YAAY,CAAC,QAAQ,EAAE,aAAa,GAAG,KAAK,CAE3D"}

package/dist/adapters/charts/settings.js

@@ -0,0 +1,225 @@
+import { checkSetting, constantValue } from '../../core/engine/index.js';
+import { cssColour, isColourValue, parseColour } from './colours.js';
+/** The eight series a `"source"` input may select, in the order 2.6 lists them. */
+const SOURCES = [
+    'open',
+    'high',
+    'low',
+    'close',
+    'hl2',
+    'hlc3',
+    'ohlc4',
+    'volume',
+];
+/** One settings row per declared input, in source order. */
+export function inputRows(program) {
+    const rows = [];
+    for (const declared of program.inputs)
+        rows.push(rowFor(declared));
+    return rows;
+}
+/**
+ * What the engine is handed as the host's settings.
+ *
+ * Only the declared keys travel. A chart's settings object also carries the
+ * generated per-plot appearance keys and the chart's timezone, and an engine
+ * given those would have nothing to do with them; leaving them out keeps the
+ * two vocabularies from having to agree on anything but the input keys.
+ */
+export function engineSettings(program, settings) {
+    const out = {};
+    for (const declared of program.inputs) {
+        const supplied = storedValue(declared, settings);
+        if (supplied !== undefined)
+            out[declared.key] = supplied;
+    }
+    return out;
+}
+/** The value each declared input currently holds, for a declaration field. */
+export function lookupFor(program, settings) {
+    return (key) => {
+        const declared = program.inputs.find((one) => one.key === key);
+        if (declared === undefined)
+            return null;
+        return effectiveValue(declared, settings);
+    };
+}
+/**
+ * A comparable spelling of every declared input's value.
+ *
+ * The incremental path is only valid while the engine it holds was loaded from
+ * the same settings, and comparing the two spellings is cheaper and safer than
+ * trusting a chart to have told us that a settings change happened.
+ *
+ * **It spells what the engine is handed, not what the declared shape shows.**
+ * Those part company the moment a stored value is one the engine refuses: every
+ * refused value shows the same declared default, so a signature taken from the
+ * shape would read a change from a setting that runs to one that cannot as no
+ * change at all, keep the held engine and go on drawing the old numbers instead
+ * of reporting OS6019. The kind is spelled beside the value for the same
+ * reason: a stored `7` and a stored `"7"` are one quotation mark apart, and one
+ * of them is refused.
+ */
+export function signatureOf(program, settings) {
+    const parts = [];
+    for (const declared of program.inputs) {
+        parts.push(`${declared.key}=${spellStored(storedValue(declared, settings))}`);
+    }
+    return parts.join('\u0000');
+}
+/** The declared default, as the value model holds it. */
+export function defaultValue(declared) {
+    return constantValue(declared.default);
+}
+function rowFor(declared) {
+    const held = defaultValue(declared);
+    const label = declared.label;
+    const key = declared.key;
+    const extra = {
+        ...(declared.group === '' ? {} : { group: declared.group }),
+        ...(declared.tooltip === null ? {} : { tooltip: declared.tooltip }),
+    };
+    // A choice is a choice whatever the type of its members. The compiled kind is
+    // `"select"` only where the values are strings, so a script that constrained a
+    // length to two numbers arrives as a number carrying options, and a spinner
+    // would offer every value between them: the engine validates a number against
+    // its bounds and not against its options, so nothing downstream would refuse
+    // the third value a user typed. The declared choices are the control.
+    const options = declared.options ?? [];
+    if (options.length > 0) {
+        return {
+            key,
+            type: 'select',
+            label,
+            default: spell(held),
+            options: options.map((one) => {
+                const text = spell(constantValue(one));
+                return { label: text, value: text };
+            }),
+            ...extra,
+        };
+    }
+    switch (declared.kind) {
+        case 'number':
+            return {
+                key,
+                type: 'number',
+                label,
+                default: typeof held === 'number' ? held : 0,
+                ...(declared.min === null ? {} : { min: declared.min }),
+                ...(declared.max === null ? {} : { max: declared.max }),
+                ...(declared.step === null ? {} : { step: declared.step }),
+                ...extra,
+            };
+        case 'bool':
+            return { key, type: 'boolean', label, default: held === true, ...extra };
+        case 'color':
+            return {
+                key,
+                type: 'color',
+                label,
+                default: isColourValue(held) ? cssColour(held) : 'rgba(0, 0, 0, 1)',
+                ...extra,
+            };
+        case 'source':
+            return {
+                key,
+                type: 'source',
+                label,
+                default: typeof held === 'string' && SOURCES.includes(held) ? held : 'close',
+                ...extra,
+            };
+        case 'interval':
+            return { key, type: 'interval', label, default: typeof held === 'string' ? held : '', ...extra };
+        case 'time':
+            return { key, type: 'time', label, default: typeof held === 'string' ? held : '', ...extra };
+        default:
+            return { key, type: 'text', label, default: typeof held === 'string' ? held : '', ...extra };
+    }
+}
+/** What the host stored for this input, converted, or nothing when it stored none. */
+function storedValue(declared, settings) {
+    if (!Object.prototype.hasOwnProperty.call(settings, declared.key))
+        return undefined;
+    const supplied = settings[declared.key];
+    if (supplied === undefined)
+        return undefined;
+    if (declared.kind === 'color' && typeof supplied === 'string') {
+        // A swatch has no alpha channel, so a stored colour that states none keeps
+        // the alpha the script declared. See `colours.ts`.
+        const held = defaultValue(declared);
+        const parsed = parseColour(supplied, isColourValue(held) ? held.a : 1);
+        return parsed ?? supplied;
+    }
+    if (declared.options !== null && typeof supplied === 'string') {
+        // The control's values are strings even where the declared choices are not,
+        // so a stored choice is matched on its own spelling and the engine is given
+        // the option the script wrote rather than the text of it.
+        const chosen = optionFor(declared.options, supplied);
+        return chosen === undefined ? supplied : chosen;
+    }
+    return supplied;
+}
+/**
+ * The effective value: the host's where the engine will run with it.
+ *
+ * The question is `checkSetting`'s, so there is no second list of types and
+ * bounds here to disagree with the first. This file decides only what to do
+ * with the answer, and the module's own paragraph says why a refused value
+ * reads as the declared default rather than as itself.
+ *
+ * One answer is narrowed and it is narrowed on purpose: a `"time"` input's
+ * stored string is read by the host's own conversion, which `run.ts` has and
+ * this has not, so a string is taken here and the load decides it.
+ */
+function effectiveValue(declared, settings) {
+    const stored = storedValue(declared, settings);
+    if (stored === undefined)
+        return defaultValue(declared);
+    const checked = checkSetting(declared, stored);
+    return checked.ok ? checked.value : defaultValue(declared);
+}
+/** The declared option a stored string names, matched on its own spelling. */
+function optionFor(options, supplied) {
+    for (const option of options) {
+        const value = constantValue(option);
+        if (spell(value) === supplied)
+            return value;
+    }
+    return undefined;
+}
+/**
+ * A stored value as the signature spells it, kind and all.
+ *
+ * Two stored values that spell one string are a settings change the incremental
+ * path does not notice, and a dialog stores numbers and text that look alike
+ * written out while the engine takes one and refuses the other. Every value of
+ * another kind spells the same word, which costs nothing: none of them can be
+ * behind a held engine, because the load that would have held one refused it.
+ */
+function spellStored(value) {
+    if (value === undefined)
+        return 'unset';
+    if (value === null)
+        return 'none';
+    if (isColourValue(value))
+        return `color ${cssColour(value)}`;
+    if (typeof value === 'number')
+        return `number ${String(value)}`;
+    if (typeof value === 'boolean')
+        return `bool ${String(value)}`;
+    if (typeof value === 'string')
+        return `text ${value}`;
+    return 'of another kind';
+}
+/** A value as a settings control spells it. */
+function spell(value) {
+    if (value === null)
+        return '';
+    if (isColourValue(value))
+        return cssColour(value);
+    if (typeof value === 'object')
+        return '';
+    return String(value);
+}
+//# sourceMappingURL=settings.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../../../src/adapters/charts/settings.ts"],"names":[],"mappings":"AA0CA,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAEzE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAIrE,mFAAmF;AACnF,MAAM,OAAO,GAAsB;IACjC,MAAM;IACN,MAAM;IACN,KAAK;IACL,OAAO;IACP,KAAK;IACL,MAAM;IACN,OAAO;IACP,QAAQ;CACT,CAAC;AAEF,4DAA4D;AAC5D,MAAM,UAAU,SAAS,CAAC,OAAwB;IAChD,MAAM,IAAI,GAAiB,EAAE,CAAC;IAC9B,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,MAAM;QAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IACnE,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAC5B,OAAwB,EACxB,QAAuB;IAEvB,MAAM,GAAG,GAA4B,EAAE,CAAC;IACxC,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACtC,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACjD,IAAI,QAAQ,KAAK,SAAS;YAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;IAC3D,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,SAAS,CAAC,OAAwB,EAAE,QAAuB;IACzE,OAAO,CAAC,GAAW,EAAS,EAAE;QAC5B,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;QAC/D,IAAI,QAAQ,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC;QACxC,OAAO,cAAc,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,WAAW,CAAC,OAAwB,EAAE,QAAuB;IAC3E,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACtC,KAAK,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,GAAG,IAAI,WAAW,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IAChF,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAC9B,CAAC;AAED,yDAAyD;AACzD,MAAM,UAAU,YAAY,CAAC,QAAuB;IAClD,OAAO,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AACzC,CAAC;AAED,SAAS,MAAM,CAAC,QAAuB;IACrC,MAAM,IAAI,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;IACpC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;IAC7B,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;IACzB,MAAM,KAAK,GAAG;QACZ,GAAG,CAAC,QAAQ,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC;QAC3D,GAAG,CAAC,QAAQ,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;KACpE,CAAC;IAEF,8EAA8E;IAC9E,+EAA+E;IAC/E,4EAA4E;IAC5E,8EAA8E;IAC9E,6EAA6E;IAC7E,sEAAsE;IACtE,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,IAAI,EAAE,CAAC;IACvC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,OAAO;YACL,GAAG;YACH,IAAI,EAAE,QAAQ;YACd,KAAK;YACL,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC;YACpB,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC3B,MAAM,IAAI,GAAG,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;gBACvC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;YACtC,CAAC,CAAC;YACF,GAAG,KAAK;SACT,CAAC;IACJ,CAAC;IAED,QAAQ,QAAQ,CAAC,IAAI,EAAE,CAAC;QACtB,KAAK,QAAQ;YACX,OAAO;gBACL,GAAG;gBACH,IAAI,EAAE,QAAQ;gBACd,KAAK;gBACL,OAAO,EAAE,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBAC5C,GAAG,CAAC,QAAQ,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE,CAAC;gBACvD,GAAG,CAAC,QAAQ,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE,CAAC;gBACvD,GAAG,CAAC,QAAQ,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAC1D,GAAG,KAAK;aACT,CAAC;QACJ,KAAK,MAAM;YACT,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,KAAK,IAAI,EAAE,GAAG,KAAK,EAAE,CAAC;QAC3E,KAAK,OAAO;YACV,OAAO;gBACL,GAAG;gBACH,IAAI,EAAE,OAAO;gBACb,KAAK;gBACL,OAAO,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,kBAAkB;gBACnE,GAAG,KAAK;aACT,CAAC;QACJ,KAAK,QAAQ;YACX,OAAO;gBACL,GAAG;gBACH,IAAI,EAAE,QAAQ;gBACd,KAAK;gBACL,OAAO,EAAE,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAE,IAAoB,CAAC,CAAC,CAAC,OAAO;gBAC7F,GAAG,KAAK;aACT,CAAC;QACJ,KAAK,UAAU;YACb,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,GAAG,KAAK,EAAE,CAAC;QACnG,KAAK,MAAM;YACT,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,GAAG,KAAK,EAAE,CAAC;QAC/F;YACE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,GAAG,KAAK,EAAE,CAAC;IACjG,CAAC;AACH,CAAC;AAED,sFAAsF;AACtF,SAAS,WAAW,CAAC,QAAuB,EAAE,QAAuB;IACnE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IACpF,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACxC,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAE7C,IAAI,QAAQ,CAAC,IAAI,KAAK,OAAO,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC9D,2EAA2E;QAC3E,mDAAmD;QACnD,MAAM,IAAI,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;QACpC,MAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACvE,OAAO,MAAM,IAAI,QAAQ,CAAC;IAC5B,CAAC;IAED,IAAI,QAAQ,CAAC,OAAO,KAAK,IAAI,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC9D,4EAA4E;QAC5E,4EAA4E;QAC5E,0DAA0D;QAC1D,MAAM,MAAM,GAAG,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACrD,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAClD,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,cAAc,CAAC,QAAuB,EAAE,QAAuB;IACtE,MAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAC/C,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC/C,OAAO,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;AAC7D,CAAC;AAED,8EAA8E;AAC9E,SAAS,SAAS,CAAC,OAA4B,EAAE,QAAgB;IAC/D,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,MAAM,KAAK,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;QACpC,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;IAC9C,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,WAAW,CAAC,KAAc;IACjC,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,OAAO,CAAC;IACxC,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,MAAM,CAAC;IAClC,IAAI,aAAa,CAAC,KAAc,CAAC;QAAE,OAAO,SAAS,SAAS,CAAC,KAAoB,CAAC,EAAE,CAAC;IACrF,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,UAAU,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;IAChE,IAAI,OAAO,KAAK,KAAK,SAAS;QAAE,OAAO,QAAQ,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;IAC/D,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,QAAQ,KAAK,EAAE,CAAC;IACtD,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AAED,+CAA+C;AAC/C,SAAS,KAAK,CAAC,KAAY;IACzB,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,EAAE,CAAC;IAC9B,IAAI,aAAa,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC;IAClD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,EAAE,CAAC;IACzC,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC"}