@terreno/api 57.2.0 → 57.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (472) hide show
  1. package/.ai/skills/mongoose-schema-safety/SKILL.md +23 -10
  2. package/README.md +23 -7
  3. package/dist/actions.js +19 -7
  4. package/dist/adminTypes.d.ts +7 -0
  5. package/dist/adminTypes.js +6 -1
  6. package/dist/api.d.ts +14 -0
  7. package/dist/api.js +111 -60
  8. package/dist/audit/auditApp.d.ts +30 -0
  9. package/dist/audit/auditApp.js +155 -0
  10. package/dist/audit/auditEventModel.d.ts +29 -0
  11. package/dist/audit/auditEventModel.js +102 -0
  12. package/dist/audit/cloudTasksEnqueue.d.ts +32 -0
  13. package/dist/audit/cloudTasksEnqueue.js +162 -0
  14. package/dist/audit/diff.d.ts +10 -0
  15. package/dist/audit/diff.js +230 -0
  16. package/dist/audit/processQueue.d.ts +6 -0
  17. package/dist/audit/processQueue.js +101 -0
  18. package/dist/audit/rbacSink.d.ts +2 -0
  19. package/dist/audit/rbacSink.js +82 -0
  20. package/dist/audit/record.d.ts +56 -0
  21. package/dist/audit/record.js +373 -0
  22. package/dist/auth.d.ts +23 -10
  23. package/dist/auth.js +97 -32
  24. package/dist/authRecovery.d.ts +5 -0
  25. package/dist/authRecovery.js +350 -0
  26. package/dist/authTokens.d.ts +8 -0
  27. package/dist/authTokens.js +162 -0
  28. package/dist/betterAuth.d.ts +39 -0
  29. package/dist/betterAuthApp.d.ts +4 -0
  30. package/dist/betterAuthApp.js +26 -8
  31. package/dist/betterAuthSetup.d.ts +44 -2
  32. package/dist/betterAuthSetup.js +288 -18
  33. package/dist/collectionRegistry.d.ts +40 -0
  34. package/dist/collectionRegistry.js +97 -0
  35. package/dist/configurationApp.d.ts +11 -2
  36. package/dist/configurationApp.js +2 -4
  37. package/dist/docLoader.js +35 -6
  38. package/dist/expressServer.d.ts +26 -3
  39. package/dist/expressServer.js +79 -11
  40. package/dist/index.d.ts +42 -1
  41. package/dist/index.js +84 -2
  42. package/dist/mcp/auth.d.ts +1 -0
  43. package/dist/mcp/auth.js +47 -25
  44. package/dist/mcp/handlers.d.ts +1 -1
  45. package/dist/mcp/handlers.js +67 -233
  46. package/dist/mcp/query.d.ts +2 -15
  47. package/dist/mcp/query.js +8 -8
  48. package/dist/mcp/registry.d.ts +1 -5
  49. package/dist/mcp/registry.js +31 -20
  50. package/dist/mcp/schemaGenerator.d.ts +2 -7
  51. package/dist/mcp/schemaGenerator.js +41 -116
  52. package/dist/mcp/server.d.ts +1 -0
  53. package/dist/mcp/server.js +1 -0
  54. package/dist/mcp/serviceTokens.d.ts +16 -0
  55. package/dist/mcp/serviceTokens.js +345 -0
  56. package/dist/mcp/types.d.ts +2 -2
  57. package/dist/migrations/fixtures/all-down/20260910120000-one.d.ts +4 -0
  58. package/dist/migrations/fixtures/all-down/20260910120000-one.js +49 -0
  59. package/dist/migrations/fixtures/all-down/20260910120001-two.d.ts +4 -0
  60. package/dist/migrations/fixtures/all-down/20260910120001-two.js +49 -0
  61. package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.d.ts +3 -0
  62. package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.js +45 -0
  63. package/dist/migrations/fixtures/bad-name/not-a-migration.d.ts +3 -0
  64. package/dist/migrations/fixtures/bad-name/not-a-migration.js +45 -0
  65. package/dist/migrations/fixtures/missing-up/20260910120000-noup.d.ts +2 -0
  66. package/dist/migrations/fixtures/missing-up/20260910120000-noup.js +5 -0
  67. package/dist/migrations/fixtures/valid/20260910120000-alpha.d.ts +3 -0
  68. package/dist/migrations/fixtures/valid/20260910120000-alpha.js +45 -0
  69. package/dist/migrations/fixtures/valid/20260910120001-beta.d.ts +4 -0
  70. package/dist/migrations/fixtures/valid/20260910120001-beta.js +49 -0
  71. package/dist/migrations/generate.d.ts +17 -0
  72. package/dist/migrations/generate.js +277 -0
  73. package/dist/migrations/load.d.ts +20 -0
  74. package/dist/migrations/load.js +236 -0
  75. package/dist/migrations/lock.d.ts +13 -0
  76. package/dist/migrations/lock.js +145 -0
  77. package/dist/migrations/runner.d.ts +42 -0
  78. package/dist/migrations/runner.js +503 -0
  79. package/dist/migrations/schemaCatalog.d.ts +44 -0
  80. package/dist/migrations/schemaCatalog.js +326 -0
  81. package/dist/migrations/types.d.ts +87 -0
  82. package/dist/migrations/types.js +7 -0
  83. package/dist/models/mcpServiceToken.d.ts +3 -0
  84. package/dist/models/mcpServiceToken.js +208 -0
  85. package/dist/models/notification.d.ts +2 -0
  86. package/dist/models/notification.js +62 -0
  87. package/dist/models/notificationPreference.d.ts +2 -0
  88. package/dist/models/notificationPreference.js +49 -0
  89. package/dist/notifications/notificationService.d.ts +40 -0
  90. package/dist/notifications/notificationService.js +323 -0
  91. package/dist/notifications/notificationsApp.d.ts +18 -0
  92. package/dist/notifications/notificationsApp.js +250 -0
  93. package/dist/notifications/notificationsBeforeSend.d.ts +14 -0
  94. package/dist/notifications/notificationsBeforeSend.js +77 -0
  95. package/dist/openApi.d.ts +1 -7
  96. package/dist/openApi.js +7 -6
  97. package/dist/openApiBuilder.d.ts +19 -7
  98. package/dist/openApiBuilder.js +61 -8
  99. package/dist/openApiCompat.js +1 -1
  100. package/dist/openApiValidator.d.ts +13 -1
  101. package/dist/openApiValidator.js +200 -38
  102. package/dist/orgs/orgContext.d.ts +23 -0
  103. package/dist/orgs/orgContext.js +198 -0
  104. package/dist/orgs/orgPermissions.d.ts +4 -0
  105. package/dist/orgs/orgPermissions.js +77 -0
  106. package/dist/orgs/orgPlugin.d.ts +13 -0
  107. package/dist/orgs/orgPlugin.js +84 -0
  108. package/dist/orgs/organizationModel.d.ts +13 -0
  109. package/dist/orgs/organizationModel.js +301 -0
  110. package/dist/orgs/organizationSettings.d.ts +19 -0
  111. package/dist/orgs/organizationSettings.js +120 -0
  112. package/dist/orgs/orgsApp.d.ts +28 -0
  113. package/dist/orgs/orgsApp.js +678 -0
  114. package/dist/permissions.d.ts +7 -13
  115. package/dist/permissions.js +8 -31
  116. package/dist/plugins.d.ts +14 -1
  117. package/dist/plugins.js +17 -6
  118. package/dist/populate.d.ts +2 -2
  119. package/dist/populate.js +47 -42
  120. package/dist/rateLimit/applyTrustProxy.d.ts +3 -0
  121. package/dist/rateLimit/applyTrustProxy.js +17 -0
  122. package/dist/rateLimit/createStore.d.ts +2 -0
  123. package/dist/rateLimit/createStore.js +28 -0
  124. package/dist/rateLimit/memoryStore.d.ts +2 -0
  125. package/dist/rateLimit/memoryStore.js +108 -0
  126. package/dist/rateLimit/middleware.d.ts +3 -0
  127. package/dist/rateLimit/middleware.js +109 -0
  128. package/dist/rateLimit/mongoStore.d.ts +4 -0
  129. package/dist/rateLimit/mongoStore.js +123 -0
  130. package/dist/rateLimit/policies.d.ts +10 -0
  131. package/dist/rateLimit/policies.js +149 -0
  132. package/dist/rateLimit/redisStore.d.ts +4 -0
  133. package/dist/rateLimit/redisStore.js +156 -0
  134. package/dist/rateLimit/types.d.ts +54 -0
  135. package/dist/rateLimit/types.js +9 -0
  136. package/dist/rbac/access.js +35 -14
  137. package/dist/rbac/assertAllowed.d.ts +9 -0
  138. package/dist/rbac/assertAllowed.js +182 -0
  139. package/dist/rbac/membershipOrgAdminSource.d.ts +6 -0
  140. package/dist/rbac/membershipOrgAdminSource.js +122 -0
  141. package/dist/rbac/modelRouterAccess.d.ts +4 -0
  142. package/dist/rbac/modelRouterAccess.js +11 -4
  143. package/dist/rbac/permissionUtils.js +3 -2
  144. package/dist/rbac/resolve.js +65 -35
  145. package/dist/rbac/roleModel.d.ts +2 -5
  146. package/dist/rbac/roleModel.js +18 -4
  147. package/dist/rbac/routes.js +15 -6
  148. package/dist/rbac/statements.d.ts +10 -1
  149. package/dist/rbac/statements.js +19 -2
  150. package/dist/rbac/types.d.ts +5 -0
  151. package/dist/realtime/changeStreamWatcher.d.ts +10 -4
  152. package/dist/realtime/changeStreamWatcher.js +110 -64
  153. package/dist/realtime/deprecation.d.ts +13 -0
  154. package/dist/realtime/deprecation.js +33 -0
  155. package/dist/realtime/realtimeApp.d.ts +2 -1
  156. package/dist/realtime/realtimeApp.js +11 -11
  157. package/dist/realtime/registry.d.ts +0 -31
  158. package/dist/realtime/registry.js +44 -31
  159. package/dist/realtime/socketAuth.d.ts +5 -5
  160. package/dist/realtime/socketAuth.js +11 -1
  161. package/dist/realtime/socketUser.d.ts +5 -1
  162. package/dist/realtime/types.d.ts +14 -4
  163. package/dist/schemaMetadata.d.ts +56 -0
  164. package/dist/schemaMetadata.js +524 -0
  165. package/dist/seedRunner.d.ts +88 -0
  166. package/dist/seedRunner.js +627 -0
  167. package/dist/sync/adminBroadcastScope.d.ts +40 -0
  168. package/dist/sync/adminBroadcastScope.js +194 -0
  169. package/dist/sync/adminWindowAccess.d.ts +13 -0
  170. package/dist/sync/adminWindowAccess.js +96 -0
  171. package/dist/sync/adminWindowMutation.d.ts +88 -0
  172. package/dist/sync/adminWindowMutation.js +247 -0
  173. package/dist/sync/executors.d.ts +19 -3
  174. package/dist/sync/executors.js +194 -165
  175. package/dist/sync/loadHarness.js +28 -19
  176. package/dist/sync/models.js +26 -24
  177. package/dist/sync/mutationHandler.d.ts +14 -2
  178. package/dist/sync/mutationHandler.js +201 -76
  179. package/dist/sync/registrationSideEffects.d.ts +35 -0
  180. package/dist/sync/registrationSideEffects.js +151 -0
  181. package/dist/sync/registry.d.ts +2 -52
  182. package/dist/sync/registry.js +42 -187
  183. package/dist/sync/routes.d.ts +13 -0
  184. package/dist/sync/routes.js +116 -58
  185. package/dist/sync/scripts/compactTombstones.js +0 -2
  186. package/dist/sync/socketHandlers.d.ts +8 -2
  187. package/dist/sync/socketHandlers.js +144 -50
  188. package/dist/sync/streams.d.ts +2 -0
  189. package/dist/sync/streams.js +7 -1
  190. package/dist/sync/syncApp.d.ts +4 -3
  191. package/dist/sync/syncApp.js +5 -4
  192. package/dist/sync/syncBatch.d.ts +5 -2
  193. package/dist/sync/syncBatch.js +7 -6
  194. package/dist/sync/syncSeqPlugin.d.ts +1 -1
  195. package/dist/sync/syncSeqPlugin.js +20 -16
  196. package/dist/sync/types.d.ts +18 -0
  197. package/dist/terrenoApp.d.ts +48 -5
  198. package/dist/terrenoApp.js +157 -72
  199. package/dist/tests/createTestData.d.ts +1 -3
  200. package/dist/tests/createTestData.js +3 -5
  201. package/dist/tests/models.d.ts +3 -0
  202. package/dist/tests/models.js +15 -2
  203. package/dist/tests/testHelper.d.ts +0 -5
  204. package/dist/tests/testHelper.js +2 -9
  205. package/dist/types/authToken.d.ts +33 -0
  206. package/dist/types/authToken.js +2 -0
  207. package/dist/types/mcpServiceToken.d.ts +41 -0
  208. package/dist/types/mcpServiceToken.js +2 -0
  209. package/dist/types/membership.d.ts +23 -0
  210. package/dist/types/membership.js +2 -0
  211. package/dist/types/notification.d.ts +28 -0
  212. package/dist/types/notification.js +2 -0
  213. package/dist/types/notificationPreference.d.ts +20 -0
  214. package/dist/types/notificationPreference.js +2 -0
  215. package/dist/types/organization.d.ts +36 -0
  216. package/dist/types/organization.js +2 -0
  217. package/dist/webhooks/headerValue.d.ts +2 -0
  218. package/dist/webhooks/headerValue.js +14 -0
  219. package/dist/webhooks/idempotency/memoryStore.d.ts +10 -0
  220. package/dist/webhooks/idempotency/memoryStore.js +65 -0
  221. package/dist/webhooks/idempotency/mongoStore.d.ts +4 -0
  222. package/dist/webhooks/idempotency/mongoStore.js +150 -0
  223. package/dist/webhooks/idempotency/webhookReceipt.d.ts +17 -0
  224. package/dist/webhooks/idempotency/webhookReceipt.js +39 -0
  225. package/dist/webhooks/rawBody.d.ts +15 -0
  226. package/dist/webhooks/rawBody.js +23 -0
  227. package/dist/webhooks/timingSafeEqual.d.ts +4 -0
  228. package/dist/webhooks/timingSafeEqual.js +17 -0
  229. package/dist/webhooks/verifiers/hmac.d.ts +15 -0
  230. package/dist/webhooks/verifiers/hmac.js +49 -0
  231. package/dist/webhooks/verifiers/sendgrid.d.ts +10 -0
  232. package/dist/webhooks/verifiers/sendgrid.js +56 -0
  233. package/dist/webhooks/verifiers/stripe.d.ts +9 -0
  234. package/dist/webhooks/verifiers/stripe.js +99 -0
  235. package/dist/webhooks/verifiers/twilio.d.ts +9 -0
  236. package/dist/webhooks/verifiers/twilio.js +112 -0
  237. package/dist/webhooks/webhooksApp.d.ts +33 -0
  238. package/dist/webhooks/webhooksApp.js +195 -0
  239. package/package.json +32 -27
  240. package/src/__snapshots__/openApi.test.ts.snap +444 -36
  241. package/src/__snapshots__/openApiBuilder.test.ts.snap +24 -24
  242. package/src/__snapshots__/schemaMetadata.test.ts.snap +196 -0
  243. package/src/actions.ts +20 -13
  244. package/src/adminModelRouter.test.ts +133 -0
  245. package/src/adminTypes.ts +8 -0
  246. package/src/api.arrayOperations.test.ts +43 -31
  247. package/src/api.hooks.test.ts +38 -29
  248. package/src/api.query.test.ts +31 -31
  249. package/src/api.test.ts +133 -97
  250. package/src/api.ts +84 -27
  251. package/src/audit/auditApp.test.ts +243 -0
  252. package/src/audit/auditApp.ts +139 -0
  253. package/src/audit/auditEventModel.ts +156 -0
  254. package/src/audit/auditRouter.test.ts +456 -0
  255. package/src/audit/cloudTasksEnqueue.test.ts +124 -0
  256. package/src/audit/cloudTasksEnqueue.ts +104 -0
  257. package/src/audit/diff.ts +163 -0
  258. package/src/audit/processQueue.ts +69 -0
  259. package/src/audit/rbacSink.test.ts +86 -0
  260. package/src/audit/rbacSink.ts +42 -0
  261. package/src/audit/record.test.ts +402 -0
  262. package/src/audit/record.ts +328 -0
  263. package/src/auth.test.ts +108 -52
  264. package/src/auth.ts +98 -29
  265. package/src/authRecovery.test.ts +281 -0
  266. package/src/authRecovery.ts +279 -0
  267. package/src/authTokens.test.ts +94 -0
  268. package/src/authTokens.ts +118 -0
  269. package/src/authVerification.test.ts +293 -0
  270. package/src/betterAuth.ts +31 -0
  271. package/src/betterAuthApp.test.ts +1 -0
  272. package/src/betterAuthApp.ts +27 -9
  273. package/src/betterAuthSetup.test.ts +595 -38
  274. package/src/betterAuthSetup.ts +261 -5
  275. package/src/collectionRegistry.test.ts +164 -0
  276. package/src/collectionRegistry.ts +135 -0
  277. package/src/configurationApp.ts +13 -7
  278. package/src/docLoader.test.ts +45 -1
  279. package/src/docLoader.ts +37 -6
  280. package/src/express.d.ts +3 -0
  281. package/src/expressServer.test.ts +180 -68
  282. package/src/expressServer.ts +75 -19
  283. package/src/githubAuth.test.ts +60 -55
  284. package/src/index.ts +127 -0
  285. package/src/mcp/auth.test.ts +47 -0
  286. package/src/mcp/auth.ts +32 -11
  287. package/src/mcp/handlers.test.ts +275 -0
  288. package/src/mcp/handlers.ts +45 -172
  289. package/src/mcp/integration.test.ts +59 -9
  290. package/src/mcp/query.ts +5 -7
  291. package/src/mcp/registry.ts +29 -20
  292. package/src/mcp/schemaGenerator.test.ts +8 -0
  293. package/src/mcp/schemaGenerator.ts +49 -131
  294. package/src/mcp/server.ts +2 -0
  295. package/src/mcp/serviceTokens.test.ts +330 -0
  296. package/src/mcp/serviceTokens.ts +307 -0
  297. package/src/mcp/toolGenerator.test.ts +82 -1
  298. package/src/mcp/types.ts +2 -6
  299. package/src/migrations/cli.test.ts +376 -0
  300. package/src/migrations/cli.ts +283 -0
  301. package/src/migrations/fixtures/all-down/20260910120000-one.ts +6 -0
  302. package/src/migrations/fixtures/all-down/20260910120001-two.ts +6 -0
  303. package/src/migrations/fixtures/bad-id/20260910120000-mismatch.ts +4 -0
  304. package/src/migrations/fixtures/bad-name/not-a-migration.ts +4 -0
  305. package/src/migrations/fixtures/missing-up/20260910120000-noup.ts +2 -0
  306. package/src/migrations/fixtures/valid/20260910120000-alpha.ts +4 -0
  307. package/src/migrations/fixtures/valid/20260910120001-beta.ts +6 -0
  308. package/src/migrations/generate.test.ts +333 -0
  309. package/src/migrations/generate.ts +216 -0
  310. package/src/migrations/load.test.ts +103 -0
  311. package/src/migrations/load.ts +124 -0
  312. package/src/migrations/lock.test.ts +133 -0
  313. package/src/migrations/lock.ts +118 -0
  314. package/src/migrations/runner.test.ts +504 -0
  315. package/src/migrations/runner.ts +358 -0
  316. package/src/migrations/schemaCatalog.test.ts +159 -0
  317. package/src/migrations/schemaCatalog.ts +262 -0
  318. package/src/migrations/types.ts +94 -0
  319. package/src/models/mcpServiceToken.test.ts +129 -0
  320. package/src/models/mcpServiceToken.ts +158 -0
  321. package/src/models/notification.ts +68 -0
  322. package/src/models/notificationPreference.ts +62 -0
  323. package/src/notifications/notificationService.ts +254 -0
  324. package/src/notifications/notificationsApp.test.ts +505 -0
  325. package/src/notifications/notificationsApp.ts +200 -0
  326. package/src/notifications/notificationsBeforeSend.ts +51 -0
  327. package/src/openApi.test.ts +80 -65
  328. package/src/openApi.ts +2 -1
  329. package/src/openApiBuilder.test.ts +95 -7
  330. package/src/openApiBuilder.ts +60 -12
  331. package/src/openApiCompat.ts +1 -1
  332. package/src/openApiValidator.test.ts +270 -56
  333. package/src/openApiValidator.ts +219 -36
  334. package/src/orgs/orgAccessOptIn.test.ts +87 -0
  335. package/src/orgs/orgContext.test.ts +259 -0
  336. package/src/orgs/orgContext.ts +151 -0
  337. package/src/orgs/orgPermissions.test.ts +105 -0
  338. package/src/orgs/orgPermissions.ts +40 -0
  339. package/src/orgs/orgPlugin.test.ts +130 -0
  340. package/src/orgs/orgPlugin.ts +70 -0
  341. package/src/orgs/orgRbac.test.ts +267 -0
  342. package/src/orgs/orgSecurityDefects.test.ts +415 -0
  343. package/src/orgs/organizationModel.test.ts +205 -0
  344. package/src/orgs/organizationModel.ts +257 -0
  345. package/src/orgs/organizationSettings.test.ts +113 -0
  346. package/src/orgs/organizationSettings.ts +126 -0
  347. package/src/orgs/orgsApp.test.ts +382 -0
  348. package/src/orgs/orgsApp.ts +563 -0
  349. package/src/permissions.test.ts +62 -36
  350. package/src/permissions.ts +8 -30
  351. package/src/plugins.test.ts +14 -0
  352. package/src/plugins.ts +34 -9
  353. package/src/populate.test.ts +34 -0
  354. package/src/populate.ts +40 -29
  355. package/src/rateLimit/applyTrustProxy.ts +17 -0
  356. package/src/rateLimit/createStore.ts +25 -0
  357. package/src/rateLimit/memoryStore.ts +40 -0
  358. package/src/rateLimit/middleware.ts +79 -0
  359. package/src/rateLimit/mongoStore.test.ts +80 -0
  360. package/src/rateLimit/mongoStore.ts +77 -0
  361. package/src/rateLimit/policies.ts +130 -0
  362. package/src/rateLimit/rateLimit.test.ts +328 -0
  363. package/src/rateLimit/redisStore.ioredis.test.ts +29 -0
  364. package/src/rateLimit/redisStore.test.ts +114 -0
  365. package/src/rateLimit/redisStore.ts +86 -0
  366. package/src/rateLimit/types.ts +64 -0
  367. package/src/rbac/access.ts +16 -4
  368. package/src/rbac/assertAllowed.test.ts +325 -0
  369. package/src/rbac/assertAllowed.ts +157 -0
  370. package/src/rbac/backfillAdmins.test.ts +124 -0
  371. package/src/rbac/fieldViews.test.ts +89 -0
  372. package/src/rbac/membershipOrgAdminSource.ts +59 -0
  373. package/src/rbac/modelRouterAccess.test.ts +126 -0
  374. package/src/rbac/modelRouterAccess.ts +8 -2
  375. package/src/rbac/permissionUtils.test.ts +26 -5
  376. package/src/rbac/permissionUtils.ts +3 -2
  377. package/src/rbac/realtimeAccess.test.ts +109 -1
  378. package/src/rbac/resolve.test.ts +34 -2
  379. package/src/rbac/resolve.ts +31 -11
  380. package/src/rbac/roleManager.test.ts +169 -0
  381. package/src/rbac/roleModel.test.ts +34 -1
  382. package/src/rbac/roleModel.ts +17 -1
  383. package/src/rbac/routes.test.ts +233 -0
  384. package/src/rbac/routes.ts +16 -6
  385. package/src/rbac/statements.test.ts +19 -0
  386. package/src/rbac/statements.ts +19 -1
  387. package/src/rbac/types.ts +5 -0
  388. package/src/realtime/changeStreamWatcher.ts +73 -33
  389. package/src/realtime/deprecation.test.ts +60 -0
  390. package/src/realtime/deprecation.ts +33 -0
  391. package/src/realtime/realtime.test.ts +365 -189
  392. package/src/realtime/realtimeApp.ts +11 -11
  393. package/src/realtime/realtimeAppSetup.test.ts +32 -5
  394. package/src/realtime/registry.ts +48 -42
  395. package/src/realtime/sessionRevalidation.test.ts +57 -44
  396. package/src/realtime/socketAuth.test.ts +75 -23
  397. package/src/realtime/socketAuth.ts +17 -6
  398. package/src/realtime/socketUser.ts +5 -3
  399. package/src/realtime/types.ts +14 -4
  400. package/src/schemaMetadata.test.ts +419 -0
  401. package/src/schemaMetadata.ts +593 -0
  402. package/src/scrubAdminFields.test.ts +105 -0
  403. package/src/seedRunner.test.ts +591 -0
  404. package/src/seedRunner.ts +464 -0
  405. package/src/sync/adminBroadcastConfig.test.ts +96 -0
  406. package/src/sync/adminBroadcastScope.test.ts +155 -0
  407. package/src/sync/adminBroadcastScope.ts +123 -0
  408. package/src/sync/adminWindowAccess.test.ts +57 -0
  409. package/src/sync/adminWindowAccess.ts +32 -0
  410. package/src/sync/adminWindowMutation.test.ts +450 -0
  411. package/src/sync/adminWindowMutation.ts +283 -0
  412. package/src/sync/docMatchesMutationData.test.ts +16 -0
  413. package/src/sync/ensureSyncIndexes.test.ts +54 -15
  414. package/src/sync/executors.test.ts +40 -0
  415. package/src/sync/executors.ts +57 -18
  416. package/src/sync/integration.test.ts +15 -7
  417. package/src/sync/loadHarness.ts +28 -19
  418. package/src/sync/models.ts +32 -18
  419. package/src/sync/mutationHandler.test.ts +293 -17
  420. package/src/sync/mutationHandler.ts +180 -36
  421. package/src/sync/registrationSideEffects.test.ts +126 -0
  422. package/src/sync/registrationSideEffects.ts +131 -0
  423. package/src/sync/registry.ts +49 -171
  424. package/src/sync/routes.ts +55 -10
  425. package/src/sync/scripts/compactTombstones.ts +0 -2
  426. package/src/sync/sessionRevalidationIntegration.test.ts +12 -11
  427. package/src/sync/socketHandlers.ts +154 -58
  428. package/src/sync/streams.ts +6 -0
  429. package/src/sync/sync.test.ts +28 -25
  430. package/src/sync/syncApp.ts +5 -4
  431. package/src/sync/syncBatch.ts +10 -4
  432. package/src/sync/syncFrontier.test.ts +17 -15
  433. package/src/sync/syncPhaseC.test.ts +54 -43
  434. package/src/sync/syncRoutes.test.ts +347 -38
  435. package/src/sync/syncSeqPlugin.ts +66 -44
  436. package/src/sync/syncSocket.test.ts +341 -81
  437. package/src/sync/types.ts +20 -0
  438. package/src/terrenoApp.mcpServiceTokens.test.ts +173 -0
  439. package/src/terrenoApp.migrations.test.ts +114 -0
  440. package/src/terrenoApp.test.ts +41 -0
  441. package/src/terrenoApp.ts +181 -46
  442. package/src/tests/createTestData.ts +2 -2
  443. package/src/tests/models.ts +24 -3
  444. package/src/tests/testHelper.ts +1 -7
  445. package/src/types/authToken.ts +41 -0
  446. package/src/types/mcpServiceToken.ts +48 -0
  447. package/src/types/membership.ts +48 -0
  448. package/src/types/notification.ts +34 -0
  449. package/src/types/notificationPreference.ts +28 -0
  450. package/src/types/organization.ts +49 -0
  451. package/src/webhooks/headerValue.test.ts +22 -0
  452. package/src/webhooks/headerValue.ts +12 -0
  453. package/src/webhooks/idempotency/memoryStore.ts +34 -0
  454. package/src/webhooks/idempotency/mongoStore.test.ts +274 -0
  455. package/src/webhooks/idempotency/mongoStore.ts +83 -0
  456. package/src/webhooks/idempotency/webhookReceipt.ts +67 -0
  457. package/src/webhooks/rawBody.test.ts +107 -0
  458. package/src/webhooks/rawBody.ts +24 -0
  459. package/src/webhooks/timingSafeEqual.ts +16 -0
  460. package/src/webhooks/verifiers/hmac.test.ts +110 -0
  461. package/src/webhooks/verifiers/hmac.ts +54 -0
  462. package/src/webhooks/verifiers/providerVerifiers.test.ts +388 -0
  463. package/src/webhooks/verifiers/sendgrid.ts +59 -0
  464. package/src/webhooks/verifiers/stripe.ts +67 -0
  465. package/src/webhooks/verifiers/twilio.ts +69 -0
  466. package/src/webhooks/webhooksApp.test.ts +221 -0
  467. package/src/webhooks/webhooksApp.ts +144 -0
  468. package/tsconfig.json +1 -1
  469. package/tsconfig.typedoc.json +2 -1
  470. package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.d.ts +0 -2
  471. package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
  472. package/src/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
