@agentrun/sdk 0.0.3 → 0.0.4

package/dist/model-DGBy-o_L.d.cts

@@ -0,0 +1,176 @@
+/**
+ * Server Core Data Models
+ *
+ * 此模块定义 Server 相关的所有数据模型。
+ * This module defines all data models related to Server.
+ */
+/**
+ * Message role enum
+ */
+declare enum MessageRole {
+    SYSTEM = "system",
+    USER = "user",
+    ASSISTANT = "assistant",
+    TOOL = "tool"
+}
+/**
+ * Event type enum for AgentEvent (Protocol agnostic)
+ *
+ * 定义核心事件类型，框架会自动转换为对应协议格式（OpenAI、AG-UI 等）。
+ */
+declare enum EventType {
+    TEXT = "TEXT",// 文本内容块
+    TOOL_CALL = "TOOL_CALL",// 完整工具调用（含 id, name, args）
+    TOOL_CALL_CHUNK = "TOOL_CALL_CHUNK",// 工具调用参数片段（流式场景）
+    TOOL_RESULT = "TOOL_RESULT",// 工具执行结果
+    TOOL_RESULT_CHUNK = "TOOL_RESULT_CHUNK",// 工具执行结果片段（流式输出场景）
+    ERROR = "ERROR",// 错误事件
+    STATE = "STATE",// 状态更新（快照或增量）
+    HITL = "HITL",// Human-in-the-Loop，请求人类介入
+    CUSTOM = "CUSTOM",// 自定义事件
+    RAW = "RAW"
+}
+/**
+ * Tool call definition
+ */
+interface ToolCall {
+    id: string;
+    type?: string;
+    function: {
+        name: string;
+        arguments: string;
+    };
+}
+/**
+ * Tool definition
+ */
+interface Tool {
+    type: string;
+    function: {
+        name: string;
+        description?: string;
+        parameters?: Record<string, unknown>;
+    };
+}
+/**
+ * Message in a conversation
+ */
+interface Message {
+    id?: string;
+    role: MessageRole;
+    content?: string | Array<Record<string, unknown>>;
+    name?: string;
+    toolCalls?: ToolCall[];
+    toolCallId?: string;
+}
+/**
+ * Agent request
+ */
+interface AgentRequest {
+    /** Protocol name */
+    protocol?: string;
+    /** Messages in the conversation */
+    messages: Message[];
+    /** Whether to stream the response */
+    stream?: boolean;
+    /** Model to use */
+    model?: string;
+    /** Available tools */
+    tools?: Tool[];
+    /** Additional metadata */
+    metadata?: Record<string, unknown>;
+    /** Raw HTTP request (for accessing headers, etc.) */
+    rawRequest?: unknown;
+}
+/**
+ * Merge options for addition field
+ */
+interface MergeOptions {
+    noNewField?: boolean;
+    concatList?: boolean;
+    ignoreEmptyList?: boolean;
+}
+/**
+ * Agent event (for streaming)
+ *
+ * 标准化的事件结构，协议无关设计。
+ * 框架层会自动将 AgentEvent 转换为对应协议的格式（OpenAI、AG-UI 等）。
+ */
+interface AgentEvent {
+    /** Event type */
+    event: EventType;
+    /** Event data */
+    data?: Record<string, unknown>;
+    /** Additional fields for protocol extension */
+    addition?: Record<string, unknown>;
+    /** Merge options for addition */
+    additionMergeOptions?: MergeOptions;
+}
+/**
+ * Agent result (alias for AgentEvent)
+ */
+type AgentResult = AgentEvent;
+/**
+ * Agent event item (can be string or AgentEvent)
+ */
+type AgentEventItem = string | AgentEvent;
+/**
+ * Protocol configuration base
+ */
+interface ProtocolConfig {
+    prefix?: string;
+    enable?: boolean;
+}
+/**
+ * OpenAI protocol configuration
+ */
+interface OpenAIProtocolConfig extends ProtocolConfig {
+    modelName?: string;
+}
+/**
+ * AG-UI protocol configuration
+ */
+interface AGUIProtocolConfig extends ProtocolConfig {
+}
+/**
+ * Server configuration
+ */
+interface ServerConfig {
+    /** OpenAI protocol config */
+    openai?: OpenAIProtocolConfig;
+    /** AG-UI protocol config */
+    agui?: AGUIProtocolConfig;
+    /** CORS origins */
+    corsOrigins?: string[];
+    /** Port to listen on */
+    port?: number;
+    /** Host to listen on */
+    host?: string;
+}
+/**
+ * Protocol request interface (framework agnostic)
+ */
+interface ProtocolRequest {
+    body: Record<string, unknown>;
+    headers: Record<string, string>;
+    method: string;
+    url: string;
+    query?: Record<string, string>;
+}
+/**
+ * Protocol response interface
+ */
+interface ProtocolResponse {
+    status: number;
+    headers: Record<string, string>;
+    body: string | AsyncIterable<string>;
+}
+/**
+ * Invoke options for AgentInvoker
+ */
+interface InvokeOptions {
+    signal?: AbortSignal;
+    timeout?: number;
+}
+
+export { type AGUIProtocolConfig as A, EventType as E, type InvokeOptions as I, type Message as M, type OpenAIProtocolConfig as O, type ProtocolConfig as P, type ServerConfig as S, type Tool as T, type AgentEvent as a, type AgentRequest as b, type AgentResult as c, MessageRole as d, type ProtocolRequest as e, type ProtocolResponse as f, type ToolCall as g, type AgentEventItem as h, type MergeOptions as i };

