@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,52 +1,14 @@
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
2
  var __importDefault = (this && this.__importDefault) || function (mod) {
41
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
42
4
  };
43
5
  Object.defineProperty(exports, "__esModule", { value: true });
44
6
  exports.createOpenApiBuilder = exports.OpenApiMiddlewareBuilder = void 0;
45
- var merge_1 = __importDefault(require("lodash/merge"));
46
- var logger_1 = require("./logger");
47
- var openApi_1 = require("./openApi");
48
- var openApiValidator_1 = require("./openApiValidator");
49
- var layer_schema_1 = require("./vendor/wesleytodd-openapi/lib/layer-schema");
7
+ const merge_1 = __importDefault(require("lodash/merge"));
8
+ const logger_1 = require("./logger");
9
+ const openApi_1 = require("./openApi");
10
+ const openApiValidator_1 = require("./openApiValidator");
11
+ const layer_schema_1 = require("./vendor/wesleytodd-openapi/lib/layer-schema");
50
12
  /**
51
13
  * Run handlers in order as one Express middleware function.
52
14
  *
@@ -54,15 +16,14 @@ var layer_schema_1 = require("./vendor/wesleytodd-openapi/lib/layer-schema");
54
16
  * Express registers. Copying the schema from the documentation handler onto
55
17
  * the composed function keeps `/openapi.json` generation working.
56
18
  */
