fairnesscoop · avmesquita · Dec 7, 2024 · Dec 7, 2024 · Dec 7, 2024 · Dec 7, 2024
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-<h1 align="center"><a href="https://fairness.coop"><img src="https://fairness.coop/image/fairness_logo.svg" alt="Fairness"></a></h1>
+<h1 align="center"><a href="https://fairness.coop"><img src="/src/public/images/logo.png" alt="Fairness"></a></h1>
 
 Permacoop is an open source and eco design ERP solution reserved for worker-owned business.
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -38,7 +38,7 @@
     "@nestjs/cqrs": "^9.0.1",
     "@nestjs/passport": "^9.0.0",
     "@nestjs/platform-express": "^9.2.0",
-    "@nestjs/swagger": "^6.1.3",
+    "@nestjs/swagger": "^6.3.0",
     "@nestjs/typeorm": "^9.0.1",
     "argon2": "^0.26.2",
     "axios": "^1.7.2",

diff --git a/src/Domain/FairCalendar/Specification/IsMaximumTimeSpentReached.ts b/src/Domain/FairCalendar/Specification/IsMaximumTimeSpentReached.ts
@@ -11,10 +11,7 @@ export class IsMaximumTimeSpentReached {
     private readonly leaveRepository: ILeaveRepository
   ) {}
 
