@terreno/api 57.2.0 → 57.4.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 (472) hide show
  1. package/.ai/skills/mongoose-schema-safety/SKILL.md +23 -10
  2. package/README.md +23 -7
  3. package/dist/actions.js +19 -7
  4. package/dist/adminTypes.d.ts +7 -0
  5. package/dist/adminTypes.js +6 -1
  6. package/dist/api.d.ts +14 -0
  7. package/dist/api.js +111 -60
  8. package/dist/audit/auditApp.d.ts +30 -0
  9. package/dist/audit/auditApp.js +155 -0
  10. package/dist/audit/auditEventModel.d.ts +29 -0
  11. package/dist/audit/auditEventModel.js +102 -0
  12. package/dist/audit/cloudTasksEnqueue.d.ts +32 -0
  13. package/dist/audit/cloudTasksEnqueue.js +162 -0
  14. package/dist/audit/diff.d.ts +10 -0
  15. package/dist/audit/diff.js +230 -0
  16. package/dist/audit/processQueue.d.ts +6 -0
  17. package/dist/audit/processQueue.js +101 -0
  18. package/dist/audit/rbacSink.d.ts +2 -0
  19. package/dist/audit/rbacSink.js +82 -0
  20. package/dist/audit/record.d.ts +56 -0
  21. package/dist/audit/record.js +373 -0
  22. package/dist/auth.d.ts +23 -10
  23. package/dist/auth.js +97 -32
  24. package/dist/authRecovery.d.ts +5 -0
  25. package/dist/authRecovery.js +350 -0
  26. package/dist/authTokens.d.ts +8 -0
  27. package/dist/authTokens.js +162 -0
  28. package/dist/betterAuth.d.ts +39 -0
  29. package/dist/betterAuthApp.d.ts +4 -0
  30. package/dist/betterAuthApp.js +26 -8
  31. package/dist/betterAuthSetup.d.ts +44 -2
  32. package/dist/betterAuthSetup.js +288 -18
  33. package/dist/collectionRegistry.d.ts +40 -0
  34. package/dist/collectionRegistry.js +97 -0
  35. package/dist/configurationApp.d.ts +11 -2
  36. package/dist/configurationApp.js +2 -4
  37. package/dist/docLoader.js +35 -6
  38. package/dist/expressServer.d.ts +26 -3
  39. package/dist/expressServer.js +79 -11
  40. package/dist/index.d.ts +42 -1
  41. package/dist/index.js +84 -2
  42. package/dist/mcp/auth.d.ts +1 -0
  43. package/dist/mcp/auth.js +47 -25
  44. package/dist/mcp/handlers.d.ts +1 -1
  45. package/dist/mcp/handlers.js +67 -233
  46. package/dist/mcp/query.d.ts +2 -15
  47. package/dist/mcp/query.js +8 -8
  48. package/dist/mcp/registry.d.ts +1 -5
  49. package/dist/mcp/registry.js +31 -20
  50. package/dist/mcp/schemaGenerator.d.ts +2 -7
  51. package/dist/mcp/schemaGenerator.js +41 -116
  52. package/dist/mcp/server.d.ts +1 -0
  53. package/dist/mcp/server.js +1 -0
  54. package/dist/mcp/serviceTokens.d.ts +16 -0
  55. package/dist/mcp/serviceTokens.js +345 -0
  56. package/dist/mcp/types.d.ts +2 -2
  57. package/dist/migrations/fixtures/all-down/20260910120000-one.d.ts +4 -0
  58. package/dist/migrations/fixtures/all-down/20260910120000-one.js +49 -0
  59. package/dist/migrations/fixtures/all-down/20260910120001-two.d.ts +4 -0
  60. package/dist/migrations/fixtures/all-down/20260910120001-two.js +49 -0
  61. package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.d.ts +3 -0
  62. package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.js +45 -0
  63. package/dist/migrations/fixtures/bad-name/not-a-migration.d.ts +3 -0
  64. package/dist/migrations/fixtures/bad-name/not-a-migration.js +45 -0
  65. package/dist/migrations/fixtures/missing-up/20260910120000-noup.d.ts +2 -0
  66. package/dist/migrations/fixtures/missing-up/20260910120000-noup.js +5 -0
  67. package/dist/migrations/fixtures/valid/20260910120000-alpha.d.ts +3 -0
  68. package/dist/migrations/fixtures/valid/20260910120000-alpha.js +45 -0
  69. package/dist/migrations/fixtures/valid/20260910120001-beta.d.ts +4 -0
  70. package/dist/migrations/fixtures/valid/20260910120001-beta.js +49 -0
  71. package/dist/migrations/generate.d.ts +17 -0
  72. package/dist/migrations/generate.js +277 -0
  73. package/dist/migrations/load.d.ts +20 -0
  74. package/dist/migrations/load.js +236 -0
  75. package/dist/migrations/lock.d.ts +13 -0
  76. package/dist/migrations/lock.js +145 -0
  77. package/dist/migrations/runner.d.ts +42 -0
  78. package/dist/migrations/runner.js +503 -0
  79. package/dist/migrations/schemaCatalog.d.ts +44 -0
  80. package/dist/migrations/schemaCatalog.js +326 -0
  81. package/dist/migrations/types.d.ts +87 -0
  82. package/dist/migrations/types.js +7 -0
  83. package/dist/models/mcpServiceToken.d.ts +3 -0
  84. package/dist/models/mcpServiceToken.js +208 -0
  85. package/dist/models/notification.d.ts +2 -0
  86. package/dist/models/notification.js +62 -0
  87. package/dist/models/notificationPreference.d.ts +2 -0
  88. package/dist/models/notificationPreference.js +49 -0
  89. package/dist/notifications/notificationService.d.ts +40 -0
  90. package/dist/notifications/notificationService.js +323 -0
  91. package/dist/notifications/notificationsApp.d.ts +18 -0
  92. package/dist/notifications/notificationsApp.js +250 -0
  93. package/dist/notifications/notificationsBeforeSend.d.ts +14 -0
  94. package/dist/notifications/notificationsBeforeSend.js +77 -0
  95. package/dist/openApi.d.ts +1 -7
  96. package/dist/openApi.js +7 -6
  97. package/dist/openApiBuilder.d.ts +19 -7
  98. package/dist/openApiBuilder.js +61 -8
  99. package/dist/openApiCompat.js +1 -1
  100. package/dist/openApiValidator.d.ts +13 -1
  101. package/dist/openApiValidator.js +200 -38
  102. package/dist/orgs/orgContext.d.ts +23 -0
  103. package/dist/orgs/orgContext.js +198 -0
  104. package/dist/orgs/orgPermissions.d.ts +4 -0
  105. package/dist/orgs/orgPermissions.js +77 -0
  106. package/dist/orgs/orgPlugin.d.ts +13 -0
  107. package/dist/orgs/orgPlugin.js +84 -0
  108. package/dist/orgs/organizationModel.d.ts +13 -0
  109. package/dist/orgs/organizationModel.js +301 -0
  110. package/dist/orgs/organizationSettings.d.ts +19 -0
  111. package/dist/orgs/organizationSettings.js +120 -0
  112. package/dist/orgs/orgsApp.d.ts +28 -0
  113. package/dist/orgs/orgsApp.js +678 -0
  114. package/dist/permissions.d.ts +7 -13
  115. package/dist/permissions.js +8 -31
  116. package/dist/plugins.d.ts +14 -1
  117. package/dist/plugins.js +17 -6
  118. package/dist/populate.d.ts +2 -2
  119. package/dist/populate.js +47 -42
  120. package/dist/rateLimit/applyTrustProxy.d.ts +3 -0
  121. package/dist/rateLimit/applyTrustProxy.js +17 -0
  122. package/dist/rateLimit/createStore.d.ts +2 -0
  123. package/dist/rateLimit/createStore.js +28 -0
  124. package/dist/rateLimit/memoryStore.d.ts +2 -0
  125. package/dist/rateLimit/memoryStore.js +108 -0
  126. package/dist/rateLimit/middleware.d.ts +3 -0
  127. package/dist/rateLimit/middleware.js +109 -0
  128. package/dist/rateLimit/mongoStore.d.ts +4 -0
  129. package/dist/rateLimit/mongoStore.js +123 -0
  130. package/dist/rateLimit/policies.d.ts +10 -0
  131. package/dist/rateLimit/policies.js +149 -0
  132. package/dist/rateLimit/redisStore.d.ts +4 -0
  133. package/dist/rateLimit/redisStore.js +156 -0
  134. package/dist/rateLimit/types.d.ts +54 -0
  135. package/dist/rateLimit/types.js +9 -0
  136. package/dist/rbac/access.js +35 -14
  137. package/dist/rbac/assertAllowed.d.ts +9 -0
  138. package/dist/rbac/assertAllowed.js +182 -0
  139. package/dist/rbac/membershipOrgAdminSource.d.ts +6 -0
  140. package/dist/rbac/membershipOrgAdminSource.js +122 -0
  141. package/dist/rbac/modelRouterAccess.d.ts +4 -0
  142. package/dist/rbac/modelRouterAccess.js +11 -4
  143. package/dist/rbac/permissionUtils.js +3 -2
  144. package/dist/rbac/resolve.js +65 -35
  145. package/dist/rbac/roleModel.d.ts +2 -5
  146. package/dist/rbac/roleModel.js +18 -4
  147. package/dist/rbac/routes.js +15 -6
  148. package/dist/rbac/statements.d.ts +10 -1
  149. package/dist/rbac/statements.js +19 -2
  150. package/dist/rbac/types.d.ts +5 -0
  151. package/dist/realtime/changeStreamWatcher.d.ts +10 -4
  152. package/dist/realtime/changeStreamWatcher.js +110 -64
  153. package/dist/realtime/deprecation.d.ts +13 -0
  154. package/dist/realtime/deprecation.js +33 -0
  155. package/dist/realtime/realtimeApp.d.ts +2 -1
  156. package/dist/realtime/realtimeApp.js +11 -11
  157. package/dist/realtime/registry.d.ts +0 -31
  158. package/dist/realtime/registry.js +44 -31
  159. package/dist/realtime/socketAuth.d.ts +5 -5
  160. package/dist/realtime/socketAuth.js +11 -1
  161. package/dist/realtime/socketUser.d.ts +5 -1
  162. package/dist/realtime/types.d.ts +14 -4
  163. package/dist/schemaMetadata.d.ts +56 -0
  164. package/dist/schemaMetadata.js +524 -0
  165. package/dist/seedRunner.d.ts +88 -0
  166. package/dist/seedRunner.js +627 -0
  167. package/dist/sync/adminBroadcastScope.d.ts +40 -0
  168. package/dist/sync/adminBroadcastScope.js +194 -0
  169. package/dist/sync/adminWindowAccess.d.ts +13 -0
  170. package/dist/sync/adminWindowAccess.js +96 -0
  171. package/dist/sync/adminWindowMutation.d.ts +88 -0
  172. package/dist/sync/adminWindowMutation.js +247 -0
  173. package/dist/sync/executors.d.ts +19 -3
  174. package/dist/sync/executors.js +194 -165
  175. package/dist/sync/loadHarness.js +28 -19
  176. package/dist/sync/models.js +26 -24
  177. package/dist/sync/mutationHandler.d.ts +14 -2
  178. package/dist/sync/mutationHandler.js +201 -76
  179. package/dist/sync/registrationSideEffects.d.ts +35 -0
  180. package/dist/sync/registrationSideEffects.js +151 -0
  181. package/dist/sync/registry.d.ts +2 -52
  182. package/dist/sync/registry.js +42 -187
  183. package/dist/sync/routes.d.ts +13 -0
  184. package/dist/sync/routes.js +116 -58
  185. package/dist/sync/scripts/compactTombstones.js +0 -2
  186. package/dist/sync/socketHandlers.d.ts +8 -2
  187. package/dist/sync/socketHandlers.js +144 -50
  188. package/dist/sync/streams.d.ts +2 -0
  189. package/dist/sync/streams.js +7 -1
  190. package/dist/sync/syncApp.d.ts +4 -3
  191. package/dist/sync/syncApp.js +5 -4
  192. package/dist/sync/syncBatch.d.ts +5 -2
  193. package/dist/sync/syncBatch.js +7 -6
  194. package/dist/sync/syncSeqPlugin.d.ts +1 -1
  195. package/dist/sync/syncSeqPlugin.js +20 -16
  196. package/dist/sync/types.d.ts +18 -0
  197. package/dist/terrenoApp.d.ts +48 -5
  198. package/dist/terrenoApp.js +157 -72
  199. package/dist/tests/createTestData.d.ts +1 -3
  200. package/dist/tests/createTestData.js +3 -5
  201. package/dist/tests/models.d.ts +3 -0
  202. package/dist/tests/models.js +15 -2
  203. package/dist/tests/testHelper.d.ts +0 -5
  204. package/dist/tests/testHelper.js +2 -9
  205. package/dist/types/authToken.d.ts +33 -0
  206. package/dist/types/authToken.js +2 -0
  207. package/dist/types/mcpServiceToken.d.ts +41 -0
  208. package/dist/types/mcpServiceToken.js +2 -0
  209. package/dist/types/membership.d.ts +23 -0
  210. package/dist/types/membership.js +2 -0
  211. package/dist/types/notification.d.ts +28 -0
  212. package/dist/types/notification.js +2 -0
  213. package/dist/types/notificationPreference.d.ts +20 -0
  214. package/dist/types/notificationPreference.js +2 -0
  215. package/dist/types/organization.d.ts +36 -0
  216. package/dist/types/organization.js +2 -0
  217. package/dist/webhooks/headerValue.d.ts +2 -0
  218. package/dist/webhooks/headerValue.js +14 -0
  219. package/dist/webhooks/idempotency/memoryStore.d.ts +10 -0
  220. package/dist/webhooks/idempotency/memoryStore.js +65 -0
  221. package/dist/webhooks/idempotency/mongoStore.d.ts +4 -0
  222. package/dist/webhooks/idempotency/mongoStore.js +150 -0
  223. package/dist/webhooks/idempotency/webhookReceipt.d.ts +17 -0
  224. package/dist/webhooks/idempotency/webhookReceipt.js +39 -0
  225. package/dist/webhooks/rawBody.d.ts +15 -0
  226. package/dist/webhooks/rawBody.js +23 -0
  227. package/dist/webhooks/timingSafeEqual.d.ts +4 -0
  228. package/dist/webhooks/timingSafeEqual.js +17 -0
  229. package/dist/webhooks/verifiers/hmac.d.ts +15 -0
  230. package/dist/webhooks/verifiers/hmac.js +49 -0
  231. package/dist/webhooks/verifiers/sendgrid.d.ts +10 -0
  232. package/dist/webhooks/verifiers/sendgrid.js +56 -0
  233. package/dist/webhooks/verifiers/stripe.d.ts +9 -0
  234. package/dist/webhooks/verifiers/stripe.js +99 -0
  235. package/dist/webhooks/verifiers/twilio.d.ts +9 -0
  236. package/dist/webhooks/verifiers/twilio.js +112 -0
  237. package/dist/webhooks/webhooksApp.d.ts +33 -0
  238. package/dist/webhooks/webhooksApp.js +195 -0
  239. package/package.json +32 -27
  240. package/src/__snapshots__/openApi.test.ts.snap +444 -36
  241. package/src/__snapshots__/openApiBuilder.test.ts.snap +24 -24
  242. package/src/__snapshots__/schemaMetadata.test.ts.snap +196 -0
  243. package/src/actions.ts +20 -13
  244. package/src/adminModelRouter.test.ts +133 -0
  245. package/src/adminTypes.ts +8 -0
  246. package/src/api.arrayOperations.test.ts +43 -31
  247. package/src/api.hooks.test.ts +38 -29
  248. package/src/api.query.test.ts +31 -31
  249. package/src/api.test.ts +133 -97
  250. package/src/api.ts +84 -27
  251. package/src/audit/auditApp.test.ts +243 -0
  252. package/src/audit/auditApp.ts +139 -0
  253. package/src/audit/auditEventModel.ts +156 -0
  254. package/src/audit/auditRouter.test.ts +456 -0
  255. package/src/audit/cloudTasksEnqueue.test.ts +124 -0
  256. package/src/audit/cloudTasksEnqueue.ts +104 -0
  257. package/src/audit/diff.ts +163 -0
  258. package/src/audit/processQueue.ts +69 -0
  259. package/src/audit/rbacSink.test.ts +86 -0
  260. package/src/audit/rbacSink.ts +42 -0
  261. package/src/audit/record.test.ts +402 -0
  262. package/src/audit/record.ts +328 -0
  263. package/src/auth.test.ts +108 -52
  264. package/src/auth.ts +98 -29
  265. package/src/authRecovery.test.ts +281 -0
  266. package/src/authRecovery.ts +279 -0
  267. package/src/authTokens.test.ts +94 -0
  268. package/src/authTokens.ts +118 -0
  269. package/src/authVerification.test.ts +293 -0
  270. package/src/betterAuth.ts +31 -0
  271. package/src/betterAuthApp.test.ts +1 -0
  272. package/src/betterAuthApp.ts +27 -9
  273. package/src/betterAuthSetup.test.ts +595 -38
  274. package/src/betterAuthSetup.ts +261 -5
  275. package/src/collectionRegistry.test.ts +164 -0
  276. package/src/collectionRegistry.ts +135 -0
  277. package/src/configurationApp.ts +13 -7
  278. package/src/docLoader.test.ts +45 -1
  279. package/src/docLoader.ts +37 -6
  280. package/src/express.d.ts +3 -0
  281. package/src/expressServer.test.ts +180 -68
  282. package/src/expressServer.ts +75 -19
  283. package/src/githubAuth.test.ts +60 -55
  284. package/src/index.ts +127 -0
  285. package/src/mcp/auth.test.ts +47 -0
  286. package/src/mcp/auth.ts +32 -11
  287. package/src/mcp/handlers.test.ts +275 -0
  288. package/src/mcp/handlers.ts +45 -172
  289. package/src/mcp/integration.test.ts +59 -9
  290. package/src/mcp/query.ts +5 -7
  291. package/src/mcp/registry.ts +29 -20
  292. package/src/mcp/schemaGenerator.test.ts +8 -0
  293. package/src/mcp/schemaGenerator.ts +49 -131
  294. package/src/mcp/server.ts +2 -0
  295. package/src/mcp/serviceTokens.test.ts +330 -0
  296. package/src/mcp/serviceTokens.ts +307 -0
  297. package/src/mcp/toolGenerator.test.ts +82 -1
  298. package/src/mcp/types.ts +2 -6
  299. package/src/migrations/cli.test.ts +376 -0
  300. package/src/migrations/cli.ts +283 -0
  301. package/src/migrations/fixtures/all-down/20260910120000-one.ts +6 -0
  302. package/src/migrations/fixtures/all-down/20260910120001-two.ts +6 -0
  303. package/src/migrations/fixtures/bad-id/20260910120000-mismatch.ts +4 -0
  304. package/src/migrations/fixtures/bad-name/not-a-migration.ts +4 -0
  305. package/src/migrations/fixtures/missing-up/20260910120000-noup.ts +2 -0
  306. package/src/migrations/fixtures/valid/20260910120000-alpha.ts +4 -0
  307. package/src/migrations/fixtures/valid/20260910120001-beta.ts +6 -0
  308. package/src/migrations/generate.test.ts +333 -0
  309. package/src/migrations/generate.ts +216 -0
  310. package/src/migrations/load.test.ts +103 -0
  311. package/src/migrations/load.ts +124 -0
  312. package/src/migrations/lock.test.ts +133 -0
  313. package/src/migrations/lock.ts +118 -0
  314. package/src/migrations/runner.test.ts +504 -0
  315. package/src/migrations/runner.ts +358 -0
  316. package/src/migrations/schemaCatalog.test.ts +159 -0
  317. package/src/migrations/schemaCatalog.ts +262 -0
  318. package/src/migrations/types.ts +94 -0
  319. package/src/models/mcpServiceToken.test.ts +129 -0
  320. package/src/models/mcpServiceToken.ts +158 -0
  321. package/src/models/notification.ts +68 -0
  322. package/src/models/notificationPreference.ts +62 -0
  323. package/src/notifications/notificationService.ts +254 -0
  324. package/src/notifications/notificationsApp.test.ts +505 -0
  325. package/src/notifications/notificationsApp.ts +200 -0
  326. package/src/notifications/notificationsBeforeSend.ts +51 -0
  327. package/src/openApi.test.ts +80 -65
  328. package/src/openApi.ts +2 -1
  329. package/src/openApiBuilder.test.ts +95 -7
  330. package/src/openApiBuilder.ts +60 -12
  331. package/src/openApiCompat.ts +1 -1
  332. package/src/openApiValidator.test.ts +270 -56
  333. package/src/openApiValidator.ts +219 -36
  334. package/src/orgs/orgAccessOptIn.test.ts +87 -0
  335. package/src/orgs/orgContext.test.ts +259 -0
  336. package/src/orgs/orgContext.ts +151 -0
  337. package/src/orgs/orgPermissions.test.ts +105 -0
  338. package/src/orgs/orgPermissions.ts +40 -0
  339. package/src/orgs/orgPlugin.test.ts +130 -0
  340. package/src/orgs/orgPlugin.ts +70 -0
  341. package/src/orgs/orgRbac.test.ts +267 -0
  342. package/src/orgs/orgSecurityDefects.test.ts +415 -0
  343. package/src/orgs/organizationModel.test.ts +205 -0
  344. package/src/orgs/organizationModel.ts +257 -0
  345. package/src/orgs/organizationSettings.test.ts +113 -0
  346. package/src/orgs/organizationSettings.ts +126 -0
  347. package/src/orgs/orgsApp.test.ts +382 -0
  348. package/src/orgs/orgsApp.ts +563 -0
  349. package/src/permissions.test.ts +62 -36
  350. package/src/permissions.ts +8 -30
  351. package/src/plugins.test.ts +14 -0
  352. package/src/plugins.ts +34 -9
  353. package/src/populate.test.ts +34 -0
  354. package/src/populate.ts +40 -29
  355. package/src/rateLimit/applyTrustProxy.ts +17 -0
  356. package/src/rateLimit/createStore.ts +25 -0
  357. package/src/rateLimit/memoryStore.ts +40 -0
  358. package/src/rateLimit/middleware.ts +79 -0
  359. package/src/rateLimit/mongoStore.test.ts +80 -0
  360. package/src/rateLimit/mongoStore.ts +77 -0
  361. package/src/rateLimit/policies.ts +130 -0
  362. package/src/rateLimit/rateLimit.test.ts +328 -0
  363. package/src/rateLimit/redisStore.ioredis.test.ts +29 -0
  364. package/src/rateLimit/redisStore.test.ts +114 -0
  365. package/src/rateLimit/redisStore.ts +86 -0
  366. package/src/rateLimit/types.ts +64 -0
  367. package/src/rbac/access.ts +16 -4
  368. package/src/rbac/assertAllowed.test.ts +325 -0
  369. package/src/rbac/assertAllowed.ts +157 -0
  370. package/src/rbac/backfillAdmins.test.ts +124 -0
  371. package/src/rbac/fieldViews.test.ts +89 -0
  372. package/src/rbac/membershipOrgAdminSource.ts +59 -0
  373. package/src/rbac/modelRouterAccess.test.ts +126 -0
  374. package/src/rbac/modelRouterAccess.ts +8 -2
  375. package/src/rbac/permissionUtils.test.ts +26 -5
  376. package/src/rbac/permissionUtils.ts +3 -2
  377. package/src/rbac/realtimeAccess.test.ts +109 -1
  378. package/src/rbac/resolve.test.ts +34 -2
  379. package/src/rbac/resolve.ts +31 -11
  380. package/src/rbac/roleManager.test.ts +169 -0
  381. package/src/rbac/roleModel.test.ts +34 -1
  382. package/src/rbac/roleModel.ts +17 -1
  383. package/src/rbac/routes.test.ts +233 -0
  384. package/src/rbac/routes.ts +16 -6
  385. package/src/rbac/statements.test.ts +19 -0
  386. package/src/rbac/statements.ts +19 -1
  387. package/src/rbac/types.ts +5 -0
  388. package/src/realtime/changeStreamWatcher.ts +73 -33
  389. package/src/realtime/deprecation.test.ts +60 -0
  390. package/src/realtime/deprecation.ts +33 -0
  391. package/src/realtime/realtime.test.ts +365 -189
  392. package/src/realtime/realtimeApp.ts +11 -11
  393. package/src/realtime/realtimeAppSetup.test.ts +32 -5
  394. package/src/realtime/registry.ts +48 -42
  395. package/src/realtime/sessionRevalidation.test.ts +57 -44
  396. package/src/realtime/socketAuth.test.ts +75 -23
  397. package/src/realtime/socketAuth.ts +17 -6
  398. package/src/realtime/socketUser.ts +5 -3
  399. package/src/realtime/types.ts +14 -4
  400. package/src/schemaMetadata.test.ts +419 -0
  401. package/src/schemaMetadata.ts +593 -0
  402. package/src/scrubAdminFields.test.ts +105 -0
  403. package/src/seedRunner.test.ts +591 -0
  404. package/src/seedRunner.ts +464 -0
  405. package/src/sync/adminBroadcastConfig.test.ts +96 -0
  406. package/src/sync/adminBroadcastScope.test.ts +155 -0
  407. package/src/sync/adminBroadcastScope.ts +123 -0
  408. package/src/sync/adminWindowAccess.test.ts +57 -0
  409. package/src/sync/adminWindowAccess.ts +32 -0
  410. package/src/sync/adminWindowMutation.test.ts +450 -0
  411. package/src/sync/adminWindowMutation.ts +283 -0
  412. package/src/sync/docMatchesMutationData.test.ts +16 -0
  413. package/src/sync/ensureSyncIndexes.test.ts +54 -15
  414. package/src/sync/executors.test.ts +40 -0
  415. package/src/sync/executors.ts +57 -18
  416. package/src/sync/integration.test.ts +15 -7
  417. package/src/sync/loadHarness.ts +28 -19
  418. package/src/sync/models.ts +32 -18
  419. package/src/sync/mutationHandler.test.ts +293 -17
  420. package/src/sync/mutationHandler.ts +180 -36
  421. package/src/sync/registrationSideEffects.test.ts +126 -0
  422. package/src/sync/registrationSideEffects.ts +131 -0
  423. package/src/sync/registry.ts +49 -171
  424. package/src/sync/routes.ts +55 -10
  425. package/src/sync/scripts/compactTombstones.ts +0 -2
  426. package/src/sync/sessionRevalidationIntegration.test.ts +12 -11
  427. package/src/sync/socketHandlers.ts +154 -58
  428. package/src/sync/streams.ts +6 -0
  429. package/src/sync/sync.test.ts +28 -25
  430. package/src/sync/syncApp.ts +5 -4
  431. package/src/sync/syncBatch.ts +10 -4
  432. package/src/sync/syncFrontier.test.ts +17 -15
  433. package/src/sync/syncPhaseC.test.ts +54 -43
  434. package/src/sync/syncRoutes.test.ts +347 -38
  435. package/src/sync/syncSeqPlugin.ts +66 -44
  436. package/src/sync/syncSocket.test.ts +341 -81
  437. package/src/sync/types.ts +20 -0
  438. package/src/terrenoApp.mcpServiceTokens.test.ts +173 -0
  439. package/src/terrenoApp.migrations.test.ts +114 -0
  440. package/src/terrenoApp.test.ts +41 -0
  441. package/src/terrenoApp.ts +181 -46
  442. package/src/tests/createTestData.ts +2 -2
  443. package/src/tests/models.ts +24 -3
  444. package/src/tests/testHelper.ts +1 -7
  445. package/src/types/authToken.ts +41 -0
  446. package/src/types/mcpServiceToken.ts +48 -0
  447. package/src/types/membership.ts +48 -0
  448. package/src/types/notification.ts +34 -0
  449. package/src/types/notificationPreference.ts +28 -0
  450. package/src/types/organization.ts +49 -0
  451. package/src/webhooks/headerValue.test.ts +22 -0
  452. package/src/webhooks/headerValue.ts +12 -0
  453. package/src/webhooks/idempotency/memoryStore.ts +34 -0
  454. package/src/webhooks/idempotency/mongoStore.test.ts +274 -0
  455. package/src/webhooks/idempotency/mongoStore.ts +83 -0
  456. package/src/webhooks/idempotency/webhookReceipt.ts +67 -0
  457. package/src/webhooks/rawBody.test.ts +107 -0
  458. package/src/webhooks/rawBody.ts +24 -0
  459. package/src/webhooks/timingSafeEqual.ts +16 -0
  460. package/src/webhooks/verifiers/hmac.test.ts +110 -0
  461. package/src/webhooks/verifiers/hmac.ts +54 -0
  462. package/src/webhooks/verifiers/providerVerifiers.test.ts +388 -0
  463. package/src/webhooks/verifiers/sendgrid.ts +59 -0
  464. package/src/webhooks/verifiers/stripe.ts +67 -0
  465. package/src/webhooks/verifiers/twilio.ts +69 -0
  466. package/src/webhooks/webhooksApp.test.ts +221 -0
  467. package/src/webhooks/webhooksApp.ts +144 -0
  468. package/tsconfig.json +1 -1
  469. package/tsconfig.typedoc.json +2 -1
  470. package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.d.ts +0 -2
  471. package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
  472. package/src/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
