@lobehub/chat 0.86.0-beta.1 → 0.86.0-beta.2

package/.github/workflows/sync.yml

@@ -47,6 +47,8 @@ jobs:
 
             由于 [LobeChat][lobechat] 上游仓库的 workflow 文件变更，导致 GitHub 自动暂停了本次自动更新，你需要手动 Sync Fork 一次，请查看 [详细教程][tutorial-zh-CN]
 
+            ![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/273954625-df80c890-0822-4ac2-95e6-c990785cbed5.png)
+
             [lobechat]: https://github.com/lobehub/lobe-chat
             [tutorial-zh-CN]: https://github.com/lobehub/lobe-chat/wiki/Upstream-Sync.zh-CN
             [tutorial-en-US]: https://github.com/lobehub/lobe-chat/wiki/Upstream-Sync

package/CHANGELOG.md

@@ -2,30 +2,73 @@
 
 # Changelog
 
-## [Version 0.86.0-beta.1](https://github.com/lobehub/lobe-chat/compare/v0.85.0...v0.86.0-beta.1)
+## [Version 0.86.0-beta.2](https://github.com/lobehub/lobe-chat/compare/v0.86.0-beta.1...v0.86.0-beta.2)
 
 <sup>Released on **2023-10-10**</sup>
 
-#### ✨ Features
+#### 🐛 Bug Fixes
+
+- **misc**: Add apikey form when there is no default api key in env, Fix mobile safearea (fix.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### What's fixed
+
+- **misc**: Add apikey form when there is no default api key in env, closes [#290](https://github.com/lobehub/lobe-chat/issues/290) ([2c907e9](https://github.com/lobehub/lobe-chat/commit/2c907e9))
+- **misc**: Fix mobile safearea (fix, closes [#211](https://github.com/lobehub/lobe-chat/issues/211) ([68775b8](https://github.com/lobehub/lobe-chat/commit/68775b8))
 
-- **misc**: Dockerize lobe-chat.
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
+### [Version 0.85.2](https://github.com/lobehub/lobe-chat/compare/v0.85.1...v0.85.2)
+
+<sup>Released on **2023-10-10**</sup>
 
 #### 🐛 Bug Fixes
 
-- **misc**: Use bun to improve speed.
+- **misc**: Add apikey form when there is no default api key in env.
 
 <br/>
 
 <details>
 <summary><kbd>Improvements and Fixes</kbd></summary>
 
-#### What's improved
+#### What's fixed
+
+- **misc**: Add apikey form when there is no default api key in env, closes [#290](https://github.com/lobehub/lobe-chat/issues/290) ([2c907e9](https://github.com/lobehub/lobe-chat/commit/2c907e9))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
 
-- **misc**: Dockerize lobe-chat ([1b750f8](https://github.com/lobehub/lobe-chat/commit/1b750f8))
+### [Version 0.85.1](https://github.com/lobehub/lobe-chat/compare/v0.85.0...v0.85.1)
+
+<sup>Released on **2023-10-10**</sup>
+
+#### 🐛 Bug Fixes
+
+- **misc**: Fix mobile safearea (fix.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
 
 #### What's fixed
 
-- **misc**: Use bun to improve speed ([8db2a3c](https://github.com/lobehub/lobe-chat/commit/8db2a3c))
+- **misc**: Fix mobile safearea (fix, closes [#211](https://github.com/lobehub/lobe-chat/issues/211) ([68775b8](https://github.com/lobehub/lobe-chat/commit/68775b8))
 
 </details>
 

package/locales/en_US/error.json

@@ -25,12 +25,13 @@
     "PluginApiNotFound": "Sorry, the API does not exist in the plugin's manifest. Please check if your request method matches the plugin manifest API",
     "PluginApiParamsError": "Sorry, the input parameter validation for the plugin request failed. Please check if the input parameters match the API description",
     "PluginSettingsInvalid": "This plugin needs to be correctly configured before it can be used. Please check if your configuration is correct",
-    "PluginServerError": "Plugin server request returned an error. Please check your plugin manifest file, plugin configuration, or server implementation based on the error information below"
+    "PluginServerError": "Plugin server request returned an error. Please check your plugin manifest file, plugin configuration, or server implementation based on the error information below",
+    "NoAPIKey": "OpenAI API Key is empty, please add a custom OpenAI API Key"
   },
   "unlock": {
     "apikey": {
-      "description": "Enter your OpenAI API Key to bypass password verification. The application will not record your API Key.",
-      "title": "Use Custom API Key"
+      "title": "Use Custom API Key",
+      "description": "Enter your OpenAI API Key to start the conversation. The application will not record your API Key."
     },
     "confirm": "Confirm and Retry",
     "password": {

package/locales/ja_JP/error.json

@@ -25,12 +25,13 @@
     "PluginMarketIndexInvalid": "申し訳ありませんが、プラグインのインデックスの検証に失敗しました。インデックスファイルの形式が正しいかどうかを確認してください",
     "PluginManifestNotFound": "申し訳ありませんが、サーバーでプラグインのマニフェストファイル (manifest.json) が見つかりませんでした。プラグインのマニフェストファイルのアドレスが正しいかどうかを確認してください",
     "PluginManifestInvalid": "申し訳ありませんが、このプラグインのマニフェストの検証に失敗しました。マニフェストの形式が正しいかどうかを確認してください",
-    "PluginApiNotFound": "申し訳ありませんが、プラグインのマニフェストに指定されたAPIが見つかりませんでした。リクエストメソッドとプラグインのマニフェストのAPIが一致しているかどうかを確認してください"
+    "PluginApiNotFound": "申し訳ありませんが、プラグインのマニフェストに指定されたAPIが見つかりませんでした。リクエストメソッドとプラグインのマニフェストのAPIが一致しているかどうかを確認してください",
+    "NoAPIKey": "OpenAI APIキーが空です。カスタムOpenAI APIキーを追加してください。"
   },
   "unlock": {
     "apikey": {
-      "description": "OpenAI APIキーを入力すると、パスワード認証をバイパスできます。アプリはAPIキーを記録しません",
-      "title": "カスタムAPIキーの使用"
+      "title": "カスタムAPIキーの使用",
+      "description": "OpenAI APIキーを入力すると、会話を開始できます。アプリはあなたのAPIキーを記録しません。"
     },
     "closeMessage": "ヒントを閉じる",
     "confirm": "確認して再試行",

package/locales/ko_KR/error.json

@@ -25,12 +25,13 @@
     "PluginSettingsInvalid": "플러그인을 사용하려면 올바른 구성이 필요합니다. 구성이 올바른지 확인해주세요.",
     "PluginServerError": "플러그인 서버 요청이 오류로 반환되었습니다. 플러그인 설명 파일, 플러그인 구성 또는 서버 구현을 확인해주세요.",
     "InvalidAccessCode": "암호가 올바르지 않거나 비어 있습니다. 올바른 액세스 암호를 입력하거나 사용자 지정 OpenAI API 키를 추가해주세요.",
-    "OpenAIBizError": "OpenAI 서비스 요청 중 오류가 발생했습니다. 아래 정보를 확인하고 문제를 해결하거나 다시 시도해주세요."
+    "OpenAIBizError": "OpenAI 서비스 요청 중 오류가 발생했습니다. 아래 정보를 확인하고 문제를 해결하거나 다시 시도해주세요.",
+    "NoAPIKey": "OpenAI API 키가 비어 있습니다. 사용자 정의 OpenAI API 키를 추가해주세요."
   },
   "unlock": {
     "apikey": {
-      "description": "OpenAI API 키를 입력하여 암호 확인을 우회할 수 있습니다. 애플리케이션은 API 키를 기록하지 않습니다.",
-      "title": "사용자 정의 API 키 사용"
+      "title": "사용자 정의 API 키 사용",
+      "description": "OpenAI API 키를 입력하면 대화를 시작할 수 있습니다. 애플리케이션은 API 키를 기록하지 않습니다."
     },
     "closeMessage": "알림 닫기",
     "confirm": "확인 및 다시 시도",

package/locales/ru_RU/error.json

@@ -25,12 +25,13 @@
     "PluginApiNotFound": "К сожалению, API не существует в манифесте плагина. Пожалуйста, проверьте, соответствует ли ваш метод запроса API манифеста плагина",
     "PluginApiParamsError": "К сожалению, проверка входных параметров для запроса плагина не удалась. Пожалуйста, проверьте, соответствуют ли входные параметры описанию API",
     "PluginSettingsInvalid": "Этот плагин необходимо правильно настроить, прежде чем его можно будет использовать. Пожалуйста, проверьте правильность вашей конфигурации",
-    "PluginServerError": "Запрос сервера плагина возвратил ошибку. Проверьте файл манифеста плагина, конфигурацию плагина или реализацию сервера на основе информации об ошибке ниже"
+    "PluginServerError": "Запрос сервера плагина возвратил ошибку. Проверьте файл манифеста плагина, конфигурацию плагина или реализацию сервера на основе информации об ошибке ниже",
+    "NoAPIKey": "Ключ OpenAI API пуст, пожалуйста, добавьте свой собственный ключ OpenAI API"
   },
   "unlock": {
     "apikey": {
-      "description": "Введите свой ключ API OpenAI, чтобы обойти проверку пароля. Приложение не будет записывать ваш ключ API.",
-      "title": "Использовать собственный ключ API"
+      "title": "Использовать собственный ключ API",
+      "description": "Введите свой ключ API OpenAI, чтобы начать сеанс. Приложение не будет сохранять ваш ключ API."
     },
     "confirm": "Подтвердить и повторить попытку",
     "password": {

package/locales/zh_CN/error.json

@@ -25,11 +25,12 @@
     "PluginSettingsInvalid": "该插件需要正确配置后才可以使用，请检查你的配置是否正确",
     "PluginServerError": "插件服务端请求返回出错，请检查根据下面的报错信息检查你的插件描述文件、插件配置或服务端实现",
     "InvalidAccessCode": "密码不正确或为空，请输入正确的访问密码，或者添加自定义 OpenAI API Key",
-    "OpenAIBizError": "请求 OpenAI 服务出错，请根据以下信息排查或重试"
+    "OpenAIBizError": "请求 OpenAI 服务出错，请根据以下信息排查或重试",
+    "NoAPIKey": "OpenAI API Key 为空，请添加自定义 OpenAI API Key"
   },
   "unlock": {
     "apikey": {
-      "description": "输入你的 OpenAI API Key 即可绕过密码验证。应用不会记录你的 API Key",
+      "description": "输入你的 OpenAI API Key 即可开始会话。应用不会记录你的 API Key",
       "title": "使用自定义 API Key"
     },
     "closeMessage": "关闭提示",

package/locales/zh_TW/error.json

@@ -25,12 +25,13 @@
     "PluginApiNotFound": "抱歉，外掛描述檔案中不存在該 API。請檢查您的請求方法與外掛清單 API 是否相符",
     "PluginApiParamsError": "抱歉，該外掛請求的輸入參數驗證失敗。請檢查輸入參數與 API 描述資訊是否相符",
     "PluginSettingsInvalid": "該外掛需要正確設定後才可以使用。請檢查您的設定是否正確",
-    "PluginServerError": "外掛伺服器請求回傳錯誤。請根據下面的錯誤資訊檢查您的外掛描述檔案、外掛設定或伺服器實作"
+    "PluginServerError": "外掛伺服器請求回傳錯誤。請根據下面的錯誤資訊檢查您的外掛描述檔案、外掛設定或伺服器實作",
+    "NoAPIKey": "OpenAI API 金鑰為空，請添加自訂 OpenAI API 金鑰"
   },
   "unlock": {
     "apikey": {
-      "description": "輸入您的 OpenAI API Key 以繞過密碼驗證。應用程式不會記錄您的 API Key。",
-      "title": "使用自定義 API Key"
+      "title": "使用自定義 API Key",
+      "description": "輸入你的 OpenAI API Key 即可開始會話。應用程式不會記錄你的 API Key"
     },
     "confirm": "確認並重試",
     "password": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "0.86.0-beta.1",
+  "version": "0.86.0-beta.2",
   "description": "An open-source, extensible (Function Calling), high-performance chatbot framework. It supports one-click free deployment of your private ChatGPT/LLM web application",
   "keywords": [
     "chatbot",

package/src/app/api/auth.ts

@@ -9,12 +9,12 @@ interface AuthConfig {
 export const checkAuth = ({ apiKey, accessCode }: AuthConfig) => {
   const { ACCESS_CODE } = getServerConfig();
 
-  // 如果存在 apiKey
+  // if apiKey exist
   if (apiKey) {
     return { auth: true };
   }
 
-  // 如果不存在，则检查 accessCode
+  // if accessCode doesn't exist
   if (!ACCESS_CODE) return { auth: true };
 
   if (accessCode !== ACCESS_CODE) {

package/src/app/api/openai/chat/route.ts

@@ -2,7 +2,7 @@ import OpenAI from 'openai';
 
 import { getServerConfig } from '@/config/server';
 import { getOpenAIAuthFromRequest } from '@/const/fetch';
-import { ErrorType } from '@/types/fetch';
+import { ChatErrorType, ErrorType } from '@/types/fetch';
 import { OpenAIStreamPayload } from '@/types/openai';
 
 import { checkAuth } from '../../auth';
@@ -29,10 +29,24 @@ export const POST = async (req: Request) => {
   const { USE_AZURE_OPENAI } = getServerConfig();
   const useAzureOpenAI = useAzure || USE_AZURE_OPENAI;
 
-  if (useAzureOpenAI) {
-    openai = createAzureOpenai({ apiVersion, endpoint, model: payload.model, userApiKey: apiKey });
-  } else {
-    openai = createOpenai(apiKey, endpoint);
+  try {
+    if (useAzureOpenAI) {
+      openai = createAzureOpenai({
+        apiVersion,
+        endpoint,
+        model: payload.model,
+        userApiKey: apiKey,
+      });
+    } else {
+      openai = createOpenai(apiKey, endpoint);
+    }
+  } catch (error) {
+    if ((error as Error).cause === ChatErrorType.NoAPIKey) {
+      return createErrorResponse(ChatErrorType.NoAPIKey);
+    }
+
+    console.error(error); // log error to trace it
+    return createErrorResponse(ChatErrorType.InternalServerError);
   }
 
   return createChatCompletion({ openai, payload });

package/src/app/api/openai/createAzureOpenai.ts

@@ -2,6 +2,7 @@ import OpenAI, { ClientOptions } from 'openai';
 import urlJoin from 'url-join';
 
 import { getServerConfig } from '@/config/server';
+import { ChatErrorType } from '@/types/fetch';
 
 // 创建 Azure OpenAI 实例
 export const createAzureOpenai = (params: {
@@ -17,7 +18,9 @@ export const createAzureOpenai = (params: {
 
   const defaultApiVersion = AZURE_API_VERSION || '2023-08-01-preview';
   const apiVersion = !params.apiVersion ? defaultApiVersion : params.apiVersion;
-  const apiKey = !params.userApiKey ? AZURE_API_KEY ?? '' : params.userApiKey;
+  const apiKey = !params.userApiKey ? AZURE_API_KEY : params.userApiKey;
+
+  if (!apiKey) throw new Error('AZURE_API_KEY is empty', { cause: ChatErrorType.NoAPIKey });
 
   const config: ClientOptions = {
     apiKey,

package/src/app/api/openai/createOpenai.ts

@@ -1,6 +1,7 @@
-import OpenAI, { ClientOptions } from 'openai';
+import OpenAI from 'openai';
 
 import { getServerConfig } from '@/config/server';
+import { ChatErrorType } from '@/types/fetch';
 
 // 创建 OpenAI 实例
 export const createOpenai = (userApiKey: string | null, endpoint?: string | null) => {
@@ -8,10 +9,9 @@ export const createOpenai = (userApiKey: string | null, endpoint?: string | null
 
   const baseURL = endpoint ? endpoint : OPENAI_PROXY_URL ? OPENAI_PROXY_URL : undefined;
 
-  const config: ClientOptions = {
-    apiKey: !userApiKey ? OPENAI_API_KEY : userApiKey,
-    baseURL,
-  };
+  const apiKey = !userApiKey ? OPENAI_API_KEY : userApiKey;
 
-  return new OpenAI(config);
+  if (!apiKey) throw new Error('OPENAI_API_KEY is empty', { cause: ChatErrorType.NoAPIKey });
+
+  return new OpenAI({ apiKey, baseURL });
 };

package/src/app/api/openai/errorResponse.ts

@@ -2,6 +2,7 @@ import { ChatErrorType, ErrorResponse, ErrorType } from '@/types/fetch';
 
 const getStatus = (errorType: ErrorType) => {
   switch (errorType) {
+    case ChatErrorType.NoAPIKey:
     case ChatErrorType.InvalidAccessCode: {
       return 401;
     }

package/src/app/chat/features/Conversation/ChatList/Error/OpenAPIKey.tsx

@@ -0,0 +1,12 @@
+import { memo } from 'react';
+
+import APIKeyForm from './ApiKeyForm';
+import { ErrorActionContainer } from './style';
+
+const OpenAPIKey = memo<{ id: string }>(({ id }) => (
+  <ErrorActionContainer>
+    <APIKeyForm id={id} />
+  </ErrorActionContainer>
+));
+
+export default OpenAPIKey;

package/src/app/chat/features/Conversation/ChatList/Error/OpenAiBizError.tsx

@@ -2,8 +2,8 @@ import { Highlighter } from '@lobehub/ui';
 import { memo } from 'react';
 import { Flexbox } from 'react-layout-kit';
 
-import APIKeyForm from './ApiKeyForm';
-import { ErrorActionContainer, useStyles } from './style';
+import OpenAPIKey from './OpenAPIKey';
+import { useStyles } from './style';
 
 interface OpenAIError {
   code: 'invalid_api_key' | string;
@@ -21,13 +21,8 @@ const OpenAiBizError = memo<{ content: OpenAIErrorResponse; id: string }>(({ con
 
   const errorCode = content.error?.code;
 
-  if (errorCode === 'invalid_api_key') {
-    return (
-      <ErrorActionContainer>
-        <APIKeyForm id={id} />
-      </ErrorActionContainer>
-    );
-  }
+  if (errorCode === 'invalid_api_key') return <OpenAPIKey id={id} />;
+
   return (
     <Flexbox className={styles.container} style={{ maxWidth: 600 }}>
       <Highlighter language={'json'}>{JSON.stringify(content, null, 2)}</Highlighter>

package/src/app/chat/features/Conversation/ChatList/Error/index.tsx

@@ -5,6 +5,7 @@ import { ChatMessage } from '@/types/chatMessage';
 import { ChatErrorType, ErrorType } from '@/types/fetch';
 
 import InvalidAccess from './InvalidAccess';
+import OpenAPIKey from './OpenAPIKey';
 import OpenAiBizError from './OpenAiBizError';
 import PluginError from './Plugin/PluginError';
 import PluginSettings from './Plugin/PluginSettings';
@@ -36,6 +37,10 @@ export const renderErrorMessage: RenderErrorMessage = (error, message: ChatMessa
       return <InvalidAccess id={message.id} />;
     }
 
+    case ChatErrorType.NoAPIKey: {
+      return <OpenAPIKey id={message.id} />;
+    }
+
     case ChatErrorType.OpenAIBizError: {
       return <OpenAiBizError content={(error as any).body} id={message.id} />;
     }

package/src/app/welcome/features/Banner/index.tsx

@@ -4,12 +4,10 @@ import { Icon } from '@lobehub/ui';
 import { useSize } from 'ahooks';
 import { Button, Upload } from 'antd';
 import { SendHorizonal } from 'lucide-react';
-import Link from 'next/link';
 import { memo, useCallback, useRef } from 'react';
 import { useTranslation } from 'react-i18next';
 import { Flexbox } from 'react-layout-kit';
 
-import { SESSION_CHAT_URL } from '@/const/url';
 import { useImportConfig } from '@/hooks/useImportConfig';
 import { useSessionStore } from '@/store/session';
 
@@ -23,8 +21,12 @@ const Banner = memo<{ mobile?: boolean }>(({ mobile }) => {
   const width = domSize?.width || 1024;
   const { t } = useTranslation('welcome');
   const { styles } = useStyles();
-
-  const switchSession = useSessionStore((s) => s.switchSession);
+  const [switchSession, switchBackToChat, router, isMobile] = useSessionStore((s) => [
+    s.switchSession,
+    s.switchBackToChat,
+    s.router,
+    s.isMobile,
+  ]);
   const handleImport = useCallback((e: any) => {
     importConfig(e);
     switchSession();
@@ -47,20 +49,17 @@ const Banner = memo<{ mobile?: boolean }>(({ mobile }) => {
             {t('button.import')}
           </Button>
         </Upload>
-        <Link
-          href={SESSION_CHAT_URL()}
-          onClick={(e) => {
-            e.preventDefault();
-            switchSession();
-          }}
+        <Button
+          block={mobile}
+          onClick={() => (isMobile ? router?.push('/chat') : switchBackToChat())}
+          size={'large'}
+          type={'primary'}
         >
-          <Button block={mobile} size={'large'} type={'primary'}>
-            <Flexbox align={'center'} gap={4} horizontal justify={'center'}>
-              {t('button.start')}
-              <Icon icon={SendHorizonal} />
-            </Flexbox>
-          </Button>
-        </Link>
+          <Flexbox align={'center'} gap={4} horizontal justify={'center'}>
+            {t('button.start')}
+            <Icon icon={SendHorizonal} />
+          </Flexbox>
+        </Button>
       </Flexbox>
     </>
   );

package/src/const/layoutTokens.ts

@@ -2,7 +2,7 @@ import type { FormProps } from '@lobehub/ui';
 
 export const HEADER_HEIGHT = 64;
 export const MOBILE_NABBAR_HEIGHT = 44;
-export const MOBILE_TABBAR_HEIGHT = 48;
+export const MOBILE_TABBAR_HEIGHT = 60;
 export const CHAT_TEXTAREA_HEIGHT = 200;
 export const CHAT_TEXTAREA_HEIGHT_MOBILE = 120;
 export const CHAT_SIDEBAR_WIDTH = 280;

package/src/layout/AppLayout.mobile.tsx

@@ -62,6 +62,7 @@ const AppLayoutMobile = memo<AppMobileLayoutProps>(
             <MobileTabBar className={styles.mobileTabBar} />
           </>
         )}
+        <SafeSpacing mobile position={'bottom'} />
       </Flexbox>
     );
   },

package/src/locales/default/error.ts

@@ -32,11 +32,12 @@ export default {
 
     InvalidAccessCode: '密码不正确或为空，请输入正确的访问密码，或者添加自定义 OpenAI API Key',
     OpenAIBizError: '请求 OpenAI 服务出错，请根据以下信息排查或重试',
+    NoAPIKey: 'OpenAI API Key 为空，请添加自定义 OpenAI API Key',
     /* eslint-enable */
   },
   unlock: {
     apikey: {
-      description: '输入你的 OpenAI API Key 即可绕过密码验证。应用不会记录你的 API Key',
+      description: '输入你的 OpenAI API Key 即可开始会话。应用不会记录你的 API Key',
       title: '使用自定义 API Key',
     },
     closeMessage: '关闭提示',

package/src/types/fetch.ts

@@ -2,10 +2,9 @@
 export const ChatErrorType = {
   // ******* 业务错误语义 ******* //
 
-  // 密码无效
-  InvalidAccessCode: 'InvalidAccessCode',
-  // OpenAI 返回的业务错误
-  OpenAIBizError: 'OpenAIBizError',
+  InvalidAccessCode: 'InvalidAccessCode', // 密码无效
+  OpenAIBizError: 'OpenAIBizError', // OpenAI 返回的业务错误
+  NoAPIKey: 'NoAPIKey',
 
   // ******* 客户端错误 ******* //
   BadRequest: 400,