package/dist/model-DGBy-o_L.d.ts

@@ -0,0 +1,176 @@
+/**
+ * Server Core Data Models
+ *
+ * 此模块定义 Server 相关的所有数据模型。
+ * This module defines all data models related to Server.
+ */
+/**
+ * Message role enum
+ */
+declare enum MessageRole {
+    SYSTEM = "system",
+    USER = "user",
+    ASSISTANT = "assistant",
+    TOOL = "tool"
+}
+/**
+ * Event type enum for AgentEvent (Protocol agnostic)
+ *
+ * 定义核心事件类型，框架会自动转换为对应协议格式（OpenAI、AG-UI 等）。
+ */
+declare enum EventType {
+    TEXT = "TEXT",// 文本内容块
+    TOOL_CALL = "TOOL_CALL",// 完整工具调用（含 id, name, args）
+    TOOL_CALL_CHUNK = "TOOL_CALL_CHUNK",// 工具调用参数片段（流式场景）
+    TOOL_RESULT = "TOOL_RESULT",// 工具执行结果
+    TOOL_RESULT_CHUNK = "TOOL_RESULT_CHUNK",// 工具执行结果片段（流式输出场景）
+    ERROR = "ERROR",// 错误事件
+    STATE = "STATE",// 状态更新（快照或增量）
+    HITL = "HITL",// Human-in-the-Loop，请求人类介入
+    CUSTOM = "CUSTOM",// 自定义事件
+    RAW = "RAW"
+}
+/**
+ * Tool call definition
+ */
+interface ToolCall {
+    id: string;
+    type?: string;
+    function: {
+        name: string;
+        arguments: string;
+    };
+}
+/**
+ * Tool definition
+ */
+interface Tool {
+    type: string;
+    function: {
+        name: string;
+        description?: string;
+        parameters?: Record<string, unknown>;
+    };
+}
+/**
+ * Message in a conversation
+ */
+interface Message {
+    id?: string;
+    role: MessageRole;
+    content?: string | Array<Record<string, unknown>>;
+    name?: string;
+    toolCalls?: ToolCall[];
+    toolCallId?: string;
+}
+/**
+ * Agent request
+ */
+interface AgentRequest {
+    /** Protocol name */
+    protocol?: string;
+    /** Messages in the conversation */
+    messages: Message[];
+    /** Whether to stream the response */
+    stream?: boolean;
+    /** Model to use */
+    model?: string;
+    /** Available tools */
+    tools?: Tool[];
+    /** Additional metadata */
+    metadata?: Record<string, unknown>;
+    /** Raw HTTP request (for accessing headers, etc.) */
+    rawRequest?: unknown;
+}
+/**
+ * Merge options for addition field
+ */
+interface MergeOptions {
+    noNewField?: boolean;
+    concatList?: boolean;
+    ignoreEmptyList?: boolean;
+}
+/**
+ * Agent event (for streaming)
+ *
+ * 标准化的事件结构，协议无关设计。
+ * 框架层会自动将 AgentEvent 转换为对应协议的格式（OpenAI、AG-UI 等）。
+ */
+interface AgentEvent {
+    /** Event type */
+    event: EventType;
+    /** Event data */
+    data?: Record<string, unknown>;
+    /** Additional fields for protocol extension */
+    addition?: Record<string, unknown>;
+    /** Merge options for addition */
+    additionMergeOptions?: MergeOptions;
+}
+/**
+ * Agent result (alias for AgentEvent)
+ */
+type AgentResult = AgentEvent;
+/**
+ * Agent event item (can be string or AgentEvent)
+ */
+type AgentEventItem = string | AgentEvent;
+/**
+ * Protocol configuration base
+ */
+interface ProtocolConfig {
+    prefix?: string;
+    enable?: boolean;
+}
+/**
+ * OpenAI protocol configuration
+ */
+interface OpenAIProtocolConfig extends ProtocolConfig {
+    modelName?: string;
+}
+/**
+ * AG-UI protocol configuration
+ */
+interface AGUIProtocolConfig extends ProtocolConfig {
+}
+/**
+ * Server configuration
+ */
+interface ServerConfig {
+    /** OpenAI protocol config */
+    openai?: OpenAIProtocolConfig;
+    /** AG-UI protocol config */
+    agui?: AGUIProtocolConfig;
+    /** CORS origins */
+    corsOrigins?: string[];
+    /** Port to listen on */
+    port?: number;
+    /** Host to listen on */
+    host?: string;
+}
+/**
+ * Protocol request interface (framework agnostic)
+ */
+interface ProtocolRequest {
+    body: Record<string, unknown>;
+    headers: Record<string, string>;
+    method: string;
+    url: string;
+    query?: Record<string, string>;
+}
+/**
+ * Protocol response interface
+ */
+interface ProtocolResponse {
+    status: number;
+    headers: Record<string, string>;
+    body: string | AsyncIterable<string>;
+}
+/**
+ * Invoke options for AgentInvoker
+ */
+interface InvokeOptions {
+    signal?: AbortSignal;
+    timeout?: number;
+}
+
+export { type AGUIProtocolConfig as A, EventType as E, type InvokeOptions as I, type Message as M, type OpenAIProtocolConfig as O, type ProtocolConfig as P, type ServerConfig as S, type Tool as T, type AgentEvent as a, type AgentRequest as b, type AgentResult as c, MessageRole as d, type ProtocolRequest as e, type ProtocolResponse as f, type ToolCall as g, type AgentEventItem as h, type MergeOptions as i };