skyeye-svc-common-utils 2.0.0-dev0.20 → 2.0.0-dev0.22

package/dist/lib/fetch/sendRequestWithTimeout.js

@@ -0,0 +1,53 @@
+"use strict";
+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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendRequestWithTimeout = void 0;
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const abort_controller_1 = require("@azure/abort-controller");
+const appConst_1 = require("../../utils/appConst");
+/**
+ * @description to store the current processing request, it should only be called
+ * by function sendRequestWithTimeout
+ */
+const abortedSet = new Set();
+/**
+ * @description send a request which will automatically abort within a given time
+ * if the request is not response yet
+ * @param {string} url - url of request endpoint
+ * @param {any} options - fetch option
+ * @param {number} abortWithinMs - automatically abort after given millisecond
+ * @returns {any} response
+ */
+function sendRequestWithTimeout(url, options, abortWithinMs = appConst_1.thirdPartyRegulation.requestLimitationMsec) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const controller = new abort_controller_1.AbortController();
+        const timeout = setTimeout(() => {
+            abortedSet.add(url);
+            controller.abort();
+        }, abortWithinMs);
+        try {
+            const response = yield (0, node_fetch_1.default)(url, Object.assign({ signal: controller.signal }, options));
+            clearTimeout(timeout);
+            return response;
+        }
+        catch (err) {
+            if (abortedSet.has(url) && err.name === 'AbortError') {
+                abortedSet.delete(url);
+            }
+            throw err;
+        }
+    });
+}
+exports.sendRequestWithTimeout = sendRequestWithTimeout;
+//# sourceMappingURL=sendRequestWithTimeout.js.map

package/dist/lib/fetch/sendRequestWithTimeout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sendRequestWithTimeout.js","sourceRoot":"","sources":["../../../src/lib/fetch/sendRequestWithTimeout.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,4DAA+B;AAC/B,8DAA0D;AAC1D,mDAA4D;AAG5D;;;GAGG;AACH,MAAM,UAAU,GAAgB,IAAI,GAAG,EAAU,CAAC;AAElD;;;;;;;GAOG;AACH,SAAsB,sBAAsB,CACxC,GAAW,EACX,OAAY,EACZ,gBAAwB,+BAAoB,CAAC,qBAAqB;;QAElE,MAAM,UAAU,GAAG,IAAI,kCAAe,EAAE,CAAC;QACzC,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;YAC5B,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACpB,UAAU,CAAC,KAAK,EAAE,CAAC;QACvB,CAAC,EAAE,aAAa,CAAC,CAAC;QAClB,IAAI,CAAC;YACD,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAK,EAAC,GAAG,kBAAI,MAAM,EAAE,UAAU,CAAC,MAAM,IAAK,OAAO,EAAE,CAAC;YAC5E,YAAY,CAAC,OAAO,CAAC,CAAC;YACtB,OAAO,QAAQ,CAAC;QACpB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,IAAK,GAAa,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gBAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAAC,CAAC;YAC5F,MAAM,GAAG,CAAC;QACd,CAAC;IACL,CAAC;CAAA;AAlBD,wDAkBC"}

package/dist/lib/httpClient.d.ts

@@ -0,0 +1,4 @@
+import { Response } from 'node-fetch';
+import { UserInfo } from '../interfaces';
+export declare function httpRequest(method: string, url: string, data?: any, headers?: any): Promise<Response>;
+export declare function sendInternalHttpRequest(userInfo: UserInfo, client: string, endpoint: string, data?: any, method?: string, select?: string[]): Promise<any>;

package/dist/lib/httpClient.js

