[CHORE] improvements for transport layer documentation

src/config/client.module.ts

@@ -4,7 +4,7 @@ import { ClientWriterService } from '@/domain/interactor/client/client-writer.se
 import { ClientReaderServicePort } from '@/domain/interactor/port/client/client-reader-service.port';
 import { ClientWriterServicePort } from '@/domain/interactor/port/client/client-writer-service.port';
 import { IClientRepository } from '@/domain/repository/client/client.repository';
-import { ClientController } from '@/transport/controller/client/client.controller';
+import { ClientController } from '@/transport/controller/client.controller';
 import { Module } from '@nestjs/common';
 import { PrismaService } from './prisma.config';
 

src/config/payment.module.ts

@@ -3,7 +3,7 @@ import { PaymentWriterService } from '@/domain/interactor/payment/payment-writer
 import { PaymentWriterServicePort } from '@/domain/interactor/port/payment/payment-writer-service.port';
 import { IPaymentRepository } from '@/domain/repository/payment/payment.repository';
 import { PrismaPaymentRepository } from '@/infrastructure/persistence/prisma/prisma-payment.repository';
-import { PaymentController } from '@/transport/controller/payment/payment.controller';
+import { PaymentController } from '@/transport/controller/payment.controller';
 import { Module } from '@nestjs/common';
 
 @Module({

src/config/product.module.ts

@@ -2,7 +2,7 @@ import { ProductInMemoryAdapter } from '@/datasource/adapter/product-in-memory.a
 import { ProductReaderServicePort } from '@/domain/interactor/port/product/product-reader-service.port';
 import { ProductService } from '@/domain/interactor/product/product.service';
 import { IProductRepository } from '@/domain/repository/product/product.repository';
-import { ProductController } from '@/transport/controller/product/product.controller';
+import { ProductController } from '@/transport/controller/product.controller';
 import { Module } from '@nestjs/common';
 
 @Module({

src/datasource/adapter/client/client-postgre.adapter.ts

@@ -1,8 +1,8 @@
 import { PrismaService } from '@/config/prisma.config';
 import { Client } from '@/domain/entity/client/client.entity';
 import { IClientRepository } from '@/domain/repository/client/client.repository';
-import { CreateClientDto } from '@/transport/dto/Client/create-client.dto';
-import { UpdateClientDto } from '@/transport/dto/Client/update-client.dto';
+import { CreateClientDto } from '@/transport/dto/client/client.dto';
+import { UpdateClientDto } from '@/transport/dto/client/update-client.dto';
 import { Injectable } from '@nestjs/common';
 
 @Injectable()

src/domain/interactor/client/client-writer.service.spec.ts

@@ -1,7 +1,6 @@
-import { Client } from '@/domain/entity/client/client.entity';
+import { BadRequestException } from '@/config/exceptions/custom-exceptions/bad-request.exception'; 
 import { ClientWriterService } from '@/domain/interactor/client/client-writer.service';
 import { IClientRepository } from '@/domain/repository/client/client.repository';
-import { PreconditionFailedException } from '@nestjs/common';
 
 describe('ClientWriterService', () => {
   let service: ClientWriterService;
@@ -40,15 +39,15 @@ describe('ClientWriterService', () => {
       expect(clientRepository.create).toHaveBeenCalledWith(client);
     });
 
-    it('should throw PreconditionFailedException for an invalid client', async () => {
+    it('should throw BadRequestException for an invalid client', async () => {
       const client = {
         id: '1',
         name: '',
         email: '',
         cpf: '',
       };
 
-      await expect(service.create(client)).rejects.toThrow(PreconditionFailedException);
+      await expect(service.create(client)).rejects.toThrow(BadRequestException);
     });
   });
 
@@ -75,7 +74,7 @@ describe('ClientWriterService', () => {
       expect(clientRepository.update).toHaveBeenCalledWith(updatedClient);
     });
 
-    it('should throw PreconditionFailedException for an invalid updated client', async () => {
+    it('should throw BadRequestException for an invalid updated client', async () => {
       const existingClient = {
         id: '1',
         name: 'Gandalf The Grey',
@@ -93,7 +92,7 @@ describe('ClientWriterService', () => {
       jest.spyOn(clientRepository, 'findById').mockResolvedValue(existingClient);
 
       await expect(service.update(updatedClient)).rejects.toThrow(
-        PreconditionFailedException,
+        BadRequestException,
       );
 
     });

src/domain/interactor/client/client-writer.service.ts

@@ -1,13 +1,14 @@
 import { BadRequestException } from '@/config/exceptions/custom-exceptions/bad-request.exception';
+import { NotFoundException } from '@/config/exceptions/custom-exceptions/not-found.exception';
 import { Client } from '@/domain/entity/client/client.entity';
 import { ClientWriterServicePort } from '@/domain/interactor/port/client/client-writer-service.port';
 import { IClientRepository } from '@/domain/repository/client/client.repository';
-import { CreateClientDto } from '@/transport/dto/Client/create-client.dto';
-import { UpdateClientDto } from '@/transport/dto/Client/update-client.dto';
-import { PreconditionFailedException } from '@nestjs/common';
+import { CreateClientDto } from '@/transport/dto/client/client.dto';
+import { UpdateClientDto } from '@/transport/dto/client/update-client.dto';
+
 
 export class ClientWriterService implements ClientWriterServicePort {
-  constructor(private readonly clientRepository: IClientRepository) {}
+  constructor(private readonly clientRepository: IClientRepository) { }
 
   async create(createClientDTO: CreateClientDto): Promise<Client> {
     const client = new Client(
@@ -27,7 +28,7 @@ export class ClientWriterService implements ClientWriterServicePort {
 
   async update(client: UpdateClientDto): Promise<Client> {
     const savedClient = await this.clientRepository.findById(client.id).catch((e) => {
-      throw new PreconditionFailedException('Client not found');
+      throw new NotFoundException({ description: 'Client not found' });
     });
 
     const editedClient = new Client(

src/domain/interactor/payment/payment-writer.service.spec.ts

@@ -1,7 +1,7 @@
 import { Payment } from '@/domain/entity/payment/payment.entity';
 import { PaymentWriterService } from '@/domain/interactor/payment/payment-writer.service';
 import { IPaymentRepository } from '@/domain/repository/payment/payment.repository';
-import { CreatePaymentDto } from '@/transport/dto/Payment/payment.dto';
+import { CreatePaymentDto } from '@/transport/dto/payment/request/payment.dto';
 import { HttpException } from '@nestjs/common';
 
 describe('PaymentService', () => {

src/domain/interactor/payment/payment-writer.service.ts

@@ -2,7 +2,7 @@ import { InternalServerErrorException } from '@/config/exceptions/custom-excepti
 import { Payment } from '@/domain/entity/payment/payment.entity';
 import { PaymentWriterServicePort } from '@/domain/interactor/port/payment/payment-writer-service.port';
 import { IPaymentRepository } from '@/domain/repository/payment/payment.repository';
-import { CreatePaymentDto } from '@/transport/dto/Payment/payment.dto';
+import { CreatePaymentDto } from '@/transport/dto/payment/request/payment.dto';
 
 export class PaymentWriterService implements PaymentWriterServicePort {
   constructor(private readonly paymentRepository: IPaymentRepository) {}

src/domain/interactor/port/client/client-writer-service.port.ts

@@ -1,6 +1,6 @@
 import { Client } from '@/domain/entity/client/client.entity';
-import { CreateClientDto } from '@/transport/dto/Client/create-client.dto';
-import { UpdateClientDto } from '@/transport/dto/Client/update-client.dto';
+import { CreateClientDto } from '@/transport/dto/client/client.dto';
+import { UpdateClientDto } from '@/transport/dto/client/update-client.dto';
 
 export abstract class ClientWriterServicePort {
   abstract create(client: CreateClientDto): Promise<Client>;

src/domain/interactor/port/payment/payment-writer-service.port.ts

@@ -1,5 +1,5 @@
 import { Payment } from '@/domain/entity/payment/payment.entity';
-import { CreatePaymentDto } from '@/transport/dto/Payment/payment.dto';
+import { CreatePaymentDto } from '@/transport/dto/payment/request/payment.dto';
 
 export abstract class PaymentWriterServicePort {
   abstract create(payment: CreatePaymentDto): Promise<Payment>;

src/domain/repository/client/client.repository.ts

@@ -1,6 +1,6 @@
 import { Client } from '@/domain/entity/client/client.entity';
-import { CreateClientDto } from '@/transport/dto/Client/create-client.dto';
-import { UpdateClientDto } from '@/transport/dto/Client/update-client.dto';
+import { CreateClientDto } from '@/transport/dto/client/client.dto';
+import { UpdateClientDto } from '@/transport/dto/client/update-client.dto';
 
 export abstract class IClientRepository {
   abstract create(client: CreateClientDto): Promise<Client>;

src/domain/repository/payment/payment.repository.ts

@@ -1,5 +1,5 @@
 import { Payment } from '@/domain/entity/payment/payment.entity';
-import { CreatePaymentDto } from '@/transport/dto/Payment/payment.dto';
+import { CreatePaymentDto } from '@/transport/dto/payment/request/payment.dto';
 
 export abstract class IPaymentRepository {
   abstract create(payment: CreatePaymentDto): Promise<Payment>;

src/infrastructure/persistence/prisma/prisma-payment.repository.ts

@@ -1,7 +1,7 @@
 import { PrismaService } from '@/config/prisma.config';
 import { Payment } from '@/domain/entity/payment/payment.entity';
 import { IPaymentRepository } from '@/domain/repository/payment/payment.repository';
-import { CreatePaymentDto } from '@/transport/dto/Payment/payment.dto';
+import { CreatePaymentDto } from '@/transport/dto/payment/request/payment.dto';
 import { Injectable } from '@nestjs/common';
 
 @Injectable()

src/transport/constant/api-response.constant.ts

@@ -0,0 +1,7 @@
+export const API_RESPONSE = {
+  OK_DESC: 'Successul request',
+  CREATED_DESC: 'Register was created successfully',
+  BAD_REQUEST_DESC: 'Invalid body request',
+  NOT_FOUND_DESC: 'A register for this identifier was not found',
+  INTERNAL_SERVER_EXCEPTION_DESC: 'Internal Server Error',
+};

src/transport/constant/client.constant.ts

@@ -0,0 +1,38 @@
+export const CLIENT = {
+  API_PROPERTY: {
+    CREATE: {
+      SUMMARY: 'Creates a client register',
+      DESC: 'Creates a client register in database',
+    },
+    GET_ALL: {
+      SUMMARY: 'Gets all registered clients in database',
+      DESC: 'Fetches all clients registered in database',
+    },
+    GET_BY_ID: {
+      SUMMARY: 'Gets client by identifier',
+      DESC: 'Fetches client register from database by identifier',
+    },
+    UPDATE: {
+      SUMMARY: 'Updates client register',
+      DESC: 'Updates client register in database by identifier',
+    },
+    CLIENT: {
+      ID: {
+        DESC: 'Client identifier in database',
+        EXAMPLE: '5671843b-324b-40ae-aaa8-a3b404013703',
+      },
+      CPF: {
+        DESC: 'Client unique Cadastro de Pessoa física (CPF)',
+        EXAMPLE: '17256987564',
+      },
+      NAME: {
+        DESC: 'Client name',
+        EXAMPLE: 'Bilbo Baggins',
+      },
+      EMAIL: {
+        DESC: 'Client email',
+        EXAMPLE: '[email protected]',
+      },
+    },
+  },
+};

src/transport/constant/payment.constant.ts

@@ -0,0 +1,22 @@
+export const PAYMENT = {
+  API_PROPERTY: {
+    CREATE: {
+      SUMMARY: 'Creates a payment register',
+      DESC: 'Creates a payment register attached to an order in database',
+    },
+    PRODUCT: {
+      ID: {
+        DESC: 'Product identifier in database',
+        EXAMPLE: '5671843b-324b-40ae-aaa8-a3b404013703',
+      },
+      VALUE: {
+        DESC: 'Order value',
+        EXAMPLE: 39.99,
+      },
+      METHOD: {
+        DESC: 'Category in which the product is registered',
+        EXAMPLE: 'Credit Card',
+      },
+    },
+  },
+};

src/transport/controller/client.controller.ts

@@ -0,0 +1,90 @@
+import { BadRequestException } from '@/config/exceptions/custom-exceptions/bad-request.exception';
+import { InternalServerErrorException } from '@/config/exceptions/custom-exceptions/internal-server-error.exception';
+import { NotFoundException } from '@/config/exceptions/custom-exceptions/not-found.exception';
+import { Client } from '@/domain/entity/client/client.entity';
+import { ClientReaderServicePort } from '@/domain/interactor/port/client/client-reader-service.port';
+import { ClientWriterServicePort } from '@/domain/interactor/port/client/client-writer-service.port';
+import { API_RESPONSE } from '@/transport/constant/api-response.constant';
+import { CLIENT } from '@/transport/constant/client.constant';
+import { CreateClientDto } from '@/transport/dto/client/client.dto';
+import { UpdateClientDto } from '@/transport/dto/client/update-client.dto';
+import { Body, Controller, Get, HttpStatus, Param, Patch, Post } from '@nestjs/common';
+import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
+
+const { CREATE, GET_ALL, GET_BY_ID, UPDATE } = CLIENT.API_PROPERTY;
+const {
+  OK_DESC,
+  CREATED_DESC,
+  BAD_REQUEST_DESC,
+  NOT_FOUND_DESC,
+  INTERNAL_SERVER_EXCEPTION_DESC,
+} = API_RESPONSE;
+
+@Controller('clients')
+@ApiTags('clients')
+export class ClientController {
+  constructor(
+    private readonly clientWriterService: ClientWriterServicePort,
+    private readonly clientReaderService: ClientReaderServicePort,
+  ) {}
+
+  @Post()
+  @ApiOperation({ summary: CREATE.SUMMARY, description: CREATE.DESC })
+  @ApiResponse({
+    status: HttpStatus.CREATED,
+    description: CREATED_DESC,
+    type: () => Client,
+  })
+  @ApiResponse({
+    status: HttpStatus.BAD_REQUEST,
+    description: BAD_REQUEST_DESC,
+    type: () => BadRequestException,
+  })
+  async create(@Body() createClient: CreateClientDto) {
+    return this.clientWriterService.create({
+      ...createClient,
+    });
+  }
+
+  @Get()
+  @ApiOperation({ summary: GET_ALL.SUMMARY, description: GET_ALL.DESC })
+  @ApiResponse({
+    status: HttpStatus.OK,
+    description: OK_DESC,
+    type: () => Client,
+  })
+  @ApiResponse({
+    status: HttpStatus.INTERNAL_SERVER_ERROR,
+    description: INTERNAL_SERVER_EXCEPTION_DESC,
+    type: () => InternalServerErrorException,
+  })
+  async findAll() {
+    return this.clientReaderService.findAll();
+  }
+
+  @Get(':id')
+  @ApiOperation({ summary: GET_BY_ID.SUMMARY, description: GET_BY_ID.DESC })
+  @ApiResponse({
+    status: HttpStatus.OK,
+    description: OK_DESC,
+    type: () => Client,
+  })
+  @ApiResponse({
+    status: HttpStatus.NOT_FOUND,
+    description: NOT_FOUND_DESC,
+    type: () => NotFoundException,
+  })
+  async findById(@Param('id') id: string) {
+    return this.clientReaderService.findById(id);
+  }
+
+  @Patch(':id')
+  @ApiOperation({ summary: UPDATE.SUMMARY, description: UPDATE.DESC })
+  @ApiResponse({ status: HttpStatus.OK, description: OK_DESC, type: () => Client })
+  async update(@Body() editClient: UpdateClientDto, @Param('id') id: string) {
+    return this.clientWriterService.update({
+      ...editClient,
+      id: id,
+    });
+  }
+}