Compare commits

..

7 Commits

Author SHA1 Message Date
38207eb618 Fixed missing export
All checks were successful
Build / Publish Docs (push) Successful in 42s
Build / Build NPM Project (push) Successful in 1m1s
Build / Tag Version (push) Successful in 9s
2025-12-08 10:07:20 -05:00
1352e69895 Added templating tests
All checks were successful
Build / Publish Docs (push) Successful in 53s
Build / Build NPM Project (push) Successful in 1m6s
Build / Tag Version (push) Successful in 9s
2025-12-08 10:03:38 -05:00
1b05af09fb Fixed templates
All checks were successful
Build / Publish Docs (push) Successful in 58s
Build / Build NPM Project (push) Successful in 1m15s
Build / Tag Version (push) Successful in 11s
2025-12-06 21:51:47 -05:00
32c61fff42 Fixed templates
All checks were successful
Build / Publish Docs (push) Successful in 1m14s
Build / Build NPM Project (push) Successful in 1m38s
Build / Tag Version (push) Successful in 11s
2025-12-06 21:34:21 -05:00
df517b6078 Fixed templates bleeding into each other between runs
All checks were successful
Build / Publish Docs (push) Successful in 43s
Build / Build NPM Project (push) Successful in 1m49s
Build / Tag Version (push) Successful in 8s
2025-12-06 19:45:38 -05:00
1e54ee57a1 Fixed imports
All checks were successful
Build / Publish Docs (push) Successful in 43s
Build / Build NPM Project (push) Successful in 1m2s
Build / Tag Version (push) Successful in 8s
2025-12-06 15:23:22 -05:00
b6f8da512c Added template helper
Some checks failed
Build / Build NPM Project (push) Failing after 35s
Build / Publish Docs (push) Failing after 33s
Build / Tag Version (push) Has been skipped
2025-12-06 15:20:51 -05:00
4 changed files with 250 additions and 1 deletions

View File

