@restorecommerce/handlebars-helperized 0.1.9 → 0.1.16

package/CHANGELOG.md

@@ -1,3 +1,74 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [0.1.16](https://github.com/restorecommerce/handlebars-helperized/compare/@restorecommerce/handlebars-helperized@0.1.15...@restorecommerce/handlebars-helperized@0.1.16) (2022-02-14)
+
+**Note:** Version bump only for package @restorecommerce/handlebars-helperized
+
+
+
+
+
+## [0.1.15](https://github.com/restorecommerce/handlebars-helperized/compare/@restorecommerce/handlebars-helperized@0.1.14...@restorecommerce/handlebars-helperized@0.1.15) (2021-08-23)
+
+
+### Bug Fixes
+
+* **version:** up version to be in sync in package-lock ([b8f22c1](https://github.com/restorecommerce/handlebars-helperized/commit/b8f22c1268ee2af4beff7d88bda30f197896e3d2))
+
+
+
+
+
+## [0.1.14](https://github.com/restorecommerce/handlebars-helperized/compare/@restorecommerce/handlebars-helperized@0.1.13...@restorecommerce/handlebars-helperized@0.1.14) (2021-08-03)
+
+
+### Bug Fixes
+
+* up pkg locks ([8ed92d6](https://github.com/restorecommerce/handlebars-helperized/commit/8ed92d613b9a095e4b5066056ac566e5dbcf1472))
+* updated githead ([2904d30](https://github.com/restorecommerce/handlebars-helperized/commit/2904d30e5773dc8a87c01a08ff6481f99d692354))
+
+
+
+
+
+## [0.1.13](https://github.com/restorecommerce/handlebars-helperized/compare/@restorecommerce/handlebars-helperized@0.1.12...@restorecommerce/handlebars-helperized@0.1.13) (2021-08-03)
+
+
+### Bug Fixes
+
+* **koa-health-check:** added missing .eslintrc.js ([45af632](https://github.com/restorecommerce/handlebars-helperized/commit/45af632955d2dd448e7a27f4e8c4b971412cd004))
+
+
+
+
+
+## [0.1.12](https://github.com/restorecommerce/handlebars-helperized/compare/@restorecommerce/handlebars-helperized@0.1.11...@restorecommerce/handlebars-helperized@0.1.12) (2021-06-26)
+
+**Note:** Version bump only for package @restorecommerce/handlebars-helperized
+
+
+
+
+
+## [0.1.11](https://github.com/restorecommerce/handlebars-helperized/compare/@restorecommerce/handlebars-helperized@0.1.10...@restorecommerce/handlebars-helperized@0.1.11) (2021-05-25)
+
+**Note:** Version bump only for package @restorecommerce/handlebars-helperized
+
+
+
+
+
+## 0.1.10 (2021-05-24)
+
+**Note:** Version bump only for package @restorecommerce/handlebars-helperized
+
+
+
+
+
 ### 0.1.9 (April 15th, 2021)
 
 - Upgrade deps.

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) Invend GmbH and other contributors.
+Copyright (c) n-fuse GmbH and other contributors.
 
 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
@@ -16,4 +16,4 @@ 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.
+SOFTWARE.

package/README.md

@@ -15,7 +15,8 @@ extension `t`.
 
 Additional custom helpers can be provided from the service which makes use of
 this module by passing an array which contains the file's path relative to the
-root folder on class initialization.  
+root folder on class initialization.
+
  ```js
 // example
 const filePathList = ['./test/handlebars/helper-loud.js'];

package/lib/helpers/custom-helpers.d.ts

@@ -0,0 +1 @@
+declare let customHandlebarsExtensions: (hbs: any, opts: any) => void;

package/lib/helpers/custom-helpers.js

@@ -0,0 +1,11 @@
+"use strict";
+let customHandlebarsExtensions = (hbs, opts) => {
+    // increment a given numerical string by one
+    hbs.registerHelper('increment', (value, hash) => {
+        const toIncrement = parseInt(value, 10);
+        if (isNaN(toIncrement))
+            return '0';
+        return toIncrement + 1;
+    });
+};
+module.exports = customHandlebarsExtensions;

package/lib/helpers/l10n-helpers.d.ts

@@ -0,0 +1,3 @@
+declare const tripleStache: RegExp;
+declare const doubleStache: RegExp;
+declare let localizationHandlebarsExtension: (hbs: any, opts: any) => void;

package/lib/helpers/l10n-helpers.js

@@ -0,0 +1,20 @@
+"use strict";
+const tripleStache = /\{\{\{\s*(.*?)\s*\}\}\}/g;
+const doubleStache = /\{\{\s*(.*?)\s*\}\}/g;
+let localizationHandlebarsExtension = (hbs, opts) => {
+    hbs.registerHelper('t', (key, hash = {}) => {
+        const locale = opts.locale;
+        let result = opts.texts[key] || key;
+        result = (typeof result === 'object') ? result[locale] : result;
+        if (!result)
+            return 'Missing translation for ' + key;
+        const data = hash.data.root;
+        return result.replace(doubleStache, (i, match) => {
+            return data[match] ? data[match] : ('{{' + match + '}}');
+        }).replace(tripleStache, (i, match) => {
+            // TODO: escaping
+            return data[match] ? data[match] : ('{{{' + match + '}}}');
+        });
+    });
+};
+module.exports = localizationHandlebarsExtension;

package/lib/helpers/moment-helpers.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/helpers/moment-helpers.js

@@ -0,0 +1,61 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const moment_timezone_1 = __importDefault(require("moment-timezone"));
+let momentHandlebarsExtension = (hbs, opts) => {
+    // Output point in time relative to current point in time
+    // for example: '1h ago'
+    hbs.registerHelper('ago', (value, options) => {
+        let v = value;
+        if (options.isSeconds) {
+            // the given property represents seconds since UNIX epoch, so we
+            // multiply by 1000 to get the date in milliseconds since UNIX epoch
+            v *= 1000;
+        }
+        const tz = options.hash.timezone || moment_timezone_1.default.tz.guess();
+        return moment_timezone_1.default.tz(v, tz).locale(opts.locale).fromNow();
+    });
+    // Date format short
+    hbs.registerHelper('df', (value, options) => {
+        const tz = options.hash.timezone || moment_timezone_1.default.tz.guess();
+        return moment_timezone_1.default.tz(value, tz).locale(opts.locale).format('L');
+    });
+    // Date format Long
+    hbs.registerHelper('dfl', (value, options) => {
+        const tz = options.hash.timezone || moment_timezone_1.default.tz.guess();
+        return moment_timezone_1.default.tz(value, tz).locale(opts.locale).format('LL');
+    });
+    // Time format
+    hbs.registerHelper('tf', (value, options) => {
+        const tz = options.hash.timezone || moment_timezone_1.default.tz.guess();
+        return moment_timezone_1.default.tz(value, tz).locale(opts.locale).format('LT');
+    });
+    // Date-Time format
+    hbs.registerHelper('dtf', (value, options) => {
+        const tz = options.hash.timezone || moment_timezone_1.default.tz.guess();
+        return moment_timezone_1.default.tz(value, tz).locale(opts.locale).format('LLL');
+    });
+    // Date-Time format with given format
+    hbs.registerHelper('dff', (value, options) => {
+        const format = options.hash.format || '';
+        const tz = options.hash.timezone || moment_timezone_1.default.tz.guess();
+        return (0, moment_timezone_1.default)(value).tz(tz).format(format);
+    });
+    // Duration formatting
+    // Warning, localization should not be used with this:
+    // While the pattern `D` yields the number of days
+    // `dddd` would yield to a name of a weekday which is
+    // of course not applicapble for a duration.
+    //
+    // A format can be a template string with this syntax:
+    // '[it\'s] D [days and] h [hours]'
+    hbs.registerHelper('duf', (value, options) => {
+        const format = options.hash.format || '';
+        const dur = moment_timezone_1.default.duration(value);
+        // eslint-disable-next-line
+        return (0, moment_timezone_1.default)(dur._data).format(format);
+    });
+};
+module.exports = momentHandlebarsExtension;

package/lib/helpers/numbro-helpers.d.ts

@@ -0,0 +1,3 @@
+declare const numbro: any;
+declare const allLanguages: any;
+declare let numbroHandlebarsExtension: (hbs: any, opts: any) => void;

package/lib/helpers/numbro-helpers.js

@@ -0,0 +1,47 @@
+"use strict";
+const numbro = require('numbro');
+const allLanguages = require('numbro/dist/languages.min');
+Object.values(allLanguages).forEach((data) => {
+    numbro.registerLanguage(data);
+});
+let numbroHandlebarsExtension = (hbs, opts) => {
+    const locale = opts.locale.replace('_', '-');
+    // For numeric values without decimals
+    hbs.registerHelper('nfn', (value, hash) => {
+        numbro.setLanguage(locale);
+        return numbro(value).format({
+            thousandSeparated: true,
+            mantissa: 0
+        });
+    });
+    // For currency based numeric values
+    hbs.registerHelper('nfc', (value, hash) => {
+        const lhash = hash.hash;
+        numbro.setLanguage(locale);
+        // Don't use formatCurrency as it does not allow control over the currency
+        // symbol in confunction with locales
+        let formatted = numbro(value).format({
+            mantissa: 2,
+            thousandSeparated: true
+        });
+        const cs = lhash.cs;
+        if (cs === undefined)
+            return formatted;
+        if (lhash.csPos === 'postfix') {
+            formatted += cs;
+        }
+        else {
+            formatted = cs + formatted;
+        }
+        return formatted;
+    });
+    // For byte based numeric values
+    hbs.registerHelper('nfb', (value, hash) => {
+        numbro.setLanguage(locale);
+        return numbro(value).format({
+            output: 'byte',
+            base: 'binary'
+        });
+    });
+};
+module.exports = numbroHandlebarsExtension;

package/lib/index.d.ts

@@ -0,0 +1,19 @@
+declare class Renderer {
+    /**
+    @param {String} template the template
+    @param {String} layout the optional layout
+    @param {String} style the style
+    @param {Object} opts handlebars options
+    @param {Array} customHelpersList contains a list of custom helpers (optional)
+    */
+    hbs: any;
+    style: string;
+    template: any;
+    constructor(template: string, layout: string, style: string, opts: object, customHelpersList: any);
+    /**
+    @param {Object} context: required data for the placeholders
+    @return {String} html
+    */
+    render(context: Object): any;
+}
+export default Renderer;

package/lib/index.js

@@ -0,0 +1,65 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const juice_1 = __importDefault(require("juice"));
+const defaults_1 = __importDefault(require("lodash/defaults"));
+const defaultOpts = {
+    locale: 'en_US',
+    texts: {}
+};
+// Initializes and configures a custom handlebars instance
+const init = (options, customHelpersList) => {
+    // default values if nothing given
+    const opts = (0, defaults_1.default)(options, defaultOpts);
+    // the basic building block is the handlebars rendering engine
+    const hbs = require('handlebars');
+    // more functionality directly added via custom plugins from ./lib
+    require('./helpers/l10n-helpers.js')(hbs, opts); // localization
+    require('./helpers/numbro-helpers.js')(hbs, opts); // numbers & currencies
+    require('./helpers/moment-helpers.js')(hbs, opts); // dates, times & durations
+    require('./helpers/custom-helpers.js')(hbs, opts); // everything else
+    // add custom helpers from rendering-srv
+    if (customHelpersList) {
+        for (let customHelper of customHelpersList) {
+            const filePath = customHelper;
+            require(filePath)(hbs, opts);
+        }
+    }
+    // extend rendering with layout functionality
+    const handlebarsLayouts = require('handlebars-layouts');
+    handlebarsLayouts.register(hbs);
+    return hbs;
+};
+class Renderer {
+    constructor(template, layout, style, opts, customHelpersList) {
+        this.hbs = init(opts, customHelpersList);
+        this.style = style;
+        if (layout) {
+            this.hbs.registerPartial('layout', layout);
+        }
+        this.template = this.hbs.compile(template);
+    }
+    /**
+    @param {Object} context: required data for the placeholders
+    @return {String} html
+    */
+    render(context) {
+        let html = this.template(context);
+        if (this.style) {
+            html = juice_1.default.inlineContent(html, this.style, {
+                inlinePseudoElements: true,
+                preserveImportant: true,
+                preserveMediaQueries: true,
+                preserveFontFaces: true,
+                applyWidthAttributes: true,
+                applyHeightAttributes: true,
+                insertPreservedExtraCss: true,
+                extraCss: this.style // to enable inlining of media queries
+            });
+        }
+        return html;
+    }
+}
+exports.default = Renderer;

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@restorecommerce/handlebars-helperized",
-  "version": "0.1.9",
+  "version": "0.1.16",
   "description": "Opinionated handlebars based templating engine for rendering e-mail like content",
-  "main": "index",
-  "author": "Invend GmbH",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "author": "n-fuse GmbH",
   "repository": {
     "type": "git",
     "url": "https://github.com/restorecommerce/handlebars-helperized.git"
@@ -20,27 +21,44 @@
   "dependencies": {
     "handlebars": "^4.7.7",
     "handlebars-layouts": "^3.1.4",
-    "juice": "^7.0.0",
+    "juice": "^8.0.0",
     "lodash": "^4.17.21",
-    "moment-timezone": "^0.5.33",
-    "numbro": "^2.3.2"
+    "moment-timezone": "^0.5.34",
+    "numbro": "^2.3.6"
   },
   "devDependencies": {
-    "@restorecommerce/eslint-config-restorecommerce": "^0.1.5",
-    "coveralls": "^3.1.0",
+    "@types/lodash": "^4.14.178",
+    "@types/mocha": "^9.1.0",
+    "@types/node": "^17.0.16",
+    "@types/nodemailer": "^6.4.4",
+    "@types/nodemailer-html-to-text": "^3.1.0",
+    "@types/nodemailer-stub-transport": "^1.1.5",
+    "@typescript-eslint/eslint-plugin": "^5.11.0",
+    "@typescript-eslint/eslint-plugin-tslint": "^5.11.0",
+    "@typescript-eslint/parser": "^5.11.0",
+    "assert": "^2.0.0",
+    "coveralls": "^3.1.1",
+    "eslint": "^8.8.0",
+    "eslint-plugin-prefer-arrow-functions": "^3.1.4",
     "is-generator": "^1.0.3",
-    "jshint": "^2.12.0",
-    "mocha": "^8.3.2",
+    "mocha": "^9.2.0",
+    "npm-run-all": "^4.1.5",
     "nyc": "^15.1.0",
-    "should": "^13.2.3"
+    "should": "^13.2.3",
+    "typescript": "^4.5.5"
   },
   "scripts": {
-    "test": "nyc mocha",
-    "lint": "eslint *.json *.js",
-    "mocha": "mocha ./test/*",
-    "coveralls": "nyc report --reporter=text-lcov | coveralls"
+    "lint": "eslint src --ext .ts ",
+    "pretest": "npm run build",
+    "test": "nyc mocha ./test/* --exit",
+    "build:tsc": "tsc --strict",
+    "build:clean": "rimraf lib",
+    "build": "npm-run-all lint build:clean build:tsc",
+    "lcov-report": "nyc report --reporter=lcov",
+    "coveralls": "nyc --reporter text --reporter lcov npm test"
   },
   "engines": {
     "node": ">= 8.0.0"
-  }
+  },
+  "gitHead": "e97bbfe2fe8166dfe1cd47ae60bce54347a4f1c9"
 }

package/src/helpers/custom-helpers.ts

@@ -0,0 +1,11 @@
+
+let customHandlebarsExtensions = (hbs: any, opts: any) => {
+  // increment a given numerical string by one
+  hbs.registerHelper('increment', (value: any, hash: any) => {
+    const toIncrement = parseInt(value, 10);
+    if (isNaN(toIncrement)) return '0';
+    return toIncrement + 1;
+  });
+};
+
+module.exports = customHandlebarsExtensions;

package/{lib/l10n-helpers.js → src/helpers/l10n-helpers.ts}

@@ -1,20 +1,20 @@
-'use strict';
-
 const tripleStache = /\{\{\{\s*(.*?)\s*\}\}\}/g;
 const doubleStache = /\{\{\s*(.*?)\s*\}\}/g;
 
-module.exports = function localizationHandlebarsExtension(hbs, opts) {
-  hbs.registerHelper('t', (key, hash = {}) => {
+let localizationHandlebarsExtension = (hbs: any, opts: any) => {
+  hbs.registerHelper('t', (key: string, hash = {} as any) => {
     const locale = opts.locale;
     let result = opts.texts[key] || key;
     result = (typeof result === 'object') ? result[locale] : result;
     if (!result) return 'Missing translation for ' + key;
     const data = hash.data.root;
-    return result.replace(doubleStache, (i, match) => {
+    return result.replace(doubleStache, (i: any, match: any) => {
       return data[match] ? data[match] : ('{{' + match + '}}');
-    }).replace(tripleStache, (i, match) => {
+    }).replace(tripleStache, (i: any, match: any) => {
       // TODO: escaping
       return data[match] ? data[match] : ('{{{' + match + '}}}');
     });
   });
 };
+
+module.exports = localizationHandlebarsExtension;

package/{lib/moment-helpers.js → src/helpers/moment-helpers.ts}

@@ -1,11 +1,9 @@
-'use strict';
+import moment from 'moment-timezone';
 
-const moment = require('moment-timezone');
-
-module.exports = function momentHandlebarsExtension(hbs, opts) {
+let  momentHandlebarsExtension = (hbs: any, opts: any) => {
   // Output point in time relative to current point in time
   // for example: '1h ago'
-  hbs.registerHelper('ago', (value, options) => {
+  hbs.registerHelper('ago', (value: any, options: any) => {
     let v = value;
     if (options.isSeconds) {
       // the given property represents seconds since UNIX epoch, so we
@@ -17,31 +15,31 @@ module.exports = function momentHandlebarsExtension(hbs, opts) {
   });
 
   // Date format short
-  hbs.registerHelper('df', (value, options) => {
+  hbs.registerHelper('df', (value: any, options: any) => {
     const tz = options.hash.timezone || moment.tz.guess();
     return moment.tz(value, tz).locale(opts.locale).format('L');
   });
 
   // Date format Long
-  hbs.registerHelper('dfl', (value, options) => {
+  hbs.registerHelper('dfl', (value: any, options: any) => {
     const tz = options.hash.timezone || moment.tz.guess();
     return moment.tz(value, tz).locale(opts.locale).format('LL');
   });
 
   // Time format
-  hbs.registerHelper('tf', (value, options) => {
+  hbs.registerHelper('tf', (value: any, options: any) => {
     const tz = options.hash.timezone || moment.tz.guess();
     return moment.tz(value, tz).locale(opts.locale).format('LT');
   });
 
   // Date-Time format
-  hbs.registerHelper('dtf', (value, options) => {
+  hbs.registerHelper('dtf', (value: any, options: any) => {
     const tz = options.hash.timezone || moment.tz.guess();
     return moment.tz(value, tz).locale(opts.locale).format('LLL');
   });
 
   // Date-Time format with given format
-  hbs.registerHelper('dff', (value, options) => {
+  hbs.registerHelper('dff', (value: any, options: any) => {
     const format = options.hash.format || '';
     const tz = options.hash.timezone || moment.tz.guess();
     return moment(value).tz(tz).format(format);
@@ -55,10 +53,12 @@ module.exports = function momentHandlebarsExtension(hbs, opts) {
   //
   // A format can be a template string with this syntax:
   // '[it\'s] D [days and] h [hours]'
-  hbs.registerHelper('duf', (value, options) => {
+  hbs.registerHelper('duf', (value: any, options: any) => {
     const format = options.hash.format || '';
-    const dur = moment.duration(value);
+    const dur: any = moment.duration(value);
     // eslint-disable-next-line
     return moment(dur._data).format(format);
   });
 };
+
+module.exports = momentHandlebarsExtension;

package/{lib/numbro-helpers.js → src/helpers/numbro-helpers.ts}

@@ -1,5 +1,3 @@
-'use strict';
-
 const numbro = require('numbro');
 const allLanguages = require('numbro/dist/languages.min');
 
@@ -7,11 +5,11 @@ Object.values(allLanguages).forEach((data) => {
   numbro.registerLanguage(data);
 });
 
-module.exports = function numbroHandlebarsExtension(hbs, opts) {
+let numbroHandlebarsExtension = (hbs: any, opts: any) => {
   const locale = opts.locale.replace('_', '-');
 
   // For numeric values without decimals
-  hbs.registerHelper('nfn', (value, hash) => {
+  hbs.registerHelper('nfn', (value: any, hash: any) => {
     numbro.setLanguage(locale);
     return numbro(value).format({
       thousandSeparated: true,
@@ -20,7 +18,7 @@ module.exports = function numbroHandlebarsExtension(hbs, opts) {
   });
 
   // For currency based numeric values
-  hbs.registerHelper('nfc', (value, hash) => {
+  hbs.registerHelper('nfc', (value: any, hash: any) => {
     const lhash = hash.hash;
     numbro.setLanguage(locale);
     // Don't use formatCurrency as it does not allow control over the currency
@@ -43,7 +41,7 @@ module.exports = function numbroHandlebarsExtension(hbs, opts) {
   });
 
   // For byte based numeric values
-  hbs.registerHelper('nfb', (value, hash) => {
+  hbs.registerHelper('nfb', (value: any, hash: any) => {
     numbro.setLanguage(locale);
     return numbro(value).format({
       output: 'byte',
@@ -51,3 +49,5 @@ module.exports = function numbroHandlebarsExtension(hbs, opts) {
     });
   });
 };
+
+module.exports = numbroHandlebarsExtension;

package/{index.js → src/index.ts}

@@ -1,7 +1,5 @@
-'use strict';
-
-const _ = require('lodash');
-const juice = require('juice');
+import juice from 'juice';
+import defaults from 'lodash/defaults';
 
 const defaultOpts = {
   locale: 'en_US',
@@ -9,16 +7,16 @@ const defaultOpts = {
 };
 
 // Initializes and configures a custom handlebars instance
-function init(options, customHelpersList) {
+const init = (options: object, customHelpersList: any) => {
   // default values if nothing given
-  const opts = _.defaults(options, defaultOpts);
+  const opts = defaults(options, defaultOpts);
   // the basic building block is the handlebars rendering engine
   const hbs = require('handlebars');
   // more functionality directly added via custom plugins from ./lib
-  require('./lib/l10n-helpers')(hbs, opts); // localization
-  require('./lib/numbro-helpers')(hbs, opts); // numbers & currencies
-  require('./lib/moment-helpers')(hbs, opts); // dates, times & durations
-  require('./lib/custom-helpers')(hbs, opts); // everything else
+  require('./helpers/l10n-helpers.js')(hbs, opts); // localization
+  require('./helpers/numbro-helpers.js')(hbs, opts); // numbers & currencies
+  require('./helpers/moment-helpers.js')(hbs, opts); // dates, times & durations
+  require('./helpers/custom-helpers.js')(hbs, opts); // everything else
 
   // add custom helpers from rendering-srv
   if (customHelpersList) {
@@ -31,7 +29,7 @@ function init(options, customHelpersList) {
   const handlebarsLayouts = require('handlebars-layouts');
   handlebarsLayouts.register(hbs);
   return hbs;
-}
+};
 
 class Renderer {
   /**
@@ -41,7 +39,12 @@ class Renderer {
   @param {Object} opts handlebars options
   @param {Array} customHelpersList contains a list of custom helpers (optional)
   */
-  constructor(template, layout, style, opts, customHelpersList) {
+
+  hbs: any;
+  style: string;
+  template: any;
+
+  constructor(template: string, layout: string, style: string, opts: object, customHelpersList: any) {
     this.hbs = init(opts, customHelpersList);
     this.style = style;
     if (layout) {
@@ -54,7 +57,7 @@ class Renderer {
   @param {Object} context: required data for the placeholders
   @return {String} html
   */
-  render(context) {
+  render(context: Object) {
     let html = this.template(context);
 
     if (this.style) {
@@ -74,4 +77,4 @@ class Renderer {
   }
 }
 
-module.exports = Renderer;
+export default Renderer;

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "target": "ES6",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "declaration": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "outDir": "lib",
+    "typeRoots": [
+      "node_modules/@types"
+    ],
+  },
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "lib",
+    "doc"
+  ]
+}

package/lib/custom-helpers.js

@@ -1,8 +0,0 @@
-module.exports = function customHandlebarsExtensions(hbs, opts) {
-  // increment a given numerical string by one
-  hbs.registerHelper('increment', (value, hash) => {
-    const toIncrement = parseInt(value, 10);
-    if (isNaN(toIncrement)) return '0';
-    return toIncrement + 1;
-  });
-};