@sanoma-ai/workflows 0.0.0-stage → 0.1.0

package/dist/cucumber.js

@@ -0,0 +1,158 @@
+import { Writable } from "node:stream";
+import { supportCodeLibraryBuilder } from "@cucumber/cucumber";
+import { runCucumber } from "@cucumber/cucumber/api";
+import { NodeType } from "@cucumber/cucumber-expressions";
+import { IdGenerator, TestStepResultStatus } from "@cucumber/messages";
+import { Query } from "@cucumber/query";
+/**
+ * Builds a support code library: the parameter types, then one step definition per expression,
+ * each handing its step to the World. Cucumber keeps one builder per process, so the library is
+ * built here, by hand, in one synchronous stretch (`reset`, register, `finalize`): building it
+ * again in the same process gives the same definitions, where a second `loadSupport` would
+ * import nothing new and find none.
+ */
+export function buildLibrary(parameterTypes, expressions) {
+    const builder = supportCodeLibraryBuilder;
+    builder.reset(process.cwd(), IdGenerator.uuid(), {
+        requireModules: [],
+        requirePaths: [],
+        importPaths: [],
+        loaders: [],
+    });
+    const { defineParameterType, defineStep, Before, BeforeStep } = builder.methods;
+    for (const { name, regexp, transformer } of parameterTypes) {
+        defineParameterType({ name, regexp: regexp, transformer, useForSnippets: false });
+    }
+    for (const expression of expressions)
+        defineStep(expression, stepCode(expression));
+    Before(function ({ pickle }) {
+        if (this.run.skips(pickle))
+            return "skipped";
+        this.begin(pickle);
+        return undefined;
+    });
+    BeforeStep(function ({ pickleStep }) {
+        this.current = pickleStep;
+    });
+    const library = builder.finalize();
+    // Cucumber checks a definition's code's `length` against what it passes: the expression's
+    // parameters, then the step's doc string or table, or else a callback. Its own parse of each
+    // expression says how many parameters it has.
+    for (const { code, expression } of library.stepDefinitions) {
+        Object.defineProperty(code, "length", {
+            value: countParameters(expression.ast) + 1,
+        });
+    }
+    return library;
+}
+const countParameters = (node) => node.type === NodeType.parameter ? 1 : (node.nodes ?? []).reduce((n, child) => n + countParameters(child), 0);
+/**
+ * A step definition's code. Cucumber passes the expression's values, then the step's doc string
+ * or table when it has one, then a callback: with one more argument than the parameters it took
+ * the callback of a step with no argument (the callback interface), and with two more, the
+ * argument of a step that has one (the promise interface). The World reads the argument from
+ * the pickle step, so the code answers both.
+ */
+function stepCode(expression) {
+    const code = function (...args) {
+        const parameters = code.length - 1;
+        const result = Promise.resolve()
+            .then(() => this.step(expression, args.slice(0, parameters), this.current))
+            .catch((err) => {
+            this.run.caught(err);
+            throw err;
+        });
+        if (args.length > parameters + 1)
+            return result;
+        const done = args.at(-1);
+        result.then((value) => done(null, value), (err) => done(err));
+        return undefined;
+    };
+    return code;
+}
+/** How each step of a run ended, by its pickle step's id; a step of a pickle that did not run has none. */
+export function stepResults({ query }) {
+    const results = new Map();
+    for (const finished of query.findAllTestStepFinished()) {
+        const testStep = query.findTestStepBy(finished);
+        if (!testStep?.pickleStepId)
+            continue;
+        const { status, message, exception } = finished.testStepResult;
+        const why = exception?.message ?? message;
+        results.set(testStep.pickleStepId, {
+            status,
+            matches: query.findStepDefinitionsBy(testStep).map((d) => d.pattern.source),
+            ...(why !== undefined && { message: why }),
+        });
+    }
+    return results;
+}
+/** A pickle's line: its examples row's, or its scenario's. */
+export const lineOf = (report, pickle) => report.query.findLocationOf(pickle)?.line ?? 1;
+/** A stream that drops what it is given: Cucumber's formatters and logger write nowhere. */
+const sink = () => new Writable({
+    write(_chunk, _encoding, callback) {
+        callback();
+    },
+});
+/**
+ * A path as a glob that matches it alone: Cucumber globs each path it is given, and reads one
+ * whose name starts with `@` as a list of paths. Brackets escape what they can; brace
+ * expansion reads braces and commas before brackets, so those (and backslashes) match any
+ * character instead.
+ */
+const literal = (path) => path.replaceAll(/[*?[\]()+@]/g, "[$&]").replaceAll(/[{},\\]/g, "?");
+/**
+ * Runs the feature files `files` (relative to `cwd`) with the library, serially, in this
+ * process, and reads back what happened. `line`, with a single file, runs only the scenario or
+ * examples row at that line. `makeWorld` makes each scenario's World, given the report so far
+ * (every file and pickle, read before the first scenario starts). A dry run matches the steps
+ * and runs none. A step's error that is a bug in code (`isBug`) is rethrown once the run is
+ * over, rather than reported as the step's failure.
+ */
+export async function runFeatures(library, makeWorld, { cwd, files, line, dryRun = false, isBug, }) {
+    const report = { query: new Query(), texts: new Map(), parseErrors: [] };
+    let bug;
+    const run = {
+        skips: (pickle) => line !== undefined && lineOf(report, pickle) !== line,
+        caught: (err) => {
+            if (isBug(err))
+                bug ??= err;
+        },
+    };
+    // Cucumber makes a scenario's World with `new`: a constructor that returns an object gives that object.
+    function World() {
+        return Object.assign(makeWorld(report), { run });
+    }
+    const configuration = {
+        sources: { defaultDialect: "en", paths: files.map(literal), names: [], tagExpression: "", order: "defined" },
+        support: { ...library, World },
+        runtime: {
+            dryRun,
+            failFast: false,
+            filterStacktraces: true,
+            parallel: 0,
+            retry: 0,
+            retryTagFilter: "",
+            strict: true,
+            worldParameters: {},
+        },
+        // Cucumber always formats to stdout, here a sink: `rerun` is the formatter that does least.
+        formats: { stdout: "rerun", files: {}, publish: false, options: {} },
+    };
+    await runCucumber(configuration, { cwd, stdout: sink(), stderr: sink(), env: {} }, (envelope) => {
+        report.query.update(envelope);
+        const { source, parseError } = envelope;
+        if (source)
+            report.texts.set(source.uri, source.data);
+        if (parseError) {
+            const { uri = "", location } = parseError.source;
+            report.parseErrors.push({ uri, ...(location && { line: location.line }), message: parseError.message });
+        }
+    });
+    if (bug !== undefined)
+        throw bug;
+    return report;
+}
+export { TestStepResultStatus as StepStatus };
+//# sourceMappingURL=cucumber.js.map

