@hodfords/nestjs-response 10.0.0

package/README.md

@@ -0,0 +1,80 @@
+<p align="center">
+  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo_text.svg" width="320" alt="Nest Logo" /></a>
+</p>
+
+[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
+[circleci-url]: https://circleci.com/gh/nestjs/nest
+
+  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
+    <p align="center">
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
+<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
+<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a>
+<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
+<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
+<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
+  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
+    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
+  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
+</p>
+  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
+  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
+
+# nestjs-response
+For response, use sync, not async.
+
+## Installation 🤖
+
+```
+npm install @hodfords/nestjs-response --save
+
+```
+
+```typescript
+class UserResponse {
+    @ApiProperty()
+    @IsNotEmpty()
+    @IsString()
+    name: string
+}
+
+class UserController{
+    @Get()
+    @ResponseModel(UserResponse, true)
+    getAllUser() {
+        return [{name: "hello"}]
+    }
+
+    @Get()
+    @ResponseModel(UserResponse, true, true)
+    getUser() {
+        return undefined
+    }
+}
+
+```
+
+- `Interceptor global`
+```javascript
+{
+    providers: [
+        {
+            provide: APP_INTERCEPTOR,
+            useClass: LoggingInterceptor
+        }
+    ]
+}
+```
+
+- `Interceptor decorator`
+
+This option is not recommended. Just use for microservice, let use global interceptor
+```javascript
+@Controller('test')
+@UseResponseInterceptor()
+export class TestController {
+    
+}
+```

package/constants/metadata.constant.d.ts

@@ -0,0 +1,2 @@
+export declare const RESPONSE_METADATA_KEY = "response:class";
+export declare const RESPONSE_METADATA_KEYS = "response:classes";

package/constants/metadata.constant.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RESPONSE_METADATA_KEYS = exports.RESPONSE_METADATA_KEY = void 0;
+exports.RESPONSE_METADATA_KEY = 'response:class';
+exports.RESPONSE_METADATA_KEYS = 'response:classes';
+//# sourceMappingURL=metadata.constant.js.map

package/constants/metadata.constant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.constant.js","sourceRoot":"","sources":["../../../libs/constants/metadata.constant.ts"],"names":[],"mappings":";;;AAAa,QAAA,qBAAqB,GAAG,gBAAgB,CAAC;AACzC,QAAA,sBAAsB,GAAG,kBAAkB,CAAC"}

package/constants/native-class-response-names.constant.d.ts

@@ -0,0 +1 @@
+export declare const NativeClassResponseNamesConstant: string[];

package/constants/native-class-response-names.constant.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NativeClassResponseNamesConstant = void 0;
+exports.NativeClassResponseNamesConstant = ['Boolean', 'String', 'Number'];
+//# sourceMappingURL=native-class-response-names.constant.js.map

package/constants/native-class-response-names.constant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"native-class-response-names.constant.js","sourceRoot":"","sources":["../../../libs/constants/native-class-response-names.constant.ts"],"names":[],"mappings":";;;AAAa,QAAA,gCAAgC,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC"}

package/decorators/response-model.decorator.d.ts

@@ -0,0 +1,2 @@
+import { ClassConstructor } from 'class-transformer';
+export declare function ResponseModel(responseClass: ClassConstructor<object>, isArray?: boolean, isAllowEmpty?: boolean): MethodDecorator;

package/decorators/response-model.decorator.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponseModel = void 0;
+const common_1 = require("@nestjs/common");
+const swagger_1 = require("@nestjs/swagger");
+const metadata_constant_1 = require("../constants/metadata.constant");
+function ResponseModel(responseClass, isArray = false, isAllowEmpty = false) {
+    return (0, common_1.applyDecorators)((0, swagger_1.ApiResponse)({ type: responseClass, isArray }), (0, common_1.SetMetadata)(metadata_constant_1.RESPONSE_METADATA_KEY, {
+        responseClass,
+        isArray,
+        isAllowEmpty
+    }));
+}
+exports.ResponseModel = ResponseModel;
+//# sourceMappingURL=response-model.decorator.js.map

