sim/tools/types.ts

import { OAuthService } from '@/lib/oauth'

export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'

export interface ToolResponse {
  success: boolean // Whether the tool execution was successful
  output: Record<string, any> // The structured output from the tool
  error?: string // Error message if success is false
}

export interface OAuthConfig {
  required: boolean // Whether this tool requires OAuth authentication
  provider: OAuthService // The service that needs to be authorized
  additionalScopes?: string[] // Additional scopes required for the tool
}

export interface ToolConfig<P = any, R extends ToolResponse = ToolResponse> {
  // Basic tool identification
  id: string
  name: string
  description: string
  version: string

  // Parameter schema - what this tool accepts
  params: Record<
    string,
    {
      type: string
      required?: boolean
      requiredForToolCall?: boolean
      default?: any
      description?: string
    }
  >

  // OAuth configuration for this tool (if it requires authentication)
  oauth?: OAuthConfig

  // Request configuration
  request: {
    url: string | ((params: P) => string)
    method: string
    headers: (params: P) => Record<string, string>
    body?: (params: P) => Record<string, any>
    isInternalRoute?: boolean // Whether this is an internal API route
  }

  // Direct execution in browser (optional) - bypasses HTTP request
  directExecution?: (params: P) => Promise<R | undefined>

  // Response handling
  transformResponse: (response: Response) => Promise<R>
  transformError: (error: any) => string
}

export interface TableRow {
  id: string
  cells: {
    Key: string
    Value: string
  }
}

export interface OAuthTokenPayload {
  credentialId: string
  workflowId?: string
}