@zhin.js/plugin-qrcode 3.0.0 → 3.0.2

package/agent/skills/qrcode.md

@@ -0,0 +1,38 @@
+---
+name: qrcode
+description: >-
+  二维码生成能力。当用户想把文本或 URL 转成二维码图片时使用。
+  用户说「生成个二维码」「帮我做个二维码」或给了一个链接想生成二维码时应触发。
+keywords:
+  - qrcode
+  - 二维码
+  - QR
+  - 扫码
+  - 生成
+tags:
+  - qrcode
+  - utility
+tools:
+  - qrcode_generate
+---
+
+# 二维码生成技能
+
+## 工具
+
+| 工具 | 用途 | 参数 |
+|------|------|------|
+| `qrcode_generate` | 生成二维码图片 | `text`（要编码的文本或 URL） |
+
+**Example:**
+```
+用户: 把这个链接做成二维码 https://example.com
+→ qrcode_generate(text="https://example.com")
+```
+
+生成 300×300 像素的 PNG 图片，支持任意文本和 URL。
+
+## 注意
+
+- 二维码扫描功能通过聊天命令 `扫码 <url>` 使用，不是 AI 工具。
+- 文本过长可能导致二维码密度过高、难以扫描。建议先 `short_url` 缩短链接再生成。

package/agent/tools/qrcode_generate.ts

@@ -0,0 +1,14 @@
+import { defineTool } from '@zhin.js/agent/tools';
+import { z } from 'zod';
+import { buildQrImageUrl } from '../../src/qrcode-lib.js';
+
+export default defineTool<{ text: string }>({
+  description: '根据文本或 URL 生成二维码图片',
+  inputSchema: z.object({ text: z.string().min(1) }),
+  keywords: ['二维码', 'QR', 'qrcode'],
+  tags: ['qrcode', 'image'],
+  async execute({ text }) {
+    const qrUrl = buildQrImageUrl(text);
+    return JSON.stringify([{ type: 'image', data: { url: qrUrl } }]);
+  },
+});

package/lib/agent/tools/qrcode_generate.js

@@ -0,0 +1,14 @@
+import { defineTool } from '@zhin.js/agent/tools';
+import { z } from 'zod';
+import { buildQrImageUrl } from '../../src/qrcode-lib.js';
+export default defineTool({
+    description: '根据文本或 URL 生成二维码图片',
+    inputSchema: z.object({ text: z.string().min(1) }),
+    keywords: ['二维码', 'QR', 'qrcode'],
+    tags: ['qrcode', 'image'],
+    async execute({ text }) {
+        const qrUrl = buildQrImageUrl(text);
+        return JSON.stringify([{ type: 'image', data: { url: qrUrl } }]);
+    },
+});
+//# sourceMappingURL=qrcode_generate.js.map

package/lib/agent/tools/qrcode_generate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"qrcode_generate.js","sourceRoot":"","sources":["../../../agent/tools/qrcode_generate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,eAAe,UAAU,CAAmB;IAC1C,WAAW,EAAE,mBAAmB;IAChC,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAClD,QAAQ,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,CAAC;IACjC,IAAI,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC;IACzB,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE;QACpB,MAAM,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;IACnE,CAAC;CACF,CAAC,CAAC"}

package/lib/{index.js → src/index.js}

@@ -1,16 +1,14 @@
-import { formatCompact, MessageCommand, usePlugin, ZhinTool } from 'zhin.js';
-const { addCommand, addTool, logger } = usePlugin();
+import { formatCompact, MessageCommand, usePlugin } from 'zhin.js';
+import { qrImageSegment } from './qrcode-lib.js';
+const { addCommand, logger } = usePlugin();
 const QR_API_BASE = 'https://api.qrserver.com/v1';
-// ====== 命令：二维码 <text> ======
 addCommand(new MessageCommand('二维码 <text:text>')
     .desc('根据文本或链接生成二维码图片')
     .action(async (_message, result) => {
     const text = result.params.text;
-    const qrUrl = `${QR_API_BASE}/create-qr-code/?size=300x300&data=${encodeURIComponent(text)}`;
     logger.debug(formatCompact({ op: 'generate', len: text.length }));
-    return [{ type: 'image', data: { url: qrUrl } }];
+    return qrImageSegment(text);
 }));
-// ====== 命令：扫码 <url> ======
 addCommand(new MessageCommand('扫码 <url:text>')
     .desc('识别图片中的二维码内容')
     .action(async (_message, result) => {
@@ -33,15 +31,4 @@ addCommand(new MessageCommand('扫码 <url:text>')
         return '二维码识别失败，请检查图片链接是否有效';
     }
 }));
-// ====== AI 工具：qrcode_generate ======
-addTool(new ZhinTool('qrcode_generate')
-    .desc('根据文本或 URL 生成二维码图片')
-    .keyword('二维码', 'QR', 'qrcode')
-    .tag('qrcode', 'image')
-    .param('text', { type: 'string', description: '要编码到二维码中的文本或 URL' }, true)
-    .execute(async (args) => {
-    const qrUrl = `${QR_API_BASE}/create-qr-code/?size=300x300&data=${encodeURIComponent(args.text)}`;
-    return JSON.stringify([{ type: 'image', data: { url: qrUrl } }]);
-})
-    .toTool());
 //# sourceMappingURL=index.js.map

