@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,250 @@
1
+ "use strict";
2
+ var __assign = (this && this.__assign) || function () {
3
+ __assign = Object.assign || function(t) {
4
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
5
+ s = arguments[i];
6
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
7
+ t[p] = s[p];
8
+ }
9
+ return t;
10
+ };
11
+ return __assign.apply(this, arguments);
12
+ };
13
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
14
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
15
+ return new (P || (P = Promise))(function (resolve, reject) {
16
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
17
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
18
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
19
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
20
+ });
21
+ };
22
+ var __generator = (this && this.__generator) || function (thisArg, body) {
23
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
24
+ return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
25
+ function verb(n) { return function (v) { return step([n, v]); }; }
26
+ function step(op) {
27
+ if (f) throw new TypeError("Generator is already executing.");
28
+ while (g && (g = 0, op[0] && (_ = 0)), _) try {
29
+ if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
30
+ if (y = 0, t) op = [op[0] & 2, t.value];
31
+ switch (op[0]) {
32
+ case 0: case 1: t = op; break;
33
+ case 4: _.label++; return { value: op[1], done: false };
34
+ case 5: _.label++; y = op[1]; op = [0]; continue;
35
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
36
+ default:
37
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
38
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
39
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
40
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
41
+ if (t[2]) _.ops.pop();
42
+ _.trys.pop(); continue;
43
+ }
44
+ op = body.call(thisArg, _);
45
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
46
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
47
+ }
48
+ };
49
+ var __values = (this && this.__values) || function(o) {
50
+ var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
51
+ if (m) return m.call(o);
52
+ if (o && typeof o.length === "number") return {
53
+ next: function () {
54
+ if (o && i >= o.length) o = void 0;
55
+ return { value: o && o[i++], done: !o };
56
+ }
57
+ };
58
+ throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
59
+ };
60
+ Object.defineProperty(exports, "__esModule", { value: true });
61
+ exports.NotificationsApp = void 0;
62
+ var luxon_1 = require("luxon");
63
+ var api_1 = require("../api");
64
+ var auth_1 = require("../auth");
65
+ var errors_1 = require("../errors");
66
+ var logger_1 = require("../logger");
67
+ var notification_1 = require("../models/notification");
68
+ var notificationPreference_1 = require("../models/notificationPreference");
69
+ var openApiBuilder_1 = require("../openApiBuilder");
70
+ var permissions_1 = require("../permissions");
71
+ var notificationService_1 = require("./notificationService");
72
+ var PREFERENCE_CHANNELS = ["inapp", "mail", "push", "sms"];
73
+ var parseNotificationDate = function (value, fieldName) {
74
+ if (value === null || value === undefined) {
75
+ return null;
76
+ }
77
+ if (value instanceof Date) {
78
+ return value;
79
+ }
80
+ if (typeof value === "string") {
81
+ var parsed = luxon_1.DateTime.fromISO(value);
82
+ if (!parsed.isValid) {
83
+ throw new errors_1.APIError({ status: 400, title: "".concat(fieldName, " must be a date or null") });
84
+ }
85
+ return parsed.toJSDate();
86
+ }
87
+ throw new errors_1.APIError({ status: 400, title: "".concat(fieldName, " must be a date or null") });
88
+ };
89
+ var sanitizeNotificationUpdate = function (body) {
90
+ var payload = body;
91
+ var update = {};
92
+ if (payload.readAt !== undefined) {
93
+ (0, notificationService_1.assertValidNotificationReadAt)(payload.readAt);
94
+ update.readAt = parseNotificationDate(payload.readAt, "readAt");
95
+ }
96
+ if (payload.archivedAt !== undefined) {
97
+ (0, notificationService_1.assertValidNotificationArchivedAt)(payload.archivedAt);
98
+ update.archivedAt = parseNotificationDate(payload.archivedAt, "archivedAt");
99
+ }
100
+ return update;
101
+ };
102
+ var sanitizePreferenceUpdate = function (body) {
103
+ var e_1, _a;
104
+ var payload = body;
105
+ var update = {};
106
+ try {
107
+ for (var PREFERENCE_CHANNELS_1 = __values(PREFERENCE_CHANNELS), PREFERENCE_CHANNELS_1_1 = PREFERENCE_CHANNELS_1.next(); !PREFERENCE_CHANNELS_1_1.done; PREFERENCE_CHANNELS_1_1 = PREFERENCE_CHANNELS_1.next()) {
108
+ var channel = PREFERENCE_CHANNELS_1_1.value;
109
+ if (channel in payload) {
110
+ update[channel] = payload[channel];
111
+ }
112
+ }
113
+ }
114
+ catch (e_1_1) { e_1 = { error: e_1_1 }; }
115
+ finally {
116
+ try {
117
+ if (PREFERENCE_CHANNELS_1_1 && !PREFERENCE_CHANNELS_1_1.done && (_a = PREFERENCE_CHANNELS_1.return)) _a.call(PREFERENCE_CHANNELS_1);
118
+ }
119
+ finally { if (e_1) throw e_1.error; }
120
+ }
121
+ return update;
122
+ };
123
+ var NotificationsApp = /** @class */ (function () {
124
+ function NotificationsApp(options) {
125
+ if (options === void 0) { options = {}; }
126
+ this.options = options;
127
+ }
128
+ NotificationsApp.prototype.register = function (app, openApi) {
129
+ var e_2, _a;
130
+ var _this = this;
131
+ var _b;
132
+ (0, notificationService_1.configureNotificationService)({
133
+ getComms: this.options.getComms,
134
+ retainDays: this.options.retainDays,
135
+ userModel: this.options.userModel,
136
+ });
137
+ if (this.routers) {
138
+ try {
139
+ for (var _c = __values(this.routers), _d = _c.next(); !_d.done; _d = _c.next()) {
140
+ var router = _d.value;
141
+ app.use(router.path, router.router);
142
+ }
143
+ }
144
+ catch (e_2_1) { e_2 = { error: e_2_1 }; }
145
+ finally {
146
+ try {
147
+ if (_d && !_d.done && (_a = _c.return)) _a.call(_c);
148
+ }
149
+ finally { if (e_2) throw e_2.error; }
150
+ }
151
+ return;
152
+ }
153
+ var openApiMiddleware = openApi;
154
+ var sharedRouterOptions = openApiMiddleware
155
+ ? { openApi: openApiMiddleware }
156
+ : {};
157
+ var notificationsRouter = (0, api_1.modelRouter)("/notifications", notification_1.Notification, __assign(__assign({}, sharedRouterOptions), { endpoints: function (router) {
158
+ router.post("/mark-all-read", [
159
+ (0, auth_1.authenticateMiddleware)(),
160
+ (0, openApiBuilder_1.createOpenApiBuilder)(sharedRouterOptions)
161
+ .withTags(["notifications"])
162
+ .withSummary("Mark all of the caller's unread notifications as read")
163
+ .withResponse(200, {
164
+ data: {
165
+ properties: { modified: { type: "number" } },
166
+ type: "object",
167
+ },
168
+ })
169
+ .build(),
170
+ ], (0, api_1.asyncHandler)(function (req, res) { return __awaiter(_this, void 0, void 0, function () {
171
+ var user, unread, now, modified, unread_1, unread_1_1, row, e_3_1;
172
+ var e_3, _a;
173
+ return __generator(this, function (_b) {
174
+ switch (_b.label) {
175
+ case 0:
176
+ user = req.user;
177
+ if (!(user === null || user === void 0 ? void 0 : user.id)) {
178
+ throw new errors_1.APIError({ status: 401, title: "Authentication required" });
179
+ }
180
+ return [4 /*yield*/, notification_1.Notification.find({
181
+ $or: [{ readAt: null }, { readAt: { $exists: false } }],
182
+ ownerId: user.id,
183
+ })];
184
+ case 1:
185
+ unread = _b.sent();
186
+ now = luxon_1.DateTime.now().toJSDate();
187
+ modified = 0;
188
+ _b.label = 2;
189
+ case 2:
190
+ _b.trys.push([2, 7, 8, 9]);
191
+ unread_1 = __values(unread), unread_1_1 = unread_1.next();
192
+ _b.label = 3;
193
+ case 3:
194
+ if (!!unread_1_1.done) return [3 /*break*/, 6];
195
+ row = unread_1_1.value;
196
+ row.readAt = now;
197
+ return [4 /*yield*/, row.save()];
198
+ case 4:
199
+ _b.sent();
200
+ modified += 1;
201
+ _b.label = 5;
202
+ case 5:
203
+ unread_1_1 = unread_1.next();
204
+ return [3 /*break*/, 3];
205
+ case 6: return [3 /*break*/, 9];
206
+ case 7:
207
+ e_3_1 = _b.sent();
208
+ e_3 = { error: e_3_1 };
209
+ return [3 /*break*/, 9];
210
+ case 8:
211
+ try {
212
+ if (unread_1_1 && !unread_1_1.done && (_a = unread_1.return)) _a.call(unread_1);
213
+ }
214
+ finally { if (e_3) throw e_3.error; }
215
+ return [7 /*endfinally*/];
216
+ case 9:
217
+ logger_1.logger.info("[notifications] mark-all-read", { modified: modified, userId: user.id });
218
+ return [2 /*return*/, res.json({ data: { modified: modified } })];
219
+ }
220
+ });
221
+ }); }));
222
+ }, permissions: {
223
+ create: [],
224
+ delete: [permissions_1.Permissions.IsOwner],
225
+ list: [permissions_1.Permissions.IsAuthenticated],
226
+ read: [permissions_1.Permissions.IsOwner],
227
+ update: [permissions_1.Permissions.IsOwner],
228
+ }, preUpdate: sanitizeNotificationUpdate, queryFields: ["_id", "ownerId", "readAt", "archivedAt", "kind"], queryFilter: permissions_1.OwnerQueryFilter, sort: "-created", sync: { scope: { type: "owner" } } }));
229
+ app.use(notificationsRouter.path, notificationsRouter.router);
230
+ var preferencesRouter = (0, api_1.modelRouter)("/notification-preferences", notificationPreference_1.NotificationPreference, __assign(__assign({}, (openApiMiddleware ? { openApi: openApiMiddleware } : {})), { permissions: {
231
+ create: [permissions_1.Permissions.IsAuthenticated],
232
+ delete: [permissions_1.Permissions.IsOwner],
233
+ list: [permissions_1.Permissions.IsAuthenticated],
234
+ read: [permissions_1.Permissions.IsOwner],
235
+ update: [permissions_1.Permissions.IsOwner],
236
+ }, preCreate: function (body, req) {
237
+ var user = req.user;
238
+ if (!(user === null || user === void 0 ? void 0 : user.id)) {
239
+ throw new errors_1.APIError({ status: 401, title: "Authentication required" });
240
+ }
241
+ var payload = body;
242
+ return __assign(__assign({}, payload), { ownerId: user.id });
243
+ }, preUpdate: sanitizePreferenceUpdate, queryFields: ["ownerId"], queryFilter: permissions_1.OwnerQueryFilter, sort: "-created", sync: { scope: { type: "owner" } } }));
244
+ app.use(preferencesRouter.path, preferencesRouter.router);
245
+ this.routers = [notificationsRouter, preferencesRouter];
246
+ logger_1.logger.info("NotificationsApp registered", { retainDays: (_b = this.options.retainDays) !== null && _b !== void 0 ? _b : 0 });
247
+ };
248
+ return NotificationsApp;
249
+ }());
250
+ exports.NotificationsApp = NotificationsApp;
@@ -0,0 +1,14 @@
1
+ export type NotificationsBeforeSendChannel = "mail" | "push" | "sms" | "verification";
2
+ export interface NotificationsBeforeSendContext {
3
+ channel: NotificationsBeforeSendChannel;
4
+ userId?: string;
5
+ }
6
+ export interface NotificationsBeforeSendResult {
7
+ cancel?: boolean;
8
+ }
9
+ /**
10
+ * Duck-typed CommsApp `beforeSend` hook that cancels outbound delivery when the user
11
+ * disabled that channel in NotificationPreference. Missing preference rows default to
12
+ * all channels on. The `verification` channel is never cancelled here.
13
+ */
14
+ export declare const notificationsBeforeSend: ({ channel, userId, }: NotificationsBeforeSendContext) => Promise<NotificationsBeforeSendResult | undefined>;
@@ -0,0 +1,77 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ var __generator = (this && this.__generator) || function (thisArg, body) {
12
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
13
+ return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
14
+ function verb(n) { return function (v) { return step([n, v]); }; }
15
+ function step(op) {
16
+ if (f) throw new TypeError("Generator is already executing.");
17
+ while (g && (g = 0, op[0] && (_ = 0)), _) try {
18
+ if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
19
+ if (y = 0, t) op = [op[0] & 2, t.value];
20
+ switch (op[0]) {
21
+ case 0: case 1: t = op; break;
22
+ case 4: _.label++; return { value: op[1], done: false };
23
+ case 5: _.label++; y = op[1]; op = [0]; continue;
24
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
25
+ default:
26
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
27
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
28
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
29
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
30
+ if (t[2]) _.ops.pop();
31
+ _.trys.pop(); continue;
32
+ }
33
+ op = body.call(thisArg, _);
34
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
35
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
36
+ }
37
+ };
38
+ Object.defineProperty(exports, "__esModule", { value: true });
39
+ exports.notificationsBeforeSend = void 0;
40
+ var notificationPreference_1 = require("../models/notificationPreference");
41
+ var PREFERENCE_FIELD_BY_CHANNEL = {
42
+ mail: "mail",
43
+ push: "push",
44
+ sms: "sms",
45
+ };
46
+ /**
47
+ * Duck-typed CommsApp `beforeSend` hook that cancels outbound delivery when the user
48
+ * disabled that channel in NotificationPreference. Missing preference rows default to
49
+ * all channels on. The `verification` channel is never cancelled here.
50
+ */
51
+ var notificationsBeforeSend = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
52
+ var preferenceField, preference;
53
+ var channel = _b.channel, userId = _b.userId;
54
+ return __generator(this, function (_c) {
55
+ switch (_c.label) {
56
+ case 0:
57
+ if (channel === "verification" || !userId) {
58
+ return [2 /*return*/, undefined];
59
+ }
60
+ preferenceField = PREFERENCE_FIELD_BY_CHANNEL[channel];
61
+ if (!preferenceField) {
62
+ return [2 /*return*/, undefined];
63
+ }
64
+ return [4 /*yield*/, notificationPreference_1.NotificationPreference.findOneOrNone({ ownerId: userId })];
65
+ case 1:
66
+ preference = _c.sent();
67
+ if (!preference) {
68
+ return [2 /*return*/, undefined];
69
+ }
70
+ if (preference[preferenceField] === false) {
71
+ return [2 /*return*/, { cancel: true }];
72
+ }
73
+ return [2 /*return*/, undefined];
74
+ }
75
+ });
76
+ }); };
77
+ exports.notificationsBeforeSend = notificationsBeforeSend;
package/dist/openApi.d.ts CHANGED
@@ -1,13 +1,6 @@
1
1
  import type express from "express";
