Files
simstudioai--sim/apps/sim/tools/file/get.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

175 lines
4.6 KiB
TypeScript

import type { ToolConfig, ToolResponse, WorkflowToolExecutionContext } from '@/tools/types'
interface FileGetParams {
fileId?: string
fileInput?: unknown
workspaceId?: string
_context?: WorkflowToolExecutionContext
}
interface FileReadParams {
fileId?: string | string[]
fileInput?: unknown
workspaceId?: string
_context?: WorkflowToolExecutionContext
}
const createFileReadTool = (config: {
id: 'file_read'
name: string
description: string
}): ToolConfig<FileReadParams, ToolResponse> => ({
id: config.id,
name: config.name,
description: config.description,
version: '1.0.0',
params: {
fileId: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Canonical workspace file ID, or an array of canonical workspace file IDs.',
},
fileInput: {
type: 'file',
required: false,
visibility: 'user-only',
description: 'Selected workspace file object.',
},
},
request: {
url: '/api/tools/file/manage',
method: 'POST',
headers: () => ({ 'Content-Type': 'application/json' }),
body: (params) => ({
operation: 'read',
fileId: params.fileId,
fileInput: params.fileInput,
workspaceId: params.workspaceId || params._context?.workspaceId,
}),
},
transformResponse: async (response) => {
const data = await response.json()
if (!response.ok || !data.success) {
return { success: false, output: {}, error: data.error || 'Failed to get file' }
}
return { success: true, output: data.data }
},
outputs: {
files: { type: 'file[]', description: 'Workspace file objects' },
},
})
export const fileGetTool: ToolConfig<FileGetParams, ToolResponse> = {
id: 'file_get',
name: 'File Get',
description: 'Get a workspace file object from a selected file or canonical workspace file ID.',
version: '1.0.0',
params: {
fileId: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Canonical workspace file ID.',
},
fileInput: {
type: 'file',
required: false,
visibility: 'user-only',
description: 'Selected workspace file object.',
},
},
request: {
url: '/api/tools/file/manage',
method: 'POST',
headers: () => ({ 'Content-Type': 'application/json' }),
body: (params) => ({
operation: 'get',
fileId: params.fileId,
fileInput: params.fileInput,
workspaceId: params.workspaceId || params._context?.workspaceId,
}),
},
transformResponse: async (response) => {
const data = await response.json()
if (!response.ok || !data.success) {
return { success: false, output: {}, error: data.error || 'Failed to get file' }
}
return { success: true, output: data.data }
},
outputs: {
file: { type: 'file', description: 'Workspace file object' },
},
}
export const fileReadTool = createFileReadTool({
id: 'file_read',
name: 'File Read',
description: 'Read workspace file objects from selected files or canonical workspace file IDs.',
})
interface FileGetContentParams {
fileId?: string | string[]
fileInput?: unknown
workspaceId?: string
_context?: WorkflowToolExecutionContext
}
export const fileGetContentTool: ToolConfig<FileGetContentParams, ToolResponse> = {
id: 'file_get_content',
name: 'File Get Content',
description:
'Extract the text content of one or more workspace files from selected file objects or canonical workspace file IDs.',
version: '1.0.0',
params: {
fileId: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Canonical workspace file ID, or an array of canonical workspace file IDs.',
},
fileInput: {
type: 'file',
required: false,
visibility: 'user-only',
description: 'Selected workspace file object, or an array of file objects.',
},
},
request: {
url: '/api/tools/file/manage',
method: 'POST',
headers: () => ({ 'Content-Type': 'application/json' }),
body: (params) => ({
operation: 'content',
fileId: params.fileId,
fileInput: params.fileInput,
workspaceId: params.workspaceId || params._context?.workspaceId,
}),
},
transformResponse: async (response) => {
const data = await response.json()
if (!response.ok || !data.success) {
return { success: false, output: {}, error: data.error || 'Failed to read file content' }
}
return { success: true, output: data.data }
},
outputs: {
contents: {
type: 'array',
description: 'Array of file text contents, one entry per file in input order',
},
},
}