feat: receipt mail preview

packages/server/src/services/Sales/Receipts/GetSaleReceiptMailState.ts

@@ -0,0 +1,45 @@
+import { Inject, Service } from 'typedi';
+import { TransformerInjectable } from '@/lib/Transformer/TransformerInjectable';
+import HasTenancyService from '@/services/Tenancy/TenancyService';
+import { SaleReceiptMailNotification } from './SaleReceiptMailNotification';
+import { GetSaleReceiptMailStateTransformer } from './GetSaleReceiptMailStateTransformer';
+
+@Service()
+export class GetSaleReceiptMailState {
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  @Inject()
+  private transformer: TransformerInjectable;
+
+  @Inject()
+  private receiptMail: SaleReceiptMailNotification;
+
+  /**
+   * Retrieves the sale receipt mail state of the given sale receipt.
+   * @param {number} tenantId
+   * @param {number} saleReceiptId
+   */
+  public async getMailState(tenantId: number, saleReceiptId: number) {
+    const { SaleReceipt } = this.tenancy.models(tenantId);
+
+    const saleReceipt = await SaleReceipt.query()
+      .findById(saleReceiptId)
+      .withGraphFetched('entries.item')
+      .withGraphFetched('customer')
+      .throwIfNotFound();
+
+    const mailOptions = await this.receiptMail.getMailOptions(
+      tenantId,
+      saleReceiptId
+    );
+    return this.transformer.transform(
+      tenantId,
+      saleReceipt,
+      new GetSaleReceiptMailStateTransformer(),
+      {
+        mailOptions,
+      }
+    );
+  }
+}

packages/server/src/services/Sales/Receipts/GetSaleReceiptMailStateTransformer.ts

