@terreno/api 57.2.0 → 57.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (472) hide show
  1. package/.ai/skills/mongoose-schema-safety/SKILL.md +23 -10
  2. package/README.md +23 -7
  3. package/dist/actions.js +19 -7
  4. package/dist/adminTypes.d.ts +7 -0
  5. package/dist/adminTypes.js +6 -1
  6. package/dist/api.d.ts +14 -0
  7. package/dist/api.js +111 -60
  8. package/dist/audit/auditApp.d.ts +30 -0
  9. package/dist/audit/auditApp.js +155 -0
  10. package/dist/audit/auditEventModel.d.ts +29 -0
  11. package/dist/audit/auditEventModel.js +102 -0
  12. package/dist/audit/cloudTasksEnqueue.d.ts +32 -0
  13. package/dist/audit/cloudTasksEnqueue.js +162 -0
  14. package/dist/audit/diff.d.ts +10 -0
  15. package/dist/audit/diff.js +230 -0
  16. package/dist/audit/processQueue.d.ts +6 -0
  17. package/dist/audit/processQueue.js +101 -0
  18. package/dist/audit/rbacSink.d.ts +2 -0
  19. package/dist/audit/rbacSink.js +82 -0
  20. package/dist/audit/record.d.ts +56 -0
  21. package/dist/audit/record.js +373 -0
  22. package/dist/auth.d.ts +23 -10
  23. package/dist/auth.js +97 -32
  24. package/dist/authRecovery.d.ts +5 -0
  25. package/dist/authRecovery.js +350 -0
  26. package/dist/authTokens.d.ts +8 -0
  27. package/dist/authTokens.js +162 -0
  28. package/dist/betterAuth.d.ts +39 -0
  29. package/dist/betterAuthApp.d.ts +4 -0
  30. package/dist/betterAuthApp.js +26 -8
  31. package/dist/betterAuthSetup.d.ts +44 -2
  32. package/dist/betterAuthSetup.js +288 -18
  33. package/dist/collectionRegistry.d.ts +40 -0
  34. package/dist/collectionRegistry.js +97 -0
  35. package/dist/configurationApp.d.ts +11 -2
  36. package/dist/configurationApp.js +2 -4
  37. package/dist/docLoader.js +35 -6
  38. package/dist/expressServer.d.ts +26 -3
  39. package/dist/expressServer.js +79 -11
  40. package/dist/index.d.ts +42 -1
  41. package/dist/index.js +84 -2
  42. package/dist/mcp/auth.d.ts +1 -0
  43. package/dist/mcp/auth.js +47 -25
  44. package/dist/mcp/handlers.d.ts +1 -1
  45. package/dist/mcp/handlers.js +67 -233
  46. package/dist/mcp/query.d.ts +2 -15
  47. package/dist/mcp/query.js +8 -8
  48. package/dist/mcp/registry.d.ts +1 -5
  49. package/dist/mcp/registry.js +31 -20
  50. package/dist/mcp/schemaGenerator.d.ts +2 -7
  51. package/dist/mcp/schemaGenerator.js +41 -116
  52. package/dist/mcp/server.d.ts +1 -0
  53. package/dist/mcp/server.js +1 -0
  54. package/dist/mcp/serviceTokens.d.ts +16 -0
  55. package/dist/mcp/serviceTokens.js +345 -0
  56. package/dist/mcp/types.d.ts +2 -2
  57. package/dist/migrations/fixtures/all-down/20260910120000-one.d.ts +4 -0
  58. package/dist/migrations/fixtures/all-down/20260910120000-one.js +49 -0
  59. package/dist/migrations/fixtures/all-down/20260910120001-two.d.ts +4 -0
  60. package/dist/migrations/fixtures/all-down/20260910120001-two.js +49 -0
  61. package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.d.ts +3 -0
  62. package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.js +45 -0
  63. package/dist/migrations/fixtures/bad-name/not-a-migration.d.ts +3 -0
  64. package/dist/migrations/fixtures/bad-name/not-a-migration.js +45 -0
  65. package/dist/migrations/fixtures/missing-up/20260910120000-noup.d.ts +2 -0
  66. package/dist/migrations/fixtures/missing-up/20260910120000-noup.js +5 -0
  67. package/dist/migrations/fixtures/valid/20260910120000-alpha.d.ts +3 -0
  68. package/dist/migrations/fixtures/valid/20260910120000-alpha.js +45 -0
  69. package/dist/migrations/fixtures/valid/20260910120001-beta.d.ts +4 -0
  70. package/dist/migrations/fixtures/valid/20260910120001-beta.js +49 -0
  71. package/dist/migrations/generate.d.ts +17 -0
  72. package/dist/migrations/generate.js +277 -0
  73. package/dist/migrations/load.d.ts +20 -0
  74. package/dist/migrations/load.js +236 -0
  75. package/dist/migrations/lock.d.ts +13 -0
  76. package/dist/migrations/lock.js +145 -0
  77. package/dist/migrations/runner.d.ts +42 -0
  78. package/dist/migrations/runner.js +503 -0
  79. package/dist/migrations/schemaCatalog.d.ts +44 -0
  80. package/dist/migrations/schemaCatalog.js +326 -0
  81. package/dist/migrations/types.d.ts +87 -0
  82. package/dist/migrations/types.js +7 -0
  83. package/dist/models/mcpServiceToken.d.ts +3 -0
  84. package/dist/models/mcpServiceToken.js +208 -0
  85. package/dist/models/notification.d.ts +2 -0
  86. package/dist/models/notification.js +62 -0
  87. package/dist/models/notificationPreference.d.ts +2 -0
  88. package/dist/models/notificationPreference.js +49 -0
  89. package/dist/notifications/notificationService.d.ts +40 -0
  90. package/dist/notifications/notificationService.js +323 -0
  91. package/dist/notifications/notificationsApp.d.ts +18 -0
  92. package/dist/notifications/notificationsApp.js +250 -0
  93. package/dist/notifications/notificationsBeforeSend.d.ts +14 -0
  94. package/dist/notifications/notificationsBeforeSend.js +77 -0
  95. package/dist/openApi.d.ts +1 -7
  96. package/dist/openApi.js +7 -6
  97. package/dist/openApiBuilder.d.ts +19 -7
  98. package/dist/openApiBuilder.js +61 -8
  99. package/dist/openApiCompat.js +1 -1
  100. package/dist/openApiValidator.d.ts +13 -1
  101. package/dist/openApiValidator.js +200 -38
  102. package/dist/orgs/orgContext.d.ts +23 -0
  103. package/dist/orgs/orgContext.js +198 -0
  104. package/dist/orgs/orgPermissions.d.ts +4 -0
  105. package/dist/orgs/orgPermissions.js +77 -0
  106. package/dist/orgs/orgPlugin.d.ts +13 -0
  107. package/dist/orgs/orgPlugin.js +84 -0
  108. package/dist/orgs/organizationModel.d.ts +13 -0
  109. package/dist/orgs/organizationModel.js +301 -0
  110. package/dist/orgs/organizationSettings.d.ts +19 -0
  111. package/dist/orgs/organizationSettings.js +120 -0
  112. package/dist/orgs/orgsApp.d.ts +28 -0
  113. package/dist/orgs/orgsApp.js +678 -0
  114. package/dist/permissions.d.ts +7 -13
  115. package/dist/permissions.js +8 -31
  116. package/dist/plugins.d.ts +14 -1
  117. package/dist/plugins.js +17 -6
  118. package/dist/populate.d.ts +2 -2
  119. package/dist/populate.js +47 -42
  120. package/dist/rateLimit/applyTrustProxy.d.ts +3 -0
  121. package/dist/rateLimit/applyTrustProxy.js +17 -0
  122. package/dist/rateLimit/createStore.d.ts +2 -0
  123. package/dist/rateLimit/createStore.js +28 -0
  124. package/dist/rateLimit/memoryStore.d.ts +2 -0
  125. package/dist/rateLimit/memoryStore.js +108 -0
  126. package/dist/rateLimit/middleware.d.ts +3 -0
  127. package/dist/rateLimit/middleware.js +109 -0
  128. package/dist/rateLimit/mongoStore.d.ts +4 -0
  129. package/dist/rateLimit/mongoStore.js +123 -0
  130. package/dist/rateLimit/policies.d.ts +10 -0
  131. package/dist/rateLimit/policies.js +149 -0
  132. package/dist/rateLimit/redisStore.d.ts +4 -0
  133. package/dist/rateLimit/redisStore.js +156 -0
  134. package/dist/rateLimit/types.d.ts +54 -0
  135. package/dist/rateLimit/types.js +9 -0
  136. package/dist/rbac/access.js +35 -14
  137. package/dist/rbac/assertAllowed.d.ts +9 -0
  138. package/dist/rbac/assertAllowed.js +182 -0
  139. package/dist/rbac/membershipOrgAdminSource.d.ts +6 -0
  140. package/dist/rbac/membershipOrgAdminSource.js +122 -0
  141. package/dist/rbac/modelRouterAccess.d.ts +4 -0
  142. package/dist/rbac/modelRouterAccess.js +11 -4
  143. package/dist/rbac/permissionUtils.js +3 -2
  144. package/dist/rbac/resolve.js +65 -35
  145. package/dist/rbac/roleModel.d.ts +2 -5
  146. package/dist/rbac/roleModel.js +18 -4
  147. package/dist/rbac/routes.js +15 -6
  148. package/dist/rbac/statements.d.ts +10 -1
  149. package/dist/rbac/statements.js +19 -2
  150. package/dist/rbac/types.d.ts +5 -0
  151. package/dist/realtime/changeStreamWatcher.d.ts +10 -4
  152. package/dist/realtime/changeStreamWatcher.js +110 -64
  153. package/dist/realtime/deprecation.d.ts +13 -0
  154. package/dist/realtime/deprecation.js +33 -0
  155. package/dist/realtime/realtimeApp.d.ts +2 -1
  156. package/dist/realtime/realtimeApp.js +11 -11
  157. package/dist/realtime/registry.d.ts +0 -31
  158. package/dist/realtime/registry.js +44 -31
  159. package/dist/realtime/socketAuth.d.ts +5 -5
  160. package/dist/realtime/socketAuth.js +11 -1
  161. package/dist/realtime/socketUser.d.ts +5 -1
  162. package/dist/realtime/types.d.ts +14 -4
  163. package/dist/schemaMetadata.d.ts +56 -0
  164. package/dist/schemaMetadata.js +524 -0
  165. package/dist/seedRunner.d.ts +88 -0
  166. package/dist/seedRunner.js +627 -0
  167. package/dist/sync/adminBroadcastScope.d.ts +40 -0
  168. package/dist/sync/adminBroadcastScope.js +194 -0
  169. package/dist/sync/adminWindowAccess.d.ts +13 -0
  170. package/dist/sync/adminWindowAccess.js +96 -0
  171. package/dist/sync/adminWindowMutation.d.ts +88 -0
  172. package/dist/sync/adminWindowMutation.js +247 -0
  173. package/dist/sync/executors.d.ts +19 -3
  174. package/dist/sync/executors.js +194 -165
  175. package/dist/sync/loadHarness.js +28 -19
  176. package/dist/sync/models.js +26 -24
  177. package/dist/sync/mutationHandler.d.ts +14 -2
  178. package/dist/sync/mutationHandler.js +201 -76
  179. package/dist/sync/registrationSideEffects.d.ts +35 -0
  180. package/dist/sync/registrationSideEffects.js +151 -0
  181. package/dist/sync/registry.d.ts +2 -52
  182. package/dist/sync/registry.js +42 -187
  183. package/dist/sync/routes.d.ts +13 -0
  184. package/dist/sync/routes.js +116 -58
  185. package/dist/sync/scripts/compactTombstones.js +0 -2
  186. package/dist/sync/socketHandlers.d.ts +8 -2
  187. package/dist/sync/socketHandlers.js +144 -50
  188. package/dist/sync/streams.d.ts +2 -0
  189. package/dist/sync/streams.js +7 -1
  190. package/dist/sync/syncApp.d.ts +4 -3
  191. package/dist/sync/syncApp.js +5 -4
  192. package/dist/sync/syncBatch.d.ts +5 -2
  193. package/dist/sync/syncBatch.js +7 -6
  194. package/dist/sync/syncSeqPlugin.d.ts +1 -1
  195. package/dist/sync/syncSeqPlugin.js +20 -16
  196. package/dist/sync/types.d.ts +18 -0
  197. package/dist/terrenoApp.d.ts +48 -5
  198. package/dist/terrenoApp.js +157 -72
  199. package/dist/tests/createTestData.d.ts +1 -3
  200. package/dist/tests/createTestData.js +3 -5
  201. package/dist/tests/models.d.ts +3 -0
  202. package/dist/tests/models.js +15 -2
  203. package/dist/tests/testHelper.d.ts +0 -5
  204. package/dist/tests/testHelper.js +2 -9
  205. package/dist/types/authToken.d.ts +33 -0
  206. package/dist/types/authToken.js +2 -0
  207. package/dist/types/mcpServiceToken.d.ts +41 -0
  208. package/dist/types/mcpServiceToken.js +2 -0
  209. package/dist/types/membership.d.ts +23 -0
  210. package/dist/types/membership.js +2 -0
  211. package/dist/types/notification.d.ts +28 -0
  212. package/dist/types/notification.js +2 -0
  213. package/dist/types/notificationPreference.d.ts +20 -0
  214. package/dist/types/notificationPreference.js +2 -0
  215. package/dist/types/organization.d.ts +36 -0
  216. package/dist/types/organization.js +2 -0
  217. package/dist/webhooks/headerValue.d.ts +2 -0
  218. package/dist/webhooks/headerValue.js +14 -0
  219. package/dist/webhooks/idempotency/memoryStore.d.ts +10 -0
  220. package/dist/webhooks/idempotency/memoryStore.js +65 -0
  221. package/dist/webhooks/idempotency/mongoStore.d.ts +4 -0
  222. package/dist/webhooks/idempotency/mongoStore.js +150 -0
  223. package/dist/webhooks/idempotency/webhookReceipt.d.ts +17 -0
  224. package/dist/webhooks/idempotency/webhookReceipt.js +39 -0
  225. package/dist/webhooks/rawBody.d.ts +15 -0
  226. package/dist/webhooks/rawBody.js +23 -0
  227. package/dist/webhooks/timingSafeEqual.d.ts +4 -0
  228. package/dist/webhooks/timingSafeEqual.js +17 -0
  229. package/dist/webhooks/verifiers/hmac.d.ts +15 -0
  230. package/dist/webhooks/verifiers/hmac.js +49 -0
  231. package/dist/webhooks/verifiers/sendgrid.d.ts +10 -0
  232. package/dist/webhooks/verifiers/sendgrid.js +56 -0
  233. package/dist/webhooks/verifiers/stripe.d.ts +9 -0
  234. package/dist/webhooks/verifiers/stripe.js +99 -0
  235. package/dist/webhooks/verifiers/twilio.d.ts +9 -0
  236. package/dist/webhooks/verifiers/twilio.js +112 -0
  237. package/dist/webhooks/webhooksApp.d.ts +33 -0
  238. package/dist/webhooks/webhooksApp.js +195 -0
  239. package/package.json +32 -27
  240. package/src/__snapshots__/openApi.test.ts.snap +444 -36
  241. package/src/__snapshots__/openApiBuilder.test.ts.snap +24 -24
  242. package/src/__snapshots__/schemaMetadata.test.ts.snap +196 -0
  243. package/src/actions.ts +20 -13
  244. package/src/adminModelRouter.test.ts +133 -0
  245. package/src/adminTypes.ts +8 -0
  246. package/src/api.arrayOperations.test.ts +43 -31
  247. package/src/api.hooks.test.ts +38 -29
  248. package/src/api.query.test.ts +31 -31
  249. package/src/api.test.ts +133 -97
  250. package/src/api.ts +84 -27
  251. package/src/audit/auditApp.test.ts +243 -0
  252. package/src/audit/auditApp.ts +139 -0
  253. package/src/audit/auditEventModel.ts +156 -0
  254. package/src/audit/auditRouter.test.ts +456 -0
  255. package/src/audit/cloudTasksEnqueue.test.ts +124 -0
  256. package/src/audit/cloudTasksEnqueue.ts +104 -0
  257. package/src/audit/diff.ts +163 -0
  258. package/src/audit/processQueue.ts +69 -0
  259. package/src/audit/rbacSink.test.ts +86 -0
  260. package/src/audit/rbacSink.ts +42 -0
  261. package/src/audit/record.test.ts +402 -0
  262. package/src/audit/record.ts +328 -0
  263. package/src/auth.test.ts +108 -52
  264. package/src/auth.ts +98 -29
  265. package/src/authRecovery.test.ts +281 -0
  266. package/src/authRecovery.ts +279 -0
  267. package/src/authTokens.test.ts +94 -0
  268. package/src/authTokens.ts +118 -0
  269. package/src/authVerification.test.ts +293 -0
  270. package/src/betterAuth.ts +31 -0
  271. package/src/betterAuthApp.test.ts +1 -0
  272. package/src/betterAuthApp.ts +27 -9
  273. package/src/betterAuthSetup.test.ts +595 -38
  274. package/src/betterAuthSetup.ts +261 -5
  275. package/src/collectionRegistry.test.ts +164 -0
  276. package/src/collectionRegistry.ts +135 -0
  277. package/src/configurationApp.ts +13 -7
  278. package/src/docLoader.test.ts +45 -1
  279. package/src/docLoader.ts +37 -6
  280. package/src/express.d.ts +3 -0
  281. package/src/expressServer.test.ts +180 -68
  282. package/src/expressServer.ts +75 -19
  283. package/src/githubAuth.test.ts +60 -55
  284. package/src/index.ts +127 -0
  285. package/src/mcp/auth.test.ts +47 -0
  286. package/src/mcp/auth.ts +32 -11
  287. package/src/mcp/handlers.test.ts +275 -0
  288. package/src/mcp/handlers.ts +45 -172
  289. package/src/mcp/integration.test.ts +59 -9
  290. package/src/mcp/query.ts +5 -7
  291. package/src/mcp/registry.ts +29 -20
  292. package/src/mcp/schemaGenerator.test.ts +8 -0
  293. package/src/mcp/schemaGenerator.ts +49 -131
  294. package/src/mcp/server.ts +2 -0
  295. package/src/mcp/serviceTokens.test.ts +330 -0
  296. package/src/mcp/serviceTokens.ts +307 -0
  297. package/src/mcp/toolGenerator.test.ts +82 -1
  298. package/src/mcp/types.ts +2 -6
  299. package/src/migrations/cli.test.ts +376 -0
  300. package/src/migrations/cli.ts +283 -0
  301. package/src/migrations/fixtures/all-down/20260910120000-one.ts +6 -0
  302. package/src/migrations/fixtures/all-down/20260910120001-two.ts +6 -0
  303. package/src/migrations/fixtures/bad-id/20260910120000-mismatch.ts +4 -0
  304. package/src/migrations/fixtures/bad-name/not-a-migration.ts +4 -0
  305. package/src/migrations/fixtures/missing-up/20260910120000-noup.ts +2 -0
  306. package/src/migrations/fixtures/valid/20260910120000-alpha.ts +4 -0
  307. package/src/migrations/fixtures/valid/20260910120001-beta.ts +6 -0
  308. package/src/migrations/generate.test.ts +333 -0
  309. package/src/migrations/generate.ts +216 -0
  310. package/src/migrations/load.test.ts +103 -0
  311. package/src/migrations/load.ts +124 -0
  312. package/src/migrations/lock.test.ts +133 -0
  313. package/src/migrations/lock.ts +118 -0
  314. package/src/migrations/runner.test.ts +504 -0
  315. package/src/migrations/runner.ts +358 -0
  316. package/src/migrations/schemaCatalog.test.ts +159 -0
  317. package/src/migrations/schemaCatalog.ts +262 -0
  318. package/src/migrations/types.ts +94 -0
  319. package/src/models/mcpServiceToken.test.ts +129 -0
  320. package/src/models/mcpServiceToken.ts +158 -0
  321. package/src/models/notification.ts +68 -0
  322. package/src/models/notificationPreference.ts +62 -0
  323. package/src/notifications/notificationService.ts +254 -0
  324. package/src/notifications/notificationsApp.test.ts +505 -0
  325. package/src/notifications/notificationsApp.ts +200 -0
  326. package/src/notifications/notificationsBeforeSend.ts +51 -0
  327. package/src/openApi.test.ts +80 -65
  328. package/src/openApi.ts +2 -1
  329. package/src/openApiBuilder.test.ts +95 -7
  330. package/src/openApiBuilder.ts +60 -12
  331. package/src/openApiCompat.ts +1 -1
  332. package/src/openApiValidator.test.ts +270 -56
  333. package/src/openApiValidator.ts +219 -36
  334. package/src/orgs/orgAccessOptIn.test.ts +87 -0
  335. package/src/orgs/orgContext.test.ts +259 -0
  336. package/src/orgs/orgContext.ts +151 -0
  337. package/src/orgs/orgPermissions.test.ts +105 -0
  338. package/src/orgs/orgPermissions.ts +40 -0
  339. package/src/orgs/orgPlugin.test.ts +130 -0
  340. package/src/orgs/orgPlugin.ts +70 -0
  341. package/src/orgs/orgRbac.test.ts +267 -0
  342. package/src/orgs/orgSecurityDefects.test.ts +415 -0
  343. package/src/orgs/organizationModel.test.ts +205 -0
  344. package/src/orgs/organizationModel.ts +257 -0
  345. package/src/orgs/organizationSettings.test.ts +113 -0
  346. package/src/orgs/organizationSettings.ts +126 -0
  347. package/src/orgs/orgsApp.test.ts +382 -0
  348. package/src/orgs/orgsApp.ts +563 -0
  349. package/src/permissions.test.ts +62 -36
  350. package/src/permissions.ts +8 -30
  351. package/src/plugins.test.ts +14 -0
  352. package/src/plugins.ts +34 -9
  353. package/src/populate.test.ts +34 -0
  354. package/src/populate.ts +40 -29
  355. package/src/rateLimit/applyTrustProxy.ts +17 -0
  356. package/src/rateLimit/createStore.ts +25 -0
  357. package/src/rateLimit/memoryStore.ts +40 -0
  358. package/src/rateLimit/middleware.ts +79 -0
  359. package/src/rateLimit/mongoStore.test.ts +80 -0
  360. package/src/rateLimit/mongoStore.ts +77 -0
  361. package/src/rateLimit/policies.ts +130 -0
  362. package/src/rateLimit/rateLimit.test.ts +328 -0
  363. package/src/rateLimit/redisStore.ioredis.test.ts +29 -0
  364. package/src/rateLimit/redisStore.test.ts +114 -0
  365. package/src/rateLimit/redisStore.ts +86 -0
  366. package/src/rateLimit/types.ts +64 -0
  367. package/src/rbac/access.ts +16 -4
  368. package/src/rbac/assertAllowed.test.ts +325 -0
  369. package/src/rbac/assertAllowed.ts +157 -0
  370. package/src/rbac/backfillAdmins.test.ts +124 -0
  371. package/src/rbac/fieldViews.test.ts +89 -0
  372. package/src/rbac/membershipOrgAdminSource.ts +59 -0
  373. package/src/rbac/modelRouterAccess.test.ts +126 -0
  374. package/src/rbac/modelRouterAccess.ts +8 -2
  375. package/src/rbac/permissionUtils.test.ts +26 -5
  376. package/src/rbac/permissionUtils.ts +3 -2
  377. package/src/rbac/realtimeAccess.test.ts +109 -1
  378. package/src/rbac/resolve.test.ts +34 -2
  379. package/src/rbac/resolve.ts +31 -11
  380. package/src/rbac/roleManager.test.ts +169 -0
  381. package/src/rbac/roleModel.test.ts +34 -1
  382. package/src/rbac/roleModel.ts +17 -1
  383. package/src/rbac/routes.test.ts +233 -0
  384. package/src/rbac/routes.ts +16 -6
  385. package/src/rbac/statements.test.ts +19 -0
  386. package/src/rbac/statements.ts +19 -1
  387. package/src/rbac/types.ts +5 -0
  388. package/src/realtime/changeStreamWatcher.ts +73 -33
  389. package/src/realtime/deprecation.test.ts +60 -0
  390. package/src/realtime/deprecation.ts +33 -0
  391. package/src/realtime/realtime.test.ts +365 -189
  392. package/src/realtime/realtimeApp.ts +11 -11
  393. package/src/realtime/realtimeAppSetup.test.ts +32 -5
  394. package/src/realtime/registry.ts +48 -42
  395. package/src/realtime/sessionRevalidation.test.ts +57 -44
  396. package/src/realtime/socketAuth.test.ts +75 -23
  397. package/src/realtime/socketAuth.ts +17 -6
  398. package/src/realtime/socketUser.ts +5 -3
  399. package/src/realtime/types.ts +14 -4
  400. package/src/schemaMetadata.test.ts +419 -0
  401. package/src/schemaMetadata.ts +593 -0
  402. package/src/scrubAdminFields.test.ts +105 -0
  403. package/src/seedRunner.test.ts +591 -0
  404. package/src/seedRunner.ts +464 -0
  405. package/src/sync/adminBroadcastConfig.test.ts +96 -0
  406. package/src/sync/adminBroadcastScope.test.ts +155 -0
  407. package/src/sync/adminBroadcastScope.ts +123 -0
  408. package/src/sync/adminWindowAccess.test.ts +57 -0
  409. package/src/sync/adminWindowAccess.ts +32 -0
  410. package/src/sync/adminWindowMutation.test.ts +450 -0
  411. package/src/sync/adminWindowMutation.ts +283 -0
  412. package/src/sync/docMatchesMutationData.test.ts +16 -0
  413. package/src/sync/ensureSyncIndexes.test.ts +54 -15
  414. package/src/sync/executors.test.ts +40 -0
  415. package/src/sync/executors.ts +57 -18
  416. package/src/sync/integration.test.ts +15 -7
  417. package/src/sync/loadHarness.ts +28 -19
  418. package/src/sync/models.ts +32 -18
  419. package/src/sync/mutationHandler.test.ts +293 -17
  420. package/src/sync/mutationHandler.ts +180 -36
  421. package/src/sync/registrationSideEffects.test.ts +126 -0
  422. package/src/sync/registrationSideEffects.ts +131 -0
  423. package/src/sync/registry.ts +49 -171
  424. package/src/sync/routes.ts +55 -10
  425. package/src/sync/scripts/compactTombstones.ts +0 -2
  426. package/src/sync/sessionRevalidationIntegration.test.ts +12 -11
  427. package/src/sync/socketHandlers.ts +154 -58
  428. package/src/sync/streams.ts +6 -0
  429. package/src/sync/sync.test.ts +28 -25
  430. package/src/sync/syncApp.ts +5 -4
  431. package/src/sync/syncBatch.ts +10 -4
  432. package/src/sync/syncFrontier.test.ts +17 -15
  433. package/src/sync/syncPhaseC.test.ts +54 -43
  434. package/src/sync/syncRoutes.test.ts +347 -38
  435. package/src/sync/syncSeqPlugin.ts +66 -44
  436. package/src/sync/syncSocket.test.ts +341 -81
  437. package/src/sync/types.ts +20 -0
  438. package/src/terrenoApp.mcpServiceTokens.test.ts +173 -0
  439. package/src/terrenoApp.migrations.test.ts +114 -0
  440. package/src/terrenoApp.test.ts +41 -0
  441. package/src/terrenoApp.ts +181 -46
  442. package/src/tests/createTestData.ts +2 -2
  443. package/src/tests/models.ts +24 -3
  444. package/src/tests/testHelper.ts +1 -7
  445. package/src/types/authToken.ts +41 -0
  446. package/src/types/mcpServiceToken.ts +48 -0
  447. package/src/types/membership.ts +48 -0
  448. package/src/types/notification.ts +34 -0
  449. package/src/types/notificationPreference.ts +28 -0
  450. package/src/types/organization.ts +49 -0
  451. package/src/webhooks/headerValue.test.ts +22 -0
  452. package/src/webhooks/headerValue.ts +12 -0
  453. package/src/webhooks/idempotency/memoryStore.ts +34 -0
  454. package/src/webhooks/idempotency/mongoStore.test.ts +274 -0
  455. package/src/webhooks/idempotency/mongoStore.ts +83 -0
  456. package/src/webhooks/idempotency/webhookReceipt.ts +67 -0
  457. package/src/webhooks/rawBody.test.ts +107 -0
  458. package/src/webhooks/rawBody.ts +24 -0
  459. package/src/webhooks/timingSafeEqual.ts +16 -0
  460. package/src/webhooks/verifiers/hmac.test.ts +110 -0
  461. package/src/webhooks/verifiers/hmac.ts +54 -0
  462. package/src/webhooks/verifiers/providerVerifiers.test.ts +388 -0
  463. package/src/webhooks/verifiers/sendgrid.ts +59 -0
  464. package/src/webhooks/verifiers/stripe.ts +67 -0
  465. package/src/webhooks/verifiers/twilio.ts +69 -0
  466. package/src/webhooks/webhooksApp.test.ts +221 -0
  467. package/src/webhooks/webhooksApp.ts +144 -0
  468. package/tsconfig.json +1 -1
  469. package/tsconfig.typedoc.json +2 -1
  470. package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.d.ts +0 -2
  471. package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
  472. package/src/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
