@compilr-dev/sdk 0.1.0

package/dist/models/model-registry.d.ts

@@ -0,0 +1,118 @@
+/**
+ * Model Registry
+ *
+ * Defines supported models with metadata for each provider.
+ * Used for:
+ * - Model selection UI (list instead of free text)
+ * - Session restore strategy (based on thinking format)
+ * - Status indicators and warnings
+ * - Context window resolution
+ */
+import type { ProviderType } from '../config.js';
+import type { ModelTier } from './types.js';
+/**
+ * Thinking block format used by the model.
+ * Used to determine session restore strategy.
+ */
+export type ThinkingFormat = 'claude' | 'gemini-v2' | 'gemini-v3' | 'openai' | 'none';
+/**
+ * Support status for a model.
+ */
+export type ModelStatus = 'supported' | 'experimental' | 'unsupported';
+/**
+ * Model information for the registry.
+ */
+export interface ModelInfo {
+    /** Model ID as used in API calls */
+    id: string;
+    /** Display name for UI */
+    displayName: string;
+    /** Short description for UI (e.g., "Fast, low cost", "Balanced (recommended)") */
+    description: string;
+    /** Provider this model belongs to */
+    provider: ProviderType;
+    /** Default tier mapping (fast/balanced/powerful) - undefined if not a default */
+    defaultTier?: ModelTier;
+    /** Thinking block format this model uses */
+    thinkingFormat: ThinkingFormat;
+    /** Support status */
+    status: ModelStatus;
+    /** Notes shown in UI (e.g., why unsupported) */
+    notes?: string;
+    /** Context window size in tokens (for display) */
+    contextWindow?: number;
+}
+/**
+ * Registry of known models with their metadata.
+ * Models are grouped by provider for easier maintenance.
+ */
+export declare const MODEL_REGISTRY: ModelInfo[];
+/**
+ * Get all models for a specific provider.
+ */
+export declare function getModelsForProvider(provider: ProviderType): ModelInfo[];
+/**
+ * Get models for a provider, sorted for display.
+ * Order: supported first, then by defaultTier (fast->balanced->powerful), then alphabetical.
+ */
+export declare function getModelsSortedForDisplay(provider: ProviderType): ModelInfo[];
+/**
+ * Get model info by ID.
+ * Returns undefined for unknown models.
+ */
+export declare function getModelInfo(modelId: string): ModelInfo | undefined;
+/**
+ * Check if a model is in the registry.
+ */
+export declare function isKnownModel(modelId: string): boolean;
+/**
+ * Check if a model is supported.
+ * Returns false for unknown models (conservative default).
+ */
+export declare function isModelSupported(modelId: string): boolean;
+/**
+ * Get the thinking format for a model.
+ * Returns 'none' for unknown models (safe default).
+ */
+export declare function getThinkingFormat(modelId: string): ThinkingFormat;
+/**
+ * Get status indicator for UI display.
+ */
+export declare function getStatusIndicator(status: ModelStatus): string;
+/**
+ * Get status label for UI display.
+ */
+export declare function getStatusLabel(status: ModelStatus): string;
+/**
+ * Get the default model for a tier from the registry.
+ * Returns the first model with that defaultTier, or undefined if none.
+ */
+export declare function getDefaultModelForTier(provider: ProviderType, tier: ModelTier): ModelInfo | undefined;
+/**
+ * Check if two models have compatible thinking formats for session restore.
+ * Compatible means we can restore without clearing history.
+ */
+export declare function areThinkingFormatsCompatible(fromModelId: string | undefined, toModelId: string): boolean;
+/**
+ * Determine if session history should be cleared when switching models.
+ * Returns true if history must be cleared (incompatible), false if we can keep/strip.
+ *
+ * Note: Gemini v3 no longer requires clearing history since Session 119.
+ * The native @google/genai SDK handles thought signatures automatically.
+ */
+export declare function shouldClearHistoryOnModelChange(_fromModelId: string | undefined, _toModelId: string): boolean;
+/**
+ * Get context window size for a model ID.
+ * Falls back to provider default if model not found or contextWindow not set.
+ */
+export declare function getModelContextWindow(modelId: string, provider?: ProviderType): number;
+/**
+ * Get model display name by ID.
+ * Returns the model ID if not found in registry.
+ */
+export declare function getModelDisplayName(modelId: string): string;
+/**
+ * Get model description by ID.
+ * Returns empty string if not found.
+ */
+export declare function getModelDescription(modelId: string): string;