node-karin 0.12.13 → 0.12.15

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

@@ -1,48 +1,26 @@
 import { KarinEventType, BaseEventDataType, EventType, NoticeSubType } from './event.js';
-/**
- * - 私聊戳一戳
- */
+/** 私聊戳一戳 */
 export interface PrivatePokeType {
-    /**
-     * - 操作者uid
-     */
+    /** 操作者uid */
     operator_uid: string;
-    /**
-     * - 操作者uin
-     */
+    /** 操作者uin */
     operator_uin: string;
-    /**
-     * - 操作名称，如“戳了戳”
-     */
+    /** 操作名称，如“戳了戳” */
     action: string;
-    /**
-     * - 后缀，未设置则未空字符串
-     */
+    /** 后缀，未设置则未空字符串 */
     suffix: string;
-    /**
-     * - 操作图标url
-     */
+    /** 操作图标url */
     action_image: string;
 }
-/**
- * - 私聊撤回消息
- */
+/** 私聊撤回消息 */
 export interface PrivateRecallType {
-    /**
-     * - 操作者uid
-     */
+    /** 操作者uid */
     operator_uid: string;
-    /**
-     * - 操作者uin
-     */
+    /** 操作者uin */
     operator_uin: string;
-    /**
-     * - 撤回的消息id
-     */
+    /** 撤回的消息id */
     message_id: string;
-    /**
-     * - 操作名称，如“撤回了一条消息”  一般此项为空字符串
-     */
+    /** 操作名称，如“撤回了一条消息”  一般此项为空字符串 */
     tip_text: string;
 }
 /**
@@ -50,70 +28,38 @@ export interface PrivateRecallType {
  * - 文件信息最少需要提供一个url
  */
 export interface PrivateFileUploadedType {
-    /**
-     * - 操作者uid
-     */
+    /** 操作者uid */
     operator_uid: string;
-    /**
-     * - 操作者uin
-     */
+    /** 操作者uin */
     operator_uin: string;
-    /**
-     * - 文件ID 此项没有则为空字符串
-     */
+    /** 文件ID 此项没有则为空字符串 */
     file_id: string;
-    /**
-     * - 文件子ID 此项没有则为空字符串
-     */
+    /** 文件子ID 此项没有则为空字符串 */
     file_sub_id: number;
-    /**
-     * - 文件名 此项没有则为空字符串
-     */
+    /** 文件名 此项没有则为空字符串 */
     file_name: string;
-    /**
-     * - 文件大小 此项没有则为0
-     */
+    /** 文件大小 此项没有则为0 */
     file_size: number;
-    /**
-     * - 过期时间 此项没有则为0
-     */
+    /** 过期时间 此项没有则为0 */
     expire_time: number;
-    /**
-     * - 文件URL
-     */
+    /** 文件URL */
     file_url: string;
 }
-/**
- * - 群聊戳一戳
- */
+/** 群聊戳一戳 */
 export interface GroupPokeType {
-    /**
-     * - 操作者uid
-     */
+    /** 操作者uid */
     operator_uid: string;
-    /**
-     * - 操作者uin
-     */
+    /** 操作者uin */
     operator_uin: string;
-    /**
-     * - 目标uid 一般为被戳的uid
-     */
+    /** 目标uid 一般为被戳的uid */
     target_uid: string;
-    /**
-     * - 目标uin 一般为被戳的uin
-     */
+    /** 目标uin 一般为被戳的uin */
     target_uin: string;
-    /**
-     * - 操作名称，如“戳了戳”
-     */
+    /** 操作名称，如“戳了戳” */
     action: string;
-    /**
-     * - 后缀，未设置则未空字符串
-     */
+    /** 后缀，未设置则未空字符串 */
     suffix: string;
-    /**
-     * - 操作图标url
-     */
+    /** 操作图标url */
     action_image: string;
 }
 /**
@@ -122,29 +68,17 @@ export interface GroupPokeType {
  * - 撤回别人消息时，operator为操作者，target为被撤回者
  */
 export interface GroupRecallType {
-    /**
-     * - 操作者uid
-     */
+    /** 操作者uid */
     operator_uid: string;
-    /**
-     * - 操作者uin
-     */
+    /** 操作者uin */
     operator_uin: string;
-    /**
-     * - 目标uid
-     */
+    /** 目标uid */
     target_uid: string;
-    /**
-     * - 目标uin
-     */
+    /** 目标uin */
     target_uin: string;
-    /**
-     * - 撤回的消息id
-     */
+    /** 撤回的消息id */
     message_id: string;
-    /**
-     * - 操作名称，如“撤回了一条消息”  一般此项为空字符串
-     */
+    /** 操作名称，如“撤回了一条消息”  一般此项为空字符串 */
     tip_text: string;
 }
 /**
@@ -152,296 +86,163 @@ export interface GroupRecallType {
  * - 文件信息最少需要提供一个url
  */
 export interface GroupFileUploadedType {
-    /**
-     * - 操作者uid
-     */
+    /** 操作者uid */
     operator_uid: string;
-    /**
-     * - 操作者uin
-     */
+    /** 操作者uin */
     operator_uin: string;
-    /**
-     * - 文件ID 此项没有则为空字符串
-     */
+    /** 文件ID 此项没有则为空字符串 */
     file_id: string;
-    /**
-     * - 文件子ID 此项没有则为0
-     */
+    /** 文件子ID 此项没有则为0 */
     file_sub_id: number;
-    /**
-     * - 文件名 此项没有则为空字符串
-     */
+    /** 文件名 此项没有则为空字符串 */
     file_name: string;
-    /**
-     * - 文件大小 此项没有则为0
-     */
+    /** 文件大小 此项没有则为0 */
     file_size: number;
-    /**
-     * - 过期时间 此项没有则为0
-     */
+    /** 过期时间 此项没有则为0 */
     expire_time: number;
-    /**
-     * - 文件URL
-     */
+    /** 文件URL */
     file_url: string;
 }
