skyeye-svc-common-utils 2.0.0-dev0.17 → 2.0.0-dev0.19

package/dist/lib/azure/cognitiveSearch/SearchOption.js

@@ -0,0 +1,104 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchOption = void 0;
+const SearchFilter_1 = require("./SearchFilter");
+const SearchMode_1 = require("./SearchMode");
+/**
+ * @classdesc the class is to wrap an option when retrieving the data from
+ * @azure/search-documents/query
+ * @property searchOptionType - to store the interface of the option, noted that
+ * when calling the query, you should use SearchOption.value() instead of using
+ * this attribute.
+ */
+class SearchOption {
+    constructor(searchOptionType) {
+        /**
+         * @description as an adaptor to transform the type for @azure/search-documents
+         * @returns {Object} object which can be accepted by @azure/search-documents
+         */
+        this.value = () => {
+            let value = {};
+            value.includeTotalCount = this.searchOptionType.count;
+            value.select = this.searchOptionType.select;
+            value.skip = this.searchOptionType.skip;
+            value.top = this.searchOptionType.top;
+            value.searchMode = this.searchOptionType.searchMode;
+            value.searchFields = this.searchOptionType.searchFields;
+            value.scoringProfile = this.searchOptionType.scoringProfile;
+            value.highlightFields = this.searchOptionType.highlightFields;
+            value.highlightPreTag = this.searchOptionType.highlightPreTag;
+            value.highlightPostTag = this.searchOptionType.highlightPostTag;
+            value.queryType = this.searchOptionType.queryType;
+            if (!!this.searchOptionType.filter) {
+                value.filter = this.composeFilter();
+            }
+            if (!!this.searchOptionType.select && this.searchOptionType.select.length) {
+                value.select = this.searchOptionType.select;
+            }
+            if (!!this.searchOptionType.orderBy && this.searchOptionType.orderBy.length) {
+                value.orderBy = this.composeOrder();
+            }
+            if (!!this.searchOptionType.facets && this.searchOptionType.facets.length) {
+                value.facets = this.composeFacets();
+            }
+            return value;
+        };
+        // override the default settings if the value is empty from the given OptionType
+        this.searchOptionType = Object.assign(Object.assign({}, SearchOption.defaultSearchOption), searchOptionType);
+    }
+    /**
+     * @description to compose flatten-filter string for @azure/search-documents
+     * @returns {string} flatten-filter string
+     */
+    composeFilter() {
+        if (typeof (this.searchOptionType.filter) === 'string') {
+            return this.searchOptionType.filter;
+        }
+        return this.searchOptionType.filterCombinationType === "and" /* CombinationType.and */ ?
+            (0, SearchFilter_1.AND)(...this.searchOptionType.filter)
+            :
+                (0, SearchFilter_1.OR)(...this.searchOptionType.filter);
+    }
+    /**
+     * @description to compose flatten-order string for @azure/search-documents
+     * @returns {Array<string>} flatten-order string
+     */
+    composeOrder() {
+        return this.searchOptionType.orderBy.map((s) => `${s.attr} ${s.orderBy}`);
+    }
+    /**
+     * @description to compose flatten-facets string for @azure/search-documents
+     * @returns {Array<string>} flatten-facets string
+     */
+    composeFacets() {
+        return this.searchOptionType.facets.map((s) => {
+            let res = `${s.attr}`;
+            if (s.count !== null && s.count !== undefined) {
+                res += `,count:${s.count}`;
+            }
+            if (!!s.sort) {
+                res += `,sort:${s.sort}`;
+            }
+            if (s.interval !== null && s.interval !== undefined) {
+                res += `,interval:${s.interval}`;
+            }
+            if (!!s.timeoffset) {
+                res += `,timeoffset:${s.timeoffset}`;
+            }
+            return res;
+        });
+    }
+}
+exports.SearchOption = SearchOption;
+/**
+ * @description when initializing a SearchOption, the defaultSearchOption
+ * will override the undefined props
+ */
+SearchOption.defaultSearchOption = {
+    count: false,
+    top: 50,
+    skip: 0,
+    searchMode: SearchMode_1.SearchMode.all,
+    filterCombinationType: "and" /* CombinationType.and */
+};
+//# sourceMappingURL=SearchOption.js.map

