@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
@@ -10,6 +10,8 @@ import type { SyncScope } from "./types";
10
10
  */
11
11
  /** The document field a scope reads, or null for broadcast/custom scopes. */
12
12
  export declare const getScopeField: (scope: SyncScope) => string | null;
13
+ /** Fan-in stream for admin window subscribers when `SyncConfig.adminBroadcast` is true. */
14
+ export declare const adminBroadcastStream: (collectionTag: string) => string;
13
15
  /** Build a stream key from a collection tag and a raw scope value. */
14
16
  export declare const streamForScopeValue: ({ collectionTag, scope, scopeValue, }: {
15
17
  collectionTag: string;
@@ -1,58 +1,7 @@
1
1
  "use strict";
2
- var __extends = (this && this.__extends) || (function () {
3
- var extendStatics = function (d, b) {
4
- extendStatics = Object.setPrototypeOf ||
5
- ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
6
- function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
7
- return extendStatics(d, b);
8
- };
9
- return function (d, b) {
10
- if (typeof b !== "function" && b !== null)
11
- throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
12
- extendStatics(d, b);
13
- function __() { this.constructor = d; }
14
- d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
15
- };
16
- })();
17
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
18
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
19
- return new (P || (P = Promise))(function (resolve, reject) {
20
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
21
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
22
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
23
- step((generator = generator.apply(thisArg, _arguments || [])).next());
24
- });
25
- };
26
- var __generator = (this && this.__generator) || function (thisArg, body) {
27
- var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
28
- return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
29
- function verb(n) { return function (v) { return step([n, v]); }; }
30
- function step(op) {
31
- if (f) throw new TypeError("Generator is already executing.");
32
- while (g && (g = 0, op[0] && (_ = 0)), _) try {
33
- if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
34
- if (y = 0, t) op = [op[0] & 2, t.value];
35
- switch (op[0]) {
36
- case 0: case 1: t = op; break;
37
- case 4: _.label++; return { value: op[1], done: false };
38
- case 5: _.label++; y = op[1]; op = [0]; continue;
39
- case 7: op = _.ops.pop(); _.trys.pop(); continue;
40
- default:
41
- if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
42
- if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
43
- if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
44
- if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
45
- if (t[2]) _.ops.pop();
46
- _.trys.pop(); continue;
47
- }
48
- op = body.call(thisArg, _);
49
- } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
50
- if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
51
- }
52
- };
53
2
  Object.defineProperty(exports, "__esModule", { value: true });
54
- exports.resolveUserStreamsForEntry = exports.MissingScopeResolverError = exports.assertWritableStream = exports.resolveStreamForDoc = exports.parseStreamKey = exports.streamForScopeValue = exports.getScopeField = void 0;
55
- var errors_1 = require("../errors");
3
+ exports.resolveUserStreamsForEntry = exports.MissingScopeResolverError = exports.assertWritableStream = exports.resolveStreamForDoc = exports.parseStreamKey = exports.streamForScopeValue = exports.adminBroadcastStream = exports.getScopeField = void 0;
4
+ const errors_1 = require("../errors");
56
5
  /**
57
6
  * Stream key resolution for SyncDB.
58
7
  *
@@ -61,13 +10,12 @@ var errors_1 = require("../errors");
61
10
  * `{collectionTag}|all` (broadcast), or `{collectionTag}|custom:{value}`.
62
11
  */
63
12
  /** The document field a scope reads, or null for broadcast/custom scopes. */
64
- var getScopeField = function (scope) {
65
- var _a;
13
+ const getScopeField = (scope) => {
66
14
  if (typeof scope === "function") {
67
15
  return null;
68
16
  }
69
17
  if (scope.type === "owner") {
70
- return (_a = scope.field) !== null && _a !== void 0 ? _a : "ownerId";
18
+ return scope.field ?? "ownerId";
71
19
  }
72
20
  if (scope.type === "tenant") {
73
21
  return scope.field;
@@ -75,19 +23,21 @@ var getScopeField = function (scope) {
75
23
  return null;
76
24
  };
77
25
  exports.getScopeField = getScopeField;
26
+ /** Fan-in stream for admin window subscribers when `SyncConfig.adminBroadcast` is true. */
27
+ const adminBroadcastStream = (collectionTag) => `${collectionTag}|admin`;
28
+ exports.adminBroadcastStream = adminBroadcastStream;
78
29
  /** Build a stream key from a collection tag and a raw scope value. */
79
- var streamForScopeValue = function (_a) {
80
- var collectionTag = _a.collectionTag, scope = _a.scope, scopeValue = _a.scopeValue;
30
+ const streamForScopeValue = ({ collectionTag, scope, scopeValue, }) => {
81
31
  if (typeof scope === "function") {
82
- return "".concat(collectionTag, "|custom:").concat(String(scopeValue));
32
+ return `${collectionTag}|custom:${String(scopeValue)}`;
83
33
  }
84
34
  if (scope.type === "owner") {
85
- return "".concat(collectionTag, "|owner:").concat(String(scopeValue));
35
+ return `${collectionTag}|owner:${String(scopeValue)}`;
86
36
  }
87
37
  if (scope.type === "tenant") {
88
- return "".concat(collectionTag, "|tenant:").concat(String(scopeValue));
38
+ return `${collectionTag}|tenant:${String(scopeValue)}`;
89
39
  }
90
- return "".concat(collectionTag, "|all");
40
+ return `${collectionTag}|all`;
91
41
  };
92
42
  exports.streamForScopeValue = streamForScopeValue;
93
43
  /**
@@ -96,22 +46,25 @@ exports.streamForScopeValue = streamForScopeValue;
96
46
  * containing `:` survive intact. Broadcast streams (`{tag}|all`) yield `scopeValue: null`.
97
47
  * Returns null when the key is not a valid stream key.
98
48
  */
99
- var parseStreamKey = function (stream) {
100
- var pipe = stream.indexOf("|");
49
+ const parseStreamKey = (stream) => {
50
+ const pipe = stream.indexOf("|");
101
51
  if (pipe <= 0) {
102
52
  return null;
103
53
  }
104
- var collectionTag = stream.slice(0, pipe);
105
- var rest = stream.slice(pipe + 1);
54
+ const collectionTag = stream.slice(0, pipe);
55
+ const rest = stream.slice(pipe + 1);
106
56
  if (rest === "all") {
107
- return { collectionTag: collectionTag, scopeKind: "all", scopeValue: null };
57
+ return { collectionTag, scopeKind: "all", scopeValue: null };
58
+ }
59
+ if (rest === "admin") {
60
+ return { collectionTag, scopeKind: "admin", scopeValue: null };
108
61
  }
109
- var colon = rest.indexOf(":");
62
+ const colon = rest.indexOf(":");
110
63
  if (colon < 0) {
111
64
  return null;
112
65
  }
113
66
  return {
114
- collectionTag: collectionTag,
67
+ collectionTag,
115
68
  scopeKind: rest.slice(0, colon),
116
69
  scopeValue: rest.slice(colon + 1),
117
70
  };
@@ -125,16 +78,15 @@ exports.parseStreamKey = parseStreamKey;
125
78
  * rows written before a scope field existed. Rejecting an unroutable document is the
126
79
  * write path's job — see {@link assertWritableStream}.
127
80
  */
128
- var resolveStreamForDoc = function (_a) {
129
- var collectionTag = _a.collectionTag, scope = _a.scope, doc = _a.doc;
81
+ const resolveStreamForDoc = ({ collectionTag, scope, doc, }) => {
130
82
  if (typeof scope === "function") {
131
- return (0, exports.streamForScopeValue)({ collectionTag: collectionTag, scope: scope, scopeValue: scope(doc) });
83
+ return (0, exports.streamForScopeValue)({ collectionTag, scope, scopeValue: scope(doc) });
132
84
  }
133
85
  if (scope.type === "broadcast") {
134
- return (0, exports.streamForScopeValue)({ collectionTag: collectionTag, scope: scope, scopeValue: null });
86
+ return (0, exports.streamForScopeValue)({ collectionTag, scope, scopeValue: null });
135
87
  }
136
- var field = (0, exports.getScopeField)(scope);
137
- return (0, exports.streamForScopeValue)({ collectionTag: collectionTag, scope: scope, scopeValue: doc[field] });
88
+ const field = (0, exports.getScopeField)(scope);
89
+ return (0, exports.streamForScopeValue)({ collectionTag, scope, scopeValue: doc[field] });
138
90
  };
139
91
  exports.resolveStreamForDoc = resolveStreamForDoc;
140
92
  /**
@@ -152,17 +104,16 @@ exports.resolveStreamForDoc = resolveStreamForDoc;
152
104
  * `preCreate`/`IsOwner` plumbing, and an unowned document is still admin-reachable, so
153
105
  * tightening that is a separate behavioral change.
154
106
  */
155
- var assertWritableStream = function (_a) {
156
- var collectionTag = _a.collectionTag, scope = _a.scope, doc = _a.doc;
107
+ const assertWritableStream = ({ collectionTag, scope, doc, }) => {
157
108
  if (typeof scope === "function" || scope.type !== "tenant") {
158
109
  return;
159
110
  }
160
- var field = (0, exports.getScopeField)(scope);
161
- var scopeValue = doc[field];
111
+ const field = (0, exports.getScopeField)(scope);
112
+ const scopeValue = doc[field];
162
113
  if (scopeValue === undefined || scopeValue === null) {
163
114
  throw new errors_1.APIError({
164
115
  status: 400,
165
- title: "Sync write on ".concat(collectionTag, " is missing tenant scope field \"").concat(field, "\""),
116
+ title: `Sync write on ${collectionTag} is missing tenant scope field "${field}"`,
166
117
  });
167
118
  }
168
119
  };
@@ -181,41 +132,28 @@ exports.assertWritableStream = assertWritableStream;
181
132
  * Runs against the FULL user (D2) so tenant memberships resolve from current
182
133
  * `organizationIds`.
183
134
  */
184
- var MissingScopeResolverError = /** @class */ (function (_super) {
185
- __extends(MissingScopeResolverError, _super);
186
- function MissingScopeResolverError(collection) {
187
- var _this = _super.call(this, "Sync collection ".concat(collection, " requires a getUserScopes resolver on SyncApp")) || this;
188
- _this.collection = collection;
189
- _this.name = "MissingScopeResolverError";
190
- return _this;
191
- }
192
- return MissingScopeResolverError;
193
- }(Error));
135
+ class MissingScopeResolverError extends Error {
136
+ collection;
137
+ constructor(collection) {
138
+ super(`Sync collection ${collection} requires a getUserScopes resolver on SyncApp`);
139
+ this.collection = collection;
140
+ this.name = "MissingScopeResolverError";
141
+ }
142
+ }
194
143
  exports.MissingScopeResolverError = MissingScopeResolverError;
195
- var resolveUserStreamsForEntry = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
196
- var scope, collection, scopeValues;
197
- var entry = _b.entry, user = _b.user, getUserScopes = _b.getUserScopes;
198
- return __generator(this, function (_c) {
199
- switch (_c.label) {
200
- case 0:
201
- scope = entry.config.scope;
202
- collection = entry.collectionTag;
203
- if (typeof scope !== "function" && scope.type === "broadcast") {
204
- return [2 /*return*/, [(0, exports.streamForScopeValue)({ collectionTag: collection, scope: scope, scopeValue: null })]];
205
- }
206
- if (typeof scope !== "function" && scope.type === "owner") {
207
- return [2 /*return*/, [(0, exports.streamForScopeValue)({ collectionTag: collection, scope: scope, scopeValue: user.id })]];
208
- }
209
- if (!getUserScopes) {
210
- throw new MissingScopeResolverError(collection);
211
- }
212
- return [4 /*yield*/, getUserScopes(user, entry)];
213
- case 1:
214
- scopeValues = _c.sent();
215
- return [2 /*return*/, scopeValues.map(function (scopeValue) {
216
- return (0, exports.streamForScopeValue)({ collectionTag: collection, scope: scope, scopeValue: scopeValue });
217
- })];
218
- }
219
- });
220
- }); };
144
+ const resolveUserStreamsForEntry = async ({ entry, user, getUserScopes, }) => {
145
+ const { scope } = entry.config;
146
+ const collection = entry.collectionTag;
147
+ if (typeof scope !== "function" && scope.type === "broadcast") {
148
+ return [(0, exports.streamForScopeValue)({ collectionTag: collection, scope, scopeValue: null })];
149
+ }
150
+ if (typeof scope !== "function" && scope.type === "owner") {
151
+ return [(0, exports.streamForScopeValue)({ collectionTag: collection, scope, scopeValue: user.id })];
152
+ }
153
+ if (!getUserScopes) {
154
+ throw new MissingScopeResolverError(collection);
155
+ }
156
+ const scopeValues = await getUserScopes(user, entry);
157
+ return scopeValues.map((scopeValue) => (0, exports.streamForScopeValue)({ collectionTag: collection, scope, scopeValue }));
158
+ };
221
159
  exports.resolveUserStreamsForEntry = resolveUserStreamsForEntry;
@@ -16,11 +16,12 @@ export declare const getSyncAppOptions: (app: express.Application) => SyncAppOpt
16
16
  *
17
17
  * Registration also enqueues the bookkeeping-model index builds (`SyncCounter`,
18
18
  * `SyncMutation`, `SyncScopeMove`, `SyncKey`) for `ensureSyncIndexes()`, which
19
- * `TerrenoApp.start()` awaits before the HTTP server begins listening. Those indexes are
19
+ * `TerrenoApp.start()` binds the HTTP port first, then awaits `ensureSyncIndexes()`. Those indexes are
20
20
  * requirements — the unique `mutationId` index is what makes duplicate mutation deliveries
21
21
  * idempotent, and the unique `stream` index is what keeps the counter upsert race from
22
22
  * minting duplicate seqs — so an index-build failure fails startup loudly. Apps that build
23
23
  * the Express app without `TerrenoApp.start()` should await `ensureSyncIndexes()` themselves.
24
+ * Pass `httpServer` when the process already bound `PORT` (Cloud Run startup probe).
24
25
  */
25
26
  export declare class SyncApp implements TerrenoPlugin {
26
27
  private readonly options;
@@ -1,14 +1,12 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SyncApp = exports.getSyncAppOptions = void 0;
4
- var models_1 = require("./models");
5
- var registry_1 = require("./registry");
6
- var routes_1 = require("./routes");
7
- var SYNC_APP_OPTIONS_LOCAL_KEY = "terrenoSyncAppOptions";
4
+ const models_1 = require("./models");
5
+ const registry_1 = require("./registry");
6
+ const routes_1 = require("./routes");
7
+ const SYNC_APP_OPTIONS_LOCAL_KEY = "terrenoSyncAppOptions";
8
8
  /** Resolve the SyncApp configuration attached to one Express application. */
9
- var getSyncAppOptions = function (app) {
10
- return app.locals[SYNC_APP_OPTIONS_LOCAL_KEY];
11
- };
9
+ const getSyncAppOptions = (app) => app.locals[SYNC_APP_OPTIONS_LOCAL_KEY];
12
10
  exports.getSyncAppOptions = getSyncAppOptions;
13
11
  /**
14
12
  * TerrenoPlugin mounting the SyncDB local-first sync HTTP routes
@@ -23,22 +21,22 @@ exports.getSyncAppOptions = getSyncAppOptions;
23
21
  *
24
22
  * Registration also enqueues the bookkeeping-model index builds (`SyncCounter`,
25
23
  * `SyncMutation`, `SyncScopeMove`, `SyncKey`) for `ensureSyncIndexes()`, which
26
- * `TerrenoApp.start()` awaits before the HTTP server begins listening. Those indexes are
24
+ * `TerrenoApp.start()` binds the HTTP port first, then awaits `ensureSyncIndexes()`. Those indexes are
27
25
  * requirements — the unique `mutationId` index is what makes duplicate mutation deliveries
28
26
  * idempotent, and the unique `stream` index is what keeps the counter upsert race from
29
27
  * minting duplicate seqs — so an index-build failure fails startup loudly. Apps that build
30
28
  * the Express app without `TerrenoApp.start()` should await `ensureSyncIndexes()` themselves.
29
+ * Pass `httpServer` when the process already bound `PORT` (Cloud Run startup probe).
31
30
  */
32
- var SyncApp = /** @class */ (function () {
33
- function SyncApp(options) {
34
- if (options === void 0) { options = {}; }
31
+ class SyncApp {
32
+ options;
33
+ constructor(options = {}) {
35
34
  this.options = options;
36
35
  }
37
- SyncApp.prototype.register = function (app) {
36
+ register(app) {
38
37
  app.locals[SYNC_APP_OPTIONS_LOCAL_KEY] = this.options;
39
- (0, registry_1.trackSyncIndexCreation)(function () { return (0, models_1.ensureSyncModelIndexes)(); });
38
+ (0, registry_1.trackSyncIndexCreation)(() => (0, models_1.ensureSyncModelIndexes)());
40
39
  (0, routes_1.addSyncRoutes)(app, this.options);
41
- };
42
- return SyncApp;
43
- }());
40
+ }
41
+ }
44
42
  exports.SyncApp = SyncApp;
@@ -1,6 +1,7 @@
1
1
  import type express from "express";
2
2
  import type { User } from "../auth";
3
3
  import { type SyncMutationOutcome, type SyncMutationScopeResolver } from "./mutationHandler";
4
+ import type { SyncAppOptions } from "./routes";
4
5
  import type { SyncMutateBatchResponse, SyncMutateRequest } from "./types";
5
6
  /**
6
7
  * Task 9.20: the single orchestration both mutation transports run.
@@ -47,11 +48,12 @@ export interface SyncBatchRunResult {
47
48
  response: SyncMutateBatchResponse;
48
49
  }
49
50
  /** Shared orchestration for a SINGLE mutation: rate limit, then apply. */
50
- export declare const runSyncMutation: ({ mutation, req, scopeResolver, user, }: {
51
+ export declare const runSyncMutation: ({ mutation, req, scopeResolver, syncOptions, user, }: {
51
52
  mutation: SyncMutateRequest;
52
53
  /** The real Express request when called over HTTP; hooks receive a `{user}` stub otherwise. */
53
54
  req?: express.Request;
54
55
  scopeResolver?: SyncMutationScopeResolver;
56
+ syncOptions?: SyncAppOptions;
55
57
  user: User;
56
58
  }) => Promise<SyncMutationRunResult>;
57
59
  /**
@@ -63,9 +65,10 @@ export declare const runSyncMutation: ({ mutation, req, scopeResolver, user, }:
63
65
  * mutations that would have succeeded. The budget is then charged per MUTATION (not per
64
66
  * batch), so batching cannot buy extra throughput over single sends.
65
67
  */
66
- export declare const runSyncBatch: ({ mutations, req, scopeResolver, user, }: {
68
+ export declare const runSyncBatch: ({ mutations, req, scopeResolver, syncOptions, user, }: {
67
69
  mutations: SyncMutateRequest[];
68
70
  req?: express.Request;
69
71
  scopeResolver?: SyncMutationScopeResolver;
72
+ syncOptions?: SyncAppOptions;
70
73
  user: User;
71
74
  }) => Promise<SyncBatchRunResult>;