feat: export reports csv and xlsx (#286)

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

@@ -29,7 +29,7 @@ enum INodeTypes {
   CLOSING_ENTRY = 'CLOSING_ENTRY',
 }
 
-export default class InventoryDetails extends FinancialSheet {
+export class InventoryDetails extends FinancialSheet {
   readonly inventoryTransactionsByItemId: Map<number, IInventoryTransaction[]>;
   readonly openingBalanceTransactions: Map<number, IInventoryTransaction>;
   readonly query: IInventoryDetailsQuery;

packages/server/src/services/FinancialStatements/InventoryDetails/InventoryDetailsApplication.ts

@@ -0,0 +1,66 @@
+import {
+  IInventoryDetailsQuery,
+  IInvetoryItemDetailsTable,
+} from '@/interfaces';
+import { Inject, Service } from 'typedi';
+import { InventoryDetailsExportInjectable } from './InventoryDetailsExportInjectable';
+import { InventoryDetailsTableInjectable } from './InventoryDetailsTableInjectable';
+import { InventoryDetailsService } from './InventoryDetailsService';
+
+@Service()
+export class InventortyDetailsApplication {
+  @Inject()
+  private inventoryDetailsExport: InventoryDetailsExportInjectable;
+
+  @Inject()
+  private inventoryDetailsTable: InventoryDetailsTableInjectable;
+
+  @Inject()
+  private inventoryDetails: InventoryDetailsService;
+
+  /**
+   * Retrieves the inventory details report in sheet format.
+   * @param {number} tenantId
+   * @param {IInventoryDetailsQuery} query
+   * @returns {Promise<IInvetoryItemDetailDOO>}
+   */
+  public sheet(tenantId: number, query: IInventoryDetailsQuery) {
+    return this.inventoryDetails.inventoryDetails(tenantId, query);
+  }
+
+  /**
+   * Retrieve the inventory details report in table format.
+   * @param {number} tenantId
+   * @param {IInventoryDetailsQuery} query
+   * @returns
+   */
+  public table(
+    tenantId: number,
+    query: IInventoryDetailsQuery
+  ): Promise<IInvetoryItemDetailsTable> {
+    return this.inventoryDetailsTable.table(tenantId, query);
+  }
+
+  /**
+   * Retrieves the inventory details report in XLSX format.
+   * @param {number} tenantId
+   * @param {IInventoryDetailsQuery} query
+   * @returns {Promise<Buffer>}
+   */
+  public xlsx(
+    tenantId: number,
+    query: IInventoryDetailsQuery
+  ): Promise<Buffer> {
+    return this.inventoryDetailsExport.xlsx(tenantId, query);
+  }
+
+  /**
+   * Retrieves the inventory details report in CSV format.
+   * @param {number} tenantId
+   * @param {IInventoryDetailsQuery} query
+   * @returns {Promise<string>}
+   */
+  public csv(tenantId: number, query: IInventoryDetailsQuery): Promise<string> {
+    return this.inventoryDetailsExport.csv(tenantId, query);
+  }
+}

packages/server/src/services/FinancialStatements/InventoryDetails/InventoryDetailsExportInjectable.ts

@@ -0,0 +1,43 @@
+import { Inject, Service } from 'typedi';
+import { IInventoryDetailsQuery } from '@/interfaces';
+import { TableSheet } from '@/lib/Xlsx/TableSheet';
+import { InventoryDetailsTableInjectable } from './InventoryDetailsTableInjectable';
+
+@Service()
+export class InventoryDetailsExportInjectable {
+  @Inject()
+  private inventoryDetailsTable: InventoryDetailsTableInjectable;
+
+  /**
+   * Retrieves the trial balance sheet in XLSX format.
+   * @param {number} tenantId
+   * @param {IInventoryDetailsQuery} query
+   * @returns {Promise<Buffer>}
+   */
+  public async xlsx(tenantId: number, query: IInventoryDetailsQuery) {
+    const table = await this.inventoryDetailsTable.table(tenantId, query);
+
+    const tableSheet = new TableSheet(table.table);
+    const tableCsv = tableSheet.convertToXLSX();
+
+    return tableSheet.convertToBuffer(tableCsv, 'xlsx');
+  }
+
+  /**
+   * Retrieves the trial balance sheet in CSV format.
+   * @param {number} tenantId
+   * @param {IInventoryDetailsQuery} query
+   * @returns {Promise<Buffer>}
+   */
+  public async csv(
+    tenantId: number,
+    query: IInventoryDetailsQuery
+  ): Promise<string> {
+    const table = await this.inventoryDetailsTable.table(tenantId, query);
+
+    const tableSheet = new TableSheet(table.table);
+    const tableCsv = tableSheet.convertToCSV();
+
+    return tableCsv;
+  }
+}

packages/server/src/services/FinancialStatements/InventoryDetails/InventoryDetailsService.ts

@@ -6,7 +6,7 @@ import {
   IInventoryItemDetailMeta,
 } from '@/interfaces';
 import TenancyService from '@/services/Tenancy/TenancyService';
-import InventoryDetails from './InventoryDetails';
+import { InventoryDetails } from './InventoryDetails';
 import FinancialSheet from '../FinancialSheet';
 import InventoryDetailsRepository from './InventoryDetailsRepository';
 import InventoryService from '@/services/Inventory/Inventory';
@@ -14,7 +14,7 @@ import { parseBoolean } from 'utils';
 import { Tenant } from '@/system/models';
 
 @Service()
-export default class InventoryDetailsService extends FinancialSheet {
+export class InventoryDetailsService extends FinancialSheet {
   @Inject()
   private tenancy: TenancyService;
 

packages/server/src/services/FinancialStatements/InventoryDetails/InventoryDetailsTable.ts

@@ -20,13 +20,13 @@ enum IROW_TYPE {
 
 const MAP_CONFIG = { childrenPath: 'children', pathFormat: 'array' };
 
-export default class InventoryDetailsTable {
+export class InventoryDetailsTable {
   i18n: any;
   report: any;
 
   /**
    * Constructor method.
-   * @param {ICashFlowStatement} reportStatement - Report statement.
+   * @param {ICashFlowStatement} report - Report statement.
    */
   constructor(reportStatement, i18n) {
     this.report = reportStatement;
@@ -172,7 +172,7 @@ export default class InventoryDetailsTable {
    * Retrieve the table rows of the inventory item details.
    * @returns {ITableRow[]}
    */
-  public tableData = (): ITableRow[] => {
+  public tableRows = (): ITableRow[] => {
     return this.itemsMapper(this.report.data);
   };
 

packages/server/src/services/FinancialStatements/InventoryDetails/InventoryDetailsTableInjectable.ts

@@ -0,0 +1,45 @@
+import HasTenancyService from '@/services/Tenancy/TenancyService';
+import { Inject, Service } from 'typedi';
+import { InventoryDetailsTable } from './InventoryDetailsTable';
+import {
+  IInventoryDetailsQuery,
+  IInvetoryItemDetailsTable,
+} from '@/interfaces';
+import { InventoryDetailsService } from './InventoryDetailsService';
+
+@Service()
+export class InventoryDetailsTableInjectable {
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  @Inject()
+  private inventoryDetails: InventoryDetailsService;
+
+  /**
+   * Retrieves the inventory item details in table format.
+   * @param {number} tenantId
+   * @param {IInventoryDetailsQuery} query
+   * @returns {Promise<IInvetoryItemDetailsTable>}
+   */
+  public async table(
+    tenantId: number,
+    query: IInventoryDetailsQuery
+  ): Promise<IInvetoryItemDetailsTable> {
+    const i18n = this.tenancy.i18n(tenantId);
+
+    const inventoryDetails = await this.inventoryDetails.inventoryDetails(
+      tenantId,
+      query
+    );
+    const table = new InventoryDetailsTable(inventoryDetails, i18n);
+
+    return {
+      table: {
+        rows: table.tableRows(),
+        columns: table.tableColumns(),
+      },
+      query: inventoryDetails.query,
+      meta: inventoryDetails.meta,
+    };
+  }
+}