@terreno/api 57.2.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 (277) hide show
  1. package/README.md +17 -7
  2. package/dist/actions.js +19 -7
  3. package/dist/api.d.ts +4 -0
  4. package/dist/api.js +12 -24
  5. package/dist/auth.d.ts +23 -10
  6. package/dist/auth.js +97 -32
  7. package/dist/authRecovery.d.ts +5 -0
  8. package/dist/authRecovery.js +350 -0
  9. package/dist/authTokens.d.ts +8 -0
  10. package/dist/authTokens.js +162 -0
  11. package/dist/betterAuth.d.ts +33 -0
  12. package/dist/betterAuthApp.d.ts +4 -0
  13. package/dist/betterAuthApp.js +26 -8
  14. package/dist/betterAuthSetup.d.ts +44 -2
  15. package/dist/betterAuthSetup.js +288 -18
  16. package/dist/collectionRegistry.d.ts +38 -0
  17. package/dist/collectionRegistry.js +72 -0
  18. package/dist/configurationApp.d.ts +11 -2
  19. package/dist/configurationApp.js +2 -4
  20. package/dist/docLoader.js +35 -6
  21. package/dist/expressServer.d.ts +26 -3
  22. package/dist/expressServer.js +79 -11
  23. package/dist/index.d.ts +16 -0
  24. package/dist/index.js +38 -2
  25. package/dist/mcp/auth.d.ts +1 -0
  26. package/dist/mcp/auth.js +47 -25
  27. package/dist/mcp/handlers.d.ts +1 -1
  28. package/dist/mcp/handlers.js +67 -233
  29. package/dist/mcp/query.d.ts +2 -2
  30. package/dist/mcp/registry.d.ts +1 -5
  31. package/dist/mcp/registry.js +31 -20
  32. package/dist/mcp/schemaGenerator.d.ts +2 -7
  33. package/dist/mcp/schemaGenerator.js +41 -116
  34. package/dist/mcp/server.d.ts +1 -0
  35. package/dist/mcp/server.js +1 -0
  36. package/dist/mcp/serviceTokens.d.ts +16 -0
  37. package/dist/mcp/serviceTokens.js +345 -0
  38. package/dist/mcp/types.d.ts +2 -2
  39. package/dist/models/mcpServiceToken.d.ts +3 -0
  40. package/dist/models/mcpServiceToken.js +208 -0
  41. package/dist/openApiBuilder.d.ts +5 -4
  42. package/dist/openApiBuilder.js +61 -8
  43. package/dist/openApiCompat.js +1 -1
  44. package/dist/openApiValidator.js +0 -2
  45. package/dist/plugins.d.ts +14 -1
  46. package/dist/plugins.js +17 -6
  47. package/dist/populate.d.ts +2 -2
  48. package/dist/populate.js +47 -42
  49. package/dist/rateLimit/applyTrustProxy.d.ts +3 -0
  50. package/dist/rateLimit/applyTrustProxy.js +17 -0
  51. package/dist/rateLimit/createStore.d.ts +2 -0
  52. package/dist/rateLimit/createStore.js +28 -0
  53. package/dist/rateLimit/memoryStore.d.ts +2 -0
  54. package/dist/rateLimit/memoryStore.js +108 -0
  55. package/dist/rateLimit/middleware.d.ts +11 -0
  56. package/dist/rateLimit/middleware.js +110 -0
  57. package/dist/rateLimit/mongoStore.d.ts +3 -0
  58. package/dist/rateLimit/mongoStore.js +122 -0
  59. package/dist/rateLimit/policies.d.ts +14 -0
  60. package/dist/rateLimit/policies.js +151 -0
  61. package/dist/rateLimit/redisStore.d.ts +3 -0
  62. package/dist/rateLimit/redisStore.js +155 -0
  63. package/dist/rateLimit/types.d.ts +54 -0
  64. package/dist/rateLimit/types.js +9 -0
  65. package/dist/rbac/access.js +5 -1
  66. package/dist/rbac/assertAllowed.d.ts +9 -0
  67. package/dist/rbac/assertAllowed.js +182 -0
  68. package/dist/rbac/modelRouterAccess.d.ts +1 -0
  69. package/dist/rbac/modelRouterAccess.js +8 -4
  70. package/dist/rbac/permissionUtils.js +3 -2
  71. package/dist/rbac/resolve.js +5 -4
  72. package/dist/rbac/routes.js +15 -6
  73. package/dist/realtime/deprecation.d.ts +12 -0
  74. package/dist/realtime/deprecation.js +32 -0
  75. package/dist/realtime/realtimeApp.d.ts +1 -1
  76. package/dist/realtime/realtimeApp.js +10 -11
  77. package/dist/realtime/registry.d.ts +0 -31
  78. package/dist/realtime/registry.js +44 -31
  79. package/dist/realtime/socketAuth.d.ts +5 -5
  80. package/dist/realtime/socketAuth.js +11 -1
  81. package/dist/realtime/socketUser.d.ts +5 -1
  82. package/dist/realtime/types.d.ts +14 -4
  83. package/dist/schemaMetadata.d.ts +56 -0
  84. package/dist/schemaMetadata.js +513 -0
  85. package/dist/seedRunner.d.ts +88 -0
  86. package/dist/seedRunner.js +627 -0
  87. package/dist/sync/executors.d.ts +12 -2
  88. package/dist/sync/executors.js +8 -10
  89. package/dist/sync/loadHarness.js +28 -19
  90. package/dist/sync/models.js +26 -24
  91. package/dist/sync/mutationHandler.d.ts +9 -0
  92. package/dist/sync/mutationHandler.js +11 -6
  93. package/dist/sync/registrationSideEffects.d.ts +35 -0
  94. package/dist/sync/registrationSideEffects.js +151 -0
  95. package/dist/sync/registry.d.ts +2 -52
  96. package/dist/sync/registry.js +38 -187
  97. package/dist/sync/routes.js +3 -2
  98. package/dist/sync/scripts/compactTombstones.js +0 -2
  99. package/dist/sync/syncApp.d.ts +3 -3
  100. package/dist/sync/syncApp.js +4 -4
  101. package/dist/sync/syncBatch.js +3 -2
  102. package/dist/sync/syncSeqPlugin.d.ts +1 -1
  103. package/dist/sync/syncSeqPlugin.js +20 -16
  104. package/dist/terrenoApp.d.ts +19 -5
  105. package/dist/terrenoApp.js +66 -18
  106. package/dist/tests/models.d.ts +2 -0
  107. package/dist/tests/models.js +6 -0
  108. package/dist/types/authToken.d.ts +33 -0
  109. package/dist/types/authToken.js +2 -0
  110. package/dist/types/mcpServiceToken.d.ts +41 -0
  111. package/dist/types/mcpServiceToken.js +2 -0
  112. package/dist/webhooks/headerValue.d.ts +2 -0
  113. package/dist/webhooks/headerValue.js +14 -0
  114. package/dist/webhooks/idempotency/memoryStore.d.ts +10 -0
  115. package/dist/webhooks/idempotency/memoryStore.js +65 -0
  116. package/dist/webhooks/idempotency/mongoStore.d.ts +4 -0
  117. package/dist/webhooks/idempotency/mongoStore.js +150 -0
  118. package/dist/webhooks/idempotency/webhookReceipt.d.ts +62 -0
  119. package/dist/webhooks/idempotency/webhookReceipt.js +39 -0
  120. package/dist/webhooks/rawBody.d.ts +14 -0
  121. package/dist/webhooks/rawBody.js +22 -0
  122. package/dist/webhooks/timingSafeEqual.d.ts +4 -0
  123. package/dist/webhooks/timingSafeEqual.js +17 -0
  124. package/dist/webhooks/verifiers/hmac.d.ts +15 -0
  125. package/dist/webhooks/verifiers/hmac.js +49 -0
  126. package/dist/webhooks/verifiers/sendgrid.d.ts +10 -0
  127. package/dist/webhooks/verifiers/sendgrid.js +56 -0
  128. package/dist/webhooks/verifiers/stripe.d.ts +9 -0
  129. package/dist/webhooks/verifiers/stripe.js +99 -0
  130. package/dist/webhooks/verifiers/twilio.d.ts +9 -0
  131. package/dist/webhooks/verifiers/twilio.js +112 -0
  132. package/dist/webhooks/webhooksApp.d.ts +33 -0
  133. package/dist/webhooks/webhooksApp.js +195 -0
  134. package/package.json +4 -5
  135. package/src/__snapshots__/openApi.test.ts.snap +270 -0
  136. package/src/__snapshots__/openApiBuilder.test.ts.snap +30 -12
  137. package/src/__snapshots__/schemaMetadata.test.ts.snap +197 -0
  138. package/src/actions.ts +20 -13
  139. package/src/adminModelRouter.test.ts +133 -0
  140. package/src/api.arrayOperations.test.ts +43 -31
  141. package/src/api.hooks.test.ts +38 -29
  142. package/src/api.query.test.ts +31 -31
  143. package/src/api.test.ts +95 -96
  144. package/src/api.ts +16 -27
  145. package/src/auth.test.ts +107 -51
  146. package/src/auth.ts +98 -29
  147. package/src/authRecovery.test.ts +281 -0
  148. package/src/authRecovery.ts +279 -0
  149. package/src/authTokens.test.ts +94 -0
  150. package/src/authTokens.ts +118 -0
  151. package/src/authVerification.test.ts +293 -0
  152. package/src/betterAuth.ts +24 -0
  153. package/src/betterAuthApp.test.ts +1 -0
  154. package/src/betterAuthApp.ts +27 -9
  155. package/src/betterAuthSetup.test.ts +568 -38
  156. package/src/betterAuthSetup.ts +260 -5
  157. package/src/collectionRegistry.test.ts +165 -0
  158. package/src/collectionRegistry.ts +115 -0
  159. package/src/configurationApp.ts +13 -7
  160. package/src/docLoader.test.ts +45 -1
  161. package/src/docLoader.ts +37 -6
  162. package/src/express.d.ts +1 -0
  163. package/src/expressServer.test.ts +130 -66
  164. package/src/expressServer.ts +75 -19
  165. package/src/githubAuth.test.ts +60 -55
  166. package/src/index.ts +58 -0
  167. package/src/mcp/auth.test.ts +47 -0
  168. package/src/mcp/auth.ts +32 -11
  169. package/src/mcp/handlers.ts +45 -172
  170. package/src/mcp/integration.test.ts +59 -9
  171. package/src/mcp/query.ts +2 -4
  172. package/src/mcp/registry.ts +29 -20
  173. package/src/mcp/schemaGenerator.test.ts +8 -0
  174. package/src/mcp/schemaGenerator.ts +49 -131
  175. package/src/mcp/server.ts +2 -0
  176. package/src/mcp/serviceTokens.test.ts +330 -0
  177. package/src/mcp/serviceTokens.ts +307 -0
  178. package/src/mcp/toolGenerator.test.ts +1 -1
  179. package/src/mcp/types.ts +2 -6
  180. package/src/models/mcpServiceToken.test.ts +129 -0
  181. package/src/models/mcpServiceToken.ts +158 -0
  182. package/src/openApi.test.ts +80 -64
  183. package/src/openApiBuilder.test.ts +95 -7
  184. package/src/openApiBuilder.ts +46 -9
  185. package/src/openApiCompat.ts +1 -1
  186. package/src/openApiValidator.test.ts +49 -54
  187. package/src/openApiValidator.ts +1 -3
  188. package/src/plugins.test.ts +14 -0
  189. package/src/plugins.ts +34 -9
  190. package/src/populate.test.ts +34 -0
  191. package/src/populate.ts +40 -29
  192. package/src/rateLimit/applyTrustProxy.ts +17 -0
  193. package/src/rateLimit/createStore.ts +25 -0
  194. package/src/rateLimit/memoryStore.ts +40 -0
  195. package/src/rateLimit/middleware.ts +79 -0
  196. package/src/rateLimit/mongoStore.test.ts +80 -0
  197. package/src/rateLimit/mongoStore.ts +76 -0
  198. package/src/rateLimit/policies.ts +130 -0
  199. package/src/rateLimit/rateLimit.test.ts +328 -0
  200. package/src/rateLimit/redisStore.ioredis.test.ts +29 -0
  201. package/src/rateLimit/redisStore.test.ts +114 -0
  202. package/src/rateLimit/redisStore.ts +85 -0
  203. package/src/rateLimit/types.ts +64 -0
  204. package/src/rbac/access.ts +5 -1
  205. package/src/rbac/assertAllowed.test.ts +325 -0
  206. package/src/rbac/assertAllowed.ts +157 -0
  207. package/src/rbac/backfillAdmins.test.ts +124 -0
  208. package/src/rbac/fieldViews.test.ts +89 -0
  209. package/src/rbac/modelRouterAccess.test.ts +126 -0
  210. package/src/rbac/modelRouterAccess.ts +5 -2
  211. package/src/rbac/permissionUtils.ts +3 -2
  212. package/src/rbac/realtimeAccess.test.ts +109 -1
  213. package/src/rbac/resolve.ts +5 -4
  214. package/src/rbac/roleManager.test.ts +169 -0
  215. package/src/rbac/routes.test.ts +233 -0
  216. package/src/rbac/routes.ts +16 -6
  217. package/src/realtime/deprecation.test.ts +60 -0
  218. package/src/realtime/deprecation.ts +32 -0
  219. package/src/realtime/realtime.test.ts +8 -4
  220. package/src/realtime/realtimeApp.ts +10 -11
  221. package/src/realtime/realtimeAppSetup.test.ts +32 -5
  222. package/src/realtime/registry.ts +48 -42
  223. package/src/realtime/sessionRevalidation.test.ts +57 -44
  224. package/src/realtime/socketAuth.test.ts +75 -23
  225. package/src/realtime/socketAuth.ts +17 -6
  226. package/src/realtime/socketUser.ts +5 -3
  227. package/src/realtime/types.ts +14 -4
  228. package/src/schemaMetadata.test.ts +405 -0
  229. package/src/schemaMetadata.ts +593 -0
  230. package/src/scrubAdminFields.test.ts +105 -0
  231. package/src/seedRunner.test.ts +591 -0
  232. package/src/seedRunner.ts +464 -0
  233. package/src/sync/docMatchesMutationData.test.ts +16 -0
  234. package/src/sync/ensureSyncIndexes.test.ts +54 -15
  235. package/src/sync/executors.test.ts +40 -0
  236. package/src/sync/executors.ts +24 -12
  237. package/src/sync/integration.test.ts +15 -7
  238. package/src/sync/loadHarness.ts +28 -19
  239. package/src/sync/models.ts +32 -18
  240. package/src/sync/mutationHandler.test.ts +16 -16
  241. package/src/sync/mutationHandler.ts +9 -7
  242. package/src/sync/registrationSideEffects.test.ts +126 -0
  243. package/src/sync/registrationSideEffects.ts +131 -0
  244. package/src/sync/registry.ts +45 -171
  245. package/src/sync/routes.ts +3 -2
  246. package/src/sync/scripts/compactTombstones.ts +0 -2
  247. package/src/sync/sessionRevalidationIntegration.test.ts +12 -11
  248. package/src/sync/sync.test.ts +25 -23
  249. package/src/sync/syncApp.ts +4 -4
  250. package/src/sync/syncBatch.ts +3 -2
  251. package/src/sync/syncFrontier.test.ts +17 -15
  252. package/src/sync/syncPhaseC.test.ts +54 -43
  253. package/src/sync/syncRoutes.test.ts +51 -36
  254. package/src/sync/syncSeqPlugin.ts +66 -44
  255. package/src/sync/syncSocket.test.ts +112 -81
  256. package/src/terrenoApp.mcpServiceTokens.test.ts +173 -0
  257. package/src/terrenoApp.ts +87 -15
  258. package/src/tests/models.ts +14 -1
  259. package/src/types/authToken.ts +43 -0
  260. package/src/types/mcpServiceToken.ts +54 -0
  261. package/src/webhooks/headerValue.test.ts +22 -0
  262. package/src/webhooks/headerValue.ts +12 -0
  263. package/src/webhooks/idempotency/memoryStore.ts +34 -0
  264. package/src/webhooks/idempotency/mongoStore.test.ts +274 -0
  265. package/src/webhooks/idempotency/mongoStore.ts +83 -0
  266. package/src/webhooks/idempotency/webhookReceipt.ts +70 -0
  267. package/src/webhooks/rawBody.test.ts +74 -0
  268. package/src/webhooks/rawBody.ts +23 -0
  269. package/src/webhooks/timingSafeEqual.ts +16 -0
  270. package/src/webhooks/verifiers/hmac.test.ts +110 -0
  271. package/src/webhooks/verifiers/hmac.ts +54 -0
  272. package/src/webhooks/verifiers/providerVerifiers.test.ts +388 -0
  273. package/src/webhooks/verifiers/sendgrid.ts +59 -0
  274. package/src/webhooks/verifiers/stripe.ts +67 -0
  275. package/src/webhooks/verifiers/twilio.ts +69 -0
  276. package/src/webhooks/webhooksApp.test.ts +221 -0
  277. package/src/webhooks/webhooksApp.ts +144 -0