@@ -0,0 +1,55 @@
+"use strict";
+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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendInternalHttpRequest = exports.httpRequest = void 0;
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const commonUtils_1 = require("../utils/commonUtils");
+const commonUtils_2 = require("../utils/commonUtils");
+const appConst_1 = require("../utils/appConst");
+const logger_1 = require("../utils/logger/logger");
+function httpRequest(method, url, data = null, headers = (0, appConst_1.jsonContentTypeHeaders)()) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const init = {
+            method,
+            headers,
+            body: data === null ? undefined : JSON.stringify(data)
+        };
+        return (0, node_fetch_1.default)(url, init);
+    });
+}
+exports.httpRequest = httpRequest;
+function sendInternalHttpRequest(userInfo, client, endpoint, data = null, method, select) {
+    return __awaiter(this, void 0, void 0, function* () {
+        method = method !== null && method !== void 0 ? method : appConst_1.commonAppConst.httpMethod.POST;
+        const internalClient = yield (0, commonUtils_1.getInternalClient)(client);
+        const url = internalClient + endpoint;
+        let headers = (0, appConst_1.jsonContentTypeHeaders)();
+        if (userInfo) {
+            userInfo = yield (0, commonUtils_1.userInfoSimplifier)(userInfo, select);
+            let token = `${appConst_1.commonAppConst.httpHeader.BEARER} ${yield (0, commonUtils_2.generateJWT)(userInfo)}`;
+            headers[appConst_1.commonAppConst.httpHeader.AUTHORIZATION] = token;
+        }
+        let response;
+        try {
+            response = yield httpRequest(method, url, data, headers);
+            return response.json();
+        }
+        catch (err) {
+            logger_1.logger.error(`Error while sending internal http request, receiving response: ${response}`);
+            throw new Error(`${err}`);
+        }
+    });
+}
+exports.sendInternalHttpRequest = sendInternalHttpRequest;
+//# sourceMappingURL=httpClient.js.map

package/dist/lib/httpClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpClient.js","sourceRoot":"","sources":["../../src/lib/httpClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,4DAA0D;AAE1D,sDAA6E;AAC7E,sDAAmD;AACnD,gDAA0E;AAC1E,mDAAgD;AAEhD,SAAsB,WAAW,CAAC,MAAc,EAAE,GAAY,EAAG,OAAY,IAAI,EAAE,UAAgB,IAAA,iCAAsB,GAAE;;QACvH,MAAM,IAAI,GAAgB;YACtB,MAAM;YACN,OAAO;YACP,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SACzD,CAAA;QACD,OAAO,IAAA,oBAAK,EAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC5B,CAAC;CAAA;AAPD,kCAOC;AAED,SAAsB,uBAAuB,CAAC,QAAiB,EAAE,MAAc,EAAE,QAAgB,EAAE,OAAY,IAAI,EAAE,MAAe,EAAE,MAAgB;;QAClJ,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,yBAAc,CAAC,UAAU,CAAC,IAAI,CAAC;QAClD,MAAM,cAAc,GAAG,MAAM,IAAA,+BAAiB,EAAC,MAAM,CAAC,CAAA;QACtD,MAAM,GAAG,GAAG,cAAc,GAAG,QAAQ,CAAC;QACtC,IAAI,OAAO,GAAO,IAAA,iCAAsB,GAAE,CAAC;QAC3C,IAAG,QAAQ,EAAC,CAAC;YACT,QAAQ,GAAG,MAAM,IAAA,gCAAkB,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;YACrD,IAAI,KAAK,GAAW,GAAG,yBAAc,CAAC,UAAU,CAAC,MAAM,IAAI,MAAM,IAAA,yBAAW,EAAC,QAAQ,CAAC,EAAE,CAAC;YACzF,OAAO,CAAC,yBAAc,CAAC,UAAU,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAC7D,CAAC;QAED,IAAI,QAAkB,CAAC;QACvB,IAAI,CAAC;YACD,QAAQ,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;YACzD,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC3B,CAAC;QACD,OAAO,GAAG,EAAE,CAAC;YACT,eAAM,CAAC,KAAK,CAAC,kEAAkE,QAAQ,EAAE,CAAC,CAAC;YAC3F,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC;QAC9B,CAAC;IACL,CAAC;CAAA;AApBD,0DAoBC"}

package/dist/lib/index.d.ts

@@ -0,0 +1,3 @@
+export * from './azure';
+export * from './fetch';
+export * from './teams';

package/dist/lib/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./azure"), exports);
+__exportStar(require("./fetch"), exports);
+__exportStar(require("./teams"), exports);
+//# sourceMappingURL=index.js.map

