✨ version 0.8.0

add button and interaction event

Author: RF-Tar-Railt

nonebot/adapters/satori/adapter.py

@@ -14,7 +14,15 @@
 from .config import Config, ClientInfo
 from .exception import ApiNotAvailable
 from .models import Event as SatoriEvent
-from .event import EVENT_CLASSES, Event, MessageEvent, LoginAddedEvent, LoginRemovedEvent, LoginUpdatedEvent
+from .event import (
+    EVENT_CLASSES,
+    Event,
+    MessageEvent,
+    LoginAddedEvent,
+    InteractionEvent,
+    LoginRemovedEvent,
+    LoginUpdatedEvent,
+)
 from .models import (
     Payload,
     LoginStatus,
@@ -238,7 +246,7 @@ async def _loop(self, info: ClientInfo, ws: WebSocket):
                             f"Received event for unknown bot " f"{escape_tag(event.self_id)}",
                         )
                         continue
-                    if isinstance(event, MessageEvent):
+                    if isinstance(event, (MessageEvent, InteractionEvent)):
                         event = event.convert()
                     asyncio.create_task(bot.handle_event(event))
             elif isinstance(payload, PongPayload):

nonebot/adapters/satori/event.py

@@ -12,6 +12,7 @@
 from .models import Event as SatoriEvent
 from .message import Message, RenderMessage
 from .models import InnerMessage as SatoriMessage
+from .models import ArgvInteraction, ButtonInteraction
 from .models import Guild, Login, Channel, ChannelType, InnerMember
 
 E = TypeVar("E", bound="Event")
@@ -39,6 +40,8 @@ class EventType(str, Enum):
     REACTION_ADDED = "reaction-added"
     REACTION_REMOVED = "reaction-removed"
     INTERNAL = "internal"
+    INTERACTION_BUTTON = "interaction/button"
+    INTERACTION_COMMAND = "interaction/command"
 
 
 class Event(BaseEvent, SatoriEvent):
@@ -423,3 +426,184 @@ class InternalEvent(Event):
     @override
     def get_event_name(self) -> str:
         return getattr(self, "_type", "internal")
+
+
+class InteractionEvent(NoticeEvent):
+    def convert(self) -> "InteractionEvent":
+        raise NotImplementedError
+
+    @override
+    def is_tome(self) -> bool:
+        return True
+
+
+@register_event_class
+class InteractionButtonEvent(InteractionEvent):
+    __type__ = EventType.INTERACTION_BUTTON
+
+    button: ButtonInteraction
+
+    @override
+    def get_event_description(self) -> str:
+        return escape_tag(f"Button interacted with button#{self.button.id}")
+
+    def convert(self):
+        if self.channel and self.user and self.channel.type != ChannelType.DIRECT:
+            return PublicInteractionButtonEvent.parse_obj(self)
+        if self.user:
+            return PrivateInteractionButtonEvent.parse_obj(self)
+        return self
+
+
+class PrivateInteractionButtonEvent(InteractionButtonEvent):
+    user: User
+
+    @override
+    def get_session_id(self) -> str:
+        return self.channel.id if self.channel else self.user.id
+
+    @override
+    def get_user_id(self) -> str:
+        return self.user.id
+
+
+class PublicInteractionButtonEvent(InteractionButtonEvent):
+    user: User
+    channel: Channel
+
+    @override
+    def get_session_id(self) -> str:
+        s = f"{self.channel.id}/{self.user.id}"
+        if self.guild:
+            s = f"{self.guild.id}/{s}"
+        return s
+
+    @override
+    def get_user_id(self) -> str:
+        return self.user.id
+
+
+@register_event_class
+class InteractionCommandEvent(InteractionEvent):
+    __type__ = EventType.INTERACTION_COMMAND
+
+    if TYPE_CHECKING:
+        _message: Message
+        original_message: Message
+
+    @override
+    def get_type(self) -> str:
+        return "message"
+
+    @override
+    def get_message(self) -> Message:
+        return self._message
+
+    def convert(self):
+        if self.argv:
+            return InteractionCommandArgvEvent.convert(self)  # type: ignore
+        return InteractionCommandMessageEvent.convert(self)  # type: ignore
+
+
+class InteractionCommandArgvEvent(InteractionCommandEvent):
+    argv: ArgvInteraction
+
+    @override
+    def get_event_description(self) -> str:
+        return escape_tag(f"Command interacted with {self.argv}")
+
+    @root_validator
+    def generate_message(cls, values: Dict[str, Any]) -> Dict[str, Any]:
+        argv: ArgvInteraction = values["argv"]
+        cmd = argv.name
+        if argv.arguments:
+            cmd += " ".join(argv.arguments)
+        values["_message"] = Message(cmd)
+        values["original_message"] = deepcopy(values["_message"])
+        return values
+
+    def convert(self):
+        if self.channel and self.user and self.channel.type != ChannelType.DIRECT:
+            return PublicInteractionCommandArgvEvent.parse_obj(self)
+        if self.user:
+            return PrivateInteractionCommandArgvEvent.parse_obj(self)
+        return self
+
+
+class PrivateInteractionCommandArgvEvent(InteractionCommandArgvEvent):
+    user: User
+
+    @override
+    def get_session_id(self) -> str:
+        return self.channel.id if self.channel else self.user.id
+
+    @override
+    def get_user_id(self) -> str:
+        return self.user.id
+
+
+class PublicInteractionCommandArgvEvent(InteractionCommandArgvEvent):
+    user: User
+    channel: Channel
+
+    @override
+    def get_session_id(self) -> str:
+        s = f"{self.channel.id}/{self.user.id}"
+        if self.guild:
+            s = f"{self.guild.id}/{s}"
+        return s
+
+    @override
+    def get_user_id(self) -> str:
+        return self.user.id
+
+
+class InteractionCommandMessageEvent(InteractionCommandEvent):
+    message: SatoriMessage
+    to_me: bool = False
+    reply: Optional[RenderMessage] = None
+
+    @root_validator
+    def generate_message(cls, values: Dict[str, Any]) -> Dict[str, Any]:
+        values["_message"] = Message.from_satori_element(values["message"].content)
+        values["original_message"] = deepcopy(values["_message"])
+        return values
+
+    @override
+    def get_event_description(self) -> str:
+        return escape_tag(f"Command interacted with {self.get_message()}")
+
+    def convert(self):
+        if self.channel and self.user and self.channel.type != ChannelType.DIRECT:
+            return PublicInteractionCommandMessageEvent.parse_obj(self)
+        if self.user:
+            return PrivateInteractionCommandMessageEvent.parse_obj(self)
+        return self
+
+
+class PrivateInteractionCommandMessageEvent(InteractionCommandMessageEvent):
+    user: User
+
+    @override
+    def get_session_id(self) -> str:
+        return self.channel.id if self.channel else self.user.id
+
+    @override
+    def get_user_id(self) -> str:
+        return self.user.id
+
+
+class PublicInteractionCommandMessageEvent(InteractionCommandMessageEvent):
+    user: User
+    channel: Channel
+
+    @override
+    def get_session_id(self) -> str:
+        s = f"{self.channel.id}/{self.user.id}"
+        if self.guild:
+            s = f"{self.guild.id}/{s}"
+        return s
+
+    @override
+    def get_user_id(self) -> str:
+        return self.user.id

