@procedures/schedule 0.0.0-stage → 0.2.3

package/dist/scheduler.js

@@ -0,0 +1,274 @@
+/**
+ * The scheduler: a host starts it, and it starts the stored programs of the schedules at their
+ * times (roadmap R46).
+ *
+ * - It wakes at each minute (the unit of cron), reads the schedules of its store, and starts each
+ *   schedule whose time came. A schedule that a procedure adds or removes counts at the next minute.
+ * - A run goes through the registry, with the capability of the host narrowed by the capability
+ *   of the caller that added the schedule. The expose rule, the call rule, the interceptors and
+ *   the resources of the host policy apply too.
+ * - A schedule has at most one run at a time. A time that comes during a run does not start a
+ *   second run: the store counts it as skipped.
+ * - The store records the last run of each schedule: its start, its time and its outcome.
+ * - A run that passes `runTimeoutMs` gets the abort of its signal and the outcome `TIMEOUT`. The
+ *   schedule stays busy until the handler ends: a handler that does not stop blocks only its own
+ *   schedule.
+ * - The scheduler does not run the times that it missed while it was stopped. Times that it
+ *   missed during a run or a slow minute give one run, not one for each time.
+ * - The timers use an injectable `Clock` (`after` and `now`), and the calendar uses an injectable
+ *   wall clock (`now`, default `Date.now`). A test gives `fakeClock` of `@mark1russell7/service/testing`.
+ */
+import { InvocationError, PROCEDURE_REGISTRY, invokePath, invokeProcedure, isRuntimeDefined, keyToPath, narrowCapability, outputValue, realClock, } from "@procedures/client";
+import { nextTime, parseCron } from "./cron.js";
+import { ScheduleError } from "./errors.js";
+import { findProgram } from "./programs.js";
+import { defaultScheduleStore } from "./store.js";
+/** The default time limit of a run: 10 minutes. */
+export const DEFAULT_RUN_TIMEOUT_MS = 600_000;
+const versionOf = (schedule) => `${schedule.createdAt}|${schedule.cron}|${schedule.timeZone}`;
+/** The code and the message of an error. */
+function errorInfo(error) {
+    const message = error instanceof Error ? error.message : String(error);
+    const code = error?.code;
+    return typeof code === "string" ? { code, message } : { message };
+}
+/** The next time of a schedule after a time, or undefined for an expression that is not correct. */
+function nextOf(schedule, after) {
+    try {
+        return nextTime(parseCron(schedule.cron), after, schedule.timeZone);
+    }
+    catch {
+        return undefined;
+    }
+}
+/** A scheduler of the stored programs. See the comment of the file. */
+export class Scheduler {
+    registry;
+    store;
+    clock;
+    now;
+    runTimeoutMs;
+    options;
+    due = new Map();
+    runs = new Map();
+    startedAt;
+    cancel;
+    ticking;
+    constructor(options = {}) {
+        this.options = options;
+        this.registry = options.registry ?? PROCEDURE_REGISTRY;
+        this.store = options.store ?? defaultScheduleStore;
+        this.clock = options.clock ?? realClock;
+        this.now = options.now ?? (() => Date.now());
+        this.runTimeoutMs = options.runTimeoutMs ?? DEFAULT_RUN_TIMEOUT_MS;
+        if (!(this.runTimeoutMs >= 0))
+            throw new TypeError("Scheduler: runTimeoutMs must be 0 or more");
+    }
+    /** True after `start()` and before `stop()`. */
+    get started() {
+        return this.startedAt !== undefined;
+    }
+    /** The names of the schedules with a run that has not ended. */
+    get active() {
+        return [...this.runs.keys()].sort();
+    }
+    /** This method starts the scheduler: the first times come after now. It gives the end of the first examination. */
+    async start() {
+        if (this.startedAt !== undefined)
+            return;
+        this.startedAt = this.now();
+        await this.tick();
+    }
+    /** This method stops the timer, aborts the runs, and gives the end of the runs. */
+    async stop() {
+        this.startedAt = undefined;
+        this.cancel?.();
+        this.cancel = undefined;
+        this.due.clear();
+        for (const run of this.runs.values())
+            run.controller.abort(new Error("The scheduler stopped"));
+        await this.settled();
+    }
+    /** This method gives the end of the examination in progress and of the runs in progress. */
+    async settled() {
+        await this.ticking;
+        await Promise.all([...this.runs.values()].map((run) => run.promise));
+    }
+    /**
+     * This method examines the schedules now and starts each one whose time came. It does not wait
+     * for the runs. A second call during an examination gives the same examination.
+     */
+    tick() {
+        this.ticking ??= this.examine().finally(() => {
+            this.ticking = undefined;
+            this.arm();
+        });
+        return this.ticking;
+    }
+    /** This method starts one run of a schedule now, unless it has a run in progress. It gives the event of the run. */
+    async runNow(id) {
+        const schedule = await this.store.get(id);
+        if (schedule === undefined)
+            throw new ScheduleError("NOT_FOUND", `No schedule is named ${id}`);
+        return new Promise((resolve) => {
+            if (!this.launch(schedule, this.now(), resolve))
+                resolve(this.skip(schedule, this.now()));
+        });
+    }
+    async examine() {
+        if (this.startedAt === undefined)
+            return;
+        const now = this.now();
+        let schedules;
+        try {
+            schedules = await this.store.list();
+        }
+        catch (error) {
+            this.options.onError?.(error);
+            return;
+        }
+        const ids = new Set(schedules.map((schedule) => schedule.id));
+        for (const id of this.due.keys())
+            if (!ids.has(id))
+                this.due.delete(id);
+        for (const schedule of schedules) {
+            // A stop during the read of the store starts nothing
+            if (this.startedAt === undefined)
+                return;
+            const version = versionOf(schedule);
+            let due = this.due.get(schedule.id);
+            if (due === undefined || due.version !== version) {
+                // A new or a changed schedule: its first time is after it was added, and after the start
+                due = { version, at: nextOf(schedule, Math.max(schedule.createdAt, this.startedAt) - 1) };
+                this.due.set(schedule.id, due);
+            }
+            if (due.at === undefined || due.at > now)
+                continue;
+            // The times that passed give one run: the next time comes after now
+            due.at = nextOf(schedule, now);
+            if (!this.launch(schedule, now))
+                void this.skip(schedule, now);
+        }
+    }
+    /** This method arms the timer for the next minute, or for an earlier time that is due. */
+    arm() {
+        if (this.startedAt === undefined)
+            return;
+        this.cancel?.();
+        const now = this.now();
+        let wake = Math.floor(now / 60_000) * 60_000 + 60_000;
+        for (const due of this.due.values())
+            if (due.at !== undefined && due.at < wake)
+                wake = due.at;
+        this.cancel = this.clock.after(Math.max(0, wake - now), () => {
+            this.cancel = undefined;
+            void this.tick();
+        });
+    }
+    /** This method gives an event to `onRun`. An error of `onRun` goes to `onError`, not to the scheduler. */
+    report(event) {
+        try {
+            this.options.onRun?.(event);
+        }
+        catch (error) {
+            this.options.onError?.(error);
+        }
+    }
+    /** This method records a time that came during a run of the same schedule. */
+    skip(schedule, now) {
+        const event = { id: schedule.id, program: schedule.program, outcome: "skipped", startedAt: now, durationMs: 0 };
+        void this.store
+            .update(schedule.id, (current) => (current.createdAt === schedule.createdAt ? { ...current, skipped: current.skipped + 1 } : undefined))
+            .catch((error) => this.options.onError?.(error));
+        this.report(event);
+        return event;
+    }
+    /** This method starts a run, unless the schedule has one. It gives false for a schedule with a run. */
+    launch(schedule, startedAt, done) {
+        if (this.runs.has(schedule.id))
+            return false;
+        const controller = new AbortController();
+        const promise = this.run(schedule, startedAt, controller).then((event) => {
+            this.runs.delete(schedule.id);
+            this.report(event);
+            done?.(event);
+        });
+        this.runs.set(schedule.id, { promise, controller });
+        return true;
+    }
+    /** One run: the program through the registry, then its record. */
+    async run(schedule, startedAt, controller) {
+        const start = this.clock.now();
+        let timedOut = false;
+        const stopTimer = this.runTimeoutMs > 0
+            ? this.clock.after(this.runTimeoutMs, () => {
+                timedOut = true;
+                controller.abort(new Error(`The run of ${schedule.id} passed its time limit of ${this.runTimeoutMs} ms`));
+            })
+            : undefined;
+        let error;
+        try {
+            await this.invoke(schedule, controller.signal);
+        }
+        catch (caught) {
+            error = errorInfo(caught);
+        }
+        finally {
+            stopTimer?.();
+        }
+        if (timedOut)
+            error = { code: "TIMEOUT", message: `The run passed its time limit of ${this.runTimeoutMs} ms${error ? `: ${error.message}` : ""}` };
+        const run = {
+            startedAt,
+            durationMs: Math.max(0, this.clock.now() - start),
+            outcome: error === undefined ? "success" : "failure",
+            ...(error !== undefined ? { error } : {}),
+        };
+        try {
+            await this.store.update(schedule.id, (current) => current.createdAt === schedule.createdAt
+                ? { ...current, lastRun: run, runs: current.runs + 1, failures: current.failures + (error === undefined ? 0 : 1) }
+                : undefined);
+        }
+        catch (caught) {
+            this.options.onError?.(caught);
+        }
+        return { id: schedule.id, program: schedule.program, outcome: run.outcome, startedAt, durationMs: run.durationMs, ...(error !== undefined ? { error } : {}) };
+    }
+    /** The options of an invocation: the policy of the host, a capability and the signal of the run. */
+    invokeOptions(capability, signal) {
+        const policy = this.options.policy;
+        return {
+            registry: this.registry,
+            signal,
+            ...(capability !== undefined ? { capability } : {}),
+            ...(policy?.expose ? { expose: policy.expose } : {}),
+            ...(policy?.strictCalls ? { strictCalls: true } : {}),
+            ...(policy && policy.interceptors.length > 0 ? { interceptors: policy.interceptors } : {}),
+            ...(policy?.clearanceOrder ? { clearanceOrder: policy.clearanceOrder } : {}),
+            ...(policy?.resources ? { resources: policy.resources } : {}),
+        };
+    }
+    /** The program of a schedule through the registry, after a load from the program store when the registry does not have it. */
+    async invoke(schedule, signal) {
+        const path = keyToPath(schedule.program);
+        const host = this.options.capability ?? this.options.policy?.capabilityOf?.();
+        if ((await findProgram(this.registry, schedule.program)) === "store") {
+            // The load defines the program: a step of the host, with the capability of the host
+            await outputValue(await invokePath(["procedure", "load"], { path }, this.invokeOptions(host, signal)), ["procedure", "load"]);
+        }
+        const procedure = this.registry.get(path);
+        if (procedure === undefined || !isRuntimeDefined(procedure)) {
+            throw new ScheduleError("NOT_FOUND", `The program ${schedule.program} is not in the registry after its load`);
+        }
+        const capability = schedule.capability === undefined ? host : narrowCapability(host, schedule.capability, this.options.policy?.clearanceOrder);
+        if (signal.aborted)
+            throw new InvocationError("ABORTED", `The run of ${schedule.id} was aborted before its start`, path);
+        const output = await invokeProcedure(procedure, schedule.input ?? {}, this.invokeOptions(capability, signal));
+        if (output.kind === "stream") {
+            for await (const _item of output.items) {
+                // A program that gives a stream runs to its end
+            }
+        }
+    }
+}
+//# sourceMappingURL=scheduler.js.map

