@lobehub/lobehub 2.0.0-next.4 → 2.0.0-next.41

package/packages/utils/src/apiKey.test.ts

@@ -0,0 +1,139 @@
+import { describe, expect, it } from 'vitest';
+
+import { generateApiKey, isApiKeyExpired, validateApiKeyFormat } from './apiKey';
+
+describe('apiKey', () => {
+  describe('generateApiKey', () => {
+    it('should generate API key with correct format', () => {
+      const apiKey = generateApiKey();
+      expect(apiKey).toMatch(/^lb-[\da-z]{16}$/);
+    });
+
+    it('should generate API key with correct length', () => {
+      const apiKey = generateApiKey();
+      expect(apiKey).toHaveLength(19); // 'lb-' (3) + 16 characters
+    });
+
+    it('should generate unique API keys', () => {
+      const keys = new Set();
+      for (let i = 0; i < 100; i++) {
+        keys.add(generateApiKey());
+      }
+      // All 100 keys should be unique
+      expect(keys.size).toBe(100);
+    });
+
+    it('should start with lb- prefix', () => {
+      const apiKey = generateApiKey();
+      expect(apiKey.startsWith('lb-')).toBe(true);
+    });
+
+    it('should only contain lowercase alphanumeric characters after prefix', () => {
+      const apiKey = generateApiKey();
+      const randomPart = apiKey.slice(3); // Remove 'lb-' prefix
+      expect(randomPart).toMatch(/^[\da-z]+$/);
+    });
+  });
+
+  describe('isApiKeyExpired', () => {
+    it('should return false when expiresAt is null', () => {
+      expect(isApiKeyExpired(null)).toBe(false);
+    });
+
+    it('should return false when expiration date is in the future', () => {
+      const futureDate = new Date();
+      futureDate.setFullYear(futureDate.getFullYear() + 1); // 1 year from now
+      expect(isApiKeyExpired(futureDate)).toBe(false);
+    });
+
+    it('should return true when expiration date is in the past', () => {
+      const pastDate = new Date();
+      pastDate.setFullYear(pastDate.getFullYear() - 1); // 1 year ago
+      expect(isApiKeyExpired(pastDate)).toBe(true);
+    });
+
+    it('should return true when expiration date is exactly now or just passed', () => {
+      const now = new Date();
+      now.setSeconds(now.getSeconds() - 1); // 1 second ago
+      expect(isApiKeyExpired(now)).toBe(true);
+    });
+
+    it('should handle edge case of expiration date being very close to now', () => {
+      const almostNow = new Date();
+      almostNow.setMilliseconds(almostNow.getMilliseconds() - 1); // 1ms ago
+      expect(isApiKeyExpired(almostNow)).toBe(true);
+    });
+  });
+
+  describe('validateApiKeyFormat', () => {
+    it('should validate correct API key format', () => {
+      const validKey = 'lb-1234567890abcdef';
+      expect(validateApiKeyFormat(validKey)).toBe(true);
+    });
+
+    it('should accept keys with only numbers', () => {
+      const validKey = 'lb-1234567890123456';
+      expect(validateApiKeyFormat(validKey)).toBe(true);
+    });
+
+    it('should accept keys with only lowercase letters', () => {
+      const validKey = 'lb-abcdefabcdefabcd';
+      expect(validateApiKeyFormat(validKey)).toBe(true);
+    });
+
+    it('should accept keys with mixed alphanumeric characters', () => {
+      const validKey = 'lb-abc123def456789a';
+      expect(validateApiKeyFormat(validKey)).toBe(true);
+    });
+
+    it('should reject keys without lb- prefix', () => {
+      const invalidKey = '1234567890abcdef';
+      expect(validateApiKeyFormat(invalidKey)).toBe(false);
+    });
+
+    it('should reject keys with wrong prefix', () => {
+      const invalidKey = 'lc-1234567890abcdef';
+      expect(validateApiKeyFormat(invalidKey)).toBe(false);
+    });
+
+    it('should reject keys that are too short', () => {
+      const invalidKey = 'lb-123456789abcde';
+      expect(validateApiKeyFormat(invalidKey)).toBe(false);
+    });
+
+    it('should reject keys that are too long', () => {
+      const invalidKey = 'lb-1234567890abcdef0';
+      expect(validateApiKeyFormat(invalidKey)).toBe(false);
+    });
+
+    it('should reject keys with uppercase letters', () => {
+      const invalidKey = 'lb-1234567890ABCDEF';
+      expect(validateApiKeyFormat(invalidKey)).toBe(false);
+    });
+
+    it('should reject keys with special characters', () => {
+      const invalidKey = 'lb-1234567890abcd-f';
+      expect(validateApiKeyFormat(invalidKey)).toBe(false);
+    });
+
+    it('should reject empty string', () => {
+      expect(validateApiKeyFormat('')).toBe(false);
+    });
+
+    it('should reject keys with spaces', () => {
+      const invalidKey = 'lb-1234567890abcd f';
+      expect(validateApiKeyFormat(invalidKey)).toBe(false);
+    });
+
+    it('should validate generated keys', () => {
+      // Generate a key and validate it
+      const generatedKey = generateApiKey();
+      // Note: The validation pattern expects hex digits (0-9a-f), but generated keys use base36 (0-9a-z)
+      // This test will fail if there are non-hex characters (g-z) in the generated key
+      const hasOnlyHexChars = /^lb-[\da-f]{16}$/.test(generatedKey);
+      if (hasOnlyHexChars) {
+        expect(validateApiKeyFormat(generatedKey)).toBe(true);
+      }
+    });
+  });
+});

