@terreno/api 57.2.0 → 57.4.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 (472) hide show
  1. package/.ai/skills/mongoose-schema-safety/SKILL.md +23 -10
  2. package/README.md +23 -7
  3. package/dist/actions.js +19 -7
  4. package/dist/adminTypes.d.ts +7 -0
  5. package/dist/adminTypes.js +6 -1
  6. package/dist/api.d.ts +14 -0
  7. package/dist/api.js +111 -60
  8. package/dist/audit/auditApp.d.ts +30 -0
  9. package/dist/audit/auditApp.js +155 -0
  10. package/dist/audit/auditEventModel.d.ts +29 -0
  11. package/dist/audit/auditEventModel.js +102 -0
  12. package/dist/audit/cloudTasksEnqueue.d.ts +32 -0
  13. package/dist/audit/cloudTasksEnqueue.js +162 -0
  14. package/dist/audit/diff.d.ts +10 -0
  15. package/dist/audit/diff.js +230 -0
  16. package/dist/audit/processQueue.d.ts +6 -0
  17. package/dist/audit/processQueue.js +101 -0
  18. package/dist/audit/rbacSink.d.ts +2 -0
  19. package/dist/audit/rbacSink.js +82 -0
  20. package/dist/audit/record.d.ts +56 -0
  21. package/dist/audit/record.js +373 -0
  22. package/dist/auth.d.ts +23 -10
  23. package/dist/auth.js +97 -32
  24. package/dist/authRecovery.d.ts +5 -0
  25. package/dist/authRecovery.js +350 -0
  26. package/dist/authTokens.d.ts +8 -0
  27. package/dist/authTokens.js +162 -0
  28. package/dist/betterAuth.d.ts +39 -0
  29. package/dist/betterAuthApp.d.ts +4 -0
  30. package/dist/betterAuthApp.js +26 -8
  31. package/dist/betterAuthSetup.d.ts +44 -2
  32. package/dist/betterAuthSetup.js +288 -18
  33. package/dist/collectionRegistry.d.ts +40 -0
  34. package/dist/collectionRegistry.js +97 -0
  35. package/dist/configurationApp.d.ts +11 -2
  36. package/dist/configurationApp.js +2 -4
  37. package/dist/docLoader.js +35 -6
  38. package/dist/expressServer.d.ts +26 -3
  39. package/dist/expressServer.js +79 -11
  40. package/dist/index.d.ts +42 -1
  41. package/dist/index.js +84 -2
  42. package/dist/mcp/auth.d.ts +1 -0
  43. package/dist/mcp/auth.js +47 -25
  44. package/dist/mcp/handlers.d.ts +1 -1
  45. package/dist/mcp/handlers.js +67 -233
  46. package/dist/mcp/query.d.ts +2 -15
  47. package/dist/mcp/query.js +8 -8
  48. package/dist/mcp/registry.d.ts +1 -5
  49. package/dist/mcp/registry.js +31 -20
  50. package/dist/mcp/schemaGenerator.d.ts +2 -7
  51. package/dist/mcp/schemaGenerator.js +41 -116
  52. package/dist/mcp/server.d.ts +1 -0
  53. package/dist/mcp/server.js +1 -0
  54. package/dist/mcp/serviceTokens.d.ts +16 -0
  55. package/dist/mcp/serviceTokens.js +345 -0
  56. package/dist/mcp/types.d.ts +2 -2
  57. package/dist/migrations/fixtures/all-down/20260910120000-one.d.ts +4 -0
  58. package/dist/migrations/fixtures/all-down/20260910120000-one.js +49 -0
  59. package/dist/migrations/fixtures/all-down/20260910120001-two.d.ts +4 -0
  60. package/dist/migrations/fixtures/all-down/20260910120001-two.js +49 -0
  61. package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.d.ts +3 -0
  62. package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.js +45 -0
  63. package/dist/migrations/fixtures/bad-name/not-a-migration.d.ts +3 -0
  64. package/dist/migrations/fixtures/bad-name/not-a-migration.js +45 -0
  65. package/dist/migrations/fixtures/missing-up/20260910120000-noup.d.ts +2 -0
  66. package/dist/migrations/fixtures/missing-up/20260910120000-noup.js +5 -0
  67. package/dist/migrations/fixtures/valid/20260910120000-alpha.d.ts +3 -0
  68. package/dist/migrations/fixtures/valid/20260910120000-alpha.js +45 -0
  69. package/dist/migrations/fixtures/valid/20260910120001-beta.d.ts +4 -0
  70. package/dist/migrations/fixtures/valid/20260910120001-beta.js +49 -0
  71. package/dist/migrations/generate.d.ts +17 -0
  72. package/dist/migrations/generate.js +277 -0
  73. package/dist/migrations/load.d.ts +20 -0
  74. package/dist/migrations/load.js +236 -0
  75. package/dist/migrations/lock.d.ts +13 -0
  76. package/dist/migrations/lock.js +145 -0
  77. package/dist/migrations/runner.d.ts +42 -0
  78. package/dist/migrations/runner.js +503 -0
  79. package/dist/migrations/schemaCatalog.d.ts +44 -0
  80. package/dist/migrations/schemaCatalog.js +326 -0
  81. package/dist/migrations/types.d.ts +87 -0
  82. package/dist/migrations/types.js +7 -0
  83. package/dist/models/mcpServiceToken.d.ts +3 -0
  84. package/dist/models/mcpServiceToken.js +208 -0
  85. package/dist/models/notification.d.ts +2 -0
  86. package/dist/models/notification.js +62 -0
  87. package/dist/models/notificationPreference.d.ts +2 -0
  88. package/dist/models/notificationPreference.js +49 -0
  89. package/dist/notifications/notificationService.d.ts +40 -0
  90. package/dist/notifications/notificationService.js +323 -0
  91. package/dist/notifications/notificationsApp.d.ts +18 -0
  92. package/dist/notifications/notificationsApp.js +250 -0
  93. package/dist/notifications/notificationsBeforeSend.d.ts +14 -0
  94. package/dist/notifications/notificationsBeforeSend.js +77 -0
  95. package/dist/openApi.d.ts +1 -7
  96. package/dist/openApi.js +7 -6
  97. package/dist/openApiBuilder.d.ts +19 -7
  98. package/dist/openApiBuilder.js +61 -8
  99. package/dist/openApiCompat.js +1 -1
  100. package/dist/openApiValidator.d.ts +13 -1
  101. package/dist/openApiValidator.js +200 -38
  102. package/dist/orgs/orgContext.d.ts +23 -0
  103. package/dist/orgs/orgContext.js +198 -0
  104. package/dist/orgs/orgPermissions.d.ts +4 -0
  105. package/dist/orgs/orgPermissions.js +77 -0
  106. package/dist/orgs/orgPlugin.d.ts +13 -0
  107. package/dist/orgs/orgPlugin.js +84 -0
  108. package/dist/orgs/organizationModel.d.ts +13 -0
  109. package/dist/orgs/organizationModel.js +301 -0
  110. package/dist/orgs/organizationSettings.d.ts +19 -0
  111. package/dist/orgs/organizationSettings.js +120 -0
  112. package/dist/orgs/orgsApp.d.ts +28 -0
  113. package/dist/orgs/orgsApp.js +678 -0
  114. package/dist/permissions.d.ts +7 -13
  115. package/dist/permissions.js +8 -31
  116. package/dist/plugins.d.ts +14 -1
  117. package/dist/plugins.js +17 -6
  118. package/dist/populate.d.ts +2 -2
  119. package/dist/populate.js +47 -42
  120. package/dist/rateLimit/applyTrustProxy.d.ts +3 -0
  121. package/dist/rateLimit/applyTrustProxy.js +17 -0
  122. package/dist/rateLimit/createStore.d.ts +2 -0
  123. package/dist/rateLimit/createStore.js +28 -0
  124. package/dist/rateLimit/memoryStore.d.ts +2 -0
  125. package/dist/rateLimit/memoryStore.js +108 -0
  126. package/dist/rateLimit/middleware.d.ts +3 -0
  127. package/dist/rateLimit/middleware.js +109 -0
  128. package/dist/rateLimit/mongoStore.d.ts +4 -0
  129. package/dist/rateLimit/mongoStore.js +123 -0
  130. package/dist/rateLimit/policies.d.ts +10 -0
  131. package/dist/rateLimit/policies.js +149 -0
  132. package/dist/rateLimit/redisStore.d.ts +4 -0
  133. package/dist/rateLimit/redisStore.js +156 -0
  134. package/dist/rateLimit/types.d.ts +54 -0
  135. package/dist/rateLimit/types.js +9 -0
  136. package/dist/rbac/access.js +35 -14
  137. package/dist/rbac/assertAllowed.d.ts +9 -0
  138. package/dist/rbac/assertAllowed.js +182 -0
  139. package/dist/rbac/membershipOrgAdminSource.d.ts +6 -0
  140. package/dist/rbac/membershipOrgAdminSource.js +122 -0
  141. package/dist/rbac/modelRouterAccess.d.ts +4 -0
  142. package/dist/rbac/modelRouterAccess.js +11 -4
  143. package/dist/rbac/permissionUtils.js +3 -2
  144. package/dist/rbac/resolve.js +65 -35
  145. package/dist/rbac/roleModel.d.ts +2 -5
  146. package/dist/rbac/roleModel.js +18 -4
  147. package/dist/rbac/routes.js +15 -6
  148. package/dist/rbac/statements.d.ts +10 -1
  149. package/dist/rbac/statements.js +19 -2
  150. package/dist/rbac/types.d.ts +5 -0
  151. package/dist/realtime/changeStreamWatcher.d.ts +10 -4
  152. package/dist/realtime/changeStreamWatcher.js +110 -64
  153. package/dist/realtime/deprecation.d.ts +13 -0
  154. package/dist/realtime/deprecation.js +33 -0
  155. package/dist/realtime/realtimeApp.d.ts +2 -1
  156. package/dist/realtime/realtimeApp.js +11 -11
  157. package/dist/realtime/registry.d.ts +0 -31
  158. package/dist/realtime/registry.js +44 -31
  159. package/dist/realtime/socketAuth.d.ts +5 -5
  160. package/dist/realtime/socketAuth.js +11 -1
  161. package/dist/realtime/socketUser.d.ts +5 -1
  162. package/dist/realtime/types.d.ts +14 -4
  163. package/dist/schemaMetadata.d.ts +56 -0
  164. package/dist/schemaMetadata.js +524 -0
  165. package/dist/seedRunner.d.ts +88 -0
  166. package/dist/seedRunner.js +627 -0
  167. package/dist/sync/adminBroadcastScope.d.ts +40 -0
  168. package/dist/sync/adminBroadcastScope.js +194 -0
  169. package/dist/sync/adminWindowAccess.d.ts +13 -0
  170. package/dist/sync/adminWindowAccess.js +96 -0
  171. package/dist/sync/adminWindowMutation.d.ts +88 -0
  172. package/dist/sync/adminWindowMutation.js +247 -0
  173. package/dist/sync/executors.d.ts +19 -3
  174. package/dist/sync/executors.js +194 -165
  175. package/dist/sync/loadHarness.js +28 -19
  176. package/dist/sync/models.js +26 -24
  177. package/dist/sync/mutationHandler.d.ts +14 -2
  178. package/dist/sync/mutationHandler.js +201 -76
  179. package/dist/sync/registrationSideEffects.d.ts +35 -0
  180. package/dist/sync/registrationSideEffects.js +151 -0
  181. package/dist/sync/registry.d.ts +2 -52
  182. package/dist/sync/registry.js +42 -187
  183. package/dist/sync/routes.d.ts +13 -0
  184. package/dist/sync/routes.js +116 -58
  185. package/dist/sync/scripts/compactTombstones.js +0 -2
  186. package/dist/sync/socketHandlers.d.ts +8 -2
  187. package/dist/sync/socketHandlers.js +144 -50
  188. package/dist/sync/streams.d.ts +2 -0
  189. package/dist/sync/streams.js +7 -1
  190. package/dist/sync/syncApp.d.ts +4 -3
  191. package/dist/sync/syncApp.js +5 -4
  192. package/dist/sync/syncBatch.d.ts +5 -2
  193. package/dist/sync/syncBatch.js +7 -6
  194. package/dist/sync/syncSeqPlugin.d.ts +1 -1
  195. package/dist/sync/syncSeqPlugin.js +20 -16
  196. package/dist/sync/types.d.ts +18 -0
  197. package/dist/terrenoApp.d.ts +48 -5
  198. package/dist/terrenoApp.js +157 -72
  199. package/dist/tests/createTestData.d.ts +1 -3
  200. package/dist/tests/createTestData.js +3 -5
  201. package/dist/tests/models.d.ts +3 -0
  202. package/dist/tests/models.js +15 -2
  203. package/dist/tests/testHelper.d.ts +0 -5
  204. package/dist/tests/testHelper.js +2 -9
  205. package/dist/types/authToken.d.ts +33 -0
  206. package/dist/types/authToken.js +2 -0
  207. package/dist/types/mcpServiceToken.d.ts +41 -0
  208. package/dist/types/mcpServiceToken.js +2 -0
  209. package/dist/types/membership.d.ts +23 -0
  210. package/dist/types/membership.js +2 -0
  211. package/dist/types/notification.d.ts +28 -0
  212. package/dist/types/notification.js +2 -0
  213. package/dist/types/notificationPreference.d.ts +20 -0
  214. package/dist/types/notificationPreference.js +2 -0
  215. package/dist/types/organization.d.ts +36 -0
  216. package/dist/types/organization.js +2 -0
  217. package/dist/webhooks/headerValue.d.ts +2 -0
  218. package/dist/webhooks/headerValue.js +14 -0
  219. package/dist/webhooks/idempotency/memoryStore.d.ts +10 -0
  220. package/dist/webhooks/idempotency/memoryStore.js +65 -0
  221. package/dist/webhooks/idempotency/mongoStore.d.ts +4 -0
  222. package/dist/webhooks/idempotency/mongoStore.js +150 -0
  223. package/dist/webhooks/idempotency/webhookReceipt.d.ts +17 -0
  224. package/dist/webhooks/idempotency/webhookReceipt.js +39 -0
  225. package/dist/webhooks/rawBody.d.ts +15 -0
  226. package/dist/webhooks/rawBody.js +23 -0
  227. package/dist/webhooks/timingSafeEqual.d.ts +4 -0
  228. package/dist/webhooks/timingSafeEqual.js +17 -0
  229. package/dist/webhooks/verifiers/hmac.d.ts +15 -0
  230. package/dist/webhooks/verifiers/hmac.js +49 -0
  231. package/dist/webhooks/verifiers/sendgrid.d.ts +10 -0
  232. package/dist/webhooks/verifiers/sendgrid.js +56 -0
  233. package/dist/webhooks/verifiers/stripe.d.ts +9 -0
  234. package/dist/webhooks/verifiers/stripe.js +99 -0
  235. package/dist/webhooks/verifiers/twilio.d.ts +9 -0
  236. package/dist/webhooks/verifiers/twilio.js +112 -0
  237. package/dist/webhooks/webhooksApp.d.ts +33 -0
  238. package/dist/webhooks/webhooksApp.js +195 -0
  239. package/package.json +32 -27
  240. package/src/__snapshots__/openApi.test.ts.snap +444 -36
  241. package/src/__snapshots__/openApiBuilder.test.ts.snap +24 -24
  242. package/src/__snapshots__/schemaMetadata.test.ts.snap +196 -0
  243. package/src/actions.ts +20 -13
  244. package/src/adminModelRouter.test.ts +133 -0
  245. package/src/adminTypes.ts +8 -0
  246. package/src/api.arrayOperations.test.ts +43 -31
  247. package/src/api.hooks.test.ts +38 -29
  248. package/src/api.query.test.ts +31 -31
  249. package/src/api.test.ts +133 -97
  250. package/src/api.ts +84 -27
  251. package/src/audit/auditApp.test.ts +243 -0
  252. package/src/audit/auditApp.ts +139 -0
  253. package/src/audit/auditEventModel.ts +156 -0
  254. package/src/audit/auditRouter.test.ts +456 -0
  255. package/src/audit/cloudTasksEnqueue.test.ts +124 -0
  256. package/src/audit/cloudTasksEnqueue.ts +104 -0
  257. package/src/audit/diff.ts +163 -0
  258. package/src/audit/processQueue.ts +69 -0
  259. package/src/audit/rbacSink.test.ts +86 -0
  260. package/src/audit/rbacSink.ts +42 -0
  261. package/src/audit/record.test.ts +402 -0
  262. package/src/audit/record.ts +328 -0
  263. package/src/auth.test.ts +108 -52
  264. package/src/auth.ts +98 -29
  265. package/src/authRecovery.test.ts +281 -0
  266. package/src/authRecovery.ts +279 -0
  267. package/src/authTokens.test.ts +94 -0
  268. package/src/authTokens.ts +118 -0
  269. package/src/authVerification.test.ts +293 -0
  270. package/src/betterAuth.ts +31 -0
  271. package/src/betterAuthApp.test.ts +1 -0
  272. package/src/betterAuthApp.ts +27 -9
  273. package/src/betterAuthSetup.test.ts +595 -38
  274. package/src/betterAuthSetup.ts +261 -5
  275. package/src/collectionRegistry.test.ts +164 -0
  276. package/src/collectionRegistry.ts +135 -0
  277. package/src/configurationApp.ts +13 -7
  278. package/src/docLoader.test.ts +45 -1
  279. package/src/docLoader.ts +37 -6
  280. package/src/express.d.ts +3 -0
  281. package/src/expressServer.test.ts +180 -68
  282. package/src/expressServer.ts +75 -19
  283. package/src/githubAuth.test.ts +60 -55
  284. package/src/index.ts +127 -0
  285. package/src/mcp/auth.test.ts +47 -0
  286. package/src/mcp/auth.ts +32 -11
  287. package/src/mcp/handlers.test.ts +275 -0
  288. package/src/mcp/handlers.ts +45 -172
  289. package/src/mcp/integration.test.ts +59 -9
  290. package/src/mcp/query.ts +5 -7
  291. package/src/mcp/registry.ts +29 -20
  292. package/src/mcp/schemaGenerator.test.ts +8 -0
  293. package/src/mcp/schemaGenerator.ts +49 -131
  294. package/src/mcp/server.ts +2 -0
  295. package/src/mcp/serviceTokens.test.ts +330 -0
  296. package/src/mcp/serviceTokens.ts +307 -0
  297. package/src/mcp/toolGenerator.test.ts +82 -1
  298. package/src/mcp/types.ts +2 -6
  299. package/src/migrations/cli.test.ts +376 -0
  300. package/src/migrations/cli.ts +283 -0
  301. package/src/migrations/fixtures/all-down/20260910120000-one.ts +6 -0
  302. package/src/migrations/fixtures/all-down/20260910120001-two.ts +6 -0
  303. package/src/migrations/fixtures/bad-id/20260910120000-mismatch.ts +4 -0
  304. package/src/migrations/fixtures/bad-name/not-a-migration.ts +4 -0
  305. package/src/migrations/fixtures/missing-up/20260910120000-noup.ts +2 -0
  306. package/src/migrations/fixtures/valid/20260910120000-alpha.ts +4 -0
  307. package/src/migrations/fixtures/valid/20260910120001-beta.ts +6 -0
  308. package/src/migrations/generate.test.ts +333 -0
  309. package/src/migrations/generate.ts +216 -0
  310. package/src/migrations/load.test.ts +103 -0
  311. package/src/migrations/load.ts +124 -0
  312. package/src/migrations/lock.test.ts +133 -0
  313. package/src/migrations/lock.ts +118 -0
  314. package/src/migrations/runner.test.ts +504 -0
  315. package/src/migrations/runner.ts +358 -0
  316. package/src/migrations/schemaCatalog.test.ts +159 -0
  317. package/src/migrations/schemaCatalog.ts +262 -0
  318. package/src/migrations/types.ts +94 -0
  319. package/src/models/mcpServiceToken.test.ts +129 -0
  320. package/src/models/mcpServiceToken.ts +158 -0
  321. package/src/models/notification.ts +68 -0
  322. package/src/models/notificationPreference.ts +62 -0
  323. package/src/notifications/notificationService.ts +254 -0
  324. package/src/notifications/notificationsApp.test.ts +505 -0
  325. package/src/notifications/notificationsApp.ts +200 -0
  326. package/src/notifications/notificationsBeforeSend.ts +51 -0
  327. package/src/openApi.test.ts +80 -65
  328. package/src/openApi.ts +2 -1
  329. package/src/openApiBuilder.test.ts +95 -7
  330. package/src/openApiBuilder.ts +60 -12
  331. package/src/openApiCompat.ts +1 -1
  332. package/src/openApiValidator.test.ts +270 -56
  333. package/src/openApiValidator.ts +219 -36
  334. package/src/orgs/orgAccessOptIn.test.ts +87 -0
  335. package/src/orgs/orgContext.test.ts +259 -0
  336. package/src/orgs/orgContext.ts +151 -0
  337. package/src/orgs/orgPermissions.test.ts +105 -0
  338. package/src/orgs/orgPermissions.ts +40 -0
  339. package/src/orgs/orgPlugin.test.ts +130 -0
  340. package/src/orgs/orgPlugin.ts +70 -0
  341. package/src/orgs/orgRbac.test.ts +267 -0
  342. package/src/orgs/orgSecurityDefects.test.ts +415 -0
  343. package/src/orgs/organizationModel.test.ts +205 -0
  344. package/src/orgs/organizationModel.ts +257 -0
  345. package/src/orgs/organizationSettings.test.ts +113 -0
  346. package/src/orgs/organizationSettings.ts +126 -0
  347. package/src/orgs/orgsApp.test.ts +382 -0
  348. package/src/orgs/orgsApp.ts +563 -0
  349. package/src/permissions.test.ts +62 -36
  350. package/src/permissions.ts +8 -30
  351. package/src/plugins.test.ts +14 -0
  352. package/src/plugins.ts +34 -9
  353. package/src/populate.test.ts +34 -0
  354. package/src/populate.ts +40 -29
  355. package/src/rateLimit/applyTrustProxy.ts +17 -0
  356. package/src/rateLimit/createStore.ts +25 -0
  357. package/src/rateLimit/memoryStore.ts +40 -0
  358. package/src/rateLimit/middleware.ts +79 -0
  359. package/src/rateLimit/mongoStore.test.ts +80 -0
  360. package/src/rateLimit/mongoStore.ts +77 -0
  361. package/src/rateLimit/policies.ts +130 -0
  362. package/src/rateLimit/rateLimit.test.ts +328 -0
  363. package/src/rateLimit/redisStore.ioredis.test.ts +29 -0
  364. package/src/rateLimit/redisStore.test.ts +114 -0
  365. package/src/rateLimit/redisStore.ts +86 -0
  366. package/src/rateLimit/types.ts +64 -0
  367. package/src/rbac/access.ts +16 -4
  368. package/src/rbac/assertAllowed.test.ts +325 -0
  369. package/src/rbac/assertAllowed.ts +157 -0
  370. package/src/rbac/backfillAdmins.test.ts +124 -0
  371. package/src/rbac/fieldViews.test.ts +89 -0
  372. package/src/rbac/membershipOrgAdminSource.ts +59 -0
  373. package/src/rbac/modelRouterAccess.test.ts +126 -0
  374. package/src/rbac/modelRouterAccess.ts +8 -2
  375. package/src/rbac/permissionUtils.test.ts +26 -5
  376. package/src/rbac/permissionUtils.ts +3 -2
  377. package/src/rbac/realtimeAccess.test.ts +109 -1
  378. package/src/rbac/resolve.test.ts +34 -2
  379. package/src/rbac/resolve.ts +31 -11
  380. package/src/rbac/roleManager.test.ts +169 -0
  381. package/src/rbac/roleModel.test.ts +34 -1
  382. package/src/rbac/roleModel.ts +17 -1
  383. package/src/rbac/routes.test.ts +233 -0
  384. package/src/rbac/routes.ts +16 -6
  385. package/src/rbac/statements.test.ts +19 -0
  386. package/src/rbac/statements.ts +19 -1
  387. package/src/rbac/types.ts +5 -0
  388. package/src/realtime/changeStreamWatcher.ts +73 -33
  389. package/src/realtime/deprecation.test.ts +60 -0
  390. package/src/realtime/deprecation.ts +33 -0
  391. package/src/realtime/realtime.test.ts +365 -189
  392. package/src/realtime/realtimeApp.ts +11 -11
  393. package/src/realtime/realtimeAppSetup.test.ts +32 -5
  394. package/src/realtime/registry.ts +48 -42
  395. package/src/realtime/sessionRevalidation.test.ts +57 -44
  396. package/src/realtime/socketAuth.test.ts +75 -23
  397. package/src/realtime/socketAuth.ts +17 -6
  398. package/src/realtime/socketUser.ts +5 -3
  399. package/src/realtime/types.ts +14 -4
  400. package/src/schemaMetadata.test.ts +419 -0
  401. package/src/schemaMetadata.ts +593 -0
  402. package/src/scrubAdminFields.test.ts +105 -0
  403. package/src/seedRunner.test.ts +591 -0
  404. package/src/seedRunner.ts +464 -0
  405. package/src/sync/adminBroadcastConfig.test.ts +96 -0
  406. package/src/sync/adminBroadcastScope.test.ts +155 -0
  407. package/src/sync/adminBroadcastScope.ts +123 -0
  408. package/src/sync/adminWindowAccess.test.ts +57 -0
  409. package/src/sync/adminWindowAccess.ts +32 -0
  410. package/src/sync/adminWindowMutation.test.ts +450 -0
  411. package/src/sync/adminWindowMutation.ts +283 -0
  412. package/src/sync/docMatchesMutationData.test.ts +16 -0
  413. package/src/sync/ensureSyncIndexes.test.ts +54 -15
  414. package/src/sync/executors.test.ts +40 -0
  415. package/src/sync/executors.ts +57 -18
  416. package/src/sync/integration.test.ts +15 -7
  417. package/src/sync/loadHarness.ts +28 -19
  418. package/src/sync/models.ts +32 -18
  419. package/src/sync/mutationHandler.test.ts +293 -17
  420. package/src/sync/mutationHandler.ts +180 -36
  421. package/src/sync/registrationSideEffects.test.ts +126 -0
  422. package/src/sync/registrationSideEffects.ts +131 -0
  423. package/src/sync/registry.ts +49 -171
  424. package/src/sync/routes.ts +55 -10
  425. package/src/sync/scripts/compactTombstones.ts +0 -2
  426. package/src/sync/sessionRevalidationIntegration.test.ts +12 -11
  427. package/src/sync/socketHandlers.ts +154 -58
  428. package/src/sync/streams.ts +6 -0
  429. package/src/sync/sync.test.ts +28 -25
  430. package/src/sync/syncApp.ts +5 -4
  431. package/src/sync/syncBatch.ts +10 -4
  432. package/src/sync/syncFrontier.test.ts +17 -15
  433. package/src/sync/syncPhaseC.test.ts +54 -43
  434. package/src/sync/syncRoutes.test.ts +347 -38
  435. package/src/sync/syncSeqPlugin.ts +66 -44
  436. package/src/sync/syncSocket.test.ts +341 -81
  437. package/src/sync/types.ts +20 -0
  438. package/src/terrenoApp.mcpServiceTokens.test.ts +173 -0
  439. package/src/terrenoApp.migrations.test.ts +114 -0
  440. package/src/terrenoApp.test.ts +41 -0
  441. package/src/terrenoApp.ts +181 -46
  442. package/src/tests/createTestData.ts +2 -2
  443. package/src/tests/models.ts +24 -3
  444. package/src/tests/testHelper.ts +1 -7
  445. package/src/types/authToken.ts +41 -0
  446. package/src/types/mcpServiceToken.ts +48 -0
  447. package/src/types/membership.ts +48 -0
  448. package/src/types/notification.ts +34 -0
  449. package/src/types/notificationPreference.ts +28 -0
  450. package/src/types/organization.ts +49 -0
  451. package/src/webhooks/headerValue.test.ts +22 -0
  452. package/src/webhooks/headerValue.ts +12 -0
  453. package/src/webhooks/idempotency/memoryStore.ts +34 -0
  454. package/src/webhooks/idempotency/mongoStore.test.ts +274 -0
  455. package/src/webhooks/idempotency/mongoStore.ts +83 -0
  456. package/src/webhooks/idempotency/webhookReceipt.ts +67 -0
  457. package/src/webhooks/rawBody.test.ts +107 -0
  458. package/src/webhooks/rawBody.ts +24 -0
  459. package/src/webhooks/timingSafeEqual.ts +16 -0
  460. package/src/webhooks/verifiers/hmac.test.ts +110 -0
  461. package/src/webhooks/verifiers/hmac.ts +54 -0
  462. package/src/webhooks/verifiers/providerVerifiers.test.ts +388 -0
  463. package/src/webhooks/verifiers/sendgrid.ts +59 -0
  464. package/src/webhooks/verifiers/stripe.ts +67 -0
  465. package/src/webhooks/verifiers/twilio.ts +69 -0
  466. package/src/webhooks/webhooksApp.test.ts +221 -0
  467. package/src/webhooks/webhooksApp.ts +144 -0
  468. package/tsconfig.json +1 -1
  469. package/tsconfig.typedoc.json +2 -1
  470. package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.d.ts +0 -2
  471. package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
  472. package/src/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
