@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,56 @@
1
+ import type { Request } from "express";
2
+ import type { AuditEventModel, AuditEventOperation, AuditEventVerb } from "./auditEventModel";
3
+ export interface ModelRouterAuditOptions {
4
+ redact?: string[];
5
+ }
6
+ export type ModelRouterAuditConfig = boolean | ModelRouterAuditOptions;
7
+ /** Off-process persist (Cloud Tasks). When set, Mongo is not written in this process. */
8
+ export type AuditEnqueue = (write: AuditEventWrite) => Promise<void>;
9
+ export interface AuditRecorderOptions {
10
+ enqueue?: AuditEnqueue;
11
+ }
12
+ export interface AuditEventWrite {
13
+ actorId?: string;
14
+ after?: Record<string, unknown>;
15
+ before?: Record<string, unknown>;
16
+ modelName: string;
17
+ operation: AuditEventOperation;
18
+ organizationId?: string;
19
+ recordId?: string;
20
+ recordLabel?: string;
21
+ source: "admin" | "modelRouter" | "rbac";
22
+ verb: AuditEventVerb;
23
+ }
24
+ export declare const installAuditRecorder: (model: AuditEventModel, options?: AuditRecorderOptions) => void;
25
+ export declare const isAuditRecorderInstalled: () => boolean;
26
+ export declare const resetAuditRecorderForTests: () => void;
27
+ export declare const flushAuditRecorderForTests: () => Promise<void>;
28
+ export declare const maybeRecordAdminAudit: ({ after, before, extraRedact, modelName, recordLabel, req, verb, }: {
29
+ after?: unknown;
30
+ before?: unknown;
31
+ extraRedact?: string[];
32
+ modelName: string;
33
+ recordLabel?: string;
34
+ req: Request;
35
+ verb: AuditEventVerb;
36
+ }) => Promise<void>;
37
+ export declare const actorIdForAuditWrite: (actorId?: string) => string | undefined;
38
+ /** Capture pre-mutation state only when audit is on. A throwing toJSON must not fail the write. */
39
+ export declare const snapshotAuditBefore: ({ audit, doc, }: {
40
+ audit?: ModelRouterAuditConfig;
41
+ doc: {
42
+ toJSON?: () => unknown;
43
+ };
44
+ }) => unknown;
45
+ export declare const persistEnqueuedAuditEvent: (write: AuditEventWrite) => Promise<void>;
46
+ export declare const recordAuditEvent: (write: AuditEventWrite) => Promise<void>;
47
+ export declare const maybeRecordModelRouterAudit: ({ after, audit, before, modelName, operation, recordId, req, verb, }: {
48
+ after?: unknown;
49
+ audit?: ModelRouterAuditConfig;
50
+ before?: unknown;
51
+ modelName: string;
52
+ operation: AuditEventOperation;
53
+ recordId?: string;
54
+ req: Request;
55
+ verb: AuditEventVerb;
56
+ }) => Promise<void>;
@@ -0,0 +1,251 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.maybeRecordModelRouterAudit = exports.recordAuditEvent = exports.persistEnqueuedAuditEvent = exports.snapshotAuditBefore = exports.actorIdForAuditWrite = exports.maybeRecordAdminAudit = exports.flushAuditRecorderForTests = exports.resetAuditRecorderForTests = exports.isAuditRecorderInstalled = exports.installAuditRecorder = void 0;
7
+ const mongoose_1 = __importDefault(require("mongoose"));
8
+ const logger_1 = require("../logger");
9
+ const orgContext_1 = require("../orgs/orgContext");
10
+ const diff_1 = require("./diff");
11
+ const MISSING_PLUGIN_MESSAGE = "modelRouter audit: true requires AuditApp to be registered; skipping AuditEvent write";
12
+ const AUDIT_EVENT_MODEL_NAMES = new Set(["AuditEvent", "TerrenoAuditEvent"]);
13
+ let auditEventModel;
14
+ let auditEnqueue;
15
+ let missingPluginLogged = false;
16
+ const inflightWrites = new Set();
17
+ const installAuditRecorder = (model, options = {}) => {
18
+ auditEventModel = model;
19
+ auditEnqueue = options.enqueue;
20
+ };
21
+ exports.installAuditRecorder = installAuditRecorder;
22
+ const isAuditRecorderInstalled = () => Boolean(auditEventModel);
23
+ exports.isAuditRecorderInstalled = isAuditRecorderInstalled;
24
+ const resetAuditRecorderForTests = () => {
25
+ auditEventModel = undefined;
26
+ auditEnqueue = undefined;
27
+ missingPluginLogged = false;
28
+ inflightWrites.clear();
29
+ };
30
+ exports.resetAuditRecorderForTests = resetAuditRecorderForTests;
31
+ const flushAuditRecorderForTests = async () => {
32
+ await Promise.all([...inflightWrites]);
33
+ };
34
+ exports.flushAuditRecorderForTests = flushAuditRecorderForTests;
35
+ const operationFromVerb = (verb) => {
36
+ if (verb === "created") {
37
+ return "create";
38
+ }
39
+ if (verb === "deleted") {
40
+ return "delete";
41
+ }
42
+ return "update";
43
+ };
44
+ const maybeRecordAdminAudit = async ({ after, before, extraRedact = [], modelName, recordLabel, req, verb, }) => {
45
+ try {
46
+ if (!auditEventModel) {
47
+ return;
48
+ }
49
+ if (AUDIT_EVENT_MODEL_NAMES.has(modelName)) {
50
+ return;
51
+ }
52
+ const beforePlain = (0, diff_1.toAuditPlain)(before);
53
+ const afterPlain = (0, diff_1.toAuditPlain)(after);
54
+ const diff = (0, diff_1.changedFieldDiff)({ after: afterPlain, before: beforePlain, extraRedact });
55
+ const recordIdValue = afterPlain?._id ?? beforePlain?._id;
56
+ await (0, exports.recordAuditEvent)({
57
+ actorId: actorIdFromRequest(req),
58
+ after: diff.after,
59
+ before: diff.before,
60
+ modelName,
61
+ operation: operationFromVerb(verb),
62
+ organizationId: organizationIdFromAuditContext(req, afterPlain, beforePlain),
63
+ recordId: recordIdValue != null ? String(recordIdValue) : undefined,
64
+ recordLabel: recordLabel ?? (0, diff_1.recordLabelFromDoc)(afterPlain) ?? (0, diff_1.recordLabelFromDoc)(beforePlain),
65
+ source: "admin",
66
+ verb,
67
+ });
68
+ }
69
+ catch (error) {
70
+ logger_1.logger.error("Failed to persist AuditEvent", error);
71
+ }
72
+ };
73
+ exports.maybeRecordAdminAudit = maybeRecordAdminAudit;
74
+ const resolveAuditRedact = (audit) => {
75
+ if (!audit) {
76
+ return undefined;
77
+ }
78
+ if (audit === true) {
79
+ return [];
80
+ }
81
+ return audit.redact ?? [];
82
+ };
83
+ const actorIdFromRequest = (req) => {
84
+ const user = req.user;
85
+ if (!user) {
86
+ return undefined;
87
+ }
88
+ if (user.id) {
89
+ return String(user.id);
90
+ }
91
+ if (user._id) {
92
+ return String(user._id);
93
+ }
94
+ return undefined;
95
+ };
96
+ const idString = (value) => {
97
+ if (value === null || value === undefined) {
98
+ return undefined;
99
+ }
100
+ if (typeof value === "string") {
101
+ return value.length > 0 ? value : undefined;
102
+ }
103
+ if (typeof value === "object" && ("id" in value || "_id" in value)) {
104
+ const record = value;
105
+ if (record.id !== undefined && record.id !== null) {
106
+ return String(record.id);
107
+ }
108
+ if (record._id !== undefined && record._id !== null) {
109
+ return String(record._id);
110
+ }
111
+ }
112
+ return String(value);
113
+ };
114
+ const organizationIdFromAuditContext = (req, after, before) => {
115
+ const organization = req.organization;
116
+ const fromRequest = idString(organization);
117
+ if (fromRequest) {
118
+ return fromRequest;
119
+ }
120
+ const fromAls = idString((0, orgContext_1.getOrgContext)()?.organization);
121
+ if (fromAls) {
122
+ return fromAls;
123
+ }
124
+ const fromHeader = typeof req.header === "function" ? req.header(orgContext_1.ORGANIZATION_ID_HEADER)?.trim() : undefined;
125
+ if (fromHeader) {
126
+ return fromHeader;
127
+ }
128
+ const fromDoc = after?.organizationId ?? before?.organizationId;
129
+ return idString(fromDoc);
130
+ };
131
+ /** 24-hex ObjectIds only. mongoose.isValidObjectId also accepts 12-char strings. */
132
+ const isCanonicalObjectId = (id) => {
133
+ try {
134
+ return new mongoose_1.default.Types.ObjectId(id).toString() === id;
135
+ }
136
+ catch {
137
+ return false;
138
+ }
139
+ };
140
+ const actorIdForAuditWrite = (actorId) => {
141
+ if (!actorId) {
142
+ return undefined;
143
+ }
144
+ if (!isCanonicalObjectId(actorId)) {
145
+ logger_1.logger.warn(`AuditEvent actorId is not an ObjectId, recording without an actor: ${actorId}`);
146
+ return undefined;
147
+ }
148
+ return actorId;
149
+ };
150
+ exports.actorIdForAuditWrite = actorIdForAuditWrite;
151
+ const actorObjectId = (actorId) => {
152
+ const validId = (0, exports.actorIdForAuditWrite)(actorId);
153
+ if (!validId) {
154
+ return undefined;
155
+ }
156
+ return new mongoose_1.default.Types.ObjectId(validId);
157
+ };
158
+ /** Capture pre-mutation state only when audit is on. A throwing toJSON must not fail the write. */
159
+ const snapshotAuditBefore = ({ audit, doc, }) => {
160
+ if (!audit) {
161
+ return undefined;
162
+ }
163
+ try {
164
+ if (typeof doc.toJSON === "function") {
165
+ return doc.toJSON();
166
+ }
167
+ return doc;
168
+ }
169
+ catch (error) {
170
+ logger_1.logger.error("Failed to snapshot document for AuditEvent", error);
171
+ return undefined;
172
+ }
173
+ };
174
+ exports.snapshotAuditBefore = snapshotAuditBefore;
175
+ const persistAuditEvent = async (write) => {
176
+ if (AUDIT_EVENT_MODEL_NAMES.has(write.modelName)) {
177
+ return;
178
+ }
179
+ if (!auditEventModel) {
180
+ if (!missingPluginLogged) {
181
+ missingPluginLogged = true;
182
+ logger_1.logger.error(MISSING_PLUGIN_MESSAGE);
183
+ }
184
+ return;
185
+ }
186
+ const actorId = actorObjectId(write.actorId);
187
+ await auditEventModel.create({
188
+ ...(actorId ? { actorId } : {}),
189
+ ...(write.after ? { after: write.after } : {}),
190
+ ...(write.before ? { before: write.before } : {}),
191
+ modelName: write.modelName,
192
+ operation: write.operation,
193
+ ...(write.organizationId ? { organizationId: write.organizationId } : {}),
194
+ ...(write.recordId ? { recordId: write.recordId } : {}),
195
+ ...(write.recordLabel ? { recordLabel: write.recordLabel } : {}),
196
+ source: write.source,
197
+ verb: write.verb,
198
+ });
199
+ };
200
+ const runAuditWrite = async (write) => {
201
+ try {
202
+ if (auditEnqueue) {
203
+ await auditEnqueue(write);
204
+ return;
205
+ }
206
+ await persistAuditEvent(write);
207
+ }
208
+ catch (error) {
209
+ logger_1.logger.error("Failed to persist AuditEvent", error);
210
+ }
211
+ };
212
+ const persistEnqueuedAuditEvent = async (write) => {
213
+ await persistAuditEvent(write);
214
+ };
215
+ exports.persistEnqueuedAuditEvent = persistEnqueuedAuditEvent;
216
+ const recordAuditEvent = (write) => {
217
+ const run = runAuditWrite(write);
218
+ inflightWrites.add(run);
219
+ void run.finally(() => {
220
+ inflightWrites.delete(run);
221
+ });
222
+ return run;
223
+ };
224
+ exports.recordAuditEvent = recordAuditEvent;
225
+ const maybeRecordModelRouterAudit = async ({ after, audit, before, modelName, operation, recordId, req, verb, }) => {
226
+ try {
227
+ const extraRedact = resolveAuditRedact(audit);
228
+ if (extraRedact === undefined) {
229
+ return;
230
+ }
231
+ const beforePlain = (0, diff_1.toAuditPlain)(before);
232
+ const afterPlain = (0, diff_1.toAuditPlain)(after);
233
+ const diff = (0, diff_1.changedFieldDiff)({ after: afterPlain, before: beforePlain, extraRedact });
234
+ await (0, exports.recordAuditEvent)({
235
+ actorId: actorIdFromRequest(req),
236
+ after: diff.after,
237
+ before: diff.before,
238
+ modelName,
239
+ operation,
240
+ organizationId: organizationIdFromAuditContext(req, afterPlain, beforePlain),
241
+ recordId,
242
+ recordLabel: (0, diff_1.recordLabelFromDoc)(afterPlain) ?? (0, diff_1.recordLabelFromDoc)(beforePlain),
243
+ source: "modelRouter",
244
+ verb,
245
+ });
246
+ }
247
+ catch (error) {
248
+ logger_1.logger.error("Failed to persist AuditEvent", error);
249
+ }
250
+ };
251
+ exports.maybeRecordModelRouterAudit = maybeRecordModelRouterAudit;