@odunlamizo/node-river 1.0.4 → 1.0.6

package/dist/insert-result-Bf0bAFvJ.d.ts

@@ -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 };

package/dist/types.cjs

@@ -0,0 +1,18 @@
+'use strict';
+
+// src/types/enums.ts
+var JobState = /* @__PURE__ */ ((JobState2) => {
+  JobState2["Available"] = "available";
+  JobState2["Cancelled"] = "cancelled";
+  JobState2["Completed"] = "completed";
+  JobState2["Discarded"] = "discarded";
+  JobState2["Pending"] = "pending";
+  JobState2["Retryable"] = "retryable";
+  JobState2["Running"] = "running";
+  JobState2["Scheduled"] = "scheduled";
+  return JobState2;
+})(JobState || {});
+
+exports.JobState = JobState;
+//# sourceMappingURL=types.cjs.map
+//# sourceMappingURL=types.cjs.map

package/dist/types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types/enums.ts"],"names":["JobState"],"mappings":";;;AAGO,IAAK,QAAA,qBAAAA,SAAAA,KAAL;AAIL,EAAAA,UAAA,WAAA,CAAA,GAAY,WAAA;AAKZ,EAAAA,UAAA,WAAA,CAAA,GAAY,WAAA;AAKZ,EAAAA,UAAA,WAAA,CAAA,GAAY,WAAA;AAKZ,EAAAA,UAAA,WAAA,CAAA,GAAY,WAAA;AAKZ,EAAAA,UAAA,SAAA,CAAA,GAAU,SAAA;AAKV,EAAAA,UAAA,WAAA,CAAA,GAAY,WAAA;AAKZ,EAAAA,UAAA,SAAA,CAAA,GAAU,SAAA;AAKV,EAAAA,UAAA,WAAA,CAAA,GAAY,WAAA;AAvCF,EAAA,OAAAA,SAAAA;AAAA,CAAA,EAAA,QAAA,IAAA,EAAA","file":"types.cjs","sourcesContent":["/**\n * Represents the lifecycle state of a job, such as available, running, completed, or scheduled.\n */\nexport enum JobState {\n  /**\n   * Immediately eligible to be worked\n   */\n  Available = 'available',\n\n  /**\n   * Manually cancelled by user; cleaned after a period\n   */\n  Cancelled = 'cancelled',\n\n  /**\n   * Successfully run to completion; cleaned after a period\n   */\n  Completed = 'completed',\n\n  /**\n   * Errored too many times; needs manual intervention\n   */\n  Discarded = 'discarded',\n\n  /**\n   * Waiting for external action; not worked or deleted until moved\n   */\n  Pending = 'pending',\n\n  /**\n   * Errored but will be retried; becomes Available when ready\n   */\n  Retryable = 'retryable',\n\n  /**\n   * Actively running; may need rescue if stuck\n   */\n  Running = 'running',\n\n  /**\n   * Scheduled for future execution; becomes Available when due\n   */\n  Scheduled = 'scheduled',\n}\n"]}

package/dist/types.d.cts

@@ -0,0 +1,18 @@
+export { A as AttemptError, I as InsertOpts, a as InsertResult, b as Job, J as JobArgs, c as JobState, U as UniqueOpts } from './insert-result-Bf0bAFvJ.cjs';
+import '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;
+}
+
+export type { ClientConfiguration };

package/dist/types.d.ts

@@ -0,0 +1,18 @@
+export { A as AttemptError, I as InsertOpts, a as InsertResult, b as Job, J as JobArgs, c as JobState, U as UniqueOpts } from './insert-result-Bf0bAFvJ.js';
+import '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;
+}
+
+export type { ClientConfiguration };

package/dist/types.js

@@ -0,0 +1,16 @@
+// src/types/enums.ts
+var JobState = /* @__PURE__ */ ((JobState2) => {
+  JobState2["Available"] = "available";
+  JobState2["Cancelled"] = "cancelled";
+  JobState2["Completed"] = "completed";
+  JobState2["Discarded"] = "discarded";
+  JobState2["Pending"] = "pending";
+  JobState2["Retryable"] = "retryable";
+  JobState2["Running"] = "running";
+  JobState2["Scheduled"] = "scheduled";
+  return JobState2;
+})(JobState || {});
+
+export { JobState };
+//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types/enums.ts"],"names":["JobState"],"mappings":";AAGO,IAAK,QAAA,qBAAAA,SAAAA,KAAL;AAIL,EAAAA,UAAA,WAAA,CAAA,GAAY,WAAA;AAKZ,EAAAA,UAAA,WAAA,CAAA,GAAY,WAAA;AAKZ,EAAAA,UAAA,WAAA,CAAA,GAAY,WAAA;AAKZ,EAAAA,UAAA,WAAA,CAAA,GAAY,WAAA;AAKZ,EAAAA,UAAA,SAAA,CAAA,GAAU,SAAA;AAKV,EAAAA,UAAA,WAAA,CAAA,GAAY,WAAA;AAKZ,EAAAA,UAAA,SAAA,CAAA,GAAU,SAAA;AAKV,EAAAA,UAAA,WAAA,CAAA,GAAY,WAAA;AAvCF,EAAA,OAAAA,SAAAA;AAAA,CAAA,EAAA,QAAA,IAAA,EAAA","file":"types.js","sourcesContent":["/**\n * Represents the lifecycle state of a job, such as available, running, completed, or scheduled.\n */\nexport enum JobState {\n  /**\n   * Immediately eligible to be worked\n   */\n  Available = 'available',\n\n  /**\n   * Manually cancelled by user; cleaned after a period\n   */\n  Cancelled = 'cancelled',\n\n  /**\n   * Successfully run to completion; cleaned after a period\n   */\n  Completed = 'completed',\n\n  /**\n   * Errored too many times; needs manual intervention\n   */\n  Discarded = 'discarded',\n\n  /**\n   * Waiting for external action; not worked or deleted until moved\n   */\n  Pending = 'pending',\n\n  /**\n   * Errored but will be retried; becomes Available when ready\n   */\n  Retryable = 'retryable',\n\n  /**\n   * Actively running; may need rescue if stuck\n   */\n  Running = 'running',\n\n  /**\n   * Scheduled for future execution; becomes Available when due\n   */\n  Scheduled = 'scheduled',\n}\n"]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@odunlamizo/node-river",
-  "version": "1.0.4",
-  "description": "Node.js library to support riverqueue integration.",
+  "version": "1.0.6",
+  "description": "Node.js library to support River integration.",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -9,9 +9,26 @@
   "files": [
     "dist"
   ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./drivers/pg": {
+      "types": "./dist/drivers/pg/index.d.ts",
+      "import": "./dist/drivers/pg/index.mjs",
+      "require": "./dist/drivers/pg/index.js"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/types.mjs",
+      "require": "./dist/types.js"
+    }
+  },
   "scripts": {
-    "build": "tsup src/index.ts --dts --format cjs,esm",
-    "dev": "tsup src/index.ts --watch --dts --format cjs,esm",
+    "build": "tsup",
+    "dev": "tsup --watch",
     "test": "jest --runInBand",
     "lint": "eslint . --ext .ts,.js --ignore-pattern eslint.config.js",
     "format": "prettier --write .",