feat: add adjustment total in estimates, invoices, and receipts pdf templates

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

@@ -1,14 +1,12 @@
 import { Inject, Service } from 'typedi';
 import { ChromiumlyTenancy } from '@/services/ChromiumlyTenancy/ChromiumlyTenancy';
-import { TemplateInjectable } from '@/services/TemplateInjectable/TemplateInjectable';
 import { GetSaleEstimate } from './GetSaleEstimate';
 import HasTenancyService from '@/services/Tenancy/TenancyService';
 import { SaleEstimatePdfTemplate } from '../Invoices/SaleEstimatePdfTemplate';
 import { transformEstimateToPdfTemplate } from './utils';
-import { EstimatePdfBrandingAttributes } from './constants';
 import events from '@/subscribers/events';
 import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
-import { renderEstimatePaperTemplateHtml } from '@bigcapital/pdf-templates';
+import { renderEstimatePaperTemplateHtml, EstimatePaperTemplateProps } from '@bigcapital/pdf-templates';
 
 @Service()
 export class SaleEstimatesPdf {
@@ -97,7 +95,7 @@ export class SaleEstimatesPdf {
   async getEstimateBrandingAttributes(
     tenantId: number,
     estimateId: number
-  ): Promise<EstimatePdfBrandingAttributes> {
+  ): Promise<EstimatePaperTemplateProps> {
     const { PdfTemplate } = this.tenancy.models(tenantId);
     const saleEstimate = await this.getSaleEstimate.getEstimate(
       tenantId,

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

@@ -1,9 +1,9 @@
+import { EstimatePaperTemplateProps } from '@bigcapital/pdf-templates';
 import { contactAddressTextFormat } from '@/utils/address-text-format';
-import { EstimatePdfBrandingAttributes } from './constants';
 
 export const transformEstimateToPdfTemplate = (
   estimate
-): Partial<EstimatePdfBrandingAttributes> => {
+): Partial<EstimatePaperTemplateProps> => {
   return {
     expirationDate: estimate.formattedExpirationDate,
     estimateNumebr: estimate.estimateNumber,
@@ -17,6 +17,7 @@ export const transformEstimateToPdfTemplate = (
     })),
     total: estimate.formattedSubtotal,
     subtotal: estimate.formattedSubtotal,
+    adjustment: estimate.adjustmentFormatted,
     customerNote: estimate.note,
     termsConditions: estimate.termsConditions,
     customerAddress: contactAddressTextFormat(estimate.customer),

packages/server/src/services/Sales/Invoices/SaleInvoicePdf.ts

@@ -1,10 +1,12 @@
 import { Inject, Service } from 'typedi';
-import { renderInvoicePaperTemplateHtml } from '@bigcapital/pdf-templates';
+import {
+  renderInvoicePaperTemplateHtml,
+  InvoicePaperTemplateProps,
+} from '@bigcapital/pdf-templates';
 import { ChromiumlyTenancy } from '@/services/ChromiumlyTenancy/ChromiumlyTenancy';
 import { GetSaleInvoice } from './GetSaleInvoice';
 import HasTenancyService from '@/services/Tenancy/TenancyService';
 import { transformInvoiceToPdfTemplate } from './utils';
-import { InvoicePdfTemplateAttributes } from '@/interfaces';
 import { SaleInvoicePdfTemplate } from './SaleInvoicePdfTemplate';
 import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
 import events from '@/subscribers/events';
@@ -100,7 +102,7 @@ export class SaleInvoicePdf {
   async getInvoiceBrandingAttributes(
     tenantId: number,
     invoiceId: number
-  ): Promise<InvoicePdfTemplateAttributes> {
+  ): Promise<InvoicePaperTemplateProps> {
     const { PdfTemplate } = this.tenancy.models(tenantId);
 
     const invoice = await this.getInvoiceService.getSaleInvoice(

packages/server/src/services/Sales/Invoices/utils.ts

@@ -1,6 +1,7 @@
 import { pickBy } from 'lodash';
-import { InvoicePdfTemplateAttributes, ISaleInvoice } from '@/interfaces';
+import { ISaleInvoice } from '@/interfaces';
 import { contactAddressTextFormat } from '@/utils/address-text-format';
+import { InvoicePaperTemplateProps } from '@bigcapital/pdf-templates';
 
 export const mergePdfTemplateWithDefaultAttributes = (
   brandingTemplate?: Record<string, any>,
@@ -18,7 +19,7 @@ export const mergePdfTemplateWithDefaultAttributes = (
 
 export const transformInvoiceToPdfTemplate = (
   invoice: ISaleInvoice
-): Partial<InvoicePdfTemplateAttributes> => {
+): Partial<InvoicePaperTemplateProps> => {
   return {
     dueDate: invoice.dueDateFormatted,
     dateIssue: invoice.invoiceDateFormatted,
@@ -29,6 +30,7 @@ export const transformInvoiceToPdfTemplate = (
     paymentMade: invoice.paymentAmountFormatted,
     dueAmount: invoice.dueAmountFormatted,
     discount: invoice.discountAmountFormatted,
+    adjustment: invoice.adjustmentFormatted,
     discountLabel: invoice.discountPercentageFormatted
       ? `Discount [${invoice.discountPercentageFormatted}]`
       : 'Discount',

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

@@ -1,13 +1,15 @@
 import { Inject, Service } from 'typedi';
 import { ChromiumlyTenancy } from '@/services/ChromiumlyTenancy/ChromiumlyTenancy';
+import {
+  renderReceiptPaperTemplateHtml,
+  ReceiptPaperTemplateProps,
+} from '@bigcapital/pdf-templates';
 import { GetSaleReceipt } from './GetSaleReceipt';
 import HasTenancyService from '@/services/Tenancy/TenancyService';
 import { SaleReceiptBrandingTemplate } from './SaleReceiptBrandingTemplate';
 import { transformReceiptToBrandingTemplateAttributes } from './utils';
-import { ISaleReceiptBrandingTemplateAttributes } from '@/interfaces';
 import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
 import events from '@/subscribers/events';
-import { renderReceiptPaperTemplateHtml } from '@bigcapital/pdf-templates';
 
 @Service()
 export class SaleReceiptsPdf {
@@ -90,12 +92,12 @@ export class SaleReceiptsPdf {
    * Retrieves receipt branding attributes.
    * @param {number} tenantId
    * @param {number} receiptId
-   * @returns {Promise<ISaleReceiptBrandingTemplateAttributes>}
+   * @returns {Promise<ReceiptPaperTemplateProps>}
    */
   public async getReceiptBrandingAttributes(
     tenantId: number,
     receiptId: number
-  ): Promise<ISaleReceiptBrandingTemplateAttributes> {
+  ): Promise<ReceiptPaperTemplateProps> {
     const { PdfTemplate } = this.tenancy.models(tenantId);
 
     const saleReceipt = await this.getSaleReceiptService.getSaleReceipt(

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

@@ -1,12 +1,10 @@
-import {
-  ISaleReceipt,
-  ISaleReceiptBrandingTemplateAttributes,
-} from '@/interfaces';
+import { ISaleReceipt } from '@/interfaces';
 import { contactAddressTextFormat } from '@/utils/address-text-format';
+import { ReceiptPaperTemplateProps } from '@bigcapital/pdf-templates';
 
 export const transformReceiptToBrandingTemplateAttributes = (
   saleReceipt: ISaleReceipt
-): Partial<ISaleReceiptBrandingTemplateAttributes> => {
+): Partial<ReceiptPaperTemplateProps> => {
   return {
     total: saleReceipt.totalFormatted,
     subtotal: saleReceipt.subtotalFormatted,
@@ -23,6 +21,7 @@ export const transformReceiptToBrandingTemplateAttributes = (
     discountLabel: saleReceipt.discountPercentageFormatted
       ? `Discount [${saleReceipt.discountPercentageFormatted}]`
       : 'Discount',
+    adjustment: saleReceipt.adjustmentFormatted,
     customerAddress: contactAddressTextFormat(saleReceipt.customer),
   };
 };