@karinjs/adapter-qqbot 1.2.9 → 1.2.10

package/lib/core/event/message.js

@@ -0,0 +1,95 @@
+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

@@ -0,0 +1,50 @@
+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;

package/lib/core/event/notice.js

@@ -0,0 +1,133 @@
+import { karin, segment, createGroupMemberAddNotice, createGroupMemberDelNotice, createFriendIncreaseNotice, createFriendDecreaseNotice } from 'node-karin';
+/**
+ * 机器人加入群聊事件
+ * @param client 机器人实例
+ * @param event 事件
+ */
+export const onGroupAddRobot = (client, event) => {
+    const selfId = client.selfId;
+    const userId = event.d.op_member_openid;
+    const groupId = event.d.group_openid;
+    const contact = karin.contactGroup(groupId);
+    const sender = karin.groupSender(userId, 'unknown');
+    const eventId = event.id;
+    const srcReply = (elements) => client.sendMsg(contact, [...elements, segment.pasmsg(eventId, 'event')]);
+    createGroupMemberAddNotice({
+        contact,
+        eventId,
+        sender,
+        srcReply,
+        bot: client,
+        rawEvent: event,
+        time: event.d.timestamp,
+        content: { operatorId: userId, targetId: selfId, type: 'invite' }
+    });
+};
+/**
+ * 机器人退出群聊事件
+ * @param client 机器人实例
+ * @param event 事件
+ */
+export const onGroupDelRobot = (client, event) => {
+    const selfId = client.selfId;
+    const userId = event.d.op_member_openid;
+    const groupId = event.d.group_openid;
+    const contact = karin.contactGroup(groupId);
+    const sender = karin.groupSender(userId, 'unknown');
+    const eventId = event.id;
+    const srcReply = (elements) => client.sendMsg(contact, [...elements, segment.pasmsg(eventId, 'event')]);
+    createGroupMemberDelNotice({
+        contact,
+        eventId,
+        sender,
+        srcReply,
+        bot: client,
+        rawEvent: event,
+        time: event.d.timestamp,
+        content: { operatorId: userId, targetId: selfId, type: 'kick' }
+    });
+};
+/**
+ * 群聊接受机器人主动消息
+ * @param client 机器人实例
+ * @param event 事件
+ */
+export const onGroupMsgReceive = (client, event) => {
+    const groupId = event.d.group_openid;
+    const userId = event.d.op_member_openid;
+    client.logger('mark', `群聊 ${groupId} 已允许机器人主动发送消息 操作人: ${userId}`);
+};
+/**
+ * 群聊拒绝机器人主动消息
+ * @param client 机器人实例
+ * @param event 事件
+ */
+export const onGroupMsgReject = (client, event) => {
+    const groupId = event.d.group_openid;
+    const userId = event.d.op_member_openid;
+    client.logger('mark', `群聊 ${groupId} 已拒绝机器人主动发送消息 操作人: ${userId}`);
+};
+/**
+ * 好友添加事件
+ * @param client 机器人实例
+ * @param event 事件
+ */
+export const onFriendAdd = (client, event) => {
+    const selfId = client.selfId;
+    const userId = event.d.openid;
+    const contact = karin.contactFriend(userId);
+    const sender = karin.friendSender(userId, '');
+    const eventId = event.id;
+    const srcReply = (elements) => client.sendMsg(contact, [...elements, segment.pasmsg(eventId, 'event')]);
+    createFriendIncreaseNotice({
+        contact,
+        eventId,
+        sender,
+        srcReply,
+        bot: client,
+        rawEvent: event,
+        time: event.d.timestamp,
+        content: { targetId: selfId }
+    });
+};
+/**
+ * 好友删除事件
+ * @param client 机器人实例
+ * @param event 事件
+ */
+export const onFriendDel = (client, event) => {
+    const selfId = client.selfId;
+    const userId = event.d.openid;
+    const contact = karin.contactFriend(userId);
+    const sender = karin.friendSender(userId, '');
+    const eventId = event.id;
+    const srcReply = (elements) => client.sendMsg(contact, [...elements, segment.pasmsg(eventId, 'event')]);
+    createFriendDecreaseNotice({
+        contact,
+        eventId,
+        sender,
+        srcReply,
+        bot: client,
+        rawEvent: event,
+        time: event.d.timestamp,
+        content: { targetId: selfId }
+    });
+};
+/**
+ * 好友接受机器人主动消息
+ * @param client 机器人实例
+ * @param event 事件
+ */
+export const onC2CMsgReceive = (client, event) => {
+    const userId = event.d.openid;
+    client.logger('mark', `好友 ${userId} 已允许机器人主动发送消息`);
+};
+/**
+ * 好友拒绝机器人主动消息
+ * @param client 机器人实例
+ * @param event 事件
+ */
+export const onC2CMsgReject = (client, event) => {
+    const userId = event.d.openid;
+    client.logger('mark', `好友 ${userId} 已拒绝机器人主动发送消息`);
+};

