scrapme-flow 0.0.0-stage → 0.2.0

package/dist/src/reporting/log-error-reporter.js

@@ -0,0 +1,35 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import { inject, injectable } from 'inversify';
+import { TYPES } from '../di/types.js';
+/** Used when LIGHTY_DSN is empty: the final error of a run goes to the log (and CouchDB, via FlowRunStore). */
+let LogErrorReporter = class LogErrorReporter {
+    logger;
+    constructor(logger) {
+        this.logger = logger.child({ component: 'error-report' });
+    }
+    report(error, context) {
+        this.logger.error('flow step failed (set LIGHTY_DSN to send it to LightyErrors)', { error, ...context });
+        return '';
+    }
+    log(_message, _data, _level) {
+        // the regular logger already printed it
+    }
+    async flush() {
+        return true;
+    }
+    async close() { }
+};
+LogErrorReporter = __decorate([
+    injectable(),
+    __param(0, inject(TYPES.Logger))
+], LogErrorReporter);
+export { LogErrorReporter };
+//# sourceMappingURL=log-error-reporter.js.map

package/dist/src/reporting/log-error-reporter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log-error-reporter.js","sourceRoot":"","sources":["../../../src/reporting/log-error-reporter.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAKvC,+GAA+G;AAExG,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;IACV,MAAM,CAAS;IAEhC,YAAyC,MAAc;QACrD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,cAAc,EAAE,CAAC,CAAC;IAC5D,CAAC;IAEM,MAAM,CAAC,KAAc,EAAE,OAA2B;QACvD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,8DAA8D,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;QACzG,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,GAAG,CAAC,QAAgB,EAAE,KAA+B,EAAE,MAAkB;QAC9E,wCAAwC;IAC1C,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,KAAK,KAAmB,CAAC;CACvC,CAAA;AArBY,gBAAgB;IAD5B,UAAU,EAAE;IAIS,WAAA,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;GAH7B,gBAAgB,CAqB5B"}

package/dist/src/reporting/reporting.models.d.ts

@@ -0,0 +1,27 @@
+import type { LineLevel } from '../logging/logger.models.js';
+/** What an error report is about (sent as tags + context to LightyErrors). */
+export interface ErrorReportContext {
+    flow: string;
+    step: string;
+    command: string;
+    runId: string;
+    attempt: number;
+    maxAttempts: number;
+    /** Shortened step input. */
+    input?: unknown;
+    tags?: Record<string, string>;
+    extra?: Record<string, unknown>;
+}
+/**
+ * Error tracking for flows. FlowRunner reports every step that finally failed (once per run) and feeds
+ * the log of the run (step started/failed/retrying) so the report shows what led to the error.
+ */
+export interface ErrorReporter {
+    /** Returns the event id ('' when not reported). Never throws. */
+    report(error: unknown, context: ErrorReportContext): string;
+    /** A line of the run's log, sent with the next report (breadcrumbs). */
+    log(message: string, data?: Record<string, unknown>, level?: LineLevel): void;
+    /** Send what is waiting; true when everything was delivered. */
+    flush(timeoutMs?: number): Promise<boolean>;
+    close(timeoutMs?: number): Promise<void>;
+}

package/dist/src/reporting/reporting.models.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=reporting.models.js.map

package/dist/src/reporting/reporting.models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reporting.models.js","sourceRoot":"","sources":["../../../src/reporting/reporting.models.ts"],"names":[],"mappings":""}

package/dist/src/scrapme.d.ts

@@ -0,0 +1,61 @@
+import 'reflect-metadata';
+import type { Container } from 'inversify';
+import type { ScrapmeConfig } from './config/config.models.js';
+import type { Flow } from './flow/flow.js';
+import { type ScheduleOptions, type WaitOptions } from './flow/flow.models.js';
+import type { FlowRunDoc } from './storage/storage.models.js';
+import type { ScrapmeOptions, StartOptions } from './scrapme.models.js';
+/** waitFor gave up (the run goes on). */
+export declare class RunWaitTimeoutError extends Error {
+    readonly runId: string;
+    readonly lastStatus: string | null;
+    constructor(runId: string, lastStatus: string | null);
+}
+/**
+ * Runs flows on pg-boss queues: every run is a job, retried by pg-boss; its progress is in CouchDB (the separate
+ * scrapme monitor app shows it).
+ *
+ *   const scrapme = Scrapme.create({
+ *     container: appContainer,
+ *     postgres: { connectionString: 'postgres://…' }, couch: { url, user, password },
+ *     scrapAnything: { url, apiSecret },
+ *   });
+ *   await scrapme.start();                                           // connects pg-boss
+ *   const runId = await scrapme.flow(titlesFlow, { url: 'https://…' }); // queues a run, starts this flow's worker
+ *   const run = await scrapme.waitFor(runId);                        // optional: wait for the end
+ *   await scrapme.stop();
+ */
+export declare class Scrapme {
+    /** scrapme's own container (child of your app's container). */
+    readonly container: Container;
+    readonly config: ScrapmeConfig;
+    private static readonly DEFAULT_WAIT_MS;
+    private static readonly DEFAULT_POLL_MS;
+    private started;
+    private worker;
+    /** Flows this process runs, by name (their workers are started on first use). */
+    private readonly workers;
+    private constructor();
+    /** Checks the options (ConfigError); connects nothing yet. */
+    static create(options: ScrapmeOptions): Scrapme;
+    /** Connect pg-boss (it creates its tables on the first start). */
+    start(options?: StartOptions): Promise<void>;
+    /**
+     * Queue a run of this flow with this input; returns its run id at once. The flow runs in a worker of any process
+     * that runs this flow — this one too (unless started with `worker: false`). Throws before anything is queued for
+     * an input that doesn't fit the flow's params (FlowInputError).
+     */
+    flow(flow: Flow, input?: Readonly<Record<string, unknown>>, options?: ScheduleOptions): Promise<string>;
+    /** Run this flow's queued runs in this process (flow() does it for you; use it in a worker-only process). */
+    work(flow: Flow): Promise<void>;
+    /** The run document: status, every step with its attempts, output and error, every flow attempt. */
+    getRun(runId: string): Promise<FlowRunDoc | null>;
+    /** Newest first. */
+    listRuns(limit?: number): Promise<FlowRunDoc[]>;
+    /** Wait until the run succeeded or failed for good (polls CouchDB). Throws RunWaitTimeoutError. */
+    waitFor(runId: string, options?: WaitOptions): Promise<FlowRunDoc>;
+    /** Stop the workers (running flows get the shutdown timeout) and the queue connection. */
+    stop(): Promise<void>;
+    private requireStarted;
+    private store;
+}

