@nicnocquee/dataqueue 1.25.0 → 1.26.0-beta.20260223202259

package/dist/index.d.ts

@@ -1,7 +1,33 @@
 import * as pg from 'pg';
 import { Pool } from 'pg';
+import { Cron } from 'croner';
 
 type JobType<PayloadMap> = keyof PayloadMap & string;
+/**
+ * Abstract database client interface for transactional job creation.
+ * Compatible with `pg.Pool`, `pg.PoolClient`, `pg.Client`, or any object
+ * that exposes a `.query()` method matching the `pg` signature.
+ */
+interface DatabaseClient {
+    query(text: string, values?: any[]): Promise<{
+        rows: any[];
+        rowCount: number | null;
+    }>;
+}
+/**
+ * Options for `addJob()` beyond the job itself.
+ * Use `db` to insert the job within an existing database transaction.
+ */
+interface AddJobOptions {
+    /**
+     * An external database client (e.g., a `pg.PoolClient` inside a transaction).
+     * When provided, the INSERT runs on this client instead of the internal pool,
+     * so the job is part of the caller's transaction.
+     *
+     * **PostgreSQL only.** Throws if used with the Redis backend.
+     */
+    db?: DatabaseClient;
+}
 interface JobOptions<PayloadMap, T extends JobType<PayloadMap>> {
     jobType: T;
     payload: PayloadMap[T];
@@ -74,6 +100,26 @@ interface JobOptions<PayloadMap, T extends JobType<PayloadMap>> {
      * Once a key exists, it cannot be reused until the job is cleaned up (via `cleanupOldJobs`).
      */
     idempotencyKey?: string;
+    /**
+     * Base delay between retries in seconds. When `retryBackoff` is true (the default),
+     * this is the base for exponential backoff: `retryDelay * 2^attempts`.
+     * When `retryBackoff` is false, retries use this fixed delay.
+     * @default 60
+     */
+    retryDelay?: number;
+    /**
+     * Whether to use exponential backoff for retries. When true, delay doubles
+     * with each attempt and includes jitter to prevent thundering herd.
+     * When false, a fixed `retryDelay` is used between every retry.
+     * @default true
+     */
+    retryBackoff?: boolean;
+    /**
+     * Maximum delay between retries in seconds. Caps the exponential backoff
+     * so retries never wait longer than this value. Only meaningful when
+     * `retryBackoff` is true. No limit when omitted.
+     */
+    retryDelayMax?: number;
 }
 /**
  * Options for editing a pending job.
@@ -186,6 +232,18 @@ interface JobRecord<PayloadMap, T extends JobType<PayloadMap>> {
      * Updated by the handler via `ctx.setProgress(percent)`.
      */
     progress?: number | null;
+    /**
+     * Base delay between retries in seconds, or null if using legacy default.
+     */
+    retryDelay?: number | null;
+    /**
+     * Whether exponential backoff is enabled for retries, or null if using legacy default.
+     */
+    retryBackoff?: boolean | null;
+    /**
+     * Maximum delay cap for retries in seconds, or null if no cap.
+     */
+    retryDelayMax?: number | null;
 }
 /**
  * Callback registered via `onTimeout`. Invoked when the timeout fires, before the AbortSignal is triggered.
@@ -416,6 +474,88 @@ interface Processor {
      */
     start: () => Promise<number>;
 }