package/decorators/response-model.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-model.decorator.js","sourceRoot":"","sources":["../../../libs/decorators/response-model.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAA8D;AAC9D,6CAA8C;AAE9C,sEAAuE;AAEvE,SAAgB,aAAa,CACzB,aAAuC,EACvC,OAAO,GAAG,KAAK,EACf,YAAY,GAAG,KAAK;IAEpB,OAAO,IAAA,wBAAe,EAClB,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC,EAC7C,IAAA,oBAAW,EAAC,yCAAqB,EAAE;QAC/B,aAAa;QACb,OAAO;QACP,YAAY;KACf,CAAC,CACL,CAAC;AACN,CAAC;AAbD,sCAaC"}

package/decorators/response-models.decorator.d.ts

@@ -0,0 +1,2 @@
+import { ResponseClass } from './../types/response-metadata.type';
+export declare function ResponseModels(...responseClasses: ResponseClass[]): MethodDecorator;

package/decorators/response-models.decorator.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponseModels = void 0;
+const common_1 = require("@nestjs/common");
+const swagger_1 = require("@nestjs/swagger");
+const metadata_constant_1 = require("../constants/metadata.constant");
+function ResponseModels(...responseClasses) {
+    const metadatas = responseClasses.map((metadata) => {
+        const isArray = Array.isArray(metadata);
+        const responseClass = isArray ? metadata[0] : metadata;
+        const isAllowEmpty = metadata === undefined || metadata === null;
+        return { isArray, responseClass, isAllowEmpty };
+    });
+    const models = metadatas.filter((metadata) => !metadata.isAllowEmpty).map((metadata) => metadata.responseClass);
+    return (0, common_1.applyDecorators)((0, swagger_1.ApiExtraModels)(...models), (0, swagger_1.ApiOkResponse)({
+        schema: { anyOf: (0, swagger_1.refs)(...models) }
+    }), (0, common_1.SetMetadata)(metadata_constant_1.RESPONSE_METADATA_KEYS, metadatas));
+}
+exports.ResponseModels = ResponseModels;
+//# sourceMappingURL=response-models.decorator.js.map

package/decorators/response-models.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-models.decorator.js","sourceRoot":"","sources":["../../../libs/decorators/response-models.decorator.ts"],"names":[],"mappings":";;;AACA,2CAA8D;AAC9D,6CAAsE;AACtE,sEAAwE;AAExE,SAAgB,cAAc,CAAC,GAAG,eAAgC;IAC9D,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC/C,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACxC,MAAM,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QACvD,MAAM,YAAY,GAAG,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,IAAI,CAAC;QACjE,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,CAAC;IACpD,CAAC,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;IAChH,OAAO,IAAA,wBAAe,EAClB,IAAA,wBAAc,EAAC,GAAG,MAAM,CAAC,EACzB,IAAA,uBAAa,EAAC;QACV,MAAM,EAAE,EAAE,KAAK,EAAE,IAAA,cAAI,EAAC,GAAG,MAAM,CAAC,EAAE;KACrC,CAAC,EACF,IAAA,oBAAW,EAAC,0CAAsB,EAAE,SAAS,CAAC,CACjD,CAAC;AACN,CAAC;AAfD,wCAeC"}

package/decorators/use-response-interceptor.decorator.d.ts

@@ -0,0 +1 @@
+export declare function UseResponseInterceptor(): MethodDecorator & ClassDecorator;

package/decorators/use-response-interceptor.decorator.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UseResponseInterceptor = void 0;
+const common_1 = require("@nestjs/common");
+const response_interceptor_1 = require("../interceptors/response.interceptor");
+function UseResponseInterceptor() {
+    return (0, common_1.UseInterceptors)(response_interceptor_1.ResponseInterceptor);
+}
+exports.UseResponseInterceptor = UseResponseInterceptor;
+//# sourceMappingURL=use-response-interceptor.decorator.js.map

package/decorators/use-response-interceptor.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-response-interceptor.decorator.js","sourceRoot":"","sources":["../../../libs/decorators/use-response-interceptor.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAiD;AACjD,+EAA2E;AAE3E,SAAgB,sBAAsB;IAClC,OAAO,IAAA,wBAAe,EAAC,0CAAmB,CAAC,CAAC;AAChD,CAAC;AAFD,wDAEC"}

