@ikonintegration/ikapi 5.0.2 → 5.0.4

package/dist/src/BaseEvent/Transaction.js

@@ -1,224 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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

@@ -1,29 +0,0 @@
-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;
-}

package/dist/src/Cache/Redis.js

@@ -1,80 +0,0 @@
-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());
-    });
-};
-var _a;
-import { createCluster, createClient } from 'redis';
-import AsyncSingleton from '../Util/AsyncSingleton.js';
-/**
- * Represents a Redis cache connection class.
- */
-class Redis {
-    static connection(config) {
-        return _a.singleton.instance(config);
-    }
-    static connectionFactory(config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (config.clusterMode)
-                return _a.redisClusterConnection(config);
-            else
-                return _a.redisClientConnection(config);
-        });
-    }
-    /**
-     * 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.
-     */
-    static redisClientConnection(config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            console.debug('Starting remote client cache connection');
-            const connection = _a.ClientFactory(Object.assign(Object.assign({ username: config.username }, (config.password ? { password: config.password } : {})), { disableOfflineQueue: true, socket: {
-                    host: config.hostname,
-                    tls: config.enableTLS,
-                    connectTimeout: 10000,
-                } }));
-            yield connection.connect();
-            return connection;
-        });
-    }
-    static redisClusterConnection(config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            console.debug('Starting remote cluster cache connection');
-            const connection = _a.ClusterFactory({
-                defaults: Object.assign(Object.assign({ username: config.username }, (config.password ? { password: config.password } : {})), { socket: {
-                        tls: config.enableTLS,
-                        connectTimeout: 10000,
-                    } }),
-                rootNodes: [
-                    {
-                        url: `redis://${config.username}:${config.username}@${config.hostname}:6379`,
-                        disableOfflineQueue: true,
-                    },
-                ],
-            });
-            yield connection.connect();
-            return connection;
-        });
-    }
-}
-_a = Redis;
-Redis.singleton = new AsyncSingleton(_a.connectionFactory, (c) => __awaiter(void 0, void 0, void 0, function* () { return c.isOpen; }));
-/**
- * A private static property that holds a reference to the redis.createClient function.
- * This property is used to create client.
- */
-Redis.ClientFactory = createClient;
-/**
- * A private static property that references the createCluster function.
- * This property can be used to create clusters within the class.
- */
-Redis.ClusterFactory = createCluster;
-export default Redis;
-//# sourceMappingURL=Redis.js.map

package/dist/src/Cache/Redis.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Redis.js","sourceRoot":"","sources":["../../../src/Cache/Redis.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,OAAO,EAAqC,aAAa,EAAE,YAAY,EAAE,MAAM,OAAO,CAAA;AAGtF,OAAO,cAAc,MAAM,2BAA2B,CAAA;AACtD;;GAEG;AACH,MAAqB,KAAK;IAkBjB,MAAM,CAAC,UAAU,CACtB,MAA4B;QAE5B,OAAO,EAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;IACzC,CAAC;IAEO,MAAM,CAAO,iBAAiB,CACpC,MAA4B;;YAE5B,IAAI,MAAM,CAAC,WAAW;gBAAE,OAAO,EAAK,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAA;;gBAC9D,OAAO,EAAK,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAA;QACjD,CAAC;KAAA;IAED;;;;;;OAMG;IACK,MAAM,CAAO,qBAAqB,CACxC,MAA4B;;YAE5B,OAAO,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAA;YACxD,MAAM,UAAU,GAAG,EAAK,CAAC,aAAa,+BACpC,QAAQ,EAAE,MAAM,CAAC,QAAQ,IACtB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,KACzD,mBAAmB,EAAE,IAAI,EACzB,MAAM,EAAE;oBACN,IAAI,EAAE,MAAM,CAAC,QAAQ;oBACrB,GAAG,EAAE,MAAM,CAAC,SAAS;oBACrB,cAAc,EAAE,KAAK;iBACtB,IACD,CAAA;YACF,MAAM,UAAU,CAAC,OAAO,EAAE,CAAA;YAE1B,OAAO,UAAiB,CAAA;QAC1B,CAAC;KAAA;IAEO,MAAM,CAAO,sBAAsB,CACzC,MAA4B;;YAE5B,OAAO,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAA;YACzD,MAAM,UAAU,GAAG,EAAK,CAAC,cAAc,CAAC;gBACtC,QAAQ,gCACN,QAAQ,EAAE,MAAM,CAAC,QAAQ,IACtB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,KACzD,MAAM,EAAE;wBACN,GAAG,EAAE,MAAM,CAAC,SAAS;wBACrB,cAAc,EAAE,KAAK;qBACtB,GACF;gBACD,SAAS,EAAE;oBACT;wBACE,GAAG,EAAE,WAAW,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,QAAQ,OAAO;wBAC5E,mBAAmB,EAAE,IAAI;qBAC1B;iBACF;aACF,CAAC,CAAA;YACF,MAAM,UAAU,CAAC,OAAO,EAAE,CAAA;YAE1B,OAAO,UAAiB,CAAA;QAC1B,CAAC;KAAA;;;AA/Ec,eAAS,GAAG,IAAI,cAAc,CAG3C,EAAK,CAAC,iBAAiB,EAAE,CAAM,CAAC,EAAC,EAAE,kDAAC,OAAA,CAAC,CAAC,MAAM,CAAA,GAAA,CAAC,AAHvB,CAGuB;AAE/C;;;GAGG;AACY,mBAAa,GAAG,YAAY,AAAf,CAAe;AAE3C;;;GAGG;AACY,oBAAc,GAAG,aAAa,AAAhB,CAAgB;eAhB1B,KAAK"}

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

