feat: vendors balance summary.

client/src/containers/FinancialStatements/VendorsBalanceSummary/VendorsBalanceSummary.js

@@ -0,0 +1,87 @@
+import React, { useEffect, useState } from 'react';
+import moment from 'moment';
+
+import 'style/pages/FinancialStatements/ContactsBalanceSummary.scss';
+
+import { FinancialStatement } from 'components';
+import DashboardPageContent from 'components/Dashboard/DashboardPageContent';
+
+import VendorsBalanceSummaryActionsBar from './VendorsBalanceSummaryActionsBar';
+import VendorsBalanceSummaryHeader from './VendorsBalanceSummaryHeader';
+import VendorsBalanceSummaryTable from './VendorsBalanceSummaryTable';
+
+import { VendorsBalanceSummaryProvider } from './VendorsBalanceSummaryProvider';
+import { VendorsSummarySheetLoadingBar } from './components';
+import withVendorsBalanceSummaryActions from './withVendorsBalanceSummaryActions';
+
+import withSettings from 'containers/Settings/withSettings';
+
+import { compose } from 'utils';
+
+/**
+ * Vendors Balance summary.
+ */
+function VendorsBalanceSummary({
+  // #withPreferences
+  organizationName,
+
+  // #withVendorsBalanceSummaryActions
+  toggleVendorSummaryFilterDrawer,
+}) {
+  const [filter, setFilter] = useState({
+    asDate: moment().endOf('day').format('YYYY-MM-DD'),
+  });
+
+  // Handle refetch vendors balance summary.
+  const handleFilterSubmit = (filter) => {
+    const _filter = {
+      ...filter,
+      asDate: moment(filter.asDate).format('YYYY-MM-DD'),
+    };
+    setFilter(_filter);
+  };
+
+  // Handle number format submit.
+  const handleNumberFormatSubmit = (format) => {
+    setFilter({
+      ...filter,
+      numberFormat: format,
+    });
+  };
+
+  useEffect(
+    () => () => {
+      toggleVendorSummaryFilterDrawer(false);
+    },
+    [toggleVendorSummaryFilterDrawer],
+  );
+
+  return (
+    <VendorsBalanceSummaryProvider filter={filter}>
+      <VendorsBalanceSummaryActionsBar
+        numberFormat={filter?.numberFormat}
+        onNumberFormatSubmit={handleNumberFormatSubmit}
+      />
+      <VendorsSummarySheetLoadingBar />
+
+      <DashboardPageContent>
+        <FinancialStatement>
+          <VendorsBalanceSummaryHeader
+            pageFilter={filter}
+            onSubmitFilter={handleFilterSubmit}
+          />
+          <div className={'financial-statement__body'}>
+            <VendorsBalanceSummaryTable organizationName={organizationName} />
+          </div>
+        </FinancialStatement>
+      </DashboardPageContent>
+    </VendorsBalanceSummaryProvider>
+  );
+}
+
+export default compose(
+  withSettings(({ organizationSettings }) => ({
+    organizationName: organizationSettings?.name,
+  })),
+  withVendorsBalanceSummaryActions,
+)(VendorsBalanceSummary);

client/src/containers/FinancialStatements/VendorsBalanceSummary/VendorsBalanceSummaryActionsBar.js