@@ -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",
@@ -168,8 +167,8 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
168
167
  "eatenBy": {
169
168
  "items": {
170
169
  "description": "Users who have eaten this food",
171
- "required": true,
172
- "type": "schemaobjectid",
170
+ "format": "objectid",
171
+ "type": "string",
173
172
  },
174
173
  "type": "array",
175
174
  },
@@ -202,10 +201,10 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
202
201
  },
203
202
  "userId": {
204
203
  "description": "The user who liked the item",
204
+ "format": "objectid",
205
205
  "type": "string",
206
206
  },
207
207
  },
208
- "required": [],
209
208
  "type": "object",
210
209
  },
211
210
  "type": "array",
@@ -216,6 +215,7 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
216
215
  },
217
216
  "ownerId": {
218
217
  "description": "The user who owns this food entry",
218
+ "format": "objectid",
219
219
  "type": "string",
220
220
  },
221
221
  "source": {
@@ -357,7 +357,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
357
357
  "type": "string",
358
358
  },
359
359
  },
360
- "required": [],
361
360
  "type": "object",
362
361
  },
363
362
  "type": "array",
@@ -373,8 +372,8 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
373
372
  "eatenBy": {
374
373
  "items": {
375
374
  "description": "Users who have eaten this food",
376
- "required": true,
377
- "type": "schemaobjectid",
375
+ "format": "objectid",
376
+ "type": "string",
378
377
  },
379
378
  "type": "array",
380
379
  },
