anote-server-libs 0.11.0 → 0.11.2

package/services/WithBody.ts

@@ -1,65 +1,65 @@
-import {Request, Response} from 'express';
-import Ajv, {_} from 'ajv';
-
-export const ajv = new Ajv();
-ajv.addKeyword({
-    keyword: 'maxDigits',
-    type: 'number',
-    schemaType: 'number',
-    validate: (schema: number, data: any) => typeof data === 'number' && Math.round(data * 10 ** schema) / (10 ** schema) === data
-});
-
-export function WithBody(schema: any, collapseTopLevelNulls = true) {
-    if(schema.type === 'object') {
-        const required: string[] = [];
-        const keys = Object.getOwnPropertyNames(schema.properties);
-        keys.forEach(key => {
-            if(schema.properties[key].required === true) {
-                required.push(key);
-            }
-            if(schema.properties[key].required === true || schema.properties[key].required === false) {
-                delete schema.properties[key].required;
-            }
-        });
-        schema.required = required;
-    }
-    const validate = ajv.compile(schema);
-    return function(_: any, __: string, descriptor: PropertyDescriptor) {
-        if(typeof descriptor.value === 'function') {
-            const previousMethod = descriptor.value;
-            descriptor.value = function(this: any, req: Request, res: Response) {
-                if(req.method.toUpperCase() !== 'POST' && req.method.toUpperCase() !== 'PUT') {
-                    return previousMethod.call(this, req, res);
-                }
-                if(!req.body) {
-                    res.status(400).json({
-                        error: {
-                            errorKey: 'client.body.missing',
-                            additionalInfo: 'client.extended.badPayload'
-                        }
-                    });
-                } else {
-                    if(collapseTopLevelNulls) {
-                        Object.keys(req.body).forEach(k => {
-                            if(req.body[k] === null) delete req.body[k];
-                        });
-                    }
-                    const valid = validate(req.body);
-                    if(valid) {
-                        return previousMethod.call(this, req, res);
-                    } else {
-                        res.status(400).json({
-                            error: {
-                                errorKey: 'client.body.missing',
-                                additionalInfo: 'client.extended.badPayload',
-                                detailedInfo: validate.errors
-                            }
-                        });
-                    }
-                }
-            };
-            return descriptor;
-        }
-        return undefined;
-    };
-}
+import {Request, Response} from 'express';
+import Ajv, {_} from 'ajv';
+
+export const ajv = new Ajv();
+ajv.addKeyword({
+    keyword: 'maxDigits',
+    type: 'number',
+    schemaType: 'number',
+    validate: (schema: number, data: any) => typeof data === 'number' && Math.round(data * 10 ** schema) / (10 ** schema) === data
+});
+
+export function WithBody(schema: any, collapseTopLevelNulls = true) {
+    if(schema.type === 'object') {
+        const required: string[] = [];
+        const keys = Object.getOwnPropertyNames(schema.properties);
+        keys.forEach(key => {
+            if(schema.properties[key].required === true) {
+                required.push(key);
+            }
+            if(schema.properties[key].required === true || schema.properties[key].required === false) {
+                delete schema.properties[key].required;
+            }
+        });
+        schema.required = required;
+    }
+    const validate = ajv.compile(schema);
+    return function(_: any, __: string, descriptor: PropertyDescriptor) {
+        if(typeof descriptor.value === 'function') {
+            const previousMethod = descriptor.value;
+            descriptor.value = function(this: any, req: Request, res: Response) {
+                if(req.method.toUpperCase() !== 'POST' && req.method.toUpperCase() !== 'PUT') {
+                    return previousMethod.call(this, req, res);
+                }
+                if(!req.body) {
+                    res.status(400).json({
+                        error: {
+                            errorKey: 'client.body.missing',
+                            additionalInfo: 'client.extended.badPayload'
+                        }
+                    });
+                } else {
+                    if(collapseTopLevelNulls) {
+                        Object.keys(req.body).forEach(k => {
+                            if(req.body[k] === null) delete req.body[k];
+                        });
+                    }
+                    const valid = validate(req.body);
+                    if(valid) {
+                        return previousMethod.call(this, req, res);
+                    } else {
+                        res.status(400).json({
+                            error: {
+                                errorKey: 'client.body.missing',
+                                additionalInfo: 'client.extended.badPayload',
+                                detailedInfo: validate.errors
+                            }
+                        });
+                    }
+                }
+            };
+            return descriptor;
+        }
+        return undefined;
+    };
+}

package/services/WithTransaction.ts

