handlebars-email 1.1.0

package/.github/workflows/node.js.yml

@@ -0,0 +1,31 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run build --if-present
+    - run: npm test

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,33 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Publish Package to NPM
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - run: npm ci
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Karthik V
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,154 @@
+# Handlebars Email
+
+A Handlebars template engine for emails.
+
+Handlebars provides the power necessary to let you build **semantic templates** effectively with no frustration.  
+Checkout the official Handlebars docs site at [handlebarsjs.com](https://handlebarsjs.com) or [Give it a Try](https://handlebarsjs.com/playground.html).
+
+## Installation
+
+Use the [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) package manager to install [Handlebars Email](https://www.npmjs.com/package/handlebars-email).
+
+```bash
+npm i handlebars-email
+```
+
+## Usage
+
+Import Handlebars Email `hbsEmail` method.  
+`hbsEmail( template, context )` take 2 argument a template & a context argument. Which will be used to render the final template.
+
+- template - Path of the template with extension ( .hbs or .handlebars ) or template name if hbsEmailConfig is set.
+- context - The actual context Object.
+
+`hbsEmailConfig()`
+
+- views - Views Path of the email template folder
+- extname - template extension ( .hbs or .handlebars )
+
+```js
+hbsEmailConfig({
+  views: "views/email/",
+  extname: ".hbs"
+});
+```
+
+Once you have a template, use the `hbsEmail` method to render the template by passing the template & context.
+
+## Example
+
+email.js
+
+```javascript
+const { hbsEmail } = require("handlebars-email");
+const path = require("path");
+
+const template = path.join("views", "email", "template.hbs");
+const context = { message: "Hello World!" };
+const eMailTemplate = hbsEmail(template, context);
+```
+
+With hbsEmailConfig
+
+```javascript
+const { hbsEmail, hbsEmailConfig } = require("handlebars-email");
+
+hbsEmailConfig({
+  views: "views/email/",
+  extname: ".hbs",
+});
+
+const context = { message: "Hello World!" };
+const eMailTemplate = hbsEmail("template", context);
+```
+
+template.hbs
+
+```hbs
+<html>
+  <head>
+    <title>Message HTML Title</title>
+  </head>
+  <body>
+    <div>
+      <h2>Message: </h2>
+      <p>{{message}}</p>
+    </div>
+  </body>
+</html>
+```
+
+Would render:
+
+```html
+<html>
+  <head>
+    <title>Message HTML Title</title>
+  </head>
+  <body>
+    <div>
+      <h2>Message:</h2>
+      <p>Hello World!</p>
+    </div>
+  </body>
+</html>
+```
+
+---
+
+## With Nodemailer
+
+email.js
+
+```js
+const { hbsEmail } = require("handlebars-email");
+const nodemailer = require("nodemailer");
+const path = require("path");
+
+const template = path.join(__dirname, "/template.hbs");
+const context = { message: "Hello World!" };
+const eMailTemplate = hbsEmail(template, context);
+
+const transporter = nodemailer.createTransport({
+  host: process.env.SMTP_HOST,
+  port: process.env.SMTP_PORT || 587,
+  secure: process.env.SMTP_PORT === 465, // true for 465, false for other ports
+  auth: {
+    user: process.env.SMTP_USERNAME,
+    pass: process.env.SMTP_PASSWORD,
+  },
+});
+
+const mailOptions = {
+  from: "sender@example.com", // Sender address
+  to: "receiver@example.com", // List of recipients
+  subject: "Node Mailer Handlebars Email", // Subject line
+  html: eMailTemplate, // Handlebars eMail template
+};
+
+transporter.sendMail(mailOptions, (error, email) => {
+  if (error) return console.log(error);
+  console.log("Message sent: %s", email.messageId);
+});
+```
+
+<!-- CONTRIBUTING -->
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
+Don't forget to give the project a star! Thanks again!
+
+1. Fork the Project
+2. Create your Feature Branch (` git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (` git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (` git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+<!-- LICENSE -->
+
+## License
+
+Distributed under the MIT License. See `LICENSE.md` for more information.

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "handlebars-email",
+  "version": "1.1.0",
+  "description": "A Handlebars template engine for emails.",
+  "main": "src/main.js",
+  "scripts": {
+    "test": "jest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/LazyFolks/handlebars-email.git"
+  },
+  "keywords": [
+    "hbs",
+    "handlebars",
+    "handlebars-email",
+    "hbs-email"
+  ],
+  "author": "Karthik",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/LazyFolks/handlebars-email/issues"
+  },
+  "homepage": "https://github.com/LazyFolks/handlebars-email#readme",
+  "dependencies": {
+    "handlebars": "^4.7.7"
+  },
+  "devDependencies": {
+    "jest": "^29.3.1"
+  }
+}

package/src/__tests__/assets/finalTemplate.html

@@ -0,0 +1,11 @@
+<html>
+  <head>
+    <title>Message HTML Title</title>
+  </head>
+  <body>
+    <div>
+      <span style="font-weight: bold;">Message: </span>
+      <span>Hello World!</span>
+    </div>
+  </body>
+</html>

package/src/__tests__/assets/template.hbs

@@ -0,0 +1,11 @@
+<html>
+  <head>
+    <title>Message HTML Title</title>
+  </head>
+  <body>
+    <div>
+      <span style="font-weight: bold;">Message: </span>
+      <span>{{message}}</span>
+    </div>
+  </body>
+</html>

package/src/__tests__/hbsEmail.test.js

@@ -0,0 +1,19 @@
+const { hbsEmail, hbsEmailConfig, templet } = require('../main')
+
+test('hbsEmail', () => {
+    const template = hbsEmail('src/__tests__/assets/template.hbs', { message: "Hello World!" })
+    const finalTemplate = templet.reader('src/__tests__/assets/finalTemplate.html')
+    expect(template).toBe(finalTemplate)
+})
+
+test('hbsEmailConfig', () => {
+
+    hbsEmailConfig({
+        views: 'src/__tests__/assets/',
+        extname: '.hbs'
+    })
+
+    const template = hbsEmail('template', { message: "Hello World!" })
+    const finalTemplate = templet.reader('src/__tests__/assets/finalTemplate.html')
+    expect(template).toBe(finalTemplate)
+})

package/src/config/config.js

@@ -0,0 +1,24 @@
+const fs = require("fs")
+const path = require('path')
+
+const hbsEmailConfig = ( config = {} ) => {
+    const configFile = path.join(__dirname, "config.json")
+    fs.writeFileSync(configFile, JSON.stringify(config))
+}
+
+const getConfig = () => {
+
+    const configFile = path.join(__dirname, "config.json")
+
+    if(!fs.existsSync(configFile)) return {}
+
+    const rawData = fs.readFileSync(configFile)
+    const config = JSON.parse(rawData)
+    return config
+} 
+
+
+module.exports = {
+    hbsEmailConfig: hbsEmailConfig,
+    getConfig: getConfig
+}

package/src/main.js

@@ -0,0 +1,52 @@
+const { hbs, hbsCompile } = require('./modules/hbs')
+const { hbsEmailConfig, getConfig } = require('./config/config')
+const path = require('path')
+const templet  = require('./modules/templet')
+const validate = require('./modules/validator')
+
+const getTemplateFile = template => {
+
+    const config = getConfig()
+
+    const viewsPath = config.views
+    const extName = config.extname
+
+    if(!viewsPath && !extName) {
+        //validate template path
+        validate.template(template)
+        return template
+    }
+
+    // if viewsPath doesn't exist but extName ( extension ) exist in config
+    if(!viewsPath){
+        const templateFile = template.concat(extName)
+        validate.template(templateFile)
+        return templateFile
+    }
+
+    const templateFile = path.join(viewsPath,template.concat(extName))
+    validate.template(templateFile)
+    return templateFile
+    
+}
+
+const hbsEmail = ( template , context ) => {
+
+    const templateFile = getTemplateFile(template)
+
+    const emailTemplateSource = templet.reader(templateFile)
+    
+    const Compiler = hbsCompile(emailTemplateSource)
+
+    const html = Compiler(context)
+
+    return html
+}
+
+module.exports = {
+    hbsEmail:hbsEmail,
+    hbsEmailConfig:hbsEmailConfig,
+    hbs:hbs,
+    hbsCompile:hbsCompile,
+    templet:templet
+}

package/src/modules/hbs.js

@@ -0,0 +1,4 @@
+const handlebars = require('handlebars')
+
+exports.hbs = handlebars
+exports.hbsCompile = handlebars.compile

package/src/modules/templet.js

@@ -0,0 +1,40 @@
+const fs = require('fs')
+
+const reader = ( template, options = 'utf8' ) => fs.readFileSync(template, options)
+const writer = ( template, data, options ) => fs.writeFileSync( template, data, options )
+const exists = template => fs.existsSync(template)
+
+const canRead = template => {
+    try {
+        fs.accessSync(template, fs.constants.R_OK)
+        return true
+    } catch (error) {
+        return false
+    }
+}
+const canWrite = template => {
+    try {
+        fs.accessSync(template, fs.constants.W_OK)
+        return true
+    } catch (error) {
+        return false
+    }
+}
+const canExecute = template => {
+    try {
+        fs.accessSync(template, fs.constants.X_OK)
+        return true
+    } catch (error) {
+        return false
+    }
+}
+
+
+module.exports = {
+    reader:reader,
+    writer:writer,
+    exists:exists,
+    canRead:canRead,
+    canWrite:canWrite,
+    canExecute:canExecute
+ }

package/src/modules/validator.js

@@ -0,0 +1,15 @@
+const templet  = require('./templet')
+const path = require('path')
+
+const validateTemplate = template => {
+
+    const templatePath = path.resolve(template)
+
+    // Check if template exist.
+    if(!templet.exists(template)) throw new Error(`ENOENT: template file doesn't exist. Please choose the correct template path. \n PATH: ${templatePath}`)
+
+    // Check read permission.
+    if(!templet.canRead(template)) throw new Error(`EACCES: permission denied. Can't read template file. Please Check the template file permission. \n PATH: ${templatePath}`)
+}
+
+exports.template = validateTemplate