feat: exclude/unexclude the uncategorized transactions

packages/server/src/api/controllers/Banking/ExcludeBankTransactionsController.ts

@@ -0,0 +1,90 @@
+import { Inject, Service } from 'typedi';
+import { param } from 'express-validator';
+import { NextFunction, Request, Response, Router } from 'express';
+import BaseController from '../BaseController';
+import { ExcludeBankTransactionsApplication } from '@/services/Banking/Exclude/ExcludeBankTransactionsApplication';
+
+@Service()
+export class ExcludeBankTransactionsController extends BaseController {
+  @Inject()
+  prviate excludeBankTransactionApp: ExcludeBankTransactionsApplication;
+
+  /**
+   * Router constructor.
+   */
+  public router() {
+    const router = Router();
+
+    router.put(
+      '/transactions/:transactionId/exclude',
+      [param('transactionId').exists()],
+      this.validationResult,
+      this.excludeBankTransaction.bind(this)
+    );
+    router.put(
+      '/transactions/:transactionId/unexclude',
+      [param('transactionId').exists()],
+      this.validationResult,
+      this.unexcludeBankTransaction.bind(this)
+    );
+    return router;
+  }
+
+  /**
+   * Marks a bank transaction as excluded.
+   * @param {Request} req
+   * @param {Response} res
+   * @param {NextFunction} next
+   * @returns
+   */
+  private async excludeBankTransaction(
+    req: Request,
+    res: Response,
+    next: NextFunction
+  ): Promise<Response | void> {
+    const { tenantId } = req;
+    const { transactionId } = req.params;
+
+    try {
+      await this.excludeBankTransactionApp.excludeBankTransaction(
+        tenantId,
+        transactionId
+      );
+      return res.status(200).send({
+        message: 'The bank transaction has been excluded.',
+        id: transactionId,
+      });
+    } catch (error) {
+      next(error);
+    }
+  }
+
+  /**
+   * Marks a bank transaction as not excluded.
+   * @param {Request} req
+   * @param {Response} res
+   * @param {NextFunction} next
+   * @returns {Promise<Response|void>}
+   */
+  private async unexcludeBankTransaction(
+    req: Request,
+    res: Response,
+    next: NextFunction
+  ): Promise<Response | void> {
+    const { tenantId } = req;
+    const { transactionId } = req.params;
+
+    try {
+      await this.excludeBankTransactionApp.unexcludeBankTransaction(
+        tenantId,
+        transactionId
+      );
+      return res.status(200).send({
+        message: 'The bank transaction has been unexcluded.',
+        id: transactionId,
+      });
+    } catch (error) {
+      next(error);
+    }
+  }
+}

packages/server/src/api/controllers/Cashflow/CashflowController.ts

@@ -4,6 +4,7 @@ import CommandCashflowTransaction from './NewCashflowTransaction';
 import DeleteCashflowTransaction from './DeleteCashflowTransaction';
 import GetCashflowTransaction from './GetCashflowTransaction';
 import GetCashflowAccounts from './GetCashflowAccounts';