@@ -407,10 +406,10 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
407
406
  },
408
407
  "userId": {
409
408
  "description": "The user who liked the item",
409
+ "format": "objectid",
410
410
  "type": "string",
411
411
  },
412
412
  },
413
- "required": [],
414
413
  "type": "object",
415
414
  },
416
415
  "type": "array",
@@ -421,6 +420,7 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
421
420
  },
422
421
  "ownerId": {
423
422
  "description": "The user who owns this food entry",
423
+ "format": "objectid",
424
424
  "type": "string",
425
425
  },
426
426
  "source": {
@@ -491,7 +491,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
491
491
  "type": "string",
492
492
  },
493
493
  },
494
- "required": [],
495
494
  "type": "object",
496
495
  },
497
496
  "type": "array",
@@ -507,8 +506,8 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
507
506
  "eatenBy": {
508
507
  "items": {
509
508
  "description": "Users who have eaten this food",
510
- "required": true,
511
- "type": "schemaobjectid",
509
+ "format": "objectid",
510
+ "type": "string",
512
511
  },
513
512
  "type": "array",
514
513
  },
@@ -541,10 +540,10 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
541
540
  },
542
541
  "userId": {
543
542
  "description": "The user who liked the item",
543
+ "format": "objectid",
544
544
  "type": "string",
545
545
  },
