@openstax/ts-utils 1.33.0 → 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 (503) 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 -131
  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 -124
  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 → packages/utils/script}/bin/copy-from-template.bash +0 -0
  483. /package/{script → packages/utils/script}/bin/delete-stack.bash +0 -0
  484. /package/{script → packages/utils/script}/bin/deploy.bash +0 -0
  485. /package/{script → packages/utils/script}/bin/destroy-deployment.bash +0 -0
  486. /package/{script → packages/utils/script}/bin/empty-bucket.bash +0 -0
  487. /package/{script → packages/utils/script}/bin/get-arg.bash +0 -0
  488. /package/{script → packages/utils/script}/bin/get-deployed-environments.bash +0 -0
  489. /package/{script → packages/utils/script}/bin/get-env-param.bash +0 -0
  490. /package/{script → packages/utils/script}/bin/get-kwarg.bash +0 -0
  491. /package/{script → packages/utils/script}/bin/get-stack-param.bash +0 -0
  492. /package/{script → packages/utils/script}/bin/has-flag.bash +0 -0
  493. /package/{script → packages/utils/script}/bin/init-constants-script.bash +0 -0
  494. /package/{script → packages/utils/script}/bin/init-params-script.bash +0 -0
  495. /package/{script → packages/utils/script}/bin/stack-exists.bash +0 -0
  496. /package/{script → packages/utils/script}/bin/update-utils.bash +0 -0
  497. /package/{script → packages/utils/script}/bin/upload-pager-duty-endpoints.bash +0 -0
  498. /package/{script → packages/utils/script}/bin/upload-params.bash +0 -0
  499. /package/{script → packages/utils/script}/bin/which.bash +0 -0
  500. /package/{script → packages/utils/script}/bin-entry.bash +0 -0
  501. /package/{script → packages/utils/script}/build.bash +0 -0
  502. /package/{dist/cjs/index.d.ts → packages/utils/src/index.ts} +0 -0
  503. /package/{dist/cjs/services/launchParams/index.d.ts → packages/utils/src/services/launchParams/index.ts} +0 -0
