skyeye-svc-common-utils 2.0.0-dev0.2 → 2.0.0-dev0.21

package/dist/utils/middleware/loadConfig.d.ts

@@ -0,0 +1,128 @@
+import { z } from 'zod';
+import { Environment } from '../appConst';
+/**
+ * @description
+ * @property {string} appName - service's app name from package.json
+ * @property {string} version - service's version from package.json
+ * @property {enum} environment - current environment
+ * @property {string} keyVaultName - Azure key vault name
+ * @property {string} keyVaultSecretName - secret name of Azure key vault
+ * @todo migration to single typedef
+ */
+declare const zEnvFileAppConfig: z.ZodObject<{
+    appName: z.ZodString;
+    version: z.ZodString;
+    environment: z.ZodEnum<["test", "dev", "development", "preview", "staging", "beta", "production"]>;
+    keyVaultName: z.ZodString;
+    keyVaultSecretName: z.ZodString;
+}, "strict", z.ZodTypeAny, {
+    appName?: string;
+    version?: string;
+    environment?: "dev" | "development" | "test" | "preview" | "staging" | "beta" | "production";
+    keyVaultName?: string;
+    keyVaultSecretName?: string;
+}, {
+    appName?: string;
+    version?: string;
+    environment?: "dev" | "development" | "test" | "preview" | "staging" | "beta" | "production";
+    keyVaultName?: string;
+    keyVaultSecretName?: string;
+}>;
+/**
+ * @description typedef of environment File App Config
+ */
+type EnvFileAppConfig = z.infer<typeof zEnvFileAppConfig>;
+/**
+ * @todo migration to single typedef
+ */
+declare const zSecretFileAppConfig: z.ZodObject<{
+    telemetry: z.ZodObject<{
+        teamsChannelWebHook: z.ZodObject<{
+            errorChannel: z.ZodString;
+            warnChannel: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            errorChannel?: string;
+            warnChannel?: string;
+        }, {
+            errorChannel?: string;
+            warnChannel?: string;
+        }>;
+        elasticKeyVault: z.ZodObject<{
+            secretToken: z.ZodString;
+            serverUrl: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            secretToken?: string;
+            serverUrl?: string;
+        }, {
+            secretToken?: string;
+            serverUrl?: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        teamsChannelWebHook?: {
+            errorChannel?: string;
+            warnChannel?: string;
+        };
+        elasticKeyVault?: {
+            secretToken?: string;
+            serverUrl?: string;
+        };
+    }, {
+        teamsChannelWebHook?: {
+            errorChannel?: string;
+            warnChannel?: string;
+        };
+        elasticKeyVault?: {
+            secretToken?: string;
+            serverUrl?: string;
+        };
+    }>;
+    serviceConfig: z.ZodNullable<z.ZodAny>;
+}, "strip", z.ZodTypeAny, {
+    telemetry?: {
+        teamsChannelWebHook?: {
+            errorChannel?: string;
+            warnChannel?: string;
+        };
+        elasticKeyVault?: {
+            secretToken?: string;
+            serverUrl?: string;
+        };
+    };
+    serviceConfig?: any;
+}, {
+    telemetry?: {
+        teamsChannelWebHook?: {
+            errorChannel?: string;
+            warnChannel?: string;
+        };
+        elasticKeyVault?: {
+            secretToken?: string;
+            serverUrl?: string;
+        };
+    };
+    serviceConfig?: any;
+}>;
+/**
+ * @description typedef of secret file
+ */
+type SecretFileAppConfig = z.infer<typeof zSecretFileAppConfig>;
+/**
+ * @todo migration to single typedef
+ */
+type AppConfig = EnvFileAppConfig & SecretFileAppConfig;
+/**
+ * @description configuration carrier (or, instance). We can classified all the configurations into 2 categories:
+ *  - Environment File App Config: configuration from the environment file (.env) and some other settings
+ *  - Secret File App Config: loaded from the Azure Key Vault
+ */
+export declare let appConfig: AppConfig;
+/**
+ * @todo move to loadConfig since all the environment fields should be loaded from appConfig
+ */
+export declare const environment: Environment;
+/**
+ * @description preload for app configuration, once it is been called, the appConfig will be loaded and be freezed
+ * @param packagePath - optional, path of `package.json` in order to load app name and version
+ */
+export declare const loadConfig: (packagePath?: string) => Promise<void>;
+export {};

package/dist/utils/middleware/loadConfig.js

@@ -0,0 +1,143 @@
+"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 };
+};
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadConfig = exports.environment = exports.appConfig = void 0;
+const dotenv_1 = __importDefault(require("dotenv"));
+const lib_1 = require("../../lib");
+const logger_1 = require("../logger/logger");
+const zod_1 = require("zod");
+const appConst_1 = require("../appConst");
+/**
+ * @description
+ * @property {string} appName - service's app name from package.json
+ * @property {string} version - service's version from package.json
+ * @property {enum} environment - current environment
+ * @property {string} keyVaultName - Azure key vault name
+ * @property {string} keyVaultSecretName - secret name of Azure key vault
+ * @todo migration to single typedef
+ */
+const zEnvFileAppConfig = zod_1.z.object({
+    appName: zod_1.z.string(),
+    version: zod_1.z.string(),
+    environment: appConst_1.zEnvironment,
+    keyVaultName: zod_1.z.string(),
+    keyVaultSecretName: zod_1.z.string()
+}).strict();
+/**
+ * @todo migration to single typedef
+ */
+const zElasticKeyVault = zod_1.z.object({
+    secretToken: zod_1.z.string(),
+    serverUrl: zod_1.z.string()
+});
+/**
+ * @todo migration to single typedef
+ */
+const zTeamsChannelWebHook = zod_1.z.object({
+    errorChannel: zod_1.z.string(),
+    warnChannel: zod_1.z.string()
+});
+/**
+ * @todo migration to single typedef
+ */
+const zTelemetry = zod_1.z.object({
+    teamsChannelWebHook: zTeamsChannelWebHook,
+    elasticKeyVault: zElasticKeyVault
+});
+/**
+ * @todo migration to single typedef
+ */
+const zSecretFileAppConfig = zod_1.z.object({
+    telemetry: zTelemetry,
+    serviceConfig: zod_1.z.any().nullable()
+});
+/**
+ * @todo move to loadConfig since all the environment fields should be loaded from appConfig
+ */
+exports.environment = (_a = process.env.NODE_ENV) !== null && _a !== void 0 ? _a : 'development';
+/**
+ * @description preload for app configuration, once it is been called, the appConfig will be loaded and be freezed
+ * @param packagePath - optional, path of `package.json` in order to load app name and version
+ */
+const loadConfig = (packagePath) => __awaiter(void 0, void 0, void 0, function* () {
+    logger_1.logger.verbose('start /appConfig/preload()');
+    // load environment file
+    dotenv_1.default.config({ path: `${exports.environment}.env` });
+    /**
+     * To load the appName and the version, we read the package information in the following order:
+     * 1. check if the environment value is defined directly
+     * 2. check if environment given from npm is defined
+     * 3. check if value in package.json is defined
+     */
+    const pkg = require(packagePath !== null && packagePath !== void 0 ? packagePath : `${process.env.PWD}/package.json`);
+    const appName = (() => {
+        if (!!process.env.APP_NAME) {
+            return process.env.APP_NAME;
+        }
+        if (!!process.env.npm_package_name) {
+            return process.env.npm_package_name;
+        }
+        if (!!pkg.name) {
+            return pkg.name;
+        }
+        return 'default-app-name';
+    })();
+    const version = (() => {
+        if (!!process.env.VERSION) {
+            return process.env.VERSION;
+        }
+        if (!!process.env.npm_package_version) {
+            return process.env.npm_package_version;
+        }
+        if (!!pkg.version) {
+            return pkg.version;
+        }
+        return '0.0.0';
+    })();
+    /**
+     * check the env which suppose to be hide as possible as it can,
+     * which is not allowed to define in-memory.
+     */
+    if (process.env.AZURE_TENANT_ID === undefined || process.env.AZURE_CLIENT_ID === undefined || process.env.AZURE_CLIENT_SECRET === undefined) {
+        throw new Error('/appConfig/preload: missing Azure configuration');
+    }
+    const envFileAppConfig = {
+        appName,
+        version,
+        environment: exports.environment,
+        keyVaultName: process.env.KEYVAULT_NAME,
+        keyVaultSecretName: process.env.LIBRARY_KEY_VAULT_SECRET_NAME
+    };
+    // check envFileAppConfig
+    const envTypeCheck = zEnvFileAppConfig.safeParse(envFileAppConfig);
+    if (!envTypeCheck.success) {
+        throw new Error('/appConfig/preload: invalid schema of envFileAppConfig');
+    }
+    // check secretFileAppConfig
+    const rawSecretResp = yield (0, lib_1.getKeyVault)(envFileAppConfig.keyVaultName, envFileAppConfig.keyVaultSecretName);
+    if (!rawSecretResp.isSuccess) {
+        throw new Error(rawSecretResp.message);
+    }
+    const secretFileAppConfig = rawSecretResp.data;
+    const secretFileTypeCheck = zSecretFileAppConfig.safeParse(secretFileAppConfig);
+    if (!secretFileTypeCheck.success) {
+        throw new Error('/appConfig/preload: invalid schema of secretFileAppConfig');
+    }
+    exports.appConfig = Object.assign(Object.assign({}, envFileAppConfig), secretFileAppConfig);
+    Object.freeze(exports.appConfig);
+    logger_1.logger.verbose('end /appConfig/preload()');
+});
+exports.loadConfig = loadConfig;
+//# sourceMappingURL=loadConfig.js.map

