@openstax/ts-utils 1.34.0 → 1.35.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (507) 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 +69 -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 +162 -0
  126. package/dist/cjs/services/searchProvider/streamIndexer.d.ts +17 -0
  127. package/dist/cjs/services/searchProvider/streamIndexer.js +41 -0
  128. package/dist/cjs/tsconfig.without-specs.cjs.tsbuildinfo +1 -0
  129. package/{packages/utils/src/types.ts → dist/cjs/types.d.ts} +6 -34
  130. package/dist/cjs/types.js +2 -0
  131. package/dist/esm/assertions/index.d.ts +89 -0
  132. package/{packages/utils/src/assertions/index.ts → dist/esm/assertions/index.js} +49 -64
  133. package/dist/esm/aws/ssmService.d.ts +5 -0
  134. package/dist/esm/aws/ssmService.js +6 -0
  135. package/dist/esm/config/awsParameterConfig.d.ts +10 -0
  136. package/dist/esm/config/awsParameterConfig.js +22 -0
  137. package/dist/esm/config/envConfig.d.ts +24 -0
  138. package/dist/esm/config/envConfig.js +53 -0
  139. package/dist/esm/config/index.d.ts +48 -0
  140. package/dist/esm/config/index.js +17 -0
  141. package/dist/esm/config/lambdaParameterConfig.d.ts +12 -0
  142. package/dist/esm/config/lambdaParameterConfig.js +38 -0
  143. package/dist/esm/config/replaceConfig.d.ts +14 -0
  144. package/{packages/utils/src/config/replaceConfig.ts → dist/esm/config/replaceConfig.js} +6 -16
  145. package/dist/esm/config/resolveConfigValue.d.ts +5 -0
  146. package/dist/esm/config/resolveConfigValue.js +8 -0
  147. package/dist/esm/errors/index.d.ts +88 -0
  148. package/{packages/utils/src/errors/index.ts → dist/esm/errors/index.js} +41 -57
  149. package/dist/esm/fetch/fetchStatusRetry.d.ts +8 -0
  150. package/dist/esm/fetch/fetchStatusRetry.js +23 -0
  151. package/dist/esm/fetch/index.d.ts +64 -0
  152. package/dist/esm/fetch/index.js +46 -0
  153. package/dist/esm/guards/index.d.ts +38 -0
  154. package/dist/esm/guards/index.js +36 -0
  155. package/dist/esm/index.d.ts +4 -0
  156. package/dist/esm/index.js +4 -0
  157. package/dist/esm/middleware/apiErrorHandler.d.ts +24 -0
  158. package/dist/esm/middleware/apiErrorHandler.js +38 -0
  159. package/dist/esm/middleware/apiSlowResponseMiddleware.d.ts +23 -0
  160. package/dist/esm/middleware/apiSlowResponseMiddleware.js +50 -0
  161. package/dist/esm/middleware/index.d.ts +47 -0
  162. package/dist/esm/middleware/index.js +44 -0
  163. package/dist/esm/middleware/lambdaCorsResponseMiddleware.d.ts +20 -0
  164. package/dist/esm/middleware/lambdaCorsResponseMiddleware.js +40 -0
  165. package/dist/esm/middleware/throwNotFoundMiddleware.d.ts +4 -0
  166. package/dist/esm/middleware/throwNotFoundMiddleware.js +10 -0
  167. package/dist/esm/misc/hashValue.d.ts +10 -0
  168. package/dist/esm/misc/hashValue.js +13 -0
  169. package/dist/esm/misc/helpers.d.ts +124 -0
  170. package/dist/esm/misc/helpers.js +199 -0
  171. package/dist/esm/misc/merge.d.ts +21 -0
  172. package/dist/esm/misc/merge.js +40 -0
  173. package/dist/esm/misc/partitionSequence.d.ts +35 -0
  174. package/{packages/utils/src/misc/partitionSequence.ts → dist/esm/misc/partitionSequence.js} +15 -23
  175. package/dist/esm/pagination/index.d.ts +91 -0
  176. package/dist/esm/pagination/index.js +77 -0
  177. package/dist/esm/routing/helpers.d.ts +57 -0
  178. package/{packages/utils/src/routing/helpers.ts → dist/esm/routing/helpers.js} +30 -42
  179. package/dist/esm/routing/index.d.ts +290 -0
  180. package/dist/esm/routing/index.js +246 -0
  181. package/dist/esm/routing/validators/zod.d.ts +4 -0
  182. package/dist/esm/routing/validators/zod.js +10 -0
  183. package/dist/esm/services/accountsGateway/index.d.ts +92 -0
  184. package/dist/esm/services/accountsGateway/index.js +131 -0
  185. package/dist/esm/services/apiGateway/index.d.ts +68 -0
  186. package/dist/esm/services/apiGateway/index.js +77 -0
  187. package/dist/esm/services/authProvider/browser.d.ts +40 -0
  188. package/dist/esm/services/authProvider/browser.js +151 -0
  189. package/dist/esm/services/authProvider/decryption.d.ts +19 -0
  190. package/dist/esm/services/authProvider/decryption.js +69 -0
  191. package/dist/esm/services/authProvider/index.d.ts +63 -0
  192. package/dist/esm/services/authProvider/index.js +26 -0
  193. package/dist/esm/services/authProvider/subrequest.d.ts +13 -0
  194. package/dist/esm/services/authProvider/subrequest.js +45 -0
  195. package/dist/esm/services/authProvider/utils/decryptAndVerify.d.ts +28 -0
  196. package/dist/esm/services/authProvider/utils/decryptAndVerify.js +85 -0
  197. package/dist/esm/services/authProvider/utils/embeddedAuthProvider.d.ts +26 -0
  198. package/dist/esm/services/authProvider/utils/embeddedAuthProvider.js +40 -0
  199. package/dist/esm/services/authProvider/utils/userRoleValidator.d.ts +13 -0
  200. package/dist/esm/services/authProvider/utils/userRoleValidator.js +33 -0
  201. package/dist/esm/services/authProvider/utils/userSubrequest.d.ts +3 -0
  202. package/dist/esm/services/authProvider/utils/userSubrequest.js +6 -0
  203. package/dist/esm/services/documentStore/dynamoEncoding.d.ts +10 -0
  204. package/dist/esm/services/documentStore/dynamoEncoding.js +45 -0
  205. package/dist/esm/services/documentStore/fileSystemAssert.d.ts +1 -0
  206. package/dist/esm/services/documentStore/fileSystemAssert.js +10 -0
  207. package/dist/esm/services/documentStore/index.d.ts +14 -0
  208. package/dist/esm/services/documentStore/index.js +1 -0
  209. package/dist/esm/services/documentStore/unversioned/dynamodb.d.ts +31 -0
  210. package/dist/esm/services/documentStore/unversioned/dynamodb.js +226 -0
  211. package/dist/esm/services/documentStore/unversioned/file-system.d.ts +32 -0
  212. package/dist/esm/services/documentStore/unversioned/file-system.js +174 -0
  213. package/dist/esm/services/documentStore/unversioned/index.d.ts +2 -0
  214. package/dist/esm/services/documentStore/unversioned/index.js +1 -0
  215. package/dist/esm/services/documentStore/versioned/dynamodb.d.ts +25 -0
  216. package/dist/esm/services/documentStore/versioned/dynamodb.js +139 -0
  217. package/dist/esm/services/documentStore/versioned/file-system.d.ts +25 -0
  218. package/dist/esm/services/documentStore/versioned/file-system.js +69 -0
  219. package/dist/esm/services/documentStore/versioned/index.d.ts +17 -0
  220. package/dist/esm/services/documentStore/versioned/index.js +1 -0
  221. package/dist/esm/services/exercisesGateway/index.d.ts +67 -0
  222. package/dist/esm/services/exercisesGateway/index.js +70 -0
  223. package/dist/esm/services/fileServer/index.d.ts +30 -0
  224. package/dist/esm/services/fileServer/index.js +13 -0
  225. package/dist/esm/services/fileServer/localFileServer.d.ts +13 -0
  226. package/dist/esm/services/fileServer/localFileServer.js +125 -0
  227. package/dist/esm/services/fileServer/s3FileServer.d.ts +14 -0
  228. package/dist/esm/services/fileServer/s3FileServer.js +124 -0
  229. package/dist/esm/services/launchParams/index.d.ts +2 -0
  230. package/dist/esm/services/launchParams/index.js +2 -0
  231. package/dist/esm/services/launchParams/signer.d.ts +23 -0
  232. package/dist/esm/services/launchParams/signer.js +51 -0
  233. package/dist/esm/services/launchParams/verifier.d.ts +21 -0
  234. package/dist/esm/services/launchParams/verifier.js +92 -0
  235. package/dist/esm/services/logger/console.d.ts +4 -0
  236. package/{packages/utils/src/services/logger/console.ts → dist/esm/services/logger/console.js} +2 -5
  237. package/dist/esm/services/logger/index.d.ts +39 -0
  238. package/dist/esm/services/logger/index.js +27 -0
  239. package/dist/esm/services/lrsGateway/addStatementDefaultFields.d.ts +5 -0
  240. package/dist/esm/services/lrsGateway/addStatementDefaultFields.js +14 -0
  241. package/dist/esm/services/lrsGateway/attempt-utils.d.ts +72 -0
  242. package/dist/esm/services/lrsGateway/attempt-utils.js +261 -0
  243. package/dist/esm/services/lrsGateway/file-system.d.ts +15 -0
  244. package/dist/esm/services/lrsGateway/file-system.js +110 -0
  245. package/dist/esm/services/lrsGateway/index.d.ts +122 -0
  246. package/dist/esm/services/lrsGateway/index.js +111 -0
  247. package/dist/esm/services/lrsGateway/xapiUtils.d.ts +71 -0
  248. package/dist/esm/services/lrsGateway/xapiUtils.js +134 -0
  249. package/dist/esm/services/postgresConnection/index.d.ts +28 -0
  250. package/dist/esm/services/postgresConnection/index.js +58 -0
  251. package/dist/esm/services/searchProvider/index.d.ts +69 -0
  252. package/dist/esm/services/searchProvider/index.js +1 -0
  253. package/dist/esm/services/searchProvider/memorySearchTheBadWay.d.ts +20 -0
  254. package/dist/esm/services/searchProvider/memorySearchTheBadWay.js +187 -0
  255. package/dist/esm/services/searchProvider/openSearch.d.ts +28 -0
  256. package/dist/esm/services/searchProvider/openSearch.js +158 -0
  257. package/dist/esm/services/searchProvider/streamIndexer.d.ts +17 -0
  258. package/dist/esm/services/searchProvider/streamIndexer.js +37 -0
  259. package/dist/esm/tsconfig.without-specs.esm.tsbuildinfo +1 -0
  260. package/dist/esm/types.d.ts +31 -0
  261. package/dist/esm/types.js +1 -0
  262. package/package.json +234 -12
  263. package/.cfnlintrc +0 -2
  264. package/.github/CODEOWNERS +0 -1
  265. package/.github/workflows/ci.yml +0 -36
  266. package/.github/workflows/lint.yml +0 -55
  267. package/.nvmrc +0 -1
  268. package/.syncignore +0 -4
  269. package/.syncpackrc +0 -18
  270. package/CONTRIBUTING.md +0 -96
  271. package/LICENSE +0 -661
  272. package/Procfile +0 -1
  273. package/app.json +0 -23
  274. package/cspell.json +0 -32
  275. package/deploy/constants.env +0 -21
  276. package/deploy/deploy.bash +0 -157
  277. package/deploy/deployment-alt-region.cfn.yml +0 -70
  278. package/deploy/deployment.cfn.yml +0 -650
  279. package/deploy/destroy-deployment.bash +0 -23
  280. package/deploy/shared.cfn.yml +0 -94
  281. package/docs/lambda-build.md +0 -35
  282. package/packages/frontend/README.md +0 -46
  283. package/packages/frontend/package.json +0 -101
  284. package/packages/frontend/public/favicon.ico +0 -0
  285. package/packages/frontend/public/index.html +0 -107
  286. package/packages/frontend/public/maintenance.html +0 -59
  287. package/packages/frontend/public/manifest.json +0 -15
  288. package/packages/frontend/public/robots.txt +0 -3
  289. package/packages/frontend/script/make-certificate.bash +0 -49
  290. package/packages/frontend/script/server/cli.js +0 -11
  291. package/packages/frontend/script/server/index.js +0 -47
  292. package/packages/frontend/script/start.bash +0 -22
  293. package/packages/frontend/script/trust-localhost.bash +0 -7
  294. package/packages/frontend/src/auth/authProvider.ts +0 -10
  295. package/packages/frontend/src/auth/useAuth.ts +0 -33
  296. package/packages/frontend/src/components/Pagination.tsx +0 -26
  297. package/packages/frontend/src/configProvider/index.ts +0 -53
  298. package/packages/frontend/src/configProvider/use.ts +0 -41
  299. package/packages/frontend/src/core/context/services.spec.tsx +0 -39
  300. package/packages/frontend/src/core/context/services.tsx +0 -16
  301. package/packages/frontend/src/core/index.spec.ts +0 -7
  302. package/packages/frontend/src/core/index.ts +0 -20
  303. package/packages/frontend/src/core/services.tsx +0 -14
  304. package/packages/frontend/src/core/types.ts +0 -3
  305. package/packages/frontend/src/example/api.ts +0 -28
  306. package/packages/frontend/src/example/components/Layout.tsx +0 -23
  307. package/packages/frontend/src/example/screens/Home.spec.tsx +0 -68
  308. package/packages/frontend/src/example/screens/Home.tsx +0 -78
  309. package/packages/frontend/src/example/screens/ThingList.spec.tsx +0 -60
  310. package/packages/frontend/src/example/screens/ThingList.tsx +0 -75
  311. package/packages/frontend/src/example/screens/ThingView.spec.tsx +0 -71
  312. package/packages/frontend/src/example/screens/ThingView.tsx +0 -47
  313. package/packages/frontend/src/example/screens/index.ts +0 -9
  314. package/packages/frontend/src/index.css +0 -159
  315. package/packages/frontend/src/index.tsx +0 -67
  316. package/packages/frontend/src/react-app-env.d.ts +0 -1
  317. package/packages/frontend/src/routing/components/RouteLink.spec.tsx +0 -55
  318. package/packages/frontend/src/routing/components/RouteLink.tsx +0 -35
  319. package/packages/frontend/src/routing/middleware.ts +0 -6
  320. package/packages/frontend/src/routing/useQuery.ts +0 -14
  321. package/packages/frontend/src/setupProxy.js +0 -19
  322. package/packages/frontend/src/setupTests.ts +0 -9
  323. package/packages/frontend/src/tests/testServices.tsx +0 -23
  324. package/packages/frontend/tsconfig.json +0 -27
  325. package/packages/lambda/.eslintrc.js +0 -64
  326. package/packages/lambda/jest-global-setup.js +0 -3
  327. package/packages/lambda/jest-setup-after-env.js +0 -1
  328. package/packages/lambda/jest.config.js +0 -31
  329. package/packages/lambda/jest.resolver.js +0 -17
  330. package/packages/lambda/package.json +0 -68
  331. package/packages/lambda/script/build.bash +0 -19
  332. package/packages/lambda/script/bundle-functions.bash +0 -10
  333. package/packages/lambda/script/lambdaLocalProxy.js +0 -16
  334. package/packages/lambda/script/lambdaLocalProxy.spec.ts +0 -147
  335. package/packages/lambda/script/utils/getRouteData.ts +0 -7
  336. package/packages/lambda/script/utils/routeDataLoader.js +0 -8
  337. package/packages/lambda/script/utils/routeDataLoader.spec.ts +0 -8
  338. package/packages/lambda/src/functions/serviceApi/core/index.ts +0 -7
  339. package/packages/lambda/src/functions/serviceApi/core/request.spec.ts +0 -38
  340. package/packages/lambda/src/functions/serviceApi/core/request.ts +0 -42
  341. package/packages/lambda/src/functions/serviceApi/core/routes.spec.ts +0 -7
  342. package/packages/lambda/src/functions/serviceApi/core/routes.ts +0 -10
  343. package/packages/lambda/src/functions/serviceApi/core/services.ts +0 -9
  344. package/packages/lambda/src/functions/serviceApi/core/types.ts +0 -13
  345. package/packages/lambda/src/functions/serviceApi/entry/lambda/https-xray.ts +0 -4
  346. package/packages/lambda/src/functions/serviceApi/entry/lambda/index.spec.ts +0 -48
  347. package/packages/lambda/src/functions/serviceApi/entry/lambda/index.ts +0 -58
  348. package/packages/lambda/src/functions/serviceApi/entry/lambda/services.ts +0 -36
  349. package/packages/lambda/src/functions/serviceApi/entry/local.ts +0 -71
  350. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentSearchMiddleware.spec.ts +0 -16
  351. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentSearchMiddleware.ts +0 -41
  352. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentStoreMiddleware.spec.ts +0 -78
  353. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentStoreMiddleware.ts +0 -70
  354. package/packages/lambda/src/functions/serviceApi/versions/v0/example/routes.spec.ts +0 -306
  355. package/packages/lambda/src/functions/serviceApi/versions/v0/example/routes.ts +0 -176
  356. package/packages/lambda/src/functions/serviceApi/versions/v0/index.spec.ts +0 -263
  357. package/packages/lambda/src/functions/serviceApi/versions/v0/index.ts +0 -134
  358. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/authMiddleware.spec.ts +0 -23
  359. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/authMiddleware.ts +0 -32
  360. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/configMiddleware.spec.ts +0 -10
  361. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/configMiddleware.ts +0 -7
  362. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/frontendFileServerMiddleware.spec.ts +0 -13
  363. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/frontendFileServerMiddleware.ts +0 -23
  364. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/paginationMiddleware.spec.ts +0 -9
  365. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/paginationMiddleware.ts +0 -9
  366. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/searchMiddleware.spec.ts +0 -12
  367. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/searchMiddleware.ts +0 -21
  368. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/userRoleValidatorMiddleware.spec.ts +0 -21
  369. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/userRoleValidatorMiddleware.ts +0 -18
  370. package/packages/lambda/tsconfig.json +0 -30
  371. package/packages/lambda/webpack.config.js +0 -97
  372. package/packages/utils/.eslintrc.js +0 -64
  373. package/packages/utils/README.md +0 -118
  374. package/packages/utils/jest-global-setup.js +0 -3
  375. package/packages/utils/jest.config.js +0 -25
  376. package/packages/utils/jest.resolver.js +0 -17
  377. package/packages/utils/package.json +0 -238
  378. package/packages/utils/src/assertions/index.spec.ts +0 -126
  379. package/packages/utils/src/aws/ssmService.ts +0 -7
  380. package/packages/utils/src/config/awsParameterConfig.ts +0 -24
  381. package/packages/utils/src/config/envConfig.ts +0 -58
  382. package/packages/utils/src/config/index.spec.ts +0 -165
  383. package/packages/utils/src/config/lambdaParameterConfig.ts +0 -49
  384. package/packages/utils/src/config/resolveConfigValue.ts +0 -10
  385. package/packages/utils/src/errors/index.spec.ts +0 -35
  386. package/packages/utils/src/fetch/fetchStatusRetry.spec.ts +0 -197
  387. package/packages/utils/src/fetch/fetchStatusRetry.ts +0 -33
  388. package/packages/utils/src/fetch/index.spec.ts +0 -34
  389. package/packages/utils/src/fetch/index.ts +0 -87
  390. package/packages/utils/src/guards/index.spec.ts +0 -58
  391. package/packages/utils/src/index.spec.ts +0 -471
  392. package/packages/utils/src/middleware/apiErrorHandler.spec.ts +0 -65
  393. package/packages/utils/src/middleware/apiErrorHandler.ts +0 -67
  394. package/packages/utils/src/middleware/apiSlowResponseMiddleware.spec.ts +0 -184
  395. package/packages/utils/src/middleware/apiSlowResponseMiddleware.ts +0 -71
  396. package/packages/utils/src/middleware/index.spec.ts +0 -99
  397. package/packages/utils/src/middleware/lambdaCorsResponseMiddleware.spec.ts +0 -103
  398. package/packages/utils/src/middleware/lambdaCorsResponseMiddleware.ts +0 -52
  399. package/packages/utils/src/middleware/throwNotFoundMiddleware.spec.ts +0 -20
  400. package/packages/utils/src/middleware/throwNotFoundMiddleware.ts +0 -11
  401. package/packages/utils/src/misc/hashValue.ts +0 -18
  402. package/packages/utils/src/misc/helpers.ts +0 -259
  403. package/packages/utils/src/misc/merge.ts +0 -48
  404. package/packages/utils/src/pagination/index.spec.ts +0 -150
  405. package/packages/utils/src/pagination/index.ts +0 -117
  406. package/packages/utils/src/routing/index.spec.ts +0 -553
  407. package/packages/utils/src/routing/index.ts +0 -424
  408. package/packages/utils/src/routing/validators/zod.spec.ts +0 -16
  409. package/packages/utils/src/routing/validators/zod.ts +0 -14
  410. package/packages/utils/src/services/accountsGateway/README.md +0 -3
  411. package/packages/utils/src/services/accountsGateway/index.spec.ts +0 -518
  412. package/packages/utils/src/services/accountsGateway/index.ts +0 -251
  413. package/packages/utils/src/services/apiGateway/README.md +0 -93
  414. package/packages/utils/src/services/apiGateway/index.spec.ts +0 -254
  415. package/packages/utils/src/services/apiGateway/index.ts +0 -189
  416. package/packages/utils/src/services/authProvider/README.md +0 -21
  417. package/packages/utils/src/services/authProvider/browser.spec.ts +0 -391
  418. package/packages/utils/src/services/authProvider/browser.ts +0 -209
  419. package/packages/utils/src/services/authProvider/decryption.spec.ts +0 -337
  420. package/packages/utils/src/services/authProvider/decryption.ts +0 -98
  421. package/packages/utils/src/services/authProvider/index.ts +0 -93
  422. package/packages/utils/src/services/authProvider/stub.spec.ts +0 -29
  423. package/packages/utils/src/services/authProvider/subrequest.spec.ts +0 -105
  424. package/packages/utils/src/services/authProvider/subrequest.ts +0 -68
  425. package/packages/utils/src/services/authProvider/utils/decryptAndVerify.spec.ts +0 -128
  426. package/packages/utils/src/services/authProvider/utils/decryptAndVerify.ts +0 -106
  427. package/packages/utils/src/services/authProvider/utils/embeddedAuthProvider.spec.ts +0 -26
  428. package/packages/utils/src/services/authProvider/utils/embeddedAuthProvider.ts +0 -57
  429. package/packages/utils/src/services/authProvider/utils/userRoleValidator.spec.ts +0 -135
  430. package/packages/utils/src/services/authProvider/utils/userRoleValidator.ts +0 -49
  431. package/packages/utils/src/services/authProvider/utils/userSubrequest.spec.ts +0 -26
  432. package/packages/utils/src/services/authProvider/utils/userSubrequest.ts +0 -10
  433. package/packages/utils/src/services/documentStore/dynamoEncoding.ts +0 -57
  434. package/packages/utils/src/services/documentStore/fileSystemAssert.spec.ts +0 -43
  435. package/packages/utils/src/services/documentStore/fileSystemAssert.ts +0 -10
  436. package/packages/utils/src/services/documentStore/unversioned/README.md +0 -13
  437. package/packages/utils/src/services/documentStore/unversioned/dynamodb.spec.ts +0 -859
  438. package/packages/utils/src/services/documentStore/unversioned/dynamodb.ts +0 -243
  439. package/packages/utils/src/services/documentStore/unversioned/file-system.spec.ts +0 -629
  440. package/packages/utils/src/services/documentStore/unversioned/file-system.ts +0 -194
  441. package/packages/utils/src/services/documentStore/versioned/README.md +0 -13
  442. package/packages/utils/src/services/documentStore/versioned/dynamodb.spec.ts +0 -376
  443. package/packages/utils/src/services/documentStore/versioned/dynamodb.ts +0 -167
  444. package/packages/utils/src/services/documentStore/versioned/file-system.spec.ts +0 -262
  445. package/packages/utils/src/services/documentStore/versioned/file-system.ts +0 -90
  446. package/packages/utils/src/services/documentStore/versioned/index.ts +0 -25
  447. package/packages/utils/src/services/exercisesGateway/README.md +0 -5
  448. package/packages/utils/src/services/exercisesGateway/index.spec.ts +0 -326
  449. package/packages/utils/src/services/exercisesGateway/index.ts +0 -163
  450. package/packages/utils/src/services/fileServer/index.spec.ts +0 -88
  451. package/packages/utils/src/services/fileServer/index.ts +0 -43
  452. package/packages/utils/src/services/fileServer/localFileServer.spec.ts +0 -182
  453. package/packages/utils/src/services/fileServer/localFileServer.ts +0 -159
  454. package/packages/utils/src/services/fileServer/s3FileServer.spec.ts +0 -266
  455. package/packages/utils/src/services/fileServer/s3FileServer.ts +0 -155
  456. package/packages/utils/src/services/launchParams/index.spec.ts +0 -366
  457. package/packages/utils/src/services/launchParams/signer.ts +0 -73
  458. package/packages/utils/src/services/launchParams/verifier.ts +0 -120
  459. package/packages/utils/src/services/logger/console.spec.ts +0 -29
  460. package/packages/utils/src/services/logger/index.spec.ts +0 -65
  461. package/packages/utils/src/services/lrsGateway/README.md +0 -5
  462. package/packages/utils/src/services/lrsGateway/addStatementDefaultFields.ts +0 -22
  463. package/packages/utils/src/services/lrsGateway/attempt-utils.spec.ts +0 -847
  464. package/packages/utils/src/services/lrsGateway/attempt-utils.ts +0 -358
  465. package/packages/utils/src/services/lrsGateway/file-system.spec.ts +0 -363
  466. package/packages/utils/src/services/lrsGateway/file-system.ts +0 -165
  467. package/packages/utils/src/services/lrsGateway/index.spec.ts +0 -194
  468. package/packages/utils/src/services/lrsGateway/index.ts +0 -257
  469. package/packages/utils/src/services/lrsGateway/xapiUtils.spec.ts +0 -887
  470. package/packages/utils/src/services/lrsGateway/xapiUtils.ts +0 -262
  471. package/packages/utils/src/services/postgresConnection/index.spec.ts +0 -170
  472. package/packages/utils/src/services/postgresConnection/index.ts +0 -84
  473. package/packages/utils/src/services/searchProvider/README.md +0 -3
  474. package/packages/utils/src/services/searchProvider/index.ts +0 -59
  475. package/packages/utils/src/services/searchProvider/memorySearchTheBadWay.spec.ts +0 -526
  476. package/packages/utils/src/services/searchProvider/memorySearchTheBadWay.ts +0 -223
  477. package/packages/utils/src/services/searchProvider/openSearch.spec.ts +0 -926
  478. package/packages/utils/src/services/searchProvider/openSearch.ts +0 -195
  479. package/packages/utils/tsconfig.json +0 -31
  480. package/packages/utils/tsconfig.without-specs.cjs.json +0 -7
  481. package/packages/utils/tsconfig.without-specs.esm.json +0 -7
  482. package/packages/utils/tsconfig.without-specs.json +0 -6
  483. package/scripts/build.bash +0 -24
  484. package/scripts/ci.bash +0 -10
  485. package/scripts/start.bash +0 -29
  486. /package/{packages/utils/src/index.ts → dist/cjs/index.d.ts} +0 -0
  487. /package/{packages/utils/src/services/launchParams/index.ts → dist/cjs/services/launchParams/index.d.ts} +0 -0
  488. /package/{packages/utils/script → script}/bin/copy-from-template.bash +0 -0
  489. /package/{packages/utils/script → script}/bin/delete-stack.bash +0 -0
  490. /package/{packages/utils/script → script}/bin/deploy.bash +0 -0
  491. /package/{packages/utils/script → script}/bin/destroy-deployment.bash +0 -0
  492. /package/{packages/utils/script → script}/bin/empty-bucket.bash +0 -0
  493. /package/{packages/utils/script → script}/bin/get-arg.bash +0 -0
  494. /package/{packages/utils/script → script}/bin/get-deployed-environments.bash +0 -0
  495. /package/{packages/utils/script → script}/bin/get-env-param.bash +0 -0
  496. /package/{packages/utils/script → script}/bin/get-kwarg.bash +0 -0
  497. /package/{packages/utils/script → script}/bin/get-stack-param.bash +0 -0
  498. /package/{packages/utils/script → script}/bin/has-flag.bash +0 -0
  499. /package/{packages/utils/script → script}/bin/init-constants-script.bash +0 -0
  500. /package/{packages/utils/script → script}/bin/init-params-script.bash +0 -0
  501. /package/{packages/utils/script → script}/bin/stack-exists.bash +0 -0
  502. /package/{packages/utils/script → script}/bin/update-utils.bash +0 -0
  503. /package/{packages/utils/script → script}/bin/upload-pager-duty-endpoints.bash +0 -0
  504. /package/{packages/utils/script → script}/bin/upload-params.bash +0 -0
  505. /package/{packages/utils/script → script}/bin/which.bash +0 -0
  506. /package/{packages/utils/script → script}/bin-entry.bash +0 -0
  507. /package/{packages/utils/script → script}/build.bash +0 -0
