Merge branch 'develop' into filter-uncategorized-bank-transactions

packages/server/src/services/Cashflow/CashflowAccountTransformer.ts

@@ -8,7 +8,12 @@ export class CashflowAccountTransformer extends Transformer {
    * @returns {string[]}
    */
   public includeAttributes = (): string[] => {
-    return ['formattedAmount'];
+    return [
+      'formattedAmount',
+      'lastFeedsUpdatedAt',
+      'lastFeedsUpdatedAtFormatted',
+      'lastFeedsUpdatedFromNow',
+    ];
   };
 
   /**
@@ -29,7 +34,7 @@ export class CashflowAccountTransformer extends Transformer {
 
   /**
    * Retrieve formatted account amount.
-   * @param   {IAccount} invoice
+   * @param {IAccount} invoice
    * @returns {string}
    */
   protected formattedAmount = (account: IAccount): string => {
@@ -37,4 +42,22 @@ export class CashflowAccountTransformer extends Transformer {
       currencyCode: account.currencyCode,
     });
   };
+
+  /**
+   * Retrieves the last feeds update at formatted date.
+   * @param {IAccount} account
+   * @returns {string}
+   */
+  protected lastFeedsUpdatedAtFormatted(account: IAccount): string {
+    return this.formatDate(account.lastFeedsUpdatedAt);
+  }
+
+  /**
+   * Retrieves the last feeds updated from now.
+   * @param {IAccount} account
+   * @returns {string}
+   */
+  protected lastFeedsUpdatedFromNow(account: IAccount): string {
+    return this.formatDateFromNow(account.lastFeedsUpdatedAt);
+  }
 }

packages/server/src/services/Cashflow/CashflowApplication.ts

@@ -21,6 +21,7 @@ import GetCashflowAccountsService from './GetCashflowAccountsService';
 import { GetCashflowTransactionService } from './GetCashflowTransactionsService';
 import { GetRecognizedTransactionsService } from './GetRecongizedTransactions';
 import { GetRecognizedTransactionService } from './GetRecognizedTransaction';
