@openstax/ts-utils 1.34.0 → 1.35.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 (507) hide show
  1. package/README.md +90 -62
  2. package/dist/cjs/assertions/index.d.ts +89 -0
  3. package/dist/cjs/assertions/index.js +157 -0
  4. package/dist/cjs/aws/ssmService.d.ts +5 -0
  5. package/dist/cjs/aws/ssmService.js +9 -0
  6. package/dist/cjs/config/awsParameterConfig.d.ts +10 -0
  7. package/dist/cjs/config/awsParameterConfig.js +26 -0
  8. package/dist/cjs/config/envConfig.d.ts +24 -0
  9. package/dist/cjs/config/envConfig.js +57 -0
  10. package/{packages/utils/src/config/index.ts → dist/cjs/config/index.d.ts} +13 -29
  11. package/dist/cjs/config/index.js +35 -0
  12. package/dist/cjs/config/lambdaParameterConfig.d.ts +12 -0
  13. package/dist/cjs/config/lambdaParameterConfig.js +45 -0
  14. package/dist/cjs/config/replaceConfig.d.ts +14 -0
  15. package/dist/cjs/config/replaceConfig.js +22 -0
  16. package/dist/cjs/config/resolveConfigValue.d.ts +5 -0
  17. package/dist/cjs/config/resolveConfigValue.js +12 -0
  18. package/dist/cjs/errors/index.d.ts +88 -0
  19. package/dist/cjs/errors/index.js +123 -0
  20. package/dist/cjs/fetch/fetchStatusRetry.d.ts +8 -0
  21. package/dist/cjs/fetch/fetchStatusRetry.js +27 -0
  22. package/dist/cjs/fetch/index.d.ts +64 -0
  23. package/dist/cjs/fetch/index.js +55 -0
  24. package/{packages/utils/src/guards/index.ts → dist/cjs/guards/index.d.ts} +7 -10
  25. package/dist/cjs/guards/index.js +44 -0
  26. package/dist/cjs/index.js +20 -0
  27. package/dist/cjs/middleware/apiErrorHandler.d.ts +24 -0
  28. package/dist/cjs/middleware/apiErrorHandler.js +42 -0
  29. package/dist/cjs/middleware/apiSlowResponseMiddleware.d.ts +23 -0
  30. package/dist/cjs/middleware/apiSlowResponseMiddleware.js +54 -0
  31. package/{packages/utils/src/middleware/index.ts → dist/cjs/middleware/index.d.ts} +5 -53
  32. package/dist/cjs/middleware/index.js +48 -0
  33. package/dist/cjs/middleware/lambdaCorsResponseMiddleware.d.ts +20 -0
  34. package/dist/cjs/middleware/lambdaCorsResponseMiddleware.js +44 -0
  35. package/dist/cjs/middleware/throwNotFoundMiddleware.d.ts +4 -0
  36. package/dist/cjs/middleware/throwNotFoundMiddleware.js +14 -0
  37. package/dist/cjs/misc/hashValue.d.ts +10 -0
  38. package/dist/cjs/misc/hashValue.js +17 -0
  39. package/dist/cjs/misc/helpers.d.ts +124 -0
  40. package/dist/cjs/misc/helpers.js +214 -0
  41. package/dist/cjs/misc/merge.d.ts +21 -0
  42. package/dist/cjs/misc/merge.js +45 -0
  43. package/dist/cjs/misc/partitionSequence.d.ts +35 -0
  44. package/dist/cjs/misc/partitionSequence.js +55 -0
  45. package/dist/cjs/pagination/index.d.ts +91 -0
  46. package/dist/cjs/pagination/index.js +83 -0
  47. package/dist/cjs/routing/helpers.d.ts +57 -0
  48. package/dist/cjs/routing/helpers.js +90 -0
  49. package/dist/cjs/routing/index.d.ts +290 -0
  50. package/dist/cjs/routing/index.js +295 -0
  51. package/dist/cjs/routing/validators/zod.d.ts +4 -0
  52. package/dist/cjs/routing/validators/zod.js +14 -0
  53. package/dist/cjs/services/accountsGateway/index.d.ts +92 -0
  54. package/dist/cjs/services/accountsGateway/index.js +138 -0
  55. package/dist/cjs/services/apiGateway/index.d.ts +68 -0
  56. package/dist/cjs/services/apiGateway/index.js +118 -0
  57. package/dist/cjs/services/authProvider/browser.d.ts +40 -0
  58. package/dist/cjs/services/authProvider/browser.js +155 -0
  59. package/dist/cjs/services/authProvider/decryption.d.ts +19 -0
  60. package/dist/cjs/services/authProvider/decryption.js +73 -0
  61. package/dist/cjs/services/authProvider/index.d.ts +63 -0
  62. package/dist/cjs/services/authProvider/index.js +34 -0
  63. package/dist/cjs/services/authProvider/subrequest.d.ts +13 -0
  64. package/dist/cjs/services/authProvider/subrequest.js +49 -0
  65. package/dist/cjs/services/authProvider/utils/decryptAndVerify.d.ts +28 -0
  66. package/dist/cjs/services/authProvider/utils/decryptAndVerify.js +91 -0
  67. package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.d.ts +26 -0
  68. package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.js +47 -0
  69. package/dist/cjs/services/authProvider/utils/userRoleValidator.d.ts +13 -0
  70. package/dist/cjs/services/authProvider/utils/userRoleValidator.js +37 -0
  71. package/dist/cjs/services/authProvider/utils/userSubrequest.d.ts +3 -0
  72. package/dist/cjs/services/authProvider/utils/userSubrequest.js +13 -0
  73. package/dist/cjs/services/documentStore/dynamoEncoding.d.ts +10 -0
  74. package/dist/cjs/services/documentStore/dynamoEncoding.js +52 -0
  75. package/dist/cjs/services/documentStore/fileSystemAssert.d.ts +1 -0
  76. package/dist/cjs/services/documentStore/fileSystemAssert.js +14 -0
  77. package/{packages/utils/src/services/documentStore/index.ts → dist/cjs/services/documentStore/index.d.ts} +8 -8
  78. package/dist/cjs/services/documentStore/index.js +2 -0
  79. package/dist/cjs/services/documentStore/unversioned/dynamodb.d.ts +31 -0
  80. package/dist/cjs/services/documentStore/unversioned/dynamodb.js +233 -0
  81. package/dist/cjs/services/documentStore/unversioned/file-system.d.ts +32 -0
  82. package/dist/cjs/services/documentStore/unversioned/file-system.js +214 -0
  83. package/{packages/utils/src/services/documentStore/unversioned/index.ts → dist/cjs/services/documentStore/unversioned/index.d.ts} +0 -2
  84. package/dist/cjs/services/documentStore/unversioned/index.js +2 -0
  85. package/dist/cjs/services/documentStore/versioned/dynamodb.d.ts +25 -0
  86. package/dist/cjs/services/documentStore/versioned/dynamodb.js +143 -0
  87. package/dist/cjs/services/documentStore/versioned/file-system.d.ts +25 -0
  88. package/dist/cjs/services/documentStore/versioned/file-system.js +73 -0
  89. package/dist/cjs/services/documentStore/versioned/index.d.ts +17 -0
  90. package/dist/cjs/services/documentStore/versioned/index.js +2 -0
  91. package/dist/cjs/services/exercisesGateway/index.d.ts +67 -0
  92. package/dist/cjs/services/exercisesGateway/index.js +107 -0
  93. package/dist/cjs/services/fileServer/index.d.ts +30 -0
  94. package/dist/cjs/services/fileServer/index.js +19 -0
  95. package/dist/cjs/services/fileServer/localFileServer.d.ts +13 -0
  96. package/dist/cjs/services/fileServer/localFileServer.js +132 -0
  97. package/dist/cjs/services/fileServer/s3FileServer.d.ts +14 -0
  98. package/dist/cjs/services/fileServer/s3FileServer.js +131 -0
  99. package/dist/cjs/services/launchParams/index.js +7 -0
  100. package/dist/cjs/services/launchParams/signer.d.ts +23 -0
  101. package/dist/cjs/services/launchParams/signer.js +58 -0
  102. package/dist/cjs/services/launchParams/verifier.d.ts +21 -0
  103. package/dist/cjs/services/launchParams/verifier.js +129 -0
  104. package/dist/cjs/services/logger/console.d.ts +4 -0
  105. package/dist/cjs/services/logger/console.js +12 -0
  106. package/{packages/utils/src/services/logger/index.ts → dist/cjs/services/logger/index.d.ts} +9 -23
  107. package/dist/cjs/services/logger/index.js +31 -0
  108. package/dist/cjs/services/lrsGateway/addStatementDefaultFields.d.ts +5 -0
  109. package/dist/cjs/services/lrsGateway/addStatementDefaultFields.js +21 -0
  110. package/dist/cjs/services/lrsGateway/attempt-utils.d.ts +72 -0
  111. package/dist/cjs/services/lrsGateway/attempt-utils.js +283 -0
  112. package/dist/cjs/services/lrsGateway/file-system.d.ts +15 -0
  113. package/dist/cjs/services/lrsGateway/file-system.js +150 -0
  114. package/dist/cjs/services/lrsGateway/index.d.ts +122 -0
  115. package/dist/cjs/services/lrsGateway/index.js +148 -0
  116. package/dist/cjs/services/lrsGateway/xapiUtils.d.ts +71 -0
  117. package/dist/cjs/services/lrsGateway/xapiUtils.js +145 -0
  118. package/dist/cjs/services/postgresConnection/index.d.ts +28 -0
  119. package/dist/cjs/services/postgresConnection/index.js +65 -0
  120. package/dist/cjs/services/searchProvider/index.d.ts +69 -0
  121. package/dist/cjs/services/searchProvider/index.js +2 -0
  122. package/dist/cjs/services/searchProvider/memorySearchTheBadWay.d.ts +20 -0
  123. package/dist/cjs/services/searchProvider/memorySearchTheBadWay.js +191 -0
  124. package/dist/cjs/services/searchProvider/openSearch.d.ts +28 -0
  125. package/dist/cjs/services/searchProvider/openSearch.js +162 -0
  126. package/dist/cjs/services/searchProvider/streamIndexer.d.ts +17 -0
  127. package/dist/cjs/services/searchProvider/streamIndexer.js +41 -0
  128. package/dist/cjs/tsconfig.without-specs.cjs.tsbuildinfo +1 -0
  129. package/{packages/utils/src/types.ts → dist/cjs/types.d.ts} +6 -34
  130. package/dist/cjs/types.js +2 -0
  131. package/dist/esm/assertions/index.d.ts +89 -0
  132. package/{packages/utils/src/assertions/index.ts → dist/esm/assertions/index.js} +49 -64
  133. package/dist/esm/aws/ssmService.d.ts +5 -0
  134. package/dist/esm/aws/ssmService.js +6 -0
  135. package/dist/esm/config/awsParameterConfig.d.ts +10 -0
  136. package/dist/esm/config/awsParameterConfig.js +22 -0
  137. package/dist/esm/config/envConfig.d.ts +24 -0
  138. package/dist/esm/config/envConfig.js +53 -0
  139. package/dist/esm/config/index.d.ts +48 -0
  140. package/dist/esm/config/index.js +17 -0
  141. package/dist/esm/config/lambdaParameterConfig.d.ts +12 -0
  142. package/dist/esm/config/lambdaParameterConfig.js +38 -0
  143. package/dist/esm/config/replaceConfig.d.ts +14 -0
  144. package/{packages/utils/src/config/replaceConfig.ts → dist/esm/config/replaceConfig.js} +6 -16
  145. package/dist/esm/config/resolveConfigValue.d.ts +5 -0
  146. package/dist/esm/config/resolveConfigValue.js +8 -0
  147. package/dist/esm/errors/index.d.ts +88 -0
  148. package/{packages/utils/src/errors/index.ts → dist/esm/errors/index.js} +41 -57
  149. package/dist/esm/fetch/fetchStatusRetry.d.ts +8 -0
  150. package/dist/esm/fetch/fetchStatusRetry.js +23 -0
  151. package/dist/esm/fetch/index.d.ts +64 -0
  152. package/dist/esm/fetch/index.js +46 -0
  153. package/dist/esm/guards/index.d.ts +38 -0
  154. package/dist/esm/guards/index.js +36 -0
  155. package/dist/esm/index.d.ts +4 -0
  156. package/dist/esm/index.js +4 -0
  157. package/dist/esm/middleware/apiErrorHandler.d.ts +24 -0
  158. package/dist/esm/middleware/apiErrorHandler.js +38 -0
  159. package/dist/esm/middleware/apiSlowResponseMiddleware.d.ts +23 -0
  160. package/dist/esm/middleware/apiSlowResponseMiddleware.js +50 -0
  161. package/dist/esm/middleware/index.d.ts +47 -0
  162. package/dist/esm/middleware/index.js +44 -0
  163. package/dist/esm/middleware/lambdaCorsResponseMiddleware.d.ts +20 -0
  164. package/dist/esm/middleware/lambdaCorsResponseMiddleware.js +40 -0
  165. package/dist/esm/middleware/throwNotFoundMiddleware.d.ts +4 -0
  166. package/dist/esm/middleware/throwNotFoundMiddleware.js +10 -0
  167. package/dist/esm/misc/hashValue.d.ts +10 -0
  168. package/dist/esm/misc/hashValue.js +13 -0
  169. package/dist/esm/misc/helpers.d.ts +124 -0
  170. package/dist/esm/misc/helpers.js +199 -0
  171. package/dist/esm/misc/merge.d.ts +21 -0
  172. package/dist/esm/misc/merge.js +40 -0
  173. package/dist/esm/misc/partitionSequence.d.ts +35 -0
  174. package/{packages/utils/src/misc/partitionSequence.ts → dist/esm/misc/partitionSequence.js} +15 -23
  175. package/dist/esm/pagination/index.d.ts +91 -0
  176. package/dist/esm/pagination/index.js +77 -0
  177. package/dist/esm/routing/helpers.d.ts +57 -0
  178. package/{packages/utils/src/routing/helpers.ts → dist/esm/routing/helpers.js} +30 -42
  179. package/dist/esm/routing/index.d.ts +290 -0
  180. package/dist/esm/routing/index.js +246 -0
  181. package/dist/esm/routing/validators/zod.d.ts +4 -0
  182. package/dist/esm/routing/validators/zod.js +10 -0
  183. package/dist/esm/services/accountsGateway/index.d.ts +92 -0
  184. package/dist/esm/services/accountsGateway/index.js +131 -0
  185. package/dist/esm/services/apiGateway/index.d.ts +68 -0
  186. package/dist/esm/services/apiGateway/index.js +77 -0
  187. package/dist/esm/services/authProvider/browser.d.ts +40 -0
  188. package/dist/esm/services/authProvider/browser.js +151 -0
  189. package/dist/esm/services/authProvider/decryption.d.ts +19 -0
  190. package/dist/esm/services/authProvider/decryption.js +69 -0
  191. package/dist/esm/services/authProvider/index.d.ts +63 -0
  192. package/dist/esm/services/authProvider/index.js +26 -0
  193. package/dist/esm/services/authProvider/subrequest.d.ts +13 -0
  194. package/dist/esm/services/authProvider/subrequest.js +45 -0
  195. package/dist/esm/services/authProvider/utils/decryptAndVerify.d.ts +28 -0
  196. package/dist/esm/services/authProvider/utils/decryptAndVerify.js +85 -0
  197. package/dist/esm/services/authProvider/utils/embeddedAuthProvider.d.ts +26 -0
  198. package/dist/esm/services/authProvider/utils/embeddedAuthProvider.js +40 -0
  199. package/dist/esm/services/authProvider/utils/userRoleValidator.d.ts +13 -0
  200. package/dist/esm/services/authProvider/utils/userRoleValidator.js +33 -0
  201. package/dist/esm/services/authProvider/utils/userSubrequest.d.ts +3 -0
  202. package/dist/esm/services/authProvider/utils/userSubrequest.js +6 -0
  203. package/dist/esm/services/documentStore/dynamoEncoding.d.ts +10 -0
  204. package/dist/esm/services/documentStore/dynamoEncoding.js +45 -0
  205. package/dist/esm/services/documentStore/fileSystemAssert.d.ts +1 -0
  206. package/dist/esm/services/documentStore/fileSystemAssert.js +10 -0
  207. package/dist/esm/services/documentStore/index.d.ts +14 -0
  208. package/dist/esm/services/documentStore/index.js +1 -0
  209. package/dist/esm/services/documentStore/unversioned/dynamodb.d.ts +31 -0
  210. package/dist/esm/services/documentStore/unversioned/dynamodb.js +226 -0
  211. package/dist/esm/services/documentStore/unversioned/file-system.d.ts +32 -0
  212. package/dist/esm/services/documentStore/unversioned/file-system.js +174 -0
  213. package/dist/esm/services/documentStore/unversioned/index.d.ts +2 -0
  214. package/dist/esm/services/documentStore/unversioned/index.js +1 -0
  215. package/dist/esm/services/documentStore/versioned/dynamodb.d.ts +25 -0
  216. package/dist/esm/services/documentStore/versioned/dynamodb.js +139 -0
  217. package/dist/esm/services/documentStore/versioned/file-system.d.ts +25 -0
  218. package/dist/esm/services/documentStore/versioned/file-system.js +69 -0
  219. package/dist/esm/services/documentStore/versioned/index.d.ts +17 -0
  220. package/dist/esm/services/documentStore/versioned/index.js +1 -0
  221. package/dist/esm/services/exercisesGateway/index.d.ts +67 -0
  222. package/dist/esm/services/exercisesGateway/index.js +70 -0
  223. package/dist/esm/services/fileServer/index.d.ts +30 -0
  224. package/dist/esm/services/fileServer/index.js +13 -0
  225. package/dist/esm/services/fileServer/localFileServer.d.ts +13 -0
  226. package/dist/esm/services/fileServer/localFileServer.js +125 -0
  227. package/dist/esm/services/fileServer/s3FileServer.d.ts +14 -0
  228. package/dist/esm/services/fileServer/s3FileServer.js +124 -0
  229. package/dist/esm/services/launchParams/index.d.ts +2 -0
  230. package/dist/esm/services/launchParams/index.js +2 -0
  231. package/dist/esm/services/launchParams/signer.d.ts +23 -0
  232. package/dist/esm/services/launchParams/signer.js +51 -0
  233. package/dist/esm/services/launchParams/verifier.d.ts +21 -0
  234. package/dist/esm/services/launchParams/verifier.js +92 -0
  235. package/dist/esm/services/logger/console.d.ts +4 -0
  236. package/{packages/utils/src/services/logger/console.ts → dist/esm/services/logger/console.js} +2 -5
  237. package/dist/esm/services/logger/index.d.ts +39 -0
  238. package/dist/esm/services/logger/index.js +27 -0
  239. package/dist/esm/services/lrsGateway/addStatementDefaultFields.d.ts +5 -0
  240. package/dist/esm/services/lrsGateway/addStatementDefaultFields.js +14 -0
  241. package/dist/esm/services/lrsGateway/attempt-utils.d.ts +72 -0
  242. package/dist/esm/services/lrsGateway/attempt-utils.js +261 -0
  243. package/dist/esm/services/lrsGateway/file-system.d.ts +15 -0
  244. package/dist/esm/services/lrsGateway/file-system.js +110 -0
  245. package/dist/esm/services/lrsGateway/index.d.ts +122 -0
  246. package/dist/esm/services/lrsGateway/index.js +111 -0
  247. package/dist/esm/services/lrsGateway/xapiUtils.d.ts +71 -0
  248. package/dist/esm/services/lrsGateway/xapiUtils.js +134 -0
  249. package/dist/esm/services/postgresConnection/index.d.ts +28 -0
  250. package/dist/esm/services/postgresConnection/index.js +58 -0
  251. package/dist/esm/services/searchProvider/index.d.ts +69 -0
  252. package/dist/esm/services/searchProvider/index.js +1 -0
  253. package/dist/esm/services/searchProvider/memorySearchTheBadWay.d.ts +20 -0
  254. package/dist/esm/services/searchProvider/memorySearchTheBadWay.js +187 -0
  255. package/dist/esm/services/searchProvider/openSearch.d.ts +28 -0
  256. package/dist/esm/services/searchProvider/openSearch.js +158 -0
  257. package/dist/esm/services/searchProvider/streamIndexer.d.ts +17 -0
  258. package/dist/esm/services/searchProvider/streamIndexer.js +37 -0
  259. package/dist/esm/tsconfig.without-specs.esm.tsbuildinfo +1 -0
  260. package/dist/esm/types.d.ts +31 -0
  261. package/dist/esm/types.js +1 -0
  262. package/package.json +234 -12
  263. package/.cfnlintrc +0 -2
  264. package/.github/CODEOWNERS +0 -1
  265. package/.github/workflows/ci.yml +0 -36
  266. package/.github/workflows/lint.yml +0 -55
  267. package/.nvmrc +0 -1
  268. package/.syncignore +0 -4
  269. package/.syncpackrc +0 -18
  270. package/CONTRIBUTING.md +0 -96
  271. package/LICENSE +0 -661
  272. package/Procfile +0 -1
  273. package/app.json +0 -23
  274. package/cspell.json +0 -32
  275. package/deploy/constants.env +0 -21
  276. package/deploy/deploy.bash +0 -157
  277. package/deploy/deployment-alt-region.cfn.yml +0 -70
  278. package/deploy/deployment.cfn.yml +0 -650
  279. package/deploy/destroy-deployment.bash +0 -23
  280. package/deploy/shared.cfn.yml +0 -94
  281. package/docs/lambda-build.md +0 -35
  282. package/packages/frontend/README.md +0 -46
  283. package/packages/frontend/package.json +0 -101
  284. package/packages/frontend/public/favicon.ico +0 -0
  285. package/packages/frontend/public/index.html +0 -107
  286. package/packages/frontend/public/maintenance.html +0 -59
  287. package/packages/frontend/public/manifest.json +0 -15
  288. package/packages/frontend/public/robots.txt +0 -3
  289. package/packages/frontend/script/make-certificate.bash +0 -49
  290. package/packages/frontend/script/server/cli.js +0 -11
  291. package/packages/frontend/script/server/index.js +0 -47
  292. package/packages/frontend/script/start.bash +0 -22
  293. package/packages/frontend/script/trust-localhost.bash +0 -7
  294. package/packages/frontend/src/auth/authProvider.ts +0 -10
  295. package/packages/frontend/src/auth/useAuth.ts +0 -33
  296. package/packages/frontend/src/components/Pagination.tsx +0 -26
  297. package/packages/frontend/src/configProvider/index.ts +0 -53
  298. package/packages/frontend/src/configProvider/use.ts +0 -41
  299. package/packages/frontend/src/core/context/services.spec.tsx +0 -39
  300. package/packages/frontend/src/core/context/services.tsx +0 -16
  301. package/packages/frontend/src/core/index.spec.ts +0 -7
  302. package/packages/frontend/src/core/index.ts +0 -20
  303. package/packages/frontend/src/core/services.tsx +0 -14
  304. package/packages/frontend/src/core/types.ts +0 -3
  305. package/packages/frontend/src/example/api.ts +0 -28
  306. package/packages/frontend/src/example/components/Layout.tsx +0 -23
  307. package/packages/frontend/src/example/screens/Home.spec.tsx +0 -68
  308. package/packages/frontend/src/example/screens/Home.tsx +0 -78
  309. package/packages/frontend/src/example/screens/ThingList.spec.tsx +0 -60
  310. package/packages/frontend/src/example/screens/ThingList.tsx +0 -75
  311. package/packages/frontend/src/example/screens/ThingView.spec.tsx +0 -71
  312. package/packages/frontend/src/example/screens/ThingView.tsx +0 -47
  313. package/packages/frontend/src/example/screens/index.ts +0 -9
  314. package/packages/frontend/src/index.css +0 -159
  315. package/packages/frontend/src/index.tsx +0 -67
  316. package/packages/frontend/src/react-app-env.d.ts +0 -1
  317. package/packages/frontend/src/routing/components/RouteLink.spec.tsx +0 -55
  318. package/packages/frontend/src/routing/components/RouteLink.tsx +0 -35
  319. package/packages/frontend/src/routing/middleware.ts +0 -6
  320. package/packages/frontend/src/routing/useQuery.ts +0 -14
  321. package/packages/frontend/src/setupProxy.js +0 -19
  322. package/packages/frontend/src/setupTests.ts +0 -9
  323. package/packages/frontend/src/tests/testServices.tsx +0 -23
  324. package/packages/frontend/tsconfig.json +0 -27
  325. package/packages/lambda/.eslintrc.js +0 -64
  326. package/packages/lambda/jest-global-setup.js +0 -3
  327. package/packages/lambda/jest-setup-after-env.js +0 -1
  328. package/packages/lambda/jest.config.js +0 -31
  329. package/packages/lambda/jest.resolver.js +0 -17
  330. package/packages/lambda/package.json +0 -68
  331. package/packages/lambda/script/build.bash +0 -19
  332. package/packages/lambda/script/bundle-functions.bash +0 -10
  333. package/packages/lambda/script/lambdaLocalProxy.js +0 -16
  334. package/packages/lambda/script/lambdaLocalProxy.spec.ts +0 -147
  335. package/packages/lambda/script/utils/getRouteData.ts +0 -7
  336. package/packages/lambda/script/utils/routeDataLoader.js +0 -8
  337. package/packages/lambda/script/utils/routeDataLoader.spec.ts +0 -8
  338. package/packages/lambda/src/functions/serviceApi/core/index.ts +0 -7
  339. package/packages/lambda/src/functions/serviceApi/core/request.spec.ts +0 -38
  340. package/packages/lambda/src/functions/serviceApi/core/request.ts +0 -42
  341. package/packages/lambda/src/functions/serviceApi/core/routes.spec.ts +0 -7
  342. package/packages/lambda/src/functions/serviceApi/core/routes.ts +0 -10
  343. package/packages/lambda/src/functions/serviceApi/core/services.ts +0 -9
  344. package/packages/lambda/src/functions/serviceApi/core/types.ts +0 -13
  345. package/packages/lambda/src/functions/serviceApi/entry/lambda/https-xray.ts +0 -4
  346. package/packages/lambda/src/functions/serviceApi/entry/lambda/index.spec.ts +0 -48
  347. package/packages/lambda/src/functions/serviceApi/entry/lambda/index.ts +0 -58
  348. package/packages/lambda/src/functions/serviceApi/entry/lambda/services.ts +0 -36
  349. package/packages/lambda/src/functions/serviceApi/entry/local.ts +0 -71
  350. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentSearchMiddleware.spec.ts +0 -16
  351. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentSearchMiddleware.ts +0 -41
  352. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentStoreMiddleware.spec.ts +0 -78
  353. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentStoreMiddleware.ts +0 -70
  354. package/packages/lambda/src/functions/serviceApi/versions/v0/example/routes.spec.ts +0 -306
  355. package/packages/lambda/src/functions/serviceApi/versions/v0/example/routes.ts +0 -176
  356. package/packages/lambda/src/functions/serviceApi/versions/v0/index.spec.ts +0 -263
  357. package/packages/lambda/src/functions/serviceApi/versions/v0/index.ts +0 -134
  358. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/authMiddleware.spec.ts +0 -23
  359. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/authMiddleware.ts +0 -32
  360. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/configMiddleware.spec.ts +0 -10
  361. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/configMiddleware.ts +0 -7
  362. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/frontendFileServerMiddleware.spec.ts +0 -13
  363. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/frontendFileServerMiddleware.ts +0 -23
  364. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/paginationMiddleware.spec.ts +0 -9
  365. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/paginationMiddleware.ts +0 -9
  366. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/searchMiddleware.spec.ts +0 -12
  367. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/searchMiddleware.ts +0 -21
  368. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/userRoleValidatorMiddleware.spec.ts +0 -21
  369. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/userRoleValidatorMiddleware.ts +0 -18
  370. package/packages/lambda/tsconfig.json +0 -30
  371. package/packages/lambda/webpack.config.js +0 -97
  372. package/packages/utils/.eslintrc.js +0 -64
  373. package/packages/utils/README.md +0 -118
  374. package/packages/utils/jest-global-setup.js +0 -3
  375. package/packages/utils/jest.config.js +0 -25
  376. package/packages/utils/jest.resolver.js +0 -17
  377. package/packages/utils/package.json +0 -238
  378. package/packages/utils/src/assertions/index.spec.ts +0 -126
  379. package/packages/utils/src/aws/ssmService.ts +0 -7
  380. package/packages/utils/src/config/awsParameterConfig.ts +0 -24
  381. package/packages/utils/src/config/envConfig.ts +0 -58
  382. package/packages/utils/src/config/index.spec.ts +0 -165
  383. package/packages/utils/src/config/lambdaParameterConfig.ts +0 -49
  384. package/packages/utils/src/config/resolveConfigValue.ts +0 -10
  385. package/packages/utils/src/errors/index.spec.ts +0 -35
  386. package/packages/utils/src/fetch/fetchStatusRetry.spec.ts +0 -197
  387. package/packages/utils/src/fetch/fetchStatusRetry.ts +0 -33
  388. package/packages/utils/src/fetch/index.spec.ts +0 -34
  389. package/packages/utils/src/fetch/index.ts +0 -87
  390. package/packages/utils/src/guards/index.spec.ts +0 -58
  391. package/packages/utils/src/index.spec.ts +0 -471
  392. package/packages/utils/src/middleware/apiErrorHandler.spec.ts +0 -65
  393. package/packages/utils/src/middleware/apiErrorHandler.ts +0 -67
  394. package/packages/utils/src/middleware/apiSlowResponseMiddleware.spec.ts +0 -184
  395. package/packages/utils/src/middleware/apiSlowResponseMiddleware.ts +0 -71
  396. package/packages/utils/src/middleware/index.spec.ts +0 -99
  397. package/packages/utils/src/middleware/lambdaCorsResponseMiddleware.spec.ts +0 -103
  398. package/packages/utils/src/middleware/lambdaCorsResponseMiddleware.ts +0 -52
  399. package/packages/utils/src/middleware/throwNotFoundMiddleware.spec.ts +0 -20
  400. package/packages/utils/src/middleware/throwNotFoundMiddleware.ts +0 -11
  401. package/packages/utils/src/misc/hashValue.ts +0 -18
  402. package/packages/utils/src/misc/helpers.ts +0 -259
  403. package/packages/utils/src/misc/merge.ts +0 -48
  404. package/packages/utils/src/pagination/index.spec.ts +0 -150
  405. package/packages/utils/src/pagination/index.ts +0 -117
  406. package/packages/utils/src/routing/index.spec.ts +0 -553
  407. package/packages/utils/src/routing/index.ts +0 -424
  408. package/packages/utils/src/routing/validators/zod.spec.ts +0 -16
  409. package/packages/utils/src/routing/validators/zod.ts +0 -14
  410. package/packages/utils/src/services/accountsGateway/README.md +0 -3
  411. package/packages/utils/src/services/accountsGateway/index.spec.ts +0 -518
  412. package/packages/utils/src/services/accountsGateway/index.ts +0 -251
  413. package/packages/utils/src/services/apiGateway/README.md +0 -93
  414. package/packages/utils/src/services/apiGateway/index.spec.ts +0 -254
  415. package/packages/utils/src/services/apiGateway/index.ts +0 -189
  416. package/packages/utils/src/services/authProvider/README.md +0 -21
  417. package/packages/utils/src/services/authProvider/browser.spec.ts +0 -391
  418. package/packages/utils/src/services/authProvider/browser.ts +0 -209
  419. package/packages/utils/src/services/authProvider/decryption.spec.ts +0 -337
  420. package/packages/utils/src/services/authProvider/decryption.ts +0 -98
  421. package/packages/utils/src/services/authProvider/index.ts +0 -93
  422. package/packages/utils/src/services/authProvider/stub.spec.ts +0 -29
  423. package/packages/utils/src/services/authProvider/subrequest.spec.ts +0 -105
  424. package/packages/utils/src/services/authProvider/subrequest.ts +0 -68
  425. package/packages/utils/src/services/authProvider/utils/decryptAndVerify.spec.ts +0 -128
  426. package/packages/utils/src/services/authProvider/utils/decryptAndVerify.ts +0 -106
  427. package/packages/utils/src/services/authProvider/utils/embeddedAuthProvider.spec.ts +0 -26
  428. package/packages/utils/src/services/authProvider/utils/embeddedAuthProvider.ts +0 -57
  429. package/packages/utils/src/services/authProvider/utils/userRoleValidator.spec.ts +0 -135
  430. package/packages/utils/src/services/authProvider/utils/userRoleValidator.ts +0 -49
  431. package/packages/utils/src/services/authProvider/utils/userSubrequest.spec.ts +0 -26
  432. package/packages/utils/src/services/authProvider/utils/userSubrequest.ts +0 -10
  433. package/packages/utils/src/services/documentStore/dynamoEncoding.ts +0 -57
  434. package/packages/utils/src/services/documentStore/fileSystemAssert.spec.ts +0 -43
  435. package/packages/utils/src/services/documentStore/fileSystemAssert.ts +0 -10
  436. package/packages/utils/src/services/documentStore/unversioned/README.md +0 -13
  437. package/packages/utils/src/services/documentStore/unversioned/dynamodb.spec.ts +0 -859
  438. package/packages/utils/src/services/documentStore/unversioned/dynamodb.ts +0 -243
  439. package/packages/utils/src/services/documentStore/unversioned/file-system.spec.ts +0 -629
  440. package/packages/utils/src/services/documentStore/unversioned/file-system.ts +0 -194
  441. package/packages/utils/src/services/documentStore/versioned/README.md +0 -13
  442. package/packages/utils/src/services/documentStore/versioned/dynamodb.spec.ts +0 -376
  443. package/packages/utils/src/services/documentStore/versioned/dynamodb.ts +0 -167
  444. package/packages/utils/src/services/documentStore/versioned/file-system.spec.ts +0 -262
  445. package/packages/utils/src/services/documentStore/versioned/file-system.ts +0 -90
  446. package/packages/utils/src/services/documentStore/versioned/index.ts +0 -25
  447. package/packages/utils/src/services/exercisesGateway/README.md +0 -5
  448. package/packages/utils/src/services/exercisesGateway/index.spec.ts +0 -326
  449. package/packages/utils/src/services/exercisesGateway/index.ts +0 -163
  450. package/packages/utils/src/services/fileServer/index.spec.ts +0 -88
  451. package/packages/utils/src/services/fileServer/index.ts +0 -43
  452. package/packages/utils/src/services/fileServer/localFileServer.spec.ts +0 -182
  453. package/packages/utils/src/services/fileServer/localFileServer.ts +0 -159
  454. package/packages/utils/src/services/fileServer/s3FileServer.spec.ts +0 -266
  455. package/packages/utils/src/services/fileServer/s3FileServer.ts +0 -155
  456. package/packages/utils/src/services/launchParams/index.spec.ts +0 -366
  457. package/packages/utils/src/services/launchParams/signer.ts +0 -73
  458. package/packages/utils/src/services/launchParams/verifier.ts +0 -120
  459. package/packages/utils/src/services/logger/console.spec.ts +0 -29
  460. package/packages/utils/src/services/logger/index.spec.ts +0 -65
  461. package/packages/utils/src/services/lrsGateway/README.md +0 -5
  462. package/packages/utils/src/services/lrsGateway/addStatementDefaultFields.ts +0 -22
  463. package/packages/utils/src/services/lrsGateway/attempt-utils.spec.ts +0 -847
  464. package/packages/utils/src/services/lrsGateway/attempt-utils.ts +0 -358
  465. package/packages/utils/src/services/lrsGateway/file-system.spec.ts +0 -363
  466. package/packages/utils/src/services/lrsGateway/file-system.ts +0 -165
  467. package/packages/utils/src/services/lrsGateway/index.spec.ts +0 -194
  468. package/packages/utils/src/services/lrsGateway/index.ts +0 -257
  469. package/packages/utils/src/services/lrsGateway/xapiUtils.spec.ts +0 -887
  470. package/packages/utils/src/services/lrsGateway/xapiUtils.ts +0 -262
  471. package/packages/utils/src/services/postgresConnection/index.spec.ts +0 -170
  472. package/packages/utils/src/services/postgresConnection/index.ts +0 -84
  473. package/packages/utils/src/services/searchProvider/README.md +0 -3
  474. package/packages/utils/src/services/searchProvider/index.ts +0 -59
  475. package/packages/utils/src/services/searchProvider/memorySearchTheBadWay.spec.ts +0 -526
  476. package/packages/utils/src/services/searchProvider/memorySearchTheBadWay.ts +0 -223
  477. package/packages/utils/src/services/searchProvider/openSearch.spec.ts +0 -926
  478. package/packages/utils/src/services/searchProvider/openSearch.ts +0 -195
  479. package/packages/utils/tsconfig.json +0 -31
  480. package/packages/utils/tsconfig.without-specs.cjs.json +0 -7
  481. package/packages/utils/tsconfig.without-specs.esm.json +0 -7
  482. package/packages/utils/tsconfig.without-specs.json +0 -6
  483. package/scripts/build.bash +0 -24
  484. package/scripts/ci.bash +0 -10
  485. package/scripts/start.bash +0 -29
  486. /package/{packages/utils/src/index.ts → dist/cjs/index.d.ts} +0 -0
  487. /package/{packages/utils/src/services/launchParams/index.ts → dist/cjs/services/launchParams/index.d.ts} +0 -0
  488. /package/{packages/utils/script → script}/bin/copy-from-template.bash +0 -0
  489. /package/{packages/utils/script → script}/bin/delete-stack.bash +0 -0
  490. /package/{packages/utils/script → script}/bin/deploy.bash +0 -0
  491. /package/{packages/utils/script → script}/bin/destroy-deployment.bash +0 -0
  492. /package/{packages/utils/script → script}/bin/empty-bucket.bash +0 -0
  493. /package/{packages/utils/script → script}/bin/get-arg.bash +0 -0
  494. /package/{packages/utils/script → script}/bin/get-deployed-environments.bash +0 -0
  495. /package/{packages/utils/script → script}/bin/get-env-param.bash +0 -0
  496. /package/{packages/utils/script → script}/bin/get-kwarg.bash +0 -0
  497. /package/{packages/utils/script → script}/bin/get-stack-param.bash +0 -0
  498. /package/{packages/utils/script → script}/bin/has-flag.bash +0 -0
  499. /package/{packages/utils/script → script}/bin/init-constants-script.bash +0 -0
  500. /package/{packages/utils/script → script}/bin/init-params-script.bash +0 -0
  501. /package/{packages/utils/script → script}/bin/stack-exists.bash +0 -0
  502. /package/{packages/utils/script → script}/bin/update-utils.bash +0 -0
  503. /package/{packages/utils/script → script}/bin/upload-pager-duty-endpoints.bash +0 -0
  504. /package/{packages/utils/script → script}/bin/upload-params.bash +0 -0
  505. /package/{packages/utils/script → script}/bin/which.bash +0 -0
  506. /package/{packages/utils/script → script}/bin-entry.bash +0 -0
  507. /package/{packages/utils/script → script}/build.bash +0 -0
@@ -1,926 +0,0 @@
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
- });