node-karin 0.6.17 → 0.6.19

package/lib/types/element.d.ts

@@ -556,9 +556,10 @@ export type KarinElement = TextElement | AtElement | FaceElement | BubbleFaceEle
 /**
  * - 构建自定义转发节点 此元素仅可通过专用接口发送 不支持混合发送
  */
-export interface KarinNodeElement extends Element {
+export interface NodeElement extends Element {
     type: 'node';
-    user_id: string;
-    nickname: string;
-    content: KarinElement | Array<KarinElement>;
+    id?: string;
+    user_id?: string;
+    nickname?: string;
+    content?: KarinElement | Array<KarinElement>;
 }

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

@@ -0,0 +1,28 @@
+/**
+ * - 事件来源枚举
+ */
+export declare enum Scene {
+    Group = "group",
+    Private = "friend",
+    Guild = "guild",
+    Nearby = "nearby",
+    Stranger = "stranger",
+    StrangerFromGroup = "stranger_from_group"
+}
+/**
+ * - 事件联系人信息 也就是从哪来的这条消息
+ */
+export interface Contact {
+    /**
+     * - 事件来源场景
+     */
+    scene: Scene;
+    /**
+     * - 事件来源id 群号或者用户id
+     */
+    peer: string;
+    /**
+     * - 事件来源子id 仅在频道和临时会话中存在
+     */
+    sub_peer?: string;
+}

package/lib/types/event/contact.js

@@ -0,0 +1,13 @@
+/* eslint-disable no-unused-vars */
+/**
+ * - 事件来源枚举
+ */
+export var Scene;
+(function (Scene) {
+    Scene["Group"] = "group";
+    Scene["Private"] = "friend";
+    Scene["Guild"] = "guild";
+    Scene["Nearby"] = "nearby";
+    Scene["Stranger"] = "stranger";
+    Scene["StrangerFromGroup"] = "stranger_from_group";
+})(Scene || (Scene = {}));

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

@@ -0,0 +1,390 @@
+import { Sender } from './sender.js';
+import { Contact } from './contact.js';
+import { KarinAdapter } from '../../types/index.js';
+import { Reply, replyCallback } from './reply.js';
+/**
+ * 事件类型枚举
+ */
+export declare enum EventType {
+    /**
+     * - 消息事件
+     */
+    Message = "message",
+    /**
+     * - 通知事件
+     */
+    Notice = "notice",
+    /**
+     * - 请求事件
+     */
+    Request = "request"
+}
+/**
+ * 消息事件子类型枚举
+ */
+export declare enum MessageSubType {
+    /**
+     * - 群消息
+     */
+    GroupMessage = "group_message",
+    /**
+     * - 私聊消息
+     */
+    PrivateMessage = "private_message",
+    /**
+     * - 频道消息
+     */
+    GuildMessage = "guild_message",
+    /**
+     * - 附近消息
+     */
+    Nearby = "nearby",
+    /**
+     * - 陌生人消息
+     */
+    Stranger = "stranger"
+}
+/**
+ * 通知事件子类型枚举
+ */
+export declare 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"
+}
+/**
+ * 请求事件子类型枚举
+ */
+export declare enum RequestSubType {
+    /**
+     * - 好友申请
+     */
+    PrivateApply = "private_apply",
+    /**
+     * - 群聊申请
+     */
+    GroupApply = "group_apply",
+    /**
+     * - 邀请入群
+     */
+    InvitedGroup = "invited_group"
+}
+/**
+ * - 类型映射
+ */
+export type EventToSubEvent = {
+    [EventType.Message]: MessageSubType;
+    [EventType.Notice]: NoticeSubType;
+    [EventType.Request]: RequestSubType;
+};
+/**
+ * 组合事件类型枚举
+ */
+export declare enum CombinedEventType {
+    /**
+     * - 消息事件: 群消息
+     */
+    MessageGroupMessage = "message.group_message",
+    /**
+     * - 消息事件: 私聊消息
+     */
+    MessagePrivateMessage = "message.private_message",
+    /**
+     * - 消息事件: 频道消息
+     */
+    MessageGuildMessage = "message.guild_message",
+    /**
+     * - 消息事件: 附近消息
+     */
+    MessageNearby = "message.nearby",
+    /**
+     * - 消息事件: 陌生人消息
+     */
+    MessageStranger = "message.stranger",
+    /**
+     * - 通知事件: 私聊戳一戳
+     */
+    NoticePrivatePoke = "notice.private_poke",
+    /**
+     * - 通知事件: 私聊撤回消息
+     */
+    NoticePrivateRecall = "notice.private_recall",
+    /**
+     * - 通知事件: 私聊发送文件
+     */
+    NoticePrivateFileUploaded = "notice.private_file_uploaded",
+    /**
+     * - 通知事件: 群聊戳一戳
+     */
+    NoticeGroupPoke = "notice.group_poke",
+    /**
+     * - 通知事件: 群聊名片变动
+     */
+    NoticeGroupCardChanged = "notice.group_card_changed",
+    /**
+     * - 通知事件: 群聊成员头衔变动
+     */
+    NoticeGroupMemberUniqueTitleChanged = "notice.group_member_unique_title_changed",
+    /**
+     * - 通知事件: 群聊精华消息变动
+     */
+    NoticeGroupEssenceChanged = "notice.group_essence_changed",
+    /**
+     * - 通知事件: 群聊撤回消息
+     */
+    NoticeGroupRecall = "notice.group_recall",
+    /**
+     * - 通知事件: 群聊成员增加
+     */
+    NoticeGroupMemberIncrease = "notice.group_member_increase",
+    /**
+     * - 通知事件: 群聊成员减少
+     */
+    NoticeGroupMemberDecrease = "notice.group_member_decrease",
+    /**
+     * - 通知事件: 群聊管理员变动
+     */
+    NoticeGroupAdminChanged = "notice.group_admin_changed",
+    /**
+     * - 通知事件: 群聊成员禁言
+     */
+    NoticeGroupMemberBan = "notice.group_member_ban",
+    /**
+     * - 通知事件: 群聊签到
+     */
+    NoticeGroupSignIn = "notice.group_sign_in",
+    /**
+     * - 通知事件: 群聊全员禁言
+     */
+    NoticeGroupWholeBan = "notice.group_whole_ban",
+    /**
+     * - 通知事件: 群聊发送文件
+     */
+    NoticeGroupFileUploaded = "notice.group_file_uploaded",
+    /**
+     * - 通知事件: 群聊消息表情动态回应
+     */
+    NoticeGroupMessageReaction = "notice.group_message_reaction",
+    /**
+     * - 请求事件: 好友申请
+     */
+    RequestPrivateApply = "request.private_apply",
+    /**
+     * - 请求事件: 群聊申请
+     */
+    RequestGroupApply = "request.group_apply",
+    /**
+     * - 请求事件: 邀请入群
+     */
+    RequestInvitedGroup = "request.invited_group"
+}
+/**
+ * 所有监听事件
+ */
+export type AllListenEvent = 'message' | 'notice' | 'request' | 'message.group_message' | 'message.private_message' | 'message.guild_message' | 'message.nearby' | 'message.stranger' | 'notice.private_poke' | 'notice.private_recall' | 'notice.private_file_uploaded' | 'notice.group_poke' | 'notice.group_card_changed' | 'notice.group_member_unique_title_changed' | 'notice.group_essence_changed' | 'notice.group_recall' | 'notice.group_member_increase' | 'notice.group_member_decrease' | 'notice.group_admin_changed' | 'notice.group_member_ban' | 'notice.group_sign_in' | 'notice.group_whole_ban' | 'notice.group_file_uploaded' | 'notice.group_message_reaction' | 'request.private_apply' | 'request.group_apply' | 'request.invited_group';
+/**
+ * 事件基类定义
+ */
+export interface KarinEventType {
+    /**
+     * - 机器人ID 请尽量使用UID
+     */
+    self_id: string;
+    /**
+     * - 用户ID
+     */
+    user_id: string;
+    /**
+     * - 群ID 仅在群聊中存在
+     * @default ''
+     */
+    group_id: string;
+    /**
+     * - 事件类型
+     */
+    event: EventType;
+    /**
+     * - 事件子类型
+     */
+    sub_event: EventToSubEvent[EventType];
+    /**
+     * - 事件ID
+     */
+    event_id: string;
+    /**
+     * - 事件触发时间戳
+     */
+    time: number;
+    /**
+     * - 事件联系人信息
+     */
+    contact: Contact;
+    /**
+     * - 事件发送者信息
+     */
+    sender: Sender;
+    /**
+     * - 是否为主人
+     * @default false
+     */
+    isMaster: boolean;
+    /**
+     * - 是否为管理员
+     * @default false
+     */
+    isAdmin: boolean;
+    /**
+     * - 是否为私聊
+     * @default false
+     */
+    isPrivate: boolean;
+    /**
+     * - 是否为群聊
+     * @default false
+     */
+    isGroup: boolean;
+    /**
+     * - 是否为频道
+     * @default false
+     */
+    isGuild: boolean;
+    /**
+     * - 是否为群临时会话
+     * @default false
+     */
+    isGroupTemp: boolean;
+    /**
+     * - 日志函数字符串
+     */
+    logFnc: string;
+    /**
+     * - 日志用户字符串
+     */
+    logText: string;
+    /**
+     * - 存储器 由开发者自行调用
+     */
+    store: Map<string, any>;
+    /**
+     * - 原始消息
+     */
+    raw_message: string;
+    /**
+     * - 原始事件字段
+     */
+    raw_event: any;
+    /**
+     * - 回复函数
+     */
+    reply: Reply;
+    /**
+     * - 回复函数 由适配器实现，开发者不应该直接调用
+     */
+    replyCallback: replyCallback;
+    /**
+     * - bot实例
+     */
+    bot: KarinAdapter;
+}
+/**
+ * - 基本事件参数
+ */
+export interface BaseEventDataType {
+    /**
+     * - 机器人ID 请尽量使用UID
+     */
+    self_id: KarinEventType['self_id'];
+    /**
+     * - 用户ID
+     */
+    user_id: KarinEventType['user_id'];
+    /**
+     * - 群ID 仅在群聊中需要提供
+     */
+    group_id?: KarinEventType['group_id'];
+    /**
+     * - 事件触发时间戳
+     */
+    time: KarinEventType['time'];
+    /**
+     * - 事件联系人信息
+     */
+    contact: KarinEventType['contact'];
+    /**
+     * - 事件发送者信息
+     */
+    sender: KarinEventType['sender'];
+    /**
+     * - 事件子类型
+     */
+    sub_event: KarinEventType['sub_event'];
+    /**
+     * - 事件ID
+     */
+    event_id: KarinEventType['event_id'];
+    /**
+     * - 原始事件字段
+     */
+    raw_event: KarinEventType['raw_event'];
+}

