anote-server-libs 0.11.0 → 0.11.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "anote-server-libs",
-  "version": "0.11.0",
+  "version": "0.11.1",
   "description": "Helpers for express-TS servers",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",

package/services/utils.js

@@ -11,6 +11,12 @@ exports.idempotent = idempotent;
 exports.sendSelfPostableMessage = sendSelfPostableMessage;
 exports.fpEuros = fpEuros;
 exports.digitize = digitize;
+exports.readEmailTemplates = readEmailTemplates;
+exports.replacePlaceholders = replacePlaceholders;
+exports.getHtmlReplaced = getHtmlReplaced;
+exports.getEmailTitle = getEmailTitle;
+exports.getEmailTranslation = getEmailTranslation;
+const fs = require("fs");
 function atob(str) {
     return Buffer.from(str, 'base64').toString('binary');
 }
@@ -195,3 +201,89 @@ function digitize(value, opts) {
     }
     return (opts && opts.currency) ? (parts[0] + '.00') : parts[0];
 }
+function loadEmailTemplates(path) {
+    if (!path || !fs.existsSync(path))
+        return undefined;
+    const loadedEmailTemplates = {};
+    const fileNames = fs.readdirSync(path);
+    fileNames.forEach(fileName => {
+        if (!fileName.startsWith('template-') || !fileName.endsWith('.html'))
+            return;
+        const templateIdentifier = fileName.slice('template-'.length, -'.html'.length);
+        loadedEmailTemplates[templateIdentifier] = fs.readFileSync(path + '/' + fileName).toString('utf8');
+    });
+    return loadedEmailTemplates;
+}
+function readEmailTemplates(path, config) {
+    const { product, name } = config.app;
+    if (!product || !name)
+        return loadEmailTemplates(path);
+    const mainPath = path + '/' + product;
+    const overridePath = product !== name ? __dirname + `/${product}/${name}` : undefined;
+    const defaultTemplates = loadEmailTemplates(mainPath);
+    const overrideTemplates = overridePath ? loadEmailTemplates(overridePath) : {};
+    return { ...defaultTemplates, ...overrideTemplates };
+}
+function replacePlaceholders(data, keys, depth) {
+    if (!keys || depth >= keys.length)
+        return undefined;
+    if (depth === keys.length - 1)
+        return (data || {})[keys[depth]];
+    return replacePlaceholders((data || {})[keys[depth]], keys, depth + 1);
+}
+function getHtml(template, translationKeyValue) {
+    if (!template)
+        return undefined;
+    const pattern = new RegExp('{{\\s*([a-zA-Z._0-9]+)\\s*}}', 'g');
+    const replacer = (_, key) => replacePlaceholders(translationKeyValue, key.split('.'), 0) ?? '';
+    template = template.replace(pattern, replacer);
+    template = template.replace(pattern, replacer);
+    template = template.replace(new RegExp('\\[\\[\\s*([a-zA-Z._0-9:]+)\\s*\\]\\]', 'g'), (_, key) => {
+        const keyParts = key.split(':');
+        return (replacePlaceholders(translationKeyValue, keyParts[1].split('.'), 0) || [])
+            .map((subContext) => getHtml(keyParts[0], subContext)).join('');
+    });
+    template = template.replace(new RegExp('<<\\s*([a-zA-Z._0-9:]+)\\s*>>', 'g'), (_, key) => {
+        const keyParts = key.split(':');
+        if (replacePlaceholders(translationKeyValue, keyParts[1].split('.'), 0))
+            return getHtml(keyParts[0], translationKeyValue);
+        return '';
+    });
+    return template;
+}
+function getHtmlReplaced(config, templates, key, lang, defaultTemplateTranslations = {}, envSpecificTranslations, extraData, newPage) {
+    const name = config.app.name;
+    const defaultTranslations = defaultTemplateTranslations?.[lang] || defaultTemplateTranslations?.[0] || {};
+    const envSpecificTrans = envSpecificTranslations?.[name]?.[key]?.[lang]
+        || envSpecificTranslations?.[name]?.[key]?.[0]
+        || {};
+    const translationKeyValue = {
+        ...defaultTranslations,
+        ...envSpecificTrans,
+        ...extraData,
+        domain: config.frontend,
+        ...config.app.emailConfig
+    };
+    let html = getHtml(templates[key], translationKeyValue);
+    if (newPage) {
+        html = html.replace('</head>', `<style>
+@media print {
+    .new-page {
+        page-break-before: always;
+    }
+}
+</style>
+</head>`);
+        html = html.replace('</body>', `<p class="new-page">Provided by Satoris</p>
+</body>`);
+    }
+    return html;
+}
+function getEmailTitle(key, lang, titles, overrideTitles, data) {
+    const pattern = new RegExp('{{\\s*([a-zA-Z._0-9]+)\\s*}}', 'g');
+    const title = overrideTitles?.[lang]?.[key] ?? titles[lang]?.[key];
+    return title?.replace(pattern, (_, placeholderKey) => data?.[placeholderKey]);
+}
+function getEmailTranslation(key, lang, translationKeyValue, defaultLang = 0) {
+    return translationKeyValue?.[lang]?.[key] ?? translationKeyValue?.[defaultLang]?.[key];
+}

