tekimax-ts 0.2.0 → 0.2.3

package/dist/tekimax-DJz-T9Vt.d.cts

@@ -0,0 +1,425 @@
+type MessageRole = 'system' | 'user' | 'assistant' | 'tool';
+interface ToolCall {
+    id: string;
+    type: 'function';
+    function: {
+        name: string;
+        arguments: string;
+    };
+}
+interface ToolDefinition {
+    type: 'function';
+    function: {
+        name: string;
+        description?: string;
+        parameters?: Record<string, unknown>;
+    };
+}
+interface Tool<T = any> extends ToolDefinition {
+    execute: (args: T) => Promise<unknown>;
+}
+interface GenerateTextResult {
+    text: string;
+    toolCalls: Array<ToolCall>;
+    toolResults: Array<{
+        id: string;
+        result: unknown;
+    }>;
+    finishReason: 'stop' | 'length' | 'tool_calls' | 'error' | 'unknown';
+    usage: {
+        promptTokens: number;
+        completionTokens: number;
+        totalTokens: number;
+    };
+    warnings?: Array<string>;
+}
+interface TextContentPart {
+    type: 'text';
+    text: string;
+}
+interface ImageContentPart {
+    type: 'image_url';
+    image_url: {
+        url: string;
+        detail?: 'auto' | 'low' | 'high';
+    };
+}
+type ContentPart = TextContentPart | ImageContentPart;
+interface Message {
+    role: MessageRole;
+    content: string | Array<ContentPart> | null;
+    thinking?: string;
+    toolCalls?: Array<ToolCall>;
+    toolCallId?: string;
+    name?: string;
+}
+interface ImageGenerationOptions {
+    prompt: string;
+    model?: string;
+    n?: number;
+    size?: string;
+    quality?: string;
+    style?: string;
+    response_format?: 'url' | 'b64_json';
+    user?: string;
+}
+interface ImageEditOptions extends ImageGenerationOptions {
+    image: string | Blob | Buffer;
+    mask?: string | Blob | Buffer;
+}
+interface ImageContent {
+    url?: string;
+    b64_json?: string;
+    revised_prompt?: string;
+}
+interface ImageResult {
+    created: number;
+    data: ImageContent[];
+}
+interface ImageAnalysisOptions {
+    image: string | Blob | Buffer;
+    prompt?: string;
+    model: string;
+    messages?: Array<Message>;
+}
+interface ImageAnalysisResult {
+    content: string;
+    usage?: {
+        inputTokens?: number;
+        outputTokens?: number;
+        totalTokens?: number;
+    };
+}
+interface SpeechGenerationOptions {
+    input: string;
+    model?: string;
+    voice: string;
+    response_format?: 'mp3' | 'opus' | 'aac' | 'flac' | 'wav' | 'pcm';
+    speed?: number;
+}
+interface SpeechResult {
+    buffer: ArrayBuffer;
+    headers?: Record<string, string>;
+}
+interface VideoGenerationOptions {
+    prompt: string;
+    model?: string;
+    aspect_ratio?: string;
+    duration_seconds?: number;
+}
+interface VideoContent {
+    url?: string;
+    b64_json?: string;
+}
+interface VideoResult {
+    data: VideoContent[];
+}
+interface VideoAnalysisOptions {
+    video: string | Blob | Buffer;
+    prompt?: string;
+    model: string;
+    messages?: Array<Message>;
+}
+interface VideoAnalysisResult {
+    content: string;
+    usage?: {
+        inputTokens?: number;
+        outputTokens?: number;
+        totalTokens?: number;
+    };
+}
+interface ChatOptions {
+    model: string;
+    messages: Array<Message>;
+    tools?: Array<ToolDefinition>;
+    temperature?: number;
+    maxTokens?: number;
+    stream?: boolean;
+    think?: boolean;
+    signal?: AbortSignal;
+    /** Force a specific response format. 'json_object' enables JSON mode. */
+    responseFormat?: {
+        type: 'json_object' | 'text';
+    };
+}
+interface ChatResult {
+    message: Message;
+    usage?: {
+        promptTokens: number;
+        completionTokens: number;
+        totalTokens: number;
+    };
+}
+interface StreamChunk {
+    delta: string;
+    thinking?: string;
+    toolCallDelta?: {
+        index: number;
+        id?: string;
+        type?: 'function';
+        function?: {
+            name?: string;
+            arguments?: string;
+        };
+    };
+    usage?: {
+        promptTokens: number;
+        completionTokens: number;
+        totalTokens: number;
+    };
+}
+interface TranscriptionOptions {
+    file: File | Blob | Buffer;
+    model?: string;
+    language?: string;
+    prompt?: string;
+    response_format?: 'json' | 'text' | 'srt' | 'verbose_json' | 'vtt';
+    temperature?: number;
+}
+interface TranscriptionResult {
+    text: string;
+    language?: string;
+    duration?: number;
+    segments?: Array<{
+        start: number;
+        end: number;
+        text: string;
+    }>;
+}
+interface EmbeddingOptions {
+    /** The text(s) to embed. Pass a string for a single embedding or an array for batch. */
+    input: string | string[];
+    /** The embedding model to use (e.g., 'text-embedding-3-small'). */
+    model?: string;
+    /** Number of dimensions for the output embedding (supported by some models). */
+    dimensions?: number;
+}
+interface EmbeddingResult {
+    /** Array of embedding vectors — one per input string. */
+    embeddings: number[][];
+    /** Model used for the embeddings. */
+    model: string;
+    usage?: {
+        promptTokens: number;
+        totalTokens: number;
+    };
+}
+interface ModelLimit {
+    /** Maximum context window size in tokens */
+    context: number;
+    /** Maximum output tokens */
+    output: number;
+}
+interface ModelModalities {
+    input: Array<'text' | 'image' | 'audio' | 'video' | 'file'>;
+    output: Array<'text' | 'image' | 'audio' | 'video'>;
+}
+interface ModelCost {
+    /** Cost per 1M input tokens (USD) */
+    input?: number;
+    /** Cost per 1M output tokens (USD) */
+    output?: number;
+    /** Cost per 1M cached input tokens (USD) */
+    cache_read?: number;
+}
+/**
+ * OpenResponses-compliant reasoning configuration.
+ * Maps from `models.dev` boolean `reasoning` flag into
+ * the official `ReasoningEffortEnum` from openresponses/openresponses.
+ */
+interface OpenResponsesReasoningConfig {
+    effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh';
+    summary?: 'none' | 'terse' | 'verbose' | 'detailed';
+}
+/**
+ * A standardized model definition that fuses the `models.dev` catalog
+ * with the `openresponses.org` specification.
+ *
+ * This type is returned by providers that support catalog introspection
+ * (e.g., fetching from `https://models.dev/api.json`).
+ */
+interface ModelDefinition {
+    /** Unique model identifier (e.g. "gpt-4o", "glm-4.6") */
+    id: string;
+    /** Human-readable display name */
+    name: string;
+    /** Model architecture family (e.g. "gpt", "glm", "deepseek") */
+    family?: string;
+    /** Provider name (e.g. "OpenAI", "Ollama Cloud") */
+    provider?: string;
+    /** Whether the model supports file/image/audio attachments in input */
+    attachment: boolean;
+    /** Whether the model supports function/tool calling */
+    tool_call: boolean;
+    /** Whether the model supports structured JSON output */
+    structured_output?: boolean;
+    /**
+     * Reasoning capability.
+     * - `false`: No reasoning support.
+     * - `true`: Reasoning supported (default effort = "medium").
+     * - `OpenResponsesReasoningConfig`: Fine-grained reasoning control
+     *   per the official openresponses.org ReasoningEffortEnum.
+     */
+    reasoning: boolean | OpenResponsesReasoningConfig;
+    /** Supported input/output modalities */
+    modalities: ModelModalities;
+    /** Token limits */
+    limit: ModelLimit;
+    /** Pricing per 1M tokens */
+    cost?: ModelCost;
+}
+
+interface AIProvider {
+    name: string;
+    /**
+     * Send a chat completion request.
+     */
+    chat: (options: ChatOptions) => Promise<ChatResult>;
+    /**
+     * Stream a chat completion.
+     */
+    chatStream: (options: ChatOptions) => AsyncIterable<StreamChunk>;
+    /**
+     * Optional: Fetch the catalog of available models from this provider.
+     * Returns OpenResponses-compliant ModelDefinition objects fused with
+     * models.dev metadata (modalities, limits, reasoning flags).
+     */
+    getModels?: () => Promise<ModelDefinition[]>;
+}
+interface ImageGenerationCapability {
+    /**
+     * Generate an image.
+     */
+    generateImage: (options: ImageGenerationOptions) => Promise<ImageResult>;
+}
+interface ImageEditCapability {
+    /**
+     * Edit an image.
+     */
+    editImage: (options: ImageEditOptions) => Promise<ImageResult>;
+}
+interface VisionCapability {
+    /**
+     * Analyze an image (Vision).
+     */
+    analyzeImage: (options: ImageAnalysisOptions) => Promise<ImageAnalysisResult>;
+}
+interface SpeechGenerationCapability {
+    /**
+     * Generate speech from text (TTS).
+     */
+    generateSpeech: (options: SpeechGenerationOptions) => Promise<SpeechResult>;
+}
+interface TranscriptionCapability {
+    /**
+     * Transcribe audio to text (STT).
+     */
+    transcribeAudio: (options: TranscriptionOptions) => Promise<TranscriptionResult>;
+}
+interface VideoGenerationCapability {
+    /**
+     * Generate a video.
+     */
+    generateVideo: (options: VideoGenerationOptions) => Promise<VideoResult>;
+}
+interface VideoAnalysisCapability {
+    /**
+     * Analyze a video (Video-to-Text).
+     */
+    analyzeVideo: (options: VideoAnalysisOptions) => Promise<VideoAnalysisResult>;
+}
+interface EmbeddingCapability {
+    /**
+     * Generate embeddings for text input(s).
+     */
+    embed: (options: EmbeddingOptions) => Promise<EmbeddingResult>;
+}
+
+declare class TextNamespace<TProvider extends AIProvider> {
+    private provider;
+    constructor(provider: TProvider);
+    /**
+     * Generate text from a prompt (Chat Completion).
+     */
+    generate(options: ChatOptions): Promise<ChatResult>;
+    /**
+     * Stream text generation.
+     */
+    generateStream(options: ChatOptions): AsyncGenerator<StreamChunk>;
+    /**
+     * Generate embeddings for text input(s). Only available if the provider supports embeddings.
+     */
+    embed(options: TProvider extends EmbeddingCapability ? EmbeddingOptions : never): Promise<TProvider extends EmbeddingCapability ? EmbeddingResult : never>;
+    get chat(): {
+        completions: {
+            create: (options: ChatOptions) => Promise<ChatResult>;
+            createStream: (options: ChatOptions) => AsyncGenerator<StreamChunk, any, any>;
+        };
+    };
+}
+
+declare class ImagesNamespace<TProvider extends AIProvider> {
+    private provider;
+    constructor(provider: TProvider);
+    /**
+     * Generate images from a prompt. Only available if the provider supports image generation.
+     */
+    generate(options: TProvider extends ImageGenerationCapability ? ImageGenerationOptions : never): Promise<TProvider extends ImageGenerationCapability ? ImageResult : never>;
+    /**
+     * Edit an image with a prompt. Only available if the provider supports image editing.
+     */
+    edit(options: TProvider extends ImageEditCapability ? ImageEditOptions : never): Promise<TProvider extends ImageEditCapability ? ImageResult : never>;
+    /**
+     * Analyze an image (Vision). Only available if the provider supports vision analytics.
+     */
+    analyze(options: TProvider extends VisionCapability ? ImageAnalysisOptions : never): Promise<TProvider extends VisionCapability ? ImageAnalysisResult : never>;
+}
+
+declare class AudioNamespace<TProvider extends AIProvider> {
+    private provider;
+    constructor(provider: TProvider);
+    /**
+     * Convert text to speech. Only available if the provider supports TTS.
+     */
+    speak(options: TProvider extends SpeechGenerationCapability ? SpeechGenerationOptions : never): Promise<TProvider extends SpeechGenerationCapability ? SpeechResult : never>;
+    /**
+     * Transcribe audio to text. Only available if the provider supports STT.
+     */
+    transcribe(options: TProvider extends TranscriptionCapability ? TranscriptionOptions : never): Promise<TProvider extends TranscriptionCapability ? TranscriptionResult : never>;
+}
+
+declare class VideosNamespace<TProvider extends AIProvider> {
+    private provider;
+    constructor(provider: TProvider);
+    /**
+     * Generate a video from a prompt. Only available if the provider supports video generation.
+     */
+    generate(options: TProvider extends VideoGenerationCapability ? VideoGenerationOptions : never): Promise<TProvider extends VideoGenerationCapability ? VideoResult : never>;
+    /**
+     * Analyze a video (Video-to-Text). Only available if the provider supports video analysis.
+     */
+    analyze(options: TProvider extends VideoAnalysisCapability ? VideoAnalysisOptions : never): Promise<TProvider extends VideoAnalysisCapability ? VideoAnalysisResult : never>;
+}
+
+interface TekimaxOptions<TProvider extends AIProvider> {
+    provider: TProvider;
+}
+declare class Tekimax<TProvider extends AIProvider> {
+    private provider;
+    text: TextNamespace<TProvider>;
+    images: ImagesNamespace<TProvider>;
+    audio: AudioNamespace<TProvider>;
+    videos: VideosNamespace<TProvider>;
+    constructor(options: TekimaxOptions<TProvider>);
+    /**
+     * @deprecated Use client.text.chat instead. Kept for backward compatibility.
+     */
+    get chat(): {
+        completions: {
+            create: (options: ChatOptions) => Promise<ChatResult>;
+            createStream: (options: ChatOptions) => AsyncGenerator<StreamChunk, any, any>;
+        };
+    };
+}
+
+export { type AIProvider as A, Tekimax as B, type ChatOptions as C, type TekimaxOptions as D, type EmbeddingCapability as E, type TextContentPart as F, type GenerateTextResult as G, type ToolCall as H, type ImageAnalysisOptions as I, type ToolDefinition as J, type VideoContent as K, type VideoGenerationCapability as L, type Message as M, type VideoGenerationOptions as N, type OpenResponsesReasoningConfig as O, type VideoResult as P, type StreamChunk as S, type Tool as T, type VisionCapability as V, type ChatResult as a, type ImageAnalysisResult as b, type VideoAnalysisCapability as c, type VideoAnalysisOptions as d, type VideoAnalysisResult as e, type EmbeddingOptions as f, type EmbeddingResult as g, type SpeechGenerationCapability as h, type ImageGenerationCapability as i, type ImageEditCapability as j, type TranscriptionCapability as k, type SpeechGenerationOptions as l, type SpeechResult as m, type ImageGenerationOptions as n, type ImageResult as o, type TranscriptionOptions as p, type TranscriptionResult as q, type ImageEditOptions as r, type ContentPart as s, type ImageContent as t, type ImageContentPart as u, type MessageRole as v, type ModelCost as w, type ModelDefinition as x, type ModelLimit as y, type ModelModalities as z };