@bedrockio/templates 0.1.1 → 0.2.0

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.2.0
+
+- Allow params in URLs.
+- Prevent escaping of basic HTML.
+- Handling null templates.
+- Allow passing file extensions.
+- Better custom handlers.
+
 ## 0.1.1
 
 - `lodash-es` -> `lodash.memoize`

package/dist/cjs/TemplateRenderer.js

@@ -20,12 +20,6 @@ class TemplateRenderer {
     }
     run(options) {
         const { template, params, helpers, ...rest } = this.resolveOptions(options);
-        if (!template) {
-            return {
-                body: '',
-                sections: [],
-            };
-        }
         const compiled = this.loadTemplate(template, rest);
         return compiled(params, {
             helpers: (0, helpers_1.resolveHelpers)(helpers, rest),
@@ -35,7 +29,7 @@ class TemplateRenderer {
     // Private
     /** @returns {Object} */
     resolveOptions(options = {}) {
-        return {
+        const resolved = {
             ...this.options,
             ...options,
             params: {
@@ -43,12 +37,15 @@ class TemplateRenderer {
                 ...options.params,
             },
         };
+        resolved.template ||= resolved.body;
+        return resolved;
     }
-    loadTemplate = (0, lodash_memoize_1.default)((input, options) => {
+    loadTemplate = (0, lodash_memoize_1.default)((input = '', options) => {
         const source = (0, utils_1.resolveTemplateSource)(input, options);
         const template = handlebars_1.default.compile(source.trim());
         return (params, options) => {
-            const output = template(params, options);
+            let output = template(params, options);
+            output = (0, utils_1.unescapeHtml)(output);
             const { body, meta } = (0, utils_1.runFrontMatter)(output);
             const sections = (0, utils_1.getSections)(body);
             return {

package/dist/cjs/helpers.js

@@ -95,15 +95,14 @@ exports.DEFAULT_HELPERS = {
         }
         return index + 1;
     },
-    link(url, text) {
+    link(text, url) {
         return new handlebars_1.default.SafeString(`[${text}](${url})`);
     },
-    button(url, text) {
+    button(text, url) {
         return generateHtml('a', {
             text,
             href: url,
             class: 'button',
-            target: '_blank',
         });
     },
     list(arr) {
@@ -124,7 +123,8 @@ function resolveHelpers(helpers, options) {
 function resolveHelper(arg, options) {
     const { names, handler } = resolveArgumentNames(arg);
     return (...args) => {
-        return handler(...resolveHelperArgs(args, names, options));
+        const result = handler(...resolveHelperArgs(args, names, options));
+        return generateHtml(result);
     };
 }
 // Arguments
@@ -162,7 +162,12 @@ function resolveHelperArgs(args, names, options) {
         params[name] = value;
     });
     const resolved = names.map((name) => {
-        return params[name];
+        if (name === 'params') {
+            return meta.hash;
+        }
+        let value = params[name];
+        value = normalizeParam(name, value, params, options);
+        return value;
     });
     options = {
         options,
@@ -170,7 +175,34 @@ function resolveHelperArgs(args, names, options) {
     };
     return [...resolved, options];
 }
-function generateHtml(tag, props) {
+// Param normalization
+function normalizeParam(name, value, params, options) {
+    if (name === 'url' || name === 'href') {
+        value = normalizeUrl(value, params, options);
+    }
+    return value;
+}
+const PARAM_REG = /:([a-z]+)/gi;
+function normalizeUrl(str, params, options) {
+    const { baseUrl } = options;
+    if (baseUrl && str.startsWith('/')) {
+        str = baseUrl + str;
+    }
+    str = str.replace(PARAM_REG, (_, key) => {
+        const value = params[key];
+        // Need to delete the injected params or they
+        // will be passed on to the HTML element.
+        delete params[key];
+        return value;
+    });
+    return str;
+}
+function generateHtml(...args) {
+    const arg = args.length > 1 ? args : args[0];
+    if (!Array.isArray(arg)) {
+        return arg || '';
+    }
+    const [tag, props] = arg;
     const { text, ...rest } = props;
     const attr = Object.entries(rest)
         .map((entry) => {
@@ -181,9 +213,14 @@ function generateHtml(tag, props) {
     })
         .filter((a) => a)
         .join(' ');
-    let html = `<${tag} ${attr}>`;
+    let html = `<${tag} ${attr}`;
     if (text) {
-        html += `${text}</${tag}>`;
+        html += '>';
+        html += generateHtml(text);
+        html += `</${tag}>`;
+    }
+    else {
+        html += ` />`;
     }
     return new handlebars_1.default.SafeString(html);
 }

package/dist/cjs/utils.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveTemplateSource = resolveTemplateSource;
 exports.runFrontMatter = runFrontMatter;
 exports.getSections = getSections;
+exports.unescapeHtml = unescapeHtml;
 const fs_1 = require("fs");
 const path_1 = __importDefault(require("path"));
 const front_matter_1 = __importDefault(require("front-matter"));
@@ -26,9 +27,9 @@ function runFrontMatter(str) {
         body: body.trim(),
     };
 }
-function tryReadFile(filepath, ext) {
+function tryReadFile(filepath) {
     try {
-        return (0, fs_1.readFileSync)(filepath + ext, 'utf-8');
+        return (0, fs_1.readFileSync)(filepath, 'utf-8');
     }
     catch (error) {
         if (error.code !== 'ENOENT') {
@@ -37,7 +38,12 @@ function tryReadFile(filepath, ext) {
     }
 }
 function readSource(filepath) {
-    return tryReadFile(filepath, '.md') || tryReadFile(filepath, '.txt');
+    if (path_1.default.extname(filepath)) {
+        return tryReadFile(filepath);
+    }
+    else {
+        return tryReadFile(filepath + '.md') || tryReadFile(filepath + '.txt');
+    }
 }
 // Sections
 const SECTIONS_REG = /^=== (\w+) ===\n\n/gm;
@@ -60,3 +66,13 @@ function getSections(str) {
     }
     return sections;
 }
+// Whitespace
+// Handlebars doesn't allow a way to selectively
+// escape so instead unescape some basic tokens.
+function unescapeHtml(html) {
+    html = html.replace(/'/g, "'");
+    html = html.replace(/"/g, '"');
+    html = html.replace(/'/g, "'");
+    html = html.replace(/=/g, '=');
+    return html;
+}

package/dist/esm/TemplateRenderer.js

@@ -1,7 +1,7 @@
 import Handlebars from 'handlebars';
 import memoize from 'lodash.memoize';
 import { DEFAULT_HELPERS, resolveHelpers } from './helpers.js';
-import { getSections, resolveTemplateSource, runFrontMatter } from './utils.js';
+import { getSections, resolveTemplateSource, runFrontMatter, unescapeHtml, } from './utils.js';
 export default class TemplateRenderer {
     constructor(options = {}) {
         /** @type {Object} */
@@ -15,12 +15,6 @@ export default class TemplateRenderer {
     }
     run(options) {
         const { template, params, helpers, ...rest } = this.resolveOptions(options);
-        if (!template) {
-            return {
-                body: '',
-                sections: [],
-            };
-        }
         const compiled = this.loadTemplate(template, rest);
         return compiled(params, {
             helpers: resolveHelpers(helpers, rest),
@@ -30,7 +24,7 @@ export default class TemplateRenderer {
     // Private
     /** @returns {Object} */
     resolveOptions(options = {}) {
-        return {
+        const resolved = {
             ...this.options,
             ...options,
             params: {
@@ -38,12 +32,15 @@ export default class TemplateRenderer {
                 ...options.params,
             },
         };
+        resolved.template ||= resolved.body;
+        return resolved;
     }
-    loadTemplate = memoize((input, options) => {
+    loadTemplate = memoize((input = '', options) => {
         const source = resolveTemplateSource(input, options);
         const template = Handlebars.compile(source.trim());
         return (params, options) => {
-            const output = template(params, options);
+            let output = template(params, options);
+            output = unescapeHtml(output);
             const { body, meta } = runFrontMatter(output);
             const sections = getSections(body);
             return {

package/dist/esm/helpers.js

@@ -88,15 +88,14 @@ export const DEFAULT_HELPERS = {
         }
         return index + 1;
     },
-    link(url, text) {
+    link(text, url) {
         return new Handlebars.SafeString(`[${text}](${url})`);
     },
-    button(url, text) {
+    button(text, url) {
         return generateHtml('a', {
             text,
             href: url,
             class: 'button',
-            target: '_blank',
         });
     },
     list(arr) {
@@ -117,7 +116,8 @@ export function resolveHelpers(helpers, options) {
 function resolveHelper(arg, options) {
     const { names, handler } = resolveArgumentNames(arg);
     return (...args) => {
-        return handler(...resolveHelperArgs(args, names, options));
+        const result = handler(...resolveHelperArgs(args, names, options));
+        return generateHtml(result);
     };
 }
 // Arguments
@@ -155,7 +155,12 @@ function resolveHelperArgs(args, names, options) {
         params[name] = value;
     });
     const resolved = names.map((name) => {
-        return params[name];
+        if (name === 'params') {
+            return meta.hash;
+        }
+        let value = params[name];
+        value = normalizeParam(name, value, params, options);
+        return value;
     });
     options = {
         options,
@@ -163,7 +168,34 @@ function resolveHelperArgs(args, names, options) {
     };
     return [...resolved, options];
 }
-function generateHtml(tag, props) {
+// Param normalization
+function normalizeParam(name, value, params, options) {
+    if (name === 'url' || name === 'href') {
+        value = normalizeUrl(value, params, options);
+    }
+    return value;
+}
+const PARAM_REG = /:([a-z]+)/gi;
+function normalizeUrl(str, params, options) {
+    const { baseUrl } = options;
+    if (baseUrl && str.startsWith('/')) {
+        str = baseUrl + str;
+    }
+    str = str.replace(PARAM_REG, (_, key) => {
+        const value = params[key];
+        // Need to delete the injected params or they
+        // will be passed on to the HTML element.
+        delete params[key];
+        return value;
+    });
+    return str;
+}
+function generateHtml(...args) {
+    const arg = args.length > 1 ? args : args[0];
+    if (!Array.isArray(arg)) {
+        return arg || '';
+    }
+    const [tag, props] = arg;
     const { text, ...rest } = props;
     const attr = Object.entries(rest)
         .map((entry) => {
@@ -174,9 +206,14 @@ function generateHtml(tag, props) {
     })
         .filter((a) => a)
         .join(' ');
-    let html = `<${tag} ${attr}>`;
+    let html = `<${tag} ${attr}`;
     if (text) {
-        html += `${text}</${tag}>`;
+        html += '>';
+        html += generateHtml(text);
+        html += `</${tag}>`;
+    }
+    else {
+        html += ` />`;
     }
     return new Handlebars.SafeString(html);
 }

package/dist/esm/utils.js

@@ -18,9 +18,9 @@ export function runFrontMatter(str) {
         body: body.trim(),
     };
 }
-function tryReadFile(filepath, ext) {
+function tryReadFile(filepath) {
     try {
-        return readFileSync(filepath + ext, 'utf-8');
+        return readFileSync(filepath, 'utf-8');
     }
     catch (error) {
         if (error.code !== 'ENOENT') {
@@ -29,7 +29,12 @@ function tryReadFile(filepath, ext) {
     }
 }
 function readSource(filepath) {
-    return tryReadFile(filepath, '.md') || tryReadFile(filepath, '.txt');
+    if (path.extname(filepath)) {
+        return tryReadFile(filepath);
+    }
+    else {
+        return tryReadFile(filepath + '.md') || tryReadFile(filepath + '.txt');
+    }
 }
 // Sections
 const SECTIONS_REG = /^=== (\w+) ===\n\n/gm;
@@ -52,3 +57,13 @@ export function getSections(str) {
     }
     return sections;
 }
+// Whitespace
+// Handlebars doesn't allow a way to selectively
+// escape so instead unescape some basic tokens.
+export function unescapeHtml(html) {
+    html = html.replace(/'/g, "'");
+    html = html.replace(/"/g, '"');
+    html = html.replace(/'/g, "'");
+    html = html.replace(/=/g, '=');
+    return html;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrockio/templates",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Bedrock utility for custom templates.",
   "type": "module",
   "scripts": {

package/types/TemplateRenderer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TemplateRenderer.d.ts","sourceRoot":"","sources":["../src/TemplateRenderer.js"],"names":[],"mappings":"AAMA;IACE,0BASC;IARC,qBAAqB;IACrB,aAMC;IAGH,uBAgBC;IAID,wBAAwB;IACxB,kCASC;IAED,kBAgBG;CACJ"}
+{"version":3,"file":"TemplateRenderer.d.ts","sourceRoot":"","sources":["../src/TemplateRenderer.js"],"names":[],"mappings":"AAYA;IACE,0BASC;IARC,qBAAqB;IACrB,aAMC;IAGH,uBASC;IAID,wBAAwB;IACxB,kCAWC;IAED,kBAkBG;CACJ"}

package/types/helpers.d.ts

@@ -22,8 +22,8 @@ export namespace DEFAULT_HELPERS {
     function dateTimeShort(arg: any, meridiem: any): any;
     function relTime(arg: any, min: any, max: any): any;
     function number(options: any): any;
-    function link(url: any, text: any): Handlebars.SafeString;
-    function button(url: any, text: any): Handlebars.SafeString;
+    function link(text: any, url: any): Handlebars.SafeString;
+    function button(text: any, url: any): any;
     function list(arr: any): any;
 }
 import Handlebars from 'handlebars';

package/types/helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../src/helpers.js"],"names":[],"mappings":"AAyHA,+DAMC;;IA1HC,gCAEC;IACD,iCAEC;IACD,mCAEC;IACD,kCAEC;IAGD,4CAIC;IAED;;OAEG;IACH,mDAFW,IAAI,CAAC,qBAAqB,CAAC,cAAc,CAAC,OAOpD;IACD,gDAIC;IACD,kDAIC;IACD,iDAIC;IAGD,gDAIC;IAED;;OAEG;IACH,uDAFW,IAAI,CAAC,qBAAqB,CAAC,cAAc,CAAC,OAOpD;IACD,oDAIC;IACD,sDAIC;IACD,qDAIC;IAID,oDAKC;IAED,mCAMC;IAED,0DAEC;IAED,4DAOC;IAED,6BAMC;;uBArHoB,YAAY"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../src/helpers.js"],"names":[],"mappings":"AAwHA,+DAMC;;IAzHC,gCAEC;IACD,iCAEC;IACD,mCAEC;IACD,kCAEC;IAGD,4CAIC;IAED;;OAEG;IACH,mDAFW,IAAI,CAAC,qBAAqB,CAAC,cAAc,CAAC,OAOpD;IACD,gDAIC;IACD,kDAIC;IACD,iDAIC;IAGD,gDAIC;IAED;;OAEG;IACH,uDAFW,IAAI,CAAC,qBAAqB,CAAC,cAAc,CAAC,OAOpD;IACD,oDAIC;IACD,sDAIC;IACD,qDAIC;IAID,oDAKC;IAED,mCAMC;IAED,0DAEC;IAED,0CAMC;IAED,6BAMC;;uBApHoB,YAAY"}

package/types/utils.d.ts

@@ -9,4 +9,5 @@ export function getSections(str: any): {
     title: any;
     content: any;
 }[];
+export function unescapeHtml(html: any): any;
 //# sourceMappingURL=utils.d.ts.map

package/types/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.js"],"names":[],"mappings":"AAKA,mEASC;AAED;;;EAOC;AAoBD;;;;;IAsBC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.js"],"names":[],"mappings":"AAKA,mEASC;AAED;;;EAOC;AAwBD;;;;;IAsBC;AAMD,6CAMC"}