@rapidrest/core 1.0.1

package/dist/lib/FileUtils.js

@@ -0,0 +1,190 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2020-2026 Jean-Philippe Steinmetz
+///////////////////////////////////////////////////////////////////////////////
+import child_process from "child_process";
+import fs from "fs";
+import path from "path";
+import { StringUtils } from "./StringUtils.js";
+import { mkdirp } from "mkdirp";
+import { Logger } from "./Logger.js";
+const logger = Logger();
+const readline = require("readline");
+/**
+ * Utility functions for working with files.
+ * @author Jean-Philippe Steinmetz
+ */
+export class FileUtils {
+    /**
+     * Attempts to write the provided contents to the file path given. If a file already exists the user is prompted to
+     * allow the file to be overwritten or merged. In the case of a merge, srcPath is used as a baseline in order to
+     * perform a 3-way merge.
+     *
+     * @param {string} srcPath The baseline template file to use during a merge.
+     * @param {string} outPath The destination file path to be written.
+     * @param {any} contents The contents of the file to write.
+     * @param {boolean} overwrite Set to `true` to overwite the file and not perform a merge.
+     */
+    static async writeFile(srcPath, outPath, contents, overwrite = false) {
+        let srcPathFull = path.resolve(srcPath);
+        let outPathFull = path.resolve(outPath);
+        let fileExists = fs.existsSync(outPathFull);
+        // Make sure the path leading to the final destination exists
+        let outDirPath = path.dirname(outPath);
+        if (!fs.existsSync(outDirPath)) {
+            await mkdirp(outDirPath);
+        }
+        if (fileExists && !overwrite) {
+            // Prompt for user action
+            let invalidResponse = false;
+            while (invalidResponse) {
+                let response = await new Promise((resolve, reject) => {
+                    try {
+                        readline("Overwrite existing file: " + outPath + "? [Y]es, [N]o, [M]erge: ", (answer) => {
+                            resolve(answer);
+                        });
+                    }
+                    catch (err) {
+                        reject(err);
+                    }
+                });
+                response = response.toLocaleLowerCase();
+                if (response.length > 0) {
+                    if (response[0] === "y" || response[0] === "n" || response[0] === "m") {
+                        if (response[0] === "n") {
+                            // Immediately exit, no point in continuing
+                            return;
+                        }
+                        overwrite = response[0] === "y";
+                    }
+                    else {
+                        logger.info("Invalid input: " + response);
+                    }
+                }
+                else {
+                    logger.info("Invalid input: " + response);
+                }
+            }
+        }
+        if (!fileExists || overwrite) {
+            // Write the final output to disk
+            logger.info("Writing: " + outPathFull);
+            fs.writeFileSync(outPathFull, contents);
+        }
+        else {
+            // Attempt to merge the results
+            let tmpPath = path.resolve(outPathFull + ".new");
+            fs.writeFileSync(tmpPath, contents);
+            // Attempt to merge the updated version of the file with the original.
+            let mergedPath = path.resolve(outPathFull + ".merged");
+            let success = true;
+            try {
+                let { stdout, stderr } = child_process.exec("kdiff3 " +
+                    srcPathFull +
+                    " " +
+                    outPathFull +
+                    " " +
+                    tmpPath +
+                    ' -m --auto --cs "ShowInfoDialogs=0" --cs "LineEndStyle=0" -o ' +
+                    mergedPath);
+            }
+            catch (err) {
+                success = false;
+            }
+            // Read back in the newly merged file so we can replace write a new generated date
+            let merged = fs.readFileSync(mergedPath, "utf-8");
+            merged = merged.replace(new RegExp("^// Last Generated.*$", "g"), "// Last Generated: " + new Date());
+            // Write the merged copy to the final destination and clean up temporary files
+            logger.info("Writing: " + outPathFull);
+            fs.writeFileSync(outPathFull, merged);
+            fs.unlinkSync(mergedPath);
+            fs.unlinkSync(tmpPath);
+        }
+    }
+    /**
+     * Generates a copy of the source file at the desired output destination and performs a swap of all values of the
+     * variables specified.
+     *
+     * @param {string} srcPath The source file to copy.
+     * @param {string} outPath The destination file to generate.
+     * @param {any} variables The map of variable names to values to swap.
+     */
+    static async copyFile(srcPath, outPath, variables = {}, overwrite = false) {
+        let srcPathFull = path.resolve(srcPath);
+        if (!fs.existsSync(srcPathFull)) {
+            throw new Error("File does not exist: " + srcPathFull);
+        }
+        // Make sure the path leading to the final destination exists
+        let outDirPath = path.dirname(outPath);
+        if (!fs.existsSync(outDirPath)) {
+            await mkdirp(outDirPath);
+        }
+        let template = fs.readFileSync(srcPathFull, "utf-8");
+        if (template) {
+            let output = StringUtils.findAndReplace(template, variables);
+            let outPathFinal = path.resolve(StringUtils.findAndReplace(outPath, variables));
+            logger.info("Writing: " + outPathFinal);
+            await FileUtils.writeFile(srcPath, outPathFinal, output, overwrite);
+        }
+        else {
+            throw new Error("Failed to read file: " + srcPathFull);
+        }
+    }
+    /**
+     * Generates a copy of the source file at the desired output destination using binary copy mode.
+     *
+     * @param {string} srcPath The source file to copy.
+     * @param {string} outPath The destination file to generate.
+     * @param {Map<string,string>} variables The map of variable names to values to swap. Applies to outPath only.
+     */
+    static async copyBinaryFile(srcPath, outPath, variables = {}) {
+        let srcPathFull = path.resolve(srcPath);
+        if (!fs.existsSync(srcPathFull)) {
+            throw new Error("File does not exist: " + srcPathFull);
+        }
+        // Make sure the path leading to the final destination exists
+        let outDirPath = path.resolve(path.dirname(outPath));
+        if (!fs.existsSync(outDirPath)) {
+            await mkdirp(outDirPath);
+        }
+        let outPathFinal = path.resolve(StringUtils.findAndReplace(outPath, variables));
+        fs.copyFileSync(srcPathFull, outPathFinal);
+    }
+    /**
+     * Performs a deep copy of a directory tree at the given srcPath to the specified output directory. Performs
+     * template replacement for all variables given and skips any files in the specified filter.
+     *
+     * @param {string} srcPath The path to the source directory to copy files from.
+     * @param {string} outPath The path to the destination directory to copy files to.
+     * @param {any} vars The map of template variables to perform replacement on.
+     * @param {array} excludeFilters The list of file extension filters to exclude during the copy process.
+     * @param {array} binaryFilters The list of file extension filters to copy as binary only.
+     * @param {boolean} force Set to `true` to force writing over any existing files.
+     */
+    static async copyDirectory(srcPath, outPath, vars = {}, excludeFilters = [], binaryFilters = [], force = false) {
+        const templatePath = path.resolve(srcPath);
+        let files = fs.readdirSync(templatePath, { withFileTypes: true });
+        files.forEach(async (file) => {
+            let extension = path.extname(file.name);
+            if (!extension) {
+                extension = file.name;
+            }
+            extension = extension.replace(".", "");
+            if (excludeFilters.indexOf(extension) === -1) {
+                let destPath = StringUtils.findAndReplace(path.join(outPath, file.name), vars);
+                if (file.isDirectory()) {
+                    if (!fs.existsSync(destPath)) {
+                        fs.mkdirSync(destPath);
+                    }
+                    await FileUtils.copyDirectory(path.join(templatePath, file.name), destPath, vars, excludeFilters, binaryFilters, force);
+                }
+                else if (binaryFilters.indexOf(extension) >= 0) {
+                    await FileUtils.copyBinaryFile(path.join(templatePath, file.name), destPath, vars);
+                }
+                else {
+                    await FileUtils.copyFile(path.join(templatePath, file.name), destPath, vars, force);
+                }
+            }
+        });
+    }
+}
+//# sourceMappingURL=FileUtils.js.map

