Rework file attachments

index.d.ts

@@ -155,7 +155,7 @@ declare namespace Eris {
   type StageInstancePrivacyLevel = Constants["StageInstancePrivacyLevel"][keyof Constants["StageInstancePrivacyLevel"]];
 
   // Webhook
-  type MessageWebhookContent = Pick<WebhookPayload, "content" | "embeds" | "file" | "allowedMentions" | "components">;
+  type MessageWebhookContent = Pick<WebhookPayload, "attachments" | "content" | "embeds" | "file" | "allowedMentions" | "components">;
   type WebhookTypes = Constants["WebhookTypes"][keyof Constants["WebhookTypes"]];
 
   // INTERFACES
@@ -1081,6 +1081,7 @@ declare namespace Eris {
   }
   interface AdvancedMessageContent {
     allowedMentions?: AllowedMentions;
+    attachments?: PartialAttachment[];
     components?: ActionRow[];
     content?: string;
     embed?: EmbedOptions;
@@ -1101,7 +1102,7 @@ declare namespace Eris {
     roles?: boolean | string[];
     users?: boolean | string[];
   }
-  interface Attachment {
+  interface Attachment extends PartialAttachment {
     content_type?: string;
     ephemeral?: boolean;
     filename: string;
@@ -1126,6 +1127,12 @@ declare namespace Eris {
     name?: string;
     tags?: string;
   }
+  interface PartialAttachment {
+    description?: string;
+    filename?: string;
+    /** When creating an attachment, the ID is the index number of the file you wish to add relevant attributes to. When editing the attachment, this is the normal attachment ID */
+    id: string | number;
+  }
   interface SelectMenu {
     custom_id: string;
     disabled?: boolean;
@@ -1399,6 +1406,7 @@ declare namespace Eris {
   }
   interface WebhookPayload {
     allowedMentions?: AllowedMentions;
+    attachments: PartialAttachment[];
     auth?: boolean;
     avatarURL?: string;
     components?: ActionRow[];

lib/Client.js

@@ -764,6 +764,10 @@ class Client extends EventEmitter {
     * @arg {Boolean | Array<String>} [content.allowedMentions.roles] Whether or not to allow all role mentions, or an array of specific role mentions to allow.
     * @arg {Boolean | Array<String>} [content.allowedMentions.users] Whether or not to allow all user mentions, or an array of specific user mentions to allow.
     * @arg {Boolean} [content.allowedMentions.repliedUser] Whether or not to mention the author of the message being replied to.
+    * @arg {Array<Object>} [content.attachments] Attachment objects to add the filename and description
+    * @arg {String} [content.attachments[].description] The file description
+    * @arg {String} [content.attachments[].filename] The file's name. You shouldn't need to use this as you provide the filename when attaching the file
+    * @arg {Number} content.attachments[].id The index ID of the attaching file
     * @arg {Array<Object>} [content.components] An array of component objects
     * @arg {String} [content.components[].custom_id] The ID of the component (type 2 style 0-4 and type 3 only)
     * @arg {Boolean} [content.components[].disabled] Whether the component is disabled (type 2 and 3 only)
@@ -835,6 +839,9 @@ class Client extends EventEmitter {
                 this.emit("warn", "[DEPRECATED] content.messageReferenceID is deprecated. Use content.messageReference instead");
                 content.message_reference = {message_id: content.messageReferenceID};
             }
+            if(file) {
+                content = {payload_json: content};
+            }
         }
         return this.requestHandler.request("POST", Endpoints.CHANNEL_MESSAGES(channelID), true, content, file).then((message) => new Message(message, this));
     }
@@ -1635,6 +1642,10 @@ class Client extends EventEmitter {
     * @arg {Boolean} [content.allowedMentions.everyone] Whether or not to allow @everyone/@here.
     * @arg {Boolean | Array<String>} [content.allowedMentions.roles] Whether or not to allow all role mentions, or an array of specific role mentions to allow.
     * @arg {Boolean | Array<String>} [content.allowedMentions.users] Whether or not to allow all user mentions, or an array of specific user mentions to allow.
+    * @arg {Array<Object>} [content.attachments] Attachment objects to retain and/or edit the name and/or description for currently attached files and add the filename and description for new files
+    * @arg {String} [content.attachments[].description] The file description
+    * @arg {String} [content.attachments[].filename] The file's name. This is not needed if you are attaching a new file
+    * @arg {Number} content.attachments[].id The file's ID. If you are attaching a new file, this would be the index ID of the attaching file
     * @arg {Array<Object>} [content.components] An array of component objects
     * @arg {String} [content.components[].custom_id] The ID of the component (type 2 style 0-4 and type 3 only)
     * @arg {Boolean} [content.components[].disabled] Whether the component is disabled (type 2 and 3 only)
@@ -1926,13 +1937,18 @@ class Client extends EventEmitter {
     * @arg {Boolean} [options.allowedMentions.repliedUser] Whether or not to mention the author of the message being replied to.
     * @arg {Boolean | Array<String>} [options.allowedMentions.roles] Whether or not to allow all role mentions, or an array of specific role mentions to allow.
     * @arg {Boolean | Array<String>} [options.allowedMentions.users] Whether or not to allow all user mentions, or an array of specific user mentions to allow.
+    * @arg {Boolean} [options.allowedMentions.repliedUser] Whether or not to mention the author of the message being replied to.
+    * @arg {Array<Object>} [options.attachments] Attachment objects to retain and/or edit the name and/or description for currently attached files and add the filename and description for new files
+    * @arg {String} [options.attachments[].description] The file description
+    * @arg {String} [options.attachments[].filename] The file's name. This is not needed if you are attaching a new file
+    * @arg {Number} options.attachments[].id The file's ID. If you are attaching a new file, this would be the index ID of the attaching file
     * @arg {Array<Object>} [options.components] An array of component objects
     * @arg {String} [options.components[].custom_id] The ID of the component (type 2 style 0-4 and type 3 only)
     * @arg {Boolean} [options.components[].disabled] Whether the component is disabled (type 2 and 3 only)
     * @arg {Object} [options.components[].emoji] The emoji to be displayed in the component (type 2)
     * @arg {String} [options.components[].label] The label to be displayed in the component (type 2)
-    * @arg {Number} [content.components[].max_values] The maximum number of items that can be chosen (1-25, default 1)
-    * @arg {Number} [content.components[].min_values] The minimum number of items that must be chosen (0-25, default 1)
+    * @arg {Number} [options.components[].max_values] The maximum number of items that can be chosen (1-25, default 1)
+    * @arg {Number} [options.components[].min_values] The minimum number of items that must be chosen (0-25, default 1)
     * @arg {Array<Object>} [options.components[].options] The options for this component (type 3 only)
     * @arg {Boolean} [options.components[].options[].default] Whether this option should be the default value selected
     * @arg {String} [options.components[].options[].description] The description for this option
@@ -1955,13 +1971,14 @@ class Client extends EventEmitter {
         if(options.allowedMentions) {
             options.allowed_mentions = this._formatAllowedMentions(options.allowedMentions);
         }
-        if(options.embed) {
-            if(!options.embeds) {
-                options.embeds = [];
-            }
-            options.embeds.push(options.embed);
+        const file = options.file;
+        delete options.file;
+
+        if(options.embed && !options.embeds) {
+            options.embeds = [options.embed];
         }
-        return this.requestHandler.request("PATCH", Endpoints.WEBHOOK_MESSAGE(webhookID, token, messageID), false, options, options.file).then((response) => new Message(response, this));
+
+        return this.requestHandler.request("PATCH", Endpoints.WEBHOOK_MESSAGE(webhookID, token, messageID), false, file ? {payload_json: options} : options, file).then((response) => new Message(response, this));
     }
 
     /**
@@ -2017,15 +2034,20 @@ class Client extends EventEmitter {
     * @arg {Boolean} [options.allowedMentions.everyone] Whether or not to allow @everyone/@here.
     * @arg {Boolean | Array<String>} [options.allowedMentions.roles] Whether or not to allow all role mentions, or an array of specific role mentions to allow.
     * @arg {Boolean | Array<String>} [options.allowedMentions.users] Whether or not to allow all user mentions, or an array of specific user mentions to allow.
+    * @arg {Boolean} [options.allowedMentions.repliedUser] Whether or not to mention the author of the message being replied to.
+    * @arg {Array<Object>} [options.attachments] Attachment objects to add the filename and description
+    * @arg {String} [options.attachments[].description] The file description
+    * @arg {String} [options.attachments[].filename] The file's name. You shouldn't need to use this as you provide the filename when attaching the file
+    * @arg {Number} options.attachments[].id The index ID of the attaching file
     * @arg {Boolean} [options.auth=false] Whether or not to authenticate with the bot token.
     * @arg {String} [options.avatarURL] A URL for a custom avatar, defaults to webhook default avatar if not specified
     * @arg {Array<Object>} [options.components] An array of component objects
     * @arg {String} [options.components[].custom_id] The ID of the component (type 2 style 0-4 and type 3 only)
     * @arg {Boolean} [options.components[].disabled] Whether the component is disabled (type 2 and 3 only)
     * @arg {Object} [options.components[].emoji] The emoji to be displayed in the component (type 2)
     * @arg {String} [options.components[].label] The label to be displayed in the component (type 2)
-    * @arg {Number} [content.components[].max_values] The maximum number of items that can be chosen (1-25, default 1)
-    * @arg {Number} [content.components[].min_values] The minimum number of items that must be chosen (0-25, default 1)
+    * @arg {Number} [options.components[].max_values] The maximum number of items that can be chosen (1-25, default 1)
+    * @arg {Number} [options.components[].min_values] The minimum number of items that must be chosen (0-25, default 1)
     * @arg {Array<Object>} [options.components[].options] The options for this component (type 3 only)
     * @arg {Boolean} [options.components[].options[].default] Whether this option should be the default value selected
     * @arg {String} [options.components[].options[].description] The description for this option
@@ -2050,6 +2072,17 @@ class Client extends EventEmitter {
     * @returns {Promise<Message?>}
     */
     executeWebhook(webhookID, token, options) {
+        const data = {
+            content: options.content,
+            embeds: options.embeds,
+            username: options.username,
+            avatar_url: options.avatarURL,
+            tts: options.tts,
+            flags: options.flags,
+            allowed_mentions: this._formatAllowedMentions(options.allowedMentions),
+            components: options.components
+        };
+
         let qs = "";
         if(options.wait) {
             qs += "&wait=true";
@@ -2063,16 +2096,7 @@ class Client extends EventEmitter {
             }
             options.embeds.push(options.embed);
         }
-        return this.requestHandler.request("POST", Endpoints.WEBHOOK_TOKEN(webhookID, token) + (qs ? "?" + qs : ""), !!options.auth, {
-            content: options.content,
-            embeds: options.embeds,
-            username: options.username,
-            avatar_url: options.avatarURL,
-            tts: options.tts,
-            flags: options.flags,
-            allowed_mentions: this._formatAllowedMentions(options.allowedMentions),
-            components: options.components
-        }, options.file).then((response) => options.wait ? new Message(response, this) : undefined);
+        return this.requestHandler.request("POST", Endpoints.WEBHOOK_TOKEN(webhookID, token) + (qs ? "?" + qs : ""), !!options.auth, options.file ? {payload_json: data} : data, options.file).then((response) => options.wait ? new Message(response, this) : undefined);
     }
 
     /**

lib/rest/RequestHandler.js

@@ -108,36 +108,26 @@ class RequestHandler {
                         }
                     }
                     if(file) {
+                        data = new MultipartData();
+                        headers["Content-Type"] = "multipart/form-data; boundary=" + data.boundary;
                         if(Array.isArray(file)) {
-                            data = new MultipartData();
-                            headers["Content-Type"] = "multipart/form-data; boundary=" + data.boundary;
-                            file.forEach(function(f) {
+                            file.forEach(function(f, i) {
                                 if(!f.file) {
                                     return;
                                 }
-                                data.attach(f.name, f.file, f.name);
+                                data.attach(`files[${i}]`, f.file, f.name);
                             });
-                            if(body) {
-                                data.attach("payload_json", body);
-                            }
-                            data = data.finish();
                         } else if(file.file) {
-                            data = new MultipartData();
-                            headers["Content-Type"] = "multipart/form-data; boundary=" + data.boundary;
-                            data.attach("file", file.file, file.name);
-                            if(body) {
-                                if(method === "POST" && url.endsWith("/stickers")) {
-                                    for(const key in body) {
-                                        data.attach(key, body[key]);
-                                    }
-                                } else {
-                                    data.attach("payload_json", body);
-                                }
-                            }
-                            data = data.finish();
+                            data.attach("files[0]", file.file, file.name);
                         } else {
                             throw new Error("Invalid file object");
                         }
+                        if(body) {
+                            for(const key in body) {
+                                data.attach(key, body[key]);
+                            }
+                        }
+                        data = data.finish();
                     } else if(body) {
                         if(method === "GET" || method === "DELETE") {
                             let qs = "";

lib/structures/Message.js

@@ -449,6 +449,10 @@ class Message extends Base {
     * @arg {Boolean} [content.allowedMentions.everyone] Whether or not to allow @everyone/@here.
     * @arg {Boolean | Array<String>} [content.allowedMentions.roles] Whether or not to allow all role mentions, or an array of specific role mentions to allow.
     * @arg {Boolean | Array<String>} [content.allowedMentions.users] Whether or not to allow all user mentions, or an array of specific user mentions to allow.
+    * @arg {Array<Object>} [content.attachments] Attachment objects to retain and/or edit the name and/or description for currently attached files and add the filename and description for new files
+    * @arg {String} [content.attachments[].description] The file description
+    * @arg {String} [content.attachments[].filename] The file's name. This is not needed if you are attaching a new file
+    * @arg {Number} content.attachments[].id The file's ID. If you are attaching a new file, this would be the index ID of the attaching file
     * @arg {Array<Object>} [content.components] An array of component objects
     * @arg {String} [content.components[].custom_id] The ID of the component (type 2 style 0-4 and type 3 only)
     * @arg {Boolean} [content.components[].disabled] Whether the component is disabled (type 2 and 3 only)
@@ -491,6 +495,11 @@ class Message extends Base {
     * @arg {Boolean} [options.allowedMentions.repliedUser] Whether or not to mention the author of the message being replied to.
     * @arg {Boolean | Array<String>} [options.allowedMentions.roles] Whether or not to allow all role mentions, or an array of specific role mentions to allow.
     * @arg {Boolean | Array<String>} [options.allowedMentions.users] Whether or not to allow all user mentions, or an array of specific user mentions to allow.
+    * @arg {Boolean} [options.allowedMentions.repliedUser] Whether or not to mention the author of the message being replied to.
+    * @arg {Array<Object>} [options.attachments] Attachment objects to retain and/or edit the name and/or description for currently attached files and add the filename and description for new files
+    * @arg {String} [options.attachments[].description] The file description
+    * @arg {String} [options.attachments[].filename] The file's name. This is not needed if you are attaching a new file
+    * @arg {Number} options.attachments[].id The file's ID. If you are attaching a new file, this would be the index ID of the attaching file
     * @arg {Array<Object>} [options.components] An array of component objects
     * @arg {String} [options.components[].custom_id] The ID of the component (type 2 style 0-4 and type 3 only)
     * @arg {Boolean} [options.components[].disabled] Whether the component is disabled (type 2 only)