art-framework 0.4.3 → 0.4.5

package/dist/index.d.cts

@@ -4562,6 +4562,87 @@ declare class OllamaAdapter implements ProviderAdapter {
     shutdown(): Promise<void>;
 }
 
+/**
+ * Configuration options required for the `GroqAdapter`.
+ */
+interface GroqAdapterOptions {
+    /** Your Groq API key. Handle securely. */
+    apiKey: string;
+    /** The default Groq model ID to use (e.g., 'llama-3.3-70b-versatile', 'mixtral-8x7b-32768'). */
+    model?: string;
+    /** Optional: Override the base URL for the Groq API. */
+    apiBaseUrl?: string;
+    /** Optional: Default maximum tokens for responses. */
+    defaultMaxTokens?: number;
+    /** Optional: Default temperature for responses. */
+    defaultTemperature?: number;
+}
+/**
+ * Implements the `ProviderAdapter` interface for interacting with Groq's
+ * ultra-fast inference API using the official Groq SDK.
+ *
+ * Groq provides an OpenAI-compatible API, making this adapter similar in structure
+ * to the OpenAI adapter but optimized for Groq's specific features and models.
+ *
+ * Handles formatting requests, parsing responses, streaming, and tool use.
+ *
+ * @see {@link ProviderAdapter} for the interface definition.
+ * @see {@link GroqAdapterOptions} for configuration options.
+ */
+declare class GroqAdapter implements ProviderAdapter {
+    readonly providerName = "groq";
+    private client;
+    private defaultModel;
+    private defaultMaxTokens;
+    private defaultTemperature;
+    /**
+     * Creates an instance of the GroqAdapter.
+     * @param options - Configuration options including the API key and optional model/baseURL/defaults.
+     * @throws {ARTError} If the API key is missing.
+     */
+    constructor(options: GroqAdapterOptions);
+    /**
+     * Sends a request to the Groq Chat Completions API.
+     * Translates `ArtStandardPrompt` to the Groq/OpenAI format and handles streaming and tool use.
+     *
+     * @param {ArtStandardPrompt} prompt - The standardized prompt messages.
+     * @param {CallOptions} options - Call options, including streaming, model parameters, and tools.
+     * @returns {Promise<AsyncIterable<StreamEvent>>} A promise resolving to an AsyncIterable of StreamEvent objects.
+     */
+    call(prompt: ArtStandardPrompt, options: CallOptions): Promise<AsyncIterable<StreamEvent>>;
+    /**
+     * Optional: Method for graceful shutdown
+     */
+    shutdown(): Promise<void>;
+    /**
+     * Translates the provider-agnostic `ArtStandardPrompt` into the Groq/OpenAI message format.
+     *
+     * @private
+     * @param {ArtStandardPrompt} artPrompt - The input `ArtStandardPrompt` array.
+     * @returns {ChatCompletionMessageParam[]} Array of Groq-formatted messages.
+     * @throws {ARTError} If translation encounters an issue.
+     */
+    private translateToGroq;
+    /**
+     * Maps a single `ArtStandardMessage` to Groq/OpenAI message format.
+     *
+     * @private
+     * @param {ArtStandardMessage} artMsg - The ART standard message to map.
+     * @returns {ChatCompletionMessageParam | null} The translated message, or null if should be skipped.
+     * @throws {ARTError} If tool call arguments are not valid JSON.
+     */
+    private mapArtMessageToGroq;
+    /**
+     * Translates an array of `ToolSchema` from the ART framework format to Groq's tool format.
+     *
+     * @private
+     * @param {ToolSchema[]} artTools - An array of ART tool schemas.
+     * @returns {ChatCompletionTool[]} An array of tools formatted for the Groq API.
+     * @throws {ARTError} If a tool's `inputSchema` is invalid.
+     */
+    private translateArtToolsToGroq;
+}
+
 /**
  * An ART Framework tool that safely evaluates mathematical expressions using the mathjs library.
  * It supports basic arithmetic, variables via a scope, complex numbers, and a predefined list of safe functions.
@@ -5265,6 +5346,6 @@ declare const generateUUID: () => string;
 /**
  * The current version of the ART Framework package.
  */
-declare const VERSION = "0.3.8";
+declare const VERSION = "0.4.5";
 