@@ -0,0 +1,126 @@
+import React from 'react';
+import {
+  NavbarDivider,
+  NavbarGroup,
+  Classes,
+  Button,
+  Popover,
+  PopoverInteractionKind,
+  Position,
+} from '@blueprintjs/core';
+import { FormattedMessage as T } from 'react-intl';
+import classNames from 'classnames';
+
+import { Icon } from 'components';
+import DashboardActionsBar from 'components/Dashboard/DashboardActionsBar';
+import NumberFormatDropdown from 'components/NumberFormatDropdown';
+
+import withVendorsBalanceSummary from './withVendorsBalanceSummary';
+import withVendorsBalanceSummaryActions from './withVendorsBalanceSummaryActions';
+import { useVendorsBalanceSummaryContext } from './VendorsBalanceSummaryProvider';
+
+import { saveInvoke, compose } from 'utils';
+
+/**
+ * Vendors balance summary action bar.
+ */
+function VendorsBalanceSummaryActionsBar({
+  //#ownProps
+  numberFormat,
+  onNumberFormatSubmit,
+
+  // #withVendorsBalanceSummary
+  isFilterDrawerOpen,
+
+  // #withVendorsBalanceSummaryActions
+  toggleVendorSummaryFilterDrawer,
+}) {
+  const {
+    isVendorsBalanceLoading,
+    refetch,
+  } = useVendorsBalanceSummaryContext();
+
+  const handleFilterToggleClick = () => {
+    toggleVendorSummaryFilterDrawer();
+  };
+
+  // handle recalculate report button.
+  const handleRecalculateReport = () => {
+    refetch();
+  };
+
+  // handle number format submit.
+  const handleNumberFormatSubmit = (numberFormat) => {
+    saveInvoke(onNumberFormatSubmit, numberFormat);
+  };
+
+  return (
+    <DashboardActionsBar>
+      <NavbarGroup>
+        <Button
+          className={classNames(Classes.MINIMAL, 'button--gray-highlight')}
+          text={<T id={'recalc_report'} />}
+          onClick={handleRecalculateReport}
+          icon={<Icon icon="refresh-16" iconSize={16} />}
+        />
+        <NavbarDivider />
+        <Button
+          className={classNames(Classes.MINIMAL, 'button--table-views')}
+          icon={<Icon icon="cog-16" iconSize={16} />}
+          text={
+            isFilterDrawerOpen ? (
+              <T id={'hide_customizer'} />
+            ) : (
+              <T id={'customize_report'} />
+            )
+          }
+          onClick={handleFilterToggleClick}
+          active={isFilterDrawerOpen}
+        />
+        <NavbarDivider />
+        <Popover
+          content={
+            <NumberFormatDropdown
+              numberFormat={numberFormat}
+              onSubmit={handleNumberFormatSubmit}
+              submitDisabled={isVendorsBalanceLoading}
+            />
+          }
+          minimal={true}
+          interactionKind={PopoverInteractionKind.CLICK}
+          position={Position.BOTTOM_LEFT}
+        >
+          <Button
+            className={classNames(Classes.MINIMAL, 'button--filter')}
+            text={<T id={'format'} />}
+            icon={<Icon icon="numbers" width={23} height={16} />}
+          />
+        </Popover>
+
+        <Button
+          className={Classes.MINIMAL}
+          text={<T id={'filter'} />}
+          icon={<Icon icon="filter-16" iconSize={16} />}
+        />
+        <NavbarDivider />
+
+        <Button
+          className={Classes.MINIMAL}
+          icon={<Icon icon="print-16" iconSize={16} />}
+          text={<T id={'print'} />}
+        />
+        <Button
+          className={Classes.MINIMAL}
+          icon={<Icon icon="file-export-16" iconSize={16} />}
+          text={<T id={'export'} />}
+        />
+      </NavbarGroup>
+    </DashboardActionsBar>
+  );
+}
+export default compose(
+  withVendorsBalanceSummaryActions,
+  withVendorsBalanceSummary(({ VendorsSummaryFilterDrawer }) => ({
+    isFilterDrawerOpen: VendorsSummaryFilterDrawer,
+  })),
+)(VendorsBalanceSummaryActionsBar);

client/src/containers/FinancialStatements/VendorsBalanceSummary/VendorsBalanceSummaryHeader.js

@@ -0,0 +1,89 @@
+import React from 'react';
+import * as Yup from 'yup';
+import { Formik, Form } from 'formik';
+import moment from 'moment';
+import { Tabs, Tab, Button, Intent } from '@blueprintjs/core';
+import { FormattedMessage as T } from 'react-intl';
+
+import FinancialStatementHeader from 'containers/FinancialStatements/FinancialStatementHeader';
+import withVendorsBalanceSummary from './withVendorsBalanceSummary';
+import withVendorsBalanceSummaryActions from './withVendorsBalanceSummaryActions';
+import VendorsBalanceSummaryHeaderGeneral from './VendorsBalanceSummaryHeaderGeneral';
+
+import { compose } from 'utils';
+
+/**
+ * Vendors balance summary drawer header.
+ */
+function VendorsBalanceSummaryHeader({
+  // #ownProps
+  pageFilter,
+  onSubmitFilter,
+
+  //#withVendorsBalanceSummary
+  VendorsSummaryFilterDrawer,
+
+  //#withVendorsBalanceSummaryActions
+  toggleVendorSummaryFilterDrawer,
+}) {
+  // validation schema.
+  const validationSchema = Yup.object().shape({
+    asDate: Yup.date().required().label('asDate'),
+  });
+
+  // filter form initial values.
+  const initialValues = {
+    ...pageFilter,
+    asDate: moment(pageFilter.asDate).toDate(),
+  };
+
+  // handle form submit.
+  const handleSubmit = (values, { setSubmitting }) => {
+    onSubmitFilter(values);
+    toggleVendorSummaryFilterDrawer(false);
+    setSubmitting(false);
+  };
+
+  // handle cancel button click.
+  const handleCancelClick = () => {
+    toggleVendorSummaryFilterDrawer(false);
+  };
+
+  return (
+    <FinancialStatementHeader
+      isOpen={VendorsSummaryFilterDrawer}
+      drawerProps={{ onClose: handleCancelClick }}
+    >
+      <Formik
+        initialValues={initialValues}
+        validationSchema={validationSchema}
+        onSubmit={handleSubmit}
+      >
+        <Form>
+          <Tabs animate={true} vertical={true} renderActiveTabPanelOnly={true}>
+            <Tab
+              id={'general'}
+              title={<T id={'general'} />}
+              panel={<VendorsBalanceSummaryHeaderGeneral />}
+            />
+          </Tabs>
+          <div className={'financial-header-drawer__footer'}>
+            <Button className={'mr1'} intent={Intent.PRIMARY} type={'submit'}>
+              <T id={'calculate_report'} />
+            </Button>
+            <Button onClick={handleCancelClick} minimal={true}>
+              <T id={'cancel'} />
+            </Button>
+          </div>
+        </Form>
+      </Formik>
+    </FinancialStatementHeader>
+  );
+}
+
+export default compose(
+  withVendorsBalanceSummary(({ VendorsSummaryFilterDrawer }) => ({
+    VendorsSummaryFilterDrawer,
+  })),
+  withVendorsBalanceSummaryActions,
+)(VendorsBalanceSummaryHeader);

