feat(server): wip tax rates service

packages/server/src/services/TaxRates/CommandTaxRatesValidators.ts

@@ -0,0 +1,16 @@
+import { ServiceError } from '@/exceptions';
+import TaxRate from '@/models/TaxRate';
+import { Service } from 'typedi';
+
+@Service()
+export class CommandTaxRatesValidators {
+  /**
+   * 
+   * @param {} taxRate 
+   */
+  public validateTaxRateExistance(taxRate: TaxRate | undefined | null) {
+    if (!taxRate) {
+      throw new ServiceError(ERRORS.TAX_RATE_NOT_FOUND);
+    }
+  }
+}

packages/server/src/services/TaxRates/CreateTaxRate.ts

@@ -0,0 +1,53 @@
+import { Knex } from 'knex';
+import {
+  ICreateTaxRateDTO,
+  ITaxRateCreatedPayload,
+  ITaxRateCreatingPayload,
+} from '@/interfaces';
+import UnitOfWork from '../UnitOfWork';
+import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
+import HasTenancyService from '../Tenancy/TenancyService';
+import { Inject, Service } from 'typedi';
+import events from '@/subscribers/events';
+
+@Service()
+export class CreateTaxRate {
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  @Inject()
+  private eventPublisher: EventPublisher;
+
+  @Inject()
+  private uow: UnitOfWork;
+
+  /**
+   * Creates a new tax rate.
+   * @param {number} tenantId
+   * @param {ICreateTaxRateDTO} createTaxRateDTO
+   */
+  public createTaxRate(tenantId: number, createTaxRateDTO: ICreateTaxRateDTO) {
+    const { TaxRate } = this.tenancy.models(tenantId);
+
+    return this.uow.withTransaction(tenantId, async (trx: Knex.Transaction) => {
+      // Triggers `onTaxRateCreating` event.
+      await this.eventPublisher.emitAsync(events.taxRates.onCreating, {
+        createTaxRateDTO,
+        tenantId,
+        trx,
+      } as ITaxRateCreatingPayload);
+
+      const taxRate = await TaxRate.query(trx).insert({ ...createTaxRateDTO });
+
+      // Triggers `onTaxRateCreated` event.
+      await this.eventPublisher.emitAsync(events.taxRates.onCreated, {
+        createTaxRateDTO,
+        taxRate,
+        tenantId,
+        trx,
+      } as ITaxRateCreatedPayload);
+
+      return taxRate;
+    });
+  }
+}

packages/server/src/services/TaxRates/DeleteTaxRate.ts

@@ -0,0 +1,54 @@
+import { Inject, Service } from 'typedi';
+import { Knex } from 'knex';
+import { ITaxRateDeletedPayload, ITaxRateDeletingPayload } from '@/interfaces';
+import UnitOfWork from '../UnitOfWork';
+import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
+import HasTenancyService from '../Tenancy/TenancyService';
+import { CommandTaxRatesValidators } from './CommandTaxRatesValidators';
+import events from '@/subscribers/events';
+
+@Service()
+export class DeleteTaxRateService {
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  @Inject()
+  private eventPublisher: EventPublisher;
+
+  @Inject()
+  private uow: UnitOfWork;
+
+  @Inject()
+  private validators: CommandTaxRatesValidators;
+
+  /**
+   *
+   * @param tenantId
+   * @param taxRateId
+   */
+  public deleteTaxRate(tenantId: number, taxRateId: number) {
+    const { TaxRate } = this.tenancy.models(tenantId);
+
+    const oldTaxRate = TaxRate.query().findById(taxRateId);
+
+    this.validators.validateTaxRateExistance(oldTaxRate);
+
+    return this.uow.withTransaction(tenantId, async (trx: Knex.Transaction) => {
+      // Triggers `onSaleInvoiceCreating` event.
+      await this.eventPublisher.emitAsync(events.taxRates.onDeleting, {
+        oldTaxRate,
+        tenantId,
+        trx,
+      } as ITaxRateDeletingPayload);
+
+      await TaxRate.query(trx).findById(taxRateId).delete();
+
+      //
+      await this.eventPublisher.emitAsync(events.taxRates.onDeleted, {
+        oldTaxRate,
+        tenantId,
+        trx,
+      } as ITaxRateDeletedPayload);
+    });
+  }
+}

packages/server/src/services/TaxRates/EditTaxRate.ts

@@ -0,0 +1,68 @@
+import {
+  IEditTaxRateDTO,
+  ITaxRateCreatingPayload,
+  ITaxRateEditedPayload,
+  ITaxRateEditingPayload,
+} from '@/interfaces';
+import { Inject } from 'typedi';
+import UnitOfWork from '../UnitOfWork';
+import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
+import HasTenancyService from '../Tenancy/TenancyService';
+import { Knex } from 'knex';
+import { CommandTaxRatesValidators } from './CommandTaxRatesValidators';
+import events from '@/subscribers/events';
+
+export class EditTaxRateService {
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  @Inject()
+  private eventPublisher: EventPublisher;
+
+  @Inject()
+  private uow: UnitOfWork;
+
+  @Inject()
+  private validators: CommandTaxRatesValidators;
+
+  /**
+   *
+   * @param {number} tenantId
+   * @param {number} taxRateId
+   * @param {IEditTaxRateDTO} taxRateEditDTO
+   */
+  public editTaxRate(
+    tenantId: number,
+    taxRateId: number,
+    editTaxRateDTO: IEditTaxRateDTO
+  ) {
+    const { TaxRate } = this.tenancy.models(tenantId);
+
+    const oldTaxRate = TaxRate.query().findById(taxRateId);
+
+    this.validators.validateTaxRateExistance(oldTaxRate);
+
+    return this.uow.withTransaction(tenantId, async (trx: Knex.Transaction) => {
+      // Triggers `onTaxRateCreating` event.
+      await this.eventPublisher.emitAsync(events.taxRates.onCreating, {
+        editTaxRateDTO,
+        tenantId,
+        trx,
+      } as ITaxRateEditingPayload);
+
+      const taxRate = await TaxRate.query(trx)
+        .findById(taxRateId)
+        .patch({ ...editTaxRateDTO });
+
+      // Triggers `onTaxRateCreated` event.
+      await this.eventPublisher.emitAsync(events.taxRates.onCreated, {
+        editTaxRateDTO,
+        taxRate,
+        tenantId,
+        trx,
+      } as ITaxRateEditedPayload);
+
+      return taxRate;
+    });
+  }
+}