@@ -0,0 +1,14 @@
1
+ import React from 'react';
2
+ import { useServices } from "../core/context/services";
3
+ import { getQuery } from "./middleware";
4
+
5
+ export const useQuery = () => {
6
+ const services = useServices();
7
+ const [query, setQuery] = React.useState(getQuery(services));
8
+
9
+ React.useEffect(() =>
10
+ services.history.listen(() => setQuery(getQuery(services)))
11
+ , [services, setQuery]);
12
+
13
+ return query;
14
+ };
@@ -0,0 +1,19 @@
1
+ const proxy = require('http-proxy-middleware');
2
+ const lambdaLocalProxy = require('@project/lambdas/build/script/lambdaLocalProxy');
3
+
4
+ module.exports = function(app) {
5
+ accountsProxy(app);
6
+ lambdaLocalProxy(app, 'serviceApi');
7
+ };
8
+
9
+ function accountsProxy(app) {
10
+ app.use(proxy('/accounts', {
11
+ target: 'https://dev.openstax.org',
12
+ changeOrigin: true,
13
+ autoRewrite: true,
14
+ cookieDomainRewrite: "",
15
+ onProxyReq: (proxyRequest, request, response) => {
16
+ proxyRequest.setHeader('X-Forwarded-Host', request.headers.host);
17
+ }
18
+ }));
19
+ }
@@ -0,0 +1,9 @@
1
+ // jest-dom adds custom jest matchers for asserting on DOM nodes.
2
+ // allows you to do things like:
3
+ // expect(element).toHaveTextContent(/react/i)
4
+ // learn more: https://github.com/testing-library/jest-dom
5
+ import '@testing-library/jest-dom';
6
+
7
+
8
+
9
+ jest.mock('!!val-loader!@project/lambdas/build/script/utils/routeDataLoader', () => ({}), {virtual: true});
@@ -0,0 +1,23 @@
1
+ import React from 'react';
2
+ import { createUserRoleValidator } from "@openstax/ts-utils/services/authProvider/utils/userRoleValidator";
3
+ import { createMemoryHistory } from "history";
4
+ import { stubAuthProvider } from '@openstax/ts-utils/services/authProvider';
5
+ import { ServiceContext } from "../core/context/services";
6
+ import { AppServices } from "../core/types";
7
+
8
+ export const testApiGateway: {[key: string]: any} = {};
9
+
10
+ const authProvider = stubAuthProvider();
11
+ export const testServices = {
12
+ createApiGateway: () => testApiGateway,
13
+ history: createMemoryHistory(),
14
+ authProvider,
15
+ roleValidator: createUserRoleValidator(authProvider, {application: 'test'}),
16
+ configProvider: { getConfig: async() => {}, getValue: async(_name: string) => undefined }
17
+ } as any as AppServices;
18
+
19
+ export const TestServiceProvider = ({children, ...services}: React.PropsWithChildren<Partial<AppServices>>) =>
20
+ <ServiceContext.Provider value={() => ({...testServices, ...services})}>
21
+ {children}
22
+ </ServiceContext.Provider>
23
+ ;
@@ -0,0 +1,27 @@
1
+ {
2
+ "compilerOptions": {
3
+ "target": "es5",
4
+ "lib": [
5
+ "dom",
6
+ "dom.iterable",
7
+ "esnext"
8
+ ],
9
+ "baseUrl": "src",
10
+ "allowJs": true,
11
+ "skipLibCheck": true,
12
+ "esModuleInterop": true,
13
+ "allowSyntheticDefaultImports": true,
14
+ "strict": true,
15
+ "forceConsistentCasingInFileNames": true,
16
+ "noFallthroughCasesInSwitch": true,
17
+ "module": "esnext",
18
+ "moduleResolution": "node",
19
+ "resolveJsonModule": true,
20
+ "isolatedModules": true,
21
+ "noEmit": true,
22
+ "jsx": "react-jsx"
23
+ },
24
+ "include": [
25
+ "src"
26
+ ]
27
+ }
@@ -0,0 +1,64 @@
1
+ module.exports = {
2
+ root: true,
3
+ env: { node: true, es6: true },
4
+ parserOptions: {
5
+ ecmaVersion: 2018
6
+ },
7
+ overrides: [
8
+ {
9
+ files: ['**/*.ts?(x)'],
10
+ parser: '@typescript-eslint/parser',
11
+ parserOptions: {
12
+ project: 'tsconfig.json',
13
+ tsconfigRootDir: __dirname,
14
+ ecmaVersion: 2018,
15
+ sourceType: 'module',
16
+ warnOnUnsupportedTypeScriptVersion: true
17
+ },
18
+ plugins: ['@typescript-eslint'],
19
+ extends: [
20
+ 'eslint:recommended',
21
+ 'plugin:import/typescript'
22
+ ],
23
+ rules: {
24
+ '@typescript-eslint/ban-ts-comment': 'off',
25
+ '@typescript-eslint/no-inferrable-types': [
26
+ 'warn',
27
+ { ignoreParameters: true }
28
+ ],
29
+ semi: 'off',
30
+ '@typescript-eslint/semi': ['warn'],
31
+ '@typescript-eslint/member-delimiter-style': ['warn'],
32
+ 'no-unused-vars': 'off',
33
+ '@typescript-eslint/no-unused-vars': [
34
+ 'warn',
35
+ {
36
+ args: 'none',
37
+ ignoreRestSiblings: true,
38
+ varsIgnorePattern: '^_',
39
+ }
40
+ ],
41
+ '@typescript-eslint/no-explicit-any': 'off'
42
+ }
43
+ }
44
+ ],
45
+ ignorePatterns: ['node_modules', 'dist', 'build', 'coverage'],
46
+ plugins: ['import', 'jest'],
47
+ extends: [
48
+ 'eslint:recommended',
49
+ 'plugin:jest/recommended',
50
+ 'plugin:jest/style'
51
+ ],
52
+ rules: {
53
+ quotes: ['warn', 'single'],
54
+ 'quote-props': ['warn', 'as-needed'],
55
+ 'import/order': [
56
+ 'warn',
57
+ { 'newlines-between': 'never', alphabetize: { order: 'asc' } }
58
+ ],
59
+ 'sort-imports': [
60
+ 'warn',
61
+ { ignoreDeclarationSort: true, ignoreCase: true }
62
+ ]
63
+ }
64
+ }
@@ -0,0 +1,3 @@
1
+ module.exports = async () => {
2
+ process.env.TZ = 'UTC';
3
+ };
@@ -0,0 +1 @@
1
+ // use this file for any global mocks or shared setup
@@ -0,0 +1,31 @@
1
+ module.exports = {
2
+ preset: 'ts-jest',
3
+ testEnvironment: 'node',
4
+ globalSetup: './jest-global-setup.js',
5
+ setupFilesAfterEnv: ['./jest-setup-after-env.js'],
6
+ testMatch: [
7
+ '**/(src|script)/**/?(*.)+(spec).ts'
8
+ ],
9
+ collectCoverageFrom: [
10
+ 'src/**/*.{js,ts}',
11
+ 'script/**/*.{js,ts}',
12
+ ],
13
+ coveragePathIgnorePatterns: [
14
+ '/node_modules/',
15
+ '/test/',
16
+ ],
17
+ coverageReporters: [
18
+ 'text-summary',
19
+ 'html',
20
+ 'lcovonly'
21
+ ],
22
+ coverageThreshold: {
23
+ global: {
24
+ branches: 100,
25
+ functions: 100,
26
+ lines: 100,
27
+ statements: 100
28
+ }
29
+ },
30
+ resolver: './jest.resolver.js'
31
+ };
@@ -0,0 +1,17 @@
1
+ // https://github.com/cloudflare/miniflare/issues/271#issuecomment-1255544333
2
+ //
3
+ // the uuid package says that it fixed this in v9 here https://github.com/uuidjs/uuid/pull/616#issuecomment-1237428554
4
+ // but i tired it and was still getting the error. try removing this hack in the future and
5
+ // see if it got figured out.
6
+ module.exports = (path, options) => {
7
+ return options.defaultResolver(path, {
8
+ ...options,
9
+ packageFilter: pkg => {
10
+ if (pkg.name === 'uuid') {
11
+ delete pkg['exports'];
12
+ delete pkg['module'];
13
+ }
14
+ return pkg;
15
+ },
16
+ });
17
+ };
@@ -0,0 +1,68 @@
1
+ {
2
+ "name": "@project/lambdas",
3
+ "version": "1.0.0",
4
+ "dependencies": {
5
+ "@openstax/ts-utils": "1.33.0",
6
+ "aws-sdk": "^2.1145.0",
7
+ "aws-xray-sdk": "^3.6.0",
8
+ "body-parser": "^1.19.2",
9
+ "node-fetch": "^2.7.0",
10
+ "path-to-regexp": "^6.2.0",
11
+ "query-string": "^7.1.1",
12
+ "url": "^0.11.0"
13
+ },
14
+ "devDependencies": {
15
+ "@types/aws-lambda": "^8.10.92",
16
+ "@types/cors": "^2.8.13",
17
+ "@types/express": "^4.17.13",
18
+ "@types/jest": "^29.5.14",
19
+ "@types/multer": "^1.4.7",
20
+ "@types/node": "^24.2.0",
21
+ "@types/node-fetch": "^2.6.11",
22
+ "@types/supertest": "^2.0.12",
23
+ "@types/uuid": "^8.3.4",
24
+ "@typescript-eslint/eslint-plugin": "^5.13.0",
25
+ "@typescript-eslint/parser": "^8.39.0",
26
+ "builtin-modules": "^3.2.0",
27
+ "cors": "^2.8.5",
28
+ "cspell": "^5.18.5",
29
+ "eslint": "^8.10.0",
30
+ "eslint-plugin-import": "^2.25.4",
31
+ "eslint-plugin-jest": "^26.1.1",
32
+ "express": "^4.17.3",
33
+ "jest": "^29.7.0",
34
+ "multer": "^1.4.5-lts.1",
35
+ "nock": "^13.2.9",
36
+ "npm-run-all": "^4.1.5",
37
+ "supertest": "^6.3.3",
38
+ "ts-jest": "^29.4.1",
39
+ "ts-loader": "^9.3.0",
40
+ "typescript": "5.9.2",
41
+ "webpack": "^5.69.1",
42
+ "webpack-bundle-analyzer": "^4.10.2",
43
+ "webpack-cli": "^4.9.2",
44
+ "yargs": "^17.5.1"
45
+ },
46
+ "license": "MIT",
47
+ "main": "index.js",
48
+ "scripts": {
49
+ "archive": "yarn archive:bundle && yarn archive:zip",
50
+ "archive:bundle": "yarn webpack --mode production",
51
+ "archive:clean": "yarn clean && yarn archive",
52
+ "archive:zip": "./script/bundle-functions.bash",
53
+ "build": "./script/build.bash",
54
+ "build:clean": "yarn clean && yarn build",
55
+ "ci": "CI=true npm-run-all ci:*",
56
+ "ci:lint": "eslint --max-warnings=0 .",
57
+ "ci:spelling": "git ls-files | yarn cspell -c ../../cspell.json --file-list stdin",
58
+ "ci:test": "yarn jest --coverage",
59
+ "ci:typecheck": "tsc --noEmit",
60
+ "clean": "rm -rf dist build",
61
+ "coverage-report": "open coverage/index.html",
62
+ "data:clean": "find data/ -maxdepth 1 -type f -delete",
63
+ "data:reset": "yarn data:clean && yarn data:seed",
64
+ "data:seed": "cp -n ./data/seeds/* ./data/ || true",
65
+ "start": "./script/build.bash --watch",
66
+ "test": "yarn jest"
67
+ }
68
+ }
@@ -0,0 +1,19 @@
1
+ #!/usr/bin/env bash
2
+ # spell-checker: ignore pipefail yargs
3
+ set -euo pipefail; if [ -n "${DEBUG-}" ]; then set -x; fi
4
+
5
+ project_dir="$( cd "$( dirname "${BASH_SOURCE[0]}" )/.." >/dev/null 2>&1 && pwd )"
6
+
7
+ cd "$project_dir";
8
+
9
+ build_dir="build"
10
+ tsc_args=(--noEmit false --outDir "$build_dir" --declaration --allowJs )
11
+
12
+ if yarn -s ts-utils has-flag watch "$@"; then
13
+ tsc_args+=(--watch)
14
+ fi
15
+ if yarn -s ts-utils has-flag clean "$@"; then
16
+ rm -rf "${build_dir:?}"/*
17
+ fi
18
+
19
+ yarn -s tsc "${tsc_args[@]}"
@@ -0,0 +1,10 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+
4
+ base=$(pwd)
5
+
6
+ for fn in dist/*; do
7
+ cd "$base/$fn"
8
+ zip="../$(basename "$fn").zip"
9
+ zip -r "$zip" .
10
+ done
@@ -0,0 +1,16 @@
1
+ // TODO - convert this file to ts
2
+ const bodyParser = require('body-parser')
3
+
4
+ const noCacheRequire = (module) => {
5
+ Object.keys(require.cache).forEach((key) => { delete require.cache[key] })
6
+ return require(module);
7
+ }
8
+
9
+ module.exports = function lambdaLocalProxy(app, fn) {
10
+ app.use(bodyParser.raw({type: '*/*'}));
11
+ app.use((...args) => {
12
+ // this is included here so that you don't have to restart the server to get code changes
13
+ const {handler} = noCacheRequire(`../src/functions/${fn}/entry/local`);
14
+ handler(...args);
15
+ })
16
+ }
@@ -0,0 +1,147 @@
1
+ import express, {Request, Response} from 'express';
2
+ import request from 'supertest';
3
+ import * as requestModule from '../src/functions/serviceApi/core/request';
4
+ // @ts-ignore-next-line
5
+ import proxy from './lambdaLocalProxy.js';
6
+
7
+ describe('proxy', () => {
8
+ let getRequestResponderSpy: jest.SpyInstance;
9
+ let requestResponderSpy: jest.SpyInstance;
10
+
11
+ beforeEach(() => {
12
+ getRequestResponderSpy = jest.spyOn(requestModule, 'getRequestResponder');
13
+ requestResponderSpy = jest.fn(() => undefined);
14
+ getRequestResponderSpy.mockReturnValue(requestResponderSpy);
15
+ });
16
+
17
+ afterEach(() => {
18
+ jest.clearAllMocks();
19
+ });
20
+
21
+ it('passes request to app responder', async() => {
22
+ const app = express();
23
+ proxy(app, 'serviceApi');
24
+
25
+ await request(app).post('/asdf/path/asdf')
26
+ .send({ foobar: 'body' })
27
+ .set('neatHeader', 'headerValue')
28
+ ;
29
+
30
+ expect(requestResponderSpy).toHaveBeenCalledWith(expect.objectContaining({
31
+ requestContext: {
32
+ http: {
33
+ method: 'POST',
34
+ path: '/asdf/path/asdf',
35
+ }
36
+ },
37
+ body: Buffer.from(JSON.stringify({ foobar: 'body' }), 'utf8'),
38
+ headers: expect.objectContaining({ neatheader: 'headerValue' }), // cspell:disable-line
39
+ }));
40
+ });
41
+
42
+ it('passes cookie to app responder', async() => {
43
+ const app = express();
44
+ proxy(app, 'serviceApi');
45
+
46
+ await request(app).get('/asdf/path/asdf').send()
47
+ .set('neatHeader', 'headerValue')
48
+ .set('cookie', 'one=cookie-one; two=cookie-two')
49
+ ;
50
+
51
+ expect(requestResponderSpy).toHaveBeenCalledWith(expect.objectContaining({
52
+ cookies: [
53
+ 'one=cookie-one',
54
+ 'two=cookie-two'
55
+ ],
56
+ }));
57
+ });
58
+
59
+ it('passes query params to app responder', async() => {
60
+ const app = express();
61
+ proxy(app, 'serviceApi');
62
+
63
+ await request(app).get('/asdf/path/asdf?param1=value1').send()
64
+ .set('neatHeader', 'headerValue')
65
+ .set('cookie', 'one=cookie-one; two=cookie-two')
66
+ ;
67
+
68
+ expect(requestResponderSpy).toHaveBeenCalledWith(expect.objectContaining({
69
+ queryStringParameters: {
70
+ param1: 'value1'
71
+ }
72
+ }));
73
+ });
74
+
75
+ it('passes multi value query params to app responder', async() => {
76
+ const app = express();
77
+ proxy(app, 'serviceApi');
78
+
79
+ await request(app).get('/asdf/path/asdf?param1=value1&param1=value2').send()
80
+ .set('neatHeader', 'headerValue')
81
+ .set('cookie', 'one=cookie-one; two=cookie-two')
82
+ ;
83
+
84
+ expect(requestResponderSpy).toHaveBeenCalledWith(expect.objectContaining({
85
+ queryStringParameters: {
86
+ param1: 'value1,value2'
87
+ }
88
+ }));
89
+ });
90
+
91
+ it('passes through when app has no response', async() => {
92
+ const app = express();
93
+ proxy(app, 'serviceApi');
94
+
95
+ const fallback = jest.fn((_req: Request, res: Response) => res.send('hello'));
96
+ app.all('*', fallback);
97
+
98
+ await request(app).get('/asdf/path/asdf?param1=value1').send()
99
+ .set('neatHeader', 'headerValue')
100
+ .set('cookie', 'one=cookie-one; two=cookie-two')
101
+ ;
102
+
103
+ expect(fallback).toHaveBeenCalled();
104
+ });
105
+
106
+ it('responds when app has response', async() => {
107
+ const appResponse = {statusCode: 201, body: 'response' };
108
+ requestResponderSpy.mockReturnValue(Promise.resolve(appResponse));
109
+
110
+ const app = express();
111
+ proxy(app, 'serviceApi');
112
+
113
+ await request(app).get('/asdf/path/asdf').send()
114
+ .expect(201, 'response');
115
+
116
+ expect(requestResponderSpy).toHaveBeenCalled();
117
+ });
118
+
119
+ it('responds when app has encoded response', async() => {
120
+ const appResponse = {statusCode: 200, body: Buffer.from('response').toString('base64'), isBase64Encoded: true};
121
+ requestResponderSpy.mockReturnValue(Promise.resolve(appResponse));
122
+
123
+ const app = express();
124
+ proxy(app, 'serviceApi');
125
+
126
+ await request(app).get('/asdf/path/asdf').send()
127
+ .expect(200, 'response');
128
+
129
+ expect(requestResponderSpy).toHaveBeenCalled();
130
+ });
131
+
132
+ it('works for empty path and queryString', async() => {
133
+ const app = express();
134
+ proxy(app, 'serviceApi');
135
+
136
+ await request(app).get('');
137
+
138
+ expect(requestResponderSpy).toHaveBeenCalledWith(expect.objectContaining({
139
+ requestContext: {
140
+ http: {
141
+ method: 'GET',
142
+ path: '/',
143
+ }
144
+ },
145
+ }));
146
+ });
147
+ });
@@ -0,0 +1,7 @@
1
+ export const getApiRouteData = (api: string) => require(`../../src/functions/${api}/core/routes`).apiRoutes().reduce((result: any, route: any) => ({
2
+ ...result,
3
+ [route.name]: {
4
+ path: route.path,
5
+ method: route.method,
6
+ }
7
+ }), {});
@@ -0,0 +1,8 @@
1
+ // TODO - convert this file to ts
2
+ const routeData = require('./getRouteData').getApiRouteData('serviceApi');
3
+
4
+ // TODO - use `options` to pass `serviceApi` instead of using it literally
5
+ /* eslint-disable no-unused-vars */
6
+ module.exports = (options, loaderContext) => {
7
+ return { code: 'module.exports = ' + JSON.stringify(routeData) };
8
+ };
@@ -0,0 +1,8 @@
1
+ describe('routeDataLoader', () => {
2
+ it('works', () => {
3
+ expect(require('./routeDataLoader')).not.toThrow();
4
+ });
5
+ });
6
+
7
+ /* eslint-disable jest/no-export */
8
+ export default null;
@@ -0,0 +1,7 @@
1
+ /* istanbul ignore file */
2
+ export * from './routes';
3
+ export * from './services';
4
+ export * from './types';
5
+ export * from './request';
6
+
7
+ // TODO - comment on the dependency loop issues or try to combine some of these files
@@ -0,0 +1,38 @@
1
+ import { METHOD } from '@openstax/ts-utils/routing';
2
+ import { logExtractor, pathExtractor, routeMatcher } from './request';
3
+ import { ApiRouteRequest } from './types';
4
+
5
+ describe('logExtractor', () => {
6
+ it('extracts path and queryStringParameters from request', () => {
7
+ expect(logExtractor(
8
+ { queryStringParameters: {}, requestContext: { http: { path: '/asdf/foo' } } } as unknown as ApiRouteRequest
9
+ )).toEqual({http: { path: '/asdf/foo' }, query: {}, requestId: undefined });
10
+ });
11
+
12
+ it('extracts path and headers from request', () => {
13
+ expect(logExtractor(
14
+ { queryStringParameters: {}, requestContext: { http: { path: '/asdf/foo' } }, headers: { 'x-request-id': 'test-id' } } as unknown as ApiRouteRequest
15
+ )).toEqual({http: { path: '/asdf/foo' }, query: {}, requestId: 'test-id'});
16
+ });
17
+
18
+ it('extracts path and headers is empty from request', () => {
19
+ expect(logExtractor(
20
+ { queryStringParameters: {}, requestContext: { http: { path: '/asdf/foo' } }, headers: {} } as unknown as ApiRouteRequest
21
+ )).toEqual({http: { path: '/asdf/foo' }, query: {}, requestId: undefined});
22
+ });
23
+ });
24
+
25
+ describe('pathExtractor', () => {
26
+ it('extracts path from request', () => {
27
+ expect(pathExtractor({requestContext: {http: {path: '/asdf/foo'}}} as ApiRouteRequest)).toBe('/asdf/foo');
28
+ });
29
+ });
30
+
31
+ describe('routeMatcher', () => {
32
+ it('positive matches', () => {
33
+ expect(routeMatcher({requestContext: {http: {method: 'GET'}}} as ApiRouteRequest, {method: METHOD.GET})).toBe(true);
34
+ });
35
+ it('negative matches', () => {
36
+ expect(routeMatcher({requestContext: {http: {method: 'GET'}}} as ApiRouteRequest, {method: METHOD.POST})).toBe(false);
37
+ });
38
+ });
@@ -0,0 +1,42 @@
1
+ /* spell-checker: ignore herokuapp */
2
+ import { envConfig } from '@openstax/ts-utils/config';
3
+ import { makeComposeMiddleware } from '@openstax/ts-utils/middleware';
4
+ import { createErrorHandler } from '@openstax/ts-utils/middleware/apiErrorHandler';
5
+ import { createSlowResponseMiddleware } from '@openstax/ts-utils/middleware/apiSlowResponseMiddleware';
6
+ import { makeGetRequestResponder, METHOD } from '@openstax/ts-utils/routing';
7
+ import { apiRoutes, TRoutes } from './routes';
8
+ import { ApiRouteRequest, ApiRouteResponse, AppServices } from './types';
9
+
10
+ export const errorHandler = createErrorHandler();
11
+
12
+ export const slowResponseMiddleware = createSlowResponseMiddleware({
13
+ logResponseSlowerThan: envConfig('LOG_SLOW_RESPONSE', 'runtime', '1000'),
14
+ timeoutResponseAfter: envConfig('RESPONSE_TIMEOUT', 'runtime', '28000'),
15
+ });
16
+
17
+ export const pathExtractor = (request: ApiRouteRequest) =>
18
+ request.requestContext.http.path
19
+ ;
20
+
21
+ export const logExtractor = (request: ApiRouteRequest) => {
22
+ const { queryStringParameters, requestContext } = request;
23
+ return {
24
+ http: requestContext.http,
25
+ query: queryStringParameters,
26
+ requestId: request.headers?.['x-request-id'],
27
+ };
28
+ };
29
+
30
+ export const routeMatcher = (request: ApiRouteRequest, route: {method: METHOD}) => {
31
+ return request.requestContext.http.method === route.method;
32
+ };
33
+
34
+ export const composeResponseMiddleware = makeComposeMiddleware<AppServices, Promise<ApiRouteResponse> | undefined>();
35
+
36
+ export const getRequestResponder = makeGetRequestResponder<AppServices, TRoutes, ApiRouteRequest, Promise<ApiRouteResponse>>()({
37
+ routes: apiRoutes,
38
+ pathExtractor,
39
+ routeMatcher,
40
+ errorHandler,
41
+ logExtractor,
42
+ });
@@ -0,0 +1,7 @@
1
+ import { apiRoutes } from './routes';
2
+
3
+ describe('routes', () => {
4
+ it('aggregates api routes', () => {
5
+ expect(apiRoutes()).toEqual(expect.any(Array));
6
+ });
7
+ });
@@ -0,0 +1,10 @@
1
+ import { makeRenderRouteUrl } from '@openstax/ts-utils/routing';
2
+ import { apiV0Routes } from '../versions/v0';
3
+
4
+ export const apiRoutes = () => ([
5
+ ...apiV0Routes(),
6
+ ]);
7
+
8
+ export type TRoutes = (ReturnType<typeof apiRoutes>)[number];
9
+
10
+ export const renderRouteUrl = makeRenderRouteUrl<TRoutes>();
@@ -0,0 +1,9 @@
1
+ import { makeComposeMiddleware } from '@openstax/ts-utils/middleware';
2
+ import { makeCreateRoute, METHOD } from '@openstax/ts-utils/routing';
3
+ import { Logger } from '@openstax/ts-utils/services/logger';
4
+ import { ApiRouteRequest, AppServices } from './types';
5
+
6
+ export const composeServiceMiddleware = makeComposeMiddleware<AppServices, {request: ApiRouteRequest; logger: Logger}>();
7
+ export const createRoute = makeCreateRoute<AppServices, ApiRouteRequest, {
8
+ method: METHOD;
9
+ }>();
@@ -0,0 +1,13 @@
1
+ import { ConfigProvider } from '@openstax/ts-utils/config';
2
+ import { ApiResponse } from '@openstax/ts-utils/routing';
3
+ import { APIGatewayProxyEventV2 } from 'aws-lambda';
4
+ import { LambdaServices } from '../entry/lambda/services';
5
+ import { LocalServices } from '../entry/local';
6
+
7
+ export type ApiRouteRequest = APIGatewayProxyEventV2;
8
+ export type ApiRouteResponse = ApiResponse<number, any>;
9
+
10
+ export type BaseEnvironmentConfig = {local: ConfigProvider; deployed: ConfigProvider};
11
+ type GetEnvironmentConfig = <C extends BaseEnvironmentConfig>(config: C) => C['local'] | C['deployed'];
12
+
13
+ export type AppServices = {getEnvironmentConfig: GetEnvironmentConfig} & (LambdaServices | LocalServices);
@@ -0,0 +1,4 @@
1
+ import { captureHTTPsGlobal } from 'aws-xray-sdk';
2
+
3
+ captureHTTPsGlobal(require('http'), true);
4
+ captureHTTPsGlobal(require('https'), true);