@openstax/ts-utils 1.34.0 → 1.35.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (507) hide show
  1. package/README.md +90 -62
  2. package/dist/cjs/assertions/index.d.ts +89 -0
  3. package/dist/cjs/assertions/index.js +157 -0
  4. package/dist/cjs/aws/ssmService.d.ts +5 -0
  5. package/dist/cjs/aws/ssmService.js +9 -0
  6. package/dist/cjs/config/awsParameterConfig.d.ts +10 -0
  7. package/dist/cjs/config/awsParameterConfig.js +26 -0
  8. package/dist/cjs/config/envConfig.d.ts +24 -0
  9. package/dist/cjs/config/envConfig.js +57 -0
  10. package/{packages/utils/src/config/index.ts → dist/cjs/config/index.d.ts} +13 -29
  11. package/dist/cjs/config/index.js +35 -0
  12. package/dist/cjs/config/lambdaParameterConfig.d.ts +12 -0
  13. package/dist/cjs/config/lambdaParameterConfig.js +45 -0
  14. package/dist/cjs/config/replaceConfig.d.ts +14 -0
  15. package/dist/cjs/config/replaceConfig.js +22 -0
  16. package/dist/cjs/config/resolveConfigValue.d.ts +5 -0
  17. package/dist/cjs/config/resolveConfigValue.js +12 -0
  18. package/dist/cjs/errors/index.d.ts +88 -0
  19. package/dist/cjs/errors/index.js +123 -0
  20. package/dist/cjs/fetch/fetchStatusRetry.d.ts +8 -0
  21. package/dist/cjs/fetch/fetchStatusRetry.js +27 -0
  22. package/dist/cjs/fetch/index.d.ts +64 -0
  23. package/dist/cjs/fetch/index.js +55 -0
  24. package/{packages/utils/src/guards/index.ts → dist/cjs/guards/index.d.ts} +7 -10
  25. package/dist/cjs/guards/index.js +44 -0
  26. package/dist/cjs/index.js +20 -0
  27. package/dist/cjs/middleware/apiErrorHandler.d.ts +24 -0
  28. package/dist/cjs/middleware/apiErrorHandler.js +42 -0
  29. package/dist/cjs/middleware/apiSlowResponseMiddleware.d.ts +23 -0
  30. package/dist/cjs/middleware/apiSlowResponseMiddleware.js +54 -0
  31. package/{packages/utils/src/middleware/index.ts → dist/cjs/middleware/index.d.ts} +5 -53
  32. package/dist/cjs/middleware/index.js +48 -0
  33. package/dist/cjs/middleware/lambdaCorsResponseMiddleware.d.ts +20 -0
  34. package/dist/cjs/middleware/lambdaCorsResponseMiddleware.js +44 -0
  35. package/dist/cjs/middleware/throwNotFoundMiddleware.d.ts +4 -0
  36. package/dist/cjs/middleware/throwNotFoundMiddleware.js +14 -0
  37. package/dist/cjs/misc/hashValue.d.ts +10 -0
  38. package/dist/cjs/misc/hashValue.js +17 -0
  39. package/dist/cjs/misc/helpers.d.ts +124 -0
  40. package/dist/cjs/misc/helpers.js +214 -0
  41. package/dist/cjs/misc/merge.d.ts +21 -0
  42. package/dist/cjs/misc/merge.js +45 -0
  43. package/dist/cjs/misc/partitionSequence.d.ts +35 -0
  44. package/dist/cjs/misc/partitionSequence.js +55 -0
  45. package/dist/cjs/pagination/index.d.ts +91 -0
  46. package/dist/cjs/pagination/index.js +83 -0
  47. package/dist/cjs/routing/helpers.d.ts +57 -0
  48. package/dist/cjs/routing/helpers.js +90 -0
  49. package/dist/cjs/routing/index.d.ts +290 -0
  50. package/dist/cjs/routing/index.js +295 -0
  51. package/dist/cjs/routing/validators/zod.d.ts +4 -0
  52. package/dist/cjs/routing/validators/zod.js +14 -0
  53. package/dist/cjs/services/accountsGateway/index.d.ts +92 -0
  54. package/dist/cjs/services/accountsGateway/index.js +138 -0
  55. package/dist/cjs/services/apiGateway/index.d.ts +68 -0
  56. package/dist/cjs/services/apiGateway/index.js +118 -0
  57. package/dist/cjs/services/authProvider/browser.d.ts +40 -0
  58. package/dist/cjs/services/authProvider/browser.js +155 -0
  59. package/dist/cjs/services/authProvider/decryption.d.ts +19 -0
  60. package/dist/cjs/services/authProvider/decryption.js +73 -0
  61. package/dist/cjs/services/authProvider/index.d.ts +63 -0
  62. package/dist/cjs/services/authProvider/index.js +34 -0
  63. package/dist/cjs/services/authProvider/subrequest.d.ts +13 -0
  64. package/dist/cjs/services/authProvider/subrequest.js +49 -0
  65. package/dist/cjs/services/authProvider/utils/decryptAndVerify.d.ts +28 -0
  66. package/dist/cjs/services/authProvider/utils/decryptAndVerify.js +91 -0
  67. package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.d.ts +26 -0
  68. package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.js +47 -0
  69. package/dist/cjs/services/authProvider/utils/userRoleValidator.d.ts +13 -0
  70. package/dist/cjs/services/authProvider/utils/userRoleValidator.js +37 -0
  71. package/dist/cjs/services/authProvider/utils/userSubrequest.d.ts +3 -0
  72. package/dist/cjs/services/authProvider/utils/userSubrequest.js +13 -0
  73. package/dist/cjs/services/documentStore/dynamoEncoding.d.ts +10 -0
  74. package/dist/cjs/services/documentStore/dynamoEncoding.js +52 -0
  75. package/dist/cjs/services/documentStore/fileSystemAssert.d.ts +1 -0
  76. package/dist/cjs/services/documentStore/fileSystemAssert.js +14 -0
  77. package/{packages/utils/src/services/documentStore/index.ts → dist/cjs/services/documentStore/index.d.ts} +8 -8
  78. package/dist/cjs/services/documentStore/index.js +2 -0
  79. package/dist/cjs/services/documentStore/unversioned/dynamodb.d.ts +31 -0
  80. package/dist/cjs/services/documentStore/unversioned/dynamodb.js +233 -0
  81. package/dist/cjs/services/documentStore/unversioned/file-system.d.ts +32 -0
  82. package/dist/cjs/services/documentStore/unversioned/file-system.js +214 -0
  83. package/{packages/utils/src/services/documentStore/unversioned/index.ts → dist/cjs/services/documentStore/unversioned/index.d.ts} +0 -2
  84. package/dist/cjs/services/documentStore/unversioned/index.js +2 -0
  85. package/dist/cjs/services/documentStore/versioned/dynamodb.d.ts +25 -0
  86. package/dist/cjs/services/documentStore/versioned/dynamodb.js +143 -0
  87. package/dist/cjs/services/documentStore/versioned/file-system.d.ts +25 -0
  88. package/dist/cjs/services/documentStore/versioned/file-system.js +73 -0
  89. package/dist/cjs/services/documentStore/versioned/index.d.ts +17 -0
  90. package/dist/cjs/services/documentStore/versioned/index.js +2 -0
  91. package/dist/cjs/services/exercisesGateway/index.d.ts +67 -0
  92. package/dist/cjs/services/exercisesGateway/index.js +107 -0
  93. package/dist/cjs/services/fileServer/index.d.ts +30 -0
  94. package/dist/cjs/services/fileServer/index.js +19 -0
  95. package/dist/cjs/services/fileServer/localFileServer.d.ts +13 -0
  96. package/dist/cjs/services/fileServer/localFileServer.js +132 -0
  97. package/dist/cjs/services/fileServer/s3FileServer.d.ts +14 -0
  98. package/dist/cjs/services/fileServer/s3FileServer.js +131 -0
  99. package/dist/cjs/services/launchParams/index.js +7 -0
  100. package/dist/cjs/services/launchParams/signer.d.ts +23 -0
  101. package/dist/cjs/services/launchParams/signer.js +58 -0
  102. package/dist/cjs/services/launchParams/verifier.d.ts +21 -0
  103. package/dist/cjs/services/launchParams/verifier.js +129 -0
  104. package/dist/cjs/services/logger/console.d.ts +4 -0
  105. package/dist/cjs/services/logger/console.js +12 -0
  106. package/{packages/utils/src/services/logger/index.ts → dist/cjs/services/logger/index.d.ts} +9 -23
  107. package/dist/cjs/services/logger/index.js +31 -0
  108. package/dist/cjs/services/lrsGateway/addStatementDefaultFields.d.ts +5 -0
  109. package/dist/cjs/services/lrsGateway/addStatementDefaultFields.js +21 -0
  110. package/dist/cjs/services/lrsGateway/attempt-utils.d.ts +72 -0
  111. package/dist/cjs/services/lrsGateway/attempt-utils.js +283 -0
  112. package/dist/cjs/services/lrsGateway/file-system.d.ts +15 -0
  113. package/dist/cjs/services/lrsGateway/file-system.js +150 -0
  114. package/dist/cjs/services/lrsGateway/index.d.ts +122 -0
  115. package/dist/cjs/services/lrsGateway/index.js +148 -0
  116. package/dist/cjs/services/lrsGateway/xapiUtils.d.ts +71 -0
  117. package/dist/cjs/services/lrsGateway/xapiUtils.js +145 -0
  118. package/dist/cjs/services/postgresConnection/index.d.ts +28 -0
  119. package/dist/cjs/services/postgresConnection/index.js +65 -0
  120. package/dist/cjs/services/searchProvider/index.d.ts +69 -0
  121. package/dist/cjs/services/searchProvider/index.js +2 -0
  122. package/dist/cjs/services/searchProvider/memorySearchTheBadWay.d.ts +20 -0
  123. package/dist/cjs/services/searchProvider/memorySearchTheBadWay.js +191 -0
  124. package/dist/cjs/services/searchProvider/openSearch.d.ts +28 -0
  125. package/dist/cjs/services/searchProvider/openSearch.js +162 -0
  126. package/dist/cjs/services/searchProvider/streamIndexer.d.ts +17 -0
  127. package/dist/cjs/services/searchProvider/streamIndexer.js +41 -0
  128. package/dist/cjs/tsconfig.without-specs.cjs.tsbuildinfo +1 -0
  129. package/{packages/utils/src/types.ts → dist/cjs/types.d.ts} +6 -34
  130. package/dist/cjs/types.js +2 -0
  131. package/dist/esm/assertions/index.d.ts +89 -0
  132. package/{packages/utils/src/assertions/index.ts → dist/esm/assertions/index.js} +49 -64
  133. package/dist/esm/aws/ssmService.d.ts +5 -0
  134. package/dist/esm/aws/ssmService.js +6 -0
  135. package/dist/esm/config/awsParameterConfig.d.ts +10 -0
  136. package/dist/esm/config/awsParameterConfig.js +22 -0
  137. package/dist/esm/config/envConfig.d.ts +24 -0
  138. package/dist/esm/config/envConfig.js +53 -0
  139. package/dist/esm/config/index.d.ts +48 -0
  140. package/dist/esm/config/index.js +17 -0
  141. package/dist/esm/config/lambdaParameterConfig.d.ts +12 -0
  142. package/dist/esm/config/lambdaParameterConfig.js +38 -0
  143. package/dist/esm/config/replaceConfig.d.ts +14 -0
  144. package/{packages/utils/src/config/replaceConfig.ts → dist/esm/config/replaceConfig.js} +6 -16
  145. package/dist/esm/config/resolveConfigValue.d.ts +5 -0
  146. package/dist/esm/config/resolveConfigValue.js +8 -0
  147. package/dist/esm/errors/index.d.ts +88 -0
  148. package/{packages/utils/src/errors/index.ts → dist/esm/errors/index.js} +41 -57
  149. package/dist/esm/fetch/fetchStatusRetry.d.ts +8 -0
  150. package/dist/esm/fetch/fetchStatusRetry.js +23 -0
  151. package/dist/esm/fetch/index.d.ts +64 -0
  152. package/dist/esm/fetch/index.js +46 -0
  153. package/dist/esm/guards/index.d.ts +38 -0
  154. package/dist/esm/guards/index.js +36 -0
  155. package/dist/esm/index.d.ts +4 -0
  156. package/dist/esm/index.js +4 -0
  157. package/dist/esm/middleware/apiErrorHandler.d.ts +24 -0
  158. package/dist/esm/middleware/apiErrorHandler.js +38 -0
  159. package/dist/esm/middleware/apiSlowResponseMiddleware.d.ts +23 -0
  160. package/dist/esm/middleware/apiSlowResponseMiddleware.js +50 -0
  161. package/dist/esm/middleware/index.d.ts +47 -0
  162. package/dist/esm/middleware/index.js +44 -0
  163. package/dist/esm/middleware/lambdaCorsResponseMiddleware.d.ts +20 -0
  164. package/dist/esm/middleware/lambdaCorsResponseMiddleware.js +40 -0
  165. package/dist/esm/middleware/throwNotFoundMiddleware.d.ts +4 -0
  166. package/dist/esm/middleware/throwNotFoundMiddleware.js +10 -0
  167. package/dist/esm/misc/hashValue.d.ts +10 -0
  168. package/dist/esm/misc/hashValue.js +13 -0
  169. package/dist/esm/misc/helpers.d.ts +124 -0
  170. package/dist/esm/misc/helpers.js +199 -0
  171. package/dist/esm/misc/merge.d.ts +21 -0
  172. package/dist/esm/misc/merge.js +40 -0
  173. package/dist/esm/misc/partitionSequence.d.ts +35 -0
  174. package/{packages/utils/src/misc/partitionSequence.ts → dist/esm/misc/partitionSequence.js} +15 -23
  175. package/dist/esm/pagination/index.d.ts +91 -0
  176. package/dist/esm/pagination/index.js +77 -0
  177. package/dist/esm/routing/helpers.d.ts +57 -0
  178. package/{packages/utils/src/routing/helpers.ts → dist/esm/routing/helpers.js} +30 -42
  179. package/dist/esm/routing/index.d.ts +290 -0
  180. package/dist/esm/routing/index.js +246 -0
  181. package/dist/esm/routing/validators/zod.d.ts +4 -0
  182. package/dist/esm/routing/validators/zod.js +10 -0
  183. package/dist/esm/services/accountsGateway/index.d.ts +92 -0
  184. package/dist/esm/services/accountsGateway/index.js +131 -0
  185. package/dist/esm/services/apiGateway/index.d.ts +68 -0
  186. package/dist/esm/services/apiGateway/index.js +77 -0
  187. package/dist/esm/services/authProvider/browser.d.ts +40 -0
  188. package/dist/esm/services/authProvider/browser.js +151 -0
  189. package/dist/esm/services/authProvider/decryption.d.ts +19 -0
  190. package/dist/esm/services/authProvider/decryption.js +69 -0
  191. package/dist/esm/services/authProvider/index.d.ts +63 -0
  192. package/dist/esm/services/authProvider/index.js +26 -0
  193. package/dist/esm/services/authProvider/subrequest.d.ts +13 -0
  194. package/dist/esm/services/authProvider/subrequest.js +45 -0
  195. package/dist/esm/services/authProvider/utils/decryptAndVerify.d.ts +28 -0
  196. package/dist/esm/services/authProvider/utils/decryptAndVerify.js +85 -0
  197. package/dist/esm/services/authProvider/utils/embeddedAuthProvider.d.ts +26 -0
  198. package/dist/esm/services/authProvider/utils/embeddedAuthProvider.js +40 -0
  199. package/dist/esm/services/authProvider/utils/userRoleValidator.d.ts +13 -0
  200. package/dist/esm/services/authProvider/utils/userRoleValidator.js +33 -0
  201. package/dist/esm/services/authProvider/utils/userSubrequest.d.ts +3 -0
  202. package/dist/esm/services/authProvider/utils/userSubrequest.js +6 -0
  203. package/dist/esm/services/documentStore/dynamoEncoding.d.ts +10 -0
  204. package/dist/esm/services/documentStore/dynamoEncoding.js +45 -0
  205. package/dist/esm/services/documentStore/fileSystemAssert.d.ts +1 -0
  206. package/dist/esm/services/documentStore/fileSystemAssert.js +10 -0
  207. package/dist/esm/services/documentStore/index.d.ts +14 -0
  208. package/dist/esm/services/documentStore/index.js +1 -0
  209. package/dist/esm/services/documentStore/unversioned/dynamodb.d.ts +31 -0
  210. package/dist/esm/services/documentStore/unversioned/dynamodb.js +226 -0
  211. package/dist/esm/services/documentStore/unversioned/file-system.d.ts +32 -0
  212. package/dist/esm/services/documentStore/unversioned/file-system.js +174 -0
  213. package/dist/esm/services/documentStore/unversioned/index.d.ts +2 -0
  214. package/dist/esm/services/documentStore/unversioned/index.js +1 -0
  215. package/dist/esm/services/documentStore/versioned/dynamodb.d.ts +25 -0
  216. package/dist/esm/services/documentStore/versioned/dynamodb.js +139 -0
  217. package/dist/esm/services/documentStore/versioned/file-system.d.ts +25 -0
  218. package/dist/esm/services/documentStore/versioned/file-system.js +69 -0
  219. package/dist/esm/services/documentStore/versioned/index.d.ts +17 -0
  220. package/dist/esm/services/documentStore/versioned/index.js +1 -0
  221. package/dist/esm/services/exercisesGateway/index.d.ts +67 -0
  222. package/dist/esm/services/exercisesGateway/index.js +70 -0
  223. package/dist/esm/services/fileServer/index.d.ts +30 -0
  224. package/dist/esm/services/fileServer/index.js +13 -0
  225. package/dist/esm/services/fileServer/localFileServer.d.ts +13 -0
  226. package/dist/esm/services/fileServer/localFileServer.js +125 -0
  227. package/dist/esm/services/fileServer/s3FileServer.d.ts +14 -0
  228. package/dist/esm/services/fileServer/s3FileServer.js +124 -0
  229. package/dist/esm/services/launchParams/index.d.ts +2 -0
  230. package/dist/esm/services/launchParams/index.js +2 -0
  231. package/dist/esm/services/launchParams/signer.d.ts +23 -0
  232. package/dist/esm/services/launchParams/signer.js +51 -0
  233. package/dist/esm/services/launchParams/verifier.d.ts +21 -0
  234. package/dist/esm/services/launchParams/verifier.js +92 -0
  235. package/dist/esm/services/logger/console.d.ts +4 -0
  236. package/{packages/utils/src/services/logger/console.ts → dist/esm/services/logger/console.js} +2 -5
  237. package/dist/esm/services/logger/index.d.ts +39 -0
  238. package/dist/esm/services/logger/index.js +27 -0
  239. package/dist/esm/services/lrsGateway/addStatementDefaultFields.d.ts +5 -0
  240. package/dist/esm/services/lrsGateway/addStatementDefaultFields.js +14 -0
  241. package/dist/esm/services/lrsGateway/attempt-utils.d.ts +72 -0
  242. package/dist/esm/services/lrsGateway/attempt-utils.js +261 -0
  243. package/dist/esm/services/lrsGateway/file-system.d.ts +15 -0
  244. package/dist/esm/services/lrsGateway/file-system.js +110 -0
  245. package/dist/esm/services/lrsGateway/index.d.ts +122 -0
  246. package/dist/esm/services/lrsGateway/index.js +111 -0
  247. package/dist/esm/services/lrsGateway/xapiUtils.d.ts +71 -0
  248. package/dist/esm/services/lrsGateway/xapiUtils.js +134 -0
  249. package/dist/esm/services/postgresConnection/index.d.ts +28 -0
  250. package/dist/esm/services/postgresConnection/index.js +58 -0
  251. package/dist/esm/services/searchProvider/index.d.ts +69 -0
  252. package/dist/esm/services/searchProvider/index.js +1 -0
  253. package/dist/esm/services/searchProvider/memorySearchTheBadWay.d.ts +20 -0
  254. package/dist/esm/services/searchProvider/memorySearchTheBadWay.js +187 -0
  255. package/dist/esm/services/searchProvider/openSearch.d.ts +28 -0
  256. package/dist/esm/services/searchProvider/openSearch.js +158 -0
  257. package/dist/esm/services/searchProvider/streamIndexer.d.ts +17 -0
  258. package/dist/esm/services/searchProvider/streamIndexer.js +37 -0
  259. package/dist/esm/tsconfig.without-specs.esm.tsbuildinfo +1 -0
  260. package/dist/esm/types.d.ts +31 -0
  261. package/dist/esm/types.js +1 -0
  262. package/package.json +234 -12
  263. package/.cfnlintrc +0 -2
  264. package/.github/CODEOWNERS +0 -1
  265. package/.github/workflows/ci.yml +0 -36
  266. package/.github/workflows/lint.yml +0 -55
  267. package/.nvmrc +0 -1
  268. package/.syncignore +0 -4
  269. package/.syncpackrc +0 -18
  270. package/CONTRIBUTING.md +0 -96
  271. package/LICENSE +0 -661
  272. package/Procfile +0 -1
  273. package/app.json +0 -23
  274. package/cspell.json +0 -32
  275. package/deploy/constants.env +0 -21
  276. package/deploy/deploy.bash +0 -157
  277. package/deploy/deployment-alt-region.cfn.yml +0 -70
  278. package/deploy/deployment.cfn.yml +0 -650
  279. package/deploy/destroy-deployment.bash +0 -23
  280. package/deploy/shared.cfn.yml +0 -94
  281. package/docs/lambda-build.md +0 -35
  282. package/packages/frontend/README.md +0 -46
  283. package/packages/frontend/package.json +0 -101
  284. package/packages/frontend/public/favicon.ico +0 -0
  285. package/packages/frontend/public/index.html +0 -107
  286. package/packages/frontend/public/maintenance.html +0 -59
  287. package/packages/frontend/public/manifest.json +0 -15
  288. package/packages/frontend/public/robots.txt +0 -3
  289. package/packages/frontend/script/make-certificate.bash +0 -49
  290. package/packages/frontend/script/server/cli.js +0 -11
  291. package/packages/frontend/script/server/index.js +0 -47
  292. package/packages/frontend/script/start.bash +0 -22
  293. package/packages/frontend/script/trust-localhost.bash +0 -7
  294. package/packages/frontend/src/auth/authProvider.ts +0 -10
  295. package/packages/frontend/src/auth/useAuth.ts +0 -33
  296. package/packages/frontend/src/components/Pagination.tsx +0 -26
  297. package/packages/frontend/src/configProvider/index.ts +0 -53
  298. package/packages/frontend/src/configProvider/use.ts +0 -41
  299. package/packages/frontend/src/core/context/services.spec.tsx +0 -39
  300. package/packages/frontend/src/core/context/services.tsx +0 -16
  301. package/packages/frontend/src/core/index.spec.ts +0 -7
  302. package/packages/frontend/src/core/index.ts +0 -20
  303. package/packages/frontend/src/core/services.tsx +0 -14
  304. package/packages/frontend/src/core/types.ts +0 -3
  305. package/packages/frontend/src/example/api.ts +0 -28
  306. package/packages/frontend/src/example/components/Layout.tsx +0 -23
  307. package/packages/frontend/src/example/screens/Home.spec.tsx +0 -68
  308. package/packages/frontend/src/example/screens/Home.tsx +0 -78
  309. package/packages/frontend/src/example/screens/ThingList.spec.tsx +0 -60
  310. package/packages/frontend/src/example/screens/ThingList.tsx +0 -75
  311. package/packages/frontend/src/example/screens/ThingView.spec.tsx +0 -71
  312. package/packages/frontend/src/example/screens/ThingView.tsx +0 -47
  313. package/packages/frontend/src/example/screens/index.ts +0 -9
  314. package/packages/frontend/src/index.css +0 -159
  315. package/packages/frontend/src/index.tsx +0 -67
  316. package/packages/frontend/src/react-app-env.d.ts +0 -1
  317. package/packages/frontend/src/routing/components/RouteLink.spec.tsx +0 -55
  318. package/packages/frontend/src/routing/components/RouteLink.tsx +0 -35
  319. package/packages/frontend/src/routing/middleware.ts +0 -6
  320. package/packages/frontend/src/routing/useQuery.ts +0 -14
  321. package/packages/frontend/src/setupProxy.js +0 -19
  322. package/packages/frontend/src/setupTests.ts +0 -9
  323. package/packages/frontend/src/tests/testServices.tsx +0 -23
  324. package/packages/frontend/tsconfig.json +0 -27
  325. package/packages/lambda/.eslintrc.js +0 -64
  326. package/packages/lambda/jest-global-setup.js +0 -3
  327. package/packages/lambda/jest-setup-after-env.js +0 -1
  328. package/packages/lambda/jest.config.js +0 -31
  329. package/packages/lambda/jest.resolver.js +0 -17
  330. package/packages/lambda/package.json +0 -68
  331. package/packages/lambda/script/build.bash +0 -19
  332. package/packages/lambda/script/bundle-functions.bash +0 -10
  333. package/packages/lambda/script/lambdaLocalProxy.js +0 -16
  334. package/packages/lambda/script/lambdaLocalProxy.spec.ts +0 -147
  335. package/packages/lambda/script/utils/getRouteData.ts +0 -7
  336. package/packages/lambda/script/utils/routeDataLoader.js +0 -8
  337. package/packages/lambda/script/utils/routeDataLoader.spec.ts +0 -8
  338. package/packages/lambda/src/functions/serviceApi/core/index.ts +0 -7
  339. package/packages/lambda/src/functions/serviceApi/core/request.spec.ts +0 -38
  340. package/packages/lambda/src/functions/serviceApi/core/request.ts +0 -42
  341. package/packages/lambda/src/functions/serviceApi/core/routes.spec.ts +0 -7
  342. package/packages/lambda/src/functions/serviceApi/core/routes.ts +0 -10
  343. package/packages/lambda/src/functions/serviceApi/core/services.ts +0 -9
  344. package/packages/lambda/src/functions/serviceApi/core/types.ts +0 -13
  345. package/packages/lambda/src/functions/serviceApi/entry/lambda/https-xray.ts +0 -4
  346. package/packages/lambda/src/functions/serviceApi/entry/lambda/index.spec.ts +0 -48
  347. package/packages/lambda/src/functions/serviceApi/entry/lambda/index.ts +0 -58
  348. package/packages/lambda/src/functions/serviceApi/entry/lambda/services.ts +0 -36
  349. package/packages/lambda/src/functions/serviceApi/entry/local.ts +0 -71
  350. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentSearchMiddleware.spec.ts +0 -16
  351. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentSearchMiddleware.ts +0 -41
  352. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentStoreMiddleware.spec.ts +0 -78
  353. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentStoreMiddleware.ts +0 -70
  354. package/packages/lambda/src/functions/serviceApi/versions/v0/example/routes.spec.ts +0 -306
  355. package/packages/lambda/src/functions/serviceApi/versions/v0/example/routes.ts +0 -176
  356. package/packages/lambda/src/functions/serviceApi/versions/v0/index.spec.ts +0 -263
  357. package/packages/lambda/src/functions/serviceApi/versions/v0/index.ts +0 -134
  358. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/authMiddleware.spec.ts +0 -23
  359. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/authMiddleware.ts +0 -32
  360. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/configMiddleware.spec.ts +0 -10
  361. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/configMiddleware.ts +0 -7
  362. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/frontendFileServerMiddleware.spec.ts +0 -13
  363. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/frontendFileServerMiddleware.ts +0 -23
  364. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/paginationMiddleware.spec.ts +0 -9
  365. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/paginationMiddleware.ts +0 -9
  366. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/searchMiddleware.spec.ts +0 -12
  367. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/searchMiddleware.ts +0 -21
  368. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/userRoleValidatorMiddleware.spec.ts +0 -21
  369. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/userRoleValidatorMiddleware.ts +0 -18
  370. package/packages/lambda/tsconfig.json +0 -30
  371. package/packages/lambda/webpack.config.js +0 -97
  372. package/packages/utils/.eslintrc.js +0 -64
  373. package/packages/utils/README.md +0 -118
  374. package/packages/utils/jest-global-setup.js +0 -3
  375. package/packages/utils/jest.config.js +0 -25
  376. package/packages/utils/jest.resolver.js +0 -17
  377. package/packages/utils/package.json +0 -238
  378. package/packages/utils/src/assertions/index.spec.ts +0 -126
  379. package/packages/utils/src/aws/ssmService.ts +0 -7
  380. package/packages/utils/src/config/awsParameterConfig.ts +0 -24
  381. package/packages/utils/src/config/envConfig.ts +0 -58
  382. package/packages/utils/src/config/index.spec.ts +0 -165
  383. package/packages/utils/src/config/lambdaParameterConfig.ts +0 -49
  384. package/packages/utils/src/config/resolveConfigValue.ts +0 -10
  385. package/packages/utils/src/errors/index.spec.ts +0 -35
  386. package/packages/utils/src/fetch/fetchStatusRetry.spec.ts +0 -197
  387. package/packages/utils/src/fetch/fetchStatusRetry.ts +0 -33
  388. package/packages/utils/src/fetch/index.spec.ts +0 -34
  389. package/packages/utils/src/fetch/index.ts +0 -87
  390. package/packages/utils/src/guards/index.spec.ts +0 -58
  391. package/packages/utils/src/index.spec.ts +0 -471
  392. package/packages/utils/src/middleware/apiErrorHandler.spec.ts +0 -65
  393. package/packages/utils/src/middleware/apiErrorHandler.ts +0 -67
  394. package/packages/utils/src/middleware/apiSlowResponseMiddleware.spec.ts +0 -184
  395. package/packages/utils/src/middleware/apiSlowResponseMiddleware.ts +0 -71
  396. package/packages/utils/src/middleware/index.spec.ts +0 -99
  397. package/packages/utils/src/middleware/lambdaCorsResponseMiddleware.spec.ts +0 -103
  398. package/packages/utils/src/middleware/lambdaCorsResponseMiddleware.ts +0 -52
  399. package/packages/utils/src/middleware/throwNotFoundMiddleware.spec.ts +0 -20
  400. package/packages/utils/src/middleware/throwNotFoundMiddleware.ts +0 -11
  401. package/packages/utils/src/misc/hashValue.ts +0 -18
  402. package/packages/utils/src/misc/helpers.ts +0 -259
  403. package/packages/utils/src/misc/merge.ts +0 -48
  404. package/packages/utils/src/pagination/index.spec.ts +0 -150
  405. package/packages/utils/src/pagination/index.ts +0 -117
  406. package/packages/utils/src/routing/index.spec.ts +0 -553
  407. package/packages/utils/src/routing/index.ts +0 -424
  408. package/packages/utils/src/routing/validators/zod.spec.ts +0 -16
  409. package/packages/utils/src/routing/validators/zod.ts +0 -14
  410. package/packages/utils/src/services/accountsGateway/README.md +0 -3
  411. package/packages/utils/src/services/accountsGateway/index.spec.ts +0 -518
  412. package/packages/utils/src/services/accountsGateway/index.ts +0 -251
  413. package/packages/utils/src/services/apiGateway/README.md +0 -93
  414. package/packages/utils/src/services/apiGateway/index.spec.ts +0 -254
  415. package/packages/utils/src/services/apiGateway/index.ts +0 -189
  416. package/packages/utils/src/services/authProvider/README.md +0 -21
  417. package/packages/utils/src/services/authProvider/browser.spec.ts +0 -391
  418. package/packages/utils/src/services/authProvider/browser.ts +0 -209
  419. package/packages/utils/src/services/authProvider/decryption.spec.ts +0 -337
  420. package/packages/utils/src/services/authProvider/decryption.ts +0 -98
  421. package/packages/utils/src/services/authProvider/index.ts +0 -93
  422. package/packages/utils/src/services/authProvider/stub.spec.ts +0 -29
  423. package/packages/utils/src/services/authProvider/subrequest.spec.ts +0 -105
  424. package/packages/utils/src/services/authProvider/subrequest.ts +0 -68
  425. package/packages/utils/src/services/authProvider/utils/decryptAndVerify.spec.ts +0 -128
  426. package/packages/utils/src/services/authProvider/utils/decryptAndVerify.ts +0 -106
  427. package/packages/utils/src/services/authProvider/utils/embeddedAuthProvider.spec.ts +0 -26
  428. package/packages/utils/src/services/authProvider/utils/embeddedAuthProvider.ts +0 -57
  429. package/packages/utils/src/services/authProvider/utils/userRoleValidator.spec.ts +0 -135
  430. package/packages/utils/src/services/authProvider/utils/userRoleValidator.ts +0 -49
  431. package/packages/utils/src/services/authProvider/utils/userSubrequest.spec.ts +0 -26
  432. package/packages/utils/src/services/authProvider/utils/userSubrequest.ts +0 -10
  433. package/packages/utils/src/services/documentStore/dynamoEncoding.ts +0 -57
  434. package/packages/utils/src/services/documentStore/fileSystemAssert.spec.ts +0 -43
  435. package/packages/utils/src/services/documentStore/fileSystemAssert.ts +0 -10
  436. package/packages/utils/src/services/documentStore/unversioned/README.md +0 -13
  437. package/packages/utils/src/services/documentStore/unversioned/dynamodb.spec.ts +0 -859
  438. package/packages/utils/src/services/documentStore/unversioned/dynamodb.ts +0 -243
  439. package/packages/utils/src/services/documentStore/unversioned/file-system.spec.ts +0 -629
  440. package/packages/utils/src/services/documentStore/unversioned/file-system.ts +0 -194
  441. package/packages/utils/src/services/documentStore/versioned/README.md +0 -13
  442. package/packages/utils/src/services/documentStore/versioned/dynamodb.spec.ts +0 -376
  443. package/packages/utils/src/services/documentStore/versioned/dynamodb.ts +0 -167
  444. package/packages/utils/src/services/documentStore/versioned/file-system.spec.ts +0 -262
  445. package/packages/utils/src/services/documentStore/versioned/file-system.ts +0 -90
  446. package/packages/utils/src/services/documentStore/versioned/index.ts +0 -25
  447. package/packages/utils/src/services/exercisesGateway/README.md +0 -5
  448. package/packages/utils/src/services/exercisesGateway/index.spec.ts +0 -326
  449. package/packages/utils/src/services/exercisesGateway/index.ts +0 -163
  450. package/packages/utils/src/services/fileServer/index.spec.ts +0 -88
  451. package/packages/utils/src/services/fileServer/index.ts +0 -43
  452. package/packages/utils/src/services/fileServer/localFileServer.spec.ts +0 -182
  453. package/packages/utils/src/services/fileServer/localFileServer.ts +0 -159
  454. package/packages/utils/src/services/fileServer/s3FileServer.spec.ts +0 -266
  455. package/packages/utils/src/services/fileServer/s3FileServer.ts +0 -155
  456. package/packages/utils/src/services/launchParams/index.spec.ts +0 -366
  457. package/packages/utils/src/services/launchParams/signer.ts +0 -73
  458. package/packages/utils/src/services/launchParams/verifier.ts +0 -120
  459. package/packages/utils/src/services/logger/console.spec.ts +0 -29
  460. package/packages/utils/src/services/logger/index.spec.ts +0 -65
  461. package/packages/utils/src/services/lrsGateway/README.md +0 -5
  462. package/packages/utils/src/services/lrsGateway/addStatementDefaultFields.ts +0 -22
  463. package/packages/utils/src/services/lrsGateway/attempt-utils.spec.ts +0 -847
  464. package/packages/utils/src/services/lrsGateway/attempt-utils.ts +0 -358
  465. package/packages/utils/src/services/lrsGateway/file-system.spec.ts +0 -363
  466. package/packages/utils/src/services/lrsGateway/file-system.ts +0 -165
  467. package/packages/utils/src/services/lrsGateway/index.spec.ts +0 -194
  468. package/packages/utils/src/services/lrsGateway/index.ts +0 -257
  469. package/packages/utils/src/services/lrsGateway/xapiUtils.spec.ts +0 -887
  470. package/packages/utils/src/services/lrsGateway/xapiUtils.ts +0 -262
  471. package/packages/utils/src/services/postgresConnection/index.spec.ts +0 -170
  472. package/packages/utils/src/services/postgresConnection/index.ts +0 -84
  473. package/packages/utils/src/services/searchProvider/README.md +0 -3
  474. package/packages/utils/src/services/searchProvider/index.ts +0 -59
  475. package/packages/utils/src/services/searchProvider/memorySearchTheBadWay.spec.ts +0 -526
  476. package/packages/utils/src/services/searchProvider/memorySearchTheBadWay.ts +0 -223
  477. package/packages/utils/src/services/searchProvider/openSearch.spec.ts +0 -926
  478. package/packages/utils/src/services/searchProvider/openSearch.ts +0 -195
  479. package/packages/utils/tsconfig.json +0 -31
  480. package/packages/utils/tsconfig.without-specs.cjs.json +0 -7
  481. package/packages/utils/tsconfig.without-specs.esm.json +0 -7
  482. package/packages/utils/tsconfig.without-specs.json +0 -6
  483. package/scripts/build.bash +0 -24
  484. package/scripts/ci.bash +0 -10
  485. package/scripts/start.bash +0 -29
  486. /package/{packages/utils/src/index.ts → dist/cjs/index.d.ts} +0 -0
  487. /package/{packages/utils/src/services/launchParams/index.ts → dist/cjs/services/launchParams/index.d.ts} +0 -0
  488. /package/{packages/utils/script → script}/bin/copy-from-template.bash +0 -0
  489. /package/{packages/utils/script → script}/bin/delete-stack.bash +0 -0
  490. /package/{packages/utils/script → script}/bin/deploy.bash +0 -0
  491. /package/{packages/utils/script → script}/bin/destroy-deployment.bash +0 -0
  492. /package/{packages/utils/script → script}/bin/empty-bucket.bash +0 -0
  493. /package/{packages/utils/script → script}/bin/get-arg.bash +0 -0
  494. /package/{packages/utils/script → script}/bin/get-deployed-environments.bash +0 -0
  495. /package/{packages/utils/script → script}/bin/get-env-param.bash +0 -0
  496. /package/{packages/utils/script → script}/bin/get-kwarg.bash +0 -0
  497. /package/{packages/utils/script → script}/bin/get-stack-param.bash +0 -0
  498. /package/{packages/utils/script → script}/bin/has-flag.bash +0 -0
  499. /package/{packages/utils/script → script}/bin/init-constants-script.bash +0 -0
  500. /package/{packages/utils/script → script}/bin/init-params-script.bash +0 -0
  501. /package/{packages/utils/script → script}/bin/stack-exists.bash +0 -0
  502. /package/{packages/utils/script → script}/bin/update-utils.bash +0 -0
  503. /package/{packages/utils/script → script}/bin/upload-pager-duty-endpoints.bash +0 -0
  504. /package/{packages/utils/script → script}/bin/upload-params.bash +0 -0
  505. /package/{packages/utils/script → script}/bin/which.bash +0 -0
  506. /package/{packages/utils/script → script}/bin-entry.bash +0 -0
  507. /package/{packages/utils/script → script}/build.bash +0 -0