package/dist/src/scrapme.js

@@ -0,0 +1,133 @@
+import 'reflect-metadata';
+import { ConfigBuilder } from './config/config-builder.js';
+import { ContainerBuilder } from './di/container.js';
+import { TYPES } from './di/types.js';
+import { FlowDefinitionError } from './flow/flow-errors.js';
+import { FINAL_RUN_STATUSES } from './flow/flow.models.js';
+import { Timing } from './util/timing.js';
+/** waitFor gave up (the run goes on). */
+export class RunWaitTimeoutError extends Error {
+    runId;
+    lastStatus;
+    constructor(runId, lastStatus) {
+        super(`run ${runId} not finished in time (last status: ${lastStatus ?? 'unknown'})`);
+        this.runId = runId;
+        this.lastStatus = lastStatus;
+        this.name = 'RunWaitTimeoutError';
+    }
+}
+/**
+ * Runs flows on pg-boss queues: every run is a job, retried by pg-boss; its progress is in CouchDB (the separate
+ * scrapme monitor app shows it).
+ *
+ *   const scrapme = Scrapme.create({
+ *     container: appContainer,
+ *     postgres: { connectionString: 'postgres://…' }, couch: { url, user, password },
+ *     scrapAnything: { url, apiSecret },
+ *   });
+ *   await scrapme.start();                                           // connects pg-boss
+ *   const runId = await scrapme.flow(titlesFlow, { url: 'https://…' }); // queues a run, starts this flow's worker
+ *   const run = await scrapme.waitFor(runId);                        // optional: wait for the end
+ *   await scrapme.stop();
+ */
+export class Scrapme {
+    container;
+    config;
+    static DEFAULT_WAIT_MS = 600_000;
+    static DEFAULT_POLL_MS = 1_000;
+    started = false;
+    worker = true;
+    /** Flows this process runs, by name (their workers are started on first use). */
+    workers = new Map();
+    constructor(
+    /** scrapme's own container (child of your app's container). */
+    container, config) {
+        this.container = container;
+        this.config = config;
+    }
+    /** Checks the options (ConfigError); connects nothing yet. */
+    static create(options) {
+        const { container, ...services } = options;
+        const config = ConfigBuilder.build(services);
+        return new Scrapme(ContainerBuilder.build(config, container), config);
+    }
+    /** Connect pg-boss (it creates its tables on the first start). */
+    async start(options = {}) {
+        if (this.started)
+            return;
+        this.worker = options.worker ?? true;
+        await this.container.get(TYPES.FlowQueue).start();
+        this.started = true;
+    }
+    /**
+     * Queue a run of this flow with this input; returns its run id at once. The flow runs in a worker of any process
+     * that runs this flow — this one too (unless started with `worker: false`). Throws before anything is queued for
+     * an input that doesn't fit the flow's params (FlowInputError).
+     */
+    async flow(flow, input = {}, options) {
+        this.requireStarted();
+        if (this.worker)
+            await this.work(flow);
+        return this.container.get(TYPES.FlowScheduler).schedule(flow, input, options);
+    }
+    /** Run this flow's queued runs in this process (flow() does it for you; use it in a worker-only process). */
+    async work(flow) {
+        this.requireStarted();
+        const known = this.workers.get(flow.name);
+        if (known) {
+            if (known.flow !== flow)
+                throw new FlowDefinitionError('another flow with this name runs here already (names must be unique)', flow.name);
+            return known.ready;
+        }
+        const processor = this.container.get(TYPES.FlowJobProcessor);
+        const queueName = this.container.get(TYPES.FlowScheduler).queueName(flow);
+        const ready = this.container.get(TYPES.FlowQueue).work(queueName, this.config.queue.concurrency, (job) => processor.process(flow, job));
+        this.workers.set(flow.name, { flow, ready });
+        try {
+            await ready;
+        }
+        catch (error) {
+            this.workers.delete(flow.name);
+            throw error;
+        }
+    }
+    /** The run document: status, every step with its attempts, output and error, every flow attempt. */
+    async getRun(runId) {
+        return this.store().get(runId);
+    }
+    /** Newest first. */
+    async listRuns(limit = 50) {
+        return this.store().list(limit);
+    }
+    /** Wait until the run succeeded or failed for good (polls CouchDB). Throws RunWaitTimeoutError. */
+    async waitFor(runId, options = {}) {
+        const deadline = Date.now() + (options.timeoutMs ?? Scrapme.DEFAULT_WAIT_MS);
+        let last = null;
+        for (;;) {
+            last = await this.getRun(runId);
+            if (last && FINAL_RUN_STATUSES.includes(last.status))
+                return last;
+            const left = deadline - Date.now();
+            if (left <= 0)
+                throw new RunWaitTimeoutError(runId, last?.status ?? null);
+            await Timing.sleep(Math.min(options.pollIntervalMs ?? Scrapme.DEFAULT_POLL_MS, left));
+        }
+    }
+    /** Stop the workers (running flows get the shutdown timeout) and the queue connection. */
+    async stop() {
+        if (!this.started)
+            return;
+        this.started = false;
+        this.workers.clear();
+        await this.container.get(TYPES.FlowQueue).stop();
+        await this.container.get(TYPES.ErrorReporter).close();
+    }
+    requireStarted() {
+        if (!this.started)
+            throw new Error('scrapme is not started - call await scrapme.start() first');
+    }
+    store() {
+        return this.container.get(TYPES.RunStore);
+    }
+}
+//# sourceMappingURL=scrapme.js.map

