feat: code review notes

This commit is contained in:
Ahmed Bouhuolia
2024-02-21 17:17:34 +02:00
parent d16ec7cda9
commit 1752c32eec
30 changed files with 43 additions and 42 deletions

View File

@@ -31,7 +31,6 @@ export const BalanceSheetNetIncome = (Base: any) =>
/** /**
* Retrieves the closing balance of income accounts. * Retrieves the closing balance of income accounts.
* @returns {number} * @returns {number}
*
*/ */
private getIncomeTotal = () => { private getIncomeTotal = () => {
const closeingBalance = this.repository.incomeLedger.getClosingBalance(); const closeingBalance = this.repository.incomeLedger.getClosingBalance();

View File

@@ -41,13 +41,14 @@ export default class BalanceSheetTable extends R.compose(
BalanceSheetBase BalanceSheetBase
)(FinancialSheet) { )(FinancialSheet) {
/** /**
* @param {} * Balance sheet data.
* @param {IBalanceSheetStatementData}
*/ */
private reportData: IBalanceSheetStatementData; private reportData: IBalanceSheetStatementData;
/** /**
* Balance sheet query. * Balance sheet query.
* @parma {} * @parma {BalanceSheetQuery}
*/ */
private query: BalanceSheetQuery; private query: BalanceSheetQuery;

View File

@@ -61,14 +61,14 @@ export const FinancialSheetStructure = (Base: Class) =>
}); });
}; };
findNodeDeep = (nodes, callback) => { public findNodeDeep = (nodes, callback) => {
return findValueDeep(nodes, callback, { return findValueDeep(nodes, callback, {
childrenPath: 'children', childrenPath: 'children',
pathFormat: 'array', pathFormat: 'array',
}); });
}; };
mapAccNodesDeep = (nodes, callback) => { public mapAccNodesDeep = (nodes, callback) => {
return reduceDeep( return reduceDeep(
nodes, nodes,
(acc, value, key, parentValue, context) => { (acc, value, key, parentValue, context) => {
@@ -97,11 +97,11 @@ export const FinancialSheetStructure = (Base: Class) =>
}); });
}; };
getTotalOfChildrenNodes = (node) => { public getTotalOfChildrenNodes = (node) => {
return this.getTotalOfNodes(node.children); return this.getTotalOfNodes(node.children);
}; };
getTotalOfNodes = (nodes) => { public getTotalOfNodes = (nodes) => {
return sumBy(nodes, 'total.amount'); return sumBy(nodes, 'total.amount');
}; };
}; };

View File

@@ -40,11 +40,4 @@ export class ProfitLossSheetExportInjectable {
return tableCsv; return tableCsv;
} }
public async pdf(
tenantId: number,
query: IProfitLossSheetQuery
): Promise<Buffer> {
const table = await this.profitLossSheetTable.table(tenantId, query);
}
} }

View File

@@ -52,6 +52,7 @@ export class TableSheetPdf {
landscape, landscape,
}); });
} }
/** /**
* Converts the table columns to pdf columns. * Converts the table columns to pdf columns.
* @param {ITableColumn[]} columns * @param {ITableColumn[]} columns

View File

@@ -9,7 +9,6 @@ import { useBalanceSheetContext } from './BalanceSheetProvider';
import { useBalanceSheetColumns } from './components'; import { useBalanceSheetColumns } from './components';
import { defaultExpanderReducer, tableRowTypesToClassnames } from '@/utils'; import { defaultExpanderReducer, tableRowTypesToClassnames } from '@/utils';
/** /**
* Balance sheet table. * Balance sheet table.
*/ */

View File

