queue-jobs-worker 1.0.4 → 2.0.0

package/dist/core/queue.d.ts

@@ -1,70 +0,0 @@
-/**
- * Queue
- *
- * Represents an independent stream of jobs.  Applications use a Queue to:
- *  - Enqueue jobs (with optional scheduling, priority, retry config).
- *  - Register processors for job types.
- *  - Create workers that consume jobs from this queue.
- *  - Query job state and counts.
- *
- * Queue-level configuration overrides client defaults.
- * Job-level options override queue configuration where applicable.
- */
-import type { StorageAdapter } from "../types/storage.types.js";
-import type { JobOptions, JobStatus } from "../types/job.types.js";
-import type { QueueOptions } from "../types/queue.types.js";
-import type { WorkerOptions, Processor } from "../types/worker.types.js";
-import type { ClientDefaults } from "../types/client.types.js";
-import { Job } from "./job.js";
-import { Worker } from "./worker.js";
-import type { QueueEventEmitter } from "../events/emitter.js";
-type ResolvedDefaults = Required<ClientDefaults>;
-export declare class Queue<TPayload = unknown> {
-    /** The name of this queue — unique within a QueueClient. */
-    readonly name: string;
-    private readonly storage;
-    private readonly emitter;
-    private readonly resolvedConfig;
-    private readonly clientDefaults;
-    /** Registered processors keyed by job type. */
-    private readonly processors;
-    /** Active worker instances created by this queue. */
-    private readonly workers;
-    constructor(name: string, storage: StorageAdapter, emitter: QueueEventEmitter, options: QueueOptions | undefined, defaults: ResolvedDefaults);
-    /**
-     * Add a new job to the queue.
-     *
-     * @param type    - Job type string, must match a registered processor.
-     * @param payload - Arbitrary serialisable payload (never logged by default).
-     * @param options - Per-job overrides (attempts, delay, priority, etc.).
-     */
-    enqueue(type: string, payload: TPayload, options?: JobOptions): Promise<Job<TPayload>>;
-    /**
-     * Register a processor function for a given job type.
-     *
-     * Only one processor per type per queue is supported.
-     * Registering a second processor for the same type replaces the first.
-     */
-    process<P = TPayload>(type: string, processor: Processor<P>): void;
-    /**
-     * Create and start a Worker that consumes jobs from this queue.
-     *
-     * Worker-level `concurrency` overrides queue-level concurrency.
-     */
-    createWorker(options?: WorkerOptions): Worker;
-    /** Fetch a single job by its ID. Returns null if not found or wrong queue. */
-    getJob(jobId: string): Promise<Job<TPayload> | null>;
-    /** Fetch jobs from this queue, optionally filtered by status. */
-    getJobs(status?: JobStatus, limit?: number, offset?: number): Promise<Job<TPayload>[]>;
-    /** Get job counts by status for this queue. */
-    getJobCounts(): Promise<Record<JobStatus, number>>;
-    /**
-     * Gracefully stop all workers attached to this queue.
-     * Called automatically by QueueClient.close().
-     */
-    close(): Promise<void>;
-    /** Return all active worker instances on this queue. */
-    getWorkers(): readonly Worker[];
-}
-export {};
-//# sourceMappingURL=queue.d.ts.map

package/dist/core/queue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"queue.d.ts","sourceRoot":"","sources":["../../src/core/queue.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACzE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAE9D,KAAK,gBAAgB,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC;AA2BjD,qBAAa,KAAK,CAAC,QAAQ,GAAG,OAAO;IACnC,4DAA4D;IAC5D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAiB;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;IAC5C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAyB;IACxD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAmB;IAElD,+CAA+C;IAC/C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAyC;IAEpE,qDAAqD;IACrD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAgB;gBAGtC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,cAAc,EACvB,OAAO,EAAE,iBAAiB,EAC1B,OAAO,EAAE,YAAY,GAAG,SAAS,EACjC,QAAQ,EAAE,gBAAgB;IAa5B;;;;;;OAMG;IACG,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAqC5F;;;;;OAKG;IACH,OAAO,CAAC,CAAC,GAAG,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI;IAQlE;;;;OAIG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,MAAM;IAoB7C,8EAA8E;IACxE,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAM1D,iEAAiE;IAC3D,OAAO,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,KAAK,SAAM,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;IAUpF,+CAA+C;IACzC,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAQxD;;;OAGG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B,wDAAwD;IACxD,UAAU,IAAI,SAAS,MAAM,EAAE;CAGhC"}

package/dist/core/worker.d.ts

