@blueking/chat-helper 0.0.1-beta.17 → 0.0.1-beta.18

package/dist/mediator/index.d.ts

@@ -0,0 +1,2 @@
+export * from './type';
+export * from './use-mediator';

package/dist/mediator/type.d.ts

@@ -0,0 +1,50 @@
+import type { IAgentModule } from '../agent/use-agent';
+import type { IHttpModule } from '../http';
+import type { IMessageModule } from '../message';
+import type { ISessionModule } from '../session/use-session';
+/**
+ * 中介者模块接口
+ * 用于协调各个模块之间的通信，避免模块之间的直接依赖
+ */
+export interface IMediatorModule {
+    /**
+     * 获取 Agent 模块
+     * @returns Agent 模块实例或 null
+     */
+    agent: IAgentModule | null;
+    /**
+     * 获取 Http 模块
+     * @returns Http 模块实例或 null
+     */
+    http: IHttpModule | null;
+    /**
+     * 获取 Message 模块
+     * @returns Message 模块实例或 null
+     */
+    message: IMessageModule | null;
+    /**
+     * 获取 Session 模块
+     * @returns Session 模块实例或 null
+     */
+    session: ISessionModule | null;
+    /**
+     * 注册 Agent 模块
+     * @param agent - Agent 模块实例
+     */
+    registerAgent(agent: IAgentModule): void;
+    /**
+     * 注册 Http 模块
+     * @param http - Http 模块实例
+     */
+    registerHttp(http: IHttpModule): void;
+    /**
+     * 注册 Message 模块
+     * @param message - Message 模块实例
+     */
+    registerMessage(message: IMessageModule): void;
+    /**
+     * 注册 Session 模块
+     * @param session - Session 模块实例
+     */
+    registerSession(session: ISessionModule): void;
+}

package/dist/mediator/use-mediator.d.ts

@@ -0,0 +1,7 @@
+import type { IMediatorModule } from './type';
+/**
+ * 中介者模块
+ * 负责协调各个模块之间的通信，避免模块之间的循环依赖
+ */
+export declare const useMediator: () => IMediatorModule;
+export type { IMediatorModule } from './type';

package/dist/message/index.d.ts

@@ -0,0 +1,2 @@
+export * from './type';
+export * from './use-message';

package/dist/message/type.d.ts