package/dist/cucumber.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cucumber.js","sourceRoot":"","sources":["../src/cucumber.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAA8C,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACjG,OAAO,EAAsC,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AAC9F,OAAO,EAAE,WAAW,EAAgC,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AACrG,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AA4BxC;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAC1B,cAA4C,EAC5C,WAA6B;IAE7B,MAAM,OAAO,GAAG,yBAAyB,CAAC;IAC1C,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,WAAW,CAAC,IAAI,EAAE,EAAE;QAC/C,cAAc,EAAE,EAAE;QAClB,YAAY,EAAE,EAAE;QAChB,WAAW,EAAE,EAAE;QACf,OAAO,EAAE,EAAE;KACZ,CAAC,CAAC;IACH,MAAM,EAAE,mBAAmB,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAChF,KAAK,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,cAAc,EAAE,CAAC;QAC3D,mBAAmB,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAgB,EAAE,WAAW,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9F,CAAC;IACD,KAAK,MAAM,UAAU,IAAI,WAAW;QAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;IACnF,MAAM,CAAC,UAAyB,EAAE,MAAM,EAAE;QACxC,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC;YAAE,OAAO,SAAS,CAAC;QAC7C,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACnB,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC,CAAC;IACH,UAAU,CAAC,UAAyB,EAAE,UAAU,EAAE;QAChD,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC;IAC5B,CAAC,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IACnC,0FAA0F;IAC1F,6FAA6F;IAC7F,8CAA8C;IAC9C,KAAK,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;QAC3D,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,QAAQ,EAAE;YACpC,KAAK,EAAE,eAAe,CAAE,UAAiC,CAAC,GAAG,CAAC,GAAG,CAAC;SACnE,CAAC,CAAC;IACL,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAWD,MAAM,eAAe,GAAG,CAAC,IAAU,EAAU,EAAE,CAC7C,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;AAEhH;;;;;;GAMG;AACH,SAAS,QAAQ,CAAC,UAAkB;IAClC,MAAM,IAAI,GAAG,UAAyB,GAAG,IAAe;QACtD,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;QACnC,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE;aAC7B,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;aAC1E,KAAK,CAAC,CAAC,GAAY,EAAE,EAAE;YACtB,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACrB,MAAM,GAAG,CAAC;QACZ,CAAC,CAAC,CAAC;QACL,IAAI,IAAI,CAAC,MAAM,GAAG,UAAU,GAAG,CAAC;YAAE,OAAO,MAAM,CAAC;QAChD,MAAM,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAA+C,CAAC;QACvE,MAAM,CAAC,IAAI,CACT,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,EAC5B,CAAC,GAAY,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAC5B,CAAC;QACF,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;IACF,OAAO,IAAI,CAAC;AACd,CAAC;AAoBD,2GAA2G;AAC3G,MAAM,UAAU,WAAW,CAAC,EAAE,KAAK,EAAU;IAC3C,MAAM,OAAO,GAAG,IAAI,GAAG,EAAsB,CAAC;IAC9C,KAAK,MAAM,QAAQ,IAAI,KAAK,CAAC,uBAAuB,EAAE,EAAE,CAAC;QACvD,MAAM,QAAQ,GAAG,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,QAAQ,EAAE,YAAY;YAAE,SAAS;QACtC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,QAAQ,CAAC,cAAc,CAAC;QAC/D,MAAM,GAAG,GAAG,SAAS,EAAE,OAAO,IAAI,OAAO,CAAC;QAC1C,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,YAAY,EAAE;YACjC,MAAM;YACN,OAAO,EAAE,KAAK,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;YAC3E,GAAG,CAAC,GAAG,KAAK,SAAS,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;SAC3C,CAAC,CAAC;IACL,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,8DAA8D;AAC9D,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,MAAc,EAAE,MAAc,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC;AAEzG,4FAA4F;AAC5F,MAAM,IAAI,GAAG,GAAG,EAAE,CAChB,IAAI,QAAQ,CAAC;IACX,KAAK,CAAC,MAAM,EAAE,SAAS,EAAE,QAAQ;QAC/B,QAAQ,EAAE,CAAC;IACb,CAAC;CACF,CAAC,CAAC;AAEL;;;;;GAKG;AACH,MAAM,OAAO,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,UAAU,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;AAEtG;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,OAA4B,EAC5B,SAA0C,EAC1C,EACE,GAAG,EACH,KAAK,EACL,IAAI,EACJ,MAAM,GAAG,KAAK,EACd,KAAK,GAC+F;IAEtG,MAAM,MAAM,GAAW,EAAE,KAAK,EAAE,IAAI,KAAK,EAAE,EAAE,KAAK,EAAE,IAAI,GAAG,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC;IACjF,IAAI,GAAY,CAAC;IACjB,MAAM,GAAG,GAAa;QACpB,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,IAAI;QACxE,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE;YACd,IAAI,KAAK,CAAC,GAAG,CAAC;gBAAE,GAAG,KAAK,GAAG,CAAC;QAC9B,CAAC;KACF,CAAC;IACF,wGAAwG;IACxG,SAAS,KAAK;QACZ,OAAO,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IACnD,CAAC;IACD,MAAM,aAAa,GAAgB;QACjC,OAAO,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;QAC5G,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,KAAK,EAAyB;QACrD,OAAO,EAAE;YACP,MAAM;YACN,QAAQ,EAAE,KAAK;YACf,iBAAiB,EAAE,IAAI;YACvB,QAAQ,EAAE,CAAC;YACX,KAAK,EAAE,CAAC;YACR,cAAc,EAAE,EAAE;YAClB,MAAM,EAAE,IAAI;YACZ,eAAe,EAAE,EAAE;SACpB;QACD,4FAA4F;QAC5F,OAAO,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE;KACrE,CAAC;IACF,MAAM,WAAW,CAAC,aAAa,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,QAAQ,EAAE,EAAE;QAC9F,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC9B,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,QAAQ,CAAC;QACxC,IAAI,MAAM;YAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,UAAU,EAAE,CAAC;YACf,MAAM,EAAE,GAAG,GAAG,EAAE,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC;YACjD,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,QAAQ,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1G,CAAC;IACH,CAAC,CAAC,CAAC;IACH,IAAI,GAAG,KAAK,SAAS;QAAE,MAAM,GAAG,CAAC;IACjC,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,OAAO,EAAE,oBAAoB,IAAI,UAAU,EAAE,CAAC"}