@@ -0,0 +1,593 @@
1
+ import type {Model} from "mongoose";
2
+
3
+ import type {ModelRouterValidationOptions} from "./openApiValidator";
4
+ import type {PopulatePath} from "./populate";
5
+ import type {FieldMask} from "./rbac/types";
6
+
7
+ export const SYSTEM_FIELD_PATHS = new Set(["_id", "id", "__v", "created", "updated", "deleted"]);
8
+
9
+ export type FieldKind =
10
+ | "string"
11
+ | "number"
12
+ | "boolean"
13
+ | "date"
14
+ | "dateOnly"
15
+ | "objectId"
16
+ | "embedded"
17
+ | "mixed"
18
+ | "map";
19
+
20
+ export interface FieldDescription {
21
+ kind: FieldKind;
22
+ required: boolean;
23
+ description?: string;
24
+ enum?: string[];
25
+ ref?: string;
26
+ isArray?: boolean;
27
+ item?: FieldDescription;
28
+ fields?: Record<string, FieldDescription>;
29
+ system?: boolean;
30
+ default?: unknown;
31
+ writableOnCreate?: boolean;
32
+ writableOnUpdate?: boolean;
33
+ }
34
+
35
+ export interface ModelDescription {
36
+ modelName: string;
37
+ fields: Record<string, FieldDescription>;
38
+ }
39
+
40
+ export interface DescribeModelOptions {
41
+ populatePaths?: PopulatePath[];
42
+ extraProperties?: Record<string, FieldDescription>;
43
+ }
44
+
45
+ export interface DescribeModelForRouterOptions extends DescribeModelOptions {
46
+ validation?: boolean | ModelRouterValidationOptions;
47
+ excludeFields?: string[];
48
+ fieldView?: FieldMask;
49
+ }
50
+
51
+ interface MongooseSchemaPath {
52
+ $__schemaType?: MongooseSchemaPath;
53
+ caster?: MongooseSchemaPath;
54
+ enumValues?: string[];
55
+ getEmbeddedSchemaType?: () => MongooseSchemaPath | undefined;
56
+ instance?: string;
57
+ isRequired?: boolean;
58
+ options?: {
59
+ default?: unknown;
60
+ description?: string;
61
+ enum?: string[];
62
+ of?: unknown;
63
+ ref?: string;
64
+ type?: unknown;
65
+ };
66
+ schema?: {
67
+ paths: Record<string, unknown>;
68
+ };
69
+ }
70
+
71
+ const isSystemField = (path: string): boolean => SYSTEM_FIELD_PATHS.has(path);
72
+
73
+ const isMapWildcardPath = (path: string): boolean => path === "$*" || path.endsWith(".$*");
74
+
75
+ const normalizeKind = (instance: string | undefined): FieldKind => {
76
+ switch (instance) {
77
+ case "String":
78
+ return "string";
79
+ case "Number":
80
+ return "number";
81
+ case "Boolean":
82
+ return "boolean";
83
+ case "Date":
84
+ return "date";
85
+ case "DateOnly":
86
+ return "dateOnly";
87
+ case "ObjectId":
88
+ case "ObjectID":
89
+ case "SchemaObjectId":
90
+ return "objectId";
91
+ case "Mixed":
92
+ return "mixed";
93
+ case "Map":
94
+ return "map";
95
+ case "Embedded":
96
+ return "embedded";
97
+ default:
98
+ return "mixed";
99
+ }
100
+ };
101
+
102
+ const getNestedValueSchemaPath = (
103
+ schemaPath: MongooseSchemaPath
104
+ ): MongooseSchemaPath | undefined => {
105
+ if (typeof schemaPath.getEmbeddedSchemaType === "function") {
106
+ const embedded = schemaPath.getEmbeddedSchemaType();
107
+ if (embedded) {
108
+ return embedded;
109
+ }
110
+ }
111
+ return schemaPath.$__schemaType ?? schemaPath.caster;
112
+ };
113
+
114
+ const describeEmbeddedSchema = (
115
+ embeddedSchema: {paths: Record<string, unknown>} | undefined
116
+ ): Record<string, FieldDescription> | undefined => {
117
+ if (!embeddedSchema?.paths) {
118
+ return undefined;
119
+ }
120
+
121
+ const fields: Record<string, FieldDescription> = {};
122
+ for (const [path, rawSchemaPath] of Object.entries(embeddedSchema.paths)) {
123
+ if (isMapWildcardPath(path)) {
124
+ continue;
125
+ }
126
+ fields[path] = describeSchemaPath(path, rawSchemaPath as MongooseSchemaPath);
127
+ }
128
+ return nestDottedFieldDescriptions(fields);
129
+ };
130
+
131
+ const describeCaster = (caster: MongooseSchemaPath): FieldDescription => {
132
+ const kind = normalizeKind(caster.instance);
133
+ const enumValues = caster.enumValues?.length
134
+ ? (caster.enumValues as string[])
135
+ : caster.options?.enum;
136
+
137
+ return {
138
+ description: caster.options?.description,
139
+ enum: enumValues?.length ? enumValues : undefined,
140
+ kind,
141
+ ref: caster.options?.ref,
142
+ required: false,
143
+ };
144
+ };
145
+
146
+ const describeSchemaPath = (path: string, schemaPath: MongooseSchemaPath): FieldDescription => {
147
+ const enumValues = schemaPath.enumValues?.length
148
+ ? (schemaPath.enumValues as string[])
149
+ : schemaPath.options?.enum;
150
+ const base: FieldDescription = {
151
+ default: schemaPath.options?.default,
152
+ description: schemaPath.options?.description,
153
+ enum: enumValues?.length ? enumValues : undefined,
154
+ kind: normalizeKind(schemaPath.instance),
155
+ ref: schemaPath.options?.ref,
156
+ required: Boolean(schemaPath.isRequired),
157
+ system: isSystemField(path),
158
+ };
159
+
160
+ if (schemaPath.instance === "Array") {
161
+ if (schemaPath.schema) {
162
+ const nestedFields = describeEmbeddedSchema(schemaPath.schema);
163
+ return {
164
+ ...base,
165
+ fields: nestedFields,
166
+ isArray: true,
167
+ item: {
168
+ fields: nestedFields,
169
+ kind: "embedded",
170
+ required: false,
171
+ },
172
+ kind: "embedded",
173
+ };
174
+ }
175
+
176
+ const itemSchemaPath = getNestedValueSchemaPath(schemaPath);
177
+ if (itemSchemaPath) {
178
+ const item = describeCaster(itemSchemaPath);
179
+ const {enum: _arrayEnum, ...arrayBase} = base;
180
+ return {
181
+ ...arrayBase,
182
+ isArray: true,
183
+ item,
184
+ kind: item.kind,
185
+ };
186
+ }
187
+
188
+ return {
189
+ ...base,
190
+ isArray: true,
191
+ item: {kind: "mixed", required: false},
192
+ kind: "mixed",
193
+ };
194
+ }
195
+
196
+ if (schemaPath.instance === "Embedded" && schemaPath.schema) {
197
+ const fields = describeEmbeddedSchema(schemaPath.schema);
198
+ return {
199
+ ...base,
200
+ fields,
201
+ kind: "embedded",
202
+ };
203
+ }
204
+
205
+ if (schemaPath.instance === "Map") {
206
+ const valueSchemaPath = getNestedValueSchemaPath(schemaPath);
207
+ return {
208
+ ...base,
209
+ item: valueSchemaPath ? describeCaster(valueSchemaPath) : {kind: "mixed", required: false},
210
+ kind: "map",
211
+ };
212
+ }
213
+
214
+ return base;
215
+ };
216
+
217
+ export const nestDottedFieldDescriptions = (
218
+ fields: Record<string, FieldDescription>
219
+ ): Record<string, FieldDescription> => {
220
+ const root: Record<string, FieldDescription> = {};
221
+
222
+ for (const [path, field] of Object.entries(fields)) {
223
+ if (!path.includes(".")) {
224
+ root[path] = field;
225
+ continue;
226
+ }
227
+
228
+ const parts = path.split(".");
229
+ let current = root;
230
+ for (let index = 0; index < parts.length - 1; index++) {
231
+ const part = parts[index];
232
+ if (!current[part]) {
233
+ current[part] = {
234
+ fields: {},
235
+ kind: "embedded",
236
+ required: false,
237
+ };
238
+ }
239
+ if (!current[part].fields) {
240
+ current[part].fields = {};
241
+ }
242
+ current = current[part].fields as Record<string, FieldDescription>;
243
+ }
244
+
245
+ current[parts[parts.length - 1]] = field;
246
+ }
247
+
248
+ return root;
249
+ };
250
+
251
+ const isWritePathAllowed = (path: string, write: string[] | "*"): boolean => {
252
+ if (write === "*") {
253
+ return true;
254
+ }
255
+ return write.some((allowed) => path === allowed || path.startsWith(`${allowed}.`));
256
+ };
257
+
258
+ const applyWriteMasks = (
259
+ fields: Record<string, FieldDescription>,
260
+ options: DescribeModelForRouterOptions
261
+ ): Record<string, FieldDescription> => {
262
+ const validation =
263
+ typeof options.validation === "object" && options.validation !== null
264
+ ? options.validation
265
+ : undefined;
266
+ const excludeFromCreate = new Set(validation?.excludeFromCreate ?? []);
267
+ const excludeFromUpdate = new Set(validation?.excludeFromUpdate ?? []);
268
+ const excludeFields = new Set(options.excludeFields ?? []);
269
+ const fieldView = options.fieldView;
270
+
271
+ const withMasks = (path: string, field: FieldDescription): FieldDescription => {
272
+ const writableOnCreate =
273
+ !field.system &&
274
+ !excludeFields.has(path) &&
275
+ !excludeFromCreate.has(path) &&
276
+ (!fieldView || isWritePathAllowed(path, fieldView.write));
277
+ const writableOnUpdate =
278
+ !field.system &&
279
+ !excludeFields.has(path) &&
280
+ !excludeFromUpdate.has(path) &&
281
+ (!fieldView || isWritePathAllowed(path, fieldView.write));
282
+
283
+ const next: FieldDescription = {
284
+ ...field,
285
+ writableOnCreate,
286
+ writableOnUpdate,
287
+ };
288
+
289
+ if (field.fields) {
290
+ next.fields = Object.fromEntries(
291
+ Object.entries(field.fields).map(([nestedPath, nestedField]) => [
292
+ nestedPath,
293
+ withMasks(`${path}.${nestedPath}`, nestedField),
294
+ ])
295
+ );
296
+ }
297
+
298
+ if (field.item?.fields) {
299
+ next.item = {
300
+ ...field.item,
301
+ fields: Object.fromEntries(
302
+ Object.entries(field.item.fields).map(([nestedPath, nestedField]) => [
303
+ nestedPath,
304
+ withMasks(`${path}.${nestedPath}`, nestedField),
305
+ ])
306
+ ),
307
+ };
308
+ }
309
+
310
+ return next;
311
+ };
312
+
313
+ return Object.fromEntries(
314
+ Object.entries(fields).map(([path, field]) => [path, withMasks(path, field)])
315
+ );
316
+ };
317
+
318
+ export const describeModel = <T>(
319
+ model: Model<T>,
320
+ options: DescribeModelOptions = {}
321
+ ): ModelDescription => {
322
+ const fields: Record<string, FieldDescription> = {};
323
+
324
+ for (const [path, rawSchemaPath] of Object.entries(model.schema.paths)) {
325
+ if (isMapWildcardPath(path)) {
326
+ continue;
327
+ }
328
+ fields[path] = describeSchemaPath(path, rawSchemaPath as unknown as MongooseSchemaPath);
329
+ }
330
+
331
+ if (options.extraProperties) {
332
+ for (const [path, field] of Object.entries(options.extraProperties)) {
333
+ fields[path] = field;
334
+ }
335
+ }
336
+
337
+ return {
338
+ fields,
339
+ modelName: model.modelName,
340
+ };
341
+ };
342
+
343
+ export const describeModelForRouter = <T>(
344
+ model: Model<T>,
345
+ options: DescribeModelForRouterOptions = {}
346
+ ): ModelDescription => {
347
+ const description = describeModel(model, options);
348
+ return {
349
+ ...description,
350
+ fields: applyWriteMasks(description.fields, options),
351
+ };
352
+ };
353
+
354
+ export const fieldDescriptionToOpenApiProperty = (
355
+ field: FieldDescription
356
+ ): Record<string, unknown> => {
357
+ if (field.isArray) {
358
+ const items = field.item
359
+ ? fieldDescriptionToOpenApiProperty({...field.item, isArray: false})
360
+ : {type: "string"};
361
+ const property: Record<string, unknown> = {
362
+ description: field.description,
363
+ items,
364
+ type: "array",
365
+ };
366
+ return property;
367
+ }
368
+
369
+ if (field.kind === "embedded" && field.fields) {
370
+ const nested = modelDescriptionToOpenApiSpec({fields: field.fields, modelName: ""});
371
+ const property: Record<string, unknown> = {
372
+ properties: nested.properties,
373
+ type: "object",
374
+ };
375
+ if (field.description) {
376
+ property.description = field.description;
377
+ }
378
+ if (nested.required.length > 0) {
379
+ property.required = nested.required;
380
+ }
381
+ return property;
382
+ }
383
+
384
+ if (field.kind === "mixed") {
385
+ return {description: field.description};
386
+ }
387
+
388
+ if (field.kind === "map") {
389
+ const property: Record<string, unknown> = {
390
+ additionalProperties: field.item
391
+ ? fieldDescriptionToOpenApiProperty({...field.item, isArray: false})
392
+ : {type: "string"},
393
+ type: "object",
394
+ };
395
+ if (field.description) {
396
+ property.description = field.description;
397
+ }
398
+ return property;
399
+ }
400
+
401
+ if (field.kind === "dateOnly") {
402
+ return {
403
+ description: field.description,
404
+ type: "dateonly",
405
+ };
406
+ }
407
+
408
+ const openApiType =
409
+ field.kind === "objectId" ? "string" : field.kind === "date" ? "string" : field.kind;
410
+ const property: Record<string, unknown> = {
411
+ type: openApiType,
412
+ };
413
+ if (field.description) {
414
+ property.description = field.description;
415
+ }
416
+ if (field.enum) {
417
+ property.enum = field.enum;
418
+ }
419
+ if (field.kind === "objectId" && !field.system) {
420
+ property.format = "objectid";
421
+ }
422
+ if (field.kind === "date") {
423
+ property.format = "date-time";
424
+ }
425
+ return property;
426
+ };
427
+
428
+ export const modelDescriptionToOpenApiSpec = (
429
+ description: ModelDescription
430
+ ): {properties: Record<string, unknown>; required: string[]} => {
431
+ const nestedFields = nestDottedFieldDescriptions(description.fields);
432
+ const properties: Record<string, unknown> = {};
433
+ const required: string[] = [];
434
+
435
+ for (const [path, field] of Object.entries(nestedFields)) {
436
+ // mongoose-to-swagger omits __v from OpenAPI components; keep parity for HTTP bodies.
437
+ if (path === "__v") {
438
+ continue;
439
+ }
440
+ properties[path] = fieldDescriptionToOpenApiProperty(field);
441
+ if (field.required) {
442
+ required.push(path);
443
+ }
444
+ }
445
+
446
+ return {properties, required};
447
+ };
448
+
449
+ export const fieldDescriptionToAdminMeta = (
450
+ field: FieldDescription
451
+ ): {
452
+ default?: unknown;
453
+ description?: string;
454
+ enum?: string[];
455
+ itemEnum?: string[];
456
+ itemRef?: string;
457
+ itemType?: string;
458
+ items?: Record<string, ReturnType<typeof fieldDescriptionToAdminMeta>>;
459
+ ref?: string;
460
+ required: boolean;
461
+ searchable?: boolean;
462
+ type: string;
463
+ } => {
464
+ const adminType = field.isArray
465
+ ? "array"
466
+ : field.kind === "objectId"
467
+ ? "objectid"
468
+ : field.kind === "embedded"
469
+ ? "object"
470
+ : field.kind === "mixed"
471
+ ? "mixed"
472
+ : field.kind === "map"
473
+ ? "object"
474
+ : field.kind === "dateOnly"
475
+ ? "dateonly"
476
+ : field.kind;
477
+
478
+ const meta: ReturnType<typeof fieldDescriptionToAdminMeta> = {
479
+ default: field.default,
480
+ description: field.description,
481
+ enum: field.enum,
482
+ ref: field.ref,
483
+ required: field.required,
484
+ searchable: adminType === "string" && !field.enum,
485
+ type: adminType,
486
+ };
487
+
488
+ if (field.isArray && field.item) {
489
+ if (field.item.ref) {
490
+ meta.ref = field.item.ref;
491
+ }
492
+ if (field.item.fields) {
493
+ meta.items = Object.fromEntries(
494
+ Object.entries(field.item.fields).map(([key, nestedField]) => [
495
+ key,
496
+ fieldDescriptionToAdminMeta(nestedField),
497
+ ])
498
+ );
499
+ } else {
500
+ meta.itemType =
501
+ field.item.kind === "objectId"
502
+ ? "objectid"
503
+ : field.item.kind === "embedded"
504
+ ? "object"
505
+ : field.item.kind;
506
+ meta.itemEnum = field.item.enum;
507
+ meta.itemRef = field.item.ref;
508
+ }
509
+ }
510
+
511
+ if (field.kind === "embedded" && field.fields && !field.isArray) {
512
+ meta.items = Object.fromEntries(
513
+ Object.entries(field.fields).map(([key, nestedField]) => [
514
+ key,
515
+ fieldDescriptionToAdminMeta(nestedField),
516
+ ])
517
+ );
518
+ }
519
+
520
+ return meta;
521
+ };
522
+
523
+ export const modelDescriptionToAdminFields = (
524
+ description: ModelDescription
525
+ ): Record<string, ReturnType<typeof fieldDescriptionToAdminMeta>> => {
526
+ const nestedFields = nestDottedFieldDescriptions(description.fields);
527
+ return Object.fromEntries(
528
+ Object.entries(nestedFields).map(([path, field]) => [path, fieldDescriptionToAdminMeta(field)])
529
+ );
530
+ };
531
+
532
+ export const fieldDescriptionToZodType = (
533
+ field: FieldDescription,
534
+ z: typeof import("zod").z
535
+ ): import("zod").ZodType => {
536
+ let zodType: import("zod").ZodType;
537
+
538
+ if (field.isArray) {
539
+ const itemType = field.item
540
+ ? fieldDescriptionToZodType({...field.item, isArray: false}, z)
541
+ : z.any();
542
+ zodType = z.array(itemType);
543
+ if (field.item?.kind === "embedded") {
544
+ zodType = zodType.describe("Array of subdocuments");
545
+ }
546
+ if (field.description) {
547
+ zodType = zodType.describe(field.description);
548
+ }
549
+ return zodType;
550
+ }
551
+
552
+ if (field.kind === "embedded" && field.fields) {
553
+ zodType = z.record(z.string(), z.any()).describe("Embedded document");
554
+ if (field.description) {
555
+ zodType = zodType.describe(field.description);
556
+ }
557
+ return zodType;
558
+ }
559
+
560
+ switch (field.kind) {
561
+ case "string":
562
+ zodType =
563
+ field.enum && field.enum.length > 0
564
+ ? z.enum(field.enum as [string, ...string[]])
565
+ : z.string();
566
+ break;
567
+ case "number":
568
+ zodType = z.number();
569
+ break;
570
+ case "boolean":
571
+ zodType = z.boolean();
572
+ break;
573
+ case "date":
574
+ case "dateOnly":
575
+ zodType = z.string().describe("ISO 8601 date string");
576
+ break;
577
+ case "objectId":
578
+ zodType = z.string().describe(field.ref ? `ObjectId reference to ${field.ref}` : "ObjectId");
579
+ break;
580
+ case "map":
581
+ zodType = z.record(z.string(), z.any());
582
+ break;
583
+ default:
584
+ zodType = z.record(z.string(), z.any());
585
+ break;
586
+ }
587
+
588
+ if (field.description) {
589
+ zodType = zodType.describe(field.description);
590
+ }
591
+
592
+ return zodType;
593
+ };
@@ -92,6 +92,74 @@ describe("scrubAdminFields", () => {
92
92
 
93
93
  expect(result.ownerId.hash).toBe("keep");
94
94
  });
