@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,114 @@
1
+ /**
2
+ * Tests for TerrenoApp `migrations.runOnStart` (wet up after connect, before listen).
3
+ */
4
+ import {beforeEach, describe, expect, it} from "bun:test";
5
+ import {join} from "node:path";
6
+ import mongoose from "mongoose";
7
+ import type {UserModel as UserModelType} from "./auth";
8
+ import {runStartupMigrations} from "./migrations/runner";
9
+ import {MIGRATION_LOCK_ID, MIGRATIONS_COLLECTION} from "./migrations/types";
10
+ import {TerrenoApp} from "./terrenoApp";
11
+ import {setupDb, UserModel} from "./tests";
12
+
13
+ const fixtures = (...parts: string[]): string => {
14
+ return join(import.meta.dir, "migrations", "fixtures", ...parts);
15
+ };
16
+
17
+ const appliedIds = async (): Promise<string[]> => {
18
+ const docs = await mongoose.connection
19
+ .collection(MIGRATIONS_COLLECTION)
20
+ .find({_id: {$ne: MIGRATION_LOCK_ID}})
21
+ .project({id: 1})
22
+ .toArray();
23
+ return docs.map((doc) => String(doc.id)).sort();
24
+ };
25
+
26
+ describe("runStartupMigrations", () => {
27
+ beforeEach(async () => {
28
+ await setupDb();
29
+ await mongoose.connection.collection(MIGRATIONS_COLLECTION).deleteMany({});
30
+ });
31
+
32
+ it("does not run when migrations option is omitted", async () => {
33
+ const result = await runStartupMigrations({
34
+ env: {NODE_ENV: "test"},
35
+ mongoose,
36
+ });
37
+ expect(result.ran).toBe(false);
38
+ expect(await appliedIds()).toEqual([]);
39
+ });
40
+
41
+ it("does not run when runOnStart is omitted", async () => {
42
+ const result = await runStartupMigrations({
43
+ env: {NODE_ENV: "test"},
44
+ migrations: {dir: fixtures("valid")},
45
+ mongoose,
46
+ });
47
+ expect(result.ran).toBe(false);
48
+ expect(await appliedIds()).toEqual([]);
49
+ });
50
+
51
+ it("applies pending files when runOnStart is true", async () => {
52
+ const result = await runStartupMigrations({
53
+ env: {NODE_ENV: "test"},
54
+ migrations: {dir: fixtures("valid"), runOnStart: true},
55
+ mongoose,
56
+ });
57
+ expect(result.ran).toBe(true);
58
+ expect(result.applied).toEqual(["20260910120000-alpha", "20260910120001-beta"]);
59
+ expect(await appliedIds()).toEqual(["20260910120000-alpha", "20260910120001-beta"]);
60
+ });
61
+
62
+ it("throws in production without ALLOW_MIGRATIONS before applying", async () => {
63
+ await expect(
64
+ runStartupMigrations({
65
+ env: {NODE_ENV: "production"},
66
+ migrations: {dir: fixtures("valid"), runOnStart: true},
67
+ mongoose,
68
+ })
69
+ ).rejects.toThrow("Migrations not allowed");
70
+ expect(await appliedIds()).toEqual([]);
71
+ });
72
+ });
73
+
74
+ describe("TerrenoApp start migrations", () => {
75
+ const typedUserModel = UserModel as unknown as UserModelType;
76
+
77
+ beforeEach(async () => {
78
+ await setupDb();
79
+ await mongoose.connection.collection(MIGRATIONS_COLLECTION).deleteMany({});
80
+ });
81
+
82
+ it("applies pending files through start() when runOnStart is true", async () => {
83
+ const app = new TerrenoApp({
84
+ migrations: {dir: fixtures("valid"), runOnStart: true},
85
+ skipListen: true,
86
+ userModel: typedUserModel,
87
+ });
88
+ app.start();
89
+ await app.whenReady();
90
+ expect(await appliedIds()).toEqual(["20260910120000-alpha", "20260910120001-beta"]);
91
+ });
92
+
93
+ it("rejects whenReady in production without ALLOW_MIGRATIONS and does not listen", async () => {
94
+ const previousNodeEnv = process.env.NODE_ENV;
95
+ process.env.NODE_ENV = "production";
96
+ Reflect.deleteProperty(process.env, "ALLOW_MIGRATIONS");
97
+ try {
98
+ const app = new TerrenoApp({
99
+ migrations: {dir: fixtures("valid"), runOnStart: true},
100
+ skipListen: true,
101
+ userModel: typedUserModel,
102
+ });
103
+ app.start();
104
+ await expect(app.whenReady()).rejects.toThrow("Migrations not allowed");
105
+ expect(await appliedIds()).toEqual([]);
106
+ } finally {
107
+ if (previousNodeEnv === undefined) {
108
+ Reflect.deleteProperty(process.env, "NODE_ENV");
109
+ } else {
110
+ process.env.NODE_ENV = previousNodeEnv;
111
+ }
112
+ }
113
+ });
114
+ });
@@ -9,6 +9,8 @@ import {configurationPlugin} from "./configurationPlugin";
9
9
  import {APIError} from "./errors";
