feat: WIP transactions by customers/vendors.

server/src/api/controllers/BaseController.ts

@@ -1,13 +1,14 @@
 import { Response, Request, NextFunction } from 'express';
-import { matchedData, validationResult } from "express-validator";
-import { camelCase, snakeCase, omit, set, get } from "lodash";
-import { mapKeysDeep } from 'utils'
+import { matchedData, validationResult } from 'express-validator';
+import accepts from 'accepts';
+import { camelCase, snakeCase, omit, set, get } from 'lodash';
+import { mapKeysDeep } from 'utils';
 import asyncMiddleware from 'api/middleware/asyncMiddleware';
 
 export default class BaseController {
   /**
    * Converts plain object keys to cameCase style.
-   * @param {Object} data 
+   * @param {Object} data
    */
   private dataToCamelCase(data) {
     return mapKeysDeep(data, (v, k) => camelCase(k));
@@ -15,8 +16,8 @@ export default class BaseController {
 
   /**
    * Matches the body data from validation schema.
-   * @param {Request} req 
-   * @param options 
+   * @param {Request} req
+   * @param options
    */
   matchedBodyData(req: Request, options: any = {}) {
     const data = matchedData(req, {
@@ -29,7 +30,7 @@ export default class BaseController {
 
   /**
    * Matches the query data from validation schema.
-   * @param {Request} req 
+   * @param {Request} req
    */
   matchedQueryData(req: Request) {
     const data = matchedData(req, {
@@ -40,13 +41,13 @@ export default class BaseController {
 
   /**
    * Validate validation schema middleware.
-   * @param {Request} req 
-   * @param {Response} res 
-   * @param {NextFunction} next 
+   * @param {Request} req
+   * @param {Response} res
+   * @param {NextFunction} next
    */
   validationResult(req: Request, res: Response, next: NextFunction) {
     const validationErrors = validationResult(req);
-    
+
     if (!validationErrors.isEmpty()) {
       return res.boom.badData(null, {
         code: 'validation_error',
@@ -58,13 +59,19 @@ export default class BaseController {
 
   /**
    * Transform the given data to response.
-   * @param {any} data 
+   * @param {any} data
    */
-  transfromToResponse(data: any, translatable?: string | string[], req?: Request) {
+  transfromToResponse(
+    data: any,
+    translatable?: string | string[],
+    req?: Request
+  ) {
     const response = mapKeysDeep(data, (v, k) => snakeCase(k));
 
     if (translatable) {
-      const translatables = Array.isArray(translatable) ? translatable : [translatable];
+      const translatables = Array.isArray(translatable)
+        ? translatable
+        : [translatable];
 
       translatables.forEach((path) => {
         const value = get(response, path);
@@ -76,9 +83,18 @@ export default class BaseController {
 
   /**
    * Async middleware.
-   * @param {function} callback 
+   * @param {function} callback
    */
   asyncMiddleware(callback) {
     return asyncMiddleware(callback);
   }
-}
+
+  /**
+   * 
+   * @param {Request} req 
+   * @returns 
+   */
+  accepts(req) {
+    return accepts(req);
+  }
+}

server/src/api/controllers/FinancialStatements/CustomerBalanceSummary/index.ts

@@ -1,6 +1,7 @@
 import { Router, Request, Response, NextFunction } from 'express';
 import { query } from 'express-validator';
 import { Inject } from 'typedi';
+import { ICustomerBalanceSummaryStatement } from 'interfaces';
 import asyncMiddleware from 'api/middleware/asyncMiddleware';
 import CustomerBalanceSummary from 'services/FinancialStatements/CustomerBalanceSummary/CustomerBalanceSummaryService';
 import BaseFinancialReportController from '../BaseFinancialReportController';
@@ -38,35 +39,72 @@ export default class CustomerBalanceSummaryReportController extends BaseFinancia
   }
 
   /**
-   * Retrieve payable aging summary report.
-   * @param {Request} req - 
-   * @param {Response} res - 
-   * @param {NextFunction} next - 
+   * Transformes the balance summary statement to table rows.
+   * @param {ICustomerBalanceSummaryStatement} statement -
    */
-  async customerBalanceSummary(req: Request, res: Response, next: NextFunction) {
+  private transformToTableRows({
+    data,
+    columns,
+  }: ICustomerBalanceSummaryStatement) {
+    return {
+      table: {
+        rows: this.customerBalanceSummaryTableRows.tableRowsTransformer(data),
+        columns: this.transfromToResponse(columns),
+      },
+      query: this.transfromToResponse(query),
+    };
+  }
+
+  /**
+   * Transformes the balance summary statement to raw json.
+   * @param {ICustomerBalanceSummaryStatement} customerBalance -
+   */
+  private transformToJsonResponse({
+    data,
+    columns,
+    query,
+  }: ICustomerBalanceSummaryStatement) {
+    return {
+      data: this.transfromToResponse(data),
+      columns: this.transfromToResponse(columns),
+      query: this.transfromToResponse(query),
+    };
+  }
+
+  /**
+   * Retrieve payable aging summary report.
+   * @param {Request} req -
+   * @param {Response} res -
+   * @param {NextFunction} next -
+   */
+  async customerBalanceSummary(
+    req: Request,
+    res: Response,
+    next: NextFunction
+  ) {
     const { tenantId, settings } = req;
     const filter = this.matchedQueryData(req);
 
     try {
-      const {
-        data,
-        columns,
-        query,
-      } = await this.customerBalanceSummaryService.customerBalanceSummary(
+      const customerBalanceSummary = await this.customerBalanceSummaryService.customerBalanceSummary(
         tenantId,
         filter
       );
 
-      const tableRows = this.customerBalanceSummaryTableRows.tableRowsTransformer(
-        data
-      );
-      return res.status( 200).send({
-        table: {
-          rows: tableRows
-        },
-        columns: this.transfromToResponse(columns),
-        query: this.transfromToResponse(query),
-      });
+      const accept = this.accepts(req);
+      const acceptType = accept.types(['json', 'application/json+table']);
+
+      switch (acceptType) {
+        case 'application/json+table':
+          return res
+            .status(200)
+            .send(this.transformToTableRows(customerBalanceSummary));
+        case 'application/json':
+        default:
+          return res
+            .status(200)
+            .send(this.transformToJsonResponse(customerBalanceSummary));
+      }
     } catch (error) {
       next(error);
     }

server/src/api/controllers/FinancialStatements/TransactionsByCustomers/index.ts

@@ -1,6 +1,7 @@
 import { Router, Request, Response, NextFunction } from 'express';
 import { query } from 'express-validator';
 import { Inject } from 'typedi';
+import { ITransactionsByCustomersStatement } from 'interfaces';
 import asyncMiddleware from 'api/middleware/asyncMiddleware';
 import BaseFinancialReportController from '../BaseFinancialReportController';
 import TransactionsByCustomersService from 'services/FinancialStatements/TransactionsByCustomer/TransactionsByCustomersService';
@@ -40,6 +41,33 @@ export default class TransactionsByCustomersReportController extends BaseFinanci
     ];
   }
 
+  /**
+   * Transformes the statement to table rows response.
+   * @param {ITransactionsByCustomersStatement} statement -
+   */
+  transformToTableResponse({ data }: ITransactionsByCustomersStatement) {
+    return {
+      table: {
+        rows: this.transactionsByCustomersTableRows.tableRows(data),
+      },
+    };
+  }
+
+  /**
+   * Transformes the statement to json response.
+   * @param {ITransactionsByCustomersStatement} statement -
+   */
+  transfromToJsonResponse({
+    data,
+    columns,
+  }: ITransactionsByCustomersStatement) {
+    return {
+      data: this.transfromToResponse(data),
+      columns: this.transfromToResponse(columns),
+      query: this.transfromToResponse(query),
+    };
+  }
+
   /**
    * Retrieve payable aging summary report.
    * @param {Request} req -
@@ -55,26 +83,24 @@ export default class TransactionsByCustomersReportController extends BaseFinanci
     const filter = this.matchedQueryData(req);
 
     try {
-      const {
-        data,
-        columns,
-        query,
-      } = await this.transactionsByCustomersService.transactionsByCustomers(
+      const transactionsByCustomers = await this.transactionsByCustomersService.transactionsByCustomers(
         tenantId,
         filter
       );
+      const accept = this.accepts(req);
+      const acceptType = accept.types(['json', 'application/json+table']);
 
-      return res.status(200).send({
-        table: {
-          rows: this.transactionsByCustomersTableRows.tableRows(data),
-        },
-      });
-
-      return res.status(200).send({
-        data: this.transfromToResponse(data),
-        columns: this.transfromToResponse(columns),
-        query: this.transfromToResponse(query),
-      });
+      switch (acceptType) {
+        case 'json':
+          return res
+            .status(200)
+            .send(this.transfromToJsonResponse(transactionsByCustomers));
+        case 'application/json+table':
+        default:
+          return res
+            .status(200)
+            .send(this.transformToTableResponse(transactionsByCustomers));
+      }
     } catch (error) {
       next(error);
     }

server/src/api/controllers/FinancialStatements/TransactionsByVendors/index.ts

@@ -5,7 +5,7 @@ import asyncMiddleware from 'api/middleware/asyncMiddleware';
 import BaseFinancialReportController from '../BaseFinancialReportController';
 import TransactionsByVendorsTableRows from 'services/FinancialStatements/TransactionsByVendor/TransactionsByVendorTableRows';
 import TransactionsByVendorsService from 'services/FinancialStatements/TransactionsByVendor/TransactionsByVendorService';
-
+import { ITransactionsByVendorsStatement } from 'interfaces';
 export default class TransactionsByVendorsReportController extends BaseFinancialReportController {
   @Inject()
   transactionsByVendorsService: TransactionsByVendorsService;
@@ -40,41 +40,63 @@ export default class TransactionsByVendorsReportController extends BaseFinancial
     ];
   }
 
+  /**
+   * Transformes the report statement to table rows.
+   * @param {ITransactionsByVendorsStatement} statement -
+   */
+  transformToTableRows({ data }: ITransactionsByVendorsStatement) {
+    return {
+      table: {
+        data: this.transactionsByVendorsTableRows.tableRows(data),
+      },
+    };
+  }
+
+  /**
+   * Transformes the report statement to json response.
+   * @param {ITransactionsByVendorsStatement} statement -
+   */
+  transformToJsonResponse({
+    data,
+    columns,
+    query,
+  }: ITransactionsByVendorsStatement) {
+    return {
+      data: this.transfromToResponse(data),
+      columns: this.transfromToResponse(columns),
+      query: this.transfromToResponse(query),
+    };
+  }
+
   /**
    * Retrieve payable aging summary report.
    * @param {Request} req -
    * @param {Response} res -
    * @param {NextFunction} next -
    */
-  async transactionsByVendors(
-    req: Request,
-    res: Response,
-    next: NextFunction
-  ) {
+  async transactionsByVendors(req: Request, res: Response, next: NextFunction) {
     const { tenantId } = req;
     const filter = this.matchedQueryData(req);
 
     try {
-      const {
-        data,
-        columns,
-        query,
-      } = await this.transactionsByVendorsService.transactionsByVendors(
+      const transactionsByVendors = await this.transactionsByVendorsService.transactionsByVendors(
         tenantId,
         filter
       );
+      const accept = this.accepts(req);
+      const acceptType = accept.types(['json', 'application/json+table']);
 
-      return res.status(200).send({
-        table: {
-          rows: this.transactionsByVendorsTableRows.tableRows(data),
-        },
-      });
-
-      return res.status(200).send({
-        data: this.transfromToResponse(data),
-        columns: this.transfromToResponse(columns),
-        query: this.transfromToResponse(query),
-      });
+      switch (acceptType) {
+        case 'application/json+table':
+          return res
+            .status(200)
+            .send(this.transformToTableRows(transactionsByVendors));
+        case 'json':
+        default:
+          return res
+            .status(200)
+            .send(this.transformToJsonResponse(transactionsByVendors));
+      }
     } catch (error) {
       next(error);
     }

server/src/api/controllers/FinancialStatements/VendorBalanceSummary/index.ts

@@ -5,7 +5,7 @@ import asyncMiddleware from 'api/middleware/asyncMiddleware';
 import BaseFinancialReportController from '../BaseFinancialReportController';
 import VendorBalanceSummaryTableRows from 'services/FinancialStatements/VendorBalanceSummary/VendorBalanceSummaryTableRows';
 import VendorBalanceSummaryService from 'services/FinancialStatements/VendorBalanceSummary/VendorBalanceSummaryService';
-
+import { IVendorBalanceSummaryStatement } from 'interfaces';
 export default class VendorBalanceSummaryReportController extends BaseFinancialReportController {
   @Inject()
   vendorBalanceSummaryService: VendorBalanceSummaryService;
@@ -37,36 +37,61 @@ export default class VendorBalanceSummaryReportController extends BaseFinancialR
     ];
   }
 
+  /**
+   * Transformes the report statement to table rows.
+   * @param {IVendorBalanceSummaryStatement} statement -
+   */
+  transformToTableRows({ data }: IVendorBalanceSummaryStatement) {
+    return {
+      table: {
+        data: this.vendorBalanceSummaryTableRows.tableRowsTransformer(data),
+      },
+    };
+  }
+
+  /**
+   * Transformes the report statement to raw json.
+   * @param {IVendorBalanceSummaryStatement} statement -
+   */
+  transformToJsonResponse({ data, columns }: IVendorBalanceSummaryStatement) {
+    return {
+      data: this.transfromToResponse(data),
+      columns: this.transfromToResponse(columns),
+      query: this.transfromToResponse(query),
+    };
+  }
+
   /**
    * Retrieve vendors balance summary.
-   * @param {Request} req - 
-   * @param {Response} res - 
-   * @param {NextFunction} next - 
+   * @param {Request} req -
+   * @param {Response} res -
+   * @param {NextFunction} next -
    */
   async vendorBalanceSummary(req: Request, res: Response, next: NextFunction) {
     const { tenantId, settings } = req;
     const filter = this.matchedQueryData(req);
 
     try {
-      const {
-        data,
-        columns,
-        query,
-      } = await this.vendorBalanceSummaryService.vendorBalanceSummary(
+      const vendorBalanceSummary = await this.vendorBalanceSummaryService.vendorBalanceSummary(
         tenantId,
         filter
       );
+      const accept = this.accepts(req);
+      const acceptType = accept.types(['json', 'application/json+table']);
 
-      const tableRows = this.vendorBalanceSummaryTableRows.tableRowsTransformer(
-        data
-      );
-      return res.status( 200).send({
-        table: {
-          rows: tableRows
-        },
-        columns: this.transfromToResponse(columns),
-        query: this.transfromToResponse(query),
-      });
+      switch (acceptType) {
+        case 'application/json+table':
+          return res
+            .status(200)
+            .send(this.transformToTableRows(vendorBalanceSummary));
+        case 'json':
+        default:
+          return res
+            .status(200)
+            .send(this.transformToJsonResponse(vendorBalanceSummary));
+      }
+
+      return res.status(200).send({});
     } catch (error) {
       next(error);
     }