@karinjs/adapter-qqbot 1.2.10 → 1.3.1

package/lib/core/api/types.d.ts

@@ -1,236 +0,0 @@
-import type { karinToQQBot } from 'node-karin';
-/** 上传富媒体文件场景 */
-export type Scene = 'user' | 'group';
-/** 上传富媒体文件类型 */
-export type MediaType = 'image' | 'video' | 'record' | 'file';
-/** 发送QQ消息请求参数基类 */
-export interface SendQQMessageRequest {
-    /** 消息类型：0 是文本，2 是 markdown， 3 ark，4 embed，7 media 富媒体 */
-    msg_type: 0 | 2 | 3 | 4 | 7;
-}
-/** 发送QQ被动消息参数 */
-export 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文本消息请求参数 */
-export interface SendQQTextMessageRequest extends SendQQMessageRequest, QQMessageID {
-    msg_type: 0;
-    /**
-     * 消息内容 支持如下内嵌格式
-     * - `<qqbot-at-user id="" />` `@用户` **注意双引号不能省略**
-     * - `<qqbot-at-everyone />` `@所有人`
-     */
-    content: string;
-}
-/** markdown消息结构 */
-export type Markdown = {
-    /** markdown 文本 */
-    content: string;
-} | {
-    /** markdown 模版id，申请模版后获得 */
-    custom_template_id: string;
-    /** 模版内变量与填充值的kv映射 */
-    params: {
-        key: string;
-        values: string[];
-    }[];
-};
-/** 按钮消息结构 */
-export type Keyboard = {
-    content: {
-        rows: ReturnType<typeof karinToQQBot>;
-    };
-} | {
-    /** 按钮模版id */
-    id: string;
-};
-/** 发送QQ Markdown 消息请求参数 */
-export 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 消息请求参数 */
-export interface SendQQArkMessageRequest extends SendQQMessageRequest, QQMessageID {
-    msg_type: 3;
-    /** ark 消息内容 */
-    ark: {
-        /** ark 模版id */
-        template_id: number;
-        /** 模版内变量与填充值的kv映射 tips: 未经测试 先any */
-        kv: any[];
-    };
-}
-/** 发送QQ Embed 消息请求参数 文档没看到发送接口 */
-/** 发送QQ Media 消息请求参数 */
-export interface SendQQMediaMessageRequest extends SendQQMessageRequest, QQMessageID {
-    msg_type: 7;
-    /** media 消息内容 */
-    media: {
-        /** 文件信息，用于发消息接口的 media 字段使用 */
-        file_info: string;
-    };
-    /** 当 msg_type = 7 时，content 字段需要填入一个值，譬如一个空格 “ ”，后续版本会修复该问题。 */
-    content: string;
-}
-/** 发送QQ消息请求参数 */
-export type SendQQMsg = SendQQTextMessageRequest | SendQQMarkdownMessageRequest | SendQQArkMessageRequest | SendQQMediaMessageRequest;
-/** 发送频道被动消息参数 */
-export interface SendGuildMessageID {
-    /** 消息ID */
-    msg_id?: string;
-    /** 事件id */
-    event_id?: string;
-}
-/** 发送频道引用消息参数 */
-export interface SendGuildQuoteMessage {
-    /** 引用消息的ID */
-    message_id?: string;
-    /** 是否忽略获取引用消息详情错误，默认否 */
-    ignore_get_message_error?: boolean;
-}
-/** 发送频道消息请求参数基类 */
-export interface SendGuildMessageRequest {
-    /** 单独加一个类型 用于区分不同的消息类型 */
-    type: 'text' | 'image' | 'embed' | 'ark' | 'markdown';
-}
-/** 发送频道 文本 消息请求参数 */
-export interface SendGuildTextMessageRequest extends SendGuildMessageID, SendGuildQuoteMessage, SendGuildMessageRequest {
-    type: 'text';
-    /**
-     * 消息内容 支持如下内嵌格式
-     * - `<@user_id>` `@用户`
-     * - `@everyone` `@所有人`
-     * - `<#channel_id>` `#子频道`
-     * - `<emoji:id>` `表情`
-     */
-    content: string;
-    /** 图片url地址 */
-    image?: string;
-}
-/** 发送频道 图片 消息请求参数 */
-export interface SendGuildImageMessageRequest extends SendGuildMessageID, SendGuildQuoteMessage, SendGuildMessageRequest {
-    type: 'image';
-    /** 图片url地址 */
-    image: string;
-}
-/** embeds消息结构 */
-export interface Embeds {
-    /** 标题 */
-    title: string;
-    /** 消息弹窗内容 */
-    prompt: string;
-    /** 缩略图 */
-    thumbnail: {
-        /** 图片地址 */
-        url: string;
-    };
-    /** embed 字段数据 */
-    fields: Record<string, any>[];
-}
-/** 发送频道 embed 消息请求参数 */
-export interface SendGuildEmbedMessageRequest extends SendGuildMessageID, SendGuildMessageRequest {
-    type: 'embed';
-    /** embed 消息内容 */
-    embed: Embeds;
-}
-/** ark消息结构 */
-export interface Ark {
-    /** 模版id */
-    template_id: number;
-    /** 模版内变量与填充值的kv映射 */
-    kv: {
-        key: string;
-        value: string;
-        /** 这个嵌套是认真的嘛... */
-        obj: {
-            obj_kv: {
-                key: string;
-                value: string;
-            }[];
-        }[];
-    }[];
-}
-/** 发送频道 ark 消息请求参数 */
-export interface SendGuildArkMessageRequest extends SendGuildMessageID, SendGuildMessageRequest {
-    type: 'ark';
-    /** ark 消息内容 */
-    ark: Ark;
-}
-/** 发送频道 markdown 消息请求参数 */
-export interface SendGuildMarkdownMessageRequest extends SendGuildMessageID, SendGuildMessageRequest {
-    type: 'markdown';
-    /** markdown 消息内容 */
-    markdown: Markdown;
-    /** 按钮 */
-    keyboard?: Keyboard;
-}
-/** 发送频道消息请求参数 */
-export type SendGuildMsg = SendGuildTextMessageRequest | SendGuildImageMessageRequest | SendGuildEmbedMessageRequest | SendGuildArkMessageRequest | SendGuildMarkdownMessageRequest;
-/** 获取当前机器人详情接口响应 */
-export interface GetMeResponse {
-    /** 机器人的频道ID */
-    id: string;
-    /** 机器人的昵称 */
-    username: string;
-    /** 用户头像 */
-    avatar: string;
-    /** 特殊关联应用的 openid */
-    union_openid: string;
-    /** 机器人关联的互联应用的用户信息 */
-    union_user_account: string;
-    /** 机器人的分享url */
-    share_url: string;
-    /** 机器人介绍 */
-    welcome_msg: string;
-}
-/** 创建私信会话接口响应 */
-export interface DmsResponse {
-    /** 频道ID 用于私信会话使用 */
-    guild_id: string;
-    /** 子频道ID 用于私信会话使用 */
-    channel_id: string;
-    /** 创建时间 */
-    create_time: string;
-}
-/** 发送QQ消息后响应 */
-export interface SendQQMsgResponse {
-    /** 消息唯一 ID */
-    id: string;
-    /** 发送时间 */
-    timestamp: number;
-}
-/** 发送频道消息后响应 */
-export interface SendGuildResponse {
-    /** 消息唯一 ID */
-    id: string;
-    /** 发送时间 ISO8601 timestamp */
-    timestamp: string;
-}
-/** 上传富媒体文件响应 */
-export interface UploadMediaResponse {
-    /** 文件 ID */
-    file_uuid: string;
-    /** 文件信息，用于发消息接口的 media 字段使用 */
-    file_info: string;
-    /** 有效期，表示剩余多少秒到期，到期后 file_info 失效，当等于 0 时，表示可长期使用 */
-    ttl: number;
-    /** 发送消息的唯一ID，当srv_send_msg设置为true时返回 */
-    id: string;
-}