package/dist/lib/azure/cognitiveSearch/SearchOption.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SearchOption.js","sourceRoot":"","sources":["../../../../src/lib/azure/cognitiveSearch/SearchOption.ts"],"names":[],"mappings":";;;AAAA,iDAAwE;AAGxE,6CAA0C;AAmC1C;;;;;;GAMG;AACH,MAAa,YAAY;IAerB,YAAY,gBAAmC;QA0C/C;;;WAGG;QACH,UAAK,GAAG,GAAG,EAAE;YACT,IAAI,KAAK,GAeL,EAAE,CAAC;YAEP,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC;YACtD,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC;YAC5C,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;YACxC,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC;YACtC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC;YACpD,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC;YACxD,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,cAAc,CAAC;YAC5D,KAAK,CAAC,eAAe,GAAG,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC;YAC9D,KAAK,CAAC,eAAe,GAAG,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC;YAC9D,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC;YAChE,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAElD,IAAI,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE;gBAChC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;aACvC;YAED,IAAI,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE;gBACvE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC;aAC/C;YAED,IAAI,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,IAAI,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,MAAM,EAAE;gBACzE,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;aACvC;YAED,IAAI,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE;gBACvE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;aACvC;YAED,OAAO,KAAK,CAAC;QACjB,CAAC,CAAA;QA5FG,gFAAgF;QAChF,IAAI,CAAC,gBAAgB,mCAAQ,YAAY,CAAC,mBAAmB,GAAK,gBAAgB,CAAE,CAAC;IACzF,CAAC;IAED;;;OAGG;IACK,aAAa;QACjB,IAAI,OAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,KAAK,QAAQ,EAAE;YAAE,OAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC;SAAE;QAC/F,OAAO,IAAI,CAAC,gBAAgB,CAAC,qBAAqB,oCAAwB,CAAC,CAAC;YACxE,IAAA,kBAAG,EAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC;YACpC,CAAC;gBACD,IAAA,iBAAE,EAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACK,YAAY;QAChB,OAAO,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,GAAG,CACpC,CAAC,CAAc,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,OAAO,EAAE,CAC/C,CAAC;IACN,CAAC;IAED;;;OAGG;IACK,aAAa;QACjB,OAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAe,EAAE,EAAE;YACxD,IAAI,GAAG,GAAG,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;YACtB,IAAI,CAAC,CAAC,KAAK,KAAK,IAAI,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS,EAAE;gBAAE,GAAG,IAAG,UAAU,CAAC,CAAC,KAAK,EAAE,CAAC;aAAE;YAC7E,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;gBAAE,GAAG,IAAI,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC;aAAE;YAC3C,IAAI,CAAC,CAAC,QAAQ,KAAK,IAAI,IAAI,CAAC,CAAC,QAAQ,KAAK,SAAS,EAAE;gBAAE,GAAG,IAAI,aAAa,CAAC,CAAC,QAAQ,EAAE,CAAC;aAAE;YAC1F,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE;gBAAE,GAAG,IAAI,eAAe,CAAC,CAAC,UAAU,EAAE,CAAC;aAAE;YAC7D,OAAO,GAAG,CAAC;QACf,CAAC,CAAC,CAAC;IACP,CAAC;;AAvDL,oCA6GC;AA1GG;;;GAGG;AACI,gCAAmB,GAAqB;IAC3C,KAAK,EAAE,KAAK;IACZ,GAAG,EAAE,EAAE;IACP,IAAI,EAAE,CAAC;IACP,UAAU,EAAE,uBAAU,CAAC,GAAG;IAC1B,qBAAqB,iCAAqB;CAC7C,CAAA"}

package/dist/lib/azure/cognitiveSearch/SearchOrder.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @description SearchOrder as a type to depict the orderBy props
+ * @property {string} attr - the search field which is used to be sorted
+ * @property {'desc' | 'asc'} orderBy - descent or ascent
+ */
+export type SearchOrder = {
+    attr: string;
+    orderBy: 'desc' | 'asc';
+};

package/dist/lib/azure/cognitiveSearch/SearchOrder.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=SearchOrder.js.map

package/dist/lib/azure/cognitiveSearch/SearchOrder.js.map

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