package/lib/types/event/event.js

@@ -0,0 +1,234 @@
+/**
+ * 事件类型枚举
+ */
+export var EventType;
+(function (EventType) {
+    /**
+     * - 消息事件
+     */
+    EventType["Message"] = "message";
+    /**
+     * - 通知事件
+     */
+    EventType["Notice"] = "notice";
+    /**
+     * - 请求事件
+     */
+    EventType["Request"] = "request";
+})(EventType || (EventType = {}));
+/**
+ * 消息事件子类型枚举
+ */
+export var MessageSubType;
+(function (MessageSubType) {
+    /**
+     * - 群消息
+     */
+    MessageSubType["GroupMessage"] = "group_message";
+    /**
+     * - 私聊消息
+     */
+    MessageSubType["PrivateMessage"] = "private_message";
+    /**
+     * - 频道消息
+     */
+    MessageSubType["GuildMessage"] = "guild_message";
+    /**
+     * - 附近消息
+     */
+    MessageSubType["Nearby"] = "nearby";
+    /**
+     * - 陌生人消息
+     */
+    MessageSubType["Stranger"] = "stranger";
+})(MessageSubType || (MessageSubType = {}));
+/**
+ * 通知事件子类型枚举
+ */
+export var NoticeSubType;
+(function (NoticeSubType) {
+    /**
+     * - 私聊戳一戳
+     */
+    NoticeSubType["PrivatePoke"] = "private_poke";
+    /**
+     * - 私聊撤回消息
+     */
+    NoticeSubType["PrivateRecall"] = "private_recall";
+    /**
+     * - 私聊发送文件
+     */
+    NoticeSubType["PrivateFileUploaded"] = "private_file_uploaded";
+    /**
+     * - 群聊戳一戳
+     */
+    NoticeSubType["GroupPoke"] = "group_poke";
+    /**
+     * - 群聊名片变动
+     */
+    NoticeSubType["GroupCardChanged"] = "group_card_changed";
+    /**
+     * - 群聊成员头衔变动
+     */
+    NoticeSubType["GroupMemberUniqueTitleChanged"] = "group_member_unique_title_changed";
+    /**
+     * - 群聊精华消息变动
+     */
+    NoticeSubType["GroupEssenceChanged"] = "group_essence_changed";
+    /**
+     * - 群聊撤回消息
+     */
+    NoticeSubType["GroupRecall"] = "group_recall";
+    /**
+     * - 群聊成员增加
+     */
+    NoticeSubType["GroupMemberIncrease"] = "group_member_increase";
+    /**
+     * - 群聊成员减少
+     */
+    NoticeSubType["GroupMemberDecrease"] = "group_member_decrease";
+    /**
+     * - 群聊管理员变动
+     */
+    NoticeSubType["GroupAdminChanged"] = "group_admin_changed";
+    /**
+     * - 群聊成员禁言
+     */
+    NoticeSubType["GroupMemberBan"] = "group_member_ban";
+    /**
+     * - 群聊签到
+     */
+    NoticeSubType["GroupSignIn"] = "group_sign_in";
+    /**
+     * - 群聊全员禁言
+     */
+    NoticeSubType["GroupWholeBan"] = "group_whole_ban";
+    /**
+     * - 群聊发送文件
+     */
+    NoticeSubType["GroupFileUploaded"] = "group_file_uploaded";
+    /**
+     * - 群聊消息表情动态回应
+     */
+    NoticeSubType["GroupMessageReaction"] = "group_message_reaction";
+})(NoticeSubType || (NoticeSubType = {}));
+/**
+ * 请求事件子类型枚举
+ */
+export var RequestSubType;
+(function (RequestSubType) {
+    /**
+     * - 好友申请
+     */
+    RequestSubType["PrivateApply"] = "private_apply";
+    /**
+     * - 群聊申请
+     */
+    RequestSubType["GroupApply"] = "group_apply";
+    /**
+     * - 邀请入群
+     */
+    RequestSubType["InvitedGroup"] = "invited_group";
+})(RequestSubType || (RequestSubType = {}));
+/**
+ * 组合事件类型枚举
+ */
+export var CombinedEventType;
+(function (CombinedEventType) {
+    /**
+     * - 消息事件: 群消息
+     */
+    CombinedEventType["MessageGroupMessage"] = "message.group_message";
+    /**
+     * - 消息事件: 私聊消息
+     */
+    CombinedEventType["MessagePrivateMessage"] = "message.private_message";
+    /**
+     * - 消息事件: 频道消息
+     */
+    CombinedEventType["MessageGuildMessage"] = "message.guild_message";
+    /**
+     * - 消息事件: 附近消息
+     */
+    CombinedEventType["MessageNearby"] = "message.nearby";
+    /**
+     * - 消息事件: 陌生人消息
+     */
+    CombinedEventType["MessageStranger"] = "message.stranger";
+    /**
+     * - 通知事件: 私聊戳一戳
+     */
+    CombinedEventType["NoticePrivatePoke"] = "notice.private_poke";
+    /**
+     * - 通知事件: 私聊撤回消息
+     */
+    CombinedEventType["NoticePrivateRecall"] = "notice.private_recall";
+    /**
+     * - 通知事件: 私聊发送文件
+     */
+    CombinedEventType["NoticePrivateFileUploaded"] = "notice.private_file_uploaded";
+    /**
+     * - 通知事件: 群聊戳一戳
+     */
+    CombinedEventType["NoticeGroupPoke"] = "notice.group_poke";
+    /**
+     * - 通知事件: 群聊名片变动
+     */
+    CombinedEventType["NoticeGroupCardChanged"] = "notice.group_card_changed";
+    /**
+     * - 通知事件: 群聊成员头衔变动
+     */
+    CombinedEventType["NoticeGroupMemberUniqueTitleChanged"] = "notice.group_member_unique_title_changed";
+    /**
+     * - 通知事件: 群聊精华消息变动
+     */
+    CombinedEventType["NoticeGroupEssenceChanged"] = "notice.group_essence_changed";
+    /**
+     * - 通知事件: 群聊撤回消息
+     */
+    CombinedEventType["NoticeGroupRecall"] = "notice.group_recall";
+    /**
+     * - 通知事件: 群聊成员增加
+     */
+    CombinedEventType["NoticeGroupMemberIncrease"] = "notice.group_member_increase";
+    /**
+     * - 通知事件: 群聊成员减少
+     */
+    CombinedEventType["NoticeGroupMemberDecrease"] = "notice.group_member_decrease";
+    /**
+     * - 通知事件: 群聊管理员变动
+     */
+    CombinedEventType["NoticeGroupAdminChanged"] = "notice.group_admin_changed";
+    /**
+     * - 通知事件: 群聊成员禁言
+     */
+    CombinedEventType["NoticeGroupMemberBan"] = "notice.group_member_ban";
+    /**
+     * - 通知事件: 群聊签到
+     */
+    CombinedEventType["NoticeGroupSignIn"] = "notice.group_sign_in";
+    /**
+     * - 通知事件: 群聊全员禁言
+     */
+    CombinedEventType["NoticeGroupWholeBan"] = "notice.group_whole_ban";
+    /**
+     * - 通知事件: 群聊发送文件
+     */
+    CombinedEventType["NoticeGroupFileUploaded"] = "notice.group_file_uploaded";
+    /**
+     * - 通知事件: 群聊消息表情动态回应
+     */
+    CombinedEventType["NoticeGroupMessageReaction"] = "notice.group_message_reaction";
+    /**
+     * - 请求事件: 好友申请
+     */
+    CombinedEventType["RequestPrivateApply"] = "request.private_apply";
+    /**
+     * - 请求事件: 群聊申请
+     */
+    CombinedEventType["RequestGroupApply"] = "request.group_apply";
+    /**
+     * - 请求事件: 邀请入群
+     */
+    CombinedEventType["RequestInvitedGroup"] = "request.invited_group";
+})(CombinedEventType || (CombinedEventType = {}));

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

@@ -0,0 +1,12 @@
+import { KarinMessageType } from './message.js';
+import { KarinNoticeType } from './notice.js';
+import { KarinRequestType } from './request.js';
+export * from './message.js';
+export * from './notice.js';
+export * from './request.js';
+export * from './event.js';
+export * from './contact.js';
+export * from './reply.js';
+export * from './sender.js';
+export type KarinEventTypes = KarinMessageType | KarinNoticeType | KarinRequestType;
+export type KarinETypes<T> = T extends KarinMessageType ? 'message' : T extends KarinNoticeType ? 'notice' : T extends KarinRequestType ? 'request' : never;

package/lib/types/event/index.js

@@ -0,0 +1,7 @@
+export * from './message.js';
+export * from './notice.js';
+export * from './request.js';
+export * from './event.js';
+export * from './contact.js';
+export * from './reply.js';
+export * from './sender.js';