client/src/containers/FinancialStatements/VendorsBalanceSummary/VendorsBalanceSummaryHeaderGeneral.js

@@ -0,0 +1,64 @@
+import React from 'react';
+import { FastField } from 'formik';
+import { DateInput } from '@blueprintjs/datetime';
+import { FormGroup, Position, Classes, Checkbox } from '@blueprintjs/core';
+import { FormattedMessage as T } from 'react-intl';
+import { Row, Col, FieldHint } from 'components';
+import {
+  momentFormatter,
+  tansformDateValue,
+  inputIntent,
+  handleDateChange,
+} from 'utils';
+
+/**
+ * Vendors balance header -general panel.
+ */
+export default function VendorsBalanceSummaryHeaderGeneral() {
+  return (
+    <div>
+      <Row>
+        <Col xs={5}>
+          <FastField name={'asDate'}>
+            {({ form, field: { value }, meta: { error } }) => (
+              <FormGroup
+                label={<T id={'as_date'} />}
+                labelInfo={<FieldHint />}
+                fill={true}
+                intent={inputIntent({ error })}
+              >
+                <DateInput
+                  {...momentFormatter('YYYY/MM/DD')}
+                  value={tansformDateValue(value)}
+                  onChange={handleDateChange((selectedDate) => {
+                    form.setFieldValue('asDate', selectedDate);
+                  })}
+                  popoverProps={{ position: Position.BOTTOM, minimal: true }}
+                  minimal={true}
+                  fill={true}
+                />
+              </FormGroup>
+            )}
+          </FastField>
+        </Col>
+      </Row>
+      <Row>
+        <Col xs={5}>
+          <FastField name={'percentage'} type={'checkbox'}>
+            {({ field }) => (
+              <FormGroup labelInfo={<FieldHint />}>
+                <Checkbox
+                  inline={true}
+                  small={true}
+                  label={'Percentage Of Column'}
+                  name={'percentage'}
+                  {...field}
+                />
+              </FormGroup>
+            )}
+          </FastField>
+        </Col>
+      </Row>
+    </div>
+  );
+}

client/src/containers/FinancialStatements/VendorsBalanceSummary/VendorsBalanceSummaryProvider.js

@@ -0,0 +1,41 @@
+import React from 'react';
+import FinancialReportPage from '../FinancialReportPage';
+import { useVendorsBalanceSummaryReport } from 'hooks/query';
+import { transformFilterFormToQuery } from '../common';
+
+const VendorsBalanceSummaryContext = React.createContext();
+
+/**
+ * Vendors balance summary provider.
+ */
+function VendorsBalanceSummaryProvider({ filter, ...props }) {
+  // const query = React.useMemo(() => transformFilterFormToQuery(filter), [
+  //   filter,
+  // ]);
+
+  const {
+    data: VendorBalanceSummary,
+    isLoading: isVendorsBalanceLoading,
+    isFetching: isVendorsBalanceFetching,
+    refetch,
+  } = useVendorsBalanceSummaryReport(filter, {
+    keepPreviousData: true,
+  });
+
+  const provider = {
+    VendorBalanceSummary,
+    isVendorsBalanceLoading,
+    isVendorsBalanceFetching,
+    refetch,
+  };
+
+  return (
+    <FinancialReportPage name={'vendors-balance-summary'}>
+      <VendorsBalanceSummaryContext.Provider value={provider} {...props} />
+    </FinancialReportPage>
+  );
+}
+
+const useVendorsBalanceSummaryContext = () =>
+  React.useContext(VendorsBalanceSummaryContext);
+export { VendorsBalanceSummaryProvider, useVendorsBalanceSummaryContext };

