refactor(nestjs): wip dtos validation schema

packages/server/src/modules/BillPayments/BillPayments.controller.ts

@@ -15,11 +15,15 @@ import {
   EditBillPaymentDto,
 } from './dtos/BillPayment.dto';
 import { GetBillPaymentsFilterDto } from './dtos/GetBillPaymentsFilter.dto';
+import { BillPaymentsPages } from './commands/BillPaymentsPages.service';
 
 @Controller('bill-payments')
 @ApiTags('bill-payments')
 export class BillPaymentsController {
-  constructor(private billPaymentsApplication: BillPaymentsApplication) {}
+  constructor(
+    private billPaymentsApplication: BillPaymentsApplication,
+    private billPaymentsPagesService: BillPaymentsPages,
+  ) {}
 
   @Post()
   @ApiOperation({ summary: 'Create a new bill payment.' })
@@ -59,6 +63,24 @@ export class BillPaymentsController {
     );
   }
 
+  @Get('/new-page/entries')
+  @ApiOperation({
+    summary:
+      'Retrieves the payable entries of the new page once vendor be selected.',
+  })
+  @ApiParam({
+    name: 'vendorId',
+    required: true,
+    type: Number,
+    description: 'The vendor id',
+  })
+  async getBillPaymentNewPageEntries(@Query('vendorId') vendorId: number) {
+    const entries =
+      await this.billPaymentsPagesService.getNewPageEntries(vendorId);
+
+    return entries;
+  }
+
   @Get(':billPaymentId/bills')
   @ApiOperation({ summary: 'Retrieves the bills of the given bill payment.' })
   @ApiParam({
@@ -71,6 +93,25 @@ export class BillPaymentsController {
     return this.billPaymentsApplication.getPaymentBills(Number(billPaymentId));
   }
 
+  @Get('/:billPaymentId/edit-page')
+  @ApiOperation({
+    summary: 'Retrieves the edit page of the given bill payment.',
+  })
+  @ApiParam({
+    name: 'billPaymentId',
+    required: true,
+    type: Number,
+    description: 'The bill payment id',
+  })
+  public async getBillPaymentEditPage(
+    @Param('billPaymentId') billPaymentId: number,
+  ) {
+    const billPaymentsWithEditEntries =
+      await this.billPaymentsPagesService.getBillPaymentEditPage(billPaymentId);
+
+    return billPaymentsWithEditEntries;
+  }
+
   @Get(':billPaymentId')
   @ApiOperation({ summary: 'Retrieves the bill payment details.' })
   @ApiParam({
@@ -83,8 +124,14 @@ export class BillPaymentsController {
     return this.billPaymentsApplication.getBillPayment(Number(billPaymentId));
   }
 
-  @Get('')
+  @Get()
   @ApiOperation({ summary: 'Retrieves the bill payments list.' })
+  @ApiParam({
+    name: 'filterDTO',
+    required: true,
+    type: GetBillPaymentsFilterDto,
+    description: 'The bill payments filter dto',
+  })
   public getBillPayments(@Query() filterDTO: GetBillPaymentsFilterDto) {
     return this.billPaymentsApplication.getBillPayments(filterDTO);
   }

packages/server/src/modules/BillPayments/BillPayments.module.ts

@@ -20,6 +20,7 @@ import { BillPaymentsExportable } from './queries/BillPaymentsExportable';
 import { BillPaymentsImportable } from './commands/BillPaymentsImportable';
 import { GetBillPaymentsService } from './queries/GetBillPayments.service';
 import { DynamicListModule } from '../DynamicListing/DynamicList.module';
+import { BillPaymentsPages } from './commands/BillPaymentsPages.service';
 
 @Module({
   imports: [LedgerModule, AccountsModule, DynamicListModule],
@@ -41,6 +42,7 @@ import { DynamicListModule } from '../DynamicListing/DynamicList.module';
     BillPaymentsExportable,
     BillPaymentsImportable,
     GetBillPaymentsService,
+    BillPaymentsPages,
   ],
   exports: [
     BillPaymentValidators,

packages/server/src/modules/BillPayments/commands/BillPaymentsPages.service.ts

@@ -8,7 +8,7 @@ import { ServiceError } from '../../Items/ServiceError';
 import { TenantModelProxy } from '@/modules/System/models/TenantBaseModel';
 
 @Injectable()
-export default class BillPaymentsPages {
+export class BillPaymentsPages {
   /**
    * @param {TenantModelProxy<typeof Bill>} billModel - Bill model.
    * @param {TenantModelProxy<typeof BillPayment>} billPaymentModel - Bill payment model.

packages/server/src/modules/BillPayments/dtos/BillPayment.dto.ts

@@ -1,7 +1,8 @@
+import { ApiProperty } from '@nestjs/swagger';
 import { Type } from 'class-transformer';
 import {
   IsArray,
-  IsDate,
+  IsDateString,
   IsNotEmpty,
   IsNumber,
   IsOptional,
@@ -9,25 +10,33 @@ import {
   ValidateNested,
 } from 'class-validator';
 import { AttachmentLinkDto } from '@/modules/Attachments/dtos/Attachment.dto';
-import { ApiProperty } from '@nestjs/swagger';
+import { ToNumber } from '@/common/decorators/Validators';
 
 export class BillPaymentEntryDto {
+  @ToNumber()
   @IsNumber()
+  @IsNotEmpty()
+  @ApiProperty({ description: 'The id of the bill', example: 1 })
   billId: number;
 
+  @ToNumber()
   @IsNumber()
+  @IsNotEmpty()
+  @ApiProperty({
+    description: 'The payment amount of the bill payment',
+    example: 100,
+  })
   paymentAmount: number;
 }
 
 export class CommandBillPaymentDTO {
+  @ToNumber()
   @IsNumber()
   @IsNotEmpty()
-  @ApiProperty({
+  @ApiProperty({ description: 'The id of the vendor', example: 1 })
-    description: 'The id of the vendor',
-    example: 1,
-  })
   vendorId: number;
 
+  @ToNumber()
   @IsNumber()
   @IsOptional()
   @ApiProperty({
@@ -36,12 +45,10 @@ export class CommandBillPaymentDTO {
   })
   amount?: number;
 
+  @ToNumber()
   @IsNumber()
   @IsNotEmpty()
-  @ApiProperty({
+  @ApiProperty({ description: 'The id of the payment account', example: 1 })
-    description: 'The id of the payment account',
-    example: 1,
-  })
   paymentAccountId: number;
 
   @IsString()
@@ -52,8 +59,8 @@ export class CommandBillPaymentDTO {
   })
   paymentNumber?: string;
 
-  @IsDate()
+  @IsDateString()
-  @Type(() => Date)
+  @IsNotEmpty()
   @ApiProperty({
     description: 'The payment date of the bill payment',
     example: '2021-01-01',
@@ -76,7 +83,6 @@ export class CommandBillPaymentDTO {
   })
   statement?: string;
 
-  @IsString()
   @IsOptional()
   @IsArray()
   @ValidateNested({ each: true })
@@ -92,12 +98,10 @@ export class CommandBillPaymentDTO {
   })
   entries: BillPaymentEntryDto[];
 
+  @ToNumber()
   @IsNumber()
   @IsOptional()
-  @ApiProperty({
+  @ApiProperty({ description: 'The id of the branch', example: 1 })
-    description: 'The id of the branch',
-    example: 1,
-  })
   branchId?: number;
 
   @IsArray()

packages/server/src/modules/Bills/dtos/Bill.dto.ts

@@ -1,3 +1,4 @@
+import { ToNumber } from '@/common/decorators/Validators';
 import { ItemEntryDto } from '@/modules/TransactionItemEntry/dto/ItemEntry.dto';
 import { Type } from 'class-transformer';
 import {
@@ -5,14 +6,14 @@ import {
   IsArray,
   IsBoolean,
   IsDate,
+  IsDateString,
   IsEnum,
   IsInt,
+  IsNotEmpty,
   IsNumber,
   IsOptional,
   IsPositive,
   IsString,
-  Min,
-  MinLength,
   ValidateNested,
 } from 'class-validator';
 
@@ -29,10 +30,12 @@ export class BillEntryDto extends ItemEntryDto {
 
 class AttachmentDto {
   @IsString()
+  @IsNotEmpty()
   key: string;
 }
 
 export class CommandBillDto {
+  @IsOptional()
   @IsString()
   billNumber: string;
 
@@ -40,32 +43,36 @@ export class CommandBillDto {
   @IsString()
   referenceNo?: string;
 
-  @IsDate()
+  @IsNotEmpty()
-  @Type(() => Date)
+  @IsDateString()
   billDate: Date;
 
   @IsOptional()
-  @IsDate()
+  @IsDateString()
-  @Type(() => Date)
   dueDate?: Date;
 
   @IsInt()
+  @IsNotEmpty()
   vendorId: number;
 
   @IsOptional()
+  @ToNumber()
   @IsNumber()
   @IsPositive()
   exchangeRate?: number;
 
   @IsOptional()
+  @ToNumber()
   @IsInt()
   warehouseId?: number;
 
   @IsOptional()
+  @ToNumber()
   @IsInt()
   branchId?: number;
 
   @IsOptional()
+  @ToNumber()
   @IsInt()
   projectId?: number;
 
@@ -74,9 +81,11 @@ export class CommandBillDto {
   note?: string;
 
   @IsBoolean()
+  @IsOptional()
   open: boolean = false;
 
   @IsBoolean()
+  @IsOptional()
   isInclusiveTax: boolean = false;
 
   @IsArray()
@@ -92,13 +101,17 @@ export class CommandBillDto {
   attachments?: AttachmentDto[];
 
   @IsEnum(DiscountType)
+  @IsOptional()
   discountType: DiscountType = DiscountType.Amount;
 
   @IsOptional()
+  @ToNumber()
   @IsNumber()
+  @IsPositive()
   discount?: number;
 
   @IsOptional()
+  @ToNumber()
   @IsNumber()
   adjustment?: number;
 }

packages/server/src/modules/PaymentReceived/dtos/PaymentReceived.dto.ts

@@ -20,19 +20,22 @@ export class PaymentReceivedEntryDto {
   id?: number;
 
   @ToNumber()
-  @IsOptional()
   @IsInt()
+  @IsOptional()
   index?: number;
 
   @IsOptional()
+  @ToNumber()
   @IsInt()
   paymentReceiveId?: number;
 
+  @ToNumber()
   @IsInt()
   @IsNotEmpty()
   invoiceId: number;
 
-  @IsNumber()
+  @ToNumber()
+  @IsInt()
   @IsNotEmpty()
   paymentAmount: number;
 }

packages/server/src/modules/VendorCredit/dtos/VendorCredit.dto.ts

@@ -1,15 +1,19 @@
-import { ItemEntryDto } from '@/modules/TransactionItemEntry/dto/ItemEntry.dto';
 import { ApiProperty } from '@nestjs/swagger';
 import { Type } from 'class-transformer';
 import {
   IsArray,
+  IsBoolean,
+  IsDateString,
   IsEnum,
+  IsInt,
   IsNotEmpty,
   IsNumber,
   IsOptional,
   IsString,
   ValidateNested,
 } from 'class-validator';
+import { ToNumber } from '@/common/decorators/Validators';
+import { ItemEntryDto } from '@/modules/TransactionItemEntry/dto/ItemEntry.dto';
 
 enum DiscountType {
   Percentage = 'percentage',
@@ -20,10 +24,12 @@ export class VendorCreditEntryDto extends ItemEntryDto {}
 
 class AttachmentDto {
   @IsString()
+  @IsNotEmpty()
   key: string;
 }
 
 export class CommandVendorCreditDto {
+  @ToNumber()
   @IsNumber()
   @IsNotEmpty()
   @ApiProperty({
@@ -32,6 +38,7 @@ export class CommandVendorCreditDto {
   })
   vendorId: number;
 
+  @ToNumber()
   @IsNumber()
   @IsOptional()
   @ApiProperty({
@@ -42,10 +49,7 @@ export class CommandVendorCreditDto {
 
   @IsString()
   @IsOptional()
-  @ApiProperty({
+  @ApiProperty({ description: 'The vendor credit number', example: '123456' })
-    description: 'The vendor credit number',
-    example: '123456',
-  })
   vendorCreditNumber?: string;
 
   @IsString()
@@ -56,7 +60,7 @@ export class CommandVendorCreditDto {
   })
   referenceNo?: string;
 
-  @IsString()
+  @IsDateString()
   @IsNotEmpty()
   @ApiProperty({
     description: 'The date of the vendor credit',
@@ -73,13 +77,15 @@ export class CommandVendorCreditDto {
   note?: string;
 
   @IsOptional()
+  @IsBoolean()
   @ApiProperty({
     description: 'The open status of the vendor credit',
     example: true,
   })
   open: boolean = false;
 
-  @IsNumber()
+  @ToNumber()
+  @IsInt()
   @IsOptional()
   @ApiProperty({
     description: 'The warehouse id of the vendor credit',
@@ -87,7 +93,8 @@ export class CommandVendorCreditDto {
   })
   warehouseId?: number;
 
-  @IsNumber()
+  @ToNumber()
+  @IsInt()
   @IsOptional()
   @ApiProperty({
     description: 'The branch id of the vendor credit',
@@ -120,14 +127,11 @@ export class CommandVendorCreditDto {
   @IsOptional()
   @ApiProperty({
     description: 'The attachments of the vendor credit',
-    example: [
+    example: [{ key: '123456' }],
-      {
-        key: '123456',
-      },
-    ],
   })
   attachments?: AttachmentDto[];
 
+  @ToNumber()
   @IsNumber()
   @IsOptional()
   @ApiProperty({
@@ -144,6 +148,7 @@ export class CommandVendorCreditDto {
   })
   discountType?: DiscountType;
 
+  @ToNumber()
   @IsNumber()
   @IsOptional()
   @ApiProperty({

packages/webapp/src/hooks/query/paymentMades.tsx

@@ -159,7 +159,7 @@ export function usePaymentMadeNewPageEntries(vendorId, props) {
       params: { vendor_id: vendorId },
     },
     {
-      select: (res) => res.data.entries,
+      select: (res) => res.data,
       defaultData: [],
       ...props,
     },