@openstax/ts-utils 1.33.0 → 1.34.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (503) hide show
  1. package/.cfnlintrc +2 -0
  2. package/.github/CODEOWNERS +1 -0
  3. package/.github/workflows/ci.yml +36 -0
  4. package/.github/workflows/lint.yml +55 -0
  5. package/.nvmrc +1 -0
  6. package/.syncignore +4 -0
  7. package/.syncpackrc +18 -0
  8. package/CONTRIBUTING.md +96 -0
  9. package/LICENSE +661 -0
  10. package/Procfile +1 -0
  11. package/README.md +62 -90
  12. package/app.json +23 -0
  13. package/cspell.json +32 -0
  14. package/deploy/constants.env +21 -0
  15. package/deploy/deploy.bash +157 -0
  16. package/deploy/deployment-alt-region.cfn.yml +70 -0
  17. package/deploy/deployment.cfn.yml +650 -0
  18. package/deploy/destroy-deployment.bash +23 -0
  19. package/deploy/shared.cfn.yml +94 -0
  20. package/docs/lambda-build.md +35 -0
  21. package/package.json +12 -228
  22. package/packages/frontend/README.md +46 -0
  23. package/packages/frontend/package.json +101 -0
  24. package/packages/frontend/public/favicon.ico +0 -0
  25. package/packages/frontend/public/index.html +107 -0
  26. package/packages/frontend/public/maintenance.html +59 -0
  27. package/packages/frontend/public/manifest.json +15 -0
  28. package/packages/frontend/public/robots.txt +3 -0
  29. package/packages/frontend/script/make-certificate.bash +49 -0
  30. package/packages/frontend/script/server/cli.js +11 -0
  31. package/packages/frontend/script/server/index.js +47 -0
  32. package/packages/frontend/script/start.bash +22 -0
  33. package/packages/frontend/script/trust-localhost.bash +7 -0
  34. package/packages/frontend/src/auth/authProvider.ts +10 -0
  35. package/packages/frontend/src/auth/useAuth.ts +33 -0
  36. package/packages/frontend/src/components/Pagination.tsx +26 -0
  37. package/packages/frontend/src/configProvider/index.ts +53 -0
  38. package/packages/frontend/src/configProvider/use.ts +41 -0
  39. package/packages/frontend/src/core/context/services.spec.tsx +39 -0
  40. package/packages/frontend/src/core/context/services.tsx +16 -0
  41. package/packages/frontend/src/core/index.spec.ts +7 -0
  42. package/packages/frontend/src/core/index.ts +20 -0
  43. package/packages/frontend/src/core/services.tsx +14 -0
  44. package/packages/frontend/src/core/types.ts +3 -0
  45. package/packages/frontend/src/example/api.ts +28 -0
  46. package/packages/frontend/src/example/components/Layout.tsx +23 -0
  47. package/packages/frontend/src/example/screens/Home.spec.tsx +68 -0
  48. package/packages/frontend/src/example/screens/Home.tsx +78 -0
  49. package/packages/frontend/src/example/screens/ThingList.spec.tsx +60 -0
  50. package/packages/frontend/src/example/screens/ThingList.tsx +75 -0
  51. package/packages/frontend/src/example/screens/ThingView.spec.tsx +71 -0
  52. package/packages/frontend/src/example/screens/ThingView.tsx +47 -0
  53. package/packages/frontend/src/example/screens/index.ts +9 -0
  54. package/packages/frontend/src/index.css +159 -0
  55. package/packages/frontend/src/index.tsx +67 -0
  56. package/packages/frontend/src/react-app-env.d.ts +1 -0
  57. package/packages/frontend/src/routing/components/RouteLink.spec.tsx +55 -0
  58. package/packages/frontend/src/routing/components/RouteLink.tsx +35 -0
  59. package/packages/frontend/src/routing/middleware.ts +6 -0
  60. package/packages/frontend/src/routing/useQuery.ts +14 -0
  61. package/packages/frontend/src/setupProxy.js +19 -0
  62. package/packages/frontend/src/setupTests.ts +9 -0
  63. package/packages/frontend/src/tests/testServices.tsx +23 -0
  64. package/packages/frontend/tsconfig.json +27 -0
  65. package/packages/lambda/.eslintrc.js +64 -0
  66. package/packages/lambda/jest-global-setup.js +3 -0
  67. package/packages/lambda/jest-setup-after-env.js +1 -0
  68. package/packages/lambda/jest.config.js +31 -0
  69. package/packages/lambda/jest.resolver.js +17 -0
  70. package/packages/lambda/package.json +68 -0
  71. package/packages/lambda/script/build.bash +19 -0
  72. package/packages/lambda/script/bundle-functions.bash +10 -0
  73. package/packages/lambda/script/lambdaLocalProxy.js +16 -0
  74. package/packages/lambda/script/lambdaLocalProxy.spec.ts +147 -0
  75. package/packages/lambda/script/utils/getRouteData.ts +7 -0
  76. package/packages/lambda/script/utils/routeDataLoader.js +8 -0
  77. package/packages/lambda/script/utils/routeDataLoader.spec.ts +8 -0
  78. package/packages/lambda/src/functions/serviceApi/core/index.ts +7 -0
  79. package/packages/lambda/src/functions/serviceApi/core/request.spec.ts +38 -0
  80. package/packages/lambda/src/functions/serviceApi/core/request.ts +42 -0
  81. package/packages/lambda/src/functions/serviceApi/core/routes.spec.ts +7 -0
  82. package/packages/lambda/src/functions/serviceApi/core/routes.ts +10 -0
  83. package/packages/lambda/src/functions/serviceApi/core/services.ts +9 -0
  84. package/packages/lambda/src/functions/serviceApi/core/types.ts +13 -0
  85. package/packages/lambda/src/functions/serviceApi/entry/lambda/https-xray.ts +4 -0
  86. package/packages/lambda/src/functions/serviceApi/entry/lambda/index.spec.ts +48 -0
  87. package/packages/lambda/src/functions/serviceApi/entry/lambda/index.ts +58 -0
  88. package/packages/lambda/src/functions/serviceApi/entry/lambda/services.ts +36 -0
  89. package/packages/lambda/src/functions/serviceApi/entry/local.ts +71 -0
  90. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentSearchMiddleware.spec.ts +16 -0
  91. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentSearchMiddleware.ts +41 -0
  92. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentStoreMiddleware.spec.ts +78 -0
  93. package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentStoreMiddleware.ts +70 -0
  94. package/packages/lambda/src/functions/serviceApi/versions/v0/example/routes.spec.ts +306 -0
  95. package/packages/lambda/src/functions/serviceApi/versions/v0/example/routes.ts +176 -0
  96. package/packages/lambda/src/functions/serviceApi/versions/v0/index.spec.ts +263 -0
  97. package/packages/lambda/src/functions/serviceApi/versions/v0/index.ts +134 -0
  98. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/authMiddleware.spec.ts +23 -0
  99. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/authMiddleware.ts +32 -0
  100. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/configMiddleware.spec.ts +10 -0
  101. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/configMiddleware.ts +7 -0
  102. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/frontendFileServerMiddleware.spec.ts +13 -0
  103. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/frontendFileServerMiddleware.ts +23 -0
  104. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/paginationMiddleware.spec.ts +9 -0
  105. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/paginationMiddleware.ts +9 -0
  106. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/searchMiddleware.spec.ts +12 -0
  107. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/searchMiddleware.ts +21 -0
  108. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/userRoleValidatorMiddleware.spec.ts +21 -0
  109. package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/userRoleValidatorMiddleware.ts +18 -0
  110. package/packages/lambda/tsconfig.json +30 -0
  111. package/packages/lambda/webpack.config.js +97 -0
  112. package/packages/utils/.eslintrc.js +64 -0
  113. package/packages/utils/README.md +118 -0
  114. package/packages/utils/jest-global-setup.js +3 -0
  115. package/packages/utils/jest.config.js +25 -0
  116. package/packages/utils/jest.resolver.js +17 -0
  117. package/packages/utils/package.json +238 -0
  118. package/packages/utils/src/assertions/index.spec.ts +126 -0
  119. package/{dist/esm/assertions/index.js → packages/utils/src/assertions/index.ts} +64 -49
  120. package/packages/utils/src/aws/ssmService.ts +7 -0
  121. package/packages/utils/src/config/awsParameterConfig.ts +24 -0
  122. package/packages/utils/src/config/envConfig.ts +58 -0
  123. package/packages/utils/src/config/index.spec.ts +165 -0
  124. package/{dist/esm/config/index.d.ts → packages/utils/src/config/index.ts} +29 -13
  125. package/packages/utils/src/config/lambdaParameterConfig.ts +49 -0
  126. package/{dist/esm/config/replaceConfig.js → packages/utils/src/config/replaceConfig.ts} +16 -6
  127. package/packages/utils/src/config/resolveConfigValue.ts +10 -0
  128. package/packages/utils/src/errors/index.spec.ts +35 -0
  129. package/{dist/esm/errors/index.js → packages/utils/src/errors/index.ts} +57 -41
  130. package/packages/utils/src/fetch/fetchStatusRetry.spec.ts +197 -0
  131. package/packages/utils/src/fetch/fetchStatusRetry.ts +33 -0
  132. package/packages/utils/src/fetch/index.spec.ts +34 -0
  133. package/packages/utils/src/fetch/index.ts +87 -0
  134. package/packages/utils/src/guards/index.spec.ts +58 -0
  135. package/{dist/esm/guards/index.d.ts → packages/utils/src/guards/index.ts} +10 -7
  136. package/packages/utils/src/index.spec.ts +471 -0
  137. package/packages/utils/src/middleware/apiErrorHandler.spec.ts +65 -0
  138. package/packages/utils/src/middleware/apiErrorHandler.ts +67 -0
  139. package/packages/utils/src/middleware/apiSlowResponseMiddleware.spec.ts +184 -0
  140. package/packages/utils/src/middleware/apiSlowResponseMiddleware.ts +71 -0
  141. package/packages/utils/src/middleware/index.spec.ts +99 -0
  142. package/{dist/cjs/middleware/index.d.ts → packages/utils/src/middleware/index.ts} +53 -5
  143. package/packages/utils/src/middleware/lambdaCorsResponseMiddleware.spec.ts +103 -0
  144. package/packages/utils/src/middleware/lambdaCorsResponseMiddleware.ts +52 -0
  145. package/packages/utils/src/middleware/throwNotFoundMiddleware.spec.ts +20 -0
  146. package/packages/utils/src/middleware/throwNotFoundMiddleware.ts +11 -0
  147. package/packages/utils/src/misc/hashValue.ts +18 -0
  148. package/packages/utils/src/misc/helpers.ts +259 -0
  149. package/packages/utils/src/misc/merge.ts +48 -0
  150. package/{dist/esm/misc/partitionSequence.js → packages/utils/src/misc/partitionSequence.ts} +23 -15
  151. package/packages/utils/src/pagination/index.spec.ts +150 -0
  152. package/packages/utils/src/pagination/index.ts +117 -0
  153. package/{dist/esm/routing/helpers.js → packages/utils/src/routing/helpers.ts} +42 -30
  154. package/packages/utils/src/routing/index.spec.ts +553 -0
  155. package/packages/utils/src/routing/index.ts +424 -0
  156. package/packages/utils/src/routing/validators/zod.spec.ts +16 -0
  157. package/packages/utils/src/routing/validators/zod.ts +14 -0
  158. package/packages/utils/src/services/accountsGateway/README.md +3 -0
  159. package/packages/utils/src/services/accountsGateway/index.spec.ts +518 -0
  160. package/packages/utils/src/services/accountsGateway/index.ts +251 -0
  161. package/packages/utils/src/services/apiGateway/README.md +93 -0
  162. package/packages/utils/src/services/apiGateway/index.spec.ts +254 -0
  163. package/packages/utils/src/services/apiGateway/index.ts +189 -0
  164. package/packages/utils/src/services/authProvider/README.md +21 -0
  165. package/packages/utils/src/services/authProvider/browser.spec.ts +391 -0
  166. package/packages/utils/src/services/authProvider/browser.ts +209 -0
  167. package/packages/utils/src/services/authProvider/decryption.spec.ts +337 -0
  168. package/packages/utils/src/services/authProvider/decryption.ts +98 -0
  169. package/packages/utils/src/services/authProvider/index.ts +93 -0
  170. package/packages/utils/src/services/authProvider/stub.spec.ts +29 -0
  171. package/packages/utils/src/services/authProvider/subrequest.spec.ts +105 -0
  172. package/packages/utils/src/services/authProvider/subrequest.ts +68 -0
  173. package/packages/utils/src/services/authProvider/utils/decryptAndVerify.spec.ts +128 -0
  174. package/packages/utils/src/services/authProvider/utils/decryptAndVerify.ts +106 -0
  175. package/packages/utils/src/services/authProvider/utils/embeddedAuthProvider.spec.ts +26 -0
  176. package/packages/utils/src/services/authProvider/utils/embeddedAuthProvider.ts +57 -0
  177. package/packages/utils/src/services/authProvider/utils/userRoleValidator.spec.ts +135 -0
  178. package/packages/utils/src/services/authProvider/utils/userRoleValidator.ts +49 -0
  179. package/packages/utils/src/services/authProvider/utils/userSubrequest.spec.ts +26 -0
  180. package/packages/utils/src/services/authProvider/utils/userSubrequest.ts +10 -0
  181. package/packages/utils/src/services/documentStore/dynamoEncoding.ts +57 -0
  182. package/packages/utils/src/services/documentStore/fileSystemAssert.spec.ts +43 -0
  183. package/packages/utils/src/services/documentStore/fileSystemAssert.ts +10 -0
  184. package/{dist/cjs/services/documentStore/index.d.ts → packages/utils/src/services/documentStore/index.ts} +8 -8
  185. package/packages/utils/src/services/documentStore/unversioned/README.md +13 -0
  186. package/packages/utils/src/services/documentStore/unversioned/dynamodb.spec.ts +859 -0
  187. package/packages/utils/src/services/documentStore/unversioned/dynamodb.ts +243 -0
  188. package/packages/utils/src/services/documentStore/unversioned/file-system.spec.ts +629 -0
  189. package/packages/utils/src/services/documentStore/unversioned/file-system.ts +194 -0
  190. package/{dist/cjs/services/documentStore/unversioned/index.d.ts → packages/utils/src/services/documentStore/unversioned/index.ts} +2 -0
  191. package/packages/utils/src/services/documentStore/versioned/README.md +13 -0
  192. package/packages/utils/src/services/documentStore/versioned/dynamodb.spec.ts +376 -0
  193. package/packages/utils/src/services/documentStore/versioned/dynamodb.ts +167 -0
  194. package/packages/utils/src/services/documentStore/versioned/file-system.spec.ts +262 -0
  195. package/packages/utils/src/services/documentStore/versioned/file-system.ts +90 -0
  196. package/packages/utils/src/services/documentStore/versioned/index.ts +25 -0
  197. package/packages/utils/src/services/exercisesGateway/README.md +5 -0
  198. package/packages/utils/src/services/exercisesGateway/index.spec.ts +326 -0
  199. package/packages/utils/src/services/exercisesGateway/index.ts +163 -0
  200. package/packages/utils/src/services/fileServer/index.spec.ts +88 -0
  201. package/packages/utils/src/services/fileServer/index.ts +43 -0
  202. package/packages/utils/src/services/fileServer/localFileServer.spec.ts +182 -0
  203. package/packages/utils/src/services/fileServer/localFileServer.ts +159 -0
  204. package/packages/utils/src/services/fileServer/s3FileServer.spec.ts +266 -0
  205. package/packages/utils/src/services/fileServer/s3FileServer.ts +155 -0
  206. package/packages/utils/src/services/launchParams/index.spec.ts +366 -0
  207. package/packages/utils/src/services/launchParams/signer.ts +73 -0
  208. package/packages/utils/src/services/launchParams/verifier.ts +120 -0
  209. package/packages/utils/src/services/logger/console.spec.ts +29 -0
  210. package/{dist/esm/services/logger/console.js → packages/utils/src/services/logger/console.ts} +5 -2
  211. package/packages/utils/src/services/logger/index.spec.ts +65 -0
  212. package/{dist/esm/services/logger/index.d.ts → packages/utils/src/services/logger/index.ts} +23 -9
  213. package/packages/utils/src/services/lrsGateway/README.md +5 -0
  214. package/packages/utils/src/services/lrsGateway/addStatementDefaultFields.ts +22 -0
  215. package/packages/utils/src/services/lrsGateway/attempt-utils.spec.ts +847 -0
  216. package/packages/utils/src/services/lrsGateway/attempt-utils.ts +358 -0
  217. package/packages/utils/src/services/lrsGateway/file-system.spec.ts +363 -0
  218. package/packages/utils/src/services/lrsGateway/file-system.ts +165 -0
  219. package/packages/utils/src/services/lrsGateway/index.spec.ts +194 -0
  220. package/packages/utils/src/services/lrsGateway/index.ts +257 -0
  221. package/packages/utils/src/services/lrsGateway/xapiUtils.spec.ts +887 -0
  222. package/packages/utils/src/services/lrsGateway/xapiUtils.ts +262 -0
  223. package/packages/utils/src/services/postgresConnection/index.spec.ts +170 -0
  224. package/packages/utils/src/services/postgresConnection/index.ts +84 -0
  225. package/packages/utils/src/services/searchProvider/README.md +3 -0
  226. package/packages/utils/src/services/searchProvider/index.ts +59 -0
  227. package/packages/utils/src/services/searchProvider/memorySearchTheBadWay.spec.ts +526 -0
  228. package/packages/utils/src/services/searchProvider/memorySearchTheBadWay.ts +223 -0
  229. package/packages/utils/src/services/searchProvider/openSearch.spec.ts +926 -0
  230. package/packages/utils/src/services/searchProvider/openSearch.ts +195 -0
  231. package/{dist/esm/types.d.ts → packages/utils/src/types.ts} +34 -6
  232. package/packages/utils/tsconfig.json +31 -0
  233. package/packages/utils/tsconfig.without-specs.cjs.json +7 -0
  234. package/packages/utils/tsconfig.without-specs.esm.json +7 -0
  235. package/packages/utils/tsconfig.without-specs.json +6 -0
  236. package/scripts/build.bash +24 -0
  237. package/scripts/ci.bash +10 -0
  238. package/scripts/start.bash +29 -0
  239. package/dist/cjs/assertions/index.d.ts +0 -89
  240. package/dist/cjs/assertions/index.js +0 -157
  241. package/dist/cjs/aws/ssmService.d.ts +0 -5
  242. package/dist/cjs/aws/ssmService.js +0 -9
  243. package/dist/cjs/config/awsParameterConfig.d.ts +0 -10
  244. package/dist/cjs/config/awsParameterConfig.js +0 -26
  245. package/dist/cjs/config/envConfig.d.ts +0 -24
  246. package/dist/cjs/config/envConfig.js +0 -57
  247. package/dist/cjs/config/index.d.ts +0 -48
  248. package/dist/cjs/config/index.js +0 -35
  249. package/dist/cjs/config/lambdaParameterConfig.d.ts +0 -12
  250. package/dist/cjs/config/lambdaParameterConfig.js +0 -45
  251. package/dist/cjs/config/replaceConfig.d.ts +0 -14
  252. package/dist/cjs/config/replaceConfig.js +0 -22
  253. package/dist/cjs/config/resolveConfigValue.d.ts +0 -5
  254. package/dist/cjs/config/resolveConfigValue.js +0 -12
  255. package/dist/cjs/errors/index.d.ts +0 -88
  256. package/dist/cjs/errors/index.js +0 -123
  257. package/dist/cjs/fetch/fetchStatusRetry.d.ts +0 -8
  258. package/dist/cjs/fetch/fetchStatusRetry.js +0 -27
  259. package/dist/cjs/fetch/index.d.ts +0 -64
  260. package/dist/cjs/fetch/index.js +0 -55
  261. package/dist/cjs/guards/index.d.ts +0 -38
  262. package/dist/cjs/guards/index.js +0 -44
  263. package/dist/cjs/index.js +0 -20
  264. package/dist/cjs/middleware/apiErrorHandler.d.ts +0 -24
  265. package/dist/cjs/middleware/apiErrorHandler.js +0 -42
  266. package/dist/cjs/middleware/apiSlowResponseMiddleware.d.ts +0 -23
  267. package/dist/cjs/middleware/apiSlowResponseMiddleware.js +0 -54
  268. package/dist/cjs/middleware/index.js +0 -48
  269. package/dist/cjs/middleware/lambdaCorsResponseMiddleware.d.ts +0 -20
  270. package/dist/cjs/middleware/lambdaCorsResponseMiddleware.js +0 -44
  271. package/dist/cjs/middleware/throwNotFoundMiddleware.d.ts +0 -4
  272. package/dist/cjs/middleware/throwNotFoundMiddleware.js +0 -14
  273. package/dist/cjs/misc/hashValue.d.ts +0 -10
  274. package/dist/cjs/misc/hashValue.js +0 -17
  275. package/dist/cjs/misc/helpers.d.ts +0 -124
  276. package/dist/cjs/misc/helpers.js +0 -214
  277. package/dist/cjs/misc/merge.d.ts +0 -21
  278. package/dist/cjs/misc/merge.js +0 -45
  279. package/dist/cjs/misc/partitionSequence.d.ts +0 -35
  280. package/dist/cjs/misc/partitionSequence.js +0 -55
  281. package/dist/cjs/pagination/index.d.ts +0 -91
  282. package/dist/cjs/pagination/index.js +0 -83
  283. package/dist/cjs/routing/helpers.d.ts +0 -57
  284. package/dist/cjs/routing/helpers.js +0 -90
  285. package/dist/cjs/routing/index.d.ts +0 -290
  286. package/dist/cjs/routing/index.js +0 -295
  287. package/dist/cjs/routing/validators/zod.d.ts +0 -4
  288. package/dist/cjs/routing/validators/zod.js +0 -14
  289. package/dist/cjs/services/accountsGateway/index.d.ts +0 -92
  290. package/dist/cjs/services/accountsGateway/index.js +0 -138
  291. package/dist/cjs/services/apiGateway/index.d.ts +0 -68
  292. package/dist/cjs/services/apiGateway/index.js +0 -118
  293. package/dist/cjs/services/authProvider/browser.d.ts +0 -40
  294. package/dist/cjs/services/authProvider/browser.js +0 -155
  295. package/dist/cjs/services/authProvider/decryption.d.ts +0 -19
  296. package/dist/cjs/services/authProvider/decryption.js +0 -73
  297. package/dist/cjs/services/authProvider/index.d.ts +0 -63
  298. package/dist/cjs/services/authProvider/index.js +0 -34
  299. package/dist/cjs/services/authProvider/subrequest.d.ts +0 -13
  300. package/dist/cjs/services/authProvider/subrequest.js +0 -49
  301. package/dist/cjs/services/authProvider/utils/decryptAndVerify.d.ts +0 -28
  302. package/dist/cjs/services/authProvider/utils/decryptAndVerify.js +0 -91
  303. package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.d.ts +0 -26
  304. package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.js +0 -47
  305. package/dist/cjs/services/authProvider/utils/userRoleValidator.d.ts +0 -13
  306. package/dist/cjs/services/authProvider/utils/userRoleValidator.js +0 -37
  307. package/dist/cjs/services/authProvider/utils/userSubrequest.d.ts +0 -3
  308. package/dist/cjs/services/authProvider/utils/userSubrequest.js +0 -13
  309. package/dist/cjs/services/documentStore/dynamoEncoding.d.ts +0 -10
  310. package/dist/cjs/services/documentStore/dynamoEncoding.js +0 -52
  311. package/dist/cjs/services/documentStore/fileSystemAssert.d.ts +0 -1
  312. package/dist/cjs/services/documentStore/fileSystemAssert.js +0 -14
  313. package/dist/cjs/services/documentStore/index.js +0 -2
  314. package/dist/cjs/services/documentStore/unversioned/dynamodb.d.ts +0 -31
  315. package/dist/cjs/services/documentStore/unversioned/dynamodb.js +0 -233
  316. package/dist/cjs/services/documentStore/unversioned/file-system.d.ts +0 -32
  317. package/dist/cjs/services/documentStore/unversioned/file-system.js +0 -214
  318. package/dist/cjs/services/documentStore/unversioned/index.js +0 -2
  319. package/dist/cjs/services/documentStore/versioned/dynamodb.d.ts +0 -25
  320. package/dist/cjs/services/documentStore/versioned/dynamodb.js +0 -143
  321. package/dist/cjs/services/documentStore/versioned/file-system.d.ts +0 -25
  322. package/dist/cjs/services/documentStore/versioned/file-system.js +0 -73
  323. package/dist/cjs/services/documentStore/versioned/index.d.ts +0 -17
  324. package/dist/cjs/services/documentStore/versioned/index.js +0 -2
  325. package/dist/cjs/services/exercisesGateway/index.d.ts +0 -67
  326. package/dist/cjs/services/exercisesGateway/index.js +0 -107
  327. package/dist/cjs/services/fileServer/index.d.ts +0 -30
  328. package/dist/cjs/services/fileServer/index.js +0 -19
  329. package/dist/cjs/services/fileServer/localFileServer.d.ts +0 -13
  330. package/dist/cjs/services/fileServer/localFileServer.js +0 -132
  331. package/dist/cjs/services/fileServer/s3FileServer.d.ts +0 -14
  332. package/dist/cjs/services/fileServer/s3FileServer.js +0 -131
  333. package/dist/cjs/services/launchParams/index.js +0 -7
  334. package/dist/cjs/services/launchParams/signer.d.ts +0 -23
  335. package/dist/cjs/services/launchParams/signer.js +0 -58
  336. package/dist/cjs/services/launchParams/verifier.d.ts +0 -21
  337. package/dist/cjs/services/launchParams/verifier.js +0 -129
  338. package/dist/cjs/services/logger/console.d.ts +0 -4
  339. package/dist/cjs/services/logger/console.js +0 -12
  340. package/dist/cjs/services/logger/index.d.ts +0 -39
  341. package/dist/cjs/services/logger/index.js +0 -31
  342. package/dist/cjs/services/lrsGateway/addStatementDefaultFields.d.ts +0 -5
  343. package/dist/cjs/services/lrsGateway/addStatementDefaultFields.js +0 -21
  344. package/dist/cjs/services/lrsGateway/attempt-utils.d.ts +0 -70
  345. package/dist/cjs/services/lrsGateway/attempt-utils.js +0 -258
  346. package/dist/cjs/services/lrsGateway/file-system.d.ts +0 -15
  347. package/dist/cjs/services/lrsGateway/file-system.js +0 -150
  348. package/dist/cjs/services/lrsGateway/index.d.ts +0 -122
  349. package/dist/cjs/services/lrsGateway/index.js +0 -148
  350. package/dist/cjs/services/lrsGateway/xapiUtils.d.ts +0 -68
  351. package/dist/cjs/services/lrsGateway/xapiUtils.js +0 -109
  352. package/dist/cjs/services/postgresConnection/index.d.ts +0 -28
  353. package/dist/cjs/services/postgresConnection/index.js +0 -65
  354. package/dist/cjs/services/searchProvider/index.d.ts +0 -67
  355. package/dist/cjs/services/searchProvider/index.js +0 -2
  356. package/dist/cjs/services/searchProvider/memorySearchTheBadWay.d.ts +0 -20
  357. package/dist/cjs/services/searchProvider/memorySearchTheBadWay.js +0 -191
  358. package/dist/cjs/services/searchProvider/openSearch.d.ts +0 -28
  359. package/dist/cjs/services/searchProvider/openSearch.js +0 -154
  360. package/dist/cjs/tsconfig.without-specs.cjs.tsbuildinfo +0 -1
  361. package/dist/cjs/types.d.ts +0 -31
  362. package/dist/cjs/types.js +0 -2
  363. package/dist/esm/assertions/index.d.ts +0 -89
  364. package/dist/esm/aws/ssmService.d.ts +0 -5
  365. package/dist/esm/aws/ssmService.js +0 -6
  366. package/dist/esm/config/awsParameterConfig.d.ts +0 -10
  367. package/dist/esm/config/awsParameterConfig.js +0 -22
  368. package/dist/esm/config/envConfig.d.ts +0 -24
  369. package/dist/esm/config/envConfig.js +0 -53
  370. package/dist/esm/config/index.js +0 -17
  371. package/dist/esm/config/lambdaParameterConfig.d.ts +0 -12
  372. package/dist/esm/config/lambdaParameterConfig.js +0 -38
  373. package/dist/esm/config/replaceConfig.d.ts +0 -14
  374. package/dist/esm/config/resolveConfigValue.d.ts +0 -5
  375. package/dist/esm/config/resolveConfigValue.js +0 -8
  376. package/dist/esm/errors/index.d.ts +0 -88
  377. package/dist/esm/fetch/fetchStatusRetry.d.ts +0 -8
  378. package/dist/esm/fetch/fetchStatusRetry.js +0 -23
  379. package/dist/esm/fetch/index.d.ts +0 -64
  380. package/dist/esm/fetch/index.js +0 -46
  381. package/dist/esm/guards/index.js +0 -36
  382. package/dist/esm/index.d.ts +0 -4
  383. package/dist/esm/index.js +0 -4
  384. package/dist/esm/middleware/apiErrorHandler.d.ts +0 -24
  385. package/dist/esm/middleware/apiErrorHandler.js +0 -38
  386. package/dist/esm/middleware/apiSlowResponseMiddleware.d.ts +0 -23
  387. package/dist/esm/middleware/apiSlowResponseMiddleware.js +0 -50
  388. package/dist/esm/middleware/index.d.ts +0 -47
  389. package/dist/esm/middleware/index.js +0 -44
  390. package/dist/esm/middleware/lambdaCorsResponseMiddleware.d.ts +0 -20
  391. package/dist/esm/middleware/lambdaCorsResponseMiddleware.js +0 -40
  392. package/dist/esm/middleware/throwNotFoundMiddleware.d.ts +0 -4
  393. package/dist/esm/middleware/throwNotFoundMiddleware.js +0 -10
  394. package/dist/esm/misc/hashValue.d.ts +0 -10
  395. package/dist/esm/misc/hashValue.js +0 -13
  396. package/dist/esm/misc/helpers.d.ts +0 -124
  397. package/dist/esm/misc/helpers.js +0 -199
  398. package/dist/esm/misc/merge.d.ts +0 -21
  399. package/dist/esm/misc/merge.js +0 -40
  400. package/dist/esm/misc/partitionSequence.d.ts +0 -35
  401. package/dist/esm/pagination/index.d.ts +0 -91
  402. package/dist/esm/pagination/index.js +0 -77
  403. package/dist/esm/routing/helpers.d.ts +0 -57
  404. package/dist/esm/routing/index.d.ts +0 -290
  405. package/dist/esm/routing/index.js +0 -246
  406. package/dist/esm/routing/validators/zod.d.ts +0 -4
  407. package/dist/esm/routing/validators/zod.js +0 -10
  408. package/dist/esm/services/accountsGateway/index.d.ts +0 -92
  409. package/dist/esm/services/accountsGateway/index.js +0 -131
  410. package/dist/esm/services/apiGateway/index.d.ts +0 -68
  411. package/dist/esm/services/apiGateway/index.js +0 -77
  412. package/dist/esm/services/authProvider/browser.d.ts +0 -40
  413. package/dist/esm/services/authProvider/browser.js +0 -151
  414. package/dist/esm/services/authProvider/decryption.d.ts +0 -19
  415. package/dist/esm/services/authProvider/decryption.js +0 -69
  416. package/dist/esm/services/authProvider/index.d.ts +0 -63
  417. package/dist/esm/services/authProvider/index.js +0 -26
  418. package/dist/esm/services/authProvider/subrequest.d.ts +0 -13
  419. package/dist/esm/services/authProvider/subrequest.js +0 -45
  420. package/dist/esm/services/authProvider/utils/decryptAndVerify.d.ts +0 -28
  421. package/dist/esm/services/authProvider/utils/decryptAndVerify.js +0 -85
  422. package/dist/esm/services/authProvider/utils/embeddedAuthProvider.d.ts +0 -26
  423. package/dist/esm/services/authProvider/utils/embeddedAuthProvider.js +0 -40
  424. package/dist/esm/services/authProvider/utils/userRoleValidator.d.ts +0 -13
  425. package/dist/esm/services/authProvider/utils/userRoleValidator.js +0 -33
  426. package/dist/esm/services/authProvider/utils/userSubrequest.d.ts +0 -3
  427. package/dist/esm/services/authProvider/utils/userSubrequest.js +0 -6
  428. package/dist/esm/services/documentStore/dynamoEncoding.d.ts +0 -10
  429. package/dist/esm/services/documentStore/dynamoEncoding.js +0 -45
  430. package/dist/esm/services/documentStore/fileSystemAssert.d.ts +0 -1
  431. package/dist/esm/services/documentStore/fileSystemAssert.js +0 -10
  432. package/dist/esm/services/documentStore/index.d.ts +0 -14
  433. package/dist/esm/services/documentStore/index.js +0 -1
  434. package/dist/esm/services/documentStore/unversioned/dynamodb.d.ts +0 -31
  435. package/dist/esm/services/documentStore/unversioned/dynamodb.js +0 -226
  436. package/dist/esm/services/documentStore/unversioned/file-system.d.ts +0 -32
  437. package/dist/esm/services/documentStore/unversioned/file-system.js +0 -174
  438. package/dist/esm/services/documentStore/unversioned/index.d.ts +0 -2
  439. package/dist/esm/services/documentStore/unversioned/index.js +0 -1
  440. package/dist/esm/services/documentStore/versioned/dynamodb.d.ts +0 -25
  441. package/dist/esm/services/documentStore/versioned/dynamodb.js +0 -139
  442. package/dist/esm/services/documentStore/versioned/file-system.d.ts +0 -25
  443. package/dist/esm/services/documentStore/versioned/file-system.js +0 -69
  444. package/dist/esm/services/documentStore/versioned/index.d.ts +0 -17
  445. package/dist/esm/services/documentStore/versioned/index.js +0 -1
  446. package/dist/esm/services/exercisesGateway/index.d.ts +0 -67
  447. package/dist/esm/services/exercisesGateway/index.js +0 -70
  448. package/dist/esm/services/fileServer/index.d.ts +0 -30
  449. package/dist/esm/services/fileServer/index.js +0 -13
  450. package/dist/esm/services/fileServer/localFileServer.d.ts +0 -13
  451. package/dist/esm/services/fileServer/localFileServer.js +0 -125
  452. package/dist/esm/services/fileServer/s3FileServer.d.ts +0 -14
  453. package/dist/esm/services/fileServer/s3FileServer.js +0 -124
  454. package/dist/esm/services/launchParams/index.d.ts +0 -2
  455. package/dist/esm/services/launchParams/index.js +0 -2
  456. package/dist/esm/services/launchParams/signer.d.ts +0 -23
  457. package/dist/esm/services/launchParams/signer.js +0 -51
  458. package/dist/esm/services/launchParams/verifier.d.ts +0 -21
  459. package/dist/esm/services/launchParams/verifier.js +0 -92
  460. package/dist/esm/services/logger/console.d.ts +0 -4
  461. package/dist/esm/services/logger/index.js +0 -27
  462. package/dist/esm/services/lrsGateway/addStatementDefaultFields.d.ts +0 -5
  463. package/dist/esm/services/lrsGateway/addStatementDefaultFields.js +0 -14
  464. package/dist/esm/services/lrsGateway/attempt-utils.d.ts +0 -70
  465. package/dist/esm/services/lrsGateway/attempt-utils.js +0 -236
  466. package/dist/esm/services/lrsGateway/file-system.d.ts +0 -15
  467. package/dist/esm/services/lrsGateway/file-system.js +0 -110
  468. package/dist/esm/services/lrsGateway/index.d.ts +0 -122
  469. package/dist/esm/services/lrsGateway/index.js +0 -111
  470. package/dist/esm/services/lrsGateway/xapiUtils.d.ts +0 -68
  471. package/dist/esm/services/lrsGateway/xapiUtils.js +0 -99
  472. package/dist/esm/services/postgresConnection/index.d.ts +0 -28
  473. package/dist/esm/services/postgresConnection/index.js +0 -58
  474. package/dist/esm/services/searchProvider/index.d.ts +0 -67
  475. package/dist/esm/services/searchProvider/index.js +0 -1
  476. package/dist/esm/services/searchProvider/memorySearchTheBadWay.d.ts +0 -20
  477. package/dist/esm/services/searchProvider/memorySearchTheBadWay.js +0 -187
  478. package/dist/esm/services/searchProvider/openSearch.d.ts +0 -28
  479. package/dist/esm/services/searchProvider/openSearch.js +0 -150
  480. package/dist/esm/tsconfig.without-specs.esm.tsbuildinfo +0 -1
  481. package/dist/esm/types.js +0 -1
  482. /package/{script → packages/utils/script}/bin/copy-from-template.bash +0 -0
  483. /package/{script → packages/utils/script}/bin/delete-stack.bash +0 -0
  484. /package/{script → packages/utils/script}/bin/deploy.bash +0 -0
  485. /package/{script → packages/utils/script}/bin/destroy-deployment.bash +0 -0
  486. /package/{script → packages/utils/script}/bin/empty-bucket.bash +0 -0
  487. /package/{script → packages/utils/script}/bin/get-arg.bash +0 -0
  488. /package/{script → packages/utils/script}/bin/get-deployed-environments.bash +0 -0
  489. /package/{script → packages/utils/script}/bin/get-env-param.bash +0 -0
  490. /package/{script → packages/utils/script}/bin/get-kwarg.bash +0 -0
  491. /package/{script → packages/utils/script}/bin/get-stack-param.bash +0 -0
  492. /package/{script → packages/utils/script}/bin/has-flag.bash +0 -0
  493. /package/{script → packages/utils/script}/bin/init-constants-script.bash +0 -0
  494. /package/{script → packages/utils/script}/bin/init-params-script.bash +0 -0
  495. /package/{script → packages/utils/script}/bin/stack-exists.bash +0 -0
  496. /package/{script → packages/utils/script}/bin/update-utils.bash +0 -0
  497. /package/{script → packages/utils/script}/bin/upload-pager-duty-endpoints.bash +0 -0
  498. /package/{script → packages/utils/script}/bin/upload-params.bash +0 -0
  499. /package/{script → packages/utils/script}/bin/which.bash +0 -0
  500. /package/{script → packages/utils/script}/bin-entry.bash +0 -0
  501. /package/{script → packages/utils/script}/build.bash +0 -0
  502. /package/{dist/cjs/index.d.ts → packages/utils/src/index.ts} +0 -0
  503. /package/{dist/cjs/services/launchParams/index.d.ts → packages/utils/src/services/launchParams/index.ts} +0 -0
