@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,283 @@
1
+ import type express from "express";
2
+ import mongoose from "mongoose";
3
+
4
+ import type {ModelRouterOptions} from "../api";
5
+ import type {User} from "../auth";
6
+ import {APIError} from "../errors";
7
+ import {checkPermissions, type PermissionMethod} from "../permissions";
8
+ import {findOneOrNoneFor} from "../plugins";
9
+ import type {AnyTerrenoAccess} from "../rbac/types";
10
+ import {canUseAdminBroadcastWindow} from "./adminWindowAccess";
11
+ import type {SyncRegistryEntry} from "./registry";
12
+ import type {SyncAppOptions} from "./routes";
13
+ import type {SyncMutateRequest, SyncMutationOperation} from "./types";
14
+
15
+ export interface AdminWindowMutationAuditEvent {
16
+ actorId?: string;
17
+ /** Serialized document after the successful mutation. */
18
+ doc?: Record<string, unknown>;
19
+ modelName: string;
20
+ recordId?: string;
21
+ recordLabel?: string;
22
+ verb: "created" | "deleted" | "updated";
23
+ }
24
+
25
+ export interface AdminWindowMutationScopeHooks {
26
+ preCreate?: ModelRouterOptions<unknown>["preCreate"];
27
+ preUpdate?: ModelRouterOptions<unknown>["preUpdate"];
28
+ preDelete?: ModelRouterOptions<unknown>["preDelete"];
29
+ postCreate?: ModelRouterOptions<unknown>["postCreate"];
30
+ postUpdate?: ModelRouterOptions<unknown>["postUpdate"];
31
+ postDelete?: ModelRouterOptions<unknown>["postDelete"];
32
+ }
33
+
34
+ export interface AdminWindowMutationScope extends AdminWindowMutationScopeHooks {
35
+ /** RBAC access used by AdminApp User admin-flag and role assignment hooks. */
36
+ accessControl?: AnyTerrenoAccess;
37
+ modelName: string;
38
+ permissions: {create: boolean; update: boolean; delete: boolean};
39
+ createPermissions: PermissionMethod<unknown>[];
40
+ updatePermissions: PermissionMethod<unknown>[];
41
+ deletePermissions: PermissionMethod<unknown>[];
42
+ stripMutationData: (data: Record<string, unknown>) => Record<string, unknown>;
43
+ /** Legacy standalone audit callback; prefer `postCreate` / `postUpdate` / `postDelete`. */
44
+ emitAudit?: (args: {
45
+ event: AdminWindowMutationAuditEvent;
46
+ req: express.Request;
47
+ }) => void | Promise<void>;
48
+ }
49
+
50
+ /** Coalesce `req.user.id` and `req.user._id` to match Admin REST audit actor ids. */
51
+ export const auditActorIdFromRequest = (req: express.Request): string | undefined => {
52
+ const actor = req.user as {id?: unknown; _id?: unknown} | undefined;
53
+ if (!actor) {
54
+ return undefined;
55
+ }
56
+ if (actor.id != null) {
57
+ return String(actor.id);
58
+ }
59
+ if (actor._id != null) {
60
+ return String(actor._id);
61
+ }
62
+ return undefined;
63
+ };
64
+
65
+ /**
66
+ * Admin-window sync mutations use AdminApp router pre/post hooks, not product `modelRouter`
67
+ * hooks. Product hooks can overwrite stripped or admin-authorized fields (for example by
68
+ * forcing `ownerId` in `preCreate`).
69
+ */
70
+ export const buildAdminWindowExecutorOptions = <T>({
71
+ productOptions,
72
+ scope,
73
+ }: {
74
+ productOptions: ModelRouterOptions<T>;
75
+ scope: AdminWindowMutationScope;
76
+ }): ModelRouterOptions<T> => ({
77
+ ...productOptions,
78
+ accessControl: scope.accessControl ?? productOptions.accessControl,
79
+ postCreate: scope.postCreate as ModelRouterOptions<T>["postCreate"],
80
+ postDelete: scope.postDelete as ModelRouterOptions<T>["postDelete"],
81
+ postUpdate: scope.postUpdate as ModelRouterOptions<T>["postUpdate"],
82
+ preCreate: scope.preCreate as ModelRouterOptions<T>["preCreate"],
83
+ preDelete: scope.preDelete as ModelRouterOptions<T>["preDelete"],
84
+ preUpdate: scope.preUpdate as ModelRouterOptions<T>["preUpdate"],
85
+ });
86
+
87
+ /** Ensure `req.params.id` is set for AdminApp update/delete hooks (User admin-flag gates). */
88
+ export const withAdminWindowMutationRequestContext = ({
89
+ mutation,
90
+ req,
91
+ }: {
92
+ mutation: SyncMutateRequest;
93
+ req: express.Request;
94
+ }): express.Request => {
95
+ if (mutation.operation === "create" || mutation.id == null) {
96
+ return req;
97
+ }
98
+ const params = {...(req.params ?? {}), id: mutation.id};
99
+ return Object.assign(req, {params}) as express.Request;
100
+ };
101
+
102
+ const adminWindowMutationScopes = new Map<string, AdminWindowMutationScope>();
103
+
104
+ export const registerAdminWindowMutationScope = (
105
+ modelName: string,
106
+ scope: AdminWindowMutationScope
107
+ ): void => {
108
+ adminWindowMutationScopes.set(modelName, scope);
109
+ };
110
+
111
+ export const getAdminWindowMutationScope = (
112
+ modelName: string
113
+ ): AdminWindowMutationScope | undefined => adminWindowMutationScopes.get(modelName);
114
+
115
+ export const clearAdminWindowMutationScopes = (): void => {
116
+ adminWindowMutationScopes.clear();
117
+ };
118
+
119
+ const operationEnabled = (
120
+ scope: AdminWindowMutationScope,
121
+ operation: SyncMutationOperation
122
+ ): boolean => {
123
+ if (operation === "create") {
124
+ return scope.permissions.create;
125
+ }
126
+ if (operation === "update") {
127
+ return scope.permissions.update;
128
+ }
129
+ return scope.permissions.delete;
130
+ };
131
+
132
+ const permissionsForOperation = (
133
+ scope: AdminWindowMutationScope,
134
+ operation: SyncMutationOperation
135
+ ): PermissionMethod<unknown>[] => {
136
+ if (operation === "create") {
137
+ return scope.createPermissions;
138
+ }
139
+ if (operation === "update") {
140
+ return scope.updatePermissions;
141
+ }
142
+ return scope.deletePermissions;
143
+ };
144
+
145
+ const loadInstance = async ({
146
+ entry,
147
+ id,
148
+ }: {
149
+ entry: SyncRegistryEntry;
150
+ id: string;
151
+ }): Promise<unknown> => {
152
+ const model = mongoose.model(entry.modelName);
153
+ return findOneOrNoneFor(model, {_id: id, deleted: {$in: [true, false]}});
154
+ };
155
+
156
+ /**
157
+ * Validates an explicit `mutationMode: "adminWindow"` marker and applies AdminApp write
158
+ * semantics before the product sync executor runs. Returns the mutation with stripped
159
+ * data, or `undefined` when the request stays on the product path.
160
+ *
161
+ * The marker alone is never trusted: callers must also have admin-window access, the
162
+ * collection must be `adminBroadcast`, and AdminApp must have registered a write scope.
163
+ */
164
+ export const prepareAdminWindowMutation = async ({
165
+ entry,
166
+ mutation,
167
+ req: _req,
168
+ syncOptions,
169
+ user,
170
+ }: {
171
+ entry: SyncRegistryEntry;
172
+ mutation: SyncMutateRequest;
173
+ req: express.Request;
174
+ syncOptions?: SyncAppOptions;
175
+ user: User;
176
+ }): Promise<{mutation: SyncMutateRequest; scope: AdminWindowMutationScope} | undefined> => {
177
+ if (mutation.mutationMode !== "adminWindow") {
178
+ return undefined;
179
+ }
180
+ if (!entry.config.adminBroadcast) {
181
+ throw new APIError({
182
+ status: 403,
183
+ title: "Admin window mutations require an adminBroadcast collection",
184
+ });
185
+ }
186
+ if (
187
+ !(await canUseAdminBroadcastWindow({
188
+ accessControl: syncOptions?.accessControl,
189
+ canOpenAdminWindow: syncOptions?.canOpenAdminWindow,
190
+ user,
191
+ }))
192
+ ) {
193
+ throw new APIError({status: 403, title: "Admin window access required"});
194
+ }
195
+ const scope = getAdminWindowMutationScope(entry.modelName);
196
+ if (!scope) {
197
+ throw new APIError({
198
+ status: 403,
199
+ title: "Admin window mutations are not registered for this collection",
200
+ });
201
+ }
202
+ if (!operationEnabled(scope, mutation.operation)) {
203
+ throw new APIError({
204
+ status: 403,
205
+ title: `${mutation.operation} is disabled for this admin model`,
206
+ });
207
+ }
208
+
209
+ let instance: unknown;
210
+ if (mutation.operation !== "create") {
211
+ if (!mutation.id) {
212
+ throw new APIError({
213
+ status: 400,
214
+ title: `id is required for ${mutation.operation} mutations`,
215
+ });
216
+ }
217
+ instance = await loadInstance({entry, id: mutation.id});
218
+ if (!instance && mutation.operation === "update") {
219
+ throw new APIError({status: 404, title: "Not found"});
220
+ }
221
+ }
222
+
223
+ const permissionMethod =
224
+ mutation.operation === "create"
225
+ ? "create"
226
+ : mutation.operation === "update"
227
+ ? "update"
228
+ : "delete";
229
+ const permissionInstance =
230
+ mutation.operation === "create" ? (mutation.data as unknown) : instance;
231
+ if (
232
+ !(await checkPermissions(
233
+ permissionMethod,
234
+ permissionsForOperation(scope, mutation.operation),
235
+ user,
236
+ permissionInstance
237
+ ))
238
+ ) {
239
+ throw new APIError({status: 403, title: "Admin write access denied"});
240
+ }
241
+
242
+ if (mutation.operation === "delete" || !mutation.data) {
243
+ return {mutation, scope};
244
+ }
245
+ return {
246
+ mutation: {...mutation, data: scope.stripMutationData(mutation.data)},
247
+ scope,
248
+ };
249
+ };
250
+
251
+ export const emitAdminWindowMutationAudit = async ({
252
+ doc,
253
+ mutation,
254
+ req,
255
+ scope,
256
+ }: {
257
+ doc: mongoose.Document;
258
+ mutation: SyncMutateRequest;
259
+ req: express.Request;
260
+ scope: AdminWindowMutationScope;
261
+ }): Promise<void> => {
262
+ if (!scope.emitAudit) {
263
+ return;
264
+ }
265
+ const plain = doc.toObject() as Record<string, unknown>;
266
+ const recordId = plain._id != null ? String(plain._id) : mutation.id;
267
+ const verb =
268
+ mutation.operation === "create"
269
+ ? "created"
270
+ : mutation.operation === "delete"
271
+ ? "deleted"
272
+ : "updated";
273
+ await scope.emitAudit({
274
+ event: {
275
+ actorId: auditActorIdFromRequest(req),
276
+ doc: plain,
277
+ modelName: scope.modelName,
278
+ recordId,
279
+ verb,
280
+ },
281
+ req,
282
+ });
283
+ };
@@ -184,6 +184,7 @@ export const executeCreate = async <T>({
184
184
  user,
185
185
  body,
186
186
  req,
187
+ skipPermissionChecks,
187
188
  skipPostHooks,
188
189
  writeModelName,
189
190
  }: {
@@ -205,10 +206,15 @@ export const executeCreate = async <T>({
205
206
  * committed write look like a failure. REST handlers never set this.
206
207
  */
207
208
  skipPostHooks?: boolean;
209
+ /** When true, skip modelRouter permission checks (admin-window sync mutations). */
210
+ skipPermissionChecks?: boolean;
208
211
  }): Promise<ExecutorResult<T>> => {
209
212
  const request = req ?? stubRequest(user);
210
213
 
211
- if (!(await checkPermissions("create", options.permissions.create, user))) {
214
+ if (
215
+ !skipPermissionChecks &&
216
+ !(await checkPermissions("create", options.permissions.create, user))
217
+ ) {
212
218
  throw new APIError({
213
219
  status: 405,
214
220
  title: `Access to CREATE on ${model.modelName} denied for ${user?.id}`,
@@ -348,6 +354,7 @@ export const executeUpdate = async <T>({
348
354
  concurrencyCheck,
349
355
  existingDoc,
350
356
  req,
357
+ skipPermissionChecks,
351
358
  skipPostHooks,
352
359
  writeModelName,
353
360
  }: {
@@ -371,10 +378,15 @@ export const executeUpdate = async <T>({
371
378
  * MCP passes the registry `modelName` because compiled mongoose names can differ.
372
379
  */
373
380
  writeModelName?: string;
381
+ /** When true, skip modelRouter permission checks (admin-window sync mutations). */
382
+ skipPermissionChecks?: boolean;
374
383
  }): Promise<ExecutorResult<T>> => {
375
384
  const request = req ?? stubRequest(user);
376
385
 
377
- if (!(await checkPermissions("update", options.permissions.update, user))) {
386
+ if (
387
+ !skipPermissionChecks &&
388
+ !(await checkPermissions("update", options.permissions.update, user))
389
+ ) {
378
390
  throw new APIError({
379
391
  status: 405,
380
392
  title: `Access to UPDATE on ${model.modelName} denied for ${user?.id}`,
@@ -384,7 +396,10 @@ export const executeUpdate = async <T>({
384
396
  let doc =
385
397
  existingDoc ?? ((await loadDocOr404<T>(model, id, options.populatePaths)) as ExecutorDoc<T>);
386
398
 
387
- if (!(await checkPermissions("update", options.permissions.update, user, doc))) {
399
+ if (
400
+ !skipPermissionChecks &&
401
+ !(await checkPermissions("update", options.permissions.update, user, doc))
402
+ ) {
388
403
  throw new APIError({
389
404
  status: 403,
390
405
  title: `Access to GET on ${model.modelName}:${id} denied for ${user?.id}`,
@@ -603,6 +618,7 @@ export const executeDelete = async <T>({
603
618
  id,
604
619
  existingDoc,
605
620
  req,
621
+ skipPermissionChecks,
606
622
  skipPostHooks,
607
623
  }: {
608
624
  model: Model<T>;
@@ -618,10 +634,15 @@ export const executeDelete = async <T>({
618
634
  req?: express.Request;
619
635
  /** C5 (FIX 6): see `executeCreate`'s `skipPostHooks` doc comment. */
620
636
  skipPostHooks?: boolean;
637
+ /** When true, skip modelRouter permission checks (admin-window sync mutations). */
638
+ skipPermissionChecks?: boolean;
621
639
  }): Promise<ExecutorResult<T>> => {
622
640
  const request = req ?? stubRequest(user);
623
641
 
624
- if (!(await checkPermissions("delete", options.permissions.delete, user))) {
642
+ if (
643
+ !skipPermissionChecks &&
644
+ !(await checkPermissions("delete", options.permissions.delete, user))
645
+ ) {
625
646
  throw new APIError({
626
647
  status: 405,
627
648
  title: `Access to DELETE on ${model.modelName} denied for ${user?.id}`,
@@ -649,7 +670,10 @@ export const executeDelete = async <T>({
649
670
  if (!resolved) {
650
671
  throw error;
651
672
  }
652
- if (!(await checkPermissions("delete", options.permissions.delete, user, resolved))) {
673
+ if (
674
+ !skipPermissionChecks &&
675
+ !(await checkPermissions("delete", options.permissions.delete, user, resolved))
676
+ ) {
653
677
  throw new APIError({
654
678
  status: 403,
655
679
  title: `Access to GET on ${model.modelName}:${id} denied for ${user?.id}`,
@@ -661,7 +685,10 @@ export const executeDelete = async <T>({
661
685
  }
662
686
  }
663
687
 
664
- if (!(await checkPermissions("delete", options.permissions.delete, user, doc))) {
688
+ if (
689
+ !skipPermissionChecks &&
690
+ !(await checkPermissions("delete", options.permissions.delete, user, doc))
691
+ ) {
665
692
  throw new APIError({
666
693
  status: 403,
667
694
  title: `Access to GET on ${model.modelName}:${id} denied for ${user?.id}`,
@@ -445,7 +445,7 @@ describe("syncdb end-to-end integration", () => {
445
445
  expect(entity?.seq).toBe(baseSeq + 1);
446
446
  expect(entity?.pendingMutationId).toBeUndefined();
447
447
  await waitFor(() => a.client.getSyncStatus().conflictCount === 0, {
448
- label: "conflict cleared after persistence flush",
448
+ label: "useServer conflict resolution persisted",
449
449
  });
450
450
  // The server kept its own write.
451
451
  const settled = await IntTodoModel.findById(conflictDocId);
@@ -488,7 +488,7 @@ describe("syncdb end-to-end integration", () => {
488
488
  // a replay immediately, so the retry drains without waiting for another trigger.
489
489
  a.client.resolveConflict({mutationId, strategy: "keepMine"});
490
490
  await waitFor(() => a.client.getSyncStatus().conflictCount === 0, {
491
- label: "conflict cleared after persistence flush",
491
+ label: "keepMine conflict resolution persisted",
492
492
  });
493
493
  expect(a.client.outbox.getMutation({mutationId})).toBeUndefined();
494
494