package/lib/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,SAAS,EAAE,CAAC;AAE3C,MAAM,WAAW,GAAG,6BAA6B,CAAC;AAElD,UAAU,CACR,IAAI,cAAc,CAAC,iBAAiB,CAAC;KAClC,IAAI,CAAC,gBAAgB,CAAC;KACtB,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE;IACjC,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;IAChC,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAClE,OAAO,cAAc,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC,CAAC,CACL,CAAC;AAEF,UAAU,CACR,IAAI,cAAc,CAAC,eAAe,CAAC;KAChC,IAAI,CAAC,aAAa,CAAC;KACnB,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE;IACjC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC;IACnC,MAAM,MAAM,GAAG,GAAG,WAAW,0BAA0B,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC;IACtF,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,CAAC;QACrC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,OAAO,aAAa,CAAC;QACvB,CAAC;QACD,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAEjC,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;QACtC,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YAC5C,OAAO,YAAY,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QAC/D,CAAC;QACD,OAAO,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;IAC/B,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACzG,OAAO,qBAAqB,CAAC;IAC/B,CAAC;AACH,CAAC,CAAC,CACL,CAAC"}

package/lib/src/qrcode-lib.js

@@ -0,0 +1,9 @@
+const QR_API_BASE = 'https://api.qrserver.com/v1';
+export function buildQrImageUrl(text) {
+    return `${QR_API_BASE}/create-qr-code/?size=300x300&data=${encodeURIComponent(text)}`;
+}
+export function qrImageSegment(text) {
+    const qrUrl = buildQrImageUrl(text);
+    return [{ type: 'image', data: { url: qrUrl } }];
+}
+//# sourceMappingURL=qrcode-lib.js.map

package/lib/src/qrcode-lib.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"qrcode-lib.js","sourceRoot":"","sources":["../../src/qrcode-lib.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,GAAG,6BAA6B,CAAC;AAElD,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,OAAO,GAAG,WAAW,sCAAsC,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;AACxF,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,IAAY;IACzC,MAAM,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IACpC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAgB,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;AAC5D,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhin.js/plugin-qrcode",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "QR code generator & reader plugin for Zhin.js",
   "type": "module",
   "main": "./lib/index.js",
@@ -16,6 +16,7 @@
   "files": [
     "src",
     "lib",
+    "agent",
     "README.md"
   ],
   "keywords": [
@@ -32,13 +33,16 @@
     "url": "https://github.com/lc-cn"
   },
   "license": "MIT",
-  "dependencies": {},
   "devDependencies": {
     "typescript": "^6.0.3",
-    "zhin.js": "4.1.0"
+    "zod": "^4.4.3",
+    "zhin.js": "4.1.2",
+    "@zhin.js/agent": "1.0.3"
   },
   "peerDependencies": {
-    "zhin.js": "4.1.0"
+    "zod": "^4.0.0",
+    "zhin.js": "4.1.2",
+    "@zhin.js/agent": "1.0.3"
   },
   "repository": {
     "type": "git",
@@ -49,8 +53,17 @@
     "access": "public",
     "registry": "https://registry.npmjs.org"
   },
+  "peerDependenciesMeta": {
+    "@zhin.js/agent": {
+      "optional": true
+    },
+    "zod": {
+      "optional": true
+    }
+  },
   "scripts": {
-    "build": "tsc --build",
-    "clean": "rimraf lib"
+    "build": "tsc",
+    "clean": "rimraf lib",
+    "test": "sh -c 'cd ../../.. && vitest run plugins/utils/qrcode/tests'"
   }
 }

package/src/index.ts

@@ -1,58 +1,42 @@
-import { formatCompact, MessageCommand, usePlugin, ZhinTool } from 'zhin.js'
+import { formatCompact, MessageCommand, usePlugin } from 'zhin.js';
+import { qrImageSegment } from './qrcode-lib.js';
 
-const { addCommand, addTool, logger } = usePlugin()
+const { addCommand, logger } = usePlugin();
 
-const QR_API_BASE = 'https://api.qrserver.com/v1'
+const QR_API_BASE = 'https://api.qrserver.com/v1';
 
-// ====== 命令：二维码 <text> ======
 addCommand(
   new MessageCommand('二维码 <text:text>')
     .desc('根据文本或链接生成二维码图片')
     .action(async (_message, result) => {
-      const text = result.params.text
-      const qrUrl = `${QR_API_BASE}/create-qr-code/?size=300x300&data=${encodeURIComponent(text)}`
-      logger.debug(formatCompact( { op: 'generate', len: text.length }))
-      return [{ type: 'image' as const, data: { url: qrUrl } }]
+      const text = result.params.text;
+      logger.debug(formatCompact({ op: 'generate', len: text.length }));
+      return qrImageSegment(text);
     }),
-)
+);
 
