feat: Add request body validation with DTOs & Swagger docs to the routes

package.json

@@ -34,6 +34,8 @@
     "@nestjs/swagger": "^7.3.1",
     "@prisma/client": "^5.13.0",
     "bcrypt": "^5.1.1",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.1",
     "date-fns": "^3.6.0",
     "passport-jwt": "^4.0.1",
     "reflect-metadata": "^0.2.0",

src/main.ts

@@ -6,6 +6,7 @@ import {
 import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
 
 import { AppModule } from './app.module';
+import { ValidationPipe } from '@nestjs/common';
 
 async function bootstrap() {
   const fastifyAdapter = new FastifyAdapter();
@@ -14,11 +15,20 @@ async function bootstrap() {
     fastifyAdapter,
   );
 
+  app.useGlobalPipes(
+    new ValidationPipe({
+      whitelist: true,
+      forbidNonWhitelisted: true,
+    }),
+  );
+
   const config = new DocumentBuilder()
     .setTitle('SOS - Rio Grande do Sul')
     .setDescription('...')
     .setVersion('1.0')
+    .addBearerAuth()
     .build();
+
   const document = SwaggerModule.createDocument(app, config);
   SwaggerModule.setup('api', app, document);
 

src/sessions/dtos/LoginSessionDTO.ts

@@ -0,0 +1,14 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsNotEmpty, IsString } from 'class-validator';
+
+export class LoginSessionDTO {
+  @ApiProperty({ type: 'string', example: 'John' })
+  @IsNotEmpty()
+  @IsString()
+  readonly login = '';
+
+  @ApiProperty({ type: 'string', example: 'john123' })
+  @IsNotEmpty()
+  @IsString()
+  readonly password = '';
+}

src/sessions/sessions.controller.ts

@@ -10,11 +10,19 @@ import {
   Request,
   UseGuards,
 } from '@nestjs/common';
-import { ApiTags } from '@nestjs/swagger';
+import {
+  ApiBadRequestResponse,
+  ApiBearerAuth,
+  ApiInternalServerErrorResponse,
+  ApiOkResponse,
+  ApiTags,
+  ApiUnauthorizedResponse,
+} from '@nestjs/swagger';
 
 import { UserGuard } from '@/guards/user.guard';
 import { ServerResponse } from '../utils';
 import { SessionsService } from './sessions.service';
+import { LoginSessionDTO } from './dtos/LoginSessionDTO';
 
 @ApiTags('Sessões')
 @Controller('sessions')
@@ -23,14 +31,17 @@ export class SessionsController {
 
   constructor(private readonly sessionService: SessionsService) {}
 
+  @ApiBadRequestResponse()
+  @ApiInternalServerErrorResponse()
+  @ApiOkResponse()
   @Post('')
   async login(
-    @Body() body,
+    @Body() body: LoginSessionDTO,
     @Headers('x-real-ip') ip: string,
     @Headers('user-agent') userAgent: string,
   ) {
     try {
-      const data = await this.sessionService.login({ ...body, ip, userAgent });
+      const data = await this.sessionService.login(body, ip, userAgent);
       return new ServerResponse(200, 'Successfully logged in', data);
     } catch (err: any) {
       this.logger.error(`Failed to login ${err}`);
@@ -41,6 +52,10 @@ export class SessionsController {
     }
   }
 
+  @ApiBearerAuth()
+  @ApiUnauthorizedResponse()
+  @ApiInternalServerErrorResponse()
+  @ApiOkResponse()
   @Get('')
   @UseGuards(UserGuard)
   async show(@Request() req) {
@@ -54,6 +69,10 @@ export class SessionsController {
     }
   }
 
+  @ApiBearerAuth()
+  @ApiUnauthorizedResponse()
+  @ApiInternalServerErrorResponse()
+  @ApiOkResponse()
   @Delete('')
   @UseGuards(UserGuard)
   async delete(@Request() req) {

src/sessions/sessions.service.ts

@@ -4,6 +4,7 @@ import * as bcrypt from 'bcrypt';
 
 import { PrismaService } from '../prisma/prisma.service';
 import { LoginSchema, TokenPayload } from './types';
+import { LoginSessionDTO } from './dtos/LoginSessionDTO';
 
 @Injectable()
 export class SessionsService {
@@ -12,8 +13,16 @@ export class SessionsService {
     private readonly jwtService: JwtService,
   ) {}
 
-  async login(body: any) {
-    const { login, password, ip, userAgent } = LoginSchema.parse(body);
+  async login(
+    body: LoginSessionDTO,
+    ipHeaders: string,
+    userAgentHeaders: string,
+  ) {
+    const { login, password, ip, userAgent } = LoginSchema.parse({
+      ...body,
+      ipHeaders,
+      userAgentHeaders,
+    });
     const user = await this.prismaService.user.findUnique({
       where: { login },
     });

src/shelter-managers/dtos/CreateShelterManagerDTO.ts

@@ -0,0 +1,14 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsNotEmpty, IsString } from 'class-validator';
+
+export class CreateShelterManagerDTO {
+  @ApiProperty({ type: 'string', example: 'ID do Abrigo' })
+  @IsNotEmpty()
+  @IsString()
+  readonly shelterId = '';
+
+  @ApiProperty({ type: 'string', example: 'ID do Usuário' })
+  @IsNotEmpty()
+  @IsString()
+  readonly userId = '';
+}

src/shelter-managers/shelter-managers.controller.ts

@@ -9,13 +9,22 @@ import {
   Query,
   UseGuards,
 } from '@nestjs/common';
-import { ApiTags } from '@nestjs/swagger';
+import {
+  ApiBadRequestResponse,
+  ApiBearerAuth,
+  ApiInternalServerErrorResponse,
+  ApiOkResponse,
+  ApiTags,
+  ApiUnauthorizedResponse,
+} from '@nestjs/swagger';
 
 import { ShelterManagersService } from './shelter-managers.service';
 import { ServerResponse } from '../utils';
 import { AdminGuard } from '@/guards/admin.guard';
+import { CreateShelterManagerDTO } from './dtos/CreateShelterManagerDTO';
 
 @ApiTags('Admin de Abrigo')
+@ApiInternalServerErrorResponse()
 @Controller('shelter/managers')
 export class ShelterManagersController {
   private logger = new Logger(ShelterManagersController.name);
@@ -24,9 +33,13 @@ export class ShelterManagersController {
     private readonly shelterManagerServices: ShelterManagersService,
   ) {}
 
+  @ApiBearerAuth()
+  @ApiUnauthorizedResponse()
+  @ApiBadRequestResponse()
+  @ApiOkResponse()
   @Post('')
   @UseGuards(AdminGuard)
-  async store(@Body() body) {
+  async store(@Body() body: CreateShelterManagerDTO) {
     try {
       await this.shelterManagerServices.store(body);
       return new ServerResponse(200, 'Successfully added manager to shelter');
@@ -36,6 +49,7 @@ export class ShelterManagersController {
     }
   }
 
+  @ApiOkResponse()
   @Get(':shelterId')
   async index(
     @Param('shelterId') shelterId: string,

src/shelter-managers/shelter-managers.service.ts

@@ -1,14 +1,14 @@
-import { z } from 'zod';
 import { Injectable } from '@nestjs/common';
 
 import { PrismaService } from '../prisma/prisma.service';
 import { CreateShelterManagerSchema } from './types';
+import { CreateShelterManagerDTO } from './dtos/CreateShelterManagerDTO';
 
 @Injectable()
 export class ShelterManagersService {
   constructor(private readonly prismaService: PrismaService) {}
 
-  async store(body: z.infer<typeof CreateShelterManagerSchema>) {
+  async store(body: CreateShelterManagerDTO) {
     const { shelterId, userId } = CreateShelterManagerSchema.parse(body);
     await this.prismaService.shelterManagers.create({
       data: {

src/shelter-supply/dtos/CreateShelterSupplyDTO.ts

@@ -0,0 +1,47 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Transform } from 'class-transformer';
+import {
+  IsEnum,
+  IsNotEmpty,
+  IsNumber,
+  IsOptional,
+  IsString,
+  Min,
+} from 'class-validator';
+import { SupplyPriority } from 'src/supply/types';
+
+export class CreateShelterSupplyDTO {
+  constructor() {
+    this.priority = SupplyPriority.UnderControl;
+  }
+
+  @ApiProperty({ type: 'string', example: 'ID do Abrigo' })
+  @IsNotEmpty()
+  @IsString()
+  readonly shelterId = '';
+
+  @ApiProperty({ type: 'string', example: 'ID do Suprimento' })
+  @IsNotEmpty()
+  @IsString()
+  readonly supplyId = '';
+
+  @ApiProperty({
+    description: 'Prioridade de suprimento',
+    enum: SupplyPriority,
+  })
+  @IsNotEmpty()
+  @IsEnum(SupplyPriority)
+  @Transform((value) => Number(value.value))
+  readonly priority: SupplyPriority;
+
+  @ApiProperty({
+    required: false,
+    type: 'number',
+    example: 1,
+  })
+  @IsOptional()
+  @IsNumber()
+  @Min(1)
+  @Transform((value) => Number(value.value))
+  readonly quantity?: number;
+}

src/shelter-supply/dtos/UpdateManyShelterSupplyDTO.ts

@@ -0,0 +1,14 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { ArrayMinSize, IsArray, IsNotEmpty, IsString } from 'class-validator';
+
+export class UpdateManyShelterSupplySchemaDTO {
+  @ApiProperty({
+    type: [String],
+    example: ['ID do Suprimento', 'ID do Suprimento 2'],
+  })
+  @IsArray()
+  @ArrayMinSize(1)
+  @IsNotEmpty()
+  @IsString({ each: true })
+  readonly ids!: string;
+}

src/shelter-supply/dtos/UpdateShelterSupplyDTO.ts

@@ -0,0 +1,27 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Transform } from 'class-transformer';
+import { IsEnum, IsOptional, IsNumber, Min } from 'class-validator';
+import { SupplyPriority } from 'src/supply/types';
+
+export class UpdateShelterSupplyDTO {
+  @ApiProperty({
+    required: false,
+    description: 'Prioridade de suprimento',
+    enum: SupplyPriority,
+  })
+  @IsOptional()
+  @IsEnum(SupplyPriority)
+  @Transform((value) => Number(value.value))
+  readonly priority?: SupplyPriority;
+
+  @ApiProperty({
+    required: false,
+    type: 'number',
+    example: 1,
+  })
+  @IsOptional()
+  @IsNumber()
+  @Min(1)
+  @Transform((value) => Number(value.value))
+  readonly quantity?: number;
+}