@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
package/dist/openApi.js CHANGED
@@ -1,55 +1,19 @@
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 __read = (this && this.__read) || function (o, n) {
14
- var m = typeof Symbol === "function" && o[Symbol.iterator];
15
- if (!m) return o;
16
- var i = m.call(o), r, ar = [], e;
17
- try {
18
- while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
19
- }
20
- catch (error) { e = { error: error }; }
21
- finally {
22
- try {
23
- if (r && !r.done && (m = i["return"])) m.call(i);
24
- }
25
- finally { if (e) throw e.error; }
26
- }
27
- return ar;
28
- };
29
- var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
30
- if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
31
- if (ar || !(i in from)) {
32
- if (!ar) ar = Array.prototype.slice.call(from, 0, i);
33
- ar[i] = from[i];
34
- }
35
- }
36
- return to.concat(ar || Array.prototype.slice.call(from));
37
- };
38
2
  var __importDefault = (this && this.__importDefault) || function (mod) {
39
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
40
4
  };
41
5
  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;
43
- var flatten_1 = __importDefault(require("lodash/flatten"));
44
- var merge_1 = __importDefault(require("lodash/merge"));
45
- var mongoose_to_swagger_1 = __importDefault(require("mongoose-to-swagger"));
46
- var logger_1 = require("./logger");
47
- var populate_1 = require("./populate");
48
- var noop = function (_a, _b, next) { return next(); };
49
- var m2sOptions = {
6
+ exports.readOpenApiMiddleware = exports.deleteOpenApiMiddleware = exports.patchOpenApiMiddleware = exports.createOpenApiMiddleware = exports.listOpenApiMiddleware = exports.getOpenApiMiddleware = exports.defaultOpenApiErrorResponses = void 0;
7
+ const flatten_1 = __importDefault(require("lodash/flatten"));
8
+ const merge_1 = __importDefault(require("lodash/merge"));
9
+ const mongoose_to_swagger_1 = __importDefault(require("mongoose-to-swagger"));
10
+ const logger_1 = require("./logger");
11
+ const populate_1 = require("./populate");
12
+ const noop = (_a, _b, next) => next();
13
+ const m2sOptions = {
50
14
  props: ["readOnly", "required", "enum", "default"],
51
15
  };
52
- exports.apiErrorContent = {
16
+ const apiErrorContent = {
53
17
  "application/json": {
54
18
  schema: { $ref: "#/components/schemas/APIError" },
55
19
  },
@@ -57,29 +21,29 @@ exports.apiErrorContent = {
57
21
  // Default error responses
58
22
  exports.defaultOpenApiErrorResponses = {
59
23
  400: {
60
- content: exports.apiErrorContent,
24
+ content: apiErrorContent,
61
25
  description: "Bad request",
62
26
  },
63
27
  401: {
64
28
  description: "The user must be authenticated",
65
29
  },
66
30
  403: {
67
- content: exports.apiErrorContent,
31
+ content: apiErrorContent,
68
32
  description: "The user is not allowed to perform this action on this document",
69
33
  },
70
34
  404: {
71
- content: exports.apiErrorContent,
35
+ content: apiErrorContent,
72
36
  description: "Document not found",
73
37
  },
74
38
  405: {
75
- content: exports.apiErrorContent,
39
+ content: apiErrorContent,
76
40
  description: "The user is not allowed to perform this action on any document",
77
41
  },
78
42
  };
79
43
  // We repeat this constantly, so we make it a component so we only have to define it once.
80
- var createAPIErrorComponent = function (openApi) {
44
+ const createAPIErrorComponent = (openApi) => {
81
45
  // Create a schema component called APIError
82
- openApi === null || openApi === void 0 ? void 0 : openApi.component("schemas", "APIError", {
46
+ openApi?.component("schemas", "APIError", {
83
47
  properties: {
84
48
  code: {
85
49
  description: "An application-specific error code, expressed as a string value.",
@@ -139,72 +103,73 @@ var createAPIErrorComponent = function (openApi) {
139
103
  type: "object",
140
104
  });
141
105
  };
142
- var getOpenApiMiddleware = function (model, options) {
143
- var _c, _d, _e, _f, _g;
106
+ const getOpenApiMiddleware = (model, options) => {
144
107
  createAPIErrorComponent(options.openApi);
145
- if (!((_c = options.openApi) === null || _c === void 0 ? void 0 : _c.path)) {
108
+ if (!options.openApi?.path) {
146
109
  // Just log this once rather than for each middleware.
147
- logger_1.logger.debug("No options.openApi provided for model \"".concat(model.modelName, "\" in getOpenApiMiddleware, skipping *OpenApiMiddleware"));
110
+ logger_1.logger.debug(`No options.openApi provided for model "${model.modelName}" in getOpenApiMiddleware, skipping *OpenApiMiddleware`);
148
111
  return noop;
149
112
  }
150
- if (((_e = (_d = options.permissions) === null || _d === void 0 ? void 0 : _d.read) === null || _e === void 0 ? void 0 : _e.length) === 0) {
113
+ if (options.permissions?.read?.length === 0) {
151
114
  return noop;
152
115
  }
153
- var _h = (0, populate_1.getOpenApiSpecForModel)(model, {
116
+ const { properties, required } = (0, populate_1.getOpenApiSpecForModel)(model, {
154
117
  extraModelProperties: options.openApiExtraModelProperties,
155
118
  populatePaths: options.populatePaths,
156
- }), properties = _h.properties, required = _h.required;
119
+ });
157
120
  return options.openApi.path((0, merge_1.default)({
158
- responses: __assign({ 200: {
121
+ responses: {
122
+ 200: {
159
123
  content: {
160
124
  "application/json": {
161
125
  schema: {
162
- properties: properties,
163
- required: __spreadArray(__spreadArray([], __read(required), false), ["_id", "created", "updated"], false),
126
+ properties,
127
+ required: [...required, "_id", "created", "updated"],
164
128
  type: "object",
165
129
  },
166
130
  },
167
131
  },
168
132
  description: "Successful read",
169
- } }, exports.defaultOpenApiErrorResponses),
133
+ },
134
+ ...exports.defaultOpenApiErrorResponses,
135
+ },
170
136
  tags: [model.collection.collectionName],
171
- }, (_g = (_f = options.openApiOverwrite) === null || _f === void 0 ? void 0 : _f.get) !== null && _g !== void 0 ? _g : {}));
137
+ }, options.openApiOverwrite?.get ?? {}));
172
138
  };
173
139
  exports.getOpenApiMiddleware = getOpenApiMiddleware;
174
- var resolveSyncScopeLabel = function (scope) {
140
+ const resolveSyncScopeLabel = (scope) => {
175
141
  if (typeof scope === "function") {
176
142
  return "custom";
177
143
  }
178
144
  return scope.type;
179
145
  };
180
- var buildTerrenoSyncExtension = function (sync, routePath, fallbackCollection) {
146
+ const buildTerrenoSyncExtension = (sync, routePath, fallbackCollection) => {
181
147
  if (!sync) {
182
148
  return {};
183
149
  }
184
- var rawPath = routePath !== null && routePath !== void 0 ? routePath : (fallbackCollection ? "/".concat(fallbackCollection) : undefined);
150
+ const rawPath = routePath ?? (fallbackCollection ? `/${fallbackCollection}` : undefined);
185
151
  if (!rawPath) {
186
152
  return {};
187
153
  }
188
- var collection = rawPath.replace(/^\//, "");
154
+ const collection = rawPath.replace(/^\//, "");
189
155
  return {
190
156
  "x-terreno-sync": {
191
- collection: collection,
157
+ collection,
192
158
  scope: resolveSyncScopeLabel(sync.scope),
193
159
  },
194
160
  };
195
161
  };
196
- var listOpenApiMiddleware = function (model, options, routePath) {
197
- var _c, _d, _e, _f, _g, _h;
198
- if (!((_c = options.openApi) === null || _c === void 0 ? void 0 : _c.path)) {
162
+ const listOpenApiMiddleware = (model, options, routePath) => {
163
+ if (!options.openApi?.path) {
199
164
  return noop;
200
165
  }
201
- if (((_e = (_d = options.permissions) === null || _d === void 0 ? void 0 : _d.list) === null || _e === void 0 ? void 0 : _e.length) === 0) {
166
+ if (options.permissions?.list?.length === 0) {
202
167
  return noop;
203
168
  }
204
- var modelSwagger = (0, mongoose_to_swagger_1.default)(model, m2sOptions);
169
+ const modelSwagger = (0, mongoose_to_swagger_1.default)(model, m2sOptions);
205
170
  // TODO: handle permissions
206
171
  // Convert modelRouter queryFields into OpenAPI parameters
207
- var defaultQueryParams = [
172
+ const defaultQueryParams = [
208
173
  {
209
174
  in: "query",
210
175
  name: "_id",
@@ -221,12 +186,14 @@ var listOpenApiMiddleware = function (model, options, routePath) {
221
186
  },
222
187
  },
223
188
  ];
224
- var modelQueryParams = (0, flatten_1.default)((_f = options.queryFields) === null || _f === void 0 ? void 0 : _f.filter(function (field) { return field !== "_id"; }).map(function (field) {
225
- var _c, _d, _e;
226
- var params = [];
189
+ const modelQueryParams = (0, flatten_1.default)(options.queryFields
190
+ // Remove _id from queryFields, we handle that above.
191
+ ?.filter((field) => field !== "_id")
192
+ .map((field) => {
193
+ const params = [];
227
194
  // Check for datetime/number to support gt/gte/lt/lte
228
- if (((_c = modelSwagger.properties[field]) === null || _c === void 0 ? void 0 : _c.type) === "number" ||
229
- ((_d = modelSwagger.properties[field]) === null || _d === void 0 ? void 0 : _d.format) === "date-time") {
195
+ if (modelSwagger.properties[field]?.type === "number" ||
196
+ modelSwagger.properties[field]?.format === "date-time") {
230
197
  params.push({
231
198
  in: "query",
232
199
  name: field,
@@ -257,7 +224,7 @@ var listOpenApiMiddleware = function (model, options, routePath) {
257
224
  properties: {
258
225
  $in: {
259
226
  items: {
260
- type: (_e = modelSwagger.properties[field]) === null || _e === void 0 ? void 0 : _e.type,
227
+ type: modelSwagger.properties[field]?.type,
261
228
  },
262
229
  type: "array",
263
230
  },
@@ -270,11 +237,15 @@ var listOpenApiMiddleware = function (model, options, routePath) {
270
237
  }
271
238
  return params;
272
239
  }));
273
- var _j = (0, populate_1.getOpenApiSpecForModel)(model, {
240
+ const { properties, required } = (0, populate_1.getOpenApiSpecForModel)(model, {
274
241
  extraModelProperties: options.openApiExtraModelProperties,
275
242
  populatePaths: options.populatePaths,
276
- }), properties = _j.properties, required = _j.required;
277
- return options.openApi.path((0, merge_1.default)(__assign(__assign({}, buildTerrenoSyncExtension(options.sync, routePath, model.collection.collectionName)), { parameters: __spreadArray(__spreadArray(__spreadArray([], __read(defaultQueryParams), false), __read((modelQueryParams !== null && modelQueryParams !== void 0 ? modelQueryParams : [])), false), [
243
+ });
244
+ return options.openApi.path((0, merge_1.default)({
245
+ ...buildTerrenoSyncExtension(options.sync, routePath, model.collection.collectionName),
246
+ parameters: [
247
+ ...defaultQueryParams,
248
+ ...(modelQueryParams ?? []),
278
249
  // pagination
279
250
  {
280
251
  in: "query",
@@ -297,15 +268,17 @@ var listOpenApiMiddleware = function (model, options, routePath) {
297
268
  type: "number",
298
269
  },
299
270
  },
300
- ], false), responses: __assign({ 200: {
271
+ ],
272
+ responses: {
273
+ 200: {
301
274
  content: {
302
275
  "application/json": {
303
276
  schema: {
304
277
  properties: {
305
278
  data: {
306
279
  items: {
307
- properties: properties,
308
- required: __spreadArray(__spreadArray([], __read(required), false), ["_id", "created", "updated"], false),
280
+ properties,
281
+ required: [...required, "_id", "created", "updated"],
309
282
  type: "object",
310
283
  },
311
284
  type: "array",
@@ -328,132 +301,145 @@ var listOpenApiMiddleware = function (model, options, routePath) {
328
301
  },
329
302
  },
330
303
  description: "Successful list",
331
- } }, exports.defaultOpenApiErrorResponses), tags: [model.collection.collectionName] }), (_h = (_g = options.openApiOverwrite) === null || _g === void 0 ? void 0 : _g.list) !== null && _h !== void 0 ? _h : {}));
304
+ },
305
+ ...exports.defaultOpenApiErrorResponses,
306
+ },
307
+ tags: [model.collection.collectionName],
308
+ }, options.openApiOverwrite?.list ?? {}));
332
309
  };
333
310
  exports.listOpenApiMiddleware = listOpenApiMiddleware;
334
- var createOpenApiMiddleware = function (model, options) {
335
- var _c, _d, _e, _f, _g;
336
- if (!((_c = options.openApi) === null || _c === void 0 ? void 0 : _c.path)) {
311
+ const createOpenApiMiddleware = (model, options) => {
312
+ if (!options.openApi?.path) {
337
313
  return noop;
338
314
  }
339
- if (((_e = (_d = options.permissions) === null || _d === void 0 ? void 0 : _d.create) === null || _e === void 0 ? void 0 : _e.length) === 0) {
315
+ if (options.permissions?.create?.length === 0) {
340
316
  return noop;
341
317
  }
342
- var _h = (0, populate_1.getOpenApiSpecForModel)(model, {
318
+ const { properties, required } = (0, populate_1.getOpenApiSpecForModel)(model, {
343
319
  extraModelProperties: options.openApiExtraModelProperties,
344
320
  populatePaths: options.populatePaths,
345
- }), properties = _h.properties, required = _h.required;
321
+ });
346
322
  return options.openApi.path((0, merge_1.default)({
347
323
  requestBody: {
348
324
  content: {
349
325
  "application/json": {
350
326
  schema: {
351
- properties: properties,
327
+ properties,
352
328
  type: "object",
353
329
  },
354
330
  },
355
331
  },
356
332
  required: true,
357
333
  },
358
- responses: __assign({ 201: {
334
+ responses: {
335
+ 201: {
359
336
  content: {
360
337
  "application/json": {
361
338
  schema: {
362
- properties: properties,
363
- required: __spreadArray(__spreadArray([], __read(required), false), ["_id", "created", "updated"], false),
339
+ properties,
340
+ required: [...required, "_id", "created", "updated"],
364
341
  type: "object",
365
342
  },
366
343
  },
367
344
  },
368
345
  description: "Successful create",
369
- } }, exports.defaultOpenApiErrorResponses),
346
+ },
347
+ ...exports.defaultOpenApiErrorResponses,
348
+ },
370
349
  tags: [model.collection.collectionName],
371
- }, (_g = (_f = options.openApiOverwrite) === null || _f === void 0 ? void 0 : _f.create) !== null && _g !== void 0 ? _g : {}));
350
+ }, options.openApiOverwrite?.create ?? {}));
372
351
  };
373
352
  exports.createOpenApiMiddleware = createOpenApiMiddleware;
374
- var patchOpenApiMiddleware = function (model, options) {
375
- var _c, _d, _e, _f, _g;
376
- if (!((_c = options.openApi) === null || _c === void 0 ? void 0 : _c.path)) {
353
+ const patchOpenApiMiddleware = (model, options) => {
354
+ if (!options.openApi?.path) {
377
355
  return noop;
378
356
  }
379
- if (((_e = (_d = options.permissions) === null || _d === void 0 ? void 0 : _d.update) === null || _e === void 0 ? void 0 : _e.length) === 0) {
357
+ if (options.permissions?.update?.length === 0) {
380
358
  return noop;
381
359
  }
382
- var _h = (0, populate_1.getOpenApiSpecForModel)(model, {
360
+ const { properties, required } = (0, populate_1.getOpenApiSpecForModel)(model, {
383
361
  extraModelProperties: options.openApiExtraModelProperties,
384
362
  populatePaths: options.populatePaths,
385
- }), properties = _h.properties, required = _h.required;
363
+ });
386
364
  return options.openApi.path((0, merge_1.default)({
387
365
  requestBody: {
388
366
  content: {
389
367
  "application/json": {
390
368
  schema: {
391
- properties: properties,
369
+ properties,
392
370
  type: "object",
393
371
  },
394
372
  },
395
373
  },
396
374
  required: true,
397
375
  },
398
- responses: __assign({ 200: {
376
+ responses: {
377
+ 200: {
399
378
  content: {
400
379
  "application/json": {
401
380
  schema: {
402
- properties: properties,
403
- required: __spreadArray(__spreadArray([], __read(required), false), ["_id", "created", "updated"], false),
381
+ properties,
382
+ required: [...required, "_id", "created", "updated"],
404
383
  type: "object",
405
384
  },
406
385
  },
407
386
  },
408
387
  description: "Successful update",
409
- } }, exports.defaultOpenApiErrorResponses),
388
+ },
389
+ ...exports.defaultOpenApiErrorResponses,
390
+ },
410
391
  tags: [model.collection.collectionName],
411
- }, (_g = (_f = options.openApiOverwrite) === null || _f === void 0 ? void 0 : _f.update) !== null && _g !== void 0 ? _g : {}));
392
+ }, options.openApiOverwrite?.update ?? {}));
412
393
  };
413
394
  exports.patchOpenApiMiddleware = patchOpenApiMiddleware;
414
- var deleteOpenApiMiddleware = function (model, options) {
415
- var _c, _d, _e, _f, _g;
416
- if (!((_c = options.openApi) === null || _c === void 0 ? void 0 : _c.path)) {
395
+ const deleteOpenApiMiddleware = (model, options) => {
396
+ if (!options.openApi?.path) {
417
397
  return noop;
418
398
  }
419
- if (((_e = (_d = options.permissions) === null || _d === void 0 ? void 0 : _d.delete) === null || _e === void 0 ? void 0 : _e.length) === 0) {
399
+ if (options.permissions?.delete?.length === 0) {
420
400
  return noop;
421
401
  }
422
402
  return options.openApi.path((0, merge_1.default)({
423
- responses: __assign({ 204: {
403
+ responses: {
404
+ 204: {
424
405
  description: "Successful delete",
425
- } }, exports.defaultOpenApiErrorResponses),
406
+ },
407
+ ...exports.defaultOpenApiErrorResponses,
408
+ },
426
409
  tags: [model.collection.collectionName],
427
- }, (_g = (_f = options.openApiOverwrite) === null || _f === void 0 ? void 0 : _f.delete) !== null && _g !== void 0 ? _g : {}));
410
+ }, options.openApiOverwrite?.delete ?? {}));
428
411
  };
429
412
  exports.deleteOpenApiMiddleware = deleteOpenApiMiddleware;
430
413
  // This is a generic OpenAPI wrapper for a read that returns any object described by `properties`.
431
414
  // Useful for endpoints that don't directly map to a model.
432
- var readOpenApiMiddleware = function (options, properties, required, queryParameters) {
433
- var _c, _d, _e, _f, _g;
434
- if (!((_c = options.openApi) === null || _c === void 0 ? void 0 : _c.path)) {
415
+ /** @internal */
416
+ const readOpenApiMiddleware = (options, properties, required, queryParameters) => {
417
+ if (!options.openApi?.path) {
435
418
  // Just log this once rather than for each middleware.
436
419
  logger_1.logger.debug("No options.openApi provided in readOpenApiMiddleware, skipping *OpenApiMiddleware");
437
420
  return noop;
438
421
  }
439
- if (((_e = (_d = options.permissions) === null || _d === void 0 ? void 0 : _d.read) === null || _e === void 0 ? void 0 : _e.length) === 0) {
422
+ if (options.permissions?.read?.length === 0) {
440
423
  return noop;
441
424
  }
442
425
  return options.openApi.path((0, merge_1.default)({
443
426
  parameters: queryParameters,
444
- responses: __assign({ 200: {
427
+ responses: {
428
+ 200: {
445
429
  content: {
446
430
  "application/json": {
447
431
  schema: {
448
- properties: properties,
449
- required: required,
432
+ properties,
433
+ required,
450
434
  type: "object",
451
435
  },
452
436
  },
453
437
  },
454
438
  description: "Successful read",
455
- } }, exports.defaultOpenApiErrorResponses),
439
+ },
440
+ ...exports.defaultOpenApiErrorResponses,
441
+ },
456
442
  tags: [],
457
- }, (_g = (_f = options.openApiOverwrite) === null || _f === void 0 ? void 0 : _f.get) !== null && _g !== void 0 ? _g : {}));
443
+ }, options.openApiOverwrite?.get ?? {}));
458
444
  };
459
445
  exports.readOpenApiMiddleware = readOpenApiMiddleware;
@@ -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.