openalgo-script 0.1.0-alpha.1 → 0.4.0

package/dist/core/engine/request-plan.js

@@ -0,0 +1,228 @@
+/**
+ * What is settled about a read before bar 0, `compiled-program.md` 2.16.
+ *
+ * **A request's identity is fixed before bar 0.** That is what lets the whole
+ * set be known at load, what lets a host fetch in parallel and cache by
+ * instrument and timeframe, and what makes a request that changed afterwards
+ * OS6013. So the three identity fields are resolved here, once, from the value
+ * the script wrote, the setting it named or the chart fact it named, and
+ * nothing below bar 0 ever asks again.
+ *
+ * **Two refusals belong at load and four belong to the host.** A timeframe the
+ * language does not know (OS6001), one finer than the chart's (OS6002) and one
+ * that does not fold into the chart's (OS6015) are facts about the program and
+ * the chart, both known before a bar runs, so they stop the load and name what
+ * was refused. An unknown instrument (OS6007), a range with no bars (OS6008), a
+ * source that refused (OS6009) and an interval the feed does not carry (OS6014)
+ * are the host's answers: they leave the read absent, put the reason in
+ * `req.error(read)` and let the study keep drawing everything else, which is
+ * `stdlib.md` 15.5.
+ */
+import { diagnosticFor } from '../diagnostics/index.js';
+import { NO_POSITION, failure } from './errors.js';
+import { foldRefusal, isIntraday, parseTimeframe } from './timeframe.js';
+/**
+ * One of the three identity fields, resolved.
+ *
+ * Three forms and no fourth: the string the script wrote, the value of the
+ * setting it named, and one of the three chart facts that identify a chart
+ * rather than describe it.
+ */
+export function identityOf(field, inputs, host) {
+    if (typeof field === 'string')
+        return field;
+    if (field === null || typeof field !== 'object' || Array.isArray(field))
+        return null;
+    const named = field;
+    if (typeof named.input === 'string') {
+        const found = inputs.find((one) => one.key === named.input);
+        return typeof found?.value === 'string' ? found.value : null;
+    }
+    if (named.chart === 'symbol')
+        return host.instrument?.symbol ?? null;
+    if (named.chart === 'exchange')
+        return host.instrument?.exchange ?? null;
+    if (named.chart === 'interval')
+        return host.instrument?.interval ?? null;
+    return null;
+}
+/**
+ * Every read the program makes, with its identity settled.
+ *
+ * Walks the nested reads as well, because a read written inside another is part
+ * of the program and a host handed a list with one missing would fetch less
+ * than the file asks for.
+ */
+export function planRequests(requests, inputs, host) {
+    const chart = chartTimeframe(host);
+    const plans = [];
+    const problem = collect(requests, inputs, host, chart, plans);
+    if (problem !== undefined)
+        return { ok: false, diagnostic: problem };
+    return { ok: true, plans };
+}
+function collect(requests, inputs, host, chart, into) {
+    for (const request of requests) {
+        const written = identityOf(request.timeframe, inputs, host);
+        const timeframe = written === null ? undefined : parseTimeframe(written);
+        if (timeframe === undefined) {
+            return failure('OS6001', NO_POSITION, { value: written ?? 'nothing' });
+        }
+        // The chart's interval is a host fact and a host may state none. Without it
+        // there is nothing to compare a request against, so the two comparisons are
+        // skipped rather than answered from a value nobody supplied.
+        const refusal = chart === undefined ? undefined : foldRefusal(timeframe, chart);
+        if (refusal !== undefined && chart !== undefined) {
+            if (refusal.code === 'OS6002') {
+                return failure('OS6002', NO_POSITION, { chart: chart.text, requested: timeframe.text });
+            }
+            return failure('OS6015', NO_POSITION, {
+                requested: timeframe.text,
+                chart: chart.text,
+                suggestion: refusal.suggestion,
+            });
+        }
+        into.push({
+            request,
+            timeframe,
+            zone: host.instrument?.timezone ?? null,
+            query: {
+                id: request.id,
+                read: request.read,
+                instrument: instrumentOf(request, inputs, host),
+                exchange: exchangeOf(request, inputs, host),
+                timeframe: timeframe.text,
+                mode: request.mode,
+                warmup: request.warmup,
+            },
+        });
+        const nested = collect(request.body.requests, inputs, host, timeframe, into);
+        if (nested !== undefined)
+            return nested;
+    }
+    return undefined;
+}
+/**
+ * The instrument a read asks about, with the format's own default applied.
+ *
+ * 2.16 spells a read of the chart's own instrument as a `null` `symbol`, so
+ * resolving it here is applying the format's rule rather than inventing one:
+ * the host is handed the identity it gave for the chart, which is what
+ * `host-interface.md` 5.2 says a request carries.
+ *
+ * **The default belongs to a `"timeframe"` read and to nothing else.** A
+ * `"symbol"` read whose identity did not resolve, because the setting behind it
+ * holds something that is not an instrument, stays absent. Falling back there
+ * would turn a read of another instrument into a second read of this one, and
+ * the study would draw a line nobody asked for with nothing to say it had
+ * substituted anything.
+ */
+function instrumentOf(request, inputs, host) {
+    const named = identityOf(request.symbol, inputs, host);
+    if (named !== null)
+        return named;
+    return request.read === 'timeframe' ? host.instrument?.symbol ?? null : null;
+}
+/**
+ * Where a read's instrument trades, with `stdlib.md` 15.1's default applied.
+ *
+ * `req.symbol`'s signature defaults `exchange` to `chart.exchange`, and 2.16
+ * spells the omission as `null`, "means the chart's exchange". A host handed
+ * that `null` would have to apply the rule against the record it supplied, and
+ * a host that applied it differently, or not at all, would resolve an
+ * instrument on a venue the script never named. So it is applied once, here.
+ */
+function exchangeOf(request, inputs, host) {
+    return identityOf(request.exchange, inputs, host) ?? host.instrument?.exchange ?? null;
+}
+/** The chart's own interval as a timeframe, when the host stated a usable one. */
+function chartTimeframe(host) {
+    const interval = host.instrument?.interval;
+    return interval === undefined ? undefined : parseTimeframe(interval);
+}
+/**
+ * What the host says about one read.
+ *
+ * A host with no provider is not asked. A read of the chart's own instrument is
+ * then folded from the bars the engine already holds, and a read of another
+ * instrument cannot be: the engine holds none of that instrument's bars, so
+ * nothing to serve is the same answer as an instrument the host does not know.
+ */
+export function askHost(plan, host) {
+    const answer = host.requestBars?.(plan.query);
+    if (answer !== undefined)
+        return answer;
+    if (plan.query.read === 'timeframe')
+        return undefined;
+    return { refused: { code: 'OS6007' } };
+}
+/**
+ * Whether this read can date a bucket at all.
+ *
+ * A day, week or month request is folded by the calendar, and a calendar
+ * boundary is a civil date read in a zone (`timeframe.ts`). A host that stated
+ * no timezone leaves the fold with no key for any bar, so the read is absent on
+ * every bar of the run and will be on every future one: nothing that arrives
+ * later supplies a fact the instrument record does not hold.
+ *
+ * That is a dead read, and a dead read a study cannot explain is the worst of
+ * the three: the trader has already looked at the blank pane. So it is answered
+ * here rather than left as absence, and `req.isReady` and `req.error` say it.
+ */
+export function undatable(plan) {
+    return !isIntraday(plan.timeframe) && plan.zone === null;
+}
+/**
+ * What `req.error(read)` says about a read with no zone to date its buckets.
+ *
+ * OS6012's own message, because the zone is an instrument fact the host did not
+ * supply and that is exactly what this read needs and cannot default. Nothing
+ * is raised: a fact the host did not state leaves the read absent, and this is
+ * the sentence that explains the absence rather than a second answer to the
+ * question `host-interface.md` 4.5 leaves open.
+ */
+export function undatableReason(query) {
+    return diagnosticFor('OS6012', NO_POSITION, { fact: 'a timezone', symbol: named(query) }).message;
+}
+/** The instrument a reason names: the one the read asked for, or the chart's. */
+function named(query) {
+    return query.instrument ?? 'the chart\'s instrument';
+}
+/**
+ * The reason a refusal reads as through `req.error(read)`.
+ *
+ * The catalogue's own message, filled with the identity the read asked for and
+ * with the host's own words where it gave them. The host's words are carried
+ * and not paraphrased, because "the account's data subscription does not cover
+ * this instrument" is actionable and "the request failed" is not.
+ */
+export function reasonFor(refusal, query) {
+    const symbol = named(query);
+    const exchange = query.exchange ?? 'the chart\'s exchange';
+    const reason = refusal.reason ?? 'the host gave no reason';
+    switch (refusal.code) {
+        case 'OS6007':
+            return diagnosticFor('OS6007', NO_POSITION, { symbol, exchange }).message;
+        case 'OS6008':
+            return diagnosticFor('OS6008', NO_POSITION, { symbol, timeframe: query.timeframe }).message;
+        case 'OS6014':
+            return diagnosticFor('OS6014', NO_POSITION, {
+                timeframe: query.timeframe,
+                symbol,
+                available: refusal.available ?? 'nothing it named',
+            }).message;
+        case 'OS6015':
+            return diagnosticFor('OS6015', NO_POSITION, {
+                requested: query.timeframe,
+                chart: 'the chart\'s interval',
+                suggestion: refusal.available ?? 'a whole multiple of it',
+            }).message;
+        default:
+            return diagnosticFor('OS6009', NO_POSITION, {
+                symbol,
+                timeframe: query.timeframe,
+                reason,
+            }).message;
+    }
+}
+//# sourceMappingURL=request-plan.js.map

