feat💥: add support for new features in modals (#1784)

* feat: add support for selects in modals (untested)

Many attempts have been made to make this non-breaking - this means the UX is a little bit off.
Also, as title says, untested.

* feat: update classes to support new select features

* feat💥: make ModalContext able to handle new component types

This requires breaking the assumption that responses always has string keys. That being said, since this is Discord breaking things, not us, this should be fine for a non-breaking release.

* docs: update/fix docstrings of select menus

Signed-off-by: Astrea <25420078+AstreaTSS@users.noreply.github.com>

* ci: correct from checks.

* feat: add file upload components for modals

* feat: make label for InputText optional

Totally forgot Discord did this, oops.

* feat: allow TextDisplayComponent to be used in modals

Apparently this has been possible for a while now.

* fix: missed a spot

* refactor: import ComponentType from enums

* fix: min/max_value -> min/max_values

* fix: make to_dict behavior correct for FileUploadComponent

* feat: add radio and checkbox components

---------

Signed-off-by: Astrea <25420078+AstreaTSS@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: AstreaTSS

interactions/__init__.py

@@ -143,6 +143,7 @@
     Extension,
     File,
     FileComponent,
+    FileUploadComponent,
     FlatUIColors,
     FlatUIColours,
     ForumLayoutType,
@@ -202,6 +203,7 @@
     Invite,
     InviteTargetType,
     is_owner,
+    LabelComponent,
     LeakyBucketSystem,
     listen,
     Listener,
@@ -375,6 +377,11 @@
     WebhookMixin,
     WebhookTypes,
     WebSocketOPCode,
+    RadioGroupOption,
+    RadioGroupComponent,
+    CheckboxGroupOption,
+    CheckboxGroupComponent,
+    CheckboxComponent,
 )
 from .api import events
 from . import ext
@@ -467,6 +474,9 @@
     "ChannelMention",
     "ChannelSelectMenu",
     "ChannelType",
+    "CheckboxComponent",
+    "CheckboxGroupComponent",
+    "CheckboxGroupOption",
     "Client",
     "ClientT",
     "ClientUser",
@@ -507,6 +517,7 @@
     "Extension",
     "File",
     "FileComponent",
+    "FileUploadComponent",
     "FlatUIColors",
     "FlatUIColours",
     "ForumLayoutType",
@@ -559,6 +570,7 @@
     "InvitableMixin",
     "Invite",
     "InviteTargetType",
+    "LabelComponent",
     "LeakyBucketSystem",
     "Listener",
     "LocalisedDesc",
@@ -615,6 +627,8 @@
     "PollResults",
     "PremiumTier",
     "PremiumType",
+    "RadioGroupComponent",
+    "RadioGroupOption",
     "Reaction",
     "ReactionUsers",
     "Resolved",
@@ -715,6 +729,8 @@
     "has_role",
     "integration_types",
     "is_owner",
+    "is_owner",
+    "kwarg_spam",
     "kwarg_spam",
     "listen",
     "logger_name",

interactions/models/__init__.py

@@ -61,6 +61,7 @@
     ExplicitContentFilterLevel,
     File,
     FileComponent,
+    FileUploadComponent,
     FlatUIColors,
     FlatUIColours,
     ForumLayoutType,
@@ -97,6 +98,7 @@
     InvitableMixin,
     Invite,
     InviteTargetType,
+    LabelComponent,
     MaterialColors,
     MaterialColours,
     MediaGalleryComponent,
@@ -217,6 +219,11 @@
     WebhookMixin,
     WebhookTypes,
     WebSocketOPCode,
+    RadioGroupOption,
+    RadioGroupComponent,
+    CheckboxGroupOption,
+    CheckboxGroupComponent,
+    CheckboxComponent,
 )
 from .internal import (
     ActiveVoiceState,
@@ -399,6 +406,9 @@
     "ChannelMention",
     "ChannelSelectMenu",
     "ChannelType",
+    "CheckboxComponent",
+    "CheckboxGroupComponent",
+    "CheckboxGroupOption",
     "ClientUser",
     "Color",
     "Colour",
@@ -437,6 +447,7 @@
     "Extension",
     "File",
     "FileComponent",
+    "FileUploadComponent",
     "FlatUIColors",
     "FlatUIColours",
     "ForumLayoutType",
@@ -488,6 +499,7 @@
     "InvitableMixin",
     "Invite",
     "InviteTargetType",
+    "LabelComponent",
     "LeakyBucketSystem",
     "Listener",
     "LocalisedDesc",
@@ -542,6 +554,8 @@
     "PollResults",
     "PremiumTier",
     "PremiumType",
+    "RadioGroupComponent",
+    "RadioGroupOption",
     "Reaction",
     "ReactionUsers",
     "Resolved",
@@ -629,6 +643,7 @@
     "has_role",
     "integration_types",
     "is_owner",
+    "is_owner",
     "listen",
     "max_concurrency",
     "message_context_menu",

interactions/models/discord/__init__.py

@@ -166,7 +166,20 @@
     process_message_payload,
     process_message_reference,
 )
