@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
@@ -32,128 +32,47 @@ var __importStar = (this && this.__importStar) || (function () {
32
32
  return result;
33
33
  };
34
34
  })();
35
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
36
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
37
- return new (P || (P = Promise))(function (resolve, reject) {
38
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
39
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
40
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
41
- step((generator = generator.apply(thisArg, _arguments || [])).next());
42
- });
43
- };
44
- var __generator = (this && this.__generator) || function (thisArg, body) {
45
- var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
46
- return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
47
- function verb(n) { return function (v) { return step([n, v]); }; }
48
- function step(op) {
49
- if (f) throw new TypeError("Generator is already executing.");
50
- while (g && (g = 0, op[0] && (_ = 0)), _) try {
51
- if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
52
- if (y = 0, t) op = [op[0] & 2, t.value];
53
- switch (op[0]) {
54
- case 0: case 1: t = op; break;
55
- case 4: _.label++; return { value: op[1], done: false };
56
- case 5: _.label++; y = op[1]; op = [0]; continue;
57
- case 7: op = _.ops.pop(); _.trys.pop(); continue;
58
- default:
59
- if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
60
- if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
61
- if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
62
- if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
63
- if (t[2]) _.ops.pop();
64
- _.trys.pop(); continue;
65
- }
66
- op = body.call(thisArg, _);
67
- } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
68
- if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
69
- }
70
- };
71
- var __read = (this && this.__read) || function (o, n) {
72
- var m = typeof Symbol === "function" && o[Symbol.iterator];
73
- if (!m) return o;
74
- var i = m.call(o), r, ar = [], e;
75
- try {
76
- while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
77
- }
78
- catch (error) { e = { error: error }; }
79
- finally {
80
- try {
81
- if (r && !r.done && (m = i["return"])) m.call(i);
82
- }
83
- finally { if (e) throw e.error; }
84
- }
85
- return ar;
86
- };
87
- var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
88
- if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
89
- if (ar || !(i in from)) {
90
- if (!ar) ar = Array.prototype.slice.call(from, 0, i);
91
- ar[i] = from[i];
92
- }
93
- }
94
- return to.concat(ar || Array.prototype.slice.call(from));
95
- };
96
35
  var __importDefault = (this && this.__importDefault) || function (mod) {
97
36
  return (mod && mod.__esModule) ? mod : { "default": mod };
98
37
  };
99
38
  Object.defineProperty(exports, "__esModule", { value: true });
100
39
  exports.sendToGoogleChat = void 0;