package/lib/core/api/types.js

@@ -1 +0,0 @@
-export {};

package/lib/core/event/conver.d.ts

@@ -1,10 +0,0 @@
-import type { ElementTypes } from 'node-karin';
-import type { DirectMsgEvent, GuildMsgEvent, C2CMsgEvent, GroupMsgEvent } from './types';
-/**
- * QQBot群、私聊转karin消息端
- * @param appid 应用ID
- * @param event 事件
- * @param subBotID 机器人ID 也就是跟用户一样的ID 并非appid
- * @return karin格式消息
- */
-export declare const QQBotConvertKarin: (appid: string, event: C2CMsgEvent | GroupMsgEvent | GuildMsgEvent | DirectMsgEvent, subBotID: string) => Array<ElementTypes>;

package/lib/core/event/conver.js

@@ -1,57 +0,0 @@
-import { segment } from 'node-karin';
-import { config } from '@/utils/config';
-/**
- * QQBot群、私聊转karin消息端
- * @param appid 应用ID
- * @param event 事件
- * @param subBotID 机器人ID 也就是跟用户一样的ID 并非appid
- * @return karin格式消息
- */
-export const QQBotConvertKarin = (appid, event, subBotID) => {
-    const elements = [];
-    const data = event.d;
-    const mentions = {};
-    if (event.t === "MESSAGE_CREATE" /* EventEnum.MESSAGE_CREATE */ || event.t === "AT_MESSAGE_CREATE" /* EventEnum.AT_MESSAGE_CREATE */) {
-        event.d.mentions?.forEach(v => {
-            mentions[v.id] = v;
-        });
-    }
-    for (const v of data.attachments || []) {
-        if (v.content_type === 'file') {
-            console.log(v);
-            continue;
-        }
-        const url = v.url.startsWith('http') ? v.url : `https://${v.url}`;
-        elements.push(segment.image(url, {
-            subType: v.content_type.split('/')[1],
-            name: v.filename,
-            width: v.width,
-            height: v.height,
-        }));
-    }
-    const regex = /<faceType=\d+,faceId="\d+",ext="[^"]+">|<@!\d+>|[^<]+/g;
-    const result = data?.content?.match(regex) || [];
-    result.forEach(v => {
-        if (v.startsWith('<faceType=')) {
-            const Match = v.match(/faceId="(\d+)"/);
-            elements.push(segment.face(Number(Match[1])));
-        }
-        if (v.startsWith('<@!')) {
-            const id = v.replace(/^<@!|>$/g, '');
-            const name = mentions[id]?.username || '';
-            elements.push(segment.at(id === subBotID ? appid : id, name));
-        }
-        else {
-            const regex = config()?.[appid]?.regex || [];
-            for (const r of regex) {
-                const reg = r.reg instanceof RegExp ? r.reg : new RegExp(r.reg);
-                v = v.trim().replace(reg, r.rep);
-            }
-            elements.push(segment.text(v));
-        }
-    });
-    if (event.t === "GROUP_AT_MESSAGE_CREATE" /* EventEnum.GROUP_AT_MESSAGE_CREATE */) {
-        elements.unshift(segment.at(appid));
-    }
-    return elements;
-};

