@nest-toolbox/response-envelope 1.8.1

package/dist/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAiBH,0BAyBC;AAiBD,sBAmBC;AAiBD,8BAoBC;AAjHD,2CAA8C;AAG9C;;;;;;;;;;;GAWG;AACH,SAAgB,OAAO,CACrB,IAAO,EACP,UAKI,EAAE;;IAEN,MAAM,IAAI,GAAiB;QACzB,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACnC,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,EAAE;QACxB,UAAU,EAAE,MAAA,OAAO,CAAC,UAAU,mCAAI,GAAG;KACtC,CAAC;IAEF,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IACvC,CAAC;IAED,OAAO;QACL,OAAO,EAAE,IAAI;QACb,IAAI;QACJ,OAAO,EAAE,MAAA,OAAO,CAAC,OAAO,mCAAI,2BAAe;QAC3C,IAAI;KACL,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAgB,KAAK,CACnB,OAAe,EACf,UAII,EAAE;;IAEN,OAAO;QACL,OAAO,EAAE,KAAK;QACd,IAAI,EAAE,IAAI;QACV,OAAO;QACP,MAAM,EAAE,MAAA,OAAO,CAAC,MAAM,mCAAI,EAAE;QAC5B,IAAI,EAAE;YACJ,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,EAAE;YACxB,UAAU,EAAE,MAAA,OAAO,CAAC,UAAU,mCAAI,GAAG;SACtC;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAgB,SAAS,CACvB,IAAS,EACT,UAA0D,EAC1D,UAII,EAAE;IAEN,MAAM,UAAU,GAAG,UAAU,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAE7F,OAAO,OAAO,CAAC,IAAI,kCACd,OAAO,KACV,UAAU,EAAE;YACV,IAAI,EAAE,UAAU,CAAC,IAAI;YACrB,KAAK,EAAE,UAAU,CAAC,KAAK;YACvB,KAAK,EAAE,UAAU,CAAC,KAAK;YACvB,UAAU;SACX,IACD,CAAC;AACL,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @nest-toolbox/response-envelope
+ *
+ * Standard API response envelope with interceptor, exception filter, and helpers for NestJS.
+ */
+export * from './constants';
+export * from './decorators';
+export * from './envelope-exception.filter';
+export * from './helpers';
+export * from './response-envelope.interceptor';
+export * from './response-envelope.module';
+export * from './types';

package/dist/index.js

