@terreno/api 57.20.0 → 58.0.0-beta.1

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 (183) hide show
  1. package/CHANGELOG.md +93 -0
  2. package/README.md +1 -1
  3. package/biome.jsonc +3 -2
  4. package/dist/api.d.ts +3 -16
  5. package/dist/api.js +0 -9
  6. package/dist/auth.d.ts +3 -2
  7. package/dist/auth.js +95 -5
  8. package/dist/authRecovery.d.ts +2 -1
  9. package/dist/authRecovery.js +35 -17
  10. package/dist/collectionRegistry.d.ts +3 -4
  11. package/dist/collectionRegistry.js +0 -1
  12. package/dist/consentApp.d.ts +1 -1
  13. package/dist/consentApp.js +58 -2
  14. package/dist/frameworkModelNames.d.ts +4 -0
  15. package/dist/frameworkModelNames.js +4 -0
  16. package/dist/index.d.ts +8 -5
  17. package/dist/index.js +14 -20
  18. package/dist/mcp/adminTracking.d.ts +28 -0
  19. package/dist/mcp/adminTracking.js +80 -0
  20. package/dist/mcp/auth.d.ts +6 -0
  21. package/dist/mcp/auth.js +12 -2
  22. package/dist/mcp/server.d.ts +8 -0
  23. package/dist/mcp/server.js +48 -4
  24. package/dist/mcp/serviceTokens.d.ts +21 -1
  25. package/dist/mcp/serviceTokens.js +159 -183
  26. package/dist/migrations/builtin/mcpServiceTokenStringIds.d.ts +18 -0
  27. package/dist/migrations/builtin/mcpServiceTokenStringIds.js +67 -0
  28. package/dist/models/mcpOAuthToken.js +27 -0
  29. package/dist/models/mcpRequestLog.d.ts +2 -0
  30. package/dist/models/mcpRequestLog.js +73 -0
  31. package/dist/models/mcpServiceToken.js +40 -4
  32. package/dist/models/mcpToolSetting.d.ts +2 -0
  33. package/dist/models/mcpToolSetting.js +119 -0
  34. package/dist/models/versionConfig.d.ts +2 -0
  35. package/dist/openApiBuilder.d.ts +4 -0
  36. package/dist/openApiBuilder.js +2 -0
  37. package/dist/rbac/auditModel.d.ts +2 -1
  38. package/dist/rbac/realtimeAccess.d.ts +5 -4
  39. package/dist/rbac/realtimeAccess.js +17 -64
  40. package/dist/realtime/changeStreamWatcher.d.ts +8 -63
  41. package/dist/realtime/changeStreamWatcher.js +32 -391
  42. package/dist/realtime/realtimeApp.d.ts +14 -27
  43. package/dist/realtime/realtimeApp.js +14 -220
  44. package/dist/realtime/types.d.ts +0 -64
  45. package/dist/sync/executors.js +14 -2
  46. package/dist/sync/socketHandlers.d.ts +1 -1
  47. package/dist/sync/socketHandlers.js +1 -1
  48. package/dist/terrenoApp.d.ts +19 -5
  49. package/dist/terrenoApp.js +21 -14
  50. package/dist/tests/models.d.ts +17 -22
  51. package/dist/tests/models.js +7 -1
  52. package/dist/tests/openApiResponseSchema.d.ts +39 -0
  53. package/dist/tests/openApiResponseSchema.js +56 -0
  54. package/dist/tests/testHelper.d.ts +6 -12
  55. package/dist/tests.d.ts +2 -0
  56. package/dist/tests.js +6 -1
  57. package/dist/types/mcpAdmin.d.ts +58 -0
  58. package/dist/types/mcpAdmin.js +2 -0
  59. package/dist/types/mcpOAuth.d.ts +2 -0
  60. package/dist/types/mcpServiceToken.d.ts +9 -4
  61. package/dist/versionCheckPlugin.d.ts +1 -1
  62. package/dist/versionCheckPlugin.js +25 -2
  63. package/e2e/smoke.ts +193 -0
  64. package/package.json +14 -8
  65. package/src/__snapshots__/openApi.test.ts.snap +4986 -2478
  66. package/src/__snapshots__/openApiBuilder.test.ts.snap +836 -0
  67. package/src/__tests__/openApiResponseSchema.test.ts +148 -0
  68. package/src/__tests__/versionCheckPlugin.test.ts +72 -0
  69. package/src/adminModelRouter.test.ts +8 -6
  70. package/src/api.arrayOperations.test.ts +31 -22
  71. package/src/api.hooks.test.ts +12 -11
  72. package/src/api.query.test.ts +2 -2
  73. package/src/api.test.ts +17 -14
  74. package/src/api.ts +3 -27
  75. package/src/audit/auditApp.test.ts +1 -1
  76. package/src/audit/cloudTasksEnqueue.test.ts +19 -14
  77. package/src/auth.test.ts +21 -7
  78. package/src/auth.ts +116 -5
  79. package/src/authOpenApi.test.ts +316 -0
  80. package/src/authRecovery.test.ts +10 -10
  81. package/src/authRecovery.ts +47 -19
  82. package/src/authVerification.test.ts +7 -7
  83. package/src/betterAuthFeatures.test.ts +3 -2
  84. package/src/betterAuthLinking.test.ts +3 -1
  85. package/src/betterAuthOAuthHandoff.test.ts +13 -5
  86. package/src/betterAuthSetup.test.ts +77 -51
  87. package/src/collectionRegistry.test.ts +4 -4
  88. package/src/collectionRegistry.ts +3 -5
  89. package/src/consentApp.test.ts +98 -0
  90. package/src/consentApp.ts +67 -2
  91. package/src/frameworkModelNames.test.ts +8 -0
  92. package/src/frameworkModelNames.ts +4 -0
  93. package/src/githubAuth.test.ts +11 -11
  94. package/src/index.ts +14 -28
  95. package/src/isolated/migrateCliConnect.isolated.ts +3 -2
  96. package/src/mcp/actionTools.test.ts +13 -7
  97. package/src/mcp/adminTracking.test.ts +272 -0
  98. package/src/mcp/adminTracking.ts +104 -0
  99. package/src/mcp/auth.test.ts +7 -3
  100. package/src/mcp/auth.ts +18 -2
  101. package/src/mcp/oauth.test.ts +13 -13
  102. package/src/mcp/server.ts +67 -4
  103. package/src/mcp/serviceTokens.sync.test.ts +230 -0
  104. package/src/mcp/serviceTokens.test.ts +114 -62
  105. package/src/mcp/serviceTokens.ts +193 -212
  106. package/src/mcp/toolGenerator.test.ts +9 -5
  107. package/src/migrations/builtin/mcpServiceTokenStringIds.test.ts +194 -0
  108. package/src/migrations/builtin/mcpServiceTokenStringIds.ts +121 -0
  109. package/src/migrations/cli.test.ts +15 -14
  110. package/src/migrations/cli.ts +1 -1
  111. package/src/migrations/generate.test.ts +2 -2
  112. package/src/migrations/load.test.ts +1 -1
  113. package/src/migrations/lock.test.ts +8 -3
  114. package/src/migrations/runner.test.ts +16 -5
  115. package/src/migrations/schemaCatalog.test.ts +4 -1
  116. package/src/models/mcpOAuthToken.test.ts +42 -0
  117. package/src/models/mcpOAuthToken.ts +32 -0
  118. package/src/models/mcpRequestLog.ts +81 -0
  119. package/src/models/mcpServiceToken.test.ts +75 -5
  120. package/src/models/mcpServiceToken.ts +61 -14
  121. package/src/models/mcpToolSetting.test.ts +69 -0
  122. package/src/models/mcpToolSetting.ts +138 -0
  123. package/src/models/versionConfig.ts +2 -0
  124. package/src/notifications/notificationsApp.test.ts +5 -8
  125. package/src/notifiers/slackWebApi.test.ts +30 -8
  126. package/src/openApi.test.ts +4 -4
  127. package/src/openApiBuilder.test.ts +34 -1
  128. package/src/openApiBuilder.ts +5 -0
  129. package/src/openApiValidator.test.ts +3 -3
  130. package/src/orgs/orgPermissions.test.ts +2 -2
  131. package/src/orgs/orgPlugin.test.ts +4 -3
  132. package/src/orgs/orgSecurityDefects.test.ts +3 -1
  133. package/src/orgs/organizationSettings.test.ts +1 -1
  134. package/src/orgs/orgsApp.test.ts +5 -3
  135. package/src/permissions.test.ts +2 -2
  136. package/src/rateLimit/rateLimit.test.ts +25 -10
  137. package/src/rateLimit/redisStore.ioredis.test.ts +3 -2
  138. package/src/rbac/assertAllowed.test.ts +1 -1
  139. package/src/rbac/auditModel.ts +10 -2
  140. package/src/rbac/realtimeAccess.test.ts +20 -171
  141. package/src/rbac/realtimeAccess.ts +17 -82
  142. package/src/rbac/routes.test.ts +1 -1
  143. package/src/rbac/userWriteGuards.test.ts +8 -5
  144. package/src/realtime/changeStreamWatcher.ts +43 -506
  145. package/src/realtime/realtime.test.ts +211 -2547
  146. package/src/realtime/realtimeApp.ts +16 -295
  147. package/src/realtime/types.ts +0 -72
  148. package/src/scrubAdminFields.test.ts +1 -1
  149. package/src/sync/adminWindowMutation.test.ts +4 -3
  150. package/src/sync/executors.test.ts +29 -1
  151. package/src/sync/executors.ts +23 -2
  152. package/src/sync/scripts/compactTombstones.test.ts +4 -3
  153. package/src/sync/socketHandlers.ts +1 -1
  154. package/src/sync/sync.test.ts +1 -1
  155. package/src/sync/syncPhaseC.test.ts +14 -11
  156. package/src/sync/syncRoutes.test.ts +8 -8
  157. package/src/sync/syncSeqPlugin.test.ts +1 -2
  158. package/src/sync/syncSocket.test.ts +78 -113
  159. package/src/terrenoApp.mcpServiceTokens.test.ts +16 -8
  160. package/src/terrenoApp.migrations.test.ts +8 -7
  161. package/src/terrenoApp.ts +38 -18
  162. package/src/tests/betterAuthStubs.ts +3 -2
  163. package/src/tests/bunSetup.ts +1 -1
  164. package/src/tests/models.ts +10 -0
  165. package/src/tests/openApiResponseSchema.ts +104 -0
  166. package/src/tests/testEnv.ts +7 -0
  167. package/src/tests.ts +8 -0
  168. package/src/types/mcpAdmin.ts +80 -0
  169. package/src/types/mcpOAuth.ts +5 -0
  170. package/src/types/mcpServiceToken.ts +12 -4
  171. package/src/versionCheckPlugin.ts +41 -2
  172. package/src/webhooks/verifiers/hmac.test.ts +1 -1
  173. package/tsconfig.typecheck.json +14 -0
  174. package/dist/realtime/deprecation.d.ts +0 -13
  175. package/dist/realtime/deprecation.js +0 -31
  176. package/dist/realtime/queryStore.d.ts +0 -37
  177. package/dist/realtime/queryStore.js +0 -103
  178. package/dist/realtime/registry.d.ts +0 -15
  179. package/dist/realtime/registry.js +0 -52
  180. package/src/realtime/deprecation.test.ts +0 -60
  181. package/src/realtime/deprecation.ts +0 -33
  182. package/src/realtime/queryStore.ts +0 -122
  183. package/src/realtime/registry.ts +0 -84
