@blueking/chat-helper 0.0.1-beta.9 → 0.0.3

package/dist/message/type.d.ts

@@ -1,18 +1,13 @@
-export declare enum MessageContentStatus {
-    Complete = "complete",
-    Error = "error",
-    Stop = "stop",
-    Streaming = "streaming"
-}
-export declare enum MessageContentType {
-    Image = "image",
-    ReferenceDocument = "reference_document",
-    Text = "text",
-    Thinking = "thinking",
-    ToolCall = "tool_call"
+import type { IFlowAgentResultCustomValue } from '../event/type';
+export declare enum ActivityType {
+    FlowAgent = "flow_agent",
+    KnowledgeRag = "knowledge_rag",
+    ReferenceDocument = "reference_document"
 }
 export declare enum MessageRole {
+    Activity = "activity",
     Assistant = "assistant",
+    Developer = "developer",
     Guide = "guide",
     Hidden = "hidden",
     HiddenAssistant = "hidden-assistant",
@@ -22,12 +17,14 @@ export declare enum MessageRole {
     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 {
@@ -37,247 +34,384 @@ export declare enum MessageStatus {
     Stop = "stop",
     Streaming = "streaming"
 }
+export declare enum MessageType {
+    Binary = "binary",
+    Function = "function",
+    Text = "text"
+}
+export interface IActivityMessage extends IBaseMessage {
+    activityType: ActivityType;
+    content: IFlowAgentResultCustomValue | IKnowledgeRag | IReferenceDocument;
+    role: MessageRole.Activity;
+}
+export interface IActivityMessageApi extends IBaseMessageApi {
+    activity_type: ActivityType;
+    content: IFlowAgentResultCustomValue | IKnowledgeRagApi | IReferenceDocumentApi;
+    role: MessageRole.Activity;
+}
 export interface IAssistantMessage extends IBaseMessage {
+    content?: string;
+    property?: IMessageProperty;
     role: MessageRole.Assistant;
-    content: Array<IImageMessageContent | IReferenceDocumentMessageContent | ITextMessageContent | IThinkingMessageContent | IToolCallMessageContent>;
+    toolCalls?: IToolCall[];
 }
 export interface IAssistantMessageApi extends IBaseMessageApi {
+    content?: string;
+    property?: IMessageProperty;
     role: MessageRole.Assistant;
-    content: Array<IImageMessageContentApi | IReferenceDocumentMessageContentApi | ITextMessageContentApi | IThinkingMessageContentApi | IToolCallMessageContentApi>;
+    tool_calls?: IToolCallApi[];
 }
 export interface IBaseMessage {
-    id?: number;
-    property?: Record<string, unknown>;
-    sessionCode: string;
-    status?: MessageStatus;
+    id?: string;
+    messageId?: string;
+    name?: string;
+    role: MessageRole;
+    sessionCode?: string;
+    status: MessageStatus;
 }
 export interface IBaseMessageApi {
-    id?: number;
-    property?: Record<string, unknown>;
-    session_code: string;
-    status?: MessageStatus;
+    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 IFlowAgentTaskNodeInfo {
+    inputs: Record<string, unknown>;
+    node_id: string;
+    task_id: number;
+    basic_info: {
+        always_use_latest: boolean | null;
+        auto_retry: {
+            enable: boolean;
+            interval: number;
+            times: number;
+        };
+        error_ignorable: boolean;
+        node_name: string;
+        optional: boolean;
+        retryable: boolean;
+        skippable: boolean;
+        stage_name: string;
+        template_name: string;
+        timeout_config: {
+            action: string;
+            enable: boolean;
+            seconds: number;
+        };
+    };
+    outputs: {
+        key: string;
+        preset: boolean;
+        value: unknown;
+    }[];
+    plugin_output: {
+        key: string;
+        name: string;
+        schema: {
+            description: string;
+            enum: unknown[];
+            properties?: Record<string, unknown>;
+            type: string;
+        };
+        type: string;
+    }[];
 }
-export interface IBaseMessageContent {
-    status: MessageContentStatus;
+export interface IFunctionCall {
+    arguments: string;
+    description?: string;
+    mcpName?: string;
+    name: string;
 }
-export interface IBaseMessageContentApi {
-    status: MessageContentStatus;
+export interface IFunctionCallApi {
+    arguments: string;
+    description?: string;
+    mcp_name?: string;
+    name: string;
 }
 export interface IGuideMessage extends IBaseMessage {
-    content: ITextMessageContent[];
+    content: string;
     role: MessageRole.Guide;
 }
 export interface IGuideMessageApi extends IBaseMessageApi {
-    content: ITextMessageContentApi[];
+    content: string;
     role: MessageRole.Guide;
 }
 export interface IHiddenAssistantMessage extends IBaseMessage {
-    content: ITextMessageContent[];
+    content: string;
     role: MessageRole.HiddenAssistant;
 }
 export interface IHiddenAssistantMessageApi extends IBaseMessageApi {
-    content: ITextMessageContentApi[];
+    content: string;
     role: MessageRole.HiddenAssistant;
 }
 export interface IHiddenGuideMessage extends IBaseMessage {
-    content: ITextMessageContent[];
+    content: string;
     role: MessageRole.HiddenGuide;
 }
 export interface IHiddenGuideMessageApi extends IBaseMessageApi {
-    content: ITextMessageContentApi[];
+    content: string;
     role: MessageRole.HiddenGuide;
 }
 export interface IHiddenMessage extends IBaseMessage {
-    content: ITextMessageContent[];
+    content: string;
     role: MessageRole.Hidden;
 }
 export interface IHiddenMessageApi extends IBaseMessageApi {
-    content: ITextMessageContentApi[];
+    content: string;
     role: MessageRole.Hidden;
 }
 export interface IHiddenSystemMessage extends IBaseMessage {
-    content: ITextMessageContent[];
+    content: string;
     role: MessageRole.HiddenSystem;
 }
 export interface IHiddenSystemMessageApi extends IBaseMessageApi {
-    content: ITextMessageContentApi[];
+    content: string;
     role: MessageRole.HiddenSystem;
 }
 export interface IHiddenUserMessage extends IBaseMessage {
-    content: ITextMessageContent[];
+    content: string;
     role: MessageRole.HiddenUser;
 }
 export interface IHiddenUserMessageApi extends IBaseMessageApi {
-    content: ITextMessageContentApi[];
+    content: string;
     role: MessageRole.HiddenUser;
 }
-export interface IImageMessageContent extends IBaseMessageContent {
-    type: MessageContentType.Image;
-    data: {
-        height?: number;
-        url: string;
-        width?: number;
-    };
-}
-export interface IImageMessageContentApi extends IBaseMessageContentApi {
-    type: MessageContentType.Image;
-    data: {
-        height?: number;
-        url: string;
-        width?: number;
-    };
-}
 export interface IInfoMessage extends IBaseMessage {
-    content: ITextMessageContent[];
+    content: string;
     role: MessageRole.Info;
 }
 export interface IInfoMessageApi extends IBaseMessageApi {
-    content: ITextMessageContentApi[];
+    content: string;
     role: MessageRole.Info;
 }
-export type IMessage = IAssistantMessage | IGuideMessage | IHiddenAssistantMessage | IHiddenGuideMessage | IHiddenMessage | IHiddenSystemMessage | IHiddenUserMessage | IInfoMessage | IPauseMessage | IPlaceholderMessage | ISystemMessage | ITemplateAssistantMessage | ITemplateGuideMessage | ITemplateHiddenMessage | ITemplateSystemMessage | ITemplateUserMessage | IUserMessage;
-export type IMessageApi = IAssistantMessageApi | IGuideMessageApi | IHiddenAssistantMessageApi | IHiddenGuideMessageApi | IHiddenMessageApi | IHiddenSystemMessageApi | IHiddenUserMessageApi | IInfoMessageApi | IPauseMessageApi | IPlaceholderMessageApi | ISystemMessageApi | ITemplateAssistantMessageApi | ITemplateGuideMessageApi | ITemplateHiddenMessageApi | ITemplateSystemMessageApi | ITemplateUserMessageApi | IUserMessageApi;
-export type IMessageContent = IImageMessageContent | IReferenceDocumentMessageContent | ITextMessageContent | IThinkingMessageContent | IToolCallMessageContent;
-export type IMessageContentApi = IImageMessageContentApi | IReferenceDocumentMessageContentApi | ITextMessageContentApi | IThinkingMessageContentApi | IToolCallMessageContentApi;
+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>>;
+        /** 用户通过 @ 选择的资源列表 */
+        resources?: Array<Record<string, unknown>>;
+    };
+}
 export interface IPauseMessage extends IBaseMessage {
-    content: ITextMessageContent[];
+    content: string;
     role: MessageRole.Pause;
 }
 export interface IPauseMessageApi extends IBaseMessageApi {
-    content: ITextMessageContentApi[];
+    content: string;
     role: MessageRole.Pause;
 }
 export interface IPlaceholderMessage extends IBaseMessage {
-    content: ITextMessageContent[];
+    content: string;
     role: MessageRole.Placeholder;
 }
 export interface IPlaceholderMessageApi extends IBaseMessageApi {
-    content: ITextMessageContentApi[];
+    content: string;
     role: MessageRole.Placeholder;
 }
-export interface IReferenceDocumentMessageContent extends IBaseMessageContent {
-    type: MessageContentType.ReferenceDocument;
-    data: {
-        icon?: string;
-        originFileUrl?: string;
-        title: string;
-        url: string;
-    }[];
-}
-export interface IReferenceDocumentMessageContentApi extends IBaseMessageContentApi {
-    type: MessageContentType.ReferenceDocument;
-    data: {
-        icon?: string;
-        origin_file_url?: string;
-        title: string;
-        url: string;
-    }[];
+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: ITextMessageContent[];
+    content: string;
     role: MessageRole.System;
 }
 export interface ISystemMessageApi extends IBaseMessageApi {
-    content: ITextMessageContentApi[];
+    content: string;
     role: MessageRole.System;
 }
 export interface ITemplateAssistantMessage extends IBaseMessage {
-    content: ITextMessageContent[];
+    content: string;
     role: MessageRole.TemplateAssistant;
 }
 export interface ITemplateAssistantMessageApi extends IBaseMessageApi {
-    content: ITextMessageContentApi[];
+    content: string;
     role: MessageRole.TemplateAssistant;
 }
 export interface ITemplateGuideMessage extends IBaseMessage {
-    content: ITextMessageContent[];
+    content: string;
     role: MessageRole.TemplateGuide;
 }
 export interface ITemplateGuideMessageApi extends IBaseMessageApi {
-    content: ITextMessageContentApi[];
+    content: string;
     role: MessageRole.TemplateGuide;
 }
 export interface ITemplateHiddenMessage extends IBaseMessage {
-    content: ITextMessageContent[];
+    content: string;
     role: MessageRole.TemplateHidden;
 }
 export interface ITemplateHiddenMessageApi extends IBaseMessageApi {
-    content: ITextMessageContentApi[];
+    content: string;
     role: MessageRole.TemplateHidden;
 }
 export interface ITemplateSystemMessage extends IBaseMessage {
-    content: ITextMessageContentApi[];
+    content: string;
     role: MessageRole.TemplateSystem;
 }
 export interface ITemplateSystemMessageApi extends IBaseMessageApi {
-    content: ITextMessageContentApi[];
+    content: string;
     role: MessageRole.TemplateSystem;
 }
 export interface ITemplateUserMessage extends IBaseMessage {
-    content: ITextMessageContent[];
+    content: string;
     role: MessageRole.TemplateUser;
 }
 export interface ITemplateUserMessageApi extends IBaseMessageApi {
-    content: ITextMessageContentApi[];
+    content: string;
     role: MessageRole.TemplateUser;
 }
-export interface ITextMessageContent extends IBaseMessageContent {
-    id?: number;
-    type: MessageContentType.Text;
-    data: {
-        text: string;
-    };
-}
-export interface ITextMessageContentApi extends IBaseMessageContent {
-    id?: number;
-    type: MessageContentType.Text;
-    data: {
-        text: string;
-    };
-}
-export interface IThinkingMessageContent extends IBaseMessageContent {
-    type: MessageContentType.Thinking;
-    data: {
-        duration?: number;
-        text: string;
-        title?: string;
-    };
-}
-export interface IThinkingMessageContentApi extends IBaseMessageContentApi {
-    type: MessageContentType.Thinking;
-    data: {
-        duration?: number;
-        text: string;
-        title?: string;
-    };
-}
-export interface IToolCallMessageContent extends IBaseMessageContent {
-    type: MessageContentType.ToolCall;
-    data: {
-        args?: string;
-        chunk?: string;
-        parentMessageId?: string;
-        result?: string;
-        toolCallId: string;
-        toolCallName: string;
-    };
-}
-export interface IToolCallMessageContentApi extends IBaseMessageContentApi {
-    type: MessageContentType.ToolCall;
-    data: {
-        args?: string;
-        chunk?: string;
-        parent_message_id?: string;
-        result?: string;
-        tool_call_id: string;
-        tool_call_name: string;
-    };
+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: ITextMessageContent[];
+    content: IInputContent[] | string;
+    /** 消息属性，用于传递引用内容或快捷键相关信息 */
+    property?: IMessageProperty;
     role: MessageRole.User;
 }
 export interface IUserMessageApi extends IBaseMessageApi {
-    content: ITextMessageContentApi[];
+    content: IInputContentApi[] | string;
+    /** 消息属性，用于传递引用内容或快捷键相关信息 */
+    property?: IMessageProperty;
     role: MessageRole.User;
 }

package/dist/message/type.ts.js

@@ -22,24 +22,17 @@
  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  * IN THE SOFTWARE.
- */ export var MessageContentStatus;
-(function(MessageContentStatus) {
-    MessageContentStatus["Complete"] = "complete";
-    MessageContentStatus["Error"] = "error";
-    MessageContentStatus["Stop"] = "stop";
-    MessageContentStatus["Streaming"] = "streaming";
-})(MessageContentStatus || (MessageContentStatus = {}));
-export var MessageContentType;
-(function(MessageContentType) {
-    MessageContentType["Image"] = "image";
-    MessageContentType["ReferenceDocument"] = "reference_document";
-    MessageContentType["Text"] = "text";
-    MessageContentType["Thinking"] = "thinking";
-    MessageContentType["ToolCall"] = "tool_call";
-})(MessageContentType || (MessageContentType = {}));
+ */ export var ActivityType;
+(function(ActivityType) {
+    ActivityType["FlowAgent"] = "flow_agent";
+    ActivityType["KnowledgeRag"] = "knowledge_rag";
+    ActivityType["ReferenceDocument"] = "reference_document";
+})(ActivityType || (ActivityType = {}));
 export var MessageRole;
 (function(MessageRole) {
+    MessageRole["Activity"] = "activity";
     MessageRole["Assistant"] = "assistant";
+    MessageRole["Developer"] = "developer";
     MessageRole["Guide"] = "guide";
     MessageRole["Hidden"] = "hidden";
     MessageRole["HiddenAssistant"] = "hidden-assistant";
@@ -49,12 +42,14 @@ export var MessageRole;
     MessageRole["Info"] = "info";
     MessageRole["Pause"] = "pause";
     MessageRole["Placeholder"] = "placeholder";
+    MessageRole["Reasoning"] = "reasoning";
     MessageRole["System"] = "system";
     MessageRole["TemplateAssistant"] = "template-assistant";
     MessageRole["TemplateGuide"] = "template-guide";
     MessageRole["TemplateHidden"] = "template-hidden";
     MessageRole["TemplateSystem"] = "template-system";
     MessageRole["TemplateUser"] = "template-user";
+    MessageRole["Tool"] = "tool";
     MessageRole["User"] = "user";
 })(MessageRole || (MessageRole = {}));
 export var MessageStatus;
@@ -65,3 +60,9 @@ export var MessageStatus;
     MessageStatus["Stop"] = "stop";
     MessageStatus["Streaming"] = "streaming";
 })(MessageStatus || (MessageStatus = {}));
+export var MessageType;
+(function(MessageType) {
+    MessageType["Binary"] = "binary";
+    MessageType["Function"] = "function";
+    MessageType["Text"] = "text";
+})(MessageType || (MessageType = {}));