feat(nestjs): migrate to NestJS

2026-02-16 04:40:32 +00:00 · 2025-04-07 11:51:24 +02:00
parent f068218a16
commit 55fcc908ef
3779 changed files with 631 additions and 195332 deletions
--- a/packages/server/src/modules/CreditNotesApplyInvoice/commands/CreditNoteApplySyncCredit.service.ts
+++ b/packages/server/src/modules/CreditNotesApplyInvoice/commands/CreditNoteApplySyncCredit.service.ts
@@ -0,0 +1,46 @@
+import { Knex } from 'knex';
+import { Inject, Injectable } from '@nestjs/common';
+import { CreditNote } from '../../CreditNotes/models/CreditNote';
+import { TenantModelProxy } from '@/modules/System/models/TenantBaseModel';
+
+@Injectable()
+export class CreditNoteApplySyncCredit {
+  constructor(
+    @Inject(CreditNote.name)
+    private creditNoteModel: TenantModelProxy<typeof CreditNote>,
+  ) {}
+
+  /**
+   * Increment credit note invoiced amount.
+   * @param {number} creditNoteId
+   * @param {number} invoicesAppliedAmount
+   * @param {Knex.Transaction} [trx]
+   */
+  public async incrementCreditNoteInvoicedAmount(
+    creditNoteId: number,
+    invoicesAppliedAmount: number,
+    trx?: Knex.Transaction,
+  ): Promise<void> {
+    await this.creditNoteModel()
+      .query(trx)
+      .findById(creditNoteId)
+      .increment('invoicesAmount', invoicesAppliedAmount);
+  }
+
+  /**
+   * Decrement credit note invoiced amount.
+   * @param {number} creditNoteId
+   * @param {number} invoicesAppliedAmount
+   * @param {Knex.Transaction} [trx]
+   */
+  public async decrementCreditNoteInvoicedAmount(
+    creditNoteId: number,
+    invoicesAppliedAmount: number,
+    trx?: Knex.Transaction,
+  ): Promise<void> {
+    await this.creditNoteModel()
+      .query(trx)
+      .findById(creditNoteId)
+      .decrement('invoicesAmount', invoicesAppliedAmount);
+  }
+}
--- a/packages/server/src/modules/CreditNotesApplyInvoice/commands/CreditNoteApplySyncInvoices.service.ts
+++ b/packages/server/src/modules/CreditNotesApplyInvoice/commands/CreditNoteApplySyncInvoices.service.ts
@@ -0,0 +1,55 @@
+import { Knex } from 'knex';
+import { Injectable, Inject } from '@nestjs/common';
+import Bluebird from 'bluebird';
+import { ICreditNoteAppliedToInvoice } from '../types/CreditNoteApplyInvoice.types';
+import { SaleInvoice } from '@/modules/SaleInvoices/models/SaleInvoice';
+import { CreditNoteAppliedInvoice } from '../models/CreditNoteAppliedInvoice';
+import { TenantModelProxy } from '@/modules/System/models/TenantBaseModel';
+
+@Injectable()
+export class CreditNoteApplySyncInvoicesCreditedAmount {
+  /**
+   * @param {typeof SaleInvoice} saleInvoiceModel - Sale invoice model.
+   */
+  constructor(
+    @Inject(SaleInvoice.name)
+    private readonly saleInvoiceModel: TenantModelProxy<typeof SaleInvoice>,
+  ) {}
+
+  /**
+   * Increment invoices credited amount.
+   * @param {ICreditNoteAppliedToInvoice[]} creditNoteAppliedInvoices -
+   * @param {Knex.Transaction} trx -
+   */
+  public incrementInvoicesCreditedAmount = async (
+    creditNoteAppliedInvoices: ICreditNoteAppliedToInvoice[],
+    trx?: Knex.Transaction,
+  ) => {
+    await Bluebird.each(
+      creditNoteAppliedInvoices,
+      (creditNoteAppliedInvoice: CreditNoteAppliedInvoice) => {
+        return this.saleInvoiceModel()
+          .query(trx)
+          .where('id', creditNoteAppliedInvoice.invoiceId)
+          .increment('creditedAmount', creditNoteAppliedInvoice.amount);
+      },
+    );
+  };
+
+  /**
+   *
+   * @param {number} invoicesIds
+   * @param {number} amount -
+   * @param {Knex.Transaction} knex -
+   */
+  public decrementInvoiceCreditedAmount = async (
+    invoiceId: number,
+    amount: number,
+    trx?: Knex.Transaction,
+  ) => {
+    await this.saleInvoiceModel()
+      .query(trx)
+      .findById(invoiceId)
+      .decrement('creditedAmount', amount);
+  };
+}
--- a/packages/server/src/modules/CreditNotesApplyInvoice/commands/CreditNoteApplyToInvoices.service.ts
+++ b/packages/server/src/modules/CreditNotesApplyInvoice/commands/CreditNoteApplyToInvoices.service.ts
@@ -0,0 +1,140 @@
+import { Inject, Injectable } from '@nestjs/common';
+import { Knex } from 'knex';
+import { sumBy } from 'lodash';
+import {
+  ICreditNoteAppliedToInvoiceModel,
+  IApplyCreditToInvoicesDTO,
+  IApplyCreditToInvoicesCreatedPayload,
+} from '../types/CreditNoteApplyInvoice.types';
+import { ERRORS } from '../../CreditNotes/constants';
+import { PaymentReceivedValidators } from '@/modules/PaymentReceived/commands/PaymentReceivedValidators.service';
+import { UnitOfWork } from '@/modules/Tenancy/TenancyDB/UnitOfWork.service';
+import { EventEmitter2 } from '@nestjs/event-emitter';
+import { events } from '@/common/events/events';
+import { SaleInvoice } from '@/modules/SaleInvoices/models/SaleInvoice';
+import { ServiceError } from '@/modules/Items/ServiceError';
+import { CreditNote } from '@/modules/CreditNotes/models/CreditNote';
+import { CreditNoteAppliedInvoice } from '../models/CreditNoteAppliedInvoice';
+import { CommandCreditNoteDTOTransform } from '@/modules/CreditNotes/commands/CommandCreditNoteDTOTransform.service';
+import { TenantModelProxy } from '@/modules/System/models/TenantBaseModel';
+
+@Injectable()
+export class CreditNoteApplyToInvoices {
+  /**
+   * @param {PaymentReceivedValidators} paymentReceiveValidators - The payment received validators service.
+   * @param {UnitOfWork} uow - The unit of work service.
+   * @param {EventEmitter2} eventPublisher - The event emitter service.
+   * @param {typeof CreditNoteAppliedInvoice} creditNoteAppliedInvoiceModel - The credit note applied invoice model.
+   */
+  constructor(
+    private readonly paymentReceiveValidators: PaymentReceivedValidators,
+    private readonly uow: UnitOfWork,
+    private readonly eventPublisher: EventEmitter2,
+    private readonly creditNoteDTOTransform: CommandCreditNoteDTOTransform,
+
+    @Inject(CreditNoteAppliedInvoice.name)
+    private readonly creditNoteAppliedInvoiceModel: TenantModelProxy<
+      typeof CreditNoteAppliedInvoice
+    >,
+
+    @Inject(CreditNote.name)
+    private readonly creditNoteModel: TenantModelProxy<typeof CreditNote>,
+  ) {}
+
+  /**
+   * Apply credit note to the given invoices.
+   * @param {number} creditNoteId
+   * @param {IApplyCreditToInvoicesDTO} applyCreditToInvoicesDTO
+   */
+  public async applyCreditNoteToInvoices(
+    creditNoteId: number,
+    applyCreditToInvoicesDTO: IApplyCreditToInvoicesDTO,
+  ): Promise<CreditNoteAppliedInvoice[]> {
+    // Saves the credit note or throw not found service error.
+    const creditNote = await this.creditNoteModel()
+      .query()
+      .findById(creditNoteId)
+      .throwIfNotFound();
+
+    // Retrieve the applied invoices that associated to the credit note customer.
+    const appliedInvoicesEntries =
+      await this.paymentReceiveValidators.validateInvoicesIDsExistance(
+        creditNote.customerId,
+        applyCreditToInvoicesDTO.entries,
+      );
+
+    // Transformes apply DTO to model.
+    const creditNoteAppliedModel = this.transformApplyDTOToModel(
+      applyCreditToInvoicesDTO,
+      creditNote,
+    );
+    // Validate invoices has remaining amount to apply.
+    this.validateInvoicesRemainingAmount(
+      appliedInvoicesEntries,
+      creditNoteAppliedModel.amount,
+    );
+    // Validate the credit note remaining amount.
+    this.creditNoteDTOTransform.validateCreditRemainingAmount(
+      creditNote,
+      creditNoteAppliedModel.amount,
+    );
+    // Creates credit note apply to invoice transaction.
+    return this.uow.withTransaction(async (trx: Knex.Transaction) => {
+      // Saves the credit note apply to invoice graph to the storage layer.
+      const creditNoteAppliedInvoices =
+        await this.creditNoteAppliedInvoiceModel()
+          .query()
+          .insertGraph(creditNoteAppliedModel.entries);
+
+      // Triggers `onCreditNoteApplyToInvoiceCreated` event.
+      await this.eventPublisher.emitAsync(
+        events.creditNote.onApplyToInvoicesCreated,
+        {
+          creditNote,
+          creditNoteAppliedInvoices,
+          trx,
+        } as IApplyCreditToInvoicesCreatedPayload,
+      );
+
+      return creditNoteAppliedInvoices;
+    });
+  }
+
+  /**
+   * Transformes apply DTO to model.
+   * @param {IApplyCreditToInvoicesDTO} applyDTO
+   * @param {ICreditNote} creditNote
+   * @returns
+   */
+  private transformApplyDTOToModel = (
+    applyDTO: IApplyCreditToInvoicesDTO,
+    creditNote: CreditNote,
+  ): ICreditNoteAppliedToInvoiceModel => {
+    const entries = applyDTO.entries.map((entry) => ({
+      invoiceId: entry.invoiceId,
+      amount: entry.amount,
+      creditNoteId: creditNote.id,
+    }));
+    return {
+      amount: sumBy(entries, 'amount'),
+      entries,
+    };
+  };
+
+  /**
+   * Validate the invoice remaining amount.
+   * @param {ISaleInvoice[]} invoices
+   * @param {number} amount
+   */
+  private validateInvoicesRemainingAmount = (
+    invoices: SaleInvoice[],
+    amount: number,
+  ) => {
+    const invalidInvoices = invoices.filter(
+      (invoice) => invoice.dueAmount < amount,
+    );
+    if (invalidInvoices.length > 0) {
+      throw new ServiceError(ERRORS.INVOICES_HAS_NO_REMAINING_AMOUNT);
+    }
+  };
+}
--- a/packages/server/src/modules/CreditNotesApplyInvoice/commands/DeleteCreditNoteApplyToInvoices.service.ts
+++ b/packages/server/src/modules/CreditNotesApplyInvoice/commands/DeleteCreditNoteApplyToInvoices.service.ts
@@ -0,0 +1,75 @@
+import { Inject, Injectable } from '@nestjs/common';
+import { Knex } from 'knex';
+import { EventEmitter2 } from '@nestjs/event-emitter';
+import { IApplyCreditToInvoicesDeletedPayload } from '../types/CreditNoteApplyInvoice.types';
+import { CreditNoteAppliedInvoice } from '../models/CreditNoteAppliedInvoice';
+import { UnitOfWork } from '@/modules/Tenancy/TenancyDB/UnitOfWork.service';
+import { events } from '@/common/events/events';
+import { ServiceError } from '@/modules/Items/ServiceError';
+import { CreditNote } from '../../CreditNotes/models/CreditNote';
+import { ERRORS } from '../../CreditNotes/constants';
+import { TenantModelProxy } from '@/modules/System/models/TenantBaseModel';
+
+@Injectable()
+export default class DeleteCreditNoteApplyToInvoices {
+  /**
+   * @param {UnitOfWork} uow - Unit of work.
+   * @param {EventEmitter2} eventPublisher - Event emitter.
+   * @param {typeof CreditNoteAppliedInvoice} creditNoteAppliedInvoiceModel - Credit note applied invoice model.
+   * @param {typeof CreditNote} creditNoteModel - Credit note model.
+   */
+  constructor(
+    private readonly uow: UnitOfWork,
+    private readonly eventPublisher: EventEmitter2,
+
+    @Inject(CreditNoteAppliedInvoice.name)
+    private readonly creditNoteAppliedInvoiceModel: TenantModelProxy<
+      typeof CreditNoteAppliedInvoice
+    >,
+
+    @Inject(CreditNote.name)
+    private readonly creditNoteModel: TenantModelProxy<typeof CreditNote>,
+  ) {}
+
+  /**
+   * Apply credit note to the given invoices.
+   * @param {number} creditNoteId
+   * @param {IApplyCreditToInvoicesDTO} applyCreditToInvoicesDTO
+   */
+  public deleteApplyCreditNoteToInvoices = async (
+    applyCreditToInvoicesId: number,
+  ): Promise<void> => {
+    const creditNoteAppliedToInvoice =
+      await this.creditNoteAppliedInvoiceModel()
+        .query()
+        .findById(applyCreditToInvoicesId);
+
+    if (!creditNoteAppliedToInvoice) {
+      throw new ServiceError(ERRORS.CREDIT_NOTE_APPLY_TO_INVOICES_NOT_FOUND);
+    }
+    // Retrieve the credit note or throw not found service error.
+    const creditNote = await this.creditNoteModel()
+      .query()
+      .findById(creditNoteAppliedToInvoice.creditNoteId)
+      .throwIfNotFound();
+
+    // Creates credit note apply to invoice transaction.
+    return this.uow.withTransaction(async (trx: Knex.Transaction) => {
+      // Delete credit note applied to invoices.
+      await this.creditNoteAppliedInvoiceModel()
+        .query(trx)
+        .findById(applyCreditToInvoicesId)
+        .delete();
+
+      // Triggers `onCreditNoteApplyToInvoiceDeleted` event.
+      await this.eventPublisher.emitAsync(
+        events.creditNote.onApplyToInvoicesDeleted,
+        {
+          creditNote,
+          creditNoteAppliedToInvoice,
+          trx,
+        } as IApplyCreditToInvoicesDeletedPayload,
+      );
+    });
+  };
+}
--- a/packages/server/src/modules/CreditNotesApplyInvoice/commands/DeleteCustomerLinkedCreditNote.service.ts
+++ b/packages/server/src/modules/CreditNotesApplyInvoice/commands/DeleteCustomerLinkedCreditNote.service.ts
@@ -0,0 +1,30 @@
+import { Inject, Injectable } from '@nestjs/common';
+import { CreditNote } from '../../CreditNotes/models/CreditNote';
+import { ERRORS } from '../../CreditNotes/constants';
+import { ServiceError } from '@/modules/Items/ServiceError';
+import { TenantModelProxy } from '@/modules/System/models/TenantBaseModel';
+
+@Injectable()
+export class DeleteCustomerLinkedCreditNoteService {
+  /**
+   * @param {typeof CreditNote} creditNoteModel - Credit note model.
+   */
+  constructor(
+    @Inject(CreditNote.name)
+    private readonly creditNoteModel: TenantModelProxy<typeof CreditNote>,
+  ) {}
+
+  /**
+   * Validate the given customer has no linked credit note transactions.
+   * @param {number} customerId - The customer identifier.
+   */
+  public async validateCustomerHasNoCreditTransaction(customerId: number) {
+    const associatedCredits = await this.creditNoteModel()
+      .query()
+      .where('customerId', customerId);
+
+    if (associatedCredits.length > 0) {
+      throw new ServiceError(ERRORS.CUSTOMER_HAS_LINKED_CREDIT_NOTES);
+    }
+  }
+}