-// ====== 命令：扫码 <url> ======
 addCommand(
   new MessageCommand('扫码 <url:text>')
     .desc('识别图片中的二维码内容')
     .action(async (_message, result) => {
-      const imageUrl = result.params.url
-      const apiUrl = `${QR_API_BASE}/read-qr-code/?fileurl=${encodeURIComponent(imageUrl)}`
+      const imageUrl = result.params.url;
+      const apiUrl = `${QR_API_BASE}/read-qr-code/?fileurl=${encodeURIComponent(imageUrl)}`;
       try {
-        const response = await fetch(apiUrl)
+        const response = await fetch(apiUrl);
         if (!response.ok) {
-          return '二维码识别服务请求失败'
+          return '二维码识别服务请求失败';
         }
         const data = (await response.json()) as Array<{
-          symbol: Array<{ data: string | null; error: string | null }>
-        }>
-        const symbol = data?.[0]?.symbol?.[0]
+          symbol: Array<{ data: string | null; error: string | null }>;
+        }>;
+        const symbol = data?.[0]?.symbol?.[0];
         if (!symbol || symbol.error || !symbol.data) {
-          return `未能识别二维码内容${symbol?.error ? `：${symbol.error}` : ''}`
+          return `未能识别二维码内容${symbol?.error ? `：${symbol.error}` : ''}`;
         }
-        return `识别结果：${symbol.data}`
+        return `识别结果：${symbol.data}`;
       } catch (e) {
-        logger.warn(formatCompact( { op: 'scan', ok: false, error: e instanceof Error ? e.message : String(e) }))
-        return '二维码识别失败，请检查图片链接是否有效'
+        logger.warn(formatCompact({ op: 'scan', ok: false, error: e instanceof Error ? e.message : String(e) }));
+        return '二维码识别失败，请检查图片链接是否有效';
       }
     }),
-)
-
-// ====== AI 工具：qrcode_generate ======
-addTool(
-  new ZhinTool('qrcode_generate')
-    .desc('根据文本或 URL 生成二维码图片')
-    .keyword('二维码', 'QR', 'qrcode')
-    .tag('qrcode', 'image')
-    .param('text', { type: 'string', description: '要编码到二维码中的文本或 URL' }, true)
-    .execute(async (args) => {
-      const qrUrl = `${QR_API_BASE}/create-qr-code/?size=300x300&data=${encodeURIComponent(args.text)}`
-      return JSON.stringify([{ type: 'image', data: { url: qrUrl } }])
-    })
-    .toTool(),
-)
+);

package/src/qrcode-lib.ts

@@ -0,0 +1,10 @@
+const QR_API_BASE = 'https://api.qrserver.com/v1';
+
+export function buildQrImageUrl(text: string): string {
+  return `${QR_API_BASE}/create-qr-code/?size=300x300&data=${encodeURIComponent(text)}`;
+}
+
+export function qrImageSegment(text: string) {
+  const qrUrl = buildQrImageUrl(text);
+  return [{ type: 'image' as const, data: { url: qrUrl } }];
+}

package/lib/index.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/lib/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAE5E,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,SAAS,EAAE,CAAA;AAEnD,MAAM,WAAW,GAAG,6BAA6B,CAAA;AAEjD,8BAA8B;AAC9B,UAAU,CACR,IAAI,cAAc,CAAC,iBAAiB,CAAC;KAClC,IAAI,CAAC,gBAAgB,CAAC;KACtB,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE;IACjC,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAA;IAC/B,MAAM,KAAK,GAAG,GAAG,WAAW,sCAAsC,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAA;IAC5F,MAAM,CAAC,KAAK,CAAC,aAAa,CAAE,EAAE,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;IAClE,OAAO,CAAC,EAAE,IAAI,EAAE,OAAgB,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAA;AAC3D,CAAC,CAAC,CACL,CAAA;AAED,4BAA4B;AAC5B,UAAU,CACR,IAAI,cAAc,CAAC,eAAe,CAAC;KAChC,IAAI,CAAC,aAAa,CAAC;KACnB,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE;IACjC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAA;IAClC,MAAM,MAAM,GAAG,GAAG,WAAW,0BAA0B,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAA;IACrF,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,CAAA;QACpC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,OAAO,aAAa,CAAA;QACtB,CAAC;QACD,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAEjC,CAAA;QACF,MAAM,MAAM,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAA;QACrC,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YAC5C,OAAO,YAAY,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;QAC9D,CAAC;QACD,OAAO,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAA;IAC9B,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,CAAC,IAAI,CAAC,aAAa,CAAE,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACzG,OAAO,qBAAqB,CAAA;IAC9B,CAAC;AACH,CAAC,CAAC,CACL,CAAA;AAED,sCAAsC;AACtC,OAAO,CACL,IAAI,QAAQ,CAAC,iBAAiB,CAAC;KAC5B,IAAI,CAAC,mBAAmB,CAAC;KACzB,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,CAAC;KAC9B,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC;KACtB,KAAK,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,kBAAkB,EAAE,EAAE,IAAI,CAAC;KACxE,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;IACtB,MAAM,KAAK,GAAG,GAAG,WAAW,sCAAsC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAA;IACjG,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAA;AAClE,CAAC,CAAC;KACD,MAAM,EAAE,CACZ,CAAA"}