package/dist/core/engine/request-plan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-plan.js","sourceRoot":"","sources":["../../../src/core/engine/request-plan.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAInD,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAgBzE;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CACxB,KAAmB,EACnB,MAAgC,EAChC,IAAgB;IAEhB,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC5C,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAErF,MAAM,KAAK,GAAG,KAA6D,CAAC;IAC5E,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;QACpC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5D,OAAO,OAAO,KAAK,EAAE,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;IAC/D,CAAC;IACD,IAAI,KAAK,CAAC,KAAK,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC,UAAU,EAAE,MAAM,IAAI,IAAI,CAAC;IACrE,IAAI,KAAK,CAAC,KAAK,KAAK,UAAU;QAAE,OAAO,IAAI,CAAC,UAAU,EAAE,QAAQ,IAAI,IAAI,CAAC;IACzE,IAAI,KAAK,CAAC,KAAK,KAAK,UAAU;QAAE,OAAO,IAAI,CAAC,UAAU,EAAE,QAAQ,IAAI,IAAI,CAAC;IACzE,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAC1B,QAA4B,EAC5B,MAAgC,EAChC,IAAgB;IAEhB,MAAM,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,KAAK,GAAkB,EAAE,CAAC;IAChC,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAC9D,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;IACrE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AAC7B,CAAC;AAED,SAAS,OAAO,CACd,QAA4B,EAC5B,MAAgC,EAChC,IAAgB,EAChB,KAA4B,EAC5B,IAAmB;IAEnB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QAC5D,MAAM,SAAS,GAAG,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACzE,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO,OAAO,CAAC,QAAQ,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,OAAO,IAAI,SAAS,EAAE,CAAC,CAAC;QACzE,CAAC;QACD,4EAA4E;QAC5E,4EAA4E;QAC5E,6DAA6D;QAC7D,MAAM,OAAO,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAChF,IAAI,OAAO,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACjD,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC9B,OAAO,OAAO,CAAC,QAAQ,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;YAC1F,CAAC;YACD,OAAO,OAAO,CAAC,QAAQ,EAAE,WAAW,EAAE;gBACpC,SAAS,EAAE,SAAS,CAAC,IAAI;gBACzB,KAAK,EAAE,KAAK,CAAC,IAAI;gBACjB,UAAU,EAAE,OAAO,CAAC,UAAU;aAC/B,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,IAAI,CAAC;YACR,OAAO;YACP,SAAS;YACT,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,QAAQ,IAAI,IAAI;YACvC,KAAK,EAAE;gBACL,EAAE,EAAE,OAAO,CAAC,EAAE;gBACd,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,UAAU,EAAE,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC;gBAC/C,QAAQ,EAAE,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC;gBAC3C,SAAS,EAAE,SAAS,CAAC,IAAI;gBACzB,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,MAAM,EAAE,OAAO,CAAC,MAAM;aACvB;SACF,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;QAC7E,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,MAAM,CAAC;IAC1C,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAS,YAAY,CACnB,OAAgB,EAChB,MAAgC,EAChC,IAAgB;IAEhB,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACvD,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IACjC,OAAO,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;AAC/E,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,UAAU,CACjB,OAAgB,EAChB,MAAgC,EAChC,IAAgB;IAEhB,OAAO,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,UAAU,EAAE,QAAQ,IAAI,IAAI,CAAC;AACzF,CAAC;AAED,kFAAkF;AAClF,SAAS,cAAc,CAAC,IAAgB;IACtC,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC;IAC3C,OAAO,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;AACvE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,OAAO,CAAC,IAAiB,EAAE,IAAgB;IACzD,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9C,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC;IACxC,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,WAAW;QAAE,OAAO,SAAS,CAAC;IACtD,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC;AACzC,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,SAAS,CAAC,IAAiB;IACzC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC;AAC3D,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAAC,KAAmB;IACjD,OAAO,aAAa,CAAC,QAAQ,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC;AACpG,CAAC;AAED,iFAAiF;AACjF,SAAS,KAAK,CAAC,KAAmB;IAChC,OAAO,KAAK,CAAC,UAAU,IAAI,yBAAyB,CAAC;AACvD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,SAAS,CAAC,OAAuB,EAAE,KAAmB;IACpE,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IAC5B,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,uBAAuB,CAAC;IAC3D,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,yBAAyB,CAAC;IAC3D,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,QAAQ;YACX,OAAO,aAAa,CAAC,QAAQ,EAAE,WAAW,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC;QAC5E,KAAK,QAAQ;YACX,OAAO,aAAa,CAAC,QAAQ,EAAE,WAAW,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC;QAC9F,KAAK,QAAQ;YACX,OAAO,aAAa,CAAC,QAAQ,EAAE,WAAW,EAAE;gBAC1C,SAAS,EAAE,KAAK,CAAC,SAAS;gBAC1B,MAAM;gBACN,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,kBAAkB;aACnD,CAAC,CAAC,OAAO,CAAC;QACb,KAAK,QAAQ;YACX,OAAO,aAAa,CAAC,QAAQ,EAAE,WAAW,EAAE;gBAC1C,SAAS,EAAE,KAAK,CAAC,SAAS;gBAC1B,KAAK,EAAE,uBAAuB;gBAC9B,UAAU,EAAE,OAAO,CAAC,SAAS,IAAI,wBAAwB;aAC1D,CAAC,CAAC,OAAO,CAAC;QACb;YACE,OAAO,aAAa,CAAC,QAAQ,EAAE,WAAW,EAAE;gBAC1C,MAAM;gBACN,SAAS,EAAE,KAAK,CAAC,SAAS;gBAC1B,MAAM;aACP,CAAC,CAAC,OAAO,CAAC;IACf,CAAC;AACH,CAAC"}

