@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,528 @@
1
+ import {afterEach, beforeEach, describe, it} from "bun:test";
2
+ import {authAsUser as authWithCredentials} from "@terreno/test";
3
+ import {assert} from "chai";
4
+ import type express from "express";
5
+ import {DateTime} from "luxon";
6
+ import type {Model} from "mongoose";
7
+ import supertest from "supertest";
8
+ import type TestAgent from "supertest/lib/agent";
9
+ import {signupUser, type UserModel as UserMongooseModel} from "../auth";
10
+ import {Notification} from "../models/notification";
11
+ import {NotificationPreference} from "../models/notificationPreference";
12
+ import {clearSyncRegistry} from "../sync/registry";
13
+ import {SyncApp} from "../sync/syncApp";
14
+ import {TerrenoApp} from "../terrenoApp";
15
+ import {authAsUser, setupDb, UserModel} from "../tests";
16
+ import {configureNotificationService, getNotificationService} from "./notificationService";
17
+ import {NotificationsApp} from "./notificationsApp";
18
+ import {
19
+ type NotificationsBeforeSendChannel,
20
+ notificationsBeforeSend,
21
+ } from "./notificationsBeforeSend";
22
+
23
+ interface FakeComms {
24
+ mailCalls: Array<{html?: string; subject: string; to: string}>;
25
+ mailUserIds: Array<string | undefined>;
26
+ pushCalls: Array<{title: string; userId: string}>;
27
+ smsCalls: Array<{body: string; to: string}>;
28
+ smsUserIds: Array<string | undefined>;
29
+ }
30
+
31
+ const buildFakeComms = (
32
+ fakeOptions: {mailError?: Error} = {}
33
+ ): {
34
+ comms: FakeComms;
35
+ getComms: () => FakeComms & {
36
+ sendMail: (
37
+ message: {html?: string; subject: string; to: string},
38
+ options?: {userId?: string}
39
+ ) => Promise<{accepted: boolean}>;
40
+ sendPushToUser: (message: {title: string; userId: string}) => Promise<unknown[]>;
41
+ sendSms: (
42
+ message: {body: string; to: string},
43
+ options?: {userId?: string}
44
+ ) => Promise<{accepted: boolean}>;
45
+ };
46
+ } => {
47
+ const comms: FakeComms = {
48
+ mailCalls: [],
49
+ mailUserIds: [],
50
+ pushCalls: [],
51
+ smsCalls: [],
52
+ smsUserIds: [],
53
+ };
54
+ return {
55
+ comms,
56
+ getComms: () => ({
57
+ ...comms,
58
+ sendMail: async (message, options) => {
59
+ if (fakeOptions.mailError) {
60
+ throw fakeOptions.mailError;
61
+ }
62
+ comms.mailCalls.push(message);
63
+ comms.mailUserIds.push(options?.userId);
64
+ return {accepted: true};
65
+ },
66
+ sendPushToUser: async (message) => {
67
+ comms.pushCalls.push(message);
68
+ return [{accepted: true}];
69
+ },
70
+ sendSms: async (message, options) => {
71
+ comms.smsCalls.push(message);
72
+ comms.smsUserIds.push(options?.userId);
73
+ return {accepted: true};
74
+ },
75
+ }),
76
+ };
77
+ };
78
+
79
+ const buildApp = (
80
+ options: {
81
+ getComms?: () => ReturnType<typeof buildFakeComms>["getComms"];
82
+ retainDays?: number;
83
+ } = {}
84
+ ): express.Application => {
85
+ clearSyncRegistry();
86
+ return new TerrenoApp({
87
+ skipListen: true,
88
+ userModel: UserModel as unknown as UserMongooseModel,
89
+ })
90
+ .register(new SyncApp({}))
91
+ .register(
92
+ new NotificationsApp({
93
+ getComms: options.getComms,
94
+ retainDays: options.retainDays,
95
+ userModel: UserModel,
96
+ })
97
+ )
98
+ .build();
99
+ };
100
+
101
+ describe("NotificationsApp", () => {
102
+ let userAgent: TestAgent;
103
+ let otherUserAgent: TestAgent;
104
+ let userId = "";
105
+
106
+ const clearNotificationData = async (): Promise<void> => {
107
+ await Notification.collection.deleteMany({});
108
+ await NotificationPreference.collection.deleteMany({});
109
+ };
110
+
111
+ beforeEach(async () => {
112
+ const [, notAdmin] = await setupDb();
113
+ userId = String(notAdmin._id);
114
+ const app = buildApp();
115
+ userAgent = await authAsUser(app, "notAdmin");
116
+ await UserModel.deleteOne({email: "other-user@example.com"});
117
+ await signupUser(UserModel, "other-user@example.com", "password");
118
+ otherUserAgent = await authWithCredentials(app, {
119
+ email: "other-user@example.com",
120
+ password: "password",
121
+ });
122
+ await clearNotificationData();
123
+ });
124
+
125
+ afterEach(async () => {
126
+ configureNotificationService({});
127
+ await clearNotificationData();
128
+ clearSyncRegistry();
129
+ });
130
+
131
+ it("notify creates one owner row when inapp is on", async () => {
132
+ const id = await getNotificationService().notify({
133
+ body: "Hello",
134
+ title: "Welcome",
135
+ userId,
136
+ });
137
+ assert.isString(id);
138
+ assert.isNotEmpty(id);
139
+ const row = await Notification.findExactlyOne({_id: id});
140
+ assert.equal(String(row.ownerId), userId);
141
+ assert.equal(row.title, "Welcome");
142
+ });
143
+
144
+ it("notify does not insert when inapp preference is off", async () => {
145
+ await NotificationPreference.create({inapp: false, ownerId: userId});
146
+ const id = await getNotificationService().notify({
147
+ body: "Hidden",
148
+ title: "Off",
149
+ userId,
150
+ });
151
+ assert.equal(id, "");
152
+ assert.equal(await Notification.countDocuments({ownerId: userId}), 0);
153
+ });
154
+
155
+ it("rejects unauthenticated list", async () => {
156
+ const app = buildApp();
157
+ await supertest(app).get("/notifications").expect(401);
158
+ });
159
+
160
+ it("can register the same plugin instance on repeated app builds", async () => {
161
+ clearSyncRegistry();
162
+ const notificationsApp = new NotificationsApp({userModel: UserModel});
163
+ const createApp = (): express.Application =>
164
+ new TerrenoApp({
165
+ skipListen: true,
166
+ userModel: UserModel as unknown as UserMongooseModel,
167
+ })
168
+ .register(new SyncApp({}))
169
+ .register(notificationsApp)
170
+ .build();
171
+
172
+ createApp();
173
+ const rebuilt = createApp();
174
+
175
+ await supertest(rebuilt).get("/notifications").expect(401);
176
+ });
177
+
178
+ it("blocks other users from reading a notification", async () => {
179
+ const id = await getNotificationService().notify({
180
+ body: "Private",
181
+ title: "Mine",
182
+ userId,
183
+ });
184
+ await otherUserAgent.get(`/notifications/${id}`).expect(403);
185
+ });
186
+
187
+ it("rejects HTTP create on notifications", async () => {
188
+ await userAgent
189
+ .post("/notifications")
190
+ .send({body: "x", ownerId: userId, title: "y"})
191
+ .expect(405);
192
+ });
193
+
194
+ it("creates notification preferences for the authenticated owner", async () => {
195
+ const response = await userAgent.post("/notification-preferences").send({mail: false});
196
+ assert.include([200, 201], response.status);
197
+ const preference = await NotificationPreference.findExactlyOne({ownerId: userId});
198
+ assert.isFalse(preference.mail);
199
+ assert.equal(String(preference.ownerId), userId);
200
+ });
201
+
202
+ it("allows creating preferences after the owner deletes the previous row", async () => {
203
+ const created = await userAgent.post("/notification-preferences").send({mail: false});
204
+ assert.include([200, 201], created.status);
205
+ const preferenceId = created.body.data._id as string;
206
+ await userAgent.delete(`/notification-preferences/${preferenceId}`).expect(204);
207
+
208
+ const recreated = await userAgent.post("/notification-preferences").send({sms: false});
209
+ assert.include([200, 201], recreated.status);
210
+ const preference = await NotificationPreference.findExactlyOne({ownerId: userId});
211
+ assert.isFalse(preference.sms);
212
+ assert.notEqual(preference._id, preferenceId);
213
+ });
214
+
215
+ it("does not allow preference PATCH to change the owner", async () => {
216
+ const preference = await NotificationPreference.create({ownerId: userId});
217
+ const otherUser = await UserModel.findOne({email: "other-user@example.com"});
218
+ assert.isOk(otherUser);
219
+
220
+ await userAgent
221
+ .patch(`/notification-preferences/${preference._id}`)
222
+ .send({mail: false, ownerId: String(otherUser?._id)})
223
+ .expect(200);
224
+
225
+ const updated = await NotificationPreference.findExactlyOne({_id: preference._id});
226
+ assert.equal(String(updated.ownerId), userId);
227
+ assert.isFalse(updated.mail);
228
+ });
229
+
230
+ it("rejects sync create on notifications", async () => {
231
+ const response = await userAgent.post("/sync/mutate").send({
232
+ collection: "notifications",
233
+ data: {body: "x", ownerId: userId, title: "y"},
234
+ mutationId: "notification-create-rejected",
235
+ operation: "create",
236
+ });
237
+ assert.equal(response.status, 403);
238
+ assert.equal(response.body.nack?.code, "unauthorized");
239
+ assert.equal(await Notification.countDocuments({ownerId: userId}), 0);
240
+ });
241
+
242
+ it("PATCH readAt persists and strips other fields", async () => {
243
+ const id = await getNotificationService().notify({
244
+ body: "Body",
245
+ title: "Original",
246
+ userId,
247
+ });
248
+ const readAt = DateTime.now().toISO();
249
+ await userAgent.patch(`/notifications/${id}`).send({readAt, title: "Hacked"}).expect(200);
250
+ const row = await Notification.findExactlyOne({_id: id});
251
+ assert.equal(row.title, "Original");
252
+ assert.isOk(row.readAt);
253
+ });
254
+
255
+ it("PATCH readAt null marks a notification unread", async () => {
256
+ const id = await getNotificationService().notify({
257
+ body: "Body",
258
+ title: "Read then unread",
259
+ userId,
260
+ });
261
+ await Notification.updateOne({_id: id}, {readAt: DateTime.now().toJSDate()});
262
+ await userAgent.patch(`/notifications/${id}`).send({readAt: null}).expect(200);
263
+ const row = await Notification.findExactlyOne({_id: id});
264
+ assert.isNull(row.readAt);
265
+ });
266
+
267
+ it("rejects invalid readAt values", async () => {
268
+ const id = await getNotificationService().notify({
269
+ body: "Body",
270
+ title: "Invalid readAt",
271
+ userId,
272
+ });
273
+ await userAgent.patch(`/notifications/${id}`).send({readAt: "not-a-date"}).expect(400);
274
+ await userAgent
275
+ .patch(`/notifications/${id}`)
276
+ .send({readAt: {invalid: true}})
277
+ .expect(400);
278
+ });
279
+
280
+ it("DELETE soft-deletes from list", async () => {
281
+ const id = await getNotificationService().notify({
282
+ body: "Body",
283
+ title: "Dismiss me",
284
+ userId,
285
+ });
286
+ await userAgent.delete(`/notifications/${id}`).expect(204);
287
+ const list = await userAgent.get("/notifications").expect(200);
288
+ assert.equal(list.body.data.length, 0);
289
+ });
290
+
291
+ it("PATCH archivedAt archives a notification without tombstoning it", async () => {
292
+ const id = await getNotificationService().notify({
293
+ body: "Archive me",
294
+ title: "Archive me",
295
+ userId,
296
+ });
297
+ const archivedAt = DateTime.now().toISO();
298
+ await userAgent.patch(`/notifications/${id}`).send({archivedAt}).expect(200);
299
+ const row = await Notification.findExactlyOne({_id: id});
300
+ assert.isOk(row.archivedAt);
301
+ assert.isFalse(row.deleted);
302
+ const list = await userAgent.get("/notifications").expect(200);
303
+ assert.equal(list.body.data.length, 1);
304
+ assert.equal(list.body.data[0]?._id, id);
305
+ });
306
+
307
+ it("rejects invalid archivedAt values", async () => {
308
+ const id = await getNotificationService().notify({
309
+ body: "Body",
310
+ title: "Invalid archivedAt",
311
+ userId,
312
+ });
313
+ await userAgent.patch(`/notifications/${id}`).send({archivedAt: "not-a-date"}).expect(400);
314
+ });
315
+
316
+ it("notificationsBeforeSend cancels mail when mail pref is false", async () => {
317
+ await NotificationPreference.create({mail: false, ownerId: userId});
318
+ const result = await notificationsBeforeSend({channel: "mail", userId});
319
+ assert.deepEqual(result, {cancel: true});
320
+ });
321
+
322
+ it("notificationsBeforeSend cancels push and SMS when their preferences are false", async () => {
323
+ await NotificationPreference.create({ownerId: userId, push: false, sms: false});
324
+ assert.deepEqual(await notificationsBeforeSend({channel: "push", userId}), {cancel: true});
325
+ assert.deepEqual(await notificationsBeforeSend({channel: "sms", userId}), {cancel: true});
326
+ });
327
+
328
+ it("notificationsBeforeSend does not cancel when preference row is missing", async () => {
329
+ const result = await notificationsBeforeSend({channel: "mail", userId});
330
+ assert.isUndefined(result);
331
+ });
332
+
333
+ it("notificationsBeforeSend never cancels verification", async () => {
334
+ await NotificationPreference.create({
335
+ inapp: false,
336
+ mail: false,
337
+ ownerId: userId,
338
+ push: false,
339
+ sms: false,
340
+ });
341
+ const result = await notificationsBeforeSend({channel: "verification", userId});
342
+ assert.isUndefined(result);
343
+ });
344
+
345
+ it("notificationsBeforeSend does not cancel when userId is missing", async () => {
346
+ const result = await notificationsBeforeSend({channel: "mail"});
347
+ assert.isUndefined(result);
348
+ });
349
+
350
+ it("notificationsBeforeSend does not cancel for channels without a preference field", async () => {
351
+ await NotificationPreference.create({
352
+ inapp: false,
353
+ mail: false,
354
+ ownerId: userId,
355
+ push: false,
356
+ sms: false,
357
+ });
358
+ const result = await notificationsBeforeSend({
359
+ channel: "inapp" as unknown as NotificationsBeforeSendChannel,
360
+ userId,
361
+ });
362
+ assert.isUndefined(result);
363
+ });
364
+
365
+ it("fan-out calls mail when pref on and email present", async () => {
366
+ const {comms, getComms} = buildFakeComms();
367
+ configureNotificationService({getComms, userModel: UserModel});
368
+ await getNotificationService().notify({
369
+ body: "Body",
370
+ title: "Mail me",
371
+ userId,
372
+ });
373
+ assert.equal(comms.mailCalls.length, 1);
374
+ assert.equal(comms.mailCalls[0]?.to, "notAdmin@example.com");
375
+ assert.deepEqual(comms.mailUserIds, [userId]);
376
+ assert.equal(comms.mailCalls[0]?.html, "<p>Body</p>");
377
+ });
378
+
379
+ it("fan-out escapes HTML in mail while preserving plain text", async () => {
380
+ const {comms, getComms} = buildFakeComms();
381
+ configureNotificationService({getComms, userModel: UserModel});
382
+ await getNotificationService().notify({
383
+ body: '<script>alert("x")</script> & more',
384
+ title: "Safe mail",
385
+ userId,
386
+ });
387
+ assert.equal(
388
+ comms.mailCalls[0]?.html,
389
+ "<p>&lt;script&gt;alert(&quot;x&quot;)&lt;/script&gt; &amp; more</p>"
390
+ );
391
+ });
392
+
393
+ it("fan-out calls SMS and push when preferences and destinations are available", async () => {
394
+ const {comms, getComms} = buildFakeComms();
395
+ const userModel = {
396
+ findById: () => ({
397
+ select: () => ({
398
+ lean: async () => ({
399
+ email: "notAdmin@example.com",
400
+ phone: "+15551234567",
401
+ }),
402
+ }),
403
+ }),
404
+ } as unknown as Model<{email?: string; phone?: string}>;
405
+ configureNotificationService({getComms, userModel});
406
+ await getNotificationService().notify({
407
+ body: "Body",
408
+ title: "Every channel",
409
+ userId,
410
+ });
411
+ assert.deepEqual(comms.smsCalls, [{body: "Every channel: Body", to: "+15551234567"}]);
412
+ assert.deepEqual(comms.smsUserIds, [userId]);
413
+ assert.deepEqual(comms.pushCalls, [{body: "Body", title: "Every channel", userId}]);
414
+ });
415
+
416
+ it("fan-out skips mail when pref off", async () => {
417
+ const {comms, getComms} = buildFakeComms();
418
+ configureNotificationService({getComms, userModel: UserModel});
419
+ await NotificationPreference.create({mail: false, ownerId: userId});
420
+ await getNotificationService().notify({
421
+ body: "Body",
422
+ title: "No mail",
423
+ userId,
424
+ });
425
+ assert.equal(comms.mailCalls.length, 0);
426
+ });
427
+
428
+ it("fan-out continues SMS and push when sendMail rejects", async () => {
429
+ const {comms, getComms} = buildFakeComms({mailError: new Error("smtp down")});
430
+ const userModel = {
431
+ findById: () => ({
432
+ select: () => ({
433
+ lean: async () => ({
434
+ email: "notAdmin@example.com",
435
+ phone: "+15551234567",
436
+ }),
437
+ }),
438
+ }),
439
+ } as unknown as Model<{email?: string; phone?: string}>;
440
+ configureNotificationService({getComms, userModel});
441
+ const id = await getNotificationService().notify({
442
+ body: "Body",
443
+ title: "Keep going",
444
+ userId,
445
+ });
446
+ assert.isNotEmpty(id);
447
+ assert.equal(comms.mailCalls.length, 0);
448
+ assert.deepEqual(comms.smsCalls, [{body: "Keep going: Body", to: "+15551234567"}]);
449
+ assert.deepEqual(comms.pushCalls, [{body: "Body", title: "Keep going", userId}]);
450
+ });
451
+
452
+ it("notify resolves when getComms throws after inbox write", async () => {
453
+ configureNotificationService({
454
+ getComms: () => {
455
+ throw new Error("comms down");
456
+ },
457
+ userModel: UserModel,
458
+ });
459
+ const id = await getNotificationService().notify({
460
+ body: "Still here",
461
+ title: "Resilient",
462
+ userId,
463
+ });
464
+ assert.isNotEmpty(id);
465
+ });
466
+
467
+ it("mark-all-read only affects caller", async () => {
468
+ const otherUserId = String((await UserModel.findOne({email: "admin@example.com"}))?._id);
469
+ await getNotificationService().notify({body: "A", title: "A", userId});
470
+ await getNotificationService().notify({body: "B", title: "B", userId: otherUserId});
471
+ await userAgent.post("/notifications/mark-all-read").expect(200);
472
+ const mine = await Notification.find({ownerId: userId});
473
+ const theirs = await Notification.find({ownerId: otherUserId});
474
+ assert.isOk(mine[0]?.readAt);
475
+ assert.isNull(theirs[0]?.readAt ?? null);
476
+ });
477
+
478
+ it("retainDays 0 leaves old rows", async () => {
479
+ const row = await Notification.create({
480
+ body: "Old",
481
+ created: DateTime.now().minus({days: 3}).toJSDate(),
482
+ ownerId: userId,
483
+ title: "Old",
484
+ });
485
+ configureNotificationService({retainDays: 0, userModel: UserModel});
486
+ const swept = await getNotificationService().sweepExpired();
487
+ assert.equal(swept, 0);
488
+ const stillThere = await Notification.findById(row._id);
489
+ assert.isFalse(stillThere?.deleted);
490
+ });
491
+
492
+ it("retainDays 1 tombstones rows older than one day", async () => {
493
+ configureNotificationService({retainDays: 1, userModel: UserModel});
494
+ const row = await Notification.create({
495
+ body: "Stale",
496
+ created: DateTime.now().minus({days: 2}).toJSDate(),
497
+ ownerId: userId,
498
+ title: "Stale",
499
+ });
500
+ const swept = await getNotificationService().sweepExpired();
501
+ assert.equal(swept, 1);
502
+ const tombstoned = await Notification.findOne({_id: row._id, deleted: true});
503
+ assert.isTrue(tombstoned?.deleted);
504
+ });
505
+
506
+ it("notify sweeps expired rows when retainDays is enabled", async () => {
507
+ configureNotificationService({retainDays: 1, userModel: UserModel});
508
+ const stale = await Notification.create({
509
+ body: "Stale",
510
+ created: DateTime.now().minus({days: 2}).toJSDate(),
511
+ ownerId: userId,
512
+ title: "Stale",
513
+ });
514
+ await getNotificationService().notify({
515
+ body: "Fresh",
516
+ title: "Fresh",
517
+ userId,
518
+ });
519
+ const tombstoned = await Notification.findOne({_id: stale._id, deleted: true});
520
+ assert.isTrue(tombstoned?.deleted);
521
+ });
522
+
523
+ it("notification collection has no TTL index", async () => {
524
+ const indexes = await Notification.collection.indexes();
525
+ const ttl = indexes.find((index) => "expireAfterSeconds" in index);
526
+ assert.isUndefined(ttl);
527
+ });
528
+ });