@openstax/ts-utils 1.33.1 → 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 (504) 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 -132
  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 -125
  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/bin/.init-params-script.bash.swp +0 -0
  483. /package/{script → packages/utils/script}/bin/copy-from-template.bash +0 -0
  484. /package/{script → packages/utils/script}/bin/delete-stack.bash +0 -0
  485. /package/{script → packages/utils/script}/bin/deploy.bash +0 -0
  486. /package/{script → packages/utils/script}/bin/destroy-deployment.bash +0 -0
  487. /package/{script → packages/utils/script}/bin/empty-bucket.bash +0 -0
  488. /package/{script → packages/utils/script}/bin/get-arg.bash +0 -0
  489. /package/{script → packages/utils/script}/bin/get-deployed-environments.bash +0 -0
  490. /package/{script → packages/utils/script}/bin/get-env-param.bash +0 -0
  491. /package/{script → packages/utils/script}/bin/get-kwarg.bash +0 -0
  492. /package/{script → packages/utils/script}/bin/get-stack-param.bash +0 -0
  493. /package/{script → packages/utils/script}/bin/has-flag.bash +0 -0
  494. /package/{script → packages/utils/script}/bin/init-constants-script.bash +0 -0
  495. /package/{script → packages/utils/script}/bin/init-params-script.bash +0 -0
  496. /package/{script → packages/utils/script}/bin/stack-exists.bash +0 -0
  497. /package/{script → packages/utils/script}/bin/update-utils.bash +0 -0
  498. /package/{script → packages/utils/script}/bin/upload-pager-duty-endpoints.bash +0 -0
  499. /package/{script → packages/utils/script}/bin/upload-params.bash +0 -0
  500. /package/{script → packages/utils/script}/bin/which.bash +0 -0
  501. /package/{script → packages/utils/script}/bin-entry.bash +0 -0
  502. /package/{script → packages/utils/script}/build.bash +0 -0
  503. /package/{dist/cjs/index.d.ts → packages/utils/src/index.ts} +0 -0
  504. /package/{dist/cjs/services/launchParams/index.d.ts → packages/utils/src/services/launchParams/index.ts} +0 -0
