@terreno/api 57.0.0 → 57.2.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 (175) hide show
  1. package/.ai/skills/mongoose-schema-safety/SKILL.md +8 -0
  2. package/dist/actions.d.ts +7 -2
  3. package/dist/actions.js +60 -25
  4. package/dist/adminModelRouter.d.ts +14 -0
  5. package/dist/adminModelRouter.js +199 -0
  6. package/dist/adminTypes.d.ts +182 -0
  7. package/dist/adminTypes.js +5 -0
  8. package/dist/api.d.ts +44 -3
  9. package/dist/api.js +74 -26
  10. package/dist/auth.d.ts +18 -1
  11. package/dist/auth.js +122 -20
  12. package/dist/consentApp.d.ts +2 -0
  13. package/dist/consentApp.js +98 -0
  14. package/dist/index.d.ts +22 -1
  15. package/dist/index.js +51 -7
  16. package/dist/mcp/auth.d.ts +11 -0
  17. package/dist/mcp/auth.js +133 -0
  18. package/dist/mcp/createMCPRequest.d.ts +16 -0
  19. package/dist/mcp/createMCPRequest.js +26 -0
  20. package/dist/mcp/handlers.d.ts +8 -0
  21. package/dist/mcp/handlers.js +793 -0
  22. package/dist/mcp/query.d.ts +32 -0
  23. package/dist/mcp/query.js +232 -0
  24. package/dist/mcp/registry.d.ts +21 -0
  25. package/dist/mcp/registry.js +54 -0
  26. package/dist/mcp/schemaGenerator.d.ts +14 -0
  27. package/dist/mcp/schemaGenerator.js +379 -0
  28. package/dist/mcp/server.d.ts +8 -0
  29. package/dist/mcp/server.js +133 -0
  30. package/dist/mcp/toolGenerator.d.ts +14 -0
  31. package/dist/mcp/toolGenerator.js +246 -0
  32. package/dist/mcp/types.d.ts +85 -0
  33. package/dist/mcp/types.js +2 -0
  34. package/dist/openApi.d.ts +1 -1
  35. package/dist/openApi.js +26 -8
  36. package/dist/permissions.js +15 -15
  37. package/dist/rbac/access.d.ts +3 -0
  38. package/dist/rbac/access.js +294 -0
  39. package/dist/rbac/auditModel.d.ts +31 -0
  40. package/dist/rbac/auditModel.js +112 -0
  41. package/dist/rbac/backfillAdmins.d.ts +18 -0
  42. package/dist/rbac/backfillAdmins.js +139 -0
  43. package/dist/rbac/fieldViews.d.ts +3 -0
  44. package/dist/rbac/fieldViews.js +201 -0
  45. package/dist/rbac/middleware.d.ts +21 -0
  46. package/dist/rbac/middleware.js +108 -0
  47. package/dist/rbac/modelRouterAccess.d.ts +42 -0
  48. package/dist/rbac/modelRouterAccess.js +388 -0
  49. package/dist/rbac/permissionUtils.d.ts +8 -0
  50. package/dist/rbac/permissionUtils.js +209 -0
  51. package/dist/rbac/realtimeAccess.d.ts +18 -0
  52. package/dist/rbac/realtimeAccess.js +173 -0
  53. package/dist/rbac/resolve.d.ts +28 -0
  54. package/dist/rbac/resolve.js +387 -0
  55. package/dist/rbac/roleManager.d.ts +20 -0
  56. package/dist/rbac/roleManager.js +741 -0
  57. package/dist/rbac/roleModel.d.ts +42 -0
  58. package/dist/rbac/roleModel.js +267 -0
  59. package/dist/rbac/routes.d.ts +9 -0
  60. package/dist/rbac/routes.js +211 -0
  61. package/dist/rbac/scopes.d.ts +15 -0
  62. package/dist/rbac/scopes.js +155 -0
  63. package/dist/rbac/statements.d.ts +30 -0
  64. package/dist/rbac/statements.js +126 -0
  65. package/dist/rbac/types.d.ts +202 -0
  66. package/dist/rbac/types.js +2 -0
  67. package/dist/rbac/userPlugin.d.ts +12 -0
  68. package/dist/rbac/userPlugin.js +41 -0
  69. package/dist/realtime/changeStreamWatcher.d.ts +1 -1
  70. package/dist/realtime/changeStreamWatcher.js +48 -39
  71. package/dist/realtime/realtimeApp.js +4 -8
  72. package/dist/realtime/registry.d.ts +5 -0
  73. package/dist/realtime/registry.js +13 -1
  74. package/dist/scrubAdminFields.d.ts +17 -0
  75. package/dist/scrubAdminFields.js +192 -0
  76. package/dist/sync/executors.d.ts +1 -1
  77. package/dist/sync/executors.js +63 -40
  78. package/dist/sync/loadHarness.js +4 -5
  79. package/dist/sync/registry.d.ts +5 -0
  80. package/dist/sync/registry.js +13 -1
  81. package/dist/sync/routes.js +41 -36
  82. package/dist/sync/serialize.js +5 -6
  83. package/dist/terrenoApp.d.ts +18 -0
  84. package/dist/terrenoApp.js +46 -3
  85. package/dist/terrenoPlugin.d.ts +8 -1
  86. package/dist/tests/createTestData.js +8 -0
  87. package/dist/tests/models.d.ts +1 -0
  88. package/dist/tests/models.js +5 -0
  89. package/dist/tests/testHelper.js +1 -2
  90. package/dist/transformers.js +16 -1
  91. package/package.json +17 -13
  92. package/src/__snapshots__/openApi.test.ts.snap +192 -0
  93. package/src/actions.test.ts +194 -1
  94. package/src/actions.ts +65 -8
  95. package/src/adminModelRouter.ts +154 -0
  96. package/src/adminTypes.ts +206 -0
  97. package/src/api.test.ts +66 -1
  98. package/src/api.ts +131 -12
  99. package/src/auth.test.ts +135 -1
  100. package/src/auth.ts +81 -3
  101. package/src/consentApp.test.ts +24 -0
  102. package/src/consentApp.ts +100 -0
  103. package/src/index.ts +56 -0
  104. package/src/mcp/auth.test.ts +197 -0
  105. package/src/mcp/auth.ts +100 -0
  106. package/src/mcp/createMCPRequest.test.ts +47 -0
  107. package/src/mcp/createMCPRequest.ts +32 -0
  108. package/src/mcp/customTools.test.ts +54 -0
  109. package/src/mcp/handlers.ts +639 -0
  110. package/src/mcp/integration.test.ts +1493 -0
  111. package/src/mcp/query.test.ts +172 -0
  112. package/src/mcp/query.ts +179 -0
  113. package/src/mcp/registry.ts +70 -0
  114. package/src/mcp/schemaGenerator.test.ts +182 -0
  115. package/src/mcp/schemaGenerator.ts +354 -0
  116. package/src/mcp/server.test.ts +226 -0
  117. package/src/mcp/server.ts +86 -0
  118. package/src/mcp/toolGenerator.test.ts +284 -0
  119. package/src/mcp/toolGenerator.ts +199 -0
  120. package/src/mcp/types.ts +95 -0
  121. package/src/openApi.test.ts +107 -0
  122. package/src/openApi.ts +32 -1
  123. package/src/permissions.ts +3 -2
  124. package/src/rbac/access.test.ts +357 -0
  125. package/src/rbac/access.ts +201 -0
  126. package/src/rbac/auditModel.ts +103 -0
  127. package/src/rbac/backfillAdmins.ts +54 -0
  128. package/src/rbac/fieldViews.test.ts +39 -0
  129. package/src/rbac/fieldViews.ts +122 -0
  130. package/src/rbac/middleware.ts +55 -0
  131. package/src/rbac/modelRouterAccess.test.ts +336 -0
  132. package/src/rbac/modelRouterAccess.ts +331 -0
  133. package/src/rbac/permissionUtils.test.ts +112 -0
  134. package/src/rbac/permissionUtils.ts +83 -0
  135. package/src/rbac/realtimeAccess.test.ts +242 -0
  136. package/src/rbac/realtimeAccess.ts +138 -0
  137. package/src/rbac/resolve.test.ts +358 -0
  138. package/src/rbac/resolve.ts +285 -0
  139. package/src/rbac/roleManager.test.ts +915 -0
  140. package/src/rbac/roleManager.ts +440 -0
  141. package/src/rbac/roleModel.test.ts +114 -0
  142. package/src/rbac/roleModel.ts +196 -0
  143. package/src/rbac/routes.ts +170 -0
  144. package/src/rbac/scopes.test.ts +105 -0
  145. package/src/rbac/scopes.ts +81 -0
  146. package/src/rbac/statements.test.ts +67 -0
  147. package/src/rbac/statements.ts +73 -0
  148. package/src/rbac/types.ts +198 -0
  149. package/src/rbac/userPlugin.test.ts +55 -0
  150. package/src/rbac/userPlugin.ts +25 -0
  151. package/src/realtime/changeStreamWatcher.ts +20 -15
  152. package/src/realtime/realtime.test.ts +25 -1
  153. package/src/realtime/realtimeApp.ts +2 -5
  154. package/src/realtime/registry.ts +15 -0
  155. package/src/scrubAdminFields.test.ts +113 -0
  156. package/src/scrubAdminFields.ts +158 -0
  157. package/src/sync/executors.ts +31 -1
  158. package/src/sync/loadHarness.ts +8 -7
  159. package/src/sync/models.test.ts +262 -0
  160. package/src/sync/registry.ts +15 -0
  161. package/src/sync/routes.ts +25 -11
  162. package/src/sync/scripts/compactTombstones.test.ts +4 -6
  163. package/src/sync/serialize.ts +17 -9
  164. package/src/sync/sync.test.ts +52 -0
  165. package/src/sync/syncRoutes.test.ts +5 -2
  166. package/src/sync/syncSocket.test.ts +28 -0
  167. package/src/terrenoApp.test.ts +100 -0
  168. package/src/terrenoApp.ts +65 -3
  169. package/src/terrenoPlugin.ts +10 -1
  170. package/src/tests/bunSetup.ts +2 -0
  171. package/src/tests/createTestData.ts +5 -1
  172. package/src/tests/models.ts +6 -0
  173. package/src/tests/testHelper.ts +1 -3
  174. package/src/transformers.test.ts +12 -0
  175. package/src/transformers.ts +7 -1
