@sanoma-ai/workflows 0.0.0-stage → 0.2.0

package/dist/source.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"source.js","sourceRoot":"","sources":["../src/source.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AA0BrE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,eAAe,CAAC,QAAQ,EAAE;IACjD,MAAM,EAAE;QACN,OAAO,EAAE;YACP,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,IAAI;YAChB,WAAW,EAAE,wEAAwE;YACrF,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YACnE,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;YAC1C,MAAM,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,EAAgC,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,GAAG,EAAE;SACxE;KACF;CACF,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,cAAc,GAAG,uBAAoE,CAAC;AAEnG,mGAAmG;AACnG,MAAM,CAAC,MAAM,YAAY,GAAG,YAAY,CAAC,SAAS,EAAE;IAClD,MAAM,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,EAAE;CAC7F,CAAC,CAAC;AAEH,MAAM,MAAM,GAAG,+BAA+B,CAAC;AAE/C,8GAA8G;AAC9G,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,GAAW,EAAE,GAAW;IAC5D,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;QAAE,OAAO,GAAG,CAAC;IACjC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC,WAAW,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,KAAK,CAAC,EAAE;QAC9F,mFAAmF;QACnF,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,mBAAmB,EAAE,GAAG,EAAE;QACjD,OAAO,EAAE,MAAM;KAChB,CAAC,CAAC,KAAK,CAAC,CAAC,GAAyC,EAAE,EAAE;QACrD,MAAM,IAAI,WAAW,CAAC,iBAAiB,GAAG,YAAY,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,GAAG,CAAC,OAAO,EAAE,EAAE;YACzF,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,GAAG;SACX,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,MAAM,IAAI,GAAG,IAAI,GAAG,CAClB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAClC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACrC,OAAO,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,CAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACnD,CAAC,CAAC,CACH,CAAC;IACF,KAAK,MAAM,IAAI,IAAI,CAAC,cAAc,GAAG,EAAE,EAAE,aAAa,GAAG,KAAK,EAAE,aAAa,GAAG,EAAE,EAAE,GAAG,CAAC,EAAE,CAAC;QACzF,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC3B,IAAI,GAAG;YAAE,OAAO,GAAG,CAAC;IACtB,CAAC;IACD,MAAM,IAAI,WAAW,CAAC,GAAG,GAAG,yBAAyB,GAAG,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC,CAAC;AAC/G,CAAC"}

package/dist/steps.d.ts

@@ -0,0 +1,76 @@
+import type { LedgerRecord } from "./ledger.ts";
+import type { Op } from "./op.ts";
+/** Any operation, whatever its input and output. */
+type AnyOp<I = any, O = any> = Op<string, string, string, I, O>;
+/**
+ * What a `Given` step sets up before the run: a call through an operation of the run's fake,
+ * with the fields of its input to set (the rest is made up), or a fault to inject into its next
+ * call. `as` names a call's output, so a later step's table of an operation's own test can use
+ * its fields: `$draft.id`.
+ */
+export type Seed = {
+    op: AnyOp;
+    input: Record<string, unknown>;
+    as?: string;
+} | {
+    op: AnyOp;
+    fault: "failNext" | "rateLimit" | "loseReply";
+};
+/** A call through an operation: what it was given, and what it returned. */
+export interface Call<I, O> {
+    input: I;
+    output: O;
+}
+/** A run as a `Then` step reads it. */
+export interface RunView {
+    /** Every record of the run, in order. */
+    readonly records: readonly LedgerRecord[];
+    /** The calls the run made through the operation, in order: those that did not fail. */
+    calls<I, O>(op: AnyOp<I, O>): Call<I, O>[];
+    /** The calls the scenario's `Given` steps made through the operation, to seed the run's fake. */
+    seeded<I, O>(op: AnyOp<I, O>): Call<I, O>[];
+    /** The seeded calls, then the run's own: everything made through the operation. */
+    made<I, O>(op: AnyOp<I, O>): Call<I, O>[];
+}
+/**
+ * What a `Then` step expects. `check` reads the run and throws, or returns why the expectation
+ * does not hold; returning nothing passes. `op` and `called` say what the step is about, for the
+ * graph: the operation, and whether it expects a call to it (true) or rules one out (false).
+ */
+export interface Expect {
+    op?: AnyOp;
+    called?: boolean;
+    check(run: RunView): string | undefined | void;
+}
+/** One step definition: a Cucumber expression, and what the step says, from its parameters' values. */
+export type StepDefinition = {
+    kind: "given";
+    expression: string;
+    fn: (...values: any[]) => Seed;
+} | {
+    kind: "then";
+    expression: string;
+    fn: (...values: any[]) => Expect;
+};
+/** A connector's or a company's steps: `owner` (the vendor, say) heads them in a list of known steps. */
+export interface Steps {
+    readonly owner: string;
+    readonly steps: readonly StepDefinition[];
+}
+/**
+ * Declares steps for Gherkin tests, as data the config's scenarios and a connector's own feature
+ * files can use: `given` steps say what to seed (`Seed`), `then` steps what to expect
+ * (`Expect`). A step's function gets its expression's values, in order, and must be pure:
+ * compiling a scenario calls it, and so does the app, whenever a feature file changes.
+ *
+ * ```ts
+ * export const ghostSteps = defineSteps("ghost", ({ given }) => {
+ *   given("a Ghost draft titled {string}", (title: string) => ({ op: ghostOps.post.create, input: { title }, as: "draft" }));
+ * });
+ * ```
+ */
+export declare function defineSteps(owner: string, define: (steps: {
+    given(expression: string, fn: (...values: any[]) => Seed): void;
+    then(expression: string, fn: (...values: any[]) => Expect): void;
+}) => void): Steps;
+export {};