package/dist/scheduler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduler.js","sourceRoot":"","sources":["../src/scheduler.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EACL,eAAe,EACf,kBAAkB,EAClB,UAAU,EACV,eAAe,EACf,gBAAgB,EAChB,SAAS,EACT,gBAAgB,EAChB,WAAW,EACX,SAAS,GAOV,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAsB,MAAM,YAAY,CAAC;AAGtE,mDAAmD;AACnD,MAAM,CAAC,MAAM,sBAAsB,GAAG,OAAO,CAAC;AAyC9C,MAAM,SAAS,GAAG,CAAC,QAAkB,EAAU,EAAE,CAAC,GAAG,QAAQ,CAAC,SAAS,IAAI,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;AAEhH,4CAA4C;AAC5C,SAAS,SAAS,CAAC,KAAc;IAC/B,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACvE,MAAM,IAAI,GAAI,KAAmC,EAAE,IAAI,CAAC;IACxD,OAAO,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC;AACpE,CAAC;AAED,oGAAoG;AACpG,SAAS,MAAM,CAAC,QAAkB,EAAE,KAAa;IAC/C,IAAI,CAAC;QACH,OAAO,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACtE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,uEAAuE;AACvE,MAAM,OAAO,SAAS;IACH,QAAQ,CAAoB;IAC5B,KAAK,CAAgB;IACrB,KAAK,CAAQ;IACb,GAAG,CAAe;IAClB,YAAY,CAAS;IACrB,OAAO,CAAmB;IAC1B,GAAG,GAAG,IAAI,GAAG,EAAe,CAAC;IAC7B,IAAI,GAAG,IAAI,GAAG,EAAmE,CAAC;IAC3F,SAAS,CAAqB;IAC9B,MAAM,CAAqB;IAC3B,OAAO,CAA4B;IAE3C,YAAY,OAAO,GAAqB,EAAE;QACxC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,kBAAkB,CAAC;QACvD,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,oBAAoB,CAAC;QACnD,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,SAAS,CAAC;QACxC,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAC7C,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,sBAAsB,CAAC;QACnE,IAAI,CAAC,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,CAAC;YAAE,MAAM,IAAI,SAAS,CAAC,2CAA2C,CAAC,CAAC;IAClG,CAAC;IAED,gDAAgD;IAChD,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC;IACtC,CAAC;IAED,gEAAgE;IAChE,IAAI,MAAM;QACR,OAAO,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACtC,CAAC;IAED,mHAAmH;IACnH,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS;YAAE,OAAO;QACzC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC5B,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;IACpB,CAAC;IAED,mFAAmF;IACnF,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;QAChB,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;QACjB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAAE,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC,CAAC;QAC/F,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;IAED,4FAA4F;IAC5F,KAAK,CAAC,OAAO;QACX,MAAM,IAAI,CAAC,OAAO,CAAC;QACnB,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;IACvE,CAAC;IAED;;;OAGG;IACH,IAAI;QACF,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;YAC3C,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;YACzB,IAAI,CAAC,GAAG,EAAE,CAAC;QACb,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,oHAAoH;IACpH,KAAK,CAAC,MAAM,CAAC,EAAU;QACrB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC1C,IAAI,QAAQ,KAAK,SAAS;YAAE,MAAM,IAAI,aAAa,CAAC,WAAW,EAAE,wBAAwB,EAAE,EAAE,CAAC,CAAC;QAC/F,OAAO,IAAI,OAAO,CAAmB,CAAC,OAAO,EAAE,EAAE;YAC/C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC;gBAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAC5F,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,OAAO;QACnB,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS;YAAE,OAAO;QACzC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,IAAI,SAAqB,CAAC;QAC1B,IAAI,CAAC;YACH,SAAS,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QACtC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;YAC9B,OAAO;QACT,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9D,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE;YAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACxE,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,qDAAqD;YACrD,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS;gBAAE,OAAO;YACzC,MAAM,OAAO,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;YACpC,IAAI,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACpC,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;gBACjD,yFAAyF;gBACzF,GAAG,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBAC1F,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;YACjC,CAAC;YACD,IAAI,GAAG,CAAC,EAAE,KAAK,SAAS,IAAI,GAAG,CAAC,EAAE,GAAG,GAAG;gBAAE,SAAS;YACnD,oEAAoE;YACpE,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;YAC/B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC;gBAAE,KAAK,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAED,0FAA0F;IAClF,GAAG;QACT,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS;YAAE,OAAO;QACzC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;QAChB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,IAAI,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,MAAM,GAAG,MAAM,CAAC;QACtD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE;YAAE,IAAI,GAAG,CAAC,EAAE,KAAK,SAAS,IAAI,GAAG,CAAC,EAAE,GAAG,IAAI;gBAAE,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;QAC9F,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,EAAE;YAC3D,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;YACxB,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,0GAA0G;IAClG,MAAM,CAAC,KAAuB;QACpC,IAAI,CAAC;YACH,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED,8EAA8E;IACtE,IAAI,CAAC,QAAkB,EAAE,GAAW;QAC1C,MAAM,KAAK,GAAqB,EAAE,EAAE,EAAE,QAAQ,CAAC,EAAE,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;QAClI,KAAK,IAAI,CAAC,KAAK;aACZ,MAAM,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,KAAK,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;aACvI,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACnB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uGAAuG;IAC/F,MAAM,CAAC,QAAkB,EAAE,SAAiB,EAAE,IAAwC;QAC5F,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAAE,OAAO,KAAK,CAAC;QAC7C,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;YACvE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YAC9B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACnB,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;QACpD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kEAAkE;IAC1D,KAAK,CAAC,GAAG,CAAC,QAAkB,EAAE,SAAiB,EAAE,UAA2B;QAClF,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;QAC/B,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,MAAM,SAAS,GACb,IAAI,CAAC,YAAY,GAAG,CAAC;YACnB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,EAAE,GAAG,EAAE;gBACvC,QAAQ,GAAG,IAAI,CAAC;gBAChB,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,cAAc,QAAQ,CAAC,EAAE,6BAA6B,IAAI,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC;YAC5G,CAAC,CAAC;YACJ,CAAC,CAAC,SAAS,CAAC;QAChB,IAAI,KAAqD,CAAC;QAC1D,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;QACjD,CAAC;QAAC,OAAO,MAAM,EAAE,CAAC;YAChB,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC;gBAAS,CAAC;YACT,SAAS,EAAE,EAAE,CAAC;QAChB,CAAC;QACD,IAAI,QAAQ;YAAE,KAAK,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,oCAAoC,IAAI,CAAC,YAAY,MAAM,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC;QACnJ,MAAM,GAAG,GAAgB;YACvB,SAAS;YACT,UAAU,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;YACjD,OAAO,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;YACpD,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC1C,CAAC;QACF,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,EAAE,CAC/C,OAAO,CAAC,SAAS,KAAK,QAAQ,CAAC,SAAS;gBACtC,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;gBAClH,CAAC,CAAC,SAAS,CACd,CAAC;QACJ,CAAC;QAAC,OAAO,MAAM,EAAE,CAAC;YAChB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC;QACjC,CAAC;QACD,OAAO,EAAE,EAAE,EAAE,QAAQ,CAAC,EAAE,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;IAChK,CAAC;IAED,oGAAoG;IAC5F,aAAa,CAAC,UAAkC,EAAE,MAAmB;QAC3E,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QACnC,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,MAAM;YACN,GAAG,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACnD,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACpD,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACrD,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1F,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5E,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC9D,CAAC;IACJ,CAAC;IAED,8HAA8H;IACtH,KAAK,CAAC,MAAM,CAAC,QAAkB,EAAE,MAAmB;QAC1D,MAAM,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE,CAAC;QAC9E,IAAI,CAAC,MAAM,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,OAAO,EAAE,CAAC;YACrE,oFAAoF;YACpF,MAAM,WAAW,CAAC,MAAM,UAAU,CAAC,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC;QAChI,CAAC;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,SAAS,KAAK,SAAS,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5D,MAAM,IAAI,aAAa,CAAC,WAAW,EAAE,eAAe,QAAQ,CAAC,OAAO,wCAAwC,CAAC,CAAC;QAChH,CAAC;QACD,MAAM,UAAU,GAAG,QAAQ,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QAC/I,IAAI,MAAM,CAAC,OAAO;YAAE,MAAM,IAAI,eAAe,CAAC,SAAS,EAAE,cAAc,QAAQ,CAAC,EAAE,+BAA+B,EAAE,IAAI,CAAC,CAAC;QACzH,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC,SAAS,EAAE,QAAQ,CAAC,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;QAC9G,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACvC,gDAAgD;YAClD,CAAC;QACH,CAAC;IACH,CAAC;CACF"}

