@lobehub/chat 0.150.9 → 0.151.0

package/src/store/user/slices/preference/action.ts

@@ -0,0 +1,50 @@
+import { SWRResponse } from 'swr';
+import type { StateCreator } from 'zustand/vanilla';
+
+import { useClientDataSWR } from '@/libs/swr';
+import type { UserStore } from '@/store/user';
+import { merge } from '@/utils/merge';
+import { setNamespace } from '@/utils/storeDebug';
+
+import type { Guide, UserPreference } from './initialState';
+
+const n = setNamespace('preference');
+
+export interface PreferenceAction {
+  updateGuideState: (guide: Partial<Guide>) => void;
+  updatePreference: (preference: Partial<UserPreference>, action?: any) => void;
+  useInitPreference: () => SWRResponse;
+}
+
+export const createPreferenceSlice: StateCreator<
+  UserStore,
+  [['zustand/devtools', never]],
+  [],
+  PreferenceAction
+> = (set, get) => ({
+  updateGuideState: (guide) => {
+    const { updatePreference } = get();
+    const nextGuide = merge(get().preference.guide, guide);
+    updatePreference({ guide: nextGuide });
+  },
+  updatePreference: (preference, action) => {
+    const nextPreference = merge(get().preference, preference);
+
+    set({ preference: nextPreference }, false, action || n('updatePreference'));
+
+    get().preferenceStorage.saveToLocalStorage(nextPreference);
+  },
+
+  useInitPreference: () =>
+    useClientDataSWR<UserPreference>(
+      'initUserPreference',
+      () => get().preferenceStorage.getFromLocalStorage(),
+      {
+        onSuccess: (preference) => {
+          if (preference) {
+            set({ preference }, false, n('initPreference'));
+          }
+        },
+      },
+    ),
+});

package/src/store/user/slices/preference/initialState.ts

@@ -0,0 +1,33 @@
+import { AsyncLocalStorage } from '@/utils/localStorage';
+
+export interface Guide {
+  // Topic 引导
+  topic?: boolean;
+}
+
+export interface UserPreference {
+  guide?: Guide;
+  hideSyncAlert?: boolean;
+  telemetry: boolean | null;
+  /**
+   * whether to use cmd + enter to send message
+   */
+  useCmdEnterToSend?: boolean;
+}
+
+export interface UserPreferenceState {
+  /**
+   * the user preference, which only store in local storage
+   */
+  preference: UserPreference;
+  preferenceStorage: AsyncLocalStorage<UserPreference>;
+}
+
+export const initialPreferenceState: UserPreferenceState = {
+  preference: {
+    guide: {},
+    telemetry: null,
+    useCmdEnterToSend: false,
+  },
+  preferenceStorage: new AsyncLocalStorage('LOBE_PREFERENCE'),
+};

package/src/store/user/slices/preference/selectors.ts

@@ -0,0 +1,13 @@
+import { UserStore } from '@/store/user';
+
+const useCmdEnterToSend = (s: UserStore): boolean => s.preference.useCmdEnterToSend || false;
+
+const userAllowTrace = (s: UserStore) => s.preference.telemetry;
+
+const hideSyncAlert = (s: UserStore) => s.preference.hideSyncAlert;
+
+export const preferenceSelectors = {
+  hideSyncAlert,
+  useCmdEnterToSend,
+  userAllowTrace,
+};

package/src/store/{global → user}/slices/settings/actions/general.test.ts

@@ -5,7 +5,7 @@ import { withSWR } from '~test-utils';
 
 import { DEFAULT_AGENT, DEFAULT_SETTINGS } from '@/const/settings';
 import { userService } from '@/services/user';
-import { useGlobalStore } from '@/store/global';
+import { useUserStore } from '@/store/user';
 import { LobeAgentSettings } from '@/types/session';
 import { GlobalSettings } from '@/types/settings';
 
