feat: Computed Net Income under Equity in Balance Sheet report. (#271)

packages/server/src/services/FinancialStatements/BalanceSheet/BalanceSheetNetIncomePP.ts

@@ -0,0 +1,74 @@
+import * as R from 'ramda';
+import {
+  IBalanceSheetDataNode,
+  IBalanceSheetNetIncomeNode,
+} from '@/interfaces';
+import { BalanceSheetComparsionPreviousPeriod } from './BalanceSheetComparsionPreviousPeriod';
+import { FinancialPreviousPeriod } from '../FinancialPreviousPeriod';
+import { FinancialHorizTotals } from '../FinancialHorizTotals';
+import BalanceSheetRepository from './BalanceSheetRepository';
+import { BalanceSheetQuery } from './BalanceSheetQuery';
+import { BalanceSheetNetIncomeDatePeriodsPP } from './BalanceSheetNetIncomeDatePeriodsPP';
+
+export const BalanceSheetNetIncomePP = (Base: any) =>
+  class extends R.compose(
+    BalanceSheetNetIncomeDatePeriodsPP,
+    BalanceSheetComparsionPreviousPeriod,
+    FinancialPreviousPeriod,
+    FinancialHorizTotals
+  )(Base) {
+    private repository: BalanceSheetRepository;
+    private query: BalanceSheetQuery;
+
+    // -------------------------------
+    // # Previous Period (PP)
+    // -------------------------------
+    /**
+     * Retrieves the PP net income.
+     * @returns {}
+     */
+    protected getPreviousPeriodNetIncome = () => {
+      const income = this.repository.incomePPAccountsLedger.getClosingBalance();
+      const expense =
+        this.repository.expensePPAccountsLedger.getClosingBalance();
+
+      return income - expense;
+    };
+
+    /**
+     * Associates the previous period to account node.
+     * @param {IBalanceSheetDataNode} node
+     * @returns {IBalanceSheetDataNode}
+     */
+    protected assocPreviousPeriodNetIncomeNode = (
+      node: IBalanceSheetDataNode
+    ): IBalanceSheetDataNode => {
+      const total = this.getPreviousPeriodNetIncome();
+
+      return R.assoc('previousPeriod', this.getAmountMeta(total), node);
+    };
+
+    /**
+     * Previous period account node composer.
+     * @param {IBalanceSheetNetIncomeNode} node
+     * @returns {IBalanceSheetNetIncomeNode}
+     */
+    protected previousPeriodNetIncomeNodeCompose = (
+      node: IBalanceSheetNetIncomeNode
+    ): IBalanceSheetNetIncomeNode => {
+      return R.compose(
+        R.when(
+          this.isNodeHasHorizTotals,
+          this.assocPreviousPeriodNetIncomeHorizNode
+        ),
+        R.when(
+          this.query.isPreviousPeriodPercentageActive,
+          this.assocPreviousPeriodPercentageNode
+        ),
+        R.when(
+          this.query.isPreviousPeriodChangeActive,
+          this.assocPreviousPeriodChangeNode
+        ),
+        this.assocPreviousPeriodNetIncomeNode
+      )(node);
+    };