@ikonintegration/ikapi 4.0.0-alpha9 → 5.0.0-alpha1

package/dist/src/Globals.js

@@ -0,0 +1,99 @@
+import dotenv from 'dotenv';
+import Utils from './Util/Utils.js';
+// important for dev env to load .env file
+dotenv.config();
+/**
+ * Class containing global constants and configurations for the application.
+ */
+class Globals {
+}
+/**
+ * A constant string representing an error message for input validation failure.
+ */
+Globals.ErrorResponseValidationFail = 'Input validation failed: '; //400
+/**
+ * A constant string representing an error response for an invalid server response.
+ */
+Globals.ErrorResponseInvalidServerResponse = 'No valid response, this is a system error.'; //400
+/**
+ * The error message for an unhandled error when processing a request.
+ */
+Globals.ErrorResponseUnhandledError = 'Unhandled error when processing request.'; //400
+/**
+ * A static string representing an error response when there are no records to be processed.
+ */
+Globals.ErrorResponseNoRecords = 'No events to be processed.'; //400
+/**
+ * Represents an error code for a missing parameter.
+ * @type {string}
+ */
+Globals.ErrorCode_MissingParam = 'MISSING_PARAM';
+/**
+ * Represents an error code for invalid input.
+ * @type {string}
+ */
+Globals.ErrorCode_InvalidInput = 'INVALID_INPUT';
+/**
+ * Represents an error code for an API error.
+ * @type {string}
+ */
+Globals.ErrorCode_APIError = 'API_ERROR';
+/**
+ * Represents the error code for when there are no records found.
+ * @type {string}
+ */
+Globals.ErrorCode_NoRecords = 'EMPTY_EVENT';
+/**
+ * Retrieves the default port number for HTTP listeners.
+ * The port number is obtained from the environment variable "PORT" and parsed as an integer.
+ * If the environment variable is not set or cannot be parsed as an integer, the default port number 9000 is used.
+ * @returns {number} - The default port number for HTTP listeners.
+ */
+Globals.Listener_HTTP_DefaultPort = Utils.parseIntNullIfNaN(process.env.PORT) || 9000;
+/**
+ * The default host for the HTTP listener.
+ */
+Globals.Listener_HTTP_DefaultHost = 'localhost';
+/**
+ * The HTTP proxy route listener for all routes.
+ * @type {string}
+ */
+Globals.Listener_HTTP_ProxyRoute = '*';
+/**
+ * Retrieves the default timeout value for HTTP listeners.
+ * @returns {number} The default timeout value in milliseconds.
+ */
+Globals.Listener_HTTP_DefaultTimeout = Utils.parseIntNullIfNaN(process.env.TIMEOUT) || 30000;
+/**
+ * The default health check route for the HTTP listener.
+ * @type {string}
+ */
+Globals.Listener_HTTP_DefaultHealthCheckRoute = process.env.HEALTH_ROUTE || '/health';
+/**
+ * The response message for an exception that occurred during request execution in the Proxy.
+ */
+Globals.Resp_MSG_EXCEPTION = '[Proxy]: Exception during request execution!';
+/**
+ * The response code for an exception that occurred during execution.
+ */
+Globals.Resp_CODE_EXCEPTION = 'EXEC_EXCEPTION';
+/**
+ * The HTTP response status code for an exception scenario.
+ */
+Globals.Resp_STATUSCODE_EXCEPTION = 502;
+/**
+ * The error message for an invalid response from the server.
+ */
+Globals.Resp_MSG_INVALIDRESP = '[Proxy]: Invalid response from server!';
+/**
+ * Represents the response code for an invalid response.
+ */
+Globals.Resp_CODE_INVALIDRESP = 'EMPTY_RESPONSE';
+/**
+ * The HTTP response status code for an invalid response.
+ * @type {number}
+ * @default 400
+ */
+Globals.Resp_STATUSCODE_INVALIDRESP = 400;
+export default Globals;
+//# sourceMappingURL=Globals.js.map