package/dist/datafile.d.ts

@@ -0,0 +1,62 @@
+import type { Node } from "./ast.ts";
+/** Something a data file may not hold, at UTF-16 offsets into its text. */
+export interface DataFileProblem {
+    start: number;
+    end: number;
+    message: string;
+}
+/** A name in a data file that refers to a declared resource: one imported from a data file, or exported by this one. */
+export declare class Reference {
+    readonly name: string;
+    constructor(name: string);
+}
+/** A value in a data file: a literal, or a reference to a declared resource. */
+export type DataValue = null | boolean | number | string | Reference | DataValue[] | {
+    [field: string]: DataValue;
+};
+/** An `import { name } from "…"`: of a connector's constructors (`from "…/resources"`), or of another data file's resource. */
+export interface DataFileImport {
+    kind: "constructors" | "file";
+    /** The specifier as written. */
+    source: string;
+    /** The name the other module exports. */
+    imported: string;
+    /** The name it has in this file. */
+    local: string;
+    start: number;
+}
+/** An `export const name = vendor.type({ … })`. */
+export interface DataFileExport {
+    name: string;
+    /** The local name of the constructors it calls (`github`). */
+    vendor: string;
+    type: string;
+    desired: {
+        [field: string]: DataValue;
+    };
+    /** The `export const` statement. */
+    start: number;
+    end: number;
+}
+export interface DataFile {
+    imports: DataFileImport[];
+    /** Each `export const` whose value is in the subset. */
+    exports: DataFileExport[];
+    /** Every name an `export const` declares, its value in the subset or not. */
+    declared: string[];
+    problems: DataFileProblem[];
+}
+/**
+ * Reads a data file's program without running it: its imports, each `export const` resource
+ * with its fields evaluated, and everything outside the data-file subset as a problem that says
+ * what to write instead.
+ *
+ * The subset: named imports, from a connector's `…/resources` entry or a `.ts` data file;
+ * `export const <name> = <vendor>.<type>({ … })`, one per statement, its argument built of
+ * strings (template literals without `${}` too), numbers, booleans, null, objects and arrays,
+ * and names of resources this file declares or imports; and `export default [a, b]`.
+ *
+ * `root` is the directory relative imports must stay in: by default the nearest `resources/`
+ * directory above `filename`, else the file's own.
+ */
+export declare function readDataFile(program: Node, filename: string, root?: string): DataFile;

package/dist/datafile.js