@@ -58,7 +58,7 @@ export const useAPAgingSheetCsvExport = (query, args) => {
*/ */
export function useAPAgingSummaryPdf(query = {}) { export function useAPAgingSummaryPdf(query = {}) {
return useRequestPdf({ return useRequestPdf({
url: `/api/financial_statements/payable_aging_summary`, url: `/financial_statements/payable_aging_summary`,
params: query, params: query,
}); });
} }

View File

@@ -57,7 +57,7 @@ export const useARAgingSheetCsvExport = (query, args) => {
*/ */
export function useARAgingSummaryPdf(query = {}) { export function useARAgingSummaryPdf(query = {}) {
return useRequestPdf({ return useRequestPdf({
url: `/api/financial_statements/receivable_aging_summary`, url: `/financial_statements/receivable_aging_summary`,
params: query, params: query,
}); });
} }

View File

@@ -76,7 +76,7 @@ export const useBalanceSheetCsvExport = (query, args) => {
*/ */
export function useBalanceSheetPdf(query = {}) { export function useBalanceSheetPdf(query = {}) {
return useRequestPdf({ return useRequestPdf({
url: `/api/financial_statements/balance_sheet`, url: `/financial_statements/balance_sheet`,
params: query, params: query,
}); });
} }

View File

@@ -77,7 +77,7 @@ export const useCashFlowStatementCsvExport = (query, args) => {
*/ */
export function useCashflowSheetPdf(query = {}) { export function useCashflowSheetPdf(query = {}) {
return useRequestPdf({ return useRequestPdf({
url: `/api/financial_statements/cash-flow`, url: `/financial_statements/cash-flow`,
params: query, params: query,
}); });
} }

View File

@@ -65,7 +65,7 @@ export const useCustomerBalanceSummaryCsvExport = (query, args) => {
*/ */
export function useCustomerBalanceSummaryPdf(query = {}) { export function useCustomerBalanceSummaryPdf(query = {}) {
return useRequestPdf({ return useRequestPdf({
url: `/api/financial_statements/customer-balance-summary`, url: `/financial_statements/customer-balance-summary`,
params: query, params: query,
}); });
} }

View File

@@ -69,7 +69,7 @@ export const useCustomersTransactionsCsvExport = (query, args) => {
*/ */
export const useCustomersTransactionsPdfExport = (query = {}) => { export const useCustomersTransactionsPdfExport = (query = {}) => {
return useRequestPdf({ return useRequestPdf({
url: '/api/financial_statements/transactions-by-customers', url: '/financial_statements/transactions-by-customers',
params: query, params: query,
}); });
}; };

View File

@@ -57,7 +57,7 @@ export const useGeneralLedgerSheetCsvExport = (query, args) => {
*/ */
export function useGeneralLedgerPdf(query = {}) { export function useGeneralLedgerPdf(query = {}) {
return useRequestPdf({ return useRequestPdf({
url: `/api/financial_statements/general_ledger`, url: `/financial_statements/general_ledger`,
params: query params: query
}); });
} }

View File

@@ -69,7 +69,7 @@ export const useInventoryItemDetailsCsvExport = (query, args) => {
*/ */
export function useInventoryItemDetailsPdf(query = {}) { export function useInventoryItemDetailsPdf(query = {}) {
return useRequestPdf({ return useRequestPdf({
url: `/api/financial_statements/inventory-item-details`, url: `/financial_statements/inventory-item-details`,
params: query, params: query,
}); });
} }

View File

@@ -77,7 +77,7 @@ export const useInventoryValuationCsvExport = (query, args) => {
*/ */
export function useInventoryValuationPdf(query = {}) { export function useInventoryValuationPdf(query = {}) {
return useRequestPdf({ return useRequestPdf({
url: `/api/financial_statements/inventory-valuation`, url: `/financial_statements/inventory-valuation`,
params: query, params: query,
}); });
} }

View File

@@ -58,7 +58,7 @@ export const useJournalSheetCsvExport = (query, args) => {
*/ */
export const useJournalSheetPdf = (query = {}) => { export const useJournalSheetPdf = (query = {}) => {
return useRequestPdf({ return useRequestPdf({
url: `/api/financial_statements/journal`, url: `/financial_statements/journal`,
params: query, params: query,
}); });
}; };

View File

@@ -58,7 +58,7 @@ export const useProfitLossSheetCsvExport = (query, args) => {
*/ */
export function useProfitLossSheetPdf(query = {}) { export function useProfitLossSheetPdf(query = {}) {
return useRequestPdf({ return useRequestPdf({
url: `/api/financial_statements/profit_loss_sheet`, url: `/financial_statements/profit_loss_sheet`,
params: query, params: query,
}); });
} }

View File

@@ -73,7 +73,7 @@ export const usePurchasesByItemsXlsxExport = (query, args) => {
*/ */
export const usePurchasesByItemsPdfExport = (query = {}) => { export const usePurchasesByItemsPdfExport = (query = {}) => {
return useRequestPdf({ return useRequestPdf({
url: '/api/financial_statements/purchases-by-items', url: '/financial_statements/purchases-by-items',
params: query, params: query,
}); });
}; };

View File

@@ -72,7 +72,7 @@ export const useSalesByItemsXlsxExport = (query, args) => {
export const useSalesByItemsPdfExport = (query = {}) => { export const useSalesByItemsPdfExport = (query = {}) => {
return useRequestPdf({ return useRequestPdf({
url: '/api/financial_statements/sales-by-items', url: '/financial_statements/sales-by-items',
params: query, params: query,
}); });
}; };

View File

@@ -58,7 +58,7 @@ export const useSalesTaxLiabilitySummaryCsvExport = (query, args) => {
*/ */
export function useSalesTaxLiabilitySummaryPdf(query = {}) { export function useSalesTaxLiabilitySummaryPdf(query = {}) {
return useRequestPdf({ return useRequestPdf({
url: `/api/financial_statements/sales-tax-liability-summary`, url: `/financial_statements/sales-tax-liability-summary`,
params: query, params: query,
}); });
} }

View File

@@ -58,7 +58,7 @@ export const useTrialBalanceSheetCsvExport = (query, args) => {
*/ */
export function useTrialBalanceSheetPdf(query = {}) { export function useTrialBalanceSheetPdf(query = {}) {
return useRequestPdf({ return useRequestPdf({
url: `/api/financial_statements/trial_balance_sheet`, url: `/financial_statements/trial_balance_sheet`,
params: query, params: query,
}); });
} }

View File

@@ -65,7 +65,7 @@ export const useVendorBalanceSummaryCsvExport = (args) => {
export const useVendorBalanceSummaryPdfExport = (query = {}) => { export const useVendorBalanceSummaryPdfExport = (query = {}) => {
return useRequestPdf({ return useRequestPdf({
url: '/api/financial_statements/vendor-balance-summary', url: 'financial_statements/vendor-balance-summary',
params: query, params: query,
}); });
}; };

View File

@@ -68,7 +68,7 @@ export const useVendorsTransactionsCsvExport = (query, args) => {
*/ */
export function useTransactionsByVendorsPdf(query = {}) { export function useTransactionsByVendorsPdf(query = {}) {
return useRequestPdf({ return useRequestPdf({
url: `/api/financial_statements/transactions-by-vendors`, url: `financial_statements/transactions-by-vendors`,
params: query, params: query,
}); });
} }

View File

@@ -354,5 +354,7 @@ export function useRefundCreditTransaction(id, props, requestProps) {
* Retrieve the credit note pdf document data, * Retrieve the credit note pdf document data,
*/ */
export function usePdfCreditNote(creditNoteId) { export function usePdfCreditNote(creditNoteId) {
return useRequestPdf(`sales/credit_notes/${creditNoteId}`); return useRequestPdf({
url: `sales/credit_notes/${creditNoteId}`,
});
} }

View File

@@ -181,7 +181,9 @@ export function useRejectEstimate(props) {
*/ */
export function usePdfEstimate(estimateId) { export function usePdfEstimate(estimateId) {
return useRequestPdf(`sales/estimates/${estimateId}`); return useRequestPdf({
url: `sales/estimates/${estimateId}`,
});
} }
export function useRefreshEstimates() { export function useRefreshEstimates() {

View File

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

View File

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

View File

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

View File

@@ -1,9 +1,7 @@
// @ts-nocheck // @ts-nocheck
import { useQueryClient, useMutation } from 'react-query'; import { useQueryClient, useMutation } from 'react-query';
import { useRequestQuery } from '../useQueryRequest'; import { useRequestQuery } from '../useQueryRequest';
import { transformPagination } from '@/utils';
import useApiRequest from '../useRequest'; import useApiRequest from '../useRequest';
import { useRequestPdf } from '../utils';
import t from './types'; import t from './types';
// Common invalidate queries. // Common invalidate queries.

View File

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