feat: export reports csv and xlsx (#286)

packages/server/src/services/FinancialStatements/BalanceSheet/BalanceSheetApplication.ts

@@ -0,0 +1,57 @@
+import { Inject, Service } from 'typedi';
+import { IBalanceSheetQuery } from '@/interfaces';
+import { BalanceSheetExportInjectable } from './BalanceSheetExportInjectable';
+import { BalanceSheetTableInjectable } from './BalanceSheetTableInjectable';
+import BalanceSheetStatementService from './BalanceSheetInjectable';
+
+@Service()
+export class BalanceSheetApplication {
+  @Inject()
+  public balanceSheetExport: BalanceSheetExportInjectable;
+
+  @Inject()
+  public balanceSheetTable: BalanceSheetTableInjectable;
+
+  @Inject()
+  public balanceSheet: BalanceSheetStatementService;
+
+  /**
+   * Retrieves the balnace sheet in json format.
+   * @param {numnber} tenantId
+   * @param {IBalanceSheetQuery} query
+   * @returns {Promise<IBalanceSheetStatement>}
+   */
+  public sheet(tenantId: number, query: IBalanceSheetQuery) {
+    return this.balanceSheet.balanceSheet(tenantId, query);
+  }
+
+  /**
+   * Retrieves the balance sheet in table format.
+   * @param {number} tenantId
+   * @param {IBalanceSheetQuery} query
+   * @returns {Promise<IBalanceSheetTable>}
+   */
+  public table(tenantId: number, query: IBalanceSheetQuery) {
+    return this.balanceSheetTable.table(tenantId, query);
+  }
+
+  /**
+   * Retrieves the balance sheet in XLSX format.
+   * @param {number} tenantId
+   * @param {IBalanceSheetQuery} query
+   * @returns {Promise<Buffer>}
+   */
+  public xlsx(tenantId: number, query: IBalanceSheetQuery) {
+    return this.balanceSheetExport.xlsx(tenantId, query);
+  }
+
+  /**
+   * Retrieves the balance sheet in CSV format.
+   * @param {number} tenantId
+   * @param {IBalanceSheetQuery} query
+   * @returns {Promise<Buffer>}
+   */
+  public csv(tenantId: number, query: IBalanceSheetQuery): Promise<string> {
+    return this.balanceSheetExport.csv(tenantId, query);
+  }
+}

packages/server/src/services/FinancialStatements/BalanceSheet/BalanceSheetExportInjectable.ts

@@ -0,0 +1,43 @@
+import { Inject, Service } from 'typedi';
+import { BalanceSheetTableInjectable } from './BalanceSheetTableInjectable';
+import { TableSheet } from '@/lib/Xlsx/TableSheet';
+import { IBalanceSheetQuery } from '@/interfaces';
+
+@Service()
+export class BalanceSheetExportInjectable {
+  @Inject()
+  private balanceSheetTable: BalanceSheetTableInjectable;
+
+  /**
+   * Retrieves the trial balance sheet in XLSX format.
+   * @param {number} tenantId
+   * @param {ITrialBalanceSheetQuery} query
+   * @returns {Promise<Buffer>}
+   */
+  public async xlsx(tenantId: number, query: IBalanceSheetQuery) {
+    const table = await this.balanceSheetTable.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 {ITrialBalanceSheetQuery} query
+   * @returns {Promise<Buffer>}
+   */
+  public async csv(
+    tenantId: number,
+    query: IBalanceSheetQuery
+  ): Promise<string> {
+    const table = await this.balanceSheetTable.table(tenantId, query);
+
+    const tableSheet = new TableSheet(table.table);
+    const tableCsv = tableSheet.convertToCSV();
+
+    return tableCsv;
+  }
+}

packages/server/src/services/FinancialStatements/BalanceSheet/BalanceSheetInjectable.ts

@@ -19,13 +19,10 @@ export default class BalanceSheetStatementService
   implements IBalanceSheetStatementService
 {
   @Inject()
-  tenancy: TenancyService;
-
-  @Inject('logger')
-  logger: any;
+  private tenancy: TenancyService;
 
   @Inject()
-  inventoryService: InventoryService;
+  private inventoryService: InventoryService;
 
   /**
    * Defaults balance sheet filter query.
@@ -94,10 +91,8 @@ export default class BalanceSheetStatementService
 
   /**
    * Retrieve balance sheet statement.
-   * -------------
    * @param {number} tenantId
    * @param {IBalanceSheetQuery} query
-   *
    * @return {IBalanceSheetStatement}
    */
   public async balanceSheet(

packages/server/src/services/FinancialStatements/BalanceSheet/BalanceSheetTableInjectable.ts

@@ -0,0 +1,42 @@
+import { Inject, Service } from 'typedi';
+import BalanceSheetStatementService from './BalanceSheetInjectable';
+import BalanceSheetTable from './BalanceSheetTable';
+import { IBalanceSheetQuery, IBalanceSheetTable } from '@/interfaces';
+import HasTenancyService from '@/services/Tenancy/TenancyService';
+
+@Service()
+export class BalanceSheetTableInjectable {
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  @Inject()
+  private balanceSheetService: BalanceSheetStatementService;
+
+  /**
+   * Retrieves the balance sheet in table format.
+   * @param {number} tenantId
+   * @param {number} query
+   * @returns {Promise<IBalanceSheetTable>}
+   */
+  public async table(
+    tenantId: number,
+    filter: IBalanceSheetQuery
+  ): Promise<IBalanceSheetTable> {
+    const i18n = this.tenancy.i18n(tenantId);
+
+    const { data, query, meta } = await this.balanceSheetService.balanceSheet(
+      tenantId,
+      filter
+    );
+    const table = new BalanceSheetTable(data, query, i18n);
+
+    return {
+      table: {
+        columns: table.tableColumns(),
+        rows: table.tableRows(),
+      },
+      query,
+      meta,
+    };
+  }
+}