package/dist/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,0CAAwB;AACxB,0CAAwB"}

package/dist/lib/redisClient.d.ts

@@ -0,0 +1,45 @@
+import Redis, { RedisOptions } from 'ioredis';
+/**
+ * A wrapper class for Redis client that adds error handling and logging
+ */
+export declare class RedisClient extends Redis {
+    /**
+     * @constructor
+     * @param {RedisOptions} options - config options for redis connection
+     */
+    constructor(options: RedisOptions);
+    /**
+     * @override It returns the value of the key from the Redis database.
+     * @param {string} key - The key to get the value of.
+     * @returns {Promise<string | null>} Value of the key.
+     */
+    get(key: string): Promise<string | null>;
+    /**
+     * It sets a key-value pair in the Redis cache.
+     * @param {string} key - The key to store the value in.
+     * @param {any} value - The value for the key
+     * @param {number} time - Time to live, in seconds
+     * @returns {Promise<boolean>} A boolean to tell whether it is able to set a key in redis.
+     */
+    put(key: string, value: any, time?: number): Promise<boolean>;
+    /**
+     * It locks a key in redis with a default TTL of 5 minutes, if possible.
+     * @param {string} key - The key to lock.
+     * @param {number} time - Time to live, in seconds
+     * @returns {Promise<boolean>} A boolean to tell whether it is able to lock the key.
+     */
+    lock(key: string, time?: number): Promise<boolean>;
+    /**
+     * If the key is locked (i.e. key exists in redis), return true, otherwise return false.
+     * @param {string} key - the key to check
+     * @returns {Promise<boolean>} A boolean to tell whether a key is locked in redis.
+     */
+    isLocked(key: string): Promise<boolean>;
+    /**
+     * It unlocks a key in redis.
+     * @param {string} key - The key to unlock.
+     */
+    unlock(key: string): Promise<void>;
+}
+declare function createRedisClient(): Promise<RedisClient | null>;
+export { createRedisClient };

package/dist/lib/redisClient.js