package/dist/store.d.ts

@@ -0,0 +1,62 @@
+/**
+ * The stores of the schedules: in memory, or in one JSON file.
+ *
+ * A host gives one store to the module of the procedures (`createScheduleModule({ store })`) and
+ * the same store to its `Scheduler`. `update()` changes one schedule in one step, so the record of
+ * a run does not lose a change of `schedule.add` that came at the same time.
+ */
+import type { Schedule } from "./types.js";
+/** A store of schedules. Each method gives a Promise: a caller cannot tell a local store from a remote one. */
+export interface ScheduleStore {
+    /** The kind of the backend: "memory", "file" or another name. */
+    readonly kind: string;
+    get(id: string): Promise<Schedule | undefined>;
+    /** The schedules, sorted by name. */
+    list(): Promise<Schedule[]>;
+    /** Write a schedule. A schedule of the same name is replaced. */
+    put(schedule: Schedule): Promise<void>;
+    /** Delete a schedule. True when it existed. */
+    delete(id: string): Promise<boolean>;
+    /**
+     * Change one schedule in one step. `change` gets a copy and gives the new schedule, or
+     * undefined for no change. The result is the stored schedule, or undefined when none exists.
+     */
+    update(id: string, change: (schedule: Schedule) => Schedule | undefined): Promise<Schedule | undefined>;
+}
+/** The schedule of a record that came from a file: its shape is not trusted. */
+export declare function checkSchedule(value: unknown): Schedule;
+/** A store in memory: for tests, and for a host that keeps its schedules only while it runs. */
+export declare class MemoryScheduleStore implements ScheduleStore {
+    readonly kind = "memory";
+    private readonly schedules;
+    get(id: string): Promise<Schedule | undefined>;
+    list(): Promise<Schedule[]>;
+    put(schedule: Schedule): Promise<void>;
+    delete(id: string): Promise<boolean>;
+    update(id: string, change: (schedule: Schedule) => Schedule | undefined): Promise<Schedule | undefined>;
+}
+/**
+ * A store in one JSON file: `{ "schemaVersion": 1, "schedules": { "<id>": <Schedule> } }`. Each
+ * operation reads the file again. A write goes through a temporary file and a rename, so a reader
+ * never sees a part of a write. The writes of this process go one at a time. The store is for
+ * one process: two processes on one file can lose a write.
+ */
+export declare class FileScheduleStore implements ScheduleStore {
+    readonly path: string;
+    readonly kind = "file";
+    private queue;
+    /** @param path - The JSON file. The store makes it, and its folder, at the first write. */
+    constructor(path: string);
+    get(id: string): Promise<Schedule | undefined>;
+    list(): Promise<Schedule[]>;
+    put(schedule: Schedule): Promise<void>;
+    delete(id: string): Promise<boolean>;
+    update(id: string, change: (schedule: Schedule) => Schedule | undefined): Promise<Schedule | undefined>;
+    /** The content of the file. A missing file is an empty store. */
+    private read;
+    /** One change of the file, after the changes before it. `edit` gives false for no change. */
+    private change;
+}
+/** The store of the default module and of a `Scheduler` without a store: in memory, one for the process. */
+export declare const defaultScheduleStore: ScheduleStore;
+//# sourceMappingURL=store.d.ts.map

