@openstax/ts-utils 1.34.0 → 1.34.1

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/README.md +90 -62
  2. package/dist/cjs/assertions/index.d.ts +89 -0
  3. package/dist/cjs/assertions/index.js +157 -0
  4. package/dist/cjs/aws/ssmService.d.ts +5 -0
  5. package/dist/cjs/aws/ssmService.js +9 -0
  6. package/dist/cjs/config/awsParameterConfig.d.ts +10 -0
  7. package/dist/cjs/config/awsParameterConfig.js +26 -0
  8. package/dist/cjs/config/envConfig.d.ts +24 -0
  9. package/dist/cjs/config/envConfig.js +57 -0
  10. package/{packages/utils/src/config/index.ts → dist/cjs/config/index.d.ts} +13 -29
  11. package/dist/cjs/config/index.js +35 -0
  12. package/dist/cjs/config/lambdaParameterConfig.d.ts +12 -0
  13. package/dist/cjs/config/lambdaParameterConfig.js +45 -0
  14. package/dist/cjs/config/replaceConfig.d.ts +14 -0
  15. package/dist/cjs/config/replaceConfig.js +22 -0
  16. package/dist/cjs/config/resolveConfigValue.d.ts +5 -0
  17. package/dist/cjs/config/resolveConfigValue.js +12 -0
  18. package/dist/cjs/errors/index.d.ts +88 -0
  19. package/dist/cjs/errors/index.js +123 -0
  20. package/dist/cjs/fetch/fetchStatusRetry.d.ts +8 -0
  21. package/dist/cjs/fetch/fetchStatusRetry.js +27 -0
  22. package/dist/cjs/fetch/index.d.ts +64 -0
  23. package/dist/cjs/fetch/index.js +55 -0
  24. package/{packages/utils/src/guards/index.ts → dist/cjs/guards/index.d.ts} +7 -10
  25. package/dist/cjs/guards/index.js +44 -0
  26. package/dist/cjs/index.js +20 -0
  27. package/dist/cjs/middleware/apiErrorHandler.d.ts +24 -0
  28. package/dist/cjs/middleware/apiErrorHandler.js +42 -0
  29. package/dist/cjs/middleware/apiSlowResponseMiddleware.d.ts +23 -0
  30. package/dist/cjs/middleware/apiSlowResponseMiddleware.js +54 -0
  31. package/{packages/utils/src/middleware/index.ts → dist/cjs/middleware/index.d.ts} +5 -53
  32. package/dist/cjs/middleware/index.js +48 -0
  33. package/dist/cjs/middleware/lambdaCorsResponseMiddleware.d.ts +20 -0
  34. package/dist/cjs/middleware/lambdaCorsResponseMiddleware.js +44 -0
  35. package/dist/cjs/middleware/throwNotFoundMiddleware.d.ts +4 -0
  36. package/dist/cjs/middleware/throwNotFoundMiddleware.js +14 -0
  37. package/dist/cjs/misc/hashValue.d.ts +10 -0
  38. package/dist/cjs/misc/hashValue.js +17 -0
  39. package/dist/cjs/misc/helpers.d.ts +124 -0
  40. package/dist/cjs/misc/helpers.js +214 -0
  41. package/dist/cjs/misc/merge.d.ts +21 -0
  42. package/dist/cjs/misc/merge.js +45 -0
  43. package/dist/cjs/misc/partitionSequence.d.ts +35 -0
  44. package/dist/cjs/misc/partitionSequence.js +55 -0
  45. package/dist/cjs/pagination/index.d.ts +91 -0
  46. package/dist/cjs/pagination/index.js +83 -0
  47. package/dist/cjs/routing/helpers.d.ts +57 -0
  48. package/dist/cjs/routing/helpers.js +90 -0
  49. package/dist/cjs/routing/index.d.ts +290 -0
  50. package/dist/cjs/routing/index.js +295 -0
  51. package/dist/cjs/routing/validators/zod.d.ts +4 -0
  52. package/dist/cjs/routing/validators/zod.js +14 -0
  53. package/dist/cjs/services/accountsGateway/index.d.ts +92 -0
  54. package/dist/cjs/services/accountsGateway/index.js +138 -0
  55. package/dist/cjs/services/apiGateway/index.d.ts +68 -0
  56. package/dist/cjs/services/apiGateway/index.js +118 -0
  57. package/dist/cjs/services/authProvider/browser.d.ts +40 -0
  58. package/dist/cjs/services/authProvider/browser.js +155 -0
  59. package/dist/cjs/services/authProvider/decryption.d.ts +19 -0
  60. package/dist/cjs/services/authProvider/decryption.js +73 -0
  61. package/dist/cjs/services/authProvider/index.d.ts +63 -0
  62. package/dist/cjs/services/authProvider/index.js +34 -0
  63. package/dist/cjs/services/authProvider/subrequest.d.ts +13 -0
  64. package/dist/cjs/services/authProvider/subrequest.js +49 -0
  65. package/dist/cjs/services/authProvider/utils/decryptAndVerify.d.ts +28 -0
  66. package/dist/cjs/services/authProvider/utils/decryptAndVerify.js +91 -0
  67. package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.d.ts +26 -0
  68. package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.js +47 -0
  69. package/dist/cjs/services/authProvider/utils/userRoleValidator.d.ts +13 -0
  70. package/dist/cjs/services/authProvider/utils/userRoleValidator.js +37 -0
  71. package/dist/cjs/services/authProvider/utils/userSubrequest.d.ts +3 -0
  72. package/dist/cjs/services/authProvider/utils/userSubrequest.js +13 -0
  73. package/dist/cjs/services/documentStore/dynamoEncoding.d.ts +10 -0
  74. package/dist/cjs/services/documentStore/dynamoEncoding.js +52 -0
  75. package/dist/cjs/services/documentStore/fileSystemAssert.d.ts +1 -0
  76. package/dist/cjs/services/documentStore/fileSystemAssert.js +14 -0
  77. package/{packages/utils/src/services/documentStore/index.ts → dist/cjs/services/documentStore/index.d.ts} +8 -8
  78. package/dist/cjs/services/documentStore/index.js +2 -0
  79. package/dist/cjs/services/documentStore/unversioned/dynamodb.d.ts +31 -0
  80. package/dist/cjs/services/documentStore/unversioned/dynamodb.js +233 -0
  81. package/dist/cjs/services/documentStore/unversioned/file-system.d.ts +32 -0
  82. package/dist/cjs/services/documentStore/unversioned/file-system.js +214 -0
  83. package/{packages/utils/src/services/documentStore/unversioned/index.ts → dist/cjs/services/documentStore/unversioned/index.d.ts} +0 -2
  84. package/dist/cjs/services/documentStore/unversioned/index.js +2 -0
  85. package/dist/cjs/services/documentStore/versioned/dynamodb.d.ts +25 -0
  86. package/dist/cjs/services/documentStore/versioned/dynamodb.js +143 -0
  87. package/dist/cjs/services/documentStore/versioned/file-system.d.ts +25 -0
  88. package/dist/cjs/services/documentStore/versioned/file-system.js +73 -0
  89. package/dist/cjs/services/documentStore/versioned/index.d.ts +17 -0
  90. package/dist/cjs/services/documentStore/versioned/index.js +2 -0
  91. package/dist/cjs/services/exercisesGateway/index.d.ts +67 -0
  92. package/dist/cjs/services/exercisesGateway/index.js +107 -0
  93. package/dist/cjs/services/fileServer/index.d.ts +30 -0
  94. package/dist/cjs/services/fileServer/index.js +19 -0
  95. package/dist/cjs/services/fileServer/localFileServer.d.ts +13 -0
  96. package/dist/cjs/services/fileServer/localFileServer.js +132 -0
  97. package/dist/cjs/services/fileServer/s3FileServer.d.ts +14 -0
  98. package/dist/cjs/services/fileServer/s3FileServer.js +131 -0
  99. package/dist/cjs/services/launchParams/index.js +7 -0
  100. package/dist/cjs/services/launchParams/signer.d.ts +23 -0
  101. package/dist/cjs/services/launchParams/signer.js +58 -0
  102. package/dist/cjs/services/launchParams/verifier.d.ts +21 -0
  103. package/dist/cjs/services/launchParams/verifier.js +129 -0
  104. package/dist/cjs/services/logger/console.d.ts +4 -0
  105. package/dist/cjs/services/logger/console.js +12 -0
  106. package/{packages/utils/src/services/logger/index.ts → dist/cjs/services/logger/index.d.ts} +9 -23
  107. package/dist/cjs/services/logger/index.js +31 -0
  108. package/dist/cjs/services/lrsGateway/addStatementDefaultFields.d.ts +5 -0
  109. package/dist/cjs/services/lrsGateway/addStatementDefaultFields.js +21 -0
  110. package/dist/cjs/services/lrsGateway/attempt-utils.d.ts +72 -0
  111. package/dist/cjs/services/lrsGateway/attempt-utils.js +283 -0
  112. package/dist/cjs/services/lrsGateway/file-system.d.ts +15 -0
  113. package/dist/cjs/services/lrsGateway/file-system.js +150 -0
  114. package/dist/cjs/services/lrsGateway/index.d.ts +122 -0
  115. package/dist/cjs/services/lrsGateway/index.js +148 -0
  116. package/dist/cjs/services/lrsGateway/xapiUtils.d.ts +71 -0
  117. package/dist/cjs/services/lrsGateway/xapiUtils.js +145 -0
  118. package/dist/cjs/services/postgresConnection/index.d.ts +28 -0
  119. package/dist/cjs/services/postgresConnection/index.js +65 -0
  120. package/dist/cjs/services/searchProvider/index.d.ts +67 -0
  121. package/dist/cjs/services/searchProvider/index.js +2 -0
  122. package/dist/cjs/services/searchProvider/memorySearchTheBadWay.d.ts +20 -0
  123. package/dist/cjs/services/searchProvider/memorySearchTheBadWay.js +191 -0
  124. package/dist/cjs/services/searchProvider/openSearch.d.ts +28 -0
  125. package/dist/cjs/services/searchProvider/openSearch.js +154 -0
  126. package/dist/cjs/tsconfig.without-specs.cjs.tsbuildinfo +1 -0
  127. package/{packages/utils/src/types.ts → dist/cjs/types.d.ts} +6 -34
  128. package/dist/cjs/types.js +2 -0
  129. package/dist/esm/assertions/index.d.ts +89 -0
  130. package/{packages/utils/src/assertions/index.ts → dist/esm/assertions/index.js} +49 -64
  131. package/dist/esm/aws/ssmService.d.ts +5 -0
  132. package/dist/esm/aws/ssmService.js +6 -0
  133. package/dist/esm/config/awsParameterConfig.d.ts +10 -0
  134. package/dist/esm/config/awsParameterConfig.js +22 -0
  135. package/dist/esm/config/envConfig.d.ts +24 -0
  136. package/dist/esm/config/envConfig.js +53 -0
  137. package/dist/esm/config/index.d.ts +48 -0
  138. package/dist/esm/config/index.js +17 -0
  139. package/dist/esm/config/lambdaParameterConfig.d.ts +12 -0
  140. package/dist/esm/config/lambdaParameterConfig.js +38 -0
  141. package/dist/esm/config/replaceConfig.d.ts +14 -0
  142. package/{packages/utils/src/config/replaceConfig.ts → dist/esm/config/replaceConfig.js} +6 -16
  143. package/dist/esm/config/resolveConfigValue.d.ts +5 -0
  144. package/dist/esm/config/resolveConfigValue.js +8 -0
  145. package/dist/esm/errors/index.d.ts +88 -0
  146. package/{packages/utils/src/errors/index.ts → dist/esm/errors/index.js} +41 -57
  147. package/dist/esm/fetch/fetchStatusRetry.d.ts +8 -0
  148. package/dist/esm/fetch/fetchStatusRetry.js +23 -0
  149. package/dist/esm/fetch/index.d.ts +64 -0
  150. package/dist/esm/fetch/index.js +46 -0
  151. package/dist/esm/guards/index.d.ts +38 -0
  152. package/dist/esm/guards/index.js +36 -0
  153. package/dist/esm/index.d.ts +4 -0
  154. package/dist/esm/index.js +4 -0
  155. package/dist/esm/middleware/apiErrorHandler.d.ts +24 -0
  156. package/dist/esm/middleware/apiErrorHandler.js +38 -0
  157. package/dist/esm/middleware/apiSlowResponseMiddleware.d.ts +23 -0
  158. package/dist/esm/middleware/apiSlowResponseMiddleware.js +50 -0
  159. package/dist/esm/middleware/index.d.ts +47 -0
  160. package/dist/esm/middleware/index.js +44 -0
  161. package/dist/esm/middleware/lambdaCorsResponseMiddleware.d.ts +20 -0
  162. package/dist/esm/middleware/lambdaCorsResponseMiddleware.js +40 -0
  163. package/dist/esm/middleware/throwNotFoundMiddleware.d.ts +4 -0
  164. package/dist/esm/middleware/throwNotFoundMiddleware.js +10 -0
  165. package/dist/esm/misc/hashValue.d.ts +10 -0
  166. package/dist/esm/misc/hashValue.js +13 -0
  167. package/dist/esm/misc/helpers.d.ts +124 -0
  168. package/dist/esm/misc/helpers.js +199 -0
  169. package/dist/esm/misc/merge.d.ts +21 -0
  170. package/dist/esm/misc/merge.js +40 -0
  171. package/dist/esm/misc/partitionSequence.d.ts +35 -0
  172. package/{packages/utils/src/misc/partitionSequence.ts → dist/esm/misc/partitionSequence.js} +15 -23
  173. package/dist/esm/pagination/index.d.ts +91 -0
  174. package/dist/esm/pagination/index.js +77 -0
  175. package/dist/esm/routing/helpers.d.ts +57 -0
  176. package/{packages/utils/src/routing/helpers.ts → dist/esm/routing/helpers.js} +30 -42
  177. package/dist/esm/routing/index.d.ts +290 -0
  178. package/dist/esm/routing/index.js +246 -0
  179. package/dist/esm/routing/validators/zod.d.ts +4 -0
  180. package/dist/esm/routing/validators/zod.js +10 -0
  181. package/dist/esm/services/accountsGateway/index.d.ts +92 -0
  182. package/dist/esm/services/accountsGateway/index.js +131 -0
  183. package/dist/esm/services/apiGateway/index.d.ts +68 -0
  184. package/dist/esm/services/apiGateway/index.js +77 -0
  185. package/dist/esm/services/authProvider/browser.d.ts +40 -0
  186. package/dist/esm/services/authProvider/browser.js +151 -0
  187. package/dist/esm/services/authProvider/decryption.d.ts +19 -0
  188. package/dist/esm/services/authProvider/decryption.js +69 -0
  189. package/dist/esm/services/authProvider/index.d.ts +63 -0
  190. package/dist/esm/services/authProvider/index.js +26 -0
  191. package/dist/esm/services/authProvider/subrequest.d.ts +13 -0
  192. package/dist/esm/services/authProvider/subrequest.js +45 -0
  193. package/dist/esm/services/authProvider/utils/decryptAndVerify.d.ts +28 -0
  194. package/dist/esm/services/authProvider/utils/decryptAndVerify.js +85 -0
  195. package/dist/esm/services/authProvider/utils/embeddedAuthProvider.d.ts +26 -0
  196. package/dist/esm/services/authProvider/utils/embeddedAuthProvider.js +40 -0
  197. package/dist/esm/services/authProvider/utils/userRoleValidator.d.ts +13 -0
  198. package/dist/esm/services/authProvider/utils/userRoleValidator.js +33 -0
  199. package/dist/esm/services/authProvider/utils/userSubrequest.d.ts +3 -0
  200. package/dist/esm/services/authProvider/utils/userSubrequest.js +6 -0
  201. package/dist/esm/services/documentStore/dynamoEncoding.d.ts +10 -0
  202. package/dist/esm/services/documentStore/dynamoEncoding.js +45 -0
  203. package/dist/esm/services/documentStore/fileSystemAssert.d.ts +1 -0
  204. package/dist/esm/services/documentStore/fileSystemAssert.js +10 -0
  205. package/dist/esm/services/documentStore/index.d.ts +14 -0
  206. package/dist/esm/services/documentStore/index.js +1 -0
  207. package/dist/esm/services/documentStore/unversioned/dynamodb.d.ts +31 -0
  208. package/dist/esm/services/documentStore/unversioned/dynamodb.js +226 -0
  209. package/dist/esm/services/documentStore/unversioned/file-system.d.ts +32 -0
  210. package/dist/esm/services/documentStore/unversioned/file-system.js +174 -0
  211. package/dist/esm/services/documentStore/unversioned/index.d.ts +2 -0
  212. package/dist/esm/services/documentStore/unversioned/index.js +1 -0
  213. package/dist/esm/services/documentStore/versioned/dynamodb.d.ts +25 -0
  214. package/dist/esm/services/documentStore/versioned/dynamodb.js +139 -0
  215. package/dist/esm/services/documentStore/versioned/file-system.d.ts +25 -0
  216. package/dist/esm/services/documentStore/versioned/file-system.js +69 -0
  217. package/dist/esm/services/documentStore/versioned/index.d.ts +17 -0
  218. package/dist/esm/services/documentStore/versioned/index.js +1 -0
  219. package/dist/esm/services/exercisesGateway/index.d.ts +67 -0
  220. package/dist/esm/services/exercisesGateway/index.js +70 -0
  221. package/dist/esm/services/fileServer/index.d.ts +30 -0
  222. package/dist/esm/services/fileServer/index.js +13 -0
  223. package/dist/esm/services/fileServer/localFileServer.d.ts +13 -0
  224. package/dist/esm/services/fileServer/localFileServer.js +125 -0
  225. package/dist/esm/services/fileServer/s3FileServer.d.ts +14 -0
  226. package/dist/esm/services/fileServer/s3FileServer.js +124 -0
  227. package/dist/esm/services/launchParams/index.d.ts +2 -0
  228. package/dist/esm/services/launchParams/index.js +2 -0
  229. package/dist/esm/services/launchParams/signer.d.ts +23 -0
  230. package/dist/esm/services/launchParams/signer.js +51 -0
  231. package/dist/esm/services/launchParams/verifier.d.ts +21 -0
  232. package/dist/esm/services/launchParams/verifier.js +92 -0
  233. package/dist/esm/services/logger/console.d.ts +4 -0
  234. package/{packages/utils/src/services/logger/console.ts → dist/esm/services/logger/console.js} +2 -5
  235. package/dist/esm/services/logger/index.d.ts +39 -0
  236. package/dist/esm/services/logger/index.js +27 -0
  237. package/dist/esm/services/lrsGateway/addStatementDefaultFields.d.ts +5 -0
  238. package/dist/esm/services/lrsGateway/addStatementDefaultFields.js +14 -0
  239. package/dist/esm/services/lrsGateway/attempt-utils.d.ts +72 -0
  240. package/dist/esm/services/lrsGateway/attempt-utils.js +261 -0
  241. package/dist/esm/services/lrsGateway/file-system.d.ts +15 -0
  242. package/dist/esm/services/lrsGateway/file-system.js +110 -0
  243. package/dist/esm/services/lrsGateway/index.d.ts +122 -0
  244. package/dist/esm/services/lrsGateway/index.js +111 -0
  245. package/dist/esm/services/lrsGateway/xapiUtils.d.ts +71 -0
  246. package/dist/esm/services/lrsGateway/xapiUtils.js +134 -0
  247. package/dist/esm/services/postgresConnection/index.d.ts +28 -0
  248. package/dist/esm/services/postgresConnection/index.js +58 -0
  249. package/dist/esm/services/searchProvider/index.d.ts +67 -0
  250. package/dist/esm/services/searchProvider/index.js +1 -0
  251. package/dist/esm/services/searchProvider/memorySearchTheBadWay.d.ts +20 -0
  252. package/dist/esm/services/searchProvider/memorySearchTheBadWay.js +187 -0
  253. package/dist/esm/services/searchProvider/openSearch.d.ts +28 -0
  254. package/dist/esm/services/searchProvider/openSearch.js +150 -0
  255. package/dist/esm/tsconfig.without-specs.esm.tsbuildinfo +1 -0
  256. package/dist/esm/types.d.ts +31 -0
  257. package/dist/esm/types.js +1 -0
  258. package/package.json +228 -12
  259. package/.cfnlintrc +0 -2
  260. package/.github/CODEOWNERS +0 -1
  261. package/.github/workflows/ci.yml +0 -36
  262. package/.github/workflows/lint.yml +0 -55
  263. package/.nvmrc +0 -1
  264. package/.syncignore +0 -4
  265. package/.syncpackrc +0 -18
  266. package/CONTRIBUTING.md +0 -96
  267. package/LICENSE +0 -661
  268. package/Procfile +0 -1
  269. package/app.json +0 -23
  270. package/cspell.json +0 -32
  271. package/deploy/constants.env +0 -21
  272. package/deploy/deploy.bash +0 -157
  273. package/deploy/deployment-alt-region.cfn.yml +0 -70
  274. package/deploy/deployment.cfn.yml +0 -650
  275. package/deploy/destroy-deployment.bash +0 -23
  276. package/deploy/shared.cfn.yml +0 -94
  277. package/docs/lambda-build.md +0 -35
  278. package/packages/frontend/README.md +0 -46
  279. package/packages/frontend/package.json +0 -101
  280. package/packages/frontend/public/favicon.ico +0 -0
  281. package/packages/frontend/public/index.html +0 -107
  282. package/packages/frontend/public/maintenance.html +0 -59
  283. package/packages/frontend/public/manifest.json +0 -15
  284. package/packages/frontend/public/robots.txt +0 -3
  285. package/packages/frontend/script/make-certificate.bash +0 -49
  286. package/packages/frontend/script/server/cli.js +0 -11
  287. package/packages/frontend/script/server/index.js +0 -47
  288. package/packages/frontend/script/start.bash +0 -22
  289. package/packages/frontend/script/trust-localhost.bash +0 -7
  290. package/packages/frontend/src/auth/authProvider.ts +0 -10
  291. package/packages/frontend/src/auth/useAuth.ts +0 -33
  292. package/packages/frontend/src/components/Pagination.tsx +0 -26
  293. package/packages/frontend/src/configProvider/index.ts +0 -53
  294. package/packages/frontend/src/configProvider/use.ts +0 -41
  295. package/packages/frontend/src/core/context/services.spec.tsx +0 -39
  296. package/packages/frontend/src/core/context/services.tsx +0 -16
  297. package/packages/frontend/src/core/index.spec.ts +0 -7
  298. package/packages/frontend/src/core/index.ts +0 -20
  299. package/packages/frontend/src/core/services.tsx +0 -14
  300. package/packages/frontend/src/core/types.ts +0 -3
  301. package/packages/frontend/src/example/api.ts +0 -28
  302. package/packages/frontend/src/example/components/Layout.tsx +0 -23
  303. package/packages/frontend/src/example/screens/Home.spec.tsx +0 -68
  304. package/packages/frontend/src/example/screens/Home.tsx +0 -78
  305. package/packages/frontend/src/example/screens/ThingList.spec.tsx +0 -60
  306. package/packages/frontend/src/example/screens/ThingList.tsx +0 -75
  307. package/packages/frontend/src/example/screens/ThingView.spec.tsx +0 -71
  308. package/packages/frontend/src/example/screens/ThingView.tsx +0 -47
  309. package/packages/frontend/src/example/screens/index.ts +0 -9
  310. package/packages/frontend/src/index.css +0 -159
  311. package/packages/frontend/src/index.tsx +0 -67
  312. package/packages/frontend/src/react-app-env.d.ts +0 -1
  313. package/packages/frontend/src/routing/components/RouteLink.spec.tsx +0 -55
  314. package/packages/frontend/src/routing/components/RouteLink.tsx +0 -35
  315. package/packages/frontend/src/routing/middleware.ts +0 -6
  316. package/packages/frontend/src/routing/useQuery.ts +0 -14
  317. package/packages/frontend/src/setupProxy.js +0 -19
  318. package/packages/frontend/src/setupTests.ts +0 -9
  319. package/packages/frontend/src/tests/testServices.tsx +0 -23
  320. package/packages/frontend/tsconfig.json +0 -27
  321. package/packages/lambda/.eslintrc.js +0 -64
  322. package/packages/lambda/jest-global-setup.js +0 -3
  323. package/packages/lambda/jest-setup-after-env.js +0 -1
  324. package/packages/lambda/jest.config.js +0 -31
  325. package/packages/lambda/jest.resolver.js +0 -17
  326. package/packages/lambda/package.json +0 -68
  327. package/packages/lambda/script/build.bash +0 -19
  328. package/packages/lambda/script/bundle-functions.bash +0 -10
  329. package/packages/lambda/script/lambdaLocalProxy.js +0 -16
  330. package/packages/lambda/script/lambdaLocalProxy.spec.ts +0 -147
  331. package/packages/lambda/script/utils/getRouteData.ts +0 -7
  332. package/packages/lambda/script/utils/routeDataLoader.js +0 -8
  333. package/packages/lambda/script/utils/routeDataLoader.spec.ts +0 -8
  334. package/packages/lambda/src/functions/serviceApi/core/index.ts +0 -7
  335. package/packages/lambda/src/functions/serviceApi/core/request.spec.ts +0 -38
  336. package/packages/lambda/src/functions/serviceApi/core/request.ts +0 -42
  337. package/packages/lambda/src/functions/serviceApi/core/routes.spec.ts +0 -7
  338. package/packages/lambda/src/functions/serviceApi/core/routes.ts +0 -10
  339. package/packages/lambda/src/functions/serviceApi/core/services.ts +0 -9
  340. package/packages/lambda/src/functions/serviceApi/core/types.ts +0 -13
  341. package/packages/lambda/src/functions/serviceApi/entry/lambda/https-xray.ts +0 -4
  342. package/packages/lambda/src/functions/serviceApi/entry/lambda/index.spec.ts +0 -48
  343. package/packages/lambda/src/functions/serviceApi/entry/lambda/index.ts +0 -58
  344. package/packages/lambda/src/functions/serviceApi/entry/lambda/services.ts +0 -36
  345. package/packages/lambda/src/functions/serviceApi/entry/local.ts +0 -71
  346. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentSearchMiddleware.spec.ts +0 -16
  347. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentSearchMiddleware.ts +0 -41
  348. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentStoreMiddleware.spec.ts +0 -78
  349. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentStoreMiddleware.ts +0 -70
  350. package/packages/lambda/src/functions/serviceApi/versions/v0/example/routes.spec.ts +0 -306
  351. package/packages/lambda/src/functions/serviceApi/versions/v0/example/routes.ts +0 -176
  352. package/packages/lambda/src/functions/serviceApi/versions/v0/index.spec.ts +0 -263
  353. package/packages/lambda/src/functions/serviceApi/versions/v0/index.ts +0 -134
  354. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/authMiddleware.spec.ts +0 -23
  355. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/authMiddleware.ts +0 -32
  356. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/configMiddleware.spec.ts +0 -10
  357. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/configMiddleware.ts +0 -7
  358. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/frontendFileServerMiddleware.spec.ts +0 -13
  359. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/frontendFileServerMiddleware.ts +0 -23
  360. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/paginationMiddleware.spec.ts +0 -9
  361. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/paginationMiddleware.ts +0 -9
  362. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/searchMiddleware.spec.ts +0 -12
  363. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/searchMiddleware.ts +0 -21
  364. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/userRoleValidatorMiddleware.spec.ts +0 -21
  365. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/userRoleValidatorMiddleware.ts +0 -18
  366. package/packages/lambda/tsconfig.json +0 -30
  367. package/packages/lambda/webpack.config.js +0 -97
  368. package/packages/utils/.eslintrc.js +0 -64
  369. package/packages/utils/README.md +0 -118
  370. package/packages/utils/jest-global-setup.js +0 -3
  371. package/packages/utils/jest.config.js +0 -25
  372. package/packages/utils/jest.resolver.js +0 -17
  373. package/packages/utils/package.json +0 -238
  374. package/packages/utils/src/assertions/index.spec.ts +0 -126
  375. package/packages/utils/src/aws/ssmService.ts +0 -7
  376. package/packages/utils/src/config/awsParameterConfig.ts +0 -24
  377. package/packages/utils/src/config/envConfig.ts +0 -58
  378. package/packages/utils/src/config/index.spec.ts +0 -165
  379. package/packages/utils/src/config/lambdaParameterConfig.ts +0 -49
  380. package/packages/utils/src/config/resolveConfigValue.ts +0 -10
  381. package/packages/utils/src/errors/index.spec.ts +0 -35
  382. package/packages/utils/src/fetch/fetchStatusRetry.spec.ts +0 -197
  383. package/packages/utils/src/fetch/fetchStatusRetry.ts +0 -33
  384. package/packages/utils/src/fetch/index.spec.ts +0 -34
  385. package/packages/utils/src/fetch/index.ts +0 -87
  386. package/packages/utils/src/guards/index.spec.ts +0 -58
  387. package/packages/utils/src/index.spec.ts +0 -471
  388. package/packages/utils/src/middleware/apiErrorHandler.spec.ts +0 -65
  389. package/packages/utils/src/middleware/apiErrorHandler.ts +0 -67
  390. package/packages/utils/src/middleware/apiSlowResponseMiddleware.spec.ts +0 -184
  391. package/packages/utils/src/middleware/apiSlowResponseMiddleware.ts +0 -71
  392. package/packages/utils/src/middleware/index.spec.ts +0 -99
  393. package/packages/utils/src/middleware/lambdaCorsResponseMiddleware.spec.ts +0 -103
  394. package/packages/utils/src/middleware/lambdaCorsResponseMiddleware.ts +0 -52
  395. package/packages/utils/src/middleware/throwNotFoundMiddleware.spec.ts +0 -20
  396. package/packages/utils/src/middleware/throwNotFoundMiddleware.ts +0 -11
  397. package/packages/utils/src/misc/hashValue.ts +0 -18
  398. package/packages/utils/src/misc/helpers.ts +0 -259
  399. package/packages/utils/src/misc/merge.ts +0 -48
  400. package/packages/utils/src/pagination/index.spec.ts +0 -150
  401. package/packages/utils/src/pagination/index.ts +0 -117
  402. package/packages/utils/src/routing/index.spec.ts +0 -553
  403. package/packages/utils/src/routing/index.ts +0 -424
  404. package/packages/utils/src/routing/validators/zod.spec.ts +0 -16
  405. package/packages/utils/src/routing/validators/zod.ts +0 -14
  406. package/packages/utils/src/services/accountsGateway/README.md +0 -3
  407. package/packages/utils/src/services/accountsGateway/index.spec.ts +0 -518
  408. package/packages/utils/src/services/accountsGateway/index.ts +0 -251
  409. package/packages/utils/src/services/apiGateway/README.md +0 -93
  410. package/packages/utils/src/services/apiGateway/index.spec.ts +0 -254
  411. package/packages/utils/src/services/apiGateway/index.ts +0 -189
  412. package/packages/utils/src/services/authProvider/README.md +0 -21
  413. package/packages/utils/src/services/authProvider/browser.spec.ts +0 -391
  414. package/packages/utils/src/services/authProvider/browser.ts +0 -209
  415. package/packages/utils/src/services/authProvider/decryption.spec.ts +0 -337
  416. package/packages/utils/src/services/authProvider/decryption.ts +0 -98
  417. package/packages/utils/src/services/authProvider/index.ts +0 -93
  418. package/packages/utils/src/services/authProvider/stub.spec.ts +0 -29
  419. package/packages/utils/src/services/authProvider/subrequest.spec.ts +0 -105
  420. package/packages/utils/src/services/authProvider/subrequest.ts +0 -68
  421. package/packages/utils/src/services/authProvider/utils/decryptAndVerify.spec.ts +0 -128
  422. package/packages/utils/src/services/authProvider/utils/decryptAndVerify.ts +0 -106
  423. package/packages/utils/src/services/authProvider/utils/embeddedAuthProvider.spec.ts +0 -26
  424. package/packages/utils/src/services/authProvider/utils/embeddedAuthProvider.ts +0 -57
  425. package/packages/utils/src/services/authProvider/utils/userRoleValidator.spec.ts +0 -135
  426. package/packages/utils/src/services/authProvider/utils/userRoleValidator.ts +0 -49
  427. package/packages/utils/src/services/authProvider/utils/userSubrequest.spec.ts +0 -26
  428. package/packages/utils/src/services/authProvider/utils/userSubrequest.ts +0 -10
  429. package/packages/utils/src/services/documentStore/dynamoEncoding.ts +0 -57
  430. package/packages/utils/src/services/documentStore/fileSystemAssert.spec.ts +0 -43
  431. package/packages/utils/src/services/documentStore/fileSystemAssert.ts +0 -10
  432. package/packages/utils/src/services/documentStore/unversioned/README.md +0 -13
  433. package/packages/utils/src/services/documentStore/unversioned/dynamodb.spec.ts +0 -859
  434. package/packages/utils/src/services/documentStore/unversioned/dynamodb.ts +0 -243
  435. package/packages/utils/src/services/documentStore/unversioned/file-system.spec.ts +0 -629
  436. package/packages/utils/src/services/documentStore/unversioned/file-system.ts +0 -194
  437. package/packages/utils/src/services/documentStore/versioned/README.md +0 -13
  438. package/packages/utils/src/services/documentStore/versioned/dynamodb.spec.ts +0 -376
  439. package/packages/utils/src/services/documentStore/versioned/dynamodb.ts +0 -167
  440. package/packages/utils/src/services/documentStore/versioned/file-system.spec.ts +0 -262
  441. package/packages/utils/src/services/documentStore/versioned/file-system.ts +0 -90
  442. package/packages/utils/src/services/documentStore/versioned/index.ts +0 -25
  443. package/packages/utils/src/services/exercisesGateway/README.md +0 -5
  444. package/packages/utils/src/services/exercisesGateway/index.spec.ts +0 -326
  445. package/packages/utils/src/services/exercisesGateway/index.ts +0 -163
  446. package/packages/utils/src/services/fileServer/index.spec.ts +0 -88
  447. package/packages/utils/src/services/fileServer/index.ts +0 -43
  448. package/packages/utils/src/services/fileServer/localFileServer.spec.ts +0 -182
  449. package/packages/utils/src/services/fileServer/localFileServer.ts +0 -159
  450. package/packages/utils/src/services/fileServer/s3FileServer.spec.ts +0 -266
  451. package/packages/utils/src/services/fileServer/s3FileServer.ts +0 -155
  452. package/packages/utils/src/services/launchParams/index.spec.ts +0 -366
  453. package/packages/utils/src/services/launchParams/signer.ts +0 -73
  454. package/packages/utils/src/services/launchParams/verifier.ts +0 -120
  455. package/packages/utils/src/services/logger/console.spec.ts +0 -29
  456. package/packages/utils/src/services/logger/index.spec.ts +0 -65
  457. package/packages/utils/src/services/lrsGateway/README.md +0 -5
  458. package/packages/utils/src/services/lrsGateway/addStatementDefaultFields.ts +0 -22
  459. package/packages/utils/src/services/lrsGateway/attempt-utils.spec.ts +0 -847
  460. package/packages/utils/src/services/lrsGateway/attempt-utils.ts +0 -358
  461. package/packages/utils/src/services/lrsGateway/file-system.spec.ts +0 -363
  462. package/packages/utils/src/services/lrsGateway/file-system.ts +0 -165
  463. package/packages/utils/src/services/lrsGateway/index.spec.ts +0 -194
  464. package/packages/utils/src/services/lrsGateway/index.ts +0 -257
  465. package/packages/utils/src/services/lrsGateway/xapiUtils.spec.ts +0 -887
  466. package/packages/utils/src/services/lrsGateway/xapiUtils.ts +0 -262
  467. package/packages/utils/src/services/postgresConnection/index.spec.ts +0 -170
  468. package/packages/utils/src/services/postgresConnection/index.ts +0 -84
  469. package/packages/utils/src/services/searchProvider/README.md +0 -3
  470. package/packages/utils/src/services/searchProvider/index.ts +0 -59
  471. package/packages/utils/src/services/searchProvider/memorySearchTheBadWay.spec.ts +0 -526
  472. package/packages/utils/src/services/searchProvider/memorySearchTheBadWay.ts +0 -223
  473. package/packages/utils/src/services/searchProvider/openSearch.spec.ts +0 -926
  474. package/packages/utils/src/services/searchProvider/openSearch.ts +0 -195
  475. package/packages/utils/tsconfig.json +0 -31
  476. package/packages/utils/tsconfig.without-specs.cjs.json +0 -7
  477. package/packages/utils/tsconfig.without-specs.esm.json +0 -7
  478. package/packages/utils/tsconfig.without-specs.json +0 -6
  479. package/scripts/build.bash +0 -24
  480. package/scripts/ci.bash +0 -10
  481. package/scripts/start.bash +0 -29
  482. /package/{packages/utils/src/index.ts → dist/cjs/index.d.ts} +0 -0
  483. /package/{packages/utils/src/services/launchParams/index.ts → dist/cjs/services/launchParams/index.d.ts} +0 -0
  484. /package/{packages/utils/script → script}/bin/copy-from-template.bash +0 -0
  485. /package/{packages/utils/script → script}/bin/delete-stack.bash +0 -0
  486. /package/{packages/utils/script → script}/bin/deploy.bash +0 -0
  487. /package/{packages/utils/script → script}/bin/destroy-deployment.bash +0 -0
  488. /package/{packages/utils/script → script}/bin/empty-bucket.bash +0 -0
  489. /package/{packages/utils/script → script}/bin/get-arg.bash +0 -0
  490. /package/{packages/utils/script → script}/bin/get-deployed-environments.bash +0 -0
  491. /package/{packages/utils/script → script}/bin/get-env-param.bash +0 -0
  492. /package/{packages/utils/script → script}/bin/get-kwarg.bash +0 -0
  493. /package/{packages/utils/script → script}/bin/get-stack-param.bash +0 -0
  494. /package/{packages/utils/script → script}/bin/has-flag.bash +0 -0
  495. /package/{packages/utils/script → script}/bin/init-constants-script.bash +0 -0
  496. /package/{packages/utils/script → script}/bin/init-params-script.bash +0 -0
  497. /package/{packages/utils/script → script}/bin/stack-exists.bash +0 -0
  498. /package/{packages/utils/script → script}/bin/update-utils.bash +0 -0
  499. /package/{packages/utils/script → script}/bin/upload-pager-duty-endpoints.bash +0 -0
  500. /package/{packages/utils/script → script}/bin/upload-params.bash +0 -0
  501. /package/{packages/utils/script → script}/bin/which.bash +0 -0
  502. /package/{packages/utils/script → script}/bin-entry.bash +0 -0
  503. /package/{packages/utils/script → script}/build.bash +0 -0