package/dist/src/scrapme.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scrapme.js","sourceRoot":"","sources":["../../src/scrapme.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAE3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAI5D,OAAO,EAAE,kBAAkB,EAA0C,MAAM,uBAAuB,CAAC;AAKnG,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,yCAAyC;AACzC,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IAE1B;IACA;IAFlB,YACkB,KAAa,EACb,UAAyB;QAEzC,KAAK,CAAC,OAAO,KAAK,uCAAuC,UAAU,IAAI,SAAS,GAAG,CAAC,CAAC;QAHrE,UAAK,GAAL,KAAK,CAAQ;QACb,eAAU,GAAV,UAAU,CAAe;QAGzC,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;IACpC,CAAC;CACF;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,OAAO;IAUA;IACA;IAVV,MAAM,CAAU,eAAe,GAAG,OAAO,CAAC;IAC1C,MAAM,CAAU,eAAe,GAAG,KAAK,CAAC;IACxC,OAAO,GAAG,KAAK,CAAC;IAChB,MAAM,GAAG,IAAI,CAAC;IACtB,iFAAiF;IAChE,OAAO,GAAG,IAAI,GAAG,EAAgD,CAAC;IAEnF;IACE,+DAA+D;IAC/C,SAAoB,EACpB,MAAqB;QADrB,cAAS,GAAT,SAAS,CAAW;QACpB,WAAM,GAAN,MAAM,CAAe;IACpC,CAAC;IAEJ,8DAA8D;IACvD,MAAM,CAAC,MAAM,CAAC,OAAuB;QAC1C,MAAM,EAAE,SAAS,EAAE,GAAG,QAAQ,EAAE,GAAG,OAAO,CAAC;QAC3C,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC7C,OAAO,IAAI,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,CAAC,CAAC;IACxE,CAAC;IAED,kEAAkE;IAC3D,KAAK,CAAC,KAAK,CAAC,UAAwB,EAAE;QAC3C,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO;QACzB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC;QACrC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAY,KAAK,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,CAAC;QAC7D,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CAAC,IAAU,EAAE,QAA2C,EAAE,EAAE,OAAyB;QACpG,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAgB,KAAK,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAC/F,CAAC;IAED,6GAA6G;IACtG,KAAK,CAAC,IAAI,CAAC,IAAU;QAC1B,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI;gBAAE,MAAM,IAAI,mBAAmB,CAAC,sEAAsE,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAC1I,OAAO,KAAK,CAAC,KAAK,CAAC;QACrB,CAAC;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAmB,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAC/E,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAgB,KAAK,CAAC,aAAa,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACzF,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAY,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;QACnJ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QAC7C,IAAI,CAAC;YACH,MAAM,KAAK,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/B,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,oGAAoG;IAC7F,KAAK,CAAC,MAAM,CAAC,KAAa;QAC/B,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAED,oBAAoB;IACb,KAAK,CAAC,QAAQ,CAAC,KAAK,GAAG,EAAE;QAC9B,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,mGAAmG;IAC5F,KAAK,CAAC,OAAO,CAAC,KAAa,EAAE,UAAuB,EAAE;QAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;QAC7E,IAAI,IAAI,GAAsB,IAAI,CAAC;QACnC,SAAS,CAAC;YACR,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAChC,IAAI,IAAI,IAAI,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC;gBAAE,OAAO,IAAI,CAAC;YAClE,MAAM,IAAI,GAAG,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACnC,IAAI,IAAI,IAAI,CAAC;gBAAE,MAAM,IAAI,mBAAmB,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,IAAI,IAAI,CAAC,CAAC;YAC1E,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,cAAc,IAAI,OAAO,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC;QACxF,CAAC;IACH,CAAC;IAED,0FAA0F;IACnF,KAAK,CAAC,IAAI;QACf,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO;QAC1B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrB,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAY,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC;QAC5D,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAgB,KAAK,CAAC,aAAa,CAAC,CAAC,KAAK,EAAE,CAAC;IACvE,CAAC;IAEO,cAAc;QACpB,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;IAClG,CAAC;IAEO,KAAK;QACX,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAW,KAAK,CAAC,QAAQ,CAAC,CAAC;IACtD,CAAC"}

