@terreno/api 57.1.0 → 57.3.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 (283) hide show
  1. package/README.md +17 -7
  2. package/dist/actions.js +19 -7
  3. package/dist/adminTypes.d.ts +26 -0
  4. package/dist/api.d.ts +4 -0
  5. package/dist/api.js +12 -24
  6. package/dist/auth.d.ts +23 -10
  7. package/dist/auth.js +97 -32
  8. package/dist/authRecovery.d.ts +5 -0
  9. package/dist/authRecovery.js +350 -0
  10. package/dist/authTokens.d.ts +8 -0
  11. package/dist/authTokens.js +162 -0
  12. package/dist/betterAuth.d.ts +33 -0
  13. package/dist/betterAuthApp.d.ts +4 -0
  14. package/dist/betterAuthApp.js +26 -8
  15. package/dist/betterAuthSetup.d.ts +44 -2
  16. package/dist/betterAuthSetup.js +288 -18
  17. package/dist/collectionRegistry.d.ts +38 -0
  18. package/dist/collectionRegistry.js +72 -0
  19. package/dist/configurationApp.d.ts +11 -2
  20. package/dist/configurationApp.js +2 -4
  21. package/dist/docLoader.js +35 -6
  22. package/dist/expressServer.d.ts +26 -3
  23. package/dist/expressServer.js +79 -11
  24. package/dist/index.d.ts +16 -0
  25. package/dist/index.js +38 -2
  26. package/dist/mcp/auth.d.ts +1 -0
  27. package/dist/mcp/auth.js +47 -25
  28. package/dist/mcp/handlers.d.ts +1 -1
  29. package/dist/mcp/handlers.js +67 -233
  30. package/dist/mcp/query.d.ts +2 -2
  31. package/dist/mcp/registry.d.ts +1 -5
  32. package/dist/mcp/registry.js +31 -20
  33. package/dist/mcp/schemaGenerator.d.ts +2 -7
  34. package/dist/mcp/schemaGenerator.js +41 -116
  35. package/dist/mcp/server.d.ts +1 -0
  36. package/dist/mcp/server.js +1 -0
  37. package/dist/mcp/serviceTokens.d.ts +16 -0
  38. package/dist/mcp/serviceTokens.js +345 -0
  39. package/dist/mcp/types.d.ts +2 -2
  40. package/dist/models/mcpServiceToken.d.ts +3 -0
  41. package/dist/models/mcpServiceToken.js +208 -0
  42. package/dist/openApiBuilder.d.ts +5 -4
  43. package/dist/openApiBuilder.js +61 -8
  44. package/dist/openApiCompat.js +1 -1
  45. package/dist/openApiValidator.js +0 -2
  46. package/dist/plugins.d.ts +14 -1
  47. package/dist/plugins.js +17 -6
  48. package/dist/populate.d.ts +2 -2
  49. package/dist/populate.js +47 -42
  50. package/dist/rateLimit/applyTrustProxy.d.ts +3 -0
  51. package/dist/rateLimit/applyTrustProxy.js +17 -0
  52. package/dist/rateLimit/createStore.d.ts +2 -0
  53. package/dist/rateLimit/createStore.js +28 -0
  54. package/dist/rateLimit/memoryStore.d.ts +2 -0
  55. package/dist/rateLimit/memoryStore.js +108 -0
  56. package/dist/rateLimit/middleware.d.ts +11 -0
  57. package/dist/rateLimit/middleware.js +110 -0
  58. package/dist/rateLimit/mongoStore.d.ts +3 -0
  59. package/dist/rateLimit/mongoStore.js +122 -0
  60. package/dist/rateLimit/policies.d.ts +14 -0
  61. package/dist/rateLimit/policies.js +151 -0
  62. package/dist/rateLimit/redisStore.d.ts +3 -0
  63. package/dist/rateLimit/redisStore.js +155 -0
  64. package/dist/rateLimit/types.d.ts +54 -0
  65. package/dist/rateLimit/types.js +9 -0
  66. package/dist/rbac/access.js +5 -1
  67. package/dist/rbac/assertAllowed.d.ts +9 -0
  68. package/dist/rbac/assertAllowed.js +182 -0
  69. package/dist/rbac/modelRouterAccess.d.ts +1 -0
  70. package/dist/rbac/modelRouterAccess.js +8 -4
  71. package/dist/rbac/permissionUtils.js +3 -2
  72. package/dist/rbac/resolve.js +5 -4
  73. package/dist/rbac/routes.js +15 -6
  74. package/dist/rbac/statements.d.ts +10 -0
  75. package/dist/rbac/statements.js +13 -2
  76. package/dist/realtime/deprecation.d.ts +12 -0
  77. package/dist/realtime/deprecation.js +32 -0
  78. package/dist/realtime/realtimeApp.d.ts +1 -1
  79. package/dist/realtime/realtimeApp.js +10 -11
  80. package/dist/realtime/registry.d.ts +0 -31
  81. package/dist/realtime/registry.js +44 -31
  82. package/dist/realtime/socketAuth.d.ts +5 -5
  83. package/dist/realtime/socketAuth.js +11 -1
  84. package/dist/realtime/socketUser.d.ts +5 -1
  85. package/dist/realtime/types.d.ts +14 -4
  86. package/dist/schemaMetadata.d.ts +56 -0
  87. package/dist/schemaMetadata.js +513 -0
  88. package/dist/seedRunner.d.ts +88 -0
  89. package/dist/seedRunner.js +627 -0
  90. package/dist/sync/executors.d.ts +12 -2
  91. package/dist/sync/executors.js +8 -10
  92. package/dist/sync/loadHarness.js +28 -19
  93. package/dist/sync/models.js +26 -24
  94. package/dist/sync/mutationHandler.d.ts +9 -0
  95. package/dist/sync/mutationHandler.js +11 -6
  96. package/dist/sync/registrationSideEffects.d.ts +35 -0
  97. package/dist/sync/registrationSideEffects.js +151 -0
  98. package/dist/sync/registry.d.ts +2 -52
  99. package/dist/sync/registry.js +38 -187
  100. package/dist/sync/routes.js +3 -2
  101. package/dist/sync/scripts/compactTombstones.js +0 -2
  102. package/dist/sync/syncApp.d.ts +3 -3
  103. package/dist/sync/syncApp.js +4 -4
  104. package/dist/sync/syncBatch.js +3 -2
  105. package/dist/sync/syncSeqPlugin.d.ts +1 -1
  106. package/dist/sync/syncSeqPlugin.js +20 -16
  107. package/dist/terrenoApp.d.ts +19 -5
  108. package/dist/terrenoApp.js +66 -18
  109. package/dist/tests/models.d.ts +2 -0
  110. package/dist/tests/models.js +6 -0
  111. package/dist/types/authToken.d.ts +33 -0
  112. package/dist/types/authToken.js +2 -0
  113. package/dist/types/mcpServiceToken.d.ts +41 -0
  114. package/dist/types/mcpServiceToken.js +2 -0
  115. package/dist/webhooks/headerValue.d.ts +2 -0
  116. package/dist/webhooks/headerValue.js +14 -0
  117. package/dist/webhooks/idempotency/memoryStore.d.ts +10 -0
  118. package/dist/webhooks/idempotency/memoryStore.js +65 -0
  119. package/dist/webhooks/idempotency/mongoStore.d.ts +4 -0
  120. package/dist/webhooks/idempotency/mongoStore.js +150 -0
  121. package/dist/webhooks/idempotency/webhookReceipt.d.ts +62 -0
  122. package/dist/webhooks/idempotency/webhookReceipt.js +39 -0
  123. package/dist/webhooks/rawBody.d.ts +14 -0
  124. package/dist/webhooks/rawBody.js +22 -0
  125. package/dist/webhooks/timingSafeEqual.d.ts +4 -0
  126. package/dist/webhooks/timingSafeEqual.js +17 -0
  127. package/dist/webhooks/verifiers/hmac.d.ts +15 -0
  128. package/dist/webhooks/verifiers/hmac.js +49 -0
  129. package/dist/webhooks/verifiers/sendgrid.d.ts +10 -0
  130. package/dist/webhooks/verifiers/sendgrid.js +56 -0
  131. package/dist/webhooks/verifiers/stripe.d.ts +9 -0
  132. package/dist/webhooks/verifiers/stripe.js +99 -0
  133. package/dist/webhooks/verifiers/twilio.d.ts +9 -0
  134. package/dist/webhooks/verifiers/twilio.js +112 -0
  135. package/dist/webhooks/webhooksApp.d.ts +33 -0
  136. package/dist/webhooks/webhooksApp.js +195 -0
  137. package/package.json +5 -6
  138. package/src/__snapshots__/openApi.test.ts.snap +270 -0
  139. package/src/__snapshots__/openApiBuilder.test.ts.snap +30 -12
  140. package/src/__snapshots__/schemaMetadata.test.ts.snap +197 -0
  141. package/src/actions.ts +20 -13
  142. package/src/adminModelRouter.test.ts +133 -0
  143. package/src/adminTypes.ts +23 -0
  144. package/src/api.arrayOperations.test.ts +43 -31
  145. package/src/api.hooks.test.ts +38 -29
  146. package/src/api.query.test.ts +31 -31
  147. package/src/api.test.ts +95 -96
  148. package/src/api.ts +16 -27
  149. package/src/auth.test.ts +107 -51
  150. package/src/auth.ts +98 -29
  151. package/src/authRecovery.test.ts +281 -0
  152. package/src/authRecovery.ts +279 -0
  153. package/src/authTokens.test.ts +94 -0
  154. package/src/authTokens.ts +118 -0
  155. package/src/authVerification.test.ts +293 -0
  156. package/src/betterAuth.ts +24 -0
  157. package/src/betterAuthApp.test.ts +1 -0
  158. package/src/betterAuthApp.ts +27 -9
  159. package/src/betterAuthSetup.test.ts +568 -38
  160. package/src/betterAuthSetup.ts +260 -5
  161. package/src/collectionRegistry.test.ts +165 -0
  162. package/src/collectionRegistry.ts +115 -0
  163. package/src/configurationApp.ts +13 -7
  164. package/src/docLoader.test.ts +45 -1
  165. package/src/docLoader.ts +37 -6
  166. package/src/express.d.ts +1 -0
  167. package/src/expressServer.test.ts +130 -66
  168. package/src/expressServer.ts +75 -19
  169. package/src/githubAuth.test.ts +60 -55
  170. package/src/index.ts +58 -0
  171. package/src/mcp/auth.test.ts +47 -0
  172. package/src/mcp/auth.ts +32 -11
  173. package/src/mcp/handlers.ts +45 -172
  174. package/src/mcp/integration.test.ts +59 -9
  175. package/src/mcp/query.ts +2 -4
  176. package/src/mcp/registry.ts +29 -20
  177. package/src/mcp/schemaGenerator.test.ts +8 -0
  178. package/src/mcp/schemaGenerator.ts +49 -131
  179. package/src/mcp/server.ts +2 -0
  180. package/src/mcp/serviceTokens.test.ts +330 -0
  181. package/src/mcp/serviceTokens.ts +307 -0
  182. package/src/mcp/toolGenerator.test.ts +1 -1
  183. package/src/mcp/types.ts +2 -6
  184. package/src/models/mcpServiceToken.test.ts +129 -0
  185. package/src/models/mcpServiceToken.ts +158 -0
  186. package/src/openApi.test.ts +80 -64
  187. package/src/openApiBuilder.test.ts +95 -7
  188. package/src/openApiBuilder.ts +46 -9
  189. package/src/openApiCompat.ts +1 -1
  190. package/src/openApiValidator.test.ts +49 -54
  191. package/src/openApiValidator.ts +1 -3
  192. package/src/plugins.test.ts +14 -0
  193. package/src/plugins.ts +34 -9
  194. package/src/populate.test.ts +34 -0
  195. package/src/populate.ts +40 -29
  196. package/src/rateLimit/applyTrustProxy.ts +17 -0
  197. package/src/rateLimit/createStore.ts +25 -0
  198. package/src/rateLimit/memoryStore.ts +40 -0
  199. package/src/rateLimit/middleware.ts +79 -0
  200. package/src/rateLimit/mongoStore.test.ts +80 -0
  201. package/src/rateLimit/mongoStore.ts +76 -0
  202. package/src/rateLimit/policies.ts +130 -0
  203. package/src/rateLimit/rateLimit.test.ts +328 -0
  204. package/src/rateLimit/redisStore.ioredis.test.ts +29 -0
  205. package/src/rateLimit/redisStore.test.ts +114 -0
  206. package/src/rateLimit/redisStore.ts +85 -0
  207. package/src/rateLimit/types.ts +64 -0
  208. package/src/rbac/access.ts +5 -1
  209. package/src/rbac/assertAllowed.test.ts +325 -0
  210. package/src/rbac/assertAllowed.ts +157 -0
  211. package/src/rbac/backfillAdmins.test.ts +124 -0
  212. package/src/rbac/fieldViews.test.ts +89 -0
  213. package/src/rbac/modelRouterAccess.test.ts +126 -0
  214. package/src/rbac/modelRouterAccess.ts +5 -2
  215. package/src/rbac/permissionUtils.ts +3 -2
  216. package/src/rbac/realtimeAccess.test.ts +109 -1
  217. package/src/rbac/resolve.ts +5 -4
  218. package/src/rbac/roleManager.test.ts +169 -0
  219. package/src/rbac/routes.test.ts +233 -0
  220. package/src/rbac/routes.ts +16 -6
  221. package/src/rbac/statements.test.ts +2 -0
  222. package/src/rbac/statements.ts +12 -1
  223. package/src/realtime/deprecation.test.ts +60 -0
  224. package/src/realtime/deprecation.ts +32 -0
  225. package/src/realtime/realtime.test.ts +8 -4
  226. package/src/realtime/realtimeApp.ts +10 -11
  227. package/src/realtime/realtimeAppSetup.test.ts +32 -5
  228. package/src/realtime/registry.ts +48 -42
  229. package/src/realtime/sessionRevalidation.test.ts +57 -44
  230. package/src/realtime/socketAuth.test.ts +75 -23
  231. package/src/realtime/socketAuth.ts +17 -6
  232. package/src/realtime/socketUser.ts +5 -3
  233. package/src/realtime/types.ts +14 -4
  234. package/src/schemaMetadata.test.ts +405 -0
  235. package/src/schemaMetadata.ts +593 -0
  236. package/src/scrubAdminFields.test.ts +105 -0
  237. package/src/seedRunner.test.ts +591 -0
  238. package/src/seedRunner.ts +464 -0
  239. package/src/sync/docMatchesMutationData.test.ts +16 -0
  240. package/src/sync/ensureSyncIndexes.test.ts +54 -15
  241. package/src/sync/executors.test.ts +40 -0
  242. package/src/sync/executors.ts +24 -12
  243. package/src/sync/integration.test.ts +15 -7
  244. package/src/sync/loadHarness.ts +28 -19
  245. package/src/sync/models.ts +32 -18
  246. package/src/sync/mutationHandler.test.ts +16 -16
  247. package/src/sync/mutationHandler.ts +9 -7
  248. package/src/sync/registrationSideEffects.test.ts +126 -0
  249. package/src/sync/registrationSideEffects.ts +131 -0
  250. package/src/sync/registry.ts +45 -171
  251. package/src/sync/routes.ts +3 -2
  252. package/src/sync/scripts/compactTombstones.ts +0 -2
  253. package/src/sync/sessionRevalidationIntegration.test.ts +12 -11
  254. package/src/sync/sync.test.ts +25 -23
  255. package/src/sync/syncApp.ts +4 -4
  256. package/src/sync/syncBatch.ts +3 -2
  257. package/src/sync/syncFrontier.test.ts +17 -15
  258. package/src/sync/syncPhaseC.test.ts +54 -43
  259. package/src/sync/syncRoutes.test.ts +51 -36
  260. package/src/sync/syncSeqPlugin.ts +66 -44
  261. package/src/sync/syncSocket.test.ts +112 -81
  262. package/src/terrenoApp.mcpServiceTokens.test.ts +173 -0
  263. package/src/terrenoApp.ts +87 -15
  264. package/src/tests/models.ts +14 -1
  265. package/src/types/authToken.ts +43 -0
  266. package/src/types/mcpServiceToken.ts +54 -0
  267. package/src/webhooks/headerValue.test.ts +22 -0
  268. package/src/webhooks/headerValue.ts +12 -0
  269. package/src/webhooks/idempotency/memoryStore.ts +34 -0
  270. package/src/webhooks/idempotency/mongoStore.test.ts +274 -0
  271. package/src/webhooks/idempotency/mongoStore.ts +83 -0
  272. package/src/webhooks/idempotency/webhookReceipt.ts +70 -0
  273. package/src/webhooks/rawBody.test.ts +74 -0
  274. package/src/webhooks/rawBody.ts +23 -0
  275. package/src/webhooks/timingSafeEqual.ts +16 -0
  276. package/src/webhooks/verifiers/hmac.test.ts +110 -0
  277. package/src/webhooks/verifiers/hmac.ts +54 -0
  278. package/src/webhooks/verifiers/providerVerifiers.test.ts +388 -0
  279. package/src/webhooks/verifiers/sendgrid.ts +59 -0
  280. package/src/webhooks/verifiers/stripe.ts +67 -0
  281. package/src/webhooks/verifiers/twilio.ts +69 -0
  282. package/src/webhooks/webhooksApp.test.ts +221 -0
  283. package/src/webhooks/webhooksApp.ts +144 -0
