feat(server): financial reports meta

packages/server/src/services/FinancialStatements/GeneralLedger/GeneralLedgerMeta.ts

@@ -0,0 +1,33 @@
+import { IGeneralLedgerMeta, IGeneralLedgerSheetQuery } from '@/interfaces';
+import moment from 'moment';
+import { Inject, Service } from 'typedi';
+import { FinancialSheetMeta } from '../FinancialSheetMeta';
+
+@Service()
+export class GeneralLedgerMeta {
+  @Inject()
+  private financialSheetMeta: FinancialSheetMeta;
+
+  /**
+   * Retrieve the balance sheet meta.
+   * @param {number} tenantId -
+   * @returns {IBalanceSheetMeta}
+   */
+  public async meta(
+    tenantId: number,
+    query: IGeneralLedgerSheetQuery
+  ): Promise<IGeneralLedgerMeta> {
+    const commonMeta = await this.financialSheetMeta.meta(tenantId);
+    const formattedToDate = moment(query.toDate).format('YYYY/MM/DD');
+    const formattedFromDate = moment(query.fromDate).format('YYYY/MM/DD');
+    const formattedDateRange = `From ${formattedFromDate} | To ${formattedToDate}`;
+
+    return {
+      ...commonMeta,
+      sheetName: 'Balance Sheet',
+      formattedFromDate,
+      formattedToDate,
+      formattedDateRange,
+    };
+  }
+}

packages/server/src/services/FinancialStatements/GeneralLedger/GeneralLedgerPdf.ts

@@ -1,7 +1,7 @@
-import { Inject, Service } from "typedi";
-import { TableSheetPdf } from "../TableSheetPdf";
-import { GeneralLedgerTableInjectable } from "./GeneralLedgerTableInjectable";
-import { IGeneralLedgerSheetQuery } from "@/interfaces";
+import { Inject, Service } from 'typedi';
+import { TableSheetPdf } from '../TableSheetPdf';
+import { GeneralLedgerTableInjectable } from './GeneralLedgerTableInjectable';
+import { IGeneralLedgerSheetQuery } from '@/interfaces';
 
 @Service()
 export class GeneralLedgerPdf {
@@ -14,7 +14,7 @@ export class GeneralLedgerPdf {
   /**
    * Converts the general ledger sheet table to pdf.
    * @param {number} tenantId - Tenant ID.
-   * @param {IGeneralLedgerSheetQuery} query - 
+   * @param {IGeneralLedgerSheetQuery} query -
    * @returns {Promise<Buffer>}
    */
   public async pdf(
@@ -22,13 +22,12 @@ export class GeneralLedgerPdf {
     query: IGeneralLedgerSheetQuery
   ): Promise<Buffer> {
     const table = await this.generalLedgerTable.table(tenantId, query);
-    const sheetName = 'General Ledger';
 
     return this.tableSheetPdf.convertToPdf(
       tenantId,
       table.table,
-      sheetName,
-      table.meta.baseCurrency
+      table.meta.sheetName,
+      table.meta.formattedDateRange
     );
   }
-}
+}

packages/server/src/services/FinancialStatements/GeneralLedger/GeneralLedgerService.ts

@@ -6,9 +6,9 @@ import { IGeneralLedgerSheetQuery, IGeneralLedgerMeta } from '@/interfaces';
 import TenancyService from '@/services/Tenancy/TenancyService';
 import Journal from '@/services/Accounting/JournalPoster';
 import GeneralLedgerSheet from '@/services/FinancialStatements/GeneralLedger/GeneralLedger';
-import InventoryService from '@/services/Inventory/Inventory';
-import { transformToMap, parseBoolean } from 'utils';
+import { transformToMap } from 'utils';
 import { Tenant } from '@/system/models';
+import { GeneralLedgerMeta } from './GeneralLedgerMeta';
 
 const ERRORS = {
   ACCOUNTS_NOT_FOUND: 'ACCOUNTS_NOT_FOUND',
@@ -17,13 +17,10 @@ const ERRORS = {
 @Service()
 export class GeneralLedgerService {
   @Inject()
-  tenancy: TenancyService;
+  private tenancy: TenancyService;
 
   @Inject()
-  inventoryService: InventoryService;
-
-  @Inject('logger')
-  logger: any;
+  private generalLedgerMeta: GeneralLedgerMeta;
 
   /**
    * Defaults general ledger report filter query.
@@ -59,40 +56,8 @@ export class GeneralLedgerService {
     }
   }
 
-  /**
-   * Retrieve the balance sheet meta.
-   * @param {number} tenantId - 
-   * @returns {IGeneralLedgerMeta}
-   */
-   reportMetadata(tenantId: number, filter): IGeneralLedgerMeta {
-    const settings = this.tenancy.settings(tenantId);
-
-    const isCostComputeRunning = this.inventoryService
-      .isItemsCostComputeRunning(tenantId);
-
-    const organizationName = settings.get({
-      group: 'organization',
-      key: 'name',
-    });
-    const baseCurrency = settings.get({
-      group: 'organization',
-      key: 'base_currency',
-    });
-    const fromDate = moment(filter.fromDate).format('YYYY MMM DD');
-    const toDate = moment(filter.toDate).format('YYYY MMM DD');
-
-    return {
-      isCostComputeRunning: parseBoolean(isCostComputeRunning, false),
-      organizationName,
-      baseCurrency,
-      fromDate,
-      toDate
-    };
-  }
-
   /**
    * Retrieve general ledger report statement.
-   * ----------
    * @param {number} tenantId
    * @param {IGeneralLedgerSheetQuery} query
    * @return {IGeneralLedgerStatement}
@@ -103,13 +68,10 @@ export class GeneralLedgerService {
   ): Promise<{
     data: any;
     query: IGeneralLedgerSheetQuery;
-    meta: IGeneralLedgerMeta
+    meta: IGeneralLedgerMeta;
   }> {
-    const {
-      accountRepository,
-      transactionsRepository,
-      contactRepository
-    } = this.tenancy.repositories(tenantId);
+    const { accountRepository, transactionsRepository, contactRepository } =
+      this.tenancy.repositories(tenantId);
 
     const i18n = this.tenancy.i18n(tenantId);
 
@@ -133,13 +95,13 @@ export class GeneralLedgerService {
     const transactions = await transactionsRepository.journal({
       fromDate: filter.fromDate,
       toDate: filter.toDate,
-      branchesIds: filter.branchesIds
+      branchesIds: filter.branchesIds,
     });
     // Retreive opening balance credit/debit sumation.
     const openingBalanceTrans = await transactionsRepository.journal({
       toDate: moment(filter.fromDate).subtract(1, 'day'),
       sumationCreditDebit: true,
-      branchesIds: filter.branchesIds
+      branchesIds: filter.branchesIds,
     });
     // Transform array transactions to journal collection.
     const transactionsJournal = Journal.fromTransactions(
@@ -147,7 +109,7 @@ export class GeneralLedgerService {
       tenantId,
       accountsGraph
     );
-    // Accounts opening transactions. 
+    // Accounts opening transactions.
     const openingTransJournal = Journal.fromTransactions(
       openingBalanceTrans,
       tenantId,
@@ -167,10 +129,13 @@ export class GeneralLedgerService {
     // Retrieve general ledger report data.
     const reportData = generalLedgerInstance.reportData();
 
+    // Retrieve general ledger report metadata.
+    const meta = await this.generalLedgerMeta.meta(tenantId, filter);
+
     return {
       data: reportData,
       query: filter,
-      meta: this.reportMetadata(tenantId, filter),
+      meta,
     };
   }
 }