@terreno/api 57.2.0 → 57.4.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.
- package/.ai/skills/mongoose-schema-safety/SKILL.md +23 -10
- package/README.md +23 -7
- package/dist/actions.js +19 -7
- package/dist/adminTypes.d.ts +7 -0
- package/dist/adminTypes.js +6 -1
- package/dist/api.d.ts +14 -0
- package/dist/api.js +111 -60
- package/dist/audit/auditApp.d.ts +30 -0
- package/dist/audit/auditApp.js +155 -0
- package/dist/audit/auditEventModel.d.ts +29 -0
- package/dist/audit/auditEventModel.js +102 -0
- package/dist/audit/cloudTasksEnqueue.d.ts +32 -0
- package/dist/audit/cloudTasksEnqueue.js +162 -0
- package/dist/audit/diff.d.ts +10 -0
- package/dist/audit/diff.js +230 -0
- package/dist/audit/processQueue.d.ts +6 -0
- package/dist/audit/processQueue.js +101 -0
- package/dist/audit/rbacSink.d.ts +2 -0
- package/dist/audit/rbacSink.js +82 -0
- package/dist/audit/record.d.ts +56 -0
- package/dist/audit/record.js +373 -0
- package/dist/auth.d.ts +23 -10
- package/dist/auth.js +97 -32
- package/dist/authRecovery.d.ts +5 -0
- package/dist/authRecovery.js +350 -0
- package/dist/authTokens.d.ts +8 -0
- package/dist/authTokens.js +162 -0
- package/dist/betterAuth.d.ts +39 -0
- package/dist/betterAuthApp.d.ts +4 -0
- package/dist/betterAuthApp.js +26 -8
- package/dist/betterAuthSetup.d.ts +44 -2
- package/dist/betterAuthSetup.js +288 -18
- package/dist/collectionRegistry.d.ts +40 -0
- package/dist/collectionRegistry.js +97 -0
- package/dist/configurationApp.d.ts +11 -2
- package/dist/configurationApp.js +2 -4
- package/dist/docLoader.js +35 -6
- package/dist/expressServer.d.ts +26 -3
- package/dist/expressServer.js +79 -11
- package/dist/index.d.ts +42 -1
- package/dist/index.js +84 -2
- package/dist/mcp/auth.d.ts +1 -0
- package/dist/mcp/auth.js +47 -25
- package/dist/mcp/handlers.d.ts +1 -1
- package/dist/mcp/handlers.js +67 -233
- package/dist/mcp/query.d.ts +2 -15
- package/dist/mcp/query.js +8 -8
- package/dist/mcp/registry.d.ts +1 -5
- package/dist/mcp/registry.js +31 -20
- package/dist/mcp/schemaGenerator.d.ts +2 -7
- package/dist/mcp/schemaGenerator.js +41 -116
- package/dist/mcp/server.d.ts +1 -0
- package/dist/mcp/server.js +1 -0
- package/dist/mcp/serviceTokens.d.ts +16 -0
- package/dist/mcp/serviceTokens.js +345 -0
- package/dist/mcp/types.d.ts +2 -2
- package/dist/migrations/fixtures/all-down/20260910120000-one.d.ts +4 -0
- package/dist/migrations/fixtures/all-down/20260910120000-one.js +49 -0
- package/dist/migrations/fixtures/all-down/20260910120001-two.d.ts +4 -0
- package/dist/migrations/fixtures/all-down/20260910120001-two.js +49 -0
- package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.d.ts +3 -0
- package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.js +45 -0
- package/dist/migrations/fixtures/bad-name/not-a-migration.d.ts +3 -0
- package/dist/migrations/fixtures/bad-name/not-a-migration.js +45 -0
- package/dist/migrations/fixtures/missing-up/20260910120000-noup.d.ts +2 -0
- package/dist/migrations/fixtures/missing-up/20260910120000-noup.js +5 -0
- package/dist/migrations/fixtures/valid/20260910120000-alpha.d.ts +3 -0
- package/dist/migrations/fixtures/valid/20260910120000-alpha.js +45 -0
- package/dist/migrations/fixtures/valid/20260910120001-beta.d.ts +4 -0
- package/dist/migrations/fixtures/valid/20260910120001-beta.js +49 -0
- package/dist/migrations/generate.d.ts +17 -0
- package/dist/migrations/generate.js +277 -0
- package/dist/migrations/load.d.ts +20 -0
- package/dist/migrations/load.js +236 -0
- package/dist/migrations/lock.d.ts +13 -0
- package/dist/migrations/lock.js +145 -0
- package/dist/migrations/runner.d.ts +42 -0
- package/dist/migrations/runner.js +503 -0
- package/dist/migrations/schemaCatalog.d.ts +44 -0
- package/dist/migrations/schemaCatalog.js +326 -0
- package/dist/migrations/types.d.ts +87 -0
- package/dist/migrations/types.js +7 -0
- package/dist/models/mcpServiceToken.d.ts +3 -0
- package/dist/models/mcpServiceToken.js +208 -0
- package/dist/models/notification.d.ts +2 -0
- package/dist/models/notification.js +62 -0
- package/dist/models/notificationPreference.d.ts +2 -0
- package/dist/models/notificationPreference.js +49 -0
- package/dist/notifications/notificationService.d.ts +40 -0
- package/dist/notifications/notificationService.js +323 -0
- package/dist/notifications/notificationsApp.d.ts +18 -0
- package/dist/notifications/notificationsApp.js +250 -0
- package/dist/notifications/notificationsBeforeSend.d.ts +14 -0
- package/dist/notifications/notificationsBeforeSend.js +77 -0
- package/dist/openApi.d.ts +1 -7
- package/dist/openApi.js +7 -6
- package/dist/openApiBuilder.d.ts +19 -7
- package/dist/openApiBuilder.js +61 -8
- package/dist/openApiCompat.js +1 -1
- package/dist/openApiValidator.d.ts +13 -1
- package/dist/openApiValidator.js +200 -38
- package/dist/orgs/orgContext.d.ts +23 -0
- package/dist/orgs/orgContext.js +198 -0
- package/dist/orgs/orgPermissions.d.ts +4 -0
- package/dist/orgs/orgPermissions.js +77 -0
- package/dist/orgs/orgPlugin.d.ts +13 -0
- package/dist/orgs/orgPlugin.js +84 -0
- package/dist/orgs/organizationModel.d.ts +13 -0
- package/dist/orgs/organizationModel.js +301 -0
- package/dist/orgs/organizationSettings.d.ts +19 -0
- package/dist/orgs/organizationSettings.js +120 -0
- package/dist/orgs/orgsApp.d.ts +28 -0
- package/dist/orgs/orgsApp.js +678 -0
- package/dist/permissions.d.ts +7 -13
- package/dist/permissions.js +8 -31
- package/dist/plugins.d.ts +14 -1
- package/dist/plugins.js +17 -6
- package/dist/populate.d.ts +2 -2
- package/dist/populate.js +47 -42
- package/dist/rateLimit/applyTrustProxy.d.ts +3 -0
- package/dist/rateLimit/applyTrustProxy.js +17 -0
- package/dist/rateLimit/createStore.d.ts +2 -0
- package/dist/rateLimit/createStore.js +28 -0
- package/dist/rateLimit/memoryStore.d.ts +2 -0
- package/dist/rateLimit/memoryStore.js +108 -0
- package/dist/rateLimit/middleware.d.ts +3 -0
- package/dist/rateLimit/middleware.js +109 -0
- package/dist/rateLimit/mongoStore.d.ts +4 -0
- package/dist/rateLimit/mongoStore.js +123 -0
- package/dist/rateLimit/policies.d.ts +10 -0
- package/dist/rateLimit/policies.js +149 -0
- package/dist/rateLimit/redisStore.d.ts +4 -0
- package/dist/rateLimit/redisStore.js +156 -0
- package/dist/rateLimit/types.d.ts +54 -0
- package/dist/rateLimit/types.js +9 -0
- package/dist/rbac/access.js +35 -14
- package/dist/rbac/assertAllowed.d.ts +9 -0
- package/dist/rbac/assertAllowed.js +182 -0
- package/dist/rbac/membershipOrgAdminSource.d.ts +6 -0
- package/dist/rbac/membershipOrgAdminSource.js +122 -0
- package/dist/rbac/modelRouterAccess.d.ts +4 -0
- package/dist/rbac/modelRouterAccess.js +11 -4
- package/dist/rbac/permissionUtils.js +3 -2
- package/dist/rbac/resolve.js +65 -35
- package/dist/rbac/roleModel.d.ts +2 -5
- package/dist/rbac/roleModel.js +18 -4
- package/dist/rbac/routes.js +15 -6
- package/dist/rbac/statements.d.ts +10 -1
- package/dist/rbac/statements.js +19 -2
- package/dist/rbac/types.d.ts +5 -0
- package/dist/realtime/changeStreamWatcher.d.ts +10 -4
- package/dist/realtime/changeStreamWatcher.js +110 -64
- package/dist/realtime/deprecation.d.ts +13 -0
- package/dist/realtime/deprecation.js +33 -0
- package/dist/realtime/realtimeApp.d.ts +2 -1
- package/dist/realtime/realtimeApp.js +11 -11
- package/dist/realtime/registry.d.ts +0 -31
- package/dist/realtime/registry.js +44 -31
- package/dist/realtime/socketAuth.d.ts +5 -5
- package/dist/realtime/socketAuth.js +11 -1
- package/dist/realtime/socketUser.d.ts +5 -1
- package/dist/realtime/types.d.ts +14 -4
- package/dist/schemaMetadata.d.ts +56 -0
- package/dist/schemaMetadata.js +524 -0
- package/dist/seedRunner.d.ts +88 -0
- package/dist/seedRunner.js +627 -0
- package/dist/sync/adminBroadcastScope.d.ts +40 -0
- package/dist/sync/adminBroadcastScope.js +194 -0
- package/dist/sync/adminWindowAccess.d.ts +13 -0
- package/dist/sync/adminWindowAccess.js +96 -0
- package/dist/sync/adminWindowMutation.d.ts +88 -0
- package/dist/sync/adminWindowMutation.js +247 -0
- package/dist/sync/executors.d.ts +19 -3
- package/dist/sync/executors.js +194 -165
- package/dist/sync/loadHarness.js +28 -19
- package/dist/sync/models.js +26 -24
- package/dist/sync/mutationHandler.d.ts +14 -2
- package/dist/sync/mutationHandler.js +201 -76
- package/dist/sync/registrationSideEffects.d.ts +35 -0
- package/dist/sync/registrationSideEffects.js +151 -0
- package/dist/sync/registry.d.ts +2 -52
- package/dist/sync/registry.js +42 -187
- package/dist/sync/routes.d.ts +13 -0
- package/dist/sync/routes.js +116 -58
- package/dist/sync/scripts/compactTombstones.js +0 -2
- package/dist/sync/socketHandlers.d.ts +8 -2
- package/dist/sync/socketHandlers.js +144 -50
- package/dist/sync/streams.d.ts +2 -0
- package/dist/sync/streams.js +7 -1
- package/dist/sync/syncApp.d.ts +4 -3
- package/dist/sync/syncApp.js +5 -4
- package/dist/sync/syncBatch.d.ts +5 -2
- package/dist/sync/syncBatch.js +7 -6
- package/dist/sync/syncSeqPlugin.d.ts +1 -1
- package/dist/sync/syncSeqPlugin.js +20 -16
- package/dist/sync/types.d.ts +18 -0
- package/dist/terrenoApp.d.ts +48 -5
- package/dist/terrenoApp.js +157 -72
- package/dist/tests/createTestData.d.ts +1 -3
- package/dist/tests/createTestData.js +3 -5
- package/dist/tests/models.d.ts +3 -0
- package/dist/tests/models.js +15 -2
- package/dist/tests/testHelper.d.ts +0 -5
- package/dist/tests/testHelper.js +2 -9
- package/dist/types/authToken.d.ts +33 -0
- package/dist/types/authToken.js +2 -0
- package/dist/types/mcpServiceToken.d.ts +41 -0
- package/dist/types/mcpServiceToken.js +2 -0
- package/dist/types/membership.d.ts +23 -0
- package/dist/types/membership.js +2 -0
- package/dist/types/notification.d.ts +28 -0
- package/dist/types/notification.js +2 -0
- package/dist/types/notificationPreference.d.ts +20 -0
- package/dist/types/notificationPreference.js +2 -0
- package/dist/types/organization.d.ts +36 -0
- package/dist/types/organization.js +2 -0
- package/dist/webhooks/headerValue.d.ts +2 -0
- package/dist/webhooks/headerValue.js +14 -0
- package/dist/webhooks/idempotency/memoryStore.d.ts +10 -0
- package/dist/webhooks/idempotency/memoryStore.js +65 -0
- package/dist/webhooks/idempotency/mongoStore.d.ts +4 -0
- package/dist/webhooks/idempotency/mongoStore.js +150 -0
- package/dist/webhooks/idempotency/webhookReceipt.d.ts +17 -0
- package/dist/webhooks/idempotency/webhookReceipt.js +39 -0
- package/dist/webhooks/rawBody.d.ts +15 -0
- package/dist/webhooks/rawBody.js +23 -0
- package/dist/webhooks/timingSafeEqual.d.ts +4 -0
- package/dist/webhooks/timingSafeEqual.js +17 -0
- package/dist/webhooks/verifiers/hmac.d.ts +15 -0
- package/dist/webhooks/verifiers/hmac.js +49 -0
- package/dist/webhooks/verifiers/sendgrid.d.ts +10 -0
- package/dist/webhooks/verifiers/sendgrid.js +56 -0
- package/dist/webhooks/verifiers/stripe.d.ts +9 -0
- package/dist/webhooks/verifiers/stripe.js +99 -0
- package/dist/webhooks/verifiers/twilio.d.ts +9 -0
- package/dist/webhooks/verifiers/twilio.js +112 -0
- package/dist/webhooks/webhooksApp.d.ts +33 -0
- package/dist/webhooks/webhooksApp.js +195 -0
- package/package.json +32 -27
- package/src/__snapshots__/openApi.test.ts.snap +444 -36
- package/src/__snapshots__/openApiBuilder.test.ts.snap +24 -24
- package/src/__snapshots__/schemaMetadata.test.ts.snap +196 -0
- package/src/actions.ts +20 -13
- package/src/adminModelRouter.test.ts +133 -0
- package/src/adminTypes.ts +8 -0
- package/src/api.arrayOperations.test.ts +43 -31
- package/src/api.hooks.test.ts +38 -29
- package/src/api.query.test.ts +31 -31
- package/src/api.test.ts +133 -97
- package/src/api.ts +84 -27
- package/src/audit/auditApp.test.ts +243 -0
- package/src/audit/auditApp.ts +139 -0
- package/src/audit/auditEventModel.ts +156 -0
- package/src/audit/auditRouter.test.ts +456 -0
- package/src/audit/cloudTasksEnqueue.test.ts +124 -0
- package/src/audit/cloudTasksEnqueue.ts +104 -0
- package/src/audit/diff.ts +163 -0
- package/src/audit/processQueue.ts +69 -0
- package/src/audit/rbacSink.test.ts +86 -0
- package/src/audit/rbacSink.ts +42 -0
- package/src/audit/record.test.ts +402 -0
- package/src/audit/record.ts +328 -0
- package/src/auth.test.ts +108 -52
- package/src/auth.ts +98 -29
- package/src/authRecovery.test.ts +281 -0
- package/src/authRecovery.ts +279 -0
- package/src/authTokens.test.ts +94 -0
- package/src/authTokens.ts +118 -0
- package/src/authVerification.test.ts +293 -0
- package/src/betterAuth.ts +31 -0
- package/src/betterAuthApp.test.ts +1 -0
- package/src/betterAuthApp.ts +27 -9
- package/src/betterAuthSetup.test.ts +595 -38
- package/src/betterAuthSetup.ts +261 -5
- package/src/collectionRegistry.test.ts +164 -0
- package/src/collectionRegistry.ts +135 -0
- package/src/configurationApp.ts +13 -7
- package/src/docLoader.test.ts +45 -1
- package/src/docLoader.ts +37 -6
- package/src/express.d.ts +3 -0
- package/src/expressServer.test.ts +180 -68
- package/src/expressServer.ts +75 -19
- package/src/githubAuth.test.ts +60 -55
- package/src/index.ts +127 -0
- package/src/mcp/auth.test.ts +47 -0
- package/src/mcp/auth.ts +32 -11
- package/src/mcp/handlers.test.ts +275 -0
- package/src/mcp/handlers.ts +45 -172
- package/src/mcp/integration.test.ts +59 -9
- package/src/mcp/query.ts +5 -7
- package/src/mcp/registry.ts +29 -20
- package/src/mcp/schemaGenerator.test.ts +8 -0
- package/src/mcp/schemaGenerator.ts +49 -131
- package/src/mcp/server.ts +2 -0
- package/src/mcp/serviceTokens.test.ts +330 -0
- package/src/mcp/serviceTokens.ts +307 -0
- package/src/mcp/toolGenerator.test.ts +82 -1
- package/src/mcp/types.ts +2 -6
- package/src/migrations/cli.test.ts +376 -0
- package/src/migrations/cli.ts +283 -0
- package/src/migrations/fixtures/all-down/20260910120000-one.ts +6 -0
- package/src/migrations/fixtures/all-down/20260910120001-two.ts +6 -0
- package/src/migrations/fixtures/bad-id/20260910120000-mismatch.ts +4 -0
- package/src/migrations/fixtures/bad-name/not-a-migration.ts +4 -0
- package/src/migrations/fixtures/missing-up/20260910120000-noup.ts +2 -0
- package/src/migrations/fixtures/valid/20260910120000-alpha.ts +4 -0
- package/src/migrations/fixtures/valid/20260910120001-beta.ts +6 -0
- package/src/migrations/generate.test.ts +333 -0
- package/src/migrations/generate.ts +216 -0
- package/src/migrations/load.test.ts +103 -0
- package/src/migrations/load.ts +124 -0
- package/src/migrations/lock.test.ts +133 -0
- package/src/migrations/lock.ts +118 -0
- package/src/migrations/runner.test.ts +504 -0
- package/src/migrations/runner.ts +358 -0
- package/src/migrations/schemaCatalog.test.ts +159 -0
- package/src/migrations/schemaCatalog.ts +262 -0
- package/src/migrations/types.ts +94 -0
- package/src/models/mcpServiceToken.test.ts +129 -0
- package/src/models/mcpServiceToken.ts +158 -0
- package/src/models/notification.ts +68 -0
- package/src/models/notificationPreference.ts +62 -0
- package/src/notifications/notificationService.ts +254 -0
- package/src/notifications/notificationsApp.test.ts +505 -0
- package/src/notifications/notificationsApp.ts +200 -0
- package/src/notifications/notificationsBeforeSend.ts +51 -0
- package/src/openApi.test.ts +80 -65
- package/src/openApi.ts +2 -1
- package/src/openApiBuilder.test.ts +95 -7
- package/src/openApiBuilder.ts +60 -12
- package/src/openApiCompat.ts +1 -1
- package/src/openApiValidator.test.ts +270 -56
- package/src/openApiValidator.ts +219 -36
- package/src/orgs/orgAccessOptIn.test.ts +87 -0
- package/src/orgs/orgContext.test.ts +259 -0
- package/src/orgs/orgContext.ts +151 -0
- package/src/orgs/orgPermissions.test.ts +105 -0
- package/src/orgs/orgPermissions.ts +40 -0
- package/src/orgs/orgPlugin.test.ts +130 -0
- package/src/orgs/orgPlugin.ts +70 -0
- package/src/orgs/orgRbac.test.ts +267 -0
- package/src/orgs/orgSecurityDefects.test.ts +415 -0
- package/src/orgs/organizationModel.test.ts +205 -0
- package/src/orgs/organizationModel.ts +257 -0
- package/src/orgs/organizationSettings.test.ts +113 -0
- package/src/orgs/organizationSettings.ts +126 -0
- package/src/orgs/orgsApp.test.ts +382 -0
- package/src/orgs/orgsApp.ts +563 -0
- package/src/permissions.test.ts +62 -36
- package/src/permissions.ts +8 -30
- package/src/plugins.test.ts +14 -0
- package/src/plugins.ts +34 -9
- package/src/populate.test.ts +34 -0
- package/src/populate.ts +40 -29
- package/src/rateLimit/applyTrustProxy.ts +17 -0
- package/src/rateLimit/createStore.ts +25 -0
- package/src/rateLimit/memoryStore.ts +40 -0
- package/src/rateLimit/middleware.ts +79 -0
- package/src/rateLimit/mongoStore.test.ts +80 -0
- package/src/rateLimit/mongoStore.ts +77 -0
- package/src/rateLimit/policies.ts +130 -0
- package/src/rateLimit/rateLimit.test.ts +328 -0
- package/src/rateLimit/redisStore.ioredis.test.ts +29 -0
- package/src/rateLimit/redisStore.test.ts +114 -0
- package/src/rateLimit/redisStore.ts +86 -0
- package/src/rateLimit/types.ts +64 -0
- package/src/rbac/access.ts +16 -4
- package/src/rbac/assertAllowed.test.ts +325 -0
- package/src/rbac/assertAllowed.ts +157 -0
- package/src/rbac/backfillAdmins.test.ts +124 -0
- package/src/rbac/fieldViews.test.ts +89 -0
- package/src/rbac/membershipOrgAdminSource.ts +59 -0
- package/src/rbac/modelRouterAccess.test.ts +126 -0
- package/src/rbac/modelRouterAccess.ts +8 -2
- package/src/rbac/permissionUtils.test.ts +26 -5
- package/src/rbac/permissionUtils.ts +3 -2
- package/src/rbac/realtimeAccess.test.ts +109 -1
- package/src/rbac/resolve.test.ts +34 -2
- package/src/rbac/resolve.ts +31 -11
- package/src/rbac/roleManager.test.ts +169 -0
- package/src/rbac/roleModel.test.ts +34 -1
- package/src/rbac/roleModel.ts +17 -1
- package/src/rbac/routes.test.ts +233 -0
- package/src/rbac/routes.ts +16 -6
- package/src/rbac/statements.test.ts +19 -0
- package/src/rbac/statements.ts +19 -1
- package/src/rbac/types.ts +5 -0
- package/src/realtime/changeStreamWatcher.ts +73 -33
- package/src/realtime/deprecation.test.ts +60 -0
- package/src/realtime/deprecation.ts +33 -0
- package/src/realtime/realtime.test.ts +365 -189
- package/src/realtime/realtimeApp.ts +11 -11
- package/src/realtime/realtimeAppSetup.test.ts +32 -5
- package/src/realtime/registry.ts +48 -42
- package/src/realtime/sessionRevalidation.test.ts +57 -44
- package/src/realtime/socketAuth.test.ts +75 -23
- package/src/realtime/socketAuth.ts +17 -6
- package/src/realtime/socketUser.ts +5 -3
- package/src/realtime/types.ts +14 -4
- package/src/schemaMetadata.test.ts +419 -0
- package/src/schemaMetadata.ts +593 -0
- package/src/scrubAdminFields.test.ts +105 -0
- package/src/seedRunner.test.ts +591 -0
- package/src/seedRunner.ts +464 -0
- package/src/sync/adminBroadcastConfig.test.ts +96 -0
- package/src/sync/adminBroadcastScope.test.ts +155 -0
- package/src/sync/adminBroadcastScope.ts +123 -0
- package/src/sync/adminWindowAccess.test.ts +57 -0
- package/src/sync/adminWindowAccess.ts +32 -0
- package/src/sync/adminWindowMutation.test.ts +450 -0
- package/src/sync/adminWindowMutation.ts +283 -0
- package/src/sync/docMatchesMutationData.test.ts +16 -0
- package/src/sync/ensureSyncIndexes.test.ts +54 -15
- package/src/sync/executors.test.ts +40 -0
- package/src/sync/executors.ts +57 -18
- package/src/sync/integration.test.ts +15 -7
- package/src/sync/loadHarness.ts +28 -19
- package/src/sync/models.ts +32 -18
- package/src/sync/mutationHandler.test.ts +293 -17
- package/src/sync/mutationHandler.ts +180 -36
- package/src/sync/registrationSideEffects.test.ts +126 -0
- package/src/sync/registrationSideEffects.ts +131 -0
- package/src/sync/registry.ts +49 -171
- package/src/sync/routes.ts +55 -10
- package/src/sync/scripts/compactTombstones.ts +0 -2
- package/src/sync/sessionRevalidationIntegration.test.ts +12 -11
- package/src/sync/socketHandlers.ts +154 -58
- package/src/sync/streams.ts +6 -0
- package/src/sync/sync.test.ts +28 -25
- package/src/sync/syncApp.ts +5 -4
- package/src/sync/syncBatch.ts +10 -4
- package/src/sync/syncFrontier.test.ts +17 -15
- package/src/sync/syncPhaseC.test.ts +54 -43
- package/src/sync/syncRoutes.test.ts +347 -38
- package/src/sync/syncSeqPlugin.ts +66 -44
- package/src/sync/syncSocket.test.ts +341 -81
- package/src/sync/types.ts +20 -0
- package/src/terrenoApp.mcpServiceTokens.test.ts +173 -0
- package/src/terrenoApp.migrations.test.ts +114 -0
- package/src/terrenoApp.test.ts +41 -0
- package/src/terrenoApp.ts +181 -46
- package/src/tests/createTestData.ts +2 -2
- package/src/tests/models.ts +24 -3
- package/src/tests/testHelper.ts +1 -7
- package/src/types/authToken.ts +41 -0
- package/src/types/mcpServiceToken.ts +48 -0
- package/src/types/membership.ts +48 -0
- package/src/types/notification.ts +34 -0
- package/src/types/notificationPreference.ts +28 -0
- package/src/types/organization.ts +49 -0
- package/src/webhooks/headerValue.test.ts +22 -0
- package/src/webhooks/headerValue.ts +12 -0
- package/src/webhooks/idempotency/memoryStore.ts +34 -0
- package/src/webhooks/idempotency/mongoStore.test.ts +274 -0
- package/src/webhooks/idempotency/mongoStore.ts +83 -0
- package/src/webhooks/idempotency/webhookReceipt.ts +67 -0
- package/src/webhooks/rawBody.test.ts +107 -0
- package/src/webhooks/rawBody.ts +24 -0
- package/src/webhooks/timingSafeEqual.ts +16 -0
- package/src/webhooks/verifiers/hmac.test.ts +110 -0
- package/src/webhooks/verifiers/hmac.ts +54 -0
- package/src/webhooks/verifiers/providerVerifiers.test.ts +388 -0
- package/src/webhooks/verifiers/sendgrid.ts +59 -0
- package/src/webhooks/verifiers/stripe.ts +67 -0
- package/src/webhooks/verifiers/twilio.ts +69 -0
- package/src/webhooks/webhooksApp.test.ts +221 -0
- package/src/webhooks/webhooksApp.ts +144 -0
- package/tsconfig.json +1 -1
- package/tsconfig.typedoc.json +2 -1
- package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.d.ts +0 -2
- package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
- package/src/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
package/src/rbac/routes.ts
CHANGED
|
@@ -6,6 +6,13 @@ import {APIError} from "../errors";
|
|
|
6
6
|
import type {TerrenoPlugin} from "../terrenoPlugin";
|
|
7
7
|
import type {AnyTerrenoAccess} from "./types";
|
|
8
8
|
|
|
9
|
+
const pathParam = (value: string | string[] | undefined, title: string): string => {
|
|
10
|
+
if (typeof value !== "string" || value.length === 0) {
|
|
11
|
+
throw new APIError({status: 400, title});
|
|
12
|
+
}
|
|
13
|
+
return value;
|
|
14
|
+
};
|
|
15
|
+
|
|
9
16
|
export interface RbacRouterOptions {
|
|
10
17
|
access: AnyTerrenoAccess;
|
|
11
18
|
userModel: UserModel;
|
|
@@ -70,7 +77,7 @@ export const rbacRouter = ({
|
|
|
70
77
|
const role = await access.roles.update({
|
|
71
78
|
actor,
|
|
72
79
|
changes: req.body,
|
|
73
|
-
roleName: req.params.name,
|
|
80
|
+
roleName: pathParam(req.params.name, "Role name is required"),
|
|
74
81
|
});
|
|
75
82
|
return res.json({data: role});
|
|
76
83
|
})
|
|
@@ -85,7 +92,10 @@ export const rbacRouter = ({
|
|
|
85
92
|
if (!actor) {
|
|
86
93
|
throw new APIError({status: 401, title: "Unauthorized"});
|
|
87
94
|
}
|
|
88
|
-
await access.roles.remove({
|
|
95
|
+
await access.roles.remove({
|
|
96
|
+
actor,
|
|
97
|
+
roleName: pathParam(req.params.name, "Role name is required"),
|
|
98
|
+
});
|
|
89
99
|
return res.status(204).send();
|
|
90
100
|
})
|
|
91
101
|
);
|
|
@@ -97,7 +107,7 @@ export const rbacRouter = ({
|
|
|
97
107
|
asyncHandler(async (req, res) => {
|
|
98
108
|
const diff = await access.roles.previewRoleChange({
|
|
99
109
|
permissions: req.body.permissions,
|
|
100
|
-
roleName: req.params.name,
|
|
110
|
+
roleName: pathParam(req.params.name, "Role name is required"),
|
|
101
111
|
});
|
|
102
112
|
return res.json({data: diff});
|
|
103
113
|
})
|
|
@@ -108,7 +118,7 @@ export const rbacRouter = ({
|
|
|
108
118
|
authenticateMiddleware(),
|
|
109
119
|
access.middleware({rbac: ["read"]}),
|
|
110
120
|
asyncHandler(async (req, res) => {
|
|
111
|
-
const user = await userModel.findById(req.params.id);
|
|
121
|
+
const user = await userModel.findById(pathParam(req.params.id, "User id is required"));
|
|
112
122
|
if (!user) {
|
|
113
123
|
throw new APIError({status: 404, title: "User not found"});
|
|
114
124
|
}
|
|
@@ -140,7 +150,7 @@ export const rbacRouter = ({
|
|
|
140
150
|
await access.roles.assign({
|
|
141
151
|
actor,
|
|
142
152
|
roleNames: req.body.roleNames,
|
|
143
|
-
userId: req.params.id,
|
|
153
|
+
userId: pathParam(req.params.id, "User id is required"),
|
|
144
154
|
});
|
|
145
155
|
return res.json({data: {success: true}});
|
|
146
156
|
})
|
|
@@ -158,7 +168,7 @@ export const rbacRouter = ({
|
|
|
158
168
|
const diff = await access.roles.previewAssignment({
|
|
159
169
|
actor,
|
|
160
170
|
roleNames: req.body.roleNames,
|
|
161
|
-
userId: req.params.id,
|
|
171
|
+
userId: pathParam(req.params.id, "User id is required"),
|
|
162
172
|
});
|
|
163
173
|
return res.json({data: diff});
|
|
164
174
|
})
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import {describe, expect, it} from "bun:test";
|
|
2
|
+
import {assert} from "chai";
|
|
2
3
|
|
|
3
4
|
import {
|
|
4
5
|
ADMIN_PAGE_PERMISSION,
|
|
@@ -12,13 +13,27 @@ import {
|
|
|
12
13
|
describe("rbac statements", () => {
|
|
13
14
|
it("exports terreno default vocabulary", () => {
|
|
14
15
|
expect(terrenoStatements.admin).toContain("access");
|
|
16
|
+
expect(terrenoStatements.admin).toContain("jobs");
|
|
15
17
|
expect(ADMIN_PAGE_PERMISSION).toEqual({admin: ["access"]});
|
|
16
18
|
expect(terrenoStatements.rbac).toContain("manageRoles");
|
|
17
19
|
expect(terrenoStatements.user).toContain("read");
|
|
18
20
|
expect(terrenoStatements.configuration).toContain("update");
|
|
19
21
|
expect(terrenoStatements.featureFlag).toEqual(["create", "list", "read", "update", "delete"]);
|
|
22
|
+
expect(terrenoStatements.organization).toEqual([
|
|
23
|
+
"create",
|
|
24
|
+
"list",
|
|
25
|
+
"read",
|
|
26
|
+
"update",
|
|
27
|
+
"delete",
|
|
28
|
+
"manageMembers",
|
|
29
|
+
"disable",
|
|
30
|
+
]);
|
|
20
31
|
expect(terrenoStatements.consentForm).toEqual(["create", "list", "read", "update", "delete"]);
|
|
21
32
|
expect(terrenoStatements.consentResponse).toEqual(["list", "read"]);
|
|
33
|
+
assert.deepEqual(
|
|
34
|
+
[...terrenoStatements.adminAnnouncementClickEvent],
|
|
35
|
+
["read", "write", "writeOwned"]
|
|
36
|
+
);
|
|
22
37
|
});
|
|
23
38
|
|
|
24
39
|
it("merges app statements over terreno defaults", () => {
|
|
@@ -40,6 +55,9 @@ describe("rbac statements", () => {
|
|
|
40
55
|
expect(expanded.featureFlag).toEqual([...terrenoStatements.featureFlag]);
|
|
41
56
|
expect(expanded.consentForm).toEqual([...terrenoStatements.consentForm]);
|
|
42
57
|
expect(expanded.consentResponse).toEqual([...terrenoStatements.consentResponse]);
|
|
58
|
+
assert.deepEqual(expanded.adminAnnouncementClickEvent, [
|
|
59
|
+
...terrenoStatements.adminAnnouncementClickEvent,
|
|
60
|
+
]);
|
|
43
61
|
});
|
|
44
62
|
|
|
45
63
|
it("expands read-only sentinel to read-ish actions", () => {
|
|
@@ -56,6 +74,7 @@ describe("rbac statements", () => {
|
|
|
56
74
|
expect(expanded.featureFlag).toEqual(["list", "read"]);
|
|
57
75
|
expect(expanded.consentForm).toEqual(["list", "read"]);
|
|
58
76
|
expect(expanded.consentResponse).toEqual(["list", "read"]);
|
|
77
|
+
expect(expanded.organization).toEqual(["list", "read"]);
|
|
59
78
|
});
|
|
60
79
|
|
|
61
80
|
it("returns concrete permission sets unchanged", () => {
|
package/src/rbac/statements.ts
CHANGED
|
@@ -8,15 +8,33 @@ export const ADMIN_PAGE_PERMISSION = {
|
|
|
8
8
|
[ADMIN_PAGE_RESOURCE]: [ADMIN_PAGE_ACTION],
|
|
9
9
|
} as const;
|
|
10
10
|
|
|
11
|
+
export const ORGANIZATION_ACTIONS = [
|
|
12
|
+
"create",
|
|
13
|
+
"list",
|
|
14
|
+
"read",
|
|
15
|
+
"update",
|
|
16
|
+
"delete",
|
|
17
|
+
"manageMembers",
|
|
18
|
+
"disable",
|
|
19
|
+
] as const;
|
|
20
|
+
|
|
11
21
|
export const terrenoStatements = {
|
|
12
|
-
admin: [ADMIN_PAGE_ACTION, "runScripts", "viewBackgroundTasks"],
|
|
22
|
+
admin: [ADMIN_PAGE_ACTION, "jobs", "runScripts", "viewBackgroundTasks"],
|
|
23
|
+
adminAnnouncement: ADMIN_MODEL_ACCESS,
|
|
24
|
+
adminAnnouncementAcknowledgement: ADMIN_MODEL_ACCESS,
|
|
25
|
+
adminAnnouncementClickEvent: ADMIN_MODEL_ACCESS,
|
|
26
|
+
adminAnnouncementImpression: ADMIN_MODEL_ACCESS,
|
|
13
27
|
adminConsentForm: ADMIN_MODEL_ACCESS,
|
|
14
28
|
adminConsentResponse: ADMIN_MODEL_ACCESS,
|
|
15
29
|
adminFeatureFlag: ADMIN_MODEL_ACCESS,
|
|
30
|
+
announcement: MODEL_CRUD,
|
|
31
|
+
announcementAcknowledgement: ["list", "read"],
|
|
32
|
+
announcementImpression: ["list", "read"],
|
|
16
33
|
configuration: ["read", "update"],
|
|
17
34
|
consentForm: MODEL_CRUD,
|
|
18
35
|
consentResponse: ["list", "read"],
|
|
19
36
|
featureFlag: MODEL_CRUD,
|
|
37
|
+
organization: ORGANIZATION_ACTIONS,
|
|
20
38
|
rbac: ["read", "manageRoles", "assignRoles"],
|
|
21
39
|
user: ["create", "list", "read", "update", "delete", "impersonate", "setPassword"],
|
|
22
40
|
} as const;
|
package/src/rbac/types.ts
CHANGED
|
@@ -150,6 +150,11 @@ export type RbacAuditSink = (record: RbacAuditWrite) => void | Promise<void>;
|
|
|
150
150
|
export interface AccessOptions<S extends Statements> {
|
|
151
151
|
connection: Connection;
|
|
152
152
|
statements: S;
|
|
153
|
+
/**
|
|
154
|
+
* Opt in to organization RBAC: membership `org-admin` grants and the locked `operator` seed.
|
|
155
|
+
* Default `false` so existing single-tenant apps stay unchanged. New apps from bootstrap pass `true`.
|
|
156
|
+
*/
|
|
157
|
+
organizations?: boolean;
|
|
153
158
|
userModel?: UserModel;
|
|
154
159
|
defaultRoles?: RoleDefinition[];
|
|
155
160
|
scopes?: ResourceScopes<S>;
|
|
@@ -10,11 +10,15 @@ import {APIError} from "../errors";
|
|
|
10
10
|
import {logger} from "../logger";
|
|
11
11
|
import type {PermissionMethod} from "../permissions";
|
|
12
12
|
import {canReadDocumentRealtime, maskRealtimeDocument} from "../rbac/realtimeAccess";
|
|
13
|
+
import {
|
|
14
|
+
authorizeAdminBroadcastDocument,
|
|
15
|
+
isAdminBroadcastSocketRoom,
|
|
16
|
+
} from "../sync/adminBroadcastScope";
|
|
13
17
|
import {computeStableFrontier, SyncScopeMove} from "../sync/models";
|
|
14
18
|
import {findSyncEntryByCollectionName, type SyncRegistryEntry} from "../sync/registry";
|
|
15
19
|
import {serializeSyncPayload} from "../sync/serialize";
|
|
16
20
|
import {syncRoomForStream} from "../sync/socketHandlers";
|
|
17
|
-
import {resolveStreamForDoc} from "../sync/streams";
|
|
21
|
+
import {adminBroadcastStream, resolveStreamForDoc} from "../sync/streams";
|
|
18
22
|
import type {SyncDelta, SyncMutationOperation, SyncResyncHint} from "../sync/types";
|
|
19
23
|
import {matchesQuery} from "./queryMatcher";
|
|
20
24
|
import {getQuerySubscriptionsForCollection} from "./queryStore";
|
|
@@ -58,10 +62,10 @@ let restartAttempts = 0;
|
|
|
58
62
|
let restartTimer: ReturnType<typeof setTimeout> | null = null;
|
|
59
63
|
|
|
60
64
|
/** First restart delay; doubles per consecutive attempt up to the max. */
|
|
61
|
-
|
|
65
|
+
const CHANGE_STREAM_RESTART_BASE_DELAY_MS = 250;
|
|
62
66
|
|
|
63
67
|
/** Ceiling for the restart backoff — a long outage retries once every 30s, forever. */
|
|
64
|
-
|
|
68
|
+
const CHANGE_STREAM_RESTART_MAX_DELAY_MS = 30_000;
|
|
65
69
|
|
|
66
70
|
/**
|
|
67
71
|
* Socket event telling clients their cached cursors may have gaps and they must
|
|
@@ -69,6 +73,7 @@ export const CHANGE_STREAM_RESTART_MAX_DELAY_MS = 30_000;
|
|
|
69
73
|
* (`ChangeStreamHistoryLost`), which is the one failure a resume token cannot repair.
|
|
70
74
|
* Payload: {@link SyncResyncHint}.
|
|
71
75
|
*/
|
|
76
|
+
/** @internal */
|
|
72
77
|
export const SYNC_RESYNC_EVENT = "sync:resync-required";
|
|
73
78
|
|
|
74
79
|
/** MongoDB error code / codeName for an unresumable change stream (oplog rolled past). */
|
|
@@ -116,6 +121,7 @@ const serializePerEntity = (key: string, task: () => Promise<void>): void => {
|
|
|
116
121
|
* events are internal (counters/ledger/markers/keys), and processing them would emit
|
|
117
122
|
* spurious deltas or reprocess scope-move markers. Exported for testing.
|
|
118
123
|
*/
|
|
124
|
+
/** @internal */
|
|
119
125
|
export const DEFAULT_IGNORED_COLLECTIONS = [
|
|
120
126
|
"socketio",
|
|
121
127
|
"sessions",
|
|
@@ -137,6 +143,7 @@ export const DEFAULT_IGNORED_COLLECTIONS = [
|
|
|
137
143
|
*
|
|
138
144
|
* Exported for testing.
|
|
139
145
|
*/
|
|
146
|
+
/** @internal */
|
|
140
147
|
export const mapOperationType = (
|
|
141
148
|
operationType: string,
|
|
142
149
|
change: ChangeStreamDocument,
|
|
@@ -192,10 +199,15 @@ const getSocketsInRoom = (io: Server, room: string): RealtimeSocketWithAuth[] =>
|
|
|
192
199
|
* `RealtimeRegistryEntry` and `SyncRegistryEntry` satisfy it structurally.
|
|
193
200
|
*/
|
|
194
201
|
export interface AuthorizedEmitEntry {
|
|
202
|
+
collectionTag?: string;
|
|
195
203
|
modelName: string;
|
|
196
204
|
options: {permissions: {read: PermissionMethod<unknown>[]}};
|
|
205
|
+
routePath?: string;
|
|
197
206
|
}
|
|
198
207
|
|
|
208
|
+
const emitCollectionTag = (entry: AuthorizedEmitEntry): string | undefined =>
|
|
209
|
+
entry.collectionTag ?? (entry.routePath ? getCollectionTag(entry.routePath) : undefined);
|
|
210
|
+
|
|
199
211
|
const canReadDocument = async (
|
|
200
212
|
entry: AuthorizedEmitEntry,
|
|
201
213
|
user?: User,
|
|
@@ -206,6 +218,7 @@ const canReadDocument = async (
|
|
|
206
218
|
* Determine which Socket.io rooms to emit to based on the room strategy.
|
|
207
219
|
* Exported for testing.
|
|
208
220
|
*/
|
|
221
|
+
/** @internal */
|
|
209
222
|
export const resolveRooms = (
|
|
210
223
|
entry: RealtimeRegistryEntry,
|
|
211
224
|
doc: Record<string, unknown>,
|
|
@@ -243,6 +256,7 @@ export const resolveRooms = (
|
|
|
243
256
|
* Ensure serialized documents include `id` to match REST API responses.
|
|
244
257
|
* Change stream fullDocument payloads are raw BSON objects with `_id` only.
|
|
245
258
|
*/
|
|
259
|
+
/** @internal */
|
|
246
260
|
export const ensureApiId = (data: unknown): unknown => {
|
|
247
261
|
if (data == null || typeof data !== "object" || Array.isArray(data)) {
|
|
248
262
|
return data;
|
|
@@ -270,6 +284,7 @@ export const ensureApiId = (data: unknown): unknown => {
|
|
|
270
284
|
* would risk leaking unsanitized fields (e.g. `hash`/`salt`) that the handler
|
|
271
285
|
* was supposed to strip.
|
|
272
286
|
*/
|
|
287
|
+
/** @internal */
|
|
273
288
|
export const serializeDoc = async (
|
|
274
289
|
entry: RealtimeRegistryEntry,
|
|
275
290
|
doc: Record<string, unknown>,
|
|
@@ -357,6 +372,22 @@ export const emitPayloadToAuthorizedRoom = async ({
|
|
|
357
372
|
// Hard deletes have no document context; use an empty object so object-scoped
|
|
358
373
|
// permission helpers fail closed instead of treating the check as preflight.
|
|
359
374
|
const permissionDocument = fullDocument ?? {};
|
|
375
|
+
const collectionTag = emitCollectionTag(entry);
|
|
376
|
+
if (collectionTag && isAdminBroadcastSocketRoom(room, collectionTag)) {
|
|
377
|
+
const adminDecision = await authorizeAdminBroadcastDocument({
|
|
378
|
+
doc: fullDocument,
|
|
379
|
+
modelName: entry.modelName,
|
|
380
|
+
user,
|
|
381
|
+
});
|
|
382
|
+
if (adminDecision === "deny") {
|
|
383
|
+
logDebug(`[realtime] Skipped ${room} for ${socket.id}: admin broadcast scope denied`);
|
|
384
|
+
continue;
|
|
385
|
+
}
|
|
386
|
+
if (adminDecision === "allow") {
|
|
387
|
+
socket.emit(eventName, await buildPayload(user));
|
|
388
|
+
continue;
|
|
389
|
+
}
|
|
390
|
+
}
|
|
360
391
|
const canRead = await canReadDocument(entry, user, permissionDocument);
|
|
361
392
|
if (!canRead) {
|
|
362
393
|
logDebug(`[realtime] Skipped ${room} for ${socket.id}: read permission denied`);
|
|
@@ -373,6 +404,7 @@ export const emitPayloadToAuthorizedRoom = async ({
|
|
|
373
404
|
}
|
|
374
405
|
};
|
|
375
406
|
|
|
407
|
+
/** @internal */
|
|
376
408
|
export const emitToAuthorizedRoom = async (
|
|
377
409
|
io: Server,
|
|
378
410
|
room: string,
|
|
@@ -413,6 +445,7 @@ export const emitToAuthorizedRoom = async (
|
|
|
413
445
|
*
|
|
414
446
|
* Exported for testing.
|
|
415
447
|
*/
|
|
448
|
+
/** @internal */
|
|
416
449
|
export const emitToDocumentAndQueryRooms = async (
|
|
417
450
|
io: Server,
|
|
418
451
|
collection: string,
|
|
@@ -718,37 +751,44 @@ export const emitSyncDeltaForChange = async ({
|
|
|
718
751
|
method = "create";
|
|
719
752
|
}
|
|
720
753
|
|
|
721
|
-
const
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
754
|
+
const emitLiveDelta = async (targetStream: string): Promise<void> => {
|
|
755
|
+
const frontierSeq = await computeStableFrontier({stream: targetStream});
|
|
756
|
+
const liveDelta: SyncDelta = {
|
|
757
|
+
collection: entry.collectionTag,
|
|
758
|
+
frontierSeq,
|
|
759
|
+
id: docId,
|
|
760
|
+
method,
|
|
761
|
+
seq,
|
|
762
|
+
stream: targetStream,
|
|
763
|
+
...(deleted ? {deleted: true} : {}),
|
|
764
|
+
};
|
|
765
|
+
await emitPayloadToAuthorizedRoom({
|
|
766
|
+
// C7: tombstone deltas carry no data (only id/seq/deleted); live deltas serialize.
|
|
767
|
+
buildPayload: deleted
|
|
768
|
+
? () => liveDelta
|
|
769
|
+
: async (user) => {
|
|
770
|
+
const syntheticReq = {params: {}, query: {}, user} as unknown as express.Request;
|
|
771
|
+
const data = ensureApiId(
|
|
772
|
+
await serializeSyncPayload({doc: fullDocument, entry, method, req: syntheticReq})
|
|
773
|
+
);
|
|
774
|
+
return {...liveDelta, data};
|
|
775
|
+
},
|
|
776
|
+
entry,
|
|
777
|
+
eventName: "sync:delta",
|
|
778
|
+
fullDocument,
|
|
779
|
+
io,
|
|
780
|
+
logDebug,
|
|
781
|
+
room: syncRoomForStream(targetStream),
|
|
782
|
+
});
|
|
783
|
+
logDebug(
|
|
784
|
+
`[sync] Emitted sync:delta ${method} for ${entry.collectionTag}/${docId} seq=${seq} stream=${targetStream} frontier=${frontierSeq}`
|
|
785
|
+
);
|
|
730
786
|
};
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
const syntheticReq = {params: {}, query: {}, user} as unknown as express.Request;
|
|
737
|
-
const data = ensureApiId(
|
|
738
|
-
await serializeSyncPayload({doc: fullDocument, entry, method, req: syntheticReq})
|
|
739
|
-
);
|
|
740
|
-
return {...delta, data};
|
|
741
|
-
},
|
|
742
|
-
entry,
|
|
743
|
-
eventName: "sync:delta",
|
|
744
|
-
fullDocument,
|
|
745
|
-
io,
|
|
746
|
-
logDebug,
|
|
747
|
-
room: syncRoomForStream(stream),
|
|
748
|
-
});
|
|
749
|
-
logDebug(
|
|
750
|
-
`[sync] Emitted sync:delta ${method} for ${entry.collectionTag}/${docId} seq=${seq} stream=${stream} frontier=${frontierSeq}`
|
|
751
|
-
);
|
|
787
|
+
|
|
788
|
+
await emitLiveDelta(stream);
|
|
789
|
+
if (entry.config.adminBroadcast === true) {
|
|
790
|
+
await emitLiveDelta(adminBroadcastStream(entry.collectionTag));
|
|
791
|
+
}
|
|
752
792
|
};
|
|
753
793
|
|
|
754
794
|
/**
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import {afterEach, describe, expect, it, spyOn} from "bun:test";
|
|
2
|
+
|
|
3
|
+
import {modelRouter} from "../api";
|
|
4
|
+
import {logger} from "../logger";
|
|
5
|
+
import {Permissions} from "../permissions";
|
|
6
|
+
import {FoodModel} from "../tests";
|
|
7
|
+
import {
|
|
8
|
+
REALTIME_DEPRECATION_MESSAGE,
|
|
9
|
+
resetRealtimeDeprecationWarningsForTests,
|
|
10
|
+
} from "./deprecation";
|
|
11
|
+
import {clearRealtimeRegistry} from "./registry";
|
|
12
|
+
|
|
13
|
+
const realtimeConfig = {
|
|
14
|
+
methods: ["create", "update", "delete"] as Array<"create" | "update" | "delete">,
|
|
15
|
+
roomStrategy: "model" as const,
|
|
16
|
+
};
|
|
17
|
+
|
|
18
|
+
const permissions = {
|
|
19
|
+
create: [Permissions.IsAny],
|
|
20
|
+
delete: [Permissions.IsAny],
|
|
21
|
+
list: [Permissions.IsAny],
|
|
22
|
+
read: [Permissions.IsAny],
|
|
23
|
+
update: [Permissions.IsAny],
|
|
24
|
+
};
|
|
25
|
+
|
|
26
|
+
describe("modelRouter realtime deprecation", () => {
|
|
27
|
+
afterEach(() => {
|
|
28
|
+
resetRealtimeDeprecationWarningsForTests();
|
|
29
|
+
clearRealtimeRegistry();
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
it("warns once per model and path when realtime is configured", () => {
|
|
33
|
+
const warnSpy = spyOn(logger, "warn").mockImplementation(() => logger);
|
|
34
|
+
|
|
35
|
+
modelRouter("/foods", FoodModel, {permissions, realtime: realtimeConfig});
|
|
36
|
+
modelRouter("/foods", FoodModel, {permissions, realtime: realtimeConfig});
|
|
37
|
+
|
|
38
|
+
const deprecationCalls = warnSpy.mock.calls.filter((args) =>
|
|
39
|
+
String(args[0]).includes(REALTIME_DEPRECATION_MESSAGE)
|
|
40
|
+
);
|
|
41
|
+
expect(deprecationCalls).toHaveLength(1);
|
|
42
|
+
expect(String(deprecationCalls[0]?.[0])).toContain("Food at /foods");
|
|
43
|
+
|
|
44
|
+
warnSpy.mockRestore();
|
|
45
|
+
});
|
|
46
|
+
|
|
47
|
+
it("warns when realtime is used without the path form", () => {
|
|
48
|
+
const warnSpy = spyOn(logger, "warn").mockImplementation(() => logger);
|
|
49
|
+
|
|
50
|
+
modelRouter(FoodModel, {permissions, realtime: realtimeConfig});
|
|
51
|
+
|
|
52
|
+
const deprecationCalls = warnSpy.mock.calls.filter((args) =>
|
|
53
|
+
String(args[0]).includes(REALTIME_DEPRECATION_MESSAGE)
|
|
54
|
+
);
|
|
55
|
+
expect(deprecationCalls).toHaveLength(1);
|
|
56
|
+
expect(String(deprecationCalls[0]?.[0])).toContain("(Food)");
|
|
57
|
+
|
|
58
|
+
warnSpy.mockRestore();
|
|
59
|
+
});
|
|
60
|
+
});
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import {logger} from "../logger";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* One-line warning for modelRouter `realtime`. Keep in sync with the
|
|
5
|
+
* `@terreno/rtk` helpers and `docs/implementationPlans/remove-legacy-realtime.md`.
|
|
6
|
+
*/
|
|
7
|
+
/** @internal */
|
|
8
|
+
export const REALTIME_DEPRECATION_MESSAGE =
|
|
9
|
+
"modelRouter `realtime` is deprecated and will be removed in Terreno 58. Use `sync` with `@terreno/syncdb` instead. See docs/how-to/migrate-rtk-to-syncdb.md. RealtimeApp remains required for sync sockets.";
|
|
10
|
+
|
|
11
|
+
const warnedKeys = new Set<string>();
|
|
12
|
+
|
|
13
|
+
const warningKey = (modelName: string, routePath?: string): string =>
|
|
14
|
+
`${modelName}:${routePath ?? ""}`;
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Emits a one-time deprecation warning per model/routePath per process when a
|
|
18
|
+
* consumer enables the legacy RTK cache-patching `realtime` option.
|
|
19
|
+
*/
|
|
20
|
+
export const warnRealtimeDeprecated = (modelName: string, routePath?: string): void => {
|
|
21
|
+
const key = warningKey(modelName, routePath);
|
|
22
|
+
if (warnedKeys.has(key)) {
|
|
23
|
+
return;
|
|
24
|
+
}
|
|
25
|
+
warnedKeys.add(key);
|
|
26
|
+
const location = routePath ? `${modelName} at ${routePath}` : modelName;
|
|
27
|
+
logger.warn(`[realtime] ${REALTIME_DEPRECATION_MESSAGE} (${location})`);
|
|
28
|
+
};
|
|
29
|
+
|
|
30
|
+
/** @internal Test helper — clears one-time realtime deprecation warnings. */
|
|
31
|
+
export const resetRealtimeDeprecationWarningsForTests = (): void => {
|
|
32
|
+
warnedKeys.clear();
|
|
33
|
+
};
|