feat(app-cmds): support nsfw only commands (#709)

* Add `nsfw` support for Application commands

* Also support message/user commands.

* Add missing types in nextcord\types\interactions.py

* Fix re-syncing on not consistent discord payload.

* add nsfw key to nextcord\types\interactions.py;_ApplicationCommandOptional

* Requested changes and versionadded

"Not-NSFW channels" -> "Non NSFW channels"

Co-Authored-By: Skelmis <[email protected]>

* Fix versionadded typo

"2.0" -> "2.1"

Co-Authored-By: Oliver Wilkes <[email protected]>

* docs: bump versionadded to 2.4

* docs: fix phrasing of the nsfw param

* docs: fix formatting errors

* docs: more formatting errors

* correct all descriptions and types

* prevent commands from needlessly resyncing

More info: #709 (comment)

Co-Authored-By: Alex Schoenhofen <[email protected]>

---------

Co-authored-by: Skelmis <[email protected]>
Co-authored-by: Oliver Wilkes <[email protected]>
Co-authored-by: Emre Terzioglu <[email protected]>
Co-authored-by: Alex Schoenhofen <[email protected]>

Author: 5 people

nextcord/application_command.py

@@ -1859,6 +1859,7 @@ def __init__(
         guild_ids: Optional[Iterable[int]] = MISSING,
         dm_permission: Optional[bool] = None,
         default_member_permissions: Optional[Union[Permissions, int]] = None,
+        nsfw: bool = False,
         parent_cog: Optional[ClientCog] = None,
         force_global: bool = False,
     ) -> None:
@@ -1892,6 +1893,10 @@ def __init__(
             Permission(s) required to use the command. Inputting ``8`` or ``Permissions(administrator=True)`` for
             example will only allow Administrators to use the command. If set to 0, nobody will be able to use it by
             default. Server owners CAN override the permission requirements.
+        nsfw: :class:`bool`
+            Whether the command can only be used in age-restricted channels. Defaults to ``False``.
+
+            .. versionadded:: 2.4
         parent_cog: Optional[:class:`ClientCog`]
             ``ClientCog`` to forward to the callback as the ``self`` argument.
         force_global: :class:`bool`
@@ -1913,6 +1918,7 @@ def __init__(
         self.default_member_permissions: Optional[
             Union[Permissions, int]
         ] = default_member_permissions
+        self.nsfw: bool = nsfw
 
         self.force_global: bool = force_global
 
@@ -2114,6 +2120,8 @@ def get_payload(self, guild_id: Optional[int]) -> dict:
                 #  the default (True) to ensure payload parity for comparisons.
                 ret["dm_permission"] = True
 
+        ret["nsfw"] = self.nsfw
+
         return ret
 
     def parse_discord_response(
@@ -2175,6 +2183,7 @@ def is_payload_valid(
             "name_localizations",
             "description_localizations",
             "dm_permission",
+            "nsfw",
         ):
             _log.debug("Failed check dictionary values, not valid payload.")
             return False
@@ -2682,6 +2691,7 @@ def __init__(
         guild_ids: Optional[Iterable[int]] = None,
         dm_permission: Optional[bool] = None,
         default_member_permissions: Optional[Union[Permissions, int]] = None,
+        nsfw: bool = False,
         parent_cog: Optional[ClientCog] = None,
         force_global: bool = False,
     ) -> None:
@@ -2711,6 +2721,14 @@ def __init__(
             Permission(s) required to use the command. Inputting ``8`` or ``Permissions(administrator=True)`` for
             example will only allow Administrators to use the command. If set to 0, nobody will be able to use it by
             default. Server owners CAN override the permission requirements.
+        nsfw: :class:`bool`
+            Whether the command can only be used in age-restricted channels. Defaults to ``False``.
+
+            .. note::
+
+                Due to a discord limitation, this can only be set for the parent command in case of a subcommand.
+
+            .. versionadded:: 2.4
         parent_cog: Optional[:class:`ClientCog`]
             ``ClientCog`` to forward to the callback as the ``self`` argument.
         force_global: :class:`bool`
@@ -2727,6 +2745,7 @@ def __init__(
             guild_ids=guild_ids,
             default_member_permissions=default_member_permissions,
             dm_permission=dm_permission,
+            nsfw=nsfw,
             parent_cog=parent_cog,
             force_global=force_global,
         )
@@ -2846,6 +2865,7 @@ def __init__(
         guild_ids: Optional[Iterable[int]] = None,
         dm_permission: Optional[bool] = None,
         default_member_permissions: Optional[Union[Permissions, int]] = None,
+        nsfw: bool = False,
         parent_cog: Optional[ClientCog] = None,
         force_global: bool = False,
     ) -> None:
@@ -2870,6 +2890,10 @@ def __init__(
             Permission(s) required to use the command. Inputting ``8`` or ``Permissions(administrator=True)`` for
             example will only allow Administrators to use the command. If set to 0, nobody will be able to use it by
             default. Server owners CAN override the permission requirements.
+        nsfw: :class:`bool`
+            Whether the command can only be used in age-restricted channels. Defaults to ``False``.
+
+            .. versionadded:: 2.4
         parent_cog: Optional[:class:`ClientCog`]
             ``ClientCog`` to forward to the callback as the ``self`` argument.
         force_global: :class:`bool`
@@ -2884,6 +2908,7 @@ def __init__(
             guild_ids=guild_ids,
             dm_permission=dm_permission,
             default_member_permissions=default_member_permissions,
+            nsfw=nsfw,
             parent_cog=parent_cog,
             force_global=force_global,
         )
@@ -2922,6 +2947,7 @@ def __init__(
         guild_ids: Optional[Iterable[int]] = None,
         dm_permission: Optional[bool] = None,
         default_member_permissions: Optional[Union[Permissions, int]] = None,
+        nsfw: bool = False,
         parent_cog: Optional[ClientCog] = None,
         force_global: bool = False,
     ) -> None:
@@ -2946,6 +2972,10 @@ def __init__(
             Permission(s) required to use the command. Inputting ``8`` or ``Permissions(administrator=True)`` for
             example will only allow Administrators to use the command. If set to 0, nobody will be able to use it by
             default. Server owners CAN override the permission requirements.
+        nsfw: :class:`bool`
+            Whether the command can only be used in age-restricted channels. Defaults to ``False``.
+
+            .. versionadded:: 2.4
         parent_cog: Optional[:class:`ClientCog`]
             ``ClientCog`` to forward to the callback as the ``self`` argument.
         force_global: :class:`bool`
@@ -2960,6 +2990,7 @@ def __init__(
             guild_ids=guild_ids,
             dm_permission=dm_permission,
             default_member_permissions=default_member_permissions,
+            nsfw=nsfw,
             parent_cog=parent_cog,
             force_global=force_global,
         )
@@ -2995,6 +3026,7 @@ def slash_command(
     guild_ids: Optional[Iterable[int]] = MISSING,
     dm_permission: Optional[bool] = None,
     default_member_permissions: Optional[Union[Permissions, int]] = None,
+    nsfw: bool = False,
     force_global: bool = False,
 ):
     """Creates a Slash application command from the decorated function.
@@ -3024,6 +3056,14 @@ def slash_command(
         Permission(s) required to use the command. Inputting ``8`` or ``Permissions(administrator=True)`` for
         example will only allow Administrators to use the command. If set to 0, nobody will be able to use it by
         default. Server owners CAN override the permission requirements.
+    nsfw: :class:`bool`
+        Whether the command can only be used in age-restricted channels. Defaults to ``False``.
+
+        .. note::
+
+            Due to a discord limitation, this can only be set for the parent command in case of a subcommand.
+
+        .. versionadded:: 2.4
     force_global: :class:`bool`
         If True, will force this command to register as a global command, even if ``guild_ids`` is set. Will still
         register to guilds. Has no effect if ``guild_ids`` are never set or added to.
@@ -3042,6 +3082,7 @@ def decorator(func: Callable) -> SlashApplicationCommand:
             guild_ids=guild_ids,
             dm_permission=dm_permission,
             default_member_permissions=default_member_permissions,
+            nsfw=nsfw,
             force_global=force_global,
         )
         return app_cmd
@@ -3056,6 +3097,7 @@ def message_command(
     guild_ids: Optional[Iterable[int]] = MISSING,
     dm_permission: Optional[bool] = None,
     default_member_permissions: Optional[Union[Permissions, int]] = None,
+    nsfw: bool = False,
     force_global: bool = False,
 ):
     """Creates a Message context command from the decorated function.
@@ -3079,6 +3121,10 @@ def message_command(
         Permission(s) required to use the command. Inputting ``8`` or ``Permissions(administrator=True)`` for
         example will only allow Administrators to use the command. If set to 0, nobody will be able to use it by
         default. Server owners CAN override the permission requirements.
+    nsfw: :class:`bool`
+        Whether the command can only be used in age-restricted channels. Defaults to ``False``.
+
+        .. versionadded:: 2.4
     force_global: :class:`bool`
         If True, will force this command to register as a global command, even if ``guild_ids`` is set. Will still
         register to guilds. Has no effect if ``guild_ids`` are never set or added to.
@@ -3095,6 +3141,7 @@ def decorator(func: Callable) -> MessageApplicationCommand:
             guild_ids=guild_ids,
             dm_permission=dm_permission,
             default_member_permissions=default_member_permissions,
+            nsfw=nsfw,
             force_global=force_global,
         )
         return app_cmd
@@ -3109,6 +3156,7 @@ def user_command(
     guild_ids: Optional[Iterable[int]] = MISSING,
     dm_permission: Optional[bool] = None,
     default_member_permissions: Optional[Union[Permissions, int]] = None,
+    nsfw: bool = False,
     force_global: bool = False,
 ):
     """Creates a User context command from the decorated function.
@@ -3132,6 +3180,10 @@ def user_command(
         Permission(s) required to use the command. Inputting ``8`` or ``Permissions(administrator=True)`` for
         example will only allow Administrators to use the command. If set to 0, nobody will be able to use it by
         default. Server owners CAN override the permission requirements.
+    nsfw: :class:`bool`
+        Whether the command can only be used in age-restricted channels. Defaults to ``False``.
+
+        .. versionadded:: 2.4
     force_global: :class:`bool`
         If True, will force this command to register as a global command, even if ``guild_ids`` is set. Will still
         register to guilds. Has no effect if ``guild_ids`` are never set or added to.
@@ -3148,6 +3200,7 @@ def decorator(func: Callable) -> UserApplicationCommand:
             guild_ids=guild_ids,
             dm_permission=dm_permission,
             default_member_permissions=default_member_permissions,
+            nsfw=nsfw,
             force_global=force_global,
         )
         return app_cmd

nextcord/client.py

@@ -2566,6 +2566,7 @@ def user_command(
         guild_ids: Optional[Iterable[int]] = MISSING,
         dm_permission: Optional[bool] = None,
         default_member_permissions: Optional[Union[Permissions, int]] = None,
+        nsfw: bool = False,
         force_global: bool = False,
     ):
         """Creates a User context command from the decorated function.
@@ -2588,6 +2589,10 @@ def user_command(
             Permission(s) required to use the command. Inputting ``8`` or ``Permissions(administrator=True)`` for
             example will only allow Administrators to use the command. If set to 0, nobody will be able to use it by
             default. Server owners CAN override the permission requirements.
+        nsfw: :class:`bool`
+            Whether the command can only be used in age-restricted channels. Defaults to ``False``.
+
+            .. versionadded:: 2.4
         force_global: :class:`bool`
             If True, will force this command to register as a global command, even if ``guild_ids`` is set. Will still
             register to guilds. Has no effect if ``guild_ids`` are never set or added to.
@@ -2600,6 +2605,7 @@ def decorator(func: Callable):
                 guild_ids=guild_ids,
                 dm_permission=dm_permission,
                 default_member_permissions=default_member_permissions,
+                nsfw=nsfw,
                 force_global=force_global,
             )(func)
             self._application_commands_to_add.add(result)
@@ -2615,6 +2621,7 @@ def message_command(
         guild_ids: Optional[Iterable[int]] = MISSING,
         dm_permission: Optional[bool] = None,
         default_member_permissions: Optional[Union[Permissions, int]] = None,
+        nsfw: bool = False,
         force_global: bool = False,
     ):
         """Creates a Message context command from the decorated function.
@@ -2637,6 +2644,10 @@ def message_command(
             Permission(s) required to use the command. Inputting ``8`` or ``Permissions(administrator=True)`` for
             example will only allow Administrators to use the command. If set to 0, nobody will be able to use it by
             default. Server owners CAN override the permission requirements.
+        nsfw: :class:`bool`
+            Whether the command can only be used in age-restricted channels. Defaults to ``False``.
+
+            .. versionadded:: 2.4
         force_global: :class:`bool`
             If True, will force this command to register as a global command, even if ``guild_ids`` is set. Will still
             register to guilds. Has no effect if ``guild_ids`` are never set or added to.
@@ -2665,6 +2676,7 @@ def slash_command(
         description_localizations: Optional[Dict[Union[Locale, str], str]] = None,
         guild_ids: Optional[Iterable[int]] = MISSING,
         dm_permission: Optional[bool] = None,
+        nsfw: bool = False,
         default_member_permissions: Optional[Union[Permissions, int]] = None,
         force_global: bool = False,
     ):
@@ -2694,6 +2706,10 @@ def slash_command(
             Permission(s) required to use the command. Inputting ``8`` or ``Permissions(administrator=True)`` for
             example will only allow Administrators to use the command. If set to 0, nobody will be able to use it by
             default. Server owners CAN override the permission requirements.
+        nsfw: :class:`bool`
+            Whether the command can only be used in age-restricted channels. Defaults to ``False``.
+
+            .. versionadded:: 2.4
         force_global: :class:`bool`
             If True, will force this command to register as a global command, even if ``guild_ids`` is set. Will still
             register to guilds. Has no effect if ``guild_ids`` are never set or added to.
@@ -2708,6 +2724,7 @@ def decorator(func: Callable):
                 guild_ids=guild_ids,
                 dm_permission=dm_permission,
                 default_member_permissions=default_member_permissions,
+                nsfw=nsfw,
                 force_global=force_global,
             )(func)
             self._application_commands_to_add.add(result)

nextcord/types/interactions.py

@@ -26,16 +26,22 @@ class ApplicationCommand(TypedDict):
     application_id: Snowflake
     name: str
     description: str
+    default_member_permissions: str
     version: Snowflake
     type: NotRequired[ApplicationCommandType]
     guild_id: NotRequired[Snowflake]
     options: NotRequired[List[ApplicationCommandOption]]
     default_permission: NotRequired[bool]
+    dm_permission: NotRequired[bool]
+    nsfw: NotRequired[bool]
+    name_localizations: NotRequired[Dict[str, str]]
+    description_localizations: NotRequired[Dict[str, str]]
 
 
 class ApplicationCommandOptionChoice(TypedDict):
     name: str
     value: Union[str, int, float]
+    name_localizations: Dict[str, str]
 
 
 ApplicationCommandOptionType = Literal[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]
@@ -54,6 +60,8 @@ class ApplicationCommandOption(TypedDict):
     min_length: NotRequired[int]
     max_length: NotRequired[int]
     autocomplete: NotRequired[bool]
+    name_localizations: NotRequired[Dict[str, str]]
+    description_localizations: NotRequired[Dict[str, str]]
 
 
 ApplicationCommandPermissionType = Literal[1, 2]