+import { ExcludeBankTransactionsController } from '../Banking/ExcludeBankTransactionsController';
 
 @Service()
 export default class CashflowController {
@@ -14,6 +15,7 @@ export default class CashflowController {
     const router = Router();
 
     router.use(Container.get(CommandCashflowTransaction).router());
+    router.use(Container.get(ExcludeBankTransactionsController).router());
     router.use(Container.get(GetCashflowTransaction).router());
     router.use(Container.get(GetCashflowAccounts).router());
     router.use(Container.get(DeleteCashflowTransaction).router());

packages/server/src/database/migrations/20240620111308_add_excluded_column_to_uncategorized_cashflow_transactions_table.js

@@ -0,0 +1,11 @@
+exports.up = function (knex) {
+  return knex.schema.table('uncategorized_cashflow_transactions', (table) => {
+    table.boolean('excluded');
+  });
+};
+
+exports.down = function (knex) {
+  return knex.schema.table('uncategorized_cashflow_transactions', (table) => {
+    table.dropColumn('excluded');
+  });
+};

packages/server/src/models/UncategorizedCashflowTransaction.ts

@@ -44,6 +44,7 @@ export default class UncategorizedCashflowTransaction extends mixin(
       'deposit',
       'isDepositTransaction',
       'isWithdrawalTransaction',
+      'isRecognized',
     ];
   }
 

packages/server/src/services/Banking/Exclude/ExcludeBankTransaction.ts

@@ -0,0 +1,41 @@
+import HasTenancyService from '@/services/Tenancy/TenancyService';
+import UnitOfWork from '@/services/UnitOfWork';
+import { Inject, Service } from 'typedi';
+import { validateTransactionNotCategorized } from './utils';
+
+@Service()
+export class ExcludeBankTransaction {
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  @Inject()
+  private uow: UnitOfWork;
+
+  /**
+   * Marks the given bank transaction as excluded.
+   * @param {number} tenantId
+   * @param {number} bankTransactionId
+   * @returns {Promise<void>}
+   */
+  public async excludeBankTransaction(
+    tenantId: number,
+    bankTransactionId: number
+  ) {
+    const { UncategorizeCashflowTransaction } = this.tenancy.models(tenantId);
+
+    const oldUncategorizedTransaction =
+      await UncategorizeCashflowTransaction.query()
+        .findById(bankTransactionId)
+        .throwIfNotFound();
+
+    validateTransactionNotCategorized(oldUncategorizedTransaction);
+
+    return this.uow.withTransaction(tenantId, async (trx) => {
+      await UncategorizeCashflowTransaction.query(trx)
+        .findById(bankTransactionId)
+        .patch({
+          excluded: true,
+        });
+    });
+  }
+}

packages/server/src/services/Banking/Exclude/ExcludeBankTransactionsApplication.ts

@@ -0,0 +1,38 @@
+import { Inject, Service } from 'typedi';
+import { ExcludeBankTransaction } from './ExcludeBankTransaction';
+import { UnexcludeBankTransaction } from './UnexcludeBankTransaction';
+
+@Service()
+export class ExcludeBankTransactionsApplication {
+  @Inject()
+  private excludeBankTransactionService: ExcludeBankTransaction;
+
+  @Inject()
+  private unexcludeBankTransactionService: UnexcludeBankTransaction;
+
+  /**
+   * Marks a bank transaction as excluded.
+   * @param {number} tenantId - The ID of the tenant.
+   * @param {number} bankTransactionId - The ID of the bank transaction to exclude.
+   * @returns {Promise<void>}
+   */
+  public excludeBankTransaction(tenantId: number, bankTransactionId: number) {
+    return this.excludeBankTransactionService.excludeBankTransaction(
+      tenantId,
+      bankTransactionId
+    );
+  }
+
+  /**
+   * Marks a bank transaction as not excluded.
+   * @param {number} tenantId - The ID of the tenant.
+   * @param {number} bankTransactionId - The ID of the bank transaction to exclude.
+   * @returns {Promise<void>}
+   */
+  public unexcludeBankTransaction(tenantId: number, bankTransactionId: number) {
+    return this.unexcludeBankTransactionService.unexcludeBankTransaction(
+      tenantId,
+      bankTransactionId
+    );
+  }
+}

packages/server/src/services/Banking/Exclude/UnexcludeBankTransaction.ts

@@ -0,0 +1,41 @@
+import HasTenancyService from '@/services/Tenancy/TenancyService';
+import UnitOfWork from '@/services/UnitOfWork';
+import { Inject, Service } from 'typedi';
+import { validateTransactionNotCategorized } from './utils';
+
+@Service()
+export class UnexcludeBankTransaction {
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  @Inject()
+  private uow: UnitOfWork;
+
+  /**
+   * Marks the given bank transaction as excluded.
+   * @param {number} tenantId
+   * @param {number} bankTransactionId
+   * @returns {Promise<void>}
+   */
+  public async unexcludeBankTransaction(
+    tenantId: number,
+    bankTransactionId: number
+  ) {
+    const { UncategorizeCashflowTransaction } = this.tenancy.models(tenantId);
+
+    const oldUncategorizedTransaction =
+      await UncategorizeCashflowTransaction.query()
+        .findById(bankTransactionId)
+        .throwIfNotFound();
+
+    validateTransactionNotCategorized(oldUncategorizedTransaction);
+
+    return this.uow.withTransaction(tenantId, async (trx) => {
+      await UncategorizeCashflowTransaction.query(trx)
+        .findById(bankTransactionId)
+        .patch({
+          excluded: false,
+        });
+    });
+  }
+}

packages/server/src/services/Banking/Exclude/utils.ts

@@ -0,0 +1,14 @@
+import { ServiceError } from '@/exceptions';
+import UncategorizedCashflowTransaction from '@/models/UncategorizedCashflowTransaction';
+
+const ERRORS = {
+  TRANSACTION_ALREADY_CATEGORIZED: 'TRANSACTION_ALREADY_CATEGORIZED',
+};
+
+export const validateTransactionNotCategorized = (
+  transaction: UncategorizedCashflowTransaction
+) => {
+  if (transaction.categorized) {
+    throw new ServiceError(ERRORS.TRANSACTION_ALREADY_CATEGORIZED);
+  }
+};