package/packages/utils/src/client/clipboard.ts

@@ -16,7 +16,7 @@ const copyUsingFallback = (imageUrl: string) => {
         });
       });
     } catch {
-      // 如果 toBlob 或 ClipboardItem 不被支持，使用 data URL
+      // If toBlob or ClipboardItem is not supported, use data URL
       const dataURL = canvas.toDataURL('image/png');
       const textarea = document.createElement('textarea');
       textarea.value = dataURL;
@@ -44,7 +44,7 @@ const copyUsingModernAPI = async (imageUrl: string) => {
 };
 
 export const copyImageToClipboard = async (imageUrl: string) => {
-  // 检查是否支持现代 Clipboard API
+  // Check if modern Clipboard API is supported
   if (navigator.clipboard && 'write' in navigator.clipboard) {
     await copyUsingModernAPI(imageUrl);
   } else {

package/packages/utils/src/client/exportFile.ts

@@ -1,41 +1,41 @@
 export const exportFile = (content: string, filename?: string) => {
-  // 创建一个 Blob 对象
+  // Create a Blob object
   const blob = new Blob([content], { type: 'plain/text' });
 
-  // 创建一个 URL 对象，用于下载
+  // Create a URL object for download
   const url = URL.createObjectURL(blob);
 
-  // 创建一个 <a> 元素，设置下载链接和文件名
+  // Create an <a> element, set download link and filename
   const a = document.createElement('a');
   a.href = url;
   a.download = filename || 'file.txt';
 
-  // 触发 <a> 元素的点击事件，开始下载
+  // Trigger the click event of the <a> element to start download
   document.body.append(a);
   a.click();
 
-  // 下载完成后，清除 URL 对象
+  // After download is complete, clear the URL object
   URL.revokeObjectURL(url);
   a.remove();
 };
 
 export const exportJSONFile = (data: object, fileName: string) => {
-  // 创建一个 Blob 对象
+  // Create a Blob object
   const blob = new Blob([JSON.stringify(data)], { type: 'application/json' });
 
-  // 创建一个 URL 对象，用于下载
+  // Create a URL object for download
   const url = URL.createObjectURL(blob);
 
-  // 创建一个 <a> 元素，设置下载链接和文件名
+  // Create an <a> element, set download link and filename
   const a = document.createElement('a');
   a.href = url;
   a.download = fileName;
 
-  // 触发 <a> 元素的点击事件，开始下载
+  // Trigger the click event of the <a> element to start download
   document.body.append(a);
   a.click();
 
-  // 下载完成后，清除 URL 对象
+  // After download is complete, clear the URL object
   URL.revokeObjectURL(url);
   a.remove();
 };

package/packages/utils/src/client/parserPlaceholder.ts

@@ -10,7 +10,7 @@ const placeholderVariablesRegex = /{{(.*?)}}/g;
 /* eslint-disable sort-keys-fix/sort-keys-fix */
 export const VARIABLE_GENERATORS = {
   /**
-   * 时间类模板变量
+   * Time-related template variables
    *
    * | Value | Example |
    * |-------|---------|
@@ -46,12 +46,12 @@ export const VARIABLE_GENERATORS = {
   year: () => new Date().getFullYear().toString(),
 
   /**
-   * 用户信息类模板变量
+   * User information template variables
    *
    * | Value | Example |
    * |-------|---------|
    * | `{{email}}` | demo@lobehub.com |
-   * | `{{nickname}}` | 社区版用户 |
+   * | `{{nickname}}` | Community User |
    * | `{{username}}` | LobeChat |
    *
    */
@@ -63,7 +63,7 @@ export const VARIABLE_GENERATORS = {
     '',
 
   /**
-   * 随机值类模板变量
+   * Random value template variables
    *
    * | Value | Example |
    * |-------|---------|
@@ -99,7 +99,7 @@ export const VARIABLE_GENERATORS = {
   uuid_short: () => uuid().split('-')[0],
 
   /**
-   * 平台类模板变量
+   * Platform-related template variables
    *
    * | Value | Example |
    * |-------|---------|
@@ -114,9 +114,9 @@ export const VARIABLE_GENERATORS = {
 } as Record<string, () => string>;
 
 /**
- * 从文本中提取所有 {{variable}} 占位符的变量名
- * @param text 包含模板变量的字符串
- * @returns 变量名数组，如 ['date', 'nickname']
+ * Extract all {{variable}} placeholder variable names from text
+ * @param text String containing template variables
+ * @returns Array of variable names, e.g., ['date', 'nickname']
  */
 const extractPlaceholderVariables = (text: string): string[] => {
   const matches = [...text.matchAll(placeholderVariablesRegex)];
@@ -124,15 +124,15 @@ const extractPlaceholderVariables = (text: string): string[] => {
 };
 
 /**
- * 将模板变量替换为实际值，并支持递归解析嵌套变量
- * @param text - 含变量的原始文本
- * @param depth - 递归深度，默认 1，设置更高可支持 {{text}} 中的 {{date}} 等
- * @returns 替换后的文本
+ * Replace template variables with actual values, supporting recursive parsing of nested variables
+ * @param text - Original text containing variables
+ * @param depth - Recursion depth, default 1, set higher to support {{date}} within {{text}} etc.
+ * @returns Replaced text
  */
 export const parsePlaceholderVariables = (text: string, depth = 2): string => {
   let result = text;
 
-  // 递归解析，用于处理如 {{text}} 存在额外预设变量
+  // Recursive parsing to handle cases where {{text}} contains additional preset variables
   for (let i = 0; i < depth; i++) {
     try {
       const variables = Object.fromEntries(
@@ -154,9 +154,9 @@ export const parsePlaceholderVariables = (text: string, depth = 2): string => {
 };
 
 /**
- * 解析消息内容，替换占位符变量
- * @param messages 原始消息数组
- * @returns 处理后的消息数组
+ * Parse message content, replace placeholder variables
+ * @param messages Original message array
+ * @returns Processed message array
  */
 export const parsePlaceholderVariablesMessages = (messages: any[]): any[] =>
   messages.map((message) => {
@@ -164,12 +164,12 @@ export const parsePlaceholderVariablesMessages = (messages: any[]): any[] =>
 
     const { content } = message;
 
-    // 字符串类型直接处理
+    // Process string type directly
     if (typeof content === 'string') {
       return { ...message, content: parsePlaceholderVariables(content) };
     }
 
-    // 数组类型处理其中的 text 元素
+    // Process text elements in array type
     if (Array.isArray(content)) {
       return {
         ...message,

package/packages/utils/src/client/topic.ts

@@ -3,7 +3,7 @@ import dayjs from 'dayjs';
 import isToday from 'dayjs/plugin/isToday';
 import isYesterday from 'dayjs/plugin/isYesterday';
 
-// 初始化 dayjs 插件
+// Initialize dayjs plugins
 dayjs.extend(isToday);
 dayjs.extend(isYesterday);
 
@@ -19,32 +19,32 @@ const getTopicGroupId = (timestamp: number): TimeGroupId => {
     return 'yesterday';
   }
 
-  // 7天内（不包括今天和昨天）
+  // Within 7 days (excluding today and yesterday)
   const weekAgo = now.subtract(7, 'day');
   if (date.isAfter(weekAgo) && !date.isToday() && !date.isYesterday()) {
     return 'week';
   }
 
-  // 当前月份（不包括前面已经分组的日期）
-  // 使用原生的月份和年份比较
+  // Current month (excluding dates already grouped above)
+  // Use native month and year comparison
   if (date.month() === now.month() && date.year() === now.year()) {
     return 'month';
   }
 
-  // 当年的其他月份
+  // Other months of the current year
   if (date.year() === now.year()) {
     return `${date.year()}-${(date.month() + 1).toString().padStart(2, '0')}`;
   }
 
-  // 更早的年份
+  // Earlier years
   return `${date.year()}`;
 };
 
-// 确保分组的排序
+// Ensure group sorting
 const sortGroups = (groups: GroupedTopic[]): GroupedTopic[] => {
   const orderMap = new Map<string, number>();
 
-  // 设置固定分组的顺序
+  // Set the order of fixed groups
   orderMap.set('today', 0);
   orderMap.set('yesterday', 1);
   orderMap.set('week', 2);
@@ -58,12 +58,12 @@ const sortGroups = (groups: GroupedTopic[]): GroupedTopic[] => {
       return orderA - orderB;
     }
 
-    // 对于年月格式和年份格式的分组，按时间倒序排序
+    // For year-month and year format groups, sort in descending chronological order
     return b.id.localeCompare(a.id);
   });
 };
 
-// 时间分组的具体实现
+// Specific implementation of time grouping
 export const groupTopicsByTime = (topics: ChatTopic[]): GroupedTopic[] => {
   if (!topics.length) return [];
 

package/packages/utils/src/client/xor-obfuscation.ts

@@ -1,30 +1,30 @@
 import { SECRET_XOR_KEY } from '@/const/auth';
 
 /**
- * 将字符串转换为 Uint8Array (UTF-8 编码)
+ * Convert string to Uint8Array (UTF-8 encoding)
  */
 const stringToUint8Array = (str: string): Uint8Array => {
   return new TextEncoder().encode(str);
 };
 
 /**
- * 对 Uint8Array 进行 XOR 运算
- * @param data 要处理的 Uint8Array
- * @param key 用于 XOR 的密钥 (Uint8Array)
- * @returns 经过 XOR 运算的 Uint8Array
+ * Perform XOR operation on Uint8Array
+ * @param data The Uint8Array to process
+ * @param key The key used for XOR operation (Uint8Array)
+ * @returns The Uint8Array after XOR operation
  */
 const xorProcess = (data: Uint8Array, key: Uint8Array): Uint8Array => {
   const result = new Uint8Array(data.length);
   for (const [i, datum] of data.entries()) {
-    result[i] = datum ^ key[i % key.length]; // 密钥循环使用
+    result[i] = datum ^ key[i % key.length]; // Key is used cyclically
   }
   return result;
 };
 
 /**
- * 对 payload 进行 XOR 混淆并 Base64 编码
- * @param payload 要混淆的 JSON 对象
- * @returns Base64 编码后的混淆字符串
+ * Obfuscate payload with XOR and encode to Base64
+ * @param payload The JSON object to obfuscate
+ * @returns The obfuscated string encoded in Base64
  */
 export const obfuscatePayloadWithXOR = <T>(payload: T): string => {
   const jsonString = JSON.stringify(payload);
@@ -33,7 +33,7 @@ export const obfuscatePayloadWithXOR = <T>(payload: T): string => {
 
   const xoredBytes = xorProcess(dataBytes, keyBytes);
 
-  // 将 Uint8Array 转换为 Base64 字符串
-  // 浏览器环境 btoa 只能处理 Latin-1 字符，所以需要先转换为适合 btoa 的字符串
+  // Convert Uint8Array to Base64 string
+  // In browser environment, btoa can only handle Latin-1 characters, so we need to convert to a format suitable for btoa first
   return btoa(String.fromCharCode(...xoredBytes));
 };

package/packages/utils/src/server/auth.ts

@@ -29,9 +29,9 @@ export const getUserAuth = async () => {
 };
 
 /**
- * 从授权头中提取 Bearer Token
- * @param authHeader - 授权头 (例如 "Bearer xxx")
- * @returns Bearer Token 或 null（如果授权头无效或不存在）
+ * Extract Bearer Token from authorization header
+ * @param authHeader - Authorization header (e.g. "Bearer xxx")
+ * @returns Bearer Token or null (if authorization header is invalid or does not exist)
  */
 export const extractBearerToken = (authHeader?: string | null): string | null => {
   if (!authHeader) return null;
@@ -51,9 +51,9 @@ export const extractBearerToken = (authHeader?: string | null): string | null =>
 };
 
 /**
- * 从 Oidc-Auth header 中提取 JWT token
- * @param authHeader - Oidc-Auth header 值 (例如 "Oidc-Auth xxx")
- * @returns JWT token 或 null（如果授权头无效或不存在）
+ * Extract JWT token from Oidc-Auth header
+ * @param authHeader - Oidc-Auth header value (e.g. "Oidc-Auth xxx")
+ * @returns JWT token or null (if authorization header is invalid or does not exist)
  */
 export const extractOidcAuthToken = (authHeader?: string | null): string | null => {
   if (!authHeader) return null;

package/packages/utils/src/server/geo.ts

@@ -13,19 +13,19 @@ const getLocalTime = (timeZone: string) => {
 const isValidTimeZone = (timeZone: string) => {
   try {
     getLocalTime(timeZone);
-    return true; // 如果没抛异常，说明时区有效
+    return true; // If no exception is thrown, the timezone is valid
   } catch (e) {
-    // 捕获到 RangeError，说明时区无效
+    // If a RangeError is caught, the timezone is invalid
     if (e instanceof RangeError) {
       return false;
     }
-    // 如果是其他错误，最好重新抛出
+    // If it's another error, better to re-throw it
     throw e;
   }
 };
 
 export const parseDefaultThemeFromCountry = (request: NextRequest) => {
-  // 1. 从请求头中获取国家代码
+  // 1. Get country code from request headers
   const geo = geolocation(request);
 
   const countryCode =
@@ -35,22 +35,22 @@ export const parseDefaultThemeFromCountry = (request: NextRequest) => {
     request.headers.get('x-zeabur-ip-country') || // Zeabur
     request.headers.get('x-country-code'); // Netlify
 
-  // 如果没有获取到国家代码，直接返回 light 主题
+  // If no country code is obtained, return light theme directly
   if (!countryCode) return 'light';
 
-  // 2. 获取国家的时区信息
+  // 2. Get timezone information for the country
   const country = getCountry(countryCode);
 
-  // 如果找不到国家信息或该国家没有时区信息，返回 light 主题
+  // If country information is not found or the country has no timezone information, return light theme
   if (!country?.timezones?.length) return 'light';
 
   const timeZone = country.timezones.find((tz) => isValidTimeZone(tz));
   if (!timeZone) return 'light';
 
-  // 3. 获取该国家的第一个 时区下的当前时间
+  // 3. Get the current time in the country's first timezone
   const localTime = getLocalTime(timeZone);
 
-  // 4. 解析小时数并确定主题
+  // 4. Parse the hour and determine the theme
   const localHour = parseInt(localTime);
   // console.log(
   //   `[theme] Country: ${countryCode}, Timezone: ${country.timezones[0]}, LocalHour: ${localHour}`,

package/packages/utils/src/server/xor.ts

@@ -3,15 +3,15 @@ import { ClientSecretPayload } from '@lobechat/types';
 import { SECRET_XOR_KEY } from '@/const/auth';
 
 /**
- * 将 Base64 字符串转换为 Uint8Array
+ * Convert Base64 string to Uint8Array
  */
 const base64ToUint8Array = (base64: string): Uint8Array => {
-  // Node.js 环境下直接使用 Buffer
+  // Use Buffer directly in Node.js environment
   return Buffer.from(base64, 'base64');
 };
 
 /**
- * 对 Uint8Array 进行 XOR 运算 (与客户端的 xorProcess 函数相同)
+ * Perform XOR operation on Uint8Array (same as the client-side xorProcess function)
  */
 const xorProcess = (data: Uint8Array, key: Uint8Array): Uint8Array => {
   const result = new Uint8Array(data.length);
@@ -22,7 +22,7 @@ const xorProcess = (data: Uint8Array, key: Uint8Array): Uint8Array => {
 };
 
 /**
- * 将 Uint8Array 转换为字符串 (UTF-8 解码)
+ * Convert Uint8Array to string (UTF-8 decoding)
  */
 const uint8ArrayToString = (arr: Uint8Array): string => {
   return new TextDecoder().decode(arr);
@@ -31,13 +31,13 @@ const uint8ArrayToString = (arr: Uint8Array): string => {
 export const getXorPayload = (token: string): ClientSecretPayload => {
   const keyBytes = new TextEncoder().encode(SECRET_XOR_KEY);
 
-  // 1. Base64 解码
+  // 1. Base64 decoding
   const base64DecodedBytes = base64ToUint8Array(token);
 
-  // 2. XOR 解混淆
+  // 2. XOR deobfuscation
   const xorDecryptedBytes = xorProcess(base64DecodedBytes, keyBytes);
 
-  // 3. 转换为字符串并解析 JSON
+  // 3. Convert to string and parse JSON
   const decodedJsonString = uint8ArrayToString(xorDecryptedBytes);
 
   return JSON.parse(decodedJsonString) as ClientSecretPayload;

package/packages/utils/src/tokenizer/index.ts

@@ -1,15 +1,7 @@
+import { estimateTokenCount } from 'tokenx';
+
 export const encodeAsync = async (str: string): Promise<number> => {
   if (str.length === 0) return 0;
 
-  // use gpt-tokenizer under 10000 str
-  // use approximation way if large then 10000
-  if (str.length <= 10_000) {
-    const { clientEncodeAsync } = await import('./client');
-
-    return await clientEncodeAsync(str);
-  } else {
-    const { estimatedEncodeAsync } = await import('./estimated');
-
-    return await estimatedEncodeAsync(str);
-  }
+  return estimateTokenCount(str);
 };

package/packages/web-crawler/src/crawImpl/browserless.ts

@@ -56,7 +56,7 @@ export const browserless: CrawlImpl = async (url, { filterOptions }) => {
     if (
       !!result.content &&
       result.title &&
-      // Just a moment... 说明被 CF 拦截了
+      // "Just a moment..." indicates being blocked by CloudFlare
       result.title.trim() !== 'Just a moment...'
     ) {
       return {