Compare commits

..

11 Commits

Author SHA1 Message Date
e32e5d6f71 Better TTS stoping error suppression
All checks were successful
Build / Publish Docs (push) Successful in 56s
Build / Build NPM Project (push) Successful in 1m15s
Build / Tag Version (push) Successful in 10s
2026-01-19 10:28:35 -05:00
41bc5e7eb5 Fixed TTS incorrect voice race condition, errors on stop and speakStream done response
All checks were successful
Build / Publish Docs (push) Successful in 36s
Build / Build NPM Project (push) Successful in 47s
Build / Tag Version (push) Successful in 6s
2026-01-18 13:37:55 -05:00
fda92e46d5 Added TTS helper
All checks were successful
Build / Publish Docs (push) Successful in 33s
Build / Build NPM Project (push) Successful in 44s
Build / Tag Version (push) Successful in 6s
2026-01-18 12:56:20 -05:00
1be2c1118f Added emoji filter
All checks were successful
Build / Publish Docs (push) Successful in 42s
Build / Build NPM Project (push) Successful in 1m7s
Build / Tag Version (push) Successful in 9s
2026-01-18 12:16:12 -05:00
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
3048b74b2f Handle sorting with undefined values
All checks were successful
Build / Publish Docs (push) Successful in 47s
Build / Build NPM Project (push) Successful in 1m4s
Build / Tag Version (push) Successful in 10s
2025-12-13 00:27:47 -05:00
49959f3060 Template variable extraction ignores functions
All checks were successful
Build / Publish Docs (push) Successful in 38s
Build / Build NPM Project (push) Successful in 52s
Build / Tag Version (push) Successful in 10s
2025-12-08 19:26:55 -05:00
cabfc93773 Better template variable extraction
All checks were successful
Build / Publish Docs (push) Successful in 47s
Build / Build NPM Project (push) Successful in 1m9s
Build / Tag Version (push) Successful in 9s
2025-12-08 10:42:02 -05:00
11 changed files with 574 additions and 67 deletions

View File

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

View File