package/dist/core/engine/requests.d.ts

@@ -0,0 +1,105 @@
+/**
+ * Higher timeframe and other instrument reads, folded onto the chart's bars.
+ *
+ * A read is an expression evaluated over a **different set of bars** than the
+ * chart's, whose value is then folded back onto the chart's. Two halves, and
+ * they are in two files: `request-body.ts` runs the expression once per
+ * requested bar, and this decides which requested bar each chart bar is allowed
+ * to see. The second half is where the off-by-one lives, so it is written as
+ * one comparison repeated three times rather than as three rules.
+ *
+ * **Bars in, buckets out.** Source bars are grouped by the bucket key of their
+ * open instant (`timeframe.ts`); a bucket becomes one requested bar. The source
+ * is the chart's own bars for a read of the chart's instrument, which is the
+ * read `host-interface.md` 5.1 says an engine can satisfy from what it already
+ * holds, and the host's answer for a read of another instrument, which it never
+ * can. One fold serves both, so the two kinds of read cannot drift apart.
+ *
+ * **The three modes differ in one thing: how far past the chart bar the fold is
+ * allowed to look.** Everything else about them is the same code.
+ *
+ * | Mode | Source bars it may consume | Value the chart bar takes |
+ * |---|---|---|
+ * | `"confirmed"` | Those opening at or before this chart bar | The last bucket that closed |
+ * | `"developing"` | Those opening at or before this chart bar | The bucket this bar is inside, so far |
+ * | `"lookahead"` | Those belonging to this bar's bucket or earlier | The bucket this bar is inside, in full |
+ *
+ * Read the middle column, because it is the repainting question written out.
+ * Confirmed and developing stop at the chart bar and can be computed live;
+ * lookahead reads past it, which is why it repaints on history permanently and
+ * by design, and why on the newest bucket, where there is nothing past the bar
+ * to read, it is the bucket so far and nothing better exists.
+ *
+ * **The boundary.** A bucket has begun on the first chart bar whose key is the
+ * new one, because a bar's open instant is what dates it. So a confirmed read
+ * steps to the closed bucket's value on the first chart bar of the next bucket,
+ * holds it across every bar inside that bucket including the last, and steps
+ * again on the first bar of the one after. The bar a bucket closes on still
+ * reads the bucket before it: at that bar's open, the bucket it is inside had
+ * not closed.
+ *
+ * **Warmup translates by arithmetic and not by a rule.** The expression runs on
+ * requested bars, so its own warmup is counted in requested bars and its absence
+ * folds onto the chart like any other value: a twenty period average of daily
+ * closes is absent until twenty daily bars exist, which on a five minute chart
+ * is about a month in. The `warmup` field of the compiled program is what a host
+ * extends the fetch range backwards by, a floor and not a promise, and an engine
+ * given less gets a read that is absent for longer rather than a wrong number.
+ */
+import type { Span } from '../span/index.js';
+import type { HostBar } from './bars.js';
+import type { Clock, EngineLimits } from './budget.js';
+import type { EngineHost } from './host.js';
+import type { ResolvedInput } from './inputs.js';
+import type { HostFacts, ManifestEntry, PositionFacts } from './library/index.js';
+import type { Registers } from './registers.js';
+import type { RequestPlan } from './request-plan.js';
+import type { CompiledProgram, Request } from './types.js';
+import type { Heap, Value } from './values/index.js';
+export interface RequestParts {
+    readonly program: CompiledProgram;
+    /** Every read in the program, nested ones included, keyed by its own id. */
+    readonly plans: ReadonlyMap<number, RequestPlan>;
+    readonly host: EngineHost;
+    readonly limits: EngineLimits;
+    readonly clock: Clock | undefined;
+    readonly library: readonly ManifestEntry[];
+    readonly inputs: readonly ResolvedInput[];
+    /** The facts a body inherits, with its own identity written over three of them. */
+    readonly facts: HostFacts;
+    /** The strategy's own position, which a body reads as the chart's bars do. */
+    readonly position: PositionFacts;
+    /**
+     * The heap of the machine these reads land in, read when a bar asks for it.
+     *
+     * A function rather than the heap, because a read written inside another lands
+     * in the enclosing body's heap and that body does not exist until its own
+     * reads have been built.
+     */
+    heapOf(): Heap;
+    spanAt(line: number, column: number): Span;
+}
+export declare class RequestSet {
+    private readonly reads;
+    private readonly byId;
+    private readonly parts;
+    constructor(parts: RequestParts, requests: readonly Request[]);
+    get empty(): boolean;
+    /**
+     * Step 4: each read's value for this bar, written into its `"request"`
+     * register.
+     *
+     * `fresh` says whether this is the first execution of this bar. A bar that is
+     * executing again restores the fold to where it stood when the bar began and
+     * rebuilds the bucket now forming from the source as it now stands, which is
+     * what makes a moving bar idempotent one level down: the newest chart bar may
+     * have been revised since the last execution, and the bucket it is inside has
+     * to be rebuilt from the revision rather than from the reading it replaced.
+     */
+    fill(registers: Registers, bars: readonly HostBar[], index: number, fresh: boolean): void;
+    /** `req.isReady(read)`: whether the host has answered this one yet. */
+    answered(id: Value): Value;
+    /** `req.error(read)`: the reason it failed, or the empty string when none has. */
+    failure(id: Value): Value;
+}
+//# sourceMappingURL=requests.d.ts.map