package/src/api.ts CHANGED
@@ -15,7 +15,9 @@ import {
15
15
  type InstanceActionConfig,
16
16
  registerActionRoutes,
17
17
  } from "./actions";
18
- import {authenticateMiddleware, type User} from "./auth";
18
+ import {enrichModelRouterOptions, type ModelRouterBuildContext} from "./adminModelRouter";
19
+ import type {AdminConfig} from "./adminTypes";
20
+ import {authenticateMiddleware, omitUserRolesFromWriteBody, type User} from "./auth";
19
21
  import {
20
22
  APIError,
21
23
  apiErrorMiddleware,
@@ -27,6 +29,8 @@ import {
27
29
  passthroughOrWrapWrite,
28
30
  } from "./errors";
29
31
  import {logger} from "./logger";
32
+ import {registerMCPModel, updateMCPRegistryOptions} from "./mcp/registry";
33
+ import type {MCPConfig} from "./mcp/types";
30
34
  import {
31
35
  createOpenApiMiddleware,
32
36
  deleteOpenApiMiddleware,
@@ -42,7 +46,9 @@ import {
42
46
  } from "./openApiValidator";
43
47
  import {checkPermissions, permissionMiddleware, type RESTPermissions} from "./permissions";
44
48
  import type {PopulatePath} from "./populate";
45
- import {registerRealtime} from "./realtime/registry";
49
+ import {resolveModelRouterAccess, validateAccessWriteBody} from "./rbac/modelRouterAccess";
50
+ import type {AnyTerrenoAccess, ModelRouterAccessOptions} from "./rbac/types";
51
+ import {registerRealtime, updateRealtimeRegistryOptions} from "./realtime/registry";
46
52
  import type {RealtimeConfig} from "./realtime/types";
47
53
  import {
48
54
  type ExecutorConcurrencyCheck,
@@ -51,7 +57,7 @@ import {
51
57
  executeUpdate,
52
58
  isExecutorConflictError,
53
59
  } from "./sync/executors";
54
- import {registerSync} from "./sync/registry";
60
+ import {registerSync, updateSyncRegistryOptions} from "./sync/registry";
55
61
  import type {SyncConfig} from "./sync/types";
56
62
  import {
57
63
  defaultResponseHandler,
@@ -140,8 +146,17 @@ export interface ModelRouterOptions<T> {
140
146
  * A group of method-level (create/read/update/delete/list) permissions.
141
147
  * Determine if the user can perform the operation at all, and for read/update/delete methods,
142
148
  * whether the user can perform the operation on the object referenced.
149
+ * @deprecated Use `access` with `accessControl` instead. Still required as a type-level
150
+ * fallback; `resolveModelRouterAccess` replaces these methods when `access` is set.
143
151
  * */
144
152
  permissions: RESTPermissions<T>;
153
+ /**
154
+ * RBAC access configuration for this router. Requires `accessControl` on the same options object
155
+ * or injected by TerrenoApp at build time.
156
+ */
157
+ access?: ModelRouterAccessOptions;
158
+ /** TerrenoAccess instance used to evaluate `access` permissions. */
159
+ accessControl?: AnyTerrenoAccess;
145
160
  /**
146
161
  * Allow anonymous users to access the resource.
147
162
  * Defaults to false.
@@ -348,6 +363,25 @@ export interface ModelRouterOptions<T> {
348
363
  * This option overrides the global setting for this specific router.
349
364
  */
350
365
  validation?: boolean | ModelRouterValidationOptions;
366
+ /**
367
+ * MCP (Model Context Protocol) configuration. When provided, registers this model's
368
+ * CRUD operations as MCP tools that can be called by LLMs.
369
+ *
370
+ * Tools are auto-generated based on the methods specified (default: ['list', 'read']).
371
+ * Auth, permissions, population, and filtering all work the same as REST.
372
+ *
373
+ * @example
374
+ * ```typescript
375
+ * modelRouter("/todos", Todo, {
376
+ * mcp: {
377
+ * methods: ['list', 'read', 'create'],
378
+ * excludeFields: ['internalNote'],
379
+ * maxLimit: 25,
380
+ * },
381
+ * });
382
+ * ```
383
+ */
384
+ mcp?: MCPConfig;
351
385
  /**
352
386
  * Enable real-time sync for this model via WebSocket events.
353
387
  * When configured, CRUD operations will emit events to connected clients
@@ -365,6 +399,11 @@ export interface ModelRouterOptions<T> {
365
399
  * Only works with the three-argument form: modelRouter('/path', Model, options).
366
400
  */
367
401
  sync?: SyncConfig;
402
+ /**
403
+ * Optional admin panel metadata for this model. Consumed by {@link AdminApp} when aggregating
404
+ * `/admin/config` and for server-side field scrubbing / realtime change events.
405
+ */
406
+ admin?: AdminConfig;
368
407
  }
369
408
 
370
409
  /**
@@ -574,8 +613,16 @@ export interface ModelRouterRegistration {
574
613
  path: string;
575
614
  /** The Express router containing CRUD endpoints */
576
615
  router: express.Router;
577
- /** @internal Rebuilds the router with the openApi instance injected into options */
578
- _buildWithOpenApi: (openApi: OpenApiMiddleware) => express.Router;
616
+ /** The Mongoose model this router serves */
617
+ // noExplicitAny: registration stores arbitrary document models
618
+ // biome-ignore lint/suspicious/noExplicitAny: registration stores arbitrary document models
619
+ model: ModelLike<any>;
620
+ /** Options passed to modelRouter (includes optional admin config) */
621
+ // noExplicitAny: registration stores arbitrary document models
622
+ // biome-ignore lint/suspicious/noExplicitAny: registration stores arbitrary document models
623
+ options: ModelRouterOptions<any>;
624
+ /** @internal Rebuilds the router with OpenAPI and TerrenoApp context injected */
625
+ _buildWithContext: (context: ModelRouterBuildContext) => express.Router;
579
626
  }
580
627
 
581
628
  /**
@@ -616,10 +663,17 @@ export function modelRouter<T>(
616
663
  options = modelOrOptions as ModelRouterOptions<T>;
617
664
  }
618
665
 
619
- const router = _buildModelRouter(model, options);
666
+ // Register MCP before building so _buildModelRouter can replace options
667
+ // with RBAC-resolved permissions (access+accessControl is not deferred).
668
+ if (options.mcp) {
669
+ registerMCPModel(model, options.mcp, options);
670
+ }
671
+
672
+ const shouldDeferBuild = path !== undefined && Boolean(options.access) && !options.accessControl;
620
673
 
621
674
  if (path !== undefined) {
622
- // Register for real-time sync if configured
675
+ // Register before building so _buildModelRouter can replace options with
676
+ // RBAC-resolved permissions (same contract as MCP).
623
677
  if (options.realtime) {
624
678
  registerRealtime({
625
679
  collectionName: model.collection.collectionName,
@@ -629,14 +683,36 @@ export function modelRouter<T>(
629
683
  routePath: path,
630
684
  });
631
685
  }
632
- // Register for local-first sync if configured (validates the schema contract)
633
686
  if (options.sync) {
634
687
  registerSync({config: options.sync, model, options, routePath: path});
635
688
  }
689
+ }
690
+
691
+ const router = shouldDeferBuild ? express.Router() : _buildModelRouter(model, options, path);
692
+
693
+ if (path !== undefined) {
636
694
  return {
637
695
  __type: "modelRouter",
638
- _buildWithOpenApi: (openApi: OpenApiMiddleware) =>
639
- _buildModelRouter(model, {...options, openApi}),
696
+ _buildWithContext: (context: ModelRouterBuildContext) => {
697
+ const enrichedOptions = enrichModelRouterOptions(
698
+ model,
699
+ {...options, openApi: context.openApi},
700
+ context
701
+ );
702
+ const runtimeOptions = {
703
+ ...enrichedOptions,
704
+ accessControl: enrichedOptions.accessControl ?? context.accessControl,
705
+ };
706
+ if (options.realtime) {
707
+ updateRealtimeRegistryOptions(
708
+ path,
709
+ runtimeOptions as unknown as ModelRouterOptions<unknown>
710
+ );
711
+ }
712
+ return _buildModelRouter(model, runtimeOptions, path);
713
+ },
714
+ model,
715
+ options,
640
716
  path,
641
717
  router,
642
718
  };
@@ -660,9 +736,33 @@ export function modelRouter<T>(
660
736
 
661
737
  const _buildModelRouter = <T>(
662
738
  model: ModelLike<T>,
663
- options: ModelRouterOptions<T>
739
+ options: ModelRouterOptions<T>,
740
+ routePath?: string
664
741
  ): express.Router => {
665
742
  const router = express.Router();
743
+ const resolvedAccess = resolveModelRouterAccess({
744
+ access: options.access,
745
+ accessControl: options.accessControl,
746
+ permissions: options.permissions,
747
+ queryFilter: options.queryFilter as never,
748
+ responseHandler: options.responseHandler as never,
749
+ scope: options.access?.scope,
750
+ });
751
+ options = {
752
+ ...options,
753
+ permissions: resolvedAccess.permissions,
754
+ queryFilter: (resolvedAccess.queryFilter ??
755
+ options.queryFilter) as ModelRouterOptions<T>["queryFilter"],
756
+ responseHandler: (resolvedAccess.responseHandler ??
757
+ options.responseHandler ??
758
+ defaultResponseHandler) as ModelRouterOptions<T>["responseHandler"],
759
+ };
760
+ if (options.mcp) {
761
+ updateMCPRegistryOptions(model.modelName, options as unknown as ModelRouterOptions<unknown>);
762
+ }
763
+ if (options.sync && routePath) {
764
+ updateSyncRegistryOptions(routePath, options as unknown as ModelRouterOptions<unknown>);
765
+ }
666
766
 
667
767
  assertNoActionCollisions(model, options);
668
768
  registerActionRoutes(router, model, options);
@@ -713,7 +813,7 @@ const _buildModelRouter = <T>(
713
813
  [
714
814
  authenticateMiddleware(options.allowAnonymous),
715
815
  permissionMiddleware(model, options),
716
- listOpenApiMiddleware(model, options),
816
+ listOpenApiMiddleware(model, options, routePath),
717
817
  queryValidation,
718
818
  ],
719
819
  asyncHandler(async (req: Request, res: Response) => {
@@ -1139,6 +1239,24 @@ const _buildModelRouter = <T>(
1139
1239
  }
1140
1240
  }
1141
1241
 
1242
+ body = omitUserRolesFromWriteBody(
1243
+ model.modelName,
1244
+ options.accessControl,
1245
+ body,
1246
+ (req as Request & {terrenoAllowUserAdminWrite?: boolean}).terrenoAllowUserAdminWrite === true
1247
+ ) as typeof body;
1248
+
1249
+ if (options.access && options.accessControl && body && typeof body === "object") {
1250
+ await validateAccessWriteBody({
1251
+ access: options.access,
1252
+ accessControl: options.accessControl,
1253
+ body: body as Record<string, unknown>,
1254
+ doc,
1255
+ phase: "write",
1256
+ user: req.user,
1257
+ });
1258
+ }
1259
+
1142
1260
  // Using .save here runs the risk of a versioning error if you try to make two simultaneous
1143
1261
  // updates. We won't wind up with corrupted data, just an API error.
1144
1262
  try {
@@ -1332,3 +1450,4 @@ export const asyncHandler = (fn: AsyncHandlerFn, options?: AsyncHandlerOptions)
1332
1450
  // For backwards compatibility with the old names.
1333
1451
  export const gooseRestRouter = modelRouter;
1334
1452
  export type GooseRESTOptions<T> = ModelRouterOptions<T>;
1453
+ export type {ModelRouterBuildContext} from "./adminModelRouter";
package/src/auth.test.ts CHANGED
@@ -15,9 +15,12 @@ import {
15
15
  generateTokens,
16
16
  type HasSetPassword,
17
17
  MAX_PASSWORD_LENGTH,
18
+ omitUserRolesFromWriteBody,
19
+ PRIVILEGED_USER_FIELDS,
18
20
  setPasswordForUser,
19
21
  setupAuth,
20
22
  signupUser,
23
+ stripPrivilegedUserFields,
21
24
  } from "./auth";
22
25
  import {logger} from "./logger";
23
26
  import {Permissions} from "./permissions";
@@ -858,7 +861,7 @@ describe("addAuthRoutes /refresh_token error paths", () => {
858
861
  app = new TerrenoApp({
859
862
  configureApp: () => {},
860
863
  skipListen: true,
861
- userModel: UserModel as any,
864
+ userModel: UserModel as unknown as AuthUserModel,
862
865
  }).build();
863
866
  agent = supertest.agent(app);
864
867
  });
@@ -985,6 +988,137 @@ describe("addMeRoutes edge cases", () => {
985
988
  });
986
989
  });
987
990
 
991
+ describe("privileged user fields", () => {
992
+ let app: express.Application;
993
+ let agent: TestAgent;
994
+
995
+ beforeEach(async () => {
996
+ setSystemTime();
997
+ await setupTestData();
998
+ app = new TerrenoApp({
999
+ configureApp: () => {},
1000
+ skipListen: true,
1001
+ userModel: UserModel as any,
1002
+ }).build();
1003
+ agent = supertest.agent(app);
1004
+ });
1005
+
1006
+ afterEach(() => {
1007
+ setSystemTime();
1008
+ });
1009
+
1010
+ it("drops admin, roles, and organizationIds, keeping other fields", () => {
1011
+ const sanitized = stripPrivilegedUserFields(
1012
+ {
1013
+ admin: true,
1014
+ age: 42,
1015
+ name: "Someone",
1016
+ organizationIds: ["other-tenant"],
1017
+ roles: ["superadmin"],
1018
+ },
1019
+ "test"
1020
+ );
1021
+
1022
+ expect(sanitized).toEqual({age: 42, name: "Someone"});
1023
+ });
1024
+
1025
+ it("leaves bodies without privileged fields untouched", () => {
1026
+ expect(stripPrivilegedUserFields({name: "Someone"}, "test")).toEqual({name: "Someone"});
1027
+ });
1028
+
1029
+ it("lists admin, roles, and organizationIds as privileged", () => {
1030
+ expect([...PRIVILEGED_USER_FIELDS]).toEqual(["admin", "roles", "organizationIds"]);
1031
+ });
1032
+
1033
+ it("omits privileged User fields from ordinary RBAC modelRouter writes", () => {
1034
+ expect(
1035
+ omitUserRolesFromWriteBody(
1036
+ "User",
1037
+ {},
1038
+ {
1039
+ admin: true,
1040
+ email: "a@example.com",
1041
+ organizationIds: ["other-tenant"],
1042
+ roles: ["superadmin"],
1043
+ }
1044
+ )
1045
+ ).toEqual({email: "a@example.com"});
1046
+ expect(
1047
+ omitUserRolesFromWriteBody("User", {}, [
1048
+ {admin: true, email: "a@example.com", roles: ["superadmin"]},
1049
+ ])
1050
+ ).toEqual([{email: "a@example.com"}]);
1051
+ expect(
1052
+ omitUserRolesFromWriteBody(
1053
+ "User",
1054
+ {},
1055
+ {admin: true, organizationIds: ["other-tenant"], roles: ["superadmin"]},
1056
+ true
1057
+ )
1058
+ ).toEqual({admin: true});
1059
+ expect(omitUserRolesFromWriteBody("Todo", {}, {admin: true, roles: ["superadmin"]})).toEqual({
1060
+ admin: true,
1061
+ roles: ["superadmin"],
1062
+ });
1063
+ expect(omitUserRolesFromWriteBody("User", undefined, {roles: ["superadmin"]})).toEqual({
1064
+ roles: ["superadmin"],
1065
+ });
1066
+ });
1067
+
1068
+ it("does not let anonymous signup self-assign admin or organizations", async () => {
1069
+ await agent
1070
+ .post("/auth/signup")
1071
+ .send({
1072
+ admin: true,
1073
+ email: "escalate@example.com",
1074
+ organizationIds: ["other-tenant"],
1075
+ password: "Password123!",
1076
+ })
1077
+ .expect(200);
1078
+
1079
+ const created = await UserModel.findOne({email: "escalate@example.com"});
1080
+ expect(created).toBeTruthy();
1081
+ expect((created as unknown as {admin?: boolean})?.admin).toBe(false);
1082
+ expect(
1083
+ (created as unknown as {organizationIds?: string[]})?.organizationIds ?? []
1084
+ ).not.toContain("other-tenant");
1085
+ });
1086
+
1087
+ it("does not let signupUser self-assign roles", async () => {
1088
+ const user = await signupUser(
1089
+ UserModel as unknown as AuthUserModel,
1090
+ "escalate-roles@example.com",
1091
+ "Password123!",
1092
+ {admin: true, roles: ["superadmin"]}
1093
+ );
1094
+
1095
+ expect((user as unknown as {admin?: boolean}).admin).toBe(false);
1096
+ expect((user as unknown as {roles?: string[]}).roles).toBeUndefined();
1097
+ });
1098
+
1099
+ it("does not let PATCH /auth/me escalate to admin or join organizations", async () => {
1100
+ const [_admin, notAdmin] = await setupDb();
1101
+ const jwtLib = (await import("jsonwebtoken")).default;
1102
+ const notAdminId = (notAdmin as unknown as {_id: {toString(): string}})._id;
1103
+ const token = jwtLib.sign({id: notAdminId.toString()}, process.env.TOKEN_SECRET as string, {
1104
+ issuer: process.env.TOKEN_ISSUER,
1105
+ });
1106
+
1107
+ await agent
1108
+ .patch("/auth/me")
1109
+ .set("authorization", `Bearer ${token}`)
1110
+ .send({admin: true, name: "Renamed", organizationIds: ["other-tenant"]})
1111
+ .expect(200);
1112
+
1113
+ const reloaded = await UserModel.findById(notAdminId);
1114
+ expect((reloaded as unknown as {admin?: boolean})?.admin).toBe(false);
1115
+ expect((reloaded as unknown as {name?: string})?.name).toBe("Renamed");
1116
+ expect(
1117
+ (reloaded as unknown as {organizationIds?: string[]})?.organizationIds ?? []
1118
+ ).not.toContain("other-tenant");
1119
+ });
1120
+ });
1121
+
988
1122
  describe("Secret prefix authorization bypass", () => {
989
1123
  let app: express.Application;
990
1124
  let agent: TestAgent;
package/src/auth.ts CHANGED
@@ -100,6 +100,75 @@ export const authenticateMiddleware = (anonymous = false) => {
100
100
  };
101
101
  };
102
102
 
103
+ /**
104
+ * User fields that confer authority. Self-service requests (anonymous signup, `PATCH /me`)
105
+ * must never set them, or any caller could grant themselves admin or an RBAC role. Elevate
106
+ * users through the admin API or `access.roles.assign` instead.
107
+ */
108
+ export const PRIVILEGED_USER_FIELDS = ["admin", "roles", "organizationIds"] as const;
109
+
110
+ /**
111
+ * Removes {@link PRIVILEGED_USER_FIELDS} from a self-service body. Fields are dropped rather
112
+ * than rejected so clients that echo a whole user object back still succeed.
113
+ */
114
+ export const stripPrivilegedUserFields = (
115
+ body: Record<string, unknown>,
116
+ context: string
117
+ ): Record<string, unknown> => {
118
+ const sanitized: Record<string, unknown> = {};
119
+ const dropped: string[] = [];
120
+ for (const [key, value] of Object.entries(body)) {
121
+ if ((PRIVILEGED_USER_FIELDS as readonly string[]).includes(key)) {
122
+ dropped.push(key);
123
+ continue;
124
+ }
125
+ sanitized[key] = value;
126
+ }
127
+ if (dropped.length > 0) {
128
+ logger.warn(`Ignored privileged user fields on ${context}: ${dropped.join(", ")}`);
129
+ }
130
+ return sanitized;
131
+ };
132
+
133
+ const omitPrivilegedFieldsFromObject = (item: unknown, allowAdminWrite: boolean): unknown => {
134
+ if (!item || typeof item !== "object" || Array.isArray(item)) {
135
+ return item;
136
+ }
137
+ const record = item as Record<string, unknown>;
138
+ const fieldsToDrop = PRIVILEGED_USER_FIELDS.filter(
139
+ (field) => field in record && !(field === "admin" && allowAdminWrite)
140
+ );
141
+ if (fieldsToDrop.length === 0) {
142
+ return item;
143
+ }
144
+ const next = {...record};
145
+ for (const field of fieldsToDrop) {
146
+ Reflect.deleteProperty(next, field);
147
+ }
148
+ logger.warn(`Ignored privileged User fields on a modelRouter write: ${fieldsToDrop.join(", ")}`);
149
+ return next;
150
+ };
151
+
152
+ /**
153
+ * When RBAC is enabled, authority-bearing User fields must not flow through ordinary mongoose
154
+ * writes on `/users`, sync, or MCP. AdminApp captures role assignments before this runs and
155
+ * explicitly marks authorized legacy-admin writes after its additional checks.
156
+ */
157
+ export const omitUserRolesFromWriteBody = (
158
+ modelName: string,
159
+ accessControl: unknown,
160
+ body: unknown,
161
+ allowAdminWrite = false
162
+ ): unknown => {
163
+ if (modelName !== "User" || !accessControl || body == null) {
164
+ return body;
165
+ }
166
+ if (Array.isArray(body)) {
167
+ return body.map((item) => omitPrivilegedFieldsFromObject(item, allowAdminWrite));
168
+ }
169
+ return omitPrivilegedFieldsFromObject(body, allowAdminWrite);
170
+ };
171
+
103
172
  export const signupUser = async (
104
173
  userModel: UserModel,
105
174
  email: string,
@@ -108,7 +177,8 @@ export const signupUser = async (
108
177
  ) => {
109
178
  // Strip email and password from the body. They can cause mongoose to throw an error if strict is
110
179
  // set.
111
- const {email: _email, password: _password, ...bodyRest} = body ?? {};
180
+ const {email: _email, password: _password, ...rawBody} = body ?? {};
181
+ const bodyRest = stripPrivilegedUserFields(rawBody, "signup");
112
182
 
113
183
  try {
114
184
  // noExplicitAny: passport-local-mongoose's register() is untyped
@@ -594,7 +664,8 @@ export const addAuthRoutes = (
594
664
  export const addMeRoutes = (
595
665
  app: express.Application,
596
666
  userModel: UserModel,
597
- _authOptions?: AuthOptions
667
+ _authOptions?: AuthOptions,
668
+ accessControl?: import("./rbac/types").AnyTerrenoAccess
598
669
  ): void => {
599
670
  const router = express.Router();
600
671
  router.get("/me", authenticateMiddleware(), async (req, res) => {
@@ -609,6 +680,13 @@ export const addMeRoutes = (
609
680
  }
610
681
  const dataObject = data.toObject() as unknown as Record<string, unknown>;
611
682
  dataObject.id = data._id;
683
+ if (accessControl) {
684
+ const withRoles = data as unknown as {roles?: string[]};
685
+ dataObject.roles = withRoles.roles ?? [];
686
+ dataObject.permissions = await accessControl.getPermissions({
687
+ user: data as unknown as User,
688
+ });
689
+ }
612
690
  return res.json({data: dataObject});
613
691
  });
614
692
 
@@ -627,7 +705,7 @@ export const addMeRoutes = (
627
705
  // return res.status(403).send({message: (e as Error).message});
628
706
  // }
629
707
  try {
630
- Object.assign(doc, req.body);
708
+ Object.assign(doc, stripPrivilegedUserFields(req.body ?? {}, "PATCH /auth/me"));
631
709
  await doc.save();
632
710
 
633
711
  const dataObject = doc.toObject() as unknown as Record<string, unknown>;
@@ -20,6 +20,30 @@ const buildApp = (consentAppOptions: ConsentAppOptions = {}): express.Applicatio
20
20
  .build();
21
21
 
22
22
  describe("ConsentApp", () => {
23
+ it("contributes consent form and response admin metadata", () => {
24
+ const contribution = new ConsentApp().adminContribution();
25
+
26
+ expect(contribution.models).toHaveLength(2);
27
+ expect(contribution.models?.map((item) => item.routePath)).toEqual([
28
+ "/consent-forms",
29
+ "/consent-responses",
30
+ ]);
31
+ expect(contribution.models?.[0]?.admin.fieldOverrides).toEqual({
32
+ checkboxes: {widget: "checkbox-list"},
33
+ content: {widget: "locale-content"},
34
+ defaultLocale: {widget: "locale-default"},
35
+ });
36
+ expect(contribution.models?.[1]?.admin.adminPermissions).toEqual({
37
+ create: [],
38
+ delete: [],
39
+ update: [],
40
+ });
41
+ expect(contribution.models?.[1]?.populatePaths).toEqual([
42
+ {fields: ["title", "slug", "version", "type"], path: "consentFormId"},
43
+ {fields: ["name", "email"], path: "userId"},
44
+ ]);
45
+ });
46
+
23
47
  let admin: HydratedDocument<User>;
24
48
  let notAdmin: HydratedDocument<User>;
25
49
  let adminAgent: TestAgent;
package/src/consentApp.ts CHANGED
@@ -9,6 +9,7 @@
9
9
  import {type Application, Router} from "express";
10
10
  import {DateTime} from "luxon";
11
11
  import type {CollectionActionConfig} from "./actions";
12
+ import type {AdminContribution} from "./adminTypes";
12
13
  import {asyncHandler, modelRouter} from "./api";
13
14
  import type {User} from "./auth";
14
15
  import {authenticateMiddleware} from "./auth";
@@ -67,6 +68,105 @@ export class ConsentApp implements TerrenoPlugin {
67
68
  this.options = options;
68
69
  }
69
70
 
71
+ adminContribution(): AdminContribution {
72
+ return {
73
+ models: [
74
+ {
75
+ admin: {
76
+ defaultSort: "order",
77
+ displayName: "Consent Forms",
78
+ fieldOrder: [
79
+ "title",
80
+ "slug",
81
+ "type",
82
+ "version",
83
+ "order",
84
+ "active",
85
+ "required",
86
+ "content",
87
+ "defaultLocale",
88
+ "requireScrollToBottom",
89
+ "captureSignature",
90
+ "agreeButtonText",
91
+ "allowDecline",
92
+ "declineButtonText",
93
+ "checkboxes",
94
+ ],
95
+ fieldOverrides: {
96
+ checkboxes: {widget: "checkbox-list"},
97
+ content: {widget: "locale-content"},
98
+ defaultLocale: {widget: "locale-default"},
99
+ },
100
+ fieldsets: [
101
+ {
102
+ fields: ["title", "slug", "type", "version", "order", "active", "required"],
103
+ title: "Basics",
104
+ },
105
+ {
106
+ fields: ["content", "defaultLocale", "requireScrollToBottom", "checkboxes"],
107
+ title: "Content",
108
+ },
109
+ {
110
+ fields: [
111
+ "captureSignature",
112
+ "agreeButtonText",
113
+ "allowDecline",
114
+ "declineButtonText",
115
+ ],
116
+ title: "Actions",
117
+ },
118
+ ],
119
+ filters: [
120
+ {field: "active", kind: "boolean", label: "Active"},
121
+ {
122
+ choices: [
123
+ {label: "Agreement", value: "agreement"},
124
+ {label: "Privacy", value: "privacy"},
125
+ {label: "HIPAA", value: "hipaa"},
126
+ {label: "Research", value: "research"},
127
+ {label: "Terms", value: "terms"},
128
+ {label: "Custom", value: "custom"},
129
+ ],
130
+ field: "type",
131
+ kind: "choice",
132
+ label: "Type",
133
+ },
134
+ ],
135
+ group: "Compliance",
136
+ listDisplay: ["title", "type", "version", "active", "order"],
137
+ listFields: ["title", "type", "version", "active", "order"],
138
+ searchFields: ["title", "slug"],
139
+ sortableFields: ["title", "type", "version", "active", "order", "created"],
140
+ },
141
+ model: ConsentForm as unknown as import("mongoose").Model<unknown>,
142
+ routePath: "/consent-forms",
143
+ },
144
+ {
145
+ admin: {
146
+ adminPermissions: {
147
+ create: [],
148
+ delete: [],
149
+ update: [],
150
+ },
151
+ defaultSort: "-agreedAt",
152
+ displayName: "Consent Responses",
153
+ filters: [
154
+ {field: "agreed", kind: "boolean", label: "Agreed"},
155
+ {field: "locale", kind: "text", label: "Locale"},
156
+ ],
157
+ group: "Compliance",
158
+ listFields: ["userId", "agreed", "locale", "agreedAt"],
159
+ searchFields: ["locale"],
160
+ sortableFields: ["agreed", "locale", "agreedAt", "created"],
161
+ },
162
+ model: ConsentResponse as unknown as import("mongoose").Model<unknown>,
163
+ populatePaths: consentResponsePopulatePaths,
164
+ routePath: "/consent-responses",
165
+ },
166
+ ],
167
+ };
168
+ }
169
+
70
170
  register(app: Application): void {
71
171
  const {auditTrail, resolveConsentForms, aiConfig} = this.options;
72
172