@nage-api/queue 1.0.0-beta.2

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,144 @@
+# @nage-api/queue
+
+Typed background jobs (PLAN.md §8, §25 P2).
+
+The `Job` contract is retained from the legacy framework so migrating is a
+driver swap rather than a rewrite of every consumer (§26). What changes is that
+both ends now share a type:
+
+<!-- docs-example: fragment -->
+
+```ts
+import type { QueueService } from '@nage-api/queue';
+
+// A `type`, not an `interface`: an interface has to say `extends QueueJobMap` to
+// satisfy the constraint, and inheriting that index signature widens `keyof` to
+// `string` — which silently stops the job *name* from being checked at all.
+type Jobs = {
+  'email.welcome': { userId: string };
+  'report.build': { month: string };
+};
+
+declare const queue: QueueService<Jobs>;
+declare const userId: string;
+declare function sendWelcomeEmail(id: string, attempt: number): Promise<void>;
+
+await queue.enqueue('email.welcome', { userId }); // name and payload both checked
+
+queue.process('email.welcome', async ({ job, attempt }) => {
+  await sendWelcomeEmail(job.payload.userId, attempt);
+});
+```
+
+The legacy bus passed `any` in both directions, so a renamed field was a runtime
+failure in a worker nobody was watching.
+
+## Wiring it up
+
+The feature is off unless `queue.enabled` is `true`, and registering the module
+publishes a publisher, not a worker: **nothing consumes until something calls
+`start()`**, and the driver `forRoot` builds has no poll timer of its own. A
+process that is meant to run jobs supplies a driver with an interval and starts
+it.
+
+```ts
+import { Injectable, Module, type OnApplicationBootstrap } from '@nestjs/common';
+import {
+  MemoryJobLogStore,
+  MemoryQueueDriver,
+  NageQueueModule,
+  QueueService,
+} from '@nage-api/queue';
+import type { NodeEnvironment } from '@nage-api/contracts';
+
+type Jobs = {
+  'email.welcome': { userId: string };
+};
+
+declare const env: { NODE_ENV: NodeEnvironment };
+declare function sendWelcomeEmail(userId: string): Promise<void>;
+
+// One store, given to both: `forRoot` publishes the log store for readers, but a
+// driver you construct yourself is never handed it, so nothing would write.
+const jobLogs = new MemoryJobLogStore();
+
+@Injectable()
+export class EmailWorker implements OnApplicationBootstrap {
+  // The provider is the bare class, so the job map is a compile-time view of it.
+  constructor(private readonly queue: QueueService<Jobs>) {}
+
+  async onApplicationBootstrap(): Promise<void> {
+    // Register before starting: a job whose name has no handler is dead on
+    // arrival, not queued until one appears.
+    this.queue.process('email.welcome', async ({ job }) => {
+      await sendWelcomeEmail(job.payload.userId);
+    });
+
+    await this.queue.start();
+  }
+}
+
+@Module({
+  imports: [
+    NageQueueModule.forRoot({
+      queue: { enabled: true, jobLogs: true },
+      // Passed so the module can refuse a driver that loses jobs on restart.
+      environment: env.NODE_ENV,
+      logs: jobLogs,
+      driver: new MemoryQueueDriver({ concurrency: 4, pollIntervalMs: 250, logs: jobLogs }),
+    }),
+  ],
+  providers: [EmailWorker],
+})
+export class WorkerModule {}
+```
+
+`onApplicationShutdown` drains whatever the module started, so `SIGTERM` does not
+abandon a job that had already been taken.
+
+## What the driver guarantees
+
+**Retries with jittered exponential backoff.** The jitter is the point: a batch
+of jobs that failed together at the same instant will otherwise retry together,
+and the dependency they were waiting on goes down again.
+
+**A dead-letter state.** A job that exhausts its attempts becomes `dead` and
+fires `onDead`, rather than vanishing or retrying forever. A job with no
+registered handler is dead immediately — retrying would burn the attempts, and
+dropping it silently would hide a deployment mistake.
+
+**De-duplication by key**, while the first is still pending. That is what makes
+an at-least-once queue tolerable for "send the welcome email".
+
+**The correlation id travels with the job.** A job is usually the tail of a
+request, and losing the id at the queue boundary is where a trace stops being
+useful.
+
+**Graceful drain on shutdown**, so a worker does not exit mid-job.
+
+## Job logs
+
+Opt-in (`queue.jobLogs`). Each transition records state, attempt, duration and
+the failure message — but never the payload, which may carry personal data and
+would outlive the job by months.
+
+## Drivers
+
+`MemoryQueueDriver` is a real implementation, not a stub: retries, delays,
+de-duplication, concurrency and drain all behave the way the BullMQ adapter
+must, which makes it the executable specification of the port. It is driven by
+an explicit `tick()`/`drain()` as well as a timer, so tests advance it
+deterministically instead of sleeping.
+
+It is not durable, so the module **refuses to use it in production** — the
+failure otherwise presents as "some emails were never sent", weeks later, with
+nothing in the logs.
+
+## Not yet implemented
+
+- The BullMQ driver itself (§27.5). `QueueDriver` is the seam; the application
+  constructs BullMQ and passes it in, so ioredis stays out of the install for
+  deployments that run no workers.
+- Repeatable/cron jobs, priorities, and `JobContext.progress` reporting — the
+  hook exists and the memory driver ignores it.
+- A queue-depth gauge wired to `@nage-api/observability`.

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * `@nage-api/queue` — typed background jobs (PLAN.md §8, §25 P2).
+ *
+ * The `Job` contract is retained from the legacy framework so migrating is a
+ * driver swap rather than a rewrite of every consumer (§26); what changes is
+ * that both ends of the queue now share a type.
+ */
+export type * from '@nage-api/contracts';
+export { NageQueueModule, type NageQueueModuleOptions } from './queue.module.js';
+export { QueueService } from './queue.service.js';
+export { DEFAULT_RETRY_POLICY, MemoryJobLogStore, MemoryQueueDriver, backoffFor, type MemoryQueueDriverOptions, } from './memory.driver.js';
+export { NAGE_JOB_LOGS, NAGE_QUEUE, NAGE_QUEUE_DRIVER } from './tokens.js';
+export { systemClock, type Clock, type EnqueueOptions, type JobContext, type JobHandler, type JobHandlers, type JobLog, type JobLogStore, type JobState, type QueueDriver, type RetryPolicy, } from './ports.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,26 @@
+"use strict";
+/**
+ * `@nage-api/queue` — typed background jobs (PLAN.md §8, §25 P2).
+ *
+ * The `Job` contract is retained from the legacy framework so migrating is a
+ * driver swap rather than a rewrite of every consumer (§26); what changes is
+ * that both ends of the queue now share a type.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.systemClock = exports.NAGE_QUEUE_DRIVER = exports.NAGE_QUEUE = exports.NAGE_JOB_LOGS = exports.backoffFor = exports.MemoryQueueDriver = exports.MemoryJobLogStore = exports.DEFAULT_RETRY_POLICY = exports.QueueService = exports.NageQueueModule = void 0;
+var queue_module_js_1 = require("./queue.module.js");
+Object.defineProperty(exports, "NageQueueModule", { enumerable: true, get: function () { return queue_module_js_1.NageQueueModule; } });
+var queue_service_js_1 = require("./queue.service.js");
+Object.defineProperty(exports, "QueueService", { enumerable: true, get: function () { return queue_service_js_1.QueueService; } });
+var memory_driver_js_1 = require("./memory.driver.js");
+Object.defineProperty(exports, "DEFAULT_RETRY_POLICY", { enumerable: true, get: function () { return memory_driver_js_1.DEFAULT_RETRY_POLICY; } });
+Object.defineProperty(exports, "MemoryJobLogStore", { enumerable: true, get: function () { return memory_driver_js_1.MemoryJobLogStore; } });
+Object.defineProperty(exports, "MemoryQueueDriver", { enumerable: true, get: function () { return memory_driver_js_1.MemoryQueueDriver; } });
+Object.defineProperty(exports, "backoffFor", { enumerable: true, get: function () { return memory_driver_js_1.backoffFor; } });
+var tokens_js_1 = require("./tokens.js");
+Object.defineProperty(exports, "NAGE_JOB_LOGS", { enumerable: true, get: function () { return tokens_js_1.NAGE_JOB_LOGS; } });
+Object.defineProperty(exports, "NAGE_QUEUE", { enumerable: true, get: function () { return tokens_js_1.NAGE_QUEUE; } });
+Object.defineProperty(exports, "NAGE_QUEUE_DRIVER", { enumerable: true, get: function () { return tokens_js_1.NAGE_QUEUE_DRIVER; } });
+var ports_js_1 = require("./ports.js");
+Object.defineProperty(exports, "systemClock", { enumerable: true, get: function () { return ports_js_1.systemClock; } });
+//# sourceMappingURL=index.js.map

package/dist/memory.driver.d.ts

@@ -0,0 +1,75 @@
+/**
+ * An in-process queue: the default driver, and the one the tests use.
+ *
+ * It is a real implementation, not a stub — retries with exponential backoff
+ * and jitter, delayed jobs, de-duplication, a dead-letter state, bounded
+ * concurrency and graceful drain all behave the way the BullMQ adapter must.
+ * That is what makes it useful as the executable specification of the port.
+ *
+ * What it is not is durable. A restart loses every pending job, so the module
+ * refuses to use it in production — the failure mode otherwise is "some emails
+ * were never sent" discovered weeks later.
+ *
+ * The loop is driven by an explicit `tick()` as well as a timer, so a test can
+ * advance the queue deterministically rather than sleeping.
+ */
+import type { QueueJob } from '@nage-api/contracts';
+import type { Clock, EnqueueOptions, JobHandler, JobLog, JobLogStore, JobState, QueueDriver, RetryPolicy } from './ports.js';
+export declare const DEFAULT_RETRY_POLICY: RetryPolicy;
+export interface MemoryQueueDriverOptions {
+    /** Jobs run at once. */
+    readonly concurrency?: number;
+    /** Poll interval for delayed work. `0` leaves the queue tick-driven. */
+    readonly pollIntervalMs?: number;
+    readonly clock?: Clock;
+    readonly logs?: JobLogStore;
+    readonly defaultRetry?: Partial<RetryPolicy>;
+    /** Called when a job exhausts its attempts. */
+    readonly onDead?: (log: JobLog) => void;
+}
+export declare class MemoryQueueDriver implements QueueDriver {
+    #private;
+    readonly name = "memory";
+    constructor(options?: MemoryQueueDriverOptions);
+    enqueue<TName extends string, TPayload>(job: QueueJob<TName, TPayload>, options?: EnqueueOptions): Promise<string>;
+    process<TName extends string, TPayload>(name: TName, handler: JobHandler<TName, TPayload>): void;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    /**
+     * Run whatever is due now.
+     *
+     * @returns how many jobs were executed
+     */
+    tick(): Promise<number>;
+    /** Run until nothing is due; the deterministic way to drive the queue. */
+    drain(maxRounds?: number): Promise<number>;
+    depth(name?: string): Promise<number>;
+    /** Every job the driver still holds. Tests and diagnostics only. */
+    get jobs(): readonly {
+        id: string;
+        name: string;
+        state: JobState;
+        attempt: number;
+    }[];
+}
+/**
+ * Exponential backoff with jitter, bounded by `maxBackoffMs`.
+ *
+ * The jitter is the point. A batch of jobs that failed together at the same
+ * instant will otherwise retry together, and the recovering dependency they
+ * were waiting on goes down again.
+ */
+export declare function backoffFor(attempt: number, policy: RetryPolicy): number;
+/** In-memory job logs; a real deployment records them in its database. */
+export declare class MemoryJobLogStore implements JobLogStore {
+    #private;
+    record(log: JobLog): Promise<void>;
+    find(id: string): Promise<JobLog | undefined>;
+    list(filter?: {
+        name?: string;
+        state?: JobState;
+    }): Promise<readonly JobLog[]>;
+    /** Every recorded transition, in order. Tests only. */
+    get history(): readonly JobLog[];
+}
+//# sourceMappingURL=memory.driver.d.ts.map

