@sanoma-ai/workflows 0.6.0 → 0.7.1

package/dist/supervisor.js

@@ -0,0 +1,68 @@
+import { warn } from "./log.js";
+import { errorMessage } from "./shared.js";
+import { startWorker } from "./worker.js";
+/**
+ * Starts a worker on `config` that stops itself when idle with a wakeup declared (`onStopped`
+ * in `WorkerOptions`), and a fresh one each time `resume` or `wake` asks after it did. Throws
+ * when the first does not start. A write heard while a worker starts or runs may land after its last check
+ * for being idle, so a worker that stops itself after one is started again at once: it stops
+ * again on its own when nothing came of it.
+ */
+export async function superviseWorker(config, options = {}) {
+    const { onStopped, selfStop = true, ...workerOptions } = options;
+    let worker;
+    let starting;
+    let closed = false;
+    // A write while the worker starts or runs, since it began starting.
+    let heard = false;
+    const launch = async () => {
+        heard = false;
+        const started = await startWorker(config, { ...workerOptions, ...(selfStop && { onStopped: selfStopped }) });
+        if (closed)
+            await started.stop();
+        else
+            worker = started;
+    };
+    const selfStopped = (stopped) => {
+        worker = undefined;
+        if (closed)
+            return;
+        // Resumed first, so `stopped` is false when `onStopped` looks.
+        if (heard)
+            void supervisor.resume();
+        onStopped?.(stopped);
+    };
+    const supervisor = {
+        get stopped() {
+            return !closed && !worker && !starting;
+        },
+        resume() {
+            if (closed)
+                return Promise.resolve();
+            if (worker) {
+                heard = true;
+                return Promise.resolve();
+            }
+            if (starting) {
+                heard = true;
+                return starting;
+            }
+            return (starting = launch()
+                .catch((err) => warn(`the worker could not start again: ${errorMessage(err)}`))
+                .finally(() => {
+                starting = undefined;
+            }));
+        },
+        wake: () => (supervisor.stopped ? supervisor.resume() : Promise.resolve()),
+        async stop() {
+            closed = true;
+            await starting;
+            const running = worker;
+            worker = undefined;
+            await running?.stop();
+        },
+    };
+    await launch();
+    return supervisor;
+}
+//# sourceMappingURL=supervisor.js.map

package/dist/supervisor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"supervisor.js","sourceRoot":"","sources":["../src/supervisor.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAmC,MAAM,aAAa,CAAC;AAqC3E;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,MAAoB,EAAE,OAAO,GAAsB,EAAE;IACzF,MAAM,EAAE,SAAS,EAAE,QAAQ,GAAG,IAAI,EAAE,GAAG,aAAa,EAAE,GAAG,OAAO,CAAC;IACjE,IAAI,MAA0B,CAAC;IAC/B,IAAI,QAAmC,CAAC;IACxC,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,oEAAoE;IACpE,IAAI,KAAK,GAAG,KAAK,CAAC;IAElB,MAAM,MAAM,GAAG,KAAK,IAAI,EAAE;QACxB,KAAK,GAAG,KAAK,CAAC;QACd,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,EAAE,GAAG,aAAa,EAAE,GAAG,CAAC,QAAQ,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC,CAAC;QAC7G,IAAI,MAAM;YAAE,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC;;YAC5B,MAAM,GAAG,OAAO,CAAC;IACxB,CAAC,CAAC;IACF,MAAM,WAAW,GAAG,CAAC,OAAiB,EAAE,EAAE;QACxC,MAAM,GAAG,SAAS,CAAC;QACnB,IAAI,MAAM;YAAE,OAAO;QACnB,+DAA+D;QAC/D,IAAI,KAAK;YAAE,KAAK,UAAU,CAAC,MAAM,EAAE,CAAC;QACpC,SAAS,EAAE,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC,CAAC;IAEF,MAAM,UAAU,GAAe;QAC7B,IAAI,OAAO;YACT,OAAO,CAAC,MAAM,IAAI,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC;QACzC,CAAC;QACD,MAAM;YACJ,IAAI,MAAM;gBAAE,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;YACrC,IAAI,MAAM,EAAE,CAAC;gBACX,KAAK,GAAG,IAAI,CAAC;gBACb,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;YAC3B,CAAC;YACD,IAAI,QAAQ,EAAE,CAAC;gBACb,KAAK,GAAG,IAAI,CAAC;gBACb,OAAO,QAAQ,CAAC;YAClB,CAAC;YACD,OAAO,CAAC,QAAQ,GAAG,MAAM,EAAE;iBACxB,KAAK,CAAC,CAAC,GAAY,EAAE,EAAE,CAAC,IAAI,CAAC,qCAAqC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;iBACvF,OAAO,CAAC,GAAG,EAAE;gBACZ,QAAQ,GAAG,SAAS,CAAC;YACvB,CAAC,CAAC,CAAC,CAAC;QACR,CAAC;QACD,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QAC1E,KAAK,CAAC,IAAI;YACR,MAAM,GAAG,IAAI,CAAC;YACd,MAAM,QAAQ,CAAC;YACf,MAAM,OAAO,GAAG,MAAM,CAAC;YACvB,MAAM,GAAG,SAAS,CAAC;YACnB,MAAM,OAAO,EAAE,IAAI,EAAE,CAAC;QACxB,CAAC;KACF,CAAC;IACF,MAAM,MAAM,EAAE,CAAC;IACf,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/dist/version.d.ts

@@ -7,8 +7,10 @@ export declare const RUNTIME_VERSION: string;
  * 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).
  * 3: a start the policy holds waits on its approval before the body (2026-10-21).
