@ikonintegration/ikapi 4.0.1 → 5.0.0

package/dist/src/Cache/Redis.js

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

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

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

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

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

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

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

@@ -0,0 +1,123 @@
+/**
+ * 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

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

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

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

@@ -0,0 +1,74 @@
+/**
+ * An enumeration representing different types of environments.
+ * @enum {number}
+ * @readonly
+ * @property {number} PlainRemote - Represents a plain remote environment.
+ * @property {number} SecureRemote - Represents a secure remote environment.
+ * @property {number} Local - Represents a local environment.
+ */
+export declare enum EnvironmentType {
+    PlainRemote = 0,
+    SecureRemote = 1,
+    Local = 2
+}
+/**
+ * Represents an environment variable with methods to resolve its value based on the environment type.
+ * @template T - The type of the environment variable value.
+ */
+export default class EnvironmentVar<T> {
+    /**
+     * The name of the parameter.
+     */
+    private readonly paramName;
+    /**
+     * The type of environment.
+     * @readonly
+     */
+    private readonly type;
+    /**
+     * A boolean flag indicating whether the field is optional or not.
+     */
+    private readonly optional;
+    /**
+     * The prefix used for parameters in the class.
+     * @type {string}
+     */
+    private readonly paramPrefix;
+    /**
+     * Constructs a new instance of the EnvironmentVar class.
+     * @param {string} paramName - The name of the environment variable.
+     * @param {EnvironmentType} type - The type of the environment.
+     * @param {boolean} [optional] - Indicates whether the environment variable is optional.
+     * @param {string} [paramPrefix] - The prefix to be added to the environment variable name.
+     */
+    constructor(paramName: string, type: EnvironmentType, optional: boolean | undefined, paramPrefix: string);
+    /**
+     * Resolves the value of the environment variable synchronously.
+     * @returns {T} - The resolved value of the environment variable.
+     * @throws {Error} - If the environment type is not 'Local'.
+     */
+    syncResolve(): T;
+    /**
+     * Resolves the value based on the environment type.
+     * @returns {Promise<any>} - The resolved value.
+     */
+    resolve(): Promise<T | undefined>;
+    /**
+     * Retrieves the value of a local environment variable.
+     * @returns {T} - The value of the local environment variable.
+     * @throws {Error} - If the local environment variable is not defined and is not optional.
+     */
+    private getLocalValue;
+    /**
+     * Retrieves the plain value of a remote environment parameter.
+     * @returns {Promise<T>} - A promise that resolves to the plain value of the parameter.
+     * @throws {Error} - If the parameter cannot be retrieved and is not optional.
+     */
+    private getPlainValue;
+    /**
+     * Retrieves a secure value from the secrets manager.
+     * @returns {Promise<T>} - A promise that resolves to the secure value.
+     * @throws {Error} - Throws an error if the secure value cannot be retrieved and is not optional.
+     */
+    private getSecureValue;
+}

package/dist/src/Config/EnvironmentVar.js