@@ -0,0 +1,326 @@
+import { basename, dirname, join } from "node:path";
+import { inside, nearestDir, RELATIVE } from "./paths.js";
+/** A name in a data file that refers to a declared resource: one imported from a data file, or exported by this one. */
+export class Reference {
+    name;
+    constructor(name) {
+        this.name = name;
+    }
+}
+/** A connector's constructors entry: a package specifier that ends in `/resources`. */
+const CONSTRUCTORS = /^(@[a-z0-9-~][a-z0-9-._~]*\/)?[a-z0-9-~][a-z0-9-._~]*\/resources$/;
+const SHAPE = "a data file holds only imports, `export const <name> = <vendor>.<type>({ … })` and `export default [ … ]`";
+const IMPORTS = "import resource constructors from a connector's resources entry " +
+    '(`import { github } from "@sanoma-ai/connector-github/resources"`) ' +
+    'and resources from other data files (`import { site } from "./github.ts"`)';
+const VALUES = "write a string, number, boolean, null, object or array, or name a declared resource";
+/**
+ * Reads a data file's program without running it: its imports, each `export const` resource
+ * with its fields evaluated, and everything outside the data-file subset as a problem that says
+ * what to write instead.
+ *
+ * The subset: named imports, from a connector's `…/resources` entry or a `.ts` data file;
+ * `export const <name> = <vendor>.<type>({ … })`, one per statement, its argument built of
+ * strings (template literals without `${}` too), numbers, booleans, null, objects and arrays,
+ * and names of resources this file declares or imports; and `export default [a, b]`.
+ *
+ * `root` is the directory relative imports must stay in: by default the nearest `resources/`
+ * directory above `filename`, else the file's own.
+ */
+export function readDataFile(program, filename, root = nearestDir(filename, ["resources"])) {
+    const problems = [];
+    const fail = (node, message) => problems.push({ start: node.start, end: node.end, message });
+    const imports = [];
+    const exports = [];
+    // Names a refused import or declaration binds: reported once, where they are bound.
+    const refused = new Set();
+    // Imports and top-level names first, each once: imports are hoisted, and a reference may name
+    // a resource declared further down. An unexported const is refused where it is declared, not
+    // again where it is used.
+    const bound = new Set();
+    const bind = (id) => {
+        if (bound.has(id.name))
+            fail(id, `${id.name} is declared twice in this file: give each its own name`);
+        bound.add(id.name);
+    };
+    const declared = new Set();
+    for (const s of program.body) {
+        if (s.type === "ImportDeclaration") {
+            for (const sp of s.specifiers)
+                bind(sp.local);
+            readImport(s);
+            continue;
+        }
+        const decl = s.type === "ExportNamedDeclaration" ? s.declaration : s;
+        if (decl?.type !== "VariableDeclaration")
+            continue;
+        for (const d of decl.declarations) {
+            if (d.id.type !== "Identifier")
+                continue;
+            bind(d.id);
+            (decl === s ? refused : declared).add(d.id.name);
+        }
+    }
+    for (const s of program.body) {
+        switch (s.type) {
+            case "ImportDeclaration":
+                break;
+            case "ExportNamedDeclaration":
+                readExport(s);
+                break;
+            case "ExportDefaultDeclaration":
+                readDefault(s);
+                break;
+            case "ExportAllDeclaration":
+                fail(s, `export * is not allowed in a data file: ${SHAPE}`);
+                break;
+            case "VariableDeclaration": {
+                const name = s.declarations[0]?.id?.name;
+                fail(s, name === undefined
+                    ? `an unexported declaration is not allowed in a data file: ${SHAPE}`
+                    : `\`${s.kind} ${name}\` is not allowed in a data file: export it as a resource, \`export const ${name} = <vendor>.<type>({ … })\`, or write its value where it is used`);
+                break;
+            }
+            default:
+                fail(s, `${describe(s)} is not allowed in a data file: ${SHAPE}`);
+        }
+    }
+    function readImport(s) {
+        const spec = s.source.value;
+        if (s.importKind === "type") {
+            fail(s, "`import type` is not allowed in a data file: it holds values only, and the constructors type them");
+            return;
+        }
+        const refusal = whyRefused(spec);
+        if (refusal) {
+            fail(s.source, `import "${spec}" is not allowed in a data file: ${refusal}`);
+            for (const sp of s.specifiers)
+                refused.add(sp.local.name);
+            return;
+        }
+        if (!s.specifiers.length) {
+            fail(s, `import "${spec}" is not allowed in a data file: it imports nothing, and a data file runs no code`);
+            return;
+        }
+        for (const sp of s.specifiers) {
+            if (sp.type !== "ImportSpecifier") {
+                const how = sp.type === "ImportNamespaceSpecifier" ? `import * as ${sp.local.name}` : `import ${sp.local.name}`;
+                fail(sp, `${how} is not allowed in a data file: import the names you use, \`import { name } from "${spec}"\``);
+                continue;
+            }
+            if (sp.importKind === "type") {
+                fail(sp, "`type` imports are not allowed in a data file: it holds values only, and the constructors type them");
+                continue;
+            }
+            const imported = sp.imported.name ?? sp.imported.value;
+            const kind = RELATIVE.test(spec) ? "file" : "constructors";
+            imports.push({ kind, source: spec, imported, local: sp.local.name, start: sp.start });
+        }
+    }
+    /** Why an import's specifier is not allowed in a data file, or undefined when it is. */
+    function whyRefused(spec) {
+        if (!RELATIVE.test(spec))
+            return CONSTRUCTORS.test(spec) ? undefined : IMPORTS;
+        if (!spec.endsWith(".ts"))
+            return "name the data file with its `.ts` extension";
+        if (!inside(root, join(dirname(filename), spec))) {
+            return `it reaches outside ${basename(root)}/; import only other data files`;
+        }
+        return undefined;
+    }
+    function readExport(s) {
+        const decl = s.declaration;
+        if (!decl) {
+            fail(s, s.source
+                ? `export … from "${s.source.value}" is not allowed in a data file: import what you reference, and export only resources declared here`
+                : "export { … } is not allowed in a data file: export each resource where it is declared, `export const name = <vendor>.<type>({ … })`");
+            return;
+        }
+        if (decl.type !== "VariableDeclaration") {
+            fail(s, `${describe(decl)} is not allowed in a data file: ${SHAPE}`);
+            return;
+        }
+        if (decl.kind !== "const") {
+            fail(s, `\`export ${decl.kind}\` is not allowed in a data file: use \`export const\``);
+            return;
+        }
+        if (decl.declarations.length !== 1) {
+            fail(s, "declare one resource per `export const`");
+            return;
+        }
+        const [d] = decl.declarations;
+        if (d.id.type !== "Identifier") {
+            fail(d.id, "an `export const` names one resource: `export const name = <vendor>.<type>({ … })`");
+            return;
+        }
+        const name = d.id.name;
+        // A second declaration of the name was reported where it is bound.
+        if (exports.some((e) => e.name === name))
+            return;
+        const init = d.init;
+        const callee = init?.type === "CallExpression" ? init.callee : undefined;
+        if (callee?.type !== "MemberExpression" ||
+            callee.computed ||
+            callee.object.type !== "Identifier" ||
+            callee.property.type !== "Identifier") {
+            fail(init ?? d, `export const ${name} must be a resource constructor call, \`<vendor>.<type>({ … })\`, with <vendor> imported from a connector's resources entry`);
+            return;
+        }
+        const vendor = callee.object.name;
+        const type = callee.property.name;
+        if (refused.has(vendor))
+            return;
+        if (imports.find((i) => i.local === vendor)?.kind !== "constructors") {
+            fail(callee.object, `${vendor} is not a connector's resource constructors: import it from the connector's resources entry, \`import { ${vendor} } from "@sanoma-ai/connector-${vendor}/resources"\``);
+            return;
+        }
+        const [arg] = init.arguments;
+        if (init.arguments.length !== 1 || arg.type !== "ObjectExpression") {
+            fail(init, `${vendor}.${type} takes one object literal: \`${vendor}.${type}({ … })\``);
+            return;
+        }
+        const desired = value(arg);
+        if (desired !== undefined) {
+            exports.push({ name, vendor, type, desired: desired, start: s.start, end: s.end });
+        }
+    }
+    function readDefault(s) {
+        const list = s.declaration;
+        if (list.type !== "ArrayExpression") {
+            fail(list, "export default must list this file's resources: `export default [a, b]`");
+            return;
+        }
+        for (const el of list.elements) {
+            if (el?.type !== "Identifier") {
+                fail(el ?? list, "export default must list this file's resources by name: `export default [a, b]`");
+            }
+            else if (!declared.has(el.name)) {
+                fail(el, `${el.name} is not declared in this file: export default lists this file's resources`);
+            }
+        }
+    }
+    /** The value an expression stands for, or undefined (with a problem) when the subset has none. */
+    function value(node) {
+        switch (node.type) {
+            case "Literal":
+                if (node.regex)
+                    return refuse(node, "a regular expression is not allowed in a data file: write it as a string");
+                if (node.bigint !== undefined && node.bigint !== null)
+                    return refuse(node, "a bigint is not allowed in a data file: write a number, or a string");
+                return node.value;
+            case "TemplateLiteral":
+                if (node.expressions.length) {
+                    return refuse(node, "a template with `${…}` is not allowed in a data file: write the string out");
+                }
+                return node.quasis[0].value.cooked;
+            case "UnaryExpression":
+                if (node.operator === "-" && node.argument.type === "Literal" && typeof node.argument.value === "number") {
+                    return -node.argument.value;
+                }
+                return refuse(node, `\`${node.operator}\` is not allowed in a data file: write the value out`);
+            case "ArrayExpression": {
+                const items = [];
+                let ok = true;
+                for (const el of node.elements) {
+                    const item = el === null
+                        ? refuse(node, "an empty array slot is not allowed in a data file: write null")
+                        : el.type === "SpreadElement"
+                            ? refuse(el, "a spread is not allowed in a data file: write the items out, so the reader sees each")
+                            : value(el);
+                    if (item === undefined)
+                        ok = false;
+                    else
+                        items.push(item);
+                }
+                return ok ? items : undefined;
+            }
+            case "ObjectExpression": {
+                const fields = new Map();
+                let ok = true;
+                for (const p of node.properties) {
+                    const field = property(p);
+                    if (field && fields.has(field[0]))
+                        fail(p, `${field[0]} is given twice: give each field once`);
+                    if (!field || fields.has(field[0]))
+                        ok = false;
+                    else
+                        fields.set(...field);
+                }
+                // fromEntries makes each field an own property, even one named `__proto__`.
+                return ok ? Object.fromEntries(fields) : undefined;
+            }
+            case "Identifier":
+                return reference(node);
+            case "MemberExpression": {
+                let base = node;
+                while (base.type === "MemberExpression")
+                    base = base.object;
+                if (base.type === "Identifier" && base.name === "process") {
+                    return refuse(node, "process is not allowed in a data file: it is read without running, so it cannot read the environment; write the value out, and leave secrets to drivers");
+                }
+                return refuse(node, "member access is not allowed in a data file: write the value out, or name the resource itself (`site`), not one of its fields");
+            }
+            case "CallExpression":
+                return refuse(node, node.callee.type === "MemberExpression" &&
+                    node.callee.object.type === "Identifier" &&
+                    imports.some((i) => i.kind === "constructors" && i.local === node.callee.object.name)
+                    ? "a resource is declared at the top of a data file: give it its own `export const` and name it here"
+                    : "a call is not allowed in a data file: write the value out; the reader never runs code");
+            case "NewExpression":
+                return refuse(node, "`new` is not allowed in a data file: write the value out (a date as an ISO 8601 string)");
+            case "ArrowFunctionExpression":
+            case "FunctionExpression":
+                return refuse(node, "a function is not allowed in a data file: a field holds a value, and code belongs in a workflow");
+            case "TSAsExpression":
+            case "TSSatisfiesExpression":
+            case "TSTypeAssertion":
+            case "TSNonNullExpression":
+                return refuse(node, "a type assertion is not allowed in a data file: leave it out; the constructor types the value");
+            default:
+                return refuse(node, `${describe(node)} is not allowed in a data file: ${VALUES}`);
+        }
+    }
+    function property(p) {
+        if (p.type === "SpreadElement") {
+            return refuse(p, "a spread is not allowed in a data file: write the fields out, so the reader sees each");
+        }
+        if (p.kind !== "init" || p.method) {
+            return refuse(p, "a method or accessor is not allowed in a data file: a field holds a value");
+        }
+        if (p.computed)
+            return refuse(p.key, "a computed key is not allowed in a data file: write the field's name");
+        const key = p.key.type === "Identifier" ? p.key.name : p.key.type === "Literal" ? String(p.key.value) : undefined;
+        if (key === undefined)
+            return refuse(p.key, "write the field's name, or a string");
+        const v = value(p.value);
+        return v === undefined ? undefined : [key, v];
+    }
+    function reference(node) {
+        const name = node.name;
+        if (name === "undefined")
+            return refuse(node, "undefined is not allowed in a data file: leave the field out, or write null");
+        const imported = imports.find((i) => i.local === name);
+        if (imported?.kind === "constructors") {
+            return refuse(node, `${name} is a connector's resource constructors, not a resource: name a declared resource`);
+        }
+        if (imported || declared.has(name))
+            return new Reference(name);
+        if (refused.has(name))
+            return undefined;
+        return refuse(node, `${name} is not a resource this file declares or imports from a data file: write the value out, or import the resource`);
+    }
+    function refuse(node, message) {
+        fail(node, message);
+        return undefined;
+    }
+    return { imports, exports, declared: [...declared], problems };
+}
+/** A node's kind, for a message: `a function declaration`, `an if statement`. */
+function describe(node) {
+    const words = String(node.type)
+        .replace(/^TS/, "TypeScript ")
+        .replace(/([a-z])([A-Z])/g, "$1 $2")
+        .toLowerCase();
+    return `${/^[aeiou]/.test(words) ? "an" : "a"} ${words}`;
+}
+//# sourceMappingURL=datafile.js.map

