@odunlamizo/node-river 1.0.5 → 1.0.7

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/utils/mappers.ts","../../../src/drivers/pg/pg-driver.ts"],"names":["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,GAAO,MAAA,CAAO,UAAA,CAAW,QAAQ,CAAA,CAAE,MAAA,CAAO,IAAA,CAAK,SAAA,CAAU,QAAQ,CAAC,CAAA,CAAE,MAAA,EAAO;AAEjF,EAAA,OAAO,MAAA,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,IAAI,IAAA,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,IAAIA,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.js","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/index.cjs

@@ -1,28 +1,4 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  RiverClient: () => RiverClient
-});
-module.exports = __toCommonJS(index_exports);
+'use strict';
 
 // src/client.ts
 var RiverClient = class {
@@ -99,7 +75,7 @@ var RiverClient = class {
     return this.driver.insertMany(jobsWithDefaults);
   }
 };
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  RiverClient
-});
+
+exports.RiverClient = RiverClient;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/client.ts"],"names":[],"mappings":";;;AAMA,IAAqB,cAArB,MAA2D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASzD,WAAA,CAAY,QAAW,aAAA,EAAoC;AACzD,IAAA,IAAA,CAAK,MAAA,GAAS,MAAA;AACd,IAAA,IAAA,CAAK,aAAA,GAAgB,aAAA;AAAA,EACvB;AAAA;AAAA;AAAA;AAAA,EAKA,gBAAA,GAAkC;AAChC,IAAA,OAAO,IAAA,CAAK,OAAO,gBAAA,EAAiB;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA,EAKA,KAAA,GAAuB;AACrB,IAAA,OAAO,IAAA,CAAK,OAAO,KAAA,EAAM;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAA,CAA0B,IAAA,EAAS,IAAA,GAAmB,EAAC,EAA6B;AAClF,IAAA,MAAM,WAAA,GAA0B;AAAA,MAC9B,KAAA,EAAO,KAAK,aAAA,CAAc,YAAA;AAAA,MAC1B,WAAA,EAAa,KAAK,aAAA,CAAc,WAAA;AAAA,MAChC,GAAG;AAAA,KACL;AAEA,IAAA,OAAO,IAAA,CAAK,MAAA,CAAO,MAAA,CAAO,IAAA,EAAM,WAAW,CAAA;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,QAAA,CAA4B,EAAA,EAAQ,IAAA,EAAS,IAAA,GAAmB,EAAC,EAA6B;AAC5F,IAAA,MAAM,WAAA,GAA0B;AAAA,MAC9B,KAAA,EAAO,KAAK,aAAA,CAAc,YAAA;AAAA,MAC1B,WAAA,EAAa,KAAK,aAAA,CAAc,WAAA;AAAA,MAChC,GAAG;AAAA,KACL;AAEA,IAAA,OAAO,IAAA,CAAK,MAAA,CAAO,QAAA,CAAS,EAAA,EAAI,MAAM,WAAW,CAAA;AAAA,EACnD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,WACJ,IAAA,EAC4B;AAC5B,IAAA,MAAM,gBAAA,GAAmB,IAAA,CAAK,GAAA,CAAI,CAAC,GAAA,MAAS;AAAA,MAC1C,MAAM,GAAA,CAAI,IAAA;AAAA,MACV,IAAA,EAAM;AAAA,QACJ,KAAA,EAAO,KAAK,aAAA,CAAc,YAAA;AAAA,QAC1B,WAAA,EAAa,KAAK,aAAA,CAAc,WAAA;AAAA,QAChC,GAAG,GAAA,CAAI;AAAA;AACT,KACF,CAAE,CAAA;AAEF,IAAA,OAAO,IAAA,CAAK,MAAA,CAAO,UAAA,CAAW,gBAAgB,CAAA;AAAA,EAChD;AACF","file":"index.cjs","sourcesContent":["import { Driver } from './drivers';\nimport { ClientConfiguration, InsertOpts, InsertResult, JobArgs } from './types';\n\n/**\n * Provides methods to enqueue jobs and manage queue operations.\n */\nexport default class RiverClient<D extends Driver<Tx>, Tx> {\n  private readonly driver: D;\n  private readonly configuration: ClientConfiguration;\n\n  /**\n   * Creates a new RiverClient instance.\n   * @param driver - The queue driver implementation.\n   * @param configuration - Client configuration options.\n   */\n  constructor(driver: D, configuration: ClientConfiguration) {\n    this.driver = driver;\n    this.configuration = configuration;\n  }\n\n  /**\n   * Checks if the driver can connect to the database. Throws on failure.\n   */\n  verifyConnection(): Promise<void> {\n    return this.driver.verifyConnection();\n  }\n\n  /**\n   * Closes all database connections and cleans up resources.\n   */\n  close(): Promise<void> {\n    return this.driver.close();\n  }\n\n  /**\n   * Inserts a job into the queue with the specified arguments and options.\n   * @param args - The job arguments to insert.\n   * @param opts - Optional insertion options.\n   * @returns A promise that resolves to the result of the insertion operation,\n   *          including the job and whether the insert was skipped due to uniqueness.\n   */\n  insert<T extends JobArgs>(args: T, opts: InsertOpts = {}): Promise<InsertResult<T>> {\n    const defaultOpts: InsertOpts = {\n      queue: this.configuration.defaultQueue,\n      maxAttempts: this.configuration.maxAttempts,\n      ...opts,\n    };\n\n    return this.driver.insert(args, defaultOpts);\n  }\n\n  /**\n   * Inserts a job into the queue within an existing transaction or session.\n   * The transaction type (Tx) is determined by the driver implementation.\n   *\n   * @param tx - The transaction or session object to use for the insert.\n   * @param args - The job arguments to insert.\n   * @param opts - Optional insertion options.\n   * @returns A promise that resolves to the result of the insertion operation,\n   *          including the job and whether the insert was skipped due to uniqueness.\n   */\n  insertTx<T extends JobArgs>(tx: Tx, args: T, opts: InsertOpts = {}): Promise<InsertResult<T>> {\n    const defaultOpts: InsertOpts = {\n      queue: this.configuration.defaultQueue,\n      maxAttempts: this.configuration.maxAttempts,\n      ...opts,\n    };\n\n    return this.driver.insertTx(tx, args, defaultOpts);\n  }\n\n  /**\n   * Inserts multiple jobs in sequence within a single transaction.\n   * If any insert fails, all previous inserts in the batch are rolled back.\n   *\n   * @param jobs - Array of job argument and option pairs to insert.\n   * @returns A promise that resolves to an array of InsertResult objects for each job.\n   */\n  async insertMany<T extends JobArgs>(\n    jobs: { args: T; opts: InsertOpts }[],\n  ): Promise<InsertResult<T>[]> {\n    const jobsWithDefaults = jobs.map((job) => ({\n      args: job.args,\n      opts: {\n        queue: this.configuration.defaultQueue,\n        maxAttempts: this.configuration.maxAttempts,\n        ...job.opts,\n      },\n    }));\n\n    return this.driver.insertMany(jobsWithDefaults);\n  }\n}\n"]}