@@ -0,0 +1,138 @@
+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 { SecretsManagerClient, GetSecretValueCommand } from '@aws-sdk/client-secrets-manager';
+import { SSMClient, GetParameterCommand } from '@aws-sdk/client-ssm';
+// Explicity setting VM level variables in order to persist
+// client across different important and instances.
+// eslint-disable-next-line no-var
+/**
+ * Variables to hold instances of SSMClient and SecretsManagerClient, initialized as null.
+ * @type {SSMClient | null} ssmClient - Instance of SSMClient or null if not initialized.
+ * @type {SecretsManagerClient | null} secretsClient - Instance of SecretsManagerClient or null if not initialized.
+ */
+let ssmClient = null, secretsClient = null;
+/**
+ * An enumeration representing different types of environments.
+ * @enum {number}
+ * @readonly
+ * @property {number} PlainRemote - Represents a plain remote environment.
+ * @property {number} SecureRemote - Represents a secure remote environment.
+ * @property {number} Local - Represents a local environment.
+ */
+export var EnvironmentType;
+(function (EnvironmentType) {
+    EnvironmentType[EnvironmentType["PlainRemote"] = 0] = "PlainRemote";
+    EnvironmentType[EnvironmentType["SecureRemote"] = 1] = "SecureRemote";
+    EnvironmentType[EnvironmentType["Local"] = 2] = "Local";
+})(EnvironmentType || (EnvironmentType = {}));
+/**
+ * Represents an environment variable with methods to resolve its value based on the environment type.
+ * @template T - The type of the environment variable value.
+ */
+export default class EnvironmentVar {
+    /**
+     * Constructs a new instance of the EnvironmentVar class.
+     * @param {string} paramName - The name of the environment variable.
+     * @param {EnvironmentType} type - The type of the environment.
+     * @param {boolean} [optional] - Indicates whether the environment variable is optional.
+     * @param {string} [paramPrefix] - The prefix to be added to the environment variable name.
+     */
+    constructor(paramName, type, optional = true, paramPrefix) {
+        this.paramName = paramName;
+        this.type = type;
+        this.optional = !!optional;
+        this.paramPrefix = paramPrefix;
+    }
+    /**
+     * Resolves the value of the environment variable synchronously.
+     * @returns {T} - The resolved value of the environment variable.
+     * @throws {Error} - If the environment type is not 'Local'.
+     */
+    syncResolve() {
+        if (this.type == EnvironmentType.Local)
+            return this.getLocalValue();
+        else {
+            throw new Error("EnvironmentVar syncResolve method can only be called for environments of type 'Local'");
+        }
+    }
+    /**
+     * Resolves the value based on the environment type.
+     * @returns {Promise<any>} - The resolved value.
+     */
+    resolve() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.type == EnvironmentType.Local)
+                return this.getLocalValue();
+            else if (this.type == EnvironmentType.SecureRemote)
+                return this.getSecureValue();
+            else
+                return this.getPlainValue();
+        });
+    }
+    /**
+     * Retrieves the value of a local environment variable.
+     * @returns {T} - The value of the local environment variable.
+     * @throws {Error} - If the local environment variable is not defined and is not optional.
+     */
+    getLocalValue() {
+        const value = process.env[this.paramName];
+        if (!value && !this.optional) {
+            throw new Error(`Local environment ${this.paramName} is not defined, please reconfigure the application and redeploy!`);
+        }
+        return value;
+    }
+    /**
+     * Retrieves the plain value of a remote environment parameter.
+     * @returns {Promise<T>} - A promise that resolves to the plain value of the parameter.
+     * @throws {Error} - If the parameter cannot be retrieved and is not optional.
+     */
+    getPlainValue() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!ssmClient)
+                ssmClient = new SSMClient();
+            const pName = `${this.paramPrefix}${this.paramName}`;
+            try {
+                const data = yield ssmClient.send(new GetParameterCommand({ Name: pName }));
+                if (data.Parameter && data.Parameter.Value)
+                    return data.Parameter.Value;
+            }
+            catch (error) {
+                console.error(error);
+            }
+            if (!this.optional) {
+                throw new Error(`Unable to retrieve plain remote env value: ${pName}`);
+            }
+        });
+    }
+    /**
+     * Retrieves a secure value from the secrets manager.
+     * @returns {Promise<T>} - A promise that resolves to the secure value.
+     * @throws {Error} - Throws an error if the secure value cannot be retrieved and is not optional.
+     */
+    getSecureValue() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!secretsClient)
+                secretsClient = new SecretsManagerClient();
+            const pName = `${this.paramPrefix}${this.paramName}`;
+            try {
+                const data = yield secretsClient.send(new GetSecretValueCommand({ SecretId: pName }));
+                if (data.SecretString)
+                    return data.SecretString;
+            }
+            catch (error) {
+                console.error(error);
+            }
+            if (!this.optional) {
+                throw new Error(`Unable to retrieve secure remote env: ${pName}`);
+            }
+        });
+    }
+}
+//# sourceMappingURL=EnvironmentVar.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"EnvironmentVar.js","sourceRoot":"","sources":["../../../src/Config/EnvironmentVar.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAA;AAC7F,OAAO,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAEpE,2DAA2D;AAC3D,mDAAmD;AACnD,kCAAkC;AAClC;;;;GAIG;AACH,IAAI,SAAS,GAAqB,IAAI,EACpC,aAAa,GAAgC,IAAI,CAAA;AAEnD;;;;;;;GAOG;AACH,MAAM,CAAN,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,mEAAW,CAAA;IACX,qEAAY,CAAA;IACZ,uDAAK,CAAA;AACP,CAAC,EAJW,eAAe,KAAf,eAAe,QAI1B;AACD;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,cAAc;IAoBjC;;;;;;OAMG;IACH,YAAY,SAAiB,EAAE,IAAqB,EAAE,QAAQ,GAAG,IAAI,EAAE,WAAmB;QACxF,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAA;QAC1B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;IAChC,CAAC;IAED;;;;OAIG;IACI,WAAW;QAChB,IAAI,IAAI,CAAC,IAAI,IAAI,eAAe,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC,aAAa,EAAE,CAAA;aAC9D,CAAC;YACJ,MAAM,IAAI,KAAK,CACb,uFAAuF,CACxF,CAAA;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACU,OAAO;;YAClB,IAAI,IAAI,CAAC,IAAI,IAAI,eAAe,CAAC,KAAK;gBAAE,OAAO,IAAI,CAAC,aAAa,EAAE,CAAA;iBAC9D,IAAI,IAAI,CAAC,IAAI,IAAI,eAAe,CAAC,YAAY;gBAAE,OAAO,IAAI,CAAC,cAAc,EAAE,CAAA;;gBAC3E,OAAO,IAAI,CAAC,aAAa,EAAE,CAAA;QAClC,CAAC;KAAA;IAED;;;;OAIG;IACK,aAAa;QACnB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACzC,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CACb,qBAAqB,IAAI,CAAC,SAAS,mEAAmE,CACvG,CAAA;QACH,CAAC;QACD,OAAO,KAAU,CAAA;IACnB,CAAC;IAED;;;;OAIG;IACW,aAAa;;YACzB,IAAI,CAAC,SAAS;gBAAE,SAAS,GAAG,IAAI,SAAS,EAAE,CAAA;YAC3C,MAAM,KAAK,GAAG,GAAG,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;YACpD,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,IAAI,mBAAmB,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;gBAC3E,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK;oBAAE,OAAO,IAAI,CAAC,SAAS,CAAC,KAAU,CAAA;YAC9E,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;YACtB,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACnB,MAAM,IAAI,KAAK,CAAC,8CAA8C,KAAK,EAAE,CAAC,CAAA;YACxE,CAAC;QACH,CAAC;KAAA;IAED;;;;OAIG;IACW,cAAc;;YAC1B,IAAI,CAAC,aAAa;gBAAE,aAAa,GAAG,IAAI,oBAAoB,EAAE,CAAA;YAC9D,MAAM,KAAK,GAAG,GAAG,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;YACpD,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,IAAI,CAAC,IAAI,qBAAqB,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;gBACrF,IAAI,IAAI,CAAC,YAAY;oBAAE,OAAO,IAAI,CAAC,YAAiB,CAAA;YACtD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;YACtB,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACnB,MAAM,IAAI,KAAK,CAAC,yCAAyC,KAAK,EAAE,CAAC,CAAA;YACnE,CAAC;QACH,CAAC;KAAA;CACF"}