-/**
- * - 群名片变动
- */
+/** 群名片变动 */
 export interface GroupCardChangedType {
-    /**
-     * - 操作者uid
-     */
+    /** 操作者uid */
     operator_uid: string;
-    /**
-     * - 操作者uin
-     */
+    /** 操作者uin */
     operator_uin: string;
-    /**
-     * - 目标uid
-     */
+    /** 目标uid */
     target_uid: string;
-    /**
-     * - 目标uin
-     */
+    /** 目标uin */
     target_uin: string;
-    /**
-     * - 新名片
-     */
+    /** 新名片 */
     new_card: string;
 }
-/**
- * - 群成员头衔变动
- */
+/** 群成员头衔变动 */
 export interface GroupMemberUniqueTitleChangedType {
-    /**
-     * - 目标uid
-     */
+    /** 目标uid */
     target_uid: string;
-    /**
-     * - 目标uin
-     */
+    /** 目标uin */
     target_uin: string;
-    /**
-     * - 新头衔
-     */
+    /** 新头衔 */
     title: string;
 }
-/**
- * - 群精华消息变动
- */
+/** 群精华消息变动 */
 export interface GroupEssenceChangedType {
-    /**
-     * - 群ID
-     */
+    /** 群ID */
     group_id: string;
-    /**
-     * - 操作者uid
-     */
+    /** 操作者uid */
     operator_uid: string;
-    /**
-     * - 操作者uin
-     */
+    /** 操作者uin */
     operator_uin: string;
-    /**
-     * - 目标uid
-     */
+    /** 目标uid */
     target_uid: string;
-    /**
-     * - 目标uin
-     */
+    /** 目标uin */
     target_uin: string;
-    /**
-     * - 被操作的消息id
-     */
+    /** 被操作的消息id */
     message_id: string;
-    /**
-     * - 设置、取消精华
-     */
+    /** 设置、取消精华 */
     is_set: boolean;
 }
-/**
- * - 群成员增加
- */
+/** 群成员增加 */
 export interface GroupMemberIncreaseType {
-    /**
-     * - 群ID
-     */
+    /** 群ID */
     group_id: string;
-    /**
-     * - 操作者uid
-     */
+    /** 操作者uid */
     operator_uid: string;
-    /**
-     * - 操作者uin
-     */
+    /** 操作者uin */
     operator_uin: string;
-    /**
-     * - 目标uid
-     */
+    /** 目标uid */
     target_uid: string;
-    /**
-     * - 目标uin
-     */
+    /** 目标uin */
     target_uin: string;
-    /**
-     * - 加入方式 APPROVE:管理员批准 INVITE:管理员邀请
-     */
+    /** 加入方式 APPROVE:管理员批准 INVITE:管理员邀请 */
     type: 'invite' | 'approve';
 }
-/**
- * - 群成员减少
- */
+/** 群成员减少 */
 export interface GroupMemberDecreaseType {
-    /**
-     * - 群ID
-     */
+    /** 群ID */
     group_id: string;
-    /**
-     * - 操作者uid
-     */
+    /** 操作者uid */
     operator_uid: string;
-    /**
-     * - 操作者uin
-     */
+    /** 操作者uin */
     operator_uin: string;
-    /**
-     * - 目标uid
-     */
+    /** 目标uid */
     target_uid: string;
-    /**
-     * - 目标uin
-     */
+    /** 目标uin */
     target_uin: string;
-    /**
-     * - 减少方式 leave:主动退群 kick:成员被踢 kick_me:机器人自身被踢
-     */
+    /** 减少方式 leave:主动退群 kick:成员被踢 kick_me:机器人自身被踢 */
     type: 'leave' | 'kick' | 'kick_me';
 }
