@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
@@ -152,7 +152,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
152
152
  "type": "string",
153
153
  },
154
154
  },
155
- "required": [],
156
155
  "type": "object",
157
156
  },
158
157
  "type": "array",
@@ -206,7 +205,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
206
205
  "type": "string",
207
206
  },
208
207
  },
209
- "required": [],
210
208
  "type": "object",
211
209
  },
212
210
  "type": "array",
@@ -235,7 +233,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
235
233
  "type": "string",
236
234
  },
237
235
  },
238
- "required": [],
239
236
  "type": "object",
240
237
  },
241
238
  "tags": {
@@ -360,7 +357,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
360
357
  "type": "string",
361
358
  },
362
359
  },
363
- "required": [],
364
360
  "type": "object",
365
361
  },
366
362
  "type": "array",
@@ -414,7 +410,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
414
410
  "type": "string",
415
411
  },
416
412
  },
417
- "required": [],
418
413
  "type": "object",
419
414
  },
420
415
  "type": "array",
@@ -443,7 +438,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
443
438
  "type": "string",
444
439
  },
445
440
  },
446
- "required": [],
447
441
  "type": "object",
448
442
  },
449
443
  "tags": {
@@ -497,7 +491,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
497
491
  "type": "string",
498
492
  },
499
493
  },
500
- "required": [],
501
494
  "type": "object",
502
495
  },
503
496
  "type": "array",
@@ -551,7 +544,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
551
544
  "type": "string",
552
545
  },
553
546
  },
554
- "required": [],
555
547
  "type": "object",
556
548
  },
557
549
  "type": "array",
@@ -580,7 +572,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
580
572
  "type": "string",
581
573
  },
582
574
  },
583
- "required": [],
584
575
  "type": "object",
585
576
  },
586
577
  "tags": {
@@ -1114,7 +1105,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
1114
1105
  "type": "string",
1115
1106
  },
1116
1107
  },
1117
- "required": [],
1118
1108
  "type": "object",
1119
1109
  },
1120
1110
  "type": "array",
@@ -1168,7 +1158,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
1168
1158
  "type": "string",
1169
1159
  },
1170
1160
  },
1171
- "required": [],
1172
1161
  "type": "object",
1173
1162
  },
1174
1163
  "type": "array",
@@ -1197,7 +1186,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
1197
1186
  "type": "string",
1198
1187
  },
1199
1188
  },
1200
- "required": [],
1201
1189
  "type": "object",
1202
1190
  },
1203
1191
  "tags": {
@@ -1315,7 +1303,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
1315
1303
  "type": "string",
1316
1304
  },
1317
1305
  },
1318
- "required": [],
1319
1306
  "type": "object",
1320
1307
  },
1321
1308
  "type": "array",
@@ -1369,7 +1356,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
1369
1356
  "type": "string",
1370
1357
  },
1371
1358
  },
1372
- "required": [],
1373
1359
  "type": "object",
1374
1360
  },
1375
1361
  "type": "array",
@@ -1398,7 +1384,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
1398
1384
  "type": "string",
1399
1385
  },
1400
1386
  },
1401
- "required": [],
1402
1387
  "type": "object",
1403
1388
  },
1404
1389
  "tags": {
@@ -1452,7 +1437,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
1452
1437
  "type": "string",
1453
1438
  },
1454
1439
  },
1455
- "required": [],
1456
1440
  "type": "object",
1457
1441
  },
1458
1442
  "type": "array",
@@ -1506,7 +1490,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
1506
1490
  "type": "string",
1507
1491
  },
1508
1492
  },
1509
- "required": [],
1510
1493
  "type": "object",
1511
1494
  },
1512
1495
  "type": "array",
@@ -1535,7 +1518,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
1535
1518
  "type": "string",
1536
1519
  },
1537
1520
  },
1538
- "required": [],
1539
1521
  "type": "object",
1540
1522
  },
