Merge pull request #292 from bigcapitalhq/big-83-send-an-invoice-to-t…

…he-customer-email

feat: Send mail notifications of the sales transactions

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

@@ -1,10 +1,11 @@
 import { Inject, Service } from 'typedi';
 import { Router, Request, Response, NextFunction } from 'express';
-import { check, param, query, ValidationChain } from 'express-validator';
+import { body, check, param, query, ValidationChain } from 'express-validator';
 import {
  AbilitySubject,
  IPaymentReceiveDTO,
  PaymentReceiveAction,
+ PaymentReceiveMailOptsDTO,
 } from '@/interfaces';
 import BaseController from '@/api/controllers/BaseController';
 import asyncMiddleware from '@/api/middleware/asyncMiddleware';
@@ -117,6 +118,25 @@ export default class PaymentReceivesController extends BaseController {
  asyncMiddleware(this.deletePaymentReceive.bind(this)),
  this.handleServiceErrors
  );
+ router.post(
+ '/:id/mail',
+ [
+ ...this.paymentReceiveValidation,
+ body('subject').isString().optional(),
+ body('from').isString().optional(),
+ body('to').isString().optional(),
+ body('body').isString().optional(),
+ body('attach_invoice').optional().isBoolean().toBoolean(),
+ ],
+ this.sendPaymentReceiveByMail.bind(this),
+ this.handleServiceErrors
+ );
+ router.get(
+ '/:id/mail',
+ [...this.paymentReceiveValidation],
+ asyncMiddleware(this.getPaymentDefaultMail.bind(this)),
+ this.handleServiceErrors
+ );
  return router;
  }
 
