Compare commits

..

4 Commits

Author SHA1 Message Date
ead8fcffc0 Added matchesCidr utility
All checks were successful
Build / Publish Docs (push) Successful in 49s
Build / Build NPM Project (push) Successful in 1m8s
Build / Tag Version (push) Successful in 9s
2026-01-17 21:11:26 -05:00
367b026cea Added new error code (429 - too many requests)
All checks were successful
Build / Publish Docs (push) Successful in 49s
Build / Build NPM Project (push) Successful in 1m3s
Build / Tag Version (push) Successful in 9s
2026-01-17 13:20:55 -05:00
1b5e16ae5f Added parent dir helper to path events
All checks were successful
Build / Publish Docs (push) Successful in 40s
Build / Build NPM Project (push) Successful in 50s
Build / Tag Version (push) Successful in 6s
2026-01-16 18:07:32 -05:00
1b0061b714 Improved template engine
All checks were successful
Build / Publish Docs (push) Successful in 1m9s
Build / Build NPM Project (push) Successful in 1m23s
Build / Tag Version (push) Successful in 10s
2026-01-15 19:18:48 -05:00
6 changed files with 216 additions and 63 deletions

View File

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

View File

@@ -113,6 +113,18 @@ export class NotAcceptableError extends CustomError {
} }
} }
export class TooManyRequestsError extends CustomError {
static code = 429;
constructor(message: string = 'Rate Limit Reached') {
super(message);
}
static instanceof(err: Error) {
return (<any>err).constructor.code == this.code;
}
}
export class InternalServerError extends CustomError { export class InternalServerError extends CustomError {
static code = 500; static code = 500;

View File

@@ -76,6 +76,23 @@ export function gravatar(email: string, def='mp') {
return `https://www.gravatar.com/avatar/${md5(email)}?d=${def}`; return `https://www.gravatar.com/avatar/${md5(email)}?d=${def}`;
} }
/**
* Check if IP address falls within CIDR range
* @param {string} ip IPV4 to check (192.168.0.12)
* @param {string} cidr IP range to check against (example: 192.168.0.0/24)
* @returns {boolean} Whether IP address is within range
*/
export function matchesCidr(ip: string, cidr: string): boolean {
if(!cidr) return true;
if(!ip) return false;
if(!cidr?.includes('/')) return ip === cidr; // Single IP
const [range, bits] = cidr.split('/');
const mask = ~(2 ** (32 - parseInt(bits)) - 1);
const ipToInt = (str: string) => str.split('.')
.reduce((int, octet) => (int << 8) + parseInt(octet), 0) >>> 0;
return (ipToInt(ip) & mask) === (ipToInt(range) & mask);
}
/** /**
* Convert IPv6 to v4 because who uses that, NAT4Life * Convert IPv6 to v4 because who uses that, NAT4Life
* @param {string} ip IPv6 address, e.g. 2001:0db8:85a3:0000:0000:8a2e:0370:7334 * @param {string} ip IPv6 address, e.g. 2001:0db8:85a3:0000:0000:8a2e:0370:7334

View File

@@ -65,6 +65,8 @@ export class PathEvent {
module!: string; module!: string;
/** Entire path, including the module & name */ /** Entire path, including the module & name */
fullPath!: string; fullPath!: string;
/** Parent directory, excludes module & name */
dir!: string;
/** Path including the name, excluding the module */ /** Path including the name, excluding the module */
path!: string; path!: string;
/** Last segment of path */ /** Last segment of path */
@@ -121,6 +123,7 @@ export class PathEvent {
if(p === '' || p === undefined || p === '*') { if(p === '' || p === undefined || p === '*') {
this.module = ''; this.module = '';
this.path = ''; this.path = '';
this.dir = '';
this.fullPath = '**'; this.fullPath = '**';
this.name = ''; this.name = '';
this.methods = new ASet<Method>(p === '*' ? ['*'] : <any>method.split('')); this.methods = new ASet<Method>(p === '*' ? ['*'] : <any>method.split(''));
@@ -132,6 +135,7 @@ export class PathEvent {
let temp = p.split('/').filter(p => !!p); let temp = p.split('/').filter(p => !!p);
this.module = temp.splice(0, 1)[0] || ''; this.module = temp.splice(0, 1)[0] || '';
this.path = temp.join('/'); this.path = temp.join('/');
this.dir = temp.length > 2 ? temp.slice(0, -1).join('/') : '';
this.fullPath = `${this.module}${this.module && this.path ? '/' : ''}${this.path}`; this.fullPath = `${this.module}${this.module && this.path ? '/' : ''}${this.path}`;
this.name = temp.pop() || ''; this.name = temp.pop() || '';
this.hasGlob = this.fullPath.includes('*'); this.hasGlob = this.fullPath.includes('*');

View File

@@ -70,10 +70,11 @@ export function findTemplateVars(html: string): Record<string, any> {
} }
return result; return result;
} }
export async function renderTemplate(template: string, data: any, fetch?: (file: string) => Promise<string>) { export async function renderTemplate(template: string, data: any, fetch?: (file: string) => Promise<string>) {
let content = template, found: any; if(!fetch) fetch = (file) => { throw new TemplateError(`Unable to fetch template: ${file}`); }
const now = new Date(), d = {
const now = new Date();
const d = {
date: { date: {
day: now.getDate(), day: now.getDate(),
month: now.toLocaleString('default', { month: 'long' }), month: now.toLocaleString('default', { month: 'long' }),
@@ -83,72 +84,158 @@ export async function renderTemplate(template: string, data: any, fetch?: (file:
}, },
...(data || {}), ...(data || {}),
}; };
if(!fetch) fetch = (file) => { throw new TemplateError(`Unable to fetch template: ${file}`); }
const evaluate = (code: string, data: object, fatal = true) => { const evaluate = (code: string, data: object, fatal = true) => {
try { try {
return Function('data', `with(data) { return ${code}; }`)(data); return Function('data', `with(data) { return ${code}; }`)(data);
} catch { } catch(err: any) {
if(fatal) throw new TemplateError(`Failed to evaluate: ${code}`); if(fatal) throw new TemplateError(`Failed to evaluate: ${code}\n${err.message || err.toString()}`);
else return false; return false;
} }
} }
// If Statements - Optimize what we render: `{{ ? javascript }} IF TRUE CONTENT {{ !? javascript }} ELSE-IF CONTENT {{ !? }} ELSE FALSE CONTENT {{ /? }}` async function process(content: string, ctx: object = d): Promise<string> {
while(!!(found = /\{\{\s*?\?\s*?(.+?)\s*?}}([\s\S]*?)\{\{\s*?\/\?\s*?}}/g.exec(content))) { let result = 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)) // Process extends first (they wrap everything)
const parts = found[2].split(/\{\{\s*?!\?\s*?/); const extendsMatch = result.match(/\{\{\s*>\s*(.+?):(.+?)\s*}}([\s\S]*?)\{\{\s*\/>\s*}}/);
let result = evaluate(found[1], d, false) ? parts[0] : ''; if(extendsMatch) {
if (!result) { const parentTemplate = await (<Function>fetch)(extendsMatch[1].trim());
if(!parentTemplate) throw new TemplateError(`Unknown extended template: ${extendsMatch[1].trim()}`);
const slotName = extendsMatch[2].trim();
const slotContent = await process(extendsMatch[3], ctx);
return process(parentTemplate, {...ctx, [slotName]: slotContent});
}
let changed = true;
while(changed) {
changed = false;
const before = result;
// Process imports
const importMatch = result.match(/\{\{\s*<\s*(.+?)\s*}}/);
if(importMatch) {
const t = await (<Function>fetch)(importMatch[1].trim());
if(!t) throw new TemplateError(`Unknown imported template: ${importMatch[1].trim()}`);
const rendered = await process(t, ctx);
result = result.replace(importMatch[0], rendered);
changed = true;
continue;
}
// Process for-loops (innermost first)
const forMatch = findInnermostFor(result);
if(forMatch) {
const { full, vars, array, body, start } = forMatch;
const [element, index = 'index'] = vars.split(',').map(v => v.trim());
const arr: any[] = <any>dotNotation(ctx, array);
if(!arr || typeof arr != 'object') throw new TemplateError(`Cannot iterate: ${array}`);
let output = [];
for(let i = 0; i < arr.length; i++)
output.push(await process(body, {...ctx, [element]: arr[i], [index]: i}));
result = result.slice(0, start) + output.join('\n') + result.slice(start + full.length);
changed = true;
continue;
}
// Process if-statements (innermost first)
const ifMatch = findInnermostIf(result);
if(ifMatch) {
const { full, condition, body, start } = ifMatch;
const branches = parseIfBranches(body);
let output = '';
if(evaluate(condition, ctx, false)) {
output = branches.if;
} else {
for(const branch of branches.elseIf) {
if(evaluate(branch.condition, ctx, false)) {
output = branch.body;
break;
}
}
if(!output && branches.else) output = branches.else;
}
result = result.slice(0, start) + output + result.slice(start + full.length);
changed = true;
continue;
}
if(before === result) changed = false;
}
return processVariables(result, ctx);
}
function processVariables(content: string, data: object): string {
return content.replace(/\{\{\s*([^<>\*\?!/}\s][^{}]*?)\s*}}/g, (match, code) => {
return evaluate(code.trim(), data) ?? '';
});
}
function findInnermostIf(content: string) {
const regex = /\{\{\s*\?\s*(.+?)\s*}}/g;
let match, lastMatch = null;
while((match = regex.exec(content)) !== null) {
const start = match.index;
const condition = match[1];
const bodyStart = match.index + match[0].length;
const end = findMatchingClose(content, bodyStart, /\{\{\s*\?\s*/, /\{\{\s*\/\?\s*}}/);
if(end === -1) throw new TemplateError(`Unmatched if-statement at position ${start}`);
const closeTag = content.slice(end).match(/\{\{\s*\/\?\s*}}/);
const full = content.slice(start, end + (<any>closeTag)[0].length);
const body = content.slice(bodyStart, end);
lastMatch = { full, condition, body, start };
}
return lastMatch;
}
function findInnermostFor(content: string) {
const regex = /\{\{\s*\*\s*(.+?)\s+in\s+(.+?)\s*}}/g;
let match, lastMatch = null;
while((match = regex.exec(content)) !== null) {
const start = match.index;
const vars = match[1].replaceAll(/[()\s]/g, '');
const array = match[2];
const bodyStart = match.index + match[0].length;
const end = findMatchingClose(content, bodyStart, /\{\{\s*\*\s*/, /\{\{\s*\/\*\s*}}/);
if(end === -1) throw new TemplateError(`Unmatched for-loop at position ${start}`);
const closeTag = content.slice(end).match(/\{\{\s*\/\*\s*}}/);
const full = content.slice(start, end + (<any>closeTag)[0].length);
const body = content.slice(bodyStart, end);
lastMatch = { full, vars, array, body, start };
}
return lastMatch;
}
function findMatchingClose(content: string, startIndex: number, openTag: RegExp, closeTag: RegExp): number {
let depth = 1, pos = startIndex;
while (depth > 0 && pos < content.length) {
const remaining = content.slice(pos);
const nextOpen = remaining.search(openTag);
const nextClose = remaining.search(closeTag);
if(nextClose === -1) return -1;
if(nextOpen !== -1 && nextOpen < nextClose) {
depth++;
pos += nextOpen + 1;
} else {
depth--;
if(depth === 0) return pos + nextClose;
pos += nextClose + 1;
}
}
return -1;
}
function parseIfBranches(body: string) {
const parts = body.split(/\{\{\s*!\?\s*/);
const result = { if: parts[0], elseIf: [] as any[], else: '' };
for(let i = 1; i < parts.length; i++) { for(let i = 1; i < parts.length; i++) {
const [cond, body] = parts[i].split(/}}/); const closeBrace = parts[i].indexOf('}}');
if (!cond.trim()) { const condition = parts[i].slice(0, closeBrace).trim();
result = body || ''; const branchBody = parts[i].slice(closeBrace + 2);
break; if(!condition) result.else = branchBody;
else result.elseIf.push({ condition, body: branchBody });
} }
if (evaluate(cond, d, false)) { return result;
result = body || '';
break;
}
}
}
content = content.replace(found[0], result);
} }
// Imports - We render bottom up: `{{ < file.html }}` return process(template);
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;
} }

View File

@@ -113,6 +113,39 @@ Total: {{ total }}
expect(result).toEqual({ cart: [], total: '' }); expect(result).toEqual({ cart: [], total: '' });
}); });
test('real world template', async () => {
const wrapper = `<div> {{body}} </div>`;
const tpl = `
{{ > email:body }}
<div style="text-align: center">
{{ ? title }}<h1 style="margin: 0">{{ title }}</h1>{{ /? }}
{{ ? subject }}<h2 style="margin: 0">{{ subject }}</h2>{{ /? }}
{{ ? message }}<p style="margin-top: 1rem">{{ message }}</p>{{ /? }}
{{ ? link }}
<br>
<div style="background: #dedede; padding: 8px 20px; border-radius: 10px; overflow-x: auto;">
{{ ? link.startsWith('http') }}
<a style="word-break: break-all;" target="_blank" href="{{ link }}">{{ link }}</a>
{{ !? }}
<p style="margin: 0; word-break: break-all;">{{ link }}</p>
{{ /? }}
</div>
{{ /? }}
{{ ? footer }}
<br>
<p>{{ footer }}</p>
{{ /? }}
</div>
{{ /> }}`;
console.log(await renderTemplate(tpl, {
title: 'test',
subject: 'test',
message: 'test',
link: 'test',
footer: 'test',
}, async () => wrapper))
});
test('real world invoice template', () => { test('real world invoice template', () => {
const tpl = ` const tpl = `
{{ settings.title }} {{ settings.title }}