package/dist/lib/FileUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileUtils.js","sourceRoot":"","sources":["../../src/FileUtils.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,kDAAkD;AAClD,+EAA+E;AAC/E,OAAO,aAAa,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC;AACxB,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAErC;;;GAGG;AACF,MAAM,OAAO,SAAS;IACnB;;;;;;;;;OASG;IACI,MAAM,CAAC,KAAK,CAAC,SAAS,CACzB,OAAe,EACf,OAAe,EACf,QAAa,EACb,YAAqB,KAAK;QAE1B,IAAI,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACxC,IAAI,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACxC,IAAI,UAAU,GAAG,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAE5C,6DAA6D;QAC7D,IAAI,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACvC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YAC7B,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC;QAC7B,CAAC;QAED,IAAI,UAAU,IAAI,CAAC,SAAS,EAAE,CAAC;YAC3B,yBAAyB;YACzB,IAAI,eAAe,GAAG,KAAK,CAAC;YAC5B,OAAO,eAAe,EAAE,CAAC;gBACrB,IAAI,QAAQ,GAAW,MAAM,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;oBACjE,IAAI,CAAC;wBACD,QAAQ,CACJ,2BAA2B,GAAG,OAAO,GAAG,0BAA0B,EAClE,CAAC,MAAc,EAAE,EAAE;4BACf,OAAO,CAAC,MAAM,CAAC,CAAC;wBACpB,CAAC,CACJ,CAAC;oBACN,CAAC;oBAAC,OAAO,GAAG,EAAE,CAAC;wBACX,MAAM,CAAC,GAAG,CAAC,CAAC;oBAChB,CAAC;gBACL,CAAC,CAAC,CAAC;gBACH,QAAQ,GAAG,QAAQ,CAAC,iBAAiB,EAAE,CAAC;gBAExC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACtB,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;wBACpE,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;4BACtB,2CAA2C;4BAC3C,OAAO;wBACX,CAAC;wBAED,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC;oBACpC,CAAC;yBAAM,CAAC;wBACJ,MAAM,CAAC,IAAI,CAAC,iBAAiB,GAAG,QAAQ,CAAC,CAAC;oBAC9C,CAAC;gBACL,CAAC;qBAAM,CAAC;oBACJ,MAAM,CAAC,IAAI,CAAC,iBAAiB,GAAG,QAAQ,CAAC,CAAC;gBAC9C,CAAC;YACL,CAAC;QACL,CAAC;QAED,IAAI,CAAC,UAAU,IAAI,SAAS,EAAE,CAAC;YAC3B,iCAAiC;YACjC,MAAM,CAAC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,CAAC;YACvC,EAAE,CAAC,aAAa,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QAC5C,CAAC;aAAM,CAAC;YACJ,+BAA+B;YAC/B,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,GAAG,MAAM,CAAC,CAAC;YACjD,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YACpC,sEAAsE;YACtE,IAAI,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAAC;YACvD,IAAI,OAAO,GAAG,IAAI,CAAC;YACnB,IAAI,CAAC;gBACD,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC,IAAI,CACvC,SAAS;oBACL,WAAW;oBACX,GAAG;oBACH,WAAW;oBACX,GAAG;oBACH,OAAO;oBACP,+DAA+D;oBAC/D,UAAU,CACjB,CAAC;YACN,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACX,OAAO,GAAG,KAAK,CAAC;YACpB,CAAC;YACD,kFAAkF;YAClF,IAAI,MAAM,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YAClD,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,uBAAuB,EAAE,GAAG,CAAC,EAAE,qBAAqB,GAAG,IAAI,IAAI,EAAE,CAAC,CAAC;YACtG,8EAA8E;YAC9E,MAAM,CAAC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,CAAC;YACvC,EAAE,CAAC,aAAa,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;YACtC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAC1B,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,QAAQ,CACxB,OAAe,EACf,OAAe,EACf,YAAiB,EAAE,EACnB,YAAqB,KAAK;QAE1B,IAAI,WAAW,GAAQ,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAE7C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,uBAAuB,GAAG,WAAW,CAAC,CAAC;QAC3D,CAAC;QAED,6DAA6D;QAC7D,IAAI,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACvC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YAC7B,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC;QAC7B,CAAC;QAED,IAAI,QAAQ,GAAG,EAAE,CAAC,YAAY,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QACrD,IAAI,QAAQ,EAAE,CAAC;YACX,IAAI,MAAM,GAAG,WAAW,CAAC,cAAc,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YAC7D,IAAI,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;YAChF,MAAM,CAAC,IAAI,CAAC,WAAW,GAAG,YAAY,CAAC,CAAC;YACxC,MAAM,SAAS,CAAC,SAAS,CAAC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;QACxE,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,KAAK,CAAC,uBAAuB,GAAG,WAAW,CAAC,CAAC;QAC3D,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,OAAe,EAAE,OAAe,EAAE,YAAiB,EAAE;QACpF,IAAI,WAAW,GAAQ,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAE7C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,uBAAuB,GAAG,WAAW,CAAC,CAAC;QAC3D,CAAC;QAED,6DAA6D;QAC7D,IAAI,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;QACrD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YAC7B,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC;QAC7B,CAAC;QAED,IAAI,YAAY,GAAW,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;QACxF,EAAE,CAAC,YAAY,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,KAAK,CAAC,aAAa,CAC7B,OAAe,EACf,OAAe,EACf,OAAY,EAAE,EACd,iBAAgC,EAAE,EAClC,gBAA+B,EAAE,EACjC,QAAiB,KAAK;QAEtB,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,YAAY,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QAClE,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,IAAS,EAAE,EAAE;YAC9B,IAAI,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxC,IAAI,CAAC,SAAS,EAAE,CAAC;gBACb,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC;YAC1B,CAAC;YACD,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YACvC,IAAI,cAAc,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBAC3C,IAAI,QAAQ,GAAG,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;gBAE/E,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;oBACrB,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;wBAC3B,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;oBAC3B,CAAC;oBACD,MAAM,SAAS,CAAC,aAAa,CACzB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,EAClC,QAAQ,EACR,IAAI,EACJ,cAAc,EACd,aAAa,EACb,KAAK,CACR,CAAC;gBACN,CAAC;qBAAM,IAAI,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC/C,MAAM,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;gBACvF,CAAC;qBAAM,CAAC;oBACJ,MAAM,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;gBACxF,CAAC;YACL,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;CACJ"}

