@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,58 @@
1
+ import { ifDefined, isDefined, isNotNull, isNumber, isPlainObject } from '.';
2
+
3
+ describe('ifDefined', () => {
4
+ it('returns input', () => {
5
+ expect(ifDefined('input', 'default')).toBe('input');
6
+ });
7
+ it('returns default', () => {
8
+ expect(ifDefined(undefined, 'default')).toBe('default');
9
+ });
10
+ });
11
+
12
+ describe('isNumber', () => {
13
+ it('returns true', () => {
14
+ expect(isNumber(5)).toBe(true);
15
+ });
16
+ it('returns false', () => {
17
+ expect(isNumber('5')).toBe(false);
18
+ });
19
+ });
20
+
21
+ describe('isDefined', () => {
22
+ it('is defined', () => {
23
+ expect(isDefined('asdf')).toBe(true);
24
+ });
25
+ it('null is defined', () => {
26
+ expect(isDefined(null)).toBe(true);
27
+ });
28
+ it('false is defined', () => {
29
+ expect(isDefined(false)).toBe(true);
30
+ });
31
+ it('isn\'t defined', () => {
32
+ expect(isDefined(undefined)).toBe(false);
33
+ });
34
+ });
35
+
36
+ describe('isNotNull', () => {
37
+ it('is not null', () => {
38
+ expect(isNotNull('asdf')).toBe(true);
39
+ });
40
+ it('null is null', () => {
41
+ expect(isNotNull(null)).toBe(false);
42
+ });
43
+ it('false is not null', () => {
44
+ expect(isNotNull(false)).toBe(true);
45
+ });
46
+ it('undefined is not null', () => {
47
+ expect(isNotNull(undefined)).toBe(true);
48
+ });
49
+ });
50
+
51
+ describe('isPlainObject', () => {
52
+ it('is plain', () => {
53
+ expect(isPlainObject({})).toBe(true);
54
+ });
55
+ it('is not plain', () => {
56
+ expect(isPlainObject(new Error())).toBe(false);
57
+ });
58
+ });
@@ -5,7 +5,8 @@
5
5
  *
6
6
  * `const result = (array as Array<string | undefined>).filter(isDefined);`
7
7
  */
8
- export declare const isDefined: <X>(x: X) => x is Exclude<X, undefined>;
8
+ export const isDefined = <X>(x: X): x is Exclude<X, undefined> => x !== undefined;
9
+
9
10
  /**
10
11
  * checks if a thing is not null. while often easy to do with a simple if statement,
11
12
  * in certain situations the guard is required and its nice to have one pre-defined.
@@ -13,7 +14,8 @@ export declare const isDefined: <X>(x: X) => x is Exclude<X, undefined>;
13
14
  *
14
15
  * `const result = (array as Array<string | null>).filter(isNotNull);`
15
16
  */
16
- export declare const isNotNull: <X>(x: X) => x is Exclude<X, null>;
17
+ export const isNotNull = <X>(x: X): x is Exclude<X, null> => x !== null;
18
+
17
19
  /**
18
20
  * checks if a thing is a number. while often easy to do with a simple if statement, in certain
19
21
  * situations the guard is required and its nice to have one pre-defined. E.g. in the following
@@ -21,18 +23,19 @@ export declare const isNotNull: <X>(x: X) => x is Exclude<X, null>;
21
23
  *
22
24
  * `const result = (array as Array<number | undefined>).filter(isNumber);`
23
25
  */
24
- export declare const isNumber: (x: any) => x is number;
26
+ export const isNumber = (x: any): x is number => typeof x === 'number';
27
+
25
28
  /**
26
29
  * a guard for plain old javascript objects that are not based on some other prototype,
27
30
  * for example making them safe to JSON stringify and stuff
28
31
  */
