feat: Inventory item details report.

feat: Cash flow statement report.
2026-02-18 13:50:31 +00:00 · 2021-05-31 13:17:02 +02:00
parent 256d915f06
commit d47633b8ea
80 changed files with 5474 additions and 376 deletions
--- a/server/src/api/controllers/FinancialStatements/CashFlow/CashFlow.ts
+++ b/server/src/api/controllers/FinancialStatements/CashFlow/CashFlow.ts
@@ -0,0 +1,113 @@
+import { Inject, Service } from 'typedi';
+import { query } from 'express-validator';
+import {
+  NextFunction,
+  Router,
+  Request,
+  Response,
+  ValidationChain,
+} from 'express';
+import BaseFinancialReportController from '../BaseFinancialReportController';
+import CashFlowStatementService from 'services/FinancialStatements/CashFlow/CashFlowService';
+import { ICashFlowStatement } from 'interfaces';
+import CashFlowTable from 'services/FinancialStatements/CashFlow/CashFlowTable';
+
+@Service()
+export default class CashFlowController extends BaseFinancialReportController {
+  @Inject()
+  cashFlowService: CashFlowStatementService;
+
+  /**
+   * Router constructor.
+   */
+  router() {
+    const router = Router();
+
+    router.get(
+      '/',
+      this.cashflowValidationSchema,
+      this.validationResult,
+      this.asyncMiddleware(this.cashFlow.bind(this))
+    );
+    return router;
+  }
+
+  /**
+   * Balance sheet validation schecma.
+   * @returns {ValidationChain[]}
+   */
+  get cashflowValidationSchema(): ValidationChain[] {
+    return [
+      ...this.sheetNumberFormatValidationSchema,
+      query('from_date').optional(),
+      query('to_date').optional(),
+      query('display_columns_type').optional().isIn(['date_periods', 'total']),
+      query('display_columns_by')
+        .optional({ nullable: true, checkFalsy: true })
+        .isIn(['year', 'month', 'week', 'day', 'quarter']),
+      query('none_zero').optional().isBoolean().toBoolean(),
+      query('none_transactions').optional().isBoolean().toBoolean(),
+    ];
+  }
+
+  /**
+   * Retrieve the cashflow statment to json response.
+   * @param {ICashFlowStatement} cashFlow -
+   */
+  private transformJsonResponse(cashFlow: ICashFlowStatement) {
+    const { data, query } = cashFlow;
+
+    return {
+      data: this.transfromToResponse(data),
+      meta: this.transfromToResponse(query),
+    };
+  }
+
+  /**
+   * Transformes the report statement to table rows.
+   * @param {ITransactionsByVendorsStatement} statement -
+   *
+   */
+  private transformToTableRows(cashFlow: ICashFlowStatement) {
+    const cashFlowTable = new CashFlowTable(cashFlow);
+
+    return {
+      table: {
+        data: cashFlowTable.tableRows(),
+        columns: cashFlowTable.tableColumns(),
+      },
+      meta: this.transfromToResponse(cashFlow.query),
+    };
+  }
+
+  /**
+   * Retrieve the cash flow statment.
+   * @param {Request} req
+   * @param {Response} res
+   * @param {NextFunction} next
+   * @returns {Response}
+   */
+  async cashFlow(req: Request, res: Response, next: NextFunction) {
+    const { tenantId, settings } = req;
+    const filter = {
+      ...this.matchedQueryData(req),
+    };
+
+    try {
+      const cashFlow = await this.cashFlowService.cashFlow(tenantId, filter);
+
+      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(cashFlow));
+        case 'json':
+        default:
+          return res.status(200).send(this.transformJsonResponse(cashFlow));
+      }
+    } catch (error) {
+      next(error);
+    }
+  }
+}
--- a/server/src/api/controllers/FinancialStatements/InventoryDetails/index.ts
+++ b/server/src/api/controllers/FinancialStatements/InventoryDetails/index.ts
@@ -0,0 +1,120 @@
+import { Inject, Service } from 'typedi';
+import { query } from 'express-validator';
+import {
+  NextFunction,
+  Router,
+  Request,
+  Response,
+  ValidationChain,
+} from 'express';
+import BaseController from 'api/controllers/BaseController';
+import InventoryDetailsService from 'services/FinancialStatements/InventoryDetails/InventoryDetailsService';
+import InventoryDetailsTable from 'services/FinancialStatements/InventoryDetails/InventoryDetailsTable';
+
+@Service()
+export default class InventoryDetailsController extends BaseController {
+  @Inject()
+  inventoryDetailsService: InventoryDetailsService;
+
+  /**
+   * Router constructor.
+   */
+  router() {
+    const router = Router();
+
+    router.get(
+      '/',
+      this.validationSchema,
+      this.validationResult,
+      this.asyncMiddleware(this.inventoryDetails.bind(this))
+    );
+    return router;
+  }
+
+  /**
+   * Balance sheet validation schecma.
+   * @returns {ValidationChain[]}
+   */
+  get validationSchema(): ValidationChain[] {
+    return [
+      query('number_format.precision')
+        .optional()
+        .isInt({ min: 0, max: 5 })
+        .toInt(),
+      query('number_format.divide_on_1000').optional().isBoolean().toBoolean(),
+      query('number_format.negative_format')
+        .optional()
+        .isIn(['parentheses', 'mines'])
+        .trim()
+        .escape(),
+      query('from_date').optional(),
+      query('to_date').optional(),
+      query('none_zero').optional().isBoolean().toBoolean(),
+      query('none_transactions').optional().isBoolean().toBoolean(),
+    ];
+  }
+
+  /**
+   * Retrieve the cashflow statment to json response.
+   * @param {ICashFlowStatement} cashFlow -
+   */
+  private transformJsonResponse(inventoryDetails) {
+    const { data, query } = inventoryDetails;
+
+    return {
+      data: this.transfromToResponse(data),
+      meta: this.transfromToResponse(query),
+    };
+  }
+
+  /**
+   * Transformes the report statement to table rows.
+   */
+  private transformToTableRows(inventoryDetails) {
+    const inventoryDetailsTable = new InventoryDetailsTable(inventoryDetails);
+
+    return {
+      table: {
+        data: inventoryDetailsTable.tableData(),
+        columns: inventoryDetailsTable.tableColumns(),
+      },
+      meta: this.transfromToResponse(inventoryDetails.query),
+    };
+  }
+
+  /**
+   * Retrieve the cash flow statment.
+   * @param {Request} req
+   * @param {Response} res
+   * @param {NextFunction} next
+   * @returns {Response}
+   */
+  async inventoryDetails(req: Request, res: Response, next: NextFunction) {
+    const { tenantId, settings } = req;
+    const filter = {
+      ...this.matchedQueryData(req),
+    };
+
+    try {
+      const inventoryDetails =
+        await this.inventoryDetailsService.inventoryDetails(tenantId, filter);
+
+      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(inventoryDetails));
+        case 'json':
+        default:
+          return res
+            .status(200)
+            .send(this.transformJsonResponse(inventoryDetails));
+      }
+    } catch (error) {
+      next(error);
+    }
+  }
+}