feat: Add SharedClientTheme support for customizable message appearance

Author: UnBonWhisky

discord/__init__.py

@@ -68,6 +68,7 @@
 from .role import *
 from .scheduled_events import *
 from .shard import *
+from .shared_client_theme import *
 from .soundboard import *
 from .stage_instance import *
 from .sticker import *

discord/abc.py

@@ -58,6 +58,7 @@
 from .scheduled_events import ScheduledEvent
 from .sticker import GuildSticker, StickerItem
 from .utils import warn_deprecated
+from .shared_client_theme import SharedClientThemeBaseType
 
 __all__ = (
     "Snowflake",
@@ -89,6 +90,7 @@
     from .member import Member
     from .message import Message, MessageReference, PartialMessage
     from .poll import Poll
+    from .shared_client_theme import SharedClientTheme
     from .state import ConnectionState
     from .threads import Thread
     from .types.channel import Channel as ChannelPayload
@@ -1388,6 +1390,7 @@ async def send(
         suppress: bool = ...,
         suppress_embeds: bool = ...,
         silent: bool = ...,
+        shared_client_theme: SharedClientTheme = ...,
     ) -> Message: ...
 
     @overload
@@ -1410,6 +1413,7 @@ async def send(
         suppress: bool = ...,
         suppress_embeds: bool = ...,
         silent: bool = ...,
+        shared_client_theme: SharedClientTheme = ...,
     ) -> Message: ...
 
     @overload
@@ -1432,6 +1436,7 @@ async def send(
         suppress: bool = ...,
         suppress_embeds: bool = ...,
         silent: bool = ...,
+        shared_client_theme: SharedClientTheme = ...,
     ) -> Message: ...
 
     @overload
@@ -1454,6 +1459,7 @@ async def send(
         suppress: bool = ...,
         suppress_embeds: bool = ...,
         silent: bool = ...,
+        shared_client_theme: SharedClientTheme = ...,
     ) -> Message: ...
 
     async def send(
@@ -1477,6 +1483,7 @@ async def send(
         suppress=None,
         suppress_embeds=None,
         silent=None,
+        shared_client_theme=None,
     ):
         """|coro|
 
@@ -1496,6 +1503,9 @@ async def send(
         parameter should be used with a :class:`list` of :class:`~discord.Embed` objects.
         **Specifying both parameters will lead to an exception**.
 
+        To upload a shared client theme, the ``shared_client_theme`` parameter should be used
+        with a :class:`~discord.SharedClientTheme` object.
+
         Parameters
         ----------
         content: Optional[:class:`str`]
@@ -1568,6 +1578,10 @@ async def send(
             The poll to send.
 
             .. versionadded:: 2.6
+        shared_client_theme: :class:`SharedClientTheme`
+            The shared client theme to send.
+
+            .. versionadded:: 2.8
 
         Returns
         -------
@@ -1585,13 +1599,35 @@ async def send(
             you specified both ``file`` and ``files``,
             or you specified both ``embed`` and ``embeds``,
             or the ``reference`` object is not a :class:`~discord.Message`,
-            :class:`~discord.MessageReference` or :class:`~discord.PartialMessage`.
+            :class:`~discord.MessageReference` or :class:`~discord.PartialMessage`,
+            or the ``shared_client_theme`` object does not meet the required criteria.
         """
 
         channel = await self._get_channel()
         state = self._state
         content = str(content) if content is not None else None
 
+        if shared_client_theme is not None:
+            if shared_client_theme.colors is None or len(shared_client_theme.colors) == 0:
+                raise InvalidArgument("shared_client_theme must have at least one color")
+            if len(shared_client_theme.colors) > 5:
+                raise InvalidArgument("shared_client_theme cannot have more than 5 colors")
+            
+            if shared_client_theme.gradient_angle is None :
+                raise InvalidArgument("shared_client_theme must have a gradient angle")
+            if shared_client_theme.gradient_angle < 0 or shared_client_theme.gradient_angle > 360:
+                raise InvalidArgument("shared_client_theme gradient angle must be between 0 and 360 degrees")
+            
+            if shared_client_theme.base_mix is None :
+                raise InvalidArgument("shared_client_theme must have a base mix value")
+            if shared_client_theme.base_mix < 0 or shared_client_theme.base_mix > 100 :
+                raise InvalidArgument("shared_client_theme base mix must be between 0 and 100")
+            
+            if shared_client_theme.base_theme is not None and not isinstance(shared_client_theme.base_theme, SharedClientThemeBaseType):
+                raise InvalidArgument("shared_client_theme base theme must be a SharedClientThemeBaseType enum value")
+            
+            shared_client_theme = shared_client_theme.to_dict()
+
         if embed is not None and embeds is not None:
             raise InvalidArgument(
                 "cannot pass both embed and embeds parameter to send()"
@@ -1706,6 +1742,7 @@ async def send(
                     components=components,
                     flags=flags.value,
                     poll=poll,
+                    shared_client_theme=shared_client_theme,
                 )
             finally:
                 for f in files:
@@ -1725,6 +1762,7 @@ async def send(
                 components=components,
                 flags=flags.value,
                 poll=poll,
+                shared_client_theme=shared_client_theme,
             )
 
         ret = state.create_message(channel=channel, data=data)

discord/enums.py

@@ -88,6 +88,7 @@
     "SelectDefaultValueType",
     "ApplicationEventWebhookStatus",
     "InviteTargetUsersJobStatusCode",
+    "SharedClientThemeBaseType",
 )
 
 
@@ -1212,6 +1213,23 @@ class InviteTargetUsersJobStatusCode(Enum):
     failed = 3
 
 
+class SharedClientThemeBaseType(Enum):
+    """The base theme mode of a :class:`SharedClientTheme`.
+
+    .. versionadded:: 2.8
+
+    .. note::
+
+        ``unset`` is treated as equivalent to ``dark`` by Discord.
+    """
+
+    unset = 0
+    dark = 1
+    light = 2
+    darker = 3
+    midnight = 4
+
+
 T = TypeVar("T")
 
 

discord/http.py

@@ -84,6 +84,9 @@
         poll,
         role,
         scheduled_events,
+    )
+    from .types import shared_client_theme as shared_client_theme_type
+    from .types import (
         sticker,
         template,
         threads,
@@ -507,6 +510,7 @@ def send_message(
         components: list[components.Component] | None = None,
         flags: int | None = None,
         poll: poll.Poll | None = None,
+        shared_client_theme: shared_client_theme_type.SharedClientTheme | None = None,
     ) -> Response[message.Message]:
         r = Route("POST", "/channels/{channel_id}/messages", channel_id=channel_id)
         payload = {}
@@ -547,6 +551,9 @@ def send_message(
         if poll:
             payload["poll"] = poll
 
+        if shared_client_theme:
+            payload["shared_client_theme"] = shared_client_theme
+
         return self.request(r, json=payload)
 
     def send_typing(self, channel_id: Snowflake) -> Response[None]:
@@ -571,6 +578,7 @@ def send_multipart_helper(
         components: list[components.Component] | None = None,
         flags: int | None = None,
         poll: poll.Poll | None = None,
+        shared_client_theme: shared_client_theme_type.SharedClientTheme | None = None,
     ) -> Response[message.Message]:
         form = []
 
@@ -598,6 +606,9 @@ def send_multipart_helper(
         if poll:
             payload["poll"] = poll
 
+        if shared_client_theme:
+            payload["shared_client_theme"] = shared_client_theme
+
         attachments = []
         form.append({"name": "payload_json"})
         for index, file in enumerate(files):
@@ -641,6 +652,7 @@ def send_files(
         components: list[components.Component] | None = None,
         flags: int | None = None,
         poll: poll.Poll | None = None,
+        shared_client_theme: shared_client_theme_type.SharedClientTheme | None = None,
     ) -> Response[message.Message]:
         r = Route("POST", "/channels/{channel_id}/messages", channel_id=channel_id)
         return self.send_multipart_helper(
@@ -658,6 +670,7 @@ def send_files(
             components=components,
             flags=flags,
             poll=poll,
+            shared_client_theme=shared_client_theme,
         )
 
     def edit_multipart_helper(

discord/message.py

@@ -58,6 +58,7 @@
 from .partial_emoji import PartialEmoji
 from .poll import Poll
 from .reaction import Reaction
+from .shared_client_theme import SharedClientTheme
 from .sticker import StickerItem
 from .threads import Thread
 from .utils import MISSING, escape_mentions, find, warn_deprecated
@@ -90,6 +91,7 @@
     from .types.message import MessageSnapshot as MessageSnapshotPayload
     from .types.message import Reaction as ReactionPayload
     from .types.poll import Poll as PollPayload
+    from .types.shared_client_theme import SharedClientTheme as SharedClientThemePayload
     from .types.snowflake import SnowflakeList
     from .types.threads import ThreadArchiveDuration
     from .types.user import User as UserPayload
@@ -1039,6 +1041,10 @@ class Message(Hashable):
         The poll associated with this message, if applicable.
 
         .. versionadded:: 2.6
+    shared_client_theme: Optional[:class:`SharedClientTheme`]
+        The shared client theme transmitted via this message, if applicable.
+
+        .. versionadded:: 2.8
     call: Optional[:class:`MessageCall`]
         The call information associated with this message, if applicable.
 
@@ -1087,6 +1093,7 @@ class Message(Hashable):
         "_poll",
         "call",
         "snapshots",
+        "shared_client_theme",
     )
 
     if TYPE_CHECKING:
@@ -1217,6 +1224,14 @@ def __init__(
         except KeyError:
             self.call = None
 
+        self.shared_client_theme: SharedClientTheme | None
+        try:
+            self.shared_client_theme = SharedClientTheme.from_dict(
+                data["shared_client_theme"]
+            )
+        except KeyError:
+            self.shared_client_theme = None
+
         for handler in ("author", "member", "mentions", "mention_roles"):
             try:
                 getattr(self, f"_handle_{handler}")(data[handler])
@@ -1328,6 +1343,9 @@ def _handle_poll(self, value: PollPayload) -> None:
         self._poll = Poll.from_dict(value, self)
         self._state.store_poll(self._poll, self.id)
 
+    def _handle_shared_client_theme(self, value: SharedClientThemePayload) -> None:
+        self.shared_client_theme = SharedClientTheme.from_dict(value)
+
     def _handle_author(self, author: UserPayload) -> None:
         self.author = self._state.store_user(author)
         if isinstance(self.guild, Guild):