wip

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

@@ -9,10 +9,7 @@ import {
   Query,
 } from '@nestjs/common';
 import { VendorsApplication } from './VendorsApplication.service';
-import {
-  IVendorOpeningBalanceEditDTO,
-  IVendorsFilter,
-} from './types/Vendors.types';
+import { VendorOpeningBalanceEditDto } from './dtos/VendorOpeningBalanceEdit.dto';
 import {
   ApiOperation,
   ApiResponse,
@@ -68,7 +65,7 @@ export class VendorsController {
   @ApiOperation({ summary: 'Edit the given vendor opening balance.' })
   editOpeningBalance(
     @Param('id') vendorId: number,
-    @Body() openingBalanceDTO: IVendorOpeningBalanceEditDTO,
+    @Body() openingBalanceDTO: VendorOpeningBalanceEditDto,
   ) {
     return this.vendorsApplication.editOpeningBalance(
       vendorId,

packages/server/src/modules/Vendors/VendorsApplication.service.ts

@@ -5,10 +5,7 @@ import { EditVendorService } from './commands/EditVendor.service';
 import { DeleteVendorService } from './commands/DeleteVendor.service';
 import { EditOpeningBalanceVendorService } from './commands/EditOpeningBalanceVendor.service';
 import { GetVendorService } from './queries/GetVendor';
-import {
-  IVendorOpeningBalanceEditDTO,
-  IVendorsFilter,
-} from './types/Vendors.types';
+import { VendorOpeningBalanceEditDto } from './dtos/VendorOpeningBalanceEdit.dto';
 import { GetVendorsService } from './queries/GetVendors.service';
 import { CreateVendorDto } from './dtos/CreateVendor.dto';
 import { EditVendorDto } from './dtos/EditVendor.dto';
@@ -58,14 +55,14 @@ export class VendorsApplication {
   }
 
   /**
-   * Changes the opening balance of the given customer.
-   * @param   {number} vendorId
-   * @param   {IVendorOpeningBalanceEditDTO} openingBalanceEditDTO
+   * Changes the opening balance of the given vendor.
+   * @param {number} vendorId
+   * @param  {VendorOpeningBalanceEditDto} openingBalanceEditDTO
    * @returns {Promise<IVendor>}
    */
   public editOpeningBalance(
     vendorId: number,
-    openingBalanceEditDTO: IVendorOpeningBalanceEditDTO,
+    openingBalanceEditDTO: VendorOpeningBalanceEditDto,
   ) {
     return this.editOpeningBalanceService.editOpeningBalance(
       vendorId,
@@ -95,10 +92,7 @@ export class VendorsApplication {
     vendorIds: number[],
     options?: { skipUndeletable?: boolean },
   ) {
-    return this.bulkDeleteVendorsService.bulkDeleteVendors(
-      vendorIds,
-      options,
-    );
+    return this.bulkDeleteVendorsService.bulkDeleteVendors(vendorIds, options);
   }
 
   public validateBulkDeleteVendors(vendorIds: number[]) {

packages/server/src/modules/Vendors/commands/EditOpeningBalanceVendor.service.ts

@@ -2,10 +2,10 @@ import { Knex } from 'knex';
 import { Inject, Injectable } from '@nestjs/common';
 import { EventEmitter2 } from '@nestjs/event-emitter';
 import {
-  IVendorOpeningBalanceEditDTO,
   IVendorOpeningBalanceEditedPayload,
   IVendorOpeningBalanceEditingPayload,
 } from '../types/Vendors.types';
+import { VendorOpeningBalanceEditDto } from '../dtos/VendorOpeningBalanceEdit.dto';
 import { UnitOfWork } from '@/modules/Tenancy/TenancyDB/UnitOfWork.service';
 import { Vendor } from '../models/Vendor';
 import { events } from '@/common/events/events';
@@ -29,12 +29,12 @@ export class EditOpeningBalanceVendorService {
   /**
    * Changes the opening balance of the given customer.
    * @param {number} vendorId
-   * @param {IVendorOpeningBalanceEditDTO} openingBalanceEditDTO
+   * @param {VendorOpeningBalanceEditDto} openingBalanceEditDTO
    * @returns {Promise<IVendor>}
    */
   public async editOpeningBalance(
     vendorId: number,
-    openingBalanceEditDTO: IVendorOpeningBalanceEditDTO,
+    openingBalanceEditDTO: VendorOpeningBalanceEditDto,
   ) {
     // Retrieves the old vendor or throw not found error.
     const oldVendor = await this.vendorModel()

packages/server/src/modules/Vendors/dtos/CreateVendor.dto.ts

@@ -2,11 +2,13 @@ import { ApiProperty } from '@nestjs/swagger';
 import {
   IsISO8601,
   IsInt,
+  IsNotEmpty,
   IsNumber,
   Min,
   IsBoolean,
   IsEmail,
   IsString,
+  ValidateIf,
 } from 'class-validator';
 import { ContactAddressDto } from '@/modules/Customers/dtos/ContactAddress.dto';
 import { IsOptional, ToNumber } from '@/common/decorators/Validators';
@@ -30,8 +32,12 @@ export class CreateVendorDto extends ContactAddressDto {
   @ToNumber()
   openingBalanceExchangeRate?: number;
 
-  @ApiProperty({ required: false, description: 'Date of the opening balance' })
-  @IsOptional()
+  @ApiProperty({
+    required: false,
+    description: 'Date of the opening balance (required when openingBalance is provided)',
+  })
+  @ValidateIf((o) => o.openingBalance != null)
+  @IsNotEmpty({ message: 'openingBalanceAt is required when openingBalance is provided' })
   @IsISO8601()
   openingBalanceAt?: Date;
 

packages/server/src/modules/Vendors/dtos/VendorOpeningBalanceEdit.dto.ts

@@ -0,0 +1,44 @@
+import { IsNotEmpty, IsNumber, IsString } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+import { IsOptional, ToNumber } from '@/common/decorators/Validators';
+
+export class VendorOpeningBalanceEditDto {
+  @ApiProperty({
+    required: true,
+    description: 'Opening balance',
+    example: 5000.0,
+  })
+  @IsNumber()
+  @IsNotEmpty()
+  @ToNumber()
+  openingBalance: number;
+
+  @ApiProperty({
+    required: false,
+    description: 'Opening balance date',
+    example: '2024-01-01',
+  })
+  @IsOptional()
+  @IsString()
+  openingBalanceAt?: string;
+
+  @ApiProperty({
+    required: false,
+    description: 'Opening balance exchange rate',
+    example: 1.0,
+  })
+  @IsOptional()
+  @IsNumber()
+  @ToNumber()
+  openingBalanceExchangeRate?: number;
+
+  @ApiProperty({
+    required: false,
+    description: 'Opening balance branch ID',
+    example: 101,
+  })
+  @IsOptional()
+  @IsNumber()
+  @ToNumber()
+  openingBalanceBranchId?: number;
+}

packages/server/src/modules/Vendors/types/Vendors.types.ts

@@ -7,6 +7,7 @@ import { IDynamicListFilter } from '@/modules/DynamicListing/DynamicFilter/Dynam
 import { IFilterMeta, IPaginationMeta } from '@/interfaces/Model';
 import { CreateVendorDto } from '../dtos/CreateVendor.dto';
 import { EditVendorDto } from '../dtos/EditVendor.dto';
+import { VendorOpeningBalanceEditDto } from '../dtos/VendorOpeningBalanceEdit.dto';
 
 // ----------------------------------
 export interface IVendorNewDTO extends IContactAddressDTO {
@@ -92,23 +93,16 @@ export interface IVendorEventEditedPayload {
   trx?: Knex.Transaction;
 }
 
-export interface IVendorOpeningBalanceEditDTO {
-  openingBalance: number;
-  openingBalanceAt: Date | string;
-  openingBalanceExchangeRate: number;
-  openingBalanceBranchId?: number;
-}
-
 export interface IVendorOpeningBalanceEditingPayload {
   oldVendor: Vendor;
-  openingBalanceEditDTO: IVendorOpeningBalanceEditDTO;
+  openingBalanceEditDTO: VendorOpeningBalanceEditDto;
   trx?: Knex.Transaction;
 }
 
 export interface IVendorOpeningBalanceEditedPayload {
   vendor: Vendor;
   oldVendor: Vendor;
-  openingBalanceEditDTO: IVendorOpeningBalanceEditDTO;
+  openingBalanceEditDTO: VendorOpeningBalanceEditDto;
   trx: Knex.Transaction;
 }