-  public async isSatisfiedBy(
-    event: Event,
-    newTime: number = 0
-  ): Promise<boolean> {
+  public async isSatisfiedBy(event: Event, newTime = 0): Promise<boolean> {
     const user = event.getUser();
     const date = event.getDate();
 

diff --git a/src/Infrastructure/Common/DTO/IdDTO.ts b/src/Infrastructure/Common/DTO/IdDTO.ts
@@ -1,6 +1,8 @@
 import { IsNotEmpty, IsUUID } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
 
 export class IdDTO {
+  @ApiProperty()
   @IsNotEmpty()
   @IsUUID()
   public id: string;

diff --git a/src/Infrastructure/Common/DTO/PaginationDTO.ts b/src/Infrastructure/Common/DTO/PaginationDTO.ts
@@ -1,7 +1,9 @@
 import { Transform } from 'class-transformer';
 import { IsNumber, IsOptional, Max, Min } from 'class-validator';
+import { ApiPropertyOptional } from '@nestjs/swagger';
 
 export class PaginationDTO {
+  @ApiPropertyOptional()
   @IsOptional()
   @Min(1)
   @Max(10000)

diff --git a/src/Infrastructure/Customer/Controller/AddCustomerController.ts b/src/Infrastructure/Customer/Controller/AddCustomerController.ts
@@ -16,7 +16,9 @@ import { WithName } from 'src/Infrastructure/Common/ExtendedRouting/WithName';
 import { CreateCustomerCommand } from 'src/Application/Customer/Command/CreateCustomerCommand';
 import { CustomerDTO } from 'src/Infrastructure/Customer/DTO/CustomerDTO';
 import { RouteNameResolver } from 'src/Infrastructure/Common/ExtendedRouting/RouteNameResolver';
+import { ApiTags } from '@nestjs/swagger';
 
+@ApiTags('Customer')
 @Controller('app/customers/add')
 @UseGuards(IsAuthenticatedGuard)
 export class AddCustomerController {

diff --git a/src/Infrastructure/Customer/Controller/EditCustomerController.ts b/src/Infrastructure/Customer/Controller/EditCustomerController.ts
@@ -20,7 +20,9 @@ import { GetCustomerByIdQuery } from 'src/Application/Customer/Query/GetCustomer
 import { CustomerDTO } from 'src/Infrastructure/Customer/DTO/CustomerDTO';
 import { UpdateCustomerCommand } from 'src/Application/Customer/Command/UpdateCustomerCommand';
 import { RouteNameResolver } from 'src/Infrastructure/Common/ExtendedRouting/RouteNameResolver';
+import { ApiTags } from '@nestjs/swagger';
 
+@ApiTags('Customer')
 @Controller('app/customers/edit')
 @UseGuards(IsAuthenticatedGuard)
 export class EditCustomerController {

diff --git a/src/Infrastructure/Customer/DTO/CustomerDTO.ts b/src/Infrastructure/Customer/DTO/CustomerDTO.ts
@@ -1,6 +1,8 @@
 import { IsNotEmpty } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
 
 export class CustomerDTO {
+  @ApiProperty()
   @IsNotEmpty()
   public name: string;
 }
diff --git a/src/Infrastructure/FairCalendar/Controller/AddEventController.ts b/src/Infrastructure/FairCalendar/Controller/AddEventController.ts
@@ -26,7 +26,9 @@ import { GetCooperativeQuery } from 'src/Application/Settings/Query/GetCooperati
 import { ArrayUtils } from 'src/Infrastructure/Common/Utils/ArrayUtils';
 import { RouteNameResolver } from 'src/Infrastructure/Common/ExtendedRouting/RouteNameResolver';
 import { makeMonthUrl } from '../Routing/urls';
+import { ApiTags } from '@nestjs/swagger';
 
+@ApiTags('Calendar')
 @Controller('app/faircalendar/events/add')
 @UseGuards(IsAuthenticatedGuard)
 export class AddEventController {

diff --git a/src/Infrastructure/FairCalendar/Controller/DeleteEventController.ts b/src/Infrastructure/FairCalendar/Controller/DeleteEventController.ts
@@ -20,7 +20,9 @@ import { RouteNameResolver } from 'src/Infrastructure/Common/ExtendedRouting/Rou
 import { EventView } from 'src/Application/FairCalendar/View/EventView';
 import { GetEventByIdQuery } from 'src/Application/FairCalendar/Query/GetEventByIdQuery';
 import { makeMonthUrl } from '../Routing/urls';
+import { ApiTags } from '@nestjs/swagger';
 
+@ApiTags('Calendar')
 @Controller('app/faircalendar/events/delete')
 @UseGuards(IsAuthenticatedGuard)
 export class DeleteEventController {

diff --git a/src/Infrastructure/FairCalendar/Controller/EditEventController.ts b/src/Infrastructure/FairCalendar/Controller/EditEventController.ts
@@ -32,7 +32,9 @@ import { GetEventByIdQuery } from 'src/Application/FairCalendar/Query/GetEventBy
 import { RouteNameResolver } from 'src/Infrastructure/Common/ExtendedRouting/RouteNameResolver';
 import { makeMonthUrl } from '../Routing/urls';
 import { EventView } from 'src/Application/FairCalendar/View/EventView';
+import { ApiTags } from '@nestjs/swagger';
 
+@ApiTags('Calendar')
 @Controller('app/faircalendar/events/edit')
 @UseGuards(IsAuthenticatedGuard)
 export class EditEventController {

diff --git a/src/Infrastructure/FairCalendar/Controller/FairCalendarController.ts b/src/Infrastructure/FairCalendar/Controller/FairCalendarController.ts
@@ -25,7 +25,9 @@ import { FairCalendarOverviewTableFactory } from '../Table/FairCalendarOverviewT
 import { IDateUtils } from 'src/Application/IDateUtils';
 import { ArrayUtils } from 'src/Infrastructure/Common/Utils/ArrayUtils';
 import { RouteNameResolver } from 'src/Infrastructure/Common/ExtendedRouting/RouteNameResolver';
+import { ApiTags } from '@nestjs/swagger';
 
+@ApiTags('Calendar')
 @Controller('app/faircalendar')
 @UseGuards(IsAuthenticatedGuard)
 export class FairCalendarController {

diff --git a/src/Infrastructure/FairCalendar/DTO/AbstractEventDTO.ts b/src/Infrastructure/FairCalendar/DTO/AbstractEventDTO.ts
@@ -9,25 +9,31 @@ import {
 } from 'class-validator';
 import { EventType } from 'src/Domain/FairCalendar/Event.entity';
 import { ArrayUtils } from 'src/Infrastructure/Common/Utils/ArrayUtils';
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
 
 export abstract class AbstractEventDTO {
+  @ApiProperty()
   @IsNotEmpty()
   @IsEnum(EventType)
   public type: EventType;
 
+  @ApiProperty()
   @IsNotEmpty()
   @IsInt()
   @IsIn([...ArrayUtils.range(30, 480, 30)])
   public time: number;
 
+  @ApiPropertyOptional()
   @IsOptional()
   @IsUUID()
   public projectId?: string;
 
+  @ApiPropertyOptional()
   @IsOptional()
   @IsUUID()
   public taskId?: string;
 
+  @ApiPropertyOptional()
   @IsOptional()
   @IsString()
   public summary?: string;

diff --git a/src/Infrastructure/FairCalendar/DTO/AddEventControllerDTO.ts b/src/Infrastructure/FairCalendar/DTO/AddEventControllerDTO.ts
@@ -1,10 +1,13 @@
 import { IsISO8601, IsNotEmpty } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
 
 export class AddEventControllerDTO {
+  @ApiProperty()
   @IsNotEmpty()
   @IsISO8601()
   public startDate: string;
 
+  @ApiProperty()
   @IsNotEmpty()
   @IsISO8601()
   public endDate: string;

diff --git a/src/Infrastructure/FairCalendar/DTO/AddEventDTO.ts b/src/Infrastructure/FairCalendar/DTO/AddEventDTO.ts
@@ -1,12 +1,15 @@
 import { IsNotEmpty, IsDateString } from 'class-validator';
 import { DateGreaterOrEqualThan } from 'src/Infrastructure/Common/Validator/DateGreaterOrEqualThan';
 import { AbstractEventDTO } from './AbstractEventDTO';
+import { ApiProperty } from '@nestjs/swagger';
 
 export class AddEventDTO extends AbstractEventDTO {
+  @ApiProperty()
   @IsNotEmpty()
   @IsDateString()
   public startDate: string;
 
+  @ApiProperty()
   @IsNotEmpty()
   @IsDateString()
   @DateGreaterOrEqualThan('startDate')

diff --git a/src/Infrastructure/FairCalendar/DTO/FairCalendarControllerDTO.ts b/src/Infrastructure/FairCalendar/DTO/FairCalendarControllerDTO.ts
@@ -1,15 +1,19 @@
 import { IsOptional, IsUUID, IsNumber } from 'class-validator';
+import { ApiPropertyOptional } from '@nestjs/swagger';
 
 // TODO test
 export class FairCalendarControllerDTO {
+  @ApiPropertyOptional()
   @IsUUID()
   @IsOptional()
   public userId?: string;
 
+  @ApiPropertyOptional()
   @IsNumber()
   @IsOptional()
   public month?: number;
 
+  @ApiPropertyOptional()
   @IsNumber()
   @IsOptional()
   public year?: number;

diff --git a/src/Infrastructure/Home/Controller/HomeController.ts b/src/Infrastructure/Home/Controller/HomeController.ts
@@ -6,13 +6,15 @@ import {
   Res,
   UseGuards
 } from '@nestjs/common';
+import { ApiTags } from '@nestjs/swagger';
 import { Response } from 'express';
 import { GetPendingLeaveRequestsCountQuery } from 'src/Application/HumanResource/Leave/Query/GetPendingLeaveRequestsCountQuery';
 import { IQueryBus } from 'src/Application/IQueryBus';
 import { RouteNameResolver } from 'src/Infrastructure/Common/ExtendedRouting/RouteNameResolver';
 import { WithName } from 'src/Infrastructure/Common/ExtendedRouting/WithName';
 import { IsAuthenticatedGuard } from 'src/Infrastructure/HumanResource/User/Security/IsAuthenticatedGuard';
 
+@ApiTags('Home')
 @Controller()
 @UseGuards(IsAuthenticatedGuard)
 export class HomeController {

diff --git a/src/Infrastructure/HumanResource/Leave/Controller/AddLeaveRequestController.ts b/src/Infrastructure/HumanResource/Leave/Controller/AddLeaveRequestController.ts
@@ -19,7 +19,9 @@ import { WithName } from 'src/Infrastructure/Common/ExtendedRouting/WithName';
 import { User } from 'src/Domain/HumanResource/User/User.entity';
 import { Type } from 'src/Domain/HumanResource/Leave/LeaveRequest.entity';
 import { RouteNameResolver } from 'src/Infrastructure/Common/ExtendedRouting/RouteNameResolver';
+import { ApiTags } from '@nestjs/swagger';
 
+@ApiTags('HR :: Leave')
 @Controller('app/people/leave-requests/add')
 @UseGuards(IsAuthenticatedGuard)
 export class AddLeaveRequestController {

diff --git a/src/Infrastructure/HumanResource/Leave/Controller/DeleteLeaveRequestController.ts b/src/Infrastructure/HumanResource/Leave/Controller/DeleteLeaveRequestController.ts
@@ -16,7 +16,9 @@ import { DeleteLeaveRequestCommand } from 'src/Application/HumanResource/Leave/C
 import { WithName } from 'src/Infrastructure/Common/ExtendedRouting/WithName';
 import { RouteNameResolver } from 'src/Infrastructure/Common/ExtendedRouting/RouteNameResolver';
 import { IsAuthenticatedGuard } from '../../User/Security/IsAuthenticatedGuard';
+import { ApiTags } from '@nestjs/swagger';
 
+@ApiTags('HR :: Leave')
 @Controller('app/people/leave-requests/delete')
 @UseGuards(IsAuthenticatedGuard)
 export class DeleteLeaveRequestController {

diff --git a/src/Infrastructure/HumanResource/Leave/Controller/EditLeaveRequestController.ts b/src/Infrastructure/HumanResource/Leave/Controller/EditLeaveRequestController.ts
@@ -27,7 +27,9 @@ import { GetLeaveRequestByIdQuery } from 'src/Application/HumanResource/Leave/Qu
 import { IQueryBus } from 'src/Application/IQueryBus';
 import { RouteNameResolver } from 'src/Infrastructure/Common/ExtendedRouting/RouteNameResolver';
 import { DoesLeaveRequestBelongToUser } from 'src/Domain/HumanResource/Leave/Specification/DoesLeaveRequestBelongToUser';
+import { ApiTags } from '@nestjs/swagger';
 
+@ApiTags('HR :: Leave')
 @Controller('app/people/leave-requests/edit')
 @UseGuards(IsAuthenticatedGuard)
 export class EditLeaveRequestController {

diff --git a/src/Infrastructure/HumanResource/Leave/Controller/ExportLeavesCalendarController.ts b/src/Infrastructure/HumanResource/Leave/Controller/ExportLeavesCalendarController.ts
@@ -11,7 +11,9 @@ import { IQueryBus } from 'src/Application/IQueryBus';
 import { CalendarTokenGuard } from 'src/Infrastructure/HumanResource/User/Security/CalendarTokenGuard';
 import { GetLeavesCalendarQuery } from 'src/Application/HumanResource/Leave/Query/GetLeavesCalendarQuery';
 import { WithName } from 'src/Infrastructure/Common/ExtendedRouting/WithName';
+import { ApiTags } from '@nestjs/swagger';
 
+@ApiTags('HR :: Leave')
 @Controller('api/leaves/calendar.ics')
 @UseGuards(CalendarTokenGuard)
 export class ExportLeavesCalendarController {

diff --git a/src/Infrastructure/HumanResource/Leave/Controller/GetLeaveRequestController.ts b/src/Infrastructure/HumanResource/Leave/Controller/GetLeaveRequestController.ts
@@ -18,7 +18,9 @@ import { CanLeaveRequestBeModerated } from 'src/Domain/HumanResource/Leave/Speci
 import { LeaveRequestDetailView } from 'src/Application/HumanResource/Leave/View/LeaveRequestDetailView';
 import { DoesLeaveRequestBelongToUser } from 'src/Domain/HumanResource/Leave/Specification/DoesLeaveRequestBelongToUser';
 import { Status } from 'src/Domain/HumanResource/Leave/LeaveRequest.entity';
+import { ApiTags } from '@nestjs/swagger';
 
+@ApiTags('HR :: Leave')
 @Controller('app/people/leaves')
 @UseGuards(IsAuthenticatedGuard)
 export class GetLeaveRequestController {

diff --git a/src/Infrastructure/HumanResource/Leave/Controller/ListLeaveRequestsController.ts b/src/Infrastructure/HumanResource/Leave/Controller/ListLeaveRequestsController.ts
@@ -20,7 +20,9 @@ import { GetLeaveRequestsOverviewQuery } from 'src/Application/HumanResource/Lea
 import { UserView } from 'src/Application/HumanResource/User/View/UserView';
 import { GetUsersQuery } from 'src/Application/HumanResource/User/Query/GetUsersQuery';
 import { ListLeaveRequestsControllerDTO } from '../DTO/ListLeaveRequestsControllerDTO';
+import { ApiTags } from '@nestjs/swagger';
 
+@ApiTags('HR :: Leave')
 @Controller('app/people/leave_requests')
 @UseGuards(IsAuthenticatedGuard)
 export class ListLeaveRequestsController {