@terreno/api 57.3.0 → 57.6.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 (412) hide show
  1. package/.ai/skills/mongoose-schema-safety/SKILL.md +23 -10
  2. package/README.md +11 -5
  3. package/bunfig.toml +1 -1
  4. package/dist/actions.js +197 -368
  5. package/dist/adminModelRouter.js +88 -173
  6. package/dist/adminTypes.d.ts +7 -0
  7. package/dist/adminTypes.js +6 -1
  8. package/dist/api.d.ts +10 -0
  9. package/dist/api.js +601 -792
  10. package/dist/audit/auditApp.d.ts +30 -0
  11. package/dist/audit/auditApp.js +114 -0
  12. package/dist/audit/auditEventModel.d.ts +29 -0
  13. package/dist/audit/auditEventModel.js +101 -0
  14. package/dist/audit/cloudTasksEnqueue.d.ts +32 -0
  15. package/dist/audit/cloudTasksEnqueue.js +69 -0
  16. package/dist/audit/diff.d.ts +10 -0
  17. package/dist/audit/diff.js +140 -0
  18. package/dist/audit/processQueue.d.ts +6 -0
  19. package/dist/audit/processQueue.js +56 -0
  20. package/dist/audit/rbacSink.d.ts +2 -0
  21. package/dist/audit/rbacSink.js +41 -0
  22. package/dist/audit/record.d.ts +56 -0
  23. package/dist/audit/record.js +251 -0
  24. package/dist/auth.js +432 -681
  25. package/dist/authRecovery.js +155 -269
  26. package/dist/authTokens.js +43 -118
  27. package/dist/betterAuth.d.ts +6 -0
  28. package/dist/betterAuthApp.js +25 -26
  29. package/dist/betterAuthSetup.js +258 -413
  30. package/dist/browserLogsRoute.d.ts +6 -0
  31. package/dist/browserLogsRoute.js +97 -0
  32. package/dist/collectionRegistry.d.ts +3 -1
  33. package/dist/collectionRegistry.js +43 -33
  34. package/dist/config.js +53 -122
  35. package/dist/configurationApp.js +180 -361
  36. package/dist/configurationPlugin.js +130 -302
  37. package/dist/consentApp.js +276 -421
  38. package/dist/docLoader.js +78 -126
  39. package/dist/envConfigurationPlugin.js +25 -147
  40. package/dist/errors.js +151 -247
  41. package/dist/example.js +28 -34
  42. package/dist/expressServer.d.ts +10 -0
  43. package/dist/expressServer.js +109 -255
  44. package/dist/frameworkModelNames.d.ts +24 -0
  45. package/dist/frameworkModelNames.js +31 -0
  46. package/dist/githubAuth.js +152 -216
  47. package/dist/httpClient.js +176 -264
  48. package/dist/index.d.ts +28 -1
  49. package/dist/index.js +53 -2
  50. package/dist/logger.js +145 -278
  51. package/dist/mcp/auth.js +76 -128
  52. package/dist/mcp/createMCPRequest.js +4 -5
  53. package/dist/mcp/handlers.js +268 -480
  54. package/dist/mcp/query.d.ts +0 -13
  55. package/dist/mcp/query.js +57 -151
  56. package/dist/mcp/registry.js +17 -30
  57. package/dist/mcp/schemaGenerator.js +95 -181
  58. package/dist/mcp/server.js +28 -100
  59. package/dist/mcp/serviceTokens.js +102 -191
  60. package/dist/mcp/toolGenerator.js +78 -191
  61. package/dist/middleware.js +15 -27
  62. package/dist/migrations/fixtures/all-down/20260910120000-one.d.ts +4 -0
  63. package/dist/migrations/fixtures/all-down/20260910120000-one.js +9 -0
  64. package/dist/migrations/fixtures/all-down/20260910120001-two.d.ts +4 -0
  65. package/dist/migrations/fixtures/all-down/20260910120001-two.js +9 -0
  66. package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.d.ts +3 -0
  67. package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.js +7 -0
  68. package/dist/migrations/fixtures/bad-name/not-a-migration.d.ts +3 -0
  69. package/dist/migrations/fixtures/bad-name/not-a-migration.js +7 -0
  70. package/dist/migrations/fixtures/missing-up/20260910120000-noup.d.ts +2 -0
  71. package/dist/migrations/fixtures/missing-up/20260910120000-noup.js +5 -0
  72. package/dist/migrations/fixtures/valid/20260910120000-alpha.d.ts +3 -0
  73. package/dist/migrations/fixtures/valid/20260910120000-alpha.js +7 -0
  74. package/dist/migrations/fixtures/valid/20260910120001-beta.d.ts +4 -0
  75. package/dist/migrations/fixtures/valid/20260910120001-beta.js +9 -0
  76. package/dist/migrations/generate.d.ts +17 -0
  77. package/dist/migrations/generate.js +155 -0
  78. package/dist/migrations/load.d.ts +20 -0
  79. package/dist/migrations/load.js +110 -0
  80. package/dist/migrations/lock.d.ts +13 -0
  81. package/dist/migrations/lock.js +73 -0
  82. package/dist/migrations/runner.d.ts +42 -0
  83. package/dist/migrations/runner.js +249 -0
  84. package/dist/migrations/schemaCatalog.d.ts +44 -0
  85. package/dist/migrations/schemaCatalog.js +185 -0
  86. package/dist/migrations/types.d.ts +87 -0
  87. package/dist/migrations/types.js +7 -0
  88. package/dist/models/consentForm.js +6 -6
  89. package/dist/models/consentResponse.js +5 -5
  90. package/dist/models/mcpServiceToken.js +66 -156
  91. package/dist/models/notification.d.ts +2 -0
  92. package/dist/models/notification.js +62 -0
  93. package/dist/models/notificationPreference.d.ts +2 -0
  94. package/dist/models/notificationPreference.js +49 -0
  95. package/dist/models/versionConfig.js +5 -5
  96. package/dist/notifications/notificationService.d.ts +40 -0
  97. package/dist/notifications/notificationService.js +183 -0
  98. package/dist/notifications/notificationsApp.d.ts +18 -0
  99. package/dist/notifications/notificationsApp.js +156 -0
  100. package/dist/notifications/notificationsBeforeSend.d.ts +14 -0
  101. package/dist/notifications/notificationsBeforeSend.js +32 -0
  102. package/dist/notifiers/googleChatNotifier.js +36 -117
  103. package/dist/notifiers/slackNotifier.d.ts +31 -2
  104. package/dist/notifiers/slackNotifier.js +170 -119
  105. package/dist/notifiers/zoomNotifier.js +60 -111
  106. package/dist/openApi.d.ts +1 -7
  107. package/dist/openApi.js +113 -127
  108. package/dist/openApiBuilder.d.ts +14 -3
  109. package/dist/openApiBuilder.js +117 -159
  110. package/dist/openApiCompat.js +81 -148
  111. package/dist/openApiEtag.js +7 -7
  112. package/dist/openApiValidator.d.ts +13 -1
  113. package/dist/openApiValidator.js +301 -246
  114. package/dist/orgs/orgContext.d.ts +23 -0
  115. package/dist/orgs/orgContext.js +128 -0
  116. package/dist/orgs/orgPermissions.d.ts +4 -0
  117. package/dist/orgs/orgPermissions.js +38 -0
  118. package/dist/orgs/orgPlugin.d.ts +13 -0
  119. package/dist/orgs/orgPlugin.js +66 -0
  120. package/dist/orgs/organizationModel.d.ts +13 -0
  121. package/dist/orgs/organizationModel.js +200 -0
  122. package/dist/orgs/organizationSettings.d.ts +19 -0
  123. package/dist/orgs/organizationSettings.js +113 -0
  124. package/dist/orgs/orgsApp.d.ts +28 -0
  125. package/dist/orgs/orgsApp.js +416 -0
  126. package/dist/permissions.d.ts +7 -13
  127. package/dist/permissions.js +95 -211
  128. package/dist/plugins.js +125 -218
  129. package/dist/populate.js +130 -240
  130. package/dist/rateLimit/applyTrustProxy.js +1 -1
  131. package/dist/rateLimit/createStore.js +7 -8
  132. package/dist/rateLimit/memoryStore.js +22 -100
  133. package/dist/rateLimit/middleware.d.ts +0 -8
  134. package/dist/rateLimit/middleware.js +49 -101
  135. package/dist/rateLimit/mongoStore.d.ts +1 -0
  136. package/dist/rateLimit/mongoStore.js +55 -112
  137. package/dist/rateLimit/policies.d.ts +0 -4
  138. package/dist/rateLimit/policies.js +44 -80
  139. package/dist/rateLimit/redisStore.d.ts +1 -0
  140. package/dist/rateLimit/redisStore.js +40 -133
  141. package/dist/rbac/access.js +122 -253
  142. package/dist/rbac/assertAllowed.js +95 -171
  143. package/dist/rbac/auditModel.js +14 -58
  144. package/dist/rbac/backfillAdmins.js +24 -130
  145. package/dist/rbac/fieldViews.js +46 -141
  146. package/dist/rbac/membershipOrgAdminSource.d.ts +6 -0
  147. package/dist/rbac/membershipOrgAdminSource.js +51 -0
  148. package/dist/rbac/middleware.js +30 -96
  149. package/dist/rbac/modelRouterAccess.d.ts +3 -0
  150. package/dist/rbac/modelRouterAccess.js +133 -307
  151. package/dist/rbac/permissionUtils.js +40 -179
  152. package/dist/rbac/realtimeAccess.js +81 -147
  153. package/dist/rbac/resolve.d.ts +1 -1
  154. package/dist/rbac/resolve.js +154 -319
  155. package/dist/rbac/roleManager.js +318 -700
  156. package/dist/rbac/roleModel.d.ts +2 -5
  157. package/dist/rbac/roleModel.js +60 -173
  158. package/dist/rbac/routes.js +93 -196
  159. package/dist/rbac/scopes.js +39 -133
  160. package/dist/rbac/statements.d.ts +10 -1
  161. package/dist/rbac/statements.js +42 -93
  162. package/dist/rbac/types.d.ts +5 -0
  163. package/dist/rbac/userPlugin.js +3 -29
  164. package/dist/realtime/changeStreamWatcher.d.ts +10 -4
  165. package/dist/realtime/changeStreamWatcher.js +499 -764
  166. package/dist/realtime/deprecation.d.ts +1 -0
  167. package/dist/realtime/deprecation.js +9 -10
  168. package/dist/realtime/queryMatcher.js +110 -191
  169. package/dist/realtime/queryStore.js +35 -118
  170. package/dist/realtime/realtimeApp.d.ts +1 -0
  171. package/dist/realtime/realtimeApp.js +248 -401
  172. package/dist/realtime/registry.js +19 -30
  173. package/dist/realtime/sessionRevalidation.js +132 -358
  174. package/dist/realtime/socketAuth.js +89 -208
  175. package/dist/realtime/socketUser.js +10 -56
  176. package/dist/requestContext.js +93 -139
  177. package/dist/schemaMetadata.js +181 -265
  178. package/dist/scriptRunner.js +96 -266
  179. package/dist/scrubAdminFields.js +36 -108
  180. package/dist/secretProviders.js +130 -299
  181. package/dist/seedRunner.js +221 -514
  182. package/dist/sync/adminBroadcastScope.d.ts +40 -0
  183. package/dist/sync/adminBroadcastScope.js +82 -0
  184. package/dist/sync/adminWindowAccess.d.ts +13 -0
  185. package/dist/sync/adminWindowAccess.js +25 -0
  186. package/dist/sync/adminWindowMutation.d.ts +88 -0
  187. package/dist/sync/adminWindowMutation.js +176 -0
  188. package/dist/sync/executors.d.ts +9 -3
  189. package/dist/sync/executors.js +425 -598
  190. package/dist/sync/loadHarness.js +392 -689
  191. package/dist/sync/models.js +181 -341
  192. package/dist/sync/mutationHandler.d.ts +5 -2
  193. package/dist/sync/mutationHandler.js +549 -697
  194. package/dist/sync/registrationSideEffects.js +41 -95
  195. package/dist/sync/registry.js +31 -47
  196. package/dist/sync/routes.d.ts +13 -0
  197. package/dist/sync/routes.js +484 -760
  198. package/dist/sync/scripts/compactTombstones.js +83 -228
  199. package/dist/sync/serialize.js +18 -58
  200. package/dist/sync/socketHandlers.d.ts +8 -2
  201. package/dist/sync/socketHandlers.js +271 -402
  202. package/dist/sync/streams.d.ts +2 -0
  203. package/dist/sync/streams.js +54 -116
  204. package/dist/sync/syncApp.d.ts +2 -1
  205. package/dist/sync/syncApp.js +14 -16
  206. package/dist/sync/syncBatch.d.ts +5 -2
  207. package/dist/sync/syncBatch.js +63 -168
  208. package/dist/sync/syncSeqPlugin.js +430 -702
  209. package/dist/sync/types.d.ts +18 -0
  210. package/dist/syncConsents.js +113 -253
  211. package/dist/terrenoApp.d.ts +29 -0
  212. package/dist/terrenoApp.js +184 -257
  213. package/dist/tests/createTestData.d.ts +1 -3
  214. package/dist/tests/createTestData.js +147 -259
  215. package/dist/tests/models.d.ts +1 -0
  216. package/dist/tests/models.js +23 -56
  217. package/dist/tests/mongoTestSetup.js +42 -103
  218. package/dist/tests/testHelper.d.ts +0 -5
  219. package/dist/tests/testHelper.js +32 -101
  220. package/dist/tests.js +12 -51
  221. package/dist/transformers.js +61 -164
  222. package/dist/types/authToken.d.ts +3 -3
  223. package/dist/types/mcpServiceToken.d.ts +2 -2
  224. package/dist/types/membership.d.ts +23 -0
  225. package/dist/types/membership.js +2 -0
  226. package/dist/types/notification.d.ts +28 -0
  227. package/dist/types/notification.js +2 -0
  228. package/dist/types/notificationPreference.d.ts +20 -0
  229. package/dist/types/notificationPreference.js +2 -0
  230. package/dist/types/organization.d.ts +36 -0
  231. package/dist/types/organization.js +2 -0
  232. package/dist/utils.js +31 -93
  233. package/dist/vendor/wesleytodd-openapi/index.js +37 -51
  234. package/dist/vendor/wesleytodd-openapi/lib/generate-doc.js +32 -40
  235. package/dist/vendor/wesleytodd-openapi/lib/layer-schema.js +3 -3
  236. package/dist/vendor/wesleytodd-openapi/lib/ui.js +50 -19
  237. package/dist/vendor/wesleytodd-openapi/lib/validate.js +19 -47
  238. package/dist/versionCheckPlugin.js +52 -100
  239. package/dist/webhooks/headerValue.js +2 -2
  240. package/dist/webhooks/idempotency/memoryStore.js +16 -59
  241. package/dist/webhooks/idempotency/mongoStore.js +55 -130
  242. package/dist/webhooks/idempotency/webhookReceipt.d.ts +4 -49
  243. package/dist/webhooks/idempotency/webhookReceipt.js +14 -14
  244. package/dist/webhooks/rawBody.d.ts +1 -0
  245. package/dist/webhooks/rawBody.js +2 -1
  246. package/dist/webhooks/timingSafeEqual.js +4 -5
  247. package/dist/webhooks/verifiers/hmac.js +17 -18
  248. package/dist/webhooks/verifiers/sendgrid.js +20 -22
  249. package/dist/webhooks/verifiers/stripe.js +31 -65
  250. package/dist/webhooks/verifiers/twilio.js +23 -73
  251. package/dist/webhooks/webhooksApp.js +78 -177
  252. package/dist/zodOpenApi.js +2 -2
  253. package/package.json +34 -28
  254. package/src/__snapshots__/openApi.test.ts.snap +192 -54
  255. package/src/__snapshots__/openApiBuilder.test.ts.snap +0 -18
  256. package/src/__snapshots__/schemaMetadata.test.ts.snap +0 -1
  257. package/src/__tests__/browserLogsRoute.test.ts +165 -0
  258. package/src/adminTypes.ts +8 -0
  259. package/src/api.test.ts +39 -2
  260. package/src/api.ts +68 -0
  261. package/src/audit/auditApp.test.ts +243 -0
  262. package/src/audit/auditApp.ts +139 -0
  263. package/src/audit/auditEventModel.ts +160 -0
  264. package/src/audit/auditRouter.test.ts +456 -0
  265. package/src/audit/cloudTasksEnqueue.test.ts +124 -0
  266. package/src/audit/cloudTasksEnqueue.ts +104 -0
  267. package/src/audit/diff.ts +163 -0
  268. package/src/audit/processQueue.ts +69 -0
  269. package/src/audit/rbacSink.test.ts +86 -0
  270. package/src/audit/rbacSink.ts +42 -0
  271. package/src/audit/record.test.ts +402 -0
  272. package/src/audit/record.ts +329 -0
  273. package/src/auth.test.ts +1 -1
  274. package/src/auth.ts +1 -1
  275. package/src/authRecovery.test.ts +43 -0
  276. package/src/authRecovery.ts +16 -10
  277. package/src/authTokens.ts +6 -2
  278. package/src/authVerification.test.ts +22 -0
  279. package/src/betterAuth.ts +7 -0
  280. package/src/betterAuthSetup.test.ts +27 -0
  281. package/src/betterAuthSetup.ts +1 -0
  282. package/src/browserLogsRoute.ts +110 -0
  283. package/src/collectionRegistry.test.ts +8 -9
  284. package/src/collectionRegistry.ts +21 -1
  285. package/src/configurationPlugin.test.ts +1 -11
  286. package/src/express.d.ts +2 -0
  287. package/src/expressServer.test.ts +50 -2
  288. package/src/expressServer.ts +10 -0
  289. package/src/frameworkModelNames.test.ts +62 -0
  290. package/src/frameworkModelNames.ts +33 -0
  291. package/src/index.ts +76 -0
  292. package/src/isolated/migrateCliConnect.isolated.ts +51 -0
  293. package/src/mcp/auth.test.ts +34 -1
  294. package/src/mcp/handlers.test.ts +275 -0
  295. package/src/mcp/query.ts +3 -3
  296. package/src/mcp/toolGenerator.test.ts +81 -0
  297. package/src/migrations/cli.test.ts +353 -0
  298. package/src/migrations/cli.ts +283 -0
  299. package/src/migrations/fixtures/all-down/20260910120000-one.ts +6 -0
  300. package/src/migrations/fixtures/all-down/20260910120001-two.ts +6 -0
  301. package/src/migrations/fixtures/bad-id/20260910120000-mismatch.ts +4 -0
  302. package/src/migrations/fixtures/bad-name/not-a-migration.ts +4 -0
  303. package/src/migrations/fixtures/missing-up/20260910120000-noup.ts +2 -0
  304. package/src/migrations/fixtures/valid/20260910120000-alpha.ts +4 -0
  305. package/src/migrations/fixtures/valid/20260910120001-beta.ts +6 -0
  306. package/src/migrations/generate.test.ts +333 -0
  307. package/src/migrations/generate.ts +216 -0
  308. package/src/migrations/load.test.ts +103 -0
  309. package/src/migrations/load.ts +124 -0
  310. package/src/migrations/lock.test.ts +133 -0
  311. package/src/migrations/lock.ts +118 -0
  312. package/src/migrations/runner.test.ts +504 -0
  313. package/src/migrations/runner.ts +358 -0
  314. package/src/migrations/schemaCatalog.test.ts +159 -0
  315. package/src/migrations/schemaCatalog.ts +262 -0
  316. package/src/migrations/types.ts +94 -0
  317. package/src/models/mcpServiceToken.ts +4 -3
  318. package/src/models/notification.ts +69 -0
  319. package/src/models/notificationPreference.ts +62 -0
  320. package/src/notifications/notificationService.ts +254 -0
  321. package/src/notifications/notificationsApp.test.ts +528 -0
  322. package/src/notifications/notificationsApp.ts +200 -0
  323. package/src/notifications/notificationsBeforeSend.ts +51 -0
  324. package/src/notifiers/slackNotifier.test.ts +186 -1
  325. package/src/notifiers/slackNotifier.ts +167 -8
  326. package/src/openApi.test.ts +0 -1
  327. package/src/openApi.ts +2 -1
  328. package/src/openApiBuilder.ts +14 -3
  329. package/src/openApiValidator.test.ts +221 -2
  330. package/src/openApiValidator.ts +218 -33
  331. package/src/orgs/orgAccessOptIn.test.ts +87 -0
  332. package/src/orgs/orgContext.test.ts +259 -0
  333. package/src/orgs/orgContext.ts +151 -0
  334. package/src/orgs/orgPermissions.test.ts +105 -0
  335. package/src/orgs/orgPermissions.ts +40 -0
  336. package/src/orgs/orgPlugin.test.ts +130 -0
  337. package/src/orgs/orgPlugin.ts +70 -0
  338. package/src/orgs/orgRbac.test.ts +267 -0
  339. package/src/orgs/orgSecurityDefects.test.ts +415 -0
  340. package/src/orgs/organizationModel.test.ts +205 -0
  341. package/src/orgs/organizationModel.ts +262 -0
  342. package/src/orgs/organizationSettings.test.ts +113 -0
  343. package/src/orgs/organizationSettings.ts +126 -0
  344. package/src/orgs/orgsApp.test.ts +382 -0
  345. package/src/orgs/orgsApp.ts +563 -0
  346. package/src/permissions.test.ts +62 -36
  347. package/src/permissions.ts +8 -30
  348. package/src/plugins.test.ts +5 -0
  349. package/src/plugins.ts +3 -0
  350. package/src/rateLimit/middleware.ts +1 -1
  351. package/src/rateLimit/mongoStore.ts +1 -0
  352. package/src/rateLimit/policies.ts +2 -2
  353. package/src/rateLimit/redisStore.ts +1 -0
  354. package/src/rbac/access.ts +11 -3
  355. package/src/rbac/membershipOrgAdminSource.ts +59 -0
  356. package/src/rbac/modelRouterAccess.ts +3 -0
  357. package/src/rbac/permissionUtils.test.ts +26 -5
  358. package/src/rbac/resolve.test.ts +34 -2
  359. package/src/rbac/resolve.ts +26 -7
  360. package/src/rbac/roleModel.test.ts +34 -1
  361. package/src/rbac/roleModel.ts +17 -1
  362. package/src/rbac/statements.test.ts +19 -0
  363. package/src/rbac/statements.ts +19 -1
  364. package/src/rbac/types.ts +5 -0
  365. package/src/realtime/changeStreamWatcher.ts +73 -33
  366. package/src/realtime/deprecation.ts +1 -0
  367. package/src/realtime/realtime.test.ts +357 -185
  368. package/src/realtime/realtimeApp.ts +2 -1
  369. package/src/schemaMetadata.test.ts +14 -0
  370. package/src/schemaMetadata.ts +5 -5
  371. package/src/sync/adminBroadcastConfig.test.ts +96 -0
  372. package/src/sync/adminBroadcastScope.test.ts +155 -0
  373. package/src/sync/adminBroadcastScope.ts +123 -0
  374. package/src/sync/adminWindowAccess.test.ts +57 -0
  375. package/src/sync/adminWindowAccess.ts +32 -0
  376. package/src/sync/adminWindowMutation.test.ts +450 -0
  377. package/src/sync/adminWindowMutation.ts +283 -0
  378. package/src/sync/executors.ts +33 -6
  379. package/src/sync/integration.test.ts +2 -2
  380. package/src/sync/mutationHandler.test.ts +277 -1
  381. package/src/sync/mutationHandler.ts +171 -29
  382. package/src/sync/registry.ts +4 -0
  383. package/src/sync/routes.ts +52 -8
  384. package/src/sync/socketHandlers.ts +154 -58
  385. package/src/sync/streams.ts +6 -0
  386. package/src/sync/sync.test.ts +3 -2
  387. package/src/sync/syncApp.ts +2 -1
  388. package/src/sync/syncBatch.ts +7 -2
  389. package/src/sync/syncRoutes.test.ts +297 -3
  390. package/src/sync/syncSocket.test.ts +229 -0
  391. package/src/sync/types.ts +20 -0
  392. package/src/terrenoApp.migrations.test.ts +114 -0
  393. package/src/terrenoApp.test.ts +41 -0
  394. package/src/terrenoApp.ts +97 -31
  395. package/src/tests/createTestData.ts +2 -2
  396. package/src/tests/models.ts +10 -2
  397. package/src/tests/testHelper.ts +1 -7
  398. package/src/types/authToken.ts +2 -4
  399. package/src/types/mcpServiceToken.ts +1 -7
  400. package/src/types/membership.ts +48 -0
  401. package/src/types/notification.ts +34 -0
  402. package/src/types/notificationPreference.ts +28 -0
  403. package/src/types/organization.ts +49 -0
  404. package/src/types.d.ts +1 -0
  405. package/src/webhooks/idempotency/webhookReceipt.ts +8 -10
  406. package/src/webhooks/rawBody.test.ts +33 -0
  407. package/src/webhooks/rawBody.ts +1 -0
  408. package/tsconfig.json +13 -54
  409. package/tsconfig.typedoc.json +4 -1
  410. package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.d.ts +0 -2
  411. package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
  412. package/src/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