package/dist/src/Crypto/Crypto.d.ts

@@ -0,0 +1,45 @@
+import { EncryptionAlgorithmSpec } from '@aws-sdk/client-kms';
+/**
+ * Represents a Crypto class that provides encryption and decryption functionality using AWS KMS.
+ */
+export default class Crypto {
+    /**
+     * The KMSClient instance used for making requests to the Key Management Service (KMS).
+     */
+    private readonly client;
+    /**
+     * The AWS region of the object. This property is readonly and cannot be modified once set.
+     */
+    private readonly region;
+    /**
+     * The unique identifier for the KMS.
+     * @readonly
+     * @type {string}
+     */
+    private readonly keyId;
+    /**
+     * Specifies the encryption algorithm used for encryption.
+     */
+    private readonly encryptionAlgorithm;
+    /**
+     * Constructs a new instance of a KeyManager with the provided region, keyId, and optional encryption algorithm.
+     * @param {string} region - The region where the key is stored.
+     * @param {string} keyId - The ID of the key.
+     * @param {EncryptionAlgorithmSpec} [optEncryptionAlgorithm='RSAES_OAEP_SHA_256'] - The encryption algorithm to use (default is RSAES_OAEP_SHA_256).
+     * @returns None
+     */
+    constructor(region: string, keyId: string, optEncryptionAlgorithm?: EncryptionAlgorithmSpec);
+    /**
+     * Encrypts the given data using RSAES_OAEP_SHA_256 encryption algorithm.
+     * @param {string | any} data - The data to be encrypted.
+     * @returns {Promise<string | null>} - A promise that resolves to the encrypted data as a hexadecimal string.
+     */
+    encryptData(data: string | any): Promise<string | null>;
+    /**
+     * Decrypts the given data using the RSAES_OAEP_SHA_256 encryption algorithm.
+     * @param {string} data - The encrypted data to decrypt.
+     * @returns {Promise<string | null>} - A promise that resolves to the decrypted plaintext string.
+     * If decryption fails, null is returned.
+     */
+    decryptData(data: string): Promise<string | null>;
+}