package/lib/core/event/index.d.ts

@@ -1,9 +0,0 @@
-import { AdapterQQBotNormal } from '@/core/adapter/normal';
-import { AdapterQQBotMarkdown } from '@/core/adapter/markdown';
-import type { Event } from '@/core/event/types';
-/**
- * 创建事件
- * @param client 机器人实例
- * @param event 事件
- */
-export declare const createEvent: (client: AdapterQQBotNormal | AdapterQQBotMarkdown, event: Event) => void;

package/lib/core/event/index.js

@@ -1,98 +0,0 @@
-import { URL } from 'url';
-import { QQBotApi } from '@/core/api';
-import { event } from '@/utils/common';
-import { config, pkg } from '@/utils/config';
-import { logger, registerBot } from 'node-karin';
-import { createC2CWebhook } from '@/core/webhook/c2c';
-import { createHttpWebhook } from '@/core/webhook/http';
-import { createWebSocketWebhook } from '@/core/webhook/ws';
-import { AdapterQQBotNormal } from '@/core/adapter/normal';
-import { AdapterQQBotMarkdown } from '@/core/adapter/markdown';
-import { createAxiosInstance, getAccessToken } from '@/core/internal/axios';
-import { GraphicTemplateMarkdown, rawMarkdown } from '@/core/adapter/handler';
-import { onChannelMsg, onDirectMsg, onFriendMsg, onGroupMsg } from '@/core/event/message';
-import { onGroupAddRobot, onGroupDelRobot } from '@/core/event/notice';
-const main = async () => {
-    const cfg = config();
-    for (const [key, value] of Object.entries(cfg)) {
-        if (!key || key === 'default')
-            continue;
-        const bot = Object.assign(cfg.default, value);
-        const appId = String(bot.appId);
-        await getAccessToken(bot.tokenApi, appId, bot.secret);
-        const url = bot.sandbox ? bot.sandboxApi : bot.prodApi;
-        const axios = createAxiosInstance(url, appId);
-        const api = new QQBotApi(axios);
-        const data = await api.getMe();
-        const { id, username, avatar } = data;
-        const client = createClient(bot, api);
-        client.account.name = username;
-        client.account.avatar = avatar;
-        client.account.selfId = appId;
-        const qq = new URL(data.share_url).searchParams.get('robot_uin');
-        client.account.subId.id = id;
-        client.account.subId.qq = qq;
-        client.account.subId.appid = appId;
-        client.account.subId.union_openid = data.union_openid;
-        event.on(appId, (event) => createEvent(client, event));
-        createC2CWebhook();
-        createHttpWebhook();
-        createWebSocketWebhook();
-        // 注册Bot
-        client.adapter.address = url;
-        client.adapter.secret = bot.secret;
-        client.adapter.version = pkg().version;
-        client.adapter.index = registerBot('http', client);
-    }
-};
-/**
- * 创建QQBot客户端
- * @param bot 机器人配置
- * @param api 机器人API
- */
-const createClient = (bot, api) => {
-    if (Number(bot.markdown?.mode) === 0) {
-        return new AdapterQQBotNormal(api);
-    }
-    if (Number(bot.markdown?.mode) === 1) {
-        return new AdapterQQBotMarkdown(api, rawMarkdown, bot);
-    }
-    if (Number(bot.markdown?.mode) === 3) {
-        return new AdapterQQBotMarkdown(api, GraphicTemplateMarkdown, bot);
-    }
-    if (Number(bot.markdown?.mode) === 4) {
-        return new AdapterQQBotMarkdown(api, GraphicTemplateMarkdown, bot);
-    }
-    if (Number(bot.markdown?.mode) === 5) {
-        return new AdapterQQBotMarkdown(api, GraphicTemplateMarkdown, bot);
-    }
-    /** 默认返回0 */
-    return new AdapterQQBotNormal(api);
-};
-/**
- * 创建事件
- * @param client 机器人实例
- * @param event 事件
- */
-export const createEvent = (client, event) => {
-    if (event.t === "GROUP_AT_MESSAGE_CREATE" /* EventEnum.GROUP_AT_MESSAGE_CREATE */) {
-        return onGroupMsg(client, event);
-    }
-    if (event.t === "C2C_MESSAGE_CREATE" /* EventEnum.C2C_MESSAGE_CREATE */) {
-        return onFriendMsg(client, event);
-    }
-    if (event.t === "MESSAGE_CREATE" /* EventEnum.MESSAGE_CREATE */ || event.t === "AT_MESSAGE_CREATE" /* EventEnum.AT_MESSAGE_CREATE */) {
-        return onChannelMsg(client, event);
-    }
-    if (event.t === "DIRECT_MESSAGE_CREATE" /* EventEnum.DIRECT_MESSAGE_CREATE */) {
-        return onDirectMsg(client, event);
-    }
-    if (event.t === "GROUP_ADD_ROBOT" /* EventEnum.GROUP_ADD_ROBOT */) {
-        return onGroupAddRobot(client, event);
-    }
-    if (event.t === "GROUP_DEL_ROBOT" /* EventEnum.GROUP_DEL_ROBOT */) {
-        return onGroupDelRobot(client, event);
-    }
-    logger.error(`未知事件类型: ${JSON.stringify(event)}`);
-};
-main();