package/dist/datafile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"datafile.js","sourceRoot":"","sources":["../src/datafile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEpD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAc1D,wHAAwH;AACxH,MAAM,OAAO,SAAS;IACX,IAAI,CAAS;IACtB,YAAY,IAAY;QACtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAsCD,uFAAuF;AACvF,MAAM,YAAY,GAAG,mEAAmE,CAAC;AAEzF,MAAM,KAAK,GACT,2GAA2G,CAAC;AAC9G,MAAM,OAAO,GACX,kEAAkE;IAClE,qEAAqE;IACrE,4EAA4E,CAAC;AAC/E,MAAM,MAAM,GAAG,qFAAqF,CAAC;AAErG;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,YAAY,CAC1B,OAAa,EACb,QAAgB,EAChB,IAAI,GAAW,UAAU,CAAC,QAAQ,EAAE,CAAC,WAAW,CAAC,CAAC;IAElD,MAAM,QAAQ,GAAsB,EAAE,CAAC;IACvC,MAAM,IAAI,GAAG,CAAC,IAAoC,EAAE,OAAe,EAAE,EAAE,CACrE,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;IAC/D,MAAM,OAAO,GAAqB,EAAE,CAAC;IACrC,MAAM,OAAO,GAAqB,EAAE,CAAC;IACrC,oFAAoF;IACpF,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAElC,8FAA8F;IAC9F,6FAA6F;IAC7F,0BAA0B;IAC1B,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,MAAM,IAAI,GAAG,CAAC,EAAQ,EAAE,EAAE;QACxB,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,IAAI,yDAAyD,CAAC,CAAC;QACtG,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC,CAAC;IACF,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;IACnC,KAAK,MAAM,CAAC,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QAC7B,IAAI,CAAC,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;YACnC,KAAK,MAAM,EAAE,IAAI,CAAC,CAAC,UAAU;gBAAE,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;YAC9C,UAAU,CAAC,CAAC,CAAC,CAAC;YACd,SAAS;QACX,CAAC;QACD,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,KAAK,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;QACrE,IAAI,IAAI,EAAE,IAAI,KAAK,qBAAqB;YAAE,SAAS;QACnD,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YAClC,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,KAAK,YAAY;gBAAE,SAAS;YACzC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACX,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAED,KAAK,MAAM,CAAC,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QAC7B,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;YACf,KAAK,mBAAmB;gBACtB,MAAM;YACR,KAAK,wBAAwB;gBAC3B,UAAU,CAAC,CAAC,CAAC,CAAC;gBACd,MAAM;YACR,KAAK,0BAA0B;gBAC7B,WAAW,CAAC,CAAC,CAAC,CAAC;gBACf,MAAM;YACR,KAAK,sBAAsB;gBACzB,IAAI,CAAC,CAAC,EAAE,2CAA2C,KAAK,EAAE,CAAC,CAAC;gBAC5D,MAAM;YACR,KAAK,qBAAqB,EAAE,CAAC;gBAC3B,MAAM,IAAI,GAAG,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC;gBACzC,IAAI,CACF,CAAC,EACD,IAAI,KAAK,SAAS;oBAChB,CAAC,CAAC,4DAA4D,KAAK,EAAE;oBACrE,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,IAAI,IAAI,6EAA6E,IAAI,kEAAkE,CAC3K,CAAC;gBACF,MAAM;YACR,CAAC;YACD;gBACE,IAAI,CAAC,CAAC,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC,mCAAmC,KAAK,EAAE,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IAED,SAAS,UAAU,CAAC,CAAO;QACzB,MAAM,IAAI,GAAW,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;QACpC,IAAI,CAAC,CAAC,UAAU,KAAK,MAAM,EAAE,CAAC;YAC5B,IAAI,CAAC,CAAC,EAAE,mGAAmG,CAAC,CAAC;YAC7G,OAAO;QACT,CAAC;QACD,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,WAAW,IAAI,oCAAoC,OAAO,EAAE,CAAC,CAAC;YAC7E,KAAK,MAAM,EAAE,IAAI,CAAC,CAAC,UAAU;gBAAE,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC1D,OAAO;QACT,CAAC;QACD,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YACzB,IAAI,CAAC,CAAC,EAAE,WAAW,IAAI,mFAAmF,CAAC,CAAC;YAC5G,OAAO;QACT,CAAC;QACD,KAAK,MAAM,EAAE,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;YAC9B,IAAI,EAAE,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;gBAClC,MAAM,GAAG,GAAG,EAAE,CAAC,IAAI,KAAK,0BAA0B,CAAC,CAAC,CAAC,eAAe,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;gBAChH,IAAI,CAAC,EAAE,EAAE,GAAG,GAAG,qFAAqF,IAAI,KAAK,CAAC,CAAC;gBAC/G,SAAS;YACX,CAAC;YACD,IAAI,EAAE,CAAC,UAAU,KAAK,MAAM,EAAE,CAAC;gBAC7B,IAAI,CAAC,EAAE,EAAE,qGAAqG,CAAC,CAAC;gBAChH,SAAS;YACX,CAAC;YACD,MAAM,QAAQ,GAAW,EAAE,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;YAC/D,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC;YAC3D,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC;QACxF,CAAC;IACH,CAAC;IAED,wFAAwF;IACxF,SAAS,UAAU,CAAC,IAAY;QAC9B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;YAAE,OAAO,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC;QAC/E,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO,6CAA6C,CAAC;QAChF,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;YACjD,OAAO,sBAAsB,QAAQ,CAAC,IAAI,CAAC,iCAAiC,CAAC;QAC/E,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,SAAS,UAAU,CAAC,CAAO;QACzB,MAAM,IAAI,GAAG,CAAC,CAAC,WAAW,CAAC;QAC3B,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,IAAI,CACF,CAAC,EACD,CAAC,CAAC,MAAM;gBACN,CAAC,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,KAAK,qGAAqG;gBACvI,CAAC,CAAC,qIAAqI,CAC1I,CAAC;YACF,OAAO;QACT,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,qBAAqB,EAAE,CAAC;YACxC,IAAI,CAAC,CAAC,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,mCAAmC,KAAK,EAAE,CAAC,CAAC;YACrE,OAAO;QACT,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC1B,IAAI,CAAC,CAAC,EAAE,YAAY,IAAI,CAAC,IAAI,wDAAwD,CAAC,CAAC;YACvF,OAAO;QACT,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACnC,IAAI,CAAC,CAAC,EAAE,yCAAyC,CAAC,CAAC;YACnD,OAAO;QACT,CAAC;QACD,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QAC9B,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;YAC/B,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,oFAAoF,CAAC,CAAC;YACjG,OAAO;QACT,CAAC;QACD,MAAM,IAAI,GAAW,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC;QAC/B,mEAAmE;QACnE,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC;YAAE,OAAO;QACjD,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC;QACpB,MAAM,MAAM,GAAG,IAAI,EAAE,IAAI,KAAK,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;QACzE,IACE,MAAM,EAAE,IAAI,KAAK,kBAAkB;YACnC,MAAM,CAAC,QAAQ;YACf,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,YAAY;YACnC,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,YAAY,EACrC,CAAC;YACD,IAAI,CACF,IAAI,IAAI,CAAC,EACT,gBAAgB,IAAI,6HAA6H,CAClJ,CAAC;YACF,OAAO;QACT,CAAC;QACD,MAAM,MAAM,GAAW,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;QAC1C,MAAM,IAAI,GAAW,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC1C,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC;YAAE,OAAO;QAChC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,MAAM,CAAC,EAAE,IAAI,KAAK,cAAc,EAAE,CAAC;YACrE,IAAI,CACF,MAAM,CAAC,MAAM,EACb,GAAG,MAAM,2GAA2G,MAAM,iCAAiC,MAAM,eAAe,CACjL,CAAC;YACF,OAAO;QACT,CAAC;QACD,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;QAC7B,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;YACnE,IAAI,CAAC,IAAI,EAAE,GAAG,MAAM,IAAI,IAAI,gCAAgC,MAAM,IAAI,IAAI,WAAW,CAAC,CAAC;YACvF,OAAO;QACT,CAAC;QACD,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3B,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAoC,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;QAClH,CAAC;IACH,CAAC;IAED,SAAS,WAAW,CAAC,CAAO;QAC1B,MAAM,IAAI,GAAG,CAAC,CAAC,WAAW,CAAC;QAC3B,IAAI,IAAI,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;YACpC,IAAI,CAAC,IAAI,EAAE,yEAAyE,CAAC,CAAC;YACtF,OAAO;QACT,CAAC;QACD,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC/B,IAAI,EAAE,EAAE,IAAI,KAAK,YAAY,EAAE,CAAC;gBAC9B,IAAI,CAAC,EAAE,IAAI,IAAI,EAAE,iFAAiF,CAAC,CAAC;YACtG,CAAC;iBAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,IAAI,2EAA2E,CAAC,CAAC;YAClG,CAAC;QACH,CAAC;IACH,CAAC;IAED,kGAAkG;IAClG,SAAS,KAAK,CAAC,IAAU;QACvB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,SAAS;gBACZ,IAAI,IAAI,CAAC,KAAK;oBAAE,OAAO,MAAM,CAAC,IAAI,EAAE,0EAA0E,CAAC,CAAC;gBAChH,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI;oBACnD,OAAO,MAAM,CAAC,IAAI,EAAE,qEAAqE,CAAC,CAAC;gBAC7F,OAAO,IAAI,CAAC,KAAyC,CAAC;YACxD,KAAK,iBAAiB;gBACpB,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;oBAC5B,OAAO,MAAM,CAAC,IAAI,EAAE,4EAA4E,CAAC,CAAC;gBACpG,CAAC;gBACD,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAgB,CAAC;YAC/C,KAAK,iBAAiB;gBACpB,IAAI,IAAI,CAAC,QAAQ,KAAK,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;oBACzG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAC9B,CAAC;gBACD,OAAO,MAAM,CAAC,IAAI,EAAE,KAAK,IAAI,CAAC,QAAQ,uDAAuD,CAAC,CAAC;YACjG,KAAK,iBAAiB,EAAE,CAAC;gBACvB,MAAM,KAAK,GAAgB,EAAE,CAAC;gBAC9B,IAAI,EAAE,GAAG,IAAI,CAAC;gBACd,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAC/B,MAAM,IAAI,GACR,EAAE,KAAK,IAAI;wBACT,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,+DAA+D,CAAC;wBAC/E,CAAC,CAAC,EAAE,CAAC,IAAI,KAAK,eAAe;4BAC3B,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,sFAAsF,CAAC;4BACpG,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;oBAClB,IAAI,IAAI,KAAK,SAAS;wBAAE,EAAE,GAAG,KAAK,CAAC;;wBAC9B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACxB,CAAC;gBACD,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YAChC,CAAC;YACD,KAAK,kBAAkB,EAAE,CAAC;gBACxB,MAAM,MAAM,GAAG,IAAI,GAAG,EAAqB,CAAC;gBAC5C,IAAI,EAAE,GAAG,IAAI,CAAC;gBACd,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;oBAChC,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;oBAC1B,IAAI,KAAK,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;wBAAE,IAAI,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,uCAAuC,CAAC,CAAC;oBAC/F,IAAI,CAAC,KAAK,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;wBAAE,EAAE,GAAG,KAAK,CAAC;;wBAC1C,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC;gBAC5B,CAAC;gBACD,4EAA4E;gBAC5E,OAAO,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACrD,CAAC;YACD,KAAK,YAAY;gBACf,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC;YACzB,KAAK,kBAAkB,EAAE,CAAC;gBACxB,IAAI,IAAI,GAAG,IAAI,CAAC;gBAChB,OAAO,IAAI,CAAC,IAAI,KAAK,kBAAkB;oBAAE,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;gBAC5D,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAC1D,OAAO,MAAM,CACX,IAAI,EACJ,yJAAyJ,CAC1J,CAAC;gBACJ,CAAC;gBACD,OAAO,MAAM,CACX,IAAI,EACJ,+HAA+H,CAChI,CAAC;YACJ,CAAC;YACD,KAAK,gBAAgB;gBACnB,OAAO,MAAM,CACX,IAAI,EACJ,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,kBAAkB;oBACrC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,YAAY;oBACxC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,cAAc,IAAI,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;oBACrF,CAAC,CAAC,mGAAmG;oBACrG,CAAC,CAAC,uFAAuF,CAC5F,CAAC;YACJ,KAAK,eAAe;gBAClB,OAAO,MAAM,CAAC,IAAI,EAAE,yFAAyF,CAAC,CAAC;YACjH,KAAK,yBAAyB,CAAC;YAC/B,KAAK,oBAAoB;gBACvB,OAAO,MAAM,CACX,IAAI,EACJ,iGAAiG,CAClG,CAAC;YACJ,KAAK,gBAAgB,CAAC;YACtB,KAAK,uBAAuB,CAAC;YAC7B,KAAK,iBAAiB,CAAC;YACvB,KAAK,qBAAqB;gBACxB,OAAO,MAAM,CACX,IAAI,EACJ,+FAA+F,CAChG,CAAC;YACJ;gBACE,OAAO,MAAM,CAAC,IAAI,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,mCAAmC,MAAM,EAAE,CAAC,CAAC;QACtF,CAAC;IACH,CAAC;IAED,SAAS,QAAQ,CAAC,CAAO;QACvB,IAAI,CAAC,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;YAC/B,OAAO,MAAM,CAAC,CAAC,EAAE,uFAAuF,CAAC,CAAC;QAC5G,CAAC;QACD,IAAI,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;YAClC,OAAO,MAAM,CAAC,CAAC,EAAE,2EAA2E,CAAC,CAAC;QAChG,CAAC;QACD,IAAI,CAAC,CAAC,QAAQ;YAAE,OAAO,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,sEAAsE,CAAC,CAAC;QAC7G,MAAM,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAClH,IAAI,GAAG,KAAK,SAAS;YAAE,OAAO,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,qCAAqC,CAAC,CAAC;QACnF,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACzB,OAAO,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,SAAS,SAAS,CAAC,IAAU;QAC3B,MAAM,IAAI,GAAW,IAAI,CAAC,IAAI,CAAC;QAC/B,IAAI,IAAI,KAAK,WAAW;YACtB,OAAO,MAAM,CAAC,IAAI,EAAE,6EAA6E,CAAC,CAAC;QACrG,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC;QACvD,IAAI,QAAQ,EAAE,IAAI,KAAK,cAAc,EAAE,CAAC;YACtC,OAAO,MAAM,CAAC,IAAI,EAAE,GAAG,IAAI,mFAAmF,CAAC,CAAC;QAClH,CAAC;QACD,IAAI,QAAQ,IAAI,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;QAC/D,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,OAAO,SAAS,CAAC;QACxC,OAAO,MAAM,CACX,IAAI,EACJ,GAAG,IAAI,gHAAgH,CACxH,CAAC;IACJ,CAAC;IAED,SAAS,MAAM,CAAC,IAAoC,EAAE,OAAe;QACnE,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACpB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,GAAG,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC;AACjE,CAAC;AAED,iFAAiF;AACjF,SAAS,QAAQ,CAAC,IAAU;IAC1B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;SAC5B,OAAO,CAAC,KAAK,EAAE,aAAa,CAAC;SAC7B,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC;SACnC,WAAW,EAAE,CAAC;IACjB,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,KAAK,EAAE,CAAC;AAC3D,CAAC"}

