@tomei/finance 0.4.19 → 0.4.21

package/invoice-template/index.html

@@ -22,7 +22,7 @@
                   <img src="./assets/img/logo.svg" alt="Logo" />
                 </div>
               </div>
-              <div class="tm_invoice_right tm_text_right">
+              <div class="tm_invoice_right tm_text_right tm_invoice_title">
                 <div class="tm_primary_color tm_f50 tm_text_uppercase">
                   Invoice
                 </div>
@@ -143,7 +143,7 @@
                     Credit Card - 236***********928 <br />Amount: $1732
                   </p>
                 </div>
-                <div class="tm_right_footer">
+                <div class="tm_item_total_section">
                   <table>
                     <tbody>
                       <tr>
@@ -187,23 +187,26 @@
                 </div>
               </div>
             </div>
-            <div class="tm_padd_15_20 tm_round_border">
-              <p class="tm_mb5">
-                <b class="tm_primary_color">Terms & Conditions:</b>
-              </p>
-              <ul class="tm_m0 tm_note_list tm_tnc_content">
-                <li>
-                  All claims relating to quantity or shipping errors shall be
-                  waived by Buyer unless made in writing to Seller within thirty
-                  (30) days after delivery of goods to the address stated.
-                </li>
-                <li>
-                  Delivery dates are not guaranteed and Seller has no liability
-                  for damages that may be incurred due to any delay in shipment
-                  of goods hereunder. Taxes are excluded unless otherwise
-                  stated.
-                </li>
-              </ul>
+            <div class="tm_footer_section">
+              <div class="tm_padd_15_20 tm_round_border">
+                <p class="tm_mb5">
+                  <b class="tm_primary_color">Terms & Conditions:</b>
+                </p>
+                <ul class="tm_m0 tm_note_list tm_tnc_content">
+                  <li>
+                    All claims relating to quantity or shipping errors shall be
+                    waived by Buyer unless made in writing to Seller within
+                    thirty (30) days after delivery of goods to the address
+                    stated.
+                  </li>
+                  <li>
+                    Delivery dates are not guaranteed and Seller has no
+                    liability for damages that may be incurred due to any delay
+                    in shipment of goods hereunder. Taxes are excluded unless
+                    otherwise stated.
+                  </li>
+                </ul>
+              </div>
             </div>
             <!-- .tm_note -->
           </div>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomei/finance",
