@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
@@ -1,24 +0,0 @@
1
- import { ForbiddenError, InvalidRequestError, NotFoundError, SessionExpiredError, UnauthorizedError, ValidationError } from '../errors';
2
- import type { ApiResponse } from '../routing';
3
- import type { Logger } from '../services/logger';
4
- export type DefaultErrors = {
5
- InvalidRequestError: InvalidRequestError;
6
- UnauthorizedError: UnauthorizedError;
7
- ForbiddenError: ForbiddenError;
8
- NotFoundError: NotFoundError;
9
- ValidationError: ValidationError;
10
- SessionExpiredError: SessionExpiredError;
11
- };
12
- export type Handlers<E> = {
13
- [T in keyof E]?: (e: E[T], logger: Logger) => ApiResponse<number, any>;
14
- };
15
- export declare const defaultHandlers: Handlers<DefaultErrors>;
16
- /**
17
- * Creates an error handler. Provides default handlers for `UnauthorizedError`,
18
- * `SessionExpiredError`, `NotFoundError`, and `InvalidRequestError`. User-specified
19
- * handlers can be added to these. If no handler is found, the error is logged and
20
- * a 500 text response is returned.
21
- *
22
- * @param inputHandlers a map of errors to handler functions
23
- */
24
- export declare const createErrorHandler: <Errors = DefaultErrors>(inputHandlers?: Handlers<Errors>) => (e: Error, logger: Logger) => Promise<ApiResponse<number, any>>;
@@ -1,38 +0,0 @@
1
- import { isAppError, } from '../errors';
2
- import { apiJsonResponse, apiTextResponse } from '../routing';
3
- import { Level } from '../services/logger';
4
- export const defaultHandlers = {
5
- InvalidRequestError: (e) => apiTextResponse(400, `400 ${e.message}`),
6
- UnauthorizedError: (e) => apiTextResponse(401, `401 ${e.message}`),
7
- ForbiddenError: (e) => apiTextResponse(403, `403 ${e.message}`),
8
- NotFoundError: (e) => apiTextResponse(404, `404 ${e.message}`),
9
- ValidationError: (e) => apiJsonResponse(422, e.getData()),
10
- SessionExpiredError: (e) => apiTextResponse(440, `440 ${e.message}`),
11
- };
12
- /**
13
- * Creates an error handler. Provides default handlers for `UnauthorizedError`,
14
- * `SessionExpiredError`, `NotFoundError`, and `InvalidRequestError`. User-specified
15
- * handlers can be added to these. If no handler is found, the error is logged and
16
- * a 500 text response is returned.
17
- *
18
- * @param inputHandlers a map of errors to handler functions
19
- */
20
- export const createErrorHandler = (inputHandlers) => {
21
- const handlers = { ...defaultHandlers, ...inputHandlers };
22
- return async (e, logger) => {
23
- const name = isAppError(e) ? e.constructor.TYPE : e.constructor.name;
24
- const handler = handlers[name];
25
- const logLevel = handler ? Level.Info : Level.Error;
26
- logger.logEvent(logLevel, {
27
- name: e.name,
28
- message: e.message,
29
- stack: e.stack,
30
- });
31
- if (handler) {
32
- // convincing typescript that this error is the right kind for the handler
33
- // we looked up based on the errors name is very annoying
34
- return handler(e, logger);
35
- }
36
- return apiTextResponse(500, '500 Error');
37
- };
38
- };
@@ -1,23 +0,0 @@
1
- import type { ConfigProviderForConfig } from '../config';
2
- import type { ApiResponse } from '../routing';
3
- import type { Logger } from '../services/logger';
4
- type Config = {
5
- logResponseSlowerThan: string;
6
- timeoutResponseAfter: string;
7
- };
8
- /**
9
- * Creates response middleware that logs slow responses and times out responses that take too long. lambda functions have a timeout setting, but when a lambda times out there is no way to log anything helpful before it exists. this middleware allows the logger context to show up for timeout requests. just make sure that the `timeoutResponseAfter` is set to something slightly shorter than the lambda timeout so that it has time to run.
10
- *
11
- * @param config
12
- * @param config.logResponseSlowerThan the config that specifies the threshold for a slow response
13
- * @param config.timeoutResponseAfter the config that specifies the timeout for a response
14
- * @example
15
- * createSlowResponseMiddleware({
16
- * logResponseSlowerThan: envConfig('LOG_SLOW_RESPONSE', 'runtime', '1000'),
17
- * timeoutResponseAfter: envConfig('RESPONSE_TIMEOUT', 'runtime', '28000'),
18
- * });
19
- */
20
- export declare const createSlowResponseMiddleware: (config: ConfigProviderForConfig<Config>) => () => (response: Promise<ApiResponse<number, any>> | undefined, { logger }: {
21
- logger: Logger;
22
- }) => Promise<ApiResponse<number, string>> | undefined;
23
- export {};
@@ -1,50 +0,0 @@
1
- import { resolveConfigValue } from '../config/resolveConfigValue';
2
- import { once } from '../misc/helpers';
3
- import { apiTextResponse } from '../routing';
4
- import { Level } from '../services/logger';
5
- /**
6
- * Creates response middleware that logs slow responses and times out responses that take too long. lambda functions have a timeout setting, but when a lambda times out there is no way to log anything helpful before it exists. this middleware allows the logger context to show up for timeout requests. just make sure that the `timeoutResponseAfter` is set to something slightly shorter than the lambda timeout so that it has time to run.
7
- *
8
- * @param config
9
- * @param config.logResponseSlowerThan the config that specifies the threshold for a slow response
10
- * @param config.timeoutResponseAfter the config that specifies the timeout for a response
11
- * @example
12
- * createSlowResponseMiddleware({
13
- * logResponseSlowerThan: envConfig('LOG_SLOW_RESPONSE', 'runtime', '1000'),
14
- * timeoutResponseAfter: envConfig('RESPONSE_TIMEOUT', 'runtime', '28000'),
15
- * });
16
- */
17
- export const createSlowResponseMiddleware = (config) => {
18
- const getSlowThreshold = once(() => resolveConfigValue(config.logResponseSlowerThan).then(result => parseInt(result, 10)));
19
- const getTimeoutAfter = once(() => resolveConfigValue(config.timeoutResponseAfter).then(result => parseInt(result, 10)));
20
- return () => (response, { logger }) => {
21
- const start = Date.now();
22
- if (!response) {
23
- return response;
24
- }
25
- return Promise.all([getSlowThreshold(), getTimeoutAfter()]).then(([slowThreshold, timeoutAfter]) => {
26
- let timeout = undefined;
27
- const timeoutPromise = isNaN(timeoutAfter)
28
- ? undefined
29
- : new Promise(resolve => timeout = setTimeout(() => {
30
- logger.logEvent(Level.Error, {
31
- message: 'request processing timed out',
32
- });
33
- resolve(apiTextResponse(504, '504 Gateway Timeout'));
34
- }, timeoutAfter));
35
- const requestPromise = response.finally(() => {
36
- const time = Date.now() - start;
37
- if (timeout !== undefined) {
38
- clearTimeout(timeout);
39
- }
40
- if (time > slowThreshold) {
41
- logger.logEvent(Level.Warn, {
42
- message: 'slow response',
43
- time,
44
- });
45
- }
46
- });
47
- return timeoutPromise ? Promise.race([timeoutPromise, requestPromise]) : requestPromise;
48
- });
49
- };
50
- };
@@ -1,47 +0,0 @@
1
- import { TupleZip } from '../types';
2
- export type MiddlewareProvider<Sa, M, A extends any[], R> = (app: Sa, appBinder?: ((app: Sa, provider: MiddlewareProvider<Sa, M, A, R>) => (middleware: M, ...args: A) => R)) => (middleware: M, ...args: A) => R;
3
- export type MiddlewareTransformProvider<Sa, M, A extends any[], R> = (app: Sa) => (middleware: M, ...args: A) => Omit<M, keyof R> & R;
4
- export type MiddlewareInput<S> = S extends MiddlewareProvider<any, infer M, any, any> ? M : never;
5
- export type ServiceMiddlewareProviderResult<M, S> = [M] extends [never] ? never : [M] extends [MiddlewareInput<S>] ? S extends MiddlewareTransformProvider<any, M, any, infer R> ? (Omit<R, keyof M> & M) extends R ? Omit<R, keyof M> & M : R extends M ? R : Omit<M, keyof R> & R : S extends MiddlewareProvider<any, M, any, infer R> ? R : never : never;
6
- export type ServiceMiddlewareProviderArgs<S> = S extends MiddlewareProvider<any, any, infer A, any> ? A : never;
7
- export type ServiceMiddlewareProviderChainResult<C, M> = C extends [infer S1, ...infer S] ? S extends never[] ? ServiceMiddlewareProviderResult<M, S1> : ServiceMiddlewareProviderChainResult<S, ServiceMiddlewareProviderResult<M, S1>> : C extends unknown ? M : never;
8
- export type ServiceMiddlewareProviderChainArgs<C> = C extends [infer S1, ...infer S] ? S extends never[] ? ServiceMiddlewareProviderArgs<S1> : TupleZip<ServiceMiddlewareProviderChainArgs<S>, ServiceMiddlewareProviderArgs<S1>> : C extends unknown ? [] : never;
9
- /**
10
- * Creates a middleware composer for given AppServices and input value types. The composer accepts a list of middleware
11
- * that it assembles into a chain. The function returned by the composer takes a value of the given input value type,
12
- * passes that value through the chain, and returns the result of the last element in the chain. The ending value will
13
- * depend on the composed middleware.
14
- *
15
- * Examples:
16
- *
17
- * ```
18
- * export const composeServiceMiddleware =
19
- * makeComposeMiddleware<AppServices, {request: ApiRouteRequest}>();
20
- * export const composeResponseMiddleware =
21
- * makeComposeMiddleware<AppServices, Promise<ApiRouteResponse> | undefined>();
22
- *
23
- * // `requestServiceProvider` is a function that expects
24
- * //`{request: ApiRouteRequest}` (specified in the call to
25
- * //`makeComposeMiddleware`); for requestServiceProviders as part of routes in
26
- * // particular, the request responder calls this when it resolves the routes.
27
- *
28
- * const requestServiceProvider = composeServiceMiddleware(
29
- * cookieAuthMiddleware, // expects `request` (from input), adds `authProvider`
30
- * myDocumentStoreMiddleware, // expects authProvider, adds the document store
31
- * myDocumentSearchMiddleware, // expects document store, adds search provider
32
- * ); // if you try to specify them in the wrong order it'll yell at you
33
- * ```
34
- *
35
- * WARNING: depending on how you use it, typescript _sometimes_ explodes on these recursive types. if you have problems in your build
36
- * with memory, you will have to specify the expected result type when calling the middleware reducer. this is a little annoying,
37
- * but it will still correctly error if the type you specify is wrong, so you've still got the type safety.
38
- *
39
- * ```
40
- * // this might work, or it might make your compiler run out of memory
41
- * eg: const myThing = makeComposeMiddleware()(...);
42
- *
43
- * // this helps typescript figure out what is going on
44
- * eg: const myThing: myType = makeComposeMiddleware()(...);
45
- * ```
46
- */
47
- export declare const makeComposeMiddleware: <Sa, M>() => <C extends any[]>(...chain: C) => MiddlewareProvider<Sa, M, ServiceMiddlewareProviderChainArgs<C>, ServiceMiddlewareProviderChainResult<C, M>>;
@@ -1,44 +0,0 @@
1
- /**
2
- * Creates a middleware composer for given AppServices and input value types. The composer accepts a list of middleware
3
- * that it assembles into a chain. The function returned by the composer takes a value of the given input value type,
4
- * passes that value through the chain, and returns the result of the last element in the chain. The ending value will
5
- * depend on the composed middleware.
6
- *
7
- * Examples:
8
- *
9
- * ```
10
- * export const composeServiceMiddleware =
11
- * makeComposeMiddleware<AppServices, {request: ApiRouteRequest}>();
12
- * export const composeResponseMiddleware =
13
- * makeComposeMiddleware<AppServices, Promise<ApiRouteResponse> | undefined>();
14
- *
15
- * // `requestServiceProvider` is a function that expects
16
- * //`{request: ApiRouteRequest}` (specified in the call to
17
- * //`makeComposeMiddleware`); for requestServiceProviders as part of routes in
18
- * // particular, the request responder calls this when it resolves the routes.
19
- *
20
- * const requestServiceProvider = composeServiceMiddleware(
21
- * cookieAuthMiddleware, // expects `request` (from input), adds `authProvider`
22
- * myDocumentStoreMiddleware, // expects authProvider, adds the document store
23
- * myDocumentSearchMiddleware, // expects document store, adds search provider
24
- * ); // if you try to specify them in the wrong order it'll yell at you
25
- * ```
26
- *
27
- * WARNING: depending on how you use it, typescript _sometimes_ explodes on these recursive types. if you have problems in your build
28
- * with memory, you will have to specify the expected result type when calling the middleware reducer. this is a little annoying,
29
- * but it will still correctly error if the type you specify is wrong, so you've still got the type safety.
30
- *
31
- * ```
32
- * // this might work, or it might make your compiler run out of memory
33
- * eg: const myThing = makeComposeMiddleware()(...);
34
- *
35
- * // this helps typescript figure out what is going on
36
- * eg: const myThing: myType = makeComposeMiddleware()(...);
37
- * ```
38
- */
39
- export const makeComposeMiddleware = () => (...chain) => (app, appBinder) => {
40
- const boundChain = chain.map(provider => appBinder ? appBinder(app, provider) : provider(app));
41
- return (middleware, ...args) => {
42
- return boundChain.reduce((result, provider) => provider(result, ...args), middleware);
43
- };
44
- };
@@ -1,20 +0,0 @@
1
- import { APIGatewayProxyEventV2 } from 'aws-lambda';
2
- import { ConfigProviderForConfig } from '../config';
3
- import { ApiResponse } from '../routing';
4
- type Config = {
5
- corsAllowedHostRegex: string;
6
- };
7
- /**
8
- * Creates response middleware that adds CORS headers to responses from approved hosts.
9
- *
10
- * @param config the config object
11
- * @param config.corsAllowedHostRegex the config that specifies the regex for allowed hosts
12
- * @example
13
- * createLambdaCorsResponseMiddleware({
14
- * corsAllowedHostRegex: '(openstax.org|herokuapp.com)$'
15
- * }),
16
- */
17
- export declare const createLambdaCorsResponseMiddleware: (config: ConfigProviderForConfig<Config>) => () => (responsePromise: Promise<ApiResponse<number, any>> | undefined, { request }: {
18
- request: APIGatewayProxyEventV2;
19
- }) => Promise<ApiResponse<number, any>> | undefined;
20
- export {};
@@ -1,40 +0,0 @@
1
- import { resolveConfigValue } from '../config/resolveConfigValue';
2
- import { once } from '../misc/helpers';
3
- import { apiTextResponse } from '../routing';
4
- /**
5
- * Creates response middleware that adds CORS headers to responses from approved hosts.
6
- *
7
- * @param config the config object
8
- * @param config.corsAllowedHostRegex the config that specifies the regex for allowed hosts
9
- * @example
10
- * createLambdaCorsResponseMiddleware({
11
- * corsAllowedHostRegex: '(openstax.org|herokuapp.com)$'
12
- * }),
13
- */
14
- export const createLambdaCorsResponseMiddleware = (config) => () => (responsePromise, { request }) => {
15
- const getAllowedHostRegex = once(() => resolveConfigValue(config.corsAllowedHostRegex));
16
- const cors = async () => {
17
- const allowedHost = await getAllowedHostRegex();
18
- if (request.headers.origin && request.headers.origin !== 'null' && new URL(request.headers.origin).hostname.match(new RegExp(allowedHost))) {
19
- return {
20
- 'Access-Control-Allow-Origin': request.headers.origin,
21
- 'Access-Control-Allow-Credentials': 'true',
22
- 'Access-Control-Allow-Headers': 'content-type, x-request-id',
23
- 'Access-Control-Allow-Methods': 'POST, GET, PUT, PATCH, DELETE, OPTIONS',
24
- };
25
- }
26
- };
27
- if (responsePromise) {
28
- return responsePromise.then(async (response) => {
29
- response.headers = {
30
- ...await cors(),
31
- ...response.headers
32
- };
33
- return response;
34
- });
35
- }
36
- if (request.requestContext.http.method === 'OPTIONS') {
37
- return cors().then(headers => apiTextResponse(200, '', headers));
38
- }
39
- return responsePromise;
40
- };
@@ -1,4 +0,0 @@
1
- /**
2
- * Creates response middleware that throws a `NotFoundError` if the response is undefined.
3
- */
4
- export declare const createThrowNotFoundMiddleware: <Ro>() => () => (response: Promise<Ro> | undefined) => Promise<Ro>;
@@ -1,10 +0,0 @@
1
- import { NotFoundError } from '../errors';
2
- /**
3
- * Creates response middleware that throws a `NotFoundError` if the response is undefined.
4
- */
5
- export const createThrowNotFoundMiddleware = () => () => (response) => {
6
- if (!response) {
7
- throw new NotFoundError('not found');
8
- }
9
- return response;
10
- };
@@ -1,10 +0,0 @@
1
- export type HashValue = string | number | boolean | null | HashCompoundValue;
2
- export type HashCompoundValue = Array<HashValue> | {
3
- [key: string]: HashValue;
4
- };
5
- /**
6
- * creates a string hash of lots of different kinds of things.
7
- *
8
- * @example hashValue({someKey: 'someValue'})
9
- */
10
- export declare const hashValue: (value: HashValue) => string;
@@ -1,13 +0,0 @@
1
- import { createHash } from 'crypto';
2
- /**
3
- * creates a string hash of lots of different kinds of things.
4
- *
5
- * @example hashValue({someKey: 'someValue'})
6
- */
7
- export const hashValue = (value) => {
8
- // hack for sorting keys https://stackoverflow.com/a/53593328/14809536
9
- const allKeys = new Set();
10
- JSON.stringify(value, (k, v) => (allKeys.add(k), v));
11
- const strValue = JSON.stringify(value, Array.from(allKeys).sort());
12
- return createHash('sha1').update(strValue).digest('hex');
13
- };
@@ -1,124 +0,0 @@
1
- import type { Logger } from '../services/logger';
2
- /**
3
- * Returns a function that gets the value of the given key from an object
4
- *
5
- * @param key
6
- * @example
7
- * const getAuthor = getKeyValue('author');
8
- * const author = getAuthor(book);
9
- */
10
- export declare const getKeyValue: <K extends string>(key: K) => <O extends { [_key in K]?: any; }>(obj: O) => O[K];
11
- /**
12
- * Returns a function that gets the value of the given key from an object, or the given default
13
- * value if the key is not present.
14
- *
15
- * @param key
16
- * @param defaultValue a default value matching the type of the value at the given key
17
- * @example
18
- * const getAuthorOrNope = getKeyValueOr('author', 'nope');
19
- * const authorOrNope = getAuthorOrNope(book);
20
- */
21
- export declare const getKeyValueOr: <K extends string, V, Od extends { [_key in K]?: any; } = { [_key in K]?: any; }>(key: K, defaultValue: V) => <O extends (Od extends undefined ? { [_key in K]?: any; } : Od)>(obj: O) => NonNullable<O[K]> | V;
22
- /**
23
- * Returns a function that sets the value of the given key on an object.
24
- *
25
- * @param key
26
- * @example
27
- * const putAuthor = putKeyValue('author');
28
- * const newBook = putAuthor(book, 'tom');
29
- */
30
- export declare const putKeyValue: <K extends string>(key: K) => <O extends { [_key in K]?: any; }>(obj: O, value: O[K]) => O;
31
- /**
32
- * Coerces a value into an array. If the value is already an array, it is returned as-is.
33
- * If the value is undefined, an empty array is returned.
34
- *
35
- * @param thing the value
36
- * @returns an array
37
- */
38
- export declare const coerceArray: <T>(thing: undefined | T | T[]) => T[];
39
- type FlowFn<A, R> = (...args: [A]) => R;
40
- type AnyFlowFn = FlowFn<any, any>;
41
- type FlowFnResult<F, A> = F extends FlowFn<A, infer R> ? R : never;
42
- type FlowResult<C, A> = C extends [infer F1, ...infer Cr] ? F1 extends AnyFlowFn ? Cr extends never[] ? FlowFnResult<F1, A> : FlowResult<Cr, FlowFnResult<F1, A>> : never : never;
43
- type FlowChainArg<C> = C extends [infer F1, ...infer _] ? F1 extends FlowFn<infer A, any> ? A : never : never;
44
- /**
45
- * this is like lodash/flow but it uses a recursive type instead of hard-coding parameters
46
- */
47
- export declare const flow: <C extends AnyFlowFn[]>(...chain: C) => (param: FlowChainArg<C>) => FlowResult<C, FlowChainArg<C>>;
48
- export type RetryOptions = {
49
- logger?: Logger;
50
- wait?: number;
51
- splay?: number;
52
- retries?: number;
53
- n?: number;
54
- };
55
- /**
56
- * Retries a function with a delay between retries.
57
- * @param fn The function to retry
58
- * @param [options] retry options
59
- * @param [options.wait=100] base wait of first retry (number), further retries are: t=n*wait,
60
- * default: 100
61
- * @param [options.splay=0.5] percentage to modify t by. 0.5 is 50%, which would make
62
- * t=n*wait+rand(wait*splay*-1, wait*splay), default: 0.5
63
- * @param [options.retries=2] number of times to retry. (2 retries means it'll try a max of 3 times),
64
- * default: 2
65
- * @param [options.n=0] the starting retry index. probably don't set this. unless you really want a very steep
66
- * initial wait cliff with incremental increases, then maybe you'd set this. default: 0
67
- * @returns A promise that resolves with the result of the function, or rejects with the last error.
68
- */
69
- export declare const retryWithDelay: <R>(fn: (abort?: (e: Error) => never) => Promise<R>, options?: RetryOptions) => Promise<R>;
70
- /**
71
- * a shameful helper to avoid needing to test code coverage of branches
72
- */
73
- export declare const fnIf: <T1, T2>(condition: boolean, trueValue: T1, falseValue: T2) => T1 | T2;
74
- /**
75
- * maps the array and returns the first result that matches the predicate
76
- * avoids processing extra elements that would happen with .map().find() or .reduce
77
- *
78
- * eg the third element of the array is never processed:
79
- * const result = mapFind([1,2,3], x => 'hello'.charAt(x), x => x === 'l');
80
- */
81
- export declare const mapFind: <I, R>(array: I[], mapper: (item: I) => R, predicate?: (result: R) => boolean) => R | undefined;
82
- /**
83
- * returns a function that will only ever call the given function once, returning the first result for every subsequent call
84
- *
85
- * does not cache rejected promises, to avoid cache poisoning on failed async requests
86
- *
87
- * eg:
88
- * const heavyFunction = () => 'hello';
89
- * const butOnlyOnce = once(() => 'hello');
90
- *
91
- * heavyFunction() // returns `hello`;
92
- * butOnlyOnce() // returns `hello`;
93
- */
94
- export declare const once: <F extends (...args: any[]) => any>(fn: F) => F;
95
- /**
96
- * memoizes a function with any number of arguments
97
- *
98
- * does not cache rejected promises, to avoid cache poisoning on failed async requests
99
- */
100
- export declare const memoize: <F extends (...args: any[]) => any>(fn: F) => F;
101
- /**
102
- * rounds number to given number of places
103
- *
104
- * eg:
105
- * roundToPrecision(1234.123, 2); // returns 1200
106
- * roundToPrecision(1234.123, -2); // returns 1234.12
107
- * roundToPrecision(1234.125, -2); // returns 1234.13
108
- */
109
- export declare const roundToPrecision: (num: number, places: number) => number;
110
- /**
111
- * a silly utility to help typescript realize an array is a tuple
112
- *
113
- * eg:
114
- * const a = [5, 'string'] // type is `Array<string | number>`
115
- * const t = tuple(5, 'string') type is `[5, 'string']`
116
- *
117
- * both have the same javascript value, but one is forced to be a tuple, which
118
- * is nice if its structure is important. examples are like the React.useState
119
- * pattern where there are two return values in a tuple, or if you're feeding
120
- * Object.fromEntries
121
- *
122
- */
123
- export declare const tuple: <A extends any[]>(...args: A) => A;
124
- export {};
@@ -1,199 +0,0 @@
1
- /*
2
- * there was a reason i made these instead of using lodash/fp but i forget what it was. i think maybe
3
- * these do more validation that the second function gets a compatible object.
4
- */
5
- /**
6
- * Returns a function that gets the value of the given key from an object
7
- *
8
- * @param key
9
- * @example
10
- * const getAuthor = getKeyValue('author');
11
- * const author = getAuthor(book);
12
- */
13
- export const getKeyValue = (key) => (obj) => obj[key];
14
- /**
15
- * Returns a function that gets the value of the given key from an object, or the given default
16
- * value if the key is not present.
17
- *
18
- * @param key
19
- * @param defaultValue a default value matching the type of the value at the given key
20
- * @example
21
- * const getAuthorOrNope = getKeyValueOr('author', 'nope');
22
- * const authorOrNope = getAuthorOrNope(book);
23
- */
24
- export const getKeyValueOr = (key, defaultValue) => (obj) => obj[key] || defaultValue;
25
- /**
26
- * Returns a function that sets the value of the given key on an object.
27
- *
28
- * @param key
29
- * @example
30
- * const putAuthor = putKeyValue('author');
31
- * const newBook = putAuthor(book, 'tom');
32
- */
33
- export const putKeyValue = (key) => (obj, value) => ({ ...obj, [key]: value });
34
- /**
35
- * Coerces a value into an array. If the value is already an array, it is returned as-is.
36
- * If the value is undefined, an empty array is returned.
37
- *
38
- * @param thing the value
39
- * @returns an array
40
- */
41
- export const coerceArray = (thing) => thing instanceof Array ? thing : thing !== undefined ? [thing] : [];
42
- /**
43
- * this is like lodash/flow but it uses a recursive type instead of hard-coding parameters
44
- */
45
- export const flow = (...chain) => (param) => {
46
- let result = param;
47
- for (const fn of chain) {
48
- result = fn(result);
49
- }
50
- return result;
51
- };
52
- /**
53
- * Retries a function with a delay between retries.
54
- * @param fn The function to retry
55
- * @param [options] retry options
56
- * @param [options.wait=100] base wait of first retry (number), further retries are: t=n*wait,
57
- * default: 100
58
- * @param [options.splay=0.5] percentage to modify t by. 0.5 is 50%, which would make
59
- * t=n*wait+rand(wait*splay*-1, wait*splay), default: 0.5
60
- * @param [options.retries=2] number of times to retry. (2 retries means it'll try a max of 3 times),
61
- * default: 2
62
- * @param [options.n=0] the starting retry index. probably don't set this. unless you really want a very steep
63
- * initial wait cliff with incremental increases, then maybe you'd set this. default: 0
64
- * @returns A promise that resolves with the result of the function, or rejects with the last error.
65
- */
66
- export const retryWithDelay = (fn, options) => {
67
- const { wait, splay, retries, n } = { wait: 100, splay: 0.5, retries: 2, n: 0, ...options };
68
- if (n >= retries) {
69
- return fn();
70
- }
71
- let aborted = false;
72
- const timeout = (n + 1) * wait + (Math.random() * 2 - 1) * splay * wait;
73
- const retry = (e) => new Promise((resolve, reject) => {
74
- var _a;
75
- if (aborted) {
76
- reject(e);
77
- }
78
- else {
79
- (_a = options === null || options === void 0 ? void 0 : options.logger) === null || _a === void 0 ? void 0 : _a.log(`failed try ${n + 1} of ${retries}. ${e.message}`);
80
- setTimeout(() => retryWithDelay(fn, { ...options, n: n + 1 }).then(resolve, reject), timeout);
81
- }
82
- });
83
- const abort = (e) => {
84
- aborted = true;
85
- throw e;
86
- };
87
- return fn(abort).catch(retry);
88
- };
89
- /**
90
- * a shameful helper to avoid needing to test code coverage of branches
91
- */
92
- export const fnIf = (condition, trueValue, falseValue) => condition ? trueValue : falseValue;
93
- /**
94
- * maps the array and returns the first result that matches the predicate
95
- * avoids processing extra elements that would happen with .map().find() or .reduce
96
- *
97
- * eg the third element of the array is never processed:
98
- * const result = mapFind([1,2,3], x => 'hello'.charAt(x), x => x === 'l');
99
- */
100
- export const mapFind = (array, mapper, predicate = (r) => !!r) => {
101
- for (const item of array) {
102
- const mapped = mapper(item);
103
- if (predicate(mapped)) {
104
- return mapped;
105
- }
106
- }
107
- };
108
- /**
109
- * returns a function that will only ever call the given function once, returning the first result for every subsequent call
110
- *
111
- * does not cache rejected promises, to avoid cache poisoning on failed async requests
112
- *
113
- * eg:
114
- * const heavyFunction = () => 'hello';
115
- * const butOnlyOnce = once(() => 'hello');
116
- *
117
- * heavyFunction() // returns `hello`;
118
- * butOnlyOnce() // returns `hello`;
119
- */
120
- export const once = (fn) => {
121
- const initialValue = {};
122
- let result = initialValue;
123
- return ((...args) => {
124
- if (result !== initialValue) {
125
- return result;
126
- }
127
- result = fn(...args);
128
- if (typeof result === 'object' && result instanceof Promise) {
129
- // Clear the result when possible but do not return a Promise that resolves to the initialValue
130
- result.catch(() => result = initialValue);
131
- }
132
- // If this is a rejected Promise, it should be returned before catch() actually overwrites it
133
- return result;
134
- });
135
- };
136
- /**
137
- * memoizes a function with any number of arguments
138
- *
139
- * does not cache rejected promises, to avoid cache poisoning on failed async requests
140
- */
141
- export const memoize = (fn) => {
142
- const cache = {};
143
- const resolveCache = (cacheLayer, [first, ...rest]) => {
144
- if (!first) {
145
- return cacheLayer;
146
- }
147
- const layers = first instanceof Object
148
- ? (cacheLayer.weakLayers = (cacheLayer.weakLayers || (typeof WeakMap === 'undefined' ? undefined : new WeakMap())))
149
- : (cacheLayer.strongLayers = (cacheLayer.strongLayers || new Map()));
150
- // argument is an object and WeakMap is not supported
151
- if (!layers) {
152
- return {};
153
- }
154
- const layer = layers.get(first) || {};
155
- if (!layers.has(first)) {
156
- layers.set(first, layer);
157
- }
158
- return resolveCache(layer, rest);
159
- };
160
- return ((...args) => {
161
- const thisCache = resolveCache(cache, args);
162
- if ('result' in thisCache) {
163
- return thisCache.result;
164
- }
165
- thisCache.result = fn(...args);
166
- if (typeof thisCache.result === 'object' && thisCache.result instanceof Promise) {
167
- // Clear the result when possible but do not return a Promise that resolves to the initialValue
168
- thisCache.result.catch(() => delete thisCache.result);
169
- }
170
- return thisCache.result;
171
- });
172
- };
173
- /**
174
- * rounds number to given number of places
175
- *
176
- * eg:
177
- * roundToPrecision(1234.123, 2); // returns 1200
178
- * roundToPrecision(1234.123, -2); // returns 1234.12
179
- * roundToPrecision(1234.125, -2); // returns 1234.13
180
- */
181
- export const roundToPrecision = (num, places) => {
182
- const multiplier = Math.pow(10, -1 * places);
183
- // https://stackoverflow.com/a/11832950/14809536
184
- return Math.round((num + Number.EPSILON) * multiplier) / multiplier;
185
- };
186
- /**
187
- * a silly utility to help typescript realize an array is a tuple
188
- *
189
- * eg:
190
- * const a = [5, 'string'] // type is `Array<string | number>`
191
- * const t = tuple(5, 'string') type is `[5, 'string']`
192
- *
193
- * both have the same javascript value, but one is forced to be a tuple, which
194
- * is nice if its structure is important. examples are like the React.useState
195
- * pattern where there are two return values in a tuple, or if you're feeding
196
- * Object.fromEntries
197
- *
198
- */
199
- export const tuple = (...args) => args;