@ai-group/chat-sdk 0.2.5 → 0.2.7

package/dist/esm/types/XAiChatbot.d.ts

@@ -0,0 +1,159 @@
+import React, { ReactNode, RefObject, ChangeEvent, FocusEvent, MouseEvent } from 'react';
+import type { PromptProps } from '@ant-design/x';
+import type { MessageType } from 'src/client/base';
+import type { Messages } from './XAiMessage';
+export interface User {
+    id: string;
+    name: string;
+    avatar?: string;
+}
+export interface MessageProps {
+    _id: string;
+    type: string;
+    content: Record<string, any>;
+    createdAt: number;
+    user: User;
+    position?: 'left' | 'right' | 'center' | 'pop';
+    hasTime?: boolean;
+    status?: 'pending' | 'sent' | 'fail';
+}
+export interface QuickReplyItemProps {
+    name: string;
+    code: string;
+    icon?: string;
+    img?: string;
+    isNew?: boolean;
+    isHighlight?: boolean;
+}
+export interface ComposerHandle {
+    setText: (text: string) => void;
+}
+export interface ScrollToEndOptions {
+    animated?: boolean;
+    force?: boolean;
+}
+export interface MessageContainerHandle {
+    scrollToEnd: (options?: ScrollToEndOptions) => void;
+}
+export interface NavbarProps {
+    title?: string;
+    subtitle?: string;
+    avatar?: string;
+}
+export interface ToolbarItemProps {
+    id: string;
+    icon: string;
+    label: string;
+    disabled?: boolean;
+}
+export interface IconButtonProps {
+    icon: string;
+    onClick: () => void;
+    disabled?: boolean;
+}
+export interface RecorderProps {
+    onStart?: () => void;
+    onStop?: (audioBlob: Blob) => void;
+    onError?: (error: Error) => void;
+}
+export type InputType = 'text' | 'voice';
+export interface ChatbotMessageFields {
+    messages?: MessageType[];
+    setMessages?: React.Dispatch<React.SetStateAction<MessageType[]>>;
+    /** 发送消息回调 */
+    onSend?: (type: string, content: string) => void;
+    /** 清空消息回调 */
+    onClear?: () => void;
+    /** 停止生成回调 */
+    onStop?: () => void;
+}
+export interface ActionItem {
+    key?: string;
+    icon: React.ReactNode;
+    tooltip?: string;
+}
+/**
+   * AI 聊天机器人组件
+   */
+export interface XAiChatbotProps extends ChatbotMessageFields {
+    /** 宽屏断点 */
+    wideBreakpoint?: string;
+    /** 导航栏展示 */
+    navbarShow?: boolean;
+    /** 导航栏配置 */
+    navbar?: NavbarProps;
+    /** 导航栏渲染函数，会覆盖 navbar */
+    renderNavbar?: () => ReactNode;
+    /** 是否加载中 */
+    loading?: boolean;
+    /** 加载更多文案 */
+    loadMoreText?: string;
+    /** 在消息列表上面的渲染函数 */
+    renderBeforeMessageList?: () => ReactNode;
+    /** 消息列表 ref */
+    messagesRef?: RefObject<MessageContainerHandle>;
+    /** 下拉加载回调 */
+    onRefresh?: () => Promise<any>;
+    /** 滚动消息列表回调 */
+    onScroll?: (event: React.UIEvent<HTMLDivElement, UIEvent>) => void;
+    /** 消息内容渲染函数 */
+    renderMessageContent?: (message: MessageProps) => ReactNode;
+    /** 快捷短语列表 */
+    quickReplies?: QuickReplyItemProps[];
+    /** 快捷短语是否可见 */
+    quickRepliesVisible?: boolean;
+    /** 点击快速回复回调 */
+    onQuickReplyClick?: (item: QuickReplyItemProps, index: number) => void;
+    /** 快捷短语的滚动回调 */
+    onQuickReplyScroll?: () => void;
+    /** 快捷短语渲染函数，会覆盖 quickReplies */
+    renderQuickReplies?: () => ReactNode;
+    /** 输入区 ref */
+    composerRef?: RefObject<ComposerHandle>;
+    /** 输入框初始内容 */
+    text?: string;
+    /** 空状态图片 */
+    emptyStateImage?: string;
+    /** 空状态文案 */
+    emptyStateText?: string;
+    /** 输入框占位符 */
+    placeholder?: string;
+    /** 输入框聚焦回调 */
+    onInputFocus?: (event: FocusEvent) => void;
+    /** 输入框更新回调 */
+    onInputChange?: (value: string, event: ChangeEvent) => void;
+    /** 输入框失去焦点回调 */
+    onInputBlur?: (event: FocusEvent) => void;
+    /** 输入框粘贴图片后的回调 */
+    onImageSend?: (file: File) => Promise<any>;
+    /** 输入方式 */
+    inputType?: InputType;
+    /** 输入方式切换回调 */
+    onInputTypeChange?: (inputType: InputType) => void;
+    /** 语音输入配置 */
+    recorder?: RecorderProps;
+    /** 工具栏配置 */
+    toolbar?: ToolbarItemProps[];
+    /** AI头像 */
+    avatar?: ReactNode;
+    /** 用户头像 */
+    userAvatar?: ReactNode;
+    /** 工具栏点击回调 */
+    onToolbarClick?: (item: ToolbarItemProps, event: MouseEvent) => void;
+    /** 工具栏打开/关闭回调 */
+    onAccessoryToggle?: (isAccessoryOpen: boolean) => void;
+    /** 输入框右边图标按钮配置 */
+    rightAction?: IconButtonProps;
+    /** 上传按钮是否显示 */
+    uploadBtnShow?: boolean;
+    /** 帮助消息点击回调 */
+    onSuggestMessageClick?: (item: PromptProps, id: string) => void;
+    /** 消息左下角展示字段  */
+    messageTooltip?: (msg: Messages) => React.ReactNode;
+    /** 消息右下角功能区  */
+    messageActions?: ActionItem[];
+    /** 消息右下角功能区点击回调 */
+    onMessagesActionsCallback?: (index: number, data: Messages) => void;
+    /** 输入组件 */
+    Composer?: React.ElementType;
+}

