@openstax/ts-utils 1.33.1 → 1.34.0

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 (504) hide show
  1. package/.cfnlintrc +2 -0
  2. package/.github/CODEOWNERS +1 -0
  3. package/.github/workflows/ci.yml +36 -0
  4. package/.github/workflows/lint.yml +55 -0
  5. package/.nvmrc +1 -0
  6. package/.syncignore +4 -0
  7. package/.syncpackrc +18 -0
  8. package/CONTRIBUTING.md +96 -0
  9. package/LICENSE +661 -0
  10. package/Procfile +1 -0
  11. package/README.md +62 -90
  12. package/app.json +23 -0
  13. package/cspell.json +32 -0
  14. package/deploy/constants.env +21 -0
  15. package/deploy/deploy.bash +157 -0
  16. package/deploy/deployment-alt-region.cfn.yml +70 -0
  17. package/deploy/deployment.cfn.yml +650 -0
  18. package/deploy/destroy-deployment.bash +23 -0
  19. package/deploy/shared.cfn.yml +94 -0
  20. package/docs/lambda-build.md +35 -0
  21. package/package.json +12 -228
  22. package/packages/frontend/README.md +46 -0
  23. package/packages/frontend/package.json +101 -0
  24. package/packages/frontend/public/favicon.ico +0 -0
  25. package/packages/frontend/public/index.html +107 -0
  26. package/packages/frontend/public/maintenance.html +59 -0
  27. package/packages/frontend/public/manifest.json +15 -0
  28. package/packages/frontend/public/robots.txt +3 -0
  29. package/packages/frontend/script/make-certificate.bash +49 -0
  30. package/packages/frontend/script/server/cli.js +11 -0
  31. package/packages/frontend/script/server/index.js +47 -0
  32. package/packages/frontend/script/start.bash +22 -0
  33. package/packages/frontend/script/trust-localhost.bash +7 -0
  34. package/packages/frontend/src/auth/authProvider.ts +10 -0
  35. package/packages/frontend/src/auth/useAuth.ts +33 -0
  36. package/packages/frontend/src/components/Pagination.tsx +26 -0
  37. package/packages/frontend/src/configProvider/index.ts +53 -0
  38. package/packages/frontend/src/configProvider/use.ts +41 -0
  39. package/packages/frontend/src/core/context/services.spec.tsx +39 -0
  40. package/packages/frontend/src/core/context/services.tsx +16 -0
  41. package/packages/frontend/src/core/index.spec.ts +7 -0
  42. package/packages/frontend/src/core/index.ts +20 -0
  43. package/packages/frontend/src/core/services.tsx +14 -0
  44. package/packages/frontend/src/core/types.ts +3 -0
  45. package/packages/frontend/src/example/api.ts +28 -0
  46. package/packages/frontend/src/example/components/Layout.tsx +23 -0
  47. package/packages/frontend/src/example/screens/Home.spec.tsx +68 -0
  48. package/packages/frontend/src/example/screens/Home.tsx +78 -0
  49. package/packages/frontend/src/example/screens/ThingList.spec.tsx +60 -0
  50. package/packages/frontend/src/example/screens/ThingList.tsx +75 -0
  51. package/packages/frontend/src/example/screens/ThingView.spec.tsx +71 -0
  52. package/packages/frontend/src/example/screens/ThingView.tsx +47 -0
  53. package/packages/frontend/src/example/screens/index.ts +9 -0
  54. package/packages/frontend/src/index.css +159 -0
  55. package/packages/frontend/src/index.tsx +67 -0
  56. package/packages/frontend/src/react-app-env.d.ts +1 -0
  57. package/packages/frontend/src/routing/components/RouteLink.spec.tsx +55 -0
  58. package/packages/frontend/src/routing/components/RouteLink.tsx +35 -0
  59. package/packages/frontend/src/routing/middleware.ts +6 -0
  60. package/packages/frontend/src/routing/useQuery.ts +14 -0
  61. package/packages/frontend/src/setupProxy.js +19 -0
  62. package/packages/frontend/src/setupTests.ts +9 -0
  63. package/packages/frontend/src/tests/testServices.tsx +23 -0
  64. package/packages/frontend/tsconfig.json +27 -0
  65. package/packages/lambda/.eslintrc.js +64 -0
  66. package/packages/lambda/jest-global-setup.js +3 -0
  67. package/packages/lambda/jest-setup-after-env.js +1 -0
  68. package/packages/lambda/jest.config.js +31 -0
  69. package/packages/lambda/jest.resolver.js +17 -0
  70. package/packages/lambda/package.json +68 -0
  71. package/packages/lambda/script/build.bash +19 -0
  72. package/packages/lambda/script/bundle-functions.bash +10 -0
  73. package/packages/lambda/script/lambdaLocalProxy.js +16 -0
  74. package/packages/lambda/script/lambdaLocalProxy.spec.ts +147 -0
  75. package/packages/lambda/script/utils/getRouteData.ts +7 -0
  76. package/packages/lambda/script/utils/routeDataLoader.js +8 -0
  77. package/packages/lambda/script/utils/routeDataLoader.spec.ts +8 -0
  78. package/packages/lambda/src/functions/serviceApi/core/index.ts +7 -0
  79. package/packages/lambda/src/functions/serviceApi/core/request.spec.ts +38 -0
  80. package/packages/lambda/src/functions/serviceApi/core/request.ts +42 -0
  81. package/packages/lambda/src/functions/serviceApi/core/routes.spec.ts +7 -0
  82. package/packages/lambda/src/functions/serviceApi/core/routes.ts +10 -0
  83. package/packages/lambda/src/functions/serviceApi/core/services.ts +9 -0
  84. package/packages/lambda/src/functions/serviceApi/core/types.ts +13 -0
  85. package/packages/lambda/src/functions/serviceApi/entry/lambda/https-xray.ts +4 -0
  86. package/packages/lambda/src/functions/serviceApi/entry/lambda/index.spec.ts +48 -0
  87. package/packages/lambda/src/functions/serviceApi/entry/lambda/index.ts +58 -0
  88. package/packages/lambda/src/functions/serviceApi/entry/lambda/services.ts +36 -0
  89. package/packages/lambda/src/functions/serviceApi/entry/local.ts +71 -0
  90. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentSearchMiddleware.spec.ts +16 -0
  91. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentSearchMiddleware.ts +41 -0
  92. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentStoreMiddleware.spec.ts +78 -0
  93. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentStoreMiddleware.ts +70 -0
  94. package/packages/lambda/src/functions/serviceApi/versions/v0/example/routes.spec.ts +306 -0
  95. package/packages/lambda/src/functions/serviceApi/versions/v0/example/routes.ts +176 -0
  96. package/packages/lambda/src/functions/serviceApi/versions/v0/index.spec.ts +263 -0
  97. package/packages/lambda/src/functions/serviceApi/versions/v0/index.ts +134 -0
  98. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/authMiddleware.spec.ts +23 -0
  99. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/authMiddleware.ts +32 -0
  100. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/configMiddleware.spec.ts +10 -0
  101. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/configMiddleware.ts +7 -0
  102. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/frontendFileServerMiddleware.spec.ts +13 -0
  103. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/frontendFileServerMiddleware.ts +23 -0
  104. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/paginationMiddleware.spec.ts +9 -0
  105. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/paginationMiddleware.ts +9 -0
  106. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/searchMiddleware.spec.ts +12 -0
  107. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/searchMiddleware.ts +21 -0
  108. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/userRoleValidatorMiddleware.spec.ts +21 -0
  109. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/userRoleValidatorMiddleware.ts +18 -0
  110. package/packages/lambda/tsconfig.json +30 -0
  111. package/packages/lambda/webpack.config.js +97 -0
  112. package/packages/utils/.eslintrc.js +64 -0
  113. package/packages/utils/README.md +118 -0
  114. package/packages/utils/jest-global-setup.js +3 -0
  115. package/packages/utils/jest.config.js +25 -0
  116. package/packages/utils/jest.resolver.js +17 -0
  117. package/packages/utils/package.json +238 -0
  118. package/packages/utils/src/assertions/index.spec.ts +126 -0
  119. package/{dist/esm/assertions/index.js → packages/utils/src/assertions/index.ts} +64 -49
  120. package/packages/utils/src/aws/ssmService.ts +7 -0
  121. package/packages/utils/src/config/awsParameterConfig.ts +24 -0
  122. package/packages/utils/src/config/envConfig.ts +58 -0
  123. package/packages/utils/src/config/index.spec.ts +165 -0
  124. package/{dist/esm/config/index.d.ts → packages/utils/src/config/index.ts} +29 -13
  125. package/packages/utils/src/config/lambdaParameterConfig.ts +49 -0
  126. package/{dist/esm/config/replaceConfig.js → packages/utils/src/config/replaceConfig.ts} +16 -6
  127. package/packages/utils/src/config/resolveConfigValue.ts +10 -0
  128. package/packages/utils/src/errors/index.spec.ts +35 -0
  129. package/{dist/esm/errors/index.js → packages/utils/src/errors/index.ts} +57 -41
  130. package/packages/utils/src/fetch/fetchStatusRetry.spec.ts +197 -0
  131. package/packages/utils/src/fetch/fetchStatusRetry.ts +33 -0
  132. package/packages/utils/src/fetch/index.spec.ts +34 -0
  133. package/packages/utils/src/fetch/index.ts +87 -0
  134. package/packages/utils/src/guards/index.spec.ts +58 -0
  135. package/{dist/esm/guards/index.d.ts → packages/utils/src/guards/index.ts} +10 -7
  136. package/packages/utils/src/index.spec.ts +471 -0
  137. package/packages/utils/src/middleware/apiErrorHandler.spec.ts +65 -0
  138. package/packages/utils/src/middleware/apiErrorHandler.ts +67 -0
  139. package/packages/utils/src/middleware/apiSlowResponseMiddleware.spec.ts +184 -0
  140. package/packages/utils/src/middleware/apiSlowResponseMiddleware.ts +71 -0
  141. package/packages/utils/src/middleware/index.spec.ts +99 -0
  142. package/{dist/cjs/middleware/index.d.ts → packages/utils/src/middleware/index.ts} +53 -5
  143. package/packages/utils/src/middleware/lambdaCorsResponseMiddleware.spec.ts +103 -0
  144. package/packages/utils/src/middleware/lambdaCorsResponseMiddleware.ts +52 -0
  145. package/packages/utils/src/middleware/throwNotFoundMiddleware.spec.ts +20 -0
  146. package/packages/utils/src/middleware/throwNotFoundMiddleware.ts +11 -0
  147. package/packages/utils/src/misc/hashValue.ts +18 -0
  148. package/packages/utils/src/misc/helpers.ts +259 -0
  149. package/packages/utils/src/misc/merge.ts +48 -0
  150. package/{dist/esm/misc/partitionSequence.js → packages/utils/src/misc/partitionSequence.ts} +23 -15
  151. package/packages/utils/src/pagination/index.spec.ts +150 -0
  152. package/packages/utils/src/pagination/index.ts +117 -0
  153. package/{dist/esm/routing/helpers.js → packages/utils/src/routing/helpers.ts} +42 -30
  154. package/packages/utils/src/routing/index.spec.ts +553 -0
  155. package/packages/utils/src/routing/index.ts +424 -0
  156. package/packages/utils/src/routing/validators/zod.spec.ts +16 -0
  157. package/packages/utils/src/routing/validators/zod.ts +14 -0
  158. package/packages/utils/src/services/accountsGateway/README.md +3 -0
  159. package/packages/utils/src/services/accountsGateway/index.spec.ts +518 -0
  160. package/packages/utils/src/services/accountsGateway/index.ts +251 -0
  161. package/packages/utils/src/services/apiGateway/README.md +93 -0
  162. package/packages/utils/src/services/apiGateway/index.spec.ts +254 -0
  163. package/packages/utils/src/services/apiGateway/index.ts +189 -0
  164. package/packages/utils/src/services/authProvider/README.md +21 -0
  165. package/packages/utils/src/services/authProvider/browser.spec.ts +391 -0
  166. package/packages/utils/src/services/authProvider/browser.ts +209 -0
  167. package/packages/utils/src/services/authProvider/decryption.spec.ts +337 -0
  168. package/packages/utils/src/services/authProvider/decryption.ts +98 -0
  169. package/packages/utils/src/services/authProvider/index.ts +93 -0
  170. package/packages/utils/src/services/authProvider/stub.spec.ts +29 -0
  171. package/packages/utils/src/services/authProvider/subrequest.spec.ts +105 -0
  172. package/packages/utils/src/services/authProvider/subrequest.ts +68 -0
  173. package/packages/utils/src/services/authProvider/utils/decryptAndVerify.spec.ts +128 -0
  174. package/packages/utils/src/services/authProvider/utils/decryptAndVerify.ts +106 -0
  175. package/packages/utils/src/services/authProvider/utils/embeddedAuthProvider.spec.ts +26 -0
  176. package/packages/utils/src/services/authProvider/utils/embeddedAuthProvider.ts +57 -0
  177. package/packages/utils/src/services/authProvider/utils/userRoleValidator.spec.ts +135 -0
  178. package/packages/utils/src/services/authProvider/utils/userRoleValidator.ts +49 -0
  179. package/packages/utils/src/services/authProvider/utils/userSubrequest.spec.ts +26 -0
  180. package/packages/utils/src/services/authProvider/utils/userSubrequest.ts +10 -0
  181. package/packages/utils/src/services/documentStore/dynamoEncoding.ts +57 -0
  182. package/packages/utils/src/services/documentStore/fileSystemAssert.spec.ts +43 -0
  183. package/packages/utils/src/services/documentStore/fileSystemAssert.ts +10 -0
  184. package/{dist/cjs/services/documentStore/index.d.ts → packages/utils/src/services/documentStore/index.ts} +8 -8
  185. package/packages/utils/src/services/documentStore/unversioned/README.md +13 -0
  186. package/packages/utils/src/services/documentStore/unversioned/dynamodb.spec.ts +859 -0
  187. package/packages/utils/src/services/documentStore/unversioned/dynamodb.ts +243 -0
  188. package/packages/utils/src/services/documentStore/unversioned/file-system.spec.ts +629 -0
  189. package/packages/utils/src/services/documentStore/unversioned/file-system.ts +194 -0
  190. package/{dist/cjs/services/documentStore/unversioned/index.d.ts → packages/utils/src/services/documentStore/unversioned/index.ts} +2 -0
  191. package/packages/utils/src/services/documentStore/versioned/README.md +13 -0
  192. package/packages/utils/src/services/documentStore/versioned/dynamodb.spec.ts +376 -0
  193. package/packages/utils/src/services/documentStore/versioned/dynamodb.ts +167 -0
  194. package/packages/utils/src/services/documentStore/versioned/file-system.spec.ts +262 -0
  195. package/packages/utils/src/services/documentStore/versioned/file-system.ts +90 -0
  196. package/packages/utils/src/services/documentStore/versioned/index.ts +25 -0
  197. package/packages/utils/src/services/exercisesGateway/README.md +5 -0
  198. package/packages/utils/src/services/exercisesGateway/index.spec.ts +326 -0
  199. package/packages/utils/src/services/exercisesGateway/index.ts +163 -0
  200. package/packages/utils/src/services/fileServer/index.spec.ts +88 -0
  201. package/packages/utils/src/services/fileServer/index.ts +43 -0
  202. package/packages/utils/src/services/fileServer/localFileServer.spec.ts +182 -0
  203. package/packages/utils/src/services/fileServer/localFileServer.ts +159 -0
  204. package/packages/utils/src/services/fileServer/s3FileServer.spec.ts +266 -0
  205. package/packages/utils/src/services/fileServer/s3FileServer.ts +155 -0
  206. package/packages/utils/src/services/launchParams/index.spec.ts +366 -0
  207. package/packages/utils/src/services/launchParams/signer.ts +73 -0
  208. package/packages/utils/src/services/launchParams/verifier.ts +120 -0
  209. package/packages/utils/src/services/logger/console.spec.ts +29 -0
  210. package/{dist/esm/services/logger/console.js → packages/utils/src/services/logger/console.ts} +5 -2
  211. package/packages/utils/src/services/logger/index.spec.ts +65 -0
  212. package/{dist/esm/services/logger/index.d.ts → packages/utils/src/services/logger/index.ts} +23 -9
  213. package/packages/utils/src/services/lrsGateway/README.md +5 -0
  214. package/packages/utils/src/services/lrsGateway/addStatementDefaultFields.ts +22 -0
  215. package/packages/utils/src/services/lrsGateway/attempt-utils.spec.ts +847 -0
  216. package/packages/utils/src/services/lrsGateway/attempt-utils.ts +358 -0
  217. package/packages/utils/src/services/lrsGateway/file-system.spec.ts +363 -0
  218. package/packages/utils/src/services/lrsGateway/file-system.ts +165 -0
  219. package/packages/utils/src/services/lrsGateway/index.spec.ts +194 -0
  220. package/packages/utils/src/services/lrsGateway/index.ts +257 -0
  221. package/packages/utils/src/services/lrsGateway/xapiUtils.spec.ts +887 -0
  222. package/packages/utils/src/services/lrsGateway/xapiUtils.ts +262 -0
  223. package/packages/utils/src/services/postgresConnection/index.spec.ts +170 -0
  224. package/packages/utils/src/services/postgresConnection/index.ts +84 -0
  225. package/packages/utils/src/services/searchProvider/README.md +3 -0
  226. package/packages/utils/src/services/searchProvider/index.ts +59 -0
  227. package/packages/utils/src/services/searchProvider/memorySearchTheBadWay.spec.ts +526 -0
  228. package/packages/utils/src/services/searchProvider/memorySearchTheBadWay.ts +223 -0
  229. package/packages/utils/src/services/searchProvider/openSearch.spec.ts +926 -0
  230. package/packages/utils/src/services/searchProvider/openSearch.ts +195 -0
  231. package/{dist/esm/types.d.ts → packages/utils/src/types.ts} +34 -6
  232. package/packages/utils/tsconfig.json +31 -0
  233. package/packages/utils/tsconfig.without-specs.cjs.json +7 -0
  234. package/packages/utils/tsconfig.without-specs.esm.json +7 -0
  235. package/packages/utils/tsconfig.without-specs.json +6 -0
  236. package/scripts/build.bash +24 -0
  237. package/scripts/ci.bash +10 -0
  238. package/scripts/start.bash +29 -0
  239. package/dist/cjs/assertions/index.d.ts +0 -89
  240. package/dist/cjs/assertions/index.js +0 -157
  241. package/dist/cjs/aws/ssmService.d.ts +0 -5
  242. package/dist/cjs/aws/ssmService.js +0 -9
  243. package/dist/cjs/config/awsParameterConfig.d.ts +0 -10
  244. package/dist/cjs/config/awsParameterConfig.js +0 -26
  245. package/dist/cjs/config/envConfig.d.ts +0 -24
  246. package/dist/cjs/config/envConfig.js +0 -57
  247. package/dist/cjs/config/index.d.ts +0 -48
  248. package/dist/cjs/config/index.js +0 -35
  249. package/dist/cjs/config/lambdaParameterConfig.d.ts +0 -12
  250. package/dist/cjs/config/lambdaParameterConfig.js +0 -45
  251. package/dist/cjs/config/replaceConfig.d.ts +0 -14
  252. package/dist/cjs/config/replaceConfig.js +0 -22
  253. package/dist/cjs/config/resolveConfigValue.d.ts +0 -5
  254. package/dist/cjs/config/resolveConfigValue.js +0 -12
  255. package/dist/cjs/errors/index.d.ts +0 -88
  256. package/dist/cjs/errors/index.js +0 -123
  257. package/dist/cjs/fetch/fetchStatusRetry.d.ts +0 -8
  258. package/dist/cjs/fetch/fetchStatusRetry.js +0 -27
  259. package/dist/cjs/fetch/index.d.ts +0 -64
  260. package/dist/cjs/fetch/index.js +0 -55
  261. package/dist/cjs/guards/index.d.ts +0 -38
  262. package/dist/cjs/guards/index.js +0 -44
  263. package/dist/cjs/index.js +0 -20
  264. package/dist/cjs/middleware/apiErrorHandler.d.ts +0 -24
  265. package/dist/cjs/middleware/apiErrorHandler.js +0 -42
  266. package/dist/cjs/middleware/apiSlowResponseMiddleware.d.ts +0 -23
  267. package/dist/cjs/middleware/apiSlowResponseMiddleware.js +0 -54
  268. package/dist/cjs/middleware/index.js +0 -48
  269. package/dist/cjs/middleware/lambdaCorsResponseMiddleware.d.ts +0 -20
  270. package/dist/cjs/middleware/lambdaCorsResponseMiddleware.js +0 -44
  271. package/dist/cjs/middleware/throwNotFoundMiddleware.d.ts +0 -4
  272. package/dist/cjs/middleware/throwNotFoundMiddleware.js +0 -14
  273. package/dist/cjs/misc/hashValue.d.ts +0 -10
  274. package/dist/cjs/misc/hashValue.js +0 -17
  275. package/dist/cjs/misc/helpers.d.ts +0 -124
  276. package/dist/cjs/misc/helpers.js +0 -214
  277. package/dist/cjs/misc/merge.d.ts +0 -21
  278. package/dist/cjs/misc/merge.js +0 -45
  279. package/dist/cjs/misc/partitionSequence.d.ts +0 -35
  280. package/dist/cjs/misc/partitionSequence.js +0 -55
  281. package/dist/cjs/pagination/index.d.ts +0 -91
  282. package/dist/cjs/pagination/index.js +0 -83
  283. package/dist/cjs/routing/helpers.d.ts +0 -57
  284. package/dist/cjs/routing/helpers.js +0 -90
  285. package/dist/cjs/routing/index.d.ts +0 -290
  286. package/dist/cjs/routing/index.js +0 -295
  287. package/dist/cjs/routing/validators/zod.d.ts +0 -4
  288. package/dist/cjs/routing/validators/zod.js +0 -14
  289. package/dist/cjs/services/accountsGateway/index.d.ts +0 -92
  290. package/dist/cjs/services/accountsGateway/index.js +0 -138
  291. package/dist/cjs/services/apiGateway/index.d.ts +0 -68
  292. package/dist/cjs/services/apiGateway/index.js +0 -118
  293. package/dist/cjs/services/authProvider/browser.d.ts +0 -40
  294. package/dist/cjs/services/authProvider/browser.js +0 -155
  295. package/dist/cjs/services/authProvider/decryption.d.ts +0 -19
  296. package/dist/cjs/services/authProvider/decryption.js +0 -73
  297. package/dist/cjs/services/authProvider/index.d.ts +0 -63
  298. package/dist/cjs/services/authProvider/index.js +0 -34
  299. package/dist/cjs/services/authProvider/subrequest.d.ts +0 -13
  300. package/dist/cjs/services/authProvider/subrequest.js +0 -49
  301. package/dist/cjs/services/authProvider/utils/decryptAndVerify.d.ts +0 -28
  302. package/dist/cjs/services/authProvider/utils/decryptAndVerify.js +0 -91
  303. package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.d.ts +0 -26
  304. package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.js +0 -47
  305. package/dist/cjs/services/authProvider/utils/userRoleValidator.d.ts +0 -13
  306. package/dist/cjs/services/authProvider/utils/userRoleValidator.js +0 -37
  307. package/dist/cjs/services/authProvider/utils/userSubrequest.d.ts +0 -3
  308. package/dist/cjs/services/authProvider/utils/userSubrequest.js +0 -13
  309. package/dist/cjs/services/documentStore/dynamoEncoding.d.ts +0 -10
  310. package/dist/cjs/services/documentStore/dynamoEncoding.js +0 -52
  311. package/dist/cjs/services/documentStore/fileSystemAssert.d.ts +0 -1
  312. package/dist/cjs/services/documentStore/fileSystemAssert.js +0 -14
  313. package/dist/cjs/services/documentStore/index.js +0 -2
  314. package/dist/cjs/services/documentStore/unversioned/dynamodb.d.ts +0 -31
  315. package/dist/cjs/services/documentStore/unversioned/dynamodb.js +0 -233
  316. package/dist/cjs/services/documentStore/unversioned/file-system.d.ts +0 -32
  317. package/dist/cjs/services/documentStore/unversioned/file-system.js +0 -214
  318. package/dist/cjs/services/documentStore/unversioned/index.js +0 -2
  319. package/dist/cjs/services/documentStore/versioned/dynamodb.d.ts +0 -25
  320. package/dist/cjs/services/documentStore/versioned/dynamodb.js +0 -143
  321. package/dist/cjs/services/documentStore/versioned/file-system.d.ts +0 -25
  322. package/dist/cjs/services/documentStore/versioned/file-system.js +0 -73
  323. package/dist/cjs/services/documentStore/versioned/index.d.ts +0 -17
  324. package/dist/cjs/services/documentStore/versioned/index.js +0 -2
  325. package/dist/cjs/services/exercisesGateway/index.d.ts +0 -67
  326. package/dist/cjs/services/exercisesGateway/index.js +0 -107
  327. package/dist/cjs/services/fileServer/index.d.ts +0 -30
  328. package/dist/cjs/services/fileServer/index.js +0 -19
  329. package/dist/cjs/services/fileServer/localFileServer.d.ts +0 -13
  330. package/dist/cjs/services/fileServer/localFileServer.js +0 -132
  331. package/dist/cjs/services/fileServer/s3FileServer.d.ts +0 -14
  332. package/dist/cjs/services/fileServer/s3FileServer.js +0 -132
  333. package/dist/cjs/services/launchParams/index.js +0 -7
  334. package/dist/cjs/services/launchParams/signer.d.ts +0 -23
  335. package/dist/cjs/services/launchParams/signer.js +0 -58
  336. package/dist/cjs/services/launchParams/verifier.d.ts +0 -21
  337. package/dist/cjs/services/launchParams/verifier.js +0 -129
  338. package/dist/cjs/services/logger/console.d.ts +0 -4
  339. package/dist/cjs/services/logger/console.js +0 -12
  340. package/dist/cjs/services/logger/index.d.ts +0 -39
  341. package/dist/cjs/services/logger/index.js +0 -31
  342. package/dist/cjs/services/lrsGateway/addStatementDefaultFields.d.ts +0 -5
  343. package/dist/cjs/services/lrsGateway/addStatementDefaultFields.js +0 -21
  344. package/dist/cjs/services/lrsGateway/attempt-utils.d.ts +0 -70
  345. package/dist/cjs/services/lrsGateway/attempt-utils.js +0 -258
  346. package/dist/cjs/services/lrsGateway/file-system.d.ts +0 -15
  347. package/dist/cjs/services/lrsGateway/file-system.js +0 -150
  348. package/dist/cjs/services/lrsGateway/index.d.ts +0 -122
  349. package/dist/cjs/services/lrsGateway/index.js +0 -148
  350. package/dist/cjs/services/lrsGateway/xapiUtils.d.ts +0 -68
  351. package/dist/cjs/services/lrsGateway/xapiUtils.js +0 -109
  352. package/dist/cjs/services/postgresConnection/index.d.ts +0 -28
  353. package/dist/cjs/services/postgresConnection/index.js +0 -65
  354. package/dist/cjs/services/searchProvider/index.d.ts +0 -67
  355. package/dist/cjs/services/searchProvider/index.js +0 -2
  356. package/dist/cjs/services/searchProvider/memorySearchTheBadWay.d.ts +0 -20
  357. package/dist/cjs/services/searchProvider/memorySearchTheBadWay.js +0 -191
  358. package/dist/cjs/services/searchProvider/openSearch.d.ts +0 -28
  359. package/dist/cjs/services/searchProvider/openSearch.js +0 -154
  360. package/dist/cjs/tsconfig.without-specs.cjs.tsbuildinfo +0 -1
  361. package/dist/cjs/types.d.ts +0 -31
  362. package/dist/cjs/types.js +0 -2
  363. package/dist/esm/assertions/index.d.ts +0 -89
  364. package/dist/esm/aws/ssmService.d.ts +0 -5
  365. package/dist/esm/aws/ssmService.js +0 -6
  366. package/dist/esm/config/awsParameterConfig.d.ts +0 -10
  367. package/dist/esm/config/awsParameterConfig.js +0 -22
  368. package/dist/esm/config/envConfig.d.ts +0 -24
  369. package/dist/esm/config/envConfig.js +0 -53
  370. package/dist/esm/config/index.js +0 -17
  371. package/dist/esm/config/lambdaParameterConfig.d.ts +0 -12
  372. package/dist/esm/config/lambdaParameterConfig.js +0 -38
  373. package/dist/esm/config/replaceConfig.d.ts +0 -14
  374. package/dist/esm/config/resolveConfigValue.d.ts +0 -5
  375. package/dist/esm/config/resolveConfigValue.js +0 -8
  376. package/dist/esm/errors/index.d.ts +0 -88
  377. package/dist/esm/fetch/fetchStatusRetry.d.ts +0 -8
  378. package/dist/esm/fetch/fetchStatusRetry.js +0 -23
  379. package/dist/esm/fetch/index.d.ts +0 -64
  380. package/dist/esm/fetch/index.js +0 -46
  381. package/dist/esm/guards/index.js +0 -36
  382. package/dist/esm/index.d.ts +0 -4
  383. package/dist/esm/index.js +0 -4
  384. package/dist/esm/middleware/apiErrorHandler.d.ts +0 -24
  385. package/dist/esm/middleware/apiErrorHandler.js +0 -38
  386. package/dist/esm/middleware/apiSlowResponseMiddleware.d.ts +0 -23
  387. package/dist/esm/middleware/apiSlowResponseMiddleware.js +0 -50
  388. package/dist/esm/middleware/index.d.ts +0 -47
  389. package/dist/esm/middleware/index.js +0 -44
  390. package/dist/esm/middleware/lambdaCorsResponseMiddleware.d.ts +0 -20
  391. package/dist/esm/middleware/lambdaCorsResponseMiddleware.js +0 -40
  392. package/dist/esm/middleware/throwNotFoundMiddleware.d.ts +0 -4
  393. package/dist/esm/middleware/throwNotFoundMiddleware.js +0 -10
  394. package/dist/esm/misc/hashValue.d.ts +0 -10
  395. package/dist/esm/misc/hashValue.js +0 -13
  396. package/dist/esm/misc/helpers.d.ts +0 -124
  397. package/dist/esm/misc/helpers.js +0 -199
  398. package/dist/esm/misc/merge.d.ts +0 -21
  399. package/dist/esm/misc/merge.js +0 -40
  400. package/dist/esm/misc/partitionSequence.d.ts +0 -35
  401. package/dist/esm/pagination/index.d.ts +0 -91
  402. package/dist/esm/pagination/index.js +0 -77
  403. package/dist/esm/routing/helpers.d.ts +0 -57
  404. package/dist/esm/routing/index.d.ts +0 -290
  405. package/dist/esm/routing/index.js +0 -246
  406. package/dist/esm/routing/validators/zod.d.ts +0 -4
  407. package/dist/esm/routing/validators/zod.js +0 -10
  408. package/dist/esm/services/accountsGateway/index.d.ts +0 -92
  409. package/dist/esm/services/accountsGateway/index.js +0 -131
  410. package/dist/esm/services/apiGateway/index.d.ts +0 -68
  411. package/dist/esm/services/apiGateway/index.js +0 -77
  412. package/dist/esm/services/authProvider/browser.d.ts +0 -40
  413. package/dist/esm/services/authProvider/browser.js +0 -151
  414. package/dist/esm/services/authProvider/decryption.d.ts +0 -19
  415. package/dist/esm/services/authProvider/decryption.js +0 -69
  416. package/dist/esm/services/authProvider/index.d.ts +0 -63
  417. package/dist/esm/services/authProvider/index.js +0 -26
  418. package/dist/esm/services/authProvider/subrequest.d.ts +0 -13
  419. package/dist/esm/services/authProvider/subrequest.js +0 -45
  420. package/dist/esm/services/authProvider/utils/decryptAndVerify.d.ts +0 -28
  421. package/dist/esm/services/authProvider/utils/decryptAndVerify.js +0 -85
  422. package/dist/esm/services/authProvider/utils/embeddedAuthProvider.d.ts +0 -26
  423. package/dist/esm/services/authProvider/utils/embeddedAuthProvider.js +0 -40
  424. package/dist/esm/services/authProvider/utils/userRoleValidator.d.ts +0 -13
  425. package/dist/esm/services/authProvider/utils/userRoleValidator.js +0 -33
  426. package/dist/esm/services/authProvider/utils/userSubrequest.d.ts +0 -3
  427. package/dist/esm/services/authProvider/utils/userSubrequest.js +0 -6
  428. package/dist/esm/services/documentStore/dynamoEncoding.d.ts +0 -10
  429. package/dist/esm/services/documentStore/dynamoEncoding.js +0 -45
  430. package/dist/esm/services/documentStore/fileSystemAssert.d.ts +0 -1
  431. package/dist/esm/services/documentStore/fileSystemAssert.js +0 -10
  432. package/dist/esm/services/documentStore/index.d.ts +0 -14
  433. package/dist/esm/services/documentStore/index.js +0 -1
  434. package/dist/esm/services/documentStore/unversioned/dynamodb.d.ts +0 -31
  435. package/dist/esm/services/documentStore/unversioned/dynamodb.js +0 -226
  436. package/dist/esm/services/documentStore/unversioned/file-system.d.ts +0 -32
  437. package/dist/esm/services/documentStore/unversioned/file-system.js +0 -174
  438. package/dist/esm/services/documentStore/unversioned/index.d.ts +0 -2
  439. package/dist/esm/services/documentStore/unversioned/index.js +0 -1
  440. package/dist/esm/services/documentStore/versioned/dynamodb.d.ts +0 -25
  441. package/dist/esm/services/documentStore/versioned/dynamodb.js +0 -139
  442. package/dist/esm/services/documentStore/versioned/file-system.d.ts +0 -25
  443. package/dist/esm/services/documentStore/versioned/file-system.js +0 -69
  444. package/dist/esm/services/documentStore/versioned/index.d.ts +0 -17
  445. package/dist/esm/services/documentStore/versioned/index.js +0 -1
  446. package/dist/esm/services/exercisesGateway/index.d.ts +0 -67
  447. package/dist/esm/services/exercisesGateway/index.js +0 -70
  448. package/dist/esm/services/fileServer/index.d.ts +0 -30
  449. package/dist/esm/services/fileServer/index.js +0 -13
  450. package/dist/esm/services/fileServer/localFileServer.d.ts +0 -13
  451. package/dist/esm/services/fileServer/localFileServer.js +0 -125
  452. package/dist/esm/services/fileServer/s3FileServer.d.ts +0 -14
  453. package/dist/esm/services/fileServer/s3FileServer.js +0 -125
  454. package/dist/esm/services/launchParams/index.d.ts +0 -2
  455. package/dist/esm/services/launchParams/index.js +0 -2
  456. package/dist/esm/services/launchParams/signer.d.ts +0 -23
  457. package/dist/esm/services/launchParams/signer.js +0 -51
  458. package/dist/esm/services/launchParams/verifier.d.ts +0 -21
  459. package/dist/esm/services/launchParams/verifier.js +0 -92
  460. package/dist/esm/services/logger/console.d.ts +0 -4
  461. package/dist/esm/services/logger/index.js +0 -27
  462. package/dist/esm/services/lrsGateway/addStatementDefaultFields.d.ts +0 -5
  463. package/dist/esm/services/lrsGateway/addStatementDefaultFields.js +0 -14
  464. package/dist/esm/services/lrsGateway/attempt-utils.d.ts +0 -70
  465. package/dist/esm/services/lrsGateway/attempt-utils.js +0 -236
  466. package/dist/esm/services/lrsGateway/file-system.d.ts +0 -15
  467. package/dist/esm/services/lrsGateway/file-system.js +0 -110
  468. package/dist/esm/services/lrsGateway/index.d.ts +0 -122
  469. package/dist/esm/services/lrsGateway/index.js +0 -111
  470. package/dist/esm/services/lrsGateway/xapiUtils.d.ts +0 -68
  471. package/dist/esm/services/lrsGateway/xapiUtils.js +0 -99
  472. package/dist/esm/services/postgresConnection/index.d.ts +0 -28
  473. package/dist/esm/services/postgresConnection/index.js +0 -58
  474. package/dist/esm/services/searchProvider/index.d.ts +0 -67
  475. package/dist/esm/services/searchProvider/index.js +0 -1
  476. package/dist/esm/services/searchProvider/memorySearchTheBadWay.d.ts +0 -20
  477. package/dist/esm/services/searchProvider/memorySearchTheBadWay.js +0 -187
  478. package/dist/esm/services/searchProvider/openSearch.d.ts +0 -28
  479. package/dist/esm/services/searchProvider/openSearch.js +0 -150
  480. package/dist/esm/tsconfig.without-specs.esm.tsbuildinfo +0 -1
  481. package/dist/esm/types.js +0 -1
  482. package/script/bin/.init-params-script.bash.swp +0 -0
  483. /package/{script → packages/utils/script}/bin/copy-from-template.bash +0 -0
  484. /package/{script → packages/utils/script}/bin/delete-stack.bash +0 -0
  485. /package/{script → packages/utils/script}/bin/deploy.bash +0 -0
  486. /package/{script → packages/utils/script}/bin/destroy-deployment.bash +0 -0
  487. /package/{script → packages/utils/script}/bin/empty-bucket.bash +0 -0
  488. /package/{script → packages/utils/script}/bin/get-arg.bash +0 -0
  489. /package/{script → packages/utils/script}/bin/get-deployed-environments.bash +0 -0
  490. /package/{script → packages/utils/script}/bin/get-env-param.bash +0 -0
  491. /package/{script → packages/utils/script}/bin/get-kwarg.bash +0 -0
  492. /package/{script → packages/utils/script}/bin/get-stack-param.bash +0 -0
  493. /package/{script → packages/utils/script}/bin/has-flag.bash +0 -0
  494. /package/{script → packages/utils/script}/bin/init-constants-script.bash +0 -0
  495. /package/{script → packages/utils/script}/bin/init-params-script.bash +0 -0
  496. /package/{script → packages/utils/script}/bin/stack-exists.bash +0 -0
  497. /package/{script → packages/utils/script}/bin/update-utils.bash +0 -0
  498. /package/{script → packages/utils/script}/bin/upload-pager-duty-endpoints.bash +0 -0
  499. /package/{script → packages/utils/script}/bin/upload-params.bash +0 -0
  500. /package/{script → packages/utils/script}/bin/which.bash +0 -0
  501. /package/{script → packages/utils/script}/bin-entry.bash +0 -0
  502. /package/{script → packages/utils/script}/build.bash +0 -0
  503. /package/{dist/cjs/index.d.ts → packages/utils/src/index.ts} +0 -0
  504. /package/{dist/cjs/services/launchParams/index.d.ts → packages/utils/src/services/launchParams/index.ts} +0 -0
