@nocobase/plugin-ai 2.1.0-beta.46 → 2.1.0-beta.48

package/dist/client-v2/ai-employees/chatbox/hooks/useChatBoxActions.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import type { AIEmployee, ClearOptions, TriggerTaskOptions } from '../../types';
+export declare const useChatBoxActions: () => {
+    clear: (options?: ClearOptions) => void;
+    startNewConversation: () => void;
+    switchAIEmployee: (aiEmployee: AIEmployee, options?: {
+        clear?: ClearOptions;
+    }) => void;
+    triggerTask: (options: TriggerTaskOptions) => Promise<void>;
+};

package/dist/client-v2/ai-employees/chatbox/stores/chat-box.d.ts

@@ -0,0 +1,113 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+/// <reference types="react" />
+import type { Bubble, Sender } from '@ant-design/x';
+import type { GetProp, GetRef } from 'antd';
+import type { AIEmployee } from '../../types';
+type RolesType = GetProp<typeof Bubble.List, 'roles'>;
+export interface ModelRef {
+    llmService: string;
+    model: string;
+}
+interface ChatBoxState {
+    open: boolean;
+    expanded: boolean;
+    collapsed: boolean;
+    showConversations: boolean;
+    minimize: boolean;
+    currentEmployee?: AIEmployee;
+    senderValue: string;
+    senderPlaceholder: string;
+    roles: GetProp<typeof Bubble.List, 'roles'>;
+    taskVariables: {
+        variables?: Record<string, unknown>;
+        localVariables?: Record<string, unknown>;
+    };
+    isEditingMessage: boolean;
+    editingMessageId?: string;
+    chatBoxRef: React.MutableRefObject<HTMLDivElement> | null;
+    senderRef: React.MutableRefObject<GetRef<typeof Sender>> | null;
+    showCodeHistory: boolean;
+    model?: ModelRef | null;
+    showDebugPanel: boolean;
+    readonly: boolean;
+    isShowSenderHint: boolean;
+}
+interface ChatBoxActions {
+    setOpen: (open: boolean) => void;
+    setExpanded: (expanded: boolean) => void;
+    setCollapsed: (collapsed: boolean) => void;
+    setShowConversations: (show: boolean) => void;
+    setMinimize: (minus: boolean) => void;
+    setCurrentEmployee: (aiEmployee?: AIEmployee | ((prev: AIEmployee) => AIEmployee)) => void;
+    setSenderValue: (value: string) => void;
+    setSenderPlaceholder: (placeholder: string) => void;
+    setTaskVariables: (variables: ChatBoxState['taskVariables']) => void;
+    setRoles: (roles: RolesType | ((prev: RolesType) => RolesType)) => void;
+    addRole: (name: string, role: unknown) => void;
+    setIsEditingMessage: (isEditing: boolean) => void;
+    setEditingMessageId: (id?: string) => void;
+    setChatBoxRef: (ref: React.MutableRefObject<HTMLDivElement> | null) => void;
+    setSenderRef: (ref: React.MutableRefObject<GetRef<typeof Sender>> | null) => void;
+    setShowCodeHistory: (show: boolean) => void;
+    setModel: (model: ModelRef | null) => void;
+    setShowDebugPanel: (show: boolean) => void;
+    setReadonly: (readonly: boolean) => void;
+    setShowSenderHint: (show: boolean) => void;
+}
+export declare const useChatBoxStore: {
+    (): ChatBoxState & ChatBoxActions;
+    <U>(selector: (state: ChatBoxState & ChatBoxActions) => U): U;
+} & import("zustand").StoreApi<ChatBoxState & ChatBoxActions> & {
+    use: {
+        open: () => boolean;
+        expanded: () => boolean;
+        collapsed: () => boolean;
+        showConversations: () => boolean;
+        minimize: () => boolean;
+        currentEmployee?: () => AIEmployee;
+        senderValue: () => string;
+        senderPlaceholder: () => string;
+        roles: () => GetProp<import("react").ForwardRefExoticComponent<import("@ant-design/x/es/bubble/BubbleList").BubbleListProps & import("react").RefAttributes<import("@ant-design/x/es/bubble/BubbleList").BubbleListRef>>, "roles">;
+        taskVariables: () => {
+            variables?: Record<string, unknown>;
+            localVariables?: Record<string, unknown>;
+        };
+        isEditingMessage: () => boolean;
+        editingMessageId?: () => string;
+        chatBoxRef: () => import("react").MutableRefObject<HTMLDivElement>;
+        senderRef: () => import("react").MutableRefObject<import("@ant-design/x/es/sender").SenderRef>;
+        showCodeHistory: () => boolean;
+        model?: () => ModelRef;
+        showDebugPanel: () => boolean;
+        readonly: () => boolean;
+        isShowSenderHint: () => boolean;
+        setOpen: () => (open: boolean) => void;
+        setExpanded: () => (expanded: boolean) => void;
+        setCollapsed: () => (collapsed: boolean) => void;
+        setShowConversations: () => (show: boolean) => void;
+        setMinimize: () => (minus: boolean) => void;
+        setCurrentEmployee: () => (aiEmployee?: AIEmployee | ((prev: AIEmployee) => AIEmployee)) => void;
+        setSenderValue: () => (value: string) => void;
+        setSenderPlaceholder: () => (placeholder: string) => void;
+        setTaskVariables: () => (variables: ChatBoxState['taskVariables']) => void;
+        setRoles: () => (roles: RolesType | ((prev: RolesType) => RolesType)) => void;
+        addRole: () => (name: string, role: unknown) => void;
+        setIsEditingMessage: () => (isEditing: boolean) => void;
+        setEditingMessageId: () => (id?: string) => void;
+        setChatBoxRef: () => (ref: React.MutableRefObject<HTMLDivElement> | null) => void;
+        setSenderRef: () => (ref: React.MutableRefObject<GetRef<typeof Sender>> | null) => void;
+        setShowCodeHistory: () => (show: boolean) => void;
+        setModel: () => (model: ModelRef | null) => void;
+        setShowDebugPanel: () => (show: boolean) => void;
+        setReadonly: () => (readonly: boolean) => void;
+        setShowSenderHint: () => (show: boolean) => void;
+    };
+};
+export {};

