refactor(nestjs): banking module

packages/server/src/modules/BankingTransactions/queries/GetPendingBankAccountTransaction.service.ts

@@ -2,6 +2,8 @@ import { Inject, Injectable } from '@nestjs/common';
 import { GetPendingBankAccountTransactionTransformer } from './GetPendingBankAccountTransactionTransformer';
 import { UncategorizedBankTransaction } from '../models/UncategorizedBankTransaction';
 import { TransformerInjectable } from '@/modules/Transformer/TransformerInjectable.service';
+import { TenantModelProxy } from '@/modules/System/models/TenantBaseModel';
+import { GetPendingTransactionsQueryDto } from '../dtos/GetPendingTransactionsQuery.dto';
 
 @Injectable()
 export class GetPendingBankAccountTransactions {
@@ -9,40 +11,37 @@ export class GetPendingBankAccountTransactions {
     private readonly transformerService: TransformerInjectable,
 
     @Inject(UncategorizedBankTransaction.name)
-    private readonly uncategorizedBankTransactionModel: typeof UncategorizedBankTransaction
+    private readonly uncategorizedBankTransactionModel: TenantModelProxy<
+      typeof UncategorizedBankTransaction
+    >,
   ) {}
 
   /**
    * Retrieves the given bank accounts pending transaction.
-   * @param {GetPendingTransactionsQuery} filter - Pending transactions query.
+   * @param {GetPendingTransactionsQueryDto} filter - Pending transactions query.
    */
-  async getPendingTransactions(filter?: GetPendingTransactionsQuery) {
+  async getPendingTransactions(filter?: GetPendingTransactionsQueryDto) {
     const _filter = {
-      page: 1, 
+      page: 1,
       pageSize: 20,
       ...filter,
     };
     const { results, pagination } =
-      await this.uncategorizedBankTransactionModel.query()
+      await this.uncategorizedBankTransactionModel()
+        .query()
         .onBuild((q) => {
           q.modify('pending');
 
-        if (_filter?.accountId) {
-          q.where('accountId', _filter.accountId);
-        }
-      })
-      .pagination(_filter.page - 1, _filter.pageSize);
+          if (_filter?.accountId) {
+            q.where('accountId', _filter.accountId);
+          }
+        })
+        .pagination(_filter.page - 1, _filter.pageSize);
 
     const data = await this.transformerService.transform(
       results,
-      new GetPendingBankAccountTransactionTransformer()
+      new GetPendingBankAccountTransactionTransformer(),
     );
     return { data, pagination };
   }
 }
-
-interface GetPendingTransactionsQuery {
-  page?: number;
-  pageSize?: number;
-  accountId?: number;
-}

packages/server/src/modules/BankingTransactions/queries/GetRecognizedTransaction.service.ts

@@ -1,39 +0,0 @@
-import { Inject, Injectable } from '@nestjs/common';
-import { GetRecognizedTransactionTransformer } from './GetRecognizedTransactionTransformer';
-import { TransformerInjectable } from '@/modules/Transformer/TransformerInjectable.service';
-import { UncategorizedBankTransaction } from '../models/UncategorizedBankTransaction';
-import { TenantModelProxy } from '@/modules/System/models/TenantBaseModel';
-
-@Injectable()
-export class GetRecognizedTransactionService {
-  constructor(
-    private readonly transformer: TransformerInjectable,
-
-    @Inject(UncategorizedBankTransaction.name)
-    private readonly uncategorizedBankTransactionModel: TenantModelProxy<
-      typeof UncategorizedBankTransaction
-    >,
-  ) {}
-
-  /**
-   * Retrieves the recognized transaction of the given uncategorized transaction.
-   * @param {number} tenantId
-   * @param {number} uncategorizedTransactionId
-   */
-  public async getRecognizedTransaction(uncategorizedTransactionId: number) {
-    const uncategorizedTransaction =
-      await this.uncategorizedBankTransactionModel()
-        .query()
-        .findById(uncategorizedTransactionId)
-        .withGraphFetched('matchedBankTransactions')
-        .withGraphFetched('recognizedTransaction.assignAccount')
-        .withGraphFetched('recognizedTransaction.bankRule')
-        .withGraphFetched('account')
-        .throwIfNotFound();
-
-    return this.transformer.transform(
-      uncategorizedTransaction,
-      new GetRecognizedTransactionTransformer(),
-    );
-  }
-}