package/lib/core/event/message.d.ts

@@ -1,27 +0,0 @@
-import type { AdapterQQBotNormal } from '../adapter/normal';
-import type { AdapterQQBotMarkdown } from '../adapter/markdown';
-import type { C2CMsgEvent, DirectMsgEvent, GroupMsgEvent, GuildMsgEvent } from './types';
-/**
- * 创建群消息事件
- * @param client 机器人实例
- * @param event 事件
- */
-export declare const onGroupMsg: (client: AdapterQQBotMarkdown | AdapterQQBotNormal, event: GroupMsgEvent) => void;
-/**
- * 创建好友消息事件
- * @param client 机器人实例
- * @param event 事件
- */
-export declare const onFriendMsg: (client: AdapterQQBotMarkdown | AdapterQQBotNormal, event: C2CMsgEvent) => void;
-/**
- * 创建频道消息事件
- * @param client 机器人实例
- * @param event 事件
- */
-export declare const onChannelMsg: (client: AdapterQQBotMarkdown | AdapterQQBotNormal, event: GuildMsgEvent) => void;
-/**
- * 创建频道私信事件
- * @param client 机器人实例
- * @param event 事件
- */
-export declare const onDirectMsg: (client: AdapterQQBotMarkdown | AdapterQQBotNormal, event: DirectMsgEvent) => void;