546
546
  },
547
- "required": [],
548
547
  "type": "object",
549
548
  },
550
549
  "type": "array",
@@ -555,6 +554,7 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
555
554
  },
556
555
  "ownerId": {
557
556
  "description": "The user who owns this food entry",
557
+ "format": "objectid",
558
558
  "type": "string",
559
559
  },
560
560
  "source": {
@@ -1105,7 +1105,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
1105
1105
  "type": "string",
1106
1106
  },
1107
1107
  },
1108
- "required": [],
1109
1108
  "type": "object",
1110
1109
  },
1111
1110
  "type": "array",
@@ -1121,8 +1120,8 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
1121
1120
  "eatenBy": {
1122
1121
  "items": {
1123
1122
  "description": "Users who have eaten this food",
1124
- "required": true,
1125
- "type": "schemaobjectid",
1123
+ "format": "objectid",
1124
+ "type": "string",
1126
1125
  },
1127
1126
  "type": "array",
1128
1127
  },
@@ -1155,10 +1154,10 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
1155
1154
  },
1156
1155
  "userId": {
1157
1156
  "description": "The user who liked the item",
1157
+ "format": "objectid",
1158
1158
  "type": "string",
1159
1159
  },
1160
1160
  },
1161
- "required": [],
1162
1161
  "type": "object",