@@ -0,0 +1,325 @@
1
+ import {describe, expect, it, mock} from "bun:test";
2
+ import mongoose from "mongoose";
3
+
4
+ import type {User} from "../auth";
5
+ import {type APIError, isAPIError} from "../errors";
6
+ import {Permissions} from "../permissions";
7
+ import {setupDb} from "../tests";
8
+ import {createAccess} from "./access";
9
+ import {assertAllowed} from "./assertAllowed";
10
+ import {terrenoStatements} from "./statements";
11
+ import type {AnyTerrenoAccess} from "./types";
12
+
13
+ const appStatements = {
14
+ ...terrenoStatements,
15
+ todo: ["create", "read", "update", "delete", "list"],
16
+ } as const;
17
+
18
+ const createUser = (
19
+ overrides: Partial<User & {roles: string[]}> = {}
20
+ ): User & {roles: string[]} => {
21
+ const id = new mongoose.Types.ObjectId();
22
+ return {
23
+ _id: id as unknown as User["_id"],
24
+ admin: false,
25
+ id: id.toString(),
26
+ roles: [],
27
+ ...overrides,
28
+ };
29
+ };
30
+
31
+ const fullLegacyPermissions = {
32
+ create: [Permissions.IsAny],
33
+ delete: [Permissions.IsAny],
34
+ list: [Permissions.IsAny],
35
+ read: [Permissions.IsAny],
36
+ update: [Permissions.IsAny],
37
+ };
38
+
39
+ describe("assertAllowed", () => {
40
+ it("allows access when can() passes even if legacy permissions would deny", async () => {
41
+ const user = createUser();
42
+ const can = mock(async () => ({allowed: true}));
43
+ const accessControl = {
44
+ can,
45
+ statements: appStatements,
46
+ } as unknown as AnyTerrenoAccess;
47
+
48
+ await assertAllowed({
49
+ method: "create",
50
+ options: {
51
+ access: {resource: "todo"},
52
+ accessControl,
53
+ permissions: {
54
+ ...fullLegacyPermissions,
55
+ create: [Permissions.IsAdmin],
56
+ },
57
+ },
58
+ user,
59
+ });
60
+
61
+ expect(can).toHaveBeenCalled();
62
+ });
63
+
64
+ it("throws 405 when legacy permissions array is empty", async () => {
65
+ const user = createUser({admin: true});
66
+
67
+ await expect(
68
+ assertAllowed({
69
+ method: "delete",
70
+ options: {
71
+ permissions: {
72
+ ...fullLegacyPermissions,
73
+ delete: [],
74
+ },
75
+ },
76
+ user,
77
+ })
78
+ ).rejects.toMatchObject({status: 405});
79
+ });
80
+
81
+ it("throws 403 when can() denies", async () => {
82
+ const user = createUser();
83
+ const can = mock(async () => ({
84
+ allowed: false,
85
+ deniedBy: "role" as const,
86
+ reason: "Missing todo:create",
87
+ }));
88
+ const accessControl = {
89
+ can,
90
+ statements: appStatements,
91
+ } as unknown as AnyTerrenoAccess;
92
+
93
+ await expect(
94
+ assertAllowed({
95
+ method: "create",
96
+ options: {
97
+ access: {resource: "todo"},
98
+ accessControl,
99
+ permissions: fullLegacyPermissions,
100
+ },
101
+ user,
102
+ })
103
+ ).rejects.toMatchObject({
104
+ detail: "Missing todo:create",
105
+ status: 403,
106
+ title: "Access denied",
107
+ });
108
+ });
109
+
110
+ it("applies legacy AND semantics across permission methods", async () => {
111
+ const user = createUser();
112
+
113
+ await expect(
114
+ assertAllowed({
115
+ method: "create",
116
+ options: {
117
+ permissions: {
118
+ ...fullLegacyPermissions,
119
+ create: [Permissions.IsAuthenticated, Permissions.IsAdmin],
120
+ },
121
+ },
122
+ user,
123
+ })
124
+ ).rejects.toMatchObject({status: 405});
125
+ });
126
+
127
+ it("throws 403 for legacy object-level denial when doc is provided", async () => {
128
+ const ownerId = new mongoose.Types.ObjectId();
129
+ const user = createUser();
130
+ const doc = {ownerId: ownerId.toString()} as {ownerId: string};
131
+
132
+ try {
133
+ await assertAllowed({
134
+ doc,
135
+ method: "read",
136
+ options: {
137
+ permissions: {
138
+ ...fullLegacyPermissions,
139
+ read: [Permissions.IsOwner],
140
+ },
141
+ },
142
+ user,
143
+ });
144
+ throw new Error("expected assertAllowed to throw");
145
+ } catch (error) {
146
+ expect(isAPIError(error)).toBe(true);
147
+ expect((error as APIError).status).toBe(403);
148
+ }
149
+ });
150
+
151
+ it("throws 405 when RBAC action is disabled", async () => {
152
+ await setupDb();
153
+ const access = createAccess({
154
+ connection: mongoose.connection,
155
+ statements: appStatements,
156
+ });
157
+ await access.roles.seedDefaults();
158
+ const user = createUser({roles: ["superadmin"]});
159
+
160
+ await expect(
161
+ assertAllowed({
162
+ method: "delete",
163
+ options: {
164
+ access: {actions: {delete: null}, resource: "todo"},
165
+ accessControl: access as AnyTerrenoAccess,
166
+ permissions: fullLegacyPermissions,
167
+ },
168
+ user,
169
+ })
170
+ ).rejects.toMatchObject({status: 405});
171
+ });
172
+
173
+ it("denies RBAC create via real can() when role lacks permission", async () => {
174
+ await setupDb();
175
+ const access = createAccess({
176
+ connection: mongoose.connection,
177
+ defaultRoles: [
178
+ {
179
+ displayName: "Reader",
180
+ name: "reader",
181
+ permissions: {todo: ["read", "list"]},
182
+ },
183
+ ],
184
+ statements: appStatements,
185
+ });
186
+ await access.roles.seedDefaults();
187
+ const user = createUser({roles: ["reader"]});
188
+
189
+ await expect(
190
+ assertAllowed({
191
+ method: "create",
192
+ options: {
193
+ access: {resource: "todo"},
194
+ accessControl: access as AnyTerrenoAccess,
195
+ permissions: fullLegacyPermissions,
196
+ },
197
+ user,
198
+ })
199
+ ).rejects.toMatchObject({status: 403});
200
+ });
201
+
202
+ it("throws 500 when neither access nor permissions are configured", async () => {
203
+ await expect(
204
+ assertAllowed({
205
+ method: "create",
206
+ options: {},
207
+ user: createUser(),
208
+ })
209
+ ).rejects.toMatchObject({
210
+ status: 500,
211
+ title: "modelRouter requires permissions or access with accessControl",
212
+ });
213
+ });
214
+
215
+ it("denies when scope.check returns false", async () => {
216
+ const user = createUser();
217
+ const can = mock(async () => ({allowed: true}));
218
+ const scopeCheck = mock(async () => false);
219
+ const accessControl = {
220
+ can,
221
+ statements: appStatements,
222
+ } as unknown as AnyTerrenoAccess;
223
+
224
+ await expect(
225
+ assertAllowed({
226
+ method: "read",
227
+ options: {
228
+ access: {
229
+ resource: "todo",
230
+ scope: {check: scopeCheck},
231
+ },
232
+ accessControl,
233
+ permissions: fullLegacyPermissions,
234
+ },
235
+ user,
236
+ })
237
+ ).rejects.toMatchObject({status: 403, title: "Access denied"});
238
+
239
+ expect(scopeCheck).toHaveBeenCalled();
240
+ });
241
+
242
+ it("denies when scope.check requires extra permissions that can() rejects", async () => {
243
+ const user = createUser();
244
+ const can = mock(async ({permissions}) => {
245
+ const todoPerms = (permissions as {todo?: string[]}).todo ?? [];
246
+ if (todoPerms.includes("admin")) {
247
+ return {allowed: false, reason: "Missing admin"};
248
+ }
249
+ return {allowed: true};
250
+ });
251
+ const scopeCheck = mock(async () => ({todo: ["admin"]}));
252
+ const accessControl = {
253
+ can,
254
+ statements: appStatements,
255
+ } as unknown as AnyTerrenoAccess;
256
+
257
+ await expect(
258
+ assertAllowed({
259
+ method: "read",
260
+ options: {
261
+ access: {
262
+ resource: "todo",
263
+ scope: {check: scopeCheck},
264
+ },
265
+ accessControl,
266
+ permissions: fullLegacyPermissions,
267
+ },
268
+ user,
269
+ })
270
+ ).rejects.toMatchObject({
271
+ detail: "Missing admin",
272
+ status: 403,
273
+ title: "Access denied",
274
+ });
275
+ });
276
+
277
+ it("denies scope when user is missing even if can() allows anonymous access", async () => {
278
+ const can = mock(async () => ({allowed: true}));
279
+ const scopeCheck = mock(async () => true);
280
+ const accessControl = {
281
+ can,
282
+ statements: appStatements,
283
+ } as unknown as AnyTerrenoAccess;
284
+
285
+ await expect(
286
+ assertAllowed({
287
+ method: "read",
288
+ options: {
289
+ access: {
290
+ resource: "todo",
291
+ scope: {check: scopeCheck},
292
+ },
293
+ accessControl,
294
+ permissions: fullLegacyPermissions,
295
+ },
296
+ })
297
+ ).rejects.toMatchObject({status: 403, title: "Access denied"});
298
+
299
+ expect(scopeCheck).not.toHaveBeenCalled();
300
+ });
301
+
302
+ it("enforces access.also legacy permission checks", async () => {
303
+ const user = createUser();
304
+ const can = mock(async () => ({allowed: true}));
305
+ const accessControl = {
306
+ can,
307
+ statements: appStatements,
308
+ } as unknown as AnyTerrenoAccess;
309
+
310
+ await expect(
311
+ assertAllowed({
312
+ method: "create",
313
+ options: {
314
+ access: {
315
+ also: {create: [Permissions.IsAdmin]},
316
+ resource: "todo",
317
+ },
318
+ accessControl,
319
+ permissions: fullLegacyPermissions,
320
+ },
321
+ user,
322
+ })
323
+ ).rejects.toMatchObject({status: 405});
324
+ });
325
+ });
@@ -0,0 +1,157 @@
1
+ import type {ModelRouterOptions, RESTMethod} from "../api";
2
+ import type {User} from "../auth";
3
+ import {APIError} from "../errors";
4
+ import {checkPermissions, type PermissionMethod} from "../permissions";
5
+ import {resolveActionForMethod} from "./modelRouterAccess";
6
+ import type {AnyTerrenoAccess, ModelRouterAccessOptions} from "./types";
7
+
8
+ export interface AssertAllowedArgs<T> {
9
+ method: RESTMethod;
10
+ options: Pick<ModelRouterOptions<T>, "access" | "accessControl" | "permissions">;
11
+ user?: User;
12
+ doc?: T;
13
+ }
14
+
15
+ const throwAccessDenied = ({
16
+ status,
17
+ title,
18
+ detail,
19
+ }: {
20
+ status: 403 | 405;
21
+ title: string;
22
+ detail?: string;
23
+ }): never => {
24
+ throw new APIError({
25
+ detail,
26
+ status,
27
+ title,
28
+ });
29
+ };
30
+
31
+ const assertAllowedViaAccess = async <T>({
32
+ method,
33
+ access,
34
+ accessControl,
35
+ user,
36
+ doc,
37
+ }: {
38
+ method: RESTMethod;
39
+ access: ModelRouterAccessOptions;
40
+ accessControl: AnyTerrenoAccess;
41
+ user?: User;
42
+ doc?: T;
43
+ }): Promise<void> => {
44
+ const statements = accessControl.statements as Record<string, readonly string[]>;
45
+ const action = resolveActionForMethod(method, access, statements);
46
+ if (action === null) {
47
+ throw new APIError({status: 405, title: "Method not allowed"});
48
+ }
49
+
50
+ const result = await accessControl.can({
51
+ doc,
52
+ permissions: {[access.resource]: [action]} as never,
53
+ user,
54
+ });
55
+ if (!result.allowed) {
56
+ throwAccessDenied({
57
+ detail: result.reason,
58
+ status: 403,
59
+ title: "Access denied",
60
+ });
61
+ }
62
+
63
+ if (access.scope?.check) {
64
+ if (user === undefined) {
65
+ throw new APIError({status: 403, title: "Access denied"});
66
+ }
67
+ const scopeResult = await access.scope.check({
68
+ action,
69
+ doc,
70
+ user,
71
+ });
72
+ if (scopeResult === false) {
73
+ throwAccessDenied({status: 403, title: "Access denied"});
74
+ }
75
+ if (scopeResult && typeof scopeResult === "object") {
76
+ const extra = await accessControl.can({
77
+ doc,
78
+ permissions: scopeResult as never,
79
+ user,
80
+ });
81
+ if (!extra.allowed) {
82
+ throwAccessDenied({
83
+ detail: extra.reason,
84
+ status: 403,
85
+ title: "Access denied",
86
+ });
87
+ }
88
+ }
89
+ }
90
+
91
+ const also = access.also?.[method] ?? [];
92
+ if (also.length > 0) {
93
+ const alsoAllowed = await checkPermissions(method, also as PermissionMethod<T>[], user, doc);
94
+ if (!alsoAllowed) {
95
+ throwAccessDenied({
96
+ status: doc ? 403 : 405,
97
+ title: doc ? "Access denied" : "Method not allowed",
98
+ });
99
+ }
100
+ }
101
+ };
102
+
103
+ const assertAllowedViaPermissions = async <T>({
104
+ method,
105
+ permissions,
106
+ user,
107
+ doc,
108
+ }: {
109
+ method: RESTMethod;
110
+ permissions: PermissionMethod<T>[];
111
+ user?: User;
112
+ doc?: T;
113
+ }): Promise<void> => {
114
+ if (permissions.length === 0) {
115
+ throwAccessDenied({status: 405, title: "Method not allowed"});
116
+ }
117
+
118
+ const allowed = await checkPermissions(method, permissions, user, doc);
119
+ if (!allowed) {
120
+ throwAccessDenied({
121
+ status: doc ? 403 : 405,
122
+ title: doc ? "Access denied" : "Method not allowed",
123
+ });
124
+ }
125
+ };
126
+
127
+ export const assertAllowed = async <T>({
128
+ method,
129
+ options,
130
+ user,
131
+ doc,
132
+ }: AssertAllowedArgs<T>): Promise<void> => {
133
+ if (options.access && options.accessControl) {
134
+ await assertAllowedViaAccess({
135
+ access: options.access,
136
+ accessControl: options.accessControl,
137
+ doc,
138
+ method,
139
+ user,
140
+ });
141
+ return;
142
+ }
143
+
144
+ if (!options.permissions) {
145
+ throw new APIError({
146
+ status: 500,
147
+ title: "modelRouter requires permissions or access with accessControl",
148
+ });
149
+ }
150
+
151
+ await assertAllowedViaPermissions({
152
+ doc,
153
+ method,
154
+ permissions: options.permissions[method],
155
+ user,
156
+ });
157
+ };
@@ -0,0 +1,124 @@
1
+ import {beforeEach, describe, expect, it, spyOn} from "bun:test";
2
+ import mongoose, {model, Schema} from "mongoose";
3
+
4
+ import type {UserModel} from "../auth";
5
+ import {setupDb} from "../tests";
6
+ import {createAccess} from "./access";
7
+ import {backfillAdmins} from "./backfillAdmins";
8
+ import {terrenoStatements} from "./statements";
9
+ import {rbacUserPlugin} from "./userPlugin";
10
+
11
+ interface BackfillUser {
12
+ admin: boolean;
13
+ email: string;
14
+ roles: string[];
15
+ }
16
+
17
+ const backfillUserSchema = new Schema<BackfillUser>({
18
+ admin: {default: false, description: "Whether the user is an admin", type: Boolean},
19
+ email: {description: "The user's email", type: String},
20
+ });
21
+ rbacUserPlugin(backfillUserSchema);
22
+
23
+ const BackfillUserModel = model<BackfillUser>("BackfillAdminsUser", backfillUserSchema);
24
+
25
+ const asUserModel = (): UserModel => BackfillUserModel as unknown as UserModel;
26
+
27
+ const createAccessForTest = () =>
28
+ createAccess({
29
+ connection: mongoose.connection,
30
+ statements: terrenoStatements,
31
+ });
32
+
33
+ const createUser = async (overrides: Partial<BackfillUser> = {}): Promise<string> => {
34
+ const user = await BackfillUserModel.create({
35
+ admin: true,
36
+ email: `${new mongoose.Types.ObjectId().toString()}@example.com`,
37
+ ...overrides,
38
+ });
39
+ return user.id;
40
+ };
41
+
42
+ const findRoles = async (id: string): Promise<string[]> => {
43
+ const user = await BackfillUserModel.findById(id);
44
+ return user?.roles ?? [];
45
+ };
46
+
47
+ describe("backfillAdmins", () => {
48
+ beforeEach(async () => {
49
+ await setupDb();
50
+ await BackfillUserModel.deleteMany({});
51
+ });
52
+
53
+ it("reports matched admins without persisting on a dry run", async () => {
54
+ const access = createAccessForTest();
55
+ const invalidateCache = spyOn(access, "invalidateCache");
56
+ const adminId = await createUser();
57
+ await createUser({admin: false});
58
+
59
+ const result = await backfillAdmins({access, userModel: asUserModel()});
60
+
61
+ expect(result).toEqual({dryRun: true, matched: 1, updated: 1});
62
+ expect(await findRoles(adminId)).toEqual([]);
63
+ expect(invalidateCache).not.toHaveBeenCalled();
64
+ });
65
+
66
+ it("assigns the superadmin role and invalidates the cache on a wet run", async () => {
67
+ const access = createAccessForTest();
68
+ const invalidateCache = spyOn(access, "invalidateCache");
69
+ const adminId = await createUser();
70
+
71
+ const result = await backfillAdmins({access, userModel: asUserModel(), wetRun: true});
72
+
73
+ expect(result).toEqual({dryRun: false, matched: 1, updated: 1});
74
+ expect(await findRoles(adminId)).toEqual(["superadmin"]);
75
+ expect(invalidateCache).toHaveBeenCalledWith({userId: adminId});
76
+ });
77
+
78
+ it("preserves existing roles when adding the backfilled role", async () => {
79
+ const access = createAccessForTest();
80
+ const adminId = await createUser({roles: ["member"]});
81
+
82
+ const result = await backfillAdmins({access, userModel: asUserModel(), wetRun: true});
83
+
84
+ expect(result.updated).toBe(1);
85
+ expect(await findRoles(adminId)).toEqual(["member", "superadmin"]);
86
+ });
87
+
88
+ it("skips admins that already have the role", async () => {
89
+ const access = createAccessForTest();
90
+ const invalidateCache = spyOn(access, "invalidateCache");
91
+ await createUser({roles: ["superadmin"]});
92
+ const missingRoleId = await createUser();
93
+
94
+ const result = await backfillAdmins({access, userModel: asUserModel(), wetRun: true});
95
+
96
+ expect(result).toEqual({dryRun: false, matched: 2, updated: 1});
97
+ expect(invalidateCache).toHaveBeenCalledTimes(1);
98
+ expect(invalidateCache).toHaveBeenCalledWith({userId: missingRoleId});
99
+ });
100
+
101
+ it("supports a custom role name", async () => {
102
+ const access = createAccessForTest();
103
+ const adminId = await createUser();
104
+
105
+ const result = await backfillAdmins({
106
+ access,
107
+ roleName: "supportAdmin",
108
+ userModel: asUserModel(),
109
+ wetRun: true,
110
+ });
111
+
112
+ expect(result).toEqual({dryRun: false, matched: 1, updated: 1});
113
+ expect(await findRoles(adminId)).toEqual(["supportAdmin"]);
114
+ });
115
+
116
+ it("returns zero counts when there are no admins", async () => {
117
+ const access = createAccessForTest();
118
+ await createUser({admin: false});
119
+
120
+ const result = await backfillAdmins({access, userModel: asUserModel(), wetRun: true});
121
+
122
+ expect(result).toEqual({dryRun: false, matched: 0, updated: 0});
123
+ });
124
+ });
@@ -1,6 +1,8 @@
1
1
  import {describe, expect, it} from "bun:test";
