@nicnocquee/dataqueue 1.16.0 → 1.18.0

package/dist/index.d.cts

@@ -2,11 +2,11 @@ import { Pool } from 'pg';
 
 type JobType<PayloadMap> = keyof PayloadMap & string;
 interface JobOptions<PayloadMap, T extends JobType<PayloadMap>> {
-    job_type: T;
+    jobType: T;
     payload: PayloadMap[T];
-    max_attempts?: number;
+    maxAttempts?: number;
     priority?: number;
-    run_at?: Date | null;
+    runAt?: Date | null;
     /**
      * Timeout for this job in milliseconds. If not set, uses the processor default or unlimited.
      */
@@ -22,9 +22,9 @@ declare enum JobEventType {
 }
 interface JobEvent {
     id: number;
-    job_id: number;
-    event_type: JobEventType;
-    created_at: Date;
+    jobId: number;
+    eventType: JobEventType;
+    createdAt: Date;
     metadata: any;
 }
 declare enum FailureReason {
@@ -32,53 +32,54 @@ declare enum FailureReason {
     HandlerError = "handler_error",
     NoHandler = "no_handler"
 }
+type JobStatus = 'pending' | 'processing' | 'completed' | 'failed' | 'cancelled';
 interface JobRecord<PayloadMap, T extends JobType<PayloadMap>> {
     id: number;
-    job_type: T;
+    jobType: T;
     payload: PayloadMap[T];
-    status: 'pending' | 'processing' | 'completed' | 'failed' | 'cancelled';
-    created_at: Date;
-    updated_at: Date;
-    locked_at: Date | null;
-    locked_by: string | null;
+    status: JobStatus;
+    createdAt: Date;
+    updatedAt: Date;
+    lockedAt: Date | null;
+    lockedBy: string | null;
     attempts: number;
-    max_attempts: number;
-    next_attempt_at: Date | null;
+    maxAttempts: number;
+    nextAttemptAt: Date | null;
     priority: number;
-    run_at: Date;
-    pending_reason?: string | null;
-    error_history?: {
+    runAt: Date;
+    pendingReason?: string | null;
+    errorHistory?: {
         message: string;
         timestamp: string;
     }[];
     /**
      * Timeout for this job in milliseconds (null means no timeout).
      */
-    timeout_ms?: number | null;
+    timeoutMs?: number | null;
     /**
      * The reason for the last failure, if any.
      */
-    failure_reason?: FailureReason | null;
+    failureReason?: FailureReason | null;
     /**
      * The time the job was completed, if completed.
      */
-    completed_at: Date | null;
+    completedAt: Date | null;
     /**
      * The time the job was first picked up for processing.
      */
-    started_at: Date | null;
+    startedAt: Date | null;
     /**
      * The time the job was last retried.
      */
-    last_retried_at: Date | null;
+    lastRetriedAt: Date | null;
     /**
      * The time the job last failed.
      */
-    last_failed_at: Date | null;
+    lastFailedAt: Date | null;
     /**
      * The time the job was last cancelled.
      */
-    last_cancelled_at: Date | null;
+    lastCancelledAt: Date | null;
 }
 type JobHandler<PayloadMap, T extends keyof PayloadMap> = (payload: PayloadMap[T], signal: AbortSignal) => Promise<void>;
 type JobHandlers<PayloadMap> = {
@@ -163,9 +164,9 @@ interface JobQueue<PayloadMap> {
      * Get jobs by their status, with pagination.
      * - If no limit is provided, all jobs are returned.
      * - If no offset is provided, the first page is returned.
-     * - The jobs are returned in descending order of created_at.
+     * - The jobs are returned in descending order of createdAt.
      */
-    getJobsByStatus: <T extends JobType<PayloadMap>>(status: string, limit?: number, offset?: number) => Promise<JobRecord<PayloadMap, T>[]>;
+    getJobsByStatus: <T extends JobType<PayloadMap>>(status: JobStatus, limit?: number, offset?: number) => Promise<JobRecord<PayloadMap, T>[]>;
     /**
      * Get all jobs.
      */
@@ -196,14 +197,14 @@ interface JobQueue<PayloadMap> {
      * - If no filters are provided, all upcoming jobs are cancelled.
      * - If filters are provided, only jobs that match the filters are cancelled.
      * - The filters are:
-     *   - job_type: The job type to cancel.
+     *   - jobType: The job type to cancel.
      *   - priority: The priority of the job to cancel.
-     *   - run_at: The time the job is scheduled to run at.
+     *   - runAt: The time the job is scheduled to run at.
      */
     cancelAllUpcomingJobs: (filters?: {
-        job_type?: string;
+        jobType?: string;
         priority?: number;
-        run_at?: Date;
+        runAt?: Date;
     }) => Promise<number>;
     /**
      * Create a job processor. Handlers must be provided per-processor.
@@ -224,4 +225,4 @@ interface JobQueue<PayloadMap> {
  */
 declare const initJobQueue: <PayloadMap = any>(config: JobQueueConfig) => Promise<JobQueue<PayloadMap>>;
 
-export { FailureReason, type JobEvent, JobEventType, type JobHandler, type JobHandlers, type JobOptions, type JobQueue, type JobQueueConfig, type JobRecord, type JobType, type Processor, type ProcessorOptions, initJobQueue };
+export { FailureReason, type JobEvent, JobEventType, type JobHandler, type JobHandlers, type JobOptions, type JobQueue, type JobQueueConfig, type JobRecord, type JobStatus, type JobType, type Processor, type ProcessorOptions, initJobQueue };

package/dist/index.d.ts

@@ -2,11 +2,11 @@ import { Pool } from 'pg';
 
 type JobType<PayloadMap> = keyof PayloadMap & string;
 interface JobOptions<PayloadMap, T extends JobType<PayloadMap>> {
-    job_type: T;
+    jobType: T;
     payload: PayloadMap[T];
-    max_attempts?: number;
+    maxAttempts?: number;
     priority?: number;
-    run_at?: Date | null;
+    runAt?: Date | null;
     /**
      * Timeout for this job in milliseconds. If not set, uses the processor default or unlimited.
      */
@@ -22,9 +22,9 @@ declare enum JobEventType {
 }
 interface JobEvent {
     id: number;
-    job_id: number;
-    event_type: JobEventType;
-    created_at: Date;
+    jobId: number;
+    eventType: JobEventType;
+    createdAt: Date;
     metadata: any;
 }
 declare enum FailureReason {
@@ -32,53 +32,54 @@ declare enum FailureReason {
     HandlerError = "handler_error",
     NoHandler = "no_handler"
 }
+type JobStatus = 'pending' | 'processing' | 'completed' | 'failed' | 'cancelled';
 interface JobRecord<PayloadMap, T extends JobType<PayloadMap>> {
     id: number;
-    job_type: T;
+    jobType: T;
     payload: PayloadMap[T];
-    status: 'pending' | 'processing' | 'completed' | 'failed' | 'cancelled';
-    created_at: Date;
-    updated_at: Date;
-    locked_at: Date | null;
-    locked_by: string | null;
+    status: JobStatus;
+    createdAt: Date;
+    updatedAt: Date;
+    lockedAt: Date | null;
+    lockedBy: string | null;
     attempts: number;
-    max_attempts: number;
-    next_attempt_at: Date | null;
+    maxAttempts: number;
+    nextAttemptAt: Date | null;
     priority: number;
-    run_at: Date;
-    pending_reason?: string | null;
-    error_history?: {
+    runAt: Date;
+    pendingReason?: string | null;
+    errorHistory?: {
         message: string;
         timestamp: string;
     }[];
     /**
      * Timeout for this job in milliseconds (null means no timeout).
      */
-    timeout_ms?: number | null;
+    timeoutMs?: number | null;
     /**
      * The reason for the last failure, if any.
      */
-    failure_reason?: FailureReason | null;
+    failureReason?: FailureReason | null;
     /**
      * The time the job was completed, if completed.
      */
-    completed_at: Date | null;
+    completedAt: Date | null;
     /**
      * The time the job was first picked up for processing.
      */
-    started_at: Date | null;
+    startedAt: Date | null;
     /**
      * The time the job was last retried.
      */
-    last_retried_at: Date | null;
+    lastRetriedAt: Date | null;
     /**
      * The time the job last failed.
      */
-    last_failed_at: Date | null;
+    lastFailedAt: Date | null;
     /**
      * The time the job was last cancelled.
      */
-    last_cancelled_at: Date | null;
+    lastCancelledAt: Date | null;
 }
 type JobHandler<PayloadMap, T extends keyof PayloadMap> = (payload: PayloadMap[T], signal: AbortSignal) => Promise<void>;
 type JobHandlers<PayloadMap> = {
@@ -163,9 +164,9 @@ interface JobQueue<PayloadMap> {
      * Get jobs by their status, with pagination.
      * - If no limit is provided, all jobs are returned.
      * - If no offset is provided, the first page is returned.
-     * - The jobs are returned in descending order of created_at.
+     * - The jobs are returned in descending order of createdAt.
      */
-    getJobsByStatus: <T extends JobType<PayloadMap>>(status: string, limit?: number, offset?: number) => Promise<JobRecord<PayloadMap, T>[]>;
+    getJobsByStatus: <T extends JobType<PayloadMap>>(status: JobStatus, limit?: number, offset?: number) => Promise<JobRecord<PayloadMap, T>[]>;
     /**
      * Get all jobs.
      */
@@ -196,14 +197,14 @@ interface JobQueue<PayloadMap> {
      * - If no filters are provided, all upcoming jobs are cancelled.
      * - If filters are provided, only jobs that match the filters are cancelled.
      * - The filters are:
-     *   - job_type: The job type to cancel.
+     *   - jobType: The job type to cancel.
      *   - priority: The priority of the job to cancel.
-     *   - run_at: The time the job is scheduled to run at.
+     *   - runAt: The time the job is scheduled to run at.
      */
     cancelAllUpcomingJobs: (filters?: {
-        job_type?: string;
+        jobType?: string;
         priority?: number;
-        run_at?: Date;
+        runAt?: Date;
     }) => Promise<number>;
     /**
      * Create a job processor. Handlers must be provided per-processor.
@@ -224,4 +225,4 @@ interface JobQueue<PayloadMap> {
  */
 declare const initJobQueue: <PayloadMap = any>(config: JobQueueConfig) => Promise<JobQueue<PayloadMap>>;
 
-export { FailureReason, type JobEvent, JobEventType, type JobHandler, type JobHandlers, type JobOptions, type JobQueue, type JobQueueConfig, type JobRecord, type JobType, type Processor, type ProcessorOptions, initJobQueue };
+export { FailureReason, type JobEvent, JobEventType, type JobHandler, type JobHandlers, type JobOptions, type JobQueue, type JobQueueConfig, type JobRecord, type JobStatus, type JobType, type Processor, type ProcessorOptions, initJobQueue };

package/dist/index.js

@@ -46,26 +46,26 @@ var recordJobEvent = async (pool, jobId, eventType, metadata) => {
   }
 };
 var addJob = async (pool, {
-  job_type,
+  jobType,
   payload,
-  max_attempts = 3,
+  maxAttempts = 3,
   priority = 0,
-  run_at = null,
+  runAt = null,
   timeoutMs = void 0
 }) => {
   const client = await pool.connect();
   try {
     let result;
-    if (run_at) {
+    if (runAt) {
       result = await client.query(
         `INSERT INTO job_queue 
           (job_type, payload, max_attempts, priority, run_at, timeout_ms) 
          VALUES ($1, $2, $3, $4, $5, $6) 
          RETURNING id`,
-        [job_type, payload, max_attempts, priority, run_at, timeoutMs ?? null]
+        [jobType, payload, maxAttempts, priority, runAt, timeoutMs ?? null]
       );
       log(
-        `Added job ${result.rows[0].id}: payload ${JSON.stringify(payload)}, run_at ${run_at.toISOString()}, priority ${priority}, max_attempts ${max_attempts} job_type ${job_type}`
+        `Added job ${result.rows[0].id}: payload ${JSON.stringify(payload)}, runAt ${runAt.toISOString()}, priority ${priority}, maxAttempts ${maxAttempts} jobType ${jobType}`
       );
     } else {
       result = await client.query(
@@ -73,14 +73,14 @@ var addJob = async (pool, {
           (job_type, payload, max_attempts, priority, timeout_ms) 
          VALUES ($1, $2, $3, $4, $5) 
          RETURNING id`,
-        [job_type, payload, max_attempts, priority, timeoutMs ?? null]
+        [jobType, payload, maxAttempts, priority, timeoutMs ?? null]
       );
       log(
-        `Added job ${result.rows[0].id}: payload ${JSON.stringify(payload)}, priority ${priority}, max_attempts ${max_attempts} job_type ${job_type}`
+        `Added job ${result.rows[0].id}: payload ${JSON.stringify(payload)}, priority ${priority}, maxAttempts ${maxAttempts} jobType ${jobType}`
       );
     }
     await recordJobEvent(pool, result.rows[0].id, "added" /* Added */, {
-      job_type,
+      jobType,
       payload
     });
     return result.rows[0].id;
@@ -94,19 +94,21 @@ var addJob = async (pool, {
 var getJob = async (pool, id) => {
   const client = await pool.connect();
   try {
-    const result = await client.query("SELECT * FROM job_queue WHERE id = $1", [
-      id
-    ]);
+    const result = await client.query(
+      `SELECT id, job_type AS "jobType", payload, status, max_attempts AS "maxAttempts", attempts, priority, run_at AS "runAt", timeout_ms AS "timeoutMs", created_at AS "createdAt", updated_at AS "updatedAt", started_at AS "startedAt", completed_at AS "completedAt", last_failed_at AS "lastFailedAt", locked_at AS "lockedAt", locked_by AS "lockedBy", error_history AS "errorHistory", failure_reason AS "failureReason", next_attempt_at AS "nextAttemptAt", last_failed_at AS "lastFailedAt", last_retried_at AS "lastRetriedAt", last_cancelled_at AS "lastCancelledAt", pending_reason AS "pendingReason" FROM job_queue WHERE id = $1`,
+      [id]
+    );
     if (result.rows.length === 0) {
       log(`Job ${id} not found`);
       return null;
     }
     log(`Found job ${id}`);
+    const job = result.rows[0];
     return {
-      ...result.rows[0],
-      payload: result.rows[0].payload,
-      timeout_ms: result.rows[0].timeout_ms,
-      failure_reason: result.rows[0].failure_reason
+      ...job,
+      payload: job.payload,
+      timeoutMs: job.timeoutMs,
+      failureReason: job.failureReason
     };
   } catch (error) {
     log(`Error getting job ${id}: ${error}`);
@@ -119,15 +121,15 @@ var getJobsByStatus = async (pool, status, limit = 100, offset = 0) => {
   const client = await pool.connect();
   try {
     const result = await client.query(
-      "SELECT * FROM job_queue WHERE status = $1 ORDER BY created_at DESC LIMIT $2 OFFSET $3",
+      `SELECT id, job_type AS "jobType", payload, status, max_attempts AS "maxAttempts", attempts, priority, run_at AS "runAt", timeout_ms AS "timeoutMs", created_at AS "createdAt", updated_at AS "updatedAt", started_at AS "startedAt", completed_at AS "completedAt", last_failed_at AS "lastFailedAt", locked_at AS "lockedAt", locked_by AS "lockedBy", error_history AS "errorHistory", failure_reason AS "failureReason", next_attempt_at AS "nextAttemptAt", last_failed_at AS "lastFailedAt", last_retried_at AS "lastRetriedAt", last_cancelled_at AS "lastCancelledAt", pending_reason AS "pendingReason" FROM job_queue WHERE status = $1 ORDER BY created_at DESC LIMIT $2 OFFSET $3`,
       [status, limit, offset]
     );
     log(`Found ${result.rows.length} jobs by status ${status}`);
-    return result.rows.map((row) => ({
-      ...row,
-      payload: row.payload,
-      timeout_ms: row.timeout_ms,
-      failure_reason: row.failure_reason
+    return result.rows.map((job) => ({
+      ...job,
+      payload: job.payload,
+      timeoutMs: job.timeoutMs,
+      failureReason: job.failureReason
     }));
   } catch (error) {
     log(`Error getting jobs by status ${status}: ${error}`);
@@ -172,7 +174,7 @@ var getNextBatch = async (pool, workerId, batchSize = 10, jobType) => {
         LIMIT $2
         FOR UPDATE SKIP LOCKED
       )
-      RETURNING *
+      RETURNING id, job_type AS "jobType", payload, status, max_attempts AS "maxAttempts", attempts, priority, run_at AS "runAt", timeout_ms AS "timeoutMs", created_at AS "createdAt", updated_at AS "updatedAt", started_at AS "startedAt", completed_at AS "completedAt", last_failed_at AS "lastFailedAt", locked_at AS "lockedAt", locked_by AS "lockedBy", error_history AS "errorHistory", failure_reason AS "failureReason", next_attempt_at AS "nextAttemptAt", last_retried_at AS "lastRetriedAt", last_cancelled_at AS "lastCancelledAt", pending_reason AS "pendingReason"
     `,
       params
     );
@@ -181,10 +183,10 @@ var getNextBatch = async (pool, workerId, batchSize = 10, jobType) => {
     for (const row of result.rows) {
       await recordJobEvent(pool, row.id, "processing" /* Processing */);
     }
-    return result.rows.map((row) => ({
-      ...row,
-      payload: row.payload,
-      timeout_ms: row.timeout_ms
+    return result.rows.map((job) => ({
+      ...job,
+      payload: job.payload,
+      timeoutMs: job.timeoutMs
     }));
   } catch (error) {
     log(`Error getting next batch: ${error}`);
@@ -327,17 +329,17 @@ var cancelAllUpcomingJobs = async (pool, filters) => {
     const params = [];
     let paramIdx = 1;
     if (filters) {
-      if (filters.job_type) {
+      if (filters.jobType) {
         query += ` AND job_type = $${paramIdx++}`;
-        params.push(filters.job_type);
+        params.push(filters.jobType);
       }
       if (filters.priority !== void 0) {
         query += ` AND priority = $${paramIdx++}`;
         params.push(filters.priority);
       }
-      if (filters.run_at) {
+      if (filters.runAt) {
         query += ` AND run_at = $${paramIdx++}`;
-        params.push(filters.run_at);
+        params.push(filters.runAt);
       }
     }
     query += "\nRETURNING id";
@@ -355,14 +357,14 @@ var getAllJobs = async (pool, limit = 100, offset = 0) => {
   const client = await pool.connect();
   try {
     const result = await client.query(
-      "SELECT * FROM job_queue ORDER BY created_at DESC LIMIT $1 OFFSET $2",
+      `SELECT id, job_type AS "jobType", payload, status, max_attempts AS "maxAttempts", attempts, priority, run_at AS "runAt", timeout_ms AS "timeoutMs", created_at AS "createdAt", updated_at AS "updatedAt", started_at AS "startedAt", completed_at AS "completedAt", last_failed_at AS "lastFailedAt", locked_at AS "lockedAt", locked_by AS "lockedBy", error_history AS "errorHistory", failure_reason AS "failureReason", next_attempt_at AS "nextAttemptAt", last_failed_at AS "lastFailedAt", last_retried_at AS "lastRetriedAt", last_cancelled_at AS "lastCancelledAt", pending_reason AS "pendingReason" FROM job_queue ORDER BY created_at DESC LIMIT $1 OFFSET $2`,
       [limit, offset]
     );
     log(`Found ${result.rows.length} jobs (all)`);
-    return result.rows.map((row) => ({
-      ...row,
-      payload: row.payload,
-      timeout_ms: row.timeout_ms
+    return result.rows.map((job) => ({
+      ...job,
+      payload: job.payload,
+      timeoutMs: job.timeoutMs
     }));
   } catch (error) {
     log(`Error getting all jobs: ${error}`);
@@ -418,7 +420,7 @@ var getJobEvents = async (pool, jobId) => {
   const client = await pool.connect();
   try {
     const res = await client.query(
-      "SELECT * FROM job_events WHERE job_id = $1 ORDER BY created_at ASC",
+      `SELECT id, job_id AS "jobId", event_type AS "eventType", metadata, created_at AS "createdAt" FROM job_events WHERE job_id = $1 ORDER BY created_at ASC`,
       [jobId]
     );
     return res.rows;
@@ -429,22 +431,22 @@ var getJobEvents = async (pool, jobId) => {
 
 // src/processor.ts
 async function processJobWithHandlers(pool, job, jobHandlers) {
-  const handler = jobHandlers[job.job_type];
+  const handler = jobHandlers[job.jobType];
   if (!handler) {
     await setPendingReasonForUnpickedJobs(
       pool,
-      `No handler registered for job type: ${job.job_type}`,
-      job.job_type
+      `No handler registered for job type: ${job.jobType}`,
+      job.jobType
     );
     await failJob(
       pool,
       job.id,
-      new Error(`No handler registered for job type: ${job.job_type}`),
+      new Error(`No handler registered for job type: ${job.jobType}`),
       "no_handler" /* NoHandler */
     );
     return;
   }
-  const timeoutMs = job.timeout_ms ?? void 0;
+  const timeoutMs = job.timeoutMs ?? void 0;
   let timeoutId;
   const controller = new AbortController();
   try {