feat: add req body validation & swagger docs to shelters routes

Author: ocsoares

src/shelter/dtos/CreateShelterDTO.ts

@@ -0,0 +1,62 @@
+import {
+  IsOptional,
+  IsString,
+  IsBoolean,
+  IsNumber,
+  Min,
+  IsNotEmpty,
+} from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+
+export class CreateShelterDTO {
+  @ApiProperty({ type: 'string', example: 'Nome do Abrigo' })
+  @IsNotEmpty()
+  @IsString()
+  readonly name = '';
+
+  @ApiProperty({ required: false, type: 'string', example: 'PIX do Abrigo' })
+  @IsOptional()
+  @IsString()
+  readonly pix?: string;
+
+  @ApiProperty({ type: 'string', example: 'Endereço do Abrigo' })
+  @IsNotEmpty()
+  @IsString()
+  readonly address = '';
+
+  @ApiProperty({ required: false, type: 'boolean', example: true })
+  @IsOptional()
+  @IsBoolean()
+  readonly petFriendly?: boolean;
+
+  @ApiProperty({ required: false, type: 'number', example: 10 })
+  @IsOptional()
+  @IsNumber()
+  @Min(0)
+  readonly shelteredPeople?: number;
+
+  @ApiProperty({ required: false, type: 'number', example: 123.456 })
+  @IsOptional()
+  @IsNumber()
+  readonly latitude?: number;
+
+  @ApiProperty({ required: false, type: 'number', example: 654.321 })
+  @IsOptional()
+  @IsNumber()
+  readonly longitude?: number;
+
+  @ApiProperty({ required: false, type: 'number', example: 50 })
+  @IsOptional()
+  @IsNumber()
+  @Min(0)
+  readonly capacity?: number;
+
+  @ApiProperty({
+    required: false,
+    type: 'string',
+    example: 'Contato do Abrigo',
+  })
+  @IsOptional()
+  @IsString()
+  readonly contact?: string;
+}

src/shelter/dtos/ShelterQuerysDTO.ts

@@ -0,0 +1,74 @@
+import { IsOptional, IsString, IsNumber, IsIn, IsEnum } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+import { SupplyPriority } from 'src/supply/types';
+import { Transform } from 'class-transformer';
+
+export class ShelterQueryDTO {
+  @ApiProperty({
+    required: false,
+    description: 'Quantidade de resultados por página',
+  })
+  @IsOptional()
+  @IsNumber()
+  @Transform((value) => Number(value.value))
+  perPage?: number;
+
+  @ApiProperty({ required: false, description: 'Número da página' })
+  @IsOptional()
+  @IsNumber()
+  @Transform((value) => Number(value.value))
+  page?: number;
+
+  @ApiProperty({ required: false, description: 'Termo de busca' })
+  @IsOptional()
+  @IsString()
+  search?: string;
+
+  @ApiProperty({
+    required: false,
+    description: 'Ordem dos resultados',
+    enum: ['asc', 'desc'],
+  })
+  @IsOptional()
+  @IsIn(['asc', 'desc'])
+  order?: 'asc' | 'desc';
+
+  @ApiProperty({
+    required: false,
+    description: 'Critério de ordenação dos resultados',
+  })
+  @IsOptional()
+  @IsString()
+  orderBy?: string;
+
+  @ApiProperty({
+    required: false,
+    description: 'IDs de categoria de suprimento',
+  })
+  @IsOptional()
+  @IsString({ each: true })
+  supplyCategoryIds?: string[];
+
+  @ApiProperty({
+    required: false,
+    description: 'Prioridade de suprimento',
+    enum: SupplyPriority,
+  })
+  @IsOptional()
+  @IsEnum(SupplyPriority)
+  @Transform((value) => Number(value.value))
+  priority?: SupplyPriority;
+
+  @ApiProperty({ required: false, description: 'IDs de suprimento' })
+  @IsOptional()
+  @IsString({ each: true })
+  supplyIds?: string[];
+
+  @ApiProperty({
+    required: false,
+    description: 'Status do abrigo',
+  })
+  @IsOptional()
+  @IsIn(['available', 'unavailable', 'waiting'], { each: true })
+  shelterStatus?: ('available' | 'unavailable' | 'waiting')[]; // MUDAR !!!!
+}

src/shelter/dtos/UpdateShelterDTO.ts

@@ -0,0 +1,7 @@
+import { PickType } from '@nestjs/swagger';
+import { CreateShelterDTO } from './CreateShelterDTO';
+
+export class UpdateShelterDTO extends PickType(CreateShelterDTO, [
+  'petFriendly',
+  'shelteredPeople',
+]) {}

src/shelter/shelter.controller.ts

@@ -10,23 +10,36 @@ import {
   Query,
   UseGuards,
 } from '@nestjs/common';
-import { ApiTags } from '@nestjs/swagger';
+import {
+  ApiBadRequestResponse,
+  ApiBearerAuth,
+  ApiInternalServerErrorResponse,
+  ApiOkResponse,
+  ApiTags,
+  ApiUnauthorizedResponse,
+} from '@nestjs/swagger';
 
 import { ShelterService } from './shelter.service';
 import { ServerResponse } from '../utils';
 import { StaffGuard } from '@/guards/staff.guard';
 import { ApplyUser } from '@/guards/apply-user.guard';
 import { UserDecorator } from '@/decorators/UserDecorator/user.decorator';