@@ -0,0 +1,69 @@
1
+ import crypto from "node:crypto";
2
+ import type {Request} from "express";
3
+
4
+ import {headerValue} from "../headerValue";
5
+ import {timingSafeEqualUtf8} from "../timingSafeEqual";
6
+
7
+ export interface TwilioSignatureOptions {
8
+ authToken: string;
9
+ url?: string | ((req: Request) => string);
10
+ }
11
+
12
+ const isUrlencoded = (req: Request): boolean => {
13
+ const contentType = headerValue(req, "content-type") ?? "";
14
+ return contentType.toLowerCase().includes("application/x-www-form-urlencoded");
15
+ };
16
+
17
+ const resolveUrl = (
18
+ req: Request,
19
+ url?: string | ((req: Request) => string)
20
+ ): string | undefined => {
21
+ if (typeof url === "function") {
22
+ return url(req);
23
+ }
24
+ if (typeof url === "string" && url.length > 0) {
25
+ return url;
26
+ }
27
+ return undefined;
28
+ };
29
+
30
+ const formParams = (body: unknown): Record<string, string> | undefined => {
31
+ if (!body || typeof body !== "object" || Array.isArray(body)) {
32
+ return undefined;
33
+ }
34
+ const params: Record<string, string> = {};
35
+ for (const [key, value] of Object.entries(body as Record<string, unknown>)) {
36
+ if (typeof value !== "string") {
37
+ return undefined;
38
+ }
39
+ params[key] = value;
40
+ }
41
+ return params;
42
+ };
43
+
44
+ /**
45
+ * Verifies Twilio `X-Twilio-Signature` (HMAC-SHA1 of callback URL + sorted POST fields).
46
+ */
47
+ export const twilioSignature = (options: TwilioSignatureOptions): ((req: Request) => boolean) => {
48
+ return (req: Request): boolean => {
49
+ if (!isUrlencoded(req) || !req.rawBody) {
50
+ return false;
51
+ }
52
+ const provided = headerValue(req, "X-Twilio-Signature");
53
+ const callbackUrl = resolveUrl(req, options.url);
54
+ const params = formParams(req.body);
55
+ if (!provided || !callbackUrl || !params) {
56
+ return false;
57
+ }
58
+ const keys = Object.keys(params).sort();
59
+ let data = callbackUrl;
60
+ for (const key of keys) {
61
+ data += key + params[key];
62
+ }
63
+ const expected = crypto
64
+ .createHmac("sha1", options.authToken)
65
+ .update(data, "utf8")
66
+ .digest("base64");
67
+ return timingSafeEqualUtf8({expected, provided});
68
+ };
69
+ };
@@ -0,0 +1,221 @@
1
+ import {describe, it} from "bun:test";
2
+ import {assert} from "chai";
3
+ import type {Application, Request} from "express";
4
+ import supertest from "supertest";
5
+
6
+ import type {UserModel as AuthUserModel} from "../auth";
7
+ import {TerrenoApp} from "../terrenoApp";
8
+ import {UserModel} from "../tests";
9
+ import {hmacSignature} from "./verifiers/hmac";
10
+ import {WebhooksApp} from "./webhooksApp";
11
+
12
+ const WEBHOOK_SECRET = "whsec_test";
13
+ const FIXTURE_BODY = `{"id":"evt_1"}`;
14
+ /** openssl dgst -sha256 -hmac whsec_test of {"id":"evt_1"} */
15
+ const FIXTURE_HMAC_HEX = "030fa3b2413d1993c551364bd53bb9b3edb5c0c34d55dba6ada6041245632811";
16
+ const SPACED_BODY = `{"id": "evt_1"}`;
17
+ /** HMAC of JSON.stringify({id:"evt_1"}) which is FIXTURE_BODY, not SPACED_BODY */
18
+ const STRINGIFY_HMAC_HEX = FIXTURE_HMAC_HEX;
19
+ /** openssl dgst -sha256 -hmac whsec_test of {"id": "evt_1"} */
20
+ const SPACED_HMAC_HEX = "13b1c709ea677bd832fb32f71b5ab6e9fbb22ead444bc5471aff93caffeb5042";
21
+
22
+ const buildWebhookApp = ({
23
+ eventId,
24
+ handler,
25
+ }: {
26
+ eventId?: (req: Request) => string;
27
+ handler: () => Promise<void> | void;
28
+ }): {app: Application; webhooks: WebhooksApp} => {
29
+ const webhooks = new WebhooksApp({idempotency: {store: "memory"}});
30
+ webhooks.route({
31
+ eventId: eventId ?? ((req) => String((req.body as {id?: string})?.id ?? "")),
32
+ handler,
33
+ path: "/webhooks/example",
34
+ source: "example",
35
+ verify: hmacSignature({header: "X-Webhook-Signature", secret: WEBHOOK_SECRET}),
36
+ });
37
+ const app = new TerrenoApp({
38
+ logRequests: false,
39
+ skipListen: true,
40
+ userModel: UserModel as unknown as AuthUserModel,
41
+ })
42
+ .register(webhooks)
43
+ .build();
44
+ return {app, webhooks};
45
+ };
46
+
47
+ const postSigned = (
48
+ app: Application,
49
+ {body = FIXTURE_BODY, signature = FIXTURE_HMAC_HEX}: {body?: string; signature?: string} = {}
50
+ ): Promise<supertest.Response> => {
51
+ const request = supertest(app).post("/webhooks/example").set("Content-Type", "application/json");
52
+ if (signature) {
53
+ request.set("X-Webhook-Signature", signature);
54
+ }
55
+ return request.send(body);
56
+ };
57
+
58
+ describe("WebhooksApp HMAC tracer", () => {
59
+ it("returns 200 and runs the handler once for a valid HMAC", async () => {
60
+ let handlerCalls = 0;
61
+ const {app} = buildWebhookApp({
62
+ handler: () => {
63
+ handlerCalls += 1;
64
+ },
65
+ });
66
+
67
+ const res = await postSigned(app);
68
+
69
+ assert.equal(res.status, 200);
70
+ assert.equal(res.body.received, true);
71
+ assert.isUndefined(res.body.duplicate);
72
+ assert.equal(handlerCalls, 1);
73
+ });
74
+
75
+ it("returns 401 webhook-signature-invalid when the signature header is missing", async () => {
76
+ let handlerCalls = 0;
77
+ const {app} = buildWebhookApp({
78
+ handler: () => {
79
+ handlerCalls += 1;
80
+ },
81
+ });
82
+
83
+ const res = await postSigned(app, {signature: ""});
84
+
85
+ assert.equal(res.status, 401);
86
+ assert.equal(res.body.code, "webhook-signature-invalid");
87
+ assert.equal(handlerCalls, 0);
88
+ });
89
+
90
+ it("returns 401 when the body is tampered after signing", async () => {
91
+ let handlerCalls = 0;
92
+ const {app} = buildWebhookApp({
93
+ handler: () => {
94
+ handlerCalls += 1;
95
+ },
96
+ });
97
+
98
+ const res = await postSigned(app, {body: `{"id":"evt_tampered"}`});
99
+
100
+ assert.equal(res.status, 401);
101
+ assert.equal(res.body.code, "webhook-signature-invalid");
102
+ assert.equal(handlerCalls, 0);
103
+ });
104
+
105
+ it("rejects HMAC computed from JSON.stringify(parsed body) when it differs from raw bytes", async () => {
106
+ let handlerCalls = 0;
107
+ const {app} = buildWebhookApp({
108
+ handler: () => {
109
+ handlerCalls += 1;
110
+ },
111
+ });
112
+
113
+ const rejected = await postSigned(app, {
114
+ body: SPACED_BODY,
115
+ signature: STRINGIFY_HMAC_HEX,
116
+ });
117
+ assert.equal(rejected.status, 401);
118
+ assert.equal(handlerCalls, 0);
119
+
120
+ const accepted = await postSigned(app, {
121
+ body: SPACED_BODY,
122
+ signature: SPACED_HMAC_HEX,
123
+ });
124
+ assert.equal(accepted.status, 200);
125
+ assert.equal(handlerCalls, 1);
126
+ });
127
+
128
+ it("returns duplicate: true on a replayed eventId without a second handler call", async () => {
129
+ let handlerCalls = 0;
130
+ const {app} = buildWebhookApp({
131
+ handler: () => {
132
+ handlerCalls += 1;
133
+ },
134
+ });
135
+
136
+ const first = await postSigned(app);
137
+ const second = await postSigned(app);
138
+
139
+ assert.equal(first.status, 200);
140
+ assert.isUndefined(first.body.duplicate);
141
+ assert.equal(second.status, 200);
142
+ assert.equal(second.body.received, true);
143
+ assert.equal(second.body.duplicate, true);
144
+ assert.equal(handlerCalls, 1);
145
+ });
146
+
147
+ it("releases the claim when the handler throws so a retry succeeds", async () => {
148
+ let handlerCalls = 0;
149
+ const {app} = buildWebhookApp({
150
+ handler: () => {
151
+ handlerCalls += 1;
152
+ if (handlerCalls === 1) {
153
+ throw new Error("handler exploded");
154
+ }
155
+ },
156
+ });
157
+
158
+ const failed = await postSigned(app);
159
+ const retried = await postSigned(app);
160
+
161
+ assert.equal(failed.status, 500);
162
+ assert.equal(failed.body.title, "Webhook handler failed");
163
+ assert.equal(retried.status, 200);
164
+ assert.equal(retried.body.received, true);
165
+ assert.isUndefined(retried.body.duplicate);
166
+ assert.equal(handlerCalls, 2);
167
+ });
168
+
169
+ it("does not list the webhook path in /openapi.json", async () => {
170
+ const {app} = buildWebhookApp({handler: () => undefined});
171
+
172
+ const res = await supertest(app).get("/openapi.json").expect(200);
173
+ const paths = res.body.paths as Record<string, unknown> | undefined;
174
+ assert.isUndefined(paths?.["/webhooks/example"]);
175
+ });
176
+
177
+ it("skips the idempotency store when eventId is empty and still runs the handler", async () => {
178
+ let handlerCalls = 0;
179
+ const {app} = buildWebhookApp({
180
+ eventId: () => "",
181
+ handler: () => {
182
+ handlerCalls += 1;
183
+ },
184
+ });
185
+
186
+ const first = await postSigned(app);
187
+ const second = await postSigned(app);
188
+
189
+ assert.equal(first.status, 200);
190
+ assert.equal(second.status, 200);
191
+ assert.isUndefined(second.body.duplicate);
192
+ assert.equal(handlerCalls, 2);
193
+ });
194
+
195
+ it("lets a handler claim nested event ids through webhooks.claim", async () => {
196
+ const claims: string[] = [];
197
+ const webhooks = new WebhooksApp({idempotency: {store: "memory"}});
198
+ webhooks.route({
199
+ eventId: () => "",
200
+ handler: async () => {
201
+ const first = await webhooks.claim({eventId: "sg_nested", source: "sendgrid"});
202
+ const second = await webhooks.claim({eventId: "sg_nested", source: "sendgrid"});
203
+ claims.push(first, second);
204
+ },
205
+ path: "/webhooks/example",
206
+ source: "example",
207
+ verify: hmacSignature({header: "X-Webhook-Signature", secret: WEBHOOK_SECRET}),
208
+ });
209
+ const app = new TerrenoApp({
210
+ logRequests: false,
211
+ skipListen: true,
212
+ userModel: UserModel as unknown as AuthUserModel,
213
+ })
214
+ .register(webhooks)
215
+ .build();
216
+
217
+ const res = await postSigned(app);
218
+ assert.equal(res.status, 200);
219
+ assert.deepEqual(claims, ["claimed", "duplicate"]);
220
+ });
221
+ });
@@ -0,0 +1,144 @@
1
+ import type {IncomingHttpHeaders} from "node:http";
2
+ import type {Application, Request, Response} from "express";
3
+
4
+ import {asyncHandler} from "../api";
5
+ import {APIError, isAPIError} from "../errors";
6
+ import {createScopedLogger} from "../logger";
7
+
8
+ import type {TerrenoPlugin} from "../terrenoPlugin";
9
+ import {
10
+ createMemoryIdempotencyStore,
11
+ type WebhookClaimArgs,
12
+ type WebhookClaimResult,
13
+ type WebhookIdempotencyStore,
14
+ } from "./idempotency/memoryStore";
15
+ import {createMongoIdempotencyStore} from "./idempotency/mongoStore";
16
+
17
+ export interface WebhookHandlerContext {
18
+ body: unknown;
19
+ eventId: string;
20
+ headers: IncomingHttpHeaders;
21
+ rawBody: Buffer;
22
+ }
23
+
24
+ export interface WebhookRouteOptions {
25
+ eventId?: (req: Request) => string;
26
+ handler: (context: WebhookHandlerContext) => Promise<void> | void;
27
+ path: string;
28
+ source: string;
29
+ verify: (req: Request) => boolean | Promise<boolean>;
30
+ }
31
+
32
+ export interface WebhooksAppOptions {
33
+ idempotency?: {
34
+ store?: "memory" | "mongo";
35
+ ttlDays?: number;
36
+ };
37
+ }
38
+
39
+ export class WebhooksApp implements TerrenoPlugin {
40
+ private readonly routes: WebhookRouteOptions[] = [];
41
+ private readonly store: WebhookIdempotencyStore;
42
+
43
+ constructor(options: WebhooksAppOptions = {}) {
44
+ const storeKind = options.idempotency?.store ?? "memory";
45
+ if (storeKind === "mongo") {
46
+ this.store = createMongoIdempotencyStore({ttlDays: options.idempotency?.ttlDays});
47
+ } else {
48
+ this.store = createMemoryIdempotencyStore();
49
+ }
50
+ }
51
+
52
+ route(options: WebhookRouteOptions): this {
53
+ this.routes.push(options);
54
+ return this;
55
+ }
56
+
57
+ claim = async (args: WebhookClaimArgs): Promise<WebhookClaimResult> => {
58
+ return this.store.claim(args);
59
+ };
60
+
61
+ release = async (args: WebhookClaimArgs): Promise<void> => {
62
+ await this.store.release(args);
63
+ };
64
+
65
+ register(app: Application): void {
66
+ for (const route of this.routes) {
67
+ app.post(
68
+ route.path,
69
+ asyncHandler(async (req: Request, res) => {
70
+ await this.dispatch({req, res, route});
71
+ })
72
+ );
73
+ }
74
+ }
75
+
76
+ private dispatch = async ({
77
+ req,
78
+ res,
79
+ route,
80
+ }: {
81
+ req: Request;
82
+ res: Response;
83
+ route: WebhookRouteOptions;
84
+ }): Promise<void> => {
85
+ if (!req.rawBody) {
86
+ throw new APIError({
87
+ code: "webhook-body-missing",
88
+ disableExternalErrorTracking: true,
89
+ status: 400,
90
+ title: "Missing webhook body",
91
+ });
92
+ }
93
+
94
+ const isValid = await route.verify(req);
95
+ if (!isValid) {
96
+ throw new APIError({
97
+ code: "webhook-signature-invalid",
98
+ disableExternalErrorTracking: true,
99
+ status: 401,
100
+ title: "Invalid webhook signature",
101
+ });
102
+ }
103
+
104
+ const eventId = route.eventId ? route.eventId(req) : "";
105
+ const log = createScopedLogger({
106
+ labels: {eventId: eventId || "none", source: route.source},
107
+ prefix: "[Webhook]",
108
+ });
109
+
110
+ if (!eventId) {
111
+ log.warn("Empty eventId; skipping idempotency claim");
112
+ } else {
113
+ const claimResult = await this.claim({eventId, source: route.source});
114
+ if (claimResult === "duplicate") {
115
+ log.info("Duplicate webhook event");
116
+ res.status(200).json({duplicate: true, received: true});
117
+ return;
118
+ }
119
+ }
120
+
121
+ try {
122
+ await route.handler({
123
+ body: req.body,
124
+ eventId,
125
+ headers: req.headers,
126
+ rawBody: req.rawBody,
127
+ });
128
+ } catch (error) {
129
+ if (eventId) {
130
+ await this.release({eventId, source: route.source});
131
+ }
132
+ if (isAPIError(error)) {
133
+ throw error;
134
+ }
135
+ throw new APIError({
136
+ cause: error,
137
+ status: 500,
138
+ title: "Webhook handler failed",
139
+ });
140
+ }
141
+
142
+ res.status(200).json({received: true});
143
+ };
144
+ }
package/tsconfig.json CHANGED
@@ -55,6 +55,6 @@
55
55
  /* Basic Options */