@@ -0,0 +1,153 @@
+"use strict";
+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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRedisClient = exports.RedisClient = void 0;
+const ioredis_1 = __importDefault(require("ioredis"));
+const logger_1 = require("../utils/logger/logger");
+const appConst_1 = require("../utils/appConst");
+const appConfig_1 = require("../utils/appConfig");
+const appConfigKeyRetriever_1 = require("../utils/commonUtils/appConfigKeyRetriever");
+/**
+ * A wrapper class for Redis client that adds error handling and logging
+ */
+class RedisClient extends ioredis_1.default {
+    /**
+     * @constructor
+     * @param {RedisOptions} options - config options for redis connection
+     */
+    constructor(options) {
+        super(options);
+        // emits immediately right after the connect event.
+        this.on("ready", () => {
+            logger_1.logger.info(`RedisClient connected, host: ${options.host}, port: ${options.port}`);
+        });
+        // emits when an error occurs while connecting.
+        this.on("error", (err) => {
+            logger_1.logger.error(`RedisClient connection error: ${err}`);
+        });
+    }
+    /**
+     * @override It returns the value of the key from the Redis database.
+     * @param {string} key - The key to get the value of.
+     * @returns {Promise<string | null>} Value of the key.
+     */
+    get(key) {
+        const _super = Object.create(null, {
+            get: { get: () => super.get }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            logger_1.logger.info("start RedisClient.get");
+            try {
+                return _super.get.call(this, key);
+            }
+            catch (err) {
+                logger_1.logger.warn(`RedisClient/get error: ${err}`);
+                return null;
+            }
+        });
+    }
+    /**
+     * It sets a key-value pair in the Redis cache.
+     * @param {string} key - The key to store the value in.
+     * @param {any} value - The value for the key
+     * @param {number} time - Time to live, in seconds
+     * @returns {Promise<boolean>} A boolean to tell whether it is able to set a key in redis.
+     */
+    put(key, value, time = appConst_1.commonAppConst.redis.TTLfor5min) {
+        const _super = Object.create(null, {
+            set: { get: () => super.set }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            logger_1.logger.info("start RedisClient.put");
+            try {
+                return Promise.resolve(!!(yield _super.set.call(this, key, value, appConst_1.commonAppConst.redis.expiryMode.inSeconds, time)));
+            }
+            catch (err) {
+                logger_1.logger.warn(`RedisClient/put error: ${err}`);
+                return Promise.resolve(false);
+            }
+        });
+    }
+    /**
+     * It locks a key in redis with a default TTL of 5 minutes, if possible.
+     * @param {string} key - The key to lock.
+     * @param {number} time - Time to live, in seconds
+     * @returns {Promise<boolean>} A boolean to tell whether it is able to lock the key.
+     */
+    lock(key, time = appConst_1.commonAppConst.redis.TTLfor5min) {
+        const _super = Object.create(null, {
+            set: { get: () => super.set }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            logger_1.logger.info("start RedisClient.lock");
+            try {
+                return Promise.resolve(!!(yield _super.set.call(this, key, null, appConst_1.commonAppConst.redis.expiryMode.inSeconds, time, appConst_1.commonAppConst.redis.setMode.setIfNotExist)));
+            }
+            catch (err) {
+                logger_1.logger.error(`RedisClient/lock error: ${err}`);
+                return Promise.resolve(false);
+            }
+        });
+    }
+    /**
+     * If the key is locked (i.e. key exists in redis), return true, otherwise return false.
+     * @param {string} key - the key to check
+     * @returns {Promise<boolean>} A boolean to tell whether a key is locked in redis.
+     */
+    isLocked(key) {
+        const _super = Object.create(null, {
+            exists: { get: () => super.exists }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            logger_1.logger.info("start RedisClient.isLocked");
+            try {
+                return !!(yield _super.exists.call(this, key));
+            }
+            catch (err) {
+                logger_1.logger.warn(`RedisClient/isLocked error: ${err}`);
+                return Promise.resolve(true);
+            }
+        });
+    }
+    /**
+     * It unlocks a key in redis.
+     * @param {string} key - The key to unlock.
+     */
+    unlock(key) {
+        const _super = Object.create(null, {
+            del: { get: () => super.del }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            logger_1.logger.info("start RedisClient.unlock");
+            try {
+                yield _super.del.call(this, key);
+            }
+            catch (err) {
+                logger_1.logger.error(`RedisClient/unlock error: ${err}`);
+            }
+        });
+    }
+}
+exports.RedisClient = RedisClient;
+function createRedisClient() {
+    return __awaiter(this, void 0, void 0, function* () {
+        let redisConnection = yield appConfigKeyRetriever_1.AppConfigKeyRetriever.getRedisConnection();
+        // Create the RedisOptions object
+        const options = Object.assign({}, JSON.parse(redisConnection));
+        // Create and return the RedisClient instance
+        return appConfig_1.commonAppConfig.RedisEnable ? new RedisClient(options) : null;
+    });
+}
+exports.createRedisClient = createRedisClient;
+//# sourceMappingURL=redisClient.js.map