package/dist/lib/JWTUtils.js

@@ -0,0 +1,111 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2020-2026 Jean-Philippe Steinmetz
+///////////////////////////////////////////////////////////////////////////////
+import crypto from "crypto";
+import jwt from "jsonwebtoken";
+import zlib from "zlib";
+/**
+ * Describes the different types of support compression methods for JWT payloads.
+ */
+export var JWTUtilsCompressionMethods;
+(function (JWTUtilsCompressionMethods) {
+    /** Uses the zlib compression method. */
+    JWTUtilsCompressionMethods["ZLIB"] = "zlib";
+})(JWTUtilsCompressionMethods || (JWTUtilsCompressionMethods = {}));
+/**
+ * Utility class for working with Json Web Token (JWT) authentication tokens.
+ *
+ * @author Jean-Philippe Steinmetz <rapidrests@gmail.com>
+ */
+export class JWTUtils {
+    /**
+     * Generates a new JWT token for the given config and user object. The user object must be a valid RapidREST
+     * user.
+     *
+     * @param config The JWT configuration to use when generating the token.
+     * @param user The user to encode into the token's payload.
+     * @param data Additional data to include the token's payload.
+     */
+    static createToken(config, user, data) {
+        // Validate the required config options
+        if (!config.secret) {
+            throw new Error("Invalid configuration provided.");
+        }
+        // Validate the user object
+        if (!user || !user.uid) {
+            throw new Error("Invalid or null user object provided.");
+        }
+        let payload = { profile: JSON.stringify(user), ...data };
+        // Encrypt the profile if desired
+        if (config.payload && config.payload.encrypt) {
+            const payloadOptions = config.payload;
+            if (payloadOptions.private_key) {
+                const keyOptions = payloadOptions;
+                const encrypted = crypto.privateEncrypt(keyOptions.private_key, Buffer.from(payload.profile));
+                payload.profile = encrypted.toString("base64");
+            }
+            else {
+                const pwOtions = payloadOptions;
+                const iv = Buffer.from(pwOtions.iv);
+                const key = crypto.scryptSync(pwOtions.password, "salt", 24);
+                const cipher = crypto.createCipheriv(pwOtions.algorithm, key, iv);
+                let encrypted = cipher.update(payload.profile, "utf8", "base64");
+                encrypted += cipher.final("base64");
+                payload.profile = encrypted;
+            }
+            payload.encryption = true;
+        }
+        // Compress the profile if desired
+        if (config.payload && config.payload.compress) {
+            if (config.payload.compress === JWTUtilsCompressionMethods.ZLIB) {
+                const buf = Buffer.from(payload.profile, "utf-8");
+                payload.profile = zlib.gzipSync(buf).toString("base64");
+                payload.compression = "zlib";
+            }
+        }
+        return jwt.sign(payload, config.secret, config.options);
+    }
+    /**
+     * Decodes the given JWT authentication token using the provided configuration. If the token is not valid an
+     * error is thrown with the reason. Returns the encoded user object payload upon success.
+     *
+     * @param config The JWT configuration to use when validating the token.
+     * @param token The JWT token to validate.
+     * @returns The data encoded in the token's payload.
+     */
+    static decodeToken(config, token) {
+        // Decode the token
+        let payload = jwt.verify(token, config.secret, config.options);
+        // Validate the payload
+        if (!payload || !payload.profile) {
+            throw new Error("Token is invalid or missing data.");
+        }
+        // Decompress the payload if desired
+        if (payload.compression === JWTUtilsCompressionMethods.ZLIB) {
+            const buf = Buffer.from(payload.profile, "base64");
+            payload.profile = zlib.gunzipSync(buf).toString("utf-8");
+        }
+        // Decrypt the payload if desired
+        if (payload.encryption && config.payload && config.payload.encrypt) {
+            const payloadOptions = config.payload;
+            if (payloadOptions.private_key) {
+                const keyOptions = payloadOptions;
+                const decrypted = crypto.privateDecrypt(keyOptions.private_key, Buffer.from(payload.profile));
+                payload.profile = decrypted.toString("utf8");
+            }
+            else {
+                const pwOtions = payloadOptions;
+                const iv = Buffer.from(payloadOptions.iv);
+                const key = crypto.scryptSync(payloadOptions.password, "salt", 24);
+                const decipher = crypto.createDecipheriv(payloadOptions.algorithm, key, iv);
+                let decrypted = decipher.update(payload.profile, "base64", "utf8");
+                decrypted += decipher.final("utf8");
+                payload.profile = decrypted;
+            }
+        }
+        // Make sure the profile is an parsed
+        payload.profile = JSON.parse(payload.profile);
+        return payload;
+    }
+}
+//# sourceMappingURL=JWTUtils.js.map

