@bookshop/hugo-engine 3.4.0-beta.1 → 3.4.0-beta.3

package/.nyc_output/processinfo/{4266a04d-f79f-4e25-82b5-a5503aad4653.json → 344d16a6-acc4-4349-b4c7-ffdc41d3e64f.json}

@@ -1 +1 @@
-{"parent":"5a2007e8-1bda-4eda-b271-6d7323d49bdd","pid":5612,"argv":["/opt/hostedtoolcache/node/16.18.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1670907492168,"ppid":5578,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/4266a04d-f79f-4e25-82b5-a5503aad4653.json","externalId":"","uuid":"4266a04d-f79f-4e25-82b5-a5503aad4653","files":[]}
+{"parent":"c1702c73-10b3-4031-a62b-78de0f5a0eda","pid":5464,"argv":["/opt/hostedtoolcache/node/16.18.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1671138230217,"ppid":5424,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/344d16a6-acc4-4349-b4c7-ffdc41d3e64f.json","externalId":"","uuid":"344d16a6-acc4-4349-b4c7-ffdc41d3e64f","files":[]}

package/.nyc_output/processinfo/{6dd4f497-4c32-412e-906a-d5f84380dee6.json → ad191300-a822-422a-892c-f6bdd9f65622.json}

@@ -1 +1 @@
-{"parent":"5a2007e8-1bda-4eda-b271-6d7323d49bdd","pid":5611,"argv":["/opt/hostedtoolcache/node/16.18.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1670907492165,"ppid":5578,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/6dd4f497-4c32-412e-906a-d5f84380dee6.json","externalId":"","uuid":"6dd4f497-4c32-412e-906a-d5f84380dee6","files":[]}
+{"parent":"c1702c73-10b3-4031-a62b-78de0f5a0eda","pid":5441,"argv":["/opt/hostedtoolcache/node/16.18.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1671138229848,"ppid":5424,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/ad191300-a822-422a-892c-f6bdd9f65622.json","externalId":"","uuid":"ad191300-a822-422a-892c-f6bdd9f65622","files":[]}

package/.nyc_output/processinfo/{bc1d4fe0-2b67-4190-bcd2-9fd06daf74c0.json → b63e9a5b-2daa-4333-9cbc-511e31b8dec0.json}

@@ -1 +1 @@
-{"parent":"5a2007e8-1bda-4eda-b271-6d7323d49bdd","pid":5595,"argv":["/opt/hostedtoolcache/node/16.18.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1670907491816,"ppid":5578,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/bc1d4fe0-2b67-4190-bcd2-9fd06daf74c0.json","externalId":"","uuid":"bc1d4fe0-2b67-4190-bcd2-9fd06daf74c0","files":[]}
+{"parent":"c1702c73-10b3-4031-a62b-78de0f5a0eda","pid":5435,"argv":["/opt/hostedtoolcache/node/16.18.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1671138229841,"ppid":5424,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/b63e9a5b-2daa-4333-9cbc-511e31b8dec0.json","externalId":"","uuid":"b63e9a5b-2daa-4333-9cbc-511e31b8dec0","files":[]}

package/.nyc_output/processinfo/c1702c73-10b3-4031-a62b-78de0f5a0eda.json

@@ -0,0 +1 @@
+{"parent":null,"pid":5424,"argv":["/opt/hostedtoolcache/node/16.18.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/cli.js","-v"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1671138229402,"ppid":5413,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/c1702c73-10b3-4031-a62b-78de0f5a0eda.json","externalId":"","uuid":"c1702c73-10b3-4031-a62b-78de0f5a0eda","files":[]}

package/.nyc_output/processinfo/{bc6fd14e-b803-4750-ac28-dfe4b8d1c235.json → d9c4bafc-f898-4591-b134-c70616d033a8.json}

@@ -1 +1 @@
-{"parent":"5a2007e8-1bda-4eda-b271-6d7323d49bdd","pid":5589,"argv":["/opt/hostedtoolcache/node/16.18.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1670907491810,"ppid":5578,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/bc6fd14e-b803-4750-ac28-dfe4b8d1c235.json","externalId":"","uuid":"bc6fd14e-b803-4750-ac28-dfe4b8d1c235","files":[]}
+{"parent":"c1702c73-10b3-4031-a62b-78de0f5a0eda","pid":5457,"argv":["/opt/hostedtoolcache/node/16.18.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1671138230206,"ppid":5424,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/d9c4bafc-f898-4591-b134-c70616d033a8.json","externalId":"","uuid":"d9c4bafc-f898-4591-b134-c70616d033a8","files":[]}

package/.nyc_output/processinfo/index.json

@@ -1 +1 @@
-{"processes":{"4266a04d-f79f-4e25-82b5-a5503aad4653":{"parent":"5a2007e8-1bda-4eda-b271-6d7323d49bdd","children":[]},"5a2007e8-1bda-4eda-b271-6d7323d49bdd":{"parent":null,"children":["4266a04d-f79f-4e25-82b5-a5503aad4653","6dd4f497-4c32-412e-906a-d5f84380dee6","bc1d4fe0-2b67-4190-bcd2-9fd06daf74c0","bc6fd14e-b803-4750-ac28-dfe4b8d1c235"]},"6dd4f497-4c32-412e-906a-d5f84380dee6":{"parent":"5a2007e8-1bda-4eda-b271-6d7323d49bdd","children":[]},"bc1d4fe0-2b67-4190-bcd2-9fd06daf74c0":{"parent":"5a2007e8-1bda-4eda-b271-6d7323d49bdd","children":[]},"bc6fd14e-b803-4750-ac28-dfe4b8d1c235":{"parent":"5a2007e8-1bda-4eda-b271-6d7323d49bdd","children":[]}},"files":{},"externalIds":{}}
+{"processes":{"344d16a6-acc4-4349-b4c7-ffdc41d3e64f":{"parent":"c1702c73-10b3-4031-a62b-78de0f5a0eda","children":[]},"ad191300-a822-422a-892c-f6bdd9f65622":{"parent":"c1702c73-10b3-4031-a62b-78de0f5a0eda","children":[]},"b63e9a5b-2daa-4333-9cbc-511e31b8dec0":{"parent":"c1702c73-10b3-4031-a62b-78de0f5a0eda","children":[]},"c1702c73-10b3-4031-a62b-78de0f5a0eda":{"parent":null,"children":["344d16a6-acc4-4349-b4c7-ffdc41d3e64f","ad191300-a822-422a-892c-f6bdd9f65622","b63e9a5b-2daa-4333-9cbc-511e31b8dec0","d9c4bafc-f898-4591-b134-c70616d033a8"]},"d9c4bafc-f898-4591-b134-c70616d033a8":{"parent":"c1702c73-10b3-4031-a62b-78de0f5a0eda","children":[]}},"files":{},"externalIds":{}}

package/lib/engine.js

@@ -15,6 +15,22 @@ const dig = (obj, path) => {
     return obj;
 }
 
+let mapHugoVariablesToParams = (obj, path) => {
+    let resolved = {};
+    for (let [k,v] of Object.entries(obj)) {
+        if (k.startsWith('$')) {
+            const remapped = `__bksh_${k.substring(1)}`;
+            obj[remapped] = v;
+            resolved[k] = `${path}.${remapped}`;
+        } else {
+            if (typeof v === 'object' && !Array.isArray(v)) {
+                resolved = {...resolved, ...mapHugoVariablesToParams(v, `${path}.${k}`)}
+            }
+        }
+    }
+    return resolved
+}
+
 export class Engine {
     constructor(options) {
         options = {
@@ -224,24 +240,69 @@ export class Engine {
         }
     }
 
-    async eval(str, props = [{}]) {
+    async eval(str, props = [{}], logger) {
         while (!window.buildHugo) await sleep(10);
         let props_obj = props.reduce((a, b) => { return { ...a, ...b } });
+        let full_props = props_obj;
 
         // We're capable of looking up a simple variable
         // (and it's hard to pass to wasm since we store variables on the context)
         if (/^\$/.test(str)) {
-            return props_obj[str] ?? null;
+            logger?.log?.(`Trying to short circuit to return a variable`);
+            if (props_obj[str]) return props_obj[str];
         }
 
         // If we have assigned a root scope we need to pass that in as the context
-        if (props_obj["."]) props_obj = props_obj["."];
+        if (props_obj["."]) {
+            logger?.log?.(`Nesting the props object into its dot scope`);
+            props_obj = props_obj["."];
+        }
+
+        if (str === ".") {
+            logger?.log?.(`Short circuiting dot notation to return the scope`);
+            return props_obj;
+        }
+
+        let normalized = this.normalize(str);
+        if (typeof normalized === 'object') {
+            logger?.log?.(`Digging into the object ${JSON.stringify(normalized)}`);
+            const process = async (obj)  => {
+                for (const [k,v] of Object.entries(obj)) {
+                    if (typeof v === "string") {
+                        if (/^".*"$/.test(v)) {
+                            // Normalized strings look like "\"string\""
+                            logger?.log?.(`Unwrapping the string ${k}: ${v}`);
+                            obj[k] = JSON.parse(v);
+                        } else {
+                            // No inner quotes means it needs to be evaled again
+                            logger?.log?.(`Evaluating the inner ${k}: ${v}`);
+                            obj[k] = await this.eval(v, [props_obj], logger.nested());
+                        }
+                    } else if (typeof v === "object") {
+                        logger?.log?.(`Processing the inner object ${k}`);
+                    }
+                }
+            }
+            await process(normalized);
+            return normalized;
+        }
+        if (/^\w+(\.\w+)*$/.test(normalized)) {
+            logger?.log?.(`Trying to short circuit to return the dot notation ${normalized}`);
+            // We're capable of looking up a simple dot notation access
+            const result = dig(props_obj, normalized);
+            if (result !== undefined) return result
+        }
 
         // Rewrite array.0 into index array 0
         str = str.replace(/(.*)\.(\d+)$/, (_, obj, index) => {
             return `index (${obj}) ${index}`;
         })
 
+        const variable_pairs = mapHugoVariablesToParams(full_props, ".Params.full_props");
+        const variable_decl = Object.entries(variable_pairs).map(([k,v]) => {
+            return `{{ ${k} := ${v} }}`
+        }).join('');
+
         const assignments = Object.entries(props_obj).filter(([key]) => key.startsWith('$')).map(([key, value]) => {
             if (Array.isArray(value)) {
                 return `{{ ${key} := index ( \`{"a": ${JSON.stringify(value)}}\` | transform.Unmarshal ) "a" }}`
@@ -251,10 +312,10 @@ export class Engine {
                 return `{{ ${key} := ${JSON.stringify(value)} }}`
             }
         }).join('');
-        const eval_str = `{{ with .Params.props }}${assignments}{{ jsonify (${str}) }}{{ end }}`;
+        const eval_str = `${variable_decl}{{ with .Params.props }}${assignments}{{ jsonify (${str}) }}{{ end }}`;
         window.writeHugoFiles(JSON.stringify({
             "layouts/index.html": eval_str,
-            "content/_index.md": JSON.stringify({ props: props_obj }, null, 2)
+            "content/_index.md": JSON.stringify({ props: props_obj, full_props: full_props }, null, 2)
         }));
 
         const buildError = window.buildHugo();

package/lib/hugoIdentifierParser.js

@@ -36,11 +36,6 @@ export class IdentifierParser {
       return `${variable}.${index}`;
     }
 
-    // strip the leading .Params. from basic variable references
-    // if (/^\s*\./.test(this.input)) {
-    //   return this.input.replace(/^\s*\.Params\.([^\.\s])/, '$1');
-    // }
-
     // strip the leading . from basic variable references
     if (/^\s*\./.test(this.input)) {
       return this.input.replace(/^\s*\.([^\.\s])/, '$1');

package/lib/translateTextTemplate.js

@@ -2,6 +2,8 @@ import { Tokenizer } from 'liquidjs';
 
 // Homebrewed pretty-regex writer
 const tokens = {
+    ENTER_COMMENT: `\\*/}}`,
+    EXIT_COMMENT: `{{/\\*`,
     END: `{{ end }}`,
     BEGIN: `{{ (if)`,
     BEGIN_SCOPED: `{{ (range|with|define|block|template)`,
@@ -11,6 +13,7 @@ const tokens = {
     REASSIGN: `{{ (\\$\\S+)  =  () }}`,
     WITH: `{{ with  () }}`,
     BOOKSHOP: `{{ partial  "bookshop"  \\( slice "()" () \\) }}`,
+    BOOKSHOP_VAR: `{{ partial  "bookshop"  \\( slice (\\S+) () \\) }}`,
     BOOKSHOP_SCOPED: `{{ partial  "bookshop"  \\(? \\. \\)? }}`,
 }
 
@@ -26,30 +29,42 @@ Object.entries(tokens).forEach(([name, r]) => {
  * that we already have in the bundle.
  * All go templating tags will come through as value tokens.
  */
-const rewriteTag = function (token, src, endTags, liveMarkup) {
+const rewriteTag = function (token, src, state, liveMarkup) {
     let raw = token.getText();
     let outputToken = {
         text: raw
     }
 
+    if (TOKENS.ENTER_COMMENT.test(raw)) {
+        state.inComment = true
+    }
+    if (TOKENS.EXIT_COMMENT.test(raw)) {
+        state.inComment = false
+        return outputToken;
+    }
+    if (state.inComment) {
+        return outputToken;
+    }
     // Skip non-value tags
     if (token.kind !== 8) return outputToken;
+
     if (TOKENS.END.test(raw)) {
-        endTags.push(outputToken);
+        state.endTags.push(outputToken);
         return outputToken;
     }
 
     if (TOKENS.BEGIN.test(raw)) {
-        endTags.pop();
+        state.endTags.pop();
     }
 
     if (TOKENS.BEGIN_SCOPED.test(raw)) {
         outputToken.text = `${outputToken.text}{{ \`<!--bookshop-live stack-->\` | safeHTML }}`;
 
-        let matchingEnd = endTags.pop();
+        let matchingEnd = state.endTags.pop();
         matchingEnd.text = `{{ \`<!--bookshop-live unstack-->\` | safeHTML }}${matchingEnd.text}`;
     }
 
+
     if (liveMarkup && TOKENS.INDEX_LOOP.test(raw)) {
         let [, index_variable, iterator] = raw.match(TOKENS.INDEX_LOOP);
         const r = required_wrapper_hugo_func(iterator);
@@ -89,6 +104,10 @@ const rewriteTag = function (token, src, endTags, liveMarkup) {
             `${outputToken.text}`,
             `{{ \`<!--bookshop-live end-->\` | safeHTML }}`
         ].join('');
+    } else if (liveMarkup && TOKENS.BOOKSHOP_VAR.test(raw)) {
+        let [, variable, params] = raw.match(TOKENS.BOOKSHOP_VAR);
+        const r = required_wrapper_hugo_func(params);
+        outputToken.text = `{{${r[0]} (printf \`<!--bookshop-live name(%s) params(.: (${tidy(params)}))-->\`${r[1]} (${variable})) | safeHTML }}${outputToken.text}{{ \`<!--bookshop-live end-->\` | safeHTML }}`
     }
 
     return outputToken;
@@ -111,10 +130,13 @@ export default function (text, opts) {
     const tokenizer = new Tokenizer(text.toString());
     const tokens = tokenizer.readTopLevelTokens();
     const output = [];
-    const endTags = [];
+    const state = {
+        endTags: [],
+        inComment: false
+    };
 
     tokens.reverse().forEach(tag => {
-        output.unshift(rewriteTag(tag, text, endTags, opts.liveMarkup));
+        output.unshift(rewriteTag(tag, text, state, opts.liveMarkup));
     });
 
     return output.map(t => t.text).join('');

package/lib/translateTextTemplate.test.js

@@ -11,6 +11,16 @@ test("add live markup to bookshop tags", t => {
     t.is(translateTextTemplate(input, {}), expected);
 });
 
+test("add live markup to bookshop tags referencing variables", t => {
+    const input = `{{ partial "bookshop" (slice .item._bookshop_name .item.something )}}`;
+    const expected = [
+        `{{ (printf \`<!--bookshop-live name(%s) params(.: (.item.something))-->\` (.item._bookshop_name)) | safeHTML }}`,
+        `{{ partial "bookshop" (slice .item._bookshop_name .item.something )}}`,
+        `{{ \`<!--bookshop-live end-->\` | safeHTML }}`
+    ].join('');
+    t.is(translateTextTemplate(input, {}), expected);
+});
+
 test("add live markup to scoped bookshop tags", t => {
     const input = `{{ partial "bookshop" . }}`;
     const expected = [
@@ -30,8 +40,18 @@ test("don't add live markup to bookshop_partial tags", t => {
 
 test("don't add live markup if no bookshop found", t => {
     let input = `{{ $a := .b }}`;
-    let expected = `{{ $a := .b }}`;
-    t.is(translateTextTemplate(input, {}), expected);
+    t.is(translateTextTemplate(input, {}), input);
+});
+
+test("don't add live markup to commented out regions", t => {
+    const input = [
+        `{{/* comment start <div>`,
+        ` . {{ partial "bookshop" (slice "content" (dict "content_html" .Params.note_html "type" "note")) }}`,
+        ` <h1> Hello World </h1>`,
+        ` . {{ partial "bookshop" . }}`,
+        `</div> comment end */}}`
+    ].join('\n');
+    t.is(translateTextTemplate(input, {}), input);
 });
 
 test("add live markup to assigns", t => {
@@ -175,4 +195,35 @@ test("add live markup to complex components", t => {
     {{ safeHTML $close }}
 {{ \`<!--bookshop-live unstack-->\` | safeHTML }}{{ end }}`;
     t.is(translateTextTemplate(input, {}), expected);
-});
+});
+
+// test("add live markup to another complex component", t => {
+//     const input = `
+// {{ if site.Params.env_bookshop_live }}
+
+// {{ partial "bookshop" (slice "layout_options" (slice (partial "bookshop" (slice "filtered_posts/component" .)) .)) }} 
+
+// {{ else }}
+// {{ $content := partial "bookshop" (slice "filtered_posts/component" .) }}
+// {{ $content = $content | strings.ReplaceRE \`<!--.*?-->\` "" | strings.ReplaceRE \`^\s+(.*?)\s+$\` "$1" | safeHTML }}
+
+// {{ if $content }}
+//     {{ partial "bookshop" (slice "layout_options" (slice $content .)) }} 
+// {{ end }}
+// {{ end }}`;
+//     const expected = `
+// {{ if site.Params.env_bookshop_live }}
+
+// {{ partial "bookshop" (slice "layout_options" (slice (partial "bookshop" (slice "filtered_posts/component" .)) .)) }} 
+
+// {{ else }}
+// {{ $content := partial "bookshop" (slice "filtered_posts/component" .) }}
+// {{ $content = $content | strings.ReplaceRE \`<!--.*?-->\` "" | strings.ReplaceRE \`^\s+(.*?)\s+$\` "$1" | safeHTML }}
+
+// {{ if $content }}
+//     {{ partial "bookshop" (slice "layout_options" (slice $content .)) }} 
+// {{ end }}
+// {{ end }}`;
+// console.log(translateTextTemplate(input, {}))
+//     t.is(translateTextTemplate(input, {}), expected);
+// });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bookshop/hugo-engine",
   "packageManager": "yarn@3.0.0",
-  "version": "3.4.0-beta.1",
+  "version": "3.4.0-beta.3",
   "description": "Bookshop frontend Hugo renderer",
   "type": "module",
   "sideEffects": false,
@@ -30,7 +30,7 @@
     "nyc": "^15.1.0"
   },
   "dependencies": {
-    "@bookshop/helpers": "3.4.0-beta.1",
+    "@bookshop/helpers": "3.4.0-beta.3",
     "esbuild": "^0.13.10",
     "fflate": "^0.7.3",
     "liquidjs": "9.28.0"

package/.nyc_output/processinfo/5a2007e8-1bda-4eda-b271-6d7323d49bdd.json

@@ -1 +0,0 @@
-{"parent":null,"pid":5578,"argv":["/opt/hostedtoolcache/node/16.18.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/cli.js","-v"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1670907491400,"ppid":5566,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/5a2007e8-1bda-4eda-b271-6d7323d49bdd.json","externalId":"","uuid":"5a2007e8-1bda-4eda-b271-6d7323d49bdd","files":[]}