package/dist/lib/redisClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redisClient.js","sourceRoot":"","sources":["../../src/lib/redisClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,sDAA8C;AAC9C,mDAAgD;AAChD,gDAAmD;AACnD,kDAAqD;AACrD,sFAAmF;AACnF;;GAEG;AACH,MAAa,WAAY,SAAQ,iBAAK;IAClC;;;OAGG;IACH,YAAY,OAAqB;QAC7B,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,mDAAmD;QACnD,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YAClB,eAAM,CAAC,IAAI,CAAC,gCAAgC,OAAO,CAAC,IAAI,WAAW,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QACvF,CAAC,CAAC,CAAC;QACH,+CAA+C;QAC/C,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACrB,eAAM,CAAC,KAAK,CAAC,iCAAiC,GAAG,EAAE,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACG,GAAG,CAAC,GAAW;;;;;YACjB,eAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;YACrC,IAAI,CAAC;gBACD,OAAO,OAAM,GAAG,YAAC,GAAG,EAAE;YAC1B,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACX,eAAM,CAAC,IAAI,CAAC,0BAA0B,GAAG,EAAE,CAAC,CAAC;gBAC7C,OAAO,IAAI,CAAC;YAChB,CAAC;QACL,CAAC;KAAA;IAED;;;;;;OAMG;IACG,GAAG,CACL,GAAW,EACX,KAAU,EACV,OAAe,yBAAc,CAAC,KAAK,CAAC,UAAU;;;;;YAE9C,eAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;YACrC,IAAI,CAAC;gBACD,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA,MAAM,OAAM,GAAG,YAAC,GAAG,EAAE,KAAK,EAAE,yBAAc,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,CAAC,CAAA,CAAC,CAAC;YAC3G,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACX,eAAM,CAAC,IAAI,CAAC,0BAA0B,GAAG,EAAE,CAAC,CAAC;gBAC7C,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAClC,CAAC;QACL,CAAC;KAAA;IAED;;;;;OAKG;IACG,IAAI,CACN,GAAW,EACX,OAAe,yBAAc,CAAC,KAAK,CAAC,UAAU;;;;;YAE9C,eAAM,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;YACtC,IAAI,CAAC;gBACD,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA,MAAM,OAAM,GAAG,YAAC,GAAG,EAAE,IAAI,EAAE,yBAAc,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,EAAE,yBAAc,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA,CAAC,CAAC;YACtJ,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACX,eAAM,CAAC,KAAK,CAAC,2BAA2B,GAAG,EAAE,CAAC,CAAC;gBAC/C,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAClC,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACG,QAAQ,CAAC,GAAW;;;;;YACtB,eAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;YAC1C,IAAI,CAAC;gBACD,OAAO,CAAC,CAAC,CAAA,MAAM,OAAM,MAAM,YAAC,GAAG,CAAC,CAAA,CAAC;YACrC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACX,eAAM,CAAC,IAAI,CAAC,+BAA+B,GAAG,EAAE,CAAC,CAAC;gBAClD,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACjC,CAAC;QACL,CAAC;KAAA;IAED;;;OAGG;IACG,MAAM,CAAC,GAAW;;;;;YACpB,eAAM,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;YACxC,IAAI,CAAC;gBACD,MAAM,OAAM,GAAG,YAAC,GAAG,CAAC,CAAC;YACzB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACX,eAAM,CAAC,KAAK,CAAC,6BAA6B,GAAG,EAAE,CAAC,CAAC;YACrD,CAAC;QACL,CAAC;KAAA;CACJ;AAnGD,kCAmGC;AAED,SAAe,iBAAiB;;QAC5B,IAAI,eAAe,GAAG,MAAM,6CAAqB,CAAC,kBAAkB,EAAE,CAAC;QACvE,iCAAiC;QACjC,MAAM,OAAO,qBACN,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CACjC,CAAC;QAEF,6CAA6C;QAC7C,OAAO,2BAAe,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACzE,CAAC;CAAA;AAGQ,8CAAiB"}

package/dist/lib/sendGridClient.d.ts

@@ -0,0 +1,27 @@
+import { MailDataRequired } from '@sendgrid/mail';
+/**
+ * A SendGrid client class
+ */
+declare class SendGridClient {
+    private mailService;
+    /**
+     * @constructor
+     * @param {string} [apiKey] - SendGrid API key (optional)
+     */
+    constructor();
+    /**
+     * Initializes the SendGrid client with the API key retrieved from Azure Key Vault.
+     */
+    private initialize;
+    /**
+     * It sends an email.
+     * @param {string} from - The email address of the sender.
+     * @param {string[]} to - string[] - an array of email addresses to send the email to
+     * @param {string} subject - The subject of the email
+     * @param {string} htmlBodyText - The HTML body of the email.
+     * @param {any} [options] - Extra settings for the email
+     */
+    send(from: string, to: string[], subject: string, htmlBodyText: string, options?: Partial<MailDataRequired>): Promise<void> | never;
+}
+export declare const sendGridClient: SendGridClient;
+export {};

package/dist/lib/sendGridClient.js