+import { UncategorizeCashflowTransactionsBulk } from './UncategorizeCashflowTransactionsBulk';
 
 @Service()
 export class CashflowApplication {
@@ -39,6 +40,9 @@ export class CashflowApplication {
   @Inject()
   private uncategorizeTransactionService: UncategorizeCashflowTransaction;
 
+  @Inject()
+  private uncategorizeTransasctionsService: UncategorizeCashflowTransactionsBulk;
+
   @Inject()
   private categorizeTransactionService: CategorizeCashflowTransaction;
 
@@ -155,6 +159,22 @@ export class CashflowApplication {
     );
   }
 
+  /**
+   * Uncategorize the given transactions in bulk.
+   * @param {number} tenantId 
+   * @param {number | Array<number>} transactionId 
+   * @returns 
+   */
+  public uncategorizeTransactions(
+    tenantId: number,
+    transactionId: number | Array<number>
+  ) {
+    return this.uncategorizeTransasctionsService.uncategorizeBulk(
+      tenantId,
+      transactionId
+    );
+  }
+
   /**
    * Categorize the given cashflow transaction.
    * @param {number} tenantId
@@ -241,9 +261,9 @@ export class CashflowApplication {
 
   /**
    * Retrieves the recognized transaction of the given uncategorized transaction.
-   * @param {number} tenantId 
-   * @param {number} uncategorizedTransactionId 
-   * @returns 
+   * @param {number} tenantId
+   * @param {number} uncategorizedTransactionId
+   * @returns
    */
   public getRecognizedTransaction(
     tenantId: number,

packages/server/src/services/Cashflow/GetPendingBankAccountTransaction.ts

@@ -0,0 +1,53 @@
+import { Inject } from 'typedi';
+import { TransformerInjectable } from '@/lib/Transformer/TransformerInjectable';
+import HasTenancyService from '../Tenancy/TenancyService';
+import { GetPendingBankAccountTransactionTransformer } from './GetPendingBankAccountTransactionTransformer';
+
+export class GetPendingBankAccountTransactions {
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  @Inject()
+  private transformer: TransformerInjectable;
+
+  /**
+   * Retrieves the given bank accounts pending transaction.
+   * @param {number} tenantId - Tenant id.
+   * @param {GetPendingTransactionsQuery} filter - Pending transactions query.
+   */
+  async getPendingTransactions(
+    tenantId: number,
+    filter?: GetPendingTransactionsQuery
+  ) {
+    const { UncategorizedCashflowTransaction } = this.tenancy.models(tenantId);
+
+    const _filter = {
+      page: 1,
+      pageSize: 20,
+      ...filter,
+    };
+    const { results, pagination } =
+      await UncategorizedCashflowTransaction.query()
+        .onBuild((q) => {
+          q.modify('pending');
+
+          if (_filter?.accountId) {
+            q.where('accountId', _filter.accountId);
+          }
+        })
+        .pagination(_filter.page - 1, _filter.pageSize);
+
+    const data = await this.transformer.transform(
+      tenantId,
+      results,
+      new GetPendingBankAccountTransactionTransformer()
+    );
+    return { data, pagination };
+  }
+}
+
+interface GetPendingTransactionsQuery {
+  page?: number;
+  pageSize?: number;
+  accountId?: number;
+}

packages/server/src/services/Cashflow/GetPendingBankAccountTransactionTransformer.ts

@@ -0,0 +1,73 @@
+import { Transformer } from '@/lib/Transformer/Transformer';
+import { formatNumber } from '@/utils';
+
+export class GetPendingBankAccountTransactionTransformer extends Transformer {
+  /**
+   * Include these attributes to sale invoice object.
+   * @returns {string[]}
+   */
+  public includeAttributes = (): string[] => {
+    return [
+      'formattedAmount',
+      'formattedDate',
+      'formattedDepositAmount',
+      'formattedWithdrawalAmount',
+    ];
+  };
+
+  /**
+   * Exclude all attributes.
+   * @returns {Array<string>}
+   */
+  public excludeAttributes = (): string[] => {
+    return [];
+  };
+
+  /**
+   * Formattes the transaction date.
+   * @param transaction
+   * @returns {string}
+   */
+  public formattedDate(transaction) {
+    return this.formatDate(transaction.date);
+  }
+
+  /**
+   * Formatted amount.
+   * @param transaction
+   * @returns {string}
+   */
+  public formattedAmount(transaction) {
+    return formatNumber(transaction.amount, {
+      currencyCode: transaction.currencyCode,
+    });
+  }
+
+  /**
+   * Formatted deposit amount.
+   * @param transaction
+   * @returns {string}
+   */
+  protected formattedDepositAmount(transaction) {
+    if (transaction.isDepositTransaction) {
+      return formatNumber(transaction.deposit, {
+        currencyCode: transaction.currencyCode,
+      });
+    }
+    return '';
+  }
+
+  /**
+   * Formatted withdrawal amount.
+   * @param transaction
+   * @returns {string}
+   */
+  protected formattedWithdrawalAmount(transaction) {
+    if (transaction.isWithdrawalTransaction) {
+      return formatNumber(transaction.withdrawal, {
+        currencyCode: transaction.currencyCode,
+      });
+    }
+    return '';
+  }
+}

packages/server/src/services/Cashflow/GetRecongizedTransactions.ts

@@ -34,8 +34,13 @@ export class GetRecognizedTransactionsService {
           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);
           }
@@ -51,6 +56,9 @@ export class GetRecognizedTransactionsService {
           if (_query.maxAmount) {
             q.modify('maxAmount', _query.maxAmount);
           }
+          if (_query.accountId) {
+            q.where('accountId', _query.accountId);
+          }
         })
         .pagination(_query.page - 1, _query.pageSize);
 

packages/server/src/services/Cashflow/GetUncategorizedTransactions.ts

