@runanywhere/core 0.16.0

package/src/types/events.ts

@@ -0,0 +1,337 @@
+/**
+ * RunAnywhere React Native SDK - Event Types
+ *
+ * These event types match the iOS Swift SDK event system.
+ * Reference: sdk/runanywhere-swift/Sources/RunAnywhere/Public/Events/SDKEvent.swift
+ */
+
+import type { LLMFramework, SDKComponent, SDKEventType } from './enums';
+import type {
+  DefaultGenerationSettings,
+  DeviceInfoData,
+  FrameworkAvailability,
+  InitializationResult,
+  ModelInfo,
+  StorageInfo,
+  StoredModel,
+} from './models';
+
+// ============================================================================
+// Base Event Interface
+// ============================================================================
+
+/**
+ * Base interface for all SDK events
+ */
+export interface SDKEvent {
+  /** Event timestamp */
+  timestamp: string;
+
+  /** Event type category */
+  eventType: SDKEventType;
+}
+
+// ============================================================================
+// Initialization Events
+// ============================================================================
+
+export type SDKInitializationEvent =
+  | { type: 'started' }
+  | { type: 'configurationLoaded'; source: string }
+  | { type: 'servicesBootstrapped' }
+  | { type: 'completed' }
+  | { type: 'failed'; error: string };
+
+// ============================================================================
+// Configuration Events
+// ============================================================================
+
+export type SDKConfigurationEvent =
+  | { type: 'fetchStarted' }
+  | { type: 'fetchCompleted'; source: string }
+  | { type: 'fetchFailed'; error: string }
+  | { type: 'loaded'; configuration: Record<string, unknown> | null }
+  | { type: 'updated'; changes: string[] }
+  | { type: 'syncStarted' }
+  | { type: 'syncCompleted' }
+  | { type: 'syncFailed'; error: string }
+  | { type: 'settingsRequested' }
+  | { type: 'settingsRetrieved'; settings: DefaultGenerationSettings }
+  | { type: 'routingPolicyRequested' }
+  | { type: 'routingPolicyRetrieved'; policy: string }
+  | { type: 'privacyModeRequested' }
+  | { type: 'privacyModeRetrieved'; mode: string }
+  | { type: 'analyticsStatusRequested' }
+  | { type: 'analyticsStatusRetrieved'; enabled: boolean }
+  | { type: 'syncRequested' };
+
+// ============================================================================
+// Generation Events
+// ============================================================================
+
+export type SDKGenerationEvent =
+  | { type: 'sessionStarted'; sessionId: string }
+  | { type: 'sessionEnded'; sessionId: string }
+  | { type: 'started'; prompt: string; sessionId?: string }
+  | { type: 'firstTokenGenerated'; token: string; latencyMs: number }
+  | { type: 'tokenGenerated'; token: string }
+  | { type: 'streamingUpdate'; text: string; tokensCount: number }
+  | {
+      type: 'completed';
+      response: string;
+      tokensUsed: number;
+      latencyMs: number;
+    }
+  | { type: 'failed'; error: string }
+  | { type: 'modelLoaded'; modelId: string }
+  | { type: 'modelUnloaded'; modelId: string }
+  | { type: 'costCalculated'; amount: number; savedAmount: number }
+  | { type: 'routingDecision'; target: string; reason: string };
+
+// ============================================================================
+// Model Events
+// ============================================================================
+
+export type SDKModelEvent =
+  | { type: 'loadStarted'; modelId: string }
+  | { type: 'loadProgress'; modelId: string; progress: number }
+  | { type: 'loadCompleted'; modelId: string }
+  | { type: 'loadFailed'; modelId: string; error: string }
+  | { type: 'unloadStarted' }
+  | { type: 'unloadCompleted' }
+  | { type: 'unloadFailed'; error: string }
+  | { type: 'downloadStarted'; modelId: string; taskId?: string }
+  | {
+      type: 'downloadProgress';
+      modelId: string;
+      taskId?: string;
+      progress: number;
+      bytesDownloaded?: number;
+      totalBytes?: number;
+      downloadState?: string;
+      error?: string;
+    }
+  | {
+      type: 'downloadCompleted';
+      modelId: string;
+      taskId?: string;
+      localPath?: string;
+    }
+  | { type: 'downloadFailed'; modelId: string; taskId?: string; error: string }
+  | { type: 'downloadCancelled'; modelId: string; taskId?: string }
+  | { type: 'listRequested' }
+  | { type: 'listCompleted'; models: ModelInfo[] }
+  | { type: 'listFailed'; error: string }
+  | { type: 'catalogLoaded'; models: ModelInfo[] }
+  | { type: 'deleteStarted'; modelId: string }
+  | { type: 'deleteCompleted'; modelId: string }
+  | { type: 'deleteFailed'; modelId: string; error: string }
+  | { type: 'customModelAdded'; name: string; url: string }
+  | { type: 'builtInModelRegistered'; modelId: string };
+
+// ============================================================================
+// Voice Events
+// ============================================================================
+
+export type SDKVoiceEvent =
+  | { type: 'listeningStarted' }
+  | { type: 'listeningEnded' }
+  | { type: 'speechDetected' }
+  | { type: 'transcriptionStarted' }
+  | { type: 'transcriptionPartial'; text: string }
+  | { type: 'transcriptionFinal'; text: string }
+  | { type: 'responseGenerated'; text: string }
+  | { type: 'synthesisStarted' }
+  | { type: 'audioGenerated'; data: string } // base64 encoded
+  | { type: 'synthesisCompleted' }
+  | { type: 'pipelineError'; error: string }
+  | { type: 'pipelineStarted' }
+  | { type: 'pipelineCompleted' }
+  | { type: 'vadStarted' }
+  | { type: 'vadDetected' }
+  | { type: 'vadEnded' }
+  | { type: 'sttProcessing' }
+  | { type: 'llmProcessing' }
+  | { type: 'ttsProcessing' }
+  // Recording events
+  | { type: 'recordingStarted' }
+  | { type: 'recordingStopped'; duration?: number }
+  // Playback events
+  | { type: 'playbackStarted'; duration?: number }
+  | { type: 'playbackCompleted'; duration?: number }
+  | { type: 'playbackStopped' }
+  | { type: 'playbackPaused' }
+  | { type: 'playbackResumed' }
+  | { type: 'playbackFailed'; error: string }
+  // VAD events
+  | { type: 'vadInitialized' }
+  | { type: 'vadStopped' }
+  | { type: 'vadCleanedUp' }
+  | { type: 'speechStarted' }
+  | { type: 'speechEnded' }
+  // STT partial result events
+  | { type: 'sttPartialResult'; text?: string; confidence?: number }
+  | { type: 'sttCompleted'; text?: string; confidence?: number }
+  | { type: 'sttFailed'; error?: string }
+  // Voice session events
+  | { type: 'voiceSession_started' }
+  | { type: 'voiceSession_listening'; audioLevel?: number }
+  | { type: 'voiceSession_speechStarted' }
+  | { type: 'voiceSession_speechEnded' }
+  | { type: 'voiceSession_processing' }
+  | { type: 'voiceSession_transcribed'; transcription?: string }
+  | { type: 'voiceSession_responded'; response?: string }
+  | { type: 'voiceSession_speaking' }
+  | { type: 'voiceSession_turnCompleted'; transcription?: string; response?: string; audio?: string }
+  | { type: 'voiceSession_stopped' }
+  | { type: 'voiceSession_error'; error?: string };
+
+// ============================================================================
+// Performance Events
+// ============================================================================
+
+export type SDKPerformanceEvent =
+  | { type: 'memoryWarning'; usage: number }
+  | { type: 'thermalStateChanged'; state: string }
+  | { type: 'latencyMeasured'; operation: string; milliseconds: number }
+  | { type: 'throughputMeasured'; tokensPerSecond: number };
+
+// ============================================================================
+// Network Events
+// ============================================================================
+
+export type SDKNetworkEvent =
+  | { type: 'requestStarted'; url: string }
+  | { type: 'requestCompleted'; url: string; statusCode: number }
+  | { type: 'requestFailed'; url: string; error: string }
+  | { type: 'connectivityChanged'; isOnline: boolean };
+
+// ============================================================================
+// Storage Events
+// ============================================================================
+
+export type SDKStorageEvent =
+  | { type: 'infoRequested' }
+  | { type: 'infoRetrieved'; info: StorageInfo }
+  | { type: 'modelsRequested' }
+  | { type: 'modelsRetrieved'; models: StoredModel[] }
+  | { type: 'clearCacheStarted' }
+  | { type: 'clearCacheCompleted' }
+  | { type: 'clearCacheFailed'; error: string }
+  | { type: 'cleanTempStarted' }
+  | { type: 'cleanTempCompleted' }
+  | { type: 'cleanTempFailed'; error: string }
+  | { type: 'deleteModelStarted'; modelId: string }
+  | { type: 'deleteModelCompleted'; modelId: string }
+  | { type: 'deleteModelFailed'; modelId: string; error: string };
+
+// ============================================================================
+// Framework Events
+// ============================================================================
+
+export type SDKFrameworkEvent =
+  | { type: 'adapterRegistered'; framework: LLMFramework; name: string }
+  | { type: 'adaptersRequested' }
+  | { type: 'adaptersRetrieved'; count: number }
+  | { type: 'frameworksRequested' }
+  | { type: 'frameworksRetrieved'; frameworks: LLMFramework[] }
+  | { type: 'availabilityRequested' }
+  | { type: 'availabilityRetrieved'; availability: FrameworkAvailability[] }
+  | { type: 'modelsForFrameworkRequested'; framework: LLMFramework }
+  | {
+      type: 'modelsForFrameworkRetrieved';
+      framework: LLMFramework;
+      models: ModelInfo[];
+    }
+  | { type: 'frameworksForModalityRequested'; modality: string }
+  | {
+      type: 'frameworksForModalityRetrieved';
+      modality: string;
+      frameworks: LLMFramework[];
+    };
+
+// ============================================================================
+// Device Events
+// ============================================================================
+
+export type SDKDeviceEvent =
+  | { type: 'deviceInfoCollected'; deviceInfo: DeviceInfoData }
+  | { type: 'deviceInfoCollectionFailed'; error: string }
+  | { type: 'deviceInfoRefreshed'; deviceInfo: DeviceInfoData }
+  | { type: 'deviceInfoSyncStarted' }
+  | { type: 'deviceInfoSyncCompleted' }
+  | { type: 'deviceInfoSyncFailed'; error: string }
+  | { type: 'deviceStateChanged'; property: string; newValue: string };
+
+// ============================================================================
+// Component Initialization Events
+// ============================================================================
+
+export type ComponentInitializationEvent =
+  | { type: 'initializationStarted'; components: SDKComponent[] }
+  | { type: 'initializationCompleted'; result: InitializationResult }
+  | {
+      type: 'componentStateChanged';
+      component: SDKComponent;
+      oldState: string;
+      newState: string;
+    }
+  | { type: 'componentChecking'; component: SDKComponent; modelId?: string }
+  | {
+      type: 'componentDownloadRequired';
+      component: SDKComponent;
+      modelId: string;
+      sizeBytes: number;
+    }
+  | {
+      type: 'componentDownloadStarted';
+      component: SDKComponent;
+      modelId: string;
+    }
+  | {
+      type: 'componentDownloadProgress';
+      component: SDKComponent;
+      modelId: string;
+      progress: number;
+    }
+  | {
+      type: 'componentDownloadCompleted';
+      component: SDKComponent;
+      modelId: string;
+    }
+  | { type: 'componentInitializing'; component: SDKComponent; modelId?: string }
+  | { type: 'componentReady'; component: SDKComponent; modelId?: string }
+  | { type: 'componentFailed'; component: SDKComponent; error: string }
+  | { type: 'parallelInitializationStarted'; components: SDKComponent[] }
+  | { type: 'sequentialInitializationStarted'; components: SDKComponent[] }
+  | { type: 'allComponentsReady' }
+  | {
+      type: 'someComponentsReady';
+      ready: SDKComponent[];
+      pending: SDKComponent[];
+    };
+
+// ============================================================================
+// Union Type for All Events
+// ============================================================================
+
+export type AnySDKEvent =
+  | SDKInitializationEvent
+  | SDKConfigurationEvent
+  | SDKGenerationEvent
+  | SDKModelEvent
+  | SDKVoiceEvent
+  | SDKPerformanceEvent
+  | SDKNetworkEvent
+  | SDKStorageEvent
+  | SDKFrameworkEvent
+  | SDKDeviceEvent
+  | ComponentInitializationEvent;
+
+// ============================================================================
+// Event Listener Types
+// ============================================================================
+
+export type SDKEventListener<T> = (event: T) => void;
+
+export type UnsubscribeFunction = () => void;

