@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,263 +0,0 @@
1
- import { getKeyValue } from '@openstax/ts-utils';
2
- import { stubAuthProvider, User } from '@openstax/ts-utils/services/authProvider';
3
- import { FileServerAdapter } from '@openstax/ts-utils/services/fileServer';
4
- import { createConsoleLogger } from '@openstax/ts-utils/services/logger/console';
5
- import { ApiRouteRequest, AppServices } from '../../core';
6
- import { apiV0Index, apiV0Routes, buildIndex, makeIndexHtmlBody } from '.';
7
-
8
- let appServices: AppServices;
9
- let request: ApiRouteRequest;
10
-
11
- beforeEach(async () => {
12
- appServices = {} as AppServices;
13
- request = {} as ApiRouteRequest;
14
- });
15
-
16
- afterEach(() => {
17
- jest.clearAllMocks();
18
- });
19
-
20
- describe('apiV0Index', () => {
21
- it('matches snapshot', async() => {
22
- const requestServices = {
23
- logger: createConsoleLogger(),
24
- request,
25
- environmentConfig: {
26
- codeVersion: 'code-version-goes-here',
27
- apiHost: '',
28
- uiHost: '',
29
- maintenanceMessage: '',
30
- frontendConfig: {
31
- roleApplication: 'test',
32
- accountsBase: 'https://dev.openstax.org/accounts',
33
- exampleMessage: 'hello from /api/v0/info',
34
- },
35
- },
36
- authProvider: stubAuthProvider()
37
- };
38
- const response = await apiV0Index.handler(undefined, requestServices);
39
- expect(response).toMatchInlineSnapshot(`
40
- {
41
- "body": "{"message":"greetings from the api controller","code":"code-version-goes-here","config":{"roleApplication":"test","accountsBase":"https://dev.openstax.org/accounts","exampleMessage":"hello from /api/v0/info","releaseId":"code-version-goes-here"}}",
42
- "data": {
43
- "code": "code-version-goes-here",
44
- "config": {
45
- "accountsBase": "https://dev.openstax.org/accounts",
46
- "exampleMessage": "hello from /api/v0/info",
47
- "releaseId": "code-version-goes-here",
48
- "roleApplication": "test",
49
- },
50
- "message": "greetings from the api controller",
51
- },
52
- "headers": {
53
- "content-type": "application/json",
54
- },
55
- "statusCode": 200,
56
- }
57
- `);
58
- });
59
-
60
- it('matches snapshot with user', async() => {
61
- const requestServices = {
62
- logger: createConsoleLogger(),
63
- request,
64
- environmentConfig: {
65
- codeVersion: 'code-version-goes-here',
66
- apiHost: '',
67
- uiHost: '',
68
- maintenanceMessage: '',
69
- frontendConfig: {
70
- roleApplication: 'test',
71
- accountsBase: 'https://dev.openstax.org/accounts',
72
- exampleMessage: 'hello from /api/v0/info',
73
- },
74
- },
75
- authProvider: stubAuthProvider({name: 'test user', uuid: '5c9f7915-4abb-499b-805d-de29cdf67e2d'} as User)
76
- };
77
- appServices.getEnvironmentConfig = getKeyValue('deployed');
78
- const response = await apiV0Index.handler(undefined, requestServices);
79
- expect(response).toMatchInlineSnapshot(`
80
- {
81
- "body": "{"message":"greetings from the api controller test user","code":"code-version-goes-here","config":{"roleApplication":"test","accountsBase":"https://dev.openstax.org/accounts","exampleMessage":"hello from /api/v0/info","releaseId":"code-version-goes-here"}}",
82
- "data": {
83
- "code": "code-version-goes-here",
84
- "config": {
85
- "accountsBase": "https://dev.openstax.org/accounts",
86
- "exampleMessage": "hello from /api/v0/info",
87
- "releaseId": "code-version-goes-here",
88
- "roleApplication": "test",
89
- },
90
- "message": "greetings from the api controller test user",
91
- },
92
- "headers": {
93
- "content-type": "application/json",
94
- },
95
- "statusCode": 200,
96
- }
97
- `);
98
- });
99
- });
100
-
101
- describe('buildIndex', () => {
102
- it('matches snapshot without user', async() => {
103
- const requestServices = {
104
- authProvider: stubAuthProvider(),
105
- environmentConfig: {
106
- codeVersion: 'code-version-goes-here',
107
- apiHost: '',
108
- uiHost: '',
109
- maintenanceMessage: '',
110
- frontendConfig: {
111
- roleApplication: 'test',
112
- accountsBase: 'https://dev.openstax.org/accounts',
113
- exampleMessage: 'hello from /api/v0/info',
114
- },
115
- },
116
- frontendFileServer: {
117
- putFileContent: jest.fn(),
118
- getSignedViewerUrl: jest.fn(),
119
- getFileContent: async() => Buffer.from(
120
- '<html><head><!-- Static head stuff --></head><body><!-- Static body stuff --></body></html>'
121
- )
122
- } as unknown as FileServerAdapter,
123
- logger: createConsoleLogger(),
124
- request,
125
- };
126
- const response = await buildIndex.handler(undefined, requestServices);
127
- expect(response).toMatchInlineSnapshot(`
128
- {
129
- "body": "<html><head>
130
- <script>window._OX_FRONTEND_CONFIG = {"roleApplication":"test","accountsBase":"https://dev.openstax.org/accounts","exampleMessage":"hello from /api/v0/info","releaseId":"code-version-goes-here"};</script><!-- Static head stuff --></head><body><!-- Static body stuff --></body></html>",
131
- "data": "<html><head>
132
- <script>window._OX_FRONTEND_CONFIG = {"roleApplication":"test","accountsBase":"https://dev.openstax.org/accounts","exampleMessage":"hello from /api/v0/info","releaseId":"code-version-goes-here"};</script><!-- Static head stuff --></head><body><!-- Static body stuff --></body></html>",
133
- "headers": {
134
- "cache-control": "no-cache",
135
- "content-type": "text/html",
136
- },
137
- "statusCode": 200,
138
- }
139
- `);
140
- });
141
-
142
- it('matches snapshot with user', async() => {
143
- const requestServices = {
144
- authProvider: stubAuthProvider({
145
- uuid: '5c9f7915-4abb-499b-805d-de29cdf67e2d',
146
- consent_preferences: { accepted: ['test'], rejected: ['nothing'] },
147
- } as User),
148
- environmentConfig: {
149
- codeVersion: 'code-version-goes-here',
150
- apiHost: '',
151
- uiHost: '',
152
- maintenanceMessage: '',
153
- frontendConfig: {
154
- roleApplication: 'test',
155
- accountsBase: 'https://dev.openstax.org/accounts',
156
- exampleMessage: 'hello from /api/v0/info',
157
- },
158
- },
159
- frontendFileServer: {
160
- putFileContent: jest.fn(),
161
- getSignedViewerUrl: jest.fn(),
162
- getFileContent: async() => Buffer.from(
163
- '<html><head><!-- Static head stuff --></head><body><!-- Static body stuff --></body></html>'
164
- )
165
- } as unknown as FileServerAdapter,
166
- logger: createConsoleLogger(),
167
- request,
168
- };
169
- const response = await buildIndex.handler(undefined, requestServices);
170
- expect(response).toMatchInlineSnapshot(`
171
- {
172
- "body": "<html><head>
173
- <script>
174
- window._OX_AUTH_TOKEN = 'authToken';
175
- window._OX_USER_DATA = {"consentPreferences":{"accepted":["test"],"rejected":["nothing"]},"uuid":"5c9f7915-4abb-499b-805d-de29cdf67e2d"};
176
- </script>
177
- <script>window._OX_FRONTEND_CONFIG = {"roleApplication":"test","accountsBase":"https://dev.openstax.org/accounts","exampleMessage":"hello from /api/v0/info","releaseId":"code-version-goes-here"};</script><!-- Static head stuff --></head><body><!-- Static body stuff --></body></html>",
178
- "data": "<html><head>
179
- <script>
180
- window._OX_AUTH_TOKEN = 'authToken';
181
- window._OX_USER_DATA = {"consentPreferences":{"accepted":["test"],"rejected":["nothing"]},"uuid":"5c9f7915-4abb-499b-805d-de29cdf67e2d"};
182
- </script>
183
- <script>window._OX_FRONTEND_CONFIG = {"roleApplication":"test","accountsBase":"https://dev.openstax.org/accounts","exampleMessage":"hello from /api/v0/info","releaseId":"code-version-goes-here"};</script><!-- Static head stuff --></head><body><!-- Static body stuff --></body></html>",
184
- "headers": {
185
- "cache-control": "no-cache",
186
- "content-type": "text/html",
187
- },
188
- "statusCode": 200,
189
- }
190
- `);
191
- });
192
-
193
- it('matches snapshot with subcontent queryStringParameter', async() => {
194
- const requestServices = {
195
- authProvider: stubAuthProvider(),
196
- environmentConfig: {
197
- codeVersion: 'code-version-goes-here',
198
- apiHost: '',
199
- uiHost: '',
200
- maintenanceMessage: '',
201
- frontendConfig: {
202
- roleApplication: 'test',
203
- accountsBase: 'https://dev.openstax.org/accounts',
204
- exampleMessage: 'hello from /api/v0/info',
205
- },
206
- },
207
- frontendFileServer: {
208
- putFileContent: jest.fn(),
209
- getSignedViewerUrl: jest.fn(),
210
- getFileContent: async() => Buffer.from(
211
- '<html><head><!-- Static head stuff --></head><body><!-- Static body stuff --></body></html>'
212
- )
213
- } as unknown as FileServerAdapter,
214
- logger: createConsoleLogger(),
215
- request: { queryStringParameters: { subcontent: 'true' } } as unknown as ApiRouteRequest,
216
- };
217
- const response = await buildIndex.handler(undefined, requestServices);
218
- expect(response).toMatchInlineSnapshot(`
219
- {
220
- "body": "<html><head>
221
- <script>window._OX_FRONTEND_CONFIG = {"roleApplication":"test","accountsBase":"https://dev.openstax.org/accounts","exampleMessage":"hello from /api/v0/info","releaseId":"code-version-goes-here"};</script><!-- Static head stuff --></head><body class="os-subcontent"><!-- Static body stuff --></body></html>",
222
- "data": "<html><head>
223
- <script>window._OX_FRONTEND_CONFIG = {"roleApplication":"test","accountsBase":"https://dev.openstax.org/accounts","exampleMessage":"hello from /api/v0/info","releaseId":"code-version-goes-here"};</script><!-- Static head stuff --></head><body class="os-subcontent"><!-- Static body stuff --></body></html>",
224
- "headers": {
225
- "cache-control": "no-cache",
226
- "content-type": "text/html",
227
- },
228
- "statusCode": 200,
229
- }
230
- `);
231
- });
232
- });
233
-
234
- describe('makeIndexHtmlBody', () => {
235
- it('matches snapshot with maintenance message', async () => {
236
- const response = await makeIndexHtmlBody({
237
- putFileContent: jest.fn(),
238
- getSignedViewerUrl: jest.fn(),
239
- getFileContent: async () => Buffer.from(
240
- '<html><head><!-- Static head stuff --></head><body><!-- Static body stuff --></body></html>'
241
- )
242
- } as unknown as FileServerAdapter, {
243
- codeVersion: 'code-version-goes-here',
244
- maintenanceMessage: 'Down for maintenance',
245
- frontendConfig: {
246
- roleApplication: 'test',
247
- accountsBase: 'https://dev.openstax.org/accounts',
248
- exampleMessage: 'hello from /api/v0/info',
249
- }
250
- }
251
- );
252
- expect(response).toMatchInlineSnapshot(`
253
- "<html><head>
254
- <script>window._OX_FRONTEND_CONFIG = {"roleApplication":"test","accountsBase":"https://dev.openstax.org/accounts","exampleMessage":"hello from /api/v0/info","releaseId":"code-version-goes-here"};</script><!-- Static head stuff --></head><body>Down for maintenance<!-- Static body stuff --></body></html>"
255
- `);
256
- });
257
- });
258
-
259
- describe('apiV0Routes', () => {
260
- it('collects routes', () => {
261
- expect(() => apiV0Routes()).not.toThrow();
262
- });
263
- });
@@ -1,134 +0,0 @@
1
- import { ConfigForConfigProvider, ConfigValueProvider, envConfig, resolveConfigValue } from '@openstax/ts-utils/config';
2
- import { once } from '@openstax/ts-utils/misc/helpers';
3
- import { apiHtmlResponse, apiJsonResponse, METHOD, routesList } from '@openstax/ts-utils/routing';
4
- import { TokenUser } from '@openstax/ts-utils/services/authProvider';
5
- import { FileServerAdapter } from '@openstax/ts-utils/services/fileServer';
6
- import { composeServiceMiddleware, createRoute } from '../../core/services';
7
- import { apiV0ExampleRoutes } from './example/routes';
8
- import { authMiddleware } from './middleware/authMiddleware';
9
- import { getEnvironmentConfig } from './middleware/configMiddleware';
10
- import { frontendFileServerMiddleware } from './middleware/frontendFileServerMiddleware';
11
- import { roleValidatorConfig } from './middleware/userRoleValidatorMiddleware';
12
-
13
- // frontendConfig values are visible to all users
14
- const configProvider = getEnvironmentConfig({
15
- local: {
16
- codeVersion: 'dev',
17
- maintenanceMessage: envConfig('MAINTENANCE_MESSAGE', 'runtime', ''),
18
- frontendConfig: {
19
- roleApplication: roleValidatorConfig.application,
20
- accountsBase: envConfig('ACCOUNTS_BASE', 'runtime', '/accounts'),
21
- exampleMessage: envConfig('EXAMPLE_MESSAGE', 'runtime', 'hello from /api/v0/info'),
22
- },
23
- },
24
- deployed: {
25
- codeVersion: envConfig('CODE_VERSION'),
26
- maintenanceMessage: envConfig('MAINTENANCE_MESSAGE', 'runtime', ''),
27
- frontendConfig: {
28
- roleApplication: roleValidatorConfig.application,
29
- accountsBase: envConfig('ACCOUNTS_BASE', 'runtime'),
30
- exampleMessage: envConfig('EXAMPLE_MESSAGE', 'runtime', 'hello from /api/v0/info'),
31
- },
32
- },
33
- });
34
-
35
- const requestServiceProvider = composeServiceMiddleware(
36
- authMiddleware,
37
- configProvider,
38
- );
39
-
40
- type EnvironmentConfigProvider = ReturnType<ReturnType<typeof configProvider>>['environmentConfig'];
41
- export type FrontendConfigProvider = EnvironmentConfigProvider['frontendConfig'];
42
-
43
- const resolveFrontendConfig = once(async(frontendConfig: FrontendConfigProvider, codeVersion: ConfigValueProvider<string>) => {
44
- const config: Record<string, ConfigValueProvider<string>> = {};
45
-
46
- await Promise.all(Object.entries({...frontendConfig, releaseId: codeVersion}).map(
47
- async([name, value]) => config[name] = await resolveConfigValue(value)
48
- ));
49
-
50
- return config as ConfigForConfigProvider<FrontendConfigProvider>;
51
- });
52
-
53
- export const makeIndexHtmlBody = async(fileServer: FileServerAdapter, config: EnvironmentConfigProvider) => {
54
- const frontendConfig = await resolveFrontendConfig(config.frontendConfig, config.codeVersion);
55
- const maintenanceMessage = await resolveConfigValue(config.maintenanceMessage);
56
- const bodyFile = maintenanceMessage ? 'maintenance' : 'index';
57
-
58
- let body = (await fileServer.getFileContent({
59
- dataType: 'file',
60
- mimeType: 'text/html',
61
- path: `build/${bodyFile}.html`,
62
- label: `${bodyFile}.html`,
63
- })).toString();
64
-
65
- if (maintenanceMessage) {
66
- body = body.replace('<body>', `<body>${maintenanceMessage}`);
67
- }
68
-
69
- return body.replace(
70
- '<head>',
71
- `<head>
72
- <script>window._OX_FRONTEND_CONFIG = ${JSON.stringify(frontendConfig)};</script>`
73
- );
74
- };
75
-
76
- const indexHtmlBody = once(makeIndexHtmlBody);
77
-
78
- export const apiV0Index = createRoute({name: 'apiV0Info', method: METHOD.GET, path: '/api/v0/info',
79
- requestServiceProvider},
80
- async(_params: undefined, services) => {
81
- const user = await services.authProvider.getUser();
82
- const environmentConfig = services.environmentConfig;
83
- // This config is here for backwards compatibility and can eventually be removed
84
- const config = await resolveFrontendConfig(environmentConfig.frontendConfig, environmentConfig.codeVersion);
85
-
86
- return apiJsonResponse(200, {
87
- message: `greetings from the api controller${user ? ` ${user.name}`: ''}`,
88
- code: await resolveConfigValue(services.environmentConfig.codeVersion),
89
- config: config,
90
- });
91
- }
92
- );
93
-
94
- const oxUserData = (user: TokenUser, consentPreferences: { accepted?: string[]; rejected?: string[] } | undefined) => {
95
- const { uuid } = user;
96
- return JSON.stringify({ consentPreferences, uuid });
97
- };
98
-
99
- export const buildIndex = createRoute({name: 'buildIndex', method: METHOD.GET, path: '/build/index.html',
100
- requestServiceProvider: composeServiceMiddleware(
101
- requestServiceProvider,
102
- frontendFileServerMiddleware,
103
- )},
104
- async(_params: undefined, services) => {
105
- const token = await services.authProvider.getAuthToken();
106
- const user = await services.authProvider.loadUserData();
107
-
108
- // Frontend config is already included
109
- const originalBody = await indexHtmlBody(services.frontendFileServer, services.environmentConfig);
110
-
111
- // Add os-subcontent body class if subcontent queryStringParameter is set to true
112
- const bodyWithSubcontent = services.request.queryStringParameters?.subcontent === 'true' ? originalBody.replace(
113
- '<body>', '<body class="os-subcontent">'
114
- ) : originalBody;
115
-
116
- // Add _OX_USER_DATA if logged in
117
- const body = user ? bodyWithSubcontent.replace(
118
- '<head>',
119
- `<head>
120
- <script>
121
- window._OX_AUTH_TOKEN = '${token}';
122
- window._OX_USER_DATA = ${oxUserData(user, user.consent_preferences)};
123
- </script>`
124
- ): bodyWithSubcontent;
125
-
126
- return apiHtmlResponse(200, body, { 'cache-control': 'no-cache' });
127
- }
128
- );
129
-
130
- export const apiV0Routes = () => routesList([
131
- apiV0Index,
132
- buildIndex,
133
- ...apiV0ExampleRoutes(),
134
- ]);
@@ -1,23 +0,0 @@
1
- import { createCoreLogger } from '@openstax/ts-utils/services/logger';
2
- import { ApiRouteRequest, AppServices } from '../../../core';
3
- import { authMiddleware } from './authMiddleware';
4
-
5
- describe('authMiddleware', () => {
6
- it('adds request cookies to auth provider', () => {
7
- const createAuthProvider = jest.fn();
8
- const request = {headers: {}, cookies: ['one=cookieOne', 'two=cookieTwo']} as unknown as ApiRouteRequest;
9
- const logger = createCoreLogger(jest.fn());
10
- const middleware = {request, logger};
11
- authMiddleware({createAuthProvider: () => createAuthProvider} as unknown as AppServices)(middleware);
12
- expect(createAuthProvider).toHaveBeenCalledWith(expect.objectContaining({request}));
13
- });
14
-
15
- it('works if there are no cookies', () => {
16
- const createAuthProvider = jest.fn();
17
- const request = {headers: {}} as unknown as ApiRouteRequest;
18
- const logger = createCoreLogger(jest.fn());
19
- const middleware = {request, logger};
20
- authMiddleware({createAuthProvider: () => createAuthProvider} as unknown as AppServices)(middleware);
21
- expect(createAuthProvider).toHaveBeenCalledWith(expect.objectContaining({request}));
22
- });
23
- });
@@ -1,32 +0,0 @@
1
- import { envConfig, lambdaParameterConfig, replaceConfig } from '@openstax/ts-utils/config';
2
- import type { Logger } from '@openstax/ts-utils/services/logger';
3
- import { ApiRouteRequest, AppServices } from '../../../core';
4
-
5
- const config = {
6
- local: {
7
- accountsBase: 'https://dev.openstax.org/accounts',
8
- cookieName: 'oxa_dev',
9
- },
10
- deployed: {
11
- accountsBase: envConfig('ACCOUNTS_BASE', 'runtime'),
12
- cookieName: envConfig('COOKIE_NAME', 'runtime'),
13
- encryptionPrivateKey: lambdaParameterConfig(
14
- replaceConfig('/[app]/[env]/api/EncryptionPrivateKey', {
15
- '[app]': envConfig('APPLICATION'),
16
- '[env]': envConfig('ENV_NAME', 'runtime')
17
- })
18
- ),
19
- signaturePublicKey: envConfig('SIGNATURE_PUBLIC_KEY', 'runtime'),
20
- },
21
- };
22
-
23
- export const authMiddleware = ({createAuthProvider}: AppServices) => {
24
- const authProvider = createAuthProvider(config);
25
-
26
- return <M extends {request: ApiRouteRequest; logger: Logger}>(middleware: M) => {
27
- return {
28
- ...middleware,
29
- authProvider: authProvider(middleware)
30
- };
31
- };
32
- };
@@ -1,10 +0,0 @@
1
- import { getKeyValue } from '@openstax/ts-utils';
2
- import { AppServices } from '../../../core/types';
3
- import { getEnvironmentConfig } from './configMiddleware';
4
-
5
- describe('getEnvironmentConfig', () => {
6
- it('gets the environment config', () => {
7
- const result = getEnvironmentConfig({local: {test: 'local'}, deployed: {test: 'deployed'}})({getEnvironmentConfig: getKeyValue('local')} as AppServices)({});
8
- expect(result.environmentConfig.test).toBe('local');
9
- });
10
- });
@@ -1,7 +0,0 @@
1
- // TODO - if we make this even more generic so that it doesn't rely on the app specific base config type, we can move it to ts-utils/config
2
- import { AppServices, BaseEnvironmentConfig } from '../../../core/types';
3
-
4
- export const getEnvironmentConfig = <P extends BaseEnvironmentConfig>(config: P) => ({getEnvironmentConfig}: AppServices) => <M extends {}>(middleware: M) => {
5
- const environmentConfig = getEnvironmentConfig(config);
6
- return {...middleware, environmentConfig};
7
- };
@@ -1,13 +0,0 @@
1
- import { ApiRouteRequest, AppServices } from '../../../core';
2
- import { frontendFileServerMiddleware } from './frontendFileServerMiddleware';
3
-
4
- describe('frontendFileServerMiddleware', () => {
5
- it('adds frontendFileServer to middleware stack', () => {
6
- const frontendFileServer = {};
7
- const createFileServer = jest.fn().mockReturnValue(frontendFileServer);
8
- const request = {} as unknown as ApiRouteRequest;
9
- const middleware = frontendFileServerMiddleware({ createFileServer } as unknown as AppServices)({request});
10
- expect(createFileServer).toHaveBeenCalledWith(expect.objectContaining({ local: { storagePrefix: '../../frontend' } }));
11
- expect(middleware.frontendFileServer).toBe(frontendFileServer);
12
- });
13
- });
@@ -1,23 +0,0 @@
1
- import { envConfig } from '@openstax/ts-utils/config';
2
- import { ApiRouteRequest, AppServices } from '../../../core';
3
-
4
- const config = {
5
- local: {
6
- storagePrefix: '../../frontend',
7
- },
8
- deployed: {
9
- bucketName: envConfig('FRONTEND_BUILD_BUCKET', 'runtime'),
10
- bucketRegion: envConfig('AWS_REGION', 'runtime'),
11
- },
12
- };
13
-
14
- export const frontendFileServerMiddleware = ({ createFileServer }: AppServices) => {
15
- const frontendFileServer = createFileServer(config);
16
-
17
- return <M extends {request: ApiRouteRequest}>(middleware: M) => {
18
- return {
19
- ...middleware,
20
- frontendFileServer
21
- };
22
- };
23
- };
@@ -1,9 +0,0 @@
1
- import { loadMorePaginationMiddleware, pageNumberPaginationMiddleware } from './paginationMiddleware';
2
-
3
- it('is defined', () => {
4
- expect(loadMorePaginationMiddleware).toBeDefined();
5
- });
6
-
7
- it('is also defined', () => {
8
- expect(pageNumberPaginationMiddleware).toBeDefined();
9
- });
@@ -1,9 +0,0 @@
1
- import { getKeyValueOr, putKeyValue } from '@openstax/ts-utils';
2
- import { createPaginationMiddleware, loadMorePagination, pageNumberPagination } from '@openstax/ts-utils/pagination';
3
- import { ApiRouteRequest } from '../../../core';
4
-
5
- const getQueryParams = getKeyValueOr('queryStringParameters', {} as NonNullable<ApiRouteRequest['queryStringParameters']>);
6
- const setUnusedQueryParams = putKeyValue('queryStringParameters');
7
-
8
- export const loadMorePaginationMiddleware = createPaginationMiddleware<ApiRouteRequest>()({getQueryParams, setUnusedQueryParams, paginator: loadMorePagination});
9
- export const pageNumberPaginationMiddleware = createPaginationMiddleware<ApiRouteRequest>()({getQueryParams, setUnusedQueryParams, paginator: pageNumberPagination});
@@ -1,12 +0,0 @@
1
- import { AppServices } from '../../../core/types';
2
- import { searchMiddleware } from './searchMiddleware';
3
-
4
- describe('searchMiddleware', () => {
5
- it('works', async () => {
6
- const provider = {};
7
- const createSearchProvider = jest.fn().mockReturnValue(provider);
8
- const middleware = searchMiddleware({createSearchProvider} as unknown as AppServices)({});
9
- expect(middleware).toHaveProperty('createSearchProvider');
10
- expect(middleware.createSearchProvider).toBe(provider);
11
- });
12
- });
@@ -1,21 +0,0 @@
1
- import { envConfig, replaceConfig } from '@openstax/ts-utils/config';
2
- import { AppServices } from '../../../core/types';
3
-
4
- const config = {
5
- deployed: {
6
- region: envConfig('OPEN_SEARCH_REGION', 'runtime', 'us-east-1'),
7
- node: replaceConfig('https://[host]', {
8
- '[host]': envConfig('OPEN_SEARCH_HOST', 'runtime'),
9
- }),
10
- },
11
- local: { },
12
- };
13
-
14
- export const searchMiddleware = <M extends {}>(app: AppServices) => (middleware: M) => {
15
- return {
16
- ...middleware,
17
- createSearchProvider: app.createSearchProvider(config),
18
- };
19
- };
20
-
21
- export type CreateSearchProvider = ReturnType<ReturnType<typeof searchMiddleware>>['createSearchProvider'];
@@ -1,21 +0,0 @@
1
- import { stubAuthProvider } from '@openstax/ts-utils/services/authProvider';
2
- import { userRoleValidatorMiddleware } from './userRoleValidatorMiddleware';
3
-
4
- describe('userRoleValidatorMiddleware', () => {
5
- const envBack = process.env;
6
-
7
- beforeEach(() => {
8
- process.env = {...process.env};
9
- });
10
-
11
- afterEach(() => {
12
- process.env = envBack;
13
- });
14
-
15
- it('works', async () => {
16
- process.env.APPLICATION = 'test';
17
- const authProvider = stubAuthProvider(undefined);
18
- const middleware = userRoleValidatorMiddleware()({authProvider});
19
- await expect(() => middleware.roleValidator.assertUserRole(['admin'])).rejects.toThrowErrorMatchingInlineSnapshot('"UnauthorizedError"');
20
- });
21
- });
@@ -1,18 +0,0 @@
1
- import { envConfig } from '@openstax/ts-utils/config';
2
- import { AuthProvider } from '@openstax/ts-utils/services/authProvider';
3
- import { createUserRoleValidator } from '@openstax/ts-utils/services/authProvider/utils/userRoleValidator';
4
-
5
- const config = {
6
- application: envConfig('APPLICATION')
7
- };
8
-
9
- export const roleValidatorConfig = config;
10
-
11
- export const userRoleValidatorMiddleware = () => {
12
- return <M extends {authProvider: AuthProvider}>(middleware: M) => {
13
- return {
14
- ...middleware,
15
- roleValidator: createUserRoleValidator(middleware.authProvider, config),
16
- };
17
- };
18
- };
@@ -1,30 +0,0 @@
1
- {
2
- "compilerOptions": {
3
- "incremental": true,
4
- "allowJs": false,
5
- "allowSyntheticDefaultImports": true,
6
- "alwaysStrict": true,
7
- "esModuleInterop": true,
8
- "forceConsistentCasingInFileNames": true,
9
- "isolatedModules": true,
10
- "module": "commonjs",
11
- "moduleResolution": "node",
12
- "noEmit": true,
13
- "noImplicitAny": true,
14
- "listEmittedFiles": true,
15
- "noUnusedLocals": true,
16
- "noUnusedParameters": true,
17
- "resolveJsonModule": true,
18
- "skipLibCheck": true,
19
- "strict": true,
20
- "target": "es2019",
21
- "lib": [
22
- "es2020"
23
- ],
24
- "noFallthroughCasesInSwitch": true
25
- },
26
- "include": [
27
- "src",
28
- "script"
29
- ]
30
- }