@zhin.js/adapter-line 0.1.0

package/lib/types.d.ts

@@ -0,0 +1,112 @@
+/**
+ * LINE Messaging API 类型定义
+ */
+export interface LineEndpointConfig {
+    context: 'line';
+    name: string;
+    channelSecret: string;
+    channelAccessToken: string;
+    webhookPath?: string;
+    apiBaseUrl?: string;
+}
+export interface LineUser {
+    userId: string;
+    displayName?: string;
+    pictureUrl?: string;
+    statusMessage?: string;
+}
+export interface LineMessageEvent {
+    type: 'message';
+    replyToken: string;
+    source: LineSource;
+    timestamp: number;
+    message: LineMessage;
+}
+export interface LineFollowEvent {
+    type: 'follow';
+    replyToken: string;
+    source: LineSource;
+    timestamp: number;
+}
+export interface LineUnfollowEvent {
+    type: 'unfollow';
+    source: LineSource;
+    timestamp: number;
+}
+export interface LineJoinEvent {
+    type: 'join';
+    replyToken: string;
+    source: LineSource;
+    timestamp: number;
+}
+export interface LineLeaveEvent {
+    type: 'leave';
+    source: LineSource;
+    timestamp: number;
+}
+export interface LinePostbackEvent {
+    type: 'postback';
+    replyToken: string;
+    source: LineSource;
+    timestamp: number;
+    postback: {
+        data: string;
+        params?: Record<string, string>;
+    };
+}
+export type LineEvent = LineMessageEvent | LineFollowEvent | LineUnfollowEvent | LineJoinEvent | LineLeaveEvent | LinePostbackEvent;
+export interface LineSource {
+    type: 'user' | 'group' | 'room';
+    userId?: string;
+    groupId?: string;
+    roomId?: string;
+}
+export interface LineMessage {
+    id: string;
+    type: 'text' | 'image' | 'video' | 'audio' | 'file' | 'location' | 'sticker';
+    text?: string;
+    fileName?: string;
+    fileSize?: number;
+    title?: string;
+    address?: string;
+    latitude?: number;
+    longitude?: number;
+    packageId?: string;
+    stickerId?: string;
+    stickerResourceType?: string;
+    duration?: number;
+}
+export interface LineWebhookBody {
+    destination: string;
+    events: LineEvent[];
+}
+export interface LineReplyMessage {
+    type: 'text' | 'image' | 'video' | 'audio' | 'location' | 'sticker' | 'flex';
+    text?: string;
+    originalContentUrl?: string;
+    previewImageUrl?: string;
+    packageId?: string;
+    stickerId?: string;
+    title?: string;
+    address?: string;
+    latitude?: number;
+    longitude?: number;
+    duration?: number;
+    altText?: string;
+    contents?: Record<string, unknown>;
+}
+export interface LineReplyRequest {
+    replyToken: string;
+    messages: LineReplyMessage[];
+}
+export interface LinePushRequest {
+    to: string;
+    messages: LineReplyMessage[];
+}
+export interface LineApiResponse {
+    sentMessages?: Array<{
+        id: string;
+        quoteToken?: string;
+    }>;
+}
+//# sourceMappingURL=types.d.ts.map

package/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,EAAE,MAAM,CAAA;IACrB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,SAAS,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,UAAU,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,WAAW,CAAA;CACrB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,QAAQ,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,UAAU,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,UAAU,CAAA;IAChB,MAAM,EAAE,UAAU,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,UAAU,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,OAAO,CAAA;IACb,MAAM,EAAE,UAAU,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,UAAU,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,UAAU,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE;QACR,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAChC,CAAA;CACF;AAED,MAAM,MAAM,SAAS,GACjB,gBAAgB,GAChB,eAAe,GACf,iBAAiB,GACjB,aAAa,GACb,cAAc,GACd,iBAAiB,CAAA;AAErB,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,CAAA;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,GAAG,SAAS,CAAA;IAC5E,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,SAAS,EAAE,CAAA;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,UAAU,GAAG,SAAS,GAAG,MAAM,CAAA;IAC5E,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,gBAAgB,EAAE,CAAA;CAC7B;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,gBAAgB,EAAE,CAAA;CAC7B;AAED,MAAM,WAAW,eAAe;IAC9B,YAAY,CAAC,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;CAC1D"}

package/lib/types.js

