@agendajs/postgres-backend 1.0.0-alpha.0

package/dist/PostgresNotificationChannel.js

@@ -0,0 +1,170 @@
+import debug from 'debug';
+import { Pool } from 'pg';
+import { BaseNotificationChannel, toJobId } from 'agenda';
+const log = debug('agenda:postgres:notification');
+/**
+ * PostgreSQL notification channel using LISTEN/NOTIFY
+ *
+ * This implementation uses PostgreSQL's built-in pub/sub mechanism
+ * for real-time job notifications across multiple processes.
+ */
+export class PostgresNotificationChannel extends BaseNotificationChannel {
+    pool;
+    ownPool = false;
+    connectionString;
+    listenClient;
+    constructor(config = {}) {
+        super(config);
+        if (config.pool) {
+            this.pool = config.pool;
+            this.ownPool = false;
+        }
+        else if (config.connectionString) {
+            this.connectionString = config.connectionString;
+            this.ownPool = true;
+        }
+    }
+    /**
+     * Set the pool (used when created by PostgresBackend)
+     */
+    setPool(pool) {
+        if (this.pool && this.ownPool) {
+            throw new Error('Cannot set pool on channel with own pool');
+        }
+        this.pool = pool;
+        this.ownPool = false;
+    }
+    async connect() {
+        log('connecting notification channel');
+        this.clearReconnect();
+        try {
+            // Create own pool if needed
+            if (!this.pool && this.connectionString) {
+                this.pool = new Pool({ connectionString: this.connectionString });
+                this.ownPool = true;
+            }
+            if (!this.pool) {
+                throw new Error('PostgresNotificationChannel requires pool or connectionString');
+            }
+            // Get a dedicated connection for LISTEN
+            this.listenClient = await this.pool.connect();
+            // Set up notification handler
+            this.listenClient.on('notification', msg => {
+                if (msg.channel === this.config.channelName && msg.payload) {
+                    try {
+                        const notification = this.parseNotification(msg.payload);
+                        log('received notification: %O', notification);
+                        this.notifyHandlers(notification).catch(err => {
+                            this.emit('error', err);
+                        });
+                    }
+                    catch (error) {
+                        log('error parsing notification: %O', error);
+                        this.emit('error', error);
+                    }
+                }
+            });
+            // Handle connection errors
+            this.listenClient.on('error', error => {
+                log('listen client error: %O', error);
+                this.emit('error', error);
+                // Try to reconnect if the connection was lost
+                if (this._state === 'connected') {
+                    this.handleConnectionLoss();
+                }
+            });
+            // Start listening
+            await this.listenClient.query(`LISTEN "${this.config.channelName}"`);
+            log('listening on channel: %s', this.config.channelName);
+            this.setState('connected');
+        }
+        catch (error) {
+            log('connection failed: %O', error);
+            this.emit('error', error);
+            this.scheduleReconnect();
+            throw error;
+        }
+    }
+    handleConnectionLoss() {
+        log('handling connection loss');
+        // Clean up the listen client
+        if (this.listenClient) {
+            try {
+                this.listenClient.release(true); // Destroy the client
+            }
+            catch {
+                // Ignore release errors
+            }
+            this.listenClient = undefined;
+        }
+        this.scheduleReconnect();
+    }
+    async disconnect() {
+        log('disconnecting notification channel');
+        this.clearReconnect();
+        if (this.listenClient) {
+            try {
+                await this.listenClient.query(`UNLISTEN "${this.config.channelName}"`);
+            }
+            catch {
+                // Ignore UNLISTEN errors (connection might be dead)
+            }
+            try {
+                this.listenClient.release();
+            }
+            catch {
+                // Ignore release errors
+            }
+            this.listenClient = undefined;
+        }
+        // Only close pool if we created it
+        if (this.ownPool && this.pool) {
+            await this.pool.end();
+            this.pool = undefined;
+        }
+        this.handlers.clear();
+        this.setState('disconnected');
+    }
+    async publish(notification) {
+        if (this._state !== 'connected') {
+            throw new Error('Cannot publish: channel not connected');
+        }
+        if (!this.pool) {
+            throw new Error('Cannot publish: no pool available');
+        }
+        const payload = this.serializeNotification(notification);
+        log('publishing notification: %s', payload);
+        // NOTIFY doesn't support parameterized queries, so we must escape the payload
+        // PostgreSQL escapes single quotes by doubling them
+        const escapedPayload = payload.replace(/'/g, "''");
+        await this.pool.query(`NOTIFY "${this.config.channelName}", '${escapedPayload}'`);
+    }
+    /**
+     * Serialize notification to JSON string for NOTIFY payload
+     */
+    serializeNotification(notification) {
+        return JSON.stringify({
+            jobId: notification.jobId,
+            jobName: notification.jobName,
+            nextRunAt: notification.nextRunAt?.toISOString() || null,
+            priority: notification.priority,
+            timestamp: notification.timestamp.toISOString(),
+            source: notification.source
+        });
+    }
+    /**
+     * Parse notification from JSON string received via LISTEN
+     */
+    parseNotification(payload) {
+        const data = JSON.parse(payload);
+        return {
+            jobId: toJobId(data.jobId),
+            jobName: data.jobName,
+            nextRunAt: data.nextRunAt ? new Date(data.nextRunAt) : null,
+            priority: data.priority,
+            timestamp: new Date(data.timestamp),
+            source: data.source
+        };
+    }
+}
+//# sourceMappingURL=PostgresNotificationChannel.js.map

package/dist/PostgresNotificationChannel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PostgresNotificationChannel.js","sourceRoot":"","sources":["../src/PostgresNotificationChannel.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,IAAI,EAAc,MAAM,IAAI,CAAC;AAEtC,OAAO,EAAE,uBAAuB,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAE1D,MAAM,GAAG,GAAG,KAAK,CAAC,8BAA8B,CAAC,CAAC;AAYlD;;;;;GAKG;AACH,MAAM,OAAO,2BAA4B,SAAQ,uBAAuB;IAC/D,IAAI,CAAQ;IACZ,OAAO,GAAY,KAAK,CAAC;IACzB,gBAAgB,CAAU;IAC1B,YAAY,CAAc;IAElC,YAAY,SAA4C,EAAE;QACzD,KAAK,CAAC,MAAM,CAAC,CAAC;QAEd,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YACjB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;YACxB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACtB,CAAC;aAAM,IAAI,MAAM,CAAC,gBAAgB,EAAE,CAAC;YACpC,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;YAChD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACrB,CAAC;IACF,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,IAAU;QACjB,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC7D,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,OAAO;QACZ,GAAG,CAAC,iCAAiC,CAAC,CAAC;QACvC,IAAI,CAAC,cAAc,EAAE,CAAC;QAEtB,IAAI,CAAC;YACJ,4BAA4B;YAC5B,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACzC,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,CAAC,EAAE,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;gBAClE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;YACrB,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gBAChB,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;YAClF,CAAC;YAED,wCAAwC;YACxC,IAAI,CAAC,YAAY,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAE9C,8BAA8B;YAC9B,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,cAAc,EAAE,GAAG,CAAC,EAAE;gBAC1C,IAAI,GAAG,CAAC,OAAO,KAAK,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;oBAC5D,IAAI,CAAC;wBACJ,MAAM,YAAY,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;wBACzD,GAAG,CAAC,2BAA2B,EAAE,YAAY,CAAC,CAAC;wBAC/C,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;4BAC7C,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;wBACzB,CAAC,CAAC,CAAC;oBACJ,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBAChB,GAAG,CAAC,gCAAgC,EAAE,KAAK,CAAC,CAAC;wBAC7C,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAc,CAAC,CAAC;oBACpC,CAAC;gBACF,CAAC;YACF,CAAC,CAAC,CAAC;YAEH,2BAA2B;YAC3B,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE;gBACrC,GAAG,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC;gBACtC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;gBAE1B,8CAA8C;gBAC9C,IAAI,IAAI,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;oBACjC,IAAI,CAAC,oBAAoB,EAAE,CAAC;gBAC7B,CAAC;YACF,CAAC,CAAC,CAAC;YAEH,kBAAkB;YAClB,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,WAAW,IAAI,CAAC,MAAM,CAAC,WAAW,GAAG,CAAC,CAAC;YACrE,GAAG,CAAC,0BAA0B,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAEzD,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC5B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,GAAG,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;YACpC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAc,CAAC,CAAC;YACnC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACzB,MAAM,KAAK,CAAC;QACb,CAAC;IACF,CAAC;IAEO,oBAAoB;QAC3B,GAAG,CAAC,0BAA0B,CAAC,CAAC;QAEhC,6BAA6B;QAC7B,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACvB,IAAI,CAAC;gBACJ,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,qBAAqB;YACvD,CAAC;YAAC,MAAM,CAAC;gBACR,wBAAwB;YACzB,CAAC;YACD,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;QAC/B,CAAC;QAED,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,UAAU;QACf,GAAG,CAAC,oCAAoC,CAAC,CAAC;QAC1C,IAAI,CAAC,cAAc,EAAE,CAAC;QAEtB,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACvB,IAAI,CAAC;gBACJ,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,aAAa,IAAI,CAAC,MAAM,CAAC,WAAW,GAAG,CAAC,CAAC;YACxE,CAAC;YAAC,MAAM,CAAC;gBACR,oDAAoD;YACrD,CAAC;YAED,IAAI,CAAC;gBACJ,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;YAC7B,CAAC;YAAC,MAAM,CAAC;gBACR,wBAAwB;YACzB,CAAC;YACD,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;QAC/B,CAAC;QAED,mCAAmC;QACnC,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YAC/B,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YACtB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACvB,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACtB,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,YAA6B;QAC1C,IAAI,IAAI,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACtD,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QACzD,GAAG,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;QAE5C,8EAA8E;QAC9E,oDAAoD;QACpD,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACnD,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,IAAI,CAAC,MAAM,CAAC,WAAW,OAAO,cAAc,GAAG,CAAC,CAAC;IACnF,CAAC;IAED;;OAEG;IACK,qBAAqB,CAAC,YAA6B;QAC1D,OAAO,IAAI,CAAC,SAAS,CAAC;YACrB,KAAK,EAAE,YAAY,CAAC,KAAK;YACzB,OAAO,EAAE,YAAY,CAAC,OAAO;YAC7B,SAAS,EAAE,YAAY,CAAC,SAAS,EAAE,WAAW,EAAE,IAAI,IAAI;YACxD,QAAQ,EAAE,YAAY,CAAC,QAAQ;YAC/B,SAAS,EAAE,YAAY,CAAC,SAAS,CAAC,WAAW,EAAE;YAC/C,MAAM,EAAE,YAAY,CAAC,MAAM;SAC3B,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,iBAAiB,CAAC,OAAe;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEjC,OAAO;YACN,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAU;YACnC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI;YAC3D,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,SAAS,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;YACnC,MAAM,EAAE,IAAI,CAAC,MAAM;SACnB,CAAC;IACH,CAAC;CACD"}

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @agendajs/postgres-backend
+ *
+ * PostgreSQL backend for Agenda job scheduler with LISTEN/NOTIFY support.
+ *
+ * @example
+ * ```typescript
+ * import { Agenda } from 'agenda';
+ * import { PostgresBackend } from '@agendajs/postgres-backend';
+ *
+ * // Create agenda with PostgreSQL backend
+ * const agenda = new Agenda({
+ *   backend: new PostgresBackend({
+ *     connectionString: 'postgresql://user:pass@localhost:5432/mydb'
+ *   })
+ * });
+ *
+ * // Define and run jobs
+ * agenda.define('myJob', async (job) => {
+ *   console.log('Running job:', job.attrs.name);
+ * });
+ *
+ * await agenda.start();
+ * await agenda.every('5 minutes', 'myJob');
+ * ```
+ */
+export { PostgresBackend } from './PostgresBackend.js';
+export { PostgresJobRepository } from './PostgresJobRepository.js';
+export { PostgresNotificationChannel } from './PostgresNotificationChannel.js';
+export type { PostgresBackendConfig, PostgresJobRow } from './types.js';
+export type { PostgresNotificationChannelConfig } from './PostgresNotificationChannel.js';
+export { getCreateTableSQL, getCreateIndexesSQL, getDropTableSQL, getUpdateTimestampTriggerSQL } from './schema.js';

package/dist/index.js

@@ -0,0 +1,32 @@
+/**
+ * @agendajs/postgres-backend
+ *
+ * PostgreSQL backend for Agenda job scheduler with LISTEN/NOTIFY support.
+ *
+ * @example
+ * ```typescript
+ * import { Agenda } from 'agenda';
+ * import { PostgresBackend } from '@agendajs/postgres-backend';
+ *
+ * // Create agenda with PostgreSQL backend
+ * const agenda = new Agenda({
+ *   backend: new PostgresBackend({
+ *     connectionString: 'postgresql://user:pass@localhost:5432/mydb'
+ *   })
+ * });
+ *
+ * // Define and run jobs
+ * agenda.define('myJob', async (job) => {
+ *   console.log('Running job:', job.attrs.name);
+ * });
+ *
+ * await agenda.start();
+ * await agenda.every('5 minutes', 'myJob');
+ * ```
+ */
+export { PostgresBackend } from './PostgresBackend.js';
+export { PostgresJobRepository } from './PostgresJobRepository.js';
+export { PostgresNotificationChannel } from './PostgresNotificationChannel.js';
+// Re-export schema utilities for advanced use cases
+export { getCreateTableSQL, getCreateIndexesSQL, getDropTableSQL, getUpdateTimestampTriggerSQL } from './schema.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAK/E,oDAAoD;AACpD,OAAO,EACN,iBAAiB,EACjB,mBAAmB,EACnB,eAAe,EACf,4BAA4B,EAC5B,MAAM,aAAa,CAAC"}

package/dist/schema.d.ts

@@ -0,0 +1,10 @@
+/**
+ * SQL schema for PostgreSQL Agenda jobs table
+ */
+export declare function getCreateTableSQL(tableName: string): string;
+export declare function getCreateIndexesSQL(tableName: string): string[];
+export declare function getDropTableSQL(tableName: string): string;
+/**
+ * Function and trigger for automatic updated_at timestamp
+ */
+export declare function getUpdateTimestampTriggerSQL(tableName: string): string;

package/dist/schema.js

@@ -0,0 +1,72 @@
+/**
+ * SQL schema for PostgreSQL Agenda jobs table
+ */
+export function getCreateTableSQL(tableName) {
+    return `
+		CREATE TABLE IF NOT EXISTS "${tableName}" (
+			id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
+			name VARCHAR(255) NOT NULL,
+			priority INTEGER NOT NULL DEFAULT 0,
+			next_run_at TIMESTAMPTZ,
+			type VARCHAR(10) NOT NULL DEFAULT 'normal' CHECK (type IN ('normal', 'single')),
+			locked_at TIMESTAMPTZ,
+			last_finished_at TIMESTAMPTZ,
+			failed_at TIMESTAMPTZ,
+			fail_count INTEGER DEFAULT NULL,
+			fail_reason TEXT,
+			repeat_timezone VARCHAR(100),
+			last_run_at TIMESTAMPTZ,
+			repeat_interval VARCHAR(255),
+			data JSONB DEFAULT '{}'::jsonb,
+			repeat_at VARCHAR(255),
+			disabled BOOLEAN DEFAULT FALSE,
+			progress REAL,
+			fork BOOLEAN DEFAULT FALSE,
+			last_modified_by VARCHAR(255),
+			created_at TIMESTAMPTZ DEFAULT NOW(),
+			updated_at TIMESTAMPTZ DEFAULT NOW()
+		);
+	`;
+}
+export function getCreateIndexesSQL(tableName) {
+    return [
+        // Main index for finding and locking next job
+        `CREATE INDEX IF NOT EXISTS "${tableName}_find_and_lock_idx"
+		 ON "${tableName}" (name, next_run_at, priority DESC, locked_at, disabled)
+		 WHERE disabled = FALSE`,
+        // Index for single jobs (upsert operations)
+        `CREATE UNIQUE INDEX IF NOT EXISTS "${tableName}_single_job_idx"
+		 ON "${tableName}" (name) WHERE type = 'single'`,
+        // Index for querying by locked_at (for stale lock detection)
+        `CREATE INDEX IF NOT EXISTS "${tableName}_locked_at_idx"
+		 ON "${tableName}" (locked_at) WHERE locked_at IS NOT NULL`,
+        // Index for next_run_at queries (queue size, scheduled jobs)
+        `CREATE INDEX IF NOT EXISTS "${tableName}_next_run_at_idx"
+		 ON "${tableName}" (next_run_at) WHERE next_run_at IS NOT NULL`
+    ];
+}
+export function getDropTableSQL(tableName) {
+    return `DROP TABLE IF EXISTS "${tableName}" CASCADE;`;
+}
+/**
+ * Function and trigger for automatic updated_at timestamp
+ */
+export function getUpdateTimestampTriggerSQL(tableName) {
+    return `
+		CREATE OR REPLACE FUNCTION update_${tableName}_updated_at()
+		RETURNS TRIGGER AS $$
+		BEGIN
+			NEW.updated_at = NOW();
+			RETURN NEW;
+		END;
+		$$ LANGUAGE plpgsql;
+
+		DROP TRIGGER IF EXISTS "${tableName}_updated_at_trigger" ON "${tableName}";
+
+		CREATE TRIGGER "${tableName}_updated_at_trigger"
+		BEFORE UPDATE ON "${tableName}"
+		FOR EACH ROW
+		EXECUTE FUNCTION update_${tableName}_updated_at();
+	`;
+}
+//# sourceMappingURL=schema.js.map

package/dist/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,UAAU,iBAAiB,CAAC,SAAiB;IAClD,OAAO;gCACwB,SAAS;;;;;;;;;;;;;;;;;;;;;;;EAuBvC,CAAC;AACH,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,SAAiB;IACpD,OAAO;QACN,8CAA8C;QAC9C,+BAA+B,SAAS;SACjC,SAAS;0BACQ;QAExB,4CAA4C;QAC5C,sCAAsC,SAAS;SACxC,SAAS,gCAAgC;QAEhD,6DAA6D;QAC7D,+BAA+B,SAAS;SACjC,SAAS,2CAA2C;QAE3D,6DAA6D;QAC7D,+BAA+B,SAAS;SACjC,SAAS,+CAA+C;KAC/D,CAAC;AACH,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,SAAiB;IAChD,OAAO,yBAAyB,SAAS,YAAY,CAAC;AACvD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,4BAA4B,CAAC,SAAiB;IAC7D,OAAO;sCAC8B,SAAS;;;;;;;;4BAQnB,SAAS,4BAA4B,SAAS;;oBAEtD,SAAS;sBACP,SAAS;;4BAEH,SAAS;EACnC,CAAC;AACH,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,52 @@
+import type { Pool, PoolConfig } from 'pg';
+import type { SortDirection } from 'agenda';
+/**
+ * Configuration options for PostgresBackend
+ */
+export interface PostgresBackendConfig {
+    /** PostgreSQL connection string (e.g., 'postgresql://user:pass@host:5432/db') */
+    connectionString?: string;
+    /** PostgreSQL pool configuration (creates a new pool) */
+    poolConfig?: PoolConfig;
+    /** Existing PostgreSQL pool instance (will not be closed on disconnect) */
+    pool?: Pool;
+    /** Table name for jobs (default: 'agenda_jobs') */
+    tableName?: string;
+    /** Channel name for LISTEN/NOTIFY (default: 'agenda_jobs') */
+    channelName?: string;
+    /** Whether to create the table and indexes on connect (default: true) */
+    ensureSchema?: boolean;
+    /** Sort order for job queries (default: { nextRunAt: 'asc', priority: 'desc' }) */
+    sort?: {
+        nextRunAt?: SortDirection;
+        priority?: SortDirection;
+    };
+    /** Disable LISTEN/NOTIFY notification channel (default: false) */
+    disableNotifications?: boolean;
+}
+/**
+ * Internal row type matching PostgreSQL column names
+ */
+export interface PostgresJobRow {
+    id: string;
+    name: string;
+    priority: number;
+    next_run_at: Date | null;
+    type: 'normal' | 'single';
+    locked_at: Date | null;
+    last_finished_at: Date | null;
+    failed_at: Date | null;
+    fail_count: number | null;
+    fail_reason: string | null;
+    repeat_timezone: string | null;
+    last_run_at: Date | null;
+    repeat_interval: string | null;
+    data: unknown;
+    repeat_at: string | null;
+    disabled: boolean;
+    progress: number | null;
+    fork: boolean;
+    last_modified_by: string | null;
+    created_at: Date;
+    updated_at: Date;
+}

package/dist/types.js

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

package/dist/types.js.map

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

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@agendajs/postgres-backend",
+  "version": "1.0.0-alpha.0",
+  "description": "PostgreSQL backend for Agenda job scheduler with LISTEN/NOTIFY support",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/agenda/agenda"
+  },
+  "keywords": [
+    "agenda",
+    "job",
+    "scheduler",
+    "postgresql",
+    "postgres",
+    "pg",
+    "listen",
+    "notify"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/agenda/agenda/issues"
+  },
+  "dependencies": {
+    "debug": "^4.4.0",
+    "pg": "^8.13.0"
+  },
+  "peerDependencies": {
+    "agenda": "6.0.0-alpha.0"
+  },
+  "devDependencies": {
+    "@types/debug": "^4.1.12",
+    "@types/node": "^22.0.0",
+    "@types/pg": "^8.11.0",
+    "@vitest/coverage-v8": "^3.1.0",
+    "tsx": "^4.21.0",
+    "vitest": "^3.1.0",
+    "agenda": "6.0.0-alpha.0"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "typecheck": "tsc -b && tsc -p tsconfig.test.json",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "test:debug": "DEBUG=agenda:**,-agenda:internal:** vitest run",
+    "test:postgres": "POSTGRES_TEST_URL=postgresql://agenda:agenda@localhost:5432/agenda_test vitest run",
+    "test:postgres:watch": "POSTGRES_TEST_URL=postgresql://agenda:agenda@localhost:5432/agenda_test vitest",
+    "docker:up": "docker compose up -d --wait",
+    "docker:down": "docker compose down",
+    "docker:logs": "docker compose logs -f",
+    "test:docker": "npm run docker:up && npm run test:postgres; npm run docker:down"
+  }
+}