@lastshotlabs/bunshot 0.0.25 → 0.0.28

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 (725) hide show
  1. package/.oclif.manifest.json +39 -0
  2. package/README.md +8282 -2147
  3. package/dist/cli/commands/init.js +690 -0
  4. package/dist/cli/index.js +6 -0
  5. package/dist/cli.js +4 -4
  6. package/dist/packages/bunshot-admin/src/index.d.ts +15 -0
  7. package/dist/packages/bunshot-admin/src/index.js +11 -0
  8. package/dist/packages/bunshot-admin/src/lib/resourceTypes.d.ts +8 -0
  9. package/dist/packages/bunshot-admin/src/lib/resourceTypes.js +33 -0
  10. package/dist/packages/bunshot-admin/src/lib/typedRoute.d.ts +14 -0
  11. package/dist/packages/bunshot-admin/src/lib/typedRoute.js +17 -0
  12. package/dist/packages/bunshot-admin/src/plugin.d.ts +4 -0
  13. package/dist/packages/bunshot-admin/src/plugin.js +46 -0
  14. package/dist/packages/bunshot-admin/src/providers/auth0Access.d.ts +6 -0
  15. package/dist/packages/bunshot-admin/src/providers/auth0Access.js +32 -0
  16. package/dist/packages/bunshot-admin/src/routes/admin.d.ts +10 -0
  17. package/dist/packages/bunshot-admin/src/routes/admin.js +923 -0
  18. package/dist/packages/bunshot-admin/src/routes/mail.d.ts +6 -0
  19. package/dist/packages/bunshot-admin/src/routes/mail.js +114 -0
  20. package/dist/packages/bunshot-admin/src/routes/permissions.d.ts +8 -0
  21. package/dist/packages/bunshot-admin/src/routes/permissions.js +315 -0
  22. package/dist/packages/bunshot-admin/src/types/config.d.ts +16 -0
  23. package/dist/packages/bunshot-admin/src/types/config.js +37 -0
  24. package/dist/packages/bunshot-admin/src/types/env.d.ts +14 -0
  25. package/dist/packages/bunshot-admin/src/types/provider.d.ts +1 -0
  26. package/dist/packages/bunshot-admin/src/types/provider.js +4 -0
  27. package/dist/packages/bunshot-auth/src/adapters/memoryAuth.d.ts +66 -0
  28. package/dist/packages/bunshot-auth/src/adapters/memoryAuth.js +1063 -0
  29. package/dist/packages/bunshot-auth/src/adapters/mongoAuth.d.ts +2 -0
  30. package/dist/packages/bunshot-auth/src/adapters/mongoAuth.js +536 -0
  31. package/dist/packages/bunshot-auth/src/adapters/sqliteAuth.d.ts +88 -0
  32. package/dist/packages/bunshot-auth/src/adapters/sqliteAuth.js +1366 -0
  33. package/dist/packages/bunshot-auth/src/admin/bunshotAccess.d.ts +2 -0
  34. package/dist/packages/bunshot-auth/src/admin/bunshotAccess.js +23 -0
  35. package/dist/packages/bunshot-auth/src/admin/bunshotUsers.d.ts +5 -0
  36. package/dist/packages/bunshot-auth/src/admin/bunshotUsers.js +131 -0
  37. package/dist/packages/bunshot-auth/src/bootstrap.d.ts +38 -0
  38. package/dist/packages/bunshot-auth/src/bootstrap.js +384 -0
  39. package/dist/packages/bunshot-auth/src/config/appConfig.d.ts +3 -0
  40. package/dist/packages/bunshot-auth/src/config/appConfig.js +4 -0
  41. package/dist/packages/bunshot-auth/src/config/authConfig.d.ts +478 -0
  42. package/dist/packages/bunshot-auth/src/config/authConfig.js +46 -0
  43. package/dist/packages/bunshot-auth/src/config/configLock.d.ts +2 -0
  44. package/dist/packages/bunshot-auth/src/config/configLock.js +10 -0
  45. package/dist/packages/bunshot-auth/src/index.d.ts +25 -0
  46. package/dist/packages/bunshot-auth/src/index.js +23 -0
  47. package/dist/packages/bunshot-auth/src/infra/mongo.d.ts +15 -0
  48. package/dist/packages/bunshot-auth/src/infra/mongo.js +44 -0
  49. package/dist/packages/bunshot-auth/src/infra/queue.d.ts +14 -0
  50. package/dist/packages/bunshot-auth/src/infra/queue.js +27 -0
  51. package/dist/packages/bunshot-auth/src/infra/redis.d.ts +5 -0
  52. package/dist/packages/bunshot-auth/src/infra/redis.js +15 -0
  53. package/dist/packages/bunshot-auth/src/infra/signing.d.ts +7 -0
  54. package/dist/packages/bunshot-auth/src/infra/signing.js +8 -0
  55. package/dist/packages/bunshot-auth/src/lib/accountLockout.d.ts +34 -0
  56. package/dist/packages/bunshot-auth/src/lib/accountLockout.js +244 -0
  57. package/dist/packages/bunshot-auth/src/lib/adapterTiers.d.ts +1 -0
  58. package/dist/packages/bunshot-auth/src/lib/adapterTiers.js +1 -0
  59. package/dist/packages/bunshot-auth/src/lib/authAdapter.d.ts +1 -0
  60. package/dist/packages/bunshot-auth/src/lib/authAdapter.js +1 -0
  61. package/dist/packages/bunshot-auth/src/lib/authContext.d.ts +15 -0
  62. package/dist/packages/bunshot-auth/src/lib/authContext.js +1 -0
  63. package/dist/packages/bunshot-auth/src/lib/authEventBus.d.ts +4 -0
  64. package/dist/packages/bunshot-auth/src/lib/authEventBus.js +15 -0
  65. package/dist/packages/bunshot-auth/src/lib/authRateLimit.d.ts +28 -0
  66. package/dist/packages/bunshot-auth/src/lib/authRateLimit.js +205 -0
  67. package/dist/packages/bunshot-auth/src/lib/breachedPassword.d.ts +19 -0
  68. package/dist/packages/bunshot-auth/src/lib/breachedPassword.js +61 -0
  69. package/dist/packages/bunshot-auth/src/lib/cache.d.ts +12 -0
  70. package/dist/packages/bunshot-auth/src/lib/cache.js +120 -0
  71. package/dist/packages/bunshot-auth/src/lib/clientIp.d.ts +4 -0
  72. package/dist/{lib → packages/bunshot-auth/src/lib}/clientIp.js +14 -7
  73. package/dist/packages/bunshot-auth/src/lib/cookieOptions.d.ts +27 -0
  74. package/dist/packages/bunshot-auth/src/lib/cookieOptions.js +33 -0
  75. package/dist/packages/bunshot-auth/src/lib/credentialStuffing.d.ts +40 -0
  76. package/dist/packages/bunshot-auth/src/lib/credentialStuffing.js +221 -0
  77. package/dist/packages/bunshot-auth/src/lib/deletionCancelToken.d.ts +19 -0
  78. package/dist/packages/bunshot-auth/src/lib/deletionCancelToken.js +148 -0
  79. package/dist/packages/bunshot-auth/src/lib/emailTemplates.d.ts +23 -0
  80. package/dist/packages/bunshot-auth/src/lib/emailTemplates.js +265 -0
  81. package/dist/packages/bunshot-auth/src/lib/emailVerification.d.ts +30 -0
  82. package/dist/packages/bunshot-auth/src/lib/emailVerification.js +200 -0
  83. package/dist/packages/bunshot-auth/src/lib/env.d.ts +1 -0
  84. package/dist/packages/bunshot-auth/src/lib/env.js +3 -0
  85. package/dist/packages/bunshot-auth/src/lib/fingerprint.js +36 -0
  86. package/dist/{lib → packages/bunshot-auth/src/lib}/groups.d.ts +15 -16
  87. package/dist/{lib → packages/bunshot-auth/src/lib}/groups.js +22 -34
  88. package/dist/packages/bunshot-auth/src/lib/jwks.d.ts +28 -0
  89. package/dist/packages/bunshot-auth/src/lib/jwks.js +79 -0
  90. package/dist/packages/bunshot-auth/src/lib/jwt.d.ts +12 -0
  91. package/dist/packages/bunshot-auth/src/lib/jwt.js +86 -0
  92. package/dist/packages/bunshot-auth/src/lib/logger.d.ts +3 -0
  93. package/dist/packages/bunshot-auth/src/lib/logger.js +13 -0
  94. package/dist/packages/bunshot-auth/src/lib/m2m.d.ts +30 -0
  95. package/dist/packages/bunshot-auth/src/lib/m2m.js +44 -0
  96. package/dist/packages/bunshot-auth/src/lib/magicLink.d.ts +13 -0
  97. package/dist/packages/bunshot-auth/src/lib/magicLink.js +145 -0
  98. package/dist/packages/bunshot-auth/src/lib/mfaChallenge.d.ts +60 -0
  99. package/dist/packages/bunshot-auth/src/lib/mfaChallenge.js +419 -0
  100. package/dist/packages/bunshot-auth/src/lib/oauth.d.ts +82 -0
  101. package/dist/packages/bunshot-auth/src/lib/oauth.js +177 -0
  102. package/dist/packages/bunshot-auth/src/lib/oauthCode.d.ts +19 -0
  103. package/dist/packages/bunshot-auth/src/lib/oauthCode.js +182 -0
  104. package/dist/packages/bunshot-auth/src/lib/oauthReauth.d.ts +19 -0
  105. package/dist/packages/bunshot-auth/src/lib/oauthReauth.js +255 -0
  106. package/dist/packages/bunshot-auth/src/lib/organization.d.ts +66 -0
  107. package/dist/packages/bunshot-auth/src/lib/organization.js +225 -0
  108. package/dist/packages/bunshot-auth/src/lib/passwordHistory.d.ts +12 -0
  109. package/dist/packages/bunshot-auth/src/lib/passwordHistory.js +31 -0
  110. package/dist/packages/bunshot-auth/src/lib/resetPassword.d.ts +20 -0
  111. package/dist/packages/bunshot-auth/src/lib/resetPassword.js +148 -0
  112. package/dist/packages/bunshot-auth/src/lib/roles.d.ts +9 -0
  113. package/dist/packages/bunshot-auth/src/lib/roles.js +93 -0
  114. package/dist/packages/bunshot-auth/src/lib/saml.d.ts +29 -0
  115. package/dist/packages/bunshot-auth/src/lib/saml.js +73 -0
  116. package/dist/packages/bunshot-auth/src/lib/samlRequestId.d.ts +13 -0
  117. package/dist/packages/bunshot-auth/src/lib/samlRequestId.js +129 -0
  118. package/dist/packages/bunshot-auth/src/lib/scim.d.ts +44 -0
  119. package/dist/packages/bunshot-auth/src/lib/scim.js +56 -0
  120. package/dist/packages/bunshot-auth/src/lib/securityEventWiring.d.ts +22 -0
  121. package/dist/packages/bunshot-auth/src/lib/securityEventWiring.js +65 -0
  122. package/dist/packages/bunshot-auth/src/lib/session.d.ts +45 -0
  123. package/dist/packages/bunshot-auth/src/lib/session.js +1211 -0
  124. package/dist/packages/bunshot-auth/src/lib/storeInfra.d.ts +26 -0
  125. package/dist/packages/bunshot-auth/src/lib/storeInfra.js +18 -0
  126. package/dist/packages/bunshot-auth/src/lib/suspension.d.ts +14 -0
  127. package/dist/packages/bunshot-auth/src/lib/suspension.js +20 -0
  128. package/dist/packages/bunshot-auth/src/lib/validateAdapter.d.ts +16 -0
  129. package/dist/packages/bunshot-auth/src/lib/validateAdapter.js +161 -0
  130. package/dist/packages/bunshot-auth/src/middleware/bearerAuth.d.ts +13 -0
  131. package/dist/packages/bunshot-auth/src/middleware/bearerAuth.js +58 -0
  132. package/dist/{middleware → packages/bunshot-auth/src/middleware}/csrf.d.ts +5 -4
  133. package/dist/packages/bunshot-auth/src/middleware/csrf.js +138 -0
  134. package/dist/packages/bunshot-auth/src/middleware/identify.d.ts +4 -0
  135. package/dist/packages/bunshot-auth/src/middleware/identify.js +124 -0
  136. package/dist/{middleware → packages/bunshot-auth/src/middleware}/requireMfaSetup.d.ts +2 -2
  137. package/dist/{middleware → packages/bunshot-auth/src/middleware}/requireMfaSetup.js +10 -7
  138. package/dist/{middleware → packages/bunshot-auth/src/middleware}/requireRole.d.ts +2 -2
  139. package/dist/{middleware → packages/bunshot-auth/src/middleware}/requireRole.js +20 -16
  140. package/dist/packages/bunshot-auth/src/middleware/requireScope.d.ts +10 -0
  141. package/dist/packages/bunshot-auth/src/middleware/requireScope.js +25 -0
  142. package/dist/packages/bunshot-auth/src/middleware/requireStepUp.d.ts +18 -0
  143. package/dist/packages/bunshot-auth/src/middleware/requireStepUp.js +30 -0
  144. package/dist/{middleware → packages/bunshot-auth/src/middleware}/requireVerifiedEmail.d.ts +2 -2
  145. package/dist/{middleware → packages/bunshot-auth/src/middleware}/requireVerifiedEmail.js +7 -6
  146. package/dist/packages/bunshot-auth/src/middleware/scimAuth.d.ts +8 -0
  147. package/dist/packages/bunshot-auth/src/middleware/scimAuth.js +29 -0
  148. package/dist/packages/bunshot-auth/src/middleware/userAuth.d.ts +3 -0
  149. package/dist/packages/bunshot-auth/src/middleware/userAuth.js +6 -0
  150. package/dist/{models → packages/bunshot-auth/src/models}/AuthUser.d.ts +19 -8
  151. package/dist/packages/bunshot-auth/src/models/AuthUser.js +53 -0
  152. package/dist/packages/bunshot-auth/src/models/Group.d.ts +19 -0
  153. package/dist/packages/bunshot-auth/src/models/Group.js +22 -0
  154. package/dist/{models → packages/bunshot-auth/src/models}/GroupMembership.d.ts +6 -8
  155. package/dist/packages/bunshot-auth/src/models/GroupMembership.js +19 -0
  156. package/dist/packages/bunshot-auth/src/models/M2MClient.d.ts +18 -0
  157. package/dist/packages/bunshot-auth/src/models/M2MClient.js +18 -0
  158. package/dist/packages/bunshot-auth/src/models/TenantRole.d.ts +13 -0
  159. package/dist/packages/bunshot-auth/src/models/TenantRole.js +17 -0
  160. package/dist/packages/bunshot-auth/src/plugin.d.ts +4 -0
  161. package/dist/packages/bunshot-auth/src/plugin.js +274 -0
  162. package/dist/packages/bunshot-auth/src/routes/auth.d.ts +15 -0
  163. package/dist/packages/bunshot-auth/src/routes/auth.js +1624 -0
  164. package/dist/packages/bunshot-auth/src/routes/groups.d.ts +4 -0
  165. package/dist/packages/bunshot-auth/src/routes/groups.js +481 -0
  166. package/dist/packages/bunshot-auth/src/routes/m2m.d.ts +2 -0
  167. package/dist/packages/bunshot-auth/src/routes/m2m.js +145 -0
  168. package/dist/packages/bunshot-auth/src/routes/mfa.d.ts +6 -0
  169. package/dist/packages/bunshot-auth/src/routes/mfa.js +991 -0
  170. package/dist/packages/bunshot-auth/src/routes/oauth.d.ts +3 -0
  171. package/dist/packages/bunshot-auth/src/routes/oauth.js +1727 -0
  172. package/dist/packages/bunshot-auth/src/routes/oidc.d.ts +2 -0
  173. package/dist/packages/bunshot-auth/src/routes/oidc.js +84 -0
  174. package/dist/packages/bunshot-auth/src/routes/organizations.d.ts +3 -0
  175. package/dist/packages/bunshot-auth/src/routes/organizations.js +741 -0
  176. package/dist/packages/bunshot-auth/src/routes/passkey.d.ts +2 -0
  177. package/dist/packages/bunshot-auth/src/routes/passkey.js +199 -0
  178. package/dist/packages/bunshot-auth/src/routes/saml.d.ts +2 -0
  179. package/dist/packages/bunshot-auth/src/routes/saml.js +226 -0
  180. package/dist/packages/bunshot-auth/src/routes/scim.d.ts +3 -0
  181. package/dist/packages/bunshot-auth/src/routes/scim.js +588 -0
  182. package/dist/packages/bunshot-auth/src/runtime.d.ts +52 -0
  183. package/dist/packages/bunshot-auth/src/runtime.js +11 -0
  184. package/dist/{schemas → packages/bunshot-auth/src/schemas}/auth.d.ts +4 -5
  185. package/dist/packages/bunshot-auth/src/schemas/auth.js +24 -0
  186. package/dist/packages/bunshot-auth/src/schemas/error.d.ts +10 -0
  187. package/dist/packages/bunshot-auth/src/schemas/error.js +10 -0
  188. package/dist/packages/bunshot-auth/src/schemas/success.d.ts +10 -0
  189. package/dist/packages/bunshot-auth/src/schemas/success.js +10 -0
  190. package/dist/packages/bunshot-auth/src/services/auth.d.ts +39 -0
  191. package/dist/packages/bunshot-auth/src/services/auth.js +378 -0
  192. package/dist/{services → packages/bunshot-auth/src/services}/mfa.d.ts +41 -17
  193. package/dist/{services → packages/bunshot-auth/src/services}/mfa.js +259 -183
  194. package/dist/packages/bunshot-auth/src/testing.d.ts +31 -0
  195. package/dist/packages/bunshot-auth/src/testing.js +23 -0
  196. package/dist/packages/bunshot-auth/src/types/adapter.d.ts +1 -0
  197. package/dist/packages/bunshot-auth/src/types/adapter.js +1 -0
  198. package/dist/packages/bunshot-auth/src/types/config.d.ts +152 -0
  199. package/dist/packages/bunshot-auth/src/types/config.js +179 -0
  200. package/dist/{routes → packages/bunshot-auth/src/types}/groups.d.ts +2 -3
  201. package/dist/packages/bunshot-auth/src/types/groups.js +1 -0
  202. package/dist/packages/bunshot-auth/src/types/oauthCode.d.ts +6 -0
  203. package/dist/packages/bunshot-auth/src/types/oauthCode.js +1 -0
  204. package/dist/packages/bunshot-auth/src/types/oauthReauth.d.ts +13 -0
  205. package/dist/packages/bunshot-auth/src/types/oauthReauth.js +1 -0
  206. package/dist/packages/bunshot-auth/src/types/redis.d.ts +1 -0
  207. package/dist/packages/bunshot-auth/src/types/redis.js +1 -0
  208. package/dist/packages/bunshot-auth/src/types/saml.d.ts +10 -0
  209. package/dist/packages/bunshot-auth/src/types/saml.js +1 -0
  210. package/dist/packages/bunshot-auth/src/types/session.d.ts +18 -0
  211. package/dist/packages/bunshot-auth/src/types/session.js +1 -0
  212. package/dist/packages/bunshot-auth/src/types/store.d.ts +1 -0
  213. package/dist/packages/bunshot-auth/src/types/store.js +1 -0
  214. package/dist/packages/bunshot-core/src/adminProvider.d.ts +95 -0
  215. package/dist/packages/bunshot-core/src/adminProvider.js +1 -0
  216. package/dist/packages/bunshot-core/src/auditLog.d.ts +34 -0
  217. package/dist/packages/bunshot-core/src/auditLog.js +1 -0
  218. package/dist/packages/bunshot-core/src/auth-adapter.d.ts +227 -0
  219. package/dist/packages/bunshot-core/src/auth-adapter.js +4 -0
  220. package/dist/packages/bunshot-core/src/authVariables.d.ts +14 -0
  221. package/dist/packages/bunshot-core/src/authVariables.js +4 -0
  222. package/dist/packages/bunshot-core/src/cache.d.ts +12 -0
  223. package/dist/packages/bunshot-core/src/cache.js +21 -0
  224. package/dist/packages/bunshot-core/src/captcha.d.ts +16 -0
  225. package/dist/packages/bunshot-core/src/captcha.js +1 -0
  226. package/dist/packages/bunshot-core/src/clearRegistry.d.ts +6 -0
  227. package/dist/packages/bunshot-core/src/clearRegistry.js +17 -0
  228. package/dist/packages/bunshot-core/src/clientIp.d.ts +3 -0
  229. package/dist/packages/bunshot-core/src/clientIp.js +45 -0
  230. package/dist/packages/bunshot-core/src/configLock.d.ts +4 -0
  231. package/dist/packages/bunshot-core/src/configLock.js +7 -0
  232. package/dist/packages/bunshot-core/src/configValidation.d.ts +22 -0
  233. package/dist/packages/bunshot-core/src/configValidation.js +39 -0
  234. package/dist/packages/bunshot-core/src/constants.js +10 -0
  235. package/dist/packages/bunshot-core/src/context/bunshotContext.d.ts +232 -0
  236. package/dist/packages/bunshot-core/src/context/bunshotContext.js +1 -0
  237. package/dist/packages/bunshot-core/src/context/contextAccess.d.ts +3 -0
  238. package/dist/packages/bunshot-core/src/context/contextAccess.js +16 -0
  239. package/dist/packages/bunshot-core/src/context/contextStore.d.ts +16 -0
  240. package/dist/packages/bunshot-core/src/context/contextStore.js +31 -0
  241. package/dist/packages/bunshot-core/src/context/frameworkConfig.d.ts +38 -0
  242. package/dist/packages/bunshot-core/src/context/frameworkConfig.js +1 -0
  243. package/dist/packages/bunshot-core/src/context/index.d.ts +4 -0
  244. package/dist/packages/bunshot-core/src/context/index.js +2 -0
  245. package/dist/packages/bunshot-core/src/context.d.ts +40 -0
  246. package/dist/packages/bunshot-core/src/context.js +35 -0
  247. package/dist/packages/bunshot-core/src/coreContracts.d.ts +47 -0
  248. package/dist/packages/bunshot-core/src/coreContracts.js +1 -0
  249. package/dist/packages/bunshot-core/src/coreRegistrar.d.ts +6 -0
  250. package/dist/packages/bunshot-core/src/coreRegistrar.js +42 -0
  251. package/dist/{lib → packages/bunshot-core/src}/createRoute.d.ts +4 -30
  252. package/dist/{lib → packages/bunshot-core/src}/createRoute.js +39 -88
  253. package/dist/packages/bunshot-core/src/cronRegistry.d.ts +11 -0
  254. package/dist/packages/bunshot-core/src/cronRegistry.js +1 -0
  255. package/dist/packages/bunshot-core/src/crypto.d.ts +43 -0
  256. package/dist/packages/bunshot-core/src/crypto.js +74 -0
  257. package/dist/packages/bunshot-core/src/csrf.d.ts +8 -0
  258. package/dist/packages/bunshot-core/src/csrf.js +1 -0
  259. package/dist/packages/bunshot-core/src/defaults/defaultFingerprint.d.ts +7 -0
  260. package/dist/packages/bunshot-core/src/defaults/defaultFingerprint.js +19 -0
  261. package/dist/packages/bunshot-core/src/defaults/memoryCacheAdapter.d.ts +6 -0
  262. package/dist/packages/bunshot-core/src/defaults/memoryCacheAdapter.js +40 -0
  263. package/dist/packages/bunshot-core/src/defaults/memoryRateLimit.d.ts +6 -0
  264. package/dist/packages/bunshot-core/src/defaults/memoryRateLimit.js +24 -0
  265. package/dist/packages/bunshot-core/src/emailTemplates.d.ts +5 -0
  266. package/dist/packages/bunshot-core/src/emailTemplates.js +10 -0
  267. package/dist/packages/bunshot-core/src/errors.d.ts +13 -0
  268. package/dist/packages/bunshot-core/src/errors.js +22 -0
  269. package/dist/packages/bunshot-core/src/eventBus.d.ts +270 -0
  270. package/dist/packages/bunshot-core/src/eventBus.js +143 -0
  271. package/dist/packages/bunshot-core/src/idempotency.d.ts +18 -0
  272. package/dist/packages/bunshot-core/src/idempotency.js +1 -0
  273. package/dist/packages/bunshot-core/src/index.d.ts +60 -0
  274. package/dist/packages/bunshot-core/src/index.js +34 -0
  275. package/dist/packages/bunshot-core/src/mail.d.ts +14 -0
  276. package/dist/packages/bunshot-core/src/mail.js +8 -0
  277. package/dist/packages/bunshot-core/src/memoryEviction.d.ts +24 -0
  278. package/dist/packages/bunshot-core/src/memoryEviction.js +52 -0
  279. package/dist/packages/bunshot-core/src/pagination.d.ts +45 -0
  280. package/dist/packages/bunshot-core/src/pagination.js +61 -0
  281. package/dist/packages/bunshot-core/src/permissions.d.ts +64 -0
  282. package/dist/packages/bunshot-core/src/permissions.js +27 -0
  283. package/dist/packages/bunshot-core/src/plugin.d.ts +44 -0
  284. package/dist/packages/bunshot-core/src/plugin.js +1 -0
  285. package/dist/packages/bunshot-core/src/rateLimit.d.ts +5 -0
  286. package/dist/packages/bunshot-core/src/rateLimit.js +18 -0
  287. package/dist/packages/bunshot-core/src/redis.d.ts +21 -0
  288. package/dist/packages/bunshot-core/src/redis.js +1 -0
  289. package/dist/packages/bunshot-core/src/routeAuth.d.ts +5 -0
  290. package/dist/packages/bunshot-core/src/routeAuth.js +11 -0
  291. package/dist/packages/bunshot-core/src/routeOverrides.d.ts +24 -0
  292. package/dist/packages/bunshot-core/src/routeOverrides.js +25 -0
  293. package/dist/packages/bunshot-core/src/routerAdapter.d.ts +6 -0
  294. package/dist/packages/bunshot-core/src/routerAdapter.js +56 -0
  295. package/dist/packages/bunshot-core/src/secrets.d.ts +48 -0
  296. package/dist/packages/bunshot-core/src/secrets.js +8 -0
  297. package/dist/packages/bunshot-core/src/signing.d.ts +41 -0
  298. package/dist/packages/bunshot-core/src/signing.js +1 -0
  299. package/dist/packages/bunshot-core/src/sse.d.ts +36 -0
  300. package/dist/packages/bunshot-core/src/sse.js +1 -0
  301. package/dist/packages/bunshot-core/src/storageAdapter.js +1 -0
  302. package/dist/packages/bunshot-core/src/storeInfra.d.ts +44 -0
  303. package/dist/packages/bunshot-core/src/storeInfra.js +18 -0
  304. package/dist/packages/bunshot-core/src/storeType.d.ts +7 -0
  305. package/dist/packages/bunshot-core/src/storeType.js +1 -0
  306. package/dist/packages/bunshot-core/src/testing.d.ts +1 -0
  307. package/dist/packages/bunshot-core/src/testing.js +1 -0
  308. package/dist/packages/bunshot-core/src/uploadRegistry.d.ts +23 -0
  309. package/dist/packages/bunshot-core/src/uploadRegistry.js +4 -0
  310. package/dist/packages/bunshot-core/src/userResolver.d.ts +5 -0
  311. package/dist/packages/bunshot-core/src/userResolver.js +14 -0
  312. package/dist/packages/bunshot-core/src/wsMessages.d.ts +42 -0
  313. package/dist/packages/bunshot-core/src/wsMessages.js +4 -0
  314. package/dist/packages/bunshot-permissions/src/adapters/memory.d.ts +7 -0
  315. package/dist/packages/bunshot-permissions/src/adapters/memory.js +73 -0
  316. package/dist/packages/bunshot-permissions/src/index.d.ts +10 -0
  317. package/dist/packages/bunshot-permissions/src/index.js +5 -0
  318. package/dist/packages/bunshot-permissions/src/lib/bootstrap.d.ts +7 -0
  319. package/dist/packages/bunshot-permissions/src/lib/bootstrap.js +12 -0
  320. package/dist/packages/bunshot-permissions/src/lib/evaluator.d.ts +10 -0
  321. package/dist/packages/bunshot-permissions/src/lib/evaluator.js +165 -0
  322. package/dist/packages/bunshot-permissions/src/lib/registry.d.ts +2 -0
  323. package/dist/packages/bunshot-permissions/src/lib/registry.js +31 -0
  324. package/dist/packages/bunshot-permissions/src/lib/validation.d.ts +1 -0
  325. package/dist/packages/bunshot-permissions/src/lib/validation.js +1 -0
  326. package/dist/packages/bunshot-permissions/src/types/adapter.d.ts +1 -0
  327. package/dist/packages/bunshot-permissions/src/types/adapter.js +1 -0
  328. package/dist/packages/bunshot-permissions/src/types/evaluator.d.ts +1 -0
  329. package/dist/packages/bunshot-permissions/src/types/evaluator.js +1 -0
  330. package/dist/packages/bunshot-permissions/src/types/models.d.ts +1 -0
  331. package/dist/packages/bunshot-permissions/src/types/models.js +1 -0
  332. package/dist/packages/bunshot-permissions/src/types/registry.d.ts +1 -0
  333. package/dist/packages/bunshot-permissions/src/types/registry.js +1 -0
  334. package/dist/packages/bunshot-postgres/src/adapter.d.ts +6 -0
  335. package/dist/packages/bunshot-postgres/src/adapter.js +794 -0
  336. package/dist/packages/bunshot-postgres/src/connection.d.ts +15 -0
  337. package/dist/packages/bunshot-postgres/src/connection.js +16 -0
  338. package/dist/packages/bunshot-postgres/src/index.d.ts +4 -0
  339. package/dist/packages/bunshot-postgres/src/index.js +2 -0
  340. package/dist/packages/bunshot-postgres/src/schema.d.ts +997 -0
  341. package/dist/packages/bunshot-postgres/src/schema.js +105 -0
  342. package/dist/src/app.d.ts +230 -0
  343. package/dist/src/app.js +182 -0
  344. package/dist/src/cli/commands/init.d.ts +10 -0
  345. package/dist/src/cli/commands/init.js +709 -0
  346. package/dist/src/cli/index.d.ts +1 -0
  347. package/dist/src/cli/index.js +3 -0
  348. package/dist/src/entrypoints/mongo.d.ts +6 -0
  349. package/dist/src/entrypoints/mongo.js +4 -0
  350. package/dist/src/entrypoints/queue.d.ts +2 -0
  351. package/dist/src/entrypoints/queue.js +1 -0
  352. package/dist/src/entrypoints/redis.d.ts +1 -0
  353. package/dist/src/entrypoints/redis.js +1 -0
  354. package/dist/{adapters → src/framework/adapters}/localStorage.d.ts +1 -1
  355. package/dist/{adapters → src/framework/adapters}/localStorage.js +23 -8
  356. package/dist/src/framework/adapters/memoryStorage.d.ts +2 -0
  357. package/dist/src/framework/adapters/memoryStorage.js +45 -0
  358. package/dist/{adapters → src/framework/adapters}/s3Storage.d.ts +1 -1
  359. package/dist/{adapters → src/framework/adapters}/s3Storage.js +12 -12
  360. package/dist/src/framework/admin/bunshotAccess.d.ts +2 -0
  361. package/dist/src/framework/admin/bunshotAccess.js +23 -0
  362. package/dist/src/framework/admin/bunshotUsers.d.ts +2 -0
  363. package/dist/src/framework/admin/bunshotUsers.js +103 -0
  364. package/dist/src/framework/admin/index.d.ts +7 -0
  365. package/dist/src/framework/admin/index.js +21 -0
  366. package/dist/src/framework/boundaryAdapters/cacheFactories.d.ts +13 -0
  367. package/dist/src/framework/boundaryAdapters/cacheFactories.js +86 -0
  368. package/dist/src/framework/boundaryAdapters/index.d.ts +2 -0
  369. package/dist/src/framework/boundaryAdapters/index.js +1 -0
  370. package/dist/src/framework/boundaryAdapters.d.ts +17 -0
  371. package/dist/src/framework/boundaryAdapters.js +62 -0
  372. package/dist/src/framework/buildContext.d.ts +33 -0
  373. package/dist/src/framework/buildContext.js +119 -0
  374. package/dist/src/framework/config/schema.d.ts +447 -0
  375. package/dist/src/framework/config/schema.js +528 -0
  376. package/dist/src/framework/createInfrastructure.d.ts +76 -0
  377. package/dist/src/framework/createInfrastructure.js +221 -0
  378. package/dist/src/framework/lib/auditLog.d.ts +23 -0
  379. package/dist/src/framework/lib/auditLog.js +416 -0
  380. package/dist/src/framework/lib/captcha.d.ts +11 -0
  381. package/dist/src/framework/lib/captcha.js +40 -0
  382. package/dist/{lib → src/framework/lib}/createDtoMapper.js +4 -4
  383. package/dist/src/framework/lib/createRoute.d.ts +1 -0
  384. package/dist/src/framework/lib/createRoute.js +2 -0
  385. package/dist/{lib → src/framework/lib}/idempotency.d.ts +2 -6
  386. package/dist/src/framework/lib/idempotency.js +74 -0
  387. package/dist/src/framework/lib/logger.d.ts +3 -0
  388. package/dist/src/framework/lib/logger.js +14 -0
  389. package/dist/src/framework/lib/metrics.d.ts +34 -0
  390. package/dist/{lib → src/framework/lib}/metrics.js +49 -57
  391. package/dist/src/framework/lib/pagination.d.ts +42 -0
  392. package/dist/src/framework/lib/pagination.js +51 -0
  393. package/dist/src/framework/lib/redisTransport.d.ts +38 -0
  394. package/dist/src/framework/lib/redisTransport.js +107 -0
  395. package/dist/src/framework/lib/resolveUserId.d.ts +2 -0
  396. package/dist/src/framework/lib/resolveUserId.js +5 -0
  397. package/dist/src/framework/lib/sseCollision.d.ts +6 -0
  398. package/dist/src/framework/lib/sseCollision.js +26 -0
  399. package/dist/src/framework/lib/storageAdapter.d.ts +1 -0
  400. package/dist/src/framework/lib/storageAdapter.js +1 -0
  401. package/dist/{lib → src/framework/lib}/stripUnreferencedSchemas.js +4 -4
  402. package/dist/src/framework/lib/tenant.d.ts +21 -0
  403. package/dist/src/framework/lib/tenant.js +70 -0
  404. package/dist/{lib → src/framework/lib}/upload.d.ts +14 -9
  405. package/dist/src/framework/lib/upload.js +132 -0
  406. package/dist/src/framework/lib/uploadRegistry.d.ts +23 -0
  407. package/dist/src/framework/lib/uploadRegistry.js +34 -0
  408. package/dist/{lib → src/framework/lib}/validate.d.ts +1 -1
  409. package/dist/{lib → src/framework/lib}/validate.js +2 -2
  410. package/dist/src/framework/lib/ws.d.ts +19 -0
  411. package/dist/src/framework/lib/ws.js +130 -0
  412. package/dist/src/framework/lib/wsHeartbeat.d.ts +12 -0
  413. package/dist/src/framework/lib/wsHeartbeat.js +53 -0
  414. package/dist/src/framework/lib/wsMessages.d.ts +25 -0
  415. package/dist/src/framework/lib/wsMessages.js +45 -0
  416. package/dist/src/framework/lib/wsNamespace.d.ts +17 -0
  417. package/dist/src/framework/lib/wsNamespace.js +19 -0
  418. package/dist/src/framework/lib/wsPresence.d.ts +17 -0
  419. package/dist/src/framework/lib/wsPresence.js +84 -0
  420. package/dist/src/framework/lib/wsTransport.d.ts +38 -0
  421. package/dist/src/framework/lib/wsTransport.js +9 -0
  422. package/dist/{lib → src/framework/lib}/zodToMongoose.d.ts +1 -1
  423. package/dist/{lib → src/framework/lib}/zodToMongoose.js +11 -11
  424. package/dist/{middleware → src/framework/middleware}/auditLog.d.ts +4 -3
  425. package/dist/src/framework/middleware/auditLog.js +42 -0
  426. package/dist/{middleware → src/framework/middleware}/botProtection.d.ts +2 -2
  427. package/dist/{middleware → src/framework/middleware}/botProtection.js +8 -9
  428. package/dist/src/framework/middleware/cacheResponse.d.ts +35 -0
  429. package/dist/src/framework/middleware/cacheResponse.js +126 -0
  430. package/dist/src/framework/middleware/captcha.d.ts +9 -0
  431. package/dist/src/framework/middleware/captcha.js +37 -0
  432. package/dist/{middleware → src/framework/middleware}/errorHandler.d.ts +1 -1
  433. package/dist/src/framework/middleware/errorHandler.js +16 -0
  434. package/dist/src/framework/middleware/index.js +1 -0
  435. package/dist/{middleware → src/framework/middleware}/logger.d.ts +1 -1
  436. package/dist/src/framework/middleware/metrics.d.ts +12 -0
  437. package/dist/src/framework/middleware/metrics.js +26 -0
  438. package/dist/{middleware → src/framework/middleware}/rateLimit.d.ts +2 -2
  439. package/dist/src/framework/middleware/rateLimit.js +22 -0
  440. package/dist/src/framework/middleware/requestId.d.ts +3 -0
  441. package/dist/{middleware → src/framework/middleware}/requestId.js +2 -2
  442. package/dist/{middleware → src/framework/middleware}/requestLogger.d.ts +3 -3
  443. package/dist/{middleware → src/framework/middleware}/requestLogger.js +17 -12
  444. package/dist/{middleware → src/framework/middleware}/requestSigning.d.ts +2 -2
  445. package/dist/{middleware → src/framework/middleware}/requestSigning.js +18 -19
  446. package/dist/src/framework/middleware/tenant.d.ts +14 -0
  447. package/dist/{middleware → src/framework/middleware}/tenant.js +31 -27
  448. package/dist/src/framework/middleware/upload.d.ts +5 -0
  449. package/dist/{middleware → src/framework/middleware}/upload.js +4 -4
  450. package/dist/{middleware → src/framework/middleware}/webhookAuth.d.ts +3 -3
  451. package/dist/{middleware → src/framework/middleware}/webhookAuth.js +11 -11
  452. package/dist/src/framework/models/AuditLog.d.ts +21 -0
  453. package/dist/src/framework/models/AuditLog.js +31 -0
  454. package/dist/src/framework/mountMiddleware.d.ts +91 -0
  455. package/dist/src/framework/mountMiddleware.js +128 -0
  456. package/dist/src/framework/mountOptionalEndpoints.d.ts +103 -0
  457. package/dist/src/framework/mountOptionalEndpoints.js +47 -0
  458. package/dist/src/framework/mountRoutes.d.ts +21 -0
  459. package/dist/src/framework/mountRoutes.js +144 -0
  460. package/dist/src/framework/persistence/cronRegistry.d.ts +28 -0
  461. package/dist/src/framework/persistence/cronRegistry.js +139 -0
  462. package/dist/src/framework/persistence/idempotency.d.ts +26 -0
  463. package/dist/src/framework/persistence/idempotency.js +178 -0
  464. package/dist/src/framework/persistence/index.d.ts +6 -0
  465. package/dist/src/framework/persistence/index.js +8 -0
  466. package/dist/src/framework/persistence/storeInfra.d.ts +9 -0
  467. package/dist/src/framework/persistence/storeInfra.js +1 -0
  468. package/dist/src/framework/persistence/uploadRegistry.d.ts +35 -0
  469. package/dist/src/framework/persistence/uploadRegistry.js +235 -0
  470. package/dist/src/framework/persistence/wsMessages.d.ts +22 -0
  471. package/dist/src/framework/persistence/wsMessages.js +296 -0
  472. package/dist/src/framework/preloadSchemas.d.ts +24 -0
  473. package/dist/src/framework/preloadSchemas.js +42 -0
  474. package/dist/src/framework/registerBoundaryAdapters.d.ts +23 -0
  475. package/dist/src/framework/registerBoundaryAdapters.js +46 -0
  476. package/dist/src/framework/routes/admin.d.ts +9 -0
  477. package/dist/src/framework/routes/admin.js +361 -0
  478. package/dist/src/framework/routes/health.d.ts +1 -0
  479. package/dist/src/framework/routes/health.js +21 -0
  480. package/dist/src/framework/routes/home.d.ts +1 -0
  481. package/dist/src/framework/routes/home.js +18 -0
  482. package/dist/src/framework/routes/jobs.d.ts +3 -0
  483. package/dist/src/framework/routes/jobs.js +315 -0
  484. package/dist/src/framework/routes/metrics.d.ts +10 -0
  485. package/dist/src/framework/routes/metrics.js +57 -0
  486. package/dist/src/framework/routes/uploads.d.ts +14 -0
  487. package/dist/src/framework/routes/uploads.js +262 -0
  488. package/dist/src/framework/runPluginLifecycle.d.ts +27 -0
  489. package/dist/src/framework/runPluginLifecycle.js +121 -0
  490. package/dist/src/framework/secrets/frameworkSecretSchema.d.ts +58 -0
  491. package/dist/src/framework/secrets/frameworkSecretSchema.js +20 -0
  492. package/dist/src/framework/secrets/index.d.ts +9 -0
  493. package/dist/src/framework/secrets/index.js +7 -0
  494. package/dist/src/framework/secrets/providers/envProvider.d.ts +15 -0
  495. package/dist/src/framework/secrets/providers/envProvider.js +18 -0
  496. package/dist/src/framework/secrets/providers/fileProvider.d.ts +8 -0
  497. package/dist/src/framework/secrets/providers/fileProvider.js +82 -0
  498. package/dist/src/framework/secrets/providers/ssmProvider.d.ts +20 -0
  499. package/dist/src/framework/secrets/providers/ssmProvider.js +127 -0
  500. package/dist/src/framework/secrets/resolveSecretBundle.d.ts +53 -0
  501. package/dist/src/framework/secrets/resolveSecretBundle.js +84 -0
  502. package/dist/src/framework/secrets/resolveSecrets.d.ts +18 -0
  503. package/dist/src/framework/secrets/resolveSecrets.js +34 -0
  504. package/dist/src/framework/sse/index.d.ts +21 -0
  505. package/dist/src/framework/sse/index.js +109 -0
  506. package/dist/src/framework/ws/index.d.ts +11 -0
  507. package/dist/src/framework/ws/index.js +8 -0
  508. package/dist/src/index.d.ts +87 -0
  509. package/dist/src/index.js +58 -0
  510. package/dist/src/lib/appConfig.d.ts +7 -0
  511. package/dist/src/lib/appConfig.js +27 -0
  512. package/dist/src/lib/appMeta.d.ts +7 -0
  513. package/dist/src/lib/appMeta.js +3 -0
  514. package/dist/src/lib/authConfig.d.ts +532 -0
  515. package/dist/src/lib/authConfig.js +179 -0
  516. package/dist/{lib → src/lib}/context.d.ts +6 -7
  517. package/dist/{lib → src/lib}/context.js +5 -5
  518. package/dist/src/lib/logger.d.ts +1 -0
  519. package/dist/src/lib/logger.js +1 -0
  520. package/dist/src/lib/mongo.d.ts +58 -0
  521. package/dist/src/lib/mongo.js +96 -0
  522. package/dist/src/lib/queue.d.ts +72 -0
  523. package/dist/src/lib/queue.js +152 -0
  524. package/dist/src/lib/redis.d.ts +28 -0
  525. package/dist/src/lib/redis.js +72 -0
  526. package/dist/{lib → src/lib}/signing.d.ts +2 -2
  527. package/dist/src/lib/signing.js +210 -0
  528. package/dist/src/lib/signingConfig.d.ts +40 -0
  529. package/dist/src/lib/signingConfig.js +28 -0
  530. package/dist/src/server.d.ts +146 -0
  531. package/dist/src/server.js +469 -0
  532. package/dist/src/shared/lib/HttpError.d.ts +1 -0
  533. package/dist/src/shared/lib/HttpError.js +2 -0
  534. package/dist/src/shared/lib/constants.d.ts +10 -0
  535. package/dist/src/shared/lib/crypto.d.ts +43 -0
  536. package/dist/src/shared/lib/crypto.js +74 -0
  537. package/dist/src/shared/lib/signing.d.ts +52 -0
  538. package/dist/{lib → src/shared/lib}/signing.js +40 -10
  539. package/dist/src/testing.d.ts +34 -0
  540. package/dist/src/testing.js +93 -0
  541. package/package.json +62 -25
  542. package/dist/adapters/memoryAuth.d.ts +0 -46
  543. package/dist/adapters/memoryAuth.js +0 -634
  544. package/dist/adapters/memoryStorage.d.ts +0 -3
  545. package/dist/adapters/memoryStorage.js +0 -44
  546. package/dist/adapters/mongoAuth.d.ts +0 -2
  547. package/dist/adapters/mongoAuth.js +0 -307
  548. package/dist/adapters/sqliteAuth.d.ts +0 -49
  549. package/dist/adapters/sqliteAuth.js +0 -707
  550. package/dist/app.d.ts +0 -456
  551. package/dist/app.js +0 -548
  552. package/dist/entrypoints/mongo.d.ts +0 -5
  553. package/dist/entrypoints/mongo.js +0 -4
  554. package/dist/entrypoints/queue.d.ts +0 -2
  555. package/dist/entrypoints/queue.js +0 -1
  556. package/dist/entrypoints/redis.d.ts +0 -1
  557. package/dist/entrypoints/redis.js +0 -1
  558. package/dist/index.d.ts +0 -98
  559. package/dist/index.js +0 -77
  560. package/dist/lib/HttpError.d.ts +0 -9
  561. package/dist/lib/HttpError.js +0 -14
  562. package/dist/lib/appConfig.d.ts +0 -162
  563. package/dist/lib/appConfig.js +0 -83
  564. package/dist/lib/auditLog.d.ts +0 -52
  565. package/dist/lib/auditLog.js +0 -201
  566. package/dist/lib/authAdapter.d.ts +0 -176
  567. package/dist/lib/authAdapter.js +0 -7
  568. package/dist/lib/authRateLimit.d.ts +0 -13
  569. package/dist/lib/authRateLimit.js +0 -81
  570. package/dist/lib/clientIp.d.ts +0 -14
  571. package/dist/lib/crypto.d.ts +0 -11
  572. package/dist/lib/crypto.js +0 -22
  573. package/dist/lib/deletionCancelToken.d.ts +0 -12
  574. package/dist/lib/deletionCancelToken.js +0 -88
  575. package/dist/lib/emailVerification.d.ts +0 -13
  576. package/dist/lib/emailVerification.js +0 -86
  577. package/dist/lib/fingerprint.js +0 -36
  578. package/dist/lib/idempotency.js +0 -182
  579. package/dist/lib/jwt.d.ts +0 -2
  580. package/dist/lib/jwt.js +0 -24
  581. package/dist/lib/logger.d.ts +0 -1
  582. package/dist/lib/logger.js +0 -7
  583. package/dist/lib/metrics.d.ts +0 -14
  584. package/dist/lib/mfaChallenge.d.ts +0 -42
  585. package/dist/lib/mfaChallenge.js +0 -293
  586. package/dist/lib/mongo.d.ts +0 -39
  587. package/dist/lib/mongo.js +0 -124
  588. package/dist/lib/oauth.d.ts +0 -40
  589. package/dist/lib/oauth.js +0 -101
  590. package/dist/lib/oauthCode.d.ts +0 -15
  591. package/dist/lib/oauthCode.js +0 -90
  592. package/dist/lib/pagination.d.ts +0 -119
  593. package/dist/lib/pagination.js +0 -166
  594. package/dist/lib/queue.d.ts +0 -37
  595. package/dist/lib/queue.js +0 -117
  596. package/dist/lib/redis.d.ts +0 -9
  597. package/dist/lib/redis.js +0 -61
  598. package/dist/lib/resetPassword.d.ts +0 -12
  599. package/dist/lib/resetPassword.js +0 -91
  600. package/dist/lib/roles.d.ts +0 -7
  601. package/dist/lib/roles.js +0 -49
  602. package/dist/lib/session.d.ts +0 -39
  603. package/dist/lib/session.js +0 -535
  604. package/dist/lib/tenant.d.ts +0 -15
  605. package/dist/lib/tenant.js +0 -65
  606. package/dist/lib/upload.js +0 -87
  607. package/dist/lib/ws.d.ts +0 -22
  608. package/dist/lib/ws.js +0 -89
  609. package/dist/lib/wsHeartbeat.d.ts +0 -12
  610. package/dist/lib/wsHeartbeat.js +0 -57
  611. package/dist/lib/wsMessages.d.ts +0 -40
  612. package/dist/lib/wsMessages.js +0 -330
  613. package/dist/lib/wsPresence.d.ts +0 -25
  614. package/dist/lib/wsPresence.js +0 -99
  615. package/dist/middleware/auditLog.js +0 -39
  616. package/dist/middleware/bearerAuth.d.ts +0 -2
  617. package/dist/middleware/bearerAuth.js +0 -11
  618. package/dist/middleware/cacheResponse.d.ts +0 -15
  619. package/dist/middleware/cacheResponse.js +0 -178
  620. package/dist/middleware/csrf.js +0 -125
  621. package/dist/middleware/errorHandler.js +0 -13
  622. package/dist/middleware/identify.d.ts +0 -3
  623. package/dist/middleware/identify.js +0 -95
  624. package/dist/middleware/index.js +0 -1
  625. package/dist/middleware/metrics.d.ts +0 -9
  626. package/dist/middleware/metrics.js +0 -26
  627. package/dist/middleware/rateLimit.js +0 -22
  628. package/dist/middleware/requestId.d.ts +0 -3
  629. package/dist/middleware/tenant.d.ts +0 -5
  630. package/dist/middleware/upload.d.ts +0 -5
  631. package/dist/middleware/userAuth.d.ts +0 -3
  632. package/dist/middleware/userAuth.js +0 -6
  633. package/dist/models/AuditLog.d.ts +0 -30
  634. package/dist/models/AuditLog.js +0 -39
  635. package/dist/models/AuthUser.js +0 -48
  636. package/dist/models/Group.d.ts +0 -21
  637. package/dist/models/Group.js +0 -28
  638. package/dist/models/GroupMembership.js +0 -25
  639. package/dist/models/TenantRole.d.ts +0 -15
  640. package/dist/models/TenantRole.js +0 -23
  641. package/dist/routes/auth.d.ts +0 -11
  642. package/dist/routes/auth.js +0 -605
  643. package/dist/routes/groups.js +0 -346
  644. package/dist/routes/health.d.ts +0 -1
  645. package/dist/routes/health.js +0 -22
  646. package/dist/routes/home.d.ts +0 -1
  647. package/dist/routes/home.js +0 -16
  648. package/dist/routes/jobs.d.ts +0 -2
  649. package/dist/routes/jobs.js +0 -272
  650. package/dist/routes/metrics.d.ts +0 -7
  651. package/dist/routes/metrics.js +0 -52
  652. package/dist/routes/mfa.d.ts +0 -5
  653. package/dist/routes/mfa.js +0 -620
  654. package/dist/routes/oauth.d.ts +0 -2
  655. package/dist/routes/oauth.js +0 -514
  656. package/dist/routes/uploads.d.ts +0 -2
  657. package/dist/routes/uploads.js +0 -135
  658. package/dist/schemas/auth.js +0 -30
  659. package/dist/server.d.ts +0 -57
  660. package/dist/server.js +0 -112
  661. package/dist/services/auth.d.ts +0 -27
  662. package/dist/services/auth.js +0 -159
  663. package/dist/ws/index.d.ts +0 -10
  664. package/dist/ws/index.js +0 -38
  665. package/docs/sections/adding-middleware/full.md +0 -35
  666. package/docs/sections/adding-models/full.md +0 -125
  667. package/docs/sections/adding-models/overview.md +0 -13
  668. package/docs/sections/adding-routes/full.md +0 -182
  669. package/docs/sections/adding-routes/overview.md +0 -23
  670. package/docs/sections/auth-flow/full.md +0 -779
  671. package/docs/sections/auth-flow/overview.md +0 -10
  672. package/docs/sections/auth-security-examples/full.md +0 -365
  673. package/docs/sections/authentication/full.md +0 -130
  674. package/docs/sections/authentication/overview.md +0 -5
  675. package/docs/sections/cli/full.md +0 -42
  676. package/docs/sections/configuration/full.md +0 -172
  677. package/docs/sections/configuration/overview.md +0 -18
  678. package/docs/sections/configuration-example/full.md +0 -117
  679. package/docs/sections/configuration-example/overview.md +0 -30
  680. package/docs/sections/documentation/full.md +0 -171
  681. package/docs/sections/environment-variables/full.md +0 -55
  682. package/docs/sections/exports/full.md +0 -123
  683. package/docs/sections/extending-context/full.md +0 -59
  684. package/docs/sections/header.md +0 -3
  685. package/docs/sections/installation/full.md +0 -6
  686. package/docs/sections/jobs/full.md +0 -140
  687. package/docs/sections/jobs/overview.md +0 -15
  688. package/docs/sections/logging/full.md +0 -83
  689. package/docs/sections/metrics/full.md +0 -127
  690. package/docs/sections/mongodb-connections/full.md +0 -45
  691. package/docs/sections/mongodb-connections/overview.md +0 -7
  692. package/docs/sections/multi-tenancy/full.md +0 -66
  693. package/docs/sections/multi-tenancy/overview.md +0 -15
  694. package/docs/sections/oauth/full.md +0 -189
  695. package/docs/sections/oauth/overview.md +0 -16
  696. package/docs/sections/package-development/full.md +0 -7
  697. package/docs/sections/pagination/full.md +0 -93
  698. package/docs/sections/peer-dependencies/full.md +0 -47
  699. package/docs/sections/quick-start/full.md +0 -43
  700. package/docs/sections/response-caching/full.md +0 -117
  701. package/docs/sections/response-caching/overview.md +0 -13
  702. package/docs/sections/roles/full.md +0 -225
  703. package/docs/sections/roles/overview.md +0 -14
  704. package/docs/sections/running-without-redis/full.md +0 -16
  705. package/docs/sections/running-without-redis-or-mongodb/full.md +0 -60
  706. package/docs/sections/signing/full.md +0 -203
  707. package/docs/sections/stack/full.md +0 -10
  708. package/docs/sections/uploads/full.md +0 -199
  709. package/docs/sections/versioning/full.md +0 -85
  710. package/docs/sections/webhook-auth/full.md +0 -100
  711. package/docs/sections/websocket/full.md +0 -184
  712. package/docs/sections/websocket/overview.md +0 -5
  713. package/docs/sections/websocket-rooms/full.md +0 -102
  714. package/docs/sections/websocket-rooms/overview.md +0 -5
  715. /package/dist/{lib/storageAdapter.js → packages/bunshot-admin/src/types/env.js} +0 -0
  716. /package/dist/{lib → packages/bunshot-auth/src/lib}/fingerprint.d.ts +0 -0
  717. /package/dist/{lib → packages/bunshot-core/src}/constants.d.ts +0 -0
  718. /package/dist/{lib → packages/bunshot-core/src}/storageAdapter.d.ts +0 -0
  719. /package/dist/{lib → src/framework/lib}/createDtoMapper.d.ts +0 -0
  720. /package/dist/{lib → src/framework/lib}/stripUnreferencedSchemas.d.ts +0 -0
  721. /package/dist/{middleware → src/framework/middleware}/cors.d.ts +0 -0
  722. /package/dist/{middleware → src/framework/middleware}/cors.js +0 -0
  723. /package/dist/{middleware → src/framework/middleware}/index.d.ts +0 -0
  724. /package/dist/{middleware → src/framework/middleware}/logger.js +0 -0
  725. /package/dist/{lib → src/shared/lib}/constants.js +0 -0
