@blueking/chat-helper 0.0.1-beta.1

package/dist/event/index.ts.js

@@ -0,0 +1,26 @@
+/*
+ * Tencent is pleased to support the open source community by making
+ * 蓝鲸智云PaaS平台 (BlueKing PaaS) available.
+ *
+ * Copyright (C) 2021 THL A29 Limited, a Tencent company.  All rights reserved.
+ *
+ * 蓝鲸智云PaaS平台 (BlueKing PaaS) is licensed under the MIT License.
+ *
+ * License for 蓝鲸智云PaaS平台 (BlueKing PaaS):
+ *
+ * ---------------------------------------------------
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
+ * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of
+ * the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
+ * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * 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 * from './ag-ui.ts.js';
+export * from './type.ts.js';

package/dist/event/type.d.ts

@@ -0,0 +1,329 @@
+import type { IMessageApi } from '../message/type';
+export declare enum CustomEventType {
+    ReferenceDocument = "reference_document"
+}
+export declare enum EventType {
+    ActivityDelta = "ACTIVITY_DELTA",
+    ActivitySnapshot = "ACTIVITY_SNAPSHOT",
+    Custom = "CUSTOM",
+    MessagesSnapshot = "MESSAGES_SNAPSHOT",
+    Raw = "RAW",
+    RunError = "RUN_ERROR",
+    RunFinished = "RUN_FINISHED",
+    RunStarted = "RUN_STARTED",
+    StateDelta = "STATE_DELTA",
+    StateSnapshot = "STATE_SNAPSHOT",
+    StepFinished = "STEP_FINISHED",
+    StepStarted = "STEP_STARTED",
+    TextMessageChunk = "TEXT_MESSAGE_CHUNK",
+    TextMessageContent = "TEXT_MESSAGE_CONTENT",
+    TextMessageEnd = "TEXT_MESSAGE_END",
+    TextMessageStart = "TEXT_MESSAGE_START",
+    ThinkingEnd = "THINKING_END",
+    ThinkingStart = "THINKING_START",
+    ThinkingTextMessageContent = "THINKING_TEXT_MESSAGE_CONTENT",
+    ThinkingTextMessageEnd = "THINKING_TEXT_MESSAGE_END",
+    ThinkingTextMessageStart = "THINKING_TEXT_MESSAGE_START",
+    ToolCallArgs = "TOOL_CALL_ARGS",
+    ToolCallChunk = "TOOL_CALL_CHUNK",
+    ToolCallEnd = "TOOL_CALL_END",
+    ToolCallResult = "TOOL_CALL_RESULT",
+    ToolCallStart = "TOOL_CALL_START"
+}
+export declare enum TextMessageRole {
+    ASSISTANT = "assistant",
+    SYSTEM = "system",
+    TOOL = "tool",
+    USER = "user"
+}
+/**
+ * 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;
+    messageId: string;
+    patch: unknown[];
+    type: EventType.ActivityDelta;
+}
+/**
+ * Activity 代表 Agent 执行过程中的活动/动作/任务，可能包含结构化数据
+ * 活动状态的快照
+ * 记录活动类型 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;
+    content: unknown;
+    messageId: string;
+    replace?: boolean;
+    type: EventType.ActivitySnapshot;
+}
+export interface IBaseCustomEvent {
+    timestamp?: number;
+    type: CustomEventType;
+}
+export interface IBaseEvent {
+    timestamp?: number;
+    type: EventType;
+}
+/**
+ * 自定义事件
+ * 用于发送自定义事件到客户端
+ *
+ * @example CustomEvent {
+ *   name: "custom_event",
+ *   value: { type: CustomEventType.ReferenceDocument, data: { ... } }
+ * }
+ */
+export interface ICustomEvent extends IBaseEvent {
+    name: string;
+    type: EventType.Custom;
+    value: IReferenceDocumentCustomEvent;
+}
+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;
+/**
+ * 消息快照事件
+ * 用于记录当前时刻的完整消息状态
+ * 同步多端消息状态
+ *
+ * @example MessagesSnapshotEvent {
+ *   messages: [{ ... }, { ... }]
+ * }
+ */
+export interface IMessagesSnapshotEvent extends IBaseEvent {
+    messages: IMessageApi[];
+    type: EventType.MessagesSnapshot;
+}
+/**
+ * 透传底层原始事件数据
+ * 保留完整的原始事件信息，不做解析
+ *
+ * // 同时对接多个 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 interface IRunErrorEvent extends IBaseEvent {
+    code?: string;
+    message: string;
+    type: EventType.RunError;
+}
+/**
+ * 标记 Agent 运行正常结束
+ * 返回最终结果 result
+ */
+export interface IRunFinishedEvent extends IBaseEvent {
+    result?: unknown;
+    runId: number;
+    threadId: string;
+    type: EventType.RunFinished;
+}
+/**
+ * 标记一次完整的 Agent 执行开始
+ * 记录本次运行的唯一标识 runId
+ * 关联会话线程 threadId
+ * 可以记录初始输入 input
+ * 支持嵌套运行（parentRunId 用于子 Agent 调用）
+ *
+ * @example RunStartedEvent {
+ *   runId: 123,
+ *   threadId: "thread_123",
+ *   parentRunId: undefined,
+ *   input: { messages: [...] },
+ * }
+ */
+export interface IRunStartedEvent extends IBaseEvent {
+    input?: unknown;
+    parentRunId?: string;
+    runId: number;
+    threadId: string;
+    type: EventType.RunStarted;
+}
+/**
+ * 状态增量更新事件
+ * 用于更新客户端状态
+ * 以 JSON Patch 格式增量更新状态
+ *
+ * @example StateDeltaEvent {
+ *   delta: [{ op: "add", path: "/title", value: "分析需求" }]
+ * }
+ */
+export interface IStateDeltaEvent extends IBaseEvent {
+    delta: unknown;
+    type: EventType.StateDelta;
+}
+/**
+ * 状态快照事件
+ * 用于初始化或重置客户端状态
+ * 提供当前时刻的完整状态视图
+ *
+ * @example StateSnapshotEvent {
+ *   snapshot: { ... }
+ * }
+ */
+export interface IStateSnapshotEvent extends IBaseEvent {
+    snapshot: unknown;
+    type: EventType.StateSnapshot;
+}
+export interface IStepFinishedEvent extends IBaseEvent {
+    stepName: string;
+    type: EventType.StepFinished;
+}
+/**
+ * 多步骤 Agent 工作流的追踪和可视化
+ * 当 Agent 需要完成一个复杂任务，分成多个步骤执行时
+ * StepStartedEvent { stepName: "分析需求" }
+ * ... // 其他步骤
+ * StepFinishedEvent { stepName: "分析需求" }
+ */
+export interface IStepStartedEvent extends IBaseEvent {
+    stepName: string;
+    type: EventType.StepStarted;
+}
+export interface ITextMessageChunkEvent extends IBaseEvent {
+    delta?: string;
+    messageId: number;
+    role?: TextMessageRole;
+    type: EventType.TextMessageChunk;
+}
+export interface ITextMessageContentEvent extends IBaseEvent {
+    delta: string;
+    messageId: number;
+    type: EventType.TextMessageContent;
+}
+export interface ITextMessageEndEvent extends IBaseEvent {
+    messageId: number;
+    type: EventType.TextMessageEnd;
+}
+export interface ITextMessageStartEvent extends IBaseEvent {
+    messageId: number;
+    role: TextMessageRole;
+    type: EventType.TextMessageStart;
+}
+/**
+ * 思考结束事件
+ *
+ * @example ThinkingEndEvent {
+ *   timestamp: 1734902400000,
+ *   type: EventType.ThinkingEnd,
+ * }
+ */
+export interface IThinkingEndEvent extends IBaseEvent {
+    type: EventType.ThinkingEnd;
+}
+/**
+ * 思考开始事件
+ * 记录思考的标题 title
+ *
+ * @example ThinkingStartEvent {
+ *   title: "分析需求"
+ *   type: EventType.ThinkingStart,
+ * }
+ */
+export interface IThinkingStartEvent extends IBaseEvent {
+    title?: string;
+    type: EventType.ThinkingStart;
+}
+/**
+ * 思考文本消息内容事件
+ *
+ * @example ThinkingTextMessageContentEvent {
+ *   timestamp: 1734902400000,
+ *   type: EventType.ThinkingTextMessageContent,
+ *   delta: "思考中..."
+ * }
+ */
+export interface IThinkingTextMessageContentEvent extends IBaseEvent {
+    delta: string;
+    type: EventType.ThinkingTextMessageContent;
+}
+/**
+ * 思考文本消息结束事件
+ *
+ * @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;
+}
+export interface IToolCallArgsEvent extends IBaseEvent {
+    delta: string;
+    toolCallId: string;
+    type: EventType.ToolCallArgs;
+}
+export interface IToolCallChunkEvent extends IBaseEvent {
+    delta?: string;
+    parentMessageId?: string;
+    toolCallId?: string;
+    toolCallName?: string;
+    type: EventType.ToolCallChunk;
+}
+export interface IToolCallEndEvent extends IBaseEvent {
+    toolCallId: string;
+    type: EventType.ToolCallEnd;
+}
+export interface IToolCallResultEvent extends IBaseEvent {
+    content: string;
+    messageId: string;
+    toolCallId: string;
+    type: EventType.ToolCallResult;
+}
+export interface IToolCallStartEvent extends IBaseEvent {
+    parentMessageId?: string;
+    toolCallId: string;
+    toolCallName: string;
+    type: EventType.ToolCallStart;
+}

package/dist/event/type.ts.js

@@ -0,0 +1,64 @@
+/*
+ * Tencent is pleased to support the open source community by making
+ * 蓝鲸智云PaaS平台 (BlueKing PaaS) available.
+ *
+ * Copyright (C) 2021 THL A29 Limited, a Tencent company.  All rights reserved.
+ *
+ * 蓝鲸智云PaaS平台 (BlueKing PaaS) is licensed under the MIT License.
+ *
+ * License for 蓝鲸智云PaaS平台 (BlueKing PaaS):
+ *
+ * ---------------------------------------------------
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
+ * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of
+ * the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
+ * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * 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 EventType;
+(function(EventType) {
+    EventType["ActivityDelta"] = "ACTIVITY_DELTA";
+    EventType["ActivitySnapshot"] = "ACTIVITY_SNAPSHOT";
+    EventType["Custom"] = "CUSTOM";
+    EventType["MessagesSnapshot"] = "MESSAGES_SNAPSHOT";
+    EventType["Raw"] = "RAW";
+    EventType["RunError"] = "RUN_ERROR";
+    EventType["RunFinished"] = "RUN_FINISHED";
+    EventType["RunStarted"] = "RUN_STARTED";
+    EventType["StateDelta"] = "STATE_DELTA";
+    EventType["StateSnapshot"] = "STATE_SNAPSHOT";
+    EventType["StepFinished"] = "STEP_FINISHED";
+    EventType["StepStarted"] = "STEP_STARTED";
+    EventType["TextMessageChunk"] = "TEXT_MESSAGE_CHUNK";
+    EventType["TextMessageContent"] = "TEXT_MESSAGE_CONTENT";
+    EventType["TextMessageEnd"] = "TEXT_MESSAGE_END";
+    EventType["TextMessageStart"] = "TEXT_MESSAGE_START";
+    EventType["ThinkingEnd"] = "THINKING_END";
+    EventType["ThinkingStart"] = "THINKING_START";
+    EventType["ThinkingTextMessageContent"] = "THINKING_TEXT_MESSAGE_CONTENT";
+    EventType["ThinkingTextMessageEnd"] = "THINKING_TEXT_MESSAGE_END";
+    EventType["ThinkingTextMessageStart"] = "THINKING_TEXT_MESSAGE_START";
+    EventType["ToolCallArgs"] = "TOOL_CALL_ARGS";
+    EventType["ToolCallChunk"] = "TOOL_CALL_CHUNK";
+    EventType["ToolCallEnd"] = "TOOL_CALL_END";
+    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 = {}));

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

@@ -0,0 +1,84 @@
+export interface ApiResponse<T = unknown> {
+    code: number | string;
+    data: T;
+    message: string;
+}
+export interface ISSEProtocol {
+    onDone?: () => void;
+    onError?: (error: Error) => void;
+    onMessage?: (event: unknown) => void;
+    onStart?: () => void;
+}
+export interface RequestConfig {
+    baseURL?: string;
+    controller?: AbortController;
+    credentials?: 'include' | 'omit' | 'same-origin';
+    data?: (() => unknown) | unknown;
+    headers?: (() => Record<string, string>) | Record<string, string>;
+    method?: string;
+    mode?: 'cors' | 'no-cors' | 'same-origin';
+    params?: Record<string, unknown>;
+    responseType?: 'arrayBuffer' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
+    timeout?: number;
+    url?: string;
+    transformRequest?: (data: unknown, headers?: Record<string, string>) => unknown;
+    transformResponse?: (data: unknown) => unknown;
+    validateStatus?: (status: number) => boolean;
+}
+export interface RequestError extends Error {
+    code?: string;
+    config: RequestConfig;
+    isAxiosError: boolean;
+    request?: Request;
+    response?: Response;
+}
+export interface Response<T = unknown> {
+    config: RequestConfig;
+    data: T;
+    headers: Headers;
+    request?: Request;
+    status: number;
+    statusText: string;
+}
+export interface SSEConfig extends ISSEProtocol, Omit<RequestConfig, 'responseType'> {
+}
+interface Interceptor<T> {
+    fulfilled?: (value: T) => T;
+    rejected?: (error: unknown) => unknown;
+}
+declare class InterceptorManager<T> {
+    private handlers;
+    clear(): void;
+    eject(id: number): void;
+    forEach(fn: (interceptor: Interceptor<T>) => void): void;
+    use(fulfilled?: (value: T) => T, rejected?: (error: unknown) => unknown): number;
+}
+export declare class FetchClient {
+    defaults: RequestConfig;
+    interceptors: {
+        request: InterceptorManager<RequestConfig>;
+        response: InterceptorManager<Response>;
+    };
+    constructor(config?: RequestConfig);
+    applyResponseErrorInterceptors(error: unknown): unknown;
+    create(config?: RequestConfig): FetchClient;
+    delete<T = unknown>(url: string, params?: Record<string, unknown>, config?: RequestConfig): Promise<T>;
+    get<T = unknown>(url: string, params?: Record<string, unknown>, config?: RequestConfig): Promise<T>;
+    head<T = unknown>(url: string, params?: Record<string, unknown>, config?: RequestConfig): Promise<T>;
+    options<T = unknown>(url: string, params?: Record<string, unknown>, config?: RequestConfig): Promise<T>;
+    patch<T = unknown>(url: string, data?: unknown, config?: RequestConfig): Promise<T>;
+    post<T = unknown>(url: string, data?: unknown, config?: RequestConfig): Promise<T>;
+    prepareRequest(config: RequestConfig, isStream?: boolean): {
+        url: string;
+        headers: Headers;
+        body: BodyInit;
+        requestConfig: RequestConfig;
+        controller: AbortController;
+    };
+    put<T = unknown>(url: string, data?: unknown, config?: RequestConfig): Promise<T>;
+    request<T = unknown>(config: RequestConfig): Promise<T>;
+    stream(url: string, config?: SSEConfig): Promise<void>;
+    streamRequest(config: SSEConfig): Promise<void>;
+}
+declare const fetchClient: FetchClient;
+export default fetchClient;