@@ -1,6 +1,6 @@
1
1
  import express from "express";
2
2
 
3
- import {asyncHandler} from "./api";
3
+ import {asyncHandler, type OpenApiMiddleware} from "./api";
4
4
  import {
5
5
  authenticateMiddleware,
6
6
  generateTokens,
@@ -220,6 +220,14 @@ const incrementTokenEpoch = (user: User): void => {
220
220
  user.tokenEpoch = (user.tokenEpoch ?? 0) + 1;
221
221
  };
222
222
 
223
+ const okResponse = {
224
+ data: {
225
+ properties: {ok: {type: "boolean"}},
226
+ required: ["ok"],
227
+ type: "object",
228
+ },
229
+ };
230
+
223
231
  // The auth options passed to addAuthRoutes, kept on the app so changeUserPassword can reach the
224
232
  // Better Auth credential sync that TerrenoApp wires after the routes are added.
225
233
  const AUTH_OPTIONS_LOCAL_KEY = "terrenoAuthOptions";
@@ -261,8 +269,10 @@ export const changeUserPassword = async (
261
269
  export const addAuthRecoveryRoutes = (
262
270
  app: express.Application,
263
271
  userModel: UserModel,
264
- authOptions?: AuthOptions
272
+ authOptions?: AuthOptions,
273
+ openApi?: OpenApiMiddleware
265
274
  ): void => {
275
+ const openApiOptions = openApi ? {openApi} : {};
266
276
  if (authOptions) {
267
277
  app.locals[AUTH_OPTIONS_LOCAL_KEY] = authOptions;
268
278
  }
@@ -347,26 +357,42 @@ export const addAuthRecoveryRoutes = (
347
357
  });
348
358
  });
