@omnicross/contracts 0.1.0

package/dist/llm-config-CQjOimv2.d.cts

@@ -0,0 +1,390 @@
+import { T as ThinkLevel } from './thinking-CBWSLel8.cjs';
+
+/**
+ * Provider preset types — hand-authored TypeScript (verbatim from the prior
+ * flat `provider-presets.ts`). These are re-exported by the module barrel
+ * (`index.ts`, via `schema.ts`) so every `@omnicross/contracts/provider-presets`
+ * import site is unchanged. The Zod runtime schema lives in `schema.ts`.
+ */
+
+/**
+ * How a provider implements web search:
+ * - 'model-param': Search enabled via a request parameter (e.g., enable_search, web_search)
+ * - 'builtin-tool': Search provided as a built-in tool definition in the tools array
+ * - 'mcp': Search provided via an MCP server
+ * - 'sdk-native': Search handled natively by the SDK (e.g., Anthropic server-side tools)
+ * - 'none': Provider does not support search
+ */
+type SearchCapability = 'model-param' | 'builtin-tool' | 'mcp' | 'sdk-native' | 'none';
+/**
+ * Provider-specific search configuration
+ */
+interface ProviderSearchConfig {
+    type: SearchCapability;
+    /** Parameter name to enable search (e.g., 'enable_search', 'web_search') */
+    paramName?: string;
+    /** Value to set for the parameter (e.g., true, { enable: true }) */
+    paramValue?: unknown;
+    /** Additional parameters to include when search is enabled */
+    extraParams?: Record<string, unknown>;
+    /** Tool definition to inject into the tools array */
+    toolDefinition?: Record<string, unknown>;
+    /** Whether the built-in search tool conflicts with function calling */
+    conflictsWithFC?: boolean;
+    /** MCP server ID that provides the search tool */
+    mcpServerId?: string;
+    /** Models this search config applies to (null or undefined = all models) */
+    applicableModels?: string[] | null;
+}
+/**
+ * Canonical API mode ids. Use these as `ApiMode.id` for built-in plans so the
+ * UI can localize labels and so future code can reason about modes by enum.
+ */
+declare const API_MODE_IDS: {
+    readonly STANDARD: "standard";
+    readonly CODING_PLAN: "coding-plan";
+    readonly TOKEN_PLAN: "token-plan";
+};
+type ApiModeId = string;
+/**
+ * One API endpoint variant on a provider. Providers with multiple modes
+ * (standard / coding-plan / token-plan) declare an array of these; the UI
+ * renders a switcher and the runtime uses the selected mode's baseUrl/apiKey.
+ *
+ * Mode-less providers (OpenAI / Anthropic / Gemini / etc.) simply leave
+ * `apiModes` undefined — the existing `api_base_url` field is used as-is.
+ */
+interface ApiMode {
+    /** Stable id within the provider — `'standard' | 'coding-plan' | 'token-plan'` for built-in plans */
+    id: ApiModeId;
+    /** i18n key (e.g. `apiMode.codingPlan`) or display label fallback */
+    label: string;
+    /** Endpoint base URL for this mode */
+    baseUrl: string;
+    /** Optional default API key for this mode (e.g. dashscope coding plan key). When set, switching to
+     *  this mode overwrites the provider's `api_key` UI field if no customization is detected. */
+    apiKey?: string;
+    /** Optional API key prefix hint shown to user (e.g. `'sk-tp-'` for Tencent Token Plan) */
+    apiKeyPrefix?: string;
+    /** Optional note (i18n key) — e.g. "仅限编程工具调用" */
+    note?: string;
+}
+/**
+ * Coding Plan configuration on a provider.
+ * @deprecated Prefer `LLMProvider.apiModes` + `selectedApiModeId`. This field
+ *   is retained for backward-compat read paths; runtime endpoint resolution
+ *   falls back to it when `apiModes` is undefined.
+ */
+interface CodingPlanConfig {
+    /** Whether Coding Plan is enabled */
+    enabled: boolean;
+    /** Coding Plan dedicated Base URL */
+    baseUrl?: string;
+    /** Coding Plan dedicated API Key (some providers require separate key) */
+    apiKey?: string;
+    /** Plan description (Lite/Pro etc.) */
+    note?: string;
+}
+/**
+ * Model mapping for a provider's model ecosystem.
+ * Used by "Follow Provider" feature to auto-select background/vision models.
+ */
+interface ProviderModelMapping {
+    /** Primary/flagship model */
+    primary: string;
+    /** Lightweight model for background tasks */
+    background: string;
+    /** Vision-capable model (null = provider has no vision model) */
+    vision: string | null;
+}
+/**
+ * Extended provider template with Coding Plan and preset metadata.
+ * Note: there is NO `category` field — the registry is intentionally flat at
+ * the public API level. Internal arrays exist only for code organization.
+ */
+interface PresetProviderTemplate extends ProviderTemplate {
+    /** Preset ID for matching with CODING_PLAN_URL_PRESETS and PROVIDER_MODEL_MAPPINGS */
+    presetId: string;
+    /**
+     * Optional i18n key for the display name (e.g. `presetName.tencent`). When
+     * present, clients prefer this over the seed `name` field for list
+     * display (so Chinese-named built-in providers render translated in non-zh
+     * locales). English-named presets (OpenAI / Anthropic / etc.) leave this
+     * undefined — the raw `name` is already locale-neutral. User-customized
+     * names (DB row name diverged from preset seed) always win regardless.
+     */
+    nameKey?: string;
+    /**
+     * Coding Plan Base URL (if provider supports Coding Plan)
+     * @deprecated Prefer `apiModes` — when `apiModes` is declared, this field is
+     *   typically derived from `apiModes.find(m => m.id === 'coding-plan')?.baseUrl`.
+     *   Retained for backward-compat reads.
+     */
+    codingPlanBaseUrl?: string;
+    /** Whether Coding Plan requires a separate API Key */
+    codingPlanSeparateKey?: boolean;
+    /** Feature tags for display */
+    features?: string[];
+    /** Search capability configuration for this provider */
+    searchConfig?: ProviderSearchConfig;
+    /**
+     * Optional list of API endpoint modes (standard / coding-plan / token-plan).
+     * Length ≥ 2 makes the UI render a mode switcher next to the API URL field.
+     * The first entry MUST have `id: 'standard'` and represents pay-as-you-go.
+     */
+    apiModes?: ApiMode[];
+    /**
+     * Additive, reserved per-preset revision (design D2). Defaulted to `1` by the
+     * loader when absent. Reserved for future overlay / remote-refresh — no
+     * current consumer reads it, and it does NOT affect any returned value.
+     */
+    revision?: number;
+}
+
+/**
+ * LLM provider configuration TYPES.
+ *
+ * A dependency-light, TYPE-ONLY set of the LLM-provider config interfaces the
+ * `@omnicross/*` packages — and the `provider-presets` directory in this package —
+ * consume (`LLMProvider`, `ModelConfig`, `ApiFormat`, `ProviderTemplate`, etc.).
+ * Type interfaces only; no runtime values.
+ */
+
+/**
+ * A transformer entry can be either:
+ * - A string (transformer name only)
+ * - A tuple of [name, options] for parameterized transformers
+ */
+type TransformerEntry = string | [string, Record<string, unknown>];
+/**
+ * Transformer configuration for a provider or model
+ */
+interface TransformerConfig {
+    /** List of transformers to apply at provider level */
+    use?: TransformerEntry[];
+    /** Model-specific transformer configurations */
+    [modelName: string]: {
+        use?: TransformerEntry[];
+    } | TransformerEntry[] | undefined;
+}
+/**
+ * Default completion settings for a provider or model
+ */
+interface CompletionSettings {
+    /** Temperature (0-2, default 0.7) */
+    temperature?: number;
+    /** Top P / Nucleus sampling (0-1, default 1) */
+    topP?: number;
+    /** Top K sampling (optional) */
+    topK?: number;
+    /** Maximum tokens for completion output */
+    maxTokens?: number;
+    /** Context window size (for display/reference) */
+    contextLength?: number;
+    /** Presence penalty (-2 to 2) */
+    presencePenalty?: number;
+    /** Frequency penalty (-2 to 2) */
+    frequencyPenalty?: number;
+    /** Stop sequences */
+    stop?: string[];
+    /** Enable streaming by default */
+    stream?: boolean;
+    /** Enable JSON mode */
+    jsonMode?: boolean;
+    /** Seed for reproducibility */
+    seed?: number;
+}
+/**
+ * Model group for organizing models in the UI
+ */
+interface ModelGroup {
+    /** Group name */
+    name: string;
+    /** Group ID */
+    id: string;
+    /** Models in this group */
+    models: ModelConfig[];
+}
+/** OpenRouter provider sorting strategy */
+type OpenRouterProviderSort = 'price' | 'throughput' | 'latency';
+/** OpenRouter data collection policy */
+type OpenRouterDataCollection = 'allow' | 'deny';
+/** OpenRouter quantization levels */
+type OpenRouterQuantization = 'int4' | 'int8' | 'fp4' | 'fp6' | 'fp8' | 'fp16' | 'bf16' | 'fp32' | 'unknown';
+/** OpenRouter maximum pricing configuration */
+interface OpenRouterMaxPrice {
+    prompt?: number;
+    completion?: number;
+    request?: number;
+    image?: number;
+}
+/**
+ * OpenRouter provider routing configuration
+ * @see https://openrouter.ai/docs/guides/routing/provider-selection
+ */
+interface OpenRouterProviderRouting {
+    sort?: OpenRouterProviderSort;
+    order?: string[];
+    allow_fallbacks?: boolean;
+    require_parameters?: boolean;
+    data_collection?: OpenRouterDataCollection;
+    zdr?: boolean;
+    enforce_distillable_text?: boolean;
+    only?: string[];
+    ignore?: string[];
+    quantizations?: OpenRouterQuantization[];
+    max_price?: OpenRouterMaxPrice;
+}
+/** @deprecated Use apiFormat instead */
+type ProviderApiType = 'openai' | 'claudecode' | 'anthropic' | 'google' | 'custom';
+/**
+ * API format - the API format used by the provider.
+ * 'openai' | 'anthropic' | 'google' | 'azure-openai' | 'openai-response'
+ */
+type ApiFormat = 'openai' | 'anthropic' | 'google' | 'azure-openai' | 'openai-response';
+/** @deprecated Use ApiFormat instead */
+type ChatApiFormat = ApiFormat;
+/**
+ * Model configuration with extended metadata
+ */
+interface ModelConfig {
+    id: string;
+    name: string;
+    enabled: boolean;
+    category?: 'chat' | 'reasoning' | 'image' | 'video' | 'embedding' | 'code';
+    group?: string;
+    contextLength?: number;
+    maxTokens?: number;
+    completionSettings?: CompletionSettings;
+    vision?: boolean;
+    functionCall?: boolean;
+    reasoning?: boolean;
+    thinkingLevels?: ThinkLevel[];
+    thinkingTokenLimit?: {
+        min: number;
+        max: number;
+    };
+    webSearch?: boolean;
+    openRouterProvider?: OpenRouterProviderRouting;
+}
+/**
+ * LLM Provider configuration.
+ */
+interface LLMProvider {
+    id: string;
+    name: string;
+    apiFormat?: ApiFormat;
+    /** @deprecated Use apiFormat instead */
+    chatApiFormat?: ChatApiFormat;
+    /** @deprecated Use apiFormat instead */
+    apiType?: ProviderApiType;
+    api_base_url: string;
+    api_key: string;
+    hasKey?: boolean;
+    models: string[];
+    modelConfigs?: ModelConfig[];
+    modelGroups?: ModelGroup[];
+    modelsEndpoint?: string;
+    enabled: boolean;
+    transformer?: TransformerConfig;
+    rerouterEnabled?: boolean;
+    icon?: string;
+    website?: string;
+    docsUrl?: string;
+    defaultSettings?: CompletionSettings;
+    isSystem?: boolean;
+    isOfficial?: boolean;
+    rateLimit?: number;
+    maxConcurrency?: number;
+    notes?: string;
+    apiVersion?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    /** @deprecated Prefer `apiModes` + `selectedApiModeId`. */
+    codingPlan?: CodingPlanConfig;
+    presetId?: string;
+    sortOrder?: number;
+    apiModes?: ApiMode[];
+    selectedApiModeId?: string;
+    nameKey?: string;
+    presetRef?: string;
+    overriddenFields?: string[];
+}
+/**
+ * API key entry in the key pool. Each provider can have multiple keys for
+ * load balancing.
+ */
+interface ApiKeyEntry {
+    id: string;
+    providerId: string;
+    label: string;
+    apiKey: string;
+    hasKey?: boolean;
+    keyHint?: string;
+    enabled: boolean;
+    weight: number;
+    sortOrder: number;
+    createdAt?: string;
+    updatedAt?: string;
+    disabledReason?: string | null;
+    lastErrorStatus?: number | null;
+    lastErrorAt?: number | null;
+}
+/** Model reference in format "provider,model" or just "model" */
+type ModelRef = string;
+/**
+ * Agent default models configuration. Used when running Agent mode to specify
+ * models for different task types.
+ */
+interface AgentDefaultModels {
+    /** Background task model - format: "providerId,modelId" */
+    background?: ModelRef;
+    /** Image processing model - format: "providerId,modelId" */
+    image?: ModelRef;
+}
+/** Individual parameter with enable toggle */
+interface ModelParameter<T> {
+    enabled: boolean;
+    value: T;
+}
+/**
+ * Global model parameters configuration. Can be overridden by session-specific
+ * settings.
+ */
+interface GlobalModelParameters {
+    temperature?: ModelParameter<number>;
+    topP?: ModelParameter<number>;
+    maxTokens?: ModelParameter<number>;
+    defaultThinkingBudget?: ThinkLevel;
+    toolMaxTurns?: number;
+}
+/**
+ * Pre-defined provider template for quick setup. `provider-presets` extends
+ * this into `PresetProviderTemplate`.
+ */
+interface ProviderTemplate {
+    id: string;
+    name: string;
+    apiFormat?: ApiFormat;
+    /** @deprecated Use apiFormat instead */
+    chatApiFormat?: ChatApiFormat;
+    /** @deprecated Use apiFormat instead */
+    apiType?: ProviderApiType;
+    api_base_url: string;
+    models: string[];
+    modelConfigs?: ModelConfig[];
+    modelGroups?: ModelGroup[];
+    modelsEndpoint?: string;
+    transformer?: TransformerConfig;
+    description?: string;
+    icon?: string;
+    website?: string;
+    docsUrl?: string;
+    defaultSettings?: CompletionSettings;
+    isSystem?: boolean;
+    isOfficial?: boolean;
+    apiVersion?: string;
+    maxConcurrency?: number;
+}
+
+export { API_MODE_IDS as A, type ChatApiFormat as C, type GlobalModelParameters as G, type LLMProvider as L, type ModelConfig as M, type OpenRouterDataCollection as O, type PresetProviderTemplate as P, type SearchCapability as S, type TransformerConfig as T, type AgentDefaultModels as a, type ApiFormat as b, type ApiKeyEntry as c, type ApiMode as d, type ApiModeId as e, type CodingPlanConfig as f, type CompletionSettings as g, type ModelGroup as h, type ModelParameter as i, type ModelRef as j, type OpenRouterMaxPrice as k, type OpenRouterProviderRouting as l, type OpenRouterProviderSort as m, type OpenRouterQuantization as n, type ProviderApiType as o, type ProviderModelMapping as p, type ProviderSearchConfig as q, type ProviderTemplate as r, type TransformerEntry as s };