@@ -0,0 +1,194 @@
1
+ import * as fsModule from 'fs';
2
+ import path from 'path';
3
+ import { Config, TDocument } from '..';
4
+ import { HashValue, hashValue } from '../../..';
5
+ import { ConfigProviderForConfig, resolveConfigValue } from '../../../config';
6
+ import { ConflictError, NotFoundError } from '../../../errors';
7
+ import { ifDefined, isDefined } from '../../../guards';
8
+ import { assertNoUndefined } from '../fileSystemAssert';
9
+
10
+ interface Initializer<C> {
11
+ dataDir: string;
12
+ fs?: Pick<typeof import('fs'), 'mkdir' | 'readdir' | 'readFile' | 'writeFile'>;
13
+ configSpace?: C;
14
+ }
15
+
16
+ export const fileSystemUnversionedDocumentStore = <C extends string = 'fileSystem'>(initializer: Initializer<C>) => <T extends TDocument<T>>() => (configProvider: {[_key in C]: ConfigProviderForConfig<Config>}) => <K extends keyof T>(_: {}, hashKey: K, options?: {afterWrite?: (item: T) => void | Promise<void>; batchAfterWrite?: (items: T[]) => void | Promise<void>; skipAssert?: boolean}) => {
17
+ const tableName = resolveConfigValue(configProvider[initializer.configSpace || 'fileSystem' as C].tableName);
18
+ const tablePath = tableName.then((table) => path.join(initializer.dataDir, table));
19
+ const { mkdir, readdir, readFile, writeFile } = ifDefined(initializer.fs, fsModule);
20
+ const skipAssert = options?.skipAssert ?? false;
21
+
22
+ const mkTableDir = new Promise<void>((resolve, reject) => tablePath.then(
23
+ (path) => mkdir(path, { recursive: true }, (err) =>
24
+ err && err.code !== 'EEXIST' ? reject(err) : resolve()
25
+ )
26
+ ));
27
+
28
+ const hashFilename = (value: HashValue) => `${hashValue(value)}.json`;
29
+
30
+ const filePath = async(filename: string) => path.join(await tablePath, filename);
31
+
32
+ const load = async(filename: string) => {
33
+ const path = await filePath(filename);
34
+ await mkTableDir;
35
+
36
+ return new Promise<T | undefined>((resolve, reject) => {
37
+ readFile(path, (err, readData) => {
38
+ if (err) {
39
+ err.code === 'ENOENT' ? resolve(undefined) : reject(err);
40
+ } else {
41
+ try {
42
+ const data = JSON.parse(readData.toString());
43
+ typeof data === 'object' ? resolve(data) : reject(new Error('unexpected non-object JSON'));
44
+ } catch (err) {
45
+ reject(err);
46
+ }
47
+ }
48
+ });
49
+ });
50
+ };
51
+
52
+ const loadAllDocumentsTheBadWay = async() => {
53
+ const path = await tablePath;
54
+ await mkTableDir;
55
+
56
+ return new Promise<T[]>((resolve, reject) => readdir(path, (err, files) => err ?
57
+ reject(err) :
58
+ Promise.all(files.map((file) => load(file)))
59
+ .then((allData) => resolve(allData.filter(isDefined)), (err) => reject(err))
60
+ ));
61
+ };
62
+
63
+ return {
64
+ loadAllDocumentsTheBadWay,
65
+ getItemsByField: async(key: keyof T, value: T[K], pageKey?: string) => {
66
+ if (!skipAssert) assertNoUndefined(value, [key as string]);
67
+ const pageSize = 10;
68
+ const items = await loadAllDocumentsTheBadWay();
69
+ const filteredItems = items.filter((item) => item[key] === value);
70
+ const startIndex = pageKey ? parseInt(pageKey, 10) : 0;
71
+ const paginatedItems = filteredItems.slice(startIndex, startIndex + pageSize);
72
+ const nextPageToken = startIndex + pageSize < filteredItems.length
73
+ ? (startIndex + pageSize).toString()
74
+ : undefined;
75
+ return { items: paginatedItems, nextPageToken };
76
+ },
77
+ batchGetItem: async(ids: T[K][]) => {
78
+ const items = await Promise.all(ids.map((id) => {
79
+ if (!skipAssert) assertNoUndefined(id, ['id']);
80
+ return load(hashFilename(id));
81
+ }));
82
+ return items.filter(isDefined);
83
+ },
84
+ getItem: (id: T[K]) => {
85
+ if (!skipAssert) assertNoUndefined(id, ['id']);
86
+ return load(hashFilename(id));
87
+ },
88
+ incrementItemAttribute: async(id: T[K], attribute: keyof T) => {
89
+ if (!skipAssert) assertNoUndefined(id, ['id']);
90
+ const filename = hashFilename(id);
91
+ const path = await filePath(filename);
92
+ await mkTableDir;
93
+
94
+ const data = await load(filename);
95
+ if (!data) { throw new NotFoundError(`Item with ${hashKey.toString()} "${id}" does not exist`); }
96
+
97
+ const newValue = typeof data[attribute] === 'number' ? data[attribute] as number + 1 : 1;
98
+ const newItem = {...data, [hashKey]: id, [attribute]: newValue};
99
+
100
+ return new Promise<number>((resolve, reject) => {
101
+ writeFile(path, JSON.stringify(newItem, null, 2), (err) => err ? reject(err) : resolve(newValue));
102
+ });
103
+ },
104
+ patchItem: async(item: Partial<T>) => {
105
+ const id = item[hashKey];
106
+ if (!id) { throw new Error(`Key attribute "${hashKey.toString()}" is required for patchItem`); }
107
+
108
+ // This check is just to make this adapter consistent with the dynamo adapter
109
+ if (Object.keys(item).filter((key) => key !== hashKey.toString()).length === 0) {
110
+ throw new Error('No attributes to update');
111
+ }
112
+
113
+ const filename = hashFilename(id);
114
+ const path = await filePath(filename);
115
+ await mkTableDir;
116
+
117
+ const data = await load(filename);
118
+ if (!data) { throw new NotFoundError(`Item with ${hashKey.toString()} "${id}" does not exist`); }
119
+
120
+ const newItem = {...data, ...item};
121
+ if (!skipAssert) assertNoUndefined(newItem);
122
+
123
+ return new Promise<T>((resolve, reject) => {
124
+ writeFile(path, JSON.stringify(newItem, null, 2), (err) => err ? reject(err) : resolve(newItem));
125
+ });
126
+ },
127
+ putItem: async(item: T) => {
128
+ if (!skipAssert) assertNoUndefined(item);
129
+ const path = await filePath(hashFilename(item[hashKey]));
130
+ await mkTableDir;
131
+
132
+ return new Promise<T>((resolve, reject) => {
133
+ writeFile(path, JSON.stringify(item, null, 2), (err) => err ? reject(err) : resolve(item));
134
+ });
135
+ },
136
+ createItem: async(item: T) => {
137
+ if (!skipAssert) assertNoUndefined(item);
138
+ const hashed = hashFilename(item[hashKey]);
139
+ const existingItem = await load(hashed);
140
+ if (existingItem) {
141
+ throw new ConflictError(`Item with ${String(hashKey)} "${item[hashKey]}" already exists`);
142
+ }
143
+
144
+ const path = await filePath(hashed);
145
+ await mkTableDir;
146
+
147
+ return new Promise<T>((resolve, reject) => {
148
+ writeFile(path, JSON.stringify(item, null, 2), (err) => err ? reject(err) : resolve(item));
149
+ });
150
+ },
151
+ batchCreateItem: async(items: T[], _concurrency = 1): Promise<{successful: T[]; failed: Array<{item: T; error: Error}>}> => {
152
+ if (items.length === 0) return { successful: [], failed: [] };
153
+
154
+ const successful: T[] = [];
155
+ const failed: Array<{item: T; error: Error}> = [];
156
+
157
+ // Process items sequentially to ensure consistent conflict detection
158
+ // Note: concurrency parameter is ignored for filesystem to avoid race conditions
159
+ for (const item of items) {
160
+ if (!skipAssert) assertNoUndefined(item);
161
+ try {
162
+ const hashed = hashFilename(item[hashKey]);
163
+ const existingItem = await load(hashed);
164
+ if (existingItem) {
165
+ throw new ConflictError(`Item with ${String(hashKey)} "${item[hashKey]}" already exists`);
166
+ }
167
+
168
+ const path = await filePath(hashed);
169
+ await mkTableDir;
170
+
171
+ const createdItem = await new Promise<T>((resolve, reject) => {
172
+ writeFile(path, JSON.stringify(item, null, 2), (err) => err ? reject(err) : resolve(item));
173
+ });
174
+
175
+ successful.push(createdItem);
176
+
177
+ // Only call individual afterWrite if batchAfterWrite is not defined
178
+ if (!options?.batchAfterWrite) {
179
+ await options?.afterWrite?.(createdItem);
180
+ }
181
+ } catch (error) {
182
+ failed.push({ item, error: error as Error });
183
+ }
184
+ }
185
+
186
+ // Call batchAfterWrite with all successful items if defined
187
+ if (options?.batchAfterWrite && successful.length > 0) {
188
+ await options.batchAfterWrite(successful);
189
+ }
190
+
191
+ return { successful, failed };
192
+ },
193
+ };
194
+ };
@@ -1,2 +1,4 @@
1
+ /* istanbul ignore file */
1
2
  import { dynamoUnversionedDocumentStore } from './dynamodb';
