refactor: banking services to Nestjs

packages/server-nest/src/modules/BankingTransactions/utils.ts

@@ -0,0 +1,124 @@
+import { upperFirst, camelCase, first, sumBy, isObject } from 'lodash';
+import {
+  CASHFLOW_TRANSACTION_TYPE,
+  CASHFLOW_TRANSACTION_TYPE_META,
+  CashflowTransactionTypes,
+  ERRORS,
+  ICashflowTransactionTypeMeta,
+  TransactionTypes,
+} from './constants';
+import { ICashflowNewCommandDTO } from './types/BankingTransactions.types';
+import { UncategorizedBankTransaction } from './models/UncategorizedBankTransaction';
+import { ServiceError } from '../Items/ServiceError';
+
+/**
+ * Ensures the given transaction type to transformed to appropriate format.
+ * @param {string} type
+ * @returns {string}
+ */
+export const transformCashflowTransactionType = (type) => {
+  return upperFirst(camelCase(type));
+};
+
+/**
+ * Retrieve the cashflow transaction type meta.
+ * @param {CASHFLOW_TRANSACTION_TYPE} transactionType
+ * @returns {ICashflowTransactionTypeMeta}
+ */
+export function getCashflowTransactionType(
+  transactionType: CASHFLOW_TRANSACTION_TYPE,
+): ICashflowTransactionTypeMeta {
+  const _transactionType = transformCashflowTransactionType(transactionType);
+
+  return CASHFLOW_TRANSACTION_TYPE_META[_transactionType];
+}
+
+/**
+ * Retrieve cashflow accounts transactions types
+ * @returns {string}
+ */
+export const getCashflowAccountTransactionsTypes = () => {
+  return Object.values(CASHFLOW_TRANSACTION_TYPE_META).map((meta) => meta.type);
+};
+
+/**
+ * Tranasformes the given uncategorized transaction and categorized DTO
+ * to cashflow create DTO.
+ * @param {IUncategorizedCashflowTransaction} uncategorizeModel
+ * @param {ICategorizeCashflowTransactioDTO} categorizeDTO
+ * @returns {ICashflowNewCommandDTO}
+ */
+export const transformCategorizeTransToCashflow = (
+  uncategorizeTransactions: Array<UncategorizedBankTransaction>,
+  categorizeDTO: ICategorizeBankTransactionDTO,
+): ICashflowNewCommandDTO => {
+  const uncategorizeTransaction = first(uncategorizeTransactions);
+  const amount = sumBy(uncategorizeTransactions, 'amount');
+  const amountAbs = Math.abs(amount);
+
+  return {
+    date: categorizeDTO.date,
+    referenceNo: categorizeDTO.referenceNo,
+    description: categorizeDTO.description,
+    cashflowAccountId: uncategorizeTransaction.accountId,
+    creditAccountId: categorizeDTO.creditAccountId,
+    exchangeRate: categorizeDTO.exchangeRate || 1,
+    currencyCode: categorizeDTO.currencyCode,
+    amount: amountAbs,
+    transactionNumber: categorizeDTO.transactionNumber,
+    transactionType: categorizeDTO.transactionType,
+    branchId: categorizeDTO?.branchId,
+    publish: true,
+  };
+};
+
+export const validateUncategorizedTransactionsNotExcluded = (
+  transactions: Array<UncategorizedBankTransaction>,
+) => {
+  const excluded = transactions.filter((tran) => tran.isExcluded);
+
+  if (excluded?.length > 0) {
+    throw new ServiceError(ERRORS.CANNOT_CATEGORIZE_EXCLUDED_TRANSACTION, '', {
+      ids: excluded.map((t) => t.id),
+    });
+  }
+};
+
+export const validateTransactionShouldBeCategorized = (
+  uncategorizedTransaction: any,
+) => {
+  if (!uncategorizedTransaction.categorized) {
+    throw new ServiceError(ERRORS.TRANSACTION_NOT_CATEGORIZED);
+  }
+};
+
+/**
+ * Retrieves the formatted type of account transaction.
+ * @param {string} referenceType
+ * @param {string} transactionType
+ * @returns {string}
+ */
+export const getTransactionTypeLabel = (
+  referenceType: string,
+  transactionType?: string,
+) => {
+  const _referenceType = upperFirst(camelCase(referenceType));
+  const _transactionType = upperFirst(camelCase(transactionType));
+
+  return isObject(TransactionTypes[_referenceType])
+    ? TransactionTypes[_referenceType][_transactionType]
+    : TransactionTypes[_referenceType] || null;
+};
+
+/**
+ * Retrieves the formatted type of cashflow transaction.
+ * @param {string} transactionType
+ * @returns {string¿}
+ */
+export const getCashflowTransactionFormattedType = (
+  transactionType: string,
+) => {
+  const _transactionType = upperFirst(camelCase(transactionType));
+
+  return CashflowTransactionTypes[_transactionType] || null;
+};