package/dist/src/scrapme.models.d.ts

@@ -0,0 +1,18 @@
+import type { Container } from 'inversify';
+import type { ServiceOptions } from './config/config.models.js';
+/**
+ * What Scrapme.create needs: the app's container and the services scrapme connects to (postgres and couch required;
+ * scrapAnything, mail, lighty when used — see ServiceOptions). scrapme reads no environment variables:
+ * the app passes everything. Flows are not registered here — pass them to scrapme.flow().
+ */
+export interface ScrapmeOptions extends ServiceOptions {
+    /**
+     * Your app's container. Commands are created by scrapme (no bindings needed) and their `@inject(...)`s are
+     * looked up here, so they can use your services. Use the same `inversify` as scrapme (it is a peer dependency).
+     */
+    container?: Container;
+}
+export interface StartOptions {
+    /** Run the flows this process schedules (default true). false = only schedule; workers run elsewhere (scrapme.work). */
+    worker?: boolean;
+}

package/dist/src/scrapme.models.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=scrapme.models.js.map

package/dist/src/scrapme.models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scrapme.models.js","sourceRoot":"","sources":["../../src/scrapme.models.ts"],"names":[],"mappings":""}

package/dist/src/storage/couch-connection.d.ts

@@ -0,0 +1,19 @@
+import type { CouchConfig } from '../config/config.models.js';
+import type { Logger } from '../logging/logger.js';
+import { CouchDatabase } from './couch-database.js';
+import type { CouchDatabases } from './storage.models.js';
+/** Shared HTTP connection to CouchDB; hands out CouchDatabase objects (one per name, cached). */
+export declare class CouchConnection implements CouchDatabases {
+    private readonly couch;
+    private static readonly PING_TIMEOUT_MS;
+    private static readonly UP_PATH;
+    private static readonly OK;
+    private static readonly RETRY_METHODS;
+    private http;
+    private readonly databases;
+    private readonly logger;
+    constructor(couch: CouchConfig, logger: Logger);
+    database(name: string): CouchDatabase;
+    ping(): Promise<boolean>;
+    private client;
+}

package/dist/src/storage/couch-connection.js

@@ -0,0 +1,67 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var CouchConnection_1;
+import got, {} from 'got';
+import { inject, injectable } from 'inversify';
+import { TYPES } from '../di/types.js';
+import { CouchDatabase } from './couch-database.js';
+/** Shared HTTP connection to CouchDB; hands out CouchDatabase objects (one per name, cached). */
+let CouchConnection = class CouchConnection {
+    static { CouchConnection_1 = this; }
+    couch;
+    static PING_TIMEOUT_MS = 3_000;
+    static UP_PATH = '_up';
+    static OK = 200;
+    static RETRY_METHODS = ['GET', 'PUT', 'HEAD'];
+    http = null;
+    databases = new Map();
+    logger;
+    constructor(couch, logger) {
+        this.couch = couch;
+        this.logger = logger.child({ component: 'couch' });
+    }
+    database(name) {
+        let db = this.databases.get(name);
+        if (!db) {
+            db = new CouchDatabase(name, this.client(), this.couch.publicUrl, this.logger);
+            this.databases.set(name, db);
+        }
+        return db;
+    }
+    async ping() {
+        try {
+            const res = await this.client().get(CouchConnection_1.UP_PATH, { retry: { limit: 0 }, timeout: { request: CouchConnection_1.PING_TIMEOUT_MS } });
+            return res.statusCode === CouchConnection_1.OK;
+        }
+        catch {
+            return false;
+        }
+    }
+    client() {
+        this.http ??= got.extend({
+            prefixUrl: this.couch.url,
+            username: this.couch.user,
+            password: this.couch.password,
+            responseType: 'json',
+            throwHttpErrors: false,
+            timeout: { request: this.couch.timeoutMs },
+            // PUT is safe to retry here: creates answer 409 the second time, upserts re-read the _rev.
+            retry: { limit: this.couch.retryLimit, methods: [...CouchConnection_1.RETRY_METHODS] },
+        });
+        return this.http;
+    }
+};
+CouchConnection = CouchConnection_1 = __decorate([
+    injectable(),
+    __param(0, inject(TYPES.CouchConfig)),
+    __param(1, inject(TYPES.Logger))
+], CouchConnection);
+export { CouchConnection };
+//# sourceMappingURL=couch-connection.js.map