95
+
96
+ it("returns null and undefined unchanged", () => {
97
+ expect(scrubAdminFields(null, {admin: todoAdmin})).toBeNull();
98
+ expect(scrubAdminFields(undefined, {admin: todoAdmin})).toBeUndefined();
99
+ });
100
+
101
+ it("returns primitives unchanged", () => {
102
+ expect(scrubAdminFields("Buy milk", {admin: todoAdmin})).toBe("Buy milk");
103
+ expect(scrubAdminFields(7, {admin: todoAdmin})).toBe(7);
104
+ expect(scrubAdminFields(false, {admin: todoAdmin})).toBe(false);
105
+ });
106
+
107
+ it("keeps null and undefined field values", () => {
108
+ const result = scrubAdminFields(
109
+ {completed: null, secret: "x", title: undefined},
110
+ {admin: todoAdmin}
111
+ );
112
+ expect(result).toEqual({completed: null, title: undefined});
113
+ });
114
+
115
+ it("converts mongoose documents with toObject before scrubbing", () => {
116
+ const doc = new Todo({title: "Task"});
117
+ const result = scrubAdminFields(doc, {admin: todoAdmin}) as Record<string, unknown>;
118
+
119
+ expect(result.title).toBe("Task");
120
+ expect(result._id).toBeDefined();
121
+ });
122
+
123
+ it("scrubs each element of an array field", () => {
124
+ const result = scrubAdminFields(
125
+ {items: [{secret: "s", title: "a"}, "plain", 3], title: "Parent"},
126
+ {admin: todoAdmin}
127
+ ) as {items: unknown[]; title: string};
128
+
129
+ expect(result.title).toBe("Parent");
130
+ expect(result.items).toEqual([{title: "a"}, "plain", 3]);
131
+ });
132
+
133
+ it("leaves populated docs on paths without a ref unchanged", () => {
134
+ const admin: AdminConfig = {
135
+ displayName: "Todos",
136
+ listFields: ["title"],
137
+ };
138
+ const result = scrubAdminFields(
139
+ {title: {_id: "507f1f77bcf86cd799439011", hash: "keep"}},
140
+ {admin, allModelAdmins: {ScrubUser: userAdmin}, schema: Todo.schema}
141
+ ) as {title: Record<string, unknown>};
142
+
143
+ expect(result.title.hash).toBe("keep");
144
+ });
145
+
146
+ it("leaves populated docs unchanged when no schema is provided", () => {
147
+ const result = scrubAdminFields(
148
+ {ownerId: {_id: "507f1f77bcf86cd799439011", hash: "keep"}},
149
+ {admin: todoAdmin, allModelAdmins: {ScrubUser: userAdmin}}
150
+ ) as {ownerId: Record<string, unknown>};
151
+
152
+ expect(result.ownerId.hash).toBe("keep");
153
+ });
154
+
155
+ it("leaves unpopulated ref ids unchanged", () => {
156
+ const result = scrubAdminFields(
157
+ {ownerId: {_id: "507f1f77bcf86cd799439011"}, title: "Task"},
158
+ {admin: todoAdmin, allModelAdmins: {ScrubUser: userAdmin}, schema: Todo.schema}
159
+ ) as {ownerId: Record<string, unknown>};
160
+
161
+ expect(result.ownerId).toEqual({_id: "507f1f77bcf86cd799439011"});
162
+ });
95
163
  });