client/src/containers/FinancialStatements/VendorsBalanceSummary/VendorsBalanceSummaryTable.js

@@ -0,0 +1,47 @@
+import React from 'react';
+import { FormattedMessage as T, useIntl } from 'react-intl';
+import { DataTable } from 'components';
+import FinancialSheet from 'components/FinancialSheet';
+
+import { useVendorsBalanceColumns } from './components';
+import { useVendorsBalanceSummaryContext } from './VendorsBalanceSummaryProvider';
+
+/**
+ * Vendors balance summary table.
+ */
+export default function VendorsBalanceSummaryTable({
+  //#ownProps
+  organizationName,
+}) {
+  const { formatMessage } = useIntl();
+
+  const {
+    VendorBalanceSummary,
+    isVendorsBalanceLoading,
+  } = useVendorsBalanceSummaryContext();
+
+  // vendors balance summary columns.
+  const columns = useVendorsBalanceColumns();
+
+  const rowClassNames = (row) => {
+    return [`row-type--${row.original.rowTypes}`];
+  };
+
+  return (
+    <FinancialSheet
+      companyName={organizationName}
+      name={'vendors-balance-summary'}
+      sheetType={formatMessage({ id: 'vendors_balance_summary' })}
+      asDate={new Date()}
+      loading={isVendorsBalanceLoading}
+    >
+      <DataTable
+        className={'bigcapital-datatable--financial-report'}
+        columns={columns}
+        data={VendorBalanceSummary?.tableRows}
+        rowClassNames={rowClassNames}
+        noInitialFetch={true}
+      />
+    </FinancialSheet>
+  );
+}

client/src/containers/FinancialStatements/VendorsBalanceSummary/components.js

@@ -0,0 +1,47 @@
+import React, { useMemo } from 'react';
+import { formatMessage } from 'services/intl';
+
+import { If } from 'components';
+import { getColumnWidth } from 'utils';
+import FinancialLoadingBar from '../FinancialLoadingBar';
+import { useVendorsBalanceSummaryContext } from './VendorsBalanceSummaryProvider';
+
+/**
+ * Retrieve vendors balance summary columns.
+ */
+export const useVendorsBalanceColumns = () => {
+  return useMemo(() => [
+    {
+      Header: formatMessage({ id: 'vendor_name' }),
+      accessor: 'cells[0].value',
+      className: 'customer_name',
+      width: 240,
+      sticky: 'left',
+      textOverview: true,
+    },
+    {
+      Header: formatMessage({ id: 'total' }),
+      accessor: 'cells[1].value',
+      className: 'total',
+      width: 140,
+    },
+    {
+      Header: formatMessage({ id: 'percentage_of_column' }),
+      accessor: 'cells[2].value',
+      // className: 'total',
+      width: 140,
+    },
+  ]);
+};
+
+/**
+ * vendors balance summary loading bar.
+ */
+export function VendorsSummarySheetLoadingBar() {
+  const { isVendorsBalanceFetching } = useVendorsBalanceSummaryContext();
+  return (
+    <If condition={isVendorsBalanceFetching}>
+      <FinancialLoadingBar />
+    </If>
+  );
+}

client/src/containers/FinancialStatements/VendorsBalanceSummary/withVendorsBalanceSummary.js

@@ -0,0 +1,15 @@
+import { connect } from 'react-redux';
+import { getVendorsBalanceSummaryFilterDrawer } from 'store/financialStatement/financialStatements.selectors';
+
+export default (mapState) => {
+  const mapStateToProps = (state, props) => {
+    const mapped = {
+      VendorsSummaryFilterDrawer: getVendorsBalanceSummaryFilterDrawer(
+        state,
+        props,
+      ),
+    };
+    return mapState ? mapState(mapped, state, props) : mapped;
+  };
+  return connect(mapStateToProps);
+};

client/src/containers/FinancialStatements/VendorsBalanceSummary/withVendorsBalanceSummaryActions.js

@@ -0,0 +1,9 @@
+import { connect } from 'react-redux';
+import { toggleVendorsBalanceSummaryFilterDrawer } from 'store/financialStatement/financialStatements.actions';
+
+const mapActionsToProps = (dispatch) => ({
+  toggleVendorSummaryFilterDrawer: (toggle) =>
+    dispatch(toggleVendorsBalanceSummaryFilterDrawer(toggle)),
+});
+
+export default connect(null, mapActionsToProps);