package/dist/lib/azure/cognitiveSearch/index.d.ts

@@ -0,0 +1,7 @@
+export * from './QueryType';
+export * from './SearchClient';
+export * from './SearchFacets';
+export * from './SearchFilter';
+export * from './SearchMode';
+export * from './SearchOption';
+export * from './SearchOrder';

package/dist/lib/azure/cognitiveSearch/index.js

@@ -0,0 +1,24 @@
+"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("./QueryType"), exports);
+__exportStar(require("./SearchClient"), exports);
+__exportStar(require("./SearchFacets"), exports);
+__exportStar(require("./SearchFilter"), exports);
+__exportStar(require("./SearchMode"), exports);
+__exportStar(require("./SearchOption"), exports);
+__exportStar(require("./SearchOrder"), exports);
+//# sourceMappingURL=index.js.map

package/dist/lib/azure/cognitiveSearch/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/azure/cognitiveSearch/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,iDAA+B;AAC/B,iDAA+B;AAC/B,iDAA+B;AAC/B,+CAA6B;AAC7B,iDAA+B;AAC/B,gDAA8B"}

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

@@ -0,0 +1,7 @@
+export * from './cognitiveSearch';
+export * from './azureBlobStorage';
+export * from './azureKeyVault';
+export * from './azureServiceBusClient';
+export * from './azureServiceBusQueue';
+export * from './azureStorageQueue';
+export * from './azureTableStorage';

package/dist/lib/azure/index.js