package/dist/store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../src/store.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAMH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,+GAA+G;AAC/G,MAAM,WAAW,aAAa;IAC5B,iEAAiE;IACjE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAC;IAC/C,qCAAqC;IACrC,IAAI,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC5B,iEAAiE;IACjE,GAAG,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,+CAA+C;IAC/C,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACrC;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAC;CACzG;AAMD,gFAAgF;AAChF,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,QAAQ,CAWtD;AAED,gGAAgG;AAChG,qBAAa,mBAAoB,YAAW,aAAa;IACvD,QAAQ,CAAC,IAAI,YAAY;IACzB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA+B;IAEnD,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAGnD;IAEK,IAAI,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC,CAEhC;IAEK,GAAG,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAG3C;IAEK,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAEzC;IAEK,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAS5G;CACF;AAeD;;;;;GAKG;AACH,qBAAa,iBAAkB,YAAW,aAAa;IAKzC,QAAQ,CAAC,IAAI,EAAE,MAAM;IAJjC,QAAQ,CAAC,IAAI,UAAU;IACvB,OAAO,CAAC,KAAK,CAAuC;IAEpD,2FAA2F;IAC3F,YAAqB,IAAI,EAAE,MAAM,EAAI;IAE/B,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAEnD;IAEK,IAAI,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC,CAEhC;IAEK,GAAG,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAM3C;IAEK,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAQzC;IAEK,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAiB5G;IAED,iEAAiE;YACnD,IAAI;IA2BlB,6FAA6F;IAC7F,OAAO,CAAC,MAAM;CAwBf;AAED,4GAA4G;AAC5G,eAAO,MAAM,oBAAoB,EAAE,aAAyC,CAAC"}

