@budibase/string-templates 2.21.9 → 2.22.0

package/dist/iife.d.ts

@@ -0,0 +1 @@
+export function iifeWrapper(script: any): string;

package/dist/index.d.ts

@@ -16,4 +16,5 @@ export function convertToJS(hbs: any): string;
 import { FIND_ANY_HBS_REGEX } from "./utilities";
 import { helpersToRemoveForJs } from "./helpers/list";
 export function defaultJSSetup(): void;
-export { setJSRunner, setOnErrorLog, FIND_ANY_HBS_REGEX, JsErrorTimeout, helpersToRemoveForJs };
+import { iifeWrapper } from "./iife";
+export { setJSRunner, setOnErrorLog, FIND_ANY_HBS_REGEX, JsErrorTimeout, helpersToRemoveForJs, iifeWrapper };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@budibase/string-templates",
-  "version": "2.21.9",
+  "version": "2.22.0",
   "description": "Handlebars wrapper for Budibase templating.",
   "main": "src/index.js",
   "module": "dist/bundle.mjs",
@@ -12,7 +12,8 @@
       "import": "./dist/bundle.mjs"
     },
     "./package.json": "./package.json",
-    "./test/utils": "./test/utils.js"
+    "./test/utils": "./test/utils.js",
+    "./iife": "./src/iife.js"
   },
   "files": [
     "dist",
@@ -46,5 +47,5 @@
     "rollup-plugin-terser": "^7.0.2",
     "typescript": "5.2.2"
   },
-  "gitHead": "901d6ae4116d0199b2a68e5be38c8dc5658b48e7"
+  "gitHead": "45f438318a63b0f60cbee8cef5115ca7947f356b"
 }

package/src/helpers/javascript.js

@@ -2,6 +2,7 @@ const { atob, isBackendService, isJSAllowed } = require("../utilities")
 const cloneDeep = require("lodash.clonedeep")
 const { LITERAL_MARKER } = require("../helpers/constants")
 const { getJsHelperList } = require("./list")
+const { iifeWrapper } = require("../iife")
 
 // The method of executing JS scripts depends on the bundle being built.
 // This setter is used in the entrypoint (either index.js or index.mjs).
@@ -48,14 +49,36 @@ module.exports.processJS = (handlebars, context) => {
   try {
     // Wrap JS in a function and immediately invoke it.
     // This is required to allow the final `return` statement to be valid.
-    const js = `(function(){${atob(handlebars)}})();`
+    const js = iifeWrapper(atob(handlebars))
+
+    // Transform snippets into an object for faster access, and cache previously
+    // evaluated snippets
+    let snippetMap = {}
+    let snippetCache = {}
+    for (let snippet of context.snippets || []) {
+      snippetMap[snippet.name] = snippet.code
+    }
 
     // Our $ context function gets a value from context.
     // We clone the context to avoid mutation in the binding affecting real
     // app context.
+    const clonedContext = cloneDeep({ ...context, snippets: null })
     const sandboxContext = {
-      $: path => getContextValue(path, cloneDeep(context)),
+      $: path => getContextValue(path, clonedContext),
       helpers: getJsHelperList(),
+
+      // Proxy to evaluate snippets when running in the browser
+      snippets: new Proxy(
+        {},
+        {
+          get: function (_, name) {
+            if (!(name in snippetCache)) {
+              snippetCache[name] = eval(iifeWrapper(snippetMap[name]))
+            }
+            return snippetCache[name]
+          },
+        }
+      ),
     }
 
     // Create a sandbox with our context and run the JS

package/src/iife.js

@@ -0,0 +1,3 @@
+module.exports.iifeWrapper = script => {
+  return `(function(){\n${script}\n})();`
+}

package/src/index.js

@@ -3,6 +3,7 @@ const handlebars = require("handlebars")
 const { registerAll, registerMinimum } = require("./helpers/index")
 const processors = require("./processors")
 const { atob, btoa, isBackendService } = require("./utilities")
+const { iifeWrapper } = require("./iife")
 const manifest = require("../manifest.json")
 const {
   FIND_HBS_REGEX,
@@ -426,3 +427,4 @@ function defaultJSSetup() {
 defaultJSSetup()
 
 module.exports.defaultJSSetup = defaultJSSetup
+module.exports.iifeWrapper = iifeWrapper