@terreno/api 57.3.0 → 57.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (412) hide show
  1. package/.ai/skills/mongoose-schema-safety/SKILL.md +23 -10
  2. package/README.md +11 -5
  3. package/bunfig.toml +1 -1
  4. package/dist/actions.js +197 -368
  5. package/dist/adminModelRouter.js +88 -173
  6. package/dist/adminTypes.d.ts +7 -0
  7. package/dist/adminTypes.js +6 -1
  8. package/dist/api.d.ts +10 -0
  9. package/dist/api.js +601 -792
  10. package/dist/audit/auditApp.d.ts +30 -0
  11. package/dist/audit/auditApp.js +114 -0
  12. package/dist/audit/auditEventModel.d.ts +29 -0
  13. package/dist/audit/auditEventModel.js +101 -0
  14. package/dist/audit/cloudTasksEnqueue.d.ts +32 -0
  15. package/dist/audit/cloudTasksEnqueue.js +69 -0
  16. package/dist/audit/diff.d.ts +10 -0
  17. package/dist/audit/diff.js +140 -0
  18. package/dist/audit/processQueue.d.ts +6 -0
  19. package/dist/audit/processQueue.js +56 -0
  20. package/dist/audit/rbacSink.d.ts +2 -0
  21. package/dist/audit/rbacSink.js +41 -0
  22. package/dist/audit/record.d.ts +56 -0
  23. package/dist/audit/record.js +251 -0
  24. package/dist/auth.js +432 -681
  25. package/dist/authRecovery.js +155 -269
  26. package/dist/authTokens.js +43 -118
  27. package/dist/betterAuth.d.ts +6 -0
  28. package/dist/betterAuthApp.js +25 -26
  29. package/dist/betterAuthSetup.js +258 -413
  30. package/dist/browserLogsRoute.d.ts +6 -0
  31. package/dist/browserLogsRoute.js +97 -0
  32. package/dist/collectionRegistry.d.ts +3 -1
  33. package/dist/collectionRegistry.js +43 -33
  34. package/dist/config.js +53 -122
  35. package/dist/configurationApp.js +180 -361
  36. package/dist/configurationPlugin.js +130 -302
  37. package/dist/consentApp.js +276 -421
  38. package/dist/docLoader.js +78 -126
  39. package/dist/envConfigurationPlugin.js +25 -147
  40. package/dist/errors.js +151 -247
  41. package/dist/example.js +28 -34
  42. package/dist/expressServer.d.ts +10 -0
  43. package/dist/expressServer.js +109 -255
  44. package/dist/frameworkModelNames.d.ts +24 -0
  45. package/dist/frameworkModelNames.js +31 -0
  46. package/dist/githubAuth.js +152 -216
  47. package/dist/httpClient.js +176 -264
  48. package/dist/index.d.ts +28 -1
  49. package/dist/index.js +53 -2
  50. package/dist/logger.js +145 -278
  51. package/dist/mcp/auth.js +76 -128
  52. package/dist/mcp/createMCPRequest.js +4 -5
  53. package/dist/mcp/handlers.js +268 -480
  54. package/dist/mcp/query.d.ts +0 -13
  55. package/dist/mcp/query.js +57 -151
  56. package/dist/mcp/registry.js +17 -30
  57. package/dist/mcp/schemaGenerator.js +95 -181
  58. package/dist/mcp/server.js +28 -100
  59. package/dist/mcp/serviceTokens.js +102 -191
  60. package/dist/mcp/toolGenerator.js +78 -191
  61. package/dist/middleware.js +15 -27
  62. package/dist/migrations/fixtures/all-down/20260910120000-one.d.ts +4 -0
  63. package/dist/migrations/fixtures/all-down/20260910120000-one.js +9 -0
  64. package/dist/migrations/fixtures/all-down/20260910120001-two.d.ts +4 -0
  65. package/dist/migrations/fixtures/all-down/20260910120001-two.js +9 -0
  66. package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.d.ts +3 -0
  67. package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.js +7 -0
  68. package/dist/migrations/fixtures/bad-name/not-a-migration.d.ts +3 -0
  69. package/dist/migrations/fixtures/bad-name/not-a-migration.js +7 -0
  70. package/dist/migrations/fixtures/missing-up/20260910120000-noup.d.ts +2 -0
  71. package/dist/migrations/fixtures/missing-up/20260910120000-noup.js +5 -0
  72. package/dist/migrations/fixtures/valid/20260910120000-alpha.d.ts +3 -0
  73. package/dist/migrations/fixtures/valid/20260910120000-alpha.js +7 -0
  74. package/dist/migrations/fixtures/valid/20260910120001-beta.d.ts +4 -0
  75. package/dist/migrations/fixtures/valid/20260910120001-beta.js +9 -0
  76. package/dist/migrations/generate.d.ts +17 -0
  77. package/dist/migrations/generate.js +155 -0
  78. package/dist/migrations/load.d.ts +20 -0
  79. package/dist/migrations/load.js +110 -0
  80. package/dist/migrations/lock.d.ts +13 -0
  81. package/dist/migrations/lock.js +73 -0
  82. package/dist/migrations/runner.d.ts +42 -0
  83. package/dist/migrations/runner.js +249 -0
  84. package/dist/migrations/schemaCatalog.d.ts +44 -0
  85. package/dist/migrations/schemaCatalog.js +185 -0
  86. package/dist/migrations/types.d.ts +87 -0
  87. package/dist/migrations/types.js +7 -0
  88. package/dist/models/consentForm.js +6 -6
  89. package/dist/models/consentResponse.js +5 -5
  90. package/dist/models/mcpServiceToken.js +66 -156
  91. package/dist/models/notification.d.ts +2 -0
  92. package/dist/models/notification.js +62 -0
  93. package/dist/models/notificationPreference.d.ts +2 -0
  94. package/dist/models/notificationPreference.js +49 -0
  95. package/dist/models/versionConfig.js +5 -5
  96. package/dist/notifications/notificationService.d.ts +40 -0
  97. package/dist/notifications/notificationService.js +183 -0
  98. package/dist/notifications/notificationsApp.d.ts +18 -0
  99. package/dist/notifications/notificationsApp.js +156 -0
  100. package/dist/notifications/notificationsBeforeSend.d.ts +14 -0
  101. package/dist/notifications/notificationsBeforeSend.js +32 -0
  102. package/dist/notifiers/googleChatNotifier.js +36 -117
  103. package/dist/notifiers/slackNotifier.d.ts +31 -2
  104. package/dist/notifiers/slackNotifier.js +170 -119
  105. package/dist/notifiers/zoomNotifier.js +60 -111
  106. package/dist/openApi.d.ts +1 -7
  107. package/dist/openApi.js +113 -127
  108. package/dist/openApiBuilder.d.ts +14 -3
  109. package/dist/openApiBuilder.js +117 -159
  110. package/dist/openApiCompat.js +81 -148
  111. package/dist/openApiEtag.js +7 -7
  112. package/dist/openApiValidator.d.ts +13 -1
  113. package/dist/openApiValidator.js +301 -246
  114. package/dist/orgs/orgContext.d.ts +23 -0
  115. package/dist/orgs/orgContext.js +128 -0
  116. package/dist/orgs/orgPermissions.d.ts +4 -0
  117. package/dist/orgs/orgPermissions.js +38 -0
  118. package/dist/orgs/orgPlugin.d.ts +13 -0
  119. package/dist/orgs/orgPlugin.js +66 -0
  120. package/dist/orgs/organizationModel.d.ts +13 -0
  121. package/dist/orgs/organizationModel.js +200 -0
  122. package/dist/orgs/organizationSettings.d.ts +19 -0
  123. package/dist/orgs/organizationSettings.js +113 -0
  124. package/dist/orgs/orgsApp.d.ts +28 -0
  125. package/dist/orgs/orgsApp.js +416 -0
  126. package/dist/permissions.d.ts +7 -13
  127. package/dist/permissions.js +95 -211
  128. package/dist/plugins.js +125 -218
  129. package/dist/populate.js +130 -240
  130. package/dist/rateLimit/applyTrustProxy.js +1 -1
  131. package/dist/rateLimit/createStore.js +7 -8
  132. package/dist/rateLimit/memoryStore.js +22 -100
  133. package/dist/rateLimit/middleware.d.ts +0 -8
  134. package/dist/rateLimit/middleware.js +49 -101
  135. package/dist/rateLimit/mongoStore.d.ts +1 -0
  136. package/dist/rateLimit/mongoStore.js +55 -112
  137. package/dist/rateLimit/policies.d.ts +0 -4
  138. package/dist/rateLimit/policies.js +44 -80
  139. package/dist/rateLimit/redisStore.d.ts +1 -0
  140. package/dist/rateLimit/redisStore.js +40 -133
  141. package/dist/rbac/access.js +122 -253
  142. package/dist/rbac/assertAllowed.js +95 -171
  143. package/dist/rbac/auditModel.js +14 -58
  144. package/dist/rbac/backfillAdmins.js +24 -130
  145. package/dist/rbac/fieldViews.js +46 -141
  146. package/dist/rbac/membershipOrgAdminSource.d.ts +6 -0
  147. package/dist/rbac/membershipOrgAdminSource.js +51 -0
  148. package/dist/rbac/middleware.js +30 -96
  149. package/dist/rbac/modelRouterAccess.d.ts +3 -0
  150. package/dist/rbac/modelRouterAccess.js +133 -307
  151. package/dist/rbac/permissionUtils.js +40 -179
  152. package/dist/rbac/realtimeAccess.js +81 -147
  153. package/dist/rbac/resolve.d.ts +1 -1
  154. package/dist/rbac/resolve.js +154 -319
  155. package/dist/rbac/roleManager.js +318 -700
  156. package/dist/rbac/roleModel.d.ts +2 -5
  157. package/dist/rbac/roleModel.js +60 -173
  158. package/dist/rbac/routes.js +93 -196
  159. package/dist/rbac/scopes.js +39 -133
  160. package/dist/rbac/statements.d.ts +10 -1
  161. package/dist/rbac/statements.js +42 -93
  162. package/dist/rbac/types.d.ts +5 -0
  163. package/dist/rbac/userPlugin.js +3 -29
  164. package/dist/realtime/changeStreamWatcher.d.ts +10 -4
  165. package/dist/realtime/changeStreamWatcher.js +499 -764
  166. package/dist/realtime/deprecation.d.ts +1 -0
  167. package/dist/realtime/deprecation.js +9 -10
  168. package/dist/realtime/queryMatcher.js +110 -191
  169. package/dist/realtime/queryStore.js +35 -118
  170. package/dist/realtime/realtimeApp.d.ts +1 -0
  171. package/dist/realtime/realtimeApp.js +248 -401
  172. package/dist/realtime/registry.js +19 -30
  173. package/dist/realtime/sessionRevalidation.js +132 -358
  174. package/dist/realtime/socketAuth.js +89 -208
  175. package/dist/realtime/socketUser.js +10 -56
  176. package/dist/requestContext.js +93 -139
  177. package/dist/schemaMetadata.js +181 -265
  178. package/dist/scriptRunner.js +96 -266
  179. package/dist/scrubAdminFields.js +36 -108
  180. package/dist/secretProviders.js +130 -299
  181. package/dist/seedRunner.js +221 -514
  182. package/dist/sync/adminBroadcastScope.d.ts +40 -0
  183. package/dist/sync/adminBroadcastScope.js +82 -0
  184. package/dist/sync/adminWindowAccess.d.ts +13 -0
  185. package/dist/sync/adminWindowAccess.js +25 -0
  186. package/dist/sync/adminWindowMutation.d.ts +88 -0
  187. package/dist/sync/adminWindowMutation.js +176 -0
  188. package/dist/sync/executors.d.ts +9 -3
  189. package/dist/sync/executors.js +425 -598
  190. package/dist/sync/loadHarness.js +392 -689
  191. package/dist/sync/models.js +181 -341
  192. package/dist/sync/mutationHandler.d.ts +5 -2
  193. package/dist/sync/mutationHandler.js +549 -697
  194. package/dist/sync/registrationSideEffects.js +41 -95
  195. package/dist/sync/registry.js +31 -47
  196. package/dist/sync/routes.d.ts +13 -0
  197. package/dist/sync/routes.js +484 -760
  198. package/dist/sync/scripts/compactTombstones.js +83 -228
  199. package/dist/sync/serialize.js +18 -58
  200. package/dist/sync/socketHandlers.d.ts +8 -2
  201. package/dist/sync/socketHandlers.js +271 -402
  202. package/dist/sync/streams.d.ts +2 -0
  203. package/dist/sync/streams.js +54 -116
  204. package/dist/sync/syncApp.d.ts +2 -1
  205. package/dist/sync/syncApp.js +14 -16
  206. package/dist/sync/syncBatch.d.ts +5 -2
  207. package/dist/sync/syncBatch.js +63 -168
  208. package/dist/sync/syncSeqPlugin.js +430 -702
  209. package/dist/sync/types.d.ts +18 -0
  210. package/dist/syncConsents.js +113 -253
  211. package/dist/terrenoApp.d.ts +29 -0
  212. package/dist/terrenoApp.js +184 -257
  213. package/dist/tests/createTestData.d.ts +1 -3
  214. package/dist/tests/createTestData.js +147 -259
  215. package/dist/tests/models.d.ts +1 -0
  216. package/dist/tests/models.js +23 -56
  217. package/dist/tests/mongoTestSetup.js +42 -103
  218. package/dist/tests/testHelper.d.ts +0 -5
  219. package/dist/tests/testHelper.js +32 -101
  220. package/dist/tests.js +12 -51
  221. package/dist/transformers.js +61 -164
  222. package/dist/types/authToken.d.ts +3 -3
  223. package/dist/types/mcpServiceToken.d.ts +2 -2
  224. package/dist/types/membership.d.ts +23 -0
  225. package/dist/types/membership.js +2 -0
  226. package/dist/types/notification.d.ts +28 -0
  227. package/dist/types/notification.js +2 -0
  228. package/dist/types/notificationPreference.d.ts +20 -0
  229. package/dist/types/notificationPreference.js +2 -0
  230. package/dist/types/organization.d.ts +36 -0
  231. package/dist/types/organization.js +2 -0
  232. package/dist/utils.js +31 -93
  233. package/dist/vendor/wesleytodd-openapi/index.js +37 -51
  234. package/dist/vendor/wesleytodd-openapi/lib/generate-doc.js +32 -40
  235. package/dist/vendor/wesleytodd-openapi/lib/layer-schema.js +3 -3
  236. package/dist/vendor/wesleytodd-openapi/lib/ui.js +50 -19
  237. package/dist/vendor/wesleytodd-openapi/lib/validate.js +19 -47
  238. package/dist/versionCheckPlugin.js +52 -100
  239. package/dist/webhooks/headerValue.js +2 -2
  240. package/dist/webhooks/idempotency/memoryStore.js +16 -59
  241. package/dist/webhooks/idempotency/mongoStore.js +55 -130
  242. package/dist/webhooks/idempotency/webhookReceipt.d.ts +4 -49
  243. package/dist/webhooks/idempotency/webhookReceipt.js +14 -14
  244. package/dist/webhooks/rawBody.d.ts +1 -0
  245. package/dist/webhooks/rawBody.js +2 -1
  246. package/dist/webhooks/timingSafeEqual.js +4 -5
  247. package/dist/webhooks/verifiers/hmac.js +17 -18
  248. package/dist/webhooks/verifiers/sendgrid.js +20 -22
  249. package/dist/webhooks/verifiers/stripe.js +31 -65
  250. package/dist/webhooks/verifiers/twilio.js +23 -73
  251. package/dist/webhooks/webhooksApp.js +78 -177
  252. package/dist/zodOpenApi.js +2 -2
  253. package/package.json +34 -28
  254. package/src/__snapshots__/openApi.test.ts.snap +192 -54
  255. package/src/__snapshots__/openApiBuilder.test.ts.snap +0 -18
  256. package/src/__snapshots__/schemaMetadata.test.ts.snap +0 -1
  257. package/src/__tests__/browserLogsRoute.test.ts +165 -0
  258. package/src/adminTypes.ts +8 -0
  259. package/src/api.test.ts +39 -2
  260. package/src/api.ts +68 -0
  261. package/src/audit/auditApp.test.ts +243 -0
  262. package/src/audit/auditApp.ts +139 -0
  263. package/src/audit/auditEventModel.ts +160 -0
  264. package/src/audit/auditRouter.test.ts +456 -0
  265. package/src/audit/cloudTasksEnqueue.test.ts +124 -0
  266. package/src/audit/cloudTasksEnqueue.ts +104 -0
  267. package/src/audit/diff.ts +163 -0
  268. package/src/audit/processQueue.ts +69 -0
  269. package/src/audit/rbacSink.test.ts +86 -0
  270. package/src/audit/rbacSink.ts +42 -0
  271. package/src/audit/record.test.ts +402 -0
  272. package/src/audit/record.ts +329 -0
  273. package/src/auth.test.ts +1 -1
  274. package/src/auth.ts +1 -1
  275. package/src/authRecovery.test.ts +43 -0
  276. package/src/authRecovery.ts +16 -10
  277. package/src/authTokens.ts +6 -2
  278. package/src/authVerification.test.ts +22 -0
  279. package/src/betterAuth.ts +7 -0
  280. package/src/betterAuthSetup.test.ts +27 -0
  281. package/src/betterAuthSetup.ts +1 -0
  282. package/src/browserLogsRoute.ts +110 -0
  283. package/src/collectionRegistry.test.ts +8 -9
  284. package/src/collectionRegistry.ts +21 -1
  285. package/src/configurationPlugin.test.ts +1 -11
  286. package/src/express.d.ts +2 -0
  287. package/src/expressServer.test.ts +50 -2
  288. package/src/expressServer.ts +10 -0
  289. package/src/frameworkModelNames.test.ts +62 -0
  290. package/src/frameworkModelNames.ts +33 -0
  291. package/src/index.ts +76 -0
  292. package/src/isolated/migrateCliConnect.isolated.ts +51 -0
  293. package/src/mcp/auth.test.ts +34 -1
  294. package/src/mcp/handlers.test.ts +275 -0
  295. package/src/mcp/query.ts +3 -3
  296. package/src/mcp/toolGenerator.test.ts +81 -0
  297. package/src/migrations/cli.test.ts +353 -0
  298. package/src/migrations/cli.ts +283 -0
  299. package/src/migrations/fixtures/all-down/20260910120000-one.ts +6 -0
  300. package/src/migrations/fixtures/all-down/20260910120001-two.ts +6 -0
  301. package/src/migrations/fixtures/bad-id/20260910120000-mismatch.ts +4 -0
  302. package/src/migrations/fixtures/bad-name/not-a-migration.ts +4 -0
  303. package/src/migrations/fixtures/missing-up/20260910120000-noup.ts +2 -0
  304. package/src/migrations/fixtures/valid/20260910120000-alpha.ts +4 -0
  305. package/src/migrations/fixtures/valid/20260910120001-beta.ts +6 -0
  306. package/src/migrations/generate.test.ts +333 -0
  307. package/src/migrations/generate.ts +216 -0
  308. package/src/migrations/load.test.ts +103 -0
  309. package/src/migrations/load.ts +124 -0
  310. package/src/migrations/lock.test.ts +133 -0
  311. package/src/migrations/lock.ts +118 -0
  312. package/src/migrations/runner.test.ts +504 -0
  313. package/src/migrations/runner.ts +358 -0
  314. package/src/migrations/schemaCatalog.test.ts +159 -0
  315. package/src/migrations/schemaCatalog.ts +262 -0
  316. package/src/migrations/types.ts +94 -0
  317. package/src/models/mcpServiceToken.ts +4 -3
  318. package/src/models/notification.ts +69 -0
  319. package/src/models/notificationPreference.ts +62 -0
  320. package/src/notifications/notificationService.ts +254 -0
  321. package/src/notifications/notificationsApp.test.ts +528 -0
  322. package/src/notifications/notificationsApp.ts +200 -0
  323. package/src/notifications/notificationsBeforeSend.ts +51 -0
  324. package/src/notifiers/slackNotifier.test.ts +186 -1
  325. package/src/notifiers/slackNotifier.ts +167 -8
  326. package/src/openApi.test.ts +0 -1
  327. package/src/openApi.ts +2 -1
  328. package/src/openApiBuilder.ts +14 -3
  329. package/src/openApiValidator.test.ts +221 -2
  330. package/src/openApiValidator.ts +218 -33
  331. package/src/orgs/orgAccessOptIn.test.ts +87 -0
  332. package/src/orgs/orgContext.test.ts +259 -0
  333. package/src/orgs/orgContext.ts +151 -0
  334. package/src/orgs/orgPermissions.test.ts +105 -0
  335. package/src/orgs/orgPermissions.ts +40 -0
  336. package/src/orgs/orgPlugin.test.ts +130 -0
  337. package/src/orgs/orgPlugin.ts +70 -0
  338. package/src/orgs/orgRbac.test.ts +267 -0
  339. package/src/orgs/orgSecurityDefects.test.ts +415 -0
  340. package/src/orgs/organizationModel.test.ts +205 -0
  341. package/src/orgs/organizationModel.ts +262 -0
  342. package/src/orgs/organizationSettings.test.ts +113 -0
  343. package/src/orgs/organizationSettings.ts +126 -0
  344. package/src/orgs/orgsApp.test.ts +382 -0
  345. package/src/orgs/orgsApp.ts +563 -0
  346. package/src/permissions.test.ts +62 -36
  347. package/src/permissions.ts +8 -30
  348. package/src/plugins.test.ts +5 -0
  349. package/src/plugins.ts +3 -0
  350. package/src/rateLimit/middleware.ts +1 -1
  351. package/src/rateLimit/mongoStore.ts +1 -0
  352. package/src/rateLimit/policies.ts +2 -2
  353. package/src/rateLimit/redisStore.ts +1 -0
  354. package/src/rbac/access.ts +11 -3
  355. package/src/rbac/membershipOrgAdminSource.ts +59 -0
  356. package/src/rbac/modelRouterAccess.ts +3 -0
  357. package/src/rbac/permissionUtils.test.ts +26 -5
  358. package/src/rbac/resolve.test.ts +34 -2
  359. package/src/rbac/resolve.ts +26 -7
  360. package/src/rbac/roleModel.test.ts +34 -1
  361. package/src/rbac/roleModel.ts +17 -1
  362. package/src/rbac/statements.test.ts +19 -0
  363. package/src/rbac/statements.ts +19 -1
  364. package/src/rbac/types.ts +5 -0
  365. package/src/realtime/changeStreamWatcher.ts +73 -33
  366. package/src/realtime/deprecation.ts +1 -0
  367. package/src/realtime/realtime.test.ts +357 -185
  368. package/src/realtime/realtimeApp.ts +2 -1
  369. package/src/schemaMetadata.test.ts +14 -0
  370. package/src/schemaMetadata.ts +5 -5
  371. package/src/sync/adminBroadcastConfig.test.ts +96 -0
  372. package/src/sync/adminBroadcastScope.test.ts +155 -0
  373. package/src/sync/adminBroadcastScope.ts +123 -0
  374. package/src/sync/adminWindowAccess.test.ts +57 -0
  375. package/src/sync/adminWindowAccess.ts +32 -0
  376. package/src/sync/adminWindowMutation.test.ts +450 -0
  377. package/src/sync/adminWindowMutation.ts +283 -0
  378. package/src/sync/executors.ts +33 -6
  379. package/src/sync/integration.test.ts +2 -2
  380. package/src/sync/mutationHandler.test.ts +277 -1
  381. package/src/sync/mutationHandler.ts +171 -29
  382. package/src/sync/registry.ts +4 -0
  383. package/src/sync/routes.ts +52 -8
  384. package/src/sync/socketHandlers.ts +154 -58
  385. package/src/sync/streams.ts +6 -0
  386. package/src/sync/sync.test.ts +3 -2
  387. package/src/sync/syncApp.ts +2 -1
  388. package/src/sync/syncBatch.ts +7 -2
  389. package/src/sync/syncRoutes.test.ts +297 -3
  390. package/src/sync/syncSocket.test.ts +229 -0
  391. package/src/sync/types.ts +20 -0
  392. package/src/terrenoApp.migrations.test.ts +114 -0
  393. package/src/terrenoApp.test.ts +41 -0
  394. package/src/terrenoApp.ts +97 -31
  395. package/src/tests/createTestData.ts +2 -2
  396. package/src/tests/models.ts +10 -2
  397. package/src/tests/testHelper.ts +1 -7
  398. package/src/types/authToken.ts +2 -4
  399. package/src/types/mcpServiceToken.ts +1 -7
  400. package/src/types/membership.ts +48 -0
  401. package/src/types/notification.ts +34 -0
  402. package/src/types/notificationPreference.ts +28 -0
  403. package/src/types/organization.ts +49 -0
  404. package/src/types.d.ts +1 -0
  405. package/src/webhooks/idempotency/webhookReceipt.ts +8 -10
  406. package/src/webhooks/rawBody.test.ts +33 -0
  407. package/src/webhooks/rawBody.ts +1 -0
  408. package/tsconfig.json +13 -54
  409. package/tsconfig.typedoc.json +4 -1
  410. package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.d.ts +0 -2
  411. package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
  412. package/src/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
