@zhin.js/plugin-link-poster 1.0.0 → 1.1.0

package/README.md

@@ -0,0 +1,28 @@
+# @zhin.js/plugin-link-poster
+
+Zhin.js plugin for link-poster functionality.
+
+## Installation
+
+```bash
+pnpm add @zhin.js/plugin-link-poster
+```
+
+## Usage
+
+Add the plugin to your `zhin.config.yml`:
+
+```yaml
+plugins:
+  - @zhin.js/plugin-link-poster
+```
+
+Or via CLI:
+
+```bash
+zhin install @zhin.js/plugin-link-poster
+```
+
+## Configuration
+
+Configure in `zhin.config.yml` under the plugin's key. Refer to the plugin source for available options.

package/agent/skills/link-poster.md

@@ -0,0 +1,37 @@
+---
+name: link-poster
+description: >-
+  链接海报卡片：自动识别消息中的 Bilibili、GitHub、抖音、小红书链接，
+  生成精美预览卡片图片。纯中间件自动触发，无 AI 工具。
+keywords:
+  - link
+  - poster
+  - 链接
+  - 卡片
+  - bilibili
+  - github
+  - douyin
+  - 抖音
+  - xiaohongshu
+  - 小红书
+  - preview
+  - 预览
+tags:
+  - link-poster
+  - media
+  - social
+tools: []
+---
+
+# 链接海报卡片
+
+中间件自动检测消息中的链接，生成预览卡片。无 AI 工具可调用。
+
+## 支持平台
+
+- **Bilibili**：视频/专栏 → 封面 + 标题 + UP 主
+- **GitHub**：仓库/Issue/PR → Star 数 + 描述
+- **抖音**：短视频 → 封面 + 标题
+- **小红书**：笔记 → 封面 + 标题
+
+依赖 `@zhin.js/html-renderer` 将 HTML 模板渲染为图片（`pnpm add @zhin.js/html-renderer`）。

package/lib/index.d.ts

@@ -1,17 +1,4 @@
-declare module 'zhin.js' {
-    namespace Plugin {
-        interface Contexts {
-            'html-renderer': {
-                render(html: string, options?: {
-                    width?: number;
-                }): Promise<{
-                    data: Buffer | string;
-                    format: string;
-                    mimeType: string;
-                }>;
-            };
-        }
-    }
-}
-export {};
+export { detectAndParse } from './platforms.js';
+export { renderPoster } from './render.js';
+export { getLinkPosterRenderer, resetLinkPosterRenderer } from './renderer-store.js';
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAaA,OAAO,QAAQ,SAAS,CAAC;IACvB,UAAU,MAAM,CAAC;QACf,UAAU,QAAQ;YAChB,eAAe,EAAE;gBACf,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;oBAAE,KAAK,CAAC,EAAE,MAAM,CAAA;iBAAE,GAAG,OAAO,CAAC;oBAC1D,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;oBACrB,MAAM,EAAE,MAAM,CAAA;oBACd,QAAQ,EAAE,MAAM,CAAA;iBACjB,CAAC,CAAA;aACH,CAAA;SACF;KACF;CACF"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC"}

package/lib/index.js

