ai.matey.types 0.2.0

package/dist/types/model-translation.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Model Translation Types
+ *
+ * Type definitions for model name translation between AI providers.
+ *
+ * @module
+ */
+/**
+ * Model name mapping (source model → target model).
+ */
+export type ModelMapping = Record<string, string>;
+/**
+ * Translation strategy for Router fallback.
+ */
+export type ModelTranslationStrategy = 'exact' | 'pattern' | 'hybrid' | 'none';
+/**
+ * Configuration for model translation behavior.
+ */
+export interface ModelTranslationConfig {
+    /**
+     * Translation strategy to use.
+     * @default 'hybrid'
+     */
+    readonly strategy: ModelTranslationStrategy;
+    /**
+     * Emit warning event when using backend default model.
+     * @default true
+     */
+    readonly warnOnDefault?: boolean;
+    /**
+     * Throw error if no translation found (instead of returning original).
+     * @default false
+     */
+    readonly strictMode?: boolean;
+}
+/**
+ * Options for translateModel function.
+ */
+export interface ModelTranslationOptions {
+    /**
+     * Exact model mappings.
+     */
+    readonly mapping?: ModelMapping;
+    /**
+     * Backend default model (used in hybrid strategy).
+     */
+    readonly defaultModel?: string;
+    /**
+     * Translation strategy.
+     * @default 'exact'
+     */
+    readonly strategy?: ModelTranslationStrategy;
+    /**
+     * Throw error if no translation found.
+     * @default false
+     */
+    readonly strictMode?: boolean;
+}
+/**
+ * Result of model translation.
+ */
+export interface TranslationResult {
+    /**
+     * Translated model name.
+     */
+    readonly translated: string;
+    /**
+     * Source of translation.
+     */
+    readonly source: 'exact' | 'pattern' | 'default' | 'none';
+    /**
+     * Whether a translation was applied.
+     */
+    readonly wasTranslated: boolean;
+}
+//# sourceMappingURL=model-translation.d.ts.map

package/dist/types/model-translation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-translation.d.ts","sourceRoot":"","sources":["../../src/model-translation.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAChC,OAAO,GACP,SAAS,GACT,QAAQ,GACR,MAAM,CAAC;AAEX;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,wBAAwB,CAAC;IAE5C;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IAEjC;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IAE7C;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;IAE1D;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;CACjC"}

package/dist/types/models.d.ts

@@ -0,0 +1,160 @@
+/**
+ * Model Types
+ *
+ * Types for representing AI models and model listing functionality.
+ * Backend adapters can expose available models through the listModels() method.
+ *
+ * @module
+ */
+/**
+ * Represents an AI model available from a provider.
+ *
+ * This type provides a unified representation of models across different
+ * providers, including metadata about capabilities and pricing.
+ */
+export interface AIModel {
+    /**
+     * Unique model identifier (e.g., "gpt-4", "claude-3-opus-20240229").
+     * This is the ID used in API requests.
+     */
+    readonly id: string;
+    /**
+     * Human-readable model name.
+     * May be more descriptive than the ID.
+     */
+    readonly name: string;
+    /**
+     * Model description explaining its purpose or characteristics.
+     */
+    readonly description?: string;
+    /**
+     * When this model was created (ISO 8601 timestamp).
+     */
+    readonly created?: string;
+    /**
+     * Who owns/created this model (e.g., "openai", "anthropic").
+     */
+    readonly ownedBy?: string;
+    /**
+     * Model capabilities for filtering and discovery.
+     */
+    readonly capabilities?: ModelCapabilities;
+    /**
+     * Provider-specific metadata not covered by standard fields.
+     */
+    readonly metadata?: Record<string, unknown>;
+}
+/**
+ * Capabilities of a specific model.
+ *
+ * Used for filtering models by feature support and understanding
+ * what the model can do.
+ */
+export interface ModelCapabilities {
+    /**
+     * Maximum output tokens the model can generate.
+     */
+    readonly maxTokens?: number;
+    /**
+     * Total context window size (input + output).
+     */
+    readonly contextWindow?: number;
+    /**
+     * Whether the model supports streaming responses.
+     */
+    readonly supportsStreaming?: boolean;
+    /**
+     * Whether the model supports vision/image inputs.
+     */
+    readonly supportsVision?: boolean;
+    /**
+     * Whether the model supports function/tool calling.
+     */
+    readonly supportsTools?: boolean;
+    /**
+     * Whether the model supports JSON mode for structured outputs.
+     */
+    readonly supportsJSON?: boolean;
+    /**
+     * Estimated cost per 1,000 tokens (in USD).
+     * Used for cost-based optimization and routing.
+     */
+    readonly pricing?: {
+        readonly input: number;
+        readonly output: number;
+    };
+    /**
+     * Estimated latency in milliseconds for typical requests.
+     * Used for speed-based optimization.
+     */
+    readonly latency?: {
+        readonly p50?: number;
+        readonly p95?: number;
+    };
+    /**
+     * Quality score from 0-100.
+     * Higher scores indicate better output quality.
+     * Can be user-defined or community-rated.
+     */
+    readonly qualityScore?: number;
+    /**
+     * Model family identifier (e.g., "gpt-4", "claude-3", "gemini-1.5").
+     * Used for capability inference and similarity matching.
+     */
+    readonly modelFamily?: string;
+    /**
+     * Model release date (ISO 8601 format).
+     * Used for determining model recency.
+     */
+    readonly releaseDate?: string;
+}
+/**
+ * Options for listing models from a backend.
+ */
+export interface ListModelsOptions {
+    /**
+     * Force refresh from remote source (bypass cache).
+     * @default false
+     */
+    readonly forceRefresh?: boolean;
+    /**
+     * Filter models by capability requirements.
+     * Only models matching ALL specified capabilities will be returned.
+     */
+    readonly filter?: {
+        readonly supportsStreaming?: boolean;
+        readonly supportsVision?: boolean;
+        readonly supportsTools?: boolean;
+        readonly supportsJSON?: boolean;
+    };
+}
+/**
+ * Result of listing models from a backend.
+ *
+ * Includes the models plus metadata about where they came from
+ * and when they were fetched.
+ */
+export interface ListModelsResult {
+    /**
+     * Available models from this backend.
+     */
+    readonly models: readonly AIModel[];
+    /**
+     * Source of the model list.
+     * - remote: Fetched from provider API
+     * - static: From configuration or hardcoded list
+     * - cache: From cached previous fetch
+     */
+    readonly source: 'remote' | 'static' | 'cache';
+    /**
+     * Timestamp when this list was fetched (Unix milliseconds).
+     * Used for cache invalidation.
+     */
+    readonly fetchedAt: number;
+    /**
+     * Whether this list is complete or partial.
+     * Partial lists may occur with filters or pagination.
+     */
+    readonly isComplete: boolean;
+}
+//# sourceMappingURL=models.d.ts.map

package/dist/types/models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAMH;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,iBAAiB,CAAC;IAE1C;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC7C;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAEhC;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE;QACjB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;KACzB,CAAC;IAEF;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE;QACjB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;IAEF;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAMD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAEhC;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE;QAChB,QAAQ,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC;QACrC,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;QAClC,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;QACjC,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;KACjC,CAAC;CACH;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,SAAS,OAAO,EAAE,CAAC;IAEpC;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAC;IAE/C;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;CAC9B"}