discord.js 15.0.0-djs-file-upload.1761302390-5ae769c9e → 15.0.0-pr-11006.1765450224-e636950b2

package/src/managers/MessageManager.js

@@ -2,6 +2,7 @@
 
 const { Collection } = require('@discordjs/collection');
 const { makeURLSearchParams } = require('@discordjs/rest');
+const { isFileBodyEncodable, isJSONEncodable } = require('@discordjs/util');
 const { Routes } = require('discord-api-types/v10');
 const { DiscordjsTypeError, ErrorCodes } = require('../errors/index.js');
 const { Message } = require('../structures/Message.js');
@@ -115,12 +116,12 @@ class MessageManager extends CachedManager {
     return this._add(data, cache);
   }
 
-  async _fetchMany(options = {}) {
+  async _fetchMany({ cache, ...apiOptions } = {}) {
     const data = await this.client.rest.get(Routes.channelMessages(this.channel.id), {
-      query: makeURLSearchParams(options),
+      query: makeURLSearchParams(apiOptions),
     });
 
-    return data.reduce((_data, message) => _data.set(message.id, this._add(message, options.cache)), new Collection());
+    return data.reduce((_data, message) => _data.set(message.id, this._add(message, cache)), new Collection());
   }
 
   /**
@@ -150,8 +151,8 @@ class MessageManager extends CachedManager {
    */
 
   /**
-   * Fetches the pinned messages of this channel and returns a collection of them.
-   * <info>The returned Collection does not contain any reaction data of the messages.
+   * Fetches the pinned messages of this channel, returning a paginated result.
+   * <info>The returned messages do not contain any reaction data.
    * Those need to be fetched separately.</info>
    *
    * @param {FetchPinnedMessagesOptions} [options={}] Options for fetching pinned messages
@@ -162,11 +163,11 @@ class MessageManager extends CachedManager {
    *   .then(messages => console.log(`Received ${messages.items.length} messages`))
    *   .catch(console.error);
    */
-  async fetchPins(options = {}) {
+  async fetchPins({ cache, ...apiOptions } = {}) {
     const data = await this.client.rest.get(Routes.channelMessagesPins(this.channel.id), {
       query: makeURLSearchParams({
-        ...options,
-        before: options.before && new Date(options.before).toISOString(),
+        ...apiOptions,
+        before: apiOptions.before && new Date(apiOptions.before).toISOString(),
       }),
     });
 
@@ -176,7 +177,7 @@ class MessageManager extends CachedManager {
         get pinnedAt() {
           return new Date(this.pinnedTimestamp);
         },
-        message: this._add(item.message, options.cache),
+        message: this._add(item.message, cache),
       })),
       hasMore: data.has_more,
     };