@@ -1,31 +0,0 @@
-import Redis from './Redis.js';
-/**
- * Defines a type alias for specifying the cache type as 'redis'.
- */
-export type CacheType = 'redis';
-/**
- * Defines a CacheClass type that has a 'redis' property which is a constructor function
- * that takes in any number of arguments and returns an instance of Redis.
- */
-export type CacheClass = {
-    redis: new (...args: any[]) => Redis;
-};
-/**
- * Represents the base configuration for a cache, including host, username, password, and TLS settings.
- */
-export type CacheBaseConfig = {
-    hostname: string;
-    username: string;
-    password?: string;
-    enableTLS: boolean;
-    clusterMode?: boolean;
-};
-/**
- * Defines a CacheConfig type that extends CacheBaseConfig and includes a specific cache type.
- * @template S - The specific cache type to be included in the CacheConfig.
- * @extends CacheBaseConfig
- * @property {S} type - The specific cache type included in the CacheConfig.
- */
-export type CacheConfig<S extends CacheType> = CacheBaseConfig & {
-    type: S;
-};

package/dist/src/Cache/types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=types.js.map

package/dist/src/Cache/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/Cache/types.ts"],"names":[],"mappings":""}

package/dist/src/Config/Configuration.d.ts

@@ -1,123 +0,0 @@
-/**
- * Represents the schema for the configuration object.
- * @typedef {Object} ConfigurationSchema
- * @property {Object} [name] - The name of the configuration property.
- * @property {boolean} [name.isLocal] - Indicates if the property is for local use.
- * @property {boolean} [name.isRemote] - Indicates if the property is for remote use.
- * @property {boolean} [name.required] - Indicates if the property is required.
- * @property {string} [name.cachingPolicy] - The caching policy for the property.
- * @property {string} [name.nameOverride] - The optional name override if the key differs
- */
-export type ConfigurationSchema = {
-    [name: string]: {
-        isLocal?: boolean;
-        isRemote?: boolean;
-        isSecure?: boolean;
-        required?: boolean;
-        noPrefix?: boolean;
-        cachingPolicy?: string;
-        nameOverride?: string;
-    };
-};
-/**
- * Extracts the properties from a given type that have the `isRemote` property set to `true`.
- * @param {Type} - The type to extract properties from.
- * @returns An object type with the extracted properties.
- */
-type ExtractRemote<Type> = {
-    [Property in keyof Type]-?: Type[Property] extends {
-        isRemote: true;
-    } ? Property : null;
-};
-/**
- * Extracts the properties from a given type that have the `isLocal` property set to `true`.
- * @typeparam Type - The type to extract properties from.
- * @returns An object type with the extracted properties as keys and their corresponding types.
- */
-type ExtractLocal<Type> = {
-    [Property in keyof Type]-?: Type[Property] extends {
-        isLocal: true;
-    } ? Property : null;
-};
-/**
- * Creates a new type by omitting keys from type T whose values are of type U.
- * @param {T} - The original type
- * @param {U} - The type to omit from T
- * @returns A new type with the omitted keys
- */
-type OmitKeysByValueType<T, U> = {
-    [P in keyof T]: T[P] extends U ? never : P;
-}[keyof T];
-/**
- * Omit properties from an object type by their value type.
- * @template T - The object type to omit properties from.
- * @template V - The value type of properties to omit.
- * @typedef OmitByValueType
- * @property {T} T - The object type to omit properties from.
- * @property {V} V - The value type of properties to omit.
- * @returns {OmitKeysByValueType<T, V>} - The resulting object type after omitting properties.
- */
-type OmitByValueType<T, V> = T extends infer _ ? {
-    [key in OmitKeysByValueType<T, V>]: T[key];
-} : never;
-/**
- * Represents a configuration object with a specified schema and remote prefix.
- * @template T - The type of the configuration schema.
- */
-export default class Configuration<T extends ConfigurationSchema> {
-    /**
-     * The schema for the private readonly property.
-     * @type {T}
-     */
-    private readonly schema;
-    /**
-     * The prefix used for remote resources.
-     * @type {string}
-     */
-    private readonly remotePrefix;
-    /**
-     * Indicates if config is local and should attempt to override
-     * remote values from local.
-     * @type {string}
-     */
-    private static readonly isLocal;
-    /**
-     * Constructs a new instance of the class.
-     * @param {T} schema - The schema object.
-     * @param {string} remotePrefix - The remote prefix string.
-     * @returns None
-     */
-    constructor(schema: T, remotePrefix: string);
-    /**
-     * Retrieves the value of a property from the environment variables or cache.
-     * @param {keyof OmitByValueType<ExtractLocal<T>, null>} propName - The name of the property to retrieve.
-     * @returns The value of the property.
-     */
-    get(propName: keyof OmitByValueType<ExtractLocal<T>, null>): any;
-    /**
-     * Asynchronously retrieves the value of a property from the remote environment.
-     * @param {keyof OmitByValueType<ExtractRemote<T>, null>} propName - The name of the property to retrieve.
-     * @returns {Promise<any>} - A promise that resolves to the value of the property.
-     */
-    asyncGet(propName: keyof OmitByValueType<ExtractRemote<T>, null>): Promise<any>;
-    /**
-     * Retrieves the cached value associated with the given key from the cache store.
-     * @param {string} valueKey - The key of the value to retrieve from the cache.
-     * @returns The cached value associated with the given key, or undefined if the key does not exist in the cache.
-     */
-    private getCachedValue;
-    /**
-     * Caches a value with the specified key and expiration policy.
-     * @param {string} valueKey - The key to associate with the cached value.
-     * @param {any} value - The value to be cached.
-     * @param {string} [policy='1d'] - The expiration policy for the cached value. Defaults to '1d' (1 day).
-     * @returns None
-     */
-    private cacheValue;
-    /**
-     * Resets the cache by creating a new instance of the MemCache class and assigning it to the cacheStore variable.
-     * @returns None
-     */
-    private resetCache;
-}
-export {};

