@lobehub/chat 0.40.7 → 0.41.1

package/.eslintrc.js

@@ -7,5 +7,7 @@ config.rules['unicorn/prefer-type-error'] = 0;
 config.rules['unicorn/prefer-logical-operator-over-ternary'] = 0;
 config.rules['unicorn/no-null'] = 0;
 config.rules['unicorn/no-typeof-undefined'] = 0;
+config.rules['unicorn/explicit-length-check'] = 0;
+config.rules['unicorn/prefer-code-point'] = 0;
 
 module.exports = config;

package/CHANGELOG.md

@@ -2,6 +2,64 @@
 
 # Changelog
 
+### [Version 0.41.1](https://github.com/lobehub/lobe-chat/compare/v0.41.0...v0.41.1)
+
+<sup>Released on **2023-08-10**</sup>
+
+#### ♻ Code Refactoring
+
+- **misc**: 重构 settings store 代码写法.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### Code refactoring
+
+- **misc**: 重构 settings store 代码写法 ([4b6f917](https://github.com/lobehub/lobe-chat/commit/4b6f917))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
+## [Version 0.41.0](https://github.com/lobehub/lobe-chat/compare/v0.40.7...v0.41.0)
+
+<sup>Released on **2023-08-10**</sup>
+
+#### ✨ Features
+
+- **misc**: 支持持久化隐藏 Topic 功能.
+
+#### 💄 Styles
+
+- **misc**: 优化第一次水合逻辑.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### What's improved
+
+- **misc**: 支持持久化隐藏 Topic 功能 ([9ea2778](https://github.com/lobehub/lobe-chat/commit/9ea2778))
+
+#### Styles
+
+- **misc**: 优化第一次水合逻辑 ([fefae61](https://github.com/lobehub/lobe-chat/commit/fefae61))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
 ### [Version 0.40.7](https://github.com/lobehub/lobe-chat/compare/v0.40.6...v0.40.7)
 
 <sup>Released on **2023-08-10**</sup>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "0.40.7",
+  "version": "0.41.1",
   "description": "Lobe Chat is an open-source chatbot client using LangChain, Typescript and Next.js",
   "keywords": [
     "chatbot",
@@ -93,6 +93,7 @@
     "serpapi": "^2",
     "swr": "^2",
     "ts-md5": "^1",
+    "use-merge-value": "^1",
     "uuid": "^9",
     "zustand": "^4.4",
     "zustand-utils": "^1"

package/src/components/Empty/index.tsx

@@ -1,34 +1,60 @@
 import { ActionIcon, DivProps } from '@lobehub/ui';
 import { X } from 'lucide-react';
-import { memo, useState } from 'react';
+import Image from 'next/image';
+import { memo } from 'react';
+import useMergeState from 'use-merge-value';
 
 import { useStyles } from './style';
 
 interface EmptyProps extends DivProps {
+  alt: string;
   cover: string;
+  defaultVisible?: boolean;
   desc: string;
+  height?: number;
+  onVisibleChange?: (visible: boolean) => void;
   title: string;
+  visible?: boolean;
+  width?: number;
 }
 
-const Empty = memo<EmptyProps>(({ cover, title, desc, ...props }) => {
-  const [visiable, setVisiable] = useState(true);
-  const { styles } = useStyles();
-  if (!visiable) return null;
-  return (
-    <div className={styles.container} {...props}>
-      <ActionIcon
-        className={styles.close}
-        icon={X}
-        onClick={() => setVisiable(false)}
-        size={{ blockSize: 24, fontSize: 16 }}
-      />
-      {cover && <img alt="empty" src={cover} width="100%" />}
-      <div className={styles.content}>
-        {title && <h3>{title}</h3>}
-        {desc && <p className={styles.desc}>{desc}</p>}
+const Empty = memo<EmptyProps>(
+  ({
+    cover,
+    visible,
+    defaultVisible,
+    onVisibleChange,
+    alt,
+    title,
+    desc,
+    width,
+    height,
+    ...props
+  }) => {
+    const [value, setValue] = useMergeState(true, {
+      defaultValue: defaultVisible,
+      onChange: onVisibleChange,
+      value: visible,
+    });
+
+    const { styles } = useStyles();
+    if (!value) return null;
+    return (
+      <div className={styles.container} {...props}>
+        <ActionIcon
+          className={styles.close}
+          icon={X}
+          onClick={() => setValue(false)}
+          size={{ blockSize: 24, fontSize: 16 }}
+        />
+        {cover && <Image alt={alt} height={height} src={cover} width={width} />}
+        <div className={styles.content}>
+          {title && <h3>{title}</h3>}
+          {desc && <p className={styles.desc}>{desc}</p>}
+        </div>
       </div>
-    </div>
-  );
-});
+    );
+  },
+);
 
 export default Empty;

package/src/pages/chat/[id]/Conversation/ChatList/index.tsx

@@ -5,12 +5,7 @@ import { useTranslation } from 'react-i18next';
 import { Flexbox } from 'react-layout-kit';
 import { shallow } from 'zustand/shallow';
 
-import {
-  agentSelectors,
-  chatSelectors,
-  useSessionHydrated,
-  useSessionStore,
-} from '@/store/session';
+import { agentSelectors, chatSelectors, useSessionStore } from '@/store/session';
 import { ChatMessage } from '@/types/chatMessage';
 import { ErrorType } from '@/types/fetch';
 import { isFunctionMessage } from '@/utils/message';
@@ -34,9 +29,8 @@ const renderErrorMessage: RenderErrorMessage = (error, message) => {
 
 const List = () => {
   const { t } = useTranslation('common');
-  const hydrated = useSessionHydrated();
+
   const data = useSessionStore(chatSelectors.currentChats, isEqual);
-  console.log(hydrated, data);
   const [displayMode, chatLoadingId, deleteMessage, resendMessage, dispatchMessage] =
     useSessionStore(
       (s) => [

package/src/pages/chat/[id]/Sidebar/Topic/index.tsx

@@ -1,26 +1,41 @@
 import { useThemeMode } from 'antd-style';
+import isEqual from 'fast-deep-equal';
 import { useTranslation } from 'react-i18next';
 import { Flexbox } from 'react-layout-kit';
 import { shallow } from 'zustand/shallow';
 
 import Empty from '@/components/Empty';
 import { topicSelectors, useSessionStore } from '@/store/session';
+import { useSettings } from '@/store/settings';
 
 import TopicItem from './TopicItem';
 
 export const Topic = () => {
-  const topics = useSessionStore(topicSelectors.currentTopics);
+  const topics = useSessionStore(topicSelectors.currentTopics, isEqual);
   const { isDarkMode } = useThemeMode();
   const [activeTopicId] = useSessionStore((s) => [s.activeTopicId], shallow);
   const { t } = useTranslation('empty');
+
+  const [visible, updateGuideState] = useSettings(
+    (s) => [s.guide?.topic, s.updateGuideState],
+    shallow,
+  );
+
   return (
     <Flexbox gap={2}>
       {topics?.length === 0 && (
         <Empty
+          alt={t('topic.desc')}
           cover={`/images/empty_topic_${isDarkMode ? 'dark' : 'light'}.webp`}
           desc={t('topic.desc')}
+          height={120}
+          onVisibleChange={(visible) => {
+            updateGuideState({ topic: visible });
+          }}
           style={{ marginBottom: 6 }}
           title={t('topic.title')}
+          visible={visible}
+          width={200}
         />
       )}
 

package/src/store/session/hooks/useSessionHydrated.ts

@@ -3,12 +3,15 @@ import { useEffect, useState } from 'react';
 import { useSessionStore } from '@/store/session';
 
 export const useSessionHydrated = () => {
-  const [isInit, setInit] = useState(false);
+  // 根据 sessions 是否有值来判断是否已经初始化
+  const hasInited = !!Object.values(useSessionStore.getState().sessions).length;
+
+  const [isInit, setInit] = useState(hasInited);
 
   useEffect(() => {
     const hasRehydrated = useSessionStore.persist.hasHydrated();
 
-    if (hasRehydrated) {
+    if (hasRehydrated && !isInit) {
       setInit(true);
     }
   }, []);

package/src/store/session/store.ts

@@ -10,6 +10,8 @@ import { AgentAction, createAgentSlice } from './slices/agentConfig';
 import { ChatAction, createChatSlice } from './slices/chat';
 import { SessionAction, createSessionSlice } from './slices/session';
 
+//  ===============  聚合 createStoreFn ============ //
+
 export type SessionStore = SessionAction & AgentAction & ChatAction & SessionStoreState;
 
 const createStore: StateCreator<SessionStore, [['zustand/devtools', never]]> = (...parameters) => ({
@@ -19,6 +21,8 @@ const createStore: StateCreator<SessionStore, [['zustand/devtools', never]]> = (
   ...createChatSlice(...parameters),
 });
 
+//  ===============  persist 本地缓存中间件配置 ============ //
+
 type SessionPersist = Pick<SessionStore, 'sessions'>;
 
 const LOBE_CHAT = 'LOBE_CHAT';
@@ -36,6 +40,8 @@ const persistOptions: PersistOptions<SessionStore, SessionPersist> = {
   // version: Migration.targetVersion,
 };
 
+//  ===============  实装 useStore ============ //
+
 export const useSessionStore = createWithEqualityFn<SessionStore>()(
   persist(
     devtools(createStore, {

package/src/store/settings/index.ts

@@ -1,27 +1,3 @@
-import equal from 'fast-deep-equal';
-import { type PersistOptions, devtools, persist } from 'zustand/middleware';
-import { createWithEqualityFn } from 'zustand/traditional';
-
-import { isDev } from '@/utils/env';
-
-import { type SettingsStore, createStore } from './store';
-
-export const LOBE_SETTINGS = 'LOBE_SETTINGS';
-
-const persistOptions: PersistOptions<SettingsStore> = {
-  name: LOBE_SETTINGS,
-  skipHydration: true,
-};
-
-export const useSettings = createWithEqualityFn<SettingsStore>()(
-  persist(
-    devtools(createStore, {
-      name: LOBE_SETTINGS + (isDev ? '_DEV' : ''),
-    }),
-    persistOptions,
-  ),
-  equal,
-);
-
 export * from './selectors';
 export type { SettingsStore } from './store';
+export { useSettings } from './store';

package/src/store/settings/initialState.ts

@@ -3,7 +3,13 @@ import type { GlobalSettings } from '@/types/settings';
 
 export type SidebarTabKey = 'chat' | 'market' | 'settings';
 
+export interface Guide {
+  // Topic 引导
+  topic?: boolean;
+}
+
 export interface AppSettingsState {
+  guide?: Guide;
   inputHeight: number;
   sessionExpandable?: boolean;
   sessionsWidth: number;
@@ -13,6 +19,7 @@ export interface AppSettingsState {
 }
 
 export const initialState: AppSettingsState = {
+  guide: {},
   inputHeight: 200,
   sessionExpandable: true,
   sessionsWidth: 320,

package/src/store/settings/{action.ts → slices/agent.ts}

@@ -1,77 +1,37 @@
-import { ThemeMode } from 'antd-style';
 import { produce } from 'immer';
 import { merge } from 'lodash-es';
 import type { StateCreator } from 'zustand/vanilla';
 
-import { DEFAULT_AGENT, DEFAULT_BASE_SETTINGS, DEFAULT_SETTINGS } from '@/const/settings';
+import { DEFAULT_AGENT } from '@/const/settings';
 import { MetaData } from '@/types/meta';
 import type { LobeAgentSession } from '@/types/session';
 import { LobeAgentConfig } from '@/types/session';
 import type { GlobalSettings } from '@/types/settings';
 import { setNamespace } from '@/utils/storeDebug';
 
-import type { SidebarTabKey } from './initialState';
-import { AppSettingsState } from './initialState';
-import type { SettingsStore } from './store';
+import type { SettingsStore } from '../store';
 
 const t = setNamespace('settings');
 
 /**
  * 设置操作
  */
-export interface SettingsAction {
-  importAppSettings: (settings: GlobalSettings) => void;
+export interface AgentAction {
   resetAgentConfig: () => void;
   resetAgentMeta: () => void;
-  resetBaseSettings: () => void;
   resetDefaultAgent: () => void;
-  /**
-   * 重置设置
-   */
-  resetSettings: () => void;
   setAgentConfig: (config: Partial<LobeAgentSession['config']>) => void;
   setAgentMeta: (meta: Partial<LobeAgentSession['meta']>) => void;
-  /**
-   * 设置全局设置
-   * @param settings - 全局设置
-   */
-  setAppSettings: (settings: AppSettingsState) => void;
-  /**
-   * 设置部分配置设置
-   * @param settings - 部分配置设置
-   */
-  setSettings: (settings: Partial<GlobalSettings>) => void;
-  /**
-   * 设置主题模式
-   * @param themeMode - 主题模式
-   */
-  setThemeMode: (themeMode: ThemeMode) => void;
-  /**
-   * 切换侧边栏选项
-   * @param key - 选中的侧边栏选项
-   */
-  switchSideBar: (key: SidebarTabKey) => void;
   toggleAgentPanel: (visible?: boolean) => void;
   toggleAgentPlugin: (pluginId: string) => void;
 }
 
-export const createSettings: StateCreator<
+export const createAgentSlice: StateCreator<
   SettingsStore,
   [['zustand/devtools', never]],
   [],
-  SettingsAction
+  AgentAction
 > = (set, get) => ({
-  importAppSettings: (importAppSettings) => {
-    const { setSettings } = get();
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const { OPENAI_API_KEY: _, password: __, ...settings } = importAppSettings;
-
-    setSettings({
-      ...settings,
-      // 如果用户存在用户头像，那么不做导入
-      avatar: !get().settings.avatar ? settings.avatar : get().settings.avatar,
-    });
-  },
   resetAgentConfig: () => {
     const settings = produce(get().settings, (draft: GlobalSettings) => {
       draft.defaultAgent.config = DEFAULT_AGENT.config;
@@ -84,20 +44,12 @@ export const createSettings: StateCreator<
     });
     set({ settings }, false, t('resetAgentMeta'));
   },
-  resetBaseSettings: () => {
-    const settings = get().settings;
-
-    set({ settings: { ...settings, ...DEFAULT_BASE_SETTINGS } }, false, t('resetBaseSettings'));
-  },
   resetDefaultAgent: () => {
     const settings = produce(get().settings, (draft: GlobalSettings) => {
       draft.defaultAgent = DEFAULT_AGENT;
     });
     set({ settings }, false, t('resetDefaultAgent'));
   },
-  resetSettings: () => {
-    set({ settings: DEFAULT_SETTINGS }, false, t('resetSettings'));
-  },
   setAgentConfig: (config) => {
     const settings = produce(get().settings, (draft: GlobalSettings) => {
       const oldConfig = draft.defaultAgent.config as LobeAgentConfig;
@@ -114,19 +66,6 @@ export const createSettings: StateCreator<
 
     set({ settings }, false, t('setAgentMeta', meta));
   },
-  setAppSettings: (settings) => {
-    set({ ...settings }, false, t('setAppSettings', settings));
-  },
-  setSettings: (settings) => {
-    const oldSetting = get().settings;
-    set({ settings: merge(oldSetting, settings) }, false, t('setSettings', settings));
-  },
-  setThemeMode: (themeMode) => {
-    get().setSettings({ themeMode });
-  },
-  switchSideBar: (key) => {
-    set({ sidebarKey: key }, false, t('switchSideBar', key));
-  },
   toggleAgentPanel: (newValue) => {
     const showAgentConfig = typeof newValue === 'boolean' ? newValue : !get().showAgentConfig;
 

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

@@ -0,0 +1,96 @@
+import { ThemeMode } from 'antd-style';
+import { produce } from 'immer';
+import { merge } from 'lodash-es';
+import type { StateCreator } from 'zustand/vanilla';
+
+import { DEFAULT_AGENT, DEFAULT_BASE_SETTINGS, DEFAULT_SETTINGS } from '@/const/settings';
+import type { GlobalSettings } from '@/types/settings';
+import { setNamespace } from '@/utils/storeDebug';
+
+import type { Guide, SidebarTabKey } from '../initialState';
+import { AppSettingsState } from '../initialState';
+import type { SettingsStore } from '../store';
+
+const t = setNamespace('settings');
+
+/**
+ * 设置操作
+ */
+export interface CommonAction {
+  importAppSettings: (settings: GlobalSettings) => void;
+  resetBaseSettings: () => void;
+  /**
+   * 重置设置
+   */
+  resetSettings: () => void;
+  /**
+   * 设置全局设置
+   * @param settings - 全局设置
+   */
+  setAppSettings: (settings: AppSettingsState) => void;
+  /**
+   * 设置部分配置设置
+   * @param settings - 部分配置设置
+   */
+  setSettings: (settings: Partial<GlobalSettings>) => void;
+  /**
+   * 设置主题模式
+   * @param themeMode - 主题模式
+   */
+  setThemeMode: (themeMode: ThemeMode) => void;
+  /**
+   * 切换侧边栏选项
+   * @param key - 选中的侧边栏选项
+   */
+  switchSideBar: (key: SidebarTabKey) => void;
+  updateGuideState: (guide: Partial<Guide>) => void;
+}
+
+export const createCommonSlice: StateCreator<
+  SettingsStore,
+  [['zustand/devtools', never]],
+  [],
+  CommonAction
+> = (set, get) => ({
+  importAppSettings: (importAppSettings) => {
+    const { setSettings } = get();
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    const { OPENAI_API_KEY: _, password: __, ...settings } = importAppSettings;
+
+    setSettings({
+      ...settings,
+      // 如果用户存在用户头像，那么不做导入
+      avatar: !get().settings.avatar ? settings.avatar : get().settings.avatar,
+    });
+  },
+  resetBaseSettings: () => {
+    const settings = get().settings;
+
+    set({ settings: { ...settings, ...DEFAULT_BASE_SETTINGS } }, false, t('resetBaseSettings'));
+  },
+  resetDefaultAgent: () => {
+    const settings = produce(get().settings, (draft: GlobalSettings) => {
+      draft.defaultAgent = DEFAULT_AGENT;
+    });
+    set({ settings }, false, t('resetDefaultAgent'));
+  },
+  resetSettings: () => {
+    set({ settings: DEFAULT_SETTINGS }, false, t('resetSettings'));
+  },
+  setAppSettings: (settings) => {
+    set({ ...settings }, false, t('setAppSettings', settings));
+  },
+  setSettings: (settings) => {
+    const oldSetting = get().settings;
+    set({ settings: merge(oldSetting, settings) }, false, t('setSettings', settings));
+  },
+  setThemeMode: (themeMode) => {
+    get().setSettings({ themeMode });
+  },
+  switchSideBar: (key) => {
+    set({ sidebarKey: key }, false, t('switchSideBar', key));
+  },
+  updateGuideState: (guide) => {
+    set({ guide: { ...get().guide, ...guide } });
+  },
+});

package/src/store/settings/store.ts

@@ -1,13 +1,43 @@
+import equal from 'fast-deep-equal';
+import { PersistOptions, devtools, persist } from 'zustand/middleware';
+import { createWithEqualityFn } from 'zustand/traditional';
 import { StateCreator } from 'zustand/vanilla';
 
-import { type SettingsAction, createSettings } from './action';
+import { isDev } from '@/utils/env';
+
 import { type AppSettingsState, initialState } from './initialState';
+import { type AgentAction, createAgentSlice } from './slices/agent';
+import { type CommonAction, createCommonSlice } from './slices/common';
+
+//  ===============  聚合 createStoreFn ============ //
 
-export type SettingsStore = SettingsAction & AppSettingsState;
+export type SettingsStore = CommonAction & AppSettingsState & AgentAction;
 
-export const createStore: StateCreator<SettingsStore, [['zustand/devtools', never]]> = (
+const createStore: StateCreator<SettingsStore, [['zustand/devtools', never]]> = (
   ...parameters
 ) => ({
   ...initialState,
-  ...createSettings(...parameters),
+  ...createCommonSlice(...parameters),
+  ...createAgentSlice(...parameters),
 });
+
+//  ===============  persist 本地缓存中间件配置 ============ //
+
+const LOBE_SETTINGS = 'LOBE_SETTINGS';
+
+const persistOptions: PersistOptions<SettingsStore> = {
+  name: LOBE_SETTINGS,
+  skipHydration: true,
+};
+
+//  ===============  实装 useStore ============ //
+
+export const useSettings = createWithEqualityFn<SettingsStore>()(
+  persist(
+    devtools(createStore, {
+      name: LOBE_SETTINGS + (isDev ? '_DEV' : ''),
+    }),
+    persistOptions,
+  ),
+  equal,
+);