@lobehub/chat 0.72.3 → 0.73.0

package/src/store/global/selectors.test.ts

@@ -0,0 +1,264 @@
+import { LanguageModel } from '@/types/llm';
+
+import { globalSelectors } from './selectors';
+import { GlobalStore } from './store';
+
+describe('globalSelectors', () => {
+  describe('currentSettings', () => {
+    it('should merge DEFAULT_SETTINGS and s.settings correctly', () => {
+      const s = {
+        settings: {
+          avatar: 'avatar.jpg',
+          fontSize: 14,
+          language: 'en-US',
+          neutralColor: 'sand',
+          password: 'password123',
+          primaryColor: 'blue',
+          themeMode: 'light',
+          defaultAgent: {
+            config: {
+              systemRole: '',
+              model: LanguageModel.GPT3_5,
+              params: {},
+            },
+            meta: {
+              avatar: 'Default Agent',
+              description: 'Default agent for testing',
+            },
+          },
+          languageModel: {
+            openAI: {
+              OPENAI_API_KEY: 'openai-api-key',
+              endpoint: 'https://openai-endpoint.com',
+              models: ['gpt-3.5-turbo'],
+            },
+          },
+        },
+      } as unknown as GlobalStore;
+
+      const result = globalSelectors.currentSettings(s);
+
+      expect(result).toEqual({
+        avatar: 'avatar.jpg',
+        fontSize: 14,
+        language: 'en-US',
+        neutralColor: 'sand',
+        password: 'password123',
+        primaryColor: 'blue',
+        themeMode: 'light',
+        defaultAgent: {
+          config: {
+            displayMode: 'chat',
+            historyCount: 1,
+            systemRole: '',
+            model: LanguageModel.GPT3_5,
+            params: {
+              frequency_penalty: 0,
+              presence_penalty: 0,
+              temperature: 0.6,
+              top_p: 1,
+            },
+            plugins: [],
+          },
+          meta: {
+            avatar: 'Default Agent',
+            description: 'Default agent for testing',
+          },
+        },
+        languageModel: {
+          openAI: {
+            OPENAI_API_KEY: 'openai-api-key',
+            azureApiVersion: '2023-08-01-preview',
+            endpoint: 'https://openai-endpoint.com',
+            models: ['gpt-3.5-turbo'],
+          },
+        },
+      });
+    });
+  });
+  //
+  // describe('defaultAgent', () => {
+  //   it('should merge DEFAULT_AGENT and s.settings.defaultAgent correctly', () => {
+  //     const s: GlobalStore = {
+  //       settings: {
+  //         defaultAgent: {
+  //           config: {
+  //             model: 'gpt-3.5-turbo',
+  //             maxTokens: 100,
+  //           },
+  //           meta: {
+  //             name: 'Default Agent',
+  //             description: 'Default agent for testing',
+  //           },
+  //         },
+  //       },
+  //     };
+  //
+  //     const result = globalSelectors.defaultAgent(s);
+  //
+  //
+  //
+  //     expect(result).toEqual(expected);
+  //   });
+  // });
+  //
+  // describe('defaultAgentConfig', () => {
+  //   it('should merge DEFAULT_AGENT_CONFIG and defaultAgent(s).config correctly', () => {
+  //     const s: GlobalStore = {
+  //       settings: {
+  //         defaultAgent: {
+  //           config: {
+  //             model: 'gpt-3.5-turbo',
+  //             maxTokens: 100,
+  //           },
+  //         },
+  //       },
+  //     };
+  //
+  //     const result = globalSelectors.defaultAgentConfig(s);
+  //
+  //     const defaultAgent = globalSelectors.defaultAgent(s);
+  //     const expected = merge({}, DEFAULT_AGENT_CONFIG, defaultAgent.config);
+  //
+  //     expect(result).toEqual(expected);
+  //   });
+  // });
+  //
+  // describe('defaultAgentMeta', () => {
+  //   it('should merge DEFAULT_AGENT_META and defaultAgent(s).meta correctly', () => {
+  //     const s: GlobalStore = {
+  //       settings: {
+  //         defaultAgent: {
+  //           meta: {
+  //             name: 'Default Agent',
+  //             description: 'Default agent for testing',
+  //           },
+  //         },
+  //       },
+  //     };
+  //
+  //     const result = globalSelectors.defaultAgentMeta(s);
+  //
+  //     const defaultAgent = globalSelectors.defaultAgent(s);
+  //     const expected = merge({}, DEFAULT_AGENT_META, defaultAgent.meta);
+  //
+  //     expect(result).toEqual(expected);
+  //   });
+  // });
+  //
+  // describe('exportSettings', () => {
+  //   it('should remove OPENAI_API_KEY and password fields from s.settings', () => {
+  //     const s: GlobalStore = {
+  //       settings: {
+  //         OPENAI_API_KEY: 'openai-api-key',
+  //         password: 'password123',
+  //         avatar: 'avatar.jpg',
+  //         fontSize: 14,
+  //         language: 'en',
+  //         neutralColor: 'white',
+  //         primaryColor: 'blue',
+  //         themeMode: 'light',
+  //         defaultAgent: {
+  //           config: {
+  //             model: 'gpt-3.5-turbo',
+  //             maxTokens: 100,
+  //           },
+  //           meta: {
+  //             name: 'Default Agent',
+  //             description: 'Default agent for testing',
+  //           },
+  //         },
+  //         languageModel: {
+  //           azureOpenAI: {
+  //             AZURE_API_KEY: 'azure-api-key',
+  //             apiVersion: 'v1',
+  //             endpoint: 'https://azure-openai-endpoint.com',
+  //             models: ['gpt-3.5-turbo'],
+  //           },
+  //           openAI: {
+  //             OPENAI_API_KEY: 'openai-api-key',
+  //             endpoint: 'https://openai-endpoint.com',
+  //             models: ['gpt-3.5-turbo'],
+  //           },
+  //         },
+  //       },
+  //     };
+  //
+  //     const result = globalSelectors.exportSettings(s);
+  //
+  //     const expected = {
+  //       avatar: 'avatar.jpg',
+  //       fontSize: 14,
+  //       language: 'en',
+  //       neutralColor: 'white',
+  //       primaryColor: 'blue',
+  //       themeMode: 'light',
+  //       defaultAgent: {
+  //         config: {
+  //           model: 'gpt-3.5-turbo',
+  //           maxTokens: 100,
+  //         },
+  //         meta: {
+  //           name: 'Default Agent',
+  //           description: 'Default agent for testing',
+  //         },
+  //       },
+  //       languageModel: {
+  //         azureOpenAI: {
+  //           AZURE_API_KEY: 'azure-api-key',
+  //           apiVersion: 'v1',
+  //           endpoint: 'https://azure-openai-endpoint.com',
+  //           models: ['gpt-3.5-turbo'],
+  //         },
+  //         openAI: {
+  //           endpoint: 'https://openai-endpoint.com',
+  //           models: ['gpt-3.5-turbo'],
+  //         },
+  //       },
+  //     };
+  //
+  //     expect(result).toEqual(expected);
+  //   });
+  //
+  //   it('should return the result as GlobalSettings type', () => {
+  //     const s: GlobalStore = {
+  //       settings: {
+  //         avatar: 'avatar.jpg',
+  //         fontSize: 14,
+  //         language: 'en',
+  //         neutralColor: 'white',
+  //         password: 'password123',
+  //         primaryColor: 'blue',
+  //         themeMode: 'light',
+  //         defaultAgent: {
+  //           config: {
+  //             model: 'gpt-3.5-turbo',
+  //             maxTokens: 100,
+  //           },
+  //           meta: {
+  //             name: 'Default Agent',
+  //             description: 'Default agent for testing',
+  //           },
+  //         },
+  //         languageModel: {
+  //           azureOpenAI: {
+  //             AZURE_API_KEY: 'azure-api-key',
+  //             apiVersion: 'v1',
+  //             endpoint: 'https://azure-openai-endpoint.com',
+  //             models: ['gpt-3.5-turbo'],
+  //           },
+  //           openAI: {
+  //             OPENAI_API_KEY: 'openai-api-key',
+  //             endpoint: 'https://openai-endpoint.com',
+  //             models: ['gpt-3.5-turbo'],
+  //           },
+  //         },
+  //       },
+  //     };
+  //
+  //     const result = globalSelectors.exportSettings(s);
+  //
+  //     expect(result).toBeInstanceOf(GlobalSettings);
+  //   });
+  // });
+});

