@lobehub/chat 0.162.9 → 0.162.11

package/CHANGELOG.md

@@ -2,6 +2,56 @@
 
 # Changelog
 
+### [Version 0.162.11](https://github.com/lobehub/lobe-chat/compare/v0.162.10...v0.162.11)
+
+<sup>Released on **2024-05-29**</sup>
+
+#### 🐛 Bug Fixes
+
+- **misc**: Fix import config.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### What's fixed
+
+- **misc**: Fix import config, closes [#2720](https://github.com/lobehub/lobe-chat/issues/2720) ([a5ddd9a](https://github.com/lobehub/lobe-chat/commit/a5ddd9a))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
+### [Version 0.162.10](https://github.com/lobehub/lobe-chat/compare/v0.162.9...v0.162.10)
+
+<sup>Released on **2024-05-29**</sup>
+
+#### ♻ Code Refactoring
+
+- **misc**: Refactor the config import for server import.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### Code refactoring
+
+- **misc**: Refactor the config import for server import, closes [#2718](https://github.com/lobehub/lobe-chat/issues/2718) ([d4ee64b](https://github.com/lobehub/lobe-chat/commit/d4ee64b))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
 ### [Version 0.162.9](https://github.com/lobehub/lobe-chat/compare/v0.162.8...v0.162.9)
 
 <sup>Released on **2024-05-29**</sup>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "0.162.9",
+  "version": "0.162.11",
   "description": "Lobe Chat - an open-source, high-performance chatbot framework that supports speech synthesis, multimodal, and extensible Function Call plugin system. Supports one-click free deployment of your private ChatGPT/LLM web application.",
   "keywords": [
     "framework",

package/src/database/client/schemas/message.ts

@@ -34,7 +34,7 @@ export const DB_MessageSchema = z.object({
 
   fromModel: z.string().optional(),
   fromProvider: z.string().optional(),
-  translate: TranslateSchema.optional().or(z.literal(false)),
+  translate: TranslateSchema.optional().or(z.literal(false)).or(z.null()),
   tts: z.any().optional(),
 
   traceId: z.string().optional(),

package/src/features/DataImporter/index.tsx

@@ -4,14 +4,15 @@ import { Icon } from '@lobehub/ui';
 import { Button, Result, Table, Upload } from 'antd';
 import { createStyles } from 'antd-style';
 import { CheckCircle, ImportIcon } from 'lucide-react';
-import React, { ReactNode, memo, useState } from 'react';
+import React, { ReactNode, memo, useMemo, useState } from 'react';
 import { useTranslation } from 'react-i18next';
 import { Center, Flexbox } from 'react-layout-kit';
 
 import DataStyleModal from '@/components/DataStyleModal';
-import { useImportConfig } from '@/hooks/useImportConfig';
 import { ImportResult, ImportResults } from '@/services/config';
 
+import { useImportConfig } from './useImportConfig';
+
 const useStyles = createStyles(({ css, token }) => {
   const size = 28;
 
@@ -145,12 +146,29 @@ interface DataImporterProps {
 }
 const DataImporter = memo<DataImporterProps>(({ children, onFinishImport }) => {
   const { t } = useTranslation('common');
-  const { importConfig } = useImportConfig();
+  const importConfig = useImportConfig();
   const [duration, setDuration] = useState(0);
   const [importState, setImportState] = useState(ImportState.Start);
   const [importData, setImportData] = useState<ImportResults | undefined>();
   const { styles } = useStyles();
 
+  const dataSource = useMemo(() => {
+    if (!importData) return;
+
+    const { type, ...res } = importData;
+
+    if (type === 'settings') return;
+
+    return Object.entries(res)
+      .filter(([, v]) => !!v)
+      .map(([item, value]: [string, ImportResult]) => ({
+        added: value.added,
+        error: value.errors,
+        skips: value.skips,
+        title: t(`importModal.result.${item as keyof ImportResults}`),
+      }));
+  }, [importData]);
+
   return (
     <>
       <DataStyleModal
@@ -187,7 +205,7 @@ const DataImporter = memo<DataImporterProps>(({ children, onFinishImport }) => {
               style={{ paddingBlock: 24 }}
               subTitle={
                 // if there is no importData, means it's only import the settings
-                !importData ? (
+                !dataSource ? (
                   t('importModal.finish.onlySettings')
                 ) : (
                   <Flexbox gap={16} width={400}>
@@ -200,14 +218,7 @@ const DataImporter = memo<DataImporterProps>(({ children, onFinishImport }) => {
                         { dataIndex: 'skips', title: t('importModal.result.skips') },
                         { dataIndex: 'error', title: t('importModal.result.errors') },
                       ]}
-                      dataSource={Object.entries(importData).map(
-                        ([item, value]: [string, ImportResult]) => ({
-                          added: value.added,
-                          error: value.errors,
-                          skips: value.skips,
-                          title: t(`importModal.result.${item as keyof ImportResults}`),
-                        }),
-                      )}
+                      dataSource={dataSource}
                       pagination={false}
                       size={'small'}
                     />

package/src/features/DataImporter/useImportConfig.ts

@@ -0,0 +1,27 @@
+import { useCallback } from 'react';
+
+import { ImportResults, configService } from '@/services/config';
+import { useChatStore } from '@/store/chat';
+import { useSessionStore } from '@/store/session';
+import { importConfigFile } from '@/utils/config';
+
+export const useImportConfig = () => {
+  const refreshSessions = useSessionStore((s) => s.refreshSessions);
+  const [refreshMessages, refreshTopics] = useChatStore((s) => [s.refreshMessages, s.refreshTopic]);
+
+  return useCallback(
+    async (file: File) =>
+      new Promise<ImportResults | undefined>((resolve) => {
+        importConfigFile(file, async (config) => {
+          const data = await configService.importConfigState(config);
+
+          await refreshSessions();
+          await refreshMessages();
+          await refreshTopics();
+
+          resolve(data);
+        });
+      }),
+    [],
+  );
+};

package/src/layout/GlobalProvider/StoreInitialization.tsx

@@ -5,7 +5,6 @@ import { memo, useEffect } from 'react';
 import { createStoreUpdater } from 'zustand-utils';
 
 import { LOBE_URL_IMPORT_NAME } from '@/const/url';
-import { useImportConfig } from '@/hooks/useImportConfig';
 import { useIsMobile } from '@/hooks/useIsMobile';
 import { useEnabledDataSync } from '@/hooks/useSyncData';
 import { useAgentStore } from '@/store/agent';
@@ -17,9 +16,10 @@ import { authSelectors } from '@/store/user/selectors';
 const StoreInitialization = memo(() => {
   const router = useRouter();
 
-  const [useInitUserState, isLogin] = useUserStore((s) => [
-    s.useInitUserState,
+  const [isLogin, useInitUserState, importUrlShareSettings] = useUserStore((s) => [
     authSelectors.isLogin(s),
+    s.useInitUserState,
+    s.importUrlShareSettings,
   ]);
 
   const { serverConfig } = useServerConfigStore();
@@ -52,10 +52,9 @@ const StoreInitialization = memo(() => {
   useStoreUpdater('router', router);
 
   // Import settings from the url
-  const { importSettings } = useImportConfig();
   const searchParam = useSearchParams().get(LOBE_URL_IMPORT_NAME);
   useEffect(() => {
-    importSettings(searchParam);
+    importUrlShareSettings(searchParam);
   }, [searchParam]);
 
   // useEffect(() => {

package/src/services/config.ts

@@ -1,3 +1,4 @@
+import { importService } from '@/services/import';
 import { messageService } from '@/services/message';
 import { sessionService } from '@/services/session';
 import { topicService } from '@/services/topic';
@@ -6,10 +7,6 @@ import { sessionSelectors } from '@/store/session/selectors';
 import { useUserStore } from '@/store/user';
 import { settingsSelectors } from '@/store/user/selectors';
 import { ConfigFile } from '@/types/exportConfig';
-import { ChatMessage } from '@/types/message';
-import { LobeSessions, SessionGroupItem } from '@/types/session';
-import { ChatTopic } from '@/types/topic';
-import { UserSettings } from '@/types/user/settings';
 import { createConfigFile, exportConfigFile } from '@/utils/config';
 
 export interface ImportResult {
@@ -20,71 +17,34 @@ export interface ImportResult {
 export interface ImportResults {
   messages?: ImportResult;
   sessionGroups?: ImportResult;
-  sessions: ImportResult;
+  sessions?: ImportResult;
   topics?: ImportResult;
+  type?: string;
 }
 
 class ConfigService {
-  /**
-   * import sessions from files
-   * @param sessions
-   */
-  importSessions = async (sessions: LobeSessions) => {
-    return await sessionService.batchCreateSessions(sessions);
-  };
-  importMessages = async (messages: ChatMessage[]) => {
-    return messageService.batchCreateMessages(messages);
-  };
-  importSettings = async (settings: UserSettings) => {
-    useUserStore.getState().importAppSettings(settings);
-  };
-  importTopics = async (topics: ChatTopic[]) => {
-    return topicService.batchCreateTopics(topics);
-  };
-  importSessionGroups = async (sessionGroups: SessionGroupItem[]) => {
-    return sessionService.batchCreateSessionGroups(sessionGroups || []);
-  };
+  importConfigState = async (config: ConfigFile): Promise<ImportResults> => {
+    if (config.exportType === 'settings') {
+      await importService.importSettings(config.state.settings);
+      return { type: 'settings' };
+    }
 
-  importConfigState = async (config: ConfigFile): Promise<ImportResults | undefined> => {
-    switch (config.exportType) {
-      case 'settings': {
-        await this.importSettings(config.state.settings);
-
-        break;
-      }
-
-      case 'agents': {
-        const sessionGroups = await this.importSessionGroups(config.state.sessionGroups);
-
-        const data = await this.importSessions(config.state.sessions);
-        return {
-          sessionGroups: this.mapImportResult(sessionGroups),
-          sessions: this.mapImportResult(data),
-        };
-      }
-
-      case 'all': {
-        await this.importSettings(config.state.settings);
-      }
-      // all and sessions have the same data process, so we can fall through
-
-      // eslint-disable-next-line no-fallthrough
-      case 'sessions': {
-        const sessionGroups = await this.importSessionGroups(config.state.sessionGroups);
-        const sessions = await this.importSessions(config.state.sessions);
-        const topics = await this.importTopics(config.state.topics);
-        const messages = await this.importMessages(config.state.messages);
-
-        return {
-          messages: this.mapImportResult(messages),
-          sessionGroups: this.mapImportResult(sessionGroups),
-          sessions: this.mapImportResult(sessions),
-          topics: this.mapImportResult(topics),
-        };
-      }
+    if (config.exportType === 'all') {
+      await importService.importSettings(config.state.settings);
     }
+
+    const data = await importService.importData({
+      messages: (config.state as any).messages || [],
+      sessionGroups: (config.state as any).sessionGroups || [],
+      sessions: (config.state as any).sessions || [],
+      topics: (config.state as any).topics || [],
+    });
+
+    return { ...data, type: config.exportType };
   };
 
+  // TODO: Seperate export feature into a new service like importService
+
   /**
    * export all agents
    */
@@ -190,18 +150,6 @@ class ConfigService {
 
   private getAgent = (id: string) =>
     sessionSelectors.getSessionById(id)(useSessionStore.getState());
-
-  private mapImportResult = (input: {
-    added: number;
-    errors?: Error[];
-    skips: string[];
-  }): ImportResult => {
-    return {
-      added: input.added,
-      errors: input.errors?.length || 0,
-      skips: input.skips.length,
-    };
-  };
 }
 
 export const configService = new ConfigService();

package/src/services/import/client.ts

@@ -0,0 +1,62 @@
+import { MessageModel } from '@/database/client/models/message';
+import { SessionModel } from '@/database/client/models/session';
+import { SessionGroupModel } from '@/database/client/models/sessionGroup';
+import { TopicModel } from '@/database/client/models/topic';
+import { ImportResult, ImportResults } from '@/services/config';
+import { useUserStore } from '@/store/user';
+import { ConfigStateSessions } from '@/types/exportConfig';
+import { UserSettings } from '@/types/user/settings';
+
+export class ClientService {
+  importSettings = async (settings: UserSettings) => {
+    await useUserStore.getState().importAppSettings(settings);
+  };
+
+  importData = async (config: ConfigStateSessions): Promise<ImportResults> => {
+    const { messages, sessionGroups, sessions, topics } = config;
+
+    let messageResult: ImportResult | undefined;
+    let sessionResult: ImportResult | undefined;
+    let sessionGroupResult: ImportResult | undefined;
+    let topicResult: ImportResult | undefined;
+
+    if (messages.length > 0) {
+      const res = await MessageModel.batchCreate(messages);
+      messageResult = this.mapImportResult(res);
+    }
+
+    if (sessionGroups.length > 0) {
+      const res = await SessionGroupModel.batchCreate(sessionGroups);
+      sessionGroupResult = this.mapImportResult(res);
+    }
+
+    if (topics.length > 0) {
+      const res = await TopicModel.batchCreate(topics as any);
+      topicResult = this.mapImportResult(res);
+    }
+
+    if (sessions.length > 0) {
+      const data = await SessionModel.batchCreate(sessions);
+      sessionResult = this.mapImportResult(data);
+    }
+
+    return {
+      messages: messageResult,
+      sessionGroups: sessionGroupResult,
+      sessions: sessionResult,
+      topics: topicResult,
+    };
+  };
+
+  private mapImportResult = (input: {
+    added: number;
+    errors?: Error[];
+    skips: string[];
+  }): ImportResult => {
+    return {
+      added: input.added,
+      errors: input.errors?.length || 0,
+      skips: input.skips.length,
+    };
+  };
+}

package/src/services/import/index.ts

@@ -0,0 +1,3 @@
+import { ClientService } from './client';
+
+export const importService = new ClientService();

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

@@ -3,6 +3,7 @@ import isEqual from 'fast-deep-equal';
 import { DeepPartial } from 'utility-types';
 import type { StateCreator } from 'zustand/vanilla';
 
+import { shareService } from '@/services/share';
 import { userService } from '@/services/user';
 import type { UserStore } from '@/store/user';
 import { LocaleMode } from '@/types/locale';
@@ -14,8 +15,8 @@ import { merge } from '@/utils/merge';
 
 export interface UserSettingsAction {
   importAppSettings: (settings: UserSettings) => Promise<void>;
+  importUrlShareSettings: (settingsParams: string | null) => Promise<void>;
   internal_createSignal: () => AbortController;
-
   resetSettings: () => Promise<void>;
   setSettings: (settings: DeepPartial<UserSettings>) => Promise<void>;
   switchLocale: (locale: LocaleMode) => Promise<void>;
@@ -39,6 +40,21 @@ export const createSettingsSlice: StateCreator<
     await setSettings(importAppSettings);
   },
 
+  /**
+   * Import settings from a string in json format
+   */
+  importUrlShareSettings: async (settingsParams: string | null) => {
+    if (settingsParams) {
+      const importSettings = shareService.decodeShareSettings(settingsParams);
+      if (importSettings?.message || !importSettings?.data) {
+        // handle some error
+        return;
+      }
+
+      await get().setSettings(importSettings.data);
+    }
+  },
+
   internal_createSignal: () => {
     const abortController = get().updateSettingsSignal;
     if (abortController && !abortController.signal.aborted) abortController.abort('canceled');

package/src/types/message/index.ts

@@ -38,7 +38,7 @@ export interface ChatMessage extends BaseDataModel {
     fromModel?: string;
     fromProvider?: string;
     // 翻译
-    translate?: ChatTranslate | false;
+    translate?: ChatTranslate | false | null;
     // TTS
     tts?: ChatTTS;
   } & Record<string, any>;

package/src/hooks/useImportConfig.ts

@@ -1,45 +0,0 @@
-import { useMemo } from 'react';
-
-import { ImportResults, configService } from '@/services/config';
-import { shareService } from '@/services/share';
-import { useChatStore } from '@/store/chat';
-import { useSessionStore } from '@/store/session';
-import { useUserStore } from '@/store/user';
-import { importConfigFile } from '@/utils/config';
-
-export const useImportConfig = () => {
-  const refreshSessions = useSessionStore((s) => s.refreshSessions);
-  const [refreshMessages, refreshTopics] = useChatStore((s) => [s.refreshMessages, s.refreshTopic]);
-  const [setSettings] = useUserStore((s) => [s.setSettings]);
-
-  const importConfig = async (file: File) =>
-    new Promise<ImportResults | undefined>((resolve) => {
-      importConfigFile(file, async (config) => {
-        const data = await configService.importConfigState(config);
-
-        await refreshSessions();
-        await refreshMessages();
-        await refreshTopics();
-
-        resolve(data);
-      });
-    });
-
-  /**
-   * Import settings from a string in json format
-   * @param settingsParams
-   * @returns
-   */
-  const importSettings = (settingsParams: string | null) => {
-    if (settingsParams) {
-      const importSettings = shareService.decodeShareSettings(settingsParams);
-      if (importSettings?.message || !importSettings?.data) {
-        // handle some error
-        return;
-      }
-      setSettings(importSettings.data);
-    }
-  };
-
-  return useMemo(() => ({ importConfig, importSettings }), []);
-};