@ikonintegration/ikapi 4.0.1 → 5.0.0

package/dist/src/BaseEvent/Process.d.ts

@@ -0,0 +1,50 @@
+import { TransactionConfig } from './Transaction.js';
+import Logger from '../Logger/Logger.js';
+import Publisher from '../Publisher/Publisher.js';
+/**
+ * A type that represents a modified version of the TransactionConfig type, excluding the 'throwOnErrors' and 'syncReturn' properties.
+ */
+export type ProcessConfig = Omit<TransactionConfig, 'throwOnErrors' | 'syncReturn'>;
+/**
+ * Represents a long-running process that executes a given function at a specified interval.
+ */
+export default class Process {
+    /**
+     * Private member variable representing the interval value.
+     * @type {number}
+     * @private
+     */
+    private interval;
+    /**
+     * A logger object used for logging messages, errors, and other information.
+     * @readonly
+     */
+    readonly logger: Logger;
+    /**
+     * The publisher of the content.
+     */
+    readonly publisher: Publisher;
+    /**
+     * A reference to the NodeJS.Timeout object representing the interval timer.
+     */
+    timeout: NodeJS.Timeout;
+    /**
+     * Constructs a new instance of the LongRunningProcess class.
+     * @param {ProcessConfig} config - The configuration object for the process.
+     * @param {number} interval - The interval at which the process should run.
+     * @returns None
+     */
+    constructor(config: ProcessConfig, interval: number);
+    /**
+     * Executes the provided execution function at a specified interval.
+     * @param {Function} executionFunc - The function to execute.
+     * @returns None
+     */
+    execute(executionFunc: any): Promise<void>;
+    /**
+     * Executes the given execution function asynchronously and handles any exceptions that occur.
+     * @param {Function} executionFunc - The function to execute.
+     * @returns {boolean} - Returns true if the execution failed, false otherwise.
+     */
+    private iexecute;
+}

package/dist/src/BaseEvent/Process.js

@@ -0,0 +1,64 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import Logger from '../Logger/Logger.js';
+import Publisher from '../Publisher/Publisher.js';
+/**
+ * Represents a long-running process that executes a given function at a specified interval.
+ */
+export default class Process {
+    /**
+     * Constructs a new instance of the LongRunningProcess class.
+     * @param {ProcessConfig} config - The configuration object for the process.
+     * @param {number} interval - The interval at which the process should run.
+     * @returns None
+     */
+    constructor(config, interval) {
+        this.interval = interval;
+        this.logger = new Logger(config.logger, 'long-running-process');
+        this.publisher = new Publisher(config.publisher);
+    }
+    /**
+     * Executes the provided execution function at a specified interval.
+     * @param {Function} executionFunc - The function to execute.
+     * @returns None
+     */
+    execute(executionFunc) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.logger.debug('Starting main process code');
+            //Program loop
+            this.timeout = setInterval(() => __awaiter(this, void 0, void 0, function* () {
+                yield this.iexecute(executionFunc);
+            }), this.interval);
+        });
+    }
+    /**
+     * Executes the given execution function asynchronously and handles any exceptions that occur.
+     * @param {Function} executionFunc - The function to execute.
+     * @returns {boolean} - Returns true if the execution failed, false otherwise.
+     */
+    iexecute(executionFunc) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let executionFailed = true; //failed til we say no!
+            // safe execution handler
+            try {
+                // Execute
+                yield executionFunc(this);
+                executionFailed = false;
+            }
+            catch (e) {
+                /* EXECUTION FAIL */
+                this.logger.error('Exception when executing main process code. Rolling back DB!');
+                this.logger.exception(e);
+            }
+            return executionFailed;
+        });
+    }
+}
+//# sourceMappingURL=Process.js.map

