@lobehub/chat 0.1.6

package/src/store/settings/action.ts

@@ -0,0 +1,40 @@
+import { ThemeMode } from 'antd-style';
+import type { StateCreator } from 'zustand/vanilla';
+
+import type { ConfigSettings } from '@/types/exportConfig';
+
+import type { SidebarTabKey } from './initialState';
+import { DEFAULT_SETTINGS, GlobalSettingsState } from './initialState';
+import type { SettingsStore } from './store';
+
+export interface SettingsAction {
+  resetSettings: () => void;
+  setGlobalSettings: (settings: GlobalSettingsState) => void;
+  setSettings: (settings: Partial<ConfigSettings>) => void;
+  setThemeMode: (themeMode: ThemeMode) => void;
+  switchSideBar: (key: SidebarTabKey) => void;
+}
+
+export const createSettings: StateCreator<
+  SettingsStore,
+  [['zustand/devtools', never]],
+  [],
+  SettingsAction
+> = (set, get) => ({
+  resetSettings: () => {
+    set({ settings: DEFAULT_SETTINGS });
+  },
+  setGlobalSettings: (settings) => {
+    set({ ...settings });
+  },
+  setSettings: (settings) => {
+    const oldSetting = get().settings;
+    set({ settings: { ...oldSetting, ...settings } });
+  },
+  setThemeMode: (themeMode) => {
+    get().setSettings({ themeMode });
+  },
+  switchSideBar: (key) => {
+    set({ sidebarKey: key });
+  },
+});

package/src/store/settings/index.ts

@@ -0,0 +1,23 @@
+import { create } from 'zustand';
+import { type PersistOptions, devtools, persist } from 'zustand/middleware';
+
+import { type SettingsStore, createStore } from './store';
+
+export const LOBE_SETTINGS = 'LOBE_SETTINGS';
+
+const persistOptions: PersistOptions<SettingsStore> = {
+  name: LOBE_SETTINGS,
+  skipHydration: true,
+};
+
+export const useSettings = create<SettingsStore>()(
+  persist(
+    devtools(createStore, {
+      name: LOBE_SETTINGS,
+    }),
+    persistOptions,
+  ),
+);
+
+export * from './selectors';
+export type { SettingsStore } from './store';

package/src/store/settings/initialState.ts

@@ -0,0 +1,41 @@
+import type { ConfigSettings } from '@/types/exportConfig';
+
+export type SidebarTabKey = 'chat' | 'market';
+export const DEFAULT_SETTINGS: ConfigSettings = {
+  accessCode: '',
+  avatar: '',
+  compressThreshold: 24,
+  enableCompressThreshold: true,
+  enableHistoryCount: true,
+  enableMaxTokens: true,
+  endpoint: '',
+  fontSize: 14,
+  frequencyPenalty: 0,
+  historyCount: 24,
+  language: 'zh-CN',
+  maxTokens: 2000,
+  model: 'gpt-3.5-turbo',
+  neutralColor: '',
+  presencePenalty: 0,
+  primaryColor: '',
+  temperature: 0.5,
+  themeMode: 'auto',
+  token: '',
+  topP: 1,
+};
+
+export interface GlobalSettingsState {
+  inputHeight: number;
+  sessionExpandable?: boolean;
+  sessionsWidth: number;
+  settings: ConfigSettings;
+  sidebarKey: SidebarTabKey;
+}
+
+export const initialState: GlobalSettingsState = {
+  inputHeight: 200,
+  sessionExpandable: true,
+  sessionsWidth: 320,
+  settings: DEFAULT_SETTINGS,
+  sidebarKey: 'chat',
+};

package/src/store/settings/selectors.ts

@@ -0,0 +1,17 @@
+import { defaults } from 'lodash-es';
+
+import { DEFAULT_SETTINGS } from '@/store/settings/initialState';
+
+import { SettingsStore } from './store';
+
+const currentSettings = (s: SettingsStore) => defaults(s.settings, DEFAULT_SETTINGS);
+
+const selecThemeMode = (s: SettingsStore) => ({
+  setThemeMode: s.setThemeMode,
+  themeMode: s.settings.themeMode,
+});
+
+export const settingsSelectors = {
+  currentSettings,
+  selecThemeMode,
+};

package/src/store/settings/store.ts

@@ -0,0 +1,13 @@
+import { StateCreator } from 'zustand/vanilla';
+
+import { type SettingsAction, createSettings } from './action';
+import { type GlobalSettingsState, initialState } from './initialState';
+
+export type SettingsStore = SettingsAction & GlobalSettingsState;
+
+export const createStore: StateCreator<SettingsStore, [['zustand/devtools', never]]> = (
+  ...parameters
+) => ({
+  ...initialState,
+  ...createSettings(...parameters),
+});