package/dist/steps.js

@@ -0,0 +1,23 @@
+/**
+ * Declares steps for Gherkin tests, as data the config's scenarios and a connector's own feature
+ * files can use: `given` steps say what to seed (`Seed`), `then` steps what to expect
+ * (`Expect`). A step's function gets its expression's values, in order, and must be pure:
+ * compiling a scenario calls it, and so does the app, whenever a feature file changes.
+ *
+ * ```ts
+ * export const ghostSteps = defineSteps("ghost", ({ given }) => {
+ *   given("a Ghost draft titled {string}", (title: string) => ({ op: ghostOps.post.create, input: { title }, as: "draft" }));
+ * });
+ * ```
+ */
+export function defineSteps(owner, define) {
+    const steps = [];
+    define({
+        given: (expression, fn) => void steps.push({ kind: "given", expression, fn }),
+        // Named for Gherkin's keyword; the object goes to `define` only, which never awaits it.
+        // oxlint-disable-next-line unicorn/no-thenable
+        then: (expression, fn) => void steps.push({ kind: "then", expression, fn }),
+    });
+    return Object.freeze({ owner, steps: Object.freeze(steps) });
+}
+//# sourceMappingURL=steps.js.map

package/dist/steps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"steps.js","sourceRoot":"","sources":["../src/steps.ts"],"names":[],"mappings":"AA8DA;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,WAAW,CACzB,KAAa,EACb,MAGU;IAEV,MAAM,KAAK,GAAqB,EAAE,CAAC;IACnC,MAAM,CAAC;QACL,KAAK,EAAE,CAAC,UAAU,EAAE,EAAE,EAAE,EAAE,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;QAC7E,wFAAwF;QACxF,+CAA+C;QAC/C,IAAI,EAAE,CAAC,UAAU,EAAE,EAAE,EAAE,EAAE,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;KAC5E,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AAC/D,CAAC"}

package/dist/version.d.ts

@@ -0,0 +1,29 @@
+import { type WorkflowDefinition } from "./define.ts";
+/** This package's version. A unit test keeps it equal to package.json. */
+export declare const RUNTIME_VERSION = "0.2.0";
+/**
+ * The sequence of DBOS calls the runtime makes around each `ctx` call: policy step, approval
+ * events and messages, the driver step. Bump it whenever that sequence changes, even without a
+ * package release, so a run in flight on the old layout is not replayed against the new one.
+ * 2: calls run in program order; a decision event per approval (2026-10-07).
+ */
+export declare const STEP_LAYOUT = 2;
+/**
+ * The application version DBOS stamps on every run, always `<appName>@…`: DBOS version names
+ * are unique per system database across apps. A worker recovers and dequeues only runs of its
+ * own version, so the version must change whenever replaying an old run on the new code could
+ * go wrong.
+ *
+ * It is a hash of the app name, `RUNTIME_VERSION`, `STEP_LAYOUT`, the installed DBOS version,
+ * and for each workflow its name, the source text of its `run` function, the ids of the
+ * operations it uses and its input schema as JSON Schema: DBOS's own automatic versioning, over
+ * the workflow code instead of the runtime's one registration wrapper. The hash cannot see
+ * functions `run` calls that live elsewhere (their source is not reachable from the definition),
+ * op schemas, drivers or the policy. DBOS's `DBOS__APPVERSION` environment variable names a
+ * version instead (a git commit, say), still prefixed with the app name.
+ */
+export declare function computeVersion({ appName, workflows: definitions, }: {
+    /** The resolved config's `appName`. */
+    appName: string;
+    workflows: readonly WorkflowDefinition<any, any>[];
+}): string;

package/dist/version.js