@@ -0,0 +1,926 @@
1
+ // cspell:ignore opensearch, Sigv
2
+ import { Client } from '@opensearch-project/opensearch';
3
+ import { SearchResponse } from '@opensearch-project/opensearch/api/types';
4
+ import { IndexConfig, openSearchService } from './openSearch';
5
+ import { SearchOptions } from '.';
6
+
7
+ jest.mock('@aws-sdk/credential-provider-node', () => ({
8
+ defaultProvider: jest.fn(() => () => Promise.resolve({
9
+ accessKeyId: 'test',
10
+ secretAccessKey: 'test',
11
+ sessionToken: 'test'
12
+ }))
13
+ }));
14
+
15
+ jest.mock('@opensearch-project/opensearch');
16
+ jest.mock('@opensearch-project/opensearch/aws', () => ({
17
+ AwsSigv4Signer: jest.fn(() => ({}))
18
+ }));
19
+
20
+ describe('openSearchService', () => {
21
+ type TestDoc = {
22
+ id: string;
23
+ title: string;
24
+ description: string;
25
+ tags: string[];
26
+ };
27
+
28
+ const indexConfig: IndexConfig = {
29
+ name: 'test-index',
30
+ mappings: {
31
+ title: { type: 'text' },
32
+ description: { type: 'text' },
33
+ tags: { type: 'keyword' }
34
+ },
35
+ pageSize: 15
36
+ };
37
+
38
+ const mockConfigProvider = {
39
+ deployed: {
40
+ node: jest.fn(() => Promise.resolve('https://opensearch.openstax.org')),
41
+ region: jest.fn(() => Promise.resolve('us-east-1'))
42
+ }
43
+ };
44
+
45
+ const mockClient = {
46
+ indices: {
47
+ exists: jest.fn(),
48
+ create: jest.fn(),
49
+ delete: jest.fn(),
50
+ putMapping: jest.fn(),
51
+ },
52
+ index: jest.fn(),
53
+ bulk: jest.fn(),
54
+ search: jest.fn(),
55
+ };
56
+
57
+ beforeEach(() => {
58
+ jest.clearAllMocks();
59
+ (Client as jest.Mock).mockImplementation(() => mockClient);
60
+ });
61
+
62
+ describe('initialization', () => {
63
+ it('should set up AwsSigv4Signer with correct parameters and getCredentials', async () => {
64
+ const mockAwsSigv4Signer = require('@opensearch-project/opensearch/aws').AwsSigv4Signer;
65
+ const mockDefaultProvider = require('@aws-sdk/credential-provider-node').defaultProvider;
66
+
67
+ mockAwsSigv4Signer.mockClear();
68
+
69
+ const mockCredentialProvider = jest.fn(() => Promise.resolve({
70
+ accessKeyId: 'test-key',
71
+ secretAccessKey: 'test-secret'
72
+ }));
73
+ mockDefaultProvider.mockReturnValue(mockCredentialProvider);
74
+
75
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
76
+
77
+ try {
78
+ await service.ensureIndexCreated();
79
+ } catch (e) {
80
+ // ignore error, we just want the signer to be called
81
+ }
82
+
83
+ expect(mockAwsSigv4Signer).toHaveBeenCalled();
84
+ expect(mockAwsSigv4Signer.mock.calls[0][0].service).toBe('es');
85
+
86
+ const getCredentials = mockAwsSigv4Signer.mock.calls[0][0].getCredentials;
87
+ await getCredentials();
88
+
89
+ expect(mockDefaultProvider).toHaveBeenCalled();
90
+ expect(mockCredentialProvider).toHaveBeenCalled();
91
+ });
92
+ });
93
+
94
+ describe('pagination configuration', () => {
95
+ it('should use default pageSize', async () => {
96
+ const service = openSearchService()(mockConfigProvider)<TestDoc>({...indexConfig, pageSize: undefined });
97
+
98
+ const searchOptions: SearchOptions = {
99
+ query: 'test',
100
+ fields: [{ key: 'title', type: 'text', weight: 1 }],
101
+ page: 2
102
+ };
103
+
104
+ mockClient.search.mockResolvedValueOnce({
105
+ statusCode: 200,
106
+ body: {
107
+ hits: {
108
+ total: { value: 25 },
109
+ hits: []
110
+ }
111
+ }
112
+ });
113
+
114
+ await service.search(searchOptions);
115
+
116
+ expect(mockClient.search).toHaveBeenCalledWith(
117
+ expect.objectContaining({
118
+ body: expect.objectContaining({
119
+ size: 10,
120
+ from: 10
121
+ })
122
+ })
123
+ );
124
+ });
125
+
126
+ it('should use custom pageSize', async () => {
127
+ const customIndexConfig = { ...indexConfig, pageSize: 25 };
128
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(customIndexConfig);
129
+
130
+ const searchOptions: SearchOptions = {
131
+ query: 'test',
132
+ fields: [{ key: 'title', type: 'text', weight: 1 }],
133
+ page: 2
134
+ };
135
+
136
+ mockClient.search.mockResolvedValueOnce({
137
+ statusCode: 200,
138
+ body: {
139
+ hits: {
140
+ total: { value: 100 },
141
+ hits: []
142
+ }
143
+ }
144
+ });
145
+
146
+ const result = await service.search(searchOptions);
147
+
148
+ expect(mockClient.search).toHaveBeenCalledWith(
149
+ expect.objectContaining({
150
+ body: expect.objectContaining({
151
+ size: 25,
152
+ from: 25
153
+ })
154
+ })
155
+ );
156
+
157
+ expect(result.pageSize).toBe(25);
158
+ expect(result.totalPages).toBe(4);
159
+ });
160
+ });
161
+
162
+ describe('ensureIndexCreated', () => {
163
+ it('should create index if it does not exist', async () => {
164
+ mockClient.indices.exists.mockResolvedValueOnce({ body: false });
165
+
166
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
167
+ await service.ensureIndexCreated();
168
+
169
+ expect(mockClient.indices.exists).toHaveBeenCalledWith({ index: 'test-index' });
170
+ expect(mockClient.indices.create).toHaveBeenCalledWith({
171
+ index: 'test-index',
172
+ body: {
173
+ mappings: {
174
+ dynamic: false,
175
+ properties: indexConfig.mappings
176
+ }
177
+ }
178
+ });
179
+ });
180
+
181
+ it('should not create index if it already exists', async () => {
182
+ mockClient.indices.exists.mockResolvedValueOnce({ body: true });
183
+
184
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
185
+ await service.ensureIndexCreated();
186
+
187
+ expect(mockClient.indices.exists).toHaveBeenCalledWith({ index: 'test-index' });
188
+ expect(mockClient.indices.create).not.toHaveBeenCalled();
189
+ });
190
+ });
191
+
192
+ describe('deleteIndexIfExists', () => {
193
+ it('should delete index if it exists', async () => {
194
+ mockClient.indices.exists.mockResolvedValueOnce({ body: true });
195
+
196
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
197
+ await service.deleteIndexIfExists();
198
+
199
+ expect(mockClient.indices.exists).toHaveBeenCalledWith({ index: 'test-index' });
200
+ expect(mockClient.indices.delete).toHaveBeenCalledWith({ index: 'test-index' });
201
+ });
202
+
203
+ it('should not delete index if it does not exist', async () => {
204
+ mockClient.indices.exists.mockResolvedValueOnce({ body: false });
205
+
206
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
207
+ await service.deleteIndexIfExists();
208
+
209
+ expect(mockClient.indices.exists).toHaveBeenCalledWith({ index: 'test-index' });
210
+ expect(mockClient.indices.delete).not.toHaveBeenCalled();
211
+ });
212
+ });
213
+
214
+ describe('index', () => {
215
+ it('should index a document', async () => {
216
+ const doc: TestDoc = {
217
+ id: '123',
218
+ title: 'Test Document',
219
+ description: 'This is a test document',
220
+ tags: ['test', 'document']
221
+ };
222
+
223
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
224
+ await service.index({ id: '123', body: doc });
225
+
226
+ expect(mockClient.index).toHaveBeenCalledWith({
227
+ index: 'test-index',
228
+ body: doc,
229
+ id: '123',
230
+ refresh: true
231
+ }, expect.anything());
232
+ });
233
+ });
234
+
235
+ describe('bulkIndex', () => {
236
+ it('should index a document', async () => {
237
+ const doc: TestDoc = {
238
+ id: '123',
239
+ title: 'Test Document',
240
+ description: 'This is a test document',
241
+ tags: ['test', 'document']
242
+ };
243
+
244
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
245
+ await service.bulkIndex([{ id: '123', body: doc }]);
246
+
247
+ expect(mockClient.bulk).toHaveBeenCalledWith({
248
+ index: 'test-index',
249
+ body: [
250
+ { index: { _id: '123' } },
251
+ doc
252
+ ],
253
+ refresh: true
254
+ }, expect.anything());
255
+ });
256
+ });
257
+
258
+ describe('search', () => {
259
+ it('should search with query and return results', async () => {
260
+ const searchOptions: SearchOptions = {
261
+ query: 'test',
262
+ fields: [
263
+ { key: 'title', weight: 2 },
264
+ { key: 'description', type: 'text', weight: 1 }
265
+ ],
266
+ page: 2
267
+ };
268
+
269
+ const mockResponse = {
270
+ statusCode: 200,
271
+ body: {
272
+ hits: {
273
+ total: { value: 30 },
274
+ hits: [
275
+ { _source: { id: '1', title: 'Doc 1', description: 'Desc 1', tags: ['a'] } },
276
+ { _source: { id: '2', title: 'Doc 2', description: 'Desc 2', tags: ['b'] } },
277
+ ]
278
+ }
279
+ }
280
+ } as unknown as SearchResponse<TestDoc>;
281
+
282
+ mockClient.search.mockResolvedValueOnce(mockResponse);
283
+
284
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
285
+ const result = await service.search(searchOptions);
286
+
287
+ expect(mockClient.search).toHaveBeenCalledWith({
288
+ index: 'test-index',
289
+ body: expect.objectContaining({
290
+ query: {
291
+ bool: {
292
+ must: [{
293
+ multi_match: {
294
+ fields: ['title^2', 'description^1'],
295
+ query: 'test'
296
+ }
297
+ }]
298
+ }
299
+ },
300
+ size: 15,
301
+ from: 15
302
+ })
303
+ });
304
+
305
+ expect(result).toEqual({
306
+ items: [
307
+ { id: '1', title: 'Doc 1', description: 'Desc 1', tags: ['a'] },
308
+ { id: '2', title: 'Doc 2', description: 'Desc 2', tags: ['b'] }
309
+ ],
310
+ pageSize: 15,
311
+ currentPage: 2,
312
+ totalItems: 30,
313
+ totalPages: 2
314
+ });
315
+ });
316
+
317
+ it('should handle filter conditions', async () => {
318
+ const searchOptions: SearchOptions = {
319
+ query: 'test',
320
+ filter: [
321
+ { key: 'tags', value: ['test'] }
322
+ ],
323
+ fields: [{ key: 'title', type: 'text', weight: 2 }]
324
+ };
325
+
326
+ const mockResponse = {
327
+ statusCode: 200,
328
+ body: {
329
+ hits: {
330
+ total: 5,
331
+ hits: [
332
+ { _source: { id: '1', title: 'Test Doc', description: 'Test', tags: ['test'] } }
333
+ ]
334
+ }
335
+ }
336
+ } as unknown as SearchResponse<TestDoc>;
337
+
338
+ mockClient.search.mockResolvedValueOnce(mockResponse);
339
+
340
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
341
+ const result = await service.search(searchOptions);
342
+
343
+ expect(mockClient.search).toHaveBeenCalledWith({
344
+ index: 'test-index',
345
+ body: expect.objectContaining({
346
+ query: {
347
+ bool: {
348
+ filter: [
349
+ { terms: { tags: ['test'] } }
350
+ ],
351
+ must: [{
352
+ multi_match: {
353
+ fields: ['title^2'],
354
+ query: 'test'
355
+ },
356
+ }]
357
+ }
358
+ }
359
+ })
360
+ });
361
+
362
+ expect(result.totalItems).toBe(5);
363
+ expect(result.items).toHaveLength(1);
364
+ });
365
+
366
+ it('should handle must conditions', async () => {
367
+ const searchOptions: SearchOptions = {
368
+ query: 'test',
369
+ must: [
370
+ { key: 'tags', value: ['test'] }
371
+ ],
372
+ fields: [{ key: 'title', type: 'text', weight: 2 }]
373
+ };
374
+
375
+ const mockResponse = {
376
+ statusCode: 200,
377
+ body: {
378
+ hits: {
379
+ total: 5,
380
+ hits: [
381
+ { _source: { id: '1', title: 'Test Doc', description: 'Test', tags: ['test'] } }
382
+ ]
383
+ }
384
+ }
385
+ } as unknown as SearchResponse<TestDoc>;
386
+
387
+ mockClient.search.mockResolvedValueOnce(mockResponse);
388
+
389
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
390
+ const result = await service.search(searchOptions);
391
+
392
+ expect(mockClient.search).toHaveBeenCalledWith({
393
+ index: 'test-index',
394
+ body: expect.objectContaining({
395
+ query: {
396
+ bool: {
397
+ must: [
398
+ {multi_match: {
399
+ fields: ['title^2'],
400
+ query: 'test'
401
+ }},
402
+ { terms: { tags: ['test'] } }
403
+ ],
404
+ }
405
+ }
406
+ })
407
+ });
408
+
409
+ expect(result.totalItems).toBe(5);
410
+ expect(result.items).toHaveLength(1);
411
+ });
412
+
413
+ it('should handle must conditions with no query', async () => {
414
+ const searchOptions: SearchOptions = {
415
+ query: '',
416
+ must: [
417
+ { key: 'tags', value: ['test'] }
418
+ ],
419
+ fields: [{ key: 'title', type: 'text', weight: 2 }]
420
+ };
421
+
422
+ const mockResponse = {
423
+ statusCode: 200,
424
+ body: {
425
+ hits: {
426
+ total: 5,
427
+ hits: [
428
+ { _source: { id: '1', title: 'Test Doc', description: 'Test', tags: ['test'] } }
429
+ ]
430
+ }
431
+ }
432
+ } as unknown as SearchResponse<TestDoc>;
433
+
434
+ mockClient.search.mockResolvedValueOnce(mockResponse);
435
+
436
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
437
+ const result = await service.search(searchOptions);
438
+
439
+ expect(mockClient.search).toHaveBeenCalledWith({
440
+ index: 'test-index',
441
+ body: expect.objectContaining({
442
+ query: {
443
+ bool: {
444
+ must: [
445
+ { terms: { tags: ['test'] } }
446
+ ],
447
+ }
448
+ }
449
+ })
450
+ });
451
+
452
+ expect(result.totalItems).toBe(5);
453
+ expect(result.items).toHaveLength(1);
454
+ });
455
+
456
+ it('should handle must_not conditions', async () => {
457
+ const searchOptions: SearchOptions = {
458
+ query: 'test',
459
+ must_not: [
460
+ { key: 'tags', value: ['hidden'] }
461
+ ],
462
+ fields: [{ key: 'title', type: 'text', weight: 2 }]
463
+ };
464
+
465
+ const mockResponse = {
466
+ statusCode: 200,
467
+ body: {
468
+ hits: {
469
+ total: { value: 10 },
470
+ hits: [
471
+ { _source: { id: '1', title: 'Visible Doc', description: 'Test', tags: ['visible'] } }
472
+ ]
473
+ }
474
+ }
475
+ } as unknown as SearchResponse<TestDoc>;
476
+
477
+ mockClient.search.mockResolvedValueOnce(mockResponse);
478
+
479
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
480
+ const result = await service.search(searchOptions);
481
+
482
+ expect(mockClient.search).toHaveBeenCalledWith({
483
+ index: 'test-index',
484
+ body: expect.objectContaining({
485
+ query: {
486
+ bool: {
487
+ must: [{
488
+ multi_match: {
489
+ fields: ['title^2'],
490
+ query: 'test'
491
+ },
492
+ }],
493
+ must_not: [
494
+ { terms: { tags: ['hidden'] } }
495
+ ]
496
+ }
497
+ }
498
+ })
499
+ });
500
+
501
+ expect(result.totalItems).toBe(10);
502
+ });
503
+
504
+ it('should handle sorting', async () => {
505
+ const searchOptions: SearchOptions = {
506
+ query: 'test',
507
+ fields: [{ key: 'title', type: 'text', weight: 2 }],
508
+ sort: [{ key: 'title', order: 'asc' }]
509
+ };
510
+
511
+ const mockResponse = {
512
+ statusCode: 200,
513
+ body: {
514
+ hits: {
515
+ total: { value: 20 },
516
+ hits: []
517
+ }
518
+ }
519
+ } as unknown as SearchResponse<TestDoc>;
520
+
521
+ mockClient.search.mockResolvedValueOnce(mockResponse);
522
+
523
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
524
+ await service.search(searchOptions);
525
+
526
+ expect(mockClient.search).toHaveBeenCalledWith(
527
+ expect.objectContaining({
528
+ body: expect.objectContaining({
529
+ sort: [{ title: { order: 'asc' } }]
530
+ })
531
+ })
532
+ );
533
+ });
534
+
535
+ it('should throw error on non-200 response', async () => {
536
+ mockClient.search.mockResolvedValueOnce({
537
+ statusCode: 500,
538
+ body: { error: 'Internal server error' }
539
+ });
540
+
541
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
542
+ await expect(
543
+ service.search({
544
+ query: 'text',
545
+ fields: [{ key: 'title', type: 'text', weight: 1 }]
546
+ })
547
+ ).rejects
548
+ .toThrow('Unexpected status code: 500 from OpenSearch');
549
+ });
550
+
551
+ it('should correctly map field keys with weights in multi_match query', async () => {
552
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
553
+
554
+ const searchOptions: SearchOptions = {
555
+ query: 'search term',
556
+ fields: [
557
+ { key: 'title', weight: 3 },
558
+ { key: 'description', weight: 2 },
559
+ { key: 'tags', type: 'keyword' }
560
+ ]
561
+ };
562
+
563
+ mockClient.search.mockResolvedValueOnce({
564
+ statusCode: 200,
565
+ body: {
566
+ hits: {
567
+ total: { value: 0 },
568
+ hits: []
569
+ }
570
+ }
571
+ });
572
+
573
+ await service.search(searchOptions);
574
+
575
+ expect(mockClient.search).toHaveBeenCalledWith(
576
+ expect.objectContaining({
577
+ body: expect.objectContaining({
578
+ query: expect.objectContaining({
579
+ bool: expect.objectContaining({
580
+ must: [expect.objectContaining({
581
+ multi_match: expect.objectContaining({
582
+ fields: ['title^3', 'description^2', 'tags'],
583
+ query: 'search term'
584
+ })
585
+ })]
586
+ })
587
+ })
588
+ })
589
+ })
590
+ );
591
+ });
592
+
593
+ it('should work with exists filter', async () => {
594
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
595
+
596
+ const searchOptions: SearchOptions = {
597
+ query: 'search term',
598
+ filter: [
599
+ { exists: {field: 'tags'} }
600
+ ],
601
+ fields: [
602
+ { key: 'title', type: 'text', weight: 1 },
603
+ { key: 'tags', type: 'keyword' }
604
+ ]
605
+ };
606
+
607
+ mockClient.search.mockResolvedValueOnce({
608
+ statusCode: 200,
609
+ body: {
610
+ hits: {
611
+ total: { value: 0 },
612
+ hits: []
613
+ }
614
+ }
615
+ });
616
+
617
+ await service.search(searchOptions);
618
+
619
+ expect(mockClient.search).toHaveBeenCalledWith(
620
+ expect.objectContaining({
621
+ body: expect.objectContaining({
622
+ query: expect.objectContaining({
623
+ bool: expect.objectContaining({
624
+ filter: [
625
+ { exists: { field: 'tags' } }
626
+ ]
627
+ })
628
+ })
629
+ })
630
+ })
631
+ );
632
+ });
633
+
634
+ it('should handle single value in filter', async () => {
635
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
636
+
637
+ const searchOptions: SearchOptions = {
638
+ query: 'search term',
639
+ filter: [
640
+ { key: 'tags', value: 'single-tag' }
641
+ ],
642
+ fields: [{ key: 'title', type: 'text', weight: 1 }]
643
+ };
644
+
645
+ mockClient.search.mockResolvedValueOnce({
646
+ statusCode: 200,
647
+ body: {
648
+ hits: {
649
+ total: { value: 0 },
650
+ hits: []
651
+ }
652
+ }
653
+ });
654
+
655
+ await service.search(searchOptions);
656
+
657
+ expect(mockClient.search).toHaveBeenCalledWith(
658
+ expect.objectContaining({
659
+ body: expect.objectContaining({
660
+ query: expect.objectContaining({
661
+ bool: expect.objectContaining({
662
+ filter: [
663
+ { terms: { tags: ['single-tag'] } }
664
+ ]
665
+ })
666
+ })
667
+ })
668
+ })
669
+ );
670
+ });
671
+
672
+ it('should handle array values in filter', async () => {
673
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
674
+
675
+ const searchOptions: SearchOptions = {
676
+ query: 'search term',
677
+ filter: [
678
+ { key: 'tags', value: ['tag1', 'tag2', 'tag3'] }
679
+ ],
680
+ fields: [{ key: 'title', type: 'text', weight: 1 }]
681
+ };
682
+
683
+ mockClient.search.mockResolvedValueOnce({
684
+ statusCode: 200,
685
+ body: {
686
+ hits: {
687
+ total: { value: 0 },
688
+ hits: []
689
+ }
690
+ }
691
+ });
692
+
693
+ await service.search(searchOptions);
694
+
695
+ expect(mockClient.search).toHaveBeenCalledWith(
696
+ expect.objectContaining({
697
+ body: expect.objectContaining({
698
+ query: expect.objectContaining({
699
+ bool: expect.objectContaining({
700
+ filter: [
701
+ { terms: { tags: ['tag1', 'tag2', 'tag3'] } }
702
+ ]
703
+ })
704
+ })
705
+ })
706
+ })
707
+ );
708
+ });
709
+
710
+ it('should handle single value in must_not', async () => {
711
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
712
+
713
+ const searchOptions: SearchOptions = {
714
+ query: 'search term',
715
+ must_not: [
716
+ { key: 'tags', value: 'exclude-tag' }
717
+ ],
718
+ fields: [{ key: 'title', type: 'text', weight: 1 }]
719
+ };
720
+
721
+ mockClient.search.mockResolvedValueOnce({
722
+ statusCode: 200,
723
+ body: {
724
+ hits: {
725
+ total: { value: 0 },
726
+ hits: []
727
+ }
728
+ }
729
+ });
730
+
731
+ await service.search(searchOptions);
732
+
733
+ expect(mockClient.search).toHaveBeenCalledWith(
734
+ expect.objectContaining({
735
+ body: expect.objectContaining({
736
+ query: expect.objectContaining({
737
+ bool: expect.objectContaining({
738
+ must_not: [
739
+ { terms: { tags: ['exclude-tag'] } }
740
+ ]
741
+ })
742
+ })
743
+ })
744
+ })
745
+ );
746
+ });
747
+
748
+ it('should handle array values in must_not', async () => {
749
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
750
+
751
+ const searchOptions: SearchOptions = {
752
+ query: 'search term',
753
+ must_not: [
754
+ { key: 'tags', value: ['exclude1', 'exclude2'] }
755
+ ],
756
+ fields: [{ key: 'title', type: 'text', weight: 1 }]
757
+ };
758
+
759
+ mockClient.search.mockResolvedValueOnce({
760
+ statusCode: 200,
761
+ body: {
762
+ hits: {
763
+ total: { value: 0 },
764
+ hits: []
765
+ }
766
+ }
767
+ });
768
+
769
+ await service.search(searchOptions);
770
+
771
+ expect(mockClient.search).toHaveBeenCalledWith(
772
+ expect.objectContaining({
773
+ body: expect.objectContaining({
774
+ query: expect.objectContaining({
775
+ bool: expect.objectContaining({
776
+ must_not: [
777
+ { terms: { tags: ['exclude1', 'exclude2'] } },
778
+ ]
779
+ })
780
+ })
781
+ })
782
+ })
783
+ );
784
+ });
785
+
786
+ it('should handle should conditions with array values', async () => {
787
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
788
+
789
+ const searchOptions: SearchOptions = {
790
+ query: 'search term',
791
+ should: [
792
+ { key: 'tags', value: ['tag1', 'tag2', 'tag3'] }
793
+ ],
794
+ fields: [{ key: 'title', type: 'text', weight: 1 }]
795
+ };
796
+
797
+ mockClient.search.mockResolvedValueOnce({
798
+ statusCode: 200,
799
+ body: {
800
+ hits: {
801
+ total: { value: 0 },
802
+ hits: []
803
+ }
804
+ }
805
+ });
806
+
807
+ await service.search(searchOptions);
808
+
809
+ expect(mockClient.search).toHaveBeenCalledWith(
810
+ expect.objectContaining({
811
+ body: expect.objectContaining({
812
+ query: expect.objectContaining({
813
+ bool: expect.objectContaining({
814
+ should: [
815
+ { terms: { tags: ['tag1', 'tag2', 'tag3'] } }
816
+ ],
817
+ minimum_should_match: 1
818
+ })
819
+ })
820
+ })
821
+ })
822
+ );
823
+ });
824
+
825
+ it('should handle should conditions with single values', async () => {
826
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
827
+
828
+ const searchOptions: SearchOptions = {
829
+ query: 'search term',
830
+ should: [
831
+ { key: 'tags', value: 'single-tag' }
832
+ ],
833
+ fields: [{ key: 'title', type: 'text', weight: 1 }]
834
+ };
835
+
836
+ mockClient.search.mockResolvedValueOnce({
837
+ statusCode: 200,
838
+ body: {
839
+ hits: {
840
+ total: { value: 0 },
841
+ hits: []
842
+ }
843
+ }
844
+ });
845
+
846
+ await service.search(searchOptions);
847
+
848
+ expect(mockClient.search).toHaveBeenCalledWith(
849
+ expect.objectContaining({
850
+ body: expect.objectContaining({
851
+ query: expect.objectContaining({
852
+ bool: expect.objectContaining({
853
+ should: [
854
+ { terms: { tags: ['single-tag'] } }
855
+ ],
856
+ minimum_should_match: 1
857
+ })
858
+ })
859
+ })
860
+ })
861
+ );
862
+ });
863
+
864
+ it('should handle multiple should conditions', async () => {
865
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
866
+
867
+ const searchOptions: SearchOptions = {
868
+ query: 'search term',
869
+ should: [
870
+ { key: 'tags', value: 'tag1' },
871
+ { key: 'title', value: 'specific-title' },
872
+ { key: 'categories', value: ['cat1', 'cat2'] }
873
+ ],
874
+ fields: [{ key: 'title', type: 'text', weight: 1 }]
875
+ };
876
+
877
+ mockClient.search.mockResolvedValueOnce({
878
+ statusCode: 200,
879
+ body: {
880
+ hits: {
881
+ total: { value: 0 },
882
+ hits: []
883
+ }
884
+ }
885
+ });
886
+
887
+ await service.search(searchOptions);
888
+
889
+ expect(mockClient.search).toHaveBeenCalledWith(
890
+ expect.objectContaining({
891
+ body: expect.objectContaining({
892
+ query: expect.objectContaining({
893
+ bool: expect.objectContaining({
894
+ should: [
895
+ { terms: { tags: ['tag1'] } },
896
+ { terms: { title: ['specific-title'] } },
897
+ { terms: { categories: ['cat1', 'cat2'] } }
898
+ ],
899
+ minimum_should_match: 1
900
+ })
901
+ })
902
+ })
903
+ })
904
+ );
905
+ });
906
+
907
+ });
908
+
909
+ describe('updateMappings', () => {
910
+ it('works', async () => {
911
+ const service = openSearchService()(mockConfigProvider)<TestDoc>(indexConfig);
912
+ await service.updateMappings();
913
+
914
+ expect(mockClient.indices.putMapping).toHaveBeenCalledWith({
915
+ index: 'test-index',
916
+ body: {
917
+ properties: indexConfig.mappings
918
+ }
919
+ }, {
920
+ requestTimeout: 10000,
921
+ maxRetries: 1,
922
+ });
923
+ });
924
+ });
925
+
926
+ });