@voltagent/core 0.1.25 → 0.1.27

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 import { Span } from '@opentelemetry/api';
+import { Context } from 'hono';
 import { SpanExporter } from '@opentelemetry/sdk-trace-base';
 import { ClientCapabilities } from '@modelcontextprotocol/sdk/types.js';
 import { EventEmitter } from 'node:events';
@@ -2522,6 +2523,43 @@ declare class Agent<TProvider extends {
     _INTERNAL_setVoltAgentExporter(exporter: VoltAgentExporter): void;
 }
 
+/**
+ * HTTP methods supported by custom endpoints
+ */
+type HttpMethod = "get" | "post" | "put" | "patch" | "delete" | "options" | "head";
+/**
+ * Handler function for custom endpoints
+ */
+type CustomEndpointHandler = (c: Context) => Promise<Response> | Response;
+/**
+ * Definition for a custom endpoint
+ */
+interface CustomEndpointDefinition {
+    /**
+     * The path for the endpoint, relative to the API root
+     * Example: "/custom-endpoint" or "/custom/:param"
+     */
+    path: string;
+    /**
+     * The HTTP method for the endpoint
+     */
+    method: HttpMethod;
+    /**
+     * The handler function for the endpoint
+     */
+    handler: CustomEndpointHandler;
+    /**
+     * Optional description for the endpoint
+     */
+    description?: string;
+}
+/**
+ * Error thrown when a custom endpoint definition is invalid
+ */
+declare class CustomEndpointError extends Error {
+    constructor(message: string);
+}
+
 /**
  * Enum defining the next action to take after a reasoning step.
  */
@@ -3220,13 +3258,30 @@ declare class AgentRegistry {
     getGlobalVoltAgentExporter(): VoltAgentExporter | undefined;
 }
 
