feat: wip send estimate mail preview

packages/server/src/api/controllers/Sales/SalesEstimates.ts

@@ -140,10 +140,10 @@ export default class SalesEstimatesController extends BaseController {
       this.handleServiceErrors
     );
     router.get(
-      '/:id/mail',
+      '/:id/mail/state',
       [...this.validateSpecificEstimateSchema],
       this.validationResult,
-      asyncMiddleware(this.getSaleEstimateMail.bind(this)),
+      asyncMiddleware(this.getSaleEstimateMailState.bind(this)),
       this.handleServiceErrors
     );
     return router;
@@ -540,18 +540,18 @@ export default class SalesEstimatesController extends BaseController {
    * @param {Response} res
    * @param {NextFunction} next
    */
-  private getSaleEstimateMail = async (
-    req: Request,
+  private getSaleEstimateMailState = async (
+    req: Request<{ id: number }>,
     res: Response,
     next: NextFunction
   ) => {
     const { tenantId } = req;
-    const { id: invoiceId } = req.params;
+    const { id: estimateId } = req.params;
 
     try {
-      const data = await this.saleEstimatesApplication.getSaleEstimateMail(
+      const data = await this.saleEstimatesApplication.getSaleEstimateMailState(
         tenantId,
-        invoiceId
+        estimateId
       );
       return res.status(200).send({ data });
     } catch (error) {

packages/server/src/models/SaleEstimate.ts

@@ -184,6 +184,7 @@ export default class SaleEstimate extends mixin(TenantModel, [
     const Branch = require('models/Branch');
     const Warehouse = require('models/Warehouse');
     const Document = require('models/Document');
+    const { PdfTemplate } = require('models/PdfTemplate');
 
     return {
       customer: {
@@ -252,6 +253,18 @@ export default class SaleEstimate extends mixin(TenantModel, [
           query.where('model_ref', 'SaleEstimate');
         },
       },
+
+      /**
+       * Sale estimate may belongs to pdf branding template.
+       */
+      pdfTemplate: {
+        relation: Model.BelongsToOneRelation,
+        modelClass: PdfTemplate,
+        join: {
+          from: 'sales_estimates.pdfTemplateId',
+          to: 'pdf_templates.id',
+        },
+      },
     };
   }
 

packages/server/src/services/Sales/Estimates/GetSaleEstimateMailState.ts

@@ -0,0 +1,51 @@
+import { Inject } from 'typedi';
+import { SendSaleEstimateMail } from './SendSaleEstimateMail';
+import HasTenancyService from '@/services/Tenancy/TenancyService';
+import { GetSaleEstimateMailStateTransformer } from './GetSaleEstimateMailStateTransformer';
+import { TransformerInjectable } from '@/lib/Transformer/TransformerInjectable';
+
+export class GetSaleEstimateMailState {
+  @Inject()
+  private estimateMail: SendSaleEstimateMail;
+
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  @Inject()
+  private transformer: TransformerInjectable;
+
+  /**
+   * Retrieves the estimate mail state of the given sale estimate.
+   * Estimate mail state includes the mail options, branding attributes and the estimate details.
+   * @param {number} tenantId
+   * @param {number} saleEstimateId
+   * @returns {Promise<SaleEstimateMailState>}
+   */
+  async getEstimateMailState(
+    tenantId: number,
+    saleEstimateId: number
+  ): Promise<SaleEstimateMailState> {
+    const { SaleEstimate } = this.tenancy.models(tenantId);
+
+    const saleEstimate = await SaleEstimate.query()
+      .findById(saleEstimateId)
+      .withGraphFetched('customer')
+      .withGraphFetched('entries.item')
+      .withGraphFetched('pdfTemplate')
+      .throwIfNotFound();
+
+    const mailOptions = await this.estimateMail.getMailOptions(
+      tenantId,
+      saleEstimateId
+    );
+    const transformed = await this.transformer.transform(
+      tenantId,
+      saleEstimate,
+      new GetSaleEstimateMailStateTransformer(),
+      {
+        mailOptions,
+      }
+    );
+    return transformed;
+  }
+}

packages/server/src/services/Sales/Estimates/GetSaleEstimateMailStateTransformer.ts

@@ -0,0 +1,105 @@
+import { ItemEntryTransformer } from '../Invoices/ItemEntryTransformer';
+import { SaleEstimateTransfromer } from './SaleEstimateTransformer';
+
+export class GetSaleEstimateMailStateTransformer extends SaleEstimateTransfromer {
+  public excludeAttributes = (): string[] => {
+    return ['*'];
+  };
+
+  public includeAttributes = (): string[] => {
+    return [
+      'estimateDate',
+      'formattedEstimateDate',
+
+      'total',
+      'totalFormatted',
+
+      'subtotal',
+      'subtotalFormatted',
+
+      'estimateNo',
+
+      'entries',
+
+      'companyName',
+      'companyLogoUri',
+
+      'primaryColor',
+      'customerName',
+    ];
+  };
+
+  /**
+   * Retrieves the customer name of the invoice.
+   * @returns {string}
+   */
+  protected customerName = (invoice) => {
+    return invoice.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 = (invoice) => {
+    return invoice.pdfTemplate?.companyLogoUri;
+  };
+
+  /**
+   * Retrieves the primary color.
+   * @returns {string}
+   */
+  protected primaryColor = (invoice) => {
+    return invoice.pdfTemplate?.attributes?.primaryColor;
+  };
+
+  /**
+   *
+   * @param invoice
+   * @returns
+   */
+  protected entries = (invoice) => {
+    return this.item(
+      invoice.entries,
+      new GetSaleEstimateMailStateEntryTransformer(),
+      {
+        currencyCode: invoice.currencyCode,
+      }
+    );
+  };
+
+  /**
+   * Merges the mail options with the invoice object.
+   */
+  public transform = (object: any) => {
+    return {
+      ...this.options.mailOptions,
+      ...object,
+    };
+  };
+}
+
+class GetSaleEstimateMailStateEntryTransformer extends ItemEntryTransformer {
+  public excludeAttributes = (): string[] => {
+    return ['*'];
+  };
+
+  public includeAttributes = (): string[] => {
+    return [
+      'description',
+      'quantity',
+      'unitPrice',
+      'unitPriceFormatted',
+      'total',
+      'totalFormatted',
+    ];
+  };
+}

packages/server/src/services/Sales/Estimates/SaleEstimatesApplication.ts

@@ -21,6 +21,7 @@ import { SaleEstimateNotifyBySms } from './SaleEstimateSmsNotify';
 import { SaleEstimatesPdf } from './SaleEstimatesPdf';
 import { SendSaleEstimateMail } from './SendSaleEstimateMail';
 import { GetSaleEstimateState } from './GetSaleEstimateState';
+import { GetSaleEstimateMailState } from './GetSaleEstimateMailState';
 
 @Service()
 export class SaleEstimatesApplication {
@@ -57,6 +58,9 @@ export class SaleEstimatesApplication {
   @Inject()
   private sendEstimateMailService: SendSaleEstimateMail;
 
+  @Inject()
+  private getSaleEstimateMailStateService: GetSaleEstimateMailState;
+
   @Inject()
   private getSaleEstimateStateService: GetSaleEstimateState;
 
@@ -250,6 +254,22 @@ export class SaleEstimatesApplication {
     );
   }
 
+  /**
+   * Retrieves the sale estimate mail state.
+   * @param {number} tenantId
+   * @param {number} saleEstimateId
+   * @returns {Promise<SaleEstimateMailOptions>}
+   */
+  public getSaleEstimateMailState(
+    tenantId: number,
+    saleEstimateId: number
+  ): Promise<SaleEstimateMailOptions> {
+    return this.getSaleEstimateMailStateService.getEstimateMailState(
+      tenantId,
+      saleEstimateId
+    );
+  }
+
   /**
    * Retrieves the default mail options of the given sale estimate.
    * @param {number} tenantId