-/**
- * - 群管理员变动
- */
+/** 群管理员变动 */
 export interface GroupAdminChangedType {
-    /**
-     * - 群ID
-     */
+    /** 群ID */
     group_id: string;
-    /**
-     * - 目标uid
-     */
+    /** 目标uid */
     target_uid: string;
-    /**
-     * - 目标uin
-     */
+    /** 目标uin */
     target_uin: string;
-    /**
-     * - 设置、取消管理员
-     */
+    /** 设置、取消管理员 */
     is_admin: boolean;
 }
-/**
- * - 群打卡
- */
+/** 群打卡 */
 export interface GroupSignInType {
-    /**
-     * - 群ID
-     */
+    /** 群ID */
     group_id: string;
-    /**
-     * - 目标uid
-     */
+    /** 目标uid */
     target_uid: string;
-    /**
-     * - 目标uin
-     */
+    /** 目标uin */
     target_uin: string;
-    /**
-     * - 操作名称，如“打卡了”
-     */
+    /** 操作名称，如“打卡了” */
     action: string;
-    /**
-     * - 打卡图标url
-     */
+    /** 打卡图标url */
     rank_image: string;
 }
-/**
- * - 群成员被禁言
- */
+/** 群成员被禁言 */
 export interface GroupMemberBanType {
-    /**
-     * - 群ID
-     */
+    /** 群ID */
     group_id: string;
-    /**
-     * - 操作者uid
-     */
+    /** 操作者uid */
     operator_uid: string;
-    /**
-     * - 操作者uin
-     */
+    /** 操作者uin */
     operator_uin: string;
-    /**
-     * - 目标uid
-     */
+    /** 目标uid */
     target_uid: string;
-    /**
-     * - 目标uin
-     */
+    /** 目标uin */
     target_uin: string;
-    /**
-     * - 禁言时长，单位秒
-     */
+    /** 禁言时长，单位秒 */
     duration: number;
-    /**
-     * - 禁言类型 ban:禁言 lift_ban:解禁
-     */
+    /** 禁言类型 ban:禁言 lift_ban:解禁 */
     type: 'ban' | 'lift_ban';
 }
-/**
- * - 群全员禁言
- */
+/** 群全员禁言 */
 export interface GroupWholeBanType {
-    /**
-     * - 群ID
-     */
+    /** 群ID */
     group_id: string;
-    /**
-     * - 操作者uid
-     */
+    /** 操作者uid */
     operator_uid: string;
-    /**
-     * - 操作者uin
-     */
+    /** 操作者uin */
     operator_uin: string;
-    /**
-     * - 是否开启全体禁言
-     */
+    /** 是否开启全体禁言 */
     is_ban: boolean;
 }
-/**
- * - 群表情动态
- */
+/** 群表情动态 */
 export interface GroupMessageReactionType {
-    /**
-     * - 群ID
-     */
+    /** 群ID */
     group_id: string;
-    /**
-     * - 操作者uid
-     */
+    /** 操作者uid */
     message_id: string;
-    /**
-     * - 表情ID 参考: https://bot.q.qq.com/wiki/develop/api-v2/openapi/emoji/model.html#EmojiType
-     */
+    /** 表情ID 参考: https://bot.q.qq.com/wiki/develop/api-v2/openapi/emoji/model.html#EmojiType */
     face_id: number;
-    /**
-     * - 添加、取消回应
-     */
+    /** 添加、取消回应 */
     is_set: boolean;
 }