349
359
 
350
- const forgotOpenApi = createOpenApiBuilder({})
360
+ const forgotOpenApi = createOpenApiBuilder(openApiOptions)
351
361
  .withTags(["auth"])
352
362
  .withSummary("Request a password reset email")
353
- .withRequestBody({email: {type: "string"}})
354
- .withResponse(202, {ok: {type: "boolean"}})
363
+ .withDescription(
364
+ "Always returns 202, whether or not an account exists for the email, so accounts cannot be probed."
365
+ )
366
+ .withRequestBody({email: {description: "The account's email address", type: "string"}})
367
+ .withResponse(202, okResponse, {description: "Accepted", required: ["data"]})
355
368
  .build();
356
369
 
357
- const resetOpenApi = createOpenApiBuilder({})
370
+ const resetOpenApi = createOpenApiBuilder(openApiOptions)
358
371
  .withTags(["auth"])
359
372
  .withSummary("Reset password with a one-time token")
373
+ .withDescription(
374
+ "Send `token` and either `password` or `newPassword`. Returns fresh tokens for the user."
375
+ )
360
376
  .withRequestBody({
361
- newPassword: {type: "string"},
362
- password: {type: "string"},
363
- token: {type: "string"},
364
- })
365
- .withResponse(200, {
366
- refreshToken: {type: "string"},
367
- token: {type: "string"},
368
- userId: {type: "string"},
377
+ newPassword: {description: "Alias for password", type: "string"},
378
+ password: {description: "The new password", type: "string"},
379
+ token: {description: "One-time reset token from the emailed link", type: "string"},
369
380
  })
381
+ .withResponse(
382
+ 200,
383
+ {
384
+ data: {
385
+ properties: {
386
+ refreshToken: {type: "string"},
387
+ token: {type: "string"},
388
+ userId: {type: "string"},
389
+ },
390
+ required: ["refreshToken", "token", "userId"],
391
+ type: "object",
392
+ },
393
+ },
394
+ {required: ["data"]}
395
+ )
370
396
  .build();
371
397
 
372
398
  const sendVerification = asyncHandler(async (req: express.Request, res: express.Response) => {
@@ -396,17 +422,19 @@ export const addAuthRecoveryRoutes = (
396
422
  return res.json({data: {ok: true}});
397
423
  });
398
424
 
399
- const sendVerificationOpenApi = createOpenApiBuilder({})
425
+ const sendVerificationOpenApi = createOpenApiBuilder(openApiOptions)
400
426
  .withTags(["auth"])
401
427
  .withSummary("Send or resend an email verification link")
402
- .withResponse(202, {ok: {type: "boolean"}})
428
+ .withResponse(202, okResponse, {description: "Accepted", required: ["data"]})
403
429
  .build();
404
430
 
405
- const verifyEmailOpenApi = createOpenApiBuilder({})
431
+ const verifyEmailOpenApi = createOpenApiBuilder(openApiOptions)
406
432
  .withTags(["auth"])
407
433
  .withSummary("Verify email with a one-time token")
408
- .withRequestBody({token: {type: "string"}})
409
- .withResponse(200, {ok: {type: "boolean"}})
434
+ .withRequestBody({
435
+ token: {description: "One-time verification token from the emailed link", type: "string"},
436
+ })
437
+ .withResponse(200, okResponse, {required: ["data"]})
410
438
  .build();
411
439
 
412
440
  const router = express.Router();
@@ -8,7 +8,7 @@ import supertest from "supertest";
8
8
  import type {UserModel as AuthUserModel} from "./auth";
9
9
  import {AuthToken} from "./authTokens";
10
10
  import {TerrenoApp} from "./terrenoApp";
11
- import {setupDb, UserModel} from "./tests";
11
+ import {authUserModel, setupDb, UserModel} from "./tests";
12
12
 
13
13
  interface CapturedMail {
14
14
  html?: string;
@@ -44,7 +44,7 @@ describe("email verification gating", () => {
44
44
  },
45
45
  },
46
46
  skipListen: true,
47
- userModel: UserModel,
47
+ userModel: authUserModel,
48
48
  }).build();
