Add nsfw config option for application commands (#802)

Co-authored-by: always-on-duty[bot] <120557446+always-on-duty[bot]@users.noreply.github.com>

Author: FasterSpeeding

CHANGELOG.md

@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [2.16.0] - 2023-07-26
+- `nsfw` config option for application commands.
+
 ## [2.15.0] - 2023-05-31
 ### Added
 - [dependencies.add_cooldown][tanjun.dependencies.limiters.add_cooldown] and
@@ -961,7 +964,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Support for python 3.8 in-order to switch over to using collection.abc generic classes due to this being more
   forward compatible.
 
-[Unreleased]: https://github.com/FasterSpeeding/Tanjun/compare/v2.15.0...HEAD
+[Unreleased]: https://github.com/FasterSpeeding/Tanjun/compare/v2.16.0...HEAD
+[2.16.0]: https://github.com/FasterSpeeding/Tanjun/compare/v2.15.0...v2.16.0
 [2.15.0]: https://github.com/FasterSpeeding/Tanjun/compare/v2.14.0...v2.15.0
 [2.14.0]: https://github.com/FasterSpeeding/Tanjun/compare/v2.13.0...v2.14.0
 [2.13.0]: https://github.com/FasterSpeeding/Tanjun/compare/v2.12.0...v2.13.0

dev-requirements/type-checking.txt

@@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "hikari-tanjun"
-version = "2.15.0"
+version = "2.16.0"
 readme = "README.md"
 requires-python = ">=3.9.0,<3.12"
 license = {file = "LICENSE"}

pyproject.toml

@@ -2729,6 +2729,10 @@ def is_global(self) -> bool:
             is inherited regardless of what it's set as on the child command.
         """
 
+    @property
+    def is_nsfw(self) -> typing.Optional[bool]:
+        """Whether a command should only be accessible in channels marked as NSFW."""
+
     @property
     @abc.abstractmethod
     def name(self) -> str:

tanjun/abc.py

@@ -95,6 +95,7 @@ def as_message_menu(
     default_to_ephemeral: typing.Optional[bool] = None,
     dm_enabled: typing.Optional[bool] = None,
     is_global: bool = True,
+    nsfw: bool = False,
 ) -> _AsMsgResultProto:
     """Build a message [MenuCommand][tanjun.MenuCommand] by decorating a function.
 
@@ -145,6 +146,9 @@ async def message_command(self, ctx: tanjun.abc.MenuContext, message: hikari.Mes
         will be used.
     is_global
         Whether this command is a global command.
+    nsfw
+        Whether this command should only be accessible in channels marked as
+        nsfw.
 
     Returns
     -------
@@ -185,6 +189,7 @@ def decorator(
             default_to_ephemeral=default_to_ephemeral,
             dm_enabled=dm_enabled,
             is_global=is_global,
+            nsfw=nsfw,
             _wrapped_command=wrapped_command,
         )
 
@@ -216,6 +221,7 @@ def as_user_menu(
     default_to_ephemeral: typing.Optional[bool] = None,
     dm_enabled: typing.Optional[bool] = None,
     is_global: bool = True,
+    nsfw: bool = False,
 ) -> _AsUserResultProto:
     """Build a user [MenuCommand][tanjun.MenuCommand] by decorating a function.
 
@@ -268,6 +274,9 @@ async def user_command(
         will be used.
     is_global
         Whether this command is a global command.
+    nsfw
+        Whether this command should only be accessible in channels marked as
+        nsfw.
 
     Returns
     -------
@@ -308,6 +317,7 @@ def decorator(
             default_to_ephemeral=default_to_ephemeral,
             dm_enabled=dm_enabled,
             is_global=is_global,
+            nsfw=nsfw,
             _wrapped_command=wrapped_command,
         )
 
@@ -328,6 +338,7 @@ class MenuCommand(base.PartialCommand[tanjun.MenuContext], tanjun.MenuCommand[_A
         "_description",
         "_is_dm_enabled",
         "_is_global",
+        "_is_nsfw",
         "_names",
         "_parent",
         "_tracked_command",
@@ -348,6 +359,7 @@ def __init__(
         default_to_ephemeral: typing.Optional[bool] = None,
         dm_enabled: typing.Optional[bool] = None,
         is_global: bool = True,
+        nsfw: bool = False,
         _wrapped_command: typing.Optional[tanjun.ExecutableCommand[typing.Any]] = None,
     ) -> None:
         ...
@@ -367,6 +379,7 @@ def __init__(
         default_to_ephemeral: typing.Optional[bool] = None,
         dm_enabled: typing.Optional[bool] = None,
         is_global: bool = True,
+        nsfw: bool = False,
         _wrapped_command: typing.Optional[tanjun.ExecutableCommand[typing.Any]] = None,
     ) -> None:
         ...
@@ -384,6 +397,7 @@ def __init__(
         default_to_ephemeral: typing.Optional[bool] = None,
         dm_enabled: typing.Optional[bool] = None,
         is_global: bool = True,
+        nsfw: bool = False,
         _wrapped_command: typing.Optional[tanjun.ExecutableCommand[typing.Any]] = None,
     ) -> None:
         ...
@@ -403,6 +417,7 @@ def __init__(
         default_to_ephemeral: typing.Optional[bool] = None,
         dm_enabled: typing.Optional[bool] = None,
         is_global: bool = True,
+        nsfw: bool = False,
         _wrapped_command: typing.Optional[tanjun.ExecutableCommand[typing.Any]] = None,
     ) -> None:
         ...
@@ -422,6 +437,7 @@ def __init__(
         default_to_ephemeral: typing.Optional[bool] = None,
         dm_enabled: typing.Optional[bool] = None,
         is_global: bool = True,
+        nsfw: bool = False,
         _wrapped_command: typing.Optional[tanjun.ExecutableCommand[typing.Any]] = None,
     ) -> None:
         """Initialise a user or message menu command.
@@ -475,6 +491,9 @@ def __init__(
             will be used.
         is_global
             Whether this command is a global command.
+        nsfw
+            Whether this command should only be accessible in channels marked as
+            nsfw.
 
         Returns
         -------
@@ -513,6 +532,7 @@ def __init__(
         self._defaults_to_ephemeral = default_to_ephemeral
         self._is_dm_enabled = dm_enabled
         self._is_global = is_global
+        self._is_nsfw = nsfw
         self._names = names
         self._parent: typing.Optional[tanjun.SlashCommandGroup] = None
         self._tracked_command: typing.Optional[hikari.ContextMenuCommand] = None
@@ -551,6 +571,11 @@ def is_global(self) -> bool:
         # <<inherited docstring from tanjun.abc.AppCommand>>.
         return self._is_global
 
+    @property
+    def is_nsfw(self) -> typing.Optional[bool]:
+        # <<inherited docstring from tanjun.abc.AppCommand>>.
+        return self._is_nsfw
+
     @property
     def name(self) -> str:
         # <<inherited docstring from tanjun.abc.AppCommand>>.
@@ -583,7 +608,10 @@ def wrapped_command(self) -> typing.Optional[tanjun.ExecutableCommand[typing.Any
     def build(self, *, component: typing.Optional[tanjun.Component] = None) -> hikari.api.ContextMenuCommandBuilder:
         # <<inherited docstring from tanjun.abc.MenuCommand>>.
         builder = hikari.impl.ContextMenuCommandBuilder(
-            type=self._type, name=self._names.default_value, name_localizations=self._names.localised_values
+            type=self._type,
+            name=self._names.default_value,
+            name_localizations=self._names.localised_values,
+            is_nsfw=self._is_nsfw,
         )
 
         component = component or self._component