@@ -0,0 +1,76 @@
+import { createHash } from "node:crypto";
+import { readFileSync } from "node:fs";
+import { createRequire } from "node:module";
+import { dirname, join } from "node:path";
+import { jsonSchemaOf, opIdsOf } from "./define.js";
+import { upFrom } from "./paths.js";
+/** This package's version. A unit test keeps it equal to package.json. */
+export const RUNTIME_VERSION = "0.2.0";
+/**
+ * The sequence of DBOS calls the runtime makes around each `ctx` call: policy step, approval
+ * events and messages, the driver step. Bump it whenever that sequence changes, even without a
+ * package release, so a run in flight on the old layout is not replayed against the new one.
+ * 2: calls run in program order; a decision event per approval (2026-10-07).
+ */
+export const STEP_LAYOUT = 2;
+let dbosVersion;
+/** The installed DBOS SDK's version, read from its package.json (which its exports don't expose). */
+function installedDbosVersion() {
+    dbosVersion ??= upFrom(dirname(createRequire(import.meta.url).resolve("@dbos-inc/dbos-sdk")), (dir) => {
+        let pkg;
+        try {
+            pkg = JSON.parse(readFileSync(join(dir, "package.json"), "utf8"));
+        }
+        catch (err) {
+            if (err.code === "ENOENT")
+                return undefined;
+            throw err;
+        }
+        return pkg.name === "@dbos-inc/dbos-sdk" && pkg.version ? pkg.version : undefined;
+    });
+    if (!dbosVersion)
+        throw new Error("Cannot find the package.json of @dbos-inc/dbos-sdk");
+    return dbosVersion;
+}
+/**
+ * The application version DBOS stamps on every run, always `<appName>@…`: DBOS version names
+ * are unique per system database across apps. A worker recovers and dequeues only runs of its
+ * own version, so the version must change whenever replaying an old run on the new code could
+ * go wrong.
+ *
+ * It is a hash of the app name, `RUNTIME_VERSION`, `STEP_LAYOUT`, the installed DBOS version,
+ * and for each workflow its name, the source text of its `run` function, the ids of the
+ * operations it uses and its input schema as JSON Schema: DBOS's own automatic versioning, over
+ * the workflow code instead of the runtime's one registration wrapper. The hash cannot see
+ * functions `run` calls that live elsewhere (their source is not reachable from the definition),
+ * op schemas, drivers or the policy. DBOS's `DBOS__APPVERSION` environment variable names a
+ * version instead (a git commit, say), still prefixed with the app name.
+ */
+export function computeVersion({ appName, workflows: definitions, }) {
+    const named = process.env.DBOS__APPVERSION?.trim();
+    if (named)
+        return `${appName}@${named}`;
+    const workflows = definitions
+        .map((wf) => [
+        wf.name,
+        wf.run.toString(),
+        opIdsOf(wf),
+        // The input schema is parsed outside steps on replay, so a change to it must change the version.
+        inputSchemaOf(wf),
+    ])
+        .toSorted(([a], [b]) => (a < b ? -1 : a > b ? 1 : 0));
+    const hash = createHash("sha256")
+        .update(JSON.stringify([appName, RUNTIME_VERSION, STEP_LAYOUT, installedDbosVersion(), ...workflows]))
+        .digest("hex");
+    return `${appName}@${hash}`;
+}
+/** The workflow's input schema as the hash sees it: its JSON Schema, or its text when zod can't convert it. */
+function inputSchemaOf(wf) {
+    try {
+        return jsonSchemaOf(wf.input);
+    }
+    catch {
+        return String(wf.input);
+    }
+}
+//# sourceMappingURL=version.js.map

package/dist/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,OAAO,EAA2B,MAAM,aAAa,CAAC;AAC7E,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEpC,0EAA0E;AAC1E,MAAM,CAAC,MAAM,eAAe,GAAG,OAAO,CAAC;AAEvC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC;AAE7B,IAAI,WAA+B,CAAC;AAEpC,qGAAqG;AACrG,SAAS,oBAAoB;IAC3B,WAAW,KAAK,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE;QACpG,IAAI,GAAwC,CAAC;QAC7C,IAAI,CAAC;YACH,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,CAAe,CAAC;QAClF,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAK,GAA6B,CAAC,IAAI,KAAK,QAAQ;gBAAE,OAAO,SAAS,CAAC;YACvE,MAAM,GAAG,CAAC;QACZ,CAAC;QACD,OAAO,GAAG,CAAC,IAAI,KAAK,oBAAoB,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IACpF,CAAC,CAAC,CAAC;IACH,IAAI,CAAC,WAAW;QAAE,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;IACxF,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,cAAc,CAAC,EAC7B,OAAO,EACP,SAAS,EAAE,WAAW,GAKvB;IACC,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,IAAI,EAAE,CAAC;IACnD,IAAI,KAAK;QAAE,OAAO,GAAG,OAAO,IAAI,KAAK,EAAE,CAAC;IACxC,MAAM,SAAS,GAAG,WAAW;SAC1B,GAAG,CACF,CAAC,EAAE,EAAE,EAAE,CACL;QACE,EAAE,CAAC,IAAI;QACP,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE;QACjB,OAAO,CAAC,EAAE,CAAC;QACX,iGAAiG;QACjG,aAAa,CAAC,EAAE,CAAC;KACT,CACb;SACA,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACxD,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC;SAC9B,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,oBAAoB,EAAE,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC;SACrG,MAAM,CAAC,KAAK,CAAC,CAAC;IACjB,OAAO,GAAG,OAAO,IAAI,IAAI,EAAE,CAAC;AAC9B,CAAC;AAED,+GAA+G;AAC/G,SAAS,aAAa,CAAC,EAAgC;IACrD,IAAI,CAAC;QACH,OAAO,YAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;AACH,CAAC"}

