@yourgpt/llm-sdk 0.1.0 → 0.1.1

package/dist/types-CdORv1Yu.d.mts

@@ -0,0 +1,338 @@
+import { z } from 'zod';
+
+/**
+ * Core Types for @yourgpt/llm-sdk
+ *
+ * Modern, instance-based types following Vercel AI SDK patterns.
+ */
+
+/**
+ * A language model instance that can generate text.
+ * This is what provider functions like `openai('gpt-4o')` return.
+ */
+interface LanguageModel {
+    /** Provider identifier (e.g., 'openai', 'anthropic') */
+    readonly provider: string;
+    /** Model identifier (e.g., 'gpt-4o', 'claude-3-5-sonnet') */
+    readonly modelId: string;
+    /** Model capabilities for feature detection */
+    readonly capabilities: ModelCapabilities;
+    /**
+     * Generate a complete response (non-streaming)
+     * Used internally by generateText()
+     */
+    doGenerate(params: DoGenerateParams): Promise<DoGenerateResult>;
+    /**
+     * Stream a response
+     * Used internally by streamText()
+     */
+    doStream(params: DoGenerateParams): AsyncGenerator<StreamChunk>;
+}
+/**
+ * Model capabilities for UI feature flags
+ */
+interface ModelCapabilities {
+    /** Supports image inputs */
+    supportsVision: boolean;
+    /** Supports tool/function calling */
+    supportsTools: boolean;
+    /** Supports streaming responses */
+    supportsStreaming: boolean;
+    /** Supports JSON mode / structured output */
+    supportsJsonMode: boolean;
+    /** Supports extended thinking (Claude) */
+    supportsThinking: boolean;
+    /** Supports PDF document inputs */
+    supportsPDF: boolean;
+    /** Maximum context tokens */
+    maxTokens: number;
+    /** Supported image MIME types */
+    supportedImageTypes: string[];
+}
+/**
+ * Default capabilities for unknown models
+ */
+declare const DEFAULT_CAPABILITIES: ModelCapabilities;
+/**
+ * Core message types for LLM conversations
+ */
+type CoreMessage = SystemMessage | UserMessage | AssistantMessage | ToolMessage;
+interface SystemMessage {
+    role: "system";
+    content: string;
+}
+interface UserMessage {
+    role: "user";
+    content: string | UserContentPart[];
+}
+interface AssistantMessage {
+    role: "assistant";
+    content: string | null;
+    toolCalls?: ToolCall[];
+}
+interface ToolMessage {
+    role: "tool";
+    toolCallId: string;
+    content: string;
+}
+/**
+ * Content parts for multimodal user messages
+ */
+type UserContentPart = TextPart | ImagePart | FilePart;
+interface TextPart {
+    type: "text";
+    text: string;
+}
+interface ImagePart {
+    type: "image";
+    /** Base64 data or URL */
+    image: string | Uint8Array;
+    /** MIME type (e.g., 'image/png') */
+    mimeType?: string;
+}
+interface FilePart {
+    type: "file";
+    /** Base64 data or URL */
+    data: string;
+    /** MIME type (e.g., 'application/pdf') */
+    mimeType: string;
+}
+/**
+ * Tool definition with Zod schema support
+ */
+interface Tool<TParams = unknown, TResult = unknown> {
+    /** Tool description for the LLM */
+    description: string;
+    /** Zod schema for parameters */
+    parameters: z.ZodType<TParams>;
+    /** Execute function */
+    execute: (params: TParams, context: ToolContext) => Promise<TResult>;
+}
+/**
+ * Context passed to tool execute function
+ */
+interface ToolContext {
+    /** Abort signal for cancellation */
+    abortSignal?: AbortSignal;
+    /** Unique tool call ID */
+    toolCallId: string;
+    /** Optional: messages in conversation */
+    messages?: CoreMessage[];
+}
+/**
+ * Tool call from LLM response
+ */
+interface ToolCall {
+    /** Unique ID for this tool call */
+    id: string;
+    /** Tool name */
+    name: string;
+    /** Parsed arguments */
+    args: Record<string, unknown>;
+}
+/**
+ * Tool execution result
+ */
+interface ToolResult {
+    /** Tool call ID this result corresponds to */
+    toolCallId: string;
+    /** Result data (will be JSON stringified for LLM) */
+    result: unknown;
+}
+/**
+ * Parameters for model.doGenerate() and model.doStream()
+ */
+interface DoGenerateParams {
+    /** Messages to send to LLM */
+    messages: CoreMessage[];
+    /** Tools available to the LLM (already formatted for provider) */
+    tools?: unknown[];
+    /** Temperature (0-2) */
+    temperature?: number;
+    /** Maximum tokens to generate */
+    maxTokens?: number;
+    /** Abort signal */
+    signal?: AbortSignal;
+}
+/**
+ * Result from model.doGenerate()
+ */
+interface DoGenerateResult {
+    /** Generated text content */
+    text: string;
+    /** Tool calls requested by the LLM */
+    toolCalls: ToolCall[];
+    /** Why generation stopped */
+    finishReason: FinishReason;
+    /** Token usage */
+    usage: TokenUsage;
+    /** Raw provider response (for debugging) */
+    rawResponse?: unknown;
+}
+/**
+ * Finish reason for generation
+ */
+type FinishReason = "stop" | "length" | "tool-calls" | "content-filter" | "error" | "unknown";
+/**
+ * Token usage statistics
+ */
+interface TokenUsage {
+    promptTokens: number;
+    completionTokens: number;
+    totalTokens: number;
+}
+/**
+ * Stream chunk from model.doStream()
+ */
+type StreamChunk = TextDeltaChunk | ToolCallChunk | ToolResultChunk | FinishChunk | ErrorChunk;
+interface TextDeltaChunk {
+    type: "text-delta";
+    text: string;
+}
+interface ToolCallChunk {
+    type: "tool-call";
+    toolCall: ToolCall;
+}
+interface ToolResultChunk {
+    type: "tool-result";
+    toolCallId: string;
+    result: unknown;
+}
+interface FinishChunk {
+    type: "finish";
+    finishReason: FinishReason;
+    usage?: TokenUsage;
+}
+interface ErrorChunk {
+    type: "error";
+    error: Error;
+}
+/**
+ * Parameters for generateText()
+ */
+interface GenerateTextParams {
+    /** Language model to use */
+    model: LanguageModel;
+    /** Simple prompt (converted to user message) */
+    prompt?: string;
+    /** System prompt */
+    system?: string;
+    /** Full message history */
+    messages?: CoreMessage[];
+    /** Tools available to the LLM */
+    tools?: Record<string, Tool>;
+    /** Maximum agentic steps (tool call loops) */
+    maxSteps?: number;
+    /** Temperature (0-2) */
+    temperature?: number;
+    /** Maximum tokens to generate */
+    maxTokens?: number;
+    /** Abort signal */
+    signal?: AbortSignal;
+}
+/**
+ * Result from generateText()
+ */
+interface GenerateTextResult {
+    /** Final text output */
+    text: string;
+    /** Token usage */
+    usage: TokenUsage;
+    /** Why generation stopped */
+    finishReason: FinishReason;
+    /** All steps taken (for agentic workflows) */
+    steps: GenerateStep[];
+    /** All tool calls made across all steps */
+    toolCalls: ToolCall[];
+    /** All tool results across all steps */
+    toolResults: ToolResult[];
+    /** Final message list including tool interactions */
+    response: {
+        messages: CoreMessage[];
+    };
+}
+/**
+ * A single step in the generation process
+ */
+interface GenerateStep {
+    /** Text generated in this step */
+    text: string;
+    /** Tool calls made in this step */
+    toolCalls: ToolCall[];
+    /** Tool results from this step */
+    toolResults: ToolResult[];
+    /** Finish reason for this step */
+    finishReason: FinishReason;
+    /** Token usage for this step */
+    usage: TokenUsage;
+}
+/**
+ * Parameters for streamText() - same as generateText
+ */
+type StreamTextParams = GenerateTextParams;
+/**
+ * Result from streamText()
+ */
+interface StreamTextResult {
+    /** Async iterable of text chunks only */
+    textStream: AsyncIterable<string>;
+    /** Async iterable of all stream parts */
+    fullStream: AsyncIterable<StreamPart>;
+    /** Promise that resolves to full text when complete */
+    readonly text: Promise<string>;
+    /** Promise that resolves to usage when complete */
+    readonly usage: Promise<TokenUsage>;
+    /** Promise that resolves to finish reason when complete */
+    readonly finishReason: Promise<FinishReason>;
+    /** Convert to plain text streaming Response */
+    toTextStreamResponse(options?: ResponseOptions): Response;
+    /** Convert to data stream Response (SSE with tool calls) */
+    toDataStreamResponse(options?: ResponseOptions): Response;
+}
+/**
+ * Stream part for fullStream
+ */
+type StreamPart = {
+    type: "text-delta";
+    text: string;
+} | {
+    type: "tool-call-start";
+    toolCallId: string;
+    toolName: string;
+} | {
+    type: "tool-call-delta";
+    toolCallId: string;
+    argsText: string;
+} | {
+    type: "tool-call-complete";
+    toolCall: ToolCall;
+} | {
+    type: "tool-result";
+    toolCallId: string;
+    result: unknown;
+} | {
+    type: "step-start";
+    step: number;
+} | {
+    type: "step-finish";
+    step: number;
+    finishReason: FinishReason;
+} | {
+    type: "finish";
+    finishReason: FinishReason;
+    usage: TokenUsage;
+} | {
+    type: "error";
+    error: Error;
+};
+/**
+ * Options for Response helpers
+ */
+interface ResponseOptions {
+    /** Additional headers */
+    headers?: Record<string, string>;
+    /** Response status (default: 200) */
+    status?: number;
+}
+
+export { type AssistantMessage as A, type CoreMessage as C, type DoGenerateParams as D, type ErrorChunk as E, type FilePart as F, type GenerateTextParams as G, type ImagePart as I, type LanguageModel as L, type ModelCapabilities as M, type ResponseOptions as R, type StreamTextParams as S, type ToolContext as T, type UserMessage as U, type GenerateTextResult as a, type StreamTextResult as b, type Tool as c, type DoGenerateResult as d, type SystemMessage as e, type ToolMessage as f, type UserContentPart as g, type TextPart as h, type ToolCall as i, type ToolResult as j, type GenerateStep as k, type StreamPart as l, type StreamChunk as m, type TextDeltaChunk as n, type ToolCallChunk as o, type ToolResultChunk as p, type FinishChunk as q, type TokenUsage as r, type FinishReason as s, DEFAULT_CAPABILITIES as t };