@@ -0,0 +1,629 @@
1
+ import { TextEncoder } from 'util';
2
+ import { hashValue } from '../../..';
3
+ import { fileSystemUnversionedDocumentStore } from './file-system';
4
+
5
+ type TTestDocument = {
6
+ coolId: string;
7
+ counter?: number;
8
+ name: string;
9
+ };
10
+
11
+ describe('fileSystemUnversionedDocumentStore', () => {
12
+ const config = {fileSystem: {tableName: 'db'}};
13
+ const middleware = {};
14
+ let mkdirSpy: jest.SpyInstance;
15
+ let readdirSpy: jest.SpyInstance;
16
+ let readFileSpy: jest.SpyInstance;
17
+ let writeFileSpy: jest.SpyInstance;
18
+ let data: string[];
19
+ let dataIndex: number;
20
+ let mkdirError: Error | null = null;
21
+ let readError: Error | null = null;
22
+ let writeError: Error | null = null;
23
+ let fs: Pick<typeof import('fs'), 'mkdir' | 'readdir' | 'readFile' | 'writeFile'>;
24
+
25
+ let consoleError: jest.SpyInstance;
26
+
27
+ beforeEach(() => {
28
+ mkdirError = null;
29
+ readError = null;
30
+ writeError = null;
31
+ data = [];
32
+ dataIndex = 0;
33
+
34
+ consoleError = jest.spyOn(console, 'error').mockImplementation(() => null);
35
+
36
+ mkdirSpy = jest.fn()
37
+ .mockImplementation((_dir, _options, cb) => cb(mkdirError));
38
+ readdirSpy = jest.fn()
39
+ .mockImplementation((_dir, cb) => cb(readError, ['123456.json']));
40
+ readFileSpy = jest.fn().mockImplementation(
41
+ (_file, cb) => cb(readError, Buffer.from(new TextEncoder().encode(data[dataIndex++]).buffer))
42
+ );
43
+ writeFileSpy = jest.fn()
44
+ .mockImplementation((_file, _data, cb) => cb(writeError));
45
+
46
+ fs = {mkdir: mkdirSpy, readdir: readdirSpy, readFile: readFileSpy, writeFile: writeFileSpy} as any;
47
+ });
48
+
49
+ afterEach(() => {
50
+ jest.clearAllMocks();
51
+ consoleError.mockRestore();
52
+ });
53
+
54
+ describe('loadAllDocumentsTheBadWay', () => {
55
+ it('returns all records', async() => {
56
+ const testDoc = {coolId: 'my-document-id', name: 'my-doc'};
57
+ data.push(JSON.stringify(testDoc));
58
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId', {skipAssert: true});
59
+
60
+ expect(await store.loadAllDocumentsTheBadWay()).toEqual([testDoc]);
61
+ });
62
+
63
+ it('throws on mkdir error', async() => {
64
+ mkdirError = new Error('no space left on device');
65
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId', {skipAssert: false});
66
+ await expect(store.loadAllDocumentsTheBadWay()).rejects.toThrow(mkdirError);
67
+ });
68
+
69
+ it('throws on file read error', async() => {
70
+ readError = new Error('foobar error');
71
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
72
+ await expect(store.loadAllDocumentsTheBadWay()).rejects.toThrow(readError);
73
+ });
74
+
75
+ it('throws if data is invalid JSON', async() => {
76
+ data.push('not json');
77
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
78
+ await expect(store.loadAllDocumentsTheBadWay()).rejects.toThrow('Unexpected token');
79
+ });
80
+
81
+ it('throws if data is non-object JSON', async() => {
82
+ data.push(JSON.stringify('asf'));
83
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
84
+
85
+ await expect(store.getItem('my-document-id')).rejects.toThrow('unexpected non-object JSON');
86
+ });
87
+ });
88
+
89
+ describe('getItemsByField', () => {
90
+ it('gets items', async() => {
91
+ const testDoc = {coolId: 'my-document-id', name: 'my-doc'};
92
+ data.push(JSON.stringify(testDoc));
93
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
94
+
95
+ const result = await store.getItemsByField('name', 'my-doc');
96
+ expect(result.items).toEqual([testDoc]);
97
+ expect(result.nextPageToken).toBeUndefined();
98
+ });
99
+
100
+ it('gets a second page', async() => {
101
+ const testDocs = Array.from({length: 15}, (_, i) => ({coolId: `my-document-id-${i}`, name: 'my-doc'}));
102
+ data.push(...testDocs.map(doc => JSON.stringify(doc)));
103
+ readdirSpy.mockImplementation((_dir, cb) => cb(readError, testDocs.map(doc => `${hashValue(doc.coolId)}.json`)));
104
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
105
+
106
+ const page1 = await store.getItemsByField('name', 'my-doc');
107
+ expect(page1.items).toHaveLength(10);
108
+ expect(page1.nextPageToken).toBeDefined();
109
+
110
+ dataIndex = 0; // reset the mock loader
111
+
112
+ const page2 = await store.getItemsByField('name', 'my-doc', page1.nextPageToken);
113
+ expect(page2.items).toHaveLength(5);
114
+ expect(page2.nextPageToken).toBeUndefined();
115
+ });
116
+ });
117
+
118
+ describe('batchGetItem', () => {
119
+ it('allows loading records from multiple files', async() => {
120
+ const testDoc = {coolId: 'my-document-id', name: 'my-doc'};
121
+ const testDoc2 = {coolId: 'my-document-id-2', name: 'my-doc-2'};
122
+ data.push(JSON.stringify(testDoc));
123
+ data.push(JSON.stringify(testDoc2));
124
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
125
+
126
+ expect(await store.batchGetItem(['my-document-id', 'my-document-id-2'])).toEqual([testDoc, testDoc2]);
127
+ });
128
+
129
+ it('returns empty array for non-existent ids', async() => {
130
+ const testDoc = {coolId: 'my-document-id', name: 'my-doc'};
131
+ const testDoc2 = {coolId: 'my-document-id-2', name: 'my-doc-2'};
132
+ data.push(JSON.stringify(testDoc));
133
+ data.push(JSON.stringify(testDoc2));
134
+ readError = new Error('file not found');
135
+ Object.defineProperty(readError, 'code', { value: 'ENOENT' });
136
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
137
+ expect(await store.batchGetItem(['my-document-id', 'my-document-id-2'])).toEqual([]);
138
+ });
139
+
140
+ it('throws on file read error', async() => {
141
+ readError = new Error('foobar error');
142
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
143
+ await expect(store.batchGetItem(['my-document-id', 'my-document-id-2'])).rejects.toThrow(readError);
144
+ });
145
+
146
+ it('throws if data is invalid JSON', async() => {
147
+ data.push('not json');
148
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
149
+ await expect(store.batchGetItem(['my-document-id', 'my-document-id-2'])).rejects.toThrow('Unexpected token');
150
+ });
151
+
152
+ it('throws if data is non-object JSON', async() => {
153
+ data.push(JSON.stringify('asf'));
154
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
155
+
156
+ await expect(store.batchGetItem(['my-document-id', 'my-document-id-2'])).rejects.toThrow('unexpected non-object JSON');
157
+ });
158
+ });
159
+
160
+ describe('getItem', () => {
161
+ it('allows loading records from a file', async() => {
162
+ const testDoc = {coolId: 'my-document-id', name: 'my-doc'};
163
+ data.push(JSON.stringify(testDoc));
164
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
165
+
166
+ expect(await store.getItem('my-document-id')).toEqual(testDoc);
167
+ });
168
+
169
+ it('returns undefined for non-existent id', async() => {
170
+ const testDoc = {coolId: 'my-document-id', name: 'my-doc'};
171
+ data.push(JSON.stringify(testDoc));
172
+ readError = new Error('file not found');
173
+ Object.defineProperty(readError, 'code', { value: 'ENOENT' });
174
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
175
+ expect(await store.getItem('my-document')).toBeUndefined();
176
+ });
177
+
178
+ it('throws on file read error', async() => {
179
+ readError = new Error('foobar error');
180
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
181
+ await expect(store.getItem('my-document-id')).rejects.toThrow(readError);
182
+ });
183
+
184
+ it('throws if data is invalid JSON', async() => {
185
+ data.push('not json');
186
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
187
+ await expect(store.getItem('my-document-id')).rejects.toThrow('Unexpected token');
188
+ });
189
+
190
+ it('throws if data is non-object JSON', async() => {
191
+ data.push(JSON.stringify('asf'));
192
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
193
+
194
+ await expect(store.getItem('my-document-id')).rejects.toThrow('unexpected non-object JSON');
195
+ });
196
+ });
197
+
198
+ describe('incrementItemAttribute', () => {
199
+ it('increments the given attribute, starting from 0 if undefined', async() => {
200
+ const testDoc = {coolId: 'my-document-id'};
201
+ data.push(JSON.stringify(testDoc));
202
+ data.push(JSON.stringify({...testDoc, counter: 1}));
203
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
204
+
205
+ expect(await store.incrementItemAttribute('my-document-id', 'counter')).toBe(1);
206
+ const testData = JSON.stringify({...testDoc, counter: 1}, null, 2);
207
+ expect(writeFileSpy).toHaveBeenCalledWith(`file/path/to/db/${hashValue(testDoc.coolId)}.json`, testData, expect.anything());
208
+ expect(await store.incrementItemAttribute('my-document-id', 'counter')).toBe(2);
209
+ const testData2 = JSON.stringify({...testDoc, counter: 2}, null, 2);
210
+ expect(writeFileSpy).toHaveBeenCalledWith(`file/path/to/db/${hashValue(testDoc.coolId)}.json`, testData2, expect.anything());
211
+ });
212
+
213
+ it('throws if the document does not exist', async() => {
214
+ data.push('null');
215
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
216
+ await expect(
217
+ store.incrementItemAttribute('my-document-id', 'counter')
218
+ ).rejects.toThrow('Item with coolId "my-document-id" does not exist');
219
+ expect(writeFileSpy).not.toHaveBeenCalled();
220
+ });
221
+
222
+ it('throws on file write error', async() => {
223
+ const testDoc = {coolId: 'my-document-id', counter: 41};
224
+ data.push(JSON.stringify(testDoc));
225
+ writeError = new Error('foobar error');
226
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
227
+ await expect(store.incrementItemAttribute('my-document-id', 'counter')).rejects.toThrow(writeError);
228
+ });
229
+ });
230
+
231
+ describe('patchItem', () => {
232
+ beforeAll(() => {
233
+ jest.useFakeTimers();
234
+ jest.setSystemTime(new Date(2020, 6, 28));
235
+ });
236
+
237
+ afterAll(() => {
238
+ jest.useRealTimers();
239
+ });
240
+
241
+ it('overwrites only the given attributes and returns updated document', async() => {
242
+ const testDoc = {coolId: 'my-document-id', name: 'my-doc', counter: 42};
243
+ const testDoc2 = {coolId: 'my-document-id', name: 'my-doc-2'};
244
+ data.push(JSON.stringify(testDoc));
245
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
246
+ const result = await store.patchItem(testDoc2);
247
+ const testData = JSON.stringify({...testDoc2, counter: 42}, null, 2);
248
+ expect(writeFileSpy).toHaveBeenCalledWith(`file/path/to/db/${hashValue(testDoc.coolId)}.json`, testData, expect.anything());
249
+ expect(result).toEqual({...testDoc2, counter: 42});
250
+ });
251
+
252
+ it('throws if the key attribute is not provided', async() => {
253
+ const testDoc = {name: 'my-doc'};
254
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
255
+ await expect(store.patchItem(testDoc)).rejects.toThrow('Key attribute "coolId" is required for patchItem');
256
+ });
257
+
258
+ it('throws if there are no updates', async() => {
259
+ const testDoc = {coolId: 'my-document-id'};
260
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
261
+ await expect(store.patchItem(testDoc)).rejects.toThrow('No attributes to update');
262
+ });
263
+
264
+ it('throws if the document does not exist', async() => {
265
+ const testDoc = {coolId: 'my-document-id', name: 'my-doc'};
266
+ data.push('null');
267
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
268
+ await expect(store.patchItem(testDoc)).rejects.toThrow('Item with coolId "my-document-id" does not exist');
269
+ expect(writeFileSpy).not.toHaveBeenCalled();
270
+ });
271
+
272
+ it('throws on file write error', async() => {
273
+ const testDoc = {coolId: 'my-document-id', name: 'my-doc'};
274
+ data.push(JSON.stringify(testDoc));
275
+ writeError = new Error('foobar error');
276
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
277
+ await expect(store.patchItem(testDoc)).rejects.toThrow(writeError);
278
+ });
279
+ });
280
+
281
+ describe('putItem', () => {
282
+ beforeAll(() => {
283
+ jest.useFakeTimers();
284
+ jest.setSystemTime(new Date(2020, 6, 28));
285
+ });
286
+
287
+ afterAll(() => {
288
+ jest.useRealTimers();
289
+ });
290
+
291
+ it('saves and returns new document', async() => {
292
+ const testDoc = {coolId: 'my-document-id', name: 'my-doc'};
293
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
294
+ const result = await store.putItem(testDoc);
295
+ const testData = JSON.stringify(testDoc, null, 2);
296
+ expect(writeFileSpy).toHaveBeenCalledWith(`file/path/to/db/${hashValue(testDoc.coolId)}.json`, testData, expect.anything());
297
+ expect(result).toEqual(testDoc);
298
+ });
299
+
300
+ it('overwrites and returns updated document', async() => {
301
+ const testDoc = {coolId: 'my-document-id', name: 'my-doc'};
302
+ const testDoc2 = {coolId: 'my-document-id', name: 'my-doc-2'};
303
+ data.push(JSON.stringify(testDoc));
304
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
305
+ const result = await store.putItem(testDoc2);
306
+ const testData = JSON.stringify(testDoc2, null, 2);
307
+ expect(writeFileSpy).toHaveBeenCalledWith(`file/path/to/db/${hashValue(testDoc.coolId)}.json`, testData, expect.anything());
308
+ expect(result).toEqual(testDoc2);
309
+ });
310
+
311
+ it('throws on file write error', async() => {
312
+ writeError = new Error('foobar error');
313
+ const testDoc = {coolId: 'my-document-id', name: 'my-doc'};
314
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
315
+ await expect(store.putItem(testDoc)).rejects.toThrow(writeError);
316
+ });
317
+ });
318
+
319
+ describe('createItem', () => {
320
+ it('creates new file with document data', async() => {
321
+ const testDoc = {coolId: 'new-document-id', name: 'new-doc'};
322
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
323
+
324
+ readFileSpy.mockImplementation((_path, callback) => {
325
+ const error = new Error('File not found');
326
+ (error as any).code = 'ENOENT';
327
+ callback(error);
328
+ });
329
+
330
+ const result = await store.createItem(testDoc);
331
+
332
+ const expectedData = JSON.stringify(testDoc, null, 2);
333
+ expect(writeFileSpy).toHaveBeenCalledWith(
334
+ `file/path/to/db/${hashValue(testDoc.coolId)}.json`,
335
+ expectedData,
336
+ expect.anything()
337
+ );
338
+ expect(result).toEqual(testDoc);
339
+ });
340
+
341
+ it('throws ConflictError if file already exists', async() => {
342
+ const testDoc = {coolId: 'existing-document-id', name: 'existing-doc'};
343
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
344
+
345
+ readFileSpy.mockImplementation((_path, callback) => {
346
+ callback(null, Buffer.from('{"coolId":"existing-document-id","name":"existing-doc"}'));
347
+ });
348
+
349
+ await expect(store.createItem(testDoc)).rejects.toThrow('Item with coolId "existing-document-id" already exists');
350
+ });
351
+
352
+ it('throws on read errors during existence check', async() => {
353
+ const testDoc = {coolId: 'new-document-id', name: 'new-doc'};
354
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
355
+
356
+ const readError = new Error('Permission denied');
357
+ readFileSpy.mockImplementation((_path, callback) => {
358
+ callback(readError);
359
+ });
360
+
361
+ await expect(store.createItem(testDoc)).rejects.toThrow('Permission denied');
362
+ });
363
+
364
+ it('throws on file write error', async() => {
365
+ const testDoc = {coolId: 'new-document-id', name: 'new-doc'};
366
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
367
+
368
+ readFileSpy.mockImplementation((_path, callback) => {
369
+ const error = new Error('File not found');
370
+ (error as any).code = 'ENOENT';
371
+ callback(error);
372
+ });
373
+
374
+ writeError = new Error('Write failed');
375
+
376
+ await expect(store.createItem(testDoc)).rejects.toThrow('Write failed');
377
+ });
378
+ });
379
+
380
+ describe('batchCreateItem', () => {
381
+ it('creates multiple new files with document data', async() => {
382
+ const testDocs = [
383
+ {coolId: 'new-document-1', name: 'new-doc-1'},
384
+ {coolId: 'new-document-2', name: 'new-doc-2'},
385
+ {coolId: 'new-document-3', name: 'new-doc-3'}
386
+ ];
387
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
388
+
389
+ readFileSpy.mockImplementation((_path, callback) => {
390
+ const error = new Error('File not found');
391
+ (error as any).code = 'ENOENT';
392
+ callback(error);
393
+ });
394
+
395
+ const result = await store.batchCreateItem(testDocs);
396
+
397
+ expect(writeFileSpy).toHaveBeenCalledTimes(3);
398
+ testDocs.forEach((testDoc) => {
399
+ const expectedData = JSON.stringify(testDoc, null, 2);
400
+ expect(writeFileSpy).toHaveBeenCalledWith(
401
+ `file/path/to/db/${hashValue(testDoc.coolId)}.json`,
402
+ expectedData,
403
+ expect.anything()
404
+ );
405
+ });
406
+ expect(result).toEqual({ successful: testDocs, failed: [] });
407
+ });
408
+
409
+ it('handles empty array', async() => {
410
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
411
+
412
+ const result = await store.batchCreateItem([]);
413
+
414
+ expect(readFileSpy).not.toHaveBeenCalled();
415
+ expect(writeFileSpy).not.toHaveBeenCalled();
416
+ expect(result).toEqual({ successful: [], failed: [] });
417
+ });
418
+
419
+ it('returns successful and failed items when some already exist', async() => {
420
+ const testDocs = [
421
+ {coolId: 'new-document-1', name: 'new-doc-1'},
422
+ {coolId: 'existing-document', name: 'existing-doc'},
423
+ {coolId: 'new-document-3', name: 'new-doc-3'}
424
+ ];
425
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
426
+
427
+ readFileSpy
428
+ .mockImplementationOnce((_path, callback) => {
429
+ const error = new Error('File not found');
430
+ (error as any).code = 'ENOENT';
431
+ callback(error);
432
+ })
433
+ .mockImplementationOnce((_path, callback) => {
434
+ callback(null, Buffer.from('{"coolId":"existing-document","name":"existing-doc"}'));
435
+ })
436
+ .mockImplementationOnce((_path, callback) => {
437
+ const error = new Error('File not found');
438
+ (error as any).code = 'ENOENT';
439
+ callback(error);
440
+ });
441
+
442
+ const result = await store.batchCreateItem(testDocs);
443
+
444
+ expect(result.successful).toEqual([testDocs[0], testDocs[2]]);
445
+ expect(result.failed).toHaveLength(1);
446
+ expect(result.failed[0].item).toEqual(testDocs[1]);
447
+ expect(result.failed[0].error.message).toContain('Item with coolId "existing-document" already exists');
448
+ });
449
+
450
+ it('returns read errors in failed array', async() => {
451
+ const testDocs = [{coolId: 'new-document-1', name: 'new-doc-1'}];
452
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
453
+
454
+ const readError = new Error('Permission denied');
455
+ readFileSpy.mockImplementation((_path, callback) => {
456
+ callback(readError);
457
+ });
458
+
459
+ const result = await store.batchCreateItem(testDocs);
460
+
461
+ expect(result.successful).toEqual([]);
462
+ expect(result.failed).toHaveLength(1);
463
+ expect(result.failed[0].item).toEqual(testDocs[0]);
464
+ expect(result.failed[0].error.message).toBe('Permission denied');
465
+ });
466
+
467
+ it('returns write errors in failed array', async() => {
468
+ const testDocs = [
469
+ {coolId: 'new-document-1', name: 'new-doc-1'},
470
+ {coolId: 'new-document-2', name: 'new-doc-2'}
471
+ ];
472
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
473
+
474
+ readFileSpy.mockImplementation((_path, callback) => {
475
+ const error = new Error('File not found');
476
+ (error as any).code = 'ENOENT';
477
+ callback(error);
478
+ });
479
+
480
+ writeError = new Error('Write failed');
481
+
482
+ const result = await store.batchCreateItem(testDocs);
483
+
484
+ expect(result.successful).toEqual([]);
485
+ expect(result.failed).toHaveLength(2);
486
+ expect(result.failed[0].item).toEqual(testDocs[0]);
487
+ expect(result.failed[0].error.message).toBe('Write failed');
488
+ expect(result.failed[1].item).toEqual(testDocs[1]);
489
+ expect(result.failed[1].error.message).toBe('Write failed');
490
+ });
491
+
492
+ it('processes single item', async() => {
493
+ const testDoc = {coolId: 'new-document-1', name: 'new-doc-1'};
494
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
495
+
496
+ readFileSpy.mockImplementation((_path, callback) => {
497
+ const error = new Error('File not found');
498
+ (error as any).code = 'ENOENT';
499
+ callback(error);
500
+ });
501
+
502
+ const result = await store.batchCreateItem([testDoc]);
503
+
504
+ expect(writeFileSpy).toHaveBeenCalledTimes(1);
505
+ expect(result).toEqual({ successful: [testDoc], failed: [] });
506
+ });
507
+
508
+ it('ignores concurrency parameter for filesystem', async() => {
509
+ const testDocs = [
510
+ {coolId: 'new-document-1', name: 'new-doc-1'},
511
+ {coolId: 'new-document-2', name: 'new-doc-2'}
512
+ ];
513
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId');
514
+
515
+ readFileSpy.mockImplementation((_path, callback) => {
516
+ const error = new Error('File not found');
517
+ (error as any).code = 'ENOENT';
518
+ callback(error);
519
+ });
520
+
521
+ const result = await store.batchCreateItem(testDocs, 100); // High concurrency ignored
522
+
523
+ expect(result).toEqual({ successful: testDocs, failed: [] });
524
+ });
525
+
526
+ it('calls batchAfterWrite instead of individual afterWrite', async() => {
527
+ const afterWrite = jest.fn();
528
+ const batchAfterWrite = jest.fn();
529
+ const testDocs = [
530
+ {coolId: 'new-document-1', name: 'new-doc-1'},
531
+ {coolId: 'new-document-2', name: 'new-doc-2'}
532
+ ];
533
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId', {afterWrite, batchAfterWrite});
534
+
535
+ readFileSpy.mockImplementation((_path, callback) => {
536
+ const error = new Error('File not found');
537
+ (error as any).code = 'ENOENT';
538
+ callback(error);
539
+ });
540
+
541
+ const result = await store.batchCreateItem(testDocs);
542
+
543
+ // Should call batchAfterWrite once with all successful items
544
+ expect(batchAfterWrite).toHaveBeenCalledTimes(1);
545
+ expect(batchAfterWrite).toHaveBeenCalledWith(testDocs);
546
+
547
+ // Should NOT call individual afterWrite when batchAfterWrite is defined
548
+ expect(afterWrite).not.toHaveBeenCalled();
549
+
550
+ expect(result).toEqual({ successful: testDocs, failed: [] });
551
+ });
552
+
553
+ it('calls batchAfterWrite only with successful items', async() => {
554
+ const batchAfterWrite = jest.fn();
555
+ const testDocs = [
556
+ {coolId: 'new-document-1', name: 'new-doc-1'},
557
+ {coolId: 'existing-document', name: 'existing-doc'},
558
+ {coolId: 'new-document-3', name: 'new-doc-3'}
559
+ ];
560
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId', {batchAfterWrite});
561
+
562
+ readFileSpy
563
+ .mockImplementationOnce((_path, callback) => {
564
+ const error = new Error('File not found');
565
+ (error as any).code = 'ENOENT';
566
+ callback(error);
567
+ })
568
+ .mockImplementationOnce((_path, callback) => {
569
+ callback(null, Buffer.from('{"coolId":"existing-document","name":"existing-doc"}'));
570
+ })
571
+ .mockImplementationOnce((_path, callback) => {
572
+ const error = new Error('File not found');
573
+ (error as any).code = 'ENOENT';
574
+ callback(error);
575
+ });
576
+
577
+ const result = await store.batchCreateItem(testDocs);
578
+
579
+ // Should call batchAfterWrite with only successful items
580
+ expect(batchAfterWrite).toHaveBeenCalledTimes(1);
581
+ expect(batchAfterWrite).toHaveBeenCalledWith([testDocs[0], testDocs[2]]);
582
+
583
+ expect(result.successful).toEqual([testDocs[0], testDocs[2]]);
584
+ expect(result.failed).toHaveLength(1);
585
+ });
586
+
587
+ it('does not call batchAfterWrite if no items succeed', async() => {
588
+ const batchAfterWrite = jest.fn();
589
+ const testDocs = [{coolId: 'existing-document', name: 'existing-doc'}];
590
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId', {batchAfterWrite});
591
+
592
+ readFileSpy.mockImplementation((_path, callback) => {
593
+ callback(null, Buffer.from('{"coolId":"existing-document","name":"existing-doc"}'));
594
+ });
595
+
596
+ const result = await store.batchCreateItem(testDocs);
597
+
598
+ // Should NOT call batchAfterWrite when no items succeed
599
+ expect(batchAfterWrite).not.toHaveBeenCalled();
600
+
601
+ expect(result.successful).toEqual([]);
602
+ expect(result.failed).toHaveLength(1);
603
+ });
604
+
605
+ it('falls back to individual afterWrite when batchAfterWrite is not defined', async() => {
606
+ const afterWrite = jest.fn();
607
+ const testDocs = [
608
+ {coolId: 'new-document-1', name: 'new-doc-1'},
609
+ {coolId: 'new-document-2', name: 'new-doc-2'}
610
+ ];
611
+ const store = fileSystemUnversionedDocumentStore({fs, dataDir: 'file/path/to'})<TTestDocument>()(config)(middleware, 'coolId', {afterWrite});
612
+
613
+ readFileSpy.mockImplementation((_path, callback) => {
614
+ const error = new Error('File not found');
615
+ (error as any).code = 'ENOENT';
616
+ callback(error);
617
+ });
618
+
619
+ const result = await store.batchCreateItem(testDocs);
620
+
621
+ // Should call afterWrite for each item when batchAfterWrite is not defined
622
+ expect(afterWrite).toHaveBeenCalledTimes(2);
623
+ expect(afterWrite).toHaveBeenCalledWith(testDocs[0]);
624
+ expect(afterWrite).toHaveBeenCalledWith(testDocs[1]);
625
+
626
+ expect(result).toEqual({ successful: testDocs, failed: [] });
627
+ });
628
+ });
629
+ });