package/dist/utils/middleware/loadConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadConfig.js","sourceRoot":"","sources":["../../../src/utils/middleware/loadConfig.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAA4B;AAC5B,mCAAwC;AACxC,6CAA0C;AAC1C,6BAAwB;AACxB,0CAAwD;AAExD;;;;;;;;GAQG;AACH,MAAM,iBAAiB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC/B,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;IACnB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;IACnB,WAAW,EAAE,uBAAY;IACzB,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE;IACxB,kBAAkB,EAAE,OAAC,CAAC,MAAM,EAAE;CACjC,CAAC,CAAC,MAAM,EAAE,CAAC;AAOZ;;GAEG;AACH,MAAM,gBAAgB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC9B,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;IACvB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;CACxB,CAAC,CAAA;AAEF;;GAEG;AACH,MAAM,oBAAoB,GAAG,OAAC,CAAC,MAAM,CAAC;IAClC,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE;IACxB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;CAC1B,CAAC,CAAA;AAEF;;GAEG;AACH,MAAM,UAAU,GAAG,OAAC,CAAC,MAAM,CAAC;IACxB,mBAAmB,EAAE,oBAAoB;IACzC,eAAe,EAAE,gBAAgB;CACpC,CAAC,CAAA;AAEF;;GAEG;AACF,MAAM,oBAAoB,GAAG,OAAC,CAAC,MAAM,CAAC;IACnC,SAAS,EAAE,UAAU;IACrB,aAAa,EAAE,OAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;CACpC,CAAC,CAAC;AAmBH;;GAEG;AACU,QAAA,WAAW,GAAgB,MAAC,OAAO,CAAC,GAAG,CAAC,QAAwB,mCAAI,aAAa,CAAC;AAE/F;;;GAGG;AACI,MAAM,UAAU,GAAG,CAAO,WAAoB,EAAE,EAAE;IACrD,eAAM,CAAC,OAAO,CAAC,4BAA4B,CAAC,CAAC;IAE7C,wBAAwB;IACxB,gBAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,GAAG,mBAAW,MAAM,EAAE,CAAC,CAAC;IAE9C;;;;;OAKG;IACH,MAAM,GAAG,GAAG,OAAO,CAAC,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,CAAC;IAEtE,MAAM,OAAO,GAAW,CAAC,GAAW,EAAE;QAClC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YAAC,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;QAAC,CAAC;QAC5D,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;YAAC,OAAO,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC;QAAC,CAAC;QAC5E,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YAAC,OAAO,GAAG,CAAC,IAAI,CAAC;QAAC,CAAC;QACpC,OAAO,kBAAkB,CAAC;IAC9B,CAAC,CAAC,EAAE,CAAC;IAEL,MAAM,OAAO,GAAW,CAAC,GAAW,EAAE;QAClC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YAAC,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;QAAC,CAAC;QAC1D,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,CAAC;YAAC,OAAO,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;QAAC,CAAC;QAClF,IAAI,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YAAC,OAAO,GAAG,CAAC,OAAO,CAAC;QAAC,CAAC;QAC1C,OAAO,OAAO,CAAC;IACnB,CAAC,CAAC,EAAE,CAAC;IAEL;;;OAGG;IACH,IAAI,OAAO,CAAC,GAAG,CAAC,eAAe,KAAK,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,eAAe,KAAK,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,mBAAmB,KAAK,SAAS,EAAE,CAAC;QAC1I,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACvE,CAAC;IAED,MAAM,gBAAgB,GAAqB;QACvC,OAAO;QACP,OAAO;QACP,WAAW,EAAX,mBAAW;QACX,YAAY,EAAE,OAAO,CAAC,GAAG,CAAC,aAAa;QACvC,kBAAkB,EAAE,OAAO,CAAC,GAAG,CAAC,6BAA6B;KAChE,CAAC;IAEF,yBAAyB;IACzB,MAAM,YAAY,GAAG,iBAAiB,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;IACnE,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;IAC9E,CAAC;IAED,4BAA4B;IAC5B,MAAM,aAAa,GAAG,MAAM,IAAA,iBAAW,EAAC,gBAAgB,CAAC,YAAY,EAAE,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;IAC5G,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC;QAAC,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAAC,CAAC;IACzE,MAAM,mBAAmB,GAAwB,aAAa,CAAC,IAAI,CAAC;IACpE,MAAM,mBAAmB,GAAG,oBAAoB,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;IAChF,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;IACjF,CAAC;IAED,iBAAS,mCAAQ,gBAAgB,GAAK,mBAAmB,CAAE,CAAC;IAC5D,MAAM,CAAC,MAAM,CAAC,iBAAS,CAAC,CAAC;IAEzB,eAAM,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC;AAC/C,CAAC,CAAA,CAAC;AA/DW,QAAA,UAAU,cA+DrB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skyeye-svc-common-utils",
-  "version": "2.0.0-dev0.2",
+  "version": "2.0.0-dev0.21",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -21,20 +21,14 @@
   "homepage": "https://github.com/HandshakesByDC/SkyEye-SVC-Common-Utils#readme",
   "dependencies": {
     "@azure/data-tables": "^13.2.2",
-    "@azure/identity": "latest",
-    "@azure/keyvault-secrets": "latest",
-    "@azure/service-bus": "7.9.1",
+    "@azure/identity": "^4.0.1",
+    "@azure/keyvault-secrets": "^4.8.0",
+    "@azure/service-bus": "^7.9.4",
     "@azure/storage-blob": "^12.1.2",
     "@azure/storage-queue": "^12.0.2",
+    "@azure/search-documents": "11.2.1",
+    "@azure/abort-controller": "1.0.4",
     "@sendgrid/mail": "^7.7.0",
-    "@types/chai": "^4.2.11",
-    "@types/express": "4.17.14",
-    "@types/express-serve-static-core": "4.17.30",
-    "@types/google-protobuf": "^3.7.2",
-    "@types/jsonwebtoken": "^9.0.0",
-    "@types/lodash": "4.14.182",
-    "@types/swagger-jsdoc": "^3.0.2",
-    "@types/swagger-ui-express": "^4.1.1",
     "async-mutex": "^0.3.2",
     "cron-parser": "4.8.1",
     "dateformat": "^3.0.3",
@@ -45,30 +39,39 @@
     "http-errors": "^1.7.3",
     "https": "^1.0.0",
     "ioredis": "^5.0.4",
-    "jsonwebtoken": "^9.0.0",
+    "jsonwebtoken": "^9.0.2",
+    "lodash": "^4.17.21",
     "logform": "2.4.2",
     "moment": "^2.24.0",
     "morgan": "^1.9.1",
     "node-fetch": "^2.6.0",
     "nyc": "^15.1.0",
-    "rotating-file-stream": "^1.4.6",
+    "rotating-file-stream": "^3.2.1",
     "skyeye-common-const": "1.0.42",
     "swagger-jsdoc": "^3.5.0",
     "swagger-ui-express": "^4.1.3",
     "ts-node": "^10.7.0",
     "typeorm": "^0.3.17",
     "typescript": "^5.3.3",
-    "uuid": "^3.3.3",
     "winston": "^3.2.1",
-    "winston-daily-rotate-file": "^4.2.1"
+    "winston-daily-rotate-file": "^4.2.1",
+    "abort-controller": "3.0.0",
+    "zod": "3.22.3"
   },
   "devDependencies": {
-    "@types/dateformat": "^3.0.1",
-    "@types/debug": "~4.1.5",
-    "@types/http-errors": "~1.6.1",
-    "@types/morgan": "~1.7.37",
-    "@types/node": "^14.0.27",
-    "@types/node-fetch": "^2.5.3",
-    "@types/uuid": "^3.4.6"
+    "@types/dateformat": "^5.0.2",
+    "@types/debug": "^4.1.12",
+    "@types/http-errors": "~2.0.4",
+    "@types/morgan": "~1.9.9",
+    "@types/node": "^20.11.19",
+    "@types/node-fetch": "^2.6.11",
+    "@types/chai": "^4.3.11",
+    "@types/express": "^4.17.21",
+    "@types/express-serve-static-core": "^4.17.43",
+    "@types/google-protobuf": "^3.15.12",
+    "@types/jsonwebtoken": "^9.0.6",
+    "@types/lodash": "^4.14.202",
+    "@types/swagger-jsdoc": "^6.0.4",
+    "@types/swagger-ui-express": "^4.1.6"
   }
 }