package/dist/worker.d.ts

@@ -0,0 +1,37 @@
+import { type SanomaConfig } from "./config.ts";
+import type { Source } from "./source.ts";
+export interface Worker {
+    /**
+     * The vendors whose drivers could not run when the worker started, in the config's order: a
+     * live call to one fails, saying why (`unconfigured` in env.ts), until its variables are set.
+     * The worker names them in one line at start, unless started `quiet`.
+     */
+    readonly unconfigured: readonly string[];
+    stop(): Promise<void>;
+}
+export interface WorkerOptions {
+    /** The least severe level of the runtime's and DBOS's messages to show, for the whole process: `warn` by default. */
+    logLevel?: string;
+    /**
+     * Start without naming the vendors not configured yet (`unconfigured` still does): for a worker
+     * whose runs use the fakes alone, as `runScenarios`'s.
+     */
+    quiet?: boolean;
+    /**
+     * Make this worker's version the app's latest, so runs queued without a version come here.
+     * A brand-new version becomes the latest on its own; set this only when deliberately starting
+     * a worker on a version seen before (a rollback). Off by default, because an old instance
+     * restarting during a rolling deploy would otherwise take the new workers' runs.
+     */
+    promote?: boolean;
+    /** The company's repository, which apply commits the lockfile to; the launcher passes its checkout. */
+    source?: Source;
+}
+/**
+ * Registers the workflows, connects to Postgres and recovers any runs that were interrupted.
+ * When a driver declares variables the environment leaves unset, it first loads their stored
+ * values into `process.env` and keeps them current while it runs. It starts whether or not they
+ * are all there: it prints one line naming the vendors that lack one (`unconfigured`), and a live
+ * call to such a vendor fails, saying why, as the call's own final failure, until they are set.
+ */
+export declare function startWorker(config: SanomaConfig, options?: WorkerOptions): Promise<Worker>;

package/dist/worker.js

