simstudioai--sim/apps/sim/tools/salesforce/get_contacts.ts

import { createLogger } from '@sim/logger'
import type {
  SalesforceGetContactsParams,
  SalesforceGetContactsResponse,
} from '@/tools/salesforce/types'
import { QUERY_PAGING_OUTPUT, RESPONSE_METADATA_OUTPUT } from '@/tools/salesforce/types'
import { extractErrorMessage, getInstanceUrl, requireId } from '@/tools/salesforce/utils'
import type { ToolConfig } from '@/tools/types'

const logger = createLogger('SalesforceContacts')

export const salesforceGetContactsTool: ToolConfig<
  SalesforceGetContactsParams,
  SalesforceGetContactsResponse
> = {
  id: 'salesforce_get_contacts',
  name: 'Get Contacts from Salesforce',
  description: 'Get contact(s) from Salesforce - single contact if ID provided, or list if not',
  version: '1.0.0',

  oauth: {
    required: true,
    provider: 'salesforce',
  },

  params: {
    accessToken: { type: 'string', required: true, visibility: 'hidden' },
    idToken: { type: 'string', required: false, visibility: 'hidden' },
    instanceUrl: { type: 'string', required: false, visibility: 'hidden' },
    contactId: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description:
        'Salesforce Contact ID (18-character string starting with 003) to get a single contact',
    },
    limit: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description: 'Maximum number of results (default: 100, max: 2000). Only for list query.',
    },
    fields: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description: 'Comma-separated field API names (e.g., "Id,FirstName,LastName,Email,Phone")',
    },
    orderBy: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description: 'Field and direction for sorting (e.g., "LastName ASC"). Only for list query.',
    },
  },

  request: {
    url: (params) => {
      const instanceUrl = getInstanceUrl(params.idToken, params.instanceUrl)

      // Single contact by ID
      if (params.contactId) {
        const contactId = requireId(params.contactId, 'Contact ID')
        const fields =
          params.fields || 'Id,FirstName,LastName,Email,Phone,AccountId,Title,Department'
        return `${instanceUrl}/services/data/v59.0/sobjects/Contact/${contactId}?fields=${encodeURIComponent(fields)}`
      }

      // List contacts with SOQL query
      const limit = params.limit ? Number.parseInt(params.limit) : 100
      const fields = params.fields || 'Id,FirstName,LastName,Email,Phone,AccountId,Title,Department'
      const orderBy = params.orderBy || 'LastName ASC'
      const query = `SELECT ${fields} FROM Contact ORDER BY ${orderBy} LIMIT ${limit}`
      const encodedQuery = encodeURIComponent(query)

      return `${instanceUrl}/services/data/v59.0/query?q=${encodedQuery}`
    },
    method: 'GET',
    headers: (params) => ({
      Authorization: `Bearer ${params.accessToken}`,
      'Content-Type': 'application/json',
    }),
  },

  transformResponse: async (response: Response, params?) => {
    const data = await response.json()

    if (!response.ok) {
      logger.error('Salesforce API request failed', { data, status: response.status })
      throw new Error(
        extractErrorMessage(data, response.status, 'Failed to fetch contacts from Salesforce')
      )
    }

    // Single contact response
    if (params?.contactId) {
      return {
        success: true,
        output: {
          contact: data,
          singleContact: true,
          success: true,
        },
      }
    }

    // List contacts response
    const contacts = data.records || []
    return {
      success: true,
      output: {
        contacts,
        paging: {
          nextRecordsUrl: data.nextRecordsUrl ?? null,
          totalSize: data.totalSize || contacts.length,
          done: data.done !== false,
        },
        metadata: {
          totalReturned: contacts.length,
          hasMore: !data.done,
        },
        singleContact: false,
        success: true,
      },
    }
  },

  outputs: {
    success: { type: 'boolean', description: 'Operation success status' },
    output: {
      type: 'object',
      description: 'Contact(s) data',
      properties: {
        contacts: { type: 'array', description: 'Array of contacts (list query)' },
        contact: { type: 'object', description: 'Single contact (by ID)' },
        paging: QUERY_PAGING_OUTPUT,
        metadata: RESPONSE_METADATA_OUTPUT,
        singleContact: { type: 'boolean', description: 'Whether single contact was returned' },
        success: { type: 'boolean', description: 'Salesforce operation success' },
      },
    },
  },
}