minijinja-js 2.12.0 → 2.13.0

package/dist/bundler/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/bundler/package.json

@@ -5,7 +5,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/node/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

package/dist/node/minijinja_js.d.ts

@@ -6,34 +6,46 @@ type UndefinedBehavior = "strict" | "chainable" | "lenient" | "semi_strct";
  */
 export class Environment {
   free(): void;
-  constructor();
   /**
    * Registers a new template by name and source.
    */
   addTemplate(name: string, source: string): void;
   /**
-   * Removes a template by name.
+   * Removes a global again.
    */
-  removeTemplate(name: string): void;
+  removeGlobal(name: string): void;
   /**
    * Clears all templates from the environment.
    */
   clearTemplates(): void;
+  /**
+   * Enables python compatibility.
+   */
+  enablePyCompat(): void;
+  /**
+   * Removes a template by name.
+   */
+  removeTemplate(name: string): void;
+  /**
+   * Like `renderStr` but with a named template for auto escape detection.
+   */
+  renderNamedStr(name: string, source: string, ctx: any): string;
   /**
    * Renders a registered template by name with the given context.
    */
   renderTemplate(name: string, ctx: any): string;
   /**
-   * Renders a string template with the given context.
+   * Sets a callback to join template paths (for relative includes/extends).
    *
-   * This is useful for one-off template rendering without registering the template.  The
-   * template is parsed and rendered immediately.
+   * 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.
    */
-  renderStr(source: string, ctx: any): string;
+  setPathJoinCallback(func: Function): void;
+  constructor();
   /**
-   * Like `renderStr` but with a named template for auto escape detection.
+   * Registers a test function.
    */
-  renderNamedStr(name: string, source: string, ctx: any): string;
+  addTest(name: string, func: Function): void;
   /**
    * Evaluates an expression with the given context.
    *
@@ -45,26 +57,25 @@ export class Environment {
    * Registers a filter function.
    */
   addFilter(name: string, func: Function): void;
-  /**
-   * Registers a test function.
-   */
-  addTest(name: string, func: Function): void;
-  /**
-   * Enables python compatibility.
-   */
-  enablePyCompat(): void;
   /**
    * Registers a value as global.
    */
   addGlobal(name: string, value: any): void;
   /**
-   * Removes a global again.
+   * 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.
    */
-  removeGlobal(name: string): void;
+  renderStr(source: string, ctx: any): string;
   /**
-   * Enables or disables debug mode.
+   * 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.
    */
-  debug: boolean;
+  setLoader(func: Function): void;
   /**
    * Enables or disables block trimming.
    */
@@ -73,17 +84,21 @@ export class Environment {
    * Enables or disables the lstrip blocks feature.
    */
   lstripBlocks: boolean;
-  /**
-   * Enables or disables keeping of the final newline.
-   */
-  keepTrailingNewline: boolean;
   /**
    * Reconfigures the behavior of undefined variables.
    */
   undefinedBehavior: UndefinedBehavior;
+  /**
+   * Enables or disables keeping of the final newline.
+   */
+  keepTrailingNewline: boolean;
   /**
    * Configures the max-fuel for template evaluation.
    */
   get fuel(): number | undefined;
   set fuel(value: number | null | undefined);
+  /**
+   * Enables or disables debug mode.
+   */
+  debug: boolean;
 }