package/dist/src/Globals.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Globals.js","sourceRoot":"","sources":["../../src/Globals.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAA;AAE3B,OAAO,KAAK,MAAM,iBAAiB,CAAA;AAEnC,0CAA0C;AAC1C,MAAM,CAAC,MAAM,EAAE,CAAA;AAEf;;GAEG;AACH,MAAqB,OAAO;;AAC1B;;GAEG;AACW,mCAA2B,GAAG,2BAA2B,CAAA,CAAC,KAAK;AAC7E;;GAEG;AACW,0CAAkC,GAAG,4CAA4C,CAAA,CAAC,KAAK;AACrG;;GAEG;AACW,mCAA2B,GAAG,0CAA0C,CAAA,CAAC,KAAK;AAC5F;;GAEG;AACW,8BAAsB,GAAG,4BAA4B,CAAA,CAAC,KAAK;AACzE;;;GAGG;AACW,8BAAsB,GAAG,eAAe,CAAA;AACtD;;;GAGG;AACW,8BAAsB,GAAG,eAAe,CAAA;AACtD;;;GAGG;AACW,0BAAkB,GAAG,WAAW,CAAA;AAC9C;;;GAGG;AACW,2BAAmB,GAAG,aAAa,CAAA;AAEjD;;;;;GAKG;AACW,iCAAyB,GAAG,KAAK,CAAC,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAA;AAC3F;;GAEG;AACW,iCAAyB,GAAG,WAAW,CAAA;AACrD;;;GAGG;AACW,gCAAwB,GAAG,GAAG,CAAA;AAC5C;;;GAGG;AACW,oCAA4B,GAAG,KAAK,CAAC,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,CAAA;AAClG;;;GAGG;AACW,6CAAqC,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,SAAS,CAAA;AAE3F;;GAEG;AACW,0BAAkB,GAAG,8CAA8C,CAAA;AACjF;;GAEG;AACW,2BAAmB,GAAG,gBAAgB,CAAA;AACpD;;GAEG;AACW,iCAAyB,GAAG,GAAG,CAAA;AAE7C;;GAEG;AACW,4BAAoB,GAAG,wCAAwC,CAAA;AAC7E;;GAEG;AACW,6BAAqB,GAAG,gBAAgB,CAAA;AACtD;;;;GAIG;AACW,mCAA2B,GAAG,GAAG,CAAA;eA3F5B,OAAO"}

package/dist/src/Logger/Logger.d.ts

@@ -0,0 +1,161 @@
+/**
+ * Enumeration of log levels.
+ * @enum {string}
+ * @property {string} DEBUG - Debug log level.
+ * @property {string} INFO - Info log level.
+ * @property {string} WARN - Warning log level.
+ * @property {string} ERROR - Error log level.
+ */
+export declare enum LOG_LEVELS {
+    DEBUG = "DEBUG",
+    INFO = "INFO",
+    WARN = "WARN",
+    ERROR = "ERROR"
+}
+/**
+ * Configuration options for the logger.
+ * @typedef {Object} LoggerConfig
+ * @property {boolean | Array<string>} [sensitiveFilteringKeywords] - Specifies whether to filter sensitive keywords in log messages. Can be a boolean value or an array of strings.
+ * @property {LOG_LEVELS | string} [logLevel] - The log level to use for logging. Can be one of the predefined log levels or a custom string value.
+ */
+export type LoggerConfig = {
+    sensitiveFilteringKeywords?: boolean | Array<string>;
+    logLevel?: LOG_LEVELS | string;
+};
+/**
+ * Logger class for logging messages with different log levels.
+ */
+export default class Logger {
+    /**
+     * The optional configuration object for the logger.
+     */
+    private config?;
+    /**
+     * Private property representing the transaction ID.
+     * @type {string}
+     * @private
+     */
+    private transactionID;
+    /**
+     * An array of strings representing a blacklist of filters
+     */
+    private filterBlacklist;
+    /**
+     * The current log level for the application.
+     * @private
+     * @type {LOG_LEVELS}
+     */
+    private _LOG_LEVEL;
+    /**
+     * The origin of the object.
+     * @private
+     * @type {any}
+     */
+    private origin;
+    /**
+     * Constructs a Logger object with the given configuration and transaction ID.
+     * @param {config} config - The configuration object for the logger. Can be undefined.
+     * @param {string} transactionID - The ID of the transaction associated with the logger.
+     * @returns None
+     */
+    constructor(config: LoggerConfig | undefined, transactionID: string);
+    /**
+     * Returns a boolean value indicating whether the notGlobalLogger function is executed successfully.
+     * @returns {boolean} - true if the function is executed successfully, false otherwise.
+     */
+    notGlobalLogger(): boolean;
+    /**
+     * Logs the given arguments with the debug log level.
+     * @param {...any} args - The arguments to be logged.
+     * @returns None
+     */
+    debug(...args: any[]): void;
+    /**
+     * Logs the given arguments with the INFO log level.
+     * @param {...any} args - The arguments to be logged.
+     * @returns None
+     */
+    log(...args: any[]): void;
+    /**
+     * Logs an informational message.
+     * @param {...any} args - The message(s) to log.
+     * @returns None
+     */
+    info(...args: any[]): void;
+    /**
+     * Logs a warning message with the provided arguments.
+     * @param {...any} args - The arguments to be logged as a warning message.
+     * @returns None
+     */
+    warning(...args: any[]): void;
+    /**
+     * Logs a warning message to the console.
+     * @param {...any} args - The arguments to be logged.
+     * @returns None
+     */
+    warn(...args: any[]): void;
+    /**
+     * Logs an error message with the given arguments.
+     * @param {...any} args - The arguments to log as an error message.
+     * @returns None
+     */
+    error(...args: any[]): void;
+    /**
+     * Logs an exception with optional additional arguments.
+     * @param {any} exception - The exception to log.
+     * @param {...any} args - Additional arguments to include in the log.
+     * @returns None
+     */
+    exception(exception: any, ...args: any[]): void;
+    /**
+     * Sets up the console bindings for logging purposes.
+     * @private
+     * @returns None
+     */
+    private setupBindings;
+    /**
+     * Formats a log message with the specified log level, message, and caller.
+     * @param {LOG_LEVELS} level - The log level of the message.
+     * @param {Array<string>} msg - An array of strings representing the message.
+     * @param {string} caller - The name of the caller function.
+     * @returns {string} - The formatted log message.
+     */
+    private formattedLog;
+    /**
+     * Retrieves the name of the caller function at the specified index in the stack trace.
+     * @param {number} index - The index of the caller function in the stack trace.
+     * @returns {string} The name of the caller function along with the file path and line number.
+     */
+    private callerName;
+    /**
+     * Processes log messages based on the specified log level.
+     * @param {LOG_LEVELS} level - The level of the log message.
+     * @param {any} args - The arguments to be logged.
+     * @returns None
+     */
+    private processLog;
+    private formatArgument;
+    /**
+     * Logs an exception along with additional arguments and the stack trace.
+     * @param {Error} exception - The exception object to log.
+     * @param {...any} args - Additional arguments to include in the log.
+     * @returns None
+     */
+    private iexception;
+    /**
+     * Pushes a log message to the console with the specified log level.
+     * @param {LOG_LEVELS} level - The log level of the message.
+     * @param {string} fMsg - The formatted log message.
+     * @returns None
+     */
+    private pushLog;
+    /**
+     * Suppresses sensitive information in the given value based on the filter blacklist.
+     * @param {any} value - The value to suppress sensitive information from.
+     * @returns {string} - The value with sensitive information suppressed.
+     */
+    private suppressSensitiveInfo;
+    private suppressSensitiveInfoItem;
+    private suppressSensitiveString;
+    private suppressSensitiveObject;
+}

