Merge branch 'development' of github.com:andrechristikan/ack-nestjs-boilerplate into development

Author: andrechristikan

README.md

@@ -239,7 +239,7 @@ Default response for the response
 export class ResponseDefaultSerialization {
     statusCode: number;
     message: string;
-    metadata?: IResponseMetadata;
+    _metadata?: IResponseMetadata;
     data?: Record<string, any>;
 }
 ```
@@ -256,9 +256,9 @@ export class ResponsePagingSerialization {
     totalPage?: number;
     currentPage?: number;
     perPage?: number;
-    availableSearch?: string[];
-    availableSort?: string[];
-    metadata?: IResponseMetadata;
+    _availableSearch?: string[];
+    _availableSort?: string[];
+    _metadata?: IResponseMetadata;
     data: Record<string, any>[];
 }
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ack-nestjs-boilerplate",
-  "version": "4.1.4",
+  "version": "4.2.3",
   "description": "Ack NestJs Boilerplate",
   "repository": {
     "type": "git",
@@ -13,6 +13,7 @@
   "private": true,
   "license": "MIT",
   "scripts": {
+    "upgrade:package": "ncu -u",
     "prebuild": "rimraf dist",
     "build": "nest build",
     "format": "yarn format:src && yarn format:test",
@@ -79,13 +80,13 @@
     "morgan": "^1.10.0",
     "nest-winston": "^1.8.0",
     "nestjs-command": "^3.1.3",
-    "nestjs-i18n": "^10.2.4",
+    "nestjs-i18n": "^10.2.6",
     "passport": "^0.6.0",
     "passport-headerapikey": "^1.2.2",
     "passport-jwt": "^4.0.1",
     "reflect-metadata": "^0.1.13",
     "response-time": "^2.3.2",
-    "rimraf": "^3.0.2",
+    "rimraf": "^4.0.4",
     "rotating-file-stream": "^3.0.4",
     "rxjs": "^7.8.0",
     "ua-parser-js": "^1.0.32",
@@ -116,17 +117,17 @@
     "@types/supertest": "^2.0.12",
     "@types/ua-parser-js": "^0.7.36",
     "@types/uuid": "^9.0.0",
-    "@typescript-eslint/eslint-plugin": "^5.48.0",
-    "@typescript-eslint/parser": "^5.48.0",
+    "@typescript-eslint/eslint-plugin": "^5.48.1",
+    "@typescript-eslint/parser": "^5.48.1",
     "cspell": "^6.18.1",
     "eslint": "^8.31.0",
     "eslint-config-prettier": "^8.6.0",
-    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-import": "^2.27.4",
     "husky": "^8.0.3",
     "jest": "^29.3.1",
-    "prettier": "^2.8.2",
+    "prettier": "^2.8.3",
     "supertest": "^6.3.3",
-    "ts-jest": "^29.0.3",
+    "ts-jest": "^29.0.5",
     "ts-loader": "^9.4.2",
     "ts-node": "^10.9.1",
     "ts-prune": "^0.10.3",

src/app/controllers/app.controller.ts

@@ -35,7 +35,7 @@ export class AppController {
         const newDate = this.helperDateService.create();
 
         return {
-            metadata: {
+            _metadata: {
                 properties: {
                     serviceName: this.serviceName,
                 },
@@ -58,7 +58,7 @@ export class AppController {
         const newDate = this.helperDateService.create();
 
         return {
-            metadata: {
+            _metadata: {
                 properties: {
                     serviceName: this.serviceName,
                 },

src/common/api-key/controllers/api-key.admin.controller.ts

@@ -92,26 +92,26 @@ export class ApiKeyAdminController {
         {
             page,
             perPage,
-            sort,
-            offset,
-            search,
-            availableSort,
-            availableSearch,
+            _sort,
+            _offset,
+            _search,
+            _availableSort,
+            _availableSearch,
         }: PaginationListDto,
         @PaginationQueryFilterInBoolean('isActive', API_KEY_DEFAULT_IS_ACTIVE)
         isActive: Record<string, any>
     ): Promise<IResponsePaging> {
         const find: Record<string, any> = {
-            ...search,
+            ..._search,
             ...isActive,
         };
 
         const apiKeys: ApiKeyEntity[] = await this.apiKeyService.findAll(find, {
             paging: {
                 limit: perPage,
-                offset,
+                offset: _offset,
             },
-            sort,
+            sort: _sort,
         });
         const totalData: number = await this.apiKeyService.getTotal(find);
         const totalPage: number = this.paginationService.totalPage(
@@ -124,8 +124,8 @@ export class ApiKeyAdminController {
             totalPage,
             currentPage: page,
             perPage,
-            availableSearch,
-            availableSort,
+            _availableSearch,
+            _availableSort,
             data: apiKeys,
         };
     }
@@ -165,7 +165,7 @@ export class ApiKeyAdminController {
             throw new InternalServerErrorException({
                 statusCode: ENUM_ERROR_STATUS_CODE_ERROR.ERROR_UNKNOWN,
                 message: 'http.serverError.internalServerError',
-                error: err.message,
+                _error: err.message,
             });
         }
     }
@@ -188,7 +188,7 @@ export class ApiKeyAdminController {
             throw new InternalServerErrorException({
                 statusCode: ENUM_ERROR_STATUS_CODE_ERROR.ERROR_UNKNOWN,
                 message: 'http.serverError.internalServerError',
-                error: err.message,
+                _error: err.message,
             });
         }
 
@@ -213,7 +213,7 @@ export class ApiKeyAdminController {
             throw new InternalServerErrorException({
                 statusCode: ENUM_ERROR_STATUS_CODE_ERROR.ERROR_UNKNOWN,
                 message: 'http.serverError.internalServerError',
-                error: err.message,
+                _error: err.message,
             });
         }
 
@@ -246,7 +246,7 @@ export class ApiKeyAdminController {
             throw new InternalServerErrorException({
                 statusCode: ENUM_ERROR_STATUS_CODE_ERROR.ERROR_UNKNOWN,
                 message: 'http.serverError.internalServerError',
-                error: err.message,
+                _error: err.message,
             });
         }
     }
@@ -271,7 +271,7 @@ export class ApiKeyAdminController {
             throw new InternalServerErrorException({
                 statusCode: ENUM_ERROR_STATUS_CODE_ERROR.ERROR_UNKNOWN,
                 message: 'http.serverError.internalServerError',
-                error: err.message,
+                _error: err.message,
             });
         }
 
@@ -299,7 +299,7 @@ export class ApiKeyAdminController {
             throw new InternalServerErrorException({
                 statusCode: ENUM_ERROR_STATUS_CODE_ERROR.ERROR_UNKNOWN,
                 message: 'http.serverError.internalServerError',
-                error: err.message,
+                _error: err.message,
             });
         }
 

src/common/api-key/docs/api-key.admin.doc.ts

@@ -25,8 +25,8 @@ export function ApiKeyListDoc(): MethodDecorator {
             },
             response: {
                 serialization: ApiKeyListSerialization,
-                availableSort: API_KEY_DEFAULT_AVAILABLE_SORT,
-                availableSearch: API_KEY_DEFAULT_AVAILABLE_SEARCH,
+                _availableSort: API_KEY_DEFAULT_AVAILABLE_SORT,
+                _availableSearch: API_KEY_DEFAULT_AVAILABLE_SEARCH,
             },
         })
     );

src/common/api-key/guards/x-api-key/api-key.x-api-key.guard.ts

@@ -7,6 +7,7 @@ import {
 } from '@nestjs/common';
 import { HelperNumberService } from 'src/common/helper/services/helper.number.service';
 import { ENUM_API_KEY_STATUS_CODE_ERROR } from 'src/common/api-key/constants/api-key.status-code.constant';
+import { BadRequestError } from 'passport-headerapikey';
 
 @Injectable()
 export class ApiKeyXApiKeyGuard extends AuthGuard('api-key') {
@@ -25,10 +26,8 @@ export class ApiKeyXApiKeyGuard extends AuthGuard('api-key') {
     ): IApiKeyPayload {
         if (err || !apiKey) {
             if (
-                (info instanceof Error &&
-                    info.name === 'BadRequestError' &&
-                    info.message === 'Missing API Key') ||
-                !apiKey
+                info instanceof BadRequestError &&
+                info.message === 'Missing API Key'
             ) {
                 throw new UnauthorizedException({
                     statusCode:

src/common/api-key/serializations/api-key.get.serialization.ts

@@ -57,5 +57,5 @@ export class ApiKeyGetSerialization {
     readonly updatedAt: Date;
 
     @Exclude()
-    readonly deletedAt: Date;
+    readonly deletedAt?: Date;
 }

src/common/api-key/services/api-key.service.ts

@@ -223,14 +223,14 @@ export class ApiKeyService implements IApiKeyService {
         _id: string,
         options?: IDatabaseSoftDeleteOptions
     ): Promise<ApiKeyEntity> {
-        return this.apiKeyRepository.deleteOneById(_id, options);
+        return this.apiKeyRepository.softDeleteOneById(_id, options);
     }
 
     async deleteOne(
         find: Record<string, any>,
         options?: IDatabaseSoftDeleteOptions
     ): Promise<ApiKeyEntity> {
-        return this.apiKeyRepository.deleteOne(find, options);
+        return this.apiKeyRepository.softDeleteOne(find, options);
     }
 
     async validateHashApiKey(

src/common/auth/constants/auth.enum.permission.constant.ts

@@ -12,6 +12,7 @@ export enum ENUM_AUTH_PERMISSIONS {
     USER_UPDATE = 'USER_UPDATE',
     USER_ACTIVE = 'USER_ACTIVE',
     USER_INACTIVE = 'USER_INACTIVE',
+    USER_BLOCKED = 'USER_BLOCKED',
     USER_DELETE = 'USER_DELETE',
     USER_IMPORT = 'USER_IMPORT',
     USER_EXPORT = 'USER_EXPORT',

src/common/auth/guards/jwt-access/auth.jwt-access.guard.ts

@@ -10,7 +10,7 @@ export class AuthJwtAccessGuard extends AuthGuard('jwt') {
                 statusCode:
                     ENUM_AUTH_STATUS_CODE_ERROR.AUTH_JWT_ACCESS_TOKEN_ERROR,
                 message: 'auth.error.accessTokenUnauthorized',
-                error: err ? err.message : info.message,
+                _error: err ? err.message : info.message,
             });
         }