56
56
  "target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
57
57
  },
58
- "exclude": ["node_modules", "**/*.test.ts", "src/tests"],
58
+ "exclude": ["node_modules", "**/*.test.ts", "src/tests", "src/migrations/cli.ts"],
59
59
  "include": ["src/**/*.ts*", "src/*.ts", "src/**/*.js", "src/**/*.d.ts"]
60
60
  }
@@ -5,6 +5,7 @@
5
5
  "src/tests.ts",
6
6
  "src/tests/**",
7
7
  "**/*.test.ts",
8
- "src/sync/loadHarness.ts"
8
+ "src/sync/loadHarness.ts",
9
+ "src/migrations/cli.ts"
9
10
  ]
10
11
  }
@@ -1,2 +0,0 @@
1
- declare function _exports(jsonObject: object): string;
2
- export = _exports;
@@ -1,13 +0,0 @@
1
- "use strict";
2
- // Vendored from https://github.com/wesleytodd/express-openapi (branch: express-5)
3
- // License: ISC (see ../LICENSE)
4
- var YAML = require('yaml');
5
- /**
6
- * Converts a json to yaml
7
- * @param {object} jsonObject
8
- * @returns {string} yamlString
9
- */
10
- module.exports = function (jsonObject) {
11
- var doc = YAML.stringify(jsonObject);
12
- return doc;
13
- };
@@ -1,13 +0,0 @@
1
- // Vendored from https://github.com/wesleytodd/express-openapi (branch: express-5)
2
- // License: ISC (see ../LICENSE)
3
- const YAML = require('yaml')
4
-
5
- /**
6
- * Converts a json to yaml
7
- * @param {object} jsonObject
8
- * @returns {string} yamlString
9
- */
10
- module.exports = function (jsonObject) {
11
- const doc = YAML.stringify(jsonObject)
12
- return doc
13
- }