49
49
 
50
50
  openApp = new TerrenoApp({
@@ -55,7 +55,7 @@ describe("email verification gating", () => {
55
55
  },
56
56
  },
57
57
  skipListen: true,
58
- userModel: UserModel,
58
+ userModel: authUserModel,
59
59
  }).build();
60
60
  });
61
61
 
@@ -109,7 +109,7 @@ describe("email verification gating", () => {
109
109
  },
110
110
  },
111
111
  skipListen: true,
112
- userModel: UserModel,
112
+ userModel: authUserModel,
113
113
  }).build();
114
114
 
115
115
  await supertest(noVerificationRoutesApp)
@@ -144,7 +144,7 @@ describe("email verification gating", () => {
144
144
  },
145
145
  },
146
146
  skipListen: true,
147
- userModel: UserModel,
147
+ userModel: authUserModel,
148
148
  }).build();
149
149
  const login = await supertest(failingApp)
150
150
  .post("/auth/login")
@@ -165,7 +165,7 @@ describe("email verification gating", () => {
165
165
  },
166
166
  },
167
167
  skipListen: true,
168
- userModel: UserModel,
168
+ userModel: authUserModel,
169
169
  }).build();
170
170
  const login = await supertest(noUrlApp)
171
171
  .post("/auth/login")
@@ -275,7 +275,7 @@ describe("email verification gating", () => {
275
275
  }
276
276
  );
277
277
  const JwtResetOnlyUser = (mongoose.models.JwtResetOnlyUser ??
278
- mongoose.model("JwtResetOnlyUser", jwtResetOnlySchema)) as AuthUserModel;
278
+ mongoose.model("JwtResetOnlyUser", jwtResetOnlySchema)) as unknown as AuthUserModel;
279
279
  await JwtResetOnlyUser.deleteMany({});
280
280
  const registerable = JwtResetOnlyUser as unknown as {
281
281
  register: (
@@ -2,6 +2,7 @@ import {afterAll, describe, expect, it} from "bun:test";
2
2
  import {createVerify, generateKeyPairSync} from "node:crypto";
3
3
  import type {BetterAuthPlugin} from "better-auth";
4
4
  import {twoFactor} from "better-auth/plugins";
5
+ import type {GoogleProfile} from "better-auth/social-providers";
5
6
  import express from "express";
6
7
  import {DateTime} from "luxon";
7
8
  import mongoose, {Schema} from "mongoose";
@@ -325,8 +326,8 @@ describe("signUp: closed", () => {
325
326
  socialProviders: {
326
327
  google: {
327
328
  getUserInfo: async () => ({
328
- data: {sub: "google-sub"},
329
- user: {email, emailVerified: true, id: "google-sub", name: "Google User"},
329
+ data: {sub: "google-sub"} as GoogleProfile,
330
+ user: {email, emailVerified: true, name: "Google User"},
330
331
  }),
331
332
  verifyIdToken: async () => true,
332
333
  },
@@ -782,7 +782,9 @@ describe("syncBetterAuthUser email matches", () => {
782
782
 
783
783
  await syncBetterAuthUser(userModel, unverifiedUser(email), undefined, {password: PASSWORD});
784
784
 
785
- const stored = await LinkingUser.collection.findOne({_id: legacy._id});
785
+ const stored = await LinkingUser.collection.findOne({
786
+ _id: legacy._id as mongoose.Types.ObjectId,
787
+ });
786
788
  expect(typeof stored?.hash).toBe("string");
787
789
  });
788
790
 
@@ -44,7 +44,9 @@ const callbackOverridePlugin = {
44
44
  }
45
45
  }),
46
46
  matcher: (context: {path?: string}): boolean =>
47
- Boolean(context.path?.startsWith("/callback/")),
47
+ Boolean(
48
+ context.path?.startsWith("/callback/") || context.path?.startsWith("/oauth2/callback/")
49
+ ),
48
50
  },
49
51
  ],
50
52
  },
@@ -335,8 +337,12 @@ describe("oauthHandoff on a listed web origin", () => {
335
337
  .get(`/api/auth/callback/${PROVIDER_ID}?error=access_denied&state=${state}`)
336
338
  .set("cookie", cookie);
337
339
 
340
+ // better-auth 1.6 sends a generic-OAuth provider error to its own error page before it reads
341
+ // errorCallbackURL from state (1.7 honors it); either way the redirect carries no token.
338
342
  expect(callback.status).toBe(302);
339
- expect(callback.headers.location).toStartWith(`${WEB_ORIGIN}/error?error=access_denied`);
343
+ expect(callback.headers.location).toContain(
344
+ "https://web.example.com/error?error=access_denied"
345
+ );
340
346
  expect(callback.headers.location).not.toContain("ott=");
341
347
  });
342
348
 
@@ -610,7 +616,7 @@ describe("GET /oauth-handoff/start", () => {
610
616
  expect(verified.headers["set-auth-token"]).toBeTruthy();
611
617
  });
612
618
 