package/src/styles/antdOverride.ts

@@ -0,0 +1,33 @@
+import { Theme, css } from 'antd-style';
+import { readableColor } from 'polished';
+
+export default (token: Theme) => css`
+  .ant-btn {
+    box-shadow: none;
+  }
+
+  .ant-popover {
+    z-index: 1100;
+  }
+
+  .ant-slider-track,
+  .ant-tabs-ink-bar,
+  .ant-switch-checked {
+    background: ${token.colorPrimary} !important;
+  }
+
+  .ant-btn-primary:not(.ant-btn-dangerous) {
+    color: ${readableColor(token.colorPrimary)};
+    background: ${token.colorPrimary};
+
+    &:hover {
+      color: ${readableColor(token.colorPrimary)} !important;
+      background: ${token.colorPrimaryHover} !important;
+    }
+
+    &:active {
+      color: ${readableColor(token.colorPrimaryActive)} !important;
+      background: ${token.colorPrimaryActive} !important;
+    }
+  }
+`;

package/src/styles/global.ts

@@ -0,0 +1,23 @@
+import { css } from 'antd-style';
+
+export default () => css`
+  body,
+  .ant-app {
+    ::-webkit-scrollbar {
+      width: 0;
+      height: 0;
+    }
+  }
+
+  #__next {
+    height: 100%;
+  }
+
+  p {
+    margin-bottom: 0;
+  }
+
+  li {
+    display: block;
+  }
+`;

package/src/styles/index.ts

@@ -0,0 +1,6 @@
+import { createGlobalStyle } from 'antd-style';
+
+import antdOverride from './antdOverride';
+import global from './global';
+
+export const GlobalStyle = createGlobalStyle(({ theme }) => [global(), antdOverride(theme)]);

package/src/types/chatMessage.ts

@@ -0,0 +1,46 @@
+import { LLMRoleType } from './llm';
+import { BaseDataModel } from './meta';
+
+/**
+ * 聊天消息错误对象
+ */
+export interface ChatMessageError {
+  /**
+   * 错误信息
+   */
+  message: string;
+  status: number;
+  type: 'general' | 'llm';
+}
+
+export interface ChatMessage extends BaseDataModel {
+  archive?: boolean;
+
+  /**
+   * @title 内容
+   * @description 消息内容
+   */
+  content: string;
+  error?: any;
+
+  // 扩展字段
+  extra?: {
+    // 翻译
+    translate: {
+      target: string;
+      to: string;
+    };
+    // 语音
+  } & Record<string, any>;
+
+  parentId?: string;
+  // 引用
+  quotaId?: string;
+  /**
+   * 角色
+   * @description 消息发送者的角色
+   */
+  role: LLMRoleType;
+}
+
+export type ChatMessageMap = Record<string, ChatMessage>;

package/src/types/exportConfig.ts

@@ -0,0 +1,44 @@
+import type { NeutralColors, PrimaryColors } from '@lobehub/ui';
+import { ThemeMode } from 'antd-style';
+
+import { Locales } from './locale';
+
+/**
+ * 配置设置
+ */
+export interface ConfigSettings {
+  accessCode: string;
+  avatar: string;
+  compressThreshold: number;
+  enableCompressThreshold: boolean;
+  enableHistoryCount: boolean;
+  enableMaxTokens: boolean;
+  endpoint: string;
+  fontSize: number;
+  frequencyPenalty: number;
+  historyCount: number;
+  language: Locales;
+  maxTokens: number;
+  model: string;
+  neutralColor: NeutralColors | '';
+  presencePenalty: number;
+  primaryColor: PrimaryColors | '';
+  temperature: number;
+  themeMode: ThemeMode;
+  token: string;
+  topP: number;
+}
+
+export type ConfigKeys = keyof ConfigSettings;
+
+export interface ConfigState {
+  settings: ConfigSettings;
+}
+
+export interface ConfigFile {
+  state: ConfigState;
+  /**
+   * 配置文件的版本号
+   */
+  version: number;
+}

package/src/types/global.d.ts

