butterbot-python 3.1.0.dev1__py3-none-any.whl

butterbot/sources/napcat/data/event_data.py

@@ -0,0 +1,441 @@
+"""
+NapCat OneBot11 事件数据模型
+
+基于 OneBot11 协议定义的事件类型，使用 BaseDataModel 实现自动分发构造
+"""
+
+from typing import ClassVar
+
+from butterbot.core.data import BaseDataModel
+
+from ..types import NapcatType
+from .segment_data import NapcatMessage
+
+# ==================== 嵌套数据类（发送者信息） ====================
+
+
+class FriendSender(BaseDataModel):
+    """私聊消息发送者信息"""
+
+    user_id: int
+    nickname: str
+    sex: str | None = None
+    age: int | None = None
+    group_id: int | None = None  # 群临时会话会有此字段
+
+
+class GroupSender(BaseDataModel):
+    """群消息发送者信息"""
+
+    user_id: int
+    nickname: str
+    sex: str | None = None
+    age: int | None = None
+    card: str | None = None  # 群名片/备注
+    area: str | None = None  # 地区
+    level: int | None = None  # 成员等级
+    role: str | None = None  # 角色: owner/admin/member
+    title: str | None = None  # 专属头衔
+
+
+class FileInfo(BaseDataModel):
+    """文件信息"""
+
+    id: str
+    name: str
+    size: int
+    busid: int
+
+
+class EmojiLike(BaseDataModel):
+    """表情回应信息"""
+
+    count: int
+    emoji_id: int
+
+
+class HeartbeatStatus(BaseDataModel):
+    """心跳状态信息"""
+
+    online: bool | None = None
+    good: bool | None = None
+
+
+# ==================== 事件基类 ====================
+
+
+class NapcatData(BaseDataModel):
+    """OneBot11 事件基类
+
+    使用 post_type 字段进行一级分发
+    """
+
+    discriminator_field: ClassVar[str] = "post_type"
+    event_type: ClassVar[NapcatType] = NapcatType.UNKNOWN
+    time: int
+    self_id: int
+    post_type: str
+
+
+# ==================== 消息事件 ====================
+
+
+class NapcatMessageData(NapcatData):
+    """消息事件基类
+
+    使用 message_type 字段进行二级分发
+    """
+
+    discriminator_value: ClassVar[str] = "message"
+    discriminator_field: ClassVar[str] = "message_type"
+    event_type: ClassVar[NapcatType] = NapcatType.MESSAGE
+    post_type: str = "message"
+    message_type: str
+    sub_type: str
+    message_id: int
+    user_id: int
+    message: NapcatMessage
+    raw_message: str
+    font: int
+
+
+class NapcatPrivateMessageData(NapcatMessageData):
+    """私聊消息事件"""
+
+    discriminator_value: ClassVar[str] = "private"
+    event_type: ClassVar[NapcatType] = NapcatType.PRIVATE_MESSAGE
+    message_type: str = "private"
+    sub_type: str = "friend"
+    target_id: int | None = None  # 接收者QQ
+    temp_source: int | None = None  # 临时会话来源
+    sender: FriendSender
+
+
+class NapcatGroupMessageData(NapcatMessageData):
+    """群消息事件"""
+
+    discriminator_value: ClassVar[str] = "group"
+    event_type: ClassVar[NapcatType] = NapcatType.GROUP_MESSAGE
+    message_type: str = "group"
+    sub_type: str = "normal"  # normal/anonymous/notice
+    group_id: int
+    sender: GroupSender
+
+
+# ==================== 消息发送事件（自身消息上报） ====================
+
+
+class NapcatMessageSentData(NapcatData):
+    """消息发送事件基类（自身发送的消息上报）
+
+    使用 message_type 字段进行二级分发
+    """
+
+    discriminator_value: ClassVar[str] = "message_sent"
+    discriminator_field: ClassVar[str] = "message_type"
+    event_type: ClassVar[NapcatType] = NapcatType.SENT
+    post_type: str = "message_sent"
+    message_type: str
+    sub_type: str
+    message_id: int
+    user_id: int
+    message: NapcatMessage
+    raw_message: str
+    font: int
+
+
+class NapcatPrivateMessageSentData(NapcatMessageSentData):
+    """私聊消息发送事件"""
+
+    discriminator_value: ClassVar[str] = "private"
+    event_type: ClassVar[NapcatType] = NapcatType.PRIVATE_SENT
+    message_type: str = "private"
+    sub_type: str = "friend"
+    target_id: int | None = None
+    sender: FriendSender
+
+
+class NapcatGroupMessageSentData(NapcatMessageSentData):
+    """群消息发送事件"""
+
+    discriminator_value: ClassVar[str] = "group"
+    event_type: ClassVar[NapcatType] = NapcatType.GROUP_SENT
+    message_type: str = "group"
+    sub_type: str = "normal"
+    group_id: int
+    sender: GroupSender
+
+
+# ==================== 通知事件 ====================
+
+
+class NapcatNoticeData(NapcatData):
+    """通知事件基类
+
+    使用 notice_type 字段进行二级分发
+    """
+
+    discriminator_value: ClassVar[str] = "notice"
+    discriminator_field: ClassVar[str] = "notice_type"
+    event_type: ClassVar[NapcatType] = NapcatType.NOTICE
+    post_type: str = "notice"
+    notice_type: str
+
+
+class NapcatGroupUploadNoticeData(NapcatNoticeData):
+    """群文件上传事件"""
+
+    discriminator_value: ClassVar[str] = "group_upload"
+    event_type: ClassVar[NapcatType] = NapcatType.GROUP_UPLOAD_NOTICE
+    notice_type: str = "group_upload"
+    group_id: int
+    user_id: int
+    file: FileInfo
+
+
+class NapcatGroupAdminNoticeData(NapcatNoticeData):
+    """群管理员变动事件"""
+
+    discriminator_value: ClassVar[str] = "group_admin"
+    event_type: ClassVar[NapcatType] = NapcatType.GROUP_ADMIN_NOTICE
+    notice_type: str = "group_admin"
+    sub_type: str  # set/unset
+    group_id: int
+    user_id: int
+
+
+class NapcatGroupDecreaseNoticeData(NapcatNoticeData):
+    """群成员减少事件"""
+
+    discriminator_value: ClassVar[str] = "group_decrease"
+    event_type: ClassVar[NapcatType] = NapcatType.GROUP_DECREASE_NOTICE
+    notice_type: str = "group_decrease"
+    sub_type: str  # leave/kick/kick_me
+    group_id: int
+    operator_id: int
+    user_id: int
+
+
+class NapcatGroupIncreaseNoticeData(NapcatNoticeData):
+    """群成员增加事件"""
+
+    discriminator_value: ClassVar[str] = "group_increase"
+    event_type: ClassVar[NapcatType] = NapcatType.GROUP_INCREASE_NOTICE
+    notice_type: str = "group_increase"
+    sub_type: str  # approve/invite
+    group_id: int
+    operator_id: int
+    user_id: int
+
+
+class NapcatGroupBanNoticeData(NapcatNoticeData):
+    """群禁言事件"""
+
+    discriminator_value: ClassVar[str] = "group_ban"
+    event_type: ClassVar[NapcatType] = NapcatType.GROUP_BAN_NOTICE
+    notice_type: str = "group_ban"
+    sub_type: str  # ban/lift_ban
+    group_id: int
+    operator_id: int
+    user_id: int
+    duration: int  # 禁言时长，单位秒
+
+
+class NapcatFriendAddNoticeData(NapcatNoticeData):
+    """好友添加事件"""
+
+    discriminator_value: ClassVar[str] = "friend_add"
+    event_type: ClassVar[NapcatType] = NapcatType.FRIEND_ADD_NOTICE
+    notice_type: str = "friend_add"
+    user_id: int
+
+
+class NapcatGroupRecallNoticeData(NapcatNoticeData):
+    """群消息撤回事件"""
+
+    discriminator_value: ClassVar[str] = "group_recall"
+    event_type: ClassVar[NapcatType] = NapcatType.GROUP_RECALL_NOTICE
+    notice_type: str = "group_recall"
+    group_id: int
+    user_id: int
+    operator_id: int
+    message_id: int
+
+
+class NapcatFriendRecallNoticeData(NapcatNoticeData):
+    """好友消息撤回事件"""
+
+    discriminator_value: ClassVar[str] = "friend_recall"
+    event_type: ClassVar[NapcatType] = NapcatType.FRIEND_RECALL_NOTICE
+    notice_type: str = "friend_recall"
+    user_id: int
+    message_id: int
+
+
+class NapcatNotifyData(NapcatNoticeData):
+    """通知事件（戳一戳/运气王/荣誉等）
+
+    使用 sub_type 字段进行三级分发
+    """
+
+    discriminator_value: ClassVar[str] = "notify"
+    discriminator_field: ClassVar[str] = "sub_type"
+    event_type: ClassVar[NapcatType] = NapcatType.NOTICE
+    notice_type: str = "notify"
+    sub_type: str
+
+
+class NapcatPokeNotifyData(NapcatNotifyData):
+    """戳一戳事件"""
+
+    discriminator_value: ClassVar[str] = "poke"
+    event_type: ClassVar[NapcatType] = NapcatType.POKE_NOTIFY
+    sub_type: str = "poke"
+    group_id: int | None = None  # 私聊不存在
+    user_id: int
+    target_id: int
+
+
+class NapcatLuckyKingNotifyData(NapcatNotifyData):
+    """运气王事件"""
+
+    discriminator_value: ClassVar[str] = "lucky_king"
+    event_type: ClassVar[NapcatType] = NapcatType.LUCKY_KING_NOTIFY
+    sub_type: str = "lucky_king"
+    group_id: int
+    user_id: int  # 红包发送者
+    target_id: int  # 运气王
+
+
+class NapcatHonorNotifyData(NapcatNotifyData):
+    """荣誉变更事件"""
+
+    discriminator_value: ClassVar[str] = "honor"
+    event_type: ClassVar[NapcatType] = NapcatType.HONOR_NOTIFY
+    sub_type: str = "honor"
+    group_id: int
+    honor_type: str  # talkative/performer/emotion
+    user_id: int
+
+
+class NapcatGroupMsgEmojiLikeNoticeData(NapcatNoticeData):
+    """群表情回应事件（NapCat/LLOneBot）"""
+
+    discriminator_value: ClassVar[str] = "group_msg_emoji_like"
+    event_type: ClassVar[NapcatType] = NapcatType.GROUP_EMOJI_LIKE_NOTICE
+    notice_type: str = "group_msg_emoji_like"
+    group_id: int
+    user_id: int
+    message_id: int
+    likes: list[EmojiLike]
+
+
+class NapcatReactionNoticeData(NapcatNoticeData):
+    """群表情回应事件（Lagrange）"""
+
+    discriminator_value: ClassVar[str] = "reaction"
+    event_type: ClassVar[NapcatType] = NapcatType.REACTION_NOTICE
+    notice_type: str = "reaction"
+    sub_type: str  # add/remove
+    group_id: int
+    operator_id: int
+    message_id: int
+    code: str  # 表情ID
+    count: int
+
+
+class NapcatGroupEssenceNoticeData(NapcatNoticeData):
+    """群精华消息事件"""
+
+    discriminator_value: ClassVar[str] = "essence"
+    event_type: ClassVar[NapcatType] = NapcatType.GROUP_ESSENCE_NOTICE
+    notice_type: str = "essence"
+    sub_type: str  # add/delete
+    group_id: int
+    message_id: int
+    sender_id: int
+    operator_id: int
+
+
+class NapcatGroupCardNoticeData(NapcatNoticeData):
+    """群名片更新事件"""
+
+    discriminator_value: ClassVar[str] = "group_card"
+    event_type: ClassVar[NapcatType] = NapcatType.GROUP_CARD_NOTICE
+    notice_type: str = "group_card"
+    group_id: int
+    user_id: int
+    card_new: str
+    card_old: str
+
+
+# ==================== 请求事件 ====================
+
+
+class NapcatRequestData(NapcatData):
+    """请求事件基类
+
+    使用 request_type 字段进行二级分发
+    """
+
+    discriminator_value: ClassVar[str] = "request"
+    discriminator_field: ClassVar[str] = "request_type"
+    event_type: ClassVar[NapcatType] = NapcatType.REQUEST
+    post_type: str = "request"
+    request_type: str
+    flag: str
+    user_id: int
+    comment: str
+
+
+class NapcatFriendRequestData(NapcatRequestData):
+    """好友请求事件"""
+
+    discriminator_value: ClassVar[str] = "friend"
+    event_type: ClassVar[NapcatType] = NapcatType.FRIEND_REQUEST
+    request_type: str = "friend"
+
+
+class NapcatGroupRequestData(NapcatRequestData):
+    """群请求事件"""
+
+    discriminator_value: ClassVar[str] = "group"
+    event_type: ClassVar[NapcatType] = NapcatType.GROUP_REQUEST
+    request_type: str = "group"
+    sub_type: str  # add/invite
+    group_id: int
+
+
+# ==================== 元事件 ====================
+
+
+class NapcatMetaData(NapcatData):
+    """元事件基类
+
+    使用 meta_event_type 字段进行二级分发
+    """
+
+    discriminator_value: ClassVar[str] = "meta_event"
+    discriminator_field: ClassVar[str] = "meta_event_type"
+    event_type: ClassVar[NapcatType] = NapcatType.META
+    post_type: str = "meta_event"
+    meta_event_type: str
+
+
+class NapcatLifecycleMetaData(NapcatMetaData):
+    """生命周期元事件"""
+
+    discriminator_value: ClassVar[str] = "lifecycle"
+    event_type: ClassVar[NapcatType] = NapcatType.LIFECYCLE_META
+    meta_event_type: str = "lifecycle"
+    sub_type: str  # enable/disable/connect
+
+
+class NapcatHeartbeatMetaData(NapcatMetaData):
+    """心跳元事件"""
+
+    discriminator_value: ClassVar[str] = "heartbeat"
+    event_type: ClassVar[NapcatType] = NapcatType.HEARTBEAT_META
+    meta_event_type: str = "heartbeat"
+    status: HeartbeatStatus
+    interval: int  # 心跳间隔，单位毫秒