@@ -416,27 +436,26 @@ export default class PaymentReceivesController extends BaseController {
  const { id: paymentReceiveId } = req.params;
 
  try {
- const paymentReceive =
- await this.paymentReceiveApplication.getPaymentReceive(
- tenantId,
- paymentReceiveId
- );
-
  const ACCEPT_TYPE = {
  APPLICATION_PDF: 'application/pdf',
  APPLICATION_JSON: 'application/json',
  };
  res.format({
- [ACCEPT_TYPE.APPLICATION_JSON]: () => {
+ [ACCEPT_TYPE.APPLICATION_JSON]: async () => {
+ const paymentReceive =
+ await this.paymentReceiveApplication.getPaymentReceive(
+ tenantId,
+ paymentReceiveId
+ );
  return res.status(200).send({
- payment_receive: this.transfromToResponse(paymentReceive),
+ payment_receive: paymentReceive,
  });
  },
  [ACCEPT_TYPE.APPLICATION_PDF]: async () => {
  const pdfContent =
  await this.paymentReceiveApplication.getPaymentReceivePdf(
  tenantId,
- paymentReceive
+ paymentReceiveId
  );
  res.set({
  'Content-Type': 'application/pdf',
@@ -507,14 +526,74 @@ export default class PaymentReceivesController extends BaseController {
  }
  };
 
+ /**
+ * Sends mail invoice of the given sale invoice.
+ * @param {Request} req
+ * @param {Response} res
+ * @param {NextFunction} next
+ * @returns
+ */
+ public sendPaymentReceiveByMail = async (
+ req: Request,
+ res: Response,
+ next: NextFunction
+ ) => {
+ const { tenantId } = req;
+ const { id: paymentReceiveId } = req.params;
+ const paymentMailDTO: PaymentReceiveMailOptsDTO = this.matchedBodyData(
+ req,
+ {
+ includeOptionals: false,
+ }
+ );
+ try {
+ await this.paymentReceiveApplication.notifyPaymentByMail(
+ tenantId,
+ paymentReceiveId,
+ paymentMailDTO
+ );
+ return res.status(200).send({
+ code: 200,
+ message: 'The payment notification has been sent successfully.',
+ });
+ } catch (error) {
+ next(error);
+ }
+ };
+
+ /**
+ * Retrieves the default mail options of the given payment transaction.
+ * @param {Request} req
+ * @param {Response} res
+ * @param {NextFunction} next
+ */
+ public getPaymentDefaultMail = async (
+ req: Request,
+ res: Response,
+ next: NextFunction
+ ) => {
+ const { tenantId } = req;
+ const { id: paymentReceiveId } = req.params;
+
+ try {
+ const data = await this.paymentReceiveApplication.getPaymentMailOptions(
+ tenantId,
+ paymentReceiveId
+ );
+ return res.status(200).send({ data });
+ } catch (error) {
+ next(error);
+ }
+ };
+
  /**
  * Handles service errors.
  * @param error
  * @param req
  * @param res
  * @param next
  */
- handleServiceErrors(
+ private handleServiceErrors(
  error: Error,
  req: Request,
  res: Response,

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

@@ -1,10 +1,11 @@
 import { Router, Request, Response, NextFunction } from 'express';
-import { check, param, query } from 'express-validator';
+import { body, check, param, query } from 'express-validator';
 import { Inject, Service } from 'typedi';
 import {
  AbilitySubject,
  ISaleEstimateDTO,
  SaleEstimateAction,
+ SaleEstimateMailOptionsDTO,
 } from '@/interfaces';
 import BaseController from '@/api/controllers/BaseController';
 import asyncMiddleware from '@/api/middleware/asyncMiddleware';
@@ -121,6 +122,27 @@ export default class SalesEstimatesController extends BaseController {
  this.handleServiceErrors,
  this.dynamicListService.handlerErrorsToResponse
  );
+ router.post(
+ '/:id/mail',
+ [
+ ...this.validateSpecificEstimateSchema,
+ body('subject').isString().optional(),
+ body('from').isString().optional(),
+ body('to').isString().optional(),
+ body('body').isString().optional(),
+ body('attach_invoice').optional().isBoolean().toBoolean(),
+ ],
+ this.validationResult,
+ asyncMiddleware(this.sendSaleEstimateMail.bind(this)),
+ this.handleServiceErrors
+ );
+ router.get(
+ '/:id/mail',
+ [...this.validateSpecificEstimateSchema],
+ this.validationResult,
+ asyncMiddleware(this.getSaleEstimateMail.bind(this)),
+ this.handleServiceErrors
+ );
  return router;
  }
 
@@ -362,22 +384,22 @@ export default class SalesEstimatesController extends BaseController {
  const { tenantId } = req;
 
  try {
- const estimate = await this.saleEstimatesApplication.getSaleEstimate(
- tenantId,
- estimateId
- );
  // Response formatter.
  res.format({
  // JSON content type.
- [ACCEPT_TYPE.APPLICATION_JSON]: () => {
- return res.status(200).send(this.transfromToResponse({ estimate }));
+ [ACCEPT_TYPE.APPLICATION_JSON]: async () => {
+ const estimate = await this.saleEstimatesApplication.getSaleEstimate(
+ tenantId,
+ estimateId
+ );
+ return res.status(200).send({ estimate });
  },
  // PDF content type.
  [ACCEPT_TYPE.APPLICATION_PDF]: async () => {
  const pdfContent =
  await this.saleEstimatesApplication.getSaleEstimatePdf(
  tenantId,
- estimate
+ estimateId
  );
  res.set({
  'Content-Type': 'application/pdf',
@@ -478,6 +500,65 @@ export default class SalesEstimatesController extends BaseController {
  }
  };
 
+ /**
+ * Send the sale estimate mail.
+ * @param {Request} req
+ * @param {Response} res
+ * @param {NextFunction} next
+ */
+ private sendSaleEstimateMail = async (
+ req: Request,
+ res: Response,
+ next: NextFunction
+ ) => {
+ const { tenantId } = req;
+ const { id: invoiceId } = req.params;
+ const saleEstimateDTO: SaleEstimateMailOptionsDTO = this.matchedBodyData(
+ req,
+ {
+ includeOptionals: false,
+ }
+ );
+ try {
+ await this.saleEstimatesApplication.sendSaleEstimateMail(
+ tenantId,
+ invoiceId,
+ saleEstimateDTO
+ );
+ return res.status(200).send({
+ code: 200,
+ message: 'The sale estimate mail has been sent successfully.',
+ });
+ } catch (error) {
+ next(error);
+ }
+ };
+
+ /**
+ * Retrieves the default mail options of the given sale estimate.
+ * @param {Request} req
+ * @param {Response} res
+ * @param {NextFunction} next
+ */
+ private getSaleEstimateMail = async (
+ req: Request,
+ res: Response,
+ next: NextFunction
+ ) => {
+ const { tenantId } = req;
+ const { id: invoiceId } = req.params;
+
+ try {
+ const data = await this.saleEstimatesApplication.getSaleEstimateMail(
+ tenantId,
+ invoiceId
+ );
+ return res.status(200).send({ data });
+ } catch (error) {
+ next(error);
+ }
+ };
+
  /**
  * Handles service errors.
  * @param {Error} error