@@ -0,0 +1,29 @@
+"use strict";
+/**
+ * @nest-toolbox/response-envelope
+ *
+ * Standard API response envelope with interceptor, exception filter, and helpers for NestJS.
+ */
+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("./decorators"), exports);
+__exportStar(require("./envelope-exception.filter"), exports);
+__exportStar(require("./helpers"), exports);
+__exportStar(require("./response-envelope.interceptor"), exports);
+__exportStar(require("./response-envelope.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;;;;GAIG;;;;;;;;;;;;;;;;AAEH,8CAA4B;AAC5B,+CAA6B;AAC7B,8DAA4C;AAC5C,4CAA0B;AAC1B,kEAAgD;AAChD,6DAA2C;AAC3C,0CAAwB"}

package/dist/response-envelope.interceptor.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Interceptor that auto-wraps controller responses in the standard envelope.
+ *
+ * Respects @SkipEnvelope() and @ApiMessage() decorators.
+ * Already-wrapped responses (objects with a `success` boolean property) are passed through.
+ */
+import { type CallHandler, type ExecutionContext, type NestInterceptor } from '@nestjs/common';
+import type { Reflector } from '@nestjs/core';
+import { type Observable } from 'rxjs';
+import type { ResponseEnvelopeOptions } from './types';
+export declare class ResponseEnvelopeInterceptor implements NestInterceptor {
+    private readonly reflector;
+    private readonly options?;
+    constructor(reflector: Reflector, options?: ResponseEnvelopeOptions | undefined);
+    intercept(context: ExecutionContext, next: CallHandler): Observable<unknown>;
+}

package/dist/response-envelope.interceptor.js

@@ -0,0 +1,79 @@
+"use strict";
+/**
+ * Interceptor that auto-wraps controller responses in the standard envelope.
+ *
+ * Respects @SkipEnvelope() and @ApiMessage() decorators.
+ * Already-wrapped responses (objects with a `success` boolean property) are passed through.
+ */
+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.ResponseEnvelopeInterceptor = void 0;
+const common_1 = require("@nestjs/common");
+const rxjs_1 = require("rxjs");
+const constants_1 = require("./constants");
+let ResponseEnvelopeInterceptor = class ResponseEnvelopeInterceptor {
+    constructor(reflector, options) {
+        this.reflector = reflector;
+        this.options = options;
+    }
+    intercept(context, next) {
+        const shouldSkip = this.reflector.getAllAndOverride(constants_1.SKIP_ENVELOPE_KEY, [context.getHandler(), context.getClass()]);
+        if (shouldSkip) {
+            return next.handle();
+        }
+        const customMessage = this.reflector.getAllAndOverride(constants_1.API_MESSAGE_KEY, [context.getHandler(), context.getClass()]);
+        const request = context.switchToHttp().getRequest();
+        const response = context.switchToHttp().getResponse();
+        return next.handle().pipe((0, rxjs_1.map)((data) => {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            // Pass through if already wrapped
+            if (isAlreadyWrapped(data)) {
+                return data;
+            }
+            const defaultMsg = (_b = (_a = this.options) === null || _a === void 0 ? void 0 : _a.defaultMessage) !== null && _b !== void 0 ? _b : constants_1.DEFAULT_MESSAGE;
+            const includePath = (_d = (_c = this.options) === null || _c === void 0 ? void 0 : _c.includePath) !== null && _d !== void 0 ? _d : true;
+            const includeTimestamp = (_f = (_e = this.options) === null || _e === void 0 ? void 0 : _e.includeTimestamp) !== null && _f !== void 0 ? _f : true;
+            const meta = {
+                timestamp: includeTimestamp ? new Date().toISOString() : '',
+                path: includePath ? ((_g = request.url) !== null && _g !== void 0 ? _g : '') : '',
+                statusCode: (_h = response.statusCode) !== null && _h !== void 0 ? _h : 200,
+            };
+            return {
+                success: true,
+                data: data !== null && data !== void 0 ? data : null,
+                message: customMessage !== null && customMessage !== void 0 ? customMessage : defaultMsg,
+                meta,
+            };
+        }));
+    }
+};
+exports.ResponseEnvelopeInterceptor = ResponseEnvelopeInterceptor;
+exports.ResponseEnvelopeInterceptor = ResponseEnvelopeInterceptor = __decorate([
+    (0, common_1.Injectable)(),
+    __param(1, (0, common_1.Optional)()),
+    __param(1, (0, common_1.Inject)(constants_1.RESPONSE_ENVELOPE_OPTIONS)),
+    __metadata("design:paramtypes", [Function, Object])
+], ResponseEnvelopeInterceptor);
+/**
+ * Check if the response is already wrapped in our envelope format.
+ * A wrapped response has a boolean `success` field and a `meta` object.
+ */
+function isAlreadyWrapped(data) {
+    if (data === null || data === undefined || typeof data !== 'object') {
+        return false;
+    }
+    const obj = data;
+    return typeof obj.success === 'boolean' && typeof obj.meta === 'object' && obj.meta !== null;
+}
+//# sourceMappingURL=response-envelope.interceptor.js.map

package/dist/response-envelope.interceptor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-envelope.interceptor.js","sourceRoot":"","sources":["../src/response-envelope.interceptor.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;;;;;;AAEH,2CAA6H;AAE7H,+BAA4C;AAC5C,2CAA6G;AAItG,IAAM,2BAA2B,GAAjC,MAAM,2BAA2B;IACtC,YACmB,SAAoB,EAGpB,OAAiC;QAHjC,cAAS,GAAT,SAAS,CAAW;QAGpB,YAAO,GAAP,OAAO,CAA0B;IACjD,CAAC;IAEJ,SAAS,CAAC,OAAyB,EAAE,IAAiB;QACpD,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAU,6BAAiB,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;QAE5H,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;QACvB,CAAC;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAS,2BAAe,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;QAE5H,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;QACpD,MAAM,QAAQ,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,WAAW,EAAE,CAAC;QAEtD,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CACvB,IAAA,UAAG,EAAC,CAAC,IAAa,EAAE,EAAE;;YACpB,kCAAkC;YAClC,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC3B,OAAO,IAAI,CAAC;YACd,CAAC;YAED,MAAM,UAAU,GAAG,MAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,cAAc,mCAAI,2BAAe,CAAC;YACnE,MAAM,WAAW,GAAG,MAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,WAAW,mCAAI,IAAI,CAAC;YACtD,MAAM,gBAAgB,GAAG,MAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,gBAAgB,mCAAI,IAAI,CAAC;YAEhE,MAAM,IAAI,GAAiB;gBACzB,SAAS,EAAE,gBAAgB,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE;gBAC3D,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,MAAA,OAAO,CAAC,GAAG,mCAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE;gBAC5C,UAAU,EAAE,MAAA,QAAQ,CAAC,UAAU,mCAAI,GAAG;aACvC,CAAC;YAEF,OAAO;gBACL,OAAO,EAAE,IAAa;gBACtB,IAAI,EAAE,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,IAAI;gBAClB,OAAO,EAAE,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,UAAU;gBACpC,IAAI;aACL,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;CACF,CAAA;AA9CY,kEAA2B;sCAA3B,2BAA2B;IADvC,IAAA,mBAAU,GAAE;IAIR,WAAA,IAAA,iBAAQ,GAAE,CAAA;IACV,WAAA,IAAA,eAAM,EAAC,qCAAyB,CAAC,CAAA;;GAJzB,2BAA2B,CA8CvC;AAED;;;GAGG;AACH,SAAS,gBAAgB,CAAC,IAAa;IACrC,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACpE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,GAAG,GAAG,IAA+B,CAAC;IAC5C,OAAO,OAAO,GAAG,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,IAAI,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC;AAC/F,CAAC"}

package/dist/response-envelope.module.d.ts

@@ -0,0 +1,44 @@
+/**
+ * NestJS module for response-envelope.
+ *
+ * Registers the interceptor and exception filter globally.
+ * Supports forRoot() with static options and forRootAsync() with factory injection.
+ */
+import { type DynamicModule } from '@nestjs/common';
+import type { ResponseEnvelopeAsyncOptions, ResponseEnvelopeOptions } from './types';
+export declare class ResponseEnvelopeModule {
+    /**
+     * Register the module with static options.
+     *
+     * @example
+     * ```typescript
+     * @Module({
+     *   imports: [
+     *     ResponseEnvelopeModule.forRoot({ defaultMessage: 'Success' }),
+     *   ],
+     * })
+     * export class AppModule {}
+     * ```
+     */
+    static forRoot(options?: ResponseEnvelopeOptions): DynamicModule;
+    /**
+     * Register the module with async options (factory, class, or existing provider).
+     *
+     * @example
+     * ```typescript
+     * @Module({
+     *   imports: [
+     *     ResponseEnvelopeModule.forRootAsync({
+     *       imports: [ConfigModule],
+     *       useFactory: (config: ConfigService) => ({
+     *         defaultMessage: config.get('API_DEFAULT_MESSAGE'),
+     *       }),
+     *       inject: [ConfigService],
+     *     }),
+     *   ],
+     * })
+     * export class AppModule {}
+     * ```
+     */
+    static forRootAsync(options: ResponseEnvelopeAsyncOptions): DynamicModule;
+}

package/dist/response-envelope.module.js

@@ -0,0 +1,103 @@
+"use strict";
+/**
+ * NestJS module for response-envelope.
+ *
+ * Registers the interceptor and exception filter globally.
+ * Supports forRoot() with static options and forRootAsync() with factory injection.
+ */
+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 ResponseEnvelopeModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponseEnvelopeModule = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const constants_1 = require("./constants");
+const envelope_exception_filter_1 = require("./envelope-exception.filter");
+const response_envelope_interceptor_1 = require("./response-envelope.interceptor");
+let ResponseEnvelopeModule = ResponseEnvelopeModule_1 = class ResponseEnvelopeModule {
+    /**
+     * Register the module with static options.
+     *
+     * @example
+     * ```typescript
+     * @Module({
+     *   imports: [
+     *     ResponseEnvelopeModule.forRoot({ defaultMessage: 'Success' }),
+     *   ],
+     * })
+     * export class AppModule {}
+     * ```
+     */
+    static forRoot(options = {}) {
+        return {
+            module: ResponseEnvelopeModule_1,
+            global: true,
+            providers: [
+                {
+                    provide: constants_1.RESPONSE_ENVELOPE_OPTIONS,
+                    useValue: options,
+                },
+                {
+                    provide: core_1.APP_INTERCEPTOR,
+                    useClass: response_envelope_interceptor_1.ResponseEnvelopeInterceptor,
+                },
+                {
+                    provide: core_1.APP_FILTER,
+                    useClass: envelope_exception_filter_1.EnvelopeExceptionFilter,
+                },
+            ],
+        };
+    }
+    /**
+     * Register the module with async options (factory, class, or existing provider).
+     *
+     * @example
+     * ```typescript
+     * @Module({
+     *   imports: [
+     *     ResponseEnvelopeModule.forRootAsync({
+     *       imports: [ConfigModule],
+     *       useFactory: (config: ConfigService) => ({
+     *         defaultMessage: config.get('API_DEFAULT_MESSAGE'),
+     *       }),
+     *       inject: [ConfigService],
+     *     }),
+     *   ],
+     * })
+     * export class AppModule {}
+     * ```
+     */
+    static forRootAsync(options) {
+        var _a, _b, _c;
+        return {
+            module: ResponseEnvelopeModule_1,
+            global: true,
+            imports: (_a = options.imports) !== null && _a !== void 0 ? _a : [],
+            providers: [
+                {
+                    provide: constants_1.RESPONSE_ENVELOPE_OPTIONS,
+                    useFactory: (_b = options.useFactory) !== null && _b !== void 0 ? _b : (() => ({})),
+                    inject: (_c = options.inject) !== null && _c !== void 0 ? _c : [],
+                },
+                {
+                    provide: core_1.APP_INTERCEPTOR,
+                    useClass: response_envelope_interceptor_1.ResponseEnvelopeInterceptor,
+                },
+                {
+                    provide: core_1.APP_FILTER,
+                    useClass: envelope_exception_filter_1.EnvelopeExceptionFilter,
+                },
+            ],
+        };
+    }
+};
+exports.ResponseEnvelopeModule = ResponseEnvelopeModule;
+exports.ResponseEnvelopeModule = ResponseEnvelopeModule = ResponseEnvelopeModule_1 = __decorate([
+    (0, common_1.Module)({})
+], ResponseEnvelopeModule);
+//# sourceMappingURL=response-envelope.module.js.map

package/dist/response-envelope.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-envelope.module.js","sourceRoot":"","sources":["../src/response-envelope.module.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;AAEH,2CAA4D;AAC5D,uCAA2D;AAC3D,2CAAwD;AACxD,2EAAsE;AACtE,mFAA8E;AAIvE,IAAM,sBAAsB,8BAA5B,MAAM,sBAAsB;IACjC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,OAAO,CAAC,UAAmC,EAAE;QAClD,OAAO;YACL,MAAM,EAAE,wBAAsB;YAC9B,MAAM,EAAE,IAAI;YACZ,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,qCAAyB;oBAClC,QAAQ,EAAE,OAAO;iBAClB;gBACD;oBACE,OAAO,EAAE,sBAAe;oBACxB,QAAQ,EAAE,2DAA2B;iBACtC;gBACD;oBACE,OAAO,EAAE,iBAAU;oBACnB,QAAQ,EAAE,mDAAuB;iBAClC;aACF;SACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,YAAY,CAAC,OAAqC;;QACvD,OAAO;YACL,MAAM,EAAE,wBAAsB;YAC9B,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,MAAA,OAAO,CAAC,OAAO,mCAAI,EAAE;YAC9B,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,qCAAyB;oBAClC,UAAU,EAAE,MAAA,OAAO,CAAC,UAAU,mCAAI,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;oBAC9C,MAAM,EAAE,MAAA,OAAO,CAAC,MAAM,mCAAI,EAAE;iBAC7B;gBACD;oBACE,OAAO,EAAE,sBAAe;oBACxB,QAAQ,EAAE,2DAA2B;iBACtC;gBACD;oBACE,OAAO,EAAE,iBAAU;oBACnB,QAAQ,EAAE,mDAAuB;iBAClC;aACF;SACF,CAAC;IACJ,CAAC;CACF,CAAA;AA5EY,wDAAsB;iCAAtB,sBAAsB;IADlC,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,sBAAsB,CA4ElC"}