101
- var Sentry = __importStar(require("@sentry/bun"));
102
- var axios_1 = __importDefault(require("axios"));
103
- var errors_1 = require("../errors");
104
- var logger_1 = require("../logger");
105
- var sendToGoogleChat = function (messageText_1) {
106
- var args_1 = [];
107
- for (var _i = 1; _i < arguments.length; _i++) {
108
- args_1[_i - 1] = arguments[_i];
40
+ const Sentry = __importStar(require("@sentry/bun"));
41
+ const axios_1 = __importDefault(require("axios"));
42
+ const errors_1 = require("../errors");
43
+ const logger_1 = require("../logger");
44
+ const sendToGoogleChat = async (messageText, { channel, shouldThrow = false, env } = {}) => {
45
+ const chatWebhooksString = process.env.GOOGLE_CHAT_WEBHOOKS;
46
+ if (!chatWebhooksString) {
47
+ const msg = "GOOGLE_CHAT_WEBHOOKS not set. Google Chat message not sent";
48
+ Sentry.captureException(new errors_1.APIError({ status: 500, title: msg }));
49
+ return;
50
+ }
51
+ const chatWebhooks = JSON.parse(chatWebhooksString ?? "{}");
52
+ const chatChannel = channel ?? "default";
53
+ const chatWebhookUrl = chatWebhooks[chatChannel] ?? chatWebhooks.default;
54
+ if (!chatWebhookUrl) {
55
+ const msg = `No webhook url set in env for ${chatChannel}. Google Chat message not sent`;
56
+ Sentry.captureException(new errors_1.APIError({ status: 500, title: msg }));
57
+ return;
58
+ }
59
+ let formattedMessageText = messageText;
60
+ if (env) {
61
+ formattedMessageText = `[${env.toUpperCase()}] ${messageText}`;
62
+ }
63
+ try {
64
+ await axios_1.default.post(chatWebhookUrl, { text: formattedMessageText });
65
+ }
66
+ catch (error) {
67
+ const message = (0, errors_1.errorMessage)(error);
68
+ logger_1.logger.error(`Error posting to Google Chat: ${message}`);
69
+ Sentry.captureException(error);
70
+ if (shouldThrow) {
71
+ throw new errors_1.APIError({
72
+ status: 500,
73
+ title: `Error posting to Google Chat: ${message}`,
74
+ });
75
+ }
109
76
  }
110
- return __awaiter(void 0, __spreadArray([messageText_1], __read(args_1), false), void 0, function (messageText, _a) {
111
- var chatWebhooksString, msg, chatWebhooks, chatChannel, chatWebhookUrl, msg, formattedMessageText, error_1, message;
112
- var _b;
113
- var _c = _a === void 0 ? {} : _a, channel = _c.channel, _d = _c.shouldThrow, shouldThrow = _d === void 0 ? false : _d, env = _c.env;
114
- return __generator(this, function (_e) {
115
- switch (_e.label) {
116
- case 0:
117
- chatWebhooksString = process.env.GOOGLE_CHAT_WEBHOOKS;
118
- if (!chatWebhooksString) {
119
- msg = "GOOGLE_CHAT_WEBHOOKS not set. Google Chat message not sent";
120
- Sentry.captureException(new errors_1.APIError({ status: 500, title: msg }));
121
- return [2 /*return*/];
122
- }
123
- chatWebhooks = JSON.parse(chatWebhooksString !== null && chatWebhooksString !== void 0 ? chatWebhooksString : "{}");
124
- chatChannel = channel !== null && channel !== void 0 ? channel : "default";
125
- chatWebhookUrl = (_b = chatWebhooks[chatChannel]) !== null && _b !== void 0 ? _b : chatWebhooks.default;
126
- if (!chatWebhookUrl) {
127
- msg = "No webhook url set in env for ".concat(chatChannel, ". Google Chat message not sent");
128
- Sentry.captureException(new errors_1.APIError({ status: 500, title: msg }));
129
- return [2 /*return*/];
130
- }
131
- formattedMessageText = messageText;
132
- if (env) {
133
- formattedMessageText = "[".concat(env.toUpperCase(), "] ").concat(messageText);
134
- }
135
- _e.label = 1;
136
- case 1:
137
- _e.trys.push([1, 3, , 4]);
138
- return [4 /*yield*/, axios_1.default.post(chatWebhookUrl, { text: formattedMessageText })];
139
- case 2:
140
- _e.sent();
141
- return [3 /*break*/, 4];
142
- case 3:
143
- error_1 = _e.sent();
144
- message = (0, errors_1.errorMessage)(error_1);
145
- logger_1.logger.error("Error posting to Google Chat: ".concat(message));
146
- Sentry.captureException(error_1);
147
- if (shouldThrow) {
148
- throw new errors_1.APIError({
149
- status: 500,
150
- title: "Error posting to Google Chat: ".concat(message),
151
- });
152
- }
153
- return [3 /*break*/, 4];
154
- case 4: return [2 /*return*/];
155
- }
156
- });
157
- });
158
77
  };
159
78
  exports.sendToGoogleChat = sendToGoogleChat;
@@ -1,6 +1,35 @@
1
- export declare const sendToSlack: (text: string, { slackChannel, shouldThrow, env, url, }?: {
1
+ export interface SendToSlackOptions {
2
2
  slackChannel?: string;
3
3
  shouldThrow?: boolean;
4
4
  env?: string;
5
5
  url?: string;
6
- }) => Promise<void>;
6
+ /**
7
+ * Slack member IDs to @-mention. Incoming webhooks only notify when the
8
+ * payload contains `<@U123…>` (or `<@W123…>`). Display names and emails in
9
+ * the message text do not mention anyone.
10
+ */
11
+ mentionUserIds?: string[];
12
+ }
13
+ export interface LookupSlackUserIdByEmailOptions {
14
+ email: string;
15
+ /** Slack bot token (`xoxb-…`) with `users:read.email`. Defaults to `SLACK_BOT_TOKEN`. */
16
+ token?: string;
17
+ shouldThrow?: boolean;
18
+ }
19
+ /**
20
+ * Normalize a Slack member ID. Accepts a bare id (`U012ABCDEF`) or a mention
21
+ * token (`<@U012ABCDEF>`). Returns undefined when the value is not a Slack
22
+ * member ID — names and emails cannot be used for mentions.
23
+ */
24
+ export declare const normalizeSlackUserId: (value: string) => string | undefined;
25
+ /** Format a Slack member ID as an incoming-webhook mention token. */
26
+ export declare const formatSlackUserMention: (slackUserId: string) => string;
27
+ /**
28
+ * Resolve a workspace member's Slack user id from their email.
29
+ *
30
+ * Incoming webhooks cannot look users up. This calls `users.lookupByEmail` and
31
+ * needs a bot token with the `users:read.email` scope. Store the returned id on
32
+ * the staff/user record and pass it to `sendToSlack({mentionUserIds})`.
33
+ */
34
+ export declare const lookupSlackUserIdByEmail: ({ email, token, shouldThrow, }: LookupSlackUserIdByEmailOptions) => Promise<string | undefined>;
35
+ export declare const sendToSlack: (text: string, { slackChannel, shouldThrow, env, url, mentionUserIds }?: SendToSlackOptions) => Promise<void>;
@@ -32,139 +32,190 @@ var __importStar = (this && this.__importStar) || (function () {
32
32
  return result;
33
33
  };
34
34
  })();
35
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
36
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
37
- return new (P || (P = Promise))(function (resolve, reject) {
38
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
39
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
40
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
41
- step((generator = generator.apply(thisArg, _arguments || [])).next());
42
- });
35
+ var __importDefault = (this && this.__importDefault) || function (mod) {
36
+ return (mod && mod.__esModule) ? mod : { "default": mod };
43
37
  };
44
- var __generator = (this && this.__generator) || function (thisArg, body) {
45
- var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
46
- return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
47
- function verb(n) { return function (v) { return step([n, v]); }; }
48
- function step(op) {
49
- if (f) throw new TypeError("Generator is already executing.");
50
- while (g && (g = 0, op[0] && (_ = 0)), _) try {
51
- if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
52
- if (y = 0, t) op = [op[0] & 2, t.value];
53
- switch (op[0]) {
54
- case 0: case 1: t = op; break;
55
- case 4: _.label++; return { value: op[1], done: false };
56
- case 5: _.label++; y = op[1]; op = [0]; continue;
57
- case 7: op = _.ops.pop(); _.trys.pop(); continue;
58
- default:
59
- if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
60
- if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
61
- if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
62
- if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
63
- if (t[2]) _.ops.pop();
64
- _.trys.pop(); continue;
65
- }
66
- op = body.call(thisArg, _);
67
- } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
68
- if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
38
+ Object.defineProperty(exports, "__esModule", { value: true });
39
+ exports.sendToSlack = exports.lookupSlackUserIdByEmail = exports.formatSlackUserMention = exports.normalizeSlackUserId = void 0;
40
+ const Sentry = __importStar(require("@sentry/bun"));
41
+ const axios_1 = __importDefault(require("axios"));
42
+ const errors_1 = require("../errors");
43
+ const logger_1 = require("../logger");
44
+ /** Slack member IDs are `U…` (users) or `W…` (Enterprise Grid). */
45
+ const SLACK_USER_ID_PATTERN = /^[UW][A-Z0-9]{8,}$/i;
46
+ const SLACK_LOOKUP_BY_EMAIL_URL = "https://slack.com/api/users.lookupByEmail";
47
+ /**
48
+ * Normalize a Slack member ID. Accepts a bare id (`U012ABCDEF`) or a mention
49
+ * token (`<@U012ABCDEF>`). Returns undefined when the value is not a Slack
50
+ * member ID — names and emails cannot be used for mentions.
51
+ */
52
+ const normalizeSlackUserId = (value) => {
53
+ const trimmed = value.trim();
54
+ if (!trimmed) {
55
+ return undefined;
56
+ }
57
+ const unwrapped = trimmed.startsWith("<@") && trimmed.endsWith(">") ? trimmed.slice(2, -1) : trimmed;
58
+ if (!SLACK_USER_ID_PATTERN.test(unwrapped)) {
59
+ return undefined;
69
60
  }
61
+ return unwrapped.toUpperCase();
70
62
  };
71
- var __read = (this && this.__read) || function (o, n) {
72
- var m = typeof Symbol === "function" && o[Symbol.iterator];
73
- if (!m) return o;
74
- var i = m.call(o), r, ar = [], e;
75
- try {
76
- while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
63
+ exports.normalizeSlackUserId = normalizeSlackUserId;
64
+ /** Format a Slack member ID as an incoming-webhook mention token. */
65
+ const formatSlackUserMention = (slackUserId) => {
66
+ const id = (0, exports.normalizeSlackUserId)(slackUserId);
67
+ if (!id) {
68
+ throw new errors_1.APIError({
69
+ detail: slackUserId,
70
+ status: 400,
71
+ title: "Invalid Slack user id",
72
+ });
73
+ }
74
+ return `<@${id}>`;
75
+ };
76
+ exports.formatSlackUserMention = formatSlackUserMention;
77
+ const uniqueMentionTokens = (mentionUserIds) => {
78
+ if (!mentionUserIds?.length) {
79
+ return [];
77
80
  }
78
- catch (error) { e = { error: error }; }
79
- finally {
80
- try {
81
- if (r && !r.done && (m = i["return"])) m.call(i);
81
+ const seen = new Set();
82
+ const tokens = [];
83
+ for (const rawId of mentionUserIds) {
84
+ const id = (0, exports.normalizeSlackUserId)(rawId);
85
+ if (!id) {
86
+ logger_1.logger.warn("Skipping Slack mention; value is not a Slack member id", { value: rawId });
87
+ continue;
82
88
  }
83
- finally { if (e) throw e.error; }
89
+ if (seen.has(id)) {
90
+ continue;
91
+ }
92
+ seen.add(id);
93
+ tokens.push(`<@${id}>`);
84
94
  }
85
- return ar;
95
+ return tokens;
86
96
  };
87
- var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
88
- if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
89
- if (ar || !(i in from)) {
90
- if (!ar) ar = Array.prototype.slice.call(from, 0, i);
91
- ar[i] = from[i];
92
- }
97
+ const applyMentions = (text, mentionUserIds) => {
98
+ const tokens = uniqueMentionTokens(mentionUserIds);
99
+ if (tokens.length === 0) {
100
+ return text;
101
+ }
102
+ if (!text) {
103
+ return tokens.join(" ");
93
104
  }
94
- return to.concat(ar || Array.prototype.slice.call(from));
105
+ return `${tokens.join(" ")} ${text}`;
95
106
  };
96
- var __importDefault = (this && this.__importDefault) || function (mod) {
97
- return (mod && mod.__esModule) ? mod : { "default": mod };
107
+ /**
108
+ * Resolve a workspace member's Slack user id from their email.
109
+ *
110
+ * Incoming webhooks cannot look users up. This calls `users.lookupByEmail` and
111
+ * needs a bot token with the `users:read.email` scope. Store the returned id on
112
+ * the staff/user record and pass it to `sendToSlack({mentionUserIds})`.
113
+ */
114
+ const lookupSlackUserIdByEmail = async ({ email, token, shouldThrow = false, }) => {
115
+ const trimmedEmail = email.trim();
116
+ if (!trimmedEmail) {
117
+ if (shouldThrow) {
118
+ throw new errors_1.APIError({ status: 400, title: "Email is required to look up a Slack user" });
119
+ }
120
+ logger_1.logger.debug("lookupSlackUserIdByEmail skipped: empty email");
121
+ return undefined;
122
+ }
123
+ const botToken = token ?? process.env.SLACK_BOT_TOKEN;
124
+ if (!botToken) {
125
+ if (shouldThrow) {
126
+ throw new errors_1.APIError({
127
+ status: 500,
128
+ title: "SLACK_BOT_TOKEN is not set; cannot look up Slack user ids",
129
+ });
130
+ }
131
+ logger_1.logger.debug("lookupSlackUserIdByEmail skipped: no Slack bot token");
132
+ return undefined;
133
+ }
134
+ try {
135
+ const response = await axios_1.default.get(SLACK_LOOKUP_BY_EMAIL_URL, {
136
+ headers: { Authorization: `Bearer ${botToken}` },
137
+ params: { email: trimmedEmail },
138
+ });
139
+ const payload = response.data;
140
+ if (!payload?.ok || !payload.user?.id) {
141
+ const slackError = payload?.error ?? "unknown_error";
142
+ logger_1.logger.warn("Slack users.lookupByEmail did not return a user id", {
143
+ email: trimmedEmail,
144
+ slackError,
145
+ });
146
+ if (shouldThrow) {
147
+ throw new errors_1.APIError({
148
+ detail: slackError,
149
+ status: 502,
150
+ title: "Slack user lookup failed",
151
+ });
152
+ }
153
+ return undefined;
154
+ }
155
+ return (0, exports.normalizeSlackUserId)(payload.user.id);
156
+ }
157
+ catch (error) {
158
+ if (error instanceof errors_1.APIError) {
159
+ throw error;
160
+ }
161
+ const message = (0, errors_1.errorMessage)(error);
162
+ logger_1.logger.error(`Error looking up Slack user by email: ${message}`);
163
+ Sentry.captureException(error);
164
+ if (shouldThrow) {
165
+ throw new errors_1.APIError({
166
+ status: 500,
167
+ title: `Error looking up Slack user by email: ${message}`,
168
+ });
169
+ }
170
+ return undefined;
171
+ }
98
172
  };
99
- Object.defineProperty(exports, "__esModule", { value: true });
100
- exports.sendToSlack = void 0;
101
- var Sentry = __importStar(require("@sentry/bun"));
102
- var axios_1 = __importDefault(require("axios"));
103
- var errors_1 = require("../errors");
104
- var logger_1 = require("../logger");
173
+ exports.lookupSlackUserIdByEmail = lookupSlackUserIdByEmail;
105
174
  // Convenience method to send data to a Slack webhook.
106
175
  // If `url` is provided, it will be used directly instead of looking up from environment.
107
176
  // DEPRECATED: Looking up webhook URLs from the SLACK_WEBHOOKS environment variable by channel name
108
177
  // is deprecated and will be removed in a future version. Please pass the `url` parameter directly.
109
- var sendToSlack = function (text_1) {
110
- var args_1 = [];
111
- for (var _i = 1; _i < arguments.length; _i++) {
112
- args_1[_i - 1] = arguments[_i];
113
- }
114
- return __awaiter(void 0, __spreadArray([text_1], __read(args_1), false), void 0, function (text, _a) {
115
- var slackWebhookUrl, slackWebhooksString, slackWebhooks, channel, formattedText, error_1, message;
116
- var _b;
117
- var _c = _a === void 0 ? {} : _a, slackChannel = _c.slackChannel, _d = _c.shouldThrow, shouldThrow = _d === void 0 ? false : _d, env = _c.env, url = _c.url;
118
- return __generator(this, function (_e) {
119
- switch (_e.label) {
120
- case 0:
121
- slackWebhookUrl = url;
122
- if (!slackWebhookUrl) {
123
- logger_1.logger.debug("DEPRECATED: Looking up webhook URLs from SLACK_WEBHOOKS environment variable is deprecated and will be removed in a future version. Please pass the url parameter directly.");
124
- slackWebhooksString = process.env.SLACK_WEBHOOKS;
125
- if (!slackWebhooksString) {
126
- logger_1.logger.debug("You must set SLACK_WEBHOOKS in the environment to use sendToSlack.");
127
- return [2 /*return*/];
128
- }
129
- slackWebhooks = JSON.parse(slackWebhooksString !== null && slackWebhooksString !== void 0 ? slackWebhooksString : "{}");
130
- channel = slackChannel !== null && slackChannel !== void 0 ? slackChannel : "default";
131
- slackWebhookUrl = (_b = slackWebhooks[channel]) !== null && _b !== void 0 ? _b : slackWebhooks.default;
132
- if (!slackWebhookUrl) {
133
- Sentry.captureException(new errors_1.APIError({
134
- status: 500,
135
- title: "No webhook url set in env for ".concat(channel, ". Slack message not sent"),
136
- }));
137
- return [2 /*return*/];
138
- }
139
- }
140
- formattedText = text;
141
- if (env) {
142
- formattedText = "[".concat(env.toUpperCase(), "] ").concat(text);
143
- }
144
- _e.label = 1;
145
- case 1:
146
- _e.trys.push([1, 3, , 4]);
147
- return [4 /*yield*/, axios_1.default.post(slackWebhookUrl, {
148
- text: formattedText,
149
- })];
150
- case 2:
151
- _e.sent();
152
- return [3 /*break*/, 4];
153
- case 3:
154
- error_1 = _e.sent();
155
- message = (0, errors_1.errorMessage)(error_1);
156
- logger_1.logger.error("Error posting to slack: ".concat(message));
157
- Sentry.captureException(error_1);
158
- if (shouldThrow) {
159
- throw new errors_1.APIError({
160
- status: 500,
161
- title: "Error posting to slack: ".concat(message),
162
- });
163
- }
164
- return [3 /*break*/, 4];
165
- case 4: return [2 /*return*/];
166
- }
178
+ const sendToSlack = async (text, { slackChannel, shouldThrow = false, env, url, mentionUserIds } = {}) => {
179
+ let slackWebhookUrl = url;
180
+ if (!slackWebhookUrl) {
181
+ logger_1.logger.debug("DEPRECATED: Looking up webhook URLs from SLACK_WEBHOOKS environment variable is deprecated and will be removed in a future version. Please pass the url parameter directly.");
182
+ // since Slack now requires a webhook for each channel, we need to store them in the environment
183
+ // as an object, so we can look them up by channel name.
184
+ const slackWebhooksString = process.env.SLACK_WEBHOOKS;
185
+ if (!slackWebhooksString) {
186
+ logger_1.logger.debug("You must set SLACK_WEBHOOKS in the environment to use sendToSlack.");
187
+ return;
188
+ }
189
+ const slackWebhooks = JSON.parse(slackWebhooksString ?? "{}");
190
+ const channel = slackChannel ?? "default";
191
+ slackWebhookUrl = slackWebhooks[channel] ?? slackWebhooks.default;
192
+ if (!slackWebhookUrl) {
193
+ Sentry.captureException(new errors_1.APIError({
194
+ status: 500,
195
+ title: `No webhook url set in env for ${channel}. Slack message not sent`,
196
+ }));
197
+ return;
198
+ }
199
+ }
200
+ let formattedText = applyMentions(text, mentionUserIds);
201
+ if (env) {
202
+ formattedText = `[${env.toUpperCase()}] ${formattedText}`;
203
+ }
204
+ try {
205
+ await axios_1.default.post(slackWebhookUrl, {
206
+ text: formattedText,
167
207
  });
168
- });
208
+ }
209
+ catch (error) {
210
+ const message = (0, errors_1.errorMessage)(error);
211
+ logger_1.logger.error(`Error posting to slack: ${message}`);
212
+ Sentry.captureException(error);
213
+ if (shouldThrow) {
214
+ throw new errors_1.APIError({
215
+ status: 500,
216
+ title: `Error posting to slack: ${message}`,
217
+ });
218
+ }
219
+ }
169
220
  };
170
221
  exports.sendToSlack = sendToSlack;