package/lib/{types/event.d.ts → core/event/types.d.ts}

@@ -1,4 +1,26 @@
-import { Attachment } from './media.js';
+/**
+ * 需要注意 目前只有私聊可以收到file类型的消息
+ */
+export type Content_type = 'image/gif' | 'image/jpeg' | 'image/png' | 'file';
+/**
+ * 富媒体基类
+ */
+export interface Attachment {
+    /** 类型 */
+    content_type: Content_type;
+    /** 未知作用 */
+    content?: string;
+    /** 文件名 */
+    filename: string;
+    /** 图片高度 */
+    height?: number;
+    /** 图片宽度 */
+    width?: number;
+    /** 文件大小 */
+    size: number;
+    /** 文件url */
+    url: string;
+}
 /**
  * opcode
  * 客户端操作含义如下：
@@ -48,7 +70,7 @@ export interface HeartbeatACKEvent {
 /**
  * 子事件类型
  */
-export declare const enum EventType {
+export declare const enum EventEnum {
     /** 在鉴权成功后下发 代表建立连接成功 */
     READY = "READY",
     /** 恢复登录状态后 不发遗漏事件完毕下发 */
@@ -141,20 +163,20 @@ export declare const enum EventType {
 /**
  * 子事件基类
  */
-export interface Event {
+export interface BaseEvent {
     /** opcode */
     op: Opcode.Dispatch;
     /** 序列号 */
     s: number;
     /** 事件类型 */
-    t: EventType;
+    t: EventEnum;
 }
 /**
  * READY子事件
  */
-export interface ReadyEvent extends Event {
+export interface ReadyEvent extends BaseEvent {
     /** 事件类型 */
-    t: EventType.READY;
+    t: EventEnum.READY;
     /** 事件内容 */
     d: {
         version: number;
@@ -173,10 +195,10 @@ export interface ReadyEvent extends Event {
 /**
  * C2C_MESSAGE_CREATE子事件
  */
-export interface C2CMessageCreateEvent extends Event {
+export interface C2CMsgEvent extends BaseEvent {
     /** 事件类型 */
-    t: EventType.C2C_MESSAGE_CREATE;
-    /** 平台方消息ID 格式: C2C_MESSAGE_CREATE:abc... */
+    t: EventEnum.C2C_MESSAGE_CREATE;
+    /** 平台方事件ID 格式: C2C_MESSAGE_CREATE:abc... */
     id: string;
     d: {
         /** 富媒体消息 */
@@ -199,10 +221,10 @@ export interface C2CMessageCreateEvent extends Event {
 /**
  * GROUP_AT_MESSAGE_CREATE子事件
  */
-export interface GroupAtMessageCreateEvent extends Event {
+export interface GroupMsgEvent extends BaseEvent {
     /** 事件类型 */
-    t: EventType.GROUP_AT_MESSAGE_CREATE;
-    /** 平台方消息ID 格式: GROUP_AT_MESSAGE_CREATE:abc... */
+    t: EventEnum.GROUP_AT_MESSAGE_CREATE;
+    /** 平台方事件ID 格式: GROUP_AT_MESSAGE_CREATE:abc... */
     id: string;
     d: {
         /** 富媒体消息 */
@@ -227,6 +249,225 @@ export interface GroupAtMessageCreateEvent extends Event {
     };
 }
 /**
- * 所有子事件
+ * 频道的user信息
+ */
+export interface GuildUser {
+    /** 发送者的头像url */
+    avatar: string;
+    /** 发送者是否为bot */
+    bot: boolean;
+    /** 发送者的id */
+    id: string;
+    /** 发送者的nickname */
+    username: string;
+}
+/** 基础消息事件 */
+export interface BaseMessageEvent {
+    /** 消息ID message_id */
+    id: string;
+    /** 消息内容 */
+    content: string;
+    /** 富媒体消息 */
+    attachments?: Array<Attachment>;
+    /** 消息发送时间 */
+    timestamp: string;
+}
+/** Guild 消息的通用结构 */
+export interface GuildMemberInfo {
+    /** 用户加入频道的时间 ISO8601 timestamp */
+    joined_at: string;
+    /** 用户在频道内的昵称 */
+    nick: string;
+    /** 用户在频道内的身份组ID */
+    roles: string[];
+}
+/** Guild 事件的公共部分 */
+export interface GuildBaseEvent extends BaseMessageEvent {
+    /** 发送者信息 */
+    author: GuildUser;
+    /** 子频道id */
+    channel_id: string;
+    /** 频道id */
+    guild_id: string;
+    /** 用于消息间的排序 */
+    seq: number;
+    /** 子频道消息 seq */
+    seq_in_channel: number;
+    /** 消息创建者的member信息 */
+    member: GuildMemberInfo;
+    /** 引用消息对象 */
+    message_reference?: {
+        /** 引用回复的消息 id */
+        message_id: string;
+        /** 是否忽略获取引用消息详情错误，默认否 */
+        ignore_get_message_error: boolean;
+    };
+    /** 附件 */
+    attachments?: Attachment[];
+}
+/**
+ * 频道文字子频道消息
+ */
+export interface GuildMsgEvent extends BaseEvent {
+    /** 事件类型 */
+    t: EventEnum.MESSAGE_CREATE | EventEnum.AT_MESSAGE_CREATE;
+    /** 平台方事件ID */
+    id: string;
+    /** 事件内容 */
+    d: GuildBaseEvent & {
+        /** 消息中at的人 */
+        mentions: [GuildUser];
+        /** 是否at all */
+        mention_everyone?: boolean;
+    };
+}
+/**
+ * 频道私信消息
+ */
+export interface DirectMsgEvent extends BaseEvent {
+    /** 事件类型 */
+    t: EventEnum.DIRECT_MESSAGE_CREATE;
+    /** 平台方事件ID */
+    id: string;
+    /** 事件内容 */
+    d: GuildBaseEvent & {
+        /** 是否为私信 */
+        direct_message: boolean;
+        /** 消息来源的频道id */
+        src_guild_id: string;
+        /** 未知字段 */
+        seq_in_channel: string;
+    };
+}
+/**
+ * 机器人加入群聊事件
+ */
+export interface GroupAddRobotEvent extends BaseEvent {
+    t: EventEnum.GROUP_ADD_ROBOT;
+    op: 0;
+    /** 平台方消息ID */
+    id: string;
+    d: {
+        /** 加入的时间戳 */
+        timestamp: number;
+        /** 加入群的群openid */
+        group_openid: string;
+        /** 操作添加机器人进群的群成员openid */
+        op_member_openid: '0337369D1F67F72EA9EEB6287B600488';
+    };
+}
+/**
+ * 机器人被移出群聊事件
+ */
+export interface GroupDelRobotEvent extends BaseEvent {
+    t: EventEnum.GROUP_DEL_ROBOT;
+    op: 0;
+    /** 平台方消息ID */
+    id: string;
+    d: {
+        /** 移出的时间戳 */
+        timestamp: number;
+        /** 移出群的群openid */
+        group_openid: string;
+        /** 操作移出机器人的群成员openid */
+        op_member_openid: '0337369D1F67F72EA9EEB6287B600488';
+    };
+}
+/**
+ * 群聊拒绝机器人主动消息
+ */
+export interface GroupMsgRejectEvent extends BaseEvent {
+    t: EventEnum.GROUP_MSG_REJECT;
+    op: 0;
+    /** 平台方消息ID */
+    id: string;
+    d: {
+        /** 操作时间戳 */
+        timestamp: number;
+        /** 操作群的群openid */
+        group_openid: string;
+        /** 操作拒绝机器人主动消息的群成员openid */
+        op_member_openid: '0337369D1F67F72EA9EEB6287B600488';
+    };
+}
+/**
+ * 群聊接受机器人主动消息
+ */
+export interface GroupMsgReceiveEvent extends BaseEvent {
+    t: EventEnum.GROUP_MSG_RECEIVE;
+    op: 0;
+    /** 平台方消息ID */
+    id: string;
+    d: {
+        /** 操作时间戳 */
+        timestamp: number;
+        /** 操作群的群openid */
+        group_openid: string;
+        /** 操作接受机器人主动消息的群成员openid */
+        op_member_openid: '0337369D1F67F72EA9EEB6287B600488';
+    };
+}
+/**
+ * 用户添加机器人事件
+ */
+export interface FriendAddEvent extends BaseEvent {
+    t: EventEnum.FRIEND_ADD;
+    op: 0;
+    /** 平台方消息ID */
+    id: string;
+    d: {
+        /** 添加时间戳 */
+        timestamp: number;
+        /** 添加机器人的用户openid */
+        openid: string;
+    };
+}
+/**
+ * 用户删除机器人事件
+ */
+export interface FriendDelEvent extends BaseEvent {
+    t: EventEnum.FRIEND_DEL;
+    op: 0;
+    /** 平台方消息ID */
+    id: string;
+    d: {
+        /** 删除时间戳 */
+        timestamp: number;
+        /** 删除机器人的用户openid */
+        openid: string;
+    };
+}
+/**
+ * 用户在机器人资料卡手动关闭"主动消息"推送
+ */
+export interface C2CMsgRejectEvent extends BaseEvent {
+    t: EventEnum.C2C_MSG_REJECT;
+    op: 0;
+    /** 平台方消息ID */
+    id: string;
+    d: {
+        /** 操作时间戳 */
+        timestamp: number;
+        /** 操作关闭主动消息推送的用户openid */
+        openid: string;
+    };
+}
+/**
+ * 用户在机器人资料卡手动开启"主动消息"推送开关
+ */
+export interface C2CMsgReceiveEvent extends BaseEvent {
+    t: EventEnum.C2C_MSG_RECEIVE;
+    op: 0;
+    /** 平台方消息ID */
+    id: string;
+    d: {
+        /** 操作时间戳 */
+        timestamp: number;
+        /** 操作开启主动消息推送的用户openid */
+        openid: string;
+    };
+}
+/**
+ * 所有事件
  */
-export type SubEvent = ReadyEvent | C2CMessageCreateEvent | GroupAtMessageCreateEvent;
+export type Event = ReadyEvent | C2CMsgEvent | GroupMsgEvent | GuildMsgEvent | DirectMsgEvent | GroupAddRobotEvent | GroupDelRobotEvent | GroupMsgRejectEvent | GroupMsgReceiveEvent | FriendAddEvent | FriendDelEvent | C2CMsgRejectEvent | C2CMsgReceiveEvent;

package/lib/core/internal/axios.d.ts

@@ -0,0 +1,25 @@
+/** 获取调用凭证返回类型 */
+export interface AccessTokenResponse {
+    /** 获取到的凭证 */
+    accessToken: string;
+    /** 凭证有效时间，单位：秒。目前是7200秒之内的值。 */
+    expiresIn: number;
+}
+/**
+ * @description 获取调用凭证
+ * @param url 请求地址
+ * @param appId 机器人ID
+ * @param secret 机器人密钥
+ * @returns 获取到的凭证
+ * @throws 获取调用凭证失败
+ */
+export declare const getAccessToken: (url: string, appId: string, secret: string) => Promise<{
+    accessToken: any;
+    expiresIn: any;
+}>;
+/**
+ * @description 创建axios实例
+ * @param url 请求地址
+ * @param appId 机器人ID
+ */
+export declare const createAxiosInstance: (url: string, appId: string) => import("axios").AxiosInstance;

package/lib/core/internal/axios.js

@@ -0,0 +1,46 @@
+import axios from 'node-karin/axios';
+/** 存储Bot对应的鉴权凭证 */
+const BotMap = new Map();
+/**
+ * @description 获取调用凭证
+ * @param url 请求地址
+ * @param appId 机器人ID
+ * @param secret 机器人密钥
+ * @returns 获取到的凭证
+ * @throws 获取调用凭证失败
+ */
+export const getAccessToken = async (url, appId, secret) => {
+    const response = await axios.post(url, {
+        appId: String(appId),
+        clientSecret: secret,
+    });
+    const { access_token: accessToken, expires_in: expiresIn } = response.data;
+    if (!accessToken || !expiresIn) {
+        throw new Error(`获取调用凭证失败: ${JSON.stringify(response.data)}`);
+    }
+    BotMap.set(appId, accessToken);
+    /** 剩下1分钟开始刷新 */
+    setTimeout(() => {
+        getAccessToken(url, appId, secret);
+    }, Number(expiresIn) * 1000 - 50000);
+    return { accessToken, expiresIn };
+};
+/**
+ * @description 创建axios实例
+ * @param url 请求地址
+ * @param appId 机器人ID
+ */
+export const createAxiosInstance = (url, appId) => {
+    const instance = axios.create({
+        baseURL: url,
+        headers: {
+            'Content-Type': 'application/json',
+        },
+        timeout: 5500,
+    });
+    instance.interceptors.request.use((config) => {
+        config.headers.Authorization = `QQBot ${BotMap.get(appId)}`;
+        return config;
+    });
+    return instance;
+};

package/lib/core/internal/sign.d.ts

@@ -0,0 +1,22 @@
+import nacl from 'tweetnacl';
+/**
+ * 从提供的种子生成密钥对
+ * @param seed 用于生成密钥的种子
+ */
+export declare const generateKeyPair: (seed: string) => nacl.SignKeyPair;
+/**
+ * 使用提供的私钥、事件时间戳和明文令牌对消息进行签名
+ * @param privateKey 用于签名的私钥
+ * @param eventTs 计算签名使用时间戳
+ * @param plainToken 需要计算签名的字符串
+ * @returns 生成的十六进制格式的签名
+ */
+export declare const signMessage: (privateKey: Uint8Array, eventTs: string, plainToken: string) => string;
+/**
+ * 签名
+ * @param secret 机器人密钥
+ * @param eventTs 计算签名使用时间戳
+ * @param plainToken 需要计算签名的字符串
+ * @returns 生成的十六进制格式的签名
+ */
+export declare const sign: (secret: string, eventTs: string, plainToken: string) => string;