package/dist/lib/JWTUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JWTUtils.js","sourceRoot":"","sources":["../../src/JWTUtils.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,kDAAkD;AAClD,+EAA+E;AAC/E,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,GAAG,MAAM,cAAc,CAAC;AAC/B,OAAO,IAAI,MAAM,MAAM,CAAC;AA8CxB;;GAEG;AACH,MAAM,CAAN,IAAY,0BAGX;AAHD,WAAY,0BAA0B;IAClC,wCAAwC;IACxC,2CAAa,CAAA;AACjB,CAAC,EAHW,0BAA0B,KAA1B,0BAA0B,QAGrC;AAkFD;;;;GAIG;AACH,MAAM,OAAO,QAAQ;IACjB;;;;;;;OAOG;IACI,MAAM,CAAC,WAAW,CAAC,MAAsB,EAAE,IAAa,EAAE,IAAU;QACvE,uCAAuC;QACvC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACvD,CAAC;QAED,2BAA2B;QAC3B,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC7D,CAAC;QAED,IAAI,OAAO,GAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC;QAE9D,iCAAiC;QACjC,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YAC3C,MAAM,cAAc,GAAQ,MAAM,CAAC,OAAO,CAAC;YAC3C,IAAI,cAAc,CAAC,WAAW,EAAE,CAAC;gBAC7B,MAAM,UAAU,GAA8B,cAA2C,CAAC;gBAC1F,MAAM,SAAS,GAAW,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;gBACtG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACnD,CAAC;iBAAM,CAAC;gBACJ,MAAM,QAAQ,GAAmC,cAAgD,CAAC;gBAClG,MAAM,EAAE,GAAW,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;gBAC5C,MAAM,GAAG,GAAW,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;gBACrE,MAAM,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;gBAElE,IAAI,SAAS,GAAW,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;gBACzE,SAAS,IAAI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;gBACpC,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;YAChC,CAAC;YACD,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;QAC9B,CAAC;QAED,kCAAkC;QAClC,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC5C,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,KAAK,0BAA0B,CAAC,IAAI,EAAE,CAAC;gBAC9D,MAAM,GAAG,GAAW,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAC1D,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBACxD,OAAO,CAAC,WAAW,GAAG,MAAM,CAAC;YACjC,CAAC;QACL,CAAC;QAED,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,OAAsC,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,WAAW,CAAC,MAAsB,EAAE,KAAa;QAC3D,mBAAmB;QACnB,IAAI,OAAO,GAAQ,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QAEpE,uBAAuB;QACvB,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACzD,CAAC;QAED,oCAAoC;QACpC,IAAI,OAAO,CAAC,WAAW,KAAK,0BAA0B,CAAC,IAAI,EAAE,CAAC;YAC1D,MAAM,GAAG,GAAW,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAiB,EAAE,QAAQ,CAAC,CAAC;YACrE,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC7D,CAAC;QAED,iCAAiC;QACjC,IAAI,OAAO,CAAC,UAAU,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACjE,MAAM,cAAc,GAAQ,MAAM,CAAC,OAAO,CAAC;YAC3C,IAAI,cAAc,CAAC,WAAW,EAAE,CAAC;gBAC7B,MAAM,UAAU,GAA8B,cAA2C,CAAC;gBAC1F,MAAM,SAAS,GAAW,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;gBACtG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACjD,CAAC;iBAAM,CAAC;gBACJ,MAAM,QAAQ,GAAmC,cAAgD,CAAC;gBAClG,MAAM,EAAE,GAAW,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;gBAClD,MAAM,GAAG,GAAW,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,QAAkB,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;gBACrF,MAAM,QAAQ,GAAG,MAAM,CAAC,gBAAgB,CAAC,cAAc,CAAC,SAAS,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;gBAE5E,IAAI,SAAS,GAAW,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;gBAC3E,SAAS,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACpC,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;YAChC,CAAC;QACL,CAAC;QAED,qCAAqC;QACrC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAE9C,OAAO,OAAO,CAAC;IACnB,CAAC;CACJ"}

