@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
@@ -43,6 +43,7 @@ export const MAX_QUERY_SUBSCRIPTIONS = 100;
43
43
  *
44
44
  * Exported for testing.
45
45
  */
46
+ /** @internal */
46
47
  export const redactCredentials = (url: string): string => {
47
48
  try {
48
49
  const parsed = new URL(url);
@@ -416,7 +417,7 @@ export class RealtimeApp implements TerrenoPlugin {
416
417
  createSocketAuthMiddleware({
417
418
  betterAuth: this.config.betterAuth,
418
419
  issuer: resolveTokenIssuer,
419
- ...(tokenSecret ? {tokenSecret} : {}),
420
+ tokenSecret,
420
421
  })
421
422
  );
422
423
 
@@ -281,6 +281,20 @@ describe("fieldDescriptionToOpenApiProperty", () => {
281
281
  items: {type: "string"},
282
282
  type: "array",
283
283
  });
284
+ expect(
285
+ fieldDescriptionToOpenApiProperty({
286
+ description: "Platforms",
287
+ enum: ["ios", "android", "web"],
288
+ isArray: true,
289
+ item: {enum: ["ios", "android", "web"], kind: "string", required: false},
290
+ kind: "string",
291
+ required: false,
292
+ })
293
+ ).toEqual({
294
+ description: "Platforms",
295
+ items: {enum: ["ios", "android", "web"], type: "string"},
296
+ type: "array",
297
+ });
284
298
  expect(fieldDescriptionToOpenApiProperty(embeddedField)).toEqual(
285
299
  expect.objectContaining({
286
300
  description: "Profile",
@@ -176,8 +176,9 @@ const describeSchemaPath = (path: string, schemaPath: MongooseSchemaPath): Field
176
176
  const itemSchemaPath = getNestedValueSchemaPath(schemaPath);
177
177
  if (itemSchemaPath) {
178
178
  const item = describeCaster(itemSchemaPath);
179
+ const {enum: _arrayEnum, ...arrayBase} = base;
179
180
  return {
180
- ...base,
181
+ ...arrayBase,
181
182
  isArray: true,
182
183
  item,
183
184
  kind: item.kind,
@@ -362,9 +363,6 @@ export const fieldDescriptionToOpenApiProperty = (
362
363
  items,
363
364
  type: "array",
364
365
  };
365
- if (field.enum) {
366
- property.enum = field.enum;
367
- }
368
366
  return property;
369
367
  }
370
368
 
@@ -377,7 +375,9 @@ export const fieldDescriptionToOpenApiProperty = (
377
375
  if (field.description) {
378
376
  property.description = field.description;
379
377
  }
380
- property.required = nested.required.length ? nested.required : [];
378
+ if (nested.required.length > 0) {
379
+ property.required = nested.required;
380
+ }
381
381
  return property;
382
382
  }
383
383
 
@@ -0,0 +1,96 @@
1
+ import {beforeEach, describe, it} from "bun:test";
2
+ import {assert} from "chai";
3
+ import {model, Schema} from "mongoose";
4
+
5
+ import {Permissions} from "../permissions";
6
+ import {createdUpdatedPlugin, type IsDeleted, isDeletedPlugin} from "../plugins";
7
+ import {clearSyncRegistry, getSyncRegistry, registerSync} from "./registry";
8
+ import {syncPlugin} from "./syncSeqPlugin";
9
+
10
+ interface AdminBroadcastTodo extends IsDeleted {
11
+ _id: string;
12
+ ownerId: string;
13
+ title: string;
14
+ _syncSeq?: number;
15
+ }
16
+
17
+ const adminBroadcastTodoSchema = new Schema<AdminBroadcastTodo>({
18
+ ownerId: {description: "The owner", type: String},
19
+ title: {description: "The title", required: true, type: String},
20
+ });
21
+ adminBroadcastTodoSchema.plugin(isDeletedPlugin);
22
+ adminBroadcastTodoSchema.plugin(createdUpdatedPlugin);
23
+ adminBroadcastTodoSchema.plugin(syncPlugin);
24
+ const AdminBroadcastTodoModel = model<AdminBroadcastTodo>(
25
+ "AdminBroadcastTodo",
26
+ adminBroadcastTodoSchema
27
+ );
28
+
29
+ const syncOptions = {
30
+ permissions: {
31
+ create: [Permissions.IsAuthenticated],
32
+ delete: [Permissions.IsAuthenticated],
33
+ list: [Permissions.IsAuthenticated],
34
+ read: [Permissions.IsAuthenticated],
35
+ update: [Permissions.IsAuthenticated],
36
+ },
37
+ sync: {scope: {type: "owner" as const}},
38
+ };
39
+
40
+ describe("SyncConfig.adminBroadcast", () => {
41
+ beforeEach(() => {
42
+ clearSyncRegistry();
43
+ });
44
+
45
+ it("stores adminBroadcast true when registerSync is given the flag", () => {
46
+ registerSync({
47
+ config: {adminBroadcast: true, scope: {type: "owner"}},
48
+ model: AdminBroadcastTodoModel,
49
+ options: syncOptions,
50
+ routePath: "/adminBroadcastTodos",
51
+ });
52
+
53
+ assert.strictEqual(getSyncRegistry()[0]?.config.adminBroadcast, true);
54
+ });
55
+
56
+ it("stores adminBroadcast false when registerSync omits the flag", () => {
57
+ registerSync({
58
+ config: {scope: {type: "owner"}},
59
+ model: AdminBroadcastTodoModel,
60
+ options: syncOptions,
61
+ routePath: "/adminBroadcastTodos",
62
+ });
63
+
64
+ assert.strictEqual(getSyncRegistry()[0]?.config.adminBroadcast, false);
65
+ });
66
+
67
+ it("stores adminBroadcast false when the host sets the flag to false", () => {
68
+ registerSync({
69
+ config: {adminBroadcast: false, scope: {type: "owner"}},
70
+ model: AdminBroadcastTodoModel,
71
+ options: syncOptions,
72
+ routePath: "/adminBroadcastTodos",
73
+ });
74
+
75
+ assert.strictEqual(getSyncRegistry()[0]?.config.adminBroadcast, false);
76
+ });
77
+
78
+ it("treats a second registerSync for the same model and route path as a no-op", () => {
79
+ registerSync({
80
+ config: {adminBroadcast: true, scope: {type: "owner"}},
81
+ model: AdminBroadcastTodoModel,
82
+ options: syncOptions,
83
+ routePath: "/adminBroadcastTodos",
84
+ });
85
+
86
+ registerSync({
87
+ config: {adminBroadcast: true, scope: {type: "owner"}},
88
+ model: AdminBroadcastTodoModel,
89
+ options: syncOptions,
90
+ routePath: "/adminBroadcastTodos",
91
+ });
92
+
93
+ assert.equal(getSyncRegistry().length, 1);
94
+ assert.strictEqual(getSyncRegistry()[0]?.config.adminBroadcast, true);
95
+ });
96
+ });
@@ -0,0 +1,155 @@
1
+ import {describe, it} from "bun:test";
2
+ import {assert} from "chai";
3
+
4
+ import type {User} from "../auth";
5
+ import {
6
+ authorizeAdminBroadcastDocument,
7
+ clearAdminBroadcastScopes,
8
+ isAdminBroadcastSocketRoom,
9
+ registerAdminBroadcastScope,
10
+ } from "./adminBroadcastScope";
11
+
12
+ const adminUser = {admin: true, id: "u-admin"} as User;
13
+
14
+ describe("adminBroadcastScope", () => {
15
+ it("treats an unregistered model as unscoped", async () => {
16
+ clearAdminBroadcastScopes();
17
+ assert.equal(
18
+ await authorizeAdminBroadcastDocument({
19
+ doc: {ownerId: "other"},
20
+ modelName: "Missing",
21
+ user: adminUser,
22
+ }),
23
+ "unscoped"
24
+ );
25
+ });
26
+
27
+ it("denies when list permission fails", async () => {
28
+ clearAdminBroadcastScopes();
29
+ registerAdminBroadcastScope("Scoped", {
30
+ listPermissions: [() => false],
31
+ readPermissions: [() => true],
32
+ });
33
+ assert.equal(
34
+ await authorizeAdminBroadcastDocument({
35
+ doc: {ownerId: "other"},
36
+ modelName: "Scoped",
37
+ user: adminUser,
38
+ }),
39
+ "deny"
40
+ );
41
+ });
42
+
43
+ it("denies when queryFilter excludes the document", async () => {
44
+ clearAdminBroadcastScopes();
45
+ registerAdminBroadcastScope("Scoped", {
46
+ listPermissions: [() => true],
47
+ queryFilter: () => ({tenantId: "acme"}),
48
+ readPermissions: [() => true],
49
+ });
50
+ assert.equal(
51
+ await authorizeAdminBroadcastDocument({
52
+ doc: {tenantId: "other"},
53
+ modelName: "Scoped",
54
+ user: adminUser,
55
+ }),
56
+ "deny"
57
+ );
58
+ assert.equal(
59
+ await authorizeAdminBroadcastDocument({
60
+ doc: {tenantId: "acme"},
61
+ modelName: "Scoped",
62
+ user: adminUser,
63
+ }),
64
+ "allow"
65
+ );
66
+ });
67
+
68
+ it("denies when queryFilter returns null", async () => {
69
+ clearAdminBroadcastScopes();
70
+ registerAdminBroadcastScope("Scoped", {
71
+ listPermissions: [() => true],
72
+ queryFilter: () => null,
73
+ readPermissions: [() => true],
74
+ });
75
+ assert.equal(
76
+ await authorizeAdminBroadcastDocument({
77
+ doc: {tenantId: "acme"},
78
+ modelName: "Scoped",
79
+ user: adminUser,
80
+ }),
81
+ "deny"
82
+ );
83
+ });
84
+
85
+ it("allows when queryFilter is omitted", async () => {
86
+ clearAdminBroadcastScopes();
87
+ registerAdminBroadcastScope("Scoped", {
88
+ listPermissions: [() => true],
89
+ readPermissions: [() => true],
90
+ });
91
+ assert.equal(
92
+ await authorizeAdminBroadcastDocument({
93
+ doc: {ownerId: "other"},
94
+ modelName: "Scoped",
95
+ user: adminUser,
96
+ }),
97
+ "allow"
98
+ );
99
+ });
100
+
101
+ it("denies when queryFilter throws", async () => {
102
+ clearAdminBroadcastScopes();
103
+ registerAdminBroadcastScope("Scoped", {
104
+ listPermissions: [() => true],
105
+ queryFilter: () => {
106
+ throw new Error("filter exploded");
107
+ },
108
+ readPermissions: [() => true],
109
+ });
110
+ assert.equal(
111
+ await authorizeAdminBroadcastDocument({
112
+ doc: {ownerId: "other"},
113
+ modelName: "Scoped",
114
+ user: adminUser,
115
+ }),
116
+ "deny"
117
+ );
118
+ });
119
+
120
+ it("denies when the user is missing", async () => {
121
+ clearAdminBroadcastScopes();
122
+ registerAdminBroadcastScope("Scoped", {
123
+ listPermissions: [() => true],
124
+ readPermissions: [() => true],
125
+ });
126
+ assert.equal(
127
+ await authorizeAdminBroadcastDocument({
128
+ doc: {ownerId: "other"},
129
+ modelName: "Scoped",
130
+ }),
131
+ "deny"
132
+ );
133
+ });
134
+
135
+ it("denies when read permission fails", async () => {
136
+ clearAdminBroadcastScopes();
137
+ registerAdminBroadcastScope("Scoped", {
138
+ listPermissions: [() => true],
139
+ readPermissions: [() => false],
140
+ });
141
+ assert.equal(
142
+ await authorizeAdminBroadcastDocument({
143
+ doc: {ownerId: "other"},
144
+ modelName: "Scoped",
145
+ user: adminUser,
146
+ }),
147
+ "deny"
148
+ );
149
+ });
150
+
151
+ it("identifies the admin broadcast socket room", () => {
152
+ assert.isTrue(isAdminBroadcastSocketRoom("sync:todos|admin", "todos"));
153
+ assert.isFalse(isAdminBroadcastSocketRoom("sync:todos|owner:u1", "todos"));
154
+ });
155
+ });
@@ -0,0 +1,123 @@
1
+ import type {User} from "../auth";
2
+ import {logger} from "../logger";
3
+ import type {PermissionMethod} from "../permissions";
4
+ import {checkPermissions} from "../permissions";
5
+ import {matchesQuery} from "../realtime/queryMatcher";
6
+ import {adminBroadcastStream} from "./streams";
7
+
8
+ /**
9
+ * AdminApp row/resource rules for `{collection}|admin` and admin-window
10
+ * `GET /sync/entities`. Product `queryFilter` / `IsOwner` stay on app streams;
11
+ * this registry is the AdminApp list/read contract (resource actions + tenant
12
+ * `queryFilter`) so a panel user cannot fetch or live-stream rows `/admin` REST
13
+ * would hide.
14
+ */
15
+ export interface AdminBroadcastScope {
16
+ listPermissions: PermissionMethod<unknown>[];
17
+ queryFilter?: (
18
+ user?: User,
19
+ query?: Record<string, unknown>
20
+ ) => Record<string, unknown> | null | Promise<Record<string, unknown> | null>;
21
+ readPermissions: PermissionMethod<unknown>[];
22
+ }
23
+
24
+ const adminBroadcastScopes = new Map<string, AdminBroadcastScope>();
25
+
26
+ export const registerAdminBroadcastScope = (
27
+ modelName: string,
28
+ scope: AdminBroadcastScope
29
+ ): void => {
30
+ adminBroadcastScopes.set(modelName, scope);
31
+ };
32
+
33
+ export const getAdminBroadcastScope = (modelName: string): AdminBroadcastScope | undefined =>
34
+ adminBroadcastScopes.get(modelName);
35
+
36
+ export const clearAdminBroadcastScopes = (): void => {
37
+ adminBroadcastScopes.clear();
38
+ };
39
+
40
+ /** Socket.io room for `{collection}|admin` (`sync:{tag}|admin`). */
41
+ export const isAdminBroadcastSocketRoom = (room: string, collectionTag: string): boolean =>
42
+ room === `sync:${adminBroadcastStream(collectionTag)}`;
43
+
44
+ const compactFilter = (filter: Record<string, unknown>): Record<string, unknown> | undefined => {
45
+ const next: Record<string, unknown> = {};
46
+ for (const [key, value] of Object.entries(filter)) {
47
+ if (value !== undefined) {
48
+ next[key] = value;
49
+ }
50
+ }
51
+ return Object.keys(next).length > 0 ? next : undefined;
52
+ };
53
+
54
+ export const resolveAdminBroadcastQueryFilter = async ({
55
+ scope,
56
+ user,
57
+ }: {
58
+ scope: AdminBroadcastScope;
59
+ user: User;
60
+ }): Promise<{denied: boolean; filter?: Record<string, unknown>}> => {
61
+ if (!scope.queryFilter) {
62
+ return {denied: false};
63
+ }
64
+ let resolved: Record<string, unknown> | null;
65
+ try {
66
+ resolved = await scope.queryFilter(user, {});
67
+ } catch (error: unknown) {
68
+ logger.error("[sync] admin broadcast queryFilter threw; denying the read", {
69
+ error: String(error),
70
+ userId: String(user.id),
71
+ });
72
+ return {denied: true};
73
+ }
74
+ if (resolved === null) {
75
+ return {denied: true};
76
+ }
77
+ return {denied: false, filter: compactFilter(resolved)};
78
+ };
79
+
80
+ export const canListAdminBroadcastScope = async ({
81
+ scope,
82
+ user,
83
+ }: {
84
+ scope: AdminBroadcastScope;
85
+ user: User;
86
+ }): Promise<boolean> => checkPermissions("list", scope.listPermissions, user);
87
+
88
+ /**
89
+ * `unscoped` means AdminApp has not registered this model — keep product
90
+ * `IsOwner` / `queryFilter` behavior. `deny` / `allow` replace product read
91
+ * for the admin window.
92
+ */
93
+ export const authorizeAdminBroadcastDocument = async ({
94
+ doc,
95
+ modelName,
96
+ user,
97
+ }: {
98
+ doc?: Record<string, unknown>;
99
+ modelName: string;
100
+ user?: User;
101
+ }): Promise<"allow" | "deny" | "unscoped"> => {
102
+ const scope = getAdminBroadcastScope(modelName);
103
+ if (!scope) {
104
+ return "unscoped";
105
+ }
106
+ if (!user) {
107
+ return "deny";
108
+ }
109
+ if (!(await canListAdminBroadcastScope({scope, user}))) {
110
+ return "deny";
111
+ }
112
+ const filterResult = await resolveAdminBroadcastQueryFilter({scope, user});
113
+ if (filterResult.denied) {
114
+ return "deny";
115
+ }
116
+ if (doc && filterResult.filter && !matchesQuery(doc, filterResult.filter)) {
117
+ return "deny";
118
+ }
119
+ if (doc && !(await checkPermissions("read", scope.readPermissions, user, doc))) {
120
+ return "deny";
121
+ }
122
+ return "allow";
123
+ };
@@ -0,0 +1,57 @@
1
+ import {describe, it} from "bun:test";
2
+ import {assert} from "chai";
3
+
4
+ import type {User} from "../auth";
5
+ import type {AnyTerrenoAccess} from "../rbac/types";
6
+ import {canUseAdminBroadcastWindow} from "./adminWindowAccess";
7
+
8
+ const adminUser = {admin: true, id: "u-admin"} as User;
9
+ const flagOnlyUser = {admin: true, id: "u-flag"} as User;
10
+ const memberUser = {admin: false, id: "u-member"} as User;
11
+
12
+ describe("canUseAdminBroadcastWindow", () => {
13
+ it("uses user.admin when no RBAC is configured", async () => {
14
+ assert.isTrue(await canUseAdminBroadcastWindow({user: adminUser}));
15
+ assert.isFalse(await canUseAdminBroadcastWindow({user: memberUser}));
16
+ });
17
+
18
+ it("requires admin:access when accessControl is configured", async () => {
19
+ const accessControl = {
20
+ can: async () => ({allowed: false}),
21
+ } as unknown as AnyTerrenoAccess;
22
+
23
+ assert.isFalse(
24
+ await canUseAdminBroadcastWindow({
25
+ accessControl,
26
+ user: flagOnlyUser,
27
+ })
28
+ );
29
+ });
30
+
31
+ it("allows a caller when accessControl grants admin:access", async () => {
32
+ const accessControl = {
33
+ can: async () => ({allowed: true}),
34
+ } as unknown as AnyTerrenoAccess;
35
+
36
+ assert.isTrue(
37
+ await canUseAdminBroadcastWindow({
38
+ accessControl,
39
+ user: memberUser,
40
+ })
41
+ );
42
+ });
43
+
44
+ it("prefers canOpenAdminWindow over accessControl and user.admin", async () => {
45
+ const accessControl = {
46
+ can: async () => ({allowed: true}),
47
+ } as unknown as AnyTerrenoAccess;
48
+
49
+ assert.isFalse(
50
+ await canUseAdminBroadcastWindow({
51
+ accessControl,
52
+ canOpenAdminWindow: () => false,
53
+ user: adminUser,
54
+ })
55
+ );
56
+ });
57
+ });
@@ -0,0 +1,32 @@
1
+ import type {User} from "../auth";
2
+ import {Permissions} from "../permissions";
3
+ import {ADMIN_PAGE_PERMISSION} from "../rbac/statements";
4
+ import type {AnyTerrenoAccess} from "../rbac/types";
5
+
6
+ /**
7
+ * Gate for `{collection}|admin` window subscribe and cross-owner `GET /sync/entities`.
8
+ *
9
+ * Matches the admin UI shell: with `accessControl`, require `admin:access`.
10
+ * Without RBAC, fall back to the legacy `user.admin` flag.
11
+ */
12
+ export const canUseAdminBroadcastWindow = async ({
13
+ accessControl,
14
+ canOpenAdminWindow,
15
+ user,
16
+ }: {
17
+ accessControl?: AnyTerrenoAccess;
18
+ canOpenAdminWindow?: (user: User) => boolean | Promise<boolean>;
19
+ user: User;
20
+ }): Promise<boolean> => {
21
+ if (canOpenAdminWindow) {
22
+ return Boolean(await canOpenAdminWindow(user));
23
+ }
24
+ if (accessControl) {
25
+ const result = await accessControl.can({
26
+ permissions: {admin: [...ADMIN_PAGE_PERMISSION.admin]},
27
+ user,
28
+ });
29
+ return result.allowed;
30
+ }
31
+ return Permissions.IsAdmin("list", user);
32
+ };