-from .modal import InputText, Modal, ParagraphText, ShortText, TextStyles
+from .modal import (
+    InputText,
+    Modal,
+    ParagraphText,
+    ShortText,
+    TextStyles,
+    LabelComponent,
+    FileUploadComponent,
+    RadioGroupOption,
+    RadioGroupComponent,
+    CheckboxGroupOption,
+    CheckboxGroupComponent,
+    CheckboxComponent,
+)
 from .onboarding import Onboarding, OnboardingPrompt, OnboardingPromptOption
 from .poll import PollMedia, PollAnswer, PollAnswerCount, PollResults, Poll
 from .reaction import Reaction, ReactionUsers
@@ -240,6 +253,9 @@
     "ChannelMention",
     "ChannelSelectMenu",
     "ChannelType",
+    "CheckboxComponent",
+    "CheckboxGroupComponent",
+    "CheckboxGroupOption",
     "ClientUser",
     "Color",
     "Colour",
@@ -262,6 +278,7 @@
     "ExplicitContentFilterLevel",
     "File",
     "FileComponent",
+    "FileUploadComponent",
     "FlatUIColors",
     "FlatUIColours",
     "ForumLayoutType",
@@ -297,6 +314,7 @@
     "InvitableMixin",
     "Invite",
     "InviteTargetType",
+    "LabelComponent",
     "MFALevel",
     "MaterialColors",
     "MaterialColours",
@@ -335,6 +353,8 @@
     "PollResults",
     "PremiumTier",
     "PremiumType",
+    "RadioGroupComponent",
+    "RadioGroupOption",
     "Reaction",
     "ReactionUsers",
     "Role",

interactions/models/discord/components.py

@@ -368,7 +368,8 @@ class BaseSelectMenu(InteractiveComponent):
         min_values Optional[int]: The minimum number of items that must be chosen. (default 1, min 0, max 25)
         max_values Optional[int]: The maximum number of items that can be chosen. (default 1, max 25)
         disabled bool: Disable the select and make it not intractable, default false.
-        type Union[ComponentType, int]: The action role type number defined by discord. This cannot be modified.
+        type Union[ComponentType, int]: The type of component, as defined by discord. This cannot be modified.
+        required bool: Whether this select menu is required to be filled out or not in modals.
 
     """
 
@@ -380,12 +381,14 @@ def __init__(
         max_values: int = 1,
         custom_id: str | None = None,
         disabled: bool = False,
+        required: bool = True,
     ) -> None:
         self.custom_id: str = custom_id or str(uuid.uuid4())
         self.placeholder: str | None = placeholder
         self.min_values: int = min_values
         self.max_values: int = max_values
         self.disabled: bool = disabled
+        self.required: bool = required
 
         self.type: ComponentType = MISSING
 
@@ -397,10 +400,11 @@ def from_dict(cls, data: discord_typings.SelectMenuComponentData) -> "BaseSelect
             max_values=data["max_values"],
             custom_id=data["custom_id"],
             disabled=data.get("disabled", False),
+            required=data.get("required", True),
         )
 
     def __repr__(self) -> str:
-        return f"<{self.__class__.__name__} type={self.type} custom_id={self.custom_id} placeholder={self.placeholder} min_values={self.min_values} max_values={self.max_values} disabled={self.disabled}>"
+        return f"<{self.__class__.__name__} type={self.type} custom_id={self.custom_id} placeholder={self.placeholder} min_values={self.min_values} max_values={self.max_values} disabled={self.disabled} required={self.required}>"
 
     def to_dict(self) -> discord_typings.SelectMenuComponentData:
         return {
@@ -410,6 +414,7 @@ def to_dict(self) -> discord_typings.SelectMenuComponentData:
             "min_values": self.min_values,
             "max_values": self.max_values,
             "disabled": self.disabled,
+            "required": self.required,
         }
 
 
@@ -589,6 +594,7 @@ class StringSelectMenu(BaseSelectMenu):
         max_values Optional[int]: The maximum number of items that can be chosen. (default 1, max 25)
         disabled bool: Disable the select and make it not intractable, default false.
         type Union[ComponentType, int]: The type of component, as defined by discord. This cannot be modified.
+        required bool: Whether this select menu is required to be filled out or not in modals.
 
     """
 
@@ -603,13 +609,15 @@ def __init__(
         max_values: int = 1,
         custom_id: str | None = None,
         disabled: bool = False,
+        required: bool = True,
     ) -> None:
         super().__init__(
             placeholder=placeholder,
             min_values=min_values,
             max_values=max_values,
             custom_id=custom_id,
             disabled=disabled,
+            required=required,
         )
         if isinstance(options, (list, tuple)) and len(options) == 1 and isinstance(options[0], (list, tuple)):
             # user passed in a list of options, expand it out
@@ -627,10 +635,11 @@ def from_dict(cls, data: discord_typings.SelectMenuComponentData) -> "StringSele
             max_values=data["max_values"],
             custom_id=data["custom_id"],
             disabled=data.get("disabled", False),
