Files
simstudioai--sim/apps/sim/tools/microsoft_planner/read_task.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

173 lines
5.4 KiB
TypeScript

import { createLogger } from '@sim/logger'
import { ErrorExtractorId } from '@/tools/error-extractors'
import type {
MicrosoftPlannerReadResponse,
MicrosoftPlannerToolParams,
} from '@/tools/microsoft_planner/types'
import type { ToolConfig } from '@/tools/types'
const logger = createLogger('MicrosoftPlannerReadTask')
export const readTaskTool: ToolConfig<MicrosoftPlannerToolParams, MicrosoftPlannerReadResponse> = {
id: 'microsoft_planner_read_task',
name: 'Read Microsoft Planner Tasks',
description:
'Read tasks from Microsoft Planner - get all user tasks or all tasks from a specific plan',
version: '1.0',
errorExtractor: ErrorExtractorId.MICROSOFT_GRAPH_ERRORS,
oauth: {
required: true,
provider: 'microsoft-planner',
},
params: {
accessToken: {
type: 'string',
required: true,
visibility: 'hidden',
description: 'The access token for the Microsoft Planner API',
},
planId: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description:
'The ID of the plan to get tasks from, if not provided gets all user tasks (e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J")',
},
taskId: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'The ID of the task to get (e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m")',
},
},
request: {
url: (params) => {
let finalUrl: string
// If taskId is provided, get specific task
if (params.taskId) {
// Validate and clean task ID
const cleanTaskId = params.taskId.trim()
if (!cleanTaskId) {
throw new Error('Task ID cannot be empty')
}
// Log the task ID for debugging
logger.info('Fetching task with ID:', cleanTaskId)
logger.info('Task ID length:', cleanTaskId.length)
logger.info('Task ID has special chars:', /[^a-zA-Z0-9_-]/.test(cleanTaskId))
finalUrl = `https://graph.microsoft.com/v1.0/planner/tasks/${cleanTaskId}`
}
// Else if planId is provided, get tasks from plan
else if (params.planId) {
const cleanPlanId = params.planId.trim()
if (!cleanPlanId) {
throw new Error('Plan ID cannot be empty')
}
logger.info('Fetching tasks for plan:', cleanPlanId)
finalUrl = `https://graph.microsoft.com/v1.0/planner/plans/${cleanPlanId}/tasks`
}
// Else get all user tasks
else {
logger.info('Fetching all user tasks')
finalUrl = 'https://graph.microsoft.com/v1.0/me/planner/tasks'
}
logger.info('Microsoft Planner URL:', finalUrl)
return finalUrl
},
method: 'GET',
headers: (params) => {
if (!params.accessToken) {
throw new Error('Access token is required')
}
logger.info('Access token present:', !!params.accessToken)
logger.info('Access token length:', params.accessToken.length)
return {
Authorization: `Bearer ${params.accessToken}`,
'Content-Type': 'application/json',
}
},
},
transformResponse: async (response: Response) => {
const data = await response.json()
logger.info('Raw response data:', data)
const rawTasks = data.value ? data.value : Array.isArray(data) ? data : [data]
const tasks = rawTasks.map((task: any) => {
let etagValue = task['@odata.etag'] ?? null
logger.info('ETag value extracted (raw):', {
raw: etagValue,
type: typeof etagValue,
length: etagValue?.length,
})
if (etagValue && typeof etagValue === 'string') {
if (etagValue.includes('\\"')) {
etagValue = etagValue.replace(/\\"/g, '"')
logger.info('Unescaped etag quotes:', { cleaned: etagValue })
}
}
return {
id: task.id,
title: task.title,
planId: task.planId,
bucketId: task.bucketId ?? null,
percentComplete: task.percentComplete,
priority: task.priority,
dueDateTime: task.dueDateTime ?? null,
createdDateTime: task.createdDateTime,
completedDateTime: task.completedDateTime ?? null,
hasDescription: task.hasDescription,
assignments: task.assignments ? Object.keys(task.assignments) : [],
etag: etagValue,
}
})
const result: MicrosoftPlannerReadResponse = {
success: true,
output: {
tasks,
metadata: {
planId: tasks.length > 0 ? tasks[0].planId : null,
userId: data.value ? null : 'me',
planUrl:
tasks.length > 0
? `https://graph.microsoft.com/v1.0/planner/plans/${tasks[0].planId}`
: null,
},
},
}
logger.info('Successfully transformed response with', tasks.length, 'tasks')
return result
},
outputs: {
success: { type: 'boolean', description: 'Whether tasks were retrieved successfully' },
tasks: { type: 'array', description: 'Array of task objects with filtered properties' },
metadata: {
type: 'object',
description: 'Metadata including planId, userId, and planUrl',
properties: {
planId: { type: 'string', description: 'Plan ID', optional: true },
userId: { type: 'string', description: 'User ID', optional: true },
planUrl: {
type: 'string',
description: 'Microsoft Graph API URL for the plan',
optional: true,
},
},
},
},
}