package/dist/src/BaseEvent/Process.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Process.js","sourceRoot":"","sources":["../../../src/BaseEvent/Process.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,MAAM,MAAM,qBAAqB,CAAA;AACxC,OAAO,SAAS,MAAM,2BAA2B,CAAA;AAOjD;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,OAAO;IAqB1B;;;;;OAKG;IACH,YAAY,MAAqB,EAAE,QAAgB;QACjD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAA;QAC/D,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;IAClD,CAAC;IAED;;;;OAIG;IACU,OAAO,CAAC,aAAa;;YAChC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAA;YAC/C,cAAc;YACd,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,GAAS,EAAE;gBACpC,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAA;YACpC,CAAC,CAAA,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;QACnB,CAAC;KAAA;IAED;;;;OAIG;IACW,QAAQ,CAAC,aAAa;;YAClC,IAAI,eAAe,GAAG,IAAI,CAAA,CAAC,uBAAuB;YAClD,yBAAyB;YACzB,IAAI,CAAC;gBACH,UAAU;gBACV,MAAM,aAAa,CAAC,IAAI,CAAC,CAAA;gBACzB,eAAe,GAAG,KAAK,CAAA;YACzB,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,oBAAoB;gBACpB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,8DAA8D,CAAC,CAAA;gBACjF,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;YAC1B,CAAC;YACD,OAAO,eAAe,CAAA;QACxB,CAAC;KAAA;CACF"}

package/dist/src/BaseEvent/StepTransaction.d.ts

@@ -0,0 +1,23 @@
+import type { Context } from 'aws-lambda';
+import Transaction, { TransactionConfig } from './Transaction.js';
+import Response, { ResponseErrorType } from '../API/Response.js';
+/**
+ * Represents a step transaction that extends the Transaction class.
+ */
+export default class StepTransaction extends Transaction {
+    /**
+     * Constructor for creating a new Transaction object.
+     * @param {any} event - The event object.
+     * @param {Context} context - The context object.
+     * @param {TransactionConfig} [config] - Optional configuration for the transaction.
+     * @returns None
+     */
+    constructor(event: any, context: Context, config?: TransactionConfig);
+    /**
+     * Generates an error response with the provided error message and error code.
+     * @param {string} error - The error message to include in the response.
+     * @param {string} code - The error code associated with the error.
+     * @returns {Response<ResponseErrorType>} - The error response object.
+     */
+    protected getErrorResponse(error: string, code: string): Response<ResponseErrorType>;
+}

package/dist/src/BaseEvent/StepTransaction.js

@@ -0,0 +1,27 @@
+import Transaction from './Transaction.js';
+import Response from '../API/Response.js';
+/**
+ * Represents a step transaction that extends the Transaction class.
+ */
+export default class StepTransaction extends Transaction {
+    /**
+     * Constructor for creating a new Transaction object.
+     * @param {any} event - The event object.
+     * @param {Context} context - The context object.
+     * @param {TransactionConfig} [config] - Optional configuration for the transaction.
+     * @returns None
+     */
+    constructor(event, context, config) {
+        super(event, context, Object.assign({ syncReturn: true, throwOnErrors: true }, (config || {})));
+    }
+    /**
+     * Generates an error response with the provided error message and error code.
+     * @param {string} error - The error message to include in the response.
+     * @param {string} code - The error code associated with the error.
+     * @returns {Response<ResponseErrorType>} - The error response object.
+     */
+    getErrorResponse(error, code) {
+        return Response.StepFunctionResponse({ err: error, errCode: code }, 400);
+    }
+}
+//# sourceMappingURL=StepTransaction.js.map

package/dist/src/BaseEvent/StepTransaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StepTransaction.js","sourceRoot":"","sources":["../../../src/BaseEvent/StepTransaction.ts"],"names":[],"mappings":"AAEA,OAAO,WAAkC,MAAM,kBAAkB,CAAA;AACjE,OAAO,QAA+B,MAAM,oBAAoB,CAAA;AAEhE;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,WAAW;IACtD;;;;;;OAMG;IACH,YAAY,KAAU,EAAE,OAAgB,EAAE,MAA0B;QAClE,KAAK,CAAC,KAAK,EAAE,OAAO,kBAClB,UAAU,EAAE,IAAI,EAChB,aAAa,EAAE,IAAI,IAEhB,CAAC,MAAM,IAAI,EAAE,CAAC,EACjB,CAAA;IACJ,CAAC;IAED;;;;;OAKG;IACO,gBAAgB,CAAC,KAAa,EAAE,IAAY;QACpD,OAAO,QAAQ,CAAC,oBAAoB,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,GAAG,CAAC,CAAA;IAC1E,CAAC;CACF"}