-export { type A2AAgentInfo, type A2ATask, type A2ATaskEvent, type A2ATaskFilter, type A2ATaskMetadata, A2ATaskPriority, type A2ATaskResult, A2ATaskSocket, A2ATaskStatus, ARTError, AdapterInstantiationError, type AgentDiscoveryConfig, AgentDiscoveryService, AgentFactory, type AgentFinalResponse, type AgentOptions, type AgentPersona, type AgentProps, type AgentState, AnthropicAdapter, type AnthropicAdapterOptions, ApiKeyStrategy, ApiQueueTimeoutError, type ArtInstance, type ArtInstanceConfig, type ArtStandardMessage, type ArtStandardMessageRole, ArtStandardMessageSchema, type ArtStandardPrompt, ArtStandardPromptSchema, AuthManager, type AvailableProviderEntry, CalculatorTool, type CallOptions, type ConversationManager, type ConversationMessage, ConversationSocket, type CreateA2ATaskRequest, DeepSeekAdapter, type DeepSeekAdapterOptions, ErrorCode, type ExecutionContext, type ExecutionMetadata, type ExecutionOutput, type FilterOptions, type FormattedPrompt, GeminiAdapter, type GeminiAdapterOptions, GenericOAuthStrategy, type IA2ATaskRepository, type IAgentCore, type IAuthStrategy, type IConversationRepository, type IObservationRepository, type IProviderManager, type IStateRepository, type IToolExecutor, type ITypedSocket, InMemoryStorageAdapter, IndexedDBStorageAdapter, type JsonObjectSchema, type JsonSchema, type LLMMetadata, LLMStreamSocket, LocalInstanceBusyError, LocalProviderConflictError, LogLevel, Logger, type LoggerConfig, type ManagedAdapterAccessor, McpClientController, McpManager, type McpManagerConfig, McpProxyTool, type McpResource, type McpResourceTemplate, type McpServerConfig, type McpServerStatus, type McpToolDefinition, type MessageOptions, MessageRole, ModelCapability, type OAuthConfig, type Observation, type ObservationFilter, type ObservationManager, ObservationSocket, ObservationType, OllamaAdapter, type OllamaAdapterOptions, OpenAIAdapter, type OpenAIAdapterOptions, OpenRouterAdapter, type OpenRouterAdapterOptions, type OutputParser, PESAgent, type PESAgentStateData, type PKCEOAuthConfig, PKCEOAuthStrategy, type ParsedToolCall, type PromptBlueprint, type PromptContext, type ProviderAdapter, type ProviderManagerConfig, ProviderManagerImpl, type ReasoningEngine, type RuntimeProviderConfig, type StageSpecificPrompts, StateManager, type StateSavingStrategy, type StorageAdapter, type StreamEvent, type StreamEventTypeFilter, SupabaseStorageAdapter, type SystemPromptMergeStrategy, type SystemPromptOverride, type SystemPromptResolver, type SystemPromptSpec, type SystemPromptsRegistry, type TaskDelegationConfig, TaskDelegationService, type TaskStatusResponse, type ThreadConfig, type ThreadContext, type TodoItem, TodoItemStatus, ToolRegistry, type ToolResult, type ToolSchema, type ToolSystem, TypedSocket, UISystem, UnknownProviderError, type UnsubscribeFunction, type UpdateA2ATaskRequest, VERSION, type ZyntopiaOAuthConfig, ZyntopiaOAuthStrategy, createArtInstance, generateUUID };
+export { type A2AAgentInfo, type A2ATask, type A2ATaskEvent, type A2ATaskFilter, type A2ATaskMetadata, A2ATaskPriority, type A2ATaskResult, A2ATaskSocket, A2ATaskStatus, ARTError, AdapterInstantiationError, type AgentDiscoveryConfig, AgentDiscoveryService, AgentFactory, type AgentFinalResponse, type AgentOptions, type AgentPersona, type AgentProps, type AgentState, AnthropicAdapter, type AnthropicAdapterOptions, ApiKeyStrategy, ApiQueueTimeoutError, type ArtInstance, type ArtInstanceConfig, type ArtStandardMessage, type ArtStandardMessageRole, ArtStandardMessageSchema, type ArtStandardPrompt, ArtStandardPromptSchema, AuthManager, type AvailableProviderEntry, CalculatorTool, type CallOptions, type ConversationManager, type ConversationMessage, ConversationSocket, type CreateA2ATaskRequest, DeepSeekAdapter, type DeepSeekAdapterOptions, ErrorCode, type ExecutionContext, type ExecutionMetadata, type ExecutionOutput, type FilterOptions, type FormattedPrompt, GeminiAdapter, type GeminiAdapterOptions, GenericOAuthStrategy, GroqAdapter, type GroqAdapterOptions, type IA2ATaskRepository, type IAgentCore, type IAuthStrategy, type IConversationRepository, type IObservationRepository, type IProviderManager, type IStateRepository, type IToolExecutor, type ITypedSocket, InMemoryStorageAdapter, IndexedDBStorageAdapter, type JsonObjectSchema, type JsonSchema, type LLMMetadata, LLMStreamSocket, LocalInstanceBusyError, LocalProviderConflictError, LogLevel, Logger, type LoggerConfig, type ManagedAdapterAccessor, McpClientController, McpManager, type McpManagerConfig, McpProxyTool, type McpResource, type McpResourceTemplate, type McpServerConfig, type McpServerStatus, type McpToolDefinition, type MessageOptions, MessageRole, ModelCapability, type OAuthConfig, type Observation, type ObservationFilter, type ObservationManager, ObservationSocket, ObservationType, OllamaAdapter, type OllamaAdapterOptions, OpenAIAdapter, type OpenAIAdapterOptions, OpenRouterAdapter, type OpenRouterAdapterOptions, type OutputParser, PESAgent, type PESAgentStateData, type PKCEOAuthConfig, PKCEOAuthStrategy, type ParsedToolCall, type PromptBlueprint, type PromptContext, type ProviderAdapter, type ProviderManagerConfig, ProviderManagerImpl, type ReasoningEngine, type RuntimeProviderConfig, type StageSpecificPrompts, StateManager, type StateSavingStrategy, type StorageAdapter, type StreamEvent, type StreamEventTypeFilter, SupabaseStorageAdapter, type SystemPromptMergeStrategy, type SystemPromptOverride, type SystemPromptResolver, type SystemPromptSpec, type SystemPromptsRegistry, type TaskDelegationConfig, TaskDelegationService, type TaskStatusResponse, type ThreadConfig, type ThreadContext, type TodoItem, TodoItemStatus, ToolRegistry, type ToolResult, type ToolSchema, type ToolSystem, TypedSocket, UISystem, UnknownProviderError, type UnsubscribeFunction, type UpdateA2ATaskRequest, VERSION, type ZyntopiaOAuthConfig, ZyntopiaOAuthStrategy, createArtInstance, generateUUID };