@@ -1,51 +1,4 @@
1
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 __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
- };
24
- var __read = (this && this.__read) || function (o, n) {
25
- var m = typeof Symbol === "function" && o[Symbol.iterator];
26
- if (!m) return o;
27
- var i = m.call(o), r, ar = [], e;
28
- try {
29
- while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
30
- }
31
- catch (error) { e = { error: error }; }
32
- finally {
33
- try {
34
- if (r && !r.done && (m = i["return"])) m.call(i);
35
- }
36
- finally { if (e) throw e.error; }
37
- }
38
- return ar;
39
- };
40
- var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
41
- if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
42
- if (ar || !(i in from)) {
43
- if (!ar) ar = Array.prototype.slice.call(from, 0, i);
44
- ar[i] = from[i];
45
- }
46
- }
47
- return to.concat(ar || Array.prototype.slice.call(from));
48
- };
49
2
  var __importDefault = (this && this.__importDefault) || function (mod) {
50
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
51
4
  };
@@ -61,18 +14,18 @@ exports.openApiCompatMiddleware = exports.patchAppUse = exports.patchExpressRout
61
14
  *
62
15
  * @see https://github.com/wesleytodd/express-openapi/issues/70
63
16
  */
64
- var express_1 = __importDefault(require("express"));
65
- var MOUNT_PATH_KEY = "__openApiMountPath";
66
- var isExpressRouterUsePatched = false;
17
+ const express_1 = __importDefault(require("express"));
18
+ const MOUNT_PATH_KEY = "__openApiMountPath";
19
+ let isExpressRouterUsePatched = false;
67
20
  /**
68
21
  * Extract Express 4-style keys from a path string.
69
22
  * Parses `:paramName` and `*paramName` segments into `{name, optional}` objects
70
23
  * that @wesleytodd/openapi expects.
71
24
  */