613
- it("sends a failed sign-in to a listed errorCallbackURL without a token", async () => {
619
+ it("sends a failed generic-OAuth sign-in to an error page without a token", async () => {
614
620
  const {app} = buildApp();
615
621
  const started = await start(app, {
616
622
  callbackURL: `${WEB_ORIGIN}/after`,
@@ -623,9 +629,11 @@ describe("GET /oauth-handoff/start", () => {
623
629
  .get(`/api/auth/callback/${PROVIDER_ID}?error=access_denied&state=${state}`)
624
630
  .set("cookie", cookieHeaderFrom(started));
625
631
 
632
+ // better-auth 1.7 honors errorCallbackURL for a generic-OAuth provider error; the redirect
633
+ // still carries no token.
626
634
  expect(returned.status).toBe(302);
627
- expect(returned.headers.location).toStartWith(
628
- `${WEB_ORIGIN}/sign-in-error?error=access_denied`
635
+ expect(returned.headers.location).toContain(
636
+ "https://web.example.com/sign-in-error?error=access_denied"
629
637
  );
630
638
  expect(returned.headers.location).not.toContain("ott=");
631
639
  });
@@ -4,7 +4,7 @@ import {assert} from "chai";
4
4
  import express, {type Request, type Response} from "express";
5
5
  import {DateTime} from "luxon";
6
6
  import {MongoMemoryServer} from "mongodb-memory-server";
7
- import mongoose, {Schema} from "mongoose";
7
+ import mongoose, {type Model, Schema} from "mongoose";
8
8
  import passportLocalMongoose from "passport-local-mongoose";
9
9
  import supertest from "supertest";
10
10
  import type {UserModel} from "./auth";
@@ -31,6 +31,11 @@ import {
31
31
  type SessionRequest = Request & {betterAuthSession?: BetterAuthSessionData};
32
32
  const makeReq = (overrides: Partial<SessionRequest> = {}): SessionRequest =>
33
33
  ({headers: {}, ...overrides}) as SessionRequest;
34
+ /** Session doubles carry only the fields the middleware reads. */
35
+ const asSessionData = (data: {
36
+ session: Partial<BetterAuthSessionData["session"]>;
37
+ user: Partial<BetterAuthUser>;
38
+ }): BetterAuthSessionData => data as BetterAuthSessionData;
34
39
  const makeRes = (): Response => ({}) as Response;
35
40
  const setGetSession = (auth: BetterAuthInstance, getSession: () => unknown): void => {
36
41
  (auth.api as unknown as {getSession: () => unknown}).getSession = getSession;
@@ -39,12 +44,29 @@ const setGetSession = (auth: BetterAuthInstance, getSession: () => unknown): voi
39
44
  // Use a separate connection to avoid conflict with bunSetup.ts preload
40
45
  let conn: mongoose.Connection;
41
46
  let mongod: MongoMemoryServer;
42
- let TestUser: UserModel;
43
- let StrictUser: UserModel;
44
- let DualAuthUser: UserModel;
47
+ /** Union of the fields the Better Auth test user schemas below declare. */
48
+ interface BetterAuthTestUser {
49
+ admin: boolean;
50
+ betterAuthId?: string;
51
+ disabled?: boolean;
52
+ email: string;
53
+ emailVerified?: boolean;
54
+ name?: string;
55
+ oauthProvider?: string;
56
+ tokenEpoch?: number;
57
+ }
58
+
59
+ type BetterAuthTestUserModel = Model<BetterAuthTestUser>;
60
+
61
+ let TestUser: BetterAuthTestUserModel;
62
+ let StrictUser: BetterAuthTestUserModel;
63
+ let DualAuthUser: BetterAuthTestUserModel;
64
+
65
+ /** The Better Auth helpers take the app `UserModel`; these test schemas stand in for it. */
66
+ const asUserModel = (model: BetterAuthTestUserModel): UserModel => model as unknown as UserModel;
45
67
 
46
68
  // Simple user schema for testing
47
- const testUserSchema = new Schema({
69
+ const testUserSchema = new Schema<BetterAuthTestUser>({
48
70
  admin: {default: false, type: Boolean},
49
71
  betterAuthId: {type: String},
50
72
  disabled: {default: false, type: Boolean},
@@ -53,7 +75,7 @@ const testUserSchema = new Schema({
53
75
  oauthProvider: {type: String},
54
76
  });
55
77
 
56
- const dualAuthUserSchema = new Schema({
78
+ const dualAuthUserSchema = new Schema<BetterAuthTestUser>({
57
79
  admin: {default: false, type: Boolean},
58
80
  betterAuthId: {type: String},
59
81
  email: {required: true, type: String},
@@ -69,7 +91,7 @@ dualAuthUserSchema.plugin(
69
91
  }
70
92
  );
71
93
 
72
- const strictUserSchema = new Schema(
94
+ const strictUserSchema = new Schema<BetterAuthTestUser>(
73
95
  {
74
96
  admin: {default: false, type: Boolean},
75
97
  betterAuthId: {type: String},
@@ -84,9 +106,9 @@ const setup = (async () => {
84
106
  mongod = await MongoMemoryServer.create();
85
107
  conn = mongoose.createConnection(mongod.getUri());
86
108
  await conn.asPromise();
87
- TestUser = conn.model("BetterAuthTestUser", testUserSchema) as UserModel;
88
- StrictUser = conn.model("BetterAuthStrictUser", strictUserSchema) as UserModel;
89
- DualAuthUser = conn.model("BetterAuthDualUser", dualAuthUserSchema) as UserModel;
109
+ TestUser = conn.model<BetterAuthTestUser>("BetterAuthTestUser", testUserSchema);
110
+ StrictUser = conn.model<BetterAuthTestUser>("BetterAuthStrictUser", strictUserSchema);
111
+ DualAuthUser = conn.model<BetterAuthTestUser>("BetterAuthDualUser", dualAuthUserSchema);
90
112
  })();
91
113
 
92
114
  // Helper to get the mongo client from our separate connection
@@ -282,7 +304,7 @@ describe("createBetterAuth", () => {
282
304
  const auth = createBetterAuth({
283
305
  config,
284
306
  mongoClient: getClient(),
285
- userModel: DualAuthUser,
307
+ userModel: asUserModel(DualAuthUser),
286
308
  });
287
309
  const options = (
288
310
  auth as {
@@ -442,7 +464,7 @@ describe("applyBetterAuthPasswordResetToJwt", () => {
442
464
  method: "POST",
443
465
  });
444
466
  await applyBetterAuthPasswordResetToJwt(
445
- DualAuthUser,
467
+ asUserModel(DualAuthUser),
446
468
  {email: "dual-jwt@example.com", id: "ba-dual-1"},
447
469
  request
448
470
  );
@@ -464,7 +486,7 @@ describe("applyBetterAuthPasswordResetToJwt", () => {
464
486
  method: "POST",
465
487
  });
466
488
  await applyBetterAuthPasswordResetToJwt(
467
- DualAuthUser,
489
+ asUserModel(DualAuthUser),
468
490
  {email: "social-only@example.com", id: "ba-social-only"},
469
491
  request
470
492
  );
@@ -482,7 +504,7 @@ describe("applyBetterAuthPasswordResetToJwt", () => {
482
504
  method: "POST",
483
505
  });
484
506
  await applyBetterAuthPasswordResetToJwt(
485
- DualAuthUser,
507
+ asUserModel(DualAuthUser),
486
508
  {email: "missing-jwt@example.com", id: "ba-missing"},
487
509
  request
488
510
  );
@@ -507,7 +529,7 @@ describe("applyBetterAuthPasswordResetToJwt", () => {
507
529
  });
508
530
  await expect(
509
531
  applyBetterAuthPasswordResetToJwt(
510
- DualAuthUser,
532
+ asUserModel(DualAuthUser),
511
533
  {email: "nopw-jwt@example.com", id: "ba-dual-nopw"},
512
534
  request
513
535
  )
@@ -640,7 +662,7 @@ describe("createBetterAuth email and password-reset wiring", () => {
640
662
  const auth = createBetterAuth({
641
663
  config: baseConfig,
642
664
  mongoClient: getClient(),
643
- userModel: DualAuthUser,
665
+ userModel: asUserModel(DualAuthUser),
644
666
  });
645
667
  const registerable = DualAuthUser as unknown as {
646
668
  register: (user: {betterAuthId: string; email: string}, password: string) => Promise<unknown>;
@@ -773,9 +795,10 @@ describe("applyJwtPasswordResetToBetterAuth lookups", () => {
773
795
  const auth = makeAuth();
774
796
  const ctx = (await auth.$context) as {
775
797
  internalAdapter: {
776
- createUser: (user: {email: string; emailVerified: boolean; name: string}) => Promise<{
777
- id: string;
778
- }>;
798
+ createUser: (
799
+ user: {email: string; emailVerified: boolean; name: string},
800
+ source?: unknown
801
+ ) => Promise<{id: string}>;
779
802
  findAccounts: (userId: string) => Promise<Array<{providerId?: string}>>;
780
803
  };
781
804
  };
@@ -809,7 +832,7 @@ describe("syncBetterAuthUser", () => {
809
832
  it("creates a new user when none exists", async () => {
810
833
  await setup;
811
834
  const baUser = makeBetterAuthUser();
812
- const result = await syncBetterAuthUser(TestUser, baUser);
835
+ const result = await syncBetterAuthUser(asUserModel(TestUser), baUser);
813
836
 
814
837
  expect(result).toBeDefined();
815
838
  expect(result.email).toBe("test@example.com");
@@ -821,7 +844,7 @@ describe("syncBetterAuthUser", () => {
821
844
  it("creates a user on a strict-throw schema that omits oauthProvider", async () => {
822
845
  await setup;
823
846
  const baUser = makeBetterAuthUser({email: "strict@example.com"});
824
- const result = await syncBetterAuthUser(StrictUser, baUser);
847
+ const result = await syncBetterAuthUser(asUserModel(StrictUser), baUser);
825
848
 
826
849
  assert.equal(result.email, "strict@example.com");
827
850
  assert.equal(result.betterAuthId, "ba-user-123");
@@ -833,11 +856,11 @@ describe("syncBetterAuthUser", () => {
833
856
  it("sets oauthProvider on create when a provider is passed", async () => {
834
857
  await setup;
835
858
  const baUser = makeBetterAuthUser({email: "oauth-create@example.com"});
836
- const result = await syncBetterAuthUser(TestUser, baUser, "google");
859
+ const result = await syncBetterAuthUser(asUserModel(TestUser), baUser, "google");
837
860
 
838
861
  assert.equal(result.oauthProvider, "google");
839
862
  const saved = await TestUser.findOne({email: "oauth-create@example.com"}).lean();
840
- assert.equal(saved.oauthProvider, "google");
863
+ assert.equal(saved?.oauthProvider, "google");
841
864
  });
842
865
 
843
866
  it("updates an existing user matched by betterAuthId", async () => {
@@ -849,7 +872,7 @@ describe("syncBetterAuthUser", () => {
849
872
  });
850
873
 
851
874
  const baUser = makeBetterAuthUser({email: "new@example.com", name: "New Name"});
852
- const result = await syncBetterAuthUser(TestUser, baUser);
875
+ const result = await syncBetterAuthUser(asUserModel(TestUser), baUser);
853
876
 
854
877
  expect(result.email).toBe("new@example.com");
855
878
  expect(result.name).toBe("New Name");
@@ -867,7 +890,7 @@ describe("syncBetterAuthUser", () => {
867
890
  });
868
891
 
869
892
  const baUser = makeBetterAuthUser();
870
- const result = await syncBetterAuthUser(TestUser, baUser);
893
+ const result = await syncBetterAuthUser(asUserModel(TestUser), baUser);
871
894
 
872
895
  expect(result.betterAuthId).toBe("ba-user-123");
873
896
  expect(result.email).toBe("test@example.com");
@@ -884,7 +907,7 @@ describe("syncBetterAuthUser", () => {
884
907
  });
885
908
 
886
909
  const baUser = makeBetterAuthUser();
887
- const result = await syncBetterAuthUser(TestUser, baUser, "google");
910
+ const result = await syncBetterAuthUser(asUserModel(TestUser), baUser, "google");
888
911
 
889
912
  expect(result.oauthProvider).toBe("google");
890
913
  });
@@ -892,7 +915,7 @@ describe("syncBetterAuthUser", () => {
892
915
  it("uses email prefix as name when name is null", async () => {
893
916
  await setup;
894
917
  const baUser = makeBetterAuthUser({name: null});
895
- const result = await syncBetterAuthUser(TestUser, baUser);
918
+ const result = await syncBetterAuthUser(asUserModel(TestUser), baUser);
896
919
 
897
920
  expect(result.name).toBe("test");
898
921
  });
@@ -906,7 +929,7 @@ describe("syncBetterAuthUser", () => {
906
929
  });
907
930
 
908
931
  const baUser = makeBetterAuthUser({name: null});
909
- const result = await syncBetterAuthUser(TestUser, baUser);
932
+ const result = await syncBetterAuthUser(asUserModel(TestUser), baUser);
910
933
 
911
934
  expect(result.name).toBe("Keep This Name");
912
935
  });
@@ -916,7 +939,7 @@ describe("syncBetterAuthUser", () => {
916
939
  await TestUser.create({admin: true, email: "test@example.com", name: "Existing Admin"});
917
940
 
918
941
  const baUser = makeBetterAuthUser({emailVerified: false});
919
- await expect(syncBetterAuthUser(TestUser, baUser)).rejects.toThrow(
942
+ await expect(syncBetterAuthUser(asUserModel(TestUser), baUser)).rejects.toThrow(
920
943
  "Verify your email to use this account"
921
944
  );
922
945
 
@@ -929,7 +952,7 @@ describe("syncBetterAuthUser", () => {
929
952
  await setup;
930
953
  await TestUser.create({betterAuthId: "ba-other", email: "test@example.com"});
931
954
 
932
- await expect(syncBetterAuthUser(TestUser, makeBetterAuthUser())).rejects.toThrow(
955
+ await expect(syncBetterAuthUser(asUserModel(TestUser), makeBetterAuthUser())).rejects.toThrow(
933
956
  "An account with this email already exists"
934
957
  );
935
958
 
@@ -942,7 +965,7 @@ describe("syncBetterAuthUser", () => {
942
965
  await TestUser.create({betterAuthId: "ba-other", email: "test@example.com"});
943
966
 
944
967
  const result = await syncBetterAuthUser(
945
- TestUser,
968
+ asUserModel(TestUser),
946
969
  makeBetterAuthUser({emailVerified: false}),
947
970
  undefined,
948
971
  {trustEmail: true}
@@ -958,7 +981,7 @@ describe("syncBetterAuthUser", () => {
958
981
  };
959
982
  await registrable.register({email: "test@example.com", name: "Legacy"}, "legacy-pass-123");
960
983
 
961
- const result = await syncBetterAuthUser(DualAuthUser, makeBetterAuthUser());
984
+ const result = await syncBetterAuthUser(asUserModel(DualAuthUser), makeBetterAuthUser());
962
985
  assert.equal(result.betterAuthId, "ba-user-123");
963
986
 
964
987
  const saved = await DualAuthUser.findOne({email: "test@example.com"})
@@ -979,7 +1002,7 @@ describe("syncBetterAuthUser", () => {
979
1002
  "legacy-pass-123"
980
1003
  );
981
1004
 
982
- await syncBetterAuthUser(DualAuthUser, makeBetterAuthUser());
1005
+ await syncBetterAuthUser(asUserModel(DualAuthUser), makeBetterAuthUser());
983
1006
 
984
1007
  const saved = await DualAuthUser.findOne({email: "test@example.com"})
985
1008
  .select("+hash +salt")
@@ -1062,14 +1085,14 @@ describe("createBetterAuthSessionMiddleware", () => {
1062
1085
 
1063
1086
  const auth = createBetterAuth({config, mongoClient: getClient()});
1064
1087
 
1065
- const mockSession = {
1088
+ const mockSession = asSessionData({
1066
1089
  session: {id: "session-1", userId: "user-1"},
1067
1090
  user: {
1068
1091
  email: "user@example.com",
1069
1092
  id: "user-1",
1070
1093
  name: "Test User",
1071
1094
  },
1072
- };
1095
+ });
1073
1096
 
1074
1097
  // Override getSession to return mock session
1075
1098
  setGetSession(auth, async () => mockSession);
@@ -1083,9 +1106,9 @@ describe("createBetterAuthSessionMiddleware", () => {
1083
1106
 
1084
1107
  expect(next).toHaveBeenCalledTimes(1);
1085
1108
  expect(req.user).toBeDefined();
1086
- expect(req.user.email).toBe("user@example.com");
1087
- expect(req.user.betterAuthId).toBe("user-1");
1088
- expect(req.user.admin).toBe(false);
1109
+ expect(req.user?.email).toBe("user@example.com");
1110
+ expect(req.user?.betterAuthId).toBe("user-1");
1111
+ expect(req.user?.admin).toBe(false);
1089
1112
  expect(req.betterAuthSession).toBe(mockSession);
1090
1113
  });
1091
1114
 
@@ -1106,18 +1129,18 @@ describe("createBetterAuthSessionMiddleware", () => {
1106
1129
 
1107
1130
  const auth = createBetterAuth({config, mongoClient: getClient()});
1108
1131
 
1109
- const mockSession = {
1132
+ const mockSession = asSessionData({
1110
1133
  session: {id: "session-1", userId: "user-1"},
1111
1134
  user: {
1112
1135
  email: "user@example.com",
1113
1136
  id: "user-1",
1114
1137
  name: "Test User",
1115
1138
  },
1116
- };
1139
+ });
1117
1140
 
1118
1141
  setGetSession(auth, async () => mockSession);
1119
1142
 
1120
- const middleware = createBetterAuthSessionMiddleware(auth, TestUser);
1143
+ const middleware = createBetterAuthSessionMiddleware(auth, asUserModel(TestUser));
1121
1144
  const req = makeReq();
1122
1145
  const res = makeRes();
1123
1146
  const next = mock(() => {});
@@ -1126,7 +1149,7 @@ describe("createBetterAuthSessionMiddleware", () => {
1126
1149
 
1127
1150
  expect(next).toHaveBeenCalledTimes(1);
1128
1151
  expect(req.user).toBeDefined();
1129
- expect(req.user._id.toString()).toBe(appUser._id.toString());
1152
+ expect(req.user?._id.toString()).toBe(appUser._id.toString());
1130
1153
  expect(req.betterAuthSession).toBe(mockSession);
1131
1154
  });
1132
1155
 
@@ -1151,7 +1174,7 @@ describe("createBetterAuthSessionMiddleware", () => {
1151
1174
 
1152
1175
  setGetSession(auth, async () => mockSession);
1153
1176
 
1154
- const middleware = createBetterAuthSessionMiddleware(auth, TestUser);
1177
+ const middleware = createBetterAuthSessionMiddleware(auth, asUserModel(TestUser));
1155
1178
  const req = makeReq();
1156
1179
  const res = makeRes();
1157
1180
  const next = mock(() => {});
@@ -1160,8 +1183,8 @@ describe("createBetterAuthSessionMiddleware", () => {
1160
1183
 
1161
1184
  expect(next).toHaveBeenCalledTimes(1);
1162
1185
  expect(req.user).toBeDefined();
1163
- expect(req.user.betterAuthId).toBe("new-user-1");
1164
- expect(req.user.email).toBe("newuser@example.com");
1186
+ expect(req.user?.betterAuthId).toBe("new-user-1");
1187
+ expect(req.user?.email).toBe("newuser@example.com");
1165
1188
 
1166
1189
  // Verify user was persisted
1167
1190
  const count = await TestUser.countDocuments();
@@ -1256,14 +1279,15 @@ describe("resolveBetterAuthAppUser", () => {
1256
1279
  email: "first-contact@example.com",
1257
1280
  emailVerified: false,
1258
1281
  id: new mongoose.Types.ObjectId().toString(),
1282
+ image: null,
1259
1283
  name: "First Contact",
1260
1284
  updatedAt: new Date(),
1261
1285
  };
1262
1286
 
1263
1287
  const results = await Promise.all([
1264
- resolveBetterAuthAppUser({betterAuthUser, userModel: TestUser}),
1265
- resolveBetterAuthAppUser({betterAuthUser, userModel: TestUser}),
1266
- resolveBetterAuthAppUser({betterAuthUser, userModel: TestUser}),
1288
+ resolveBetterAuthAppUser({betterAuthUser, userModel: asUserModel(TestUser)}),
1289
+ resolveBetterAuthAppUser({betterAuthUser, userModel: asUserModel(TestUser)}),
1290
+ resolveBetterAuthAppUser({betterAuthUser, userModel: asUserModel(TestUser)}),
1267
1291
  ]);
1268
1292
 
1269
1293
  expect(new Set(results.map((result) => String(result.user.id))).size).toBe(1);
@@ -1275,6 +1299,7 @@ describe("resolveBetterAuthAppUser", () => {
1275
1299
  // between this lookup and this insert.
1276
1300
  let insertedByOtherRequest: Record<string, unknown> | null = null;
1277
1301
  class RacingUser {
1302
+ [key: string]: unknown;
1278
1303
  constructor(doc: Record<string, unknown>) {
1279
1304
  Object.assign(this, doc);
1280
1305
  }
@@ -1295,6 +1320,7 @@ describe("resolveBetterAuthAppUser", () => {
1295
1320
  email: "raced@example.com",
1296
1321
  emailVerified: false,
1297
1322
  id: "ba-raced",
1323
+ image: null,
1298
1324
  name: "Raced",
1299
1325
  updatedAt: new Date(),
1300
1326
  },
@@ -1330,7 +1356,7 @@ describe("createBetterAuthSessionMiddleware with disabled users", () => {
1330
1356
  // then a route that requires an authenticated user.
1331
1357
  const buildApp = (auth: BetterAuthInstance): express.Application => {
1332
1358
  const app = express();
1333
- app.use(createBetterAuthSessionMiddleware(auth, TestUser));
1359
+ app.use(createBetterAuthSessionMiddleware(auth, asUserModel(TestUser)));
1334
1360
  mountBetterAuthRoutes(app, auth);
1335
1361
  app.get("/protected", (req, res) => {
1336
1362
  if (!req.user) {
@@ -1400,7 +1426,7 @@ describe("createBetterAuthSessionMiddleware with an existing app user's email",
1400
1426
  assert.isFalse(created.user.emailVerified);
1401
1427
 
1402
1428
  const app = express();
1403
- app.use(createBetterAuthSessionMiddleware(auth, TestUser));
1429
+ app.use(createBetterAuthSessionMiddleware(auth, asUserModel(TestUser)));
1404
1430
  app.get("/protected", (req, res) => {
1405
1431
  if (!req.user) {
1406
1432
  return res.status(401).json({status: 401, title: "Unauthorized"});
@@ -1559,6 +1585,6 @@ describe("setupBetterAuthUserSync", () => {
1559
1585
 
1560
1586
  const auth = createBetterAuth({config, mongoClient: getClient()});
1561
1587
 
1562
- expect(() => setupBetterAuthUserSync(auth, TestUser)).not.toThrow();
1588
+ expect(() => setupBetterAuthUserSync(auth, asUserModel(TestUser))).not.toThrow();
1563
1589
  });
1564
1590
  });