@@ -1,38 +1,4 @@
-/**
- * @zhin.js/plugin-link-poster
- *
- * 自动检测消息中的 Bilibili / GitHub / 抖音 / 小红书链接，
- * 生成精美内容海报图片并回复。
- *
- * 依赖：@zhin.js/plugin-html-renderer（提供 html-renderer Context）
- */
-import { formatCompact, segment, usePlugin } from 'zhin.js';
-import { detectAndParse } from './platforms.js';
-import { renderPoster } from './render.js';
-const { addMiddleware, useContext, logger } = usePlugin();
-useContext('html-renderer', (renderer) => {
-    logger.info(formatCompact({ op: 'load' }));
-    addMiddleware(async (message, next) => {
-        const text = message.$raw || '';
-        // 快速跳过：消息中没有 http 链接
-        if (!text.includes('http'))
-            return next();
-        try {
-            const meta = await detectAndParse(text);
-            if (meta) {
-                const html = renderPoster(meta);
-                const result = await renderer.render(html, { width: 480 });
-                if (result.format === 'png' && typeof result.data === 'object') {
-                    const base64 = Buffer.from(result.data).toString('base64');
-                    const dataUrl = `data:${result.mimeType};base64,${base64}`;
-                    await message.$reply(segment('image', { url: dataUrl }));
-                }
-            }
-        }
-        catch (e) {
-            logger.warn(formatCompact({ op: 'render', ok: false, error: e instanceof Error ? e.message : String(e) }));
-        }
-        return next();
-    });
-});
+export { detectAndParse } from './platforms.js';
+export { renderPoster } from './render.js';
+export { getLinkPosterRenderer, resetLinkPosterRenderer } from './renderer-store.js';
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAiB1C,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,SAAS,EAAE,CAAA;AAEzD,UAAU,CAAC,eAAe,EAAE,CAAC,QAAQ,EAAE,EAAE;IACvC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAE,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAA;IAE3C,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;QACpC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,EAAE,CAAA;QAE/B,qBAAqB;QACrB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;YAAE,OAAO,IAAI,EAAE,CAAA;QAEzC,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,CAAA;YACvC,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;gBAC/B,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;gBAE1D,IAAI,MAAM,CAAC,MAAM,KAAK,KAAK,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC/D,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAc,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;oBACpE,MAAM,OAAO,GAAG,QAAQ,MAAM,CAAC,QAAQ,WAAW,MAAM,EAAE,CAAA;oBAC1D,MAAM,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;gBAC1D,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,CAAC,IAAI,CAAC,aAAa,CAAE,EAAE,EAAE,EAAE,QAAQ,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;QAC7G,CAAC;QAED,OAAO,IAAI,EAAE,CAAA;IACf,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC"}

package/lib/renderer-store.d.ts

@@ -0,0 +1,4 @@
+import { type HtmlRendererService } from '@zhin.js/html-renderer';
+export declare function getLinkPosterRenderer(): HtmlRendererService;
+export declare function resetLinkPosterRenderer(): void;
+//# sourceMappingURL=renderer-store.d.ts.map

package/lib/renderer-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderer-store.d.ts","sourceRoot":"","sources":["../src/renderer-store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,KAAK,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAItF,wBAAgB,qBAAqB,IAAI,mBAAmB,CAG3D;AAED,wBAAgB,uBAAuB,IAAI,IAAI,CAE9C"}

package/lib/renderer-store.js

@@ -0,0 +1,11 @@
+import { createHtmlRenderer } from '@zhin.js/html-renderer';
+let _renderer = null;
+export function getLinkPosterRenderer() {
+    if (!_renderer)
+        _renderer = createHtmlRenderer();
+    return _renderer;
+}
+export function resetLinkPosterRenderer() {
+    _renderer = null;
+}
+//# sourceMappingURL=renderer-store.js.map

package/lib/renderer-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderer-store.js","sourceRoot":"","sources":["../src/renderer-store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAA4B,MAAM,wBAAwB,CAAC;AAEtF,IAAI,SAAS,GAA+B,IAAI,CAAC;AAEjD,MAAM,UAAU,qBAAqB;IACnC,IAAI,CAAC,SAAS;QAAE,SAAS,GAAG,kBAAkB,EAAE,CAAC;IACjD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,uBAAuB;IACrC,SAAS,GAAG,IAAI,CAAC;AACnB,CAAC"}

package/middlewares/link-poster.js

