minijinja-js 2.8.0

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

@@ -0,0 +1,34 @@
+/* tslint:disable */
+/* 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_addTest: (a: number, b: number, c: number, d: number) => void;
+export const environment_enablePyCompat: (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_keepTrailingNewline: (a: number) => number;
+export const environment_set_keepTrailingNewline: (a: number, b: number) => void;
+export const environment_undefinedBehavior: (a: number) => number;
+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 __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;
+export const __wbindgen_export_3: (a: number, b: number, c: number) => void;
+export const __wbindgen_add_to_stack_pointer: (a: number) => number;

package/dist/bundler/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "minijinja-js",
+  "type": "module",
+  "collaborators": [
+    "Armin Ronacher <armin.ronacher@active-4.com>"
+  ],
+  "description": "a powerful template engine with minimal dependencies",
+  "version": "2.8.0",
+  "license": "Apache-2.0",
+  "files": [
+    "minijinja_js_bg.wasm",
+    "minijinja_js.js",
+    "minijinja_js_bg.js",
+    "minijinja_js.d.ts"
+  ],
+  "main": "minijinja_js.js",
+  "types": "minijinja_js.d.ts",
+  "sideEffects": [
+    "./minijinja_js.js",
+    "./snippets/*"
+  ]
+}

package/dist/node/README.md

@@ -0,0 +1,82 @@
+<div align="center">
+  <img src="https://github.com/mitsuhiko/minijinja/raw/main/artwork/logo.png" alt="" width=320>
+  <p><strong>MiniJinja for JavaScript: a powerful template engine</strong></p>
+
+[![License](https://img.shields.io/github/license/mitsuhiko/minijinja)](https://github.com/mitsuhiko/minijinja/blob/main/LICENSE)
+[![Crates.io](https://img.shields.io/crates/d/minijinja.svg)](https://crates.io/crates/minijinja)
+[![rustc 1.63.0](https://img.shields.io/badge/rust-1.63%2B-orange.svg)](https://img.shields.io/badge/rust-1.63%2B-orange.svg)
+[![Documentation](https://docs.rs/minijinja/badge.svg)](https://docs.rs/minijinja)
+
+</div>
+
+`minijinja-js` is an experimental binding of
+[MiniJinja](https://github.com/mitsuhiko/minijinja) to JavaScript.  It has somewhat
+limited functionality compared to the Rust version.  These bindings use
+`wasm-bindgen`.
+
+You might want to use MiniJinja instead of Jinja2 when the full feature set
+of Jinja2 is not required and you want to have the same rendering experience
+of a data set between Rust, Python and JavaScript.
+
+This exposes a bunch of MiniJinja via wasm to the browser, but not all of it.
+
+This package can be useful if you have MiniJinja templates that you want to
+evaluate as a sandbox in a browser for a user or on the backend.  Given the
+overheads that this creates size and performance wise, it would not be wise to
+use this for actual template rendering in the browser.
+
+## Example
+
+Render a template from a string:
+
+```typescript
+import { Environment } from "minijinja-js";
+
+const env = new Environment();
+env.debug = true;
+const result = env.renderStr('Hello {{ name }}!', { name: 'World' });
+console.log(result);
+```
+
+Render a template registered to the engine:
+
+```typescript
+import { Environment } from "minijinja-js";
+
+const env = new Environment();
+env.addTemplate('index.html', 'Hello {{ name }}!');
+const result = env.renderTemplate('index.html', { name: 'World' });
+console.log(result);
+```
+
+Evaluate an expression:
+
+```typescript
+import { Environment } from "minijinja-js";
+
+const env = new Environment();
+const result = env.evalExpr('1 + 1', {});
+console.log(result);
+```
+
+## Known Limitations
+
+There are various limitations with the binding today, some of which can be fixed,
+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
+* If the engine panics, the WASM runtime corrupts.
+
+## Sponsor
+
+If you like the project and find it useful you can [become a
+sponsor](https://github.com/sponsors/mitsuhiko).
+
+## License and Links
+
+- [Documentation](https://docs.rs/minijinja/)
+- [Examples](https://github.com/mitsuhiko/minijinja/tree/main/examples)
+- [Issue Tracker](https://github.com/mitsuhiko/minijinja/issues)
+- [MiniJinja Playground](https://mitsuhiko.github.io/minijinja-playground/)
+- License: [Apache-2.0](https://github.com/mitsuhiko/minijinja/blob/main/LICENSE)

package/dist/node/minijinja_js.d.ts

@@ -0,0 +1,89 @@
+/* tslint:disable */
+/* eslint-disable */
+type UndefinedBehavior = "strict" | "chainable" | "lenient" | "semi_strct";
+/**
+ * Represents a MiniJinja environment.
+ */
+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.
+   */
+  removeTemplate(name: string): void;
+  /**
+   * Clears all templates from the environment.
+   */
+  clearTemplates(): void;
+  /**
+   * Renders a registered template by name with the given context.
+   */
+  renderTemplate(name: string, ctx: any): string;
+  /**
+   * 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.
+   */
+  renderStr(source: string, ctx: any): string;
+  /**
+   * Like `renderStr` but with a named template for auto escape detection.
+   */
+  renderNamedStr(name: string, source: string, ctx: any): string;
+  /**
+   * Evaluates an expression with the given context.
+   *
+   * This is useful for evaluating expressions outside of templates.  The expression is
+   * parsed and evaluated immediately.
+   */
+  evalExpr(expr: string, ctx: any): any;
+  /**
+   * 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.
+   */
+  removeGlobal(name: string): void;
+  /**
+   * Enables or disables debug mode.
+   */
+  debug: boolean;
+  /**
+   * Enables or disables block trimming.
+   */
+  trimBlocks: boolean;
+  /**
+   * 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;
+  /**
+   * Configures the max-fuel for template evaluation.
+   */
+  get fuel(): number | undefined;
+  set fuel(value: number | null | undefined);
+}