refactor: migrate credit note and vendor credit services to nestjs

2026-02-20 14:50:32 +00:00 · 2024-12-29 18:37:33 +02:00
parent 9f9b75cd31
commit caf235e2b5
107 changed files with 7396 additions and 109 deletions
--- a/packages/server-nest/src/modules/VendorCredit/commands/DeleteVendorCredit.service.ts
+++ b/packages/server-nest/src/modules/VendorCredit/commands/DeleteVendorCredit.service.ts
@@ -0,0 +1,116 @@
+import { Inject, Injectable } from '@nestjs/common';
+import { Knex } from 'knex';
+import { EventEmitter2 } from '@nestjs/event-emitter';
+import {
+  IVendorCreditDeletedPayload,
+  IVendorCreditDeletingPayload,
+} from '@/modules/VendorCredit/types/VendorCredit.types';
+import { ERRORS } from '../constants';
+import { VendorCredit } from '../models/VendorCredit';
+import { ItemEntry } from '@/modules/TransactionItemEntry/models/ItemEntry';
+import { VendorCreditAppliedBill } from '../../VendorCreditsApplyBills/models/VendorCreditAppliedBill';
+import { UnitOfWork } from '@/modules/Tenancy/TenancyDB/UnitOfWork.service';
+import { ServiceError } from '@/modules/Items/ServiceError';
+import { RefundVendorCredit } from '../models/RefundVendorCredit';
+import { events } from '@/common/events/events';
+
+@Injectable()
+export class DeleteVendorCreditService {
+  /**
+   * @param {typeof VendorCredit} vendorCreditModel - The vendor credit model.
+   * @param {typeof ItemEntry} itemEntryModel - The item entry model.
+   * @param {EventEmitter2} eventPublisher - The event emitter service.
+   * @param {UnitOfWork} uow - The unit of work service.
+   * @param {typeof RefundVendorCredit} refundVendorCreditModel - The refund vendor credit model.
+   * @param {typeof VendorCreditAppliedBill} vendorCreditAppliedBillModel - The vendor credit applied bill model.
+   */
+  constructor(
+    private vendorCreditModel: typeof VendorCredit,
+    private itemEntryModel: typeof ItemEntry,
+    private eventPublisher: EventEmitter2,
+    private uow: UnitOfWork,
+
+    @Inject(RefundVendorCredit.name)
+    private refundVendorCreditModel: typeof RefundVendorCredit,
+
+    @Inject(VendorCreditAppliedBill.name)
+    private vendorCreditAppliedBillModel: typeof VendorCreditAppliedBill,
+  ) {}
+
+  /**
+   * Deletes the given vendor credit.
+   * @param {number} vendorCreditId - Vendor credit id.
+   */
+  public deleteVendorCredit = async (
+    vendorCreditId: number,
+    trx?: Knex.Transaction,
+  ) => {
+    // Retrieve the old vendor credit.
+    const oldVendorCredit = await this.refundVendorCreditModel
+      .query()
+      .findById(vendorCreditId)
+      .throwIfNotFound();
+
+    // Validates vendor credit has no associate refund transactions.
+    await this.validateVendorCreditHasNoRefundTransactions(vendorCreditId);
+
+    // Validates vendor credit has no associated applied to bills transactions.
+    await this.validateVendorCreditHasNoApplyBillsTransactions(vendorCreditId);
+
+    // Deletes the vendor credit transactions under UOW environment.
+    return this.uow.withTransaction(async (trx: Knex.Transaction) => {
+      // Triggers `onVendorCreditEditing` event.
+      await this.eventPublisher.emitAsync(events.vendorCredit.onDeleting, {
+        oldVendorCredit,
+        trx,
+      } as IVendorCreditDeletingPayload);
+
+      // Deletes the associated credit note entries.
+      await this.itemEntryModel
+        .query(trx)
+        .where('reference_id', vendorCreditId)
+        .where('reference_type', 'VendorCredit')
+        .delete();
+
+      // Deletes the credit note transaction.
+      await this.vendorCreditModel.query(trx).findById(vendorCreditId).delete();
+
+      // Triggers `onVendorCreditDeleted` event.
+      await this.eventPublisher.emitAsync(events.vendorCredit.onDeleted, {
+        vendorCreditId,
+        oldVendorCredit,
+        trx,
+      } as IVendorCreditDeletedPayload);
+    });
+  };
+
+  /**
+   * Validates vendor credit has no refund transactions.
+   * @param {number} vendorCreditId
+   */
+  private validateVendorCreditHasNoRefundTransactions = async (
+    vendorCreditId: number,
+  ): Promise<void> => {
+    const refundCredits = await this.refundVendorCreditModel
+      .query()
+      .where('vendorCreditId', vendorCreditId);
+    if (refundCredits.length > 0) {
+      throw new ServiceError(ERRORS.VENDOR_CREDIT_HAS_REFUND_TRANSACTIONS);
+    }
+  };
+
+  /**
+   * Validate vendor credit has no applied transactions to bills.
+   * @param {number} vendorCreditId
+   */
+  private validateVendorCreditHasNoApplyBillsTransactions = async (
+    vendorCreditId: number,
+  ): Promise<void> => {
+    const appliedTransactions = await this.vendorCreditAppliedBillModel
+      .query()
+      .where('vendorCreditId', vendorCreditId);
+    if (appliedTransactions.length > 0) {
+      throw new ServiceError(ERRORS.VENDOR_CREDIT_HAS_APPLIED_BILLS);
+    }
+  };
+}