@odunlamizo/node-river 1.0.4 → 1.0.6

package/dist/index.d.ts

@@ -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-okKFbSrB.js';
+import { ClientConfiguration } from './types.js';
+import { J as JobArgs, I as InsertOpts, a as InsertResult } from './insert-result-Bf0bAFvJ.js';
+import 'buffer';
 
 /**
  * Provides methods to enqueue jobs and manage queue operations.

package/dist/index.js

@@ -73,6 +73,7 @@ var RiverClient = class {
     return this.driver.insertMany(jobsWithDefaults);
   }
 };
-export {
-  RiverClient
-};
+
+export { RiverClient };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.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.js","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/insert-result-Bf0bAFvJ.d.cts

@@ -0,0 +1,238 @@
+import { Buffer } from 'buffer';
+
+/**
+ * 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;
+}
+
+export { type AttemptError as A, type InsertOpts as I, type JobArgs as J, type UniqueOpts as U, type InsertResult as a, type Job as b, JobState as c };