Merge pull request #310 from bigcapitalhq/big-99-purchases-by-items

feat: sales by items export csv & xlsx

packages/webapp/src/containers/FinancialStatements/SalesByItems/SalesByItemProvider.tsx

@@ -1,7 +1,7 @@
 // @ts-nocheck
-import React, { createContext, useContext } from 'react';
+import { createContext, useContext } from 'react';
 import FinancialReportPage from '../FinancialReportPage';
-import { useSalesByItems } from '@/hooks/query';
+import { useSalesByItemsTable } from '@/hooks/query';
 import { transformFilterFormToQuery } from '../common';
 
 const SalesByItemsContext = createContext();
@@ -12,7 +12,7 @@ function SalesByItemProvider({ query, ...props }) {
     isFetching,
     isLoading,
     refetch,
-  } = useSalesByItems(
+  } = useSalesByItemsTable(
     {
       ...transformFilterFormToQuery(query),
     },

packages/webapp/src/containers/FinancialStatements/SalesByItems/SalesByItemsActionsBar.tsx

@@ -19,6 +19,7 @@ import withSalesByItemsActions from './withSalesByItemsActions';
 
 import { compose, saveInvoke } from '@/utils';
 import { useSalesByItemsContext } from './SalesByItemProvider';
+import { SalesByItemsSheetExportMenu } from './components';
 
 function SalesByItemsActionsBar({
   // #withSalesByItems
@@ -108,11 +109,18 @@ function SalesByItemsActionsBar({
           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'} />}
-        />
+        <Popover
+          content={<SalesByItemsSheetExportMenu />}
+          interactionKind={PopoverInteractionKind.CLICK}
+          placement="bottom-start"
+          minimal
+        >
+          <Button
+            className={Classes.MINIMAL}
+            icon={<Icon icon="file-export-16" iconSize={16} />}
+            text={<T id={'export'} />}
+          />
+        </Popover>
       </NavbarGroup>
     </DashboardActionsBar>
   );

packages/webapp/src/containers/FinancialStatements/SalesByItems/SalesByItemsTable.tsx

@@ -5,7 +5,7 @@ import styled from 'styled-components';
 
 import { ReportDataTable, FinancialSheet } from '@/components';
 import { useSalesByItemsContext } from './SalesByItemProvider';
-import { useSalesByItemsTableColumns } from './components';
+import { useSalesByItemsTableColumns } from './dynamicColumns';
 import { tableRowTypesToClassnames } from '@/utils';
 import { TableStyle } from '@/constants';
 
@@ -15,7 +15,7 @@ import { TableStyle } from '@/constants';
 export default function SalesByItemsTable({ companyName }) {
   // Sales by items context.
   const {
-    salesByItems: { tableRows, query },
+    salesByItems: { table, query },
     isLoading,
   } = useSalesByItemsContext();
 
@@ -32,7 +32,7 @@ export default function SalesByItemsTable({ companyName }) {
     >
       <SalesByItemsDataTable
         columns={columns}
-        data={tableRows}
+        data={table.rows}
         expandable={true}
         expandToggleColumn={1}
         expandColumnSpace={1}
@@ -59,7 +59,7 @@ const SalesByItemsDataTable = styled(ReportDataTable)`
         padding-top: 0.4rem;
         padding-bottom: 0.4rem;
       }
-      .tr.row_type--total .td {
+      .tr.row_type--TOTAL .td {
         border-top: 1px solid #bbb;
         font-weight: 500;
         border-bottom: 3px double #000;

packages/webapp/src/containers/FinancialStatements/SalesByItems/components.tsx

@@ -1,70 +1,20 @@
 // @ts-nocheck
-import React, { useMemo } from 'react';
+import { useMemo, useRef } from 'react';
 import intl from 'react-intl-universal';
+import classNames from 'classnames';
+import { Classes } from '@blueprintjs/core';
 
 import { getColumnWidth } from '@/utils';
-import { If } from '@/components';
+import { AppToaster, If, Stack } from '@/components';
 import { Align } from '@/constants';
 import { CellTextSpan } from '@/components/Datatable/Cells';
 import { useSalesByItemsContext } from './SalesByItemProvider';
 import FinancialLoadingBar from '../FinancialLoadingBar';
-
-
-/**
- * Retrieve sales by items table columns.
- */
-export const useSalesByItemsTableColumns = () => {
-  //sales by items context.
-  const {
-    salesByItems: { tableRows },
-  } = useSalesByItemsContext();
-
-  return useMemo(
-    () => [
-      {
-        Header: intl.get('item_name'),
-        accessor: (row) => (row.code ? `${row.name} - ${row.code}` : row.name),
-        className: 'name',
-        width: 180,
-        textOverview: true,
-      },
-      {
-        Header: intl.get('sold_quantity'),
-        accessor: 'quantity_sold_formatted',
-        Cell: CellTextSpan,
-        className: 'quantity_sold',
-        width: getColumnWidth(tableRows, `quantity_sold_formatted`, {
-          minWidth: 150,
-        }),
-        textOverview: true,
-        align: Align.Right,
-      },
-      {
-        Header: intl.get('sold_amount'),
-        accessor: 'sold_cost_formatted',
-        Cell: CellTextSpan,
-        className: 'sold_cost',
-        width: getColumnWidth(tableRows, `sold_cost_formatted`, {
-          minWidth: 150,
-        }),
-        textOverview: true,
-        align: Align.Right,
-      },
-      {
-        Header: intl.get('average_price'),
-        accessor: 'average_sell_price_formatted',
-        Cell: CellTextSpan,
-        className: 'average_sell_price',
-        width: getColumnWidth(tableRows, `average_sell_price_formatted`, {
-          minWidth: 150,
-        }),
-        textOverview: true,
-        align: Align.Right,
-      },
-    ],
-    [tableRows],
-  );
-};
+import { Intent, Menu, MenuItem, ProgressBar, Text } from '@blueprintjs/core';
+import {
+  useSalesByItemsCsvExport,
+  useSalesByItemsXlsxExport,
+} from '@/hooks/query';
 
 /**
  * sales by items progress loading bar.
@@ -77,3 +27,88 @@ export function SalesByItemsLoadingBar() {
     </If>
   );
 }
+
+/**
+ * Retrieves the sales by items export menu.
+ * @returns {JSX.Element}
+ */
+export const SalesByItemsSheetExportMenu = () => {
+  const toastKey = useRef(null);
+  const commonToastConfig = {
+    isCloseButtonShown: true,
+    timeout: 2000,
+  };
+  const { query } = useSalesByItemsContext();
+
+  const openProgressToast = (amount: number) => {
+    return (
+      <Stack spacing={8}>
+        <Text>The report has been exported successfully.</Text>
+        <ProgressBar
+          className={classNames('toast-progress', {
+            [Classes.PROGRESS_NO_STRIPES]: amount >= 100,
+          })}
+          intent={amount < 100 ? Intent.PRIMARY : Intent.SUCCESS}
+          value={amount / 100}
+        />
+      </Stack>
+    );
+  };
+
+  // Export the report to xlsx.
+  const { mutateAsync: xlsxExport } = useSalesByItemsXlsxExport(query, {
+    onDownloadProgress: (xlsxExportProgress: number) => {
+      if (!toastKey.current) {
+        toastKey.current = AppToaster.show({
+          message: openProgressToast(xlsxExportProgress),
+          ...commonToastConfig,
+        });
+      } else {
+        AppToaster.show(
+          {
+            message: openProgressToast(xlsxExportProgress),
+            ...commonToastConfig,
+          },
+          toastKey.current,
+        );
+      }
+    },
+  });
+  // Export the report to csv.
+  const { mutateAsync: csvExport } = useSalesByItemsCsvExport(query, {
+    onDownloadProgress: (xlsxExportProgress: number) => {
+      if (!toastKey.current) {
+        toastKey.current = AppToaster.show({
+          message: openProgressToast(xlsxExportProgress),
+          ...commonToastConfig,
+        });
+      } else {
+        AppToaster.show(
+          {
+            message: openProgressToast(xlsxExportProgress),
+            ...commonToastConfig,
+          },
+          toastKey.current,
+        );
+      }
+    },
+  });
+  // Handle csv export button click.
+  const handleCsvExportBtnClick = () => {
+    csvExport();
+  };
+  // Handle xlsx export button click.
+  const handleXlsxExportBtnClick = () => {
+    xlsxExport();
+  };
+
+  return (
+    <Menu>
+      <MenuItem
+        text={'XLSX (Microsoft Excel)'}
+        onClick={handleXlsxExportBtnClick}
+      />
+      <MenuItem text={'CSV'} onClick={handleCsvExportBtnClick} />
+    </Menu>
+  );
+};

packages/webapp/src/containers/FinancialStatements/SalesByItems/dynamicColumns.ts

@@ -0,0 +1,89 @@
+// @ts-nocheck
+import { getColumnWidth } from '@/utils';
+import * as R from 'ramda';
+import { Align } from '@/constants';
+import { useSalesByItemsContext } from './SalesByItemProvider';
+
+const getTableCellValueAccessor = (index) => `cells[${index}].value`;
+
+const getReportColWidth = (data, accessor, headerText) => {
+  return getColumnWidth(
+    data,
+    accessor,
+    { magicSpacing: 10, minWidth: 100 },
+    headerText,
+  );
+};
+
+/**
+ * Account name column mapper.
+ */
+const commonColumnMapper = R.curry((data, column) => {
+  const accessor = getTableCellValueAccessor(column.cell_index);
+
+  return {
+    key: column.key,
+    Header: column.label,
+    accessor,
+    className: column.key,
+    textOverview: true,
+  };
+});
+
+/**
+ * Numeric columns accessor.
+ */
+const numericColumnAccessor = R.curry((data, column) => {
+  const accessor = getTableCellValueAccessor(column.cell_index);
+  const width = getReportColWidth(data, accessor, column.label);
+
+  return {
+    ...column,
+    align: Align.Right,
+    width,
+  };
+});
+
+/**
+ * Item name column accessor.
+ */
+const itemNameColumnAccessor = R.curry((data, column) => {
+  return {
+    ...column,
+    width: 180,
+  }
+});
+
+const dynamiColumnMapper = R.curry((data, column) => {
+  const _numericColumnAccessor = numericColumnAccessor(data);
+  const _itemNameColumnAccessor = itemNameColumnAccessor(data);
+
+  return R.compose(
+    R.when(R.pathEq(['key'], 'item_name'), _itemNameColumnAccessor),
+    R.when(R.pathEq(['key'], 'sold_quantity'), _numericColumnAccessor),
+    R.when(R.pathEq(['key'], 'sold_amount'), _numericColumnAccessor),
+    R.when(R.pathEq(['key'], 'average_price'), _numericColumnAccessor),
+    commonColumnMapper(data),
+  )(column);
+});
+
+/**
+ * Composes the dynamic columns that fetched from request to columns to table component.
+ */
+export const dynamicColumns = R.curry((data, columns) => {
+  return R.map(dynamiColumnMapper(data), columns);
+});
+
+/**
+ * Retrieves the G/L sheet table columns for table component.
+ */
+export const useSalesByItemsTableColumns = () => {
+  const { salesByItems } = useSalesByItemsContext();
+
+  if (!salesByItems) {
+    throw new Error('Sales by items context not found');
+  }
+  const { table } = salesByItems;
+
+  return dynamicColumns(table.rows, table.columns);
+};

packages/webapp/src/hooks/query/financialReports.tsx

@@ -463,20 +463,60 @@ export function useSalesByItems(query, props) {
       params: query,
     },
     {
-      select: (res) => ({
-        tableRows: salesByItemsReducer(res.data.data),
-        ...res.data,
-      }),
-      defaultData: {
-        tableRows: [],
-        data: [],
-        query: {},
-      },
       ...props,
     },
   );
 }
 
+/**
+ * Retrieves sales by items table format.
+ */
+export function useSalesByItemsTable(query, props) {
+  return useRequestQuery(
+    [t.FINANCIAL_REPORT, t.SALES_BY_ITEMS, query],
+    {
+      method: 'get',
+      url: '/financial_statements/sales-by-items',
+      params: query,
+      headers: {
+        Accept: 'application/json+table',
+      },
+    },
+    {
+      select: (res) => res.data,
+      ...props,
+    },
+  );
+}
+
+export const useSalesByItemsCsvExport = (query, args) => {
+  return useDownloadFile({
+    url: '/financial_statements/sales-by-items',
+    config: {
+      headers: {
+        accept: 'application/csv',
+      },
+      params: query,
+    },
+    filename: 'sales_by_items.csv',
+    ...args,
+  });
+};
+
+export const useSalesByItemsXlsxExport = (query, args) => {
+  return useDownloadFile({
+    url: '/financial_statements/sales-by-items',
+    config: {
+      headers: {
+        accept: 'application/xlsx',
+      },
+      params: query,
+    },
+    filename: 'sales_by_items.xlsx',
+    ...args,
+  });
+};
+
 /**
  * Retrieve customers balance summary report.
  */