add generic crud

daniwebdev · daniwebdev · commit 26d8ba4b3cf8 · 2023-10-25T13:34:56.000+07:00
diff --git a/package.json b/package.json
@@ -36,6 +36,8 @@
     "@nestjs/platform-express": "^10.0.2",
     "@nestjs/swagger": "^7.1.13",
     "@nestjs/typeorm": "^10.0.0",
+    "@nestjsx/crud": "^5.0.0-alpha.3",
+    "@nestjsx/crud-typeorm": "^5.0.0-alpha.3",
     "@svtslv/nestjs-ioredis": "^1.0.2",
     "bcrypt": "^5.1.0",
     "cache-manager-redis-store": "^3.0.1",
@@ -44,6 +46,7 @@
     "ejs": "^3.1.8",
     "ioredis": "^5.3.2",
     "jsonwebtoken": "^9.0.1",
+    "nest-access-control": "^3.1.0",
     "nestjs-i18n": "^10.3.6",
     "passport": "^0.6.0",
     "passport-jwt": "^4.0.1",
diff --git a/src/admin/admin.module.ts b/src/admin/admin.module.ts
@@ -0,0 +1,13 @@
+import { Module } from "@nestjs/common";
+import { SwaggerModule } from "@nestjs/swagger";
+import { UserModule } from "src/apps/user/user.module";
+import { UsersModule } from "./users/users.module";
+import { RolesModule } from './roles/roles.module';
+
+@Module({
+    imports: [
+        UsersModule,
+        RolesModule,
+    ]
+})
+export class AdminModule {}
diff --git a/src/admin/admin.roles.ts b/src/admin/admin.roles.ts
@@ -0,0 +1,19 @@
+import { RolesBuilder } from 'nest-access-control';
+
+export enum AppRoles {
+  ADMIN = 'ADMIN',
+  EDITOR = 'EDITOR',
+}
+
+export const roles: RolesBuilder = new RolesBuilder();
+
+roles
+    .grant(AppRoles.EDITOR)
+    .create('jobs')
+    .update('jobs')
+    // admin
+    .grant(AppRoles.ADMIN)
+    .extend(AppRoles.EDITOR)
+    .create(['companies'])
+    .update(['companies'])
+    .delete(['companies', 'jobs']);
diff --git a/src/admin/roles/dto/create-role.dto.ts b/src/admin/roles/dto/create-role.dto.ts
@@ -0,0 +1,14 @@
+import { ApiProperty } from "@nestjsx/crud/lib/crud";
+import { Exclude } from "class-transformer";
+
+export class CreateRoleDto {
+
+    @ApiProperty({example: 'Admin'})
+    name: string;
+    
+    @ApiProperty({example: 'ADMIN'})
+    key: string;
+    
+    @ApiProperty()
+    description: string;
+}
diff --git a/src/admin/roles/dto/update-role.dto.ts b/src/admin/roles/dto/update-role.dto.ts
@@ -0,0 +1,4 @@
+import { PartialType } from '@nestjs/swagger';
+import { CreateRoleDto } from './create-role.dto';
+
+export class UpdateRoleDto extends PartialType(CreateRoleDto) {}
diff --git a/src/admin/roles/roles.controller.spec.ts b/src/admin/roles/roles.controller.spec.ts
@@ -0,0 +1,20 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { RolesController } from './roles.controller';
+import { RolesService } from './roles.service';
+
+describe('RolesController', () => {
+  let controller: RolesController;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      controllers: [RolesController],
+      providers: [RolesService],
+    }).compile();
+
+    controller = module.get<RolesController>(RolesController);
+  });
+
+  it('should be defined', () => {
+    expect(controller).toBeDefined();
+  });
+});
diff --git a/src/admin/roles/roles.controller.ts b/src/admin/roles/roles.controller.ts
@@ -0,0 +1,15 @@
+import { Controller, Get, Post, Body, Patch, Param, Delete } from '@nestjs/common';
+import { RolesService } from './roles.service';
+import { CreateRoleDto } from './dto/create-role.dto';
+import { UpdateRoleDto } from './dto/update-role.dto';
+import { ApiSecurity, ApiTags } from '@nestjs/swagger';
+import { BaseCrudController } from 'src/i18n/base-crud/base-crud.controller';
+
+@Controller('admin/roles')
+@ApiTags("Admin > Role")
+@ApiSecurity('api-key')
+export class RolesController extends BaseCrudController<CreateRoleDto, UpdateRoleDto> {
+  constructor(public readonly service: RolesService) {
+    super(service);
+  }
+}
diff --git a/src/admin/roles/roles.module.ts b/src/admin/roles/roles.module.ts
@@ -0,0 +1,14 @@
+import { Module } from '@nestjs/common';
+import { RolesService } from './roles.service';
+import { RolesController } from './roles.controller';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { Role } from 'src/entities/role.entity';
+
+@Module({
+  imports: [
+    TypeOrmModule.forFeature([Role])
+  ],
+  controllers: [RolesController],
+  providers: [RolesService],
+})
+export class RolesModule {}
diff --git a/src/admin/roles/roles.service.spec.ts b/src/admin/roles/roles.service.spec.ts
@@ -0,0 +1,18 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { RolesService } from './roles.service';
+
+describe('RolesService', () => {
+  let service: RolesService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [RolesService],
+    }).compile();
+
+    service = module.get<RolesService>(RolesService);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+});
diff --git a/src/admin/roles/roles.service.ts b/src/admin/roles/roles.service.ts
@@ -0,0 +1,19 @@
+import { Injectable } from '@nestjs/common';
+import { CreateRoleDto } from './dto/create-role.dto';
+import { UpdateRoleDto } from './dto/update-role.dto';
+import { Role } from 'src/entities/role.entity';
+import { InjectRepository } from '@nestjs/typeorm';
+import { Repository } from 'typeorm';
+import { IBaseService } from 'src/i18n/base-crud/base-service.interface';
+import { BaseCrudService } from 'src/i18n/base-crud/base-crud.service';
+
+@Injectable()
+// export class RolesService implements IBaseService<CreateRoleDto, UpdateRoleDto> {
+export class RolesService extends BaseCrudService<CreateRoleDto, UpdateRoleDto> implements IBaseService<CreateRoleDto, UpdateRoleDto> {
+  constructor(
+    @InjectRepository(Role) 
+    public roleRepository: Repository<Role>
+  ) {
+    super(roleRepository)
+  }
+}
diff --git a/src/admin/users/dto/create-user.dto.ts b/src/admin/users/dto/create-user.dto.ts
@@ -0,0 +1,21 @@
+import { ApiProperty } from "@nestjsx/crud/lib/crud";
+import { IsString, IsEmail, MinLength, Matches, IsNotEmpty } from 'class-validator';
+import { Match } from "src/common/decorators/validation.decorator";
+
+export class CreateUserDto {
+    @ApiProperty()
+    @IsString()
+    name: string;
+
+    @ApiProperty()
+    @IsEmail()
+    email: string;
+    
+    @ApiProperty()
+    @MinLength(8)
+    password: string;
+    
+    @ApiProperty()
+    @Match('password', { message: 'Confirm password must match the password'})
+    confirmPassword: string;
+}
diff --git a/src/admin/users/dto/update-user.dto.ts b/src/admin/users/dto/update-user.dto.ts
@@ -0,0 +1,6 @@
+import { PartialType } from '@nestjs/swagger';
+import { CreateUserDto } from './create-user.dto';
+
+export class UpdateUserDto extends PartialType(CreateUserDto) {
+    
+}
diff --git a/src/admin/users/users.controller.ts b/src/admin/users/users.controller.ts
@@ -0,0 +1,37 @@
+import { Controller, Get, Post, Body, Patch, Param, Delete } from '@nestjs/common';
+import { UsersService } from './users.service';
+import { CreateUserDto } from './dto/create-user.dto';
+import { UpdateUserDto } from './dto/update-user.dto';
+import { ApiSecurity, ApiTags } from '@nestjs/swagger';
+
+@Controller('admin/users')
+@ApiSecurity('api-key')
+@ApiTags("Admin > Users")
+export class UsersController {
+  constructor(private readonly usersService: UsersService) {}
+
+  @Post()
+  create(@Body() createUserDto: CreateUserDto) {
+    return this.usersService.create(createUserDto);
+  }
+
+  @Get()
+  findAll() {
+    return this.usersService.findAll();
+  }
+
+  @Get(':id')
+  findOne(@Param('id') id: string) {
+    return this.usersService.findOne(+id);
+  }
+
+  @Patch(':id')
+  update(@Param('id') id: string, @Body() updateUserDto: UpdateUserDto) {
+    return this.usersService.update(+id, updateUserDto);
+  }
+
+  @Delete(':id')
+  remove(@Param('id') id: string) {
+    return this.usersService.remove(+id);
+  }
+}
diff --git a/src/admin/users/users.module.ts b/src/admin/users/users.module.ts
@@ -0,0 +1,14 @@
+import { Module } from '@nestjs/common';
+import { UsersService } from './users.service';
+import { UsersController } from './users.controller';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { User } from 'src/entities/user.entity';
+
+@Module({
+  imports: [
+    TypeOrmModule.forFeature([User]),
+  ],
+  controllers: [UsersController],
+  providers: [UsersService],
+})
+export class UsersModule {}
diff --git a/src/admin/users/users.service.ts b/src/admin/users/users.service.ts
@@ -0,0 +1,46 @@
+import { Injectable } from '@nestjs/common';
+import { CreateUserDto } from './dto/create-user.dto';
+import { UpdateUserDto } from './dto/update-user.dto';
+import { InjectRepository } from '@nestjs/typeorm';
+import { User } from 'src/entities/user.entity';
+import { Repository } from 'typeorm';
+import { hash } from 'bcrypt';
+
+@Injectable()
+export class UsersService {
+
+  constructor(
+    @InjectRepository(User) 
+    private userRepository: Repository<User>
+  ) {}
+
+
+  get repo() { return this.userRepository; }
+
+  async create(createUserDto: CreateUserDto) {
+    const { password, ...rest } = createUserDto;
+    const hashedPassword = await hash(password, 10);
+    const newUser = this.repo.create({ password: hashedPassword, ...rest });
+    const createdUser = await this.repo.save(newUser);
+    return createdUser;
+  }
+
+  findAll() {
+
+    return this.repo.find();
+  }
+
+  findOne(id: number) {
+    return this.repo.findOne({where: {id}});
+  }
+
+  async update(id: number, updateUserDto: UpdateUserDto) {
+
+    return await this.repo.update(id, updateUserDto);
+  }
+
+  remove(id: number) {
+    // delete with typeorm
+    return this.repo.delete(id);
+  }
+}
diff --git a/src/apps/app.module.ts b/src/apps/app.module.ts
@@ -10,6 +10,9 @@ import { FileModule } from './file/file.module';
 import { I18nModule, QueryResolver, HeaderResolver, AcceptLanguageResolver } from 'nestjs-i18n'
 import { join } from 'path';
 import { ConfigModule as AppConfigModule } from './config/config.module';
