@onebots/adapter-kook 1.0.0

package/lib/types.d.ts

@@ -0,0 +1,240 @@
+/**
+ * KOOK (开黑了) API 类型定义
+ * 基于 KOOK 开发者平台官方 API
+ */
+export interface KookConfig {
+    account_id: string;
+    token: string;
+    verifyToken?: string;
+    encryptKey?: string;
+    mode?: 'webhook' | 'websocket';
+    maxRetry?: number;
+}
+export interface KookUser {
+    id: string;
+    username: string;
+    nickname?: string;
+    identify_num: string;
+    online: boolean;
+    bot?: boolean;
+    status: number;
+    avatar: string;
+    vip_avatar?: string;
+    mobile_verified?: boolean;
+    roles?: number[];
+    joined_at?: number;
+    active_time?: number;
+}
+export interface KookGuild {
+    id: string;
+    name: string;
+    topic: string;
+    user_id: string;
+    icon: string;
+    notify_type: number;
+    region: string;
+    enable_open: boolean;
+    open_id: string;
+    default_channel_id: string;
+    welcome_channel_id: string;
+    roles?: KookRole[];
+    channels?: KookChannel[];
+}
+export interface KookChannel {
+    id: string;
+    name: string;
+    user_id: string;
+    guild_id: string;
+    topic: string;
+    is_category: boolean;
+    parent_id: string;
+    level: number;
+    slow_mode: number;
+    type: number;
+    permission_overwrites?: KookPermissionOverwrite[];
+    permission_users?: any[];
+    permission_sync: number;
+    has_password: boolean;
+}
+export interface KookRole {
+    role_id: number;
+    name: string;
+    color: number;
+    position: number;
+    hoist: number;
+    mentionable: number;
+    permissions: number;
+}
+export interface KookPermissionOverwrite {
+    role_id: number;
+    allow: number;
+    deny: number;
+}
+export type KookMessageType = 1 | 2 | 3 | 4 | 8 | 9 | 10 | 255;
+export interface KookChannelMessage {
+    id: string;
+    type: KookMessageType;
+    content: string;
+    mention: string[];
+    mention_all: boolean;
+    mention_roles: number[];
+    mention_here: boolean;
+    embeds: any[];
+    attachments: KookAttachment[];
+    create_at: number;
+    updated_at: number;
+    reactions: KookReaction[];
+    author: KookUser;
+    image_name?: string;
+    read_status?: boolean;
+    quote?: KookChannelMessage;
+    mention_info?: any;
+}
+export interface KookDirectMessage {
+    id: string;
+    type: KookMessageType;
+    content: string;
+    embeds: any[];
+    attachments: KookAttachment[];
+    create_at: number;
+    updated_at: number;
+    reactions: KookReaction[];
+    author_id: string;
+    image_name?: string;
+    read_status?: boolean;
+    quote?: KookDirectMessage;
+    nonce?: string;
+}
+export interface KookAttachment {
+    type: string;
+    url: string;
+    name: string;
+    file_type?: string;
+    size?: number;
+    duration?: number;
+    width?: number;
+    height?: number;
+}
+export interface KookReaction {
+    emoji: KookEmoji;
+    count: number;
+    me: boolean;
+}
+export interface KookEmoji {
+    id: string;
+    name: string;
+}
+export interface KookIntimacy {
+    img_url: string;
+    social_info: string;
+    last_read: number;
+    score: number;
+    img_list: Array<{
+        id: string;
+        url: string;
+    }>;
+}
+export interface KookUserChat {
+    code: string;
+    last_read_time: number;
+    latest_msg_time: number;
+    unread_count: number;
+    is_friend: boolean;
+    is_blocked: boolean;
+    is_target_blocked: boolean;
+    target_info: KookUser;
+}
+export interface KookGame {
+    id: number;
+    name: string;
+    type: number;
+    options: string;
+    kmhook_admin: boolean;
+    process_name: string[];
+    product_name: string[];
+    icon: string;
+}
+export interface KookApiResponse<T = any> {
+    code: number;
+    message: string;
+    data: T;
+}
+export interface KookListResponse<T> {
+    items: T[];
+    meta: {
+        page: number;
+        page_total: number;
+        page_size: number;
+        total: number;
+    };
+    sort?: Record<string, number>;
+}
+export interface KookSignal {
+    s: number;
+    d: any;
+    sn?: number;
+}
+export declare const KookSignalType: {
+    readonly EVENT: 0;
+    readonly HELLO: 1;
+    readonly PING: 2;
+    readonly PONG: 3;
+    readonly RESUME: 4;
+    readonly RECONNECT: 5;
+    readonly RESUME_ACK: 6;
+};
+export type KookEventType = 'message' | 'added_reaction' | 'deleted_reaction' | 'updated_message' | 'deleted_message' | 'pinned_message' | 'unpinned_message' | 'added_channel' | 'updated_channel' | 'deleted_channel' | 'joined_guild' | 'exited_guild' | 'updated_guild_member' | 'guild_member_online' | 'guild_member_offline' | 'added_role' | 'deleted_role' | 'updated_role' | 'joined_channel' | 'exited_channel' | 'user_updated' | 'self_joined_guild' | 'self_exited_guild' | 'message_btn_click' | 'added_block_list' | 'deleted_block_list' | 'private_added_reaction' | 'private_deleted_reaction' | 'updated_private_message' | 'deleted_private_message';
+export declare const KookChannelType: {
+    readonly TEXT: 1;
+    readonly VOICE: 2;
+};
+export interface KookEvent {
+    channel_type: 'GROUP' | 'PERSON' | 'BROADCAST';
+    type: number;
+    target_id: string;
+    author_id: string;
+    content: string;
+    msg_id: string;
+    msg_timestamp: number;
+    nonce: string;
+    extra: KookEventExtra;
+}
+export interface KookEventExtra {
+    type?: KookEventType | number;
+    guild_id?: string;
+    channel_name?: string;
+    mention?: string[];
+    mention_all?: boolean;
+    mention_roles?: number[];
+    mention_here?: boolean;
+    author?: KookUser;
+    body?: any;
+    code?: string;
+    [key: string]: any;
+}
+export interface KookWebhookChallenge {
+    s: 0;
+    d: {
+        type: 255;
+        channel_type: 'WEBHOOK_CHALLENGE';
+        challenge: string;
+        verify_token: string;
+    };
+}
+export interface KookSendMessageParams {
+    type?: KookMessageType;
+    target_id: string;
+    content: string;
+    quote?: string;
+    nonce?: string;
+    temp_target_id?: string;
+}
+export interface KookSendDirectMessageParams {
+    type?: KookMessageType;
+    target_id?: string;
+    chat_code?: string;
+    content: string;
+    quote?: string;
+    nonce?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/lib/types.js

@@ -0,0 +1,20 @@
+/**
+ * KOOK (开黑了) API 类型定义
+ * 基于 KOOK 开发者平台官方 API
+ */
+// 信令类型
+export const KookSignalType = {
+    EVENT: 0, // 服务端推送消息
+    HELLO: 1, // 客户端和服务端的 Hello
+    PING: 2, // 客户端发送的 Ping
+    PONG: 3, // 服务端回复的 Pong
+    RESUME: 4, // 恢复连接
+    RECONNECT: 5, // 服务端通知重连
+    RESUME_ACK: 6, // 恢复成功
+};
+// 频道类型
+export const KookChannelType = {
+    TEXT: 1, // 文字频道
+    VOICE: 2, // 语音频道
+};
+//# sourceMappingURL=types.js.map

package/lib/utils.d.ts

@@ -0,0 +1,93 @@
+/**
+ * 验证 Webhook 请求
+ */
+export declare function verifyWebhook(body: any, verifyToken: string): boolean;
+/**
+ * 解密 Webhook 消息（当配置了 encryptKey 时）
+ */
+export declare function decryptWebhookMessage(encryptedData: string, encryptKey: string): string;
+/**
+ * 解析 KMarkdown 消息为文本
+ */
+export declare function parseKMarkdown(content: string): string;
+/**
+ * 将文本转换为 KMarkdown 格式
+ */
+export declare function textToKMarkdown(text: string): string;
+/**
+ * 构建 @用户 的 KMarkdown
+ */
+export declare function mentionUser(userId: string): string;
+/**
+ * 构建 @全体成员 的 KMarkdown
+ */
+export declare function mentionAll(): string;
+/**
+ * 构建 @在线成员 的 KMarkdown
+ */
+export declare function mentionHere(): string;
+/**
+ * 构建 @角色 的 KMarkdown
+ */
+export declare function mentionRole(roleId: number): string;
+/**
+ * 构建 #频道 的 KMarkdown
+ */
+export declare function mentionChannel(channelId: string): string;
+/**
+ * 构建表情的 KMarkdown
+ */
+export declare function emojiKMarkdown(emojiName: string, emojiId: string): string;
+/**
+ * 构建链接的 KMarkdown
+ */
+export declare function linkKMarkdown(text: string, url: string): string;
+/**
+ * 构建加粗的 KMarkdown
+ */
+export declare function boldKMarkdown(text: string): string;
+/**
+ * 构建斜体的 KMarkdown
+ */
+export declare function italicKMarkdown(text: string): string;
+/**
+ * 构建删除线的 KMarkdown
+ */
+export declare function strikethroughKMarkdown(text: string): string;
+/**
+ * 构建代码块的 KMarkdown
+ */
+export declare function codeBlockKMarkdown(code: string, language?: string): string;
+/**
+ * 构建行内代码的 KMarkdown
+ */
+export declare function inlineCodeKMarkdown(code: string): string;
+/**
+ * 构建引用的 KMarkdown
+ */
+export declare function quoteKMarkdown(text: string): string;
+/**
+ * 构建分割线的 KMarkdown
+ */
+export declare function dividerKMarkdown(): string;
+/**
+ * 生成随机 nonce
+ */
+export declare function generateNonce(): string;
+/**
+ * 解析卡片消息
+ */
+export declare function parseCardMessage(content: string): any[];
+/**
+ * 构建简单文本卡片
+ */
+export declare function buildTextCard(text: string, theme?: 'primary' | 'success' | 'danger' | 'warning' | 'info' | 'secondary' | 'none'): string;
+/**
+ * 构建图片卡片
+ */
+export declare function buildImageCard(imageUrl: string, title?: string): string;
+/**
+ * 计算消息签名（用于验证）
+ */
+export declare function calculateSignature(data: string, key: string): string;
+//# sourceMappingURL=utils.d.ts.map

package/lib/utils.js

@@ -0,0 +1,240 @@
+/**
+ * KOOK (开黑了) 工具函数
+ */
+import { createDecipheriv, createHash } from 'crypto';
+/**
+ * 验证 Webhook 请求
+ */
+export function verifyWebhook(body, verifyToken) {
+    if (!body || !body.d)
+        return false;
+    return body.d.verify_token === verifyToken;
+}
+/**
+ * 解密 Webhook 消息（当配置了 encryptKey 时）
+ */
+export function decryptWebhookMessage(encryptedData, encryptKey) {
+    if (!encryptKey) {
+        throw new Error('未配置 encryptKey，无法解密消息');
+    }
+    try {
+        // 解码 base64
+        const encrypted = Buffer.from(encryptedData, 'base64');
+        // 提取 IV（前 16 字节）
+        const iv = encrypted.slice(0, 16);
+        const ciphertext = encrypted.slice(16);
+        // 生成密钥（encryptKey 需要是 32 字节）
+        const key = Buffer.alloc(32);
+        Buffer.from(encryptKey).copy(key);
+        // 解密
+        const decipher = createDecipheriv('aes-256-cbc', key, iv);
+        let decrypted = decipher.update(ciphertext);
+        decrypted = Buffer.concat([decrypted, decipher.final()]);
+        return decrypted.toString('utf-8');
+    }
+    catch (error) {
+        throw new Error(`解密消息失败: ${error.message}`);
+    }
+}
+/**
+ * 解析 KMarkdown 消息为文本
+ */
+export function parseKMarkdown(content) {
+    if (!content)
+        return '';
+    // 移除 KMarkdown 格式标记
+    let text = content;
+    // 移除加粗 **text**
+    text = text.replace(/\*\*(.+?)\*\*/g, '$1');
+    // 移除斜体 *text*
+    text = text.replace(/\*(.+?)\*/g, '$1');
+    // 移除删除线 ~~text~~
+    text = text.replace(/~~(.+?)~~/g, '$1');
+    // 移除下划线 (ins)text(/ins)
+    text = text.replace(/\(ins\)(.+?)\(\/ins\)/g, '$1');
+    // 移除剧透 (spl)text(/spl)
+    text = text.replace(/\(spl\)(.+?)\(\/spl\)/g, '$1');
+    // 提取链接文本 [text](url)
+    text = text.replace(/\[(.+?)\]\(.+?\)/g, '$1');
+    // 提取 @用户 (met)id(/met)
+    text = text.replace(/\(met\)(\w+)\(\/met\)/g, '@$1');
+    // 提取 @角色 (rol)id(/rol)
+    text = text.replace(/\(rol\)(\w+)\(\/rol\)/g, '@角色$1');
+    // 提取 #频道 (chn)id(/chn)
+    text = text.replace(/\(chn\)(\w+)\(\/chn\)/g, '#$1');
+    // 提取表情 (emj)name(/emj)[id]
+    text = text.replace(/\(emj\)(.+?)\(\/emj\)\[.+?\]/g, ':$1:');
+    // 移除代码块 ```code```
+    text = text.replace(/```[\s\S]*?```/g, '[代码块]');
+    // 移除行内代码 `code`
+    text = text.replace(/`(.+?)`/g, '$1');
+    return text.trim();
+}
+/**
+ * 将文本转换为 KMarkdown 格式
+ */
+export function textToKMarkdown(text) {
+    // 转义特殊字符
+    return text
+        .replace(/\\/g, '\\\\')
+        .replace(/\*/g, '\\*')
+        .replace(/~/g, '\\~')
+        .replace(/`/g, '\\`')
+        .replace(/\[/g, '\\[')
+        .replace(/\(/g, '\\(');
+}
+/**
+ * 构建 @用户 的 KMarkdown
+ */
+export function mentionUser(userId) {
+    return `(met)${userId}(/met)`;
+}
+/**
+ * 构建 @全体成员 的 KMarkdown
+ */
+export function mentionAll() {
+    return '(met)all(/met)';
+}
+/**
+ * 构建 @在线成员 的 KMarkdown
+ */
+export function mentionHere() {
+    return '(met)here(/met)';
+}
+/**
+ * 构建 @角色 的 KMarkdown
+ */
+export function mentionRole(roleId) {
+    return `(rol)${roleId}(/rol)`;
+}
+/**
+ * 构建 #频道 的 KMarkdown
+ */
+export function mentionChannel(channelId) {
+    return `(chn)${channelId}(/chn)`;
+}
+/**
+ * 构建表情的 KMarkdown
+ */
+export function emojiKMarkdown(emojiName, emojiId) {
+    return `(emj)${emojiName}(emj)[${emojiId}]`;
+}
+/**
+ * 构建链接的 KMarkdown
+ */
+export function linkKMarkdown(text, url) {
+    return `[${text}](${url})`;
+}
+/**
+ * 构建加粗的 KMarkdown
+ */
+export function boldKMarkdown(text) {
+    return `**${text}**`;
+}
+/**
+ * 构建斜体的 KMarkdown
+ */
+export function italicKMarkdown(text) {
+    return `*${text}*`;
+}
+/**
+ * 构建删除线的 KMarkdown
+ */
+export function strikethroughKMarkdown(text) {
+    return `~~${text}~~`;
+}
+/**
+ * 构建代码块的 KMarkdown
+ */
+export function codeBlockKMarkdown(code, language) {
+    return `\`\`\`${language || ''}\n${code}\n\`\`\``;
+}
+/**
+ * 构建行内代码的 KMarkdown
+ */
+export function inlineCodeKMarkdown(code) {
+    return `\`${code}\``;
+}
+/**
+ * 构建引用的 KMarkdown
+ */
+export function quoteKMarkdown(text) {
+    return `> ${text}`;
+}
+/**
+ * 构建分割线的 KMarkdown
+ */
+export function dividerKMarkdown() {
+    return '---';
+}
+/**
+ * 生成随机 nonce
+ */
+export function generateNonce() {
+    return `${Date.now()}_${Math.random().toString(36).substring(2, 15)}`;
+}
+/**
+ * 解析卡片消息
+ */
+export function parseCardMessage(content) {
+    try {
+        return JSON.parse(content);
+    }
+    catch {
+        return [];
+    }
+}
+/**
+ * 构建简单文本卡片
+ */
+export function buildTextCard(text, theme = 'primary') {
+    const card = [{
+            type: 'card',
+            theme,
+            size: 'lg',
+            modules: [{
+                    type: 'section',
+                    text: {
+                        type: 'plain-text',
+                        content: text,
+                    },
+                }],
+        }];
+    return JSON.stringify(card);
+}
+/**
+ * 构建图片卡片
+ */
+export function buildImageCard(imageUrl, title) {
+    const modules = [];
+    if (title) {
+        modules.push({
+            type: 'header',
+            text: {
+                type: 'plain-text',
+                content: title,
+            },
+        });
+    }
+    modules.push({
+        type: 'container',
+        elements: [{
+                type: 'image',
+                src: imageUrl,
+            }],
+    });
+    const card = [{
+            type: 'card',
+            theme: 'none',
+            size: 'lg',
+            modules,
+        }];
+    return JSON.stringify(card);
+}
+/**
+ * 计算消息签名（用于验证）
+ */
+export function calculateSignature(data, key) {
+    return createHash('sha256').update(data + key).digest('hex');
+}
+//# sourceMappingURL=utils.js.map

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@onebots/adapter-kook",
+  "version": "1.0.0",
+  "description": "onebots KOOK(开黑了)适配器",
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "keywords": [
+    "onebots",
+    "kook",
+    "kaiheila",
+    "adapter"
+  ],
+  "author": "凉菜",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "files": [
+    "/lib/**/*.js",
+    "/lib/**/*.d.ts"
+  ],
+  "devDependencies": {
+    "tsc-alias": "latest",
+    "typescript": "latest",
+    "@types/node": "^22.7.3"
+  },
+  "peerDependencies": {
+    "onebots": "1.0.0"
+  },
+  "dependencies": {
+    "kook-client": "^1.0.4"
+  },
+  "scripts": {
+    "build": "rm -f *.tsbuildinfo && tsc --project tsconfig.json && tsc-alias -p tsconfig.json",
+    "clean": "rm -rf lib *.tsbuildinfo"
+  }
+}