+ * 4: a sleep for a duration reads DBOS's clock for its start (2026-10-25).
+ * 5: a scheduled run admits its starter and asks the policy in two steps before the body (2026-10-25).
  */
-export declare const STEP_LAYOUT = 3;
+export declare const STEP_LAYOUT = 5;
 /**
  * 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

package/dist/version.js

@@ -12,8 +12,10 @@ export const RUNTIME_VERSION = JSON.parse(readFileSync(new URL("../package.json"
  * 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).
  * 3: a start the policy holds waits on its approval before the body (2026-10-21).
+ * 4: a sleep for a duration reads DBOS's clock for its start (2026-10-25).
+ * 5: a scheduled run admits its starter and asks the policy in two steps before the body (2026-10-25).
  */
-export const STEP_LAYOUT = 3;
+export const STEP_LAYOUT = 5;
 let dbosVersion;
 /** The installed DBOS SDK's version, read from its package.json (which its exports don't expose). */
 function installedDbosVersion() {

package/dist/version.js.map

@@ -1 +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,+FAA+F;AAC/F,MAAM,CAAC,MAAM,eAAe,GAC1B,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC,iBAAiB,EAAE,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAC7E,CAAC,OAAO,CAAC;AAEV;;;;;;GAMG;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"}
+{"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,+FAA+F;AAC/F,MAAM,CAAC,MAAM,eAAe,GAC1B,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC,iBAAiB,EAAE,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAC7E,CAAC,OAAO,CAAC;AAEV;;;;;;;;GAQG;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/wakeup-driver.d.ts

@@ -0,0 +1,128 @@
+import { z } from "zod";
+import { type CallContext, DriverError } from "./op.ts";
+import type { PlanAction } from "./resource.ts";
+import type { WakeupRegistration } from "./wakeup.ts";
+/** An instance as the service shows it (`GET /wakeup/instances/{id}`): the fields read here. */
+declare const instanceSchema: z.ZodObject<{
+    id: z.ZodString;
+    url: z.ZodString;
+    at: z.ZodNullable<z.ZodString>;
+    lastError: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type Instance = z.output<typeof instanceSchema>;
+/** The wakeup service, as the operations use it. Each call fails with a `DriverError`. */
+export interface WakeupApi {
+    /**
+     * `POST /wakeup/instances { url, token }` with the account's token: the instance the token
+     * names, made, or moved to `url` when the account registered it before.
+     */
+    put(url: string, token: string): Promise<{
+        id: string;
+    }>;
+    /** `GET /wakeup/instances/{id}` with the account's token; undefined when there is none (404). */
+    get(id: string): Promise<Instance | undefined>;
+    /** `DELETE /wakeup/instances/{id}` with the account's token; nothing when there is none. */
+    remove(id: string): Promise<void>;
+    /** `PUT /wakeup/wake { at }` with the instance's token, which names the instance. */
+    wake(registration: WakeupRegistration, token: string): Promise<void>;
+}
+/** What the service holds of an instance that registered no wake: a new one's, and one moved to a new URL. */
+export declare const UNREGISTERED: {
+    readonly at: null;
+    readonly lastError: null;
+};
+export declare const fail: (message: string, status: number) => DriverError;
+/**
+ * The wakeup type's operations and `wakeup.register` over `api()`, made on each call. The
+ * instance's token, `SANOMA_WAKEUP_TOKEN`, names the instance: `create` and `update` both post it
+ * with the host's URL (minted and stored first when none is, as for a data file written by hand),
+ * so a new host is the same instance moved, never a replace; `register` sends it.
+ */
+export declare function wakeupCalls(api: () => WakeupApi): {
+    import: ({ id }: {
+        id: string;
+    }) => Promise<{
+        id: string;
+        gone: boolean;
+        state: {
+            id: string;
+            host: string;
+            at: string | null;
+            lastError: string | null;
+        };
+    } | {
+        state?: undefined;
+        id: string;
+        gone: boolean;
+    }>;
+    read: ({ id }: {
+        id: string;
+    }) => Promise<{
+        id: string;
+        gone: boolean;
+        state: {
+            id: string;
+            host: string;
+            at: string | null;
+            lastError: string | null;
+        };
+    } | {
+        state?: undefined;
+        id: string;
+        gone: boolean;
+    }>;
+    plan: (input: {
+        id?: string;
+        desired?: Record<string, unknown>;
+    }) => Promise<{
+        action: PlanAction;
+        planned?: Record<string, unknown>;
+        unknown: string[];
+        replace: string[];
+    }>;
+    create: ({ desired }: {
+        desired: Record<string, unknown>;
+    }, call: CallContext) => Promise<{
+        id: string;
+        state: {
+            id: string;
+            host: string;
+            at: string | null;
+            lastError: string | null;
+        };
+    }>;
+    update: ({ id, desired, expect, }: {
+        id: string;
+        desired: Record<string, unknown>;
+        expect?: {
+            action: PlanAction;
+            replace: string[];
+        };
+    }, call: CallContext) => Promise<{
+        id: string;
+        state: {
+            id: string;
+            host: string;
+            at: string | null;
+            lastError: string | null;
+        };
+    }>;
+    delete: ({ id }: {
+        id: string;
+    }) => Promise<{
+        id: string;
+        gone: true;
+    }>;
+    register: (registration: WakeupRegistration, { secrets }: CallContext) => Promise<{}>;
+};
+/**
+ * The real wakeup service at `SANOMA_WAKEUP_URL`: instances created, read and deleted with
+ * `SANOMA_WAKEUP_ACCOUNT_TOKEN`, each named by its `SANOMA_WAKEUP_TOKEN` (which `create` and
+ * `register` send). `timeoutMs` is how long one request may take: 10 s by default.
+ */
+export declare function sanomaWakeupDriver({ timeoutMs }?: {
+    timeoutMs?: number;
+}): import("./op.ts").Driver;
+/** The wakeup's step for Gherkin tests: an instance at the service before the run, named `wakeup` (`$wakeup.id`). */
+export declare const wakeupSteps: import("./steps.ts").Steps;
+export {};

package/dist/wakeup-driver.js

@@ -0,0 +1,216 @@
+import { z } from "zod";
+import { defineDriver, DriverError, retryableStatus } from "./op.js";
+import { defineSteps } from "./steps.js";
+import { instanceUrl, mintInstanceToken, WAKEUP_TOKEN } from "./wakeup-service.js";
+import { wakeupOps } from "./wakeup-type.js";
+// `sanoma.wakeup`'s operations over a wakeup service (`WakeupApi`): the driver's call it over
+// HTTP (plain `fetch`, the service has no SDK), the fake's (`fakeSanomaWakeup` in `fake.ts`)
+// answer from its state. Both go through `wakeupCalls`, so they plan, post the token and refuse
+// alike. `config.ts` puts the two together as the built-in `sanomaWakeup`.
+/** An instance as the service shows it (`GET /wakeup/instances/{id}`): the fields read here. */
+const instanceSchema = z.object({
+    id: z.string(),
+    url: z.string(),
+    at: z.string().nullable(),
+    lastError: z.string().nullable(),
+});
+/** What the service holds of an instance that registered no wake: a new one's, and one moved to a new URL. */
+export const UNREGISTERED = { at: null, lastError: null };
+export const fail = (message, status) => new DriverError(`sanoma.wakeup: ${message}`, { retryable: retryableStatus(status), status });
+/** The driver's own refusal, before or instead of a call: never retried. */
+const refused = (message, vendorCode) => new DriverError(`sanoma.wakeup: ${message}`, { retryable: false, ...(vendorCode && { vendorCode }) });
+/** A wakeup's state: the service's instance, its URL as `host`. */
+const stateOf = ({ id, url, at, lastError }) => ({ id, host: url, at, lastError });
+/** A URL as the service keeps it (`instanceUrl`, the service's own rule), or as given when the service would refuse it. */
+const normalUrl = (url) => {
+    const checked = instanceUrl(url);
+    return "url" in checked ? checked.url : String(url);
+};
+/**
+ * The wakeup type's operations and `wakeup.register` over `api()`, made on each call. The
+ * instance's token, `SANOMA_WAKEUP_TOKEN`, names the instance: `create` and `update` both post it
+ * with the host's URL (minted and stored first when none is, as for a data file written by hand),
+ * so a new host is the same instance moved, never a replace; `register` sends it.
+ */
+export function wakeupCalls(api) {
+    const read = async ({ id }) => {
+        const found = await api().get(id);
+        return found ? { id, gone: false, state: stateOf(found) } : { id, gone: true };
+    };
+    /**
+     * The instance the stored token names, at the desired host: made or moved, its state as a new
+     * one's (a repeat after a lost reply keeps the wake the service holds, which the next read shows).
+     */
+    const put = async (desired, { secrets }) => {
+        const host = normalUrl(desired.host);
+        const token = await secrets.ensure(WAKEUP_TOKEN, mintInstanceToken);
+        const { id } = await api().put(host, token);
+        const state = { id, host, ...UNREGISTERED };
+        return { id, state };
+    };
+    const plan = async ({ id, desired }) => {
+        const state = id === undefined ? undefined : (await read({ id })).state;
+        const none = { unknown: [], replace: [] };
+        if (!desired)
+            return { action: state ? "delete" : "none", state, ...none };
+        const planned = { host: normalUrl(desired.host) };
+        if (!state)
+            return { action: "create", planned, unknown: ["id"], replace: [] };
+        if (planned.host === state.host)
+            return { action: "none", planned: state, state, ...none };
+        // A move forgets the wake registered at the old URL, as the service does.
+        return { action: "update", planned: { ...state, ...planned, ...UNREGISTERED }, state, ...none };
+    };
+    return {
+        import: read,
+        read,
+        plan: async (input) => {
+            const { state: _, ...out } = await plan(input);
+            return out;
+        },
+        create: ({ desired }, call) => put(desired, call),
+        update: async ({ id, desired, expect, }, call) => {
+            const fresh = await plan({ id, desired });
+            if (expect && (expect.action !== fresh.action || expect.replace.join() !== fresh.replace.join())) {
+                throw refused(`update: the plan changed (${expect.action}, now ${fresh.action})`, "plan_changed");
+            }
+            if (fresh.state && fresh.action === "none")
+                return { id, state: fresh.state };
+            return put(desired, call);
+        },
+        delete: async ({ id }) => {
+            await api().remove(id);
+            return { id, gone: true };
+        },
+        register: async (registration, { secrets }) => {
+            const token = await secrets.get(WAKEUP_TOKEN);
+            if (!token)
+                throw refused(`register: ${WAKEUP_TOKEN} is not set: connect a wakeup service in /setup, then apply the wakeup`);
+            await api().wake(registration, token);
+            return {};
+        },
+    };
+}
+/** The environment variables the driver reads, on every call. */
+const env = z.object({
+    SANOMA_WAKEUP_URL: z.url().optional().describe("the wakeup service's URL: Sanoma's, or your own `sanoma wakeup`"),
+    SANOMA_WAKEUP_ACCOUNT_TOKEN: z
+        .string()
+        .startsWith("swa_", "an account's token starts swa_")
+        .optional()
+        .describe("an account's token at the wakeup service (swa_…), which creates and deletes the instances"),
+    // No check of its form: a host's own wakeup (Cloudflare's alarm) takes this variable too, and
+    // the service refuses a token that is not an instance's.
+    [WAKEUP_TOKEN]: z
+        .string()
+        .optional()
+        .describe("this instance's token at the wakeup service (swi_…), which /setup mints and the wakeup's create registers"),
+});
+/** The variable `name`, read when an operation is called, or the driver's refusal. */
+function required(name) {
+    const value = process.env[name];
+    if (!value)
+        throw refused(`${name} is not set (${env.shape[name].description})`);
+    return value;
+}
+const Posted = z.object({ id: z.string() });
+/** The service's error body. */
+const Problem = z.object({ error: z.string() });
+const instance = (id) => `/wakeup/instances/${encodeURIComponent(id)}`;
+/** The service at `SANOMA_WAKEUP_URL`, read when an operation is called: each request's failure a `DriverError`. */
+function serviceApi(timeoutMs) {
+    const base = required("SANOMA_WAKEUP_URL").replace(/\/+$/, "");
+    if (!URL.canParse(base))
+        throw refused("SANOMA_WAKEUP_URL is not a URL");
+    const account = () => required("SANOMA_WAKEUP_ACCOUNT_TOKEN");
+    /**
+     * One request: its reply parsed by `reply` (none: not read), a 404 `undefined` where `absent`
+     * says it means no such instance, and any other answer but a 2xx a `DriverError`.
+     */
+    const send = async (method, path, token, { reply, body, absent = false } = {}) => {
+        const where = `${method} ${path}`;
+        let res;
+        let text;
+        try {
+            res = await fetch(`${base}${path}`, {
+                method,
+                signal: AbortSignal.timeout(timeoutMs),
+                // A redirect is no answer of the service's, and would carry the token elsewhere.
+                redirect: "manual",
+                headers: {
+                    authorization: `Bearer ${token}`,
+                    accept: "application/json",
+                    ...(body !== undefined && { "content-type": "application/json" }),
+                },
+                ...(body !== undefined && { body: JSON.stringify(body) }),
+            });
+            text = await res.text();
+        }
+        catch (cause) {
+            // No answer: the request may or may not have reached the service.
+            const why = cause.name === "TimeoutError" ? `no reply in ${timeoutMs} ms` : "the request failed";
+            throw new DriverError(`sanoma.wakeup: ${where}: ${why}`, { retryable: true, cause });
+        }
+        const { status } = res;
+        let json;
+        try {
+            json = text ? JSON.parse(text) : undefined;
+        }
+        catch {
+            // A proxy's HTML page, say: no body to read.
+        }
+        // The service's own 404 (its `{ error }`), not another server's at that URL.
+        if (status === 404 && absent && Problem.safeParse(json).success)
+            return undefined;
+        if (status < 200 || status >= 300)
+            throw fail(`${where}: ${Problem.safeParse(json).data?.error ?? `HTTP ${status}`}`, status);
+        if (!reply)
+            return undefined;
+        const parsed = reply.safeParse(json);
+        if (!parsed.success) {
+            throw new DriverError(`sanoma.wakeup: ${where}: the reply is not a wakeup service's; is SANOMA_WAKEUP_URL right?`, {
+                retryable: false,
+                status,
+                cause: parsed.error,
+            });
+        }
+        return parsed.data;
+    };
+    return {
+        put: async (url, token) => {
+            try {
+                return (await send("POST", "/wakeup/instances", account(), { reply: Posted, body: { url, token } }));
+            }
+            catch (error) {
+                // Another account's instance's token: the advice is the company's, so it is here, not the service's.
+                if (!(error instanceof DriverError) || error.status !== 409)
+                    throw error;
+                throw new DriverError(`${error.message}: a new account needs a new instance token (store the new account's token in /setup, which mints one)`, { retryable: false, status: 409, cause: error });
+            }
+        },
+        get: (id) => send("GET", instance(id), account(), { reply: instanceSchema, absent: true }),
+        async remove(id) {
+            await send("DELETE", instance(id), account(), { absent: true });
+        },
+        async wake({ at }, token) {
+            await send("PUT", "/wakeup/wake", token, { body: { at } });
+        },
+    };
+}
+/**
+ * The real wakeup service at `SANOMA_WAKEUP_URL`: instances created, read and deleted with
+ * `SANOMA_WAKEUP_ACCOUNT_TOKEN`, each named by its `SANOMA_WAKEUP_TOKEN` (which `create` and
+ * `register` send). `timeoutMs` is how long one request may take: 10 s by default.
+ */
+export function sanomaWakeupDriver({ timeoutMs = 10_000 } = {}) {
+    return defineDriver(wakeupOps, { wakeup: wakeupCalls(() => serviceApi(timeoutMs)) }, { env });
+}
+/** The wakeup's step for Gherkin tests: an instance at the service before the run, named `wakeup` (`$wakeup.id`). */
+export const wakeupSteps = defineSteps("sanoma", ({ given }) => {
+    given("a sanoma wakeup for {string}", (host) => ({
+        op: wakeupOps.wakeup.create,
+        input: { desired: { host } },
+        as: "wakeup",
+    }));
+});
+//# sourceMappingURL=wakeup-driver.js.map

package/dist/wakeup-driver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wakeup-driver.js","sourceRoot":"","sources":["../src/wakeup-driver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAoB,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAEvF,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnF,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE7C,8FAA8F;AAC9F,6FAA6F;AAC7F,gGAAgG;AAChG,2EAA2E;AAE3E,gGAAgG;AAChG,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9B,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAkBH,8GAA8G;AAC9G,MAAM,CAAC,MAAM,YAAY,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAW,CAAC;AAEnE,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,OAAe,EAAE,MAAc,EAAE,EAAE,CACtD,IAAI,WAAW,CAAC,kBAAkB,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,eAAe,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;AAE/F,4EAA4E;AAC5E,MAAM,OAAO,GAAG,CAAC,OAAe,EAAE,UAAmB,EAAE,EAAE,CACvD,IAAI,WAAW,CAAC,kBAAkB,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,CAAC,UAAU,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;AAExG,mEAAmE;AACnE,MAAM,OAAO,GAAG,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,SAAS,EAAY,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;AAY7F,2HAA2H;AAC3H,MAAM,SAAS,GAAG,CAAC,GAAY,EAAE,EAAE;IACjC,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IACjC,OAAO,KAAK,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AACtD,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,GAAoB;IAC9C,MAAM,IAAI,GAAG,KAAK,EAAE,EAAE,EAAE,EAAkB,EAAE,EAAE;QAC5C,MAAM,KAAK,GAAG,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAClC,OAAO,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IACjF,CAAC,CAAC;IACF;;;OAGG;IACH,MAAM,GAAG,GAAG,KAAK,EAAE,OAAgC,EAAE,EAAE,OAAO,EAAe,EAAE,EAAE;QAC/E,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;QACpE,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC5C,MAAM,KAAK,GAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC;QACnD,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;IACvB,CAAC,CAAC;IACF,MAAM,IAAI,GAAG,KAAK,EAAE,EAAE,EAAE,EAAE,OAAO,EAAsD,EAAoB,EAAE;QAC3G,MAAM,KAAK,GAAG,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QACxE,MAAM,IAAI,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;QAC1C,IAAI,CAAC,OAAO;YAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,CAAC;QAC3E,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAClD,IAAI,CAAC,KAAK;YAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;QAC/E,IAAI,OAAO,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI;YAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,CAAC;QAC3F,0EAA0E;QAC1E,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,GAAG,KAAK,EAAE,GAAG,OAAO,EAAE,GAAG,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,CAAC;IAClG,CAAC,CAAC;IACF,OAAO;QACL,MAAM,EAAE,IAAI;QACZ,IAAI;QACJ,IAAI,EAAE,KAAK,EAAE,KAAyD,EAAE,EAAE;YACxE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,GAAG,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC;YAC/C,OAAO,GAAG,CAAC;QACb,CAAC;QACD,MAAM,EAAE,CAAC,EAAE,OAAO,EAAwC,EAAE,IAAiB,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC;QACpG,MAAM,EAAE,KAAK,EACX,EACE,EAAE,EACF,OAAO,EACP,MAAM,GAC+F,EACvG,IAAiB,EACjB,EAAE;YACF,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;YAC1C,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;gBACjG,MAAM,OAAO,CAAC,6BAA6B,MAAM,CAAC,MAAM,SAAS,KAAK,CAAC,MAAM,GAAG,EAAE,cAAc,CAAC,CAAC;YACpG,CAAC;YACD,IAAI,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,MAAM;gBAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;YAC9E,OAAO,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC5B,CAAC;QACD,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,EAAkB,EAAE,EAAE;YACvC,MAAM,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACvB,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAa,EAAE,CAAC;QACrC,CAAC;QACD,QAAQ,EAAE,KAAK,EAAE,YAAgC,EAAE,EAAE,OAAO,EAAe,EAAE,EAAE;YAC7E,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAC9C,IAAI,CAAC,KAAK;gBACR,MAAM,OAAO,CACX,aAAa,YAAY,wEAAwE,CAClG,CAAC;YACJ,MAAM,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;YACtC,OAAO,EAAE,CAAC;QACZ,CAAC;KACF,CAAC;AACJ,CAAC;AAED,iEAAiE;AACjE,MAAM,GAAG,GAAG,CAAC,CAAC,MAAM,CAAC;IACnB,iBAAiB,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iEAAiE,CAAC;IACjH,2BAA2B,EAAE,CAAC;SAC3B,MAAM,EAAE;SACR,UAAU,CAAC,MAAM,EAAE,gCAAgC,CAAC;SACpD,QAAQ,EAAE;SACV,QAAQ,CAAC,2FAA2F,CAAC;IACxG,8FAA8F;IAC9F,yDAAyD;IACzD,CAAC,YAAY,CAAC,EAAE,CAAC;SACd,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,2GAA2G,CAC5G;CACJ,CAAC,CAAC;AAEH,sFAAsF;AACtF,SAAS,QAAQ,CAAC,IAAyD;IACzE,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAChC,IAAI,CAAC,KAAK;QAAE,MAAM,OAAO,CAAC,GAAG,IAAI,gBAAgB,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,WAAW,GAAG,CAAC,CAAC;IACjF,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AAC5C,gCAAgC;AAChC,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AAEhD,MAAM,QAAQ,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,qBAAqB,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAAC;AAE/E,oHAAoH;AACpH,SAAS,UAAU,CAAC,SAAiB;IACnC,MAAM,IAAI,GAAG,QAAQ,CAAC,mBAAmB,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC/D,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,MAAM,OAAO,CAAC,gCAAgC,CAAC,CAAC;IACzE,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAC,6BAA6B,CAAC,CAAC;IAC9D;;;OAGG;IACH,MAAM,IAAI,GAAG,KAAK,EAChB,MAAyC,EACzC,IAAY,EACZ,KAAa,EACb,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,GAAG,KAAK,EAAE,GAA+D,EAAE,EACxE,EAAE;QAC1B,MAAM,KAAK,GAAG,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC;QAClC,IAAI,GAAa,CAAC;QAClB,IAAI,IAAY,CAAC;QACjB,IAAI,CAAC;YACH,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,GAAG,IAAI,EAAE,EAAE;gBAClC,MAAM;gBACN,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC;gBACtC,iFAAiF;gBACjF,QAAQ,EAAE,QAAQ;gBAClB,OAAO,EAAE;oBACP,aAAa,EAAE,UAAU,KAAK,EAAE;oBAChC,MAAM,EAAE,kBAAkB;oBAC1B,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC;iBAClE;gBACD,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;aAC1D,CAAC,CAAC;YACH,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAC1B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,kEAAkE;YAClE,MAAM,GAAG,GAAI,KAAe,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC,CAAC,eAAe,SAAS,KAAK,CAAC,CAAC,CAAC,oBAAoB,CAAC;YAC5G,MAAM,IAAI,WAAW,CAAC,kBAAkB,KAAK,KAAK,GAAG,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QACvF,CAAC;QACD,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;QACvB,IAAI,IAAa,CAAC;QAClB,IAAI,CAAC;YACH,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC7C,CAAC;QAAC,MAAM,CAAC;YACP,6CAA6C;QAC/C,CAAC;QACD,6EAA6E;QAC7E,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,IAAI,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO;YAAE,OAAO,SAAS,CAAC;QAClF,IAAI,MAAM,GAAG,GAAG,IAAI,MAAM,IAAI,GAAG;YAC/B,MAAM,IAAI,CAAC,GAAG,KAAK,KAAK,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,IAAI,QAAQ,MAAM,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;QAC7F,IAAI,CAAC,KAAK;YAAE,OAAO,SAAS,CAAC;QAC7B,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,IAAI,WAAW,CACnB,kBAAkB,KAAK,oEAAoE,EAC3F;gBACE,SAAS,EAAE,KAAK;gBAChB,MAAM;gBACN,KAAK,EAAE,MAAM,CAAC,KAAK;aACpB,CACF,CAAC;QACJ,CAAC;QACD,OAAO,MAAM,CAAC,IAAI,CAAC;IACrB,CAAC,CAAC;IACF,OAAO;QACL,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;YACxB,IAAI,CAAC;gBACH,OAAO,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAE,CAAC;YACxG,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,qGAAqG;gBACrG,IAAI,CAAC,CAAC,KAAK,YAAY,WAAW,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG;oBAAE,MAAM,KAAK,CAAC;gBACzE,MAAM,IAAI,WAAW,CACnB,GAAG,KAAK,CAAC,OAAO,uGAAuG,EACvH,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,CAChD,CAAC;YACJ,CAAC;QACH,CAAC;QACD,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QAC1F,KAAK,CAAC,MAAM,CAAC,EAAE;YACb,MAAM,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAClE,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,KAAK;YACtB,MAAM,IAAI,CAAC,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAC7D,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,EAAE,SAAS,GAAG,MAAM,EAAE,GAA2B,EAAE;IACpF,OAAO,YAAY,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,WAAW,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;AAChG,CAAC;AAED,qHAAqH;AACrH,MAAM,CAAC,MAAM,WAAW,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;IAC7D,KAAK,CAAC,8BAA8B,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC;QACvD,EAAE,EAAE,SAAS,CAAC,MAAM,CAAC,MAAM;QAC3B,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE;QAC5B,EAAE,EAAE,QAAQ;KACb,CAAC,CAAC,CAAC;AACN,CAAC,CAAC,CAAC"}

package/dist/wakeup-service.d.ts

@@ -0,0 +1,83 @@
+/** Where the accounts live: one per party that registers instances, its token's hash alone. */
+export declare const WAKEUP_ACCOUNTS_TABLE = "sanoma_wakeup_accounts";
+/** Where the instances live: each one's URL, its token's hash and its registered wake. */
+export declare const WAKEUP_INSTANCES_TABLE = "sanoma_wakeup_instances";
+/** The shape of `@sanoma-ai/app`'s `IngressRoute`, which `startApp`'s `ingress` takes. */
+export interface WakeupRoute {
+    method?: "GET" | "POST" | "PUT" | "DELETE";
+    /** `/wakeup`, with every path under it (`prefix`). */
+    path: string;
+    prefix: true;
+    handle(request: Request): Promise<Response>;
+}
+export interface WakeupServiceOptions {
+    /** The service's own Postgres: its tables are made there when missing (the database too). */
+    databaseUrl: string;
+    /** The clock: what is due, and what `called_at` and `next_attempt_at` are set from. */
+    now?: () => Date;
+    /** How the instances are called. */
+    fetch?: typeof globalThis.fetch;
+    /** One `info` line per call, a `warn` per failure; the runtime's logger by default. */
+    log?: {
+        info(line: string): void;
+        warn(line: string): void;
+    };
+}
+export interface WakeupService {
+    /** One route answering everything under `/wakeup`, for `startApp`'s `ingress` or a server of its own. */
+    routes: WakeupRoute[];
+    /** An account that may register instances: its id, and its token, shown this once. */
+    mintAccount(label: string): Promise<{
+        id: string;
+        token: string;
+    }>;
+    /** Refuses the account's token and its instances' from now on, and wakes its instances no more. */
+    revokeAccount(id: string): Promise<void>;
+    /** Ends the loop, abandoning the calls in flight (called again once their claim lapses), and closes the pool. */
+    stop(): Promise<void>;
+}
+/**
+ * A new instance token (`swi_…`), which the company mints and stores as `SANOMA_WAKEUP_TOKEN`
+ * before anything is applied, so its host is given it from the first apply; the wakeup's create
+ * then registers it with the service. The service never mints one.
+ */
+export declare const mintInstanceToken: () => string;
+/** The secret a company keeps its instance token in: what its host's `secrets` name and its wakeup's driver reads. */
+export declare const WAKEUP_TOKEN = "SANOMA_WAKEUP_TOKEN";
+/** An instance token the service takes: `swi_`, then at least as many base64url characters as a minted one has. */
+export declare const INSTANCE_TOKEN: RegExp;
+/**
+ * An instance's URL as it is stored, without a trailing slash, or why it is refused: `http(s)`, no
+ * user or password, no query, no fragment (`/wake` is added to it).
+ */
+export declare function instanceUrl(value: unknown): {
+    url: string;
+} | {
+    error: string;
+};
+/**
+ * An account of the wakeup service on `databaseUrl`, minted without starting the service (its
+ * tables made when missing): what `sanoma wakeup account <label>` prints.
+ */
+export declare function mintWakeupAccount(databaseUrl: string, label: string): Promise<{
+    id: string;
+    token: string;
+}>;
+/**
+ * Starts the wakeup service on its own database: its two tables made when missing, its one loop
+ * running, and `routes` for whoever serves it (`sanoma wakeup`, or `sanoma serve` with
+ * `wakeup: true`). Routes, each JSON and `no-store`:
+ *
+ * - `POST /wakeup/instances { url, token }`, an account's token → 201 `{ id }` for a new instance
+ *   token, 200 `{ id }` for one the account registered already, its URL now the given one (a lost
+ *   reply, or a host that moved; its registered wake kept only when the URL is the same), 409 for
+ *   another account's
+ * - `GET /wakeup/instances/{id}`, its account's token → `{ id, url, at, calledAt, attempts, lastError }`
+ * - `DELETE /wakeup/instances/{id}`, its account's token → 204
+ * - `PUT /wakeup/wake { at }`, an instance's own token, which names the instance → 204, replacing
+ *   the wake it had, and waking the loop
+ *
+ * 401 without a token or with an unknown one, 403 for another account's instance, 400 for a bad
+ * body, 404 for an unknown id or path.
+ */
+export declare function startWakeupService({ databaseUrl, now, fetch, log, }: WakeupServiceOptions): Promise<WakeupService>;