@@ -1,6 +1,6 @@
{
"name": "@ztimson/utils",
"version": "0.27.15",
"version": "0.28.0",
"description": "Utility library",
"author": "Zak Timson",
"license": "MIT",

View File

@@ -19,6 +19,7 @@ export * from './path-events';
export * from './promise-progress';
export * from './search';
export * from './string';
export * from './template';
export * from './time';
export * from './types';
export * from 'var-persist';

116
src/template.ts Normal file
View File

@@ -0,0 +1,116 @@
import {BadRequestError} from './errors.ts';
import {dotNotation} from './objects.ts';
import {matchAll} from './string.ts';
import {formatDate} from './time.ts';
export class TemplateError extends BadRequestError { }
export function findTemplateVars(html: string): Record<string, any> {
const variables = new Set<string>();
const regex = /\{\{\s*([^<>\*\?!/}\s][^}]*?)\s*}}/g;
let match;
while ((match = regex.exec(html)) !== null) {
const code = match[1].trim();
const varMatch = code.match(/^([a-zA-Z_$][a-zA-Z0-9_$.]*)/);
if (varMatch) variables.add(varMatch[1]);
}
const result: Record<string, any> = {};
for (const path of variables) {
const parts = path.split('.');
let current = result;
for (let i = 0; i < parts.length; i++) {
const part = parts[i];
if (i === parts.length - 1) {
current[part] = '';
} else {
current[part] = current[part] || {};
current = current[part];
}
}
}
return result;
}
export async function renderTemplate(template: string, data: any, fetch?: (file: string) => Promise<string>) {
let content = template, found: any;
const now = new Date(), d = {
date: {
day: now.getDate(),
month: now.toLocaleString('default', { month: 'long' }),
year: now.getFullYear(),
time: now.toLocaleTimeString(),
format: formatDate
},
...(data || {}),
};
if(!fetch) fetch = (file) => { throw new TemplateError(`Unable to fetch template: ${file}`); }
const evaluate = (code: string, data: object, fatal = true) => {
try {
return Function('data', `with(data) { return ${code}; }`)(data);
} catch {
if(fatal) throw new TemplateError(`Failed to evaluate: ${code}`);
else return false;
}
}
// If Statements - Optimize what we render: `{{ ? javascript }} IF TRUE CONTENT {{ !? javascript }} ELSE-IF CONTENT {{ !? }} ELSE FALSE CONTENT {{ /? }}`
while(!!(found = /\{\{\s*?\?\s*?(.+?)\s*?}}([\s\S]*?)\{\{\s*?\/\?\s*?}}/g.exec(content))) {
const nested = matchAll(found[0], /\{\{\s*?\?.+?}}/g).slice(-1)?.[0]?.index;
if(nested != 0) found = /\{\{\s*?\?\s*?(.+?)\s*?}}([\s\S]*?)\{\{\s*?\/\?\s*?}}/g.exec(content.slice(found.index + nested))
const parts = found[2].split(/\{\{\s*?!\?\s*?/);
let result = evaluate(found[1], d, false) ? parts[0] : '';
if (!result) {
for (let i = 1; i < parts.length; i++) {
const [cond, body] = parts[i].split(/}}/);
if (!cond.trim()) {
result = body || '';
break;
}
if (evaluate(cond, d, false)) {
result = body || '';
break;
}
}
}
content = content.replace(found[0], result);
}
// Imports - We render bottom up: `{{ < file.html }}`
while(!!(found = /\{\{\s*?<\s*?(.+?)\s*?}}/g.exec(content))) {
const t = await fetch(found[1].trim());
if(!t) throw new TemplateError(`Unknown imported template: ${found[1].trim()}`);
content = content.replace(found[0], await renderTemplate(t, d, fetch));
}
// For Loops: `{{ * (row, index) in invoice }} CONTENT {{ /* }}`
while(!!(found = /\{\{\s*?\*\s*?(.+?)\s+in\s+(.+?)\s*?}}([\s\S]*?)\{\{\s*?\/\*\s*?}}/g.exec(content))) {
const split = found[1].replaceAll(/[()\s]/g, '').split(',');
const element = split[0];
const index = split[1] || 'index';
const array: any[] = <any>dotNotation(d, found[2]);
if(!array || typeof array != 'object') throw new TemplateError(`Cannot iterate: ${found[2]}`);
let compiled = [];
for(let i = 0; i < array.length; i++)
compiled.push(await renderTemplate(found[3], {...d, [element]: array[i], [index]: i}, fetch));
content = content.replace(found[0], compiled.join('\n'));
}
// Evaluate whatever is left - Should come last: `{{ javascript }}`
while(!!(found = /\{\{\s*([^<>\*\?!/}\s][^}]*?)\s*}}/g.exec(content))) {
content = content.replace(found[0], evaluate(found[1].trim(), d) ?? '');
}
// Extends: `{{ > file.html:property }} CONTENT {{ /> }}`
while(!!(found = /\{\{\s*?>\s*?(.+?):(.+?)\s*?}}([\s\S]*?)\{\{\s*?\/>\s*?}}/g.exec(content))) {
const t = await fetch(found[1].trim());
if(!t) throw new TemplateError(`Unknown extended templated: ${found[1].trim()}`);
content = content.replace(found[0], await renderTemplate(t, {
...d,
[found[2].trim()]: found[3],
}, fetch));
}
return content;
}

132
tests/templates.spec.ts Normal file
View File