packages/server/src/modules/BankingTransactions/queries/GetRecognizedTransactionTransformer.ts

@@ -1,261 +0,0 @@
-import { Transformer } from "@/modules/Transformer/Transformer";
-
-export class GetRecognizedTransactionTransformer extends Transformer {
-  /**
-   * Include these attributes to sale credit note object.
-   * @returns {Array}
-   */
-  public includeAttributes = (): string[] => {
-    return [
-      'uncategorizedTransactionId',
-      'referenceNo',
-      'description',
-      'payee',
-      'amount',
-      'formattedAmount',
-      'date',
-      'formattedDate',
-      'assignedAccountId',
-      'assignedAccountName',
-      'assignedAccountCode',
-      'assignedPayee',
-      'assignedMemo',
-      'assignedCategory',
-      'assignedCategoryFormatted',
-      'withdrawal',
-      'deposit',
-      'isDepositTransaction',
-      'isWithdrawalTransaction',
-      'formattedDepositAmount',
-      'formattedWithdrawalAmount',
-      'bankRuleId',
-      'bankRuleName',
-    ];
-  };
-
-  /**
-   * Exclude all attributes.
-   * @returns {Array<string>}
-   */
-  public excludeAttributes = (): string[] => {
-    return ['*'];
-  };
-
-  /**
-   * Get the uncategorized transaction id.
-   * @param transaction 
-   * @returns {number}
-   */
-  public uncategorizedTransactionId = (transaction): number => {
-    return transaction.id; 
-  }
-
-  /**
-   * Get the reference number of the transaction.
-   * @param {object} transaction
-   * @returns {string}
-   */
-  public referenceNo(transaction: any): string {
-    return transaction.referenceNo;
-  }
-
-  /**
-   * Get the description of the transaction.
-   * @param {object} transaction
-   * @returns {string}
-   */
-  public description(transaction: any): string {
-    return transaction.description;
-  }
-
-  /**
-   * Get the payee of the transaction.
-   * @param {object} transaction
-   * @returns {string}
-   */
-  public payee(transaction: any): string {
-    return transaction.payee;
-  }
-
-  /**
-   * Get the amount of the transaction.
-   * @param {object} transaction
-   * @returns {number}
-   */
-  public amount(transaction: any): number {
-    return transaction.amount;
-  }
-
-  /**
-   * Get the formatted amount of the transaction.
-   * @param {object} transaction
-   * @returns {string}
-   */
-  public formattedAmount(transaction: any): string {
-    return this.formatNumber(transaction.formattedAmount, {
-      money: true,
-    });
-  }
-
-  /**
-   * Get the date of the transaction.
-   * @param {object} transaction
-   * @returns {string}
-   */
-  public date(transaction: any): string {
-    return transaction.date;
-  }
-
-  /**
-   * Get the formatted date of the transaction.
-   * @param {object} transaction
-   * @returns {string}
-   */
-  public formattedDate(transaction: any): string {
-    return this.formatDate(transaction.date);
-  }
-
-  /**
-   * Get the assigned account ID of the transaction.
-   * @param {object} transaction
-   * @returns {number}
-   */
-  public assignedAccountId(transaction: any): number {
-    return transaction.recognizedTransaction.assignedAccountId;
-  }
-
-  /**
-   * Get the assigned account name of the transaction.
-   * @param {object} transaction
-   * @returns {string}
-   */
-  public assignedAccountName(transaction: any): string {
-    return transaction.recognizedTransaction.assignAccount.name;
-  }
-
-  /**
-   * Get the assigned account code of the transaction.
-   * @param {object} transaction
-   * @returns {string}
-   */
-  public assignedAccountCode(transaction: any): string {
-    return transaction.recognizedTransaction.assignAccount.code;
-  }
-
-  /**
-   * Get the assigned payee of the transaction.
-   * @param {object} transaction
-   * @returns {string}
-   */
-  public getAssignedPayee(transaction: any): string {
-    return transaction.recognizedTransaction.assignedPayee;
-  }
-
-  /**
-   * Get the assigned memo of the transaction.
-   * @param {object} transaction
-   * @returns {string}
-   */
-  public assignedMemo(transaction: any): string {
-    return transaction.recognizedTransaction.assignedMemo;
-  }
-
-  /**
-   * Get the assigned category of the transaction.
-   * @param {object} transaction
-   * @returns {string}
-   */
-  public assignedCategory(transaction: any): string {
-    return transaction.recognizedTransaction.assignedCategory;
-  }
-
-  /**
-   * 
-   * @returns {string}
-   */
-  public assignedCategoryFormatted() {
-    return 'Other Income'
-  }
-
-  /**
-   * Check if the transaction is a withdrawal.
-   * @param {object} transaction
-   * @returns {boolean}
-   */
-  public isWithdrawal(transaction: any): boolean {
-    return transaction.withdrawal;
-  }
-
-  /**
-   * Check if the transaction is a deposit.
-   * @param {object} transaction
-   * @returns {boolean}
-   */
-  public isDeposit(transaction: any): boolean {
-    return transaction.deposit;
-  }
-
-  /**
-   * Check if the transaction is a deposit transaction.
-   * @param {object} transaction
-   * @returns {boolean}
-   */
-  public isDepositTransaction(transaction: any): boolean {
-    return transaction.isDepositTransaction;
-  }
-
-  /**
-   * Check if the transaction is a withdrawal transaction.
-   * @param {object} transaction
-   * @returns {boolean}
-   */
-  public isWithdrawalTransaction(transaction: any): boolean {
-    return transaction.isWithdrawalTransaction;
-  }
-
-  /**
-   * Get formatted deposit amount.
-   * @param {any} transaction
-   * @returns {string}
-   */
-  protected formattedDepositAmount(transaction) {
-    if (transaction.isDepositTransaction) {
-      return this.formatNumber(transaction.deposit, {
-        currencyCode: transaction.currencyCode,
-      });
-    }
-    return '';
-  }
-
-  /**
-   * Get formatted withdrawal amount.
-   * @param transaction
-   * @returns {string}
-   */
-  protected formattedWithdrawalAmount(transaction) {
-    if (transaction.isWithdrawalTransaction) {
-      return this.formatNumber(transaction.withdrawal, {
-        currencyCode: transaction.currencyCode,
-      });
-    }
-    return '';
-  }
-
-  /**
-   * Get the transaction bank rule id.
-   * @param transaction
-   * @returns {string}
-   */
-  protected bankRuleId(transaction) {
-    return transaction.recognizedTransaction.bankRuleId;
-  }
-
-  /**
-   * Get the transaction bank rule name.
-   * @param transaction
-   * @returns {string}
-   */
-  protected bankRuleName(transaction) {
-    return transaction.recognizedTransaction.bankRule.name;
-  }
-}