package/src/index.ts

@@ -7,23 +7,26 @@ export * from './utils/logger/morganLogger';
 export * from './utils/middleware/handleError';
 export * from './utils/middleware/isPublicUser';
 export * from './utils/middleware/overwriteConst';
-export * from './utils/middleware/startdbConnection';
+export * from './utils/middleware/loadConfig';
 export * from './utils/baseClass/baseController';
 export * from './utils/baseClass/baseService';
-export * from './interfaces/index';
+export * from './utils/baseClass/appDataSource';
+export * from './utils/monitoring/apm';
+export * from './utils/commonUtils/appConfigKeyRetriever';
+export * from './utils/documentation/swagger';
 export * from './lib/azure/azureKeyVault';
 export * from './lib/azure/azureServiceBusClient';
 export * from './lib/azure/azureStorageQueue';
 export * from './lib/azure/azureServiceBusQueue';
 export * from './lib/azure/azureTableStorage';
 export * from './lib/azure/azureBlobStorage';
-export * from './utils/documentation/swagger';
+export * from './lib/azure/cognitiveSearch';
+export * from './lib/fetch';
 export * from './lib/httpClient';
-export * from './utils/monitoring/apm';
-export * from './models/baseControllerParameter';
-export * from './models';
 export * from './lib/redisClient';
 export * from './lib/sendGridClient';