1163
1162
  },
1164
1163
  "type": "array",
@@ -1169,6 +1168,7 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
1169
1168
  },
1170
1169
  "ownerId": {
1171
1170
  "description": "The user who owns this food entry",
1171
+ "format": "objectid",
1172
1172
  "type": "string",
1173
1173
  },
1174
1174
  "source": {
@@ -1303,7 +1303,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
1303
1303
  "type": "string",
1304
1304
  },
1305
1305
  },
1306
- "required": [],
1307
1306
  "type": "object",
1308
1307
  },
1309
1308
  "type": "array",
@@ -1319,8 +1318,8 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
1319
1318
  "eatenBy": {
1320
1319
  "items": {
1321
1320
  "description": "Users who have eaten this food",
1322
- "required": true,
1323
- "type": "schemaobjectid",
1321
+ "format": "objectid",
1322
+ "type": "string",
1324
1323
  },
1325
1324
  "type": "array",
1326
1325
  },
@@ -1353,10 +1352,10 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
1353
1352
  },
1354
1353
  "userId": {
1355
1354
  "description": "The user who liked the item",
1355
+ "format": "objectid",
1356
1356
  "type": "string",
1357
1357
  },
1358
1358
  },
1359
- "required": [],
1360
1359
  "type": "object",
1361
1360
  },