package/lib/core/event/message.js

@@ -1,95 +0,0 @@
-import { QQBotConvertKarin } from './conver';
-import { karin, createGroupMessage, createFriendMessage, segment, createGuildMessage, createDirectMessage } from 'node-karin';
-/**
- * 创建群消息事件
- * @param client 机器人实例
- * @param event 事件
- */
-export const onGroupMsg = (client, event) => {
-    const selfId = client.selfId;
-    const userId = event.d.author.member_openid;
-    const contact = karin.contactGroup(event.d.group_id);
-    const sender = karin.groupSender(userId, 'unknown');
-    const e = createGroupMessage({
-        bot: client,
-        elements: QQBotConvertKarin(selfId, event, client.selfSubId('id')),
-        eventId: event.id,
-        messageId: event.d.id,
-        messageSeq: 0,
-        rawEvent: event,
-        time: Number(event.d.timestamp),
-        contact,
-        sender,
-        srcReply: (elements) => client.srcReply(e, [...elements, segment.pasmsg(event.d.id)])
-    });
-};
-/**
- * 创建好友消息事件
- * @param client 机器人实例
- * @param event 事件
- */
-export const onFriendMsg = (client, event) => {
-    const selfId = client.selfId;
-    const userId = event.d.author.user_openid;
-    const contact = karin.contactFriend(userId);
-    const sender = karin.friendSender(userId, '');
-    const e = createFriendMessage({
-        bot: client,
-        elements: QQBotConvertKarin(selfId, event, client.selfSubId('id')),
-        eventId: event.id,
-        messageId: event.d.id,
-        messageSeq: 0,
-        rawEvent: event,
-        time: Number(event.d.timestamp),
-        contact,
-        sender,
-        srcReply: (elements) => client.srcReply(e, [...elements, segment.pasmsg(event.d.id)])
-    });
-};
-/**
- * 创建频道消息事件
- * @param client 机器人实例
- * @param event 事件
- */
-export const onChannelMsg = (client, event) => {
-    const selfId = client.selfId;
-    const userId = event.d.author.id;
-    const contact = karin.contact('guild', event.d.guild_id, event.d.channel_id);
-    const sender = karin.groupSender(userId, 'unknown', event.d.author.username);
-    const e = createGuildMessage({
-        bot: client,
-        elements: QQBotConvertKarin(selfId, event, client.selfSubId('id')),
-        eventId: event.id,
-        messageId: event.d.id,
-        messageSeq: 0,
-        rawEvent: event,
-        time: Number(event.d.timestamp),
-        contact,
-        sender,
-        srcReply: (elements) => client.srcReply(e, [...elements, segment.pasmsg(event.d.id)])
-    });
-};
-/**
- * 创建频道私信事件
- * @param client 机器人实例
- * @param event 事件
- */
-export const onDirectMsg = (client, event) => {
-    const selfId = client.selfId;
-    const userId = event.d.author.id;
-    const contact = karin.contact('direct', event.d.guild_id, event.d.channel_id);
-    const sender = karin.friendSender(userId, event.d.author.username);
-    const e = createDirectMessage({
-        bot: client,
-        elements: QQBotConvertKarin(selfId, event, client.selfSubId('id')),
-        eventId: event.id,
-        messageId: event.d.id,
-        messageSeq: 0,
-        rawEvent: event,
-        time: Number(event.d.timestamp),
-        contact,
-        sender,
-        srcGuildId: event.d.src_guild_id,
-        srcReply: (elements) => client.srcReply(e, [...elements, segment.pasmsg(event.d.id)]),
-    });
-};