package/dist/lib/Logger.js

@@ -0,0 +1,28 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2020-2026 Jean-Philippe Steinmetz
+///////////////////////////////////////////////////////////////////////////////
+const winston = require("winston");
+const { format, transports } = winston;
+const { combine, timestamp, printf } = format;
+const logFormat = printf((info) => {
+    return `${info.timestamp} ${info.level}: ${info.message}`;
+});
+/**
+ * Creates a new logger with the specified level and file name to output logs to.
+ *
+ * @param level The logging level to create the logger with.
+ * @param file The name (without an extension) of the file to output logs to.
+ */
+export const Logger = function (level = "debug", file = undefined) {
+    const transport = [new transports.Console()];
+    if (file) {
+        transport.push(new winston.transports.File({ filename: file + "error.log", level: "error" }));
+        transport.push(new winston.transports.File({ filename: file + ".log" }));
+    }
+    return winston.createLogger({
+        level,
+        format: combine(format.splat(), format.simple(), format.colorize(), timestamp(), logFormat),
+        transports: transport,
+    });
+};
+//# sourceMappingURL=Logger.js.map

package/dist/lib/Logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Logger.js","sourceRoot":"","sources":["../../src/Logger.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,kDAAkD;AAClD,+EAA+E;AAC/E,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;AACnC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;AACvC,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;AAC9C,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,IAAS,EAAE,EAAE;IACnC,OAAO,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;AAC9D,CAAC,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,MAAM,GAAQ,UAAS,QAAgB,OAAO,EAAE,OAA2B,SAAS;IAC7F,MAAM,SAAS,GAAU,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;IACpD,IAAI,IAAI,EAAE,CAAC;QACP,SAAS,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,GAAG,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;QAC9F,SAAS,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,GAAG,MAAM,EAAE,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED,OAAO,OAAO,CAAC,YAAY,CAAC;QACxB,KAAK;QACL,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,EAAE,SAAS,CAAC;QAC3F,UAAU,EAAE,SAAS;KACxB,CAAC,CAAC;AACP,CAAC,CAAC"}

package/dist/lib/MessagingUtils.js

