minijinja-js 2.12.0 → 2.13.0

package/dist/node/minijinja_js.js

@@ -214,11 +214,13 @@ class Environment {
         const ptr = this.__destroy_into_raw();
         wasm.__wbg_environment_free(ptr, 0);
     }
-    constructor() {
-        const ret = wasm.environment_new();
-        this.__wbg_ptr = ret >>> 0;
-        EnvironmentFinalization.register(this, this.__wbg_ptr, this);
-        return this;
+    /**
+     * Enables or disables block trimming.
+     * @returns {boolean}
+     */
+    get trimBlocks() {
+        const ret = wasm.environment_trimBlocks(this.__wbg_ptr);
+        return ret !== 0;
     }
     /**
      * Registers a new template by name and source.
@@ -243,13 +245,21 @@ class Environment {
         }
     }
     /**
-     * Removes a template by name.
+     * Enables or disables the lstrip blocks feature.
+     * @returns {boolean}
+     */
+    get lstripBlocks() {
+        const ret = wasm.environment_lstripBlocks(this.__wbg_ptr);
+        return ret !== 0;
+    }
+    /**
+     * Removes a global again.
      * @param {string} name
      */
-    removeTemplate(name) {
+    removeGlobal(name) {
         const ptr0 = passStringToWasm0(name, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
         const len0 = WASM_VECTOR_LEN;
-        wasm.environment_removeTemplate(this.__wbg_ptr, ptr0, len0);
+        wasm.environment_removeGlobal(this.__wbg_ptr, ptr0, len0);
     }
     /**
      * Clears all templates from the environment.
@@ -258,71 +268,19 @@ class Environment {
         wasm.environment_clearTemplates(this.__wbg_ptr);
     }
     /**
-     * Renders a registered template by name with the given context.
-     * @param {string} name
-     * @param {any} ctx
-     * @returns {string}
+     * Enables python compatibility.
      */
-    renderTemplate(name, ctx) {
-        let deferred3_0;
-        let deferred3_1;
-        try {
-            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
-            const ptr0 = passStringToWasm0(name, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
-            const len0 = WASM_VECTOR_LEN;
-            wasm.environment_renderTemplate(retptr, this.__wbg_ptr, ptr0, len0, addHeapObject(ctx));
-            var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
-            var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
-            var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
-            var r3 = getDataViewMemory0().getInt32(retptr + 4 * 3, true);
-            var ptr2 = r0;
-            var len2 = r1;
-            if (r3) {
-                ptr2 = 0; len2 = 0;
-                throw takeObject(r2);
-            }
-            deferred3_0 = ptr2;
-            deferred3_1 = len2;
-            return getStringFromWasm0(ptr2, len2);
-        } finally {
-            wasm.__wbindgen_add_to_stack_pointer(16);
-            wasm.__wbindgen_export_3(deferred3_0, deferred3_1, 1);
-        }
+    enablePyCompat() {
+        wasm.environment_enablePyCompat(this.__wbg_ptr);
     }
     /**
-     * Renders a string template with the given context.
-     *
-     * This is useful for one-off template rendering without registering the template.  The
-     * template is parsed and rendered immediately.
-     * @param {string} source
-     * @param {any} ctx
-     * @returns {string}
+     * Removes a template by name.
+     * @param {string} name
      */
-    renderStr(source, ctx) {
-        let deferred3_0;
-        let deferred3_1;
-        try {
-            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
-            const ptr0 = passStringToWasm0(source, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
-            const len0 = WASM_VECTOR_LEN;
-            wasm.environment_renderStr(retptr, this.__wbg_ptr, ptr0, len0, addHeapObject(ctx));
-            var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
-            var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
-            var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
-            var r3 = getDataViewMemory0().getInt32(retptr + 4 * 3, true);
-            var ptr2 = r0;
-            var len2 = r1;
-            if (r3) {
-                ptr2 = 0; len2 = 0;
-                throw takeObject(r2);
-            }
-            deferred3_0 = ptr2;
-            deferred3_1 = len2;
-            return getStringFromWasm0(ptr2, len2);
-        } finally {
-            wasm.__wbindgen_add_to_stack_pointer(16);
-            wasm.__wbindgen_export_3(deferred3_0, deferred3_1, 1);
-        }
+    removeTemplate(name) {
+        const ptr0 = passStringToWasm0(name, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
+        const len0 = WASM_VECTOR_LEN;
+        wasm.environment_removeTemplate(this.__wbg_ptr, ptr0, len0);
     }
     /**
      * Like `renderStr` but with a named template for auto escape detection.
@@ -360,99 +318,57 @@ class Environment {
         }
     }
     /**
-     * Evaluates an expression with the given context.
-     *
-     * This is useful for evaluating expressions outside of templates.  The expression is
-     * parsed and evaluated immediately.
-     * @param {string} expr
+     * Renders a registered template by name with the given context.
+     * @param {string} name
      * @param {any} ctx
-     * @returns {any}
+     * @returns {string}
      */
-    evalExpr(expr, ctx) {
+    renderTemplate(name, ctx) {
+        let deferred3_0;
+        let deferred3_1;
         try {
             const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
-            const ptr0 = passStringToWasm0(expr, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
+            const ptr0 = passStringToWasm0(name, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
             const len0 = WASM_VECTOR_LEN;
-            wasm.environment_evalExpr(retptr, this.__wbg_ptr, ptr0, len0, addHeapObject(ctx));
+            wasm.environment_renderTemplate(retptr, this.__wbg_ptr, ptr0, len0, addHeapObject(ctx));
             var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
             var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
             var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
-            if (r2) {
-                throw takeObject(r1);
+            var r3 = getDataViewMemory0().getInt32(retptr + 4 * 3, true);
+            var ptr2 = r0;
+            var len2 = r1;
+            if (r3) {
+                ptr2 = 0; len2 = 0;
+                throw takeObject(r2);
             }
-            return takeObject(r0);
+            deferred3_0 = ptr2;
+            deferred3_1 = len2;
+            return getStringFromWasm0(ptr2, len2);
         } finally {
             wasm.__wbindgen_add_to_stack_pointer(16);
+            wasm.__wbindgen_export_3(deferred3_0, deferred3_1, 1);
         }
     }
-    /**
-     * Registers a filter function.
-     * @param {string} name
-     * @param {Function} func
-     */
-    addFilter(name, func) {
-        const ptr0 = passStringToWasm0(name, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
-        const len0 = WASM_VECTOR_LEN;
-        wasm.environment_addFilter(this.__wbg_ptr, ptr0, len0, addHeapObject(func));
-    }
-    /**
-     * Registers a test function.
-     * @param {string} name
-     * @param {Function} func
-     */
-    addTest(name, func) {
-        const ptr0 = passStringToWasm0(name, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
-        const len0 = WASM_VECTOR_LEN;
-        wasm.environment_addTest(this.__wbg_ptr, ptr0, len0, addHeapObject(func));
-    }
-    /**
-     * Enables python compatibility.
-     */
-    enablePyCompat() {
-        wasm.environment_enablePyCompat(this.__wbg_ptr);
-    }
-    /**
-     * Enables or disables debug mode.
-     * @returns {boolean}
-     */
-    get debug() {
-        const ret = wasm.environment_debug(this.__wbg_ptr);
-        return ret !== 0;
-    }
-    /**
-     * @param {boolean} yes
-     */
-    set debug(yes) {
-        wasm.environment_set_debug(this.__wbg_ptr, yes);
-    }
-    /**
-     * Enables or disables block trimming.
-     * @returns {boolean}
-     */
-    get trimBlocks() {
-        const ret = wasm.environment_trimBlocks(this.__wbg_ptr);
-        return ret !== 0;
-    }
     /**
      * @param {boolean} yes
      */
     set trimBlocks(yes) {
         wasm.environment_set_trimBlocks(this.__wbg_ptr, yes);
     }
-    /**
-     * Enables or disables the lstrip blocks feature.
-     * @returns {boolean}
-     */
-    get lstripBlocks() {
-        const ret = wasm.environment_lstripBlocks(this.__wbg_ptr);
-        return ret !== 0;
-    }
     /**
      * @param {boolean} yes
      */
     set lstripBlocks(yes) {
         wasm.environment_set_lstripBlocks(this.__wbg_ptr, yes);
     }
+    /**
+     * Reconfigures the behavior of undefined variables.
+     * @returns {UndefinedBehavior}
+     */
+    get undefinedBehavior() {
+        const ret = wasm.environment_undefinedBehavior(this.__wbg_ptr);
+        return __wbindgen_enum_UndefinedBehavior[ret];
+    }
     /**
      * Enables or disables keeping of the final newline.
      * @returns {boolean}
@@ -462,18 +378,14 @@ class Environment {
         return ret !== 0;
     }
     /**
-     * @param {boolean} yes
-     */
-    set keepTrailingNewline(yes) {
-        wasm.environment_set_keepTrailingNewline(this.__wbg_ptr, yes);
-    }
-    /**
-     * Reconfigures the behavior of undefined variables.
-     * @returns {UndefinedBehavior}
+     * Sets a callback to join template paths (for relative includes/extends).
+     *
+     * The callback receives `(name, parent)` and should return a joined path string.
+     * If it throws or returns a non-string, the original `name` is used.
+     * @param {Function} func
      */
-    get undefinedBehavior() {
-        const ret = wasm.environment_undefinedBehavior(this.__wbg_ptr);
-        return __wbindgen_enum_UndefinedBehavior[ret];
+    setPathJoinCallback(func) {
+        wasm.environment_setPathJoinCallback(this.__wbg_ptr, addHeapObject(func));
     }
     /**
      * @param {UndefinedBehavior} value
@@ -491,6 +403,18 @@ class Environment {
             wasm.__wbindgen_add_to_stack_pointer(16);
         }
     }
+    /**
+     * @param {boolean} yes
+     */
+    set keepTrailingNewline(yes) {
+        wasm.environment_set_keepTrailingNewline(this.__wbg_ptr, yes);
+    }
+    constructor() {
+        const ret = wasm.environment_new();
+        this.__wbg_ptr = ret >>> 0;
+        EnvironmentFinalization.register(this, this.__wbg_ptr, this);
+        return this;
+    }
     /**
      * Configures the max-fuel for template evaluation.
      * @returns {number | undefined}
@@ -499,12 +423,66 @@ class Environment {
         const ret = wasm.environment_fuel(this.__wbg_ptr);
         return ret === 0x100000001 ? undefined : ret;
     }
+    /**
+     * Enables or disables debug mode.
+     * @returns {boolean}
+     */
+    get debug() {
+        const ret = wasm.environment_debug(this.__wbg_ptr);
+        return ret !== 0;
+    }
+    /**
+     * Registers a test function.
+     * @param {string} name
+     * @param {Function} func
+     */
+    addTest(name, func) {
+        const ptr0 = passStringToWasm0(name, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
+        const len0 = WASM_VECTOR_LEN;
+        wasm.environment_addTest(this.__wbg_ptr, ptr0, len0, addHeapObject(func));
+    }
+    /**
+     * Evaluates an expression with the given context.
+     *
+     * This is useful for evaluating expressions outside of templates.  The expression is
+     * parsed and evaluated immediately.
+     * @param {string} expr
+     * @param {any} ctx
+     * @returns {any}
+     */
+    evalExpr(expr, ctx) {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            const ptr0 = passStringToWasm0(expr, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
+            const len0 = WASM_VECTOR_LEN;
+            wasm.environment_evalExpr(retptr, this.__wbg_ptr, ptr0, len0, addHeapObject(ctx));
+            var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+            var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+            var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
+            if (r2) {
+                throw takeObject(r1);
+            }
+            return takeObject(r0);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
     /**
      * @param {number | null} [value]
      */
     set fuel(value) {
         wasm.environment_set_fuel(this.__wbg_ptr, isLikeNone(value) ? 0x100000001 : (value) >>> 0);
     }
+    /**
+     * Registers a filter function.
+     * @param {string} name
+     * @param {Function} func
+     */
+    addFilter(name, func) {
+        const ptr0 = passStringToWasm0(name, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
+        const len0 = WASM_VECTOR_LEN;
+        wasm.environment_addFilter(this.__wbg_ptr, ptr0, len0, addHeapObject(func));
+    }
     /**
      * Registers a value as global.
      * @param {string} name
@@ -526,13 +504,56 @@ class Environment {
         }
     }
     /**
-     * Removes a global again.
-     * @param {string} name
+     * Renders a string template with the given context.
+     *
+     * This is useful for one-off template rendering without registering the template.  The
+     * template is parsed and rendered immediately.
+     * @param {string} source
+     * @param {any} ctx
+     * @returns {string}
      */
-    removeGlobal(name) {
-        const ptr0 = passStringToWasm0(name, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
-        const len0 = WASM_VECTOR_LEN;
-        wasm.environment_removeGlobal(this.__wbg_ptr, ptr0, len0);
+    renderStr(source, ctx) {
+        let deferred3_0;
+        let deferred3_1;
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            const ptr0 = passStringToWasm0(source, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
+            const len0 = WASM_VECTOR_LEN;
+            wasm.environment_renderStr(retptr, this.__wbg_ptr, ptr0, len0, addHeapObject(ctx));
+            var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+            var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+            var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
+            var r3 = getDataViewMemory0().getInt32(retptr + 4 * 3, true);
+            var ptr2 = r0;
+            var len2 = r1;
+            if (r3) {
+                ptr2 = 0; len2 = 0;
+                throw takeObject(r2);
+            }
+            deferred3_0 = ptr2;
+            deferred3_1 = len2;
+            return getStringFromWasm0(ptr2, len2);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+            wasm.__wbindgen_export_3(deferred3_0, deferred3_1, 1);
+        }
+    }
+    /**
+     * Registers a synchronous template loader callback.
+     *
+     * The provided function is called with a template name and must return a
+     * string with the template source or `null`/`undefined` if the template
+     * does not exist. Errors thrown are propagated as MiniJinja errors.
+     * @param {Function} func
+     */
+    setLoader(func) {
+        wasm.environment_setLoader(this.__wbg_ptr, addHeapObject(func));
+    }
+    /**
+     * @param {boolean} yes
+     */
+    set debug(yes) {
+        wasm.environment_set_debug(this.__wbg_ptr, yes);
     }
 }
 module.exports.Environment = Environment;
@@ -560,6 +581,16 @@ module.exports.__wbg_call_672a4d21634d4a24 = function() { return handleError(fun
     return addHeapObject(ret);
 }, arguments) };
 
+module.exports.__wbg_call_7cccdd69e0791ae2 = function() { return handleError(function (arg0, arg1, arg2) {
+    const ret = getObject(arg0).call(getObject(arg1), getObject(arg2));
+    return addHeapObject(ret);
+}, arguments) };
+
+module.exports.__wbg_call_833bed5770ea2041 = function() { return handleError(function (arg0, arg1, arg2, arg3) {
+    const ret = getObject(arg0).call(getObject(arg1), getObject(arg2), getObject(arg3));
+    return addHeapObject(ret);
+}, arguments) };
+
 module.exports.__wbg_done_769e5ede4b31c67b = function(arg0) {
     const ret = getObject(arg0).done;
     return ret;
@@ -796,6 +827,11 @@ module.exports.__wbindgen_is_function = function(arg0) {
     return ret;
 };
 
+module.exports.__wbindgen_is_null = function(arg0) {
+    const ret = getObject(arg0) === null;
+    return ret;
+};
+
 module.exports.__wbindgen_is_object = function(arg0) {
     const val = getObject(arg0);
     const ret = typeof(val) === 'object' && val !== null;
@@ -807,6 +843,11 @@ module.exports.__wbindgen_is_string = function(arg0) {
     return ret;
 };
 
+module.exports.__wbindgen_is_undefined = function(arg0) {
+    const ret = getObject(arg0) === undefined;
+    return ret;
+};
+
 module.exports.__wbindgen_jsval_eq = function(arg0, arg1) {
     const ret = getObject(arg0) === getObject(arg1);
     return ret;

package/dist/node/minijinja_js_bg.wasm.d.ts

@@ -2,31 +2,33 @@
 /* eslint-disable */
 export const memory: WebAssembly.Memory;
 export const __wbg_environment_free: (a: number, b: number) => void;
-export const environment_new: () => number;
-export const environment_addTemplate: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
-export const environment_removeTemplate: (a: number, b: number, c: number) => void;
-export const environment_clearTemplates: (a: number) => void;
-export const environment_renderTemplate: (a: number, b: number, c: number, d: number, e: number) => void;
-export const environment_renderStr: (a: number, b: number, c: number, d: number, e: number) => void;
-export const environment_renderNamedStr: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
-export const environment_evalExpr: (a: number, b: number, c: number, d: number, e: number) => void;
 export const environment_addFilter: (a: number, b: number, c: number, d: number) => void;
+export const environment_addGlobal: (a: number, b: number, c: number, d: number, e: number) => void;
+export const environment_addTemplate: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
 export const environment_addTest: (a: number, b: number, c: number, d: number) => void;
-export const environment_enablePyCompat: (a: number) => void;
+export const environment_clearTemplates: (a: number) => void;
 export const environment_debug: (a: number) => number;
-export const environment_set_debug: (a: number, b: number) => void;
-export const environment_trimBlocks: (a: number) => number;
-export const environment_set_trimBlocks: (a: number, b: number) => void;
-export const environment_lstripBlocks: (a: number) => number;
-export const environment_set_lstripBlocks: (a: number, b: number) => void;
+export const environment_enablePyCompat: (a: number) => void;
+export const environment_evalExpr: (a: number, b: number, c: number, d: number, e: number) => void;
+export const environment_fuel: (a: number) => number;
 export const environment_keepTrailingNewline: (a: number) => number;
+export const environment_lstripBlocks: (a: number) => number;
+export const environment_new: () => number;
+export const environment_removeGlobal: (a: number, b: number, c: number) => void;
+export const environment_removeTemplate: (a: number, b: number, c: number) => void;
+export const environment_renderNamedStr: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+export const environment_renderStr: (a: number, b: number, c: number, d: number, e: number) => void;
+export const environment_renderTemplate: (a: number, b: number, c: number, d: number, e: number) => void;
+export const environment_setLoader: (a: number, b: number) => void;
+export const environment_setPathJoinCallback: (a: number, b: number) => void;
+export const environment_set_debug: (a: number, b: number) => void;
+export const environment_set_fuel: (a: number, b: number) => void;
 export const environment_set_keepTrailingNewline: (a: number, b: number) => void;
-export const environment_undefinedBehavior: (a: number) => number;
+export const environment_set_lstripBlocks: (a: number, b: number) => void;
+export const environment_set_trimBlocks: (a: number, b: number) => void;
 export const environment_set_undefinedBehavior: (a: number, b: number, c: number) => void;
-export const environment_fuel: (a: number) => number;
-export const environment_set_fuel: (a: number, b: number) => void;
-export const environment_addGlobal: (a: number, b: number, c: number, d: number, e: number) => void;
-export const environment_removeGlobal: (a: number, b: number, c: number) => void;
+export const environment_trimBlocks: (a: number) => number;
+export const environment_undefinedBehavior: (a: number) => number;
 export const __wbindgen_export_0: (a: number, b: number) => number;
 export const __wbindgen_export_1: (a: number, b: number, c: number, d: number) => number;
 export const __wbindgen_export_2: (a: number) => void;

package/dist/node/package.json

@@ -4,7 +4,7 @@
     "Armin Ronacher <armin.ronacher@active-4.com>"
   ],
   "description": "a powerful template engine with minimal dependencies",
-  "version": "2.12.0",
+  "version": "2.13.0",
   "license": "Apache-2.0",
   "files": [
     "minijinja_js_bg.wasm",

package/dist/web/README.md

@@ -46,6 +46,38 @@ const result = env.renderTemplate('index.html', { name: 'World' });
 console.log(result);
 ```
 
+Resolve includes/extends from the filesystem (Node, etc...):
+
+```typescript
+import { Environment } from "minijinja-js";
+import fs from "node:fs";
+import path from "node:path";
+
+const env = new Environment();
+
+// Resolve relative paths like "./partial.html" against the parent template
+env.setPathJoinCallback((name, parent) => {
+  const parentDir = parent ? path.dirname(parent) : process.cwd();
+  const joined = path.resolve(parentDir, name);
+  return joined.replace(/\\\\/g, '/');
+});
+
+// Synchronous loader: return template source or null/undefined if missing
+env.setLoader((name) => {
+  try {
+    return fs.readFileSync(name, "utf8");
+  } catch {
+    return null;
+  }
+});
+
+// Example: main in-memory, include from disk under ./templates/dir/inc.html
+const templatePath = path.resolve(process.cwd(), "templates/dir/main.html");
+env.addTemplate(templatePath, "Hello {% include './inc.html' %}!");
+console.log(env.renderTemplate(templatePath, { value: "World" }));
+// -> Hello [World]!
+```
+
 Evaluate an expression:
 
 ```typescript
@@ -74,6 +106,7 @@ others probably not so much.  You might run into the following:
 
 * Access of the template engine state from JavaScript is not possible.
 * You cannot register a custom auto escape callback or a finalizer
+* The loader is synchronous; use sync I/O in Node etc... (e.g. `fs.readFileSync`)
 * If the engine panics, the WASM runtime corrupts.
 
 ## Sponsor