29
- export declare const isPlainObject: (thing: any) => thing is {
30
- [key: string]: any;
31
- };
32
+ export const isPlainObject = (thing: any): thing is {[key: string]: any} =>
33
+ thing instanceof Object && thing.__proto__.constructor.name === 'Object';
34
+
32
35
  /**
33
36
  * if the first thing is defined it uses it, otherwise it returns the second thing. this isn't
34
37
  * really a guard its just a way to provide a default value without creating a coverage branch.
35
38
  *
36
39
  * @example const valueWithDefault = ifDefined(thing, 'default value')
37
40
  */
38
- export declare const ifDefined: <X, D>(x: X, d: D) => D | Exclude<X, undefined>;
41
+ export const ifDefined = <X, D>(x: X, d: D) => isDefined(x) ? x : d;
@@ -0,0 +1,471 @@
1
+ import { retryWithDelay } from './misc/helpers';
2
+ import { coerceArray, flow, fnIf, getKeyValue, getKeyValueOr, hashValue, mapFind, memoize, merge, once, partitionSequence, putKeyValue, roundToPrecision, tuple } from '.';
3
+
4
+ afterEach(() => {
5
+ jest.clearAllMocks();
6
+ });
7
+
8
+ describe('mapFind', () => {
9
+ it('finds first result', () => {
10
+ const array = [{a: 0}, {a: 2}, {a: 0}, {a: 1}];
11
+ const result = mapFind(array, x => x.a);
12
+
13
+ expect(result).toBe(2);
14
+ });
15
+
16
+ it('finds first result with predicate', () => {
17
+ const array = [{a: 0}, {a: 2}, {a: 0}, {a: 1}];
18
+ const result = mapFind(array, x => x.a, x => x === 1);
19
+
20
+ expect(result).toBe(1);
21
+ });
22
+
23
+ it('fails to find result', () => {
24
+ const array: {a: number; b?: number}[] = [{a: 0}, {a: 2}, {a: 0}, {a: 1}];
25
+ const result = mapFind(array, x => x.b);
26
+
27
+ expect(result).toBeUndefined();
28
+ });
29
+
30
+ it('fails to find result with predicate', () => {
31
+ const array = [{a: 0}, {a: 2}, {a: 0}, {a: 1}];
32
+ const result = mapFind(array, x => x.a, x => x === 3);
33
+
34
+ expect(result).toBeUndefined();
35
+ });
36
+ });
37
+
38
+ describe('hashValue', () => {
39
+ it('hashes a string', () => {
40
+ expect(hashValue('a string')).toEqual(expect.any(String));
41
+ expect(hashValue('a string')).toEqual(hashValue('a string'));
42
+ expect(hashValue('a string')).not.toEqual(hashValue('a different string'));
43
+ });
44
+ it('hashes a boolean', () => {
45
+ expect(hashValue(true)).toEqual(expect.any(String));
46
+ expect(hashValue(true)).toEqual(hashValue(true));
47
+ expect(hashValue(true)).not.toEqual(hashValue(false));
48
+ });
49
+ it('hashes a number', () => {
50
+ expect(hashValue(1)).toEqual(expect.any(String));
51
+ expect(hashValue(1)).toEqual(hashValue(1));
52
+ expect(hashValue(1)).not.toEqual(hashValue(2));
53
+ });
54
+ it('hashes a list', () => {
55
+ expect(hashValue([1,2])).toEqual(expect.any(String));
56
+ expect(hashValue([1,2])).toEqual(hashValue([1,2]));
57
+ expect(hashValue([1,2])).not.toEqual(hashValue([2,3]));
58
+ });
59
+ it('hashes an object', () => {
60
+ expect(hashValue({one: 'one'})).toEqual(expect.any(String));
61
+ expect(hashValue({one: 'one'})).toEqual(hashValue({one: 'one'}));
62
+ expect(hashValue({one: 'one'})).not.toEqual(hashValue({two: 'two'}));
63
+ expect(hashValue({one: 'one', two: 'two'})).toEqual(hashValue({two: 'two', one: 'one'}));
64
+ });
65
+ });
66
+
67
+ describe('object access', () => {
68
+ it('gets key value', () => {
69
+ expect(getKeyValue('theKey')({theKey: 'theValue'})).toBe('theValue');
70
+ });
71
+ it('gets key value with default', () => {
72
+ expect(getKeyValueOr('theKey', 'defaultValue')({theKey: 'theValue'})).toBe('theValue');
73
+ });
74
+ it('gets default value', () => {
75
+ expect(getKeyValueOr('theKey', 'defaultValue')({theKey: null})).toBe('defaultValue');
76
+ });
77
+ it('puts key value', () => {
78
+ expect(putKeyValue('theKey')({theKey: 'theValue'}, 'newValue')).toEqual({theKey: 'newValue'});
79
+ });
80
+ });
81
+
82
+ describe('once', () => {
83
+ it('calls once', () => {
84
+ const spy = jest.fn(x => x);
85
+ const onceSpy = once(spy);
86
+
87
+ expect(onceSpy(5)).toBe(5);
88
+ expect(onceSpy(1)).toBe(5);
89
+ expect(onceSpy(7)).toBe(5);
90
+ expect(onceSpy(2)).toBe(5);
91
+
92
+ expect(spy).toHaveBeenCalledTimes(1);
93
+ });
94
+
95
+ it('calls once when result is falsy', () => {
96
+ const spy = jest.fn(_x => null);
97
+ const onceSpy = once(spy);
98
+
99
+ expect(onceSpy(5)).toBeNull();
100
+ expect(onceSpy(1)).toBeNull();
101
+ expect(onceSpy(7)).toBeNull();
102
+ expect(onceSpy(2)).toBeNull();
103
+
104
+ expect(spy).toHaveBeenCalledTimes(1);
105
+ });
106
+
107
+ it('calls multiple times when the function throws', () => {
108
+ const spy = jest.fn((_x) => { throw new Error('Bad Request'); });
109
+ const onceSpy = once(spy);
110
+
111
+ expect(() => onceSpy(1)).toThrow('Bad Request');
112
+ expect(() => onceSpy(2)).toThrow('Bad Request');
113
+
114
+ expect(spy).toHaveBeenCalledTimes(2);
115
+ });
116
+
117
+ it('calls multiple times when the function returns a Promise that rejects (when it rejects)', async() => {
118
+ const spy = jest.fn(async(_x) => { throw new Error('Bad Request'); });
119
+ const onceSpy = once(spy);
120
+
121
+ const promise1 = onceSpy(1);
122
+ const promise2 = onceSpy(2);
123
+
124
+ await expect(promise1).rejects.toThrow('Bad Request');
125
+ await expect(promise2).rejects.toThrow('Bad Request');
126
+
127
+ expect(spy).toHaveBeenCalledTimes(1);
128
+
129
+ await expect(onceSpy(3)).rejects.toThrow('Bad Request');
130
+
131
+ expect(spy).toHaveBeenCalledTimes(2);
132
+ });
133
+ });
134
+
135
+ describe('merge', () => {
136
+ it('merges simple object', () => {
137
+ expect(merge({key1: 'value1'}, {key2: 'value2'})).toEqual({key1: 'value1', key2: 'value2'});
138
+ });
139
+
140
+ it('merges objects recursively', () => {
141
+ expect(merge(
142
+ {key1: 'value1', subObject: {subKey1: 'subValue1'}},
143
+ {key2: 'value2', subObject: {subKey2: 'subValue2'}}
144
+ )).toEqual({key1: 'value1', key2: 'value2', subObject: {subKey1: 'subValue1', subKey2: 'subValue2'}});
145
+ });
146
+
147
+ it('merges arrays recursively', () => {
148
+ expect(merge(
149
+ {key1: 'value1', subArray: ['subValue1']},
150
+ {key2: 'value2', subArray: ['subValue2']}
151
+ )).toEqual({key1: 'value1', key2: 'value2', subArray: ['subValue1', 'subValue2']});
152
+ });
153
+
154
+ it('last value for common key wins', () => {
155
+ expect(merge({key: 'value1'}, {key: 'value2'})).toEqual({key: 'value2'});
156
+ });
157
+
158
+ it('object references work when unmerged', () => {
159
+ const subObject1 = {subKey1: 'subValue1'};
160
+ const subObject2 = {subKey2: 'subValue2'};
161
+ const merged = merge(
162
+ {key1: 'value1', subObject1, subObject: subObject1},
163
+ {key2: 'value2', subObject2, subObject: subObject2}
164
+ );
165
+
166
+ expect(merged.subObject1).toBe(subObject1);
167
+ expect(merged.subObject2).toBe(subObject2);
168
+ expect(merged.subObject).not.toBe(subObject1);
169
+ expect(merged.subObject).not.toBe(subObject2);
170
+ });
171
+ });
172
+
173
+ describe('tuple', () => {
174
+ it('works', () => {
175
+ expect(tuple(1,2)).toEqual([1,2]);
176
+ });
177
+ });
178
+
179
+ describe('fnIf', () => {
180
+ it('returns one', () => {
181
+ expect(fnIf(true, 'this one', 'not this one')).toBe('this one');
182
+ });
183
+
184
+ it('returns two', () => {
185
+ expect(fnIf(false, 'not this one', 'this one')).toBe('this one');
186
+ });
187
+ });
188
+
189
+ describe('roundToPrecision', () => {
190
+ it('rounds positive places', () => {
191
+ expect(roundToPrecision(1234.123, 2)).toBe(1200);
192
+ });
193
+
194
+ it('rounds negative places', () => {
195
+ expect(roundToPrecision(1234.123, -2)).toBe(1234.12);
196
+ });
197
+
198
+ it('rounds up 5s', () => {
199
+ expect(roundToPrecision(1234.125, -2)).toBe(1234.13);
200
+ });
201
+ });
202
+
203
+ describe('memoize', () => {
204
+ it('memoizes', () => {
205
+ const fn = jest.fn((x: number) => x * 2);
206
+ const fnM = memoize(fn);
207
+
208
+ expect(fnM(3)).toBe(6);
209
+ expect(fnM(3)).toBe(6);
210
+ expect(fnM(3)).toBe(6);
211
+ expect(fnM(1)).toBe(2);
212
+ expect(fnM(1)).toBe(2);
213
+ expect(fnM(7)).toBe(14);
214
+
215
+ expect(fn).toHaveBeenCalledTimes(3);
216
+ });
217
+
218
+ it('handles multiple arguments', () => {
219
+ const fn = jest.fn((x: number, y: number, z: number = 1) => x * y * z);
220
+ const fnM = memoize(fn);
221
+
222
+ expect(fnM(3, 2)).toBe(6);
223
+ expect(fnM(3, 2)).toBe(6);
224
+ expect(fnM(3, 3)).toBe(9);
225
+ expect(fnM(3, 3, 2)).toBe(18);
226
+ expect(fnM(3, 3, 2)).toBe(18);
227
+ expect(fnM(1, 2)).toBe(2);
228
+ expect(fnM(1, 2)).toBe(2);
229
+ expect(fnM(7, 2)).toBe(14);
230
+
231
+ expect(fn).toHaveBeenCalledTimes(5);
232
+ });
233
+
234
+ it('memoizes object arguments', () => {
235
+ const fn = jest.fn((x: number, {y, z}: {y: number; z?: number}) => x * y * (z || 1));
236
+ const fnM = memoize(fn);
237
+
238
+ const two = {y: 2};
239
+ const threeTwo = {y:3, z: 2};
240
+
241
+ expect(fnM(3, two)).toBe(6);
242
+ expect(fnM(3, two)).toBe(6);
243
+ expect(fnM(3, {y: 3})).toBe(9);
244
+ expect(fnM(3, threeTwo)).toBe(18);
245
+ expect(fnM(3, threeTwo)).toBe(18);
246
+ expect(fnM(1, two)).toBe(2);
247
+ expect(fnM(1, two)).toBe(2);
248
+ expect(fnM(7, two)).toBe(14);
249
+
250
+ expect(fn).toHaveBeenCalledTimes(5);
251
+ });
252
+
253
+ describe('without WeakMap support', () => {
254
+ const weakMapBak = global.WeakMap;
255
+
256
+ beforeEach(() => {
257
+ delete (global as any).WeakMap;
258
+ });
259
+
260
+ afterEach(() => {
261
+ (global as any).WeakMap = weakMapBak;
262
+ });
263
+
264
+ it('still works', () => {
265
+ const fn = jest.fn((x: number, y: number, z: number = 1) => x * y * z);
266
+ const fnM = memoize(fn);
267
+
268
+ expect(fnM(3, 2)).toBe(6);
269
+ expect(fnM(3, 2)).toBe(6);
270
+ expect(fnM(3, 3)).toBe(9);
271
+ expect(fnM(3, 3, 2)).toBe(18);
272
+ expect(fnM(3, 3, 2)).toBe(18);
273
+ expect(fnM(1, 2)).toBe(2);
274
+ expect(fnM(1, 2)).toBe(2);
275
+ expect(fnM(7, 2)).toBe(14);
276
+
277
+ expect(fn).toHaveBeenCalledTimes(5);
278
+ });
279
+
280
+ it('doesn\'t memoize object arguments', () => {
281
+ const fn = jest.fn((x: number, {y, z}: {y: number; z?: number}) => x * y * (z || 1));
282
+ const fnM = memoize(fn);
283
+
284
+ const two = {y: 2};
285
+ const threeTwo = {y:3, z: 2};
286
+
287
+ expect(fnM(3, two)).toBe(6);
288
+ expect(fnM(3, two)).toBe(6);
289
+ expect(fnM(3, {y: 3})).toBe(9);
290
+ expect(fnM(3, threeTwo)).toBe(18);
291
+ expect(fnM(3, threeTwo)).toBe(18);
292
+ expect(fnM(1, two)).toBe(2);
293
+ expect(fnM(1, two)).toBe(2);
294
+ expect(fnM(7, two)).toBe(14);
295
+
296
+ expect(fn).toHaveBeenCalledTimes(8);
297
+ });
298
+ });
299
+
300
+ it('calls multiple times when the function returns a Promise that rejects (when it rejects)', async() => {
301
+ const spy = jest.fn(async(_x) => { throw new Error('Bad Request'); });
302
+ const memoized = memoize(spy);
303
+
304
+ const promise1 = memoized(1);
305
+ const promise2 = memoized(1);
306
+ const promise3 = memoized(2);
307
+
308
+ await expect(promise1).rejects.toThrow('Bad Request');
309
+ await expect(promise2).rejects.toThrow('Bad Request');
310
+ await expect(promise3).rejects.toThrow('Bad Request');
311
+
312
+ expect(spy).toHaveBeenCalledTimes(2);
313
+
314
+ await expect(memoized(2)).rejects.toThrow('Bad Request');
315
+
316
+ expect(spy).toHaveBeenCalledTimes(3);
317
+ });
318
+ });
319
+
320
+ describe('partitionSequence', () => {
321
+ it('partitions a sequence by predicate', () => {
322
+ expect(partitionSequence(
323
+ (n: number) => ({value: n % 2}),
324
+ [1,2,3,4,5,6,7,8]
325
+ )).toEqual([
326
+ [1, [1]],
327
+ [0, [2]],
328
+ [1, [3]],
329
+ [0, [4]],
330
+ [1, [5]],
331
+ [0, [6]],
332
+ [1, [7]],
333
+ [0, [8]],
334
+ ]);
335
+ expect(partitionSequence(
336
+ (n: number) => ({value: Math.floor(n / 3)}),
337
+ [1,2,3,4,5,6,7,8]
338
+ )).toEqual([
339
+ [0, [1,2]],
340
+ [1, [3,4, 5]],
341
+ [2, [6,7,8]],
342
+ ]);
343
+ });
344
+
345
+ it('partitions a sequence with running predicate', () => {
346
+ expect(partitionSequence(
347
+ (n: number, p?: {min: number; max: number}) =>
348
+ p && p.max + 1 === n
349
+ ? {value: {...p, max: n}, matches: true}
350
+ : {value: {min: n, max: n}, matches: false}
351
+ , [1,2,3,5,6,8]
352
+ )).toEqual([
353
+ [{min: 1, max: 3}, [1,2,3]],
354
+ [{min: 5,max: 6}, [5,6]],
355
+ [{min: 8,max: 8}, [8]],
356
+ ]);
357
+ });
358
+ });
359
+
360
+ describe('flow', () => {
361
+ it('flows', () => {
362
+ const fn = flow(
363
+ (n: number) => n * 4,
364
+ (n: number) => n.toString(),
365
+ (s: string) => [s, s],
366
+ (a: string[]) => a.join(', ')
367
+ );
368
+
369
+ expect(fn(2)).toBe('8, 8');
370
+ });
371
+ });
372
+
373
+ describe('coerceArray', () => {
374
+ it('coerces', () => {
375
+ expect(coerceArray('value')).toEqual(['value']);
376
+ });
377
+
378
+ it('no-ops', () => {
379
+ const array = ['foo'];
380
+ expect(coerceArray(array)).toBe(array);
381
+ });
382
+
383
+ it('handles undefined', () => {
384
+ expect(coerceArray(undefined)).toEqual([]);
385
+ });
386
+ });
387
+
388
+ describe('retryWithDelay', () => {
389
+ let setTimeoutSpy: jest.SpyInstance;
390
+ let timeouts: Array<number | undefined>;
391
+
392
+ const doBeforeEach = () => {
393
+ timeouts = [];
394
+ setTimeoutSpy = jest.spyOn(global, 'setTimeout')
395
+ .mockImplementation((fn, timeout) => {
396
+ timeouts.push(timeout);
397
+ fn();
398
+ return 1 as any;
399
+ });
400
+ };
401
+
402
+ const doAfterEach = () => {
403
+ setTimeoutSpy.mockReset();
404
+ };
405
+
406
+ beforeEach(doBeforeEach);
407
+ afterEach(doAfterEach);
408
+
409
+ it('runs once without delay', async() => {
410
+ const fn = jest.fn().mockReturnValue(Promise.resolve('hello'));
411
+ const result = await retryWithDelay(fn);
412
+ expect(setTimeoutSpy).not.toHaveBeenCalled();
413
+ expect(result).toBe('hello');
414
+ });
415
+
416
+ it('aborts without retrying', async() => {
417
+ const fn = jest.fn().mockImplementation(async abort => {
418
+ abort(new Error('cool error'));
419
+ throw new Error('unreachable code');
420
+ });
421
+ await expect(() => retryWithDelay(fn)).rejects.toThrow('cool error');
422
+ expect(setTimeoutSpy).not.toHaveBeenCalled();
423
+ });
424
+
425
+ it('retries within expected delay bounds', async() => {
426
+ for (let i = 0; i < 100; i++) {
427
+ doBeforeEach();
428
+ const fn = jest.fn()
429
+ .mockReturnValueOnce(Promise.reject(new Error('nope')))
430
+ .mockReturnValue(Promise.resolve('hello'));
431
+
432
+ const result = await retryWithDelay<string>(fn);
433
+
434
+ expect(result).toBe('hello');
435
+
436
+ expect(setTimeoutSpy).toHaveBeenCalledTimes(1);
437
+ expect(timeouts).toHaveLength(1);
438
+
439
+ expect(timeouts[0]).toBeGreaterThan(50);
440
+ expect(timeouts[0]).toBeLessThan(150);
441
+ doAfterEach();
442
+ }
443
+ });
444
+
445
+ it('throws when it runs out of attempts', async() => {
446
+ for (let i = 0; i < 100; i++) {
447
+ doBeforeEach();
448
+ const fn = jest.fn()
449
+ .mockReturnValueOnce(Promise.reject(new Error('nope')))
450
+ .mockReturnValueOnce(Promise.reject(new Error('nope')))
451
+ .mockReturnValueOnce(Promise.reject(new Error('nope')))
452
+ .mockReturnValueOnce(Promise.reject(new Error('nope')))
453
+ .mockReturnValue(Promise.resolve('hello'));
454
+
455
+ await expect(() => retryWithDelay<string>(fn, {retries: 3})).rejects.toThrow('nope');
456
+
457
+ expect(setTimeoutSpy).toHaveBeenCalledTimes(3);
458
+ expect(timeouts).toHaveLength(3);
459
+
460
+ expect(timeouts[0]).toBeGreaterThan(50);
461
+ expect(timeouts[0]).toBeLessThan(150);
462
+
463
+ expect(timeouts[1]).toBeGreaterThan(150);
464
+ expect(timeouts[1]).toBeLessThan(250);
465
+
466
+ expect(timeouts[2]).toBeGreaterThan(250);
467
+ expect(timeouts[2]).toBeLessThan(350);
468
+ doAfterEach();
469
+ }
470
+ });
471
+ });
@@ -0,0 +1,65 @@
1
+ import { ForbiddenError, InvalidRequestError, NotFoundError, SessionExpiredError, UnauthorizedError, ValidationError } from '../errors';
2
+ import { createCoreLogger, Logger } from '../services/logger';
3
+ import { createErrorHandler } from './apiErrorHandler';
4
+
5
+ describe('errorHandler', () => {
6
+ let logSpy: jest.SpyInstance;
7
+ let logger: Logger;
8
+
9
+ beforeEach(() => {
10
+ logSpy = jest.fn();
11
+ logger = createCoreLogger(logSpy as any);
12
+ });
13
+
14
+ afterEach(() => {
15
+ jest.clearAllMocks();
16
+ });
17
+
18
+ it('handles InvalidRequestError with 400', async () => {
19
+ expect(await createErrorHandler()(new InvalidRequestError(), logger)).toEqual(expect.objectContaining({statusCode: 400}));
20
+ });
21
+
22
+ it('handles UnauthorizedError with 401', async() => {
23
+ expect(await createErrorHandler()(new UnauthorizedError(), logger)).toEqual(expect.objectContaining({statusCode: 401}));
24
+ });
25
+
26
+ it('handles ForbiddenError with 403', async() => {
27
+ expect(await createErrorHandler()(new ForbiddenError(), logger)).toEqual(expect.objectContaining({statusCode: 403}));
28
+ });
29
+
30
+ it('handles NotFoundError with 404', async () => {
31
+ expect(await createErrorHandler()(new NotFoundError(), logger)).toEqual(expect.objectContaining({statusCode: 404}));
32
+ });
33
+
34
+ it('handles ValidationError with 422', async () => {
35
+ const error = new ValidationError({field: 'value'});
36
+ expect(await createErrorHandler()(error, logger)).toMatchInlineSnapshot(`
37
+ {
38
+ "body": "{"field":"value"}",
39
+ "data": {
40
+ "field": "value",
41
+ },
42
+ "headers": {
43
+ "content-type": "application/json",
44
+ },
45
+ "statusCode": 422,
46
+ }
47
+ `);
48
+ });
49
+
50
+ it('handles SessionExpired error with 440', async() => {
51
+ expect(await createErrorHandler()(new SessionExpiredError(), logger)).toEqual(expect.objectContaining(({
52
+ statusCode: 440,
53
+ body: '440 SessionExpiredError'
54
+ })));
55
+ });
56
+
57
+ it('handles unknown error with 500', async() => {
58
+ expect(await createErrorHandler()(new Error(), logger)).toEqual(expect.objectContaining({statusCode: 500}));
59
+ });
60
+
61
+ it('logs unknown error', async () => {
62
+ await createErrorHandler()(new Error(), logger);
63
+ expect(logSpy).toHaveBeenCalled();
64
+ });
65
+ });
@@ -0,0 +1,67 @@
1
+ import {
2
+ ForbiddenError,
3
+ InvalidRequestError,
4
+ isAppError,
5
+ NotFoundError,
6
+ SessionExpiredError,
7
+ UnauthorizedError,
8
+ ValidationError,
9
+ } from '../errors';
10
+ import type { ApiResponse } from '../routing';
11
+ import { apiJsonResponse, apiTextResponse } from '../routing';
12
+ import type { Logger } from '../services/logger';
13
+ import { Level } from '../services/logger';
14
+
15
+ export type DefaultErrors = {
16
+ InvalidRequestError: InvalidRequestError;
17
+ UnauthorizedError: UnauthorizedError;
18
+ ForbiddenError: ForbiddenError;
19
+ NotFoundError: NotFoundError;
20
+ ValidationError: ValidationError;
21
+ SessionExpiredError: SessionExpiredError;
22
+ };
23
+
24
+ export type Handlers<E> = {
25
+ [T in keyof E]?: (e: E[T], logger: Logger) => ApiResponse<number, any>;
26
+ };
27
+
28
+ export const defaultHandlers: Handlers<DefaultErrors> = {
29
+ InvalidRequestError: (e) => apiTextResponse(400, `400 ${e.message}`),
30
+ UnauthorizedError: (e) => apiTextResponse(401, `401 ${e.message}`),
31
+ ForbiddenError: (e) => apiTextResponse(403, `403 ${e.message}`),
32
+ NotFoundError: (e) => apiTextResponse(404, `404 ${e.message}`),
33
+ ValidationError: (e) => apiJsonResponse(422, e.getData()),
34
+ SessionExpiredError: (e) => apiTextResponse(440, `440 ${e.message}`),
35
+ };
36
+
37
+ /**
38
+ * Creates an error handler. Provides default handlers for `UnauthorizedError`,
39
+ * `SessionExpiredError`, `NotFoundError`, and `InvalidRequestError`. User-specified
40
+ * handlers can be added to these. If no handler is found, the error is logged and
41
+ * a 500 text response is returned.
42
+ *
43
+ * @param inputHandlers a map of errors to handler functions
44
+ */
45
+ export const createErrorHandler = <Errors = DefaultErrors>(inputHandlers?: Handlers<Errors>) => {
46
+ const handlers = {...defaultHandlers, ...inputHandlers};
47
+
48
+ return async(e: Error, logger: Logger) => {
49
+ const name = isAppError(e) ? e.constructor.TYPE : e.constructor.name;
50
+ const handler = handlers[name as keyof typeof handlers];
51
+ const logLevel = handler ? Level.Info : Level.Error;
52
+
53
+ logger.logEvent(logLevel, {
54
+ name: e.name,
55
+ message: e.message,
56
+ stack: e.stack,
57
+ });
58
+
59
+ if (handler) {
60
+ // convincing typescript that this error is the right kind for the handler
61
+ // we looked up based on the errors name is very annoying
62
+ return handler(e as any, logger);
63
+ }
64
+
65
+ return apiTextResponse(500, '500 Error');
66
+ };
67
+ };