@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,456 @@
1
+ import {afterEach, beforeEach, describe, it, spyOn} from "bun:test";
2
+ import {assert} from "chai";
3
+ import type express from "express";
4
+ import mongoose from "mongoose";
5
+
6
+ import {modelRouter} from "../api";
7
+ import type {UserModel as AuthUserModel} from "../auth";
8
+ import {logger} from "../logger";
9
+ import {Permissions} from "../permissions";
10
+ import {createdUpdatedPlugin, findExactlyOne, findOneOrNone} from "../plugins";
11
+ import {TerrenoApp} from "../terrenoApp";
12
+ import {authAsUser, setupDb, UserModel} from "../tests";
13
+ import {AuditApp} from "./auditApp";
14
+ import {createAuditEventModel} from "./auditEventModel";
15
+ import {changedFieldDiff} from "./diff";
16
+ import {
17
+ flushAuditRecorderForTests,
18
+ maybeRecordAdminAudit,
19
+ maybeRecordModelRouterAudit,
20
+ resetAuditRecorderForTests,
21
+ } from "./record";
22
+
23
+ const typedUserModel = UserModel as unknown as AuthUserModel;
24
+
25
+ interface Note {
26
+ calories?: number;
27
+ organizationId?: string;
28
+ password?: string;
29
+ ssn?: string;
30
+ tags?: string[];
31
+ title: string;
32
+ }
33
+
34
+ const noteSchema = new mongoose.Schema<Note>(
35
+ {
36
+ calories: {description: "Calories", type: Number},
37
+ organizationId: {description: "Tenant organization id", type: String},
38
+ password: {description: "Secret password", type: String},
39
+ ssn: {description: "Social security number", type: String},
40
+ tags: {description: "Tags", type: [String]},
41
+ title: {description: "Note title", required: true, type: String},
42
+ },
43
+ {strict: "throw"}
44
+ );
45
+ noteSchema.plugin(createdUpdatedPlugin);
46
+ noteSchema.plugin(findOneOrNone);
47
+ noteSchema.plugin(findExactlyOne);
48
+
49
+ const deleteNamedModel = (name: string): void => {
50
+ if (mongoose.connection.models[name]) {
51
+ mongoose.connection.deleteModel(name);
52
+ }
53
+ };
54
+
55
+ const notePermissions = {
56
+ create: [Permissions.IsAuthenticated],
57
+ delete: [Permissions.IsAuthenticated],
58
+ list: [Permissions.IsAuthenticated],
59
+ read: [Permissions.IsAuthenticated],
60
+ update: [Permissions.IsAuthenticated],
61
+ };
62
+
63
+ const buildApp = (audit: true | {redact: string[]} = true): express.Application => {
64
+ const NoteModel = mongoose.model<Note>("Note", noteSchema);
65
+ const app = new TerrenoApp({
66
+ skipListen: true,
67
+ userModel: typedUserModel,
68
+ })
69
+ .register(new AuditApp())
70
+ .build();
71
+ app.use("/notes", modelRouter(NoteModel, {audit, permissions: notePermissions}));
72
+ return app;
73
+ };
74
+
75
+ describe("changedFieldDiff", () => {
76
+ it("redacts default secret segments case-insensitively", () => {
77
+ const diff = changedFieldDiff({
78
+ after: {password: "secret", title: "Hi", token: "abc"},
79
+ before: {password: "old", title: "Lo", token: "xyz"},
80
+ });
81
+ assert.deepEqual(diff, {after: {title: "Hi"}, before: {title: "Lo"}});
82
+ });
83
+
84
+ it("omits extra redact fields", () => {
85
+ const diff = changedFieldDiff({
86
+ after: {ssn: "999", title: "B"},
87
+ before: {ssn: "111", title: "A"},
88
+ extraRedact: ["ssn"],
89
+ });
90
+ assert.deepEqual(diff, {after: {title: "B"}, before: {title: "A"}});
91
+ });
92
+
93
+ it("redacts secret keys nested in objects and arrays", () => {
94
+ const diff = changedFieldDiff({
95
+ after: {
96
+ items: [{password: "x", title: "ok"}],
97
+ settings: {auth: {mode: "a", token: "t"}},
98
+ },
99
+ before: {
100
+ items: [{password: "y", title: "old"}],
101
+ settings: {auth: {mode: "b", token: "u"}},
102
+ },
103
+ });
104
+ assert.deepEqual(diff.after, {
105
+ items: [{title: "ok"}],
106
+ settings: {auth: {mode: "a"}},
107
+ });
108
+ assert.deepEqual(diff.before, {
109
+ items: [{title: "old"}],
110
+ settings: {auth: {mode: "b"}},
111
+ });
112
+ });
113
+
114
+ it("redacts compound secret keys such as tokenHash", () => {
115
+ const diff = changedFieldDiff({
116
+ after: {title: "New", tokenHash: "abc"},
117
+ before: {title: "Old", tokenHash: "xyz"},
118
+ });
119
+ assert.deepEqual(diff, {after: {title: "New"}, before: {title: "Old"}});
120
+ });
121
+
122
+ it("does not treat extra redact names as substrings", () => {
123
+ const diff = changedFieldDiff({
124
+ after: {lesson: "keep", ssn: "999"},
125
+ extraRedact: ["ssn"],
126
+ });
127
+ assert.equal(diff.after?.lesson, "keep");
128
+ assert.isUndefined(diff.after?.ssn);
129
+ });
130
+ });
131
+
132
+ describe("modelRouter audit", () => {
133
+ beforeEach(async () => {
134
+ resetAuditRecorderForTests();
135
+ deleteNamedModel("Note");
136
+ deleteNamedModel("TerrenoAuditEvent");
137
+ await setupDb();
138
+ await mongoose.connection.collection("auditevents").deleteMany({});
139
+ });
140
+
141
+ afterEach(() => {
142
+ resetAuditRecorderForTests();
143
+ deleteNamedModel("Note");
144
+ deleteNamedModel("TerrenoAuditEvent");
145
+ });
146
+
147
+ it("writes a create event with after only and strips secrets", async () => {
148
+ const app = buildApp();
149
+ const agent = await authAsUser(app, "notAdmin");
150
+ const created = await agent
151
+ .post("/notes")
152
+ .send({password: "hunter2", title: "Hello"})
153
+ .expect(201);
154
+ await flushAuditRecorderForTests();
155
+ const admin = await authAsUser(app, "admin");
156
+ const list = await admin.get("/audit-events").expect(200);
157
+ assert.equal(list.body.data.length, 1);
158
+ const event = list.body.data[0];
159
+ assert.equal(event.verb, "created");
160
+ assert.equal(event.operation, "create");
161
+ assert.equal(event.source, "modelRouter");
162
+ assert.equal(event.modelName, "Note");
163
+ assert.equal(event.recordId, created.body.data._id);
164
+ assert.equal(event.recordLabel, "Hello");
165
+ assert.equal(event.after.title, "Hello");
166
+ assert.isUndefined(event.before);
167
+ assert.isUndefined(event.after.password);
168
+ assert.isUndefined(event.organizationId);
169
+ });
170
+
171
+ it("PATCH title yields one event with before.title and after.title", async () => {
172
+ const app = buildApp();
173
+ const agent = await authAsUser(app, "notAdmin");
174
+ const created = await agent.post("/notes").send({calories: 1, title: "One"}).expect(201);
175
+ await agent.patch(`/notes/${created.body.data._id}`).send({title: "Two"}).expect(200);
176
+ await flushAuditRecorderForTests();
177
+ const admin = await authAsUser(app, "admin");
178
+ const list = await admin.get("/audit-events?verb=updated").expect(200);
179
+ assert.equal(list.body.data.length, 1);
180
+ const event = list.body.data[0];
181
+ assert.equal(event.before.title, "One");
182
+ assert.equal(event.after.title, "Two");
183
+ assert.isUndefined(event.before.calories);
184
+ assert.isUndefined(event.after.calories);
185
+ });
186
+
187
+ it("strips ssn when redact includes ssn", async () => {
188
+ const app = buildApp({redact: ["ssn"]});
189
+ const agent = await authAsUser(app, "notAdmin");
190
+ await agent.post("/notes").send({ssn: "123-45-6789", title: "Pii"}).expect(201);
191
+ await flushAuditRecorderForTests();
192
+ const admin = await authAsUser(app, "admin");
193
+ const list = await admin.get("/audit-events").expect(200);
194
+ assert.isUndefined(list.body.data[0].after.ssn);
195
+ assert.equal(list.body.data[0].after.title, "Pii");
196
+ });
197
+
198
+ it("delete has before only", async () => {
199
+ const app = buildApp();
200
+ const agent = await authAsUser(app, "notAdmin");
201
+ const created = await agent.post("/notes").send({title: "Gone"}).expect(201);
202
+ await agent.delete(`/notes/${created.body.data._id}`).expect(204);
203
+ await flushAuditRecorderForTests();
204
+ const admin = await authAsUser(app, "admin");
205
+ const list = await admin.get("/audit-events?verb=deleted").expect(200);
206
+ assert.equal(list.body.data.length, 1);
207
+ assert.equal(list.body.data[0].before.title, "Gone");
208
+ assert.isUndefined(list.body.data[0].after);
209
+ });
210
+
211
+ it("still returns 201 when the recorder throws", async () => {
212
+ const app = buildApp();
213
+ const model = createAuditEventModel(mongoose.connection);
214
+ const createSpy = spyOn(model, "create").mockImplementation(() => {
215
+ throw new Error("disk full");
216
+ });
217
+ const agent = await authAsUser(app, "notAdmin");
218
+ await agent.post("/notes").send({title: "Keep"}).expect(201);
219
+ await flushAuditRecorderForTests();
220
+ createSpy.mockRestore();
221
+ });
222
+
223
+ it("skips writes and logs once when AuditApp is omitted", async () => {
224
+ const errorSpy = spyOn(logger, "error").mockImplementation(() => logger);
225
+ const NoteModel = mongoose.model<Note>("Note", noteSchema);
226
+ const app = new TerrenoApp({
227
+ skipListen: true,
228
+ userModel: typedUserModel,
229
+ }).build();
230
+ app.use("/notes", modelRouter(NoteModel, {audit: true, permissions: notePermissions}));
231
+ const agent = await authAsUser(app, "notAdmin");
232
+ await agent.post("/notes").send({title: "A"}).expect(201);
233
+ await agent.post("/notes").send({title: "B"}).expect(201);
234
+ await flushAuditRecorderForTests();
235
+ assert.isUndefined(mongoose.connection.models.TerrenoAuditEvent);
236
+ const auditLogs = errorSpy.mock.calls.filter((call) =>
237
+ String(call[0]).includes("requires AuditApp")
238
+ );
239
+ assert.equal(auditLogs.length, 1);
240
+ errorSpy.mockRestore();
241
+ });
242
+
243
+ it("never writes an event for AuditEvent itself", async () => {
244
+ const app = new TerrenoApp({skipListen: true, userModel: typedUserModel})
245
+ .register(new AuditApp())
246
+ .build();
247
+ const model = createAuditEventModel(mongoose.connection);
248
+ const beforeCount = await model.countDocuments();
249
+ await maybeRecordModelRouterAudit({
250
+ after: {modelName: "Todo"},
251
+ audit: true,
252
+ modelName: "AuditEvent",
253
+ operation: "create",
254
+ recordId: "1",
255
+ req: {user: {id: new mongoose.Types.ObjectId().toString()}} as never,
256
+ verb: "created",
257
+ });
258
+ assert.equal(await model.countDocuments(), beforeCount);
259
+ const admin = await authAsUser(app, "admin");
260
+ const list = await admin.get("/audit-events").expect(200);
261
+ assert.equal(list.body.data.length, 0);
262
+ });
263
+
264
+ it("array push/update/remove each write one updated event with recordId", async () => {
265
+ const app = buildApp();
266
+ const agent = await authAsUser(app, "notAdmin");
267
+ const created = await agent
268
+ .post("/notes")
269
+ .send({tags: ["a"], title: "Tagged"})
270
+ .expect(201);
271
+ const id = created.body.data._id;
272
+
273
+ await agent.post(`/notes/${id}/tags`).send({tags: "b"}).expect(200);
274
+ await agent.patch(`/notes/${id}/tags/a`).send({tags: "alpha"}).expect(200);
275
+ await agent.delete(`/notes/${id}/tags/b`).expect(200);
276
+ await flushAuditRecorderForTests();
277
+
278
+ const admin = await authAsUser(app, "admin");
279
+ const list = await admin.get("/audit-events").expect(200);
280
+ const events = list.body.data.filter((row: {verb: string}) => row.verb === "updated");
281
+ assert.equal(events.length, 3);
282
+ const operations = events.map((row: {operation: string}) => row.operation).sort();
283
+ assert.deepEqual(operations, ["arrayPush", "arrayRemove", "arrayUpdate"].sort());
284
+ for (const event of events) {
285
+ assert.equal(event.recordId, id);
286
+ assert.equal(event.source, "modelRouter");
287
+ }
288
+ });
289
+
290
+ it("copies organizationId from the document", async () => {
291
+ const app = buildApp();
292
+ const agent = await authAsUser(app, "notAdmin");
293
+ await agent.post("/notes").send({organizationId: "org-doc", title: "Tenant"}).expect(201);
294
+ await flushAuditRecorderForTests();
295
+ const admin = await authAsUser(app, "admin");
296
+ const list = await admin.get("/audit-events").expect(200);
297
+ assert.equal(list.body.data[0].organizationId, "org-doc");
298
+ });
299
+
300
+ it("prefers req.organization over the document field", async () => {
301
+ const NoteModel = mongoose.model<Note>("Note", noteSchema);
302
+ const app = new TerrenoApp({
303
+ skipListen: true,
304
+ userModel: typedUserModel,
305
+ })
306
+ .register(new AuditApp())
307
+ .build();
308
+ app.use((req, _res, next) => {
309
+ (req as express.Request & {organization?: {id: string}}).organization = {id: "org-req"};
310
+ next();
311
+ });
312
+ app.use("/notes", modelRouter(NoteModel, {audit: true, permissions: notePermissions}));
313
+ const agent = await authAsUser(app, "notAdmin");
314
+ await agent.post("/notes").send({organizationId: "org-doc", title: "Both"}).expect(201);
315
+ await flushAuditRecorderForTests();
316
+ const admin = await authAsUser(app, "admin");
317
+ const list = await admin.get("/audit-events").expect(200);
318
+ assert.equal(list.body.data[0].organizationId, "org-req");
319
+ });
320
+
321
+ it("still updates when toJSON throws before the audit snapshot", async () => {
322
+ const throwSchema = new mongoose.Schema<{title: string}>(
323
+ {title: {description: "Title", required: true, type: String}},
324
+ {strict: "throw"}
325
+ );
326
+ throwSchema.plugin(createdUpdatedPlugin);
327
+ throwSchema.plugin(findOneOrNone);
328
+ throwSchema.plugin(findExactlyOne);
329
+ let shouldThrow = false;
330
+ throwSchema.set("toJSON", {
331
+ transform: (_doc, ret) => {
332
+ if (shouldThrow) {
333
+ throw new Error("circular");
334
+ }
335
+ return ret;
336
+ },
337
+ virtuals: true,
338
+ });
339
+ deleteNamedModel("ThrowNote");
340
+ const ThrowNote = mongoose.model<{title: string}>("ThrowNote", throwSchema);
341
+ const app = new TerrenoApp({
342
+ skipListen: true,
343
+ userModel: typedUserModel,
344
+ })
345
+ .register(new AuditApp())
346
+ .build();
347
+ app.use("/throw-notes", modelRouter(ThrowNote, {audit: true, permissions: notePermissions}));
348
+ const agent = await authAsUser(app, "notAdmin");
349
+ const created = await agent.post("/throw-notes").send({title: "Before"}).expect(201);
350
+ shouldThrow = true;
351
+ await agent.patch(`/throw-notes/${created.body.data._id}`).send({title: "After"});
352
+ const stored = await ThrowNote.findById(created.body.data._id).lean();
353
+ assert.equal(stored?.title, "After");
354
+ deleteNamedModel("ThrowNote");
355
+ });
356
+
357
+ it("returns 201 without waiting for enqueue to finish", async () => {
358
+ let release!: () => void;
359
+ const held = new Promise<void>((resolve) => {
360
+ release = resolve;
361
+ });
362
+ const queued: {modelName: string}[] = [];
363
+ const NoteModel = mongoose.model<Note>("Note", noteSchema);
364
+ const app = new TerrenoApp({
365
+ skipListen: true,
366
+ userModel: typedUserModel,
367
+ })
368
+ .register(
369
+ new AuditApp({
370
+ enqueue: async (write): Promise<void> => {
371
+ queued.push({modelName: write.modelName});
372
+ await held;
373
+ },
374
+ })
375
+ )
376
+ .build();
377
+ app.use("/notes", modelRouter(NoteModel, {audit: true, permissions: notePermissions}));
378
+ const agent = await authAsUser(app, "notAdmin");
379
+ await agent.post("/notes").send({title: "Async"}).expect(201);
380
+ assert.equal(queued.length, 1);
381
+ assert.equal(await mongoose.connection.collection("auditevents").countDocuments(), 0);
382
+ release();
383
+ await flushAuditRecorderForTests();
384
+ });
385
+ });
386
+
387
+ describe("maybeRecordAdminAudit", () => {
388
+ beforeEach(async () => {
389
+ deleteNamedModel("Note");
390
+ deleteNamedModel("TerrenoAuditEvent");
391
+ resetAuditRecorderForTests();
392
+ await setupDb();
393
+ await mongoose.connection.collection("auditevents").deleteMany({});
394
+ });
395
+
396
+ afterEach(() => {
397
+ resetAuditRecorderForTests();
398
+ deleteNamedModel("Note");
399
+ deleteNamedModel("TerrenoAuditEvent");
400
+ });
401
+
402
+ it("does not write when AuditApp is not registered", async () => {
403
+ await maybeRecordAdminAudit({
404
+ after: {_id: "1", name: "Nope"},
405
+ modelName: "Food",
406
+ req: {user: {_id: new mongoose.Types.ObjectId()}} as express.Request,
407
+ verb: "created",
408
+ });
409
+ const count = await mongoose.connection.collection("auditevents").countDocuments();
410
+ assert.equal(count, 0);
411
+ });
412
+
413
+ it("skips writing an event for the AuditEvent model", async () => {
414
+ const app = new TerrenoApp({
415
+ skipListen: true,
416
+ userModel: typedUserModel,
417
+ })
418
+ .register(new AuditApp())
419
+ .build();
420
+ assert.ok(app);
421
+ await maybeRecordAdminAudit({
422
+ after: {_id: "1", modelName: "Food"},
423
+ modelName: "AuditEvent",
424
+ req: {user: {_id: new mongoose.Types.ObjectId()}} as express.Request,
425
+ verb: "created",
426
+ });
427
+ const count = await mongoose.connection.collection("auditevents").countDocuments();
428
+ assert.equal(count, 0);
429
+ });
430
+
431
+ it("does not throw when toJSON fails after a mutation", async () => {
432
+ const app = new TerrenoApp({
433
+ skipListen: true,
434
+ userModel: typedUserModel,
435
+ })
436
+ .register(new AuditApp())
437
+ .build();
438
+ assert.ok(app);
439
+ const after = {
440
+ toJSON: (): never => {
441
+ throw new Error("circular");
442
+ },
443
+ };
444
+ await maybeRecordModelRouterAudit({
445
+ after,
446
+ audit: true,
447
+ modelName: "Note",
448
+ operation: "create",
449
+ recordId: "1",
450
+ req: {user: {_id: new mongoose.Types.ObjectId()}} as express.Request,
451
+ verb: "created",
452
+ });
453
+ const count = await mongoose.connection.collection("auditevents").countDocuments();
454
+ assert.equal(count, 0);
455
+ });
456
+ });
@@ -0,0 +1,124 @@
1
+ import {describe, it} from "bun:test";
2
+ import {assert} from "chai";
3
+
4
+ import {APIError} from "../errors";
5
+ import {auditEnqueueFromEnv, createCloudTasksAuditEnqueue} from "./cloudTasksEnqueue";
6
+ import type {AuditEventWrite} from "./record";
7
+
8
+ const sampleWrite: AuditEventWrite = {
9
+ modelName: "Note",
10
+ operation: "create",
11
+ source: "modelRouter",
12
+ verb: "created",
13
+ };
14
+
15
+ describe("createCloudTasksAuditEnqueue", () => {
16
+ it("POSTs the write to the queue URL with the shared secret", async () => {
17
+ const created: unknown[] = [];
18
+ const enqueue = createCloudTasksAuditEnqueue({
19
+ loadModule: async () => ({
20
+ CloudTasksClient: class {
21
+ createTask = async (request: unknown): Promise<void> => {
22
+ created.push(request);
23
+ };
24
+ },
25
+ }),
26
+ location: "us-central1",
27
+ project: "proj",
28
+ queue: "audit-queue",
29
+ secret: "s3cret",
30
+ url: "https://api.example.com/internal/audit-events",
31
+ });
32
+ await enqueue(sampleWrite);
33
+ await enqueue(sampleWrite);
34
+ assert.equal(created.length, 2);
35
+ const request = created[0] as {
36
+ parent: string;
37
+ task: {httpRequest: {body: string; headers: Record<string, string>; url: string}};
38
+ };
39
+ assert.equal(request.parent, "projects/proj/locations/us-central1/queues/audit-queue");
40
+ assert.equal(request.task.httpRequest.url, "https://api.example.com/internal/audit-events");
41
+ assert.equal(request.task.httpRequest.headers["X-Terreno-Audit-Secret"], "s3cret");
42
+ const payload = JSON.parse(
43
+ Buffer.from(request.task.httpRequest.body, "base64").toString("utf8")
44
+ ) as AuditEventWrite;
45
+ assert.equal(payload.modelName, "Note");
46
+ });
47
+
48
+ it("throws when @google-cloud/tasks cannot be loaded", async () => {
49
+ const enqueue = createCloudTasksAuditEnqueue({
50
+ loadModule: async () => {
51
+ throw new Error("not installed");
52
+ },
53
+ location: "us-central1",
54
+ project: "proj",
55
+ queue: "audit-queue",
56
+ secret: "s3cret",
57
+ url: "https://api.example.com/internal/audit-events",
58
+ });
59
+ try {
60
+ await enqueue(sampleWrite);
61
+ assert.fail("expected enqueue to throw");
62
+ } catch (error: unknown) {
63
+ assert.instanceOf(error, APIError);
64
+ assert.include((error as APIError).title, "@google-cloud/tasks");
65
+ }
66
+ });
67
+
68
+ it("throws when CloudTasksClient is missing from the module", async () => {
69
+ const enqueue = createCloudTasksAuditEnqueue({
70
+ loadModule: async () => ({}),
71
+ location: "us-central1",
72
+ project: "proj",
73
+ queue: "audit-queue",
74
+ secret: "s3cret",
75
+ url: "https://api.example.com/internal/audit-events",
76
+ });
77
+ try {
78
+ await enqueue(sampleWrite);
79
+ assert.fail("expected enqueue to throw");
80
+ } catch (error: unknown) {
81
+ assert.instanceOf(error, APIError);
82
+ assert.include((error as APIError).title, "CloudTasksClient not found");
83
+ }
84
+ });
85
+
86
+ it("wraps a missing default @google-cloud/tasks install", async () => {
87
+ const enqueue = createCloudTasksAuditEnqueue({
88
+ location: "us-central1",
89
+ project: "proj",
90
+ queue: "audit-queue",
91
+ secret: "s3cret",
92
+ url: "https://api.example.com/internal/audit-events",
93
+ });
94
+ try {
95
+ await enqueue(sampleWrite);
96
+ assert.fail("expected enqueue to throw");
97
+ } catch (error: unknown) {
98
+ assert.instanceOf(error, APIError);
99
+ }
100
+ });
101
+ });
102
+
103
+ describe("auditEnqueueFromEnv", () => {
104
+ it("returns undefined until project, location, queue, url, and secret are set", () => {
105
+ assert.isUndefined(auditEnqueueFromEnv({}));
106
+ assert.isUndefined(
107
+ auditEnqueueFromEnv({
108
+ AUDIT_TASKS_SECRET: "s",
109
+ AUDIT_TASKS_URL: "https://example.com/internal/audit-events",
110
+ GCP_LOCATION: "us-central1",
111
+ GCP_PROJECT: "proj",
112
+ })
113
+ );
114
+ assert.isDefined(
115
+ auditEnqueueFromEnv({
116
+ AUDIT_TASKS_SECRET: "s",
117
+ AUDIT_TASKS_URL: "https://example.com/internal/audit-events",
118
+ GCP_LOCATION: "us-central1",
119
+ GCP_PROJECT: "proj",
120
+ GCP_TASKS_AUDIT_QUEUE: "audit-q",
121
+ })
122
+ );
123
+ });
124
+ });
@@ -0,0 +1,104 @@
1
+ import {APIError} from "../errors";
2
+ import type {AuditEnqueue, AuditEventWrite} from "./record";
3
+
4
+ interface CloudTasksClient {
5
+ createTask: (request: {
6
+ parent: string;
7
+ task: {
8
+ httpRequest: {
9
+ body: string;
10
+ headers: Record<string, string>;
11
+ httpMethod: "POST";
12
+ url: string;
13
+ };
14
+ };
15
+ }) => Promise<unknown>;
16
+ }
17
+
18
+ interface CloudTasksModule {
19
+ CloudTasksClient?: new () => CloudTasksClient;
20
+ default?: {CloudTasksClient?: new () => CloudTasksClient};
21
+ }
22
+
23
+ export interface CloudTasksAuditEnqueueOptions {
24
+ location: string;
25
+ project: string;
26
+ queue: string;
27
+ secret: string;
28
+ url: string;
29
+ loadModule?: () => Promise<CloudTasksModule>;
30
+ }
31
+
32
+ const AUDIT_SECRET_HEADER = "X-Terreno-Audit-Secret";
33
+
34
+ export const createCloudTasksAuditEnqueue = (
35
+ options: CloudTasksAuditEnqueueOptions
36
+ ): AuditEnqueue => {
37
+ let client: CloudTasksClient | undefined;
38
+ const loadModule =
39
+ options.loadModule ??
40
+ (() => {
41
+ const moduleName = "@google-cloud/tasks";
42
+ return import(/* webpackIgnore: true */ moduleName);
43
+ });
44
+
45
+ const getClient = async (): Promise<CloudTasksClient> => {
46
+ if (client) {
47
+ return client;
48
+ }
49
+ let mod: CloudTasksModule;
50
+ try {
51
+ mod = await loadModule();
52
+ } catch {
53
+ throw new APIError({
54
+ status: 500,
55
+ title:
56
+ "Cloud Tasks audit enqueue requires @google-cloud/tasks. Install it with: bun add @google-cloud/tasks",
57
+ });
58
+ }
59
+ const Client = mod.CloudTasksClient ?? mod.default?.CloudTasksClient;
60
+ if (!Client) {
61
+ throw new APIError({
62
+ status: 500,
63
+ title: "CloudTasksClient not found in @google-cloud/tasks module",
64
+ });
65
+ }
66
+ client = new Client();
67
+ return client;
68
+ };
69
+
70
+ return async (write: AuditEventWrite): Promise<void> => {
71
+ const tasks = await getClient();
72
+ const parent = `projects/${options.project}/locations/${options.location}/queues/${options.queue}`;
73
+ await tasks.createTask({
74
+ parent,
75
+ task: {
76
+ httpRequest: {
77
+ body: Buffer.from(JSON.stringify(write), "utf8").toString("base64"),
78
+ headers: {
79
+ "Content-Type": "application/json",
80
+ [AUDIT_SECRET_HEADER]: options.secret,
81
+ },
82
+ httpMethod: "POST",
83
+ url: options.url,
84
+ },
85
+ },
86
+ });
87
+ };
88
+ };
89
+
90
+ export const auditEnqueueFromEnv = (
91
+ env: NodeJS.ProcessEnv = process.env
92
+ ): AuditEnqueue | undefined => {
93
+ const queue = env.GCP_TASKS_AUDIT_QUEUE;
94
+ const url = env.AUDIT_TASKS_URL;
95
+ const project = env.GCP_PROJECT;
96
+ const location = env.GCP_LOCATION;
97
+ const secret = env.AUDIT_TASKS_SECRET;
98
+ if (!queue || !url || !project || !location || !secret) {
99
+ return undefined;
100
+ }
101
+ return createCloudTasksAuditEnqueue({location, project, queue, secret, url});
102
+ };
103
+
104
+ export {AUDIT_SECRET_HEADER};