fix: sales by items TS types

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

@@ -1,8 +1,13 @@
-import { ISalesByItemsReportQuery } from '@/interfaces';
+import { Inject, Service } from 'typedi';
+import {
+  ISalesByItemsReportQuery,
+  ISalesByItemsSheet,
+  ISalesByItemsSheetData,
+  ISalesByItemsTable,
+} from '@/interfaces';
 import { SalesByItemsReportService } from './SalesByItemsService';
 import { SalesByItemsTableInjectable } from './SalesByItemsTableInjectable';
 import { SalesByItemsExport } from './SalesByItemsExport';
-import { Inject, Service } from 'typedi';
 
 @Service()
 export class SalesByItemsApplication {
@@ -19,9 +24,12 @@ export class SalesByItemsApplication {
    * Retrieves the sales by items report in json format.
    * @param {number} tenantId
    * @param {ISalesByItemsReportQuery} filter
-   * @returns {Promise<ISalesByItemsTable>}
+   * @returns {Promise<ISalesByItemsSheetData>}
    */
-  public sheet(tenantId: number, filter: ISalesByItemsReportQuery) {
+  public sheet(
+    tenantId: number,
+    filter: ISalesByItemsReportQuery
+  ): Promise<ISalesByItemsSheet> {
     return this.salesByItemsSheet.salesByItems(tenantId, filter);
   }
 
@@ -31,7 +39,10 @@ export class SalesByItemsApplication {
    * @param {ISalesByItemsReportQuery} filter
    * @returns {Promise<ISalesByItemsTable>}
    */
-  public table(tenantId: number, filter: ISalesByItemsReportQuery) {
+  public table(
+    tenantId: number,
+    filter: ISalesByItemsReportQuery
+  ): Promise<ISalesByItemsTable> {
     return this.salesByItemsTable.table(tenantId, filter);
   }
 
@@ -39,9 +50,12 @@ export class SalesByItemsApplication {
    * Retrieves the sales by items report in csv format.
    * @param {number} tenantId
    * @param {ISalesByItemsReportQuery} filter
-   * @returns {Promise<Buffer>}
+   * @returns {Promise<string>}
    */
-  public csv(tenantId: number, filter: ISalesByItemsReportQuery) {
+  public csv(
+    tenantId: number,
+    filter: ISalesByItemsReportQuery
+  ): Promise<string> {
     return this.salesByItemsExport.csv(tenantId, filter);
   }
 
@@ -51,7 +65,10 @@ export class SalesByItemsApplication {
    * @param {ISalesByItemsReportQuery} filter
    * @returns {Promise<Buffer>}
    */
-  public xlsx(tenantId: number, filter: ISalesByItemsReportQuery) {
+  public xlsx(
+    tenantId: number,
+    filter: ISalesByItemsReportQuery
+  ): Promise<Buffer> {
     return this.salesByItemsExport.xlsx(tenantId, filter);
   }
 }

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

@@ -2,8 +2,8 @@ import { Service, Inject } from 'typedi';
 import moment from 'moment';
 import {
   ISalesByItemsReportQuery,
-  ISalesByItemsSheetStatement,
-  ISalesByItemsSheetMeta
+  ISalesByItemsSheetMeta,
+  ISalesByItemsSheet,
 } from '@/interfaces';
 import TenancyService from '@/services/Tenancy/TenancyService';
 import SalesByItems from './SalesByItems';
@@ -63,20 +63,14 @@ export class SalesByItemsReportService {
 
   /**
    * Retrieve balance sheet statement.
-   * -------------
    * @param {number} tenantId
    * @param {IBalanceSheetQuery} query
-   *
-   * @return {IBalanceSheetStatement}
+   * @return {Promise<ISalesByItemsSheet>}
    */
   public async salesByItems(
     tenantId: number,
     query: ISalesByItemsReportQuery
-  ): Promise<{
-    data: ISalesByItemsSheetStatement,
-    query: ISalesByItemsReportQuery,
-    meta: ISalesByItemsSheetMeta,
-  }> {
+  ): Promise<ISalesByItemsSheet> {
     const { Item, InventoryTransaction } = this.tenancy.models(tenantId);
 
     const tenant = await Tenant.query()
@@ -107,20 +101,19 @@ export class SalesByItemsReportService {
         builder.whereIn('itemId', inventoryItemsIds);
 
         // Filter the date range of the sheet.
-        builder.modify('filterDateRange', filter.fromDate, filter.toDate)
+        builder.modify('filterDateRange', filter.fromDate, filter.toDate);
       }
     );
-
-    const purchasesByItemsInstance = new SalesByItems(
+    const sheet = new SalesByItems(
       filter,
       inventoryItems,
       inventoryTransactions,
-      tenant.metadata.baseCurrency,
+      tenant.metadata.baseCurrency
     );
-    const purchasesByItemsData = purchasesByItemsInstance.reportData();
+    const salesByItemsData = sheet.reportData();
 
     return {
-      data: purchasesByItemsData,
+      data: salesByItemsData,
       query: filter,
       meta: this.reportMetadata(tenantId),
     };

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

@@ -1,12 +1,12 @@
-import { ISalesByItemsReportQuery } from '@/interfaces';
 import { Inject, Service } from 'typedi';
+import { ISalesByItemsReportQuery } from '@/interfaces';
 import { SalesByItemsReportService } from './SalesByItemsService';
 import { SalesByItemsTable } from './SalesByItemsTable';
 
 @Service()
 export class SalesByItemsTableInjectable {
   @Inject()
-  salesByItemSheet: SalesByItemsReportService;
+  private salesByItemSheet: SalesByItemsReportService;
 
   /**
    * Retrieves the sales by items report in table format.