feat: bank rules for uncategorized transactions

packages/server/src/services/Banking/Rules/BankRulesApplication.ts

@@ -0,0 +1,79 @@
+import { Inject, Service } from 'typedi';
+import { CreateBankRuleService } from './CreateBankRule';
+import { DeleteBankRuleSerivce } from './DeleteBankRule';
+import { EditBankRuleService } from './EditBankRule';
+import { GetBankRuleService } from './GetBankRule';
+import { GetBankRulesService } from './GetBankRules';
+import { ICreateBankRuleDTO, IEditBankRuleDTO } from './types';
+
+@Service()
+export class BankRulesApplication {
+  @Inject()
+  private createBankRuleService: CreateBankRuleService;
+
+  @Inject()
+  private editBankRuleService: EditBankRuleService;
+
+  @Inject()
+  private deleteBankRuleService: DeleteBankRuleSerivce;
+
+  @Inject()
+  private getBankRuleService: GetBankRuleService;
+
+  @Inject()
+  private getBankRulesService: GetBankRulesService;
+
+  /**
+   * Creates new bank rule.
+   * @param {number} tenantId
+   * @param {ICreateBankRuleDTO} createRuleDTO
+   * @returns
+   */
+  public createBankRule(tenantId: number, createRuleDTO: ICreateBankRuleDTO) {
+    return this.createBankRuleService.createBankRule(tenantId, createRuleDTO);
+  }
+
+  /**
+   * Edits the given bank rule.
+   * @param {number} tenantId
+   * @param {IEditBankRuleDTO} editRuleDTO
+   * @returns
+   */
+  public editBankRule(
+    tenantId: number,
+    ruleId: number,
+    editRuleDTO: IEditBankRuleDTO
+  ) {
+    return this.editBankRuleService.editBankRule(tenantId, ruleId, editRuleDTO);
+  }
+
+  /**
+   * Deletes the given bank rule.
+   * @param {number} tenantId
+   * @param {number} ruleId
+   * @returns
+   */
+  public deleteBankRule(tenantId: number, ruleId: number) {
+    return this.deleteBankRuleService.deleteBankRule(tenantId, ruleId);
+  }
+
+  /**
+   * Retrieves the given bank rule.
+   * @param {number} tenantId
+   * @param {number} ruleId
+   * @returns
+   */
+  public getBankRule(tenantId: number, ruleId: number) {
+    return this.getBankRuleService.getBankRule(tenantId, ruleId);
+  }
+
+  /**
+   * Retrieves the bank rules of the given account.
+   * @param {number} tenantId
+   * @param {number} accountId
+   * @returns
+   */
+  public getBankRules(tenantId: number) {
+    return this.getBankRulesService.getBankRules(tenantId);
+  }
+}

packages/server/src/services/Banking/Rules/CreateBankRule.ts

@@ -0,0 +1,65 @@
+import { Knex } from 'knex';
+import { Inject, Service } from 'typedi';
+import {
+  IBankRuleEventCreatedPayload,
+  IBankRuleEventCreatingPayload,
+  ICreateBankRuleDTO,
+} from './types';
+import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
+import HasTenancyService from '@/services/Tenancy/TenancyService';
+import UnitOfWork from '@/services/UnitOfWork';
+import events from '@/subscribers/events';
+
+@Service()
+export class CreateBankRuleService {
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  @Inject()
+  private uow: UnitOfWork;
+
+  @Inject()
+  private eventPublisher: EventPublisher;
+
+  /**
+   * Transformes the DTO to model.
+   * @param {ICreateBankRuleDTO} createDTO
+   * @returns
+   */
+  private transformDTO(createDTO: ICreateBankRuleDTO) {
+    return {
+      ...createDTO,
+    };
+  }
+
+  /**
+   * Creates a new bank rule.
+   * @param {number} tenantId
+   * @param {ICreateBankRuleDTO} createRuleDTO
+   */
+  public createBankRule(tenantId: number, createRuleDTO: ICreateBankRuleDTO) {
+    const { BankRule } = this.tenancy.models(tenantId);
+
+    const transformDTO = this.transformDTO(createRuleDTO);
+
+    return this.uow.withTransaction(tenantId, async (trx: Knex.Transaction) => {
+      // Triggers `onBankRuleCreating` event.
+      await this.eventPublisher.emitAsync(events.bankRules.onCreating, {
+        createRuleDTO,
+        trx,
+      } as IBankRuleEventCreatingPayload);
+
+      const bankRule = await BankRule.query(trx).upsertGraph({
+        ...transformDTO,
+      });
+
+      // Triggers `onBankRuleCreated` event.
+      await this.eventPublisher.emitAsync(events.bankRules.onCreated, {
+        createRuleDTO,
+        trx,
+      } as IBankRuleEventCreatedPayload);
+
+      return bankRule;
+    });
+  }
+}