@@ -0,0 +1,228 @@
+import { DBOS } from "@dbos-inc/dbos-sdk";
+import { buildCtx, isInfrastructureError } from "./call.js";
+import { dbosStatusesOf } from "./client.js";
+import { resolveConfig } from "./config.js";
+import { storedSecrets, watchCredentials } from "./credentials.js";
+import { DBOS_DATABASE_OPTIONS, lazyPool, prepareDatabase } from "./db.js";
+import { credentialsOf, unconfigured, unconfiguredSummary } from "./env.js";
+import { errorInfo, parseOrThrow } from "./errors.js";
+import { entry, ownedLedger, skipped, write, writeFailure } from "./ledger.js";
+import { dbosLogger, quietIfSandbox, setLogLevel, warn } from "./log.js";
+import { lineStartsOf, readSource } from "./ast.js";
+import { callsOf, outlineWithSource } from "./outline.js";
+import { currentRun } from "./run.js";
+import { errorMessage } from "./shared.js";
+// DBOS registrations are process-wide and survive shutdown, so a name is registered once, and
+// its function reads the state of the worker running when a run starts, definition and all; the
+// run keeps that state.
+let current;
+const registered = new Set();
+/**
+ * Registers the workflows, connects to Postgres and recovers any runs that were interrupted.
+ * When a driver declares variables the environment leaves unset, it first loads their stored
+ * values into `process.env` and keeps them current while it runs. It starts whether or not they
+ * are all there: it prints one line naming the vendors that lack one (`unconfigured`), and a live
+ * call to such a vendor fails, saying why, as the call's own final failure, until they are set.
+ */
+export async function startWorker(config, options = {}) {
+    // Check everything before touching the state a running worker reads.
+    const resolved = resolveConfig(config);
+    setLogLevel(options.logLevel);
+    // The config's own, or a Postgres store made for this worker, which `stop` then closes.
+    const ledger = ownedLedger(resolved);
+    const secrets = lazyPool(resolved.databaseUrl, "secrets");
+    const state = {
+        app: resolved.appName,
+        ops: resolved.ops,
+        drivers: resolved.drivers,
+        fakes: resolved.fakes,
+        ...(resolved.scenarios && { scenarios: resolved.scenarios }),
+        ...(options.source && { source: options.source }),
+        types: resolved.types,
+        steps: resolved.steps,
+        policy: resolved.policy,
+        ledger: ledger.store,
+        secrets: storedSecrets(() => secrets.db(), "sanoma"),
+        workflows: resolved.workflows,
+        outlines: new Map([...resolved.workflows].map(([name, wf]) => [name, outlineOf(wf)])),
+        stopped: false,
+    };
+    const credentials = await watchCredentials(resolved.databaseUrl, resolved.driversByVendor);
+    const worker = {
+        unconfigured: [...credentialsOf(resolved.driversByVendor, (name) => process.env[name])]
+            .filter(([vendor, statuses]) => unconfigured(vendor, statuses))
+            .map(([vendor]) => vendor),
+        async stop() {
+            state.stopped = true;
+            // Each is closed whatever the one before did; the first failure is what stop throws.
+            let failed;
+            for (const close of [
+                () => DBOS.shutdown(),
+                () => credentials.close(),
+                () => secrets.close(),
+                () => ledger.close(),
+            ]) {
+                await close().catch((error) => (failed ??= { error }));
+            }
+            if (failed)
+                throw failed.error;
+        },
+    };
+    // Runs recovered during launch start before it returns, so they must already find this
+    // state. If starting fails, a worker still running in the process gets its own back, once
+    // DBOS has stopped: until then a run DBOS dispatches finds this state stopped, and is refused.
+    const previous = current;
+    let launched = false;
+    try {
+        for (const name of resolved.workflows.keys()) {
+            if (!registered.has(name)) {
+                register(name);
+                registered.add(name);
+            }
+        }
+        current = state;
+        // Before DBOS's pool connects, so its connections start with the database's idle-transaction
+        // timeout (`DBOS_DATABASE_OPTIONS`); once per process and database.
+        await prepareDatabase(resolved.databaseUrl);
+        DBOS.setConfig({
+            name: resolved.appName,
+            systemDatabaseUrl: resolved.databaseUrl,
+            ...DBOS_DATABASE_OPTIONS,
+            // A logger of our own replaces DBOS's OTLP log export, so only while DBOS exports none (it
+            // does on DBOS Cloud); its level is then the threshold `setLogLevel` set, DBOS's own `logLevel` unread.
+            ...(process.env.DBOS__CLOUD === "true" ? { logLevel: options.logLevel ?? "warn" } : { logger: dbosLogger }),
+            applicationVersion: resolved.version,
+        });
+        await DBOS.launch();
+        launched = true;
+        // DBOS gives runs queued without a version only to the app's latest version, which is the
+        // newest one registered. A worker started on code seen before (a rollback) is not it.
+        const latest = (await DBOS.getLatestApplicationVersion()).versionName;
+        if (latest !== resolved.version) {
+            if (options.promote)
+                await DBOS.setLatestApplicationVersion(resolved.version);
+            else {
+                warn(`this worker runs version ${resolved.version} but the app's latest is ${latest}; ` +
+                    "runs queued without a version go to the latest. Start with { promote: true } to take them here");
+            }
+        }
+        await DBOS.registerQueue(resolved.queueName);
+        await warnAboutStrandedRuns(resolved);
+        const summary = unconfiguredSummary(worker.unconfigured, resolved.driversByVendor.size);
+        if (summary && !options.quiet)
+            warn(summary);
+    }
+    catch (err) {
+        // Once DBOS is launched, the caller gets no worker to stop: stop it here, so no run goes on
+        // in a worker nobody holds, and the next startWorker launches afresh.
+        let stopFailed;
+        if (launched)
+            await worker.stop().catch((error) => (stopFailed = { error }));
+        else {
+            await credentials
+                .close()
+                .catch((e) => warn(`closing the credentials listener failed: ${errorMessage(e)}`));
+        }
+        current = previous;
+        if (stopFailed) {
+            throw new AggregateError([err, stopFailed.error], `${errorMessage(err)} (and stopping DBOS failed too: ${errorMessage(stopFailed.error)})`, { cause: err });
+        }
+        throw err;
+    }
+    return worker;
+}
+/**
+ * The workflow's outline, read from its file, which every run is held to. A workflow whose
+ * outline cannot be read does not start: nothing could say where its calls are.
+ */
+function outlineOf(wf) {
+    const { outline, source } = outlineWithSource(wf, readSource(wf.file));
+    if ("error" in outline) {
+        throw new Error(`Workflow "${wf.name}" cannot be outlined, so its runs could not be held to its code: ${outline.error}`);
+    }
+    return { file: outline.file, lineStarts: lineStartsOf(source), calls: callsOf(outline.nodes) };
+}
+/**
+ * Warns about unfinished runs this worker will never pick up: started on another version of
+ * the app, or queued on another queue (such as the single "sanoma" queue before queues were
+ * named per app, or the sandbox queue before sandbox runs went on the app's).
+ */
+async function warnAboutStrandedRuns({ appName, version, queueName }) {
+    const runs = await DBOS.listWorkflows({
+        status: dbosStatusesOf("queued", "running"),
+        applicationName: appName,
+        loadInput: false,
+        loadOutput: false,
+    });
+    const otherVersion = runs.filter((r) => r.applicationVersion && r.applicationVersion !== version);
+    // Recovery moves a worker's own runs to DBOS's internal queues, which are fine.
+    const otherQueue = runs.filter((r) => !otherVersion.includes(r) && r.queueName && r.queueName !== queueName && !r.queueName.startsWith("_dbos_"));
+    if (!otherVersion.length && !otherQueue.length)
+        return;
+    const ids = [...otherVersion, ...otherQueue].map((r) => r.workflowID);
+    warn(`${otherVersion.length} unfinished run(s) of "${appName}" belong to another version and ${otherQueue.length} ` +
+        `wait on another queue, so this worker (version ${version}, queue ${queueName}) will not run them: ` +
+        `${ids.slice(0, 5).join(", ")}${ids.length > 5 ? ", …" : ""}. Run the version that started them, or move each ` +
+        `with DBOSClient.forkWorkflow(id, step, { applicationVersion: "${version}", queueName: "${queueName}" }) ` +
+        `and cancel the original; resumeWorkflow(id, { queueName: "${queueName}" }) moves a run on this version to this queue.`);
+}
+/** Registers the name with DBOS: its runs take the definition of that name from the running worker. */
+function register(name) {
+    DBOS.registerWorkflow((args) => quietIfSandbox(args.sandbox !== undefined, () => runWorkflow(name, args)), {
+        name,
+    });
+}
+/** One run of the workflow registered as `name`, on the state of the worker running when it starts. */
+async function runWorkflow(name, { input, startedBy, sandbox }) {
+    const state = current;
+    // A stopped worker's state stays current while DBOS shuts down.
+    if (!state || state.stopped)
+        throw new Error(`Run of "${name}" started with no worker running`);
+    const wf = state.workflows.get(name);
+    const outline = state.outlines.get(name);
+    // Registered by an earlier worker in this process, whose config had it; this one's has not.
+    if (!wf || !outline)
+        throw new Error(`Run of "${name}" refused: this worker's config has no workflow of that name`);
+    const run = {
+        id: DBOS.workflowID,
+        workflow: wf.name,
+        actor: startedBy,
+        ...(sandbox === undefined ? {} : { sandbox }),
+        approvals: [],
+        seq: 0,
+        tail: Promise.resolve(),
+        inAll: false,
+        ended: false,
+        outline,
+        state,
+    };
+    await write(run, entry(run, { type: "run.started", input }));
+    let output;
+    try {
+        try {
+            // The one parse of the input: the client checked it, but sent it as given.
+            const parsed = parseOrThrow(wf.input, input, `The input does not match ${wf.name}'s schema`);
+            if (sandbox !== undefined) {
+                // Imported here, so a live worker never loads the Gherkin parser or faker.
+                const { seedSandbox } = await import("./sandbox.js");
+                await seedSandbox(run, sandbox);
+            }
+            output = await currentRun.run(run, () => wf.run(buildCtx(wf, run), parsed));
+        }
+        finally {
+            // Before the outcome is written: a call still queued must find the run ended.
+            run.ended = true;
+        }
+    }
+    catch (err) {
+        const record = entry(run, { type: "run.failed", error: errorInfo(err) });
+        if (isInfrastructureError(err, state))
+            skipped(record, `the run was interrupted (${errorMessage(err)})`);
+        else
+            await writeFailure(run, record, err);
+        throw err;
+    }
+    await write(run, entry(run, { type: "run.finished", output }));
+    return output;
+}
+//# sourceMappingURL=worker.js.map

