@gov-cy/dsf-email-templates 2.0.1 → 2.0.2

package/CHANGELOG.md

@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [v2.0.2] - 2024-05-01
+
+### Changed 
+- `dsf-email-templater` use `fs/promises` to load and save files
+- `mailtrap-njk` use `fs/promises` to load files
+
+### Removed
+- Removed use of `fs/promises`, `saveFile()` and `renderFromFile()` from `DSFEmailRenderer`
+
 ## [v2.0.1] - 2024-04-30
 
 ### Fixed

package/README.md

@@ -86,10 +86,11 @@ const renderedTemplate = renderer.renderFromString(inputString);
 console.log(renderedTemplate); // Output the rendered template
 ```
 
-You may also use the `renderFromFile` and provide a text file with the nunjucks input template as follows:
+You may also use load a template from a file using `fs/promises` and provide a text file with the nunjucks input template as follows:
 
 ```js
 import DSFEmailRenderer from '@gov-cy/dsf-email-templates';
+import fs from 'fs/promises';
 
 // Create an instance of DSFEmailRenderer
 const renderer = new DSFEmailRenderer();
@@ -97,8 +98,10 @@ const renderer = new DSFEmailRenderer();
 // Specify the path of the template file
 const templatePath = 'path/to/template.njk';
 
-// Render the email template from the input file
-const renderedTemplate = await renderer.renderFromFile(templatePath);
+// Load template file
+const templateContent = await fs.readFile(templatePath, 'utf8');
+// Render template
+const renderedTemplate = renderer.renderFromString(templateContent);
 
 console.log(renderedTemplate); // Output the rendered template
 

package/bin/dsf-email-templater.js

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 
 import { DSFEmailRenderer } from '../src/index.mjs';
+import fs from 'fs/promises';
 
 const args = process.argv.slice(2);
 
@@ -15,8 +16,17 @@ const renderer = new DSFEmailRenderer();
 
 (async () => {
   try {
-    const inputTemplate = await renderer.renderFromFile(inputPath);
-    await renderer.saveFile(inputTemplate, outputPath);
+    // Load template
+    const templateContent = await fs.readFile(inputPath, 'utf8');
+    // Render template
+    const inputTemplate = renderer.renderFromString(templateContent);
+    try { 
+      // Write rendered content to output file
+      await fs.writeFile(outputPath, inputTemplate);
+      console.log(`File rendered and saved to ${outputPath}`);
+    } catch (error) {
+      throw new Error(`Error rendering template: ${error.message}`);
+    }
   } catch (error) {
     console.error(error);
     process.exit(1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gov-cy/dsf-email-templates",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "This project can be used to produce html email templates to be used by DSF.",
   "author": "DMRID - DSF Team",
   "license": "MIT",

package/src/DSFEmailRenderer.mjs

@@ -1,5 +1,4 @@
 import nunjucks from 'nunjucks';
-import fs from 'fs/promises';
 import { dirname, join } from 'path';
 import { fileURLToPath } from 'url';
 
@@ -21,21 +20,7 @@ export default class DSFEmailRenderer {
         const templateDirectory = join(__dirname, 'njk');
         nunjucks.configure(templateDirectory);
       }
-    /**
-     * Renders the email html in file, based on an input html string
-     * 
-     * @param {string} inputHTML The input
-     * @param {string} outputPath The path of the output html file
-     */
-      async saveFile(inputHTML, outputPath) {
-        try { 
-          // Write rendered content to output file
-          await fs.writeFile(outputPath, inputHTML);
-          console.log(`File rendered and saved to ${outputPath}`);
-        } catch (error) {
-          throw new Error(`Error rendering template: ${error.message}`);
-        }
-      }
+    
     /**
      * Returns the rendered email html as string, based on the nunjucks templates
      * 
@@ -50,20 +35,6 @@ export default class DSFEmailRenderer {
           return renderedContent;
       }
 
-      /**
-       * Renders the email html, based on an input template 
-       * 
-       * @param {string} templatePath The path of the template to used as input
-       * @returns {string} Rendered email html as string
-       */
-      async renderFromFile(templatePath) {
-        // Load template
-        const templateContent = await fs.readFile(templatePath, 'utf8');
-        // Render template
-        const renderedContent = this.renderFromString(templateContent);
-        return renderedContent; 
-      }
-
       /**
        * Returns the rendered email html as string, based on the input json object
        * 

package/test/mailtrap-njk.js

@@ -32,7 +32,7 @@
  * 
  */
 import nodemailer from 'nodemailer';
-import fs from 'fs';
+import fs from 'fs/promises';
 import { DSFEmailRenderer } from '../src/index.mjs';
 import { exit } from 'process';
 
@@ -46,8 +46,10 @@ async function testMailtrap() {
     process.exit(1);
   }
   const renderer = new DSFEmailRenderer();
-  //render html 
-  const htmlBody = await renderer.renderFromFile(myArgs[0]);
+  // Load template
+  const templateContent = await fs.readFile(myArgs[0], 'utf8');
+  // Render template
+  const htmlBody = renderer.renderFromString(templateContent);
 
   // Generate test SMTP service account from ethereal.email
   // Only needed if you don't have a real mail account for testing