feat: add sort order for forums (#1488)

* feat: add forum sort order

* feat: cache layout and sort order for forums

Author: LordOfPolls

interactions/__init__.py

@@ -339,6 +339,7 @@
     ExponentialBackoffSystem,
     LeakyBucketSystem,
     TokenBucketSystem,
+    ForumSortOrder,
 )
 from .api import events
 from . import ext
@@ -460,6 +461,7 @@
     "File",
     "FlatUIColors",
     "FlatUIColours",
+    "ForumSortOrder",
     "ForumLayoutType",
     "get_components_ids",
     "get_logger",

interactions/models/__init__.py

@@ -187,6 +187,7 @@
     WebhookMixin,
     WebhookTypes,
     WebSocketOPCode,
+    ForumSortOrder,
 )
 from .internal import (
     ActiveVoiceState,
@@ -398,6 +399,7 @@
     "File",
     "FlatUIColors",
     "FlatUIColours",
+    "ForumSortOrder",
     "ForumLayoutType",
     "get_components_ids",
     "global_autocomplete",

interactions/models/discord/__init__.py

@@ -114,6 +114,7 @@
     VerificationLevel,
     VideoQualityMode,
     WebSocketOPCode,
+    ForumSortOrder,
 )
 from .file import File, open_file, UPLOADABLE_TYPE
 from .guild import (
@@ -226,6 +227,7 @@
     "File",
     "FlatUIColors",
     "FlatUIColours",
+    "ForumSortOrder",
     "ForumLayoutType",
     "get_components_ids",
     "Guild",

interactions/models/discord/channel.py

@@ -36,6 +36,8 @@
     StagePrivacyLevel,
     MessageFlags,
     InviteTargetType,
+    ForumSortOrder,
+    ForumLayoutType,
 )
 
 if TYPE_CHECKING:
@@ -2394,6 +2396,14 @@ class GuildForum(GuildChannel):
     """The default emoji to react with for posts"""
     last_message_id: Optional[Snowflake_Type] = attrs.field(repr=False, default=None)
     # TODO: Implement "template" once the API supports them
+    default_sort_order: Optional[ForumSortOrder] = attrs.field(
+        repr=False, default=None, converter=ForumSortOrder.converter
+    )
+    """the default sort order type used to order posts in GUILD_FORUM channels. Defaults to null, which indicates a preferred sort order hasn't been set by a channel admin"""
+    default_forum_layout: ForumLayoutType = attrs.field(
+        repr=False, default=ForumLayoutType.NOT_SET, converter=ForumLayoutType
+    )
+    """The default forum layout view used to display posts in GUILD_FORUM channels. Defaults to 0, which indicates a layout view has not been set by a channel admin"""
 
     @classmethod
     def _process_dict(cls, data: Dict[str, Any], client: "Client") -> Dict[str, Any]:

interactions/models/discord/enums.py

@@ -1,7 +1,7 @@
 from enum import Enum, EnumMeta, IntEnum, IntFlag
 from functools import reduce
 from operator import or_
-from typing import Iterator, Tuple, TypeVar, Type
+from typing import Iterator, Tuple, TypeVar, Type, Optional
 
 from interactions.client.const import get_logger
 
@@ -19,6 +19,7 @@
     "DefaultNotificationLevel",
     "ExplicitContentFilterLevel",
     "ForumLayoutType",
+    "ForumSortOrder",
     "IntegrationExpireBehaviour",
     "Intents",
     "InteractionPermissionTypes",
@@ -1046,3 +1047,14 @@ class ForumLayoutType(CursedIntEnum):
     NOT_SET = 0
     LIST = 1
     GALLERY = 2
+
+
+class ForumSortOrder(CursedIntEnum):
+    """The order of a forum channel."""
+
+    LATEST_ACTIVITY = 0
+    CREATION_DATE = 1
+
+    @classmethod
+    def converter(cls, value: Optional[int]) -> "ForumSortOrder":
+        return None if value is None else cls(value)

interactions/models/discord/guild.py

@@ -41,6 +41,7 @@
     ScheduledEventType,
     SystemChannelFlags,
     VerificationLevel,
+    ForumSortOrder,
 )
 from .snowflake import (
     Snowflake_Type,
@@ -1023,6 +1024,7 @@ async def create_forum_channel(
         default_reaction_emoji: Absent[Union[dict, "models.PartialEmoji", "models.DefaultReaction", str]] = MISSING,
         available_tags: Absent["list[dict | models.ThreadTag] | dict | models.ThreadTag"] = MISSING,
         layout: ForumLayoutType = ForumLayoutType.NOT_SET,
+        sort_order: Absent[ForumSortOrder] = MISSING,
         reason: Absent[Optional[str]] = MISSING,
     ) -> "models.GuildForum":
         """
@@ -1039,6 +1041,7 @@ async def create_forum_channel(
             default_reaction_emoji: The default emoji to react with when creating a thread
             available_tags: The available tags for this forum channel
             layout: The layout of the forum channel
+            sort_order: The sort order of the forum channel
             reason: The reason for creating this channel
 
         Returns:
@@ -1057,6 +1060,7 @@ async def create_forum_channel(
             default_reaction_emoji=models.process_default_reaction(default_reaction_emoji),
             available_tags=list_converter(models.process_thread_tag)(available_tags) if available_tags else MISSING,
             default_forum_layout=layout,
+            default_sort_order=sort_order,
             reason=reason,
         )