package/dist/esm/types/XAiMessage.d.ts

@@ -0,0 +1,121 @@
+import type { PromptsProps } from '@ant-design/x';
+export type MessageType = 'TextMessage' | 'ActionExecutionMessage' | 'ResultMessage' | 'AgentStateMessage' | 'ImageMessage' | 'SuggestionMessage';
+export declare enum MessageRole {
+    user = "user",// 用户
+    assistant = "assistant",// AI助手
+    suggestion = "suggestion",// 建议
+    system = "system"
+}
+export declare enum MessageStatus {
+    init = "init",
+    pending = "pending",// 生成中/接收中
+    done = "done",// 已完成
+    failed = "failed",// 失败
+    recalled = "recalled",// 已撤回
+    deleted = "deleted"
+}
+/**
+* 所有消息的基础结构
+*/
+export interface BaseMessage {
+    id: string;
+    type: MessageType;
+    createdAt: Date;
+    status?: MessageStatus;
+    thinks?: ActionExecutionMessage[];
+    extra?: any;
+}
+/**
+* 文本消息
+*/
+export interface TextMessage extends BaseMessage {
+    type: 'TextMessage';
+    role: MessageRole;
+    content: {
+        text: string;
+    };
+    parentMessageId?: string;
+}
+/**
+* 工具/动作执行消息
+*/
+export interface ActionExecutionMessage extends BaseMessage {
+    type: 'ActionExecutionMessage';
+    name: string;
+    arguments?: Record<string, any>;
+    parentMessageId?: string;
+    extra?: any;
+}
+/**
+* 工具/动作执行结果消息
+*/
+export interface ResultMessage extends BaseMessage {
+    type: 'ResultMessage';
+    actionExecutionId: string;
+    actionName: string;
+    result: string;
+}
+/**
+* 智能体状态消息
+*/
+export interface AgentStateMessage extends BaseMessage {
+    type: 'AgentStateMessage';
+    threadId: string;
+    agentName: string;
+    nodeName: string;
+    runId: string;
+    active: boolean;
+    role: MessageRole;
+    state: any;
+    running: boolean;
+}
+/**
+* 图片消息
+*/
+export interface ImageMessage extends BaseMessage {
+    type: 'ImageMessage';
+    content: {
+        format: string;
+        bytes: string;
+        thinks?: ActionExecutionMessage[];
+    };
+    role: MessageRole;
+    parentMessageId?: string;
+}
+/**
+ * 提示消息
+ */
+export interface SuggestionMessage extends BaseMessage {
+    type: 'SuggestionMessage';
+    content: PromptsProps['items'];
+    role: MessageRole;
+}
+/**
+* 消息输入类型（用于前端输入/组装）
+* 可选地包含不同类型的消息体
+*/
+export interface MessageInput extends BaseMessage {
+    textMessage?: Omit<TextMessage, 'id' | 'createdAt' | 'type'>;
+    actionExecutionMessage?: Omit<ActionExecutionMessage, 'id' | 'createdAt' | 'type'>;
+    resultMessage?: Omit<ResultMessage, 'id' | 'createdAt' | 'type'>;
+    agentStateMessage?: Omit<AgentStateMessage, 'id' | 'createdAt' | 'type'>;
+    imageMessage?: Omit<ImageMessage, 'id' | 'createdAt' | 'type'>;
+}
+/**
+* 消息列表中消息格式
+*/
+export type Messages = TextMessage | ImageMessage | SuggestionMessage;
+export declare enum ActionAvailability {
+    disabled = "disabled",// 不可用
+    enabled = "enabled",// 可用
+    remote = "remote"
+}
+/**
+* 工具/动作定义
+*/
+export interface Action {
+    name: string;
+    description: string;
+    jsonSchema: string;
+    available?: ActionAvailability;
+}