+import { UsersModule } from 'src/admin/users/users.module';
+import { AdminModule } from 'src/admin/admin.module';
+import { UserModule } from './user/user.module';
 @Module({
   imports: [
     ConfigModule.forRoot({
@@ -38,7 +41,8 @@ import { ConfigModule as AppConfigModule } from './config/config.module';
     }),
     AuthModule,
     FileModule,
-    AppConfigModule
+    AppConfigModule,
+    AdminModule,
   ],
   controllers: [AppController],
   providers: [AppService],
diff --git a/src/apps/user/user.controller.ts b/src/apps/user/user.controller.ts
@@ -4,6 +4,7 @@ import { UseJwtGuard } from 'src/common/guards/jwt.guard';
 import { Response } from 'src/common/utils';
 import { UpdateUserDTO } from './update-user.dto';
 import { UserService } from './user.service';
+import { ApiNotAcceptableResponse, ApiTags } from '@nestjs/swagger';
 
 @Controller('user')
 @UseJwtGuard()
diff --git a/src/common/decorators/validation.decorator.ts b/src/common/decorators/validation.decorator.ts
@@ -0,0 +1,24 @@
+import {registerDecorator, ValidationArguments, ValidationOptions, ValidatorConstraint, ValidatorConstraintInterface} from 'class-validator';
+
+export function Match(property: string, validationOptions?: ValidationOptions) {
+    return (object: any, propertyName: string) => {
+        registerDecorator({
+            target: object.constructor,
+            propertyName,
+            options: validationOptions,
+            constraints: [property],
+            validator: MatchConstraint,
+        });
+    };
+}
+
+@ValidatorConstraint({name: 'Match'})
+export class MatchConstraint implements ValidatorConstraintInterface {
+
+    validate(value: any, args: ValidationArguments) {
+        const [relatedPropertyName] = args.constraints;
+        const relatedValue = (args.object as any)[relatedPropertyName];
+        return value === relatedValue;
+    }
+
+}
diff --git a/src/entities/role.entity.ts b/src/entities/role.entity.ts
@@ -26,4 +26,3 @@ export class Role {
     @OneToMany(type => RoleToPermission, roleToPermission => roleToPermission.role)
     permissions: RoleToPermission[];
 }
-
diff --git a/src/i18n/base-crud/base-crud.controller.ts b/src/i18n/base-crud/base-crud.controller.ts
@@ -0,0 +1,33 @@
+import { Controller, Get, Post, Body, Patch, Param, Delete } from '@nestjs/common';
+import { ApiSecurity, ApiTags } from '@nestjs/swagger';
+import { IBaseService } from './base-service.interface';
+
+
+export abstract class BaseCrudController<CreateDTO, UpdateDTO> {
+  constructor(public readonly service: IBaseService<CreateDTO, UpdateDTO>) {}
+
+  @Post()
+  create(@Body() createRoleDto: CreateDTO) {
+    return this.service.create(createRoleDto);
+  }
+
+  @Get()
+  findAll() {
+    return this.service.findAll();
+  }
+
+  @Get(':id')
+  findOne(@Param('id') id: string) {
+    return this.service.findOne(+id);
+  }
+
+  @Patch(':id')
+  update(@Param('id') id: string, @Body() updateRoleDto: UpdateDTO) {
+    return this.service.update(+id, updateRoleDto);
+  }
+
+  @Delete(':id')
+  remove(@Param('id') id: string) {
+    return this.service.remove(+id);
+  }
+}
diff --git a/src/i18n/base-crud/base-crud.service.ts b/src/i18n/base-crud/base-crud.service.ts
diff --git a/src/i18n/base-crud/base-service.interface.ts b/src/i18n/base-crud/base-service.interface.ts
diff --git a/src/main.ts b/src/main.ts
diff --git a/yarn.lock b/yarn.lock