package/lib/core/event/notice.d.ts

@@ -1,50 +0,0 @@
-import { AdapterQQBot } from '@/core/adapter/adapter';
-import type { GroupAddRobotEvent, GroupDelRobotEvent, GroupMsgRejectEvent, GroupMsgReceiveEvent, FriendAddEvent, FriendDelEvent, C2CMsgRejectEvent, C2CMsgReceiveEvent } from './types';
-/**
- * 机器人加入群聊事件
- * @param client 机器人实例
- * @param event 事件
- */
-export declare const onGroupAddRobot: (client: AdapterQQBot, event: GroupAddRobotEvent) => void;
-/**
- * 机器人退出群聊事件
- * @param client 机器人实例
- * @param event 事件
- */
-export declare const onGroupDelRobot: (client: AdapterQQBot, event: GroupDelRobotEvent) => void;
-/**
- * 群聊接受机器人主动消息
- * @param client 机器人实例
- * @param event 事件
- */
-export declare const onGroupMsgReceive: (client: AdapterQQBot, event: GroupMsgReceiveEvent) => void;
-/**
- * 群聊拒绝机器人主动消息
- * @param client 机器人实例
- * @param event 事件
- */
-export declare const onGroupMsgReject: (client: AdapterQQBot, event: GroupMsgRejectEvent) => void;
-/**
- * 好友添加事件
- * @param client 机器人实例
- * @param event 事件
- */
-export declare const onFriendAdd: (client: AdapterQQBot, event: FriendAddEvent) => void;
-/**
- * 好友删除事件
- * @param client 机器人实例
- * @param event 事件
- */
-export declare const onFriendDel: (client: AdapterQQBot, event: FriendDelEvent) => void;
-/**
- * 好友接受机器人主动消息
- * @param client 机器人实例
- * @param event 事件
- */
-export declare const onC2CMsgReceive: (client: AdapterQQBot, event: C2CMsgReceiveEvent) => void;
-/**
- * 好友拒绝机器人主动消息
- * @param client 机器人实例
- * @param event 事件
- */
-export declare const onC2CMsgReject: (client: AdapterQQBot, event: C2CMsgRejectEvent) => void;