package/dist/esm/types/XAiProvider.d.ts

@@ -0,0 +1,32 @@
+import React, { ReactNode } from 'react';
+import { AiClient } from 'src/client/base';
+import type { ChatbotMessageFields } from './XAiChatbot';
+export type ThemeType = 'default';
+export interface XAiProviderProps {
+    /** AI 服务地址 */
+    url: string;
+    /** 认证 token */
+    token: string;
+    /** 配置信息 */
+    config?: any;
+    /** Provider 唯一标识，用于区分多个 Provider 实例 */
+    providerId?: string;
+    /** Token 刷新回调 */
+    onRefreshToken?: () => Promise<string>;
+    /** 子组件 */
+    children: ReactNode;
+}
+export interface XAiSDKProps extends XAiProviderProps {
+    theme?: ThemeType;
+    componentProps?: {
+        id?: string;
+        [key: string]: any;
+    };
+}
+export interface XAiContextType extends Required<ChatbotMessageFields> {
+    client: AiClient | null;
+    token: string;
+    loading: boolean;
+    error: string | null;
+}
+export declare const XAiContext: React.Context<XAiContextType | null>;

package/dist/esm/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './XAiChatbot';
+export * from './XAiMessage';
+export * from './XAiProvider';

package/dist/esm/utils/chat.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 处理发送消息并接收流式响应
+ * @param {Object} params - 参数对象
+ * @param {string} params.message - 用户输入的消息
+ * @param {Array} params.files - 上传的文件列表
+ * @param {string} params.botNo - 机器人编号
+ * @param {string} params.agentNo - 代理编号
+ * @param {string} params.agentVersionNo - 代理版本编号
+ * @param {string} params.sessionId - 会话ID
+ * @param {string} params.botPrefix - API前缀
+ * @param {string} params.mode - 模式
+ * @param {Function} params.setMessages - 设置消息列表的函数
+ * @param {Function} params.setLoading - 设置加载状态的函数
+ * @param {Function} params.setContent - 设置输入内容的函数
+ * @param {Function} params.setSessionId - 设置会话ID的函数
+ * @param {Function} params.scrollToBottom - 滚动到底部的函数
+ * @param {Object} params.controllerRef - AbortController引用
+ * @param {Object} params.timeoutRef - 超时计时器引用
+ * @param {Function} params.setServerTime - 设置服务器时间的函数
+ * @param {Function} params.processActionData - 处理动作数据的函数
+ * @param {Function} params.handleNeedApprove - 处理需要授权的回调函数
+ * @param {boolean} params.isJsonMode - 是否为JSON模式
+ * @param {boolean} params.skipUserMessage - 是否跳过添加用户消息（用于授权后重新发送）
+ * @param {string} params.aiMessageId - 已创建的AI消息ID（配合skipUserMessage使用）
+ * @returns {Promise<void>}
+ */
+/**
+ * 停止生成响应
+ * @param {Object} params - 参数对象
+ * @param {Object} params.controllerRef - AbortController引用
+ * @param {Object} params.timeoutRef - 超时计时器引用
+ * @param {Function} params.setLoading - 设置加载状态的函数
+ * @param {Function} params.setMessages - 设置消息列表的函数
+ */

