@odunlamizo/node-river 1.0.5 → 1.0.6

package/dist/driver-okKFbSrB.d.ts

@@ -0,0 +1,54 @@
+import { J as JobArgs, I as InsertOpts, a as InsertResult } from './insert-result-Bf0bAFvJ.js';
+
+/**
+ * Common interface for all RiverQueue drivers (e.g., Postgres, Prisma, Sequelize, etc.).
+ * The generic parameter Tx must be set to the driver's transaction/session type.
+ */
+interface Driver<Tx> {
+    /**
+     * Checks if the driver can connect to the database. Throws on failure.
+     */
+    verifyConnection(): Promise<void>;
+    /**
+     * Closes all database connections and cleans up resources.
+     */
+    close(): Promise<void>;
+    /**
+     * Inserts a new job into the queue using the provided arguments and options.
+     * @param args - The job arguments to insert.
+     * @param opts - Options for job insertion.
+     * @returns A promise that resolves to the result of the insertion operation,
+     *          including the job and whether the insert was skipped due to uniqueness.
+     */
+    insert<T extends JobArgs>(args: T, opts: InsertOpts): Promise<InsertResult<T>>;
+    /**
+     * Inserts a new job into the queue within an existing transaction or session.
+     * The type of `tx` is driver-specific and should match the transaction/session type for the driver.
+     *
+     * @param tx - The transaction or session object to use for the insert.
+     * @param args - The job arguments to insert.
+     * @param opts - Options for job insertion.
+     * @returns A promise that resolves to the result of the insertion operation.
+     */
+    insertTx<T extends JobArgs>(tx: Tx, args: T, opts: InsertOpts): Promise<InsertResult<T>>;
+    /**
+     * Inserts multiple jobs in sequence within a single transaction.
+     * If any insert fails, all previous inserts in the batch are rolled back.
+     *
+     * @param jobs - Array of job argument and option pairs to insert.
+     * @returns Array of InsertResult objects for each job.
+     */
+    insertMany<T extends JobArgs>(jobs: {
+        args: T;
+        opts: InsertOpts;
+    }[]): Promise<InsertResult<T>[]>;
+    /**
+     * Starts and returns a new transaction or session object for the driver.
+     * The returned object should be used for transactional operations such as insertTx.
+     *
+     * @returns A promise that resolves to the driver's transaction/session object.
+     */
+    getTx(): Promise<Tx>;
+}
+
+export type { Driver as D };

package/dist/driver-vSyPLsFq.d.cts

@@ -0,0 +1,54 @@
+import { J as JobArgs, I as InsertOpts, a as InsertResult } from './insert-result-Bf0bAFvJ.cjs';
+
+/**
+ * Common interface for all RiverQueue drivers (e.g., Postgres, Prisma, Sequelize, etc.).
+ * The generic parameter Tx must be set to the driver's transaction/session type.
+ */
+interface Driver<Tx> {
+    /**
+     * Checks if the driver can connect to the database. Throws on failure.
+     */
+    verifyConnection(): Promise<void>;
+    /**
+     * Closes all database connections and cleans up resources.
+     */
+    close(): Promise<void>;
+    /**
+     * Inserts a new job into the queue using the provided arguments and options.
+     * @param args - The job arguments to insert.
+     * @param opts - Options for job insertion.
+     * @returns A promise that resolves to the result of the insertion operation,
+     *          including the job and whether the insert was skipped due to uniqueness.
+     */
+    insert<T extends JobArgs>(args: T, opts: InsertOpts): Promise<InsertResult<T>>;
+    /**
+     * Inserts a new job into the queue within an existing transaction or session.
+     * The type of `tx` is driver-specific and should match the transaction/session type for the driver.
+     *
+     * @param tx - The transaction or session object to use for the insert.
+     * @param args - The job arguments to insert.
+     * @param opts - Options for job insertion.
+     * @returns A promise that resolves to the result of the insertion operation.
+     */
+    insertTx<T extends JobArgs>(tx: Tx, args: T, opts: InsertOpts): Promise<InsertResult<T>>;
+    /**
+     * Inserts multiple jobs in sequence within a single transaction.
+     * If any insert fails, all previous inserts in the batch are rolled back.
+     *
+     * @param jobs - Array of job argument and option pairs to insert.
+     * @returns Array of InsertResult objects for each job.
+     */
+    insertMany<T extends JobArgs>(jobs: {
+        args: T;
+        opts: InsertOpts;
+    }[]): Promise<InsertResult<T>[]>;
+    /**
+     * Starts and returns a new transaction or session object for the driver.
+     * The returned object should be used for transactional operations such as insertTx.
+     *
+     * @returns A promise that resolves to the driver's transaction/session object.
+     */
+    getTx(): Promise<Tx>;
+}
+
+export type { Driver as D };

package/dist/drivers/pg/index.cjs

