feat(server): financial reports meta

packages/server/src/services/FinancialStatements/SalesByItems/SalesByItems.ts

@@ -1,4 +1,5 @@
 import { get, sumBy } from 'lodash';
+
 import * as R from 'ramda';
 import FinancialSheet from '../FinancialSheet';
 import { allPassedConditionsPass, transformToMap } from 'utils';

packages/server/src/services/FinancialStatements/SalesByItems/SalesByItemsApplication.ts

@@ -1,4 +1,5 @@
 import { Inject, Service } from 'typedi';
+
 import {
   ISalesByItemsReportQuery,
   ISalesByItemsSheet,

packages/server/src/services/FinancialStatements/SalesByItems/SalesByItemsMeta.ts

@@ -0,0 +1,33 @@
+import moment from 'moment';
+import { Inject, Service } from 'typedi';
+import { FinancialSheetMeta } from '../FinancialSheetMeta';
+import { ISalesByItemsReportQuery, ISalesByItemsSheetMeta } from '@/interfaces';
+
+@Service()
+export class SalesByItemsMeta {
+  @Inject()
+  private financialSheetMeta: FinancialSheetMeta;
+
+  /**
+   * Retrieve the sales by items meta.
+   * @param {number} tenantId -
+   * @returns {IBalanceSheetMeta}
+   */
+  public async meta(
+    tenantId: number,
+    query: ISalesByItemsReportQuery
+  ): Promise<ISalesByItemsSheetMeta> {
+    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: 'Purchases By Items',
+      formattedFromDate,
+      formattedToDate,
+      formattedDateRange,
+    };
+  }
+}

packages/server/src/services/FinancialStatements/SalesByItems/SalesByItemsPdfInjectable.ts

@@ -22,13 +22,12 @@ export class SalesByItemsPdfInjectable {
     query: ISalesByItemsReportQuery
   ): Promise<Buffer> {
     const table = await this.salesByItemsTable.table(tenantId, query);
-    const sheetName = 'Sales By Items';
 
     return this.tableSheetPdf.convertToPdf(
       tenantId,
       table.table,
-      sheetName,
-      table.meta.baseCurrency
+      table.meta.sheetName,
+      table.meta.formattedDateRange
     );
   }
 }

packages/server/src/services/FinancialStatements/SalesByItems/SalesByItemsService.ts

@@ -1,27 +1,24 @@
 import { Service, Inject } from 'typedi';
 import moment from 'moment';
-import {
-  ISalesByItemsReportQuery,
-  ISalesByItemsSheetMeta,
-  ISalesByItemsSheet,
-} from '@/interfaces';
+import { ISalesByItemsReportQuery, ISalesByItemsSheet } from '@/interfaces';
 import TenancyService from '@/services/Tenancy/TenancyService';
 import SalesByItems from './SalesByItems';
 import { Tenant } from '@/system/models';
+import { SalesByItemsMeta } from './SalesByItemsMeta';
 
 @Service()
 export class SalesByItemsReportService {
   @Inject()
-  tenancy: TenancyService;
+  private tenancy: TenancyService;
 
-  @Inject('logger')
-  logger: any;
+  @Inject()
+  private salesByItemsMeta: SalesByItemsMeta;
 
   /**
    * Defaults balance sheet filter query.
    * @return {IBalanceSheetQuery}
    */
-  get defaultQuery(): ISalesByItemsReportQuery {
+  private get defaultQuery(): ISalesByItemsReportQuery {
     return {
       fromDate: moment().startOf('month').format('YYYY-MM-DD'),
       toDate: moment().format('YYYY-MM-DD'),
@@ -38,29 +35,6 @@ export class SalesByItemsReportService {
     };
   }
 
-  /**
-   * Retrieve the balance sheet meta.
-   * @param {number} tenantId -
-   * @returns {IBalanceSheetMeta}
-   */
-  reportMetadata(tenantId: number): ISalesByItemsSheetMeta {
-    const settings = this.tenancy.settings(tenantId);
-
-    const organizationName = settings.get({
-      group: 'organization',
-      key: 'name',
-    });
-    const baseCurrency = settings.get({
-      group: 'organization',
-      key: 'base_currency',
-    });
-
-    return {
-      organizationName,
-      baseCurrency,
-    };
-  }
-
   /**
    * Retrieve balance sheet statement.
    * @param {number} tenantId
@@ -112,10 +86,13 @@ export class SalesByItemsReportService {
     );
     const salesByItemsData = sheet.reportData();
 
+    // Retrieve the sales by items meta.
+    const meta = await this.salesByItemsMeta.meta(tenantId, query);
+
     return {
       data: salesByItemsData,
       query: filter,
-      meta: this.reportMetadata(tenantId),
+      meta,
     };
   }
 }