package/dist/esm/utils/index.d.ts

@@ -0,0 +1,2 @@
+export declare const safeJsonParse: <T = any>(str?: string, defaultValue?: any) => T;
+export declare const safeJsonStringify: <T = any>(obj?: T, defaultValue?: any) => string;

package/dist/esm/utils/providerManager.d.ts

@@ -0,0 +1,22 @@
+import { MessageType } from 'src/client/base';
+declare class ProviderManager {
+    private providers;
+    register(providerId: string, data: {
+        client: any;
+        token: string;
+        url: string;
+    }): void;
+    unregister(providerId: string): void;
+    getProvider(providerId: string): {
+        client: any;
+        messages: import("src/client/base").MessageType[];
+        token: string;
+        url: string;
+    } | undefined;
+    addMessage(providerId: string, message: MessageType): void;
+    clearMessages(providerId: string): void;
+    getProviderIds(): string[];
+}
+export declare const providerManager: ProviderManager;
+export declare const useProviderManager: () => ProviderManager;
+export {};

package/dist/esm/utils/request.d.ts

@@ -0,0 +1,78 @@
+import { AxiosInstance, AxiosRequestConfig, AxiosResponse, AxiosError, InternalAxiosRequestConfig } from 'axios';
+export interface RequestConfig extends AxiosRequestConfig {
+    showError?: boolean;
+    retry?: number;
+    retryDelay?: number;
+}
+export interface ApiResponse<T = any> {
+    code: number;
+    message: string;
+    data: T;
+    success: boolean;
+}
+export interface RequestError {
+    code: number;
+    message: string;
+    details?: any;
+}
+export interface RequestInterceptor {
+    onRequest?: (config: InternalAxiosRequestConfig) => InternalAxiosRequestConfig | Promise<InternalAxiosRequestConfig>;
+    onRequestError?: (error: AxiosError) => Promise<AxiosError>;
+}
+export interface ResponseInterceptor {
+    onResponse?: <T>(response: AxiosResponse<ApiResponse<T>>) => AxiosResponse<ApiResponse<T>> | Promise<AxiosResponse<ApiResponse<T>>>;
+    onResponseError?: (error: AxiosError) => Promise<AxiosError>;
+}
+export interface CreateRequestConfig {
+    baseURL?: string;
+    timeout?: number;
+    headers?: Record<string, string>;
+    requestInterceptor?: RequestInterceptor;
+    responseInterceptor?: ResponseInterceptor;
+    onError?: (error: RequestError) => void;
+}
+/**
+ * 创建请求实例
+ */
+export declare function createRequest(config?: CreateRequestConfig): AxiosInstance;
+/**
+ * 通用 GET 请求
+ */
+export declare function get<T = any>(url: string, params?: any, config?: RequestConfig): Promise<ApiResponse<T>>;
+/**
+ * 通用 POST 请求
+ */
+export declare function post<T = any>(url: string, data?: any, config?: RequestConfig): Promise<ApiResponse<T>>;
+/**
+ * 通用 PUT 请求
+ */
+export declare function put<T = any>(url: string, data?: any, config?: RequestConfig): Promise<ApiResponse<T>>;
+/**
+ * 通用 DELETE 请求
+ */
+export declare function del<T = any>(url: string, config?: RequestConfig): Promise<ApiResponse<T>>;
+/**
+ * 通用 PATCH 请求
+ */
+export declare function patch<T = any>(url: string, data?: any, config?: RequestConfig): Promise<ApiResponse<T>>;
+/**
+ * 文件上传
+ */
+export declare function upload<T = any>(url: string, file: File, onProgress?: (progress: number) => void, config?: RequestConfig): Promise<ApiResponse<T>>;
+/**
+ * 下载文件
+ */
+export declare function download(url: string, filename?: string, config?: RequestConfig): Promise<void>;
+export declare const request: AxiosInstance;
+declare const _default: {
+    createRequest: typeof createRequest;
+    get: typeof get;
+    post: typeof post;
+    put: typeof put;
+    del: typeof del;
+    patch: typeof patch;
+    upload: typeof upload;
+    download: typeof download;
+    request: AxiosInstance;
+};
+export default _default;

