Forms support (#531)

* Initial modals implementation You can already receive modals via the gateway and send modals via REST * Change the "DiscordComponent" model to multiple classes due to buttons and text inputs sharing the same field name * Canonical order * Use two ***DiscordComponents classes for everything * Rename the classes because it looks better this way * Revert core changes * Implement text input component classes in the core module * Fix TextInput component type deserialization * improve the interaction tree * More changes to the tree * remove unresolved references * add core events * Apply suggestions from code review Co-authored-by: Lukellmann <[email protected]> * change compontents top level to ActionRowBuilder Co-authored-by: Lukellmann <[email protected]> * refactor files * refactor interaction files * refactor response files * refactor followup messages * add TextInputComponent list retrival property * fix withStrategy return type * Apply suggestions from code review Co-authored-by: Lukellmann <[email protected]> * rename discord modal component to DiscordTextInputComponent * fix interaction response type * Forms support adjustments (#534) * return types * sealed InteractionResponseBehavior * ClosedRange<Int> instead of IntRange * rename file * GuildAutoCompleteInteraction is GuildInteraction (#535) * required is true by default for text inputs (#537) * rewrite a safer OptionValue implementation * Apply code review suggestions * Yeet out IntOptionValue * Fix interactions for forms feature (#538) * move MessageInteraction into Message * interactions * clarify why ComponentInteractionBehavior is no ModalParentInteractionBehavior * typo * rename ApplicationCommandInteractionInteractionCreateEvent to ApplicationCommandInteractionCreateEvent * move ResolvedObjects * attachments in InteractionCommand * fix InteractionCommand.filterOptions() * Entity in mentionables again * move duplicate code to InteractionCommand * ActionRowComponent docs * rename acknowledge * maps for components * cleanup and consider feedback in codereview * reintroduce CommandArgument convience methods Co-authored-by: MrPowerGamerBR <[email protected]> Co-authored-by: Lukellmann <[email protected]>
kordlib · Feb 20, 2022 · b4d77e0 · b4d77e0
1 parent d8960aa
commit b4d77e0
Show file tree

Hide file tree

Showing 75 changed files with 2,287 additions and 1,657 deletions.
diff --git a/common/src/main/kotlin/entity/DiscordComponent.kt b/common/src/main/kotlin/entity/DiscordComponent.kt
@@ -11,13 +11,17 @@ import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
 import kotlinx.serialization.descriptors.SerialDescriptor
 import kotlinx.serialization.encoding.Decoder
 import kotlinx.serialization.encoding.Encoder
+import kotlinx.serialization.json.JsonContentPolymorphicSerializer
+import kotlinx.serialization.json.JsonElement
+import kotlinx.serialization.json.intOrNull
+import kotlinx.serialization.json.jsonObject
+import kotlinx.serialization.json.jsonPrimitive
 
 /**
- * Represent a [intractable component within a message sent in Discord](https://discord.com/developers/docs/interactions/message-components#what-are-components).
+ * Represent a [interactable component within a message sent in Discord](https://discord.com/developers/docs/interactions/message-components#what-are-components).
  *
  * @property type the [ComponentType] of the component
  * @property style the [ButtonStyle] of the component (if it is a button)
- * @property style the text that appears on the button (if the component is a button)
  * @property emoji an [DiscordPartialEmoji] that appears on the button (if the component is a button)
  * @property customId a developer-defined identifier for the button, max 100 characters
  * @property url a url for link-style buttons
@@ -27,36 +31,103 @@ import kotlinx.serialization.encoding.Encoder
  * @property placeholder the placeholder text for the select menu
  * @property minValues the minimum amount of [options] allowed
  * @property maxValues the maximum amount of [options] allowed
+ * @property minLength the minimum input length for a text input, min 0, max 4000.
+ * @property maxLength the maximum input length for a text input, min 1, max 4000.
+ * @property required whether this component is required to be filled, default false.
+ * @property value a pre-filled value for this component, max 4000 characters.
  */
+@Serializable(with = DiscordComponent.Serializer::class)
+public sealed class DiscordComponent {
+    public abstract val type: ComponentType
+    public abstract val label: Optional<String>
+    public abstract val emoji: Optional<DiscordPartialEmoji>
+    @SerialName("custom_id")
+    public abstract val customId: Optional<String>
+    public abstract val url: Optional<String>
+    public abstract val disabled: OptionalBoolean
+    public abstract val components: Optional<List<DiscordComponent>>
+    public abstract val options: Optional<List<DiscordSelectOption>>
+    public abstract val placeholder: Optional<String>
+    @SerialName("min_values")
+    public abstract val minValues: OptionalInt
+    @SerialName("max_values")
+    public abstract val maxValues: OptionalInt
+    @SerialName("min_length")
+    public abstract val minLength: OptionalInt
+    @SerialName("max_length")
+    public abstract val maxLength: OptionalInt
+    public abstract val required: OptionalBoolean
+    public abstract val value: Optional<String>
+
+    internal object Serializer : JsonContentPolymorphicSerializer<DiscordComponent>(DiscordComponent::class) {
+        override fun selectDeserializer(element: JsonElement): KSerializer<out DiscordComponent> {
+            val componentType = element.jsonObject["type"]?.jsonPrimitive?.intOrNull ?: error("Missing component type ID!")
+
+            return when (componentType) {
+                ComponentType.TextInput.value -> DiscordTextInputComponent.serializer()
+                else -> DiscordChatComponent.serializer()
+            }
+        }
+    }
+}
+
+@Serializable
+public data class DiscordChatComponent(
+     override val type: ComponentType,
+     val style: Optional<ButtonStyle> = Optional.Missing(),
+     override val label: Optional<String> = Optional.Missing(),
+     override val emoji: Optional<DiscordPartialEmoji> = Optional.Missing(),
+    @SerialName("custom_id")
+     override val customId: Optional<String> = Optional.Missing(),
+     override val url: Optional<String> = Optional.Missing(),
+     override val disabled: OptionalBoolean = OptionalBoolean.Missing,
+     override val components: Optional<List<DiscordComponent>> = Optional.Missing(),
+     override val options: Optional<List<DiscordSelectOption>> = Optional.Missing(),
+     override val placeholder: Optional<String> = Optional.Missing(),
+    @SerialName("min_values")
+     override val minValues: OptionalInt = OptionalInt.Missing,
+    @SerialName("max_values")
+     override val maxValues: OptionalInt = OptionalInt.Missing,
+    @SerialName("min_length")
+     override val minLength: OptionalInt = OptionalInt.Missing,
+    @SerialName("max_length")
+     override val maxLength: OptionalInt = OptionalInt.Missing,
+     override val required: OptionalBoolean = OptionalBoolean.Missing,
+     override val value: Optional<String> = Optional.Missing()
+) : DiscordComponent()
 
 @Serializable
-public data class DiscordComponent(
-    val type: ComponentType,
-    val style: Optional<ButtonStyle> = Optional.Missing(),
-    val label: Optional<String> = Optional.Missing(),
-    val emoji: Optional<DiscordPartialEmoji> = Optional.Missing(),
+public data class DiscordTextInputComponent(
+     override val type: ComponentType,
+    public val style: Optional<TextInputStyle> = Optional.Missing(),
+     override val label: Optional<String> = Optional.Missing(),
+     override val emoji: Optional<DiscordPartialEmoji> = Optional.Missing(),
     @SerialName("custom_id")
-    val customId: Optional<String> = Optional.Missing(),
-    val url: Optional<String> = Optional.Missing(),
-    val disabled: OptionalBoolean = OptionalBoolean.Missing,
-    val components: Optional<List<DiscordComponent>> = Optional.Missing(),
-    val options: Optional<List<DiscordSelectOption>> = Optional.Missing(),
-    val placeholder: Optional<String> = Optional.Missing(),
+     override val customId: Optional<String> = Optional.Missing(),
+     override val url: Optional<String> = Optional.Missing(),
+     override val disabled: OptionalBoolean = OptionalBoolean.Missing,
+     override val components: Optional<List<DiscordComponent>> = Optional.Missing(),
+     override val options: Optional<List<DiscordSelectOption>> = Optional.Missing(),
+     override val placeholder: Optional<String> = Optional.Missing(),
     @SerialName("min_values")
-    val minValues: OptionalInt = OptionalInt.Missing,
+     override val minValues: OptionalInt = OptionalInt.Missing,
     @SerialName("max_values")
-    val maxValues: OptionalInt = OptionalInt.Missing,
-)
+     override val maxValues: OptionalInt = OptionalInt.Missing,
+    @SerialName("min_length")
+     override val minLength: OptionalInt = OptionalInt.Missing,
+    @SerialName("max_length")
+     override val maxLength: OptionalInt = OptionalInt.Missing,
+     override val required: OptionalBoolean = OptionalBoolean.Missing,
+     override val value: Optional<String> = Optional.Missing()
+) : DiscordComponent()
 
 /**
  * Representation of different [DiscordComponent] types.
  *
  * @property value the raw type value used by the Discord API
  */
-
 @Serializable(with = ComponentType.Serializer::class)
 public sealed class ComponentType(public val value: Int) {
-
     /**
      * Fallback type used for types that haven't been added to Kord yet.
      */
@@ -77,6 +148,11 @@ public sealed class ComponentType(public val value: Int) {
      */
     public object SelectMenu : ComponentType(3)
 
+    /**
+     * 	A text input object.
+     */
+    public object TextInput : ComponentType(4)
+
     public companion object Serializer : KSerializer<ComponentType> {
         override val descriptor: SerialDescriptor = PrimitiveSerialDescriptor("ComponentType", PrimitiveKind.INT)
 
@@ -85,6 +161,7 @@ public sealed class ComponentType(public val value: Int) {
                 1 -> ActionRow
                 2 -> Button
                 3 -> SelectMenu
+                4 -> TextInput
                 else -> Unknown(value)
             }
 
@@ -99,7 +176,6 @@ public sealed class ComponentType(public val value: Int) {
  *
  * @see ComponentType.Button
  */
-
 @Serializable(with = ButtonStyle.Serializer::class)
 public sealed class ButtonStyle(public val value: Int) {
 
@@ -139,7 +215,7 @@ public sealed class ButtonStyle(public val value: Int) {
     public object Link : ButtonStyle(5)
 
     public companion object Serializer : KSerializer<ButtonStyle> {
-        override val descriptor: SerialDescriptor = PrimitiveSerialDescriptor("ButtonStyle", PrimitiveKind.INT)
+        override val descriptor: SerialDescriptor = PrimitiveSerialDescriptor("Button", PrimitiveKind.INT)
 
         override fun deserialize(decoder: Decoder): ButtonStyle =
             when (val value = decoder.decodeInt()) {
@@ -154,3 +230,39 @@ public sealed class ButtonStyle(public val value: Int) {
         override fun serialize(encoder: Encoder, value: ButtonStyle): Unit = encoder.encodeInt(value.value)
     }
 }
+
+/**
+ * Representation of different TextInputStyles.
+ *
+ * @see ComponentType.TextInput
+ */
+@Serializable(with = TextInputStyle.Serializer::class)
+public sealed class TextInputStyle(public val value: Int) {
+    /**
+     * A fallback style used for styles that haven't been added to Kord yet.
+     */
+    public class Unknown(value: Int) : TextInputStyle(value)
+
+    /**
+     * A single-line input.
+     */
+    public object Short : TextInputStyle(1)
+
+    /**
+     * A multi-line input.
+     */
+    public object Paragraph : TextInputStyle(2)
+
+    internal companion object Serializer : KSerializer<TextInputStyle> {
+        override val descriptor: SerialDescriptor = PrimitiveSerialDescriptor("TextInput", PrimitiveKind.INT)
+
+        override fun deserialize(decoder: Decoder): TextInputStyle =
+            when (val value = decoder.decodeInt()) {
+                1 -> Short
+                2 -> Paragraph
+                else -> Unknown(value)
+            }
+
+        override fun serialize(encoder: Encoder, value: TextInputStyle): Unit = encoder.encodeInt(value.value)
+    }
+}
diff --git a/common/src/main/kotlin/entity/Interactions.kt b/common/src/main/kotlin/entity/Interactions.kt
@@ -257,13 +257,15 @@ public sealed class InteractionType(public val type: Int) {
     public object Component : InteractionType(3)
 
     public object AutoComplete : InteractionType(4)
+    public object ModalSubmit : InteractionType(5)
     public class Unknown(type: Int) : InteractionType(type)
 
     override fun toString(): String = when (this) {
         Ping -> "InteractionType.Ping($type)"
         ApplicationCommand -> "InteractionType.ApplicationCommand($type)"
         Component -> "InteractionType.ComponentInvoke($type)"
         AutoComplete -> "InteractionType.AutoComplete($type)"
+        ModalSubmit -> "InteractionType.ModalSubmit($type)"
         is Unknown -> "InteractionType.Unknown($type)"
     }
 
@@ -278,6 +280,7 @@ public sealed class InteractionType(public val type: Int) {
                 2 -> ApplicationCommand
                 3 -> Component
                 4 -> AutoComplete
+                5 -> ModalSubmit
                 else -> Unknown(type)
             }
         }
@@ -303,6 +306,7 @@ public data class InteractionCallbackData(
     @SerialName("component_type")
     val componentType: Optional<ComponentType> = Optional.Missing(),
     val values: Optional<List<String>> = Optional.Missing(),
+    val components: Optional<List<DiscordComponent>> = Optional.Missing()
 )
 
 @Serializable(with = Option.Serializer::class)
@@ -695,6 +699,7 @@ public sealed class InteractionResponseType(public val type: Int) {
     public object DeferredUpdateMessage : InteractionResponseType(6)
     public object UpdateMessage : InteractionResponseType(7)
     public object ApplicationCommandAutoCompleteResult : InteractionResponseType(8)
+    public object Modal : InteractionResponseType(9)
     public class Unknown(type: Int) : InteractionResponseType(type)
 
     internal object Serializer : KSerializer<InteractionResponseType> {
@@ -710,6 +715,7 @@ public sealed class InteractionResponseType(public val type: Int) {
                 6 -> DeferredUpdateMessage
                 7 -> UpdateMessage
                 8 -> ApplicationCommandAutoCompleteResult
+                9 -> Modal
                 else -> Unknown(type)
             }
         }
@@ -771,3 +777,11 @@ public data class DiscordGuildApplicationCommandPermission(
 public data class DiscordAutoComplete<T>(
     val choices: List<Choice<T>>
 )
+
+@Serializable
+public data class DiscordModal(
+    val title: String,
+    @SerialName("custom_id")
+    val customId: String,
+    val components: List<DiscordComponent>,
+)
diff --git a/core/src/main/kotlin/behavior/GuildInteractionBehavior.kt b/core/src/main/kotlin/behavior/GuildInteractionBehavior.kt