@@ -0,0 +1,45 @@
1
+ import { isPlainObject } from '../../guards';
2
+ export const encodeDynamoAttribute = (value) => {
3
+ if (typeof value === 'string') {
4
+ return { S: value };
5
+ }
6
+ if (typeof value === 'number') {
7
+ return { N: value.toString() };
8
+ }
9
+ if (typeof value === 'boolean') {
10
+ return { BOOL: value };
11
+ }
12
+ if (value === null) {
13
+ return { NULL: true };
14
+ }
15
+ if (value instanceof Array) {
16
+ return { L: value.map(encodeDynamoAttribute) };
17
+ }
18
+ if (isPlainObject(value)) {
19
+ return { M: encodeDynamoDocument(value) };
20
+ }
21
+ throw new Error(`unknown attribute type ${typeof value} with value ${value}.`);
22
+ };
23
+ export const encodeDynamoDocument = (base) => Object.fromEntries(Object.entries(base).map(([key, value]) => ([key, encodeDynamoAttribute(value)])));
24
+ export const decodeDynamoAttribute = (value) => {
25
+ if (value.S !== undefined) {
26
+ return value.S;
27
+ }
28
+ if (value.N !== undefined) {
29
+ return parseFloat(value.N);
30
+ }
31
+ if (value.BOOL !== undefined) {
32
+ return value.BOOL;
33
+ }
34
+ if (value.NULL !== undefined) {
35
+ return null;
36
+ }
37
+ if (value.L !== undefined) {
38
+ return value.L.map(decodeDynamoAttribute);
39
+ }
40
+ if (value.M !== undefined) {
41
+ return decodeDynamoDocument(value.M);
42
+ }
43
+ throw new Error(`unknown attribute type: ${JSON.stringify(value)}.`);
44
+ };
45
+ export const decodeDynamoDocument = (document) => Object.fromEntries(Object.entries(document).map(([key, value]) => ([key, decodeDynamoAttribute(value)])));
@@ -0,0 +1 @@
1
+ export declare const assertNoUndefined: (obj: any, path?: string[]) => void;
@@ -0,0 +1,10 @@
1
+ export const assertNoUndefined = (obj, path = []) => {
2
+ if (obj === undefined) {
3
+ throw new Error(`unknown attribute type ${typeof obj} with value ${obj} at ${path.join('.') || 'root'}.`);
4
+ }
5
+ if (obj && typeof obj === 'object') {
6
+ for (const [key, value] of Object.entries(obj)) {
7
+ assertNoUndefined(value, [...path, key]);
8
+ }
9
+ }
10
+ };
@@ -0,0 +1,14 @@
1
+ export type Config = {
2
+ tableName: string;
3
+ };
4
+ export type DocumentBaseMapType = {
5
+ [key: string]: DocumentBaseValueTypes;
6
+ };
7
+ export type DocumentBaseListType = DocumentBaseValueTypes[];
8
+ export type DocumentBaseValueTypes = number | boolean | string | null | DocumentBaseMapType | DocumentBaseListType;
9
+ export type DocumentBaseType = {
10
+ [key: string]: DocumentBaseValueTypes;
11
+ };
12
+ export type TDocument<T> = {
13
+ [_key in keyof T]: DocumentBaseValueTypes;
14
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,31 @@
1
+ import { DynamoDB } from '@aws-sdk/client-dynamodb';
2
+ import { Config, TDocument } from '..';
3
+ import { ConfigProviderForConfig } from '../../../config';
4
+ interface Initializer<C> {
5
+ configSpace?: C;
6
+ dynamoClient?: DynamoDB;
7
+ }
8
+ export declare const dynamoUnversionedDocumentStore: <C extends string = "dynamodb">(initializer?: Initializer<C>) => <T extends TDocument<T>>() => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => <K extends keyof T>(_: {}, hashKey: K, options?: {
9
+ afterWrite?: (item: T) => void | Promise<void>;
10
+ batchAfterWrite?: (items: T[]) => void | Promise<void>;
11
+ }) => {
12
+ loadAllDocumentsTheBadWay: () => Promise<T[]>;
13
+ getItemsByField: (key: keyof T, value: T[K], pageKey?: string) => Promise<{
14
+ items: T[];
15
+ nextPageToken: string | undefined;
16
+ }>;
17
+ batchGetItem: (ids: T[K][]) => Promise<T[]>;
18
+ getItem: (id: T[K]) => Promise<T | undefined>;
19
+ incrementItemAttribute: (id: T[K], attribute: keyof T) => Promise<number>;
20
+ patchItem: (item: Partial<T>) => Promise<T>;
21
+ putItem: (item: T) => Promise<T>;
22
+ createItem: (item: T) => Promise<T>;
23
+ batchCreateItem: (items: T[], concurrency?: number) => Promise<{
24
+ successful: T[];
25
+ failed: Array<{
26
+ item: T;
27
+ error: Error;
28
+ }>;
29
+ }>;
30
+ };
31
+ export {};
@@ -0,0 +1,226 @@
1
+ import { BatchGetItemCommand, DynamoDB, GetItemCommand, PutItemCommand, QueryCommand, ScanCommand, UpdateItemCommand } from '@aws-sdk/client-dynamodb';
2
+ import asyncPool from 'tiny-async-pool';
3
+ import { once } from '../../..';
4
+ import { resolveConfigValue } from '../../../config';
5
+ import { ConflictError, NotFoundError } from '../../../errors';
6
+ import { ifDefined } from '../../../guards';
7
+ import { decodeDynamoDocument, encodeDynamoAttribute, encodeDynamoDocument } from '../dynamoEncoding';
8
+ export const dynamoUnversionedDocumentStore = (initializer) => {
9
+ const init = ifDefined(initializer, {});
10
+ const dynamodb = once(() => { var _a; return (_a = init.dynamoClient) !== null && _a !== void 0 ? _a : new DynamoDB({ apiVersion: '2012-08-10' }); });
11
+ return () => (configProvider) => (_, hashKey, options) => {
12
+ const tableName = once(() => resolveConfigValue(configProvider[ifDefined(init.configSpace, 'dynamodb')].tableName));
13
+ return {
14
+ loadAllDocumentsTheBadWay: async () => {
15
+ const loadAllResults = async (ExclusiveStartKey) => {
16
+ var _a, _b;
17
+ const cmd = new ScanCommand({ TableName: await tableName(), ExclusiveStartKey });
18
+ const result = await dynamodb().send(cmd);
19
+ const resultItems = (_b = (_a = result.Items) === null || _a === void 0 ? void 0 : _a.map((item) => decodeDynamoDocument(item))) !== null && _b !== void 0 ? _b : [];
20
+ if (result.LastEvaluatedKey) {
21
+ return [...resultItems, ...await loadAllResults(result.LastEvaluatedKey)];
22
+ }
23
+ return resultItems;
24
+ };
25
+ return loadAllResults();
26
+ },
27
+ /*
28
+ * requires that a global secondary index exist on the table
29
+ */
30
+ getItemsByField: async (key, value, pageKey) => {
31
+ var _a, _b;
32
+ const ExclusiveStartKey = pageKey
33
+ ? JSON.parse(Buffer.from(pageKey, 'base64').toString('utf-8'))
34
+ : undefined;
35
+ const table = await tableName();
36
+ const cmd = new QueryCommand({
37
+ TableName: table,
38
+ IndexName: key.toString(),
39
+ ExclusiveStartKey,
40
+ KeyConditionExpression: '#hk = :hkv',
41
+ ExpressionAttributeValues: {
42
+ ':hkv': encodeDynamoAttribute(value),
43
+ },
44
+ ExpressionAttributeNames: {
45
+ '#hk': key.toString(),
46
+ },
47
+ });
48
+ const response = await dynamodb().send(cmd);
49
+ const items = (_b = (_a = response.Items) === null || _a === void 0 ? void 0 : _a.map((item) => decodeDynamoDocument(item))) !== null && _b !== void 0 ? _b : [];
50
+ const nextPageToken = response.LastEvaluatedKey;
51
+ return {
52
+ items,
53
+ nextPageToken: nextPageToken
54
+ ? Buffer.from(JSON.stringify(nextPageToken)).toString('base64')
55
+ : undefined,
56
+ };
57
+ },
58
+ batchGetItem: async (ids) => {
59
+ const table = await tableName();
60
+ const key = hashKey.toString();
61
+ const getBatches = async (requestItems) => {
62
+ const cmd = new BatchGetItemCommand({
63
+ RequestItems: requestItems !== null && requestItems !== void 0 ? requestItems : { [table]: { Keys: ids.map((id) => ({ [key]: encodeDynamoAttribute(id) })) } },
64
+ });
65
+ const response = await dynamodb().send(cmd);
66
+ const currentResponses = response.Responses ?
67
+ response.Responses[table].map(response => decodeDynamoDocument(response)) : [];
68
+ return currentResponses.concat(response.UnprocessedKeys ? await getBatches(response.UnprocessedKeys) : []);
69
+ };
70
+ return getBatches();
71
+ },
72
+ getItem: async (id) => {
73
+ const cmd = new GetItemCommand({
74
+ Key: { [hashKey.toString()]: encodeDynamoAttribute(id) },
75
+ TableName: await tableName(),
76
+ });
77
+ return dynamodb().send(cmd).then(result => result.Item ? decodeDynamoDocument(result.Item) : undefined);
78
+ },
79
+ /* atomically increments the given item attribute by 1 */
80
+ incrementItemAttribute: async (id, attribute) => {
81
+ const key = hashKey.toString();
82
+ const field = attribute.toString();
83
+ const cmd = new UpdateItemCommand({
84
+ Key: { [key]: encodeDynamoAttribute(id) },
85
+ TableName: await tableName(),
86
+ UpdateExpression: 'ADD #f :one',
87
+ ConditionExpression: 'attribute_exists(#k)',
88
+ ExpressionAttributeNames: { '#k': hashKey.toString(), '#f': field },
89
+ ExpressionAttributeValues: { ':one': { N: '1' } },
90
+ ReturnValues: 'ALL_NEW',
91
+ });
92
+ return dynamodb().send(cmd).then(async (item) => {
93
+ var _a, _b, _c;
94
+ const result = (_b = (_a = item.Attributes) === null || _a === void 0 ? void 0 : _a[field]) === null || _b === void 0 ? void 0 : _b['N'];
95
+ if (!item.Attributes) {
96
+ throw new NotFoundError(`Item with ${key} "${id}" does not exist`);
97
+ }
98
+ if (!result) {
99
+ throw new NotFoundError(`Item with ${key} "${id}" did not produce field "${field}"`);
100
+ }
101
+ const updatedDoc = decodeDynamoDocument(item.Attributes);
102
+ await ((_c = options === null || options === void 0 ? void 0 : options.afterWrite) === null || _c === void 0 ? void 0 : _c.call(options, updatedDoc));
103
+ return parseFloat(result);
104
+ }).catch((error) => {
105
+ throw error.name === 'ConditionalCheckFailedException' ?
106
+ new NotFoundError(`Item with ${key} "${id}" does not exist`) : error;
107
+ });
108
+ },
109
+ /* replaces only specified attributes with the given data */
110
+ patchItem: async (item) => {
111
+ const id = item[hashKey];
112
+ const key = hashKey.toString();
113
+ if (!id) {
114
+ throw new Error(`Key attribute "${key}" is required for patchItem`);
115
+ }
116
+ const entries = Object.entries(item).filter(([field]) => field !== key);
117
+ if (entries.length === 0) {
118
+ throw new Error('No attributes to update');
119
+ }
120
+ const updates = [];
121
+ const expressionAttributeNames = { '#k': key };
122
+ const expressionAttributeValues = {};
123
+ entries.forEach(([field, value], index) => {
124
+ updates.push(`#f${index} = :f${index}`);
125
+ expressionAttributeNames[`#f${index}`] = field;
126
+ expressionAttributeValues[`:f${index}`] = encodeDynamoAttribute(value);
127
+ });
128
+ const cmd = new UpdateItemCommand({
129
+ Key: { [key]: encodeDynamoAttribute(id) },
130
+ TableName: await tableName(),
131
+ UpdateExpression: `SET ${updates.join(', ')}`,
132
+ ConditionExpression: 'attribute_exists(#k)',
133
+ ExpressionAttributeNames: expressionAttributeNames,
134
+ ExpressionAttributeValues: expressionAttributeValues,
135
+ ReturnValues: 'ALL_NEW',
136
+ });
137
+ return dynamodb().send(cmd).then(async (item) => {
138
+ var _a;
139
+ if (!item.Attributes) {
140
+ throw new NotFoundError(`Item with ${key} "${id}" does not exist`);
141
+ }
142
+ const updatedDoc = decodeDynamoDocument(item.Attributes);
143
+ await ((_a = options === null || options === void 0 ? void 0 : options.afterWrite) === null || _a === void 0 ? void 0 : _a.call(options, updatedDoc));
144
+ return updatedDoc;
145
+ }).catch((error) => {
146
+ throw error.name === 'ConditionalCheckFailedException' ?
147
+ new NotFoundError(`Item with ${key} "${id}" does not exist`) : error;
148
+ });
149
+ },
150
+ /* replaces the entire document with the given data */
151
+ putItem: async (item) => {
152
+ var _a;
153
+ const cmd = new PutItemCommand({
154
+ TableName: await tableName(),
155
+ Item: encodeDynamoDocument(item),
156
+ });
157
+ const updatedDoc = await dynamodb().send(cmd).then(() => item);
158
+ await ((_a = options === null || options === void 0 ? void 0 : options.afterWrite) === null || _a === void 0 ? void 0 : _a.call(options, updatedDoc));
159
+ return updatedDoc;
160
+ },
161
+ /* creates a new document, fails if the primary key already exists */
162
+ createItem: async (item) => {
163
+ const cmd = new PutItemCommand({
164
+ TableName: await tableName(),
165
+ Item: encodeDynamoDocument(item),
166
+ ConditionExpression: 'attribute_not_exists(#k)',
167
+ ExpressionAttributeNames: {
168
+ '#k': hashKey.toString(),
169
+ },
170
+ });
171
+ return await dynamodb().send(cmd).then(() => item).catch((error) => {
172
+ throw error.name === 'ConditionalCheckFailedException' ?
173
+ new ConflictError(`Item with ${String(hashKey)} "${item[hashKey]}" already exists`) : error;
174
+ }).then(async (createdDoc) => {
175
+ var _a;
176
+ await ((_a = options === null || options === void 0 ? void 0 : options.afterWrite) === null || _a === void 0 ? void 0 : _a.call(options, createdDoc));
177
+ return createdDoc;
178
+ });
179
+ },
180
+ /* creates multiple new documents, returns successful and failed items separately */
181
+ batchCreateItem: async (items, concurrency = 10) => {
182
+ if (items.length === 0)
183
+ return { successful: [], failed: [] };
184
+ const successful = [];
185
+ const failed = [];
186
+ // Process using async iterator (tiny-async-pool v2)
187
+ for await (const result of asyncPool(concurrency, items, async (item) => {
188
+ var _a;
189
+ try {
190
+ const cmd = new PutItemCommand({
191
+ TableName: await tableName(),
192
+ Item: encodeDynamoDocument(item),
193
+ ConditionExpression: 'attribute_not_exists(#k)',
194
+ ExpressionAttributeNames: {
195
+ '#k': hashKey.toString(),
196
+ },
197
+ });
198
+ await dynamodb().send(cmd);
199
+ // Only call individual afterWrite if batchAfterWrite is not defined
200
+ if (!(options === null || options === void 0 ? void 0 : options.batchAfterWrite)) {
201
+ await ((_a = options === null || options === void 0 ? void 0 : options.afterWrite) === null || _a === void 0 ? void 0 : _a.call(options, item));
202
+ }
203
+ return { success: true, item };
204
+ }
205
+ catch (error) {
206
+ const processedError = error.name === 'ConditionalCheckFailedException' ?
207
+ new ConflictError(`Item with ${String(hashKey)} "${item[hashKey]}" already exists`) : error;
208
+ return { success: false, item, error: processedError };
209
+ }
210
+ })) {
211
+ if (result.success) {
212
+ successful.push(result.item);
213
+ }
214
+ else {
215
+ failed.push({ item: result.item, error: result.error });
216
+ }
217
+ }
218
+ // Call batchAfterWrite with all successful items if defined
219
+ if ((options === null || options === void 0 ? void 0 : options.batchAfterWrite) && successful.length > 0) {
220
+ await options.batchAfterWrite(successful);
221
+ }
222
+ return { successful, failed };
223
+ },
224
+ };
225
+ };
226
+ };
@@ -0,0 +1,32 @@
1
+ import { Config, TDocument } from '..';
2
+ import { ConfigProviderForConfig } from '../../../config';
3
+ interface Initializer<C> {
4
+ dataDir: string;
5
+ fs?: Pick<typeof import('fs'), 'mkdir' | 'readdir' | 'readFile' | 'writeFile'>;
6
+ configSpace?: C;
7
+ }
8
+ export declare 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?: {
9
+ afterWrite?: (item: T) => void | Promise<void>;
10
+ batchAfterWrite?: (items: T[]) => void | Promise<void>;
11
+ skipAssert?: boolean;
12
+ }) => {
13
+ loadAllDocumentsTheBadWay: () => Promise<T[]>;
14
+ getItemsByField: (key: keyof T, value: T[K], pageKey?: string) => Promise<{
15
+ items: T[];
16
+ nextPageToken: string | undefined;
17
+ }>;
18
+ batchGetItem: (ids: T[K][]) => Promise<Exclude<Awaited<T>, undefined>[]>;
19
+ getItem: (id: T[K]) => Promise<T | undefined>;
20
+ incrementItemAttribute: (id: T[K], attribute: keyof T) => Promise<number>;
21
+ patchItem: (item: Partial<T>) => Promise<T>;
22
+ putItem: (item: T) => Promise<T>;
23
+ createItem: (item: T) => Promise<T>;
24
+ batchCreateItem: (items: T[], _concurrency?: number) => Promise<{
25
+ successful: T[];
26
+ failed: Array<{
27
+ item: T;
28
+ error: Error;
29
+ }>;
30
+ }>;
31
+ };
32
+ export {};
@@ -0,0 +1,174 @@
1
+ import * as fsModule from 'fs';
2
+ import path from 'path';
3
+ import { hashValue } from '../../..';
4
+ import { resolveConfigValue } from '../../../config';
5
+ import { ConflictError, NotFoundError } from '../../../errors';
6
+ import { ifDefined, isDefined } from '../../../guards';
7
+ import { assertNoUndefined } from '../fileSystemAssert';
8
+ export const fileSystemUnversionedDocumentStore = (initializer) => () => (configProvider) => (_, hashKey, options) => {
9
+ var _a;
10
+ const tableName = resolveConfigValue(configProvider[initializer.configSpace || 'fileSystem'].tableName);
11
+ const tablePath = tableName.then((table) => path.join(initializer.dataDir, table));
12
+ const { mkdir, readdir, readFile, writeFile } = ifDefined(initializer.fs, fsModule);
13
+ const skipAssert = (_a = options === null || options === void 0 ? void 0 : options.skipAssert) !== null && _a !== void 0 ? _a : false;
14
+ const mkTableDir = new Promise((resolve, reject) => tablePath.then((path) => mkdir(path, { recursive: true }, (err) => err && err.code !== 'EEXIST' ? reject(err) : resolve())));
15
+ const hashFilename = (value) => `${hashValue(value)}.json`;
16
+ const filePath = async (filename) => path.join(await tablePath, filename);
17
+ const load = async (filename) => {
18
+ const path = await filePath(filename);
19
+ await mkTableDir;
20
+ return new Promise((resolve, reject) => {
21
+ readFile(path, (err, readData) => {
22
+ if (err) {
23
+ err.code === 'ENOENT' ? resolve(undefined) : reject(err);
24
+ }
25
+ else {
26
+ try {
27
+ const data = JSON.parse(readData.toString());
28
+ typeof data === 'object' ? resolve(data) : reject(new Error('unexpected non-object JSON'));
29
+ }
30
+ catch (err) {
31
+ reject(err);
32
+ }
33
+ }
34
+ });
35
+ });
36
+ };
37
+ const loadAllDocumentsTheBadWay = async () => {
38
+ const path = await tablePath;
39
+ await mkTableDir;
40
+ return new Promise((resolve, reject) => readdir(path, (err, files) => err ?
41
+ reject(err) :
42
+ Promise.all(files.map((file) => load(file)))
43
+ .then((allData) => resolve(allData.filter(isDefined)), (err) => reject(err))));
44
+ };
45
+ return {
46
+ loadAllDocumentsTheBadWay,
47
+ getItemsByField: async (key, value, pageKey) => {
48
+ if (!skipAssert)
49
+ assertNoUndefined(value, [key]);
50
+ const pageSize = 10;
51
+ const items = await loadAllDocumentsTheBadWay();
52
+ const filteredItems = items.filter((item) => item[key] === value);
53
+ const startIndex = pageKey ? parseInt(pageKey, 10) : 0;
54
+ const paginatedItems = filteredItems.slice(startIndex, startIndex + pageSize);
55
+ const nextPageToken = startIndex + pageSize < filteredItems.length
56
+ ? (startIndex + pageSize).toString()
57
+ : undefined;
58
+ return { items: paginatedItems, nextPageToken };
59
+ },
60
+ batchGetItem: async (ids) => {
61
+ const items = await Promise.all(ids.map((id) => {
62
+ if (!skipAssert)
63
+ assertNoUndefined(id, ['id']);
64
+ return load(hashFilename(id));
65
+ }));
66
+ return items.filter(isDefined);
67
+ },
68
+ getItem: (id) => {
69
+ if (!skipAssert)
70
+ assertNoUndefined(id, ['id']);
71
+ return load(hashFilename(id));
72
+ },
73
+ incrementItemAttribute: async (id, attribute) => {
74
+ if (!skipAssert)
75
+ assertNoUndefined(id, ['id']);
76
+ const filename = hashFilename(id);
77
+ const path = await filePath(filename);
78
+ await mkTableDir;
79
+ const data = await load(filename);
80
+ if (!data) {
81
+ throw new NotFoundError(`Item with ${hashKey.toString()} "${id}" does not exist`);
82
+ }
83
+ const newValue = typeof data[attribute] === 'number' ? data[attribute] + 1 : 1;
84
+ const newItem = { ...data, [hashKey]: id, [attribute]: newValue };
85
+ return new Promise((resolve, reject) => {
86
+ writeFile(path, JSON.stringify(newItem, null, 2), (err) => err ? reject(err) : resolve(newValue));
87
+ });
88
+ },
89
+ patchItem: async (item) => {
90
+ const id = item[hashKey];
91
+ if (!id) {
92
+ throw new Error(`Key attribute "${hashKey.toString()}" is required for patchItem`);
93
+ }
94
+ // This check is just to make this adapter consistent with the dynamo adapter
95
+ if (Object.keys(item).filter((key) => key !== hashKey.toString()).length === 0) {
96
+ throw new Error('No attributes to update');
97
+ }
98
+ const filename = hashFilename(id);
99
+ const path = await filePath(filename);
100
+ await mkTableDir;
101
+ const data = await load(filename);
102
+ if (!data) {
103
+ throw new NotFoundError(`Item with ${hashKey.toString()} "${id}" does not exist`);
104
+ }
105
+ const newItem = { ...data, ...item };
106
+ if (!skipAssert)
107
+ assertNoUndefined(newItem);
108
+ return new Promise((resolve, reject) => {
109
+ writeFile(path, JSON.stringify(newItem, null, 2), (err) => err ? reject(err) : resolve(newItem));
110
+ });
111
+ },
112
+ putItem: async (item) => {
113
+ if (!skipAssert)
114
+ assertNoUndefined(item);
115
+ const path = await filePath(hashFilename(item[hashKey]));
116
+ await mkTableDir;
117
+ return new Promise((resolve, reject) => {
118
+ writeFile(path, JSON.stringify(item, null, 2), (err) => err ? reject(err) : resolve(item));
119
+ });
120
+ },
121
+ createItem: async (item) => {
122
+ if (!skipAssert)
123
+ assertNoUndefined(item);
124
+ const hashed = hashFilename(item[hashKey]);
125
+ const existingItem = await load(hashed);
126
+ if (existingItem) {
127
+ throw new ConflictError(`Item with ${String(hashKey)} "${item[hashKey]}" already exists`);
128
+ }
129
+ const path = await filePath(hashed);
130
+ await mkTableDir;
131
+ return new Promise((resolve, reject) => {
132
+ writeFile(path, JSON.stringify(item, null, 2), (err) => err ? reject(err) : resolve(item));
133
+ });
134
+ },
135
+ batchCreateItem: async (items, _concurrency = 1) => {
136
+ var _a;
137
+ if (items.length === 0)
138
+ return { successful: [], failed: [] };
139
+ const successful = [];
140
+ const failed = [];
141
+ // Process items sequentially to ensure consistent conflict detection
142
+ // Note: concurrency parameter is ignored for filesystem to avoid race conditions
143
+ for (const item of items) {
144
+ if (!skipAssert)
145
+ assertNoUndefined(item);
146
+ try {
147
+ const hashed = hashFilename(item[hashKey]);
148
+ const existingItem = await load(hashed);
149
+ if (existingItem) {
150
+ throw new ConflictError(`Item with ${String(hashKey)} "${item[hashKey]}" already exists`);
151
+ }
152
+ const path = await filePath(hashed);
153
+ await mkTableDir;
154
+ const createdItem = await new Promise((resolve, reject) => {
155
+ writeFile(path, JSON.stringify(item, null, 2), (err) => err ? reject(err) : resolve(item));
156
+ });
157
+ successful.push(createdItem);
158
+ // Only call individual afterWrite if batchAfterWrite is not defined
159
+ if (!(options === null || options === void 0 ? void 0 : options.batchAfterWrite)) {
160
+ await ((_a = options === null || options === void 0 ? void 0 : options.afterWrite) === null || _a === void 0 ? void 0 : _a.call(options, createdItem));
161
+ }
162
+ }
163
+ catch (error) {
164
+ failed.push({ item, error: error });
165
+ }
166
+ }
167
+ // Call batchAfterWrite with all successful items if defined
168
+ if ((options === null || options === void 0 ? void 0 : options.batchAfterWrite) && successful.length > 0) {
169
+ await options.batchAfterWrite(successful);
170
+ }
171
+ return { successful, failed };
172
+ },
173
+ };
174
+ };
@@ -0,0 +1,2 @@
1
+ import { dynamoUnversionedDocumentStore } from './dynamodb';
2
+ export type UnversionedDocumentStoreCreator = typeof dynamoUnversionedDocumentStore;
@@ -0,0 +1,25 @@
1
+ import { DynamoDB } from '@aws-sdk/client-dynamodb';
2
+ import { Config } from '..';
3
+ import { ConfigProviderForConfig } from '../../../config';
4
+ import { VersionedDocumentAuthor, VersionedTDocument } from '.';
5
+ interface Initializer<C> {
6
+ configSpace?: C;
7
+ dynamoClient?: DynamoDB;
8
+ }
9
+ export declare const dynamoVersionedDocumentStore: <C extends string = "dynamodb">(initializer?: Initializer<C>) => <T extends VersionedTDocument<T>>() => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => <K extends keyof T, A extends undefined | ((...a: any[]) => Promise<VersionedDocumentAuthor>)>(_: {}, hashKey: K, options?: {
10
+ afterWrite?: (item: T) => void | Promise<void>;
11
+ getAuthor?: A;
12
+ }) => {
13
+ loadAllDocumentsTheBadWay: () => Promise<T[]>;
14
+ getVersions: (id: T[K], startVersion?: number) => Promise<{
15
+ items: T[];
16
+ nextPageToken: number | undefined;
17
+ } | undefined>;
18
+ getItem: (id: T[K], timestamp?: number) => Promise<T | undefined>;
19
+ prepareItem: (item: Omit<T, "timestamp" | "author">, ...authorArgs: A extends Function ? Parameters<A> : [VersionedDocumentAuthor]) => Promise<{
20
+ document: T;
21
+ save: (changes?: Partial<Omit<T, "timestamp" | "author">>) => Promise<T>;
22
+ }>;
23
+ putItem: (item: Omit<T, "timestamp" | "author">, ...authorArgs: A extends Function ? Parameters<A> : [VersionedDocumentAuthor]) => Promise<T>;
24
+ };
25
+ export {};