@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,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.TerrenoAuditEvent) {
19
+ mongoose.connection.deleteModel("TerrenoAuditEvent");
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.TerrenoAuditEvent);
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.TerrenoAuditEvent.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.TerrenoAuditEvent.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
+ }
@@ -0,0 +1,160 @@
1
+ import mongoose from "mongoose";
2
+
3
+ import {
4
+ createdUpdatedPlugin,
5
+ type FindExactlyOnePlugin,
6
+ type FindOneOrNonePlugin,
7
+ findExactlyOne,
8
+ findOneOrNone,
9
+ } from "../plugins";
10
+
11
+ export type AuditEventVerb = "created" | "deleted" | "updated";
12
+ export type AuditEventSource = "admin" | "modelRouter" | "rbac";
13
+ export type AuditEventOperation =
14
+ | "arrayPush"
15
+ | "arrayRemove"
16
+ | "arrayUpdate"
17
+ | "create"
18
+ | "delete"
19
+ | "update";
20
+
21
+ type AuditEventMethods = Record<string, never>;
22
+
23
+ interface AuditEventStatics
24
+ extends FindExactlyOnePlugin<AuditEventDocument>,
25
+ FindOneOrNonePlugin<AuditEventDocument> {}
26
+
27
+ export interface AuditEventModel
28
+ extends mongoose.Model<AuditEventDocument, object, AuditEventMethods>,
29
+ AuditEventStatics {}
30
+
31
+ type AuditEventSchema = mongoose.Schema<AuditEventDocument, AuditEventModel, AuditEventMethods>;
32
+
33
+ export interface AuditEventDocument extends mongoose.Document {
34
+ _id: mongoose.Types.ObjectId;
35
+ actorId?: mongoose.Types.ObjectId;
36
+ after?: Record<string, unknown>;
37
+ before?: Record<string, unknown>;
38
+ created: Date;
39
+ modelName: string;
40
+ operation: AuditEventOperation;
41
+ organizationId?: string;
42
+ recordId?: string;
43
+ recordLabel?: string;
44
+ source: AuditEventSource;
45
+ updated: Date;
46
+ verb: AuditEventVerb;
47
+ }
48
+
49
+ const auditEventSchema: AuditEventSchema = new mongoose.Schema<
50
+ AuditEventDocument,
51
+ AuditEventModel,
52
+ AuditEventMethods
53
+ >(
54
+ {
55
+ actorId: {
56
+ description: "User who performed the mutation, when known",
57
+ index: true,
58
+ ref: "User",
59
+ type: mongoose.Schema.Types.ObjectId,
60
+ },
61
+ after: {
62
+ description: "Redacted changed fields after the mutation",
63
+ type: mongoose.Schema.Types.Mixed,
64
+ },
65
+ before: {
66
+ description: "Redacted changed fields before the mutation",
67
+ type: mongoose.Schema.Types.Mixed,
68
+ },
69
+ modelName: {
70
+ description: "Mongoose model name of the affected document",
71
+ index: true,
72
+ required: true,
73
+ trim: true,
74
+ type: String,
75
+ },
76
+ operation: {
77
+ description: "Fine-grained mutation kind",
78
+ enum: ["arrayPush", "arrayRemove", "arrayUpdate", "create", "delete", "update"],
79
+ required: true,
80
+ type: String,
81
+ },
82
+ organizationId: {
83
+ description: "Tenant organization id when known",
84
+ index: true,
85
+ type: String,
86
+ },
87
+ recordId: {
88
+ description: "Primary key of the affected document",
89
+ index: true,
90
+ type: String,
91
+ },
92
+ recordLabel: {
93
+ description: "Short human-readable label for the affected record",
94
+ trim: true,
95
+ type: String,
96
+ },
97
+ source: {
98
+ description: "Which framework surface wrote this event",
99
+ enum: ["admin", "modelRouter", "rbac"],
100
+ index: true,
101
+ required: true,
102
+ type: String,
103
+ },
104
+ verb: {
105
+ description: "Widget-compatible mutation verb",
106
+ enum: ["created", "deleted", "updated"],
107
+ index: true,
108
+ required: true,
109
+ type: String,
110
+ },
111
+ },
112
+ {strict: "throw", toJSON: {virtuals: true}, toObject: {virtuals: true}}
113
+ );
114
+
115
+ auditEventSchema.index({created: -1});
116
+ // Key order is the Mongo prefix (modelName, recordId), not alphabetical.
117
+ // biome-ignore assist/source/useSortedKeys: compound query prefix is modelName then recordId then created
118
+ auditEventSchema.index({modelName: 1, recordId: 1, created: -1});
119
+ auditEventSchema.plugin(createdUpdatedPlugin);
120
+ auditEventSchema.plugin(findOneOrNone);
121
+ auditEventSchema.plugin(findExactlyOne);
122
+
123
+ const ttlExpireAfterSeconds = (retentionDays?: number): number | undefined => {
124
+ if (retentionDays === undefined || retentionDays <= 0) {
125
+ return undefined;
126
+ }
127
+ return retentionDays * 86400;
128
+ };
129
+
130
+ /** createdUpdatedPlugin indexes `{created: 1}`. Put TTL on that same key pattern. */
131
+ const replaceCreatedIndexWithTtl = (schema: mongoose.Schema, expireAfterSeconds: number): void => {
132
+ const createdPath = schema.path("created") as
133
+ | (mongoose.SchemaType & {_index?: unknown})
134
+ | undefined;
135
+ if (!createdPath) {
136
+ schema.index({created: 1}, {expireAfterSeconds, name: "AuditEvent_created_ttl"});
137
+ return;
138
+ }
139
+ createdPath.options.index = {expireAfterSeconds};
140
+ createdPath._index = {expireAfterSeconds};
141
+ };
142
+
143
+ export const createAuditEventModel = (
144
+ connection: mongoose.Connection,
145
+ options: {retentionDays?: number} = {}
146
+ ): AuditEventModel => {
147
+ if (connection.models.TerrenoAuditEvent) {
148
+ return connection.models.TerrenoAuditEvent as AuditEventModel;
149
+ }
150
+ const schema = auditEventSchema.clone();
151
+ const expireAfterSeconds = ttlExpireAfterSeconds(options.retentionDays);
152
+ if (expireAfterSeconds !== undefined) {
153
+ replaceCreatedIndexWithTtl(schema as unknown as mongoose.Schema, expireAfterSeconds);
154
+ }
155
+ return connection.model<AuditEventDocument, AuditEventModel>(
156
+ "TerrenoAuditEvent",
157
+ schema,
158
+ "auditevents"
159
+ );
160
+ };