package/dist/store.js

@@ -0,0 +1,188 @@
+/**
+ * The stores of the schedules: in memory, or in one JSON file.
+ *
+ * A host gives one store to the module of the procedures (`createScheduleModule({ store })`) and
+ * the same store to its `Scheduler`. `update()` changes one schedule in one step, so the record of
+ * a run does not lose a change of `schedule.add` that came at the same time.
+ */
+import { mkdir, readFile, rename, rm, writeFile } from "node:fs/promises";
+import { dirname } from "node:path";
+import { randomBytes } from "node:crypto";
+import { ScheduleError } from "./errors.js";
+const byId = (a, b) => (a.id < b.id ? -1 : a.id > b.id ? 1 : 0);
+const isCount = (value) => typeof value === "number" && Number.isSafeInteger(value) && value >= 0;
+/** The schedule of a record that came from a file: its shape is not trusted. */
+export function checkSchedule(value) {
+    const record = value;
+    if (record === null || typeof record !== "object")
+        throw new ScheduleError("BAD_STORE", "A stored schedule must be an object");
+    if (typeof record.id !== "string" || record.id === "")
+        throw new ScheduleError("BAD_STORE", "A stored schedule needs an id");
+    if (typeof record.cron !== "string" || typeof record.program !== "string" || record.program === "") {
+        throw new ScheduleError("BAD_STORE", `The schedule ${record.id} needs a cron expression and a program`);
+    }
+    if (record.timeZone !== "utc" && record.timeZone !== "local")
+        throw new ScheduleError("BAD_STORE", `The schedule ${record.id} needs the time zone utc or local`);
+    if (typeof record.createdAt !== "number" || !Number.isFinite(record.createdAt))
+        throw new ScheduleError("BAD_STORE", `The schedule ${record.id} needs createdAt`);
+    if (!isCount(record.runs) || !isCount(record.failures) || !isCount(record.skipped))
+        throw new ScheduleError("BAD_STORE", `The schedule ${record.id} needs the counts of its runs`);
+    return record;
+}
+/** A store in memory: for tests, and for a host that keeps its schedules only while it runs. */
+export class MemoryScheduleStore {
+    kind = "memory";
+    schedules = new Map();
+    async get(id) {
+        const schedule = this.schedules.get(id);
+        return schedule ? structuredClone(schedule) : undefined;
+    }
+    async list() {
+        return [...this.schedules.values()].map((schedule) => structuredClone(schedule)).sort(byId);
+    }
+    async put(schedule) {
+        const checked = checkSchedule(structuredClone(schedule));
+        this.schedules.set(checked.id, checked);
+    }
+    async delete(id) {
+        return this.schedules.delete(id);
+    }
+    async update(id, change) {
+        const current = this.schedules.get(id);
+        if (current === undefined)
+            return undefined;
+        const next = change(structuredClone(current));
+        if (next === undefined)
+            return structuredClone(current);
+        const checked = checkSchedule(structuredClone(next));
+        if (checked.id !== id)
+            throw new ScheduleError("BAD_STORE", "An update cannot change the id of a schedule");
+        this.schedules.set(id, checked);
+        return structuredClone(checked);
+    }
+}
+/** True when Windows holds a file for a moment. */
+function isContention(error) {
+    const code = error.code;
+    return process.platform === "win32" && (code === "EPERM" || code === "EACCES" || code === "EBUSY");
+}
+const pause = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+/**
+ * A store in one JSON file: `{ "schemaVersion": 1, "schedules": { "<id>": <Schedule> } }`. Each
+ * operation reads the file again. A write goes through a temporary file and a rename, so a reader
+ * never sees a part of a write. The writes of this process go one at a time. The store is for
+ * one process: two processes on one file can lose a write.
+ */
+export class FileScheduleStore {
+    path;
+    kind = "file";
+    queue = Promise.resolve();
+    /** @param path - The JSON file. The store makes it, and its folder, at the first write. */
+    constructor(path) {
+        this.path = path;
+    }
+    async get(id) {
+        return (await this.read()).schedules[id];
+    }
+    async list() {
+        return Object.values((await this.read()).schedules).sort(byId);
+    }
+    async put(schedule) {
+        const checked = checkSchedule(structuredClone(schedule));
+        await this.change((file) => {
+            file.schedules[checked.id] = checked;
+            return true;
+        });
+    }
+    async delete(id) {
+        let deleted = false;
+        await this.change((file) => {
+            deleted = Object.hasOwn(file.schedules, id);
+            if (deleted)
+                delete file.schedules[id];
+            return deleted;
+        });
+        return deleted;
+    }
+    async update(id, change) {
+        let result;
+        await this.change((file) => {
+            const current = file.schedules[id];
+            if (current === undefined)
+                return false;
+            const next = change(structuredClone(current));
+            if (next === undefined) {
+                result = current;
+                return false;
+            }
+            const checked = checkSchedule(structuredClone(next));
+            if (checked.id !== id)
+                throw new ScheduleError("BAD_STORE", "An update cannot change the id of a schedule");
+            file.schedules[id] = checked;
+            result = checked;
+            return true;
+        });
+        return result;
+    }
+    /** The content of the file. A missing file is an empty store. */
+    async read() {
+        let text;
+        try {
+            text = await readFile(this.path, "utf8");
+        }
+        catch (error) {
+            if (error.code === "ENOENT")
+                return { schemaVersion: 1, schedules: {} };
+            throw error;
+        }
+        let parsed;
+        try {
+            parsed = JSON.parse(text);
+        }
+        catch {
+            throw new ScheduleError("BAD_STORE", `The schedule file ${this.path} is not JSON. The store does not write over it.`);
+        }
+        const file = parsed;
+        if (file === null || typeof file !== "object" || file.schemaVersion !== 1 || file.schedules === null || typeof file.schedules !== "object") {
+            throw new ScheduleError("BAD_STORE", `The schedule file ${this.path} does not have schemaVersion 1 and schedules`);
+        }
+        const schedules = {};
+        for (const [id, value] of Object.entries(file.schedules)) {
+            const schedule = checkSchedule(value);
+            if (schedule.id !== id)
+                throw new ScheduleError("BAD_STORE", `The schedule file ${this.path} has the schedule ${schedule.id} under the key ${id}`);
+            schedules[id] = schedule;
+        }
+        return { schemaVersion: 1, schedules };
+    }
+    /** One change of the file, after the changes before it. `edit` gives false for no change. */
+    change(edit) {
+        const run = this.queue.then(async () => {
+            const file = await this.read();
+            if (!edit(file))
+                return;
+            await mkdir(dirname(this.path), { recursive: true });
+            const temporary = `${this.path}.${randomBytes(6).toString("hex")}.tmp`;
+            await writeFile(temporary, JSON.stringify(file, null, 2) + "\n", "utf8");
+            for (let attempt = 1;; attempt++) {
+                try {
+                    await rename(temporary, this.path);
+                    return;
+                }
+                catch (error) {
+                    if (attempt >= 20 || !isContention(error)) {
+                        await rm(temporary, { force: true });
+                        throw error;
+                    }
+                    await pause(10 * attempt);
+                }
+            }
+        });
+        // A failed change does not stop the next one
+        this.queue = run.catch(() => undefined);
+        return run;
+    }
+}
+/** The store of the default module and of a `Scheduler` without a store: in memory, one for the process. */
+export const defaultScheduleStore = new MemoryScheduleStore();
+//# sourceMappingURL=store.js.map