+interface SupervisorOptions {
+    /**
+     * How often the maintenance loop runs, in milliseconds.
+     * @default 60000 (1 minute)
+     */
+    intervalMs?: number;
+    /**
+     * Reclaim jobs stuck in `processing` longer than this many minutes.
+     * @default 10
+     */
+    stuckJobsTimeoutMinutes?: number;
+    /**
+     * Auto-delete completed jobs older than this many days. Set to 0 to disable.
+     * @default 30
+     */
+    cleanupJobsDaysToKeep?: number;
+    /**
+     * Auto-delete job events older than this many days. Set to 0 to disable.
+     * @default 30
+     */
+    cleanupEventsDaysToKeep?: number;
+    /**
+     * Batch size for cleanup deletions.
+     * @default 1000
+     */
+    cleanupBatchSize?: number;
+    /**
+     * Whether to reclaim stuck jobs each cycle.
+     * @default true
+     */
+    reclaimStuckJobs?: boolean;
+    /**
+     * Whether to expire timed-out waitpoint tokens each cycle.
+     * @default true
+     */
+    expireTimedOutTokens?: boolean;
+    /**
+     * Called when a maintenance task throws. One failure does not block other tasks.
+     * @default console.error
+     */
+    onError?: (error: Error) => void;
+    /** Enable verbose logging. */
+    verbose?: boolean;
+}
+interface SupervisorRunResult {
+    /** Number of stuck jobs reclaimed back to pending. */
+    reclaimedJobs: number;
+    /** Number of old completed jobs deleted. */
+    cleanedUpJobs: number;
+    /** Number of old job events deleted. */
+    cleanedUpEvents: number;
+    /** Number of timed-out waitpoint tokens expired. */
+    expiredTokens: number;
+}
+interface Supervisor {
+    /**
+     * Run all maintenance tasks once and return the results.
+     * Ideal for serverless or cron-triggered invocations.
+     */
+    start: () => Promise<SupervisorRunResult>;
+    /**
+     * Start the maintenance loop in the background.
+     * Runs every `intervalMs` milliseconds (default: 60 000).
+     * Call `stop()` or `stopAndDrain()` to halt the loop.
+     */
+    startInBackground: () => void;
+    /**
+     * Stop the background maintenance loop immediately.
+     * Does not wait for an in-flight maintenance run to complete.
+     */
+    stop: () => void;
+    /**
+     * Stop the background loop and wait for the current maintenance run
+     * (if any) to finish before resolving.
+     *
+     * @param timeoutMs - Maximum time to wait (default: 30 000 ms).
+     *   If the run does not finish within this time the promise resolves anyway.
+     */
+    stopAndDrain: (timeoutMs?: number) => Promise<void>;
+    /** Whether the background maintenance loop is currently running. */
+    isRunning: () => boolean;
+}
 interface DatabaseSSLConfig {
     /**
      * CA certificate as PEM string or file path. If the value starts with 'file://', it will be loaded from file, otherwise treated as PEM string.
@@ -437,10 +577,13 @@ interface DatabaseSSLConfig {
 /**
  * Configuration for PostgreSQL backend (default).
  * Backward-compatible: omitting `backend` defaults to 'postgres'.
+ *
+ * Provide either `databaseConfig` (the library creates a pool) or `pool`
+ * (bring your own `pg.Pool`). At least one must be set.
  */
 interface PostgresJobQueueConfig {
     backend?: 'postgres';
-    databaseConfig: {
+    databaseConfig?: {
         connectionString?: string;
         host?: string;
         port?: number;
@@ -448,7 +591,29 @@ interface PostgresJobQueueConfig {
         user?: string;
         password?: string;
         ssl?: DatabaseSSLConfig;
+        /**
+         * Maximum number of clients in the pool (default: 10).
+         * Increase when running multiple processors in the same process.
+         */
+        max?: number;
+        /**
+         * Minimum number of idle clients in the pool (default: 0).
+         */
+        min?: number;
+        /**
+         * Milliseconds a client must sit idle before being closed (default: 10000).
+         */
+        idleTimeoutMillis?: number;
+        /**
+         * Milliseconds to wait for a connection before throwing (default: 0, no timeout).
+         */
+        connectionTimeoutMillis?: number;
     };
+    /**
+     * Bring your own `pg.Pool` instance. When provided, `databaseConfig` is
+     * ignored and the library will not close the pool on shutdown.
+     */
+    pool?: pg.Pool;
     verbose?: boolean;
 }
 /**
@@ -462,10 +627,13 @@ interface RedisTLSConfig {
 }
 /**
  * Configuration for Redis backend.
+ *
+ * Provide either `redisConfig` (the library creates an ioredis client) or
+ * `client` (bring your own ioredis instance). At least one must be set.
  */
 interface RedisJobQueueConfig {
     backend: 'redis';
-    redisConfig: {
+    redisConfig?: {
         /** Redis URL (e.g. redis://localhost:6379) */
         url?: string;
         host?: string;
@@ -480,6 +648,17 @@ interface RedisJobQueueConfig {
          */
         keyPrefix?: string;
     };
+    /**
+     * Bring your own ioredis client instance. When provided, `redisConfig` is
+     * ignored and the library will not close the client on shutdown.
+     * Use `keyPrefix` to set the key namespace (default: 'dq:').
+     */
+    client?: unknown;
+    /**
+     * Key prefix when using an external `client`. Ignored when `redisConfig` is used
+     * (set `redisConfig.keyPrefix` instead). Default: 'dq:'.
+     */
+    keyPrefix?: string;
     verbose?: boolean;
 }
 /**
@@ -490,11 +669,172 @@ type JobQueueConfig = PostgresJobQueueConfig | RedisJobQueueConfig;
 /** @deprecated Use JobQueueConfig instead. Alias kept for backward compat. */
 type JobQueueConfigLegacy = PostgresJobQueueConfig;
 type TagQueryMode = 'exact' | 'all' | 'any' | 'none';
+/**
+ * Status of a cron schedule.
+ */
+type CronScheduleStatus = 'active' | 'paused';
+/**
+ * Options for creating a recurring cron schedule.
+ * Each schedule defines a recurring job that is automatically enqueued
+ * when its cron expression matches.
+ */
+interface CronScheduleOptions<PayloadMap, T extends JobType<PayloadMap>> {
+    /** Unique human-readable name for the schedule. */
+    scheduleName: string;
+    /** Standard cron expression (5 fields, e.g. "0 * * * *"). */
+    cronExpression: string;
+    /** Job type from the PayloadMap. */
+    jobType: T;
+    /** Payload for each job instance. */
+    payload: PayloadMap[T];
+    /** Maximum retry attempts for each job instance (default: 3). */
+    maxAttempts?: number;
+    /** Priority for each job instance (default: 0). */
+    priority?: number;
+    /** Timeout in milliseconds for each job instance. */
+    timeoutMs?: number;
+    /** Whether to force-kill the job on timeout (default: false). */
+    forceKillOnTimeout?: boolean;
+    /** Tags for each job instance. */
+    tags?: string[];
+    /** IANA timezone string for cron evaluation (default: "UTC"). */
+    timezone?: string;
+    /**
+     * Whether to allow overlapping job instances (default: false).
+     * When false, a new job will not be enqueued if the previous instance
+     * is still pending, processing, or waiting.
+     */
+    allowOverlap?: boolean;
+    /** Base delay between retries in seconds for each job instance (default: 60). */
+    retryDelay?: number;
+    /** Whether to use exponential backoff for retries (default: true). */
+    retryBackoff?: boolean;
+    /** Maximum delay cap for retries in seconds. */
+    retryDelayMax?: number;
+}
+/**
+ * A persisted cron schedule record.
+ */
+interface CronScheduleRecord {
+    id: number;
+    scheduleName: string;
+    cronExpression: string;
+    jobType: string;
+    payload: any;
+    maxAttempts: number;
+    priority: number;
+    timeoutMs: number | null;
+    forceKillOnTimeout: boolean;
+    tags: string[] | undefined;
+    timezone: string;
+    allowOverlap: boolean;
+    status: CronScheduleStatus;
+    lastEnqueuedAt: Date | null;
+    lastJobId: number | null;
+    nextRunAt: Date | null;
+    createdAt: Date;
+    updatedAt: Date;
+    retryDelay: number | null;
+    retryBackoff: boolean | null;
+    retryDelayMax: number | null;
+}
+/**
+ * Options for editing an existing cron schedule.
+ * All fields are optional; only provided fields are updated.
+ */
+interface EditCronScheduleOptions {
+    cronExpression?: string;
+    payload?: any;
+    maxAttempts?: number;
+    priority?: number;
+    timeoutMs?: number | null;
+    forceKillOnTimeout?: boolean;
+    tags?: string[] | null;
+    timezone?: string;
+    allowOverlap?: boolean;
+    retryDelay?: number | null;
+    retryBackoff?: boolean | null;
+    retryDelayMax?: number | null;
+}
+/**
+ * Payload types for each event emitted by the job queue.
+ */
+interface QueueEventMap {
+    /** Fired after a job is successfully added to the queue. */
+    'job:added': {
+        jobId: number;
+        jobType: string;
+    };
+    /** Fired when a processor claims a job and begins executing its handler. */
+    'job:processing': {
+        jobId: number;
+        jobType: string;
+    };
+    /** Fired when a job handler completes successfully. */
+    'job:completed': {
+        jobId: number;
+        jobType: string;
+    };
+    /** Fired when a job handler fails. `willRetry` indicates whether the job will be retried. */
+    'job:failed': {
+        jobId: number;
+        jobType: string;
+        error: Error;
+        willRetry: boolean;
+    };
+    /** Fired after a job is cancelled via `cancelJob()`. */
+    'job:cancelled': {
+        jobId: number;
+    };
+    /** Fired after a failed job is manually retried via `retryJob()`. */
+    'job:retried': {
+        jobId: number;
+    };
+    /** Fired when a job enters the `waiting` state (via `ctx.waitFor`, `ctx.waitUntil`, or `ctx.waitForToken`). */
+    'job:waiting': {
+        jobId: number;
+        jobType: string;
+    };
+    /** Fired when a job reports progress via `ctx.setProgress()`. */
+    'job:progress': {
+        jobId: number;
+        progress: number;
+    };
+    /** Fired on internal errors from the processor or supervisor. */
+    error: Error;
+}
+/** Union of all event names supported by the job queue. */
+type QueueEventName = keyof QueueEventMap;
+/**
+ * Callback type for `emit`. Used internally to pass the emitter
+ * from `initJobQueue` into the processor and supervisor.
+ */
+type QueueEmitFn = <K extends QueueEventName>(event: K, data: QueueEventMap[K]) => void;
 interface JobQueue<PayloadMap> {
     /**
      * Add a job to the job queue.
+     *
+     * @param job - The job to enqueue.
+     * @param options - Optional. Pass `{ db }` with an external database client
+     *   to insert the job within an existing transaction (PostgreSQL only).
      */
-    addJob: <T extends JobType<PayloadMap>>(job: JobOptions<PayloadMap, T>) => Promise<number>;
+    addJob: <T extends JobType<PayloadMap>>(job: JobOptions<PayloadMap, T>, options?: AddJobOptions) => Promise<number>;
+    /**
+     * Add multiple jobs to the queue in a single operation.
+     *
+     * More efficient than calling `addJob` in a loop because it batches the
+     * INSERT into a single database round-trip (PostgreSQL) or a single
+     * atomic Lua script (Redis).
+     *
+     * Returns an array of job IDs in the same order as the input array.
+     * Each job may independently have an `idempotencyKey`; duplicates
+     * resolve to the existing job's ID without creating a new row.
+     *
+     * @param jobs - Array of jobs to enqueue.
+     * @param options - Optional. Pass `{ db }` with an external database client
+     *   to insert the jobs within an existing transaction (PostgreSQL only).
+     */
+    addJobs: <T extends JobType<PayloadMap>>(jobs: JobOptions<PayloadMap, T>[], options?: AddJobOptions) => Promise<number[]>;
     /**
      * Get a job by its ID.
      */
@@ -550,12 +890,18 @@ interface JobQueue<PayloadMap> {
     retryJob: (jobId: number) => Promise<void>;
     /**
      * Cleanup jobs that are older than the specified number of days.
+     * Deletes in batches for scale safety.
+     * @param daysToKeep - Number of days to retain completed jobs (default 30).
+     * @param batchSize - Number of rows to delete per batch (default 1000 for PostgreSQL, 200 for Redis).
      */
-    cleanupOldJobs: (daysToKeep?: number) => Promise<number>;
+    cleanupOldJobs: (daysToKeep?: number, batchSize?: number) => Promise<number>;
     /**
      * Cleanup job events that are older than the specified number of days.
+     * Deletes in batches for scale safety.
+     * @param daysToKeep - Number of days to retain events (default 30).
+     * @param batchSize - Number of rows to delete per batch (default 1000).
      */
-    cleanupOldJobEvents: (daysToKeep?: number) => Promise<number>;
+    cleanupOldJobEvents: (daysToKeep?: number, batchSize?: number) => Promise<number>;
     /**
      * Cancel a job given its ID.
      * - This will set the job status to 'cancelled' and clear the locked_at and locked_by.
@@ -633,6 +979,12 @@ interface JobQueue<PayloadMap> {
      * Create a job processor. Handlers must be provided per-processor.
      */
     createProcessor: (handlers: JobHandlers<PayloadMap>, options?: ProcessorOptions) => Processor;
+    /**
+     * Create a background supervisor that automatically reclaims stuck jobs,
+     * cleans up old completed jobs/events, and expires timed-out waitpoint
+     * tokens on a configurable interval.
+     */
+    createSupervisor: (options?: SupervisorOptions) => Supervisor;
     /**
      * Get the job events for a job.
      */
@@ -642,8 +994,6 @@ interface JobQueue<PayloadMap> {
      * Tokens can be completed externally to resume a waiting job.
      * Can be called outside of handlers (e.g., from an API route).
      *
-     * **PostgreSQL backend only.** Throws if the backend is Redis.
-     *
      * @param options - Optional token configuration (timeout, tags).
      * @returns A token object with `id`.
      */
@@ -652,8 +1002,6 @@ interface JobQueue<PayloadMap> {
      * Complete a waitpoint token, resuming the associated waiting job.
      * Can be called from anywhere (API routes, external services, etc.).
      *
-     * **PostgreSQL backend only.** Throws if the backend is Redis.
-     *
      * @param tokenId - The ID of the token to complete.
      * @param data - Optional data to pass to the waiting handler.
      */
@@ -661,8 +1009,6 @@ interface JobQueue<PayloadMap> {
     /**
      * Retrieve a waitpoint token by its ID.
      *
-     * **PostgreSQL backend only.** Throws if the backend is Redis.
-     *
      * @param tokenId - The ID of the token to retrieve.
      * @returns The token record, or null if not found.
      */
@@ -671,11 +1017,89 @@ interface JobQueue<PayloadMap> {
      * Expire timed-out waitpoint tokens and resume their associated jobs.
      * Call this periodically (e.g., alongside `reclaimStuckJobs`).
      *
-     * **PostgreSQL backend only.** Throws if the backend is Redis.
-     *
      * @returns The number of tokens that were expired.
      */
     expireTimedOutTokens: () => Promise<number>;
+    /**
+     * Add a recurring cron schedule. The processor automatically enqueues
+     * due cron jobs before each batch, so no manual triggering is needed.
+     *
+     * @returns The ID of the created schedule.
+     * @throws If the cron expression is invalid or the schedule name is already taken.
+     */
+    addCronJob: <T extends JobType<PayloadMap>>(options: CronScheduleOptions<PayloadMap, T>) => Promise<number>;
+    /**
+     * Get a cron schedule by its ID.
+     */
+    getCronJob: (id: number) => Promise<CronScheduleRecord | null>;
+    /**
+     * Get a cron schedule by its unique name.
+     */
+    getCronJobByName: (name: string) => Promise<CronScheduleRecord | null>;
+    /**
+     * List all cron schedules, optionally filtered by status.
+     */
+    listCronJobs: (status?: CronScheduleStatus) => Promise<CronScheduleRecord[]>;
+    /**
+     * Remove a cron schedule by its ID. Does not cancel any already-enqueued jobs.
+     */
+    removeCronJob: (id: number) => Promise<void>;
+    /**
+     * Pause a cron schedule. Paused schedules are skipped by `enqueueDueCronJobs()`.
+     */
+    pauseCronJob: (id: number) => Promise<void>;
+    /**
+     * Resume a paused cron schedule.
+     */
+    resumeCronJob: (id: number) => Promise<void>;
+    /**
+     * Edit an existing cron schedule. Only provided fields are updated.
+     * If `cronExpression` or `timezone` changes, `nextRunAt` is recalculated.
+     */
+    editCronJob: (id: number, updates: EditCronScheduleOptions) => Promise<void>;
+    /**
+     * Check all active cron schedules and enqueue jobs for any whose
+     * `nextRunAt` has passed. When `allowOverlap` is false (the default),
+     * a new job is not enqueued if the previous instance is still
+     * pending, processing, or waiting.
+     *
+     * **Note:** The processor calls this automatically before each batch,
+     * so you typically do not need to call it yourself. It is exposed for
+     * manual use in tests or one-off scripts.
+     *
+     * @returns The number of jobs that were enqueued.
+     */
+    enqueueDueCronJobs: () => Promise<number>;
+    /**
+     * Register a listener for a queue event. The listener is called every
+     * time the event fires. Works identically with both PostgreSQL and Redis.
+     *
+     * @param event - The event name (e.g. `'job:completed'`, `'error'`).
+     * @param listener - Callback receiving the event payload.
+     */
+    on: <K extends QueueEventName>(event: K, listener: (data: QueueEventMap[K]) => void) => void;
+    /**
+     * Register a one-time listener. The listener is automatically removed
+     * after it fires once.
+     *
+     * @param event - The event name.
+     * @param listener - Callback receiving the event payload.
+     */
+    once: <K extends QueueEventName>(event: K, listener: (data: QueueEventMap[K]) => void) => void;
+    /**
+     * Remove a previously registered listener.
+     *
+     * @param event - The event name.
+     * @param listener - The exact function reference passed to `on` or `once`.
+     */
+    off: <K extends QueueEventName>(event: K, listener: (data: QueueEventMap[K]) => void) => void;
+    /**
+     * Remove all listeners for a specific event, or all listeners for
+     * all events when called without arguments.
+     *
+     * @param event - Optional event name. If omitted, removes everything.
+     */
+    removeAllListeners: (event?: QueueEventName) => void;
     /**
      * Get the PostgreSQL database pool.
      * Throws if the backend is not PostgreSQL.
@@ -722,6 +1146,30 @@ interface JobUpdates {
     runAt?: Date | null;
     timeoutMs?: number | null;
     tags?: string[] | null;
+    retryDelay?: number | null;
+    retryBackoff?: boolean | null;
+    retryDelayMax?: number | null;
+}
+/**
+ * Input shape for creating a cron schedule in the backend.
+ * This is the backend-level version of CronScheduleOptions.
+ */
+interface CronScheduleInput {
+    scheduleName: string;
+    cronExpression: string;
+    jobType: string;
+    payload: any;
+    maxAttempts: number;
+    priority: number;
+    timeoutMs: number | null;
+    forceKillOnTimeout: boolean;
+    tags: string[] | undefined;
+    timezone: string;
+    allowOverlap: boolean;
+    nextRunAt: Date | null;
+    retryDelay: number | null;
+    retryBackoff: boolean | null;
+    retryDelayMax: number | null;
 }
 /**
  * Abstract backend interface that both PostgreSQL and Redis implement.
@@ -729,8 +1177,26 @@ interface JobUpdates {
  * and public API are backend-agnostic.
  */
 interface QueueBackend {
-    /** Add a job and return its numeric ID. */
-    addJob<PayloadMap, T extends JobType<PayloadMap>>(job: JobOptions<PayloadMap, T>): Promise<number>;
+    /**
+     * Add a job and return its numeric ID.
+     *
+     * @param job - Job configuration.
+     * @param options - Optional. Pass `{ db }` to run the INSERT on an external
+     *   client (e.g., inside a transaction). PostgreSQL only.
+     */
+    addJob<PayloadMap, T extends JobType<PayloadMap>>(job: JobOptions<PayloadMap, T>, options?: AddJobOptions): Promise<number>;
+    /**
+     * Add multiple jobs in a single operation and return their IDs.
+     *
+     * IDs are returned in the same order as the input array.
+     * Each job may independently have an `idempotencyKey`; duplicates
+     * resolve to the existing job's ID without creating a new row.
+     *
+     * @param jobs - Array of job configurations.
+     * @param options - Optional. Pass `{ db }` to run the INSERTs on an external
+     *   client (e.g., inside a transaction). PostgreSQL only.
+     */
+    addJobs<PayloadMap, T extends JobType<PayloadMap>>(jobs: JobOptions<PayloadMap, T>[], options?: AddJobOptions): Promise<number[]>;
     /** Get a single job by ID, or null if not found. */
     getJob<PayloadMap, T extends JobType<PayloadMap>>(id: number): Promise<JobRecord<PayloadMap, T> | null>;
     /** Get jobs filtered by status, ordered by createdAt DESC. */
@@ -762,10 +1228,10 @@ interface QueueBackend {
     editJob(jobId: number, updates: JobUpdates): Promise<void>;
     /** Edit all pending jobs matching filters. Returns count. */
     editAllPendingJobs(filters: JobFilters | undefined, updates: JobUpdates): Promise<number>;
-    /** Delete completed jobs older than N days. Returns count deleted. */
-    cleanupOldJobs(daysToKeep?: number): Promise<number>;
-    /** Delete job events older than N days. Returns count deleted. */
-    cleanupOldJobEvents(daysToKeep?: number): Promise<number>;
+    /** Delete completed jobs older than N days. Deletes in batches for scale safety. Returns count deleted. */
+    cleanupOldJobs(daysToKeep?: number, batchSize?: number): Promise<number>;
+    /** Delete job events older than N days. Deletes in batches for scale safety. Returns count deleted. */
+    cleanupOldJobEvents(daysToKeep?: number, batchSize?: number): Promise<number>;
     /** Reclaim jobs stuck in 'processing' for too long. Returns count. */
     reclaimStuckJobs(maxProcessingTimeMinutes?: number): Promise<number>;
     /** Update the progress percentage (0-100) for a job. */
@@ -774,6 +1240,84 @@ interface QueueBackend {
     recordJobEvent(jobId: number, eventType: JobEventType, metadata?: any): Promise<void>;
     /** Get all events for a job, ordered by createdAt ASC. */
     getJobEvents(jobId: number): Promise<JobEvent[]>;
+    /** Create a cron schedule and return its ID. */
+    addCronSchedule(input: CronScheduleInput): Promise<number>;
+    /** Get a cron schedule by ID, or null if not found. */
+    getCronSchedule(id: number): Promise<CronScheduleRecord | null>;
+    /** Get a cron schedule by its unique name, or null if not found. */
+    getCronScheduleByName(name: string): Promise<CronScheduleRecord | null>;
+    /** List cron schedules, optionally filtered by status. */
+    listCronSchedules(status?: CronScheduleStatus): Promise<CronScheduleRecord[]>;
+    /** Delete a cron schedule by ID. */
+    removeCronSchedule(id: number): Promise<void>;
+    /** Pause a cron schedule. */
+    pauseCronSchedule(id: number): Promise<void>;
+    /** Resume a cron schedule. */
+    resumeCronSchedule(id: number): Promise<void>;
+    /** Edit a cron schedule. */
+    editCronSchedule(id: number, updates: EditCronScheduleOptions, nextRunAt?: Date | null): Promise<void>;
+    /**
+     * Atomically fetch all active cron schedules whose nextRunAt <= now.
+     * In PostgreSQL this uses FOR UPDATE SKIP LOCKED to prevent duplicate enqueuing.
+     */
+    getDueCronSchedules(): Promise<CronScheduleRecord[]>;
+    /**
+     * Update a cron schedule after a job has been enqueued.
+     * Sets lastEnqueuedAt, lastJobId, and advances nextRunAt.
+     */
+    updateCronScheduleAfterEnqueue(id: number, lastEnqueuedAt: Date, lastJobId: number, nextRunAt: Date | null): Promise<void>;
+    /**
+     * Transition a job from 'processing' to 'waiting' status.
+     * Persists step data so the handler can resume from where it left off.
+     *
+     * @param jobId - The job to pause.
+     * @param options - Wait configuration including optional waitUntil date, token ID, and step data.
+     */
+    waitJob(jobId: number, options: {
+        waitUntil?: Date;
+        waitTokenId?: string;
+        stepData: Record<string, any>;
+    }): Promise<void>;
+    /**
+     * Persist step data for a job. Called after each `ctx.run()` step completes
+     * to save intermediate progress. Best-effort: should not throw.
+     *
+     * @param jobId - The job to update.
+     * @param stepData - The step data to persist.
+     */
+    updateStepData(jobId: number, stepData: Record<string, any>): Promise<void>;
+    /**
+     * Create a waitpoint token that can pause a job until an external signal completes it.
+     *
+     * @param jobId - The job ID to associate with the token (null if created outside a handler).
+     * @param options - Optional timeout string (e.g. '10m', '1h') and tags.
+     * @returns The created waitpoint with its unique ID.
+     */
+    createWaitpoint(jobId: number | null, options?: CreateTokenOptions): Promise<{
+        id: string;
+    }>;
+    /**
+     * Complete a waitpoint token, optionally providing output data.
+     * Moves the associated job from 'waiting' back to 'pending' so it gets picked up.
+     *
+     * @param tokenId - The waitpoint token ID to complete.
+     * @param data - Optional data to pass to the waiting handler.
+     */
+    completeWaitpoint(tokenId: string, data?: any): Promise<void>;
+    /**
+     * Retrieve a waitpoint token by its ID.
+     *
+     * @param tokenId - The waitpoint token ID to look up.
+     * @returns The waitpoint record, or null if not found.
+     */
+    getWaitpoint(tokenId: string): Promise<WaitpointRecord | null>;
+    /**
+     * Expire timed-out waitpoint tokens and move their associated jobs back to 'pending'.
+     * Should be called periodically (e.g., alongside reclaimStuckJobs).
+     *
+     * @returns The number of tokens that were expired.
+     */
+    expireTimedOutWaitpoints(): Promise<number>;
     /** Set a pending reason for unpicked jobs of a given type. */
     setPendingReasonForUnpickedJobs(reason: string, jobType?: string | string[]): Promise<void>;
 }
@@ -785,7 +1329,22 @@ declare class PostgresBackend implements QueueBackend {
     getPool(): Pool;
     recordJobEvent(jobId: number, eventType: JobEventType, metadata?: any): Promise<void>;
     getJobEvents(jobId: number): Promise<JobEvent[]>;
-    addJob<PayloadMap, T extends JobType<PayloadMap>>({ jobType, payload, maxAttempts, priority, runAt, timeoutMs, forceKillOnTimeout, tags, idempotencyKey, }: JobOptions<PayloadMap, T>): Promise<number>;
+    /**
+     * Add a job and return its numeric ID.
+     *
+     * @param job - Job configuration.
+     * @param options - Optional. Pass `{ db }` to run the INSERT on an external
+     *   client (e.g., inside a transaction) so the job is part of the caller's
+     *   transaction. The event INSERT also uses the same client.
+     */
+    addJob<PayloadMap, T extends JobType<PayloadMap>>({ jobType, payload, maxAttempts, priority, runAt, timeoutMs, forceKillOnTimeout, tags, idempotencyKey, retryDelay, retryBackoff, retryDelayMax, }: JobOptions<PayloadMap, T>, options?: AddJobOptions): Promise<number>;
+    /**
+     * Insert multiple jobs in a single database round-trip.
+     *
+     * Uses a multi-row INSERT with ON CONFLICT handling for idempotency keys.
+     * Returns IDs in the same order as the input array.
+     */
+    addJobs<PayloadMap, T extends JobType<PayloadMap>>(jobs: JobOptions<PayloadMap, T>[], options?: AddJobOptions): Promise<number[]>;
     getJob<PayloadMap, T extends JobType<PayloadMap>>(id: number): Promise<JobRecord<PayloadMap, T> | null>;
     getJobsByStatus<PayloadMap, T extends JobType<PayloadMap>>(status: string, limit?: number, offset?: number): Promise<JobRecord<PayloadMap, T>[]>;
     getAllJobs<PayloadMap, T extends JobType<PayloadMap>>(limit?: number, offset?: number): Promise<JobRecord<PayloadMap, T>[]>;
@@ -801,14 +1360,108 @@ declare class PostgresBackend implements QueueBackend {
     cancelAllUpcomingJobs(filters?: JobFilters): Promise<number>;
     editJob(jobId: number, updates: JobUpdates): Promise<void>;
     editAllPendingJobs(filters: JobFilters | undefined, updates: JobUpdates): Promise<number>;
-    cleanupOldJobs(daysToKeep?: number): Promise<number>;
-    cleanupOldJobEvents(daysToKeep?: number): Promise<number>;
+    /**
+     * Delete completed jobs older than the given number of days.
+     * Deletes in batches of 1000 to avoid long-running transactions
+     * and excessive WAL bloat at scale.
+     *
+     * @param daysToKeep - Number of days to retain completed jobs (default 30).
+     * @param batchSize - Number of rows to delete per batch (default 1000).
+     * @returns Total number of deleted jobs.
+     */
+    cleanupOldJobs(daysToKeep?: number, batchSize?: number): Promise<number>;
+    /**
+     * Delete job events older than the given number of days.
+     * Deletes in batches of 1000 to avoid long-running transactions
+     * and excessive WAL bloat at scale.
+     *
+     * @param daysToKeep - Number of days to retain events (default 30).
+     * @param batchSize - Number of rows to delete per batch (default 1000).
+     * @returns Total number of deleted events.
+     */
+    cleanupOldJobEvents(daysToKeep?: number, batchSize?: number): Promise<number>;
     reclaimStuckJobs(maxProcessingTimeMinutes?: number): Promise<number>;
     /**
      * Batch-insert multiple job events in a single query.
      * More efficient than individual recordJobEvent calls.
      */
     private recordJobEventsBatch;
+    /** Create a cron schedule and return its ID. */
+    addCronSchedule(input: CronScheduleInput): Promise<number>;
+    /** Get a cron schedule by ID. */
+    getCronSchedule(id: number): Promise<CronScheduleRecord | null>;
+    /** Get a cron schedule by its unique name. */
+    getCronScheduleByName(name: string): Promise<CronScheduleRecord | null>;
+    /** List cron schedules, optionally filtered by status. */
+    listCronSchedules(status?: CronScheduleStatus): Promise<CronScheduleRecord[]>;
+    /** Delete a cron schedule by ID. */
+    removeCronSchedule(id: number): Promise<void>;
+    /** Pause a cron schedule. */
+    pauseCronSchedule(id: number): Promise<void>;
+    /** Resume a paused cron schedule. */
+    resumeCronSchedule(id: number): Promise<void>;
+    /** Edit a cron schedule. */
+    editCronSchedule(id: number, updates: EditCronScheduleOptions, nextRunAt?: Date | null): Promise<void>;
+    /**
+     * Atomically fetch all active cron schedules whose nextRunAt <= NOW().
+     * Uses FOR UPDATE SKIP LOCKED to prevent duplicate enqueuing across workers.
+     */
+    getDueCronSchedules(): Promise<CronScheduleRecord[]>;
+    /**
+     * Update a cron schedule after a job has been enqueued.
+     * Sets lastEnqueuedAt, lastJobId, and advances nextRunAt.
+     */
+    updateCronScheduleAfterEnqueue(id: number, lastEnqueuedAt: Date, lastJobId: number, nextRunAt: Date | null): Promise<void>;
+    /**
+     * Transition a job from 'processing' to 'waiting' status.
+     * Persists step data so the handler can resume from where it left off.
+     *
+     * @param jobId - The job to pause.
+     * @param options - Wait configuration including optional waitUntil date, token ID, and step data.
+     */
+    waitJob(jobId: number, options: {
+        waitUntil?: Date;
+        waitTokenId?: string;
+        stepData: Record<string, any>;
+    }): Promise<void>;
+    /**
+     * Persist step data for a job. Called after each ctx.run() step completes.
+     * Best-effort: does not throw to avoid killing the running handler.
+     *
+     * @param jobId - The job to update.
+     * @param stepData - The step data to persist.
+     */
+    updateStepData(jobId: number, stepData: Record<string, any>): Promise<void>;
+    /**
+     * Create a waitpoint token in the database.
+     *
+     * @param jobId - The job ID to associate with the token (null if created outside a handler).
+     * @param options - Optional timeout string (e.g. '10m', '1h') and tags.
+     * @returns The created waitpoint with its unique ID.
+     */
+    createWaitpoint(jobId: number | null, options?: CreateTokenOptions): Promise<{
+        id: string;
+    }>;
+    /**
+     * Complete a waitpoint token and move the associated job back to 'pending'.
+     *
+     * @param tokenId - The waitpoint token ID to complete.
+     * @param data - Optional data to pass to the waiting handler.
+     */
+    completeWaitpoint(tokenId: string, data?: any): Promise<void>;
+    /**
+     * Retrieve a waitpoint token by its ID.
+     *
+     * @param tokenId - The waitpoint token ID to look up.
+     * @returns The waitpoint record, or null if not found.
+     */
+    getWaitpoint(tokenId: string): Promise<WaitpointRecord | null>;
+    /**
+     * Expire timed-out waitpoint tokens and move their associated jobs back to 'pending'.
+     *
+     * @returns The number of tokens that were expired.
+     */
+    expireTimedOutWaitpoints(): Promise<number>;
     setPendingReasonForUnpickedJobs(reason: string, jobType?: string | string[]): Promise<void>;
 }
 
@@ -863,11 +1516,32 @@ declare function testHandlerSerialization<PayloadMap, T extends keyof PayloadMap
     error?: string;
 }>;
 
+/**
+ * Calculate the next occurrence of a cron expression after a given date.
+ *
+ * @param cronExpression - A standard cron expression (5 fields, e.g. "0 * * * *").
+ * @param timezone - IANA timezone string (default: "UTC").
+ * @param after - The reference date to compute the next run from (default: now).
+ * @param CronImpl - Cron class for dependency injection (default: croner's Cron).
+ * @returns The next occurrence as a Date, or null if the expression will never fire again.
+ */
+declare function getNextCronOccurrence(cronExpression: string, timezone?: string, after?: Date, CronImpl?: typeof Cron): Date | null;
+/**
+ * Validate whether a string is a syntactically correct cron expression.
+ *
+ * @param cronExpression - The cron expression to validate.
+ * @param CronImpl - Cron class for dependency injection (default: croner's Cron).
+ * @returns True if the expression is valid, false otherwise.
+ */
+declare function validateCronExpression(cronExpression: string, CronImpl?: typeof Cron): boolean;
+
 /**
  * Initialize the job queue system.
  *
  * Defaults to PostgreSQL when `backend` is omitted.
+ * For PostgreSQL, provide either `databaseConfig` or `pool` (bring your own).
+ * For Redis, provide either `redisConfig` or `client` (bring your own).
  */
 declare const initJobQueue: <PayloadMap = any>(config: JobQueueConfig) => JobQueue<PayloadMap>;
 
-export { type CreateTokenOptions, type DatabaseSSLConfig, type EditJobOptions, FailureReason, type JobContext, type JobEvent, JobEventType, type JobHandler, type JobHandlers, type JobOptions, type JobQueue, type JobQueueConfig, type JobQueueConfigLegacy, type JobRecord, type JobStatus, type JobType, type OnTimeoutCallback, PostgresBackend, type PostgresJobQueueConfig, type Processor, type ProcessorOptions, type QueueBackend, type RedisJobQueueConfig, type RedisTLSConfig, type TagQueryMode, type WaitDuration, WaitSignal, type WaitToken, type WaitTokenResult, type WaitpointRecord, type WaitpointStatus, initJobQueue, testHandlerSerialization, validateHandlerSerializable };
+export { type AddJobOptions, type CreateTokenOptions, type CronScheduleInput, type CronScheduleOptions, type CronScheduleRecord, type CronScheduleStatus, type DatabaseClient, type DatabaseSSLConfig, type EditCronScheduleOptions, type EditJobOptions, FailureReason, type JobContext, type JobEvent, JobEventType, type JobHandler, type JobHandlers, type JobOptions, type JobQueue, type JobQueueConfig, type JobQueueConfigLegacy, type JobRecord, type JobStatus, type JobType, type OnTimeoutCallback, PostgresBackend, type PostgresJobQueueConfig, type Processor, type ProcessorOptions, type QueueBackend, type QueueEmitFn, type QueueEventMap, type QueueEventName, type RedisJobQueueConfig, type RedisTLSConfig, type Supervisor, type SupervisorOptions, type SupervisorRunResult, type TagQueryMode, type WaitDuration, WaitSignal, type WaitToken, type WaitTokenResult, type WaitpointRecord, type WaitpointStatus, getNextCronOccurrence, initJobQueue, testHandlerSerialization, validateCronExpression, validateHandlerSerializable };