package/dist/index.d.ts

@@ -4562,6 +4562,87 @@ declare class OllamaAdapter implements ProviderAdapter {
     shutdown(): Promise<void>;
 }
 
+/**
+ * Configuration options required for the `GroqAdapter`.
+ */
+interface GroqAdapterOptions {
+    /** Your Groq API key. Handle securely. */
+    apiKey: string;
+    /** The default Groq model ID to use (e.g., 'llama-3.3-70b-versatile', 'mixtral-8x7b-32768'). */
+    model?: string;
+    /** Optional: Override the base URL for the Groq API. */
+    apiBaseUrl?: string;
+    /** Optional: Default maximum tokens for responses. */
+    defaultMaxTokens?: number;
+    /** Optional: Default temperature for responses. */
+    defaultTemperature?: number;
+}
+/**
+ * Implements the `ProviderAdapter` interface for interacting with Groq's
+ * ultra-fast inference API using the official Groq SDK.
+ *
+ * Groq provides an OpenAI-compatible API, making this adapter similar in structure
+ * to the OpenAI adapter but optimized for Groq's specific features and models.
+ *
+ * Handles formatting requests, parsing responses, streaming, and tool use.
+ *
+ * @see {@link ProviderAdapter} for the interface definition.
+ * @see {@link GroqAdapterOptions} for configuration options.
+ */
+declare class GroqAdapter implements ProviderAdapter {
+    readonly providerName = "groq";
+    private client;
+    private defaultModel;
+    private defaultMaxTokens;
+    private defaultTemperature;
+    /**
+     * Creates an instance of the GroqAdapter.
+     * @param options - Configuration options including the API key and optional model/baseURL/defaults.
+     * @throws {ARTError} If the API key is missing.
+     */
+    constructor(options: GroqAdapterOptions);
+    /**
+     * Sends a request to the Groq Chat Completions API.
+     * Translates `ArtStandardPrompt` to the Groq/OpenAI format and handles streaming and tool use.
+     *
+     * @param {ArtStandardPrompt} prompt - The standardized prompt messages.
+     * @param {CallOptions} options - Call options, including streaming, model parameters, and tools.
+     * @returns {Promise<AsyncIterable<StreamEvent>>} A promise resolving to an AsyncIterable of StreamEvent objects.
+     */
+    call(prompt: ArtStandardPrompt, options: CallOptions): Promise<AsyncIterable<StreamEvent>>;
+    /**
+     * Optional: Method for graceful shutdown
+     */
+    shutdown(): Promise<void>;
+    /**
+     * Translates the provider-agnostic `ArtStandardPrompt` into the Groq/OpenAI message format.
+     *
+     * @private
+     * @param {ArtStandardPrompt} artPrompt - The input `ArtStandardPrompt` array.
+     * @returns {ChatCompletionMessageParam[]} Array of Groq-formatted messages.
+     * @throws {ARTError} If translation encounters an issue.
+     */
+    private translateToGroq;
+    /**
+     * Maps a single `ArtStandardMessage` to Groq/OpenAI message format.
+     *
+     * @private
+     * @param {ArtStandardMessage} artMsg - The ART standard message to map.
+     * @returns {ChatCompletionMessageParam | null} The translated message, or null if should be skipped.
+     * @throws {ARTError} If tool call arguments are not valid JSON.
+     */
+    private mapArtMessageToGroq;
+    /**
+     * Translates an array of `ToolSchema` from the ART framework format to Groq's tool format.
+     *
+     * @private
+     * @param {ToolSchema[]} artTools - An array of ART tool schemas.
+     * @returns {ChatCompletionTool[]} An array of tools formatted for the Groq API.
+     * @throws {ARTError} If a tool's `inputSchema` is invalid.
+     */
+    private translateArtToolsToGroq;
+}
+
 /**
  * An ART Framework tool that safely evaluates mathematical expressions using the mathjs library.
  * It supports basic arithmetic, variables via a scope, complex numbers, and a predefined list of safe functions.
@@ -5265,6 +5346,6 @@ declare const generateUUID: () => string;
 /**
  * The current version of the ART Framework package.
  */