package/dist/core/engine/requests.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../src/core/engine/requests.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAClF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAErD,OAAO,KAAK,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAE3D,OAAO,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAErD,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAClC,4EAA4E;IAC5E,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACjD,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,CAAC;IAClC,QAAQ,CAAC,OAAO,EAAE,SAAS,aAAa,EAAE,CAAC;IAC3C,QAAQ,CAAC,MAAM,EAAE,SAAS,aAAa,EAAE,CAAC;IAC1C,mFAAmF;IACnF,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;IAC1B,8EAA8E;IAC9E,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IACjC;;;;;;OAMG;IACH,MAAM,IAAI,IAAI,CAAC;IACf,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5C;AAgCD,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAc;IACpC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAA2B;IAChD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAe;gBAEzB,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,OAAO,EAAE;IAW7D,IAAI,KAAK,IAAI,OAAO,CAEnB;IAED;;;;;;;;;;OAUG;IACH,IAAI,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI;IAczF,uEAAuE;IACvE,QAAQ,CAAC,EAAE,EAAE,KAAK,GAAG,KAAK;IAI1B,kFAAkF;IAClF,OAAO,CAAC,EAAE,EAAE,KAAK,GAAG,KAAK;CAG1B"}

package/dist/core/engine/requests.js

@@ -0,0 +1,260 @@
+import { RequestBody, bodyProgram } from './request-body.js';
+import { askHost, reasonFor, undatable, undatableReason } from './request-plan.js';
+import { bucketKeyOf } from './timeframe.js';
+import { ABSENT } from './values/index.js';
+const START = { cursor: 0, openKey: undefined, openFrom: 0 };
+export class RequestSet {
+    reads = [];
+    byId = new Map();
+    parts;
+    constructor(parts, requests) {
+        this.parts = parts;
+        for (const request of requests) {
+            const plan = parts.plans.get(request.id);
+            if (plan === undefined)
+                continue;
+            const read = build(parts, request, plan);
+            this.reads.push(read);
+            this.byId.set(request.id, read);
+        }
+    }
+    get empty() {
+        return this.reads.length === 0;
+    }
+    /**
+     * Step 4: each read's value for this bar, written into its `"request"`
+     * register.
+     *
+     * `fresh` says whether this is the first execution of this bar. A bar that is
+     * executing again restores the fold to where it stood when the bar began and
+     * rebuilds the bucket now forming from the source as it now stands, which is
+     * what makes a moving bar idempotent one level down: the newest chart bar may
+     * have been revised since the last execution, and the bucket it is inside has
+     * to be rebuilt from the revision rather than from the reading it replaced.
+     */
+    fill(registers, bars, index, fresh) {
+        const heap = this.parts.heapOf();
+        for (const read of this.reads) {
+            if (fresh) {
+                read.mark = { cursor: read.cursor, openKey: read.openKey, openFrom: read.openFrom };
+            }
+            else {
+                restore(read, bars);
+            }
+            // The body's value is the body's, in the body's heap. `carry` is what
+            // makes it a value of the machine that is about to read it.
+            registers.set(read.register, read.body.carry(valueOf(read, bars, index), heap));
+        }
+    }
+    /** `req.isReady(read)`: whether the host has answered this one yet. */
+    answered(id) {
+        return typeof id === 'number' ? this.byId.get(id)?.ready === true : false;
+    }
+    /** `req.error(read)`: the reason it failed, or the empty string when none has. */
+    failure(id) {
+        return typeof id === 'number' ? this.byId.get(id)?.reason ?? '' : '';
+    }
+}
+function build(parts, request, plan) {
+    const view = bodyProgram(parts.program, request);
+    const answer = askHost(plan, parts.host);
+    const refused = answer !== undefined && 'refused' in answer ? answer.refused : undefined;
+    let body;
+    // The facts a body reads are the chart's, except the three that identify an
+    // instrument: inside a read, those are the instrument and the interval the
+    // read asked for. The two request calls answer about the reads written inside
+    // this body, which is why the set below is built before the body is.
+    let nested;
+    const facts = {
+        ...parts.facts,
+        symbol: () => plan.query.instrument ?? parts.facts.symbol(),
+        exchange: () => plan.query.exchange ?? parts.facts.exchange(),
+        interval: () => plan.query.timeframe,
+        requestReady: (id) => nested?.answered(id) ?? false,
+        requestError: (id) => nested?.failure(id) ?? '',
+    };
+    nested = new RequestSet(
+    // A read inside this one lands in this body's heap, which is built below.
+    { ...parts, program: view, facts, heapOf: () => body.objects }, request.body.requests);
+    body = new RequestBody({
+        program: view,
+        limits: parts.limits,
+        clock: parts.clock,
+        host: facts,
+        position: parts.position,
+        library: parts.library,
+        inputs: request.body.inputs.map((one) => ({
+            series: one.series,
+            value: parts.inputs.find((input) => input.key === one.input)?.value ?? null,
+        })),
+        nested,
+        spanAt: parts.spanAt,
+    });
+    // A reason is the read saying why it will never answer. A refusal is the
+    // host's; a calendar fold with no zone to date a bucket in is the engine's,
+    // and it is stated here rather than left as an absence the study cannot
+    // explain. The host's own words win where both hold: a source that refused is
+    // the fix the user can act on first.
+    const reason = refused !== undefined
+        ? reasonFor(refused, plan.query)
+        : undatable(plan)
+            ? undatableReason(plan.query)
+            : '';
+    return {
+        plan,
+        register: request.series,
+        body,
+        source: answer !== undefined && 'bars' in answer ? answer.bars : undefined,
+        // A fold of the chart's own bars needs nothing from the host, so it is
+        // answered the moment it is planned. A read the host is still fetching is
+        // not: the read is absent, `req.isReady` is false, and the study keeps
+        // drawing everything that does not depend on it. A read with a reason is
+        // never ready: it is not waiting for anything.
+        ready: reason === '' && (answer === undefined ? plan.query.read === 'timeframe' : 'bars' in answer),
+        reason,
+        cursor: 0,
+        openKey: undefined,
+        openFrom: 0,
+        open: undefined,
+        closedValue: ABSENT,
+        highestClosed: undefined,
+        mark: START,
+    };
+}
+/** The read's value for the chart bar at `index`, and the fold that gets there. */
+function valueOf(read, bars, index) {
+    if (!read.ready)
+        return ABSENT;
+    const bar = bars[index];
+    const at = bar?.time ?? null;
+    if (at === null)
+        return ABSENT;
+    const key = keyOf(read, at);
+    if (key === undefined)
+        return ABSENT;
+    const source = read.source ?? bars;
+    const lookahead = read.plan.request.mode === 'lookahead';
+    for (;;) {
+        const next = source[read.cursor];
+        if (next === undefined)
+            break;
+        const found = next.time === null ? undefined : keyOf(read, next.time);
+        if (found === undefined) {
+            // A source bar with no time, or none this calendar can date, belongs to
+            // no bucket. It is stepped over rather than folded into whichever bucket
+            // happens to be open.
+            read.cursor += 1;
+            continue;
+        }
+        // The one line the three modes differ in. A lookahead read may read to the
+        // end of the bucket the chart bar is inside; the other two stop at the bar.
+        if (lookahead ? found > key : (next.time ?? 0) > at)
+            break;
+        read.cursor += 1;
+        feed(read, next, found);
+    }
+    if (read.plan.request.mode === 'confirmed')
+        return read.closedValue;
+    if (read.openKey !== key || read.open === undefined)
+        return ABSENT;
+    return read.body.peek(read.open);
+}
+function keyOf(read, instant) {
+    return bucketKeyOf(instant, read.plan.timeframe, read.plan.zone);
+}
+/**
+ * One source bar folded in.
+ *
+ * A bar whose key is the open bucket's extends it. A bar whose key is new
+ * closes the open bucket, which is the only place a requested bar ever settles:
+ * a bucket is closed by something later, never by the clock. The guard on
+ * `highestClosed` is what makes that idempotent, because a chart bar that
+ * closed a bucket on its first execution must not close it again on its second.
+ */
+function feed(read, bar, key) {
+    if (read.openKey === key && read.open !== undefined) {
+        read.open = extend(read.open, bar);
+        return;
+    }
+    if (read.openKey !== undefined && read.open !== undefined) {
+        if (read.highestClosed === undefined || read.openKey > read.highestClosed) {
+            read.closedValue = read.body.settle(read.open);
+            read.highestClosed = read.openKey;
+        }
+    }
+    read.openKey = key;
+    read.openFrom = read.cursor - 1;
+    read.open = start(bar);
+}
+/** A re-executed bar: the fold as it stood when the bar began. */
+function restore(read, bars) {
+    read.cursor = read.mark.cursor;
+    read.openKey = read.mark.openKey;
+    read.openFrom = read.mark.openFrom;
+    read.open = undefined;
+    if (read.openKey === undefined)
+        return;
+    const source = read.source ?? bars;
+    for (let at = read.openFrom; at < read.cursor; at += 1) {
+        const bar = source[at];
+        if (bar === undefined || bar.time === null)
+            continue;
+        if (keyOf(read, bar.time) !== read.openKey)
+            continue;
+        read.open = read.open === undefined ? start(bar) : extend(read.open, bar);
+    }
+}
+/**
+ * The first source bar of a bucket, as a bar of its own.
+ *
+ * The bucket's `time` is this bar's open instant rather than the instant the
+ * bucket's key names. The two differ whenever trading begins after the boundary,
+ * which is every session on a daily fold, and the first bar's instant is a
+ * reading from the data while the boundary is a number the engine chose.
+ */
+function start(bar) {
+    return {
+        open: bar.open,
+        high: bar.high,
+        low: bar.low,
+        close: bar.close,
+        volume: bar.volume ?? null,
+        time: bar.time,
+        oi: bar.oi ?? null,
+    };
+}
+/**
+ * One more source bar in the same bucket.
+ *
+ * **Absence propagates through every field**, which is `host-interface.md` 3.1:
+ * an absent price is a hole and what it feeds turns absent. So a bucket whose
+ * high is missing from one of its bars has no high, rather than the highest of
+ * the bars that did report one, which would be a number with no name. Open is
+ * the first bar's, close is the last bar's, and open interest is a level rather
+ * than a flow so the coarser bar takes the last and never the sum.
+ */
+function extend(into, bar) {
+    return {
+        open: into.open,
+        high: higher(into.high, bar.high),
+        low: lower(into.low, bar.low),
+        close: bar.close ?? null,
+        volume: both(into.volume ?? null, bar.volume ?? null),
+        time: into.time,
+        oi: bar.oi ?? null,
+    };
+}
+function higher(a, b) {
+    if (a === null || typeof b !== 'number')
+        return null;
+    return b > a ? b : a;
+}
+function lower(a, b) {
+    if (a === null || typeof b !== 'number')
+        return null;
+    return b < a ? b : a;
+}
+function both(a, b) {
+    return a === null || b === null ? null : a + b;
+}
+//# sourceMappingURL=requests.js.map