package/dist/worker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker.js","sourceRoot":"","sources":["../src/worker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAuB,aAAa,EAAqB,MAAM,aAAa,CAAC;AACpF,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACnE,OAAO,EAAE,qBAAqB,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE3E,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC/E,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAkE,MAAM,UAAU,CAAC;AAEtG,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAY3C,8FAA8F;AAC9F,gGAAgG;AAChG,wBAAwB;AACxB,IAAI,OAAgC,CAAC;AACrC,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;AAqBrC;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,MAAoB,EAAE,OAAO,GAAkB,EAAE;IACjF,qEAAqE;IACrE,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IACvC,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC9B,wFAAwF;IACxF,MAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;IACrC,MAAM,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;IAC1D,MAAM,KAAK,GAAgB;QACzB,GAAG,EAAE,QAAQ,CAAC,OAAO;QACrB,GAAG,EAAE,QAAQ,CAAC,GAAG;QACjB,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,GAAG,CAAC,QAAQ,CAAC,SAAS,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,EAAE,CAAC;QAC5D,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;QACjD,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,MAAM,EAAE,MAAM,CAAC,KAAK;QACpB,OAAO,EAAE,aAAa,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,QAAQ,CAAC;QACpD,SAAS,EAAE,QAAQ,CAAC,SAAS;QAC7B,QAAQ,EAAE,IAAI,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACrF,OAAO,EAAE,KAAK;KACf,CAAC;IACF,MAAM,WAAW,GAAG,MAAM,gBAAgB,CAAC,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;IAC3F,MAAM,MAAM,GAAW;QACrB,YAAY,EAAE,CAAC,GAAG,aAAa,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;aACpF,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;aAC9D,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC;QAC5B,KAAK,CAAC,IAAI;YACR,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC;YACrB,qFAAqF;YACrF,IAAI,MAAsC,CAAC;YAC3C,KAAK,MAAM,KAAK,IAAI;gBAClB,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE;gBACrB,GAAG,EAAE,CAAC,WAAW,CAAC,KAAK,EAAE;gBACzB,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE;gBACrB,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE;aACrB,EAAE,CAAC;gBACF,MAAM,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE,CAAC,CAAC,MAAM,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;YAClE,CAAC;YACD,IAAI,MAAM;gBAAE,MAAM,MAAM,CAAC,KAAK,CAAC;QACjC,CAAC;KACF,CAAC;IACF,uFAAuF;IACvF,0FAA0F;IAC1F,+FAA+F;IAC/F,MAAM,QAAQ,GAAG,OAAO,CAAC;IACzB,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,IAAI,CAAC;QACH,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,CAAC;YAC7C,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1B,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACf,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;QACD,OAAO,GAAG,KAAK,CAAC;QAChB,6FAA6F;QAC7F,oEAAoE;QACpE,MAAM,eAAe,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC5C,IAAI,CAAC,SAAS,CAAC;YACb,IAAI,EAAE,QAAQ,CAAC,OAAO;YACtB,iBAAiB,EAAE,QAAQ,CAAC,WAAW;YACvC,GAAG,qBAAqB;YACxB,2FAA2F;YAC3F,wGAAwG;YACxG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;YAC3G,kBAAkB,EAAE,QAAQ,CAAC,OAAO;SACrC,CAAC,CAAC;QACH,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACpB,QAAQ,GAAG,IAAI,CAAC;QAChB,0FAA0F;QAC1F,sFAAsF;QACtF,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,2BAA2B,EAAE,CAAC,CAAC,WAAW,CAAC;QACtE,IAAI,MAAM,KAAK,QAAQ,CAAC,OAAO,EAAE,CAAC;YAChC,IAAI,OAAO,CAAC,OAAO;gBAAE,MAAM,IAAI,CAAC,2BAA2B,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;iBACzE,CAAC;gBACJ,IAAI,CACF,4BAA4B,QAAQ,CAAC,OAAO,4BAA4B,MAAM,IAAI;oBAChF,gGAAgG,CACnG,CAAC;YACJ,CAAC;QACH,CAAC;QACD,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAC7C,MAAM,qBAAqB,CAAC,QAAQ,CAAC,CAAC;QACtC,MAAM,OAAO,GAAG,mBAAmB,CAAC,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QACxF,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK;YAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,4FAA4F;QAC5F,sEAAsE;QACtE,IAAI,UAA0C,CAAC;QAC/C,IAAI,QAAQ;YAAE,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE,CAAC,CAAC,UAAU,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;aACjF,CAAC;YACJ,MAAM,WAAW;iBACd,KAAK,EAAE;iBACP,KAAK,CAAC,CAAC,CAAU,EAAE,EAAE,CAAC,IAAI,CAAC,4CAA4C,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAChG,CAAC;QACD,OAAO,GAAG,QAAQ,CAAC;QACnB,IAAI,UAAU,EAAE,CAAC;YACf,MAAM,IAAI,cAAc,CACtB,CAAC,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,EACvB,GAAG,YAAY,CAAC,GAAG,CAAC,mCAAmC,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,EACxF,EAAE,KAAK,EAAE,GAAG,EAAE,CACf,CAAC;QACJ,CAAC;QACD,MAAM,GAAG,CAAC;IACZ,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,SAAS,SAAS,CAAC,EAAgC;IACjD,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,iBAAiB,CAAC,EAAE,EAAE,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IACvE,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CACb,aAAa,EAAE,CAAC,IAAI,oEAAoE,OAAO,CAAC,KAAK,EAAE,CACxG,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,UAAU,EAAE,YAAY,CAAC,MAAO,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;AAClG,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,qBAAqB,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAkB;IAClF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC;QACpC,MAAM,EAAE,cAAc,CAAC,QAAQ,EAAE,SAAS,CAAC;QAC3C,eAAe,EAAE,OAAO;QACxB,SAAS,EAAE,KAAK;QAChB,UAAU,EAAE,KAAK;KAClB,CAAC,CAAC;IACH,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,kBAAkB,IAAI,CAAC,CAAC,kBAAkB,KAAK,OAAO,CAAC,CAAC;IAClG,gFAAgF;IAChF,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAC5B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,SAAS,KAAK,SAAS,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,CAClH,CAAC;IACF,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM;QAAE,OAAO;IACvD,MAAM,GAAG,GAAG,CAAC,GAAG,YAAY,EAAE,GAAG,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IACtE,IAAI,CACF,GAAG,YAAY,CAAC,MAAM,0BAA0B,OAAO,mCAAmC,UAAU,CAAC,MAAM,GAAG;QAC5G,kDAAkD,OAAO,WAAW,SAAS,uBAAuB;QACpG,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,oDAAoD;QAC/G,iEAAiE,OAAO,kBAAkB,SAAS,OAAO;QAC1G,6DAA6D,SAAS,iDAAiD,CAC1H,CAAC;AACJ,CAAC;AAED,uGAAuG;AACvG,SAAS,QAAQ,CAAC,IAAY;IAC5B,IAAI,CAAC,gBAAgB,CAAC,CAAC,IAAa,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE;QAClH,IAAI;KACL,CAAC,CAAC;AACL,CAAC;AAED,uGAAuG;AACvG,KAAK,UAAU,WAAW,CAAC,IAAY,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAW;IAC7E,MAAM,KAAK,GAAG,OAAO,CAAC;IACtB,gEAAgE;IAChE,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,WAAW,IAAI,kCAAkC,CAAC,CAAC;IAChG,MAAM,EAAE,GAAG,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,OAAO,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACzC,4FAA4F;IAC5F,IAAI,CAAC,EAAE,IAAI,CAAC,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,WAAW,IAAI,8DAA8D,CAAC,CAAC;IACpH,MAAM,GAAG,GAAQ;QACf,EAAE,EAAE,IAAI,CAAC,UAAW;QACpB,QAAQ,EAAE,EAAE,CAAC,IAAI;QACjB,KAAK,EAAE,SAAS;QAChB,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC;QAC7C,SAAS,EAAE,EAAE;QACb,GAAG,EAAE,CAAC;QACN,IAAI,EAAE,OAAO,CAAC,OAAO,EAAE;QACvB,KAAK,EAAE,KAAK;QACZ,KAAK,EAAE,KAAK;QACZ,OAAO;QACP,KAAK;KACN,CAAC;IACF,MAAM,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IAC7D,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACH,IAAI,CAAC;YACH,2EAA2E;YAC3E,MAAM,MAAM,GAAG,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,4BAA4B,EAAE,CAAC,IAAI,WAAW,CAAC,CAAC;YAC7F,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC1B,2EAA2E;gBAC3E,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,CAAC;gBACrD,MAAM,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YAClC,CAAC;YACD,MAAM,GAAG,MAAM,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;QAC9E,CAAC;gBAAS,CAAC;YACT,8EAA8E;YAC9E,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC;QACnB,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACzE,IAAI,qBAAqB,CAAC,GAAG,EAAE,KAAK,CAAC;YAAE,OAAO,CAAC,MAAM,EAAE,4BAA4B,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;;YACpG,MAAM,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;QAC1C,MAAM,GAAG,CAAC;IACZ,CAAC;IACD,MAAM,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC/D,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/writer.d.ts

