@lobehub/chat 0.122.2 → 0.122.4

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

@@ -0,0 +1,64 @@
+import { DEFAULT_OPENAI_MODEL_LIST } from '@/const/llm';
+import { CustomModels } from '@/types/settings';
+
+import { GlobalStore } from '../../../store';
+import { currentSettings } from './settings';
+
+const openAIConfig = (s: GlobalStore) => currentSettings(s).languageModel.openAI;
+
+const openAIAPIKeySelectors = (s: GlobalStore) =>
+  currentSettings(s).languageModel.openAI.OPENAI_API_KEY;
+
+const enableAzure = (s: GlobalStore) => currentSettings(s).languageModel.openAI.useAzure;
+
+const openAIProxyUrlSelectors = (s: GlobalStore) =>
+  currentSettings(s).languageModel.openAI.endpoint;
+
+const modelListSelectors = (s: GlobalStore) => {
+  let models: CustomModels = [];
+
+  const removedModels: string[] = [];
+  const modelNames = [
+    ...DEFAULT_OPENAI_MODEL_LIST,
+    ...(s.serverConfig.customModelName || '').split(/[,，]/).filter(Boolean),
+    ...(currentSettings(s).languageModel.openAI.customModelName || '')
+      .split(/[,，]/)
+      .filter(Boolean),
+  ];
+
+  for (const item of modelNames) {
+    const disable = item.startsWith('-');
+    const nameConfig = item.startsWith('+') || item.startsWith('-') ? item.slice(1) : item;
+    const [name, displayName] = nameConfig.split('=');
+
+    if (disable) {
+      // Disable all models.
+      if (name === 'all') {
+        models = [];
+      }
+      removedModels.push(name);
+      continue;
+    }
+
+    // Remove duplicate model entries.
+    const existingIndex = models.findIndex(({ name: n }) => n === name);
+    if (existingIndex !== -1) {
+      models.splice(existingIndex, 1);
+    }
+
+    models.push({
+      displayName: displayName || name,
+      name,
+    });
+  }
+
+  return models.filter((m) => !removedModels.includes(m.name));
+};
+
+export const modelProviderSelectors = {
+  enableAzure,
+  modelList: modelListSelectors,
+  openAIAPI: openAIAPIKeySelectors,
+  openAIConfig,
+  openAIProxyUrl: openAIProxyUrlSelectors,
+};

package/src/store/global/slices/settings/{selectors.test.ts → selectors/selectors.test.ts}

@@ -1,7 +1,7 @@
 import { LanguageModel } from '@/types/llm';
 