@@ -1,161 +1,161 @@
-import {NextFunction, Request, Response} from 'express';
-import {Logger} from 'winston';
-import {BaseModelRepository} from '../models/repository/BaseModelRepository';
-import {jsonStringify, utils} from './utils';
-
-export const enum SystemLock {
-    CHECK_CROSSING = 1,
-    FLUSH_CALLS = 2,
-    TX_CHECK = 3
-}
-
-export const withTransactionConfig = {
-    logQueries: false,
-    timeoutMillis: 15000
-};
-
-export function withTransaction(repo: BaseModelRepository, logger: Logger, previousMethod: (req: Request, res: Response, next: NextFunction) => void, lock?: SystemLock, commitIfLost = true) {
-    return function(req: Request, res: Response, next: NextFunction) {
-        let commit = true;
-        if(!commitIfLost) {
-            res.once('close', () => commit = false);
-        }
-        const endTerminator = res.end.bind(res);
-        const jsonTerminator = (obj: any) => {
-            try { res.set('Content-Type', 'application/json'); } catch(_) {}
-            res.write(jsonStringify(obj) || '{}');
-            endTerminator();
-        };
-        const connectTimeoutHandler = setTimeout(() => {
-            // Timed out getting a client, restart worker or process...
-            logger.error('Error timed out getting a client, exiting...');
-            process.exit(22);
-        }, withTransactionConfig.timeoutMillis);
-        Promise.all([
-            repo.db ? repo.db.connect() : Promise.resolve(undefined),
-            repo.dbMssql ? Promise.resolve(repo.dbMssql.transaction()) : Promise.resolve(undefined)
-        ]).then(([c1, c2]) => {
-            const dbClient = c1 || c2;
-            clearTimeout(connectTimeoutHandler);
-            // On error, will rollback...
-            utils.logger = logger;
-            if(withTransactionConfig.logQueries && !dbClient.queryPatched) {
-                const originalQuery = dbClient.query.bind(dbClient);
-                dbClient.query = (...args: any[]) => {
-                    logger.debug('SQL [Client %d] QUERY: %s', dbClient.processID, args[0]);
-                    return originalQuery(...args);
-                };
-                dbClient.queryPatched = true;
-            }
-            dbClient.removeAllListeners('error');
-            dbClient.on('error', (err: any) => utils.clientErrorHandler(err, dbClient));
-
-            res.locals.dbClient = dbClient;
-            res.locals.dbClientCommited = false;
-            res.locals.dbClientCommit = (cb: (err: any) => any) => {
-                if(!res.locals.dbClientCommited) {
-                    res.locals.dbClientCommited = true;
-                    (commit ? (repo.db ? dbClient.query('COMMIT') : dbClient.commit()) : Promise.reject(new Error('Client lost'))).catch((err: any) => err).then((err: any) => {
-                        if(repo.db) dbClient.release();
-                        if(!(err instanceof Error)) {
-                            for(let i = 0; i < res.locals.dbClientOnCommit.length; i++) {
-                                res.locals.dbClientOnCommit[i]();
-                            }
-                        }
-                        cb(err instanceof Error ? err : undefined);
-                    });
-                } else {
-                    cb(undefined);
-                }
-            };
-            res.locals.dbClientOnCommit = [];
-            return (repo.db ? dbClient.query('BEGIN') : dbClient.begin()).then(() => {
-                const finish = () => {
-                    res.send = () => {
-                        throw new Error('res.send() should not be used within transactions. Use res.json() instead.');
-                    };
-                    res.json = (obj: any) => {
-                        if(res.statusCode > 303 && res.statusCode !== 412) {
-                            if(logger) {
-                                if(res.statusCode > 499) {
-                                    logger.error('Uncaught 500: %j', obj?.error?.additionalInfo);
-                                } else {
-                                    logger.warn('Client error 4XX: %j', obj?.error);
-                                }
-                            }
-                            (repo.db ? dbClient.query('ROLLBACK') : dbClient.rollback()).catch((err: any) => obj && obj.error && (obj.error.additionalInfo2 = {message: err.message})).then(() => {
-                                if(repo.db) dbClient.release();
-                                jsonTerminator(obj);
-                            });
-                        } else {
-                            res.locals.dbClientCommit((err: any) => {
-                                if(err && commitIfLost) {
-                                    res.status(500);
-                                    jsonTerminator({
-                                        error: {
-                                            errorKey: 'internal.db',
-                                            additionalInfo: {message: err.message}
-                                        }
-                                    });
-                                } else jsonTerminator(obj);
-                            });
-                        }
-                        return res;
-                    };
-                    res.end = () => {
-                        if(res.statusCode > 303 && res.statusCode !== 412) {
-                            if(logger && res.statusCode > 499) {
-                                logger.error('Uncaught 500 with no details...');
-                            }
-                            (repo.db ? dbClient.query('ROLLBACK') : dbClient.rollback()).catch((): any => undefined).then(() => {
-                                if(repo.db) dbClient.release();
-                                endTerminator();
-                            });
-                        } else {
-                            res.locals.dbClientCommit((err: any) => {
-                                if(err && commitIfLost) {
-                                    res.status(500);
-                                    jsonTerminator({
-                                        error: {
-                                            errorKey: 'internal.db',
-                                            additionalInfo: {message: err.message}
-                                        }
-                                    });
-                                } else endTerminator();
-                            });
-                        }
-                        return res;
-                    };
-                    return previousMethod.call(this, req, res, next);
-                };
-
-                if(lock) {
-                    dbClient.query('SELECT pg_advisory_xact_lock(' + lock + ')').then(() => finish()).catch((err: any) => {
-                        res.status(500).json({
-                            error: {
-                                errorKey: 'internal.db',
-                                additionalInfo: {message: err.message}
-                            }
-                        });
-                        dbClient.release();  // Lock acquisition failed, release will also rollback
-                    });
-                } else {
-                    finish();
-                }
-            }).catch((err: any) => {
-                // Error beginning transaction
-                dbClient.release();
-                throw err;
-            });
-        }).catch(err => {
-            // Error connecting to database for other reason than timeout or beginning transaction
-            clearTimeout(connectTimeoutHandler);
-            res.status(500).json({
-                error: {
-                    errorKey: 'internal.db',
-                    additionalInfo: {message: err.message}
-                }
-            });
-        });
-    };
-}
+import {NextFunction, Request, Response} from 'express';
+import {Logger} from 'winston';
+import {BaseModelRepository} from '../models/repository/BaseModelRepository';
+import {jsonStringify, utils} from './utils';
+
+export const enum SystemLock {
+    CHECK_CROSSING = 1,
+    FLUSH_CALLS = 2,
+    TX_CHECK = 3
+}
+
+export const withTransactionConfig = {
+    logQueries: false,
+    timeoutMillis: 15000
+};
+
+export function withTransaction(repo: BaseModelRepository, logger: Logger, previousMethod: (req: Request, res: Response, next: NextFunction) => void, lock?: SystemLock, commitIfLost = true) {
+    return function(req: Request, res: Response, next: NextFunction) {
+        let commit = true;
+        if(!commitIfLost) {
+            res.once('close', () => commit = false);
+        }
+        const endTerminator = res.end.bind(res);
+        const jsonTerminator = (obj: any) => {
+            try { res.set('Content-Type', 'application/json'); } catch(_) {}
+            res.write(jsonStringify(obj) || '{}');
+            endTerminator();
+        };
+        const connectTimeoutHandler = setTimeout(() => {
+            // Timed out getting a client, restart worker or process...
+            logger.error('Error timed out getting a client, exiting...');
+            process.exit(22);
+        }, withTransactionConfig.timeoutMillis);
+        Promise.all([
+            repo.db ? repo.db.connect() : Promise.resolve(undefined),
+            repo.dbMssql ? Promise.resolve(repo.dbMssql.transaction()) : Promise.resolve(undefined)
+        ]).then(([c1, c2]) => {
+            const dbClient = c1 || c2;
+            clearTimeout(connectTimeoutHandler);
+            // On error, will rollback...
+            utils.logger = logger;
+            if(withTransactionConfig.logQueries && !dbClient.queryPatched) {
+                const originalQuery = dbClient.query.bind(dbClient);
+                dbClient.query = (...args: any[]) => {
+                    logger.debug('SQL [Client %d] QUERY: %s', dbClient.processID, args[0]);
+                    return originalQuery(...args);
+                };
+                dbClient.queryPatched = true;
+            }
+            dbClient.removeAllListeners('error');
+            dbClient.on('error', (err: any) => utils.clientErrorHandler(err, dbClient));
+
+            res.locals.dbClient = dbClient;
+            res.locals.dbClientCommited = false;
+            res.locals.dbClientCommit = (cb: (err: any) => any) => {
+                if(!res.locals.dbClientCommited) {
+                    res.locals.dbClientCommited = true;
+                    (commit ? (repo.db ? dbClient.query('COMMIT') : dbClient.commit()) : Promise.reject(new Error('Client lost'))).catch((err: any) => err).then((err: any) => {
+                        if(repo.db) dbClient.release();
+                        if(!(err instanceof Error)) {
+                            for(let i = 0; i < res.locals.dbClientOnCommit.length; i++) {
+                                res.locals.dbClientOnCommit[i]();
+                            }
+                        }
+                        cb(err instanceof Error ? err : undefined);
+                    });
+                } else {
+                    cb(undefined);
+                }
+            };
+            res.locals.dbClientOnCommit = [];
+            return (repo.db ? dbClient.query('BEGIN') : dbClient.begin()).then(() => {
+                const finish = () => {
+                    res.send = () => {
+                        throw new Error('res.send() should not be used within transactions. Use res.json() instead.');
+                    };
+                    res.json = (obj: any) => {
+                        if(res.statusCode > 303 && res.statusCode !== 412) {
+                            if(logger) {
+                                if(res.statusCode > 499) {
+                                    logger.error('Uncaught 500: %j', obj?.error?.additionalInfo);
+                                } else {
+                                    logger.warn('Client error 4XX: %j', obj?.error);
+                                }
+                            }
+                            (repo.db ? dbClient.query('ROLLBACK') : dbClient.rollback()).catch((err: any) => obj && obj.error && (obj.error.additionalInfo2 = {message: err.message})).then(() => {
+                                if(repo.db) dbClient.release();
+                                jsonTerminator(obj);
+                            });
+                        } else {
+                            res.locals.dbClientCommit((err: any) => {
+                                if(err && commitIfLost) {
+                                    res.status(500);
+                                    jsonTerminator({
+                                        error: {
+                                            errorKey: 'internal.db',
+                                            additionalInfo: {message: err.message}
+                                        }
+                                    });
+                                } else jsonTerminator(obj);
+                            });
+                        }
+                        return res;
+                    };
+                    res.end = () => {
+                        if(res.statusCode > 303 && res.statusCode !== 412) {
+                            if(logger && res.statusCode > 499) {
+                                logger.error('Uncaught 500 with no details...');
+                            }
+                            (repo.db ? dbClient.query('ROLLBACK') : dbClient.rollback()).catch((): any => undefined).then(() => {
+                                if(repo.db) dbClient.release();
+                                endTerminator();
+                            });
+                        } else {
+                            res.locals.dbClientCommit((err: any) => {
+                                if(err && commitIfLost) {
+                                    res.status(500);
+                                    jsonTerminator({
+                                        error: {
+                                            errorKey: 'internal.db',
+                                            additionalInfo: {message: err.message}
+                                        }
+                                    });
+                                } else endTerminator();
+                            });
+                        }
+                        return res;
+                    };
+                    return previousMethod.call(this, req, res, next);
+                };
+
+                if(lock) {
+                    dbClient.query('SELECT pg_advisory_xact_lock(' + lock + ')').then(() => finish()).catch((err: any) => {
+                        res.status(500).json({
+                            error: {
+                                errorKey: 'internal.db',
+                                additionalInfo: {message: err.message}
+                            }
+                        });
+                        dbClient.release();  // Lock acquisition failed, release will also rollback
+                    });
+                } else {
+                    finish();
+                }
+            }).catch((err: any) => {
+                // Error beginning transaction
+                dbClient.release();
+                throw err;
+            });
+        }).catch(err => {
+            // Error connecting to database for other reason than timeout or beginning transaction
+            clearTimeout(connectTimeoutHandler);
+            res.status(500).json({
+                error: {
+                    errorKey: 'internal.db',
+                    additionalInfo: {message: err.message}
+                }
+            });
+        });
+    };
+}

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');
 }
@@ -143,22 +149,22 @@ function idempotent(repo, debug, logger) {
     };
 }
 function sendSelfPostableMessage(res, code, messageType, err) {
-    res.type('text/html').status(code).write(`
-<!DOCTYPE HTML>
-<html>
-<head>
-    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
-</head>
-<body>
-<script type="text/javascript">
-    window.parent.postMessage({
-        type: '${messageType}',
-        confirm: ${!err},
-        error: JSON.parse('${JSON.stringify(err) || 'null'}')
-    }, '*');
-</script>
-</body>
-</html>
+    res.type('text/html').status(code).write(`
+<!DOCTYPE HTML>
+<html>
+<head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+</head>
+<body>
+<script type="text/javascript">
+    window.parent.postMessage({
+        type: '${messageType}',
+        confirm: ${!err},
+        error: JSON.parse('${JSON.stringify(err) || 'null'}')
+    }, '*');
+</script>
+</body>
+</html>
     `);
     res.end();
 }
@@ -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 ? path + `/${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];
+}