@openstax/ts-utils 1.33.0 → 1.34.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (503) hide show
  1. package/.cfnlintrc +2 -0
  2. package/.github/CODEOWNERS +1 -0
  3. package/.github/workflows/ci.yml +36 -0
  4. package/.github/workflows/lint.yml +55 -0
  5. package/.nvmrc +1 -0
  6. package/.syncignore +4 -0
  7. package/.syncpackrc +18 -0
  8. package/CONTRIBUTING.md +96 -0
  9. package/LICENSE +661 -0
  10. package/Procfile +1 -0
  11. package/README.md +62 -90
  12. package/app.json +23 -0
  13. package/cspell.json +32 -0
  14. package/deploy/constants.env +21 -0
  15. package/deploy/deploy.bash +157 -0
  16. package/deploy/deployment-alt-region.cfn.yml +70 -0
  17. package/deploy/deployment.cfn.yml +650 -0
  18. package/deploy/destroy-deployment.bash +23 -0
  19. package/deploy/shared.cfn.yml +94 -0
  20. package/docs/lambda-build.md +35 -0
  21. package/package.json +12 -228
  22. package/packages/frontend/README.md +46 -0
  23. package/packages/frontend/package.json +101 -0
  24. package/packages/frontend/public/favicon.ico +0 -0
  25. package/packages/frontend/public/index.html +107 -0
  26. package/packages/frontend/public/maintenance.html +59 -0
  27. package/packages/frontend/public/manifest.json +15 -0
  28. package/packages/frontend/public/robots.txt +3 -0
  29. package/packages/frontend/script/make-certificate.bash +49 -0
  30. package/packages/frontend/script/server/cli.js +11 -0
  31. package/packages/frontend/script/server/index.js +47 -0
  32. package/packages/frontend/script/start.bash +22 -0
  33. package/packages/frontend/script/trust-localhost.bash +7 -0
  34. package/packages/frontend/src/auth/authProvider.ts +10 -0
  35. package/packages/frontend/src/auth/useAuth.ts +33 -0
  36. package/packages/frontend/src/components/Pagination.tsx +26 -0
  37. package/packages/frontend/src/configProvider/index.ts +53 -0
  38. package/packages/frontend/src/configProvider/use.ts +41 -0
  39. package/packages/frontend/src/core/context/services.spec.tsx +39 -0
  40. package/packages/frontend/src/core/context/services.tsx +16 -0
  41. package/packages/frontend/src/core/index.spec.ts +7 -0
  42. package/packages/frontend/src/core/index.ts +20 -0
  43. package/packages/frontend/src/core/services.tsx +14 -0
  44. package/packages/frontend/src/core/types.ts +3 -0
  45. package/packages/frontend/src/example/api.ts +28 -0
  46. package/packages/frontend/src/example/components/Layout.tsx +23 -0
  47. package/packages/frontend/src/example/screens/Home.spec.tsx +68 -0
  48. package/packages/frontend/src/example/screens/Home.tsx +78 -0
  49. package/packages/frontend/src/example/screens/ThingList.spec.tsx +60 -0
  50. package/packages/frontend/src/example/screens/ThingList.tsx +75 -0
  51. package/packages/frontend/src/example/screens/ThingView.spec.tsx +71 -0
  52. package/packages/frontend/src/example/screens/ThingView.tsx +47 -0
  53. package/packages/frontend/src/example/screens/index.ts +9 -0
  54. package/packages/frontend/src/index.css +159 -0
  55. package/packages/frontend/src/index.tsx +67 -0
  56. package/packages/frontend/src/react-app-env.d.ts +1 -0
  57. package/packages/frontend/src/routing/components/RouteLink.spec.tsx +55 -0
  58. package/packages/frontend/src/routing/components/RouteLink.tsx +35 -0
  59. package/packages/frontend/src/routing/middleware.ts +6 -0
  60. package/packages/frontend/src/routing/useQuery.ts +14 -0
  61. package/packages/frontend/src/setupProxy.js +19 -0
  62. package/packages/frontend/src/setupTests.ts +9 -0
  63. package/packages/frontend/src/tests/testServices.tsx +23 -0
  64. package/packages/frontend/tsconfig.json +27 -0
  65. package/packages/lambda/.eslintrc.js +64 -0
  66. package/packages/lambda/jest-global-setup.js +3 -0
  67. package/packages/lambda/jest-setup-after-env.js +1 -0
  68. package/packages/lambda/jest.config.js +31 -0
  69. package/packages/lambda/jest.resolver.js +17 -0
  70. package/packages/lambda/package.json +68 -0
  71. package/packages/lambda/script/build.bash +19 -0
  72. package/packages/lambda/script/bundle-functions.bash +10 -0
  73. package/packages/lambda/script/lambdaLocalProxy.js +16 -0
  74. package/packages/lambda/script/lambdaLocalProxy.spec.ts +147 -0
  75. package/packages/lambda/script/utils/getRouteData.ts +7 -0
  76. package/packages/lambda/script/utils/routeDataLoader.js +8 -0
  77. package/packages/lambda/script/utils/routeDataLoader.spec.ts +8 -0
  78. package/packages/lambda/src/functions/serviceApi/core/index.ts +7 -0
  79. package/packages/lambda/src/functions/serviceApi/core/request.spec.ts +38 -0
  80. package/packages/lambda/src/functions/serviceApi/core/request.ts +42 -0
  81. package/packages/lambda/src/functions/serviceApi/core/routes.spec.ts +7 -0
  82. package/packages/lambda/src/functions/serviceApi/core/routes.ts +10 -0
  83. package/packages/lambda/src/functions/serviceApi/core/services.ts +9 -0
  84. package/packages/lambda/src/functions/serviceApi/core/types.ts +13 -0
  85. package/packages/lambda/src/functions/serviceApi/entry/lambda/https-xray.ts +4 -0
  86. package/packages/lambda/src/functions/serviceApi/entry/lambda/index.spec.ts +48 -0
  87. package/packages/lambda/src/functions/serviceApi/entry/lambda/index.ts +58 -0
  88. package/packages/lambda/src/functions/serviceApi/entry/lambda/services.ts +36 -0
  89. package/packages/lambda/src/functions/serviceApi/entry/local.ts +71 -0
  90. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentSearchMiddleware.spec.ts +16 -0
  91. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentSearchMiddleware.ts +41 -0
  92. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentStoreMiddleware.spec.ts +78 -0
  93. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentStoreMiddleware.ts +70 -0
  94. package/packages/lambda/src/functions/serviceApi/versions/v0/example/routes.spec.ts +306 -0
  95. package/packages/lambda/src/functions/serviceApi/versions/v0/example/routes.ts +176 -0
  96. package/packages/lambda/src/functions/serviceApi/versions/v0/index.spec.ts +263 -0
  97. package/packages/lambda/src/functions/serviceApi/versions/v0/index.ts +134 -0
  98. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/authMiddleware.spec.ts +23 -0
  99. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/authMiddleware.ts +32 -0
  100. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/configMiddleware.spec.ts +10 -0
  101. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/configMiddleware.ts +7 -0
  102. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/frontendFileServerMiddleware.spec.ts +13 -0
  103. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/frontendFileServerMiddleware.ts +23 -0
  104. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/paginationMiddleware.spec.ts +9 -0
  105. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/paginationMiddleware.ts +9 -0
  106. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/searchMiddleware.spec.ts +12 -0
  107. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/searchMiddleware.ts +21 -0
  108. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/userRoleValidatorMiddleware.spec.ts +21 -0
  109. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/userRoleValidatorMiddleware.ts +18 -0
  110. package/packages/lambda/tsconfig.json +30 -0
  111. package/packages/lambda/webpack.config.js +97 -0
  112. package/packages/utils/.eslintrc.js +64 -0
  113. package/packages/utils/README.md +118 -0
  114. package/packages/utils/jest-global-setup.js +3 -0
  115. package/packages/utils/jest.config.js +25 -0
  116. package/packages/utils/jest.resolver.js +17 -0
  117. package/packages/utils/package.json +238 -0
  118. package/packages/utils/src/assertions/index.spec.ts +126 -0
  119. package/{dist/esm/assertions/index.js → packages/utils/src/assertions/index.ts} +64 -49
  120. package/packages/utils/src/aws/ssmService.ts +7 -0
  121. package/packages/utils/src/config/awsParameterConfig.ts +24 -0
  122. package/packages/utils/src/config/envConfig.ts +58 -0
  123. package/packages/utils/src/config/index.spec.ts +165 -0
  124. package/{dist/esm/config/index.d.ts → packages/utils/src/config/index.ts} +29 -13
  125. package/packages/utils/src/config/lambdaParameterConfig.ts +49 -0
  126. package/{dist/esm/config/replaceConfig.js → packages/utils/src/config/replaceConfig.ts} +16 -6
  127. package/packages/utils/src/config/resolveConfigValue.ts +10 -0
  128. package/packages/utils/src/errors/index.spec.ts +35 -0
  129. package/{dist/esm/errors/index.js → packages/utils/src/errors/index.ts} +57 -41
  130. package/packages/utils/src/fetch/fetchStatusRetry.spec.ts +197 -0
  131. package/packages/utils/src/fetch/fetchStatusRetry.ts +33 -0
  132. package/packages/utils/src/fetch/index.spec.ts +34 -0
  133. package/packages/utils/src/fetch/index.ts +87 -0
  134. package/packages/utils/src/guards/index.spec.ts +58 -0
  135. package/{dist/esm/guards/index.d.ts → packages/utils/src/guards/index.ts} +10 -7
  136. package/packages/utils/src/index.spec.ts +471 -0
  137. package/packages/utils/src/middleware/apiErrorHandler.spec.ts +65 -0
  138. package/packages/utils/src/middleware/apiErrorHandler.ts +67 -0
  139. package/packages/utils/src/middleware/apiSlowResponseMiddleware.spec.ts +184 -0
  140. package/packages/utils/src/middleware/apiSlowResponseMiddleware.ts +71 -0
  141. package/packages/utils/src/middleware/index.spec.ts +99 -0
  142. package/{dist/cjs/middleware/index.d.ts → packages/utils/src/middleware/index.ts} +53 -5
  143. package/packages/utils/src/middleware/lambdaCorsResponseMiddleware.spec.ts +103 -0
  144. package/packages/utils/src/middleware/lambdaCorsResponseMiddleware.ts +52 -0
  145. package/packages/utils/src/middleware/throwNotFoundMiddleware.spec.ts +20 -0
  146. package/packages/utils/src/middleware/throwNotFoundMiddleware.ts +11 -0
  147. package/packages/utils/src/misc/hashValue.ts +18 -0
  148. package/packages/utils/src/misc/helpers.ts +259 -0
  149. package/packages/utils/src/misc/merge.ts +48 -0
  150. package/{dist/esm/misc/partitionSequence.js → packages/utils/src/misc/partitionSequence.ts} +23 -15
  151. package/packages/utils/src/pagination/index.spec.ts +150 -0
  152. package/packages/utils/src/pagination/index.ts +117 -0
  153. package/{dist/esm/routing/helpers.js → packages/utils/src/routing/helpers.ts} +42 -30
  154. package/packages/utils/src/routing/index.spec.ts +553 -0
  155. package/packages/utils/src/routing/index.ts +424 -0
  156. package/packages/utils/src/routing/validators/zod.spec.ts +16 -0
  157. package/packages/utils/src/routing/validators/zod.ts +14 -0
  158. package/packages/utils/src/services/accountsGateway/README.md +3 -0
  159. package/packages/utils/src/services/accountsGateway/index.spec.ts +518 -0
  160. package/packages/utils/src/services/accountsGateway/index.ts +251 -0
  161. package/packages/utils/src/services/apiGateway/README.md +93 -0
  162. package/packages/utils/src/services/apiGateway/index.spec.ts +254 -0
  163. package/packages/utils/src/services/apiGateway/index.ts +189 -0
  164. package/packages/utils/src/services/authProvider/README.md +21 -0
  165. package/packages/utils/src/services/authProvider/browser.spec.ts +391 -0
  166. package/packages/utils/src/services/authProvider/browser.ts +209 -0
  167. package/packages/utils/src/services/authProvider/decryption.spec.ts +337 -0
  168. package/packages/utils/src/services/authProvider/decryption.ts +98 -0
  169. package/packages/utils/src/services/authProvider/index.ts +93 -0
  170. package/packages/utils/src/services/authProvider/stub.spec.ts +29 -0
  171. package/packages/utils/src/services/authProvider/subrequest.spec.ts +105 -0
  172. package/packages/utils/src/services/authProvider/subrequest.ts +68 -0
  173. package/packages/utils/src/services/authProvider/utils/decryptAndVerify.spec.ts +128 -0
  174. package/packages/utils/src/services/authProvider/utils/decryptAndVerify.ts +106 -0
  175. package/packages/utils/src/services/authProvider/utils/embeddedAuthProvider.spec.ts +26 -0
  176. package/packages/utils/src/services/authProvider/utils/embeddedAuthProvider.ts +57 -0
  177. package/packages/utils/src/services/authProvider/utils/userRoleValidator.spec.ts +135 -0
  178. package/packages/utils/src/services/authProvider/utils/userRoleValidator.ts +49 -0
  179. package/packages/utils/src/services/authProvider/utils/userSubrequest.spec.ts +26 -0
  180. package/packages/utils/src/services/authProvider/utils/userSubrequest.ts +10 -0
  181. package/packages/utils/src/services/documentStore/dynamoEncoding.ts +57 -0
  182. package/packages/utils/src/services/documentStore/fileSystemAssert.spec.ts +43 -0
  183. package/packages/utils/src/services/documentStore/fileSystemAssert.ts +10 -0
  184. package/{dist/cjs/services/documentStore/index.d.ts → packages/utils/src/services/documentStore/index.ts} +8 -8
  185. package/packages/utils/src/services/documentStore/unversioned/README.md +13 -0
  186. package/packages/utils/src/services/documentStore/unversioned/dynamodb.spec.ts +859 -0
  187. package/packages/utils/src/services/documentStore/unversioned/dynamodb.ts +243 -0
  188. package/packages/utils/src/services/documentStore/unversioned/file-system.spec.ts +629 -0
  189. package/packages/utils/src/services/documentStore/unversioned/file-system.ts +194 -0
  190. package/{dist/cjs/services/documentStore/unversioned/index.d.ts → packages/utils/src/services/documentStore/unversioned/index.ts} +2 -0
  191. package/packages/utils/src/services/documentStore/versioned/README.md +13 -0
  192. package/packages/utils/src/services/documentStore/versioned/dynamodb.spec.ts +376 -0
  193. package/packages/utils/src/services/documentStore/versioned/dynamodb.ts +167 -0
  194. package/packages/utils/src/services/documentStore/versioned/file-system.spec.ts +262 -0
  195. package/packages/utils/src/services/documentStore/versioned/file-system.ts +90 -0
  196. package/packages/utils/src/services/documentStore/versioned/index.ts +25 -0
  197. package/packages/utils/src/services/exercisesGateway/README.md +5 -0
  198. package/packages/utils/src/services/exercisesGateway/index.spec.ts +326 -0
  199. package/packages/utils/src/services/exercisesGateway/index.ts +163 -0
  200. package/packages/utils/src/services/fileServer/index.spec.ts +88 -0
  201. package/packages/utils/src/services/fileServer/index.ts +43 -0
  202. package/packages/utils/src/services/fileServer/localFileServer.spec.ts +182 -0
  203. package/packages/utils/src/services/fileServer/localFileServer.ts +159 -0
  204. package/packages/utils/src/services/fileServer/s3FileServer.spec.ts +266 -0
  205. package/packages/utils/src/services/fileServer/s3FileServer.ts +155 -0
  206. package/packages/utils/src/services/launchParams/index.spec.ts +366 -0
  207. package/packages/utils/src/services/launchParams/signer.ts +73 -0
  208. package/packages/utils/src/services/launchParams/verifier.ts +120 -0
  209. package/packages/utils/src/services/logger/console.spec.ts +29 -0
  210. package/{dist/esm/services/logger/console.js → packages/utils/src/services/logger/console.ts} +5 -2
  211. package/packages/utils/src/services/logger/index.spec.ts +65 -0
  212. package/{dist/esm/services/logger/index.d.ts → packages/utils/src/services/logger/index.ts} +23 -9
  213. package/packages/utils/src/services/lrsGateway/README.md +5 -0
  214. package/packages/utils/src/services/lrsGateway/addStatementDefaultFields.ts +22 -0
  215. package/packages/utils/src/services/lrsGateway/attempt-utils.spec.ts +847 -0
  216. package/packages/utils/src/services/lrsGateway/attempt-utils.ts +358 -0
  217. package/packages/utils/src/services/lrsGateway/file-system.spec.ts +363 -0
  218. package/packages/utils/src/services/lrsGateway/file-system.ts +165 -0
  219. package/packages/utils/src/services/lrsGateway/index.spec.ts +194 -0
  220. package/packages/utils/src/services/lrsGateway/index.ts +257 -0
  221. package/packages/utils/src/services/lrsGateway/xapiUtils.spec.ts +887 -0
  222. package/packages/utils/src/services/lrsGateway/xapiUtils.ts +262 -0
  223. package/packages/utils/src/services/postgresConnection/index.spec.ts +170 -0
  224. package/packages/utils/src/services/postgresConnection/index.ts +84 -0
  225. package/packages/utils/src/services/searchProvider/README.md +3 -0
  226. package/packages/utils/src/services/searchProvider/index.ts +59 -0
  227. package/packages/utils/src/services/searchProvider/memorySearchTheBadWay.spec.ts +526 -0
  228. package/packages/utils/src/services/searchProvider/memorySearchTheBadWay.ts +223 -0
  229. package/packages/utils/src/services/searchProvider/openSearch.spec.ts +926 -0
  230. package/packages/utils/src/services/searchProvider/openSearch.ts +195 -0
  231. package/{dist/esm/types.d.ts → packages/utils/src/types.ts} +34 -6
  232. package/packages/utils/tsconfig.json +31 -0
  233. package/packages/utils/tsconfig.without-specs.cjs.json +7 -0
  234. package/packages/utils/tsconfig.without-specs.esm.json +7 -0
  235. package/packages/utils/tsconfig.without-specs.json +6 -0
  236. package/scripts/build.bash +24 -0
  237. package/scripts/ci.bash +10 -0
  238. package/scripts/start.bash +29 -0
  239. package/dist/cjs/assertions/index.d.ts +0 -89
  240. package/dist/cjs/assertions/index.js +0 -157
  241. package/dist/cjs/aws/ssmService.d.ts +0 -5
  242. package/dist/cjs/aws/ssmService.js +0 -9
  243. package/dist/cjs/config/awsParameterConfig.d.ts +0 -10
  244. package/dist/cjs/config/awsParameterConfig.js +0 -26
  245. package/dist/cjs/config/envConfig.d.ts +0 -24
  246. package/dist/cjs/config/envConfig.js +0 -57
  247. package/dist/cjs/config/index.d.ts +0 -48
  248. package/dist/cjs/config/index.js +0 -35
  249. package/dist/cjs/config/lambdaParameterConfig.d.ts +0 -12
  250. package/dist/cjs/config/lambdaParameterConfig.js +0 -45
  251. package/dist/cjs/config/replaceConfig.d.ts +0 -14
  252. package/dist/cjs/config/replaceConfig.js +0 -22
  253. package/dist/cjs/config/resolveConfigValue.d.ts +0 -5
  254. package/dist/cjs/config/resolveConfigValue.js +0 -12
  255. package/dist/cjs/errors/index.d.ts +0 -88
  256. package/dist/cjs/errors/index.js +0 -123
  257. package/dist/cjs/fetch/fetchStatusRetry.d.ts +0 -8
  258. package/dist/cjs/fetch/fetchStatusRetry.js +0 -27
  259. package/dist/cjs/fetch/index.d.ts +0 -64
  260. package/dist/cjs/fetch/index.js +0 -55
  261. package/dist/cjs/guards/index.d.ts +0 -38
  262. package/dist/cjs/guards/index.js +0 -44
  263. package/dist/cjs/index.js +0 -20
  264. package/dist/cjs/middleware/apiErrorHandler.d.ts +0 -24
  265. package/dist/cjs/middleware/apiErrorHandler.js +0 -42
  266. package/dist/cjs/middleware/apiSlowResponseMiddleware.d.ts +0 -23
  267. package/dist/cjs/middleware/apiSlowResponseMiddleware.js +0 -54
  268. package/dist/cjs/middleware/index.js +0 -48
  269. package/dist/cjs/middleware/lambdaCorsResponseMiddleware.d.ts +0 -20
  270. package/dist/cjs/middleware/lambdaCorsResponseMiddleware.js +0 -44
  271. package/dist/cjs/middleware/throwNotFoundMiddleware.d.ts +0 -4
  272. package/dist/cjs/middleware/throwNotFoundMiddleware.js +0 -14
  273. package/dist/cjs/misc/hashValue.d.ts +0 -10
  274. package/dist/cjs/misc/hashValue.js +0 -17
  275. package/dist/cjs/misc/helpers.d.ts +0 -124
  276. package/dist/cjs/misc/helpers.js +0 -214
  277. package/dist/cjs/misc/merge.d.ts +0 -21
  278. package/dist/cjs/misc/merge.js +0 -45
  279. package/dist/cjs/misc/partitionSequence.d.ts +0 -35
  280. package/dist/cjs/misc/partitionSequence.js +0 -55
  281. package/dist/cjs/pagination/index.d.ts +0 -91
  282. package/dist/cjs/pagination/index.js +0 -83
  283. package/dist/cjs/routing/helpers.d.ts +0 -57
  284. package/dist/cjs/routing/helpers.js +0 -90
  285. package/dist/cjs/routing/index.d.ts +0 -290
  286. package/dist/cjs/routing/index.js +0 -295
  287. package/dist/cjs/routing/validators/zod.d.ts +0 -4
  288. package/dist/cjs/routing/validators/zod.js +0 -14
  289. package/dist/cjs/services/accountsGateway/index.d.ts +0 -92
  290. package/dist/cjs/services/accountsGateway/index.js +0 -138
  291. package/dist/cjs/services/apiGateway/index.d.ts +0 -68
  292. package/dist/cjs/services/apiGateway/index.js +0 -118
  293. package/dist/cjs/services/authProvider/browser.d.ts +0 -40
  294. package/dist/cjs/services/authProvider/browser.js +0 -155
  295. package/dist/cjs/services/authProvider/decryption.d.ts +0 -19
  296. package/dist/cjs/services/authProvider/decryption.js +0 -73
  297. package/dist/cjs/services/authProvider/index.d.ts +0 -63
  298. package/dist/cjs/services/authProvider/index.js +0 -34
  299. package/dist/cjs/services/authProvider/subrequest.d.ts +0 -13
  300. package/dist/cjs/services/authProvider/subrequest.js +0 -49
  301. package/dist/cjs/services/authProvider/utils/decryptAndVerify.d.ts +0 -28
  302. package/dist/cjs/services/authProvider/utils/decryptAndVerify.js +0 -91
  303. package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.d.ts +0 -26
  304. package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.js +0 -47
  305. package/dist/cjs/services/authProvider/utils/userRoleValidator.d.ts +0 -13
  306. package/dist/cjs/services/authProvider/utils/userRoleValidator.js +0 -37
  307. package/dist/cjs/services/authProvider/utils/userSubrequest.d.ts +0 -3
  308. package/dist/cjs/services/authProvider/utils/userSubrequest.js +0 -13
  309. package/dist/cjs/services/documentStore/dynamoEncoding.d.ts +0 -10
  310. package/dist/cjs/services/documentStore/dynamoEncoding.js +0 -52
  311. package/dist/cjs/services/documentStore/fileSystemAssert.d.ts +0 -1
  312. package/dist/cjs/services/documentStore/fileSystemAssert.js +0 -14
  313. package/dist/cjs/services/documentStore/index.js +0 -2
  314. package/dist/cjs/services/documentStore/unversioned/dynamodb.d.ts +0 -31
  315. package/dist/cjs/services/documentStore/unversioned/dynamodb.js +0 -233
  316. package/dist/cjs/services/documentStore/unversioned/file-system.d.ts +0 -32
  317. package/dist/cjs/services/documentStore/unversioned/file-system.js +0 -214
  318. package/dist/cjs/services/documentStore/unversioned/index.js +0 -2
  319. package/dist/cjs/services/documentStore/versioned/dynamodb.d.ts +0 -25
  320. package/dist/cjs/services/documentStore/versioned/dynamodb.js +0 -143
  321. package/dist/cjs/services/documentStore/versioned/file-system.d.ts +0 -25
  322. package/dist/cjs/services/documentStore/versioned/file-system.js +0 -73
  323. package/dist/cjs/services/documentStore/versioned/index.d.ts +0 -17
  324. package/dist/cjs/services/documentStore/versioned/index.js +0 -2
  325. package/dist/cjs/services/exercisesGateway/index.d.ts +0 -67
  326. package/dist/cjs/services/exercisesGateway/index.js +0 -107
  327. package/dist/cjs/services/fileServer/index.d.ts +0 -30
  328. package/dist/cjs/services/fileServer/index.js +0 -19
  329. package/dist/cjs/services/fileServer/localFileServer.d.ts +0 -13
  330. package/dist/cjs/services/fileServer/localFileServer.js +0 -132
  331. package/dist/cjs/services/fileServer/s3FileServer.d.ts +0 -14
  332. package/dist/cjs/services/fileServer/s3FileServer.js +0 -131
  333. package/dist/cjs/services/launchParams/index.js +0 -7
  334. package/dist/cjs/services/launchParams/signer.d.ts +0 -23
  335. package/dist/cjs/services/launchParams/signer.js +0 -58
  336. package/dist/cjs/services/launchParams/verifier.d.ts +0 -21
  337. package/dist/cjs/services/launchParams/verifier.js +0 -129
  338. package/dist/cjs/services/logger/console.d.ts +0 -4
  339. package/dist/cjs/services/logger/console.js +0 -12
  340. package/dist/cjs/services/logger/index.d.ts +0 -39
  341. package/dist/cjs/services/logger/index.js +0 -31
  342. package/dist/cjs/services/lrsGateway/addStatementDefaultFields.d.ts +0 -5
  343. package/dist/cjs/services/lrsGateway/addStatementDefaultFields.js +0 -21
  344. package/dist/cjs/services/lrsGateway/attempt-utils.d.ts +0 -70
  345. package/dist/cjs/services/lrsGateway/attempt-utils.js +0 -258
  346. package/dist/cjs/services/lrsGateway/file-system.d.ts +0 -15
  347. package/dist/cjs/services/lrsGateway/file-system.js +0 -150
  348. package/dist/cjs/services/lrsGateway/index.d.ts +0 -122
  349. package/dist/cjs/services/lrsGateway/index.js +0 -148
  350. package/dist/cjs/services/lrsGateway/xapiUtils.d.ts +0 -68
  351. package/dist/cjs/services/lrsGateway/xapiUtils.js +0 -109
  352. package/dist/cjs/services/postgresConnection/index.d.ts +0 -28
  353. package/dist/cjs/services/postgresConnection/index.js +0 -65
  354. package/dist/cjs/services/searchProvider/index.d.ts +0 -67
  355. package/dist/cjs/services/searchProvider/index.js +0 -2
  356. package/dist/cjs/services/searchProvider/memorySearchTheBadWay.d.ts +0 -20
  357. package/dist/cjs/services/searchProvider/memorySearchTheBadWay.js +0 -191
  358. package/dist/cjs/services/searchProvider/openSearch.d.ts +0 -28
  359. package/dist/cjs/services/searchProvider/openSearch.js +0 -154
  360. package/dist/cjs/tsconfig.without-specs.cjs.tsbuildinfo +0 -1
  361. package/dist/cjs/types.d.ts +0 -31
  362. package/dist/cjs/types.js +0 -2
  363. package/dist/esm/assertions/index.d.ts +0 -89
  364. package/dist/esm/aws/ssmService.d.ts +0 -5
  365. package/dist/esm/aws/ssmService.js +0 -6
  366. package/dist/esm/config/awsParameterConfig.d.ts +0 -10
  367. package/dist/esm/config/awsParameterConfig.js +0 -22
  368. package/dist/esm/config/envConfig.d.ts +0 -24
  369. package/dist/esm/config/envConfig.js +0 -53
  370. package/dist/esm/config/index.js +0 -17
  371. package/dist/esm/config/lambdaParameterConfig.d.ts +0 -12
  372. package/dist/esm/config/lambdaParameterConfig.js +0 -38
  373. package/dist/esm/config/replaceConfig.d.ts +0 -14
  374. package/dist/esm/config/resolveConfigValue.d.ts +0 -5
  375. package/dist/esm/config/resolveConfigValue.js +0 -8
  376. package/dist/esm/errors/index.d.ts +0 -88
  377. package/dist/esm/fetch/fetchStatusRetry.d.ts +0 -8
  378. package/dist/esm/fetch/fetchStatusRetry.js +0 -23
  379. package/dist/esm/fetch/index.d.ts +0 -64
  380. package/dist/esm/fetch/index.js +0 -46
  381. package/dist/esm/guards/index.js +0 -36
  382. package/dist/esm/index.d.ts +0 -4
  383. package/dist/esm/index.js +0 -4
  384. package/dist/esm/middleware/apiErrorHandler.d.ts +0 -24
  385. package/dist/esm/middleware/apiErrorHandler.js +0 -38
  386. package/dist/esm/middleware/apiSlowResponseMiddleware.d.ts +0 -23
  387. package/dist/esm/middleware/apiSlowResponseMiddleware.js +0 -50
  388. package/dist/esm/middleware/index.d.ts +0 -47
  389. package/dist/esm/middleware/index.js +0 -44
  390. package/dist/esm/middleware/lambdaCorsResponseMiddleware.d.ts +0 -20
  391. package/dist/esm/middleware/lambdaCorsResponseMiddleware.js +0 -40
  392. package/dist/esm/middleware/throwNotFoundMiddleware.d.ts +0 -4
  393. package/dist/esm/middleware/throwNotFoundMiddleware.js +0 -10
  394. package/dist/esm/misc/hashValue.d.ts +0 -10
  395. package/dist/esm/misc/hashValue.js +0 -13
  396. package/dist/esm/misc/helpers.d.ts +0 -124
  397. package/dist/esm/misc/helpers.js +0 -199
  398. package/dist/esm/misc/merge.d.ts +0 -21
  399. package/dist/esm/misc/merge.js +0 -40
  400. package/dist/esm/misc/partitionSequence.d.ts +0 -35
  401. package/dist/esm/pagination/index.d.ts +0 -91
  402. package/dist/esm/pagination/index.js +0 -77
  403. package/dist/esm/routing/helpers.d.ts +0 -57
  404. package/dist/esm/routing/index.d.ts +0 -290
  405. package/dist/esm/routing/index.js +0 -246
  406. package/dist/esm/routing/validators/zod.d.ts +0 -4
  407. package/dist/esm/routing/validators/zod.js +0 -10
  408. package/dist/esm/services/accountsGateway/index.d.ts +0 -92
  409. package/dist/esm/services/accountsGateway/index.js +0 -131
  410. package/dist/esm/services/apiGateway/index.d.ts +0 -68
  411. package/dist/esm/services/apiGateway/index.js +0 -77
  412. package/dist/esm/services/authProvider/browser.d.ts +0 -40
  413. package/dist/esm/services/authProvider/browser.js +0 -151
  414. package/dist/esm/services/authProvider/decryption.d.ts +0 -19
  415. package/dist/esm/services/authProvider/decryption.js +0 -69
  416. package/dist/esm/services/authProvider/index.d.ts +0 -63
  417. package/dist/esm/services/authProvider/index.js +0 -26
  418. package/dist/esm/services/authProvider/subrequest.d.ts +0 -13
  419. package/dist/esm/services/authProvider/subrequest.js +0 -45
  420. package/dist/esm/services/authProvider/utils/decryptAndVerify.d.ts +0 -28
  421. package/dist/esm/services/authProvider/utils/decryptAndVerify.js +0 -85
  422. package/dist/esm/services/authProvider/utils/embeddedAuthProvider.d.ts +0 -26
  423. package/dist/esm/services/authProvider/utils/embeddedAuthProvider.js +0 -40
  424. package/dist/esm/services/authProvider/utils/userRoleValidator.d.ts +0 -13
  425. package/dist/esm/services/authProvider/utils/userRoleValidator.js +0 -33
  426. package/dist/esm/services/authProvider/utils/userSubrequest.d.ts +0 -3
  427. package/dist/esm/services/authProvider/utils/userSubrequest.js +0 -6
  428. package/dist/esm/services/documentStore/dynamoEncoding.d.ts +0 -10
  429. package/dist/esm/services/documentStore/dynamoEncoding.js +0 -45
  430. package/dist/esm/services/documentStore/fileSystemAssert.d.ts +0 -1
  431. package/dist/esm/services/documentStore/fileSystemAssert.js +0 -10
  432. package/dist/esm/services/documentStore/index.d.ts +0 -14
  433. package/dist/esm/services/documentStore/index.js +0 -1
  434. package/dist/esm/services/documentStore/unversioned/dynamodb.d.ts +0 -31
  435. package/dist/esm/services/documentStore/unversioned/dynamodb.js +0 -226
  436. package/dist/esm/services/documentStore/unversioned/file-system.d.ts +0 -32
  437. package/dist/esm/services/documentStore/unversioned/file-system.js +0 -174
  438. package/dist/esm/services/documentStore/unversioned/index.d.ts +0 -2
  439. package/dist/esm/services/documentStore/unversioned/index.js +0 -1
  440. package/dist/esm/services/documentStore/versioned/dynamodb.d.ts +0 -25
  441. package/dist/esm/services/documentStore/versioned/dynamodb.js +0 -139
  442. package/dist/esm/services/documentStore/versioned/file-system.d.ts +0 -25
  443. package/dist/esm/services/documentStore/versioned/file-system.js +0 -69
  444. package/dist/esm/services/documentStore/versioned/index.d.ts +0 -17
  445. package/dist/esm/services/documentStore/versioned/index.js +0 -1
  446. package/dist/esm/services/exercisesGateway/index.d.ts +0 -67
  447. package/dist/esm/services/exercisesGateway/index.js +0 -70
  448. package/dist/esm/services/fileServer/index.d.ts +0 -30
  449. package/dist/esm/services/fileServer/index.js +0 -13
  450. package/dist/esm/services/fileServer/localFileServer.d.ts +0 -13
  451. package/dist/esm/services/fileServer/localFileServer.js +0 -125
  452. package/dist/esm/services/fileServer/s3FileServer.d.ts +0 -14
  453. package/dist/esm/services/fileServer/s3FileServer.js +0 -124
  454. package/dist/esm/services/launchParams/index.d.ts +0 -2
  455. package/dist/esm/services/launchParams/index.js +0 -2
  456. package/dist/esm/services/launchParams/signer.d.ts +0 -23
  457. package/dist/esm/services/launchParams/signer.js +0 -51
  458. package/dist/esm/services/launchParams/verifier.d.ts +0 -21
  459. package/dist/esm/services/launchParams/verifier.js +0 -92
  460. package/dist/esm/services/logger/console.d.ts +0 -4
  461. package/dist/esm/services/logger/index.js +0 -27
  462. package/dist/esm/services/lrsGateway/addStatementDefaultFields.d.ts +0 -5
  463. package/dist/esm/services/lrsGateway/addStatementDefaultFields.js +0 -14
  464. package/dist/esm/services/lrsGateway/attempt-utils.d.ts +0 -70
  465. package/dist/esm/services/lrsGateway/attempt-utils.js +0 -236
  466. package/dist/esm/services/lrsGateway/file-system.d.ts +0 -15
  467. package/dist/esm/services/lrsGateway/file-system.js +0 -110
  468. package/dist/esm/services/lrsGateway/index.d.ts +0 -122
  469. package/dist/esm/services/lrsGateway/index.js +0 -111
  470. package/dist/esm/services/lrsGateway/xapiUtils.d.ts +0 -68
  471. package/dist/esm/services/lrsGateway/xapiUtils.js +0 -99
  472. package/dist/esm/services/postgresConnection/index.d.ts +0 -28
  473. package/dist/esm/services/postgresConnection/index.js +0 -58
  474. package/dist/esm/services/searchProvider/index.d.ts +0 -67
  475. package/dist/esm/services/searchProvider/index.js +0 -1
  476. package/dist/esm/services/searchProvider/memorySearchTheBadWay.d.ts +0 -20
  477. package/dist/esm/services/searchProvider/memorySearchTheBadWay.js +0 -187
  478. package/dist/esm/services/searchProvider/openSearch.d.ts +0 -28
  479. package/dist/esm/services/searchProvider/openSearch.js +0 -150
  480. package/dist/esm/tsconfig.without-specs.esm.tsbuildinfo +0 -1
  481. package/dist/esm/types.js +0 -1
  482. /package/{script → packages/utils/script}/bin/copy-from-template.bash +0 -0
  483. /package/{script → packages/utils/script}/bin/delete-stack.bash +0 -0
  484. /package/{script → packages/utils/script}/bin/deploy.bash +0 -0
  485. /package/{script → packages/utils/script}/bin/destroy-deployment.bash +0 -0
  486. /package/{script → packages/utils/script}/bin/empty-bucket.bash +0 -0
  487. /package/{script → packages/utils/script}/bin/get-arg.bash +0 -0
  488. /package/{script → packages/utils/script}/bin/get-deployed-environments.bash +0 -0
  489. /package/{script → packages/utils/script}/bin/get-env-param.bash +0 -0
  490. /package/{script → packages/utils/script}/bin/get-kwarg.bash +0 -0
  491. /package/{script → packages/utils/script}/bin/get-stack-param.bash +0 -0
  492. /package/{script → packages/utils/script}/bin/has-flag.bash +0 -0
  493. /package/{script → packages/utils/script}/bin/init-constants-script.bash +0 -0
  494. /package/{script → packages/utils/script}/bin/init-params-script.bash +0 -0
  495. /package/{script → packages/utils/script}/bin/stack-exists.bash +0 -0
  496. /package/{script → packages/utils/script}/bin/update-utils.bash +0 -0
  497. /package/{script → packages/utils/script}/bin/upload-pager-duty-endpoints.bash +0 -0
  498. /package/{script → packages/utils/script}/bin/upload-params.bash +0 -0
  499. /package/{script → packages/utils/script}/bin/which.bash +0 -0
  500. /package/{script → packages/utils/script}/bin-entry.bash +0 -0
  501. /package/{script → packages/utils/script}/build.bash +0 -0
  502. /package/{dist/cjs/index.d.ts → packages/utils/src/index.ts} +0 -0
  503. /package/{dist/cjs/services/launchParams/index.d.ts → packages/utils/src/services/launchParams/index.ts} +0 -0
@@ -0,0 +1,189 @@
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
+ };
@@ -0,0 +1,21 @@
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
@@ -0,0 +1,391 @@
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
+ });