@@ -0,0 +1,24 @@
+"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("./cognitiveSearch"), exports);
+__exportStar(require("./azureBlobStorage"), exports);
+__exportStar(require("./azureKeyVault"), exports);
+__exportStar(require("./azureServiceBusClient"), exports);
+__exportStar(require("./azureServiceBusQueue"), exports);
+__exportStar(require("./azureStorageQueue"), exports);
+__exportStar(require("./azureTableStorage"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/azure/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,qDAAmC;AACnC,kDAAgC;AAChC,0DAAwC;AACxC,yDAAuC;AACvC,sDAAoC;AACpC,sDAAoC"}

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

@@ -0,0 +1,2 @@
+export * from './sendRequest';
+export * from './sendRequestWithTimeout';

package/dist/lib/fetch/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("./sendRequest"), exports);
+__exportStar(require("./sendRequestWithTimeout"), exports);
+//# sourceMappingURL=index.js.map

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

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

package/dist/lib/fetch/sendRequest.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @description wrapper of node-fetch
+ * @param {string} url - request endpoint
+ * @param {any} options - fetch options
+ * @returns {any} response
+ */
+export declare const sendRequest: (url: string, options: any) => Promise<import("node-fetch").Response>;

package/dist/lib/fetch/sendRequest.js

@@ -0,0 +1,25 @@
+"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.sendRequest = void 0;
+const node_fetch_1 = __importDefault(require("node-fetch"));
+/**
+ * @description wrapper of node-fetch
+ * @param {string} url - request endpoint
+ * @param {any} options - fetch options
+ * @returns {any} response
+ */
+const sendRequest = (url, options) => __awaiter(void 0, void 0, void 0, function* () { return yield (0, node_fetch_1.default)(url, options); });
+exports.sendRequest = sendRequest;
+//# sourceMappingURL=sendRequest.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sendRequest.js","sourceRoot":"","sources":["../../../src/lib/fetch/sendRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,4DAA+B;AAG/B;;;;;GAKG;AACI,MAAM,WAAW,GAAG,CAAO,GAAW,EAAE,OAAY,EAAE,EAAE,kDAAC,OAAA,MAAM,IAAA,oBAAK,EAAC,GAAG,EAAE,OAAO,CAAC,CAAA,GAAA,CAAC;AAA7E,QAAA,WAAW,eAAkE"}

package/dist/lib/fetch/sendRequest.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/lib/fetch/sendRequest.test.js

@@ -0,0 +1,27 @@
+"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 });
+const sendRequest_1 = require("./sendRequest");
+const utils_1 = require("../../utils");
+const loadConfig_1 = require("../../utils/middleware/loadConfig");
+beforeAll(() => { return (0, loadConfig_1.loadConfig)(); });
+jest.setTimeout(utils_1.QAConst.jestDefaultTimeoutMsec);
+describe('/fetch/sendRequest()', () => {
+    test(`By given google's homepage, sendRequest() should response 200 status code by GET request`, () => __awaiter(void 0, void 0, void 0, function* () {
+        const resp = yield (0, sendRequest_1.sendRequest)('https://www.google.com', { method: 'GET' });
+        expect(resp.status).toEqual(200);
+    }));
+    test(`By given google's homepage, sendRequest() should response 405 status code by POST request`, () => __awaiter(void 0, void 0, void 0, function* () {
+        const resp = yield (0, sendRequest_1.sendRequest)('https://www.google.com', { method: 'POST' });
+        expect(resp.status).toEqual(405);
+    }));
+});
+//# sourceMappingURL=sendRequest.test.js.map

package/dist/lib/fetch/sendRequest.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sendRequest.test.js","sourceRoot":"","sources":["../../../src/lib/fetch/sendRequest.test.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,+CAA4C;AAC5C,uCAAsC;AACtC,kEAA+D;AAG/D,SAAS,CAAC,GAAG,EAAE,GAAG,OAAO,IAAA,uBAAU,GAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1C,IAAI,CAAC,UAAU,CAAC,eAAO,CAAC,sBAAsB,CAAC,CAAC;AAEhD,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IAClC,IAAI,CAAC,0FAA0F,EAAE,GAAS,EAAE;QACxG,MAAM,IAAI,GAAG,MAAM,IAAA,yBAAW,EAAC,wBAAwB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5E,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACrC,CAAC,CAAA,CAAC,CAAC;IAEH,IAAI,CAAC,2FAA2F,EAAE,GAAS,EAAE;QACzG,MAAM,IAAI,GAAG,MAAM,IAAA,yBAAW,EAAC,wBAAwB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;QAC7E,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACrC,CAAC,CAAA,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/lib/fetch/sendRequestWithTimeout.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @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
+ */
+export declare function sendRequestWithTimeout(url: string, options: any, abortWithinMs?: number): Promise<any>;

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;YACA,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;SACnB;QAAC,OAAO,GAAG,EAAE;YACV,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,IAAK,GAAa,CAAC,IAAI,KAAK,YAAY,EAAE;gBAAE,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;aAAE;YAC5F,MAAM,GAAG,CAAC;SACb;IACL,CAAC;CAAA;AAlBD,wDAkBC"}

package/dist/lib/fetch/sendRequestWithTimeout.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,43 @@
+"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 });
+const sendRequestWithTimeout_1 = require("./sendRequestWithTimeout");
+const utils_1 = require("../../utils");
+const loadConfig_1 = require("../../utils/middleware/loadConfig");
+beforeAll(() => { return (0, loadConfig_1.loadConfig)(); });
+jest.setTimeout(utils_1.QAConst.jestDefaultTimeoutMsec);
+describe('/fetch/sendRequestWithTimeout()', () => {
+    test(`By given google's homepage, request should response 200 status code by GET request within 1000 ms`, () => __awaiter(void 0, void 0, void 0, function* () {
+        const resp = yield (0, sendRequestWithTimeout_1.sendRequestWithTimeout)('http://www.google.com', { method: 'GET' }, 1000);
+        expect(resp.status).toEqual(200);
+    }));
+    test(`By given google's homepage, request should be aborted by GET request within 1 ms`, () => __awaiter(void 0, void 0, void 0, function* () {
+        try {
+            yield (0, sendRequestWithTimeout_1.sendRequestWithTimeout)('http://www.google.com', { method: 'GET' }, 1);
+        }
+        catch (err) {
+            expect(err.name).toEqual('AbortError');
+        }
+    }));
+    test(`By given google's homepage, request should response 405 status code by POST request within 1000 ms`, () => __awaiter(void 0, void 0, void 0, function* () {
+        const resp = yield (0, sendRequestWithTimeout_1.sendRequestWithTimeout)('https://www.google.com', { method: 'POST' }, 1000);
+        expect(resp.status).toEqual(405);
+    }));
+    test(`By given google's homepage, request should be aborted by POST request within 1 ms`, () => __awaiter(void 0, void 0, void 0, function* () {
+        try {
+            yield (0, sendRequestWithTimeout_1.sendRequestWithTimeout)('http://www.google.com', { method: 'POST' }, 1);
+        }
+        catch (err) {
+            expect(err.name).toEqual('AbortError');
+        }
+    }));
+});
+//# sourceMappingURL=sendRequestWithTimeout.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sendRequestWithTimeout.test.js","sourceRoot":"","sources":["../../../src/lib/fetch/sendRequestWithTimeout.test.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,qEAAkE;AAClE,uCAAsC;AACtC,kEAA+D;AAG/D,SAAS,CAAC,GAAG,EAAE,GAAG,OAAO,IAAA,uBAAU,GAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1C,IAAI,CAAC,UAAU,CAAC,eAAO,CAAC,sBAAsB,CAAC,CAAC;AAEhD,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAC7C,IAAI,CAAC,mGAAmG,EAAE,GAAS,EAAE;QACjH,MAAM,IAAI,GAAG,MAAM,IAAA,+CAAsB,EAAC,uBAAuB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,IAAI,CAAC,CAAC;QAC5F,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACrC,CAAC,CAAA,CAAC,CAAC;IAEH,IAAI,CAAC,kFAAkF,EAAE,GAAS,EAAE;QAChG,IAAI;YACA,MAAM,IAAA,+CAAsB,EAAC,uBAAuB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;SAC/E;QAAC,OAAO,GAAG,EAAE;YACV,MAAM,CAAE,GAAa,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;SACrD;IACL,CAAC,CAAA,CAAC,CAAC;IAEH,IAAI,CAAC,oGAAoG,EAAE,GAAS,EAAE;QAClH,MAAM,IAAI,GAAG,MAAM,IAAA,+CAAsB,EAAC,wBAAwB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,IAAI,CAAC,CAAC;QAC9F,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACrC,CAAC,CAAA,CAAC,CAAC;IAEH,IAAI,CAAC,mFAAmF,EAAE,GAAS,EAAE;QACjG,IAAI;YACA,MAAM,IAAA,+CAAsB,EAAC,uBAAuB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;SAChF;QAAC,OAAO,GAAG,EAAE;YACV,MAAM,CAAE,GAAa,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;SACrD;IACL,CAAC,CAAA,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/lib/index.d.ts

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

package/dist/lib/index.js

@@ -0,0 +1,21 @@
+"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("./logger"), 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,2CAAyB;AACzB,0CAAwB"}

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