@@ -0,0 +1,218 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2020-2026 Jean-Philippe Steinmetz
+///////////////////////////////////////////////////////////////////////////////
+import handlebars from "handlebars";
+import { Config, Init, Logger } from "./decorators/ObjectDecorators.js";
+/**
+ * Simple utility class for sending templated messages via e-mail, SMS and more.
+ */
+export class MessagingUtils {
+    slackApps = [];
+    slackConfigs = [];
+    smtpConfig;
+    twilio;
+    twilioConfig = null;
+    templates = {};
+    logger;
+    async init() {
+        if (this.slackConfigs.length > 0) {
+            try {
+                const { App } = await import("@slack/bolt");
+                if (!App) {
+                    throw new Error("Failed to import @slack/bolt. Did you add it to your project?");
+                }
+                for (const slackConfig of this.slackConfigs) {
+                    if (!slackConfig.token || !slackConfig.signingSecret) {
+                        throw new Error("Slack token or signingSecret is not set.");
+                    }
+                    const app = new App({
+                        token: slackConfig.token,
+                        signingSecret: slackConfig.signingSecret,
+                    });
+                    this.slackApps.push(app);
+                }
+            }
+            catch (error) {
+                this.logger?.error("Unable to setup slack notifications");
+                this.logger?.debug(error);
+            }
+        }
+        if (this.smtpConfig) {
+            try {
+                const nodemailer = await import("nodemailer");
+                if (!nodemailer) {
+                    throw new Error("Failed to import nodemailer. Did you add it to your project?");
+                }
+                if (!this.smtpConfig.host) {
+                    throw new Error("No host specified in SMTP configuration.");
+                }
+            }
+            catch (error) {
+                this.logger?.error("Unable to setup email notifications");
+                this.logger?.debug(error);
+            }
+        }
+        if (this.twilioConfig) {
+            try {
+                if (!this.twilioConfig.accountSid || !this.twilioConfig.token) {
+                    throw new Error("Twilio accountSid or token is not set.");
+                }
+                const twilio = await import("twilio");
+                if (!twilio) {
+                    throw new Error("Failed to import twilio. Did you add it to your project?");
+                }
+                this.twilio = twilio(this.twilioConfig.accountSid, this.twilioConfig.token, this.twilioConfig.options);
+            }
+            catch (error) {
+                this.logger?.error("Unable to setup twilio notifications");
+                this.logger?.debug(error);
+            }
+        }
+    }
+    /**
+     * Sends an email using the given template name and variables.
+     * @param templateName The name of the email template to send.
+     * @param templateVars The map of variables to inject into the template.
+     * @param options The map of additional options to pass into the sendMail function.
+     * @returns
+     */
+    async sendEmail(templateName, templateVars, options = {}) {
+        if (!this.smtpConfig) {
+            throw new Error("E-mail is not configured.");
+        }
+        if (!this.templates[templateName]) {
+            throw new Error(`No template found with name ${templateName}`);
+        }
+        const tplConfig = this.templates[templateName];
+        if (!tplConfig.enabled || !tplConfig.subject) {
+            return undefined;
+        }
+        // Create the plain text template
+        let message = null;
+        if (tplConfig.text) {
+            const template = handlebars.compile(tplConfig.text);
+            message = template(templateVars);
+        }
+        // Create the HTML template
+        let htmlMessage = null;
+        if (tplConfig.html) {
+            const template = handlebars.compile(tplConfig.html);
+            htmlMessage = template(templateVars);
+        }
+        const subjectTemplate = handlebars.compile(tplConfig.subject);
+        const subject = subjectTemplate(templateVars);
+        // Send the e-mail to the user
+        const nodemailer = await import("nodemailer");
+        const transporter = nodemailer.createTransport(this.smtpConfig);
+        if (!this.templates?.from?.email) {
+            this.logger?.warn("Unable to send email missing from.email in message template");
+            return undefined;
+        }
+        const result = await transporter.sendMail({
+            from: this.templates.from.email,
+            ...tplConfig.email_options,
+            ...options,
+            subject,
+            text: message,
+            html: htmlMessage,
+        });
+        return result;
+    }
+    /**
+     * Sends an Slack message using the given template name and variables.
+     * @param templateName The name of the Slack template to send.
+     * @param templateVars The map of variables to inject into the template.
+     * @returns
+     */
+    async sendSlack(templateName, templateVars) {
+        if (this.slackApps.length === 0) {
+            throw new Error("Slack is not configured.");
+        }
+        if (!this.templates[templateName]) {
+            throw new Error(`No template found with name ${templateName}`);
+        }
+        const tplConfig = this.templates[templateName];
+        if (!tplConfig.enabled || !tplConfig.slack_channel || !tplConfig.slack_text) {
+            return undefined;
+        }
+        // Create the sms template
+        const template = handlebars.compile(tplConfig.slack_text);
+        const message = template(templateVars);
+        const result = [];
+        // Send the slack message to the desired channel
+        for (const app of this.slackApps) {
+            const res = await app.client.chat.postMessage({
+                channel: tplConfig.slack_channel,
+                text: message,
+            });
+            result.push(res);
+        }
+        return result;
+    }
+    /**
+     * Sends an SMS using the given template name and variables.
+     * @param templateName The name of the SMS template to send.
+     * @param templateVars The map of variables to inject into the template.
+     * @param options The map of additional options to pass into the sendMail function.
+     * @returns
+     */
+    async sendSMS(templateName, templateVars, options = {}) {
+        if (!this.twilio) {
+            throw new Error("Twilio is not configured.");
+        }
+        if (!this.templates[templateName]) {
+            throw new Error(`No template found with name ${templateName}`);
+        }
+        const tplConfig = this.templates[templateName];
+        if (!tplConfig.enabled || !tplConfig.sms) {
+            return undefined;
+        }
+        // Create the sms template
+        const template = handlebars.compile(tplConfig.sms);
+        const message = template(templateVars);
+        // Send the message to the user
+        const result = await this.twilio.messages.create({
+            from: this.templates.from.sms,
+            ...tplConfig.sms_options,
+            ...options,
+            body: message,
+        });
+        return result;
+    }
+}
+__decorate([
+    Config("slack", []),
+    __metadata("design:type", Array)
+], MessagingUtils.prototype, "slackConfigs", void 0);
+__decorate([
+    Config("smtp_config", null),
+    __metadata("design:type", Object)
+], MessagingUtils.prototype, "smtpConfig", void 0);
+__decorate([
+    Config("twilio", null),
+    __metadata("design:type", Object)
+], MessagingUtils.prototype, "twilioConfig", void 0);
+__decorate([
+    Config("message_templates", {}),
+    __metadata("design:type", Object)
+], MessagingUtils.prototype, "templates", void 0);
+__decorate([
+    Logger,
+    __metadata("design:type", Object)
+], MessagingUtils.prototype, "logger", void 0);
+__decorate([
+    Init,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], MessagingUtils.prototype, "init", null);
+//# sourceMappingURL=MessagingUtils.js.map

