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

package/dist/event/type.d.ts

@@ -1,6 +1,14 @@
-import type { IMessageApi } from '../message/type';
-export declare enum CustomEventType {
-    ReferenceDocument = "reference_document"
+import { type IMessageApi, type MessageRole, type MessageStatus } from '../message/type';
+export declare enum CustomEventName {
+    FlowAgentEnd = "flow_agent_end",
+    FlowAgentResult = "flow_agent_result",
+    FlowAgentStart = "flow_agent_start",
+    KnowledgeRagEnd = "knowledge_rag_end",
+    KnowledgeRagResult = "knowledge_rag_result",
+    KnowledgeRagStart = "knowledge_rag_start",
+    KnowledgeRagTextContent = "knowledge_rag_text_content",
+    ReferenceDocument = "reference_document",
+    TempMessage = "temp_message"
 }
 export declare enum EventType {
     ActivityDelta = "ACTIVITY_DELTA",
@@ -30,23 +38,49 @@ export declare enum EventType {
     ToolCallResult = "TOOL_CALL_RESULT",
     ToolCallStart = "TOOL_CALL_START"
 }
-export declare enum TextMessageRole {
-    ASSISTANT = "assistant",
-    SYSTEM = "system",
-    TOOL = "tool",
-    USER = "user"
+/** BKFlow 收敛后的节点状态 - task.node 的状态枚举 */
+export declare enum FlowNodeState {
+    /** 失败 */
+    Failed = "failed",
+    /** 执行中 */
+    Running = "running",
+    /** 成功 */
+    Success = "success",
+    /** 挂起 */
+    Suspended = "suspended"
+}
+/** BKFLOW 原始状态 - task 的状态枚举 */
+export declare enum FlowTaskState {
+    /** 执行中 */
+    Blocked = "BLOCKED",
+    /** 执行中 */
+    Created = "CREATED",
+    /** 失败 */
+    Failed = "FAILED",
+    /** 成功 */
+    Finished = "FINISHED",
+    /** 执行中 */
+    LoopReady = "LOOP_READY",
+    /** 执行中 */
+    Ready = "READY",
+    /** 失败 */
+    Revoked = "REVOKED",
+    /** 失败 */
+    RollBackFailed = "ROLL_BACK_FAILED",
+    /** 执行中 */
+    RollBackSuccess = "ROLL_BACK_SUCCESS",
+    /** 执行中 */
+    RollingBack = "ROLLING_BACK",
+    /** 执行中 */
+    Running = "RUNNING",
+    /** 挂起 */
+    Suspended = "SUSPENDED"
 }
 /**
  * Activity 代表 Agent 执行过程中的活动/动作/任务，可能包含结构化数据
  * 活动状态的增量更新
  * 记录活动类型 activityType
  * 使用 JSON Patch (RFC 6902) 格式增量更新 Activity 数据
- *
- * @example ActivityDeltaEvent {
- *   activityType: "file_processing",
- *   messageId: "123",
- *   patch: [{ op: "add", path: "/title", value: "分析需求" }]
- * }
  */
 export interface IActivityDeltaEvent extends IBaseEvent {
     activityType: string;
@@ -59,17 +93,6 @@ export interface IActivityDeltaEvent extends IBaseEvent {
  * 活动状态的快照
  * 记录活动类型 activityType
  * 使用 JSON 格式存储 Activity 数据
- *
- * @example ActivitySnapshotEvent {
- *   activityType: "file_processing",
- *   messageId: "123",
- *   content: {
- *     title: "分析需求",
- *     status: "pending",
- *     progress: 0.5,
- *   },
- *   replace: true,
- * }
  */
 export interface IActivitySnapshotEvent extends IBaseEvent {
     activityType: string;
@@ -78,10 +101,6 @@ export interface IActivitySnapshotEvent extends IBaseEvent {
     replace?: boolean;
     type: EventType.ActivitySnapshot;
 }
-export interface IBaseCustomEvent {
-    timestamp?: number;
-    type: CustomEventType;
-}
 export interface IBaseEvent {
     timestamp?: number;
     type: EventType;
@@ -89,26 +108,47 @@ export interface IBaseEvent {
 /**
  * 自定义事件
  * 用于发送自定义事件到客户端
- *
- * @example CustomEvent {
- *   name: "custom_event",
- *   value: { type: CustomEventType.ReferenceDocument, data: { ... } }
- * }
  */
 export interface ICustomEvent extends IBaseEvent {
-    name: string;
+    name: CustomEventName;
     type: EventType.Custom;
-    value: IReferenceDocumentCustomEvent;
+    value: IFlowAgentEndCustomValue | IFlowAgentResultCustomValue | IFlowAgentStartCustomValue | IKnowledgeRagResultCustomValue | IKnowledgeRagTextContentCustomValue | IReferenceDocumentCustomValue | ITempMessageCustomValue;
 }
 export type IEvent = IActivityDeltaEvent | IActivitySnapshotEvent | ICustomEvent | IMessagesSnapshotEvent | IRawEvent | IRunErrorEvent | IRunFinishedEvent | IRunStartedEvent | IStateDeltaEvent | IStateSnapshotEvent | IStepFinishedEvent | IStepStartedEvent | ITextMessageChunkEvent | ITextMessageContentEvent | ITextMessageEndEvent | ITextMessageStartEvent | IThinkingEndEvent | IThinkingStartEvent | IThinkingTextMessageContentEvent | IThinkingTextMessageEndEvent | IThinkingTextMessageStartEvent | IToolCallArgsEvent | IToolCallChunkEvent | IToolCallEndEvent | IToolCallResultEvent | IToolCallStartEvent;
+export interface IFlowAgentEndCustomValue {
+    task_outputs: string[];
+}
+export interface IFlowAgentNode {
+    /** 耗时(s) */
+    elapsed_time: number;
+    /** 节点id */
+    id: string;
+    /** 节点名称 */
+    name: string;
+    /** 节点状态 */
+    state: FlowNodeState;
+}
+export interface IFlowAgentResultCustomValue {
+    nodes: Record<string, IFlowAgentNode>;
+    task_id: number;
+    task_name: string;
+    task_outputs: string[];
+    task_state: FlowTaskState;
+}
+export interface IFlowAgentStartCustomValue {
+    task_id: string;
+}
+export type IKnowledgeRagResultCustomValue = IReferenceDocumentCustomValue;
+export interface IKnowledgeRagTextContentCustomValue {
+    cover: boolean;
+    chunk: {
+        content: string;
+    };
+}
 /**
  * 消息快照事件
  * 用于记录当前时刻的完整消息状态
  * 同步多端消息状态
- *
- * @example MessagesSnapshotEvent {
- *   messages: [{ ... }, { ... }]
- * }
  */
 export interface IMessagesSnapshotEvent extends IBaseEvent {
     messages: IMessageApi[];
@@ -117,32 +157,17 @@ export interface IMessagesSnapshotEvent extends IBaseEvent {
 /**
  * 透传底层原始事件数据
  * 保留完整的原始事件信息，不做解析
- *
- * // 同时对接多个 AI 服务
- * @example RawEvent {
- *   event: {  Claude 原始响应  },
- *   source: "anthropic"
- * }
- *
- * @example RawEvent {
- *   event: {  OpenAI 原始响应  },
- *   source: "openai"
- * }
  */
 export interface IRawEvent extends IBaseEvent {
     event: unknown;
     source?: string;
     type: EventType.Raw;
 }
-export interface IReferenceDocumentCustomEvent extends IBaseCustomEvent {
-    type: CustomEventType.ReferenceDocument;
-    data: {
-        icon?: string;
-        originFileUrl?: string;
-        title: string;
-        url: string;
-    }[];
-}
+export type IReferenceDocumentCustomValue = {
+    name: string;
+    originFileUrl?: string;
+    url: string;
+}[];
 export interface IRunErrorEvent extends IBaseEvent {
     code?: string;
     message: string;
@@ -164,13 +189,6 @@ export interface IRunFinishedEvent extends IBaseEvent {
  * 关联会话线程 threadId
  * 可以记录初始输入 input
  * 支持嵌套运行（parentRunId 用于子 Agent 调用）
- *
- * @example RunStartedEvent {
- *   runId: 123,
- *   threadId: "thread_123",
- *   parentRunId: undefined,
- *   input: { messages: [...] },
- * }
  */
 export interface IRunStartedEvent extends IBaseEvent {
     input?: unknown;
@@ -183,10 +201,6 @@ export interface IRunStartedEvent extends IBaseEvent {
  * 状态增量更新事件
  * 用于更新客户端状态
  * 以 JSON Patch 格式增量更新状态
- *
- * @example StateDeltaEvent {
- *   delta: [{ op: "add", path: "/title", value: "分析需求" }]
- * }
  */
 export interface IStateDeltaEvent extends IBaseEvent {
     delta: unknown;
@@ -196,10 +210,6 @@ export interface IStateDeltaEvent extends IBaseEvent {
  * 状态快照事件
  * 用于初始化或重置客户端状态
  * 提供当前时刻的完整状态视图
- *
- * @example StateSnapshotEvent {
- *   snapshot: { ... }
- * }
  */
 export interface IStateSnapshotEvent extends IBaseEvent {
     snapshot: unknown;
@@ -220,45 +230,40 @@ export interface IStepStartedEvent extends IBaseEvent {
     stepName: string;
     type: EventType.StepStarted;
 }
+export interface ITempMessageCustomValue {
+    message: string;
+    status: MessageStatus;
+}
 export interface ITextMessageChunkEvent extends IBaseEvent {
     delta?: string;
-    messageId: number;
-    role?: TextMessageRole;
+    messageId: string;
+    role?: MessageRole;
     type: EventType.TextMessageChunk;
 }
 export interface ITextMessageContentEvent extends IBaseEvent {
     delta: string;
-    messageId: number;
+    messageId: string;
     type: EventType.TextMessageContent;
 }
 export interface ITextMessageEndEvent extends IBaseEvent {
-    messageId: number;
+    messageId: string;
     type: EventType.TextMessageEnd;
 }
 export interface ITextMessageStartEvent extends IBaseEvent {
-    messageId: number;
-    role: TextMessageRole;
+    messageId: string;
+    role: MessageRole;
     type: EventType.TextMessageStart;
 }
 /**
  * 思考结束事件
- *
- * @example ThinkingEndEvent {
- *   timestamp: 1734902400000,
- *   type: EventType.ThinkingEnd,
- * }
  */
 export interface IThinkingEndEvent extends IBaseEvent {
+    duration?: number;
     type: EventType.ThinkingEnd;
 }
 /**
  * 思考开始事件
  * 记录思考的标题 title
- *
- * @example ThinkingStartEvent {
- *   title: "分析需求"
- *   type: EventType.ThinkingStart,
- * }
  */
 export interface IThinkingStartEvent extends IBaseEvent {
     title?: string;
@@ -266,12 +271,6 @@ export interface IThinkingStartEvent extends IBaseEvent {
 }
 /**
  * 思考文本消息内容事件
- *
- * @example ThinkingTextMessageContentEvent {
- *   timestamp: 1734902400000,
- *   type: EventType.ThinkingTextMessageContent,
- *   delta: "思考中..."
- * }
  */
 export interface IThinkingTextMessageContentEvent extends IBaseEvent {
     delta: string;
@@ -279,22 +278,12 @@ export interface IThinkingTextMessageContentEvent extends IBaseEvent {
 }
 /**
  * 思考文本消息结束事件
- *
- * @example ThinkingTextMessageEndEvent {
- *   timestamp: 1734902400000,
- *   type: EventType.ThinkingTextMessageEnd,
- * }
  */
 export interface IThinkingTextMessageEndEvent extends IBaseEvent {
     type: EventType.ThinkingTextMessageEnd;
 }
 /**
  * 思考文本消息开始事件
- *
- * @example ThinkingTextMessageStartEvent {
- *   timestamp: 1734902400000,
- *   type: EventType.ThinkingTextMessageStart,
- * }
  */
 export interface IThinkingTextMessageStartEvent extends IBaseEvent {
     type: EventType.ThinkingTextMessageStart;
@@ -317,11 +306,14 @@ export interface IToolCallEndEvent extends IBaseEvent {
 }
 export interface IToolCallResultEvent extends IBaseEvent {
     content: string;
+    duration?: number;
     messageId: string;
     toolCallId: string;
     type: EventType.ToolCallResult;
 }
 export interface IToolCallStartEvent extends IBaseEvent {
+    description?: string;
+    mcpName?: string;
     parentMessageId?: string;
     toolCallId: string;
     toolCallName: string;

package/dist/event/type.ts.js

@@ -22,10 +22,18 @@
  * 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 CustomEventType;
-(function(CustomEventType) {
-    CustomEventType["ReferenceDocument"] = "reference_document";
-})(CustomEventType || (CustomEventType = {}));
+ */ export var CustomEventName;
+(function(CustomEventName) {
+    CustomEventName["FlowAgentEnd"] = "flow_agent_end";
+    CustomEventName["FlowAgentResult"] = "flow_agent_result";
+    CustomEventName["FlowAgentStart"] = "flow_agent_start";
+    CustomEventName["KnowledgeRagEnd"] = "knowledge_rag_end";
+    CustomEventName["KnowledgeRagResult"] = "knowledge_rag_result";
+    CustomEventName["KnowledgeRagStart"] = "knowledge_rag_start";
+    CustomEventName["KnowledgeRagTextContent"] = "knowledge_rag_text_content";
+    CustomEventName["ReferenceDocument"] = "reference_document";
+    CustomEventName["TempMessage"] = "temp_message";
+})(CustomEventName || (CustomEventName = {}));
 export var EventType;
 (function(EventType) {
     EventType["ActivityDelta"] = "ACTIVITY_DELTA";
@@ -55,10 +63,25 @@ export var EventType;
     EventType["ToolCallResult"] = "TOOL_CALL_RESULT";
     EventType["ToolCallStart"] = "TOOL_CALL_START";
 })(EventType || (EventType = {}));
-export var TextMessageRole;
-(function(TextMessageRole) {
-    TextMessageRole["ASSISTANT"] = "assistant";
-    TextMessageRole["SYSTEM"] = "system";
-    TextMessageRole["TOOL"] = "tool";
-    TextMessageRole["USER"] = "user";
-})(TextMessageRole || (TextMessageRole = {}));
+export var FlowNodeState;
+(function(FlowNodeState) {
+    /** 失败 */ FlowNodeState["Failed"] = "failed";
+    /** 执行中 */ FlowNodeState["Running"] = "running";
+    /** 成功 */ FlowNodeState["Success"] = "success";
+    /** 挂起 */ FlowNodeState["Suspended"] = "suspended";
+})(FlowNodeState || (FlowNodeState = {}));
+export var FlowTaskState;
+(function(FlowTaskState) {
+    /** 执行中 */ FlowTaskState["Blocked"] = "BLOCKED";
+    /** 执行中 */ FlowTaskState["Created"] = "CREATED";
+    /** 失败 */ FlowTaskState["Failed"] = "FAILED";
+    /** 成功 */ FlowTaskState["Finished"] = "FINISHED";
+    /** 执行中 */ FlowTaskState["LoopReady"] = "LOOP_READY";
+    /** 执行中 */ FlowTaskState["Ready"] = "READY";
+    /** 失败 */ FlowTaskState["Revoked"] = "REVOKED";
+    /** 失败 */ FlowTaskState["RollBackFailed"] = "ROLL_BACK_FAILED";
+    /** 执行中 */ FlowTaskState["RollBackSuccess"] = "ROLL_BACK_SUCCESS";
+    /** 执行中 */ FlowTaskState["RollingBack"] = "ROLLING_BACK";
+    /** 执行中 */ FlowTaskState["Running"] = "RUNNING";
+    /** 挂起 */ FlowTaskState["Suspended"] = "SUSPENDED";
+})(FlowTaskState || (FlowTaskState = {}));

package/dist/http/fetch/fetch.d.ts

@@ -3,11 +3,14 @@ export interface ApiResponse<T = unknown> {
     data: T;
     message: string;
 }
+/** 单次请求配置，优先级高于 `requestData` 全局默认值 */
 export interface IRequestConfig {
     baseURL?: string;
     controller?: AbortController;
     credentials?: 'include' | 'omit' | 'same-origin';
+    /** 请求体；可传函数以便延迟求值（在 `prepareRequest` 中通过 `getValue` 解析） */
     data?: (() => unknown) | unknown;
+    /** 请求头；可传函数以便延迟求值，便于动态注入（如 token） */
     headers?: (() => Record<string, string>) | Record<string, string>;
     method?: string;
     mode?: 'cors' | 'no-cors' | 'same-origin';
@@ -75,8 +78,9 @@ export declare class FetchClient {
             mode: "same-origin" | "cors" | "no-cors";
             headers: Headers;
             body: BodyInit;
-            controller: AbortController;
+            signal: AbortSignal;
         };
+        controller: AbortController;
     };
     put<T = unknown>(url: string, data?: unknown, config?: IRequestConfig): Promise<T>;
     request<T = unknown>(config: IRequestConfig): Promise<T>;