From f5e18fc1fe9e0f8f8bf09b33185008baddde2ff7 Mon Sep 17 00:00:00 2001
From: Ahmed Bouhuolia <a.bouhuolia@gmail.com>
Date: Mon, 29 Jul 2024 14:03:37 +0200
Subject: [PATCH] feat: document the Redux mutation methods

---
 .../containers/CashFlow/withBankingActions.ts | 18 +++++++++++---
 .../src/store/banking/banking.reducer.ts      | 24 +++++++++++++++++++
 2 files changed, 39 insertions(+), 3 deletions(-)

diff --git a/packages/webapp/src/containers/CashFlow/withBankingActions.ts b/packages/webapp/src/containers/CashFlow/withBankingActions.ts
index be394ab67..8d1d7d133 100644
--- a/packages/webapp/src/containers/CashFlow/withBankingActions.ts
+++ b/packages/webapp/src/containers/CashFlow/withBankingActions.ts
@@ -49,7 +49,7 @@ const mapDipatchToProps = (dispatch: any): WithBankingActionsProps => ({
 
   /**
    * Sets the selected uncategorized transactions.
-   * @param {Array<string | number>} ids 
+   * @param {Array<string | number>} ids
    */
   setUncategorizedTransactionsSelected: (ids: Array<string | number>) =>
     dispatch(
@@ -76,17 +76,29 @@ const mapDipatchToProps = (dispatch: any): WithBankingActionsProps => ({
     ),
 
   /**
-   * Resets the excluded selected transactions
+   * Resets the excluded selected transactions.
    */
   resetExcludedTransactionsSelected: () =>
     dispatch(resetExcludedTransactionsSelected()),
 
+  /**
+   * Sets the selected transactions to categorize or match.
+   * @param {Array<string | number>} ids
+   */
   setTransactionsToCategorizeSelected: (ids: Array<string | number>) =>
     dispatch(setTransactionsToCategorizeSelected({ ids })),
+
+  /**
+   * Resets the selected transactions to categorize or match.
+   */
   resetTransactionsToCategorizeSelected: () =>
     dispatch(resetTransactionsToCategorizeSelected()),
 
-  enableMultipleCategorization: (enable) =>
+  /**
+   * Enables/Disables the multiple selection to categorize or match.
+   * @param {boolean} enable
+   */
+  enableMultipleCategorization: (enable: boolean) =>
     dispatch(enableMultipleCategorization({ enable })),
 });
 
diff --git a/packages/webapp/src/store/banking/banking.reducer.ts b/packages/webapp/src/store/banking/banking.reducer.ts
index f0e0a3759..81a2bc0dd 100644
--- a/packages/webapp/src/store/banking/banking.reducer.ts
+++ b/packages/webapp/src/store/banking/banking.reducer.ts
@@ -104,6 +104,11 @@ export const PlaidSlice = createSlice({
       state.excludedTransactionsSelected = [];
     },
 
+    /**
+     * Sets the selected transactions to categorize or match.
+     * @param {StorePlaidState} state
+     * @param {PayloadAction<{ ids: Array<string | number> }>} action
+     */
     setTransactionsToCategorizeSelected: (
       state: StorePlaidState,
       action: PayloadAction<{ ids: Array<string | number> }>,
@@ -111,6 +116,11 @@ export const PlaidSlice = createSlice({
       state.transactionsToCategorizeSelected = action.payload.ids;
     },
 
+    /**
+     * Adds a transaction to selected transactions to categorize or match.
+     * @param {StorePlaidState} state
+     * @param {PayloadAction<{ id: string | number }>} action
+     */
     addTransactionsToCategorizeSelected: (
       state: StorePlaidState,
       action: PayloadAction<{ id: string | number }>,
@@ -121,6 +131,11 @@ export const PlaidSlice = createSlice({
       ]);
     },
 
+    /**
+     * Removes a transaction from the selected transactions to categorize or match.
+     * @param {StorePlaidState} state
+     * @param {PayloadAction<{ id: string | number }>} action
+     */
     removeTransactionsToCategorizeSelected: (
       state: StorePlaidState,
       action: PayloadAction<{ id: string | number }>,
@@ -131,10 +146,19 @@ export const PlaidSlice = createSlice({
         );
     },
 
+    /**
+     * Resets the selected transactions to categorize or match.
+     * @param {StorePlaidState} state
+     */
     resetTransactionsToCategorizeSelected: (state: StorePlaidState) => {
       state.transactionsToCategorizeSelected = [];
     },
 
+    /**
+     * Enables/Disables the multiple selection to categorize or match.
+     * @param {StorePlaidState} state
+     * @param {PayloadAction<{ enable: boolean }>} action
+     */
     enableMultipleCategorization: (
       state: StorePlaidState,
       action: PayloadAction<{ enable: boolean }>,