package/dist/core/engine/requests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requests.js","sourceRoot":"","sources":["../../../src/core/engine/requests.ts"],"names":[],"mappings":"AAuDA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEnF,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAuD3C,MAAM,KAAK,GAAS,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;AAEnE,MAAM,OAAO,UAAU;IACJ,KAAK,GAAW,EAAE,CAAC;IACnB,IAAI,GAAG,IAAI,GAAG,EAAgB,CAAC;IAC/B,KAAK,CAAe;IAErC,YAAY,KAAmB,EAAE,QAA4B;QAC3D,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YACzC,IAAI,IAAI,KAAK,SAAS;gBAAE,SAAS;YACjC,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;YACzC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CAAC,SAAoB,EAAE,IAAwB,EAAE,KAAa,EAAE,KAAc;QAChF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QACjC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAC9B,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,CAAC,IAAI,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACtF,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACtB,CAAC;YACD,sEAAsE;YACtE,4DAA4D;YAC5D,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;QAClF,CAAC;IACH,CAAC;IAED,uEAAuE;IACvE,QAAQ,CAAC,EAAS;QAChB,OAAO,OAAO,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;IAC5E,CAAC;IAED,kFAAkF;IAClF,OAAO,CAAC,EAAS;QACf,OAAO,OAAO,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACvE,CAAC;CACF;AAED,SAAS,KAAK,CAAC,KAAmB,EAAE,OAAgB,EAAE,IAAiB;IACrE,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACjD,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,OAAO,GAAG,MAAM,KAAK,SAAS,IAAI,SAAS,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IACzF,IAAI,IAA6B,CAAC;IAElC,4EAA4E;IAC5E,2EAA2E;IAC3E,8EAA8E;IAC9E,qEAAqE;IACrE,IAAI,MAA8B,CAAC;IACnC,MAAM,KAAK,GAAc;QACvB,GAAG,KAAK,CAAC,KAAK;QACd,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE;QAC3D,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE;QAC7D,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS;QACpC,YAAY,EAAE,CAAC,EAAS,EAAE,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC,IAAI,KAAK;QAC1D,YAAY,EAAE,CAAC,EAAS,EAAE,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE;KACvD,CAAC;IACF,MAAM,GAAG,IAAI,UAAU;IACrB,0EAA0E;IAC1E,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,CAAE,IAAoB,CAAC,OAAO,EAAE,EAC/E,OAAO,CAAC,IAAI,CAAC,QAAQ,CACtB,CAAC;IAEF,IAAI,GAAG,IAAI,WAAW,CAAC;QACrB,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,IAAI,EAAE,KAAK;QACX,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YACxC,MAAM,EAAE,GAAG,CAAC,MAAM;YAClB,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,KAAK,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,IAAI;SAC5E,CAAC,CAAC;QACH,MAAM;QACN,MAAM,EAAE,KAAK,CAAC,MAAM;KACrB,CAAC,CAAC;IAEH,yEAAyE;IACzE,4EAA4E;IAC5E,wEAAwE;IACxE,8EAA8E;IAC9E,qCAAqC;IACrC,MAAM,MAAM,GACV,OAAO,KAAK,SAAS;QACnB,CAAC,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC;QAChC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC;YAC7B,CAAC,CAAC,EAAE,CAAC;IAEX,OAAO;QACL,IAAI;QACJ,QAAQ,EAAE,OAAO,CAAC,MAAM;QACxB,IAAI;QACJ,MAAM,EAAE,MAAM,KAAK,SAAS,IAAI,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;QAC1E,uEAAuE;QACvE,0EAA0E;QAC1E,uEAAuE;QACvE,yEAAyE;QACzE,+CAA+C;QAC/C,KAAK,EACH,MAAM,KAAK,EAAE,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,MAAM,IAAI,MAAM,CAAC;QAC9F,MAAM;QACN,MAAM,EAAE,CAAC;QACT,OAAO,EAAE,SAAS;QAClB,QAAQ,EAAE,CAAC;QACX,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,MAAM;QACnB,aAAa,EAAE,SAAS;QACxB,IAAI,EAAE,KAAK;KACZ,CAAC;AACJ,CAAC;AAED,mFAAmF;AACnF,SAAS,OAAO,CAAC,IAAU,EAAE,IAAwB,EAAE,KAAa;IAClE,IAAI,CAAC,IAAI,CAAC,KAAK;QAAE,OAAO,MAAM,CAAC;IAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;IACxB,MAAM,EAAE,GAAG,GAAG,EAAE,IAAI,IAAI,IAAI,CAAC;IAC7B,IAAI,EAAE,KAAK,IAAI;QAAE,OAAO,MAAM,CAAC;IAC/B,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC5B,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC;IAErC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC;IACnC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC;IACzD,SAAS,CAAC;QACR,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,IAAI,KAAK,SAAS;YAAE,MAAM;QAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACtE,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,wEAAwE;YACxE,yEAAyE;YACzE,sBAAsB;YACtB,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;YACjB,SAAS;QACX,CAAC;QACD,2EAA2E;QAC3E,4EAA4E;QAC5E,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,EAAE;YAAE,MAAM;QAC3D,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;QACjB,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,WAAW;QAAE,OAAO,IAAI,CAAC,WAAW,CAAC;IACpE,IAAI,IAAI,CAAC,OAAO,KAAK,GAAG,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC;IACnE,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC;AAED,SAAS,KAAK,CAAC,IAAU,EAAE,OAAe;IACxC,OAAO,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACnE,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,IAAI,CAAC,IAAU,EAAE,GAAY,EAAE,GAAW;IACjD,IAAI,IAAI,CAAC,OAAO,KAAK,GAAG,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QACpD,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QACnC,OAAO;IACT,CAAC;IACD,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC1D,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;YAC1E,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/C,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC;QACpC,CAAC;IACH,CAAC;IACD,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;IACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAChC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC;AAED,kEAAkE;AAClE,SAAS,OAAO,CAAC,IAAU,EAAE,IAAwB;IACnD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IAC/B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;IACjC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;IACnC,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;IACtB,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS;QAAE,OAAO;IACvC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC;IACnC,KAAK,IAAI,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,IAAI,CAAC,EAAE,CAAC;QACvD,MAAM,GAAG,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;QACvB,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,KAAK,IAAI;YAAE,SAAS;QACrD,IAAI,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,OAAO;YAAE,SAAS;QACrD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC5E,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,KAAK,CAAC,GAAY;IACzB,OAAO;QACL,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,GAAG,EAAE,GAAG,CAAC,GAAG;QACZ,KAAK,EAAE,GAAG,CAAC,KAAK;QAChB,MAAM,EAAE,GAAG,CAAC,MAAM,IAAI,IAAI;QAC1B,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,EAAE,EAAE,GAAG,CAAC,EAAE,IAAI,IAAI;KACnB,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,MAAM,CAAC,IAAa,EAAE,GAAY;IACzC,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC;QACjC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC;QAC7B,KAAK,EAAE,GAAG,CAAC,KAAK,IAAI,IAAI;QACxB,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE,GAAG,CAAC,MAAM,IAAI,IAAI,CAAC;QACrD,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,EAAE,EAAE,GAAG,CAAC,EAAE,IAAI,IAAI;KACnB,CAAC;AACJ,CAAC;AAED,SAAS,MAAM,CAAC,CAAgB,EAAE,CAA4B;IAC5D,IAAI,CAAC,KAAK,IAAI,IAAI,OAAO,CAAC,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IACrD,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACvB,CAAC;AAED,SAAS,KAAK,CAAC,CAAgB,EAAE,CAA4B;IAC3D,IAAI,CAAC,KAAK,IAAI,IAAI,OAAO,CAAC,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IACrD,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACvB,CAAC;AAED,SAAS,IAAI,CAAC,CAAgB,EAAE,CAAgB;IAC9C,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AACjD,CAAC"}

