@lobehub/chat 0.114.9 → 0.115.0

package/src/store/tool/selectors/tool.ts

@@ -0,0 +1,125 @@
+import { LobeChatPluginManifest } from '@lobehub/chat-plugin-sdk';
+import { uniqBy } from 'lodash-es';
+import { Md5 } from 'ts-md5';
+
+import { PLUGIN_SCHEMA_API_MD5_PREFIX, PLUGIN_SCHEMA_SEPARATOR } from '@/const/plugin';
+import { MetaData } from '@/types/meta';
+import { ChatCompletionFunctions } from '@/types/openai/chat';
+import { LobeToolMeta } from '@/types/tool/tool';
+
+import { pluginHelpers } from '../helpers';
+import { ToolStoreState } from '../initialState';
+import { builtinToolSelectors } from '../slices/builtin/selectors';
+import { pluginSelectors } from '../slices/plugin/selectors';
+
+const getAPIName = (identifier: string, name: string, type?: string) => {
+  const pluginType = type && type !== 'default' ? `${PLUGIN_SCHEMA_SEPARATOR + type}` : '';
+
+  // 将插件的 identifier 作为前缀，避免重复
+  let apiName = identifier + PLUGIN_SCHEMA_SEPARATOR + name + pluginType;
+
+  // OpenAI GPT function_call name can't be longer than 64 characters
+  // So we need to use md5 to shorten the name
+  // and then find the correct apiName in response by md5
+  if (apiName.length >= 64) {
+    const md5Content = PLUGIN_SCHEMA_API_MD5_PREFIX + Md5.hashStr(name).toString();
+
+    apiName = identifier + PLUGIN_SCHEMA_SEPARATOR + md5Content + pluginType;
+  }
+
+  return apiName;
+};
+
+const enabledSchema =
+  (tools: string[] = []) =>
+  (s: ToolStoreState): ChatCompletionFunctions[] => {
+    const list = pluginSelectors
+      .installedPluginManifestList(s)
+      .concat(s.builtinTools.map((b) => b.manifest as LobeChatPluginManifest))
+      // 如果存在 enabledPlugins，那么只启用 enabledPlugins 中的插件
+      .filter((m) => tools.includes(m?.identifier))
+      .flatMap((manifest) =>
+        manifest.api.map((m) => ({
+          ...m,
+          name: getAPIName(manifest.identifier, m.name, manifest.type),
+        })),
+      );
+
+    return uniqBy(list, 'name');
+  };
+
+const enabledSystemRoles =
+  (tools: string[] = []) =>
+  (s: ToolStoreState) => {
+    const toolsSystemRole = pluginSelectors
+      .installedPluginManifestList(s)
+      .concat(s.builtinTools.map((b) => b.manifest as LobeChatPluginManifest))
+      // 如果存在 enabledPlugins，那么只启用 enabledPlugins 中的插件
+      .filter((m) => tools.includes(m?.identifier))
+      .map((manifest) => {
+        if (!manifest) return '';
+
+        const meta = manifest.meta || {};
+
+        const title = pluginHelpers.getPluginTitle(meta) || manifest.identifier;
+        const systemRole = manifest.systemRole || pluginHelpers.getPluginDesc(meta);
+
+        const methods = manifest.api
+          .map((m) =>
+            [`#### ${getAPIName(manifest.identifier, m.name, manifest.type)}`, m.description].join(
+              '\n\n',
+            ),
+          )
+          .join('\n\n');
+
+        return [`### ${title}`, systemRole, 'The APIs you can use:', methods].join('\n\n');
+      })
+      .filter(Boolean);
+
+    if (toolsSystemRole.length > 0) {
+      return ['## Tools', 'You can use these tools below:', ...toolsSystemRole]
+        .filter(Boolean)
+        .join('\n\n');
+    }
+
+    return '';
+  };
+
+const metaList = (s: ToolStoreState): LobeToolMeta[] => {
+  const pluginList = pluginSelectors.installedPluginMetaList(s) as LobeToolMeta[];
+
+  return builtinToolSelectors.metaList(s).concat(pluginList);
+};
+
+const getMetaById =
+  (id: string) =>
+  (s: ToolStoreState): MetaData | undefined =>
+    metaList(s).find((m) => m.identifier === id)?.meta;
+
+const getManifestById =
+  (id: string) =>
+  (s: ToolStoreState): LobeChatPluginManifest | undefined =>
+    pluginSelectors
+      .installedPluginManifestList(s)
+      .concat(s.builtinTools.map((b) => b.manifest as LobeChatPluginManifest))
+      .find((i) => i.identifier === id);
+
+// 获取插件 manifest 加载状态
+const getManifestLoadingStatus = (id: string) => (s: ToolStoreState) => {
+  const manifest = getManifestById(id)(s);
+
+  if (s.pluginInstallLoading[id]) return 'loading';
+
+  if (!manifest) return 'error';
+
+  if (!!manifest) return 'success';
+};
+
+export const toolSelectors = {
+  enabledSchema,
+  enabledSystemRoles,
+  getManifestById,
+  getManifestLoadingStatus,
+  getMetaById,
+  metaList,
+};

