@elevenlabs/react-native/src/types.ts

ElevenLabs React Native SDK for Conversational AI

import type * as Types from "@elevenlabs/types";
import type {
  AsrInitiationMetadataEvent as AsrMetadataEvent,
  Callbacks,
  ConversationMetadata,
  Mode as ConversationMode,
  Incoming,
  Interruption,
  Role as MessageRole,
  Outgoing,
  Ping,
  Status,
} from "@elevenlabs/types";
export type { Callbacks } from "@elevenlabs/types";

/**
 * Role in the conversation
 */
export type Role = MessageRole;

/**
 * Current mode of the conversation
 */
export type Mode = ConversationMode;

export type ConversationStatus = Status;

/**
 * Language support
 */
export type Language = Types.ConversationConfigOverrideAgentLanguage;

/**
 * Client tools configuration
 */
export type ClientToolsConfig = {
  clientTools: Record<
    string,
    (
      parameters: unknown
    ) => Promise<string | number | undefined> | string | number | undefined
  >;
};

/**
 * Options for useConversation hook
 */
export type ConversationOptions = {
  serverUrl?: string;
  tokenFetchUrl?: string;
  clientTools?: Record<
    string,
    (
      parameters: unknown
    ) => Promise<string | number | undefined> | string | number | undefined
  >;
} & Partial<Callbacks>;

export type ConversationConfig = {
  agentId?: string;
  conversationToken?: string;
  tokenFetchUrl?: string;
  overrides?: {
    agent?: {
      prompt?: {
        prompt?: string;
      };
      firstMessage?: string;
      language?: Language;
    };
    tts?: {
      voiceId?: string;
      speed?: number;
    };
    conversation?: {
      textOnly?: boolean;
    };
    client?: {
      source?: string;
      version?: string;
    };
  };
  customLlmExtraBody?: unknown;
  dynamicVariables?: Record<string, string | number | boolean>;
  userId?: string;
};

// Incoming event types
export type UserTranscriptionEvent = Incoming.UserTranscriptionClientEvent;
export type AgentResponseEvent = Incoming.AgentResponseClientEvent;
export type AgentResponseCorrectionEvent =
  Incoming.AgentResponseCorrectionClientEvent;
export type AgentAudioEvent = Incoming.AudioClientEvent;
export type InterruptionEvent = Interruption;
export type InternalTentativeAgentResponseEvent =
  Incoming.TentativeAgentResponseInternalClientEvent;
export type ConfigEvent = ConversationMetadata;
export type PingEvent = Ping;
export type ClientToolCallEvent = Incoming.ClientToolCallClientEvent;
export type VadScoreEvent = Incoming.VadScoreClientEvent;
export type MCPToolCallClientEvent = Incoming.McpToolCallClientEvent;
export type MCPConnectionStatusEvent = Incoming.McpConnectionStatusClientEvent;
export type AgentToolRequestEvent = Incoming.AgentToolRequestClientEvent;
export type AgentToolResponseEvent = Incoming.AgentToolResponseClientEvent;
export type ConversationMetadataEvent = ConversationMetadata;
export type AsrInitiationMetadataEvent = AsrMetadataEvent;
export type AgentChatResponsePartEvent =
  Incoming.AgentChatResponsePartClientEvent;

// Outgoing event types
export type PongEvent = Outgoing.PongClientToOrchestratorEvent;
export type UserAudioEvent = Outgoing.UserAudio;
export type UserFeedbackEvent = Outgoing.UserFeedbackClientToOrchestratorEvent;
export type ClientToolResultEvent =
  Outgoing.ClientToolResultClientToOrchestratorEvent;
export type ContextualUpdateEvent =
  Outgoing.ContextualUpdateClientToOrchestratorEvent;
export type UserMessageEvent = Outgoing.UserMessageClientToOrchestratorEvent;
export type UserActivityEvent = Outgoing.UserActivityClientToOrchestratorEvent;
export type MCPToolApprovalResultEvent =
  Outgoing.McpToolApprovalResultClientToOrchestratorEvent;
export type InitiationClientDataEvent =
  Outgoing.ConversationInitiationClientToOrchestratorEvent;

export type ConversationEvent =
  | UserTranscriptionEvent
  | AgentResponseEvent
  | AgentResponseCorrectionEvent
  | AgentAudioEvent
  | InterruptionEvent
  | InternalTentativeAgentResponseEvent
  | ConfigEvent
  | PingEvent
  | ClientToolCallEvent
  | VadScoreEvent
  | MCPToolCallClientEvent
  | MCPConnectionStatusEvent
  | AgentToolRequestEvent
  | AgentToolResponseEvent
  | ConversationMetadataEvent
  | AsrInitiationMetadataEvent
  | AgentChatResponsePartEvent;

/**
 * Audio session configuration for controlling how the SDK handles audio
 */
export interface AudioSessionConfig {
  /**
   * Whether audio should mix with other audio sources.
   * When true, the SDK will configure the audio session to allow
   * concurrent audio playback with other audio sources.
   *
   * iOS: Adds AVAudioSessionCategoryOptionMixWithOthers
   * Android: Uses AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK
   *
   * @default false (exclusive audio session)
   */
  allowMixingWithOthers?: boolean;
}