add named files and attachments (#379)

* add named files and attachments * add a conversion method from core attachments to common structure * use data since it has identical structure
kordlib · Sep 5, 2021 · a9f36c0 · a9f36c0
1 parent 3c31bbd
commit a9f36c0
Show file tree

Hide file tree

Showing 21 changed files with 124 additions and 69 deletions.
diff --git a/core/src/main/kotlin/entity/Attachment.kt b/core/src/main/kotlin/entity/Attachment.kt
@@ -1,6 +1,8 @@
 package dev.kord.core.entity
 
+import dev.kord.common.entity.DiscordAttachment
 import dev.kord.common.entity.Snowflake
+import dev.kord.common.entity.optional.optionalInt
 import dev.kord.common.entity.optional.value
 import dev.kord.core.Kord
 import dev.kord.core.cache.data.AttachmentData
@@ -67,4 +69,10 @@ data class Attachment(val data: AttachmentData, override val kord: Kord) : KordE
         return "Attachment(data=$data, kord=$kord)"
     }
 
+}
+
+fun Attachment.toRawType(): DiscordAttachment {
+    with(data) {
+        return DiscordAttachment(id, filename, size, url, proxyUrl, height, width)
+    }
 }
diff --git a/rest/src/main/kotlin/NamedFile.kt b/rest/src/main/kotlin/NamedFile.kt
@@ -0,0 +1,12 @@
+package dev.kord.rest
+
+import java.io.InputStream
+
+class NamedFile(val name: String, val inputStream: InputStream) {
+
+    val url: String get() = "attachment://$name"
+
+    operator fun component1() = name
+    operator fun component2() = inputStream
+    operator fun component3() = url
+}
diff --git a/rest/src/main/kotlin/builder/message/create/PersistentMessageCreateBuilder.kt b/rest/src/main/kotlin/builder/message/create/PersistentMessageCreateBuilder.kt
@@ -1,5 +1,6 @@
 package dev.kord.rest.builder.message.create
 
+import dev.kord.rest.NamedFile
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.withContext
 import java.io.InputStream