3
+
2
4
  export type UnversionedDocumentStoreCreator = typeof dynamoUnversionedDocumentStore;
@@ -0,0 +1,13 @@
1
+ # VersionedDocumentStore
2
+
3
+ a key value document store where all writes are new versions of documents and a version history can be fetched. the interface accepts a `getAuthor` argument at the driver level so you can provide some automatic audit logging for writes, if you don't provide that you have to provide the author information on every call to putItem.
4
+
5
+ ## drivers
6
+
7
+ ### dynamo
8
+
9
+ production driver, the entity key is the hash key and the version timestamp is the range key, getItem just fetches the last element of the range in one read, while getVersions paginates through the whole range.
10
+
11
+ ### fileSystem
12
+
13
+ just matches the interface over dumping everything in a json file on disk
@@ -0,0 +1,376 @@
1
+ import * as awsSdk from '@aws-sdk/client-dynamodb';
2
+ import { dynamoVersionedDocumentStore } from './dynamodb';
3
+ import { VersionedDocumentRequiredFields } from '.';
4
+
5
+ jest.mock('@aws-sdk/client-dynamodb', () => {
6
+ const sendSpy = jest.fn(() => Promise.resolve()) as any;
7
+ return {
8
+ ...jest.requireActual('@aws-sdk/client-dynamodb'),
9
+ DynamoDB: class {
10
+ static sendSpy = sendSpy;
11
+ send(...a: any[]) { return sendSpy(...a); }
12
+ }
13
+ };
14
+ });
15
+
16
+ type TTestDocument = {
17
+ coolId: string;
18
+ maybe?: null;
19
+ name: string;
20
+ strings?: string[];
21
+ isCool?: boolean;
22
+ } & VersionedDocumentRequiredFields;
23
+
24
+ describe('dynamoVersionedDocumentStore', () => {
25
+ const sendSpy: jest.SpyInstance = (awsSdk.DynamoDB as any).sendSpy;
26
+ const config = {dynamodb: {tableName: 'cool-table-name'}};
27
+ const middleware = {};
28
+ let mockDynamoClient: awsSdk.DynamoDB;
29
+ let mockClientSend: jest.SpyInstance;
30
+
31
+ beforeEach(() => {
32
+ mockClientSend = jest.fn();
33
+ mockDynamoClient = {send: mockClientSend} as unknown as awsSdk.DynamoDB;
34
+ });
35
+
36
+ afterEach(() => {
37
+ jest.clearAllMocks();
38
+ });
39
+
40
+ describe('loadAllDocumentsTheBadWay', () => {
41
+ it('loads pages of documents', async() => {
42
+ const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
43
+
44
+ sendSpy.mockReturnValueOnce(Promise.resolve({
45
+ LastEvaluatedKey: {
46
+ coolId: {S: 'my-document-id'},
47
+ timestamp: {N: '123'},
48
+ },
49
+ Items: [
50
+ {
51
+ coolId: {S: 'my-document-id'},
52
+ timestamp: {N: '123'},
53
+ author: {M: {type: {S: 'system'}, reason: {S: 'testing'}}},
54
+ name: {S: 'my-doc-old'},
55
+ },
56
+ {
57
+ coolId: {S: 'my-document-id'},
58
+ timestamp: {N: '124'},
59
+ author: {M: {type: {S: 'system'}, reason: {S: 'testing'}}},
60
+ name: {S: 'my-doc-new'},
61
+ },
62
+ {
63
+ coolId: {S: 'my-document-id'},
64
+ timestamp: {N: '122'},
65
+ author: {M: {type: {S: 'system'}, reason: {S: 'testing'}}},
66
+ name: {S: 'my-doc-old'},
67
+ }
68
+ ]
69
+ }));
70
+ sendSpy.mockReturnValueOnce(Promise.resolve({
71
+ Items: [
72
+ {
73
+ coolId: {S: 'my-document-id-two'},
74
+ timestamp: {N: '123'},
75
+ author: {M: {type: {S: 'system'}, reason: {S: 'testing'}}},
76
+ name: {S: 'my-doc-two'},
77
+ }
78
+ ]
79
+ }));
80
+
81
+ expect(await store.loadAllDocumentsTheBadWay()).toEqual([
82
+ {
83
+ coolId: 'my-document-id',
84
+ timestamp: 124,
85
+ author: {type: 'system', reason: 'testing'},
86
+ name: 'my-doc-new',
87
+ },
88
+ {
89
+ coolId: 'my-document-id-two',
90
+ timestamp: 123,
91
+ author: {type: 'system', reason: 'testing'},
92
+ name: 'my-doc-two',
93
+ }
94
+ ]);
95
+ });
96
+
97
+ it('handles null items', async() => {
98
+ const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
99
+ sendSpy.mockReturnValueOnce(Promise.resolve({
100
+ }));
101
+ expect(await store.loadAllDocumentsTheBadWay()).toEqual([
102
+ ]);
103
+ });
104
+ });
105
+
106
+ describe('getItem', () => {
107
+ it('gets document', async() => {
108
+ const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
109
+
110
+ sendSpy.mockReturnValue(Promise.resolve({Items: [{
111
+ coolId: {S: 'my-document-id'},
112
+ timestamp: {N: '123'},
113
+ maybe: {NULL: true},
114
+ strings: {L: [{S: 'string1'}, {S: 'string2'}]},
115
+ author: {M: {type: {S: 'system'}, reason: {S: 'testing'}}},
116
+ name: {S: 'my-doc'},
117
+ isCool: {BOOL: true}
118
+ }]}));
119
+
120
+ expect(await store.getItem('my-document-id')).toEqual({
121
+ coolId: 'my-document-id',
122
+ timestamp: 123,
123
+ maybe: null,
124
+ strings: ['string1', 'string2'],
125
+ author: {type: 'system', reason: 'testing'},
126
+ name: 'my-doc',
127
+ isCool: true
128
+ });
129
+ });
130
+
131
+ it('can get a specific version', async() => {
132
+ const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
133
+
134
+ sendSpy.mockReturnValue(Promise.resolve({Items: [{
135
+ coolId: {S: 'my-document-id'},
136
+ timestamp: {N: '123'},
137
+ maybe: {NULL: true},
138
+ strings: {L: [{S: 'string1'}, {S: 'string2'}]},
139
+ author: {M: {type: {S: 'system'}, reason: {S: 'testing'}}},
140
+ name: {S: 'my-doc'},
141
+ isCool: {BOOL: true}
142
+ }]}));
143
+
144
+ expect(await store.getItem('my-document-id', 123)).toEqual({
145
+ coolId: 'my-document-id',
146
+ timestamp: 123,
147
+ maybe: null,
148
+ strings: ['string1', 'string2'],
149
+ author: {type: 'system', reason: 'testing'},
150
+ name: 'my-doc',
151
+ isCool: true
152
+ });
153
+ });
154
+
155
+ it('gets undefined for missing document', async() => {
156
+ const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
157
+ sendSpy.mockReturnValue(Promise.resolve({}));
158
+ expect(await store.getItem('my-document-id')).toBeUndefined();
159
+ });
160
+
161
+ it('throws on weirdo data types', async() => {
162
+ const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
163
+ sendSpy.mockReturnValue(Promise.resolve({Items: [{
164
+ isCool: {NOT_A_REAL_TYPE: true}
165
+ }]}));
166
+
167
+ await expect(async() => store.getItem('my-document-id')).rejects.toThrow();
168
+ });
169
+ });
170
+
171
+ describe('putItem', () => {
172
+ beforeAll(() => {
173
+ jest.useFakeTimers();
174
+ jest.setSystemTime(new Date(2020, 6, 28));
175
+ });
176
+
177
+ afterAll(() => {
178
+ jest.useRealTimers();
179
+ });
180
+
181
+ it('saves document', async() => {
182
+ const testDoc = {coolId: 'my-document-id', name: 'my-doc', isCool: false, maybe: null, strings: ['string1', 'string2']};
183
+ const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId');
184
+ await store.putItem(testDoc, {type: 'system', reason: 'testing'});
185
+ expect(sendSpy).toHaveBeenCalledWith(expect.objectContaining({
186
+ input: {
187
+ TableName: 'cool-table-name',
188
+ Item: {
189
+ coolId: {S: 'my-document-id'},
190
+ timestamp: {N: '1595894400000'},
191
+ strings: {L: [{S: 'string1'}, {S: 'string2'}]},
192
+ maybe: {NULL: true},
193
+ author: {M: {type: {S: 'system'}, reason: {S: 'testing'}}},
194
+ name: {S: 'my-doc'},
195
+ isCool: {BOOL: false}
196
+ }
197
+ }
198
+ }));
199
+ });
200
+
201
+ it('calls afterWrite', async() => {
202
+ const afterWrite = jest.fn();
203
+ const testDoc = {coolId: 'my-document-id', name: 'my-doc', isCool: false, maybe: null, strings: ['string1', 'string2']};
204
+ const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', {afterWrite});
205
+ await store.putItem(testDoc, {type: 'system', reason: 'testing'});
206
+ expect(afterWrite).toHaveBeenCalledWith(expect.objectContaining({
207
+ ...testDoc,
208
+ author: {type: 'system', reason: 'testing'},
209
+ timestamp: 1595894400000,
210
+ }));
211
+ });
212
+
213
+ it('returns new document', async() => {
214
+ const testDoc = {coolId: 'my-document-id', name: 'my-doc'};
215
+ const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId');
216
+ const result = await store.putItem(testDoc, {type: 'system', reason: 'testing'});
217
+ expect(result).toEqual({...testDoc, timestamp: expect.any(Number), author: {type: 'system', reason: 'testing'}});
218
+ });
219
+
220
+ it('throws on weirdo data types', async() => {
221
+ const testDoc = {coolId: 'my-document-id', name: 'my-doc', foobar: Buffer.from('asdf')};
222
+ const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
223
+ await expect(async() => store.putItem(testDoc, {type: 'system', reason: 'testing'})).rejects.toThrow();
224
+ });
225
+
226
+ it('uses author provider', async() => {
227
+ const testDoc = {coolId: 'my-document-id', name: 'my-doc'};
228
+ const getAuthor = (name: string) => Promise.resolve({type: 'user' as const, name, uuid: 'a uuid'});
229
+ const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', {getAuthor});
230
+ const result = await store.putItem(testDoc, 'a name');
231
+ expect(result).toEqual({...testDoc, timestamp: expect.any(Number), author: {type: 'user', name: 'a name', uuid: 'a uuid'}});
232
+ });
233
+ });
234
+
235
+ describe('prepareItem', () => {
236
+ beforeAll(() => {
237
+ jest.useFakeTimers();
238
+ jest.setSystemTime(new Date(2020, 6, 28));
239
+ });
240
+
241
+ afterAll(() => {
242
+ jest.useRealTimers();
243
+ });
244
+
245
+ it('saves document', async() => {
246
+ const testDoc = {coolId: 'my-document-id', name: 'my-doc', isCool: false, maybe: null, strings: ['string1', 'string2']};
247
+ const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
248
+ const {save} = await store.prepareItem(testDoc, {type: 'system', reason: 'testing'});
249
+ await save();
250
+ expect(sendSpy).toHaveBeenCalledWith(expect.objectContaining({
251
+ input: {
252
+ TableName: 'cool-table-name',
253
+ Item: {
254
+ coolId: {S: 'my-document-id'},
255
+ timestamp: {N: '1595894400000'},
256
+ strings: {L: [{S: 'string1'}, {S: 'string2'}]},
257
+ maybe: {NULL: true},
258
+ author: {M: {type: {S: 'system'}, reason: {S: 'testing'}}},
259
+ name: {S: 'my-doc'},
260
+ isCool: {BOOL: false}
261
+ }
262
+ }
263
+ }));
264
+ });
265
+
266
+ it('calls afterWrite', async() => {
267
+ const afterWrite = jest.fn();
268
+ const testDoc = {coolId: 'my-document-id', name: 'my-doc', isCool: false, maybe: null, strings: ['string1', 'string2']};
269
+ const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', {afterWrite});
270
+ const {save} = await store.prepareItem(testDoc, {type: 'system', reason: 'testing'});
271
+ expect(await save()).toEqual(expect.objectContaining({
272
+ ...testDoc,
273
+ author: {type: 'system', reason: 'testing'},
274
+ timestamp: 1595894400000,
275
+ }));
276
+ });
277
+
278
+ it('returns new document', async() => {
279
+ const testDoc = {coolId: 'my-document-id', name: 'my-doc'};
280
+ const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId');
281
+ const {document} = await store.prepareItem(testDoc, {type: 'system', reason: 'testing'});
282
+ expect(document).toEqual({...testDoc, timestamp: expect.any(Number), author: {type: 'system', reason: 'testing'}});
283
+ });
284
+
285
+ it('uses author provider', async() => {
286
+ const testDoc = {coolId: 'my-document-id', name: 'my-doc'};
287
+ const getAuthor = (name: string) => Promise.resolve({type: 'user' as const, name, uuid: 'a uuid'});
288
+ const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', {getAuthor});
289
+ const {document} = await store.prepareItem(testDoc, 'a name');
290
+ expect(document).toEqual({...testDoc, timestamp: expect.any(Number), author: {type: 'user', name: 'a name', uuid: 'a uuid'}});
291
+ });
292
+ });
293
+
294
+ describe('custom client', () => {
295
+ it('uses provided dynamodb client', async() => {
296
+ const customSendSpy = jest.fn().mockResolvedValue({Items: [{coolId: {S: 'test-id'}}]});
297
+ mockDynamoClient.send = customSendSpy;
298
+
299
+ const store = dynamoVersionedDocumentStore({dynamoClient: mockDynamoClient})<TTestDocument>()(config)(middleware, 'coolId', undefined);
300
+ await store.getItem('test-id');
301
+
302
+ expect(customSendSpy).toHaveBeenCalled();
303
+ expect(sendSpy).not.toHaveBeenCalled();
304
+ });
305
+ });
306
+
307
+ describe('getVersions', () => {
308
+ it('gets versions for document', async() => {
309
+ const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
310
+
311
+ sendSpy.mockReturnValue(Promise.resolve({Items: [
312
+ {
313
+ coolId: {S: 'my-document-id'},
314
+ timestamp: {N: '123'},
315
+ name: {S: 'my-doc'}
316
+ },
317
+ {
318
+ coolId: {S: 'my-document-id'},
319
+ timestamp: {N: '234'},
320
+ name: {S: 'my-doc'}
321
+ }
322
+ ]}));
323
+
324
+ expect(await store.getVersions('my-document-id')).toEqual({
325
+ items: [
326
+ {coolId: 'my-document-id', name: 'my-doc', timestamp: 123},
327
+ {coolId: 'my-document-id', name: 'my-doc', timestamp: 234}
328
+ ]
329
+ });
330
+ });
331
+
332
+ it('gets next page token', async() => {
333
+ const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
334
+
335
+ sendSpy.mockReturnValue(Promise.resolve({
336
+ LastEvaluatedKey: {
337
+ coolId: {S: 'my-document-id'},
338
+ timestamp: {N: '123'},
339
+ },
340
+ Items: [
341
+ {
342
+ coolId: {S: 'my-document-id'},
343
+ timestamp: {N: '234'},
344
+ name: {S: 'my-doc'}
345
+ }
346
+ ]}));
347
+
348
+ expect(await store.getVersions('my-document-id')).toEqual(expect.objectContaining({
349
+ nextPageToken: 123,
350
+ }));
351
+ });
352
+
353
+ it('gets undefined for unknown document id', async() => {
354
+ const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
355
+ sendSpy.mockReturnValue(Promise.resolve({}));
356
+ expect(await store.getVersions('my-document-id')).toBeUndefined();
357
+ sendSpy.mockReturnValue(Promise.resolve({Items: []}));
358
+ expect(await store.getVersions('my-document-id')).toBeUndefined();
359
+ });
360
+
361
+ it('gets version with indicated start point', async() => {
362
+ const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
363
+ sendSpy.mockReturnValue(Promise.resolve({}));
364
+ await store.getVersions('my-document-id', 123);
365
+
366
+ expect(sendSpy).toHaveBeenCalledWith(expect.objectContaining({
367
+ input: expect.objectContaining({
368
+ ExclusiveStartKey: {
369
+ coolId: {S: 'my-document-id'},
370
+ timestamp: {N: '123'}
371
+ }
372
+ })
373
+ }));
374
+ });
375
+ });
376
+ });