2
2
  import type { Model } from "mongoose";
3
3
  import type { ModelRouterOptions } from "./api";
4
- export declare const apiErrorContent: {
5
- "application/json": {
6
- schema: {
7
- $ref: string;
8
- };
9
- };
10
- };
11
4
  export declare const defaultOpenApiErrorResponses: {
12
5
  400: {
13
6
  content: {
@@ -58,4 +51,5 @@ export declare const listOpenApiMiddleware: <T>(model: Model<T>, options: Partia
58
51
  export declare const createOpenApiMiddleware: <T>(model: Model<T>, options: Partial<ModelRouterOptions<T>>) => express.RequestHandler;
59
52
  export declare const patchOpenApiMiddleware: <T>(model: Model<T>, options: Partial<ModelRouterOptions<T>>) => express.RequestHandler;
60
53
  export declare const deleteOpenApiMiddleware: <T>(model: Model<T>, options: Partial<ModelRouterOptions<T>>) => express.RequestHandler;
54
+ /** @internal */
61
55
  export declare const readOpenApiMiddleware: <T>(options: Partial<ModelRouterOptions<T>>, properties: Record<string, unknown>, required: string[], queryParameters: Array<Record<string, unknown>>) => express.RequestHandler;
package/dist/openApi.js CHANGED
@@ -39,7 +39,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
39
39
  return (mod && mod.__esModule) ? mod : { "default": mod };
40
40
  };
41
41
  Object.defineProperty(exports, "__esModule", { value: true });
42
- exports.readOpenApiMiddleware = exports.deleteOpenApiMiddleware = exports.patchOpenApiMiddleware = exports.createOpenApiMiddleware = exports.listOpenApiMiddleware = exports.getOpenApiMiddleware = exports.defaultOpenApiErrorResponses = exports.apiErrorContent = void 0;
42
+ exports.readOpenApiMiddleware = exports.deleteOpenApiMiddleware = exports.patchOpenApiMiddleware = exports.createOpenApiMiddleware = exports.listOpenApiMiddleware = exports.getOpenApiMiddleware = exports.defaultOpenApiErrorResponses = void 0;
43
43
  var flatten_1 = __importDefault(require("lodash/flatten"));
44
44
  var merge_1 = __importDefault(require("lodash/merge"));
45
45
  var mongoose_to_swagger_1 = __importDefault(require("mongoose-to-swagger"));
@@ -49,7 +49,7 @@ var noop = function (_a, _b, next) { return next(); };
49
49
  var m2sOptions = {
50
50
  props: ["readOnly", "required", "enum", "default"],
51
51
  };
52
- exports.apiErrorContent = {
52
+ var apiErrorContent = {
53
53
  "application/json": {
54
54
  schema: { $ref: "#/components/schemas/APIError" },
55
55
  },
@@ -57,22 +57,22 @@ exports.apiErrorContent = {
57
57
  // Default error responses
58
58
  exports.defaultOpenApiErrorResponses = {
59
59
  400: {
60
- content: exports.apiErrorContent,
60
+ content: apiErrorContent,
61
61
  description: "Bad request",
62
62
  },
63
63
  401: {
64
64
  description: "The user must be authenticated",
65
65
  },
66
66
  403: {
67
- content: exports.apiErrorContent,
67
+ content: apiErrorContent,
68
68
  description: "The user is not allowed to perform this action on this document",
69
69
  },
70
70
  404: {
71
- content: exports.apiErrorContent,
71
+ content: apiErrorContent,
72
72
  description: "Document not found",
73
73
  },
74
74
  405: {
75
- content: exports.apiErrorContent,
75
+ content: apiErrorContent,
76
76
  description: "The user is not allowed to perform this action on any document",
77
77
  },
78
78
  };
@@ -429,6 +429,7 @@ var deleteOpenApiMiddleware = function (model, options) {
429
429
  exports.deleteOpenApiMiddleware = deleteOpenApiMiddleware;
430
430
  // This is a generic OpenAPI wrapper for a read that returns any object described by `properties`.
431
431
  // Useful for endpoints that don't directly map to a model.
432
+ /** @internal */
432
433
  var readOpenApiMiddleware = function (options, properties, required, queryParameters) {
433
434
  var _c, _d, _e, _f, _g;
434
435
  if (!((_c = options.openApi) === null || _c === void 0 ? void 0 : _c.path)) {
@@ -67,19 +67,30 @@ import type { ModelRouterOptions } from "./api";
67
67
  */
68
68
  export interface OpenApiSchemaProperty {
69
69
  /** The JSON Schema type (e.g., "string", "number", "boolean", "object", "array") */
70
- type: string;
70
+ type?: string;
71
+ /** JSON Schema oneOf for query operators (scalar or Mongo-style object). */
72
+ oneOf?: OpenApiSchemaProperty[];
71
73
  /** Human-readable description of the property */
72
74
  description?: string;
75
+ /** Allowed values for string/number enums in query validation. */
76
+ enum?: string[];
73
77
  /** Format hint for the type (e.g., "date-time", "email", "uri", "uuid") */
74
78
  format?: string;
75
79
  /** Schema for array items when type is "array" */
76
80
  items?: OpenApiSchemaProperty;
81
+ /** Minimum array length when type is "array". */
82
+ minItems?: number;
77
83
  /** Nested properties when type is "object" */
78
84
  properties?: Record<string, OpenApiSchemaProperty>;
79
85
  /** Schema for additional properties or boolean to allow/disallow them */
80
86
  additionalProperties?: OpenApiSchemaProperty | boolean;
81
- /** Whether this property is required in the parent object */
82
- required?: boolean;
87
+ /**
88
+ * Property-level required flag, or object-schema required key list for nested
89
+ * operator shapes (`{$in: ...}`, `{$regex: ...}`).
90
+ */
91
+ required?: boolean | string[];
92
+ /** When true, string values must be escaped regex literals (query `$regex` operator). */
93
+ escapedRegexLiteral?: boolean;
83
94
  }
84
95
  /**
85
96
  * Defines the top-level schema for request bodies and responses.
@@ -489,13 +500,14 @@ export declare class OpenApiMiddlewareBuilder {
489
500
  * that integrates with the OpenAPI documentation system. If no OpenAPI
490
501
  * path is configured in options, returns a no-op middleware.
491
502
  *
492
- * If validation was enabled via `withValidation()`, returns an array
493
- * of middleware: [openApiDocMiddleware, validationMiddleware].
503
+ * If validation was enabled via `withValidation()`, body and query
504
+ * validators are composed into the same RequestHandler (they still run
505
+ * in order: OpenAPI docs, then body, then query).
494
506
  *
495
507
  * Default error responses (400, 401, 403, 404, 405) are automatically
496
508
  * merged with the configured responses.
497
509
  *
498
- * @returns Express middleware function(s) for OpenAPI documentation and optional validation
510
+ * @returns Express middleware for OpenAPI documentation and optional validation
499
511
  *
500
512
  * @example
501
513
  * ```typescript
@@ -507,7 +519,7 @@ export declare class OpenApiMiddlewareBuilder {
507
519
  * router.get("/users/:id", middleware, getUserHandler);
508
520
  * ```
509
521
  */
510
- build(): any;
522
+ build(): express.RequestHandler;
511
523
  }
512
524
  /**
513
525
  * Creates a new OpenAPI middleware builder.
@@ -10,6 +10,17 @@ var __assign = (this && this.__assign) || function () {
10
10
  };
11
11
  return __assign.apply(this, arguments);
12
12
  };
13
+ var __values = (this && this.__values) || function(o) {
14
+ var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
15
+ if (m) return m.call(o);
16
+ if (o && typeof o.length === "number") return {
17
+ next: function () {
18
+ if (o && i >= o.length) o = void 0;
19
+ return { value: o && o[i++], done: !o };
20
+ }
21
+ };
22
+ throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
23
+ };
13
24
  var __read = (this && this.__read) || function (o, n) {
14
25
  var m = typeof Symbol === "function" && o[Symbol.iterator];
15
26
  if (!m) return o;
@@ -35,6 +46,51 @@ var merge_1 = __importDefault(require("lodash/merge"));
35
46
  var logger_1 = require("./logger");
36
47
  var openApi_1 = require("./openApi");
37
48
  var openApiValidator_1 = require("./openApiValidator");
49
+ var layer_schema_1 = require("./vendor/wesleytodd-openapi/lib/layer-schema");
50
+ /**
51
+ * Run handlers in order as one Express middleware function.
52
+ *
53
+ * `@wesleytodd/openapi` stores path schemas on a Map keyed by the function
54
+ * Express registers. Copying the schema from the documentation handler onto
55
+ * the composed function keeps `/openapi.json` generation working.
56
+ */
57
+ var composeRequestHandlers = function (handlers) {
58
+ var e_1, _c;
59
+ var composed = function (req, res, next) {
60
+ var run = function (index) {
61
+ if (index >= handlers.length) {
62
+ next();
63
+ return;
64
+ }
65
+ handlers[index](req, res, function (error) {
66
+ if (error) {
67
+ next(error);
68
+ return;
69
+ }
70
+ run(index + 1);
71
+ });
72
+ };
73
+ run(0);
74
+ };
75
+ try {
76
+ for (var handlers_1 = __values(handlers), handlers_1_1 = handlers_1.next(); !handlers_1_1.done; handlers_1_1 = handlers_1.next()) {
77
+ var handler = handlers_1_1.value;
78
+ var schema = (0, layer_schema_1.get)(handler);
79
+ if (schema) {
80
+ (0, layer_schema_1.set)(composed, schema);
81
+ break;
82
+ }
83
+ }
84
+ }
85
+ catch (e_1_1) { e_1 = { error: e_1_1 }; }
86
+ finally {
87
+ try {
88
+ if (handlers_1_1 && !handlers_1_1.done && (_c = handlers_1.return)) _c.call(handlers_1);
89
+ }
90
+ finally { if (e_1) throw e_1.error; }
91
+ }
92
+ return composed;
93
+ };
38
94
  /**
39
95
  * A fluent builder for constructing OpenAPI middleware.
40
96
  *
@@ -441,13 +497,14 @@ var OpenApiMiddlewareBuilder = /** @class */ (function () {
441
497
  * that integrates with the OpenAPI documentation system. If no OpenAPI
442
498
  * path is configured in options, returns a no-op middleware.
443
499
  *
444
- * If validation was enabled via `withValidation()`, returns an array
445
- * of middleware: [openApiDocMiddleware, validationMiddleware].
500
+ * If validation was enabled via `withValidation()`, body and query
501
+ * validators are composed into the same RequestHandler (they still run
502
+ * in order: OpenAPI docs, then body, then query).
446
503
  *
447
504
  * Default error responses (400, 401, 403, 404, 405) are automatically
448
505
  * merged with the configured responses.
449
506
  *
450
- * @returns Express middleware function(s) for OpenAPI documentation and optional validation
507
+ * @returns Express middleware for OpenAPI documentation and optional validation
451
508
  *
452
509
  * @example
453
510
  * ```typescript
@@ -459,8 +516,6 @@ var OpenApiMiddlewareBuilder = /** @class */ (function () {
459
516
  * router.get("/users/:id", middleware, getUserHandler);
460
517
  * ```
461
518
  */
462
- // noExplicitAny: returns either a single RequestHandler or an array depending on validation config — callers spread or invoke
463
- // biome-ignore lint/suspicious/noExplicitAny: returns either a single RequestHandler or an array depending on validation config
464
519
  OpenApiMiddlewareBuilder.prototype.build = function () {
465
520
  var _c, _d, _e, _f, _g;
466
521
  var noop = function (_a, _b, next) { return next(); };
@@ -488,12 +543,10 @@ var OpenApiMiddlewareBuilder = /** @class */ (function () {
488
543
  if (this.validationConfig.validateQuery && Object.keys(this.queryParamSchemas).length > 0) {
489
544
  validators.push((0, openApiValidator_1.validateQueryParams)(this.queryParamSchemas, { enabled: true }));
490
545
  }
491
- // If only one middleware (the openApi one), return it directly
492
546
  if (validators.length === 1) {
493
547
  return openApiMiddleware;
494
548
  }
495
- // Return array of middleware to be spread in route definition
496
- return validators;
549
+ return composeRequestHandlers(validators);
497
550
  };
498
551
  return OpenApiMiddlewareBuilder;
499
552
  }());
@@ -202,7 +202,7 @@ var patchExpressRouterUse = function () {
202
202
  return;
203
203
  }
204
204
  var originalUse = useDescriptor.value;
205
- Object.defineProperty(routerPrototype, "use", __assign(__assign({}, useDescriptor), { value: function patchedRouterUse() {
205
+ Object.defineProperty(routerPrototype, "use", __assign(__assign({}, useDescriptor), { value: function () {
206
206
  var _a, _b;
207
207
  var args = [];
208
208
  for (var _i = 0; _i < arguments.length; _i++) {
@@ -6,7 +6,8 @@
6
6
  *
7
7
  * Validation is always installed as middleware but only activates after
8
8
  * `configureOpenApiValidator()` is called. This makes it safe to include
9
- * in modelRouter by default.
9
+ * in modelRouter by default. Create bodies enforce Mongoose required fields;
10
+ * PATCH/update bodies are partial (present fields only).
10
11
  *
11
12
  * @module openApiValidator
12
13
  *
@@ -112,6 +113,8 @@ export declare const getOpenApiValidatorConfig: () => OpenApiValidatorConfig;
112
113
  * Useful for testing.
113
114
  */
114
115
  export declare const resetOpenApiValidatorConfig: () => void;
116
+ /** Accepts literal text and escaped metacharacters (e.g. `\\.`), rejects executable patterns. */
117
+ export declare const isEscapedRegexLiteral: (value: string) => boolean;
115
118
  /**
116
119
  * Options for the request body validator middleware.
117
120
  */
@@ -124,6 +127,11 @@ export interface RequestBodyValidatorOptions {
124
127
  * List of required field names.
125
128
  */
126
129
  required?: string[];
130
+ /**
131
+ * When true, skip schema-level `required` (PATCH / partial update bodies).
132
+ * Present fields are still type-checked.
133
+ */
134
+ partial?: boolean;
127
135
  /**
128
136
  * Fields to exclude from validation (e.g. fields set by preCreate hooks).
129
137
  * Excluded fields are removed from both the schema properties and the required array.
@@ -285,6 +293,10 @@ export declare const createModelValidators: <T>(model: Model<T>, options?: Model
285
293
  create: (req: Request, res: Response, next: NextFunction) => void;
286
294
  update: (req: Request, res: Response, next: NextFunction) => void;
287
295
  };
296
+ /** Query schema for string/enum fields: scalar, `$in`, or escaped `$regex`. */
297
+ export declare const buildStringListQueryFieldSchema: (fieldSchema: OpenApiSchemaProperty) => OpenApiSchemaProperty;
298
+ /** Query schema for number/date fields: scalar or comparison operators. */
299
+ export declare const buildNumericListQueryFieldSchema: (fieldSchema: OpenApiSchemaProperty) => OpenApiSchemaProperty;
288
300
  /**
289
301
  * Build a query parameter schema from a model's Mongoose schema and queryFields array.
290
302
  * Always includes pagination parameters (limit, page, sort).