@zhin.js/plugin-qrcode 1.1.6 → 1.1.8

package/README.md

@@ -5,24 +5,29 @@ Zhin.js plugin for qrcode functionality.
 ## Installation
 
 ```bash
-pnpm add @zhin.js/plugin-qrcode
+pnpm exec zhin install @zhin.js/plugin-qrcode
 ```
 
 ## Usage
 
-Add the plugin to your `zhin.config.yml`:
+Run the installation command from your application directory. It installs the package and mounts the `qrcode` instance in `package.json#zhin.plugins`. The corresponding `zhin.config.yml` node is:
 
 ```yaml
 plugins:
-  - @zhin.js/plugin-qrcode
+  qrcode: {}
 ```
 
-Or via CLI:
+## Configuration
 
-```bash
-zhin install @zhin.js/plugin-qrcode
-```
+This plugin currently has no configuration fields. Its [`schema.json`](./schema.json) accepts an empty object; do not place package names in a `plugins` array.
 
-## Configuration
+## Commands
+
+- `gen hello beautiful world`: generate a 300 × 300 QR image.
+- `gen hello --size 512` / `gen hello -s 512`: choose 64–1024 pixels.
+- `scan https://example.com/qr.png`: decode an existing QR image.
+- `gen --help`: show parameters, constraints and defaults.
 
-Configure in `zhin.config.yml` under the plugin's key. Refer to the plugin source for available options.
+The Endpoint determines any command prefix. An explicit `commandNamespace` adds a plugin
+namespace; neither is hardcoded in the command. Generation declares text length (1–2048)
+and image size in `defineCommand`; invalid values are rejected before creating the image.

package/commands/gen/index.js

@@ -0,0 +1,10 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { defineCommand } from 'zhin.js/command';
+import { raw } from '@zhin.js/core/runtime';
+import { buildQrImageUrl } from "../../lib/qrcode-lib.js";
+export default defineCommand({
+    description: '根据文本或链接生成二维码图片',
+    params: { text: { type: 'text', min: 1, max: 2048, description: '二维码内容（可含空格）' } },
+    options: { size: { type: 'integer', alias: 's', default: 300, min: 64, max: 1024, description: '图片宽高（像素）' } },
+    execute: ({ params, options }) => raw({ type: 'image', data: { url: buildQrImageUrl(params.text, options.size) } }),
+});

package/commands/gen/index.ts

@@ -0,0 +1,10 @@
+import { defineCommand } from 'zhin.js/command';
+import { raw } from '@zhin.js/core/runtime';
+import { buildQrImageUrl } from '../../src/qrcode-lib.js';
+
+export default defineCommand({
+  description: '根据文本或链接生成二维码图片',
+  params: { text: { type: 'text', min: 1, max: 2048, description: '二维码内容（可含空格）' } },
+  options: { size: { type: 'integer', alias: 's', default: 300, min: 64, max: 1024, description: '图片宽高（像素）' } },
+  execute: ({ params, options }) => raw({ type: 'image', data: { url: buildQrImageUrl(params.text, options.size) } }),
+});

package/lib/qrcode-lib.js

@@ -1,6 +1,8 @@
 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 buildQrImageUrl(text, size = 300) {
+    if (!Number.isInteger(size) || size < 64 || size > 1024)
+        throw new TypeError('QR size must be an integer between 64 and 1024');
+    return `${QR_API_BASE}/create-qr-code/?size=${size}x${size}&data=${encodeURIComponent(text)}`;
 }
 export function qrImageSegment(text) {
     const qrUrl = buildQrImageUrl(text);

package/lib/qrcode-lib.js.map

@@ -1 +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"}
+{"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,EAAE,IAAI,GAAG,GAAG;IACtD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,EAAE,IAAI,IAAI,GAAG,IAAI;QAAE,MAAM,IAAI,SAAS,CAAC,gDAAgD,CAAC,CAAC;IAC/H,OAAO,GAAG,WAAW,yBAAyB,IAAI,IAAI,IAAI,SAAS,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;AAChG,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": "1.1.6",
+  "version": "1.1.8",
   "description": "QR code generator & reader plugin for Zhin.js (Plugin Runtime)",
   "type": "module",
   "main": "./lib/index.js",
@@ -38,20 +38,20 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@zhin.js/core": "1.1.41",
-    "@zhin.js/tool": "1.1.4",
-    "@zhin.js/skill": "1.1.4"
+    "@zhin.js/core": "1.1.43",
+    "@zhin.js/tool": "1.1.5",
+    "@zhin.js/skill": "1.1.5"
   },
   "devDependencies": {
     "typescript": "^6.0.3",
     "vitest": "^4.1.10",
     "zod": "^4.4.3",
-    "zhin.js": "1.1.6"
+    "zhin.js": "1.1.8"
   },
   "peerDependencies": {
     "zod": "^4.0.0",
-    "@zhin.js/command": "^1.1.5",
-    "zhin.js": "^1.1.6"
+    "@zhin.js/command": "^1.1.6",
+    "zhin.js": "^1.1.8"
   },
   "peerDependenciesMeta": {
     "@zhin.js/command": {

package/src/qrcode-lib.ts

@@ -1,7 +1,8 @@
 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 buildQrImageUrl(text: string, size = 300): string {
+  if (!Number.isInteger(size) || size < 64 || size > 1024) throw new TypeError('QR size must be an integer between 64 and 1024');
+  return `${QR_API_BASE}/create-qr-code/?size=${size}x${size}&data=${encodeURIComponent(text)}`;
 }
 
 export function qrImageSegment(text: string) {

package/commands/gen/[text]/index.js

@@ -1,16 +0,0 @@
-// Generated by build-plugin-runtime-entries.mjs. Do not edit.
-import { defineCommand } from 'zhin.js/command';
-import { raw } from '@zhin.js/core/runtime';
-import { buildQrImageUrl } from "../../../lib/qrcode-lib.js";
-export default defineCommand({
-    description: '根据文本或链接生成二维码图片',
-    params: { text: { type: 'string' } },
-    execute: ({ params, args }) => {
-        // [text] 单动态段只消费一个词；含空格的文本需拼上剩余 args
-        const text = [String(params.text ?? ''), ...args].join(' ').trim();
-        return raw({
-            type: 'image',
-            data: { url: buildQrImageUrl(text) },
-        });
-    },
-});

package/commands/gen/[text]/index.ts

@@ -1,16 +0,0 @@
-import { defineCommand } from 'zhin.js/command';
-import { raw } from '@zhin.js/core/runtime';
-import { buildQrImageUrl } from '../../../src/qrcode-lib.js';
-
-export default defineCommand({
-  description: '根据文本或链接生成二维码图片',
-  params: { text: { type: 'string' } },
-  execute: ({ params, args }) => {
-    // [text] 单动态段只消费一个词；含空格的文本需拼上剩余 args
-    const text = [String(params.text ?? ''), ...args].join(' ').trim();
-    return raw({
-      type: 'image',
-      data: { url: buildQrImageUrl(text) },
-    });
-  },
-});