package/exceptions/response-validate.exception.d.ts

@@ -0,0 +1,5 @@
+import { HttpException } from '@nestjs/common';
+export declare class ResponseValidateException extends HttpException {
+    errors: any;
+    constructor(errors: any);
+}

package/exceptions/response-validate.exception.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponseValidateException = void 0;
+const common_1 = require("@nestjs/common");
+class ResponseValidateException extends common_1.HttpException {
+    constructor(errors) {
+        super({}, common_1.HttpStatus.INTERNAL_SERVER_ERROR);
+        this.errors = errors;
+    }
+}
+exports.ResponseValidateException = ResponseValidateException;
+//# sourceMappingURL=response-validate.exception.js.map

package/exceptions/response-validate.exception.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-validate.exception.js","sourceRoot":"","sources":["../../../libs/exceptions/response-validate.exception.ts"],"names":[],"mappings":";;;AAAA,2CAA2D;AAE3D,MAAa,yBAA0B,SAAQ,sBAAa;IACxD,YAAmB,MAAM;QACrB,KAAK,CAAC,EAAE,EAAE,mBAAU,CAAC,qBAAqB,CAAC,CAAC;QAD7B,WAAM,GAAN,MAAM,CAAA;IAEzB,CAAC;CACJ;AAJD,8DAIC"}

package/index.d.ts

@@ -0,0 +1,8 @@
+export * from './constants/metadata.constant';
+export * from './decorators/response-model.decorator';
+export * from './decorators/use-response-interceptor.decorator';
+export * from './exceptions/response-validate.exception';
+export * from './interceptors/response.interceptor';
+export * from './types/response-metadata.type';
+export * from './decorators/response-models.decorator';
+export * from './types/handle-result.type';

package/index.js

@@ -0,0 +1,25 @@
+"use strict";
+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/metadata.constant"), exports);
+__exportStar(require("./decorators/response-model.decorator"), exports);
+__exportStar(require("./decorators/use-response-interceptor.decorator"), exports);
+__exportStar(require("./exceptions/response-validate.exception"), exports);
+__exportStar(require("./interceptors/response.interceptor"), exports);
+__exportStar(require("./types/response-metadata.type"), exports);
+__exportStar(require("./decorators/response-models.decorator"), exports);
+__exportStar(require("./types/handle-result.type"), exports);
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../libs/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gEAA8C;AAC9C,wEAAsD;AACtD,kFAAgE;AAChE,2EAAyD;AACzD,sEAAoD;AACpD,iEAA+C;AAC/C,yEAAuD;AACvD,6DAA2C"}

package/interceptors/response.interceptor.d.ts

@@ -0,0 +1,22 @@
+import { CallHandler, ExecutionContext, NestInterceptor } from '@nestjs/common';
+import { Observable } from 'rxjs';
+import { ResponseMetadata } from '../types/response-metadata.type';
+export declare class ResponseInterceptor implements NestInterceptor {
+    private readonly logger;
+    intercept(context: ExecutionContext, next: CallHandler): Observable<any>;
+    handleResponse(context: ExecutionContext, data: any): any;
+    handleOneTypeResponse(context: ExecutionContext, data: any, responseMetadata: ResponseMetadata): any;
+    handleMultiTypeResponse(context: ExecutionContext, data: any, responseMetadatas: ResponseMetadata[]): any;
+    handleSingleResponse(responseMetadata: ResponseMetadata, data: any): any;
+    handleListResponse(context: ExecutionContext, responseMetadata: ResponseMetadata, data: any): object[] | {
+        items: object[];
+        grpcArray: boolean;
+    };
+    handleEmptyResponse(responseMetadata: ResponseMetadata, data: any): any;
+    private handleNativeValueResponse;
+    private getResponseMap;
+    private filterResponseMetadatas;
+    private getArrayTypeMetadata;
+    private getEmptyTypeMetadata;
+    private getObjectTypeMetadata;
+}

package/interceptors/response.interceptor.js

