feat: uncategorize the cashflow transaction

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

@@ -93,6 +93,19 @@ export default class DeleteCashflowTransactionController extends BaseController
           ],
         });
       }
+      if (
+        error.errorType ===
+        'CANNOT_DELETE_TRANSACTION_CONVERTED_FROM_UNCATEGORIZED'
+      ) {
+        return res.boom.badRequest(null, {
+          errors: [
+            {
+              type: 'CANNOT_DELETE_TRANSACTION_CONVERTED_FROM_UNCATEGORIZED',
+              code: 4100,
+            },
+          ],
+        });
+      }
     }
     next(error);
   }

packages/server/src/database/migrations/20240308122047_add_uncategorized_transaction_id_to_cashflow_transactions.js

@@ -0,0 +1,15 @@
+exports.up = function (knex) {
+  return knex.schema.table('cashflow_transactions', (table) => {
+    table
+      .integer('uncategorized_transaction_id')
+      .unsigned()
+      .references('id')
+      .inTable('uncategorized_cashflow_transactions');
+  });
+};
+
+exports.down = function (knex) {
+  return knex.schema.table('cashflow_transactions', (table) => {
+    table.dropColumn('uncategorized_transaction_id');
+  });
+};

packages/server/src/interfaces/CashflowService.ts

@@ -51,6 +51,7 @@ export interface ICashflowCommandDTO {
 
 export interface ICashflowNewCommandDTO extends ICashflowCommandDTO {
   plaidAccountId?: string;
+  uncategorizedTransactionId?: number;
 }
 
 export interface ICashflowTransaction {
@@ -83,6 +84,8 @@ export interface ICashflowTransaction {
 
   isCashDebit?: boolean;
   isCashCredit?: boolean;
+
+  uncategorizedTransactionId?: number;
 }
 
 export interface ICashflowTransactionLine {

packages/server/src/loaders/eventEmitter.ts

@@ -89,6 +89,7 @@ import { InvoiceChangeStatusOnMailSentSubscriber } from '@/services/Sales/Invoic
 import { SaleReceiptMarkClosedOnMailSentSubcriber } from '@/services/Sales/Receipts/subscribers/SaleReceiptMarkClosedOnMailSentSubcriber';
 import { SaleEstimateMarkApprovedOnMailSent } from '@/services/Sales/Estimates/subscribers/SaleEstimateMarkApprovedOnMailSent';
 import { DeleteCashflowTransactionOnUncategorize } from '@/services/Cashflow/subscribers/DeleteCashflowTransactionOnUncategorize';
+import { PreventDeleteTransactionOnDelete } from '@/services/Cashflow/subscribers/PreventDeleteTransactionsOnDelete'; }
 
 export default () => {
   return new EventPublisher();
@@ -217,5 +218,6 @@ export const susbcribers = () => {
 
     // Cashflow
     DeleteCashflowTransactionOnUncategorize,
+    PreventDeleteTransactionOnDelete
   ];
 };

packages/server/src/models/CashflowTransaction.ts

@@ -13,6 +13,7 @@ export default class CashflowTransaction extends TenantModel {
   amount: number;
   exchangeRate: number;
   uncategorize: boolean;
+  uncategorizedTransaction!: boolean;
 
   /**
    * Table name.
@@ -86,6 +87,14 @@ export default class CashflowTransaction extends TenantModel {
     return this.typeMeta?.direction === CASHFLOW_DIRECTION.IN;
   }
 
+  /**
+   * Detarmines whether the transaction imported from uncategorized transaction.
+   * @returns {boolean}
+   */
+  get isCategroizedTranasction() {
+    return !!this.uncategorizedTransaction;
+  }
+
   /**
    * Relationship mapping.
    */

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

@@ -86,6 +86,7 @@ export default class NewCashflowTransactionService {
       'creditAccountId',
       'branchId',
       'plaidTransactionId',
+      'uncategorizedTransactionId',
     ]);
     // Retreive the next invoice number.
     const autoNextNumber =

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

@@ -11,7 +11,8 @@ export const ERRORS = {
   ACCOUNT_HAS_ASSOCIATED_TRANSACTIONS: 'account_has_associated_transactions',
   TRANSACTION_ALREADY_CATEGORIZED: 'TRANSACTION_ALREADY_CATEGORIZED',
   TRANSACTION_ALREADY_UNCATEGORIZED: 'TRANSACTION_ALREADY_UNCATEGORIZED',
-  UNCATEGORIZED_TRANSACTION_TYPE_INVALID: 'UNCATEGORIZED_TRANSACTION_TYPE_INVALID'
+  UNCATEGORIZED_TRANSACTION_TYPE_INVALID: 'UNCATEGORIZED_TRANSACTION_TYPE_INVALID',
+  CANNOT_DELETE_TRANSACTION_CONVERTED_FROM_UNCATEGORIZED: 'CANNOT_DELETE_TRANSACTION_CONVERTED_FROM_UNCATEGORIZED'
 };
 
 export enum CASHFLOW_DIRECTION {

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

@@ -2,12 +2,16 @@ import { Inject, Service } from 'typedi';
 import events from '@/subscribers/events';
 import { ICashflowTransactionUncategorizedPayload } from '@/interfaces';
 import { DeleteCashflowTransaction } from '../DeleteCashflowTransactionService';
+import HasTenancyService from '@/services/Tenancy/TenancyService';
 
 @Service()
 export class DeleteCashflowTransactionOnUncategorize {
   @Inject()
   private deleteCashflowTransactionService: DeleteCashflowTransaction;
 
+  @Inject()
+  private tenancy: HasTenancyService;
+
   /**
    * Attaches events with handlers.
    */
@@ -27,10 +31,18 @@ export class DeleteCashflowTransactionOnUncategorize {
     oldUncategorizedTransaction,
     trx,
   }: ICashflowTransactionUncategorizedPayload) {
+    const { CashflowTransaction } = this.tenancy.models(tenantId);
+
     // Deletes the cashflow transaction.
     if (
       oldUncategorizedTransaction.categorizeRefType === 'CashflowTransaction'
     ) {
+      await CashflowTransaction.query()
+        .findById(oldUncategorizedTransaction.categorizeRefId)
+        .patch({
+          uncategorizedTransactionId: null,
+        });
+
       await this.deleteCashflowTransactionService.deleteCashflowTransaction(
         tenantId,
         oldUncategorizedTransaction.categorizeRefId

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

@@ -0,0 +1,37 @@
+import { Service } from 'typedi';
+import events from '@/subscribers/events';
+import { ICommandCashflowDeletingPayload } from '@/interfaces';
+import { ServiceError } from '@/exceptions';
+import { ERRORS } from '../constants';
+
+@Service()
+export class PreventDeleteTransactionOnDelete {
+  /**
+   * Attaches events with handlers.
+   */
+  public attach = (bus) => {
+    bus.subscribe(
+      events.cashflow.onTransactionDeleting,
+      this.preventDeleteCashflowTransactionHasUncategorizedTransaction.bind(
+        this
+      )
+    );
+  };
+
+  /**
+   * Prevent delete cashflow transaction has converted from uncategorized transaction.
+   * @param {ICommandCashflowDeletingPayload} payload
+   */
+  public async preventDeleteCashflowTransactionHasUncategorizedTransaction({
+    tenantId,
+    oldCashflowTransaction,
+    trx,
+  }: ICommandCashflowDeletingPayload) {
+    if (oldCashflowTransaction.uncategorizedTransactionId) {
+      throw new ServiceError(
+        ERRORS.CANNOT_DELETE_TRANSACTION_CONVERTED_FROM_UNCATEGORIZED,
+        'Cannot delete cashflow transaction converted from uncategorized transaction.'
+      );
+    }
+  }
+}

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

@@ -61,6 +61,7 @@ export const transformCategorizeTransToCashflow = (
     amount: uncategorizeModel.amount,
     transactionNumber: categorizeDTO.transactionNumber,
     transactionType: categorizeDTO.transactionType,
+    uncategorizedTransactionId: uncategorizeModel.id,
     publish: true,
   };
 };

packages/webapp/src/containers/AlertsContainer/registered.tsx

@@ -25,6 +25,7 @@ import WarehousesTransfersAlerts from '@/containers/WarehouseTransfers/Warehouse
 import BranchesAlerts from '@/containers/Preferences/Branches/BranchesAlerts';
 import ProjectAlerts from '@/containers/Projects/containers/ProjectAlerts';
 import TaxRatesAlerts from '@/containers/TaxRates/alerts';
+import { CashflowAlerts } from '../CashFlow/CashflowAlerts';
 
 export default [
   ...AccountsAlerts,
@@ -53,4 +54,5 @@ export default [
   ...BranchesAlerts,
   ...ProjectAlerts,
   ...TaxRatesAlerts,
+  ...CashflowAlerts,
 ];

packages/webapp/src/containers/CashFlow/CashflowAlerts.ts

@@ -0,0 +1,16 @@
+// @ts-nocheck
+import React from 'react';
+
+const UncategorizeTransactionAlert = React.lazy(
+  () => import('./UncategorizeTransactionAlert/UncategorizeTransactionAlert'),
+);
+
+/**
+ * Cashflow alerts.
+ */
+export const CashflowAlerts = [
+  {
+    name: 'cashflow-tranaction-uncategorize',
+    component: UncategorizeTransactionAlert,
+  },
+];

packages/webapp/src/containers/CashFlow/UncategorizeTransactionAlert/UncategorizeTransactionAlert.tsx

@@ -0,0 +1,83 @@
+// @ts-nocheck
+import React from 'react';
+import { Intent, Alert } from '@blueprintjs/core';
+import { FormattedMessage as T } from '@/components';
+import { AppToaster } from '@/components';
+
+import withAlertStoreConnect from '@/containers/Alert/withAlertStoreConnect';
+import withAlertActions from '@/containers/Alert/withAlertActions';
+import withDrawerActions from '@/containers/Drawer/withDrawerActions';
+
+import { useUncategorizeTransaction } from '@/hooks/query';
+import { compose } from '@/utils';
+import { DRAWERS } from '@/constants/drawers';
+
+/**
+ * Project delete alert.
+ */
+function UncategorizeTransactionAlert({
+  name,
+
+  // #withAlertStoreConnect
+  isOpen,
+  payload: { uncategorizedTransactionId },
+
+  // #withAlertActions
+  closeAlert,
+
+  // #withDrawerActions
+  closeDrawer,
+}) {
+  const { mutateAsync: uncategorizeTransaction, isLoading } =
+    useUncategorizeTransaction();
+
+  // handle cancel delete project alert.
+  const handleCancelDeleteAlert = () => {
+    closeAlert(name);
+  };
+
+  // handleConfirm delete project
+  const handleConfirmBtnClick = () => {
+    uncategorizeTransaction(uncategorizedTransactionId)
+      .then(() => {
+        AppToaster.show({
+          message: 'The transaction has uncategorized successfully.',
+          intent: Intent.SUCCESS,
+        });
+        closeAlert(name);
+        closeDrawer(DRAWERS.CASHFLOW_TRNASACTION_DETAILS);
+      })
+      .catch(
+        ({
+          response: {
+            data: { errors },
+          },
+        }) => {
+          AppToaster.show({
+            message: 'Something went wrong.',
+            intent: Intent.DANGER,
+          });
+        },
+      );
+  };
+
+  return (
+    <Alert
+      cancelButtonText={<T id={'cancel'} />}
+      confirmButtonText={'Uncategorize'}
+      intent={Intent.WARNING}
+      isOpen={isOpen}
+      onCancel={handleCancelDeleteAlert}
+      onConfirm={handleConfirmBtnClick}
+      loading={isLoading}
+    >
+      <p>Are you sure want to uncategorize the transaction?</p>
+    </Alert>
+  );
+}
+
+export default compose(
+  withAlertStoreConnect(),
+  withAlertActions,
+  withDrawerActions,
+)(UncategorizeTransactionAlert);

packages/webapp/src/containers/CashFlow/UncategorizeTransactionAlert/index.ts

@@ -0,0 +1 @@
+export * from './UncategorizeTransactionAlert';

packages/webapp/src/containers/Drawers/CashflowTransactionDetailDrawer/CashflowTransactionDrawerActionBar.tsx

@@ -1,11 +1,18 @@
 // @ts-nocheck
 import React from 'react';
-import { Button, Classes, NavbarGroup, Intent } from '@blueprintjs/core';
+import {
+  Button,
+  Classes,
+  NavbarGroup,
+  Intent,
+  NavbarDivider,
+} from '@blueprintjs/core';
 import {
   Can,
   FormattedMessage as T,
   DrawerActionsBar,
   Icon,
+  If,
 } from '@/components';
 import withAlertsActions from '@/containers/Alert/withAlertActions';
 import { useCashflowTransactionDrawerContext } from './CashflowTransactionDrawerProvider';
@@ -19,13 +26,22 @@ function CashflowTransactionDrawerActionBar({
   // #withAlertsDialog
   openAlert,
 }) {
-  const { referenceId } = useCashflowTransactionDrawerContext();
+  const { referenceId, cashflowTransaction } =
+    useCashflowTransactionDrawerContext();
 
   // Handle cashflow transaction delete action.
   const handleDeleteCashflowTransaction = () => {
     openAlert('account-transaction-delete', { referenceId });
   };
 
+  // Handles the uncategorize button click.
+  const handleUncategorizeBtnClick = () => {
+    openAlert('cashflow-tranaction-uncategorize', {
+      uncategorizedTransactionId:
+        cashflowTransaction.uncategorized_transaction_id,
+    });
+  };
+
   return (
     <Can I={CashflowAction.Delete} a={AbilitySubject.Cashflow}>
       <DrawerActionsBar>
@@ -37,6 +53,14 @@ function CashflowTransactionDrawerActionBar({
             intent={Intent.DANGER}
             onClick={handleDeleteCashflowTransaction}
           />
+          <If condition={cashflowTransaction.uncategorized_transaction_id}>
+            <NavbarDivider />
+            <Button
+              text={'Uncategorize'}
+              onClick={handleUncategorizeBtnClick}
+              className={Classes.MINIMAL}
+            />
+          </If>
         </NavbarGroup>
       </DrawerActionsBar>
     </Can>

packages/webapp/src/hooks/query/cashflowAccounts.tsx

@@ -256,3 +256,26 @@ export function useCategorizeTransaction(props) {
     },
   );
 }
+
+/**
+ * Uncategorize the cashflow transaction.
+ */
+export function useUncategorizeTransaction(props) {
+  const queryClient = useQueryClient();
+  const apiRequest = useApiRequest();
+
+  return useMutation(
+    (id: number) => apiRequest.post(`cashflow/transactions/${id}/uncategorize`),
+    {
+      onSuccess: (res, id) => {
+        // Invalidate queries.
+        commonInvalidateQueries(queryClient);
+        queryClient.invalidateQueries(t.CASHFLOW_UNCAATEGORIZED_TRANSACTION);
+        queryClient.invalidateQueries(
+          t.CASHFLOW_ACCOUNT_UNCATEGORIZED_TRANSACTIONS_INFINITY,
+        );
+      },
+      ...props,
+    },
+  );
+}