node-karin 0.0.3

package/lib/event/event.d.ts

@@ -0,0 +1,138 @@
+import { Reply, replyCallback } from '../types/reply.js';
+import { KarinAdapter } from '../types/adapter.js';
+import { Event, contact, Sender, SubEventForEvent } from '../types/types.js';
+/**
+ * - 事件基类 所有事件都继承自此类并且需要实现此类的所有属性
+ * @class KarinEvent
+ */
+export declare class KarinEvent {
+    /**
+     * - 机器人ID 请尽量使用UID
+     */
+    self_id: string;
+    /**
+     * - 用户ID
+     */
+    user_id: string;
+    /**
+     * - 群ID 仅在群聊中存在
+     * @default ''
+     */
+    group_id: string;
+    /**
+     * - 事件类型
+     */
+    event: Event;
+    /**
+     * - 事件子类型
+     */
+    sub_event: SubEventForEvent<Event>;
+    /**
+     * - 事件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>;
+    /**
+     * - 回复函数
+     */
+    reply: Reply;
+    /**
+     * - 回复函数 由适配器实现，开发者不应该直接调用
+     */
+    replyCallback: replyCallback;
+    /**
+     * - bot实现
+     */
+    bot: KarinAdapter;
+    constructor({ event, self_id, user_id, group_id, time, contact, sender, sub_event, event_id, }: {
+        /**
+         * - 事件类型
+         */
+        event: Event;
+        /**
+         * - 机器人ID 请尽量使用UID
+         */
+        self_id: string;
+        /**
+         * - 用户ID
+         */
+        user_id: string;
+        /**
+         * - 群ID 仅在群聊中需要提供
+         */
+        group_id?: string;
+        /**
+         * - 事件触发时间戳
+         */
+        time: number;
+        /**
+         * - 事件联系人信息
+         */
+        contact: contact;
+        /**
+         * - 事件发送者信息
+         */
+        sender: Sender;
+        /**
+         * - 事件子类型
+         */
+        sub_event: SubEventForEvent<Event>;
+        /**
+         * - 事件ID
+         */
+        event_id: string;
+    });
+}

package/lib/event/event.handler.d.ts

@@ -0,0 +1,29 @@
+import { GroupCfg } from '../types/config.js';
+import { KarinMessage } from './message.js';
+import { KarinNotice } from './notice.js';
+import { KarinRequest } from './request.js';
+import { Event, Permission, SubEvent } from '../types/types.js';
+export default class EventHandler {
+    e: KarinMessage | KarinNotice | KarinRequest;
+    config: GroupCfg | {};
+    /**
+     * 处理事件，加入自定义字段
+     */
+    constructor(e: KarinMessage | KarinNotice | KarinRequest);
+    /**
+     * 事件处理
+     */
+    review(): boolean;
+    /**
+     * 根据事件类型过滤事件
+     */
+    filtEvent(event: Event | `${Event}.${SubEvent}`): boolean;
+    /**
+     * 判断权限
+     */
+    filterPermission(permission: Permission | undefined): boolean;
+    /**
+     * 快速回复
+     */
+    reply(): void;
+}

package/lib/event/event.handler.js