packages/server/src/services/TaxRates/GetTaxRate.ts

@@ -0,0 +1,28 @@
+import { Inject, Service } from 'typedi';
+import HasTenancyService from '../Tenancy/TenancyService';
+import { CommandTaxRatesValidators } from './CommandTaxRatesValidators';
+
+@Service()
+export class GetTaxRateService {
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  @Inject()
+  private validators: CommandTaxRatesValidators;
+
+  /**
+   *
+   * @param {number} tenantId
+   * @param {number} taxRateId
+   * @returns
+   */
+  public async getTaxRate(tenantId: number, taxRateId: number) {
+    const { TaxRate } = this.tenancy.models(tenantId);
+
+    const taxRate = await TaxRate.query().findById(taxRateId);
+
+    this.validators.validateTaxRateExistance(taxRate);
+
+    return taxRate;
+  }
+}

packages/server/src/services/TaxRates/GetTaxRates.ts

@@ -0,0 +1,21 @@
+import { Inject, Service } from 'typedi';
+import HasTenancyService from '../Tenancy/TenancyService';
+
+@Service()
+export class GetTaxRatesService {
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  /**
+   *
+   * @param {number} tenantId
+   * @returns
+   */
+  public async getTaxRates(tenantId: number) {
+    const { TaxRate } = this.tenancy.models(tenantId);
+
+    const taxRates = await TaxRate.query();
+
+    return taxRates;
+  }
+}

packages/server/src/services/TaxRates/TaxRatesApplication.ts

@@ -0,0 +1,82 @@
+import { Inject, Service } from 'typedi';
+import { ICreateTaxRateDTO, IEditTaxRateDTO } from '@/interfaces';
+import { CreateTaxRate } from './CreateTaxRate';
+import { DeleteTaxRateService } from './DeleteTaxRate';
+import { EditTaxRateService } from './EditTaxRate';
+import { GetTaxRateService } from './GetTaxRate';
+import { GetTaxRatesService } from './GetTaxRates';
+
+@Service()
+export class TaxRatesApplication {
+  @Inject()
+  private createTaxRateService: CreateTaxRate;
+
+  @Inject()
+  private editTaxRateService: EditTaxRateService;
+
+  @Inject()
+  private deleteTaxRateService: DeleteTaxRateService;
+
+  @Inject()
+  private getTaxRateService: GetTaxRateService;
+
+  @Inject()
+  private getTaxRatesService: GetTaxRatesService;
+
+  /**
+   * Creates a new tax rate.
+   * @param {number} tenantId
+   * @param {ICreateTaxRateDTO} createTaxRateDTO
+   * @returns
+   */
+  public createTaxRate(tenantId: number, createTaxRateDTO: ICreateTaxRateDTO) {
+    return this.createTaxRateService.createTaxRate(tenantId, createTaxRateDTO);
+  }
+
+  /**
+   * Edits the given tax rate.
+   * @param {number} tenantId
+   * @param {number} taxRateId
+   * @param {IEditTaxRateDTO} taxRateEditDTO
+   */
+  public editTaxRate(
+    tenantId: number,
+    taxRateId: number,
+    editTaxRateDTO: IEditTaxRateDTO
+  ) {
+    return this.editTaxRateService.editTaxRate(
+      tenantId,
+      taxRateId,
+      editTaxRateDTO
+    );
+  }
+
+  /**
+   * Deletes the given tax rate.
+   * @param {number} tenantId
+   * @param {number} taxRateId
+   * @returns {Promise<void>}
+   */
+  public deleteTaxRate(tenantId: number, taxRateId: number) {
+    return this.deleteTaxRateService.deleteTaxRate(tenantId, taxRateId);
+  }
+
+  /**
+   * Retrieves the given tax rate.
+   * @param {number} tenantId
+   * @param {number} taxRateId
+   * @returns
+   */
+  public getTaxRate(tenantId: number, taxRateId: number) {
+    return this.getTaxRateService.getTaxRate(tenantId, taxRateId);
+  }
+
+  /**
+   * Retrieves the tax rates list.
+   * @param {number} tenantId
+   * @returns
+   */
+  public getTaxRates(tenantId: number) {
+    return this.getTaxRatesService.getTaxRates(tenantId);
+  }
+}

packages/server/src/services/TaxRates/constants.ts

@@ -0,0 +1,3 @@
+const ERRORS = {
+  TAX_RATE_NOT_FOUND: 'TAX_RATE_NOT_FOUND',
+};