-  "version": "0.4.19",
+  "version": "0.4.21",
   "description": "NestJS package for finance module",
   "main": "dist/index.js",
   "scripts": {

package/src/document/document.ts

@@ -340,7 +340,7 @@ export default class Document extends AccountSystemEntity {
     const invoiceNo = this.DocNo;
 
     // Update the invoice number and date in the HTML content
-    const invoiceContent = `
+    const invoiceTitleInfo = `
     <div class="tm_invoice_seperator tm_gray_bg"></div>
     <div class="tm_invoice_info_list">
       <p class="tm_invoice_number tm_m0">
@@ -351,10 +351,10 @@ export default class Document extends AccountSystemEntity {
       </p>
     </div>
   `;
-    const invoiceHandle = await page.$('.tm_invoice_info');
-    await invoiceHandle.evaluate((invoice, invoiceContent) => {
-      invoice.innerHTML = invoiceContent;
-    }, invoiceContent);
+    const invoiceTitleInfoHandle = await page.$('.tm_invoice_info');
+    await invoiceTitleInfoHandle.evaluate((invoice, invoiceTitleInfo) => {
+      invoice.innerHTML = invoiceTitleInfo;
+    }, invoiceTitleInfo);
 
     // Update the invoice customer detail in the HTML content
     const invoiceCustomerContent = `
@@ -435,7 +435,7 @@ export default class Document extends AccountSystemEntity {
       </tbody>
     </table>
     `;
-    const invoiceRightFooterHandle = await page.$('.tm_right_footer');
+    const invoiceRightFooterHandle = await page.$('.tm_item_total_section');
     await invoiceRightFooterHandle.evaluate(
       (invoice, invoiceRightFooterContent) => {
         invoice.innerHTML = invoiceRightFooterContent;
@@ -448,9 +448,9 @@ export default class Document extends AccountSystemEntity {
     <li>
       All payment must be made to:
       <ul>
-        <li>Bank: <b>RHB</b></li>
+        <li>Bank: <b>RHB BANK BHD</b></li>
         <li>Account Name: <b>TXG Financial Solutions Sdn Bhd</b></li>
-        <li>Account No.: <b>TBD</b></li>
+        <li>Account No.: <b>2142 13000 17954</b></li>
       </ul>
     </li>
     <li>
@@ -515,6 +515,238 @@ export default class Document extends AccountSystemEntity {
     return pdfStream;
   }
 
+  /**
+   * Returns PDF template file for receipt generation
+   *
+   * @remarks - This function is converting generated HTML into PDF
+   *
+   * @see generateReceipt - for implementation
+   *
+   * @returns {Express.Multer.File} - PDF File
+   */
+  public async DEFAULT_RECEIPT_TEMPLATE_PDF(
+    customer: FinanceCustomerBase,
+  ): Promise<Express.Multer.File> {
+    /* prepping HTML conversion by getting its URL and String */
+
+    /* todo: needs to generate HTML first before converting to PDF */
+    const templateLocation = path.resolve('./invoice-template/index.html');
+    const cssLocation = path.resolve('./invoice-template/assets/css/style.css');
+    const readFileContent = util.promisify(fs.readFile);
+    // const htmlString = await readFileContent(templateLocation, 'utf8');
+    const [htmlString] = await Promise.all([
+      readFileContent(templateLocation, 'utf8'),
+    ]);
+
+    /* converting HTML to PDF */
+    const browser = await puppeteer.launch();
+    const page = await browser.newPage();
+
+    const imagePath = path.resolve(
+      './invoice-template/assets/img/tomei-logo.svg',
+    );
+    const imageBuffer = await readFileContent(imagePath);
+    const imageDataUrl = `data:image/svg+xml;base64,${imageBuffer.toString(
+      'base64',
+    )}`;
+
+    const imgTag = `<img src="${imageDataUrl}" alt="Logo">`;
+
+    await page.setContent(htmlString);
+    await page.addStyleTag({ path: cssLocation });
+
+    // Replace the <img> tag with the new image
+    const divHandle = await page.$('.tm_logo');
+    await divHandle.evaluate((div, imgTag) => {
+      div.innerHTML = imgTag;
+    }, imgTag);
+
+    // Get the current date and recei[t] number from customer
+    const currentDate = new Date().toLocaleDateString('en-GB');
+    const receiptNo = this.DocNo;
+
+    // Change and update from invoice template title to receipt title
+    const receiptTitle = `
+    <div class="tm_primary_color tm_f50 tm_text_uppercase">
+      Receipt
+    </div>
+    `;
+    const receiptTitleHandle = await page.$('.tm_invoice_title');
+    await receiptTitleHandle.evaluate((receipt, receiptTitle) => {
+      receipt.innerHTML = receiptTitle;
+    }, receiptTitle);
+
+    // Update the receipt number and date in the HTML content
+    const receiptTitleInfo = `
+  <div class="tm_invoice_seperator tm_gray_bg"></div>
+  <div class="tm_invoice_info_list">
+    <p class="tm_invoice_number tm_m0">
+      Receipt No: <b class="tm_primary_color">${receiptNo}</b>
+    </p>
+    <p class="tm_invoice_date tm_m0">
+      Date: <b class="tm_primary_color">${currentDate}</b>
+    </p>
+  </div>
+`;
+    const receiptTitleInfoHandle = await page.$('.tm_invoice_info');
+    await receiptTitleInfoHandle.evaluate((receipt, receiptTitleInfo) => {
+      receipt.innerHTML = receiptTitleInfo;
+    }, receiptTitleInfo);
+
+    // Update the receipt customer detail in the HTML content
+    const receiptCustomerContent = `
+  <p class="tm_mb2">
+    <b class="tm_primary_color">Issued To:</b>
+  </p>
+  <p>
+    ${customer.FullName} <br />
+    ${customer.DefaultAddress.Address}, ${customer.DefaultAddress.City} <br />
+    ${customer.DefaultAddress.Country} <br />
+    ${customer.Email}
+  </p>
+  `;
+    const receiptCustomerHandle = await page.$('.tm_customer_detail');
+    await receiptCustomerHandle.evaluate((receipt, receiptCustomerContent) => {
+      receipt.innerHTML = receiptCustomerContent;
+    }, receiptCustomerContent);
+
+    // Remove the receipt Pay To details in the HTML content
+    const receiptPayToContent = ``;
+    const receiptPayToHandle = await page.$('.tm_payto_detail');
+    await receiptPayToHandle.evaluate((receipt, receiptPayToContent) => {
+      receipt.innerHTML = receiptPayToContent;
+    }, receiptPayToContent);
+
+    // Remove the receipt payment info in the HTML content
+    const receiptPaymentInfoContent = ``;
+    const receiptPaymentInfoHandle = await page.$('.tm_payment_info');
+    await receiptPaymentInfoHandle.evaluate(
+      (receipt, receiptPaymentInfoContent) => {
+        receipt.innerHTML = receiptPaymentInfoContent;
+      },
+      receiptPaymentInfoContent,
+    );
+
+    // Update the receipt right footer content in the HTML content
+    const receiptSubtotal = +this.Amount;
+    const receiptTax = 0;
+    const receiptRightFooterContent = `
+  <table>
+    <tbody>
+      <tr>
+        <td
+          class="tm_width_3 tm_primary_color tm_border_none tm_bold"
+        >
+          Subtotal
+        </td>
+        <td
+          class="tm_width_3 tm_primary_color tm_text_right tm_border_none tm_bold"
+        >
+          ${this.Currency} ${receiptSubtotal}
+        </td>
+      </tr>
+      <tr>
+        <td
+          class="tm_width_3 tm_primary_color tm_border_none tm_pt0"
+        >
+          Tax <span class="tm_ternary_color">(0%)</span>
+        </td>
+        <td
+          class="tm_width_3 tm_primary_color tm_text_right tm_border_none tm_pt0"
+        >
+          ${this.Currency} ${receiptTax}
+        </td>
+      </tr>
+      <tr class="tm_border_top tm_border_bottom">
+        <td
+          class="tm_width_3 tm_border_top_0 tm_bold tm_f16 tm_primary_color"
+        >
+          Grand Total
+        </td>
+        <td
+          class="tm_width_3 tm_border_top_0 tm_bold tm_f16 tm_primary_color tm_text_right"
+        >
+          ${this.Currency} ${receiptSubtotal + receiptTax}
+        </td>
+      </tr>
+    </tbody>
+  </table>
+  `;
+    const receiptRightFooterHandle = await page.$('.tm_item_total_section');
+    await receiptRightFooterHandle.evaluate(
+      (receipt, receiptRightFooterContent) => {
+        receipt.innerHTML = receiptRightFooterContent;
+      },
+      receiptRightFooterContent,
+    );
+
+    // Update the receipt items content in the HTML content
+    const receiptDocumentItems = await this.DocumentItems;
+
+    let receiptItemContent = ``;
+    receiptDocumentItems.forEach((documentItem, i) => {
+      receiptItemContent += `
+    <tr>
+      <td class="tm_width_3">${i + 1}. ${documentItem.Name}</td>
+      <td class="tm_width_4">
+        ${documentItem.Description}
+      </td>
+      <td class="tm_width_2">${documentItem.Currency} ${
+        documentItem.UnitPrice
+      }</td>
+      <td class="tm_width_1">${documentItem.Quantity}</td>
+      <td class="tm_width_2 tm_text_right">${documentItem.Currency} ${
+        +documentItem.UnitPrice * +documentItem.Quantity
+      }</td>
+    </tr>
+    `;
+    });
+    const receiptDocumentItemHandle = await page.$('.tm_items_content');
+    await receiptDocumentItemHandle.evaluate((receipt, receiptItemContent) => {
+      receipt.innerHTML = receiptItemContent;
+    }, receiptItemContent);
+
+    // Update the receipt Terms & Agreement content in the HTML content
+    const receiptFooterContent = `
+    <p class="tm_mb5 tm_text_center tm_f11">
+      <i>
+       Thank you for your payment. This is computer generated receipt
+       - no signature is required.
+     </i>
+   </p>
+    `;
+    const receiptFooterHandle = await page.$('.tm_footer_section');
+    await receiptFooterHandle.evaluate((receipt, receiptFooterContent) => {
+      receipt.innerHTML = receiptFooterContent;
+    }, receiptFooterContent);
+
+    const pdfBuffer = await page.pdf({
+      format: 'a4',
+      printBackground: true,
+      margin: {
+        left: '0px',
+        top: '0px',
+        right: '0px',
+        bottom: '0px',
+      },
+    });
+
+    const pdfStream: Express.Multer.File = {
+      buffer: pdfBuffer,
+      fieldname: 'FileStream',
+      originalname: 'sample-invoice.pdf',
+      mimetype: 'application/pdf',
+      size: pdfBuffer.length,
+      encoding: '8bit',
+      filename: 'sample-invoice.pdf',
+      destination: '',
+      path: '',
+      stream: null,
+    };
+
+    return pdfStream;
+  }
+
   /**
    * Returns the media representing the document in HTML format
    *
@@ -569,7 +801,7 @@ export default class Document extends AccountSystemEntity {
   }
 
   /**
-   * Returns generated HTML & PDF Media
+   * Returns generated HTML & PDF Invoice Media
    *
    * @remarks - This function also create each media element in common_Media table
    *
@@ -634,7 +866,7 @@ export default class Document extends AccountSystemEntity {
       userId ?? 'System',
     );
 
-    /*Below is commented because the current implentation flow does not add up*/
+    /*Below is commented because the current implentation flow does not add up (PLEASE DON'T DELETE)*/
     // try {
     //   const document = await this.RepositoryBase.findOne({
     //     where: {
@@ -659,6 +891,75 @@ export default class Document extends AccountSystemEntity {
     };
   }
 
+  /**
+   * Returns generated HTML & PDF Receipt Media
+   *
+   * @remarks - This function also create each media element in common_Media table
+   *
+   * @see DocumentFileInHTML - for implementation
+   *
+   * @param userId - userId that trigger this function
+   *
+   * @returns {MediasModel} - HTML & PDF Media
+   */
+  async generateReceipt(
+    userId?: string,
+    customer?: FinanceCustomerBase,
+  ): Promise<{
+    HTMLMedia: MediasModel;
+    PDFMedia: MediasModel;
+  }> {
+    const media: Medias = new Medias(
+      Document._MediaRepository,
+      this.mediaCommonService,
+    );
+
+    /* insert FileStream on htmlPayload  */
+    const htmlPayload: InternalMediaDto = {
+      ObjectId: this.DocNo,
+      ObjectType: this.DocType,
+      Type: MediaType.Document,
+      FileName: `${this.DocType}-${this.DocNo}`,
+      FileStream: await Document.DEFAULT_INVOICE_TEMPLATE_HTML(),
+      FileExtension: 'html',
+      Title: `${this.DocType}-${this.DocNo}.html`,
+      Description: `HTML ${this.DocType}`,
+      IsEncryptedYN: 'N',
+    };
+
+    /* create HTML media of the generated HTML */
+    const HTMLInvoiceMedia = await media.postInternal(
+      await Document.DEFAULT_INVOICE_TEMPLATE_HTML(),
+      htmlPayload,
+      userId ?? 'System',
+    );
+
+    /* insert FileStream on pdfPayload  */
+    const pdfPayload: InternalMediaDto = {
+      ObjectId: this.DocNo,
+      ObjectType: this.DocType,
+      Type: MediaType.Document,
+      FileName: `${this.DocType}-${this.DocNo}`,
+      FileStream: await this.DEFAULT_RECEIPT_TEMPLATE_PDF(customer),
+      FileExtension: 'pdf',
+      Title: `${this.DocType}-${this.DocNo}.pdf`,
+      Description: `PDF ${this.DocType}`,
+      IsEncryptedYN: 'N',
+    };
+
+    /* create PDF media from the converted HTML */
+    const PDFInvoiceMedia = await media.postInternal(
+      await this.DEFAULT_RECEIPT_TEMPLATE_PDF(customer),
+      pdfPayload,
+      userId ?? 'System',
+    );
+
+    return {
+      HTMLMedia: HTMLInvoiceMedia,
+      PDFMedia: PDFInvoiceMedia,
+    };
+  }
+
   async generateCreditNote(userId?: string, customer?: FinanceCustomerBase) {
     console.log(userId, customer, '<< generateCreditNote');
   }