package/dist/src/Config/Configuration.js

@@ -1,109 +0,0 @@
-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 MemCache from 'node-cache';
-import DurationParser from 'parse-duration';
-import EnvironmentVar, { EnvironmentType } from './EnvironmentVar.js';
-// Hold cached values at nodeVM level
-// eslint-disable-next-line no-var
-/**
- * Creates a new instance of a memory cache store.
- * @returns {MemCache} A new instance of a memory cache store.
- */
-let cacheStore = new MemCache();
-/**
- * Represents a configuration object with a specified schema and remote prefix.
- * @template T - The type of the configuration schema.
- */
-class Configuration {
-    /**
-     * Constructs a new instance of the class.
-     * @param {T} schema - The schema object.
-     * @param {string} remotePrefix - The remote prefix string.
-     * @returns None
-     */
-    constructor(schema, remotePrefix) {
-        this.schema = schema;
-        this.remotePrefix = remotePrefix;
-    }
-    /**
-     * Retrieves the value of a property from the environment variables or cache.
-     * @param {keyof OmitByValueType<ExtractLocal<T>, null>} propName - The name of the property to retrieve.
-     * @returns The value of the property.
-     */
-    get(propName) {
-        const propString = propName;
-        const propSchema = this.schema[propString];
-        let v = this.getCachedValue(propString);
-        v =
-            v ||
-                new EnvironmentVar(propSchema.nameOverride || propString, EnvironmentType.Local, !propSchema.required, !propSchema.noPrefix ? this.remotePrefix : '').syncResolve();
-        this.cacheValue(propString, v, propSchema.cachingPolicy);
-        return v;
-    }
-    /**
-     * Asynchronously retrieves the value of a property from the remote environment.
-     * @param {keyof OmitByValueType<ExtractRemote<T>, null>} propName - The name of the property to retrieve.
-     * @returns {Promise<any>} - A promise that resolves to the value of the property.
-     */
-    asyncGet(propName) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const propString = propName;
-            const propSchema = this.schema[propString];
-            // check cache
-            let v = this.getCachedValue(propString);
-            if (v !== undefined)
-                return v;
-            // check for local override
-            if (Configuration.isLocal && process.env[propString] !== undefined) {
-                console.log(`Overriding remote variable ${propString} with local value!`);
-                const v = process.env[propString];
-                this.cacheValue(propString, v, propSchema.cachingPolicy);
-                return v;
-            }
-            // remote
-            v = yield new EnvironmentVar(propSchema.nameOverride || propString, propSchema.isSecure ? EnvironmentType.SecureRemote : EnvironmentType.PlainRemote, !propSchema.required, !propSchema.noPrefix ? this.remotePrefix : '').resolve();
-            this.cacheValue(propString, v, propSchema.cachingPolicy);
-            return v;
-        });
-    }
-    /**
-     * Retrieves the cached value associated with the given key from the cache store.
-     * @param {string} valueKey - The key of the value to retrieve from the cache.
-     * @returns The cached value associated with the given key, or undefined if the key does not exist in the cache.
-     */
-    getCachedValue(valueKey) {
-        return cacheStore.get(valueKey);
-    }
-    /**
-     * Caches a value with the specified key and expiration policy.
-     * @param {string} valueKey - The key to associate with the cached value.
-     * @param {any} value - The value to be cached.
-     * @param {string} [policy='1d'] - The expiration policy for the cached value. Defaults to '1d' (1 day).
-     * @returns None
-     */
-    cacheValue(valueKey, value, policy = '1d') {
-        cacheStore.set(valueKey, value, DurationParser(policy, 's') || '');
-    }
-    /**
-     * Resets the cache by creating a new instance of the MemCache class and assigning it to the cacheStore variable.
-     * @returns None
-     */
-    resetCache() {
-        cacheStore = new MemCache();
-    }
-}
-/**
- * Indicates if config is local and should attempt to override
- * remote values from local.
- * @type {string}
- */
-Configuration.isLocal = process.env.NODE_ENV == 'local';
-export default Configuration;
-//# sourceMappingURL=Configuration.js.map