@@ -0,0 +1,30 @@
1
+ import type express from "express";
2
+ import type { AdminContribution } from "../adminTypes";
3
+ import type { TerrenoPlugin } from "../terrenoPlugin";
4
+ import { type AuditEnqueue } from "./record";
5
+ export interface AuditAppOptions {
6
+ /**
7
+ * When set, persist is delegated (Cloud Tasks). Mongo is not written on the
8
+ * request process. Diffs still run inline so before/after is captured now.
9
+ */
10
+ enqueue?: AuditEnqueue;
11
+ /** Shared secret for POST on `processQueuePath`. Required when that path is set. */
12
+ processQueueSecret?: string;
13
+ /**
14
+ * Worker URL path Cloud Tasks should POST to. Defaults to `/internal/audit-events`
15
+ * when enqueue comes from env (`GCP_TASKS_AUDIT_QUEUE` + `AUDIT_TASKS_URL`).
16
+ */
17
+ processQueuePath?: string;
18
+ /** Mongo TTL in days. Omit or 0 = forever (no TTL index). */
19
+ retentionDays?: number;
20
+ }
21
+ export declare class AuditApp implements TerrenoPlugin {
22
+ private readonly options;
23
+ private readonly enqueue;
24
+ constructor(options?: AuditAppOptions);
25
+ getRetentionDays: () => number | undefined;
26
+ adminContribution(): AdminContribution;
27
+ register(app: express.Application): void;
28
+ private mountProcessQueue;
29
+ private resolveProcessQueuePath;
30
+ }
@@ -0,0 +1,114 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.AuditApp = void 0;
7
+ const mongoose_1 = __importDefault(require("mongoose"));
8
+ const api_1 = require("../api");
9
+ const logger_1 = require("../logger");
10
+ const permissions_1 = require("../permissions");
11
+ const auditEventModel_1 = require("./auditEventModel");
12
+ const cloudTasksEnqueue_1 = require("./cloudTasksEnqueue");
13
+ const processQueue_1 = require("./processQueue");
14
+ const record_1 = require("./record");
15
+ const DEFAULT_PROCESS_QUEUE_PATH = "/internal/audit-events";
16
+ class AuditApp {
17
+ options;
18
+ enqueue;
19
+ constructor(options = {}) {
20
+ this.options = options;
21
+ this.enqueue = options.enqueue ?? (0, cloudTasksEnqueue_1.auditEnqueueFromEnv)();
22
+ }
23
+ getRetentionDays = () => {
24
+ return this.options.retentionDays;
25
+ };
26
+ adminContribution() {
27
+ const model = (0, auditEventModel_1.createAuditEventModel)(mongoose_1.default.connection, {
28
+ retentionDays: this.options.retentionDays,
29
+ });
30
+ return {
31
+ models: [
32
+ {
33
+ admin: {
34
+ adminPermissions: {
35
+ create: [],
36
+ delete: [],
37
+ update: [],
38
+ },
39
+ defaultSort: "-created",
40
+ displayName: "Audit Log",
41
+ listFields: ["created", "verb", "modelName", "recordLabel", "actorId"],
42
+ readonlyFields: [
43
+ "actorId",
44
+ "after",
45
+ "before",
46
+ "created",
47
+ "modelName",
48
+ "operation",
49
+ "organizationId",
50
+ "recordId",
51
+ "recordLabel",
52
+ "source",
53
+ "updated",
54
+ "verb",
55
+ ],
56
+ recordTitleField: "recordLabel",
57
+ },
58
+ model,
59
+ permissions: {
60
+ create: [],
61
+ delete: [],
62
+ list: [permissions_1.Permissions.IsAdmin],
63
+ read: [permissions_1.Permissions.IsAdmin],
64
+ update: [],
65
+ },
66
+ routePath: "/audit-events",
67
+ },
68
+ ],
69
+ };
70
+ }
71
+ register(app) {
72
+ const model = (0, auditEventModel_1.createAuditEventModel)(mongoose_1.default.connection, {
73
+ retentionDays: this.options.retentionDays,
74
+ });
75
+ (0, record_1.installAuditRecorder)(model, { enqueue: this.enqueue });
76
+ const router = (0, api_1.modelRouter)(model, {
77
+ permissions: {
78
+ create: [],
79
+ delete: [],
80
+ list: [permissions_1.Permissions.IsAdmin],
81
+ read: [permissions_1.Permissions.IsAdmin],
82
+ update: [],
83
+ },
84
+ queryFields: ["actorId", "modelName", "organizationId", "recordId", "source", "verb"],
85
+ sort: "-created",
86
+ });
87
+ app.use("/audit-events", router);
88
+ this.mountProcessQueue(app);
89
+ }
90
+ mountProcessQueue = (app) => {
91
+ const path = this.resolveProcessQueuePath();
92
+ if (!path) {
93
+ return;
94
+ }
95
+ const secret = this.options.processQueueSecret ?? process.env.AUDIT_TASKS_SECRET;
96
+ if (!secret) {
97
+ logger_1.logger.error("AuditApp processQueuePath requires processQueueSecret or AUDIT_TASKS_SECRET");
98
+ return;
99
+ }
100
+ app.post(path, (0, api_1.asyncHandler)(async (req, res) => {
101
+ return (0, processQueue_1.handleEnqueuedAuditWrite)({ req, res, secret });
102
+ }));
103
+ };
104
+ resolveProcessQueuePath = () => {
105
+ if (this.options.processQueuePath) {
106
+ return this.options.processQueuePath;
107
+ }
108
+ if (this.options.enqueue === undefined && this.enqueue) {
109
+ return DEFAULT_PROCESS_QUEUE_PATH;
110
+ }
111
+ return undefined;
112
+ };
113
+ }
114
+ exports.AuditApp = AuditApp;
@@ -0,0 +1,29 @@
1
+ import mongoose from "mongoose";
2
+ import { type FindExactlyOnePlugin, type FindOneOrNonePlugin } from "../plugins";
3
+ export type AuditEventVerb = "created" | "deleted" | "updated";
4
+ export type AuditEventSource = "admin" | "modelRouter" | "rbac";
5
+ export type AuditEventOperation = "arrayPush" | "arrayRemove" | "arrayUpdate" | "create" | "delete" | "update";
6
+ type AuditEventMethods = Record<string, never>;
7
+ interface AuditEventStatics extends FindExactlyOnePlugin<AuditEventDocument>, FindOneOrNonePlugin<AuditEventDocument> {
8
+ }
9
+ export interface AuditEventModel extends mongoose.Model<AuditEventDocument, object, AuditEventMethods>, AuditEventStatics {
10
+ }
11
+ export interface AuditEventDocument extends mongoose.Document {
12
+ _id: mongoose.Types.ObjectId;
13
+ actorId?: mongoose.Types.ObjectId;
14
+ after?: Record<string, unknown>;
15
+ before?: Record<string, unknown>;
16
+ created: Date;
17
+ modelName: string;
18
+ operation: AuditEventOperation;
19
+ organizationId?: string;
20
+ recordId?: string;
21
+ recordLabel?: string;
22
+ source: AuditEventSource;
23
+ updated: Date;
24
+ verb: AuditEventVerb;
25
+ }
26
+ export declare const createAuditEventModel: (connection: mongoose.Connection, options?: {
27
+ retentionDays?: number;
28
+ }) => AuditEventModel;
29
+ export {};
@@ -0,0 +1,101 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.createAuditEventModel = void 0;
7
+ const mongoose_1 = __importDefault(require("mongoose"));
8
+ const plugins_1 = require("../plugins");
9
+ const auditEventSchema = new mongoose_1.default.Schema({
10
+ actorId: {
11
+ description: "User who performed the mutation, when known",
12
+ index: true,
13
+ ref: "User",
14
+ type: mongoose_1.default.Schema.Types.ObjectId,
15
+ },
16
+ after: {
17
+ description: "Redacted changed fields after the mutation",
18
+ type: mongoose_1.default.Schema.Types.Mixed,
19
+ },
20
+ before: {
21
+ description: "Redacted changed fields before the mutation",
22
+ type: mongoose_1.default.Schema.Types.Mixed,
23
+ },
24
+ modelName: {
25
+ description: "Mongoose model name of the affected document",
26
+ index: true,
27
+ required: true,
28
+ trim: true,
29
+ type: String,
30
+ },
31
+ operation: {
32
+ description: "Fine-grained mutation kind",
33
+ enum: ["arrayPush", "arrayRemove", "arrayUpdate", "create", "delete", "update"],
34
+ required: true,
35
+ type: String,
36
+ },
37
+ organizationId: {
38
+ description: "Tenant organization id when known",
39
+ index: true,
40
+ type: String,
41
+ },
42
+ recordId: {
43
+ description: "Primary key of the affected document",
44
+ index: true,
45
+ type: String,
46
+ },
47
+ recordLabel: {
48
+ description: "Short human-readable label for the affected record",
49
+ trim: true,
50
+ type: String,
51
+ },
52
+ source: {
53
+ description: "Which framework surface wrote this event",
54
+ enum: ["admin", "modelRouter", "rbac"],
55
+ index: true,
56
+ required: true,
57
+ type: String,
58
+ },
59
+ verb: {
60
+ description: "Widget-compatible mutation verb",
61
+ enum: ["created", "deleted", "updated"],
62
+ index: true,
63
+ required: true,
64
+ type: String,
65
+ },
66
+ }, { strict: "throw", toJSON: { virtuals: true }, toObject: { virtuals: true } });
67
+ auditEventSchema.index({ created: -1 });
68
+ // Key order is the Mongo prefix (modelName, recordId), not alphabetical.
69
+ // biome-ignore assist/source/useSortedKeys: compound query prefix is modelName then recordId then created
70
+ auditEventSchema.index({ modelName: 1, recordId: 1, created: -1 });
71
+ auditEventSchema.plugin(plugins_1.createdUpdatedPlugin);
72
+ auditEventSchema.plugin(plugins_1.findOneOrNone);
73
+ auditEventSchema.plugin(plugins_1.findExactlyOne);
74
+ const ttlExpireAfterSeconds = (retentionDays) => {
75
+ if (retentionDays === undefined || retentionDays <= 0) {
76
+ return undefined;
77
+ }
78
+ return retentionDays * 86400;
79
+ };
80
+ /** createdUpdatedPlugin indexes `{created: 1}`. Put TTL on that same key pattern. */
81
+ const replaceCreatedIndexWithTtl = (schema, expireAfterSeconds) => {
82
+ const createdPath = schema.path("created");
83
+ if (!createdPath) {
84
+ schema.index({ created: 1 }, { expireAfterSeconds, name: "AuditEvent_created_ttl" });
85
+ return;
86
+ }
87
+ createdPath.options.index = { expireAfterSeconds };
88
+ createdPath._index = { expireAfterSeconds };
89
+ };
90
+ const createAuditEventModel = (connection, options = {}) => {
91
+ if (connection.models.TerrenoAuditEvent) {
92
+ return connection.models.TerrenoAuditEvent;
93
+ }
94
+ const schema = auditEventSchema.clone();
95
+ const expireAfterSeconds = ttlExpireAfterSeconds(options.retentionDays);
96
+ if (expireAfterSeconds !== undefined) {
97
+ replaceCreatedIndexWithTtl(schema, expireAfterSeconds);
98
+ }
99
+ return connection.model("TerrenoAuditEvent", schema, "auditevents");
100
+ };
101
+ exports.createAuditEventModel = createAuditEventModel;
@@ -0,0 +1,32 @@
1
+ import type { AuditEnqueue } from "./record";
2
+ interface CloudTasksClient {
3
+ createTask: (request: {
4
+ parent: string;
5
+ task: {
6
+ httpRequest: {
7
+ body: string;
8
+ headers: Record<string, string>;
9
+ httpMethod: "POST";
10
+ url: string;
11
+ };
12
+ };
13
+ }) => Promise<unknown>;
14
+ }
15
+ interface CloudTasksModule {
16
+ CloudTasksClient?: new () => CloudTasksClient;
17
+ default?: {
18
+ CloudTasksClient?: new () => CloudTasksClient;
19
+ };
20
+ }
21
+ export interface CloudTasksAuditEnqueueOptions {
22
+ location: string;
23
+ project: string;
24
+ queue: string;
25
+ secret: string;
26
+ url: string;
27
+ loadModule?: () => Promise<CloudTasksModule>;
28
+ }
29
+ declare const AUDIT_SECRET_HEADER = "X-Terreno-Audit-Secret";
30
+ export declare const createCloudTasksAuditEnqueue: (options: CloudTasksAuditEnqueueOptions) => AuditEnqueue;
31
+ export declare const auditEnqueueFromEnv: (env?: NodeJS.ProcessEnv) => AuditEnqueue | undefined;
32
+ export { AUDIT_SECRET_HEADER };
@@ -0,0 +1,69 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.AUDIT_SECRET_HEADER = exports.auditEnqueueFromEnv = exports.createCloudTasksAuditEnqueue = void 0;
4
+ const errors_1 = require("../errors");
5
+ const AUDIT_SECRET_HEADER = "X-Terreno-Audit-Secret";
6
+ exports.AUDIT_SECRET_HEADER = AUDIT_SECRET_HEADER;
7
+ const createCloudTasksAuditEnqueue = (options) => {
8
+ let client;
9
+ const loadModule = options.loadModule ??
10
+ (() => {
11
+ const moduleName = "@google-cloud/tasks";
12
+ return import(/* webpackIgnore: true */ moduleName);
13
+ });
14
+ const getClient = async () => {
15
+ if (client) {
16
+ return client;
17
+ }
18
+ let mod;
19
+ try {
20
+ mod = await loadModule();
21
+ }
22
+ catch {
23
+ throw new errors_1.APIError({
24
+ status: 500,
25
+ title: "Cloud Tasks audit enqueue requires @google-cloud/tasks. Install it with: bun add @google-cloud/tasks",
26
+ });
27
+ }
28
+ const Client = mod.CloudTasksClient ?? mod.default?.CloudTasksClient;
29
+ if (!Client) {
30
+ throw new errors_1.APIError({
31
+ status: 500,
32
+ title: "CloudTasksClient not found in @google-cloud/tasks module",
33
+ });
34
+ }
35
+ client = new Client();
36
+ return client;
37
+ };
38
+ return async (write) => {
39
+ const tasks = await getClient();
40
+ const parent = `projects/${options.project}/locations/${options.location}/queues/${options.queue}`;
41
+ await tasks.createTask({
42
+ parent,
43
+ task: {
44
+ httpRequest: {
45
+ body: Buffer.from(JSON.stringify(write), "utf8").toString("base64"),
46
+ headers: {
47
+ "Content-Type": "application/json",
48
+ [AUDIT_SECRET_HEADER]: options.secret,
49
+ },
50
+ httpMethod: "POST",
51
+ url: options.url,
52
+ },
53
+ },
54
+ });
55
+ };
56
+ };
57
+ exports.createCloudTasksAuditEnqueue = createCloudTasksAuditEnqueue;
58
+ const auditEnqueueFromEnv = (env = process.env) => {
59
+ const queue = env.GCP_TASKS_AUDIT_QUEUE;
60
+ const url = env.AUDIT_TASKS_URL;
61
+ const project = env.GCP_PROJECT;
62
+ const location = env.GCP_LOCATION;
63
+ const secret = env.AUDIT_TASKS_SECRET;
64
+ if (!queue || !url || !project || !location || !secret) {
65
+ return undefined;
66
+ }
67
+ return (0, exports.createCloudTasksAuditEnqueue)({ location, project, queue, secret, url });
68
+ };
69
+ exports.auditEnqueueFromEnv = auditEnqueueFromEnv;
@@ -0,0 +1,10 @@
1
+ export declare const toAuditPlain: (value: unknown) => Record<string, unknown> | undefined;
2
+ export declare const changedFieldDiff: ({ after, before, extraRedact, }: {
3
+ after?: Record<string, unknown>;
4
+ before?: Record<string, unknown>;
5
+ extraRedact?: string[];
6
+ }) => {
7
+ after?: Record<string, unknown>;
8
+ before?: Record<string, unknown>;
9
+ };
10
+ export declare const recordLabelFromDoc: (doc?: Record<string, unknown>) => string | undefined;
@@ -0,0 +1,140 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.recordLabelFromDoc = exports.changedFieldDiff = exports.toAuditPlain = void 0;
4
+ const DEFAULT_AUDIT_REDACT_SEGMENTS = [
5
+ "hash",
6
+ "password",
7
+ "refreshToken",
8
+ "salt",
9
+ "secret",
10
+ "token",
11
+ ];
12
+ const isPlainObject = (value) => {
13
+ return Boolean(value) && typeof value === "object" && !Array.isArray(value);
14
+ };
15
+ const DEFAULT_REDACT_LOWER = DEFAULT_AUDIT_REDACT_SEGMENTS.map((segment) => segment.toLowerCase());
16
+ /** Split camelCase / snake_case keys so `tokenHash` matches default `token` and `hash`. */
17
+ const fieldNameParts = (name) => {
18
+ return name
19
+ .replace(/([a-z0-9])([A-Z])/g, "$1 $2")
20
+ .replace(/([A-Z]+)([A-Z][a-z])/g, "$1 $2")
21
+ .split(/[^A-Za-z0-9]+/)
22
+ .filter((part) => part.length > 0)
23
+ .map((part) => part.toLowerCase());
24
+ };
25
+ const isRedactedSegment = (name, extraRedact = []) => {
26
+ const lower = name.toLowerCase();
27
+ const parts = fieldNameParts(name);
28
+ if (DEFAULT_REDACT_LOWER.includes(lower) ||
29
+ parts.some((part) => DEFAULT_REDACT_LOWER.includes(part))) {
30
+ return true;
31
+ }
32
+ return extraRedact.some((segment) => segment.toLowerCase() === lower);
33
+ };
34
+ const redactValue = (value, extraRedact) => {
35
+ if (Array.isArray(value)) {
36
+ return value.map((item) => redactValue(item, extraRedact));
37
+ }
38
+ if (isPlainObject(value)) {
39
+ return redactRecord(value, extraRedact);
40
+ }
41
+ return value;
42
+ };
43
+ const redactRecord = (input, extraRedact) => {
44
+ const out = {};
45
+ for (const [key, nested] of Object.entries(input)) {
46
+ if (isRedactedSegment(key, extraRedact)) {
47
+ continue;
48
+ }
49
+ out[key] = redactValue(nested, extraRedact);
50
+ }
51
+ return out;
52
+ };
53
+ const toAuditPlain = (value) => {
54
+ if (value === null || value === undefined) {
55
+ return undefined;
56
+ }
57
+ const withJson = value;
58
+ const raw = typeof withJson.toJSON === "function" ? withJson.toJSON() : value;
59
+ if (!isPlainObject(raw)) {
60
+ return undefined;
61
+ }
62
+ return JSON.parse(JSON.stringify(raw));
63
+ };
64
+ exports.toAuditPlain = toAuditPlain;
65
+ const valuesEqual = (left, right) => {
66
+ return JSON.stringify(left) === JSON.stringify(right);
67
+ };
68
+ const diffShallow = (before, after) => {
69
+ const beforeOut = {};
70
+ const afterOut = {};
71
+ const keys = new Set([...Object.keys(before), ...Object.keys(after)]);
72
+ for (const key of keys) {
73
+ const previous = before[key];
74
+ const next = after[key];
75
+ if (valuesEqual(previous, next)) {
76
+ continue;
77
+ }
78
+ if (previous !== undefined) {
79
+ beforeOut[key] = previous;
80
+ }
81
+ if (next !== undefined) {
82
+ afterOut[key] = next;
83
+ }
84
+ }
85
+ return { after: afterOut, before: beforeOut };
86
+ };
87
+ const changedFieldDiff = ({ after, before, extraRedact = [], }) => {
88
+ const redactedBefore = before ? redactRecord(before, extraRedact) : undefined;
89
+ const redactedAfter = after ? redactRecord(after, extraRedact) : undefined;
90
+ if (!redactedBefore) {
91
+ return redactedAfter ? { after: redactedAfter } : {};
92
+ }
93
+ if (!redactedAfter) {
94
+ return { before: redactedBefore };
95
+ }
96
+ const beforeOut = {};
97
+ const afterOut = {};
98
+ const keys = new Set([...Object.keys(redactedBefore), ...Object.keys(redactedAfter)]);
99
+ for (const key of keys) {
100
+ const previous = redactedBefore[key];
101
+ const next = redactedAfter[key];
102
+ if (isPlainObject(previous) && isPlainObject(next)) {
103
+ const nested = diffShallow(previous, next);
104
+ if (Object.keys(nested.before).length > 0) {
105
+ beforeOut[key] = nested.before;
106
+ }
107
+ if (Object.keys(nested.after).length > 0) {
108
+ afterOut[key] = nested.after;
109
+ }
110
+ continue;
111
+ }
112
+ if (valuesEqual(previous, next)) {
113
+ continue;
114
+ }
115
+ if (previous !== undefined) {
116
+ beforeOut[key] = previous;
117
+ }
118
+ if (next !== undefined) {
119
+ afterOut[key] = next;
120
+ }
121
+ }
122
+ return {
123
+ ...(Object.keys(afterOut).length > 0 ? { after: afterOut } : {}),
124
+ ...(Object.keys(beforeOut).length > 0 ? { before: beforeOut } : {}),
125
+ };
126
+ };
127
+ exports.changedFieldDiff = changedFieldDiff;
128
+ const recordLabelFromDoc = (doc) => {
129
+ if (!doc) {
130
+ return undefined;
131
+ }
132
+ for (const field of ["title", "name", "email"]) {
133
+ const value = doc[field];
134
+ if (typeof value === "string" && value.length > 0) {
135
+ return value;
136
+ }
137
+ }
138
+ return undefined;
139
+ };
140
+ exports.recordLabelFromDoc = recordLabelFromDoc;
@@ -0,0 +1,6 @@
1
+ import type { Request, Response } from "express";
2
+ export declare const handleEnqueuedAuditWrite: ({ req, res, secret, }: {
3
+ req: Request;
4
+ res: Response;
5
+ secret: string;
6
+ }) => Promise<Response>;
@@ -0,0 +1,56 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.handleEnqueuedAuditWrite = void 0;
4
+ const node_crypto_1 = require("node:crypto");
5
+ const errors_1 = require("../errors");
6
+ const cloudTasksEnqueue_1 = require("./cloudTasksEnqueue");
7
+ const record_1 = require("./record");
8
+ const secretsMatch = (provided, expected) => {
9
+ if (!provided) {
10
+ return false;
11
+ }
12
+ const left = Buffer.from(provided);
13
+ const right = Buffer.from(expected);
14
+ if (left.length !== right.length) {
15
+ return false;
16
+ }
17
+ return (0, node_crypto_1.timingSafeEqual)(left, right);
18
+ };
19
+ const isAuditEventWrite = (value) => {
20
+ if (!value || typeof value !== "object") {
21
+ return false;
22
+ }
23
+ const record = value;
24
+ const validOperations = [
25
+ "arrayPush",
26
+ "arrayRemove",
27
+ "arrayUpdate",
28
+ "create",
29
+ "delete",
30
+ "update",
31
+ ];
32
+ const validSources = ["admin", "modelRouter", "rbac"];
33
+ const validVerbs = ["created", "deleted", "updated"];
34
+ return (typeof record.modelName === "string" &&
35
+ record.modelName.length > 0 &&
36
+ typeof record.operation === "string" &&
37
+ validOperations.includes(record.operation) &&
38
+ typeof record.source === "string" &&
39
+ validSources.includes(record.source) &&
40
+ typeof record.verb === "string" &&
41
+ validVerbs.includes(record.verb));
42
+ };
43
+ const handleEnqueuedAuditWrite = async ({ req, res, secret, }) => {
44
+ const provided = req.header(cloudTasksEnqueue_1.AUDIT_SECRET_HEADER);
45
+ if (!secretsMatch(provided, secret)) {
46
+ throw new errors_1.APIError({ status: 401, title: "Unauthorized" });
47
+ }
48
+ if (!isAuditEventWrite(req.body)) {
49
+ // Cloud Tasks retries every non-2xx response. This authenticated task cannot
50
+ // become valid on retry, so acknowledge it rather than retrying it forever.
51
+ return res.status(204).end();
52
+ }
53
+ await (0, record_1.persistEnqueuedAuditEvent)(req.body);
54
+ return res.status(204).end();
55
+ };
56
+ exports.handleEnqueuedAuditWrite = handleEnqueuedAuditWrite;
@@ -0,0 +1,2 @@
1
+ import type { RbacAuditWrite } from "../rbac/auditModel";
2
+ export declare const persistRbacAuditToAuditEvent: (record: RbacAuditWrite) => Promise<void>;
@@ -0,0 +1,41 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.persistRbacAuditToAuditEvent = void 0;
4
+ const record_1 = require("./record");
5
+ const RBAC_AUDIT_VERBS = {
6
+ "role.create": "created",
7
+ "role.remove": "deleted",
8
+ };
9
+ const operationFromVerb = (verb) => {
10
+ if (verb === "created") {
11
+ return "create";
12
+ }
13
+ if (verb === "deleted") {
14
+ return "delete";
15
+ }
16
+ return "update";
17
+ };
18
+ const persistRbacAuditToAuditEvent = async (record) => {
19
+ const mappedVerb = RBAC_AUDIT_VERBS[record.action];
20
+ const verb = record.denied || !mappedVerb ? "updated" : mappedVerb;
21
+ const after = {
22
+ action: record.action,
23
+ denied: record.denied ?? false,
24
+ };
25
+ if (record.permissionDelta?.gained) {
26
+ after.gained = record.permissionDelta.gained;
27
+ }
28
+ const before = record.permissionDelta?.lost ? { lost: record.permissionDelta.lost } : undefined;
29
+ void (0, record_1.recordAuditEvent)({
30
+ actorId: (0, record_1.actorIdForAuditWrite)(record.actorId),
31
+ after,
32
+ before,
33
+ modelName: record.targetRoleName ? "RbacRole" : "User",
34
+ operation: operationFromVerb(verb),
35
+ recordId: record.targetUserId ?? record.targetRoleName,
36
+ recordLabel: record.targetRoleName ?? record.targetUserId,
37
+ source: "rbac",
38
+ verb,
39
+ });
40
+ };
41
+ exports.persistRbacAuditToAuditEvent = persistRbacAuditToAuditEvent;