+export * from './models';
+export * from './models/baseControllerParameter';
+export * from './interfaces';
 export * from './interfaces/grpcServiceResponse';
 export * from './interfaces/grpcListRequest';
-export * from './utils/commonUtils/appConfigKeyRetriever';

package/src/lib/azure/azureKeyVault.ts

@@ -1,6 +1,9 @@
 import { SecretClient } from "@azure/keyvault-secrets";
 import { DefaultAzureCredential } from "@azure/identity";
+import { AbortController } from '@azure/abort-controller';
 import { commonAppConfig} from '../../utils/appConfig';
+import { thirdPartyRegulation } from '../../utils/appConst';
+import { ServiceResponse } from '../../interfaces';
 
 export async function getKey(secretName : string) : Promise<string>{
     const credential = new DefaultAzureCredential();
@@ -12,4 +15,45 @@ export async function getKey(secretName : string) : Promise<string>{
     const secret = await client.getSecret(secretName);
 
     return secret.value;
+}
+
+/**
+ * @description To retrieve secret from a given Azure Key Vault
+ * @param {string} keyVaultName - name of Azure Key Vault
+ * @param {string} secretName - secret name of Azure Key Vault
+ * @param {number} abortWithinMsec - automatically abort within given millisecond
+ * @param {number} retry - automatically retry with given times
+ * @returns {ServiceResponse}
+ */
+export async function getKeyVault(
+    keyVaultName: string,
+    secretName : string,
+    abortWithinMsec: number = thirdPartyRegulation.requestLimitationMsec,
+    retry: number = thirdPartyRegulation.requestDefaultRetry
+): Promise<ServiceResponse> {
+    const resp: ServiceResponse = { isSuccess: false };
+
+    try {
+        const credential = new DefaultAzureCredential();
+        const url = `https://${keyVaultName}.vault.azure.net`;
+        const client = new SecretClient(url, credential);
+
+        let curTry = 0;
+        while (curTry <= retry) {
+            const signal = AbortController.timeout(abortWithinMsec);
+            const secret = await client.getSecret(secretName, { abortSignal: signal });
+            if (secret && secret.value) {
+                resp.data = JSON.parse(secret.value);
+                resp.isSuccess = true;
+                break;
+            }
+            if (curTry === retry) {
+                throw new Error(`/keyVault/getKeyVault(): failed fetch secret with retries (${retry})`);
+            }
+        }
+    } catch (err) {
+        resp.message = err as string;
+    }
+
+    return resp;
 }

package/src/lib/azure/cognitiveSearch/QueryType.ts

@@ -0,0 +1,8 @@
+/**
+ * @description Specifies whether simple or full of query type must be matched
+ * @see https://docs.microsoft.com/en-us/rest/api/searchservice/search-documents
+ */
+export enum QueryType {
+    simple = 'simple',
+    full = 'full'
+}

package/src/lib/azure/cognitiveSearch/SearchClient.ts

@@ -0,0 +1,149 @@
+import { SearchClient as OfficialSearchClient, AzureKeyCredential } from '@azure/search-documents';
+import { logger } from '../../../utils/logger/logger';
+import { getKeyVault } from '../../azure/azureKeyVault';
+import { ServiceResponse } from '../../../interfaces';
+import { AzureSearchIndex, AzureSearchConfig } from '../../../utils';
+import { appConfig, loadConfig } from '../../../utils/middleware/loadConfig';
+
+
+/**
+ * @classdesc SearchClient as an adaptor to bind the third-party library
+ * (@azure/search-documents) with the internal application. That is to say, the 
+ * class is aim to enhance dev's maintenance between lib and the exact usage.
+ * @property {SearchClient} instance - Singleton instance
+ * @property {string} endpoint - Azure cognitive search's request endpoint
+ * @property {string} credential - Azure cognitive search's API key
+ * @property {Semaphore} semaphore - to ensure not too many requests are sent to Azure cognitive search
+ * @property {Record<AzureSearchIndex, string>} indexMap - to store the index's alias
+ * 
+ * @example
+ * const client = await SearchClient.getInstance();
+ * const searchOption = new SearchOption( { top: 1 });
+ * console.log(JSON.stringify(await client.query(AzureSearchIndex.company, '*', searchOption.value())));
+ */
+export class SearchClient {
+    private static instance: SearchClient;
+    private static endpoint: string;
+    private static credential: string;
+    private static indexMap: Record<AzureSearchIndex, string>;
+
+    /**
+     * @description To retrieve the instance in the Singleton pattern
+     * @returns {SearchClient} the singleton instance of SearchClient
+     */
+    static async getInstance(): Promise<SearchClient> {
+        if (!!SearchClient.instance) { return SearchClient.instance; }
+
+        SearchClient.instance = new SearchClient();
+
+        /**
+         * 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 (appConfig === undefined) {
+            try {
+                await loadConfig();
+                if (appConfig.keyVaultName === undefined) {
+                    throw new Error('SearchClient/getInstance: empty keyVaultName');
+                }
+            } catch (err) {
+                throw err;
+            }
+        }
+
+        const credentialResp = await getKeyVault(appConfig.keyVaultName, AzureSearchConfig.credentialSecretName);
+
+        if (credentialResp.isSuccess === false) {
+            throw new Error('/SearchClient/getInstance(): retrieve search credential failed');
+        }
+
+        const secret: { endpoint: string, credential: string } = credentialResp.data;
+
+        const indexMapResp = await getKeyVault(appConfig.keyVaultName, AzureSearchConfig.indexSecretName);
+
+        if (indexMapResp.isSuccess === false) {
+            throw new Error('/SearchClient/getInstance(): retrieve search indexMap failed');
+        }
+
+        SearchClient.indexMap = indexMapResp.data;
+        SearchClient.endpoint = secret.endpoint;
+        SearchClient.credential = secret.credential;
+        return SearchClient.instance;
+    }
+
+    /**
+     * @description To query the Azure cognitive search
+     * @param {AzureSearchIndex} index - to retrieve the document
+     * @param {string} keyword - as the prop 'search'
+     * @param {any} options - additional option for the search
+     * @param {number} retryTimes - specify how many times if Azure cognitive search returns a bad request
+     * @returns {ServiceResponse} a serviceResponse, noted that data is stated in `data.document`
+     */
+    async query(
+        index: AzureSearchIndex,
+        keyword: string = '*',
+        options?: any,
+        retryTimes: number = AzureSearchConfig.queryRetryDefault,
+        tracking: number = Math.floor(Math.random()*100000000000)
+    ): Promise<ServiceResponse> {
+        logger.verbose(`start SearchClient/query: ${tracking}`);
+        let serviceResponse: ServiceResponse = { isSuccess: false };
+        let searchResults: any;
+        let curRetry = 0;
+        try {
+
+            const client = new OfficialSearchClient(
+                SearchClient.endpoint,
+                SearchClient.indexMap[index],
+                new AzureKeyCredential(SearchClient.credential)
+            );
+
+            while (curRetry < retryTimes) {
+                try {
+                    logger.verbose(`SearchClient/query before sending : ${curRetry}|${tracking}`);
+                    searchResults = await client.search(keyword, options);
+                    logger.verbose(`SearchClient/query after sending : ${curRetry}|${tracking}`);
+                    serviceResponse.data = { document: [] };
+
+                    for await (const result of searchResults.results) {
+                        result.document.score = result.score;
+                        result.document.highlights = result.highlights;
+                        serviceResponse.data.document.push(result.document);
+                    }
+                    logger.verbose(`SearchClient/query after processing : ${curRetry}|${tracking}`);
+                    if (!!searchResults.facets) {
+                        serviceResponse.data.facets = searchResults.facets;
+                    }
+
+                    if (!!searchResults.count) {
+                        serviceResponse.data.count = searchResults.count;
+                    }
+
+                    serviceResponse.isSuccess = true;
+                } catch (err) {
+                    logger.error(`SearchClient/query: fail - ${err}`);
+                }
+
+                if (!serviceResponse.isSuccess) {
+                    logger.info(`SearchClient/query: retry - ${curRetry}`);
+                    ++curRetry;
+                    await this.sleep(AzureSearchConfig.retryIntervalSecond * 1000);
+                } else {
+                    break;
+                }
+            }
+        } catch (err) {
+            logger.error(`SearchClient/query: ${err}`);
+        }
+        logger.verbose(`end SearchClient/query : ${curRetry}|${serviceResponse.data.document.length}|${tracking}`);
+        return serviceResponse;
+    }
+
+    /**
+     * @description To postpone for specific millisecond
+     * @param {number} ms - millisecond to wait for
+     */
+    private async sleep(ms: number) {
+        await new Promise( _ => setTimeout(_, ms));
+    }
+}

package/src/lib/azure/cognitiveSearch/SearchFacets.ts

@@ -0,0 +1,16 @@
+/**
+ * @description SearchFacets as a type is to wrap facets for @azure/search-documents
+ * @see https://docs.microsoft.com/en-us/rest/api/searchservice/search-documents
+ * @property {string} attr - attribute/prop to reach
+ * @property {number} count - volume of the search
+ * @property {enum} sort - order
+ * @property {enum | number} interval - interval greater than 0 for numbers for date time values
+ * @property {string} timeoffset - specifying a dynamic set of facet entry values
+ */
+ export type SearchFacets = {
+    attr: string;
+    count?: number;
+    sort?: 'count' | '-count' | 'value' | '-value';
+    interval?: number | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year';
+    timeoffset?: string;
+}