bigcapital/packages/server-nest/src/modules/InventoryAdjutments/commands/PublishInventoryAdjustment.service.ts

import { Knex } from 'knex';
import { Inject, Injectable } from '@nestjs/common';
import { EventEmitter2 } from '@nestjs/event-emitter';
import * as moment from 'moment';
import { UnitOfWork } from '@/modules/Tenancy/TenancyDB/UnitOfWork.service';
import { InventoryAdjustment } from '../models/InventoryAdjustment';
import {
  IInventoryAdjustmentEventPublishedPayload,
  IInventoryAdjustmentPublishingPayload,
} from '../types/InventoryAdjustments.types';
import { events } from '@/common/events/events';
import { ServiceError } from '@/modules/Items/ServiceError';
import { ERRORS } from '../constants/InventoryAdjustments.constants';

@Injectable()
export class PublishInventoryAdjustmentService {
  constructor(
    private readonly eventEmitter: EventEmitter2,
    private readonly uow: UnitOfWork,

    @Inject(InventoryAdjustment.name)
    private readonly inventoryAdjustmentModel: typeof InventoryAdjustment,
  ) {}

  /**
   * Publish the inventory adjustment transaction.
   * @param {number} inventoryAdjustmentId - Inventory adjustment ID.
   */
  public async publishInventoryAdjustment(
    inventoryAdjustmentId: number,
  ): Promise<void> {
    // Retrieve the inventory adjustment or throw not found service error.
    const oldInventoryAdjustment = await this.inventoryAdjustmentModel
      .query()
      .findById(inventoryAdjustmentId)
      .throwIfNotFound();

    // Validate adjustment not already published.
    this.validateAdjustmentTransactionsNotPublished(oldInventoryAdjustment);

    // Publishes inventory adjustment with associated inventory transactions
    // under unit-of-work envirement.
    return this.uow.withTransaction(async (trx: Knex.Transaction) => {
      await this.eventEmitter.emitAsync(
        events.inventoryAdjustment.onPublishing,
        {
          trx,
          oldInventoryAdjustment,
        } as IInventoryAdjustmentPublishingPayload,
      );

      // Publish the inventory adjustment transaction.
      await this.inventoryAdjustmentModel
        .query()
        .findById(inventoryAdjustmentId)
        .patch({
          publishedAt: moment().toMySqlDateTime(),
        });
      // Retrieve the inventory adjustment after the modification.
      const inventoryAdjustment = await this.inventoryAdjustmentModel
        .query()
        .findById(inventoryAdjustmentId)
        .withGraphFetched('entries');

      // Triggers `onInventoryAdjustmentDeleted` event.
      await this.eventEmitter.emitAsync(
        events.inventoryAdjustment.onPublished,
        {
          inventoryAdjustmentId,
          inventoryAdjustment,
          oldInventoryAdjustment,
          trx,
        } as IInventoryAdjustmentEventPublishedPayload,
      );
    });
  }

  /**
   * Validate the adjustment transaction is exists.
   * @param {IInventoryAdjustment} inventoryAdjustment
   */
  private throwIfAdjustmentNotFound(inventoryAdjustment: InventoryAdjustment) {
    if (!inventoryAdjustment) {
      throw new ServiceError(ERRORS.INVENTORY_ADJUSTMENT_NOT_FOUND);
    }
  }

  /**
   * Validates the adjustment transaction is not already published.
   * @param {IInventoryAdjustment} oldInventoryAdjustment
   */
  private validateAdjustmentTransactionsNotPublished(
    oldInventoryAdjustment: InventoryAdjustment,
  ) {
    if (oldInventoryAdjustment.isPublished) {
      throw new ServiceError(ERRORS.INVENTORY_ADJUSTMENT_ALREADY_PUBLISHED);
    }
  }
}