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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (388) hide show
  1. package/dist/index.d.ts +32 -0
  2. package/dist/index.js +49 -0
  3. package/dist/index.js.map +1 -0
  4. package/dist/interfaces/apiResponse.d.ts +7 -0
  5. package/dist/interfaces/apiResponse.js +3 -0
  6. package/dist/interfaces/apiResponse.js.map +1 -0
  7. package/dist/interfaces/grpcListRequest.d.ts +6 -0
  8. package/dist/interfaces/grpcListRequest.js +3 -0
  9. package/dist/interfaces/grpcListRequest.js.map +1 -0
  10. package/dist/interfaces/grpcServiceResponse.d.ts +8 -0
  11. package/dist/interfaces/grpcServiceResponse.js +3 -0
  12. package/dist/interfaces/grpcServiceResponse.js.map +1 -0
  13. package/dist/interfaces/index.d.ts +10 -0
  14. package/dist/interfaces/index.js +26 -0
  15. package/dist/interfaces/index.js.map +1 -0
  16. package/dist/interfaces/internalHttp/request/index.d.ts +1 -0
  17. package/dist/interfaces/internalHttp/request/index.js +18 -0
  18. package/dist/interfaces/internalHttp/request/index.js.map +1 -0
  19. package/dist/interfaces/internalHttp/request/search.d.ts +9 -0
  20. package/dist/interfaces/internalHttp/request/search.js +3 -0
  21. package/dist/interfaces/internalHttp/request/search.js.map +1 -0
  22. package/dist/interfaces/internalHttp/response/index.d.ts +1 -0
  23. package/dist/interfaces/internalHttp/response/index.js +18 -0
  24. package/dist/interfaces/internalHttp/response/index.js.map +1 -0
  25. package/dist/interfaces/internalHttp/response/search.d.ts +10 -0
  26. package/dist/interfaces/internalHttp/response/search.js +3 -0
  27. package/dist/interfaces/internalHttp/response/search.js.map +1 -0
  28. package/dist/interfaces/pagination.d.ts +6 -0
  29. package/dist/interfaces/pagination.js +12 -0
  30. package/dist/interfaces/pagination.js.map +1 -0
  31. package/dist/interfaces/serviceResponse.d.ts +8 -0
  32. package/dist/interfaces/serviceResponse.js +3 -0
  33. package/dist/interfaces/serviceResponse.js.map +1 -0
  34. package/dist/interfaces/subcriptionFeaturePermissionModel.d.ts +8 -0
  35. package/dist/interfaces/subcriptionFeaturePermissionModel.js +14 -0
  36. package/dist/interfaces/subcriptionFeaturePermissionModel.js.map +1 -0
  37. package/dist/interfaces/userInfo.d.ts +17 -0
  38. package/dist/interfaces/userInfo.js +21 -0
  39. package/dist/interfaces/userInfo.js.map +1 -0
  40. package/dist/lib/azure/azureBlobStorage.d.ts +4 -0
  41. package/dist/lib/azure/azureBlobStorage.js +137 -0
  42. package/dist/lib/azure/azureBlobStorage.js.map +1 -0
  43. package/dist/lib/azure/azureKeyVault.d.ts +11 -0
  44. package/dist/lib/azure/azureKeyVault.js +65 -0
  45. package/dist/lib/azure/azureKeyVault.js.map +1 -0
  46. package/dist/lib/azure/azureServiceBusClient.d.ts +47 -0
  47. package/dist/lib/azure/azureServiceBusClient.js +139 -0
  48. package/dist/lib/azure/azureServiceBusClient.js.map +1 -0
  49. package/dist/lib/azure/azureServiceBusQueue.d.ts +1 -0
  50. package/dist/lib/azure/azureServiceBusQueue.js +42 -0
  51. package/dist/lib/azure/azureServiceBusQueue.js.map +1 -0
  52. package/dist/lib/azure/azureStorageQueue.d.ts +1 -0
  53. package/dist/lib/azure/azureStorageQueue.js +26 -0
  54. package/dist/lib/azure/azureStorageQueue.js.map +1 -0
  55. package/dist/lib/azure/azureTableStorage.d.ts +4 -0
  56. package/dist/lib/azure/azureTableStorage.js +67 -0
  57. package/dist/lib/azure/azureTableStorage.js.map +1 -0
  58. package/dist/lib/azure/cognitiveSearch/QueryType.d.ts +8 -0
  59. package/dist/lib/azure/cognitiveSearch/QueryType.js +13 -0
  60. package/dist/lib/azure/cognitiveSearch/QueryType.js.map +1 -0
  61. package/dist/lib/azure/cognitiveSearch/SearchClient.d.ts +42 -0
  62. package/dist/lib/azure/cognitiveSearch/SearchClient.js +161 -0
  63. package/dist/lib/azure/cognitiveSearch/SearchClient.js.map +1 -0
  64. package/dist/lib/azure/cognitiveSearch/SearchFacets.d.ts +16 -0
  65. package/dist/lib/azure/cognitiveSearch/SearchFacets.js +3 -0
  66. package/dist/lib/azure/cognitiveSearch/SearchFacets.js.map +1 -0
  67. package/dist/lib/azure/cognitiveSearch/SearchFilter.d.ts +68 -0
  68. package/dist/lib/azure/cognitiveSearch/SearchFilter.js +125 -0
  69. package/dist/lib/azure/cognitiveSearch/SearchFilter.js.map +1 -0
  70. package/dist/lib/azure/cognitiveSearch/SearchMode.d.ts +9 -0
  71. package/dist/lib/azure/cognitiveSearch/SearchMode.js +14 -0
  72. package/dist/lib/azure/cognitiveSearch/SearchMode.js.map +1 -0
  73. package/dist/lib/azure/cognitiveSearch/SearchOption.d.ts +88 -0
  74. package/dist/lib/azure/cognitiveSearch/SearchOption.js +104 -0
  75. package/dist/lib/azure/cognitiveSearch/SearchOption.js.map +1 -0
  76. package/dist/lib/azure/cognitiveSearch/SearchOrder.d.ts +9 -0
  77. package/dist/lib/azure/cognitiveSearch/SearchOrder.js +3 -0
  78. package/dist/lib/azure/cognitiveSearch/SearchOrder.js.map +1 -0
  79. package/dist/lib/azure/cognitiveSearch/index.d.ts +7 -0
  80. package/dist/lib/azure/cognitiveSearch/index.js +24 -0
  81. package/dist/lib/azure/cognitiveSearch/index.js.map +1 -0
  82. package/dist/lib/azure/index.d.ts +7 -0
  83. package/dist/lib/azure/index.js +24 -0
  84. package/dist/lib/azure/index.js.map +1 -0
  85. package/dist/lib/fetch/index.d.ts +2 -0
  86. package/dist/lib/fetch/index.js +19 -0
  87. package/dist/lib/fetch/index.js.map +1 -0
  88. package/dist/lib/fetch/sendRequest.d.ts +8 -0
  89. package/dist/lib/fetch/sendRequest.js +25 -0
  90. package/dist/lib/fetch/sendRequest.js.map +1 -0
  91. package/dist/lib/fetch/sendRequestWithTimeout.d.ts +9 -0
  92. package/dist/lib/fetch/sendRequestWithTimeout.js +53 -0
  93. package/dist/lib/fetch/sendRequestWithTimeout.js.map +1 -0
  94. package/dist/lib/httpClient.d.ts +4 -0
  95. package/dist/lib/httpClient.js +55 -0
  96. package/dist/lib/httpClient.js.map +1 -0
  97. package/dist/lib/index.d.ts +3 -0
  98. package/dist/lib/index.js +20 -0
  99. package/dist/lib/index.js.map +1 -0
  100. package/dist/lib/redisClient.d.ts +45 -0
  101. package/dist/lib/redisClient.js +153 -0
  102. package/dist/lib/redisClient.js.map +1 -0
  103. package/dist/lib/sendGridClient.d.ts +27 -0
  104. package/dist/lib/sendGridClient.js +62 -0
  105. package/dist/lib/sendGridClient.js.map +1 -0
  106. package/dist/lib/teams/broadcastLogMessage.d.ts +8 -0
  107. package/dist/lib/teams/broadcastLogMessage.js +81 -0
  108. package/dist/lib/teams/broadcastLogMessage.js.map +1 -0
  109. package/dist/lib/teams/index.d.ts +2 -0
  110. package/dist/lib/teams/index.js +19 -0
  111. package/dist/lib/teams/index.js.map +1 -0
  112. package/dist/lib/teams/logMessage.d.ts +51 -0
  113. package/dist/lib/teams/logMessage.js +33 -0
  114. package/dist/lib/teams/logMessage.js.map +1 -0
  115. package/dist/models/baseControllerParameter.d.ts +9 -0
  116. package/dist/models/baseControllerParameter.js +24 -0
  117. package/dist/models/baseControllerParameter.js.map +1 -0
  118. package/dist/models/campaign/grpcCampaignEventModel.d.ts +18 -0
  119. package/dist/models/campaign/grpcCampaignEventModel.js +24 -0
  120. package/dist/models/campaign/grpcCampaignEventModel.js.map +1 -0
  121. package/dist/models/campaign/grpcCampaignEventUserModel.d.ts +13 -0
  122. package/dist/models/campaign/grpcCampaignEventUserModel.js +19 -0
  123. package/dist/models/campaign/grpcCampaignEventUserModel.js.map +1 -0
  124. package/dist/models/campaign/grpcCampaignUserModel.d.ts +12 -0
  125. package/dist/models/campaign/grpcCampaignUserModel.js +16 -0
  126. package/dist/models/campaign/grpcCampaignUserModel.js.map +1 -0
  127. package/dist/models/campaign/index.d.ts +4 -0
  128. package/dist/models/campaign/index.js +10 -0
  129. package/dist/models/campaign/index.js.map +1 -0
  130. package/dist/models/emailtemplate/grpcEmailTemplateModel.d.ts +10 -0
  131. package/dist/models/emailtemplate/grpcEmailTemplateModel.js +16 -0
  132. package/dist/models/emailtemplate/grpcEmailTemplateModel.js.map +1 -0
  133. package/dist/models/emailtemplate/index.d.ts +2 -0
  134. package/dist/models/emailtemplate/index.js +6 -0
  135. package/dist/models/emailtemplate/index.js.map +1 -0
  136. package/dist/models/index.d.ts +10 -0
  137. package/dist/models/index.js +28 -0
  138. package/dist/models/index.js.map +1 -0
  139. package/dist/models/organisation/grpcOrganisationModel.d.ts +15 -0
  140. package/dist/models/organisation/grpcOrganisationModel.js +21 -0
  141. package/dist/models/organisation/grpcOrganisationModel.js.map +1 -0
  142. package/dist/models/organisation/index.d.ts +2 -0
  143. package/dist/models/organisation/index.js +6 -0
  144. package/dist/models/organisation/index.js.map +1 -0
  145. package/dist/models/rbac/grpcRoleModel.d.ts +9 -0
  146. package/dist/models/rbac/grpcRoleModel.js +15 -0
  147. package/dist/models/rbac/grpcRoleModel.js.map +1 -0
  148. package/dist/models/rbac/index.d.ts +2 -0
  149. package/dist/models/rbac/index.js +6 -0
  150. package/dist/models/rbac/index.js.map +1 -0
  151. package/dist/models/scoutai/grpcAIDETrainingResultListModel.d.ts +8 -0
  152. package/dist/models/scoutai/grpcAIDETrainingResultListModel.js +14 -0
  153. package/dist/models/scoutai/grpcAIDETrainingResultListModel.js.map +1 -0
  154. package/dist/models/scoutai/grpcNerlCorrectionModel.d.ts +11 -0
  155. package/dist/models/scoutai/grpcNerlCorrectionModel.js +16 -0
  156. package/dist/models/scoutai/grpcNerlCorrectionModel.js.map +1 -0
  157. package/dist/models/scoutai/grpcScoutAIListReq.d.ts +12 -0
  158. package/dist/models/scoutai/grpcScoutAIListReq.js +17 -0
  159. package/dist/models/scoutai/grpcScoutAIListReq.js.map +1 -0
  160. package/dist/models/scoutai/grpcScoutAIModel.d.ts +10 -0
  161. package/dist/models/scoutai/grpcScoutAIModel.js +16 -0
  162. package/dist/models/scoutai/grpcScoutAIModel.js.map +1 -0
  163. package/dist/models/scoutai/grpcScoutAIResult.d.ts +10 -0
  164. package/dist/models/scoutai/grpcScoutAIResult.js +16 -0
  165. package/dist/models/scoutai/grpcScoutAIResult.js.map +1 -0
  166. package/dist/models/scoutai/grpcTaasConfigAIModel.d.ts +6 -0
  167. package/dist/models/scoutai/grpcTaasConfigAIModel.js +12 -0
  168. package/dist/models/scoutai/grpcTaasConfigAIModel.js.map +1 -0
  169. package/dist/models/scoutai/grpcTaasConfigModel.d.ts +11 -0
  170. package/dist/models/scoutai/grpcTaasConfigModel.js +15 -0
  171. package/dist/models/scoutai/grpcTaasConfigModel.js.map +1 -0
  172. package/dist/models/scoutai/grpcTaasConfigUserModel.d.ts +8 -0
  173. package/dist/models/scoutai/grpcTaasConfigUserModel.js +14 -0
  174. package/dist/models/scoutai/grpcTaasConfigUserModel.js.map +1 -0
  175. package/dist/models/scoutai/grpcTagItemModel.d.ts +9 -0
  176. package/dist/models/scoutai/grpcTagItemModel.js +15 -0
  177. package/dist/models/scoutai/grpcTagItemModel.js.map +1 -0
  178. package/dist/models/scoutai/grpcVisualisationModel.d.ts +11 -0
  179. package/dist/models/scoutai/grpcVisualisationModel.js +15 -0
  180. package/dist/models/scoutai/grpcVisualisationModel.js.map +1 -0
  181. package/dist/models/scoutai/grpcVisualisationPositionModel.d.ts +6 -0
  182. package/dist/models/scoutai/grpcVisualisationPositionModel.js +11 -0
  183. package/dist/models/scoutai/grpcVisualisationPositionModel.js.map +1 -0
  184. package/dist/models/scoutai/index.d.ts +10 -0
  185. package/dist/models/scoutai/index.js +22 -0
  186. package/dist/models/scoutai/index.js.map +1 -0
  187. package/dist/models/search/grpcAggregation.d.ts +9 -0
  188. package/dist/models/search/grpcAggregation.js +14 -0
  189. package/dist/models/search/grpcAggregation.js.map +1 -0
  190. package/dist/models/search/grpcCmsModel.d.ts +5 -0
  191. package/dist/models/search/grpcCmsModel.js +11 -0
  192. package/dist/models/search/grpcCmsModel.js.map +1 -0
  193. package/dist/models/search/grpcCommonModels.d.ts +109 -0
  194. package/dist/models/search/grpcCommonModels.js +80 -0
  195. package/dist/models/search/grpcCommonModels.js.map +1 -0
  196. package/dist/models/search/grpcCompanyAggregation.d.ts +14 -0
  197. package/dist/models/search/grpcCompanyAggregation.js +16 -0
  198. package/dist/models/search/grpcCompanyAggregation.js.map +1 -0
  199. package/dist/models/search/grpcCompanyConnectModel.d.ts +14 -0
  200. package/dist/models/search/grpcCompanyConnectModel.js +18 -0
  201. package/dist/models/search/grpcCompanyConnectModel.js.map +1 -0
  202. package/dist/models/search/grpcCompanyListReq.d.ts +36 -0
  203. package/dist/models/search/grpcCompanyListReq.js +42 -0
  204. package/dist/models/search/grpcCompanyListReq.js.map +1 -0
  205. package/dist/models/search/grpcCompanyModel.d.ts +43 -0
  206. package/dist/models/search/grpcCompanyModel.js +46 -0
  207. package/dist/models/search/grpcCompanyModel.js.map +1 -0
  208. package/dist/models/search/grpcCompanyNewsCountModel.d.ts +9 -0
  209. package/dist/models/search/grpcCompanyNewsCountModel.js +14 -0
  210. package/dist/models/search/grpcCompanyNewsCountModel.js.map +1 -0
  211. package/dist/models/search/grpcCompanyPeriodMentionModel.d.ts +18 -0
  212. package/dist/models/search/grpcCompanyPeriodMentionModel.js +22 -0
  213. package/dist/models/search/grpcCompanyPeriodMentionModel.js.map +1 -0
  214. package/dist/models/search/grpcCompanyPreviewModel.d.ts +26 -0
  215. package/dist/models/search/grpcCompanyPreviewModel.js +31 -0
  216. package/dist/models/search/grpcCompanyPreviewModel.js.map +1 -0
  217. package/dist/models/search/grpcContentAggregation.d.ts +8 -0
  218. package/dist/models/search/grpcContentAggregation.js +7 -0
  219. package/dist/models/search/grpcContentAggregation.js.map +1 -0
  220. package/dist/models/search/grpcContentListReq.d.ts +16 -0
  221. package/dist/models/search/grpcContentListReq.js +22 -0
  222. package/dist/models/search/grpcContentListReq.js.map +1 -0
  223. package/dist/models/search/grpcContentModel.d.ts +32 -0
  224. package/dist/models/search/grpcContentModel.js +37 -0
  225. package/dist/models/search/grpcContentModel.js.map +1 -0
  226. package/dist/models/search/grpcContentPreviewModel.d.ts +28 -0
  227. package/dist/models/search/grpcContentPreviewModel.js +33 -0
  228. package/dist/models/search/grpcContentPreviewModel.js.map +1 -0
  229. package/dist/models/search/grpcContentTabsModel.d.ts +10 -0
  230. package/dist/models/search/grpcContentTabsModel.js +15 -0
  231. package/dist/models/search/grpcContentTabsModel.js.map +1 -0
  232. package/dist/models/search/grpcCountryModel.d.ts +13 -0
  233. package/dist/models/search/grpcCountryModel.js +19 -0
  234. package/dist/models/search/grpcCountryModel.js.map +1 -0
  235. package/dist/models/search/grpcFinancialModel.d.ts +292 -0
  236. package/dist/models/search/grpcFinancialModel.js +7 -0
  237. package/dist/models/search/grpcFinancialModel.js.map +1 -0
  238. package/dist/models/search/grpcMarketModel.d.ts +16 -0
  239. package/dist/models/search/grpcMarketModel.js +6 -0
  240. package/dist/models/search/grpcMarketModel.js.map +1 -0
  241. package/dist/models/search/grpcMentionContentCountModel.d.ts +5 -0
  242. package/dist/models/search/grpcMentionContentCountModel.js +7 -0
  243. package/dist/models/search/grpcMentionContentCountModel.js.map +1 -0
  244. package/dist/models/search/index.d.ts +16 -0
  245. package/dist/models/search/index.js +44 -0
  246. package/dist/models/search/index.js.map +1 -0
  247. package/dist/models/subscription/applicationFeatureModel.d.ts +7 -0
  248. package/dist/models/subscription/applicationFeatureModel.js +12 -0
  249. package/dist/models/subscription/applicationFeatureModel.js.map +1 -0
  250. package/dist/models/subscription/featureModel.d.ts +7 -0
  251. package/dist/models/subscription/featureModel.js +13 -0
  252. package/dist/models/subscription/featureModel.js.map +1 -0
  253. package/dist/models/subscription/grpcSubscriptionModel.d.ts +6 -0
  254. package/dist/models/subscription/grpcSubscriptionModel.js +12 -0
  255. package/dist/models/subscription/grpcSubscriptionModel.js.map +1 -0
  256. package/dist/models/subscription/index.d.ts +10 -0
  257. package/dist/models/subscription/index.js +22 -0
  258. package/dist/models/subscription/index.js.map +1 -0
  259. package/dist/models/subscription/licenseModel.d.ts +6 -0
  260. package/dist/models/subscription/licenseModel.js +12 -0
  261. package/dist/models/subscription/licenseModel.js.map +1 -0
  262. package/dist/models/subscription/licenseUserModel.d.ts +5 -0
  263. package/dist/models/subscription/licenseUserModel.js +11 -0
  264. package/dist/models/subscription/licenseUserModel.js.map +1 -0
  265. package/dist/models/subscription/subscriptionFeatureModel.d.ts +6 -0
  266. package/dist/models/subscription/subscriptionFeatureModel.js +12 -0
  267. package/dist/models/subscription/subscriptionFeatureModel.js.map +1 -0
  268. package/dist/models/subscription/subscriptionModel.d.ts +14 -0
  269. package/dist/models/subscription/subscriptionModel.js +19 -0
  270. package/dist/models/subscription/subscriptionModel.js.map +1 -0
  271. package/dist/models/subscription/subscriptionPlanFeatureModel.d.ts +5 -0
  272. package/dist/models/subscription/subscriptionPlanFeatureModel.js +11 -0
  273. package/dist/models/subscription/subscriptionPlanFeatureModel.js.map +1 -0
  274. package/dist/models/subscription/subscriptionPlanModel.d.ts +15 -0
  275. package/dist/models/subscription/subscriptionPlanModel.js +20 -0
  276. package/dist/models/subscription/subscriptionPlanModel.js.map +1 -0
  277. package/dist/models/user/grpcAccountInfoModel.d.ts +5 -0
  278. package/dist/models/user/grpcAccountInfoModel.js +7 -0
  279. package/dist/models/user/grpcAccountInfoModel.js.map +1 -0
  280. package/dist/models/user/grpcAppUserModel.d.ts +15 -0
  281. package/dist/models/user/grpcAppUserModel.js +20 -0
  282. package/dist/models/user/grpcAppUserModel.js.map +1 -0
  283. package/dist/models/user/grpcAppUserOrganisationStatistic.d.ts +6 -0
  284. package/dist/models/user/grpcAppUserOrganisationStatistic.js +12 -0
  285. package/dist/models/user/grpcAppUserOrganisationStatistic.js.map +1 -0
  286. package/dist/models/user/grpcAppUserRoleModel.d.ts +5 -0
  287. package/dist/models/user/grpcAppUserRoleModel.js +11 -0
  288. package/dist/models/user/grpcAppUserRoleModel.js.map +1 -0
  289. package/dist/models/user/grpcBrowseHistoryModel.d.ts +8 -0
  290. package/dist/models/user/grpcBrowseHistoryModel.js +14 -0
  291. package/dist/models/user/grpcBrowseHistoryModel.js.map +1 -0
  292. package/dist/models/user/grpcDailyDigestUserModel.d.ts +10 -0
  293. package/dist/models/user/grpcDailyDigestUserModel.js +15 -0
  294. package/dist/models/user/grpcDailyDigestUserModel.js.map +1 -0
  295. package/dist/models/user/grpcNotificationSettingModel.d.ts +11 -0
  296. package/dist/models/user/grpcNotificationSettingModel.js +17 -0
  297. package/dist/models/user/grpcNotificationSettingModel.js.map +1 -0
  298. package/dist/models/user/grpcSavedSearchModel.d.ts +8 -0
  299. package/dist/models/user/grpcSavedSearchModel.js +14 -0
  300. package/dist/models/user/grpcSavedSearchModel.js.map +1 -0
  301. package/dist/models/user/grpcSearchHistoryModel.d.ts +7 -0
  302. package/dist/models/user/grpcSearchHistoryModel.js +13 -0
  303. package/dist/models/user/grpcSearchHistoryModel.js.map +1 -0
  304. package/dist/models/user/grpcTargetListEntityModel.d.ts +5 -0
  305. package/dist/models/user/grpcTargetListEntityModel.js +7 -0
  306. package/dist/models/user/grpcTargetListEntityModel.js.map +1 -0
  307. package/dist/models/user/grpcTargetListExportModel.d.ts +8 -0
  308. package/dist/models/user/grpcTargetListExportModel.js +14 -0
  309. package/dist/models/user/grpcTargetListExportModel.js.map +1 -0
  310. package/dist/models/user/grpcTargetListItemModel.d.ts +7 -0
  311. package/dist/models/user/grpcTargetListItemModel.js +13 -0
  312. package/dist/models/user/grpcTargetListItemModel.js.map +1 -0
  313. package/dist/models/user/grpcTargetListModel.d.ts +9 -0
  314. package/dist/models/user/grpcTargetListModel.js +14 -0
  315. package/dist/models/user/grpcTargetListModel.js.map +1 -0
  316. package/dist/models/user/index.d.ts +14 -0
  317. package/dist/models/user/index.js +30 -0
  318. package/dist/models/user/index.js.map +1 -0
  319. package/dist/utils/appConfig.d.ts +45 -0
  320. package/dist/utils/appConfig.js +57 -0
  321. package/dist/utils/appConfig.js.map +1 -0
  322. package/dist/utils/appConst.d.ts +196 -0
  323. package/dist/utils/appConst.js +214 -0
  324. package/dist/utils/appConst.js.map +1 -0
  325. package/dist/utils/authentication/auth.d.ts +2 -0
  326. package/dist/utils/authentication/auth.js +163 -0
  327. package/dist/utils/authentication/auth.js.map +1 -0
  328. package/dist/utils/authentication/role.d.ts +7 -0
  329. package/dist/utils/authentication/role.js +139 -0
  330. package/dist/utils/authentication/role.js.map +1 -0
  331. package/dist/utils/baseClass/appDataSource.d.ts +7 -0
  332. package/dist/utils/baseClass/appDataSource.js +31 -0
  333. package/dist/utils/baseClass/appDataSource.js.map +1 -0
  334. package/dist/utils/baseClass/baseController.d.ts +12 -0
  335. package/dist/utils/baseClass/baseController.js +176 -0
  336. package/dist/utils/baseClass/baseController.js.map +1 -0
  337. package/dist/utils/baseClass/baseService.d.ts +7 -0
  338. package/dist/utils/baseClass/baseService.js +11 -0
  339. package/dist/utils/baseClass/baseService.js.map +1 -0
  340. package/dist/utils/commonUtils/appConfigKeyRetriever.d.ts +7 -0
  341. package/dist/utils/commonUtils/appConfigKeyRetriever.js +43 -0
  342. package/dist/utils/commonUtils/appConfigKeyRetriever.js.map +1 -0
  343. package/dist/utils/commonUtils/appUtils.d.ts +41 -0
  344. package/dist/utils/commonUtils/appUtils.js +236 -0
  345. package/dist/utils/commonUtils/appUtils.js.map +1 -0
  346. package/dist/utils/commonUtils/cronUtils.d.ts +9 -0
  347. package/dist/utils/commonUtils/cronUtils.js +32 -0
  348. package/dist/utils/commonUtils/cronUtils.js.map +1 -0
  349. package/dist/utils/commonUtils/index.d.ts +6 -0
  350. package/dist/utils/commonUtils/index.js +23 -0
  351. package/dist/utils/commonUtils/index.js.map +1 -0
  352. package/dist/utils/commonUtils/jwtUtils.d.ts +3 -0
  353. package/dist/utils/commonUtils/jwtUtils.js +83 -0
  354. package/dist/utils/commonUtils/jwtUtils.js.map +1 -0
  355. package/dist/utils/commonUtils/responseUtils.d.ts +7 -0
  356. package/dist/utils/commonUtils/responseUtils.js +131 -0
  357. package/dist/utils/commonUtils/responseUtils.js.map +1 -0
  358. package/dist/utils/commonUtils/validation.d.ts +6 -0
  359. package/dist/utils/commonUtils/validation.js +92 -0
  360. package/dist/utils/commonUtils/validation.js.map +1 -0
  361. package/dist/utils/documentation/swagger.d.ts +1 -0
  362. package/dist/utils/documentation/swagger.js +44 -0
  363. package/dist/utils/documentation/swagger.js.map +1 -0
  364. package/dist/utils/index.d.ts +2 -0
  365. package/dist/utils/index.js +19 -0
  366. package/dist/utils/index.js.map +1 -0
  367. package/dist/utils/logger/logger.d.ts +1 -0
  368. package/dist/utils/logger/logger.js +58 -0
  369. package/dist/utils/logger/logger.js.map +1 -0
  370. package/dist/utils/logger/morganLogger.d.ts +2 -0
  371. package/dist/utils/logger/morganLogger.js +41 -0
  372. package/dist/utils/logger/morganLogger.js.map +1 -0
  373. package/dist/utils/middleware/handleError.d.ts +2 -0
  374. package/dist/utils/middleware/handleError.js +12 -0
  375. package/dist/utils/middleware/handleError.js.map +1 -0
  376. package/dist/utils/middleware/isPublicUser.d.ts +2 -0
  377. package/dist/utils/middleware/isPublicUser.js +35 -0
  378. package/dist/utils/middleware/isPublicUser.js.map +1 -0
  379. package/dist/utils/middleware/loadConfig.d.ts +128 -0
  380. package/dist/utils/middleware/loadConfig.js +143 -0
  381. package/dist/utils/middleware/loadConfig.js.map +1 -0
  382. package/dist/utils/middleware/overwriteConst.d.ts +1 -0
  383. package/dist/utils/middleware/overwriteConst.js +84 -0
  384. package/dist/utils/middleware/overwriteConst.js.map +1 -0
  385. package/dist/utils/monitoring/apm.d.ts +6 -0
  386. package/dist/utils/monitoring/apm.js +99 -0
  387. package/dist/utils/monitoring/apm.js.map +1 -0
  388. package/package.json +2 -2