package/dist/memory.driver.js

@@ -0,0 +1,281 @@
+"use strict";
+/**
+ * An in-process queue: the default driver, and the one the tests use.
+ *
+ * It is a real implementation, not a stub — retries with exponential backoff
+ * and jitter, delayed jobs, de-duplication, a dead-letter state, bounded
+ * concurrency and graceful drain all behave the way the BullMQ adapter must.
+ * That is what makes it useful as the executable specification of the port.
+ *
+ * What it is not is durable. A restart loses every pending job, so the module
+ * refuses to use it in production — the failure mode otherwise is "some emails
+ * were never sent" discovered weeks later.
+ *
+ * The loop is driven by an explicit `tick()` as well as a timer, so a test can
+ * advance the queue deterministically rather than sleeping.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MemoryJobLogStore = exports.MemoryQueueDriver = exports.DEFAULT_RETRY_POLICY = void 0;
+exports.backoffFor = backoffFor;
+const core_1 = require("@nage-api/core");
+exports.DEFAULT_RETRY_POLICY = {
+    maxAttempts: 3,
+    backoffMs: 1000,
+    maxBackoffMs: 60_000,
+    jitter: 0.2,
+};
+class MemoryQueueDriver {
+    name = 'memory';
+    #jobs = new Map();
+    #handlers = new Map();
+    #byKey = new Map();
+    #concurrency;
+    #pollIntervalMs;
+    #clock;
+    #logs;
+    #defaultRetry;
+    #onDead;
+    /**
+     * Runs a poll tick started but has not finished.
+     *
+     * The timer cannot await its own tick, so without this handle `stop()` has
+     * nothing to wait on: an executing job is `active` rather than `pending`, so
+     * draining walks straight past it and shutdown abandons work it had taken.
+     */
+    #inFlight = new Set();
+    #running = false;
+    #active = 0;
+    #timer;
+    constructor(options = {}) {
+        // Clamped rather than trusted: a configured `0` used to be absorbed by the
+        // batch size, and the alternative now — a capacity of zero — would wedge
+        // the queue silently, which is the worse of the two failures.
+        this.#concurrency = Math.max(1, options.concurrency ?? 1);
+        this.#pollIntervalMs = options.pollIntervalMs ?? 0;
+        this.#clock = options.clock ?? { now: () => Date.now() };
+        this.#logs = options.logs;
+        this.#defaultRetry = { ...exports.DEFAULT_RETRY_POLICY, ...options.defaultRetry };
+        this.#onDead = options.onDead;
+    }
+    async enqueue(job, options = {}) {
+        await Promise.resolve();
+        if (options.key !== undefined) {
+            const existing = this.#byKey.get(options.key);
+            const pending = existing === undefined ? undefined : this.#jobs.get(existing);
+            // De-duplication only applies while the first is still waiting: once it
+            // has run, the same key should be able to schedule new work.
+            if (pending !== undefined && (pending.state === 'pending' || pending.state === 'active')) {
+                return pending.id;
+            }
+        }
+        const now = this.#clock.now();
+        const id = (0, core_1.randomId)();
+        const queued = {
+            id,
+            job,
+            retry: { ...this.#defaultRetry, ...options.retry },
+            key: options.key,
+            enqueuedAt: now,
+            runAt: now + (options.delayMs ?? 0),
+            attempt: 0,
+            state: 'pending',
+        };
+        this.#jobs.set(id, queued);
+        if (options.key !== undefined)
+            this.#byKey.set(options.key, id);
+        await this.#log(queued, 'pending');
+        return id;
+    }
+    process(name, handler) {
+        this.#handlers.set(name, handler);
+    }
+    async start() {
+        await Promise.resolve();
+        if (this.#running)
+            return;
+        this.#running = true;
+        if (this.#pollIntervalMs > 0) {
+            this.#timer = setInterval(() => void this.tick(), this.#pollIntervalMs);
+            // A worker's poll timer must not keep a CLI or a test runner alive.
+            this.#timer.unref();
+        }
+    }
+    async stop() {
+        this.#running = false;
+        if (this.#timer !== undefined) {
+            clearInterval(this.#timer);
+            this.#timer = undefined;
+        }
+        // Let in-flight work finish rather than abandoning it half-done. Draining
+        // alone does not do that: a job a poll tick already took is `active`, so
+        // `#due()` excludes it and shutdown would return mid-handler.
+        await Promise.all([...this.#inFlight]);
+        await this.drain();
+    }
+    /**
+     * Run whatever is due now.
+     *
+     * @returns how many jobs were executed
+     */
+    async tick() {
+        const due = this.#due();
+        if (due.length === 0)
+            return 0;
+        // Free slots only. Admitting one job regardless — which is what a
+        // `Math.max(1, …)` batch size did — breaks the cap as soon as ticks
+        // overlap, and under the poll timer they always do: the timer fires again
+        // while the previous tick's handlers are still running, so every poll added
+        // another job on top of a queue that was already at capacity.
+        const capacity = this.#concurrency - this.#active;
+        if (capacity <= 0)
+            return 0;
+        const batch = due.slice(0, capacity);
+        await Promise.all(batch.map((queued) => this.#track(this.#run(queued))));
+        return batch.length;
+    }
+    /** Run until nothing is due; the deterministic way to drive the queue. */
+    async drain(maxRounds = 1000) {
+        let executed = 0;
+        for (let round = 0; round < maxRounds; round += 1) {
+            const ran = await this.tick();
+            if (ran === 0)
+                break;
+            executed += ran;
+        }
+        return executed;
+    }
+    async depth(name) {
+        await Promise.resolve();
+        return [...this.#jobs.values()].filter((queued) => queued.state === 'pending' && (name === undefined || queued.job.name === name)).length;
+    }
+    /** Every job the driver still holds. Tests and diagnostics only. */
+    get jobs() {
+        return [...this.#jobs.values()].map((queued) => ({
+            id: queued.id,
+            name: queued.job.name,
+            state: queued.state,
+            attempt: queued.attempt,
+        }));
+    }
+    /** Hold a run so `stop()` can wait for it, and release it when it settles. */
+    #track(work) {
+        this.#inFlight.add(work);
+        return work.finally(() => {
+            this.#inFlight.delete(work);
+        });
+    }
+    #due() {
+        const now = this.#clock.now();
+        return [...this.#jobs.values()]
+            .filter((queued) => queued.state === 'pending' && queued.runAt <= now)
+            .sort((left, right) => left.runAt - right.runAt);
+    }
+    async #run(queued) {
+        const handler = this.#handlers.get(queued.job.name);
+        if (handler === undefined) {
+            // A job nobody handles is dead on arrival: retrying would just burn the
+            // attempts, and dropping it silently would hide a deployment mistake.
+            queued.state = 'dead';
+            // One record, recorded and alerted on. Building it twice gave the log and
+            // the alert different `error` text for the same job, so an operator
+            // grepping the log for what the page said found nothing.
+            const log = await this.#buildLog(queued, 'dead', 'no handler is registered for this job name');
+            await this.#logs?.record(log);
+            this.#onDead?.(log);
+            return;
+        }
+        queued.state = 'active';
+        queued.attempt += 1;
+        this.#active += 1;
+        const startedAt = this.#clock.now();
+        const context = {
+            job: queued.job,
+            attempt: queued.attempt,
+            maxAttempts: queued.retry.maxAttempts,
+            progress: () => undefined,
+        };
+        try {
+            await handler(context);
+            queued.state = 'completed';
+            await this.#log(queued, 'completed', undefined, startedAt);
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            if (queued.attempt >= queued.retry.maxAttempts) {
+                queued.state = 'dead';
+                const log = await this.#buildLog(queued, 'dead', message, startedAt);
+                await this.#logs?.record(log);
+                this.#onDead?.(log);
+            }
+            else {
+                queued.state = 'pending';
+                queued.runAt = this.#clock.now() + backoffFor(queued.attempt, queued.retry);
+                await this.#log(queued, 'failed', message, startedAt);
+            }
+        }
+        finally {
+            this.#active -= 1;
+        }
+    }
+    async #log(queued, state, error, startedAt) {
+        if (this.#logs === undefined)
+            return;
+        await this.#logs.record(await this.#buildLog(queued, state, error, startedAt));
+    }
+    async #buildLog(queued, state, error, startedAt) {
+        await Promise.resolve();
+        const finishedAt = this.#clock.now();
+        return {
+            id: queued.id,
+            name: queued.job.name,
+            state,
+            attempt: queued.attempt,
+            enqueuedAt: queued.enqueuedAt,
+            ...(startedAt === undefined
+                ? {}
+                : { startedAt, finishedAt, durationMs: finishedAt - startedAt }),
+            ...(error === undefined ? {} : { error }),
+            ...(queued.job.requestId === undefined ? {} : { requestId: queued.job.requestId }),
+        };
+    }
+}
+exports.MemoryQueueDriver = MemoryQueueDriver;
+/**
+ * Exponential backoff with jitter, bounded by `maxBackoffMs`.
+ *
+ * The jitter is the point. A batch of jobs that failed together at the same
+ * instant will otherwise retry together, and the recovering dependency they
+ * were waiting on goes down again.
+ */
+function backoffFor(attempt, policy) {
+    const exponential = Math.min(policy.backoffMs * 2 ** (attempt - 1), policy.maxBackoffMs);
+    if (policy.jitter <= 0)
+        return exponential;
+    const spread = Math.floor(exponential * policy.jitter);
+    return exponential - spread + (0, core_1.randomInt)(0, spread * 2);
+}
+/** In-memory job logs; a real deployment records them in its database. */
+class MemoryJobLogStore {
+    #logs = new Map();
+    #history = [];
+    async record(log) {
+        await Promise.resolve();
+        this.#logs.set(log.id, log);
+        this.#history.push(log);
+    }
+    async find(id) {
+        await Promise.resolve();
+        return this.#logs.get(id);
+    }
+    async list(filter = {}) {
+        await Promise.resolve();
+        return [...this.#logs.values()].filter((log) => (filter.name === undefined || log.name === filter.name) &&
+            (filter.state === undefined || log.state === filter.state));
+    }
+    /** Every recorded transition, in order. Tests only. */
+    get history() {
+        return this.#history;
+    }
+}
+exports.MemoryJobLogStore = MemoryJobLogStore;
+//# sourceMappingURL=memory.driver.js.map

package/dist/ports.d.ts

@@ -0,0 +1,98 @@
+/**
+ * Background jobs (PLAN.md §8, §25 P2, §26 "keep the `Job` contract").
+ *
+ * `QueueJob<TName, TPayload>` already lives in `@nage-api/contracts`, so a
+ * publisher and a consumer share one type and a payload cannot drift between
+ * them. This file adds what a driver must implement and what a run produces.
+ *
+ * The legacy framework's bespoke Redis message bus is replaced by a port with a
+ * BullMQ adapter (§27.5), but the shape of a job is retained deliberately: the
+ * migration should be a driver swap, not a rewrite of every consumer.
+ */
+import type { QueueJob, QueueJobMap } from '@nage-api/contracts';
+/** What a handler is given. The payload is typed by the job map. */
+export interface JobContext<TName extends string, TPayload> {
+    readonly job: QueueJob<TName, TPayload>;
+    /** 1 on the first run; incremented on every retry. */
+    readonly attempt: number;
+    /** Attempts this job gets in total, so a handler can behave on the last one. */
+    readonly maxAttempts: number;
+    /** Emit progress; drivers that cannot report it ignore this. */
+    progress(percent: number): void;
+}
+export type JobHandler<TName extends string, TPayload> = (context: JobContext<TName, TPayload>) => Promise<void>;
+/** How a job behaves when it fails. */
+export interface RetryPolicy {
+    /** Total attempts, including the first. `1` means no retry. */
+    readonly maxAttempts: number;
+    /** Delay before the first retry; doubled on each subsequent one. */
+    readonly backoffMs: number;
+    /** Ceiling on the backoff, so an exponential curve stays bounded. */
+    readonly maxBackoffMs: number;
+    /**
+     * Jitter, as a fraction of the delay.
+     *
+     * Without it, a batch of jobs that failed together retries together — the
+     * thundering herd that keeps a recovering dependency down.
+     */
+    readonly jitter: number;
+}
+export interface EnqueueOptions {
+    /** Run no earlier than this many milliseconds from now. */
+    readonly delayMs?: number;
+    readonly retry?: Partial<RetryPolicy>;
+    /**
+     * De-duplication key.
+     *
+     * A job enqueued twice with the same key runs once while the first is still
+     * pending — which is what makes an at-least-once queue tolerable for
+     * "send the welcome email" work.
+     */
+    readonly key?: string;
+}
+export type JobState = 'pending' | 'active' | 'completed' | 'failed' | 'dead';
+/** A durable record of one job and its outcome (§8: "job logs (opt-in)"). */
+export interface JobLog {
+    readonly id: string;
+    readonly name: string;
+    readonly state: JobState;
+    readonly attempt: number;
+    readonly enqueuedAt: number;
+    readonly startedAt?: number;
+    readonly finishedAt?: number;
+    readonly durationMs?: number;
+    /** Failure message. Never the payload, which may carry personal data. */
+    readonly error?: string;
+    readonly requestId?: string;
+}
+export interface JobLogStore {
+    record(log: JobLog): Promise<void>;
+    find(id: string): Promise<JobLog | undefined>;
+    list(filter?: {
+        name?: string;
+        state?: JobState;
+    }): Promise<readonly JobLog[]>;
+}
+/** A queue backend. */
+export interface QueueDriver {
+    readonly name: string;
+    enqueue<TName extends string, TPayload>(job: QueueJob<TName, TPayload>, options: EnqueueOptions): Promise<string>;
+    /** Register the handler for one job name. */
+    process<TName extends string, TPayload>(name: TName, handler: JobHandler<TName, TPayload>): void;
+    /** Begin consuming. Idempotent. */
+    start(): Promise<void>;
+    /** Stop consuming and let in-flight work finish. */
+    stop(): Promise<void>;
+    /** Jobs waiting, by name. */
+    depth(name?: string): Promise<number>;
+}
+/** Injected so delays and backoff are testable without waiting. */
+export interface Clock {
+    now(): number;
+}
+export declare const systemClock: Clock;
+/** Convenience alias: the handler map an application registers. */
+export type JobHandlers<TMap extends QueueJobMap> = {
+    [TName in keyof TMap & string]?: JobHandler<TName, TMap[TName]>;
+};
+//# sourceMappingURL=ports.d.ts.map

package/dist/ports.js

@@ -0,0 +1,16 @@
+"use strict";
+/**
+ * Background jobs (PLAN.md §8, §25 P2, §26 "keep the `Job` contract").
+ *
+ * `QueueJob<TName, TPayload>` already lives in `@nage-api/contracts`, so a
+ * publisher and a consumer share one type and a payload cannot drift between
+ * them. This file adds what a driver must implement and what a run produces.
+ *
+ * The legacy framework's bespoke Redis message bus is replaced by a port with a
+ * BullMQ adapter (§27.5), but the shape of a job is retained deliberately: the
+ * migration should be a driver swap, not a rewrite of every consumer.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.systemClock = void 0;
+exports.systemClock = { now: () => Date.now() };
+//# sourceMappingURL=ports.js.map

package/dist/queue.module.d.ts

@@ -0,0 +1,29 @@
+/**
+ * `NageQueueModule.forRoot(config)` (PLAN.md §11.1 item 6).
+ *
+ * The in-memory driver is the default and is refused in production: it loses
+ * every pending job on restart, and that failure presents as "some emails were
+ * never sent", weeks later, with nothing in the logs.
+ *
+ * BullMQ is the intended production driver (§27.5). It is not bundled — the
+ * application constructs it and passes it in, so ioredis stays out of the
+ * install for deployments that do not run workers.
+ */
+import { type DynamicModule, type OnApplicationShutdown } from '@nestjs/common';
+import type { QueueConfig } from '@nage-api/contracts';
+import type { Clock, JobLogStore, QueueDriver } from './ports.js';
+export interface NageQueueModuleOptions {
+    readonly queue?: QueueConfig;
+    readonly environment?: string;
+    /** A production driver — BullMQ, say. */
+    readonly driver?: QueueDriver;
+    /** Where job logs go; in-memory when `queue.jobLogs` is on and none is given. */
+    readonly logs?: JobLogStore;
+    readonly clock?: Clock;
+}
+export declare class NageQueueModule implements OnApplicationShutdown {
+    static forRoot(options?: NageQueueModuleOptions): DynamicModule;
+    onApplicationShutdown(): Promise<void>;
+    private static buildDriver;
+}
+//# sourceMappingURL=queue.module.d.ts.map

package/dist/queue.module.js

@@ -0,0 +1,84 @@
+"use strict";
+/**
+ * `NageQueueModule.forRoot(config)` (PLAN.md §11.1 item 6).
+ *
+ * The in-memory driver is the default and is refused in production: it loses
+ * every pending job on restart, and that failure presents as "some emails were
+ * never sent", weeks later, with nothing in the logs.
+ *
+ * BullMQ is the intended production driver (§27.5). It is not bundled — the
+ * application constructs it and passes it in, so ioredis stays out of the
+ * install for deployments that do not run workers.
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var NageQueueModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NageQueueModule = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nage-api/core");
+const memory_driver_js_1 = require("./memory.driver.js");
+const queue_service_js_1 = require("./queue.service.js");
+const tokens_js_1 = require("./tokens.js");
+/** Drivers started by `forRoot`, so shutdown can drain them. */
+const started = [];
+let NageQueueModule = NageQueueModule_1 = class NageQueueModule {
+    static forRoot(options = {}) {
+        const config = options.queue ?? {};
+        if (config.enabled !== true) {
+            return { module: NageQueueModule_1, providers: [], exports: [] };
+        }
+        const logs = config.jobLogs === true ? (options.logs ?? new memory_driver_js_1.MemoryJobLogStore()) : undefined;
+        const driver = options.driver ?? NageQueueModule_1.buildDriver(config, options, logs);
+        const service = new queue_service_js_1.QueueService(driver);
+        started.push(driver);
+        const providers = [
+            { provide: tokens_js_1.NAGE_QUEUE_DRIVER, useValue: driver },
+            { provide: tokens_js_1.NAGE_QUEUE, useValue: service },
+            { provide: queue_service_js_1.QueueService, useValue: service },
+            ...(logs === undefined ? [] : [{ provide: tokens_js_1.NAGE_JOB_LOGS, useValue: logs }]),
+        ];
+        return {
+            module: NageQueueModule_1,
+            providers,
+            exports: [
+                tokens_js_1.NAGE_QUEUE,
+                tokens_js_1.NAGE_QUEUE_DRIVER,
+                queue_service_js_1.QueueService,
+                ...(logs === undefined ? [] : [tokens_js_1.NAGE_JOB_LOGS]),
+            ],
+        };
+    }
+    async onApplicationShutdown() {
+        // Drain rather than drop: a worker that exits mid-job leaves work that was
+        // taken but never finished.
+        for (const driver of started.splice(0))
+            await driver.stop();
+    }
+    static buildDriver(config, options, logs) {
+        const deployed = options.environment === 'production' || options.environment === 'staging';
+        if (deployed) {
+            throw new core_1.ConfigurationError({
+                detail: 'The in-memory queue driver loses every pending job on restart; pass a durable driver to NageQueueModule.forRoot({ driver }) in a deployed environment',
+                meta: { setting: 'queue.driver', environment: options.environment },
+            });
+        }
+        // `queue.driver` only admits 'bullmq' today, and BullMQ is not bundled —
+        // the application constructs it and passes it in, so ioredis stays out of
+        // the install for deployments that run no workers.
+        return new memory_driver_js_1.MemoryQueueDriver({
+            ...(config.concurrency === undefined ? {} : { concurrency: config.concurrency }),
+            ...(logs === undefined ? {} : { logs }),
+            ...(options.clock === undefined ? {} : { clock: options.clock }),
+        });
+    }
+};
+exports.NageQueueModule = NageQueueModule;
+exports.NageQueueModule = NageQueueModule = NageQueueModule_1 = __decorate([
+    (0, common_1.Module)({})
+], NageQueueModule);
+//# sourceMappingURL=queue.module.js.map

package/dist/queue.service.d.ts

@@ -0,0 +1,28 @@
+/**
+ * The typed publisher application code uses (PLAN.md §8).
+ *
+ * `QueueService<TMap>` is parameterised by the application's job map, so
+ * `enqueue('email.welcome', { userId })` is checked against the payload the
+ * consumer will receive. The legacy bus passed `any` in both directions; a
+ * renamed field was a runtime failure in a worker nobody was watching.
+ *
+ * The correlation id travels with the job. A job is usually the tail of a
+ * request, and losing the id at the queue boundary is where a trace stops
+ * being useful.
+ */
+import type { QueueJobMap } from '@nage-api/contracts';
+import type { EnqueueOptions, JobHandler, QueueDriver } from './ports.js';
+export declare class QueueService<TMap extends QueueJobMap = QueueJobMap> {
+    #private;
+    constructor(driver: QueueDriver);
+    /** Publish a job. Returns the driver's id for it. */
+    enqueue<TName extends keyof TMap & string>(name: TName, payload: TMap[TName], options?: EnqueueOptions): Promise<string>;
+    /** Register the consumer for one job name. */
+    process<TName extends keyof TMap & string>(name: TName, handler: JobHandler<TName, TMap[TName]>): void;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    /** Jobs waiting; wire it to a gauge so a backlog is visible. */
+    depth(name?: keyof TMap & string): Promise<number>;
+    get driver(): QueueDriver;
+}
+//# sourceMappingURL=queue.service.d.ts.map

package/dist/queue.service.js

@@ -0,0 +1,52 @@
+"use strict";
+/**
+ * The typed publisher application code uses (PLAN.md §8).
+ *
+ * `QueueService<TMap>` is parameterised by the application's job map, so
+ * `enqueue('email.welcome', { userId })` is checked against the payload the
+ * consumer will receive. The legacy bus passed `any` in both directions; a
+ * renamed field was a runtime failure in a worker nobody was watching.
+ *
+ * The correlation id travels with the job. A job is usually the tail of a
+ * request, and losing the id at the queue boundary is where a trace stops
+ * being useful.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueueService = void 0;
+const core_1 = require("@nage-api/core");
+class QueueService {
+    #driver;
+    constructor(driver) {
+        this.#driver = driver;
+    }
+    /** Publish a job. Returns the driver's id for it. */
+    async enqueue(name, payload, options = {}) {
+        const requestId = (0, core_1.getActiveContext)()?.requestId;
+        const job = {
+            name,
+            payload,
+            ...(requestId === undefined ? {} : { requestId }),
+            ...(options.delayMs === undefined ? {} : { scheduledAt: Date.now() + options.delayMs }),
+        };
+        return this.#driver.enqueue(job, options);
+    }
+    /** Register the consumer for one job name. */
+    process(name, handler) {
+        this.#driver.process(name, handler);
+    }
+    async start() {
+        await this.#driver.start();
+    }
+    async stop() {
+        await this.#driver.stop();
+    }
+    /** Jobs waiting; wire it to a gauge so a backlog is visible. */
+    async depth(name) {
+        return this.#driver.depth(name);
+    }
+    get driver() {
+        return this.#driver;
+    }
+}
+exports.QueueService = QueueService;
+//# sourceMappingURL=queue.service.js.map

package/dist/tokens.d.ts

@@ -0,0 +1,8 @@
+/** DI tokens for the queue (PLAN.md §7.3). */
+import { type Token } from '@nage-api/core';
+import type { JobLogStore, QueueDriver } from './ports.js';
+import type { QueueService } from './queue.service.js';
+export declare const NAGE_QUEUE: Token<QueueService>;
+export declare const NAGE_QUEUE_DRIVER: Token<QueueDriver>;
+export declare const NAGE_JOB_LOGS: Token<JobLogStore>;
+//# sourceMappingURL=tokens.d.ts.map

package/dist/tokens.js

@@ -0,0 +1,9 @@
+"use strict";
+/** DI tokens for the queue (PLAN.md §7.3). */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NAGE_JOB_LOGS = exports.NAGE_QUEUE_DRIVER = exports.NAGE_QUEUE = void 0;
+const core_1 = require("@nage-api/core");
+exports.NAGE_QUEUE = (0, core_1.createToken)('NAGE_QUEUE');
+exports.NAGE_QUEUE_DRIVER = (0, core_1.createToken)('NAGE_QUEUE_DRIVER');
+exports.NAGE_JOB_LOGS = (0, core_1.createToken)('NAGE_JOB_LOGS');
+//# sourceMappingURL=tokens.js.map

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@nage-api/queue",
+  "version": "1.0.0-beta.2",
+  "description": "Background jobs for @nage-api — typed job contracts, retries, job logs",
+  "license": "Apache-2.0",
+  "type": "commonjs",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "!dist/.tsbuildinfo",
+    "!dist/**/*.map",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@nage-api/contracts": "1.0.0-beta.2",
+    "@nage-api/core": "1.0.0-beta.2"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^11.0.0",
+    "@nestjs/core": "^11.0.0",
+    "reflect-metadata": "^0.2.0"
+  },
+  "devDependencies": {
+    "@nestjs/common": "11.1.29",
+    "@nestjs/core": "11.1.29",
+    "@nestjs/testing": "11.1.29",
+    "@swc/core": "1.15.47",
+    "@types/node": "22.20.1",
+    "@vitest/coverage-v8": "4.1.10",
+    "reflect-metadata": "0.2.2",
+    "rimraf": "6.1.3",
+    "rxjs": "7.8.2",
+    "typescript": "5.9.3",
+    "unplugin-swc": "1.5.11",
+    "vitest": "4.1.10",
+    "@nage-api/testing": "1.0.0-beta.2"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "scripts": {
+    "build": "tsc -b tsconfig.build.json",
+    "clean": "rimraf dist .turbo",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run"
+  }
+}