package/src/api.ts CHANGED
@@ -17,7 +17,13 @@ import {
17
17
  } from "./actions";
18
18
  import {enrichModelRouterOptions, type ModelRouterBuildContext} from "./adminModelRouter";
19
19
  import type {AdminConfig} from "./adminTypes";
20
+ import {
21
+ type ModelRouterAuditConfig,
22
+ maybeRecordModelRouterAudit,
23
+ snapshotAuditBefore,
24
+ } from "./audit/record";
20
25
  import {authenticateMiddleware, omitUserRolesFromWriteBody, type User} from "./auth";
26
+ import {registerCollection, replaceCollectionOptions} from "./collectionRegistry";
21
27
  import {
22
28
  APIError,
23
29
  apiErrorMiddleware,
@@ -48,7 +54,7 @@ import {checkPermissions, permissionMiddleware, type RESTPermissions} from "./pe
48
54
  import type {PopulatePath} from "./populate";
49
55
  import {resolveModelRouterAccess, validateAccessWriteBody} from "./rbac/modelRouterAccess";
50
56
  import type {AnyTerrenoAccess, ModelRouterAccessOptions} from "./rbac/types";
51
- import {registerRealtime, updateRealtimeRegistryOptions} from "./realtime/registry";
57
+ import {warnRealtimeDeprecated} from "./realtime/deprecation";
52
58
  import type {RealtimeConfig} from "./realtime/types";
53
59
  import {
54
60
  type ExecutorConcurrencyCheck,
@@ -57,7 +63,6 @@ import {
57
63
  executeUpdate,
58
64
  isExecutorConflictError,
59
65
  } from "./sync/executors";
60
- import {registerSync, updateSyncRegistryOptions} from "./sync/registry";
61
66
  import type {SyncConfig} from "./sync/types";
62
67
  import {
63
68
  defaultResponseHandler,
@@ -302,6 +307,13 @@ export interface ModelRouterOptions<T> {
302
307
  * @param value - The document that was deleted, after the soft update of deleted: true (type: T).
303
308
  */
304
309
  postDelete?: (request: express.Request, value: T) => void | Promise<void>;
310
+ /**
311
+ * When true or `{redact}`, persist an `AuditEvent` after successful HTTP
312
+ * create/update/delete. Requires `AuditApp`. Extra `redact` names merge with
313
+ * the default secret segments (`password`, `hash`, `salt`, `token`, `secret`,
314
+ * `refreshToken`).
315
+ */
316
+ audit?: ModelRouterAuditConfig;
305
317
  /** Hook that runs after the object is fetched but before it is serialized.
306
318
  * Returns a promise so that asynchronous actions can be included in the function.
307
319
  * Throw an APIError to return a 400 with an error message.
@@ -388,11 +400,17 @@ export interface ModelRouterOptions<T> {
388
400
  * through the RealtimeApp plugin's change stream watcher.
389
401
  *
390
402
  * Requires the RealtimeApp plugin to be registered with TerrenoApp.
403
+ *
404
+ * @deprecated Removed in Terreno 58. Use `sync` with
405
+ * `@terreno/syncdb` instead. `RealtimeApp` remains required for sync sockets.
406
+ * See docs/how-to/migrate-rtk-to-syncdb.md.
391
407
  */
392
408
  realtime?: RealtimeConfig;
393
409
  /**
394
410
  * Enable local-first sync (@terreno/syncdb) for this model. Documents are scoped
395
411
  * into streams (owner/tenant/broadcast/custom) with monotonic per-stream cursors.
412
+ * Set `sync.adminBroadcast: true` to also emit `sync:delta` to `{collection}|admin`
413
+ * (default false; stored on the collection catalog at registration).
396
414
  *
397
415
  * Requires the schema to use `isDeletedPlugin` (soft delete tombstones) and
398
416
  * `syncPlugin` (per-stream `_syncSeq` stamping) — validated at registration.
@@ -576,6 +594,9 @@ const getBodyValidationMiddleware = <T>(
576
594
  validationOptions.excludeFields = excludeFields;
577
595
  }
578
596
  }
597
+ if (operation === "update") {
598
+ validationOptions.partial = true;
599
+ }
579
600
 
580
601
  return validateModelRequestBody(model, validationOptions);
581
602
  };
@@ -663,29 +684,19 @@ export function modelRouter<T>(
663
684
  options = modelOrOptions as ModelRouterOptions<T>;
664
685
  }
665
686
 
666
- // Register MCP before building so _buildModelRouter can replace options
667
- // with RBAC-resolved permissions (access+accessControl is not deferred).
668
- if (options.mcp) {
687
+ // Pathless MCP only — when a route path is present, registerCollection below
688
+ // owns the catalog entry and MCP shares that routePath key.
689
+ if (options.mcp && path === undefined) {
669
690
  registerMCPModel(model, options.mcp, options);
670
691
  }
671
692
 
672
693
  const shouldDeferBuild = path !== undefined && Boolean(options.access) && !options.accessControl;
673
694
 
674
695
  if (path !== undefined) {
675
- // Register before building so _buildModelRouter can replace options with
676
- // RBAC-resolved permissions (same contract as MCP).
677
696
  if (options.realtime) {
678
- registerRealtime({
679
- collectionName: model.collection.collectionName,
680
- config: options.realtime,
681
- modelName: model.modelName,
682
- options: options as unknown as ModelRouterOptions<unknown>,
683
- routePath: path,
684
- });
685
- }
686
- if (options.sync) {
687
- registerSync({config: options.sync, model, options, routePath: path});
697
+ warnRealtimeDeprecated(model.modelName, path);
688
698
  }
699
+ registerCollection({model, options, routePath: path});
689
700
  }
690
701
 
691
702
  const router = shouldDeferBuild ? express.Router() : _buildModelRouter(model, options, path);
@@ -703,12 +714,7 @@ export function modelRouter<T>(
703
714
  ...enrichedOptions,
704
715
  accessControl: enrichedOptions.accessControl ?? context.accessControl,
705
716
  };
706
- if (options.realtime) {
707
- updateRealtimeRegistryOptions(
708
- path,
709
- runtimeOptions as unknown as ModelRouterOptions<unknown>
710
- );
711
- }
717
+ replaceCollectionOptions(path, runtimeOptions as unknown as ModelRouterOptions<unknown>);
712
718
  return _buildModelRouter(model, runtimeOptions, path);
713
719
  },
714
720
  model,
@@ -719,6 +725,7 @@ export function modelRouter<T>(
719
725
  }
720
726
 
721
727
  if (options.realtime) {
728
+ warnRealtimeDeprecated(model.modelName);
722
729
  logger.warn(
723
730
  `modelRouter for ${model.modelName} has realtime config but was called without a path. ` +
724
731
  "Realtime sync only works with the three-argument form: modelRouter('/path', Model, options)"
@@ -757,12 +764,12 @@ const _buildModelRouter = <T>(
757
764
  options.responseHandler ??
758
765
  defaultResponseHandler) as ModelRouterOptions<T>["responseHandler"],
759
766
  };
767
+ if (routePath) {
768
+ replaceCollectionOptions(routePath, options as unknown as ModelRouterOptions<unknown>);
769
+ }
760
770
  if (options.mcp) {
761
771
  updateMCPRegistryOptions(model.modelName, options as unknown as ModelRouterOptions<unknown>);
762
772
  }
763
- if (options.sync && routePath) {
764
- updateSyncRegistryOptions(routePath, options as unknown as ModelRouterOptions<unknown>);
765
- }
766
773
 
767
774
  assertNoActionCollisions(model, options);
768
775
  registerActionRoutes(router, model, options);
@@ -795,6 +802,15 @@ const _buildModelRouter = <T>(
795
802
  req,
796
803
  user: req.user,
797
804
  });
805
+ void maybeRecordModelRouterAudit({
806
+ after: doc,
807
+ audit: options.audit,
808
+ modelName: model.modelName,
809
+ operation: "create",
810
+ recordId: String(doc._id),
811
+ req,
812
+ verb: "created",
813
+ });
798
814
  try {
799
815
  const serialized = await responseHandler(doc, "create", req, options);
800
816
  return res.status(201).json({data: serialized});
@@ -807,7 +823,6 @@ const _buildModelRouter = <T>(
807
823
  })
808
824
  );
809
825
 
810
- // TODO add rate limit
811
826
  router.get(
812
827
  "/",
813
828
  [
@@ -868,6 +883,11 @@ const _buildModelRouter = <T>(
868
883
  return res.json({data: []});
869
884
  }
870
885
  query = {...query, ...queryFilter};
886
+ for (const [key, value] of Object.entries(queryFilter)) {
887
+ if (value === undefined) {
888
+ delete query[key];
889
+ }
890
+ }
871
891
  }
872
892
 
873
893
  let limit = options.defaultLimit ?? 100;
@@ -1043,6 +1063,7 @@ const _buildModelRouter = <T>(
1043
1063
  }
1044
1064
 
1045
1065
  let doc: Document<unknown, unknown, unknown> & T;
1066
+ const previous = snapshotAuditBefore({audit: options.audit, doc: existingDoc});
1046
1067
  try {
1047
1068
  ({doc} = await executeUpdate<T>({
1048
1069
  body: req.body,
@@ -1072,6 +1093,17 @@ const _buildModelRouter = <T>(
1072
1093
  throw error;
1073
1094
  }
1074
1095
 
1096
+ void maybeRecordModelRouterAudit({
1097
+ after: doc,
1098
+ audit: options.audit,
1099
+ before: previous,
1100
+ modelName: model.modelName,
1101
+ operation: "update",
1102
+ recordId: String(doc._id),
1103
+ req,
1104
+ verb: "updated",
1105
+ });
1106
+
1075
1107
  try {
1076
1108
  const serialized = await responseHandler(doc, "update", req, options);
1077
1109
  return res.json({data: serialized});
@@ -1096,6 +1128,7 @@ const _buildModelRouter = <T>(
1096
1128
  req as Request & {obj: mongoose.Document & T & {deleted?: boolean}}
1097
1129
  ).obj;
1098
1130
 
1131
+ const previous = snapshotAuditBefore({audit: options.audit, doc: existingDoc});
1099
1132
  await executeDelete<T>({
1100
1133
  existingDoc,
1101
1134
  id: req.params.id as string,
@@ -1105,6 +1138,16 @@ const _buildModelRouter = <T>(
1105
1138
  user: req.user,
1106
1139
  });
1107
1140
 
1141
+ void maybeRecordModelRouterAudit({
1142
+ audit: options.audit,
1143
+ before: previous,
1144
+ modelName: model.modelName,
1145
+ operation: "delete",
1146
+ recordId: String(existingDoc._id),
1147
+ req,
1148
+ verb: "deleted",
1149
+ });
1150
+
1108
1151
  return res.status(204).json({});
1109
1152
  })
1110
1153
  );
@@ -1288,6 +1331,20 @@ const _buildModelRouter = <T>(
1288
1331
  });
1289
1332
  }
1290
1333
  }
1334
+
1335
+ const arrayAuditOperation =
1336
+ operation === "POST" ? "arrayPush" : operation === "PATCH" ? "arrayUpdate" : "arrayRemove";
1337
+ void maybeRecordModelRouterAudit({
1338
+ after: doc,
1339
+ audit: options.audit,
1340
+ before: prevDoc,
1341
+ modelName: model.modelName,
1342
+ operation: arrayAuditOperation,
1343
+ recordId: String(doc._id),
1344
+ req,
1345
+ verb: "updated",
1346
+ });
1347
+
1291
1348
  return res.json({
1292
1349
  data: serialize<T>(req, options, doc as unknown as Document<unknown, unknown, unknown> & T),
1293
1350
  });
@@ -0,0 +1,243 @@
1
+ import {afterEach, beforeEach, describe, it} from "bun:test";
2
+ import {assert} from "chai";
3
+ import type express from "express";
4
+ import mongoose from "mongoose";
5
+ import supertest from "supertest";
6
+
7
+ import type {UserModel as AuthUserModel} from "../auth";
8
+ import {TerrenoApp} from "../terrenoApp";
9
+ import {authAsUser, setupDb, UserModel} from "../tests";
10
+ import {AuditApp} from "./auditApp";
11
+ import {createAuditEventModel} from "./auditEventModel";
12
+ import {AUDIT_SECRET_HEADER} from "./cloudTasksEnqueue";
13
+ import {resetAuditRecorderForTests} from "./record";
14
+
15
+ const typedUserModel = UserModel as unknown as AuthUserModel;
16
+
17
+ const deleteAuditEventModel = (): void => {
18
+ if (mongoose.connection.models.AuditEvent) {
19
+ mongoose.connection.deleteModel("AuditEvent");
20
+ }
21
+ };
22
+
23
+ const fetchWorker = async (
24
+ app: express.Application,
25
+ {
26
+ body,
27
+ secret,
28
+ }: {
29
+ body: Record<string, unknown>;
30
+ secret: string;
31
+ }
32
+ ): Promise<supertest.Response> => {
33
+ return supertest(app).post("/internal/audit-events").set(AUDIT_SECRET_HEADER, secret).send(body);
34
+ };
35
+
36
+ describe("AuditApp", () => {
37
+ beforeEach(async () => {
38
+ deleteAuditEventModel();
39
+ resetAuditRecorderForTests();
40
+ await setupDb();
41
+ await mongoose.connection.collection("auditevents").deleteMany({});
42
+ });
43
+
44
+ afterEach(() => {
45
+ resetAuditRecorderForTests();
46
+ deleteAuditEventModel();
47
+ });
48
+
49
+ it("does not register AuditEvent on the default connection when @terreno/api is imported", async () => {
50
+ deleteAuditEventModel();
51
+ await import("../index");
52
+ assert.isUndefined(mongoose.connection.models.AuditEvent);
53
+ });
54
+
55
+ it("lets an admin list an empty audit log", async () => {
56
+ const app = new TerrenoApp({
57
+ skipListen: true,
58
+ userModel: typedUserModel,
59
+ })
60
+ .register(new AuditApp())
61
+ .build();
62
+ const agent = await authAsUser(app, "admin");
63
+
64
+ const res = await agent.get("/audit-events").expect(200);
65
+ assert.deepEqual(res.body.data, []);
66
+ assert.isUndefined(new AuditApp().getRetentionDays());
67
+ });
68
+
69
+ it("rejects a non-admin list", async () => {
70
+ const app = new TerrenoApp({
71
+ skipListen: true,
72
+ userModel: typedUserModel,
73
+ })
74
+ .register(new AuditApp())
75
+ .build();
76
+ const agent = await authAsUser(app, "notAdmin");
77
+
78
+ const res = await agent.get("/audit-events");
79
+ // modelRouter permissionMiddleware uses 405 when list permissions fail.
80
+ assert.equal(res.status, 405);
81
+ });
82
+
83
+ it("indexes created desc and modelName+recordId+created for per-record history", () => {
84
+ deleteAuditEventModel();
85
+ const model = createAuditEventModel(mongoose.connection);
86
+ const specs = model.schema.indexes().map(([fields]) => fields as Record<string, number>);
87
+ assert.isTrue(
88
+ specs.some((fields) => fields.created === -1 && Object.keys(fields).length === 1)
89
+ );
90
+ assert.isTrue(
91
+ specs.some(
92
+ (fields) => fields.modelName === 1 && fields.recordId === 1 && fields.created === -1
93
+ )
94
+ );
95
+ });
96
+
97
+ it("does not expose create, update, or delete", async () => {
98
+ const app = new TerrenoApp({
99
+ skipListen: true,
100
+ userModel: typedUserModel,
101
+ })
102
+ .register(new AuditApp())
103
+ .build();
104
+ const agent = await authAsUser(app, "admin");
105
+ const model = createAuditEventModel(mongoose.connection);
106
+ const row = await model.create({
107
+ modelName: "Todo",
108
+ operation: "create",
109
+ source: "modelRouter",
110
+ verb: "created",
111
+ });
112
+
113
+ const post = await agent.post("/audit-events").send({modelName: "Todo", verb: "created"});
114
+ const patch = await agent.patch(`/audit-events/${row._id}`).send({recordLabel: "x"});
115
+ const del = await agent.delete(`/audit-events/${row._id}`);
116
+ const read = await agent.get(`/audit-events/${row._id}`).expect(200);
117
+ assert.equal(read.body.data.modelName, "Todo");
118
+ assert.equal(post.status, 405);
119
+ assert.equal(patch.status, 405);
120
+ assert.equal(del.status, 405);
121
+ });
122
+
123
+ it("does not add a TTL index by default", () => {
124
+ deleteAuditEventModel();
125
+ createAuditEventModel(mongoose.connection);
126
+ const indexes = mongoose.connection.models.AuditEvent.schema.indexes();
127
+ assert.isFalse(indexes.some(([, options]) => options && "expireAfterSeconds" in options));
128
+ });
129
+
130
+ it("adds a TTL index on created when retentionDays is greater than 0", () => {
131
+ deleteAuditEventModel();
132
+ createAuditEventModel(mongoose.connection, {retentionDays: 1});
133
+ const indexes = mongoose.connection.models.AuditEvent.schema.indexes();
134
+ const createdAsc = indexes.filter(
135
+ ([fields]) => (fields as {created?: number}).created === 1 && Object.keys(fields).length === 1
136
+ );
137
+ const ttl = createdAsc[0];
138
+ assert.ok(ttl);
139
+ assert.equal((ttl[1] as {expireAfterSeconds?: number}).expireAfterSeconds, 86400);
140
+ });
141
+
142
+ it("disables admin create, update, and delete on the contribution", () => {
143
+ const contribution = new AuditApp({retentionDays: 90}).adminContribution();
144
+ assert.equal(new AuditApp({retentionDays: 90}).getRetentionDays(), 90);
145
+ assert.deepEqual(contribution.models?.[0]?.admin.adminPermissions, {
146
+ create: [],
147
+ delete: [],
148
+ update: [],
149
+ });
150
+ });
151
+
152
+ it("persists an enqueued write on POST /internal/audit-events", async () => {
153
+ const app = new TerrenoApp({
154
+ skipListen: true,
155
+ userModel: typedUserModel,
156
+ })
157
+ .register(
158
+ new AuditApp({
159
+ enqueue: async (): Promise<void> => {
160
+ throw new Error("must not enqueue from the worker");
161
+ },
162
+ processQueuePath: "/internal/audit-events",
163
+ processQueueSecret: "queue-secret",
164
+ })
165
+ )
166
+ .build();
167
+ const res = await fetchWorker(app, {
168
+ body: {
169
+ modelName: "Note",
170
+ operation: "create",
171
+ source: "modelRouter",
172
+ verb: "created",
173
+ },
174
+ secret: "queue-secret",
175
+ });
176
+ assert.equal(res.status, 204);
177
+ const count = await mongoose.connection.collection("auditevents").countDocuments();
178
+ assert.equal(count, 1);
179
+ });
180
+
181
+ it("rejects enqueued writes with a bad secret", async () => {
182
+ const app = new TerrenoApp({
183
+ skipListen: true,
184
+ userModel: typedUserModel,
185
+ })
186
+ .register(
187
+ new AuditApp({
188
+ enqueue: async (): Promise<void> => undefined,
189
+ processQueuePath: "/internal/audit-events",
190
+ processQueueSecret: "queue-secret",
191
+ })
192
+ )
193
+ .build();
194
+ const res = await fetchWorker(app, {
195
+ body: {modelName: "Note", operation: "create", source: "modelRouter", verb: "created"},
196
+ secret: "wrong",
197
+ });
198
+ assert.equal(res.status, 401);
199
+ });
200
+
201
+ it("acknowledges malformed enqueued writes without persisting them", async () => {
202
+ const app = new TerrenoApp({
203
+ skipListen: true,
204
+ userModel: typedUserModel,
205
+ })
206
+ .register(
207
+ new AuditApp({
208
+ enqueue: async (): Promise<void> => undefined,
209
+ processQueuePath: "/internal/audit-events",
210
+ processQueueSecret: "queue-secret",
211
+ })
212
+ )
213
+ .build();
214
+ const res = await fetchWorker(app, {
215
+ body: {modelName: "Note", operation: "create", source: "invalid", verb: "created"},
216
+ secret: "queue-secret",
217
+ });
218
+ assert.equal(res.status, 204);
219
+ assert.equal(await mongoose.connection.collection("auditevents").countDocuments(), 0);
220
+ });
221
+
222
+ it("rejects enqueued writes with no secret header", async () => {
223
+ const app = new TerrenoApp({
224
+ skipListen: true,
225
+ userModel: typedUserModel,
226
+ })
227
+ .register(
228
+ new AuditApp({
229
+ enqueue: async (): Promise<void> => undefined,
230
+ processQueuePath: "/internal/audit-events",
231
+ processQueueSecret: "queue-secret",
232
+ })
233
+ )
234
+ .build();
235
+ const res = await supertest(app).post("/internal/audit-events").send({
236
+ modelName: "Note",
237
+ operation: "create",
238
+ source: "modelRouter",
239
+ verb: "created",
240
+ });
241
+ assert.equal(res.status, 401);
242
+ });
243
+ });
@@ -0,0 +1,139 @@
1
+ import type express from "express";
2
+ import mongoose from "mongoose";
3
+
4
+ import type {AdminContribution} from "../adminTypes";
5
+ import {asyncHandler, modelRouter} from "../api";
6
+ import {logger} from "../logger";
7
+ import {Permissions} from "../permissions";
8
+ import type {TerrenoPlugin} from "../terrenoPlugin";
9
+ import {createAuditEventModel} from "./auditEventModel";
10
+ import {auditEnqueueFromEnv} from "./cloudTasksEnqueue";
11
+ import {handleEnqueuedAuditWrite} from "./processQueue";
12
+ import {type AuditEnqueue, installAuditRecorder} from "./record";
13
+
14
+ export interface AuditAppOptions {
15
+ /**
16
+ * When set, persist is delegated (Cloud Tasks). Mongo is not written on the
17
+ * request process. Diffs still run inline so before/after is captured now.
18
+ */
19
+ enqueue?: AuditEnqueue;
20
+ /** Shared secret for POST on `processQueuePath`. Required when that path is set. */
21
+ processQueueSecret?: string;
22
+ /**
23
+ * Worker URL path Cloud Tasks should POST to. Defaults to `/internal/audit-events`
24
+ * when enqueue comes from env (`GCP_TASKS_AUDIT_QUEUE` + `AUDIT_TASKS_URL`).
25
+ */
26
+ processQueuePath?: string;
27
+ /** Mongo TTL in days. Omit or 0 = forever (no TTL index). */
28
+ retentionDays?: number;
29
+ }
30
+
31
+ const DEFAULT_PROCESS_QUEUE_PATH = "/internal/audit-events";
32
+
33
+ export class AuditApp implements TerrenoPlugin {
34
+ private readonly options: AuditAppOptions;
35
+ private readonly enqueue: AuditEnqueue | undefined;
36
+
37
+ constructor(options: AuditAppOptions = {}) {
38
+ this.options = options;
39
+ this.enqueue = options.enqueue ?? auditEnqueueFromEnv();
40
+ }
41
+
42
+ getRetentionDays = (): number | undefined => {
43
+ return this.options.retentionDays;
44
+ };
45
+
46
+ adminContribution(): AdminContribution {
47
+ const model = createAuditEventModel(mongoose.connection, {
48
+ retentionDays: this.options.retentionDays,
49
+ });
50
+ return {
51
+ models: [
52
+ {
53
+ admin: {
54
+ adminPermissions: {
55
+ create: [],
56
+ delete: [],
57
+ update: [],
58
+ },
59
+ defaultSort: "-created",
60
+ displayName: "Audit Log",
61
+ listFields: ["created", "verb", "modelName", "recordLabel", "actorId"],
62
+ readonlyFields: [
63
+ "actorId",
64
+ "after",
65
+ "before",
66
+ "created",
67
+ "modelName",
68
+ "operation",
69
+ "organizationId",
70
+ "recordId",
71
+ "recordLabel",
72
+ "source",
73
+ "updated",
74
+ "verb",
75
+ ],
76
+ recordTitleField: "recordLabel",
77
+ },
78
+ model,
79
+ permissions: {
80
+ create: [],
81
+ delete: [],
82
+ list: [Permissions.IsAdmin],
83
+ read: [Permissions.IsAdmin],
84
+ update: [],
85
+ },
86
+ routePath: "/audit-events",
87
+ },
88
+ ],
89
+ };
90
+ }
91
+
92
+ register(app: express.Application): void {
93
+ const model = createAuditEventModel(mongoose.connection, {
94
+ retentionDays: this.options.retentionDays,
95
+ });
96
+ installAuditRecorder(model, {enqueue: this.enqueue});
97
+ const router = modelRouter(model, {
98
+ permissions: {
99
+ create: [],
100
+ delete: [],
101
+ list: [Permissions.IsAdmin],
102
+ read: [Permissions.IsAdmin],
103
+ update: [],
104
+ },
105
+ queryFields: ["actorId", "modelName", "organizationId", "recordId", "source", "verb"],
106
+ sort: "-created",
107
+ });
108
+ app.use("/audit-events", router);
109
+ this.mountProcessQueue(app);
110
+ }
111
+
112
+ private mountProcessQueue = (app: express.Application): void => {
113
+ const path = this.resolveProcessQueuePath();
114
+ if (!path) {
115
+ return;
116
+ }
117
+ const secret = this.options.processQueueSecret ?? process.env.AUDIT_TASKS_SECRET;
118
+ if (!secret) {
119
+ logger.error("AuditApp processQueuePath requires processQueueSecret or AUDIT_TASKS_SECRET");
120
+ return;
121
+ }
122
+ app.post(
123
+ path,
124
+ asyncHandler(async (req, res) => {
125
+ return handleEnqueuedAuditWrite({req, res, secret});
126
+ })
127
+ );
128
+ };
129
+
130
+ private resolveProcessQueuePath = (): string | undefined => {
131
+ if (this.options.processQueuePath) {
132
+ return this.options.processQueuePath;
133
+ }
134
+ if (this.options.enqueue === undefined && this.enqueue) {
135
+ return DEFAULT_PROCESS_QUEUE_PATH;
136
+ }
137
+ return undefined;
138
+ };
139
+ }