kokkoro-plugin-saucenao 2.0.1 → 2.0.3

package/README.md

@@ -2,6 +2,9 @@
 
 SauceNAO 图片搜索，查找动漫、漫画、插画等图片的来源。
 
+> [!IMPORTANT]
+> 使用 SauceNAO API 前，需要先[申请 API Key](https://saucenao.com/user.php?page=search-api)，并完成[环境变量配置](#环境变量)。
+
 ## 安装
 
 ```shell
@@ -14,16 +17,30 @@ bun add kokkoro-plugin-saucenao
 /搜图
 ```
 
-发送「/搜图」时附带图片，插件会搜索消息中的第一张图片，并以 Markdown 返回搜索结果，默认显示相似度最高的 3 条。
+发送「/搜图」指令时附带图片，或引用包含图片的消息回复该指令。插件搜索首张图片的来源，并通过 QQ Markdown 返回结果，默认显示相似度最高的 3 条。
 
 ## 快捷方式
 
-发送「搜图」时附带图片，也会返回搜索结果。群聊需要开启「获取群内全部消息」权限。
+「搜图」与「/搜图」的用法相同。在普通群消息中使用快捷方式，需要开启「获取群内全部消息」权限。
 
 ```text
 搜图
 ```
 
+## API
+
+其他插件可以从 `service` 入口导入 `fetchImageSources()` 搜索图片来源，再从 `util` 入口导入 `createMarkdown()` 生成 QQ Markdown：
+
+```typescript
+import { fetchImageSources } from 'kokkoro-plugin-saucenao/service';
+import { createMarkdown } from 'kokkoro-plugin-saucenao/util';
+
+const { results } = await fetchImageSources('https://example.com/image.jpg');
+const markdown = await createMarkdown(results);
+```
+
+`fetchImageSources()` 返回 SauceNAO 的完整响应，可通过第二个参数传入日志记录器，记录完整请求参数和接口响应。`service` 入口同时导出 `SauceNao` 和 `ImageSource` 类型。
+
 ## 环境变量
 
 使用插件前，需要在项目根目录的 `.env` 文件中填写 [SauceNAO API Key](https://saucenao.com/user.php?page=search-api)。
@@ -37,17 +54,3 @@ SAUCENAO_SIMILARITY_THRESHOLD=50
 `SAUCENAO_NUMRES` 表示返回结果数量，默认值为 `3`。
 
 `SAUCENAO_SIMILARITY_THRESHOLD` 表示显示原缩略图的最低相似度，默认值为 `50`。低于该数值时，插件会使用表情包替换缩略图，避免搜出奇怪的图社死。
-
-## API
-
-其他插件可以从 `service` 入口导入 `fetchImageSources()` 搜索图片来源，再从 `util` 入口导入 `createMarkdown()` 生成 QQ Markdown：
-
-```typescript
-import { fetchImageSources } from 'kokkoro-plugin-saucenao/service';
-import { createMarkdown } from 'kokkoro-plugin-saucenao/util';
-
-const { results } = await fetchImageSources('https://example.com/image.jpg');
-const markdown = await createMarkdown(results);
-```
-
-`fetchImageSources()` 返回 SauceNAO 的完整响应。`service` 入口同时导出 `SauceNao` 和 `ImageSource` 类型。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kokkoro-plugin-saucenao",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "description": "SauceNAO 图片搜索，查找动漫、漫画、插画等图片的来源。",
   "keywords": [
     "bot",

package/src/index.ts

@@ -1,33 +1,30 @@
 import { useCommand, useLogger } from '@kokkoro/core';
 
-import { fetchImageSources, SAUCENAO_API } from './service';
+import { fetchImageSources } from './service';
 import { createMarkdown } from './util';
 
 const logger = useLogger();
 
 export default () => {
   useCommand('/搜图', async context => {
-    const image = context.attachments?.find(attachment => attachment.content_type?.startsWith('image/'));
+    const [reference] = context.msg_elements ?? [];
+    const attachments = context.message_type === 103 ? reference?.attachments : context.attachments;
+    const images = attachments?.filter(attachment => attachment.content_type?.startsWith('image/')) ?? [];
+    const [image] = images;
 
     if (!image?.url) {
-      throw new Error('请在指令中附带需要搜索的图片');
+      throw new Error('未检测到图片，请在指令消息中附带图片，或引用包含图片的消息后重试。');
     }
-    logger.debug('发送 SauceNAO 请求', {
-      method: 'POST',
-      url: SAUCENAO_API,
-      payload: { url: image.url },
-    });
-
-    const result = await fetchImageSources(image.url);
+    const result = await fetchImageSources(image.url, logger);
     const { results } = result;
+    const notice = images.length > 1 ? '检测到消息中包含多张图片，已选取首张图片进行识别。' : undefined;
 
-    logger.debug('收到 SauceNAO 响应', result);
     logger.info('已找到图片来源', { count: results.length });
 
     await context.reply({
       msg_type: 2,
       markdown: {
-        content: await createMarkdown(results),
+        content: await createMarkdown(results, notice),
       },
     });
   }).shortcut('搜图');

package/src/service.ts

@@ -1,3 +1,5 @@
+import { type Logger } from '@kokkoro/core';
+
 /**
  * SauceNAO JSON API 搜索响应。
  *
@@ -23,7 +25,7 @@ export interface SauceNao {
     /** 请求失败时返回的错误信息。 */
     readonly message?: string;
     /** `numres` 请求的结果数量。 */
-    readonly results_requested: string;
+    readonly results_requested: number;
     /** 参与搜索的索引状态，以索引编号为键。 */
     readonly index: Readonly<
       Record<
@@ -115,37 +117,48 @@ export interface ImageSource {
   };
 }
 
-const { SAUCENAO_API_KEY, SAUCENAO_NUMRES = 3 } = import.meta.env;
+const { SAUCENAO_API_KEY, SAUCENAO_NUMRES = '3' } = import.meta.env;
 /** SauceNAO JSON API 的请求地址。 */
 export const SAUCENAO_API = 'https://saucenao.com/search.php';
 
 /** 使用 SauceNAO 搜索图片来源，并返回完整的接口响应。 */
-export async function fetchImageSources(image: string): Promise<SauceNao> {
+export async function fetchImageSources(url: string, logger?: Logger): Promise<SauceNao> {
   if (!SAUCENAO_API_KEY) {
     throw new Error('未配置 SAUCENAO_API_KEY 环境变量');
   }
-  const form = new FormData();
+  const endpoint = new URL(SAUCENAO_API);
+  const payload = {
+    api_key: SAUCENAO_API_KEY,
+    output_type: '2',
+    numres: SAUCENAO_NUMRES,
+    db: '999',
+    url,
+  };
+  const params = new URLSearchParams(payload);
 
-  form.set('api_key', SAUCENAO_API_KEY);
-  form.set('output_type', '2');
-  form.set('numres', String(SAUCENAO_NUMRES));
-  form.set('db', '999');
-  form.set('url', image);
+  endpoint.search = params.toString();
+  logger?.debug('发送 SauceNAO 请求', {
+    method: 'GET',
+    url: SAUCENAO_API,
+    payload,
+  });
 
-  const response = await fetch(SAUCENAO_API, { method: 'POST', body: form });
+  const response = await fetch(endpoint);
 
   if (!response.ok) {
-    throw new Error(`接口请求失败，状态码 ${response.status}`);
+    throw new Error(`SauceNAO 请求失败，HTTP 状态码 ${response.status}`);
   }
   const result = <SauceNao>await response.json();
   const { header, results } = result;
 
+  logger?.debug('收到 SauceNAO 响应', result);
+
   if (header.status !== 0) {
     throw new Error(header.message ?? `SauceNAO 搜索失败，状态码 ${header.status}`);
   }
 
   if (results.length === 0) {
-    throw new Error('没有找到图片来源');
+    throw new Error('未找到图片来源');
   }
   return result;
 }

package/src/util.ts

@@ -2,7 +2,7 @@ import { Image } from 'bun';
 
 import { type ImageSource } from './service';
 
-const { SAUCENAO_SIMILARITY_THRESHOLD = 50 } = import.meta.env;
+const { SAUCENAO_SIMILARITY_THRESHOLD = '50' } = import.meta.env;
 const LOW_SIMILARITY_THUMBNAIL = 'https://kokkoro.js.org/saucenao-low-similarity.jpg';
 const similarityThreshold = Number(SAUCENAO_SIMILARITY_THRESHOLD);
 
@@ -28,41 +28,42 @@ function getUrl(data: ImageSource['data']) {
   }
 }
 
-/** 将 SauceNAO 搜索结果转换为 QQ Markdown。 */
-export async function createMarkdown(results: readonly ImageSource[]): Promise<string> {
+/** 将 SauceNAO 搜索结果转换为 QQ Markdown，可在标题下方展示提示。 */
+export async function createMarkdown(results: readonly ImageSource[], notice?: string): Promise<string> {
+  const lines = ['## SauceNAO 搜图结果'];
+
+  if (notice) {
+    lines.push('', `> ${notice}`);
+  }
   const content = await Promise.all(
     results.map(async ({ data, header }, index) => {
       const { index_name: indexName, similarity, thumbnail } = header;
       const platform = getPlatform(indexName);
       const title = getTitle(data) || platform;
       const url = getUrl(data);
-      const lines = ['### 标题', `- ${title}`, '### 平台', `- ${platform}`, '### 相似度', `- ${similarity}%`];
+      const lines = [`### ${index + 1}. ${title}`, `- 相似度：${similarity}%`, `- 平台：${platform}`];
 
       if (thumbnail) {
         if (Number(similarity) < similarityThreshold) {
-          lines.push('### 缩略图', `![缩略图 #168px #142px](${LOW_SIMILARITY_THUMBNAIL})`);
+          lines.push('', `![缩略图 #168px #142px](${LOW_SIMILARITY_THUMBNAIL})`);
         } else {
           const response = await fetch(thumbnail);
 
           if (!response.ok) {
-            throw new Error(`缩略图请求失败，状态码 ${response.status}`);
+            throw new Error(`缩略图下载失败，HTTP 状态码 ${response.status}`);
           }
           const { height, width } = await new Image(await response.blob()).metadata();
 
-          lines.push('### 缩略图', `![缩略图 #${width}px #${height}px](${thumbnail})`);
+          lines.push('', `![缩略图 #${width}px #${height}px](${thumbnail})`);
         }
       }
 
       if (url) {
-        lines.push(`[查看来源](${url})`);
-      }
-
-      if (index < results.length - 1) {
-        lines.push('***');
+        lines.push('', `[查看来源](${url})`);
       }
       return lines.join('\n');
     }),
   );
 
-  return ['## SauceNAO 搜图结果', '***', ...content].join('\n\n');
+  return [lines.join('\n'), ...content].join('\n***\n');
 }