@@ -0,0 +1,194 @@
+import { Transformer } from '@/lib/Transformer/Transformer';
+import { ItemEntryTransformer } from '../Invoices/ItemEntryTransformer';
+
+export class GetSaleReceiptMailStateTransformer extends Transformer {
+  /**
+   * Exclude these attributes from user object.
+   * @returns {Array}
+   */
+  public excludeAttributes = (): string[] => {
+    return ['*'];
+  };
+
+  /**
+   * Included attributes.
+   * @returns {Array}
+   */
+  public includeAttributes = (): string[] => {
+    return [
+      'companyName',
+      'companyLogoUri',
+      'primaryColor',
+      'customerName',
+      'total',
+      'totalFormatted',
+      'subtotal',
+      'subtotalFormatted',
+      'receiptDate',
+      'receiptDateFormatted',
+      'closedAtDate',
+      'closedAtDateFormatted',
+      'receiptNumber',
+      'entries',
+    ];
+  };
+
+  /**
+   * Retrieves the customer name of the invoice.
+   * @returns {string}
+   */
+  protected customerName = (receipt) => {
+    return receipt.customer.displayName;
+  };
+
+  /**
+   * Retrieves the company name.
+   * @returns {string}
+   */
+  protected companyName = () => {
+    return this.context.organization.name;
+  };
+
+  /**
+   * Retrieves the company logo uri.
+   * @returns {string | null}
+   */
+  protected companyLogoUri = (receipt) => {
+    return receipt.pdfTemplate?.companyLogoUri;
+  };
+
+  /**
+   * Retrieves the primary color.
+   * @returns {string}
+   */
+  protected primaryColor = (receipt) => {
+    return receipt.pdfTemplate?.attributes?.primaryColor;
+  };
+
+  /**
+   *
+   * @param receipt
+   * @returns
+   */
+  protected total = (receipt) => {
+    return receipt.amount;
+  };
+
+  /**
+   *
+   * @param receipt
+   * @returns
+   */
+  protected totalFormatted = (receipt) => {
+    return this.formatMoney(receipt.amount, {
+      currencyCode: receipt.currencyCode,
+    });
+  };
+
+  /**
+   *
+   * @param receipt
+   * @returns
+   */
+  protected subtotal = (receipt) => {
+    return receipt.amount;
+  };
+
+  /**
+   *
+   * @param receipt
+   * @returns
+   */
+  protected subtotalFormatted = (receipt) => {
+    return this.formatMoney(receipt.amount, {
+      currencyCode: receipt.currencyCode,
+    });
+  };
+
+  /**
+   *
+   * @param receipt
+   * @returns
+   */
+  protected receiptDate = (receipt): string => {
+    return receipt.receiptDate;
+  };
+
+  /**
+   *
+   * @param {ISaleReceipt} invoice
+   * @returns {string}
+   */
+  protected receiptDateFormatted = (receipt): string => {
+    return this.formatDate(receipt.receiptDate);
+  };
+
+  /**
+   *
+   * @param receipt
+   * @returns
+   */
+  protected closedAtDate = (receipt): string => {
+    return receipt.closedAt;
+  };
+
+  /**
+   * Retrieve formatted estimate closed at date.
+   * @param {ISaleReceipt} invoice
+   * @returns {String}
+   */
+  protected closedAtDateFormatted = (receipt): string => {
+    return this.formatDate(receipt.closedAt);
+  };
+
+  /**
+   *
+   * @param invoice
+   * @returns
+   */
+  protected entries = (receipt) => {
+    return this.item(
+      receipt.entries,
+      new GetSaleReceiptEntryMailStateTransformer(),
+      {
+        currencyCode: receipt.currencyCode,
+      }
+    );
+  };
+
+  /**
+   * Merges the mail options with the invoice object.
+   */
+  public transform = (object: any) => {
+    return {
+      ...this.options.mailOptions,
+      ...object,
+    };
+  };
+}
+
+class GetSaleReceiptEntryMailStateTransformer extends ItemEntryTransformer {
+  /**
+   * Exclude these attributes from user object.
+   * @returns {Array}
+   */
+  public excludeAttributes = (): string[] => {
+    return ['*'];
+  };
+
+  public name = (entry) => {
+    return entry.item.name;
+  };
+
+  public includeAttributes = (): string[] => {
+    return [
+      'name',
+      'quantity',
+      'quantityFormatted',
+      'rate',
+      'rateFormatted',
+      'total',
+      'totalFormatted',
+    ];
+  };
+}

packages/server/src/services/Sales/Receipts/SaleReceiptApplication.ts

@@ -18,6 +18,7 @@ import { SaleReceiptsPdf } from './SaleReceiptsPdfService';
 import { SaleReceiptNotifyBySms } from './SaleReceiptNotifyBySms';
 import { SaleReceiptMailNotification } from './SaleReceiptMailNotification';
 import { GetSaleReceiptState } from './GetSaleReceiptState';
+import { GetSaleReceiptMailState } from './GetSaleReceiptMailState';
 
 @Service()
 export class SaleReceiptApplication {
@@ -51,6 +52,9 @@ export class SaleReceiptApplication {
   @Inject()
   private getSaleReceiptStateService: GetSaleReceiptState;
 
+  @Inject()
+  private getSaleReceiptMailStateService: GetSaleReceiptMailState;
+
   /**
    * Creates a new sale receipt with associated entries.
    * @param {number} tenantId
@@ -234,4 +238,20 @@ export class SaleReceiptApplication {
   public getSaleReceiptState(tenantId: number): Promise<ISaleReceiptState> {
     return this.getSaleReceiptStateService.getSaleReceiptState(tenantId);
   }
+
+  /**
+   * Retrieves the mail state of the given sale receipt.
+   * @param {number} tenantId
+   * @param {number} saleReceiptId
+   * @returns
+   */
+  public getSaleReceiptMailState(
+    tenantId: number,
+    saleReceiptId: number
+  ): Promise<ISaleReceiptState> {
+    return this.getSaleReceiptMailStateService.getMailState(
+      tenantId,
+      saleReceiptId
+    );
+  }
 }