package/dist/client-v2/ai-employees/chatbox/stores/chat-conversations.d.ts

@@ -0,0 +1,45 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import type { Conversation } from '../../types';
+interface ChatConversationsState {
+    currentConversation?: string;
+    conversations: Conversation[];
+    keyword: string;
+    webSearch: boolean;
+    conversationSegmented: string;
+    unreadCount: number;
+}
+interface ChatConversationsActions {
+    setCurrentConversation: (id: string | undefined) => void;
+    setKeyword: (keyword: string) => void;
+    setConversations: (conversations: Conversation[] | ((prev: Conversation[]) => Conversation[])) => void;
+    setWebSearch: (webSearch: boolean) => void;
+    setConversationSegmented: (conversationSegmented: string) => void;
+    setUnreadCount: (unreadCount: number | ((prev: number) => number)) => void;
+}
+export declare const useChatConversationsStore: {
+    (): ChatConversationsState & ChatConversationsActions;
+    <U>(selector: (state: ChatConversationsState & ChatConversationsActions) => U): U;
+} & import("zustand").StoreApi<ChatConversationsState & ChatConversationsActions> & {
+    use: {
+        currentConversation?: () => string;
+        conversations: () => Conversation[];
+        keyword: () => string;
+        webSearch: () => boolean;
+        conversationSegmented: () => string;
+        unreadCount: () => number;
+        setCurrentConversation: () => (id: string | undefined) => void;
+        setKeyword: () => (keyword: string) => void;
+        setConversations: () => (conversations: Conversation[] | ((prev: Conversation[]) => Conversation[])) => void;
+        setWebSearch: () => (webSearch: boolean) => void;
+        setConversationSegmented: () => (conversationSegmented: string) => void;
+        setUnreadCount: () => (unreadCount: number | ((prev: number) => number)) => void;
+    };
+};
+export {};