@@ -0,0 +1,14 @@
+import type { LobeCustomStylish, LobeCustomToken } from '@lobehub/ui';
+import 'antd-style';
+import { AntdToken } from 'antd-style/lib/types/theme';
+
+declare module 'antd-style' {
+  // eslint-disable-next-line @typescript-eslint/no-empty-interface
+  export interface CustomToken extends LobeCustomToken {}
+  // eslint-disable-next-line @typescript-eslint/no-empty-interface
+  export interface CustomStylish extends LobeCustomStylish {}
+}
+
+declare module 'styled-components' {
+  export interface DefaultTheme extends AntdToken, LobeCustomToken {}
+}

package/src/types/i18next.d.ts

@@ -0,0 +1,8 @@
+import { DefaultResources } from '@/types/locale';
+
+declare module 'i18next' {
+  interface CustomTypeOptions {
+    defaultNS: ['common', 'setting'];
+    resources: DefaultResources;
+  }
+}

package/src/types/langchain.ts

@@ -0,0 +1,34 @@
+import { ChatMessage } from '@lobehub/ui';
+
+export interface LangChainParams {
+  llm: {
+    /**
+     *  控制生成文本中的惩罚系数，用于减少重复性
+     */
+    frequency_penalty?: number;
+    /**
+     *  生成文本的最大长度
+     */
+    max_tokens?: number;
+    model: string;
+    /**
+     *  控制生成文本中的惩罚系数，用于减少主题的变化
+     */
+    presence_penalty?: number;
+    /**
+     *  生成文本的随机度量，用于控制文本的创造性和多样性
+     * @default 0.6
+     */
+    temperature: number;
+    /**
+     *  控制生成文本中最高概率的单个令牌
+     */
+    top_p?: number;
+  };
+
+  /**
+   *  聊天信息列表
+   */
+  prompts: ChatMessage[];
+  vars: Record<string, string>;
+}

package/src/types/llm.ts

@@ -0,0 +1,49 @@
+/**
+ * LLM 模型
+ */
+export enum LanguageModel {
+  /**
+   * GPT 3.5 Turbo
+   */
+  GPT3_5 = 'gpt-3.5-turbo',
+  GPT3_5_16K = 'gpt-3.5-turbo-16k',
+  /**
+   * GPT 4
+   */
+  GPT4 = 'gpt-4',
+  GPT4_32K = 'gpt-4-32k',
+}
+
+// 语言模型的设置参数
+export interface LLMParams {
+  /**
+   * 控制生成文本中的惩罚系数，用于减少重复性
+   */
+  frequency_penalty?: number;
+  /**
+   * 生成文本的最大长度
+   */
+  max_tokens?: number;
+  /**
+   * 控制生成文本中的惩罚系数，用于减少主题的变化
+   */
+  presence_penalty?: number;
+  /**
+   * 生成文本的随机度量，用于控制文本的创造性和多样性
+   * @default 0.6
+   */
+  temperature?: number;
+  /**
+   * 控制生成文本中最高概率的单个 token
+   */
+  top_p?: number;
+}
+
+export type LLMRoleType = 'user' | 'system' | 'assistant';
+
+export interface LLMMessage {
+  content: string;
+  role: LLMRoleType;
+}
+
+export type LLMExample = LLMMessage[];

package/src/types/locale.ts

@@ -0,0 +1 @@
+export type * from '@/locales/resources';

package/src/types/meta.ts

@@ -0,0 +1,26 @@
+export interface MetaData {
+  /**
+   * 角色头像
+   * @description 可选参数，如果不传则使用默认头像
+   */
+  avatar?: string;
+  /**
+   *  背景色
+   * @description 可选参数，如果不传则使用默认背景色
+   */
+  backgroundColor?: string;
+  description?: string;
+  tag?: string[];
+  /**
+   * 名称
+   * @description 可选参数，如果不传则使用默认名称
+   */
+  title?: string;
+}
+
+export interface BaseDataModel {
+  createAt: number;
+  id: string;
+  meta: MetaData;
+  updateAt: number;
+}

package/src/types/openai.ts

