feat: add message delete event

Author: kutuzov13

pybotx/__init__.py

@@ -144,6 +144,7 @@
 from pybotx.models.system_events.cts_login import CTSLoginEvent
 from pybotx.models.system_events.cts_logout import CTSLogoutEvent
 from pybotx.models.system_events.deleted_from_chat import DeletedFromChatEvent
+from pybotx.models.system_events.event_delete import EventDeleted
 from pybotx.models.system_events.event_edit import EventEdit
 from pybotx.models.system_events.internal_bot_notification import (
     InternalBotNotificationEvent,
@@ -206,6 +207,7 @@
     "DeletedFromChatEvent",
     "Document",
     "EditMessage",
+    "EventDeleted",
     "EventEdit",
     "EventNotFoundError",
     "File",

pybotx/bot/bot.py

@@ -3,15 +3,7 @@
 from contextlib import asynccontextmanager
 from datetime import datetime
 from types import SimpleNamespace
-from typing import (
-    Any,
-    Dict,
-    List,
-    Optional,
-    Set,
-    Tuple,
-    Union,
-)
+from typing import Any, Dict, List, Optional, Set, Tuple, Union
 from uuid import UUID
 
 import aiofiles

pybotx/bot/handler.py

@@ -1,14 +1,6 @@
 from dataclasses import dataclass
 from functools import partial
-from typing import (
-    TYPE_CHECKING,
-    Awaitable,
-    Callable,
-    List,
-    Literal,
-    TypeVar,
-    Union,
-)
+from typing import TYPE_CHECKING, Awaitable, Callable, List, Literal, TypeVar, Union
 
 from pybotx.models.commands import BotCommand
 from pybotx.models.message.incoming_message import IncomingMessage
@@ -23,6 +15,7 @@
 from pybotx.models.system_events.cts_login import CTSLoginEvent
 from pybotx.models.system_events.cts_logout import CTSLogoutEvent
 from pybotx.models.system_events.deleted_from_chat import DeletedFromChatEvent
+from pybotx.models.system_events.event_delete import EventDeleted
 from pybotx.models.system_events.event_edit import EventEdit
 from pybotx.models.system_events.internal_bot_notification import (
     InternalBotNotificationEvent,
@@ -53,6 +46,7 @@
     HandlerFunc[CTSLogoutEvent],
     HandlerFunc[InternalBotNotificationEvent],
     HandlerFunc[SmartAppEvent],
+    HandlerFunc[EventDeleted],
     HandlerFunc[EventEdit],
     HandlerFunc[JoinToChatEvent],
     HandlerFunc[ConferenceChangedEvent],

pybotx/bot/handler_collector.py

@@ -48,6 +48,7 @@
 from pybotx.models.system_events.cts_login import CTSLoginEvent
 from pybotx.models.system_events.cts_logout import CTSLogoutEvent
 from pybotx.models.system_events.deleted_from_chat import DeletedFromChatEvent
+from pybotx.models.system_events.event_delete import EventDeleted
 from pybotx.models.system_events.event_edit import EventEdit
 from pybotx.models.system_events.internal_bot_notification import (
     InternalBotNotificationEvent,
@@ -316,6 +317,14 @@ def event_edit(
         self._system_event(EventEdit, handler_func)
         return handler_func
 
+    def event_delete(
+        self,
+        handler_func: HandlerFunc[EventDeleted],
+    ) -> HandlerFunc[EventDeleted]:
+        """Decorate `event delete` event handler."""
+        self._system_event(EventDeleted, handler_func)
+        return handler_func
+
     def conference_changed(
         self,
         handler_func: HandlerFunc[ConferenceChangedEvent],

pybotx/models/commands.py

@@ -31,6 +31,7 @@
     BotAPIDeletedFromChat,
     DeletedFromChatEvent,
 )
+from pybotx.models.system_events.event_delete import BotAPIEventDeleted, EventDeleted
 from pybotx.models.system_events.event_edit import BotAPIEventEdit, EventEdit
 from pybotx.models.system_events.internal_bot_notification import (
     BotAPIInternalBotNotification,
@@ -60,6 +61,7 @@
     BotAPILeftFromChat,
     BotAPICTSLogin,
     BotAPICTSLogout,
+    BotAPIEventDeleted,
     BotAPIEventEdit,
     BotAPIJoinToChat,
     BotAPIConferenceChanged,
@@ -79,6 +81,7 @@
     LeftFromChatEvent,
     CTSLoginEvent,
     CTSLogoutEvent,
+    EventDeleted,
     EventEdit,
     JoinToChatEvent,
     ConferenceChangedEvent,

pybotx/models/enums.py

@@ -111,6 +111,7 @@ class BotAPISystemEventTypes(StrEnum):
     INTERNAL_BOT_NOTIFICATION = "system:internal_bot_notification"
     LEFT_FROM_CHAT = "system:left_from_chat"
     SMARTAPP_EVENT = "system:smartapp_event"
+    EVENT_DELETED = "system:event_deleted"
     EVENT_EDIT = "system:event_edit"
     JOIN_TO_CHAT = "system:user_joined_to_chat"
     CONFERENCE_CHANGED = "system:conference_changed"

pybotx/models/system_events/event_delete.py

@@ -0,0 +1,72 @@
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Any, Dict, List, Literal
+from uuid import UUID
+
+from pydantic import Field
+
+from pybotx.models.api_base import VerifiedPayloadBaseModel
+from pybotx.models.base_command import (
+    BaseBotAPIContext,
+    BotAPIBaseCommand,
+    BotAPIBaseSystemEventPayload,
+    BotCommandBase,
+)
+from pybotx.models.bot_account import BotAccount
+from pybotx.models.enums import BotAPISystemEventTypes
+
+
+@dataclass
+class EventDeletedMeta:
+    deleted_by: UUID
+    deleted_by_admin: bool
+
+
+@dataclass
+class EventDeleted(BotCommandBase):
+    """Event `system:event_deleted`.
+
+    Attributes:
+        deleted_at: Delete message date and time.
+        group_chat_id: Delete message group chat id.
+        meta: Delete message meta.
+        sync_ids: Delete message sync ids.
+    """
+
+    deleted_at: datetime
+    group_chat_id: UUID
+    meta: EventDeletedMeta
+    sync_ids: List[UUID]
+
+
+class BotAPIEventDeletedData(VerifiedPayloadBaseModel):
+    deleted_at: datetime
+    group_chat_id: UUID
+    meta: EventDeletedMeta
+    sync_ids: List[UUID]
+
+
+class BotAPIEventDeletedPayload(BotAPIBaseSystemEventPayload):
+    body: Literal[BotAPISystemEventTypes.EVENT_DELETED]
+    data: BotAPIEventDeletedData
+
+
+class BotAPIEventDeleted(BotAPIBaseCommand):
+    payload: BotAPIEventDeletedPayload = Field(..., alias="command")
+    bot: BaseBotAPIContext = Field(..., alias="from")
+
+    def to_domain(self, raw_command: Dict[str, Any]) -> EventDeleted:
+        return EventDeleted(
+            bot=BotAccount(
+                id=self.bot_id,
+                host=self.bot.host,
+            ),
+            raw_command=raw_command,
+            deleted_at=self.payload.data.deleted_at,
+            group_chat_id=self.payload.data.group_chat_id,
+            meta=EventDeletedMeta(
+                deleted_by=self.payload.data.meta.deleted_by,
+                deleted_by_admin=self.payload.data.meta.deleted_by_admin,
+            ),
+            sync_ids=self.payload.data.sync_ids,
+        )

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pybotx"
-version = "0.75.2"
+version = "0.76.0"
 description = "A python library for interacting with eXpress BotX API"
 authors = [
     "Sidnev Nikolay <nsidnev@ccsteam.ru>",

tests/system_events/test_event_delete.py

@@ -0,0 +1,102 @@
+from datetime import datetime
+from typing import Callable, Optional
+from uuid import UUID
+
+import pytest
+
+from pybotx import (
+    Bot,
+    BotAccount,
+    BotAccountWithSecret,
+    EventDeleted,
+    HandlerCollector,
+    lifespan_wrapper,
+)
+from pybotx.models.system_events.event_delete import EventDeletedMeta
+
+pytestmark = [
+    pytest.mark.asyncio,
+    pytest.mark.mock_authorization,
+    pytest.mark.usefixtures("respx_mock"),
+]
+
+
+async def test__event_delete__succeed(
+    bot_account: BotAccountWithSecret,
+    datetime_formatter: Callable[[str], datetime],
+) -> None:
+    # - Arrange -
+    payload = {
+        "sync_id": "a465f0f3-1354-491c-8f11-f400164295cb",
+        "command": {
+            "body": "system:event_deleted",
+            "data": {
+                "deleted_at": "2025-09-23T09:04:49.787078Z",
+                "group_chat_id": "6fe9b0e7-32e3-4843-8486-897eabd69422",
+                "meta": {
+                    "deleted_by": "fbc84c63-e432-4ff1-99bd-c3275f053866",
+                    "deleted_by_admin": True,
+                },
+                "sync_ids": ["36c4f12a-7082-599a-9842-cd146730e179"],
+            },
+            "command_type": "system",
+            "metadata": {},
+        },
+        "async_files": [],
+        "attachments": [],
+        "entities": [],
+        "from": {
+            "user_huid": None,
+            "group_chat_id": "6fe9b0e7-32e3-4843-8486-897eabd69422",
+            "ad_login": None,
+            "ad_domain": None,
+            "username": None,
+            "chat_type": None,
+            "manufacturer": None,
+            "device": None,
+            "device_software": None,
+            "device_meta": {},
+            "platform": None,
+            "platform_package_id": None,
+            "is_admin": None,
+            "is_creator": None,
+            "app_version": None,
+            "locale": "en",
+            "host": "cts.example.com",
+        },
+        "bot_id": "24348246-6791-4ac0-9d86-b948cd6a0e46",
+        "proto_version": 4,
+        "source_sync_id": None,
+    }
+
+    collector = HandlerCollector()
+    event_delete: Optional[EventDeleted] = None
+
+    @collector.event_delete
+    async def event_delete_handler(event: EventDeleted, _: Bot) -> None:
+        nonlocal event_delete
+        event_delete = event
+        # Drop `raw_command` from asserting
+        event_delete.raw_command = None
+
+    built_bot = Bot(collectors=[collector], bot_accounts=[bot_account])
+
+    # - Act -
+    async with lifespan_wrapper(built_bot) as bot:
+        bot.async_execute_raw_bot_command(payload, verify_request=False)
+
+    # - Assert -
+    assert event_delete == EventDeleted(
+        bot=BotAccount(
+            id=UUID("24348246-6791-4ac0-9d86-b948cd6a0e46"),
+            host="cts.example.com",
+        ),
+        raw_command=None,
+        deleted_at=datetime_formatter("2025-09-23T09:04:49.787078Z"),
+        meta=EventDeletedMeta(
+            deleted_by=UUID("fbc84c63-e432-4ff1-99bd-c3275f053866"),
+            deleted_by_admin=True,
+        ),
+        group_chat_id=UUID("6fe9b0e7-32e3-4843-8486-897eabd69422"),
+        sync_ids=[UUID("36c4f12a-7082-599a-9842-cd146730e179")],
+    )