@zhin.js/adapter-kook 1.0.50 → 1.0.52
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/lib/adapter.d.ts +34 -0
- package/lib/adapter.d.ts.map +1 -0
- package/lib/adapter.js +337 -0
- package/lib/adapter.js.map +1 -0
- package/lib/bot.d.ts +122 -0
- package/lib/bot.d.ts.map +1 -0
- package/lib/bot.js +607 -0
- package/lib/bot.js.map +1 -0
- package/lib/index.d.ts +4 -178
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +8 -948
- package/lib/index.js.map +1 -1
- package/lib/types.d.ts +32 -0
- package/lib/types.d.ts.map +1 -0
- package/lib/types.js +8 -0
- package/lib/types.js.map +1 -0
- package/package.json +4 -4
package/lib/index.d.ts
CHANGED
|
@@ -1,184 +1,10 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { Bot, Adapter, Plugin, Message, SendOptions } from "zhin.js";
|
|
1
|
+
import { KookAdapter } from "./adapter.js";
|
|
3
2
|
declare module "zhin.js" {
|
|
4
3
|
interface Adapters {
|
|
5
4
|
kook: KookAdapter;
|
|
6
5
|
}
|
|
7
6
|
}
|
|
8
|
-
export
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
Owner = 4,
|
|
12
|
-
ChannelAdmin = 5
|
|
13
|
-
}
|
|
14
|
-
export interface KookSenderInfo {
|
|
15
|
-
id: string;
|
|
16
|
-
name: string;
|
|
17
|
-
/** KOOK 权限级别 */
|
|
18
|
-
permission?: KookPermission;
|
|
19
|
-
/** 用户角色列表 */
|
|
20
|
-
roles?: number[];
|
|
21
|
-
/** 是否为服务器主人 */
|
|
22
|
-
isGuildOwner?: boolean;
|
|
23
|
-
/** 是否为管理员 */
|
|
24
|
-
isAdmin?: boolean;
|
|
25
|
-
}
|
|
26
|
-
export interface KookBotConfig {
|
|
27
|
-
context: "kook";
|
|
28
|
-
name: string;
|
|
29
|
-
token: string;
|
|
30
|
-
data_dir?: string;
|
|
31
|
-
timeout?: number;
|
|
32
|
-
max_retry?: number;
|
|
33
|
-
ignore?: "bot" | "self";
|
|
34
|
-
logLevel?: LogLevel;
|
|
35
|
-
}
|
|
36
|
-
type KookRawMessage = PrivateMessageEvent | ChannelMessageEvent;
|
|
37
|
-
/**
|
|
38
|
-
* KOOK Bot 实现
|
|
39
|
-
*/
|
|
40
|
-
export declare class KookBot extends Client implements Bot<KookBotConfig, KookRawMessage> {
|
|
41
|
-
$config: KookBotConfig;
|
|
42
|
-
$connected: boolean;
|
|
43
|
-
adapter: KookAdapter;
|
|
44
|
-
get $id(): string;
|
|
45
|
-
constructor(adapter: KookAdapter, $config: KookBotConfig);
|
|
46
|
-
/**
|
|
47
|
-
* 设置事件监听器
|
|
48
|
-
*/
|
|
49
|
-
private setupEventListeners;
|
|
50
|
-
/**
|
|
51
|
-
* 将 KOOK 消息转换为标准消息格式
|
|
52
|
-
*/
|
|
53
|
-
$formatMessage(msg: KookRawMessage): Message<KookRawMessage>;
|
|
54
|
-
/**
|
|
55
|
-
* 获取发送者的详细权限信息
|
|
56
|
-
*/
|
|
57
|
-
private getSenderInfo;
|
|
58
|
-
/**
|
|
59
|
-
* 踢出用户
|
|
60
|
-
* @param guildId 服务器ID
|
|
61
|
-
* @param userId 用户ID
|
|
62
|
-
*/
|
|
63
|
-
kickUser(guildId: string, userId: string): Promise<boolean>;
|
|
64
|
-
/**
|
|
65
|
-
* 将用户加入黑名单
|
|
66
|
-
* @param guildId 服务器ID
|
|
67
|
-
* @param userId 用户ID
|
|
68
|
-
* @param remark 备注
|
|
69
|
-
* @param delMsgDays 删除消息天数(0-7)
|
|
70
|
-
*/
|
|
71
|
-
addToBlacklist(guildId: string, userId: string, remark?: string, delMsgDays?: number): Promise<boolean>;
|
|
72
|
-
/**
|
|
73
|
-
* 将用户从黑名单移除
|
|
74
|
-
* @param guildId 服务器ID
|
|
75
|
-
* @param userId 用户ID
|
|
76
|
-
*/
|
|
77
|
-
removeFromBlacklist(guildId: string, userId: string): Promise<boolean>;
|
|
78
|
-
/**
|
|
79
|
-
* 给用户授予角色
|
|
80
|
-
* @param guildId 服务器ID
|
|
81
|
-
* @param userId 用户ID
|
|
82
|
-
* @param roleId 角色ID
|
|
83
|
-
*/
|
|
84
|
-
grantRole(guildId: string, userId: string, roleId: string): Promise<boolean>;
|
|
85
|
-
/**
|
|
86
|
-
* 撤销用户角色
|
|
87
|
-
* @param guildId 服务器ID
|
|
88
|
-
* @param userId 用户ID
|
|
89
|
-
* @param roleId 角色ID
|
|
90
|
-
*/
|
|
91
|
-
revokeRole(guildId: string, userId: string, roleId: string): Promise<boolean>;
|
|
92
|
-
/**
|
|
93
|
-
* 设置用户昵称
|
|
94
|
-
* @param guildId 服务器ID
|
|
95
|
-
* @param userId 用户ID
|
|
96
|
-
* @param nickname 新昵称
|
|
97
|
-
*/
|
|
98
|
-
setNickname(guildId: string, userId: string, nickname: string): Promise<boolean>;
|
|
99
|
-
/**
|
|
100
|
-
* 获取服务器角色列表
|
|
101
|
-
* @param guildId 服务器ID
|
|
102
|
-
*/
|
|
103
|
-
getRoleList(guildId: string): Promise<Guild.Role[]>;
|
|
104
|
-
/**
|
|
105
|
-
* 创建角色
|
|
106
|
-
* @param guildId 服务器ID
|
|
107
|
-
* @param name 角色名称
|
|
108
|
-
*/
|
|
109
|
-
createRole(guildId: string, name: string): Promise<Guild.Role>;
|
|
110
|
-
/**
|
|
111
|
-
* 删除角色
|
|
112
|
-
* @param guildId 服务器ID
|
|
113
|
-
* @param roleId 角色ID
|
|
114
|
-
*/
|
|
115
|
-
deleteRole(guildId: string, roleId: string): Promise<boolean>;
|
|
116
|
-
/**
|
|
117
|
-
* 获取服务器成员列表
|
|
118
|
-
* @param guildId 服务器ID
|
|
119
|
-
* @param channelId 可选的频道ID
|
|
120
|
-
*/
|
|
121
|
-
getGuildMembers(guildId: string, channelId?: string): Promise<User.Info[]>;
|
|
122
|
-
private parseMarkdown;
|
|
123
|
-
/**
|
|
124
|
-
* 将 kook-client 的 MessageSegment[] 转换为 Zhin 的 MessageElement[]
|
|
125
|
-
*/
|
|
126
|
-
private parseMessageContent;
|
|
127
|
-
/**
|
|
128
|
-
* 检查文本是否包含 KMarkdown 特殊语法
|
|
129
|
-
*/
|
|
130
|
-
private hasKMarkdownSyntax;
|
|
131
|
-
/**
|
|
132
|
-
* 连接到 KOOK
|
|
133
|
-
*/
|
|
134
|
-
$connect(): Promise<void>;
|
|
135
|
-
/**
|
|
136
|
-
* 断开连接
|
|
137
|
-
*/
|
|
138
|
-
$disconnect(): Promise<void>;
|
|
139
|
-
/**
|
|
140
|
-
* 发送消息
|
|
141
|
-
*/
|
|
142
|
-
$sendMessage(options: SendOptions): Promise<string>;
|
|
143
|
-
/**
|
|
144
|
-
* 撤回消息
|
|
145
|
-
*/
|
|
146
|
-
$recallMessage(messageId: string): Promise<void>;
|
|
147
|
-
/**
|
|
148
|
-
* 将消息段转换为 KOOK KMarkdown 格式
|
|
149
|
-
* 支持:文本、图片、@提及、表情、引用等
|
|
150
|
-
*/
|
|
151
|
-
private convertToKookFormat;
|
|
152
|
-
}
|
|
153
|
-
/**
|
|
154
|
-
* KOOK 适配器
|
|
155
|
-
*/
|
|
156
|
-
export declare class KookAdapter extends Adapter<KookBot> {
|
|
157
|
-
constructor(plugin: Plugin);
|
|
158
|
-
createBot(config: KookBotConfig): KookBot;
|
|
159
|
-
kickMember(botId: string, sceneId: string, userId: string): Promise<boolean>;
|
|
160
|
-
banMember(botId: string, sceneId: string, userId: string, reason?: string): Promise<boolean>;
|
|
161
|
-
unbanMember(botId: string, sceneId: string, userId: string): Promise<boolean>;
|
|
162
|
-
setMemberNickname(botId: string, sceneId: string, userId: string, nickname: string): Promise<boolean>;
|
|
163
|
-
listMembers(botId: string, sceneId: string): Promise<{
|
|
164
|
-
members: {
|
|
165
|
-
id: string;
|
|
166
|
-
username: string;
|
|
167
|
-
nickname: string;
|
|
168
|
-
roles: number[];
|
|
169
|
-
}[];
|
|
170
|
-
count: number;
|
|
171
|
-
}>;
|
|
172
|
-
start(): Promise<void>;
|
|
173
|
-
stop(): Promise<void>;
|
|
174
|
-
/**
|
|
175
|
-
* 注册 KOOK 平台特有工具(角色授予等)
|
|
176
|
-
*/
|
|
177
|
-
private registerKookPlatformTools;
|
|
178
|
-
/**
|
|
179
|
-
* 检查执行上下文中的权限
|
|
180
|
-
*/
|
|
181
|
-
private checkPermission;
|
|
182
|
-
}
|
|
183
|
-
export {};
|
|
7
|
+
export * from "./types.js";
|
|
8
|
+
export { KookBot } from "./bot.js";
|
|
9
|
+
export { KookAdapter } from "./adapter.js";
|
|
184
10
|
//# sourceMappingURL=index.d.ts.map
|
package/lib/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C,OAAO,QAAQ,SAAS,CAAC;IACvB,UAAU,QAAQ;QAChB,IAAI,EAAE,WAAW,CAAC;KACnB;CACF;AAED,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC"}
|