QT/bigcapital
1
0
Fork 0
mirror of https://github.com/bigcapitalhq/bigcapital.git synced 2026-02-17 13:20:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: send invoice notifications

Browse Source
This commit is contained in:
Ahmed Bouhuolia
2023-12-22 02:45:44 +02:00
parent d2c63878ed
commit 50d5ddba8e
3 changed files with 138 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
packages/server/src/services/Sales/Invoices/SaleInvoiceMailFormatter.ts
View File

@@ -1,43 +0,0 @@
import HasTenancyService from '@/services/Tenancy/TenancyService';
import { GetSaleInvoice } from './GetSaleInvoice';
import { Inject, Service } from 'typedi';
import { Tenant } from '@/system/models';
@Service()
export class SaleInvoiceMailFormatter {
@Inject()
private tenancy: HasTenancyService;
@Inject()
private getSaleInvoiceService: GetSaleInvoice;
/**
* Retrieves the formatted text of the given sale invoice.
* @param {number} tenantId - Tenant id.
* @param {number} invoiceId - Sale invoice id.
* @param {string} text - The given text.
* @returns {Promise<string>}
*/
public formatText = async (
tenantId: number,
invoiceId: number,
text: string
): Promise<string> => {
const invoice = await this.getSaleInvoiceService.getSaleInvoice(
tenantId,
invoiceId
);
const organization = await Tenant.query()
.findById(tenantId)
.withGraphFetched('metadata');
return text
.replace('{CompanyName}', organization.metadata.name)
.replace('{CustomerName}', invoice.customer.displayName)
.replace('{InvoiceNumber}', invoice.invoiceNo)
.replace('{InvoiceDueAmount}', invoice.dueAmountFormatted)
.replace('{InvoiceDueDate}', invoice.dueDateFormatted)
.replace('{InvoiceDate}', invoice.invoiceDateFormatted)
.replace('{InvoiceAmount}', invoice.totalFormatted);
};
}

107
packages/server/src/services/Sales/Invoices/SendSaleInvoiceMail.ts
View File

