hotcat-bot-qq 0.0.1

package/dist/botEvent.js

@@ -0,0 +1,557 @@
+import { BotConsole } from './botConsole';
+/**
+ * 当接收到消息时触发的事件。
+ *
+ * @example
+ * ```ts
+ * bot.event.message.onGroupMessage(async (bot, event) => {
+ *     await bot.api.sendGroupMessage(event.group_id, Message.text('收到'));
+ * });
+ * ```
+ */
+export class MessageEvent {
+    constructor(napcat, client) {
+        Object.defineProperty(this, "napcat", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "client", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.napcat = napcat;
+        this.client = client;
+    }
+    /**
+     * 注册群消息事件回调
+     * @param fn - 回调 `(bot, event) => any`
+     */
+    onGroupMessage(fn) {
+        this.napcat.on('message.group', async (event) => {
+            try {
+                new BotConsole('groupMessage', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /**
+     * 注册群消息普通事件回调
+     * @param fn - 回调 `(bot, event) => any`
+     */
+    onGroupNormal(fn) {
+        this.napcat.on('message.group.normal', async (event) => {
+            try {
+                new BotConsole('groupMessage', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /**
+     * 注册私聊消息事件回调
+     * @param fn - 回调 `(bot, event) => any`
+     */
+    onPrivateMessage(fn) {
+        this.napcat.on('message.private', async (event) => {
+            try {
+                new BotConsole('privateMessage', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /**
+     * 注册私聊消息好友事件回调
+     * @param fn - 回调 `(bot, event) => any`
+     */
+    onPrivateFriend(fn) {
+        this.napcat.on('message.private.friend', async (event) => {
+            try {
+                new BotConsole('privateMessage', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /**
+     * 注册私聊消息群临时事件回调
+     * @param fn - 回调 `(bot, event) => any`
+     */
+    onPrivateGroup(fn) {
+        this.napcat.on('message.private.group', async (event) => {
+            try {
+                new BotConsole('privateMessage', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+}
+/**
+ * 当 bot 自身发出消息后的事件。
+ *
+ * @example
+ * ```ts
+ * bot.event.messageSent.onGroupSent(async (bot, event) => {
+ *     console.log('群消息已发送:', event.message_id);
+ * });
+ * ```
+ */
+export class MessageSent {
+    constructor(napcat, client) {
+        Object.defineProperty(this, "napcat", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "client", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.napcat = napcat;
+        this.client = client;
+    }
+    /**
+     * 注册群消息发送回执
+     * @param fn - 回调 `(bot, event) => any`
+     */
+    onGroupSent(fn) {
+        this.napcat.on('message_sent.group', async (event) => {
+            try {
+                new BotConsole('groupMessageSelf', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /**
+     * 注册群消息发送回执（仅普通消息）
+     * @param fn - 回调 `(bot, event) => any`
+     */
+    onGroupNormal(fn) {
+        this.napcat.on('message_sent.group.normal', async (event) => {
+            try {
+                new BotConsole('groupMessageSelf', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /**
+     * 注册私聊消息发送回执
+     * @param fn - 回调 `(bot, event) => any`
+     */
+    onPrivateSent(fn) {
+        this.napcat.on('message_sent.private', async (event) => {
+            try {
+                new BotConsole('privateMessageSelf', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /**
+     * 注册私聊好友消息发送回执
+     * @param fn - 回调 `(bot, event) => any`
+     */
+    onPrivateFriend(fn) {
+        this.napcat.on('message_sent.private.friend', async (event) => {
+            try {
+                new BotConsole('privateMessageSelf', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /**
+     * 注册私聊群临时消息发送回执
+     * @param fn - 回调 `(bot, event) => any`
+     */
+    onPrivateGroup(fn) {
+        this.napcat.on('message_sent.private.group', async (event) => {
+            try {
+                new BotConsole('privateMessageSelf', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+}
+/**
+ * 请求事件监听（加好友、加群、邀请入群）。
+ *
+ * @example
+ * ```ts
+ * bot.event.request.onFriend(async (bot, event) => {
+ *     await bot.api.handleFriendAddRequest(event.flag, true);
+ * });
+ * ```
+ */
+export class RequestEvent {
+    constructor(napcat, client) {
+        Object.defineProperty(this, "napcat", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "client", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.napcat = napcat;
+        this.client = client;
+    }
+    /**
+     * 注册加好友请求回调
+     * @param fn - 回调 `(bot, event) => any`，event.flag 可传给 handleFriendAddRequest
+     */
+    onFriend(fn) {
+        this.napcat.on('request.friend', async (event) => {
+            try {
+                new BotConsole('requestFriend', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /**
+     * 注册加群请求回调
+     * @param fn - 回调 `(bot, event) => any`，event.flag 可传给 handleGroupAddRequest
+     */
+    onGroupAdd(fn) {
+        this.napcat.on('request.group.add', async (event) => {
+            try {
+                new BotConsole('requestGroupAdd', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /**
+     * 注册邀请入群回调
+     * @param fn - 回调 `(bot, event) => any`
+     */
+    onGroupInvite(fn) {
+        this.napcat.on('request.group.invite', async (event) => {
+            try {
+                new BotConsole('requestGroupInvite', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /**
+     * 注册所有群请求回调（加群 + 邀请）
+     * @param fn - 回调 `(bot, event) => any`
+     */
+    onGroupRequest(fn) {
+        this.napcat.on('request.group', async (event) => {
+            try {
+                const type = event.sub_type === 'add' ? 'requestGroupAdd' : 'requestGroupInvite';
+                new BotConsole(type, event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+}
+/**
+ * 通知事件监听（好友添加、群成员变动、禁言、撤回等）。
+ *
+ * @example
+ * ```ts
+ * bot.event.notice.onFriendAdd(async (bot, event) => { ... });
+ * bot.event.notice.onGroupIncrease(async (bot, event) => { ... });
+ * ```
+ */
+export class NoticeEvent {
+    constructor(napcat, client) {
+        Object.defineProperty(this, "napcat", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "client", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.napcat = napcat;
+        this.client = client;
+    }
+    /** 好友添加 */
+    onFriendAdd(fn) {
+        this.napcat.on('notice.friend_add', async (event) => {
+            try {
+                new BotConsole('notice', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /** 私聊消息撤回 */
+    onFriendRecall(fn) {
+        this.napcat.on('notice.friend_recall', async (event) => {
+            try {
+                new BotConsole('notice', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /** 群管理员变动（设置/取消） */
+    onGroupAdmin(fn) {
+        this.napcat.on('notice.group_admin', async (event) => {
+            try {
+                new BotConsole('notice', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /** 群禁言变动（禁言/解除） */
+    onGroupBan(fn) {
+        this.napcat.on('notice.group_ban', async (event) => {
+            try {
+                new BotConsole('notice', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /** 群名片变更 */
+    onGroupCard(fn) {
+        this.napcat.on('notice.group_card', async (event) => {
+            try {
+                new BotConsole('notice', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /** 群成员减少（退群/被踢/bot被踢） */
+    onGroupDecrease(fn) {
+        this.napcat.on('notice.group_decrease', async (event) => {
+            try {
+                new BotConsole('notice', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /** 群成员增加（审批/邀请） */
+    onGroupIncrease(fn) {
+        this.napcat.on('notice.group_increase', async (event) => {
+            try {
+                new BotConsole('notice', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /** 群消息撤回 */
+    onGroupRecall(fn) {
+        this.napcat.on('notice.group_recall', async (event) => {
+            try {
+                new BotConsole('notice', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /** 群文件上传 */
+    onGroupUpload(fn) {
+        this.napcat.on('notice.group_upload', async (event) => {
+            try {
+                new BotConsole('notice', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /** 群表情回应 */
+    onGroupEmojiLike(fn) {
+        this.napcat.on('notice.group_msg_emoji_like', async (event) => {
+            try {
+                new BotConsole('notice', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /** 群设精（添加/删除） */
+    onGroupEssence(fn) {
+        this.napcat.on('notice.essence', async (event) => {
+            try {
+                new BotConsole('notice', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /** 戳一戳（好友/群） */
+    onPoke(fn) {
+        this.napcat.on('notice.notify.poke', async (event) => {
+            try {
+                new BotConsole('notice', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /** 群名称变更 */
+    onGroupNameChange(fn) {
+        this.napcat.on('notice.notify.group_name', async (event) => {
+            try {
+                new BotConsole('notice', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /** 群头衔变更 */
+    onTitleChange(fn) {
+        this.napcat.on('notice.notify.title', async (event) => {
+            try {
+                new BotConsole('notice', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /** 个人资料点赞 */
+    onProfileLike(fn) {
+        this.napcat.on('notice.notify.profile_like', async (event) => {
+            try {
+                new BotConsole('notice', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+    /** bot 离线 */
+    onBotOffline(fn) {
+        this.napcat.on('notice.bot_offline', async (event) => {
+            try {
+                new BotConsole('notice', event).log();
+                await fn(this.client, event);
+            }
+            catch (e) {
+                new BotConsole('error', e instanceof Error ? e.message : JSON.stringify(e)).log();
+            }
+        });
+    }
+}
+/**
+ * 事件监听入口，按类别分组暴露监听器。
+ *
+ * @example
+ * ```ts
+ * bot.event.message.onGroupMessage(...);
+ * bot.event.messageSent.onGroupSent(...);
+ * bot.event.request.onFriend(...);
+ * ```
+ */
+export class BotEvent {
+    constructor(api, client) {
+        Object.defineProperty(this, "message", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "messageSent", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "request", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "notice", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.message = new MessageEvent(api.napcat, client);
+        this.messageSent = new MessageSent(api.napcat, client);
+        this.request = new RequestEvent(api.napcat, client);
+        this.notice = new NoticeEvent(api.napcat, client);
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export { BotClient } from './botClient';
+export { BotApi } from './botApi';
+export { BotEvent, MessageEvent, MessageSent, RequestEvent, NoticeEvent } from './botEvent';
+export { BotConsole, colors, parseCQ, formatMessage } from './botConsole';
+export type { BotConsoleType, PrivateMessage, PrivateMessageSelf, RequestGroup, NoticeEvent as NoticeEventType } from './botConsole';
+export { Message } from './message';

package/dist/index.js

@@ -0,0 +1,5 @@
+export { BotClient } from './botClient';
+export { BotApi } from './botApi';
+export { BotEvent, MessageEvent, MessageSent, RequestEvent, NoticeEvent } from './botEvent';
+export { BotConsole, colors, parseCQ, formatMessage } from './botConsole';
+export { Message } from './message';

package/dist/message.d.ts

@@ -0,0 +1,96 @@
+/**
+ * 消息段，搭配 {@link BotApi.sendMessage} / {@link BotApi.sendGroupMessage} 等发送方法使用。
+ *
+ * ## 收发支持情况
+ * | 类型 | 发送 | 接收 | 说明 |
+ * |------|:----:|:----:|------|
+ * | `text` | ✅ | ✅ | 文本 |
+ * | `at` | ✅ | ✅ | @某人 / @全体 |
+ * | `reply` | ✅ | ✅ | 引用回复 |
+ * | `face` | ✅ | ✅ | QQ 表情 |
+ * | `image` | ✅ | ✅ | 图片 |
+ * | `file` | ✅ | ✅ | 文件 |
+ * | `video` | ✅ | ✅ | 短视频 |
+ * | `record` | ✅ | ✅ | 语音 |
+ * | `json` | ✅ | ✅ | JSON 消息段 |
+ * | `dice` | ✅ | ✅ | 骰子 |
+ * | `rps` | ✅ | ✅ | 猜拳 |
+ * | `markdown` | ✅ | ✅ | Markdown |
+ * | `forward` | ✅ | ✅ | 合并转发 |
+ * | `mface` | ✅ | — | 商城表情（收归入 `image`） |
+ * | `music` | ✅ | — | 音乐分享 |
+ * | `node` | ✅ | — | 合并转发节点 |
+ * | `contact` | ✅ | — | 推荐联系人/群 |
+ * | `poke` | — | ✅ | 戳一戳（仅接收） |
+ */
+export declare class Message {
+    type: string;
+    data: Record<string, any>;
+    private constructor();
+    /** 文本消息段（发+收） */
+    static text(text: string): Message;
+    /** @某人，传 QQ 号或 `'all'`（发+收） */
+    static at(qq: string | number): Message;
+    /** @全体成员（发） */
+    static atAll(): Message;
+    /** QQ 表情，传表情 ID（发+收） */
+    static face(id: string | number): Message;
+    /** 商城表情（仅发送，接收时归入 image 段） */
+    static mface(emoji_id: string | number, emoji_package_id: string | number, key: string, summary?: string): Message;
+    /** 图片，`file` 支持本地路径 / URL / Buffer（发+收） */
+    static image(file: string | Buffer, summary?: string, sub_type?: string | number): Message;
+    /** 引用回复，传消息 ID（发+收） */
+    static reply(id: string | number): Message;
+    /** 文件，`file` 支持本地路径 / URL / Buffer（发+收） */
+    static file(file: string | Buffer, name?: string): Message;
+    /** 短视频，`file` 支持本地路径 / URL / Buffer（发+收） */
+    static video(file: string | Buffer, name?: string, thumb?: string): Message;
+    /** 语音，`file` 支持本地路径 / URL / Buffer（发+收） */
+    static record(file: string | Buffer, name?: string, thumb?: string): Message;
+    /** JSON 消息段（发+收） */
+    static json(data: string): Message;
+    /** 骰子（发+收） */
+    static dice(): Message;
+    /** 猜拳（发+收） */
+    static rps(): Message;
+    /** Markdown 消息（发+收） */
+    static markdown(content: string): Message;
+    /** 平台音乐分享，type 支持 qq/163/kugou/migu/kuwo（仅发送） */
+    static music(type: 'qq' | '163' | 'kugou' | 'migu' | 'kuwo', id: string | number): Message;
+    /** 自定义音乐分享，需配置签名服务器（仅发送） */
+    static customMusic(type: 'qq' | '163' | 'kugou' | 'migu' | 'kuwo' | 'custom', url: string, image: string, audio?: string, title?: string, singer?: string): Message;
+    /** 合并转发节点（引用已有消息，仅发送） */
+    static node(id: string | number, user_id?: string | number, nickname?: string, source?: string, news?: {
+        text: string;
+    }[], summary?: string, prompt?: string, time?: string | number): Message;
+    /** 合并转发节点（自定义内容，仅发送） */
+    static customNode(content: Message[], user_id?: string | number, nickname?: string, source?: string, news?: {
+        text: string;
+    }[], summary?: string, prompt?: string, time?: string | number): Message;
+    /** 合并转发，传 message_id（发+收） */
+    static forward(message_id: number): Message;
+    /** 推荐联系人/群（仅发送） */
+    static contact(type: 'qq' | 'group', id: string | number): Message;
+    /**
+     * 从 napcat 事件中的 message 段构造 Message（收消息还原）
+     * 支持的接收类型：text/at/image/file/poke/dice/rps/face/reply/video/record/forward/json/markdown
+     * @param seg - `{ type: string, data: object }`
+     */
+    static from(seg: {
+        type: string;
+        data: Record<string, any>;
+    }): Message;
+    /**
+     * 转为 napcat API 所需的 JSON 格式
+     * @returns `{ type, data }`
+     */
+    toJson(): {
+        type: string;
+        data: Record<string, any>;
+    };
+    /**
+     * 转为 CQ 码字符串
+     * @returns 例如 `[CQ:at,qq=123456]`
+     */
+    toCQ(): string;
+}