packages/server/src/modules/BankingTransactions/queries/GetRecongizedTransactions.ts

@@ -1,67 +0,0 @@
-import { Inject, Injectable } from '@nestjs/common';
-import { GetRecognizedTransactionTransformer } from './GetRecognizedTransactionTransformer';
-import { UncategorizedBankTransaction } from '../models/UncategorizedBankTransaction';
-import { TransformerInjectable } from '@/modules/Transformer/TransformerInjectable.service';
-import { IGetRecognizedTransactionsQuery } from '../types/BankingTransactions.types';
-
-@Injectable()
-export class GetRecognizedTransactionsService {
-  constructor(
-    private readonly transformer: TransformerInjectable,
-
-    @Inject(UncategorizedBankTransaction.name)
-    private readonly uncategorizedBankTransactionModel: typeof UncategorizedBankTransaction,
-  ) {}
-
-  /**
-   * Retrieves the recognized transactions of the given account.
-   * @param {number} tenantId
-   * @param {IGetRecognizedTransactionsQuery} filter -
-   */
-  async getRecognizedTranactions(filter?: IGetRecognizedTransactionsQuery) {
-    const _query = {
-      page: 1,
-      pageSize: 20,
-      ...filter,
-    };
-    const { results, pagination } =
-      await this.uncategorizedBankTransactionModel.query()
-        .onBuild((q) => {
-          q.withGraphFetched('recognizedTransaction.assignAccount');
-          q.withGraphFetched('recognizedTransaction.bankRule');
-          q.whereNotNull('recognizedTransactionId');
-
-          // Exclude the excluded transactions.
-          q.modify('notExcluded');
-
-          // Exclude the pending transactions.
-          q.modify('notPending');
-
-          if (_query.accountId) {
-            q.where('accountId', _query.accountId);
-          }
-          if (_query.minDate) {
-            q.modify('fromDate', _query.minDate);
-          }
-          if (_query.maxDate) {
-            q.modify('toDate', _query.maxDate);
-          }
-          if (_query.minAmount) {
-            q.modify('minAmount', _query.minAmount);
-          }
-          if (_query.maxAmount) {
-            q.modify('maxAmount', _query.maxAmount);
-          }
-          if (_query.accountId) {
-            q.where('accountId', _query.accountId);
-          }
-        })
-        .pagination(_query.page - 1, _query.pageSize);
-
-    const data = await this.transformer.transform(
-      results,
-      new GetRecognizedTransactionTransformer(),
-    );
-    return { data, pagination };
-  }
-}

