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

package/dist/index.d.ts

@@ -7,10 +7,9 @@ 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/baseClass/baseController';
 export * from './utils/baseClass/baseService';
-export * from './utils/baseClass/dataSourceManager';
+export * from './utils/baseClass/appDataSource';
 export * from './interfaces/index';
 export * from './lib/azure/azureKeyVault';
 export * from './lib/azure/azureServiceBusClient';

package/dist/index.js

@@ -23,10 +23,9 @@ __exportStar(require("./utils/logger/morganLogger"), exports);
 __exportStar(require("./utils/middleware/handleError"), exports);
 __exportStar(require("./utils/middleware/isPublicUser"), exports);
 __exportStar(require("./utils/middleware/overwriteConst"), exports);
-__exportStar(require("./utils/middleware/startdbConnection"), exports);
 __exportStar(require("./utils/baseClass/baseController"), exports);
 __exportStar(require("./utils/baseClass/baseService"), exports);
-__exportStar(require("./utils/baseClass/dataSourceManager"), exports);
+__exportStar(require("./utils/baseClass/appDataSource"), exports);
 __exportStar(require("./interfaces/index"), exports);
 __exportStar(require("./lib/azure/azureKeyVault"), exports);
 __exportStar(require("./lib/azure/azureServiceBusClient"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,mDAAiC;AACjC,sDAAoC;AACpC,8DAA4C;AAC5C,wDAAsC;AACtC,8DAA4C;AAC5C,iEAA+C;AAC/C,kEAAgD;AAChD,oEAAkD;AAClD,uEAAqD;AACrD,mEAAiD;AACjD,gEAA8C;AAC9C,sEAAoD;AACpD,qDAAmC;AACnC,4DAA0C;AAC1C,oEAAkD;AAClD,gEAA8C;AAC9C,mEAAiD;AACjD,gEAA8C;AAC9C,+DAA6C;AAC7C,gEAA8C;AAC9C,mDAAiC;AACjC,yDAAuC;AACvC,mEAAiD;AACjD,2CAAyB;AACzB,oDAAkC;AAClC,uDAAqC;AACrC,mEAAiD;AACjD,+DAA6C;AAC7C,4EAA0D"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,mDAAiC;AACjC,sDAAoC;AACpC,8DAA4C;AAC5C,wDAAsC;AACtC,8DAA4C;AAC5C,iEAA+C;AAC/C,kEAAgD;AAChD,oEAAkD;AAClD,mEAAiD;AACjD,gEAA8C;AAC9C,kEAAgD;AAChD,qDAAmC;AACnC,4DAA0C;AAC1C,oEAAkD;AAClD,gEAA8C;AAC9C,mEAAiD;AACjD,gEAA8C;AAC9C,+DAA6C;AAC7C,gEAA8C;AAC9C,mDAAiC;AACjC,yDAAuC;AACvC,mEAAiD;AACjD,2CAAyB;AACzB,oDAAkC;AAClC,uDAAqC;AACrC,mEAAiD;AACjD,+DAA6C;AAC7C,4EAA0D"}

package/dist/lib/azure/cognitiveSearch/QueryType.d.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 declare enum QueryType {
+    simple = "simple",
+    full = "full"
+}

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

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryType = void 0;
+/**
+ * @description Specifies whether simple or full of query type must be matched
+ * @see https://docs.microsoft.com/en-us/rest/api/searchservice/search-documents
+ */
+var QueryType;
+(function (QueryType) {
+    QueryType["simple"] = "simple";
+    QueryType["full"] = "full";
+})(QueryType = exports.QueryType || (exports.QueryType = {}));
+//# sourceMappingURL=QueryType.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"QueryType.js","sourceRoot":"","sources":["../../../../src/lib/azure/cognitiveSearch/QueryType.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,IAAY,SAGX;AAHD,WAAY,SAAS;IACjB,8BAAiB,CAAA;IACjB,0BAAa,CAAA;AACjB,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB"}

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

@@ -0,0 +1,42 @@
+import { ServiceResponse } from '../../../interfaces';
+import { AzureSearchIndex } from '../../../utils';
+/**
+ * @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 declare class SearchClient {
+    private static instance;
+    private static endpoint;
+    private static credential;
+    private static indexMap;
+    /**
+     * @description To retrieve the instance in the Singleton pattern
+     * @returns {SearchClient} the singleton instance of SearchClient
+     */
+    static getInstance(): Promise<SearchClient>;
+    /**
+     * @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`
+     */
+    query(index: AzureSearchIndex, keyword?: string, options?: any, retryTimes?: number, tracking?: number): Promise<ServiceResponse>;
+    /**
+     * @description To postpone for specific millisecond
+     * @param {number} ms - millisecond to wait for
+     */
+    private sleep;
+}

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