@@ -4,31 +4,29 @@ import { SendInvoiceMailDTO } from '@/interfaces';
import Mail from '@/lib/Mail';
import HasTenancyService from '@/services/Tenancy/TenancyService';
import { SaleInvoicePdf } from './SaleInvoicePdf';
import { SaleInvoiceMailFormatter } from './SaleInvoiceMailFormatter';
import {
DEFAULT_INVOICE_MAIL_CONTENT,
DEFAULT_INVOICE_MAIL_SUBJECT,
ERRORS,
} from './constants';
import { CommandSaleInvoiceValidators } from './CommandSaleInvoiceValidators';
import { ServiceError } from '@/exceptions';
import { formatSmsMessage } from '@/utils';
import { GetSaleInvoice } from './GetSaleInvoice';
import { Tenant } from '@/system/models';
@Service()
export class SendSaleInvoiceMail {
@Inject()
private tenancy: HasTenancyService;
@Inject('agenda')
private agenda: any;
@Inject()
private getSaleInvoiceService: GetSaleInvoice;
@Inject()
private invoicePdf: SaleInvoicePdf;
@Inject()
private invoiceFormatter: SaleInvoiceMailFormatter;
@Inject()
private commandInvoiceValidator: CommandSaleInvoiceValidators;
@Inject('agenda')
private agenda: any;
/**
* Sends the invoice mail of the given sale invoice.
@@ -49,6 +47,58 @@ export class SendSaleInvoiceMail {
await this.agenda.now('sale-invoice-mail-send', payload);
}
/**
* Retrieves the default invoice mail options.
* @param {number} tenantId
* @param {number} invoiceId
* @returns {Promise<SendInvoiceMailDTO>}
*/
public getDefaultMailOpts = async (tenantId: number, invoiceId: number) => {
const { SaleInvoice } = this.tenancy.models(tenantId);
const saleInvoice = await SaleInvoice.query()
.findById(invoiceId)
.withGraphFetched('customer')
.throwIfNotFound();
return {
attachInvoice: true,
subject: DEFAULT_INVOICE_MAIL_SUBJECT,
body: DEFAULT_INVOICE_MAIL_CONTENT,
to: saleInvoice.customer.email,
};
};
/**
* Retrieves the formatted text of the given sale invoice.
* @param {number} tenantId - Tenant id.
* @param {number} invoiceId - Sale invoice id.
* @param {string} text - The given text.
* @returns {Promise<string>}
*/
public textFormatter = async (
tenantId: number,
invoiceId: number,
text: string
): Promise<string> => {
const invoice = await this.getSaleInvoiceService.getSaleInvoice(
tenantId,
invoiceId
);
const organization = await Tenant.query()
.findById(tenantId)
.withGraphFetched('metadata');
return formatSmsMessage(text, {
CompanyName: organization.metadata.name,
CustomerName: invoice.customer.displayName,
InvoiceNumber: invoice.invoiceNo,
InvoiceDueAmount: invoice.dueAmountFormatted,
InvoiceDueDate: invoice.dueDateFormatted,
InvoiceDate: invoice.invoiceDateFormatted,
InvoiceAmount: invoice.totalFormatted,
});
};
/**
* Triggers the mail invoice.
* @param {number} tenantId
@@ -61,31 +111,20 @@ export class SendSaleInvoiceMail {
saleInvoiceId: number,
messageDTO: SendInvoiceMailDTO
) {
const { SaleInvoice } = this.tenancy.models(tenantId);
const saleInvoice = await SaleInvoice.query()
.findById(saleInvoiceId)
.withGraphFetched('customer');
this.commandInvoiceValidator.validateInvoiceExistance(saleInvoice);
const defaultMessageOpts = await this.getDefaultMailOpts(
tenantId,
saleInvoiceId
);
// Parsed message opts with default options.
const parsedMessageOpts = {
attachInvoice: true,
subject: DEFAULT_INVOICE_MAIL_SUBJECT,
body: DEFAULT_INVOICE_MAIL_CONTENT,
to: saleInvoice.customer.email,
...defaultMessageOpts,
...messageDTO,
};
// In case there is no email address from the customer or from options, throw an error.
if (!parsedMessageOpts.to) {
throw new ServiceError(ERRORS.NO_INVOICE_CUSTOMER_EMAIL_ADDR);
}
const formatter = R.curry(this.invoiceFormatter.formatText)(
tenantId,
saleInvoiceId
);
const toEmail = parsedMessageOpts.to;
const formatter = R.curry(this.textFormatter)(tenantId, saleInvoiceId);
const subject = await formatter(parsedMessageOpts.subject);
const body = await formatter(parsedMessageOpts.body);
const attachments = [];
@@ -96,17 +135,13 @@ export class SendSaleInvoiceMail {
tenantId,
saleInvoiceId
);
attachments.push({
filename: 'invoice.pdf',
content: invoicePdfBuffer,
});
attachments.push({ filename: 'invoice.pdf', content: invoicePdfBuffer });
}
const mail = new Mail()
await new Mail()
.setSubject(subject)
.setTo(toEmail)
.setTo(parsedMessageOpts.to)
.setContent(body)
.setAttachments(attachments);
await mail.send();
.setAttachments(attachments)
.send();
}
}

99
packages/server/src/services/Sales/Invoices/SendSaleInvoiceMailReminder.ts
View File

@@ -1,11 +1,8 @@
import { Inject, Service } from 'typedi';
import * as R from 'ramda';
import { assign } from 'lodash';
import { SendInvoiceMailDTO } from '@/interfaces';
import Mail from '@/lib/Mail';
import HasTenancyService from '@/services/Tenancy/TenancyService';
import { CommandSaleInvoiceValidators } from './CommandSaleInvoiceValidators';
import { SaleInvoiceMailFormatter } from './SaleInvoiceMailFormatter';
import {
DEFAULT_INVOICE_REMINDER_MAIL_CONTENT,
DEFAULT_INVOICE_REMINDER_MAIL_SUBJECT,
@@ -13,6 +10,9 @@ import {
} from './constants';
import { SaleInvoicePdf } from './SaleInvoicePdf';
import { ServiceError } from '@/exceptions';
import { GetSaleInvoice } from './GetSaleInvoice';
import { Tenant } from '@/system/models';
import { formatSmsMessage } from '@/utils';
@Service()
export class SendInvoiceMailReminder {
@@ -22,15 +22,12 @@ export class SendInvoiceMailReminder {
@Inject('agenda')
private agenda: any;
@Inject()
private commandInvoiceValidator: CommandSaleInvoiceValidators;
@Inject()
private invoiceFormatter: SaleInvoiceMailFormatter;
@Inject()
private invoicePdf: SaleInvoicePdf;
@Inject()
private getSaleInvoiceService: GetSaleInvoice;
/**
* Triggers the reminder mail of the given sale invoice.
* @param {number} tenantId
@@ -49,6 +46,59 @@ export class SendInvoiceMailReminder {
await this.agenda.now('sale-invoice-reminder-mail-send', payload);
}
/**
* Parses the default message options.
* @param {number} tenantId
* @param {number} invoiceId
* @returns {Promise<SendInvoiceMailDTO>}
*/
public async getDefaultMailOpts(tenantId: number, invoiceId: number) {
const { SaleInvoice } = this.tenancy.models(tenantId);
const saleInvoice = await SaleInvoice.query()
.findById(invoiceId)
.withGraphFetched('customer')
.throwIfNotFound();
return {
attachInvoice: true,
subject: DEFAULT_INVOICE_REMINDER_MAIL_SUBJECT,
body: DEFAULT_INVOICE_REMINDER_MAIL_CONTENT,
to: saleInvoice.customer.email,
};
}
/**
* Retrieves the formatted text of the given sale invoice.
* @param {number} tenantId - Tenant id.
* @param {number} invoiceId - Sale invoice id.
* @param {string} text - The given text.
* @returns {Promise<string>}
*/
public formatText = async (
tenantId: number,
invoiceId: number,
text: string
): Promise<string> => {
const invoice = await this.getSaleInvoiceService.getSaleInvoice(
tenantId,
invoiceId
);
const organization = await Tenant.query()
.findById(tenantId)
.withGraphFetched('metadata');
return formatSmsMessage(text, {
CompanyName: organization.metadata.name,
CustomerName: invoice.customer.displayName,
InvoiceNumber: invoice.invoiceNo,
InvoiceDueAmount: invoice.dueAmountFormatted,
InvoiceDueDate: invoice.dueDateFormatted,
InvoiceDate: invoice.invoiceDateFormatted,
InvoiceAmount: invoice.totalFormatted,
});
};
/**
* Triggers the mail invoice.
* @param {number} tenantId
@@ -61,31 +111,19 @@ export class SendInvoiceMailReminder {
saleInvoiceId: number,
messageOptions: SendInvoiceMailDTO
) {
const { SaleInvoice } = this.tenancy.models(tenantId);
const saleInvoice = await SaleInvoice.query()
.findById(saleInvoiceId)
.withGraphFetched('customer');
// Validates the invoice existance.
this.commandInvoiceValidator.validateInvoiceExistance(saleInvoice);
const defaultMessageOpts = await this.getDefaultMailOpts(
tenantId,
saleInvoiceId
);
const parsedMessageOptions = {
attachInvoice: true,
subject: DEFAULT_INVOICE_REMINDER_MAIL_SUBJECT,
body: DEFAULT_INVOICE_REMINDER_MAIL_CONTENT,
to: saleInvoice.customer.email,
...defaultMessageOpts,
...messageOptions,
};
// In case there is no email address from the customer or from options, throw an error.
if (!parsedMessageOptions.to) {
throw new ServiceError(ERRORS.NO_INVOICE_CUSTOMER_EMAIL_ADDR);
}
const formatter = R.curry(this.invoiceFormatter.formatText)(
tenantId,
saleInvoiceId
);
const toEmail = parsedMessageOptions.to;
const formatter = R.curry(this.formatText)(tenantId, saleInvoiceId);
const subject = await formatter(parsedMessageOptions.subject);
const body = await formatter(parsedMessageOptions.body);
const attachments = [];
@@ -96,14 +134,11 @@ export class SendInvoiceMailReminder {
tenantId,
saleInvoiceId
);
attachments.push({
filename: 'invoice.pdf',
content: invoicePdfBuffer,
});
attachments.push({ filename: 'invoice.pdf', content: invoicePdfBuffer });
}
const mail = new Mail()
.setSubject(subject)
.setTo(toEmail)
.setTo(parsedMessageOptions.to)
.setContent(body)
.setAttachments(attachments);