feat: export reports csv and xlsx (#286)

packages/server/src/services/FinancialStatements/SalesTaxLiabilitySummary/SalesTaxLiabilitySummaryApplication.ts

@@ -0,0 +1,63 @@
+import { Inject, Service } from 'typedi';
+import { SalesTaxLiabilitySummaryQuery } from '@/interfaces/SalesTaxLiabilitySummary';
+import { SalesTaxLiabilitySummaryTableInjectable } from './SalesTaxLiabilitySummaryTableInjectable';
+import { SalesTaxLiabilitySummaryExportInjectable } from './SalesTaxLiabilitySummaryExportInjectable';
+import { SalesTaxLiabilitySummaryService } from './SalesTaxLiabilitySummaryService';
+
+@Service()
+export class SalesTaxLiabilitySummaryApplication {
+  @Inject()
+  private salesTaxLiabilitySheet: SalesTaxLiabilitySummaryService;
+
+  @Inject()
+  private salesTaxLiabilityExport: SalesTaxLiabilitySummaryExportInjectable;
+
+  @Inject()
+  private salesTaxLiabilityTable: SalesTaxLiabilitySummaryTableInjectable;
+
+  /**
+   * Retrieves the sales tax liability summary in json format.
+   * @param {number} tenantId
+   * @param {SalesTaxLiabilitySummaryQuery} query
+   * @returns {Promise<Buffer>}
+   */
+  public sheet(tenantId: number, query: SalesTaxLiabilitySummaryQuery) {
+    return this.salesTaxLiabilitySheet.salesTaxLiability(tenantId, query);
+  }
+
+  /**
+   * Retrieves the sales tax liability summary in table format.
+   * @param {number} tenantId
+   * @param {SalesTaxLiabilitySummaryQuery} query
+   * @return {Promise<Buffer>}
+   */
+  public table(tenantId: number, query: SalesTaxLiabilitySummaryQuery) {
+    return this.salesTaxLiabilityTable.table(tenantId, query);
+  }
+
+  /**
+   * Retrieves the sales tax liability summary in XLSX format.
+   * @param {number} tenantId
+   * @param {SalesTaxLiabilitySummaryQuery} query
+   * @returns {Promise<Buffer>}
+   */
+  public xlsx(
+    tenantId: number,
+    query: SalesTaxLiabilitySummaryQuery
+  ): Promise<Buffer> {
+    return this.salesTaxLiabilityExport.xlsx(tenantId, query);
+  }
+
+  /**
+   * Retrieves the sales tax liability summary in CSV format.
+   * @param {number} tenantId
+   * @param {SalesTaxLiabilitySummaryQuery} query
+   * @returns {Promise<string>}
+   */
+  public csv(
+    tenantId: number,
+    query: SalesTaxLiabilitySummaryQuery
+  ): Promise<string> {
+    return this.salesTaxLiabilityExport.csv(tenantId, query);
+  }
+}

packages/server/src/services/FinancialStatements/SalesTaxLiabilitySummary/SalesTaxLiabilitySummaryExportInjectable.ts

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

packages/server/src/services/FinancialStatements/SalesTaxLiabilitySummary/SalesTaxLiabilitySummaryService.ts

@@ -5,7 +5,6 @@ import {
   SalesTaxLiabilitySummaryQuery,
 } from '@/interfaces/SalesTaxLiabilitySummary';
 import { SalesTaxLiabilitySummary } from './SalesTaxLiabilitySummary';
-import { SalesTaxLiabilitySummaryTable } from './SalesTaxLiabilitySummaryTable';
 import HasTenancyService from '@/services/Tenancy/TenancyService';
 
 @Service()
@@ -47,32 +46,6 @@ export class SalesTaxLiabilitySummaryService {
     };
   }
 
-  /**
-   * Retrieve sales tax liability summary table.
-   * @param {number} tenantId
-   * @param {SalesTaxLiabilitySummaryQuery} query
-   * @returns
-   */
-  public async salesTaxLiabilitySummaryTable(
-    tenantId: number,
-    query: SalesTaxLiabilitySummaryQuery
-  ) {
-    const report = await this.salesTaxLiability(tenantId, query);
-
-    // Creates the sales tax liability summary table.
-    const table = new SalesTaxLiabilitySummaryTable(report.data, query);
-
-    return {
-      table: {
-        rows: table.tableRows(),
-        columns: table.tableColumns(),
-      },
-      data: report.data,
-      query: report.query,
-      meta: report.meta,
-    };
-  }
-
   /**
    * Retrieve the report meta.
    * @param {number} tenantId -

packages/server/src/services/FinancialStatements/SalesTaxLiabilitySummary/SalesTaxLiabilitySummaryTableInjectable.ts

@@ -0,0 +1,40 @@
+import { Inject, Service } from 'typedi';
+import {
+  ISalesTaxLiabilitySummaryTable,
+  SalesTaxLiabilitySummaryQuery,
+} from '@/interfaces/SalesTaxLiabilitySummary';
+import { SalesTaxLiabilitySummaryTable } from './SalesTaxLiabilitySummaryTable';
+import { SalesTaxLiabilitySummaryService } from './SalesTaxLiabilitySummaryService';
+
+@Service()
+export class SalesTaxLiabilitySummaryTableInjectable {
+  @Inject()
+  private salesTaxLiability: SalesTaxLiabilitySummaryService;
+
+  /**
+   * Retrieve sales tax liability summary table.
+   * @param {number} tenantId
+   * @param {SalesTaxLiabilitySummaryQuery} query
+   * @returns {Promise<ISalesTaxLiabilitySummaryTable>}
+   */
+  public async table(
+    tenantId: number,
+    query: SalesTaxLiabilitySummaryQuery
+  ): Promise<ISalesTaxLiabilitySummaryTable> {
+    const report = await this.salesTaxLiability.salesTaxLiability(
+      tenantId,
+      query
+    );
+    // Creates the sales tax liability summary table.
+    const table = new SalesTaxLiabilitySummaryTable(report.data, query);
+
+    return {
+      table: {
+        rows: table.tableRows(),
+        columns: table.tableColumns(),
+      },
+      query: report.query,
+      meta: report.meta,
+    };
+  }
+}