@@ -0,0 +1,62 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendGridClient = void 0;
+const mail_1 = require("@sendgrid/mail");
+const logger_1 = require("./../utils/logger/logger");
+const appConfigKeyRetriever_1 = require("./../utils/commonUtils/appConfigKeyRetriever");
+const appConfig_1 = require("./../utils/appConfig");
+/**
+ * A SendGrid client class
+ */
+class SendGridClient {
+    /**
+     * @constructor
+     * @param {string} [apiKey] - SendGrid API key (optional)
+     */
+    constructor() {
+        this.mailService = new mail_1.MailService();
+        this.initialize();
+    }
+    /**
+     * Initializes the SendGrid client with the API key retrieved from Azure Key Vault.
+     */
+    initialize() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const sendGridClientSecret = yield appConfigKeyRetriever_1.AppConfigKeyRetriever.getSendgridClientSecret();
+            this.mailService.setApiKey(sendGridClientSecret);
+        });
+    }
+    /**
+     * It sends an email.
+     * @param {string} from - The email address of the sender.
+     * @param {string[]} to - string[] - an array of email addresses to send the email to
+     * @param {string} subject - The subject of the email
+     * @param {string} htmlBodyText - The HTML body of the email.
+     * @param {any} [options] - Extra settings for the email
+     */
+    send(from, to, subject, htmlBodyText, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const msg = Object.assign({ from,
+                to,
+                subject, html: htmlBodyText }, options);
+            try {
+                yield this.mailService.send(msg);
+            }
+            catch (err) {
+                logger_1.logger.error(`SendGridClient/send with error, ${err}`);
+                throw err;
+            }
+        });
+    }
+}
+exports.sendGridClient = appConfig_1.commonAppConfig.SendgridClientSecretKey ? new SendGridClient() : null;
+//# sourceMappingURL=sendGridClient.js.map

package/dist/lib/sendGridClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sendGridClient.js","sourceRoot":"","sources":["../../src/lib/sendGridClient.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yCAA+D;AAC/D,qDAAkD;AAClD,wFAAqF;AACrF,oDAAuD;AAEvD;;GAEG;AACH,MAAM,cAAc;IAIhB;;;OAGG;IACH;QACI,IAAI,CAAC,WAAW,GAAG,IAAI,kBAAW,EAAE,CAAC;QACrC,IAAI,CAAC,UAAU,EAAE,CAAC;IACtB,CAAC;IAED;;OAEG;IACW,UAAU;;YACpB,MAAM,oBAAoB,GAAG,MAAM,6CAAqB,CAAC,uBAAuB,EAAE,CAAC;YACnF,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;QACrD,CAAC;KAAA;IAGD;;;;;;;OAOG;IACG,IAAI,CAAC,IAAY,EAAE,EAAY,EAAE,OAAe,EAAE,YAAoB,EAAE,OAAmC;;YAC7G,MAAM,GAAG,mBACL,IAAI;gBACJ,EAAE;gBACF,OAAO,EACP,IAAI,EAAE,YAAY,IACf,OAAO,CACb,CAAC;YAEF,IAAI,CAAC;gBACD,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACrC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACX,eAAM,CAAC,KAAK,CAAC,mCAAmC,GAAG,EAAE,CAAC,CAAC;gBACvD,MAAM,GAAG,CAAC;YACd,CAAC;QACL,CAAC;KAAA;CACJ;AAEY,QAAA,cAAc,GAAG,2BAAe,CAAC,uBAAuB,CAAC,CAAC,CAAC,IAAI,cAAc,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC"}

package/dist/lib/teams/broadcastLogMessage.d.ts

@@ -0,0 +1,8 @@
+import { LogLevel } from './logMessage';
+/**
+ * @description broadcast log message to specific Microsoft Teams channels
+ * @param {LogLevel} level - level of the log
+ * @param {string} message - log message
+ * @returns {void} the function is deposable, thus it won't return any of information
+ */
+export declare function broadcastLogMessage(level: LogLevel, message: string): Promise<void>;

package/dist/lib/teams/broadcastLogMessage.js

