feat: code review notes

2026-02-13 11:20:31 +00:00 · 2024-02-21 17:17:34 +02:00
parent d16ec7cda9
commit 1752c32eec
30 changed files with 43 additions and 42 deletions
--- a/packages/server/src/services/FinancialStatements/BalanceSheet/BalanceSheetNetIncome.ts
+++ b/packages/server/src/services/FinancialStatements/BalanceSheet/BalanceSheetNetIncome.ts
@@ -31,7 +31,6 @@ export const BalanceSheetNetIncome = (Base: any) =>
    /**
     * Retrieves the closing balance of income accounts.
     * @returns {number}
-     * 
     */
    private getIncomeTotal = () => {
      const closeingBalance = this.repository.incomeLedger.getClosingBalance();
--- a/packages/server/src/services/FinancialStatements/BalanceSheet/BalanceSheetTable.ts
+++ b/packages/server/src/services/FinancialStatements/BalanceSheet/BalanceSheetTable.ts
@@ -41,13 +41,14 @@ export default class BalanceSheetTable extends R.compose(
  BalanceSheetBase
 )(FinancialSheet) {
  /**
-   * @param {}
+   * Balance sheet data.
+   * @param {IBalanceSheetStatementData}
   */
  private reportData: IBalanceSheetStatementData;

  /**
   * Balance sheet query.
-   * @parma {}
+   * @parma {BalanceSheetQuery}
   */
  private query: BalanceSheetQuery;

--- a/packages/server/src/services/FinancialStatements/FinancialSheetStructure.ts
+++ b/packages/server/src/services/FinancialStatements/FinancialSheetStructure.ts
@@ -61,14 +61,14 @@ export const FinancialSheetStructure = (Base: Class) =>
      });
    };

-    findNodeDeep = (nodes, callback) => {
+    public findNodeDeep = (nodes, callback) => {
      return findValueDeep(nodes, callback, {
        childrenPath: 'children',
        pathFormat: 'array',
      });
    };

-    mapAccNodesDeep = (nodes, callback) => {
+    public mapAccNodesDeep = (nodes, callback) => {
      return reduceDeep(
        nodes,
        (acc, value, key, parentValue, context) => {
@@ -97,11 +97,11 @@ export const FinancialSheetStructure = (Base: Class) =>
      });
    };

-    getTotalOfChildrenNodes = (node) => {
+    public getTotalOfChildrenNodes = (node) => {
      return this.getTotalOfNodes(node.children);
    };

-    getTotalOfNodes = (nodes) => {
+    public getTotalOfNodes = (nodes) => {
      return sumBy(nodes, 'total.amount');
    };
  };
--- a/packages/server/src/services/FinancialStatements/ProfitLossSheet/ProfitLossSheetExportInjectable.ts
+++ b/packages/server/src/services/FinancialStatements/ProfitLossSheet/ProfitLossSheetExportInjectable.ts
@@ -40,11 +40,4 @@ export class ProfitLossSheetExportInjectable {

    return tableCsv;
  }
-
-  public async pdf(
-    tenantId: number,
-    query: IProfitLossSheetQuery
-  ): Promise<Buffer> {
-    const table = await this.profitLossSheetTable.table(tenantId, query);
-  }
 }
--- a/packages/server/src/services/FinancialStatements/TableSheetPdf.ts
+++ b/packages/server/src/services/FinancialStatements/TableSheetPdf.ts
@@ -52,6 +52,7 @@ export class TableSheetPdf {
      landscape,
    });
  }
+
  /**
   * Converts the table columns to pdf columns.
   * @param {ITableColumn[]} columns
--- a/packages/webapp/src/containers/FinancialStatements/BalanceSheet/BalanceSheetTable.tsx
+++ b/packages/webapp/src/containers/FinancialStatements/BalanceSheet/BalanceSheetTable.tsx
@@ -9,7 +9,6 @@ import { useBalanceSheetContext } from './BalanceSheetProvider';
 import { useBalanceSheetColumns } from './components';
 import { defaultExpanderReducer, tableRowTypesToClassnames } from '@/utils';

-
 /**
 * Balance sheet table.
 */