@@ -0,0 +1,62 @@
+import { LLMRoleType } from '@/types/llm';
+
+export interface OpenAIChatMessage {
+  /**
+   * @title 内容
+   * @description 消息内容
+   */
+  content: string;
+
+  /**
+   * 角色
+   * @description 消息发送者的角色
+   */
+  role: LLMRoleType;
+}
+
+/**
+ * @title OpenAI Stream Payload
+ */
+export interface OpenAIStreamPayload {
+  /**
+   * @title 控制生成文本中的惩罚系数，用于减少重复性
+   * @default 0
+   */
+  frequency_penalty?: number;
+  /**
+   * @title 生成文本的最大长度
+   */
+  max_tokens?: number;
+  /**
+   * @title 聊天信息列表
+   */
+  messages: OpenAIChatMessage[];
+  /**
+   * @title 模型名称
+   */
+  model: string;
+  /**
+   * @title 返回的文本数量
+   */
+  n?: number;
+  /**
+   * @title 控制生成文本中的惩罚系数，用于减少主题的变化
+   * @default 0
+   */
+  presence_penalty?: number;
+  /**
+   * @title 是否开启流式请求
+   * @default true
+   */
+  stream?: boolean;
+  /**
+   * @title 生成文本的随机度量，用于控制文本的创造性和多样性
+   * @default 0.5
+   */
+  temperature: number;
+  /**
+   * @title 控制生成文本中最高概率的单个令牌
+   * @default 1
+   */
+  top_p?: number;
+}

package/src/types/session.ts

@@ -0,0 +1,59 @@
+import { ChatMessageMap } from './chatMessage';
+import { LLMExample, LLMParams, LanguageModel } from './llm';
+import { BaseDataModel } from './meta';
+
+export enum LobeSessionType {
+  /**
+   * 角色
+   */
+  Agent = 'agent',
+  /**
+   * 群聊
+   */
+  Group = 'group',
+}
+
+interface LobeSessionBase extends BaseDataModel {
+  /**
+   * 聊天记录
+   */
+  chats: ChatMessageMap;
+
+  /**
+   * 每个会话的类别
+   */
+  type: LobeSessionType;
+}
+
+export interface LobeAgentConfig {
+  /**
+   * 语言模型示例
+   */
+  example?: LLMExample;
+  /**
+   * 角色所使用的语言模型
+   * @default gpt-3.5-turbo
+   */
+  model: LanguageModel;
+  /**
+   * 语言模型参数
+   */
+  params: LLMParams;
+  /**
+   * 系统角色
+   */
+  systemRole: string;
+}
+
+/**
+ * Lobe Agent会话
+ */
+export interface LobeAgentSession extends LobeSessionBase {
+  /**
+   * 语言模型角色设定
+   */
+  config: LobeAgentConfig;
+  type: LobeSessionType.Agent;
+}
+
+export type LobeSessions = Record<string, LobeAgentSession>;

package/src/utils/VersionController.test.ts

@@ -0,0 +1,90 @@
+import { Migration, MigrationData, VersionController } from './VersionController';
+
+class TestMigration0 implements Migration {
+  version = 0;
+
+  migrate(data: MigrationData): MigrationData {
+    return data;
+  }
+}
+class TestMigration1 implements Migration {
+  version = 1;
+
+  migrate(data: MigrationData): MigrationData {
+    return {
+      state: {
+        ...data.state,
+        value1: data.state.value * 2,
+      },
+      version: this.version,
+    };
+  }
+}
+
+class TestMigration2 implements Migration {
+  version = 2;
+
+  migrate(data: MigrationData): MigrationData {
+    return {
+      state: {
+        ...data.state,
+        value2: data.state.value1 * 2,
+      },
+      version: this.version,
+    };
+  }
+}
+
+describe('VersionController', () => {
+  let migrations;
+  let versionController: VersionController<any>;
+
+  beforeEach(() => {
+    migrations = [TestMigration0, TestMigration1, TestMigration2];
+    versionController = new VersionController(migrations);
+  });
+
+  it('should instantiate with sorted migrations', () => {
+    expect(versionController['migrations'][0].version).toBe(0);
+    expect(versionController['migrations'][1].version).toBe(1);
+    expect(versionController['migrations'][2].version).toBe(2);
+  });
+
+  it('should throw error if data version is undefined', () => {
+    const data = {
+      state: { value: 10 },
+    };
+
+    expect(() => versionController.migrate(data as any)).toThrow(
+      '导入数据缺少版本号，请检查文件后重试',
+    );
+  });
+
+  it('should migrate data correctly through multiple versions', () => {
+    const data: MigrationData = {
+      state: { value: 10 },
+      version: 0,
+    };
+
+    const migratedData = versionController.migrate(data);
+
+    expect(migratedData).toEqual({
+      state: { value: 10, value1: 20, value2: 40 },
+      version: 3,
+    });
+  });
+
+  it('should migrate data correctly if starting from a specific version', () => {
+    const data: MigrationData = {
+      state: { value: 10, value1: 20 },
+      version: 1,
+    };
+
+    const migratedData = versionController.migrate(data);
+
+    expect(migratedData).toEqual({
+      state: { value: 10, value1: 20, value2: 40 },
+      version: 3,
+    });
+  });
+});