@@ -0,0 +1,281 @@
1
+ import {beforeEach, describe, it} from "bun:test";
2
+ import {assert} from "chai";
3
+ import type express from "express";
4
+ import mongoose from "mongoose";
5
+ import supertest from "supertest";
6
+
7
+ import {MAX_PASSWORD_LENGTH} from "./auth";
8
+ import {AuthToken} from "./authTokens";
9
+ import {TerrenoApp} from "./terrenoApp";
10
+ import {setupDb, UserModel} from "./tests";
11
+
12
+ interface CapturedMail {
13
+ html?: string;
14
+ subject: string;
15
+ text: string;
16
+ to: string;
17
+ }
18
+
19
+ const tokenFromResetUrl = (text: string): string => {
20
+ const match = text.match(/token=([0-9a-f]+)/i);
21
+ assert.isNotNull(match);
22
+ return match?.[1] ?? "";
23
+ };
24
+
25
+ describe("password reset routes", () => {
26
+ let app: express.Application;
27
+ let sentMail: CapturedMail[];
28
+
29
+ beforeEach(async () => {
30
+ await setupDb();
31
+ await AuthToken.deleteMany({});
32
+ sentMail = [];
33
+
34
+ app = new TerrenoApp({
35
+ authOptions: {
36
+ publicAppUrl: "https://app.example.com",
37
+ sendMail: async (message) => {
38
+ sentMail.push(message);
39
+ },
40
+ },
41
+ skipListen: true,
42
+ userModel: UserModel,
43
+ }).build();
44
+ });
45
+
46
+ it("returns 202 for existing and missing emails and only mails existing users", async () => {
47
+ const existing = await supertest(app)
48
+ .post("/auth/forgotPassword")
49
+ .send({email: "notAdmin@example.com"})
50
+ .expect(202);
51
+ const missing = await supertest(app)
52
+ .post("/auth/forgotPassword")
53
+ .send({email: "nobody@example.com"})
54
+ .expect(202);
55
+
56
+ assert.deepEqual(existing.body, missing.body);
57
+ assert.equal(sentMail.length, 1);
58
+ assert.equal(sentMail[0]?.to, "notAdmin@example.com");
59
+ assert.include(sentMail[0]?.text ?? "", "https://app.example.com/resetPassword?token=");
60
+ });
61
+
62
+ it("finds an existing user email case-insensitively", async () => {
63
+ const users = await UserModel.find({email: "notAdmin@example.com"});
64
+ const user = users[0];
65
+ assert.isDefined(user);
66
+ if (!user) {
67
+ return;
68
+ }
69
+ user.email = "Mixed.Case@Example.com";
70
+ await user.save();
71
+
72
+ await supertest(app)
73
+ .post("/auth/forgotPassword")
74
+ .send({email: "mixed.case@example.com"})
75
+ .expect(202);
76
+
77
+ assert.equal(sentMail.length, 1);
78
+ assert.equal(sentMail[0]?.to, "Mixed.Case@Example.com");
79
+ });
80
+
81
+ it("resets the password once, then rejects the token and old refresh tokens", async () => {
82
+ const login = await supertest(app)
83
+ .post("/auth/login")
84
+ .send({email: "notAdmin@example.com", password: "password"})
85
+ .expect(200);
86
+ const oldRefresh = login.body.data.refreshToken as string;
87
+
88
+ await supertest(app)
89
+ .post("/auth/forgotPassword")
90
+ .send({email: "notAdmin@example.com"})
91
+ .expect(202);
92
+ const token = tokenFromResetUrl(sentMail[0]?.text ?? "");
93
+
94
+ const reset = await supertest(app)
95
+ .post("/auth/resetPassword")
96
+ .send({password: "new-password-123", token})
97
+ .expect(200);
98
+ assert.isString(reset.body.data.token);
99
+
100
+ await supertest(app)
101
+ .post("/auth/resetPassword")
102
+ .send({password: "another-password", token})
103
+ .expect(400);
104
+
105
+ await supertest(app)
106
+ .post("/auth/login")
107
+ .send({email: "notAdmin@example.com", password: "password"})
108
+ .expect(401);
109
+ await supertest(app)
110
+ .post("/auth/login")
111
+ .send({email: "notAdmin@example.com", password: "new-password-123"})
112
+ .expect(200);
113
+
114
+ const refresh = await supertest(app)
115
+ .post("/auth/refresh_token")
116
+ .send({refreshToken: oldRefresh})
117
+ .expect(401);
118
+ assert.equal(refresh.body.message, "Invalid refresh token");
119
+ });
120
+
121
+ it("honors the RTK client POST /resetPassword path and body shape", async () => {
122
+ await supertest(app)
123
+ .post("/auth/forgotPassword")
124
+ .send({email: "notAdmin@example.com"})
125
+ .expect(202);
126
+ const token = tokenFromResetUrl(sentMail[0]?.text ?? "");
127
+
128
+ await supertest(app)
129
+ .post("/resetPassword")
130
+ .send({
131
+ _id: "unused",
132
+ email: "notAdmin@example.com",
133
+ newPassword: "rtk-new-password",
134
+ oldPassword: "password",
135
+ password: "rtk-new-password",
136
+ token,
137
+ })
138
+ .expect(200);
139
+
140
+ await supertest(app)
141
+ .post("/auth/login")
142
+ .send({email: "notAdmin@example.com", password: "rtk-new-password"})
143
+ .expect(200);
144
+ });
145
+
146
+ it("syncs a successful JWT reset to Better Auth when a bridge is configured", async () => {
147
+ const synced: Array<{email?: string; password: string}> = [];
148
+ const bridgedApp = new TerrenoApp({
149
+ authOptions: {
150
+ publicAppUrl: "https://app.example.com",
151
+ sendMail: async (message) => {
152
+ sentMail.push(message);
153
+ },
154
+ syncPasswordResetToBetterAuth: async (user, password) => {
155
+ synced.push({email: (user as {email?: string}).email, password});
156
+ },
157
+ },
158
+ skipListen: true,
159
+ userModel: UserModel,
160
+ }).build();
161
+
162
+ await supertest(bridgedApp)
163
+ .post("/auth/forgotPassword")
164
+ .send({email: "notAdmin@example.com"})
165
+ .expect(202);
166
+ const token = tokenFromResetUrl(sentMail[sentMail.length - 1]?.text ?? "");
167
+
168
+ await supertest(bridgedApp)
169
+ .post("/auth/resetPassword")
170
+ .send({password: "bridged-password-123", token})
171
+ .expect(200);
172
+
173
+ assert.equal(synced.length, 1);
174
+ assert.equal(synced[0]?.email, "notAdmin@example.com");
175
+ assert.equal(synced[0]?.password, "bridged-password-123");
176
+ });
177
+
178
+ it("does not consume a reset token when the new password is too long", async () => {
179
+ await supertest(app)
180
+ .post("/auth/forgotPassword")
181
+ .send({email: "notAdmin@example.com"})
182
+ .expect(202);
183
+ const token = tokenFromResetUrl(sentMail[0]?.text ?? "");
184
+
185
+ await supertest(app)
186
+ .post("/auth/resetPassword")
187
+ .send({password: "x".repeat(MAX_PASSWORD_LENGTH + 1), token})
188
+ .expect(400);
189
+
190
+ await supertest(app)
191
+ .post("/auth/resetPassword")
192
+ .send({password: "valid-after-too-long", token})
193
+ .expect(200);
194
+ });
195
+
196
+ it("accepts newPassword when password is omitted", async () => {
197
+ await supertest(app)
198
+ .post("/auth/forgotPassword")
199
+ .send({email: "notAdmin@example.com"})
200
+ .expect(202);
201
+ const token = tokenFromResetUrl(sentMail[0]?.text ?? "");
202
+
203
+ await supertest(app)
204
+ .post("/auth/resetPassword")
205
+ .send({newPassword: "only-new-password", token})
206
+ .expect(200);
207
+ });
208
+
209
+ it("returns 202 without issuing a token when publicAppUrl is missing", async () => {
210
+ const noUrlApp = new TerrenoApp({
211
+ authOptions: {
212
+ sendMail: async (message) => {
213
+ sentMail.push(message);
214
+ },
215
+ },
216
+ skipListen: true,
217
+ userModel: UserModel,
218
+ }).build();
219
+ const before = await AuthToken.countDocuments({});
220
+ await supertest(noUrlApp)
221
+ .post("/auth/forgotPassword")
222
+ .send({email: "notAdmin@example.com"})
223
+ .expect(202);
224
+ assert.equal(sentMail.length, 0);
225
+ assert.equal(await AuthToken.countDocuments({}), before);
226
+ });
227
+
228
+ it("returns 202 for a non-string email and for a missing body", async () => {
229
+ await supertest(app).post("/auth/forgotPassword").send({email: 12}).expect(202);
230
+ await supertest(app).post("/auth/forgotPassword").send({}).expect(202);
231
+ assert.equal(sentMail.length, 0);
232
+ });
233
+
234
+ it("rejects reset without a token or password", async () => {
235
+ await supertest(app).post("/auth/resetPassword").send({password: "enough-chars"}).expect(400);
236
+ await supertest(app).post("/auth/resetPassword").send({token: "deadbeef"}).expect(400);
237
+ });
238
+
239
+ it("returns 400 when the consumed reset token has no user", async () => {
240
+ const orphanId = new mongoose.Types.ObjectId();
241
+ const issued = await AuthToken.issueFor({_id: orphanId}, "passwordReset");
242
+ await supertest(app)
243
+ .post("/auth/resetPassword")
244
+ .send({password: "valid-password", token: issued.token})
245
+ .expect(400);
246
+ });
247
+
248
+ it("logs recovery mail to the console when sendMail is unset outside production", async () => {
249
+ const consoleApp = new TerrenoApp({
250
+ authOptions: {
251
+ publicAppUrl: "https://app.example.com",
252
+ },
253
+ skipListen: true,
254
+ userModel: UserModel,
255
+ }).build();
256
+ await supertest(consoleApp)
257
+ .post("/auth/forgotPassword")
258
+ .send({email: "notAdmin@example.com"})
259
+ .expect(202);
260
+ });
261
+
262
+ it("still returns 202 when production mail is unset", async () => {
263
+ const previous = process.env.NODE_ENV;
264
+ process.env.NODE_ENV = "production";
265
+ try {
266
+ const consoleApp = new TerrenoApp({
267
+ authOptions: {
268
+ publicAppUrl: "https://app.example.com",
269
+ },
270
+ skipListen: true,
271
+ userModel: UserModel,
272
+ }).build();
273
+ await supertest(consoleApp)
274
+ .post("/auth/forgotPassword")
275
+ .send({email: "notAdmin@example.com"})
276
+ .expect(202);
277
+ } finally {
278
+ process.env.NODE_ENV = previous;
279
+ }
280
+ });
281
+ });
@@ -0,0 +1,279 @@
1
+ import express from "express";
2
+
3
+ import {asyncHandler} from "./api";
4
+ import {
5
+ authenticateMiddleware,
6
+ generateTokens,
7
+ type HasSetPassword,
8
+ MAX_PASSWORD_LENGTH,
9
+ setPasswordForUser,
10
+ type User,
11
+ type UserModel,
12
+ } from "./auth";
13
+ import {AuthToken} from "./authTokens";
14
+ import {APIError} from "./errors";
15
+ import type {AuthOptions, AuthRecoveryMail} from "./expressServer";
16
+ import {logger} from "./logger";
17
+ import {createOpenApiBuilder} from "./openApiBuilder";
18
+ import {findOneOrNoneFor} from "./plugins";
19
+
20
+ const RESET_PASSWORD_SUBJECT = "Reset your password";
21
+ const VERIFY_EMAIL_SUBJECT = "Verify your email";
22
+
23
+ const resetPasswordText = (resetUrl: string): string =>
24
+ `Reset your password using this link: ${resetUrl}`;
25
+
26
+ const resetPasswordHtml = (resetUrl: string): string =>
27
+ `<p><a href="${resetUrl}">Reset your password</a></p>`;
28
+
29
+ const verifyEmailText = (verifyUrl: string): string =>
30
+ `Verify your email using this link: ${verifyUrl}`;
31
+
32
+ const verifyEmailHtml = (verifyUrl: string): string =>
33
+ `<p><a href="${verifyUrl}">Verify your email</a></p>`;
34
+
35
+ const normalizeEmail = (value: unknown): string => {
36
+ if (typeof value !== "string") {
37
+ return "";
38
+ }
39
+ return value.trim().toLowerCase();
40
+ };
41
+
42
+ const escapeRegularExpression = (value: string): string => {
43
+ return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
44
+ };
45
+
46
+ const findUserByEmail = async (userModel: UserModel, email: string): Promise<User | null> => {
47
+ return findOneOrNoneFor(userModel, {
48
+ email: {$options: "i", $regex: `^${escapeRegularExpression(email)}$`},
49
+ } as never);
50
+ };
51
+
52
+ const passwordFromBody = (body: Record<string, unknown>): string => {
53
+ if (typeof body.password === "string" && body.password.length > 0) {
54
+ return body.password;
55
+ }
56
+ if (typeof body.newPassword === "string" && body.newPassword.length > 0) {
57
+ return body.newPassword;
58
+ }
59
+ return "";
60
+ };
61
+
62
+ const tokenFromBody = (body: Record<string, unknown>): string => {
63
+ if (typeof body.token === "string") {
64
+ return body.token;
65
+ }
66
+ return "";
67
+ };
68
+
69
+ const buildAppUrl = (publicAppUrl: string | undefined, path: string, token: string): string => {
70
+ const base = (publicAppUrl ?? "").replace(/\/$/, "");
71
+ return `${base}${path}?token=${encodeURIComponent(token)}`;
72
+ };
73
+
74
+ const buildResetUrl = (publicAppUrl: string | undefined, token: string): string => {
75
+ return buildAppUrl(publicAppUrl, "/resetPassword", token);
76
+ };
77
+
78
+ const buildVerifyUrl = (publicAppUrl: string | undefined, token: string): string => {
79
+ return buildAppUrl(publicAppUrl, "/verifyEmail", token);
80
+ };
81
+
82
+ const userEmail = (user: User, fallback = ""): string => {
83
+ if (typeof (user as User & {email?: string}).email === "string") {
84
+ return (user as User & {email: string}).email;
85
+ }
86
+ return fallback;
87
+ };
88
+
89
+ const isEmailVerified = (user: User): boolean => {
90
+ return (user as User & {emailVerified?: boolean}).emailVerified === true;
91
+ };
92
+
93
+ const markEmailVerified = (user: User): void => {
94
+ (user as User & {emailVerified?: boolean}).emailVerified = true;
95
+ };
96
+
97
+ export const sendVerificationEmail = async (
98
+ user: User,
99
+ authOptions?: AuthOptions
100
+ ): Promise<void> => {
101
+ if (!authOptions?.publicAppUrl) {
102
+ logger.error("[auth] publicAppUrl is required to send verification mail");
103
+ throw new APIError({
104
+ status: 501,
105
+ title: "publicAppUrl is required to send verification mail",
106
+ });
107
+ }
108
+ if (isEmailVerified(user)) {
109
+ return;
110
+ }
111
+ const issued = await AuthToken.issueFor({_id: String(user._id)}, "emailVerification");
112
+ const verifyUrl = buildVerifyUrl(authOptions.publicAppUrl, issued.token);
113
+ await deliverRecoveryMail(authOptions, {
114
+ html: verifyEmailHtml(verifyUrl),
115
+ subject: VERIFY_EMAIL_SUBJECT,
116
+ text: verifyEmailText(verifyUrl),
117
+ to: userEmail(user),
118
+ });
119
+ };
120
+
121
+ const deliverRecoveryMail = async (
122
+ authOptions: AuthOptions | undefined,
123
+ message: AuthRecoveryMail
124
+ ): Promise<void> => {
125
+ if (authOptions?.sendMail) {
126
+ await authOptions.sendMail(message);
127
+ return;
128
+ }
129
+ if (process.env.NODE_ENV === "production") {
130
+ throw new APIError({status: 501, title: "Mail is not configured"});
131
+ }
132
+ logger.info(
133
+ `[auth] Console recovery mail subject=${message.subject} textLength=${message.text.length}`
134
+ );
135
+ };
136
+
137
+ const incrementTokenEpoch = (user: User): void => {
138
+ user.tokenEpoch = (user.tokenEpoch ?? 0) + 1;
139
+ };
140
+
141
+ export const addAuthRecoveryRoutes = (
142
+ app: express.Application,
143
+ userModel: UserModel,
144
+ authOptions?: AuthOptions
145
+ ): void => {
146
+ const forgotPassword = asyncHandler(async (req: express.Request, res: express.Response) => {
147
+ const email = normalizeEmail(req.body?.email);
148
+ if (email) {
149
+ try {
150
+ const user = await findUserByEmail(userModel, email);
151
+ if (user) {
152
+ if (!authOptions?.publicAppUrl) {
153
+ logger.error("[auth] publicAppUrl is required to send password reset mail");
154
+ } else {
155
+ const issued = await AuthToken.issueFor({_id: String(user._id)}, "passwordReset");
156
+ const resetUrl = buildResetUrl(authOptions.publicAppUrl, issued.token);
157
+ await deliverRecoveryMail(authOptions, {
158
+ html: resetPasswordHtml(resetUrl),
159
+ subject: RESET_PASSWORD_SUBJECT,
160
+ text: resetPasswordText(resetUrl),
161
+ to: userEmail(user, email),
162
+ });
163
+ }
164
+ }
165
+ } catch (error: unknown) {
166
+ logger.error("[auth] Failed to send password reset mail", {error});
167
+ }
168
+ }
169
+ return res.status(202).json({data: {ok: true}});
170
+ });
171
+
172
+ const resetPassword = asyncHandler(async (req: express.Request, res: express.Response) => {
173
+ const body = (req.body ?? {}) as Record<string, unknown>;
174
+ const token = tokenFromBody(body);
175
+ const password = passwordFromBody(body);
176
+ if (!token || !password) {
177
+ throw new APIError({status: 400, title: "token and password are required"});
178
+ }
179
+ if (password.length > MAX_PASSWORD_LENGTH) {
180
+ throw new APIError({
181
+ status: 400,
182
+ title: `Password must be at most ${MAX_PASSWORD_LENGTH} characters`,
183
+ });
184
+ }
185
+ const consumed = await AuthToken.consume(token, "passwordReset");
186
+ if (!consumed) {
187
+ throw new APIError({status: 400, title: "Invalid or expired reset token"});
188
+ }
189
+ const user = await userModel.findById(consumed.userId);
190
+ if (!user) {
191
+ throw new APIError({status: 400, title: "Invalid or expired reset token"});
192
+ }
193
+ await setPasswordForUser(user as unknown as HasSetPassword, password);
194
+ incrementTokenEpoch(user);
195
+ await (user as unknown as {save: () => Promise<unknown>}).save();
196
+ if (authOptions?.syncPasswordResetToBetterAuth) {
197
+ await authOptions.syncPasswordResetToBetterAuth(user, password);
198
+ }
199
+ const tokens = await generateTokens(user, authOptions);
200
+ return res.json({
201
+ data: {refreshToken: tokens.refreshToken, token: tokens.token, userId: user._id},
202
+ });
203
+ });
204
+
205
+ const forgotOpenApi = createOpenApiBuilder({})
206
+ .withTags(["auth"])
207
+ .withSummary("Request a password reset email")
208
+ .withRequestBody({email: {type: "string"}})
209
+ .withResponse(202, {ok: {type: "boolean"}})
210
+ .build();
211
+
212
+ const resetOpenApi = createOpenApiBuilder({})
213
+ .withTags(["auth"])
214
+ .withSummary("Reset password with a one-time token")
215
+ .withRequestBody({
216
+ newPassword: {type: "string"},
217
+ password: {type: "string"},
218
+ token: {type: "string"},
219
+ })
220
+ .withResponse(200, {
221
+ refreshToken: {type: "string"},
222
+ token: {type: "string"},
223
+ userId: {type: "string"},
224
+ })
225
+ .build();
226
+
227
+ const sendVerification = asyncHandler(async (req: express.Request, res: express.Response) => {
228
+ const user = req.user as User | undefined;
229
+ if (!user) {
230
+ throw new APIError({status: 401, title: "Unauthorized"});
231
+ }
232
+ await sendVerificationEmail(user, authOptions);
233
+ return res.status(202).json({data: {ok: true}});
234
+ });
235
+
236
+ const verifyEmail = asyncHandler(async (req: express.Request, res: express.Response) => {
237
+ const token = tokenFromBody((req.body ?? {}) as Record<string, unknown>);
238
+ if (!token) {
239
+ throw new APIError({status: 400, title: "token is required"});
240
+ }
241
+ const consumed = await AuthToken.consume(token, "emailVerification");
242
+ if (!consumed) {
243
+ throw new APIError({status: 400, title: "Invalid or expired verification token"});
244
+ }
245
+ const user = await userModel.findById(consumed.userId);
246
+ if (!user) {
247
+ throw new APIError({status: 400, title: "Invalid or expired verification token"});
248
+ }
249
+ markEmailVerified(user);
250
+ await (user as unknown as {save: () => Promise<unknown>}).save();
251
+ return res.json({data: {ok: true}});
252
+ });
253
+
254
+ const sendVerificationOpenApi = createOpenApiBuilder({})
255
+ .withTags(["auth"])
256
+ .withSummary("Send or resend an email verification link")
257
+ .withResponse(202, {ok: {type: "boolean"}})
258
+ .build();
259
+
260
+ const verifyEmailOpenApi = createOpenApiBuilder({})
261
+ .withTags(["auth"])
262
+ .withSummary("Verify email with a one-time token")
263
+ .withRequestBody({token: {type: "string"}})
264
+ .withResponse(200, {ok: {type: "boolean"}})
265
+ .build();
266
+
267
+ const router = express.Router();
268
+ router.post("/forgotPassword", forgotOpenApi, forgotPassword);
269
+ router.post("/resetPassword", resetOpenApi, resetPassword);
270
+ router.post(
271
+ "/sendVerification",
272
+ authenticateMiddleware(),
273
+ sendVerificationOpenApi,
274
+ sendVerification
275
+ );
276
+ router.post("/verifyEmail", verifyEmailOpenApi, verifyEmail);
277
+ app.use("/auth", router);
278
+ app.post("/resetPassword", resetOpenApi, resetPassword);
279
+ };
@@ -0,0 +1,94 @@
1
+ import {beforeEach, describe, it} from "bun:test";
2
+ import {createHash} from "node:crypto";
3
+ import {assert} from "chai";
4
+ import {DateTime} from "luxon";
5
+ import mongoose from "mongoose";
6
+
7
+ import {AUTH_TOKEN_TTL, AuthToken} from "./authTokens";
8
+
9
+ const hashToken = (token: string): string => createHash("sha256").update(token).digest("hex");
10
+
11
+ describe("AuthToken", () => {
12
+ beforeEach(async () => {
13
+ await AuthToken.deleteMany({});
14
+ });
15
+
16
+ it("issues a hashed single-use token with type-specific TTL and never stores plaintext", async () => {
17
+ const userId = new mongoose.Types.ObjectId();
18
+ const issued = await AuthToken.issueFor({_id: userId}, "passwordReset");
19
+
20
+ assert.match(issued.token, /^[0-9a-f]{64}$/);
21
+ assert.equal(issued.authToken.tokenHash, hashToken(issued.token));
22
+ assert.notInclude(JSON.stringify(issued.authToken.toJSON()), issued.token);
23
+ assert.isUndefined(issued.authToken.consumedAt);
24
+
25
+ const ttlMs = issued.authToken.expiresAt.getTime() - issued.authToken.created.getTime();
26
+ const expectedMs = AUTH_TOKEN_TTL.passwordReset.as("milliseconds");
27
+ assert.approximately(ttlMs, expectedMs, 5_000);
28
+
29
+ const verifyIssued = await AuthToken.issueFor({_id: userId}, "emailVerification");
30
+ const verifyTtlMs =
31
+ verifyIssued.authToken.expiresAt.getTime() - verifyIssued.authToken.created.getTime();
32
+ assert.approximately(verifyTtlMs, AUTH_TOKEN_TTL.emailVerification.as("milliseconds"), 5_000);
33
+ });
34
+
35
+ it("consumes a token exactly once under parallel callers", async () => {
36
+ const userId = new mongoose.Types.ObjectId();
37
+ const {token} = await AuthToken.issueFor({_id: userId}, "passwordReset");
38
+
39
+ const results = await Promise.all(
40
+ Array.from({length: 20}, () => AuthToken.consume(token, "passwordReset"))
41
+ );
42
+ const winners = results.filter((doc) => doc !== null);
43
+
44
+ assert.equal(winners.length, 1);
45
+ assert.equal(String(winners[0]?.userId), String(userId));
46
+ assert.isDefined(winners[0]?.consumedAt);
47
+
48
+ const secondPass = await AuthToken.consume(token, "passwordReset");
49
+ assert.isNull(secondPass);
50
+ });
51
+
52
+ it("does not consume an expired token", async () => {
53
+ const userId = new mongoose.Types.ObjectId();
54
+ const {token, authToken} = await AuthToken.issueFor({_id: userId}, "passwordReset");
55
+ authToken.expiresAt = DateTime.fromMillis(0).toJSDate();
56
+ await authToken.save();
57
+
58
+ const consumed = await AuthToken.consume(token, "passwordReset");
59
+ assert.isNull(consumed);
60
+ });
61
+
62
+ it("does not consume a token of a different type", async () => {
63
+ const userId = new mongoose.Types.ObjectId();
64
+ const {token} = await AuthToken.issueFor({_id: userId}, "passwordReset");
65
+
66
+ const consumed = await AuthToken.consume(token, "emailVerification");
67
+ assert.isNull(consumed);
68
+ });
69
+
70
+ it("invalidates earlier unused tokens of the same type when issuing a new one", async () => {
71
+ const userId = new mongoose.Types.ObjectId();
72
+ const firstReset = await AuthToken.issueFor({_id: userId}, "passwordReset");
73
+ const firstVerify = await AuthToken.issueFor({_id: userId}, "emailVerification");
74
+ const secondReset = await AuthToken.issueFor({_id: userId}, "passwordReset");
75
+
76
+ assert.isNull(await AuthToken.consume(firstReset.token, "passwordReset"));
77
+ const stillValidVerify = await AuthToken.consume(firstVerify.token, "emailVerification");
78
+ assert.isNotNull(stillValidVerify);
79
+ const consumedSecond = await AuthToken.consume(secondReset.token, "passwordReset");
80
+ assert.isNotNull(consumedSecond);
81
+ });
82
+
83
+ it("invalidates unused tokens of a type without issuing a replacement", async () => {
84
+ const userId = new mongoose.Types.ObjectId();
85
+ const issued = await AuthToken.issueFor({_id: userId}, "emailVerification");
86
+ const resetIssued = await AuthToken.issueFor({_id: userId}, "passwordReset");
87
+
88
+ await AuthToken.invalidateUnusedFor({_id: userId}, "emailVerification");
89
+
90
+ assert.isNull(await AuthToken.consume(issued.token, "emailVerification"));
91
+ const stillValidReset = await AuthToken.consume(resetIssued.token, "passwordReset");
92
+ assert.isNotNull(stillValidReset);
93
+ });
94
+ });