package/dist/src/storage/couch-connection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"couch-connection.js","sourceRoot":"","sources":["../../../src/storage/couch-connection.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,OAAO,GAAG,EAAE,EAAY,MAAM,KAAK,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAE/C,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAGpD,iGAAiG;AAE1F,IAAM,eAAe,GAArB,MAAM,eAAe;;IAUoB;IATtC,MAAM,CAAU,eAAe,GAAG,KAAK,CAAC;IACxC,MAAM,CAAU,OAAO,GAAG,KAAK,CAAC;IAChC,MAAM,CAAU,EAAE,GAAG,GAAG,CAAC;IACzB,MAAM,CAAU,aAAa,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAU,CAAC;IAChE,IAAI,GAAe,IAAI,CAAC;IACf,SAAS,GAAG,IAAI,GAAG,EAAyB,CAAC;IAC7C,MAAM,CAAS;IAEhC,YAC8C,KAAkB,EACxC,MAAc;QADQ,UAAK,GAAL,KAAK,CAAa;QAG9D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC;IACrD,CAAC;IAEM,QAAQ,CAAC,IAAY;QAC1B,IAAI,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,EAAE,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YAC/E,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC/B,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,KAAK,CAAC,IAAI;QACf,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,iBAAe,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,iBAAe,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;YAC7I,OAAO,GAAG,CAAC,UAAU,KAAK,iBAAe,CAAC,EAAE,CAAC;QAC/C,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAEO,MAAM;QACZ,IAAI,CAAC,IAAI,KAAK,GAAG,CAAC,MAAM,CAAC;YACvB,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG;YACzB,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI;YACzB,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ;YAC7B,YAAY,EAAE,MAAM;YACpB,eAAe,EAAE,KAAK;YACtB,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;YAC1C,2FAA2F;YAC3F,KAAK,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,OAAO,EAAE,CAAC,GAAG,iBAAe,CAAC,aAAa,CAAC,EAAE;SACrF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;;AA9CU,eAAe;IAD3B,UAAU,EAAE;IAWR,WAAA,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;IACzB,WAAA,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;GAXZ,eAAe,CA+C3B"}

package/dist/src/storage/couch-database.d.ts

@@ -0,0 +1,44 @@
+import type { Got } from 'got';
+import type { Logger } from '../logging/logger.js';
+import { type CouchDatabaseApi, type CouchDoc, type CreateResult } from './storage.models.js';
+/**
+ * One CouchDB database over a shared got instance. Created by CouchConnection. The database is created on first
+ * use (idempotent), so a fresh CouchDB needs no setup step.
+ */
+export declare class CouchDatabase implements CouchDatabaseApi {
+    readonly name: string;
+    private readonly http;
+    private readonly publicUrl;
+    private readonly logger;
+    private static readonly CONFLICT_ATTEMPTS;
+    private static readonly OK;
+    /** 201 written, 202 accepted (written, not yet on every node). */
+    private static readonly WRITTEN;
+    private static readonly NOT_FOUND;
+    private static readonly CONFLICT;
+    /** PUT /<db> when the database exists. */
+    private static readonly DB_EXISTS;
+    private static readonly FAUXTON;
+    private static readonly ALL_DOCS;
+    /** CouchDB's documented "end of a prefix range" character. */
+    private static readonly HIGHEST_CHAR;
+    private ready;
+    constructor(name: string, http: Got, publicUrl: string, logger: Logger);
+    get<T extends CouchDoc>(id: string): Promise<T | null>;
+    /** Write a new document; 'exists' when the id is taken (never overwrites). */
+    create(doc: CouchDoc): Promise<CreateResult>;
+    /** Create or replace a document (optimistic locking, retried on conflicts). */
+    upsert(doc: CouchDoc): Promise<{
+        rev: string;
+        created: boolean;
+    }>;
+    /** Read-modify-write with optimistic locking: on a conflict the document is read again and `change` re-applied. */
+    update<T extends CouchDoc>(id: string, change: (doc: T) => void): Promise<T | null>;
+    /** `_all_docs` over an id range: every id that starts with `prefix`. */
+    byPrefix<T extends CouchDoc>(prefix: string, limit: number, descending?: boolean): Promise<T[]>;
+    docUrl(id: string): string;
+    dbUrl(): string;
+    /** PUT /<db> once per process: 201 created, 412 exists. */
+    private ensure;
+    private docPath;
+}

package/dist/src/storage/couch-database.js