@@ -0,0 +1,38 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { defineMiddleware } from 'zhin.js/middleware';
+import { detectAndParse } from "../lib/platforms.js";
+import { renderPoster } from "../lib/render.js";
+import { getLinkPosterRenderer } from "../lib/renderer-store.js";
+/**
+ * Detect Bilibili / GitHub / Douyin / Xiaohongshu links and reply with a poster image.
+ * Uses Runtime Message.content (legacy used $raw).
+ */
+export default defineMiddleware({
+    target: 'inbound',
+    async handle(context, next) {
+        const text = typeof context.input.content === 'string'
+            ? context.input.content
+            : '';
+        if (!text.includes('http')) {
+            await next();
+            return;
+        }
+        try {
+            const meta = await detectAndParse(text);
+            if (meta) {
+                const html = renderPoster(meta);
+                const result = await getLinkPosterRenderer().render(html, { width: 480 });
+                if (result.format === 'png' && typeof result.data === 'object') {
+                    const base64 = Buffer.from(result.data).toString('base64');
+                    const dataUrl = `data:${result.mimeType};base64,${base64}`;
+                    await context.input.$reply([{ type: 'image', data: { url: dataUrl } }]);
+                }
+            }
+        }
+        catch (e) {
+            // keep pipeline moving on poster failures, but do not swallow silently
+            console.warn(`[link-poster] render failed: ${e instanceof Error ? e.message : String(e)}`);
+        }
+        await next();
+    },
+});

package/middlewares/link-poster.ts

@@ -0,0 +1,41 @@
+import { defineMiddleware } from 'zhin.js/middleware';
+import type { Message } from '@zhin.js/core/runtime';
+import { detectAndParse } from '../src/platforms.js';
+import { renderPoster } from '../src/render.js';
+import { getLinkPosterRenderer } from '../src/renderer-store.js';
+
+/**
+ * Detect Bilibili / GitHub / Douyin / Xiaohongshu links and reply with a poster image.
+ * Uses Runtime Message.content (legacy used $raw).
+ */
+export default defineMiddleware<Message>({
+  target: 'inbound',
+  async handle(context, next) {
+    const text = typeof context.input.content === 'string'
+      ? context.input.content
+      : '';
+
+    if (!text.includes('http')) {
+      await next();
+      return;
+    }
+
+    try {
+      const meta = await detectAndParse(text);
+      if (meta) {
+        const html = renderPoster(meta);
+        const result = await getLinkPosterRenderer().render(html, { width: 480 });
+        if (result.format === 'png' && typeof result.data === 'object') {
+          const base64 = Buffer.from(result.data as Buffer).toString('base64');
+          const dataUrl = `data:${result.mimeType};base64,${base64}`;
+          await context.input.$reply([{ type: 'image', data: { url: dataUrl } }]);
+        }
+      }
+    } catch (e) {
+      // keep pipeline moving on poster failures, but do not swallow silently
+      console.warn(`[link-poster] render failed: ${e instanceof Error ? e.message : String(e)}`);
+    }
+
+    await next();
+  },
+});

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zhin.js/plugin-link-poster",
-  "version": "1.0.0",
-  "description": "Auto-detect Bilibili/GitHub/Douyin/Xiaohongshu links and generate beautiful poster cards",
+  "version": "1.1.0",
+  "description": "Auto-detect link posters for Zhin.js (Plugin Runtime)",
   "type": "module",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -14,8 +14,12 @@
     "./package.json": "./package.json"
   },
   "files": [
+    "plugin.js",
+    "schema.json",
+    "middlewares",
     "src",
     "lib",
+    "agent",
     "README.md"
   ],
   "keywords": [
@@ -35,13 +39,14 @@
     "url": "https://github.com/lc-cn"
   },
   "license": "MIT",