packages/server/src/modules/BankingTransactions/queries/GetUncategorizedTransactions.ts

@@ -1,26 +1,45 @@
+import { Inject, Injectable } from '@nestjs/common';
+import { initialize } from 'objection';
+import { Knex } from 'knex';
 import { TransformerInjectable } from '@/modules/Transformer/TransformerInjectable.service';
 import { UncategorizedBankTransaction } from '../models/UncategorizedBankTransaction';
-import { Inject, Injectable } from '@nestjs/common';
 import { UncategorizedTransactionTransformer } from '../../BankingCategorize/commands/UncategorizedTransaction.transformer';
-import { IGetUncategorizedTransactionsQuery } from '../types/BankingTransactions.types';
+import { GetUncategorizedTransactionsQueryDto } from '../dtos/GetUncategorizedTransactionsQuery.dto';
+import { TenantModelProxy } from '@/modules/System/models/TenantBaseModel';
+import { TENANCY_DB_CONNECTION } from '@/modules/Tenancy/TenancyDB/TenancyDB.constants';
+import { Account } from '@/modules/Accounts/models/Account.model';
+import { RecognizedBankTransaction } from '@/modules/BankingTranasctionsRegonize/models/RecognizedBankTransaction';
+import { MatchedBankTransaction } from '@/modules/BankingMatching/models/MatchedBankTransaction';
 
 @Injectable()
 export class GetUncategorizedTransactions {
   constructor(
     private readonly transformer: TransformerInjectable,
 
+    @Inject(TENANCY_DB_CONNECTION)
+    private readonly tenantDb: () => Knex,
+
     @Inject(UncategorizedBankTransaction.name)
-    private readonly uncategorizedBankTransactionModel: typeof UncategorizedBankTransaction,
+    private readonly uncategorizedBankTransactionModel: TenantModelProxy<typeof UncategorizedBankTransaction>,
+
+    @Inject(Account.name)
+    private readonly accountModel: TenantModelProxy<typeof Account>,
+
+    @Inject(RecognizedBankTransaction.name)
+    private readonly recognizedTransactionModel: TenantModelProxy<typeof RecognizedBankTransaction>,
+
+    @Inject(MatchedBankTransaction.name)  
+    private readonly matchedTransactionModel: TenantModelProxy<typeof MatchedBankTransaction>,
   ) {}
 
   /**
    * Retrieves the uncategorized cashflow transactions.
-   * @param {number} tenantId - Tenant id.
    * @param {number} accountId - Account Id.
+   * @param {IGetUncategorizedTransactionsQuery} query - Query.
    */
   public async getTransactions(
     accountId: number,
-    query: IGetUncategorizedTransactionsQuery
+    query: GetUncategorizedTransactionsQueryDto
   ) {
     // Parsed query with default values.
     const _query = {
@@ -29,8 +48,15 @@ export class GetUncategorizedTransactions {
       ...query,
     };
 
+    await initialize(this.tenantDb(), [
+      this.accountModel(),
+      this.uncategorizedBankTransactionModel(),
+      this.recognizedTransactionModel(),
+      this.matchedTransactionModel(),
+    ]);
+
     const { results, pagination } =
-      await this.uncategorizedBankTransactionModel.query()
+      await this.uncategorizedBankTransactionModel().query()
         .onBuild((q) => {
           q.where('accountId', accountId);
           q.where('categorized', false);