1362
1361
  "type": "array",
@@ -1367,6 +1366,7 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
1367
1366
  },
1368
1367
  "ownerId": {
1369
1368
  "description": "The user who owns this food entry",
1369
+ "format": "objectid",
1370
1370
  "type": "string",
1371
1371
  },
1372
1372
  "source": {
@@ -1437,7 +1437,6 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
1437
1437
  "type": "string",
1438
1438
  },
1439
1439
  },
1440
- "required": [],
1441
1440
  "type": "object",
1442
1441
  },
1443
1442
  "type": "array",
@@ -1453,8 +1452,8 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
1453
1452
  "eatenBy": {
1454
1453
  "items": {
1455
1454
  "description": "Users who have eaten this food",
1456
- "required": true,
1457
- "type": "schemaobjectid",
1455
+ "format": "objectid",
1456
+ "type": "string",
1458
1457
  },
1459
1458
  "type": "array",
1460
1459
  },
@@ -1487,10 +1486,10 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
1487
1486
  },
1488
1487
  "userId": {
1489
1488
  "description": "The user who liked the item",
1489
+ "format": "objectid",
1490
1490
  "type": "string",
1491
1491
  },
1492
1492
  },
1493
- "required": [],
1494
1493
  "type": "object",
1495
1494
  },
1496
1495
  "type": "array",
