@lobehub/lobehub 2.0.0-next.3 → 2.0.0-next.31

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

@@ -1,223 +0,0 @@
-import type {
-  ChatModelCard,
-  GlobalLLMProviderKey,
-  ModelProviderCard,
-  UserKeyVaults,
-  UserModelProviderConfig,
-} from '@lobechat/types';
-import { produce } from 'immer';
-import { ModelProvider } from 'model-bank';
-import useSWR, { SWRResponse } from 'swr';
-import type { StateCreator } from 'zustand/vanilla';
-
-import type { UserStore } from '@/store/user';
-
-import { settingsSelectors } from '../settings/selectors';
-import { CustomModelCardDispatch, customModelCardsReducer } from './reducers/customModelCard';
-import { modelProviderSelectors } from './selectors/modelProvider';
-
-/**
- * 设置操作
- */
-export interface ModelListAction {
-  clearObtainedModels: (provider: GlobalLLMProviderKey) => Promise<void>;
-  dispatchCustomModelCards: (
-    provider: GlobalLLMProviderKey,
-    payload: CustomModelCardDispatch,
-  ) => Promise<void>;
-  /**
-   * make sure the default model provider list is sync to latest state
-   */
-  refreshDefaultModelProviderList: (params?: { trigger?: string }) => Promise<void>;
-  refreshModelProviderList: (params?: { trigger?: string }) => void;
-  removeEnabledModels: (provider: GlobalLLMProviderKey, model: string) => Promise<void>;
-  setModelProviderConfig: <T extends GlobalLLMProviderKey>(
-    provider: T,
-    config: Partial<UserModelProviderConfig[T]>,
-  ) => Promise<void>;
-  toggleEditingCustomModelCard: (params?: { id: string; provider: GlobalLLMProviderKey }) => void;
-
-  toggleProviderEnabled: (provider: GlobalLLMProviderKey, enabled: boolean) => Promise<void>;
-
-  updateEnabledModels: (
-    provider: GlobalLLMProviderKey,
-    modelKeys: string[],
-    options: { label?: string; value?: string }[],
-  ) => Promise<void>;
-
-  updateKeyVaultConfig: <T extends GlobalLLMProviderKey>(
-    provider: T,
-    config: Partial<UserKeyVaults[T]>,
-  ) => Promise<void>;
-
-  updateKeyVaultSettings: (key: string, config: any) => Promise<void>;
-
-  useFetchProviderModelList: (
-    provider: GlobalLLMProviderKey,
-    enabledAutoFetch: boolean,
-  ) => SWRResponse;
-}
-
-export const createModelListSlice: StateCreator<
-  UserStore,
-  [['zustand/devtools', never]],
-  [],
-  ModelListAction
-> = (set, get) => ({
-  clearObtainedModels: async (provider: GlobalLLMProviderKey) => {
-    await get().setModelProviderConfig(provider, {
-      remoteModelCards: [],
-    });
-
-    await get().refreshDefaultModelProviderList();
-  },
-  dispatchCustomModelCards: async (provider, payload) => {
-    const prevState = settingsSelectors.providerConfig(provider)(get());
-
-    if (!prevState) return;
-
-    const nextState = customModelCardsReducer(prevState.customModelCards, payload);
-
-    await get().setModelProviderConfig(provider, { customModelCards: nextState });
-  },
-  refreshDefaultModelProviderList: async (params) => {
-    /**
-     * Because we have several model cards sources, we need to merge the model cards
-     * the priority is below:
-     * 1 - server side model cards
-     * 2 - remote model cards
-     * 3 - default model cards
-     */
-
-    const mergeModels = (providerKey: GlobalLLMProviderKey, providerCard: ModelProviderCard) => {
-      // if the chat model is config in the server side, use the server side model cards
-      const serverChatModels = modelProviderSelectors.serverProviderModelCards(providerKey)(get());
-      const remoteChatModels = providerCard.modelList?.showModelFetcher
-        ? modelProviderSelectors.remoteProviderModelCards(providerKey)(get())
-        : undefined;
-
-      if (serverChatModels && serverChatModels.length > 0) {
-        return serverChatModels;
-      }
-      if (remoteChatModels && remoteChatModels.length > 0) {
-        return remoteChatModels;
-      }
-
-      return providerCard.chatModels;
-    };
-
-    const { DEFAULT_MODEL_PROVIDER_LIST } = await import('@/config/modelProviders');
-    const defaultModelProviderList = produce(DEFAULT_MODEL_PROVIDER_LIST, (draft) => {
-      Object.values(ModelProvider).forEach((id) => {
-        const provider = draft.find((d) => d.id === id);
-        if (provider) provider.chatModels = mergeModels(id as any, provider);
-      });
-    });
-
-    set({ defaultModelProviderList }, false, `refreshDefaultModelList - ${params?.trigger}`);
-
-    get().refreshModelProviderList({ trigger: 'refreshDefaultModelList' });
-  },
-  refreshModelProviderList: (params) => {
-    const modelProviderList = get().defaultModelProviderList.map((list) => {
-      const enabledModels = modelProviderSelectors.getEnableModelsById(list.id)(get());
-      return {
-        ...list,
-        chatModels: modelProviderSelectors
-          .getModelCardsById(list.id)(get())
-          ?.map((model) => {
-            if (!enabledModels) return model;
-
-            return {
-              ...model,
-              enabled: enabledModels?.some((m) => m === model.id),
-            };
-          }),
-        enabled: modelProviderSelectors.isProviderEnabled(list.id as any)(get()),
-      };
-    });
-
-    set({ modelProviderList }, false, `refreshModelList - ${params?.trigger}`);
-  },
-
-  removeEnabledModels: async (provider, model) => {
-    const config = settingsSelectors.providerConfig(provider)(get());
-
-    await get().setModelProviderConfig(provider, {
-      enabledModels: config?.enabledModels?.filter((s) => s !== model).filter(Boolean),
-    });
-  },
-
-  setModelProviderConfig: async (provider, config) => {
-    await get().setSettings({ languageModel: { [provider]: config } });
-  },
-
-  toggleEditingCustomModelCard: (params) => {
-    set({ editingCustomCardModel: params }, false, 'toggleEditingCustomModelCard');
-  },
-
-  toggleProviderEnabled: async (provider, enabled) => {
-    await get().setSettings({ languageModel: { [provider]: { enabled } } });
-  },
-  updateEnabledModels: async (provider, value, options) => {
-    const { dispatchCustomModelCards, setModelProviderConfig } = get();
-    const enabledModels = modelProviderSelectors.getEnableModelsById(provider)(get());
-
-    // if there is a new model, add it to `customModelCards`
-    const pools = options.map(async (option: { label?: string; value?: string }, index: number) => {
-      // if is a known model, it should have value
-      // if is an unknown model, the option will be {}
-      if (option.value) return;
-
-      const modelId = value[index];
-
-      // if is in enabledModels, it means it's a removed model
-      if (enabledModels?.some((m) => modelId === m)) return;
-
-      await dispatchCustomModelCards(provider, {
-        modelCard: { id: modelId },
-        type: 'add',
-      });
-    });
-
-    // TODO: 当前的这个 pool 方法并不是最好的实现，因为它会触发 setModelProviderConfig 的多次更新。
-    // 理论上应该合并这些变更，然后最后只做一次触发
-    // 因此后续的做法应该是将 dispatchCustomModelCards 改造为同步方法，并在最后做一次异步更新
-    // 对应需要改造 'should add new custom model to customModelCards' 这一个单测
-    await Promise.all(pools);
-
-    await setModelProviderConfig(provider, { enabledModels: value.filter(Boolean) });
-  },
-
-  updateKeyVaultConfig: async (provider, config) => {
-    await get().setSettings({ keyVaults: { [provider]: config } });
-  },
-
-  updateKeyVaultSettings: async (provider, config) => {
-    await get().setSettings({ keyVaults: { [provider]: config } });
-  },
-
-  useFetchProviderModelList: (provider, enabledAutoFetch) =>
-    useSWR<ChatModelCard[] | undefined>(
-      [provider, enabledAutoFetch],
-      async ([p]) => {
-        const { modelsService } = await import('@/services/models');
-
-        return modelsService.getModels(p);
-      },
-      {
-        onSuccess: async (data) => {
-          if (data) {
-            await get().setModelProviderConfig(provider, {
-              latestFetchTime: Date.now(),
-              remoteModelCards: data,
-            });
-
-            get().refreshDefaultModelProviderList();
-          }
-        },
-        revalidateOnFocus: false,
-        revalidateOnMount: enabledAutoFetch,
-      },
-    ),
-});

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

