@onebots/adapter-kook 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 凉菜
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,133 @@
+# @onebots/adapter-kook
+
+onebots KOOK (开黑了) 适配器
+
+## 简介
+
+这是一个用于 onebots 框架的 KOOK（原开黑了）平台适配器。KOOK 是一个面向游戏玩家的即时通讯平台，类似于 Discord。
+
+## 功能特性
+
+- ✅ WebSocket 和 Webhook 两种连接模式
+- ✅ 频道消息收发
+- ✅ 私聊消息收发
+- ✅ 服务器（公会）管理
+- ✅ 频道管理
+- ✅ 成员管理
+- ✅ 角色管理
+- ✅ 表情回应
+- ✅ 文件上传
+- ✅ KMarkdown 消息格式支持
+- ✅ 卡片消息支持
+
+## 安装
+
+```bash
+npm install @onebots/adapter-kook
+# 或
+pnpm add @onebots/adapter-kook
+```
+
+## 配置
+
+在配置文件中添加 KOOK 账号：
+
+```yaml
+accounts:
+  - platform: kook
+    account_id: your_bot_id
+    token: your_bot_token
+    mode: websocket  # 或 webhook
+    verifyToken: your_verify_token  # Webhook 模式需要
+    encryptKey: your_encrypt_key  # 可选，消息加密密钥
+```
+
+### 配置项说明
+
+| 配置项 | 类型 | 必填 | 说明 |
+|--------|------|------|------|
+| account_id | string | 是 | 机器人账号 ID |
+| token | string | 是 | 机器人 Token |
+| mode | string | 否 | 连接模式：`websocket`（默认）或 `webhook` |
+| verifyToken | string | 否 | Webhook 验证 Token |
+| encryptKey | string | 否 | 消息加密密钥 |
+
+## 获取 Token
+
+1. 访问 [KOOK 开发者平台](https://developer.kookapp.cn/)
+2. 创建应用并添加机器人
+3. 在机器人设置中获取 Token
+
+## 消息类型支持
+
+### 发送消息
+
+支持的消息段类型：
+- `text` - 文本消息
+- `at` - @用户/全体成员/在线成员
+- `image` - 图片消息
+- `face` - 表情
+
+### 接收消息
+
+支持的消息类型：
+- 文字消息
+- KMarkdown 消息
+- 图片消息
+- 视频消息
+- 文件消息
+- 音频消息
+- 卡片消息
+
+## API 支持
+
+### 消息相关
+- `sendMessage` - 发送消息
+- `deleteMessage` - 删除消息
+- `getMessage` - 获取消息
+- `updateMessage` - 更新消息
+
+### 用户相关
+- `getLoginInfo` - 获取机器人信息
+- `getUserInfo` - 获取用户信息
+- `getFriendList` - 获取私聊会话列表
+- `getFriendInfo` - 获取好友信息
+
+### 服务器相关
+- `getGroupList` - 获取服务器列表
+- `getGroupInfo` - 获取服务器信息
+- `leaveGroup` - 退出服务器
+- `getGroupMemberList` - 获取服务器成员列表
+- `getGroupMemberInfo` - 获取成员信息
+- `kickGroupMember` - 踢出成员
+- `setGroupCard` - 设置成员昵称
+
+### 频道相关
+- `getChannelList` - 获取频道列表
+- `getChannelInfo` - 获取频道信息
+- `createChannel` - 创建频道
+- `updateChannel` - 更新频道
+- `deleteChannel` - 删除频道
+- `getChannelMemberList` - 获取频道成员列表
+
+### 公会相关
+- `getGuildList` - 获取服务器列表
+- `getGuildInfo` - 获取服务器信息
+- `getGuildMemberInfo` - 获取成员信息
+
+## 事件支持
+
+### 消息事件
+- 频道消息
+- 私聊消息
+
+### 通知事件
+- 成员加入服务器
+- 成员离开服务器
+- 表情回应添加
+- 消息更新
+- 消息删除
+
+## 许可证
+
+MIT

package/lib/adapter.d.ts

@@ -0,0 +1,137 @@
+/**
+ * KOOK (开黑了) 适配器
+ * 继承 Adapter 基类，实现 KOOK 平台功能
+ * - 消息收发（sendMessage）
+ * - 服务器管理（getGroupList, getGroupInfo 等，对应 KOOK 的服务器）
+ * - 频道管理（getChannelList, getChannelInfo 等）
+ * - 用户管理（getFriendList, getUserInfo 等）
+ */
+import { Account } from "onebots";
+import { Adapter } from "onebots";
+import { BaseApp } from "onebots";
+import { KookBot } from "./bot.js";
+import type { KookConfig } from "./types.js";
+export declare class KookAdapter extends Adapter<KookBot, "kook"> {
+    constructor(app: BaseApp);
+    /**
+     * 发送消息
+     * KOOK 支持频道消息和私聊消息
+     */
+    sendMessage(uin: string, params: Adapter.SendMessageParams): Promise<Adapter.SendMessageResult>;
+    /**
+     * 删除/撤回消息
+     */
+    deleteMessage(uin: string, params: Adapter.DeleteMessageParams): Promise<void>;
+    /**
+     * 获取消息
+     */
+    getMessage(uin: string, params: Adapter.GetMessageParams): Promise<Adapter.MessageInfo>;
+    /**
+     * 更新消息
+     */
+    updateMessage(uin: string, params: Adapter.UpdateMessageParams): Promise<void>;
+    /**
+     * 获取机器人自身信息
+     */
+    getLoginInfo(uin: string): Promise<Adapter.UserInfo>;
+    /**
+     * 获取用户信息
+     */
+    getUserInfo(uin: string, params: Adapter.GetUserInfoParams): Promise<Adapter.UserInfo>;
+    /**
+     * 获取好友列表（私聊会话列表）
+     */
+    getFriendList(uin: string, params?: Adapter.GetFriendListParams): Promise<Adapter.FriendInfo[]>;
+    /**
+     * 获取好友信息
+     */
+    getFriendInfo(uin: string, params: Adapter.GetFriendInfoParams): Promise<Adapter.FriendInfo>;
+    /**
+     * 获取群列表（服务器列表）
+     */
+    getGroupList(uin: string, params?: Adapter.GetGroupListParams): Promise<Adapter.GroupInfo[]>;
+    /**
+     * 获取群信息（服务器信息）
+     */
+    getGroupInfo(uin: string, params: Adapter.GetGroupInfoParams): Promise<Adapter.GroupInfo>;
+    /**
+     * 退出群组（退出服务器）
+     */
+    leaveGroup(uin: string, params: Adapter.LeaveGroupParams): Promise<void>;
+    /**
+     * 获取群成员列表（服务器成员列表）
+     */
+    getGroupMemberList(uin: string, params: Adapter.GetGroupMemberListParams): Promise<Adapter.GroupMemberInfo[]>;
+    /**
+     * 获取群成员信息
+     */
+    getGroupMemberInfo(uin: string, params: Adapter.GetGroupMemberInfoParams): Promise<Adapter.GroupMemberInfo>;
+    /**
+     * 踢出群成员
+     */
+    kickGroupMember(uin: string, params: Adapter.KickGroupMemberParams): Promise<void>;
+    /**
+     * 设置群名片（设置服务器昵称）
+     */
+    setGroupCard(uin: string, params: Adapter.SetGroupCardParams): Promise<void>;
+    /**
+     * 获取频道列表
+     */
+    getChannelList(uin: string, params?: Adapter.GetChannelListParams): Promise<Adapter.ChannelInfo[]>;
+    /**
+     * 获取频道信息
+     */
+    getChannelInfo(uin: string, params: Adapter.GetChannelInfoParams): Promise<Adapter.ChannelInfo>;
+    /**
+     * 创建频道
+     */
+    createChannel(uin: string, params: Adapter.CreateChannelParams): Promise<Adapter.ChannelInfo>;
+    /**
+     * 更新频道
+     */
+    updateChannel(uin: string, params: Adapter.UpdateChannelParams): Promise<void>;
+    /**
+     * 删除频道
+     */
+    deleteChannel(uin: string, params: Adapter.DeleteChannelParams): Promise<void>;
+    /**
+     * 获取频道成员列表
+     */
+    getChannelMemberList(uin: string, params: Adapter.GetChannelMemberListParams): Promise<Adapter.ChannelMemberInfo[]>;
+    /**
+     * 获取服务器列表
+     */
+    getGuildList(uin: string): Promise<Adapter.GuildInfo[]>;
+    /**
+     * 获取服务器信息
+     */
+    getGuildInfo(uin: string, params: Adapter.GetGuildInfoParams): Promise<Adapter.GuildInfo>;
+    /**
+     * 获取服务器成员信息
+     */
+    getGuildMemberInfo(uin: string, params: Adapter.GetGuildMemberInfoParams): Promise<Adapter.GuildMemberInfo>;
+    /**
+     * 获取版本信息
+     */
+    getVersion(uin: string): Promise<Adapter.VersionInfo>;
+    /**
+     * 获取运行状态
+     */
+    getStatus(uin: string): Promise<Adapter.StatusInfo>;
+    createAccount(config: Account.Config<'kook'>): Account<'kook', KookBot>;
+}
+declare module "onebots" {
+    namespace Adapter {
+        interface Configs {
+            kook: KookConfig;
+        }
+    }
+}
+declare module './adapter.js' {
+    namespace Adapter {
+        interface Configs {
+            kook: KookConfig;
+        }
+    }
+}
+//# sourceMappingURL=adapter.d.ts.map