@@ -1501,6 +1500,7 @@ exports[`OpenApiMiddlewareBuilder snapshot tests matches OpenAPI spec snapshot 1
1501
1500
  },
1502
1501
  "ownerId": {
1503
1502
  "description": "The user who owns this food entry",
1503
+ "format": "objectid",
1504
1504
  "type": "string",
1505
1505
  },
1506
1506
  "source": {
@@ -0,0 +1,196 @@
1
+ // Bun Snapshot v1, https://bun.sh/docs/test/snapshots
2
+
3
+ exports[`describeModel returns a field graph snapshot for the fixture schema 1`] = `
4
+ {
5
+ "__v": {
6
+ "default": undefined,
7
+ "description": undefined,
8
+ "enum": undefined,
9
+ "kind": "number",
10
+ "ref": undefined,
11
+ "required": false,
12
+ "system": true,
13
+ },
14
+ "_id": {
15
+ "default": undefined,
16
+ "description": undefined,
17
+ "enum": undefined,
18
+ "kind": "objectId",
19
+ "ref": undefined,
20
+ "required": false,
21
+ "system": true,
22
+ },
23
+ "completed": {
24
+ "default": false,
25
+ "description": "Whether the item is done",
26
+ "enum": undefined,
27
+ "kind": "boolean",
28
+ "ref": undefined,
29
+ "required": false,
30
+ "system": false,
31
+ },
32
+ "created": {
33
+ "default": undefined,
34
+ "description": "Created timestamp",
35
+ "enum": undefined,
36
+ "kind": "date",
37
+ "ref": undefined,
38
+ "required": false,
39
+ "system": true,
40
+ },
41
+ "createdAt": {
42
+ "default": undefined,
43
+ "description": "When the record was created",
44
+ "enum": undefined,
45
+ "kind": "date",
46
+ "ref": undefined,
47
+ "required": false,
48
+ "system": false,
49
+ },
50
+ "deleted": {
51
+ "default": false,
52
+ "description": "Soft delete flag",
53
+ "enum": undefined,
54
+ "kind": "boolean",
55
+ "ref": undefined,
56
+ "required": false,
57
+ "system": true,
58
+ },
59
+ "label": {
60
+ "default": undefined,
61
+ "description": "Display label",
62
+ "enum": undefined,
63
+ "kind": "string",
64
+ "ref": undefined,
65
+ "required": true,
66
+ "system": false,
67
+ },
68
+ "metadata": {
69
+ "default": undefined,
70
+ "description": "Arbitrary metadata",
71
+ "enum": undefined,
72
+ "kind": "mixed",
73
+ "ref": undefined,
74
+ "required": false,
75
+ "system": false,
76
+ },
77
+ "ownerId": {
78
+ "default": undefined,
79
+ "description": "Owning user",
80
+ "enum": undefined,
81
+ "kind": "objectId",
82
+ "ref": "User",
83
+ "required": true,
84
+ "system": false,
85
+ },
86
+ "status": {
87
+ "default": undefined,
88
+ "description": "Workflow status",
89
+ "enum": [
90
+ "draft",
91
+ "published",
92
+ ],
93
+ "kind": "string",
94
+ "ref": undefined,
95
+ "required": false,
96
+ "system": false,
97
+ },
98
+ "tags": {
99
+ "default": undefined,
100
+ "description": "Search tags",
101
+ "isArray": true,
102
+ "item": {
103
+ "description": undefined,
104
+ "enum": undefined,
105
+ "kind": "string",
106
+ "ref": undefined,
107
+ "required": false,
108
+ },
109
+ "kind": "string",
110
+ "ref": undefined,
111
+ "required": false,
112
+ "system": false,
113
+ },
114
+ "tasks": {
115
+ "default": undefined,
116
+ "description": "Nested tasks",
117
+ "enum": undefined,
118
+ "fields": {
119
+ "_id": {
120
+ "default": undefined,
121
+ "description": undefined,
122
+ "enum": undefined,
123
+ "kind": "objectId",
124
+ "ref": undefined,
125
+ "required": false,
126
+ "system": true,
127
+ },
128
+ "done": {
129
+ "default": undefined,
130
+ "description": "Whether the task is done",
131
+ "enum": undefined,
132
+ "kind": "boolean",
133
+ "ref": undefined,
134
+ "required": false,
135
+ "system": false,
136
+ },
137
+ "title": {
138
+ "default": undefined,
139
+ "description": "Task title",
140
+ "enum": undefined,
141
+ "kind": "string",
142
+ "ref": undefined,
143
+ "required": true,
144
+ "system": false,
145
+ },
146
+ },
147
+ "isArray": true,
148
+ "item": {
149
+ "fields": {
150
+ "_id": {
151
+ "default": undefined,
152
+ "description": undefined,
153
+ "enum": undefined,
154
+ "kind": "objectId",
155
+ "ref": undefined,
156
+ "required": false,
157
+ "system": true,
158
+ },
159
+ "done": {
160
+ "default": undefined,
161
+ "description": "Whether the task is done",
162
+ "enum": undefined,
163
+ "kind": "boolean",
164
+ "ref": undefined,
165
+ "required": false,
166
+ "system": false,
167
+ },
168
+ "title": {
169
+ "default": undefined,
170
+ "description": "Task title",
171
+ "enum": undefined,
172
+ "kind": "string",
173
+ "ref": undefined,
174
+ "required": true,
175
+ "system": false,
176
+ },
177
+ },
178
+ "kind": "embedded",
179
+ "required": false,
180
+ },
181
+ "kind": "embedded",
182
+ "ref": undefined,
183
+ "required": false,
184
+ "system": false,
185
+ },
186
+ "updated": {
187
+ "default": undefined,
188
+ "description": "Updated timestamp",
189
+ "enum": undefined,
190
+ "kind": "date",
191
+ "ref": undefined,
192
+ "required": false,
193
+ "system": true,
194
+ },
195
+ }
196
+ `;
package/src/actions.ts CHANGED
@@ -325,31 +325,37 @@ const getArrayFieldNames = <T>(model: Model<T>): string[] => {
325
325
  .map((config) => config.path);
326
326
  };
327
327
 
328
- // Registration-time validation throws plain Error so misconfiguration fails at app boot.
328
+ // Registration-time validation throws APIError so misconfiguration fails at app boot.
329
329
  const validateActionConfig = (
330
330
  scope: ActionScope,
331
331
  name: string,
332
332
  config: BaseActionConfig<unknown, unknown, unknown>
333
333
  ): void => {
334
334
  if (!name) {
335
- throw new Error("Action name cannot be empty");
335
+ throw new APIError({status: 500, title: "Action name cannot be empty"});
336
336
  }
337
337
  if (!ACTION_NAME_PATTERN.test(name)) {
338
- throw new Error(
339
- `Invalid action name "${name}". Action names must match ${ACTION_NAME_PATTERN.toString()}`
340
- );
338
+ throw new APIError({
339
+ status: 500,
340
+ title: `Invalid action name "${name}". Action names must match ${ACTION_NAME_PATTERN.toString()}`,
341
+ });
341
342
  }
342
343
  if (config.permissions === undefined && !config.access) {
343
- throw new Error(
344
- `Action "${name}" (${scope}) is missing required "permissions" or "access". ` +
345
- "Provide at least one permission function, an access descriptor, or [] to disable the action."
346
- );
344
+ throw new APIError({
345
+ status: 500,
346
+ title:
347
+ `Action "${name}" (${scope}) is missing required "permissions" or "access". ` +
348
+ "Provide at least one permission function, an access descriptor, or [] to disable the action.",
349
+ });
347
350
  }
348
351
  if (config.permissions !== undefined && config.permissions.length === 0 && !config.access) {
349
352
  return;
350
353
  }
351
354
  if (config.method !== "GET" && config.method !== "POST") {
352
- throw new Error(`Action "${name}" (${scope}) only supports GET and POST methods`);
355
+ throw new APIError({
356
+ status: 500,
357
+ title: `Action "${name}" (${scope}) only supports GET and POST methods`,
358
+ });
353
359
  }
354
360
  };
355
361
 
@@ -372,9 +378,10 @@ export const assertNoActionCollisions = <T>(
372
378
  for (const [name, config] of Object.entries(actions)) {
373
379
  validateActionConfig(scope, name, config);
374
380
  if (scope === "instance" && arrayFields.has(name)) {
375
- throw new Error(
376
- `instanceAction '${name}' collides with array field operations on /:id/${name}`
377
- );
381
+ throw new APIError({
382
+ status: 500,
383
+ title: `instanceAction '${name}' collides with array field operations on /:id/${name}`,
384
+ });
378
385
  }
379
386
  }
380
387
  };
@@ -0,0 +1,133 @@
1
+ import {describe, expect, it} from "bun:test";
2
+ import mongoose from "mongoose";
3
+
4
+ import {enrichModelRouterOptions} from "./adminModelRouter";
5
+ import type {ModelRouterOptions} from "./api";
6
+
7
+ interface Widget {
8
+ secret?: string;
9
+ title: string;
10
+ }
11
+
12
+ const widgetSchema = new mongoose.Schema<Widget>(
13
+ {
14
+ secret: {description: "Hidden", type: String},
15
+ title: {description: "Title", type: String},
16
+ },
17
+ {strict: "throw"}
18
+ );
19
+
20
+ const WidgetModel =
21
+ (mongoose.models.CoverageWidget as mongoose.Model<Widget>) ??
22
+ mongoose.model<Widget>("CoverageWidget", widgetSchema);
23
+
24
+ describe("enrichModelRouterOptions", () => {
25
+ it("returns options unchanged when admin is omitted", () => {
26
+ const options: ModelRouterOptions<Widget> = {
27
+ permissions: {create: [], delete: [], list: [], read: [], update: []},
28
+ };
29
+ const enriched = enrichModelRouterOptions(WidgetModel, options, {});
30
+ expect(enriched).toBe(options);
31
+ });
32
+
33
+ it("merges openApi from context when admin is omitted", () => {
34
+ const options: ModelRouterOptions<Widget> = {
35
+ permissions: {create: [], delete: [], list: [], read: [], update: []},
36
+ };
37
+ const enriched = enrichModelRouterOptions(WidgetModel, options, {
38
+ openApi: {enabled: true} as never,
39
+ });
40
+ expect(enriched.openApi).toEqual({enabled: true});
41
+ });
42
+
43
+ it("scrubs admin fields in preCreate/preUpdate and honors user hooks", async () => {
44
+ const options: ModelRouterOptions<Widget> = {
45
+ admin: {
46
+ displayName: "Widgets",
47
+ excludeFields: ["secret"],
48
+ hiddenFields: [],
49
+ listFields: ["title"],
50
+ },
51
+ permissions: {create: [], delete: [], list: [], read: [], update: []},
52
+ preCreate: async (body) => ({...body, title: `${body.title}-created`}),
53
+ preUpdate: async () => null,
54
+ };
55
+ const enriched = enrichModelRouterOptions(WidgetModel, options, {});
56
+ const created = await enriched.preCreate?.({secret: "x", title: "Hi"}, {} as never);
57
+ expect(created).toEqual({title: "Hi-created"});
58
+ const updated = await enriched.preUpdate?.({secret: "x", title: "Hi"}, {} as never);
59
+ expect(updated).toBeNull();
60
+ });
61
+
62
+ it("returns the user preUpdate body when it is not null", async () => {
63
+ const enriched = enrichModelRouterOptions(
64
+ WidgetModel,
65
+ {
66
+ admin: {
67
+ displayName: "Widgets",
68
+ excludeFields: ["secret"],
69
+ hiddenFields: [],
70
+ listFields: ["title"],
71
+ },
72
+ permissions: {create: [], delete: [], list: [], read: [], update: []},
73
+ preUpdate: async (body) => ({...body, title: "next"}),
74
+ },
75
+ {}
76
+ );
77
+ const patched = await enriched.preUpdate?.({secret: "x", title: "Hi"}, {} as never);
78
+ expect(patched).toEqual({title: "next"});
79
+ });
80
+
81
+ it("emits realtime admin events after create/update/delete", async () => {
82
+ const events: unknown[] = [];
83
+ const terrenoApp = {
84
+ emitAdminModelChanged: (event: unknown) => {
85
+ events.push(event);
86
+ },
87
+ };
88
+ const options: ModelRouterOptions<Widget> = {
89
+ admin: {
90
+ displayName: "Widgets",
91
+ excludeFields: ["secret"],
92
+ hiddenFields: [],
93
+ listFields: ["title"],
94
+ realtime: true,
95
+ },
96
+ permissions: {create: [], delete: [], list: [], read: [], update: []},
97
+ postCreate: async () => {},
98
+ postDelete: async () => {},
99
+ postUpdate: async () => {},
100
+ };
101
+ const enriched = enrichModelRouterOptions(WidgetModel, options, {
102
+ routePath: "/widgets",
103
+ terrenoApp: terrenoApp as never,
104
+ });
105
+ const doc = {_id: "abc", secret: "x", title: "Hi", toObject: () => ({_id: "abc", title: "Hi"})};
106
+ const req = {user: {_id: "user-1"}} as never;
107
+ await enriched.postCreate?.(doc as never, req);
108
+ await enriched.postUpdate?.(doc as never, {}, req, doc as never);
109
+ await enriched.postDelete?.(req, doc as never);
110
+ expect(events).toHaveLength(3);
111
+ expect((events[0] as {type: string}).type).toBe("create");
112
+ expect((events[2] as {type: string; document?: unknown}).type).toBe("delete");
113
+ expect((events[2] as {document?: unknown}).document).toBeUndefined();
114
+ });
115
+
116
+ it("skips realtime emit when the request has no user id", async () => {
117
+ const events: unknown[] = [];
118
+ const options: ModelRouterOptions<Widget> = {
119
+ admin: {
120
+ displayName: "Widgets",
121
+ listFields: ["title"],
122
+ realtime: true,
123
+ },
124
+ permissions: {create: [], delete: [], list: [], read: [], update: []},
125
+ };
126
+ const enriched = enrichModelRouterOptions(WidgetModel, options, {
127
+ routePath: "/widgets",
128
+ terrenoApp: {emitAdminModelChanged: (event: unknown) => events.push(event)} as never,
129
+ });
130
+ await enriched.postCreate?.({_id: "abc", title: "Hi"} as never, {user: {}} as never);
131
+ expect(events).toHaveLength(0);
132
+ });
133
+ });
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;