@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
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
import {beforeEach, describe, expect, it, spyOn} from "bun:test";
|
|
2
|
+
import mongoose, {model, Schema} from "mongoose";
|
|
3
|
+
|
|
4
|
+
import type {UserModel} from "../auth";
|
|
5
|
+
import {setupDb} from "../tests";
|
|
6
|
+
import {createAccess} from "./access";
|
|
7
|
+
import {backfillAdmins} from "./backfillAdmins";
|
|
8
|
+
import {terrenoStatements} from "./statements";
|
|
9
|
+
import {rbacUserPlugin} from "./userPlugin";
|
|
10
|
+
|
|
11
|
+
interface BackfillUser {
|
|
12
|
+
admin: boolean;
|
|
13
|
+
email: string;
|
|
14
|
+
roles: string[];
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
const backfillUserSchema = new Schema<BackfillUser>({
|
|
18
|
+
admin: {default: false, description: "Whether the user is an admin", type: Boolean},
|
|
19
|
+
email: {description: "The user's email", type: String},
|
|
20
|
+
});
|
|
21
|
+
rbacUserPlugin(backfillUserSchema);
|
|
22
|
+
|
|
23
|
+
const BackfillUserModel = model<BackfillUser>("BackfillAdminsUser", backfillUserSchema);
|
|
24
|
+
|
|
25
|
+
const asUserModel = (): UserModel => BackfillUserModel as unknown as UserModel;
|
|
26
|
+
|
|
27
|
+
const createAccessForTest = () =>
|
|
28
|
+
createAccess({
|
|
29
|
+
connection: mongoose.connection,
|
|
30
|
+
statements: terrenoStatements,
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
const createUser = async (overrides: Partial<BackfillUser> = {}): Promise<string> => {
|
|
34
|
+
const user = await BackfillUserModel.create({
|
|
35
|
+
admin: true,
|
|
36
|
+
email: `${new mongoose.Types.ObjectId().toString()}@example.com`,
|
|
37
|
+
...overrides,
|
|
38
|
+
});
|
|
39
|
+
return user.id;
|
|
40
|
+
};
|
|
41
|
+
|
|
42
|
+
const findRoles = async (id: string): Promise<string[]> => {
|
|
43
|
+
const user = await BackfillUserModel.findById(id);
|
|
44
|
+
return user?.roles ?? [];
|
|
45
|
+
};
|
|
46
|
+
|
|
47
|
+
describe("backfillAdmins", () => {
|
|
48
|
+
beforeEach(async () => {
|
|
49
|
+
await setupDb();
|
|
50
|
+
await BackfillUserModel.deleteMany({});
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
it("reports matched admins without persisting on a dry run", async () => {
|
|
54
|
+
const access = createAccessForTest();
|
|
55
|
+
const invalidateCache = spyOn(access, "invalidateCache");
|
|
56
|
+
const adminId = await createUser();
|
|
57
|
+
await createUser({admin: false});
|
|
58
|
+
|
|
59
|
+
const result = await backfillAdmins({access, userModel: asUserModel()});
|
|
60
|
+
|
|
61
|
+
expect(result).toEqual({dryRun: true, matched: 1, updated: 1});
|
|
62
|
+
expect(await findRoles(adminId)).toEqual([]);
|
|
63
|
+
expect(invalidateCache).not.toHaveBeenCalled();
|
|
64
|
+
});
|
|
65
|
+
|
|
66
|
+
it("assigns the superadmin role and invalidates the cache on a wet run", async () => {
|
|
67
|
+
const access = createAccessForTest();
|
|
68
|
+
const invalidateCache = spyOn(access, "invalidateCache");
|
|
69
|
+
const adminId = await createUser();
|
|
70
|
+
|
|
71
|
+
const result = await backfillAdmins({access, userModel: asUserModel(), wetRun: true});
|
|
72
|
+
|
|
73
|
+
expect(result).toEqual({dryRun: false, matched: 1, updated: 1});
|
|
74
|
+
expect(await findRoles(adminId)).toEqual(["superadmin"]);
|
|
75
|
+
expect(invalidateCache).toHaveBeenCalledWith({userId: adminId});
|
|
76
|
+
});
|
|
77
|
+
|
|
78
|
+
it("preserves existing roles when adding the backfilled role", async () => {
|
|
79
|
+
const access = createAccessForTest();
|
|
80
|
+
const adminId = await createUser({roles: ["member"]});
|
|
81
|
+
|
|
82
|
+
const result = await backfillAdmins({access, userModel: asUserModel(), wetRun: true});
|
|
83
|
+
|
|
84
|
+
expect(result.updated).toBe(1);
|
|
85
|
+
expect(await findRoles(adminId)).toEqual(["member", "superadmin"]);
|
|
86
|
+
});
|
|
87
|
+
|
|
88
|
+
it("skips admins that already have the role", async () => {
|
|
89
|
+
const access = createAccessForTest();
|
|
90
|
+
const invalidateCache = spyOn(access, "invalidateCache");
|
|
91
|
+
await createUser({roles: ["superadmin"]});
|
|
92
|
+
const missingRoleId = await createUser();
|
|
93
|
+
|
|
94
|
+
const result = await backfillAdmins({access, userModel: asUserModel(), wetRun: true});
|
|
95
|
+
|
|
96
|
+
expect(result).toEqual({dryRun: false, matched: 2, updated: 1});
|
|
97
|
+
expect(invalidateCache).toHaveBeenCalledTimes(1);
|
|
98
|
+
expect(invalidateCache).toHaveBeenCalledWith({userId: missingRoleId});
|
|
99
|
+
});
|
|
100
|
+
|
|
101
|
+
it("supports a custom role name", async () => {
|
|
102
|
+
const access = createAccessForTest();
|
|
103
|
+
const adminId = await createUser();
|
|
104
|
+
|
|
105
|
+
const result = await backfillAdmins({
|
|
106
|
+
access,
|
|
107
|
+
roleName: "supportAdmin",
|
|
108
|
+
userModel: asUserModel(),
|
|
109
|
+
wetRun: true,
|
|
110
|
+
});
|
|
111
|
+
|
|
112
|
+
expect(result).toEqual({dryRun: false, matched: 1, updated: 1});
|
|
113
|
+
expect(await findRoles(adminId)).toEqual(["supportAdmin"]);
|
|
114
|
+
});
|
|
115
|
+
|
|
116
|
+
it("returns zero counts when there are no admins", async () => {
|
|
117
|
+
const access = createAccessForTest();
|
|
118
|
+
await createUser({admin: false});
|
|
119
|
+
|
|
120
|
+
const result = await backfillAdmins({access, userModel: asUserModel(), wetRun: true});
|
|
121
|
+
|
|
122
|
+
expect(result).toEqual({dryRun: false, matched: 0, updated: 0});
|
|
123
|
+
});
|
|
124
|
+
});
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import {describe, expect, it} from "bun:test";
|
|
2
|
+
import {assert} from "chai";
|
|
2
3
|
|
|
3
4
|
import {applyReadMask, getDisallowedWriteKeys} from "./fieldViews";
|
|
5
|
+
import type {FieldMask} from "./types";
|
|
4
6
|
|
|
5
7
|
describe("fieldViews", () => {
|
|
6
8
|
it("applyReadMask picks only allowed read paths", () => {
|
|
@@ -36,4 +38,91 @@ describe("fieldViews", () => {
|
|
|
36
38
|
);
|
|
37
39
|
expect(disallowed).toEqual(["admin"]);
|
|
38
40
|
});
|
|
41
|
+
|
|
42
|
+
it("applyReadMask returns primitives and null untouched", () => {
|
|
43
|
+
const mask: FieldMask = {omit: ["anything"], read: ["name"], write: []};
|
|
44
|
+
assert.equal(applyReadMask("plain", mask), "plain");
|
|
45
|
+
assert.equal(applyReadMask(7, mask), 7);
|
|
46
|
+
assert.isNull(applyReadMask(null, mask));
|
|
47
|
+
assert.isUndefined(applyReadMask(undefined, mask));
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
it("applyReadMask maps over arrays, including nested arrays of documents", () => {
|
|
51
|
+
const masked = applyReadMask(
|
|
52
|
+
[{name: "a", secret: "s"}, {name: "b", secret: "s"}, "primitive"],
|
|
53
|
+
{omit: [], read: ["name"], write: []}
|
|
54
|
+
);
|
|
55
|
+
assert.deepEqual(masked, [{name: "a"}, {name: "b"}, "primitive"]);
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
it("applyReadMask picks nested paths and skips paths missing from the document", () => {
|
|
59
|
+
const masked = applyReadMask(
|
|
60
|
+
{name: "Todo", profile: {email: "a@b.com", phone: "555"}},
|
|
61
|
+
{omit: [], read: ["profile.email", "profile.missing", "absent.deep", "name"], write: []}
|
|
62
|
+
);
|
|
63
|
+
assert.deepEqual(masked, {name: "Todo", profile: {email: "a@b.com"}});
|
|
64
|
+
});
|
|
65
|
+
|
|
66
|
+
it("applyReadMask omits top-level paths and ignores omissions with no parent object", () => {
|
|
67
|
+
const masked = applyReadMask(
|
|
68
|
+
{name: "Todo", profile: {email: "a@b.com"}, secret: "hidden"},
|
|
69
|
+
{omit: ["secret", "missing.deep", "profile.missing"], read: "*", write: []}
|
|
70
|
+
);
|
|
71
|
+
assert.deepEqual(masked, {name: "Todo", profile: {email: "a@b.com"}});
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
it("applyReadMask deep clones so mutating the result leaves the document intact", () => {
|
|
75
|
+
const doc = {profile: {tags: ["a"]}};
|
|
76
|
+
const masked = applyReadMask(doc, {omit: [], read: "*", write: []}) as {
|
|
77
|
+
profile: {tags: string[]};
|
|
78
|
+
};
|
|
79
|
+
masked.profile.tags.push("b");
|
|
80
|
+
assert.deepEqual(doc.profile.tags, ["a"]);
|
|
81
|
+
});
|
|
82
|
+
|
|
83
|
+
it("getDisallowedWriteKeys allows everything for a wildcard write mask", () => {
|
|
84
|
+
assert.deepEqual(
|
|
85
|
+
getDisallowedWriteKeys(
|
|
86
|
+
{admin: true, profile: {email: "a@b.com"}},
|
|
87
|
+
{
|
|
88
|
+
omit: [],
|
|
89
|
+
read: "*",
|
|
90
|
+
write: "*",
|
|
91
|
+
}
|
|
92
|
+
),
|
|
93
|
+
[]
|
|
94
|
+
);
|
|
95
|
+
});
|
|
96
|
+
|
|
97
|
+
it("getDisallowedWriteKeys allows a whole subtree when its parent path is writable", () => {
|
|
98
|
+
assert.deepEqual(
|
|
99
|
+
getDisallowedWriteKeys(
|
|
100
|
+
{profile: {email: "a@b.com", phone: "555"}},
|
|
101
|
+
{
|
|
102
|
+
omit: [],
|
|
103
|
+
read: "*",
|
|
104
|
+
write: ["profile"],
|
|
105
|
+
}
|
|
106
|
+
),
|
|
107
|
+
[]
|
|
108
|
+
);
|
|
109
|
+
});
|
|
110
|
+
|
|
111
|
+
it("getDisallowedWriteKeys reports the whole object when no nested path is writable", () => {
|
|
112
|
+
assert.deepEqual(
|
|
113
|
+
getDisallowedWriteKeys(
|
|
114
|
+
{name: "x", profile: {email: "a@b.com"}},
|
|
115
|
+
{
|
|
116
|
+
omit: [],
|
|
117
|
+
read: "*",
|
|
118
|
+
write: ["name"],
|
|
119
|
+
}
|
|
120
|
+
),
|
|
121
|
+
["profile"]
|
|
122
|
+
);
|
|
123
|
+
});
|
|
124
|
+
|
|
125
|
+
it("getDisallowedWriteKeys returns nothing for an empty body", () => {
|
|
126
|
+
assert.deepEqual(getDisallowedWriteKeys({}, {omit: [], read: "*", write: ["name"]}), []);
|
|
127
|
+
});
|
|
39
128
|
});
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import type {User} from "../auth";
|
|
2
|
+
import {Membership} from "../orgs/organizationModel";
|
|
3
|
+
import {getOrgContext} from "../orgs/orgContext";
|
|
4
|
+
import type {PermissionSet} from "./statements";
|
|
5
|
+
import type {PermissionSource, PermissionSourceGrants} from "./types";
|
|
6
|
+
|
|
7
|
+
export const MEMBERSHIP_ORG_ADMIN_PERMISSION_SOURCE_NAME = "membership-org-admin";
|
|
8
|
+
|
|
9
|
+
/** Grants applied when `Membership.roleName` is `org-admin` in the current org context. */
|
|
10
|
+
export const ORG_ADMIN_PERMISSION_BUNDLE: PermissionSet = {
|
|
11
|
+
admin: ["access"],
|
|
12
|
+
organization: ["read", "update", "manageMembers"],
|
|
13
|
+
};
|
|
14
|
+
|
|
15
|
+
const userIdForMembershipLookup = (user: User): string => {
|
|
16
|
+
if (user._id) {
|
|
17
|
+
return String(user._id);
|
|
18
|
+
}
|
|
19
|
+
return user.id;
|
|
20
|
+
};
|
|
21
|
+
|
|
22
|
+
const isActiveOrgAdminMembership = (membership?: {roleName?: string; status?: string}): boolean => {
|
|
23
|
+
return membership?.roleName === "org-admin" && membership.status === "active";
|
|
24
|
+
};
|
|
25
|
+
|
|
26
|
+
const fullOrgAdminGrants = (): PermissionSourceGrants => ({
|
|
27
|
+
permissions: {
|
|
28
|
+
admin: [...ORG_ADMIN_PERMISSION_BUNDLE.admin],
|
|
29
|
+
organization: [...ORG_ADMIN_PERMISSION_BUNDLE.organization],
|
|
30
|
+
},
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
const shellOnlyOrgAdminGrants = (): PermissionSourceGrants => ({
|
|
34
|
+
permissions: {
|
|
35
|
+
admin: [...ORG_ADMIN_PERMISSION_BUNDLE.admin],
|
|
36
|
+
},
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
export const membershipOrgAdminPermissionSource = (): PermissionSource => ({
|
|
40
|
+
getGrants: async ({user}): Promise<PermissionSourceGrants | null> => {
|
|
41
|
+
const contextMembership = getOrgContext()?.membership;
|
|
42
|
+
if (contextMembership) {
|
|
43
|
+
if (!isActiveOrgAdminMembership(contextMembership)) {
|
|
44
|
+
return null;
|
|
45
|
+
}
|
|
46
|
+
return fullOrgAdminGrants();
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
const activeMemberships = await Membership.findActiveForUser(userIdForMembershipLookup(user));
|
|
50
|
+
const hasOrgAdminMembership = activeMemberships.some((row) => row.roleName === "org-admin");
|
|
51
|
+
if (!hasOrgAdminMembership) {
|
|
52
|
+
return null;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
return shellOnlyOrgAdminGrants();
|
|
56
|
+
},
|
|
57
|
+
name: MEMBERSHIP_ORG_ADMIN_PERMISSION_SOURCE_NAME,
|
|
58
|
+
ttlMs: 0,
|
|
59
|
+
});
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import {describe, expect, it} from "bun:test";
|
|
2
|
+
import {assert} from "chai";
|
|
2
3
|
import mongoose from "mongoose";
|
|
3
4
|
|
|
4
5
|
import type {User} from "../auth";
|
|
@@ -8,6 +9,7 @@ import {createAccess} from "./access";
|
|
|
8
9
|
import {
|
|
9
10
|
buildAccessPermissions,
|
|
10
11
|
buildAccessQueryFilter,
|
|
12
|
+
resolveActionForMethod,
|
|
11
13
|
resolveModelRouterAccess,
|
|
12
14
|
validateAccessWriteBody,
|
|
13
15
|
wrapAccessResponseHandler,
|
|
@@ -35,6 +37,24 @@ const createTestUser = (
|
|
|
35
37
|
};
|
|
36
38
|
};
|
|
37
39
|
|
|
40
|
+
/**
|
|
41
|
+
* Minimal TerrenoAccess stub for the filter-merging branches, which depend only on
|
|
42
|
+
* `statements` and `queryFilter` and would otherwise need a seeded role per case.
|
|
43
|
+
*/
|
|
44
|
+
const createAccessStub = (
|
|
45
|
+
scopeFilter: Record<string, unknown> | null
|
|
46
|
+
): AnyTerrenoAccess & {queryFilterCalls: number} => {
|
|
47
|
+
const stub = {
|
|
48
|
+
queryFilter: async () => {
|
|
49
|
+
stub.queryFilterCalls += 1;
|
|
50
|
+
return scopeFilter;
|
|
51
|
+
},
|
|
52
|
+
queryFilterCalls: 0,
|
|
53
|
+
statements: appStatements,
|
|
54
|
+
};
|
|
55
|
+
return stub as unknown as AnyTerrenoAccess & {queryFilterCalls: number};
|
|
56
|
+
};
|
|
57
|
+
|
|
38
58
|
describe("modelRouterAccess", () => {
|
|
39
59
|
it("builds permissions from access config", async () => {
|
|
40
60
|
await setupDb();
|
|
@@ -315,6 +335,112 @@ describe("modelRouterAccess", () => {
|
|
|
315
335
|
expect(resolved.responseHandler).toBeDefined();
|
|
316
336
|
});
|
|
317
337
|
|
|
338
|
+
it("resolves actions per method", () => {
|
|
339
|
+
const statements: Record<string, readonly string[]> = appStatements;
|
|
340
|
+
assert.equal(
|
|
341
|
+
resolveActionForMethod("list", {actions: {list: "browse"}, resource: "todo"}, statements),
|
|
342
|
+
"browse"
|
|
343
|
+
);
|
|
344
|
+
assert.isNull(
|
|
345
|
+
resolveActionForMethod("read", {actions: {read: null}, resource: "todo"}, statements)
|
|
346
|
+
);
|
|
347
|
+
assert.equal(resolveActionForMethod("list", {resource: "todo"}, statements), "list");
|
|
348
|
+
assert.equal(resolveActionForMethod("list", {resource: "unknown"}, statements), "read");
|
|
349
|
+
assert.equal(resolveActionForMethod("update", {resource: "todo"}, statements), "update");
|
|
350
|
+
});
|
|
351
|
+
|
|
352
|
+
it("returns null when the access scope filter denies every row", async () => {
|
|
353
|
+
const queryFilter = buildAccessQueryFilter(createAccessStub(null), {resource: "todo"});
|
|
354
|
+
assert.isNull(await queryFilter(createTestUser(["reader"]), {completed: false}));
|
|
355
|
+
});
|
|
356
|
+
|
|
357
|
+
it("keeps the incoming query when the scope filter is empty", async () => {
|
|
358
|
+
const queryFilter = buildAccessQueryFilter(createAccessStub({}), {resource: "todo"});
|
|
359
|
+
assert.deepEqual(await queryFilter(createTestUser(["reader"]), {completed: false}), {
|
|
360
|
+
completed: false,
|
|
361
|
+
});
|
|
362
|
+
});
|
|
363
|
+
|
|
364
|
+
it("skips scope filtering when the list action is disabled", async () => {
|
|
365
|
+
const access = createAccessStub({ownerId: "someone-else"});
|
|
366
|
+
const queryFilter = buildAccessQueryFilter(access, {
|
|
367
|
+
actions: {list: null},
|
|
368
|
+
resource: "todo",
|
|
369
|
+
});
|
|
370
|
+
|
|
371
|
+
assert.deepEqual(await queryFilter(createTestUser(["reader"]), {completed: true}), {
|
|
372
|
+
completed: true,
|
|
373
|
+
});
|
|
374
|
+
assert.equal(access.queryFilterCalls, 0);
|
|
375
|
+
});
|
|
376
|
+
|
|
377
|
+
it("merges the per-router scope filter on top of the access filter", async () => {
|
|
378
|
+
const queryFilter = buildAccessQueryFilter(createAccessStub({tenantId: "t1"}), {
|
|
379
|
+
resource: "todo",
|
|
380
|
+
scope: {
|
|
381
|
+
filter: async ({user}) => ({ownerId: user.id}),
|
|
382
|
+
},
|
|
383
|
+
});
|
|
384
|
+
const user = createTestUser(["reader"]);
|
|
385
|
+
|
|
386
|
+
assert.deepEqual(await queryFilter(user, {completed: false}), {
|
|
387
|
+
$and: [{$and: [{completed: false}, {tenantId: "t1"}]}, {ownerId: user.id}],
|
|
388
|
+
});
|
|
389
|
+
});
|
|
390
|
+
|
|
391
|
+
it("denies scope checks for anonymous requests and rejected docs", async () => {
|
|
392
|
+
await setupDb();
|
|
393
|
+
const access = createAccess({
|
|
394
|
+
connection: mongoose.connection,
|
|
395
|
+
defaultRoles: [
|
|
396
|
+
{
|
|
397
|
+
displayName: "Reader",
|
|
398
|
+
name: "reader",
|
|
399
|
+
permissions: {todo: ["read"]},
|
|
400
|
+
},
|
|
401
|
+
],
|
|
402
|
+
statements: appStatements,
|
|
403
|
+
});
|
|
404
|
+
await access.roles.seedDefaults();
|
|
405
|
+
|
|
406
|
+
const permissions = buildAccessPermissions(access as AnyTerrenoAccess, {
|
|
407
|
+
resource: "todo",
|
|
408
|
+
scope: {
|
|
409
|
+
check: ({doc}) => (doc as {ownerId?: string} | undefined)?.ownerId === "mine",
|
|
410
|
+
},
|
|
411
|
+
});
|
|
412
|
+
const scopeCheck = permissions.read[1];
|
|
413
|
+
const user = createTestUser(["reader"]);
|
|
414
|
+
|
|
415
|
+
assert.isFalse(await scopeCheck("read", undefined, {ownerId: "mine"}));
|
|
416
|
+
assert.isFalse(await scopeCheck("read", user, {ownerId: "theirs"}));
|
|
417
|
+
assert.isTrue(await scopeCheck("read", user, {ownerId: "mine"}));
|
|
418
|
+
});
|
|
419
|
+
|
|
420
|
+
it("appends the `also` permission checks after the access checks", async () => {
|
|
421
|
+
await setupDb();
|
|
422
|
+
const access = createAccess({
|
|
423
|
+
connection: mongoose.connection,
|
|
424
|
+
defaultRoles: [
|
|
425
|
+
{
|
|
426
|
+
displayName: "Reader",
|
|
427
|
+
name: "reader",
|
|
428
|
+
permissions: {todo: ["read"]},
|
|
429
|
+
},
|
|
430
|
+
],
|
|
431
|
+
statements: appStatements,
|
|
432
|
+
});
|
|
433
|
+
await access.roles.seedDefaults();
|
|
434
|
+
|
|
435
|
+
const permissions = buildAccessPermissions(access as AnyTerrenoAccess, {
|
|
436
|
+
also: {read: [Permissions.IsAdmin]},
|
|
437
|
+
resource: "todo",
|
|
438
|
+
});
|
|
439
|
+
|
|
440
|
+
assert.lengthOf(permissions.read, 2);
|
|
441
|
+
assert.isFalse(await permissions.read[1]("read", createTestUser(["reader"])));
|
|
442
|
+
});
|
|
443
|
+
|
|
318
444
|
it("returns legacy permissions when access config is absent", () => {
|
|
319
445
|
const permissions = {
|
|
320
446
|
create: [Permissions.IsAdmin],
|
|
@@ -35,7 +35,7 @@ const mergeFilters = (
|
|
|
35
35
|
return {$and: [existing, scopeFilter]};
|
|
36
36
|
};
|
|
37
37
|
|
|
38
|
-
const resolveActionForMethod = (
|
|
38
|
+
export const resolveActionForMethod = (
|
|
39
39
|
method: RESTMethod,
|
|
40
40
|
access: ModelRouterAccessOptions,
|
|
41
41
|
statements: Record<string, readonly string[]>
|
|
@@ -62,6 +62,7 @@ const buildPermissionRequest = (resource: string, action: string): Record<string
|
|
|
62
62
|
[resource]: [action],
|
|
63
63
|
});
|
|
64
64
|
|
|
65
|
+
/** @internal */
|
|
65
66
|
export const buildAccessPermissions = <T>(
|
|
66
67
|
accessControl: AnyTerrenoAccess,
|
|
67
68
|
access: ModelRouterAccessOptions
|
|
@@ -115,6 +116,7 @@ export const buildAccessPermissions = <T>(
|
|
|
115
116
|
};
|
|
116
117
|
};
|
|
117
118
|
|
|
119
|
+
/** @internal */
|
|
118
120
|
export const buildAccessQueryFilter = <_T>(
|
|
119
121
|
accessControl: AnyTerrenoAccess,
|
|
120
122
|
access: ModelRouterAccessOptions,
|
|
@@ -161,6 +163,7 @@ export const buildAccessQueryFilter = <_T>(
|
|
|
161
163
|
};
|
|
162
164
|
};
|
|
163
165
|
|
|
166
|
+
/** @internal */
|
|
164
167
|
export const wrapAccessResponseHandler = <T>(
|
|
165
168
|
accessControl: AnyTerrenoAccess,
|
|
166
169
|
access: ModelRouterAccessOptions,
|
|
@@ -299,7 +302,10 @@ export const resolveModelRouterAccess = <T>(options: {
|
|
|
299
302
|
} => {
|
|
300
303
|
if (!options.access || !options.accessControl) {
|
|
301
304
|
if (!options.permissions) {
|
|
302
|
-
throw new
|
|
305
|
+
throw new APIError({
|
|
306
|
+
status: 500,
|
|
307
|
+
title: "modelRouter requires permissions or access with accessControl",
|
|
308
|
+
});
|
|
303
309
|
}
|
|
304
310
|
return {
|
|
305
311
|
permissions: options.permissions,
|
|
@@ -101,12 +101,33 @@ describe("rbac permission utils and middleware", () => {
|
|
|
101
101
|
const first = await access.getPermissions({user});
|
|
102
102
|
expect(first.todo).toEqual(["read"]);
|
|
103
103
|
|
|
104
|
-
user.roles = [];
|
|
105
|
-
const cached = await access.getPermissions({user});
|
|
106
|
-
expect(cached.todo).toEqual(["read"]);
|
|
107
|
-
|
|
108
104
|
access.invalidateCache({userId: user.id});
|
|
109
105
|
const refreshed = await access.getPermissions({user});
|
|
110
|
-
expect(refreshed.todo).
|
|
106
|
+
expect(refreshed.todo).toEqual(["read"]);
|
|
107
|
+
});
|
|
108
|
+
|
|
109
|
+
it("does not reuse cached permissions after the user's roles change", async () => {
|
|
110
|
+
await setupDb();
|
|
111
|
+
const access = createAccess({
|
|
112
|
+
cacheTtlMs: 60_000,
|
|
113
|
+
connection: mongoose.connection,
|
|
114
|
+
defaultRoles: [
|
|
115
|
+
{
|
|
116
|
+
displayName: "Reader",
|
|
117
|
+
name: "reader",
|
|
118
|
+
permissions: {todo: ["read"]},
|
|
119
|
+
},
|
|
120
|
+
],
|
|
121
|
+
statements: appStatements,
|
|
122
|
+
});
|
|
123
|
+
await access.roles.seedDefaults();
|
|
124
|
+
|
|
125
|
+
const user = createUser({roles: ["reader"]});
|
|
126
|
+
const first = await access.getPermissions({user});
|
|
127
|
+
expect(first.todo).toEqual(["read"]);
|
|
128
|
+
|
|
129
|
+
user.roles = [];
|
|
130
|
+
const afterRoleChange = await access.getPermissions({user});
|
|
131
|
+
expect(afterRoleChange.todo).toBeUndefined();
|
|
111
132
|
});
|
|
112
133
|
});
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import {APIError} from "../errors";
|
|
1
2
|
import type {PermissionSet} from "./statements";
|
|
2
3
|
|
|
3
4
|
export const unionPermissionSets = (...sets: PermissionSet[]): PermissionSet => {
|
|
@@ -72,11 +73,11 @@ export const validatePermissionSet = (
|
|
|
72
73
|
for (const [resource, actions] of Object.entries(permissions)) {
|
|
73
74
|
const allowedActions = statements[resource];
|
|
74
75
|
if (!allowedActions) {
|
|
75
|
-
throw new
|
|
76
|
+
throw new APIError({status: 500, title: `Unknown resource: ${resource}`});
|
|
76
77
|
}
|
|
77
78
|
for (const action of actions) {
|
|
78
79
|
if (!allowedActions.includes(action)) {
|
|
79
|
-
throw new
|
|
80
|
+
throw new APIError({status: 500, title: `Unknown permission: ${resource}:${action}`});
|
|
80
81
|
}
|
|
81
82
|
}
|
|
82
83
|
}
|
|
@@ -13,7 +13,13 @@ import {
|
|
|
13
13
|
} from "./realtimeAccess";
|
|
14
14
|
import {OwnerScope} from "./scopes";
|
|
15
15
|
import {terrenoStatements} from "./statements";
|
|
16
|
-
import type {
|
|
16
|
+
import type {
|
|
17
|
+
AccessCheckArgs,
|
|
18
|
+
AccessResult,
|
|
19
|
+
AnyTerrenoAccess,
|
|
20
|
+
PermissionRequest,
|
|
21
|
+
Statements,
|
|
22
|
+
} from "./types";
|
|
17
23
|
|
|
18
24
|
const appStatements = {
|
|
19
25
|
...terrenoStatements,
|
|
@@ -41,6 +47,19 @@ const makeEntry = (options: RealtimeRegistryEntry["options"]): RealtimeRegistryE
|
|
|
41
47
|
routePath: "/todos",
|
|
42
48
|
});
|
|
43
49
|
|
|
50
|
+
const makeStubAccess = ({
|
|
51
|
+
allowed,
|
|
52
|
+
onCheck,
|
|
53
|
+
}: {
|
|
54
|
+
allowed: boolean;
|
|
55
|
+
onCheck?: (args: AccessCheckArgs<Statements>) => AccessResult | undefined;
|
|
56
|
+
}): AnyTerrenoAccess =>
|
|
57
|
+
({
|
|
58
|
+
can: async (args: AccessCheckArgs<Statements>): Promise<AccessResult> =>
|
|
59
|
+
onCheck?.(args) ?? {allowed},
|
|
60
|
+
statements: appStatements,
|
|
61
|
+
}) as unknown as AnyTerrenoAccess;
|
|
62
|
+
|
|
44
63
|
describe("realtimeAccess", () => {
|
|
45
64
|
it("uses accessControl permissions for subscriptions", async () => {
|
|
46
65
|
await setupDb();
|
|
@@ -239,4 +258,93 @@ describe("realtimeAccess", () => {
|
|
|
239
258
|
const doc = {title: "Plain"};
|
|
240
259
|
expect(await maskRealtimeDocument(entry, undefined, doc, "read")).toBe(doc);
|
|
241
260
|
});
|
|
261
|
+
|
|
262
|
+
it("falls back to the read action when the resource has no list statement", async () => {
|
|
263
|
+
await setupDb();
|
|
264
|
+
const readOnlyStatements = {
|
|
265
|
+
...terrenoStatements,
|
|
266
|
+
note: ["create", "read", "update", "delete"],
|
|
267
|
+
} as const;
|
|
268
|
+
const access = createAccess({
|
|
269
|
+
connection: mongoose.connection,
|
|
270
|
+
defaultRoles: [
|
|
271
|
+
{
|
|
272
|
+
displayName: "Note Reader",
|
|
273
|
+
name: "note-reader",
|
|
274
|
+
permissions: {note: ["read"]},
|
|
275
|
+
},
|
|
276
|
+
],
|
|
277
|
+
statements: readOnlyStatements,
|
|
278
|
+
});
|
|
279
|
+
await access.roles.seedDefaults();
|
|
280
|
+
|
|
281
|
+
const user = createTestUser({roles: ["note-reader"]});
|
|
282
|
+
const entry = makeEntry({
|
|
283
|
+
access: {resource: "note"},
|
|
284
|
+
accessControl: access as AnyTerrenoAccess,
|
|
285
|
+
});
|
|
286
|
+
|
|
287
|
+
expect(await canSubscribeRealtime(entry, "list", user)).toBe(true);
|
|
288
|
+
});
|
|
289
|
+
|
|
290
|
+
it("returns false for document reads when the read action override is null", async () => {
|
|
291
|
+
const user = createTestUser();
|
|
292
|
+
const entry = makeEntry({
|
|
293
|
+
access: {actions: {read: null}, resource: "todo"},
|
|
294
|
+
accessControl: makeStubAccess({allowed: true}),
|
|
295
|
+
});
|
|
296
|
+
|
|
297
|
+
expect(await canReadDocumentRealtime(entry, user, {title: "Any"})).toBe(false);
|
|
298
|
+
});
|
|
299
|
+
|
|
300
|
+
it("denies scoped document reads for anonymous subscribers", async () => {
|
|
301
|
+
const entry = makeEntry({
|
|
302
|
+
access: {resource: "todo", scope: {check: () => true}},
|
|
303
|
+
accessControl: makeStubAccess({allowed: true}),
|
|
304
|
+
});
|
|
305
|
+
|
|
306
|
+
expect(await canReadDocumentRealtime(entry, undefined, {title: "Any"})).toBe(false);
|
|
307
|
+
});
|
|
308
|
+
|
|
309
|
+
it("re-checks permissions returned by a scope check", async () => {
|
|
310
|
+
const permissionRequests: PermissionRequest<Statements>[] = [];
|
|
311
|
+
const user = createTestUser();
|
|
312
|
+
const entry = makeEntry({
|
|
313
|
+
access: {
|
|
314
|
+
resource: "todo",
|
|
315
|
+
scope: {check: () => ({todo: ["update"]})},
|
|
316
|
+
},
|
|
317
|
+
accessControl: makeStubAccess({
|
|
318
|
+
allowed: true,
|
|
319
|
+
onCheck: (args) => {
|
|
320
|
+
permissionRequests.push(args.permissions);
|
|
321
|
+
return undefined;
|
|
322
|
+
},
|
|
323
|
+
}),
|
|
324
|
+
});
|
|
325
|
+
|
|
326
|
+
expect(await canReadDocumentRealtime(entry, user, {title: "Any"})).toBe(true);
|
|
327
|
+
expect(permissionRequests).toEqual([{todo: ["read"]}, {todo: ["update"]}]);
|
|
328
|
+
});
|
|
329
|
+
|
|
330
|
+
it("denies document reads when scope permissions are not granted", async () => {
|
|
331
|
+
const user = createTestUser();
|
|
332
|
+
const entry = makeEntry({
|
|
333
|
+
access: {
|
|
334
|
+
resource: "todo",
|
|
335
|
+
scope: {check: () => ({todo: ["delete"]})},
|
|
336
|
+
},
|
|
337
|
+
accessControl: makeStubAccess({
|
|
338
|
+
allowed: true,
|
|
339
|
+
onCheck: (args) => {
|
|
340
|
+
if (args.permissions.todo?.includes("delete")) {
|
|
341
|
+
return {allowed: false};
|
|
342
|
+
}
|
|
343
|
+
return undefined;
|
|
344
|
+
},
|
|
345
|
+
}),
|
|
346
|
+
});
|
|
347
|
+
|
|
348
|
+
expect(await canReadDocumentRealtime(entry, user, {title: "Any"})).toBe(false);
|
|
349
|
+
});
|
|
242
350
|
});
|