Files
bigcapital/packages/webapp/src/containers/FinancialStatements/APAgingSummary/common.tsx
2023-08-27 00:44:37 +02:00

85 lines
2.0 KiB
TypeScript

// @ts-nocheck
import moment from 'moment';
import * as Yup from 'yup';
import { transformToCamelCase, flatObject, transformToForm } from '@/utils';
import { useAppQueryString } from '@/hooks';
import { useMemo } from 'react';
import { castArray } from 'lodash';
export const transformFilterFormToQuery = (form) => {
return flatObject(transformToCamelCase(form));
};
/**
* The default query of AP aging summary.
* @returns
*/
export const getDefaultAPAgingSummaryQuery = () => {
return {
asDate: moment().endOf('day').format('YYYY-MM-DD'),
agingDaysBefore: 30,
agingPeriods: 3,
filterByOption: 'without-zero-balance',
vendorsIds: [],
branchesIds: [],
};
};
/**
* Retrieves the query validation schema.
* @returns {Yup}
*/
export const getAPAgingSummaryQuerySchema = () => {
return Yup.object({
asDate: Yup.date().required().label('asDate'),
agingDaysBefore: Yup.number()
.required()
.integer()
.positive()
.label('Aging days before')
.min(1)
.max(500),
agingPeriods: Yup.number()
.required()
.integer()
.positive()
.max(12)
.min(1)
.label('Aging periods'),
});
};
/**
* Parses the AP aging summary query state.
* @param locationQuery
* @returns
*/
const parseAPAgingSummaryQuery = (locationQuery) => {
const defaultQuery = getDefaultAPAgingSummaryQuery();
const transformed = {
...defaultQuery,
...transformToForm(locationQuery, defaultQuery),
};
return {
...transformed,
vendorsIds: castArray(transformed.vendorsIds),
branchesIds: castArray(transformed.branchesIds),
};
};
/**
* AP aging summary query state.
*/
export const useAPAgingSummaryQuery = () => {
// Retrieves location query.
const [locationQuery, setLocationQuery] = useAppQueryString();
// Merges the default filter query with location URL query.
const query = useMemo(
() => parseAPAgingSummaryQuery(locationQuery),
[locationQuery],
);
return { query, locationQuery, setLocationQuery };
};