@@ -0,0 +1,142 @@
+import Review from './review.handler.js'
+import config from '../utils/config.js'
+import logger from '../utils/logger.js'
+import Common from '../utils/common.js'
+import Segment from '../utils/segment.js'
+import Listeners from '../core/listener.js'
+export default class EventHandler {
+  e
+  config
+  /**
+     * 处理事件，加入自定义字段
+     */
+  constructor (e) {
+    this.e = e
+    this.config = {}
+    /** 加入e.bot */
+    Object.defineProperty(this.e, 'bot', { value: Listeners.getBot(this.e.self_id) })
+    if (this.e.group_id) { this.config = config.group(this.e.group_id) }
+  }
+
+  /**
+     * 事件处理
+     */
+  review () {
+    /** 检查CD */
+    if (!Review.CD(this.e, this.config)) {
+      logger.debug('[消息拦截] 正在冷却中')
+      return true
+    }
+    /** 检查群聊黑白名单 */
+    if (!Review.GroupEnable(this.e)) {
+      logger.debug('[消息拦截] 未通过群聊黑白名单检查')
+      return true
+    }
+    /** 检查用户黑白名单 */
+    if (!Review.UserEnable(this.e)) {
+      logger.debug('[消息拦截] 未通过用户黑白名单检查')
+      return true
+    }
+    /** 都通过了 */
+    return false
+  }
+
+  /**
+     * 根据事件类型过滤事件
+     */
+  filtEvent (event) {
+    /** 事件映射表 */
+    const eventMap = {
+      message: () => `message.${this.e.sub_event}`,
+      message_sent: () => `message_sent.${this.e.sub_event}`,
+      meta_event: () => `message.${this.e.sub_event}`,
+      notice: () => `notice.${this.e.sub_event}`,
+      request: () => `request.${this.e.sub_event}`,
+    }
+    const eventType = eventMap[this.e.event]()
+    return eventType.includes(event)
+  }
+
+  /**
+     * 判断权限
+     */
+  filterPermission (permission) {
+    if (!permission || permission === 'all') { return true }
+    if (permission === 'master') {
+      if (!this.e.isMaster) {
+        this.e.reply('暂无权限，只有主人才能操作')
+        return false
+      }
+      return true
+    }
+    if (permission === 'admin') {
+      if (!this.e.isMaster && !this.e.isAdmin) {
+        this.e.reply('暂无权限，只有管理员才能操作')
+        return false
+      }
+      return true
+    }
+    if (this.e.isGroup) {
+      const list = {
+        'group.owner': {
+          role: 'owner',
+          name: '群主',
+        },
+        'group.admin': {
+          role: 'admin',
+          name: '群管理员',
+        },
+      }
+      const role = list[permission]
+      if (role && this.e.sender?.role !== role.role) {
+        this.e.reply(`暂无权限，只有${role.name}才能操作`)
+        return false
+      }
+    }
+    return true
+  }
+
+  /**
+     * 快速回复
+     */
+  reply () {
+    /**
+         * 快速回复
+         * @param elements 回复内容
+         * @param options 回复选项
+         */
+    this.e.reply = async (elements = '', options = { reply: false, recallMsg: 0, at: false, retry_count: 1 }) => {
+      const message = Common.makeMessage(elements)
+      const { reply = false, recallMsg = 0, at, retry_count = 1 } = options
+      /** 加入at */
+      if (at && this.e.isGroup) { message.unshift(Segment.at(this.e.user_id)) }
+      /** 加入引用回复 */
+      if (reply && 'message_id' in this.e) { message.unshift(Segment.reply(this.e.message_id)) }
+      /** 先发 提升速度 */
+      const result = this.e.replyCallback(message, retry_count)
+      const ReplyLog = Common.makeMessageLog(message)
+      if (this.e.isGroup) {
+        Review.GroupMsgPrint(this.e) && logger.bot('info', this.e.self_id, `${logger.green(`Send Group ${this.e.group_id}: `)}${ReplyLog}`)
+      } else {
+        logger.bot('info', this.e.self_id, `${logger.green(`Send private ${this.e.user_id}: `)}${ReplyLog}`)
+      }
+      let message_id = ''
+      try {
+        Listeners.emit('karin:count:send', 1)
+        /** 取结果 */
+        const Res = await result
+        message_id = Res.message_id || ''
+        logger.bot('debug', this.e.self_id, `回复消息结果:${JSON.stringify(result)}`)
+      } catch (error) {
+        logger.bot('error', this.e.self_id, `回复消息失败:${ReplyLog}`)
+        logger.bot('error', this.e.self_id, error.stack || error.message || JSON.stringify(error))
+      }
+      /** 快速撤回 */
+      if (recallMsg > 0 && message_id) {
+        setTimeout(() => this.e.bot.RecallMessage(this.e.contact, message_id), recallMsg * 1000)
+      }
+      return result
+    }
+    Object.freeze(this.e.reply)
+  }
+}

package/lib/event/event.js

