From abc5631ac2bf16a11b037a37ba212f897a60d7e6 Mon Sep 17 00:00:00 2001
From: Ahmed Bouhuolia <a.bouhuolia@gmail.com>
Date: Sun, 20 Aug 2023 23:16:54 +0200
Subject: [PATCH] chore(webapp): document functions

---
 .../FinancialStatements/ARAgingSummary/common.tsx        | 3 ++-
 .../CustomersBalanceSummary/utils.tsx                    | 9 ++++-----
 .../FinancialStatements/VendorsTransactions/_utils.ts    | 6 ++----
 3 files changed, 8 insertions(+), 10 deletions(-)

diff --git a/packages/webapp/src/containers/FinancialStatements/ARAgingSummary/common.tsx b/packages/webapp/src/containers/FinancialStatements/ARAgingSummary/common.tsx
index 732cac6f9..e70c6efb3 100644
--- a/packages/webapp/src/containers/FinancialStatements/ARAgingSummary/common.tsx
+++ b/packages/webapp/src/containers/FinancialStatements/ARAgingSummary/common.tsx
@@ -18,8 +18,8 @@ export const getDefaultARAgingSummaryQuery = () => {
     asDate: moment().endOf('day').format('YYYY-MM-DD'),
     agingDaysBefore: 30,
     agingPeriods: 3,
-    customersIds: [],
     filterByOption: 'without-zero-balance',
+    customersIds: [],
     branchesIds: [],
   };
 };
@@ -56,6 +56,7 @@ const parseARAgingSummaryQuery = (locationQuery) => {
   return {
     ...transformed,
     branchesIds: castArray(transformed.branchesIds),
+    customersIds: castArray(transformed.customersIds),
   };
 };
 
diff --git a/packages/webapp/src/containers/FinancialStatements/CustomersBalanceSummary/utils.tsx b/packages/webapp/src/containers/FinancialStatements/CustomersBalanceSummary/utils.tsx
index 3118e26d6..5335a7d82 100644
--- a/packages/webapp/src/containers/FinancialStatements/CustomersBalanceSummary/utils.tsx
+++ b/packages/webapp/src/containers/FinancialStatements/CustomersBalanceSummary/utils.tsx
@@ -7,6 +7,9 @@ import { useAppQueryString } from '@/hooks';
 import { getDefaultARAgingSummaryQuery } from '../ARAgingSummary/common';
 import { transformToForm } from '@/utils';
 
+/**
+ * Default query of customers balance summary.
+ */
 export const getDefaultCustomersBalanceQuery = () => {
   return {
     asDate: moment().endOf('day').format('YYYY-MM-DD'),
@@ -27,7 +30,6 @@ export const getCustomersBalanceQuerySchema = () => {
 
 /**
  * Parses the customer balance summary query.
- * @returns
  */
 const parseCustomersBalanceSummaryQuery = (locationQuery) => {
   const defaultQuery = getDefaultARAgingSummaryQuery();
@@ -38,15 +40,12 @@ const parseCustomersBalanceSummaryQuery = (locationQuery) => {
   };
   return {
     ...transformed,
-
-    // 
     customersIds: castArray(transformed.customersIds),
   };
 };
 
 /**
- *
- * @returns
+ * Getter/setter query state of customers balance summary.
  */
 export const useCustomerBalanceSummaryQuery = () => {
   const [locationQuery, setLocationQuery] = useAppQueryString();
diff --git a/packages/webapp/src/containers/FinancialStatements/VendorsTransactions/_utils.ts b/packages/webapp/src/containers/FinancialStatements/VendorsTransactions/_utils.ts
index 053c4adbc..db28d7058 100644
--- a/packages/webapp/src/containers/FinancialStatements/VendorsTransactions/_utils.ts
+++ b/packages/webapp/src/containers/FinancialStatements/VendorsTransactions/_utils.ts
@@ -3,8 +3,7 @@ import intl from 'react-intl-universal';
 import moment from 'moment';
 
 /**
- * 
- * @returns 
+ * The validation schema of vendors transactions.
  */
 export const getVendorTransactionsQuerySchema = () => {
   return Yup.object().shape({
@@ -17,8 +16,7 @@ export const getVendorTransactionsQuerySchema = () => {
 };
 
 /**
- * 
- * @returns {}
+ * Retrieves the default query of vendors transactions.
  */
 export const getVendorsTransactionsDefaultQuery = () => ({
   fromDate: moment().toDate(),