@@ -0,0 +1,166 @@
+"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 __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchClient = void 0;
+const search_documents_1 = require("@azure/search-documents");
+const logger_1 = require("../../logger");
+const azureKeyVault_1 = require("../../azure/azureKeyVault");
+const utils_1 = require("../../../utils");
+const loadConfig_1 = require("../../../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())));
+ */
+class SearchClient {
+    /**
+     * @description To retrieve the instance in the Singleton pattern
+     * @returns {SearchClient} the singleton instance of SearchClient
+     */
+    static getInstance() {
+        return __awaiter(this, void 0, void 0, function* () {
+            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 (loadConfig_1.appConfig === undefined) {
+                try {
+                    yield (0, loadConfig_1.loadConfig)();
+                    if (loadConfig_1.appConfig.keyVaultName === undefined) {
+                        throw new Error('SearchClient/getInstance: empty keyVaultName');
+                    }
+                }
+                catch (err) {
+                    throw err;
+                }
+            }
+            const credentialResp = yield (0, azureKeyVault_1.getKeyVault)(loadConfig_1.appConfig.keyVaultName, utils_1.AzureSearchConfig.credentialSecretName);
+            if (credentialResp.isSuccess === false) {
+                throw new Error('/SearchClient/getInstance(): retrieve search credential failed');
+            }
+            const secret = credentialResp.data;
+            const indexMapResp = yield (0, azureKeyVault_1.getKeyVault)(loadConfig_1.appConfig.keyVaultName, utils_1.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`
+     */
+    query(index, keyword = '*', options, retryTimes = utils_1.AzureSearchConfig.queryRetryDefault, tracking = Math.floor(Math.random() * 100000000000)) {
+        var _a, e_1, _b, _c;
+        return __awaiter(this, void 0, void 0, function* () {
+            logger_1.logger.verbose(`start SearchClient/query: ${tracking}`);
+            let serviceResponse = { isSuccess: false };
+            let searchResults;
+            let curRetry = 0;
+            try {
+                const client = new search_documents_1.SearchClient(SearchClient.endpoint, SearchClient.indexMap[index], new search_documents_1.AzureKeyCredential(SearchClient.credential));
+                while (curRetry < retryTimes) {
+                    try {
+                        logger_1.logger.verbose(`SearchClient/query before sending : ${curRetry}|${tracking}`);
+                        searchResults = yield client.search(keyword, options);
+                        logger_1.logger.verbose(`SearchClient/query after sending : ${curRetry}|${tracking}`);
+                        serviceResponse.data = { document: [] };
+                        try {
+                            for (var _d = true, _e = (e_1 = void 0, __asyncValues(searchResults.results)), _f; _f = yield _e.next(), _a = _f.done, !_a;) {
+                                _c = _f.value;
+                                _d = false;
+                                try {
+                                    const result = _c;
+                                    result.document.score = result.score;
+                                    result.document.highlights = result.highlights;
+                                    serviceResponse.data.document.push(result.document);
+                                }
+                                finally {
+                                    _d = true;
+                                }
+                            }
+                        }
+                        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                        finally {
+                            try {
+                                if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
+                            }
+                            finally { if (e_1) throw e_1.error; }
+                        }
+                        logger_1.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_1.logger.error(`SearchClient/query: fail - ${err}`);
+                    }
+                    if (!serviceResponse.isSuccess) {
+                        logger_1.logger.info(`SearchClient/query: retry - ${curRetry}`);
+                        ++curRetry;
+                        yield this.sleep(utils_1.AzureSearchConfig.retryIntervalSecond * 1000);
+                    }
+                    else {
+                        break;
+                    }
+                }
+            }
+            catch (err) {
+                logger_1.logger.error(`SearchClient/query: ${err}`);
+            }
+            logger_1.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
+     */
+    sleep(ms) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield new Promise(_ => setTimeout(_, ms));
+        });
+    }
+}
+exports.SearchClient = SearchClient;
+//# sourceMappingURL=SearchClient.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SearchClient.js","sourceRoot":"","sources":["../../../../src/lib/azure/cognitiveSearch/SearchClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAAA,8DAAmG;AACnG,yCAAsC;AACtC,6DAAwD;AAExD,0CAAqE;AACrE,qEAA6E;AAG7E;;;;;;;;;;;;;;GAcG;AACH,MAAa,YAAY;IAMrB;;;OAGG;IACH,MAAM,CAAO,WAAW;;YACpB,IAAI,CAAC,CAAC,YAAY,CAAC,QAAQ,EAAE;gBAAE,OAAO,YAAY,CAAC,QAAQ,CAAC;aAAE;YAE9D,YAAY,CAAC,QAAQ,GAAG,IAAI,YAAY,EAAE,CAAC;YAE3C;;;eAGG;YACH,IAAI,sBAAS,KAAK,SAAS,EAAE;gBACzB,IAAI;oBACA,MAAM,IAAA,uBAAU,GAAE,CAAC;oBACnB,IAAI,sBAAS,CAAC,YAAY,KAAK,SAAS,EAAE;wBACtC,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;qBACnE;iBACJ;gBAAC,OAAO,GAAG,EAAE;oBACV,MAAM,GAAG,CAAC;iBACb;aACJ;YAED,MAAM,cAAc,GAAG,MAAM,IAAA,2BAAW,EAAC,sBAAS,CAAC,YAAY,EAAE,yBAAiB,CAAC,oBAAoB,CAAC,CAAC;YAEzG,IAAI,cAAc,CAAC,SAAS,KAAK,KAAK,EAAE;gBACpC,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;aACrF;YAED,MAAM,MAAM,GAA6C,cAAc,CAAC,IAAI,CAAC;YAE7E,MAAM,YAAY,GAAG,MAAM,IAAA,2BAAW,EAAC,sBAAS,CAAC,YAAY,EAAE,yBAAiB,CAAC,eAAe,CAAC,CAAC;YAElG,IAAI,YAAY,CAAC,SAAS,KAAK,KAAK,EAAE;gBAClC,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;aACnF;YAED,YAAY,CAAC,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC;YAC1C,YAAY,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;YACxC,YAAY,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;YAC5C,OAAO,YAAY,CAAC,QAAQ,CAAC;QACjC,CAAC;KAAA;IAED;;;;;;;OAOG;IACG,KAAK,CACP,KAAuB,EACvB,UAAkB,GAAG,EACrB,OAAa,EACb,aAAqB,yBAAiB,CAAC,iBAAiB,EACxD,WAAmB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAC,YAAY,CAAC;;;YAEzD,eAAM,CAAC,OAAO,CAAC,6BAA6B,QAAQ,EAAE,CAAC,CAAC;YACxD,IAAI,eAAe,GAAoB,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;YAC5D,IAAI,aAAkB,CAAC;YACvB,IAAI,QAAQ,GAAG,CAAC,CAAC;YACjB,IAAI;gBAEA,MAAM,MAAM,GAAG,IAAI,+BAAoB,CACnC,YAAY,CAAC,QAAQ,EACrB,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,EAC5B,IAAI,qCAAkB,CAAC,YAAY,CAAC,UAAU,CAAC,CAClD,CAAC;gBAEF,OAAO,QAAQ,GAAG,UAAU,EAAE;oBAC1B,IAAI;wBACA,eAAM,CAAC,OAAO,CAAC,uCAAuC,QAAQ,IAAI,QAAQ,EAAE,CAAC,CAAC;wBAC9E,aAAa,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;wBACtD,eAAM,CAAC,OAAO,CAAC,sCAAsC,QAAQ,IAAI,QAAQ,EAAE,CAAC,CAAC;wBAC7E,eAAe,CAAC,IAAI,GAAG,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;;4BAExC,KAA2B,eAAA,oBAAA,cAAA,aAAa,CAAC,OAAO,CAAA,CAAA,IAAA;gCAArB,cAAqB;gCAArB,WAAqB;;oCAArC,MAAM,MAAM,KAAA,CAAA;oCACnB,MAAM,CAAC,QAAQ,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;oCACrC,MAAM,CAAC,QAAQ,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;oCAC/C,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;;;;;6BACvD;;;;;;;;;wBACD,eAAM,CAAC,OAAO,CAAC,yCAAyC,QAAQ,IAAI,QAAQ,EAAE,CAAC,CAAC;wBAChF,IAAI,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE;4BACxB,eAAe,CAAC,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC;yBACtD;wBAED,IAAI,CAAC,CAAC,aAAa,CAAC,KAAK,EAAE;4BACvB,eAAe,CAAC,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC;yBACpD;wBAED,eAAe,CAAC,SAAS,GAAG,IAAI,CAAC;qBACpC;oBAAC,OAAO,GAAG,EAAE;wBACV,eAAM,CAAC,KAAK,CAAC,8BAA8B,GAAG,EAAE,CAAC,CAAC;qBACrD;oBAED,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE;wBAC5B,eAAM,CAAC,IAAI,CAAC,+BAA+B,QAAQ,EAAE,CAAC,CAAC;wBACvD,EAAE,QAAQ,CAAC;wBACX,MAAM,IAAI,CAAC,KAAK,CAAC,yBAAiB,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAAC;qBAClE;yBAAM;wBACH,MAAM;qBACT;iBACJ;aACJ;YAAC,OAAO,GAAG,EAAE;gBACV,eAAM,CAAC,KAAK,CAAC,uBAAuB,GAAG,EAAE,CAAC,CAAC;aAC9C;YACD,eAAM,CAAC,OAAO,CAAC,4BAA4B,QAAQ,IAAI,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,QAAQ,EAAE,CAAC,CAAC;YAC3G,OAAO,eAAe,CAAC;;KAC1B;IAED;;;OAGG;IACW,KAAK,CAAC,EAAU;;YAC1B,MAAM,IAAI,OAAO,CAAE,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QAC/C,CAAC;KAAA;CACJ;AA7HD,oCA6HC"}

package/dist/lib/azure/cognitiveSearch/SearchFacets.d.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;
+};

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

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

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

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

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

@@ -0,0 +1,68 @@
+/**
+ * @classdesc SearchFilter is the object to construct the Filter when using Azure cognitive search
+ * @property {string} attr - the attribute, so called props, to be filtered by the condition
+ * @property {SearchFilterCondition} condition - the condition to filter, see enum @SearchFilter for more information
+ * @property {any} value - attr should under the condition with value
+ * @property {boolean} isCollection - true if the filed is defined as a collection in Azure Cognitive Search
+ * @property {'any' | 'all'} collectionOperation - collection search settings
+ * @see https://docs.microsoft.com/en-us/azure/search/search-query-understand-collection-filters
+ *
+ * @example
+ * ```ts
+ * const primaryFilter = new SearchFilter('isPrimary', EQUAL, true);
+ * const mentionedCompanyListFilter = new SearchFilter('companyMentioned', CONTAINS, [...]);
+ * ```
+ */
+export declare class SearchFilter {
+    attr: string;
+    condition: SearchFilterCondition;
+    value: any;
+    isCollection: boolean;
+    collectionOperation: 'any' | 'all';
+    constructor(attr: string, condition: SearchFilterCondition, value: any, isCollection?: boolean, collectionOperation?: 'any' | 'all');
+    /**
+     * @description flatten is to compose the instance into a string when using Search
+     * @returns {string} the composite of the instance
+     */
+    flatten(): string;
+}
+/**
+ * @description The condition when filtering an params.
+ */
+export declare enum SearchFilterCondition {
+    contains = "",
+    exclude = "not",
+    equal = "eq",
+    notEqual = "ne",
+    lessThanOrEqual = "le",
+    greaterThanOrEqual = "ge"
+}
+/**
+ * @description The following const params is a easy-to-use type when implementing a SearchFilter,
+ * so that the developers no longer need to call the enum with the class reference
+ */
+export declare const CONTAINS = SearchFilterCondition.contains;
+export declare const EXCLUDE = SearchFilterCondition.exclude;
+export declare const EQUAL = SearchFilterCondition.equal;
+export declare const NOT_EQUAL = SearchFilterCondition.notEqual;
+export declare const LESS_THAN_OR_EQUAL = SearchFilterCondition.lessThanOrEqual;
+export declare const GREATER_THAN_OR_EQUAL = SearchFilterCondition.greaterThanOrEqual;
+/**
+ * @description describe types of combination
+ */
+export declare const enum CombinationType {
+    and = "and",
+    or = "or"
+}
+/**
+ * @description AND helps developers to compose a nested filter for condition AND.
+ * @param {Array<Array<string | SearchFilter>>} args - the arguments which need to be construct into string
+ * @returns {string} aggregation of the given args
+ */
+export declare const AND: (...args: Array<string | SearchFilter>) => string;
+/**
+ * @description OR helps developers to compose a nested filter for condition OR.
+ * @param {Array<Array<string | SearchFilter>>} args - the arguments which need to be construct into string
+ * @returns {string} aggregation of the given args
+ */
+export declare const OR: (...args: Array<string | SearchFilter>) => string;

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

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OR = exports.AND = exports.GREATER_THAN_OR_EQUAL = exports.LESS_THAN_OR_EQUAL = exports.NOT_EQUAL = exports.EQUAL = exports.EXCLUDE = exports.CONTAINS = exports.SearchFilterCondition = exports.SearchFilter = void 0;
+/**
+ * @classdesc SearchFilter is the object to construct the Filter when using Azure cognitive search
+ * @property {string} attr - the attribute, so called props, to be filtered by the condition
+ * @property {SearchFilterCondition} condition - the condition to filter, see enum @SearchFilter for more information
+ * @property {any} value - attr should under the condition with value
+ * @property {boolean} isCollection - true if the filed is defined as a collection in Azure Cognitive Search
+ * @property {'any' | 'all'} collectionOperation - collection search settings
+ * @see https://docs.microsoft.com/en-us/azure/search/search-query-understand-collection-filters
+ *
+ * @example
+ * ```ts
+ * const primaryFilter = new SearchFilter('isPrimary', EQUAL, true);
+ * const mentionedCompanyListFilter = new SearchFilter('companyMentioned', CONTAINS, [...]);
+ * ```
+ */
+class SearchFilter {
+    constructor(attr, condition, value, isCollection = false, collectionOperation = 'any') {
+        this.isCollection = false;
+        this.collectionOperation = 'any';
+        this.attr = attr;
+        this.condition = condition;
+        this.value = value;
+        this.isCollection = isCollection;
+        this.collectionOperation = collectionOperation;
+    }
+    /**
+     * @description flatten is to compose the instance into a string when using Search
+     * @returns {string} the composite of the instance
+     */
+    flatten() {
+        if (this.isCollection) {
+            switch (this.condition) {
+                case exports.CONTAINS:
+                    return `${this.attr}/${this.collectionOperation}(i: search.in(i,'${this.value.toString()}', ','))`;
+                case exports.EXCLUDE:
+                    return `${this.attr}/${this.collectionOperation}(i: not search.in(i,'${this.value.toString()}', ','))`;
+                default:
+                    throw new Error(`SearchFilter/flatten: Unknown condition for collection`);
+            }
+        }
+        else {
+            switch (this.condition) {
+                case exports.EQUAL:
+                case exports.NOT_EQUAL:
+                case exports.LESS_THAN_OR_EQUAL:
+                case exports.GREATER_THAN_OR_EQUAL:
+                    return `${this.attr} ${this.condition} ${typeof (this.value) === 'string' ? `'${this.value}'` : this.value}`;
+                case exports.CONTAINS:
+                    return `search.in(${this.attr}, '${this.value.toString()}', ',')`;
+                case exports.EXCLUDE:
+                    return `${this.condition} search.in(${this.attr}, '${this.value.toString()}', ',')`;
+                default:
+                    throw new Error(`SearchFilter/flatten: Unknown condition`);
+            }
+        }
+    }
+}
+exports.SearchFilter = SearchFilter;
+/**
+ * @description The condition when filtering an params.
+ */
+var SearchFilterCondition;
+(function (SearchFilterCondition) {
+    SearchFilterCondition["contains"] = "";
+    SearchFilterCondition["exclude"] = "not";
+    SearchFilterCondition["equal"] = "eq";
+    SearchFilterCondition["notEqual"] = "ne";
+    SearchFilterCondition["lessThanOrEqual"] = "le";
+    SearchFilterCondition["greaterThanOrEqual"] = "ge";
+})(SearchFilterCondition = exports.SearchFilterCondition || (exports.SearchFilterCondition = {}));
+/**
+ * @description The following const params is a easy-to-use type when implementing a SearchFilter,
+ * so that the developers no longer need to call the enum with the class reference
+ */
+exports.CONTAINS = SearchFilterCondition.contains;
+exports.EXCLUDE = SearchFilterCondition.exclude;
+exports.EQUAL = SearchFilterCondition.equal;
+exports.NOT_EQUAL = SearchFilterCondition.notEqual;
+exports.LESS_THAN_OR_EQUAL = SearchFilterCondition.lessThanOrEqual;
+exports.GREATER_THAN_OR_EQUAL = SearchFilterCondition.greaterThanOrEqual;
+;
+/**
+ * combination is a function ONLY be used for constructing two function: AND and OR,
+ * then it would be express into a string.
+ * @param {CombinationType} type - to indicate the combination type
+ * @param {Array<Array<string | SearchFilter>>} args - the arguments which need to be construct into string
+ * @returns {string} aggregation of the given args
+ */
+const combination = (type, ...args) => {
+    if (args.length === 0) {
+        return '';
+    }
+    function flatten(obj) {
+        return typeof (obj) === 'string' ? obj : obj.flatten();
+    }
+    let res = !!args[0] ? flatten(args[0]) : '';
+    for (let i = 1; i < args.length; ++i) {
+        if (!!args) {
+            res += ` ${type} ${flatten(args[i])}`;
+        }
+    }
+    return `(${res})`;
+};
+/**
+ * @description AND helps developers to compose a nested filter for condition AND.
+ * @param {Array<Array<string | SearchFilter>>} args - the arguments which need to be construct into string
+ * @returns {string} aggregation of the given args
+ */
+const AND = (...args) => {
+    return combination("and" /* CombinationType.and */, ...args);
+};
+exports.AND = AND;
+/**
+ * @description OR helps developers to compose a nested filter for condition OR.
+ * @param {Array<Array<string | SearchFilter>>} args - the arguments which need to be construct into string
+ * @returns {string} aggregation of the given args
+ */
+const OR = (...args) => {
+    return combination("or" /* CombinationType.or */, ...args);
+};
+exports.OR = OR;
+//# sourceMappingURL=SearchFilter.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SearchFilter.js","sourceRoot":"","sources":["../../../../src/lib/azure/cognitiveSearch/SearchFilter.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;GAcG;AACF,MAAa,YAAY;IAOtB,YACI,IAAY,EACZ,SAAgC,EAChC,KAAU,EACV,eAAwB,KAAK,EAC7B,sBAAqC,KAAK;QAR9C,iBAAY,GAAY,KAAK,CAAC;QAC9B,wBAAmB,GAAkB,KAAK,CAAC;QAQvC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;IACnD,CAAC;IAED;;;OAGG;IACH,OAAO;QACH,IAAI,IAAI,CAAC,YAAY,EAAE;YACnB,QAAQ,IAAI,CAAC,SAAS,EAAE;gBACpB,KAAK,gBAAQ;oBACT,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,mBAAmB,oBAAoB,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,UAAU,CAAC;gBACvG,KAAK,eAAO;oBACR,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,mBAAmB,wBAAwB,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,UAAU,CAAC;gBAC3G;oBACI,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;aACjF;SACJ;aAAM;YACH,QAAQ,IAAI,CAAC,SAAS,EAAE;gBACpB,KAAK,aAAK,CAAC;gBACX,KAAK,iBAAS,CAAC;gBACf,KAAK,0BAAkB,CAAC;gBACxB,KAAK,6BAAqB;oBACtB,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,IAAK,OAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAM,EAAE,CAAC;gBAClH,KAAK,gBAAQ;oBACT,OAAO,aAAa,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC;gBACtE,KAAK,eAAO;oBACR,OAAO,GAAG,IAAI,CAAC,SAAS,cAAc,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC;gBACxF;oBACI,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;aAClE;SACJ;IACL,CAAC;CACJ;AAlDA,oCAkDA;AAED;;GAEG;AACH,IAAY,qBAOX;AAPD,WAAY,qBAAqB;IAC7B,sCAAa,CAAA;IACb,wCAAe,CAAA;IACf,qCAAY,CAAA;IACZ,wCAAe,CAAA;IACf,+CAAsB,CAAA;IACtB,kDAAyB,CAAA;AAC7B,CAAC,EAPW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAOhC;AAED;;;GAGG;AACU,QAAA,QAAQ,GAAG,qBAAqB,CAAC,QAAQ,CAAC;AAC1C,QAAA,OAAO,GAAG,qBAAqB,CAAC,OAAO,CAAC;AACxC,QAAA,KAAK,GAAG,qBAAqB,CAAC,KAAK,CAAC;AACpC,QAAA,SAAS,GAAG,qBAAqB,CAAC,QAAQ,CAAC;AAC3C,QAAA,kBAAkB,GAAG,qBAAqB,CAAC,eAAe,CAAC;AAC3D,QAAA,qBAAqB,GAAG,qBAAqB,CAAC,kBAAkB,CAAC;AAQ7E,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,WAAW,GAAG,CAAC,IAAqB,EAAE,GAAG,IAAkC,EAAU,EAAE;IACzF,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QAAE,OAAO,EAAE,CAAC;KAAE;IAErC,SAAS,OAAO,CAAC,GAA0B;QACvC,OAAO,OAAM,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IAC1D,CAAC;IAED,IAAI,GAAG,GAAW,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAEpD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;QAClC,IAAI,CAAC,CAAC,IAAI,EAAE;YACR,GAAG,IAAI,IAAI,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SACzC;KACJ;IAED,OAAO,IAAI,GAAG,GAAG,CAAC;AACtB,CAAC,CAAA;AAED;;;;GAIG;AACI,MAAM,GAAG,GAAG,CAAC,GAAG,IAAkC,EAAU,EAAE;IACjE,OAAO,WAAW,kCAAsB,GAAG,IAAI,CAAC,CAAC;AACrD,CAAC,CAAA;AAFY,QAAA,GAAG,OAEf;AAED;;;;GAIG;AACI,MAAM,EAAE,GAAG,CAAC,GAAG,IAAkC,EAAU,EAAE;IAChE,OAAO,WAAW,gCAAqB,GAAG,IAAI,CAAC,CAAC;AACpD,CAAC,CAAA;AAFY,QAAA,EAAE,MAEd"}

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

@@ -0,0 +1,9 @@
+/**
+ * @description Specifies whether any or all of the search terms must be matched
+ * in order to count the document as a match.
+ * @see https://docs.microsoft.com/en-us/rest/api/searchservice/search-documents
+ */
+export declare enum SearchMode {
+    all = "all",
+    any = "any"
+}

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

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchMode = void 0;
+/**
+ * @description Specifies whether any or all of the search terms must be matched
+ * in order to count the document as a match.
+ * @see https://docs.microsoft.com/en-us/rest/api/searchservice/search-documents
+ */
+var SearchMode;
+(function (SearchMode) {
+    SearchMode["all"] = "all";
+    SearchMode["any"] = "any";
+})(SearchMode = exports.SearchMode || (exports.SearchMode = {}));
+//# sourceMappingURL=SearchMode.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SearchMode.js","sourceRoot":"","sources":["../../../../src/lib/azure/cognitiveSearch/SearchMode.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,IAAY,UAGX;AAHD,WAAY,UAAU;IAClB,yBAAW,CAAA;IACX,yBAAW,CAAA;AACf,CAAC,EAHW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAGrB"}

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

@@ -0,0 +1,88 @@
+import { CombinationType, SearchFilter } from './SearchFilter';
+import { SearchFacets } from './SearchFacets';
+import { SearchOrder } from './SearchOrder';
+import { SearchMode } from './SearchMode';
+import { QueryType } from './QueryType';
+/**
+ * @description SearchOptionType is the interface to connect with the library
+ * @azure/search-documents, it would only be initiated when creating an instance
+ * of class @SearchOption, none of the other functions should access this type declaration.
+ * @property {Array<string>} select - optional, to indicate the select attributes/props.
+ * @property {string | Array<string | SearchFilter>} filter - optional, search with the filter
+ * @property {CombinationType} filterCombinationType - optional, combination type of the filters
+ * @property {Array<SearchOrder>} orderBy - optional, return order
+ * @property {boolean} count - optional, if true, return with the count of the documents.
+ * @property {number} top - optional, total volume when retrieving the data
+ * @property {number} skip - optional, skip how many document
+ * @property {Array<SearchFacets>} facets - optional, retrieve data's facets
+ * @property {SearchMode} searchMode - required, different mode for search
+ */
+type SearchOptionType = {
+    select?: string[];
+    filter?: string | Array<string | SearchFilter>;
+    filterCombinationType?: CombinationType;
+    orderBy?: SearchOrder[];
+    count?: boolean;
+    top?: number;
+    skip?: number;
+    facets?: SearchFacets[];
+    searchMode?: SearchMode;
+    searchFields?: string[];
+    scoringProfile?: string;
+    highlightFields?: string;
+    highlightPreTag?: string;
+    highlightPostTag?: string;
+    queryType?: QueryType;
+};
+/**
+ * @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.
+ */
+export declare class SearchOption {
+    searchOptionType?: SearchOptionType;
+    /**
+     * @description when initializing a SearchOption, the defaultSearchOption
+     * will override the undefined props
+     */
+    static defaultSearchOption: SearchOptionType;
+    constructor(searchOptionType?: SearchOptionType);
+    /**
+     * @description to compose flatten-filter string for @azure/search-documents
+     * @returns {string} flatten-filter string
+     */
+    private composeFilter;
+    /**
+     * @description to compose flatten-order string for @azure/search-documents
+     * @returns {Array<string>} flatten-order string
+     */
+    private composeOrder;
+    /**
+     * @description to compose flatten-facets string for @azure/search-documents
+     * @returns {Array<string>} flatten-facets string
+     */
+    private composeFacets;
+    /**
+     * @description as an adaptor to transform the type for @azure/search-documents
+     * @returns {Object} object which can be accepted by @azure/search-documents
+     */
+    value: () => {
+        select?: string[];
+        filter?: string;
+        orderBy?: string[];
+        includeTotalCount?: boolean;
+        top?: number;
+        skip?: number;
+        facets?: string[];
+        searchMode?: string;
+        searchFields?: string[];
+        scoringProfile?: string;
+        highlightFields?: string;
+        highlightPreTag?: string;
+        highlightPostTag?: string;
+        queryType?: string;
+    };
+}
+export {};