refactor: financial reports to nestjs

temp/BalanceSheet/BalanceSheetFiltering.ts

@@ -0,0 +1,173 @@
+import * as R from 'ramda';
+import { get } from 'lodash';
+import {
+  IBalanceSheetDataNode,
+  BALANCE_SHEET_NODE_TYPE,
+} from './BalanceSheet.types';
+import { Constructor } from '@/common/types/Constructor';
+import { FinancialFilter } from '../../common/FinancialFilter';
+import { BalanceSheetBase } from './BalanceSheetBase';
+import { BalanceSheetRepository } from './BalanceSheetRepository';
+import { BalanceSheetQuery } from './BalanceSheetQuery';
+
+export const BalanceSheetFiltering = <T extends Constructor>(Base: T) =>
+  class extends R.pipe(FinancialFilter, BalanceSheetBase)(Base) {
+    public repository: BalanceSheetRepository;
+
+    // -----------------------
+    // # Account
+    // -----------------------
+    /**
+     * Filter report node detarmine.
+     * @param  {IBalanceSheetDataNode} node - Balance sheet node.
+     * @return {boolean}
+     */
+    private accountNoneZeroNodesFilterDetarminer = (
+      node: IBalanceSheetDataNode,
+    ): boolean => {
+      return R.ifElse(
+        this.isNodeType(BALANCE_SHEET_NODE_TYPE.ACCOUNT),
+        this.isNodeNoneZero,
+        R.always(true),
+      )(node);
+    };
+
+    /**
+     * Detarmines account none-transactions node.
+     * @param   {IBalanceSheetDataNode} node
+     * @returns {boolean}
+     */
+    private accountNoneTransFilterDetarminer = (
+      node: IBalanceSheetDataNode,
+    ): boolean => {
+      return R.ifElse(
+        this.isNodeType(BALANCE_SHEET_NODE_TYPE.ACCOUNT),
+        this.isNodeNoneZero,
+        R.always(true),
+      )(node);
+    };
+
+    /**
+     * Report nodes filter.
+     * @param  {IBalanceSheetSection[]} nodes -
+     * @return {IBalanceSheetSection[]}
+     */
+    private accountsNoneZeroNodesFilter = (
+      nodes: IBalanceSheetDataNode[],
+    ): IBalanceSheetDataNode[] => {
+      return this.filterNodesDeep(
+        nodes,
+        this.accountNoneZeroNodesFilterDetarminer,
+      );
+    };
+
+    /**
+     * Filters the accounts none-transactions nodes.
+     * @param   {IBalanceSheetDataNode[]} nodes
+     * @returns {IBalanceSheetDataNode[]}
+     */
+    private accountsNoneTransactionsNodesFilter = (
+      nodes: IBalanceSheetDataNode[],
+    ) => {
+      return this.filterNodesDeep(nodes, this.accountNoneTransFilterDetarminer);
+    };
+
+    // -----------------------
+    // # Aggregate/Accounts.
+    // -----------------------
+    /**
+     * Detearmines aggregate none-children filtering.
+     * @param   {IBalanceSheetDataNode} node
+     * @returns {boolean}
+     */
+    private aggregateNoneChildrenFilterDetarminer = (
+      node: IBalanceSheetDataNode,
+    ): boolean => {
+      // Detarmines whether the given node is aggregate or accounts node.
+      const isAggregateOrAccounts =
+        this.isNodeType(BALANCE_SHEET_NODE_TYPE.AGGREGATE, node) ||
+        this.isNodeType(BALANCE_SHEET_NODE_TYPE.ACCOUNTS, node);
+
+      // Retrieve the schema node of the given id.
+      const schemaNode = this.getSchemaNodeById(node.id);
+
+      // Detarmines if the schema node is always should show.
+      const isSchemaAlwaysShow = get(schemaNode, 'alwaysShow', false);
+
+      return isAggregateOrAccounts && !isSchemaAlwaysShow
+        ? this.isNodeHasChildren(node)
+        : true;
+    };
+
+    /**
+     * Filters aggregate none-children nodes.
+     * @param   {IBalanceSheetDataNode[]} nodes
+     * @returns {IBalanceSheetDataNode[]}
+     */
+    private aggregateNoneChildrenFilter = (
+      nodes: IBalanceSheetDataNode[],
+    ): IBalanceSheetDataNode[] => {
+      return this.filterNodesDeep2(
+        this.aggregateNoneChildrenFilterDetarminer,
+        nodes,
+      );
+    };
+
+    // -----------------------
+    // # Composers.
+    // -----------------------
+    /**
+     * Filters none-zero nodes.
+     * @param   {IBalanceSheetDataNode[]} nodes
+     * @returns {IBalanceSheetDataNode[]}
+     */
+    private filterNoneZeroNodesCompose = (
+      nodes: IBalanceSheetDataNode[],
+    ): IBalanceSheetDataNode[] => {
+      return R.compose(
+        this.aggregateNoneChildrenFilter,
+        this.accountsNoneZeroNodesFilter,
+      )(nodes);
+    };
+
+    /**
+     * Filters none-transactions nodes.
+     * @param   {IBalanceSheetDataNode[]} nodes
+     * @returns {IBalanceSheetDataNode[]}
+     */
+    private filterNoneTransNodesCompose = (
+      nodes: IBalanceSheetDataNode[],
+    ): IBalanceSheetDataNode[] => {
+      return R.compose(
+        this.aggregateNoneChildrenFilter,
+        this.accountsNoneTransactionsNodesFilter,
+      )(nodes);
+    };
+
+    /**
+     * Supress nodes when accounts transactions ledger is empty.
+     * @param   {IBalanceSheetDataNode[]} nodes
+     * @returns {IBalanceSheetDataNode[]}
+     */
+    private supressNodesWhenAccountsTransactionsEmpty = (
+      nodes: IBalanceSheetDataNode[],
+    ): IBalanceSheetDataNode[] => {
+      return this.repository.totalAccountsLedger.isEmpty() ? [] : nodes;
+    };
+
+    /**
+     * Compose report nodes filtering.
+     * @param   {IBalanceSheetDataNode[]} nodes
+     * @returns {IBalanceSheetDataNode[]}
+     */
+    protected reportFilterPlugin = (nodes: IBalanceSheetDataNode[]) => {
+      return R.compose(
+        this.supressNodesWhenAccountsTransactionsEmpty,
+        R.when(R.always(this.query.noneZero), this.filterNoneZeroNodesCompose),
+        R.when(
+          R.always(this.query.noneTransactions),
+          this.filterNoneTransNodesCompose,
+        ),
+      )(nodes);
+    };
+  };