@@ -20,7 +20,7 @@ vi.mock('@/services/user', () => ({
 describe('SettingsAction', () => {
   describe('importAppSettings', () => {
     it('should import app settings', async () => {
-      const { result } = renderHook(() => useGlobalStore());
+      const { result } = renderHook(() => useUserStore());
       const newSettings: GlobalSettings = {
         ...DEFAULT_SETTINGS,
         themeMode: 'dark',
@@ -51,7 +51,7 @@ describe('SettingsAction', () => {
 
   describe('resetSettings', () => {
     it('should reset settings to default', async () => {
-      const { result } = renderHook(() => useGlobalStore());
+      const { result } = renderHook(() => useUserStore());
 
       // Perform the action
       await act(async () => {
@@ -68,7 +68,7 @@ describe('SettingsAction', () => {
 
   describe('setSettings', () => {
     it('should set partial settings', async () => {
-      const { result } = renderHook(() => useGlobalStore());
+      const { result } = renderHook(() => useUserStore());
       const partialSettings: Partial<GlobalSettings> = { themeMode: 'dark' };
 
       // Perform the action
@@ -83,7 +83,7 @@ describe('SettingsAction', () => {
 
   describe('switchThemeMode', () => {
     it('should switch theme mode', async () => {
-      const { result } = renderHook(() => useGlobalStore());
+      const { result } = renderHook(() => useUserStore());
       const themeMode = 'light';
 
       // Perform the action
@@ -98,7 +98,7 @@ describe('SettingsAction', () => {
 
   describe('updateDefaultAgent', () => {
     it('should update default agent settings', async () => {
-      const { result } = renderHook(() => useGlobalStore());
+      const { result } = renderHook(() => useUserStore());
       const updatedAgent: Partial<LobeAgentSettings> = {
         meta: { title: 'docs' },
       };

package/src/store/{global → user}/slices/settings/actions/general.ts

@@ -4,7 +4,7 @@ import { DeepPartial } from 'utility-types';
 import type { StateCreator } from 'zustand/vanilla';
 
 import { userService } from '@/services/user';
-import type { GlobalStore } from '@/store/global';
+import type { UserStore } from '@/store/user';
 import { LobeAgentSettings } from '@/types/session';
 import { GlobalSettings } from '@/types/settings';
 import { difference } from '@/utils/difference';
@@ -19,7 +19,7 @@ export interface GeneralSettingsAction {
 }
 
 export const generalSettingsSlice: StateCreator<
-  GlobalStore,
+  UserStore,
   [['zustand/devtools', never]],
   [],
   GeneralSettingsAction

package/src/store/{global → user}/slices/settings/actions/index.ts

@@ -1,6 +1,6 @@
 import type { StateCreator } from 'zustand/vanilla';
 
-import type { GlobalStore } from '@/store/global';
+import type { UserStore } from '@/store/user';
 
 import { GeneralSettingsAction, generalSettingsSlice } from './general';
 import { LLMSettingsAction, llmSettingsSlice } from './llm';
@@ -8,7 +8,7 @@ import { LLMSettingsAction, llmSettingsSlice } from './llm';
 export interface SettingsAction extends LLMSettingsAction, GeneralSettingsAction {}
 
 export const createSettingsSlice: StateCreator<
-  GlobalStore,
+  UserStore,
   [['zustand/devtools', never]],
   [],
   SettingsAction

package/src/store/{global → user}/slices/settings/actions/llm.test.ts

@@ -2,16 +2,13 @@ import { act, renderHook } from '@testing-library/react';
 import { describe, expect, it, vi } from 'vitest';
 
 import { userService } from '@/services/user';
-import { GlobalStore, useGlobalStore } from '@/store/global';
-import {
-  GlobalSettingsState,
-  initialSettingsState,
-} from '@/store/global/slices/settings/initialState';
+import { UserStore, useUserStore } from '@/store/user';
+import { UserSettingsState, initialSettingsState } from '@/store/user/slices/settings/initialState';
 import {
   modelConfigSelectors,
   modelProviderSelectors,
   settingsSelectors,
-} from '@/store/global/slices/settings/selectors';
+} from '@/store/user/slices/settings/selectors';
 import { GeneralModelProviderConfig } from '@/types/settings';
 import { merge } from '@/utils/merge';
 
@@ -28,7 +25,7 @@ vi.mock('@/services/user', () => ({
 describe('LLMSettingsSliceAction', () => {
   describe('setModelProviderConfig', () => {
     it('should set OpenAI configuration', async () => {
-      const { result } = renderHook(() => useGlobalStore());
+      const { result } = renderHook(() => useUserStore());
       const openAIConfig: Partial<GeneralModelProviderConfig> = { apiKey: 'test-key' };
 
       // Perform the action
@@ -47,7 +44,7 @@ describe('LLMSettingsSliceAction', () => {
 
   describe('dispatchCustomModelCards', () => {
     it('should return early when prevState does not exist', async () => {
-      const { result } = renderHook(() => useGlobalStore());
+      const { result } = renderHook(() => useUserStore());
       const provider = 'openai';
       const payload: CustomModelCardDispatch = { type: 'add', modelCard: { id: 'test-id' } };
 
@@ -66,10 +63,10 @@ describe('LLMSettingsSliceAction', () => {
 
   describe('refreshDefaultModelProviderList', () => {
     it('default', async () => {
-      const { result } = renderHook(() => useGlobalStore());
+      const { result } = renderHook(() => useUserStore());
 
       act(() => {
-        useGlobalStore.setState({
+        useUserStore.setState({
           serverConfig: {
             languageModel: {
               azure: { serverModelCards: [{ id: 'abc', deploymentName: 'abc' }] },
@@ -91,9 +88,9 @@ describe('LLMSettingsSliceAction', () => {
 
   describe('refreshModelProviderList', () => {
     it('visible', async () => {
-      const { result } = renderHook(() => useGlobalStore());
+      const { result } = renderHook(() => useUserStore());
       act(() => {
-        useGlobalStore.setState({
+        useUserStore.setState({
           settings: {
             languageModel: {
               ollama: { enabledModels: ['llava'] },
@@ -118,10 +115,10 @@ describe('LLMSettingsSliceAction', () => {
     });
 
     it('modelProviderListForModelSelect should return only enabled providers', () => {
-      const { result } = renderHook(() => useGlobalStore());
+      const { result } = renderHook(() => useUserStore());
 
       act(() => {
-        useGlobalStore.setState({
+        useUserStore.setState({
           settings: {
             languageModel: {
               perplexity: { enabled: true },

package/src/store/{global → user}/slices/settings/actions/llm.ts

@@ -7,6 +7,7 @@ import {
   BedrockProviderCard,
   GoogleProviderCard,
   GroqProviderCard,
+  MinimaxProviderCard,
   MistralProviderCard,
   MoonshotProviderCard,
   OllamaProviderCard,
@@ -17,7 +18,7 @@ import {
   ZeroOneProviderCard,
   ZhiPuProviderCard,
 } from '@/config/modelProviders';
-import { GlobalStore } from '@/store/global';
+import { UserStore } from '@/store/user';
 import { ChatModelCard } from '@/types/llm';
 import { GlobalLLMConfig, GlobalLLMProviderKey } from '@/types/settings';
 import { setNamespace } from '@/utils/storeDebug';
@@ -57,7 +58,7 @@ export interface LLMSettingsAction {
 }
 
 export const llmSettingsSlice: StateCreator<
-  GlobalStore,
+  UserStore,
   [['zustand/devtools', never]],
   [],
   LLMSettingsAction
@@ -109,6 +110,7 @@ export const llmSettingsSlice: StateCreator<
       },
       BedrockProviderCard,
       PerplexityProviderCard,
+      MinimaxProviderCard,
       MistralProviderCard,
       GroqProviderCard,
       MoonshotProviderCard,

package/src/store/{global → user}/slices/settings/initialState.ts

@@ -6,7 +6,7 @@ import { ModelProviderCard } from '@/types/llm';
 import { GlobalServerConfig } from '@/types/serverConfig';
 import { GlobalSettings } from '@/types/settings';
 
-export interface GlobalSettingsState {
+export interface UserSettingsState {
   avatar?: string;
   defaultModelProviderList: ModelProviderCard[];
   defaultSettings: GlobalSettings;
@@ -17,7 +17,7 @@ export interface GlobalSettingsState {
   userId?: string;
 }
 
-export const initialSettingsState: GlobalSettingsState = {
+export const initialSettingsState: UserSettingsState = {
   defaultModelProviderList: DEFAULT_MODEL_PROVIDER_LIST,
   defaultSettings: DEFAULT_SETTINGS,
   modelProviderList: DEFAULT_MODEL_PROVIDER_LIST,

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

@@ -2,8 +2,8 @@ import { describe, expect, it } from 'vitest';
 
 import { merge } from '@/utils/merge';
 
-import { GlobalStore, useGlobalStore } from '../../../store';
-import { GlobalSettingsState, initialSettingsState } from '../initialState';
+import { UserStore, useUserStore } from '../../../store';
+import { UserSettingsState, initialSettingsState } from '../initialState';
 import { modelConfigSelectors } from './modelConfig';
 
 describe('modelConfigSelectors', () => {
@@ -15,7 +15,7 @@ describe('modelConfigSelectors', () => {
             ollama: { enabled: true },
           },
         },
-      } as GlobalSettingsState) as unknown as GlobalStore;
+      } as UserSettingsState) as unknown as UserStore;
 
       expect(modelConfigSelectors.isProviderEnabled('ollama')(s)).toBe(true);
     });
@@ -27,7 +27,7 @@ describe('modelConfigSelectors', () => {
             perplexity: { enabled: false },
           },
         },
-      } as GlobalSettingsState) as unknown as GlobalStore;
+      } as UserSettingsState) as unknown as UserStore;
 
       expect(modelConfigSelectors.isProviderEnabled('perplexity')(s)).toBe(false);
     });
@@ -46,7 +46,7 @@ describe('modelConfigSelectors', () => {
             },
           },
         },
-      } as GlobalSettingsState) as unknown as GlobalStore;
+      } as UserSettingsState) as unknown as UserStore;
 
       const customModelCard = modelConfigSelectors.getCustomModelCard({
         id: 'custom-model-2',
@@ -65,7 +65,7 @@ describe('modelConfigSelectors', () => {
             },
           },
         },
-      } as GlobalSettingsState) as unknown as GlobalStore;
+      } as UserSettingsState) as unknown as UserStore;
 
       const customModelCard = modelConfigSelectors.getCustomModelCard({
         id: 'nonexistent-model',
@@ -93,7 +93,7 @@ describe('modelConfigSelectors', () => {
           id: 'custom-model-2',
           provider: 'perplexity',
         },
-      } as GlobalSettingsState) as unknown as GlobalStore;
+      } as UserSettingsState) as unknown as UserStore;
 
       const currentEditingModelCard = modelConfigSelectors.currentEditingCustomModelCard(s);
 
@@ -112,7 +112,7 @@ describe('modelConfigSelectors', () => {
             },
           },
         },
-      } as GlobalSettingsState) as unknown as GlobalStore;
+      } as UserSettingsState) as unknown as UserStore;
 
       const currentEditingModelCard = modelConfigSelectors.currentEditingCustomModelCard(s);
 

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

@@ -1,15 +1,15 @@
 import { GlobalLLMProviderKey } from '@/types/settings';
 
-import { GlobalStore } from '../../../store';
+import { UserStore } from '../../../store';
 import { currentLLMSettings, getProviderConfigById } from './settings';
 
-const isProviderEnabled = (provider: GlobalLLMProviderKey) => (s: GlobalStore) =>
+const isProviderEnabled = (provider: GlobalLLMProviderKey) => (s: UserStore) =>
   getProviderConfigById(provider)(s)?.enabled || false;
 
-const isProviderEndpointNotEmpty = (provider: GlobalLLMProviderKey | string) => (s: GlobalStore) =>
+const isProviderEndpointNotEmpty = (provider: GlobalLLMProviderKey | string) => (s: UserStore) =>
   !!getProviderConfigById(provider)(s)?.endpoint;
 
-const isProviderFetchOnClient = (provider: GlobalLLMProviderKey | string) => (s: GlobalStore) => {
+const isProviderFetchOnClient = (provider: GlobalLLMProviderKey | string) => (s: UserStore) => {
   const config = getProviderConfigById(provider)(s);
   if (typeof config?.fetchOnClient !== 'undefined') return config?.fetchOnClient;
 
@@ -18,7 +18,7 @@ const isProviderFetchOnClient = (provider: GlobalLLMProviderKey | string) => (s:
 
 const getCustomModelCard =
   ({ id, provider }: { id?: string; provider?: string }) =>
-  (s: GlobalStore) => {
+  (s: UserStore) => {
     if (!provider) return;
 
     const config = getProviderConfigById(provider)(s);
@@ -26,7 +26,7 @@ const getCustomModelCard =
     return config?.customModelCards?.find((m) => m.id === id);
   };
 
-const currentEditingCustomModelCard = (s: GlobalStore) => {
+const currentEditingCustomModelCard = (s: UserStore) => {
   if (!s.editingCustomCardModel) return;
   const { id, provider } = s.editingCustomCardModel;
 
@@ -35,16 +35,16 @@ const currentEditingCustomModelCard = (s: GlobalStore) => {
 
 const isAutoFetchModelsEnabled =
   (provider: GlobalLLMProviderKey) =>
-  (s: GlobalStore): boolean => {
+  (s: UserStore): boolean => {
     return getProviderConfigById(provider)(s)?.autoFetchModelLists || false;
   };
 
-const openAIConfig = (s: GlobalStore) => currentLLMSettings(s).openai;
-const bedrockConfig = (s: GlobalStore) => currentLLMSettings(s).bedrock;
-const ollamaConfig = (s: GlobalStore) => currentLLMSettings(s).ollama;
-const azureConfig = (s: GlobalStore) => currentLLMSettings(s).azure;
+const openAIConfig = (s: UserStore) => currentLLMSettings(s).openai;
+const bedrockConfig = (s: UserStore) => currentLLMSettings(s).bedrock;
+const ollamaConfig = (s: UserStore) => currentLLMSettings(s).ollama;
+const azureConfig = (s: UserStore) => currentLLMSettings(s).azure;
 
-const isAzureEnabled = (s: GlobalStore) => currentLLMSettings(s).azure.enabled;
+const isAzureEnabled = (s: UserStore) => currentLLMSettings(s).azure.enabled;
 
 export const modelConfigSelectors = {
   azureConfig,

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

@@ -2,21 +2,21 @@ import { describe, expect, it } from 'vitest';
 
 import { merge } from '@/utils/merge';
 
-import { GlobalStore, useGlobalStore } from '../../../store';
-import { GlobalSettingsState, initialSettingsState } from '../initialState';
+import { UserStore, useUserStore } from '../../../store';
+import { UserSettingsState, initialSettingsState } from '../initialState';
 import { getDefaultModeProviderById, modelProviderSelectors } from './modelProvider';
 
 describe('modelProviderSelectors', () => {
   describe('getDefaultModeProviderById', () => {
     it('should return the correct ModelProviderCard when provider ID matches', () => {
-      const s = merge(initialSettingsState, {}) as unknown as GlobalStore;
+      const s = merge(initialSettingsState, {}) as unknown as UserStore;
 
       const result = getDefaultModeProviderById('openai')(s);
       expect(result).not.toBeUndefined();
     });
 
     it('should return undefined when provider ID does not exist', () => {
-      const s = merge(initialSettingsState, {}) as unknown as GlobalStore;
+      const s = merge(initialSettingsState, {}) as unknown as UserStore;
       const result = getDefaultModeProviderById('nonExistingProvider')(s);
       expect(result).toBeUndefined();
     });
@@ -32,7 +32,7 @@ describe('modelProviderSelectors', () => {
             },
           },
         },
-      } as GlobalSettingsState) as unknown as GlobalStore;
+      } as UserSettingsState) as unknown as UserStore;
 
       const modelCards = modelProviderSelectors.getModelCardsById('perplexity')(s);
 
@@ -46,14 +46,14 @@ describe('modelProviderSelectors', () => {
 
   describe('defaultEnabledProviderModels', () => {
     it('should return enabled models for a given provider', () => {
-      const s = merge(initialSettingsState, {}) as unknown as GlobalStore;
+      const s = merge(initialSettingsState, {}) as unknown as UserStore;
 
       const result = modelProviderSelectors.getDefaultEnabledModelsById('openai')(s);
       expect(result).toEqual(['gpt-3.5-turbo', 'gpt-4-turbo']);
     });
 
     it('should return undefined for a non-existing provider', () => {
-      const s = merge(initialSettingsState, {}) as unknown as GlobalStore;
+      const s = merge(initialSettingsState, {}) as unknown as UserStore;
 
       const result = modelProviderSelectors.getDefaultEnabledModelsById('nonExistingProvider')(s);
       expect(result).toBeUndefined();
@@ -62,14 +62,14 @@ describe('modelProviderSelectors', () => {
   describe('modelEnabledVision', () => {
     it('should return true if the model has vision ability', () => {
       const hasAbility = modelProviderSelectors.isModelEnabledVision('gpt-4-vision-preview')(
-        useGlobalStore.getState(),
+        useUserStore.getState(),
       );
       expect(hasAbility).toBeTruthy();
     });
 
     it('should return false if the model does not have vision ability', () => {
       const hasAbility = modelProviderSelectors.isModelEnabledVision('some-other-model')(
-        useGlobalStore.getState(),
+        useUserStore.getState(),
       );
 
       expect(hasAbility).toBeFalsy();
@@ -77,7 +77,7 @@ describe('modelProviderSelectors', () => {
 
     it('should return false if the model include vision in id', () => {
       const hasAbility = modelProviderSelectors.isModelEnabledVision('some-other-model-vision')(
-        useGlobalStore.getState(),
+        useUserStore.getState(),
       );
 
       expect(hasAbility).toBeTruthy();
@@ -87,14 +87,14 @@ describe('modelProviderSelectors', () => {
   describe('modelEnabledFiles', () => {
     it('should return false if the model does not have file ability', () => {
       const enabledFiles = modelProviderSelectors.isModelEnabledFiles('gpt-4-vision-preview')(
-        useGlobalStore.getState(),
+        useUserStore.getState(),
       );
       expect(enabledFiles).toBeFalsy();
     });
 
     it.skip('should return true if the model has file ability', () => {
       const enabledFiles = modelProviderSelectors.isModelEnabledFiles('gpt-4-all')(
-        useGlobalStore.getState(),
+        useUserStore.getState(),
       );
       expect(enabledFiles).toBeTruthy();
     });
@@ -103,14 +103,14 @@ describe('modelProviderSelectors', () => {
   describe('modelHasMaxToken', () => {
     it('should return true if the model is in the list of models that show tokens', () => {
       const show = modelProviderSelectors.isModelHasMaxToken('gpt-3.5-turbo')(
-        useGlobalStore.getState(),
+        useUserStore.getState(),
       );
       expect(show).toBeTruthy();
     });
 
     it('should return false if the model is not in the list of models that show tokens', () => {
       const show = modelProviderSelectors.isModelHasMaxToken('some-other-model')(
-        useGlobalStore.getState(),
+        useUserStore.getState(),
       );
       expect(show).toBe(false);
     });
@@ -119,7 +119,7 @@ describe('modelProviderSelectors', () => {
   describe('modelMaxToken', () => {
     it('should return the correct token count for a model with specified tokens', () => {
       const model1Tokens = modelProviderSelectors.modelMaxToken('gpt-3.5-turbo')(
-        useGlobalStore.getState(),
+        useUserStore.getState(),
       );
 
       expect(model1Tokens).toEqual(16385);
@@ -128,7 +128,7 @@ describe('modelProviderSelectors', () => {
     it('should return 0 for a model without a specified token count', () => {
       // 测试未指定tokens属性的模型的tokens值，期望为0
       const tokens = modelProviderSelectors.modelMaxToken('chat-bison-001')(
-        useGlobalStore.getState(),
+        useUserStore.getState(),
       );
       expect(tokens).toEqual(0);
     });
@@ -136,7 +136,7 @@ describe('modelProviderSelectors', () => {
     it('should return 0 for a non-existing model', () => {
       // 测试一个不存在的模型的tokens值，期望为0
       const tokens = modelProviderSelectors.modelMaxToken('nonExistingModel')(
-        useGlobalStore.getState(),
+        useUserStore.getState(),
       );
 
       expect(tokens).toEqual(0);