-  "dependencies": {},
+  "dependencies": {
+    "@zhin.js/core": "1.1.35",
+    "@zhin.js/html-renderer": "1.1.0"
+  },
   "devDependencies": {
     "typescript": "^6.0.3",
-    "zhin.js": "2.0.0"
-  },
-  "peerDependencies": {
-    "zhin.js": "2.0.0"
+    "vitest": "^4.1.10",
+    "zhin.js": "1.1.0"
   },
   "repository": {
     "type": "git",
@@ -52,8 +57,35 @@
     "access": "public",
     "registry": "https://registry.npmjs.org"
   },
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "zhin": {
+    "protocol": 1,
+    "type": "plugin",
+    "entry": "./plugin.js",
+    "engine": "^1.0.0",
+    "runtime": "trusted",
+    "features": [
+      {
+        "package": "@zhin.js/middleware",
+        "api": "^1.0.0"
+      }
+    ],
+    "plugins": []
+  },
+  "peerDependencies": {
+    "@zhin.js/middleware": "^1.1.0",
+    "zhin.js": "^1.1.0"
+  },
+  "peerDependenciesMeta": {
+    "@zhin.js/middleware": {
+      "optional": true
+    }
+  },
   "scripts": {
-    "build": "tsc --build",
-    "clean": "rimraf lib"
+    "build": "tsc",
+    "clean": "rimraf lib",
+    "test": "NODE_OPTIONS=--experimental-strip-types vitest run --root ../../.. plugins/utils/link-poster/tests"
   }
 }

package/plugin.js

@@ -0,0 +1,8 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { definePlugin } from 'zhin.js';
+export default definePlugin({
+    name: 'link-poster',
+    metadata: {
+        displayName: 'Link Poster',
+    },
+});

package/schema.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {}
+}

package/src/index.ts

@@ -1,57 +1,3 @@
-/**
- * @zhin.js/plugin-link-poster
- *
- * 自动检测消息中的 Bilibili / GitHub / 抖音 / 小红书链接，
- * 生成精美内容海报图片并回复。
- *
- * 依赖：@zhin.js/plugin-html-renderer（提供 html-renderer Context）
- */
-import { formatCompact, segment, usePlugin } from 'zhin.js'
-import { detectAndParse } from './platforms.js'
-import { renderPoster } from './render.js'
-
-// html-renderer Context 的最小类型声明（运行时由 html-renderer 插件注入）
-declare module 'zhin.js' {
-  namespace Plugin {
-    interface Contexts {
-      'html-renderer': {
-        render(html: string, options?: { width?: number }): Promise<{
-          data: Buffer | string
-          format: string
-          mimeType: string
-        }>
-      }
-    }
-  }
-}
-
-const { addMiddleware, useContext, logger } = usePlugin()
-
-useContext('html-renderer', (renderer) => {
-  logger.info(formatCompact( { op: 'load' }))
-
-  addMiddleware(async (message, next) => {
-    const text = message.$raw || ''
-
-    // 快速跳过：消息中没有 http 链接
-    if (!text.includes('http')) return next()
-
-    try {
-      const meta = await detectAndParse(text)
-      if (meta) {
-        const html = renderPoster(meta)
-        const result = await renderer.render(html, { width: 480 })
-
-        if (result.format === 'png' && typeof result.data === 'object') {
-          const base64 = Buffer.from(result.data as Buffer).toString('base64')
-          const dataUrl = `data:${result.mimeType};base64,${base64}`
-          await message.$reply(segment('image', { url: dataUrl }))
-        }
-      }
-    } catch (e) {
-      logger.warn(formatCompact( { op: 'render', ok: false, error: e instanceof Error ? e.message : String(e) }))
-    }
-
-    return next()
-  })
-})
+export { detectAndParse } from './platforms.js';
+export { renderPoster } from './render.js';
+export { getLinkPosterRenderer, resetLinkPosterRenderer } from './renderer-store.js';

package/src/renderer-store.ts

@@ -0,0 +1,12 @@
+import { createHtmlRenderer, type HtmlRendererService } from '@zhin.js/html-renderer';
+
+let _renderer: HtmlRendererService | null = null;
+
+export function getLinkPosterRenderer(): HtmlRendererService {
+  if (!_renderer) _renderer = createHtmlRenderer();
+  return _renderer;
+}
+
+export function resetLinkPosterRenderer(): void {
+  _renderer = null;
+}