Merge pull request #360 from andrechristikan/development

andrechristikan · web-flow · commit 95f31201ab37 · 2023-01-12T13:29:10.000+07:00
Development
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ack-nestjs-boilerplate",
-  "version": "4.1.4",
+  "version": "4.1.5",
   "description": "Ack NestJs Boilerplate",
   "repository": {
     "type": "git",
diff --git a/src/common/auth/constants/auth.enum.permission.constant.ts b/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',
diff --git a/src/modules/user/constants/user.constant.ts b/src/modules/user/constants/user.constant.ts
@@ -1 +1,2 @@
 export const USER_ACTIVE_META_KEY = 'UserActiveMetaKey';
+export const USER_BLOCKED_META_KEY = 'UserBlockedMetaKey';
diff --git a/src/modules/user/constants/user.status-code.constant.ts b/src/modules/user/constants/user.status-code.constant.ts
@@ -9,4 +9,5 @@ export enum ENUM_USER_STATUS_CODE_ERROR {
     USER_PASSWORD_NEW_MUST_DIFFERENCE_ERROR = 5407,
     USER_PASSWORD_EXPIRED_ERROR = 5408,
     USER_PASSWORD_ATTEMPT_MAX_ERROR = 5409,
+    USER_BLOCKED_ERROR = 5410,
 }
diff --git a/src/modules/user/controllers/user.admin.controller.ts b/src/modules/user/controllers/user.admin.controller.ts
@@ -44,12 +44,14 @@ import {
     UserDeleteGuard,
     UserGetGuard,
     UserUpdateActiveGuard,
+    UserUpdateBlockedGuard,
     UserUpdateGuard,
     UserUpdateInactiveGuard,
 } from 'src/modules/user/decorators/user.admin.decorator';
 import { GetUser } from 'src/modules/user/decorators/user.decorator';
 import {
     UserActiveDoc,
+    UserBlockedDoc,
     UserCreateDoc,
     UserDeleteDoc,
     UserExportDoc,
@@ -385,4 +387,29 @@ export class UserAdminController {
     async export(): Promise<IResponse> {
         return this.userService.findAll({});
     }
+
+    @UserBlockedDoc()
+    @Response('user.blocked')
+    @UserUpdateBlockedGuard()
+    @RequestParamGuard(UserRequestDto)
+    @AuthPermissionProtected(
+        ENUM_AUTH_PERMISSIONS.USER_READ,
+        ENUM_AUTH_PERMISSIONS.USER_UPDATE,
+        ENUM_AUTH_PERMISSIONS.USER_BLOCKED
+    )
+    @AuthJwtAdminAccessProtected()
+    @Patch('/update/:user/blocked')
+    async blocked(@GetUser() user: IUserEntity): Promise<void> {
+        try {
+            await this.userService.blocked(user._id);
+        } catch (err: any) {
+            throw new InternalServerErrorException({
+                statusCode: ENUM_ERROR_STATUS_CODE_ERROR.ERROR_UNKNOWN,
+                message: 'http.serverError.internalServerError',
+                error: err.message,
+            });
+        }
+
+        return;
+    }
 }
diff --git a/src/modules/user/controllers/user.controller.ts b/src/modules/user/controllers/user.controller.ts
@@ -2,6 +2,7 @@ import {
     BadRequestException,
     Body,
     Controller,
+    Delete,
     ForbiddenException,
     Get,
     HttpCode,
@@ -38,6 +39,7 @@ import { ENUM_ROLE_STATUS_CODE_ERROR } from 'src/modules/role/constants/role.sta
 import { ENUM_USER_STATUS_CODE_ERROR } from 'src/modules/user/constants/user.status-code.constant';
 import { GetUser } from 'src/modules/user/decorators/user.decorator';
 import { UserProfileGuard } from 'src/modules/user/decorators/user.public.decorator';
+import { UserDeleteDoc } from 'src/modules/user/docs/user.admin.doc';
 import {
     UserChangePasswordDoc,
     UserGrantPermissionDoc,
@@ -493,4 +495,22 @@ export class UserController {
 
         return;
     }
+
+    @UserDeleteDoc()
+    @Response('user.delete')
+    @AuthJwtAccessProtected()
+    @Delete('/delete')
+    async delete(@AuthJwtPayload('_id') _id: string): Promise<void> {
+        try {
+            await this.userService.inactive(_id);
+        } catch (err: any) {
+            throw new InternalServerErrorException({
+                statusCode: ENUM_ERROR_STATUS_CODE_ERROR.ERROR_UNKNOWN,
+                message: 'http.serverError.internalServerError',
+                error: err.message,
+            });
+        }
+
+        return;
+    }
 }
diff --git a/src/modules/user/decorators/user.admin.decorator.ts b/src/modules/user/decorators/user.admin.decorator.ts
@@ -1,6 +1,10 @@
 import { applyDecorators, SetMetadata, UseGuards } from '@nestjs/common';
-import { USER_ACTIVE_META_KEY } from 'src/modules/user/constants/user.constant';
+import {
+    USER_ACTIVE_META_KEY,
+    USER_BLOCKED_META_KEY,
+} from 'src/modules/user/constants/user.constant';
 import { UserActiveGuard } from 'src/modules/user/guards/user.active.guard';
+import { UserBlockedGuard } from 'src/modules/user/guards/user.blocked.guard';
 import { UserNotFoundGuard } from 'src/modules/user/guards/user.not-found.guard';
 import { UserPutToRequestGuard } from 'src/modules/user/guards/user.put-to-request.guard';
 
@@ -29,3 +33,10 @@ export function UserUpdateActiveGuard(): MethodDecorator {
         SetMetadata(USER_ACTIVE_META_KEY, [false])
     );
 }
+
+export function UserUpdateBlockedGuard(): MethodDecorator {
+    return applyDecorators(
+        UseGuards(UserPutToRequestGuard, UserNotFoundGuard, UserBlockedGuard),
+        SetMetadata(USER_BLOCKED_META_KEY, [false])
+    );
+}
diff --git a/src/modules/user/docs/user.admin.doc.ts b/src/modules/user/docs/user.admin.doc.ts
@@ -145,3 +145,17 @@ export function UserInactiveDoc(): MethodDecorator {
         })
     );
 }
