@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
@@ -0,0 +1,23 @@
1
+ import type { RequestHandler } from "express";
2
+ import type { User } from "../auth";
3
+ import type { MembershipDocument } from "../types/membership";
4
+ import type { OrganizationDocument } from "../types/organization";
5
+ export declare const ORGANIZATION_ID_HEADER = "x-organization-id";
6
+ export declare const ORGANIZATION_DISABLED_TITLE = "Organization is disabled";
7
+ export declare const PLATFORM_ORG_ROLE_NAMES: readonly ["operator", "superadmin"];
8
+ export interface ResolvedOrgContext {
9
+ membership?: MembershipDocument;
10
+ organization?: OrganizationDocument;
11
+ }
12
+ export declare const getOrgContext: () => ResolvedOrgContext | undefined;
13
+ export declare const runWithOrgContext: <T>(context: ResolvedOrgContext, fn: () => T) => T;
14
+ export declare const isPlatformOrgActor: (user?: User) => boolean;
15
+ export declare const assertOrganizationEnabled: (organization: OrganizationDocument) => void;
16
+ export declare const resolveOrgContext: (args: {
17
+ organizationId?: string;
18
+ required: boolean;
19
+ user?: User;
20
+ }) => Promise<ResolvedOrgContext>;
21
+ export declare const orgContextMiddleware: (options?: {
22
+ required?: boolean;
23
+ }) => RequestHandler;
@@ -0,0 +1,128 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.orgContextMiddleware = exports.resolveOrgContext = exports.assertOrganizationEnabled = exports.isPlatformOrgActor = exports.runWithOrgContext = exports.getOrgContext = exports.PLATFORM_ORG_ROLE_NAMES = exports.ORGANIZATION_DISABLED_TITLE = exports.ORGANIZATION_ID_HEADER = void 0;
4
+ const node_async_hooks_1 = require("node:async_hooks");
5
+ const errors_1 = require("../errors");
6
+ const utils_1 = require("../utils");
7
+ const organizationModel_1 = require("./organizationModel");
8
+ exports.ORGANIZATION_ID_HEADER = "x-organization-id";
9
+ exports.ORGANIZATION_DISABLED_TITLE = "Organization is disabled";
10
+ exports.PLATFORM_ORG_ROLE_NAMES = ["operator", "superadmin"];
11
+ const orgContextAls = new node_async_hooks_1.AsyncLocalStorage();
12
+ const getOrgContext = () => {
13
+ return orgContextAls.getStore();
14
+ };
15
+ exports.getOrgContext = getOrgContext;
16
+ const runWithOrgContext = (context, fn) => {
17
+ return orgContextAls.run(context, fn);
18
+ };
19
+ exports.runWithOrgContext = runWithOrgContext;
20
+ const isPlatformOrgActor = (user) => {
21
+ if (!user) {
22
+ return false;
23
+ }
24
+ const roles = user.roles ?? [];
25
+ return roles.includes("operator") || roles.includes("superadmin");
26
+ };
27
+ exports.isPlatformOrgActor = isPlatformOrgActor;
28
+ const readOrganizationIdHeader = (req) => {
29
+ const raw = req.header("X-Organization-Id");
30
+ if (typeof raw !== "string") {
31
+ return undefined;
32
+ }
33
+ const trimmed = raw.trim();
34
+ if (!trimmed) {
35
+ return undefined;
36
+ }
37
+ return trimmed;
38
+ };
39
+ const userIdForMembership = (user) => {
40
+ if (user._id) {
41
+ return String(user._id);
42
+ }
43
+ return user.id;
44
+ };
45
+ const loadOrganization = async (id) => {
46
+ if (!(0, utils_1.isValidObjectId)(id)) {
47
+ throw new errors_1.BadRequestError("Invalid organization id");
48
+ }
49
+ const organization = await organizationModel_1.Organization.findOneOrNone({ _id: id });
50
+ if (!organization) {
51
+ throw new errors_1.NotFoundError("Organization not found");
52
+ }
53
+ return organization;
54
+ };
55
+ const assertOrganizationEnabled = (organization) => {
56
+ if (organization.disabled) {
57
+ throw new errors_1.ForbiddenError(exports.ORGANIZATION_DISABLED_TITLE);
58
+ }
59
+ };
60
+ exports.assertOrganizationEnabled = assertOrganizationEnabled;
61
+ const resolveOrgContext = async (args) => {
62
+ const user = args.user;
63
+ if (!user?.id) {
64
+ if (args.required) {
65
+ throw new errors_1.APIError({ status: 401, title: "Unauthorized" });
66
+ }
67
+ return {};
68
+ }
69
+ const platform = (0, exports.isPlatformOrgActor)(user);
70
+ if (args.organizationId) {
71
+ const organization = await loadOrganization(args.organizationId);
72
+ (0, exports.assertOrganizationEnabled)(organization);
73
+ const membership = await organizationModel_1.Membership.findOneOrNone({
74
+ organizationId: organization._id,
75
+ status: "active",
76
+ userId: userIdForMembership(user),
77
+ });
78
+ if (!platform && !membership) {
79
+ throw new errors_1.ForbiddenError("Not a member of this organization");
80
+ }
81
+ return { membership: membership ?? undefined, organization };
82
+ }
83
+ if (!args.required) {
84
+ return {};
85
+ }
86
+ if (platform) {
87
+ throw new errors_1.BadRequestError("Organization context required");
88
+ }
89
+ const active = await organizationModel_1.Membership.findActiveForUser(userIdForMembership(user));
90
+ const adminMemberships = active.filter((row) => {
91
+ return row.roleName === "org-admin";
92
+ });
93
+ if (adminMemberships.length === 1) {
94
+ const membership = adminMemberships[0];
95
+ if (!membership) {
96
+ throw new errors_1.ForbiddenError("Organization context required");
97
+ }
98
+ const organization = await organizationModel_1.Organization.findExactlyOne({ _id: membership.organizationId });
99
+ (0, exports.assertOrganizationEnabled)(organization);
100
+ return { membership, organization };
101
+ }
102
+ if (adminMemberships.length > 1) {
103
+ throw new errors_1.BadRequestError("Select an organization");
104
+ }
105
+ throw new errors_1.ForbiddenError("Organization context required");
106
+ };
107
+ exports.resolveOrgContext = resolveOrgContext;
108
+ const orgContextMiddleware = (options) => {
109
+ const required = options?.required ?? false;
110
+ return async (req, _res, next) => {
111
+ try {
112
+ const context = await (0, exports.resolveOrgContext)({
113
+ organizationId: readOrganizationIdHeader(req),
114
+ required,
115
+ user: req.user,
116
+ });
117
+ req.organization = context.organization;
118
+ req.membership = context.membership;
119
+ orgContextAls.run(context, () => {
120
+ next();
121
+ });
122
+ }
123
+ catch (error) {
124
+ next(error);
125
+ }
126
+ };
127
+ };
128
+ exports.orgContextMiddleware = orgContextMiddleware;
@@ -0,0 +1,4 @@
1
+ import type { User } from "../auth";
2
+ import type { PermissionMethod } from "../permissions";
3
+ export declare const OrgQueryFilter: (_user?: User, _query?: Record<string, unknown>) => Record<string, unknown>;
4
+ export declare const isOrgMemberPermission: PermissionMethod<unknown>;
@@ -0,0 +1,38 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.isOrgMemberPermission = exports.OrgQueryFilter = void 0;
4
+ const errors_1 = require("../errors");
5
+ const organizationModel_1 = require("./organizationModel");
6
+ const orgContext_1 = require("./orgContext");
7
+ const OrgQueryFilter = (_user, _query) => {
8
+ const context = (0, orgContext_1.getOrgContext)();
9
+ if (!context?.organization) {
10
+ throw new errors_1.BadRequestError("Organization context required");
11
+ }
12
+ return { organizationId: context.organization._id };
13
+ };
14
+ exports.OrgQueryFilter = OrgQueryFilter;
15
+ const isOrgMemberPermission = async (_method, user, obj) => {
16
+ if (!obj) {
17
+ return true;
18
+ }
19
+ if (!user) {
20
+ return false;
21
+ }
22
+ const organizationId = obj.organizationId;
23
+ if (!organizationId) {
24
+ return false;
25
+ }
26
+ const context = (0, orgContext_1.getOrgContext)();
27
+ if (!context?.organization) {
28
+ return false;
29
+ }
30
+ if (String(context.organization._id) !== String(organizationId)) {
31
+ return false;
32
+ }
33
+ if ((0, orgContext_1.isPlatformOrgActor)(user)) {
34
+ return true;
35
+ }
36
+ return organizationModel_1.Membership.isMember(user.id, String(organizationId));
37
+ };
38
+ exports.isOrgMemberPermission = isOrgMemberPermission;
@@ -0,0 +1,13 @@
1
+ import mongoose, { type Schema } from "mongoose";
2
+ export interface OrgScoped {
3
+ organizationId: mongoose.Types.ObjectId;
4
+ }
5
+ export declare const ORGANIZATION_ID_IMMUTABLE_TITLE = "organizationId cannot be changed";
6
+ /** Rejects post-create changes to an existing `organizationId` schema path. */
7
+ export declare const organizationIdImmutabilityPlugin: (schema: Schema) => void;
8
+ /**
9
+ * Adds a required indexed `organizationId` so tenant-scoped consumer models cannot be saved
10
+ * without an organization. After creation, `organizationId` is immutable for REST, admin,
11
+ * sync, and direct saves.
12
+ */
13
+ export declare const orgScopedPlugin: (schema: Schema) => void;
@@ -0,0 +1,66 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.orgScopedPlugin = exports.organizationIdImmutabilityPlugin = exports.ORGANIZATION_ID_IMMUTABLE_TITLE = void 0;
7
+ const mongoose_1 = __importDefault(require("mongoose"));
8
+ const errors_1 = require("../errors");
9
+ exports.ORGANIZATION_ID_IMMUTABLE_TITLE = "organizationId cannot be changed";
10
+ const updateContainsOrganizationId = (value) => {
11
+ if (Array.isArray(value)) {
12
+ return value.some(updateContainsOrganizationId);
13
+ }
14
+ if (!value || typeof value !== "object") {
15
+ return false;
16
+ }
17
+ return Object.entries(value).some(([key, nestedValue]) => {
18
+ if (key === "organizationId" || key.startsWith("organizationId.")) {
19
+ return true;
20
+ }
21
+ if (key === "$rename" && nestedValue && typeof nestedValue === "object") {
22
+ return Object.entries(nestedValue).some(([source, target]) => {
23
+ return (source === "organizationId" ||
24
+ source.startsWith("organizationId.") ||
25
+ target === "organizationId" ||
26
+ String(target).startsWith("organizationId."));
27
+ });
28
+ }
29
+ return updateContainsOrganizationId(nestedValue);
30
+ });
31
+ };
32
+ /** Rejects post-create changes to an existing `organizationId` schema path. */
33
+ const organizationIdImmutabilityPlugin = (schema) => {
34
+ schema.pre("save", function () {
35
+ if (this.isNew || !this.isModified("organizationId")) {
36
+ return;
37
+ }
38
+ throw new errors_1.BadRequestError(exports.ORGANIZATION_ID_IMMUTABLE_TITLE);
39
+ });
40
+ schema.pre(["updateOne", "findOneAndUpdate"], function () {
41
+ const update = this.getUpdate();
42
+ if (!updateContainsOrganizationId(update)) {
43
+ return;
44
+ }
45
+ throw new errors_1.BadRequestError(exports.ORGANIZATION_ID_IMMUTABLE_TITLE);
46
+ });
47
+ };
48
+ exports.organizationIdImmutabilityPlugin = organizationIdImmutabilityPlugin;
49
+ /**
50
+ * Adds a required indexed `organizationId` so tenant-scoped consumer models cannot be saved
51
+ * without an organization. After creation, `organizationId` is immutable for REST, admin,
52
+ * sync, and direct saves.
53
+ */
54
+ const orgScopedPlugin = (schema) => {
55
+ schema.add({
56
+ organizationId: {
57
+ description: "Organization this document belongs to",
58
+ index: true,
59
+ ref: "TerrenoOrganization",
60
+ required: true,
61
+ type: mongoose_1.default.Schema.Types.ObjectId,
62
+ },
63
+ });
64
+ (0, exports.organizationIdImmutabilityPlugin)(schema);
65
+ };
66
+ exports.orgScopedPlugin = orgScopedPlugin;
@@ -0,0 +1,13 @@
1
+ import mongoose from "mongoose";
2
+ import type { MembershipModel } from "../types/membership";
3
+ import type { OrganizationModel } from "../types/organization";
4
+ export type { MembershipDocument, MembershipMethods, MembershipModel, MembershipRoleName, MembershipSchema, MembershipStatics, MembershipStatus, } from "../types/membership";
5
+ export type { OrganizationDocument, OrganizationMethods, OrganizationModel, OrganizationSchema, OrganizationSettings, OrganizationStatics, } from "../types/organization";
6
+ export declare const assertOrganizationSlugAvailable: (slug: string, excludeOrganizationId?: mongoose.Types.ObjectId) => Promise<void>;
7
+ export declare const organizationSlugFromName: (name: string) => string;
8
+ export declare const getOrganizationModel: () => OrganizationModel;
9
+ export declare const getMembershipModel: () => MembershipModel;
10
+ /** Lazy so importing `@terreno/api` does not register Organization until first use. */
11
+ export declare const Organization: OrganizationModel;
12
+ /** Lazy so importing `@terreno/api` does not register Membership until first use. */
13
+ export declare const Membership: MembershipModel;
@@ -0,0 +1,200 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.Membership = exports.Organization = exports.getMembershipModel = exports.getOrganizationModel = exports.organizationSlugFromName = exports.assertOrganizationSlugAvailable = void 0;
7
+ const mongoose_1 = __importDefault(require("mongoose"));
8
+ const errors_1 = require("../errors");
9
+ const plugins_1 = require("../plugins");
10
+ const organizationSettings_1 = require("./organizationSettings");
11
+ const MEMBERSHIP_ROLE_NAMES = ["org-admin", "member"];
12
+ const MEMBERSHIP_STATUSES = ["active", "suspended"];
13
+ const toObjectId = (value) => {
14
+ if (value instanceof mongoose_1.default.Types.ObjectId) {
15
+ return value;
16
+ }
17
+ return new mongoose_1.default.Types.ObjectId(value);
18
+ };
19
+ const assertOrganizationSlugAvailable = async (slug, excludeOrganizationId) => {
20
+ const query = { deleted: { $in: [true, false] }, slug };
21
+ if (excludeOrganizationId) {
22
+ query._id = { $ne: excludeOrganizationId };
23
+ }
24
+ const existing = await exports.Organization.findOneOrNone(query);
25
+ if (existing) {
26
+ throw new errors_1.ConflictError("Organization name already in use");
27
+ }
28
+ };
29
+ exports.assertOrganizationSlugAvailable = assertOrganizationSlugAvailable;
30
+ const organizationSlugFromName = (name) => {
31
+ const slug = name
32
+ .trim()
33
+ .toLowerCase()
34
+ .replace(/[^a-z0-9]+/g, "-")
35
+ .replace(/^-+|-+$/g, "");
36
+ if (!slug) {
37
+ throw new errors_1.APIError({
38
+ status: 400,
39
+ title: "Organization name must produce a slug",
40
+ });
41
+ }
42
+ return slug;
43
+ };
44
+ exports.organizationSlugFromName = organizationSlugFromName;
45
+ const organizationSchema = new mongoose_1.default.Schema({
46
+ disabled: {
47
+ default: false,
48
+ description: "Whether operators have disabled this organization",
49
+ type: Boolean,
50
+ },
51
+ name: {
52
+ description: "Human-readable organization name",
53
+ required: true,
54
+ trim: true,
55
+ type: String,
56
+ },
57
+ ownerId: {
58
+ description: "User who created the organization; transferable",
59
+ ref: "User",
60
+ required: true,
61
+ type: mongoose_1.default.Schema.Types.ObjectId,
62
+ },
63
+ settings: {
64
+ description: "App-defined organization settings object",
65
+ type: mongoose_1.default.Schema.Types.Mixed,
66
+ },
67
+ slug: {
68
+ description: "URL-safe unique identifier generated from the organization name",
69
+ required: true,
70
+ trim: true,
71
+ type: String,
72
+ unique: true,
73
+ },
74
+ }, { strict: "throw", toJSON: { virtuals: true }, toObject: { virtuals: true } });
75
+ organizationSchema.plugin(plugins_1.createdUpdatedPlugin);
76
+ organizationSchema.plugin(plugins_1.isDeletedPlugin);
77
+ organizationSchema.plugin(plugins_1.findOneOrNone);
78
+ organizationSchema.plugin(plugins_1.findExactlyOne);
79
+ organizationSchema.pre("validate", function () {
80
+ if (!this.slug) {
81
+ this.slug = (0, exports.organizationSlugFromName)(this.name);
82
+ }
83
+ if (!this.isModified("settings")) {
84
+ return;
85
+ }
86
+ this.settings = (0, organizationSettings_1.applyOrganizationSettings)(this.settings);
87
+ });
88
+ const membershipSchema = new mongoose_1.default.Schema({
89
+ organizationId: {
90
+ description: "Organization this membership belongs to",
91
+ index: true,
92
+ ref: "TerrenoOrganization",
93
+ required: true,
94
+ type: mongoose_1.default.Schema.Types.ObjectId,
95
+ },
96
+ roleName: {
97
+ default: "member",
98
+ description: "Per-organization role: org-admin or member",
99
+ enum: MEMBERSHIP_ROLE_NAMES,
100
+ required: true,
101
+ type: String,
102
+ },
103
+ status: {
104
+ default: "active",
105
+ description: "Whether this membership is active or suspended",
106
+ enum: MEMBERSHIP_STATUSES,
107
+ required: true,
108
+ type: String,
109
+ },
110
+ userId: {
111
+ description: "User who holds this membership",
112
+ index: true,
113
+ ref: "User",
114
+ required: true,
115
+ type: mongoose_1.default.Schema.Types.ObjectId,
116
+ },
117
+ }, { strict: "throw", toJSON: { virtuals: true }, toObject: { virtuals: true } });
118
+ membershipSchema.index({ organizationId: 1, userId: 1 }, { unique: true });
119
+ membershipSchema.plugin(plugins_1.createdUpdatedPlugin);
120
+ membershipSchema.plugin(plugins_1.isDeletedPlugin);
121
+ membershipSchema.plugin(plugins_1.findOneOrNone);
122
+ membershipSchema.plugin(plugins_1.findExactlyOne);
123
+ membershipSchema.statics = {
124
+ ...membershipSchema.statics,
125
+ async findActiveForUser(userId) {
126
+ return this.find({
127
+ status: "active",
128
+ userId: toObjectId(userId),
129
+ });
130
+ },
131
+ async isMember(userId, organizationId) {
132
+ const membership = await this.findOneOrNone({
133
+ organizationId: toObjectId(organizationId),
134
+ status: "active",
135
+ userId: toObjectId(userId),
136
+ });
137
+ return Boolean(membership);
138
+ },
139
+ async isOrgAdmin(userId, organizationId) {
140
+ const membership = await this.findOneOrNone({
141
+ organizationId: toObjectId(organizationId),
142
+ roleName: "org-admin",
143
+ status: "active",
144
+ userId: toObjectId(userId),
145
+ });
146
+ return Boolean(membership);
147
+ },
148
+ };
149
+ const getOrganizationModel = () => {
150
+ const existing = mongoose_1.default.models.TerrenoOrganization;
151
+ if (existing) {
152
+ return existing;
153
+ }
154
+ return mongoose_1.default.model("TerrenoOrganization", organizationSchema, "organizations");
155
+ };
156
+ exports.getOrganizationModel = getOrganizationModel;
157
+ const getMembershipModel = () => {
158
+ const existing = mongoose_1.default.models.TerrenoMembership;
159
+ if (existing) {
160
+ return existing;
161
+ }
162
+ return mongoose_1.default.model("TerrenoMembership", membershipSchema, "memberships");
163
+ };
164
+ exports.getMembershipModel = getMembershipModel;
165
+ const createLazyModel = (getModel) => {
166
+ const handler = {
167
+ apply(_target, thisArg, argArray) {
168
+ return Reflect.apply(getModel(), thisArg, argArray);
169
+ },
170
+ construct(_target, argArray) {
171
+ const Model = getModel();
172
+ return new Model(...argArray);
173
+ },
174
+ get(_target, prop) {
175
+ const model = getModel();
176
+ const value = Reflect.get(model, prop, model);
177
+ if (typeof value === "function") {
178
+ return value.bind(model);
179
+ }
180
+ return value;
181
+ },
182
+ getPrototypeOf() {
183
+ return Object.getPrototypeOf(getModel());
184
+ },
185
+ has(_target, prop) {
186
+ return prop in getModel();
187
+ },
188
+ set(_target, prop, value) {
189
+ Reflect.set(getModel(), prop, value);
190
+ return true;
191
+ },
192
+ };
193
+ class LazyMongooseModel {
194
+ }
195
+ return new Proxy(LazyMongooseModel, handler);
196
+ };
197
+ /** Lazy so importing `@terreno/api` does not register Organization until first use. */
198
+ exports.Organization = createLazyModel(exports.getOrganizationModel);
199
+ /** Lazy so importing `@terreno/api` does not register Membership until first use. */
200
+ exports.Membership = createLazyModel(exports.getMembershipModel);
@@ -0,0 +1,19 @@
1
+ import mongoose from "mongoose";
2
+ import type { OrganizationSettings } from "../types/organization";
3
+ /**
4
+ * Build a nested Mongoose schema for `Organization.settings`.
5
+ * Fields should be optional or have defaults so existing organizations still validate.
6
+ */
7
+ export declare const createOrganizationSettingsSchema: (definition: mongoose.SchemaDefinition, options?: mongoose.SchemaOptions) => mongoose.Schema;
8
+ /** Register the app settings schema. Call before creating or patching organizations. */
9
+ export declare const registerOrganizationSettings: (schema?: mongoose.Schema) => void;
10
+ export declare const getOrganizationSettingsSchema: () => mongoose.Schema | undefined;
11
+ /**
12
+ * Validate and cast `Organization.settings` when a schema is registered.
13
+ * With no schema, Mixed values pass through unchanged.
14
+ */
15
+ export declare const applyOrganizationSettings: <TSettings extends OrganizationSettings = OrganizationSettings>(settings: unknown) => TSettings | undefined;
16
+ /** Read typed settings from an organization document or API payload. */
17
+ export declare const organizationSettingsOf: <TSettings extends OrganizationSettings = OrganizationSettings>(organization: {
18
+ settings?: TSettings | null;
19
+ }) => TSettings;
@@ -0,0 +1,113 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.organizationSettingsOf = exports.applyOrganizationSettings = exports.getOrganizationSettingsSchema = exports.registerOrganizationSettings = exports.createOrganizationSettingsSchema = void 0;
7
+ const mongoose_1 = __importDefault(require("mongoose"));
8
+ const errors_1 = require("../errors");
9
+ const SETTINGS_VALIDATOR_MODEL = "__TerrenoOrganizationSettings";
10
+ let registeredOrganizationSettingsSchema;
11
+ const dropSettingsValidatorModel = () => {
12
+ const existing = mongoose_1.default.models[SETTINGS_VALIDATOR_MODEL];
13
+ if (existing) {
14
+ mongoose_1.default.deleteModel(SETTINGS_VALIDATOR_MODEL);
15
+ }
16
+ };
17
+ /**
18
+ * Build a nested Mongoose schema for `Organization.settings`.
19
+ * Fields should be optional or have defaults so existing organizations still validate.
20
+ */
21
+ const createOrganizationSettingsSchema = (definition, options) => {
22
+ return new mongoose_1.default.Schema(definition, {
23
+ _id: false,
24
+ id: false,
25
+ strict: "throw",
26
+ ...options,
27
+ });
28
+ };
29
+ exports.createOrganizationSettingsSchema = createOrganizationSettingsSchema;
30
+ /** Register the app settings schema. Call before creating or patching organizations. */
31
+ const registerOrganizationSettings = (schema) => {
32
+ dropSettingsValidatorModel();
33
+ registeredOrganizationSettingsSchema = schema;
34
+ };
35
+ exports.registerOrganizationSettings = registerOrganizationSettings;
36
+ const getOrganizationSettingsSchema = () => {
37
+ return registeredOrganizationSettingsSchema;
38
+ };
39
+ exports.getOrganizationSettingsSchema = getOrganizationSettingsSchema;
40
+ const settingsValidationMessage = (error) => {
41
+ if (error instanceof mongoose_1.default.Error.ValidationError) {
42
+ return Object.values(error.errors)
43
+ .map((fieldError) => fieldError.message)
44
+ .join("; ");
45
+ }
46
+ if (error instanceof Error) {
47
+ return error.message;
48
+ }
49
+ return "Organization settings are invalid";
50
+ };
51
+ const getSettingsValidatorModel = (schema) => {
52
+ const existing = mongoose_1.default.models[SETTINGS_VALIDATOR_MODEL];
53
+ if (existing) {
54
+ return existing;
55
+ }
56
+ return mongoose_1.default.model(SETTINGS_VALIDATOR_MODEL, schema, undefined, {
57
+ overwriteModels: true,
58
+ });
59
+ };
60
+ /**
61
+ * Validate and cast `Organization.settings` when a schema is registered.
62
+ * With no schema, Mixed values pass through unchanged.
63
+ */
64
+ const applyOrganizationSettings = (settings) => {
65
+ if (settings === undefined || settings === null) {
66
+ return undefined;
67
+ }
68
+ const schema = registeredOrganizationSettingsSchema;
69
+ if (!schema) {
70
+ return settings;
71
+ }
72
+ if (typeof settings !== "object" || Array.isArray(settings)) {
73
+ throw new errors_1.ValidationError({
74
+ fields: { settings: "Organization settings must be an object" },
75
+ title: "Organization settings must be an object",
76
+ });
77
+ }
78
+ try {
79
+ const unknownKeys = Object.keys(settings).filter((key) => {
80
+ return schema.path(key) === undefined;
81
+ });
82
+ if (unknownKeys.length > 0) {
83
+ throw new errors_1.ValidationError({
84
+ fields: { settings: `Unknown settings field: ${unknownKeys.join(", ")}` },
85
+ title: "Organization settings are invalid",
86
+ });
87
+ }
88
+ const ValidatorModel = getSettingsValidatorModel(schema);
89
+ const document = new ValidatorModel(settings);
90
+ const validationError = document.validateSync();
91
+ if (validationError) {
92
+ throw validationError;
93
+ }
94
+ return document.toObject({ versionKey: false });
95
+ }
96
+ catch (error) {
97
+ if (error instanceof errors_1.ValidationError) {
98
+ throw error;
99
+ }
100
+ throw new errors_1.ValidationError({
101
+ cause: error instanceof Error ? error : undefined,
102
+ detail: settingsValidationMessage(error),
103
+ fields: { settings: settingsValidationMessage(error) },
104
+ title: "Organization settings are invalid",
105
+ });
106
+ }
107
+ };
108
+ exports.applyOrganizationSettings = applyOrganizationSettings;
109
+ /** Read typed settings from an organization document or API payload. */
110
+ const organizationSettingsOf = (organization) => {
111
+ return (organization.settings ?? {});
112
+ };
113
+ exports.organizationSettingsOf = organizationSettingsOf;
@@ -0,0 +1,28 @@
1
+ import type express from "express";
2
+ import { type Application } from "express";
3
+ import type mongoose from "mongoose";
4
+ import { type UserModel } from "../auth";
5
+ import type { AnyTerrenoAccess } from "../rbac/types";
6
+ import type { TerrenoPlugin } from "../terrenoPlugin";
7
+ export interface OrgAuditEvent {
8
+ actorId?: string;
9
+ organizationId?: string;
10
+ organizationLabel?: string;
11
+ verb: "created" | "updated" | "disabled" | "deleted" | "memberAttached" | "memberUpdated" | "memberRemoved";
12
+ }
13
+ export interface OrgsAppOptions {
14
+ access: AnyTerrenoAccess;
15
+ basePath?: string;
16
+ onOrgAudit?: (event: OrgAuditEvent, req: express.Request) => void | Promise<void>;
17
+ /** Nested schema for `Organization.settings`. Same as `registerOrganizationSettings`. */
18
+ settingsSchema?: mongoose.Schema;
19
+ userModel: UserModel;
20
+ }
21
+ export declare class OrgsApp implements TerrenoPlugin {
22
+ private readonly access;
23
+ private readonly basePath;
24
+ private readonly onOrgAudit?;
25
+ private readonly userModel;
26
+ constructor(options: OrgsAppOptions);
27
+ register(app: Application, openApi?: unknown): void;
28
+ }