@@ -223,21 +224,27 @@ class MessageManager extends CachedManager {
    * Edits a message, even if it's not cached.
    *
    * @param {MessageResolvable} message The message to edit
-   * @param {string|MessageEditOptions|MessagePayload} options The options to edit the message
+   * @param {string|MessageEditOptions|MessagePayload|FileBodyEncodable<RESTPatchAPIChannelMessageJSONBody>|JSONEncodable<RESTPatchAPIChannelMessageJSONBody>} options The options to edit the message
    * @returns {Promise<Message>}
    */
   async edit(message, options) {
     const messageId = this.resolveId(message);
     if (!messageId) throw new DiscordjsTypeError(ErrorCodes.InvalidType, 'message', 'MessageResolvable');
 
-    const { body, files } = await (
-      options instanceof MessagePayload
-        ? options
-        : MessagePayload.create(message instanceof Message ? message : this, options)
-    )
-      .resolveBody()
-      .resolveFiles();
-    const data = await this.client.rest.patch(Routes.channelMessage(this.channel.id, messageId), { body, files });
+    let payload;
+    if (options instanceof MessagePayload) {
+      payload = await options.resolveBody().resolveFiles();
+    } else if (isFileBodyEncodable(options)) {
+      payload = options.toFileBody();
+    } else if (isJSONEncodable(options)) {
+      payload = { body: options.toJSON() };
+    } else {
+      payload = await MessagePayload.create(message instanceof Message ? message : this, options)
+        .resolveBody()
+        .resolveFiles();
+    }
+
+    const data = await this.client.rest.patch(Routes.channelMessage(this.channel.id, messageId), payload);
 
     const existing = this.cache.get(messageId);
     if (existing) {

package/src/structures/ApplicationCommand.js

@@ -136,11 +136,11 @@ class ApplicationCommand extends Base {
       /**
        * The options of this command
        *
-       * @type {ApplicationCommandOption[]}
+       * @type {?ApplicationCommandOption[]}
        */
       this.options = data.options.map(option => this.constructor.transformOption(option, true));
     } else {
-      this.options ??= [];
+      this.options ??= null;
     }
 
     if ('default_member_permissions' in data) {
@@ -436,9 +436,7 @@ class ApplicationCommand extends Base {
       ('version' in command && command.version !== this.version) ||
       (command.type && command.type !== this.type) ||
       ('nsfw' in command && command.nsfw !== this.nsfw) ||
-      // Future proof for options being nullable
-      // TODO: remove ?? 0 on each when nullable
-      (command.options?.length ?? 0) !== (this.options?.length ?? 0) ||
+      command.options?.length !== this.options?.length ||
       defaultMemberPermissions !== (this.defaultMemberPermissions?.bitfield ?? null) ||
       !isEqual(command.nameLocalizations ?? command.name_localizations ?? {}, this.nameLocalizations ?? {}) ||
       !isEqual(
@@ -452,6 +450,7 @@ class ApplicationCommand extends Base {
       return false;
     }
 
+    // Don't need to check both because we already checked the lengths above
     if (command.options) {
       return this.constructor.optionsEqual(this.options, command.options, enforceOptionOrder);
     }

package/src/structures/ClientApplication.js

@@ -98,6 +98,7 @@ class ClientApplication extends Application {
      * Scopes and permissions regarding the installation context
      */
 
+    /* eslint-disable jsdoc/valid-types */
     /**
      * The application's supported installation context data.
      *
@@ -107,6 +108,7 @@ class ClientApplication extends Application {
      * @property {IntegrationTypesConfigurationContext} [1] Scopes and permissions
      * regarding the user-installation context
      */
+    /* eslint-enable jsdoc/valid-types */
 
     if ('integration_types_config' in data) {
       /**

package/src/structures/Embed.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { embedLength } = require('@discordjs/builders');
+const { embedLength } = require('@discordjs/util');
 const isEqual = require('fast-deep-equal');
 
 /**

package/src/structures/Guild.js

@@ -641,7 +641,7 @@ class Guild extends AnonymousGuild {
   }
 
   /**
-   * The maximum bitrate available for this guild
+   * The maximum bitrate available for a voice channel in this guild
    *
    * @type {number}
    * @readonly
@@ -663,6 +663,16 @@ class Guild extends AnonymousGuild {
     }
   }
 
+  /**
+   * The maximum bitrate available for a stage channel in this guild
+   *
+   * @type {number}
+   * @readonly
+   */
+  get maximumStageBitrate() {
+    return 64_000;
+  }
+
   /**
    * Fetches a collection of integrations to this guild.
    * Resolves with a collection mapping integrations by their ids.

package/src/structures/GuildInvite.js

@@ -192,7 +192,7 @@ class GuildInvite extends BaseInvite {
     if (!guild.members.me) throw new DiscordjsError(ErrorCodes.GuildUncachedMe);
     return Boolean(
       this.channel?.permissionsFor(this.client.user).has(PermissionFlagsBits.ManageChannels, false) ||
-        guild.members.me.permissions.has(PermissionFlagsBits.ManageGuild),
+      guild.members.me.permissions.has(PermissionFlagsBits.ManageGuild),
     );
   }
 

package/src/structures/GuildMember.js

@@ -24,13 +24,6 @@ class GuildMember extends Base {
      */
     this.guild = guild;
 
-    /**
-     * The timestamp the member joined the guild at
-     *
-     * @type {?number}
-     */
-    this.joinedTimestamp = null;
-
     /**
      * The last timestamp this member started boosting the guild
      *
@@ -68,7 +61,7 @@ class GuildMember extends Base {
      */
     Object.defineProperty(this, '_roles', { value: [], writable: true });
 
-    if (data) this._patch(data);
+    this._patch(data);
   }
 
   _patch(data) {
@@ -104,7 +97,17 @@ class GuildMember extends Base {
       this.banner ??= null;
     }
 
-    if ('joined_at' in data) this.joinedTimestamp = Date.parse(data.joined_at);
+    if ('joined_at' in data) {
+      /**
+       * The timestamp the member joined the guild at
+       *
+       * @type {?number}
+       */
+      this.joinedTimestamp = data.joined_at && Date.parse(data.joined_at);
+    } else {
+      this.joinedTimestamp ??= null;
+    }
+
     if ('premium_since' in data) {
       this.premiumSinceTimestamp = data.premium_since ? Date.parse(data.premium_since) : null;
     }

package/src/structures/Message.js

@@ -725,8 +725,8 @@ class Message extends Base {
   get editable() {
     const precheck = Boolean(
       this.author.id === this.client.user.id &&
-        (!this.guild || this.channel?.viewable) &&
-        this.reference?.type !== MessageReferenceType.Forward,
+      (!this.guild || this.channel?.viewable) &&
+      this.reference?.type !== MessageReferenceType.Forward,
     );
 
     // Regardless of permissions thread messages cannot be edited if
@@ -799,12 +799,15 @@ class Message extends Base {
    */
   get pinnable() {
     const { channel } = this;
-    return Boolean(
-      !this.system &&
-        (!this.guild ||
-          (channel?.viewable &&
-            channel?.permissionsFor(this.client.user)?.has(PermissionFlagsBits.ManageMessages, false))),
-    );
+
+    if (this.system) return false;
+    if (!this.guild) return true;
+    if (!channel || channel.isVoiceBased() || !channel.viewable) return false;
+
+    const permissions = channel.permissionsFor(this.client.user);
+    if (!permissions) return false;
+
+    return permissions.has(PermissionFlagsBits.ReadMessageHistory | PermissionFlagsBits.PinMessages);
   }
 
   /**
@@ -834,19 +837,19 @@ class Message extends Base {
     const { channel } = this;
     return Boolean(
       channel?.type === ChannelType.GuildAnnouncement &&
-        !this.flags.has(MessageFlags.Crossposted) &&
-        this.reference?.type !== MessageReferenceType.Forward &&
-        this.type === MessageType.Default &&
-        !this.poll &&
-        channel.viewable &&
-        channel.permissionsFor(this.client.user)?.has(bitfield, false),
+      !this.flags.has(MessageFlags.Crossposted) &&
+      this.reference?.type !== MessageReferenceType.Forward &&
+      this.type === MessageType.Default &&
+      !this.poll &&
+      channel.viewable &&
+      channel.permissionsFor(this.client.user)?.has(bitfield, false),
     );
   }
 
   /**
    * Edits the content of the message.
    *
-   * @param {string|MessagePayload|MessageEditOptions} options The options to provide
+   * @param {string|MessageEditOptions|MessagePayload|FileBodyEncodable<RESTPatchAPIChannelMessageJSONBody>|JSONEncodable<RESTPatchAPIChannelMessageJSONBody>} options The options to provide
    * @returns {Promise<Message>}
    * @example
    * // Update the content of a message

package/src/structures/MessagePayload.js

@@ -1,13 +1,20 @@
 'use strict';
 
 const { Buffer } = require('node:buffer');
-const { isJSONEncodable } = require('@discordjs/util');
+const { isJSONEncodable, lazy } = require('@discordjs/util');
 const { DiscordSnowflake } = require('@sapphire/snowflake');
 const { DiscordjsError, DiscordjsRangeError, ErrorCodes } = require('../errors/index.js');
 const { resolveFile } = require('../util/DataResolver.js');
 const { MessageFlagsBitField } = require('../util/MessageFlagsBitField.js');
 const { findName, verifyString, resolvePartialEmoji } = require('../util/Util.js');
 
+// Fixes circular dependencies.
+const getWebhook = lazy(() => require('./Webhook.js').Webhook);
+const getUser = lazy(() => require('./User.js').User);
+const getGuildMember = lazy(() => require('./GuildMember.js').GuildMember);
+const getMessage = lazy(() => require('./Message.js').Message);
+const getMessageManager = lazy(() => require('../managers/MessageManager.js').MessageManager);
+
 /**
  * Represents a message to be sent to the API.
  */
@@ -47,15 +54,13 @@ class MessagePayload {
   }
 
   /**
-   * Whether or not the target is a {@link Webhook} or a {@link WebhookClient}
+   * Whether or not the target is a {@link Webhook}
    *
    * @type {boolean}
    * @readonly
    */
   get isWebhook() {
-    const { Webhook } = require('./Webhook.js');
-    const { WebhookClient } = require('../client/WebhookClient.js');
-    return this.target instanceof Webhook || this.target instanceof WebhookClient;
+    return this.target instanceof getWebhook();
   }
 
   /**
@@ -65,9 +70,7 @@ class MessagePayload {
    * @readonly
    */
   get isUser() {
-    const { User } = require('./User.js');
-    const { GuildMember } = require('./GuildMember.js');
-    return this.target instanceof User || this.target instanceof GuildMember;
+    return this.target instanceof getUser() || this.target instanceof getGuildMember();
   }
 
   /**
@@ -77,8 +80,7 @@ class MessagePayload {
    * @readonly
    */
   get isMessage() {
-    const { Message } = require('./Message.js');
-    return this.target instanceof Message;
+    return this.target instanceof getMessage();
   }
 
   /**
@@ -88,8 +90,7 @@ class MessagePayload {
    * @readonly
    */
   get isMessageManager() {
-    const { MessageManager } = require('../managers/MessageManager.js');
-    return this.target instanceof MessageManager;
+    return this.target instanceof getMessageManager();
   }
 
   /**
@@ -196,10 +197,13 @@ class MessagePayload {
       waveform: file.waveform,
       duration_secs: file.duration,
     }));
+
+    // Only passable during edits
     if (Array.isArray(this.options.attachments)) {
-      this.options.attachments.push(...(attachments ?? []));
-    } else {
-      this.options.attachments = attachments;
+      attachments.push(
+        // Note how we don't check for file body encodable, since we aren't expecting file data here
+        ...this.options.attachments.map(attachment => (isJSONEncodable(attachment) ? attachment.toJSON() : attachment)),
+      );
     }
 
     let poll;
@@ -236,7 +240,7 @@ class MessagePayload {
           : allowedMentions,
       flags,
       message_reference,
-      attachments: this.options.attachments,
+      attachments,
       sticker_ids: this.options.stickers?.map(sticker => sticker.id ?? sticker),
       thread_name: threadName,
       applied_tags: appliedTags,
@@ -302,7 +306,7 @@ exports.MessagePayload = MessagePayload;
 /**
  * A target for a message.
  *
- * @typedef {TextBasedChannels|ChannelManager|Webhook|WebhookClient|BaseInteraction|InteractionWebhook|
+ * @typedef {TextBasedChannels|ChannelManager|Webhook|BaseInteraction|InteractionWebhook|
  * Message|MessageManager} MessageTarget
  */
 

package/src/structures/ModalComponentResolver.js

@@ -228,7 +228,7 @@ class ModalComponentResolver {
    *
    * @param {string} customId The custom id of the component
    * @param {boolean} [required=false] Whether to throw an error if the component value is not found or empty
-   * @returns {?Collection<string, Attachment>} The uploaded files, or null if none were uploaded and not required
+   * @returns {?Collection<Snowflake, Attachment>} The uploaded files, or null if none were uploaded and not required
    */
   getUploadedFiles(customId, required = false) {
     return this._getTypedComponent(customId, [ComponentType.FileUpload], ['attachments'], required).attachments ?? null;

package/src/structures/ModalSubmitInteraction.js

@@ -21,17 +21,17 @@ const getAttachment = lazy(() => require('./Attachment.js').Attachment);
  * @typedef {BaseModalData} SelectMenuModalData
  * @property {string} customId The custom id of the component
  * @property {string[]} values The values of the component
- * @property {Collection<string, GuildMember|APIGuildMember>} [members] The resolved members
- * @property {Collection<string, User|APIUser>} [users] The resolved users
- * @property {Collection<string, Role|APIRole>} [roles] The resolved roles
- * @property {Collection<string, BaseChannel|APIChannel>} [channels] The resolved channels
+ * @property {Collection<Snowflake, GuildMember|APIGuildMember>} [members] The resolved members
+ * @property {Collection<Snowflake, User|APIUser>} [users] The resolved users
+ * @property {Collection<Snowflake, Role|APIRole>} [roles] The resolved roles
+ * @property {Collection<Snowflake, BaseChannel|APIChannel>} [channels] The resolved channels
  */
 
 /**
  * @typedef {BaseModalData} FileUploadModalData
  * @property {string} customId The custom id of the file upload
- * @property {string[]} values The values of the file upload
- * @property {Collection<string, Attachment>} [attachments] The resolved attachments
+ * @property {Snowflake[]} values The values of the file upload
+ * @property {Collection<Snowflake, Attachment>} [attachments] The resolved attachments
  */
 
 /**

package/src/structures/PermissionOverwrites.js

@@ -24,7 +24,7 @@ class PermissionOverwrites extends Base {
      */
     Object.defineProperty(this, 'channel', { value: channel });
 
-    if (data) this._patch(data);
+    this._patch(data);
   }
 
   _patch(data) {

package/src/structures/Role.js

@@ -38,7 +38,7 @@ class Role extends Base {
      */
     this.unicodeEmoji = null;
 
-    if (data) this._patch(data);
+    this._patch(data);
   }
 
   _patch(data) {

package/src/structures/ThreadChannel.js

@@ -55,7 +55,7 @@ class ThreadChannel extends BaseChannel {
      * @type {ThreadMemberManager}
      */
     this.members = new ThreadMemberManager(this);
-    if (data) this._patch(data);
+    this._patch(data);
   }
 
   _patch(data) {

package/src/structures/Webhook.js

@@ -23,7 +23,7 @@ class Webhook {
      * @readonly
      */
     Object.defineProperty(this, 'client', { value: client });
-    if (data) this._patch(data);
+    this._patch(data);
   }
 
   _patch(data) {
@@ -95,9 +95,9 @@ class Webhook {
       /**
        * The owner of the webhook
        *
-       * @type {?(User|APIUser)}
+       * @type {?User}
        */
-      this.owner = this.client.users?._add(data.user) ?? data.user;
+      this.owner = this.client.users._add(data.user);
     } else {
       this.owner ??= null;
     }
@@ -119,7 +119,7 @@ class Webhook {
        *
        * @type {?(Guild|APIGuild)}
        */
-      this.sourceGuild = this.client.guilds?.cache.get(data.source_guild.id) ?? data.source_guild;
+      this.sourceGuild = this.client.guilds.cache.get(data.source_guild.id) ?? data.source_guild;
     } else {
       this.sourceGuild ??= null;
     }
@@ -130,7 +130,7 @@ class Webhook {
        *
        * @type {?(AnnouncementChannel|APIChannel)}
        */
-      this.sourceChannel = this.client.channels?.cache.get(data.source_channel?.id) ?? data.source_channel;
+      this.sourceChannel = this.client.channels.cache.get(data.source_channel?.id) ?? data.source_channel;
     } else {
       this.sourceChannel ??= null;
     }
@@ -248,7 +248,6 @@ class Webhook {
       auth: false,
     });
 
-    if (!this.client.channels) return data;
     return (
       this.client.channels.cache.get(data.channel_id)?.messages._add(data, false) ??
       new (getMessage())(this.client, data)
@@ -345,7 +344,6 @@ class Webhook {
       auth: false,
     });
 
-    if (!this.client.channels) return data;
     return (
       this.client.channels.cache.get(data.channel_id)?.messages._add(data, false) ??
       new (getMessage())(this.client, data)
@@ -384,10 +382,7 @@ class Webhook {
       },
     );
 
-    const channelManager = this.client.channels;
-    if (!channelManager) return data;
-
-    const messageManager = channelManager.cache.get(data.channel_id)?.messages;
+    const messageManager = this.client.channels.cache.get(data.channel_id)?.messages;
     if (!messageManager) return new (getMessage())(this.client, data);
 
     const existing = messageManager.cache.get(data.id);

package/src/structures/interfaces/TextBasedChannel.js

@@ -1,14 +1,17 @@
 'use strict';
 
 const { Collection } = require('@discordjs/collection');
+const { lazy } = require('@discordjs/util');
 const { DiscordSnowflake } = require('@sapphire/snowflake');
 const { InteractionType, Routes } = require('discord-api-types/v10');
 const { DiscordjsTypeError, DiscordjsError, ErrorCodes } = require('../../errors/index.js');
 const { MaxBulkDeletableMessageAge } = require('../../util/Constants.js');
 const { InteractionCollector } = require('../InteractionCollector.js');
-// eslint-disable-next-line import-x/order
 const { MessageCollector } = require('../MessageCollector.js');
 
+// Fixes circular dependencies.
+const getGuildMessageManager = lazy(() => require('../../managers/GuildMessageManager.js').GuildMessageManager);
+
 /**
  * Interface for classes that have text-channel-like features.
  *
@@ -21,8 +24,7 @@ class TextBasedChannel {
      *
      * @type {GuildMessageManager}
      */
-    // eslint-disable-next-line no-use-before-define
-    this.messages = new GuildMessageManager(this);
+    this.messages = new (getGuildMessageManager())(this);
 
     /**
      * The channel's last message id, if one was sent
@@ -86,7 +88,7 @@ class TextBasedChannel {
    * @property {Array<(EmbedBuilder|Embed|APIEmbed)>} [embeds] The embeds for the message
    * @property {MessageMentionOptions} [allowedMentions] Which mentions should be parsed from the message content
    * (see {@link https://discord.com/developers/docs/resources/message#allowed-mentions-object here} for more details)
-   * @property {Array<(AttachmentBuilder|Attachment|AttachmentPayload|BufferResolvable)>} [files]
+   * @property {Array<(Attachment|AttachmentPayload|BufferResolvable|FileBodyEncodable<APIAttachment>|Stream)>} [files]
    * The files to send with the message.
    * @property {Array<(ActionRowBuilder|MessageTopLevelComponent|APIMessageTopLevelComponent)>} [components]
    * Action rows containing interactive components for the message (buttons, select menus) and other
@@ -154,7 +156,7 @@ class TextBasedChannel {
   /**
    * Sends a message to this channel.
    *
-   * @param {string|MessagePayload|MessageCreateOptions} options The options to provide
+   * @param {string|MessagePayload|MessageCreateOptions|JSONEncodable<RESTPostAPIChannelMessageJSONBody>|FileBodyEncodable<RESTPostAPIChannelMessageJSONBody>} options The options to provide
    * @returns {Promise<Message>}
    * @example
    * // Send a basic message
@@ -427,7 +429,3 @@ class TextBasedChannel {
 }
 
 exports.TextBasedChannel = TextBasedChannel;
-
-// Fixes Circular
-// eslint-disable-next-line import-x/order
-const { GuildMessageManager } = require('../../managers/GuildMessageManager.js');

package/src/util/APITypes.js

@@ -683,3 +683,13 @@
  * @external WebhookType
  * @see {@link https://discord-api-types.dev/api/discord-api-types-v10/enum/WebhookType}
  */
+
+/**
+ * @external RESTPatchAPIChannelMessageJSONBody
+ * @see {@link https://discord-api-types.dev/api/discord-api-types-v10/interface/RESTPatchAPIChannelMessageJSONBody}
+ */
+
+/**
+ * @external RESTPostAPIChannelMessageJSONBody
+ * @see {@link https://discord-api-types.dev/api/discord-api-types-v10/interface/RESTPostAPIChannelMessageJSONBody}
+ */