@lobehub/chat 0.94.4 → 0.95.0

package/src/store/session/slices/chat/actions/message.ts

@@ -1,15 +1,12 @@
-import { PluginRequestPayload } from '@lobehub/chat-plugin-sdk';
 import { template } from 'lodash-es';
 import { StateCreator } from 'zustand/vanilla';
 
 import { LOADING_FLAT } from '@/const/message';
-import { PLUGIN_SCHEMA_SEPARATOR } from '@/const/plugin';
 import { fetchChatModel } from '@/services/chatModel';
-import { fetchPlugin } from '@/services/plugin';
 import { SessionStore } from '@/store/session';
-import { ChatMessage, OpenAIFunctionCall } from '@/types/chatMessage';
+import { ChatMessage } from '@/types/chatMessage';
 import { fetchSSE } from '@/utils/fetch';
-import { isFunctionMessage } from '@/utils/message';
+import { isFunctionMessageAtStart, testFunctionMessageAtEnd } from '@/utils/message';
 import { setNamespace } from '@/utils/storeDebug';
 import { nanoid } from '@/utils/uuid';
 
@@ -29,6 +26,12 @@ export interface ChatMessageAction {
    * 清除消息
    */
   clearMessage: () => void;
+  /**
+   * 处理 ai 消息的核心逻辑（包含前处理与后处理）
+   * @param messages - 聊天消息数组
+   * @param parentId - 父消息 ID，可选
+   */
+  coreProcessMessage: (messages: ChatMessage[], parentId: string) => Promise<void>;
   /**
    * 删除消息
    * @param id - 消息 ID
@@ -40,21 +43,19 @@ export interface ChatMessageAction {
    */
   dispatchMessage: (payload: MessageDispatch) => void;
   /**
-   * 生成消息
+   * 实际获取 AI 响应
    * @param messages - 聊天消息数组
    * @param options - 获取 SSE 选项
    */
-  generateMessage: (
+  fetchAIChatMessage: (
     messages: ChatMessage[],
     assistantMessageId: string,
-  ) => Promise<{ isFunctionCall: boolean }>;
-  /**
-   * 实际获取 AI 响应
-   *
-   * @param messages - 聊天消息数组
-   * @param parentId - 父消息 ID，可选
-   */
-  realFetchAIResponse: (messages: ChatMessage[], parentId: string) => Promise<void>;
+  ) => Promise<{
+    content: string;
+    functionCallAtEnd: boolean;
+    functionCallContent: string;
+    isFunctionCall: boolean;
+  }>;
 
   /**
    * 重新发送消息
@@ -73,8 +74,6 @@ export interface ChatMessageAction {
     id?: string,
     action?: string,
   ) => AbortController | undefined;
-
-  triggerFunctionCall: (id: string) => Promise<void>;
 }
 
 export const chatMessage: StateCreator<
@@ -93,10 +92,74 @@ export const chatMessage: StateCreator<
     }
   },
 
+  coreProcessMessage: async (messages, userMessageId) => {
+    const { dispatchMessage, fetchAIChatMessage, triggerFunctionCall, activeTopicId } = get();
+
+    const { model } = agentSelectors.currentAgentConfig(get());
+
+    // 添加一个空的信息用于放置 ai 响应，注意顺序不能反
+    // 因为如果顺序反了，messages 中将包含新增的 ai message
+    const mid = nanoid();
+
+    dispatchMessage({
+      id: mid,
+      message: LOADING_FLAT,
+      parentId: userMessageId,
+      role: 'assistant',
+      type: 'addMessage',
+    });
+
+    // 如果有 activeTopicId，则添加 topicId
+    if (activeTopicId) {
+      dispatchMessage({ id: mid, key: 'topicId', type: 'updateMessage', value: activeTopicId });
+    }
+
+    // 为模型添加 fromModel 的额外信息
+    dispatchMessage({ id: mid, key: 'fromModel', type: 'updateMessageExtra', value: model });
+
+    // 生成 ai message
+    const { isFunctionCall, content, functionCallAtEnd, functionCallContent } =
+      await fetchAIChatMessage(messages, mid);
+
+    // 如果是 function，则发送函数调用方法
+    if (isFunctionCall) {
+      let functionId = mid;
+
+      if (functionCallAtEnd) {
+        // create a new separate message and remove the function call from the prev message
+        dispatchMessage({
+          id: mid,
+          key: 'content',
+          type: 'updateMessage',
+          value: content.replace(functionCallContent, ''),
+        });
+
+        functionId = nanoid();
+        dispatchMessage({
+          id: functionId,
+          message: functionCallContent,
+          parentId: userMessageId,
+          role: 'assistant',
+          type: 'addMessage',
+        });
+
+        // also add activeTopicId
+        if (activeTopicId)
+          dispatchMessage({
+            id: functionId,
+            key: 'topicId',
+            type: 'updateMessage',
+            value: activeTopicId,
+          });
+      }
+
+      triggerFunctionCall(functionId);
+    }
+  },
+
   deleteMessage: (id) => {
     get().dispatchMessage({ id, type: 'deleteMessage' });
   },
-
   dispatchMessage: (payload) => {
     const { activeId } = get();
     const session = sessionSelectors.currentSession(get());
@@ -106,7 +169,8 @@ export const chatMessage: StateCreator<
 
     get().dispatchSession({ chats, id: activeId, type: 'updateSessionChat' });
   },
-  generateMessage: async (messages, assistantId) => {
+
+  fetchAIChatMessage: async (messages, assistantId) => {
     const { dispatchMessage, toggleChatLoading } = get();
 
     const abortController = toggleChatLoading(
@@ -160,6 +224,8 @@ export const chatMessage: StateCreator<
 
     let output = '';
     let isFunctionCall = false;
+    let functionCallAtEnd = false;
+    let functionCallContent = '';
 
     await fetchSSE(fetcher, {
       onErrorHandle: (error) => {
@@ -168,15 +234,10 @@ export const chatMessage: StateCreator<
       onMessageHandle: (text) => {
         output += text;
 
-        dispatchMessage({
-          id: assistantId,
-          key: 'content',
-          type: 'updateMessage',
-          value: output,
-        });
+        dispatchMessage({ id: assistantId, key: 'content', type: 'updateMessage', value: output });
 
-        // 如果是 function call
-        if (isFunctionMessage(output)) {
+        // is this message is just a function call
+        if (isFunctionMessageAtStart(output)) {
           isFunctionCall = true;
         }
       },
@@ -184,41 +245,19 @@ export const chatMessage: StateCreator<
 
     toggleChatLoading(false, undefined, t('generateMessage(end)') as string);
 
-    return { isFunctionCall };
-  },
-
-  realFetchAIResponse: async (messages, userMessageId) => {
-    const { dispatchMessage, generateMessage, triggerFunctionCall, activeTopicId } = get();
-
-    const { model } = agentSelectors.currentAgentConfig(get());
+    // also exist message like this: 请稍等，我帮您查询一下。{"function_call": {"name": "plugin-identifier____recommendClothes____standalone", "arguments": "{\n "mood": "",\n "gender": "man"\n}"}}
+    if (!isFunctionCall) {
+      const { content, valid } = testFunctionMessageAtEnd(output);
 
-    // 添加一个空的信息用于放置 ai 响应，注意顺序不能反
-    // 因为如果顺序反了，messages 中将包含新增的 ai message
-    const mid = nanoid();
-
-    dispatchMessage({
-      id: mid,
-      message: LOADING_FLAT,
-      parentId: userMessageId,
-      role: 'assistant',
-      type: 'addMessage',
-    });
-
-    // 如果有 activeTopicId，则添加 topicId
-    if (activeTopicId) {
-      dispatchMessage({ id: mid, key: 'topicId', type: 'updateMessage', value: activeTopicId });
+      // if fc at end, replace the message
+      if (valid) {
+        isFunctionCall = true;
+        functionCallAtEnd = true;
+        functionCallContent = content;
+      }
     }
 
-    // 为模型添加 fromModel 的额外信息
-    dispatchMessage({ id: mid, key: 'fromModel', type: 'updateMessageExtra', value: model });
-
-    // 生成 ai message
-    const { isFunctionCall } = await generateMessage(messages, mid);
-
-    // 如果是 function，则发送函数调用方法
-    if (isFunctionCall) {
-      triggerFunctionCall(mid);
-    }
+    return { content: output, functionCallAtEnd, functionCallContent, isFunctionCall };
   },
 
   resendMessage: async (messageId) => {
@@ -254,17 +293,17 @@ export const chatMessage: StateCreator<
 
     if (contextMessages.length <= 0) return;
 
-    const { realFetchAIResponse } = get();
+    const { coreProcessMessage } = get();
 
     const latestMsg = contextMessages.filter((s) => s.role === 'user').at(-1);
 
     if (!latestMsg) return;
 
-    await realFetchAIResponse(contextMessages, latestMsg.id);
+    await coreProcessMessage(contextMessages, latestMsg.id);
   },
 
   sendMessage: async (message) => {
-    const { dispatchMessage, realFetchAIResponse, activeTopicId } = get();
+    const { dispatchMessage, coreProcessMessage, activeTopicId } = get();
     const session = sessionSelectors.currentSession(get());
     if (!session || !message) return;
 
@@ -279,7 +318,7 @@ export const chatMessage: StateCreator<
     // Get the current messages to generate AI response
     const messages = chatSelectors.currentChats(get());
 
-    await realFetchAIResponse(messages, userId);
+    await coreProcessMessage(messages, userId);
 
     // check activeTopic and then auto create topic
     const chats = chatSelectors.currentChats(get());
@@ -308,58 +347,4 @@ export const chatMessage: StateCreator<
       set({ abortController: undefined, chatLoadingId: undefined }, false, action);
     }
   },
-
-  triggerFunctionCall: async (id) => {
-    const { dispatchMessage, realFetchAIResponse, toggleChatLoading } = get();
-    const session = sessionSelectors.currentSession(get());
-
-    if (!session) return;
-
-    const message = session.chats[id];
-    if (!message) return;
-
-    let payload: PluginRequestPayload = { apiName: '', identifier: '' };
-    // 识别到内容是 function_call 的情况下
-    // 将 function_call 转换为 plugin request payload
-    if (message.content) {
-      const { function_call } = JSON.parse(message.content) as {
-        function_call: OpenAIFunctionCall;
-      };
-
-      const [identifier, apiName] = function_call.name.split(PLUGIN_SCHEMA_SEPARATOR);
-      payload = { apiName, arguments: function_call.arguments, identifier };
-
-      dispatchMessage({ id, key: 'plugin', type: 'updateMessage', value: payload });
-      dispatchMessage({ id, key: 'content', type: 'updateMessage', value: '' });
-    } else {
-      if (message.plugin) {
-        payload = message.plugin;
-      }
-    }
-
-    if (!payload.apiName) return;
-
-    dispatchMessage({ id, key: 'role', type: 'updateMessage', value: 'function' });
-    dispatchMessage({ id, key: 'name', type: 'updateMessage', value: payload.identifier });
-    dispatchMessage({ id, key: 'plugin', type: 'updateMessage', value: payload });
-
-    let data: string;
-    try {
-      const abortController = toggleChatLoading(true, id);
-      data = await fetchPlugin(payload, { signal: abortController?.signal });
-    } catch (error) {
-      dispatchMessage({ id, key: 'error', type: 'updateMessage', value: error });
-
-      data = '';
-    }
-    toggleChatLoading(false);
-    // 如果报错则结束了
-    if (!data) return;
-
-    dispatchMessage({ id, key: 'content', type: 'updateMessage', value: data });
-
-    const chats = chatSelectors.currentChats(get());
-
-    await realFetchAIResponse(chats, message.id);
-  },
 });

package/src/store/session/slices/chat/actions/plugin.ts

@@ -0,0 +1,109 @@
+import { PluginRequestPayload } from '@lobehub/chat-plugin-sdk';
+import { StateCreator } from 'zustand/vanilla';
+
+import { PLUGIN_SCHEMA_SEPARATOR } from '@/const/plugin';
+import { fetchPlugin } from '@/services/plugin';
+import { SessionStore } from '@/store/session';
+import { OpenAIFunctionCall } from '@/types/chatMessage';
+import { setNamespace } from '@/utils/storeDebug';
+
+import { sessionSelectors } from '../../session/selectors';
+import { chatSelectors } from '../selectors';
+
+const t = setNamespace('chat/plugin');
+
+/**
+ * 插件方法
+ */
+export interface ChatPluginAction {
+  fillPluginMessageContent: (id: string, content: string) => Promise<void>;
+  runPluginDefaultType: (id: string, payload: any) => Promise<void>;
+  triggerFunctionCall: (id: string) => Promise<void>;
+  updatePluginState: (id: string, key: string, value: any) => void;
+}
+
+export const chatPlugin: StateCreator<
+  SessionStore,
+  [['zustand/devtools', never]],
+  [],
+  ChatPluginAction
+> = (set, get) => ({
+  fillPluginMessageContent: async (id, content) => {
+    const { dispatchMessage, coreProcessMessage } = get();
+
+    dispatchMessage({ id, key: 'content', type: 'updateMessage', value: content });
+
+    const chats = chatSelectors.currentChats(get());
+    await coreProcessMessage(chats, id);
+  },
+  runPluginDefaultType: async (id, payload) => {
+    const { dispatchMessage, coreProcessMessage, toggleChatLoading } = get();
+    let data: string;
+    try {
+      const abortController = toggleChatLoading(true, id, t('fetchPlugin') as string);
+      data = await fetchPlugin(payload, { signal: abortController?.signal });
+    } catch (error) {
+      dispatchMessage({ id, key: 'error', type: 'updateMessage', value: error });
+
+      data = '';
+    }
+    toggleChatLoading(false);
+    // 如果报错则结束了
+    if (!data) return;
+
+    dispatchMessage({ id, key: 'content', type: 'updateMessage', value: data });
+
+    const chats = chatSelectors.currentChats(get());
+    await coreProcessMessage(chats, id);
+  },
+  triggerFunctionCall: async (id) => {
+    const { dispatchMessage, runPluginDefaultType } = get();
+    const session = sessionSelectors.currentSession(get());
+
+    if (!session) return;
+
+    const message = session.chats[id];
+    if (!message) return;
+
+    let payload: PluginRequestPayload = { apiName: '', identifier: '' };
+
+    // 识别到内容是 function_call 的情况下
+    // 将 function_call 转换为 plugin request payload
+    if (message.content) {
+      const { function_call } = JSON.parse(message.content) as {
+        function_call: OpenAIFunctionCall;
+      };
+
+      const [identifier, apiName, type] = function_call.name.split(PLUGIN_SCHEMA_SEPARATOR);
+
+      payload = {
+        apiName,
+        arguments: function_call.arguments,
+        identifier,
+        type: type ?? 'default',
+      };
+
+      dispatchMessage({ id, key: 'plugin', type: 'updateMessage', value: payload });
+      dispatchMessage({ id, key: 'content', type: 'updateMessage', value: '' });
+    } else {
+      if (message.plugin) {
+        payload = message.plugin;
+      }
+    }
+
+    if (!payload.apiName) return;
+
+    dispatchMessage({ id, key: 'role', type: 'updateMessage', value: 'function' });
+    dispatchMessage({ id, key: 'name', type: 'updateMessage', value: payload.identifier });
+    dispatchMessage({ id, key: 'plugin', type: 'updateMessage', value: payload });
+
+    if (payload.type === 'standalone') {
+      // nothing to do
+    } else runPluginDefaultType(id, payload);
+  },
+  updatePluginState: (id, key, value) => {
+    const { dispatchMessage } = get();
+
+    dispatchMessage({ id, key, type: 'updatePluginState', value });
+  },
+});

package/src/store/session/slices/chat/reducers/message.ts

@@ -1,8 +1,10 @@
+import isEqual from 'fast-deep-equal';
 import { produce } from 'immer';
 
 import { ChatMessage, ChatMessageMap } from '@/types/chatMessage';
 import { LLMRoleType } from '@/types/llm';
 import { MetaData } from '@/types/meta';
+import { merge } from '@/utils/merge';
 import { nanoid } from '@/utils/uuid';
 
 interface AddMessage {
@@ -38,12 +40,20 @@ interface UpdateMessageExtra {
   value: any;
 }
 
+interface UpdatePluginState {
+  id: string;
+  key: string;
+  type: 'updatePluginState';
+  value: any;
+}
+
 export type MessageDispatch =
   | AddMessage
   | DeleteMessage
   | ResetMessages
   | UpdateMessage
-  | UpdateMessageExtra;
+  | UpdateMessageExtra
+  | UpdatePluginState;
 
 export const messagesReducer = (
   state: ChatMessageMap,
@@ -101,6 +111,26 @@ export const messagesReducer = (
       });
     }
 
+    case 'updatePluginState': {
+      return produce(state, (draftState) => {
+        const { id, key, value } = payload;
+        const message = draftState[id];
+        if (!message) return;
+
+        let newState;
+        if (!message.pluginState) {
+          newState = { [key]: value } as any;
+        } else {
+          newState = merge(message.pluginState, { [key]: value });
+        }
+
+        if (isEqual(message.pluginState, newState)) return;
+
+        message.pluginState = newState;
+        message.updateAt = Date.now();
+      });
+    }
+
     case 'resetMessages': {
       return produce(state, (draftState) => {
         const { topicId } = payload;

package/src/store/session/slices/chat/selectors/chat.ts

@@ -1,6 +1,6 @@
+import { LobePluginType } from '@lobehub/chat-plugin-sdk';
 import { t } from 'i18next';
 
-import { FunctionCallProps } from '@/app/chat/features/Conversation/ChatList/Plugins/FunctionCall';
 import { DEFAULT_INBOX_AVATAR, DEFAULT_USER_AVATAR } from '@/const/meta';
 import { INBOX_SESSION_ID } from '@/const/session';
 import { useGlobalStore } from '@/store/global';
@@ -92,22 +92,19 @@ export const chatsMessageString = (s: SessionStore): string => {
   return chats.map((m) => m.content).join('');
 };
 
-export const getFunctionMessageParams =
-  (
-    s: SessionStore,
-  ): ((
-    props: Pick<ChatMessage, 'plugin' | 'function_call' | 'content' | 'id'>,
-  ) => FunctionCallProps) =>
-  ({ plugin, function_call, content, id }) => {
-    const itemId = plugin?.identifier || function_call?.name;
-    const command = plugin ?? function_call;
-    const args = command?.arguments;
-
-    return {
-      arguments: args,
-      command,
-      content,
-      id: itemId,
-      loading: id === s.chatLoadingId,
-    };
-  };
+export const getFunctionMessageProps =
+  ({ plugin, content, id }: Pick<ChatMessage, 'plugin' | 'content' | 'id'>) =>
+  (s: SessionStore) => ({
+    arguments: plugin?.arguments,
+    command: plugin,
+    content,
+    id: plugin?.identifier,
+    loading: id === s.chatLoadingId,
+    type: plugin?.type as LobePluginType,
+  });
+
+export const getMessageById = (id: string) => (s: SessionStore) => {
+  for (const e of Object.values(s.sessions)) {
+    if (e.chats[id]) return e.chats[id];
+  }
+};

package/src/store/session/slices/chat/selectors/index.ts

@@ -4,7 +4,8 @@ import {
   currentChatsWithGuideMessage,
   currentChatsWithHistoryConfig,
   getChatsById,
-  getFunctionMessageParams,
+  getFunctionMessageProps,
+  getMessageById,
 } from './chat';
 import { currentTopics, getTopicMessages } from './topic';
 
@@ -14,7 +15,8 @@ export const chatSelectors = {
   currentChatsWithGuideMessage,
   currentChatsWithHistoryConfig,
   getChatsById,
-  getFunctionMessageParams,
+  getFunctionMessageProps,
+  getMessageById,
 };
 
 export const topicSelectors = {

package/src/types/chatMessage.ts

@@ -46,6 +46,7 @@ export interface ChatMessage extends BaseDataModel {
   parentId?: string;
 
   plugin?: PluginRequestPayload;
+  pluginState?: any;
 
   // 引用
   quotaId?: string;

package/src/utils/message.ts

@@ -1,9 +1,16 @@
 import { FUNCTION_MESSAGE_FLAG } from '@/const/message';
 
-export const isFunctionMessage = (content: string) => {
+export const isFunctionMessageAtStart = (content: string) => {
   return content.startsWith(FUNCTION_MESSAGE_FLAG);
 };
 
+export const testFunctionMessageAtEnd = (content: string) => {
+  const regExp = /{"function_call":.*?}}/;
+  const match = content.match(regExp);
+
+  return { content: match ? match[0] : '', valid: match };
+};
+
 // export const createFunctionCallMessage = () => {
 //   return [
 //     {

package/src/app/chat/features/Conversation/ChatList/Plugins/IFrameRender/hooks.ts

@@ -1,29 +0,0 @@
-import { useEffect } from 'react';
-
-import { onPluginFetchMessage, onPluginReady } from './utils';
-
-export const useOnPluginReady = (onReady: () => void) => {
-  useEffect(() => {
-    const fn = (e: MessageEvent) => {
-      onPluginReady(e, onReady);
-    };
-
-    window.addEventListener('message', fn);
-    return () => {
-      window.removeEventListener('message', fn);
-    };
-  }, []);
-};
-
-export const useOnPluginFetchMessage = (onRequest: (data: any) => void, deps: any[] = []) => {
-  useEffect(() => {
-    const fn = (e: MessageEvent) => {
-      onPluginFetchMessage(e, onRequest);
-    };
-
-    window.addEventListener('message', fn);
-    return () => {
-      window.removeEventListener('message', fn);
-    };
-  }, deps);
-};

package/src/app/chat/features/Conversation/ChatList/Plugins/IFrameRender/utils.ts

@@ -1,17 +0,0 @@
-import { PluginChannel } from '@lobehub/chat-plugin-sdk/client';
-
-export const onPluginReady = (e: MessageEvent, onReady: () => void) => {
-  if (e.data.type === PluginChannel.pluginReadyForRender) {
-    onReady();
-  }
-};
-
-export const onPluginFetchMessage = (e: MessageEvent, onRequest: (data: any) => void) => {
-  if (e.data.type === PluginChannel.fetchPluginMessage) {
-    onRequest(e.data);
-  }
-};
-
-export const sendMessageToPlugin = (window: Window, props: any) => {
-  window.postMessage({ props, type: PluginChannel.renderPlugin }, '*');
-};