@karinjs/adapter-qqbot 1.2.10 → 1.3.1

package/dist/index.d.ts

@@ -0,0 +1,499 @@
+import FormData from 'form-data';
+import * as axios from 'axios';
+import { karinToQQBot, AdapterBase, LogMethodNames, Contact, ButtonElement, KeyboardElement, MarkdownElement, MarkdownTplElement, SendMsgResults } from 'node-karin';
+
+/**
+ * @description 创建axios实例
+ * @param url 请求地址
+ * @param appId 机器人ID
+ */
+declare const createAxiosInstance: (url: string, appId: string) => axios.AxiosInstance;
+
+/** 上传富媒体文件场景 */
+type Scene = 'user' | 'group';
+/** 上传富媒体文件类型 */
+type MediaType = 'image' | 'video' | 'record' | 'file';
+/** 发送QQ消息请求参数基类 */
+interface SendQQMessageRequest {
+    /** 消息类型：0 是文本，2 是 markdown， 3 ark，4 embed，7 media 富媒体 */
+    msg_type: 0 | 2 | 3 | 4 | 7;
+}
+/** 发送QQ被动消息参数 */
+interface QQMessageID {
+    /** 前置收到的事件 ID，用于发送被动消息，支持事件："INTERACTION_CREATE"、"C2C_MSG_RECEIVE"、"FRIEND_ADD" */
+    event_id?: string;
+    /** 前置收到的用户发送过来的消息 ID，用于发送被动（回复）消息 */
+    msg_id?: string;
+    /** 回复消息的序号，与 msg_id 联合使用，避免相同消息id回复重复发送，不填默认是1。相同的 msg_id + msg_seq 重复发送会失败。 */
+    msg_seq?: number;
+}
+/** 发送QQ文本消息请求参数 */
+interface SendQQTextMessageRequest extends SendQQMessageRequest, QQMessageID {
+    msg_type: 0;
+    /**
+     * 消息内容 支持如下内嵌格式
+     * - `<qqbot-at-user id="" />` `@用户` **注意双引号不能省略**
+     * - `<qqbot-at-everyone />` `@所有人`
+     */
+    content: string;
+}
+/** markdown消息结构 */
+type Markdown = {
+    /** markdown 文本 */
+    content: string;
+} | {
+    /** markdown 模版id，申请模版后获得 */
+    custom_template_id: string;
+    /** 模版内变量与填充值的kv映射 */
+    params: {
+        key: string;
+        values: string[];
+    }[];
+};
+/** 按钮消息结构 */
+type Keyboard = {
+    content: {
+        rows: ReturnType<typeof karinToQQBot>;
+    };
+} | {
+    /** 按钮模版id */
+    id: string;
+};
+/** 发送QQ Markdown 消息请求参数 */
+interface SendQQMarkdownMessageRequest extends SendQQMessageRequest, QQMessageID {
+    msg_type: 2;
+    /**
+     * markdown 消息内容 支持如下内嵌格式
+     * - `<qqbot-cmd-enter text="xxx" />` `回车按钮: 点击后，文本直接发送`
+     * - `<qqbot-cmd-input text="xxx" show="xxx" reference="false" />` `点击后，文本输入框弹出`
+     * - `text 用户点击后插入输入框的文本，参数必填，最大限制 100 字符，传值时需要 urlencode`
+     * - `show 用户在消息内看到的文本，参数选填，默认取 text 值，最大限制 100 字符，传值时需要 urlencode。`
+     * - `reference 插入输入框时是否带消息原文回复引用，参数选填，默认为 false，填入 true 时则带引用回复到输入框中。`
+     *
+     * {@link https://bot.q.qq.com/wiki/develop/api-v2/server-inter/message/trans/text-chain.html}
+     */
+    markdown: Markdown;
+    /** 按钮 */
+    keyboard?: Keyboard;
+}
+/** 发送QQ Ark 消息请求参数 */
+interface SendQQArkMessageRequest extends SendQQMessageRequest, QQMessageID {
+    msg_type: 3;
+    /** ark 消息内容 */
+    ark: {
+        /** ark 模版id */
+        template_id: number;
+        /** 模版内变量与填充值的kv映射 tips: 未经测试 先any */
+        kv: any[];
+    };
+}
+/** 发送QQ Embed 消息请求参数 文档没看到发送接口 */
+/** 发送QQ Media 消息请求参数 */
+interface SendQQMediaMessageRequest extends SendQQMessageRequest, QQMessageID {
+    msg_type: 7;
+    /** media 消息内容 */
+    media: {
+        /** 文件信息，用于发消息接口的 media 字段使用 */
+        file_info: string;
+    };
+    /** 当 msg_type = 7 时，content 字段需要填入一个值，譬如一个空格 “ ”，后续版本会修复该问题。 */
+    content: string;
+}
+/** 发送QQ消息请求参数 */
+type SendQQMsg = SendQQTextMessageRequest | SendQQMarkdownMessageRequest | SendQQArkMessageRequest | SendQQMediaMessageRequest;
+/** 发送频道被动消息参数 */
+interface SendGuildMessageID {
+    /** 消息ID */
+    msg_id?: string;
+    /** 事件id */
+    event_id?: string;
+}
+/** 发送频道引用消息参数 */
+interface SendGuildQuoteMessage {
+    /** 引用消息的ID */
+    message_id?: string;
+    /** 是否忽略获取引用消息详情错误，默认否 */
+    ignore_get_message_error?: boolean;
+}
+/** 发送频道消息请求参数基类 */
+interface SendGuildMessageRequest {
+    /** 单独加一个类型 用于区分不同的消息类型 */
+    type: 'text' | 'image' | 'embed' | 'ark' | 'markdown';
+}
+/** 发送频道 文本 消息请求参数 */
+interface SendGuildTextMessageRequest extends SendGuildMessageID, SendGuildQuoteMessage, SendGuildMessageRequest {
+    type: 'text';
+    /**
+     * 消息内容 支持如下内嵌格式
+     * - `<@user_id>` `@用户`
+     * - `@everyone` `@所有人`
+     * - `<#channel_id>` `#子频道`
+     * - `<emoji:id>` `表情`
+     */
+    content: string;
+    /** 图片url地址 */
+    image?: string;
+}
+/** 发送频道 图片 消息请求参数 */
+interface SendGuildImageMessageRequest extends SendGuildMessageID, SendGuildQuoteMessage, SendGuildMessageRequest {
+    type: 'image';
+    /** 图片url地址 */
+    image: string;
+}
+/** embeds消息结构 */
+interface Embeds {
+    /** 标题 */
+    title: string;
+    /** 消息弹窗内容 */
+    prompt: string;
+    /** 缩略图 */
+    thumbnail: {
+        /** 图片地址 */
+        url: string;
+    };
+    /** embed 字段数据 */
+    fields: Record<string, any>[];
+}
+/** 发送频道 embed 消息请求参数 */
+interface SendGuildEmbedMessageRequest extends SendGuildMessageID, SendGuildMessageRequest {
+    type: 'embed';
+    /** embed 消息内容 */
+    embed: Embeds;
+}
+/** ark消息结构 */
+interface Ark {
+    /** 模版id */
+    template_id: number;
+    /** 模版内变量与填充值的kv映射 */
+    kv: {
+        key: string;
+        value: string;
+        /** 这个嵌套是认真的嘛... */
+        obj: {
+            obj_kv: {
+                key: string;
+                value: string;
+            }[];
+        }[];
+    }[];
+}
+/** 发送频道 ark 消息请求参数 */
+interface SendGuildArkMessageRequest extends SendGuildMessageID, SendGuildMessageRequest {
+    type: 'ark';
+    /** ark 消息内容 */
+    ark: Ark;
+}
+/** 发送频道 markdown 消息请求参数 */
+interface SendGuildMarkdownMessageRequest extends SendGuildMessageID, SendGuildMessageRequest {
+    type: 'markdown';
+    /** markdown 消息内容 */
+    markdown: Markdown;
+    /** 按钮 */
+    keyboard?: Keyboard;
+}
+/** 发送频道消息请求参数 */
+type SendGuildMsg = SendGuildTextMessageRequest | SendGuildImageMessageRequest | SendGuildEmbedMessageRequest | SendGuildArkMessageRequest | SendGuildMarkdownMessageRequest;
+/** 获取当前机器人详情接口响应 */
+interface GetMeResponse {
+    /** 机器人的频道ID */
+    id: string;
+    /** 机器人的昵称 */
+    username: string;
+    /** 用户头像 */
+    avatar: string;
+    /** 特殊关联应用的 openid */
+    union_openid: string;
+    /** 机器人关联的互联应用的用户信息 */
+    union_user_account: string;
+    /** 机器人的分享url */
+    share_url: string;
+    /** 机器人介绍 */
+    welcome_msg: string;
+}
+/** 创建私信会话接口响应 */
+interface DmsResponse {
+    /** 频道ID 用于私信会话使用 */
+    guild_id: string;
+    /** 子频道ID 用于私信会话使用 */
+    channel_id: string;
+    /** 创建时间 */
+    create_time: string;
+}
+/** 发送QQ消息后响应 */
+interface SendQQMsgResponse {
+    /** 消息唯一 ID */
+    id: string;
+    /** 发送时间 */
+    timestamp: number;
+}
+/** 发送频道消息后响应 */
+interface SendGuildResponse {
+    /** 消息唯一 ID */
+    id: string;
+    /** 发送时间 ISO8601 timestamp */
+    timestamp: string;
+}
+/** 上传富媒体文件响应 */
+interface UploadMediaResponse {
+    /** 文件 ID */
+    file_uuid: string;
+    /** 文件信息，用于发消息接口的 media 字段使用 */
+    file_info: string;
+    /** 有效期，表示剩余多少秒到期，到期后 file_info 失效，当等于 0 时，表示可长期使用 */
+    ttl: number;
+    /** 发送消息的唯一ID，当srv_send_msg设置为true时返回 */
+    id: string;
+}
+
+declare class QQBotApi {
+    /** axios 实例 */
+    axios: ReturnType<typeof createAxiosInstance>;
+    constructor(axios: ReturnType<typeof createAxiosInstance>);
+    /**
+     * 发送get请求
+     * @param path 请求路径
+     * @returns 请求结果
+     */
+    get<T>(path: string): Promise<T>;
+    /**
+     * 发送post请求
+     * @param path 请求路径
+     * @param options 请求数据
+     * @param headers 请求头
+     */
+    post<T>(path: string, options?: {}, headers?: Record<string, string>): Promise<T>;
+    /**
+     * 处理请求错误
+     * @param error 错误信息
+     */
+    handleError(path: string, options: any, error: any): void;
+    /**
+     * 发送单聊消息
+     * @param targetId 目标QQ用户的 openid
+     * @param options 消息参数
+     */
+    sendFriendMsg(targetId: string, options: SendQQMsg): Promise<SendQQMsgResponse>;
+    /**
+     * 发送群聊消息
+     * @param targetId 目标QQ群的 openid
+     * @param options 消息参数
+     */
+    sendGroupMsg(targetId: string, options: SendQQMsg): Promise<SendQQMsgResponse>;
+    /**
+     * 构建QQBot文本消息参数
+     * @param content 消息文本内容
+     */
+    QQdMsgOptions(type: 'text', content: string): SendQQTextMessageRequest;
+    /**
+     * 构建Markdown消息参数
+     * @param markdown Markdown文本内容
+     * @param keyboard 按钮
+     */
+    QQdMsgOptions(type: 'markdown', markdown: Markdown, keyboard?: Keyboard): SendQQMarkdownMessageRequest;
+    /**
+     * 构建Ark消息参数
+     * @param ark Ark参数
+     */
+    QQdMsgOptions(type: 'ark', ark: SendQQArkMessageRequest['ark']): SendQQArkMessageRequest;
+    /**
+     * 构建Media消息参数
+     * @param file 文件信息
+     */
+    QQdMsgOptions(type: 'media', file: string): SendQQMediaMessageRequest;
+    /**
+     * 构建频道文本、文本图片消息参数
+     * @param type 消息类型
+     * @param content 消息内容
+     * @param image 图片url
+     */
+    GuildMsgOptions(type: 'text', content: string, image?: string): SendGuildTextMessageRequest;
+    /**
+     * 构建图片消息参数
+     * @param type 消息类型
+     * @param image 图片url
+     */
+    GuildMsgOptions(type: 'image', image: string): SendGuildTextMessageRequest;
+    /**
+     * 构建Embed消息参数
+     * @param type 消息类型
+     * @param embed Embed参数
+     */
+    GuildMsgOptions(type: 'embed', embed: Embeds): SendGuildEmbedMessageRequest;
+    /**
+     * 构建Ark消息参数
+     * @param type 消息类型
+     * @param ark Ark参数
+     */
+    GuildMsgOptions(type: 'ark', ark: Ark): SendGuildArkMessageRequest;
+    /**
+     * 构建Markdown消息参数
+     * @param type 消息类型
+     * @param markdown Markdown文本
+     */
+    GuildMsgOptions(type: 'markdown', markdown: Markdown): SendGuildMarkdownMessageRequest;
+    /**
+     * 上传富媒体文件
+     * @param scene 上传场景
+     * @param targetId 目标id
+     * @param type 文件类型
+     * @param url 需要上传的文件的url
+     * @param srvSendMsg 是否发送消息
+     */
+    uploadMedia(scene: Scene, targetId: string, type: MediaType, url: string, srvSendMsg?: boolean): Promise<UploadMediaResponse>;
+    /**
+     * 上传富媒体文件
+     * @param scene 上传场景
+     * @param targetId 目标id
+     * @param type 文件类型
+     * @param base64 需要上传的文件的base64编码
+     * @param srvSendMsg 是否发送消息
+     */
+    uploadMedia(scene: Scene, targetId: string, type: MediaType, base64: string, srvSendMsg?: boolean): Promise<UploadMediaResponse>;
+    /**
+     * 单聊撤回消息
+     * @param type 场景类型
+     * @param targetId 目标QQ用户的openid
+     * @param messageId 消息id
+     */
+    recallMsg(type: 'user', targetId: string, messageId: string): Promise<boolean>;
+    /**
+     * 群聊撤回消息
+     * @param type 场景类型
+     * @param targetId 目标QQ群的openid
+     * @param messageId 消息id
+     */
+    recallMsg(type: 'group', targetId: string, messageId: string): Promise<boolean>;
+    /**
+     * 文字子频道撤回消息
+     * @param type 场景类型
+     * @param channelId 子频道的id
+     * @param messageId 消息id
+     * @param hidetip 是否隐藏提示小灰条，true 为隐藏，false 为显示。默认为false
+     */
+    recallMsg(type: 'channels', channelId: string, messageId: string, hidetip?: boolean): Promise<boolean>;
+    /**
+     * 频道私信撤回消息
+     * @param type 场景类型
+     * @param guildId 频道的id
+     * @param messageId 消息id
+     * @param hidetip 是否隐藏提示小灰条，true 为隐藏，false 为显示。默认为false
+     */
+    recallMsg(type: 'dms', guildId: string, messageId: string, hidetip?: boolean): Promise<boolean>;
+    /**
+     * 发送文字子频道消息
+     * @param targetId 目标子频道的id
+     * @param options 消息参数
+     */
+    sendChannelMsg(targetId: string, options: SendGuildMsg | FormData): Promise<SendGuildResponse>;
+    /**
+     * 直接发送频道消息
+     * @param guildID 频道的id
+     * @param options 消息参数
+     */
+    sendDmsMsg(guildID: string, options: SendGuildMsg | FormData): Promise<SendGuildResponse>;
+    /**
+     * 发送频道私信消息
+     * @param targetId 目标的id
+     * @param srcGuildId 源频道的id
+     * @param options 消息参数
+     */
+    sendDmsMsg(targetId: string, srcGuildId: string, options: SendGuildMsg | FormData): Promise<SendGuildResponse>;
+    /**
+     * 获取当前机器人详情
+     */
+    getMe(): Promise<GetMeResponse>;
+    /**
+     * 创建私信会话
+     * @param recipientID 接受者id
+     * @param srcGuildID 源频道id
+     */
+    dms(recipientID: string, srcGuildID: string): Promise<DmsResponse>;
+}
+
+/** 发送函数所需参数 */
+type Options<T extends 'qq' | 'guild'> = T extends 'qq' ? SendQQMsg : SendGuildMsg | FormData;
+type Pasmsg<T extends 'qq' | 'guild'> = {
+    type: 'msg' | 'event';
+    msg_id: string;
+    msg_seq: T extends 'qq' ? number : never;
+};
+interface Grouping<T extends 'qq' | 'guild'> {
+    /** 文本 */
+    content: string[];
+    /** 图片 QQ专属 */
+    image: string[];
+    /** 单行按钮 */
+    button: ButtonElement[];
+    /** 多行按钮 */
+    keyboard: KeyboardElement[];
+    /** markdown */
+    markdown: MarkdownElement[];
+    /** markdown模板 */
+    markdownTpl: MarkdownTplElement[];
+    /** 频道专属 图片url */
+    imageUrls: string[];
+    /** 频道专属 图片file */
+    imageFiles: string[];
+    /** 引用回复 频道专属 */
+    reply: {
+        message_id: string;
+    };
+    /** pasmsg */
+    pasmsg: Pasmsg<T>;
+    /** 代发送列表 */
+    list: Array<Options<T>>;
+    /**
+     * 处理按钮、markdown
+     * 统一格式后推入待发送消息列表
+     * @param type 构建类型
+     * @param list 分类列表
+     * @returns
+     */
+    markdownToButton: (type: T, list: Grouping<T>) => void;
+}
+/**
+ * @adaoter QQBot
+ * @version 1.8.0
+ */
+declare abstract class AdapterQQBot extends AdapterBase {
+    super: QQBotApi;
+    constructor(QQBot: QQBotApi);
+    logger(level: LogMethodNames, ...args: any[]): void;
+    /**
+     * 被动消息结构
+     * @param type 消息类型
+     */
+    pasmsg<T extends 'qq' | 'guild'>(type: T): Pasmsg<T>;
+    /**
+     * 撤回消息
+     * @param contact 联系人
+     * @param messageId 消息id
+     */
+    recallMsg(contact: Contact, messageId: string): Promise<void>;
+    /**
+     * 初始化消息分类对象
+     */
+    initList<T extends 'qq' | 'guild'>(type: T): Grouping<T>;
+    /**
+     * 初始化发送消息返回值
+     */
+    initSendMsgResults(): SendMsgResults;
+    /**
+     * 处理返回值
+     * @param data 返回值
+     */
+    handleResponse(data: SendMsgResults): SendMsgResults;
+    /**
+     * - 处理按钮、markdown
+     * - 统一格式后推入待发送消息列表
+     * @param type 消息类型
+     * @param button 按钮
+     * @param keyboard 键盘
+     * @param markdown markdown
+     * @param markdownTpl markdown模板
+     * @returns 消息列表
+     */
+    markdownToButton<T extends 'qq' | 'guild'>(type: T, list: Grouping<T>): void;
+}
+
+export { AdapterQQBot };