@@ -1,346 +0,0 @@
1
- import { z } from "zod";
2
- import { createRoute, withSecurity } from "../lib/createRoute";
3
- import { createRouter } from "../lib/context";
4
- import { userAuth } from "../middleware/userAuth";
5
- import { requireRole } from "../middleware/requireRole";
6
- import { createGroup, deleteGroup, getGroup, listGroups, updateGroup, addGroupMember, updateGroupMembership, removeGroupMember, getGroupMembers, getUserGroups, } from "../lib/groups";
7
- import { HttpError } from "../lib/HttpError";
8
- // ---------------------------------------------------------------------------
9
- // Zod schemas
10
- // ---------------------------------------------------------------------------
11
- const SLUG_REGEX = /^[a-z0-9_-]+$/;
12
- const GroupBody = z.object({
13
- name: z.string().min(1).max(100).regex(SLUG_REGEX, "name must be a slug: lowercase letters, digits, underscores, or hyphens"),
14
- displayName: z.string().max(200).optional(),
15
- description: z.string().max(1000).optional(),
16
- roles: z.array(z.string()).default([]),
17
- tenantId: z.string().nullable().optional().default(null),
18
- });
19
- const GroupUpdateBody = z.object({
20
- name: z.string().min(1).max(100).regex(SLUG_REGEX, "name must be a slug").optional(),
21
- displayName: z.string().max(200).nullable().optional(),
22
- description: z.string().max(1000).nullable().optional(),
23
- roles: z.array(z.string()).optional(),
24
- });
25
- const MemberBody = z.object({
26
- userId: z.string().min(1),
27
- roles: z.array(z.string()).default([]),
28
- });
29
- const MemberRolesBody = z.object({
30
- roles: z.array(z.string()),
31
- });
32
- const GroupResponse = z.object({
33
- id: z.string(),
34
- name: z.string(),
35
- displayName: z.string().optional(),
36
- description: z.string().optional(),
37
- roles: z.array(z.string()),
38
- tenantId: z.string().nullable(),
39
- createdAt: z.number(),
40
- updatedAt: z.number(),
41
- }).openapi("Group");
42
- const MemberResponse = z.object({
43
- userId: z.string(),
44
- roles: z.array(z.string()),
45
- }).openapi("GroupMember");
46
- const PaginatedGroupsResponse = z.object({
47
- items: z.array(GroupResponse),
48
- total: z.number(),
49
- limit: z.number(),
50
- offset: z.number(),
51
- }).openapi("PaginatedGroups");
52
- const PaginatedMembersResponse = z.object({
53
- items: z.array(MemberResponse),
54
- total: z.number(),
55
- limit: z.number(),
56
- offset: z.number(),
57
- }).openapi("PaginatedGroupMembers");
58
- const UserGroupEntry = z.object({
59
- group: GroupResponse,
60
- membershipRoles: z.array(z.string()),
61
- }).openapi("UserGroupEntry");
62
- const ErrorResponse = z.object({ error: z.string() });
63
- const PaginationParams = {
64
- limit: z.string().optional().openapi({ description: "Max results (default 50, max 200)" }),
65
- offset: z.string().optional().openapi({ description: "Skip this many results (default 0)" }),
66
- };
67
- const tags = ["Groups"];
68
- // ---------------------------------------------------------------------------
69
- // Router factory
70
- // ---------------------------------------------------------------------------
71
- export const createGroupsRouter = (config) => {
72
- const router = createRouter();
73
- // Normalize: managementRoutes: true is equivalent to managementRoutes: {}
74
- const mgmt = config.managementRoutes === true ? {} : (config.managementRoutes ?? {});
75
- const guard = mgmt.middleware ?? [userAuth, requireRole.global(mgmt.adminRole ?? "admin")];
76
- // Defensive guard warning
77
- if (guard.length === 0 && process.env.NODE_ENV !== "production") {
78
- console.warn("[bunshot] groups.managementRoutes: resolved auth middleware is empty — management routes are unprotected");
79
- }
80
- // Apply auth guard to all group management routes
81
- router.use("/groups/*", ...guard);
82
- router.use("/users/:userId/groups", ...guard);
83
- // ---------------------------------------------------------------------------
84
- // GET /groups — list groups
85
- // ---------------------------------------------------------------------------
86
- router.openapi(withSecurity(createRoute({
87
- method: "get",
88
- path: "/groups",
89
- tags,
90
- summary: "List groups",
91
- description: "List groups. Returns tenant-scoped groups when tenantId is in context, app-wide groups otherwise.",
92
- request: { query: z.object(PaginationParams) },
93
- responses: {
94
- 200: { content: { "application/json": { schema: PaginatedGroupsResponse } }, description: "Groups list" },
95
- 401: { content: { "application/json": { schema: ErrorResponse } }, description: "Unauthorized" },
96
- 403: { content: { "application/json": { schema: ErrorResponse } }, description: "Forbidden" },
97
- },
98
- }), { cookieAuth: [] }, { userToken: [] }), async (c) => {
99
- const tenantId = c.get("tenantId") ?? null;
100
- const { limit, offset } = c.req.valid("query");
101
- const result = await listGroups(tenantId, {
102
- limit: limit ? Math.min(parseInt(limit, 10), 200) : 50,
103
- offset: offset ? parseInt(offset, 10) : 0,
104
- });
105
- return c.json(result, 200);
106
- });
107
- // ---------------------------------------------------------------------------
108
- // POST /groups — create group
109
- // ---------------------------------------------------------------------------
110
- router.openapi(withSecurity(createRoute({
111
- method: "post",
112
- path: "/groups",
113
- tags,
114
- summary: "Create group",
115
- request: { body: { content: { "application/json": { schema: GroupBody } }, required: true } },
116
- responses: {
117
- 201: { content: { "application/json": { schema: z.object({ id: z.string() }) } }, description: "Group created" },
118
- 401: { content: { "application/json": { schema: ErrorResponse } }, description: "Unauthorized" },
119
- 403: { content: { "application/json": { schema: ErrorResponse } }, description: "Forbidden" },
120
- 409: { content: { "application/json": { schema: ErrorResponse } }, description: "Name already exists in scope" },
121
- 422: { content: { "application/json": { schema: ErrorResponse } }, description: "Validation error" },
122
- },
123
- }), { cookieAuth: [] }, { userToken: [] }), async (c) => {
124
- const body = c.req.valid("json");
125
- const result = await createGroup({
126
- name: body.name,
127
- displayName: body.displayName,
128
- description: body.description,
129
- roles: body.roles,
130
- tenantId: body.tenantId ?? null,
131
- });
132
- return c.json(result, 201);
133
- });
134
- // ---------------------------------------------------------------------------
135
- // GET /groups/:groupId — get group
136
- // ---------------------------------------------------------------------------
137
- router.openapi(withSecurity(createRoute({
138
- method: "get",
139
- path: "/groups/:groupId",
140
- tags,
141
- summary: "Get group",
142
- request: { params: z.object({ groupId: z.string() }) },
143
- responses: {
144
- 200: { content: { "application/json": { schema: GroupResponse } }, description: "Group" },
145
- 401: { content: { "application/json": { schema: ErrorResponse } }, description: "Unauthorized" },
146
- 403: { content: { "application/json": { schema: ErrorResponse } }, description: "Forbidden" },
147
- 404: { content: { "application/json": { schema: ErrorResponse } }, description: "Not found" },
148
- },
149
- }), { cookieAuth: [] }, { userToken: [] }), async (c) => {
150
- const { groupId } = c.req.valid("param");
151
- const group = await getGroup(groupId);
152
- if (!group)
153
- return c.json({ error: "Group not found" }, 404);
154
- return c.json(group, 200);
155
- });
156
- // ---------------------------------------------------------------------------
157
- // PATCH /groups/:groupId — update group
158
- // ---------------------------------------------------------------------------
159
- router.openapi(withSecurity(createRoute({
160
- method: "patch",
161
- path: "/groups/:groupId",
162
- tags,
163
- summary: "Update group",
164
- request: {
165
- params: z.object({ groupId: z.string() }),
166
- body: { content: { "application/json": { schema: GroupUpdateBody } }, required: true },
167
- },
168
- responses: {
169
- 204: { description: "Updated" },
170
- 401: { content: { "application/json": { schema: ErrorResponse } }, description: "Unauthorized" },
171
- 403: { content: { "application/json": { schema: ErrorResponse } }, description: "Forbidden" },
172
- 404: { content: { "application/json": { schema: ErrorResponse } }, description: "Not found" },
173
- 409: { content: { "application/json": { schema: ErrorResponse } }, description: "Name conflict" },
174
- 422: { content: { "application/json": { schema: ErrorResponse } }, description: "Validation error" },
175
- },
176
- }), { cookieAuth: [] }, { userToken: [] }), async (c) => {
177
- const { groupId } = c.req.valid("param");
178
- const body = c.req.valid("json");
179
- const group = await getGroup(groupId);
180
- if (!group)
181
- return c.json({ error: "Group not found" }, 404);
182
- const updates = {};
183
- if (body.name !== undefined)
184
- updates.name = body.name;
185
- if ("displayName" in body)
186
- updates.displayName = body.displayName ?? undefined;
187
- if ("description" in body)
188
- updates.description = body.description ?? undefined;
189
- if (body.roles !== undefined)
190
- updates.roles = body.roles;
191
- await updateGroup(groupId, updates);
192
- return c.body(null, 204);
193
- });
194
- // ---------------------------------------------------------------------------
195
- // DELETE /groups/:groupId — delete group
196
- // ---------------------------------------------------------------------------
197
- router.openapi(withSecurity(createRoute({
198
- method: "delete",
199
- path: "/groups/:groupId",
200
- tags,
201
- summary: "Delete group",
202
- description: "Delete a group. All memberships are cascade-deleted.",
203
- request: { params: z.object({ groupId: z.string() }) },
204
- responses: {
205
- 204: { description: "Deleted" },
206
- 401: { content: { "application/json": { schema: ErrorResponse } }, description: "Unauthorized" },
207
- 403: { content: { "application/json": { schema: ErrorResponse } }, description: "Forbidden" },
208
- 404: { content: { "application/json": { schema: ErrorResponse } }, description: "Not found" },
209
- },
210
- }), { cookieAuth: [] }, { userToken: [] }), async (c) => {
211
- const { groupId } = c.req.valid("param");
212
- const group = await getGroup(groupId);
213
- if (!group)
214
- return c.json({ error: "Group not found" }, 404);
215
- await deleteGroup(groupId);
216
- return c.body(null, 204);
217
- });
218
- // ---------------------------------------------------------------------------
219
- // GET /groups/:groupId/members — list members
220
- // ---------------------------------------------------------------------------
221
- router.openapi(withSecurity(createRoute({
222
- method: "get",
223
- path: "/groups/:groupId/members",
224
- tags,
225
- summary: "List group members",
226
- request: {
227
- params: z.object({ groupId: z.string() }),
228
- query: z.object(PaginationParams),
229
- },
230
- responses: {
231
- 200: { content: { "application/json": { schema: PaginatedMembersResponse } }, description: "Members list" },
232
- 401: { content: { "application/json": { schema: ErrorResponse } }, description: "Unauthorized" },
233
- 403: { content: { "application/json": { schema: ErrorResponse } }, description: "Forbidden" },
234
- 404: { content: { "application/json": { schema: ErrorResponse } }, description: "Group not found" },
235
- },
236
- }), { cookieAuth: [] }, { userToken: [] }), async (c) => {
237
- const { groupId } = c.req.valid("param");
238
- const { limit, offset } = c.req.valid("query");
239
- const group = await getGroup(groupId);
240
- if (!group)
241
- return c.json({ error: "Group not found" }, 404);
242
- const result = await getGroupMembers(groupId, {
243
- limit: limit ? Math.min(parseInt(limit, 10), 200) : 50,
244
- offset: offset ? parseInt(offset, 10) : 0,
245
- });
246
- return c.json(result, 200);
247
- });
248
- // ---------------------------------------------------------------------------
249
- // POST /groups/:groupId/members — add member
250
- // ---------------------------------------------------------------------------
251
- router.openapi(withSecurity(createRoute({
252
- method: "post",
253
- path: "/groups/:groupId/members",
254
- tags,
255
- summary: "Add group member",
256
- request: {
257
- params: z.object({ groupId: z.string() }),
258
- body: { content: { "application/json": { schema: MemberBody } }, required: true },
259
- },
260
- responses: {
261
- 201: { description: "Member added" },
262
- 401: { content: { "application/json": { schema: ErrorResponse } }, description: "Unauthorized" },
263
- 403: { content: { "application/json": { schema: ErrorResponse } }, description: "Forbidden" },
264
- 404: { content: { "application/json": { schema: ErrorResponse } }, description: "Group not found" },
265
- 409: { content: { "application/json": { schema: ErrorResponse } }, description: "User already a member" },
266
- },
267
- }), { cookieAuth: [] }, { userToken: [] }), async (c) => {
268
- const { groupId } = c.req.valid("param");
269
- const body = c.req.valid("json");
270
- try {
271
- await addGroupMember(groupId, body.userId, body.roles);
272
- }
273
- catch (err) {
274
- if (err instanceof HttpError) {
275
- return c.json({ error: err.message }, err.status);
276
- }
277
- throw err;
278
- }
279
- return c.body(null, 201);
280
- });
281
- // ---------------------------------------------------------------------------
282
- // PATCH /groups/:groupId/members/:userId — update member roles
283
- // ---------------------------------------------------------------------------
284
- router.openapi(withSecurity(createRoute({
285
- method: "patch",
286
- path: "/groups/:groupId/members/:userId",
287
- tags,
288
- summary: "Update member roles",
289
- description: "Update the per-membership roles for an existing group member.",
290
- request: {
291
- params: z.object({ groupId: z.string(), userId: z.string() }),
292
- body: { content: { "application/json": { schema: MemberRolesBody } }, required: true },
293
- },
294
- responses: {
295
- 204: { description: "Updated" },
296
- 401: { content: { "application/json": { schema: ErrorResponse } }, description: "Unauthorized" },
297
- 403: { content: { "application/json": { schema: ErrorResponse } }, description: "Forbidden" },
298
- },
299
- }), { cookieAuth: [] }, { userToken: [] }), async (c) => {
300
- const { groupId, userId } = c.req.valid("param");
301
- const { roles } = c.req.valid("json");
302
- await updateGroupMembership(groupId, userId, roles);
303
- return c.body(null, 204);
304
- });
305
- // ---------------------------------------------------------------------------
306
- // DELETE /groups/:groupId/members/:userId — remove member
307
- // ---------------------------------------------------------------------------
308
- router.openapi(withSecurity(createRoute({
309
- method: "delete",
310
- path: "/groups/:groupId/members/:userId",
311
- tags,
312
- summary: "Remove group member",
313
- request: { params: z.object({ groupId: z.string(), userId: z.string() }) },
314
- responses: {
315
- 204: { description: "Removed" },
316
- 401: { content: { "application/json": { schema: ErrorResponse } }, description: "Unauthorized" },
317
- 403: { content: { "application/json": { schema: ErrorResponse } }, description: "Forbidden" },
318
- },
319
- }), { cookieAuth: [] }, { userToken: [] }), async (c) => {
320
- const { groupId, userId } = c.req.valid("param");
321
- await removeGroupMember(groupId, userId);
322
- return c.body(null, 204);
323
- });
324
- // ---------------------------------------------------------------------------
325
- // GET /users/:userId/groups — list user's groups
326
- // ---------------------------------------------------------------------------
327
- router.openapi(withSecurity(createRoute({
328
- method: "get",
329
- path: "/users/:userId/groups",
330
- tags,
331
- summary: "List user's groups",
332
- description: "List groups a user belongs to. Scoped to tenant context when present, app-wide otherwise.",
333
- request: { params: z.object({ userId: z.string() }) },
334
- responses: {
335
- 200: { content: { "application/json": { schema: z.array(UserGroupEntry) } }, description: "User's groups" },
336
- 401: { content: { "application/json": { schema: ErrorResponse } }, description: "Unauthorized" },
337
- 403: { content: { "application/json": { schema: ErrorResponse } }, description: "Forbidden" },
338
- },
339
- }), { cookieAuth: [] }, { userToken: [] }), async (c) => {
340
- const { userId } = c.req.valid("param");
341
- const tenantId = c.get("tenantId") ?? null;
342
- const groups = await getUserGroups(userId, tenantId);
343
- return c.json(groups, 200);
344
- });
345
- return router;
346
- };
@@ -1 +0,0 @@
1
- export declare const router: import("@hono/zod-openapi").OpenAPIHono<import("../lib/context").AppEnv, {}, "/">;
@@ -1,22 +0,0 @@
1
- import { createRoute } from "@hono/zod-openapi";
2
- import { z } from "zod";
3
- import { createRouter } from "../lib/context";
4
- export const router = createRouter();
5
- router.openapi(createRoute({
6
- method: "get",
7
- path: "/health",
8
- tags: ["Core"],
9
- responses: {
10
- 200: {
11
- content: {
12
- "application/json": {
13
- schema: z.object({
14
- status: z.enum(["ok"]),
15
- timestamp: z.string(),
16
- }),
17
- },
18
- },
19
- description: "Service health check",
20
- },
21
- },
22
- }), (c) => c.json({ status: "ok", timestamp: new Date().toISOString() }));
@@ -1 +0,0 @@
1
- export declare const router: import("@hono/zod-openapi").OpenAPIHono<import("../lib/context").AppEnv, {}, "/">;
@@ -1,16 +0,0 @@
1
- import { createRoute } from "@hono/zod-openapi";
2
- import { z } from "zod";
3
- import { getAppName } from "../lib/appConfig";
4
- import { createRouter } from "../lib/context";
5
- export const router = createRouter();
6
- router.openapi(createRoute({
7
- method: "get",
8
- path: "/",
9
- tags: ["Core"],
10
- responses: {
11
- 200: {
12
- content: { "application/json": { schema: z.object({ message: z.string() }) } },
13
- description: "API is running",
14
- },
15
- },
16
- }), (c) => c.json({ message: `${getAppName()} is running` }));
@@ -1,2 +0,0 @@
1
- import type { JobsConfig } from "../app";
2
- export declare const createJobsRouter: (config: JobsConfig) => import("@hono/zod-openapi").OpenAPIHono<import("../lib/context").AppEnv, {}, "/">;
@@ -1,272 +0,0 @@
1
- import { createRoute, withSecurity } from "../lib/createRoute";
2
- import { z } from "zod";
3
- import { createRouter } from "../lib/context";
4
- import { userAuth } from "../middleware/userAuth";
5
- import { requireRole } from "../middleware/requireRole";
6
- import { createQueue } from "../lib/queue";
7
- const tags = ["Jobs"];
8
- const ErrorResponse = z.object({ error: z.string() });
9
- const JobStatusResponse = z.object({
10
- id: z.string().describe("Job ID."),
11
- state: z.string().describe("Job state: waiting, active, completed, failed, delayed, paused."),
12
- progress: z.union([z.number(), z.record(z.string(), z.unknown())]).describe("Job progress."),
13
- result: z.unknown().optional().describe("Job result (when completed)."),
14
- failedReason: z.string().optional().describe("Failure reason (when failed)."),
15
- attemptsMade: z.number().describe("Number of attempts made."),
16
- timestamp: z.number().describe("Unix timestamp (ms) when the job was created."),
17
- finishedOn: z.number().optional().describe("Unix timestamp (ms) when the job finished."),
18
- }).openapi("JobStatus");
19
- export const createJobsRouter = (config) => {
20
- const router = createRouter();
21
- const allowedQueues = new Set(config.allowedQueues ?? []);
22
- const authConfig = config.auth ?? "none";
23
- const scopeToUser = config.scopeToUser ?? false;
24
- // Determine if userAuth is involved (for scopeToUser and OpenAPI security schemes)
25
- const hasUserAuth = authConfig === "userAuth" || Array.isArray(authConfig);
26
- // Apply middleware based on config
27
- if (authConfig === "userAuth") {
28
- router.use("/jobs/*", userAuth);
29
- if (config.roles?.length) {
30
- router.use("/jobs/*", requireRole(...config.roles));
31
- }
32
- }
33
- else if (Array.isArray(authConfig)) {
34
- for (const mw of authConfig) {
35
- router.use("/jobs/*", mw);
36
- }
37
- }
38
- // "none" requires no middleware
39
- function isQueueAllowed(queueName) {
40
- return allowedQueues.has(queueName);
41
- }
42
- /** Determine OpenAPI security for a route */
43
- function applyRouteSecurity(route) {
44
- if (authConfig === "userAuth") {
45
- return withSecurity(route, { cookieAuth: [] }, { userToken: [] });
46
- }
47
- if (Array.isArray(authConfig)) {
48
- // Custom middleware — mark as cookieAuth/userToken if it likely includes userAuth
49
- return withSecurity(route, { cookieAuth: [] }, { userToken: [] });
50
- }
51
- return route;
52
- }
53
- /** Map a BullMQ job to the response shape */
54
- async function jobToResponse(job) {
55
- const state = await job.getState();
56
- return {
57
- id: job.id,
58
- state,
59
- progress: job.progress,
60
- result: job.returnvalue,
61
- failedReason: job.failedReason ?? undefined,
62
- attemptsMade: job.attemptsMade,
63
- timestamp: job.timestamp,
64
- finishedOn: job.finishedOn ?? undefined,
65
- };
66
- }
67
- // ─── List available queues ──────────────────────────────────────────────
68
- const listQueuesRoute = createRoute({
69
- method: "get",
70
- path: "/jobs",
71
- summary: "List available queues",
72
- description: "Returns the list of queue names exposed via the API.",
73
- tags,
74
- responses: {
75
- 200: {
76
- content: {
77
- "application/json": {
78
- schema: z.object({
79
- queues: z.array(z.string()).describe("Available queue names."),
80
- }),
81
- },
82
- },
83
- description: "Available queues.",
84
- },
85
- },
86
- });
87
- router.openapi(applyRouteSecurity(listQueuesRoute), async (c) => {
88
- return c.json({ queues: [...allowedQueues] }, 200);
89
- });
90
- // ─── List jobs in a queue ─────────────────────────────────────────────
91
- const listJobsRoute = createRoute({
92
- method: "get",
93
- path: "/jobs/{queue}",
94
- summary: "List jobs in a queue",
95
- description: "Returns a paginated list of jobs in a queue, optionally filtered by state.",
96
- tags,
97
- request: {
98
- params: z.object({
99
- queue: z.string().describe("Queue name."),
100
- }),
101
- query: z.object({
102
- state: z.enum(["waiting", "active", "completed", "failed", "delayed", "paused"]).optional().describe("Filter by job state."),
103
- start: z.string().optional().describe("Start index. Default: 0."),
104
- end: z.string().optional().describe("End index. Default: 19."),
105
- }),
106
- },
107
- responses: {
108
- 200: {
109
- content: {
110
- "application/json": {
111
- schema: z.object({
112
- jobs: z.array(JobStatusResponse),
113
- total: z.number().describe("Total jobs matching the filter."),
114
- }),
115
- },
116
- },
117
- description: "Jobs list.",
118
- },
119
- 403: { content: { "application/json": { schema: ErrorResponse } }, description: "Queue not allowed." },
120
- },
121
- });
122
- router.openapi(applyRouteSecurity(listJobsRoute), async (c) => {
123
- const { queue: queueName } = c.req.valid("param");
124
- if (!isQueueAllowed(queueName)) {
125
- return c.json({ error: "Queue not allowed" }, 403);
126
- }
127
- const { state, start: startStr, end: endStr } = c.req.valid("query");
128
- const start = startStr ? parseInt(startStr) : 0;
129
- const end = endStr ? parseInt(endStr) : 19;
130
- const queue = createQueue(queueName);
131
- // Get jobs by state or all jobs
132
- const stateFilter = state ?? "waiting";
133
- const jobs = await queue.getJobs([stateFilter], start, end);
134
- // Get total count for the filtered state
135
- const counts = await queue.getJobCounts(stateFilter);
136
- const total = counts[stateFilter] ?? 0;
137
- // Optionally filter by userId
138
- let filteredJobs = jobs;
139
- if (scopeToUser && hasUserAuth) {
140
- const userId = c.get("authUserId");
141
- filteredJobs = jobs.filter((job) => job.data?.userId === userId);
142
- }
143
- const result = await Promise.all(filteredJobs.map(jobToResponse));
144
- return c.json({ jobs: result, total }, 200);
145
- });
146
- // ─── Dead letter queue ────────────────────────────────────────────────
147
- // Must be registered BEFORE getJobRoute so that the literal path segment
148
- // "dead-letters" is matched before the parameterised {id} segment.
149
- const getDlqRoute = createRoute({
150
- method: "get",
151
- path: "/jobs/{queue}/dead-letters",
152
- summary: "List dead letter queue jobs",
153
- description: "Returns paginated list of jobs in the dead letter queue for a given source queue.",
154
- tags,
155
- request: {
156
- params: z.object({ queue: z.string().describe("Source queue name (DLQ name is {queue}-dlq).") }),
157
- query: z.object({
158
- start: z.string().optional().describe("Start index. Default: 0."),
159
- end: z.string().optional().describe("End index. Default: 19."),
160
- }),
161
- },
162
- responses: {
163
- 200: {
164
- content: {
165
- "application/json": {
166
- schema: z.object({
167
- jobs: z.array(JobStatusResponse),
168
- total: z.number().describe("Total jobs in DLQ."),
169
- }),
170
- },
171
- },
172
- description: "DLQ jobs.",
173
- },
174
- 403: { content: { "application/json": { schema: ErrorResponse } }, description: "Queue not allowed." },
175
- },
176
- });
177
- router.openapi(applyRouteSecurity(getDlqRoute), async (c) => {
178
- const { queue: queueName } = c.req.valid("param");
179
- if (!isQueueAllowed(queueName)) {
180
- return c.json({ error: "Queue not allowed" }, 403);
181
- }
182
- const { start: startStr, end: endStr } = c.req.valid("query");
183
- const start = startStr ? parseInt(startStr) : 0;
184
- const end = endStr ? parseInt(endStr) : 19;
185
- const dlqQueue = createQueue(`${queueName}-dlq`);
186
- const [jobs, total] = await Promise.all([
187
- dlqQueue.getWaiting(start, end),
188
- dlqQueue.getWaitingCount(),
189
- ]);
190
- const result = await Promise.all(jobs.map(jobToResponse));
191
- return c.json({ jobs: result, total }, 200);
192
- });
193
- // ─── Get job status ─────────────────────────────────────────────────────
194
- const getJobRoute = createRoute({
195
- method: "get",
196
- path: "/jobs/{queue}/{id}",
197
- summary: "Get job status",
198
- description: "Returns the current state, progress, result, or failure reason for a job.",
199
- tags,
200
- request: {
201
- params: z.object({
202
- queue: z.string().describe("Queue name."),
203
- id: z.string().describe("Job ID."),
204
- }),
205
- },
206
- responses: {
207
- 200: { content: { "application/json": { schema: JobStatusResponse } }, description: "Job status." },
208
- 403: { content: { "application/json": { schema: ErrorResponse } }, description: "Queue not in allowedQueues." },
209
- 404: { content: { "application/json": { schema: ErrorResponse } }, description: "Job not found." },
210
- },
211
- });
212
- router.openapi(applyRouteSecurity(getJobRoute), async (c) => {
213
- const { queue: queueName, id } = c.req.valid("param");
214
- if (!isQueueAllowed(queueName)) {
215
- return c.json({ error: "Queue not allowed" }, 403);
216
- }
217
- const queue = createQueue(queueName);
218
- const job = await queue.getJob(id);
219
- if (!job)
220
- return c.json({ error: "Job not found" }, 404);
221
- // Scope to user if configured
222
- if (scopeToUser && hasUserAuth) {
223
- const userId = c.get("authUserId");
224
- if (job.data?.userId !== userId) {
225
- return c.json({ error: "Job not found" }, 404);
226
- }
227
- }
228
- return c.json(await jobToResponse(job), 200);
229
- });
230
- // ─── Get job logs ───────────────────────────────────────────────────────
231
- const getJobLogsRoute = createRoute({
232
- method: "get",
233
- path: "/jobs/{queue}/{id}/logs",
234
- summary: "Get job logs",
235
- description: "Returns logs for a specific job.",
236
- tags,
237
- request: {
238
- params: z.object({
239
- queue: z.string().describe("Queue name."),
240
- id: z.string().describe("Job ID."),
241
- }),
242
- },
243
- responses: {
244
- 200: {
245
- content: {
246
- "application/json": {
247
- schema: z.object({
248
- logs: z.array(z.string()).describe("Log entries."),
249
- count: z.number().describe("Total log count."),
250
- }),
251
- },
252
- },
253
- description: "Job logs.",
254
- },
255
- 403: { content: { "application/json": { schema: ErrorResponse } }, description: "Queue not allowed." },
256
- 404: { content: { "application/json": { schema: ErrorResponse } }, description: "Job not found." },
257
- },
258
- });
259
- router.openapi(applyRouteSecurity(getJobLogsRoute), async (c) => {
260
- const { queue: queueName, id } = c.req.valid("param");
261
- if (!isQueueAllowed(queueName)) {
262
- return c.json({ error: "Queue not allowed" }, 403);
263
- }
264
- const queue = createQueue(queueName);
265
- const job = await queue.getJob(id);
266
- if (!job)
267
- return c.json({ error: "Job not found" }, 404);
268
- const { logs, count } = await queue.getJobLogs(id);
269
- return c.json({ logs, count }, 200);
270
- });
271
- return router;
272
- };