package/dist/core/engine/results.d.ts

@@ -0,0 +1,40 @@
+/**
+ * What a host reads back from a bar and from a run.
+ *
+ * Declared apart from the loop that fills it, because these are the shapes an
+ * adapter, a test and a second engine's harness all read, and a shape somebody
+ * outside this repository depends on is worth being able to read on its own.
+ *
+ * Four of the six fields are about one bar's execution and two are about what
+ * that execution sent and was told: the effects it applied, each carrying the
+ * intents it became, and what the frames that arrived before it did to the
+ * ledger. A run that places no orders carries both empty for every bar.
+ */
+import type { Diagnostic } from '../diagnostics/index.js';
+import type { AlertFiring } from './alerts.js';
+import type { RoutedEffect } from './host.js';
+import type { FrameOutcome } from './ledger/index.js';
+import type { Value } from './values/index.js';
+/** What one execution of one bar produced. */
+export interface BarResult {
+    readonly index: number;
+    /** One value per channel, absent where nothing wrote, in channel order. */
+    readonly columns: readonly Value[];
+    /** Whether step 9 applied the deferred channels and the pending effects. */
+    readonly applied: boolean;
+    readonly effects: readonly RoutedEffect[];
+    /**
+     * What the frames delivered since the previous bar did to the ledger, a
+     * refused one included (`stdlib.md` 17.14).
+     */
+    readonly frames: readonly FrameOutcome[];
+    /** The watched conditions this bar raised, empty on a bar that raised none. */
+    readonly alerts: readonly AlertFiring[];
+    /** The failure that stopped the bar, when one did. */
+    readonly diagnostic: Diagnostic | undefined;
+}
+export interface RunResult {
+    readonly bars: readonly BarResult[];
+    readonly diagnostic: Diagnostic | undefined;
+}
+//# sourceMappingURL=results.d.ts.map