@@ -0,0 +1,197 @@
+"use strict";
+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 ResponseInterceptor_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponseInterceptor = void 0;
+const native_class_response_names_constant_1 = require("./../constants/native-class-response-names.constant");
+const common_1 = require("@nestjs/common");
+const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
+const rxjs_1 = require("rxjs");
+const metadata_constant_1 = require("../constants/metadata.constant");
+const response_validate_exception_1 = require("../exceptions/response-validate.exception");
+const native_value_response_1 = require("../responses/native-value.response");
+let Metadata = null;
+try {
+    const grpc = require('@grpc/grpc-js');
+    Metadata = grpc.Metadata;
+}
+catch (ex) { }
+let ResponseInterceptor = ResponseInterceptor_1 = class ResponseInterceptor {
+    constructor() {
+        this.logger = new common_1.Logger(ResponseInterceptor_1.name);
+    }
+    intercept(context, next) {
+        return next.handle().pipe((0, rxjs_1.map)((data) => this.handleResponse(context, data)));
+    }
+    handleResponse(context, data) {
+        const responseMetadata = Reflect.getMetadata(metadata_constant_1.RESPONSE_METADATA_KEY, context.getHandler());
+        const responseMetadatas = Reflect.getMetadata(metadata_constant_1.RESPONSE_METADATA_KEYS, context.getHandler());
+        if (responseMetadata) {
+            return this.handleMultiTypeResponse(context, data, [responseMetadata]);
+        }
+        if (responseMetadatas && responseMetadatas.length > 0) {
+            return this.handleMultiTypeResponse(context, data, responseMetadatas);
+        }
+        return data;
+    }
+    handleOneTypeResponse(context, data, responseMetadata) {
+        if (!(0, class_validator_1.isBoolean)(data) && !data) {
+            return this.handleEmptyResponse(responseMetadata, data);
+        }
+        if (responseMetadata.isArray) {
+            return this.handleListResponse(context, responseMetadata, data);
+        }
+        return this.handleSingleResponse(responseMetadata, data);
+    }
+    handleMultiTypeResponse(context, data, responseMetadatas) {
+        const results = [];
+        const newMetadatas = this.filterResponseMetadatas(responseMetadatas, data);
+        for (const metadata of newMetadatas) {
+            try {
+                const result = this.handleOneTypeResponse(context, data, metadata);
+                results.push({ data: result, error: null });
+            }
+            catch (error) {
+                const newError = error.errors ? error.errors : error;
+                results.push({ data: null, error: newError });
+            }
+        }
+        const resultValid = results.find((result) => result.error === null);
+        if (resultValid) {
+            return resultValid.data;
+        }
+        const errors = results.map((result) => result.error);
+        this.logger.error(errors);
+        throw new response_validate_exception_1.ResponseValidateException(errors);
+    }
+    handleSingleResponse(responseMetadata, data) {
+        if (native_class_response_names_constant_1.NativeClassResponseNamesConstant.includes(responseMetadata.responseClass.name)) {
+            return this.handleNativeValueResponse(responseMetadata, data);
+        }
+        const newData = (0, class_transformer_1.plainToInstance)(responseMetadata.responseClass, data);
+        const errors = (0, class_validator_1.validateSync)(newData, {
+            whitelist: true,
+            stopAtFirstError: true
+        });
+        if (errors.length) {
+            throw new response_validate_exception_1.ResponseValidateException(errors);
+        }
+        return (0, class_transformer_1.plainToInstance)(responseMetadata.responseClass, data);
+    }
+    handleListResponse(context, responseMetadata, data) {
+        const newData = [];
+        for (const item of data) {
+            const newItem = this.handleSingleResponse(responseMetadata, item);
+            newData.push(newItem);
+        }
+        if (Metadata && context.switchToRpc().getContext() instanceof Metadata) {
+            return { items: newData, grpcArray: true };
+        }
+        return newData;
+    }
+    handleEmptyResponse(responseMetadata, data) {
+        if (responseMetadata.isAllowEmpty) {
+            return data;
+        }
+        else {
+            throw new response_validate_exception_1.ResponseValidateException([
+                {
+                    target: data,
+                    children: [],
+                    constraints: {
+                        nullValue: 'an null value was passed to the validate function'
+                    }
+                }
+            ]);
+        }
+    }
+    handleNativeValueResponse(responseMetadata, data) {
+        const responseMap = this.getResponseMap(responseMetadata, data);
+        const newData = (0, class_transformer_1.plainToInstance)(native_value_response_1.NativeValueResponse, responseMap);
+        const errors = (0, class_validator_1.validateSync)(newData, {
+            whitelist: true,
+            stopAtFirstError: true
+        });
+        if (errors.length) {
+            throw new response_validate_exception_1.ResponseValidateException(errors);
+        }
+        return data;
+    }
+    getResponseMap(responseMetadata, data) {
+        switch (responseMetadata.responseClass.name) {
+            case 'Boolean':
+                return { ['boolean']: data };
+            case 'String':
+                return { ['string']: data };
+            case 'Number':
+                return { ['number']: data };
+            default:
+                return {};
+        }
+    }
+    filterResponseMetadatas(responseMetadatas, data) {
+        if (Array.isArray(data)) {
+            return this.getArrayTypeMetadata(responseMetadatas, data);
+        }
+        if (!(0, class_validator_1.isBoolean)(data) && !data) {
+            return this.getEmptyTypeMetadata(responseMetadatas, data);
+        }
+        return this.getObjectTypeMetadata(responseMetadatas, data);
+    }
+    getArrayTypeMetadata(responseMetadatas, data) {
+        const arrayTypes = responseMetadatas.filter((metadata) => metadata.isArray);
+        if (arrayTypes.length == 0) {
+            throw new response_validate_exception_1.ResponseValidateException([
+                {
+                    target: data,
+                    children: [],
+                    constraints: {
+                        arrayValue: 'an array value was passed to the validate function'
+                    }
+                }
+            ]);
+        }
+        return arrayTypes;
+    }
+    getEmptyTypeMetadata(responseMetadatas, data) {
+        const emptyType = responseMetadatas.find((metadata) => metadata.isAllowEmpty);
+        if (emptyType) {
+            return [emptyType];
+        }
+        throw new response_validate_exception_1.ResponseValidateException([
+            {
+                target: data,
+                children: [],
+                constraints: {
+                    arrayValue: 'an empty value was passed to the validate function'
+                }
+            }
+        ]);
+    }
+    getObjectTypeMetadata(responseMetadatas, data) {
+        const objectTypes = responseMetadatas.filter((metadata) => !metadata.isArray);
+        if (objectTypes.length == 0) {
+            throw new response_validate_exception_1.ResponseValidateException([
+                {
+                    target: data,
+                    children: [],
+                    constraints: {
+                        arrayValue: 'an object value was passed to the validate function'
+                    }
+                }
+            ]);
+        }
+        return objectTypes;
+    }
+};
+exports.ResponseInterceptor = ResponseInterceptor;
+exports.ResponseInterceptor = ResponseInterceptor = ResponseInterceptor_1 = __decorate([
+    (0, common_1.Injectable)()
+], ResponseInterceptor);
+//# sourceMappingURL=response.interceptor.js.map