package/dist/store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.js","sourceRoot":"","sources":["../src/store.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC1E,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAqB5C,MAAM,IAAI,GAAG,CAAC,CAAW,EAAE,CAAW,EAAU,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAE5F,MAAM,OAAO,GAAG,CAAC,KAAc,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AAE5H,gFAAgF;AAChF,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,MAAM,MAAM,GAAG,KAAiC,CAAC;IACjD,IAAI,MAAM,KAAK,IAAI,IAAI,OAAO,MAAM,KAAK,QAAQ;QAAE,MAAM,IAAI,aAAa,CAAC,WAAW,EAAE,qCAAqC,CAAC,CAAC;IAC/H,IAAI,OAAO,MAAM,CAAC,EAAE,KAAK,QAAQ,IAAI,MAAM,CAAC,EAAE,KAAK,EAAE;QAAE,MAAM,IAAI,aAAa,CAAC,WAAW,EAAE,+BAA+B,CAAC,CAAC;IAC7H,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,MAAM,CAAC,OAAO,KAAK,QAAQ,IAAI,MAAM,CAAC,OAAO,KAAK,EAAE,EAAE,CAAC;QACnG,MAAM,IAAI,aAAa,CAAC,WAAW,EAAE,gBAAgB,MAAM,CAAC,EAAE,wCAAwC,CAAC,CAAC;IAC1G,CAAC;IACD,IAAI,MAAM,CAAC,QAAQ,KAAK,KAAK,IAAI,MAAM,CAAC,QAAQ,KAAK,OAAO;QAAE,MAAM,IAAI,aAAa,CAAC,WAAW,EAAE,gBAAgB,MAAM,CAAC,EAAE,mCAAmC,CAAC,CAAC;IACjK,IAAI,OAAO,MAAM,CAAC,SAAS,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC;QAAE,MAAM,IAAI,aAAa,CAAC,WAAW,EAAE,gBAAgB,MAAM,CAAC,EAAE,kBAAkB,CAAC,CAAC;IAClK,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC;QAAE,MAAM,IAAI,aAAa,CAAC,WAAW,EAAE,gBAAgB,MAAM,CAAC,EAAE,+BAA+B,CAAC,CAAC;IACnL,OAAO,MAAkB,CAAC;AAC5B,CAAC;AAED,gGAAgG;AAChG,MAAM,OAAO,mBAAmB;IACrB,IAAI,GAAG,QAAQ,CAAC;IACR,SAAS,GAAG,IAAI,GAAG,EAAoB,CAAC;IAEzD,KAAK,CAAC,GAAG,CAAC,EAAU;QAClB,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACxC,OAAO,QAAQ,CAAC,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1D,CAAC;IAED,KAAK,CAAC,IAAI;QACR,OAAO,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9F,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,QAAkB;QAC1B,MAAM,OAAO,GAAG,aAAa,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;QACzD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU;QACrB,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,MAAoD;QAC3E,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACvC,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO,SAAS,CAAC;QAC5C,MAAM,IAAI,GAAG,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;QAC9C,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO,eAAe,CAAC,OAAO,CAAC,CAAC;QACxD,MAAM,OAAO,GAAG,aAAa,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;QACrD,IAAI,OAAO,CAAC,EAAE,KAAK,EAAE;YAAE,MAAM,IAAI,aAAa,CAAC,WAAW,EAAE,8CAA8C,CAAC,CAAC;QAC5G,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAChC,OAAO,eAAe,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;CACF;AAOD,mDAAmD;AACnD,SAAS,YAAY,CAAC,KAAc;IAClC,MAAM,IAAI,GAAI,KAA+B,CAAC,IAAI,CAAC;IACnD,OAAO,OAAO,CAAC,QAAQ,KAAK,OAAO,IAAI,CAAC,IAAI,KAAK,OAAO,IAAI,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,OAAO,CAAC,CAAC;AACrG,CAAC;AAED,MAAM,KAAK,GAAG,CAAC,EAAU,EAAiB,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAE/F;;;;;GAKG;AACH,MAAM,OAAO,iBAAiB;IAKP,IAAI;IAJhB,IAAI,GAAG,MAAM,CAAC;IACf,KAAK,GAAqB,OAAO,CAAC,OAAO,EAAE,CAAC;IAEpD,2FAA2F;IAC3F,YAAqB,IAAY;oBAAZ,IAAI;IAAW,CAAC;IAErC,KAAK,CAAC,GAAG,CAAC,EAAU;QAClB,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,IAAI;QACR,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjE,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,QAAkB;QAC1B,MAAM,OAAO,GAAG,aAAa,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;QACzD,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;YACzB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC;YACrC,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU;QACrB,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;YACzB,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YAC5C,IAAI,OAAO;gBAAE,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YACvC,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,MAAoD;QAC3E,IAAI,MAA4B,CAAC;QACjC,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;YACzB,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YACnC,IAAI,OAAO,KAAK,SAAS;gBAAE,OAAO,KAAK,CAAC;YACxC,MAAM,IAAI,GAAG,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;YAC9C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,MAAM,GAAG,OAAO,CAAC;gBACjB,OAAO,KAAK,CAAC;YACf,CAAC;YACD,MAAM,OAAO,GAAG,aAAa,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;YACrD,IAAI,OAAO,CAAC,EAAE,KAAK,EAAE;gBAAE,MAAM,IAAI,aAAa,CAAC,WAAW,EAAE,8CAA8C,CAAC,CAAC;YAC5G,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC;YAC7B,MAAM,GAAG,OAAO,CAAC;YACjB,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,iEAAiE;IACzD,KAAK,CAAC,IAAI;QAChB,IAAI,IAAY,CAAC;QACjB,IAAI,CAAC;YACH,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC3C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAK,KAA+B,CAAC,IAAI,KAAK,QAAQ;gBAAE,OAAO,EAAE,aAAa,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;YACnG,MAAM,KAAK,CAAC;QACd,CAAC;QACD,IAAI,MAAe,CAAC;QACpB,IAAI,CAAC;YACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,aAAa,CAAC,WAAW,EAAE,qBAAqB,IAAI,CAAC,IAAI,iDAAiD,CAAC,CAAC;QACxH,CAAC;QACD,MAAM,IAAI,GAAG,MAAsC,CAAC;QACpD,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,aAAa,KAAK,CAAC,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,IAAI,OAAO,IAAI,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC3I,MAAM,IAAI,aAAa,CAAC,WAAW,EAAE,qBAAqB,IAAI,CAAC,IAAI,8CAA8C,CAAC,CAAC;QACrH,CAAC;QACD,MAAM,SAAS,GAA6B,EAAE,CAAC;QAC/C,KAAK,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACzD,MAAM,QAAQ,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;YACtC,IAAI,QAAQ,CAAC,EAAE,KAAK,EAAE;gBAAE,MAAM,IAAI,aAAa,CAAC,WAAW,EAAE,qBAAqB,IAAI,CAAC,IAAI,qBAAqB,QAAQ,CAAC,EAAE,kBAAkB,EAAE,EAAE,CAAC,CAAC;YACnJ,SAAS,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC;QAC3B,CAAC;QACD,OAAO,EAAE,aAAa,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC;IACzC,CAAC;IAED,6FAA6F;IACrF,MAAM,CAAC,IAAqC;QAClD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE;YACrC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;YAC/B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAAE,OAAO;YACxB,MAAM,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACrD,MAAM,SAAS,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC;YACvE,MAAM,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,CAAC;YACzE,KAAK,IAAI,OAAO,GAAG,CAAC,GAAI,OAAO,EAAE,EAAE,CAAC;gBAClC,IAAI,CAAC;oBACH,MAAM,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;oBACnC,OAAO;gBACT,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,IAAI,OAAO,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;wBAC1C,MAAM,EAAE,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;wBACrC,MAAM,KAAK,CAAC;oBACd,CAAC;oBACD,MAAM,KAAK,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC;gBAC5B,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QACH,6CAA6C;QAC7C,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QACxC,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAED,4GAA4G;AAC5G,MAAM,CAAC,MAAM,oBAAoB,GAAkB,IAAI,mBAAmB,EAAE,CAAC"}