@@ -0,0 +1,224 @@
+'use strict';
+
+var pg = require('pg');
+var buffer = require('buffer');
+var crypto = require('crypto');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var crypto__default = /*#__PURE__*/_interopDefault(crypto);
+
+// src/drivers/pg/pg-driver.ts
+var bitmaskToJobStates = (bitmask) => {
+  if (!bitmask || bitmask.length === 0) return null;
+  const allStates = [
+    "available" /* Available */,
+    // 7
+    "cancelled" /* Cancelled */,
+    // 6
+    "completed" /* Completed */,
+    // 5
+    "discarded" /* Discarded */,
+    // 4
+    "pending" /* Pending */,
+    // 3
+    "retryable" /* Retryable */,
+    // 2
+    "running" /* Running */,
+    // 1
+    "scheduled" /* Scheduled */
+    // 0
+  ];
+  const byte = bitmask[0];
+  return allStates.filter((_, i) => (byte & 1 << 7 - i) !== 0);
+};
+var mapToUniqueKey = (args, opts) => {
+  const uniqueOpts = opts.uniqueOpts;
+  if (!uniqueOpts) return void 0;
+  const keyParts = {};
+  if (!uniqueOpts.excludeKind) {
+    keyParts.kind = args.kind;
+  }
+  if (uniqueOpts.byArgs === true) {
+    keyParts.args = args;
+  } else if (Array.isArray(uniqueOpts.byArgs)) {
+    keyParts.args = Object.fromEntries(uniqueOpts.byArgs.sort().map((k) => [k, args[k]]));
+  }
+  if (uniqueOpts.byQueue) {
+    keyParts.queue = opts.queue;
+  }
+  if (uniqueOpts.byPeriod && opts.scheduledAt) {
+    const date = new Date(opts.scheduledAt);
+    const period = uniqueOpts.byPeriod;
+    const timestamp = Math.floor(date.getTime() / 1e3);
+    const rounded = timestamp - timestamp % period;
+    keyParts.period = rounded;
+  }
+  const hash = crypto__default.default.createHash("sha256").update(JSON.stringify(keyParts)).digest();
+  return buffer.Buffer.from(hash);
+};
+
+// src/drivers/pg/pg-driver.ts
+var PgDriver = class {
+  /**
+   * Creates a new PgDriver instance.
+   * @param options - Options for configuring the RiverQueue pg driver connection pool. Fields include:
+   *   - connectionString: Database connection string
+   *   - connectionTimeoutMillis: Optional, connection timeout in milliseconds
+   *   - idleTimeoutMillis: Optional, idle timeout in milliseconds
+   *   - max: Optional, maximum number of clients in the pool
+   */
+  constructor(options) {
+    const config = { ...options };
+    this.pool = new pg.Pool(config);
+  }
+  async verifyConnection() {
+    try {
+      const client = await this.pool.connect();
+      try {
+        await client.query("SELECT 1");
+      } finally {
+        client.release();
+      }
+    } catch (error) {
+      throw new Error(
+        `Database connection failed: ${error instanceof Error ? error.message : String(error)}`
+      );
+    }
+  }
+  async close() {
+    await this.pool.end();
+  }
+  async insert(args, opts) {
+    const client = await this.pool.connect();
+    try {
+      return await this.insertTx(client, args, opts);
+    } finally {
+      client.release();
+    }
+  }
+  async insertTx(tx, args, opts) {
+    if (!opts.queue) {
+      throw new Error("Queue name is required in InsertOpts");
+    }
+    if (!opts.maxAttempts) {
+      throw new Error("maxAttempts is required in InsertOpts");
+    }
+    let uniqueKey;
+    if (opts.uniqueOpts) {
+      uniqueKey = mapToUniqueKey(args, opts);
+    }
+    if (uniqueKey) {
+      const stateList = opts.uniqueOpts?.byState || [];
+      let query2 = "SELECT * FROM river_job WHERE unique_key = $1";
+      let values2 = [uniqueKey];
+      if (stateList.length > 0) {
+        query2 += " AND state = ANY($2)";
+        values2.push(stateList);
+      }
+      query2 += " LIMIT 1";
+      const result2 = await tx.query(
+        query2,
+        values2
+      );
+      if (result2.rows.length > 0) {
+        const row2 = result2.rows[0];
+        return this.mapRowToInsertResult(row2, true);
+      }
+    }
+    const { kind, ...restArgs } = args;
+    const columns = ["kind", "args", "queue", "max_attempts"];
+    const values = [
+      kind,
+      JSON.stringify(restArgs),
+      opts.queue,
+      opts.maxAttempts
+    ];
+    if (opts.tags) {
+      columns.push("tags");
+      values.push(JSON.stringify(opts.tags));
+    }
+    if (opts.priority) {
+      columns.push("priority");
+      values.push(opts.priority);
+    }
+    if (opts.metadata) {
+      columns.push("metadata");
+      values.push(JSON.stringify(opts.metadata));
+    }
+    if (opts.scheduledAt) {
+      columns.push("scheduled_at");
+      values.push(
+        opts.scheduledAt instanceof Date ? opts.scheduledAt.toISOString() : opts.scheduledAt
+      );
+    }
+    if (uniqueKey) {
+      columns.push("unique_key");
+      values.push(uniqueKey);
+    }
+    const placeholders = columns.map((_, i) => `$${i + 1}`);
+    const query = `INSERT INTO river_job (${columns.join(", ")}) VALUES (${placeholders.join(", ")}) RETURNING
+      id,
+      state,
+      attempt,
+      max_attempts as "maxAttempts",
+      attempted_at as "attemptedAt",
+      created_at as "createdAt",
+      finalized_at as "finalizedAt",
+      scheduled_at as "scheduledAt",
+      priority,
+      args,
+      attempted_by as "attemptedBy",
+      errors,
+      kind,
+      metadata,
+      queue,
+      tags,
+      unique_key as "uniqueKey",
+      unique_states as "uniqueStates"`;
+    const result = await tx.query(
+      query,
+      values
+    );
+    const row = result.rows[0];
+    if (!row) return row;
+    return this.mapRowToInsertResult(row, false);
+  }
+  async insertMany(jobs) {
+    const client = await this.pool.connect();
+    try {
+      await client.query("BEGIN");
+      const results = [];
+      for (const job of jobs) {
+        results.push(await this.insertTx(client, job.args, job.opts));
+      }
+      await client.query("COMMIT");
+      return results;
+    } catch (error) {
+      await client.query("ROLLBACK");
+      throw error;
+    } finally {
+      client.release();
+    }
+  }
+  async getTx() {
+    return this.pool.connect();
+  }
+  /**
+   * Helper to map a DB row to a Job<T> and InsertResult.
+   */
+  mapRowToInsertResult(row, skipped) {
+    return {
+      job: {
+        ...row,
+        args: { ...row.args, kind: row.kind },
+        uniqueStates: bitmaskToJobStates(row.uniqueStates)
+      },
+      skipped
+    };
+  }
+};
+
+exports.PgDriver = PgDriver;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/drivers/pg/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/utils/mappers.ts","../../../src/drivers/pg/pg-driver.ts"],"names":["crypto","Buffer","Pool","query","values","result","row"],"mappings":";;;;;;;;;;;AAUO,IAAM,kBAAA,GAAqB,CAAC,OAAA,KAA8C;AAC/E,EAAA,IAAI,CAAC,OAAA,IAAW,OAAA,CAAQ,MAAA,KAAW,GAAG,OAAO,IAAA;AAE7C,EAAA,MAAM,SAAA,GAAwB;AAAA,IAAA,WAAA;AAAA;AAAA,IAAA,WAAA;AAAA;AAAA,IAAA,WAAA;AAAA;AAAA,IAAA,WAAA;AAAA;AAAA,IAAA,SAAA;AAAA;AAAA,IAAA,WAAA;AAAA;AAAA,IAAA,SAAA;AAAA;AAAA,IAAA,WAAA;AAAA;AAAA,GAS9B;AACA,EAAA,MAAM,IAAA,GAAO,QAAQ,CAAC,CAAA;AAEtB,EAAA,OAAO,SAAA,CAAU,OAAO,CAAC,CAAA,EAAG,OAAO,IAAA,GAAQ,CAAA,IAAM,CAAA,GAAI,CAAA,MAAS,CAAC,CAAA;AACjE,CAAA;AASO,IAAM,cAAA,GAAiB,CAAC,IAAA,EAAe,IAAA,KAAyC;AACrF,EAAA,MAAM,aAAa,IAAA,CAAK,UAAA;AACxB,EAAA,IAAI,CAAC,YAAY,OAAO,MAAA;AAExB,EAAA,MAAM,WAAoC,EAAC;AAE3C,EAAA,IAAI,CAAC,WAAW,WAAA,EAAa;AAC3B,IAAA,QAAA,CAAS,OAAO,IAAA,CAAK,IAAA;AAAA,EACvB;AAEA,EAAA,IAAI,UAAA,CAAW,WAAW,IAAA,EAAM;AAC9B,IAAA,QAAA,CAAS,IAAA,GAAO,IAAA;AAAA,EAClB,CAAA,MAAA,IAAW,KAAA,CAAM,OAAA,CAAQ,UAAA,CAAW,MAAM,CAAA,EAAG;AAC3C,IAAA,QAAA,CAAS,OAAO,MAAA,CAAO,WAAA,CAAY,UAAA,CAAW,MAAA,CAAO,MAAK,CAAE,GAAA,CAAI,CAAC,CAAA,KAAM,CAAC,CAAA,EAAG,IAAA,CAAK,CAAC,CAAC,CAAC,CAAC,CAAA;AAAA,EACtF;AAEA,EAAA,IAAI,WAAW,OAAA,EAAS;AACtB,IAAA,QAAA,CAAS,QAAQ,IAAA,CAAK,KAAA;AAAA,EACxB;AAEA,EAAA,IAAI,UAAA,CAAW,QAAA,IAAY,IAAA,CAAK,WAAA,EAAa;AAC3C,IAAA,MAAM,IAAA,GAAO,IAAI,IAAA,CAAK,IAAA,CAAK,WAAW,CAAA;AACtC,IAAA,MAAM,SAAS,UAAA,CAAW,QAAA;AAC1B,IAAA,MAAM,YAAY,IAAA,CAAK,KAAA,CAAM,IAAA,CAAK,OAAA,KAAY,GAAI,CAAA;AAClD,IAAA,MAAM,OAAA,GAAU,YAAa,SAAA,GAAY,MAAA;AACzC,IAAA,QAAA,CAAS,MAAA,GAAS,OAAA;AAAA,EACpB;AAEA,EAAA,MAAM,IAAA,GAAOA,uBAAA,CAAO,UAAA,CAAW,QAAQ,CAAA,CAAE,MAAA,CAAO,IAAA,CAAK,SAAA,CAAU,QAAQ,CAAC,CAAA,CAAE,MAAA,EAAO;AAEjF,EAAA,OAAOC,aAAA,CAAO,KAAK,IAAI,CAAA;AACzB,CAAA;;;ACzDA,IAAqB,WAArB,MAA4D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAW1D,YAAY,OAAA,EAAkB;AAC5B,IAAA,MAAM,MAAA,GAAqB,EAAE,GAAG,OAAA,EAAQ;AACxC,IAAA,IAAA,CAAK,IAAA,GAAO,IAAIC,OAAA,CAAK,MAAM,CAAA;AAAA,EAC7B;AAAA,EAEA,MAAM,gBAAA,GAAkC;AACtC,IAAA,IAAI;AACF,MAAA,MAAM,MAAA,GAAS,MAAM,IAAA,CAAK,IAAA,CAAK,OAAA,EAAQ;AACvC,MAAA,IAAI;AACF,QAAA,MAAM,MAAA,CAAO,MAAM,UAAU,CAAA;AAAA,MAC/B,CAAA,SAAE;AACA,QAAA,MAAA,CAAO,OAAA,EAAQ;AAAA,MACjB;AAAA,IACF,SAAS,KAAA,EAAO;AACd,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,+BAA+B,KAAA,YAAiB,KAAA,GAAQ,MAAM,OAAA,GAAU,MAAA,CAAO,KAAK,CAAC,CAAA;AAAA,OACvF;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,KAAA,GAAuB;AAC3B,IAAA,MAAM,IAAA,CAAK,KAAK,GAAA,EAAI;AAAA,EACtB;AAAA,EAEA,MAAM,MAAA,CAA0B,IAAA,EAAS,IAAA,EAA4C;AACnF,IAAA,MAAM,MAAA,GAAS,MAAM,IAAA,CAAK,IAAA,CAAK,OAAA,EAAQ;AACvC,IAAA,IAAI;AACF,MAAA,OAAO,MAAM,IAAA,CAAK,QAAA,CAAS,MAAA,EAAQ,MAAM,IAAI,CAAA;AAAA,IAC/C,CAAA,SAAE;AACA,MAAA,MAAA,CAAO,OAAA,EAAQ;AAAA,IACjB;AAAA,EACF;AAAA,EAEA,MAAM,QAAA,CACJ,EAAA,EACA,IAAA,EACA,IAAA,EAC0B;AAC1B,IAAA,IAAI,CAAC,KAAK,KAAA,EAAO;AACf,MAAA,MAAM,IAAI,MAAM,sCAAsC,CAAA;AAAA,IACxD;AAEA,IAAA,IAAI,CAAC,KAAK,WAAA,EAAa;AACrB,MAAA,MAAM,IAAI,MAAM,uCAAuC,CAAA;AAAA,IACzD;AAEA,IAAA,IAAI,SAAA;AACJ,IAAA,IAAI,KAAK,UAAA,EAAY;AACnB,MAAA,SAAA,GAAY,cAAA,CAAe,MAAM,IAAI,CAAA;AAAA,IACvC;AAEA,IAAA,IAAI,SAAA,EAAW;AACb,MAAA,MAAM,SAAA,GAAY,IAAA,CAAK,UAAA,EAAY,OAAA,IAAW,EAAC;AAE/C,MAAA,IAAIC,MAAAA,GAAQ,+CAAA;AACZ,MAAA,IAAIC,OAAAA,GAAgC,CAAC,SAAS,CAAA;AAE9C,MAAA,IAAI,SAAA,CAAU,SAAS,CAAA,EAAG;AACxB,QAAAD,MAAAA,IAAS,sBAAA;AACT,QAAAC,OAAAA,CAAO,KAAK,SAAS,CAAA;AAAA,MACvB;AAEA,MAAAD,MAAAA,IAAS,UAAA;AAET,MAAA,MAAME,OAAAA,GAAS,MAAM,EAAA,CAAG,KAAA;AAAA,QACtBF,MAAAA;AAAA,QACAC;AAAA,OACF;AAEA,MAAA,IAAIC,OAAAA,CAAO,IAAA,CAAK,MAAA,GAAS,CAAA,EAAG;AAC1B,QAAA,MAAMC,IAAAA,GAAMD,OAAAA,CAAO,IAAA,CAAK,CAAC,CAAA;AAEzB,QAAA,OAAO,IAAA,CAAK,oBAAA,CAAqBC,IAAAA,EAAK,IAAI,CAAA;AAAA,MAC5C;AAAA,IACF;AAEA,IAAA,MAAM,EAAE,IAAA,EAAM,GAAG,QAAA,EAAS,GAAI,IAAA;AAC9B,IAAA,MAAM,OAAA,GAAU,CAAC,MAAA,EAAQ,MAAA,EAAQ,SAAS,cAAc,CAAA;AACxD,IAAA,MAAM,MAAA,GAAuC;AAAA,MAC3C,IAAA;AAAA,MACA,IAAA,CAAK,UAAU,QAAQ,CAAA;AAAA,MACvB,IAAA,CAAK,KAAA;AAAA,MACL,IAAA,CAAK;AAAA,KACP;AAEA,IAAA,IAAI,KAAK,IAAA,EAAM;AACb,MAAA,OAAA,CAAQ,KAAK,MAAM,CAAA;AACnB,MAAA,MAAA,CAAO,IAAA,CAAK,IAAA,CAAK,SAAA,CAAU,IAAA,CAAK,IAAI,CAAC,CAAA;AAAA,IACvC;AAEA,IAAA,IAAI,KAAK,QAAA,EAAU;AACjB,MAAA,OAAA,CAAQ,KAAK,UAAU,CAAA;AACvB,MAAA,MAAA,CAAO,IAAA,CAAK,KAAK,QAAQ,CAAA;AAAA,IAC3B;AAEA,IAAA,IAAI,KAAK,QAAA,EAAU;AACjB,MAAA,OAAA,CAAQ,KAAK,UAAU,CAAA;AACvB,MAAA,MAAA,CAAO,IAAA,CAAK,IAAA,CAAK,SAAA,CAAU,IAAA,CAAK,QAAQ,CAAC,CAAA;AAAA,IAC3C;AAEA,IAAA,IAAI,KAAK,WAAA,EAAa;AACpB,MAAA,OAAA,CAAQ,KAAK,cAAc,CAAA;AAC3B,MAAA,MAAA,CAAO,IAAA;AAAA,QACL,KAAK,WAAA,YAAuB,IAAA,GAAO,KAAK,WAAA,CAAY,WAAA,KAAgB,IAAA,CAAK;AAAA,OAC3E;AAAA,IACF;AAEA,IAAA,IAAI,SAAA,EAAW;AACb,MAAA,OAAA,CAAQ,KAAK,YAAY,CAAA;AACzB,MAAA,MAAA,CAAO,KAAK,SAAS,CAAA;AAAA,IACvB;AAEA,IAAA,MAAM,YAAA,GAAe,QAAQ,GAAA,CAAI,CAAC,GAAG,CAAA,KAAM,CAAA,CAAA,EAAI,CAAA,GAAI,CAAC,CAAA,CAAE,CAAA;AACtD,IAAA,MAAM,KAAA,GAAQ,CAAA,uBAAA,EAA0B,OAAA,CAAQ,IAAA,CAAK,IAAI,CAAC,CAAA,UAAA,EAAa,YAAA,CAAa,IAAA,CAAK,IAAI,CAAC,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,qCAAA,CAAA;AAmB9F,IAAA,MAAM,MAAA,GAAS,MAAM,EAAA,CAAG,KAAA;AAAA,MACtB,KAAA;AAAA,MACA;AAAA,KACF;AAEA,IAAA,MAAM,GAAA,GAAM,MAAA,CAAO,IAAA,CAAK,CAAC,CAAA;AACzB,IAAA,IAAI,CAAC,KAAK,OAAO,GAAA;AAEjB,IAAA,OAAO,IAAA,CAAK,oBAAA,CAAqB,GAAA,EAAK,KAAK,CAAA;AAAA,EAC7C;AAAA,EAEA,MAAM,WACJ,IAAA,EAC4B;AAC5B,IAAA,MAAM,MAAA,GAAS,MAAM,IAAA,CAAK,IAAA,CAAK,OAAA,EAAQ;AACvC,IAAA,IAAI;AACF,MAAA,MAAM,MAAA,CAAO,MAAM,OAAO,CAAA;AAE1B,MAAA,MAAM,UAA6B,EAAC;AACpC,MAAA,KAAA,MAAW,OAAO,IAAA,EAAM;AACtB,QAAA,OAAA,CAAQ,IAAA,CAAK,MAAM,IAAA,CAAK,QAAA,CAAS,QAAQ,GAAA,CAAI,IAAA,EAAM,GAAA,CAAI,IAAI,CAAC,CAAA;AAAA,MAC9D;AAEA,MAAA,MAAM,MAAA,CAAO,MAAM,QAAQ,CAAA;AAE3B,MAAA,OAAO,OAAA;AAAA,IACT,SAAS,KAAA,EAAO;AACd,MAAA,MAAM,MAAA,CAAO,MAAM,UAAU,CAAA;AAE7B,MAAA,MAAM,KAAA;AAAA,IACR,CAAA,SAAE;AACA,MAAA,MAAA,CAAO,OAAA,EAAQ;AAAA,IACjB;AAAA,EACF;AAAA,EAEA,MAAM,KAAA,GAA6B;AACjC,IAAA,OAAO,IAAA,CAAK,KAAK,OAAA,EAAQ;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA,EAKQ,oBAAA,CACN,KACA,OAAA,EACiB;AACjB,IAAA,OAAO;AAAA,MACL,GAAA,EAAK;AAAA,QACH,GAAG,GAAA;AAAA,QACH,MAAM,EAAE,GAAG,IAAI,IAAA,EAAM,IAAA,EAAM,IAAI,IAAA,EAAK;AAAA,QACpC,YAAA,EAAc,kBAAA,CAAmB,GAAA,CAAI,YAAY;AAAA,OACnD;AAAA,MACA;AAAA,KACF;AAAA,EACF;AACF","file":"index.cjs","sourcesContent":["import { Buffer } from 'buffer';\nimport crypto from 'crypto';\nimport { InsertOpts, JobArgs, JobState } from '../types';\n\n/**\n * Converts a bit(8) Buffer to an array of JobState values using the bit order from river_job_state_in_bitmask.\n *\n * @param bitmask - The Buffer representing the job state bitmask.\n * @returns An array of JobState values corresponding to the set bits, or null if the bitmask is null.\n */\nexport const bitmaskToJobStates = (bitmask: Buffer | null): JobState[] | null => {\n  if (!bitmask || bitmask.length === 0) return null;\n  // Bit order: 7=available, 6=cancelled, 5=completed, 4=discarded, 3=pending, 2=retryable, 1=running, 0=scheduled\n  const allStates: JobState[] = [\n    JobState.Available, // 7\n    JobState.Cancelled, // 6\n    JobState.Completed, // 5\n    JobState.Discarded, // 4\n    JobState.Pending, // 3\n    JobState.Retryable, // 2\n    JobState.Running, // 1\n    JobState.Scheduled, // 0\n  ];\n  const byte = bitmask[0];\n  // Map bits 7..0 to allStates\n  return allStates.filter((_, i) => (byte & (1 << (7 - i))) !== 0);\n};\n\n/**\n * Maps job args and unique options to a unique key buffer.\n *\n * @param args - The job arguments to use for uniqueness computation.\n * @param opts - The insertion options, including unique options.\n * @returns A Buffer containing the unique key, or undefined if no unique options are set.\n */\nexport const mapToUniqueKey = (args: JobArgs, opts: InsertOpts): Buffer | undefined => {\n  const uniqueOpts = opts.uniqueOpts;\n  if (!uniqueOpts) return undefined;\n\n  const keyParts: Record<string, unknown> = {};\n\n  if (!uniqueOpts.excludeKind) {\n    keyParts.kind = args.kind;\n  }\n\n  if (uniqueOpts.byArgs === true) {\n    keyParts.args = args;\n  } else if (Array.isArray(uniqueOpts.byArgs)) {\n    keyParts.args = Object.fromEntries(uniqueOpts.byArgs.sort().map((k) => [k, args[k]]));\n  }\n\n  if (uniqueOpts.byQueue) {\n    keyParts.queue = opts.queue;\n  }\n\n  if (uniqueOpts.byPeriod && opts.scheduledAt) {\n    const date = new Date(opts.scheduledAt);\n    const period = uniqueOpts.byPeriod;\n    const timestamp = Math.floor(date.getTime() / 1000);\n    const rounded = timestamp - (timestamp % period);\n    keyParts.period = rounded;\n  }\n\n  const hash = crypto.createHash('sha256').update(JSON.stringify(keyParts)).digest();\n\n  return Buffer.from(hash);\n};\n","// RiverQueue driver implementation using the 'pg' library.\nimport { Buffer } from 'buffer';\nimport { Pool, PoolClient, PoolConfig } from 'pg';\nimport { InsertOpts, InsertResult, Job, JobArgs } from '../../types';\nimport { bitmaskToJobStates, mapToUniqueKey } from '../../utils';\nimport Driver from '../driver';\nimport Options from './pg-options';\n\n// Implements the RiverQueue Driver interface using the 'pg' library.\nexport default class PgDriver implements Driver<PoolClient> {\n  private readonly pool: Pool;\n\n  /**\n   * Creates a new PgDriver instance.\n   * @param options - Options for configuring the RiverQueue pg driver connection pool. Fields include:\n   *   - connectionString: Database connection string\n   *   - connectionTimeoutMillis: Optional, connection timeout in milliseconds\n   *   - idleTimeoutMillis: Optional, idle timeout in milliseconds\n   *   - max: Optional, maximum number of clients in the pool\n   */\n  constructor(options: Options) {\n    const config: PoolConfig = { ...options };\n    this.pool = new Pool(config);\n  }\n\n  async verifyConnection(): Promise<void> {\n    try {\n      const client = await this.pool.connect();\n      try {\n        await client.query('SELECT 1');\n      } finally {\n        client.release();\n      }\n    } catch (error) {\n      throw new Error(\n        `Database connection failed: ${error instanceof Error ? error.message : String(error)}`,\n      );\n    }\n  }\n\n  async close(): Promise<void> {\n    await this.pool.end();\n  }\n\n  async insert<T extends JobArgs>(args: T, opts: InsertOpts): Promise<InsertResult<T>> {\n    const client = await this.pool.connect();\n    try {\n      return await this.insertTx(client, args, opts);\n    } finally {\n      client.release();\n    }\n  }\n\n  async insertTx<T extends JobArgs>(\n    tx: PoolClient,\n    args: T,\n    opts: InsertOpts,\n  ): Promise<InsertResult<T>> {\n    if (!opts.queue) {\n      throw new Error('Queue name is required in InsertOpts');\n    }\n\n    if (!opts.maxAttempts) {\n      throw new Error('maxAttempts is required in InsertOpts');\n    }\n\n    let uniqueKey: Buffer | undefined;\n    if (opts.uniqueOpts) {\n      uniqueKey = mapToUniqueKey(args, opts);\n    }\n\n    if (uniqueKey) {\n      const stateList = opts.uniqueOpts?.byState || [];\n\n      let query = 'SELECT * FROM river_job WHERE unique_key = $1';\n      let values: (Buffer | string[])[] = [uniqueKey];\n\n      if (stateList.length > 0) {\n        query += ' AND state = ANY($2)';\n        values.push(stateList);\n      }\n\n      query += ' LIMIT 1';\n\n      const result = await tx.query<Omit<Job, 'uniqueStates'> & { uniqueStates: Buffer | null }>(\n        query,\n        values,\n      );\n\n      if (result.rows.length > 0) {\n        const row = result.rows[0];\n\n        return this.mapRowToInsertResult(row, true);\n      }\n    }\n\n    const { kind, ...restArgs } = args;\n    const columns = ['kind', 'args', 'queue', 'max_attempts'];\n    const values: (string | number | Buffer)[] = [\n      kind,\n      JSON.stringify(restArgs),\n      opts.queue,\n      opts.maxAttempts,\n    ];\n\n    if (opts.tags) {\n      columns.push('tags');\n      values.push(JSON.stringify(opts.tags));\n    }\n\n    if (opts.priority) {\n      columns.push('priority');\n      values.push(opts.priority);\n    }\n\n    if (opts.metadata) {\n      columns.push('metadata');\n      values.push(JSON.stringify(opts.metadata));\n    }\n\n    if (opts.scheduledAt) {\n      columns.push('scheduled_at');\n      values.push(\n        opts.scheduledAt instanceof Date ? opts.scheduledAt.toISOString() : opts.scheduledAt,\n      );\n    }\n\n    if (uniqueKey) {\n      columns.push('unique_key');\n      values.push(uniqueKey);\n    }\n\n    const placeholders = columns.map((_, i) => `$${i + 1}`);\n    const query = `INSERT INTO river_job (${columns.join(', ')}) VALUES (${placeholders.join(', ')}) RETURNING\n      id,\n      state,\n      attempt,\n      max_attempts as \"maxAttempts\",\n      attempted_at as \"attemptedAt\",\n      created_at as \"createdAt\",\n      finalized_at as \"finalizedAt\",\n      scheduled_at as \"scheduledAt\",\n      priority,\n      args,\n      attempted_by as \"attemptedBy\",\n      errors,\n      kind,\n      metadata,\n      queue,\n      tags,\n      unique_key as \"uniqueKey\",\n      unique_states as \"uniqueStates\"`;\n    const result = await tx.query<Omit<Job, 'uniqueStates'> & { uniqueStates: Buffer | null }>(\n      query,\n      values,\n    );\n\n    const row = result.rows[0];\n    if (!row) return row;\n\n    return this.mapRowToInsertResult(row, false);\n  }\n\n  async insertMany<T extends JobArgs>(\n    jobs: { args: T; opts: InsertOpts }[],\n  ): Promise<InsertResult<T>[]> {\n    const client = await this.pool.connect();\n    try {\n      await client.query('BEGIN');\n\n      const results: InsertResult<T>[] = [];\n      for (const job of jobs) {\n        results.push(await this.insertTx(client, job.args, job.opts));\n      }\n\n      await client.query('COMMIT');\n\n      return results;\n    } catch (error) {\n      await client.query('ROLLBACK');\n\n      throw error;\n    } finally {\n      client.release();\n    }\n  }\n\n  async getTx(): Promise<PoolClient> {\n    return this.pool.connect();\n  }\n\n  /**\n   * Helper to map a DB row to a Job<T> and InsertResult.\n   */\n  private mapRowToInsertResult<T extends JobArgs>(\n    row: Omit<Job, 'uniqueStates'> & { uniqueStates: Buffer | null },\n    skipped: boolean,\n  ): InsertResult<T> {\n    return {\n      job: {\n        ...row,\n        args: { ...row.args, kind: row.kind } as T,\n        uniqueStates: bitmaskToJobStates(row.uniqueStates),\n      },\n      skipped,\n    };\n  }\n}\n"]}

package/dist/drivers/pg/index.d.cts

@@ -0,0 +1,46 @@
+import { PoolClient } from 'pg';
+import { J as JobArgs, I as InsertOpts, a as InsertResult } from '../../insert-result-Bf0bAFvJ.cjs';
+import { D as Driver } from '../../driver-vSyPLsFq.cjs';
+import 'buffer';
+
+/**
+ * Options for configuring the RiverQueue pg driver connection pool.
+ */
+interface PgDriverOptions {
+    /** Database connection string */
+    connectionString: string;
+    /** Optional: Connection timeout in milliseconds */
+    connectionTimeoutMillis?: number;
+    /** Optional: Idle timeout in milliseconds */
+    idleTimeoutMillis?: number;
+    /** Optional: Maximum number of clients in the pool */
+    max?: number;
+}
+
+declare class PgDriver implements Driver<PoolClient> {
+    private readonly pool;
+    /**
+     * Creates a new PgDriver instance.
+     * @param options - Options for configuring the RiverQueue pg driver connection pool. Fields include:
+     *   - connectionString: Database connection string
+     *   - connectionTimeoutMillis: Optional, connection timeout in milliseconds
+     *   - idleTimeoutMillis: Optional, idle timeout in milliseconds
+     *   - max: Optional, maximum number of clients in the pool
+     */
+    constructor(options: PgDriverOptions);
+    verifyConnection(): Promise<void>;
+    close(): Promise<void>;
+    insert<T extends JobArgs>(args: T, opts: InsertOpts): Promise<InsertResult<T>>;
+    insertTx<T extends JobArgs>(tx: PoolClient, args: T, opts: InsertOpts): Promise<InsertResult<T>>;
+    insertMany<T extends JobArgs>(jobs: {
+        args: T;
+        opts: InsertOpts;
+    }[]): Promise<InsertResult<T>[]>;
+    getTx(): Promise<PoolClient>;
+    /**
+     * Helper to map a DB row to a Job<T> and InsertResult.
+     */
+    private mapRowToInsertResult;
+}
+
+export { PgDriver, type PgDriverOptions };

package/dist/drivers/pg/index.d.ts

@@ -0,0 +1,46 @@
+import { PoolClient } from 'pg';
+import { J as JobArgs, I as InsertOpts, a as InsertResult } from '../../insert-result-Bf0bAFvJ.js';
+import { D as Driver } from '../../driver-okKFbSrB.js';
+import 'buffer';
+
+/**
+ * Options for configuring the RiverQueue pg driver connection pool.
+ */
+interface PgDriverOptions {
+    /** Database connection string */
+    connectionString: string;
+    /** Optional: Connection timeout in milliseconds */
+    connectionTimeoutMillis?: number;
+    /** Optional: Idle timeout in milliseconds */
+    idleTimeoutMillis?: number;
+    /** Optional: Maximum number of clients in the pool */
+    max?: number;
+}
+
+declare class PgDriver implements Driver<PoolClient> {
+    private readonly pool;
+    /**
+     * Creates a new PgDriver instance.
+     * @param options - Options for configuring the RiverQueue pg driver connection pool. Fields include:
+     *   - connectionString: Database connection string
+     *   - connectionTimeoutMillis: Optional, connection timeout in milliseconds
+     *   - idleTimeoutMillis: Optional, idle timeout in milliseconds
+     *   - max: Optional, maximum number of clients in the pool
+     */
+    constructor(options: PgDriverOptions);
+    verifyConnection(): Promise<void>;
+    close(): Promise<void>;
+    insert<T extends JobArgs>(args: T, opts: InsertOpts): Promise<InsertResult<T>>;
+    insertTx<T extends JobArgs>(tx: PoolClient, args: T, opts: InsertOpts): Promise<InsertResult<T>>;
+    insertMany<T extends JobArgs>(jobs: {
+        args: T;
+        opts: InsertOpts;
+    }[]): Promise<InsertResult<T>[]>;
+    getTx(): Promise<PoolClient>;
+    /**
+     * Helper to map a DB row to a Job<T> and InsertResult.
+     */
+    private mapRowToInsertResult;
+}
+
+export { PgDriver, type PgDriverOptions };

package/dist/drivers/pg/index.js

@@ -0,0 +1,218 @@
+import { Pool } from 'pg';
+import { Buffer } from 'buffer';
+import crypto from 'crypto';
+
+// src/drivers/pg/pg-driver.ts
+var bitmaskToJobStates = (bitmask) => {
+  if (!bitmask || bitmask.length === 0) return null;
+  const allStates = [
+    "available" /* Available */,
+    // 7
+    "cancelled" /* Cancelled */,
+    // 6
+    "completed" /* Completed */,
+    // 5
+    "discarded" /* Discarded */,
+    // 4
+    "pending" /* Pending */,
+    // 3
+    "retryable" /* Retryable */,
+    // 2
+    "running" /* Running */,
+    // 1
+    "scheduled" /* Scheduled */
+    // 0
+  ];
+  const byte = bitmask[0];
+  return allStates.filter((_, i) => (byte & 1 << 7 - i) !== 0);
+};
+var mapToUniqueKey = (args, opts) => {
+  const uniqueOpts = opts.uniqueOpts;
+  if (!uniqueOpts) return void 0;
+  const keyParts = {};
+  if (!uniqueOpts.excludeKind) {
+    keyParts.kind = args.kind;
+  }
+  if (uniqueOpts.byArgs === true) {
+    keyParts.args = args;
+  } else if (Array.isArray(uniqueOpts.byArgs)) {
+    keyParts.args = Object.fromEntries(uniqueOpts.byArgs.sort().map((k) => [k, args[k]]));
+  }
+  if (uniqueOpts.byQueue) {
+    keyParts.queue = opts.queue;
+  }
+  if (uniqueOpts.byPeriod && opts.scheduledAt) {
+    const date = new Date(opts.scheduledAt);
+    const period = uniqueOpts.byPeriod;
+    const timestamp = Math.floor(date.getTime() / 1e3);
+    const rounded = timestamp - timestamp % period;
+    keyParts.period = rounded;
+  }
+  const hash = crypto.createHash("sha256").update(JSON.stringify(keyParts)).digest();
+  return Buffer.from(hash);
+};
+
+// src/drivers/pg/pg-driver.ts
+var PgDriver = class {
+  /**
+   * Creates a new PgDriver instance.
+   * @param options - Options for configuring the RiverQueue pg driver connection pool. Fields include:
+   *   - connectionString: Database connection string
+   *   - connectionTimeoutMillis: Optional, connection timeout in milliseconds
+   *   - idleTimeoutMillis: Optional, idle timeout in milliseconds
+   *   - max: Optional, maximum number of clients in the pool
+   */
+  constructor(options) {
+    const config = { ...options };
+    this.pool = new Pool(config);
+  }
+  async verifyConnection() {
+    try {
+      const client = await this.pool.connect();
+      try {
+        await client.query("SELECT 1");
+      } finally {
+        client.release();
+      }
+    } catch (error) {
+      throw new Error(
+        `Database connection failed: ${error instanceof Error ? error.message : String(error)}`
+      );
+    }
+  }
+  async close() {
+    await this.pool.end();
+  }
+  async insert(args, opts) {
+    const client = await this.pool.connect();
+    try {
+      return await this.insertTx(client, args, opts);
+    } finally {
+      client.release();
+    }
+  }
+  async insertTx(tx, args, opts) {
+    if (!opts.queue) {
+      throw new Error("Queue name is required in InsertOpts");
+    }
+    if (!opts.maxAttempts) {
+      throw new Error("maxAttempts is required in InsertOpts");
+    }
+    let uniqueKey;
+    if (opts.uniqueOpts) {
+      uniqueKey = mapToUniqueKey(args, opts);
+    }
+    if (uniqueKey) {
+      const stateList = opts.uniqueOpts?.byState || [];
+      let query2 = "SELECT * FROM river_job WHERE unique_key = $1";
+      let values2 = [uniqueKey];
+      if (stateList.length > 0) {
+        query2 += " AND state = ANY($2)";
+        values2.push(stateList);
+      }
+      query2 += " LIMIT 1";
+      const result2 = await tx.query(
+        query2,
+        values2
+      );
+      if (result2.rows.length > 0) {
+        const row2 = result2.rows[0];
+        return this.mapRowToInsertResult(row2, true);
+      }
+    }
+    const { kind, ...restArgs } = args;
+    const columns = ["kind", "args", "queue", "max_attempts"];
+    const values = [
+      kind,
+      JSON.stringify(restArgs),
+      opts.queue,
+      opts.maxAttempts
+    ];
+    if (opts.tags) {
+      columns.push("tags");
+      values.push(JSON.stringify(opts.tags));
+    }
+    if (opts.priority) {
+      columns.push("priority");
+      values.push(opts.priority);
+    }
+    if (opts.metadata) {
+      columns.push("metadata");
+      values.push(JSON.stringify(opts.metadata));
+    }
+    if (opts.scheduledAt) {
+      columns.push("scheduled_at");
+      values.push(
+        opts.scheduledAt instanceof Date ? opts.scheduledAt.toISOString() : opts.scheduledAt
+      );
+    }
+    if (uniqueKey) {
+      columns.push("unique_key");
+      values.push(uniqueKey);
+    }
+    const placeholders = columns.map((_, i) => `$${i + 1}`);
+    const query = `INSERT INTO river_job (${columns.join(", ")}) VALUES (${placeholders.join(", ")}) RETURNING
+      id,
+      state,
+      attempt,
+      max_attempts as "maxAttempts",
+      attempted_at as "attemptedAt",
+      created_at as "createdAt",
+      finalized_at as "finalizedAt",
+      scheduled_at as "scheduledAt",
+      priority,
+      args,
+      attempted_by as "attemptedBy",
+      errors,
+      kind,
+      metadata,
+      queue,
+      tags,
+      unique_key as "uniqueKey",
+      unique_states as "uniqueStates"`;
+    const result = await tx.query(
+      query,
+      values
+    );
+    const row = result.rows[0];
+    if (!row) return row;
+    return this.mapRowToInsertResult(row, false);
+  }
+  async insertMany(jobs) {
+    const client = await this.pool.connect();
+    try {
+      await client.query("BEGIN");
+      const results = [];
+      for (const job of jobs) {
+        results.push(await this.insertTx(client, job.args, job.opts));
+      }
+      await client.query("COMMIT");
+      return results;
+    } catch (error) {
+      await client.query("ROLLBACK");
+      throw error;
+    } finally {
+      client.release();
+    }
+  }
+  async getTx() {
+    return this.pool.connect();
+  }
+  /**
+   * Helper to map a DB row to a Job<T> and InsertResult.
+   */
+  mapRowToInsertResult(row, skipped) {
+    return {
+      job: {
+        ...row,
+        args: { ...row.args, kind: row.kind },
+        uniqueStates: bitmaskToJobStates(row.uniqueStates)
+      },
+      skipped
+    };
+  }
+};
+
+export { PgDriver };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map