package/dist/esm/utils/request.example.d.ts

@@ -0,0 +1,39 @@
+declare function getUserInfo(userId: string): Promise<{
+    id: string;
+    name: string;
+    email: string;
+} | undefined>;
+declare function createUser(userData: {
+    name: string;
+    email: string;
+    password: string;
+}): Promise<{
+    id: string;
+    name: string;
+    email: string;
+} | undefined>;
+declare function updateUser(userId: string, userData: {
+    name?: string;
+    email?: string;
+}): Promise<{
+    id: string;
+    name: string;
+    email: string;
+} | undefined>;
+declare function deleteUser(userId: string): Promise<true | undefined>;
+declare function updateUserProfile(userId: string, profileData: {
+    avatar?: string;
+    bio?: string;
+}): Promise<{
+    id: string;
+    avatar: string;
+    bio: string;
+} | undefined>;
+declare function uploadAvatar(userId: string, file: File): Promise<{
+    url: string;
+} | undefined>;
+declare function downloadReport(reportId: string, filename?: string): Promise<void>;
+declare function getProtectedData(): Promise<any>;
+declare function handleErrors(): Promise<import("./request").ApiResponse<any> | undefined>;
+declare function batchRequests(): Promise<import("./request").ApiResponse<any>[] | undefined>;
+export { getUserInfo, createUser, updateUser, deleteUser, updateUserProfile, uploadAvatar, downloadReport, getProtectedData, handleErrors, batchRequests, };

package/dist/esm/utils/umdEntry.d.ts

@@ -0,0 +1,11 @@
+import { XAiSDKProps } from "../types/XAiProvider";
+declare class XAiWebSDK {
+    container: HTMLElement;
+    props: XAiSDKProps;
+    root: any;
+    constructor(container: HTMLElement, props: XAiSDKProps);
+    mount(): void;
+    unmount(): void;
+    static initChatbot(containerOrProps: HTMLElement | XAiSDKProps, props?: XAiSDKProps): XAiWebSDK;
+}
+export default XAiWebSDK;