-/**
- * - 通知事件子类型
- */
+/** 新增好友 */
+export interface FriendIncreaseType {
+    /** 新好友uid */
+    target_uid: string;
+    /** 新好友uin */
+    target_uin: string;
+}
+/** 通知事件子类型 */
 export interface NoticeType {
     [NoticeSubType.PrivatePoke]: PrivatePokeType;
     [NoticeSubType.PrivateRecall]: PrivateRecallType;
@@ -459,27 +260,20 @@ export interface NoticeType {
     [NoticeSubType.GroupMemberBan]: GroupMemberBanType;
     [NoticeSubType.GroupWholeBan]: GroupWholeBanType;
     [NoticeSubType.GroupMessageReaction]: GroupMessageReactionType;
+    [NoticeSubType.FriendIncrease]: FriendIncreaseType;
 }
-/**
- * - 请求事件基类
- */
+/** 请求事件基类 */
 export interface KarinNoticeEventBase extends KarinEventType {
     event: EventType.Notice;
 }
-/**
- * - 辅助类型，用于生成 KarinRequestEvent 的联合类型来自动推导content的类型
- */
-type NoticeEvent<T extends NoticeSubType> = KarinNoticeEventBase & {
+/** 辅助类型，用于生成 KarinRequestEvent 的联合类型来自动推导content的类型 */
+export type NoticeEvent<T extends NoticeSubType> = KarinNoticeEventBase & {
     sub_event: T;
     content: NoticeType[T];
 };
-/**
- * - 通知事件定义
- */
-export type KarinNoticeType = NoticeEvent<NoticeSubType.PrivatePoke> | NoticeEvent<NoticeSubType.PrivateRecall> | NoticeEvent<NoticeSubType.PrivateFileUploaded> | NoticeEvent<NoticeSubType.GroupPoke> | NoticeEvent<NoticeSubType.GroupRecall> | NoticeEvent<NoticeSubType.GroupFileUploaded> | NoticeEvent<NoticeSubType.GroupCardChanged> | NoticeEvent<NoticeSubType.GroupMemberUniqueTitleChanged> | NoticeEvent<NoticeSubType.GroupEssenceChanged> | NoticeEvent<NoticeSubType.GroupMemberIncrease> | NoticeEvent<NoticeSubType.GroupMemberDecrease> | NoticeEvent<NoticeSubType.GroupAdminChanged> | NoticeEvent<NoticeSubType.GroupSignIn> | NoticeEvent<NoticeSubType.GroupMemberBan> | NoticeEvent<NoticeSubType.GroupWholeBan> | NoticeEvent<NoticeSubType.GroupMessageReaction>;
-/**
- * - 创建一个通知事件
- */
+/** 通知事件定义 */
+export type KarinNoticeType = NoticeEvent<NoticeSubType.PrivatePoke> | NoticeEvent<NoticeSubType.PrivateRecall> | NoticeEvent<NoticeSubType.PrivateFileUploaded> | NoticeEvent<NoticeSubType.GroupPoke> | NoticeEvent<NoticeSubType.GroupRecall> | NoticeEvent<NoticeSubType.GroupFileUploaded> | NoticeEvent<NoticeSubType.GroupCardChanged> | NoticeEvent<NoticeSubType.GroupMemberUniqueTitleChanged> | NoticeEvent<NoticeSubType.GroupEssenceChanged> | NoticeEvent<NoticeSubType.GroupMemberIncrease> | NoticeEvent<NoticeSubType.GroupMemberDecrease> | NoticeEvent<NoticeSubType.GroupAdminChanged> | NoticeEvent<NoticeSubType.GroupSignIn> | NoticeEvent<NoticeSubType.GroupMemberBan> | NoticeEvent<NoticeSubType.GroupWholeBan> | NoticeEvent<NoticeSubType.GroupMessageReaction> | NoticeEvent<NoticeSubType.FriendIncrease>;
+/** 创建一个通知事件 */
 export declare class KarinNotice implements KarinNoticeEventBase {
     self_id: KarinNoticeType['self_id'];
     user_id: KarinNoticeType['user_id'];
@@ -505,9 +299,8 @@ export declare class KarinNotice implements KarinNoticeEventBase {
     replyCallback: KarinNoticeType['replyCallback'];
     bot: KarinNoticeType['bot'];
     content: KarinNoticeType['content'];
-    constructor({ event_id, self_id, user_id, group_id, time, contact, sender, sub_event, content, raw_event, }: BaseEventDataType & {
+    constructor({ event_id: eventId, self_id: selfId, user_id: userId, group_id: groupId, time, contact, sender, sub_event: subEvent, content, raw_event: rawEvent, }: BaseEventDataType & {
         sub_event: KarinNoticeType['sub_event'];
         content: KarinNoticeType['content'];
     });
 }
-export {};

package/lib/types/event/notice.js

@@ -1,6 +1,4 @@
-/**
- * - 创建一个通知事件
- */
+/** 创建一个通知事件 */
 export class KarinNotice {
     self_id;
     user_id;
@@ -26,17 +24,17 @@ export class KarinNotice {
     replyCallback;
     bot;
     content;
-    constructor({ event_id, self_id, user_id, group_id = '', time, contact, sender, sub_event, content, raw_event, }) {
-        this.raw_event = raw_event;
-        this.self_id = self_id;
-        this.user_id = user_id;
-        this.group_id = contact.scene === 'group' ? (contact.peer || group_id) : group_id;
+    constructor({ event_id: eventId, self_id: selfId, user_id: userId, group_id: groupId = '', time, contact, sender, sub_event: subEvent, content, raw_event: rawEvent, }) {
+        this.raw_event = rawEvent;
+        this.self_id = selfId;
+        this.user_id = userId;
+        this.group_id = contact.scene === 'group' ? (contact.peer || groupId) : groupId;
         this.time = time;
         this.event = "notice" /* EventType.Notice */;
-        this.event_id = event_id;
+        this.event_id = eventId;
         this.contact = contact;
         this.sender = sender;
-        this.sub_event = sub_event;
+        this.sub_event = subEvent;
         this.isMaster = false;
         this.isAdmin = false;
         this.isPrivate = false;