@@ -0,0 +1,35 @@
+import type { FormatConfig } from "oxfmt";
+import { type DataFileExport, type DataFileImport, type DataValue } from "./datafile.ts";
+/** A whole data file to render: its imports and its resources, in order. */
+export interface DataFileContent {
+    imports: readonly Pick<DataFileImport, "source" | "imported" | "local">[];
+    exports: readonly Pick<DataFileExport, "name" | "vendor" | "type" | "desired">[];
+}
+/**
+ * oxfmt's options from `<root>/.oxfmtrc.json`, what `oxfmt` itself reads there, less what only
+ * its CLI uses (`ignorePatterns`, `overrides`); none, oxfmt's defaults, without the file.
+ */
+export declare function formatOptions(root: string): FormatConfig;
+/**
+ * `source`, a data file's text, with fields of its resource `exportName` set to new values:
+ * `fields` by dotted path, a list item's with its index, as a drift report names them
+ * (`required_pull_request_reviews.0.dismiss_stale_reviews`). A field the declaration does not
+ * have is added at the end of the object that should hold it. Only that `export const` changes:
+ * it is formatted with oxfmt under `options` (`formatOptions`), and every other byte of the file
+ * stays as it was.
+ *
+ * A value naming a secret adds `import { secret } from "sanoma/resources"` after the file's
+ * imports when it has none.
+ *
+ * Throws when the file does not parse, declares no such resource, or a path cannot be set: it
+ * runs through a value that is not an object or a list, or ends at a reference to another
+ * resource (a person changes a reference; a vendor's value never replaces one).
+ */
+export declare function setFields(source: string, exportName: string, fields: Readonly<Record<string, DataValue>>, options?: FormatConfig): Promise<string>;
+/**
+ * A whole data file: the imports, one per source, then each resource as `export const`, then
+ * `export default` naming them all, formatted with oxfmt under `options`. `readDataFile` reads it
+ * back as it was given: what `readDataFile` returns renders the file again. A file whose values
+ * name a secret also imports `secret` from "sanoma/resources".
+ */
+export declare function renderDataFile({ imports, exports }: DataFileContent, options?: FormatConfig): Promise<string>;