@@ -1,189 +0,0 @@
1
- import { Headers } from 'node-fetch';
2
- import * as pathToRegexp from 'path-to-regexp';
3
- import queryString from 'query-string';
4
- import { v4 as uuid } from 'uuid';
5
- import { merge } from '../..';
6
- import { ConfigProviderForConfig, resolveConfigValue } from '../../config';
7
- import { SessionExpiredError, UnauthorizedError } from '../../errors';
8
- import { ConfigForFetch, GenericFetch, Response } from '../../fetch';
9
- import { fetchStatusRetry } from '../../fetch/fetchStatusRetry';
10
- import { AnyRoute, ApiResponse, METHOD, OutputForRoute, ParamsForRoute, PayloadForRoute, QueryParams, RouteParams } from '../../routing';
11
- import { UnwrapPromise } from '../../types';
12
- import { Level, Logger } from '../logger';
13
-
14
- export type TResponsePayload<R> = R extends ApiResponse<any, infer P> ? P : never;
15
- export type TResponseStatus<R> = R extends ApiResponse<infer S, any> ? S : never;
16
-
17
- export type RouteClient<R> = {
18
- (
19
- config: { fetchConfig?: any; query?: QueryParams }
20
- & (
21
- ParamsForRoute<R> extends undefined
22
- ? {}
23
- : { params: ParamsForRoute<R> }
24
- )
25
- & (
26
- PayloadForRoute<R> extends undefined
27
- ? {}
28
- : { payload: PayloadForRoute<R> }
29
- )
30
- ): Promise<UnsafeApiClientResponse<UnwrapPromise<OutputForRoute<R>>>>;
31
- renderUrl: (
32
- config: { query?: QueryParams }
33
- & (
34
- ParamsForRoute<R> extends undefined
35
- ? {}
36
- : { params: ParamsForRoute<R> }
37
- )
38
- ) => Promise<string>;
39
- };
40
-
41
- export interface AcceptStatus<Ro> {
42
- <S extends TResponseStatus<Ro>[]>(...args: S): Promise<ApiClientResponse<Extract<Ro, Record<'statusCode', S[number]>>>>;
43
- <S extends number[]>(...args: S): Promise<ApiClientResponse<any>>;
44
- }
45
-
46
- export type UnsafeApiClientResponse<Ro> = {
47
- headers: Headers;
48
- load: () => Promise<any>;
49
- status: number;
50
- acceptStatus: AcceptStatus<Ro>;
51
- };
52
-
53
- export type ApiClientResponse<Ro> = Ro extends any ? {
54
- headers: Headers;
55
- status: TResponseStatus<Ro>;
56
- load: () => Promise<TResponsePayload<Ro>>;
57
- } : never;
58
-
59
- export type ExpandRoute<T> = T extends ((...args: infer A) => infer R) & { renderUrl: (...args: infer Ar) => Promise<string> } ? ((...args: A) => R) & { renderUrl: (...args: Ar) => Promise<string> } : never;
60
-
61
- export type MapRoutesToClient<Ru> = [Ru] extends [AnyRoute<Ru>]
62
- ? { [N in Ru['name']]: ExpandRoute<RouteClient<Extract<Ru, Record<'name', N>>>> }
63
- : never;
64
-
65
- export type MapRoutesToConfig<Ru> = [Ru] extends [AnyRoute<Ru>]
66
- ? { [_N in Ru['name']]: {
67
- path: string;
68
- method: string;
69
- } }
70
- : never;
71
-
72
- /** Pulls the content out of a response based on the content type */
73
- export const loadResponse = (response: Response) => () => {
74
- const [contentType] = (response.headers.get('content-type') || '').split(';');
75
- switch (contentType) {
76
- case 'text/plain':
77
- return response.text();
78
- case 'application/json':
79
- return response.json();
80
- default:
81
- throw new Error(`unknown content type ${contentType}`);
82
- }
83
- };
84
-
85
- const makeRouteClient = <F extends GenericFetch>(
86
- initializer: {
87
- fetch: F;
88
- },
89
- config: ConfigProviderForConfig<{
90
- apiBase: string;
91
- }>,
92
- route: { path: string; method: METHOD },
93
- app?: {
94
- authProvider?: { getAuthorizedFetchConfig: () => Promise<ConfigForFetch<F>> };
95
- logger?: Logger;
96
- launchToken?: string;
97
- }
98
- ) => {
99
- /* TODO this duplicates code with makeRenderRouteUrl, reuse that */
100
- const renderUrl = async ({ params, query }: { params?: RouteParams; query?: QueryParams }) => {
101
- const apiBase = await resolveConfigValue(config.apiBase);
102
- const getPathForParams = pathToRegexp.compile(route.path, { encode: encodeURIComponent });
103
- const search = query && queryString.stringify(query);
104
- return apiBase.replace(/\/+$/, '') + getPathForParams(params || {}) + (search ? `?${search}` : '');
105
- };
106
-
107
- const routeClient = async ({ params, payload, query, fetchConfig }: { params?: RouteParams; payload?: any; query?: QueryParams; fetchConfig?: ConfigForFetch<F> }) => {
108
- const { fetch } = initializer;
109
-
110
- const url = await renderUrl({ params, query });
111
- const body = payload ? JSON.stringify(payload) : undefined;
112
- const baseOptions = merge((await app?.authProvider?.getAuthorizedFetchConfig()) || {}, fetchConfig || {});
113
- const requestId = uuid();
114
- const requestLogger = app?.logger?.createSubContext();
115
- requestLogger?.setContext({ requestId, url, timeStamp: new Date().getTime() });
116
- const fetcher = fetchStatusRetry(fetch, { retries: 1, status: [502], logger: requestLogger });
117
-
118
- requestLogger?.log('Request Initiated', Level.Info);
119
-
120
- return fetcher(url, merge(baseOptions, {
121
- method: route.method,
122
- body,
123
- headers: {
124
- ...fetchConfig?.headers,
125
- ...(body ? { 'content-type': 'application/json' } : {}),
126
- 'x-request-id': requestId,
127
- ...(app?.launchToken ? {
128
- 'x-launch-token': app.launchToken,
129
- } : {}),
130
- }
131
- })).then(
132
- response => {
133
- if (response.status === 401) {
134
- throw new UnauthorizedError();
135
- }
136
- if (response.status === 440) {
137
- throw new SessionExpiredError();
138
- }
139
-
140
- return {
141
- status: response.status,
142
- acceptStatus: async (...status: number[]) => {
143
- if (!status.includes(response.status)) {
144
- throw new Error(`unexpected HTTP ${response.status} response from api: ${await response.text()}`);
145
- }
146
-
147
- return { status: response.status, headers: response.headers, load: loadResponse(response) };
148
- },
149
- headers: response.headers,
150
- load: loadResponse(response),
151
- };
152
- }
153
- );
154
- };
155
-
156
- routeClient.renderUrl = renderUrl;
157
-
158
- return routeClient;
159
- };
160
-
161
-
162
- export interface MakeApiGateway<F> {
163
- <Ru>(
164
- config: ConfigProviderForConfig<{ apiBase: string }>,
165
- routes: MapRoutesToConfig<Ru>,
166
- app?: {
167
- authProvider?: { getAuthorizedFetchConfig: () => Promise<ConfigForFetch<F>> };
168
- logger?: Logger;
169
- launchToken?: string;
170
- }
171
- ): MapRoutesToClient<Ru>;
172
- }
173
-
174
- export const createApiGateway = <F extends GenericFetch>(initializer: {
175
- fetch: F;
176
- // TODO - try harder
177
- // @ts-ignore this type conversion is annoying
178
- }): MakeApiGateway<F> => (
179
- config: ConfigProviderForConfig<{ apiBase: string }>,
180
- routes: { [key: string]: { path: string; method: METHOD } },
181
- app?: {
182
- authProvider?: { getAuthorizedFetchConfig: () => Promise<ConfigForFetch<F>> };
183
- logger?: Logger;
184
- launchToken?: string;
185
- }
186
- ) => {
187
- return Object.fromEntries(Object.entries(routes)
188
- .map(([key, routeConfig]) => ([key, makeRouteClient(initializer, config, routeConfig, app)])));
189
- };
@@ -1,21 +0,0 @@
1
-
2
- # authProvider
3
-
4
- the authProvider interface is just a `getUser` function, there are several available drivers.
5
-
6
-
7
- ## drivers
8
-
9
- ### [subrequest](./subrequest.ts)
10
-
11
- for servers, takes a given cookie value and forwards it to another accounts server to get the user data. useful for dev or testing server implementations because you don't need any secrets.
12
-
13
- ### [browser](./browser.ts)
14
-
15
- for browsers, queries an accounts server for the current user data
16
-
17
- ### decode
18
-
19
- **note** not written yet, needs to be written
20
-
21
- decodes the given cookie value with secret keys. faster than making a subrequest
@@ -1,391 +0,0 @@
1
- import { browserAuthProvider, EventHandler, Window } from './browser';
2
- import { User } from '.';
3
-
4
- afterEach(() => {
5
- jest.clearAllMocks();
6
- });
7
-
8
- describe('browserAuthProvider', () => {
9
- let fetchSpy: jest.SpyInstance;
10
- let postMessageSpy: jest.SpyInstance;
11
- let addEventListenerSpy: jest.SpyInstance;
12
- let removeEventListenerSpy: jest.SpyInstance;
13
- let initializer: { window: Window };
14
- const config = {
15
- auth: {
16
- accountsBase: 'accountsBase',
17
- }
18
- };
19
-
20
- beforeEach(() => {
21
- fetchSpy = jest.fn();
22
- postMessageSpy = jest.fn();
23
- addEventListenerSpy = jest.fn();
24
- removeEventListenerSpy = jest.fn();
25
- const win = {};
26
-
27
- Object.assign(win, {
28
- fetch: fetchSpy as any,
29
- location: {search: ''},
30
- parent: win,
31
- document: {referrer: 'https://example.com'},
32
- postMessage: postMessageSpy as any,
33
- addEventListener: addEventListenerSpy as any,
34
- removeEventListener: removeEventListenerSpy as any,
35
- });
36
-
37
- initializer = {
38
- window: win as Window
39
- };
40
- });
41
-
42
- describe('with cookie config', () => {
43
- it('fetches user', async() => {
44
- const userResponse = { id: 1 } as User;
45
- fetchSpy.mockReturnValue(Promise.resolve({status: 200, json: () => userResponse}));
46
- const loader = browserAuthProvider(initializer)(config);
47
- await loader.getUser();
48
- await loader.getUser();
49
- const user = await loader.getUser();
50
- expect(fetchSpy).toHaveBeenCalledTimes(1);
51
- expect(fetchSpy).toHaveBeenCalledWith('accountsBase/api/user?always_200=true', {credentials: 'include'});
52
- expect(user).toBe(userResponse);
53
- });
54
-
55
- it('handles empty object responses', async() => {
56
- fetchSpy.mockReturnValue(Promise.resolve({status: 200, json: () => ({})}));
57
- const loader = browserAuthProvider(initializer)(config);
58
- await loader.getUser();
59
- await loader.getUser();
60
- const user = await loader.getUser();
61
- expect(fetchSpy).toHaveBeenCalledTimes(1);
62
- expect(fetchSpy).toHaveBeenCalledWith('accountsBase/api/user?always_200=true', {credentials: 'include'});
63
- expect(user).toBeUndefined();
64
- });
65
-
66
- it('throws on other status codes', async() => {
67
- fetchSpy.mockReturnValue(Promise.resolve({status: 500, text: () => 'oops'}));
68
- const loader = browserAuthProvider(initializer)(config);
69
- await expect(loader.getUser()).rejects.toThrow('Error response from Accounts 500: oops');
70
- expect(fetchSpy).toHaveBeenCalledTimes(1);
71
- expect(fetchSpy).toHaveBeenCalledWith('accountsBase/api/user?always_200=true', {credentials: 'include'});
72
- });
73
-
74
- it('generates authorized url', () => {
75
- const provider = browserAuthProvider(initializer)(config);
76
- expect(provider.getAuthorizedUrl('https://somecoolurl.com/?foo=bar')).toBe('https://somecoolurl.com/?foo=bar');
77
- expect(provider.getAuthorizedLinkUrl('https://somecoolurl.com/?foo=bar')).toBe('https://somecoolurl.com/?foo=bar');
78
- expect(provider.getAuthorizedEmbedUrl('https://somecoolurl.com/?foo=bar')).toBe('https://somecoolurl.com/?auth=embedded&embedded=true&foo=bar&subcontent=true');
79
- expect(provider.getAuthorizedEmbedUrl('https://somecoolurl.com/?foo=bar', {test: 'true'})).toBe('https://somecoolurl.com/?auth=embedded&embedded=true&foo=bar&subcontent=true&test=true');
80
- });
81
-
82
- it('generates authorized fetch-config', async () => {
83
- const userResponse = { id: 1 } as User;
84
- fetchSpy.mockReturnValue(Promise.resolve({status: 200, json: () => userResponse}));
85
- const provider = browserAuthProvider(initializer)(config);
86
- expect(await provider.getAuthorizedFetchConfig()).toEqual({credentials: 'include'});
87
- });
88
-
89
- it('releases loaded identity to trusted embed', async () => {
90
- let eventListener: EventHandler;
91
-
92
- addEventListenerSpy.mockImplementation((_, handler) => eventListener = handler);
93
-
94
- const userResponse = { id: 1 } as User;
95
- fetchSpy.mockReturnValue(Promise.resolve({status: 200, json: () => userResponse}));
96
- const provider = browserAuthProvider(initializer)(config);
97
-
98
- provider.getAuthorizedEmbedUrl('https://somecoolurl.com/?foo=bar');
99
- eventListener!({data: {type: 'request-user'}, origin: 'https://somecoolurl.com', source: initializer.window});
100
-
101
- await new Promise(setImmediate);
102
-
103
- expect(postMessageSpy).toHaveBeenCalledWith({
104
- type: 'receive-user', userData: {token: null, user: userResponse}
105
- }, 'https://somecoolurl.com');
106
- });
107
- });
108
-
109
- describe('with token config', () => {
110
- it('sends an Authorization: Bearer TOKEN header when given a token string', async() => {
111
- const userResponse = { id: 1 } as User;
112
- fetchSpy.mockReturnValue(Promise.resolve({status: 200, json: () => userResponse}));
113
- initializer.window.location.search = '?auth=123abc';
114
- const loader = browserAuthProvider(initializer)(config);
115
- await loader.getUser();
116
- await loader.getUser();
117
- const user = await loader.getUser();
118
- expect(fetchSpy).toHaveBeenCalledTimes(1);
119
- expect(fetchSpy).toHaveBeenCalledWith(
120
- 'accountsBase/api/user?always_200=true', {headers: {Authorization: 'Bearer 123abc'}}
121
- );
122
- expect(user).toBe(userResponse);
123
- });
124
-
125
- it('generates authorized url', () => {
126
- initializer.window.location.search = '?auth=123abc';
127
- const provider = browserAuthProvider(initializer)(config);
128
- expect(provider.getAuthorizedUrl('https://somecoolurl.com/?foo=bar')).toBe('https://somecoolurl.com/?foo=bar&auth=123abc');
129
- expect(provider.getAuthorizedLinkUrl('https://somecoolurl.com/?foo=bar')).toBe('https://somecoolurl.com/?foo=bar&auth=123abc');
130
- });
131
-
132
- it('generates authorized fetch-config', async () => {
133
- initializer.window.location.search = '?auth=123abc';
134
- const provider = browserAuthProvider(initializer)(config);
135
- expect(await provider.getAuthorizedFetchConfig()).toEqual({headers: {Authorization: 'Bearer 123abc'}});
136
- });
137
-
138
- it('generates authorized embed url', () => {
139
- initializer.window.location.search = '?auth=123abc';
140
- const provider = browserAuthProvider(initializer)(config);
141
- expect(provider.getAuthorizedEmbedUrl('https://somecoolurl.com/?foo=bar')).toBe(
142
- 'https://somecoolurl.com/?auth=123abc&embedded=true&foo=bar&subcontent=true'
143
- );
144
- });
145
-
146
- it('returns the auth token', async () => {
147
- const userResponse = { id: 1 } as User;
148
- fetchSpy.mockReturnValue(Promise.resolve({status: 200, json: () => userResponse}));
149
- initializer.window.location.search = '?auth=123abc';
150
- const provider = browserAuthProvider(initializer)(config);
151
- expect(await provider.getAuthToken()).toBe('123abc');
152
- });
153
-
154
- it('releases loaded identity to trusted embed', async () => {
155
- let eventListener: EventHandler;
156
-
157
- addEventListenerSpy.mockImplementation((_, handler) => eventListener = handler);
158
-
159
- const userResponse = { id: 1 } as User;
160
- fetchSpy.mockReturnValue(Promise.resolve({status: 200, json: () => userResponse}));
161
- initializer.window.location.search = '?auth=123abc';
162
- const provider = browserAuthProvider(initializer)(config);
163
-
164
- provider.getAuthorizedEmbedUrl('https://somecoolurl.com/?foo=bar');
165
- eventListener!({data: {type: 'request-user'}, origin: 'https://somecoolurl.com', source: initializer.window});
166
-
167
- await new Promise(setImmediate);
168
-
169
- expect(postMessageSpy).toHaveBeenCalledWith({
170
- type: 'receive-user', userData: {token: '123abc', user: userResponse}
171
- }, 'https://somecoolurl.com');
172
- });
173
- });
174
-
175
- describe('with embedded config', () => {
176
- it('requests user identity', async () => {
177
- let eventListener: EventHandler;
178
-
179
- addEventListenerSpy.mockImplementation((_, handler) => eventListener = handler);
180
- const userResponse = { id: 1 } as User;
181
-
182
- const parentPostMessageSpy = jest.fn();
183
- const parent = {
184
- postMessage: parentPostMessageSpy,
185
- } as NonNullable<Window['parent']>;
186
-
187
- initializer.window.document.referrer = 'https://openstax.org/select-content';
188
- initializer.window.parent = parent;
189
- initializer.window.location.search = '?embedded=true';
190
- const provider = browserAuthProvider(initializer)(config);
191
-
192
- const promise = provider.getUser();
193
-
194
- expect(addEventListenerSpy).toHaveBeenCalledTimes(2);
195
- expect(parentPostMessageSpy).toHaveBeenCalledWith({type: 'request-user'}, 'https://openstax.org');
196
- eventListener!({data: {type: 'receive-user', userData: {token: '123abc', user: userResponse}}, origin: 'https://openstax.org', source: parent});
197
-
198
- await new Promise(setImmediate);
199
-
200
- expect(await promise).toBe(userResponse);
201
- });
202
-
203
- it('requests with trusted subdomain referrer', async () => {
204
- let eventListener: EventHandler;
205
-
206
- addEventListenerSpy.mockImplementation((_, handler) => eventListener = handler);
207
- const userResponse = { id: 1 } as User;
208
-
209
- const parentPostMessageSpy = jest.fn();
210
- const parent = {
211
- postMessage: parentPostMessageSpy,
212
- } as NonNullable<Window['parent']>;
213
-
214
- initializer.window.document.referrer = 'https://lti.openstax.org/select-content';
215
- initializer.window.parent = parent;
216
- initializer.window.location.search = '?embedded=true';
217
- const provider = browserAuthProvider(initializer)(config);
218
-
219
- const promise = provider.getUser();
220
-
221
- expect(addEventListenerSpy).toHaveBeenCalledTimes(2);
222
- expect(parentPostMessageSpy).toHaveBeenCalledWith({type: 'request-user'}, 'https://lti.openstax.org');
223
- eventListener!({data: {type: 'receive-user', userData: {token: '123abc', user: userResponse}}, origin: 'https://lti.openstax.org', source: parent});
224
-
225
- await new Promise(setImmediate);
226
-
227
- expect(await promise).toBe(userResponse);
228
- });
229
-
230
- it('does not request with untrusted referrer', async () => {
231
- const parentPostMessageSpy = jest.fn();
232
- const parent = {
233
- postMessage: parentPostMessageSpy,
234
- } as NonNullable<Window['parent']>;
235
-
236
- initializer.window.document.referrer = 'https://notopenstax.org/select-content';
237
- initializer.window.parent = parent;
238
- initializer.window.location.search = '?embedded=true';
239
- const provider = browserAuthProvider(initializer)(config);
240
-
241
- await expect(() => provider.getUser()).rejects.toThrow('parent window is undefined or not trusted');
242
-
243
- initializer.window.document.referrer = 'https://not.openstaxlorg/select-content';
244
- const provider2 = browserAuthProvider(initializer)(config);
245
-
246
- await expect(() => provider2.getUser()).rejects.toThrow('parent window is undefined or not trusted');
247
- });
248
-
249
- it('does not request without referrer', async () => {
250
- const parentPostMessageSpy = jest.fn();
251
- const parent = {
252
- postMessage: parentPostMessageSpy,
253
- } as NonNullable<Window['parent']>;
254
-
255
- initializer.window.document.referrer = '';
256
- initializer.window.parent = parent;
257
- initializer.window.location.search = '?embedded=true';
258
- const provider = browserAuthProvider(initializer)(config);
259
-
260
- await expect(() => provider.getUser()).rejects.toThrow('parent window is undefined or not trusted');
261
- });
262
-
263
- it('ignores responses from the wrong origin', async () => {
264
- let eventListener: EventHandler;
265
-
266
- addEventListenerSpy.mockImplementation((_, handler) => eventListener = handler);
267
- const userResponse = { id: 1 } as User;
268
-
269
- const parentPostMessageSpy = jest.fn();
270
- const parent = {
271
- postMessage: parentPostMessageSpy,
272
- } as NonNullable<Window['parent']>;
273
-
274
- initializer.window.document.referrer = 'https://lti.openstax.org/select-content';
275
- initializer.window.parent = parent;
276
- initializer.window.location.search = '?embedded=true';
277
- const provider = browserAuthProvider(initializer)(config);
278
-
279
- const promise = provider.getUser();
280
-
281
- expect(addEventListenerSpy).toHaveBeenCalledTimes(2);
282
- expect(parentPostMessageSpy).toHaveBeenCalledWith({type: 'request-user'}, 'https://lti.openstax.org');
283
- eventListener!({data: {type: 'receive-user', userData: {token: '123abc', user: userResponse}}, origin: 'https://malicious-site.com', source: parent});
284
-
285
- await expect(promise).rejects.toThrow('loading user identity timed out');
286
- }, 10000);
287
-
288
- it('works with legacy auth=embedded urls', async () => {
289
- let eventListener: EventHandler;
290
-
291
- addEventListenerSpy.mockImplementation((_, handler) => eventListener = handler);
292
- const userResponse = { id: 1 } as User;
293
-
294
- const parentPostMessageSpy = jest.fn();
295
- const parent = {
296
- postMessage: parentPostMessageSpy,
297
- } as NonNullable<Window['parent']>;
298
-
299
- initializer.window.document.referrer = 'https://openstax.org/select-content';
300
- initializer.window.parent = parent;
301
- initializer.window.location.search = '?auth=embedded';
302
- const provider = browserAuthProvider(initializer)(config);
303
-
304
- const promise = provider.getUser();
305
-
306
- expect(addEventListenerSpy).toHaveBeenCalledTimes(2);
307
- expect(parentPostMessageSpy).toHaveBeenCalledWith({type: 'request-user'}, 'https://openstax.org');
308
- eventListener!({data: {type: 'receive-user', userData: {token: '123abc', user: userResponse}}, origin: 'https://openstax.org', source: parent});
309
-
310
- await new Promise(setImmediate);
311
-
312
- expect(await promise).toBe(userResponse);
313
- });
314
- });
315
-
316
- describe('with both token and embedded config', () => {
317
- it('gets the parent window user', async() => {
318
- const parentPostMessageSpy = jest.fn();
319
- const parent = {
320
- postMessage: parentPostMessageSpy,
321
- } as NonNullable<Window['parent']>;
322
- initializer.window.document.referrer = 'https://openstax.org/select-content';
323
- initializer.window.parent = parent;
324
- initializer.window.location.search = '?auth=123abc&embedded=true';
325
- const provider = browserAuthProvider(initializer)(config);
326
-
327
- const userResponse = { id: 1 } as User;
328
- let eventListener: EventHandler;
329
- addEventListenerSpy.mockImplementation((_, handler) => eventListener = handler);
330
-
331
- const promise = provider.getUser();
332
-
333
- expect(addEventListenerSpy).toHaveBeenCalledTimes(2);
334
- expect(parentPostMessageSpy).toHaveBeenCalledWith({type: 'request-user'}, 'https://openstax.org');
335
- eventListener!({
336
- data: {type: 'receive-user', userData: {token: '123abc', user: userResponse}},
337
- origin: 'https://openstax.org',
338
- source: parent
339
- });
340
-
341
- const user = await promise;
342
- expect(user).toBe(userResponse);
343
- });
344
-
345
- it('generates authorized url', () => {
346
- initializer.window.location.search = '?auth=123abc&embedded=true';
347
- const provider = browserAuthProvider(initializer)(config);
348
- expect(provider.getAuthorizedUrl('https://somecoolurl.com/?foo=bar')).toBe(
349
- 'https://somecoolurl.com/?foo=bar&auth=123abc&embedded=true'
350
- );
351
- expect(provider.getAuthorizedLinkUrl('https://somecoolurl.com/?foo=bar')).toBe(
352
- 'https://somecoolurl.com/?foo=bar&auth=123abc'
353
- );
354
- });
355
-
356
- it('sets auth=embedded for backwards compatibility', () => {
357
- initializer.window.location.search = '?embedded=true';
358
- const provider = browserAuthProvider(initializer)(config);
359
- expect(provider.getAuthorizedUrl('https://somecoolurl.com/?foo=bar')).toBe(
360
- 'https://somecoolurl.com/?foo=bar&auth=embedded&embedded=true'
361
- );
362
- });
363
-
364
- it('can update user settings', async() => {
365
- const consent_preferences = {
366
- accepted: ['necessary'],
367
- rejected: ['functional', 'analytics', 'performance', 'advertisement', 'other']
368
- };
369
- const userResponse = { id: 1, consent_preferences } as User;
370
- fetchSpy.mockReturnValue(Promise.resolve({status: 200, json: () => userResponse}));
371
- const provider = browserAuthProvider(initializer)(config);
372
-
373
- const response = await provider.updateUser({consent_preferences});
374
- expect(response).toStrictEqual({ token: null, user: userResponse });
375
- });
376
-
377
- it('throws on other status codes when updating', async() => {
378
- const consent_preferences = {
379
- accepted: ['necessary'],
380
- rejected: ['functional', 'analytics', 'performance', 'advertisement', 'other']
381
- };
382
- fetchSpy.mockReturnValue(Promise.resolve({status: 500, text: () => 'oops'}));
383
- const provider = browserAuthProvider(initializer)(config);
384
- await expect(provider.updateUser({consent_preferences})).rejects.toThrow('Error response from Accounts 500: oops');
385
- expect(fetchSpy).toHaveBeenCalledTimes(1);
386
- expect(fetchSpy).toHaveBeenCalledWith('accountsBase/api/user', {
387
- body: JSON.stringify({consent_preferences}), credentials: 'include', method: 'PUT'
388
- });
389
- });
390
- });
391
- });