nonebot/adapters/satori/message.py

@@ -254,6 +254,33 @@ def author(
             data["avatar"] = avatar
         return Author("author", data)
 
+    @staticmethod
+    def action_button(button_id: str, display: Optional[str] = None, theme: Optional[str] = None):
+        data = {"type": "action", "id": button_id}
+        if display:
+            data["display"] = display
+        if theme:
+            data["theme"] = theme
+        return Button("button", data)
+
+    @staticmethod
+    def link_button(url: str, display: Optional[str] = None, theme: Optional[str] = None):
+        data = {"type": "link", "href": url}
+        if display:
+            data["display"] = display
+        if theme:
+            data["theme"] = theme
+        return Button("button", data)
+
+    @staticmethod
+    def input_button(text: str, display: Optional[str] = None, theme: Optional[str] = None):
+        data = {"type": "input", "text": text}
+        if display:
+            data["display"] = display
+        if theme:
+            data["theme"] = theme
+        return Button("button", data)
+
     @override
     def is_text(self) -> bool:
         return False
@@ -548,6 +575,35 @@ class Author(MessageSegment):
     data: AuthorData = field(default_factory=dict)
 
 
+class ButtonData(TypedDict, total=False):
+    type: str
+    display: NotRequired[str]
+    id: NotRequired[str]
+    href: NotRequired[str]
+    text: NotRequired[str]
+    theme: NotRequired[str]
+
+
+@dataclass
+class Button(MessageSegment):
+    data: ButtonData = field(default_factory=dict)
+
+    @override
+    def __str__(self):
+        attr = [f'type="{escape(self.data["type"])}"']
+        if self.data["type"] == "action":
+            attr.append(f'id="{escape(self.data["id"])}"')
+        if self.data["type"] == "link":
+            attr.append(f'href="{escape(self.data["href"])}"')
+        if self.data["type"] == "input":
+            attr.append(f'text="{escape(self.data["text"])}"')
+        if "theme":
+            attr.append(f'theme="{escape(self.data["theme"])}"')
+        if "display" in self.data:
+            return f'<button {" ".join(attr)}>{escape(self.data["display"])}</button>'
+        return f'<button {" ".join(attr)} />'
+
+
 ELEMENT_TYPE_MAP = {
     "text": (Text, "text"),
     "at": (At, "at"),
@@ -610,6 +666,11 @@ def from_satori_element(cls, elements: List[Element]) -> "Message":
                     )
                 else:
                     msg.append(Link("link", {"text": elem.attrs["href"]}))
+            elif elem.type == "button":
+                if elem.children:
+                    msg.append(Button("button", {"display": elem.children[0].attrs["text"], **elem.attrs}))
+                else:
+                    msg.append(Button("button", {**elem.attrs}))
             elif elem.type in STYLE_TYPE_MAP:
                 seg_cls, seg_type = STYLE_TYPE_MAP[elem.type]
                 msg.append(seg_cls(seg_type, {"text": elem.children[0].attrs["text"]}))

nonebot/adapters/satori/models.py

@@ -81,6 +81,16 @@ class Login(BaseModel, extra=Extra.allow):
     status: LoginStatus
 
 
+class ArgvInteraction(BaseModel):
+    name: str
+    arguments: list
+    options: Any
+
+
+class ButtonInteraction(BaseModel):
+    id: str
+
+
 class Opcode(IntEnum):
     EVENT = 0
     PING = 1
@@ -188,6 +198,8 @@ class Event(BaseModel, extra=Extra.allow):
     platform: str
     self_id: str
     timestamp: datetime
+    argv: Optional[ArgvInteraction] = None
+    button: Optional[ButtonInteraction] = None
     channel: Optional[Channel] = None
     guild: Optional[Guild] = None
     login: Optional[Login] = None

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nonebot-adapter-satori"
-version = "0.7.0"
+version = "0.8.0"
 description = "Satori Protocol Adapter for Nonebot2"
 authors = [
     {name = "RF-Tar-Railt",email = "rf_tar_railt@qq.com"},