package/dist/types-CdORv1Yu.d.ts

@@ -0,0 +1,338 @@
+import { z } from 'zod';
+
+/**
+ * Core Types for @yourgpt/llm-sdk
+ *
+ * Modern, instance-based types following Vercel AI SDK patterns.
+ */
+
+/**
+ * A language model instance that can generate text.
+ * This is what provider functions like `openai('gpt-4o')` return.
+ */
+interface LanguageModel {
+    /** Provider identifier (e.g., 'openai', 'anthropic') */
+    readonly provider: string;
+    /** Model identifier (e.g., 'gpt-4o', 'claude-3-5-sonnet') */
+    readonly modelId: string;
+    /** Model capabilities for feature detection */
+    readonly capabilities: ModelCapabilities;
+    /**
+     * Generate a complete response (non-streaming)
+     * Used internally by generateText()
+     */
+    doGenerate(params: DoGenerateParams): Promise<DoGenerateResult>;
+    /**
+     * Stream a response
+     * Used internally by streamText()
+     */
+    doStream(params: DoGenerateParams): AsyncGenerator<StreamChunk>;
+}
+/**
+ * Model capabilities for UI feature flags
+ */
+interface ModelCapabilities {
+    /** Supports image inputs */
+    supportsVision: boolean;
+    /** Supports tool/function calling */
+    supportsTools: boolean;
+    /** Supports streaming responses */
+    supportsStreaming: boolean;
+    /** Supports JSON mode / structured output */
+    supportsJsonMode: boolean;
+    /** Supports extended thinking (Claude) */
+    supportsThinking: boolean;
+    /** Supports PDF document inputs */
+    supportsPDF: boolean;
+    /** Maximum context tokens */
+    maxTokens: number;
+    /** Supported image MIME types */
+    supportedImageTypes: string[];
+}
+/**
+ * Default capabilities for unknown models
+ */
+declare const DEFAULT_CAPABILITIES: ModelCapabilities;
+/**
+ * Core message types for LLM conversations
+ */
+type CoreMessage = SystemMessage | UserMessage | AssistantMessage | ToolMessage;
+interface SystemMessage {
+    role: "system";
+    content: string;
+}
+interface UserMessage {
+    role: "user";
+    content: string | UserContentPart[];
+}
+interface AssistantMessage {
+    role: "assistant";
+    content: string | null;
+    toolCalls?: ToolCall[];
+}
+interface ToolMessage {
+    role: "tool";
+    toolCallId: string;
+    content: string;
+}
+/**
+ * Content parts for multimodal user messages
+ */
+type UserContentPart = TextPart | ImagePart | FilePart;
+interface TextPart {
+    type: "text";
+    text: string;
+}
+interface ImagePart {
+    type: "image";
+    /** Base64 data or URL */
+    image: string | Uint8Array;
+    /** MIME type (e.g., 'image/png') */
+    mimeType?: string;
+}
+interface FilePart {
+    type: "file";
+    /** Base64 data or URL */
+    data: string;
+    /** MIME type (e.g., 'application/pdf') */
+    mimeType: string;
+}
+/**
+ * Tool definition with Zod schema support
+ */
+interface Tool<TParams = unknown, TResult = unknown> {
+    /** Tool description for the LLM */
+    description: string;
+    /** Zod schema for parameters */
+    parameters: z.ZodType<TParams>;
+    /** Execute function */
+    execute: (params: TParams, context: ToolContext) => Promise<TResult>;
+}
+/**
+ * Context passed to tool execute function
+ */
+interface ToolContext {
+    /** Abort signal for cancellation */
+    abortSignal?: AbortSignal;
+    /** Unique tool call ID */
+    toolCallId: string;
+    /** Optional: messages in conversation */
+    messages?: CoreMessage[];
+}
+/**
+ * Tool call from LLM response
+ */
+interface ToolCall {
+    /** Unique ID for this tool call */
+    id: string;
+    /** Tool name */
+    name: string;
+    /** Parsed arguments */
+    args: Record<string, unknown>;
+}
+/**
+ * Tool execution result
+ */
+interface ToolResult {
+    /** Tool call ID this result corresponds to */
+    toolCallId: string;
+    /** Result data (will be JSON stringified for LLM) */
+    result: unknown;
+}
+/**
+ * Parameters for model.doGenerate() and model.doStream()
+ */
+interface DoGenerateParams {
+    /** Messages to send to LLM */
+    messages: CoreMessage[];
+    /** Tools available to the LLM (already formatted for provider) */
+    tools?: unknown[];
+    /** Temperature (0-2) */
+    temperature?: number;
+    /** Maximum tokens to generate */
+    maxTokens?: number;
+    /** Abort signal */
+    signal?: AbortSignal;
+}
+/**
+ * Result from model.doGenerate()
+ */
+interface DoGenerateResult {
+    /** Generated text content */
+    text: string;
+    /** Tool calls requested by the LLM */
+    toolCalls: ToolCall[];
+    /** Why generation stopped */
+    finishReason: FinishReason;
+    /** Token usage */
+    usage: TokenUsage;
+    /** Raw provider response (for debugging) */
+    rawResponse?: unknown;
+}
+/**
+ * Finish reason for generation
+ */
+type FinishReason = "stop" | "length" | "tool-calls" | "content-filter" | "error" | "unknown";
+/**
+ * Token usage statistics
+ */
+interface TokenUsage {
+    promptTokens: number;
+    completionTokens: number;
+    totalTokens: number;
+}
+/**
+ * Stream chunk from model.doStream()
+ */
+type StreamChunk = TextDeltaChunk | ToolCallChunk | ToolResultChunk | FinishChunk | ErrorChunk;
+interface TextDeltaChunk {
+    type: "text-delta";
+    text: string;
+}
+interface ToolCallChunk {
+    type: "tool-call";
+    toolCall: ToolCall;
+}
+interface ToolResultChunk {
+    type: "tool-result";
+    toolCallId: string;
+    result: unknown;
+}
+interface FinishChunk {
+    type: "finish";
+    finishReason: FinishReason;
+    usage?: TokenUsage;
+}
+interface ErrorChunk {
+    type: "error";
+    error: Error;
+}
+/**
+ * Parameters for generateText()
+ */
+interface GenerateTextParams {
+    /** Language model to use */
+    model: LanguageModel;
+    /** Simple prompt (converted to user message) */
+    prompt?: string;
+    /** System prompt */
+    system?: string;
+    /** Full message history */
+    messages?: CoreMessage[];
+    /** Tools available to the LLM */
+    tools?: Record<string, Tool>;
+    /** Maximum agentic steps (tool call loops) */
+    maxSteps?: number;
+    /** Temperature (0-2) */
+    temperature?: number;
+    /** Maximum tokens to generate */
+    maxTokens?: number;
+    /** Abort signal */
+    signal?: AbortSignal;
+}
+/**
+ * Result from generateText()
+ */
+interface GenerateTextResult {
+    /** Final text output */
+    text: string;
+    /** Token usage */
+    usage: TokenUsage;
+    /** Why generation stopped */
+    finishReason: FinishReason;
+    /** All steps taken (for agentic workflows) */
+    steps: GenerateStep[];
+    /** All tool calls made across all steps */
+    toolCalls: ToolCall[];
+    /** All tool results across all steps */
+    toolResults: ToolResult[];
+    /** Final message list including tool interactions */
+    response: {
+        messages: CoreMessage[];
+    };
+}
+/**
+ * A single step in the generation process
+ */
+interface GenerateStep {
+    /** Text generated in this step */
+    text: string;
+    /** Tool calls made in this step */
+    toolCalls: ToolCall[];
+    /** Tool results from this step */
+    toolResults: ToolResult[];
+    /** Finish reason for this step */
+    finishReason: FinishReason;
+    /** Token usage for this step */
+    usage: TokenUsage;
+}
+/**
+ * Parameters for streamText() - same as generateText
+ */
+type StreamTextParams = GenerateTextParams;
+/**
+ * Result from streamText()
+ */
+interface StreamTextResult {
+    /** Async iterable of text chunks only */
+    textStream: AsyncIterable<string>;
+    /** Async iterable of all stream parts */
+    fullStream: AsyncIterable<StreamPart>;
+    /** Promise that resolves to full text when complete */
+    readonly text: Promise<string>;
+    /** Promise that resolves to usage when complete */
+    readonly usage: Promise<TokenUsage>;
+    /** Promise that resolves to finish reason when complete */
+    readonly finishReason: Promise<FinishReason>;
+    /** Convert to plain text streaming Response */
+    toTextStreamResponse(options?: ResponseOptions): Response;
+    /** Convert to data stream Response (SSE with tool calls) */
+    toDataStreamResponse(options?: ResponseOptions): Response;
+}
+/**
+ * Stream part for fullStream
+ */
+type StreamPart = {
+    type: "text-delta";
+    text: string;
+} | {
+    type: "tool-call-start";
+    toolCallId: string;
+    toolName: string;
+} | {
+    type: "tool-call-delta";
+    toolCallId: string;
+    argsText: string;
+} | {
+    type: "tool-call-complete";
+    toolCall: ToolCall;
+} | {
+    type: "tool-result";
+    toolCallId: string;
+    result: unknown;
+} | {
+    type: "step-start";
+    step: number;
+} | {
+    type: "step-finish";
+    step: number;
+    finishReason: FinishReason;
+} | {
+    type: "finish";
+    finishReason: FinishReason;
+    usage: TokenUsage;
+} | {
+    type: "error";
+    error: Error;
+};
+/**
+ * Options for Response helpers
+ */
+interface ResponseOptions {
+    /** Additional headers */
+    headers?: Record<string, string>;
+    /** Response status (default: 200) */
+    status?: number;
+}
+
+export { type AssistantMessage as A, type CoreMessage as C, type DoGenerateParams as D, type ErrorChunk as E, type FilePart as F, type GenerateTextParams as G, type ImagePart as I, type LanguageModel as L, type ModelCapabilities as M, type ResponseOptions as R, type StreamTextParams as S, type ToolContext as T, type UserMessage as U, type GenerateTextResult as a, type StreamTextResult as b, type Tool as c, type DoGenerateResult as d, type SystemMessage as e, type ToolMessage as f, type UserContentPart as g, type TextPart as h, type ToolCall as i, type ToolResult as j, type GenerateStep as k, type StreamPart as l, type StreamChunk as m, type TextDeltaChunk as n, type ToolCallChunk as o, type ToolResultChunk as p, type FinishChunk as q, type TokenUsage as r, type FinishReason as s, DEFAULT_CAPABILITIES as t };