2
+ import {assert} from "chai";
2
3
 
3
4
  import {applyReadMask, getDisallowedWriteKeys} from "./fieldViews";
5
+ import type {FieldMask} from "./types";
4
6
 
5
7
  describe("fieldViews", () => {
6
8
  it("applyReadMask picks only allowed read paths", () => {
@@ -36,4 +38,91 @@ describe("fieldViews", () => {
36
38
  );
37
39
  expect(disallowed).toEqual(["admin"]);
38
40
  });
41
+
42
+ it("applyReadMask returns primitives and null untouched", () => {
43
+ const mask: FieldMask = {omit: ["anything"], read: ["name"], write: []};
44
+ assert.equal(applyReadMask("plain", mask), "plain");
45
+ assert.equal(applyReadMask(7, mask), 7);
46
+ assert.isNull(applyReadMask(null, mask));
47
+ assert.isUndefined(applyReadMask(undefined, mask));
48
+ });
49
+
50
+ it("applyReadMask maps over arrays, including nested arrays of documents", () => {
51
+ const masked = applyReadMask(
52
+ [{name: "a", secret: "s"}, {name: "b", secret: "s"}, "primitive"],
53
+ {omit: [], read: ["name"], write: []}
54
+ );
55
+ assert.deepEqual(masked, [{name: "a"}, {name: "b"}, "primitive"]);
56
+ });
57
+
58
+ it("applyReadMask picks nested paths and skips paths missing from the document", () => {
59
+ const masked = applyReadMask(
60
+ {name: "Todo", profile: {email: "a@b.com", phone: "555"}},
61
+ {omit: [], read: ["profile.email", "profile.missing", "absent.deep", "name"], write: []}
62
+ );
63
+ assert.deepEqual(masked, {name: "Todo", profile: {email: "a@b.com"}});
64
+ });
65
+
66
+ it("applyReadMask omits top-level paths and ignores omissions with no parent object", () => {
67
+ const masked = applyReadMask(
68
+ {name: "Todo", profile: {email: "a@b.com"}, secret: "hidden"},
69
+ {omit: ["secret", "missing.deep", "profile.missing"], read: "*", write: []}
70
+ );
71
+ assert.deepEqual(masked, {name: "Todo", profile: {email: "a@b.com"}});
72
+ });
73
+
74
+ it("applyReadMask deep clones so mutating the result leaves the document intact", () => {
75
+ const doc = {profile: {tags: ["a"]}};
76
+ const masked = applyReadMask(doc, {omit: [], read: "*", write: []}) as {
77
+ profile: {tags: string[]};
78
+ };
79
+ masked.profile.tags.push("b");
80
+ assert.deepEqual(doc.profile.tags, ["a"]);
81
+ });
82
+
83
+ it("getDisallowedWriteKeys allows everything for a wildcard write mask", () => {
84
+ assert.deepEqual(
85
+ getDisallowedWriteKeys(
86
+ {admin: true, profile: {email: "a@b.com"}},
87
+ {
88
+ omit: [],
89
+ read: "*",
90
+ write: "*",
91
+ }
92
+ ),
93
+ []
94
+ );
95
+ });
96
+
97
+ it("getDisallowedWriteKeys allows a whole subtree when its parent path is writable", () => {
98
+ assert.deepEqual(
99
+ getDisallowedWriteKeys(
100
+ {profile: {email: "a@b.com", phone: "555"}},
101
+ {
102
+ omit: [],
103
+ read: "*",
104
+ write: ["profile"],
105
+ }
106
+ ),
107
+ []
108
+ );
109
+ });
110
+
111
+ it("getDisallowedWriteKeys reports the whole object when no nested path is writable", () => {
112
+ assert.deepEqual(
113
+ getDisallowedWriteKeys(
114
+ {name: "x", profile: {email: "a@b.com"}},
115
+ {
116
+ omit: [],
117
+ read: "*",
118
+ write: ["name"],
119
+ }
120
+ ),
121
+ ["profile"]
122
+ );
123
+ });
124
+
125
+ it("getDisallowedWriteKeys returns nothing for an empty body", () => {
126
+ assert.deepEqual(getDisallowedWriteKeys({}, {omit: [], read: "*", write: ["name"]}), []);
127
+ });
39
128
  });