node-karin 0.12.13 → 0.12.15

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

@@ -1,5 +1,5 @@
 /**
- * - 事件来源枚举
+ * 事件来源枚举
  */
 export declare const enum Scene {
     /** 群 */
@@ -9,7 +9,7 @@ export declare const enum Scene {
     /** 频道 */
     Guild = "guild",
     /** 频道私信 */
-    GuildPrivate = "guild_private",
+    GuildDirect = "guild_direct",
     /** 临时会话 */
     Nearby = "nearby",
     /** 陌生人 */
@@ -18,19 +18,13 @@ export declare const enum Scene {
     StrangerFromGroup = "stranger_from_group"
 }
 /**
- * - 事件联系人信息 也就是从哪来的这条消息
+ * 事件联系人信息 也就是从哪来的这条消息
  */
 export interface Contact {
-    /**
-     * - 事件来源场景
-     */
+    /** 事件来源场景 */
     scene: `${Scene}`;
-    /**
-     * - 事件来源id 群号或者用户id
-     */
+    /** 事件来源id 群号或者用户id */
     peer: string;
-    /**
-     * - 事件来源子id 仅在频道和临时会话中存在
-     */
+    /** 事件来源子id 仅在频道和临时会话中存在 */
     sub_peer?: string;
 }

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

@@ -6,133 +6,81 @@ import { Reply, replyCallback } from './reply.js';
  * 事件类型枚举
  */
 export declare const enum EventType {
-    /**
-     * - 消息事件
-     */
+    /** 消息事件 */
     Message = "message",
-    /**
-     * - 通知事件
-     */
+    /** 通知事件 */
     Notice = "notice",
-    /**
-     * - 请求事件
-     */
+    /** 请求事件 */
     Request = "request"
 }
 /**
  * 消息事件子类型枚举
  */
 export declare const enum MessageSubType {
-    /**
-     * - 群消息
-     */
+    /** 群消息 */
     GroupMessage = "group_message",
-    /**
-     * - 私聊消息
-     */
+    /** 私聊消息 */
     PrivateMessage = "private_message",
-    /**
-     * - 频道消息
-     */
+    /** 频道消息 */
     GuildMessage = "guild_message",
-    /**
-     * - 附近消息
-     */
+    /** 频道私信 */
+    GuildPrivateMessage = "guild_direct",
+    /** 附近消息 */
     Nearby = "nearby",
-    /**
-     * - 陌生人消息
-     */
+    /** 陌生人消息 */
     Stranger = "stranger"
 }
 /**
  * 通知事件子类型枚举
  */
 export declare const enum NoticeSubType {
-    /**
-     * - 私聊戳一戳
-     */
+    /** 私聊戳一戳 */
     PrivatePoke = "private_poke",
-    /**
-     * - 私聊撤回消息
-     */
+    /** 私聊撤回消息 */
     PrivateRecall = "private_recall",
-    /**
-     * - 私聊发送文件
-     */
+    /** 私聊发送文件 */
     PrivateFileUploaded = "private_file_uploaded",
-    /**
-     * - 群聊戳一戳
-     */
+    /** 群聊戳一戳 */
     GroupPoke = "group_poke",
-    /**
-     * - 群聊名片变动
-     */
+    /** 群聊名片变动 */
     GroupCardChanged = "group_card_changed",
-    /**
-     * - 群聊成员头衔变动
-     */
+    /** 群聊成员头衔变动 */
     GroupMemberUniqueTitleChanged = "group_member_unique_title_changed",
-    /**
-     * - 群聊精华消息变动
-     */
+    /** 群聊精华消息变动 */
     GroupEssenceChanged = "group_essence_changed",
-    /**
-     * - 群聊撤回消息
-     */
+    /** 群聊撤回消息 */
     GroupRecall = "group_recall",
-    /**
-     * - 群聊成员增加
-     */
+    /** 群聊成员增加 */
     GroupMemberIncrease = "group_member_increase",
-    /**
-     * - 群聊成员减少
-     */
+    /** 群聊成员减少 */
     GroupMemberDecrease = "group_member_decrease",
-    /**
-     * - 群聊管理员变动
-     */
+    /** 群聊管理员变动 */
     GroupAdminChanged = "group_admin_changed",
-    /**
-     * - 群聊成员禁言
-     */
+    /** 群聊成员禁言 */
     GroupMemberBan = "group_member_ban",
-    /**
-     * - 群聊签到
-     */
+    /** 群聊签到 */
     GroupSignIn = "group_sign_in",
-    /**
-     * - 群聊全员禁言
-     */
+    /** 群聊全员禁言 */
     GroupWholeBan = "group_whole_ban",
-    /**
-     * - 群聊发送文件
-     */
+    /** 群聊发送文件 */
     GroupFileUploaded = "group_file_uploaded",
-    /**
-     * - 群聊消息表情动态回应
-     */
-    GroupMessageReaction = "group_message_reaction"
+    /** 群聊消息表情动态回应 */
+    GroupMessageReaction = "group_message_reaction",
+    /** 好友增加 */
+    FriendIncrease = "friend_increase"
 }
 /**
  * 请求事件子类型枚举
  */
 export declare const enum RequestSubType {
-    /**
-     * - 好友申请
-     */
+    /** 好友申请 */
     PrivateApply = "private_apply",
-    /**
-     * - 群聊申请
-     */
+    /** 群聊申请 */
     GroupApply = "group_apply",
-    /**
-     * - 邀请入群
-     */
+    /** 邀请入群 */
     InvitedGroup = "invited_group"
 }
-/**
- * - 类型映射
- */
+/** 类型映射 */
 export type EventToSubEvent = {
     [EventType.Message]: MessageSubType;
     [EventType.Notice]: NoticeSubType;
@@ -162,42 +110,26 @@ export type AllListenEvent = `${EventType}` | `${CombinedEventType}`;
  * 事件基类定义
  */
 export interface KarinEventType {
-    /**
-     * - 机器人ID 请尽量使用UID
-     */
+    /** 机器人ID 请尽量使用UID */
     self_id: string;
-    /**
-     * - 用户ID
-     */
+    /** 用户ID */
     user_id: string;
     /**
      * - 群ID 仅在群聊中存在
      * @default ''
      */
     group_id: string;
-    /**
-     * - 事件类型
-     */
+    /** 事件类型 */
     event: EventType;
-    /**
-     * - 事件子类型
-     */
+    /** 事件子类型 */
     sub_event: EventToSubEvent[EventType];
-    /**
-     * - 事件ID
-     */
+    /** 事件ID */
     event_id: string;
-    /**
-     * - 事件触发时间戳
-     */
+    /** 事件触发时间戳 */
     time: number;
-    /**
-     * - 事件联系人信息
-     */
+    /** 事件联系人信息 */
     contact: Contact;
-    /**
-     * - 事件发送者信息
-     */
+    /** 事件发送者信息 */
     sender: Sender;
     /**
      * - 是否为主人
@@ -229,77 +161,41 @@ export interface KarinEventType {
      * @default false
      */
     isGroupTemp: boolean;
-    /**
-     * - 日志函数字符串
-     */
+    /** 日志函数字符串 */
     logFnc: string;
-    /**
-     * - 日志用户字符串
-     */
+    /** 日志用户字符串 */
     logText: string;
-    /**
-     * - 存储器 由开发者自行调用
-     */
+    /** 存储器 由开发者自行调用 */
     store: Map<any, any>;
-    /**
-     * - 原始消息
-     */
+    /** 原始消息 */
     raw_message: string;
-    /**
-     * - 原始事件字段
-     */
+    /** 原始事件字段 */
     raw_event: any;
-    /**
-     * - 回复函数
-     */
+    /** 回复函数 */
     reply: Reply;
-    /**
-     * - 回复函数 由适配器实现，开发者不应该直接调用
-     */
+    /** 回复函数 由适配器实现，开发者不应该直接调用 */
     replyCallback: replyCallback;
-    /**
-     * - bot实例
-     */
+    /** bot实例 */
     bot: KarinAdapter;
 }
-/**
- * - 基本事件参数
- */
+/** 基本事件参数 */
 export interface BaseEventDataType {
-    /**
-     * - 机器人ID 请尽量使用UID
-     */
+    /** 机器人ID */
     self_id: KarinEventType['self_id'];
-    /**
-     * - 用户ID
-     */
+    /** 用户ID */
     user_id: KarinEventType['user_id'];
-    /**
-     * - 群ID 仅在群聊中需要提供
-     */
+    /** 群ID 仅在群聊中需要提供 */
     group_id?: KarinEventType['group_id'];
-    /**
-     * - 事件触发时间戳
-     */
+    /** 事件触发时间戳 */
     time: KarinEventType['time'];
-    /**
-     * - 事件联系人信息
-     */
+    /** 事件联系人信息 */
     contact: KarinEventType['contact'];
-    /**
-     * - 事件发送者信息
-     */
+    /** 事件发送者信息 */
     sender: KarinEventType['sender'];
-    /**
-     * - 事件子类型
-     */
+    /** 事件子类型 */
     sub_event: KarinEventType['sub_event'];
-    /**
-     * - 事件ID
-     */
+    /** 事件ID */
     event_id: KarinEventType['event_id'];
-    /**
-     * - 原始事件字段
-     */
+    /** 原始事件字段 */
     raw_event: KarinEventType['raw_event'];
 }

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

@@ -1,42 +1,26 @@
 import { KarinElement } from '../element/element.js';
 import { KarinEventType, BaseEventDataType, EventType, MessageSubType } from './event.js';
-/**
- * - 消息事件定义
- */
+/** 消息事件定义 */
 export interface KarinMessageType extends KarinEventType {
     event: EventType.Message;
     sub_event: MessageSubType;
-    /**
-     * - 消息ID
-     */
+    /** 消息ID */
     message_id: string;
-    /**
-     * - 消息序列号
-     */
+    /** 消息序列号 */
     message_seq?: number;
-    /**
-     * - 原始消息文本
-     */
+    /** 原始消息文本 */
     raw_message: string;
-    /**
-     * - 消息体元素
-     */
+    /** 消息体元素 */
     elements: Array<KarinElement>;
-    /**
-     * - 群ID
-     */
+    /** 群ID */
     group_id: string;
     /**
      * 经过处理后的消息
      */
     msg: string;
-    /**
-     * - 消息图片
-     */
+    /** 消息图片 */
     image: string[];
-    /**
-     * - 语音url
-     */
+    /** 语音url */
     record: string;
     file: any;
     /**
@@ -55,14 +39,10 @@ export interface KarinMessageType extends KarinEventType {
      * 引用回复的消息id
      */
     reply_id: string;
-    /**
-     * - bot别名
-     */
+    /** bot别名 */
     alias: string;
 }
-/**
- * - 创建一个消息事件
- */
+/** 创建一个消息事件 */
 export declare class KarinMessage implements KarinMessageType {
     self_id: KarinMessageType['self_id'];
     user_id: KarinMessageType['user_id'];
@@ -99,7 +79,7 @@ export declare class KarinMessage implements KarinMessageType {
     at: KarinMessageType['at'];
     reply_id: KarinMessageType['reply_id'];
     alias: KarinMessageType['alias'];
-    constructor({ event, self_id, user_id, group_id, time, contact, sender, sub_event, event_id, message_id, message_seq, elements, raw_event, }: BaseEventDataType & {
+    constructor({ event, self_id: selfId, user_id: userId, group_id: groupId, time, contact, sender, sub_event: subEvent, event_id: eventId, message_id: messageId, message_seq: messageSeq, elements, raw_event: rawEvent, }: BaseEventDataType & {
         event: KarinMessageType['event'];
         sub_event: KarinMessageType['sub_event'];
         message_id: KarinMessageType['message_id'];

package/lib/types/event/message.js

@@ -1,6 +1,4 @@
-/**
- * - 创建一个消息事件
- */
+/** 创建一个消息事件 */
 export class KarinMessage {
     self_id;
     user_id;
@@ -37,20 +35,20 @@ export class KarinMessage {
     at;
     reply_id;
     alias;
-    constructor({ event, self_id, user_id, group_id = '', time, contact, sender, sub_event, event_id, message_id, message_seq, elements, raw_event, }) {
-        this.self_id = self_id;
-        this.user_id = user_id;
+    constructor({ event, self_id: selfId, user_id: userId, group_id: groupId = '', time, contact, sender, sub_event: subEvent, event_id: eventId, message_id: messageId, message_seq: messageSeq, elements, raw_event: rawEvent, }) {
+        this.self_id = selfId;
+        this.user_id = userId;
         this.time = time;
         this.event = event;
-        this.event_id = event_id;
+        this.event_id = eventId;
         this.contact = contact;
         this.sender = sender;
-        this.sub_event = sub_event;
-        this.message_id = message_id;
-        this.message_seq = message_seq;
+        this.sub_event = subEvent;
+        this.message_id = messageId;
+        this.message_seq = messageSeq;
         this.elements = elements;
-        this.group_id = contact.scene === 'group' ? (contact.peer || group_id) : group_id;
-        this.raw_event = raw_event;
+        this.group_id = contact.scene === 'group' ? (contact.peer || groupId) : groupId;
+        this.raw_event = rawEvent;
         this.isMaster = false;
         this.isAdmin = false;
         this.isPrivate = false;