package/interceptors/response.interceptor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response.interceptor.js","sourceRoot":"","sources":["../../../libs/interceptors/response.interceptor.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,8GAAuG;AACvG,2CAAoG;AACpG,yDAAoD;AACpD,qDAA0D;AAC1D,+BAAuC;AACvC,sEAA+F;AAC/F,2FAAsF;AAEtF,8EAAyE;AAGzE,IAAI,QAAQ,GAAG,IAAI,CAAC;AAEpB,IAAI,CAAC;IAGD,MAAM,IAAI,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACtC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;AAC7B,CAAC;AAAC,OAAO,EAAE,EAAE,CAAC,CAAA,CAAC;AAGR,IAAM,mBAAmB,2BAAzB,MAAM,mBAAmB;IAAzB;QACc,WAAM,GAAG,IAAI,eAAM,CAAC,qBAAmB,CAAC,IAAI,CAAC,CAAC;IAiLnE,CAAC;IA/KG,SAAS,CAAC,OAAyB,EAAE,IAAiB;QAClD,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,IAAA,UAAG,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IACjF,CAAC;IAED,cAAc,CAAC,OAAyB,EAAE,IAAS;QAC/C,MAAM,gBAAgB,GAAqB,OAAO,CAAC,WAAW,CAAC,yCAAqB,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;QAC5G,MAAM,iBAAiB,GAAuB,OAAO,CAAC,WAAW,CAAC,0CAAsB,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;QAChH,IAAI,gBAAgB,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAC3E,CAAC;QACD,IAAI,iBAAiB,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpD,OAAO,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;QAC1E,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,qBAAqB,CAAC,OAAyB,EAAE,IAAS,EAAE,gBAAkC;QAC1F,IAAI,CAAC,IAAA,2BAAS,EAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YAC5B,OAAO,IAAI,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;QAC5D,CAAC;QACD,IAAI,gBAAgB,CAAC,OAAO,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,gBAAgB,EAAE,IAAI,CAAC,CAAC;QACpE,CAAC;QAED,OAAO,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;IAC7D,CAAC;IAED,uBAAuB,CAAC,OAAyB,EAAE,IAAS,EAAE,iBAAqC;QAC/F,MAAM,OAAO,GAAmB,EAAE,CAAC;QACnC,MAAM,YAAY,GAAG,IAAI,CAAC,uBAAuB,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAC3E,KAAK,MAAM,QAAQ,IAAI,YAAY,EAAE,CAAC;YAClC,IAAI,CAAC;gBACD,MAAM,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;gBACnE,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YAChD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;gBACrD,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;YAClD,CAAC;QACL,CAAC;QACD,MAAM,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC;QACpE,IAAI,WAAW,EAAE,CAAC;YACd,OAAO,WAAW,CAAC,IAAI,CAAC;QAC5B,CAAC;QACD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC1B,MAAM,IAAI,uDAAyB,CAAC,MAAM,CAAC,CAAC;IAChD,CAAC;IAED,oBAAoB,CAAC,gBAAkC,EAAE,IAAS;QAC9D,IAAI,uEAAgC,CAAC,QAAQ,CAAC,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;YACjF,OAAO,IAAI,CAAC,yBAAyB,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;QAClE,CAAC;QAED,MAAM,OAAO,GAAG,IAAA,mCAAe,EAAC,gBAAgB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QACtE,MAAM,MAAM,GAAG,IAAA,8BAAY,EAAC,OAAO,EAAE;YACjC,SAAS,EAAE,IAAI;YACf,gBAAgB,EAAE,IAAI;SACzB,CAAC,CAAC;QACH,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,uDAAyB,CAAC,MAAM,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,IAAA,mCAAe,EAAC,gBAAgB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IACjE,CAAC;IAED,kBAAkB,CAAC,OAAyB,EAAE,gBAAkC,EAAE,IAAS;QACvF,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;YACtB,MAAM,OAAO,GAAG,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;YAClE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1B,CAAC;QACD,IAAI,QAAQ,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC,UAAU,EAAE,YAAY,QAAQ,EAAE,CAAC;YACrE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;QAC/C,CAAC;QACD,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,mBAAmB,CAAC,gBAAkC,EAAE,IAAS;QAC7D,IAAI,gBAAgB,CAAC,YAAY,EAAE,CAAC;YAChC,OAAO,IAAI,CAAC;QAChB,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,uDAAyB,CAAC;gBAChC;oBACI,MAAM,EAAE,IAAI;oBACZ,QAAQ,EAAE,EAAE;oBACZ,WAAW,EAAE;wBACT,SAAS,EAAE,mDAAmD;qBACjE;iBACJ;aACJ,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IAEO,yBAAyB,CAAC,gBAAkC,EAAE,IAAS;QAC3E,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;QAChE,MAAM,OAAO,GAAG,IAAA,mCAAe,EAAC,2CAAmB,EAAE,WAAW,CAAC,CAAC;QAClE,MAAM,MAAM,GAAG,IAAA,8BAAY,EAAC,OAAO,EAAE;YACjC,SAAS,EAAE,IAAI;YACf,gBAAgB,EAAE,IAAI;SACzB,CAAC,CAAC;QACH,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,uDAAyB,CAAC,MAAM,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAEO,cAAc,CAAC,gBAAkC,EAAE,IAAS;QAChE,QAAQ,gBAAgB,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;YAC1C,KAAK,SAAS;gBACV,OAAO,EAAE,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC;YACjC,KAAK,QAAQ;gBACT,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC;YAChC,KAAK,QAAQ;gBACT,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC;YAChC;gBACI,OAAO,EAAE,CAAC;QAClB,CAAC;IACL,CAAC;IAEO,uBAAuB,CAAC,iBAAqC,EAAE,IAAS;QAC5E,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAC9D,CAAC;QACD,IAAI,CAAC,IAAA,2BAAS,EAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YAC5B,OAAO,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAC9D,CAAC;QACD,OAAO,IAAI,CAAC,qBAAqB,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;IAC/D,CAAC;IAEO,oBAAoB,CAAC,iBAAqC,EAAE,IAAS;QACzE,MAAM,UAAU,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC5E,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,uDAAyB,CAAC;gBAChC;oBACI,MAAM,EAAE,IAAI;oBACZ,QAAQ,EAAE,EAAE;oBACZ,WAAW,EAAE;wBACT,UAAU,EAAE,oDAAoD;qBACnE;iBACJ;aACJ,CAAC,CAAC;QACP,CAAC;QACD,OAAO,UAAU,CAAC;IACtB,CAAC;IAEO,oBAAoB,CAAC,iBAAqC,EAAE,IAAS;QACzE,MAAM,SAAS,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAC9E,IAAI,SAAS,EAAE,CAAC;YACZ,OAAO,CAAC,SAAS,CAAC,CAAC;QACvB,CAAC;QACD,MAAM,IAAI,uDAAyB,CAAC;YAChC;gBACI,MAAM,EAAE,IAAI;gBACZ,QAAQ,EAAE,EAAE;gBACZ,WAAW,EAAE;oBACT,UAAU,EAAE,oDAAoD;iBACnE;aACJ;SACJ,CAAC,CAAC;IACP,CAAC;IAEO,qBAAqB,CAAC,iBAAqC,EAAE,IAAS;QAC1E,MAAM,WAAW,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC9E,IAAI,WAAW,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,uDAAyB,CAAC;gBAChC;oBACI,MAAM,EAAE,IAAI;oBACZ,QAAQ,EAAE,EAAE;oBACZ,WAAW,EAAE;wBACT,UAAU,EAAE,qDAAqD;qBACpE;iBACJ;aACJ,CAAC,CAAC;QACP,CAAC;QACD,OAAO,WAAW,CAAC;IACvB,CAAC;CACJ,CAAA;AAlLY,kDAAmB;8BAAnB,mBAAmB;IAD/B,IAAA,mBAAU,GAAE;GACA,mBAAmB,CAkL/B"}

