The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Name the AI run scope AiRunPermissionScope (#29534)
Charles Bochetc701c54e672c
diff --git a/packages/twenty-server/src/engine/core-modules/auth/types/workspace-auth-context.type.ts b/packages/twenty-server/src/engine/core-modules/auth/types/workspace-auth-context.type.tsindex 4e16a3c2062..c3e75d3a02b 100644--- a/packages/twenty-server/src/engine/core-modules/auth/types/workspace-auth-context.type.ts+++ b/packages/twenty-server/src/engine/core-modules/auth/types/workspace-auth-context.type.ts@@ -1,6 +1,6 @@import { type ActingAgent } from 'src/engine/core-modules/auth/types/acting-agent.type';import { type RawAuthContext } from 'src/engine/core-modules/auth/types/raw-auth-context.type';-import { type PermissionScope } from 'src/engine/permissions/principal/types/permission-scope.type';+import { type AiRunPermissionScope } from 'src/engine/permissions/principal/types/ai-run-permission-scope.type';import { type UserSessionVariant } from 'src/engine/core-modules/auth/types/user-session-variant.type';export type WorkspaceAuthContextType =@@ -21,7 +21,7 @@ export interface ApiKeyWorkspaceAuthContext extends BaseWorkspaceAuthContext {// Set when the key runs an agent: the agent and its application narrow the key's rolesapplication?: NonNullable<RawAuthContext['application']>;agentId?: string;- permissionScope?: PermissionScope;+ aiRunScope?: AiRunPermissionScope;}export interface UserWorkspaceAuthContext extends BaseWorkspaceAuthContext {@@ -35,7 +35,7 @@ export interface UserWorkspaceAuthContext extends BaseWorkspaceAuthContext {application?: NonNullable<RawAuthContext['application']>;agentId?: string;// Set when an AI run narrows the caller to an inline scope- permissionScope?: PermissionScope;+ aiRunScope?: AiRunPermissionScope;}export interface ApplicationWorkspaceAuthContext extends BaseWorkspaceAuthContext {@@ -45,7 +45,7 @@ export interface ApplicationWorkspaceAuthContext extends BaseWorkspaceAuthContexactingAgent?: ActingAgent;// The agent named in the token only narrows its roles; unlike actingAgent, writes are not attributed to itagentId?: string;- permissionScope?: PermissionScope;+ aiRunScope?: AiRunPermissionScope;}export interface SystemWorkspaceAuthContext extends BaseWorkspaceAuthContext {diff --git a/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent-execution/services/agent-run-persona.service.ts b/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent-execution/services/agent-run-persona.service.tsindex 29083c33312..da39b109696 100644--- a/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent-execution/services/agent-run-persona.service.ts+++ b/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent-execution/services/agent-run-persona.service.ts@@ -121,7 +121,7 @@ export class AgentRunPersonaService {return buildAgentRunAuthContext({authContext,agentId: agentId ?? undefined,- permissionScope: resolveAiRunPermissionScope({+ aiRunScope: resolveAiRunPermissionScope({scope,flatObjectMetadataMaps,flatFieldMetadataMaps,diff --git a/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent-execution/utils/build-agent-run-auth-context.util.ts b/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent-execution/utils/build-agent-run-auth-context.util.tsindex cb815d43004..38f8faa195b 100644--- a/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent-execution/utils/build-agent-run-auth-context.util.ts+++ b/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent-execution/utils/build-agent-run-auth-context.util.ts@@ -6,23 +6,23 @@ import {AiExceptionCode,} from 'src/engine/metadata-modules/ai/ai.exception';import { type WorkspaceAuthContext } from 'src/engine/core-modules/auth/types/workspace-auth-context.type';-import { type PermissionScope } from 'src/engine/permissions/principal/types/permission-scope.type';+import { type AiRunPermissionScope } from 'src/engine/permissions/principal/types/ai-run-permission-scope.type';// A run never exceeds its agent, its scope nor the agent's application, whoever calls itexport const buildAgentRunAuthContext = ({authContext,agentId,application,- permissionScope,+ aiRunScope,}: {authContext: WorkspaceAuthContext;agentId?: string;application?: FlatApplication;- permissionScope?: PermissionScope;+ aiRunScope?: AiRunPermissionScope;}): WorkspaceAuthContext => {const narrowing = {...(isDefined(agentId) ? { agentId } : {}),- ...(isDefined(permissionScope) ? { permissionScope } : {}),+ ...(isDefined(aiRunScope) ? { aiRunScope } : {}),};switch (authContext.type) {diff --git a/packages/twenty-server/src/engine/permissions/combine/utils/__tests__/resolve-permissions-row-access-outcome.util.spec.ts b/packages/twenty-server/src/engine/permissions/combine/utils/__tests__/resolve-permissions-row-access-outcome.util.spec.tsindex a746d19a3f7..09cca6fda34 100644--- a/packages/twenty-server/src/engine/permissions/combine/utils/__tests__/resolve-permissions-row-access-outcome.util.spec.ts+++ b/packages/twenty-server/src/engine/permissions/combine/utils/__tests__/resolve-permissions-row-access-outcome.util.spec.ts@@ -161,7 +161,7 @@ describe('resolvePermissionsRowAccessOutcome', () => {canReadObjectRecords: boolean;}): PermissionsPrincipalsWithRolesContext => ({...readOnlyPrincipal,- scope: {+ aiRunScope: {objectsPermissions: {[flatObjectMetadata.id]: {...readOnlyPermissions,diff --git a/packages/twenty-server/src/engine/permissions/permissions.service.ts b/packages/twenty-server/src/engine/permissions/permissions.service.tsindex b02adf4ac63..75bc3d4f4b3 100644--- a/packages/twenty-server/src/engine/permissions/permissions.service.ts+++ b/packages/twenty-server/src/engine/permissions/permissions.service.ts@@ -188,10 +188,11 @@ export class PermissionsService {'flatRolePermissionFlagMaps',]);- const { scope } = principal;+ const { aiRunScope } = principal;return (- (!isDefined(scope) || (scope.permissionFlags[setting] ?? false)) &&+ (!isDefined(aiRunScope) ||+ (aiRunScope.permissionFlags[setting] ?? false)) &&this.isPermissionFlagGrantedToRoles({roleIds: getPermissionsPrincipalRoleIds(principal),setting,diff --git a/packages/twenty-server/src/engine/permissions/principal/types/permission-scope.type.ts b/packages/twenty-server/src/engine/permissions/principal/types/ai-run-permission-scope.type.tssimilarity index 54%rename from packages/twenty-server/src/engine/permissions/principal/types/permission-scope.type.tsrename to packages/twenty-server/src/engine/permissions/principal/types/ai-run-permission-scope.type.tsindex 21b2ab6dd3f..6318b37967e 100644--- a/packages/twenty-server/src/engine/permissions/principal/types/permission-scope.type.ts+++ b/packages/twenty-server/src/engine/permissions/principal/types/ai-run-permission-scope.type.ts@@ -2,8 +2,9 @@ import { type PermissionFlagType } from 'twenty-shared/constants';import { type UserWorkspacePermissions } from 'src/engine/permissions/types/user-workspace-permissions.type';-// A restriction written inline on an AI run rather than stored as a role, resolved like a member's permissions-export type PermissionScope = Pick<+// TODO(@charlesBochet): deprecate AI run scopes, they limit a run without being a role or a principal+// A limit written inline on an AI run rather than stored as a role, resolved like a member's permissions+export type AiRunPermissionScope = Pick<UserWorkspacePermissions,'objectsPermissions'> & {diff --git a/packages/twenty-server/src/engine/permissions/principal/types/permissions-auth-context.type.ts b/packages/twenty-server/src/engine/permissions/principal/types/permissions-auth-context.type.tsindex 6e654e3fd99..0de80589bb5 100644--- a/packages/twenty-server/src/engine/permissions/principal/types/permissions-auth-context.type.ts+++ b/packages/twenty-server/src/engine/permissions/principal/types/permissions-auth-context.type.ts@@ -18,7 +18,7 @@ type PermissionsApplication = Pick<type PermissionsUserAuthContext = Pick<UserWorkspaceAuthContext,- 'type' | 'workspaceMemberId' | 'agentId' | 'permissionScope'+ 'type' | 'workspaceMemberId' | 'agentId' | 'aiRunScope'> & {workspace: PermissionsWorkspace;application?: PermissionsApplication;@@ -26,7 +26,7 @@ type PermissionsUserAuthContext = Pick<type PermissionsApiKeyAuthContext = Pick<ApiKeyWorkspaceAuthContext,- 'type' | 'agentId' | 'permissionScope'+ 'type' | 'agentId' | 'aiRunScope'> & {workspace: PermissionsWorkspace;apiKey: Pick<ApiKeyWorkspaceAuthContext['apiKey'], 'id'>;@@ -35,7 +35,7 @@ type PermissionsApiKeyAuthContext = Pick<type PermissionsApplicationAuthContext = Pick<ApplicationWorkspaceAuthContext,- 'type' | 'agentId' | 'permissionScope'+ 'type' | 'agentId' | 'aiRunScope'> & {workspace: PermissionsWorkspace;application: PermissionsApplication;diff --git a/packages/twenty-server/src/engine/permissions/principal/types/permissions-principals-with-roles-context.type.ts b/packages/twenty-server/src/engine/permissions/principal/types/permissions-principals-with-roles-context.type.tsindex f67ced935e4..1906ba7eb8d 100644--- a/packages/twenty-server/src/engine/permissions/principal/types/permissions-principals-with-roles-context.type.ts+++ b/packages/twenty-server/src/engine/permissions/principal/types/permissions-principals-with-roles-context.type.ts@@ -1,6 +1,6 @@/* @license Enterprise */-import { type PermissionScope } from 'src/engine/permissions/principal/types/permission-scope.type';+import { type AiRunPermissionScope } from 'src/engine/permissions/principal/types/ai-run-permission-scope.type';import {type PermissionsAgentPrincipal,type PermissionsApiKeyPrincipal,@@ -36,5 +36,5 @@ export type PermissionsPrincipalsWithRolesContext = {limitingPrincipal?: PermissionsLimitingPrincipalWithRole;applicationPrincipal: PermissionsApplicationPrincipalWithRole;// narrows what the roles allow, and leaves no reach beyond them- scope?: PermissionScope;+ aiRunScope?: AiRunPermissionScope;};diff --git a/packages/twenty-server/src/engine/permissions/principal/utils/resolve-permissions-principals-with-roles.util.ts b/packages/twenty-server/src/engine/permissions/principal/utils/resolve-permissions-principals-with-roles.util.tsindex 4a87b74d955..14d74a2fec4 100644--- a/packages/twenty-server/src/engine/permissions/principal/utils/resolve-permissions-principals-with-roles.util.ts+++ b/packages/twenty-server/src/engine/permissions/principal/utils/resolve-permissions-principals-with-roles.util.ts@@ -9,7 +9,7 @@ import {type PermissionsLimitingPrincipal,type PermissionsMainPrincipal,} from 'src/engine/permissions/principal/types/permissions-principal.type';-import { type PermissionScope } from 'src/engine/permissions/principal/types/permission-scope.type';+import { type AiRunPermissionScope } from 'src/engine/permissions/principal/types/ai-run-permission-scope.type';import {type PermissionsApplicationPrincipalWithRole,type PermissionsLimitingPrincipalWithRole,@@ -168,7 +168,7 @@ type PermissionsIdentities = {mainPrincipal: PermissionsMainPrincipal;limitingPrincipal?: PermissionsLimitingPrincipal;applicationPrincipal: PermissionsApplicationPrincipal;- scope?: PermissionScope;+ aiRunScope?: AiRunPermissionScope;};const toApplicationPrincipal = (@@ -197,7 +197,7 @@ const getPermissionsIdentitiesFromAuthContext = (applicationPrincipal: toApplicationPrincipal(authContext.application?.id,),- scope: authContext.permissionScope,+ aiRunScope: authContext.aiRunScope,};case 'apiKey':return {@@ -206,7 +206,7 @@ const getPermissionsIdentitiesFromAuthContext = (applicationPrincipal: toApplicationPrincipal(authContext.application?.id,),- scope: authContext.permissionScope,+ aiRunScope: authContext.aiRunScope,};case 'application':return {@@ -216,7 +216,7 @@ const getPermissionsIdentitiesFromAuthContext = (applicationPrincipal: toApplicationPrincipal(authContext.application.id,),- scope: authContext.permissionScope,+ aiRunScope: authContext.aiRunScope,};case 'webhook':return {@@ -281,6 +281,8 @@ export const resolvePermissionsPrincipalsWithRoles = ({mainPrincipal,limitingPrincipal: limitingPrincipalWithRole,applicationPrincipal,- ...(isDefined(identities.scope) ? { scope: identities.scope } : {}),+ ...(isDefined(identities.aiRunScope)+ ? { aiRunScope: identities.aiRunScope }+ : {}),};};diff --git a/packages/twenty-server/src/engine/permissions/record-share/utils/is-operation-granted-beyond-role-to-principal.util.ts b/packages/twenty-server/src/engine/permissions/record-share/utils/is-operation-granted-beyond-role-to-principal.util.tsindex 130b5b22c89..ebbcb7016d0 100644--- a/packages/twenty-server/src/engine/permissions/record-share/utils/is-operation-granted-beyond-role-to-principal.util.ts+++ b/packages/twenty-server/src/engine/permissions/record-share/utils/is-operation-granted-beyond-role-to-principal.util.ts@@ -15,7 +15,7 @@ export const isOperationGrantedBeyondRoleToPrincipal = ({PermissionsObjectAccessRequest,'principal' | 'flatObjectMetadata' | 'metadataMaps' | 'operationType'>): boolean =>- !isDefined(principal.scope) &&+ !isDefined(principal.aiRunScope) &&isOperationGrantedBeyondRole({flatObjectMetadata,featureFlagsMap: metadataMaps.featureFlagsMap,diff --git a/packages/twenty-server/src/engine/permissions/role/utils/__tests__/compute-objects-permissions-for-roles.util.spec.ts b/packages/twenty-server/src/engine/permissions/role/utils/__tests__/compute-objects-permissions-for-roles.util.spec.tsindex 423b2720d99..52adc4a4d84 100644--- a/packages/twenty-server/src/engine/permissions/role/utils/__tests__/compute-objects-permissions-for-roles.util.spec.ts+++ b/packages/twenty-server/src/engine/permissions/role/utils/__tests__/compute-objects-permissions-for-roles.util.spec.ts@@ -18,7 +18,7 @@ import { type OrmFlatFieldMetadata } from 'src/engine/metadata-modules/flat-fielimport { getFlatObjectMetadataMock } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/get-flat-object-metadata.mock';import { type FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';import { type PermissionsAuthContext } from 'src/engine/permissions/principal/types/permissions-auth-context.type';-import { type PermissionScope } from 'src/engine/permissions/principal/types/permission-scope.type';+import { type AiRunPermissionScope } from 'src/engine/permissions/principal/types/ai-run-permission-scope.type';import { type PermissionsPrincipalsWithRolesContext } from 'src/engine/permissions/principal/types/permissions-principals-with-roles-context.type';import { buildPermissionsPrincipalRoleMaps } from 'src/engine/permissions/principal/utils/build-permissions-principal-role-maps.util';import {@@ -108,17 +108,17 @@ const buildMemberAuthContext = ({const buildApiKeyAuthContext = ({apiKeyId,agentId,- permissionScope,+ aiRunScope,}: {apiKeyId: string;agentId?: string;- permissionScope?: PermissionScope;+ aiRunScope?: AiRunPermissionScope;}): PermissionsAuthContext => ({type: 'apiKey',workspace: { id: 'workspace-id' },apiKey: { id: apiKeyId },...(isDefined(agentId) ? { agentId } : {}),- ...(isDefined(permissionScope) ? { permissionScope } : {}),+ ...(isDefined(aiRunScope) ? { aiRunScope } : {}),});const computeForAuthContext = ({@@ -718,7 +718,7 @@ describe('computeObjectsPermissionsForRoles with a scope', () => {const principal = resolvePermissionsPrincipalsWithRoles({authContext: buildApiKeyAuthContext({apiKeyId,- permissionScope: hasScope+ aiRunScope: hasScope? {objectsPermissions: isDefined(scopeObjectPermissions)? { [INVOICE_ID]: scopeObjectPermissions }diff --git a/packages/twenty-server/src/engine/permissions/role/utils/__tests__/resolve-ai-run-permission-scope.util.spec.ts b/packages/twenty-server/src/engine/permissions/role/utils/__tests__/resolve-ai-run-permission-scope.util.spec.tsindex 45c77f680d5..1a06cc4270a 100644--- a/packages/twenty-server/src/engine/permissions/role/utils/__tests__/resolve-ai-run-permission-scope.util.spec.ts+++ b/packages/twenty-server/src/engine/permissions/role/utils/__tests__/resolve-ai-run-permission-scope.util.spec.ts@@ -272,7 +272,7 @@ describe('resolveAiRunPermissionScope', () => {it('refuses an insert by a member who can write it, under a scope that grants nothing', () => {const isInsertDenied = (- scope?: PermissionsPrincipalsWithRolesContext['scope'],+ aiRunScope?: PermissionsPrincipalsWithRolesContext['aiRunScope'],) =>isObjectOperationDeniedToPrincipal({principal: {@@ -283,7 +283,7 @@ describe('resolveAiRunPermissionScope', () => {workspaceMemberId: 'workspace-member-id',},applicationPrincipal: { type: 'customApplication' },- ...(isDefined(scope) ? { scope } : {}),+ ...(isDefined(aiRunScope) ? { aiRunScope } : {}),},metadataMaps: {flatObjectMetadataMaps,diff --git a/packages/twenty-server/src/engine/permissions/role/utils/compute-objects-permissions-for-roles.util.ts b/packages/twenty-server/src/engine/permissions/role/utils/compute-objects-permissions-for-roles.util.tsindex 508602d757f..ba9797d4469 100644--- a/packages/twenty-server/src/engine/permissions/role/utils/compute-objects-permissions-for-roles.util.ts+++ b/packages/twenty-server/src/engine/permissions/role/utils/compute-objects-permissions-for-roles.util.ts@@ -26,7 +26,10 @@ export const computeObjectsPermissionsForRoles = ({}: {principal: Pick<PermissionsPrincipalsWithRolesContext,- 'mainPrincipal' | 'limitingPrincipal' | 'applicationPrincipal' | 'scope'+ | 'mainPrincipal'+ | 'limitingPrincipal'+ | 'applicationPrincipal'+ | 'aiRunScope'>;rolesPermissions: ObjectsPermissionsByRoleId;flatObjectMetadataMaps: FlatEntityMaps<FlatObjectMetadata>;@@ -70,10 +73,10 @@ export const computeObjectsPermissionsForRoles = ({const objectsPermissions = computePermissionIntersection(permissionsPerRole);- return isDefined(principal.scope)+ return isDefined(principal.aiRunScope)? restrictObjectsPermissionsToScope({objectsPermissions,- scope: principal.scope,+ aiRunScope: principal.aiRunScope,}): objectsPermissions;};diff --git a/packages/twenty-server/src/engine/permissions/role/utils/resolve-ai-run-permission-scope.util.ts b/packages/twenty-server/src/engine/permissions/role/utils/resolve-ai-run-permission-scope.util.tsindex 2a2a4c39e63..8f30de59367 100644--- a/packages/twenty-server/src/engine/permissions/role/utils/resolve-ai-run-permission-scope.util.ts+++ b/packages/twenty-server/src/engine/permissions/role/utils/resolve-ai-run-permission-scope.util.ts@@ -21,7 +21,7 @@ import {PermissionsException,PermissionsExceptionCode,} from 'src/engine/permissions/permissions.exception';-import { type PermissionScope } from 'src/engine/permissions/principal/types/permission-scope.type';+import { type AiRunPermissionScope } from 'src/engine/permissions/principal/types/ai-run-permission-scope.type';// a flag decides objects such as workflows regardless of their object permission, so a scope's explicit deny is applied afterconst narrowObjectsPermissionsToExplicitDenies = ({@@ -76,7 +76,7 @@ export const resolveAiRunPermissionScope = ({FlatEntityMaps<FlatFieldMetadata>,'byUniversalIdentifier'>;-}): PermissionScope => {+}): AiRunPermissionScope => {if (hasAiRunScopeRepeatedEntries(scope)) {throw new PermissionsException('An AI run scope lists an object or field more than once',diff --git a/packages/twenty-server/src/engine/permissions/role/utils/restrict-objects-permissions-to-scope.util.ts b/packages/twenty-server/src/engine/permissions/role/utils/restrict-objects-permissions-to-scope.util.tsindex 6b23e6b43fe..25c351e0319 100644--- a/packages/twenty-server/src/engine/permissions/role/utils/restrict-objects-permissions-to-scope.util.ts+++ b/packages/twenty-server/src/engine/permissions/role/utils/restrict-objects-permissions-to-scope.util.ts@@ -1,26 +1,27 @@import { type ObjectsPermissions } from 'twenty-shared/types';-import { type PermissionScope } from 'src/engine/permissions/principal/types/permission-scope.type';+import { type AiRunPermissionScope } from 'src/engine/permissions/principal/types/ai-run-permission-scope.type';import { computePermissionIntersection } from 'src/engine/permissions/role/utils/compute-permission-intersection.util';// the roles' predicates keep their insert-guard field exemption, except on fields the scope denies writingexport const restrictObjectsPermissionsToScope = ({objectsPermissions,- scope,+ aiRunScope,}: {objectsPermissions: ObjectsPermissions;- scope: Pick<PermissionScope, 'objectsPermissions'>;+ aiRunScope: Pick<AiRunPermissionScope, 'objectsPermissions'>;}): ObjectsPermissions => {const intersectedObjectsPermissions = computePermissionIntersection([objectsPermissions,- scope.objectsPermissions,+ aiRunScope.objectsPermissions,]);return Object.fromEntries(Object.entries(objectsPermissions).map(([objectMetadataId, objectPermissions]) => {const scopeRestrictedFields =- scope.objectsPermissions[objectMetadataId]?.restrictedFields ?? {};+ aiRunScope.objectsPermissions[objectMetadataId]?.restrictedFields ??+ {};return [objectMetadataId,