feat: Hook up customer/company address to pdf templates

packages/server/src/services/CreditNotes/CreditNoteBrandingTemplate.ts

@@ -1,26 +1,44 @@
-import { Inject } from "typedi";
-import { GetPdfTemplate } from "../PdfTemplate/GetPdfTemplate";
-import { defaultCreditNoteBrandingAttributes } from "./constants";
-import { mergePdfTemplateWithDefaultAttributes } from "../Sales/Invoices/utils";
+import { Inject } from 'typedi';
+import { GetPdfTemplate } from '../PdfTemplate/GetPdfTemplate';
+import { defaultCreditNoteBrandingAttributes } from './constants';
+import { mergePdfTemplateWithDefaultAttributes } from '../Sales/Invoices/utils';
+import { GetOrganizationBrandingAttributes } from '../PdfTemplate/GetOrganizationBrandingAttributes';
 
 export class CreditNoteBrandingTemplate {
   @Inject()
   private getPdfTemplateService: GetPdfTemplate;
 
+  @Inject()
+  private getOrgBrandingAttributes: GetOrganizationBrandingAttributes;
+
   /**
    * Retrieves the credit note branding template.
-   * @param {number} tenantId 
-   * @param {number} templateId 
+   * @param {number} tenantId
+   * @param {number} templateId
    * @returns {}
    */
-  public async getCreditNoteBrandingTemplate(tenantId: number, templateId: number) {
+  public async getCreditNoteBrandingTemplate(
+    tenantId: number,
+    templateId: number
+  ) {
     const template = await this.getPdfTemplateService.getPdfTemplate(
       tenantId,
       templateId
     );
+    // Retrieves the organization branding attributes.
+    const commonOrgBrandingAttrs =
+      await this.getOrgBrandingAttributes.getOrganizationBrandingAttributes(
+        tenantId
+      );
+    // Merges the default branding attributes with common organization branding attrs.
+    const organizationBrandingAttrs = {
+      ...defaultCreditNoteBrandingAttributes,
+      ...commonOrgBrandingAttrs,
+    };
+
     const attributes = mergePdfTemplateWithDefaultAttributes(
       template.attributes,
-      defaultCreditNoteBrandingAttributes
+      organizationBrandingAttrs
     );
     return {
       ...template,

packages/server/src/services/CreditNotes/GetCreditNotePdf.ts

@@ -34,8 +34,6 @@ export default class GetCreditNotePdf {
       tenantId,
       creditNoteId
     );
-    console.log(brandingAttributes, 'brandingAttributes');
-
     const htmlContent = await this.templateInjectable.render(
       tenantId,
       'modules/credit-note-standard',

packages/server/src/services/CreditNotes/constants.ts

@@ -80,24 +80,13 @@ export const defaultCreditNoteBrandingAttributes = {
   // # Company name
   companyName: 'Bigcapital Technology, Inc.',
 
-  // Address
-  billedToAddress: [
-    'Bigcapital Technology, Inc.',
-    '131 Continental Dr Suite 305 Newark,',
-    'Delaware 19713',
-    'United States',
-    '+1 762-339-5634',
-    'ahmed@bigcapital.app',
-  ],
-  billedFromAddress: [
-    '131 Continental Dr Suite 305 Newark,',
-    'Delaware 19713',
-    'United States',
-    '+1 762-339-5634',
-    'ahmed@bigcapital.app',
-  ],
-  showBilledToAddress: true,
-  showBilledFromAddress: true,
+  // # Customer address
+  showCustomerAddress: true,
+  customerAddress: '',
+
+  // # Company address
+  showCompanyAddress: true,
+  companyAddress: '',
   billedToLabel: 'Billed To',
 
   // Total

packages/server/src/services/CreditNotes/utils.ts

@@ -1,4 +1,5 @@
 import { CreditNotePdfTemplateAttributes, ICreditNote } from '@/interfaces';
+import { contactAddressTextFormat } from '@/utils/address-text-format';
 
 export const transformCreditNoteToPdfTemplate = (
   creditNote: ICreditNote
@@ -19,5 +20,6 @@ export const transformCreditNoteToPdfTemplate = (
     })),
     customerNote: creditNote.note,
     termsConditions: creditNote.termsConditions,
+    customerAddress: contactAddressTextFormat(creditNote.customer),
   };
 };

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

@@ -231,7 +231,6 @@ export const defaultEstimatePdfBrandingAttributes = {
   expirationDate: 'September 3, 2024',
 };
 
-
 interface EstimatePdfBrandingLineItem {
   item: string;
   description: string;
@@ -247,10 +246,13 @@ export interface EstimatePdfBrandingAttributes {
   companyLogo: string;
   companyName: string;
 
-  billedToAddress: string[];
-  billedFromAddress: string[];
-  showBilledFromAddress: boolean;
-  showBilledToAddress: boolean;
+  // Customer Address
+  showCustomerAddress: boolean;
+  customerAddress: string;
+
+  // Company Address
+  showCompanyAddress: boolean;
+  companyAddress: string;
   billedToLabel: string;
 
   total: string;
@@ -282,4 +284,4 @@ export interface EstimatePdfBrandingAttributes {
   expirationDateLabel: string;
   showExpirationDate: boolean;
   expirationDate: string;
-}
+}

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

@@ -1,3 +1,4 @@
+import { contactAddressTextFormat } from '@/utils/address-text-format';
 import { EstimatePdfBrandingAttributes } from './constants';
 
 export const transformEstimateToPdfTemplate = (
@@ -18,5 +19,6 @@ export const transformEstimateToPdfTemplate = (
     subtotal: estimate.formattedSubtotal,
     customerNote: estimate.customerNote,
     termsConditions: estimate.termsConditions,
+    customerAddress: contactAddressTextFormat(estimate.customer),
   };
 };

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

@@ -28,7 +28,7 @@ export class SaleEstimatePdfTemplate {
       await this.getOrgBrandingAttrs.getOrganizationBrandingAttributes(
         tenantId
       );
-
+    // Merge the default branding attributes with organization attrs.
     const orgainizationBrandingAttrs = {
       ...defaultEstimatePdfBrandingAttributes,
       ...commonOrgBrandingAttrs,

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

@@ -1,5 +1,6 @@
 import { pickBy } from 'lodash';
 import { InvoicePdfTemplateAttributes, ISaleInvoice } from '@/interfaces';
+import { contactAddressTextFormat } from '@/utils/address-text-format';
 
 export const mergePdfTemplateWithDefaultAttributes = (
   brandingTemplate?: Record<string, any>,
@@ -42,5 +43,7 @@ export const transformInvoiceToPdfTemplate = (
       label: tax.name,
       amount: tax.taxRateAmountFormatted,
     })),
+
+    customerAddress: contactAddressTextFormat(invoice.customer),
   };
 };

packages/server/src/services/Sales/PaymentReceived/PaymentReceivedBrandingTemplate.ts

@@ -3,12 +3,18 @@ import { Inject, Service } from 'typedi';
 import { mergePdfTemplateWithDefaultAttributes } from '../Invoices/utils';
 import { defaultPaymentReceivedPdfTemplateAttributes } from './constants';
 import { PdfTemplate } from '@/models/PdfTemplate';
+import { GetOrganizationBrandingAttributes } from '@/services/PdfTemplate/GetOrganizationBrandingAttributes';
 
 @Service()
 export class PaymentReceivedBrandingTemplate {
   @Inject()
   private getPdfTemplateService: GetPdfTemplate;
 
+
+  @Inject()
+  private getOrgBrandingAttributes: GetOrganizationBrandingAttributes;
+
+
   /**
    * Retrieves the payment received pdf template.
    * @param {number} tenantId 
@@ -23,9 +29,16 @@ export class PaymentReceivedBrandingTemplate {
       tenantId,
       paymentTemplateId
     );
+    // Retrieves the organization branding attributes.
+    const commonOrgBrandingAttrs = this.getOrgBrandingAttributes.getOrganizationBrandingAttributes(tenantId);
+
+    const organizationBrandingAttrs = {
+      ...defaultPaymentReceivedPdfTemplateAttributes,
+      ...commonOrgBrandingAttrs,
+    };
     const attributes = mergePdfTemplateWithDefaultAttributes(
       template.attributes,
-      defaultPaymentReceivedPdfTemplateAttributes
+      organizationBrandingAttrs 
     );
     return {
       ...template,

packages/server/src/services/Sales/PaymentReceived/constants.ts

@@ -58,24 +58,13 @@ export const defaultPaymentReceivedPdfTemplateAttributes = {
   // # Company name
   companyName: 'Bigcapital Technology, Inc.',
 
-  // Address
-  billedToAddress: [
-    'Bigcapital Technology, Inc.',
-    '131 Continental Dr Suite 305 Newark,',
-    'Delaware 19713',
-    'United States',
-    '+1 762-339-5634',
-    'ahmed@bigcapital.app',
-  ],
-  billedFromAddress: [
-    '131 Continental Dr Suite 305 Newark,',
-    'Delaware 19713',
-    'United States',
-    '+1 762-339-5634',
-    'ahmed@bigcapital.app',
-  ],
-  showBilledFromAddress: true,
-  showBillingToAddress: true,
+  // # Customer address
+  showCustomerAddress: true,
+  customerAddress: '',
+
+  // # Company address
+  showCompanyAddress: true,
+  companyAddress: '',
   billedToLabel: 'Billed To',
 
   // Total

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

@@ -2,6 +2,7 @@ import {
   IPaymentReceived,
   PaymentReceivedPdfTemplateAttributes,
 } from '@/interfaces';
+import { contactAddressTextFormat } from '@/utils/address-text-format';
 
 export const transformPaymentReceivedToPdfTemplate = (
   payment: IPaymentReceived
@@ -17,5 +18,6 @@ export const transformPaymentReceivedToPdfTemplate = (
       invoiceAmount: entry.invoice.totalFormatted,
       paidAmount: entry.paymentAmountFormatted,
     })),
+    customerAddress: contactAddressTextFormat(payment.customer),
   };
 };

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

@@ -2,12 +2,15 @@ import { GetPdfTemplate } from '@/services/PdfTemplate/GetPdfTemplate';
 import { Inject, Service } from 'typedi';
 import { defaultSaleReceiptBrandingAttributes } from './constants';
 import { mergePdfTemplateWithDefaultAttributes } from '../Invoices/utils';
+import { GetOrganizationBrandingAttributes } from '@/services/PdfTemplate/GetOrganizationBrandingAttributes';
 
 @Service()
 export class SaleReceiptBrandingTemplate {
   @Inject()
   private getPdfTemplateService: GetPdfTemplate;
 
+  @Inject()
+  private getOrgBrandingAttributes: GetOrganizationBrandingAttributes;
 
   /**
    * Retrieves the sale receipt branding template.
@@ -23,9 +26,20 @@ export class SaleReceiptBrandingTemplate {
       tenantId,
       templateId
     );
+    // Retrieves the organization branding attributes.
+    const commonOrgBrandingAttrs =
+      await this.getOrgBrandingAttributes.getOrganizationBrandingAttributes(
+        tenantId
+      );
+
+    // Merges the default branding attributes with organization common branding attrs.
+    const organizationBrandingAttrs = {
+      ...defaultSaleReceiptBrandingAttributes,
+      ...commonOrgBrandingAttrs,
+    };
     const attributes = mergePdfTemplateWithDefaultAttributes(
       template.attributes,
-      defaultSaleReceiptBrandingAttributes
+      organizationBrandingAttrs
     );
     return {
       ...template,

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

@@ -76,26 +76,16 @@ export const defaultSaleReceiptBrandingAttributes = {
   companyLogoUri: '',
   companyLogoKey: '',
 
-  // # Address
-  billedToAddress: [
-    'Bigcapital Technology, Inc.',
-    '131 Continental Dr Suite 305 Newark,',
-    'Delaware 19713',
-    'United States',
-    '+1 762-339-5634',
-    'ahmed@bigcapital.app',
-  ],
-  billedFromAddress: [
-    '131 Continental Dr Suite 305 Newark,',
-    'Delaware 19713',
-    'United States',
-    '+1 762-339-5634',
-    'ahmed@bigcapital.app',
-  ],
-  showBilledFromAddress: true,
-  showBilledToAddress: true,
+  // # Customer address
+  showCustomerAddress: true,
+  customerAddress: '',
+
+  // # Company address
+  showCompanyAddress: true,
+  companyAddress: '',
   billedToLabel: 'Billed To',
 
+  // # Total
   total: '$1000.00',
   totalLabel: 'Total',
   showTotal: true,

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

@@ -1,4 +1,5 @@
 import { ISaleReceipt, ISaleReceiptBrandingTemplateAttributes } from "@/interfaces";
+import { contactAddressTextFormat } from "@/utils/address-text-format";
 
 
 
@@ -13,8 +14,8 @@ export const transformReceiptToBrandingTemplateAttributes = (saleReceipt: ISaleR
       quantity: entry.quantityFormatted,
       total: entry.totalFormatted,
     })),
-
     receiptNumber: saleReceipt.receiptNumber,
     receiptDate: saleReceipt.formattedReceiptDate,
+    customerAddress: contactAddressTextFormat(saleReceipt.customer),
   };
 }