package/dist/src/Logger/Logger.js

@@ -0,0 +1,297 @@
+import abind from 'abind';
+import stringify from 'json-stringify-safe';
+import stackTrace from 'stack-trace';
+import Utils from '../Util/Utils.js';
+/**
+ * Enumeration of log levels.
+ * @enum {string}
+ * @property {string} DEBUG - Debug log level.
+ * @property {string} INFO - Info log level.
+ * @property {string} WARN - Warning log level.
+ * @property {string} ERROR - Error log level.
+ */
+export var LOG_LEVELS;
+(function (LOG_LEVELS) {
+    LOG_LEVELS["DEBUG"] = "DEBUG";
+    LOG_LEVELS["INFO"] = "INFO";
+    LOG_LEVELS["WARN"] = "WARN";
+    LOG_LEVELS["ERROR"] = "ERROR";
+})(LOG_LEVELS || (LOG_LEVELS = {}));
+/**
+ * A constant that represents the console object to be used for logging.
+ * If the console object has a property named 'notGlobalLogger', it is assumed
+ * to be a custom logger and the 'origin' property is used as the console object.
+ * Otherwise, the global console object is used.
+ * @type {Console}
+ */
+const PURE_CONSOLE = console['notGlobalLogger'] ? console['origin'] : console;
+/**
+ * The default log function that is used for logging messages.
+ * @type {Function}
+ */
+const DEFAULT_LOG_FUNCTION = PURE_CONSOLE.log.bind(PURE_CONSOLE);
+/**
+ * Creates a blacklist array by mapping each string in the given array to its lowercase form.
+ * The resulting blacklist array is used to filter out sensitive information.
+ * @type {string[]} blacklist - An array of strings to be converted to lowercase and used as a blacklist.
+ * @returns {string[]} - An array of lowercase strings representing the blacklist.
+ */
+const blacklist = ['password', 'token', 'accounts'].map(s => s.toLowerCase());
+/**
+ * Logger class for logging messages with different log levels.
+ */
+export default class Logger {
+    /**
+     * Constructs a Logger object with the given configuration and transaction ID.
+     * @param {config} config - The configuration object for the logger. Can be undefined.
+     * @param {string} transactionID - The ID of the transaction associated with the logger.
+     * @returns None
+     */
+    constructor(config, transactionID) {
+        abind(this);
+        //
+        this.origin = PURE_CONSOLE;
+        this._LOG_LEVEL = (config === null || config === void 0 ? void 0 : config.logLevel)
+            ? LOG_LEVELS[config === null || config === void 0 ? void 0 : config.logLevel] || LOG_LEVELS.DEBUG
+            : LOG_LEVELS.DEBUG;
+        this.config = config || {};
+        this.transactionID = transactionID;
+        this.filterBlacklist = this.config.sensitiveFilteringKeywords
+            ? Array.isArray(this.config.sensitiveFilteringKeywords)
+                ? this.config.sensitiveFilteringKeywords
+                : blacklist
+            : [];
+        //
+        this.setupBindings();
+        //
+        this.log('Using logger with level: ' + this._LOG_LEVEL.toString());
+        this.debug('logger config: ', this.config);
+    }
+    /**
+     * Returns a boolean value indicating whether the notGlobalLogger function is executed successfully.
+     * @returns {boolean} - true if the function is executed successfully, false otherwise.
+     */
+    notGlobalLogger() {
+        return true;
+    }
+    /**
+     * Logs the given arguments with the debug log level.
+     * @param {...any} args - The arguments to be logged.
+     * @returns None
+     */
+    debug(...args) {
+        this.processLog(LOG_LEVELS.DEBUG, args);
+    }
+    /**
+     * Logs the given arguments with the INFO log level.
+     * @param {...any} args - The arguments to be logged.
+     * @returns None
+     */
+    log(...args) {
+        this.processLog(LOG_LEVELS.INFO, args);
+    }
+    /**
+     * Logs an informational message.
+     * @param {...any} args - The message(s) to log.
+     * @returns None
+     */
+    info(...args) {
+        this.processLog(LOG_LEVELS.INFO, args);
+    }
+    /**
+     * Logs a warning message with the provided arguments.
+     * @param {...any} args - The arguments to be logged as a warning message.
+     * @returns None
+     */
+    warning(...args) {
+        this.processLog(LOG_LEVELS.WARN, args);
+    }
+    /**
+     * Logs a warning message to the console.
+     * @param {...any} args - The arguments to be logged.
+     * @returns None
+     */
+    warn(...args) {
+        this.processLog(LOG_LEVELS.WARN, args);
+    }
+    /**
+     * Logs an error message with the given arguments.
+     * @param {...any} args - The arguments to log as an error message.
+     * @returns None
+     */
+    error(...args) {
+        this.processLog(LOG_LEVELS.ERROR, args);
+    }
+    /**
+     * Logs an exception with optional additional arguments.
+     * @param {any} exception - The exception to log.
+     * @param {...any} args - Additional arguments to include in the log.
+     * @returns None
+     */
+    exception(exception, ...args) {
+        this.iexception(exception, args);
+    }
+    /**
+     * Sets up the console bindings for logging purposes.
+     * @private
+     * @returns None
+     */
+    setupBindings() {
+        global.console = {
+            debug: (...args) => this.processLog(LOG_LEVELS.DEBUG, args),
+            log: (...args) => this.processLog(LOG_LEVELS.INFO, args),
+            info: (...args) => this.processLog(LOG_LEVELS.INFO, args),
+            warn: (...args) => this.processLog(LOG_LEVELS.WARN, args),
+            error: (...args) => this.processLog(LOG_LEVELS.ERROR, args),
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
+            warning: (...args) => this.processLog(LOG_LEVELS.WARN, args),
+            exception: (exception, ...args) => this.iexception(exception, args),
+        };
+    }
+    /**
+     * Formats a log message with the specified log level, message, and caller.
+     * @param {LOG_LEVELS} level - The log level of the message.
+     * @param {Array<string>} msg - An array of strings representing the message.
+     * @param {string} caller - The name of the caller function.
+     * @returns {string} - The formatted log message.
+     */
+    formattedLog(level, msg, caller) {
+        if (Utils.isHybridlessContainer() && this.transactionID) {
+            return `${this.transactionID}` + ` [${level.toString()}] [${caller}] ${msg.join(' ')}`;
+        }
+        else {
+            return `[${level.toString()}] [${caller}] ${msg.join(' ')}`;
+        }
+    }
+    /**
+     * Retrieves the name of the caller function at the specified index in the stack trace.
+     * @param {number} index - The index of the caller function in the stack trace.
+     * @returns {string} The name of the caller function along with the file path and line number.
+     */
+    callerName(index) {
+        var _a, _b, _c, _d, _e, _f;
+        const safeIndex = Math.min(index, stackTrace.get().length);
+        if (stackTrace.get()[safeIndex]) {
+            let callerName = (_c = (_b = (_a = stackTrace === null || stackTrace === void 0 ? void 0 : stackTrace.get()) === null || _a === void 0 ? void 0 : _a[safeIndex]) === null || _b === void 0 ? void 0 : _b.getFileName()) === null || _c === void 0 ? void 0 : _c.split('/');
+            callerName = (_d = callerName === null || callerName === void 0 ? void 0 : callerName.slice(callerName === null || callerName === void 0 ? void 0 : callerName.indexOf('src'))) === null || _d === void 0 ? void 0 : _d.join('/');
+            return callerName + ':' + ((_f = (_e = stackTrace === null || stackTrace === void 0 ? void 0 : stackTrace.get()) === null || _e === void 0 ? void 0 : _e[safeIndex]) === null || _f === void 0 ? void 0 : _f.getLineNumber());
+        }
+        return '';
+    }
+    /**
+     * Processes log messages based on the specified log level.
+     * @param {LOG_LEVELS} level - The level of the log message.
+     * @param {any} args - The arguments to be logged.
+     * @returns None
+     */
+    processLog(level, args) {
+        if (level < this._LOG_LEVEL)
+            return;
+        //get args
+        const msg = [];
+        for (const arg of args) {
+            // Deep clone object so we dont modify source
+            const fMsg = this.formatArgument(arg);
+            msg.push(fMsg);
+        }
+        //push into logs stack
+        // todo: improve error stack
+        this.pushLog(level, this.formattedLog(level, msg, this.callerName(3)));
+    }
+    formatArgument(arg) {
+        if (arg instanceof Error) {
+            return arg.message + '\n' + arg.stack;
+        }
+        if (arg && typeof arg === 'object') {
+            return stringify(this.suppressSensitiveInfo(JSON.parse(stringify(arg))), null, 2);
+        }
+        return `${this.suppressSensitiveInfo(arg)}`;
+    }
+    /**
+     * Logs an exception along with additional arguments and the stack trace.
+     * @param {Error} exception - The exception object to log.
+     * @param {...any} args - Additional arguments to include in the log.
+     * @returns None
+     */
+    iexception(exception, ...args) {
+        //format message
+        const msg = [];
+        //push exeception
+        msg.push(exception.toString() + ' -');
+        //get args
+        for (const arg of args)
+            if (arg != exception)
+                msg.push(arg);
+        if (exception.stack)
+            msg.push(exception.stack); //push Exeception stack at the end
+        //push into logs stack
+        this.pushLog(LOG_LEVELS.ERROR, this.formattedLog(LOG_LEVELS.ERROR, msg, this.callerName(3)));
+    }
+    /**
+     * Pushes a log message to the console with the specified log level.
+     * @param {LOG_LEVELS} level - The log level of the message.
+     * @param {string} fMsg - The formatted log message.
+     * @returns None
+     */
+    pushLog(level, fMsg) {
+        DEFAULT_LOG_FUNCTION.apply(PURE_CONSOLE, [fMsg]);
+    }
+    /**
+     * Suppresses sensitive information in the given value based on the filter blacklist.
+     * @param {any} value - The value to suppress sensitive information from.
+     * @returns {string} - The value with sensitive information suppressed.
+     */
+    suppressSensitiveInfo(value) {
+        if (!value || !this.filterBlacklist.length)
+            return value;
+        const parent = [value];
+        const stack = [{ value, parent, key: 0 }];
+        while (stack.length > 0) {
+            this.suppressSensitiveInfoItem(stack.pop(), stack.push.bind(stack));
+        }
+        return parent[0];
+    }
+    suppressSensitiveInfoItem({ value, parent, key }, push) {
+        if (!value)
+            return;
+        if (typeof value === 'string') {
+            this.suppressSensitiveString({ value, parent, key }, push);
+        }
+        else if (Array.isArray(value)) {
+            value.forEach((v, index) => push({ value: v, parent: value, key: index }));
+        }
+        else if (typeof value === 'object') {
+            this.suppressSensitiveObject(value, push);
+        }
+    }
+    suppressSensitiveString({ value, parent, key }, push) {
+        var _a;
+        let modifiedValue = value;
+        try {
+            // Try to parse json string
+            modifiedValue = JSON.parse(value);
+            push({ value: modifiedValue, parent, key });
+        }
+        catch (_b) {
+            const lower = value.toLowerCase();
+            if (this.filterBlacklist.some(f => lower == f))
+                modifiedValue = `**SUPPRESSED_SENSITIVE_DATA** (${((_a = String(modifiedValue)) === null || _a === void 0 ? void 0 : _a.length) || 0} len)`;
+        }
+        parent[key] = modifiedValue;
+    }
+    suppressSensitiveObject(value, push) {
+        Object.entries(value).forEach(([k, v]) => {
+            var _a;
+            const lower = k.toLowerCase();
+            const match = v && this.filterBlacklist.some(f => lower == f);
+            if (match) {
+                value[k] = `**SUPPRESSED_SENSITIVE_DATA** (${((_a = String(v)) === null || _a === void 0 ? void 0 : _a.length) || 0} len)`;
+            }
+            else {
+                push({ value: v, parent: value, key: k });
+            }
+        });
+    }
+}
+//# sourceMappingURL=Logger.js.map

