simstudioai--sim/apps/sim/tools/microsoft_planner/update_bucket.ts

import { createLogger } from '@sim/logger'
import { ErrorExtractorId } from '@/tools/error-extractors'
import type {
  MicrosoftPlannerToolParams,
  MicrosoftPlannerUpdateBucketResponse,
  PlannerBucket,
} from '@/tools/microsoft_planner/types'
import type { ToolConfig } from '@/tools/types'

const logger = createLogger('MicrosoftPlannerUpdateBucket')

export const updateBucketTool: ToolConfig<
  MicrosoftPlannerToolParams,
  MicrosoftPlannerUpdateBucketResponse
> = {
  id: 'microsoft_planner_update_bucket',
  name: 'Update Microsoft Planner Bucket',
  description: 'Update a bucket in Microsoft Planner',
  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',
    },
    bucketId: {
      type: 'string',
      required: true,
      visibility: 'user-or-llm',
      description: 'The ID of the bucket to update (e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq")',
    },
    name: {
      type: 'string',
      required: false,
      visibility: 'user-only',
      description: 'The new name of the bucket',
    },
    etag: {
      type: 'string',
      required: true,
      visibility: 'user-only',
      description: 'The ETag value from the bucket to update (If-Match header)',
    },
  },

  request: {
    url: (params) => {
      const bucketId = params.bucketId?.trim()
      if (!bucketId) {
        throw new Error('Bucket ID is required')
      }
      return `https://graph.microsoft.com/v1.0/planner/buckets/${bucketId}`
    },
    method: 'PATCH',
    headers: (params) => {
      if (!params.accessToken) {
        throw new Error('Access token is required')
      }
      if (!params.etag) {
        throw new Error('ETag is required for update operations')
      }

      let cleanedEtag = params.etag.trim()

      while (cleanedEtag.startsWith('"') && cleanedEtag.endsWith('"')) {
        cleanedEtag = cleanedEtag.slice(1, -1)
        logger.info('Removed surrounding quotes:', cleanedEtag)
      }

      if (cleanedEtag.includes('\\"')) {
        cleanedEtag = cleanedEtag.replace(/\\"/g, '"')
        logger.info('Cleaned escaped quotes from etag')
      }

      return {
        Authorization: `Bearer ${params.accessToken}`,
        'Content-Type': 'application/json',
        Prefer: 'return=representation',
        'If-Match': cleanedEtag,
      }
    },
    body: (params) => {
      const body: Record<string, any> = {}

      if (params.name) {
        body.name = params.name
      }

      if (Object.keys(body).length === 0) {
        throw new Error('At least one field must be provided to update')
      }

      logger.info('Updating bucket with body:', body)
      return body
    },
  },

  transformResponse: async (response: Response, params?: MicrosoftPlannerToolParams) => {
    // Prefer: return=representation requests a body, but the service may still return
    // 204 No Content for some tenants/requests
    const text = await response.text()
    if (!text || text.trim() === '') {
      logger.info('Update successful but no response body returned (204 No Content)')
      return {
        success: true,
        output: {
          bucket: {} as PlannerBucket,
          metadata: {
            bucketId: params?.bucketId?.trim(),
          },
        },
      }
    }

    const bucket = JSON.parse(text)
    logger.info('Updated bucket:', bucket)

    const result: MicrosoftPlannerUpdateBucketResponse = {
      success: true,
      output: {
        bucket,
        metadata: {
          bucketId: bucket.id,
          planId: bucket.planId,
        },
      },
    }

    return result
  },

  outputs: {
    success: { type: 'boolean', description: 'Whether the bucket was updated successfully' },
    bucket: { type: 'object', description: 'The updated bucket object with all properties' },
    metadata: {
      type: 'object',
      description: 'Metadata including bucketId and planId',
      properties: {
        bucketId: { type: 'string', description: 'Updated bucket ID' },
        planId: { type: 'string', description: 'Parent plan ID' },
      },
    },
  },
}