@@ -0,0 +1,120 @@
+/**
+ * - 事件基类 所有事件都继承自此类并且需要实现此类的所有属性
+ * @class KarinEvent
+ */
+export class KarinEvent {
+  /**
+     * - 机器人ID 请尽量使用UID
+     */
+  self_id
+  /**
+     * - 用户ID
+     */
+  user_id
+  /**
+     * - 群ID 仅在群聊中存在
+     * @default ''
+     */
+  group_id
+  /**
+     * - 事件类型
+     */
+  event
+  /**
+     * - 事件子类型
+     */
+  sub_event
+  /**
+     * - 事件ID
+     */
+  event_id
+  /**
+     * - 事件触发时间戳
+     */
+  time
+  /**
+     * - 事件联系人信息
+     */
+  contact
+  /**
+     * - 事件发送者信息
+     */
+  sender
+  /**
+     * - 是否为主人
+     * @default false
+     */
+  isMaster
+  /**
+     * - 是否为管理员
+     * @default false
+     */
+  isAdmin
+  /**
+     * - 是否为私聊
+     * @default false
+     */
+  isPrivate
+  /**
+     * - 是否为群聊
+     * @default false
+     */
+  isGroup
+  /**
+     * - 是否为频道
+     * @default false
+     */
+  isGuild
+  /**
+     * - 是否为群临时会话
+     * @default false
+     */
+  isGroupTemp
+  /**
+     * - 日志函数字符串
+     */
+  logFnc
+  /**
+     * - 日志用户字符串
+     */
+  logText
+  /**
+     * - 存储器 由开发者自行调用
+     */
+  store
+  /**
+     * - 回复函数
+     */
+  reply
+  /**
+     * - 回复函数 由适配器实现，开发者不应该直接调用
+     */
+  replyCallback
+  /**
+     * - bot实现
+     */
+  bot
+  constructor ({ event, self_id, user_id, group_id = '', time, contact, sender, sub_event, event_id }) {
+    this.self_id = self_id
+    this.user_id = user_id
+    this.group_id = group_id
+    this.time = time
+    this.event = event
+    this.event_id = event_id
+    this.contact = contact
+    this.sender = sender
+    this.sub_event = sub_event
+    this.isMaster = false
+    this.isAdmin = false
+    this.isPrivate = false
+    this.isGroup = false
+    this.isGuild = false
+    this.isGroupTemp = false
+    this.logFnc = ''
+    this.logText = ''
+    this.store = new Map()
+    this.reply = (elements, options) => Promise.resolve({ message_id: '' })
+    this.replyCallback = (elements, options) => Promise.resolve({ message_id: '' })
+    this.bot = {}
+  }
+}

package/lib/event/message.d.ts

@@ -0,0 +1,102 @@
+import { KarinEvent } from './event.js';
+import { KarinElement } from '../types/element.js';
+import { contact, Sender } from '../types/types.js';
+/**
+ * - 消息事件基类
+ */
+export declare class KarinMessage extends KarinEvent {
+    constructor({ event, self_id, user_id, time, message_id, message_seq, raw_message, contact, sender, elements, group_id, }: {
+        /**
+         * - 事件类型
+         */
+        event: 'message' | 'message_sent';
+        /**
+         * - 机器人ID 请尽量使用UID
+         */
+        self_id: string;
+        /**
+         * - 用户ID
+         */
+        user_id: string;
+        /**
+         * - 事件触发时间戳
+         */
+        time: number;
+        /**
+         * - 消息ID
+         */
+        message_id: string;
+        /**
+         * - 消息序列号
+         */
+        message_seq?: string;
+        /**
+         * - 原始消息文本
+         */
+        raw_message: string;
+        /**
+         * 事件联系人信息
+         */
+        contact: contact;
+        /**
+         * 事件发送者信息
+         */
+        sender: Sender;
+        /**
+         * 消息体元素
+         */
+        elements: Array<KarinElement>;
+        /**
+         * 群ID
+         */
+        group_id: string;
+    });
+    /**
+     * - 消息ID
+     */
+    message_id: string;
+    /**
+     * - 消息序列号
+     */
+    message_seq?: string;
+    /**
+     * - 原始消息文本
+     */
+    raw_message: string;
+    /**
+     * - 消息体元素
+     */
+    elements: Array<KarinElement>;
+    /**
+     * - 框架处理后的文本
+     */
+    msg: string;
+    /**
+     * - 图片数组
+     */
+    image: Array<string>;
+    /**
+     * - AT数组
+     */
+    at: Array<string>;
+    /**
+     * - 是否AT机器人
+     */
+    atBot: boolean;
+    /**
+     * - 是否AT全体
+     */
+    atAll: boolean;
+    /**
+     * - 文件元素
+     */
+    file: object;
+    /**
+     * - 引用消息ID
+     */
+    reply_id: string;
+    /**
+     * - 消息别名
+     */
+    alias: string;
+}

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

@@ -0,0 +1,25 @@
+import { KarinMessage } from './message.js';
+import EventHandler from './event.handler.js';
+/**
+ * 消息事件
+ */
+export default class Message extends EventHandler {
+    e: KarinMessage;
+    /**
+     * - 是否打印群消息日志
+     */
+    GroupMsgPrint: boolean;
+    constructor(e: KarinMessage);
+    /**
+     * 处理消息
+     */
+    deal(): Promise<void>;
+    /**
+     * 处理消息体
+     */
+    dealMsg(): void;
+    /**
+     * 处理上下文
+     */
+    context(): Promise<boolean>;
+}