+/**
+ * Register a single custom endpoint with the API server
+ * @param endpoint The custom endpoint definition
+ * @throws CustomEndpointError if the endpoint definition is invalid or registration fails
+ */
+declare function registerCustomEndpoint(endpoint: CustomEndpointDefinition): void;
+/**
+ * Register multiple custom endpoints with the API server
+ * @param endpoints Array of custom endpoint definitions
+ * @throws CustomEndpointError if any endpoint definition is invalid or registration fails
+ */
+declare function registerCustomEndpoints(endpoints: CustomEndpointDefinition[]): void;
+
 type VoltAgentOptions = {
     agents: Record<string, Agent<any>>;
     port?: number;
     autoStart?: boolean;
     checkDependencies?: boolean;
     /**
-     * Optional OpenTelemetry SpanExporter instance or array of instances,
+     * Optional array of custom endpoint definitions to register with the API server
+     */
+    customEndpoints?: CustomEndpointDefinition[];
+    /**
+     * Optional OpenTelemetry SpanExporter instance or array of instances.
      * or a VoltAgentExporter instance or array of instances.
      * If provided, VoltAgent will attempt to initialize and register
      * a NodeTracerProvider with a BatchSpanProcessor for the given exporter(s).
@@ -3240,6 +3295,7 @@ type VoltAgentOptions = {
 declare class VoltAgent {
     private registry;
     private serverStarted;
+    private customEndpoints;
     constructor(options: VoltAgentOptions);
     /**
      * Check for dependency updates
@@ -3257,6 +3313,18 @@ declare class VoltAgent {
      * Start the server
      */
     startServer(): Promise<void>;
+    /**
+     * Register a custom endpoint with the API server
+     * @param endpoint The custom endpoint definition
+     * @throws Error if the endpoint definition is invalid or registration fails
+     */
+    registerCustomEndpoint(endpoint: CustomEndpointDefinition): void;
+    /**
+     * Register multiple custom endpoints with the API server
+     * @param endpoints Array of custom endpoint definitions
+     * @throws Error if any endpoint definition is invalid or registration fails
+     */
+    registerCustomEndpoints(endpoints: CustomEndpointDefinition[]): void;
     /**
      * Get all registered agents
      */
@@ -3273,4 +3341,4 @@ declare class VoltAgent {
     shutdownTelemetry(): Promise<void>;
 }
 
-export { Agent, AgentErrorEvent, AgentHistoryEntry, AgentHookOnEnd, AgentHookOnHandoff, AgentHookOnStart, AgentHookOnToolEnd, AgentHookOnToolStart, AgentHooks, AgentOptions, AgentRegistry, AgentResponse, AgentStartEvent, AgentStartEventMetadata, AgentSuccessEvent, AgentSuccessEventMetadata, AgentTool, AllowedVariableValue, AnyToolConfig, BaseEventMetadata, BaseLLMOptions, BaseMessage, BaseRetriever, BaseTimelineEvent, BaseTool, BaseToolCall, ClientInfo, Conversation, CreateConversationInput, CreateReasoningToolsOptions, DEFAULT_INSTRUCTIONS, DataContent, EventStatus, ExtractVariableNames, FEW_SHOT_EXAMPLES, FilePart, GenerateObjectOptions, GenerateTextOptions, HTTPServerConfig, HistoryStatus, ImagePart, InMemoryStorage, InferGenerateObjectResponse, InferGenerateTextResponse, InferMessage, InferModel, InferProviderParams, InferStreamResponse, InferTool, LLMProvider, LibSQLStorage, MCPClient, MCPClientConfig, MCPClientEvents, MCPConfiguration, MCPOptions, MCPServerConfig, MCPToolCall, MCPToolResult, Memory, MemoryEventMetadata, MemoryManager, MemoryMessage, MemoryOptions, MemoryReadErrorEvent, MemoryReadStartEvent, MemoryReadSuccessEvent, MemoryWriteErrorEvent, MemoryWriteStartEvent, MemoryWriteSuccessEvent, MessageContent, MessageFilterOptions, MessageRole, ModelToolCall, NewTimelineEvent, NextAction, NodeType, OnEndHookArgs, OnHandoffHookArgs, OnStartHookArgs, OnToolEndHookArgs, OnToolStartHookArgs, OperationContext, PackageUpdateInfo, PromptCreator, PromptTemplate, ProviderObjectResponse, ProviderObjectStreamResponse, ProviderParams, ProviderResponse, ProviderTextResponse, ProviderTextStreamResponse, ReadableStreamType, ReasoningStep, ReasoningStepSchema, ReasoningToolExecuteOptions, Retriever, RetrieverErrorEvent, RetrieverOptions, RetrieverStartEvent, RetrieverSuccessEvent, RetryConfig, StandardEventData, StandardTimelineEvent, StdioServerConfig, StepChunkCallback, StepFinishCallback, StepWithContent, StreamObjectFinishResult, StreamObjectOnFinishCallback, StreamObjectOptions, StreamTextFinishResult, StreamTextOnFinishCallback, StreamTextOptions, TemplateVariables, TextPart, TimelineEventCoreLevel, TimelineEventCoreStatus, TimelineEventCoreType, Tool, ToolCall, ToolErrorEvent, ToolErrorInfo, ToolExecuteOptions, ToolExecutionContext, ToolManager, ToolOptions, ToolSchema, ToolStartEvent, ToolStatus, ToolStatusInfo, ToolSuccessEvent, Toolkit, ToolsetMap, ToolsetWithTools, TransportError, Usage, UsageInfo, Voice, VoiceEventData, VoiceEventType, VoiceMetadata, VoiceOptions, VoltAgent, VoltAgentError, VoltAgentExporter, VoltAgentExporterOptions, checkForUpdates, createHooks, createNodeId, createPrompt, createReasoningTools, createRetrieverTool, createTool, createToolkit, VoltAgent as default, getNodeTypeFromNodeId, safeJsonParse, serializeValueForDebug, tool, updateAllPackages, updateSinglePackage, zodSchemaToJsonUI };
+export { Agent, AgentErrorEvent, AgentHistoryEntry, AgentHookOnEnd, AgentHookOnHandoff, AgentHookOnStart, AgentHookOnToolEnd, AgentHookOnToolStart, AgentHooks, AgentOptions, AgentRegistry, AgentResponse, AgentStartEvent, AgentStartEventMetadata, AgentSuccessEvent, AgentSuccessEventMetadata, AgentTool, AllowedVariableValue, AnyToolConfig, BaseEventMetadata, BaseLLMOptions, BaseMessage, BaseRetriever, BaseTimelineEvent, BaseTool, BaseToolCall, ClientInfo, Conversation, CreateConversationInput, CreateReasoningToolsOptions, CustomEndpointDefinition, CustomEndpointError, CustomEndpointHandler, DEFAULT_INSTRUCTIONS, DataContent, EventStatus, ExtractVariableNames, FEW_SHOT_EXAMPLES, FilePart, GenerateObjectOptions, GenerateTextOptions, HTTPServerConfig, HistoryStatus, HttpMethod, ImagePart, InMemoryStorage, InferGenerateObjectResponse, InferGenerateTextResponse, InferMessage, InferModel, InferProviderParams, InferStreamResponse, InferTool, LLMProvider, LibSQLStorage, MCPClient, MCPClientConfig, MCPClientEvents, MCPConfiguration, MCPOptions, MCPServerConfig, MCPToolCall, MCPToolResult, Memory, MemoryEventMetadata, MemoryManager, MemoryMessage, MemoryOptions, MemoryReadErrorEvent, MemoryReadStartEvent, MemoryReadSuccessEvent, MemoryWriteErrorEvent, MemoryWriteStartEvent, MemoryWriteSuccessEvent, MessageContent, MessageFilterOptions, MessageRole, ModelToolCall, NewTimelineEvent, NextAction, NodeType, OnEndHookArgs, OnHandoffHookArgs, OnStartHookArgs, OnToolEndHookArgs, OnToolStartHookArgs, OperationContext, PackageUpdateInfo, PromptCreator, PromptTemplate, ProviderObjectResponse, ProviderObjectStreamResponse, ProviderParams, ProviderResponse, ProviderTextResponse, ProviderTextStreamResponse, ReadableStreamType, ReasoningStep, ReasoningStepSchema, ReasoningToolExecuteOptions, Retriever, RetrieverErrorEvent, RetrieverOptions, RetrieverStartEvent, RetrieverSuccessEvent, RetryConfig, StandardEventData, StandardTimelineEvent, StdioServerConfig, StepChunkCallback, StepFinishCallback, StepWithContent, StreamObjectFinishResult, StreamObjectOnFinishCallback, StreamObjectOptions, StreamTextFinishResult, StreamTextOnFinishCallback, StreamTextOptions, TemplateVariables, TextPart, TimelineEventCoreLevel, TimelineEventCoreStatus, TimelineEventCoreType, Tool, ToolCall, ToolErrorEvent, ToolErrorInfo, ToolExecuteOptions, ToolExecutionContext, ToolManager, ToolOptions, ToolSchema, ToolStartEvent, ToolStatus, ToolStatusInfo, ToolSuccessEvent, Toolkit, ToolsetMap, ToolsetWithTools, TransportError, Usage, UsageInfo, Voice, VoiceEventData, VoiceEventType, VoiceMetadata, VoiceOptions, VoltAgent, VoltAgentError, VoltAgentExporter, VoltAgentExporterOptions, checkForUpdates, createHooks, createNodeId, createPrompt, createReasoningTools, createRetrieverTool, createTool, createToolkit, VoltAgent as default, getNodeTypeFromNodeId, registerCustomEndpoint, registerCustomEndpoints, safeJsonParse, serializeValueForDebug, tool, updateAllPackages, updateSinglePackage, zodSchemaToJsonUI };