nestjs-api-forge 1.0.2 → 1.0.3

package/README.md

@@ -1,17 +1,27 @@
 # nestjs-api-forge
 
-Standardized API response formatting, structured error handling, and exception filters for [NestJS](https://nestjs.com/) applications.
+[![Build & Publish](https://github.com/mirzasaikatahmmed/nestjs-api-forge/actions/workflows/publish.yml/badge.svg)](https://github.com/mirzasaikatahmmed/nestjs-api-forge/actions/workflows/publish.yml)
+[![npm version](https://img.shields.io/npm/v/nestjs-api-forge.svg)](https://www.npmjs.com/package/nestjs-api-forge)
+[![npm downloads](https://img.shields.io/npm/dm/nestjs-api-forge.svg)](https://www.npmjs.com/package/nestjs-api-forge)
+[![license](https://img.shields.io/npm/l/nestjs-api-forge.svg)](https://github.com/mirzasaikatahmmed/nestjs-api-forge/blob/main/LICENSE)
+
+Plug-and-play response envelope, exception filter, and error formatting for [NestJS](https://nestjs.com/) REST APIs — zero boilerplate, fully typed.
+
+---
 
 ## Features
 
-- **Uniform success response** envelope wrapping all handler return values
-- **Structured error responses** with `code`, `message`, and optional `details` array
-- **Global exception filter** that handles `HttpException`, `ValidationPipe` errors, and unexpected exceptions
-- **Built-in typed exceptions** (`NotFoundException`, `UnauthorizedException`, `ValidationException`, etc.)
-- **`@ForgeMessage`** decorator to override per-route success messages
-- **`@ForgeRawResponse`** decorator to opt a route out of wrapping
-- **`ApiForgeModule.forRoot()`** for one-line global registration
-- **`ApiForgeModule.forRootAsync()`** for config-service-driven options
+- **Uniform success envelope** — every handler response wrapped with `success`, `statusCode`, `message`, `data`, and `meta`
+- **Structured error responses** — consistent `code`, `message`, and optional `details` array for all errors
+- **Global exception filter** — handles `HttpException`, `ValidationPipe` errors, and unexpected exceptions
+- **Paginated response helper** — `ApiResponseDto.paginated()` with full pagination meta
+- **Built-in typed exceptions** — drop-in replacements for NestJS built-ins with structured error codes
+- **`@ForgeMessage`** — override per-route success message
+- **`@ForgeRawResponse`** — opt a route out of envelope wrapping
+- **`@ApiForge`** — apply filter + interceptor to a single controller without going global
+- **`ApiForgeModule.forRoot()`** — one-line global registration
+- **`ApiForgeModule.forRootAsync()`** — config-service-driven async options
+- **Request ID tracing** — optional UUID `requestId` in every response `meta`
 
 ---
 
@@ -25,7 +35,7 @@ npm install nestjs-api-forge
 
 ## Quick Start
 
-### 1. Register globally (`app.module.ts`)
+### 1. Register globally in `app.module.ts`
 
 ```typescript
 import { Module } from '@nestjs/common';
@@ -34,39 +44,57 @@ import { ApiForgeModule } from 'nestjs-api-forge';
 @Module({
   imports: [
     ApiForgeModule.forRoot({
-      version: '1.0',
-      defaultSuccessMessage: 'OK',
+      version: '1.0.0',
+      defaultSuccessMessage: 'Request successful',
       includePath: true,
       includeTimestamp: true,
+      includeRequestId: true,
     }),
   ],
 })
 export class AppModule {}
 ```
 
-Every route in your application will now return a standardized response automatically.
+Every route in your application now returns a standardized response automatically.
+
+### 2. Add `ValidationPipe` in `main.ts`
+
+```typescript
+import { ValidationPipe } from '@nestjs/common';
+
+app.useGlobalPipes(
+  new ValidationPipe({
+    whitelist: true,
+    forbidNonWhitelisted: true,
+    transform: true,
+  }),
+);
+```
+
+The exception filter automatically parses `ValidationPipe` errors and formats them into `error.details`.
 
 ---
 
-## Response Formats
+## Response Shapes
 
-### Success
+### Success (`2xx`)
 
 ```json
 {
   "success": true,
   "statusCode": 200,
-  "message": "Request successful",
-  "data": { "id": 1, "name": "Alice" },
+  "message": "User fetched successfully",
+  "data": { "id": 1, "name": "Alice Johnson", "email": "alice@example.com" },
   "meta": {
-    "timestamp": "2026-05-02T10:00:00.000Z",
+    "timestamp": "2026-05-15T10:00:00.000Z",
     "path": "/api/users/1",
-    "version": "1.0"
+    "version": "1.0.0",
+    "requestId": "a3f2c1d0-84e5-4b6a-9123-abc123def456"
   }
 }
 ```
 
-### Error
+### Error (`4xx` / `5xx`)
 
 ```json
 {
@@ -77,9 +105,10 @@ Every route in your application will now return a standardized response automati
     "code": "NOT_FOUND"
   },
   "meta": {
-    "timestamp": "2026-05-02T10:00:00.000Z",
+    "timestamp": "2026-05-15T10:00:00.000Z",
     "path": "/api/users/99",
-    "version": "1.0"
+    "version": "1.0.0",
+    "requestId": "b1e2f3a4-0000-4b5c-8d9e-fedcba987654"
   }
 }
 ```
@@ -95,12 +124,35 @@ Every route in your application will now return a standardized response automati
     "code": "VALIDATION_ERROR",
     "details": [
       { "field": "email", "message": "must be an email" },
-      { "field": "password", "message": "must be longer than 8 characters" }
+      { "field": "age", "message": "must be an integer number" }
     ]
   },
   "meta": {
-    "timestamp": "2026-05-02T10:00:00.000Z",
-    "path": "/api/auth/register"
+    "timestamp": "2026-05-15T10:00:00.000Z",
+    "path": "/api/users"
+  }
+}
+```
+
+### Paginated (`ApiResponseDto.paginated()`)
+
+```json
+{
+  "success": true,
+  "statusCode": 200,
+  "message": "Users fetched successfully",
+  "data": [ { "id": 1, "name": "Alice Johnson" } ],
+  "pagination": {
+    "total": 42,
+    "page": 2,
+    "limit": 10,
+    "totalPages": 5,
+    "hasNextPage": true,
+    "hasPrevPage": true
+  },
+  "meta": {
+    "timestamp": "2026-05-15T10:00:00.000Z",
+    "path": "/api/users?page=2&limit=10"
   }
 }
 ```
@@ -115,104 +167,171 @@ Every route in your application will now return a standardized response automati
 |---|---|---|---|
 | `includePath` | `boolean` | `true` | Include request path in `meta` |
 | `includeTimestamp` | `boolean` | `true` | Include ISO timestamp in `meta` |
+| `includeRequestId` | `boolean` | `false` | Attach a generated UUID to `meta.requestId` |
 | `version` | `string` | `undefined` | API version string added to `meta` |
-| `defaultSuccessMessage` | `string` | `'Request successful'` | Default success message |
+| `defaultSuccessMessage` | `string` | `'Request successful'` | Fallback success message |
+
+### `ApiForgeModule.forRootAsync(asyncOptions)`
+
+```typescript
+ApiForgeModule.forRootAsync({
+  imports: [ConfigModule],
+  inject: [ConfigService],
+  useFactory: (config: ConfigService) => ({
+    version: config.get('API_VERSION'),
+    defaultSuccessMessage: config.get('DEFAULT_SUCCESS_MSG'),
+    includeRequestId: true,
+  }),
+})
+```
 
 ### Decorators
 
 | Decorator | Scope | Description |
 |---|---|---|
-| `@ApiForge(options?)` | Controller / Method | Apply filter + interceptor to a single controller or method |
+| `@ApiForge(options?)` | Controller / Method | Apply filter + interceptor without going global |
 | `@ForgeMessage(msg)` | Controller / Method | Override the success message for that route |
-| `@ForgeRawResponse()` | Controller / Method | Skip response wrapping; return handler value as-is |
+| `@ForgeRawResponse()` | Controller / Method | Skip envelope wrapping; return raw handler value |
+
+### `ApiResponseDto` — manual usage
+
+```typescript
+import { ApiResponseDto } from 'nestjs-api-forge';
+
+// Success
+ApiResponseDto.success(data, 'User fetched', 200, { path: '/users/1' });
+
+// Created (201)
+ApiResponseDto.created(data, 'User created');
+
+// No content (204)
+ApiResponseDto.noContent('Deleted');
+
+// Paginated
+ApiResponseDto.paginated(data, total, page, limit, 'Users fetched');
+
+// Error
+ApiResponseDto.error('Not found', 404, { code: 'NOT_FOUND' });
+```
 
 ### Built-in Exceptions
 
-All exceptions extend `ApiException` which extends NestJS's `HttpException`.
+All exceptions extend `ApiException` → `HttpException` and produce a structured error body.
 
 | Class | Status | Code |
 |---|---|---|
 | `BadRequestException` | 400 | `BAD_REQUEST` |
 | `UnauthorizedException` | 401 | `UNAUTHORIZED` |
+| `PaymentRequiredException` | 402 | `PAYMENT_REQUIRED` |
 | `ForbiddenException` | 403 | `FORBIDDEN` |
 | `NotFoundException` | 404 | `NOT_FOUND` |
+| `MethodNotAllowedException` | 405 | `METHOD_NOT_ALLOWED` |
 | `ConflictException` | 409 | `CONFLICT` |
 | `UnprocessableEntityException` | 422 | `UNPROCESSABLE_ENTITY` |
 | `TooManyRequestsException` | 429 | `TOO_MANY_REQUESTS` |
 | `InternalServerException` | 500 | `INTERNAL_SERVER_ERROR` |
 | `ServiceUnavailableException` | 503 | `SERVICE_UNAVAILABLE` |
+| `GatewayTimeoutException` | 504 | `GATEWAY_TIMEOUT` |
 | `ValidationException` | 400 | `VALIDATION_ERROR` |
 
-### `ApiResponseDto` (manual usage)
-
-```typescript
-import { ApiResponseDto } from 'nestjs-api-forge';
-
-ApiResponseDto.success(data, 'User fetched', 200, { path: '/users/1' });
-ApiResponseDto.created(data, 'User created');
-ApiResponseDto.noContent('Deleted');
-ApiResponseDto.error('Not found', 404, { code: 'NOT_FOUND' });
-```
-
 ---
 
 ## Usage Examples
 
-### Controller with custom message
+### Standard CRUD controller
 
 ```typescript
-import { Controller, Get, Param } from '@nestjs/common';
-import { ForgeMessage, NotFoundException } from 'nestjs-api-forge';
+import { Controller, Get, Post, Delete, Param, Body, HttpCode, HttpStatus } from '@nestjs/common';
+import { ForgeMessage, ForgeRawResponse, NotFoundException } from 'nestjs-api-forge';
 
 @Controller('users')
 export class UsersController {
+  constructor(private readonly usersService: UsersService) {}
+
   @Get(':id')
   @ForgeMessage('User fetched successfully')
-  findOne(@Param('id') id: string) {
-    const user = this.usersService.findById(+id);
+  findOne(@Param('id') id: number) {
+    const user = this.usersService.findById(id);
     if (!user) throw new NotFoundException('User');
     return user;
   }
+
+  @Delete(':id')
+  @HttpCode(HttpStatus.NO_CONTENT)
+  remove(@Param('id') id: number) {
+    this.usersService.remove(id);
+  }
 }
 ```
 
-### Skip wrapping for a specific route
+### Paginated list (skip envelope, build manually)
 
 ```typescript
-@Get('health')
+import { ApiResponseDto, ForgeRawResponse } from 'nestjs-api-forge';
+
+@Get()
 @ForgeRawResponse()
-healthCheck() {
-  return { status: 'ok' };
+findAll(@Query('page') page = '1', @Query('limit') limit = '10') {
+  const p = parseInt(page, 10);
+  const l = parseInt(limit, 10);
+  const { data, total } = this.usersService.findAll(p, l);
+  return ApiResponseDto.paginated(data, total, p, l, 'Users fetched');
 }
 ```
 
-### Async module registration (with ConfigService)
+### Per-controller scope (no global module)
 
 ```typescript
-ApiForgeModule.forRootAsync({
-  imports: [ConfigModule],
-  inject: [ConfigService],
-  useFactory: (config: ConfigService) => ({
-    version: config.get('API_VERSION'),
-    defaultSuccessMessage: config.get('DEFAULT_SUCCESS_MSG'),
-  }),
-})
+import { ApiForge, ForgeMessage } from 'nestjs-api-forge';
+
+@Controller('products')
+@ApiForge({ version: '2.0' })
+export class ProductsController {
+  @Get()
+  @ForgeMessage('Products fetched successfully')
+  findAll() {
+    return this.productsService.findAll();
+  }
+}
 ```
 
-### Use with `ValidationPipe`
+### Raw response (health check)
 
 ```typescript
-// main.ts
-app.useGlobalPipes(
-  new ValidationPipe({
-    whitelist: true,
-    forbidNonWhitelisted: true,
-    transform: true,
-  }),
-);
+@Get('health')
+@ForgeRawResponse()
+health() {
+  return { status: 'ok', uptime: process.uptime() };
+}
+```
+
+### Custom exception with field details
+
+```typescript
+import { BadRequestException, ValidationException } from 'nestjs-api-forge';
+
+// With field-level details
+throw new BadRequestException('Invalid input', [
+  { field: 'price', message: 'Must be a positive number', value: -5 },
+]);
+
+// From class-validator constraints map
+throw ValidationException.fromConstraints({
+  email: { isEmail: 'must be an email' },
+  age: { min: 'must be at least 1' },
+});
 ```
 
-The exception filter automatically parses `ValidationPipe` error arrays and formats them into `error.details`.
+---
+
+## Peer Dependencies
+
+```
+@nestjs/common  ^9 | ^10 | ^11
+@nestjs/core    ^9 | ^10 | ^11
+reflect-metadata ^0.1 | ^0.2
+rxjs            ^7
+```
 
 ---
 

package/dist/api-forge.module.js

@@ -39,26 +39,30 @@ let ApiForgeModule = ApiForgeModule_1 = class ApiForgeModule {
         };
     }
     static forRootAsync(asyncOptions) {
+        const optionsProvider = {
+            provide: exports.FORGE_OPTIONS,
+            useFactory: asyncOptions.useFactory,
+            inject: asyncOptions.inject ?? [],
+        };
         const exceptionFilterProvider = {
             provide: core_1.APP_FILTER,
-            useFactory: async (...args) => {
-                const options = await asyncOptions.useFactory(...args);
-                return new global_exception_filter_1.ForgeExceptionFilter(options);
-            },
-            inject: asyncOptions.inject ?? [],
+            useFactory: (options) => new global_exception_filter_1.ForgeExceptionFilter(options),
+            inject: [exports.FORGE_OPTIONS],
         };
         const responseInterceptorProvider = {
             provide: core_1.APP_INTERCEPTOR,
-            useFactory: async (reflector, ...args) => {
-                const options = await asyncOptions.useFactory(...args);
-                return new response_interceptor_1.ForgeResponseInterceptor(reflector, options);
-            },
-            inject: [core_1.Reflector, ...(asyncOptions.inject ?? [])],
+            useFactory: (reflector, options) => new response_interceptor_1.ForgeResponseInterceptor(reflector, options),
+            inject: [core_1.Reflector, exports.FORGE_OPTIONS],
         };
         return {
             module: ApiForgeModule_1,
             imports: asyncOptions.imports ?? [],
-            providers: [exceptionFilterProvider, responseInterceptorProvider],
+            providers: [
+                optionsProvider,
+                exceptionFilterProvider,
+                responseInterceptorProvider,
+            ],
+            exports: [exports.FORGE_OPTIONS],
         };
     }
 };

package/dist/api-forge.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"api-forge.module.js","sourceRoot":"","sources":["../src/api-forge.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAAyE;AACzE,uCAAsE;AACtE,+EAAyE;AACzE,8EAA+E;AAGlE,QAAA,aAAa,GAAG,eAAe,CAAC;AAItC,IAAM,cAAc,sBAApB,MAAM,cAAc;IAKzB,MAAM,CAAC,OAAO,CAAC,UAAwB,EAAE;QACvC,MAAM,eAAe,GAAa;YAChC,OAAO,EAAE,qBAAa;YACtB,QAAQ,EAAE,OAAO;SAClB,CAAC;QAEF,MAAM,uBAAuB,GAAa;YACxC,OAAO,EAAE,iBAAU;YACnB,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI,8CAAoB,CAAC,OAAO,CAAC;SACpD,CAAC;QAEF,MAAM,2BAA2B,GAAa;YAC5C,OAAO,EAAE,sBAAe;YACxB,UAAU,EAAE,CAAC,SAAoB,EAAE,EAAE,CACnC,IAAI,+CAAwB,CAAC,SAAS,EAAE,OAAO,CAAC;YAClD,MAAM,EAAE,CAAC,gBAAS,CAAC;SACpB,CAAC;QAEF,OAAO;YACL,MAAM,EAAE,gBAAc;YACtB,SAAS,EAAE;gBACT,eAAe;gBACf,uBAAuB;gBACvB,2BAA2B;aAC5B;YACD,OAAO,EAAE,CAAC,qBAAa,CAAC;SACzB,CAAC;IACJ,CAAC;IAKD,MAAM,CAAC,YAAY,CAAC,YAInB;QACC,MAAM,uBAAuB,GAAa;YACxC,OAAO,EAAE,iBAAU;YACnB,UAAU,EAAE,KAAK,EAAE,GAAG,IAAW,EAAE,EAAE;gBACnC,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;gBACvD,OAAO,IAAI,8CAAoB,CAAC,OAAO,CAAC,CAAC;YAC3C,CAAC;YACD,MAAM,EAAE,YAAY,CAAC,MAAM,IAAI,EAAE;SAClC,CAAC;QAEF,MAAM,2BAA2B,GAAa;YAC5C,OAAO,EAAE,sBAAe;YACxB,UAAU,EAAE,KAAK,EAAE,SAAoB,EAAE,GAAG,IAAW,EAAE,EAAE;gBACzD,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;gBACvD,OAAO,IAAI,+CAAwB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YAC1D,CAAC;YACD,MAAM,EAAE,CAAC,gBAAS,EAAE,GAAG,CAAC,YAAY,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;SACpD,CAAC;QAEF,OAAO;YACL,MAAM,EAAE,gBAAc;YACtB,OAAO,EAAE,YAAY,CAAC,OAAO,IAAI,EAAE;YACnC,SAAS,EAAE,CAAC,uBAAuB,EAAE,2BAA2B,CAAC;SAClE,CAAC;IACJ,CAAC;CACF,CAAA;AAlEY,wCAAc;yBAAd,cAAc;IAF1B,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,cAAc,CAkE1B"}
+{"version":3,"file":"api-forge.module.js","sourceRoot":"","sources":["../src/api-forge.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAAyE;AACzE,uCAAsE;AACtE,+EAAyE;AACzE,8EAA+E;AAGlE,QAAA,aAAa,GAAG,eAAe,CAAC;AAItC,IAAM,cAAc,sBAApB,MAAM,cAAc;IACzB,MAAM,CAAC,OAAO,CAAC,UAAwB,EAAE;QACvC,MAAM,eAAe,GAAa;YAChC,OAAO,EAAE,qBAAa;YACtB,QAAQ,EAAE,OAAO;SAClB,CAAC;QAEF,MAAM,uBAAuB,GAAa;YACxC,OAAO,EAAE,iBAAU;YACnB,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI,8CAAoB,CAAC,OAAO,CAAC;SACpD,CAAC;QAEF,MAAM,2BAA2B,GAAa;YAC5C,OAAO,EAAE,sBAAe;YACxB,UAAU,EAAE,CAAC,SAAoB,EAAE,EAAE,CACnC,IAAI,+CAAwB,CAAC,SAAS,EAAE,OAAO,CAAC;YAClD,MAAM,EAAE,CAAC,gBAAS,CAAC;SACpB,CAAC;QAEF,OAAO;YACL,MAAM,EAAE,gBAAc;YACtB,SAAS,EAAE;gBACT,eAAe;gBACf,uBAAuB;gBACvB,2BAA2B;aAC5B;YACD,OAAO,EAAE,CAAC,qBAAa,CAAC;SACzB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,YAInB;QACC,MAAM,eAAe,GAAa;YAChC,OAAO,EAAE,qBAAa;YACtB,UAAU,EAAE,YAAY,CAAC,UAAU;YACnC,MAAM,EAAE,YAAY,CAAC,MAAM,IAAI,EAAE;SAClC,CAAC;QAEF,MAAM,uBAAuB,GAAa;YACxC,OAAO,EAAE,iBAAU;YACnB,UAAU,EAAE,CAAC,OAAqB,EAAE,EAAE,CAAC,IAAI,8CAAoB,CAAC,OAAO,CAAC;YACxE,MAAM,EAAE,CAAC,qBAAa,CAAC;SACxB,CAAC;QAEF,MAAM,2BAA2B,GAAa;YAC5C,OAAO,EAAE,sBAAe;YACxB,UAAU,EAAE,CAAC,SAAoB,EAAE,OAAqB,EAAE,EAAE,CAC1D,IAAI,+CAAwB,CAAC,SAAS,EAAE,OAAO,CAAC;YAClD,MAAM,EAAE,CAAC,gBAAS,EAAE,qBAAa,CAAC;SACnC,CAAC;QAEF,OAAO;YACL,MAAM,EAAE,gBAAc;YACtB,OAAO,EAAE,YAAY,CAAC,OAAO,IAAI,EAAE;YACnC,SAAS,EAAE;gBACT,eAAe;gBACf,uBAAuB;gBACvB,2BAA2B;aAC5B;YACD,OAAO,EAAE,CAAC,qBAAa,CAAC;SACzB,CAAC;IACJ,CAAC;CACF,CAAA;AAjEY,wCAAc;yBAAd,cAAc;IAF1B,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,cAAc,CAiE1B"}

package/dist/exceptions/api.exception.d.ts

@@ -32,3 +32,12 @@ export declare class InternalServerException extends ApiException {
 export declare class ServiceUnavailableException extends ApiException {
     constructor(message?: string);
 }
+export declare class MethodNotAllowedException extends ApiException {
+    constructor(message?: string);
+}
+export declare class PaymentRequiredException extends ApiException {
+    constructor(message?: string);
+}
+export declare class GatewayTimeoutException extends ApiException {
+    constructor(message?: string);
+}

package/dist/exceptions/api.exception.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ServiceUnavailableException = exports.InternalServerException = exports.TooManyRequestsException = exports.UnprocessableEntityException = exports.ConflictException = exports.NotFoundException = exports.ForbiddenException = exports.UnauthorizedException = exports.BadRequestException = exports.ApiException = void 0;
+exports.GatewayTimeoutException = exports.PaymentRequiredException = exports.MethodNotAllowedException = exports.ServiceUnavailableException = exports.InternalServerException = exports.TooManyRequestsException = exports.UnprocessableEntityException = exports.ConflictException = exports.NotFoundException = exports.ForbiddenException = exports.UnauthorizedException = exports.BadRequestException = exports.ApiException = void 0;
 const common_1 = require("@nestjs/common");
 class ApiException extends common_1.HttpException {
     constructor(message, statusCode, code, details) {
@@ -64,4 +64,22 @@ class ServiceUnavailableException extends ApiException {
     }
 }
 exports.ServiceUnavailableException = ServiceUnavailableException;
+class MethodNotAllowedException extends ApiException {
+    constructor(message = 'Method not allowed') {
+        super(message, common_1.HttpStatus.METHOD_NOT_ALLOWED, 'METHOD_NOT_ALLOWED');
+    }
+}
+exports.MethodNotAllowedException = MethodNotAllowedException;
+class PaymentRequiredException extends ApiException {
+    constructor(message = 'Payment required') {
+        super(message, common_1.HttpStatus.PAYMENT_REQUIRED, 'PAYMENT_REQUIRED');
+    }
+}
+exports.PaymentRequiredException = PaymentRequiredException;
+class GatewayTimeoutException extends ApiException {
+    constructor(message = 'Gateway timeout') {
+        super(message, common_1.HttpStatus.GATEWAY_TIMEOUT, 'GATEWAY_TIMEOUT');
+    }
+}
+exports.GatewayTimeoutException = GatewayTimeoutException;
 //# sourceMappingURL=api.exception.js.map

package/dist/exceptions/api.exception.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.exception.js","sourceRoot":"","sources":["../../src/exceptions/api.exception.ts"],"names":[],"mappings":";;;AAAA,2CAA2D;AAG3D,MAAa,YAAa,SAAQ,sBAAa;IAC7C,YACE,OAAe,EACf,UAAsB,EACN,IAAY,EACZ,OAA0B;QAE1C,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,UAAU,CAAC,CAAC;QAH9B,SAAI,GAAJ,IAAI,CAAQ;QACZ,YAAO,GAAP,OAAO,CAAmB;IAG5C,CAAC;CACF;AATD,oCASC;AAED,MAAa,mBAAoB,SAAQ,YAAY;IACnD,YAAY,OAAO,GAAG,aAAa,EAAE,OAA0B;QAC7D,KAAK,CAAC,OAAO,EAAE,mBAAU,CAAC,WAAW,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;CACF;AAJD,kDAIC;AAED,MAAa,qBAAsB,SAAQ,YAAY;IACrD,YAAY,OAAO,GAAG,cAAc;QAClC,KAAK,CAAC,OAAO,EAAE,mBAAU,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;IAC1D,CAAC;CACF;AAJD,sDAIC;AAED,MAAa,kBAAmB,SAAQ,YAAY;IAClD,YAAY,OAAO,GAAG,oBAAoB;QACxC,KAAK,CAAC,OAAO,EAAE,mBAAU,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACpD,CAAC;CACF;AAJD,gDAIC;AAED,MAAa,iBAAkB,SAAQ,YAAY;IACjD,YAAY,QAAQ,GAAG,UAAU;QAC/B,KAAK,CAAC,GAAG,QAAQ,YAAY,EAAE,mBAAU,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACpE,CAAC;CACF;AAJD,8CAIC;AAED,MAAa,iBAAkB,SAAQ,YAAY;IACjD,YAAY,OAAO,GAAG,yBAAyB;QAC7C,KAAK,CAAC,OAAO,EAAE,mBAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IAClD,CAAC;CACF;AAJD,8CAIC;AAED,MAAa,4BAA6B,SAAQ,YAAY;IAC5D,YAAY,OAAO,GAAG,sBAAsB,EAAE,OAA0B;QACtE,KAAK,CACH,OAAO,EACP,mBAAU,CAAC,oBAAoB,EAC/B,sBAAsB,EACtB,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AATD,oEASC;AAED,MAAa,wBAAyB,SAAQ,YAAY;IACxD,YAAY,OAAO,GAAG,mBAAmB;QACvC,KAAK,CAAC,OAAO,EAAE,mBAAU,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,CAAC;IACpE,CAAC;CACF;AAJD,4DAIC;AAED,MAAa,uBAAwB,SAAQ,YAAY;IACvD,YAAY,OAAO,GAAG,uBAAuB;QAC3C,KAAK,CAAC,OAAO,EAAE,mBAAU,CAAC,qBAAqB,EAAE,uBAAuB,CAAC,CAAC;IAC5E,CAAC;CACF;AAJD,0DAIC;AAED,MAAa,2BAA4B,SAAQ,YAAY;IAC3D,YAAY,OAAO,GAAG,qBAAqB;QACzC,KAAK,CAAC,OAAO,EAAE,mBAAU,CAAC,mBAAmB,EAAE,qBAAqB,CAAC,CAAC;IACxE,CAAC;CACF;AAJD,kEAIC"}
+{"version":3,"file":"api.exception.js","sourceRoot":"","sources":["../../src/exceptions/api.exception.ts"],"names":[],"mappings":";;;AAAA,2CAA2D;AAG3D,MAAa,YAAa,SAAQ,sBAAa;IAC7C,YACE,OAAe,EACf,UAAsB,EACN,IAAY,EACZ,OAA0B;QAE1C,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,UAAU,CAAC,CAAC;QAH9B,SAAI,GAAJ,IAAI,CAAQ;QACZ,YAAO,GAAP,OAAO,CAAmB;IAG5C,CAAC;CACF;AATD,oCASC;AAED,MAAa,mBAAoB,SAAQ,YAAY;IACnD,YAAY,OAAO,GAAG,aAAa,EAAE,OAA0B;QAC7D,KAAK,CAAC,OAAO,EAAE,mBAAU,CAAC,WAAW,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;CACF;AAJD,kDAIC;AAED,MAAa,qBAAsB,SAAQ,YAAY;IACrD,YAAY,OAAO,GAAG,cAAc;QAClC,KAAK,CAAC,OAAO,EAAE,mBAAU,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;IAC1D,CAAC;CACF;AAJD,sDAIC;AAED,MAAa,kBAAmB,SAAQ,YAAY;IAClD,YAAY,OAAO,GAAG,oBAAoB;QACxC,KAAK,CAAC,OAAO,EAAE,mBAAU,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACpD,CAAC;CACF;AAJD,gDAIC;AAED,MAAa,iBAAkB,SAAQ,YAAY;IACjD,YAAY,QAAQ,GAAG,UAAU;QAC/B,KAAK,CAAC,GAAG,QAAQ,YAAY,EAAE,mBAAU,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACpE,CAAC;CACF;AAJD,8CAIC;AAED,MAAa,iBAAkB,SAAQ,YAAY;IACjD,YAAY,OAAO,GAAG,yBAAyB;QAC7C,KAAK,CAAC,OAAO,EAAE,mBAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IAClD,CAAC;CACF;AAJD,8CAIC;AAED,MAAa,4BAA6B,SAAQ,YAAY;IAC5D,YAAY,OAAO,GAAG,sBAAsB,EAAE,OAA0B;QACtE,KAAK,CACH,OAAO,EACP,mBAAU,CAAC,oBAAoB,EAC/B,sBAAsB,EACtB,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AATD,oEASC;AAED,MAAa,wBAAyB,SAAQ,YAAY;IACxD,YAAY,OAAO,GAAG,mBAAmB;QACvC,KAAK,CAAC,OAAO,EAAE,mBAAU,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,CAAC;IACpE,CAAC;CACF;AAJD,4DAIC;AAED,MAAa,uBAAwB,SAAQ,YAAY;IACvD,YAAY,OAAO,GAAG,uBAAuB;QAC3C,KAAK,CAAC,OAAO,EAAE,mBAAU,CAAC,qBAAqB,EAAE,uBAAuB,CAAC,CAAC;IAC5E,CAAC;CACF;AAJD,0DAIC;AAED,MAAa,2BAA4B,SAAQ,YAAY;IAC3D,YAAY,OAAO,GAAG,qBAAqB;QACzC,KAAK,CAAC,OAAO,EAAE,mBAAU,CAAC,mBAAmB,EAAE,qBAAqB,CAAC,CAAC;IACxE,CAAC;CACF;AAJD,kEAIC;AAED,MAAa,yBAA0B,SAAQ,YAAY;IACzD,YAAY,OAAO,GAAG,oBAAoB;QACxC,KAAK,CAAC,OAAO,EAAE,mBAAU,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,CAAC;IACtE,CAAC;CACF;AAJD,8DAIC;AAED,MAAa,wBAAyB,SAAQ,YAAY;IACxD,YAAY,OAAO,GAAG,kBAAkB;QACtC,KAAK,CAAC,OAAO,EAAE,mBAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;IAClE,CAAC;CACF;AAJD,4DAIC;AAED,MAAa,uBAAwB,SAAQ,YAAY;IACvD,YAAY,OAAO,GAAG,iBAAiB;QACrC,KAAK,CAAC,OAAO,EAAE,mBAAU,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC;IAChE,CAAC;CACF;AAJD,0DAIC"}

package/dist/filters/global-exception.filter.js

@@ -12,6 +12,7 @@ var ForgeExceptionFilter_1;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ForgeExceptionFilter = void 0;
 const common_1 = require("@nestjs/common");
+const crypto_1 = require("crypto");
 const api_exception_1 = require("../exceptions/api.exception");
 const api_response_dto_1 = require("../dto/api-response.dto");
 const error_code_util_1 = require("../utils/error-code.util");
@@ -35,11 +36,12 @@ let ForgeExceptionFilter = ForgeExceptionFilter_1 = class ForgeExceptionFilter {
         response.status(errorResponse.statusCode).json(errorResponse);
     }
     buildMeta(request) {
-        const { includePath = true, includeTimestamp = true, version } = this.options;
+        const { includePath = true, includeTimestamp = true, includeRequestId = false, version, } = this.options;
         return {
             ...(includeTimestamp && { timestamp: new Date().toISOString() }),
             ...(includePath && { path: request.url }),
             ...(version && { version }),
+            ...(includeRequestId && { requestId: (0, crypto_1.randomUUID)() }),
         };
     }
     buildErrorResponse(exception, meta) {
@@ -79,9 +81,13 @@ let ForgeExceptionFilter = ForgeExceptionFilter_1 = class ForgeExceptionFilter {
         if (!Array.isArray(r['message']))
             return [];
         return r['message'].map((msg) => {
-            const parts = msg.split(' ');
-            const field = parts.shift();
-            return { field, message: parts.join(' ') };
+            const spaceIndex = msg.indexOf(' ');
+            if (spaceIndex === -1)
+                return { message: msg };
+            return {
+                field: msg.slice(0, spaceIndex),
+                message: msg.slice(spaceIndex + 1),
+            };
         });
     }
 };

package/dist/filters/global-exception.filter.js.map

@@ -1 +1 @@
-{"version":3,"file":"global-exception.filter.js","sourceRoot":"","sources":["../../src/filters/global-exception.filter.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,2CAOwB;AAExB,+DAA2D;AAC3D,8DAAyD;AAEzD,8DAAiE;AAG1D,IAAM,oBAAoB,4BAA1B,MAAM,oBAAoB;IAG/B,YAA6B,UAAwB,EAAE;QAA1B,YAAO,GAAP,OAAO,CAAmB;QAFtC,WAAM,GAAG,IAAI,eAAM,CAAC,sBAAoB,CAAC,IAAI,CAAC,CAAC;IAEN,CAAC;IAE3D,KAAK,CAAC,SAAkB,EAAE,IAAmB;QAC3C,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,GAAG,CAAC,WAAW,EAAY,CAAC;QAC7C,MAAM,OAAO,GAAG,GAAG,CAAC,UAAU,EAAW,CAAC;QAE1C,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACrC,MAAM,aAAa,GAAG,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAE/D,IAAI,aAAa,CAAC,UAAU,IAAI,GAAG,EAAE,CAAC;YACpC,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,MAAM,aAAa,CAAC,UAAU,EAAE,EAChE,SAAS,YAAY,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CACjE,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,MAAM,aAAa,CAAC,UAAU,KAAK,aAAa,CAAC,OAAO,EAAE,CAC3F,CAAC;QACJ,CAAC;QAED,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAChE,CAAC;IAEO,SAAS,CAAC,OAAgB;QAChC,MAAM,EAAE,WAAW,GAAG,IAAI,EAAE,gBAAgB,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAC9E,OAAO;YACL,GAAG,CAAC,gBAAgB,IAAI,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC;YAChE,GAAG,CAAC,WAAW,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;YACzC,GAAG,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,CAAC;SAC5B,CAAC;IACJ,CAAC;IAEO,kBAAkB,CAAC,SAAkB,EAAE,IAA4B;QACzE,IAAI,SAAS,YAAY,4BAAY,EAAE,CAAC;YACtC,OAAO,iCAAc,CAAC,KAAK,CACzB,SAAS,CAAC,OAAO,EACjB,SAAS,CAAC,SAAS,EAAE,EACrB,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,EAAE,EACpD,IAAI,CACL,CAAC;QACJ,CAAC;QAED,IAAI,SAAS,YAAY,sBAAa,EAAE,CAAC;YACvC,MAAM,MAAM,GAAG,SAAS,CAAC,SAAS,EAAE,CAAC;YACrC,MAAM,iBAAiB,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;YAClD,MAAM,OAAO,GAAG,IAAI,CAAC,2BAA2B,CAAC,iBAAiB,CAAC,CAAC;YACpE,MAAM,OAAO,GAAG,IAAI,CAAC,wBAAwB,CAAC,iBAAiB,CAAC,CAAC;YAEjE,OAAO,iCAAc,CAAC,KAAK,CACzB,OAAO,EACP,MAAM,EACN;gBACE,IAAI,EAAE,IAAA,uCAAqB,EAAC,MAAM,CAAC;gBACnC,GAAG,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC;aACvC,EACD,IAAI,CACL,CAAC;QACJ,CAAC;QAED,OAAO,iCAAc,CAAC,KAAK,CACzB,8BAA8B,EAC9B,mBAAU,CAAC,qBAAqB,EAChC,EAAE,IAAI,EAAE,uBAAuB,EAAE,EACjC,IAAI,CACL,CAAC;IACJ,CAAC;IAEO,2BAA2B,CAAC,QAAyB;QAC3D,IAAI,OAAO,QAAQ,KAAK,QAAQ;YAAE,OAAO,QAAQ,CAAC;QAClD,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACtD,MAAM,CAAC,GAAG,QAAmC,CAAC;YAC9C,IAAI,OAAO,CAAC,CAAC,SAAS,CAAC,KAAK,QAAQ;gBAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC;YAC1D,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;gBAAE,OAAO,mBAAmB,CAAC;YAC5D,IAAI,OAAO,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ;gBAAE,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC;QACxD,CAAC;QACD,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAEO,wBAAwB,CAC9B,QAAyB;QAEzB,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI;YAAE,OAAO,EAAE,CAAC;QACjE,MAAM,CAAC,GAAG,QAAmC,CAAC;QAE9C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;YAAE,OAAO,EAAE,CAAC;QAE5C,OAAQ,CAAC,CAAC,SAAS,CAAc,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YAC5C,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC7B,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;YAC5B,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC;CACF,CAAA;AAhGY,oDAAoB;+BAApB,oBAAoB;IADhC,IAAA,cAAK,GAAE;;GACK,oBAAoB,CAgGhC"}
+{"version":3,"file":"global-exception.filter.js","sourceRoot":"","sources":["../../src/filters/global-exception.filter.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,2CAOwB;AACxB,mCAAoC;AAEpC,+DAA2D;AAC3D,8DAAyD;AAEzD,8DAAiE;AAG1D,IAAM,oBAAoB,4BAA1B,MAAM,oBAAoB;IAG/B,YAA6B,UAAwB,EAAE;QAA1B,YAAO,GAAP,OAAO,CAAmB;QAFtC,WAAM,GAAG,IAAI,eAAM,CAAC,sBAAoB,CAAC,IAAI,CAAC,CAAC;IAEN,CAAC;IAE3D,KAAK,CAAC,SAAkB,EAAE,IAAmB;QAC3C,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,GAAG,CAAC,WAAW,EAAY,CAAC;QAC7C,MAAM,OAAO,GAAG,GAAG,CAAC,UAAU,EAAW,CAAC;QAE1C,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACrC,MAAM,aAAa,GAAG,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAE/D,IAAI,aAAa,CAAC,UAAU,IAAI,GAAG,EAAE,CAAC;YACpC,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,MAAM,aAAa,CAAC,UAAU,EAAE,EAChE,SAAS,YAAY,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CACjE,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,MAAM,aAAa,CAAC,UAAU,KAAK,aAAa,CAAC,OAAO,EAAE,CAC3F,CAAC;QACJ,CAAC;QAED,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAChE,CAAC;IAEO,SAAS,CAAC,OAAgB;QAChC,MAAM,EACJ,WAAW,GAAG,IAAI,EAClB,gBAAgB,GAAG,IAAI,EACvB,gBAAgB,GAAG,KAAK,EACxB,OAAO,GACR,GAAG,IAAI,CAAC,OAAO,CAAC;QACjB,OAAO;YACL,GAAG,CAAC,gBAAgB,IAAI,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC;YAChE,GAAG,CAAC,WAAW,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;YACzC,GAAG,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,CAAC;YAC3B,GAAG,CAAC,gBAAgB,IAAI,EAAE,SAAS,EAAE,IAAA,mBAAU,GAAE,EAAE,CAAC;SACrD,CAAC;IACJ,CAAC;IAEO,kBAAkB,CAAC,SAAkB,EAAE,IAA4B;QACzE,IAAI,SAAS,YAAY,4BAAY,EAAE,CAAC;YACtC,OAAO,iCAAc,CAAC,KAAK,CACzB,SAAS,CAAC,OAAO,EACjB,SAAS,CAAC,SAAS,EAAE,EACrB,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,EAAE,EACpD,IAAI,CACL,CAAC;QACJ,CAAC;QAED,IAAI,SAAS,YAAY,sBAAa,EAAE,CAAC;YACvC,MAAM,MAAM,GAAG,SAAS,CAAC,SAAS,EAAE,CAAC;YACrC,MAAM,iBAAiB,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;YAClD,MAAM,OAAO,GAAG,IAAI,CAAC,2BAA2B,CAAC,iBAAiB,CAAC,CAAC;YACpE,MAAM,OAAO,GAAG,IAAI,CAAC,wBAAwB,CAAC,iBAAiB,CAAC,CAAC;YAEjE,OAAO,iCAAc,CAAC,KAAK,CACzB,OAAO,EACP,MAAM,EACN;gBACE,IAAI,EAAE,IAAA,uCAAqB,EAAC,MAAM,CAAC;gBACnC,GAAG,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC;aACvC,EACD,IAAI,CACL,CAAC;QACJ,CAAC;QAED,OAAO,iCAAc,CAAC,KAAK,CACzB,8BAA8B,EAC9B,mBAAU,CAAC,qBAAqB,EAChC,EAAE,IAAI,EAAE,uBAAuB,EAAE,EACjC,IAAI,CACL,CAAC;IACJ,CAAC;IAEO,2BAA2B,CAAC,QAAyB;QAC3D,IAAI,OAAO,QAAQ,KAAK,QAAQ;YAAE,OAAO,QAAQ,CAAC;QAClD,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACtD,MAAM,CAAC,GAAG,QAAmC,CAAC;YAC9C,IAAI,OAAO,CAAC,CAAC,SAAS,CAAC,KAAK,QAAQ;gBAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC;YAC1D,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;gBAAE,OAAO,mBAAmB,CAAC;YAC5D,IAAI,OAAO,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ;gBAAE,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC;QACxD,CAAC;QACD,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAEO,wBAAwB,CAC9B,QAAyB;QAEzB,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI;YAAE,OAAO,EAAE,CAAC;QACjE,MAAM,CAAC,GAAG,QAAmC,CAAC;QAE9C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;YAAE,OAAO,EAAE,CAAC;QAE5C,OAAQ,CAAC,CAAC,SAAS,CAAc,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YAC5C,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACpC,IAAI,UAAU,KAAK,CAAC,CAAC;gBAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;YAC/C,OAAO;gBACL,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC;gBAC/B,OAAO,EAAE,GAAG,CAAC,KAAK,CAAC,UAAU,GAAG,CAAC,CAAC;aACnC,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF,CAAA;AAzGY,oDAAoB;+BAApB,oBAAoB;IADhC,IAAA,cAAK,GAAE;;GACK,oBAAoB,CAyGhC"}

package/dist/interceptors/response.interceptor.js

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ForgeResponseInterceptor = void 0;
 const common_1 = require("@nestjs/common");
 const core_1 = require("@nestjs/core");
+const crypto_1 = require("crypto");
 const operators_1 = require("rxjs/operators");
 const api_response_dto_1 = require("../dto/api-response.dto");
 const api_response_decorator_1 = require("../decorators/api-response.decorator");
@@ -36,11 +37,12 @@ let ForgeResponseInterceptor = class ForgeResponseInterceptor {
         }));
     }
     buildMeta(request) {
-        const { includePath = true, includeTimestamp = true, version } = this.options;
+        const { includePath = true, includeTimestamp = true, includeRequestId = false, version, } = this.options;
         return {
             ...(includeTimestamp && { timestamp: new Date().toISOString() }),
             ...(includePath && { path: request.url }),
             ...(version && { version }),
+            ...(includeRequestId && { requestId: (0, crypto_1.randomUUID)() }),
         };
     }
 };

package/dist/interceptors/response.interceptor.js.map

@@ -1 +1 @@
-{"version":3,"file":"response.interceptor.js","sourceRoot":"","sources":["../../src/interceptors/response.interceptor.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAKwB;AACxB,uCAAyC;AAEzC,8CAAqC;AAErC,8DAAyD;AAEzD,iFAG8C;AAGvC,IAAM,wBAAwB,GAA9B,MAAM,wBAAwB;IACnC,YACmB,SAAoB,EACpB,UAAwB,EAAE;QAD1B,cAAS,GAAT,SAAS,CAAW;QACpB,YAAO,GAAP,OAAO,CAAmB;IAC1C,CAAC;IAEJ,SAAS,CAAC,OAAyB,EAAE,IAAiB;QACpD,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAC5C,+CAAsB,EACtB,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAC3C,CAAC;QAEF,IAAI,KAAK;YAAE,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;QAEhC,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CACpD,0CAAiB,EACjB,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAC3C,CAAC;QAEF,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAW,CAAC;QAC7D,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC;QAEnE,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAErC,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CACvB,IAAA,eAAG,EAAC,CAAC,IAAI,EAAE,EAAE;YACX,MAAM,OAAO,GACX,aAAa;gBACb,IAAI,CAAC,OAAO,CAAC,qBAAqB;gBAClC,oBAAoB,CAAC;YAEvB,OAAO,iCAAc,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QACjE,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAEO,SAAS,CAAC,OAAgB;QAChC,MAAM,EAAE,WAAW,GAAG,IAAI,EAAE,gBAAgB,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAC9E,OAAO;YACL,GAAG,CAAC,gBAAgB,IAAI,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC;YAChE,GAAG,CAAC,WAAW,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;YACzC,GAAG,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,CAAC;SAC5B,CAAC;IACJ,CAAC;CACF,CAAA;AA5CY,4DAAwB;mCAAxB,wBAAwB;IADpC,IAAA,mBAAU,GAAE;qCAGmB,gBAAS;GAF5B,wBAAwB,CA4CpC"}
+{"version":3,"file":"response.interceptor.js","sourceRoot":"","sources":["../../src/interceptors/response.interceptor.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAKwB;AACxB,uCAAyC;AACzC,mCAAoC;AAEpC,8CAAqC;AAErC,8DAAyD;AAEzD,iFAG8C;AAGvC,IAAM,wBAAwB,GAA9B,MAAM,wBAAwB;IACnC,YACmB,SAAoB,EACpB,UAAwB,EAAE;QAD1B,cAAS,GAAT,SAAS,CAAW;QACpB,YAAO,GAAP,OAAO,CAAmB;IAC1C,CAAC;IAEJ,SAAS,CAAC,OAAyB,EAAE,IAAiB;QACpD,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAC5C,+CAAsB,EACtB,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAC3C,CAAC;QAEF,IAAI,KAAK;YAAE,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;QAEhC,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CACpD,0CAAiB,EACjB,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAC3C,CAAC;QAEF,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAW,CAAC;QAC7D,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC;QAEnE,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAErC,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CACvB,IAAA,eAAG,EAAC,CAAC,IAAI,EAAE,EAAE;YACX,MAAM,OAAO,GACX,aAAa;gBACb,IAAI,CAAC,OAAO,CAAC,qBAAqB;gBAClC,oBAAoB,CAAC;YAEvB,OAAO,iCAAc,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QACjE,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAEO,SAAS,CAAC,OAAgB;QAChC,MAAM,EACJ,WAAW,GAAG,IAAI,EAClB,gBAAgB,GAAG,IAAI,EACvB,gBAAgB,GAAG,KAAK,EACxB,OAAO,GACR,GAAG,IAAI,CAAC,OAAO,CAAC;QACjB,OAAO;YACL,GAAG,CAAC,gBAAgB,IAAI,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC;YAChE,GAAG,CAAC,WAAW,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;YACzC,GAAG,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,CAAC;YAC3B,GAAG,CAAC,gBAAgB,IAAI,EAAE,SAAS,EAAE,IAAA,mBAAU,GAAE,EAAE,CAAC;SACrD,CAAC;IACJ,CAAC;CACF,CAAA;AAlDY,4DAAwB;mCAAxB,wBAAwB;IADpC,IAAA,mBAAU,GAAE;qCAGmB,gBAAS;GAF5B,wBAAwB,CAkDpC"}

package/dist/interfaces/api-response.interface.d.ts

@@ -47,6 +47,7 @@ export interface ApiPaginatedResponse<T = unknown> {
 export interface ForgeOptions {
     includePath?: boolean;
     includeTimestamp?: boolean;
+    includeRequestId?: boolean;
     version?: string;
     defaultSuccessMessage?: string;
 }