package/dist/db.d.ts

@@ -0,0 +1,58 @@
+import { DBOSClient } from "@dbos-inc/dbos-sdk";
+import { Client, Pool } from "pg";
+/** A connection or a pool: what the queries take. */
+export type Db = Pick<Pool | Client, "query">;
+/** Where the credentials set from the app live. */
+export declare const CREDENTIALS_TABLE = "sanoma_credentials";
+/** Where the Postgres ledger keeps its records. */
+export declare const LEDGER_TABLE = "sanoma_ledger";
+/** The Postgres error code of `err`, or an empty string when it has none. */
+export declare const pgCode: (err: unknown) => string;
+/** True for the failure of a create that another process won: what was to be made is there. */
+export declare const madeAlready: (err: unknown) => boolean;
+/**
+ * A pool on the config's database for `what` (a word for the messages). An idle connection that
+ * drops (Postgres restarted) is replaced on the next query; unheard, it would end the process.
+ */
+export declare function openPool(databaseUrl: string, what: string): Pool;
+/**
+ * What every DBOS handle on the config's database is given (`DBOS.setConfig`, `dbosClient`): DBOS
+ * is told not to set Postgres's `idle_in_transaction_session_timeout` on each connection of its
+ * pool. It sends that `SET` from the pool's `connect` event without awaiting it (dbos-sdk 5.2.11,
+ * dist/src/system_database.js:691), so the pool hands the connection out while it runs: two
+ * queries at once on one client, which pg deprecates. `prepareDatabase` sets the same 60 s guard
+ * on the database instead. Remove the switch when DBOS awaits its `SET`.
+ */
+export declare const DBOS_DATABASE_OPTIONS: {
+    readonly systemDatabaseIdleTransactionTimeoutMs: 0;
+};
+/**
+ * A DBOS client of the app `applicationName` on the database at `databaseUrl`, as every client of
+ * the runtime, its tests and `@sanoma-ai/testing` make one (`DBOS_DATABASE_OPTIONS`).
+ */
+export declare const dbosClient: (databaseUrl: string, applicationName?: string) => Promise<DBOSClient>;
+/** A pool opened on first use, once its database is prepared, and ended by `close`. */
+export interface LazyPool {
+    db(): Promise<Pool>;
+    close(): Promise<void>;
+}
+/**
+ * A pool for `what` on the database at `databaseUrl`, opened on the first `db()` once the
+ * database is prepared (`prepareDatabase`). A preparation that fails lets the pool go, so the
+ * next `db()` tries again. `close` ends the pool, for good: a `db()` after it is refused.
+ */
+export declare function lazyPool(databaseUrl: string, what: string): LazyPool;
+/**
+ * Makes the database at `databaseUrl` ready for the runtime, once per process and URL: the
+ * database itself and DBOS's tables when they are not there yet (as a worker's launch makes
+ * them; credentials may be set, and a ledger read, before any worker has run), then the
+ * credentials and ledger tables, and its idle-transaction timeout (`guardIdleTransactions`).
+ * Two processes preparing one database both succeed. A
+ * preparation that fails is forgotten, so the next call tries again.
+ */
+export declare function prepareDatabase(databaseUrl: string): Promise<void>;
+/**
+ * Runs `ddl` (`CREATE TABLE IF NOT EXISTS`, and the like) on `db`. Two processes racing to create
+ * the same table both succeed; any other failure names the `what` table, with its cause.
+ */
+export declare function createTable(db: Db, ddl: string, what: string): Promise<void>;