@@ -51,7 +51,9 @@ export class GetUncategorizedTransactions {
         .onBuild((q) => {
           q.where('accountId', accountId);
           q.where('categorized', false);
+
           q.modify('notExcluded');
+          q.modify('notPending');
 
           q.withGraphFetched('account');
           q.withGraphFetched('recognizedTransaction.assignAccount');

packages/server/src/services/Cashflow/RemovePendingUncategorizedTransaction.ts

@@ -0,0 +1,72 @@
+import { Knex } from 'knex';
+import { Inject, Service } from 'typedi';
+import HasTenancyService from '../Tenancy/TenancyService';
+import UnitOfWork from '../UnitOfWork';
+import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
+import events from '@/subscribers/events';
+import { ServiceError } from '@/exceptions';
+import { ERRORS } from './constants';
+import {
+  IPendingTransactionRemovedEventPayload,
+  IPendingTransactionRemovingEventPayload,
+} from '@/interfaces';
+
+@Service()
+export class RemovePendingUncategorizedTransaction {
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  @Inject()
+  private uow: UnitOfWork;
+
+  @Inject()
+  private eventPublisher: EventPublisher;
+
+  /**
+   * REmoves the pending uncategorized transaction.
+   * @param {number} tenantId -
+   * @param {number} uncategorizedTransactionId -
+   * @param {Knex.Transaction} trx -
+   * @returns {Promise<void>}
+   */
+  public async removePendingTransaction(
+    tenantId: number,
+    uncategorizedTransactionId: number,
+    trx?: Knex.Transaction
+  ): Promise<void> {
+    const { UncategorizedCashflowTransaction } = this.tenancy.models(tenantId);
+
+    const pendingTransaction = await UncategorizedCashflowTransaction.query(trx)
+      .findById(uncategorizedTransactionId)
+      .throwIfNotFound();
+
+    if (!pendingTransaction.isPending) {
+      throw new ServiceError(ERRORS.TRANSACTION_NOT_PENDING);
+    }
+    return this.uow.withTransaction(tenantId, async (trx: Knex.Transaction) => {
+      await this.eventPublisher.emitAsync(
+        events.bankTransactions.onPendingRemoving,
+        {
+          tenantId,
+          uncategorizedTransactionId,
+          pendingTransaction,
+          trx,
+        } as IPendingTransactionRemovingEventPayload
+      );
+      // Removes the pending uncategorized transaction.
+      await UncategorizedCashflowTransaction.query(trx)
+        .findById(uncategorizedTransactionId)
+        .delete();
+
+      await this.eventPublisher.emitAsync(
+        events.bankTransactions.onPendingRemoved,
+        {
+          tenantId,
+          uncategorizedTransactionId,
+          pendingTransaction,
+          trx,
+        } as IPendingTransactionRemovedEventPayload
+      );
+    });
+  }
+}

packages/server/src/services/Cashflow/UncategorizeCashflowTransactionsBulk.ts

@@ -0,0 +1,37 @@
+import PromisePool from '@supercharge/promise-pool';
+import { castArray } from 'lodash';
+import { Service, Inject } from 'typedi';
+import HasTenancyService from '../Tenancy/TenancyService';
+import { UncategorizeCashflowTransaction } from './UncategorizeCashflowTransaction';
+
+@Service()
+export class UncategorizeCashflowTransactionsBulk {
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  @Inject()
+  private uncategorizeTransaction: UncategorizeCashflowTransaction;
+
+  /**
+   * Uncategorize the given bank transactions in bulk.
+   * @param {number} tenantId
+   * @param {number} uncategorizedTransactionId
+   */
+  public async uncategorizeBulk(
+    tenantId: number,
+    uncategorizedTransactionId: number | Array<number>
+  ) {
+    const uncategorizedTransactionIds = castArray(uncategorizedTransactionId);
+
+    const result = await PromisePool.withConcurrency(MIGRATION_CONCURRENCY)
+      .for(uncategorizedTransactionIds)
+      .process(async (_uncategorizedTransactionId: number, index, pool) => {
+        await this.uncategorizeTransaction.uncategorize(
+          tenantId,
+          _uncategorizedTransactionId
+        );
+      });
+  }
+}
+
+const MIGRATION_CONCURRENCY = 1;

packages/server/src/services/Cashflow/constants.ts

@@ -15,10 +15,10 @@ export const ERRORS = {
     'UNCATEGORIZED_TRANSACTION_TYPE_INVALID',
   CANNOT_DELETE_TRANSACTION_CONVERTED_FROM_UNCATEGORIZED:
     'CANNOT_DELETE_TRANSACTION_CONVERTED_FROM_UNCATEGORIZED',
-
-  CANNOT_CATEGORIZE_EXCLUDED_TRANSACTION: 'CANNOT_CATEGORIZE_EXCLUDED_TRANSACTION',
-  TRANSACTION_NOT_CATEGORIZED: 'TRANSACTION_NOT_CATEGORIZED'
-
+  CANNOT_CATEGORIZE_EXCLUDED_TRANSACTION:
+    'CANNOT_CATEGORIZE_EXCLUDED_TRANSACTION',
+  TRANSACTION_NOT_CATEGORIZED: 'TRANSACTION_NOT_CATEGORIZED',
+  TRANSACTION_NOT_PENDING: 'TRANSACTION_NOT_PENDING',
 };
 
 export enum CASHFLOW_DIRECTION {

packages/server/src/services/Cashflow/subscribers/DecrementUncategorizedTransactionOnCategorize.ts

@@ -1,11 +1,11 @@
 import { Inject, Service } from 'typedi';
+import PromisePool from '@supercharge/promise-pool';
 import events from '@/subscribers/events';
 import HasTenancyService from '@/services/Tenancy/TenancyService';
 import {
   ICashflowTransactionCategorizedPayload,
   ICashflowTransactionUncategorizedPayload,
 } from '@/interfaces';
-import PromisePool from '@supercharge/promise-pool';
 
 @Service()
 export class DecrementUncategorizedTransactionOnCategorize {
@@ -36,13 +36,17 @@ export class DecrementUncategorizedTransactionOnCategorize {
   public async decrementUnCategorizedTransactionsOnCategorized({
     tenantId,
     uncategorizedTransactions,
-    trx
+    trx,
   }: ICashflowTransactionCategorizedPayload) {
     const { Account } = this.tenancy.models(tenantId);
 
     await PromisePool.withConcurrency(1)
       .for(uncategorizedTransactions)
       .process(async (uncategorizedTransaction) => {
+        // Cannot continue if the transaction is still pending.
+        if (uncategorizedTransaction.isPending) {
+          return;
+        }
         await Account.query(trx)
           .findById(uncategorizedTransaction.accountId)
           .decrement('uncategorizedTransactions', 1);
@@ -56,13 +60,17 @@ export class DecrementUncategorizedTransactionOnCategorize {
   public async incrementUnCategorizedTransactionsOnUncategorized({
     tenantId,
     uncategorizedTransactions,
-    trx
+    trx,
   }: ICashflowTransactionUncategorizedPayload) {
     const { Account } = this.tenancy.models(tenantId);
 
     await PromisePool.withConcurrency(1)
       .for(uncategorizedTransactions)
       .process(async (uncategorizedTransaction) => {
+        // Cannot continue if the transaction is still pending.
+        if (uncategorizedTransaction.isPending) {
+          return;
+        }
         await Account.query(trx)
           .findById(uncategorizedTransaction.accountId)
           .increment('uncategorizedTransactions', 1);
@@ -82,6 +90,9 @@ export class DecrementUncategorizedTransactionOnCategorize {
 
     if (!uncategorizedTransaction.accountId) return;
 
+    // Cannot continue if the transaction is still pending.
+    if (uncategorizedTransaction.isPending) return;
+
     await Account.query(trx)
       .findById(uncategorizedTransaction.accountId)
       .increment('uncategorizedTransactions', 1);