package/dist/lib/MessagingUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MessagingUtils.js","sourceRoot":"","sources":["../../src/MessagingUtils.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+EAA+E;AAC/E,kDAAkD;AAClD,+EAA+E;AAC/E,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AA4DxE;;GAEG;AACH,MAAM,OAAO,cAAc;IACb,SAAS,GAAU,EAAE,CAAC;IAEtB,YAAY,GAAU,EAAE,CAAC;IAE3B,UAAU,CAAc;IACxB,MAAM,CAAO;IAEb,YAAY,GAAQ,IAAI,CAAC;IAEzB,SAAS,GAAgB,EAAS,CAAC;IAEnC,MAAM,CAAO;IAGR,AAAN,KAAK,CAAC,IAAI;QACb,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,IAAI,CAAC;gBACD,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,CAAC;gBAC5C,IAAI,CAAC,GAAG,EAAE,CAAC;oBACP,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;gBACrF,CAAC;gBACD,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;oBAC1C,IAAI,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC;wBACnD,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;oBAChE,CAAC;oBAED,MAAM,GAAG,GAAQ,IAAI,GAAG,CAAC;wBACrB,KAAK,EAAE,WAAW,CAAC,KAAK;wBACxB,aAAa,EAAE,WAAW,CAAC,aAAa;qBAC3C,CAAC,CAAC;oBACH,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAE7B,CAAC;YACL,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;gBAC1D,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;YAC9B,CAAC;QACL,CAAC;QAED,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YAClB,IAAI,CAAC;gBACD,MAAM,UAAU,GAAQ,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC;gBACnD,IAAI,CAAC,UAAU,EAAE,CAAC;oBACd,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;gBACpF,CAAC;gBAED,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;oBACxB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;gBAChE,CAAC;YACL,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;gBAC1D,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;YAC9B,CAAC;QACL,CAAC;QAED,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACpB,IAAI,CAAC;gBACD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;oBAC5D,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;gBAC9D,CAAC;gBAED,MAAM,MAAM,GAAQ,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAC;gBAC3C,IAAI,CAAC,MAAM,EAAE,CAAC;oBACV,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;gBAChF,CAAC;gBACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YAC3G,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,sCAAsC,CAAC,CAAC;gBAC3D,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;YAC9B,CAAC;QACL,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAC,YAAoB,EAAE,YAAiB,EAAE,UAAe,EAAE;QAC7E,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,+BAA+B,YAAY,EAAE,CAAC,CAAC;QACnE,CAAC;QAED,MAAM,SAAS,GAAa,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACzD,IAAI,CAAC,SAAS,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;YAC3C,OAAO,SAAS,CAAC;QACrB,CAAC;QAED,iCAAiC;QACjC,IAAI,OAAO,GAAkB,IAAI,CAAC;QAClC,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC;YACjB,MAAM,QAAQ,GAAgC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACjF,OAAO,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAC;QACrC,CAAC;QAED,2BAA2B;QAC3B,IAAI,WAAW,GAAkB,IAAI,CAAC;QACtC,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC;YACjB,MAAM,QAAQ,GAAgC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACjF,WAAW,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAC;QACzC,CAAC;QAED,MAAM,eAAe,GAAgC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAC3F,MAAM,OAAO,GAAW,eAAe,CAAC,YAAY,CAAC,CAAC;QAEtD,8BAA8B;QAC9B,MAAM,UAAU,GAAQ,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC;QACnD,MAAM,WAAW,GAAG,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAChE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YAC/B,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,6DAA6D,CAAC,CAAC;YACjF,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,MAAM,MAAM,GAAQ,MAAM,WAAW,CAAC,QAAQ,CAAC;YAC3C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK;YAC/B,GAAG,SAAS,CAAC,aAAa;YAC1B,GAAG,OAAO;YACV,OAAO;YACP,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,WAAW;SACpB,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CAAC,YAAoB,EAAE,YAAiB;QAC1D,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAChD,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,+BAA+B,YAAY,EAAE,CAAC,CAAC;QACnE,CAAC;QAED,MAAM,SAAS,GAAa,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACzD,IAAI,CAAC,SAAS,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,aAAa,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;YAC1E,OAAO,SAAS,CAAC;QACrB,CAAC;QAED,0BAA0B;QAC1B,MAAM,QAAQ,GAAgC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACvF,MAAM,OAAO,GAAW,QAAQ,CAAC,YAAY,CAAC,CAAC;QAE/C,MAAM,MAAM,GAAU,EAAE,CAAC;QACzB,gDAAgD;QAChD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YAC/B,MAAM,GAAG,GAAQ,MAAM,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC;gBAC/C,OAAO,EAAE,SAAS,CAAC,aAAa;gBAChC,IAAI,EAAE,OAAO;aAChB,CAAC,CAAC;YACH,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,OAAO,CAAC,YAAoB,EAAE,YAAiB,EAAE,UAAe,EAAE;QAC3E,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,+BAA+B,YAAY,EAAE,CAAC,CAAC;QACnE,CAAC;QAED,MAAM,SAAS,GAAa,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACzD,IAAI,CAAC,SAAS,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC;YACvC,OAAO,SAAS,CAAC;QACrB,CAAC;QAED,0BAA0B;QAC1B,MAAM,QAAQ,GAAgC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAChF,MAAM,OAAO,GAAW,QAAQ,CAAC,YAAY,CAAC,CAAC;QAE/C,+BAA+B;QAC/B,MAAM,MAAM,GAAQ,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;YAClD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG;YAC7B,GAAG,SAAS,CAAC,WAAW;YACxB,GAAG,OAAO;YACV,IAAI,EAAE,OAAO;SAChB,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ;AArMa;IADT,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;;oDACe;AAE3B;IADP,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC;;kDACI;AAGxB;IADP,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC;;oDACU;AAEzB;IADP,MAAM,CAAC,mBAAmB,EAAE,EAAE,CAAC;;iDACW;AAEnC;IADP,MAAM;;8CACc;AAGR;IADZ,IAAI;;;;0CA0DJ"}