96
164
 
97
165
  describe("stripAdminBodyFields", () => {
@@ -110,4 +178,41 @@ describe("stripAdminBodyFields", () => {
110
178
  );
111
179
  expect(result).toEqual({title: "x"});
112
180
  });
181
+
182
+ it("strips keys from every object in an array body and leaves non-objects alone", () => {
183
+ const result = stripAdminBodyFields(
184
+ [
185
+ {slug: "fixed", title: "a"},
186
+ {internal: "n", title: "b"},
187
+ ] as Record<string, unknown>[],
188
+ admin
189
+ );
190
+ expect(result).toEqual([{title: "a"}, {title: "b"}]);
191
+ });
192
+
193
+ it("returns array entries that are not objects unchanged", () => {
194
+ const body = [null, {role: "admin", title: "a"}] as unknown as Record<string, unknown>[];
195
+ expect(stripAdminBodyFields(body, admin)).toEqual([null, {title: "a"}] as unknown as Record<
196
+ string,
197
+ unknown
198
+ >[]);
199
+ });
200
+
201
+ it("returns null and undefined bodies unchanged", () => {
202
+ expect(stripAdminBodyFields(null, admin)).toBeNull();
203
+ expect(stripAdminBodyFields(undefined, admin)).toBeUndefined();
204
+ });
205
+
206
+ it("returns non-object bodies unchanged", () => {
207
+ const body = "not-an-object" as unknown as Record<string, unknown>;
208
+ expect(stripAdminBodyFields(body, admin)).toBe(body);
209
+ });
210
+
211
+ it("keeps an admin config without any strip lists intact", () => {
212
+ const bareAdmin: AdminConfig = {displayName: "Todos", listFields: ["title"]};
213
+ expect(stripAdminBodyFields({slug: "fixed", title: "x"}, bareAdmin)).toEqual({
214
+ slug: "fixed",
215
+ title: "x",
216
+ });
217
+ });
113
218
  });