+            required=data.get("required", True),
         )
 
     def __repr__(self) -> str:
-        return f"<{self.__class__.__name__} type={self.type} custom_id={self.custom_id} placeholder={self.placeholder} min_values={self.min_values} max_values={self.max_values} disabled={self.disabled} options={self.options}>"
+        return f"<{self.__class__.__name__} type={self.type} custom_id={self.custom_id} placeholder={self.placeholder} min_values={self.min_values} max_values={self.max_values} disabled={self.disabled} required={self.required} options={self.options}>"
 
     def to_dict(self) -> discord_typings.SelectMenuComponentData:
         return {
@@ -651,6 +660,7 @@ class UserSelectMenu(DefaultableSelectMenu):
         default_values list[BaseUser, Member, SelectDefaultValues]: A list of default values to pre-select in the select.
         disabled bool: Disable the select and make it not intractable, default false.
         type Union[ComponentType, int]: The type of component, as defined by discord. This cannot be modified.
+        required bool: Whether this select menu is required to be filled out or not in modals.
 
     """
 
@@ -672,13 +682,15 @@ def __init__(
             | None
         ) = None,
         disabled: bool = False,
+        required: bool = True,
     ) -> None:
         super().__init__(
             placeholder=placeholder,
             min_values=min_values,
             max_values=max_values,
             custom_id=custom_id,
             disabled=disabled,
+            required=required,
             defaults=default_values,
         )
 
@@ -697,6 +709,7 @@ class RoleSelectMenu(DefaultableSelectMenu):
         default_values list[Role, SelectDefaultValues]: A list of default values to pre-select in the select.
         disabled bool: Disable the select and make it not intractable, default false.
         type Union[ComponentType, int]: The type of component, as defined by discord. This cannot be modified.
+        required bool: Whether this select menu is required to be filled out or not in modals.
 
     """
 
@@ -708,6 +721,7 @@ def __init__(
         max_values: int = 1,
         custom_id: str | None = None,
         disabled: bool = False,
+        required: bool = True,
         default_values: (
             list[
                 Union[
@@ -724,6 +738,7 @@ def __init__(
             max_values=max_values,
             custom_id=custom_id,
             disabled=disabled,
+            required=required,
             defaults=default_values,
         )
 
@@ -742,6 +757,7 @@ class MentionableSelectMenu(DefaultableSelectMenu):
         default_values list[BaseUser, Role, BaseChannel, Member, SelectDefaultValues]: A list of default values to pre-select in the select.
         disabled bool: Disable the select and make it not intractable, default false.
         type Union[ComponentType, int]: The type of component, as defined by discord. This cannot be modified.
+        required bool: Whether this select menu is required to be filled out or not in modals.
 
     """
 
@@ -753,6 +769,7 @@ def __init__(
         max_values: int = 1,
         custom_id: str | None = None,
         disabled: bool = False,
+        required: bool = True,
         default_values: (
             list[
                 Union[
@@ -772,6 +789,7 @@ def __init__(
             max_values=max_values,
             custom_id=custom_id,
             disabled=disabled,
+            required=required,
             defaults=default_values,
         )
 
@@ -790,6 +808,7 @@ class ChannelSelectMenu(DefaultableSelectMenu):
         default_values list[BaseChannel, SelectDefaultValues]: A list of default values to pre-select in the select.
         disabled bool: Disable the select and make it not intractable, default false.
         type Union[ComponentType, int]: The type of component, as defined by discord. This cannot be modified.
+        required bool: Whether this select menu is required to be filled out or not in modals.
 
     """
 
@@ -802,6 +821,7 @@ def __init__(
         max_values: int = 1,
         custom_id: str | None = None,
         disabled: bool = False,
+        required: bool = True,
         default_values: (
             list[
                 Union[
@@ -818,6 +838,7 @@ def __init__(
             max_values=max_values,
             custom_id=custom_id,
             disabled=disabled,
+            required=required,
             defaults=default_values,
         )
 
@@ -834,11 +855,12 @@ def from_dict(cls, data: discord_typings.SelectMenuComponentData) -> "ChannelSel
             max_values=data["max_values"],
             custom_id=data["custom_id"],
             disabled=data.get("disabled", False),
+            required=data.get("required", True),
             channel_types=data.get("channel_types", []),
         )
 
     def __repr__(self) -> str:
-        return f"<{self.__class__.__name__} type={self.type} custom_id={self.custom_id} placeholder={self.placeholder} min_values={self.min_values} max_values={self.max_values} disabled={self.disabled} channel_types={self.channel_types}>"
+        return f"<{self.__class__.__name__} type={self.type} custom_id={self.custom_id} placeholder={self.placeholder} min_values={self.min_values} max_values={self.max_values} disabled={self.disabled} required={self.required} channel_types={self.channel_types}>"
 
     def to_dict(self) -> discord_typings.SelectMenuComponentData:
         return {