@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/actions.js CHANGED
@@ -1,204 +1,98 @@
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.registerActionRoutes = exports.assertNoActionCollisions = exports.createActionOpenApiMiddleware = exports.wrapActionResponse = exports.validateActionRequest = exports.runActionPermissions = exports.defineCollectionAction = exports.defineInstanceAction = exports.ACTION_NAME_PATTERN = void 0;
87
- var zod_to_openapi_1 = require("@asteasolutions/zod-to-openapi");
88
- var api_1 = require("./api");
89
- var auth_1 = require("./auth");
90
- var docLoader_1 = require("./docLoader");
91
- var errors_1 = require("./errors");
92
- var openApi_1 = require("./openApi");
93
- var permissions_1 = require("./permissions");
94
- var middleware_1 = require("./rbac/middleware");
4
+ const zod_to_openapi_1 = require("@asteasolutions/zod-to-openapi");
5
+ const api_1 = require("./api");
6
+ const auth_1 = require("./auth");
7
+ const docLoader_1 = require("./docLoader");
8
+ const errors_1 = require("./errors");
9
+ const openApi_1 = require("./openApi");
10
+ const permissions_1 = require("./permissions");
11
+ const middleware_1 = require("./rbac/middleware");
95
12
  // At least two characters: leading letter plus one or more alphanumeric/_/- chars.
96
13
  exports.ACTION_NAME_PATTERN = /^[A-Za-z][A-Za-z0-9_-]+$/;