@@ -0,0 +1,118 @@
+import { CouchError } from './couch-error.js';
+import { CREATE_RESULT } from './storage.models.js';
+/**
+ * One CouchDB database over a shared got instance. Created by CouchConnection. The database is created on first
+ * use (idempotent), so a fresh CouchDB needs no setup step.
+ */
+export class CouchDatabase {
+    name;
+    http;
+    publicUrl;
+    logger;
+    static CONFLICT_ATTEMPTS = 5;
+    static OK = 200;
+    /** 201 written, 202 accepted (written, not yet on every node). */
+    static WRITTEN = new Set([201, 202]);
+    static NOT_FOUND = 404;
+    static CONFLICT = 409;
+    /** PUT /<db> when the database exists. */
+    static DB_EXISTS = 412;
+    static FAUXTON = '_utils/#database';
+    static ALL_DOCS = '_all_docs';
+    /** CouchDB's documented "end of a prefix range" character. */
+    static HIGHEST_CHAR = '\ufff0';
+    ready = null;
+    constructor(name, http, publicUrl, logger) {
+        this.name = name;
+        this.http = http;
+        this.publicUrl = publicUrl;
+        this.logger = logger;
+    }
+    async get(id) {
+        await this.ensure();
+        const res = await this.http.get(this.docPath(id));
+        if (res.statusCode === CouchDatabase.NOT_FOUND)
+            return null;
+        if (res.statusCode !== CouchDatabase.OK)
+            throw new CouchError(`GET ${this.name}/${id}`, res.statusCode, res.body);
+        return res.body;
+    }
+    /** Write a new document; 'exists' when the id is taken (never overwrites). */
+    async create(doc) {
+        await this.ensure();
+        const { _rev: _ignored, ...body } = doc;
+        const res = await this.http.put(this.docPath(doc._id), { json: body });
+        if (CouchDatabase.WRITTEN.has(res.statusCode))
+            return CREATE_RESULT.CREATED;
+        if (res.statusCode === CouchDatabase.CONFLICT)
+            return CREATE_RESULT.EXISTS;
+        throw new CouchError(`create ${this.name}/${doc._id}`, res.statusCode, res.body);
+    }
+    /** Create or replace a document (optimistic locking, retried on conflicts). */
+    async upsert(doc) {
+        await this.ensure();
+        for (let attempt = 1; attempt <= CouchDatabase.CONFLICT_ATTEMPTS; attempt++) {
+            const current = await this.get(doc._id);
+            const body = { ...doc, ...(current?._rev ? { _rev: current._rev } : {}) };
+            if (!current)
+                delete body._rev;
+            const res = await this.http.put(this.docPath(doc._id), { json: body });
+            if (CouchDatabase.WRITTEN.has(res.statusCode))
+                return { rev: res.body.rev, created: !current };
+            if (res.statusCode !== CouchDatabase.CONFLICT)
+                throw new CouchError(`upsert ${this.name}/${doc._id}`, res.statusCode, res.body);
+        }
+        throw new CouchError(`upsert ${this.name}/${doc._id} (too many conflicts)`, CouchDatabase.CONFLICT, null);
+    }
+    /** Read-modify-write with optimistic locking: on a conflict the document is read again and `change` re-applied. */
+    async update(id, change) {
+        await this.ensure();
+        for (let attempt = 1; attempt <= CouchDatabase.CONFLICT_ATTEMPTS; attempt++) {
+            const doc = await this.get(id);
+            if (!doc)
+                return null;
+            change(doc);
+            const res = await this.http.put(this.docPath(id), { json: doc });
+            if (CouchDatabase.WRITTEN.has(res.statusCode))
+                return { ...doc, _rev: res.body.rev };
+            if (res.statusCode !== CouchDatabase.CONFLICT)
+                throw new CouchError(`update ${this.name}/${id}`, res.statusCode, res.body);
+        }
+        throw new CouchError(`update ${this.name}/${id} (too many conflicts)`, CouchDatabase.CONFLICT, null);
+    }
+    /** `_all_docs` over an id range: every id that starts with `prefix`. */
+    async byPrefix(prefix, limit, descending = false) {
+        await this.ensure();
+        const low = JSON.stringify(prefix);
+        const high = JSON.stringify(prefix + CouchDatabase.HIGHEST_CHAR);
+        const searchParams = { include_docs: 'true', limit: String(limit), descending: String(descending), startkey: descending ? high : low, endkey: descending ? low : high };
+        const res = await this.http.get(`${encodeURIComponent(this.name)}/${CouchDatabase.ALL_DOCS}`, { searchParams });
+        if (res.statusCode !== CouchDatabase.OK)
+            throw new CouchError(`list ${this.name}/${prefix}*`, res.statusCode, res.body);
+        return res.body.rows.flatMap((r) => (r.doc ? [r.doc] : []));
+    }
+    docUrl(id) {
+        return `${this.publicUrl}/${CouchDatabase.FAUXTON}/${encodeURIComponent(this.name)}/${encodeURIComponent(id)}`;
+    }
+    dbUrl() {
+        return `${this.publicUrl}/${CouchDatabase.FAUXTON}/${encodeURIComponent(this.name)}/${CouchDatabase.ALL_DOCS}`;
+    }
+    /** PUT /<db> once per process: 201 created, 412 exists. */
+    ensure() {
+        this.ready ??= (async () => {
+            const res = await this.http.put(encodeURIComponent(this.name));
+            if (!CouchDatabase.WRITTEN.has(res.statusCode) && res.statusCode !== CouchDatabase.DB_EXISTS)
+                throw new CouchError(`create db ${this.name}`, res.statusCode, res.body);
+            if (res.statusCode !== CouchDatabase.DB_EXISTS)
+                this.logger.info('couchdb database created', { db: this.name });
+        })().catch((err) => {
+            this.ready = null; // try again next time (CouchDB may come up later)
+            throw err;
+        });
+        return this.ready;
+    }
+    docPath(id) {
+        return `${encodeURIComponent(this.name)}/${encodeURIComponent(id)}`;
+    }
+}
+//# sourceMappingURL=couch-database.js.map