package/dist/client-v2/ai-employees/chatbox/stores/chat-messages.d.ts

@@ -0,0 +1,118 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import type { Attachment, ChatEditorRef, ContextItem, Message, SkillSettings, WebSearching } from '../../types';
+export declare const CHAT_DEFAULT_SESSION_KEY = "__draft__";
+export declare const getChatSessionKey: (sessionId?: string) => string;
+export type ChatSessionState = {
+    messages: Message[];
+    messagesLoading: boolean;
+    messagesError?: unknown;
+    messagesMeta: {
+        cursor?: string;
+        hasMore?: boolean;
+    };
+    attachments: Attachment[];
+    contextItems: ContextItem[];
+    systemMessage: string;
+    responseLoading: boolean;
+    abortController?: AbortController;
+    skillSettings?: SkillSettings;
+    webSearching?: WebSearching;
+    backgroundWorking: boolean;
+    resumeStreamFailed: boolean;
+};
+export declare const CHAT_EMPTY_SESSION_STATE: ChatSessionState;
+type ChatMessagesState = {
+    sessions: Record<string, ChatSessionState>;
+    editorRef?: Record<string, ChatEditorRef | null>;
+    currentEditorRefUid?: string;
+    flowContext?: unknown;
+};
+type SessionStateUpdater<T> = T | ((prev: T) => T);
+export interface ChatMessagesActions {
+    setEditorRef: (uid: string, editorRef: ChatEditorRef | null) => void;
+    setCurrentEditorRefUid: (uid: string) => void;
+    setFlowContext: (ctx: unknown) => void;
+    getSessionState: (sessionId?: string) => ChatSessionState;
+    resetSessionState: (sessionId?: string, patch?: Partial<ChatSessionState>) => void;
+    migrateSessionState: (fromSessionId: string | undefined, toSessionId: string) => void;
+    setSessionMessages: (sessionId: string | undefined, messages: SessionStateUpdater<Message[]>) => void;
+    setSessionMessagesLoading: (sessionId: string | undefined, loading: boolean) => void;
+    setSessionMessagesError: (sessionId: string | undefined, error: unknown) => void;
+    setSessionMessagesMeta: (sessionId: string | undefined, meta: ChatSessionState['messagesMeta'] | ((prev: ChatSessionState['messagesMeta']) => ChatSessionState['messagesMeta'])) => void;
+    setSessionAttachments: (sessionId: string | undefined, attachments: SessionStateUpdater<Attachment[]>) => void;
+    setSessionContextItems: (sessionId: string | undefined, items: SessionStateUpdater<ContextItem[]>) => void;
+    setSessionSystemMessage: (sessionId: string | undefined, msg: string | ((prev: string) => string)) => void;
+    setSessionResponseLoading: (sessionId: string | undefined, loading: boolean) => void;
+    setSessionBackgroundWorking: (sessionId: string | undefined, backgroundWorking: boolean) => void;
+    setSessionResumeStreamFailed: (sessionId: string | undefined, resumeStreamFailed: boolean) => void;
+    addSessionMessage: (sessionId: string | undefined, msg: Message) => void;
+    addSessionMessages: (sessionId: string | undefined, msgs: Message[]) => void;
+    updateSessionLastMessage: (sessionId: string | undefined, updater: (msg: Message) => Message) => void;
+    removeSessionMessage: (sessionId: string | undefined, key: string) => void;
+    addSessionAttachments: (sessionId: string | undefined, attachments: Attachment | Attachment[]) => void;
+    removeSessionAttachment: (sessionId: string | undefined, filename: string) => void;
+    addSessionContextItems: (sessionId: string | undefined, items: ContextItem | ContextItem[]) => void;
+    addContextItems: (items: ContextItem | ContextItem[]) => void;
+    removeSessionContextItem: (sessionId: string | undefined, type: string, uid: string) => void;
+    setSessionAbortController: (sessionId: string | undefined, controller: AbortController | undefined) => void;
+    setSessionSkillSettings: (sessionId: string | undefined, settings: SkillSettings | undefined) => void;
+    setSessionWebSearching: (sessionId: string | undefined, webSearching: WebSearching) => void;
+    addSessionSubAgentMessage: (sessionId: string | undefined, subSessionId: string, msg: Message) => void;
+    addSessionSubAgentMessages: (sessionId: string | undefined, subSessionId: string, msgs: Message[]) => void;
+    updateSessionLastSubAgentMessage: (sessionId: string | undefined, subSessionId: string, username: string, updater: (msg: Message) => Message) => void;
+    updateSessionSubAgentConversationStatus: (sessionId: string | undefined, subSessionId: string, status: 'pending' | 'completed') => void;
+}
+export declare const useChatMessagesStore: {
+    (): ChatMessagesState & ChatMessagesActions;
+    <U>(selector: (state: ChatMessagesState & ChatMessagesActions) => U): U;
+} & import("zustand").StoreApi<ChatMessagesState & ChatMessagesActions> & {
+    use: {
+        sessions: () => Record<string, ChatSessionState>;
+        editorRef?: () => Record<string, ChatEditorRef>;
+        currentEditorRefUid?: () => string;
+        flowContext?: () => unknown;
+        setEditorRef: () => (uid: string, editorRef: ChatEditorRef | null) => void;
+        setCurrentEditorRefUid: () => (uid: string) => void;
+        setFlowContext: () => (ctx: unknown) => void;
+        getSessionState: () => (sessionId?: string) => ChatSessionState;
+        resetSessionState: () => (sessionId?: string, patch?: Partial<ChatSessionState>) => void;
+        migrateSessionState: () => (fromSessionId: string | undefined, toSessionId: string) => void;
+        setSessionMessages: () => (sessionId: string | undefined, messages: SessionStateUpdater<Message[]>) => void;
+        setSessionMessagesLoading: () => (sessionId: string | undefined, loading: boolean) => void;
+        setSessionMessagesError: () => (sessionId: string | undefined, error: unknown) => void;
+        setSessionMessagesMeta: () => (sessionId: string | undefined, meta: {
+            cursor?: string;
+            hasMore?: boolean;
+        } | ((prev: ChatSessionState['messagesMeta']) => ChatSessionState['messagesMeta'])) => void;
+        setSessionAttachments: () => (sessionId: string | undefined, attachments: SessionStateUpdater<Attachment[]>) => void;
+        setSessionContextItems: () => (sessionId: string | undefined, items: SessionStateUpdater<ContextItem[]>) => void;
+        setSessionSystemMessage: () => (sessionId: string | undefined, msg: string | ((prev: string) => string)) => void;
+        setSessionResponseLoading: () => (sessionId: string | undefined, loading: boolean) => void;
+        setSessionBackgroundWorking: () => (sessionId: string | undefined, backgroundWorking: boolean) => void;
+        setSessionResumeStreamFailed: () => (sessionId: string | undefined, resumeStreamFailed: boolean) => void;
+        addSessionMessage: () => (sessionId: string | undefined, msg: Message) => void;
+        addSessionMessages: () => (sessionId: string | undefined, msgs: Message[]) => void;
+        updateSessionLastMessage: () => (sessionId: string | undefined, updater: (msg: Message) => Message) => void;
+        removeSessionMessage: () => (sessionId: string | undefined, key: string) => void;
+        addSessionAttachments: () => (sessionId: string | undefined, attachments: Attachment | Attachment[]) => void;
+        removeSessionAttachment: () => (sessionId: string | undefined, filename: string) => void;
+        addSessionContextItems: () => (sessionId: string | undefined, items: ContextItem | ContextItem[]) => void;
+        addContextItems: () => (items: ContextItem | ContextItem[]) => void;
+        removeSessionContextItem: () => (sessionId: string | undefined, type: string, uid: string) => void;
+        setSessionAbortController: () => (sessionId: string | undefined, controller: AbortController | undefined) => void;
+        setSessionSkillSettings: () => (sessionId: string | undefined, settings: SkillSettings | undefined) => void;
+        setSessionWebSearching: () => (sessionId: string | undefined, webSearching: WebSearching) => void;
+        addSessionSubAgentMessage: () => (sessionId: string | undefined, subSessionId: string, msg: Message) => void;
+        addSessionSubAgentMessages: () => (sessionId: string | undefined, subSessionId: string, msgs: Message[]) => void;
+        updateSessionLastSubAgentMessage: () => (sessionId: string | undefined, subSessionId: string, username: string, updater: (msg: Message) => Message) => void;
+        updateSessionSubAgentConversationStatus: () => (sessionId: string | undefined, subSessionId: string, status: 'pending' | 'completed') => void;
+    };
+};
+export {};