package/dist/src/BaseEvent/Transaction.d.ts

@@ -0,0 +1,149 @@
+import type { APIGatewayEvent, Context, DynamoDBStreamEvent, SQSEvent } from 'aws-lambda';
+import Request from '../API/Request.js';
+import Response, { ResponseErrorType } from '../API/Response.js';
+import type { DatabaseImplType, DatabaseTransactionType, DatabaseType, DbConfig } from '../Database/types.js';
+import Logger, { LoggerConfig } from '../Logger/Logger.js';
+import Publisher, { PublisherConfig } from '../Publisher/Publisher.js';
+/**
+ * Defines a type for executing a transaction and returning a promise with the response.
+ * @param {TransactionType} transaction - The transaction to execute.
+ * @returns A promise that resolves to the response of the transaction.
+ */
+export type TransactionExecution<TransactionType, ResponseInnerType, MiscRespType = never> = (transaction: TransactionType) => Promise<Response<ResponseInnerType> | Response<ResponseErrorType> | MiscRespType>;
+/**
+ * Represents the configuration options for a transaction.
+ * @typedef {Object} TransactionConfig
+ * @property {boolean} [throwOnErrors] - Whether to throw an error if there are any errors during the transaction.
+ * @property {boolean} [syncReturn] - Whether to return the result of the transaction synchronously.
+ * @property {boolean} [skipCleanTmp] - Whether to skip cleaning the temporary folder, in EventProcessor.
+ * @property {LoggerConfig} [logger] - The configuration options for the logger.
+ * @property {PublisherConfig} [publisher] - The configuration options for the publisher.
+ */
+export type TransactionConfig = {
+    throwOnErrors?: boolean;
+    syncReturn?: boolean;
+    skipCleanTmp?: boolean;
+    logger?: LoggerConfig;
+    publisher?: PublisherConfig;
+};
+/**
+ * Represents a simple string dictionary with string values
+ */
+export type StringMap = {
+    [key: string]: string | null;
+};
+/**
+ * Represents a transaction object that handles the execution of a request and manages the response.
+ * @template InputType - The type of the input data for the transaction.
+ * @template ResponseInnerType - The type of the inner response data for the transaction.
+ * @template MiscRespType - The type of miscellaneous response data for the transaction.
+ */
+export default class Transaction<InputType = never, ResponseInnerType = null, MiscRespType = never, PathParamsType = StringMap, QueryParamsType = StringMap> {
+    /**
+     * The instance of the DatabaseManager class used for managing the database.
+     */
+    private databaseManager;
+    /**
+     * An array of database transactions.
+     * @type {DatabaseTransaction[]}
+     */
+    private transactions;
+    /**
+     * Represents an event object.
+     * @private
+     * @type {any}
+     */
+    private event;
+    /**
+     * The context object for the current instance.
+     */
+    private context;
+    /**
+     * The response object that can hold different types of responses.
+     * @type {Response<ResponseInnerType | ResponseErrorType> | MiscRespType | null}
+     */
+    private response;
+    /**
+     * A private boolean variable indicating whether the return value of a synchronous operation
+     * should be synchronized with the calling thread.
+     */
+    private syncReturn;
+    /**
+     * A boolean flag indicating whether retroactive errors are enabled or not.
+     * @private
+     */
+    private retrowErrors;
+    /**
+     * A logger object used for logging messages, errors, and other information.
+     * @readonly
+     */
+    readonly logger: Logger;
+    /**
+     * The request object for making a request of type InputType.
+     * @readonly
+     */
+    readonly request: Request<InputType, PathParamsType, QueryParamsType>;
+    /**
+     * The publisher of the content.
+     */
+    readonly publisher: Publisher;
+    /**
+     * A function that acts as a response proxy for a given response object.
+     * @param {Response<ResponseInnerType>} response - The response object to proxy.
+     * @returns A promise that resolves to void.
+     */
+    responseProxy: ((response: Response<ResponseInnerType>) => Promise<void>) | null;
+    /**
+     * Constructs a new instance of the Transaction class.
+     * @param {APIGatewayEvent | SQSEvent | DynamoDBStreamEvent} event - The event object passed to the Lambda function.
+     * @param {Context} context - The context object passed to the Lambda function.
+     * @param {TransactionConfig} [config] - Optional configuration object for the transaction.
+     * @returns None
+     */
+    constructor(event: APIGatewayEvent | SQSEvent | DynamoDBStreamEvent, context: Context, config?: TransactionConfig);
+    /**
+     * Executes a transaction using the provided execution function and returns a promise
+     * that resolves to the response or miscellaneous response.
+     * @param {TransactionExecution<Transaction<InputType, ResponseInnerType, MiscRespType>, ResponseInnerType, MiscRespType>} executionFunc - The execution function to be executed.
+     * @returns {Promise<Response<ResponseInnerType | ResponseErrorType> | MiscRespType>} - A promise that resolves to the response or miscellaneous response.
+     */
+    execute(executionFunc: TransactionExecution<Transaction<InputType, ResponseInnerType, MiscRespType, PathParamsType, QueryParamsType>, ResponseInnerType, MiscRespType>): Promise<Response<ResponseInnerType | ResponseErrorType> | MiscRespType | null>;
+    /**
+     * Executes a transaction using the provided execution function and handles the response.
+     * @param {TransactionExecution<Transaction<InputType, ResponseInnerType, MiscRespType>, ResponseInnerType, MiscRespType>} executionFunc - The function to execute the transaction.
+     * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the execution failed or not.
+     */
+    private iexecute;
+    /**
+     * Retrieves a database transaction based on the provided database configuration.
+     * @param {DbConfig<S>} config - The configuration object for the database.
+     * @returns {Promise<DatabaseTransactionType<S, DBSchema>>} A promise that resolves to the database transaction.
+     */
+    getDbTransaction<S extends DatabaseType, DBSchema>(config: DbConfig<S>): Promise<DatabaseTransactionType<S, DBSchema>>;
+    /**
+     * Retrieves a database instance based on the provided configuration.
+     * @param {DbConfig<S>} config - The configuration object specifying the type of database.
+     * @returns {DatabaseImplType<S, DBSchema>} A database instance based on the provided configuration.
+     */
+    getDatabase<S extends DatabaseType, DBSchema>(config: DbConfig<S>): DatabaseImplType<S, DBSchema>;
+    /**
+     * Get the remaining time in milliseconds for the current execution context.
+     * @returns {number} The remaining time in milliseconds, or -1 if the time is not available.
+     */
+    getRemainingTimeInMillis(): number;
+    private executeDBTransactions;
+    /**
+     * Executes a logger flush operation with error handling and logging.
+     * @param {Function} safeExecution - The function to execute safely.
+     * @returns None
+     * @throws {Error} - If `retrowErrors` is true and an error occurs during execution.
+     */
+    private executeLoggerFlush;
+    /**
+     * Generates an error response with the provided error message and code.
+     * @param {string} error - The error message to include in the response.
+     * @param {string} code - The error code associated with the response.
+     * @returns {Response<ResponseErrorType>} - The error response object.
+     */
+    protected getErrorResponse(error: string, code: string): Response<ResponseErrorType>;
+}