@@ -1,15 +0,0 @@
-import { DEFAULT_MODEL_PROVIDER_LIST } from '@/config/modelProviders';
-import { ModelProviderCard } from '@/types/llm';
-import { ServerLanguageModel } from '@/types/serverConfig';
-
-export interface ModelListState {
-  defaultModelProviderList: ModelProviderCard[];
-  editingCustomCardModel?: { id: string; provider: string } | undefined;
-  modelProviderList: ModelProviderCard[];
-  serverLanguageModel?: ServerLanguageModel;
-}
-
-export const initialModelListState: ModelListState = {
-  defaultModelProviderList: DEFAULT_MODEL_PROVIDER_LIST,
-  modelProviderList: DEFAULT_MODEL_PROVIDER_LIST,
-};

package/src/store/user/slices/modelList/reducers/customModelCard.test.ts

@@ -1,204 +0,0 @@
-import { describe, expect, it } from 'vitest';
-
-import { ChatModelCard } from '@/types/llm';
-
-import {
-  AddCustomModelCard,
-  DeleteCustomModelCard,
-  UpdateCustomModelCard,
-  customModelCardsReducer,
-} from './customModelCard';
-
-describe('customModelCardsReducer', () => {
-  const initialState: ChatModelCard[] = [
-    {
-      id: 'model1',
-      displayName: 'Model 1',
-      description: 'A helpful assistant',
-      files: true,
-      functionCall: false,
-      enabled: true,
-      isCustom: true,
-      legacy: false,
-      maxOutput: 1000,
-      contextWindowTokens: 2048,
-      vision: false,
-    },
-    {
-      id: 'model2',
-      displayName: 'Model 2',
-      description: 'A friendly chatbot',
-      files: false,
-      functionCall: true,
-      isCustom: true,
-      legacy: true,
-      maxOutput: 500,
-      contextWindowTokens: 1024,
-      vision: true,
-    },
-  ];
-
-  it('should add a new custom model card', () => {
-    const newModelCard: ChatModelCard = {
-      id: 'model3',
-      displayName: 'Model 3',
-      description: 'A versatile assistant',
-      files: true,
-      functionCall: true,
-      enabled: true,
-      isCustom: true,
-      legacy: false,
-      maxOutput: 2000,
-      contextWindowTokens: 4096,
-      vision: false,
-    };
-
-    const action: AddCustomModelCard = {
-      type: 'add',
-      modelCard: newModelCard,
-    };
-
-    const newState = customModelCardsReducer(initialState, action);
-
-    expect(newState).toContainEqual(newModelCard);
-    expect(newState.length).toBe(initialState.length + 1);
-  });
-
-  it('should not add a duplicate custom model card', () => {
-    const duplicateModelCard: ChatModelCard = {
-      id: 'model1',
-      displayName: 'Duplicate Model 1',
-      description: 'A duplicate model',
-      files: true,
-      functionCall: false,
-      enabled: true,
-      isCustom: true,
-      legacy: false,
-      maxOutput: 1000,
-      contextWindowTokens: 2048,
-      vision: false,
-    };
-
-    const action: AddCustomModelCard = {
-      type: 'add',
-      modelCard: duplicateModelCard,
-    };
-
-    const newState = customModelCardsReducer(initialState, action);
-
-    expect(newState).toEqual(initialState);
-  });
-
-  it('should delete a custom model card', () => {
-    const action: DeleteCustomModelCard = {
-      type: 'delete',
-      id: 'model1',
-    };
-
-    const newState = customModelCardsReducer(initialState, action);
-
-    expect(newState).not.toContainEqual(initialState[0]);
-    expect(newState.length).toBe(initialState.length - 1);
-  });
-
-  it('should update a custom model card', () => {
-    const action: UpdateCustomModelCard = {
-      type: 'update',
-      id: 'model1',
-      value: { displayName: 'Updated Model 1' },
-    };
-
-    const newState = customModelCardsReducer(initialState, action);
-
-    expect(newState.find((card) => card.id === 'model1')?.displayName).toBe('Updated Model 1');
-    expect(newState.length).toBe(initialState.length);
-  });
-
-  it('should throw an error for unhandled action type', () => {
-    const invalidAction = {
-      type: 'invalid',
-    };
-
-    expect(() => customModelCardsReducer(initialState, invalidAction as any)).toThrowError(
-      'Unhandled action type in customModelCardsReducer',
-    );
-  });
-
-  it('should return the original state if the model card is not found during update', () => {
-    const action: UpdateCustomModelCard = {
-      type: 'update',
-      id: 'nonexistent',
-      value: { displayName: 'Updated Nonexistent Model' },
-    };
-
-    const newState = customModelCardsReducer(initialState, action);
-
-    expect(newState).toEqual(initialState);
-  });
-
-  it('should return the original state if the model card ID is missing during add', () => {
-    const newModelCard: ChatModelCard = {
-      id: '',
-      displayName: 'Model 4',
-      description: 'A new model',
-      files: false,
-      functionCall: false,
-      enabled: true,
-      isCustom: true,
-      legacy: false,
-      maxOutput: 1500,
-      contextWindowTokens: 2048,
-      vision: false,
-    };
-
-    const action: AddCustomModelCard = {
-      type: 'add',
-      modelCard: newModelCard,
-    };
-
-    const newState = customModelCardsReducer(initialState, action);
-
-    expect(newState).toEqual(initialState);
-  });
-
-  it('should handle optional properties correctly', () => {
-    const newModelCard: ChatModelCard = {
-      id: 'model4',
-    };
-
-    const action: AddCustomModelCard = {
-      type: 'add',
-      modelCard: newModelCard,
-    };
-
-    const newState = customModelCardsReducer(initialState, action);
-
-    expect(newState).toContainEqual(newModelCard);
-  });
-
-  it('should handle an undefined initial state', () => {
-    const newModelCard: ChatModelCard = {
-      id: 'model4',
-      displayName: 'Model 4',
-      description: 'A new model',
-      files: false,
-      functionCall: false,
-      enabled: true,
-      isCustom: true,
-      legacy: false,
-      maxOutput: 1500,
-      contextWindowTokens: 2048,
-      vision: false,
-    };
-
-    const action: AddCustomModelCard = {
-      type: 'add',
-      modelCard: newModelCard,
-    };
-
-    const newState = customModelCardsReducer(undefined, action);
-
-    expect(newState).toContainEqual(newModelCard);
-    expect(newState.length).toBe(1);
-  });
-});

