Files
simstudioai--sim/apps/sim/tools/google_drive/list_permissions.ts
T
wehub-resource-sync d25d482dc2
Publish CLI Package / publish-npm (push) Waiting to run
Publish Python SDK / publish-pypi (push) Waiting to run
Publish TypeScript SDK / publish-npm (push) Waiting to run
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

141 lines
4.3 KiB
TypeScript

import type { GoogleDrivePermission, GoogleDriveToolParams } from '@/tools/google_drive/types'
import type { ToolConfig, ToolResponse } from '@/tools/types'
interface GoogleDriveListPermissionsParams extends GoogleDriveToolParams {
fileId: string
pageToken?: string
}
interface GoogleDriveListPermissionsResponse extends ToolResponse {
output: {
permissions: GoogleDrivePermission[]
nextPageToken?: string
}
}
export const listPermissionsTool: ToolConfig<
GoogleDriveListPermissionsParams,
GoogleDriveListPermissionsResponse
> = {
id: 'google_drive_list_permissions',
name: 'List Google Drive Permissions',
description: 'List all permissions (who has access) for a file in Google Drive',
version: '1.0.0',
oauth: {
required: true,
provider: 'google-drive',
},
params: {
accessToken: {
type: 'string',
required: true,
visibility: 'hidden',
description: 'OAuth access token',
},
fileId: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'The ID of the file to list permissions for',
},
pageToken: {
type: 'string',
required: false,
visibility: 'hidden',
description: 'The page token to use for pagination',
},
},
request: {
url: (params) => {
const url = new URL(
`https://www.googleapis.com/drive/v3/files/${params.fileId?.trim()}/permissions`
)
url.searchParams.append('supportsAllDrives', 'true')
url.searchParams.append(
'fields',
'nextPageToken,permissions(id,type,role,emailAddress,displayName,photoLink,domain,expirationTime,deleted,allowFileDiscovery,pendingOwner,permissionDetails)'
)
if (params.pageToken) {
url.searchParams.append('pageToken', params.pageToken)
}
return url.toString()
},
method: 'GET',
headers: (params) => ({
Authorization: `Bearer ${params.accessToken}`,
}),
},
transformResponse: async (response: Response) => {
const data = await response.json()
if (!response.ok) {
throw new Error(data.error?.message || 'Failed to list Google Drive permissions')
}
const permissions = (data.permissions ?? []).map((p: Record<string, unknown>) => ({
id: p.id ?? null,
type: p.type ?? null,
role: p.role ?? null,
emailAddress: p.emailAddress ?? null,
displayName: p.displayName ?? null,
photoLink: p.photoLink ?? null,
domain: p.domain ?? null,
expirationTime: p.expirationTime ?? null,
deleted: p.deleted ?? false,
allowFileDiscovery: p.allowFileDiscovery ?? null,
pendingOwner: p.pendingOwner ?? false,
permissionDetails: p.permissionDetails ?? null,
}))
return {
success: true,
output: {
permissions,
nextPageToken: data.nextPageToken,
},
}
},
outputs: {
permissions: {
type: 'array',
description: 'List of permissions on the file',
items: {
type: 'object',
properties: {
id: { type: 'string', description: 'Permission ID (use to remove permission)' },
type: { type: 'string', description: 'Grantee type (user, group, domain, anyone)' },
role: {
type: 'string',
description:
'Permission role (owner, organizer, fileOrganizer, writer, commenter, reader)',
},
emailAddress: { type: 'string', description: 'Email of the grantee' },
displayName: { type: 'string', description: 'Display name of the grantee' },
photoLink: { type: 'string', description: 'Photo URL of the grantee' },
domain: { type: 'string', description: 'Domain of the grantee' },
expirationTime: { type: 'string', description: 'When permission expires' },
deleted: { type: 'boolean', description: 'Whether grantee account is deleted' },
allowFileDiscovery: {
type: 'boolean',
description: 'Whether file is discoverable by grantee',
},
pendingOwner: { type: 'boolean', description: 'Whether ownership transfer is pending' },
permissionDetails: {
type: 'json',
description: 'Details about inherited permissions',
},
},
},
},
nextPageToken: {
type: 'string',
description: 'Token for fetching the next page of permissions',
},
},
}