@@ -0,0 +1,81 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.broadcastLogMessage = void 0;
+const loadConfig_1 = require("../../utils/middleware/loadConfig");
+const fetch_1 = require("../fetch");
+/**
+ * @description broadcast log message to specific Microsoft Teams channels
+ * @param {LogLevel} level - level of the log
+ * @param {string} message - log message
+ * @returns {void} the function is deposable, thus it won't return any of information
+ */
+function broadcastLogMessage(level, message) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // we only broadcast two levels of log.
+        if (level !== 'error' && level !== 'warn') {
+            return;
+        }
+        /**
+         * When the keyVaultName is empty, loadConfig() should be called in order to fetch the value as possible
+         * since we are not using lazy-loading here. It would be better to transform into a lazy-loading mechanism.
+         */
+        if (loadConfig_1.appConfig === undefined) {
+            try {
+                yield (0, loadConfig_1.loadConfig)();
+            }
+            catch (err) {
+                throw err;
+            }
+        }
+        const time = new Date().toISOString();
+        const logMessage = {
+            level,
+            message,
+            time,
+            environment: loadConfig_1.appConfig.environment,
+            appName: loadConfig_1.appConfig.appName,
+            version: loadConfig_1.appConfig.version
+        };
+        const messageCard = (() => {
+            return {
+                '@type': 'MessageCard',
+                '@context': 'http://schema.org/extensions',
+                'summary': 'Teams broadcasting of Logs',
+                'sections': [{
+                        'activityTitle': `# ***Service Error Log - ${logMessage.level}***`,
+                        'facts': [
+                            { 'name': 'Time', 'value': logMessage.time },
+                            { 'name': 'Environment', 'value': logMessage.environment },
+                            { 'name': 'Service', 'value': logMessage.appName },
+                            { 'name': 'Version', 'value': logMessage.version },
+                            { 'name': 'Message', 'value': logMessage.message }
+                        ],
+                        'markdown': true
+                    }],
+                'potentialAction': [
+                    {
+                        '@type': 'OpenUri',
+                        'name': 'View Documentation',
+                        'targets': [{ 'os': 'default', 'uri': '' }]
+                    }
+                ]
+            };
+        })();
+        const url = level === 'error' ?
+            loadConfig_1.appConfig.telemetry.teamsChannelWebHook.errorChannel
+            :
+                loadConfig_1.appConfig.telemetry.teamsChannelWebHook.warnChannel;
+        yield (0, fetch_1.sendRequestWithTimeout)(url, { method: 'POST', body: JSON.stringify(messageCard) });
+    });
+}
+exports.broadcastLogMessage = broadcastLogMessage;
+//# sourceMappingURL=broadcastLogMessage.js.map