package/dist/src/Config/Configuration.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Configuration.js","sourceRoot":"","sources":["../../../src/Config/Configuration.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,cAAc,MAAM,gBAAgB,CAAA;AAE3C,OAAO,cAAc,EAAE,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAErE,qCAAqC;AACrC,kCAAkC;AAClC;;;GAGG;AACH,IAAI,UAAU,GAAG,IAAI,QAAQ,EAAE,CAAA;AA6E/B;;;GAGG;AACH,MAAqB,aAAa;IAkBhC;;;;;OAKG;IACH,YAAY,MAAS,EAAE,YAAoB;QACzC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;IAClC,CAAC;IAED;;;;OAIG;IACI,GAAG,CAAC,QAAsD;QAC/D,MAAM,UAAU,GAAG,QAAkB,CAAA;QACrC,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;QAC1C,IAAI,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAA;QACvC,CAAC;YACC,CAAC;gBACD,IAAI,cAAc,CAChB,UAAU,CAAC,YAAY,IAAI,UAAU,EACrC,eAAe,CAAC,KAAK,EACrB,CAAC,UAAU,CAAC,QAAQ,EACpB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAC9C,CAAC,WAAW,EAAE,CAAA;QACjB,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC,CAAA;QACxD,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;;OAIG;IACU,QAAQ,CAAC,QAAuD;;YAC3E,MAAM,UAAU,GAAG,QAAkB,CAAA;YACrC,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;YAC1C,cAAc;YACd,IAAI,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAA;YACvC,IAAI,CAAC,KAAK,SAAS;gBAAE,OAAO,CAAC,CAAA;YAC7B,2BAA2B;YAC3B,IAAI,aAAa,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,SAAS,EAAE,CAAC;gBACnE,OAAO,CAAC,GAAG,CAAC,8BAA8B,UAAU,oBAAoB,CAAC,CAAA;gBACzE,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;gBACjC,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC,CAAA;gBACxD,OAAO,CAAC,CAAA;YACV,CAAC;YACD,SAAS;YACT,CAAC,GAAG,MAAM,IAAI,cAAc,CAC1B,UAAU,CAAC,YAAY,IAAI,UAAU,EACrC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,CAAC,eAAe,CAAC,WAAW,EAChF,CAAC,UAAU,CAAC,QAAQ,EACpB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAC9C,CAAC,OAAO,EAAE,CAAA;YACX,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC,CAAA;YACxD,OAAO,CAAC,CAAA;QACV,CAAC;KAAA;IAED;;;;OAIG;IACK,cAAc,CAAC,QAAgB;QACrC,OAAO,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;IACjC,CAAC;IAED;;;;;;OAMG;IACK,UAAU,CAAC,QAAgB,EAAE,KAAU,EAAE,SAAiB,IAAI;QACpE,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,cAAc,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAA;IACpE,CAAC;IAED;;;OAGG;IACK,UAAU;QAChB,UAAU,GAAG,IAAI,QAAQ,EAAE,CAAA;IAC7B,CAAC;;AA9FD;;;;GAIG;AACqB,qBAAO,GAAY,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,OAAO,CAAA;eAhBvD,aAAa"}