@opentiny/tiny-robot-kit 0.4.2-alpha.4 → 0.4.2-alpha.5

package/dist/skillPlugin-4pC5SvPk.d.mts

@@ -1,548 +0,0 @@
-import { ChatCompletionMessageParam, ChatCompletionMessageToolCall, ChatCompletionFunctionTool, ChatCompletion, ChatCompletionChunk, ChatCompletionMessageFunctionToolCall, ChatCompletionSystemMessageParam } from 'openai/resources';
-import { S as SkillDefinition } from './types-ChCZ8jKB.mjs';
-
-/**
- * 模型Provider基类
- */
-declare abstract class BaseModelProvider {
-    protected config: AIModelConfig;
-    /**
-     * @param config AI模型配置
-     */
-    constructor(config: AIModelConfig);
-    /**
-     * 发送聊天请求并获取响应
-     * @param request 聊天请求参数
-     * @returns 聊天响应
-     */
-    abstract chat(request: ChatCompletionRequest): Promise<ChatCompletionResponse>;
-    /**
-     * 发送流式聊天请求并通过处理器处理响应
-     * @param request 聊天请求参数
-     * @param handler 流式响应处理器
-     */
-    abstract chatStream(request: ChatCompletionRequest, handler: StreamHandler): Promise<void>;
-    /**
-     * 更新配置
-     * @param config 新的AI模型配置
-     */
-    updateConfig(config: AIModelConfig): void;
-    /**
-     * 获取当前配置
-     * @returns AI模型配置
-     */
-    getConfig(): AIModelConfig;
-    /**
-     * 验证请求参数
-     * @param request 聊天请求参数
-     */
-    protected validateRequest(request: ChatCompletionRequest): void;
-}
-
-type MaybePromise<T> = T | Promise<T>;
-/**
- * 消息角色类型
- */
-type MessageRole = 'system' | 'user' | 'assistant';
-interface ToolCall {
-    index: number;
-    id: string;
-    type: 'function';
-    function: {
-        name: string;
-        arguments: string;
-        result?: string;
-    };
-}
-interface MessageMetadata {
-    createdAt?: number;
-    updatedAt?: number;
-    id?: string;
-    model?: string;
-    [key: string]: any;
-}
-/**
- * 聊天消息接口
- */
-interface ChatMessage$1 {
-    role: string;
-    content: string;
-    reasoning_content?: string;
-    metadata?: MessageMetadata;
-    tool_calls?: ToolCall[];
-    tool_call_id?: string;
-    [key: string]: any;
-    [key: symbol]: any;
-}
-/**
- * 聊天历史记录
- */
-type ChatHistory = ChatMessage$1[];
-/**
- * 聊天完成请求选项
- */
-interface ChatCompletionOptions {
-    model?: string;
-    temperature?: number;
-    top_p?: number;
-    n?: number;
-    stream?: boolean;
-    max_tokens?: number;
-    signal?: AbortSignal;
-}
-/**
- * 聊天完成请求参数
- */
-interface ChatCompletionRequest {
-    messages: ChatMessage$1[];
-    options?: ChatCompletionOptions;
-}
-/**
- * 聊天完成响应消息
- */
-interface ChatCompletionResponseMessage {
-    role: MessageRole;
-    content: string;
-    [x: string]: unknown;
-}
-/**
- * 聊天完成响应选择
- */
-interface ChatCompletionResponseChoice {
-    index: number;
-    message: ChatCompletionResponseMessage;
-    finish_reason: string;
-}
-/**
- * 聊天完成响应使用情况
- */
-interface ChatCompletionResponseUsage {
-    prompt_tokens: number;
-    completion_tokens: number;
-    total_tokens: number;
-}
-/**
- * 聊天完成响应
- */
-interface ChatCompletionResponse {
-    id: string;
-    object: string;
-    created: number;
-    model: string;
-    choices: ChatCompletionResponseChoice[];
-    usage: ChatCompletionResponseUsage;
-}
-/**
- * 流式聊天完成响应增量
- */
-interface ChatCompletionStreamResponseDelta {
-    content?: string;
-    role?: MessageRole;
-    [x: string]: unknown;
-}
-/**
- * 流式聊天完成响应选择
- */
-interface ChatCompletionStreamResponseChoice {
-    index: number;
-    delta: ChatCompletionStreamResponseDelta;
-    finish_reason: string | null;
-}
-/**
- * 流式聊天完成响应
- */
-interface ChatCompletionStreamResponse {
-    id: string;
-    object: string;
-    created: number;
-    model: string;
-    choices: ChatCompletionStreamResponseChoice[];
-}
-/**
- * AI模型提供商类型
- */
-type AIProvider = 'openai' | 'deepseek' | 'custom';
-/**
- * AI模型配置接口
- */
-interface AIModelConfig {
-    provider: AIProvider;
-    providerImplementation?: BaseModelProvider;
-    apiKey?: string;
-    apiUrl?: string;
-    apiVersion?: string;
-    defaultModel?: string;
-    defaultOptions?: ChatCompletionOptions;
-}
-/**
- * 错误类型
- */
-declare enum ErrorType {
-    NETWORK_ERROR = "network_error",
-    AUTHENTICATION_ERROR = "authentication_error",
-    RATE_LIMIT_ERROR = "rate_limit_error",
-    SERVER_ERROR = "server_error",
-    MODEL_ERROR = "model_error",
-    TIMEOUT_ERROR = "timeout_error",
-    UNKNOWN_ERROR = "unknown_error"
-}
-/**
- * AI适配器错误
- */
-interface AIAdapterError {
-    type: ErrorType;
-    message: string;
-    statusCode?: number;
-    originalError?: object;
-}
-/**
- * 流式响应事件类型
- */
-declare enum StreamEventType {
-    DATA = "data",
-    ERROR = "error",
-    DONE = "done"
-}
-/**
- * 流式响应处理器
- */
-interface StreamHandler {
-    onData: (data: ChatCompletionStreamResponse) => void;
-    onError: (error: AIAdapterError) => void;
-    onDone: (finishReason?: string) => void;
-}
-
-type DeepReadonly<T> = T extends (...args: any[]) => any ? T : T extends Array<infer U> ? ReadonlyArray<DeepReadonly<U>> : T extends object ? {
-    readonly [K in keyof T]: DeepReadonly<T[K]>;
-} : T;
-type RequestState = 'idle' | 'processing' | 'completed' | 'aborted' | 'error';
-type RequestProcessingState = 'requesting' | 'completing' | string;
-type ChatMessage<Metadata extends object = Record<string, unknown>, State extends object = Record<string, unknown>> = ChatCompletionMessageParam & {
-    tool_calls?: Array<ChatCompletionMessageToolCall>;
-    loading?: boolean;
-    metadata?: Metadata;
-    state?: State;
-    [key: string]: any;
-};
-interface MessageRequestBody {
-    messages: Array<ChatMessage>;
-    tools?: Array<ChatCompletionFunctionTool>;
-    [key: string]: any;
-}
-type ResponseProvider<T extends ChatCompletion | ChatCompletionChunk = ChatCompletion | ChatCompletionChunk> = (requestBody: MessageRequestBody, abortSignal: AbortSignal) => Promise<T> | AsyncGenerator<T> | Promise<AsyncGenerator<T>>;
-interface PublicMessageState {
-    requestState: RequestState;
-    processingState?: RequestProcessingState;
-    messages: ChatMessage[];
-    isProcessing: boolean;
-}
-interface InternalMessageState {
-    requestState: RequestState;
-    processingState?: RequestProcessingState;
-    messages: ChatMessage[];
-}
-interface MessageRuntime {
-    currentTurn: ChatMessage[];
-    customContext: Record<string, unknown>;
-    abortController: AbortController | null;
-    responseProvider: ResponseProvider;
-}
-interface MessageEngine {
-    getState(): PublicMessageState;
-    subscribe(listener: (state: PublicMessageState) => void): () => void;
-    subscribe(kinds: MessageUpdateKinds, listener: (state: PublicMessageState) => void): () => void;
-    sendMessage(content: string): Promise<void>;
-    send(...msgs: ChatMessage[]): Promise<void>;
-    abort(): Promise<void>;
-    setResponseProvider(provider: ResponseProvider): void;
-}
-type MessageUpdateKind = 'messages' | 'requestState';
-type MessageUpdateKinds = MessageUpdateKind | MessageUpdateKind[];
-type MessageMutationRecipe = (draft: InternalMessageState, skipNotify: () => void) => void;
-interface MutateMessageStateFn {
-    /**
-     * 在受控上下文中修改消息状态，并按声明的更新类型分发状态变更通知。
-     *
-     * 这里的“通知”语义对应 `subscribe` 订阅链路，用于驱动依赖 engine 状态快照的观察者；
-     * 它并不等同于具体框架的响应式更新机制。对于 Vue 等运行时，界面更新可能同时依赖
-     * 框架自身的响应式追踪与 `subscribe` 侧的状态通知，两者职责不同，不应混用。
-     */
-    (kinds: MessageUpdateKinds, recipe: MessageMutationRecipe): void;
-}
-interface MessageStateAdapter {
-    initialize(initialState: InternalMessageState): void;
-    getState(): PublicMessageState;
-    /**
-     * 创建一条适配当前运行时的消息对象。
-     *
-     * engine 和 core 插件里凡是“新建消息”的入口，都应统一走这个方法，
-     * 以便不同平台注入各自的运行时能力。
-     *
-     * 例如：
-     * - native/纯 TS 场景：直接返回原对象即可
-     *   `createMessage(message) { return message }`
-     * - Vue 场景：返回 reactive proxy，使后续对 message.content / message.state 的原地修改能够被追踪
-     *   `createMessage(message) { return reactive(message) }`
-     */
-    createMessage<T extends ChatMessage>(message: T): T;
-    mutate: MutateMessageStateFn;
-    subscribe(listener: (state: PublicMessageState) => void): () => void;
-    subscribe(kinds: MessageUpdateKinds, listener: (state: PublicMessageState) => void): () => void;
-}
-interface BasePluginContext {
-    getState(): PublicMessageState;
-    /**
-     * 创建一条适配当前运行时的消息对象。
-     *
-     * 插件在运行过程中如果需要主动创建并追加消息，应统一通过此接口构造消息实例，
-     * 而不是直接持有普通对象字面量。这样可以确保消息对象具备当前平台所要求的运行时能力。
-     *
-     * 对于采用响应式机制的平台（例如 Vue），该接口通常会返回带有响应式包装的消息实例。
-     * 如果插件绕过此接口直接创建普通对象，再参与后续的状态更新或原地字段修改，
-     * 可能导致消息内容、状态字段等变更无法被正确追踪。
-     */
-    createMessage<T extends ChatMessage>(message: T): T;
-    /**
-     * 在受控上下文中修改状态，并触发与 `subscribe` 对应的状态更新通知。
-     *
-     * 该通知机制面向 engine 的订阅接口，而不是具体框架的响应式系统本身。
-     * 因此，在需要让 `subscribe` 观察者感知到变更时，应通过此接口完成状态写入。
-     */
-    mutate: MutateMessageStateFn;
-    abortSignal: AbortSignal;
-    currentTurn: ChatMessage[];
-    /**
-     * 当前 engine 中已注册的插件列表。
-     *
-     * 插件可基于该列表发现其他插件暴露的轻量协议，例如 toolPlugin 收集 provideTools。
-     */
-    plugins: readonly MessageEnginePlugin[];
-    customContext: Record<string, unknown>;
-    setRequestState: (state: RequestState, processingState?: RequestProcessingState) => void;
-    setCustomContext: (data: Record<string, unknown>) => void;
-}
-interface BeforeRequestContext extends BasePluginContext {
-    requestBody: MessageRequestBody;
-}
-interface AfterRequestContext extends BasePluginContext {
-    currentMessage: DeepReadonly<ChatMessage>;
-    lastChoice?: ChatCompletion.Choice | ChatCompletionChunk.Choice;
-    /**
-     * 使用 appendMessage 函数追加消息，可触发消息更新通知。
-     */
-    appendMessage: (message: ChatMessage | ChatMessage[]) => void;
-    requestNext: () => void;
-}
-interface CompletionChunkContext extends BasePluginContext {
-    /**
-     * 当前消息，只读。需要使用 updateCurrentMessage 函数修改当前消息，才能正常触发消息更新通知。
-     */
-    currentMessage: DeepReadonly<ChatMessage>;
-    /**
-     * 使用 updateCurrentMessage 函数修改当前消息，才能正常触发消息更新通知。
-     */
-    updateCurrentMessage: (recipe: (message: ChatMessage) => void) => void;
-    choice: ChatCompletion.Choice | ChatCompletionChunk.Choice;
-    chunk: ChatCompletion | ChatCompletionChunk;
-}
-interface MessageEnginePlugin {
-    /**
-     * 插件名称。
-     */
-    name?: string;
-    /**
-     * 是否禁用插件。
-     */
-    disabled?: boolean | ((context: BasePluginContext) => boolean);
-    /**
-     * 一次对话回合（turn）开始钩子：用户消息入队后、正式发起请求之前触发。
-     * 按插件注册顺序串行执行，便于做有序初始化/校验；出错则中断流程。
-     */
-    onTurnStart?: (context: BasePluginContext) => MaybePromise<void>;
-    /**
-     * 一次对话回合（turn）结束的生命周期钩子。
-     * 触发时机：本轮对话完成（成功、被中止）后。
-     * 执行策略：按插件注册顺序串行执行，有错误则中断流程。
-     */
-    onTurnEnd?: (context: BasePluginContext) => MaybePromise<void>;
-    /**
-     * 请求开始前的生命周期钩子。
-     * 触发时机：已组装 requestBody，正式发起请求之前。
-     * 执行策略：按插件注册顺序串行执行，避免并发修改 requestBody 产生冲突。
-     */
-    onBeforeRequest?: (context: BeforeRequestContext) => MaybePromise<void>;
-    /**
-     * 请求完成后的生命周期钩子。
-     * 触发时机：本次请求（含流式）结束后。
-     * 执行策略：并行执行（Promise.all）。
-     */
-    onAfterRequest?: (context: AfterRequestContext) => MaybePromise<void>;
-    /**
-     * 数据块处理钩子，在接收到每个响应数据块时触发。
-     * 无论是流式响应（多个增量数据块）还是非流式响应（单个完整数据块），都会触发此钩子。
-     */
-    onCompletionChunk?: (context: CompletionChunkContext) => void;
-    onError?: (context: BasePluginContext & {
-        error: unknown;
-    }) => void;
-    onFinally?: (context: BasePluginContext) => void;
-}
-interface CreateMessageEngineOptions {
-    initialMessages?: ChatMessage[];
-    /**
-     * 请求消息时，要包含的字段（白名单）。默认包含所有字段。
-     * 如果 `requestMessageFieldsExclude` 存在，会先取 `requestMessageFields` 中的字段，再排除 `requestMessageFieldsExclude` 中的字段
-     */
-    requestMessageFields?: string[];
-    /**
-     * 请求消息时，要排除的字段（黑名单）。默认会排除 `state`、`metadata`、`loading` 字段（这几个字段是给UI展示用的）。
-     * 如果 `requestMessageFields` 存在，会先取 `requestMessageFields` 中的字段，再排除 `requestMessageFieldsExclude` 中的字段
-     */
-    requestMessageFieldsExclude?: string[];
-    responseProvider?: ResponseProvider;
-    /**
-     * 全局的数据块处理钩子，在接收到每个响应数据块时触发。
-     * 注意：此钩子与插件中的 onCompletionChunk 有区别。
-     * 如果传入了此参数，默认的 chunk 处理逻辑不会自动执行，需要手动调用 runDefault 来执行默认处理逻辑。
-     */
-    onCompletionChunk?: (context: CompletionChunkContext, runDefault: () => void) => void;
-    plugins?: MessageEnginePlugin[];
-}
-
-type AssistantMessageWithState = ChatMessage<Record<string, unknown>, {
-    toolCall?: Record<string, Record<string, unknown>>;
-}>;
-type ToolSource = {
-    type: 'toolPlugin';
-} | {
-    type: 'toolProvider';
-    pluginName?: string;
-} | {
-    type: 'unknown';
-};
-type ToolCallContext = BasePluginContext & {
-    assistantMessage: AssistantMessageWithState;
-    toolMessage: ChatMessage;
-    /**
-     * 当前工具的来源。
-     */
-    toolSource: ToolSource;
-};
-type ToolCallResult = string | Record<string, any>;
-type ToolCallReturn = ToolCallResult | Promise<ToolCallResult> | AsyncGenerator<ToolCallResult>;
-interface RuntimeTool {
-    tool: ChatCompletionFunctionTool;
-    handler: (toolCall: ChatCompletionMessageFunctionToolCall, context: ToolCallContext) => ToolCallReturn;
-}
-type ToolProviderItem = ChatCompletionFunctionTool | RuntimeTool;
-interface ToolProvider {
-    provideTools: (context: BasePluginContext) => MaybePromise<ToolProviderItem[]>;
-}
-declare const toolPlugin: (options: MessageEnginePlugin & {
-    /**
-     * 获取本轮可用工具。可以返回普通 tool schema，也可以返回带执行函数的 runtime tool。
-     */
-    getTools: (context: BasePluginContext) => MaybePromise<ToolProviderItem[]>;
-    /**
-     * 在处理包含 tool_calls 的响应前调用。
-     */
-    beforeCallTools?: (toolCalls: ChatCompletionMessageToolCall[], context: BasePluginContext & {
-        assistantMessage: AssistantMessageWithState;
-    }) => Promise<void>;
-    /**
-     * 执行单个工具调用并返回其文本结果的函数。
-     */
-    callTool: (toolCall: ChatCompletionMessageToolCall, context: ToolCallContext) => Promise<ToolCallResult> | AsyncGenerator<ToolCallResult>;
-    /**
-     * 工具调用开始时的回调函数。
-     * 触发时机：工具消息已创建并追加后，调用 callTool 之前触发。
-     * @param toolCall - 工具调用对象
-     * @param context - 插件上下文，包含当前工具消息
-     */
-    onToolCallStart?: (toolCall: ChatCompletionMessageToolCall, context: ToolCallContext) => void;
-    /**
-     * 工具调用结束时的回调函数。
-     * 触发时机：工具调用完成（成功、失败或取消）时触发。
-     * @param toolCall - 工具调用对象
-     * @param context - 插件上下文，包含当前工具消息、状态和错误信息
-     * @param context.status - 工具调用状态：'success' | 'failed' | 'cancelled'
-     * @param context.error - 当状态为 'failed' 或 'cancelled' 时，可能包含错误信息
-     */
-    onToolCallEnd?: (toolCall: ChatCompletionMessageToolCall, context: ToolCallContext & {
-        status: "success" | "failed" | "cancelled";
-        error?: Error;
-    }) => void;
-    /**
-     * 当请求被中止时用于工具调用取消的消息内容。
-     */
-    toolCallCancelledContent?: string;
-    /**
-     * 当工具调用执行失败（抛错或拒绝）时使用的消息内容。
-     */
-    toolCallFailedContent?: string;
-    /**
-     * 是否在请求前自动补充缺失的 tool 消息。
-     * 当 assistant 响应了 tool_calls 但未追加对应的 tool 消息时，
-     * 插件将自动补充"工具调用已取消"的 tool 消息。默认：false。
-     */
-    autoFillMissingToolMessages?: boolean;
-}) => MessageEnginePlugin;
-
-type SkillCommandRequest = {
-    skillName: string;
-    command: string;
-    args: string[];
-    skill: SkillDefinition;
-};
-type SkillCommandResult = string | Record<string, unknown>;
-type SkillCommandExecutor = (request: SkillCommandRequest) => MaybePromise<SkillCommandResult>;
-type SkillRuntimeToolsOptions = {
-    /**
-     * @experimental 该 API 仍在设计和验证中，命令协议、返回结构和安全边界后续可能调整。
-     */
-    executeSkillCommand?: SkillCommandExecutor;
-};
-/**
- * 创建 skill 运行时工具。
- *
- * 默认只根据 skill 文件创建基础文件工具；传入 executeSkillCommand 时会额外创建命令执行工具。
- */
-declare const createSkillRuntimeTools: (skills: SkillDefinition[], options?: SkillRuntimeToolsOptions) => RuntimeTool[];
-declare const compileSkillInstructions: (skills: SkillDefinition[]) => Promise<ChatCompletionSystemMessageParam | undefined>;
-
-/**
- * Skill 插件的转换状态。
- *
- * 该状态会写入 customContext.__tiny_robot_skill，供消息钩子和插件回调读取同一份编译结果。
- */
-interface SkillPluginState {
-    skills: SkillDefinition[];
-    skillNames: string[];
-    runtimeTools: RuntimeTool[];
-}
-/**
- * 将已选择的 skills 转换为消息指令和工具的配置项。
- */
-type SkillPluginOptions = MessageEnginePlugin & {
-    /**
-     * 返回本次请求要使用的 skills。
-     *
-     * 插件只转换返回的 skills；选择、存储和集合管理由调用方负责。
-     */
-    getSkills?: (context: BasePluginContext) => MaybePromise<SkillDefinition[] | undefined>;
-    /**
-     * 执行模型为某个 skill 规划的后端命令。
-     *
-     * @experimental 该 API 仍在设计和验证中，命令协议、返回结构和安全边界后续可能调整。
-     *
-     * 插件只负责暴露 execute_skill_command 并转发参数；沙箱、镜像和权限控制由调用方实现。
-     */
-    executeSkillCommand?: (request: SkillCommandRequest, context: BasePluginContext) => MaybePromise<SkillCommandResult>;
-    /**
-     * skills 解析并规整为插件状态后触发。
-     */
-    onSkillsResolved?: (state: SkillPluginState, context: BasePluginContext) => MaybePromise<void>;
-};
-declare const skillPlugin: (options: SkillPluginOptions) => MessageEnginePlugin & ToolProvider;
-
-export { type ToolSource as $, type AIAdapterError as A, BaseModelProvider as B, type ChatCompletionOptions as C, type DeepReadonly as D, ErrorType as E, type MessageUpdateKind as F, type MessageUpdateKinds as G, type MutateMessageStateFn as H, type InternalMessageState as I, type RequestState as J, type ResponseProvider as K, type RuntimeTool as L, type MaybePromise as M, type SkillCommandRequest as N, type SkillCommandResult as O, type PublicMessageState as P, type SkillPluginOptions as Q, type RequestProcessingState as R, type SkillCommandExecutor as S, type SkillPluginState as T, type SkillRuntimeToolsOptions as U, StreamEventType as V, type StreamHandler as W, type ToolCall as X, type ToolCallContext as Y, type ToolProvider as Z, type ToolProviderItem as _, type AIModelConfig as a, compileSkillInstructions as a0, createSkillRuntimeTools as a1, skillPlugin as a2, toolPlugin as a3, type AIProvider as b, type AfterRequestContext as c, type BasePluginContext as d, type BeforeRequestContext as e, type ChatCompletionRequest as f, type ChatCompletionResponse as g, type ChatCompletionResponseChoice as h, type ChatCompletionResponseMessage as i, type ChatCompletionResponseUsage as j, type ChatCompletionStreamResponse as k, type ChatCompletionStreamResponseChoice as l, type ChatCompletionStreamResponseDelta as m, type ChatHistory as n, type ChatMessage as o, type ChatMessage$1 as p, type CompletionChunkContext as q, type CreateMessageEngineOptions as r, type MessageEngine as s, type MessageEnginePlugin as t, type MessageMetadata as u, type MessageMutationRecipe as v, type MessageRequestBody as w, type MessageRole as x, type MessageRuntime as y, type MessageStateAdapter as z };