@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,101 +1,18 @@
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 __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
14
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
15
- return new (P || (P = Promise))(function (resolve, reject) {
16
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
17
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
18
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
19
- step((generator = generator.apply(thisArg, _arguments || [])).next());
20
- });
21
- };
22
- var __generator = (this && this.__generator) || function (thisArg, body) {
23
- var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
24
- return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
25
- function verb(n) { return function (v) { return step([n, v]); }; }
26
- function step(op) {
27
- if (f) throw new TypeError("Generator is already executing.");
28
- while (g && (g = 0, op[0] && (_ = 0)), _) try {
29
- if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
30
- if (y = 0, t) op = [op[0] & 2, t.value];
31
- switch (op[0]) {
32
- case 0: case 1: t = op; break;
33
- case 4: _.label++; return { value: op[1], done: false };
34
- case 5: _.label++; y = op[1]; op = [0]; continue;
35
- case 7: op = _.ops.pop(); _.trys.pop(); continue;
36
- default:
37
- if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
38
- if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
39
- if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
40
- if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
41
- if (t[2]) _.ops.pop();
42
- _.trys.pop(); continue;
43
- }
44
- op = body.call(thisArg, _);
45
- } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
46
- if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
47
- }
48
- };
49
- var __read = (this && this.__read) || function (o, n) {
50
- var m = typeof Symbol === "function" && o[Symbol.iterator];
51
- if (!m) return o;
52
- var i = m.call(o), r, ar = [], e;
53
- try {
54
- while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
55
- }
56
- catch (error) { e = { error: error }; }
57
- finally {
58
- try {
59
- if (r && !r.done && (m = i["return"])) m.call(i);
60
- }
61
- finally { if (e) throw e.error; }
62
- }
63
- return ar;
64
- };
65
- var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
66
- if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
67
- if (ar || !(i in from)) {
68
- if (!ar) ar = Array.prototype.slice.call(from, 0, i);
69
- ar[i] = from[i];
70
- }
71
- }
72
- return to.concat(ar || Array.prototype.slice.call(from));
73
- };
74
- var __values = (this && this.__values) || function(o) {
75
- var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
76
- if (m) return m.call(o);
77
- if (o && typeof o.length === "number") return {
78
- next: function () {
79
- if (o && i >= o.length) o = void 0;
80
- return { value: o && o[i++], done: !o };
81
- }
82
- };
83
- throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
84
- };
85
2
  Object.defineProperty(exports, "__esModule", { value: true });
86
3
  exports.resolveModelRouterAccess = exports.validateAccessWritePayload = exports.validateAccessWriteBody = exports.wrapAccessResponseHandler = exports.buildAccessQueryFilter = exports.buildAccessPermissions = exports.resolveActionForMethod = void 0;
