feat: migrate manual journal to nestjs

2026-02-20 14:50:32 +00:00 · 2024-12-26 20:57:21 +02:00
parent cd84872a61
commit 736cedd63d
34 changed files with 2129 additions and 69 deletions
--- a/packages/server-nest/src/modules/ManualJournals/commands/EditManualJournal.service.ts
+++ b/packages/server-nest/src/modules/ManualJournals/commands/EditManualJournal.service.ts
@@ -0,0 +1,139 @@
+import { Knex } from 'knex';
+import { omit, sumBy } from 'lodash';
+import * as moment from 'moment';
+import { Inject, Injectable } from '@nestjs/common';
+import {
+  IManualJournalDTO,
+  IManualJournalEventEditedPayload,
+  IManualJournalEditingPayload,
+} from '../types/ManualJournals.types';
+import { EventEmitter2 } from '@nestjs/event-emitter';
+import { UnitOfWork } from '@/modules/Tenancy/TenancyDB/UnitOfWork.service';
+import { CommandManualJournalValidators } from './CommandManualJournalValidators.service';
+import { events } from '@/common/events/events';
+import { ManualJournal } from '../models/ManualJournal';
+
+@Injectable()
+export class EditManualJournal {
+  constructor(
+    private eventPublisher: EventEmitter2,
+    private uow: UnitOfWork,
+    private validator: CommandManualJournalValidators,
+
+    @Inject(ManualJournal.name)
+    private manualJournalModel: typeof ManualJournal,
+  ) {}
+
+  /**
+   * Authorize the manual journal editing.
+   * @param {number} tenantId
+   * @param {number} manualJournalId
+   * @param {IManualJournalDTO} manualJournalDTO
+   */
+  private authorize = async (
+    manualJournalId: number,
+    manualJournalDTO: IManualJournalDTO,
+  ) => {
+    // Validates the total credit and debit to be equals.
+    this.validator.valdiateCreditDebitTotalEquals(manualJournalDTO);
+
+    // Validate the contacts existance.
+    await this.validator.validateContactsExistance(manualJournalDTO);
+
+    // Validates entries accounts existance.
+    await this.validator.validateAccountsExistance(manualJournalDTO);
+
+    // Validates the manual journal number uniquiness.
+    if (manualJournalDTO.journalNumber) {
+      await this.validator.validateManualJournalNoUnique(
+        manualJournalDTO.journalNumber,
+        manualJournalId,
+      );
+    }
+    // Validate accounts with contact type from the given config.
+    await this.validator.dynamicValidateAccountsWithContactType(
+      manualJournalDTO.entries,
+    );
+  };
+
+  /**
+   * Transform the edit manual journal DTO to upsert graph operation.
+   * @param {IManualJournalDTO} manualJournalDTO - Manual jorunal DTO.
+   * @param {IManualJournal} oldManualJournal
+   */
+  private transformEditDTOToModel = (
+    manualJournalDTO: IManualJournalDTO,
+    oldManualJournal: ManualJournal,
+  ) => {
+    const amount = sumBy(manualJournalDTO.entries, 'credit') || 0;
+    const date = moment(manualJournalDTO.date).format('YYYY-MM-DD');
+
+    return {
+      id: oldManualJournal.id,
+      ...omit(manualJournalDTO, ['publish', 'attachments']),
+      ...(manualJournalDTO.publish && !oldManualJournal.publishedAt
+        ? { publishedAt: moment().toMySqlDateTime() }
+        : {}),
+      amount,
+      date,
+    };
+  };
+
+  /**
+   * Edits jouranl entries.
+   * @param {number} tenantId
+   * @param {number} manualJournalId
+   * @param {IMakeJournalDTO} manualJournalDTO
+   * @param {ISystemUser} authorizedUser
+   */
+  public async editJournalEntries(
+    manualJournalId: number,
+    manualJournalDTO: IManualJournalDTO,
+  ): Promise<{
+    manualJournal: ManualJournal;
+    oldManualJournal: ManualJournal;
+  }> {
+    // Validates the manual journal existance on the storage.
+    const oldManualJournal = await ManualJournal.query()
+      .findById(manualJournalId)
+      .throwIfNotFound();
+
+    // Authorize manual journal editing.
+    await this.authorize(manualJournalId, manualJournalDTO);
+
+    // Transform manual journal DTO to model.
+    const manualJournalObj = this.transformEditDTOToModel(
+      manualJournalDTO,
+      oldManualJournal,
+    );
+    // Edits the manual journal transactions with associated transactions
+    // under unit-of-work envirement.
+    return this.uow.withTransaction(async (trx: Knex.Transaction) => {
+      // Triggers `onManualJournalEditing` event.
+      await this.eventPublisher.emitAsync(events.manualJournals.onEditing, {
+        manualJournalDTO,
+        oldManualJournal,
+        trx,
+      } as IManualJournalEditingPayload);
+
+      // Upserts the manual journal graph to the storage.
+      await this.manualJournalModel.query(trx).upsertGraph({
+        ...manualJournalObj,
+      });
+      // Retrieve the given manual journal with associated entries after modifications.
+      const manualJournal = await this.manualJournalModel.query(trx)
+        .findById(manualJournalId)
+        .withGraphFetched('entries');
+
+      // Triggers `onManualJournalEdited` event.
+      await this.eventPublisher.emitAsync(events.manualJournals.onEdited, {
+        manualJournal,
+        oldManualJournal,
+        manualJournalDTO,
+        trx,
+      } as IManualJournalEventEditedPayload);
+
+      return { manualJournal, oldManualJournal };
+    });
+  }
+}