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

import { createLogger } from '@sim/logger'
import type {
  SalesforceGetOpportunitiesParams,
  SalesforceGetOpportunitiesResponse,
} 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('SalesforceGetOpportunities')

export const salesforceGetOpportunitiesTool: ToolConfig<
  SalesforceGetOpportunitiesParams,
  SalesforceGetOpportunitiesResponse
> = {
  id: 'salesforce_get_opportunities',
  name: 'Get Opportunities from Salesforce',
  description: 'Get opportunity(ies) from Salesforce',
  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' },
    opportunityId: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description:
        'Salesforce Opportunity ID (18-character string starting with 006) to get a single opportunity',
    },
    limit: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description: 'Maximum number of results to return (default: 100)',
    },
    fields: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description: 'Comma-separated list of field API names to return',
    },
    orderBy: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description: 'Field and direction for sorting (e.g., CloseDate DESC)',
    },
  },

  request: {
    url: (params) => {
      const instanceUrl = getInstanceUrl(params.idToken, params.instanceUrl)
      if (params.opportunityId) {
        const opportunityId = requireId(params.opportunityId, 'Opportunity ID')
        const fields = params.fields || 'Id,Name,AccountId,Amount,StageName,CloseDate,Probability'
        return `${instanceUrl}/services/data/v59.0/sobjects/Opportunity/${opportunityId}?fields=${encodeURIComponent(fields)}`
      }
      const limit = params.limit ? Number.parseInt(params.limit) : 100
      const fields = params.fields || 'Id,Name,AccountId,Amount,StageName,CloseDate,Probability'
      const orderBy = params.orderBy || 'CloseDate DESC'
      const query = `SELECT ${fields} FROM Opportunity ORDER BY ${orderBy} LIMIT ${limit}`
      return `${instanceUrl}/services/data/v59.0/query?q=${encodeURIComponent(query)}`
    },
    method: 'GET',
    headers: (params) => ({
      Authorization: `Bearer ${params.accessToken}`,
      'Content-Type': 'application/json',
    }),
  },

  transformResponse: async (response, params?) => {
    const data = await response.json()
    if (!response.ok) {
      logger.error('Failed to fetch opportunities', { data, status: response.status })
      throw new Error(extractErrorMessage(data, response.status, 'Failed to fetch opportunities'))
    }
    if (params?.opportunityId) {
      return {
        success: true,
        output: { opportunity: data, success: true },
      }
    }
    const opportunities = data.records || []
    return {
      success: true,
      output: {
        opportunities,
        paging: {
          nextRecordsUrl: data.nextRecordsUrl ?? null,
          totalSize: data.totalSize || opportunities.length,
          done: data.done !== false,
        },
        metadata: {
          totalReturned: opportunities.length,
          hasMore: !data.done,
        },
        success: true,
      },
    }
  },

  outputs: {
    success: { type: 'boolean', description: 'Operation success status' },
    output: {
      type: 'object',
      description: 'Opportunity data',
      properties: {
        opportunity: {
          type: 'object',
          description: 'Single opportunity object (when opportunityId provided)',
        },
        opportunities: {
          type: 'array',
          description: 'Array of opportunity objects (when listing)',
        },
        paging: QUERY_PAGING_OUTPUT,
        metadata: RESPONSE_METADATA_OUTPUT,
        success: { type: 'boolean', description: 'Operation success status' },
      },
    },
  },
}