package/dist/src/BaseEvent/Transaction.js

@@ -0,0 +1,224 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import Request from '../API/Request.js';
+import Response from '../API/Response.js';
+import { DatabaseManager } from '../Database/DatabaseManager.js';
+import Globals from '../Globals.js';
+import Logger from '../Logger/Logger.js';
+import Publisher from '../Publisher/Publisher.js';
+/**
+ * Represents a transaction object that handles the execution of a request and manages the response.
+ * @template InputType - The type of the input data for the transaction.
+ * @template ResponseInnerType - The type of the inner response data for the transaction.
+ * @template MiscRespType - The type of miscellaneous response data for the transaction.
+ */
+export default class Transaction {
+    /**
+     * Constructs a new instance of the Transaction class.
+     * @param {APIGatewayEvent | SQSEvent | DynamoDBStreamEvent} event - The event object passed to the Lambda function.
+     * @param {Context} context - The context object passed to the Lambda function.
+     * @param {TransactionConfig} [config] - Optional configuration object for the transaction.
+     * @returns None
+     */
+    constructor(event, context, config) {
+        /**
+         * The instance of the DatabaseManager class used for managing the database.
+         */
+        this.databaseManager = DatabaseManager.INSTANCE;
+        /**
+         * An array of database transactions.
+         * @type {DatabaseTransaction[]}
+         */
+        this.transactions = [];
+        const transactionId = context.awsRequestId
+            ? context.awsRequestId
+            : event.requestContext
+                ? event.requestContext.requestId
+                : 'unknown';
+        // transaction ctx
+        this.event = event;
+        this.context = context;
+        // when set, this will be called with the response context right before calling the context suceed/fail - useful for writing the resp for example.
+        this.responseProxy = null;
+        // transaction flags
+        this.syncReturn = !!(config === null || config === void 0 ? void 0 : config.syncReturn);
+        this.retrowErrors = !!(config === null || config === void 0 ? void 0 : config.throwOnErrors); /* retrow internal errors */
+        // components
+        this.logger = new Logger(config === null || config === void 0 ? void 0 : config.logger, transactionId);
+        this.request = new Request(this.event, this.context, this.logger);
+        this.publisher = new Publisher(config === null || config === void 0 ? void 0 : config.publisher);
+    }
+    /**
+     * Executes a transaction using the provided execution function and returns a promise
+     * that resolves to the response or miscellaneous response.
+     * @param {TransactionExecution<Transaction<InputType, ResponseInnerType, MiscRespType>, ResponseInnerType, MiscRespType>} executionFunc - The execution function to be executed.
+     * @returns {Promise<Response<ResponseInnerType | ResponseErrorType> | MiscRespType>} - A promise that resolves to the response or miscellaneous response.
+     */
+    execute(executionFunc) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.executeLoggerFlush(() => __awaiter(this, void 0, void 0, function* () {
+                yield this.executeDBTransactions(() => __awaiter(this, void 0, void 0, function* () {
+                    return yield this.iexecute(executionFunc);
+                }));
+            }));
+            // return raw response if sync return is requested
+            if (this.syncReturn)
+                return this.response;
+            // allow request to async succeed through lambda context
+            return null;
+        });
+    }
+    /**
+     * Executes a transaction using the provided execution function and handles the response.
+     * @param {TransactionExecution<Transaction<InputType, ResponseInnerType, MiscRespType>, ResponseInnerType, MiscRespType>} executionFunc - The function to execute the transaction.
+     * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the execution failed or not.
+     */
+    iexecute(executionFunc) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let executionFailed = true; //failed til we say no!
+            //safe execution handler
+            try {
+                //Execute
+                this.logger.debug('Starting main request code');
+                this.response = yield executionFunc(this);
+                //Answer client
+                if (this.response && this.response instanceof Response) {
+                    yield this.response.build(this.context, this, this.syncReturn);
+                    executionFailed = !!(this.response.getBody() && this.response.getBody()['rollback']);
+                }
+                else if (this.syncReturn && this.response) {
+                    this.logger.log('Sync return with different response object');
+                    this.logger.debug(this.response);
+                    executionFailed = false;
+                }
+                else {
+                    this.response = this.getErrorResponse(Globals.ErrorResponseInvalidServerResponse, Globals.ErrorCode_APIError);
+                    yield this.response.build(this.context, this, this.syncReturn);
+                    this.logger.error('Invalid response object from main request code.');
+                }
+            }
+            catch (e) {
+                /*EXECUTION FAIL*/
+                this.logger.error('Exception when executing main request code.');
+                this.logger.exception(e);
+                //retrow?
+                if (this.retrowErrors)
+                    throw e;
+                //envelope exception?
+                this.response = this.getErrorResponse(Globals.ErrorResponseUnhandledError, Globals.ErrorCode_APIError);
+                yield this.response.build(this.context, this, this.syncReturn);
+            }
+            return executionFailed;
+        });
+    }
+    /**
+     * Retrieves a database transaction based on the provided database configuration.
+     * @param {DbConfig<S>} config - The configuration object for the database.
+     * @returns {Promise<DatabaseTransactionType<S, DBSchema>>} A promise that resolves to the database transaction.
+     */
+    getDbTransaction(config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const db = this.getDatabase(config);
+            const dbTrans = yield db.transaction();
+            this.transactions.push(dbTrans);
+            return dbTrans;
+        });
+    }
+    /**
+     * Retrieves a database instance based on the provided configuration.
+     * @param {DbConfig<S>} config - The configuration object specifying the type of database.
+     * @returns {DatabaseImplType<S, DBSchema>} A database instance based on the provided configuration.
+     */
+    getDatabase(config) {
+        return this.databaseManager.create(config);
+    }
+    /**
+     * Get the remaining time in milliseconds for the current execution context.
+     * @returns {number} The remaining time in milliseconds, or -1 if the time is not available.
+     */
+    getRemainingTimeInMillis() {
+        var _a, _b;
+        return ((_b = (_a = this.context) === null || _a === void 0 ? void 0 : _a.getRemainingTimeInMillis) === null || _b === void 0 ? void 0 : _b.call(_a)) || -1;
+    }
+    /*
+     * Executes a series of database transactions in a safe manner.
+     * @param {Function} safeExecution - The function that contains the database transactions to be executed.
+     * @returns None
+     * @throws {Error} - If an exception occurs during the execution of the transactions and `retrowErrors` is true.
+     */
+    executeDBTransactions(safeExecution) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                // Execute
+                const execFailed = yield safeExecution();
+                for (const transaction of [...this.transactions].reverse()) {
+                    try {
+                        yield transaction[execFailed ? 'closeFailure' : 'closeSuccess']();
+                    }
+                    catch (e) {
+                        this.logger.error('Exception when closing DB transactions after success.');
+                        this.logger.exception(e);
+                    }
+                }
+            }
+            catch (e) {
+                /* this part of the code handle exceptions at transaction level,
+                   so probably a bug but we still handle such */
+                for (const transaction of [...this.transactions].reverse()) {
+                    try {
+                        yield transaction.closeFailure();
+                    }
+                    catch (e) {
+                        this.logger.error('Exception when closing DB transactions after failure.');
+                        this.logger.exception(e);
+                    }
+                }
+                this.logger.error('Exception when executing DB transactions.');
+                this.logger.log(e.stack);
+                //retrow?
+                if (this.retrowErrors)
+                    throw e;
+            }
+        });
+    }
+    /**
+     * Executes a logger flush operation with error handling and logging.
+     * @param {Function} safeExecution - The function to execute safely.
+     * @returns None
+     * @throws {Error} - If `retrowErrors` is true and an error occurs during execution.
+     */
+    executeLoggerFlush(safeExecution) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield safeExecution();
+            }
+            catch (e) {
+                this.logger.error('Exception when flushing logs.');
+                this.logger.exception(e);
+                //retrow?
+                if (this.retrowErrors)
+                    throw e;
+            }
+            finally {
+                this.logger.debug('Transaction ended');
+            }
+        });
+    }
+    /**
+     * Generates an error response with the provided error message and code.
+     * @param {string} error - The error message to include in the response.
+     * @param {string} code - The error code associated with the response.
+     * @returns {Response<ResponseErrorType>} - The error response object.
+     */
+    getErrorResponse(error, code) {
+        return Response.BadRequestResponseWithRollback(error, code);
+    }
+}
+//# sourceMappingURL=Transaction.js.map

