@lobehub/chat 0.54.2 → 0.54.3

package/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 # Changelog
 
+### [Version 0.54.3](https://github.com/lobehub/lobe-chat/compare/v0.54.2...v0.54.3)
+
+<sup>Released on **2023-08-21**</sup>
+
+#### ♻ Code Refactoring
+
+- **misc**: Refactor plugin request.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### Code refactoring
+
+- **misc**: Refactor plugin request, closes [#89](https://github.com/lobehub/lobe-chat/issues/89) ([23efee3](https://github.com/lobehub/lobe-chat/commit/23efee3))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
 ### [Version 0.54.2](https://github.com/lobehub/lobe-chat/compare/v0.54.1...v0.54.2)
 
 <sup>Released on **2023-08-16**</sup>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "0.54.2",
+  "version": "0.54.3",
   "description": "Lobe Chat is an open-source chatbot client using LangChain, Typescript and Next.js",
   "keywords": [
     "chatbot",
@@ -63,10 +63,10 @@
   "dependencies": {
     "@ant-design/colors": "^7",
     "@ant-design/icons": "^5",
-    "@commitlint/cli": "^17",
     "@emoji-mart/data": "^1",
     "@emoji-mart/react": "^1",
     "@icons-pack/react-simple-icons": "^8",
+    "@lobehub/chat-plugin-sdk": "latest",
     "@lobehub/ui": "latest",
     "@vercel/analytics": "^1",
     "ahooks": "^3",
@@ -86,7 +86,6 @@
     "next": "13.4.7",
     "openai-edge": "^1",
     "polished": "^4",
-    "query-string": "^8",
     "react": "^18",
     "react-dom": "^18",
     "react-hotkeys-hook": "^4",

package/src/pages/api/plugins.api.ts

@@ -1,22 +1,10 @@
-import { OpenAIPluginPayload } from '@/types/plugin';
-
-import { PluginsMap } from '../../plugins';
-
 export const runtime = 'edge';
 
-export default async function handler(req: Request) {
-  const { name, arguments: args } = (await req.json()) as OpenAIPluginPayload;
-
-  console.log(`检测到 functionCall: ${name}`);
+// chat plugin gateway
+// refs to: https://github.com/lobehub/chat-plugins-gateway
+const PLUGIN_GATEWAY_URL = process.env.PLUGIN_GATEWAY_URL || 'https://chat-plugins.lobehub.com';
 
-  const func = PluginsMap[name];
-
-  if (func) {
-    const data = JSON.parse(args);
-    const result = await func.runner(data);
-
-    console.log(`[${name}]`, args, `result:`, JSON.stringify(result, null, 2).slice(0, 3600));
-
-    return new Response(JSON.stringify(result));
-  }
+export default async function handler(req: Request) {
+  const payload = await req.text();
+  return fetch(`${PLUGIN_GATEWAY_URL}/api/v1/runner`, { body: payload, method: 'POST' });
 }

package/src/plugins/searchEngine/index.ts

@@ -2,9 +2,6 @@ import { ChatCompletionFunctions } from 'openai-edge/types/api';
 
 import { PluginItem } from '@/plugins/type';
 
-import runner from './runner';
-import { Result } from './type';
-
 const schema: ChatCompletionFunctions = {
   description: '查询搜索引擎获取信息',
   name: 'searchEngine',
@@ -20,10 +17,9 @@ const schema: ChatCompletionFunctions = {
   },
 };
 
-const searchEngine: PluginItem<Result> = {
+const searchEngine: PluginItem = {
   avatar: '🔍',
   name: 'searchEngine',
-  runner,
   schema,
 };
 

package/src/plugins/type.ts

@@ -6,7 +6,7 @@ import { ReactNode } from 'react';
  * @template Result - 结果类型，默认为 any
  * @template RunnerParams - 运行参数类型，默认为 any
  */
-export interface PluginItem<Result = any, RunnerParams = any> {
+export interface PluginItem {
   /**
    * 头像
    */
@@ -15,12 +15,7 @@ export interface PluginItem<Result = any, RunnerParams = any> {
    * 名称
    */
   name: string;
-  /**
-   * 运行器
-   * @param params - 运行参数
-   * @returns 运行结果的 Promise
-   */
-  runner: PluginRunner<RunnerParams, Result>;
+  render?: PluginRender;
   /**
    * 聊天完成函数的模式
    */
@@ -34,15 +29,6 @@ export interface PluginItem<Result = any, RunnerParams = any> {
  */
 export type PluginRender = (props: PluginRenderProps) => ReactNode;
 
-/**
- * 插件运行器
- * @template Params - 参数类型，默认为 object
- * @template Result - 结果类型，默认为 any
- * @param params - 运行参数
- * @returns 运行结果的 Promise
- */
-export type PluginRunner<Params = object, Result = any> = (params: Params) => Promise<Result>;
-
 /**
  * 插件渲染属性
  * @template Result - 结果类型，默认为 any

package/src/plugins/weather/index.ts

@@ -1,7 +1,4 @@
 import { PluginItem } from '@/plugins/type';
-import { WeatherResult } from '@/plugins/weather/type';
-
-import runner from './runner';
 
 const schema = {
   description: '获取当前天气情况',
@@ -18,10 +15,9 @@ const schema = {
   },
 };
 
-const getWeather: PluginItem<WeatherResult> = {
+const getWeather: PluginItem = {
   avatar: '☂️',
   name: 'realtimeWeather',
-  runner,
   schema,
 };
 

package/src/plugins/webCrawler/index.ts

@@ -1,8 +1,5 @@
 import { PluginItem } from '@/plugins/type';
 
-import runner from './runner';
-import { Result } from './type';
-
 const schema = {
   description: '提取网页内容并总结',
   name: 'websiteCrawler',
@@ -18,6 +15,6 @@ const schema = {
   },
 };
 
-const getWeather: PluginItem<Result> = { avatar: '🕸', name: 'websiteCrawler', runner, schema };
+const getWeather: PluginItem = { avatar: '🕸', name: 'websiteCrawler', schema };
 
 export default getWeather;

package/src/services/plugin.ts

@@ -1,6 +1,7 @@
+import { PluginRequestPayload } from '@lobehub/chat-plugin-sdk';
+
 import { LOBE_CHAT_ACCESS_CODE } from '@/const/fetch';
 import { useGlobalStore } from '@/store/global';
-import { OpenAIPluginPayload } from '@/types/plugin';
 
 import { URLS } from './url';
 
@@ -13,7 +14,7 @@ interface FetchChatModelOptions {
  * 专门用于对话的 fetch
  */
 export const fetchPlugin = async (
-  params: Partial<OpenAIPluginPayload>,
+  params: PluginRequestPayload,
   options?: FetchChatModelOptions,
 ) => {
   const res = await fetch(URLS.plugins, {

package/src/plugins/searchEngine/runner.ts

@@ -1,41 +0,0 @@
-import querystring from 'query-string';
-
-import { PluginRunner } from '@/plugins/type';
-
-import { OrganicResults, Result } from './type';
-
-const BASE_URL = 'https://serpapi.com/search';
-
-const API_KEY = process.env.SERPAI_API_KEY;
-
-const fetchResult: PluginRunner<{ keywords: string }, Result> = async ({ keywords }) => {
-  const params = {
-    api_key: API_KEY,
-    engine: 'google',
-    gl: 'cn',
-    google_domain: 'google.com',
-    hl: 'zh-cn',
-    location: 'China',
-    q: keywords,
-  };
-
-  const query = querystring.stringify(params);
-
-  const res = await fetch(`${BASE_URL}?${query}`);
-
-  const data = await res.json();
-
-  const results = data.organic_results as OrganicResults;
-
-  return results.map((r) => ({
-    content: r.snippet,
-    date: r.date,
-    displayed_link: r.displayed_link,
-    favicon: r.favicon,
-    link: r.link,
-    source: r.source,
-    title: r.title,
-  }));
-};
-
-export default fetchResult;

package/src/plugins/weather/runner.ts

@@ -1,35 +0,0 @@
-import { PluginRunner } from '@/plugins/type';
-
-import { Response, WeatherParams, WeatherResult } from './type';
-
-const weatherBaseURL = 'https://restapi.amap.com/v3/weather/weatherInfo';
-
-const citySearchURL = 'https://restapi.amap.com/v3/config/district';
-
-const KEY = process.env.GAODE_WEATHER_KEY;
-
-const fetchCityCode = async (keywords: string): Promise<string> => {
-  const URL = `${citySearchURL}?keywords=${keywords}&subdistrict=0&extensions=base&key=${KEY}`;
-  const res = await fetch(URL);
-
-  const data = await res.json();
-  console.log(data);
-
-  return data.districts[0].adcode;
-};
-
-const fetchWeather: PluginRunner<WeatherParams, WeatherResult> = async ({
-  city,
-  extensions = 'all',
-}) => {
-  const cityCode = await fetchCityCode(city);
-
-  const URL = `${weatherBaseURL}?city=${cityCode}&extensions=${extensions}&key=${KEY}`;
-  const res = await fetch(URL);
-
-  const data: Response = await res.json();
-
-  return data.forecasts;
-};
-
-export default fetchWeather;

package/src/plugins/webCrawler/runner.ts

@@ -1,46 +0,0 @@
-import { PluginRunner } from '@/plugins/type';
-
-import { ParserResponse, Result } from './type';
-
-const BASE_URL = process.env.BROWSERLESS_URL ?? 'https://chrome.browserless.io';
-const BROWSERLESS_TOKEN = process.env.BROWSERLESS_TOKEN;
-
-// service from: https://github.com/lobehub/html-parser/tree/master
-const HTML_PARSER_URL = process.env.HTML_PARSER_URL;
-
-const runner: PluginRunner<{ url: string }, Result> = async ({ url }) => {
-  const input = {
-    gotoOptions: { waitUntil: 'networkidle2' },
-    url,
-  };
-
-  try {
-    const res = await fetch(`${BASE_URL}/content?token=${BROWSERLESS_TOKEN}`, {
-      body: JSON.stringify(input),
-      headers: {
-        'Content-Type': 'application/json',
-      },
-      method: 'POST',
-    });
-    const html = await res.text();
-
-    const parserBody = { html, url };
-
-    const parseRes = await fetch(`${HTML_PARSER_URL}`, {
-      body: JSON.stringify(parserBody),
-      headers: {
-        'Content-Type': 'application/json',
-      },
-      method: 'POST',
-    });
-
-    const { title, textContent, siteName } = (await parseRes.json()) as ParserResponse;
-
-    return { content: textContent, title, url, website: siteName };
-  } catch (error) {
-    console.error(error);
-    return { content: '抓取失败', errorMessage: (error as any).message, url };
-  }
-};
-
-export default runner;