package/dist/src/storage/couch-database.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"couch-database.js","sourceRoot":"","sources":["../../../src/storage/couch-database.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAA2D,MAAM,qBAAqB,CAAC;AAE7G;;;GAGG;AACH,MAAM,OAAO,aAAa;IAgBN;IACC;IACA;IACA;IAlBX,MAAM,CAAU,iBAAiB,GAAG,CAAC,CAAC;IACtC,MAAM,CAAU,EAAE,GAAG,GAAG,CAAC;IACjC,kEAAkE;IAC1D,MAAM,CAAU,OAAO,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IAC9C,MAAM,CAAU,SAAS,GAAG,GAAG,CAAC;IAChC,MAAM,CAAU,QAAQ,GAAG,GAAG,CAAC;IACvC,0CAA0C;IAClC,MAAM,CAAU,SAAS,GAAG,GAAG,CAAC;IAChC,MAAM,CAAU,OAAO,GAAG,kBAAkB,CAAC;IAC7C,MAAM,CAAU,QAAQ,GAAG,WAAW,CAAC;IAC/C,8DAA8D;IACtD,MAAM,CAAU,YAAY,GAAG,QAAQ,CAAC;IACxC,KAAK,GAAyB,IAAI,CAAC;IAE3C,YACkB,IAAY,EACX,IAAS,EACT,SAAiB,EACjB,MAAc;QAHf,SAAI,GAAJ,IAAI,CAAQ;QACX,SAAI,GAAJ,IAAI,CAAK;QACT,cAAS,GAAT,SAAS,CAAQ;QACjB,WAAM,GAAN,MAAM,CAAQ;IAC9B,CAAC;IAEG,KAAK,CAAC,GAAG,CAAqB,EAAU;QAC7C,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACpB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QACrD,IAAI,GAAG,CAAC,UAAU,KAAK,aAAa,CAAC,SAAS;YAAE,OAAO,IAAI,CAAC;QAC5D,IAAI,GAAG,CAAC,UAAU,KAAK,aAAa,CAAC,EAAE;YAAE,MAAM,IAAI,UAAU,CAAC,OAAO,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE,EAAE,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;QAClH,OAAO,GAAG,CAAC,IAAI,CAAC;IAClB,CAAC;IAED,8EAA8E;IACvE,KAAK,CAAC,MAAM,CAAC,GAAa;QAC/B,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACpB,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,GAAG,CAAC;QACxC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACvE,IAAI,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC;YAAE,OAAO,aAAa,CAAC,OAAO,CAAC;QAC5E,IAAI,GAAG,CAAC,UAAU,KAAK,aAAa,CAAC,QAAQ;YAAE,OAAO,aAAa,CAAC,MAAM,CAAC;QAC3E,MAAM,IAAI,UAAU,CAAC,UAAU,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,GAAG,EAAE,EAAE,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;IACnF,CAAC;IAED,+EAA+E;IACxE,KAAK,CAAC,MAAM,CAAC,GAAa;QAC/B,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACpB,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,aAAa,CAAC,iBAAiB,EAAE,OAAO,EAAE,EAAE,CAAC;YAC5E,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,GAAG,CAAW,GAAG,CAAC,GAAG,CAAC,CAAC;YAClD,MAAM,IAAI,GAAG,EAAE,GAAG,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;YAC1E,IAAI,CAAC,OAAO;gBAAE,OAAO,IAAI,CAAC,IAAI,CAAC;YAC/B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAkB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YACxF,IAAI,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC;gBAAE,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,CAAC,OAAO,EAAE,CAAC;YAC/F,IAAI,GAAG,CAAC,UAAU,KAAK,aAAa,CAAC,QAAQ;gBAAE,MAAM,IAAI,UAAU,CAAC,UAAU,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,GAAG,EAAE,EAAE,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;QAClI,CAAC;QACD,MAAM,IAAI,UAAU,CAAC,UAAU,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,GAAG,uBAAuB,EAAE,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC5G,CAAC;IAED,mHAAmH;IAC5G,KAAK,CAAC,MAAM,CAAqB,EAAU,EAAE,MAAwB;QAC1E,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACpB,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,aAAa,CAAC,iBAAiB,EAAE,OAAO,EAAE,EAAE,CAAC;YAC5E,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,GAAG,CAAI,EAAE,CAAC,CAAC;YAClC,IAAI,CAAC,GAAG;gBAAE,OAAO,IAAI,CAAC;YACtB,MAAM,CAAC,GAAG,CAAC,CAAC;YACZ,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAkB,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;YAClF,IAAI,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC;gBAAE,OAAO,EAAE,GAAG,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YACrF,IAAI,GAAG,CAAC,UAAU,KAAK,aAAa,CAAC,QAAQ;gBAAE,MAAM,IAAI,UAAU,CAAC,UAAU,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE,EAAE,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;QAC7H,CAAC;QACD,MAAM,IAAI,UAAU,CAAC,UAAU,IAAI,CAAC,IAAI,IAAI,EAAE,uBAAuB,EAAE,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACvG,CAAC;IAED,wEAAwE;IACjE,KAAK,CAAC,QAAQ,CAAqB,MAAc,EAAE,KAAa,EAAE,UAAU,GAAG,KAAK;QACzF,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACpB,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACnC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;QACjE,MAAM,YAAY,GAAG,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACxK,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAA0B,GAAG,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,QAAQ,EAAE,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC;QACzI,IAAI,GAAG,CAAC,UAAU,KAAK,aAAa,CAAC,EAAE;YAAE,MAAM,IAAI,UAAU,CAAC,QAAQ,IAAI,CAAC,IAAI,IAAI,MAAM,GAAG,EAAE,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;QACxH,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9D,CAAC;IAEM,MAAM,CAAC,EAAU;QACtB,OAAO,GAAG,IAAI,CAAC,SAAS,IAAI,aAAa,CAAC,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAAC;IACjH,CAAC;IAEM,KAAK;QACV,OAAO,GAAG,IAAI,CAAC,SAAS,IAAI,aAAa,CAAC,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,QAAQ,EAAE,CAAC;IACjH,CAAC;IAED,2DAA2D;IACnD,MAAM;QACZ,IAAI,CAAC,KAAK,KAAK,CAAC,KAAK,IAAI,EAAE;YACzB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YAC/D,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC,UAAU,KAAK,aAAa,CAAC,SAAS;gBAAE,MAAM,IAAI,UAAU,CAAC,aAAa,IAAI,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;YACvK,IAAI,GAAG,CAAC,UAAU,KAAK,aAAa,CAAC,SAAS;gBAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QAClH,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,GAAY,EAAE,EAAE;YAC1B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,kDAAkD;YACrE,MAAM,GAAG,CAAC;QACZ,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAEO,OAAO,CAAC,EAAU;QACxB,OAAO,GAAG,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAAC;IACtE,CAAC"}