@@ -0,0 +1,2 @@
+export * from './logger';
+export * from './morganLogger';

package/dist/lib/logger/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("./logger"), exports);
+__exportStar(require("./morganLogger"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/logger/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,iDAA+B"}

package/dist/lib/logger/logger.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @description only be used in the override native `console` with function `verbose`
+ */
+interface ConsoleExtension {
+    verbose: Function;
+}
+/**
+ * @description custom logger will be controlled by two environment values:
+ * 	- `NODE_ENV`: The environment decides the default log level
+ * 	- `LOG_LEVEL`: if there's any pre-defined LOG_LEVEL, it will then override
+ * 		the default log level. Noted that you may expect in some services, i.e. Azure Function,
+ * 		you may not able to use the local storage. Set LOG_LEVEL = `disabled` can close
+ * 		custom logger.
+ */
+export declare const logger: import("winston").Logger | (Console & ConsoleExtension);
+export {};

package/dist/lib/logger/logger.js

@@ -0,0 +1,120 @@
+"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 __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const winston_1 = require("winston");
+const fs_1 = __importDefault(require("fs"));
+const winston_daily_rotate_file_1 = __importDefault(require("winston-daily-rotate-file"));
+const appConst_1 = require("../../utils/appConst");
+const teams_1 = require("../teams");
+/**
+ * @description make `verbose()` as an alias of `console.debug()`
+ */
+const customConsole = Object.assign(Object.assign({}, console), { verbose: (message, ...optionalParams) => {
+        console.debug(message, ...optionalParams);
+    } });
+/**
+ * @description custom logger will be controlled by two environment values:
+ * 	- `NODE_ENV`: The environment decides the default log level
+ * 	- `LOG_LEVEL`: if there's any pre-defined LOG_LEVEL, it will then override
+ * 		the default log level. Noted that you may expect in some services, i.e. Azure Function,
+ * 		you may not able to use the local storage. Set LOG_LEVEL = `disabled` can close
+ * 		custom logger.
+ */
+exports.logger = (() => {
+    // since const environment value is loaded in compile time, we fetch directly here
+    const environment = appConst_1.zEnvironment.safeParse(process.env.NODE_ENV).success ?
+        process.env.NODE_ENV : appConst_1.zEnvironment.enum.development;
+    const customLogLevel = process.env.LOG_LEVEL;
+    // Use default console if the LOG_LEVEL is specified as `disabled`
+    if (customLogLevel === teams_1.zLogLevel.enum.disabled) {
+        return customConsole;
+    }
+    fs_1.default.existsSync(appConst_1.loggerSettings.path) || fs_1.default.mkdirSync(appConst_1.loggerSettings.path, { recursive: true });
+    const logLevel = (() => {
+        // override the Log level if there's non-empty env
+        if (teams_1.zLogLevel.safeParse(customLogLevel).success) {
+            return customLogLevel;
+        }
+        switch (environment) {
+            case appConst_1.zEnvironment.enum.test:
+            case appConst_1.zEnvironment.enum.dev:
+            case appConst_1.zEnvironment.enum.development:
+                return teams_1.zLogLevel.enum.verbose;
+            case appConst_1.zEnvironment.enum.preview:
+            case appConst_1.zEnvironment.enum.staging:
+            case appConst_1.zEnvironment.enum.beta:
+            case appConst_1.zEnvironment.enum.production:
+                return teams_1.zLogLevel.enum.info;
+        }
+    })();
+    const self = (0, winston_1.createLogger)({
+        level: logLevel,
+        format: winston_1.format.combine(winston_1.format.json(), winston_1.format.timestamp(), winston_1.format.printf((_a) => {
+            var { timestamp, level, message } = _a, metadata = __rest(_a, ["timestamp", "level", "message"]);
+            return JSON.stringify(Object.assign({ timestamp,
+                level,
+                message }, (metadata || {})));
+        })),
+        transports: [
+            new winston_daily_rotate_file_1.default({
+                filename: `${appConst_1.loggerSettings.path}backend-error-%DATE%.log`,
+                level: 'error',
+                datePattern: 'YYYY-MM-DD'
+            }),
+            new winston_daily_rotate_file_1.default({
+                filename: `${appConst_1.loggerSettings.path}backend-combined-%DATE%.log`,
+                datePattern: 'YYYY-MM-DD'
+            })
+        ]
+    });
+    // if (environment !== zEnvironment.enum.production) {
+    self.add(new winston_1.transports.Console({ format: winston_1.format.combine(winston_1.format.json(), winston_1.format.timestamp(), winston_1.format.printf((_a) => {
+            var { timestamp, level, message } = _a, metadata = __rest(_a, ["timestamp", "level", "message"]);
+            return JSON.stringify(Object.assign({ timestamp,
+                level,
+                message }, (metadata || {})));
+        })) }));
+    // }
+    // we broadcast the messages on Teams only if the environment is not `test` nor `development`.
+    if (appConst_1.loggerSettings.teamsChannelDisabled && environment !== appConst_1.zEnvironment.enum.test && environment !== appConst_1.zEnvironment.enum.development) {
+        self.on('data', (context) => __awaiter(void 0, void 0, void 0, function* () {
+            switch (context.level) {
+                case teams_1.zLogLevel.enum.verbose:
+                case teams_1.zLogLevel.enum.info:
+                    return;
+                case teams_1.zLogLevel.enum.warn:
+                    (0, teams_1.broadcastLogMessage)(teams_1.zLogLevel.enum.warn, context.message.startsWith('\t') ? context.message.substring(1) : context.message);
+                    return;
+                case teams_1.zLogLevel.enum.error:
+                    (0, teams_1.broadcastLogMessage)(teams_1.zLogLevel.enum.error, context.message.startsWith('\t') ? context.message.substring(1) : context.message);
+                    return;
+            }
+            ;
+        }));
+    }
+    return self;
+})();
+//# sourceMappingURL=logger.js.map