@lobehub/chat 1.17.7 → 1.18.1

package/src/types/discover.ts

@@ -0,0 +1,152 @@
+import { LobeChatPluginManifest } from '@lobehub/chat-plugin-sdk';
+import { LobeChatPluginMeta, Meta } from '@lobehub/chat-plugin-sdk/lib/types/market';
+
+import { ChatModelCard, ModelProviderCard } from '@/types/llm';
+import { MetaData } from '@/types/meta';
+import { LobeAgentSettings } from '@/types/session';
+
+export enum AssistantCategory {
+  Academic = 'academic',
+  All = 'all',
+  Career = 'career',
+  CopyWriting = 'copywriting',
+  Design = 'design',
+  Education = 'education',
+  Emotions = 'emotions',
+  Entertainment = 'entertainment',
+  Games = 'games',
+  General = 'general',
+  Life = 'life',
+  Marketing = 'marketing',
+  Office = 'office',
+  Programming = 'programming',
+  Translation = 'translation',
+}
+
+export enum PluginCategory {
+  All = 'all',
+  GamingEntertainment = 'gaming-entertainment',
+  LifeStyle = 'lifestyle',
+  MediaGenerate = 'media-generate',
+  ScienceEducation = 'science-education',
+  Social = 'social',
+  StocksFinance = 'stocks-finance',
+  Tools = 'tools',
+  WebSearch = 'web-search',
+}
+
+export enum DiscoverTab {
+  Assistants = 'assistants',
+  Home = 'home',
+  Models = 'models',
+  Plugins = 'plugins',
+  Providers = 'providers',
+}
+
+// TODO 可能需要修改
+export interface ExampleTopic {
+  description: string;
+  id: string;
+  title: string;
+}
+
+// TODO 服务端接口待补充
+export interface DiscoverAssistantItem extends LobeAgentSettings {
+  author: string;
+  createdAt: string;
+  examples?: ExampleTopic[];
+  homepage: string;
+  identifier: string;
+  meta: MetaData & {
+    category?: AssistantCategory;
+  };
+  schemaVersion: 1;
+  socialData: {
+    conversations: number;
+    likes: number;
+    users: number;
+  };
+  suggestions: Omit<DiscoverAssistantItem, 'suggestions' | 'socialData' | 'config'>[];
+}
+
+export interface DiscoverModelItem {
+  createdAt: string;
+  identifier: string;
+  meta: Omit<ChatModelCard, 'displayName' | 'deploymentName'> & {
+    category?: string;
+    title: string;
+  };
+  providers?: string[];
+  socialData: {
+    conversations: number;
+    likes: number;
+    tokens: number;
+  };
+  suggestions: Omit<DiscoverModelItem, 'suggestions' | 'socialData' | 'providers'>[];
+}
+
+export interface DiscoverProviderItem {
+  createdAt: string;
+  identifier: string;
+  meta: Omit<ModelProviderCard, 'chatModels' | 'name'> & {
+    description?: string;
+    title: string;
+  };
+  models: string[];
+  socialData: {
+    conversations: number;
+    likes: number;
+    users: number;
+  };
+  suggestions: Omit<DiscoverProviderItem, 'suggestions' | 'socialData'>[];
+}
+
+// TODO 服务端接口待补充
+export type DiscoverPlugintem = LobeChatPluginMeta & {
+  manifest: LobeChatPluginManifest;
+  meta: Meta & {
+    category?: PluginCategory;
+  };
+  socialData: {
+    called: number;
+    executionTime: number;
+    likes: number;
+    relatedAssistants: number;
+    successRate: number;
+    users: number;
+  };
+  suggestions: Omit<DiscoverPlugintem, 'suggestions' | 'socialData' | 'manifest'>[];
+};
+
+export enum SortBy {
+  MostLiked = 'liked',
+  MostUsed = 'used',
+  Newest = 'newest',
+  Oldest = 'oldest',
+  Recommended = 'recommended',
+}
+
+export enum TimePeriod {
+  All = 'all',
+  Day = 'day',
+  Month = 'month',
+  Week = 'week',
+  Year = 'year',
+}
+
+export enum AuthorRange {
+  Everyone = 'everyone',
+  Followed = 'followed',
+}
+
+export interface FilterBy {
+  author?: AuthorRange;
+  content?: number;
+  fc?: boolean;
+  knowledge?: boolean;
+  plugin?: boolean;
+  price?: number;
+  time?: TimePeriod;
+  token?: number;
+  vision?: boolean;
+}

