bigcapital/packages/server/src/services/Sales/Estimates/SaleEstimateTransformer.ts

import { ISaleEstimate } from '@/interfaces';
import { Transformer } from '@/lib/Transformer/Transformer';
import { formatNumber } from 'utils';
import { ItemEntryTransformer } from '../Invoices/ItemEntryTransformer';
import { AttachmentTransformer } from '@/services/Attachments/AttachmentTransformer';

export class SaleEstimateTransfromer extends Transformer {
  /**
   * Include these attributes to sale invoice object.
   * @returns {Array}
   */
  public includeAttributes = (): string[] => {
    return [
      'formattedSubtotal',
      'formattedAmount',
      'formattedEstimateDate',
      'formattedExpirationDate',
      'formattedDeliveredAtDate',
      'formattedApprovedAtDate',
      'formattedRejectedAtDate',
      'discountAmountFormatted',
      'discountPercentageFormatted',
      'adjustmentFormatted',
      'formattedCreatedAt',
      'entries',
      'attachments',
    ];
  };

  /**
   * Retrieve formatted estimate date.
   * @param {ISaleEstimate} invoice
   * @returns {String}
   */
  protected formattedEstimateDate = (estimate: ISaleEstimate): string => {
    return this.formatDate(estimate.estimateDate);
  };

  /**
   * Retrieve formatted estimate date.
   * @param {ISaleEstimate} invoice
   * @returns {String}
   */
  protected formattedExpirationDate = (estimate: ISaleEstimate): string => {
    return this.formatDate(estimate.expirationDate);
  };

  /**
   * Retrieves the formatted estimate created at.
   * @param {ISaleEstimate} estimate -
   * @returns {string}
   */
  protected formattedCreatedAt = (estimate: ISaleEstimate): string => {
    return this.formatDate(estimate.createdAt);
  };

  /**
   * Retrieve formatted estimate date.
   * @param {ISaleEstimate} invoice
   * @returns {String}
   */
  protected formattedDeliveredAtDate = (estimate: ISaleEstimate): string => {
    return this.formatDate(estimate.deliveredAt);
  };

  /**
   * Retrieve formatted estimate date.
   * @param {ISaleEstimate} invoice
   * @returns {String}
   */
  protected formattedApprovedAtDate = (estimate: ISaleEstimate): string => {
    return this.formatDate(estimate.approvedAt);
  };

  /**
   * Retrieve formatted estimate date.
   * @param {ISaleEstimate} invoice
   * @returns {String}
   */
  protected formattedRejectedAtDate = (estimate: ISaleEstimate): string => {
    return this.formatDate(estimate.rejectedAt);
  };

  /**
   * Retrieve formatted invoice amount.
   * @param {ISaleEstimate} estimate
   * @returns {string}
   */
  protected formattedAmount = (estimate: ISaleEstimate): string => {
    return formatNumber(estimate.amount, {
      currencyCode: estimate.currencyCode,
    });
  };

  /**
   * Retrieves the formatted invoice subtotal.
   * @param {ISaleEstimate} estimate
   * @returns {string}
   */
  protected formattedSubtotal = (estimate: ISaleEstimate): string => {
    return formatNumber(estimate.amount, { money: false });
  };

  /**
   * Retrieves formatted discount amount.
   * @param estimate
   * @returns {string}
   */
  protected discountAmountFormatted = (estimate: ISaleEstimate): string => {
    return formatNumber(estimate.discountAmount, {
      currencyCode: estimate.currencyCode,
    });
  };

  /**
   * Retrieves formatted discount percentage.
   * @param estimate
   * @returns {string}
   */
  protected discountPercentageFormatted = (estimate: ISaleEstimate): string => {
    return estimate.discountPercentage
      ? `${estimate.discountPercentage}%`
      : '';
  };

  /**
   * Retrieves formatted adjustment amount.
   * @param estimate
   * @returns {string}
   */
  protected adjustmentFormatted = (estimate: ISaleEstimate): string => {
    return this.formatMoney(estimate.adjustment, {
      currencyCode: estimate.currencyCode,
    });
  };

  /**
   * Retrieves the entries of the sale estimate.
   * @param {ISaleEstimate} estimate
   * @returns {}
   */
  protected entries = (estimate: ISaleEstimate) => {
    return this.item(estimate.entries, new ItemEntryTransformer(), {
      currencyCode: estimate.currencyCode,
    });
  };

  /**
   * Retrieves the sale estimate attachments.
   * @param {ISaleInvoice} invoice
   * @returns
   */
  protected attachments = (estimate: ISaleEstimate) => {
    return this.item(estimate.attachments, new AttachmentTransformer());
  };
}