-declare const VERSION = "0.3.8";
+declare const VERSION = "0.4.5";
 
-export { type A2AAgentInfo, type A2ATask, type A2ATaskEvent, type A2ATaskFilter, type A2ATaskMetadata, A2ATaskPriority, type A2ATaskResult, A2ATaskSocket, A2ATaskStatus, ARTError, AdapterInstantiationError, type AgentDiscoveryConfig, AgentDiscoveryService, AgentFactory, type AgentFinalResponse, type AgentOptions, type AgentPersona, type AgentProps, type AgentState, AnthropicAdapter, type AnthropicAdapterOptions, ApiKeyStrategy, ApiQueueTimeoutError, type ArtInstance, type ArtInstanceConfig, type ArtStandardMessage, type ArtStandardMessageRole, ArtStandardMessageSchema, type ArtStandardPrompt, ArtStandardPromptSchema, AuthManager, type AvailableProviderEntry, CalculatorTool, type CallOptions, type ConversationManager, type ConversationMessage, ConversationSocket, type CreateA2ATaskRequest, DeepSeekAdapter, type DeepSeekAdapterOptions, ErrorCode, type ExecutionContext, type ExecutionMetadata, type ExecutionOutput, type FilterOptions, type FormattedPrompt, GeminiAdapter, type GeminiAdapterOptions, GenericOAuthStrategy, type IA2ATaskRepository, type IAgentCore, type IAuthStrategy, type IConversationRepository, type IObservationRepository, type IProviderManager, type IStateRepository, type IToolExecutor, type ITypedSocket, InMemoryStorageAdapter, IndexedDBStorageAdapter, type JsonObjectSchema, type JsonSchema, type LLMMetadata, LLMStreamSocket, LocalInstanceBusyError, LocalProviderConflictError, LogLevel, Logger, type LoggerConfig, type ManagedAdapterAccessor, McpClientController, McpManager, type McpManagerConfig, McpProxyTool, type McpResource, type McpResourceTemplate, type McpServerConfig, type McpServerStatus, type McpToolDefinition, type MessageOptions, MessageRole, ModelCapability, type OAuthConfig, type Observation, type ObservationFilter, type ObservationManager, ObservationSocket, ObservationType, OllamaAdapter, type OllamaAdapterOptions, OpenAIAdapter, type OpenAIAdapterOptions, OpenRouterAdapter, type OpenRouterAdapterOptions, type OutputParser, PESAgent, type PESAgentStateData, type PKCEOAuthConfig, PKCEOAuthStrategy, type ParsedToolCall, type PromptBlueprint, type PromptContext, type ProviderAdapter, type ProviderManagerConfig, ProviderManagerImpl, type ReasoningEngine, type RuntimeProviderConfig, type StageSpecificPrompts, StateManager, type StateSavingStrategy, type StorageAdapter, type StreamEvent, type StreamEventTypeFilter, SupabaseStorageAdapter, type SystemPromptMergeStrategy, type SystemPromptOverride, type SystemPromptResolver, type SystemPromptSpec, type SystemPromptsRegistry, type TaskDelegationConfig, TaskDelegationService, type TaskStatusResponse, type ThreadConfig, type ThreadContext, type TodoItem, TodoItemStatus, ToolRegistry, type ToolResult, type ToolSchema, type ToolSystem, TypedSocket, UISystem, UnknownProviderError, type UnsubscribeFunction, type UpdateA2ATaskRequest, VERSION, type ZyntopiaOAuthConfig, ZyntopiaOAuthStrategy, createArtInstance, generateUUID };
+export { type A2AAgentInfo, type A2ATask, type A2ATaskEvent, type A2ATaskFilter, type A2ATaskMetadata, A2ATaskPriority, type A2ATaskResult, A2ATaskSocket, A2ATaskStatus, ARTError, AdapterInstantiationError, type AgentDiscoveryConfig, AgentDiscoveryService, AgentFactory, type AgentFinalResponse, type AgentOptions, type AgentPersona, type AgentProps, type AgentState, AnthropicAdapter, type AnthropicAdapterOptions, ApiKeyStrategy, ApiQueueTimeoutError, type ArtInstance, type ArtInstanceConfig, type ArtStandardMessage, type ArtStandardMessageRole, ArtStandardMessageSchema, type ArtStandardPrompt, ArtStandardPromptSchema, AuthManager, type AvailableProviderEntry, CalculatorTool, type CallOptions, type ConversationManager, type ConversationMessage, ConversationSocket, type CreateA2ATaskRequest, DeepSeekAdapter, type DeepSeekAdapterOptions, ErrorCode, type ExecutionContext, type ExecutionMetadata, type ExecutionOutput, type FilterOptions, type FormattedPrompt, GeminiAdapter, type GeminiAdapterOptions, GenericOAuthStrategy, GroqAdapter, type GroqAdapterOptions, type IA2ATaskRepository, type IAgentCore, type IAuthStrategy, type IConversationRepository, type IObservationRepository, type IProviderManager, type IStateRepository, type IToolExecutor, type ITypedSocket, InMemoryStorageAdapter, IndexedDBStorageAdapter, type JsonObjectSchema, type JsonSchema, type LLMMetadata, LLMStreamSocket, LocalInstanceBusyError, LocalProviderConflictError, LogLevel, Logger, type LoggerConfig, type ManagedAdapterAccessor, McpClientController, McpManager, type McpManagerConfig, McpProxyTool, type McpResource, type McpResourceTemplate, type McpServerConfig, type McpServerStatus, type McpToolDefinition, type MessageOptions, MessageRole, ModelCapability, type OAuthConfig, type Observation, type ObservationFilter, type ObservationManager, ObservationSocket, ObservationType, OllamaAdapter, type OllamaAdapterOptions, OpenAIAdapter, type OpenAIAdapterOptions, OpenRouterAdapter, type OpenRouterAdapterOptions, type OutputParser, PESAgent, type PESAgentStateData, type PKCEOAuthConfig, PKCEOAuthStrategy, type ParsedToolCall, type PromptBlueprint, type PromptContext, type ProviderAdapter, type ProviderManagerConfig, ProviderManagerImpl, type ReasoningEngine, type RuntimeProviderConfig, type StageSpecificPrompts, StateManager, type StateSavingStrategy, type StorageAdapter, type StreamEvent, type StreamEventTypeFilter, SupabaseStorageAdapter, type SystemPromptMergeStrategy, type SystemPromptOverride, type SystemPromptResolver, type SystemPromptSpec, type SystemPromptsRegistry, type TaskDelegationConfig, TaskDelegationService, type TaskStatusResponse, type ThreadConfig, type ThreadContext, type TodoItem, TodoItemStatus, ToolRegistry, type ToolResult, type ToolSchema, type ToolSystem, TypedSocket, UISystem, UnknownProviderError, type UnsubscribeFunction, type UpdateA2ATaskRequest, VERSION, type ZyntopiaOAuthConfig, ZyntopiaOAuthStrategy, createArtInstance, generateUUID };