ccs/src/cliproxy/types.ts

/**
 * CLIProxy Type Definitions
 * Types for CLIProxyAPI binary management and execution
 */

/**
 * Supported operating systems
 */
export type SupportedOS = 'darwin' | 'linux' | 'windows';

/**
 * Supported CPU architectures
 */
export type SupportedArch = 'amd64' | 'arm64';

/**
 * Archive extension based on platform
 */
export type ArchiveExtension = 'tar.gz' | 'zip';

/**
 * Platform detection result
 */
export interface PlatformInfo {
  /** Operating system (darwin, linux, windows) */
  os: SupportedOS;
  /** CPU architecture (amd64, arm64) */
  arch: SupportedArch;
  /** Full binary archive name (e.g., CLIProxyAPI_6.5.27_linux_amd64.tar.gz) */
  binaryName: string;
  /** Archive extension (tar.gz for Unix, zip for Windows) */
  extension: ArchiveExtension;
}

/**
 * Binary manager configuration
 */
export interface BinaryManagerConfig {
  /** CLIProxyAPI version to download */
  version: string;
  /** GitHub releases base URL */
  releaseUrl: string;
  /** Local binary storage path (~/.ccs/bin/) */
  binPath: string;
  /** Maximum download retry attempts */
  maxRetries: number;
  /** Enable verbose logging */
  verbose: boolean;
  /** Force specific version (skip auto-upgrade to latest) */
  forceVersion: boolean;
  /** Backend variant (original vs plus) */
  backend?: CLIProxyBackend;
}

/**
 * Download progress callback
 */
export interface DownloadProgress {
  /** Total bytes to download */
  total: number;
  /** Bytes downloaded so far */
  downloaded: number;
  /** Download percentage (0-100) */
  percentage: number;
}

/**
 * Download progress callback function type
 */
export type ProgressCallback = (progress: DownloadProgress) => void;

/**
 * Binary info after successful download/verification
 */
export interface BinaryInfo {
  /** Full path to executable */
  path: string;
  /** CLIProxyAPI version */
  version: string;
  /** Platform info */
  platform: PlatformInfo;
  /** SHA256 checksum (verified) */
  checksum: string;
}

/**
 * Checksum verification result
 */
export interface ChecksumResult {
  /** Whether checksum matched */
  valid: boolean;
  /** Expected checksum from checksums.txt */
  expected: string;
  /** Actual computed checksum */
  actual: string;
}

/**
 * Download result
 */
export interface DownloadResult {
  /** Whether download succeeded */
  success: boolean;
  /** Path to downloaded file */
  filePath?: string;
  /** Error message if failed */
  error?: string;
  /** Number of retries attempted */
  retries: number;
}

/**
 * Supported CLIProxy providers
 * - gemini: Google Gemini via OAuth
 * - codex: OpenAI Codex via OAuth
 * - agy: Antigravity via OAuth (short name for easy usage)
 * - qwen: Qwen Code via OAuth (qwen3-coder)
 * - iflow: iFlow via OAuth
 * - kiro: Kiro (AWS CodeWhisperer) via OAuth
 * - ghcp: GitHub Copilot via Device Code (OAuth through CLIProxyAPIPlus)
 * - claude: Claude (Anthropic) via OAuth
 */
export type CLIProxyProvider =
  | 'gemini'
  | 'codex'
  | 'agy'
  | 'qwen'
  | 'iflow'
  | 'kiro'
  | 'ghcp'
  | 'claude';

/**
 * CLIProxy backend selection
 * - original: CLIProxyAPI (no Kiro/ghcp support)
 * - plus: CLIProxyAPIPlus (Kiro/ghcp support, default)
 */
export type CLIProxyBackend = 'original' | 'plus';

/**
 * Providers that require CLIProxyAPIPlus backend
 */
export const PLUS_ONLY_PROVIDERS: CLIProxyProvider[] = ['kiro', 'ghcp'];

/**
 * CLIProxy config.yaml structure (minimal)
 */
export interface CLIProxyConfig {
  port: number;
  'api-keys': string[];
  'auth-dir': string;
  debug: boolean;
  'gemini-api-key'?: Array<{
    'api-key': string;
    'base-url'?: string;
  }>;
  'codex-api-key'?: Array<{
    'api-key': string;
    'base-url'?: string;
  }>;
  'openai-compatibility'?: Array<{
    name: string;
    'base-url': string;
    'api-key-entries': Array<{
      'api-key': string;
    }>;
  }>;
}

/**
 * Executor configuration
 */
export interface ExecutorConfig {
  /** Port for CLIProxyAPI (default: 8317) */
  port: number;
  /** Timeout for proxy readiness in ms (default: 5000) */
  timeout: number;
  /** Enable verbose logging */
  verbose: boolean;
  /** Poll interval for port check in ms (default: 100) */
  pollInterval: number;
  /** Custom settings path for user-defined CLIProxy variants */
  customSettingsPath?: string;
}

/**
 * Model mapping for each provider
 */
export interface ProviderModelMapping {
  /** Default model for requests */
  defaultModel: string;
  /** Model for Claude CLI's ANTHROPIC_MODEL */
  claudeModel: string;
  /** Model for Claude CLI's ANTHROPIC_DEFAULT_OPUS_MODEL */
  opusModel?: string;
  /** Model for Claude CLI's ANTHROPIC_DEFAULT_SONNET_MODEL */
  sonnetModel?: string;
  /** Model for Claude CLI's ANTHROPIC_DEFAULT_HAIKU_MODEL */
  haikuModel?: string;
}

/**
 * Provider configuration
 */
export interface ProviderConfig {
  /** Provider name */
  name: CLIProxyProvider;
  /** Display name for UI */
  displayName: string;
  /** Model configuration */
  models: ProviderModelMapping;
  /** Whether OAuth is required */
  requiresOAuth: boolean;
}

/**
 * Resolved proxy configuration after merging CLI > ENV > config.yaml > defaults.
 * Used by executor to determine local vs remote proxy mode.
 */
export interface ResolvedProxyConfig {
  /** Proxy mode: 'local' spawns CLIProxyAPI locally, 'remote' connects to external server */
  mode: 'local' | 'remote';
  /** Remote proxy hostname/IP (only for remote mode) */
  host?: string;
  /** Proxy port (default: 8317) */
  port: number;
  /** Protocol for remote connection (default: http) */
  protocol: 'http' | 'https';
  /** Auth token for remote proxy authentication */
  authToken?: string;
  /** Enable fallback to local when remote unreachable (default: true) */
  fallbackEnabled: boolean;
  /** Auto-start local proxy if not running (default: true) */
  autoStartLocal: boolean;
  /** --remote-only flag: fail if remote unreachable, no fallback */
  remoteOnly: boolean;
  /** --local-proxy flag: force local mode, ignore remote config */
  forceLocal: boolean;
  /** Remote proxy connection timeout in ms (default: 2000) */
  timeout?: number;
  /** Allow self-signed certificates for HTTPS connections (default: true) */
  allowSelfSigned?: boolean;
}