package/dist/client-v2/ai-employees/chatbox/stores/create-selectors.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import type { StoreApi, UseBoundStore } from 'zustand';
+type WithSelectors<S> = S extends {
+    getState: () => infer T;
+} ? S & {
+    use: {
+        [K in keyof T]: () => T[K];
+    };
+} : never;
+export declare const createSelectors: <S extends UseBoundStore<StoreApi<object>>>(_store: S) => WithSelectors<S>;
+export {};

package/dist/client-v2/ai-employees/chatbox/stores/global-store.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+export declare const getOrCreateGlobalStore: <T>(key: string, createStore: () => T) => T;

package/dist/client-v2/ai-employees/types.d.ts

@@ -6,6 +6,8 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
+/// <reference types="react" />
+import type { BubbleProps } from '@ant-design/x';
 export type AIEmployee = {
     username: string;
     nickname?: string;
@@ -13,8 +15,157 @@ export type AIEmployee = {
     avatar?: string;
     bio?: string;
     greeting?: string;
+    userConfig?: {
+        prompt?: string;
+    };
+    skillSettings?: {
+        tools?: {
+            name: string;
+            autoCall?: boolean;
+        }[];
+        skills?: string[];
+    };
+    chatSettings?: {
+        systemPromptMode?: 'default' | 'raw' | 'none';
+        enableSkills?: boolean;
+        enableTools?: boolean;
+        [key: string]: unknown;
+    };
+    builtIn?: boolean;
+    webSearch?: boolean;
+    toolsConflict?: boolean;
     category?: string;
+    deprecated?: boolean;
+    modelSettings?: {
+        enabled?: boolean;
+        llmService?: string;
+        model?: string;
+        models?: {
+            llmService?: string;
+            model?: string;
+        }[];
+    };
+};
+export type SkillSettings = {
+    toolsVersion?: number;
+    skillsVersion?: number;
+    tools?: string[];
+    skills?: string[];
+};
+export type Conversation = {
+    sessionId: string;
+    title: string;
+    updatedAt: string;
+    aiEmployee: AIEmployee;
+    read: boolean;
+    options?: {
+        modelSettings?: {
+            llmService?: string;
+            model?: string;
+        };
+        [key: string]: any;
+    };
+};
+export type ContextItem = {
+    type: string;
+    uid: string;
+    title?: string;
+    content?: unknown;
+};
+export type ToolCall<T = unknown> = {
+    id: string;
+    type: string;
+    name: string;
+    status?: 'success' | 'error';
+    invokeStatus: 'init' | 'interrupted' | 'waiting' | 'pending' | 'done' | 'confirmed';
+    auto: boolean;
+    args: T;
+    [key: string]: any;
+};
+export type Attachment = any;
+export type MessageType = 'text' | 'greeting';
+export type Message = Omit<BubbleProps, 'content'> & {
+    key?: string | number;
+    role?: string;
+    createdAt?: string | Date;
+    content: {
+        content: any;
+        ref?: React.MutableRefObject<any>;
+        type?: MessageType;
+        messageId?: string;
+        attachments?: Attachment[];
+        workContext?: ContextItem[];
+        tool_calls?: ToolCall<unknown>[];
+        metadata?: {
+            model: string;
+            provider: string;
+            llmService?: string;
+            usage_metadata?: {
+                input_tokens: number;
+                output_tokens: number;
+                total_tokens: number;
+            };
+            autoCallTools?: string[];
+        };
+        reference?: {
+            title: string;
+            url: string;
+        }[];
+        reasoning?: {
+            status: string;
+            content: string;
+        };
+        subAgentConversations?: {
+            sessionId: string;
+            toolCallId?: string;
+            status?: 'pending' | 'completed';
+            messages: Message[];
+        }[];
+        from?: 'main-agent' | 'sub-agent';
+    };
+};
+export type TaskMessage = {
+    user?: string;
+    system?: string;
+    attachments?: Attachment[];
+    workContext?: ContextItem[];
 };
 export type Task = {
     title?: string;
+    message?: TaskMessage;
+    autoSend?: boolean;
+    skillSettings?: SkillSettings;
+    webSearch?: boolean;
+    model?: {
+        llmService: string;
+        model: string;
+    } | null;
+};
+export type TriggerTaskOptions = {
+    aiEmployee?: AIEmployee;
+    tasks?: Task[];
+    auto?: boolean;
+};
+export type ClearOptions = {
+    sender?: boolean;
+    systemMessage?: boolean;
+    attachments?: boolean;
+    contextItems?: boolean;
+    taskVariables?: boolean;
+    toolModal?: boolean;
+    activeTool?: boolean;
+    activeMessageId?: boolean;
+    skillSettings?: boolean;
+};
+export type WebSearching = {
+    type: string;
+    query: string;
 };
+export interface ChatEditorRef {
+    write(document: string): void;
+    read(): string;
+    run?(): Promise<unknown>;
+    buttonGroupHeight?: number;
+    snippetEntries: unknown[];
+    logs: unknown[];
+}

package/dist/client-v2/index.d.ts

@@ -8,10 +8,17 @@
  */
 import { Plugin } from '@nocobase/client-v2';
 export declare class PluginAIClientV2 extends Plugin {
+    load(): Promise<void>;
 }
 export default PluginAIClientV2;
 export { AIEmployeeProfileCard } from './ai-employees/ProfileCard';
 export { AIEmployeeShortcut } from './ai-employees/AIEmployeeShortcut';
 export { avatars, avatarsMap } from './ai-employees/avatars';
-export type { AIEmployee, Task } from './ai-employees/types';
+export type { AIEmployee, Attachment, ChatEditorRef, ContextItem, Conversation, Message, SkillSettings, Task, TriggerTaskOptions, WebSearching, } from './ai-employees/types';
 export { formatModelLabel } from './llm-services/model-label';
+export { AIConfigRepository } from './repositories/AIConfigRepository';
+export { useAIConfigRepository } from './repositories/hooks/useAIConfigRepository';
+export { useChatMessagesStore } from './ai-employees/chatbox/stores/chat-messages';
+export { useChatBoxStore } from './ai-employees/chatbox/stores/chat-box';
+export { useChatConversationsStore } from './ai-employees/chatbox/stores/chat-conversations';
+export { useChatBoxActions } from './ai-employees/chatbox/hooks/useChatBoxActions';