refactoring: balance sheet report.

refactoring: trial balance sheet report.
refactoring: general ledger report.
refactoring: journal report.
refactoring: P&L report.

server/src/services/FinancialStatements/JournalSheet/JournalSheet.ts

@@ -0,0 +1,88 @@
+import { sumBy, chain } from 'lodash';
+import {
+  IJournalEntry,
+  IJournalPoster,
+  IJournalReportEntriesGroup,
+  IJournalReportQuery,
+  IJournalReport
+} from "interfaces";
+import FinancialSheet from "../FinancialSheet";
+
+export default class JournalSheet extends FinancialSheet {
+  tenantId: number;
+  journal: IJournalPoster;
+  query: IJournalReportQuery;
+  baseCurrency: string;
+
+  /**
+   * Constructor method.
+   * @param {number} tenantId 
+   * @param {IJournalPoster} journal 
+   */
+  constructor(
+    tenantId: number,
+    query: IJournalReportQuery,
+    journal: IJournalPoster,
+    baseCurrency: string,
+  ) {
+    super();
+
+    this.tenantId = tenantId;
+    this.journal = journal;
+    this.query = query;
+    this.numberFormat = this.query.numberFormat;
+    this.baseCurrency = baseCurrency;
+  }
+
+  /**
+   * Mapping journal entries groups.
+   * @param {IJournalEntry[]} entriesGroup -
+   * @param {string} key -
+   * @return {IJournalReportEntriesGroup}
+   */
+  entriesGroupMapper(
+    entriesGroup: IJournalEntry[],
+    key: string,
+  ): IJournalReportEntriesGroup {
+    const totalCredit = sumBy(entriesGroup, 'credit');
+    const totalDebit = sumBy(entriesGroup, 'debit');
+
+    return {
+      id: key,
+      entries: entriesGroup,
+      
+      currencyCode: this.baseCurrency,
+
+      credit: totalCredit,
+      debit: totalDebit,
+
+      formattedCredit: this.formatNumber(totalCredit),
+      formattedDebit: this.formatNumber(totalDebit),
+    };
+  }
+
+  /**
+   * Mapping the journal entries to entries groups.
+   * @param {IJournalEntry[]} entries 
+   * @return {IJournalReportEntriesGroup[]}
+   */
+  entriesWalker(entries: IJournalEntry[]): IJournalReportEntriesGroup[] {
+    return chain(entries)
+      .groupBy((entry) => `${entry.referenceId}-${entry.referenceType}`)
+      .map((
+        entriesGroup: IJournalEntry[],
+        key: string
+      ) => this.entriesGroupMapper(entriesGroup, key))
+      .value();
+  }
+
+  /**
+   * Retrieve journal report.
+   * @return {IJournalReport}
+   */
+  reportData(): IJournalReport {
+    return {
+      entries: this.entriesWalker(this.journal.entries),
+    };
+  }
+}

server/src/services/FinancialStatements/JournalSheet/JournalSheetService.ts

@@ -0,0 +1,85 @@
+import { Service, Inject } from "typedi";
+import { IJournalReportQuery } from 'interfaces';
+import moment from 'moment';
+import JournalSheet from "./JournalSheet";
+import TenancyService from "services/Tenancy/TenancyService";
+import Journal from "services/Accounting/JournalPoster";
+
+@Service()
+export default class JournalSheetService  {
+  @Inject()
+  tenancy: TenancyService;
+
+  @Inject('logger')
+  logger: any;
+
+  /**
+   * Default journal sheet filter queyr.
+   */
+  get defaultQuery() {
+    return {
+      fromDate: moment().startOf('year').format('YYYY-MM-DD'),
+      toDate: moment().endOf('year').format('YYYY-MM-DD'),
+      fromRange: null,
+      toRange: null,
+      accountsIds: [],
+      transactionTypes: [],
+      numberFormat: {
+        noCents: false,
+        divideOn1000: false,
+      },
+    };
+  }
+
+  /**
+   * Journal sheet.
+   * @param {number} tenantId 
+   * @param {IJournalSheetFilterQuery} query 
+   */
+  async journalSheet(
+    tenantId: number,
+    query: IJournalReportQuery,
+  ) {
+    const {
+      accountRepository,
+      transactionsRepository,
+    } = this.tenancy.repositories(tenantId);
+
+    const filter = {
+      ...this.defaultQuery,
+      ...query,
+    };
+    this.logger.info('[journal] trying to calculate the report.', { tenantId, filter });
+
+    // Settings service.
+    const settings = this.tenancy.settings(tenantId);
+    const baseCurrency = settings.get({ group: 'organization', key: 'base_currency' });
+
+    // Retrieve all accounts on the storage.
+    const accountsGraph = await accountRepository.getDependencyGraph();
+
+    // Retrieve all journal transactions based on the given query.
+    const transactions = await transactionsRepository.journal({
+      fromDate: filter.fromDate,
+      toDate: filter.toDate,
+      transactionsTypes: filter.transactionTypes,
+      fromAmount: filter.fromRange,
+      toAmount: filter.toRange,
+    });
+
+    // Transform the transactions array to journal collection.
+    const transactionsJournal = Journal.fromTransactions(transactions, tenantId, accountsGraph);
+
+    // Journal report instance.
+    const journalSheetInstance = new JournalSheet(
+      tenantId,
+      filter,
+      transactionsJournal,
+      baseCurrency
+    );
+    // Retrieve journal report columns.
+    const journalSheetData = journalSheetInstance.reportData();
+
+    return journalSheetData;
+  }
+}