package/src/types/external.d.ts

@@ -0,0 +1,142 @@
+/**
+ * Type declarations for optional external modules
+ * These modules are dynamically imported and may not be installed
+ */
+
+// react-native-fs is an optional dependency for file operations
+declare module 'react-native-fs' {
+  const RNFS: {
+    DocumentDirectoryPath: string;
+    CachesDirectoryPath: string;
+    MainBundlePath: string;
+    LibraryDirectoryPath: string;
+    ExternalDirectoryPath: string;
+    ExternalStorageDirectoryPath: string;
+    TemporaryDirectoryPath: string;
+    DownloadDirectoryPath: string;
+    PicturesDirectoryPath: string;
+
+    mkdir(
+      filepath: string,
+      options?: { NSURLIsExcludedFromBackupKey?: boolean }
+    ): Promise<void>;
+    moveFile(filepath: string, destPath: string): Promise<void>;
+    copyFile(filepath: string, destPath: string): Promise<void>;
+    unlink(filepath: string): Promise<void>;
+    exists(filepath: string): Promise<boolean>;
+    readFile(filepath: string, encoding?: string): Promise<string>;
+    writeFile(
+      filepath: string,
+      contents: string,
+      encoding?: string
+    ): Promise<void>;
+    appendFile(
+      filepath: string,
+      contents: string,
+      encoding?: string
+    ): Promise<void>;
+    stat(filepath: string): Promise<{
+      name: string;
+      path: string;
+      size: number;
+      mode: number;
+      ctime: number;
+      mtime: number;
+      originalFilepath: string;
+      isFile: () => boolean;
+      isDirectory: () => boolean;
+    }>;
+    readDir(dirpath: string): Promise<
+      Array<{
+        name: string;
+        path: string;
+        size: number;
+        ctime: Date;
+        mtime: Date;
+        isFile: () => boolean;
+        isDirectory: () => boolean;
+      }>
+    >;
+    hash(filepath: string, algorithm: string): Promise<string>;
+    getFSInfo(): Promise<{
+      totalSpace: number;
+      freeSpace: number;
+    }>;
+    downloadFile(options: {
+      fromUrl: string;
+      toFile: string;
+      headers?: Record<string, string>;
+      background?: boolean;
+      begin?: (res: {
+        jobId: number;
+        contentLength: number;
+        statusCode: number;
+      }) => void;
+      progress?: (res: {
+        jobId: number;
+        bytesWritten: number;
+        contentLength: number;
+      }) => void;
+      progressDivider?: number;
+    }): {
+      jobId: number;
+      promise: Promise<{
+        jobId: number;
+        statusCode: number;
+        bytesWritten: number;
+      }>;
+    };
+    stopDownload(jobId: number): void;
+  };
+  export = RNFS;
+}
+
+// rn-fetch-blob is an optional dependency for large file downloads
+declare module 'rn-fetch-blob' {
+  interface FetchBlobResponse {
+    path(): string;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any -- External library JSON type
+    json(): any;
+    text(): string;
+    data: string;
+    info(): { status: number; headers: Record<string, string> };
+    flush(): void;
+  }
+
+  interface StatefulPromise<T> extends Promise<T> {
+    cancel(): void;
+    progress(
+      callback: (received: number, total: number) => void
+    ): StatefulPromise<T>;
+  }
+
+  interface RNFetchBlob {
+    fs: {
+      dirs: {
+        DocumentDir: string;
+        CacheDir: string;
+        DownloadDir: string;
+      };
+      exists(path: string): Promise<boolean>;
+      unlink(path: string): Promise<void>;
+      mkdir(path: string): Promise<void>;
+    };
+    config(options: {
+      fileCache?: boolean;
+      path?: string;
+      appendExt?: string;
+      timeout?: number;
+    }): {
+      fetch(
+        method: string,
+        url: string,
+        headers?: Record<string, string>,
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any -- External library body type
+        body?: any
+      ): StatefulPromise<FetchBlobResponse>;
+    };
+  }
+
+  const RNFetchBlob: { default: RNFetchBlob };
+  export = RNFetchBlob;
+}