package/package.json

@@ -0,0 +1,95 @@
+{
+  "name": "@hodfords/nestjs-response",
+  "version": "10.0.0",
+  "description": "",
+  "author": "",
+  "license": "UNLICENSED",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hodfords-solutions/nestjs-response.git"
+  },
+  "scripts": {
+    "prebuild": "rimraf dist",
+    "build": "nest build",
+    "postbuild": "cp package.json dist/libs/package.json",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\" \"libs/**/*.ts\"",
+    "start": "nest start",
+    "start:dev": "npm run prebuild && nest start --watch",
+    "start:debug": "nest start --debug --watch",
+    "start:prod": "node dist/main",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json",
+    "wz-command": "wz-command",
+    "prepare": "is-ci || husky install",
+    "version": "auto-changelog && git add CHANGELOG.md",
+    "release:patch": "git add CHANGELOG.md && npm version patch --tag-version-prefix='' -f -m 'chore: release to %s'",
+    "release:push": "git push --no-verify && git push --tags --no-verify",
+    "lint-staged": "lint-staged",
+    "cspell": "cspell"
+  },
+  "devDependencies": {
+    "@nestjs/cli": "10.3.0",
+    "@nestjs/common": "10.3.1",
+    "@nestjs/core": "10.3.1",
+    "@nestjs/platform-express": "10.3.1",
+    "@nestjs/schematics": "10.1.0",
+    "@nestjs/swagger": "7.2.0",
+    "@nestjs/testing": "10.3.1",
+    "@types/express": "4.17.21",
+    "@types/jest": "29.5.11",
+    "@types/node": "20.11.10",
+    "@types/supertest": "2.0.16",
+    "@typescript-eslint/eslint-plugin": "6.20.0",
+    "@typescript-eslint/parser": "6.20.0",
+    "auto-changelog": "2.4.0",
+    "class-transformer": "0.5.1",
+    "class-validator": "0.14.0",
+    "cspell": "8.3.2",
+    "eslint": "8.56.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-prettier": "5.1.3",
+    "husky": "8.0.3",
+    "is-ci": "3.0.1",
+    "jest": "29.7.0",
+    "lint-staged": "15.2.0",
+    "prettier": "3.2.4",
+    "reflect-metadata": "0.1.13",
+    "rimraf": "5.0.5",
+    "rxjs": "7.8.1",
+    "source-map-support": "0.5.21",
+    "supertest": "6.3.4",
+    "ts-jest": "29.1.2",
+    "ts-loader": "9.5.1",
+    "ts-node": "10.9.2",
+    "tsconfig-paths": "4.2.0",
+    "typescript": "5.3.3"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": ".",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "./coverage",
+    "testEnvironment": "node",
+    "roots": [
+      "<rootDir>/src/",
+      "<rootDir>/libs/"
+    ],
+    "moduleNameMapper": {
+      "^@hodfords/nestjs-response(|/.*)$": "<rootDir>/libs/nestjs-response/src/$1"
+    }
+  }
+}