--- a/packages/webapp/src/hooks/query/FinancialReports/use-AP-aging-summary.ts
+++ b/packages/webapp/src/hooks/query/FinancialReports/use-AP-aging-summary.ts
@@ -58,7 +58,7 @@ export const useAPAgingSheetCsvExport = (query, args) => {
 */
 export function useAPAgingSummaryPdf(query = {}) {
  return useRequestPdf({
-    url: `/api/financial_statements/payable_aging_summary`,
+    url: `/financial_statements/payable_aging_summary`,
    params: query,
  });
 }
--- a/packages/webapp/src/hooks/query/FinancialReports/use-AR-aging-summary.ts
+++ b/packages/webapp/src/hooks/query/FinancialReports/use-AR-aging-summary.ts
@@ -57,7 +57,7 @@ export const useARAgingSheetCsvExport = (query, args) => {
 */
 export function useARAgingSummaryPdf(query = {}) {
  return useRequestPdf({
-    url: `/api/financial_statements/receivable_aging_summary`,
+    url: `/financial_statements/receivable_aging_summary`,
    params: query,
  });
 }
--- a/packages/webapp/src/hooks/query/FinancialReports/use-balance-sheet.ts
+++ b/packages/webapp/src/hooks/query/FinancialReports/use-balance-sheet.ts
@@ -76,7 +76,7 @@ export const useBalanceSheetCsvExport = (query, args) => {
 */
 export function useBalanceSheetPdf(query = {}) {
  return useRequestPdf({
-    url: `/api/financial_statements/balance_sheet`,
+    url: `/financial_statements/balance_sheet`,
    params: query,
  });
 }
--- a/packages/webapp/src/hooks/query/FinancialReports/use-cashflow-sheet.ts
+++ b/packages/webapp/src/hooks/query/FinancialReports/use-cashflow-sheet.ts
@@ -77,7 +77,7 @@ export const useCashFlowStatementCsvExport = (query, args) => {
 */
 export function useCashflowSheetPdf(query = {}) {
  return useRequestPdf({
-    url: `/api/financial_statements/cash-flow`,
+    url: `/financial_statements/cash-flow`,
    params: query,
  });
 }
--- a/packages/webapp/src/hooks/query/FinancialReports/use-customer-balance-summary.ts
+++ b/packages/webapp/src/hooks/query/FinancialReports/use-customer-balance-summary.ts
@@ -65,7 +65,7 @@ export const useCustomerBalanceSummaryCsvExport = (query, args) => {
 */
 export function useCustomerBalanceSummaryPdf(query = {}) {
  return useRequestPdf({
-    url: `/api/financial_statements/customer-balance-summary`,
+    url: `/financial_statements/customer-balance-summary`,
    params: query,
  });
 }
--- a/packages/webapp/src/hooks/query/FinancialReports/use-customer-transactions.ts
+++ b/packages/webapp/src/hooks/query/FinancialReports/use-customer-transactions.ts
@@ -69,7 +69,7 @@ export const useCustomersTransactionsCsvExport = (query, args) => {
 */
 export const useCustomersTransactionsPdfExport = (query = {}) => {
  return useRequestPdf({
-    url: '/api/financial_statements/transactions-by-customers',
+    url: '/financial_statements/transactions-by-customers',
    params: query,
  });
 };
--- a/packages/webapp/src/hooks/query/FinancialReports/use-general-ledger.ts
+++ b/packages/webapp/src/hooks/query/FinancialReports/use-general-ledger.ts
@@ -57,7 +57,7 @@ export const useGeneralLedgerSheetCsvExport = (query, args) => {
 */
 export function useGeneralLedgerPdf(query = {}) {
  return useRequestPdf({
-    url: `/api/financial_statements/general_ledger`,
+    url: `/financial_statements/general_ledger`,
    params: query
  });
 }
--- a/packages/webapp/src/hooks/query/FinancialReports/use-inventory-item-details.ts
+++ b/packages/webapp/src/hooks/query/FinancialReports/use-inventory-item-details.ts
@@ -69,7 +69,7 @@ export const useInventoryItemDetailsCsvExport = (query, args) => {
 */
 export function useInventoryItemDetailsPdf(query = {}) {
  return useRequestPdf({
-    url: `/api/financial_statements/inventory-item-details`,
+    url: `/financial_statements/inventory-item-details`,
    params: query,
  });
 }
--- a/packages/webapp/src/hooks/query/FinancialReports/use-inventory-valuation.ts
+++ b/packages/webapp/src/hooks/query/FinancialReports/use-inventory-valuation.ts
@@ -77,7 +77,7 @@ export const useInventoryValuationCsvExport = (query, args) => {
 */
 export function useInventoryValuationPdf(query = {}) {
  return useRequestPdf({
-    url: `/api/financial_statements/inventory-valuation`,
+    url: `/financial_statements/inventory-valuation`,
    params: query,
  });
 }
--- a/packages/webapp/src/hooks/query/FinancialReports/use-journal-sheet.ts
+++ b/packages/webapp/src/hooks/query/FinancialReports/use-journal-sheet.ts
@@ -58,7 +58,7 @@ export const useJournalSheetCsvExport = (query, args) => {
 */
 export const useJournalSheetPdf = (query = {}) => {
  return useRequestPdf({
-    url: `/api/financial_statements/journal`,
+    url: `/financial_statements/journal`,
    params: query,
  });
 };
--- a/packages/webapp/src/hooks/query/FinancialReports/use-profit-loss-sheet.ts
+++ b/packages/webapp/src/hooks/query/FinancialReports/use-profit-loss-sheet.ts
@@ -58,7 +58,7 @@ export const useProfitLossSheetCsvExport = (query, args) => {
 */
 export function useProfitLossSheetPdf(query = {}) {
  return useRequestPdf({
-    url: `/api/financial_statements/profit_loss_sheet`,
+    url: `/financial_statements/profit_loss_sheet`,
    params: query,
  });
 }
--- a/packages/webapp/src/hooks/query/FinancialReports/use-purchases-by-items.ts
+++ b/packages/webapp/src/hooks/query/FinancialReports/use-purchases-by-items.ts
@@ -73,7 +73,7 @@ export const usePurchasesByItemsXlsxExport = (query, args) => {
 */
 export const usePurchasesByItemsPdfExport = (query = {}) => {
  return useRequestPdf({
-    url: '/api/financial_statements/purchases-by-items',
+    url: '/financial_statements/purchases-by-items',
    params: query,
  });
 };
--- a/packages/webapp/src/hooks/query/FinancialReports/use-sales-by-items.ts
+++ b/packages/webapp/src/hooks/query/FinancialReports/use-sales-by-items.ts
@@ -72,7 +72,7 @@ export const useSalesByItemsXlsxExport = (query, args) => {

 export const useSalesByItemsPdfExport = (query = {}) => {
  return useRequestPdf({
-    url: '/api/financial_statements/sales-by-items',
+    url: '/financial_statements/sales-by-items',
    params: query,
  });
 };
--- a/packages/webapp/src/hooks/query/FinancialReports/use-sales-tax-liabilities-summary.ts
+++ b/packages/webapp/src/hooks/query/FinancialReports/use-sales-tax-liabilities-summary.ts
@@ -58,7 +58,7 @@ export const useSalesTaxLiabilitySummaryCsvExport = (query, args) => {
 */
 export function useSalesTaxLiabilitySummaryPdf(query = {}) {
  return useRequestPdf({
-    url: `/api/financial_statements/sales-tax-liability-summary`,
+    url: `/financial_statements/sales-tax-liability-summary`,
    params: query,
  });
 }
--- a/packages/webapp/src/hooks/query/FinancialReports/use-trial-balance-sheet.ts
+++ b/packages/webapp/src/hooks/query/FinancialReports/use-trial-balance-sheet.ts
@@ -58,7 +58,7 @@ export const useTrialBalanceSheetCsvExport = (query, args) => {
 */
 export function useTrialBalanceSheetPdf(query = {}) {
  return useRequestPdf({
-    url: `/api/financial_statements/trial_balance_sheet`,
+    url: `/financial_statements/trial_balance_sheet`,
    params: query,
  });
 }
--- a/packages/webapp/src/hooks/query/FinancialReports/use-vendor-balance-summary.ts
+++ b/packages/webapp/src/hooks/query/FinancialReports/use-vendor-balance-summary.ts
@@ -65,7 +65,7 @@ export const useVendorBalanceSummaryCsvExport = (args) => {

 export const useVendorBalanceSummaryPdfExport = (query = {}) => {
  return useRequestPdf({
-    url: '/api/financial_statements/vendor-balance-summary',
+    url: 'financial_statements/vendor-balance-summary',
    params: query,
  });
 };
--- a/packages/webapp/src/hooks/query/FinancialReports/use-vendor-transactions.ts
+++ b/packages/webapp/src/hooks/query/FinancialReports/use-vendor-transactions.ts
@@ -68,7 +68,7 @@ export const useVendorsTransactionsCsvExport = (query, args) => {
 */
 export function useTransactionsByVendorsPdf(query = {}) {
  return useRequestPdf({
-    url: `/api/financial_statements/transactions-by-vendors`,
+    url: `financial_statements/transactions-by-vendors`,
    params: query,
  });
 }
--- a/packages/webapp/src/hooks/query/creditNote.tsx
+++ b/packages/webapp/src/hooks/query/creditNote.tsx
@@ -354,5 +354,7 @@ export function useRefundCreditTransaction(id, props, requestProps) {
 * Retrieve the credit note pdf document data,
 */
 export function usePdfCreditNote(creditNoteId) {
-  return useRequestPdf(`sales/credit_notes/${creditNoteId}`);
+  return useRequestPdf({
+    url: `sales/credit_notes/${creditNoteId}`,
+  });
 }
--- a/packages/webapp/src/hooks/query/estimates.tsx
+++ b/packages/webapp/src/hooks/query/estimates.tsx
@@ -181,7 +181,9 @@ export function useRejectEstimate(props) {
 */

 export function usePdfEstimate(estimateId) {
-  return useRequestPdf(`sales/estimates/${estimateId}`);
+  return useRequestPdf({
+    url: `sales/estimates/${estimateId}`,
+  });
 }

 export function useRefreshEstimates() {
--- a/packages/webapp/src/hooks/query/invoices.tsx
+++ b/packages/webapp/src/hooks/query/invoices.tsx
@@ -24,7 +24,7 @@ const commonInvalidateQueries = (queryClient) => {

  // Invalidate financial reports.
  queryClient.invalidateQueries(t.FINANCIAL_REPORT);
-  
+
  // Invalidate transactions by reference.
  queryClient.invalidateQueries(t.TRANSACTIONS_BY_REFERENCE);

@@ -188,7 +188,9 @@ export function useInvoice(invoiceId, props, requestProps) {
 * Retrieve the invoice pdf document data.
 */
 export function usePdfInvoice(invoiceId) {
-  return useRequestPdf(`sales/invoices/${invoiceId}`);
+  return useRequestPdf({
+    url: `sales/invoices/${invoiceId}`,
+  });
 }

 /**
@@ -339,4 +341,3 @@ export function useSaleInvoiceDefaultOptions(invoiceId, props) {
    },
  );
 }
-
--- a/packages/webapp/src/hooks/query/paymentReceives.tsx
+++ b/packages/webapp/src/hooks/query/paymentReceives.tsx
@@ -233,9 +233,10 @@ export function usePaymentReceiveSMSDetail(

 /**
 * Retrieve the payment receive pdf document data.
+ * @param {number} paymentReceiveId - Payment receive id.
 */
 export function usePdfPaymentReceive(paymentReceiveId) {
-  return useRequestPdf(`sales/payment_receives/${paymentReceiveId}`);
+  return useRequestPdf({ url: `sales/payment_receives/${paymentReceiveId}` });
 }

 export function useSendPaymentReceiveMail(props) {
--- a/packages/webapp/src/hooks/query/receipts.tsx
+++ b/packages/webapp/src/hooks/query/receipts.tsx
@@ -162,9 +162,12 @@ export function useReceipt(id, props) {

 /**
 * Retrieve the receipt pdf document data.
+ * @param {number} receiptId -
 */
-export function usePdfReceipt(ReceiptId) {
-  return useRequestPdf(`sales/receipts/${ReceiptId}`);
+export function usePdfReceipt(receiptId: number) {
+  return useRequestPdf({
+    url: `sales/receipts/${receiptId}`,
+  });
 }

 export function useRefreshReceipts() {
--- a/packages/webapp/src/hooks/query/transactionsLocking.tsx
+++ b/packages/webapp/src/hooks/query/transactionsLocking.tsx
@@ -1,9 +1,7 @@
 // @ts-nocheck
 import { useQueryClient, useMutation } from 'react-query';
 import { useRequestQuery } from '../useQueryRequest';
-import { transformPagination } from '@/utils';
 import useApiRequest from '../useRequest';
-import { useRequestPdf } from '../utils';
 import t from './types';

 // Common invalidate queries.
--- a/packages/webapp/src/hooks/useRequestPdf.tsx
+++ b/packages/webapp/src/hooks/useRequestPdf.tsx
@@ -16,6 +16,7 @@ export const useRequestPdf = (httpProps) => {
        headers: { accept: 'application/pdf' },
        responseType: 'blob',
        ...httpProps,
+        url: `/api/${httpProps?.url}`,
      })
      .then((response) => {
        // Create a Blob from the PDF Stream.