@@ -122,6 +122,8 @@ export function sortByProp(prop: string, reverse = false) {
return function (a: any, b: any) { return function (a: any, b: any) {
const aVal = dotNotation<any>(a, prop); const aVal = dotNotation<any>(a, prop);
const bVal = dotNotation<any>(b, prop); const bVal = dotNotation<any>(b, prop);
if(aVal === undefined) return 1;
if(bVal === undefined) return -1;
if(typeof aVal == 'number' && typeof bVal == 'number') if(typeof aVal == 'number' && typeof bVal == 'number')
return (reverse ? -1 : 1) * (aVal - bVal); return (reverse ? -1 : 1) * (aVal - bVal);
if(aVal > bVal) return reverse ? -1 : 1; if(aVal > bVal) return reverse ? -1 : 1;

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

@@ -21,5 +21,6 @@ export * from './search';
export * from './string'; export * from './string';
export * from './template'; export * from './template';
export * from './time'; export * from './time';
export * from './tts';
export * from './types'; export * from './types';
export * from 'var-persist'; export * from 'var-persist';

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

@@ -135,7 +135,15 @@ export function pascalCase(str?: string): string {
.join(''); .join('');
} }
/**
* Remove all emojis from a string
* @param {string} str Input string with emojis
* @returns {string} Sanitized string without emojis
*/
export function removeEmojis(str: string): string {
const emojiRegex = /(?:[\u2700-\u27bf]|(?:\ud83c[\udde6-\uddff]){2}|[\ud83c[\udde6-\uddff]|[\ud83d[\ude00-\ude4f]|[\ud83d[\ude80-\udeff]|[\ud83c[\udd00-\uddff]|[\ud83d[\ude50-\ude7f]|[\u2600-\u26ff]|[\u2700-\u27bf]|[\ud83e[\udd00-\uddff]|[\ud83c[\udf00-\uffff]|[\ud83d[\ude00-\udeff]|[\ud83c[\udde6-\uddff])/g;
return str.replace(emojiRegex, '');
}
/** /**
* Generate a random hexadecimal value * Generate a random hexadecimal value

View File

@@ -7,13 +7,50 @@ export class TemplateError extends BadRequestError { }
export function findTemplateVars(html: string): Record<string, any> { export function findTemplateVars(html: string): Record<string, any> {
const variables = new Set<string>(); const variables = new Set<string>();
const arrays = new Set<string>();
const excluded = new Set<string>(['true', 'false', 'null', 'undefined']);
// Extract & exclude loop variables, mark arrays
for (const loop of matchAll(html, /\{\{\s*?\*\s*?(.+?)\s+in\s+(.+?)\s*?}}/g)) {
const [element, index = 'index'] = loop[1].replaceAll(/[()\s]/g, '').split(',');
excluded.add(element);
excluded.add(index);
const arrayVar = loop[2].trim();
const root = arrayVar.split('.')[0];
if(!excluded.has(root)) {
variables.add(arrayVar);
arrays.add(arrayVar);
}
}
// Extract variables from if/else-if conditions
for (const ifStmt of matchAll(html, /\{\{\s*?[!]?\?\s*?([^}]+?)\s*?}}/g)) {
const code = ifStmt[1].replace(/["'`][^"'`]*["'`]/g, '');
const cleaned = code.replace(/([a-zA-Z_$][a-zA-Z0-9_$.]*)\s*\(/g, (_, v) => {
const parts = v.split('.');
return parts.length > 1 ? parts.slice(0, -1).join('.') + ' ' : '';
});
const vars = cleaned.match(/[a-zA-Z_$][a-zA-Z0-9_$.]+/g) || [];
for (const v of vars) {
const root = v.split('.')[0];
if(!excluded.has(root)) variables.add(v);
}
}
// Extract from if block content & regular interpolations
const regex = /\{\{\s*([^<>\*\?!/}\s][^}]*?)\s*}}/g; const regex = /\{\{\s*([^<>\*\?!/}\s][^}]*?)\s*}}/g;
let match; let match;
while ((match = regex.exec(html)) !== null) { while ((match = regex.exec(html)) !== null) {
const code = match[1].trim(); const code = match[1].trim().replace(/["'`][^"'`]*["'`]/g, '');
const varMatch = code.match(/^([a-zA-Z_$][a-zA-Z0-9_$.]*)/); const cleaned = code.replace(/([a-zA-Z_$][a-zA-Z0-9_$.]*)\s*\(/g, (_, v) => {
if (varMatch) variables.add(varMatch[1]); const parts = v.split('.');
return parts.length > 1 ? parts.slice(0, -1).join('.') + ' ' : '';
});
const vars = cleaned.match(/[a-zA-Z_$][a-zA-Z0-9_$.]+/g) || [];
for (const v of vars) {
const root = v.split('.')[0];
if(!excluded.has(root)) variables.add(v);
}
} }
const result: Record<string, any> = {}; const result: Record<string, any> = {};
@@ -22,8 +59,9 @@ export function findTemplateVars(html: string): Record<string, any> {
let current = result; let current = result;
for (let i = 0; i < parts.length; i++) { for (let i = 0; i < parts.length; i++) {
const part = parts[i]; const part = parts[i];
if (i === parts.length - 1) { if(i === parts.length - 1) {
current[part] = ''; const fullPath = parts.slice(0, i + 1).join('.');
current[part] = arrays.has(fullPath) ? [] : '';
} else { } else {
current[part] = current[part] || {}; current[part] = current[part] || {};
current = current[part]; current = current[part];
@@ -32,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' }),
@@ -45,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());
for (let i = 1; i < parts.length; i++) { if(!parentTemplate) throw new TemplateError(`Unknown extended template: ${extendsMatch[1].trim()}`);
const [cond, body] = parts[i].split(/}}/); const slotName = extendsMatch[2].trim();
if (!cond.trim()) { const slotContent = await process(extendsMatch[3], ctx);
result = body || ''; return process(parentTemplate, {...ctx, [slotName]: slotContent});
break; }
}
if (evaluate(cond, d, false)) { let changed = true;
result = body || ''; while(changed) {
break; 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;
} }
} }
content = content.replace(found[0], result); return -1;
} }
// Imports - We render bottom up: `{{ < file.html }}` function parseIfBranches(body: string) {
while(!!(found = /\{\{\s*?<\s*?(.+?)\s*?}}/g.exec(content))) { const parts = body.split(/\{\{\s*!\?\s*/);
const t = await fetch(found[1].trim()); const result = { if: parts[0], elseIf: [] as any[], else: '' };
if(!t) throw new TemplateError(`Unknown imported template: ${found[1].trim()}`); for(let i = 1; i < parts.length; i++) {
content = content.replace(found[0], await renderTemplate(t, d, fetch)); const closeBrace = parts[i].indexOf('}}');
const condition = parts[i].slice(0, closeBrace).trim();
const branchBody = parts[i].slice(closeBrace + 2);
if(!condition) result.else = branchBody;
else result.elseIf.push({ condition, body: branchBody });
}
return result;
} }
// For Loops: `{{ * (row, index) in invoice }} CONTENT {{ /* }}` return process(template);
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;
} }

161
src/tts.ts Normal file
View File

@@ -0,0 +1,161 @@
import {removeEmojis} from './string.ts';
export class TTS {
private static readonly QUALITY_PATTERNS = ['Google', 'Microsoft', 'Samantha', 'Premium', 'Natural', 'Neural'];
private _currentUtterance: SpeechSynthesisUtterance | null = null;
private _voicesLoaded: Promise<void>;
private _stoppedUtterances = new WeakSet<SpeechSynthesisUtterance>();
private _rate: number = 1.0;
get rate(): number { return this._rate; }
set rate(value: number) {
this._rate = value;
if(this._currentUtterance) this._currentUtterance.rate = value;
}
private _pitch: number = 1.0;
get pitch(): number { return this._pitch; }
set pitch(value: number) {
this._pitch = value;
if(this._currentUtterance) this._currentUtterance.pitch = value;
}
private _volume: number = 1.0;
get volume(): number { return this._volume; }
set volume(value: number) {
this._volume = value;
if(this._currentUtterance) this._currentUtterance.volume = value;
}
private _voice: SpeechSynthesisVoice | undefined;
get voice(): SpeechSynthesisVoice | undefined { return this._voice; }
set voice(value: SpeechSynthesisVoice | undefined) {
this._voice = value;
if(this._currentUtterance && value) this._currentUtterance.voice = value;
}
/** Create a TTS instance with optional configuration */
constructor(config?: {rate?: number; pitch?: number; volume?: number; voice?: SpeechSynthesisVoice | null}) {
this._voicesLoaded = this.initializeVoices();
if(config) {
if(config.rate !== undefined) this._rate = config.rate;
if(config.pitch !== undefined) this._pitch = config.pitch;
if(config.volume !== undefined) this._volume = config.volume;
this._voice = config.voice === null ? undefined : (config.voice || undefined);
}
}
/** Initializes voice loading and sets default voice if needed */
private initializeVoices(): Promise<void> {
return new Promise((resolve) => {
const voices = window.speechSynthesis.getVoices();
if(voices.length > 0) {
if(!this._voice) this._voice = TTS.bestVoice();
resolve();
} else {
const handler = () => {
window.speechSynthesis.removeEventListener('voiceschanged', handler);
if(!this._voice) this._voice = TTS.bestVoice();
resolve();
};
window.speechSynthesis.addEventListener('voiceschanged', handler);
}
});
}
/**
* Selects the best available TTS voice, prioritizing high-quality options
* @param lang Speaking language
* @returns Highest quality voice
*/
private static bestVoice(lang = 'en'): SpeechSynthesisVoice | undefined {
const voices = window.speechSynthesis.getVoices();
for (const pattern of this.QUALITY_PATTERNS) {
const voice = voices.find(v => v.name.includes(pattern) && v.lang.startsWith(lang));
if(voice) return voice;
}
return voices.find(v => v.lang.startsWith(lang));
}
/** Cleans text for TTS by removing emojis, markdown and code block */
private static cleanText(text: string): string {
return removeEmojis(text)
.replace(/```[\s\S]*?```/g, ' code block ')
.replace(/[#*_~`]/g, '');
}
/** Creates a speech utterance with current options */
private createUtterance(text: string): SpeechSynthesisUtterance {
const cleanedText = TTS.cleanText(text);
const utterance = new SpeechSynthesisUtterance(cleanedText);
const voice = this._voice || TTS.bestVoice();
if(voice) utterance.voice = voice;
utterance.rate = this._rate;
utterance.pitch = this._pitch;
utterance.volume = this._volume;
return utterance;
}
/** Speaks text and returns a Promise which resolves once complete */
async speak(text: string): Promise<void> {
if(!text.trim()) return Promise.resolve();
await this._voicesLoaded;
return new Promise((resolve, reject) => {
this._currentUtterance = this.createUtterance(text);
const utterance = this._currentUtterance;
utterance.onend = () => {
this._currentUtterance = null;
resolve();
};
utterance.onerror = (error) => {
this._currentUtterance = null;
if(this._stoppedUtterances.has(utterance) && error.error === 'interrupted') resolve();
else reject(error);
};
window.speechSynthesis.speak(utterance);
});
}
/** Stops all TTS */
stop(): void {
if(this._currentUtterance) this._stoppedUtterances.add(this._currentUtterance);
window.speechSynthesis.cancel();
this._currentUtterance = null;
}
/**
* Initialize a stream that chunks text into sentences and speak them.
*
* @example
* const stream = tts.speakStream();
* stream.next("Hello ");
* stream.next("World. How");
* stream.next(" are you?");
* await stream.done();
*
* @returns Object with next function for passing chunk of streamed text and done for completing the stream
*/
speakStream(): {next: (text: string) => void, done: () => Promise<void>} {
let buffer = '';
let streamPromise: Promise<void> = Promise.resolve();
const sentenceRegex = /[^.!?\n]+[.!?\n]+/g;
return {
next: (text: string): void => {
buffer += text;
const sentences = buffer.match(sentenceRegex);
if(sentences) {
sentences.forEach(sentence => streamPromise = this.speak(sentence.trim()));
buffer = buffer.replace(sentenceRegex, '');
}
},
done: async (): Promise<void> => {
if(buffer.trim()) {
streamPromise = this.speak(buffer.trim());
buffer = '';
}
await streamPromise;
}
};
}
}

View File

@@ -62,6 +62,11 @@ describe('Object utilities', () => {
dotNotation(obj, 'd.e.f', 5); dotNotation(obj, 'd.e.f', 5);
expect(obj.d.e.f).toBe(5); expect(obj.d.e.f).toBe(5);
}); });
it('undefined', () => {
const obj: any = {a: 1};
const resp = dotNotation(obj, 'a.b');
expect(resp).toBe(undefined);
})
}); });
describe('encodeQuery', () => { describe('encodeQuery', () => {

View File

@@ -1,4 +1,176 @@
import { renderTemplate, TemplateError } from '../src'; import {findTemplateVars, renderTemplate, TemplateError} from '../src';
describe('findTemplateVars', () => {
test('extracts simple variables', () => {
const result = findTemplateVars('Hello {{ name }}!');
expect(result).toEqual({ name: '' });
});
test('extracts nested object paths', () => {
const result = findTemplateVars('{{ user.name }} is {{ user.age }}');
expect(result).toEqual({ user: { name: '', age: '' } });
});
test('extracts variables from if statements', () => {
const result = findTemplateVars('{{ ? active }}{{ message }}{{ /? }}');
expect(result).toEqual({ active: '', message: '' });
});
test('extracts variables from else-if conditions', () => {
const result = findTemplateVars('{{ ? status == "paid" }}PAID{{ !? status == "pending" }}{{ value }}{{ /? }}');
expect(result).toEqual({ status: '', value: '' });
});
test('extracts array reference from loops', () => {
const result = findTemplateVars('{{ * item in items }}{{ item }}{{ /* }}');
expect(result).toEqual({ items: [] });
});
test('excludes loop element variable', () => {
const result = findTemplateVars('{{ * item in items }}{{ item.name }}{{ /* }}');
expect(result).toEqual({ items: [] });
expect(result).not.toHaveProperty('item');
});
test('excludes loop index variable', () => {
const result = findTemplateVars('{{ * (item, i) in items }}{{ i }}:{{ item }}{{ /* }}');
expect(result).toEqual({ items: [] });
expect(result).not.toHaveProperty('item');
expect(result).not.toHaveProperty('i');
});
test('extracts external vars used inside loops', () => {
const result = findTemplateVars('{{ * item in items }}{{ item }}-{{ prefix }}{{ /* }}');
expect(result).toEqual({ items: [], prefix: '' });
});
test('handles nested loops', () => {
const result = findTemplateVars('{{ * row in rows }}{{ * col in row.cols }}{{ col }}{{ /* }}{{ /* }}');
expect(result).toEqual({ rows: [] });
expect(result).not.toHaveProperty('row');
expect(result).not.toHaveProperty('col');
});
test('extracts from complex nested template', () => {
const tpl = `
{{ ? items.length > 0 }}
{{ * (item, i) in items }}
{{ i }}. {{ item.name }}: {{ currency }}{{ item.price }}
{{ /* }}
Total: {{ total }}
{{ !? }}
{{ emptyMessage }}
{{ /? }}`;
const result = findTemplateVars(tpl);
expect(result).toEqual({
items: [],
currency: '',
total: '',
emptyMessage: ''
});
expect(result).not.toHaveProperty('item');
expect(result).not.toHaveProperty('i');
});
test('ignores template control syntax', () => {
const result = findTemplateVars('{{ < header.html }}{{ > layout.html:content }}content{{ /> }}');
expect(result).toEqual({});
});
test('handles multiple variables in expressions', () => {
const result = findTemplateVars('{{ firstName + " " + lastName }}');
expect(result).toEqual({ firstName: '', lastName: '' });
});
test('creates arrays for loop variables', () => {
const result = findTemplateVars('{{ * item in items }}{{ item }}{{ /* }}');
expect(result).toEqual({ items: [] });
});
test('creates nested arrays', () => {
const result = findTemplateVars('{{ * row in data.rows }}{{ row }}{{ /* }}');
expect(result).toEqual({ data: { rows: [] } });
});
test('creates multiple arrays', () => {
const result = findTemplateVars('{{ * user in users }}{{ user }}{{ /* }}{{ * post in posts }}{{ post }}{{ /* }}');
expect(result).toEqual({ users: [], posts: [] });
});
test('excludes function calls', () => {
const result = findTemplateVars('{{ value.toFixed(2) }}');
expect(result).toEqual({ value: '' });
expect(result.value).not.toBe('toFixed');
});
test('excludes method chains', () => {
const result = findTemplateVars('{{ text.replaceAll("\\n", "<br>") }}');
expect(result).toEqual({ text: '' });
});
test('handles mix of arrays and regular variables', () => {
const result = findTemplateVars('{{ * item in cart }}{{ item.name }}{{ /* }}{{ 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', () => {
const tpl = `
{{ settings.title }}
{{ * (row, index) in transaction.cart }}
{{ row.quantity }} x {{ row.name }} = \${{ row.cost.toFixed(2) }}
{{ /* }}
Total: \${{ transaction.total.toFixed(2) }}
{{ ? transaction.discount }}
Discount: {{ transaction.discount.value }}
{{ /? }}
`;
const result = findTemplateVars(tpl);
expect(result).toEqual({
settings: { title: '' },
transaction: {
cart: [],
total: '',
discount: { value: '' }
}
});
expect(result).not.toHaveProperty('row');
expect(result).not.toHaveProperty('index');
expect(result.transaction.cart).toEqual([]);
});
});
describe('renderTemplate', () => { describe('renderTemplate', () => {
test('basic variable interpolation', async () => { test('basic variable interpolation', async () => {