package/responses/native-value.response.d.ts

@@ -0,0 +1,5 @@
+export declare class NativeValueResponse {
+    string: string;
+    number: number;
+    boolean: boolean;
+}

package/responses/native-value.response.js

@@ -0,0 +1,32 @@
+"use strict";
+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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NativeValueResponse = void 0;
+const class_validator_1 = require("class-validator");
+class NativeValueResponse {
+}
+exports.NativeValueResponse = NativeValueResponse;
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], NativeValueResponse.prototype, "string", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsNumber)(),
+    __metadata("design:type", Number)
+], NativeValueResponse.prototype, "number", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsBoolean)(),
+    __metadata("design:type", Boolean)
+], NativeValueResponse.prototype, "boolean", void 0);
+//# sourceMappingURL=native-value.response.js.map

package/responses/native-value.response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"native-value.response.js","sourceRoot":"","sources":["../../../libs/responses/native-value.response.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAA4E;AAE5E,MAAa,mBAAmB;CAY/B;AAZD,kDAYC;AATG;IAFC,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;;mDACI;AAIf;IAFC,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;;mDACI;AAIf;IAFC,IAAA,4BAAU,GAAE;IACZ,IAAA,2BAAS,GAAE;;oDACK"}

package/types/handle-result.type.d.ts

@@ -0,0 +1,5 @@
+import { ValidationError } from 'class-validator';
+export type HandleResult = {
+    error: ValidationError;
+    data: any;
+};

package/types/handle-result.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=handle-result.type.js.map

package/types/handle-result.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"handle-result.type.js","sourceRoot":"","sources":["../../../libs/types/handle-result.type.ts"],"names":[],"mappings":""}

package/types/response-metadata.type.d.ts

@@ -0,0 +1,7 @@
+import { ClassConstructor } from 'class-transformer';
+export type ResponseMetadata = {
+    responseClass: ClassConstructor<object>;
+    isArray: boolean;
+    isAllowEmpty: boolean;
+};
+export type ResponseClass = Function | [Function];

package/types/response-metadata.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=response-metadata.type.js.map

package/types/response-metadata.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-metadata.type.js","sourceRoot":"","sources":["../../../libs/types/response-metadata.type.ts"],"names":[],"mappings":""}