+import { ShelterQueryDTO } from './dtos/ShelterQuerysDTO';
+import { CreateShelterDTO } from './dtos/CreateShelterDTO';
+import { UpdateShelterDTO } from './dtos/UpdateShelterDTO';
 
 @ApiTags('Abrigos')
+@ApiInternalServerErrorResponse()
 @Controller('shelters')
 export class ShelterController {
   private logger = new Logger(ShelterController.name);
 
   constructor(private readonly shelterService: ShelterService) {}
 
+  @ApiBadRequestResponse()
+  @ApiOkResponse()
   @Get('')
-  async index(@Query() query) {
+  async index(@Query() query: ShelterQueryDTO) {
     try {
       const data = await this.shelterService.index(query);
       return new ServerResponse(200, 'Successfully get shelters', data);
@@ -36,6 +49,8 @@ export class ShelterController {
     }
   }
 
+  @ApiBadRequestResponse()
+  @ApiOkResponse()
   @Get('cities')
   async cities() {
     try {
@@ -47,6 +62,8 @@ export class ShelterController {
     }
   }
 
+  @ApiBearerAuth()
+  @ApiOkResponse()
   @Get(':id')
   @UseGuards(ApplyUser)
   async show(@UserDecorator() user: any, @Param('id') id: string) {
@@ -61,9 +78,13 @@ export class ShelterController {
     }
   }
 
+  @ApiBearerAuth()
+  @ApiUnauthorizedResponse()
+  @ApiBadRequestResponse()
+  @ApiOkResponse()
   @Post('')
   @UseGuards(StaffGuard)
-  async store(@Body() body) {
+  async store(@Body() body: CreateShelterDTO) {
     try {
       const data = await this.shelterService.store(body);
       return new ServerResponse(200, 'Successfully created shelter', data);
@@ -73,8 +94,10 @@ export class ShelterController {
     }
   }
 
+  @ApiBadRequestResponse()
+  @ApiOkResponse()
   @Put(':id')
-  async update(@Param('id') id: string, @Body() body) {
+  async update(@Param('id') id: string, @Body() body: UpdateShelterDTO) {
     try {
       const data = await this.shelterService.update(id, body);
       return new ServerResponse(200, 'Successfully updated shelter', data);
@@ -84,9 +107,13 @@ export class ShelterController {
     }
   }
 
+  @ApiBearerAuth()
+  @ApiUnauthorizedResponse()
+  @ApiBadRequestResponse()
+  @ApiOkResponse()
   @Put(':id/admin')
   @UseGuards(StaffGuard)
-  async fullUpdate(@Param('id') id: string, @Body() body) {
+  async fullUpdate(@Param('id') id: string, @Body() body: UpdateShelterDTO) {
     try {
       const data = await this.shelterService.fullUpdate(id, body);
       return new ServerResponse(200, 'Successfully updated shelter', data);

src/shelter/shelter.service.ts

@@ -5,16 +5,19 @@ import * as qs from 'qs';
 import { z } from 'zod';
 
 import { PrismaService } from '../prisma/prisma.service';
-import { SupplyPriority } from '../supply/types';
-import { SearchSchema } from '../types';
-import { ShelterSearch, parseTagResponse } from './ShelterSearch';
-import { ShelterSearchPropsSchema } from './types/search.types';
 import {
   CreateShelterSchema,
   FullUpdateShelterSchema,
   UpdateShelterSchema,
 } from './types/types';
 import { subDays } from 'date-fns';
+import { SupplyPriority } from 'src/supply/types';
+import { SearchSchema } from 'src/types';
+import { ShelterSearch, parseTagResponse } from './ShelterSearch';
+import { CreateShelterDTO } from './dtos/CreateShelterDTO';
+import { ShelterQueryDTO } from './dtos/ShelterQuerysDTO';
+import { UpdateShelterDTO } from './dtos/UpdateShelterDTO';
+import { ShelterSearchPropsSchema } from './types/search.types';
 
 @Injectable()
 export class ShelterService {
@@ -24,7 +27,7 @@ export class ShelterService {
     this.loadVoluntaryIds();
   }
 
-  async store(body: z.infer<typeof CreateShelterSchema>) {
+  async store(body: CreateShelterDTO) {
     const payload = CreateShelterSchema.parse(body);
 
     await this.prismaService.shelter.create({
@@ -36,7 +39,7 @@ export class ShelterService {
     });
   }
 
-  async update(id: string, body: z.infer<typeof UpdateShelterSchema>) {
+  async update(id: string, body: UpdateShelterDTO) {
     const payload = UpdateShelterSchema.parse(body);
     await this.prismaService.shelter.update({
       where: {
@@ -114,7 +117,8 @@ export class ShelterService {
     return data;
   }
 
-  async index(query: any) {
+  // ARRUMAR o queryData
+  async index(query: ShelterQueryDTO) {
     const {
       order,
       orderBy,