package/dist/lib/NotificationsUtils.js

@@ -0,0 +1,52 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2020-2026 Jean-Philippe Steinmetz
+///////////////////////////////////////////////////////////////////////////////
+/**
+ * Utility functions for sending push notifications to registered clients.
+ *
+ * @author Jean-Philippe Steinmetz
+ */
+export class NotificationUtils {
+    /** The redis client to use for broadcasting messages. */
+    redis;
+    /**
+     * Initializes the utility using the given redis connection.
+     *
+     * @param {any} redis The redis connection to publish to.
+     */
+    constructor(redis) {
+        if (!redis) {
+            throw new Error("redis argument is required.");
+        }
+        this.redis = redis;
+    }
+    /**
+     * Broadcasts a given message to all users.
+     *
+     * @param {any} type The type of message being sent.
+     * @param {string} action The action performed on the data (if applicable).
+     * @param {string} data The contents of the message to send.
+     */
+    broadcastMessage(type, action, data) {
+        void this.redis?.publish("allusers", JSON.stringify({ type, action, data }));
+    }
+    /**
+     * Sends a given message to the room or user with the specified uid(s).
+     *
+     * @param {string} uids The universally unique identifier of the room or user to send the message to.
+     * @param {string} type The type of message being sent.
+     * @param {string} action The action performed on the data (if applicable).
+     * @param {string} data The contents of the message to send to the room or user.
+     */
+    sendMessage(uids, type, action, data) {
+        if (Array.isArray(uids)) {
+            for (const uid of uids) {
+                void this.redis?.publish(uid, JSON.stringify({ type, action, data }));
+            }
+        }
+        else {
+            void this.redis?.publish(uids, JSON.stringify({ type, action, data }));
+        }
+    }
+}
+//# sourceMappingURL=NotificationsUtils.js.map

package/dist/lib/NotificationsUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NotificationsUtils.js","sourceRoot":"","sources":["../../src/NotificationsUtils.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,kDAAkD;AAClD,+EAA+E;AAC/E;;;;GAIG;AACH,MAAM,OAAO,iBAAiB;IAC1B,yDAAyD;IACjD,KAAK,CAAM;IAEnB;;;;OAIG;IACH,YAAY,KAAU;QAClB,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACnD,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACI,gBAAgB,CAAC,IAAS,EAAE,MAAc,EAAE,IAAS;QACxD,KAAK,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;OAOG;IACI,WAAW,CAAC,IAAuB,EAAE,IAAY,EAAE,MAAc,EAAE,IAAS;QAC/E,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACrB,KAAK,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YAC1E,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,KAAK,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAC3E,CAAC;IACL,CAAC;CACJ"}