@@ -0,0 +1,5 @@
+/**
+ * LINE Messaging API 类型定义
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@zhin.js/adapter-line",
+  "version": "0.1.0",
+  "description": "Zhin.js adapter for LINE Messaging API",
+  "type": "module",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "development": "./src/index.ts",
+      "import": "./lib/index.js"
+    }
+  },
+  "keywords": [
+    "zhin",
+    "zhin.js",
+    "bot",
+    "adapter",
+    "line",
+    "chatbot"
+  ],
+  "author": {
+    "name": "lc-cn",
+    "email": "admin@liucl.cn",
+    "url": "https://github.com/lc-cn"
+  },
+  "license": "MIT",
+  "repository": {
+    "url": "git+https://github.com/zhinjs/zhin.git",
+    "type": "git",
+    "directory": "plugins/adapters/line"
+  },
+  "devDependencies": {
+    "@types/node": "^25.9.2",
+    "typescript": "^6.0.3",
+    "@zhin.js/cli": "1.0.89",
+    "@zhin.js/host-api": "1.0.1",
+    "@zhin.js/host-router": "1.0.1",
+    "@zhin.js/logger": "0.1.71",
+    "zhin.js": "2.0.1"
+  },
+  "peerDependencies": {
+    "@zhin.js/host-api": "1.0.1",
+    "@zhin.js/host-router": "1.0.1",
+    "@zhin.js/logger": "0.1.71",
+    "zhin.js": "2.0.1"
+  },
+  "peerDependenciesMeta": {
+    "@zhin.js/host-router": {
+      "optional": true
+    },
+    "@zhin.js/host-api": {
+      "optional": true
+    }
+  },
+  "files": [
+    "src",
+    "lib",
+    "skills",
+    "plugin.yml",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "scripts": {
+    "build": "zhin build",
+    "clean": "rimraf lib dist",
+    "build:node": "tsc"
+  }
+}

package/plugin.yml

@@ -0,0 +1,3 @@
+name: adapter-line
+description: LINE Messaging API 适配器：Webhook 接收、Reply/Push 发送、签名验证
+version: 0.1.0

package/skills/line/PERMITS.md

@@ -0,0 +1,17 @@
+# LINE 适配器权限说明
+
+LINE Messaging API 适配器本身不涉及平台级权限检查（LINE 没有类似 Telegram 的 ChatMember 权限模型）。
+
+## 平台权限
+
+LINE 的权限模型通过 LINE Official Account Manager 管理，不在 bot 层面控制。
+所有发消息权限由 Channel Access Token 的 scope 决定。
+
+## 已知 scope
+
+| scope | 说明 |
+|-------|------|
+| `message` | 发送消息（Reply + Push） |
+| `profile` | 获取用户资料 |
+
+如需额外权限，请在 LINE Developers Console 的 Messaging API 设置中启用。

package/skills/line/SKILL.md

@@ -0,0 +1,39 @@
+---
+name: line
+platforms:
+  - line
+description: >-
+  LINE Messaging API 适配器技能。当用户在 LINE 私聊或群组中发送消息时，
+  框架通过 Webhook 接收并处理。支持文本、图片、视频、音频、文件、位置、贴纸
+  等消息类型。回复消息使用 Reply API（自动引用上下文），主动发送使用 Push API。
+keywords:
+  - line
+  - adapter:line
+  - messaging-api
+  - webhook
+tags:
+  - im
+  - adapter
+---
+# LINE Messaging API 技能
+
+LINE 的 Messaging API 基于 Webhook 模式：平台将事件 POST 到指定 URL，适配器签名验证后处理。
+
+## 消息接收
+
+- 文本消息：直接转发为 text segment
+- 媒体消息（image/video/audio/file）：包含 message_id，可通过 Content API 获取
+- 位置消息：包含经纬度和地址
+- 贴纸消息：包含 packageId 和 stickerId
+
+## 消息发送
+
+- **Reply API**：有 replyToken 时自动使用，回复会关联原始消息
+- **Push API**：无 replyToken 时使用，主动推送到 userId/groupId/roomId
+- 单次最多 5 条消息，单条文本最多 5000 字符
+
+## 限制
+
+- 不支持消息撤回
+- 不支持已读回执（read receipt）
+- 媒体消息仅提供 message_id，需额外 API 调用获取内容

package/src/adapter.ts

@@ -0,0 +1,29 @@
+/**
+ * LINE 适配器
+ */
+import {
+  Adapter,
+  Plugin,
+} from "zhin.js";
+import { LineEndpoint } from "./endpoint.js";
+import type { LineEndpointConfig } from "./types.js";
+import type { Router } from "@zhin.js/host-router/router";
+
+export class LineAdapter extends Adapter<LineEndpoint> {
+  static override readonly capabilities = ['inbound', 'outbound'] as const;
+
+  #router: Router;
+
+  constructor(plugin: Plugin, router: Router) {
+    super(plugin, "line", []);
+    this.#router = router;
+  }
+
+  createEndpoint(config: LineEndpointConfig): LineEndpoint {
+    return new LineEndpoint(this, this.#router, config);
+  }
+
+  async start(): Promise<void> {
+    await super.start();
+  }
+}