package/dist/src/Logger/Logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Logger.js","sourceRoot":"","sources":["../../../src/Logger/Logger.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,SAAS,MAAM,qBAAqB,CAAA;AAC3C,OAAO,UAAU,MAAM,aAAa,CAAA;AAEpC,OAAO,KAAK,MAAM,kBAAkB,CAAA;AAEpC;;;;;;;GAOG;AACH,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,6BAAe,CAAA;IACf,2BAAa,CAAA;IACb,2BAAa,CAAA;IACb,6BAAe,CAAA;AACjB,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB;AACD;;;;;;GAMG;AACH,MAAM,YAAY,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;AAC7E;;;GAGG;AACH,MAAM,oBAAoB,GAAG,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;AAEhE;;;;;GAKG;AACH,MAAM,SAAS,GAAG,CAAC,UAAU,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAA;AAmB7E;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IA4BzB;;;;;OAKG;IACH,YAAY,MAAgC,EAAE,aAAqB;QACjE,KAAK,CAAC,IAAI,CAAC,CAAA;QACX,EAAE;QACF,IAAI,CAAC,MAAM,GAAG,YAAY,CAAA;QAC1B,IAAI,CAAC,UAAU,GAAG,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ;YAChC,CAAC,CAAC,UAAU,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,CAAC,IAAI,UAAU,CAAC,KAAK;YAClD,CAAC,CAAC,UAAU,CAAC,KAAK,CAAA;QACpB,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,EAAE,CAAA;QAC1B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,0BAA0B;YAC3D,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,0BAA0B,CAAC;gBACrD,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,0BAA0B;gBACxC,CAAC,CAAC,SAAS;YACb,CAAC,CAAC,EAAE,CAAA;QACN,EAAE;QACF,IAAI,CAAC,aAAa,EAAE,CAAA;QACpB,EAAE;QACF,IAAI,CAAC,GAAG,CAAC,2BAA2B,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAA;QAClE,IAAI,CAAC,KAAK,CAAC,iBAAiB,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;IAC5C,CAAC;IAED;;;OAGG;IACI,eAAe;QACpB,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,GAAG,IAAI;QAClB,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IACzC,CAAC;IAED;;;;OAIG;IACI,GAAG,CAAC,GAAG,IAAI;QAChB,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IACxC,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,GAAG,IAAI;QACjB,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IACxC,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,GAAG,IAAI;QACpB,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IACxC,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,GAAG,IAAI;QACjB,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IACxC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,GAAG,IAAI;QAClB,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IACzC,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAC,SAAS,EAAE,GAAG,IAAI;QACjC,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,CAAC,CAAA;IAClC,CAAC;IAED;;;;OAIG;IACK,aAAa;QACnB,MAAM,CAAC,OAAO,GAAG;YACf,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;YAC3D,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC;YACxD,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC;YACzD,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC;YACzD,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;YAC3D,6DAA6D;YAC7D,aAAa;YACb,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC;YAC5D,SAAS,EAAE,CAAC,SAAS,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,CAAC;SACpE,CAAA;IACH,CAAC;IAED;;;;;;OAMG;IACK,YAAY,CAAC,KAAiB,EAAE,GAAkB,EAAE,MAAc;QACxE,IAAI,KAAK,CAAC,qBAAqB,EAAE,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACxD,OAAO,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,KAAK,KAAK,CAAC,QAAQ,EAAE,MAAM,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAA;QACxF,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,KAAK,CAAC,QAAQ,EAAE,MAAM,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAA;QAC7D,CAAC;IACH,CAAC;IAED;;;;OAIG;IACK,UAAU,CAAC,KAAa;;QAC9B,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,UAAU,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,CAAA;QAC1D,IAAI,UAAU,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;YAChC,IAAI,UAAU,GAAG,MAAA,MAAA,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,GAAG,EAAE,0CAAG,SAAS,CAAC,0CAAE,WAAW,EAAE,0CAAE,KAAK,CAAC,GAAG,CAAC,CAAA;YAC1E,UAAU,GAAG,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,CAAC,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,OAAO,CAAC,KAAK,CAAC,CAAC,0CAAE,IAAI,CAAC,GAAG,CAAC,CAAA;YACrE,OAAO,UAAU,GAAG,GAAG,IAAG,MAAA,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,GAAG,EAAE,0CAAG,SAAS,CAAC,0CAAE,aAAa,EAAE,CAAA,CAAA;QAC3E,CAAC;QACD,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;;;;OAKG;IACK,UAAU,CAAC,KAAiB,EAAE,IAAS;QAC7C,IAAI,KAAK,GAAG,IAAI,CAAC,UAAU;YAAE,OAAM;QACnC,UAAU;QACV,MAAM,GAAG,GAAa,EAAE,CAAA;QACxB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,6CAA6C;YAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAA;YACrC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAChB,CAAC;QACD,sBAAsB;QACtB,4BAA4B;QAC5B,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACxE,CAAC;IAEO,cAAc,CAAC,GAAQ;QAC7B,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;YACzB,OAAO,GAAG,CAAC,OAAO,GAAG,IAAI,GAAG,GAAG,CAAC,KAAK,CAAA;QACvC,CAAC;QAED,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YACnC,OAAO,SAAS,CAAC,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;QACnF,CAAC;QAED,OAAO,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAA;IAC7C,CAAC;IAED;;;;;OAKG;IACK,UAAU,CAAC,SAAgB,EAAE,GAAG,IAAI;QAC1C,gBAAgB;QAChB,MAAM,GAAG,GAAkB,EAAE,CAAA;QAC7B,iBAAiB;QACjB,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC,CAAA;QACrC,UAAU;QACV,KAAK,MAAM,GAAG,IAAI,IAAI;YAAE,IAAI,GAAG,IAAI,SAAS;gBAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAC3D,IAAI,SAAS,CAAC,KAAK;YAAE,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA,CAAC,kCAAkC;QACjF,sBAAsB;QACtB,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAC9F,CAAC;IAED;;;;;OAKG;IACK,OAAO,CAAC,KAAiB,EAAE,IAAY;QAC7C,oBAAoB,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC,IAAI,CAAC,CAAC,CAAA;IAClD,CAAC;IAED;;;;OAIG;IACK,qBAAqB,CAAC,KAAU;QACtC,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM;YAAE,OAAO,KAAK,CAAA;QAExD,MAAM,MAAM,GAAG,CAAC,KAAK,CAAC,CAAA;QACtB,MAAM,KAAK,GAAsB,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAA;QAE5D,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,IAAI,CAAC,yBAAyB,CAAC,KAAK,CAAC,GAAG,EAAG,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;QACtE,CAAC;QAED,OAAO,MAAM,CAAC,CAAC,CAAC,CAAA;IAClB,CAAC;IAEO,yBAAyB,CAC/B,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAmB,EACvC,IAAkC;QAElC,IAAI,CAAC,KAAK;YAAE,OAAM;QAElB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,IAAI,CAAC,uBAAuB,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,IAAI,CAAC,CAAA;QAC5D,CAAC;aAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;QAC5E,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACrC,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;QAC3C,CAAC;IACH,CAAC;IAEO,uBAAuB,CAC7B,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAmB,EACvC,IAAkC;;QAElC,IAAI,aAAa,GAAG,KAAK,CAAA;QACzB,IAAI,CAAC;YACH,2BAA2B;YAC3B,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;YACjC,IAAI,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAA;QAC7C,CAAC;QAAC,WAAM,CAAC;YACP,MAAM,KAAK,GAAG,KAAK,CAAC,WAAW,EAAE,CAAA;YACjC,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,CAAC;gBAC5C,aAAa,GAAG,kCAAkC,CAAA,MAAA,MAAM,CAAC,aAAa,CAAC,0CAAE,MAAM,KAAI,CAAC,OAAO,CAAA;QAC/F,CAAC;QACD,MAAM,CAAC,GAAG,CAAC,GAAG,aAAa,CAAA;IAC7B,CAAC;IAEO,uBAAuB,CAAC,KAAa,EAAE,IAAkC;QAC/E,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;;YACvC,MAAM,KAAK,GAAG,CAAC,CAAC,WAAW,EAAE,CAAA;YAC7B,MAAM,KAAK,GAAG,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,CAAC,CAAA;YAC7D,IAAI,KAAK,EAAE,CAAC;gBACV,KAAK,CAAC,CAAC,CAAC,GAAG,kCAAkC,CAAA,MAAA,MAAM,CAAC,CAAC,CAAC,0CAAE,MAAM,KAAI,CAAC,OAAO,CAAA;YAC5E,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAA;YAC3C,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;CACF"}

