Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
@shferreira/brazejs
Advanced tools
Readme
A braze compatible Liquid template engine in pure JavaScript. Built on top of liquidjs, with Braze tags/filters/syntax added and incompatible features removed.
Install via npm:
npm install --save brazejs
For detailed usage please refer to liquidjs' original doc.
Braze's liquid is a subset of Shopify's liquid, hence some incompatible features have to be removed. Braze also has it's own support for some Braze specific tags/filters/output, we add them in as plugin to liquidjs.
abs
: Braze doesn't support absEncoding
Filter Name | Example | Notes |
---|---|---|
md5 | {{"sample" | md5}} | |
sha1 | {{"strings" | sha1}} | |
sha2 | {{"to" | sha2}} | This is using SHA-256 |
hmac_sha1 | {{"be" | hmac_sha1}} | |
base64 | {{"encoded" | base64}} |
URL
Filter Name | Example | Notes |
---|---|---|
url_escape | {{"hey<>hi" | url_escape}} | ⚠️ this uses encodeURI which is slightly different from Braze's implementation |
url_param_escape | {{"hey<>hi" | url_param_escape}} | ⚠️ this uses encodeURIComponent which is slightly different from Braze's implementation |
Filter Name | Example | Notes |
---|---|---|
property_accessor | {{hash | property_accessor: 'key'}} | Example hash: { 'key' => 'hello' } |
Number Formatting
Filter Name | Example | Notes |
---|---|---|
number_with_delimiter | {{123456 | number_with_delimiter}} | ⚠️ this uses toLocaleString which is slightly different from Braze's implementation |
JSON Escape
Filter Name | Example | Notes |
---|---|---|
json_escape | {{'123"456' | json_escape}} | ⚠️ this uses JSON.stringify which is slightly different from Braze's implementation |
abort_message: abort rendering and output an optional message
Example:
{% abort_message() %}
{% abort_message('aborted due to error') %}
connected_content: call an external API
Example:
{% connected_content http://numbersapi.com/random/trivia :save trivia :cache 900 :basic_auth <secret_name> %}
Supported options: :basic_auth
, :content_type
, :save
, :cache
, :method
, :body
For basic auth to work, you'll need to add the username and password into the context object.
// replace <secret_name> so that it matches your basic auth name in Braze
{
"__secrets": {
"<secret_name>": {
"username": "<your username>",
"password": "<your password>"
}
}
}
${}
support for Personalization tags
For it to work the attributes need to be added into context
{
"first_name": "<my_name>",
"user_id": "<my_uid>",
"custom_attribute": {
"<attr1>": "<val1>",
"<attr2>": "<val2>"
}
}
Then you can access them in the template:
{{ ${first_name} }}
{{ custom_attribute.${attr1} }}
Object will be converted to Ruby presentation
If context is { "obj": {"foo": "bar"} }
, liquidjs renders to [object Object]
, while brazejs renders it to {"foo"=>"bar"}
Content Blocks is supported
{{content_blocks.${contentBlockName}}}
By default the content blocks template is being searched in directories in following order:
1. current dir
2. content_blocks under current dir
3. content_blocks in parent dir
It will also search for file names in this order:
1. exact match
2. convert file name to kebab-case
3. append .liquid
4. convert file name to kebab-case and append .liquid
It's also possible to configure the root dir and file extension in context:
{
"__contentBlocks": {
"root": "path_to_dir",
"ext": ".html"
}
}
⚠️ At time of writing, Braze only support nesting 2 levels of content blocks
FAQs
Liquid template engine for the Braze variant by pure JavaScript: compatible to Braze, easy to extend.
The npm package @shferreira/brazejs receives a total of 3 weekly downloads. As such, @shferreira/brazejs popularity was classified as not popular.
We found that @shferreira/brazejs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.