package/services/utils.ts

@@ -1,3 +1,4 @@
+import * as fs from 'fs';
 import {NextFunction, Request, Response} from 'express';
 import {Logger} from 'winston';
 import {BaseModelRepository} from '../models/repository/BaseModelRepository';
@@ -178,4 +179,91 @@ export function digitize(value: number | string, opts?: {[key: string]: any}): s
         return parts[0] + '.' + decimals;
     }
     return (opts && opts.currency)? (parts[0] + '.00') : parts[0];
-}
+}
+
+function loadEmailTemplates(path: string): Record<string, string> | undefined {
+    if(!path || !fs.existsSync(path)) return undefined;
+    const loadedEmailTemplates: {[id: string]: string} = {};
+    const fileNames = fs.readdirSync(path);
+    fileNames.forEach(fileName => {
+        if(!fileName.startsWith('template-') || !fileName.endsWith('.html')) return;
+        const templateIdentifier = fileName.slice('template-'.length, -'.html'.length);
+        loadedEmailTemplates[templateIdentifier] = fs.readFileSync(path + '/' + fileName).toString('utf8');
+    });
+    return loadedEmailTemplates;
+}
+
+export function readEmailTemplates(path: string, config: Record<string, any>): {[id: string]: string} {
+    const { product, name } = config.app;
+    if (!product || !name) return loadEmailTemplates(path);
+    const mainPath = path + '/' + product;
+    const overridePath = product !== name ? __dirname + `/${product}/${name}` : undefined;
+    const defaultTemplates = loadEmailTemplates(mainPath);
+    const overrideTemplates = overridePath ? loadEmailTemplates(overridePath) : {};
+    return {...defaultTemplates, ...overrideTemplates};
+}
+
+export function replacePlaceholders(data: Record<string, any>, keys: string[], depth: number): any {
+    if(!keys || depth >= keys.length) return undefined;
+    if(depth === keys.length - 1) return (data || {})[keys[depth]];
+    return replacePlaceholders((data || {})[keys[depth]], keys, depth + 1);
+}
+
+function getHtml(template: string, translationKeyValue: Record<string, any>): string | undefined {
+    if(!template) return undefined;
+    const pattern = new RegExp('{{\\s*([a-zA-Z._0-9]+)\\s*}}', 'g');
+    const replacer = (_: string, key: string) => replacePlaceholders(translationKeyValue, key.split('.'), 0) ?? '';
+    template = template.replace(pattern, replacer);
+    template = template.replace(pattern, replacer);
+    template = template.replace(new RegExp('\\[\\[\\s*([a-zA-Z._0-9:]+)\\s*\\]\\]', 'g'), (_, key) => {
+        const keyParts = key.split(':');
+        return (replacePlaceholders(translationKeyValue, keyParts[1].split('.'), 0) || [])
+            .map((subContext: any) => getHtml(keyParts[0], subContext)).join('');
+    });
+    template = template.replace(new RegExp('<<\\s*([a-zA-Z._0-9:]+)\\s*>>', 'g'), (_, key) => {
+        const keyParts = key.split(':');
+        if(replacePlaceholders(translationKeyValue, keyParts[1].split('.'), 0))
+            return getHtml(keyParts[0], translationKeyValue);
+        return '';
+    });
+    return template;
+}
+
+export function getHtmlReplaced(config: Record<string, any>, templates: Record<string, string>, key: string, lang: number, defaultTemplateTranslations: Record<number, any> = {}, envSpecificTranslations?: Record<string, any>, extraData?: Record<string, any>, newPage?: boolean): string {
+    const name = config.app.name;
+    const defaultTranslations = defaultTemplateTranslations?.[lang] || defaultTemplateTranslations?.[0] || {};
+    const envSpecificTrans = envSpecificTranslations?.[name]?.[key]?.[lang]
+        || envSpecificTranslations?.[name]?.[key]?.[0]
+        || {};
+    const translationKeyValue = {
+        ...defaultTranslations,
+        ...envSpecificTrans,
+        ...extraData,
+        domain: config.frontend,
+        ...config.app.emailConfig
+    };
+    let html = getHtml(templates[key], translationKeyValue);
+    if(newPage) {
+        html = html.replace('</head>', `<style>
+@media print {
+    .new-page {
+        page-break-before: always;
+    }
+}
+</style>
+</head>`);
+        html = html.replace('</body>', `<p class="new-page">Provided by Satoris</p>
+</body>`);
+    }
+    return html;
+}
+
+export function getEmailTitle(key: string, lang: number, titles: Record<number, any>, overrideTitles?: Record<number, any>, data?: Record<string, string>): string | undefined {
+    const pattern = new RegExp('{{\\s*([a-zA-Z._0-9]+)\\s*}}', 'g');
+    const title = overrideTitles?.[lang]?.[key] ?? titles[lang]?.[key];
+    return title?.replace(pattern, (_: string, placeholderKey: string) => data?.[placeholderKey]);
+}
+
+export function getEmailTranslation(key: string, lang: number, translationKeyValue: Record<number, any>, defaultLang: number = 0): string | undefined {
+    return translationKeyValue?.[lang]?.[key] ?? translationKeyValue?.[defaultLang]?.[key];
+}