feat: more resources support importing

packages/server/src/services/Purchases/BillPayments/BillPaymentsImportable.ts

@@ -0,0 +1,45 @@
+import { Inject, Service } from 'typedi';
+import { Knex } from 'knex';
+import { IBillPaymentDTO } from '@/interfaces';
+import { CreateBillPayment } from './CreateBillPayment';
+import { Importable } from '@/services/Import/Importable';
+import { BillsPaymentsSampleData } from './constants';
+
+@Service()
+export class BillPaymentsImportable extends Importable {
+  @Inject()
+  private createBillPaymentService: CreateBillPayment;
+
+  /**
+   * Importing to account service.
+   * @param {number} tenantId
+   * @param {IAccountCreateDTO} createAccountDTO
+   * @returns
+   */
+  public importable(
+    tenantId: number,
+    billPaymentDTO: IBillPaymentDTO,
+    trx?: Knex.Transaction
+  ) {
+    return this.createBillPaymentService.createBillPayment(
+      tenantId,
+      billPaymentDTO,
+      trx
+    );
+  }
+
+  /**
+   * Concurrrency controlling of the importing process.
+   * @returns {number}
+   */
+  public get concurrency() {
+    return 1;
+  }
+
+  /**
+   * Retrieves the sample data that used to download accounts sample sheet.
+   */
+  public sampleData(): any[] {
+    return BillsPaymentsSampleData;
+  }
+}

packages/server/src/services/Purchases/BillPayments/CreateBillPayment.ts

@@ -48,7 +48,8 @@ export class CreateBillPayment {
    */
   public async createBillPayment(
     tenantId: number,
-    billPaymentDTO: IBillPaymentDTO
+    billPaymentDTO: IBillPaymentDTO,
+    trx?: Knex.Transaction
   ): Promise<IBillPayment> {
     const { BillPayment, Contact } = this.tenancy.models(tenantId);
 
@@ -97,28 +98,32 @@ export class CreateBillPayment {
     );
     // Writes bill payment transacation with associated transactions
     // under unit-of-work envirement.
-    return this.uow.withTransaction(tenantId, async (trx: Knex.Transaction) => {
-      // Triggers `onBillPaymentCreating` event.
-      await this.eventPublisher.emitAsync(events.billPayment.onCreating, {
-        tenantId,
-        billPaymentDTO,
-        trx,
-      } as IBillPaymentCreatingPayload);
+    return this.uow.withTransaction(
+      tenantId,
+      async (trx: Knex.Transaction) => {
+        // Triggers `onBillPaymentCreating` event.
+        await this.eventPublisher.emitAsync(events.billPayment.onCreating, {
+          tenantId,
+          billPaymentDTO,
+          trx,
+        } as IBillPaymentCreatingPayload);
 
-      // Writes the bill payment graph to the storage.
-      const billPayment = await BillPayment.query(trx).insertGraphAndFetch({
-        ...billPaymentObj,
-      });
+        // Writes the bill payment graph to the storage.
+        const billPayment = await BillPayment.query(trx).insertGraphAndFetch({
+          ...billPaymentObj,
+        });
 
-      // Triggers `onBillPaymentCreated` event.
-      await this.eventPublisher.emitAsync(events.billPayment.onCreated, {
-        tenantId,
-        billPayment,
-        billPaymentId: billPayment.id,
-        trx,
-      } as IBillPaymentEventCreatedPayload);
+        // Triggers `onBillPaymentCreated` event.
+        await this.eventPublisher.emitAsync(events.billPayment.onCreated, {
+          tenantId,
+          billPayment,
+          billPaymentId: billPayment.id,
+          trx,
+        } as IBillPaymentEventCreatedPayload);
 
-      return billPayment;
-    });
+        return billPayment;
+      },
+      trx
+    );
   }
 }

packages/server/src/services/Purchases/BillPayments/constants.ts

@@ -15,3 +15,36 @@ export const ERRORS = {
 };
 
 export const DEFAULT_VIEWS = [];
+
+export const BillsPaymentsSampleData = [
+  {
+    'Payment Date': '2024-03-01',
+    Vendor: 'Gabriel Kovacek',
+    'Payment No.': 'P-10001',
+    'Reference No.': 'REF-1',
+    'Payment Account': 'Petty Cash',
+    Statement: 'Vel et dolorem architecto veniam.',
+    'Bill No': 'B-120',
+    'Payment Amount': 100,
+  },
+  {
+    'Payment Date': '2024-03-02',
+    Vendor: 'Gabriel Kovacek',
+    'Payment No.': 'P-10002',
+    'Reference No.': 'REF-2',
+    'Payment Account': 'Petty Cash',
+    Statement: 'Id est molestias.',
+    'Bill No': 'B-121',
+    'Payment Amount': 100,
+  },
+  {
+    'Payment Date': '2024-03-03',
+    Vendor: 'Gabriel Kovacek',
+    'Payment No.': 'P-10003',
+    'Reference No.': 'REF-3',
+    'Payment Account': 'Petty Cash',
+    Statement: 'Quam cupiditate at nihil dicta dignissimos non fugit illo.',
+    'Bill No': 'B-122',
+    'Payment Amount': 100,
+  },
+];