feat: match bank transaction

packages/server/src/services/Banking/Matching/GetMatchedTransactionManualJournalsTransformer.ts

@@ -43,7 +43,7 @@ export class GetMatchedTransactionManualJournalsTransformer extends Transformer
    * @returns {number}
    */
   protected amount(manualJournal) {
-    return manualJournal.totalAmount;
+    return manualJournal.amount;
   }
 
   /**
@@ -52,7 +52,7 @@ export class GetMatchedTransactionManualJournalsTransformer extends Transformer
    * @returns {string}
    */
   protected amountFormatted(manualJournal) {
-    return this.formatNumber(manualJournal.totalAmount, {
+    return this.formatNumber(manualJournal.amount, {
       currencyCode: manualJournal.currencyCode,
     });
   }

packages/server/src/services/Banking/Matching/GetMatchedTransactions.ts

@@ -1,7 +1,7 @@
 import { Inject, Service } from 'typedi';
 import * as R from 'ramda';
 import { PromisePool } from '@supercharge/promise-pool';
-import { GetMatchedTransactionsFilter } from './types';
+import { GetMatchedTransactionsFilter, MatchedTransactionsPOJO } from './types';
 import { GetMatchedTransactionsByExpenses } from './GetMatchedTransactionsByExpenses';
 import { GetMatchedTransactionsByBills } from './GetMatchedTransactionsByBills';
 import { GetMatchedTransactionsByManualJournals } from './GetMatchedTransactionsByManualJournals';
@@ -20,6 +20,9 @@ export class GetMatchedTransactions {
   @Inject()
   private getMatchedExpensesService: GetMatchedTransactionsByExpenses;
 
+  /**
+   * Registered matched transactions types.
+   */
   get registered() {
     return [
       { type: 'SaleInvoice', service: this.getMatchedInvoicesService },
@@ -37,7 +40,7 @@ export class GetMatchedTransactions {
   public async getMatchedTransactions(
     tenantId: number,
     filter: GetMatchedTransactionsFilter
-  ) {
+  ): Promise<MatchedTransactionsPOJO> {
     const filtered = filter.transactionType
       ? this.registered.filter((item) => item.type === filter.transactionType)
       : this.registered;
@@ -50,13 +53,3 @@ export class GetMatchedTransactions {
     return R.compose(R.flatten)(matchedTransactions?.results);
   }
 }
-
-interface MatchedTransaction {
-  amount: number;
-  amountFormatted: string;
-  date: string;
-  dateFormatted: string;
-  referenceNo: string;
-  transactionNo: string;
-  transactionId: number;
-}

packages/server/src/services/Banking/Matching/GetMatchedTransactionsByBills.ts

@@ -1,12 +1,12 @@
+import { Inject, Service } from 'typedi';
 import { TransformerInjectable } from '@/lib/Transformer/TransformerInjectable';
 import { GetMatchedTransactionBillsTransformer } from './GetMatchedTransactionBillsTransformer';
-import { GetMatchedTransactionInvoicesTransformer } from './GetMatchedTransactionInvoicesTransformer';
 import { GetMatchedTransactionsFilter } from './types';
 import HasTenancyService from '@/services/Tenancy/TenancyService';
-import { Inject, Service } from 'typedi';
+import { GetMatchedTransactionsByType } from './GetMatchedTransactionsByType';
 
 @Service()
-export class GetMatchedTransactionsByBills {
+export class GetMatchedTransactionsByBills extends GetMatchedTransactionsByType {
   @Inject()
   private tenancy: HasTenancyService;
 

packages/server/src/services/Banking/Matching/GetMatchedTransactionsByExpenses.ts

@@ -3,14 +3,15 @@ import { GetMatchedTransactionManualJournalsTransformer } from './GetMatchedTran
 import { GetMatchedTransactionsFilter } from './types';
 import { TransformerInjectable } from '@/lib/Transformer/TransformerInjectable';
 import HasTenancyService from '@/services/Tenancy/TenancyService';
+import { GetMatchedTransactionsByType } from './GetMatchedTransactionsByType';
 
 @Service()
-export class GetMatchedTransactionsByExpenses {
+export class GetMatchedTransactionsByExpenses extends GetMatchedTransactionsByType {
   @Inject()
-  private tenancy: HasTenancyService;
+  protected tenancy: HasTenancyService;
 
   @Inject()
-  private transformer: TransformerInjectable;
+  protected transformer: TransformerInjectable;
 
   /**
    *

packages/server/src/services/Banking/Matching/GetMatchedTransactionsByInvoices.ts

@@ -1,16 +1,21 @@
 import { TransformerInjectable } from '@/lib/Transformer/TransformerInjectable';
 import { GetMatchedTransactionInvoicesTransformer } from './GetMatchedTransactionInvoicesTransformer';
-import { GetMatchedTransactionsFilter } from './types';
+import {
+  GetMatchedTransactionsFilter,
+  MatchedTransactionPOJO,
+  MatchedTransactionsPOJO,
+} from './types';
 import HasTenancyService from '@/services/Tenancy/TenancyService';
 import { Inject, Service } from 'typedi';
+import { GetMatchedTransactionsByType } from './GetMatchedTransactionsByType';
 
 @Service()
-export class GetMatchedTransactionsByInvoices {
+export class GetMatchedTransactionsByInvoices extends GetMatchedTransactionsByType {
   @Inject()
-  private tenancy: HasTenancyService;
+  protected tenancy: HasTenancyService;
 
   @Inject()
-  private transformer: TransformerInjectable;
+  protected transformer: TransformerInjectable;
 
   /**
    * Retrieves the matched transactions.
@@ -20,7 +25,7 @@ export class GetMatchedTransactionsByInvoices {
   public async getMatchedTransactions(
     tenantId: number,
     filter: GetMatchedTransactionsFilter
-  ) {
+  ): Promise<MatchedTransactionsPOJO> {
     const { SaleInvoice } = this.tenancy.models(tenantId);
 
     const invoices = await SaleInvoice.query();
@@ -31,4 +36,27 @@ export class GetMatchedTransactionsByInvoices {
       new GetMatchedTransactionInvoicesTransformer()
     );
   }
+
+  /**
+   *
+   * @param {number} tenantId
+   * @param {number} transactionId
+   * @returns
+   */
+  public async getMatchedTransaction(
+    tenantId: number,
+    transactionId: number
+  ): Promise<MatchedTransactionPOJO> {
+    const { SaleInvoice } = this.tenancy.models(tenantId);
+
+    console.log(transactionId);
+
+    const invoice = await SaleInvoice.query().findById(transactionId);
+
+    return this.transformer.transform(
+      tenantId,
+      invoice,
+      new GetMatchedTransactionInvoicesTransformer()
+    );
+  }
 }

packages/server/src/services/Banking/Matching/GetMatchedTransactionsByManualJournals.ts

@@ -1,17 +1,20 @@
 import { TransformerInjectable } from '@/lib/Transformer/TransformerInjectable';
 import { GetMatchedTransactionManualJournalsTransformer } from './GetMatchedTransactionManualJournalsTransformer';
 import { Inject, Service } from 'typedi';
-import HasTenancyService from '@/services/Tenancy/TenancyService';
 import { GetMatchedTransactionsFilter } from './types';
+import { GetMatchedTransactionsByType } from './GetMatchedTransactionsByType';
 
 @Service()
-export class GetMatchedTransactionsByManualJournals {
-  @Inject()
-  private tenancy: HasTenancyService;
-
+export class GetMatchedTransactionsByManualJournals extends GetMatchedTransactionsByType {
   @Inject()
   private transformer: TransformerInjectable;
 
+  /**
+   * Retrieve the matched transactions of manual journals.
+   * @param {number} tenantId
+   * @param {GetMatchedTransactionsFilter} filter
+   * @returns
+   */
   async getMatchedTransactions(
     tenantId: number,
     filter: GetMatchedTransactionsFilter
@@ -26,4 +29,24 @@ export class GetMatchedTransactionsByManualJournals {
       new GetMatchedTransactionManualJournalsTransformer()
     );
   }
+
+  /**
+   * Retrieves the matched transaction of manual journals.
+   * @param {number} tenantId
+   * @param {number} transactionId
+   * @returns
+   */
+  async getMatchedTransaction(tenantId: number, transactionId: number) {
+    const { ManualJournal } = this.tenancy.models(tenantId);
+
+    const manualJournal = await ManualJournal.query()
+      .findById(transactionId)
+      .throwIfNotFound();
+
+    return this.transformer.transform(
+      tenantId,
+      manualJournal,
+      new GetMatchedTransactionManualJournalsTransformer()
+    );
+  }
 }

packages/server/src/services/Banking/Matching/GetMatchedTransactionsByType.ts

@@ -0,0 +1,65 @@
+import { Knex } from 'knex';
+import HasTenancyService from '@/services/Tenancy/TenancyService';
+import {
+  GetMatchedTransactionsFilter,
+  IMatchTransactionDTO,
+  MatchedTransactionPOJO,
+  MatchedTransactionsPOJO,
+} from './types';
+import { Inject, Service } from 'typedi';
+
+// @Service()
+export abstract class GetMatchedTransactionsByType {
+  @Inject()
+  protected tenancy: HasTenancyService;
+
+  /**
+   * Retrieves the matched transactions.
+   * @param {number} tenantId -
+   * @param {GetMatchedTransactionsFilter} filter -
+   */
+  public async getMatchedTransactions(
+    tenantId: number,
+    filter: GetMatchedTransactionsFilter
+  ): Promise<MatchedTransactionsPOJO> {
+    throw new Error(
+      'The `getMatchedTransactions` method is not defined for the transaction type.'
+    );
+  }
+
+  /**
+   * Retrieves the matched transaction details.
+   * @param {number} tenantId -
+   * @param {number} transactionId -
+   */
+  public async getMatchedTransaction(
+    tenantId: number,
+    transactionId: number
+  ): Promise<MatchedTransactionPOJO> {
+    throw new Error(
+      'The `getMatchedTransaction` method is not defined for the transaction type.'
+    );
+  }
+
+  /**
+   *
+   * @param {number} tenantId
+   * @param {number} uncategorizedTransactionId
+   * @param {IMatchTransactionDTO} matchTransactionDTO
+   * @param {Knex.Transaction} trx
+   */
+  public async createMatchedTransaction(
+    tenantId: number,
+    uncategorizedTransactionId: number,
+    matchTransactionDTO: IMatchTransactionDTO,
+    trx?: Knex.Transaction
+  ) {
+    const { MatchedBankTransaction } = this.tenancy.models(tenantId);
+
+    await MatchedBankTransaction.query(trx).insert({
+      uncategorizedTransactionId,
+      referenceType: matchTransactionDTO.referenceType,
+      referenceId: matchTransactionDTO.referenceId,
+    });
+  }
+}

packages/server/src/services/Banking/Matching/MatchTransactions.ts

@@ -1,3 +1,4 @@
+import { sumBy } from 'lodash';
 import { PromisePool } from '@supercharge/promise-pool';
 import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
 import HasTenancyService from '@/services/Tenancy/TenancyService';
@@ -6,10 +7,13 @@ import events from '@/subscribers/events';
 import { Knex } from 'knex';
 import { Inject, Service } from 'typedi';
 import {
+  ERRORS,
   IBankTransactionMatchedEventPayload,
   IBankTransactionMatchingEventPayload,
-  IMatchTransactionDTO,
+  IMatchTransactionsDTO,
 } from './types';
+import { MatchTransactionsTypes } from './MatchTransactionsTypes';
+import { ServiceError } from '@/exceptions';
 
 @Service()
 export class MatchBankTransactions {
@@ -22,22 +26,90 @@ export class MatchBankTransactions {
   @Inject()
   private eventPublisher: EventPublisher;
 
+  @Inject()
+  private matchedBankTransactions: MatchTransactionsTypes;
+
+  /**
+   * Validates the match bank transactions DTO.
+   * @param {number} tenantId
+   * @param {number} uncategorizedTransactionId
+   * @param {IMatchTransactionsDTO} matchTransactionsDTO
+   */
+  async validate(
+    tenantId: number,
+    uncategorizedTransactionId: number,
+    matchTransactionsDTO: IMatchTransactionsDTO
+  ) {
+    const { UncategorizedCashflowTransaction } = this.tenancy.models(tenantId);
+    const { matchedTransactions } = matchTransactionsDTO;
+
+    const uncategorizedTransaction =
+      await UncategorizedCashflowTransaction.query()
+        .findById(uncategorizedTransactionId)
+        .throwIfNotFound();
+
+    // Validates the given matched transaction.
+    const validateMatchedTransaction = async (matchedTransaction) => {
+      const getMatchedTransactionsService =
+        this.matchedBankTransactions.registry.get(
+          matchedTransaction.referenceType
+        );
+      if (!getMatchedTransactionsService) {
+        throw new ServiceError(
+          ERRORS.RESOURCE_TYPE_MATCHING_TRANSACTION_INVALID
+        );
+      }
+      const foundMatchedTransaction =
+        await getMatchedTransactionsService.getMatchedTransaction(
+          tenantId,
+          matchedTransaction.referenceId
+        );
+      if (!foundMatchedTransaction) {
+        throw new ServiceError(ERRORS.RESOURCE_ID_MATCHING_TRANSACTION_INVALID);
+      }
+      return foundMatchedTransaction;
+    };
+    // Matches the given transactions under promise pool concurrency controlling.
+    const validatationResult = await PromisePool.withConcurrency(10)
+      .for(matchedTransactions)
+      .process(validateMatchedTransaction);
+
+    if (validatationResult.errors?.length > 0) {
+      const error = validatationResult.errors.map((er) => er.raw)[0];
+      throw new ServiceError(error);
+    }
+    // Calculate the total given matching transactions.
+    const totalMatchedTranasctions = sumBy(
+      validatationResult.results,
+      'amount'
+    );
+    // Validates the total given matching transcations whether is not equal
+    // uncategorized transaction amount.
+    if (totalMatchedTranasctions !== uncategorizedTransaction.amount) {
+      throw new ServiceError(ERRORS.TOTAL_MATCHING_TRANSACTIONS_INVALID);
+    }
+  }
+
   /**
    * Matches the given uncategorized transaction to the given references.
    * @param {number} tenantId
    * @param {number} uncategorizedTransactionId
    */
-  public matchTransaction(
+  public async matchTransaction(
     tenantId: number,
     uncategorizedTransactionId: number,
-    matchTransactionsDTO: IMatchTransactionDTO
+    matchTransactionsDTO: IMatchTransactionsDTO
   ) {
     const { matchedTransactions } = matchTransactionsDTO;
-    const { MatchBankTransaction } = this.tenancy.models(tenantId);
 
-    //
+    // Validates the given matching transactions DTO.
+    await this.validate(
+      tenantId,
+      uncategorizedTransactionId,
+      matchTransactionsDTO
+    );
     return this.uow.withTransaction(tenantId, async (trx: Knex.Transaction) => {
-      // Triggers the event `onSaleInvoiceCreated`.
+      // Triggers the event `onBankTransactionMatching`.
       await this.eventPublisher.emitAsync(events.bankMatch.onMatching, {
         tenantId,
         uncategorizedTransactionId,
@@ -45,19 +117,23 @@ export class MatchBankTransactions {
         trx,
       } as IBankTransactionMatchingEventPayload);
 
-      //  Matches the given transactions under promise pool concurrency controlling.
+      // Matches the given transactions under promise pool concurrency controlling.
       await PromisePool.withConcurrency(10)
         .for(matchedTransactions)
         .process(async (matchedTransaction) => {
-          await MatchBankTransaction.query(trx).insert({
+          const getMatchedTransactionsService =
+            this.matchedBankTransactions.registry.get(
+              matchedTransaction.referenceType
+            );
+          await getMatchedTransactionsService.createMatchedTransaction(
+            tenantId,
             uncategorizedTransactionId,
-            referenceType: matchedTransaction.referenceType,
-            referenceId: matchedTransaction.referenceId,
-            amount: matchedTransaction.amount,
-          });
+            matchedTransaction,
+            trx
+          );
         });
 
-      // Triggers the event `onSaleInvoiceCreated`.
+      // Triggers the event `onBankTransactionMatched`.
       await this.eventPublisher.emitAsync(events.bankMatch.onMatched, {
         tenantId,
         uncategorizedTransactionId,

packages/server/src/services/Banking/Matching/MatchTransactionsTypes.ts

@@ -0,0 +1,57 @@
+import Container, { Service } from 'typedi';
+import { GetMatchedTransactionsByExpenses } from './GetMatchedTransactionsByExpenses';
+import { GetMatchedTransactionsByBills } from './GetMatchedTransactionsByBills';
+import { GetMatchedTransactionsByManualJournals } from './GetMatchedTransactionsByManualJournals';
+import { MatchTransactionsTypesRegistry } from './MatchTransactionsTypesRegistry';
+import { GetMatchedTransactionsByInvoices } from './GetMatchedTransactionsByInvoices';
+
+@Service()
+export class MatchTransactionsTypes {
+  private static registry: MatchTransactionsTypesRegistry;
+
+  /**
+   * Consttuctor method.
+   */
+  constructor() {
+    this.boot();
+  }
+
+  get registered() {
+    return [
+      { type: 'SaleInvoice', service: GetMatchedTransactionsByInvoices },
+      { type: 'Bill', service: GetMatchedTransactionsByBills },
+      { type: 'Expense', service: GetMatchedTransactionsByExpenses },
+      {
+        type: 'ManualJournal',
+        service: GetMatchedTransactionsByManualJournals,
+      },
+    ];
+  }
+
+  /**
+   * Importable instances.
+   */
+  private types = [];
+
+  /**
+   *
+   */
+  public get registry() {
+    return MatchTransactionsTypes.registry;
+  }
+
+  /**
+   * Boots all the registered importables.
+   */
+  public boot() {
+    if (!MatchTransactionsTypes.registry) {
+      const instance = MatchTransactionsTypesRegistry.getInstance();
+
+      this.registered.forEach((registered) => {
+        const serviceInstanace = Container.get(registered.service);
+        instance.register(registered.type, serviceInstanace);
+      });
+      MatchTransactionsTypes.registry = instance;
+    }
+  }
+}

packages/server/src/services/Banking/Matching/MatchTransactionsTypesRegistry.ts

@@ -0,0 +1,50 @@
+import { camelCase, upperFirst } from 'lodash';
+import { GetMatchedTransactionsByType } from './GetMatchedTransactionsByType';
+
+export class MatchTransactionsTypesRegistry {
+  private static instance: MatchTransactionsTypesRegistry;
+  private importables: Record<string, GetMatchedTransactionsByType>;
+
+  constructor() {
+    this.importables = {};
+  }
+
+  /**
+   * Gets singleton instance of registry.
+   * @returns {MatchTransactionsTypesRegistry}
+   */
+  public static getInstance(): MatchTransactionsTypesRegistry {
+    if (!MatchTransactionsTypesRegistry.instance) {
+      MatchTransactionsTypesRegistry.instance =
+        new MatchTransactionsTypesRegistry();
+    }
+    return MatchTransactionsTypesRegistry.instance;
+  }
+
+  /**
+   * Registers the given importable service.
+   * @param {string} resource
+   * @param {GetMatchedTransactionsByType} importable
+   */
+  public register(
+    resource: string,
+    importable: GetMatchedTransactionsByType
+  ): void {
+    const _resource = this.sanitizeResourceName(resource);
+    this.importables[_resource] = importable;
+  }
+
+  /**
+   * Retrieves the importable service instance of the given resource name.
+   * @param {string} name
+   * @returns {GetMatchedTransactionsByType}
+   */
+  public get(name: string): GetMatchedTransactionsByType {
+    const _name = this.sanitizeResourceName(name);
+    return this.importables[_name];
+  }
+
+  private sanitizeResourceName(resource: string) {
+    return upperFirst(camelCase(resource));
+  }
+}

packages/server/src/services/Banking/Matching/types.ts

@@ -3,14 +3,14 @@ import { Knex } from 'knex';
 export interface IBankTransactionMatchingEventPayload {
   tenantId: number;
   uncategorizedTransactionId: number;
-  matchTransactionsDTO: IMatchTransactionDTO;
+  matchTransactionsDTO: IMatchTransactionsDTO;
   trx?: Knex.Transaction;
 }
 
 export interface IBankTransactionMatchedEventPayload {
   tenantId: number;
   uncategorizedTransactionId: number;
-  matchTransactionsDTO: IMatchTransactionDTO;
+  matchTransactionsDTO: IMatchTransactionsDTO;
   trx?: Knex.Transaction;
 }
 
@@ -23,11 +23,12 @@ export interface IBankTransactionUnmatchedEventPayload {
 }
 
 export interface IMatchTransactionDTO {
-  matchedTransactions: Array<{
-    referenceType: string;
-    referenceId: number;
-    amount: number;
-  }>;
+  referenceType: string;
+  referenceId: number;
+}
+
+export interface IMatchTransactionsDTO {
+  matchedTransactions: Array<IMatchTransactionDTO>;
 }
 
 export interface GetMatchedTransactionsFilter {
@@ -37,3 +38,24 @@ export interface GetMatchedTransactionsFilter {
   maxAmount: number;
   transactionType: string;
 }
+
+export interface MatchedTransactionPOJO {
+  amount: number;
+  amountFormatted: string;
+  date: string;
+  dateFormatted: string;
+  referenceNo: string;
+  transactionNo: string;
+  transactionId: number;
+}
+
+export type MatchedTransactionsPOJO = Array<MatchedTransactionPOJO[]>;
+
+export const ERRORS = {
+  RESOURCE_TYPE_MATCHING_TRANSACTION_INVALID:
+    'RESOURCE_TYPE_MATCHING_TRANSACTION_INVALID',
+  RESOURCE_ID_MATCHING_TRANSACTION_INVALID:
+    'RESOURCE_ID_MATCHING_TRANSACTION_INVALID',
+
+  TOTAL_MATCHING_TRANSACTIONS_INVALID: 'TOTAL_MATCHING_TRANSACTIONS_INVALID',
+};