package/src/store/global/selectors.ts

@@ -5,14 +5,13 @@ import { merge } from '@/utils/merge';
 
 import { GlobalStore } from './store';
 
-const currentSettings = (s: GlobalStore) => merge({}, DEFAULT_SETTINGS, s.settings);
+const currentSettings = (s: GlobalStore) => merge(DEFAULT_SETTINGS, s.settings);
 
-const defaultAgent = (s: GlobalStore) => merge({}, DEFAULT_AGENT, s.settings.defaultAgent);
+const defaultAgent = (s: GlobalStore) => merge(DEFAULT_AGENT, s.settings.defaultAgent);
 
-const defaultAgentConfig = (s: GlobalStore) =>
-  merge({}, DEFAULT_AGENT_CONFIG, defaultAgent(s).config);
+const defaultAgentConfig = (s: GlobalStore) => merge(DEFAULT_AGENT_CONFIG, defaultAgent(s).config);
 
-const defaultAgentMeta = (s: GlobalStore) => merge({}, DEFAULT_AGENT_META, defaultAgent(s).meta);
+const defaultAgentMeta = (s: GlobalStore) => merge(DEFAULT_AGENT_META, defaultAgent(s).meta);
 
 export const exportSettings = (s: GlobalStore) => {
   // eslint-disable-next-line @typescript-eslint/no-unused-vars

package/src/store/global/slices/settings.ts

@@ -1,10 +1,13 @@
 import { ThemeMode } from 'antd-style';
+import isEqual from 'fast-deep-equal';
 import { produce } from 'immer';
-import { merge } from 'lodash-es';
+import { DeepPartial } from 'utility-types';
 import type { StateCreator } from 'zustand/vanilla';
 
 import { DEFAULT_AGENT, DEFAULT_SETTINGS } from '@/const/settings';
+import { SettingsTabs } from '@/store/global/initialState';
 import type { GlobalSettings } from '@/types/settings';
+import { merge } from '@/utils/merge';
 import { setNamespace } from '@/utils/storeDebug';
 
 import type { GlobalStore } from '../store';
@@ -24,7 +27,8 @@ export interface SettingsAction {
    * 设置部分配置设置
    * @param settings - 部分配置设置
    */
-  setSettings: (settings: Partial<GlobalSettings>) => void;
+  setSettings: (settings: DeepPartial<GlobalSettings>) => void;
+  switchSettingTabs: (tab: SettingsTabs) => void;
   /**
    * 设置主题模式
    * @param themeMode - 主题模式
@@ -58,11 +62,19 @@ export const createSettingsSlice: StateCreator<
   resetSettings: () => {
     set({ settings: DEFAULT_SETTINGS }, false, t('resetSettings'));
   },
-
   setSettings: (settings) => {
     const oldSetting = get().settings;
-    set({ settings: merge({}, oldSetting, settings) }, false, t('setSettings', settings));
+    const nextSettings = merge(oldSetting, settings);
+
+    if (isEqual(oldSetting, nextSettings)) return;
+
+    set({ settings: merge(oldSetting, settings) }, false, t('setSettings', settings));
   },
+
+  switchSettingTabs: (tab) => {
+    set({ settingsTab: tab });
+  },
+
   switchThemeMode: (themeMode) => {
     get().setSettings({ themeMode });
   },

package/src/store/global/store.ts

@@ -4,9 +4,10 @@ import { shallow } from 'zustand/shallow';
 import { createWithEqualityFn } from 'zustand/traditional';
 import { StateCreator } from 'zustand/vanilla';
 
-import { DEFAULT_AGENT } from '@/const/settings';
+import { DEFAULT_AGENT, DEFAULT_LLM_CONFIG } from '@/const/settings';
 import { isDev } from '@/utils/env';
 
+import { createHyperStorage } from '../middleware/createHyperStorage';
 import { type GlobalState, initialState } from './initialState';
 import { type AgentAction, createAgentSlice } from './slices/agent';
 import { type CommonAction, createCommonSlice } from './slices/common';
@@ -29,6 +30,7 @@ type GlobalPersist = Pick<GlobalStore, 'preference' | 'settings'>;
 const persistOptions: PersistOptions<GlobalStore, GlobalPersist> = {
   merge: (persistedState, currentState) => {
     const state = persistedState as GlobalPersist;
+
     return {
       ...currentState,
       ...state,
@@ -36,15 +38,42 @@ const persistOptions: PersistOptions<GlobalStore, GlobalPersist> = {
         if (!draft.defaultAgent) {
           draft.defaultAgent = DEFAULT_AGENT;
         }
+        delete draft.enableMaxTokens;
+        delete draft.enableHistoryCount;
+        delete draft.historyCount;
+        delete draft.enableCompressThreshold;
+        delete draft.compressThreshold;
+
+        // migration to new data model
+        if (!draft.languageModel) {
+          draft.languageModel = {
+            openAI: {
+              ...DEFAULT_LLM_CONFIG.openAI,
+              OPENAI_API_KEY: draft.OPENAI_API_KEY || DEFAULT_LLM_CONFIG.openAI.OPENAI_API_KEY,
+              endpoint: draft.endpoint || DEFAULT_LLM_CONFIG.openAI.OPENAI_API_KEY,
+            },
+          };
+
+          delete draft.OPENAI_API_KEY;
+          delete draft.endpoint;
+        }
       }),
     };
   },
   name: 'LOBE_SETTINGS',
-  partialize: (s) => ({
-    preference: s.preference,
-    settings: s.settings,
-  }),
+
   skipHydration: true,
+
+  storage: createHyperStorage({
+    localStorage: {
+      dbName: 'LobeHub',
+      selectors: ['preference', 'settings'],
+    },
+    url: {
+      mode: 'hash',
+      selectors: [{ settingsTab: 'tab' }],
+    },
+  }),
 };
 
 //  ===============  实装 useStore ============ //

package/src/types/settings.ts

@@ -5,15 +5,37 @@ import type { Locales } from '@/locales/resources';
 import type { LobeAgentSession } from '@/types/session';
 
 export interface GlobalBaseSettings {
-  OPENAI_API_KEY: string;
+  /**
+   * @deprecated
+   */
+  OPENAI_API_KEY?: string;
+
   avatar: string;
-  compressThreshold: number;
-  enableCompressThreshold: boolean;
-  enableHistoryCount: boolean;
-  enableMaxTokens: boolean;
-  endpoint: string;
+  /**
+   * @deprecated
+   */
+  compressThreshold?: number;
+  /**
+   * @deprecated
+   */
+  enableCompressThreshold?: boolean;
+  /**
+   * @deprecated
+   */
+  enableHistoryCount?: boolean;
+  /**
+   * @deprecated
+   */
+  enableMaxTokens?: boolean;
+  /**
+   * @deprecated
+   */
+  endpoint?: string;
   fontSize: number;
-  historyCount: number;
+  /**
+   * @deprecated
+   */
+  historyCount?: number;
   language: Locales;
   neutralColor: NeutralColors | '';
   password: string;
@@ -21,13 +43,28 @@ export interface GlobalBaseSettings {
   themeMode: ThemeMode;
 }
 
-export type GlobalDefaultAgent = Partial<LobeAgentSession>;
+export type GlobalDefaultAgent = Pick<LobeAgentSession, 'config' | 'meta'>;
+
+interface OpenAIConfig {
+  OPENAI_API_KEY: string;
+  azureApiVersion?: string;
+  endpoint?: string;
+  models?: string[];
+  useAzure?: boolean;
+}
+
+export type GlobalLLMConfig = {
+  openAI: OpenAIConfig;
+};
+
+export type LLMBrand = keyof GlobalLLMConfig;
 
 /**
  * 配置设置
  */
 export interface GlobalSettings extends GlobalBaseSettings {
   defaultAgent: GlobalDefaultAgent;
+  languageModel: GlobalLLMConfig;
 }
 
 export type ConfigKeys = keyof GlobalSettings;

package/src/utils/fetch.ts

@@ -74,7 +74,7 @@ interface FetchAITaskResultParams<T> {
   /**
    * 错误处理函数
    */
-  onError?: (e: Error) => void;
+  onError?: (e: Error, rawError?: any) => void;
   /**
    * 加载状态变化处理函数
    * @param loading - 是否处于加载状态
@@ -101,27 +101,19 @@ export const fetchAIFactory =
     onLoadingChange,
     abortController,
   }: FetchAITaskResultParams<T>) => {
-    const errorHandle = (error: Error) => {
+    const errorHandle = (error: Error, errorContent?: any) => {
       onLoadingChange?.(false);
       if (abortController?.signal.aborted) {
-        // notification.primaryInfo({
-        //   message: '已中断当前节点的执行任务',
-        // });
         return;
       }
-
-      // notification?.error({
-      //   message: `请求失败(${error.message})`,
-      //   placement: 'bottomRight',
-      // });
-      onError?.(error);
+      onError?.(error, errorContent);
     };
 
     onLoadingChange?.(true);
 
     const data = await fetchSSE(() => fetcher(params, { signal: abortController?.signal }), {
       onErrorHandle: (error) => {
-        errorHandle(new Error(error.message));
+        errorHandle(new Error(error.message), error);
       },
       onMessageHandle,
     }).catch(errorHandle);

package/src/pages/api/openai.api.ts

@@ -1,24 +0,0 @@
-import { LOBE_CHAT_ACCESS_CODE, OPENAI_API_KEY_HEADER_KEY, OPENAI_END_POINT } from '@/const/fetch';
-import { ErrorType } from '@/types/fetch';
-import { OpenAIStreamPayload } from '@/types/openai';
-
-import { checkAuth } from './auth';
-import { createErrorResponse } from './error';
-import { createChatCompletion } from './openai';
-
-export const runtime = 'edge';
-
-export default async function handler(req: Request) {
-  const payload = (await req.json()) as OpenAIStreamPayload;
-  const apiKey = req.headers.get(OPENAI_API_KEY_HEADER_KEY);
-  const accessCode = req.headers.get(LOBE_CHAT_ACCESS_CODE);
-  const endpoint = req.headers.get(OPENAI_END_POINT);
-
-  const result = checkAuth({ accessCode, apiKey });
-
-  if (!result.auth) {
-    return createErrorResponse(result.error as ErrorType);
-  }
-
-  return createChatCompletion({ OPENAI_API_KEY: apiKey, endpoint, payload });
-}

package/src/services/url.ts

@@ -1,8 +0,0 @@
-const isDev = process.env.NODE_ENV === 'development';
-
-const prefix = isDev ? '-dev' : '';
-
-export const URLS = {
-  openai: '/api/openai' + prefix,
-  plugins: '/api/plugins' + prefix,
-};