packages/server/src/services/Banking/Rules/DeleteBankRule.ts

@@ -0,0 +1,53 @@
+import { Knex } from 'knex';
+import UnitOfWork from '@/services/UnitOfWork';
+import { Inject, Service } from 'typedi';
+import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
+import events from '@/subscribers/events';
+import {
+  IBankRuleEventDeletedPayload,
+  IBankRuleEventDeletingPayload,
+} from './types';
+import HasTenancyService from '@/services/Tenancy/TenancyService';
+
+@Service()
+export class DeleteBankRuleSerivce {
+  @Inject()
+  private uow: UnitOfWork;
+
+  @Inject()
+  private eventPublisher: EventPublisher;
+
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  /**
+   * Deletes the given bank rule.
+   * @param {number} tenantId
+   * @param {number} ruleId
+   * @returns {Promise<void>}
+   */
+  public async deleteBankRule(tenantId: number, ruleId: number) {
+    const { BankRule } = this.tenancy.models(tenantId);
+
+    const oldBankRule = await BankRule.query()
+      .findById(ruleId)
+      .throwIfNotFound();
+
+    return this.uow.withTransaction(tenantId, async (trx: Knex.Transaction) => {
+      // Triggers `onBankRuleDeleting` event.
+      await this.eventPublisher.emitAsync(events.bankRules.onDeleting, {
+        oldBankRule,
+        ruleId,
+        trx,
+      } as IBankRuleEventDeletingPayload);
+
+      await BankRule.query(trx).findById(ruleId).delete();
+
+      // Triggers `onBankRuleDeleted` event.
+      await await this.eventPublisher.emitAsync(events.bankRules.onDeleted, {
+        ruleId,
+        trx,
+      } as IBankRuleEventDeletedPayload);
+    });
+  }
+}

packages/server/src/services/Banking/Rules/EditBankRule.ts

@@ -0,0 +1,80 @@
+import { Knex } from 'knex';
+import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
+import HasTenancyService from '@/services/Tenancy/TenancyService';
+import UnitOfWork from '@/services/UnitOfWork';
+import events from '@/subscribers/events';
+import { Inject, Service } from 'typedi';
+import {
+  IBankRuleEventEditedPayload,
+  IBankRuleEventEditingPayload,
+  IEditBankRuleDTO,
+} from './types';
+
+@Service()
+export class EditBankRuleService {
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  @Inject()
+  private uow: UnitOfWork;
+
+  @Inject()
+  private eventPublisher: EventPublisher;
+
+  /**
+   *
+   * @param createDTO
+   * @returns
+   */
+  private transformDTO(createDTO: IEditBankRuleDTO) {
+    return {
+      ...createDTO,
+    };
+  }
+
+  /**
+   * Edits the given bank rule.
+   * @param {number} tenantId
+   * @param {number} ruleId -
+   * @param {IEditBankRuleDTO} editBankDTO
+   */
+  public async editBankRule(
+    tenantId: number,
+    ruleId: number,
+    editRuleDTO: IEditBankRuleDTO
+  ) {
+    const { BankRule } = this.tenancy.models(tenantId);
+
+    const oldBankRule = await BankRule.query()
+      .findById(ruleId)
+      .throwIfNotFound();
+
+    const tranformDTO = this.transformDTO(editRuleDTO);
+
+    return this.uow.withTransaction(
+      tenantId,
+      async (trx?: Knex.Transaction) => {
+        // Triggers `onBankRuleEditing` event.
+        await this.eventPublisher.emitAsync(events.bankRules.onEditing, {
+          oldBankRule,
+          ruleId,
+          editRuleDTO,
+          trx,
+        } as IBankRuleEventEditingPayload);
+
+        // Updates the given bank rule.
+        await BankRule.query()
+          .findById(ruleId)
+          .patch({ ...tranformDTO });
+
+        // Triggers `onBankRuleEdited` event.
+        await this.eventPublisher.emitAsync(events.bankRules.onEdited, {
+          oldBankRule,
+          ruleId,
+          editRuleDTO,
+          trx,
+        } as IBankRuleEventEditedPayload);
+      }
+    );
+  }
+}

packages/server/src/services/Banking/Rules/GetBankRule.ts