@@ -14,13 +15,13 @@ interface PersistentMessageCreateBuilder : MessageCreateBuilder {
     /**
      * The files to include as attachments.
      */
-    val files: MutableList<Pair<String, InputStream>>
+    val files: MutableList<NamedFile>
 
     /**
      * Adds a file with the [name] and [content] to the attachments.
      */
     fun addFile(name: String, content: InputStream) {
-        files += name to content
+        files += NamedFile(name, content)
     }
 
     /**

diff --git a/rest/src/main/kotlin/builder/message/create/PublicFollowupMessageCreateBuilder.kt b/rest/src/main/kotlin/builder/message/create/PublicFollowupMessageCreateBuilder.kt
@@ -2,6 +2,7 @@ package dev.kord.rest.builder.message.create
 
 import dev.kord.common.annotation.KordPreview
 import dev.kord.common.entity.optional.*
+import dev.kord.rest.NamedFile
 import dev.kord.rest.builder.RequestBuilder
 import dev.kord.rest.builder.component.MessageComponentBuilder
 import dev.kord.rest.builder.message.AllowedMentionsBuilder
@@ -30,7 +31,7 @@ class PublicFollowupMessageCreateBuilder
 
     override val components: MutableList<MessageComponentBuilder> = mutableListOf()
 
-    override val files: MutableList<Pair<String, InputStream>> = mutableListOf()
+    override val files: MutableList<NamedFile> = mutableListOf()
 
     override fun toRequest(): MultipartFollowupMessageCreateRequest {
         return MultipartFollowupMessageCreateRequest(
@@ -41,7 +42,7 @@ class PublicFollowupMessageCreateBuilder
                 allowedMentions = Optional(allowedMentions).coerceToMissing().map { it.build() },
                 components = Optional(components).coerceToMissing().mapList { it.build() },
             ),
-            Optional(files)
+            files
         )
     }
 

diff --git a/rest/src/main/kotlin/builder/message/create/PublicInteractionCreateBuilder.kt b/rest/src/main/kotlin/builder/message/create/PublicInteractionCreateBuilder.kt
@@ -3,6 +3,7 @@ package dev.kord.rest.builder.message.create
 import dev.kord.common.annotation.KordPreview
 import dev.kord.common.entity.InteractionResponseType
 import dev.kord.common.entity.optional.*
+import dev.kord.rest.NamedFile
 import dev.kord.rest.builder.RequestBuilder
 import dev.kord.rest.builder.component.MessageComponentBuilder
 import dev.kord.rest.builder.message.AllowedMentionsBuilder
@@ -31,7 +32,7 @@ class PublicInteractionResponseCreateBuilder
 
     override val components: MutableList<MessageComponentBuilder> = mutableListOf()
 
-    override val files: MutableList<Pair<String, InputStream>> = mutableListOf()
+    override val files: MutableList<NamedFile> = mutableListOf()
 
     override fun toRequest(): MultipartInteractionResponseCreateRequest {
         return MultipartInteractionResponseCreateRequest(

diff --git a/rest/src/main/kotlin/builder/message/create/UserMessageCreateBuilder.kt b/rest/src/main/kotlin/builder/message/create/UserMessageCreateBuilder.kt
@@ -4,6 +4,7 @@ import dev.kord.common.annotation.KordPreview
 import dev.kord.common.entity.DiscordMessageReference
 import dev.kord.common.entity.Snowflake
 import dev.kord.common.entity.optional.*
+import dev.kord.rest.NamedFile
 import dev.kord.rest.builder.RequestBuilder
 import dev.kord.rest.builder.component.MessageComponentBuilder
 import dev.kord.rest.builder.message.AllowedMentionsBuilder
@@ -50,7 +51,7 @@ class UserMessageCreateBuilder
      */
     var failIfNotExists: Boolean? = null
 
-    override val files: MutableList<Pair<String, InputStream>> = mutableListOf()
+    override val files: MutableList<NamedFile> = mutableListOf()
 
     @OptIn(KordPreview::class)
     override fun toRequest(): MultipartMessageCreateRequest {

diff --git a/rest/src/main/kotlin/builder/message/create/WebhookMessageCreateBuilder.kt b/rest/src/main/kotlin/builder/message/create/WebhookMessageCreateBuilder.kt
@@ -2,6 +2,7 @@ package dev.kord.rest.builder.message.create
 
 import dev.kord.common.annotation.KordPreview
 import dev.kord.common.entity.optional.*
+import dev.kord.rest.NamedFile
 import dev.kord.rest.builder.RequestBuilder
 import dev.kord.rest.builder.component.MessageComponentBuilder
 import dev.kord.rest.builder.message.AllowedMentionsBuilder
@@ -32,7 +33,7 @@ class WebhookMessageCreateBuilder
 
     override val components: MutableList<MessageComponentBuilder> = mutableListOf()
 
-    override val files: MutableList<Pair<String, InputStream>> = mutableListOf()
+    override val files: MutableList<NamedFile> = mutableListOf()
 
     @OptIn(KordPreview::class)
     override fun toRequest(): MultiPartWebhookExecuteRequest {

diff --git a/rest/src/main/kotlin/builder/message/modify/EphemeralInteractionResponseModifyBuilder.kt b/rest/src/main/kotlin/builder/message/modify/EphemeralInteractionResponseModifyBuilder.kt
@@ -1,6 +1,5 @@
 package dev.kord.rest.builder.message.modify
 
-import dev.kord.common.annotation.KordPreview
 import dev.kord.common.entity.MessageFlag
 import dev.kord.common.entity.MessageFlags
 import dev.kord.common.entity.optional.Optional
@@ -36,10 +35,11 @@ class EphemeralInteractionResponseModifyBuilder
         return MultipartInteractionResponseModifyRequest(
             InteractionResponseModifyRequest(
                 content = state.content,
+                embeds = state.embeds.mapList { it.toRequest() },
                 allowedMentions = state.allowedMentions.map { it.build() },
+                flags = Optional(MessageFlags(MessageFlag.Ephemeral)),
                 components = state.components.mapList { it.build() },
-                embeds = state.embeds.mapList { it.toRequest() },
-                flags = Optional(MessageFlags(MessageFlag.Ephemeral))
+                attachments = state.attachments
             )
         )
     }

diff --git a/rest/src/main/kotlin/builder/message/modify/MessageModifyStateHolder.kt b/rest/src/main/kotlin/builder/message/modify/MessageModifyStateHolder.kt
@@ -1,8 +1,10 @@
 package dev.kord.rest.builder.message.modify
 
 import dev.kord.common.annotation.KordPreview
+import dev.kord.common.entity.DiscordAttachment
 import dev.kord.common.entity.MessageFlags
 import dev.kord.common.entity.optional.Optional
+import dev.kord.rest.NamedFile
 import dev.kord.rest.builder.component.MessageComponentBuilder
 import dev.kord.rest.builder.message.AllowedMentionsBuilder
 import dev.kord.rest.builder.message.EmbedBuilder
@@ -14,7 +16,7 @@ import java.io.InputStream
  */
 internal class MessageModifyStateHolder {
 
-    var files: Optional<MutableList<Pair<String, InputStream>>> = Optional.Missing()
+    var files: Optional<MutableList<NamedFile>> = Optional.Missing()
 
     var content: Optional<String?> = Optional.Missing()
 
@@ -24,6 +26,7 @@ internal class MessageModifyStateHolder {
 
     var allowedMentions: Optional<AllowedMentionsBuilder> = Optional.Missing()
 
+    var attachments: Optional<MutableList<DiscordAttachment>> = Optional.Missing()
 
     var components: Optional<MutableList<MessageComponentBuilder>> = Optional.Missing()
 

diff --git a/rest/src/main/kotlin/builder/message/modify/PersistentMessageModifyBuilder.kt b/rest/src/main/kotlin/builder/message/modify/PersistentMessageModifyBuilder.kt
@@ -1,5 +1,7 @@
 package dev.kord.rest.builder.message.modify
 
+import dev.kord.common.entity.DiscordAttachment
+import dev.kord.rest.NamedFile
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.withContext
 import java.io.InputStream
@@ -14,11 +16,13 @@ interface PersistentMessageModifyBuilder : MessageModifyBuilder {
     /**
      * The files to include as attachments
      */
-    var files: MutableList<Pair<String, InputStream>>?
+    var files: MutableList<NamedFile>?
+
+    var attachments: MutableList<DiscordAttachment>?
 
     fun addFile(name: String, content: InputStream) {
         files = (files ?: mutableListOf()).also {
-            it.add(name to content)
+            it.add(NamedFile(name, content))
         }
     }
 

diff --git a/rest/src/main/kotlin/builder/message/modify/PublicFollowupMessageModifyBuilder.kt b/rest/src/main/kotlin/builder/message/modify/PublicFollowupMessageModifyBuilder.kt
@@ -1,11 +1,13 @@
 package dev.kord.rest.builder.message.modify
 
 import dev.kord.common.annotation.KordPreview
+import dev.kord.common.entity.DiscordAttachment
 import dev.kord.common.entity.optional.Optional
 import dev.kord.common.entity.optional.coerceToMissing
 import dev.kord.common.entity.optional.delegate.delegate
 import dev.kord.common.entity.optional.map
 import dev.kord.common.entity.optional.mapList
+import dev.kord.rest.NamedFile
 import dev.kord.rest.builder.RequestBuilder
 import dev.kord.rest.builder.component.MessageComponentBuilder
 import dev.kord.rest.builder.message.AllowedMentionsBuilder
@@ -21,7 +23,9 @@ class PublicFollowupMessageModifyBuilder
 
     private var state = MessageModifyStateHolder()
 
-    override var files: MutableList<Pair<String, InputStream>>? by state::files.delegate()
+    override var files: MutableList<NamedFile>? by state::files.delegate()
+
+    override var attachments: MutableList<DiscordAttachment>? by state::attachments.delegate()
 
     override var content: String? by state::content.delegate()
 
@@ -38,7 +42,8 @@ class PublicFollowupMessageModifyBuilder
                 content = state.content,
                 embeds = state.embeds.mapList { it.toRequest() },
                 allowedMentions = state.allowedMentions.map { it.build() },
-                components = Optional(components).coerceToMissing().mapList { it.build() },
+                components = state.components.mapList { it.build() },
+                attachments = state.attachments
             ),
             state.files
         )

diff --git a/rest/src/main/kotlin/builder/message/modify/PublicInteractionResponseModifyBuilder.kt b/rest/src/main/kotlin/builder/message/modify/PublicInteractionResponseModifyBuilder.kt
@@ -1,18 +1,18 @@
 package dev.kord.rest.builder.message.modify
 
-import dev.kord.common.annotation.KordPreview
+import dev.kord.common.entity.DiscordAttachment
 import dev.kord.common.entity.optional.Optional
 import dev.kord.common.entity.optional.coerceToMissing
 import dev.kord.common.entity.optional.delegate.delegate
 import dev.kord.common.entity.optional.map
 import dev.kord.common.entity.optional.mapList
+import dev.kord.rest.NamedFile
 import dev.kord.rest.builder.RequestBuilder
 import dev.kord.rest.builder.component.MessageComponentBuilder
 import dev.kord.rest.builder.message.AllowedMentionsBuilder
 import dev.kord.rest.builder.message.EmbedBuilder
 import dev.kord.rest.json.request.InteractionResponseModifyRequest
 import dev.kord.rest.json.request.MultipartInteractionResponseModifyRequest
-import java.io.InputStream
 
 
 class PublicInteractionResponseModifyBuilder
@@ -21,7 +21,9 @@ class PublicInteractionResponseModifyBuilder
 
     private var state = MessageModifyStateHolder()
 
-    override var files: MutableList<Pair<String, InputStream>>? by state::files.delegate()
+    override var files: MutableList<NamedFile>? by state::files.delegate()
+
+    override var attachments: MutableList<DiscordAttachment>? by state::attachments.delegate()
 
     override var content: String? by state::content.delegate()
 
@@ -38,7 +40,8 @@ class PublicInteractionResponseModifyBuilder
                 content = state.content,
                 embeds = state.embeds.mapList { it.toRequest() },
                 allowedMentions = state.allowedMentions.map { it.build() },
-                components = Optional(components).coerceToMissing().mapList { it.build() },
+                components = state.components.mapList { it.build() },
+                attachments = state.attachments
             ),
             state.files
         )

diff --git a/...main/kotlin/builder/message/modify/UpdatePublicMessageInteractionResponseCreateBuilder.kt b/...main/kotlin/builder/message/modify/UpdatePublicMessageInteractionResponseCreateBuilder.kt
@@ -1,51 +1,49 @@
 package dev.kord.rest.builder.message.modify
 
-import dev.kord.common.annotation.KordPreview
 import dev.kord.common.entity.InteractionResponseType
-import dev.kord.common.entity.MessageFlags
-import dev.kord.common.entity.optional.coerceToMissing
+import dev.kord.common.entity.optional.*
 import dev.kord.common.entity.optional.delegate.delegate
-import dev.kord.common.entity.optional.map
-import dev.kord.common.entity.optional.mapList
-import dev.kord.common.entity.optional.optional
+import dev.kord.rest.NamedFile
 import dev.kord.rest.builder.RequestBuilder
 import dev.kord.rest.builder.component.MessageComponentBuilder
 import dev.kord.rest.builder.message.AllowedMentionsBuilder
 import dev.kord.rest.builder.message.EmbedBuilder
+import dev.kord.rest.builder.message.create.PersistentMessageCreateBuilder
 import dev.kord.rest.json.request.InteractionApplicationCommandCallbackData
 import dev.kord.rest.json.request.InteractionResponseCreateRequest
 import dev.kord.rest.json.request.MultipartInteractionResponseCreateRequest
-import java.io.InputStream
 
 
 class UpdatePublicMessageInteractionResponseCreateBuilder :
-    PersistentMessageModifyBuilder,
+    PersistentMessageCreateBuilder,
     RequestBuilder<MultipartInteractionResponseCreateRequest> {
 
-    private var state = MessageModifyStateHolder()
 
-    override var files: MutableList<Pair<String, InputStream>>? by state::files.delegate()
+    override var files: MutableList<NamedFile> = mutableListOf()
 
-    override var content: String? by state::content.delegate()
+    override var content: String? = null
 
-    override var embeds: MutableList<EmbedBuilder>? by state::embeds.delegate()
+    override var tts: Boolean? = null
 
-    override var allowedMentions: AllowedMentionsBuilder? by state::allowedMentions.delegate()
+    override var embeds: MutableList<EmbedBuilder> = mutableListOf()
 
-    override var components: MutableList<MessageComponentBuilder>? by state::components.delegate()
+    override var allowedMentions: AllowedMentionsBuilder? = null
+
+    override var components: MutableList<MessageComponentBuilder> = mutableListOf()
 
     override fun toRequest(): MultipartInteractionResponseCreateRequest {
         return MultipartInteractionResponseCreateRequest(
             InteractionResponseCreateRequest(
                 InteractionResponseType.UpdateMessage,
                 InteractionApplicationCommandCallbackData(
-                    content = state.content,
-                    embeds = state.embeds.mapList { it.toRequest() },
-                    allowedMentions = state.allowedMentions.map { it.build() },
-                    components = state.components.mapList { it.build() }
+                    content = Optional(content).coerceToMissing(),
+                    embeds = Optional(embeds).mapList { it.toRequest() },
+                    allowedMentions = Optional(allowedMentions).map { it.build() },
+                    components = Optional(components).mapList { it.build() },
+                    tts = Optional(tts).coerceToMissing().toPrimitive()
                 ).optional()
             ),
-            state.files
+            Optional(files)
         )
 
     }

diff --git a/rest/src/main/kotlin/builder/message/modify/UserMessageModifyBuilder.kt b/rest/src/main/kotlin/builder/message/modify/UserMessageModifyBuilder.kt
@@ -1,25 +1,28 @@
 package dev.kord.rest.builder.message.modify
 
 import dev.kord.common.annotation.KordPreview
+import dev.kord.common.entity.DiscordAttachment
 import dev.kord.common.entity.MessageFlags
 import dev.kord.common.entity.optional.delegate.delegate
 import dev.kord.common.entity.optional.map
 import dev.kord.common.entity.optional.mapList
+import dev.kord.rest.NamedFile
 import dev.kord.rest.builder.RequestBuilder
 import dev.kord.rest.builder.component.MessageComponentBuilder
 import dev.kord.rest.builder.message.AllowedMentionsBuilder
 import dev.kord.rest.builder.message.EmbedBuilder
 import dev.kord.rest.json.request.MessageEditPatchRequest
 import dev.kord.rest.json.request.MultipartMessagePatchRequest
-import java.io.InputStream
 
 class UserMessageModifyBuilder
     : PersistentMessageModifyBuilder,
     RequestBuilder<MultipartMessagePatchRequest> {
 
     private var state = MessageModifyStateHolder()
 
-    override var files: MutableList<Pair<String, InputStream>>? by state::files.delegate()
+    override var files: MutableList<NamedFile>? by state::files.delegate()
+
+    override var attachments: MutableList<DiscordAttachment>? by state::attachments.delegate()
 
     override var content: String? by state::content.delegate()
 
@@ -39,7 +42,8 @@ class UserMessageModifyBuilder
             embeds = state.embeds.mapList { it.toRequest() },
             flags = state.flags,
             allowedMentions = state.allowedMentions.map { it.build() },
-            components = state.components.mapList { it.build() }
+            components = state.components.mapList { it.build() },
+            attachments = state.attachments
         ),
         state.files,
     )