package/dist/index.d.cts

@@ -1,304 +1,7 @@
-import { Buffer } from 'buffer';
-
-/**
- * Configuration options for the RiverQueue client.
- */
-interface ClientConfiguration {
-    /**
-     * Default queue name for job insertion
-     */
-    defaultQueue?: string;
-    /**
-     * Maximum number of attempts for jobs
-     */
-    maxAttempts?: number;
-}
-
-/**
- * Represents the lifecycle state of a job, such as available, running, completed, or scheduled.
- */
-declare enum JobState {
-    /**
-     * Immediately eligible to be worked
-     */
-    Available = "available",
-    /**
-     * Manually cancelled by user; cleaned after a period
-     */
-    Cancelled = "cancelled",
-    /**
-     * Successfully run to completion; cleaned after a period
-     */
-    Completed = "completed",
-    /**
-     * Errored too many times; needs manual intervention
-     */
-    Discarded = "discarded",
-    /**
-     * Waiting for external action; not worked or deleted until moved
-     */
-    Pending = "pending",
-    /**
-     * Errored but will be retried; becomes Available when ready
-     */
-    Retryable = "retryable",
-    /**
-     * Actively running; may need rescue if stuck
-     */
-    Running = "running",
-    /**
-     * Scheduled for future execution; becomes Available when due
-     */
-    Scheduled = "scheduled"
-}
-
-/**
- * Represents a failed job attempt, including error details and stack trace.
- */
-interface AttemptError {
-    /**
-     * Time the error occurred
-     */
-    at: string;
-    /**
-     * Attempt number when the error occurred
-     */
-    attempt: number;
-    /**
-     * Stringified error or panic value
-     */
-    error: string;
-    /**
-     * Stack trace from a job that panicked
-     */
-    trace: string;
-}
-
-/**
- * Options for enforcing uniqueness constraints on jobs.
- */
-interface UniqueOpts {
-    /**
-     * Enforce uniqueness based on job arguments.
-     * True for all args, or specify keys to include.
-     */
-    byArgs?: true | string[];
-    /**
-     * Enforce uniqueness within a time period (seconds).
-     */
-    byPeriod?: number;
-    /**
-     * Enforce uniqueness within each queue.
-     */
-    byQueue?: true;
-    /**
-     * Enforce uniqueness across specified job states.
-     */
-    byState?: string[];
-    /**
-     * Exclude job kind from uniqueness computation.
-     */
-    excludeKind?: true;
-}
-
-/**
- * Options for job insertion, such as queue, priority, scheduling, and metadata.
- */
-interface InsertOpts {
-    /**
-     * List of tags for grouping and categorizing jobs
-     */
-    tags?: string[];
-    /**
-     * Name of the job queue to insert into
-     */
-    queue?: string;
-    /**
-     * Job priority (1 = highest, 4 = lowest)
-     */
-    priority?: number;
-    /**
-     * Arbitrary metadata for the job
-     */
-    metadata?: Record<string, unknown>;
-    /**
-     * Maximum number of attempts before discarding the job
-     */
-    maxAttempts?: number;
-    /**
-     * Schedule the job for future execution
-     */
-    scheduledAt?: Date;
-    /**
-     * Options relating to job uniqueness.
-     * If not set, the job is never treated as unique.
-     */
-    uniqueOpts?: UniqueOpts;
-}
-
-/**
- * Interface for job argument objects passed to job handlers.
- *
- * Every job must specify a `kind` to identify its type, and can include
- * any number of additional properties relevant to the job's execution.
- */
-interface JobArgs {
-    /**
-     * Identifies the job type for routing and processing.
-     */
-    kind: string;
-    /**
-     * Arbitrary job parameters, allowing for flexible job payloads.
-     * All values should be JSON-compatible.
-     */
-    [key: string]: unknown;
-}
-
-/**
- * Represents a job persisted in the database, including its state, metadata, and scheduling information.
- */
-interface Job<T extends JobArgs = JobArgs> {
-    /**
-     * Unique job ID, generated by the database
-     */
-    id: number;
-    /**
-     * Current state of the job (e.g., available, completed)
-     */
-    state: JobState;
-    /**
-     * Current attempt number, incremented each time the job is worked
-     */
-    attempt: number;
-    /**
-     * Maximum number of attempts before the job stops retrying
-     */
-    maxAttempts: number;
-    /**
-     * Last time the job was worked, null if never
-     */
-    attemptedAt: Date | null;
-    /**
-     * When the job record was created
-     */
-    createdAt: Date;
-    /**
-     * When the job was finalized (completed or errored for last time), null if not finalized
-     */
-    finalizedAt: Date | null;
-    /**
-     * When the job is scheduled to become available
-     */
-    scheduledAt: Date;
-    /**
-     * Job priority (1 = highest, 4 = lowest)
-     */
-    priority: number;
-    /**
-     * Job arguments, decoded from JSON
-     */
-    args: T;
-    /**
-     * Worker IDs that have worked this job, null if never
-     */
-    attemptedBy: string[] | null;
-    /**
-     * Errors for each attempt, ordered earliest to latest, null if none
-     */
-    errors: AttemptError[] | null;
-    /**
-     * Job type identifier, set at insertion
-     */
-    kind: string;
-    /**
-     * Arbitrary metadata associated with the job
-     */
-    metadata: Record<string, unknown>;
-    /**
-     * Name of the queue where the job will be worked
-     */
-    queue: string;
-    /**
-     * List of tags for grouping and categorizing jobs
-     */
-    tags: string[];
-    /**
-     * Unique key for job within its kind, used for unique insertions, null if not set
-     */
-    uniqueKey: Buffer | null;
-    /**
-     * States required for uniqueness, null if not set
-     */
-    uniqueStates: JobState[] | null;
-}
-
-/**
- * Result of a job insertion operation.
- *
- * - If a unique job already exists, `job` is the existing job and `skipped` is true.
- * - If the job was inserted, `job` is the new job and `skipped` is false.
- */
-interface InsertResult<T extends JobArgs = JobArgs> {
-    /**
-     * The inserted job, or the existing job if insertion was skipped due to uniqueness.
-     */
-    job: Job<T>;
-    /**
-     * True if insertion was skipped because a unique job already exists.
-     */
-    skipped: boolean;
-}
-
-/**
- * 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>;
-}
+import { D as Driver } from './driver-vSyPLsFq.cjs';
+import { ClientConfiguration } from './types.cjs';
+import { J as JobArgs, I as InsertOpts, a as InsertResult } from './insert-result-Bf0bAFvJ.cjs';
+import 'buffer';
 
 /**
  * Provides methods to enqueue jobs and manage queue operations.