simstudioai--sim/apps/sim/tools/google_vault/update_matters_holds.ts

import type { GoogleVaultUpdateMattersHoldsParams } from '@/tools/google_vault/types'
import { enhanceGoogleVaultError } from '@/tools/google_vault/utils'
import type { ToolConfig } from '@/tools/types'

export const updateMattersHoldsTool: ToolConfig<GoogleVaultUpdateMattersHoldsParams> = {
  id: 'google_vault_update_matters_holds',
  name: 'Vault Update Hold',
  description:
    'Replace the name, query, and scope of an existing hold. This is a full-resource update: fetch the current hold first (Vault List Holds) and resupply every field you want to keep — any field left blank is cleared, not left unchanged.',
  version: '1.0.0',

  oauth: {
    required: true,
    provider: 'google-vault',
  },

  params: {
    accessToken: {
      type: 'string',
      required: true,
      visibility: 'hidden',
      description: 'OAuth access token',
    },
    matterId: {
      type: 'string',
      required: true,
      visibility: 'user-or-llm',
      description: 'The matter ID (e.g., "12345678901234567890")',
    },
    holdId: {
      type: 'string',
      required: true,
      visibility: 'user-or-llm',
      description: 'The hold ID to update (e.g., "holdId123456")',
    },
    holdName: {
      type: 'string',
      required: true,
      visibility: 'user-only',
      description: 'Name for the hold',
    },
    corpus: {
      type: 'string',
      required: true,
      visibility: 'user-only',
      description: 'Data corpus of the hold (MAIL, DRIVE, GROUPS, HANGOUTS_CHAT, VOICE)',
    },
    accountEmails: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description:
        'Comma-separated list of user emails covered by the hold (e.g., "user1@example.com, user2@example.com")',
    },
    orgUnitId: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description:
        'Organization unit ID covered by the hold (e.g., "id:03ph8a2z1enx5q0", alternative to accounts)',
    },
    terms: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description:
        'Search terms to filter held content (e.g., "from:sender@example.com subject:invoice", for MAIL and GROUPS corpus). Resupply the hold\'s current terms to keep them — this replaces the hold, so leaving it blank clears any existing filter.',
    },
    startTime: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description:
        'Start time for date filtering (ISO 8601 format, e.g., "2024-01-01T00:00:00Z", for MAIL and GROUPS corpus). Resupply the hold\'s current value to keep it — leaving it blank clears any existing date filter.',
    },
    endTime: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description:
        'End time for date filtering (ISO 8601 format, e.g., "2024-12-31T23:59:59Z", for MAIL and GROUPS corpus). Resupply the hold\'s current value to keep it — leaving it blank clears any existing date filter.',
    },
    includeSharedDrives: {
      type: 'boolean',
      required: false,
      visibility: 'user-only',
      description:
        'Include files in shared drives (for DRIVE corpus). Resupply true if the hold currently includes shared drives — leaving it false/blank clears that setting.',
    },
  },

  request: {
    url: (params) =>
      `https://vault.googleapis.com/v1/matters/${params.matterId.trim()}/holds/${params.holdId.trim()}`,
    method: 'PUT',
    headers: (params) => ({
      Authorization: `Bearer ${params.accessToken}`,
      'Content-Type': 'application/json',
    }),
    body: (params) => {
      const body: any = {
        name: params.holdName,
        corpus: params.corpus,
      }

      let emails: string[] = []
      if (params.accountEmails) {
        if (Array.isArray(params.accountEmails)) {
          emails = params.accountEmails
        } else if (typeof params.accountEmails === 'string') {
          emails = params.accountEmails
            .split(',')
            .map((e) => e.trim())
            .filter(Boolean)
        }
      }

      if (emails.length > 0) {
        body.accounts = emails.map((email: string) => ({ email }))
      } else if (params.orgUnitId) {
        body.orgUnit = { orgUnitId: params.orgUnitId }
      } else {
        throw new Error(
          'Updating a hold replaces its full scope: re-provide the current Account Emails or Org Unit ID ' +
            '(they are not preserved automatically). To add or remove individual custodians without ' +
            'resending the full scope, use Add Held Accounts / Remove Held Accounts instead.'
        )
      }

      if (params.corpus === 'MAIL' || params.corpus === 'GROUPS') {
        const hasQueryParams = params.terms || params.startTime || params.endTime
        if (hasQueryParams) {
          const queryObj: any = {}
          if (params.terms) queryObj.terms = params.terms
          if (params.startTime) queryObj.startTime = params.startTime
          if (params.endTime) queryObj.endTime = params.endTime

          if (params.corpus === 'MAIL') {
            body.query = { mailQuery: queryObj }
          } else {
            body.query = { groupsQuery: queryObj }
          }
        }
      } else if (params.corpus === 'DRIVE' && params.includeSharedDrives) {
        body.query = { driveQuery: { includeSharedDriveFiles: params.includeSharedDrives } }
      }

      return body
    },
  },

  transformResponse: async (response: Response) => {
    const data = await response.json()
    if (!response.ok) {
      const errorMessage = data.error?.message || 'Failed to update hold'
      throw new Error(enhanceGoogleVaultError(errorMessage))
    }
    return { success: true, output: { hold: data } }
  },

  outputs: {
    hold: { type: 'json', description: 'Updated hold object' },
  },
}