Platform Adapters
Adapters connect IM / chat platforms to the Zhin.js core. Each @zhin.js/adapter-* package has its own documentation page, kept in sync with the in-package README.md (pnpm sync:adapter-docs).
For framework-level concepts (multi-platform concurrency, message flow, endpoint lifecycle), see Core Concepts and Endpoint Lifecycle.
Tier SSOT:
scripts/adapter-meta.mjs(same source as docs/snippets/platform-tiers.md).
Tiers
| Tier | Meaning |
|---|---|
| Stable | Consistent with pnpm check:stable and minimal-bot |
| Platform Stable | Mainstream IM; must satisfy ADR 0015 D3 and enter the check:stable Platform batch (currently none) |
| Advanced | Commonly used by the test-bot maintainer kitchen sink (not a user template); has integration tests but not in the Stable smoke |
| Experimental | Usability varies greatly by deployment; requires self-verification; does not mean untested, just no full CI / real-device guarantee |
Stable
| Adapter | Package | Endpoint Management Capabilities | Docs |
|---|---|---|---|
| Sandbox | @zhin.js/adapter-sandbox | — | Sandbox |
Platform Stable
(Currently none)
Advanced
| Adapter | Package | Endpoint Management Capabilities | Docs |
|---|---|---|---|
| DingTalk | @zhin.js/adapter-dingtalk | — | DingTalk |
| Lark | @zhin.js/adapter-lark | — | Lark |
| WeChat Official Account | @zhin.js/adapter-wechat-mp | — | WeChat Official Account |
| Discord | @zhin.js/adapter-discord | — | Discord |
| ICQQ (QQ) | @zhin.js/adapter-icqq | listFriends, listGroups, listChannels, listGroupMembers, approveRequest, rejectRequest, kickGroupMember, muteGroupMember, setGroupAdmin, deleteFriend | ICQQ (QQ) |
| KOOK | @zhin.js/adapter-kook | — | KOOK |
| OneBot v11 | @zhin.js/adapter-onebot11 | — | OneBot v11 |
| QQ Official | @zhin.js/adapter-qq | listChannels | QQ Official |
| Slack | @zhin.js/adapter-slack | — | Slack |
| Telegram | @zhin.js/adapter-telegram | — | Telegram |
Experimental
| Adapter | Package | Endpoint Management Capabilities | Docs |
|---|---|---|---|
| WeCom | @zhin.js/adapter-wecom | — | WeCom |
| WeChat iLink | @zhin.js/adapter-weixin-ilink | — | WeChat iLink |
@zhin.js/adapter-email | — | ||
| GitHub | @zhin.js/adapter-github | — | GitHub |
| LINE | @zhin.js/adapter-line | — | LINE |
| Milky | @zhin.js/adapter-milky | — | Milky |
| NapCat | @zhin.js/adapter-napcat | — | NapCat |
| OneBot v12 | @zhin.js/adapter-onebot12 | — | OneBot v12 |
| Satori | @zhin.js/adapter-satori | — | Satori |
Maintenance Notes
- Single source of truth (tiers):
scripts/adapter-meta.mjs - Single source of truth (content):
plugins/adapters/<name>/README.md - Sync command: Run
pnpm sync:adapter-docsfrom the repository root - CI checks:
pnpm check:adapter-docs,pnpm check:platform-tiers-ssot
Source index: plugins/adapters/README.md