package/src/store/tool/slices/builtin/action.ts

@@ -0,0 +1,54 @@
+import { StateCreator } from 'zustand/vanilla';
+
+import { OpenAIImagePayload } from '@/types/openai/image';
+import { DallEImageItem } from '@/types/tool/dalle';
+import { setNamespace } from '@/utils/storeDebug';
+
+import { ToolStore } from '../../store';
+
+const n = setNamespace('builtinTool');
+
+interface Text2ImageParams extends Pick<OpenAIImagePayload, 'quality' | 'style' | 'size'> {
+  prompts: string[];
+}
+
+/**
+ * 代理行为接口
+ */
+export interface BuiltinToolAction {
+  invokeBuiltinTool: (key: string, params: any) => Promise<string | undefined>;
+  text2image: (params: Text2ImageParams, messageId: string) => DallEImageItem[];
+  toggleBuiltinToolLoading: (key: string, value: boolean) => void;
+}
+
+export const createBuiltinToolSlice: StateCreator<
+  ToolStore,
+  [['zustand/devtools', never]],
+  [],
+  BuiltinToolAction
+> = (set, get) => ({
+  invokeBuiltinTool: async (key, params) => {
+    const { builtinToolLoading, toggleBuiltinToolLoading } = get();
+
+    if (builtinToolLoading[key]) return;
+
+    toggleBuiltinToolLoading(key, true);
+
+    const { [key as keyof BuiltinToolAction]: action } = get();
+
+    if (!action) return;
+
+    // @ts-ignore
+    const result = await action(params);
+
+    toggleBuiltinToolLoading(key, false);
+
+    return JSON.stringify(result);
+  },
+  text2image: ({ prompts, size = '1024x1024' as const, quality = 'standard', style = 'vivid' }) =>
+    prompts.map((p) => ({ prompt: p, quality, size, style })),
+
+  toggleBuiltinToolLoading: (key, value) => {
+    set({ builtinToolLoading: { [key]: value } }, false, n('toggleBuiltinToolLoading'));
+  },
+});

package/src/store/tool/slices/builtin/index.ts

@@ -0,0 +1,2 @@
+export * from './action';
+export * from './initialState';

package/src/store/tool/slices/builtin/initialState.ts

@@ -0,0 +1,13 @@
+import { LobeBuiltinTool } from '@/types/tool';
+
+import { builtinTools } from '../../../../tools';
+
+export interface BuiltinToolState {
+  builtinToolLoading: Record<string, boolean>;
+  builtinTools: LobeBuiltinTool[];
+}
+
+export const initialBuiltinToolState: BuiltinToolState = {
+  builtinToolLoading: {},
+  builtinTools,
+};

package/src/store/tool/slices/builtin/selectors.test.ts

@@ -0,0 +1,70 @@
+import { LobeChatPluginManifest, LobeChatPluginMeta } from '@lobehub/chat-plugin-sdk';
+import { describe, expect, it } from 'vitest';
+
+import { ToolStoreState, initialState } from '../../initialState';
+import { builtinToolSelectors } from './selectors';
+
+const mockState = {
+  ...initialState,
+  pluginManifestLoading: {
+    'plugin-1': false,
+    'plugin-2': true,
+  },
+  installedPlugins: [
+    {
+      identifier: 'plugin-1',
+      type: 'plugin',
+      manifest: {
+        identifier: 'plugin-1',
+        api: [{ name: 'api-1' }],
+        type: 'default',
+      } as LobeChatPluginManifest,
+    },
+    {
+      identifier: 'plugin-2',
+      manifest: {
+        identifier: 'plugin-2',
+        api: [{ name: 'api-2' }],
+        type: 'default',
+      },
+      type: 'plugin',
+    },
+  ],
+  pluginStoreList: [
+    {
+      identifier: 'plugin-1',
+      author: 'Author 1',
+      createdAt: '2021-01-01',
+      meta: { avatar: 'avatar-url-1', title: 'Plugin 1' },
+      homepage: 'http://homepage-1.com',
+    } as LobeChatPluginMeta,
+    {
+      identifier: 'plugin-2',
+      author: 'Author 2',
+      createdAt: '2022-02-02',
+      meta: { avatar: 'avatar-url-2', title: 'Plugin 2' },
+      homepage: 'http://homepage-2.com',
+    },
+  ],
+} as ToolStoreState;
+
+describe('pluginSelectors', () => {
+  describe('isCustomPlugin', () => {
+    it('should return false for a non-custom plugin', () => {
+      const result = builtinToolSelectors.isBuiltinTool('plugin-1')(mockState);
+      expect(result).toBe(false);
+    });
+
+    it('should return true for a custom plugin', () => {
+      const stateWithCustomPlugin = {
+        ...mockState,
+        installedPlugins: [
+          ...mockState.installedPlugins,
+          { identifier: 'custom-plugin', type: 'customPlugin' },
+        ],
+      } as ToolStoreState;
+      const result = builtinToolSelectors.isBuiltinTool('custom-plugin')(stateWithCustomPlugin);
+      expect(result).toBe(true);
+    });
+  });
+});