package/src/types/llm.ts

@@ -1,5 +1,7 @@
 import { ReactNode } from 'react';
 
+export type ModelPriceCurrency = 'CNY' | 'USD';
+
 export interface ChatModelCard {
   /**
    * only used in azure
@@ -39,7 +41,7 @@ export interface ChatModelCard {
      * the currency of the pricing
      * @default USD
      */
-    currency?: 'CNY' | 'USD';
+    currency?: ModelPriceCurrency;
     /**
      * the input pricing, e.g. $1 / 1M tokens
      */
@@ -128,7 +130,7 @@ export interface ModelProviderCard {
   /**
    * provider's website url
    */
-  url?: string;
+  url: string;
 }
 
 // 语言模型的设置参数

package/src/types/meta.ts

@@ -10,6 +10,7 @@ export const LobeMetaDataSchema = z.object({
    */
   backgroundColor: z.string().optional(),
   description: z.string().optional(),
+
   tags: z.array(z.string()).optional(),
   /**
    * 名称

package/src/utils/format.test.ts

@@ -1,116 +1,195 @@
 import { describe, expect, it } from 'vitest';
 
-import { formatSize, formatSpeed, formatTime, formatTokenNumber } from './format';
-
-describe('formatSize', () => {
-  it('should format bytes to KB correctly', () => {
-    expect(formatSize(1024)).toBe('1.0 KB');
-    expect(formatSize(2048)).toBe('2.0 KB');
-    expect(formatSize(1536)).toBe('1.5 KB');
-  });
-
-  it('should format bytes to MB correctly', () => {
-    expect(formatSize(1048576)).toBe('1.0 MB');
-    expect(formatSize(2097152)).toBe('2.0 MB');
-    expect(formatSize(1572864)).toBe('1.5 MB');
-  });
-
-  it('should format bytes to GB correctly', () => {
-    expect(formatSize(1073741824)).toBe('1.0 GB');
-    expect(formatSize(2147483648)).toBe('2.0 GB');
-    expect(formatSize(1610612736)).toBe('1.5 GB');
-  });
-
-  it('should handle edge cases', () => {
-    expect(formatSize(0)).toBe('0.0 KB');
-    expect(formatSize(1023)).toBe('1.0 KB');
-    expect(formatSize(1073741823)).toBe('1024.0 MB');
-  });
-});
-
-describe('formatSpeed', () => {
-  it('should format speed in KB/s correctly', () => {
-    expect(formatSpeed(10 * 1024)).toBe('10.00 KB/s');
-    expect(formatSpeed(999.99 * 1024)).toBe('999.99 KB/s');
-  });
-
-  it('should format speed in MB/s correctly', () => {
-    expect(formatSpeed(1024 * 1024)).toBe('1.00 MB/s');
-    expect(formatSpeed(10240 * 1024)).toBe('10.00 MB/s');
-  });
-
-  it('should format speed in GB/s correctly', () => {
-    expect(formatSpeed(1048576 * 1024)).toBe('1.00 GB/s');
-    expect(formatSpeed(10485760 * 1024)).toBe('10.00 GB/s');
-  });
-
-  it('should handle edge cases', () => {
-    expect(formatSpeed(0)).toBe('0.00 Byte/s');
-    expect(formatSpeed(1000 * 1024)).toBe('1000.00 KB/s');
-    expect(formatSpeed(1000.01 * 1024)).toBe('0.98 MB/s');
-  });
-});
-
-describe('formatTime', () => {
-  it('should format time in seconds correctly', () => {
-    expect(formatTime(30)).toBe('30.0 s');
-    expect(formatTime(59.9)).toBe('59.9 s');
-  });
-
-  it('should format time in minutes correctly', () => {
-    expect(formatTime(60)).toBe('1.0 min');
-    expect(formatTime(3599)).toBe('60.0 min');
-  });
-
-  it('should format time in hours correctly', () => {
-    expect(formatTime(3600)).toBe('1.00 h');
-    expect(formatTime(7200)).toBe('2.00 h');
-  });
-
-  it('should handle edge cases', () => {
-    expect(formatTime(0)).toBe('0.0 s');
-    expect(formatTime(59.99)).toBe('60.0 s');
-    expect(formatTime(3599.99)).toBe('60.0 min');
-  });
-});
-
-describe('formatTokenNumber', () => {
-  it('should return "1K" for numbers between 1 and 1023', () => {
-    expect(formatTokenNumber(500)).toBe('1K');
-    expect(formatTokenNumber(1000)).toBe('1K');
-  });
-
-  it('should format numbers between 1024 and 41,983 correctly', () => {
-    expect(formatTokenNumber(1024)).toBe('1K');
-    expect(formatTokenNumber(2000)).toBe('2K');
-    expect(formatTokenNumber(2048)).toBe('2K');
-    expect(formatTokenNumber(4000)).toBe('4K');
-    expect(formatTokenNumber(4096)).toBe('4K');
-    expect(formatTokenNumber(32000)).toBe('32K');
-    expect(formatTokenNumber(65536)).toBe('64K');
-  });
-
-  it('should format numbers between 41,984 and 127,999 correctly', () => {
-    expect(formatTokenNumber(41984)).toBe('41K');
-    expect(formatTokenNumber(100000)).toBe('97K');
-    expect(formatTokenNumber(127999)).toBe('124K');
-  });
-
-  it('should return "128K" for 131,072', () => {
-    expect(formatTokenNumber(131072)).toBe('128K'); // Qwen
-  });
-
-  it('should format numbers between 128,000 and 999,999 correctly', () => {
-    expect(formatTokenNumber(128000)).toBe('128K');
-    expect(formatTokenNumber(200000)).toBe('200K'); // Claude
-    expect(formatTokenNumber(999999)).toBe('999K');
-  });
-
-  it('should format numbers 1,000,000 and above correctly', () => {
-    expect(formatTokenNumber(1000000)).toBe('1M');
-    expect(formatTokenNumber(1024000)).toBe('1M');
-    expect(formatTokenNumber(1048576)).toBe('1M'); // Gemini Flash
-    expect(formatTokenNumber(2000000)).toBe('2M');
-    expect(formatTokenNumber(2097152)).toBe('2M'); // Gemini Pro
+import {
+  formatNumber,
+  formatPrice,
+  formatPriceByCurrency,
+  formatShortenNumber,
+  formatSize,
+  formatSpeed,
+  formatTime,
+  formatTokenNumber,
+} from './format';
+
+// 保留你已经编写的测试用例
+describe('format', () => {
+  describe('formatSize', () => {
+    it('should format bytes to KB correctly', () => {
+      expect(formatSize(1024)).toBe('1.0 KB');
+      expect(formatSize(2048)).toBe('2.0 KB');
+      expect(formatSize(1536)).toBe('1.5 KB');
+    });
+
+    it('should format bytes to MB correctly', () => {
+      expect(formatSize(1048576)).toBe('1.0 MB');
+      expect(formatSize(2097152)).toBe('2.0 MB');
+      expect(formatSize(1572864)).toBe('1.5 MB');
+    });
+
+    it('should format bytes to GB correctly', () => {
+      expect(formatSize(1073741824)).toBe('1.0 GB');
+      expect(formatSize(2147483648)).toBe('2.0 GB');
+      expect(formatSize(1610612736)).toBe('1.5 GB');
+    });
+
+    it('should handle edge cases', () => {
+      expect(formatSize(0)).toBe('0.0 KB');
+      expect(formatSize(1023)).toBe('1.0 KB');
+      expect(formatSize(1073741823)).toBe('1024.0 MB');
+    });
+  });
+
+  describe('formatSpeed', () => {
+    it('should format speed in KB/s correctly', () => {
+      expect(formatSpeed(10 * 1024)).toBe('10.00 KB/s');
+      expect(formatSpeed(999.99 * 1024)).toBe('999.99 KB/s');
+    });
+
+    it('should format speed in MB/s correctly', () => {
+      expect(formatSpeed(1024 * 1024)).toBe('1.00 MB/s');
+      expect(formatSpeed(10240 * 1024)).toBe('10.00 MB/s');
+    });
+
+    it('should format speed in GB/s correctly', () => {
+      expect(formatSpeed(1048576 * 1024)).toBe('1.00 GB/s');
+      expect(formatSpeed(10485760 * 1024)).toBe('10.00 GB/s');
+    });
+
+    it('should handle edge cases', () => {
+      expect(formatSpeed(0)).toBe('0.00 Byte/s');
+      expect(formatSpeed(1000 * 1024)).toBe('1000.00 KB/s');
+      expect(formatSpeed(1000.01 * 1024)).toBe('0.98 MB/s');
+    });
+  });
+
+  describe('formatTime', () => {
+    it('should format time in seconds correctly', () => {
+      expect(formatTime(30)).toBe('30.0 s');
+      expect(formatTime(59.9)).toBe('59.9 s');
+    });
+
+    it('should format time in minutes correctly', () => {
+      expect(formatTime(60)).toBe('1.0 min');
+      expect(formatTime(3599)).toBe('60.0 min');
+    });
+
+    it('should format time in hours correctly', () => {
+      expect(formatTime(3600)).toBe('1.00 h');
+      expect(formatTime(7200)).toBe('2.00 h');
+    });
+
+    it('should handle edge cases', () => {
+      expect(formatTime(0)).toBe('0.0 s');
+      expect(formatTime(59.99)).toBe('60.0 s');
+      expect(formatTime(3599.99)).toBe('60.0 min');
+    });
+    it('should handle edge cases', () => {
+      expect(formatTime(0)).toBe('0.0 s');
+      expect(formatTime(59.99)).toBe('60.0 s');
+      expect(formatTime(3599.99)).toBe('60.0 min');
+    });
+  });
+
+  describe('formatShortenNumber', () => {
+    it('should return the input if it is not a number', () => {
+      expect(formatShortenNumber('not a number')).toBe('not a number');
+      expect(formatShortenNumber(null)).toBe(null);
+    });
+
+    it('should format numbers less than 10,000 correctly', () => {
+      expect(formatShortenNumber(0)).toBe(0);
+      expect(formatShortenNumber(1234)).toBe('1,234');
+      expect(formatShortenNumber(9999)).toBe('9,999');
+    });
+
+    it('should format numbers between 10,000 and 9,999,999 correctly', () => {
+      expect(formatShortenNumber(10000)).toBe('10.0K');
+      expect(formatShortenNumber(123456)).toBe('123.5K');
+      expect(formatShortenNumber(9999999)).toBe('10000.0K');
+    });
+
+    it('should format numbers 10,000,000 and above correctly', () => {
+      expect(formatShortenNumber(10000000)).toBe('10.0M');
+      expect(formatShortenNumber(123456789)).toBe('123.5M');
+      expect(formatShortenNumber(9876543210)).toBe('9876.5M');
+    });
+  });
+
+  describe('formatNumber', () => {
+    it('should format numbers with commas correctly', () => {
+      expect(formatNumber(1000)).toBe('1,000');
+      expect(formatNumber(1000000)).toBe('1,000,000');
+      expect(formatNumber(1234567.89)).toBe('1,234,567.89');
+    });
+
+    it('should handle non-number inputs', () => {
+      expect(formatNumber('1000')).toBe('1,000');
+      expect(formatNumber('not a number')).toBe(Number.NaN.toString());
+      expect(formatNumber(null)).toBe(undefined);
+    });
+  });
+
+  describe('formatPrice', () => {
+    it('should format prices correctly', () => {
+      expect(formatPrice(1000)).toBe('1,000.00');
+      expect(formatPrice(1234.56)).toBe('1,234.56');
+      expect(formatPrice(0.99)).toBe('0.99');
+      expect(formatPrice(1000000.01)).toBe('1,000,000.01');
+    });
+  });
+
+  describe('formatPriceByCurrency', () => {
+    it('should format USD prices correctly', () => {
+      expect(formatPriceByCurrency(1000)).toBe('1,000.00');
+      expect(formatPriceByCurrency(1234.56, 'USD')).toBe('1,234.56');
+    });
+
+    it('should format CNY prices correctly', () => {
+      // Assuming CNY_TO_USD is 6.5
+      const CNY_TO_USD = 6.5;
+      expect(formatPriceByCurrency(1000, 'CNY')).toBe('140.06');
+      expect(formatPriceByCurrency(6500, 'CNY')).toBe('910.36');
+    });
+  });
+
+  describe('formatTokenNumber', () => {
+    it('should return "1K" for numbers between 1 and 1023', () => {
+      expect(formatTokenNumber(500)).toBe('1K');
+      expect(formatTokenNumber(1000)).toBe('1K');
+    });
+
+    it('should format numbers between 1024 and 41,983 correctly', () => {
+      expect(formatTokenNumber(1024)).toBe('1K');
+      expect(formatTokenNumber(2000)).toBe('2K');
+      expect(formatTokenNumber(2048)).toBe('2K');
+      expect(formatTokenNumber(4000)).toBe('4K');
+      expect(formatTokenNumber(4096)).toBe('4K');
+      expect(formatTokenNumber(32000)).toBe('32K');
+      expect(formatTokenNumber(65536)).toBe('64K');
+    });
+
+    it('should format numbers between 41,984 and 127,999 correctly', () => {
+      expect(formatTokenNumber(41984)).toBe('41K');
+      expect(formatTokenNumber(100000)).toBe('97K');
+      expect(formatTokenNumber(127999)).toBe('124K');
+    });
+
+    it('should return "128K" for 131,072', () => {
+      expect(formatTokenNumber(131072)).toBe('128K'); // Qwen
+    });
+
+    it('should format numbers between 128,000 and 999,999 correctly', () => {
+      expect(formatTokenNumber(128000)).toBe('128K');
+      expect(formatTokenNumber(200000)).toBe('200K'); // Claude
+      expect(formatTokenNumber(999999)).toBe('999K');
+    });
+
+    it('should format numbers 1,000,000 and above correctly', () => {
+      expect(formatTokenNumber(1000000)).toBe('1M');
+      expect(formatTokenNumber(1024000)).toBe('1M');
+      expect(formatTokenNumber(1048576)).toBe('1M'); // Gemini Flash
+      expect(formatTokenNumber(2000000)).toBe('2M');
+      expect(formatTokenNumber(2097152)).toBe('2M'); // Gemini Pro
+    });
   });
 });

package/src/utils/format.ts

@@ -1,3 +1,9 @@
+import { isNumber } from 'lodash-es';
+import numeral from 'numeral';
+
+import { CNY_TO_USD } from '@/const/discover';
+import { ModelPriceCurrency } from '@/types/llm';
+
 export const formatSize = (bytes: number, fractionDigits = 1): string => {
   const kbSize = bytes / 1024;
   if (kbSize < 1024) {
@@ -47,11 +53,29 @@ export const formatTime = (timeInSeconds: number): string => {
   }
 };
 
+export const formatShortenNumber = (num: any) => {
+  if (!isNumber(num)) return num;
+  // 使用Intl.NumberFormat来添加千分号
+  const formattedWithComma = new Intl.NumberFormat('en-US').format(num);
+
+  // 格式化为 K 或 M
+  if (num >= 10_000_000) {
+    return (num / 1_000_000).toFixed(1) + 'M';
+  } else if (num >= 10_000) {
+    return (num / 1000).toFixed(1) + 'K';
+  } else if (num === 0) {
+    return 0;
+  } else {
+    return formattedWithComma;
+  }
+};
+
 /**
  * format number with comma
  * @param num
  */
 export const formatNumber = (num: any) => {
+  if (!num) return;
   return new Intl.NumberFormat('en-US').format(num);
 };
 
@@ -65,3 +89,15 @@ export const formatTokenNumber = (num: number): string => {
   if (num === 131_072) return '128K';
   return kiloToken < 1000 ? `${kiloToken}K` : `${Math.floor(kiloToken / 1000)}M`;
 };
+
+export const formatPrice = (price: number) => {
+  const [a, b] = price.toFixed(2).split('.');
+  return `${numeral(a).format('0,0')}.${b}`;
+};
+
+export const formatPriceByCurrency = (price: number, currency?: ModelPriceCurrency) => {
+  if (currency === 'CNY') {
+    return formatPrice(price / CNY_TO_USD);
+  }
+  return formatPrice(price);
+};

package/src/utils/toolManifest.ts

@@ -0,0 +1,124 @@
+import { LobeChatPluginManifest, pluginManifestSchema } from '@lobehub/chat-plugin-sdk';
+
+import { API_ENDPOINTS } from '@/services/_url';
+import { OpenAIPluginManifest } from '@/types/openai/plugin';
+
+const fetchJSON = async <T = any>(url: string, proxy = false): Promise<T> => {
+  // 2. 发送请求
+  let res: Response;
+  try {
+    res = await (proxy ? fetch(API_ENDPOINTS.proxy, { body: url, method: 'POST' }) : fetch(url));
+  } catch {
+    throw new TypeError('fetchError');
+  }
+
+  if (!res.ok) {
+    throw new TypeError('fetchError');
+  }
+
+  let data;
+  const contentType = res.headers.get('Content-Type');
+
+  try {
+    if (contentType === 'application/json') {
+      data = await res.json();
+    } else {
+      const { default: YAML } = await import('yaml');
+
+      const yaml = await res.text();
+      data = YAML.parse(yaml);
+    }
+  } catch {
+    throw new TypeError('urlError');
+  }
+
+  return data;
+};
+
+export const convertOpenAIManifestToLobeManifest = (
+  data: OpenAIPluginManifest,
+): LobeChatPluginManifest => {
+  const manifest: LobeChatPluginManifest = {
+    api: [],
+    homepage: data.legal_info_url,
+    identifier: data.name_for_model,
+    meta: {
+      avatar: data.logo_url,
+      description: data.description_for_human,
+      title: data.name_for_human,
+    },
+    openapi: data.api.url,
+    systemRole: data.description_for_model,
+    type: 'default',
+    version: '1',
+  };
+  switch (data.auth.type) {
+    case 'none': {
+      break;
+    }
+    case 'service_http': {
+      manifest.settings = {
+        properties: {
+          apiAuthKey: {
+            default: data.auth.verification_tokens['openai'],
+            description: 'API Key',
+            format: 'password',
+            title: 'API Key',
+            type: 'string',
+          },
+        },
+        type: 'object',
+      };
+      break;
+    }
+  }
+
+  return manifest;
+};
+
+export const getToolManifest = async (
+  url?: string,
+  useProxy: boolean = false,
+): Promise<LobeChatPluginManifest> => {
+  // 1. valid plugin
+  if (!url) {
+    throw new TypeError('noManifest');
+  }
+
+  // 2. 发送请求
+
+  let data = await fetchJSON<LobeChatPluginManifest>(url, useProxy);
+
+  // @ts-ignore
+  // if there is a description_for_model, it is an OpenAI plugin
+  // we need convert to lobe plugin
+  if (data['description_for_model']) {
+    data = convertOpenAIManifestToLobeManifest(data as any);
+  }
+
+  // 3. 校验插件文件格式规范
+  const parser = pluginManifestSchema.safeParse(data);
+
+  if (!parser.success) {
+    throw new TypeError('manifestInvalid', { cause: parser.error });
+  }
+
+  // 4. if exist OpenAPI api, merge the OpenAPIs to api
+  if (parser.data.openapi) {
+    const openapiJson = await fetchJSON(parser.data.openapi, useProxy);
+
+    try {
+      const { OpenAPIConvertor } = await import('@lobehub/chat-plugin-sdk/openapi');
+
+      const convertor = new OpenAPIConvertor(openapiJson);
+      const openAPIs = await convertor.convertOpenAPIToPluginSchema();
+      data.api = [...data.api, ...openAPIs];
+
+      data.settings = await convertor.convertAuthToSettingsSchema(data.settings);
+    } catch (error) {
+      throw new TypeError('openAPIInvalid', { cause: error });
+    }
+  }
+
+  return data;
+};