package/dist/src/BaseEvent/Transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Transaction.js","sourceRoot":"","sources":["../../../src/BaseEvent/Transaction.ts"],"names":[],"mappings":";;;;;;;;;AAEA,OAAO,OAAO,MAAM,mBAAmB,CAAA;AACvC,OAAO,QAA+B,MAAM,oBAAoB,CAAA;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAA;AAQhE,OAAO,OAAO,MAAM,eAAe,CAAA;AACnC,OAAO,MAAwB,MAAM,qBAAqB,CAAA;AAC1D,OAAO,SAA8B,MAAM,2BAA2B,CAAA;AAkCtE;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;IA8D9B;;;;;;OAMG;IACH,YACE,KAAuD,EACvD,OAAgB,EAChB,MAA0B;QAjE5B;;WAEG;QACK,oBAAe,GAAoB,eAAe,CAAC,QAAQ,CAAA;QACnE;;;WAGG;QACK,iBAAY,GAA0B,EAAE,CAAA;QA2D9C,MAAM,aAAa,GAAG,OAAO,CAAC,YAAY;YACxC,CAAC,CAAC,OAAO,CAAC,YAAY;YACtB,CAAC,CAAmB,KAAM,CAAC,cAAc;gBACvC,CAAC,CAAmB,KAAM,CAAC,cAAc,CAAC,SAAS;gBACnD,CAAC,CAAC,SAAS,CAAA;QACf,kBAAkB;QAClB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,kJAAkJ;QAClJ,IAAI,CAAC,aAAa,GAAG,IAAI,CAAA;QACzB,oBAAoB;QACpB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,CAAA,CAAA;QACtC,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,aAAa,CAAA,CAAA,CAAC,4BAA4B;QACxE,aAAa;QACb,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,EAAE,aAAa,CAAC,CAAA;QACvD,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CACxB,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,MAAM,CACZ,CAAA;QACD,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,CAAC,CAAA;IACnD,CAAC;IAED;;;;;OAKG;IACU,OAAO,CAClB,aAIC;;YAED,MAAM,IAAI,CAAC,kBAAkB,CAAC,GAAS,EAAE;gBACvC,MAAM,IAAI,CAAC,qBAAqB,CAAC,GAAS,EAAE;oBAC1C,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAA;gBAC3C,CAAC,CAAA,CAAC,CAAA;YACJ,CAAC,CAAA,CAAC,CAAA;YACF,kDAAkD;YAClD,IAAI,IAAI,CAAC,UAAU;gBAAE,OAAO,IAAI,CAAC,QAAQ,CAAA;YACzC,wDAAwD;YACxD,OAAO,IAAI,CAAA;QACb,CAAC;KAAA;IAED;;;;OAIG;IACW,QAAQ,CACpB,aAIC;;YAED,IAAI,eAAe,GAAG,IAAI,CAAA,CAAC,uBAAuB;YAClD,wBAAwB;YACxB,IAAI,CAAC;gBACH,SAAS;gBACT,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAA;gBAC/C,IAAI,CAAC,QAAQ,GAAG,MAAM,aAAa,CAAC,IAAI,CAAC,CAAA;gBACzC,eAAe;gBACf,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,YAAY,QAAQ,EAAE,CAAC;oBACvD,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;oBAC9D,eAAe,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,CAAC,CAAA;gBACtF,CAAC;qBAAM,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAC5C,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAA;oBAC7D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;oBAChC,eAAe,GAAG,KAAK,CAAA;gBACzB,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CACnC,OAAO,CAAC,kCAAkC,EAC1C,OAAO,CAAC,kBAAkB,CAC3B,CAAA;oBACD,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;oBAC9D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAA;gBACtE,CAAC;YACH,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,kBAAkB;gBAClB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6CAA6C,CAAC,CAAA;gBAChE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;gBACxB,SAAS;gBACT,IAAI,IAAI,CAAC,YAAY;oBAAE,MAAM,CAAC,CAAA;gBAC9B,qBAAqB;gBACrB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CACnC,OAAO,CAAC,2BAA2B,EACnC,OAAO,CAAC,kBAAkB,CAC3B,CAAA;gBACD,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;YAChE,CAAC;YACD,OAAO,eAAe,CAAA;QACxB,CAAC;KAAA;IAED;;;;OAIG;IACU,gBAAgB,CAC3B,MAAmB;;YAEnB,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,CAAc,MAAM,CAAC,CAAA;YAChD,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,WAAW,EAAE,CAAA;YACtC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC/B,OAAO,OAAc,CAAA;QACvB,CAAC;KAAA;IAED;;;;OAIG;IACI,WAAW,CAChB,MAAmB;QAEnB,OAAO,IAAI,CAAC,eAAe,CAAC,MAAM,CAAc,MAAM,CAAC,CAAA;IACzD,CAAC;IAED;;;OAGG;IACI,wBAAwB;;QAC7B,OAAO,CAAA,MAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,wBAAwB,kDAAI,KAAI,CAAC,CAAC,CAAA;IACzD,CAAC;IAED;;;;;OAKG;IACW,qBAAqB,CAAC,aAAqC;;YACvE,IAAI,CAAC;gBACH,UAAU;gBACV,MAAM,UAAU,GAAG,MAAM,aAAa,EAAE,CAAA;gBACxC,KAAK,MAAM,WAAW,IAAI,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;oBAC3D,IAAI,CAAC;wBACH,MAAM,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC,EAAE,CAAA;oBACnE,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uDAAuD,CAAC,CAAA;wBAC1E,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;oBAC1B,CAAC;gBACH,CAAC;YACH,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX;gEACgD;gBAChD,KAAK,MAAM,WAAW,IAAI,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;oBAC3D,IAAI,CAAC;wBACH,MAAM,WAAW,CAAC,YAAY,EAAE,CAAA;oBAClC,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uDAAuD,CAAC,CAAA;wBAC1E,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;oBAC1B,CAAC;gBACH,CAAC;gBACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAA;gBAC9D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;gBACxB,SAAS;gBACT,IAAI,IAAI,CAAC,YAAY;oBAAE,MAAM,CAAC,CAAA;YAChC,CAAC;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACW,kBAAkB,CAAC,aAAa;;YAC5C,IAAI,CAAC;gBACH,MAAM,aAAa,EAAE,CAAA;YACvB,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAA;gBAClD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;gBACxB,SAAS;gBACT,IAAI,IAAI,CAAC,YAAY;oBAAE,MAAM,CAAC,CAAA;YAChC,CAAC;oBAAS,CAAC;gBACT,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAA;YACxC,CAAC;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACO,gBAAgB,CAAC,KAAa,EAAE,IAAY;QACpD,OAAO,QAAQ,CAAC,8BAA8B,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IAC7D,CAAC;CACF"}

package/dist/src/Cache/Redis.d.ts

@@ -0,0 +1,29 @@
+import { RedisClientType, RedisClusterType } from 'redis';
+import { CacheConfig } from './types.js';
+/**
+ * Represents a Redis cache connection class.
+ */
+export default class Redis {
+    private static singleton;
+    /**
+     * A private static property that holds a reference to the redis.createClient function.
+     * This property is used to create client.
+     */
+    private static ClientFactory;
+    /**
+     * A private static property that references the createCluster function.
+     * This property can be used to create clusters within the class.
+     */
+    private static ClusterFactory;
+    static connection(config: CacheConfig<'redis'>): Promise<RedisClientType | RedisClusterType>;
+    private static connectionFactory;
+    /**
+     * Establishes a connection to a Redis client based on the provided configuration
+     * and holds it for reusability. If connection is detected closed, new connection is
+     * initialized and established.
+     * @param {CacheConfig<'redis'>} config - The configuration object for connecting to the Redis client.
+     * @returns {Promise<RedisClientType>} A promise that resolves to the Redis client connection.
+     */
+    private static redisClientConnection;
+    private static redisClusterConnection;
+}