feat: export reports csv and xlsx (#286)

bigcapitalhq · Nov 28, 2023 · d15c589 · d15c589
1 parent 151aff4
commit d15c589
Show file tree

Hide file tree

Showing 125 changed files with 4,682 additions and 942 deletions.
diff --git a/packages/server/package.json b/packages/server/package.json
@@ -100,7 +100,8 @@
     "tsyringe": "^4.3.0",
     "typedi": "^0.8.0",
     "uniqid": "^5.2.0",
-    "winston": "^3.2.1"
+    "winston": "^3.2.1",
+    "xlsx": "^0.18.5"
   },
   "devDependencies": {
     "@types/lodash": "^4.14.158",

diff --git a/packages/server/src/api/controllers/FinancialStatements/APAgingSummary.ts b/packages/server/src/api/controllers/FinancialStatements/APAgingSummary.ts
@@ -2,19 +2,20 @@ import { Router, Request, Response, NextFunction } from 'express';
 import { query } from 'express-validator';
 import { Inject } from 'typedi';
 import asyncMiddleware from '@/api/middleware/asyncMiddleware';
-import APAgingSummaryReportService from '@/services/FinancialStatements/AgingSummary/APAgingSummaryService';
 import BaseFinancialReportController from './BaseFinancialReportController';
 import { AbilitySubject, ReportsAction } from '@/interfaces';
 import CheckPolicies from '@/api/middleware/CheckPolicies';
+import { ACCEPT_TYPE } from '@/interfaces/Http';
+import { APAgingSummaryApplication } from '@/services/FinancialStatements/AgingSummary/APAgingSummaryApplication';
 
 export default class APAgingSummaryReportController extends BaseFinancialReportController {
   @Inject()
-  APAgingSummaryService: APAgingSummaryReportService;
+  private APAgingSummaryApp: APAgingSummaryApplication;
 
   /**
    * Router constructor.
    */
-  router() {
+  public router() {
     const router = Router();
 
     router.get(
@@ -28,8 +29,9 @@ export default class APAgingSummaryReportController extends BaseFinancialReportC
 
   /**
    * Validation schema.
+   * @returns {ValidationChain[]}
    */
-  get validationSchema() {
+  private get validationSchema() {
     return [
       ...this.sheetNumberFormatValidationSchema,
       query('as_date').optional().isISO8601(),
@@ -49,42 +51,58 @@ export default class APAgingSummaryReportController extends BaseFinancialReportC
   }
 
   /**
-   * Retrieve payable aging summary report.
+   * Retrieves payable aging summary report.
+   * @param {Request} req -
+   * @param {Response} res -
+   * @param {NextFunction} next -
    */
-  async payableAgingSummary(req: Request, res: Response, next: NextFunction) {
-    const { tenantId, settings } = req;
+  private async payableAgingSummary(
+    req: Request,
+    res: Response,
+    next: NextFunction
+  ) {
+    const { tenantId } = req;
     const filter = this.matchedQueryData(req);
 
     try {
       const accept = this.accepts(req);
-      const acceptType = accept.types(['json', 'application/json+table']);
+      const acceptType = accept.types([
+        ACCEPT_TYPE.APPLICATION_JSON,
+        ACCEPT_TYPE.APPLICATION_JSON_TABLE,
+        ACCEPT_TYPE.APPLICATION_CSV,
+        ACCEPT_TYPE.APPLICATION_XLSX,
+      ]);
+      // Retrieves the json table format.
+      if (ACCEPT_TYPE.APPLICATION_JSON_TABLE === acceptType) {
+        const table = await this.APAgingSummaryApp.table(tenantId, filter);
 
-      switch (acceptType) {
-        case 'application/json+table':
-          const table = await this.APAgingSummaryService.APAgingSummaryTable(
-            tenantId,
-            filter
-          );
-          return res.status(200).send({
-            table: {
-              rows: table.rows,
-              columns: table.columns,
-            },
-            meta: table.meta,
-            query: table.query,
-          });
-          break;
-        default:
-          const { data, columns, query, meta } =
-            await this.APAgingSummaryService.APAgingSummary(tenantId, filter);
+        return res.status(200).send(table);
+        // Retrieves the csv format.
+      } else if (ACCEPT_TYPE.APPLICATION_CSV === acceptType) {
+        const csv = await this.APAgingSummaryApp.csv(tenantId, filter);
 
-          return res.status(200).send({
-            data: this.transfromToResponse(data),
-            columns: this.transfromToResponse(columns),
-            query: this.transfromToResponse(query),
-            meta: this.transfromToResponse(meta),
-          });
-          break;
+        res.setHeader('Content-Disposition', 'attachment; filename=output.csv');
+        res.setHeader('Content-Type', 'text/csv');
+
+        return res.send(csv);
+        // Retrieves the xlsx format.
+      } else if (ACCEPT_TYPE.APPLICATION_XLSX === acceptType) {
+        const buffer = await this.APAgingSummaryApp.xlsx(tenantId, filter);
+
+        res.setHeader(
+          'Content-Disposition',
+          'attachment; filename=output.xlsx'
+        );
+        res.setHeader(
+          'Content-Type',
+          'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+        );
+        return res.send(buffer);
+        // Retrieves the json format.
+      } else {
+        const sheet = await this.APAgingSummaryApp.sheet(tenantId, filter);
+
+        return res.status(200).send(sheet);
       }
     } catch (error) {
       next(error);

diff --git a/packages/server/src/api/controllers/FinancialStatements/ARAgingSummary.ts b/packages/server/src/api/controllers/FinancialStatements/ARAgingSummary.ts
@@ -5,16 +5,18 @@ import ARAgingSummaryService from '@/services/FinancialStatements/AgingSummary/A
 import BaseFinancialReportController from './BaseFinancialReportController';
 import { AbilitySubject, ReportsAction } from '@/interfaces';
 import CheckPolicies from '@/api/middleware/CheckPolicies';
+import { ARAgingSummaryApplication } from '@/services/FinancialStatements/AgingSummary/ARAgingSummaryApplication';
+import { ACCEPT_TYPE } from '@/interfaces/Http';
 
 @Service()
 export default class ARAgingSummaryReportController extends BaseFinancialReportController {
   @Inject()
-  ARAgingSummaryService: ARAgingSummaryService;
+  ARAgingSummaryApp: ARAgingSummaryApplication;
 
   /**
    * Router constructor.
    */
-  router() {
+  public router() {
     const router = Router();
 
     router.get(
@@ -30,7 +32,7 @@ export default class ARAgingSummaryReportController extends BaseFinancialReportC
   /**
    * AR aging summary validation roles.
    */
-  get validationSchema() {
+  private get validationSchema() {
     return [
       ...this.sheetNumberFormatValidationSchema,
 
@@ -52,41 +54,53 @@ export default class ARAgingSummaryReportController extends BaseFinancialReportC
 
   /**
    * Retrieve AR aging summary report.
+   * @param {Request} req
+   * @param {Response} res
    */
-  async receivableAgingSummary(req: Request, res: Response) {
-    const { tenantId, settings } = req;
+  private async receivableAgingSummary(req: Request, res: Response) {
+    const { tenantId } = req;
     const filter = this.matchedQueryData(req);
 
     try {
       const accept = this.accepts(req);
-      const acceptType = accept.types(['json', 'application/json+table']);
-
-      switch (acceptType) {
-        case 'application/json+table':
-          const table = await this.ARAgingSummaryService.ARAgingSummaryTable(
-            tenantId,
-            filter
-          );
-          return res.status(200).send({
-            table: {
-              rows: table.rows,
-              columns: table.columns,
-            },
-            meta: table.meta,
-            query: table.query,
-          });
-          break;
-        default:
-          const { data, columns, query, meta } =
-            await this.ARAgingSummaryService.ARAgingSummary(tenantId, filter);
-
-          return res.status(200).send({
-            data: this.transfromToResponse(data),
-            columns: this.transfromToResponse(columns),
-            query: this.transfromToResponse(query),
-            meta: this.transfromToResponse(meta),
-          });
-          break;
+
+      const acceptType = accept.types([
+        ACCEPT_TYPE.APPLICATION_JSON,
+        ACCEPT_TYPE.APPLICATION_JSON_TABLE,
+        ACCEPT_TYPE.APPLICATION_CSV,
+        ACCEPT_TYPE.APPLICATION_XLSX,
+      ]);
+      // Retrieves the xlsx format.
+      if (ACCEPT_TYPE.APPLICATION_XLSX === acceptType) {
+        const buffer = await this.ARAgingSummaryApp.xlsx(tenantId, filter);
+
+        res.setHeader(
+          'Content-Disposition',
+          'attachment; filename=output.xlsx'
+        );
+        res.setHeader(
+          'Content-Type',
+          'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+        );
+        return res.send(buffer);
+        // Retrieves the table format.
+      } else if (ACCEPT_TYPE.APPLICATION_JSON_TABLE === acceptType) {
+        const table = await this.ARAgingSummaryApp.table(tenantId, filter);
+
+        return res.status(200).send(table);
+        // Retrieves the csv format.
+      } else if (ACCEPT_TYPE.APPLICATION_CSV === acceptType) {
+        const buffer = await this.ARAgingSummaryApp.csv(tenantId, filter);
+
+        res.setHeader('Content-Disposition', 'attachment; filename=output.csv');
+        res.setHeader('Content-Type', 'text/csv');
+
+        return res.send(buffer);
+        // Retrieves the json format.
+      } else {
+        const sheet = await this.ARAgingSummaryApp.sheet(tenantId, filter);
+
+        return res.status(200).send(sheet);
       }
     } catch (error) {
       console.log(error);

diff --git a/packages/server/src/api/controllers/FinancialStatements/BalanceSheet.ts b/packages/server/src/api/controllers/FinancialStatements/BalanceSheet.ts
@@ -3,25 +3,21 @@ import { Router, Request, Response, NextFunction } from 'express';
 import { query, ValidationChain } from 'express-validator';
 import { castArray } from 'lodash';
 import asyncMiddleware from '@/api/middleware/asyncMiddleware';
-import BalanceSheetStatementService from '@/services/FinancialStatements/BalanceSheet/BalanceSheetService';
 import BaseFinancialReportController from './BaseFinancialReportController';
 import { AbilitySubject, ReportsAction } from '@/interfaces';
 import CheckPolicies from '@/api/middleware/CheckPolicies';
-import BalanceSheetTable from '@/services/FinancialStatements/BalanceSheet/BalanceSheetTable';
-import HasTenancyService from '@/services/Tenancy/TenancyService';
+import { BalanceSheetApplication } from '@/services/FinancialStatements/BalanceSheet/BalanceSheetApplication';
+import { ACCEPT_TYPE } from '@/interfaces/Http';
 
 @Service()
 export default class BalanceSheetStatementController extends BaseFinancialReportController {
   @Inject()
-  balanceSheetService: BalanceSheetStatementService;
-
-  @Inject()
-  tenancy: HasTenancyService;
+  private balanceSheetApp: BalanceSheetApplication;
 
   /**
    * Router constructor.
    */
-  router() {
+  public router() {
     const router = Router();
 
     router.get(
@@ -38,7 +34,7 @@ export default class BalanceSheetStatementController extends BaseFinancialReport
    * Balance sheet validation schecma.
    * @returns {ValidationChain[]}
    */
-  get balanceSheetValidationSchema(): ValidationChain[] {
+  private get balanceSheetValidationSchema(): ValidationChain[] {
     return [
       ...this.sheetNumberFormatValidationSchema,
       query('accounting_method').optional().isIn(['cash', 'accrual']),
@@ -84,40 +80,58 @@ export default class BalanceSheetStatementController extends BaseFinancialReport
 
   /**
    * Retrieve the balance sheet.
+   * @param {Request} req
+   * @param {Response} res
+   * @param {NextFunction} next
    */
-  async balanceSheet(req: Request, res: Response, next: NextFunction) {
-    const { tenantId, settings } = req;
-    const i18n = this.tenancy.i18n(tenantId);
+  private async balanceSheet(req: Request, res: Response, next: NextFunction) {
+    const { tenantId } = req;
 
     let filter = this.matchedQueryData(req);
 
     filter = {
       ...filter,
       accountsIds: castArray(filter.accountsIds),
     };
-
     try {
-      const { data, columns, query, meta } =
-        await this.balanceSheetService.balanceSheet(tenantId, filter);
-
       const accept = this.accepts(req);
-      const acceptType = accept.types(['json', 'application/json+table']);
-
-      const table = new BalanceSheetTable(data, query, i18n);
-
-      switch (acceptType) {
-        case 'application/json+table':
-          return res.status(200).send({
-            table: {
-              rows: table.tableRows(),
-              columns: table.tableColumns(),
-            },
-            query,
-            meta,
-          });
-        case 'json':
-        default:
-          return res.status(200).send({ data, columns, query, meta });
+
+      const acceptType = accept.types([
+        ACCEPT_TYPE.APPLICATION_JSON,
+        ACCEPT_TYPE.APPLICATION_JSON_TABLE,
+        ACCEPT_TYPE.APPLICATION_XLSX,
+        ACCEPT_TYPE.APPLICATION_CSV,
+      ]);
+      // Retrieves the json table format.
+      if (ACCEPT_TYPE.APPLICATION_JSON_TABLE == acceptType) {
+        const table = await this.balanceSheetApp.table(tenantId, filter);
+
+        return res.status(200).send(table);
+        // Retrieves the csv format.
+      } else if (ACCEPT_TYPE.APPLICATION_CSV === acceptType) {
+        const buffer = await this.balanceSheetApp.csv(tenantId, filter);
+
+        res.setHeader('Content-Disposition', 'attachment; filename=output.csv');
+        res.setHeader('Content-Type', 'text/csv');
+
+        return res.send(buffer);
+        // Retrieves the xlsx format.
+      } else if (ACCEPT_TYPE.APPLICATION_XLSX === acceptType) {
+        const buffer = await this.balanceSheetApp.xlsx(tenantId, filter);
+
+        res.setHeader(
+          'Content-Disposition',
+          'attachment; filename=output.xlsx'
+        );
+        res.setHeader(
+          'Content-Type',
+          'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+        );
+        return res.send(buffer);
+      } else {
+        const sheet = await this.balanceSheetApp.sheet(tenantId, filter);
+
+        return res.status(200).send(sheet);
       }
     } catch (error) {
       next(error);