@guidekit/core 0.1.0-beta.2 → 0.1.0-beta.3

package/dist/index.d.cts

@@ -1177,130 +1177,6 @@ declare class ContextManager {
     private log;
 }
 
-interface TokenUsage$1 {
-    prompt: number;
-    completion: number;
-    total: number;
-}
-/** Configuration for the OpenAI adapter (custom adapter pattern). */
-interface OpenAIAdapterConfig {
-    apiKey: string;
-    model?: 'gpt-4o' | 'gpt-4o-mini' | (string & {});
-}
-/**
- * Adapter that translates between GuideKit's internal types and the
- * OpenAI Chat Completions API wire format. Handles streaming via SSE,
- * tool formatting, and response parsing.
- *
- * Usage as a custom adapter:
- * ```ts
- * import { OpenAIAdapter } from '@guidekit/core';
- * const llmConfig = { adapter: new OpenAIAdapter({ apiKey: '...', model: 'gpt-4o' }) };
- * ```
- */
-declare class OpenAIAdapter implements LLMProviderAdapter {
-    private readonly apiKey;
-    private readonly model;
-    /** Tracks whether the last extractChunks call emitted a done chunk. */
-    private lastExtractEmittedDone;
-    /**
-     * Token usage extracted from the most recent `parseResponse` call.
-     * Updated as each SSE chunk is parsed.
-     */
-    private _lastUsage;
-    constructor(config: OpenAIAdapterConfig);
-    /** Token usage from the most recent parseResponse call. */
-    get lastUsage(): TokenUsage$1;
-    /**
-     * Convert GuideKit tool definitions into OpenAI's `tools` format.
-     * Each tool is wrapped as `{ type: 'function', function: { name, description, parameters } }`.
-     */
-    formatTools(tools: ToolDefinition[]): unknown;
-    /**
-     * Convert an array of `ConversationTurn` objects into OpenAI's messages
-     * format with `role: 'user' | 'assistant'`.
-     */
-    formatConversation(history: ConversationTurn[]): Array<{
-        role: 'user' | 'assistant';
-        content: string;
-    }>;
-    /**
-     * Parse an OpenAI SSE streaming response into an async iterable of
-     * `TextChunk` and `ToolCall` objects.
-     *
-     * The OpenAI streaming endpoint sends each chunk as a JSON object
-     * prefixed by `data: `. The final line is `data: [DONE]`.
-     * Text content arrives in `choices[0].delta.content` and tool calls
-     * arrive in `choices[0].delta.tool_calls`.
-     *
-     * This method also:
-     * - Detects content filtering and throws `ContentFilterError`.
-     * - Tracks token usage (accessible via `lastUsage` after iteration).
-     */
-    parseResponse(stream: ReadableStream<Uint8Array>): AsyncIterable<TextChunk | ToolCall>;
-    /**
-     * Format a tool result so it can be sent back to OpenAI as a
-     * `tool` role message with the `tool_call_id`.
-     */
-    formatToolResult(callId: string, result: unknown): {
-        role: 'tool';
-        tool_call_id: string;
-        content: string;
-    };
-    /**
-     * Build and execute a streaming request to the OpenAI Chat Completions API.
-     * Returns the raw `ReadableStream` for the response body together with
-     * the raw Response object.
-     */
-    streamRequest(params: {
-        systemPrompt: string;
-        contents: unknown;
-        userMessage?: string;
-        tools?: unknown;
-        signal?: AbortSignal;
-        timeoutMs?: number;
-    }): Promise<{
-        stream: ReadableStream<Uint8Array>;
-        response: Response;
-    }>;
-    /**
-     * Extract `TextChunk` and accumulate `ToolCall` data from a single parsed
-     * OpenAI SSE JSON object.
-     *
-     * OpenAI tool calls arrive incrementally: the first chunk for a tool call
-     * carries the `id` and `function.name`, while subsequent chunks append to
-     * `function.arguments`. We accumulate these in `pendingToolCalls` and only
-     * yield complete `ToolCall` objects when the finish_reason is 'tool_calls'
-     * or when flushed.
-     */
-    private extractChunks;
-    /**
-     * Flush all accumulated pending tool calls as complete `ToolCall` objects.
-     */
-    private flushPendingToolCalls;
-    /**
-     * Extract token usage from a parsed OpenAI response chunk.
-     * Usage data typically appears in the final chunk when `stream_options`
-     * includes `include_usage`, or in the non-streaming response.
-     * Returns `null` if no usage data is present.
-     */
-    extractUsage(parsed: Record<string, unknown>): TokenUsage$1 | null;
-    /**
-     * Check whether a parsed OpenAI chunk indicates the response was
-     * blocked by a content filter.
-     *
-     * OpenAI signals content filtering through:
-     * - `choices[].finish_reason === 'content_filter'`
-     * - `choices[].content_filter_results` with `filtered: true`
-     */
-    isContentFiltered(parsed: Record<string, unknown>): boolean;
-    /**
-     * Translate an HTTP error response from OpenAI into the appropriate
-     * GuideKit error class.
-     */
-    private handleHttpError;
-}
-
 interface TokenUsage {
     prompt: number;
     completion: number;
@@ -1478,7 +1354,7 @@ declare class LLMOrchestrator {
      *
      * Custom adapters:
      * - Pass `{ adapter: myAdapter }` to use any `LLMProviderAdapter`.
-     *   Example: `llm: { adapter: new OpenAIAdapter({ ... }) }`
+     *   Example: `llm: { adapter: myCustomAdapter }`
      */
     private createAdapter;
     /** Convenience accessor for the current provider name. */
@@ -2724,4 +2600,4 @@ declare class VoicePipeline {
     private _log;
 }
 
-export { type AgentConfig, type AgentState, type AggregatedUsage, AuthenticationError, type AwarenessOptions, type AwarenessState, AwarenessSystem, type BeforeLLMCallContext, BrowserSupportError, ConfigurationError, ConnectionManager, type ConnectionManagerOptions, type ConnectionState, ContentFilterError, type ContentMap, type ContentMapEntry, type ContentMapFunction, type ContentMapInput, ContextManager, type ContextManagerOptions, type ConversationTurn, type CreateSessionTokenOptions, DOMScanner, type DOMScannerOptions, type ErrorCode, ErrorCodes, EventBus, type EventMap, type FormField, type FormSummary, GeminiAdapter, GuideKitCore, type GuideKitCoreOptions, GuideKitError, type GuideKitErrorOptions, type GuideKitErrorType, type GuideKitEvent, type GuideKitOptions, type GuideKitProviderProps, type GuideKitStore, type GuideKitTheme, type HealthCheckResult, type HealthCheckStatus, I18n, type I18nOptions, type I18nStrings, InitializationError, type InteractiveElement, type LLMConfig, LLMOrchestrator, type LLMProviderAdapter, type LocaleInput, type NavItem, NavigationController, type NavigationControllerOptions, NetworkError, OpenAIAdapter, type OpenAIAdapterConfig, type OverlayElement, type PageModel, type PageSection, PermissionError, type ProactiveOptions, type ProactiveTrigger, ProactiveTriggerEngine, type ProactiveTriggerType, type Provider, type QueuedMessage, RateLimitError, RateLimiter, type RateLimiterOptions, type RateLimiterState, type RateLimits, type Resource, ResourceExhaustedError, ResourceManager, type ResourceManagerState, type STTConfig, type ScanMetadata, type SessionState, SingletonGuard, type SpotlightState, type SupportedLocale, type TTSConfig, type TextChunk, TimeoutError, type TokenData, TokenManager, type TokenManagerOptions, type TokenPayload, type TokenResponse, type ToolCall, type ToolCallRecord, type ToolDefinition, type ToolExecutionResult, ToolExecutor, type ToolExecutorOptions, type ToolHandler, type TooltipOptions, VisualGuidance, type VisualGuidanceOptions, VoicePipeline, type VoicePipelineOptions, type VoiceState, WebSpeechSTT, type WebSpeechSTTOptions, WebSpeechTTS, type WebSpeechTTSAudioEvent, type WebSpeechTTSOptions, createEventBus, isGuideKitError };
+export { type AgentConfig, type AgentState, type AggregatedUsage, AuthenticationError, type AwarenessOptions, type AwarenessState, AwarenessSystem, type BeforeLLMCallContext, BrowserSupportError, ConfigurationError, ConnectionManager, type ConnectionManagerOptions, type ConnectionState, ContentFilterError, type ContentMap, type ContentMapEntry, type ContentMapFunction, type ContentMapInput, ContextManager, type ContextManagerOptions, type ConversationTurn, type CreateSessionTokenOptions, DOMScanner, type DOMScannerOptions, type ErrorCode, ErrorCodes, EventBus, type EventMap, type FormField, type FormSummary, GeminiAdapter, GuideKitCore, type GuideKitCoreOptions, GuideKitError, type GuideKitErrorOptions, type GuideKitErrorType, type GuideKitEvent, type GuideKitOptions, type GuideKitProviderProps, type GuideKitStore, type GuideKitTheme, type HealthCheckResult, type HealthCheckStatus, I18n, type I18nOptions, type I18nStrings, InitializationError, type InteractiveElement, type LLMConfig, LLMOrchestrator, type LLMProviderAdapter, type LocaleInput, type NavItem, NavigationController, type NavigationControllerOptions, NetworkError, type OverlayElement, type PageModel, type PageSection, PermissionError, type ProactiveOptions, type ProactiveTrigger, ProactiveTriggerEngine, type ProactiveTriggerType, type Provider, type QueuedMessage, RateLimitError, RateLimiter, type RateLimiterOptions, type RateLimiterState, type RateLimits, type Resource, ResourceExhaustedError, ResourceManager, type ResourceManagerState, type STTConfig, type ScanMetadata, type SessionState, SingletonGuard, type SpotlightState, type SupportedLocale, type TTSConfig, type TextChunk, TimeoutError, type TokenData, TokenManager, type TokenManagerOptions, type TokenPayload, type TokenResponse, type ToolCall, type ToolCallRecord, type ToolDefinition, type ToolExecutionResult, ToolExecutor, type ToolExecutorOptions, type ToolHandler, type TooltipOptions, VisualGuidance, type VisualGuidanceOptions, VoicePipeline, type VoicePipelineOptions, type VoiceState, WebSpeechSTT, type WebSpeechSTTOptions, WebSpeechTTS, type WebSpeechTTSAudioEvent, type WebSpeechTTSOptions, createEventBus, isGuideKitError };

package/dist/index.d.ts

@@ -1177,130 +1177,6 @@ declare class ContextManager {
     private log;
 }
 
-interface TokenUsage$1 {
-    prompt: number;
-    completion: number;
-    total: number;
-}
-/** Configuration for the OpenAI adapter (custom adapter pattern). */
-interface OpenAIAdapterConfig {
-    apiKey: string;
-    model?: 'gpt-4o' | 'gpt-4o-mini' | (string & {});
-}
-/**
- * Adapter that translates between GuideKit's internal types and the
- * OpenAI Chat Completions API wire format. Handles streaming via SSE,
- * tool formatting, and response parsing.
- *
- * Usage as a custom adapter:
- * ```ts
- * import { OpenAIAdapter } from '@guidekit/core';
- * const llmConfig = { adapter: new OpenAIAdapter({ apiKey: '...', model: 'gpt-4o' }) };
- * ```
- */
-declare class OpenAIAdapter implements LLMProviderAdapter {
-    private readonly apiKey;
-    private readonly model;
-    /** Tracks whether the last extractChunks call emitted a done chunk. */
-    private lastExtractEmittedDone;
-    /**
-     * Token usage extracted from the most recent `parseResponse` call.
-     * Updated as each SSE chunk is parsed.
-     */
-    private _lastUsage;
-    constructor(config: OpenAIAdapterConfig);
-    /** Token usage from the most recent parseResponse call. */
-    get lastUsage(): TokenUsage$1;
-    /**
-     * Convert GuideKit tool definitions into OpenAI's `tools` format.
-     * Each tool is wrapped as `{ type: 'function', function: { name, description, parameters } }`.
-     */
-    formatTools(tools: ToolDefinition[]): unknown;
-    /**
-     * Convert an array of `ConversationTurn` objects into OpenAI's messages
-     * format with `role: 'user' | 'assistant'`.
-     */
-    formatConversation(history: ConversationTurn[]): Array<{
-        role: 'user' | 'assistant';
-        content: string;
-    }>;
-    /**
-     * Parse an OpenAI SSE streaming response into an async iterable of
-     * `TextChunk` and `ToolCall` objects.
-     *
-     * The OpenAI streaming endpoint sends each chunk as a JSON object
-     * prefixed by `data: `. The final line is `data: [DONE]`.
-     * Text content arrives in `choices[0].delta.content` and tool calls
-     * arrive in `choices[0].delta.tool_calls`.
-     *
-     * This method also:
-     * - Detects content filtering and throws `ContentFilterError`.
-     * - Tracks token usage (accessible via `lastUsage` after iteration).
-     */
-    parseResponse(stream: ReadableStream<Uint8Array>): AsyncIterable<TextChunk | ToolCall>;
-    /**
-     * Format a tool result so it can be sent back to OpenAI as a
-     * `tool` role message with the `tool_call_id`.
-     */
-    formatToolResult(callId: string, result: unknown): {
-        role: 'tool';
-        tool_call_id: string;
-        content: string;
-    };
-    /**
-     * Build and execute a streaming request to the OpenAI Chat Completions API.
-     * Returns the raw `ReadableStream` for the response body together with
-     * the raw Response object.
-     */
-    streamRequest(params: {
-        systemPrompt: string;
-        contents: unknown;
-        userMessage?: string;
-        tools?: unknown;
-        signal?: AbortSignal;
-        timeoutMs?: number;
-    }): Promise<{
-        stream: ReadableStream<Uint8Array>;
-        response: Response;
-    }>;
-    /**
-     * Extract `TextChunk` and accumulate `ToolCall` data from a single parsed
-     * OpenAI SSE JSON object.
-     *
-     * OpenAI tool calls arrive incrementally: the first chunk for a tool call
-     * carries the `id` and `function.name`, while subsequent chunks append to
-     * `function.arguments`. We accumulate these in `pendingToolCalls` and only
-     * yield complete `ToolCall` objects when the finish_reason is 'tool_calls'
-     * or when flushed.
-     */
-    private extractChunks;
-    /**
-     * Flush all accumulated pending tool calls as complete `ToolCall` objects.
-     */
-    private flushPendingToolCalls;
-    /**
-     * Extract token usage from a parsed OpenAI response chunk.
-     * Usage data typically appears in the final chunk when `stream_options`
-     * includes `include_usage`, or in the non-streaming response.
-     * Returns `null` if no usage data is present.
-     */
-    extractUsage(parsed: Record<string, unknown>): TokenUsage$1 | null;
-    /**
-     * Check whether a parsed OpenAI chunk indicates the response was
-     * blocked by a content filter.
-     *
-     * OpenAI signals content filtering through:
-     * - `choices[].finish_reason === 'content_filter'`
-     * - `choices[].content_filter_results` with `filtered: true`
-     */
-    isContentFiltered(parsed: Record<string, unknown>): boolean;
-    /**
-     * Translate an HTTP error response from OpenAI into the appropriate
-     * GuideKit error class.
-     */
-    private handleHttpError;
-}
-
 interface TokenUsage {
     prompt: number;
     completion: number;
@@ -1478,7 +1354,7 @@ declare class LLMOrchestrator {
      *
      * Custom adapters:
      * - Pass `{ adapter: myAdapter }` to use any `LLMProviderAdapter`.
-     *   Example: `llm: { adapter: new OpenAIAdapter({ ... }) }`
+     *   Example: `llm: { adapter: myCustomAdapter }`
      */
     private createAdapter;
     /** Convenience accessor for the current provider name. */
@@ -2724,4 +2600,4 @@ declare class VoicePipeline {
     private _log;
 }
 
-export { type AgentConfig, type AgentState, type AggregatedUsage, AuthenticationError, type AwarenessOptions, type AwarenessState, AwarenessSystem, type BeforeLLMCallContext, BrowserSupportError, ConfigurationError, ConnectionManager, type ConnectionManagerOptions, type ConnectionState, ContentFilterError, type ContentMap, type ContentMapEntry, type ContentMapFunction, type ContentMapInput, ContextManager, type ContextManagerOptions, type ConversationTurn, type CreateSessionTokenOptions, DOMScanner, type DOMScannerOptions, type ErrorCode, ErrorCodes, EventBus, type EventMap, type FormField, type FormSummary, GeminiAdapter, GuideKitCore, type GuideKitCoreOptions, GuideKitError, type GuideKitErrorOptions, type GuideKitErrorType, type GuideKitEvent, type GuideKitOptions, type GuideKitProviderProps, type GuideKitStore, type GuideKitTheme, type HealthCheckResult, type HealthCheckStatus, I18n, type I18nOptions, type I18nStrings, InitializationError, type InteractiveElement, type LLMConfig, LLMOrchestrator, type LLMProviderAdapter, type LocaleInput, type NavItem, NavigationController, type NavigationControllerOptions, NetworkError, OpenAIAdapter, type OpenAIAdapterConfig, type OverlayElement, type PageModel, type PageSection, PermissionError, type ProactiveOptions, type ProactiveTrigger, ProactiveTriggerEngine, type ProactiveTriggerType, type Provider, type QueuedMessage, RateLimitError, RateLimiter, type RateLimiterOptions, type RateLimiterState, type RateLimits, type Resource, ResourceExhaustedError, ResourceManager, type ResourceManagerState, type STTConfig, type ScanMetadata, type SessionState, SingletonGuard, type SpotlightState, type SupportedLocale, type TTSConfig, type TextChunk, TimeoutError, type TokenData, TokenManager, type TokenManagerOptions, type TokenPayload, type TokenResponse, type ToolCall, type ToolCallRecord, type ToolDefinition, type ToolExecutionResult, ToolExecutor, type ToolExecutorOptions, type ToolHandler, type TooltipOptions, VisualGuidance, type VisualGuidanceOptions, VoicePipeline, type VoicePipelineOptions, type VoiceState, WebSpeechSTT, type WebSpeechSTTOptions, WebSpeechTTS, type WebSpeechTTSAudioEvent, type WebSpeechTTSOptions, createEventBus, isGuideKitError };
+export { type AgentConfig, type AgentState, type AggregatedUsage, AuthenticationError, type AwarenessOptions, type AwarenessState, AwarenessSystem, type BeforeLLMCallContext, BrowserSupportError, ConfigurationError, ConnectionManager, type ConnectionManagerOptions, type ConnectionState, ContentFilterError, type ContentMap, type ContentMapEntry, type ContentMapFunction, type ContentMapInput, ContextManager, type ContextManagerOptions, type ConversationTurn, type CreateSessionTokenOptions, DOMScanner, type DOMScannerOptions, type ErrorCode, ErrorCodes, EventBus, type EventMap, type FormField, type FormSummary, GeminiAdapter, GuideKitCore, type GuideKitCoreOptions, GuideKitError, type GuideKitErrorOptions, type GuideKitErrorType, type GuideKitEvent, type GuideKitOptions, type GuideKitProviderProps, type GuideKitStore, type GuideKitTheme, type HealthCheckResult, type HealthCheckStatus, I18n, type I18nOptions, type I18nStrings, InitializationError, type InteractiveElement, type LLMConfig, LLMOrchestrator, type LLMProviderAdapter, type LocaleInput, type NavItem, NavigationController, type NavigationControllerOptions, NetworkError, type OverlayElement, type PageModel, type PageSection, PermissionError, type ProactiveOptions, type ProactiveTrigger, ProactiveTriggerEngine, type ProactiveTriggerType, type Provider, type QueuedMessage, RateLimitError, RateLimiter, type RateLimiterOptions, type RateLimiterState, type RateLimits, type Resource, ResourceExhaustedError, ResourceManager, type ResourceManagerState, type STTConfig, type ScanMetadata, type SessionState, SingletonGuard, type SpotlightState, type SupportedLocale, type TTSConfig, type TextChunk, TimeoutError, type TokenData, TokenManager, type TokenManagerOptions, type TokenPayload, type TokenResponse, type ToolCall, type ToolCallRecord, type ToolDefinition, type ToolExecutionResult, ToolExecutor, type ToolExecutorOptions, type ToolHandler, type TooltipOptions, VisualGuidance, type VisualGuidanceOptions, VoicePipeline, type VoicePipelineOptions, type VoiceState, WebSpeechSTT, type WebSpeechSTTOptions, WebSpeechTTS, type WebSpeechTTSAudioEvent, type WebSpeechTTSOptions, createEventBus, isGuideKitError };