package/dist/index.js

@@ -0,0 +1,100 @@
+import {
+  basename,
+  config_exports,
+  event,
+  fakeEvent,
+  getConfig,
+  initQQBotAdapter,
+  sign
+} from "./chunk-PYOUSZ6B.js";
+
+// src/index.ts
+import { logger as logger2 } from "node-karin";
+
+// src/connection/routing.ts
+import { app } from "node-karin";
+import express from "node-karin/express";
+
+// src/connection/webhook.ts
+import { logger } from "node-karin";
+var webhookRouting = async (req, res) => {
+  var _a, _b, _c, _d;
+  const data = await checkAppid(req, res);
+  if (!data) return;
+  const cfg = getConfig(data.appid);
+  if (!cfg) {
+    logger.error(`[\u914D\u7F6E\u9519\u8BEF][${data.appid}] \u914D\u7F6E\u6587\u4EF6\u4E2D\u672A\u627E\u5230\u5BF9\u5E94\u7684appid\uFF0C\u8BF7\u68C0\u67E5\u914D\u7F6E\u6587\u4EF6`);
+    return;
+  }
+  if (cfg.event.type !== 1) {
+    logger.error(`[\u914D\u7F6E\u9519\u8BEF][${data.appid}] webhook\u672A\u542F\u7528\uFF0C\u8BF7\u68C0\u67E5\u914D\u7F6E\u6587\u4EF6`);
+    return;
+  }
+  if (data.body.op === 13) {
+    const eventTs = (_b = (_a = data.body) == null ? void 0 : _a.d) == null ? void 0 : _b.event_ts;
+    const plainToken = (_d = (_c = data.body) == null ? void 0 : _c.d) == null ? void 0 : _d.plain_token;
+    if (!eventTs || !plainToken) {
+      logger.error(`[\u8BF7\u6C42\u6570\u636E\u9519\u8BEF][${data.appid}] \u672A\u627E\u5230 event_ts \u6216 plain_token: ${data.rawBody}`);
+      return;
+    }
+    const signature2 = sign(cfg.secret, eventTs, plainToken);
+    logger.mark(`[signature][${data.appid}] ${signature2}`);
+    res.setHeader("Content-Type", "application/json");
+    res.status(200).end(JSON.stringify({ plain_token: plainToken, signature: signature2 }));
+    return;
+  }
+  const ed25519 = req.headers["x-signature-ed25519"];
+  const signature = sign(cfg.secret, req.headers["x-signature-timestamp"], data.rawBody);
+  if (ed25519 !== signature) {
+    fakeEvent(`\u7B7E\u540D\u9A8C\u8BC1\u5931\u8D25:
+appid: ${data.appid}
+ed25519: ${ed25519}
+\u5B9E\u9645\u7B7E\u540D: ${signature}
+body: ${data.rawBody}`);
+    return;
+  }
+  event.emit(data.appid, data.body);
+};
+var checkAppid = async (req, res) => {
+  let response = true;
+  try {
+    const ip = req.socket.remoteAddress;
+    const appid = req.headers["x-bot-appid"];
+    const rawBody = await new Promise((resolve) => {
+      const raw = [];
+      req.on("data", (chunk) => raw.push(chunk));
+      req.on("end", () => resolve(raw.join("")));
+    });
+    if (!appid) {
+      fakeEvent(`\u672A\u627E\u5230 x-bot-appid: ${ip} body: ${rawBody}`);
+      return;
+    }
+    const userAgent = req.headers["user-agent"];
+    if (userAgent !== "QQBot-Callback") {
+      fakeEvent(`\u672A\u627E\u5230 User-Agent: ${ip} body: ${rawBody}`);
+      return;
+    }
+    const body = JSON.parse(rawBody) || {};
+    if (typeof body.op !== "number") {
+      fakeEvent(`\u975E\u6CD5\u8BF7\u6C42\u4F53\uFF0C\u672A\u627E\u5230 op: ${ip} body: ${rawBody}`);
+      return;
+    } else if (body.op === 13) {
+      response = false;
+    }
+    return { appid, rawBody, body };
+  } finally {
+    response && res.status(200).end();
+  }
+};
+
+// src/connection/routing.ts
+var createRouting = () => {
+  const router = express.Router();
+  router.use("/webhook", webhookRouting);
+  app.use("/qqbot", router);
+};
+
+// src/index.ts
+logger2.info(`${logger2.violet(`[\u63D2\u4EF6:${config_exports.pkg().version}]`)} ${logger2.green(basename)} \u521D\u59CB\u5316\u5B8C\u6210~`);
+createRouting();
+initQQBotAdapter();

package/dist/web.config.d.ts

@@ -0,0 +1,25 @@
+import * as node_karin from 'node-karin';
+
+declare const _default: node_karin.DefineConfig<{
+    qqbot: [{
+        appId: string;
+        secret: string;
+        prodApi: string;
+        sandboxApi: string;
+        tokenApi: string;
+        sandbox: boolean;
+        qqEnable: boolean;
+        guildEnable: boolean;
+        guildMode: 0 | 1;
+        exclude: string[];
+        regex: string[];
+        "markdown:mode": 0 | 1 | 3 | 4 | 5;
+        "markdown:id": string;
+        "markdown:kv": string[];
+        "event:type": 0 | 1 | 2;
+        "event:wsUrl": string;
+        "event:wsToken": string;
+    }];
+}>;
+
+export { _default as default };