Implement default values for select menus.

See discord/discord-api-docs#6442.

Backend/Remora.Discord.API.Abstractions/API/Objects/Interactions/Components/SelectMenu/IChannelSelectComponent.cs

@@ -30,7 +30,7 @@ namespace Remora.Discord.API.Abstractions.Objects;
 /// Represents a dropdown of selectable channels.
 /// </summary>
 [PublicAPI]
-public interface IChannelSelectComponent : ISelectMenuComponent, IPartialChannelSelectComponent
+public interface IChannelSelectComponent : IMentionableSelectComponent, IPartialChannelSelectComponent
 {
     /// <summary>
     /// Gets the channel types to show on a <see cref="ComponentType.ChannelSelect"/> component.

Backend/Remora.Discord.API.Abstractions/API/Objects/Interactions/Components/SelectMenu/IMentionableSelectComponent.cs

@@ -20,7 +20,9 @@
 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 //
 
+using System.Collections.Generic;
 using JetBrains.Annotations;
+using Remora.Rest.Core;
 
 namespace Remora.Discord.API.Abstractions.Objects;
 
@@ -30,4 +32,12 @@ namespace Remora.Discord.API.Abstractions.Objects;
 [PublicAPI]
 public interface IMentionableSelectComponent : ISelectMenuComponent, IPartialMentionableSelectComponent
 {
+    /// <summary>
+    /// Gets the default values for auto-populated select menu components.
+    /// </summary>
+    new Optional<IReadOnlyList<ISelectDefaultValue>> DefaultValues { get; }
+
+    /// <inheritdoc/>
+    Optional<IReadOnlyList<IPartialSelectDefaultValue>> IPartialMentionableSelectComponent.DefaultValues
+        => this.DefaultValues.Map<IReadOnlyList<IPartialSelectDefaultValue>>(v => v);
 }

Backend/Remora.Discord.API.Abstractions/API/Objects/Interactions/Components/SelectMenu/IPartialChannelSelectComponent.cs

@@ -30,7 +30,7 @@ namespace Remora.Discord.API.Abstractions.Objects;
 /// Represents a partial dropdown of selectable channels.
 /// </summary>
 [PublicAPI]
-public interface IPartialChannelSelectComponent : IPartialSelectMenuComponent
+public interface IPartialChannelSelectComponent : IPartialMentionableSelectComponent
 {
     /// <inheritdoc cref="IChannelSelectComponent.ChannelTypes" />
     Optional<IReadOnlyList<ChannelType>> ChannelTypes { get; }

Backend/Remora.Discord.API.Abstractions/API/Objects/Interactions/Components/SelectMenu/IPartialMentionableSelectComponent.cs

@@ -20,14 +20,18 @@
 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 //
 
+using System.Collections.Generic;
 using JetBrains.Annotations;
+using Remora.Rest.Core;
 
 namespace Remora.Discord.API.Abstractions.Objects;
 
 /// <summary>
-/// Represents a partial dropdown of selectable mentionables (users and roles).
+/// Represents a partial dropdown of selectable mentionables (users, roles, and channels).
 /// </summary>
 [PublicAPI]
 public interface IPartialMentionableSelectComponent : IPartialSelectMenuComponent
 {
+    /// <inheritdoc cref="IMentionableSelectComponent.DefaultValues"/>
+    Optional<IReadOnlyList<IPartialSelectDefaultValue>> DefaultValues { get; }
 }

Backend/Remora.Discord.API.Abstractions/API/Objects/Interactions/Components/SelectMenu/IPartialRoleSelectComponent.cs

@@ -28,6 +28,6 @@ namespace Remora.Discord.API.Abstractions.Objects;
 /// Represents a partial dropdown of selectable roles.
 /// </summary>
 [PublicAPI]
-public interface IPartialRoleSelectComponent : IPartialSelectMenuComponent
+public interface IPartialRoleSelectComponent : IPartialMentionableSelectComponent
 {
 }

Backend/Remora.Discord.API.Abstractions/API/Objects/Interactions/Components/SelectMenu/IPartialSelectDefaultValue.cs

@@ -0,0 +1,37 @@
+//
+//  IPartialSelectDefaultValue.cs
+//
+//  Author:
+//       Jarl Gullberg <[email protected]>
+//
+//  Copyright (c) Jarl Gullberg
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU Lesser General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU Lesser General Public License for more details.
+//
+//  You should have received a copy of the GNU Lesser General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+using Remora.Rest.Core;
+
+namespace Remora.Discord.API.Abstractions.Objects;
+
+/// <summary>
+/// Represents a partial default value for a select menu.
+/// </summary>
+public interface IPartialSelectDefaultValue
+{
+    /// <inheritdoc cref="ISelectDefaultValue.ID"/>
+    Optional<Snowflake> ID { get; }
+
+    /// <inheritdoc cref="ISelectDefaultValue.Type"/>
+    Optional<string> Type { get; }
+}

Backend/Remora.Discord.API.Abstractions/API/Objects/Interactions/Components/SelectMenu/IPartialUserSelectComponent.cs

@@ -28,6 +28,6 @@ namespace Remora.Discord.API.Abstractions.Objects;
 /// Represents a partial dropdown of selectable users.
 /// </summary>
 [PublicAPI]
-public interface IPartialUserSelectComponent : IPartialSelectMenuComponent
+public interface IPartialUserSelectComponent : IPartialMentionableSelectComponent
 {
 }

Backend/Remora.Discord.API.Abstractions/API/Objects/Interactions/Components/SelectMenu/IRoleSelectComponent.cs

@@ -28,6 +28,6 @@ namespace Remora.Discord.API.Abstractions.Objects;
 /// Represents a dropdown of selectable roles.
 /// </summary>
 [PublicAPI]
-public interface IRoleSelectComponent : ISelectMenuComponent, IPartialRoleSelectComponent
+public interface IRoleSelectComponent : IMentionableSelectComponent, IPartialRoleSelectComponent
 {
 }

Backend/Remora.Discord.API.Abstractions/API/Objects/Interactions/Components/SelectMenu/ISelectDefaultValue.cs

@@ -0,0 +1,47 @@
+//
+//  ISelectDefaultValue.cs
+//
+//  Author:
+//       Jarl Gullberg <[email protected]>
+//
+//  Copyright (c) Jarl Gullberg
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU Lesser General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU Lesser General Public License for more details.
+//
+//  You should have received a copy of the GNU Lesser General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+using Remora.Rest.Core;
+
+namespace Remora.Discord.API.Abstractions.Objects;
+
+/// <summary>
+/// Represents a default value for a select menu.
+/// </summary>
+public interface ISelectDefaultValue : IPartialSelectDefaultValue
+{
+    /// <summary>
+    /// Gets the ID of the default entity (user, role, or channel).
+    /// </summary>
+    new Snowflake ID { get; }
+
+    /// <summary>
+    /// Gets the type of value that <see cref="ID"/> represents. Can be one of "user", "role", or "channel".
+    /// </summary>
+    new string Type { get; }
+
+    /// <inheritdoc/>
+    Optional<Snowflake> IPartialSelectDefaultValue.ID => this.ID;
+
+    /// <inheritdoc/>
+    Optional<string> IPartialSelectDefaultValue.Type => this.Type;
+}

Backend/Remora.Discord.API.Abstractions/API/Objects/Interactions/Components/SelectMenu/IUserSelectComponent.cs

@@ -28,6 +28,6 @@ namespace Remora.Discord.API.Abstractions.Objects;
 /// Represents a dropdown of selectable users.
 /// </summary>
 [PublicAPI]
-public interface IUserSelectComponent : ISelectMenuComponent, IPartialUserSelectComponent
+public interface IUserSelectComponent : IMentionableSelectComponent, IPartialUserSelectComponent
 {
 }

Backend/Remora.Discord.API/API/Objects/Interactions/Components/SelectMenu/ChannelSelectComponent.cs

@@ -36,7 +36,8 @@ public record ChannelSelectComponent
     Optional<string> Placeholder = default,
     Optional<int> MinValues = default,
     Optional<int> MaxValues = default,
-    Optional<bool> IsDisabled = default
+    Optional<bool> IsDisabled = default,
+    Optional<IReadOnlyList<ISelectDefaultValue>> DefaultValues = default
 ) : IChannelSelectComponent
 {
     /// <inheritdoc />

Backend/Remora.Discord.API/API/Objects/Interactions/Components/SelectMenu/MentionableSelectComponent.cs

@@ -20,6 +20,7 @@
 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 //
 
+using System.Collections.Generic;
 using JetBrains.Annotations;
 using Remora.Discord.API.Abstractions.Objects;
 using Remora.Rest.Core;
@@ -34,7 +35,8 @@ public record MentionableSelectComponent
     Optional<string> Placeholder = default,
     Optional<int> MinValues = default,
     Optional<int> MaxValues = default,
-    Optional<bool> IsDisabled = default
+    Optional<bool> IsDisabled = default,
+    Optional<IReadOnlyList<ISelectDefaultValue>> DefaultValues = default
 ) : IMentionableSelectComponent
 {
     /// <inheritdoc />

Backend/Remora.Discord.API/API/Objects/Interactions/Components/SelectMenu/PartialChannelSelectComponent.cs

@@ -36,7 +36,8 @@ public record PartialChannelSelectComponent
     Optional<string> Placeholder = default,
     Optional<int> MinValues = default,
     Optional<int> MaxValues = default,
-    Optional<bool> IsDisabled = default
+    Optional<bool> IsDisabled = default,
+    Optional<IReadOnlyList<IPartialSelectDefaultValue>> DefaultValues = default
 ) : IPartialChannelSelectComponent
 {
     /// <inheritdoc />

Backend/Remora.Discord.API/API/Objects/Interactions/Components/SelectMenu/PartialMentionableSelectComponent.cs

@@ -20,6 +20,7 @@
 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 //
 
+using System.Collections.Generic;
 using JetBrains.Annotations;
 using Remora.Discord.API.Abstractions.Objects;
 using Remora.Rest.Core;
@@ -34,7 +35,8 @@ public record PartialMentionableSelectComponent
     Optional<string> Placeholder = default,
     Optional<int> MinValues = default,
     Optional<int> MaxValues = default,
-    Optional<bool> IsDisabled = default
+    Optional<bool> IsDisabled = default,
+    Optional<IReadOnlyList<IPartialSelectDefaultValue>> DefaultValues = default
 ) : IPartialMentionableSelectComponent
 {
     /// <inheritdoc />

Backend/Remora.Discord.API/API/Objects/Interactions/Components/SelectMenu/PartialRoleSelectComponent.cs

@@ -20,6 +20,7 @@
 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 //
 
+using System.Collections.Generic;
 using JetBrains.Annotations;
 using Remora.Discord.API.Abstractions.Objects;
 using Remora.Rest.Core;
@@ -34,7 +35,8 @@ public record PartialRoleSelectComponent
     Optional<string> Placeholder = default,
     Optional<int> MinValues = default,
     Optional<int> MaxValues = default,
-    Optional<bool> IsDisabled = default
+    Optional<bool> IsDisabled = default,
+    Optional<IReadOnlyList<IPartialSelectDefaultValue>> DefaultValues = default
 ) : IPartialRoleSelectComponent
 {
     /// <inheritdoc />

Backend/Remora.Discord.API/API/Objects/Interactions/Components/SelectMenu/PartialUserSelectComponent.cs

@@ -20,6 +20,7 @@
 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 //
 
+using System.Collections.Generic;
 using JetBrains.Annotations;
 using Remora.Discord.API.Abstractions.Objects;
 using Remora.Rest.Core;
@@ -34,7 +35,8 @@ public record PartialUserSelectComponent
     Optional<string> Placeholder = default,
     Optional<int> MinValues = default,
     Optional<int> MaxValues = default,
-    Optional<bool> IsDisabled = default
+    Optional<bool> IsDisabled = default,
+    Optional<IReadOnlyList<IPartialSelectDefaultValue>> DefaultValues = default
 ) : IPartialUserSelectComponent
 {
     /// <inheritdoc />

Backend/Remora.Discord.API/API/Objects/Interactions/Components/SelectMenu/RoleSelectComponent.cs

@@ -20,6 +20,7 @@
 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 //
 
+using System.Collections.Generic;
 using JetBrains.Annotations;
 using Remora.Discord.API.Abstractions.Objects;
 using Remora.Rest.Core;
@@ -34,7 +35,8 @@ public record RoleSelectComponent
     Optional<string> Placeholder = default,
     Optional<int> MinValues = default,
     Optional<int> MaxValues = default,
-    Optional<bool> IsDisabled = default
+    Optional<bool> IsDisabled = default,
+    Optional<IReadOnlyList<ISelectDefaultValue>> DefaultValues = default
 ) : IRoleSelectComponent
 {
     /// <inheritdoc />

Backend/Remora.Discord.API/API/Objects/Interactions/Components/SelectMenu/SelectDefaultValue.cs

@@ -0,0 +1,29 @@
+//
+//  SelectDefaultValue.cs
+//
+//  Author:
+//       Jarl Gullberg <[email protected]>
+//
+//  Copyright (c) Jarl Gullberg
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU Lesser General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU Lesser General Public License for more details.
+//
+//  You should have received a copy of the GNU Lesser General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+using Remora.Discord.API.Abstractions.Objects;
+using Remora.Rest.Core;
+
+namespace Remora.Discord.API.Objects;
+
+/// <inheritdoc />
+public record SelectDefaultValue(Snowflake ID, string Type) : ISelectDefaultValue;

Backend/Remora.Discord.API/API/Objects/Interactions/Components/SelectMenu/UserSelectComponent.cs

@@ -20,6 +20,7 @@
 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 //
 
+using System.Collections.Generic;
 using JetBrains.Annotations;
 using Remora.Discord.API.Abstractions.Objects;
 using Remora.Rest.Core;
@@ -34,7 +35,8 @@ public record UserSelectComponent
     Optional<string> Placeholder = default,
     Optional<int> MinValues = default,
     Optional<int> MaxValues = default,
-    Optional<bool> IsDisabled = default
+    Optional<bool> IsDisabled = default,
+    Optional<IReadOnlyList<ISelectDefaultValue>> DefaultValues = default
 ) : IUserSelectComponent
 {
     /// <inheritdoc />

Backend/Remora.Discord.API/Extensions/ServiceCollectionExtensions.cs

@@ -1167,6 +1167,8 @@ private static JsonSerializerOptions AddInteractionObjectConverters(this JsonSer
         options.AddDataObjectConverter<IPartialSelectOption, PartialSelectOption>()
             .WithPropertyName(o => o.IsDefault, "default");
 
+        options.AddDataObjectConverter<ISelectDefaultValue, SelectDefaultValue>();
+
         return options;
     }
 

Backend/Remora.Discord.API/Json/Converters/Internal/MessageComponentConverter.cs

@@ -124,14 +124,14 @@ public override void Write(Utf8JsonWriter writer, IMessageComponent value, JsonS
                 JsonSerializer.Serialize(writer, roleSelect, options);
                 break;
             }
-            case IMentionableSelectComponent mentionableSelect:
+            case IChannelSelectComponent channelSelect:
             {
-                JsonSerializer.Serialize(writer, mentionableSelect, options);
+                JsonSerializer.Serialize(writer, channelSelect, options);
                 break;
             }
-            case IChannelSelectComponent channelSelect:
+            case IMentionableSelectComponent mentionableSelect:
             {
-                JsonSerializer.Serialize(writer, channelSelect, options);
+                JsonSerializer.Serialize(writer, mentionableSelect, options);
                 break;
             }
             default:

Backend/Remora.Discord.API/Json/Converters/Internal/PartialMessageComponentConverter.cs

@@ -124,14 +124,14 @@ public override void Write(Utf8JsonWriter writer, IPartialMessageComponent value
                 JsonSerializer.Serialize(writer, roleSelect, options);
                 break;
             }
-            case IPartialMentionableSelectComponent mentionableSelect:
+            case IPartialChannelSelectComponent channelSelect:
             {
-                JsonSerializer.Serialize(writer, mentionableSelect, options);
+                JsonSerializer.Serialize(writer, channelSelect, options);
                 break;
             }
-            case IPartialChannelSelectComponent channelSelect:
+            case IPartialMentionableSelectComponent mentionableSelect:
             {
-                JsonSerializer.Serialize(writer, channelSelect, options);
+                JsonSerializer.Serialize(writer, mentionableSelect, options);
                 break;
             }
             default:

Tests/Remora.Discord.Tests/Samples/Objects/MESSAGE_COMPONENT/CHANNEL_SELECT_COMPONENT.json

@@ -8,5 +8,11 @@
   "placeholder": "none",
   "min_values": 1,
   "max_values": 3,
-  "disabled": true
+  "disabled": true,
+  "default_values": [
+    {
+      "id": "999999999999999999",
+      "type": "channel"
+    }
+  ]
 }