@hodfords/nestjs-response 8.0.0

package/README.md

@@ -0,0 +1,71 @@
+<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
+
+## 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"}]
+    }
+}
+
+```
+
+- `Interceptor global`
+```javascript
+{
+    providers: [
+        {
+            provide: APP_INTERCEPTOR,
+            useClass: LoggingInterceptor
+        }
+    ]
+}
+```
+
+- `Interceptor decorator`
+```javascript
+@Controller('test')
+@UseResponseInterceptor()
+export class TestController {
+    
+}
+```

package/constants/metadata.constant.d.ts

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

package/constants/metadata.constant.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RESPONSE_METADATA_KEY = void 0;
+exports.RESPONSE_METADATA_KEY = 'response:class';
+//# 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,CAAA"}

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

@@ -0,0 +1 @@
+export declare function ResponseModel(responseClass: any, isArray?: boolean): any;

package/decorators/response-model.decorator.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponseModel = void 0;
+const common_1 = require("@nestjs/common");
+const metadata_constant_1 = require("../constants/metadata.constant");
+const swagger_1 = require("@nestjs/swagger");
+function ResponseModel(responseClass, isArray = 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
+    }));
+}
+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,sEAAuE;AACvE,6CAA8C;AAE9C,SAAgB,aAAa,CAAC,aAAa,EAAE,OAAO,GAAG,KAAK;IACxD,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;KACV,CAAC,CACL,CAAC;AACN,CAAC;AARD,sCAQC"}

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,2CAA+C;AAC/C,+EAAyE;AAEzE,SAAgB,sBAAsB;IAClC,OAAO,IAAA,wBAAe,EAAC,0CAAmB,CAAC,CAAA;AAC/C,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,5 @@
+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';

package/index.js

@@ -0,0 +1,22 @@
+"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);
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../libs/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gEAA6C;AAC7C,wEAAqD;AACrD,kFAA+D;AAC/D,2EAAwD;AACxD,sEAAmD"}

package/interceptors/response.interceptor.d.ts

@@ -0,0 +1,6 @@
+import { CallHandler, ExecutionContext, NestInterceptor } from '@nestjs/common';
+import { Observable } from 'rxjs';
+export declare class ResponseInterceptor implements NestInterceptor {
+    intercept(context: ExecutionContext, next: CallHandler): Observable<any>;
+    handleResponse(context: ExecutionContext, data: any): Promise<any>;
+}

package/interceptors/response.interceptor.js

@@ -0,0 +1,57 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponseInterceptor = void 0;
+const common_1 = require("@nestjs/common");
+const rxjs_1 = require("rxjs");
+const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
+const response_validate_exception_1 = require("../exceptions/response-validate.exception");
+const metadata_constant_1 = require("../constants/metadata.constant");
+let ResponseInterceptor = class ResponseInterceptor {
+    intercept(context, next) {
+        return next.handle().pipe((0, rxjs_1.map)((data) => this.handleResponse(context, data)));
+    }
+    async handleResponse(context, data) {
+        let responseMetadata = Reflect.getMetadata(metadata_constant_1.RESPONSE_METADATA_KEY, context.getHandler());
+        if (!responseMetadata) {
+            return data;
+        }
+        if (responseMetadata.isArray) {
+            let newData = [];
+            for (let item of data) {
+                let newItem = (0, class_transformer_1.plainToInstance)(responseMetadata.responseClass, item);
+                let errors = await (0, class_validator_1.validate)(newItem, {
+                    whitelist: true,
+                    stopAtFirstError: true
+                });
+                if (errors.length) {
+                    console.error(errors);
+                    throw new response_validate_exception_1.ResponseValidateException(errors);
+                }
+                newData.push(newItem);
+            }
+            return newData;
+        }
+        let newData = (0, class_transformer_1.plainToInstance)(responseMetadata.responseClass, data);
+        let errors = await (0, class_validator_1.validate)(newData, {
+            whitelist: true,
+            stopAtFirstError: true
+        });
+        if (errors.length) {
+            console.error(errors);
+            throw new response_validate_exception_1.ResponseValidateException(errors);
+        }
+        return newData;
+    }
+};
+ResponseInterceptor = __decorate([
+    (0, common_1.Injectable)()
+], ResponseInterceptor);
+exports.ResponseInterceptor = 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,2CAA4F;AAC5F,+BAAuC;AACvC,yDAAoD;AACpD,qDAA2C;AAC3C,2FAAsF;AACtF,sEAAuE;AAGvE,IAAa,mBAAmB,GAAhC,MAAa,mBAAmB;IAC5B,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,KAAK,CAAC,cAAc,CAAC,OAAyB,EAAE,IAAI;QAChD,IAAI,gBAAgB,GAAG,OAAO,CAAC,WAAW,CAAC,yCAAqB,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;QACxF,IAAI,CAAC,gBAAgB,EAAE;YACnB,OAAO,IAAI,CAAC;SACf;QACD,IAAI,gBAAgB,CAAC,OAAO,EAAE;YAC1B,IAAI,OAAO,GAAG,EAAE,CAAC;YACjB,KAAK,IAAI,IAAI,IAAI,IAAI,EAAE;gBACnB,IAAI,OAAO,GAAG,IAAA,mCAAe,EAAC,gBAAgB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;gBACpE,IAAI,MAAM,GAAG,MAAM,IAAA,0BAAQ,EAAC,OAAO,EAAE;oBACjC,SAAS,EAAE,IAAI;oBACf,gBAAgB,EAAE,IAAI;iBACzB,CAAC,CAAC;gBACH,IAAI,MAAM,CAAC,MAAM,EAAE;oBACf,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;oBACtB,MAAM,IAAI,uDAAyB,CAAC,MAAM,CAAC,CAAC;iBAC/C;gBACD,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aACzB;YACD,OAAO,OAAO,CAAC;SAClB;QACD,IAAI,OAAO,GAAG,IAAA,mCAAe,EAAC,gBAAgB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QACpE,IAAI,MAAM,GAAG,MAAM,IAAA,0BAAQ,EAAC,OAAO,EAAE;YACjC,SAAS,EAAE,IAAI;YACf,gBAAgB,EAAE,IAAI;SACzB,CAAC,CAAC;QACH,IAAI,MAAM,CAAC,MAAM,EAAE;YACf,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACtB,MAAM,IAAI,uDAAyB,CAAC,MAAM,CAAC,CAAC;SAC/C;QACD,OAAO,OAAO,CAAC;IACnB,CAAC;CACJ,CAAA;AArCY,mBAAmB;IAD/B,IAAA,mBAAU,GAAE;GACA,mBAAmB,CAqC/B;AArCY,kDAAmB"}

package/package.json

@@ -0,0 +1,91 @@
+{
+  "name": "@hodfords/nestjs-response",
+  "version": "8.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",
+    "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"
+  },
+  "devDependencies": {
+    "@nestjs/cli": "8.2.6",
+    "@nestjs/common": "8.4.5",
+    "@nestjs/core": "8.4.5",
+    "@nestjs/platform-express": "8.4.5",
+    "@nestjs/swagger": "5.2.1",
+    "@nestjs/schematics": "8.0.11",
+    "@nestjs/testing": "8.4.5",
+    "@types/express": "4.17.13",
+    "@types/jest": "27.4.1",
+    "@types/node": "16.18.3",
+    "@types/supertest": "2.0.12",
+    "@typescript-eslint/eslint-plugin": "5.26.0",
+    "@typescript-eslint/parser": "5.26.0",
+    "auto-changelog": "2.4.0",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.0",
+    "eslint": "8.16.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-prettier": "4.0.0",
+    "husky": "8.0.1",
+    "is-ci": "3.0.1",
+    "jest": "27.5.1",
+    "lint-staged": "13.0.3",
+    "prettier": "2.6.2",
+    "reflect-metadata": "0.1.13",
+    "rimraf": "3.0.2",
+    "rxjs": "7.5.7",
+    "source-map-support": "0.5.21",
+    "supertest": "6.2.3",
+    "ts-jest": "27.1.5",
+    "ts-loader": "9.3.0",
+    "ts-node": "10.8.0",
+    "tsconfig-paths": "3.14.1",
+    "typescript": "4.6.4"
+  },
+  "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"
+    }
+  }
+}