10
10
  import {Permissions} from "./permissions";
11
11
  import {createdUpdatedPlugin} from "./plugins";
12
+ import {createAccess} from "./rbac/access";
13
+ import {terrenoStatements} from "./rbac/statements";
12
14
  import {TerrenoApp} from "./terrenoApp";
13
15
  import type {TerrenoPlugin} from "./terrenoPlugin";
14
16
  import {authAsUser, FoodModel, setupDb, UserModel} from "./tests";
@@ -74,6 +76,45 @@ describe("TerrenoApp", () => {
74
76
 
75
77
  expect(app).toBeDefined();
76
78
  });
79
+
80
+ it("does not mount /orgs when organizations is omitted", async () => {
81
+ const app = new TerrenoApp({
82
+ skipListen: true,
83
+ userModel: typedUserModel,
84
+ }).start();
85
+
86
+ const res = await supertest(app).get("/orgs");
87
+ expect(res.status).toBe(404);
88
+ });
89
+
90
+ it("requires accessControl when organizations is true", () => {
91
+ expect(() =>
92
+ new TerrenoApp({
93
+ organizations: true,
94
+ skipListen: true,
95
+ userModel: typedUserModel,
96
+ }).start()
97
+ ).toThrow("organizations requires accessControl");
98
+ });
99
+
100
+ it("mounts /orgs when organizations is true", async () => {
101
+ await setupDb();
102
+ const access = createAccess({
103
+ connection: mongoose.connection,
104
+ organizations: true,
105
+ statements: terrenoStatements,
106
+ userModel: typedUserModel,
107
+ });
108
+ const app = new TerrenoApp({
109
+ accessControl: access,
110
+ organizations: true,
111
+ skipListen: true,
112
+ userModel: typedUserModel,
113
+ }).start();
114
+
115
+ const res = await supertest(app).get("/orgs");
116
+ expect(res.status).not.toBe(404);
117
+ });
77
118
  });
78
119
 