package/dist/src/storage/couch-document-store.d.ts

@@ -0,0 +1,14 @@
+import type { CouchConfig } from '../config/config.models.js';
+import type { CouchDatabases, CouchDoc, DocumentStore, SavedDocument } from './storage.models.js';
+/** DocumentStore on CouchDB: couch.db by default, any database by name. */
+export declare class CouchDocumentStore implements DocumentStore {
+    private readonly config;
+    private readonly couch;
+    constructor(config: CouchConfig, couch: CouchDatabases);
+    save(id: string, document: Record<string, unknown>, options?: {
+        db?: string;
+    }): Promise<SavedDocument>;
+    get<T extends object>(id: string, options?: {
+        db?: string;
+    }): Promise<(T & CouchDoc) | null>;
+}

package/dist/src/storage/couch-document-store.js

@@ -0,0 +1,36 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import { inject, injectable } from 'inversify';
+import { TYPES } from '../di/types.js';
+/** DocumentStore on CouchDB: couch.db by default, any database by name. */
+let CouchDocumentStore = class CouchDocumentStore {
+    config;
+    couch;
+    constructor(config, couch) {
+        this.config = config;
+        this.couch = couch;
+    }
+    async save(id, document, options = {}) {
+        const db = this.couch.database(options.db ?? this.config.db);
+        const { _id: _ignoredId, _rev: _ignoredRev, ...body } = document;
+        const { rev, created } = await db.upsert({ ...body, _id: id, savedAt: new Date().toISOString() });
+        return { db: db.name, id, rev, created, url: db.docUrl(id) };
+    }
+    async get(id, options = {}) {
+        return this.couch.database(options.db ?? this.config.db).get(id);
+    }
+};
+CouchDocumentStore = __decorate([
+    injectable(),
+    __param(0, inject(TYPES.CouchConfig)),
+    __param(1, inject(TYPES.CouchConnection))
+], CouchDocumentStore);
+export { CouchDocumentStore };
+//# sourceMappingURL=couch-document-store.js.map

package/dist/src/storage/couch-document-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"couch-document-store.js","sourceRoot":"","sources":["../../../src/storage/couch-document-store.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAE/C,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAGvC,2EAA2E;AAEpE,IAAM,kBAAkB,GAAxB,MAAM,kBAAkB;IAEiB;IACI;IAFlD,YAC8C,MAAmB,EACf,KAAqB;QADzB,WAAM,GAAN,MAAM,CAAa;QACf,UAAK,GAAL,KAAK,CAAgB;IACpE,CAAC;IAEG,KAAK,CAAC,IAAI,CAAC,EAAU,EAAE,QAAiC,EAAE,UAA2B,EAAE;QAC5F,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC7D,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,QAAQ,CAAC;QACjE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAClG,OAAO,EAAE,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;IAC/D,CAAC;IAEM,KAAK,CAAC,GAAG,CAAmB,EAAU,EAAE,UAA2B,EAAE;QAC1E,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,CAAe,EAAE,CAAC,CAAC;IACjF,CAAC;CACF,CAAA;AAhBY,kBAAkB;IAD9B,UAAU,EAAE;IAGR,WAAA,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;IACzB,WAAA,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAA;GAHrB,kBAAkB,CAgB9B"}