87
- var errors_1 = require("../errors");
88
- var transformers_1 = require("../transformers");
89
- var fieldViews_1 = require("./fieldViews");
90
- var middleware_1 = require("./middleware");
91
- var DEFAULT_METHOD_ACTIONS = {
4
+ const errors_1 = require("../errors");
5
+ const transformers_1 = require("../transformers");
6
+ const fieldViews_1 = require("./fieldViews");
7
+ const middleware_1 = require("./middleware");
8
+ const DEFAULT_METHOD_ACTIONS = {
92
9
  create: "create",
93
10
  delete: "delete",
94
11
  list: "list",
95
12
  read: "read",
96
13
  update: "update",
97
14
  };
98
- var mergeFilters = function (existing, scopeFilter) {
15
+ const mergeFilters = (existing, scopeFilter) => {
99
16
  if (existing === null || scopeFilter === null) {
100
17
  return null;
101
18
  }
@@ -103,23 +20,22 @@ var mergeFilters = function (existing, scopeFilter) {
103
20
  return {};
104
21
  }
105
22
  if (!existing) {
106
- return scopeFilter !== null && scopeFilter !== void 0 ? scopeFilter : {};
23
+ return scopeFilter ?? {};
107
24
  }
108
25
  if (!scopeFilter || Object.keys(scopeFilter).length === 0) {
109
26
  return existing;
110
27
  }
111
28
  return { $and: [existing, scopeFilter] };
112
29
  };
113
- var resolveActionForMethod = function (method, access, statements) {
114
- var _a, _b;
115
- var override = (_a = access.actions) === null || _a === void 0 ? void 0 : _a[method];
30
+ const resolveActionForMethod = (method, access, statements) => {
31
+ const override = access.actions?.[method];
116
32
  if (override === null) {
117
33
  return null;
118
34
  }
119
35
  if (override) {
120
36
  return override;
121
37
  }
122
- var resourceActions = (_b = statements[access.resource]) !== null && _b !== void 0 ? _b : [];
38
+ const resourceActions = statements[access.resource] ?? [];
123
39
  if (method === "list" && resourceActions.includes("list")) {
124
40
  return "list";
125
41
  }
@@ -129,60 +45,47 @@ var resolveActionForMethod = function (method, access, statements) {
129
45
  return DEFAULT_METHOD_ACTIONS[method];
130
46
  };
131
47
  exports.resolveActionForMethod = resolveActionForMethod;
132
- var buildPermissionRequest = function (resource, action) {
133
- var _a;
134
- return (_a = {},
135
- _a[resource] = [action],
136
- _a);
137
- };
138
- var buildAccessPermissions = function (accessControl, access) {
139
- var isPermitted = (0, middleware_1.createIsPermitted)({ can: accessControl.can });
140
- var statements = accessControl.statements;
141
- var buildMethodPermissions = function (method) {
142
- var _a, _b, _c;
143
- var action = (0, exports.resolveActionForMethod)(method, access, statements);
48
+ const buildPermissionRequest = (resource, action) => ({
49
+ [resource]: [action],
50
+ });
51
+ /** @internal */
52
+ const buildAccessPermissions = (accessControl, access) => {
53
+ const isPermitted = (0, middleware_1.createIsPermitted)({ can: accessControl.can });
54
+ const statements = accessControl.statements;
55
+ const buildMethodPermissions = (method) => {
56
+ const action = (0, exports.resolveActionForMethod)(method, access, statements);
144
57
  if (!action) {
145
58
  return [];
146
59
  }
147
- var checks = [
60
+ const checks = [
148
61
  isPermitted(buildPermissionRequest(access.resource, action)),
149
62
  ];
150
- if ((_a = access.scope) === null || _a === void 0 ? void 0 : _a.check) {
151
- checks.push(function (_method, user, obj) { return __awaiter(void 0, void 0, void 0, function () {
152
- var result, extra;
153
- var _a, _b;
154
- return __generator(this, function (_c) {
155
- switch (_c.label) {
156
- case 0:
157
- if (!user) {
158
- return [2 /*return*/, false];
159
- }
160
- return [4 /*yield*/, ((_b = (_a = access.scope) === null || _a === void 0 ? void 0 : _a.check) === null || _b === void 0 ? void 0 : _b.call(_a, {
161
- action: action,
162
- doc: obj,
163
- user: user,
164
- }))];
165
- case 1:
166
- result = _c.sent();
167
- if (result === false) {
168
- return [2 /*return*/, false];
169
- }
170
- if (!(result && typeof result === "object")) return [3 /*break*/, 3];
171
- return [4 /*yield*/, accessControl.can({
172
- doc: obj,
173
- permissions: result,
174
- user: user,
175
- })];
176
- case 2:
177
- extra = _c.sent();
178
- return [2 /*return*/, extra.allowed];
179
- case 3: return [2 /*return*/, true];
180
- }
63
+ if (access.scope?.check) {
64
+ checks.push(async (_method, user, obj) => {
65
+ if (!user) {
66
+ return false;
67
+ }
68
+ const result = await access.scope?.check?.({
69
+ action,
70
+ doc: obj,
71
+ user,
181
72
  });
182
- }); });
73
+ if (result === false) {
74
+ return false;
75
+ }
76
+ if (result && typeof result === "object") {
77
+ const extra = await accessControl.can({
78
+ doc: obj,
79
+ permissions: result,
80
+ user,
81
+ });
82
+ return extra.allowed;
83
+ }
84
+ return true;
85
+ });
183
86
  }
184
- var also = (_c = (_b = access.also) === null || _b === void 0 ? void 0 : _b[method]) !== null && _c !== void 0 ? _c : [];
185
- return __spreadArray(__spreadArray([], __read(checks), false), __read(also), false);
87
+ const also = access.also?.[method] ?? [];
88
+ return [...checks, ...also];
186
89
  };
187
90
  return {
188
91
  create: buildMethodPermissions("create"),
@@ -193,180 +96,100 @@ var buildAccessPermissions = function (accessControl, access) {
193
96
  };
194
97
  };
195
98
  exports.buildAccessPermissions = buildAccessPermissions;
196
- var buildAccessQueryFilter = function (accessControl, access, existing) {
197
- return function (user, query) { return __awaiter(void 0, void 0, void 0, function () {
198
- var merged, statements, listAction, scopeFilter, withAccessScope, routerScopeFilter;
199
- var _a;
200
- return __generator(this, function (_b) {
201
- switch (_b.label) {
202
- case 0:
203
- merged = query !== null && query !== void 0 ? query : {};
204
- if (!existing) return [3 /*break*/, 2];
205
- return [4 /*yield*/, existing(user, query)];
206
- case 1:
207
- merged = _b.sent();
208
- if (merged === null) {
209
- return [2 /*return*/, null];
210
- }
211
- _b.label = 2;
212
- case 2:
213
- statements = accessControl.statements;
214
- listAction = (0, exports.resolveActionForMethod)("list", access, statements);
215
- if (!listAction) {
216
- return [2 /*return*/, merged];
217
- }
218
- return [4 /*yield*/, accessControl.queryFilter({
219
- action: listAction,
220
- context: { query: query },
221
- resource: access.resource,
222
- user: user,
223
- })];
224
- case 3:
225
- scopeFilter = _b.sent();
226
- withAccessScope = mergeFilters(merged, scopeFilter);
227
- if (!(((_a = access.scope) === null || _a === void 0 ? void 0 : _a.filter) && user)) return [3 /*break*/, 5];
228
- return [4 /*yield*/, access.scope.filter({
229
- action: listAction,
230
- user: user,
231
- })];
232
- case 4:
233
- routerScopeFilter = _b.sent();
234
- withAccessScope = mergeFilters(withAccessScope, routerScopeFilter);
235
- _b.label = 5;
236
- case 5: return [2 /*return*/, withAccessScope];
99
+ /** @internal */
100
+ const buildAccessQueryFilter = (accessControl, access, existing) => {
101
+ return async (user, query) => {
102
+ let merged = query ?? {};
103
+ if (existing) {
104
+ merged = await existing(user, query);
105
+ if (merged === null) {
106
+ return null;
237
107
  }
108
+ }
109
+ const statements = accessControl.statements;
110
+ const listAction = (0, exports.resolveActionForMethod)("list", access, statements);
111
+ if (!listAction) {
112
+ return merged;
113
+ }
114
+ const scopeFilter = await accessControl.queryFilter({
115
+ action: listAction,
116
+ context: { query },
117
+ resource: access.resource,
118
+ user,
238
119
  });
239
- }); };
120
+ let withAccessScope = mergeFilters(merged, scopeFilter);
121
+ if (access.scope?.filter && user) {
122
+ const routerScopeFilter = await access.scope.filter({
123
+ action: listAction,
124
+ user,
125
+ });
126
+ withAccessScope = mergeFilters(withAccessScope, routerScopeFilter);
127
+ }
128
+ return withAccessScope;
129
+ };
240
130
  };
241
131
  exports.buildAccessQueryFilter = buildAccessQueryFilter;
242
- var wrapAccessResponseHandler = function (accessControl, access, baseHandler) {
243
- return function (value, method, request, options) { return __awaiter(void 0, void 0, void 0, function () {
244
- var serialized, docs, masked;
245
- return __generator(this, function (_a) {
246
- switch (_a.label) {
247
- case 0: return [4 /*yield*/, baseHandler(value, method, request, options)];
248
- case 1:
249
- serialized = _a.sent();
250
- docs = Array.isArray(serialized) ? serialized : [serialized];
251
- return [4 /*yield*/, Promise.all(docs.map(function (doc) { return __awaiter(void 0, void 0, void 0, function () {
252
- var mask;
253
- return __generator(this, function (_a) {
254
- switch (_a.label) {
255
- case 0: return [4 /*yield*/, accessControl.fieldMask({
256
- doc: doc,
257
- phase: "read",
258
- resource: access.resource,
259
- user: request.user,
260
- })];
261
- case 1:
262
- mask = _a.sent();
263
- return [2 /*return*/, (0, fieldViews_1.applyReadMask)(doc, mask)];
264
- }
265
- });
266
- }); }))];
267
- case 2:
268
- masked = _a.sent();
269
- return [2 /*return*/, Array.isArray(serialized) ? masked : masked[0]];
270
- }
271
- });
272
- }); };
132
+ /** @internal */
133
+ const wrapAccessResponseHandler = (accessControl, access, baseHandler) => {
134
+ return async (value, method, request, options) => {
135
+ const serialized = await baseHandler(value, method, request, options);
136
+ const docs = Array.isArray(serialized) ? serialized : [serialized];
137
+ const masked = await Promise.all(docs.map(async (doc) => {
138
+ const mask = await accessControl.fieldMask({
139
+ doc,
140
+ phase: "read",
141
+ resource: access.resource,
142
+ user: request.user,
143
+ });
144
+ return (0, fieldViews_1.applyReadMask)(doc, mask);
145
+ }));
146
+ return Array.isArray(serialized) ? masked : masked[0];
147
+ };
273
148
  };
274
149
  exports.wrapAccessResponseHandler = wrapAccessResponseHandler;
275
- var validateAccessWriteBody = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
276
- var mask, disallowed, fields, disallowed_1, disallowed_1_1, key;
277
- var e_1, _c;
278
- var accessControl = _b.accessControl, access = _b.access, body = _b.body, doc = _b.doc, phase = _b.phase, user = _b.user;
279
- return __generator(this, function (_d) {
280
- switch (_d.label) {
281
- case 0: return [4 /*yield*/, accessControl.fieldMask({
282
- doc: doc,
283
- phase: phase === "create" ? "create" : "write",
284
- resource: access.resource,
285
- user: user,
286
- })];
287
- case 1:
288
- mask = _d.sent();
289
- disallowed = (0, fieldViews_1.getDisallowedWriteKeys)(body, mask);
290
- if (disallowed.length === 0) {
291
- return [2 /*return*/];
292
- }
293
- fields = {};
294
- try {
295
- for (disallowed_1 = __values(disallowed), disallowed_1_1 = disallowed_1.next(); !disallowed_1_1.done; disallowed_1_1 = disallowed_1.next()) {
296
- key = disallowed_1_1.value;
297
- fields[key] = "Field is not writable";
298
- }
299
- }
300
- catch (e_1_1) { e_1 = { error: e_1_1 }; }
301
- finally {
302
- try {
303
- if (disallowed_1_1 && !disallowed_1_1.done && (_c = disallowed_1.return)) _c.call(disallowed_1);
304
- }
305
- finally { if (e_1) throw e_1.error; }
306
- }
307
- throw new errors_1.APIError({
308
- fields: fields,
309
- status: 400,
310
- title: "Validation failed",
311
- });
312
- }
150
+ const validateAccessWriteBody = async ({ accessControl, access, body, doc, phase, user, }) => {
151
+ const mask = await accessControl.fieldMask({
152
+ doc,
153
+ phase: phase === "create" ? "create" : "write",
154
+ resource: access.resource,
155
+ user,
313
156
  });
314
- }); };
157
+ const disallowed = (0, fieldViews_1.getDisallowedWriteKeys)(body, mask);
158
+ if (disallowed.length === 0) {
159
+ return;
160
+ }
161
+ const fields = {};
162
+ for (const key of disallowed) {
163
+ fields[key] = "Field is not writable";
164
+ }
165
+ throw new errors_1.APIError({
166
+ fields,
167
+ status: 400,
168
+ title: "Validation failed",
169
+ });
170
+ };
315
171
  exports.validateAccessWriteBody = validateAccessWriteBody;
316
- var validateAccessWritePayload = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
317
- var items, items_1, items_1_1, item, e_2_1;
318
- var e_2, _c;
319
- var options = _b.options, body = _b.body, doc = _b.doc, phase = _b.phase, user = _b.user;
320
- return __generator(this, function (_d) {
321
- switch (_d.label) {
322
- case 0:
323
- if (!options.access || !options.accessControl || body == null) {
324
- return [2 /*return*/];
325
- }
326
- items = Array.isArray(body) ? body : [body];
327
- _d.label = 1;
328
- case 1:
329
- _d.trys.push([1, 6, 7, 8]);
330
- items_1 = __values(items), items_1_1 = items_1.next();
331
- _d.label = 2;
332
- case 2:
333
- if (!!items_1_1.done) return [3 /*break*/, 5];
334
- item = items_1_1.value;
335
- if (!item || typeof item !== "object" || Array.isArray(item)) {
336
- return [3 /*break*/, 4];
337
- }
338
- return [4 /*yield*/, (0, exports.validateAccessWriteBody)({
339
- access: options.access,
340
- accessControl: options.accessControl,
341
- body: item,
342
- doc: doc,
343
- phase: phase,
344
- user: user,
345
- })];
346
- case 3:
347
- _d.sent();
348
- _d.label = 4;
349
- case 4:
350
- items_1_1 = items_1.next();
351
- return [3 /*break*/, 2];
352
- case 5: return [3 /*break*/, 8];
353
- case 6:
354
- e_2_1 = _d.sent();
355
- e_2 = { error: e_2_1 };
356
- return [3 /*break*/, 8];
357
- case 7:
358
- try {
359
- if (items_1_1 && !items_1_1.done && (_c = items_1.return)) _c.call(items_1);
360
- }
361
- finally { if (e_2) throw e_2.error; }
362
- return [7 /*endfinally*/];
363
- case 8: return [2 /*return*/];
172
+ const validateAccessWritePayload = async ({ options, body, doc, phase, user, }) => {
173
+ if (!options.access || !options.accessControl || body == null) {
174
+ return;
175
+ }
176
+ const items = Array.isArray(body) ? body : [body];
177
+ for (const item of items) {
178
+ if (!item || typeof item !== "object" || Array.isArray(item)) {
179
+ continue;
364
180
  }
365
- });
366
- }); };
181
+ await (0, exports.validateAccessWriteBody)({
182
+ access: options.access,
183
+ accessControl: options.accessControl,
184
+ body: item,
185
+ doc,
186
+ phase,
187
+ user,
188
+ });
189
+ }
190
+ };
367
191
  exports.validateAccessWritePayload = validateAccessWritePayload;
368
- var resolveModelRouterAccess = function (options) {
369
- var _a, _b;
192
+ const resolveModelRouterAccess = (options) => {
370
193
  if (!options.access || !options.accessControl) {
371
194
  if (!options.permissions) {
372
195
  throw new errors_1.APIError({
@@ -380,13 +203,16 @@ var resolveModelRouterAccess = function (options) {
380
203
  responseHandler: options.responseHandler,
381
204
  };
382
205
  }
383
- var access = __assign(__assign({}, options.access), { scope: (_a = options.access.scope) !== null && _a !== void 0 ? _a : options.scope });
206
+ const access = {
207
+ ...options.access,
208
+ scope: options.access.scope ?? options.scope,
209
+ };
384
210
  return {
385
211
  permissions: (0, exports.buildAccessPermissions)(options.accessControl, access),
386
212
  queryFilter: (0, exports.buildAccessQueryFilter)(options.accessControl, access, options.queryFilter),
387
213
  // Without an app handler the base must stay defaultResponseHandler: masking a raw
388
214
  // Mongoose document would emit internal state instead of the serialized payload.
389
- responseHandler: (0, exports.wrapAccessResponseHandler)(options.accessControl, access, ((_b = options.responseHandler) !== null && _b !== void 0 ? _b : transformers_1.defaultResponseHandler)),
215
+ responseHandler: (0, exports.wrapAccessResponseHandler)(options.accessControl, access, (options.responseHandler ?? transformers_1.defaultResponseHandler)),
390
216
  };
391
217
  };
392
218
  exports.resolveModelRouterAccess = resolveModelRouterAccess;