79
120
  describe("register with modelRouter", () => {
package/src/terrenoApp.ts CHANGED
@@ -1,8 +1,9 @@
1
1
  import {EventEmitter} from "node:events";
2
- import {createServer} from "node:http";
2
+ import {createServer, type Server as HttpServer} from "node:http";
3
3
  import * as Sentry from "@sentry/bun";
4
4
  import cors from "cors";
5
5
  import express from "express";
6
+ import mongoose from "mongoose";
6
7
  import qs from "qs";
7
8
  import type {AdminChangeEvent, TerrenoAppAdminEvent} from "./adminTypes";
8
9
  import type {ModelRouterRegistration} from "./api";
@@ -12,12 +13,14 @@ import {
12
13
  type BetterAuthInstance,
13
14
  createBetterAuthSessionMiddleware,
14
15
  } from "./betterAuthSetup";
16
+ import {addTerrenoDevBrowserLogsRoute} from "./browserLogsRoute";
15
17
  import {
16
18
  ConfigurationApp,
17
19
  type ConfigurationAppOptions,
18
20
  type ConfigurationModelLike,
19
21
  } from "./configurationApp";
20
22
  import {
23
+ APIError,
21
24
  apiErrorMiddleware,
22
25
  apiFallthroughErrorMiddleware,
23
26
  apiUnauthorizedMiddleware,
@@ -32,8 +35,10 @@ import {
32
35
  resolveMcpServiceTokensOption,
33
36
  } from "./mcp/serviceTokens";
34
37
  import {jsonResponseRequestIdMiddleware} from "./middleware";
38
+ import {runStartupMigrations, type StartupMigrationsOption} from "./migrations/runner";
35
39
  import {openApiCompatMiddleware, patchAppUse} from "./openApiCompat";
36
40
  import {openApiEtagMiddleware} from "./openApiEtag";
41
+ import {OrgsApp, type OrgsAppOptions} from "./orgs/orgsApp";
37
42
  import {applyRateLimitTrustProxy} from "./rateLimit/applyTrustProxy";
38
43
  import {createRateLimitStore} from "./rateLimit/createStore";
39
44
  import {createRateLimitMiddleware} from "./rateLimit/middleware";
@@ -87,6 +92,12 @@ export interface TerrenoAppOptions {
87
92
  githubAuth?: GitHubAuthOptions;
88
93
  /** Skip calling app.listen() in start() method (useful for testing) */
89
94
  skipListen?: boolean;
95
+ /**
96
+ * Already-listening HTTP server. `start()` attaches the Express app to it
97
+ * instead of creating and binding a new server, so Cloud Run can see PORT
98
+ * before MongoDB connect and plugin registration finish.
99
+ */
100
+ httpServer?: HttpServer;
90
101
  /** Sentry configuration options */
91
102
  sentryOptions?: Sentry.BunOptions;
92
103
  /** Maximum number of array items in query parameters (default: 200) */
@@ -104,6 +115,13 @@ export interface TerrenoAppOptions {
104
115
  * RBAC access controller injected into model routers and `/auth/me` enrichment.
105
116
  */
106
117
  accessControl?: import("./rbac/types").AnyTerrenoAccess;
118
+ /**
119
+ * Multi-tenant organizations. Default off so existing single-tenant apps stay unchanged.
120
+ * New apps from `terreno_bootstrap_app` pass `true`. Requires `accessControl` from
121
+ * `createAccess({ organizations: true })`. Pass `{ settingsSchema }` to type and
122
+ * validate `Organization.settings`.
123
+ */
124
+ organizations?: boolean | Omit<OrgsAppOptions, "access" | "userModel">;
107
125
  /**
108
126
  * Runs after CORS and before the `addMiddleware` chain and JSON body parsing.
109
127
  * Use to attach early middleware via `app.use(...)` before JSON parsing.
@@ -125,6 +143,12 @@ export interface TerrenoAppOptions {
125
143
  * mounts `/mcp/service-tokens` and accepts `Authorization: Bearer mcp_…` on `/mcp`.
126
144
  */
127
145
  mcpServiceTokens?: McpServiceTokensAppOption;
146
+ /**
147
+ * Versioned MongoDB migrations. `runOnStart` defaults to false. When true, wet `up`
148
+ * runs after listen and `ensureSyncIndexes`. Production still requires
149
+ * `ALLOW_MIGRATIONS=true`.
150
+ */
151
+ migrations?: StartupMigrationsOption;
128
152
  }
129
153
 
130
154
  /**
@@ -195,6 +219,7 @@ export class TerrenoApp {
195
219
  private middlewareFns: (express.RequestHandler | ((app: express.Application) => void))[] = [];
196
220
  private configurationApp: ConfigurationApp | null = null;
197
221
  private readonly adminEvents = new EventEmitter();
222
+ private bootPromise: Promise<void> = Promise.resolve();
198
223
 
199
224
  /**
200
225
  * Create a new TerrenoApp builder.
@@ -401,6 +426,8 @@ export class TerrenoApp {
401
426
  app.use(createRateLimitMiddleware(store, rateLimit));
402
427
  }
403
428
 
429
+ addTerrenoDevBrowserLogsRoute(app);
430
+
404
431
  if (!options.authOptions) {
405
432
  options.authOptions = {};
406
433
  }
@@ -546,6 +573,31 @@ export class TerrenoApp {
546
573
  * ```
547
574
  */
548
575
  start(): express.Application {
576
+ if (this.options.organizations) {
577
+ if (!this.options.accessControl) {
578
+ throw new APIError({
579
+ status: 500,
580
+ title:
581
+ "TerrenoApp organizations requires accessControl from createAccess({ organizations: true })",
582
+ });
583
+ }
584
+ const hasOrgsPlugin = this.registrations.some(
585
+ (registration) =>
586
+ !this.isModelRouterRegistration(registration) && registration instanceof OrgsApp
587
+ );
588
+ if (!hasOrgsPlugin) {
589
+ const orgConfig =
590
+ typeof this.options.organizations === "object" ? this.options.organizations : {};
591
+ this.register(
592
+ new OrgsApp({
593
+ ...orgConfig,
594
+ access: this.options.accessControl,
595
+ userModel: this.options.userModel,
596
+ })
597
+ );
598
+ }
599
+ }
600
+
549
601
  // If realtime option is set, auto-register the RealtimeApp plugin
550
602
  if (this.options.realtime) {
551
603
  const hasRealtimePlugin = this.registrations.some(
@@ -568,41 +620,55 @@ export class TerrenoApp {
568
620
  }
569
621
 
570
622
  const app = this.build();
623
+ this.bootPromise = this.completeStart(app);
624
+ if (!this.options.skipListen) {
625
+ void this.bootPromise.catch((error: unknown) => {
626
+ const stack = error instanceof Error ? error.stack : String(error);
627
+ logger.error(`Error trying to start HTTP server: ${error}\n${stack}`);
628
+ process.exit(1);
629
+ });
630
+ }
631
+ return app;
632
+ }
571
633
 
634
+ /**
635
+ * Resolves after startup migrations (and listen, unless `skipListen`).
636
+ * Tests with `skipListen` should await this instead of assuming `start()` is idle.
637
+ */
638
+ whenReady(): Promise<void> {
639
+ return this.bootPromise;
640
+ }
641
+
642
+ private completeStart = async (app: express.Application): Promise<void> => {
572
643
  if (!this.options.skipListen) {
573
644
  const port = process.env.PORT || "9000";
574
- // Await sync index creation before listening: the per-model snapshot indexes (a
575
- // failed createIndex degrades the snapshot/catch-up query to a table scan) and the
576
- // bookkeeping-model indexes enqueued by SyncApp (the unique mutationId index is what
577
- // makes duplicate mutation deliveries idempotent, and the unique stream index is what
578
- // keeps the counter upsert race from minting duplicate seqs). Either failure is a
579
- // loud startup error rather than a silent correctness cliff. No-op when no sync
580
- // models or SyncApp are registered. Detached because start() returns synchronously.
581
- void (async (): Promise<void> => {
582
- try {
583
- await ensureSyncIndexes();
584
- const server = createServer(app);
585
-
586
- // Notify plugins that need access to the HTTP server (e.g. WebSocket plugins)
587
- for (const reg of this.registrations) {
588
- if (!this.isModelRouterRegistration(reg) && typeof reg.onServerCreated === "function") {
589
- reg.onServerCreated(server);
590
- }
591
- }
592
-
593
- server.listen(port, () => {
594
- logger.info(`Listening on port ${port}`);
595
- });
596
- } catch (error) {
597
- const stack = error instanceof Error ? error.stack : String(error);
598
- logger.error(`Error trying to start HTTP server: ${error}\n${stack}`);
599
- process.exit(1);
645
+ const existingServer = this.options.httpServer;
646
+ const server = existingServer ?? createServer(app);
647
+ if (existingServer) {
648
+ existingServer.removeAllListeners("request");
649
+ existingServer.on("request", app);
650
+ }
651
+ for (const reg of this.registrations) {
652
+ if (!this.isModelRouterRegistration(reg) && typeof reg.onServerCreated === "function") {
653
+ reg.onServerCreated(server);
600
654
  }
601
- })();
655
+ }
656
+ // Bind PORT before index/migration work so Cloud Run's startup probe can
657
+ // succeed while `ensureSyncIndexes` still runs. whenReady() still waits.
658
+ if (!existingServer) {
659
+ server.listen(port, () => {
660
+ logger.info(`Listening on port ${port}`);
661
+ });
662
+ } else {
663
+ logger.info(`Listening on port ${port}`);
664
+ }
665
+ await ensureSyncIndexes();
602
666
  }
603
-
604
- return app;
605
- }
667
+ await runStartupMigrations({
668
+ migrations: this.options.migrations,
669
+ mongoose,
670
+ });
671
+ };
606
672
 
607
673
  private isModelRouterRegistration(
608
674
  registration: ModelRouterRegistration | TerrenoPlugin
@@ -40,7 +40,7 @@ export const createTestUsers = async (): Promise<TestUsers> => {
40
40
  return {admin, adminOther, notAdmin};
41
41
  };
42
42
 
43
- export const createStandardFoods = async (users: TestUsers): Promise<TestFoods> => {
43
+ const createStandardFoods = async (users: TestUsers): Promise<TestFoods> => {
44
44
  const {admin, adminOther, notAdmin} = users;
45
45
 
46
46
  const [spinach, apple, carrots, pizza] = await Promise.all([
@@ -106,7 +106,7 @@ export const createStandardFoods = async (users: TestUsers): Promise<TestFoods>
106
106
  return {apple, carrots, pizza, spinach};
107
107
  };
108
108
 
109
- export const createRequiredFixtures = async (): Promise<TestRequired> => {
109
+ const createRequiredFixtures = async (): Promise<TestRequired> => {
110
110
  const [sample, withAbout] = await Promise.all([
111
111
  RequiredModel.create({name: "Sample Required"}),
112
112
  RequiredModel.create({about: "Optional about text", name: "Required With About"}),
@@ -16,6 +16,7 @@ export interface User {
16
16
  age?: number;
17
17
  disabled?: boolean;
18
18
  organizationIds?: string[];
19
+ roles?: string[];
19
20
  tokenEpoch?: number;
20
21
  emailVerified?: boolean;
21
22
  }
@@ -70,6 +71,11 @@ const userSchema = new Schema<User>({
70
71
  description: "Organization memberships",
71
72
  type: [String],
72
73
  },
74
+ roles: {
75
+ default: [],
76
+ description: "RBAC role names assigned to this user",
77
+ type: [String],
78
+ },
73
79
  tokenEpoch: {
74
80
  default: 0,
75
81
  description: "Incremented on password reset to invalidate outstanding refresh tokens",
@@ -82,10 +88,12 @@ userSchema.plugin(
82
88
  passportLocalMongoose as unknown as (schema: Schema, options?: Record<string, unknown>) => void,
83
89
  {
84
90
  attemptsField: "attempts",
85
- interval: process.env.NODE_ENV === "test" ? 1 : 100,
91
+ interval: 1,
86
92
  limitAttempts: true,
87
93
  maxAttempts: 3,
88
- maxInterval: process.env.NODE_ENV === "test" ? 1 : 300000,
94
+ // Test-only schema: maxInterval 0 caps calculatedInterval at 0 so AttemptTooSoon
95
+ // never preempts maxAttempts lockout under rapid supertest logins.
96
+ maxInterval: 0,
89
97
  usernameCaseInsensitive: true,
90
98
  usernameField: "email",
91
99
  }
@@ -7,7 +7,7 @@ import type {TestData} from "./types";
7
7
 
8
8
  const defaultTestMongoUri = "mongodb://127.0.0.1/terreno?&connectTimeoutMS=360000";
9
9
 
10
- export const applyTestAuthEnv = (): void => {
10
+ const applyTestAuthEnv = (): void => {
11
11
  process.env.REFRESH_TOKEN_SECRET = "refresh_secret";
12
12
  process.env.TOKEN_SECRET = "secret";
13
13
  process.env.TOKEN_EXPIRES_IN = "30m";
@@ -47,9 +47,3 @@ export const setupTestData = async (): Promise<TestData> => {
47
47
 
48
48
  return createTestData();
49
49
  };
50
-
51
- /** Clears all API test collections without re-seeding. */
52
- export const resetTestCollections = clearTestCollections;
53
-
54
- export {createTestData} from "./createTestData";
55
- export {loadTestData} from "./mongoTestSetup";
@@ -3,9 +3,9 @@ import type {FindExactlyOnePlugin, FindOneOrNonePlugin} from "../plugins";
3
3
 
4
4
  export type AuthTokenType = "passwordReset" | "emailVerification";
5
5
 
6
- export type AuthTokenMethods = Record<string, never>;
6
+ type AuthTokenMethods = Record<string, never>;
7
7
 
8
- export interface AuthTokenStatics
8
+ interface AuthTokenStatics
9
9
  extends FindExactlyOnePlugin<AuthTokenDocument>,
10
10
  FindOneOrNonePlugin<AuthTokenDocument> {
11
11
  consume: (
@@ -29,8 +29,6 @@ export interface AuthTokenModel
29
29
  extends mongoose.Model<AuthTokenDocument, object, AuthTokenMethods>,
30
30
  AuthTokenStatics {}
31
31
 
32
- export type AuthTokenSchema = mongoose.Schema<AuthTokenDocument, AuthTokenModel, AuthTokenMethods>;
33
-
34
32
  export interface AuthTokenDocument extends mongoose.Document {
35
33
  _id: mongoose.Types.ObjectId;
36
34
  userId: mongoose.Types.ObjectId;
@@ -6,7 +6,7 @@ export interface McpServiceTokenIssueOptions {
6
6
  name: string;
7
7
  }
8
8
 
9
- export interface McpServiceTokenMethods {
9
+ interface McpServiceTokenMethods {
10
10
  deleteOne: (this: McpServiceTokenDocument) => Promise<McpServiceTokenDocument>;
11
11
  }
12
12
 
@@ -34,12 +34,6 @@ export interface McpServiceTokenModel
34
34
  extends mongoose.Model<McpServiceTokenDocument, object, McpServiceTokenMethods>,
35
35
  McpServiceTokenStatics {}
36
36
 
37
- export type McpServiceTokenSchema = mongoose.Schema<
38
- McpServiceTokenDocument,
39
- McpServiceTokenModel,
40
- McpServiceTokenMethods
41
- >;
42
-
43
37
  export interface McpServiceTokenDocument extends mongoose.Document {
44
38
  _id: mongoose.Types.ObjectId;
45
39
  created: Date;
@@ -0,0 +1,48 @@
1
+ import type mongoose from "mongoose";
2
+ import type {FindExactlyOnePlugin, FindOneOrNonePlugin} from "../plugins";
3
+
4
+ export type MembershipRoleName = "org-admin" | "member";
5
+ export type MembershipStatus = "active" | "suspended";
6
+
7
+ // biome-ignore lint/complexity/noBannedTypes: No instance methods.
8
+ export type MembershipMethods = {};
9
+
10
+ export interface MembershipStatics
11
+ extends FindExactlyOnePlugin<MembershipDocument>,
12
+ FindOneOrNonePlugin<MembershipDocument> {
13
+ findActiveForUser: (
14
+ this: MembershipModel,
15
+ userId: mongoose.Types.ObjectId | string
16
+ ) => Promise<MembershipDocument[]>;
17
+ isMember: (
18
+ this: MembershipModel,
19
+ userId: mongoose.Types.ObjectId | string,
20
+ organizationId: mongoose.Types.ObjectId | string
21
+ ) => Promise<boolean>;
22
+ isOrgAdmin: (
23
+ this: MembershipModel,
24
+ userId: mongoose.Types.ObjectId | string,
25
+ organizationId: mongoose.Types.ObjectId | string
26
+ ) => Promise<boolean>;
27
+ }
28
+
29
+ export interface MembershipModel
30
+ extends mongoose.Model<MembershipDocument, object, MembershipMethods>,
31
+ MembershipStatics {}
32
+
33
+ export type MembershipSchema = mongoose.Schema<
34
+ MembershipDocument,
35
+ MembershipModel,
36
+ MembershipMethods
37
+ >;
38
+
39
+ export interface MembershipDocument extends mongoose.Document {
40
+ _id: mongoose.Types.ObjectId;
41
+ created: Date;
42
+ deleted: boolean;
43
+ organizationId: mongoose.Types.ObjectId;
44
+ roleName: MembershipRoleName;
45
+ status: MembershipStatus;
46
+ updated: Date;
47
+ userId: mongoose.Types.ObjectId;
48
+ }
@@ -0,0 +1,34 @@
1
+ import type mongoose from "mongoose";
2
+ import type {FindExactlyOnePlugin, FindOneOrNonePlugin} from "../plugins";
3
+
4
+ type NotificationMethods = Record<never, never>;
5
+
6
+ interface NotificationStatics
7
+ extends FindExactlyOnePlugin<NotificationDocument>,
8
+ FindOneOrNonePlugin<NotificationDocument> {}
9
+
10
+ export interface NotificationModel
11
+ extends mongoose.Model<NotificationDocument, object, NotificationMethods>,
12
+ NotificationStatics {}
13
+
14
+ export interface NotificationDocument extends mongoose.Document<string>, NotificationMethods {
15
+ _id: string;
16
+ archivedAt: Date | null;
17
+ body: string;
18
+ href?: string;
19
+ kind?: string;
20
+ ownerId: mongoose.Types.ObjectId;
21
+ readAt: Date | null;
22
+ title: string;
23
+ created: Date;
24
+ updated: Date;
25
+ deleted: boolean;
26
+ }
27
+
28
+ export interface NotifyInput {
29
+ body: string;
30
+ href?: string;
31
+ kind?: string;
32
+ title: string;
33
+ userId: string;
34
+ }
@@ -0,0 +1,28 @@
1
+ import type mongoose from "mongoose";
2
+ import type {FindExactlyOnePlugin, FindOneOrNonePlugin} from "../plugins";
3
+
4
+ export type NotificationPreferenceChannel = "inapp" | "mail" | "push" | "sms";
5
+
6
+ type NotificationPreferenceMethods = Record<never, never>;
7
+
8
+ interface NotificationPreferenceStatics
9
+ extends FindExactlyOnePlugin<NotificationPreferenceDocument>,
10
+ FindOneOrNonePlugin<NotificationPreferenceDocument> {}
11
+
12
+ export interface NotificationPreferenceModel
13
+ extends mongoose.Model<NotificationPreferenceDocument, object, NotificationPreferenceMethods>,
14
+ NotificationPreferenceStatics {}
15
+
16
+ export interface NotificationPreferenceDocument
17
+ extends mongoose.Document<string>,
18
+ NotificationPreferenceMethods {
19
+ _id: string;
20
+ inapp: boolean;
21
+ mail: boolean;
22
+ ownerId: mongoose.Types.ObjectId;
23
+ push: boolean;
24
+ sms: boolean;
25
+ created: Date;
26
+ updated: Date;
27
+ deleted: boolean;
28
+ }
@@ -0,0 +1,49 @@
1
+ import type mongoose from "mongoose";
2
+ import type {FindExactlyOnePlugin, FindOneOrNonePlugin} from "../plugins";
3
+
4
+ // biome-ignore lint/complexity/noBannedTypes: No instance methods.
5
+ export type OrganizationMethods = {};
6
+
7
+ export interface OrganizationStatics
8
+ extends FindExactlyOnePlugin<OrganizationDocument>,
9
+ FindOneOrNonePlugin<OrganizationDocument> {}
10
+
11
+ export interface OrganizationModel
12
+ extends mongoose.Model<OrganizationDocument, object, OrganizationMethods>,
13
+ OrganizationStatics {}
14
+
15
+ export type OrganizationSchema = mongoose.Schema<
16
+ OrganizationDocument,
17
+ OrganizationModel,
18
+ OrganizationMethods
19
+ >;
20
+
21
+ /**
22
+ * App-defined `Organization.settings` shape.
23
+ *
24
+ * Augment in the consumer app:
25
+ *
26
+ * ```ts
27
+ * declare module "@terreno/api" {
28
+ * interface OrganizationSettings {
29
+ * timezone?: string;
30
+ * }
31
+ * }
32
+ * ```
33
+ *
34
+ * Or pass a generic to `organizationSettingsOf<MySettings>(organization)`.
35
+ */
36
+ // biome-ignore lint/suspicious/noEmptyInterface: Declaration merging for consumer settings.
37
+ export interface OrganizationSettings {}
38
+
39
+ export interface OrganizationDocument extends mongoose.Document {
40
+ _id: mongoose.Types.ObjectId;
41
+ created: Date;
42
+ deleted: boolean;
43
+ disabled: boolean;
44
+ name: string;
45
+ ownerId: mongoose.Types.ObjectId;
46
+ settings?: OrganizationSettings;
47
+ slug: string;
48
+ updated: Date;
49
+ }
package/src/types.d.ts CHANGED
@@ -6,6 +6,7 @@ declare namespace NodeJS {
6
6
  SENTRY_TRACES_SAMPLE_RATE: string;
7
7
  SENTRY_PROFILES_SAMPLE_RATE: string;
8
8
  SLACK_WEBHOOKS?: string;
9
+ SLACK_BOT_TOKEN?: string;
9
10
  GOOGLE_CHAT_WEBHOOKS?: string;
10
11
  SESSION_SECRET: string;
11
12
  TOKEN_ISSUER: string;