bigcapital/packages/server/src/services/Accounts/DeleteAccount.ts

import { Service, Inject } from 'typedi';
import { Knex } from 'knex';
import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
import HasTenancyService from '@/services/Tenancy/TenancyService';
import UnitOfWork from '@/services/UnitOfWork';
import { IAccountEventDeletedPayload, IAccount } from '@/interfaces';
import events from '@/subscribers/events';
import { CommandAccountValidators } from './CommandAccountValidators';
import { ERRORS } from './constants';

@Service()
export class DeleteAccount {
  @Inject()
  private tenancy: HasTenancyService;

  @Inject()
  private eventPublisher: EventPublisher;

  @Inject()
  private uow: UnitOfWork;

  @Inject()
  private validator: CommandAccountValidators;

  /**
   * Authorize account delete.
   * @param {number} tenantId - Tenant id.
   * @param {number} accountId - Account id.
   */
  private authorize = async (
    tenantId: number,
    accountId: number,
    oldAccount: IAccount
  ) => {
    // Throw error if the account was predefined.
    this.validator.throwErrorIfAccountPredefined(oldAccount);
  };

  /**
   * Unlink the given parent account with children accounts.
   * @param {number} tenantId -
   * @param {number|number[]} parentAccountId -
   */
  private async unassociateChildrenAccountsFromParent(
    tenantId: number,
    parentAccountId: number | number[],
    trx?: Knex.Transaction
  ) {
    const { Account } = this.tenancy.models(tenantId);
    const accountsIds = Array.isArray(parentAccountId)
      ? parentAccountId
      : [parentAccountId];

    await Account.query(trx)
      .whereIn('parent_account_id', accountsIds)
      .patch({ parent_account_id: null });
  }

  /**
   * Deletes the account from the storage.
   * @param {number} tenantId
   * @param {number} accountId
   */
  public deleteAccount = async (
    tenantId: number,
    accountId: number
  ): Promise<void> => {
    const { Account } = this.tenancy.models(tenantId);

    // Retrieve account or not found service error.
    const oldAccount = await Account.query()
      .findById(accountId)
      .throwIfNotFound()
      .queryAndThrowIfHasRelations({
        type: ERRORS.ACCOUNT_HAS_ASSOCIATED_TRANSACTIONS,
        excludeRelations: ['uncategorizedTransactions', 'plaidItem']
      });
    // Authorize before delete account.
    await this.authorize(tenantId, accountId, oldAccount);

    // Deletes the account and associated transactions under UOW envirement.
    return this.uow.withTransaction(tenantId, async (trx: Knex.Transaction) => {
      // Triggers `onAccountDelete` event.
      await this.eventPublisher.emitAsync(events.accounts.onDelete, {
        trx,
        oldAccount,
        tenantId,
      } as IAccountEventDeletedPayload);

      // Unlink the parent account from children accounts.
      await this.unassociateChildrenAccountsFromParent(
        tenantId,
        accountId,
        trx
      );
      // Deletes account by the given id.
      await Account.query(trx).findById(accountId).delete();

      // Triggers `onAccountDeleted` event.
      await this.eventPublisher.emitAsync(events.accounts.onDeleted, {
        tenantId,
        accountId,
        oldAccount,
        trx,
      } as IAccountEventDeletedPayload);
    });
  };
}