-import { GlobalStore } from '../../store';
-import { settingsSelectors } from './selectors';
+import { GlobalStore } from '../../../store';
+import { settingsSelectors } from './settings';
 
 describe('settingsSelectors', () => {
   describe('currentSettings', () => {
@@ -58,101 +58,6 @@ describe('settingsSelectors', () => {
     });
   });
 
-  describe('CUSTOM_MODELS', () => {
-    it('custom deletion, addition, and renaming of models', () => {
-      const s = {
-        serverConfig: {
-          customModelName:
-            '-all,+llama,+claude-2，-gpt-3.5-turbo,gpt-4-1106-preview=gpt-4-turbo,gpt-4-1106-preview=gpt-4-32k',
-        },
-        settings: {
-          languageModel: {
-            openAI: {},
-          },
-        },
-      } as unknown as GlobalStore;
-
-      const result = settingsSelectors.modelList(s);
-
-      expect(result).toMatchSnapshot();
-    });
-
-    it('duplicate naming model', () => {
-      const s = {
-        serverConfig: {},
-        settings: {
-          languageModel: {
-            openAI: {
-              customModelName: 'gpt-4-1106-preview=gpt-4-turbo，gpt-4-1106-preview=gpt-4-32k',
-            },
-          },
-        },
-      } as unknown as GlobalStore;
-
-      const result = settingsSelectors.modelList(s);
-
-      expect(result).toMatchSnapshot();
-    });
-
-    it('should delete model', () => {
-      const s = {
-        serverConfig: {
-          customModelName: '-gpt-4',
-        },
-        settings: {
-          languageModel: {
-            openAI: {},
-          },
-        },
-      } as unknown as GlobalStore;
-
-      const result = settingsSelectors.modelList(s);
-
-      expect(result).toEqual([
-        {
-          displayName: 'gpt-3.5-turbo',
-          name: 'gpt-3.5-turbo',
-        },
-        {
-          displayName: 'gpt-3.5-turbo-1106',
-          name: 'gpt-3.5-turbo-1106',
-        },
-        {
-          displayName: 'gpt-3.5-turbo-16k',
-          name: 'gpt-3.5-turbo-16k',
-        },
-        {
-          displayName: 'gpt-4-32k',
-          name: 'gpt-4-32k',
-        },
-        {
-          displayName: 'gpt-4-1106-preview',
-          name: 'gpt-4-1106-preview',
-        },
-        {
-          displayName: 'gpt-4-vision-preview',
-          name: 'gpt-4-vision-preview',
-        },
-      ]);
-    });
-
-    it('only add the model', () => {
-      const s = {
-        serverConfig: {},
-        settings: {
-          languageModel: {
-            openAI: {
-              customModelName: 'model1,model2,model3，model4',
-            },
-          },
-        },
-      } as unknown as GlobalStore;
-
-      const result = settingsSelectors.modelList(s);
-
-      expect(result).toMatchSnapshot();
-    });
-  });
   describe('defaultAgent', () => {
     it('should merge DEFAULT_AGENT and s.settings.defaultAgent correctly', () => {
       const s = {

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

@@ -0,0 +1,58 @@
+import { DEFAULT_LANG } from '@/const/locale';
+import { DEFAULT_AGENT_META } from '@/const/meta';
+import { DEFAULT_AGENT, DEFAULT_AGENT_CONFIG, DEFAULT_TTS_CONFIG } from '@/const/settings';
+import { Locales } from '@/locales/resources';
+import { GlobalSettings } from '@/types/settings';
+import { isOnServerSide } from '@/utils/env';
+import { merge } from '@/utils/merge';
+
+import { GlobalStore } from '../../../store';
+
+export const currentSettings = (s: GlobalStore): GlobalSettings =>
+  merge(s.defaultSettings, s.settings);
+
+const password = (s: GlobalStore) => currentSettings(s).password;
+
+const currentTTS = (s: GlobalStore) => merge(DEFAULT_TTS_CONFIG, currentSettings(s).tts);
+
+const defaultAgent = (s: GlobalStore) => merge(DEFAULT_AGENT, currentSettings(s).defaultAgent);
+
+const defaultAgentConfig = (s: GlobalStore) => merge(DEFAULT_AGENT_CONFIG, defaultAgent(s).config);
+
+const defaultAgentMeta = (s: GlobalStore) => merge(DEFAULT_AGENT_META, defaultAgent(s).meta);
+
+// TODO: Maybe we can also export settings difference
+const exportSettings = (s: GlobalStore) => {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  const { password: _, ...settings } = currentSettings(s);
+
+  return settings as GlobalSettings;
+};
+
+const currentLanguage = (s: GlobalStore) => {
+  const locale = currentSettings(s).language;
+
+  if (locale === 'auto') {
+    if (isOnServerSide) return DEFAULT_LANG;
+
+    return navigator.language as Locales;
+  }
+
+  return locale;
+};
+
+const dalleConfig = (s: GlobalStore) => currentSettings(s).tool?.dalle || {};
+const isDalleAutoGenerating = (s: GlobalStore) => currentSettings(s).tool?.dalle?.autoGenerate;
+
+export const settingsSelectors = {
+  currentLanguage,
+  currentSettings,
+  currentTTS,
+  dalleConfig,
+  defaultAgent,
+  defaultAgentConfig,
+  defaultAgentMeta,
+  exportSettings,
+  isDalleAutoGenerating,
+  password,
+};

package/src/store/global/store.ts

@@ -1,66 +1,39 @@
-import { produce } from 'immer';
-import { PersistOptions, devtools, persist } from 'zustand/middleware';
+import { PersistOptions, devtools, persist, subscribeWithSelector } from 'zustand/middleware';
 import { shallow } from 'zustand/shallow';
 import { createWithEqualityFn } from 'zustand/traditional';
 import { StateCreator } from 'zustand/vanilla';
 
-import { DEFAULT_AGENT, DEFAULT_LLM_CONFIG } from '@/const/settings';
-import { SessionDefaultGroup } from '@/types/session';
 import { isDev } from '@/utils/env';
 
 import { createHyperStorage } from '../middleware/createHyperStorage';
 import { type GlobalState, initialState } from './initialState';
 import { type CommonAction, createCommonSlice } from './slices/common/action';
+import { type PreferenceAction, createPreferenceSlice } from './slices/preference/action';
 import { type SettingsAction, createSettingsSlice } from './slices/settings/action';
 
 //  ===============  聚合 createStoreFn ============ //
 
-export type GlobalStore = CommonAction & GlobalState & SettingsAction;
+export type GlobalStore = CommonAction & GlobalState & SettingsAction & PreferenceAction;
 
 const createStore: StateCreator<GlobalStore, [['zustand/devtools', never]]> = (...parameters) => ({
   ...initialState,
   ...createCommonSlice(...parameters),
   ...createSettingsSlice(...parameters),
+  ...createPreferenceSlice(...parameters),
 });
 
 //  ===============  persist 本地缓存中间件配置 ============ //
 type GlobalPersist = Pick<GlobalStore, 'preference' | 'settings'>;
 
 const persistOptions: PersistOptions<GlobalStore, GlobalPersist> = {
-  merge: (persistedState, currentState) => {
-    const state = persistedState as GlobalPersist;
-
-    return {
-      ...currentState,
-      ...state,
-      preference: produce(state.preference, (draft) => {
-        if (!draft.expandSessionGroupKeys) {
-          draft.expandSessionGroupKeys = [SessionDefaultGroup.Pinned, SessionDefaultGroup.Default];
-          delete (draft as any).sessionGroupKeys;
-        }
-      }),
-      settings: produce(state.settings, (draft) => {
-        if (!draft.defaultAgent) {
-          draft.defaultAgent = DEFAULT_AGENT;
-        }
-
-        // migration to new data model
-        if (!draft.languageModel) {
-          draft.languageModel = {
-            openAI: DEFAULT_LLM_CONFIG.openAI,
-          };
-        }
-      }),
-    };
-  },
-  name: 'LOBE_SETTINGS',
+  name: 'LOBE_GLOBAL',
 
   skipHydration: true,
 
   storage: createHyperStorage({
     localStorage: {
       dbName: 'LobeHub',
-      selectors: ['preference', 'settings'],
+      selectors: ['preference'],
     },
   }),
 };
@@ -69,9 +42,11 @@ const persistOptions: PersistOptions<GlobalStore, GlobalPersist> = {
 
 export const useGlobalStore = createWithEqualityFn<GlobalStore>()(
   persist(
-    devtools(createStore, {
-      name: 'LobeChat_Global' + (isDev ? '_DEV' : ''),
-    }),
+    subscribeWithSelector(
+      devtools(createStore, {
+        name: 'LobeChat_Global' + (isDev ? '_DEV' : ''),
+      }),
+    ),
     persistOptions,
   ),
   shallow,

package/src/store/session/slices/agent/action.ts

@@ -58,7 +58,7 @@ export const createAgentSlice: StateCreator<
     // if is the inbox session, update the global config
     const isInbox = sessionSelectors.isInboxSession(get());
     if (isInbox) {
-      useGlobalStore.getState().updateDefaultAgent({ config });
+      await useGlobalStore.getState().updateDefaultAgent({ config });
     } else {
       const session = sessionSelectors.currentSession(get());
       if (!session) return;

package/src/types/settings/base.ts

@@ -0,0 +1,13 @@
+import type { NeutralColors, PrimaryColors } from '@lobehub/ui';
+import type { ThemeMode } from 'antd-style';
+
+import { LocaleMode } from '@/types/locale';
+
+export interface GlobalBaseSettings {
+  fontSize: number;
+  language: LocaleMode;
+  neutralColor?: NeutralColors;
+  password: string;
+  primaryColor?: PrimaryColors;
+  themeMode: ThemeMode;
+}

package/src/types/settings/index.ts

@@ -0,0 +1,34 @@
+import { DeepPartial } from 'utility-types';
+
+import type { LobeAgentSession } from '@/types/session';
+
+import { GlobalBaseSettings } from './base';
+import { GlobalLLMConfig } from './modelProvider';
+import { GlobalTTSConfig } from './tts';
+
+export type GlobalDefaultAgent = Pick<LobeAgentSession, 'config' | 'meta'>;
+
+export * from './base';
+export * from './modelProvider';
+export * from './tts';
+
+export interface GlobalTool {
+  dalle: {
+    autoGenerate: boolean;
+  };
+}
+
+export interface GlobalServerConfig {
+  customModelName?: string;
+  defaultAgent?: DeepPartial<GlobalDefaultAgent>;
+}
+
+/**
+ * 配置设置
+ */
+export interface GlobalSettings extends GlobalBaseSettings {
+  defaultAgent: GlobalDefaultAgent;
+  languageModel: GlobalLLMConfig;
+  tool: GlobalTool;
+  tts: GlobalTTSConfig;
+}

package/src/types/settings/modelProvider.ts

@@ -0,0 +1,17 @@
+export type CustomModels = { displayName: string; name: string }[];
+
+export interface OpenAIConfig {
+  OPENAI_API_KEY: string;
+  azureApiVersion?: string;
+  /**
+   * custom mode name for fine-tuning or openai like model
+   */
+  customModelName?: string;
+  endpoint?: string;
+  models?: string[];
+  useAzure?: boolean;
+}
+
+export interface GlobalLLMConfig {
+  openAI: OpenAIConfig;
+}

package/src/types/settings/tts.ts

@@ -0,0 +1,10 @@
+export type STTServer = 'openai' | 'browser';
+
+export interface GlobalTTSConfig {
+  openAI: {
+    sttModel: 'whisper-1';
+    ttsModel: 'tts-1' | 'tts-1-hd';
+  };
+  sttAutoStop: boolean;
+  sttServer: STTServer;
+}

package/src/utils/difference.ts

@@ -0,0 +1,12 @@
+import { isEqual, isObject, transform } from 'lodash-es';
+
+export const difference = <T extends object>(object: T, base: T) => {
+  const changes = (object: any, base: any) =>
+    transform(object, (result: any, value, key) => {
+      if (!isEqual(value, base[key])) {
+        result[key] = isObject(value) && isObject(base[key]) ? changes(value, base[key]) : value;
+      }
+    });
+
+  return changes(object, base);
+};

package/tests/utils.tsx

@@ -0,0 +1,8 @@
+import { SWRConfig } from 'swr';
+
+// 全局的 SWR 配置
+const swrConfig = {
+  provider: () => new Map(),
+};
+
+export const withSWR = ({ children }: any) => <SWRConfig value={swrConfig}>{children}</SWRConfig>;

package/tsconfig.json

@@ -18,13 +18,14 @@
     "baseUrl": ".",
     "types": ["vitest/globals"],
     "paths": {
-      "@/*": ["./src/*"]
+      "@/*": ["./src/*"],
+      "~test-utils": ["./tests/utils.tsx"],
     },
     "plugins": [
       {
-        "name": "next"
-      }
-    ]
+        "name": "next",
+      },
+    ],
   },
   "exclude": ["node_modules"],
   "include": [
@@ -35,11 +36,11 @@
     "**/*.ts",
     "**/*.d.ts",
     "**/*.tsx",
-    ".next/types/**/*.ts"
+    ".next/types/**/*.ts",
   ],
   "ts-node": {
     "compilerOptions": {
-      "module": "commonjs"
-    }
-  }
+      "module": "commonjs",
+    },
+  },
 }

package/vitest.config.ts

@@ -9,6 +9,7 @@ export default defineConfig({
   test: {
     alias: {
       '@': resolve(__dirname, './src'),
+      '~test-utils': resolve(__dirname, './tests/utils.tsx'),
     },
     coverage: {
       all: false,

package/src/store/global/hooks/useHydrated.ts

@@ -1,18 +0,0 @@
-import { useEffect, useState } from 'react';
-
-import { useGlobalStore } from '../store';
-
-export const useGlobalHydrated = () => {
-  // 根据 sessions 是否有值来判断是否已经初始化
-  const hasInited = !!Object.values(useGlobalStore.getState().settings).length;
-
-  const [isInit, setInit] = useState(hasInited);
-
-  useEffect(() => {
-    useGlobalStore.persist.onFinishHydration(() => {
-      if (!isInit) setInit(true);
-    });
-  }, []);
-
-  return isInit;
-};

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

@@ -1,105 +0,0 @@
-import { DEFAULT_OPENAI_MODEL_LIST } from '@/const/llm';
-import { DEFAULT_LANG } from '@/const/locale';
-import { DEFAULT_AGENT_META } from '@/const/meta';
-import {
-  DEFAULT_AGENT,
-  DEFAULT_AGENT_CONFIG,
-  DEFAULT_SETTINGS,
-  DEFAULT_TTS_CONFIG,
-} from '@/const/settings';
-import { Locales } from '@/locales/resources';
-import { CustomModels, GlobalSettings } from '@/types/settings';
-import { isOnServerSide } from '@/utils/env';
-import { merge } from '@/utils/merge';
-
-import { GlobalStore } from '../../store';
-
-const currentSettings = (s: GlobalStore) => merge(DEFAULT_SETTINGS, s.settings);
-
-const currentTTS = (s: GlobalStore) => merge(DEFAULT_TTS_CONFIG, s.settings.tts);
-
-const defaultAgent = (s: GlobalStore) => merge(DEFAULT_AGENT, s.settings.defaultAgent);
-
-const defaultAgentConfig = (s: GlobalStore) => merge(DEFAULT_AGENT_CONFIG, defaultAgent(s).config);
-
-const defaultAgentMeta = (s: GlobalStore) => merge(DEFAULT_AGENT_META, defaultAgent(s).meta);
-
-const openAIAPIKeySelectors = (s: GlobalStore) => s.settings.languageModel.openAI.OPENAI_API_KEY;
-
-const openAIProxyUrlSelectors = (s: GlobalStore) => s.settings.languageModel.openAI.endpoint;
-
-const modelListSelectors = (s: GlobalStore) => {
-  let models: CustomModels = [];
-
-  const removedModels: string[] = [];
-  const modelNames = [
-    ...DEFAULT_OPENAI_MODEL_LIST,
-    ...(s.serverConfig.customModelName || '').split(/[,，]/).filter(Boolean),
-    ...(s.settings.languageModel.openAI.customModelName || '').split(/[,，]/).filter(Boolean),
-  ];
-
-  for (const item of modelNames) {
-    const disable = item.startsWith('-');
-    const nameConfig = item.startsWith('+') || item.startsWith('-') ? item.slice(1) : item;
-    const [name, displayName] = nameConfig.split('=');
-
-    if (disable) {
-      // Disable all models.
-      if (name === 'all') {
-        models = [];
-      }
-      removedModels.push(name);
-      continue;
-    }
-
-    // Remove duplicate model entries.
-    const existingIndex = models.findIndex(({ name: n }) => n === name);
-    if (existingIndex !== -1) {
-      models.splice(existingIndex, 1);
-    }
-
-    models.push({
-      displayName: displayName || name,
-      name,
-    });
-  }
-
-  return models.filter((m) => !removedModels.includes(m.name));
-};
-
-export const exportSettings = (s: GlobalStore) => {
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  const { password: _, ...settings } = s.settings;
-
-  return settings as GlobalSettings;
-};
-
-const currentLanguage = (s: GlobalStore) => {
-  const locale = s.settings.language;
-
-  if (locale === 'auto') {
-    if (isOnServerSide) return DEFAULT_LANG;
-
-    return navigator.language as Locales;
-  }
-
-  return locale;
-};
-
-const dalleConfig = (s: GlobalStore) => s.settings.tool?.dalle || {};
-const isDalleAutoGenerating = (s: GlobalStore) => s.settings.tool?.dalle?.autoGenerate;
-
-export const settingsSelectors = {
-  currentLanguage,
-  currentSettings,
-  currentTTS,
-  dalleConfig,
-  defaultAgent,
-  defaultAgentConfig,
-  defaultAgentMeta,
-  exportSettings,
-  isDalleAutoGenerating,
-  modelList: modelListSelectors,
-  openAIAPI: openAIAPIKeySelectors,
-  openAIProxyUrl: openAIProxyUrlSelectors,
-};

package/src/types/settings.ts

@@ -1,68 +0,0 @@
-import type { NeutralColors, PrimaryColors } from '@lobehub/ui';
-import type { ThemeMode } from 'antd-style';
-
-import { LocaleMode } from '@/types/locale';
-import type { LobeAgentSession } from '@/types/session';
-
-export interface GlobalBaseSettings {
-  avatar: string;
-  fontSize: number;
-  language: LocaleMode;
-  neutralColor?: NeutralColors;
-  password: string;
-  primaryColor?: PrimaryColors;
-  themeMode: ThemeMode;
-}
-
-export type GlobalDefaultAgent = Pick<LobeAgentSession, 'config' | 'meta'>;
-
-export type CustomModels = { displayName: string; name: string }[];
-
-export interface OpenAIConfig {
-  OPENAI_API_KEY: string;
-  azureApiVersion?: string;
-  /**
-   * custom mode name for fine-tuning or openai like model
-   */
-  customModelName?: string;
-  endpoint?: string;
-  models?: string[];
-  useAzure?: boolean;
-}
-
-export interface GlobalLLMConfig {
-  openAI: OpenAIConfig;
-}
-
-export type STTServer = 'openai' | 'browser';
-export interface GlobalTTSConfig {
-  openAI: {
-    sttModel: 'whisper-1';
-    ttsModel: 'tts-1' | 'tts-1-hd';
-  };
-  sttAutoStop: boolean;
-  sttServer: STTServer;
-}
-
-export type LLMBrand = keyof GlobalLLMConfig;
-
-export interface GlobalTool {
-  dalle: {
-    autoGenerate: boolean;
-  };
-}
-/**
- * 配置设置
- */
-export interface GlobalSettings extends GlobalBaseSettings {
-  defaultAgent: GlobalDefaultAgent;
-  languageModel: GlobalLLMConfig;
-  tool: GlobalTool;
-  tts: GlobalTTSConfig;
-}
-
-export type ConfigKeys = keyof GlobalSettings;
-
-export interface GlobalServerConfig {
-  customModelName?: string;
-}