97
- var defineInstanceAction = function (config) {
14
+ const defineInstanceAction = (config) => {
98
15
  return config;
99
16
  };
100
17
  exports.defineInstanceAction = defineInstanceAction;
101
- var defineCollectionAction = function (config) {
18
+ const defineCollectionAction = (config) => {
102
19
  return config;
103
20
  };
104
21
  exports.defineCollectionAction = defineCollectionAction;
105
- var mapActionToCrudMethod = function (scope, httpMethod) {
22
+ const mapActionToCrudMethod = (scope, httpMethod) => {
106
23
  if (scope === "instance") {
107
24
  return httpMethod === "GET" ? "read" : "update";
108
25
  }
109
26
  return httpMethod === "GET" ? "list" : "create";
110
27
  };
111
- var resolveActionAccess = function (action, scope, routerAccess) {
112
- var _a;
28
+ const resolveActionAccess = (action, scope, routerAccess) => {
113
29
  if (action.access) {
114
30
  return action.access;
115
31
  }
116
- if (!(routerAccess === null || routerAccess === void 0 ? void 0 : routerAccess.resource)) {
32
+ if (!routerAccess?.resource) {
117
33
  return undefined;
118
34
  }
119
- var crud = mapActionToCrudMethod(scope, action.method);
120
- var mapped = (_a = routerAccess.actions) === null || _a === void 0 ? void 0 : _a[crud];
35
+ const crud = mapActionToCrudMethod(scope, action.method);
36
+ const mapped = routerAccess.actions?.[crud];
121
37
  if (mapped === null) {
122
38
  return null;
123
39
  }
124
- return { action: mapped !== null && mapped !== void 0 ? mapped : crud, resource: routerAccess.resource };
40
+ return { action: mapped ?? crud, resource: routerAccess.resource };
125
41
  };
126
- var runActionPermissions = function (action, scope, model, req, doc, accessControl, routerAccess) { return __awaiter(void 0, void 0, void 0, function () {
127
- var method, permissions, rbacAccess, isPermitted, rbacCheck, allowed;
128
- var _a;
129
- var _b, _c, _d;
130
- return __generator(this, function (_e) {
131
- switch (_e.label) {
132
- case 0:
133
- method = mapActionToCrudMethod(scope, action.method);
134
- permissions = action.permissions;
135
- rbacAccess = resolveActionAccess(action, scope, routerAccess);
136
- if (rbacAccess === null || (permissions === null || permissions === void 0 ? void 0 : permissions.length) === 0) {
137
- permissions = [];
138
- }
139
- else if (rbacAccess && accessControl) {
140
- isPermitted = (0, middleware_1.createIsPermitted)({ can: accessControl.can });
141
- rbacCheck = isPermitted((_a = {},
142
- _a[rbacAccess.resource] = [rbacAccess.action],
143
- _a));
144
- permissions = __spreadArray(__spreadArray([], __read(((_b = action.permissions) !== null && _b !== void 0 ? _b : [])), false), [rbacCheck], false);
145
- }
146
- if (!permissions) {
147
- throw new errors_1.APIError({ status: 500, title: "Action missing permissions configuration" });
148
- }
149
- return [4 /*yield*/, (0, permissions_1.checkPermissions)(method, permissions, req.user, doc)];
150
- case 1:
151
- allowed = _e.sent();
152
- if (allowed) {
153
- return [2 /*return*/];
154
- }
155
- if (!doc) {
156
- // Status kept at 405 for backwards compatibility with the same pre-document permission denial
157
- // in modelRouter's array operations; changing it would break consumers matching on it.
158
- throw new errors_1.APIError({
159
- code: "action-access-denied",
160
- detail: "Access to ".concat(method.toUpperCase(), " on ").concat(model.modelName, " ") + "denied for ".concat((_c = req.user) === null || _c === void 0 ? void 0 : _c.id),
161
- meta: { action: method.toUpperCase(), model: model.modelName },
162
- status: 405,
163
- title: "Access denied",
164
- });
165
- }
166
- throw new errors_1.ForbiddenError({
167
- code: "action-access-denied",
168
- detail: "Access to ".concat(method.toUpperCase(), " on ").concat(model.modelName, ":").concat(req.params.id, " ") +
169
- "denied for ".concat((_d = req.user) === null || _d === void 0 ? void 0 : _d.id),
170
- meta: { action: method.toUpperCase(), model: model.modelName },
171
- title: "Access denied",
172
- });
173
- }
42
+ const runActionPermissions = async (action, scope, model, req, doc, accessControl, routerAccess) => {
43
+ const method = mapActionToCrudMethod(scope, action.method);
44
+ let permissions = action.permissions;
45
+ const rbacAccess = resolveActionAccess(action, scope, routerAccess);
46
+ if (rbacAccess === null || permissions?.length === 0) {
47
+ permissions = [];
48
+ }
49
+ else if (rbacAccess && accessControl) {
50
+ const isPermitted = (0, middleware_1.createIsPermitted)({ can: accessControl.can });
51
+ const rbacCheck = isPermitted({
52
+ [rbacAccess.resource]: [rbacAccess.action],
53
+ });
54
+ permissions = [...(action.permissions ?? []), rbacCheck];
55
+ }
56
+ if (!permissions) {
57
+ throw new errors_1.APIError({ status: 500, title: "Action missing permissions configuration" });
58
+ }
59
+ const allowed = await (0, permissions_1.checkPermissions)(method, permissions, req.user, doc);
60
+ if (allowed) {
61
+ return;
62
+ }
63
+ if (!doc) {
64
+ // Status kept at 405 for backwards compatibility with the same pre-document permission denial
65
+ // in modelRouter's array operations; changing it would break consumers matching on it.
66
+ throw new errors_1.APIError({
67
+ code: "action-access-denied",
68
+ detail: `Access to ${method.toUpperCase()} on ${model.modelName} ` + `denied for ${req.user?.id}`,
69
+ meta: { action: method.toUpperCase(), model: model.modelName },
70
+ status: 405,
71
+ title: "Access denied",
72
+ });
73
+ }
74
+ throw new errors_1.ForbiddenError({
75
+ code: "action-access-denied",
76
+ detail: `Access to ${method.toUpperCase()} on ${model.modelName}:${req.params.id} ` +
77
+ `denied for ${req.user?.id}`,
78
+ meta: { action: method.toUpperCase(), model: model.modelName },
79
+ title: "Access denied",
174
80
  });
175
- }); };
81
+ };
176
82
  exports.runActionPermissions = runActionPermissions;
177
- var flattenZodFieldErrors = function (fieldErrors) {
178
- var e_1, _a;
179
- var fields = {};
180
- try {
181
- for (var _b = __values(Object.entries(fieldErrors)), _c = _b.next(); !_c.done; _c = _b.next()) {
182
- var _d = __read(_c.value, 2), key = _d[0], msgs = _d[1];
183
- if (msgs && msgs.length > 0) {
184
- fields[key] = msgs[0];
185
- }
83
+ const flattenZodFieldErrors = (fieldErrors) => {
84
+ const fields = {};
85
+ for (const [key, msgs] of Object.entries(fieldErrors)) {
86
+ if (msgs && msgs.length > 0) {
87
+ fields[key] = msgs[0];
186
88
  }
187
89
  }
188
- catch (e_1_1) { e_1 = { error: e_1_1 }; }
189
- finally {
190
- try {
191
- if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
192
- }
193
- finally { if (e_1) throw e_1.error; }
194
- }
195
90
  return fields;
196
91
  };
197
- var validateActionRequest = function (_a) {
198
- var action = _a.action, req = _a.req;
199
- var body;
92
+ const validateActionRequest = ({ action, req, }) => {
93
+ let body;
200
94
  if (action.body) {
201
- var parsedBody = action.body.safeParse(req.body);
95
+ const parsedBody = action.body.safeParse(req.body);
202
96
  if (!parsedBody.success) {
203
97
  throw new errors_1.ValidationError({
204
98
  code: "action-body-validation-failed",
@@ -212,9 +106,9 @@ var validateActionRequest = function (_a) {
212
106
  else {
213
107
  body = req.body;
214
108
  }
215
- var query;
109
+ let query;
216
110
  if (action.query) {
217
- var parsedQuery = action.query.safeParse(req.query);
111
+ const parsedQuery = action.query.safeParse(req.query);
218
112
  if (!parsedQuery.success) {
219
113
  throw new errors_1.ValidationError({
220
114
  code: "action-query-validation-failed",
@@ -228,59 +122,50 @@ var validateActionRequest = function (_a) {
228
122
  else {
229
123
  query = req.query;
230
124
  }
231
- return { body: body, query: query };
125
+ return { body, query };
232
126
  };
233
127
  exports.validateActionRequest = validateActionRequest;
234
- var wrapActionResponse = function (handlerResult, action, res) {
235
- var _a;
128
+ const wrapActionResponse = (handlerResult, action, res) => {
236
129
  if (res.headersSent) {
237
130
  return;
238
131
  }
239
- res.status((_a = action.status) !== null && _a !== void 0 ? _a : 200).json({ data: handlerResult !== null && handlerResult !== void 0 ? handlerResult : null });
132
+ res.status(action.status ?? 200).json({ data: handlerResult ?? null });
240
133
  };
241
134
  exports.wrapActionResponse = wrapActionResponse;
242
- var inlineOpenApiSchemaCounter = 0;
243
- var zodToJsonSchema = function (zodSchema) {
244
- var _a;
245
- var registry = new zod_to_openapi_1.OpenAPIRegistry();
246
- var refId = "ActionInlineSchema".concat(inlineOpenApiSchemaCounter++);
135
+ let inlineOpenApiSchemaCounter = 0;
136
+ const zodToJsonSchema = (zodSchema) => {
137
+ const registry = new zod_to_openapi_1.OpenAPIRegistry();
138
+ const refId = `ActionInlineSchema${inlineOpenApiSchemaCounter++}`;
247
139
  registry.register(refId, zodSchema);
248
- var generator = new zod_to_openapi_1.OpenApiGeneratorV3(registry.definitions);
249
- var components = generator.generateComponents().components;
250
- var schema = (_a = components === null || components === void 0 ? void 0 : components.schemas) === null || _a === void 0 ? void 0 : _a[refId];
140
+ const generator = new zod_to_openapi_1.OpenApiGeneratorV3(registry.definitions);
141
+ const { components } = generator.generateComponents();
142
+ const schema = components?.schemas?.[refId];
251
143
  if (schema && typeof schema === "object") {
252
144
  return schema;
253
145
  }
254
146
  return { type: "object" };
255
147
  };
256
- var queryParametersFromSchema = function (querySchema) {
257
- var _a;
258
- var jsonSchema = zodToJsonSchema(querySchema);
259
- var properties = jsonSchema.properties;
148
+ const queryParametersFromSchema = (querySchema) => {
149
+ const jsonSchema = zodToJsonSchema(querySchema);
150
+ const properties = jsonSchema.properties;
260
151
  if (!properties) {
261
152
  return [];
262
153
  }
263
- var requiredFields = (_a = jsonSchema.required) !== null && _a !== void 0 ? _a : [];
264
- return Object.entries(properties).map(function (_a) {
265
- var _b = __read(_a, 2), name = _b[0], schema = _b[1];
266
- return ({
267
- in: "query",
268
- name: name,
269
- required: requiredFields.includes(name),
270
- schema: schema,
271
- });
272
- });
154
+ const requiredFields = jsonSchema.required ?? [];
155
+ return Object.entries(properties).map(([name, schema]) => ({
156
+ in: "query",
157
+ name,
158
+ required: requiredFields.includes(name),
159
+ schema,
160
+ }));
273
161
  };
274
- var createActionOpenApiMiddleware = function (_a) {
275
- var _b;
276
- var _c, _d, _e, _f;
277
- var action = _a.action, scope = _a.scope, actionName = _a.actionName, model = _a.model, options = _a.options;
278
- if (!((_c = options.openApi) === null || _c === void 0 ? void 0 : _c.path)) {
279
- return function (_req, _res, next) { return next(); };
162
+ const createActionOpenApiMiddleware = ({ action, scope, actionName, model, options, }) => {
163
+ if (!options.openApi?.path) {
164
+ return (_req, _res, next) => next();
280
165
  }
281
- var tag = (_d = action.tag) !== null && _d !== void 0 ? _d : model.collection.collectionName;
282
- var statusCode = String((_e = action.status) !== null && _e !== void 0 ? _e : 200);
283
- var parameters = [];
166
+ const tag = action.tag ?? model.collection.collectionName;
167
+ const statusCode = String(action.status ?? 200);
168
+ const parameters = [];
284
169
  if (scope === "instance") {
285
170
  parameters.push({
286
171
  in: "path",
@@ -290,34 +175,37 @@ var createActionOpenApiMiddleware = function (_a) {
290
175
  });
291
176
  }
292
177
  if (action.query) {
293
- parameters.push.apply(parameters, __spreadArray([], __read(queryParametersFromSchema(action.query)), false));
178
+ parameters.push(...queryParametersFromSchema(action.query));
294
179
  }
295
- var operation = {
180
+ const operation = {
296
181
  description: action.description,
297
- operationId: "".concat(tag, "_").concat(actionName),
298
- parameters: parameters,
299
- responses: __assign((_b = {}, _b[statusCode] = {
300
- content: {
301
- "application/json": {
302
- schema: action.response
303
- ? {
304
- properties: {
305
- data: zodToJsonSchema(action.response),
182
+ operationId: `${tag}_${actionName}`,
183
+ parameters,
184
+ responses: {
185
+ [statusCode]: {
186
+ content: {
187
+ "application/json": {
188
+ schema: action.response
189
+ ? {
190
+ properties: {
191
+ data: zodToJsonSchema(action.response),
192
+ },
193
+ required: ["data"],
194
+ type: "object",
195
+ }
196
+ : {
197
+ properties: {
198
+ data: { type: "object" },
199
+ },
200
+ type: "object",
306
201
  },
307
- required: ["data"],
308
- type: "object",
309
- }
310
- : {
311
- properties: {
312
- data: { type: "object" },
313
- },
314
- type: "object",
315
- },
202
+ },
316
203
  },
204
+ description: "Successful response",
317
205
  },
318
- description: "Successful response",
319
- }, _b), openApi_1.defaultOpenApiErrorResponses),
320
- summary: (_f = action.summary) !== null && _f !== void 0 ? _f : "".concat(actionName, " ").concat(scope, " action"),
206
+ ...openApi_1.defaultOpenApiErrorResponses,
207
+ },
208
+ summary: action.summary ?? `${actionName} ${scope} action`,
321
209
  tags: [tag],
322
210
  };
323
211
  if (action.body) {
@@ -333,26 +221,26 @@ var createActionOpenApiMiddleware = function (_a) {
333
221
  return options.openApi.path(operation);
334
222
  };
335
223
  exports.createActionOpenApiMiddleware = createActionOpenApiMiddleware;
336
- var getArrayFieldNames = function (model) {
224
+ const getArrayFieldNames = (model) => {
337
225
  return Object.values(model.schema.paths)
338
- .filter(function (config) { return config.instance === "Array"; })
339
- .map(function (config) { return config.path; });
226
+ .filter((config) => config.instance === "Array")
227
+ .map((config) => config.path);
340
228
  };
341
229
  // Registration-time validation throws APIError so misconfiguration fails at app boot.
342
- var validateActionConfig = function (scope, name, config) {
230
+ const validateActionConfig = (scope, name, config) => {
343
231
  if (!name) {
344
232
  throw new errors_1.APIError({ status: 500, title: "Action name cannot be empty" });
345
233
  }
346
234
  if (!exports.ACTION_NAME_PATTERN.test(name)) {
347
235
  throw new errors_1.APIError({
348
236
  status: 500,
349
- title: "Invalid action name \"".concat(name, "\". Action names must match ").concat(exports.ACTION_NAME_PATTERN.toString()),
237
+ title: `Invalid action name "${name}". Action names must match ${exports.ACTION_NAME_PATTERN.toString()}`,
350
238
  });
351
239
  }
352
240
  if (config.permissions === undefined && !config.access) {
353
241
  throw new errors_1.APIError({
354
242
  status: 500,
355
- title: "Action \"".concat(name, "\" (").concat(scope, ") is missing required \"permissions\" or \"access\". ") +
243
+ title: `Action "${name}" (${scope}) is missing required "permissions" or "access". ` +
356
244
  "Provide at least one permission function, an access descriptor, or [] to disable the action.",
357
245
  });
358
246
  }
@@ -362,119 +250,75 @@ var validateActionConfig = function (scope, name, config) {
362
250
  if (config.method !== "GET" && config.method !== "POST") {
363
251
  throw new errors_1.APIError({
364
252
  status: 500,
365
- title: "Action \"".concat(name, "\" (").concat(scope, ") only supports GET and POST methods"),
253
+ title: `Action "${name}" (${scope}) only supports GET and POST methods`,
366
254
  });
367
255
  }
368
256
  };
369
- var assertNoActionCollisions = function (model, options) {
370
- var arrayFields = new Set(getArrayFieldNames(model));
371
- var validateMap = function (actions, scope) {
372
- var e_2, _a;
257
+ const assertNoActionCollisions = (model, options) => {
258
+ const arrayFields = new Set(getArrayFieldNames(model));
259
+ const validateMap = (actions, scope) => {
373
260
  if (!actions) {
374
261
  return;
375
262
  }
376
- try {
377
- for (var _b = __values(Object.entries(actions)), _c = _b.next(); !_c.done; _c = _b.next()) {
378
- var _d = __read(_c.value, 2), name_1 = _d[0], config = _d[1];
379
- validateActionConfig(scope, name_1, config);
380
- if (scope === "instance" && arrayFields.has(name_1)) {
381
- throw new errors_1.APIError({
382
- status: 500,
383
- title: "instanceAction '".concat(name_1, "' collides with array field operations on /:id/").concat(name_1),
384
- });
385
- }
386
- }
387
- }
388
- catch (e_2_1) { e_2 = { error: e_2_1 }; }
389
- finally {
390
- try {
391
- if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
263
+ for (const [name, config] of Object.entries(actions)) {
264
+ validateActionConfig(scope, name, config);
265
+ if (scope === "instance" && arrayFields.has(name)) {
266
+ throw new errors_1.APIError({
267
+ status: 500,
268
+ title: `instanceAction '${name}' collides with array field operations on /:id/${name}`,
269
+ });
392
270
  }
393
- finally { if (e_2) throw e_2.error; }
394
271
  }
395
272
  };
396
273
  validateMap(options.instanceActions, "instance");
397
274
  validateMap(options.collectionActions, "collection");
398
275
  };
399
276
  exports.assertNoActionCollisions = assertNoActionCollisions;
400
- var buildActionMiddleware = function (model, options, registered) {
401
- var action = registered.config;
402
- var scope = registered.scope;
403
- var actionName = registered.name;
404
- var preDocPermissions = function (req, _res, next) { return __awaiter(void 0, void 0, void 0, function () {
405
- var error_1;
406
- return __generator(this, function (_a) {
407
- switch (_a.label) {
408
- case 0:
409
- _a.trys.push([0, 2, , 3]);
410
- return [4 /*yield*/, (0, exports.runActionPermissions)(action, scope, model, req, undefined, options.accessControl, options.access)];
411
- case 1:
412
- _a.sent();
413
- return [2 /*return*/, next()];
414
- case 2:
415
- error_1 = _a.sent();
416
- return [2 /*return*/, next(error_1)];
417
- case 3: return [2 /*return*/];
277
+ const buildActionMiddleware = (model, options, registered) => {
278
+ const action = registered.config;
279
+ const scope = registered.scope;
280
+ const actionName = registered.name;
281
+ const preDocPermissions = async (req, _res, next) => {
282
+ try {
283
+ await (0, exports.runActionPermissions)(action, scope, model, req, undefined, options.accessControl, options.access);
284
+ return next();
285
+ }
286
+ catch (error) {
287
+ return next(error);
288
+ }
289
+ };
290
+ const loadDocAndPostPermissions = scope === "instance"
291
+ ? async (req, _res, next) => {
292
+ try {
293
+ const doc = await (0, docLoader_1.loadDocOr404)(model, req.params.id, options.populatePaths);
294
+ req.obj = doc;
295
+ await (0, exports.runActionPermissions)(action, scope, model, req, doc, options.accessControl, options.access);
296
+ return next();
418
297
  }
419
- });
420
- }); };
421
- var loadDocAndPostPermissions = scope === "instance"
422
- ? function (req, _res, next) { return __awaiter(void 0, void 0, void 0, function () {
423
- var doc, error_2;
424
- return __generator(this, function (_a) {
425
- switch (_a.label) {
426
- case 0:
427
- _a.trys.push([0, 3, , 4]);
428
- return [4 /*yield*/, (0, docLoader_1.loadDocOr404)(model, req.params.id, options.populatePaths)];
429
- case 1:
430
- doc = _a.sent();
431
- req.obj = doc;
432
- return [4 /*yield*/, (0, exports.runActionPermissions)(action, scope, model, req, doc, options.accessControl, options.access)];
433
- case 2:
434
- _a.sent();
435
- return [2 /*return*/, next()];
436
- case 3:
437
- error_2 = _a.sent();
438
- return [2 /*return*/, next(error_2)];
439
- case 4: return [2 /*return*/];
440
- }
441
- });
442
- }); }
443
- : null;
444
- var validateAndRun = (0, api_1.asyncHandler)(function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
445
- var _a, body, query, doc, ctx, result, _b;
446
- return __generator(this, function (_c) {
447
- switch (_c.label) {
448
- case 0:
449
- _a = (0, exports.validateActionRequest)({ action: action, req: req }), body = _a.body, query = _a.query;
450
- doc = scope === "instance" ? req.obj : undefined;
451
- ctx = {
452
- body: body,
453
- doc: doc,
454
- query: query,
455
- req: req,
456
- res: res,
457
- user: req.user,
458
- };
459
- if (!(scope === "instance")) return [3 /*break*/, 2];
460
- return [4 /*yield*/, action.handler(ctx)];
461
- case 1:
462
- _b = _c.sent();
463
- return [3 /*break*/, 4];
464
- case 2: return [4 /*yield*/, action.handler(ctx)];
465
- case 3:
466
- _b = _c.sent();
467
- _c.label = 4;
468
- case 4:
469
- result = _b;
470
- (0, exports.wrapActionResponse)(result, action, res);
471
- return [2 /*return*/];
298
+ catch (error) {
299
+ return next(error);
472
300
  }
473
- });
474
- }); });
475
- var chain = [
301
+ }
302
+ : null;
303
+ const validateAndRun = (0, api_1.asyncHandler)(async (req, res) => {
304
+ const { body, query } = (0, exports.validateActionRequest)({ action, req });
305
+ const doc = scope === "instance" ? req.obj : undefined;
306
+ const ctx = {
307
+ body,
308
+ doc,
309
+ query,
310
+ req,
311
+ res,
312
+ user: req.user,
313
+ };
314
+ const result = scope === "instance"
315
+ ? await action.handler(ctx)
316
+ : await action.handler(ctx);
317
+ (0, exports.wrapActionResponse)(result, action, res);
318
+ });
319
+ const chain = [
476
320
  (0, auth_1.authenticateMiddleware)(options.allowAnonymous),
477
- (0, exports.createActionOpenApiMiddleware)({ action: action, actionName: actionName, model: model, options: options, scope: scope }),
321
+ (0, exports.createActionOpenApiMiddleware)({ action, actionName, model, options, scope }),
478
322
  preDocPermissions,
479
323
  ];
480
324
  if (loadDocAndPostPermissions) {
@@ -483,46 +327,31 @@ var buildActionMiddleware = function (model, options, registered) {
483
327
  chain.push(validateAndRun);
484
328
  return chain;
485
329
  };
486
- var registerActionRoutes = function (router, model, options) {
487
- var e_3, _a;
488
- var _b, _c;
489
- var instanceActions = (_b = options.instanceActions) !== null && _b !== void 0 ? _b : {};
490
- var collectionActions = (_c = options.collectionActions) !== null && _c !== void 0 ? _c : {};
491
- var registeredActions = __spreadArray(__spreadArray([], __read(Object.entries(instanceActions).map(function (_a) {
492
- var _b = __read(_a, 2), name = _b[0], config = _b[1];
493
- return ({
494
- config: config,
495
- name: name,
330
+ const registerActionRoutes = (router, model, options) => {
331
+ const instanceActions = options.instanceActions ?? {};
332
+ const collectionActions = options.collectionActions ?? {};
333
+ const registeredActions = [
334
+ ...Object.entries(instanceActions).map(([name, config]) => ({
335
+ config,
336
+ name,
496
337
  scope: "instance",
497
- });
498
- })), false), __read(Object.entries(collectionActions).map(function (_a) {
499
- var _b = __read(_a, 2), name = _b[0], config = _b[1];
500
- return ({
501
- config: config,
502
- name: name,
338
+ })),
339
+ ...Object.entries(collectionActions).map(([name, config]) => ({
340
+ config,
341
+ name,
503
342
  scope: "collection",
504
- });
505
- })), false);
506
- try {
507
- for (var registeredActions_1 = __values(registeredActions), registeredActions_1_1 = registeredActions_1.next(); !registeredActions_1_1.done; registeredActions_1_1 = registeredActions_1.next()) {
508
- var registered = registeredActions_1_1.value;
509
- var config = registered.config, name_2 = registered.name, scope = registered.scope;
510
- var middleware = buildActionMiddleware(model, options, registered);
511
- var routePath = scope === "instance" ? "/:id/".concat(name_2) : "/".concat(name_2);
512
- if (config.method === "GET") {
513
- router.get(routePath, middleware);
514
- }
515
- else {
516
- router.post(routePath, middleware);
517
- }
343
+ })),
344
+ ];
345
+ for (const registered of registeredActions) {
346
+ const { config, name, scope } = registered;
347
+ const middleware = buildActionMiddleware(model, options, registered);
348
+ const routePath = scope === "instance" ? `/:id/${name}` : `/${name}`;
349
+ if (config.method === "GET") {
350
+ router.get(routePath, middleware);
518
351
  }
519
- }
520
- catch (e_3_1) { e_3 = { error: e_3_1 }; }
521
- finally {
522
- try {
523
- if (registeredActions_1_1 && !registeredActions_1_1.done && (_a = registeredActions_1.return)) _a.call(registeredActions_1);
352
+ else {
353
+ router.post(routePath, middleware);
524
354
  }
525
- finally { if (e_3) throw e_3.error; }
526
355
  }
527
356
  };
528
357
  exports.registerActionRoutes = registerActionRoutes;