57
- var composeRequestHandlers = function (handlers) {
58
- var e_1, _c;
59
- var composed = function (req, res, next) {
60
- var run = function (index) {
19
+ const composeRequestHandlers = (handlers) => {
20
+ const composed = (req, res, next) => {
21
+ const run = (index) => {
61
22
  if (index >= handlers.length) {
62
23
  next();
63
24
  return;
64
25
  }
65
- handlers[index](req, res, function (error) {
26
+ handlers[index](req, res, (error) => {
66
27
  if (error) {
67
28
  next(error);
68
29
  return;
@@ -72,23 +33,13 @@ var composeRequestHandlers = function (handlers) {
72
33
  };
73
34
  run(0);
74
35
  };
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
- }
36
+ for (const handler of handlers) {
37
+ const schema = (0, layer_schema_1.get)(handler);
38
+ if (schema) {
39
+ (0, layer_schema_1.set)(composed, schema);
40
+ break;
83
41
  }
84
42
  }
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
43
  return composed;
93
44
  };
94
45
  /**
@@ -117,32 +68,39 @@ var composeRequestHandlers = function (handlers) {
117
68
  * .build();
118
69
  * ```
119
70
  */
120
- var OpenApiMiddlewareBuilder = /** @class */ (function () {
71
+ class OpenApiMiddlewareBuilder {
72
+ /** Router options containing OpenAPI configuration */
73
+ options;
74
+ /** Accumulated OpenAPI configuration from builder methods */
75
+ config;
76
+ /** Validation configuration */
77
+ validationConfig;
78
+ /** Store the raw request body schema for validation */
79
+ requestBodySchema;
80
+ /** Store the raw query parameter schemas for validation */
81
+ queryParamSchemas = {};
121
82
  /**
122
83
  * Creates a new OpenApiMiddlewareBuilder instance.
123
84
  *
124
85
  * @param options - Router options containing the OpenAPI path configuration
125
86
  */
126
- function OpenApiMiddlewareBuilder(options) {
127
- /** Store the raw query parameter schemas for validation */
128
- this.queryParamSchemas = {};
87
+ constructor(options) {
129
88
  this.options = options;
130
89
  this.config = {
131
90
  responses: {},
132
91
  };
133
92
  this.validationConfig = {};
134
93
  }
135
- OpenApiMiddlewareBuilder.prototype.describeRoute = function () {
136
- var _c;
137
- var parts = [];
94
+ describeRoute() {
95
+ const parts = [];
138
96
  if (this.config.summary) {
139
- parts.push("\"".concat(this.config.summary, "\""));
97
+ parts.push(`"${this.config.summary}"`);
140
98
  }
141
- if ((_c = this.config.tags) === null || _c === void 0 ? void 0 : _c.length) {
142
- parts.push("tags=[".concat(this.config.tags.join(", "), "]"));
99
+ if (this.config.tags?.length) {
100
+ parts.push(`tags=[${this.config.tags.join(", ")}]`);
143
101
  }
144
102
  return parts.length > 0 ? parts.join(" ") : "unnamed route";
145
- };
103
+ }
146
104
  /**
147
105
  * Sets the tags for the OpenAPI operation.
148
106
  *
@@ -156,10 +114,10 @@ var OpenApiMiddlewareBuilder = /** @class */ (function () {
156
114
  * builder.withTags(["users", "authentication"]);
157
115
  * ```
158
116
  */
159
- OpenApiMiddlewareBuilder.prototype.withTags = function (tags) {
117
+ withTags(tags) {
160
118
  this.config.tags = tags;
161
119
  return this;
162
- };
120
+ }
163
121
  /**
164
122
  * Sets the summary for the OpenAPI operation.
165
123
  *
@@ -173,10 +131,10 @@ var OpenApiMiddlewareBuilder = /** @class */ (function () {
173
131
  * builder.withSummary("Get user by ID");
174
132
  * ```
175
133
  */
176
- OpenApiMiddlewareBuilder.prototype.withSummary = function (summary) {
134
+ withSummary(summary) {
177
135
  this.config.summary = summary;
178
136
  return this;
179
- };
137
+ }
180
138
  /**
181
139
  * Sets an explicit `operationId` for the OpenAPI operation.
182
140
  *
@@ -194,10 +152,10 @@ var OpenApiMiddlewareBuilder = /** @class */ (function () {
194
152
  * builder.withOperationId("getUserStats");
195
153
  * ```
196
154
  */
197
- OpenApiMiddlewareBuilder.prototype.withOperationId = function (operationId) {
155
+ withOperationId(operationId) {
198
156
  this.config.operationId = operationId;
199
157
  return this;
200
- };
158
+ }
201
159
  /**
202
160
  * Sets the description for the OpenAPI operation.
203
161
  *
@@ -212,10 +170,10 @@ var OpenApiMiddlewareBuilder = /** @class */ (function () {
212
170
  * builder.withDescription("Retrieves a user by their unique identifier. Returns 404 if not found.");
213
171
  * ```
214
172
  */
215
- OpenApiMiddlewareBuilder.prototype.withDescription = function (description) {
173
+ withDescription(description) {
216
174
  this.config.description = description;
217
175
  return this;
218
- };
176
+ }
219
177
  /**
220
178
  * Sets the request body schema for the OpenAPI operation.
221
179
  *
@@ -237,34 +195,26 @@ var OpenApiMiddlewareBuilder = /** @class */ (function () {
237
195
  * });
238
196
  * ```
239
197
  */
240
- OpenApiMiddlewareBuilder.prototype.withRequestBody = function (schema, options) {
241
- var _c;
242
- var _d, _e;
243
- var required = Object.entries(schema)
244
- .filter(function (_c) {
245
- var _d = __read(_c, 2), _ = _d[0], prop = _d[1];
246
- return prop.required;
247
- })
248
- .map(function (_c) {
249
- var _d = __read(_c, 2), key = _d[0], _ = _d[1];
250
- return key;
251
- });
198
+ withRequestBody(schema, options) {
199
+ const required = Object.entries(schema)
200
+ .filter(([_, prop]) => prop.required)
201
+ .map(([key, _]) => key);
252
202
  this.config.requestBody = {
253
- content: (_c = {},
254
- _c[(_d = options === null || options === void 0 ? void 0 : options.mediaType) !== null && _d !== void 0 ? _d : "application/json"] = {
203
+ content: {
204
+ [options?.mediaType ?? "application/json"]: {
255
205
  schema: {
256
206
  properties: schema,
257
207
  required: required.length > 0 ? required : undefined,
258
208
  type: "object",
259
209
  },
260
210
  },
261
- _c),
262
- required: (_e = options === null || options === void 0 ? void 0 : options.required) !== null && _e !== void 0 ? _e : true,
211
+ },
212
+ required: options?.required ?? true,
263
213
  };
264
214
  // Store the schema for validation
265
215
  this.requestBodySchema = schema;
266
216
  return this;
267
- };
217
+ }
268
218
  /**
269
219
  * Adds a response definition to the OpenAPI operation.
270
220
  *
@@ -290,9 +240,7 @@ var OpenApiMiddlewareBuilder = /** @class */ (function () {
290
240
  * builder.withResponse(204, "No content");
291
241
  * ```
292
242
  */
293
- OpenApiMiddlewareBuilder.prototype.withResponse = function (statusCode, schema, options) {
294
- var _c;
295
- var _d, _e;
243
+ withResponse(statusCode, schema, options) {
296
244
  if (typeof schema === "string") {
297
245
  this.config.responses[statusCode] = {
298
246
  description: schema,
@@ -300,19 +248,19 @@ var OpenApiMiddlewareBuilder = /** @class */ (function () {
300
248
  }
301
249
  else {
302
250
  this.config.responses[statusCode] = {
303
- content: (_c = {},
304
- _c[(_d = options === null || options === void 0 ? void 0 : options.mediaType) !== null && _d !== void 0 ? _d : "application/json"] = {
251
+ content: {
252
+ [options?.mediaType ?? "application/json"]: {
305
253
  schema: {
306
254
  properties: schema,
307
255
  type: "object",
308
256
  },
309
257
  },
310
- _c),
311
- description: (_e = options === null || options === void 0 ? void 0 : options.description) !== null && _e !== void 0 ? _e : "Success",
258
+ },
259
+ description: options?.description ?? "Success",
312
260
  };
313
261
  }
314
262
  return this;
315
- };
263
+ }
316
264
  /**
317
265
  * Adds an array response definition to the OpenAPI operation.
318
266
  *
@@ -335,12 +283,10 @@ var OpenApiMiddlewareBuilder = /** @class */ (function () {
335
283
  * }, {description: "List of users"});
336
284
  * ```
337
285
  */
338
- OpenApiMiddlewareBuilder.prototype.withArrayResponse = function (statusCode, itemSchema, options) {
339
- var _c;
340
- var _d, _e;
286
+ withArrayResponse(statusCode, itemSchema, options) {
341
287
  this.config.responses[statusCode] = {
342
- content: (_c = {},
343
- _c[(_d = options === null || options === void 0 ? void 0 : options.mediaType) !== null && _d !== void 0 ? _d : "application/json"] = {
288
+ content: {
289
+ [options?.mediaType ?? "application/json"]: {
344
290
  schema: {
345
291
  items: {
346
292
  properties: itemSchema,
@@ -349,11 +295,11 @@ var OpenApiMiddlewareBuilder = /** @class */ (function () {
349
295
  type: "array",
350
296
  },
351
297
  },
352
- _c),
353
- description: (_e = options === null || options === void 0 ? void 0 : options.description) !== null && _e !== void 0 ? _e : "Success",
298
+ },
299
+ description: options?.description ?? "Success",
354
300
  };
355
301
  return this;
356
- };
302
+ }
357
303
  /**
358
304
  * Adds a query parameter to the OpenAPI operation.
359
305
  *
@@ -374,22 +320,24 @@ var OpenApiMiddlewareBuilder = /** @class */ (function () {
374
320
  * });
375
321
  * ```
376
322
  */
377
- OpenApiMiddlewareBuilder.prototype.withQueryParameter = function (name, schema, options) {
378
- var _c;
323
+ withQueryParameter(name, schema, options) {
379
324
  if (!this.config.parameters) {
380
325
  this.config.parameters = [];
381
326
  }
382
327
  this.config.parameters.push({
383
- description: options === null || options === void 0 ? void 0 : options.description,
328
+ description: options?.description,
384
329
  in: "query",
385
- name: name,
386
- required: (_c = options === null || options === void 0 ? void 0 : options.required) !== null && _c !== void 0 ? _c : false,
387
- schema: schema,
330
+ name,
331
+ required: options?.required ?? false,
332
+ schema,
388
333
  });
389
334
  // Store for validation
390
- this.queryParamSchemas[name] = __assign(__assign({}, schema), { required: options === null || options === void 0 ? void 0 : options.required });
335
+ this.queryParamSchemas[name] = {
336
+ ...schema,
337
+ required: options?.required,
338
+ };
391
339
  return this;
392
- };
340
+ }
393
341
  /**
394
342
  * Adds a path parameter to the OpenAPI operation.
395
343
  *
@@ -409,19 +357,19 @@ var OpenApiMiddlewareBuilder = /** @class */ (function () {
409
357
  * });
410
358
  * ```
411
359
  */
412
- OpenApiMiddlewareBuilder.prototype.withPathParameter = function (name, schema, options) {
360
+ withPathParameter(name, schema, options) {
413
361
  if (!this.config.parameters) {
414
362
  this.config.parameters = [];
415
363
  }
416
364
  this.config.parameters.push({
417
- description: options === null || options === void 0 ? void 0 : options.description,
365
+ description: options?.description,
418
366
  in: "path",
419
- name: name,
367
+ name,
420
368
  required: true,
421
- schema: schema,
369
+ schema,
422
370
  });
423
371
  return this;
424
- };
372
+ }
425
373
  /**
426
374
  * Enables runtime validation for this route.
427
375
  *
@@ -442,15 +390,14 @@ var OpenApiMiddlewareBuilder = /** @class */ (function () {
442
390
  * .build();
443
391
  * ```
444
392
  */
445
- OpenApiMiddlewareBuilder.prototype.withValidation = function (options) {
446
- var _c, _d, _e;
393
+ withValidation(options) {
447
394
  this.validationConfig = {
448
- enabled: (_c = options === null || options === void 0 ? void 0 : options.enabled) !== null && _c !== void 0 ? _c : true,
449
- validateBody: (_d = options === null || options === void 0 ? void 0 : options.body) !== null && _d !== void 0 ? _d : true,
450
- validateQuery: (_e = options === null || options === void 0 ? void 0 : options.query) !== null && _e !== void 0 ? _e : true,
395
+ enabled: options?.enabled ?? true,
396
+ validateBody: options?.body ?? true,
397
+ validateQuery: options?.query ?? true,
451
398
  };
452
399
  return this;
453
- };
400
+ }
454
401
  /**
455
402
  * Builds and returns the OpenAPI middleware along with schemas.
456
403
  *
@@ -470,26 +417,32 @@ var OpenApiMiddlewareBuilder = /** @class */ (function () {
470
417
  * }, {bodySchema, validate: true}));
471
418
  * ```
472
419
  */
473
- OpenApiMiddlewareBuilder.prototype.buildWithSchemas = function () {
474
- var _c, _d, _e, _f, _g;
475
- var noop = function (_a, _b, next) { return next(); };
420
+ buildWithSchemas() {
421
+ const noop = (_a, _b, next) => next();
476
422
  // Build the OpenAPI documentation middleware only (no validation middleware)
477
- var openApiMiddleware = noop;
478
- if ((_c = this.options.openApi) === null || _c === void 0 ? void 0 : _c.path) {
479
- openApiMiddleware = this.options.openApi.path((0, merge_1.default)(__assign(__assign({}, this.config), { responses: __assign(__assign({}, this.config.responses), openApi_1.defaultOpenApiErrorResponses) }), (_e = (_d = this.options.openApiOverwrite) === null || _d === void 0 ? void 0 : _d.get) !== null && _e !== void 0 ? _e : {}));
423
+ let openApiMiddleware = noop;
424
+ if (this.options.openApi?.path) {
425
+ openApiMiddleware = this.options.openApi.path((0, merge_1.default)({
426
+ ...this.config,
427
+ responses: {
428
+ ...this.config.responses,
429
+ ...openApi_1.defaultOpenApiErrorResponses,
430
+ },
431
+ }, this.options.openApiOverwrite?.get ?? {}));
480
432
  }
481
433
  else {
482
- logger_1.logger.debug("No options.openApi provided in buildWithSchemas for ".concat(this.describeRoute(), ", skipping OpenApiMiddleware"));
434
+ logger_1.logger.debug(`No options.openApi provided in buildWithSchemas for ${this.describeRoute()}, skipping OpenApiMiddleware`);
483
435
  }
484
- var globalConfig = (0, openApiValidator_1.getOpenApiValidatorConfig)();
485
- var validationEnabled = (_f = this.validationConfig.enabled) !== null && _f !== void 0 ? _f : ((0, openApiValidator_1.isOpenApiValidatorConfigured)() && ((_g = globalConfig.validateRequests) !== null && _g !== void 0 ? _g : false));
436
+ const globalConfig = (0, openApiValidator_1.getOpenApiValidatorConfig)();
437
+ const validationEnabled = this.validationConfig.enabled ??
438
+ ((0, openApiValidator_1.isOpenApiValidatorConfigured)() && (globalConfig.validateRequests ?? false));
486
439
  return {
487
440
  bodySchema: this.requestBodySchema,
488
441
  middleware: openApiMiddleware,
489
442
  querySchema: Object.keys(this.queryParamSchemas).length > 0 ? this.queryParamSchemas : undefined,
490
- validationEnabled: validationEnabled,
443
+ validationEnabled,
491
444
  };
492
- };
445
+ }
493
446
  /**
494
447
  * Builds and returns the OpenAPI middleware.
495
448
  *
@@ -516,25 +469,31 @@ var OpenApiMiddlewareBuilder = /** @class */ (function () {
516
469
  * router.get("/users/:id", middleware, getUserHandler);
517
470
  * ```
518
471
  */
519
- OpenApiMiddlewareBuilder.prototype.build = function () {
520
- var _c, _d, _e, _f, _g;
521
- var noop = function (_a, _b, next) { return next(); };
472
+ build() {
473
+ const noop = (_a, _b, next) => next();
522
474
  // Build the OpenAPI documentation middleware
523
- var openApiMiddleware = noop;
524
- if ((_c = this.options.openApi) === null || _c === void 0 ? void 0 : _c.path) {
525
- openApiMiddleware = this.options.openApi.path((0, merge_1.default)(__assign(__assign({}, this.config), { responses: __assign(__assign({}, this.config.responses), openApi_1.defaultOpenApiErrorResponses) }), (_e = (_d = this.options.openApiOverwrite) === null || _d === void 0 ? void 0 : _d.get) !== null && _e !== void 0 ? _e : {}));
475
+ let openApiMiddleware = noop;
476
+ if (this.options.openApi?.path) {
477
+ openApiMiddleware = this.options.openApi.path((0, merge_1.default)({
478
+ ...this.config,
479
+ responses: {
480
+ ...this.config.responses,
481
+ ...openApi_1.defaultOpenApiErrorResponses,
482
+ },
483
+ }, this.options.openApiOverwrite?.get ?? {}));
526
484
  }
527
485
  else {
528
- logger_1.logger.debug("No options.openApi provided in build for ".concat(this.describeRoute(), ", skipping OpenApiMiddleware"));
486
+ logger_1.logger.debug(`No options.openApi provided in build for ${this.describeRoute()}, skipping OpenApiMiddleware`);
529
487
  }
530
488
  // Check if validation should be enabled
531
- var globalConfig = (0, openApiValidator_1.getOpenApiValidatorConfig)();
532
- var shouldValidate = (_f = this.validationConfig.enabled) !== null && _f !== void 0 ? _f : ((0, openApiValidator_1.isOpenApiValidatorConfigured)() && ((_g = globalConfig.validateRequests) !== null && _g !== void 0 ? _g : false));
489
+ const globalConfig = (0, openApiValidator_1.getOpenApiValidatorConfig)();
490
+ const shouldValidate = this.validationConfig.enabled ??
491
+ ((0, openApiValidator_1.isOpenApiValidatorConfigured)() && (globalConfig.validateRequests ?? false));
533
492
  if (!shouldValidate) {
534
493
  return openApiMiddleware;
535
494
  }
536
495
  // Build validation middleware
537
- var validators = [openApiMiddleware];
496
+ const validators = [openApiMiddleware];
538
497
  // Add body validation if we have a request body schema
539
498
  if (this.validationConfig.validateBody && this.requestBodySchema) {
540
499
  validators.push((0, openApiValidator_1.validateRequestBody)(this.requestBodySchema, { enabled: true }));
@@ -547,9 +506,8 @@ var OpenApiMiddlewareBuilder = /** @class */ (function () {
547
506
  return openApiMiddleware;
548
507
  }
549
508
  return composeRequestHandlers(validators);
550
- };
551
- return OpenApiMiddlewareBuilder;
552
- }());
509
+ }
510
+ }
553
511
  exports.OpenApiMiddlewareBuilder = OpenApiMiddlewareBuilder;
554
512
  /**
555
513
  * Creates a new OpenAPI middleware builder.
@@ -578,7 +536,7 @@ exports.OpenApiMiddlewareBuilder = OpenApiMiddlewareBuilder;
578
536
  * router.get("/analytics/stats", statsMiddleware, getStatsHandler);
579
537
  * ```
580
538
  */
581
- var createOpenApiBuilder = function (options) {
539
+ const createOpenApiBuilder = (options) => {
582
540
  return new OpenApiMiddlewareBuilder(options);
583
541
  };
584
542
  exports.createOpenApiBuilder = createOpenApiBuilder;