package/dist/src/Mailer/Mailer.d.ts

@@ -0,0 +1,78 @@
+import Email from 'email-templates';
+export default class Mailer {
+    /**
+     * The starting point of a range.
+     * @type {string}
+     */
+    private readonly from;
+    /**
+     * The default file template for the application.
+     * @type {string}
+     */
+    private readonly templateDefaultFile;
+    /**
+     * The transporter object used for sending emails using the AWS SES service.
+     * @type {ReturnType<typeof nodemailer.createTransport<SESTransport.SentMessageInfo>>}
+     */
+    private readonly transporter;
+    /**
+     * Constructs a new instance of the EmailSender class.
+     * @param {string} defaultFrom - The default "from" email address.
+     * @param {string} region - The AWS region to use for sending emails.
+     * @returns None
+     */
+    constructor(defaultFrom: string, region: string);
+    /**
+     * Sends a raw email with the specified parameters.
+     * @param {string | Array<string>} to - The recipient(s) of the email.
+     * @param {string} htmlMessage - The HTML content of the email.
+     * @param {string} subject - The subject of the email.
+     * @param {string | Array<string>} [optionalCC] - The optional CC recipient(s) of the email.
+     * @param {string} [optionalFrom] - The optional sender of the email. If not provided, the default sender will be used.
+     * @param {string} [optionalReplyTo] - The optional reply-to address for the email.
+     * @param {any[]} [optionalAttachments] - The optional attachments to include
+     */
+    sendRawEmail(to: string | Array<string>, htmlMessage: string, subject: string, optionalCC?: string | Array<string>, optionalFrom?: string, optionalReplyTo?: string, optionalAttachments?: any[], optionalTransport?: Email.NodeMailerTransportOptions): Promise<null>;
+    /**
+     * Sends a templated email to the specified recipients.
+     * @param {string | Array<string>} to - The email address(es) of the recipient(s).
+     * @param {string | Array<string>} templates - The template(s) to use for the email.
+     * @param {object} data - The data to be used in the email template.
+     * @param {string | Array<string>} [optionalCC] - The email address(es) to CC.
+     * @param {string} [optionalFrom] - The email address to send the email from.
+     * @param {string} [optionalReplyTo] - The email address to set as the reply-to address.
+     * @param {any[]} [optionalAttachments] - An array
+     */
+    sendTemplatedEmail(to: string | Array<string>, templates: string | Array<string>, data: object, optionalCC?: string | Array<string>, optionalFrom?: string, optionalReplyTo?: string, optionalAttachments?: any[], optionalTransport?: Email.NodeMailerTransportOptions): Promise<null>;
+    /**
+     * Creates a new SMTP transporter for sending emails using NodeMailer.
+     * @param {string} host - The SMTP server host.
+     * @param {number} portNumber - The port number to connect to the SMTP server.
+     * @param {string} user - The username for authentication with the SMTP server.
+     * @param {string} password - The password for authentication with the SMTP server.
+     * @returns {Email.NodeMailerTransportOptions} - The SMTP transporter object.
+     */
+    newSMTPTransporter(host: string, portNumber: number, user: string, password: string): Email.NodeMailerTransportOptions;
+    /**
+     * Chooses a template from the given array of templates or a single template string based on whether it can be rendered with the provided data.
+     * @param {string | Array<string>} templates - The template(s) to choose from.
+     * @param {object} data - The data to be used for rendering the template.
+     * @returns {Promise<string>} - The chosen template.
+     * @throws {Error} - If no template can be rendered with the provided data.
+     */
+    private chooseTemplate;
+    /**
+     * Checks if a given email template can be rendered with the provided data.
+     * @param {string} template - The name of the email template.
+     * @param {object} data - The data to be used for rendering the template.
+     * @returns {Promise<boolean>} - A promise that resolves to true if the template can be rendered, false otherwise.
+     */
+    private canRenderTemplate;
+    /**
+     * Renders the given template with the provided data using the Email class.
+     * @param {string} template - The name or path of the template to render.
+     * @param {object} data - The data object to pass to the template.
+     * @returns {Promise<boolean>} - A promise that resolves to true if the template was rendered successfully, false otherwise.
+     */
+    static renderTemplate(template: string, data: object): Promise<any>;
+}