@@ -1,68 +0,0 @@
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
- }
@@ -1,19 +0,0 @@
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[@]}"
@@ -1,10 +0,0 @@
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
@@ -1,16 +0,0 @@
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
- }
@@ -1,147 +0,0 @@
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
- });
@@ -1,7 +0,0 @@
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
- }), {});
@@ -1,8 +0,0 @@
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
- };
@@ -1,8 +0,0 @@
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;
@@ -1,7 +0,0 @@
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
@@ -1,38 +0,0 @@
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
- });
@@ -1,42 +0,0 @@
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
- });
@@ -1,7 +0,0 @@
1
- import { apiRoutes } from './routes';
2
-
3
- describe('routes', () => {
4
- it('aggregates api routes', () => {
5
- expect(apiRoutes()).toEqual(expect.any(Array));
6
- });
7
- });
@@ -1,10 +0,0 @@
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>();
@@ -1,9 +0,0 @@
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
- }>();
@@ -1,13 +0,0 @@
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);
@@ -1,4 +0,0 @@
1
- import { captureHTTPsGlobal } from 'aws-xray-sdk';
2
-
3
- captureHTTPsGlobal(require('http'), true);
4
- captureHTTPsGlobal(require('https'), true);
@@ -1,48 +0,0 @@
1
- import { APIGatewayProxyEventV2 } from 'aws-lambda/trigger/api-gateway-proxy';
2
- import { setContextMissingStrategy } from 'aws-xray-sdk';
3
- import * as coreModule from '../../core';
4
- import { handler } from '.';
5
-
6
- setContextMissingStrategy('IGNORE_ERROR');
7
-
8
- jest.mock('../../core', () => {
9
- const getRequestResponse = jest.fn();
10
- return {
11
- getRequestResponse,
12
- getRequestResponder: jest.fn(() => getRequestResponse)
13
- };
14
- });
15
-
16
- afterEach(() => {
17
- jest.clearAllMocks();
18
- });
19
-
20
- describe('handler', () => {
21
- let getRequestResponseSpy: jest.SpyInstance;
22
- let mockResponse: coreModule.ApiRouteResponse | undefined;
23
-
24
- beforeEach(async() => {
25
- mockResponse = {body: 'foobar body', statusCode: 200, data: 'foobar body'};
26
- getRequestResponseSpy = (coreModule as any).getRequestResponse.mockImplementation(() => Promise.resolve(mockResponse));
27
- });
28
-
29
- afterEach(() => {
30
- jest.clearAllMocks();
31
- });
32
-
33
- it('returns response', async() => {
34
- const request = {
35
- cookies: [],
36
- headers: { },
37
- requestContext: {
38
- http: {
39
- method: 'GET'
40
- }
41
- }
42
- } as unknown as APIGatewayProxyEventV2;
43
- const response = await handler(request);
44
-
45
- expect(getRequestResponseSpy).toHaveBeenCalledWith(request);
46
- expect(response.body).toBe('foobar body');
47
- });
48
- });
@@ -1,58 +0,0 @@
1
- /* spell-checker: ignore avif apng thbs KHTML */
2
- import './https-xray';
3
-
4
- import { APIGatewayProxyEventV2 } from 'aws-lambda/trigger/api-gateway-proxy';
5
- import { getRequestResponder } from '../../core';
6
- import { ApiRouteResponse } from '../../core/types';
7
- import { lambdaMiddleware, lambdaServices } from './services';
8
-
9
- /*
10
- * for posterity, the payload format looks like this
11
- * {
12
- * version: '2.0',
13
- * routeKey: '$default',
14
- * rawPath: '/favicon.ico',
15
- * rawQueryString: '',
16
- * headers: {
17
- * accept: 'image/avif,image/webp,image/apng,image/svg+xml;q=0.8',
18
- * 'accept-encoding': 'gzip, deflate, br',
19
- * 'accept-language': 'en-US,en;q=0.9',
20
- * 'content-length': '0',
21
- * host: 'o8thbs5d45.execute-api.us-east-1.amazonaws.com',
22
- * referer: 'https://o8thbs5d45.execute-api.us-east-1.amazonaws.com/api/foobar',
23
- * 'sec-ch-ua': '" Not;A Brand";v="99", "Google Chrome";v="97", "Chromium";v="97"',
24
- * 'sec-ch-ua-mobile': '?0',
25
- * 'sec-ch-ua-platform': '"macOS"',
26
- * 'sec-fetch-dest': 'image',
27
- * 'sec-fetch-mode': 'no-cors',
28
- * 'sec-fetch-site': 'same-origin',
29
- * 'user-agent': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/97.0.4692.71 Safari/537.36',
30
- * 'x-amzn-trace-id': 'Root=1-6213f295-165a47a57d98e524555003ce',
31
- * 'x-forwarded-for': '100.37.48.117',
32
- * 'x-forwarded-port': '443',
33
- * 'x-forwarded-proto': 'https'
34
- * },
35
- * requestContext: {
36
- * accountId: '373045849756',
37
- * apiId: 'o8thbs5d45',
38
- * domainName: 'o8thbs5d45.execute-api.us-east-1.amazonaws.com',
39
- * domainPrefix: 'o8thbs5d45',
40
- * http: {
41
- * method: 'GET',
42
- * path: '/favicon.ico',
43
- * protocol: 'HTTP/1.1',
44
- * sourceIp: '100.37.48.117',
45
- * userAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/97.0.4692.71 Safari/537.36'
46
- * },
47
- * requestId: 'N6LXVhOjoAMEMkQ=',
48
- * routeKey: '$default',
49
- * stage: '$default',
50
- * time: '21/Feb/2022:20:14:13 +0000',
51
- * timeEpoch: 1645474453192
52
- * },
53
- * isBase64Encoded: false
54
- * }
55
- */
56
-
57
- export const handler: (request: APIGatewayProxyEventV2) => Promise<ApiRouteResponse> =
58
- getRequestResponder(lambdaServices, lambdaMiddleware);
@@ -1,36 +0,0 @@
1
- import { DynamoDB } from '@aws-sdk/client-dynamodb';
2
- import { S3Client } from '@aws-sdk/client-s3';
3
- import { getKeyValue } from '@openstax/ts-utils';
4
- import { createLambdaCorsResponseMiddleware } from '@openstax/ts-utils/middleware/lambdaCorsResponseMiddleware';
5
- import { createThrowNotFoundMiddleware } from '@openstax/ts-utils/middleware/throwNotFoundMiddleware';
6
- import { decryptionAuthProvider } from '@openstax/ts-utils/services/authProvider/decryption';
7
- import { dynamoVersionedDocumentStore } from '@openstax/ts-utils/services/documentStore/versioned/dynamodb';
8
- import { s3FileServer } from '@openstax/ts-utils/services/fileServer/s3FileServer';
9
- import { openSearchService } from '@openstax/ts-utils/services/searchProvider/openSearch';
10
- import { captureAWSv3Client } from 'aws-xray-sdk';
11
- import fetch from 'node-fetch';
12
- import { composeResponseMiddleware, slowResponseMiddleware } from '../../core/request';
13
- import { ApiRouteResponse } from '../../core/types';
14
-
15
- const dynamoClient = captureAWSv3Client(new DynamoDB({apiVersion: '2012-08-10'}));
16
-
17
- export const lambdaServices = {
18
- createAuthProvider: decryptionAuthProvider({configSpace: 'deployed', fetch}),
19
- createFileServer: s3FileServer({
20
- configSpace: 'deployed',
21
- getS3Client: /* istanbul ignore next */ (...args) => captureAWSv3Client(new S3Client(...args))
22
- }),
23
- getEnvironmentConfig: getKeyValue('deployed'),
24
- versionedDocumentStore: dynamoVersionedDocumentStore({dynamoClient}),
25
- createSearchProvider: openSearchService({configSpace: 'deployed'}),
26
- };
27
-
28
- export type LambdaServices = typeof lambdaServices;
29
-
30
- export const lambdaMiddleware = composeResponseMiddleware(
31
- createLambdaCorsResponseMiddleware({
32
- corsAllowedHostRegex: '(openstax.org|herokuapp.com)$'
33
- }),
34
- slowResponseMiddleware,
35
- createThrowNotFoundMiddleware<ApiRouteResponse>()
36
- );
@@ -1,71 +0,0 @@
1
- import path from 'path';
2
- import url from 'url';
3
- import { getKeyValue } from '@openstax/ts-utils';
4
- import { assertString } from '@openstax/ts-utils/assertions';
5
- import { ifDefined } from '@openstax/ts-utils/guards';
6
- import { subrequestAuthProvider } from '@openstax/ts-utils/services/authProvider/subrequest';
7
- import { fileSystemVersionedDocumentStore } from '@openstax/ts-utils/services/documentStore/versioned/file-system';
8
- import { localFileServer } from '@openstax/ts-utils/services/fileServer/localFileServer';
9
- import { memorySearchTheBadWay } from '@openstax/ts-utils/services/searchProvider/memorySearchTheBadWay';
10
- import {NextFunction, Request, Response} from 'express';
11
- import fetch from 'node-fetch';
12
- import queryString from 'query-string';
13
- import { composeResponseMiddleware, getRequestResponder, slowResponseMiddleware } from '../core/request';
14
- import { ApiRouteRequest } from '../core/types';
15
-
16
- // when this runs its from the /build/src dir, so theres an extra up here
17
- const dataDir = path.join(__dirname, '../../../../../data');
18
-
19
- const services = {
20
- createAuthProvider: subrequestAuthProvider({configSpace: 'local', fetch}),
21
- createFileServer: localFileServer({configSpace: 'local', dataDir}),
22
- getEnvironmentConfig: getKeyValue('local'),
23
- versionedDocumentStore: fileSystemVersionedDocumentStore({ dataDir }),
24
- createSearchProvider: memorySearchTheBadWay,
25
- };
26
-
27
- export type LocalServices = typeof services;
28
-
29
- export const handler = (request: Request, response: Response, next: NextFunction) => {
30
- const getRequestResponse = getRequestResponder(services, composeResponseMiddleware(
31
- slowResponseMiddleware,
32
- ));
33
- const {pathname, search} = url.parse(request.url);
34
-
35
- // https://docs.aws.amazon.com/lambda/latest/dg/services-apigateway.html#apigateway-example-event
36
- const payload = {
37
- cookies: request.headers.cookie ? request.headers.cookie.split('; ') : [],
38
- headers: request.headers,
39
- body: request.body,
40
- // https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
41
- // APIGatewayProxyEventV2 no longer has multiValueQueryStringParameters, instead it joins multiple values on comma
42
- queryStringParameters: search
43
- ? Object.fromEntries(
44
- Object.entries(queryString.parse(search)).map(([key, entry]) => [key, entry instanceof Array ? entry.join(',') : entry])
45
- )
46
- : undefined,
47
- requestContext: {
48
- http: {
49
- method: request.method,
50
- path: decodeURIComponent(assertString(pathname, new Error('invalid request.url'))),
51
- }
52
- }
53
- } as ApiRouteRequest;
54
-
55
- const responsePromise = getRequestResponse(payload);
56
-
57
- if (!responsePromise) {
58
- return next();
59
- }
60
-
61
- responsePromise.then(apiResponse => {
62
- // TODO - other stuff in the response
63
- response.status(ifDefined(apiResponse.statusCode, 200));
64
- response.set(apiResponse.headers);
65
-
66
- response.end(apiResponse.isBase64Encoded
67
- ? Buffer.from(apiResponse.body, 'base64')
68
- : apiResponse.body
69
- );
70
- });
71
- };