@nest-toolbox/request-context 1.8.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 bogdanlupu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,301 @@
+# @nest-toolbox/request-context
+
+Lightweight AsyncLocalStorage-based request context for NestJS with auto-generated request IDs.
+
+[![npm version](https://badge.fury.io/js/%40nest-toolbox%2Frequest-context.svg)](https://www.npmjs.com/package/@nest-toolbox/request-context)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Features
+
+- 🪶 **Zero dependencies** — uses Node.js built-in `AsyncLocalStorage`, nothing else
+- 🚀 **Zero config** — import the module and every request gets a unique ID
+- 🆔 **Auto-generated request IDs** — UUIDv4 by default, or reads from an incoming header
+- 📤 **Response header** — sets `x-request-id` on every response automatically
+- 🎯 **Static API** — no DI needed, read context from anywhere with `RequestContext.get()`
+- 🔀 **Express & Fastify** — works with both adapters out of the box
+- 🔒 **Type-safe** — generic `get<T>(key)` for typed access
+
+## Installation
+
+```bash
+npm install @nest-toolbox/request-context
+```
+
+**Peer dependencies:** `@nestjs/common` and `@nestjs/core` (^10.0.0)
+
+## Quick Start
+
+```typescript
+// app.module.ts
+import { Module } from '@nestjs/common';
+import { RequestContextModule } from '@nest-toolbox/request-context';
+
+@Module({
+  imports: [RequestContextModule.forRoot()],
+})
+export class AppModule {}
+```
+
+That's it! Every HTTP request now has a unique context. Access it from anywhere:
+
+```typescript
+import { RequestContext } from '@nest-toolbox/request-context';
+
+// In any service, repository, pipe, or helper — no injection needed
+const requestId = RequestContext.requestId;
+const userId = RequestContext.get<string>('userId');
+```
+
+## API Reference
+
+### `RequestContextModule.forRoot(options?)`
+
+Register the module globally with static options.
+
+```typescript
+RequestContextModule.forRoot({
+  requestIdHeader: 'x-correlation-id',
+  generateId: () => nanoid(),
+  setResponseHeader: true,
+  responseIdHeader: 'x-correlation-id',
+});
+```
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `requestIdHeader` | `string` | `'x-request-id'` | Header to read the incoming request ID from |
+| `generateId` | `() => string` | `crypto.randomUUID` | Custom ID generator when no header is present |
+| `setResponseHeader` | `boolean` | `true` | Whether to set the request ID on the response |
+| `responseIdHeader` | `string` | `'x-request-id'` | Response header name for the request ID |
+
+### `RequestContextModule.forRootAsync(options)`
+
+Register the module with async factory injection.
+
+```typescript
+RequestContextModule.forRootAsync({
+  imports: [ConfigModule],
+  useFactory: (config: ConfigService) => ({
+    requestIdHeader: config.get('CORRELATION_HEADER', 'x-request-id'),
+    setResponseHeader: config.get('SET_RESPONSE_HEADER') !== 'false',
+  }),
+  inject: [ConfigService],
+});
+```
+
+### `RequestContext.requestId`
+
+Get the current request ID. Returns `undefined` if called outside a request context.
+
+```typescript
+import { RequestContext } from '@nest-toolbox/request-context';
+
+const id = RequestContext.requestId;
+// → "550e8400-e29b-41d4-a716-446655440000"
+```
+
+### `RequestContext.get<T>(key)`
+
+Get a typed value from the context store.
+
+```typescript
+const userId = RequestContext.get<number>('userId');
+// → 42 (typed as number | undefined)
+```
+
+### `RequestContext.set(key, value)`
+
+Set a value in the context store. No-op if called outside a context.
+
+```typescript
+RequestContext.set('userId', 42);
+RequestContext.set('tenantId', 'acme-corp');
+```
+
+### `RequestContext.has(key)`
+
+Check whether a key exists in the context store.
+
+```typescript
+if (RequestContext.has('userId')) {
+  // user is authenticated
+}
+```
+
+### `RequestContext.delete(key)`
+
+Remove a key from the context store. Returns `true` if the key existed.
+
+```typescript
+RequestContext.delete('tempToken');
+```
+
+### `RequestContext.getAll()`
+
+Get all key-value pairs as a `ReadonlyMap<string, unknown>`.
+
+```typescript
+const entries = RequestContext.getAll();
+// → Map { 'userId' => 42, 'tenantId' => 'acme-corp' }
+```
+
+### `RequestContext.run(requestId, fn)`
+
+Run a function within a manually created request context. Useful for testing, WebSocket handlers, message queue consumers, and CRON jobs.
+
+```typescript
+const result = await RequestContext.run('test-request-1', async () => {
+  RequestContext.set('userId', 1);
+  return await myService.doSomething();
+});
+```
+
+## Common Patterns
+
+### Setting user info in a guard
+
+```typescript
+import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common';
+import { RequestContext } from '@nest-toolbox/request-context';
+
+@Injectable()
+export class AuthGuard implements CanActivate {
+  async canActivate(context: ExecutionContext): Promise<boolean> {
+    const request = context.switchToHttp().getRequest();
+    const user = await this.authService.validate(request.headers.authorization);
+
+    // Store user info — available everywhere downstream
+    RequestContext.set('userId', user.id);
+    RequestContext.set('userRole', user.role);
+
+    return true;
+  }
+}
+```
+
+### Reading tenant ID in a service
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import { RequestContext } from '@nest-toolbox/request-context';
+
+@Injectable()
+export class InvoiceService {
+  async findAll() {
+    const tenantId = RequestContext.get<string>('tenantId');
+
+    return this.invoiceRepo.find({
+      where: { tenantId },
+    });
+  }
+}
+```
+
+### Using with loggers (injecting request ID)
+
+```typescript
+import { LoggerService } from '@nestjs/common';
+import { RequestContext } from '@nest-toolbox/request-context';
+
+export class AppLogger implements LoggerService {
+  log(message: string) {
+    const requestId = RequestContext.requestId ?? 'no-context';
+    console.log(`[${requestId}] ${message}`);
+  }
+
+  error(message: string, trace?: string) {
+    const requestId = RequestContext.requestId ?? 'no-context';
+    console.error(`[${requestId}] ${message}`, trace);
+  }
+
+  warn(message: string) {
+    const requestId = RequestContext.requestId ?? 'no-context';
+    console.warn(`[${requestId}] ${message}`);
+  }
+}
+```
+
+### Testing with `RequestContext.run()`
+
+```typescript
+import { RequestContext } from '@nest-toolbox/request-context';
+
+describe('InvoiceService', () => {
+  it('should filter by tenant', async () => {
+    const result = await RequestContext.run('test-req-1', async () => {
+      RequestContext.set('tenantId', 'acme-corp');
+      return invoiceService.findAll();
+    });
+
+    expect(result).toEqual(
+      expect.arrayContaining([
+        expect.objectContaining({ tenantId: 'acme-corp' }),
+      ]),
+    );
+  });
+});
+```
+
+## Integration with Other Toolbox Packages
+
+### @nest-toolbox/http-logger-middleware
+
+The HTTP logger automatically picks up the request ID to correlate log entries:
+
+```typescript
+import { RequestContextModule } from '@nest-toolbox/request-context';
+import { HttpLoggerMiddleware } from '@nest-toolbox/http-logger-middleware';
+
+@Module({
+  imports: [RequestContextModule.forRoot()],
+})
+export class AppModule implements NestModule {
+  configure(consumer: MiddlewareConsumer) {
+    consumer.apply(HttpLoggerMiddleware).forRoutes('*');
+  }
+}
+// Every log line now includes the request ID for tracing.
+```
+
+### @nest-toolbox/typeorm-audit-log
+
+Store the current user in context so audit logs automatically record who made each change:
+
+```typescript
+// In your auth guard
+RequestContext.set('userId', user.id);
+
+// The audit log subscriber reads from the same context
+// to attribute every INSERT, UPDATE, and DELETE.
+```
+
+## Comparison with nestjs-cls
+
+[`nestjs-cls`](https://github.com/Papooch/nestjs-cls) is a popular, feature-rich CLS library. If you need middleware hooks, proxy providers, or plugin extensibility, it's a great choice.
+
+**`@nest-toolbox/request-context` is intentionally simpler:**
+
+| | `request-context` | `nestjs-cls` |
+|---|---|---|
+| Dependencies | **0** (Node.js built-in) | 1+ |
+| API surface | Static class, 7 methods | Service + decorators + plugins |
+| Setup | `forRoot()`, done | `forRoot()` + configure enhancer |
+| Access pattern | `RequestContext.get()` anywhere | Inject `ClsService` via DI |
+| Request IDs | Built-in, auto-generated | Manual setup |
+| Best for | Simple context + request IDs | Complex CLS with plugins |
+
+If all you need is request IDs and a lightweight key-value store per request, this package gets out of your way.
+
+## Types
+
+All types are exported from the package:
+
+| Type | Description |
+|------|-------------|
+| `ContextStore` | Internal store shape (`requestId` + `values` map) |
+| `RequestContextOptions` | Static options for `forRoot()` |
+| `RequestContextAsyncOptions` | Async options for `forRootAsync()` |
+
+## License
+
+MIT © [Bogdan Lupu](https://github.com/lupu60)

package/dist/constants.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Constants for @nest-toolbox/request-context
+ */
+/** Injection token for module options */
+export declare const REQUEST_CONTEXT_OPTIONS = "REQUEST_CONTEXT_OPTIONS";
+/** Default request ID header name */
+export declare const DEFAULT_REQUEST_ID_HEADER = "x-request-id";

package/dist/constants.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * Constants for @nest-toolbox/request-context
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_REQUEST_ID_HEADER = exports.REQUEST_CONTEXT_OPTIONS = void 0;
+/** Injection token for module options */
+exports.REQUEST_CONTEXT_OPTIONS = 'REQUEST_CONTEXT_OPTIONS';
+/** Default request ID header name */
+exports.DEFAULT_REQUEST_ID_HEADER = 'x-request-id';
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,yCAAyC;AAC5B,QAAA,uBAAuB,GAAG,yBAAyB,CAAC;AAEjE,qCAAqC;AACxB,QAAA,yBAAyB,GAAG,cAAc,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @nest-toolbox/request-context
+ *
+ * Lightweight AsyncLocalStorage-based request context for NestJS
+ * with auto-generated request IDs.
+ */
+export * from './constants';
+export * from './request-context';
+export * from './request-context.middleware';
+export * from './request-context.module';
+export * from './types';

package/dist/index.js

@@ -0,0 +1,28 @@
+"use strict";
+/**
+ * @nest-toolbox/request-context
+ *
+ * Lightweight AsyncLocalStorage-based request context for NestJS
+ * with auto-generated request IDs.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./constants"), exports);
+__exportStar(require("./request-context"), exports);
+__exportStar(require("./request-context.middleware"), exports);
+__exportStar(require("./request-context.module"), exports);
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;;;;;;;AAEH,8CAA4B;AAC5B,oDAAkC;AAClC,+DAA6C;AAC7C,2DAAyC;AACzC,0CAAwB"}

package/dist/request-context.d.ts

@@ -0,0 +1,78 @@
+/**
+ * Core request context store using AsyncLocalStorage.
+ *
+ * Provides a static API to get/set values anywhere in the request lifecycle
+ * without injecting services or passing context through function arguments.
+ */
+import type { ContextStore } from './types';
+/**
+ * Run a function within a request context.
+ * All code executed within fn (including async operations) will have access
+ * to the context store.
+ *
+ * @param store - The context store for this request
+ * @param fn - The function to run within the context
+ * @returns The return value of fn
+ */
+export declare function runWithContext<T>(store: ContextStore, fn: () => T): T;
+/**
+ * Get the current context store, or undefined if outside a context.
+ */
+export declare function getStore(): ContextStore | undefined;
+/**
+ * Static API for accessing request context from anywhere.
+ *
+ * @example
+ * ```typescript
+ * import { RequestContext } from '@nest-toolbox/request-context';
+ *
+ * // In any service, repository, or helper
+ * const reqId = RequestContext.requestId;
+ * const userId = RequestContext.get<string>('userId');
+ * RequestContext.set('tenantId', 'acme-corp');
+ * ```
+ */
+export declare class RequestContext {
+    /**
+     * Get the current request ID.
+     * Returns undefined if called outside a request context.
+     */
+    static get requestId(): string | undefined;
+    /**
+     * Get a typed value from the context store.
+     *
+     * @param key - The key to look up
+     * @returns The value cast to T, or undefined if not found
+     */
+    static get<T = unknown>(key: string): T | undefined;
+    /**
+     * Set a value in the context store.
+     * No-op if called outside a request context.
+     *
+     * @param key - The key to set
+     * @param value - The value to store
+     */
+    static set(key: string, value: unknown): void;
+    /**
+     * Check if a key exists in the context store.
+     */
+    static has(key: string): boolean;
+    /**
+     * Delete a key from the context store.
+     */
+    static delete(key: string): boolean;
+    /**
+     * Get all key-value pairs from the context store.
+     * Returns an empty map if called outside a request context.
+     */
+    static getAll(): ReadonlyMap<string, unknown>;
+    /**
+     * Run a function within a request context.
+     * Useful for testing or non-HTTP contexts (WebSockets, queues).
+     *
+     * @param requestId - The request ID for this context
+     * @param fn - The function to run
+     * @returns The return value of fn
+     */
+    static run<T>(requestId: string, fn: () => T): T;
+}

package/dist/request-context.js

@@ -0,0 +1,112 @@
+"use strict";
+/**
+ * Core request context store using AsyncLocalStorage.
+ *
+ * Provides a static API to get/set values anywhere in the request lifecycle
+ * without injecting services or passing context through function arguments.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestContext = void 0;
+exports.runWithContext = runWithContext;
+exports.getStore = getStore;
+const node_async_hooks_1 = require("node:async_hooks");
+const storage = new node_async_hooks_1.AsyncLocalStorage();
+/**
+ * Run a function within a request context.
+ * All code executed within fn (including async operations) will have access
+ * to the context store.
+ *
+ * @param store - The context store for this request
+ * @param fn - The function to run within the context
+ * @returns The return value of fn
+ */
+function runWithContext(store, fn) {
+    return storage.run(store, fn);
+}
+/**
+ * Get the current context store, or undefined if outside a context.
+ */
+function getStore() {
+    return storage.getStore();
+}
+/**
+ * Static API for accessing request context from anywhere.
+ *
+ * @example
+ * ```typescript
+ * import { RequestContext } from '@nest-toolbox/request-context';
+ *
+ * // In any service, repository, or helper
+ * const reqId = RequestContext.requestId;
+ * const userId = RequestContext.get<string>('userId');
+ * RequestContext.set('tenantId', 'acme-corp');
+ * ```
+ */
+// biome-ignore lint/complexity/noStaticOnlyClass: class provides clean namespaced API for static access pattern
+class RequestContext {
+    /**
+     * Get the current request ID.
+     * Returns undefined if called outside a request context.
+     */
+    static get requestId() {
+        var _a;
+        return (_a = storage.getStore()) === null || _a === void 0 ? void 0 : _a.requestId;
+    }
+    /**
+     * Get a typed value from the context store.
+     *
+     * @param key - The key to look up
+     * @returns The value cast to T, or undefined if not found
+     */
+    static get(key) {
+        var _a;
+        return (_a = storage.getStore()) === null || _a === void 0 ? void 0 : _a.values.get(key);
+    }
+    /**
+     * Set a value in the context store.
+     * No-op if called outside a request context.
+     *
+     * @param key - The key to set
+     * @param value - The value to store
+     */
+    static set(key, value) {
+        var _a;
+        (_a = storage.getStore()) === null || _a === void 0 ? void 0 : _a.values.set(key, value);
+    }
+    /**
+     * Check if a key exists in the context store.
+     */
+    static has(key) {
+        var _a, _b;
+        return (_b = (_a = storage.getStore()) === null || _a === void 0 ? void 0 : _a.values.has(key)) !== null && _b !== void 0 ? _b : false;
+    }
+    /**
+     * Delete a key from the context store.
+     */
+    static delete(key) {
+        var _a, _b;
+        return (_b = (_a = storage.getStore()) === null || _a === void 0 ? void 0 : _a.values.delete(key)) !== null && _b !== void 0 ? _b : false;
+    }
+    /**
+     * Get all key-value pairs from the context store.
+     * Returns an empty map if called outside a request context.
+     */
+    static getAll() {
+        var _a, _b;
+        return (_b = (_a = storage.getStore()) === null || _a === void 0 ? void 0 : _a.values) !== null && _b !== void 0 ? _b : new Map();
+    }
+    /**
+     * Run a function within a request context.
+     * Useful for testing or non-HTTP contexts (WebSockets, queues).
+     *
+     * @param requestId - The request ID for this context
+     * @param fn - The function to run
+     * @returns The return value of fn
+     */
+    static run(requestId, fn) {
+        const store = { requestId, values: new Map() };
+        return runWithContext(store, fn);
+    }
+}
+exports.RequestContext = RequestContext;
+//# sourceMappingURL=request-context.js.map

package/dist/request-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-context.js","sourceRoot":"","sources":["../src/request-context.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAgBH,wCAEC;AAKD,4BAEC;AAvBD,uDAAqD;AAGrD,MAAM,OAAO,GAAG,IAAI,oCAAiB,EAAgB,CAAC;AAEtD;;;;;;;;GAQG;AACH,SAAgB,cAAc,CAAI,KAAmB,EAAE,EAAW;IAChE,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AAChC,CAAC;AAED;;GAEG;AACH,SAAgB,QAAQ;IACtB,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAC;AAC5B,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,gHAAgH;AAChH,MAAa,cAAc;IACzB;;;OAGG;IACH,MAAM,KAAK,SAAS;;QAClB,OAAO,MAAA,OAAO,CAAC,QAAQ,EAAE,0CAAE,SAAS,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,GAAG,CAAc,GAAW;;QACjC,OAAO,MAAA,OAAO,CAAC,QAAQ,EAAE,0CAAE,MAAM,CAAC,GAAG,CAAC,GAAG,CAAkB,CAAC;IAC9D,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,CAAC,GAAW,EAAE,KAAc;;QACpC,MAAA,OAAO,CAAC,QAAQ,EAAE,0CAAE,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,GAAG,CAAC,GAAW;;QACpB,OAAO,MAAA,MAAA,OAAO,CAAC,QAAQ,EAAE,0CAAE,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,KAAK,CAAC;IACtD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,MAAM,CAAC,GAAW;;QACvB,OAAO,MAAA,MAAA,OAAO,CAAC,QAAQ,EAAE,0CAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,mCAAI,KAAK,CAAC;IACzD,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,MAAM;;QACX,OAAO,MAAA,MAAA,OAAO,CAAC,QAAQ,EAAE,0CAAE,MAAM,mCAAI,IAAI,GAAG,EAAE,CAAC;IACjD,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,GAAG,CAAI,SAAiB,EAAE,EAAW;QAC1C,MAAM,KAAK,GAAiB,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC;QAC7D,OAAO,cAAc,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACnC,CAAC;CACF;AAhED,wCAgEC"}

package/dist/request-context.middleware.d.ts

@@ -0,0 +1,16 @@
+/**
+ * NestJS middleware that initializes the request context for each HTTP request.
+ *
+ * Extracts or generates a request ID and wraps the request lifecycle
+ * in AsyncLocalStorage so context is available everywhere.
+ */
+import { type NestMiddleware } from '@nestjs/common';
+import type { RequestContextOptions } from './types';
+export declare class RequestContextMiddleware implements NestMiddleware {
+    private readonly requestIdHeader;
+    private readonly generateId;
+    private readonly setResponseHeader;
+    private readonly responseIdHeader;
+    constructor(options?: RequestContextOptions);
+    use(req: any, res: any, next: () => void): void;
+}

package/dist/request-context.middleware.js

@@ -0,0 +1,53 @@
+"use strict";
+/**
+ * NestJS middleware that initializes the request context for each HTTP request.
+ *
+ * Extracts or generates a request ID and wraps the request lifecycle
+ * in AsyncLocalStorage so context is available everywhere.
+ */
+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 __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestContextMiddleware = void 0;
+const node_crypto_1 = require("node:crypto");
+const common_1 = require("@nestjs/common");
+const constants_1 = require("./constants");
+const request_context_1 = require("./request-context");
+let RequestContextMiddleware = class RequestContextMiddleware {
+    constructor(options) {
+        var _a, _b, _c, _d;
+        this.requestIdHeader = (_a = options === null || options === void 0 ? void 0 : options.requestIdHeader) !== null && _a !== void 0 ? _a : constants_1.DEFAULT_REQUEST_ID_HEADER;
+        this.generateId = (_b = options === null || options === void 0 ? void 0 : options.generateId) !== null && _b !== void 0 ? _b : node_crypto_1.randomUUID;
+        this.setResponseHeader = (_c = options === null || options === void 0 ? void 0 : options.setResponseHeader) !== null && _c !== void 0 ? _c : true;
+        this.responseIdHeader = (_d = options === null || options === void 0 ? void 0 : options.responseIdHeader) !== null && _d !== void 0 ? _d : constants_1.DEFAULT_REQUEST_ID_HEADER;
+    }
+    // biome-ignore lint/suspicious/noExplicitAny: Express/Fastify request/response types vary
+    use(req, res, next) {
+        var _a;
+        const headerValue = (_a = req.headers) === null || _a === void 0 ? void 0 : _a[this.requestIdHeader];
+        const requestId = typeof headerValue === 'string' && headerValue.length > 0 ? headerValue : this.generateId();
+        if (this.setResponseHeader && typeof res.setHeader === 'function') {
+            res.setHeader(this.responseIdHeader, requestId);
+        }
+        const store = { requestId, values: new Map() };
+        (0, request_context_1.runWithContext)(store, () => next());
+    }
+};
+exports.RequestContextMiddleware = RequestContextMiddleware;
+exports.RequestContextMiddleware = RequestContextMiddleware = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, common_1.Optional)()),
+    __param(0, (0, common_1.Inject)(constants_1.REQUEST_CONTEXT_OPTIONS)),
+    __metadata("design:paramtypes", [Object])
+], RequestContextMiddleware);
+//# sourceMappingURL=request-context.middleware.js.map

package/dist/request-context.middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-context.middleware.js","sourceRoot":"","sources":["../src/request-context.middleware.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;;;;;;AAEH,6CAAyC;AACzC,2CAAmF;AACnF,2CAAiF;AACjF,uDAAmD;AAI5C,IAAM,wBAAwB,GAA9B,MAAM,wBAAwB;IAMnC,YAGE,OAA+B;;QAE/B,IAAI,CAAC,eAAe,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe,mCAAI,qCAAyB,CAAC;QAC7E,IAAI,CAAC,UAAU,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,mCAAI,wBAAU,CAAC;QACpD,IAAI,CAAC,iBAAiB,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,iBAAiB,mCAAI,IAAI,CAAC;QAC5D,IAAI,CAAC,gBAAgB,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,gBAAgB,mCAAI,qCAAyB,CAAC;IACjF,CAAC;IAED,0FAA0F;IAC1F,GAAG,CAAC,GAAQ,EAAE,GAAQ,EAAE,IAAgB;;QACtC,MAAM,WAAW,GAAG,MAAA,GAAG,CAAC,OAAO,0CAAG,IAAI,CAAC,eAAe,CAAC,CAAC;QACxD,MAAM,SAAS,GAAG,OAAO,WAAW,KAAK,QAAQ,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;QAE9G,IAAI,IAAI,CAAC,iBAAiB,IAAI,OAAO,GAAG,CAAC,SAAS,KAAK,UAAU,EAAE,CAAC;YAClE,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,CAAC;QAClD,CAAC;QAED,MAAM,KAAK,GAAiB,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC;QAC7D,IAAA,gCAAc,EAAC,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;IACtC,CAAC;CACF,CAAA;AA7BY,4DAAwB;mCAAxB,wBAAwB;IADpC,IAAA,mBAAU,GAAE;IAQR,WAAA,IAAA,iBAAQ,GAAE,CAAA;IACV,WAAA,IAAA,eAAM,EAAC,mCAAuB,CAAC,CAAA;;GARvB,wBAAwB,CA6BpC"}