🐛 make ComponentEmoji id and name optional (#91)

* fix: make ComponentEmoji id and name optional

Discord only includes the `id` field for custom emojis, not for standard
unicode emojis (e.g. 🔗).  Defining `id` as required via `Field(...)` causes
pydantic ValidationError when receiving MESSAGE_UPDATE events containing
button components with unicode emojis.

Change both `id` and `name` to use `Missing[...] = UNSET` to match the
Discord API specification where both fields are optional in a partial emoji.

Fixes #90

* fix: make ComponentEmoji id and name optional

Discord only includes the id field for custom emojis, not for standard
unicode emojis (e.g. 🔗).  Defining id as required via Field(...) causes
pydantic ValidationError when receiving MESSAGE_UPDATE events containing
button components with unicode emojis.

Change both id and
ame to use Missing[...] = UNSET to match the
Discord API specification where both fields are optional in a partial emoji.

Fixes #90

* fix: align ComponentEmoji with partial emoji schema

---------

Co-authored-by: shoucandanghehe <wallfjjd@gmail.com>

Author: RainyN0077

nonebot/adapters/discord/api/model.py

@@ -641,9 +641,9 @@ class ComponentEmoji(BaseModel):
     see https://discord.com/developers/docs/interactions/message-components#button-object
     """
 
-    id: str | None = Field(...)
+    id: MissingOrNullable[Snowflake] = UNSET
     """emoji id"""
-    name: str | None = Field(...)
+    name: MissingOrNullable[str] = UNSET
     """emoji name"""
     animated: Missing[bool] = UNSET
     """whether this emoji is animated"""

tests/test_api_nullability.py

@@ -4,9 +4,11 @@
 
 from nonebot.adapters.discord.api import (
     ActionRow,
+    ComponentEmoji,
     ComponentType,
     SelectMenu,
     SelectOption,
+    Snowflake,
 )
 from nonebot.adapters.discord.api.model import (
     Embed,
@@ -23,6 +25,8 @@
 )
 from nonebot.adapters.discord.utils import omit_unset
 
+from nonebot.compat import type_validate_python
+
 
 def _json_payload(prepared: PreparedRequest) -> dict[str, Any]:
     encoded = encode_prepared_request(prepared)
@@ -135,6 +139,22 @@ def test_parse_data_keeps_action_row_type_for_components() -> None:
     assert int(payload["components"][0]["type"]) == int(ComponentType.ActionRow)
 
 
+def test_component_emoji_allows_missing_partial_fields() -> None:
+    emoji = type_validate_python(ComponentEmoji, {"name": "🔗"})
+
+    assert emoji.id is UNSET
+    assert emoji.name == "🔗"
+    assert emoji.animated is UNSET
+
+
+def test_component_emoji_id_is_nullable_snowflake() -> None:
+    emoji = type_validate_python(ComponentEmoji, {"id": "41771983429993937"})
+
+    assert isinstance(emoji.id, Snowflake)
+    assert emoji.id == Snowflake(41771983429993937)
+    assert emoji.name is UNSET
+
+
 def test_parse_forum_thread_message_keeps_name() -> None:
     payload = _json_payload(
         parse_forum_thread_message({"name": "thread-name", "content": "hello"})