1541
1523
  "tags": {
@@ -98,7 +98,6 @@ exports[`describeModel returns a field graph snapshot for the fixture schema 1`]
98
98
  "tags": {
99
99
  "default": undefined,
100
100
  "description": "Search tags",
101
- "enum": undefined,
102
101
  "isArray": true,
103
102
  "item": {
104
103
  "description": undefined,
@@ -0,0 +1,165 @@
1
+ import {afterEach, beforeEach, describe, expect, it} from "bun:test";
2
+ import {mkdtempSync, readFileSync, rmSync, statSync, writeFileSync} from "node:fs";
3
+ import {tmpdir} from "node:os";
4
+ import {join} from "node:path";
5
+ import {assert} from "chai";
6
+ import express from "express";
7
+ import supertest from "supertest";
8
+ import {addTerrenoDevBrowserLogsRoute} from "../browserLogsRoute";
9
+
10
+ describe("Terreno dev browser logs route", () => {
11
+ let dir: string;
12
+ let prevBrowserLogs: string | undefined;
13
+ let prevEnv: NodeJS.ProcessEnv["NODE_ENV"] | undefined;
14
+ let prevCwd: string;
15
+
16
+ beforeEach(() => {
17
+ prevCwd = process.cwd();
18
+ prevEnv = process.env.NODE_ENV;
19
+ prevBrowserLogs = process.env.TERRENO_BROWSER_LOGS;
20
+ dir = mkdtempSync(join(tmpdir(), "terreno-browser-logs-"));
21
+ process.chdir(dir);
22
+ });
23
+
24
+ afterEach(() => {
25
+ process.chdir(prevCwd);
26
+ process.env.NODE_ENV = prevEnv ?? "test";
27
+ if (prevBrowserLogs === undefined) {
28
+ Reflect.deleteProperty(process.env, "TERRENO_BROWSER_LOGS");
29
+ } else {
30
+ process.env.TERRENO_BROWSER_LOGS = prevBrowserLogs;
31
+ }
32
+ rmSync(dir, {force: true, recursive: true});
33
+ });
34
+
35
+ it("accepts POST batches in development and appends JSONL", async () => {
36
+ process.env.NODE_ENV = "development";
37
+
38
+ const app = express();
39
+ addTerrenoDevBrowserLogsRoute(app);
40
+
41
+ const res = await supertest(app)
42
+ .post("/__terreno/browser-logs")
43
+ .send({entries: [{level: "error", message: "from client"}]});
44
+
45
+ expect(res.status).toBe(204);
46
+ const p = join(dir, ".terreno", "logs", "browser.log");
47
+ const txt = readFileSync(p, "utf-8");
48
+ expect(txt).toContain("from client");
49
+ });
50
+
51
+ it("rejects batches over the entry cap", async () => {
52
+ process.env.NODE_ENV = "development";
53
+
54
+ const app = express();
55
+ addTerrenoDevBrowserLogsRoute(app);
56
+
57
+ const res = await supertest(app)
58
+ .post("/__terreno/browser-logs")
59
+ .send({entries: Array.from({length: 101}, () => ({level: "error", message: "x"}))});
60
+
61
+ expect(res.status).toBe(413);
62
+ });
63
+
64
+ it("enforces the body cap after TerrenoApp's global JSON parser", async () => {
65
+ process.env.NODE_ENV = "development";
66
+
67
+ const app = express();
68
+ app.use(express.json({limit: "1mb"}));
69
+ addTerrenoDevBrowserLogsRoute(app);
70
+
71
+ const response = await supertest(app)
72
+ .post("/__terreno/browser-logs")
73
+ .send({entries: [{level: "error", message: "x".repeat(300 * 1024)}]});
74
+
75
+ assert.equal(response.status, 413);
76
+ assert.include(response.body.error, "256 kB");
77
+ });
78
+
79
+ it("rejects an empty request body", async () => {
80
+ process.env.NODE_ENV = "development";
81
+ const app = express();
82
+ addTerrenoDevBrowserLogsRoute(app);
83
+
84
+ const response = await supertest(app).post("/__terreno/browser-logs");
85
+ expect(response.status).toBe(400);
86
+ });
87
+
88
+ it("rejects unauthenticated remote clients and accepts authenticated ones", async () => {
89
+ process.env.NODE_ENV = "development";
90
+ const remoteAddressMiddleware: express.RequestHandler = (req, _res, next) => {
91
+ Object.defineProperty(req.socket, "remoteAddress", {
92
+ configurable: true,
93
+ value: "10.0.0.5",
94
+ });
95
+ next();
96
+ };
97
+ const remoteApp = express();
98
+ remoteApp.use(remoteAddressMiddleware);
99
+ addTerrenoDevBrowserLogsRoute(remoteApp);
100
+
101
+ const rejected = await supertest(remoteApp)
102
+ .post("/__terreno/browser-logs")
103
+ .send({entries: [{level: "error", message: "remote"}]});
104
+ assert.equal(rejected.status, 403);
105
+
106
+ const authenticatedApp = express();
107
+ authenticatedApp.use(remoteAddressMiddleware);
108
+ authenticatedApp.use((req, _res, next) => {
109
+ Object.assign(req, {user: {_id: "dev-user"}});
110
+ next();
111
+ });
112
+ addTerrenoDevBrowserLogsRoute(authenticatedApp);
113
+ const accepted = await supertest(authenticatedApp)
114
+ .post("/__terreno/browser-logs")
115
+ .send({entries: [{level: "error", message: "authenticated"}]});
116
+ assert.equal(accepted.status, 204);
117
+ });
118
+
119
+ it("restarts the dev log before it exceeds the size cap", async () => {
120
+ process.env.NODE_ENV = "development";
121
+ const logDir = join(dir, ".terreno", "logs");
122
+ const logPath = join(logDir, "browser.log");
123
+ const app = express();
124
+ addTerrenoDevBrowserLogsRoute(app);
125
+ await supertest(app)
126
+ .post("/__terreno/browser-logs")
127
+ .send({entries: [{level: "info", message: "create directory"}]});
128
+ writeFileSync(logPath, Buffer.alloc(5 * 1024 * 1024));
129
+
130
+ const response = await supertest(app)
131
+ .post("/__terreno/browser-logs")
132
+ .send({entries: [{level: "error", message: "after rollover"}]});
133
+
134
+ assert.equal(response.status, 204);
135
+ assert.isBelow(statSync(logPath).size, 1024);
136
+ assert.include(readFileSync(logPath, "utf8"), "after rollover");
137
+ });
138
+
139
+ it("is not mounted outside development unless explicitly enabled", async () => {
140
+ process.env.NODE_ENV = "test";
141
+
142
+ const disabledApp = express();
143
+ addTerrenoDevBrowserLogsRoute(disabledApp);
144
+ const disabledResponse = await supertest(disabledApp)
145
+ .post("/__terreno/browser-logs")
146
+ .send({entries: [{level: "error", message: "x"}]});
147
+ expect(disabledResponse.status).toBe(404);
148
+
149
+ process.env.TERRENO_BROWSER_LOGS = "true";
150
+ const enabledApp = express();
151
+ addTerrenoDevBrowserLogsRoute(enabledApp);
152
+ const enabledResponse = await supertest(enabledApp)
153
+ .post("/__terreno/browser-logs")
154
+ .send({entries: [{level: "error", message: "x"}]});
155
+ expect(enabledResponse.status).toBe(204);
156
+
157
+ process.env.NODE_ENV = "production";
158
+ const productionApp = express();
159
+ addTerrenoDevBrowserLogsRoute(productionApp);
160
+ const productionResponse = await supertest(productionApp)
161
+ .post("/__terreno/browser-logs")
162
+ .send({entries: [{level: "error", message: "x"}]});
163
+ expect(productionResponse.status).toBe(404);
164
+ });
165
+ });
package/src/adminTypes.ts CHANGED
@@ -11,6 +11,12 @@ export const MAX_BULK_PATCH_IDS = 1000;
11
11
 
12
12
  export type AdminFilterKind = "boolean" | "choice" | "dateRange" | "ref" | "text";
13
13
 
14
+ /**
15
+ * Wire-format sentinel for optional choice filters meaning "field is null or unset".
16
+ * Must match `DATA_TABLE_CHOICE_EMPTY_VALUE` in `@terreno/ui`.
17
+ */
18
+ export const ADMIN_LIST_CHOICE_EMPTY_VALUE = "__empty__";
19
+
14
20
  export interface AdminFilterBoolean {
15
21
  field: string;
16
22
  kind: "boolean";
@@ -19,6 +25,8 @@ export interface AdminFilterBoolean {
19
25
 
20
26
  export interface AdminFilterChoice {
21
27
  choices: {label: string; value: string}[];
28
+ /** When true, the filter UI offers an Empty option and the parser accepts {@link ADMIN_LIST_CHOICE_EMPTY_VALUE}. */
29
+ allowEmpty?: boolean;
22
30
  field: string;
23
31
  kind: "choice";
24
32
  label?: string;
package/src/api.test.ts CHANGED
@@ -1,8 +1,7 @@
1
1
  import {beforeEach, describe, expect, it} from "bun:test";
2
2
  import type express from "express";
3
3
  import {DateTime} from "luxon";
4
- import type mongoose from "mongoose";
5
- import type {Model} from "mongoose";
4
+ import mongoose, {type Model} from "mongoose";
6
5
  import supertest from "supertest";
7
6
  import type TestAgent from "supertest/lib/agent";
8
7
 
@@ -544,6 +543,44 @@ describe("@terreno/api", () => {
544
543
  const res = await server.get("/food").expect(200);
545
544
  expect(res.body.data).toEqual([]);
546
545
  });
546
+
547
+ it("queryFilter undefined values remove keys from the merged query", async () => {
548
+ await FoodModel.create({
549
+ calories: 100,
550
+ hidden: false,
551
+ name: "Apple",
552
+ ownerId: new mongoose.Types.ObjectId(),
553
+ });
554
+ await FoodModel.create({
555
+ calories: 50,
556
+ hidden: false,
557
+ name: "Banana",
558
+ ownerId: new mongoose.Types.ObjectId(),
559
+ });
560
+
561
+ app.use(
562
+ "/food",
563
+ modelRouter(FoodModel, {
564
+ allowAnonymous: true,
565
+ permissions: {
566
+ create: [Permissions.IsAny],
567
+ delete: [Permissions.IsAny],
568
+ list: [Permissions.IsAny],
569
+ read: [Permissions.IsAny],
570
+ update: [Permissions.IsAny],
571
+ },
572
+ queryFields: ["name", "hidden"],
573
+ queryFilter: () => ({
574
+ hidden: undefined,
575
+ name: "Apple",
576
+ }),
577
+ })
578
+ );
579
+ server = supertest(app);
580
+
581
+ const res = await server.get("/food?name=Banana&hidden=true").expect(200);
582
+ expect(res.body.data.map((item: {name: string}) => item.name)).toEqual(["Apple"]);
583
+ });
547
584
  });
548
585
 
549
586
  describe("transformer errors", () => {
package/src/api.ts CHANGED
@@ -17,6 +17,11 @@ import {
17
17
  } from "./actions";
18
18
  import {enrichModelRouterOptions, type ModelRouterBuildContext} from "./adminModelRouter";
19
19
  import type {AdminConfig} from "./adminTypes";
20
+ import {
21
+ type ModelRouterAuditConfig,
22
+ maybeRecordModelRouterAudit,
23
+ snapshotAuditBefore,
24
+ } from "./audit/record";
20
25
  import {authenticateMiddleware, omitUserRolesFromWriteBody, type User} from "./auth";
21
26
  import {registerCollection, replaceCollectionOptions} from "./collectionRegistry";
22
27
  import {
@@ -302,6 +307,13 @@ export interface ModelRouterOptions<T> {
302
307
  * @param value - The document that was deleted, after the soft update of deleted: true (type: T).
303
308
  */
304
309
  postDelete?: (request: express.Request, value: T) => void | Promise<void>;
310
+ /**
311
+ * When true or `{redact}`, persist an `AuditEvent` after successful HTTP
312
+ * create/update/delete. Requires `AuditApp`. Extra `redact` names merge with
313
+ * the default secret segments (`password`, `hash`, `salt`, `token`, `secret`,
314
+ * `refreshToken`).
315
+ */
316
+ audit?: ModelRouterAuditConfig;
305
317
  /** Hook that runs after the object is fetched but before it is serialized.
306
318
  * Returns a promise so that asynchronous actions can be included in the function.
307
319
  * Throw an APIError to return a 400 with an error message.
@@ -397,6 +409,8 @@ export interface ModelRouterOptions<T> {
397
409
  /**
398
410
  * Enable local-first sync (@terreno/syncdb) for this model. Documents are scoped
399
411
  * into streams (owner/tenant/broadcast/custom) with monotonic per-stream cursors.
412
+ * Set `sync.adminBroadcast: true` to also emit `sync:delta` to `{collection}|admin`
413
+ * (default false; stored on the collection catalog at registration).
400
414
  *
401
415
  * Requires the schema to use `isDeletedPlugin` (soft delete tombstones) and
402
416
  * `syncPlugin` (per-stream `_syncSeq` stamping) — validated at registration.
@@ -580,6 +594,9 @@ const getBodyValidationMiddleware = <T>(
580
594
  validationOptions.excludeFields = excludeFields;
581
595
  }
582
596
  }
597
+ if (operation === "update") {
598
+ validationOptions.partial = true;
599
+ }
583
600
 
584
601
  return validateModelRequestBody(model, validationOptions);
585
602
  };
@@ -785,6 +802,15 @@ const _buildModelRouter = <T>(
785
802
  req,
786
803
  user: req.user,
787
804
  });
805
+ void maybeRecordModelRouterAudit({
806
+ after: doc,
807
+ audit: options.audit,
808
+ modelName: model.modelName,
809
+ operation: "create",
810
+ recordId: String(doc._id),
811
+ req,
812
+ verb: "created",
813
+ });
788
814
  try {
789
815
  const serialized = await responseHandler(doc, "create", req, options);
790
816
  return res.status(201).json({data: serialized});
@@ -857,6 +883,11 @@ const _buildModelRouter = <T>(
857
883
  return res.json({data: []});
858
884
  }
859
885
  query = {...query, ...queryFilter};
886
+ for (const [key, value] of Object.entries(queryFilter)) {
887
+ if (value === undefined) {
888
+ delete query[key];
889
+ }
890
+ }
860
891
  }
861
892
 
862
893
  let limit = options.defaultLimit ?? 100;
@@ -1032,6 +1063,7 @@ const _buildModelRouter = <T>(
1032
1063
  }
1033
1064
 
1034
1065
  let doc: Document<unknown, unknown, unknown> & T;
1066
+ const previous = snapshotAuditBefore({audit: options.audit, doc: existingDoc});
1035
1067
  try {
1036
1068
  ({doc} = await executeUpdate<T>({
1037
1069
  body: req.body,
@@ -1061,6 +1093,17 @@ const _buildModelRouter = <T>(
1061
1093
  throw error;
1062
1094
  }
1063
1095
 
1096
+ void maybeRecordModelRouterAudit({
1097
+ after: doc,
1098
+ audit: options.audit,
1099
+ before: previous,
1100
+ modelName: model.modelName,
1101
+ operation: "update",
1102
+ recordId: String(doc._id),
1103
+ req,
1104
+ verb: "updated",
1105
+ });
1106
+
1064
1107
  try {
1065
1108
  const serialized = await responseHandler(doc, "update", req, options);
1066
1109
  return res.json({data: serialized});
@@ -1085,6 +1128,7 @@ const _buildModelRouter = <T>(
1085
1128
  req as Request & {obj: mongoose.Document & T & {deleted?: boolean}}
1086
1129
  ).obj;
1087
1130
 
1131
+ const previous = snapshotAuditBefore({audit: options.audit, doc: existingDoc});
1088
1132
  await executeDelete<T>({
1089
1133
  existingDoc,
1090
1134
  id: req.params.id as string,
@@ -1094,6 +1138,16 @@ const _buildModelRouter = <T>(
1094
1138
  user: req.user,
1095
1139
  });
1096
1140
 
1141
+ void maybeRecordModelRouterAudit({
1142
+ audit: options.audit,
1143
+ before: previous,
1144
+ modelName: model.modelName,
1145
+ operation: "delete",
1146
+ recordId: String(existingDoc._id),
1147
+ req,
1148
+ verb: "deleted",
1149
+ });
1150
+
1097
1151
  return res.status(204).json({});
1098
1152
  })
1099
1153
  );
@@ -1277,6 +1331,20 @@ const _buildModelRouter = <T>(
1277
1331
  });
1278
1332
  }
1279
1333
  }
1334
+
1335
+ const arrayAuditOperation =
1336
+ operation === "POST" ? "arrayPush" : operation === "PATCH" ? "arrayUpdate" : "arrayRemove";
1337
+ void maybeRecordModelRouterAudit({
1338
+ after: doc,
1339
+ audit: options.audit,
1340
+ before: prevDoc,
1341
+ modelName: model.modelName,
1342
+ operation: arrayAuditOperation,
1343
+ recordId: String(doc._id),
1344
+ req,
1345
+ verb: "updated",
1346
+ });
1347
+
1280
1348
  return res.json({
1281
1349
  data: serialize<T>(req, options, doc as unknown as Document<unknown, unknown, unknown> & T),
1282
1350
  });