@@ -0,0 +1,68 @@
1
+ /**
2
+ * @classdesc SearchFilter is the object to construct the Filter when using Azure cognitive search
3
+ * @property {string} attr - the attribute, so called props, to be filtered by the condition
4
+ * @property {SearchFilterCondition} condition - the condition to filter, see enum @SearchFilter for more information
5
+ * @property {any} value - attr should under the condition with value
6
+ * @property {boolean} isCollection - true if the filed is defined as a collection in Azure Cognitive Search
7
+ * @property {'any' | 'all'} collectionOperation - collection search settings
8
+ * @see https://docs.microsoft.com/en-us/azure/search/search-query-understand-collection-filters
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const primaryFilter = new SearchFilter('isPrimary', EQUAL, true);
13
+ * const mentionedCompanyListFilter = new SearchFilter('companyMentioned', CONTAINS, [...]);
14
+ * ```
15
+ */
16
+ export declare class SearchFilter {
17
+ attr: string;
18
+ condition: SearchFilterCondition;
19
+ value: any;
20
+ isCollection: boolean;
21
+ collectionOperation: 'any' | 'all';
22
+ constructor(attr: string, condition: SearchFilterCondition, value: any, isCollection?: boolean, collectionOperation?: 'any' | 'all');
23
+ /**
24
+ * @description flatten is to compose the instance into a string when using Search
25
+ * @returns {string} the composite of the instance
26
+ */
27
+ flatten(): string;
28
+ }
29
+ /**
30
+ * @description The condition when filtering an params.
31
+ */
32
+ export declare enum SearchFilterCondition {
33
+ contains = "",
34
+ exclude = "not",
35
+ equal = "eq",
36
+ notEqual = "ne",
37
+ lessThanOrEqual = "le",
38
+ greaterThanOrEqual = "ge"
39
+ }
40
+ /**
41
+ * @description The following const params is a easy-to-use type when implementing a SearchFilter,
42
+ * so that the developers no longer need to call the enum with the class reference
43
+ */
44
+ export declare const CONTAINS = SearchFilterCondition.contains;
45
+ export declare const EXCLUDE = SearchFilterCondition.exclude;
46
+ export declare const EQUAL = SearchFilterCondition.equal;
47
+ export declare const NOT_EQUAL = SearchFilterCondition.notEqual;
48
+ export declare const LESS_THAN_OR_EQUAL = SearchFilterCondition.lessThanOrEqual;
49
+ export declare const GREATER_THAN_OR_EQUAL = SearchFilterCondition.greaterThanOrEqual;
50
+ /**
51
+ * @description describe types of combination
52
+ */
53
+ export declare const enum CombinationType {
54
+ and = "and",
55
+ or = "or"
56
+ }
57
+ /**
58
+ * @description AND helps developers to compose a nested filter for condition AND.
59
+ * @param {Array<Array<string | SearchFilter>>} args - the arguments which need to be construct into string
60
+ * @returns {string} aggregation of the given args
61
+ */
62
+ export declare const AND: (...args: Array<string | SearchFilter>) => string;
63
+ /**
64
+ * @description OR helps developers to compose a nested filter for condition OR.
65
+ * @param {Array<Array<string | SearchFilter>>} args - the arguments which need to be construct into string
66
+ * @returns {string} aggregation of the given args
67
+ */
68
+ export declare const OR: (...args: Array<string | SearchFilter>) => string;
@@ -0,0 +1,125 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ 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;
4
+ /**
5
+ * @classdesc SearchFilter is the object to construct the Filter when using Azure cognitive search
6
+ * @property {string} attr - the attribute, so called props, to be filtered by the condition
7
+ * @property {SearchFilterCondition} condition - the condition to filter, see enum @SearchFilter for more information
8
+ * @property {any} value - attr should under the condition with value
9
+ * @property {boolean} isCollection - true if the filed is defined as a collection in Azure Cognitive Search
10
+ * @property {'any' | 'all'} collectionOperation - collection search settings
11
+ * @see https://docs.microsoft.com/en-us/azure/search/search-query-understand-collection-filters
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * const primaryFilter = new SearchFilter('isPrimary', EQUAL, true);
16
+ * const mentionedCompanyListFilter = new SearchFilter('companyMentioned', CONTAINS, [...]);
17
+ * ```
18
+ */
19
+ class SearchFilter {
20
+ constructor(attr, condition, value, isCollection = false, collectionOperation = 'any') {
21
+ this.isCollection = false;
22
+ this.collectionOperation = 'any';
23
+ this.attr = attr;
24
+ this.condition = condition;
25
+ this.value = value;
26
+ this.isCollection = isCollection;
27
+ this.collectionOperation = collectionOperation;
28
+ }
29
+ /**
30
+ * @description flatten is to compose the instance into a string when using Search
31
+ * @returns {string} the composite of the instance
32
+ */
33
+ flatten() {
34
+ if (this.isCollection) {
35
+ switch (this.condition) {
36
+ case exports.CONTAINS:
37
+ return `${this.attr}/${this.collectionOperation}(i: search.in(i,'${this.value.toString()}', ','))`;
38
+ case exports.EXCLUDE:
39
+ return `${this.attr}/${this.collectionOperation}(i: not search.in(i,'${this.value.toString()}', ','))`;
40
+ default:
41
+ throw new Error(`SearchFilter/flatten: Unknown condition for collection`);
42
+ }
43
+ }
44
+ else {
45
+ switch (this.condition) {
46
+ case exports.EQUAL:
47
+ case exports.NOT_EQUAL:
48
+ case exports.LESS_THAN_OR_EQUAL:
49
+ case exports.GREATER_THAN_OR_EQUAL:
50
+ return `${this.attr} ${this.condition} ${typeof (this.value) === 'string' ? `'${this.value}'` : this.value}`;
51
+ case exports.CONTAINS:
52
+ return `search.in(${this.attr}, '${this.value.toString()}', ',')`;
53
+ case exports.EXCLUDE:
54
+ return `${this.condition} search.in(${this.attr}, '${this.value.toString()}', ',')`;
55
+ default:
56
+ throw new Error(`SearchFilter/flatten: Unknown condition`);
57
+ }
58
+ }
59
+ }
60
+ }
61
+ exports.SearchFilter = SearchFilter;
62
+ /**
63
+ * @description The condition when filtering an params.
64
+ */
65
+ var SearchFilterCondition;
66
+ (function (SearchFilterCondition) {
67
+ SearchFilterCondition["contains"] = "";
68
+ SearchFilterCondition["exclude"] = "not";
69
+ SearchFilterCondition["equal"] = "eq";
70
+ SearchFilterCondition["notEqual"] = "ne";
71
+ SearchFilterCondition["lessThanOrEqual"] = "le";
72
+ SearchFilterCondition["greaterThanOrEqual"] = "ge";
73
+ })(SearchFilterCondition || (exports.SearchFilterCondition = SearchFilterCondition = {}));
74
+ /**
75
+ * @description The following const params is a easy-to-use type when implementing a SearchFilter,
76
+ * so that the developers no longer need to call the enum with the class reference
77
+ */
78
+ exports.CONTAINS = SearchFilterCondition.contains;
79
+ exports.EXCLUDE = SearchFilterCondition.exclude;
80
+ exports.EQUAL = SearchFilterCondition.equal;
81
+ exports.NOT_EQUAL = SearchFilterCondition.notEqual;
82
+ exports.LESS_THAN_OR_EQUAL = SearchFilterCondition.lessThanOrEqual;
83
+ exports.GREATER_THAN_OR_EQUAL = SearchFilterCondition.greaterThanOrEqual;
84
+ ;
85
+ /**
86
+ * combination is a function ONLY be used for constructing two function: AND and OR,
87
+ * then it would be express into a string.
88
+ * @param {CombinationType} type - to indicate the combination type
89
+ * @param {Array<Array<string | SearchFilter>>} args - the arguments which need to be construct into string
90
+ * @returns {string} aggregation of the given args
91
+ */
92
+ const combination = (type, ...args) => {
93
+ if (args.length === 0) {
94
+ return '';
95
+ }
96
+ function flatten(obj) {
97
+ return typeof (obj) === 'string' ? obj : obj.flatten();
98
+ }
99
+ let res = !!args[0] ? flatten(args[0]) : '';
100
+ for (let i = 1; i < args.length; ++i) {
101
+ if (!!args) {
102
+ res += ` ${type} ${flatten(args[i])}`;
103
+ }
104
+ }
105
+ return `(${res})`;
106
+ };
107
+ /**
108
+ * @description AND helps developers to compose a nested filter for condition AND.
109
+ * @param {Array<Array<string | SearchFilter>>} args - the arguments which need to be construct into string
110
+ * @returns {string} aggregation of the given args
111
+ */
112
+ const AND = (...args) => {
113
+ return combination("and" /* CombinationType.and */, ...args);
114
+ };
115
+ exports.AND = AND;
116
+ /**
117
+ * @description OR helps developers to compose a nested filter for condition OR.
118
+ * @param {Array<Array<string | SearchFilter>>} args - the arguments which need to be construct into string
119
+ * @returns {string} aggregation of the given args
120
+ */
121
+ const OR = (...args) => {
122
+ return combination("or" /* CombinationType.or */, ...args);
123
+ };
124
+ exports.OR = OR;
125
+ //# sourceMappingURL=SearchFilter.js.map
@@ -0,0 +1 @@
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,CAAC;YACpB,QAAQ,IAAI,CAAC,SAAS,EAAE,CAAC;gBACrB,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;YAClF,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,QAAQ,IAAI,CAAC,SAAS,EAAE,CAAC;gBACrB,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;YACnE,CAAC;QACL,CAAC;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,qCAArB,qBAAqB,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,CAAC;QAAC,OAAO,EAAE,CAAC;IAAC,CAAC;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,CAAC;QACnC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;YACT,GAAG,IAAI,IAAI,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1C,CAAC;IACL,CAAC;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"}
@@ -0,0 +1,9 @@
1
+ /**
2
+ * @description Specifies whether any or all of the search terms must be matched
3
+ * in order to count the document as a match.
4
+ * @see https://docs.microsoft.com/en-us/rest/api/searchservice/search-documents
5
+ */
6
+ export declare enum SearchMode {
7
+ all = "all",
8
+ any = "any"
9
+ }
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.SearchMode = void 0;
4
+ /**
5
+ * @description Specifies whether any or all of the search terms must be matched
6
+ * in order to count the document as a match.
7
+ * @see https://docs.microsoft.com/en-us/rest/api/searchservice/search-documents
8
+ */
9
+ var SearchMode;
10
+ (function (SearchMode) {
11
+ SearchMode["all"] = "all";
12
+ SearchMode["any"] = "any";
13
+ })(SearchMode || (exports.SearchMode = SearchMode = {}));
14
+ //# sourceMappingURL=SearchMode.js.map
@@ -0,0 +1 @@
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,0BAAV,UAAU,QAGrB"}
@@ -0,0 +1,88 @@
1
+ import { CombinationType, SearchFilter } from './SearchFilter';
2
+ import { SearchFacets } from './SearchFacets';
3
+ import { SearchOrder } from './SearchOrder';
4
+ import { SearchMode } from './SearchMode';
5
+ import { QueryType } from './QueryType';
6
+ /**
7
+ * @description SearchOptionType is the interface to connect with the library
8
+ * @azure/search-documents, it would only be initiated when creating an instance
9
+ * of class @SearchOption, none of the other functions should access this type declaration.
10
+ * @property {Array<string>} select - optional, to indicate the select attributes/props.
11
+ * @property {string | Array<string | SearchFilter>} filter - optional, search with the filter
12
+ * @property {CombinationType} filterCombinationType - optional, combination type of the filters
13
+ * @property {Array<SearchOrder>} orderBy - optional, return order
14
+ * @property {boolean} count - optional, if true, return with the count of the documents.
15
+ * @property {number} top - optional, total volume when retrieving the data
16
+ * @property {number} skip - optional, skip how many document
17
+ * @property {Array<SearchFacets>} facets - optional, retrieve data's facets
18
+ * @property {SearchMode} searchMode - required, different mode for search
19
+ */
20
+ type SearchOptionType = {
21
+ select?: string[];
22
+ filter?: string | Array<string | SearchFilter>;
23
+ filterCombinationType?: CombinationType;
24
+ orderBy?: SearchOrder[];
25
+ count?: boolean;
26
+ top?: number;
27
+ skip?: number;
28
+ facets?: SearchFacets[];
29
+ searchMode?: SearchMode;
30
+ searchFields?: string[];
31
+ scoringProfile?: string;
32
+ highlightFields?: string;
33
+ highlightPreTag?: string;
34
+ highlightPostTag?: string;
35
+ queryType?: QueryType;
36
+ };
37
+ /**
38
+ * @classdesc the class is to wrap an option when retrieving the data from
39
+ * @azure/search-documents/query
40
+ * @property searchOptionType - to store the interface of the option, noted that
41
+ * when calling the query, you should use SearchOption.value() instead of using
42
+ * this attribute.
43
+ */
44
+ export declare class SearchOption {
45
+ searchOptionType?: SearchOptionType;
46
+ /**
47
+ * @description when initializing a SearchOption, the defaultSearchOption
48
+ * will override the undefined props
49
+ */
50
+ static defaultSearchOption: SearchOptionType;
51
+ constructor(searchOptionType?: SearchOptionType);
52
+ /**
53
+ * @description to compose flatten-filter string for @azure/search-documents
54
+ * @returns {string} flatten-filter string
55
+ */
56
+ private composeFilter;
57
+ /**
58
+ * @description to compose flatten-order string for @azure/search-documents
59
+ * @returns {Array<string>} flatten-order string
60
+ */
61
+ private composeOrder;
62
+ /**
63
+ * @description to compose flatten-facets string for @azure/search-documents
64
+ * @returns {Array<string>} flatten-facets string
65
+ */
66
+ private composeFacets;
67
+ /**
68
+ * @description as an adaptor to transform the type for @azure/search-documents
69
+ * @returns {Object} object which can be accepted by @azure/search-documents
70
+ */
71
+ value: () => {
72
+ select?: string[];
73
+ filter?: string;
74
+ orderBy?: string[];
75
+ includeTotalCount?: boolean;
76
+ top?: number;
77
+ skip?: number;
78
+ facets?: string[];
79
+ searchMode?: string;
80
+ searchFields?: string[];
81
+ scoringProfile?: string;
82
+ highlightFields?: string;
83
+ highlightPreTag?: string;
84
+ highlightPostTag?: string;
85
+ queryType?: string;
86
+ };
87
+ }
88
+ export {};
@@ -0,0 +1,104 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.SearchOption = void 0;
4
+ const SearchFilter_1 = require("./SearchFilter");
5
+ const SearchMode_1 = require("./SearchMode");
6
+ /**
7
+ * @classdesc the class is to wrap an option when retrieving the data from
8
+ * @azure/search-documents/query
9
+ * @property searchOptionType - to store the interface of the option, noted that
10
+ * when calling the query, you should use SearchOption.value() instead of using
11
+ * this attribute.
12
+ */
13
+ class SearchOption {
14
+ constructor(searchOptionType) {
15
+ /**
16
+ * @description as an adaptor to transform the type for @azure/search-documents
17
+ * @returns {Object} object which can be accepted by @azure/search-documents
18
+ */
19
+ this.value = () => {
20
+ let value = {};
21
+ value.includeTotalCount = this.searchOptionType.count;
22
+ value.select = this.searchOptionType.select;
23
+ value.skip = this.searchOptionType.skip;
24
+ value.top = this.searchOptionType.top;
25
+ value.searchMode = this.searchOptionType.searchMode;
26
+ value.searchFields = this.searchOptionType.searchFields;
27
+ value.scoringProfile = this.searchOptionType.scoringProfile;
28
+ value.highlightFields = this.searchOptionType.highlightFields;
29
+ value.highlightPreTag = this.searchOptionType.highlightPreTag;
30
+ value.highlightPostTag = this.searchOptionType.highlightPostTag;
31
+ value.queryType = this.searchOptionType.queryType;
32
+ if (!!this.searchOptionType.filter) {
33
+ value.filter = this.composeFilter();
34
+ }
35
+ if (!!this.searchOptionType.select && this.searchOptionType.select.length) {
36
+ value.select = this.searchOptionType.select;
37
+ }
38
+ if (!!this.searchOptionType.orderBy && this.searchOptionType.orderBy.length) {
39
+ value.orderBy = this.composeOrder();
40
+ }
41
+ if (!!this.searchOptionType.facets && this.searchOptionType.facets.length) {
42
+ value.facets = this.composeFacets();
43
+ }
44
+ return value;
45
+ };
46
+ // override the default settings if the value is empty from the given OptionType
47
+ this.searchOptionType = Object.assign(Object.assign({}, SearchOption.defaultSearchOption), searchOptionType);
48
+ }
49
+ /**
50
+ * @description to compose flatten-filter string for @azure/search-documents
51
+ * @returns {string} flatten-filter string
52
+ */
53
+ composeFilter() {
54
+ if (typeof (this.searchOptionType.filter) === 'string') {
55
+ return this.searchOptionType.filter;
56
+ }
57
+ return this.searchOptionType.filterCombinationType === "and" /* CombinationType.and */ ?
58
+ (0, SearchFilter_1.AND)(...this.searchOptionType.filter)
59
+ :
60
+ (0, SearchFilter_1.OR)(...this.searchOptionType.filter);
61
+ }
62
+ /**
63
+ * @description to compose flatten-order string for @azure/search-documents
64
+ * @returns {Array<string>} flatten-order string
65
+ */
66
+ composeOrder() {
67
+ return this.searchOptionType.orderBy.map((s) => `${s.attr} ${s.orderBy}`);
68
+ }
69
+ /**
70
+ * @description to compose flatten-facets string for @azure/search-documents
71
+ * @returns {Array<string>} flatten-facets string
72
+ */
73
+ composeFacets() {
74
+ return this.searchOptionType.facets.map((s) => {
75
+ let res = `${s.attr}`;
76
+ if (s.count !== null && s.count !== undefined) {
77
+ res += `,count:${s.count}`;
78
+ }
79
+ if (!!s.sort) {
80
+ res += `,sort:${s.sort}`;
81
+ }
82
+ if (s.interval !== null && s.interval !== undefined) {
83
+ res += `,interval:${s.interval}`;
84
+ }
85
+ if (!!s.timeoffset) {
86
+ res += `,timeoffset:${s.timeoffset}`;
87
+ }
88
+ return res;
89
+ });
90
+ }
91
+ }
92
+ exports.SearchOption = SearchOption;
93
+ /**
94
+ * @description when initializing a SearchOption, the defaultSearchOption
95
+ * will override the undefined props
96
+ */
97
+ SearchOption.defaultSearchOption = {
98
+ count: false,
99
+ top: 50,
100
+ skip: 0,
101
+ searchMode: SearchMode_1.SearchMode.all,
102
+ filterCombinationType: "and" /* CombinationType.and */
103
+ };
104
+ //# sourceMappingURL=SearchOption.js.map
@@ -0,0 +1 @@
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,CAAC;gBACjC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;YACxC,CAAC;YAED,IAAI,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;gBACxE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC;YAChD,CAAC;YAED,IAAI,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,IAAI,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;gBAC1E,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;YACxC,CAAC;YAED,IAAI,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;gBACxE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;YACxC,CAAC;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,CAAC;YAAC,OAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC;QAAC,CAAC;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,CAAC;gBAAC,GAAG,IAAG,UAAU,CAAC,CAAC,KAAK,EAAE,CAAC;YAAC,CAAC;YAC7E,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;gBAAC,GAAG,IAAI,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC;YAAC,CAAC;YAC3C,IAAI,CAAC,CAAC,QAAQ,KAAK,IAAI,IAAI,CAAC,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAAC,GAAG,IAAI,aAAa,CAAC,CAAC,QAAQ,EAAE,CAAC;YAAC,CAAC;YAC1F,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;gBAAC,GAAG,IAAI,eAAe,CAAC,CAAC,UAAU,EAAE,CAAC;YAAC,CAAC;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,AANyB,CAMzB"}
@@ -0,0 +1,9 @@
1
+ /**
2
+ * @description SearchOrder as a type to depict the orderBy props
3
+ * @property {string} attr - the search field which is used to be sorted
4
+ * @property {'desc' | 'asc'} orderBy - descent or ascent
5
+ */
6
+ export type SearchOrder = {
7
+ attr: string;
8
+ orderBy: 'desc' | 'asc';
9
+ };
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=SearchOrder.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SearchOrder.js","sourceRoot":"","sources":["../../../../src/lib/azure/cognitiveSearch/SearchOrder.ts"],"names":[],"mappings":""}
@@ -0,0 +1,7 @@
1
+ export * from './QueryType';
2
+ export * from './SearchClient';
3
+ export * from './SearchFacets';
4
+ export * from './SearchFilter';
5
+ export * from './SearchMode';
6
+ export * from './SearchOption';
7
+ export * from './SearchOrder';
@@ -0,0 +1,24 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./QueryType"), exports);
18
+ __exportStar(require("./SearchClient"), exports);
19
+ __exportStar(require("./SearchFacets"), exports);
20
+ __exportStar(require("./SearchFilter"), exports);
21
+ __exportStar(require("./SearchMode"), exports);
22
+ __exportStar(require("./SearchOption"), exports);
23
+ __exportStar(require("./SearchOrder"), exports);
24
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
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"}
@@ -0,0 +1,7 @@
1
+ export * from './cognitiveSearch';
2
+ export * from './azureBlobStorage';
3
+ export * from './azureKeyVault';
4
+ export * from './azureServiceBusClient';
5
+ export * from './azureServiceBusQueue';
6
+ export * from './azureStorageQueue';
7
+ export * from './azureTableStorage';
@@ -0,0 +1,24 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./cognitiveSearch"), exports);
18
+ __exportStar(require("./azureBlobStorage"), exports);
19
+ __exportStar(require("./azureKeyVault"), exports);
20
+ __exportStar(require("./azureServiceBusClient"), exports);
21
+ __exportStar(require("./azureServiceBusQueue"), exports);
22
+ __exportStar(require("./azureStorageQueue"), exports);
23
+ __exportStar(require("./azureTableStorage"), exports);
24
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
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"}
@@ -0,0 +1,2 @@
1
+ export * from './sendRequest';
2
+ export * from './sendRequestWithTimeout';
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./sendRequest"), exports);
18
+ __exportStar(require("./sendRequestWithTimeout"), exports);
19
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/fetch/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,2DAAyC"}
@@ -0,0 +1,8 @@
1
+ import fetch from 'node-fetch';
2
+ /**
3
+ * @description wrapper of node-fetch
4
+ * @param {string} url - request endpoint
5
+ * @param {any} options - fetch options
6
+ * @returns {any} response
7
+ */
8
+ export declare const sendRequest: (url: string, options: any) => Promise<fetch.Response>;
@@ -0,0 +1,25 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ var __importDefault = (this && this.__importDefault) || function (mod) {
12
+ return (mod && mod.__esModule) ? mod : { "default": mod };
13
+ };
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.sendRequest = void 0;
16
+ const node_fetch_1 = __importDefault(require("node-fetch"));
17
+ /**
18
+ * @description wrapper of node-fetch
19
+ * @param {string} url - request endpoint
20
+ * @param {any} options - fetch options
21
+ * @returns {any} response
22
+ */
23
+ const sendRequest = (url, options) => __awaiter(void 0, void 0, void 0, function* () { return yield (0, node_fetch_1.default)(url, options); });
24
+ exports.sendRequest = sendRequest;
25
+ //# sourceMappingURL=sendRequest.js.map
@@ -0,0 +1 @@
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"}
@@ -0,0 +1,9 @@
1
+ /**
2
+ * @description send a request which will automatically abort within a given time
3
+ * if the request is not response yet
4
+ * @param {string} url - url of request endpoint
5
+ * @param {any} options - fetch option
6
+ * @param {number} abortWithinMs - automatically abort after given millisecond
7
+ * @returns {any} response
8
+ */
9
+ export declare function sendRequestWithTimeout(url: string, options: any, abortWithinMs?: number): Promise<any>;