@@ -0,0 +1,132 @@
import { renderTemplate, TemplateError } from '../src';
describe('renderTemplate', () => {
test('basic variable interpolation', async () => {
const result = await renderTemplate('Hello {{ name }}!', { name: 'World' });
expect(result).toBe('Hello World!');
});
test('nested object access', async () => {
const result = await renderTemplate('{{ user.name }} is {{ user.age }}', {
user: { name: 'Alice', age: 25 }
});
expect(result).toBe('Alice is 25');
});
test('method calls', async () => {
const result = await renderTemplate('{{ price.toFixed(2) }}', { price: 9.5 });
expect(result).toBe('9.50');
});
test('if statement true', async () => {
const result = await renderTemplate('{{ ? active }}YES{{ /? }}', { active: true });
expect(result).toBe('YES');
});
test('if statement false', async () => {
const result = await renderTemplate('{{ ? active }}YES{{ /? }}', { active: false });
expect(result).toBe('');
});
test('if-else', async () => {
const result = await renderTemplate('{{ ? active }}YES{{ !? }}NO{{ /? }}', { active: false });
expect(result).toBe('NO');
});
test('if-elseif-else', async () => {
const tpl = '{{ ? status == "paid" }}PAID{{ !? status == "pending" }}PENDING{{ !? }}OTHER{{ /? }}';
expect(await renderTemplate(tpl, { status: 'paid' })).toBe('PAID');
expect(await renderTemplate(tpl, { status: 'pending' })).toBe('PENDING');
expect(await renderTemplate(tpl, { status: 'failed' })).toBe('OTHER');
});
test('nested if statements', async () => {
const tpl = '{{ ? a }}A{{ ? b }}B{{ /? }}{{ /? }}';
expect(await renderTemplate(tpl, { a: true, b: true })).toBe('AB');
expect(await renderTemplate(tpl, { a: true, b: false })).toBe('A');
expect(await renderTemplate(tpl, { a: false, b: true })).toBe('');
});
test('for loop', async () => {
const tpl = '{{ * item in items }}{{ item }}{{ /* }}';
const result = await renderTemplate(tpl, { items: ['a', 'b', 'c'] });
expect(result).toBe('a\nb\nc');
});
test('for loop with index', async () => {
const tpl = '{{ * (item, i) in items }}{{ i }}:{{ item }}{{ /* }}';
const result = await renderTemplate(tpl, { items: ['a', 'b'] });
expect(result).toBe('0:a\n1:b');
});
test('for loop with objects', async () => {
const tpl = '{{ * user in users }}{{ user.name }}{{ /* }}';
const result = await renderTemplate(tpl, {
users: [{ name: 'Alice' }, { name: 'Bob' }]
});
expect(result).toBe('Alice\nBob');
});
test('for loop error on non-array', async () => {
await expect(
renderTemplate('{{ * x in notArray }}{{ x }}{{ /* }}', { notArray: 'string' })
).rejects.toThrow(TemplateError);
});
test('import template', async () => {
const fetch = async (file: string) => {
if (file === 'header.html') return 'HEADER: {{ title }}';
throw new Error('Not found');
};
const result = await renderTemplate('{{ < header.html }}', { title: 'Test' }, fetch);
expect(result).toBe('HEADER: Test');
});
test('import template error', async () => {
await expect(
renderTemplate('{{ < missing.html }}', {})
).rejects.toThrow(TemplateError);
});
test('extend template', async () => {
const fetch = async (file: string) => {
if (file === 'layout.html') return '<div>{{ content }}</div>';
throw new Error('Not found');
};
const result = await renderTemplate('{{ > layout.html:content }}Hello{{ /> }}', {}, fetch);
expect(result).toBe('<div>Hello</div>');
});
test('date object', async () => {
const result = await renderTemplate('{{ date.year }}', {});
expect(result).toBe(new Date().getFullYear().toString());
});
test('evaluation error', async () => {
await expect(
renderTemplate('{{ undefined.property }}', {})
).rejects.toThrow(TemplateError);
});
test('complex nested example', async () => {
const tpl = `
{{ ? items.length > 0 }}
{{ * (item, i) in items }}
{{ i + 1 }}. {{ item.name }}: \${{ item.price.toFixed(2) }}
{{ /* }}
Total: \${{ total.toFixed(2) }}
{{ !? }}
No items
{{ /? }}`;
const result = await renderTemplate(tpl, {
items: [
{ name: 'A', price: 10 },
{ name: 'B', price: 20 }
],
total: 30
});
expect(result.trim()).toContain('1. A: $10.00');
expect(result.trim()).toContain('2. B: $20.00');
expect(result.trim()).toContain('Total: $30.00');
});
});