package/dist/lib/teams/broadcastLogMessage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"broadcastLogMessage.js","sourceRoot":"","sources":["../../../src/lib/teams/broadcastLogMessage.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,kEAA0E;AAC1E,oCAAkD;AAGlD;;;;;GAKG;AACH,SAAsB,mBAAmB,CAAC,KAAe,EAAE,OAAe;;QACtE,uCAAuC;QACvC,IAAI,KAAK,KAAK,OAAO,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;YAAC,OAAO;QAAC,CAAC;QAEtD;;;WAGG;QACH,IAAI,sBAAS,KAAK,SAAS,EAAE,CAAC;YAC1B,IAAI,CAAC;gBACD,MAAM,IAAA,uBAAU,GAAE,CAAC;YACvB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACX,MAAM,GAAG,CAAC;YACd,CAAC;QACL,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACtC,MAAM,UAAU,GAAe;YAC3B,KAAK;YACL,OAAO;YACP,IAAI;YACJ,WAAW,EAAE,sBAAS,CAAC,WAAW;YAClC,OAAO,EAAE,sBAAS,CAAC,OAAO;YAC1B,OAAO,EAAE,sBAAS,CAAC,OAAO;SAC7B,CAAC;QAEF,MAAM,WAAW,GAAW,CAAC,GAAW,EAAE;YACtC,OAAO;gBACH,OAAO,EAAE,aAAa;gBACtB,UAAU,EAAE,8BAA8B;gBAC1C,SAAS,EAAE,4BAA4B;gBACvC,UAAU,EAAE,CAAC;wBACT,eAAe,EAAE,4BAA4B,UAAU,CAAC,KAAK,KAAK;wBAClE,OAAO,EAAE;4BACL,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC,IAAI,EAAE;4BAC5C,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,UAAU,CAAC,WAAW,EAAE;4BAC1D,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE;4BAClD,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE;4BAClD,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE;yBACrD;wBACD,UAAU,EAAE,IAAI;qBACnB,CAAC;gBACF,iBAAiB,EAAE;oBACf;wBACI,OAAO,EAAE,SAAS;wBAClB,MAAM,EAAE,oBAAoB;wBAC5B,SAAS,EAAE,CAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,EAAE,CAAE;qBAChD;iBACJ;aACJ,CAAA;QACL,CAAC,CAAC,EAAE,CAAC;QAEL,MAAM,GAAG,GAAG,KAAK,KAAK,OAAO,CAAC,CAAC;YAC3B,sBAAS,CAAC,SAAS,CAAC,mBAAmB,CAAC,YAAY;YACpD,CAAC;gBACD,sBAAS,CAAC,SAAS,CAAC,mBAAmB,CAAC,WAAW,CAAC;QAExD,MAAM,IAAA,8BAAsB,EAAC,GAAG,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAC7F,CAAC;CAAA;AA1DD,kDA0DC"}

package/dist/lib/teams/index.d.ts

@@ -0,0 +1,2 @@
+export * from './broadcastLogMessage';
+export * from './logMessage';

package/dist/lib/teams/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./broadcastLogMessage"), exports);
+__exportStar(require("./logMessage"), exports);
+//# sourceMappingURL=index.js.map

package/dist/lib/teams/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/teams/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC;AACtC,+CAA6B"}

package/dist/lib/teams/logMessage.d.ts

@@ -0,0 +1,51 @@
+import { Environment } from '../../utils';
+import { z } from 'zod';
+/**
+ * @description we classified the logs into 4 levels and one supporting level:
+ *  - `verbose`: The most fine-grained information only used in rare cases where
+ *  you need the full visibility of what is happening in your application
+ *  and inside the third-party libraries that you use
+ *  - `info`: The standard log level indicating that something happened;
+ *  the application entered a certain state. It should be purely informative and
+ *  not looking into them on a regular basis
+ *  - `warn`: the log level that indicates that something unexpected happened in
+ *  the application, a problem, or a situation that might disturb one of the
+ *  processes. But that doesn’t mean that the application failed
+ *  - `error`: error, states as `FATAL` in the modern log leveling to alleviate DRY.
+ *  It tells that the application encountered an event or entered a state in which
+ * one of the crucial business functionality is no longer working
+ *  - `disabled`: supporting enum for disabling the functionality of logger
+ *
+ * @example
+ * ```markdown
+ *  - verbose: annotate each step in the algorithm or each individual query
+ *  with parameters in your code
+ *  - info: request of authorization API which states whether a user sign-on success or not
+ *  - warn`: a parsing error occurred that resulted in a certain document not being processed
+ *  - error: when the application is not able to connect to a crucial data store like a database
+ *  or one of the sub-service is unavailable
+ * ```
+ * @see https://sematext.com/blog/logging-levels/
+ */
+export declare const zLogLevel: z.ZodEnum<["verbose", "info", "warn", "error", "disabled"]>;
+/**
+ * @description typedef of `zLogLevel`
+ */
+export type LogLevel = z.infer<typeof zLogLevel>;
+/**
+ * @description definition of the context that a log should contains
+ * @property {LogLevel} level - log level
+ * @property {string} time - when does the log be generated
+ * @property {string} appName - the service which generates the logs
+ * @property {Environment} environment - log happened in which environment
+ * @property {string} message - log message
+ * @property {string} version - current app version
+ */
+export type LogMessage = {
+    level: LogLevel;
+    time: string;
+    appName: string;
+    environment: Environment;
+    message: string;
+    version: string;
+};