package/src/store/tool/slices/builtin/selectors.ts

@@ -0,0 +1,20 @@
+import { LobeToolMeta } from '@/types/tool/tool';
+
+import { pluginHelpers } from '../../helpers';
+import type { ToolStoreState } from '../../initialState';
+
+const isBuiltinTool = (id: string) => (s: ToolStoreState) =>
+  pluginHelpers.isCustomPlugin(id, s.installedPlugins);
+
+const metaList = (s: ToolStoreState): LobeToolMeta[] =>
+  s.builtinTools.map((t) => ({
+    author: 'LobeHub',
+    identifier: t.identifier,
+    meta: t.manifest.meta,
+    type: 'builtin',
+  }));
+
+export const builtinToolSelectors = {
+  isBuiltinTool,
+  metaList,
+};

package/src/store/tool/slices/customPlugin/action.ts

@@ -14,9 +14,6 @@ import { defaultCustomPlugin } from './initialState';
 
 const n = setNamespace('customPlugin');
 
-/**
- * 代理行为接口
- */
 export interface CustomPluginAction {
   installCustomPlugin: (value: LobeToolCustomPlugin) => Promise<void>;
   reinstallCustomPlugin: (id: string) => Promise<void>;

package/src/store/tool/slices/plugin/selectors.test.ts

@@ -58,57 +58,6 @@ const mockState = {
 } as ToolStoreState;
 
 describe('pluginSelectors', () => {
-  describe('enabledSchema', () => {
-    it('enabledSchema should return correct ChatCompletionFunctions array', () => {
-      const result = pluginSelectors.enabledSchema(['plugin-1', 'plugin-2'])(mockState);
-      expect(result).toEqual([{ name: 'plugin-1____api-1' }, { name: 'plugin-2____api-2' }]);
-    });
-
-    it('enabledSchema should return with standalone plugin', () => {
-      const result = pluginSelectors.enabledSchema(['plugin-4'])({
-        ...mockState,
-        installedPlugins: [
-          ...mockState.installedPlugins,
-          {
-            identifier: 'plugin-4',
-            manifest: {
-              identifier: 'plugin-4',
-              api: [{ name: 'api-4' }],
-              type: 'standalone',
-            },
-            type: 'plugin',
-          },
-        ],
-      } as ToolStoreState);
-      expect(result).toEqual([{ name: 'plugin-4____api-4____standalone' }]);
-    });
-
-    it('enabledSchema should return md5 hash apiName', () => {
-      const result = pluginSelectors.enabledSchema(['long-long-plugin-with-id'])({
-        ...mockState,
-        installedPlugins: [
-          ...mockState.installedPlugins,
-          {
-            identifier: 'long-long-plugin-with-id',
-            manifest: {
-              identifier: 'long-long-plugin-with-id',
-              api: [{ name: 'long-long-manifest-long-long-apiName' }],
-            },
-            type: 'plugin',
-          },
-        ],
-      } as ToolStoreState);
-      expect(result).toEqual([
-        { name: 'long-long-plugin-with-id____MD5HASH_396eae4c671da3fb642c49ad2b9e8790' },
-      ]);
-    });
-
-    it('enabledSchema should return empty', () => {
-      const result = pluginSelectors.enabledSchema([])(mockState);
-      expect(result).toEqual([]);
-    });
-  });
-
   describe('getPluginManifestById', () => {
     it('getPluginManifestById should return the correct manifest', () => {
       const result = pluginSelectors.getPluginManifestById('plugin-1')(mockState);
@@ -211,24 +160,6 @@ describe('pluginSelectors', () => {
     });
   });
 
-  describe('getPluginManifestLoadingStatus', () => {
-    it('should return "loading" if the plugin manifest is being loaded', () => {
-      const result = pluginSelectors.getPluginManifestLoadingStatus('plugin-2')(mockState);
-      expect(result).toBe('loading');
-    });
-
-    it('should return "error" if the plugin manifest is not found', () => {
-      const result =
-        pluginSelectors.getPluginManifestLoadingStatus('non-existing-plugin')(mockState);
-      expect(result).toBe('error');
-    });
-
-    it('should return "success" if the plugin manifest is loaded', () => {
-      const result = pluginSelectors.getPluginManifestLoadingStatus('plugin-1')(mockState);
-      expect(result).toBe('success');
-    });
-  });
-
   describe('storeAndInstallPluginsIdList', () => {
     it('should return a list of unique plugin identifiers from both installed and store lists', () => {
       const result = pluginSelectors.storeAndInstallPluginsIdList(mockState);

package/src/store/tool/slices/plugin/selectors.ts

@@ -1,12 +1,8 @@
 import { LobeChatPluginManifest } from '@lobehub/chat-plugin-sdk';
-import { uniq, uniqBy } from 'lodash-es';
-import { Md5 } from 'ts-md5';
+import { uniq } from 'lodash-es';
 
-import { PLUGIN_SCHEMA_API_MD5_PREFIX, PLUGIN_SCHEMA_SEPARATOR } from '@/const/plugin';
-import { ChatCompletionFunctions } from '@/types/openai/chat';
 import { InstallPluginMeta, LobeToolCustomPlugin } from '@/types/tool/plugin';
 
-import { pluginHelpers } from '../../helpers';
 import type { ToolStoreState } from '../../initialState';
 
 const installedPlugins = (s: ToolStoreState) => s.installedPlugins;
@@ -37,17 +33,6 @@ const getPluginManifestById = (id: string) => (s: ToolStoreState) =>
 const getPluginSettingsById = (id: string) => (s: ToolStoreState) =>
   getInstalledPluginById(id)(s)?.settings || {};
 
-// 获取插件 manifest 加载状态
-const getPluginManifestLoadingStatus = (id: string) => (s: ToolStoreState) => {
-  const manifest = getPluginManifestById(id)(s);
-
-  if (s.pluginInstallLoading[id]) return 'loading';
-
-  if (!manifest) return 'error';
-
-  if (!!manifest) return 'success';
-};
-
 const storeAndInstallPluginsIdList = (s: ToolStoreState) =>
   uniq(
     [
@@ -79,78 +64,10 @@ const isPluginHasUI = (id: string) => (s: ToolStoreState) => {
   return !!plugin?.ui;
 };
 
-const enabledSchema =
-  (enabledPlugins: string[] = []) =>
-  (s: ToolStoreState): ChatCompletionFunctions[] => {
-    // 如果不存在 enabledPlugins，那么全部不启用
-    if (!enabledPlugins) return [];
-
-    const list = installedPluginManifestList(s)
-      .filter((m) =>
-        // 如果存在 enabledPlugins，那么只启用 enabledPlugins 中的插件
-        enabledPlugins.includes(m?.identifier),
-      )
-      .flatMap((manifest) =>
-        manifest.api.map((m) => {
-          const pluginType =
-            manifest.type && manifest.type !== 'default'
-              ? `${PLUGIN_SCHEMA_SEPARATOR + manifest.type}`
-              : '';
-
-          // 将插件的 identifier 作为前缀，避免重复
-          let apiName = manifest.identifier + PLUGIN_SCHEMA_SEPARATOR + m.name + pluginType;
-
-          // OpenAI GPT function_call name can't be longer than 64 characters
-          // So we need to use md5 to shorten the name
-          // and then find the correct apiName in response by md5
-          if (apiName.length >= 64) {
-            const md5Content = PLUGIN_SCHEMA_API_MD5_PREFIX + Md5.hashStr(m.name).toString();
-
-            apiName = manifest.identifier + PLUGIN_SCHEMA_SEPARATOR + md5Content + pluginType;
-          }
-
-          return {
-            ...m,
-            name: apiName,
-          };
-        }),
-      );
-
-    return uniqBy(list, 'name');
-  };
-
-const enabledPluginsSystemRoles =
-  (enabledPlugins: string[] = []) =>
-  (s: ToolStoreState) => {
-    const toolsSystemRole = enabledPlugins
-      .map((id) => {
-        const manifest = getPluginManifestById(id)(s);
-        if (!manifest) return '';
-        const meta = getPluginMetaById(id)(s);
-
-        const title = pluginHelpers.getPluginTitle(meta);
-        const desc = pluginHelpers.getPluginDesc(meta);
-
-        return [`### ${title}`, manifest.systemRole || desc].join('\n\n');
-      })
-      .filter(Boolean);
-
-    if (toolsSystemRole.length > 0) {
-      return ['## Tools', 'You can use these tools below:', ...toolsSystemRole]
-        .filter(Boolean)
-        .join('\n\n');
-    }
-
-    return '';
-  };
-
 export const pluginSelectors = {
-  enabledPluginsSystemRoles,
-  enabledSchema,
   getCustomPluginById,
   getInstalledPluginById,
   getPluginManifestById,
-  getPluginManifestLoadingStatus,
   getPluginMetaById,
   getPluginSettingsById,
   installedCustomPluginMetaList,

package/src/store/tool/store.ts

@@ -6,26 +6,32 @@ import { StateCreator } from 'zustand/vanilla';
 import { isDev } from '@/utils/env';
 
 import { ToolStoreState, initialState } from './initialState';
+import { BuiltinToolAction, createBuiltinToolSlice } from './slices/builtin';
 import { CustomPluginAction, createCustomPluginSlice } from './slices/customPlugin';
 import { PluginAction, createPluginSlice } from './slices/plugin';
 import { PluginStoreAction, createPluginStoreSlice } from './slices/store';
 
 //  ===============  聚合 createStoreFn ============ //
 
-export type ToolStore = ToolStoreState & CustomPluginAction & PluginAction & PluginStoreAction;
+export type ToolStore = ToolStoreState &
+  CustomPluginAction &
+  PluginAction &
+  PluginStoreAction &
+  BuiltinToolAction;
 
 const createStore: StateCreator<ToolStore, [['zustand/devtools', never]]> = (...parameters) => ({
   ...initialState,
   ...createPluginSlice(...parameters),
   ...createCustomPluginSlice(...parameters),
   ...createPluginStoreSlice(...parameters),
+  ...createBuiltinToolSlice(...parameters),
 });
 
 //  ===============  实装 useStore ============ //
 
 export const useToolStore = createWithEqualityFn<ToolStore>()(
   devtools(createStore, {
-    name: 'LobeChat_Plugin' + (isDev ? '_DEV' : ''),
+    name: 'LobeChat_Tool' + (isDev ? '_DEV' : ''),
   }),
   shallow,
 );

package/src/tools/dalle/Render/EditMode.tsx

@@ -0,0 +1,66 @@
+import { TextArea } from '@lobehub/ui';
+import { Button, Radio, Select } from 'antd';
+import { memo } from 'react';
+import { useTranslation } from 'react-i18next';
+import { Flexbox } from 'react-layout-kit';
+
+import { DallEImageItem } from '@/types/tool/dalle';
+
+interface EditModeProps extends DallEImageItem {
+  setEdit: (edit: boolean) => void;
+}
+
+const EditMode = memo<EditModeProps>(({ prompt, setEdit, style, size, quality }) => {
+  const { t } = useTranslation('tool');
+
+  return (
+    <Flexbox gap={16}>
+      <TextArea style={{ minHeight: 120 }} type={'block'} value={prompt} />
+      <Flexbox horizontal justify={'space-between'}>
+        风格
+        <Radio.Group
+          defaultValue={style}
+          options={[
+            { label: 'vivid', value: 'vivid' },
+            { label: 'natural', value: 'natural' },
+          ]}
+        />
+      </Flexbox>
+      <Flexbox horizontal justify={'space-between'}>
+        质量
+        <Radio.Group
+          defaultValue={quality}
+          options={[
+            { label: 'standard', value: 'standard' },
+            { label: 'hd', value: 'hd' },
+          ]}
+        />
+      </Flexbox>
+      <Flexbox horizontal justify={'space-between'}>
+        尺寸
+        <Select
+          defaultValue={size}
+          options={[
+            { label: '1792x1024', value: '1792x1024' },
+            { label: '1024x1024', value: '1024x1024' },
+            { label: '1024x1792', value: '1024x1792' },
+          ]}
+          size={'small'}
+        />
+      </Flexbox>
+
+      <Flexbox direction={'horizontal-reverse'} gap={12}>
+        <Button type={'primary'}>{t('dalle.generate')}</Button>
+        <Button
+          onClick={() => {
+            setEdit(false);
+          }}
+        >
+          {t('cancel', { ns: 'common' })}
+        </Button>
+      </Flexbox>
+    </Flexbox>
+  );
+});
+
+export default EditMode;