+
+export function UserBlockedDoc(): MethodDecorator {
+    return applyDecorators(
+        Doc<void>('user.blocked', {
+            auth: {
+                jwtAccessToken: true,
+                permissionToken: true,
+            },
+            request: {
+                params: UserDocParamsGet,
+            },
+        })
+    );
+}
diff --git a/src/modules/user/docs/user.doc.ts b/src/modules/user/docs/user.doc.ts
@@ -96,3 +96,13 @@ export function UserGrantPermissionDoc(): MethodDecorator {
         })
     );
 }
+
+export function UserDeleteDoc(): MethodDecorator {
+    return applyDecorators(
+        Doc<void>('user.delete', {
+            auth: {
+                jwtAccessToken: true,
+            },
+        })
+    );
+}
diff --git a/src/modules/user/dtos/user.block.dto.ts b/src/modules/user/dtos/user.block.dto.ts
@@ -0,0 +1,7 @@
+import { IsBoolean, IsNotEmpty } from 'class-validator';
+
+export class UserBlockedDto {
+    @IsBoolean()
+    @IsNotEmpty()
+    blocked: boolean;
+}
diff --git a/src/modules/user/guards/user.blocked.guard.ts b/src/modules/user/guards/user.blocked.guard.ts
@@ -0,0 +1,35 @@
+import {
+    Injectable,
+    CanActivate,
+    ExecutionContext,
+    BadRequestException,
+} from '@nestjs/common';
+import { Reflector } from '@nestjs/core';
+import { USER_BLOCKED_META_KEY } from 'src/modules/user/constants/user.constant';
+import { ENUM_USER_STATUS_CODE_ERROR } from 'src/modules/user/constants/user.status-code.constant';
+
+@Injectable()
+export class UserBlockedGuard implements CanActivate {
+    constructor(private reflector: Reflector) {}
+
+    async canActivate(context: ExecutionContext): Promise<boolean> {
+        const required: boolean[] = this.reflector.getAllAndOverride<boolean[]>(
+            USER_BLOCKED_META_KEY,
+            [context.getHandler(), context.getClass()]
+        );
+
+        if (!required) {
+            return true;
+        }
+
+        const { __user } = context.switchToHttp().getRequest();
+
+        if (!required.includes(__user.blocked)) {
+            throw new BadRequestException({
+                statusCode: ENUM_USER_STATUS_CODE_ERROR.USER_BLOCKED_ERROR,
+                message: 'user.error.blocked',
+            });
+        }
+        return true;
+    }
+}
diff --git a/src/modules/user/interfaces/user.service.interface.ts b/src/modules/user/interfaces/user.service.interface.ts
@@ -100,6 +100,8 @@ export interface IUserService {
 
     inactive(_id: string, options?: IDatabaseOptions): Promise<UserEntity>;
 
+    blocked(_id: string, options?: IDatabaseOptions): Promise<UserEntity>;
+
     maxPasswordAttempt(
         _id: string,
         options?: IDatabaseOptions
diff --git a/src/modules/user/repository/entities/user.entity.ts b/src/modules/user/repository/entities/user.entity.ts
@@ -106,6 +106,14 @@ export class UserEntity extends DatabaseMongoUUIDEntityAbstract {
     })
     isActive: boolean;
 
+    @Prop({
+        required: true,
+        default: false,
+        index: true,
+        type: Boolean,
+    })
+    blocked: boolean;
+
     @Prop({
         required: false,
         _id: false,
diff --git a/src/modules/user/serializations/user.get.serialization.ts b/src/modules/user/serializations/user.get.serialization.ts
@@ -16,14 +16,14 @@ export class UserGetSerialization {
     readonly role: RoleGetSerialization;
 
     @ApiProperty({
-        example: faker.internet.email(),
+        example: faker.internet.userName(),
     })
-    readonly email: string;
+    readonly username: string;
 
     @ApiProperty({
-        example: faker.internet.userName(),
+        example: faker.internet.email(),
     })
-    readonly username: string;
+    readonly email: string;
 
     @ApiProperty({
         example: faker.internet.email(),
@@ -35,6 +35,11 @@ export class UserGetSerialization {
     })
     readonly isActive: boolean;
 
+    @ApiProperty({
+        example: false,
+    })
+    readonly blocked: boolean;
+
     @ApiProperty({
         example: faker.name.firstName(),
     })
diff --git a/src/modules/user/serializations/user.list.serialization.ts b/src/modules/user/serializations/user.list.serialization.ts
@@ -7,6 +7,8 @@ export class UserListSerialization extends OmitType(UserGetSerialization, [
     'role',
     'photo',
     'passwordExpired',
+    'passwordAttempt',
+    'signUpDate',
 ] as const) {
     @Exclude()
     readonly role: string;
@@ -16,4 +18,10 @@ export class UserListSerialization extends OmitType(UserGetSerialization, [
 
     @Exclude()
     readonly passwordExpired: Date;
+
+    @Exclude()
+    readonly passwordAttempt: number;
+
+    @Exclude()
+    readonly signUpDate: Date;
 }
diff --git a/src/modules/user/serializations/user.payload.serialization.ts b/src/modules/user/serializations/user.payload.serialization.ts
@@ -9,6 +9,7 @@ export class UserPayloadSerialization extends OmitType(UserGetSerialization, [
     'photo',
     'role',
     'isActive',
+    'blocked',
     'email',
     'mobileNumber',
     'passwordExpired',
@@ -37,6 +38,9 @@ export class UserPayloadSerialization extends OmitType(UserGetSerialization, [
     @Exclude()
     readonly isActive: boolean;
 
+    @Exclude()
+    readonly blocked: boolean;
+
     @Exclude()
     readonly passwordExpired: Date;
 
diff --git a/src/modules/user/services/user.service.ts b/src/modules/user/services/user.service.ts
@@ -29,6 +29,7 @@ import { plainToInstance } from 'class-transformer';
 import { PermissionEntity } from 'src/modules/permission/repository/entities/permission.entity';
 import { UserPayloadPermissionSerialization } from 'src/modules/user/serializations/user.payload-permission.serialization';
 import { ENUM_PERMISSION_GROUP } from 'src/modules/permission/constants/permission.enum.constant';
+import { UserBlockedDto } from 'src/modules/user/dtos/user.block.dto';
 
 @Injectable()
 export class UserService implements IUserService {
@@ -239,6 +240,20 @@ export class UserService implements IUserService {
         );
     }
 
+    async blocked(
+        _id: string,
+        options?: IDatabaseOptions
+    ): Promise<UserEntity> {
+        const dto: UserBlockedDto = new UserBlockedDto();
+        dto.blocked = true;
+
+        return this.userRepository.updateOneById<UserBlockedDto>(
+            _id,
+            dto,
+            options
+        );
+    }
+
     async maxPasswordAttempt(
         _id: string,
         options?: IDatabaseOptions

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "ack-nestjs-boilerplate",`
`3`		`- "version": "4.1.4",`
	`3`	`+ "version": "4.1.5",`
`4`	`4`	`"description": "Ack NestJs Boilerplate",`
`5`	`5`	`"repository": {`
`6`	`6`	`"type": "git",`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`export const USER_ACTIVE_META_KEY = 'UserActiveMetaKey';`
	`2`	`+export const USER_BLOCKED_META_KEY = 'UserBlockedMetaKey';`
Original file line number	Diff line number	Diff line change
`@@ -9,4 +9,5 @@ export enum ENUM_USER_STATUS_CODE_ERROR {`
`9`	`9`	`USER_PASSWORD_NEW_MUST_DIFFERENCE_ERROR = 5407,`
`10`	`10`	`USER_PASSWORD_EXPIRED_ERROR = 5408,`
`11`	`11`	`USER_PASSWORD_ATTEMPT_MAX_ERROR = 5409,`
	`12`	`+ USER_BLOCKED_ERROR = 5410,`
`12`	`13`	`}`