hotcat-bot-qq 0.0.1

package/dist/message.js

@@ -0,0 +1,187 @@
+const cqEscape = (v) => v.replace(/&/g, '&').replace(/\[/g, '[').replace(/\]/g, ']').replace(/,/g, ',');
+const toBase64 = (file) => Buffer.isBuffer(file) ? `base64://${file.toString('base64')}` : file;
+/**
+ * 消息段，搭配 {@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 class Message {
+    constructor(type, data) {
+        Object.defineProperty(this, "type", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "data", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.type = type;
+        this.data = data;
+    }
+    /** 文本消息段（发+收） */
+    static text(text) {
+        return new Message('text', { text });
+    }
+    /** @某人，传 QQ 号或 `'all'`（发+收） */
+    static at(qq) {
+        return new Message('at', { qq: String(qq) });
+    }
+    /** @全体成员（发） */
+    static atAll() {
+        return new Message('at', { qq: 'all' });
+    }
+    /** QQ 表情，传表情 ID（发+收） */
+    static face(id) {
+        return new Message('face', { id: String(id) });
+    }
+    /** 商城表情（仅发送，接收时归入 image 段） */
+    static mface(emoji_id, emoji_package_id, key, summary) {
+        return new Message('mface', { emoji_id: String(emoji_id), emoji_package_id: String(emoji_package_id), key, summary: summary ?? '' });
+    }
+    /** 图片，`file` 支持本地路径 / URL / Buffer（发+收） */
+    static image(file, summary, sub_type) {
+        return new Message('image', { file: toBase64(file), summary: summary ?? '', sub_type: sub_type != null ? String(sub_type) : '0' });
+    }
+    /** 引用回复，传消息 ID（发+收） */
+    static reply(id) {
+        return new Message('reply', { id: String(id) });
+    }
+    /** 文件，`file` 支持本地路径 / URL / Buffer（发+收） */
+    static file(file, name) {
+        return new Message('file', { file: toBase64(file), name: name ?? '' });
+    }
+    /** 短视频，`file` 支持本地路径 / URL / Buffer（发+收） */
+    static video(file, name, thumb) {
+        return new Message('video', { file: toBase64(file), name: name ?? '', thumb: thumb ?? '' });
+    }
+    /** 语音，`file` 支持本地路径 / URL / Buffer（发+收） */
+    static record(file, name, thumb) {
+        return new Message('record', { file: toBase64(file), name: name ?? '', thumb: thumb ?? '' });
+    }
+    /** JSON 消息段（发+收） */
+    static json(data) {
+        return new Message('json', { data });
+    }
+    /** 骰子（发+收） */
+    static dice() {
+        return new Message('dice', {});
+    }
+    /** 猜拳（发+收） */
+    static rps() {
+        return new Message('rps', {});
+    }
+    /** Markdown 消息（发+收） */
+    static markdown(content) {
+        return new Message('markdown', { content });
+    }
+    /** 平台音乐分享，type 支持 qq/163/kugou/migu/kuwo（仅发送） */
+    static music(type, id) {
+        return new Message('music', { type, id: String(id) });
+    }
+    /** 自定义音乐分享，需配置签名服务器（仅发送） */
+    static customMusic(type, url, image, audio, title, singer) {
+        return new Message('music', { type, url, image, audio: audio ?? '', title: title ?? '', singer: singer ?? '' });
+    }
+    /** 合并转发节点（引用已有消息，仅发送） */
+    static node(id, user_id, nickname, source, news, summary, prompt, time) {
+        return new Message('node', {
+            id: String(id),
+            user_id: user_id != null ? String(user_id) : '',
+            nickname: nickname ?? '',
+            source: source ?? '',
+            news: news ?? [],
+            summary: summary ?? '',
+            prompt: prompt ?? '',
+            time: time != null ? String(time) : '',
+        });
+    }
+    /** 合并转发节点（自定义内容，仅发送） */
+    static customNode(content, user_id, nickname, source, news, summary, prompt, time) {
+        return new Message('node', {
+            content: content.map(m => m.toJson()),
+            user_id: user_id != null ? String(user_id) : '',
+            nickname: nickname ?? '',
+            source: source ?? '',
+            news: news ?? [],
+            summary: summary ?? '',
+            prompt: prompt ?? '',
+            time: time != null ? String(time) : '',
+        });
+    }
+    /** 合并转发，传 message_id（发+收） */
+    static forward(message_id) {
+        return new Message('forward', { id: String(message_id) });
+    }
+    /** 推荐联系人/群（仅发送） */
+    static contact(type, id) {
+        return new Message('contact', { type, id: String(id) });
+    }
+    /**
+     * 从 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) {
+        return new Message(seg.type, { ...seg.data });
+    }
+    /**
+     * 转为 napcat API 所需的 JSON 格式
+     * @returns `{ type, data }`
+     */
+    toJson() {
+        const result = { type: this.type, data: {} };
+        for (const key of Object.keys(this.data)) {
+            const val = this.data[key];
+            if (key === 'news' && Array.isArray(val)) {
+                result.data[key] = val;
+            }
+            else if (key === 'content' && Array.isArray(val)) {
+                result.data[key] = val;
+            }
+            else if (val !== '' && val != null) {
+                result.data[key] = val;
+            }
+        }
+        return result;
+    }
+    /**
+     * 转为 CQ 码字符串
+     * @returns 例如 `[CQ:at,qq=123456]`
+     */
+    toCQ() {
+        if (this.type === 'text') {
+            return cqEscape(this.data.text ?? '');
+        }
+        const parts = [];
+        for (const [k, v] of Object.entries(this.data)) {
+            if (v == null || v === '' || (Array.isArray(v) && v.length === 0))
+                continue;
+            parts.push(`${k}=${cqEscape(Array.isArray(v) ? JSON.stringify(v) : String(v))}`);
+        }
+        return `[CQ:${this.type},${parts.join(',')}]`;
+    }
+}

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "hotcat-bot-qq",
+  "version": "0.0.1",
+  "description": "基于 node-napcat-ts 的 TypeScript QQ 机器人框架",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./message": {
+      "types": "./dist/message.d.ts",
+      "default": "./dist/message.js"
+    },
+    "./botApi": {
+      "types": "./dist/botApi.d.ts",
+      "default": "./dist/botApi.js"
+    },
+    "./botClient": {
+      "types": "./dist/botClient.d.ts",
+      "default": "./dist/botClient.js"
+    },
+    "./botConsole": {
+      "types": "./dist/botConsole.d.ts",
+      "default": "./dist/botConsole.js"
+    },
+    "./botEvent": {
+      "types": "./dist/botEvent.d.ts",
+      "default": "./dist/botEvent.js"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md",
+    "logo.png"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepublishOnly": "bun run build",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs"
+  },
+  "keywords": [
+    "qq",
+    "bot",
+    "napcat",
+    "onebot",
+    "typescript",
+    "chatbot"
+  ],
+  "author": "CHCAT1320",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/CHCAT1320/hotCat-bot-qq"
+  },
+  "dependencies": {
+    "node-napcat-ts": "^0.4.25",
+    "@types/node": "^26.1.2"
+  },
+  "devDependencies": {
+    "@types/node-schedule": "^2.1.8",
+    "dependency-cruiser": "^17.4.3",
+    "madge": "^8.0.0",
+    "patch-package": "^8.0.1",
+    "vitepress": "^1.6.4"
+  }
+}