🔥 Refactor: 剥离插件服务端路由，为实现独立的插件调用做准备 (lobehub#82)

* 🔥 refactor: remove /api/plugins function

* ♻️ refactor: refactor the plugin implement to separate the server runner

next.config.mjs

@@ -3,6 +3,10 @@ import nextPWA from 'next-pwa';
 const isProd = process.env.NODE_ENV === 'production';
 const API_END_PORT_URL = process.env.API_END_PORT_URL || '';
 
+// chat plugin market
+const PLUGIN_RUNNER_BASE_URL =
+  process.env.PLUGIN_RUNNER_BASE_URL || 'https://lobe-chat-plugin-market.vercel.app';
+
 const withPWA = nextPWA({
   dest: 'public',
   register: true,
@@ -31,8 +35,9 @@ const nextConfig = {
         destination: `${API_END_PORT_URL}/api/openai`,
       },
       {
-        source: '/api/plugins-dev',
-        destination: `${API_END_PORT_URL}/api/plugins`,
+        source: '/api/plugins',
+        // refs to: https://github.com/lobehub/chat-plugin-market
+        destination: `${PLUGIN_RUNNER_BASE_URL}/api/v1/runner`,
       },
     ];
   },

package.json

@@ -63,7 +63,6 @@
   "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",
@@ -86,7 +85,6 @@
     "next": "13.4.7",
     "openai-edge": "^1",
     "polished": "^4",
-    "query-string": "^8",
     "react": "^18",
     "react-dom": "^18",
     "react-hotkeys-hook": "^4",

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,
 };
 

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

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,
 };
 

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;

src/services/url.ts

@@ -4,5 +4,5 @@ const prefix = isDev ? '-dev' : '';
 
 export const URLS = {
   openai: '/api/openai' + prefix,
-  plugins: '/api/plugins' + prefix,
+  plugins: '/api/plugins',
 };