package/src/types/index.ts

@@ -0,0 +1,146 @@
+/**
+ * RunAnywhere React Native SDK - Types
+ *
+ * Re-exports all types for convenient importing.
+ */
+
+// Enums
+export {
+  ComponentState,
+  ConfigurationSource,
+  ExecutionTarget,
+  FrameworkModality,
+  HardwareAcceleration,
+  LLMFramework,
+  LLMFrameworkDisplayNames,
+  ModelCategory,
+  ModelCategoryDisplayNames,
+  ModelFormat,
+  PrivacyMode,
+  RoutingPolicy,
+  SDKComponent,
+  SDKEnvironment,
+  SDKEventType,
+} from './enums';
+
+// Models
+export type {
+  ComponentHealth,
+  ConfigurationData,
+  DefaultGenerationSettings,
+  DeviceInfoData,
+  FrameworkAvailability,
+  GeneratableType,
+  GenerationOptions,
+  GenerationResult,
+  InitializationResult,
+  LLMGenerationOptions,
+  ModelInfo,
+  ModelInfoMetadata,
+  PerformanceMetrics,
+  SDKInitOptions,
+  STTAlternative,
+  STTOptions,
+  STTResult,
+  STTSegment,
+  StorageInfo,
+  StoredModel,
+  StructuredOutputConfig,
+  StructuredOutputValidation,
+  ThinkingTagPattern,
+  TTSConfiguration,
+  TTSResult,
+  VADConfiguration,
+  VoiceAudioChunk,
+} from './models';
+
+// Events
+export type {
+  AnySDKEvent,
+  ComponentInitializationEvent,
+  SDKConfigurationEvent,
+  SDKDeviceEvent,
+  SDKEvent,
+  SDKEventListener,
+  SDKFrameworkEvent,
+  SDKGenerationEvent,
+  SDKInitializationEvent,
+  SDKModelEvent,
+  SDKNetworkEvent,
+  SDKPerformanceEvent,
+  SDKStorageEvent,
+  SDKVoiceEvent,
+  UnsubscribeFunction,
+} from './events';
+
+// Voice Agent Types
+export type {
+  ComponentLoadState,
+  ComponentState as VoiceAgentComponentState,
+  VoiceAgentComponentStates,
+  VoiceAgentConfig,
+  VoiceTurnResult,
+  VoiceSessionEventType,
+  VoiceSessionEvent,
+  VoiceSessionCallback,
+  VoiceAgentMetrics,
+} from './VoiceAgentTypes';
+
+// Structured Output Types
+export type {
+  JSONSchemaType,
+  JSONSchemaProperty,
+  JSONSchema,
+  StructuredOutputOptions,
+  StructuredOutputResult,
+  EntityExtractionResult,
+  ClassificationResult,
+  SentimentResult,
+  NamedEntity,
+  NERResult,
+} from './StructuredOutputTypes';
+
+// VAD Types
+export type {
+  VADConfiguration as VADConfig,
+  VADResult,
+  SpeechActivityEvent,
+  VADSpeechActivityCallback,
+  VADAudioBufferCallback,
+  VADState,
+} from './VADTypes';
+
+// TTS Types
+export type {
+  TTSOptions as TTSOpts,
+  AudioFormat,
+  TTSOutput,
+  PhonemeTimestamp,
+  TTSSynthesisMetadata,
+  TTSSpeakResult,
+  TTSVoiceInfo,
+  TTSStreamChunkCallback,
+} from './TTSTypes';
+
+// STT Types
+export type {
+  STTOptions as STTOpts,
+  STTOutput,
+  WordTimestamp,
+  STTAlternative as STTAlt,
+  TranscriptionMetadata,
+  STTPartialResult,
+  STTStreamCallback,
+  STTStreamOptions,
+} from './STTTypes';
+
+// LLM Types
+export type {
+  LLMGenerationOptions as LLMGenOptions,
+  LLMGenerationResult as LLMGenResult,
+  LLMStreamingResult,
+  LLMStreamingMetrics,
+  LLMTokenCallback,
+  LLMStreamCompleteCallback,
+  LLMStreamErrorCallback,
+} from './LLMTypes';