@@ -1,65 +0,0 @@
-/**
- * Worker
- *
- * Claims jobs from a queue and executes registered processors concurrently.
- *
- * Key guarantees:
- *  - At-most `concurrency` jobs run simultaneously.
- *  - Job claiming is delegated to the storage adapter's atomic `claim()` call.
- *  - Failed jobs are requeued (with backoff) or moved to the DLQ.
- *  - Stalled jobs (expired locks from crashed workers) are recovered
- *    periodically.
- *  - Graceful shutdown: stop claiming, wait for active jobs, release any
- *    locks that could not be finished within shutdownTimeout.
- *  - Cron jobs: re-enqueued immediately after each successful execution.
- */
-import type { StorageAdapter } from "../types/storage.types.js";
-import type { WorkerOptions, WorkerStatus, Processor } from "../types/worker.types.js";
-import type { QueueOptions } from "../types/queue.types.js";
-import type { ClientDefaults } from "../types/client.types.js";
-import type { QueueEventEmitter } from "../events/emitter.js";
-type ResolvedDefaults = Required<ClientDefaults>;
-export declare class Worker {
-    /** Unique identifier for this worker instance. */
-    readonly id: string;
-    private readonly queueName;
-    private readonly storage;
-    private readonly emitter;
-    private readonly processors;
-    private readonly config;
-    private _status;
-    private activeCount;
-    /**
-     * Tracks job IDs currently being processed so we can release their locks
-     * when graceful shutdown times out before they finish.
-     */
-    private readonly activeJobIds;
-    private pollTimer;
-    private stalledTimer;
-    /** Resolves when all active jobs finish during shutdown. */
-    private drainResolve;
-    constructor(queueName: string, storage: StorageAdapter, emitter: QueueEventEmitter, processors: Map<string, Processor<unknown>>, workerOptions: WorkerOptions, queueOptions: QueueOptions, defaults: ResolvedDefaults);
-    get status(): WorkerStatus;
-    /** Start polling for jobs. */
-    start(): void;
-    /**
-     * Gracefully stop the worker.
-     *
-     * 1. Stop accepting new jobs.
-     * 2. Wait up to `shutdownTimeout` ms for active jobs to finish.
-     * 3. Release locks on any jobs that did not finish in time so another
-     *    worker can reclaim them.
-     * 4. Emit stopped event.
-     */
-    stop(): Promise<void>;
-    private schedulePoll;
-    private poll;
-    private claimNext;
-    private executeJob;
-    private enqueueCronNext;
-    private handleFailure;
-    private scheduleStallCheck;
-    private recoverStalledJobs;
-}
-export {};
-//# sourceMappingURL=worker.d.ts.map

package/dist/core/worker.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"worker.d.ts","sourceRoot":"","sources":["../../src/core/worker.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAIH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACvF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAI/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAE9D,KAAK,gBAAgB,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC;AAyBjD,qBAAa,MAAM;IACjB,kDAAkD;IAClD,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAiB;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;IAC5C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAkC;IAC7D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmC;IAE1D,OAAO,CAAC,OAAO,CAAwB;IACvC,OAAO,CAAC,WAAW,CAAK;IAExB;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAElD,OAAO,CAAC,SAAS,CAA+B;IAChD,OAAO,CAAC,YAAY,CAA+B;IAEnD,4DAA4D;IAC5D,OAAO,CAAC,YAAY,CAA6B;gBAG/C,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,cAAc,EACvB,OAAO,EAAE,iBAAiB,EAC1B,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC,EAC3C,aAAa,EAAE,aAAa,EAC5B,YAAY,EAAE,YAAY,EAC1B,QAAQ,EAAE,gBAAgB;IAc5B,IAAI,MAAM,IAAI,YAAY,CAEzB;IAED,8BAA8B;IAC9B,KAAK,IAAI,IAAI;IAab;;;;;;;;OAQG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAqD3B,OAAO,CAAC,YAAY;YAQN,IAAI;YAsBJ,SAAS;YAyCT,UAAU;YAqFV,eAAe;YA4Df,aAAa;IA4C3B,OAAO,CAAC,kBAAkB;YAQZ,kBAAkB;CAkBjC"}

package/dist/events/emitter.d.ts

@@ -1,24 +0,0 @@
-/**
- * QueueEventEmitter
- *
- * A strongly-typed, lightweight event emitter built on top of Node.js
- * EventEmitter.  All queue/worker/job lifecycle events flow through here.
- *
- * Using typed generics ensures that each event name maps to its exact
- * argument tuple — no runtime guessing.
- */
-import type { QueueEvents } from "../types/events.types.js";
-type EventKey = keyof QueueEvents;
-type EventArgs<K extends EventKey> = QueueEvents[K];
-export declare class QueueEventEmitter {
-    private readonly emitter;
-    constructor();
-    on<K extends EventKey>(event: K, listener: (...args: EventArgs<K>) => void): this;
-    once<K extends EventKey>(event: K, listener: (...args: EventArgs<K>) => void): this;
-    off<K extends EventKey>(event: K, listener: (...args: EventArgs<K>) => void): this;
-    emit<K extends EventKey>(event: K, ...args: EventArgs<K>): boolean;
-    removeAllListeners(event?: EventKey): this;
-    listenerCount(event: EventKey): number;
-}
-export {};
-//# sourceMappingURL=emitter.d.ts.map

package/dist/events/emitter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"emitter.d.ts","sourceRoot":"","sources":["../../src/events/emitter.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAGH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAM5D,KAAK,QAAQ,GAAG,MAAM,WAAW,CAAC;AAClC,KAAK,SAAS,CAAC,CAAC,SAAS,QAAQ,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;AAEpD,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;;IAavC,EAAE,CAAC,CAAC,SAAS,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,IAAI;IAKjF,IAAI,CAAC,CAAC,SAAS,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,IAAI;IAKnF,GAAG,CAAC,CAAC,SAAS,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,IAAI;IASlF,IAAI,CAAC,CAAC,SAAS,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,OAAO;IAQlE,kBAAkB,CAAC,KAAK,CAAC,EAAE,QAAQ,GAAG,IAAI;IAS1C,aAAa,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM;CAGvC"}