package/src/store/user/slices/modelList/reducers/customModelCard.ts

@@ -1,64 +0,0 @@
-import { produce } from 'immer';
-
-import { ChatModelCard } from '@/types/llm';
-
-export interface AddCustomModelCard {
-  modelCard: ChatModelCard;
-  type: 'add';
-}
-
-export interface DeleteCustomModelCard {
-  id: string;
-  type: 'delete';
-}
-
-export interface UpdateCustomModelCard {
-  id: string;
-  type: 'update';
-  value: Partial<ChatModelCard>;
-}
-
-export type CustomModelCardDispatch =
-  | AddCustomModelCard
-  | DeleteCustomModelCard
-  | UpdateCustomModelCard;
-
-export const customModelCardsReducer = (
-  state: ChatModelCard[] | undefined,
-  payload: CustomModelCardDispatch,
-): ChatModelCard[] => {
-  switch (payload.type) {
-    case 'add': {
-      return produce(state || [], (draftState) => {
-        const { id } = payload.modelCard;
-        if (!id) return;
-        if (draftState.some((card) => card.id === id)) return;
-
-        draftState.push(payload.modelCard);
-      });
-    }
-
-    case 'delete': {
-      return produce(state || [], (draftState) => {
-        const index = draftState.findIndex((card) => card.id === payload.id);
-        if (index !== -1) {
-          draftState.splice(index, 1);
-        }
-      });
-    }
-
-    case 'update': {
-      return produce(state || [], (draftState) => {
-        const index = draftState.findIndex((card) => card.id === payload.id);
-        if (index !== -1) {
-          const card = draftState[index];
-          Object.assign(card, payload.value);
-        }
-      });
-    }
-
-    default: {
-      throw new Error('Unhandled action type in customModelCardsReducer');
-    }
-  }
-};

package/src/store/user/slices/modelList/selectors/index.ts

@@ -1,3 +0,0 @@
-export { keyVaultsConfigSelectors } from './keyVaults';
-export { modelConfigSelectors } from './modelConfig';
-export { modelProviderSelectors } from './modelProvider';