72
- var extractKeysFromPath = function (path) {
73
- var keys = [];
74
- var paramRegex = /[:*](\w+)\??/g;
75
- var match;
25
+ const extractKeysFromPath = (path) => {
26
+ const keys = [];
27
+ const paramRegex = /[:*](\w+)\??/g;
28
+ let match;
76
29
  // biome-ignore lint/suspicious/noAssignInExpressions: standard regex exec loop
77
30
  while ((match = paramRegex.exec(path)) !== null) {
78
31
  keys.push({ name: match[1], optional: match[0].endsWith("?") });
@@ -89,92 +42,80 @@ var extractKeysFromPath = function (path) {
89
42
  * Express 4-style capture group `(?:([^\/]+?))` so that `processComplexMatch()`
90
43
  * in the openapi library can map them to `{paramName}` using `layer.keys`.
91
44
  */
92
- var buildRegexpForPath = function (pathStr, isMount) {
45
+ const buildRegexpForPath = (pathStr, isMount) => {
93
46
  // Replace :param segments with Express 4-style capture groups, then escape the rest
94
- var parts = pathStr.split("/").map(function (segment) {
47
+ const parts = pathStr.split("/").map((segment) => {
95
48
  if (segment.startsWith(":")) {
96
49
  return "(?:([^\\/]+?))";
97
50
  }
98
51
  return segment.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
99
52
  });
100
- var pattern = parts.join("\\/");
53
+ const pattern = parts.join("\\/");
101
54
  if (isMount) {
102
- return new RegExp("^".concat(pattern, "\\/?(?=\\/|$)"));
55
+ return new RegExp(`^${pattern}\\/?(?=\\/|$)`);
103
56
  }
104
- return new RegExp("^".concat(pattern, "\\/?$"));
57
+ return new RegExp(`^${pattern}\\/?$`);
105
58
  };
106
- var annotateMountLayers = function (stack, stackBefore, args) {
59
+ const annotateMountLayers = (stack, stackBefore, args) => {
107
60
  if (!stack) {
108
61
  return;
109
62
  }
110
- var mountPath = typeof args[0] === "string" ? args[0] : undefined;
63
+ const mountPath = typeof args[0] === "string" ? args[0] : undefined;
111
64
  if (!mountPath || mountPath === "/") {
112
65
  return;
113
66
  }
114
- var normalizedMountPath = mountPath.replace(/\/+$/, "");
115
- for (var i = stackBefore; i < stack.length; i++) {
67
+ const normalizedMountPath = mountPath.replace(/\/+$/, "");
68
+ for (let i = stackBefore; i < stack.length; i++) {
116
69
  stack[i][MOUNT_PATH_KEY] = normalizedMountPath;
117
70
  }
118
71
  };
119
- var patchRouterStack = function (stack) {
120
- var e_1, _a;
121
- var _b, _c, _d, _e;
122
- try {
123
- for (var stack_1 = __values(stack), stack_1_1 = stack_1.next(); !stack_1_1.done; stack_1_1 = stack_1.next()) {
124
- var layer = stack_1_1.value;
125
- if (layer.regexp === undefined) {
126
- // Determine the path string for this layer
127
- var pathStr = void 0;
128
- var isMount = layer.name === "router" || !!((_b = layer.handle) === null || _b === void 0 ? void 0 : _b.stack);
129
- if (layer.slash) {
130
- // Express 5 layers use .slash instead of .regexp.fast_slash
131
- layer.regexp = { fast_slash: true };
132
- }
133
- else if (layer[MOUNT_PATH_KEY]) {
134
- pathStr = layer[MOUNT_PATH_KEY];
135
- layer.regexp = buildRegexpForPath(pathStr, isMount);
136
- }
137
- else if (layer.path && typeof layer.path === "string") {
138
- pathStr = layer.path;
139
- layer.regexp = buildRegexpForPath(pathStr, false);
140
- }
141
- else if (((_c = layer.route) === null || _c === void 0 ? void 0 : _c.path) && typeof layer.route.path === "string") {
142
- pathStr = layer.route.path;
143
- layer.regexp = buildRegexpForPath(pathStr, false);
72
+ const patchRouterStack = (stack) => {
73
+ for (const layer of stack) {
74
+ if (layer.regexp === undefined) {
75
+ // Determine the path string for this layer
76
+ let pathStr;
77
+ const isMount = layer.name === "router" || !!layer.handle?.stack;
78
+ if (layer.slash) {
79
+ // Express 5 layers use .slash instead of .regexp.fast_slash
80
+ layer.regexp = { fast_slash: true };
81
+ }
82
+ else if (layer[MOUNT_PATH_KEY]) {
83
+ pathStr = layer[MOUNT_PATH_KEY];
84
+ layer.regexp = buildRegexpForPath(pathStr, isMount);
85
+ }
86
+ else if (layer.path && typeof layer.path === "string") {
87
+ pathStr = layer.path;
88
+ layer.regexp = buildRegexpForPath(pathStr, false);
89
+ }
90
+ else if (layer.route?.path && typeof layer.route.path === "string") {
91
+ pathStr = layer.route.path;
92
+ layer.regexp = buildRegexpForPath(pathStr, false);
93
+ }
94
+ else {
95
+ layer.regexp = /^\/?$/;
96
+ }
97
+ // Populate keys in Express 4 format: [{name, optional}]
98
+ // @wesleytodd/openapi reads layer.keys[i].name for path parameters
99
+ if (!layer.keys || (Array.isArray(layer.keys) && layer.keys.length === 0)) {
100
+ if (pathStr) {
101
+ layer.keys = extractKeysFromPath(pathStr);
144
102
  }
145
103
  else {
146
- layer.regexp = /^\/?$/;
147
- }
148
- // Populate keys in Express 4 format: [{name, optional}]
149
- // @wesleytodd/openapi reads layer.keys[i].name for path parameters
150
- if (!layer.keys || (Array.isArray(layer.keys) && layer.keys.length === 0)) {
151
- if (pathStr) {
152
- layer.keys = extractKeysFromPath(pathStr);
153
- }
154
- else {
155
- layer.keys = [];
156
- }
104
+ layer.keys = [];
157
105
  }
158
- else if (Array.isArray(layer.keys) && typeof layer.keys[0] === "string") {
159
- // Express 5 stores keys as plain strings after match() — convert to objects
160
- layer.keys = layer.keys.map(function (k) { return ({ name: k, optional: false }); });
161
- }
162
- }
163
- // Recursively patch nested stacks even when this layer already had a regexp.
164
- if ((_d = layer.handle) === null || _d === void 0 ? void 0 : _d.stack) {
165
- patchRouterStack(layer.handle.stack);
166
106
  }
167
- if ((_e = layer.route) === null || _e === void 0 ? void 0 : _e.stack) {
168
- patchRouterStack(layer.route.stack);
107
+ else if (Array.isArray(layer.keys) && typeof layer.keys[0] === "string") {
108
+ // Express 5 stores keys as plain strings after match() — convert to objects
109
+ layer.keys = layer.keys.map((k) => ({ name: k, optional: false }));
169
110
  }
170
111
  }
171
- }
172
- catch (e_1_1) { e_1 = { error: e_1_1 }; }
173
- finally {
174
- try {
175
- if (stack_1_1 && !stack_1_1.done && (_a = stack_1.return)) _a.call(stack_1);
112
+ // Recursively patch nested stacks even when this layer already had a regexp.
113
+ if (layer.handle?.stack) {
114
+ patchRouterStack(layer.handle.stack);
115
+ }
116
+ if (layer.route?.stack) {
117
+ patchRouterStack(layer.route.stack);
176
118
  }
177
- finally { if (e_1) throw e_1.error; }
178
119
  }
179
120
  };
180
121
  /**
@@ -185,34 +126,32 @@ var patchRouterStack = function (stack) {
185
126
  * Express 5's Router puts `use` a few prototypes up from the instance, so we walk
186
127
  * the chain until we find the own `use` descriptor.
187
128
  */
188
- var patchExpressRouterUse = function () {
129
+ const patchExpressRouterUse = () => {
189
130
  if (isExpressRouterUsePatched) {
190
131
  return;
191
132
  }
192
133
  isExpressRouterUsePatched = true;
193
- var routerPrototype = Object.getPrototypeOf(express_1.default.Router());
134
+ let routerPrototype = Object.getPrototypeOf(express_1.default.Router());
194
135
  while (routerPrototype && !Object.getOwnPropertyDescriptor(routerPrototype, "use")) {
195
136
  routerPrototype = Object.getPrototypeOf(routerPrototype);
196
137
  }
197
138
  if (!routerPrototype) {
198
139
  return;
199
140
  }
200
- var useDescriptor = Object.getOwnPropertyDescriptor(routerPrototype, "use");
201
- if (!(useDescriptor === null || useDescriptor === void 0 ? void 0 : useDescriptor.value)) {
141
+ const useDescriptor = Object.getOwnPropertyDescriptor(routerPrototype, "use");
142
+ if (!useDescriptor?.value) {
202
143
  return;
203
144
  }
204
- var originalUse = useDescriptor.value;
205
- Object.defineProperty(routerPrototype, "use", __assign(__assign({}, useDescriptor), { value: function () {
206
- var _a, _b;
207
- var args = [];
208
- for (var _i = 0; _i < arguments.length; _i++) {
209
- args[_i] = arguments[_i];
210
- }
211
- var stackBefore = (_b = (_a = this.stack) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0;
212
- var result = originalUse.apply(this, args);
145
+ const originalUse = useDescriptor.value;
146
+ Object.defineProperty(routerPrototype, "use", {
147
+ ...useDescriptor,
148
+ value(...args) {
149
+ const stackBefore = this.stack?.length ?? 0;
150
+ const result = originalUse.apply(this, args);
213
151
  annotateMountLayers(this.stack, stackBefore, args);
214
152
  return result;
215
- } }));
153
+ },
154
+ });
216
155
  };
217
156
  exports.patchExpressRouterUse = patchExpressRouterUse;
218
157
  /**
@@ -222,23 +161,18 @@ exports.patchExpressRouterUse = patchExpressRouterUse;
222
161
  *
223
162
  * Must be called before any routes are registered.
224
163
  */
225
- var patchAppUse = function (app) {
164
+ const patchAppUse = (app) => {
226
165
  (0, exports.patchExpressRouterUse)();
227
- var internal = app;
228
- var originalUse = app.use.bind(app);
229
- var patchedUse = function () {
230
- var _a, _b, _c, _d;
231
- var args = [];
232
- for (var _i = 0; _i < arguments.length; _i++) {
233
- args[_i] = arguments[_i];
234
- }
166
+ const internal = app;
167
+ const originalUse = app.use.bind(app);
168
+ const patchedUse = (...args) => {
235
169
  // Track stack length before the call
236
- var router = (_a = internal._router) !== null && _a !== void 0 ? _a : internal.router;
237
- var stackBefore = (_c = (_b = router === null || router === void 0 ? void 0 : router.stack) === null || _b === void 0 ? void 0 : _b.length) !== null && _c !== void 0 ? _c : 0;
238
- var result = originalUse.apply(void 0, __spreadArray([], __read(args), false));
170
+ const router = internal._router ?? internal.router;
171
+ const stackBefore = router?.stack?.length ?? 0;
172
+ const result = originalUse(...args);
239
173
  // After use(), check if new layers were added and annotate them
240
- var routerAfter = (_d = internal._router) !== null && _d !== void 0 ? _d : internal.router;
241
- annotateMountLayers(routerAfter === null || routerAfter === void 0 ? void 0 : routerAfter.stack, stackBefore, args);
174
+ const routerAfter = internal._router ?? internal.router;
175
+ annotateMountLayers(routerAfter?.stack, stackBefore, args);
242
176
  return result;
243
177
  };
244
178
  app.use = patchedUse;
@@ -248,11 +182,10 @@ exports.patchAppUse = patchAppUse;
248
182
  * Express middleware that patches the router stack before OpenAPI doc
249
183
  * generation. Must be mounted before the openapi middleware.
250
184
  */
251
- var openApiCompatMiddleware = function (req, _res, next) {
252
- var _a;
253
- var internal = req.app;
254
- var router = (_a = internal._router) !== null && _a !== void 0 ? _a : internal.router;
255
- if (router === null || router === void 0 ? void 0 : router.stack) {
185
+ const openApiCompatMiddleware = (req, _res, next) => {
186
+ const internal = req.app;
187
+ const router = internal._router ?? internal.router;
188
+ if (router?.stack) {
256
189
  patchRouterStack(router.stack);
257
190
  }
258
191
  next();
@@ -4,23 +4,23 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
6
  exports.openApiEtagMiddleware = void 0;
7
- var node_crypto_1 = __importDefault(require("node:crypto"));
7
+ const node_crypto_1 = __importDefault(require("node:crypto"));
8
8
  /**
9
9
  * Middleware to add ETag support for OpenAPI JSON endpoint.
10
10
  * This middleware should be added before the @wesleytodd/openapi middleware
11
11
  * to intercept requests to /openapi.json and add conditional request support.
12
12
  */
13
- var openApiEtagMiddleware = function (req, res, next) {
13
+ const openApiEtagMiddleware = (req, res, next) => {
14
14
  if (req.method !== "GET" || req.path !== "/openapi.json") {
15
15
  next();
16
16
  return;
17
17
  }
18
- var originalJson = res.json.bind(res);
19
- res.json = function (body) {
20
- var jsonString = JSON.stringify(body);
21
- var etag = "\"".concat(node_crypto_1.default.createHash("sha256").update(jsonString).digest("hex").substring(0, 16), "\"");
18
+ const originalJson = res.json.bind(res);
19
+ res.json = (body) => {
20
+ const jsonString = JSON.stringify(body);
21
+ const etag = `"${node_crypto_1.default.createHash("sha256").update(jsonString).digest("hex").substring(0, 16)}"`;
22
22
  res.set("ETag", etag);
23
- var ifNoneMatch = req.get("If-None-Match");
23
+ const ifNoneMatch = req.get("If-None-Match");
24
24
  if (ifNoneMatch === etag) {
25
25
  res.status(304).end();
26
26
  return res;
@@ -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).