@@ -0,0 +1,370 @@
+export declare enum ActivityType {
+    KnowledgeRag = "knowledge_rag",
+    ReferenceDocument = "reference_document"
+}
+export declare enum MessageRole {
+    Activity = "activity",
+    Assistant = "assistant",
+    Developer = "developer",
+    Guide = "guide",
+    Hidden = "hidden",
+    HiddenAssistant = "hidden-assistant",
+    HiddenGuide = "hidden-guide",
+    HiddenSystem = "hidden-system",
+    HiddenUser = "hidden-user",
+    Info = "info",
+    Pause = "pause",
+    Placeholder = "placeholder",
+    Reasoning = "reasoning",
+    System = "system",
+    TemplateAssistant = "template-assistant",
+    TemplateGuide = "template-guide",
+    TemplateHidden = "template-hidden",
+    TemplateSystem = "template-system",
+    TemplateUser = "template-user",
+    Tool = "tool",
+    User = "user"
+}
+export declare enum MessageStatus {
+    Complete = "complete",
+    Error = "error",
+    Pending = "pending",
+    Stop = "stop",
+    Streaming = "streaming"
+}
+export declare enum MessageType {
+    Binary = "binary",
+    Function = "function",
+    Text = "text"
+}
+export interface IActivityMessage extends IBaseMessage {
+    activityType: ActivityType;
+    content: IKnowledgeRag | IReferenceDocument;
+    role: MessageRole.Activity;
+}
+export interface IActivityMessageApi extends IBaseMessageApi {
+    activity_type: ActivityType;
+    content: IKnowledgeRagApi | IReferenceDocumentApi;
+    role: MessageRole.Activity;
+}
+export interface IAssistantMessage extends IBaseMessage {
+    content?: string;
+    role: MessageRole.Assistant;
+    toolCalls?: IToolCall[];
+}
+export interface IAssistantMessageApi extends IBaseMessageApi {
+    content?: string;
+    role: MessageRole.Assistant;
+    tool_calls?: IToolCallApi[];
+}
+export interface IBaseMessage {
+    id?: string;
+    messageId?: string;
+    name?: string;
+    role: MessageRole;
+    sessionCode?: string;
+    status: MessageStatus;
+}
+export interface IBaseMessageApi {
+    id?: string;
+    message_id?: string;
+    name?: string;
+    role: MessageRole;
+    session_code?: string;
+    status: MessageStatus;
+}
+export interface IBinaryInputContent {
+    data?: string;
+    filename?: string;
+    id?: string;
+    mimeType: string;
+    type: MessageType.Binary;
+    url?: string;
+}
+export interface IBinaryInputContentApi {
+    data?: string;
+    filename?: string;
+    id?: string;
+    mime_type: string;
+    type: MessageType.Binary;
+    url?: string;
+}
+export interface IContext {
+    description: string;
+    value: string;
+}
+export interface IContextApi {
+    description: string;
+    value: string;
+}
+export interface IDeveloperMessage extends IBaseMessage {
+    content: string;
+    role: MessageRole.Developer;
+}
+export interface IDeveloperMessageApi extends IBaseMessageApi {
+    content: string;
+    role: MessageRole.Developer;
+}
+export interface IFunctionCall {
+    arguments: string;
+    description?: string;
+    mcpName?: string;
+    name: string;
+}
+export interface IFunctionCallApi {
+    arguments: string;
+    description?: string;
+    mcp_name?: string;
+    name: string;
+}
+export interface IGuideMessage extends IBaseMessage {
+    content: string;
+    role: MessageRole.Guide;
+}
+export interface IGuideMessageApi extends IBaseMessageApi {
+    content: string;
+    role: MessageRole.Guide;
+}
+export interface IHiddenAssistantMessage extends IBaseMessage {
+    content: string;
+    role: MessageRole.HiddenAssistant;
+}
+export interface IHiddenAssistantMessageApi extends IBaseMessageApi {
+    content: string;
+    role: MessageRole.HiddenAssistant;
+}
+export interface IHiddenGuideMessage extends IBaseMessage {
+    content: string;
+    role: MessageRole.HiddenGuide;
+}
+export interface IHiddenGuideMessageApi extends IBaseMessageApi {
+    content: string;
+    role: MessageRole.HiddenGuide;
+}
+export interface IHiddenMessage extends IBaseMessage {
+    content: string;
+    role: MessageRole.Hidden;
+}
+export interface IHiddenMessageApi extends IBaseMessageApi {
+    content: string;
+    role: MessageRole.Hidden;
+}
+export interface IHiddenSystemMessage extends IBaseMessage {
+    content: string;
+    role: MessageRole.HiddenSystem;
+}
+export interface IHiddenSystemMessageApi extends IBaseMessageApi {
+    content: string;
+    role: MessageRole.HiddenSystem;
+}
+export interface IHiddenUserMessage extends IBaseMessage {
+    content: string;
+    role: MessageRole.HiddenUser;
+}
+export interface IHiddenUserMessageApi extends IBaseMessageApi {
+    content: string;
+    role: MessageRole.HiddenUser;
+}
+export interface IInfoMessage extends IBaseMessage {
+    content: string;
+    role: MessageRole.Info;
+}
+export interface IInfoMessageApi extends IBaseMessageApi {
+    content: string;
+    role: MessageRole.Info;
+}
+export type IInputContent = IBinaryInputContent | ITextInputContent;
+export type IInputContentApi = IBinaryInputContentApi | ITextInputContentApi;
+export interface IKnowledgeRag {
+    content: string;
+    referenceDocument: IReferenceDocument;
+}
+export interface IKnowledgeRagApi {
+    content: string;
+    reference_document: IReferenceDocumentApi;
+}
+export type IMessage = IActivityMessage | IAssistantMessage | IDeveloperMessage | IGuideMessage | IHiddenAssistantMessage | IHiddenGuideMessage | IHiddenMessage | IHiddenSystemMessage | IHiddenUserMessage | IInfoMessage | IPauseMessage | IPlaceholderMessage | IReasoningMessage | ISystemMessage | ITemplateAssistantMessage | ITemplateGuideMessage | ITemplateHiddenMessage | ITemplateSystemMessage | ITemplateUserMessage | IToolMessage | IUserMessage;
+export type IMessageApi = IActivityMessageApi | IAssistantMessageApi | IDeveloperMessageApi | IGuideMessageApi | IHiddenAssistantMessageApi | IHiddenGuideMessageApi | IHiddenMessageApi | IHiddenSystemMessageApi | IHiddenUserMessageApi | IInfoMessageApi | IPauseMessageApi | IPlaceholderMessageApi | IReasoningMessageApi | ISystemMessageApi | ITemplateAssistantMessageApi | ITemplateGuideMessageApi | ITemplateHiddenMessageApi | ITemplateSystemMessageApi | ITemplateUserMessageApi | IToolMessageApi | IUserMessageApi;
+/**
+ * 消息属性 - 用于传递引用内容或快捷键相关信息
+ * 该类型设计为灵活的结构，由外部调用方决定具体内容
+ */
+export interface IMessageProperty {
+    /** 其他扩展字段 */
+    [key: string]: unknown;
+    extra?: {
+        /** 其他扩展字段 */
+        [key: string]: unknown;
+        /** 引用内容，可以是字符串或结构化对象 */
+        cite?: string | {
+            data: Array<{
+                key: string;
+                value: string;
+            }>;
+            title: string;
+            type: string;
+        };
+        /** 快捷键命令 */
+        command?: string;
+        /** 上下文信息 */
+        context?: Array<Record<string, unknown>>;
+    };
+}
+export interface IPauseMessage extends IBaseMessage {
+    content: string;
+    role: MessageRole.Pause;
+}
+export interface IPauseMessageApi extends IBaseMessageApi {
+    content: string;
+    role: MessageRole.Pause;
+}
+export interface IPlaceholderMessage extends IBaseMessage {
+    content: string;
+    role: MessageRole.Placeholder;
+}
+export interface IPlaceholderMessageApi extends IBaseMessageApi {
+    content: string;
+    role: MessageRole.Placeholder;
+}
+export interface IReasoningMessage extends IBaseMessage {
+    content: string[];
+    duration?: number;
+    role: MessageRole.Reasoning;
+}
+export interface IReasoningMessageApi extends IBaseMessageApi {
+    content: string[];
+    duration?: number;
+    role: MessageRole.Reasoning;
+}
+export type IReferenceDocument = {
+    name: string;
+    originFileUrl?: string;
+    url: string;
+}[];
+export type IReferenceDocumentApi = {
+    name: string;
+    origin_file_url?: string;
+    url: string;
+}[];
+export interface IRunAgentInput {
+    context: IContext[];
+    forwardedProps: unknown;
+    messages: IMessage[];
+    parentRunId?: string;
+    runId: string;
+    state: unknown;
+    threadId: string;
+    tools: ITool[];
+}
+export interface IRunAgentInputApi {
+    context: IContextApi[];
+    forwarded_props: unknown;
+    messages: IMessageApi[];
+    parent_run_id?: string;
+    run_id: string;
+    state: unknown;
+    thread_id: string;
+    tools: IToolApi[];
+}
+export interface ISystemMessage extends IBaseMessage {
+    content: string;
+    role: MessageRole.System;
+}
+export interface ISystemMessageApi extends IBaseMessageApi {
+    content: string;
+    role: MessageRole.System;
+}
+export interface ITemplateAssistantMessage extends IBaseMessage {
+    content: string;
+    role: MessageRole.TemplateAssistant;
+}
+export interface ITemplateAssistantMessageApi extends IBaseMessageApi {
+    content: string;
+    role: MessageRole.TemplateAssistant;
+}
+export interface ITemplateGuideMessage extends IBaseMessage {
+    content: string;
+    role: MessageRole.TemplateGuide;
+}
+export interface ITemplateGuideMessageApi extends IBaseMessageApi {
+    content: string;
+    role: MessageRole.TemplateGuide;
+}
+export interface ITemplateHiddenMessage extends IBaseMessage {
+    content: string;
+    role: MessageRole.TemplateHidden;
+}
+export interface ITemplateHiddenMessageApi extends IBaseMessageApi {
+    content: string;
+    role: MessageRole.TemplateHidden;
+}
+export interface ITemplateSystemMessage extends IBaseMessage {
+    content: string;
+    role: MessageRole.TemplateSystem;
+}
+export interface ITemplateSystemMessageApi extends IBaseMessageApi {
+    content: string;
+    role: MessageRole.TemplateSystem;
+}
+export interface ITemplateUserMessage extends IBaseMessage {
+    content: string;
+    role: MessageRole.TemplateUser;
+}
+export interface ITemplateUserMessageApi extends IBaseMessageApi {
+    content: string;
+    role: MessageRole.TemplateUser;
+}
+export interface ITextInputContent {
+    text: string;
+    type: MessageType.Text;
+}
+export interface ITextInputContentApi {
+    text: string;
+    type: MessageType.Text;
+}
+export interface ITool {
+    description: string;
+    name: string;
+    parameters: unknown;
+}
+export interface IToolApi {
+    description: string;
+    name: string;
+    parameters: unknown;
+}
+export interface IToolCall {
+    function: IFunctionCall;
+    id: string;
+    type: MessageType.Function;
+}
+export interface IToolCallApi {
+    function: IFunctionCallApi;
+    id: string;
+    type: MessageType.Function;
+}
+export interface IToolMessage extends IBaseMessage {
+    content: string;
+    duration?: number;
+    error?: string;
+    role: MessageRole.Tool;
+    toolCallId: string;
+}
+export interface IToolMessageApi extends IBaseMessageApi {
+    content: string;
+    duration?: number;
+    error?: string;
+    role: MessageRole.Tool;
+    tool_call_id: string;
+}
+export interface IUserMessage extends IBaseMessage {
+    content: IInputContent[] | string;
+    /** 消息属性，用于传递引用内容或快捷键相关信息 */
+    property?: IMessageProperty;
+    role: MessageRole.User;
+}
+export interface IUserMessageApi extends IBaseMessageApi {
+    content: IInputContentApi[] | string;
+    /** 消息属性，用于传递引用内容或快捷键相关信息 */
+    property?: IMessageProperty;
+    role: MessageRole.User;
+}