@@ -0,0 +1,34 @@
+import { TransformerInjectable } from '@/lib/Transformer/TransformerInjectable';
+import { BankRule } from '@/models/BankRule';
+import HasTenancyService from '@/services/Tenancy/TenancyService';
+import { Inject, Service } from 'typedi';
+import { GetBankRuleTransformer } from './GetBankRuleTransformer';
+
+@Service()
+export class GetBankRuleService {
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  @Inject()
+  private transformer: TransformerInjectable;
+
+  /**
+   * Retrieves the bank rule.
+   * @param {number} tenantId
+   * @param {number} ruleId
+   * @returns
+   */
+  async getBankRule(tenantId: number, ruleId: number) {
+    const { BankRule } = this.tenancy.models(tenantId);
+
+    const bankRule = await BankRule.query()
+      .findById(ruleId)
+      .withGraphFetched('conditions');
+
+    return this.transformer.transform(
+      tenantId,
+      bankRule,
+      new GetBankRuleTransformer()
+    );
+  }
+}

packages/server/src/services/Banking/Rules/GetBankRuleTransformer.ts

@@ -0,0 +1,11 @@
+import { Transformer } from '@/lib/Transformer/Transformer';
+
+export class GetBankRuleTransformer extends Transformer {
+  /**
+   * Include these attributes to sale invoice object.
+   * @returns {Array}
+   */
+  public includeAttributes = (): string[] => {
+    return [];
+  };
+}

packages/server/src/services/Banking/Rules/GetBankRules.ts

@@ -0,0 +1,31 @@
+import { TransformerInjectable } from '@/lib/Transformer/TransformerInjectable';
+import HasTenancyService from '@/services/Tenancy/TenancyService';
+import { Inject, Service } from 'typedi';
+import { GetBankRulesTransformer } from './GetBankRulesTransformer';
+
+@Service()
+export class GetBankRulesService {
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  @Inject()
+  private transformer: TransformerInjectable;
+
+  /**
+   * Retrieves the bank rules of the given account.
+   * @param {number} tenantId 
+   * @param {number} accountId 
+   * @returns 
+   */
+  public async getBankRules(tenantId: number) {
+    const { BankRule } = this.tenancy.models(tenantId);
+
+    const bankRule = await BankRule.query();
+
+    return this.transformer.transform(
+      tenantId,
+      bankRule,
+      new GetBankRulesTransformer()
+    );
+  }
+}

packages/server/src/services/Banking/Rules/GetBankRulesTransformer.ts

@@ -0,0 +1,11 @@
+import { Transformer } from '@/lib/Transformer/Transformer';
+
+export class GetBankRulesTransformer extends Transformer {
+  /**
+   * Include these attributes to sale invoice object.
+   * @returns {Array}
+   */
+  public includeAttributes = (): string[] => {
+    return [];
+  };
+}

packages/server/src/services/Banking/Rules/types.ts

@@ -0,0 +1,64 @@
+import { Knex } from 'knex';
+
+export enum BankRuleAssignCategory {
+  InterestIncome = 'InterestIncome',
+  OtherIncome = 'OtherIncome',
+  Deposit = 'Deposit',
+  Expense = 'Expense',
+  OwnerDrawings = 'OwnerDrawings',
+}
+
+export interface IBankRuleConditionDTO {
+  id?: number;
+  field: string;
+  comparator: string;
+  value: number;
+}
+
+export interface IBankRuleCommonDTO {
+  name: string;
+  order?: number;
+  applyIfAccountId: number;
+  applyIfTransactionType: string;
+
+  conditions: IBankRuleConditionDTO[];
+
+  assignCategory: BankRuleAssignCategory;
+  assignAccountId: number;
+  assignPayee?: string;
+  assignMemo?: string;
+}
+
+export interface ICreateBankRuleDTO extends IBankRuleCommonDTO {}
+export interface IEditBankRuleDTO extends IBankRuleCommonDTO {}
+
+export interface IBankRuleEventCreatingPayload {
+  createRuleDTO: ICreateBankRuleDTO;
+  trx?: Knex.Transaction;
+}
+export interface IBankRuleEventCreatedPayload {
+  createRuleDTO: ICreateBankRuleDTO;
+  trx?: Knex.Transaction;
+}
+
+export interface IBankRuleEventEditingPayload {
+  ruleId: number;
+  oldBankRule: any;
+  editRuleDTO: IEditBankRuleDTO;
+  trx?: Knex.Transaction;
+}
+export interface IBankRuleEventEditedPayload {
+  ruleId: number;
+  editRuleDTO: IEditBankRuleDTO;
+  trx?: Knex.Transaction;
+}
+
+export interface IBankRuleEventDeletingPayload {
+  oldBankRule: any;
+  ruleId: number;
+  trx?: Knex.Transaction;
+}
+export interface IBankRuleEventDeletedPayload {
+  ruleId: number;
+  trx?: Knex.Transaction;
+}