NotificationTemplates

Templates

Render notification bodies with pluggable template engines

Templates

Render chat/push/SMS bodies from templates. Each engine lives on its own subpath so you only pull in the one you use. All are edge-safe (pure JS — they run on Cloudflare Workers).

You don't need a template framework. Templating is engine-agnostic: the extension point is a single function type, TemplateRenderer, not a framework. Use the zero-dep renderString, plug in Handlebars/Liquid, or wrap any engine in a ~5-line adapter (see Custom renderer). The package never bundles a framework — keep the default for the edge, opt into a heavier engine only where you need its logic.

Zero-dependency string renderer

import { renderString } from "@visulima/notification/template/string";

renderString("Hi {{ user.name }}, your code is {{ code }}", { code: "123", user: { name: "Ada" } });
// "Hi Ada, your code is 123"

Supports flat and nested {{ a.b.c }} placeholders; missing values render as empty strings.

Handlebars / Liquid

handlebars and liquidjs are optional peers — install the one you need.

import { renderHandlebars } from "@visulima/notification/template/handlebars";
import { renderLiquid } from "@visulima/notification/template/liquid";

await renderHandlebars("<h1>Hello {{name}}!</h1>", { name: "John" });
await renderLiquid("Hello {{ name }}!", { name: "John" });

The TemplateRenderer contract

Every renderer matches one type — this is the whole extension surface:

import type { TemplateRenderer } from "@visulima/notification/template/string";

type TemplateRenderer = (template: unknown, data?: Record<string, unknown>, options?: Record<string, unknown>) => string | Promise<string>;

renderString, renderHandlebars and renderLiquid are simply implementations of it. Richer features — conditionals, loops, partials/includes, helpers — come from the engine you choose; the package delegates rather than reimplementing them.

Custom renderer (any engine)

To use Eta, Mustache, Nunjucks, EJS, MJML — anything — wrap it in the contract. No package change, no framework lock-in:

import type { TemplateRenderer } from "@visulima/notification/template/string";
import { Eta } from "eta";

const eta = new Eta();
const renderEta: TemplateRenderer = (template, data) => eta.renderString(template as string, data ?? {});

await notify.sendToChannel("chat", { text: await renderEta("Hi <%= it.name %>", { name: "Ada" }), to: "C123" });

For rich HTML email, prefer the email side (@visulima/email ships Liquid + jsx-email) and feed the rendered HTML into the notification email channel.

Composing with layouts & i18n

A TemplateRenderer is what layouts and the rendered output of i18n plug into — so "extending template usage" is composition over the same seam, not a new framework. Pass your renderer to defineLayout, and feed translate(...) output as data:

import { defineLayout } from "@visulima/notification/layouts";

const layout = defineLayout({ render: renderEta, template: "<main><%~ it.content %></main>" });
const html = await layout.render("<p>Welcome!</p>", { unsubscribeUrl });

Using a renderer in a send

A renderer is just (template, data?) => string | Promise<string>. Render, then send:

await notify.sendToChannel("chat", { text: await renderHandlebars(template, data), to: "C123" });
Support

Contribute to our work and keep us going

Community is the heart of open source. The success of our packages wouldn't be possible without the incredible contributions of users, testers, and developers who collaborate with us every day.Want to get involved? Here are some tips on how you can make a meaningful impact on our open source projects.

Ready to help us out?

Be sure to check out the package's contribution guidelines first. They'll walk you through the process on how to properly submit an issue or pull request to our repositories.

Submit a pull request

Found something to improve? Fork the repo, make your changes, and open a PR. We review every contribution and provide feedback to help you get merged.

Good first issues

Simple issues suited for people new to open source development, and often a good place to start working on a package.
View good first issues