feat: Add media channels (#9662)

* feat: add media channels * refactor: rename to `ThreadOnlyChannel` * feat: support media channels more * docs(ThreadOnlyChannel): update class description * types: update references * test: add more tests * chore: update code * refactor: `abstract` Co-authored-by: space <spaceeec@yahoo.com> --------- Co-authored-by: space <spaceeec@yahoo.com> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
discordjs · Sep 18, 2023 · 571aedd · 571aedd
1 parent e02a59b
commit 571aedd
Show file tree

Hide file tree

Showing 19 changed files with 342 additions and 281 deletions.
diff --git a/...ilders/src/interactions/slashCommands/mixins/ApplicationCommandOptionChannelTypesMixin.ts b/...ilders/src/interactions/slashCommands/mixins/ApplicationCommandOptionChannelTypesMixin.ts
@@ -17,6 +17,7 @@ const allowedChannelTypes = [
 	ChannelType.PrivateThread,
 	ChannelType.GuildStageVoice,
 	ChannelType.GuildForum,
+	ChannelType.GuildMedia,
 ] as const;
 
 /**

diff --git a/packages/discord.js/src/client/actions/WebhooksUpdate.js b/packages/discord.js/src/client/actions/WebhooksUpdate.js
@@ -15,15 +15,15 @@ class WebhooksUpdate extends Action {
     /**
      * Emitted whenever a channel has its webhooks changed.
      * @event Client#webhooksUpdate
-     * @param {TextChannel|NewsChannel|VoiceChannel|StageChannel|ForumChannel} channel
+     * @param {TextChannel|NewsChannel|VoiceChannel|StageChannel|ForumChannel|MediaChannel} channel
      * The channel that had a webhook update
      */
     client.emit('webhooksUpdate', channel);
 
     /**
      * Emitted whenever a channel has its webhooks changed.
      * @event Client#webhookUpdate
-     * @param {TextChannel|NewsChannel|VoiceChannel|StageChannel|ForumChannel} channel
+     * @param {TextChannel|NewsChannel|VoiceChannel|StageChannel|ForumChannel|MediaChannel} channel
      * The channel that had a webhook update
      * @deprecated Use {@link Client#event:webhooksUpdate} instead.
      */

diff --git a/packages/discord.js/src/index.js b/packages/discord.js/src/index.js
@@ -149,6 +149,7 @@ exports.Message = require('./structures/Message').Message;
 exports.Attachment = require('./structures/Attachment');
 exports.AttachmentBuilder = require('./structures/AttachmentBuilder');
 exports.ModalBuilder = require('./structures/ModalBuilder');
+exports.MediaChannel = require('./structures/MediaChannel');
 exports.MessageCollector = require('./structures/MessageCollector');
 exports.MessageComponentInteraction = require('./structures/MessageComponentInteraction');
 exports.MessageContextMenuCommandInteraction = require('./structures/MessageContextMenuCommandInteraction');
@@ -199,6 +200,7 @@ exports.TextInputBuilder = require('./structures/TextInputBuilder');
 exports.TextInputComponent = require('./structures/TextInputComponent');
 exports.ThreadChannel = require('./structures/ThreadChannel');
 exports.ThreadMember = require('./structures/ThreadMember');
+exports.ThreadOnlyChannel = require('./structures/ThreadOnlyChannel');
 exports.Typing = require('./structures/Typing');
 exports.User = require('./structures/User');
 exports.UserContextMenuCommandInteraction = require('./structures/UserContextMenuCommandInteraction');

diff --git a/packages/discord.js/src/managers/GuildChannelManager.js b/packages/discord.js/src/managers/GuildChannelManager.js
@@ -194,7 +194,7 @@ class GuildChannelManager extends CachedManager {
 
   /**
    * @typedef {ChannelWebhookCreateOptions} WebhookCreateOptions
-   * @property {TextChannel|NewsChannel|VoiceChannel|StageChannel|ForumChannel|Snowflake} channel
+   * @property {TextChannel|NewsChannel|VoiceChannel|StageChannel|ForumChannel|MediaChannel|Snowflake} channel
    * The channel to create the webhook for
    */
 

diff --git a/packages/discord.js/src/managers/GuildInviteManager.js b/packages/discord.js/src/managers/GuildInviteManager.js
@@ -46,8 +46,9 @@ class GuildInviteManager extends CachedManager {
    * * NewsChannel
    * * StageChannel
    * * ForumChannel
+   * * MediaChannel
    * * Snowflake
-   * @typedef {TextChannel|VoiceChannel|NewsChannel|StageChannel|ForumChannel|Snowflake}
+   * @typedef {TextChannel|VoiceChannel|NewsChannel|StageChannel|ForumChannel|MediaChannel|Snowflake}
    * GuildInvitableChannelResolvable
    */
 

diff --git a/packages/discord.js/src/managers/ThreadManager.js b/packages/discord.js/src/managers/ThreadManager.js
@@ -20,7 +20,7 @@ class ThreadManager extends CachedManager {
 
     /**
      * The channel this Manager belongs to
-     * @type {TextChannel|NewsChannel|ForumChannel}
+     * @type {TextChannel|NewsChannel|ForumChannel|MediaChannel}
      */
     this.channel = channel;
   }

diff --git a/packages/discord.js/src/structures/AutoModerationActionExecution.js b/packages/discord.js/src/structures/AutoModerationActionExecution.js
@@ -87,7 +87,7 @@ class AutoModerationActionExecution {
 
   /**
    * The channel where this action was triggered from.
-   * @type {?(GuildTextBasedChannel|ForumChannel)}
+   * @type {?(GuildTextBasedChannel|ForumChannel|MediaChannel)}
    * @readonly
    */
   get channel() {

diff --git a/packages/discord.js/src/structures/ForumChannel.js b/packages/discord.js/src/structures/ForumChannel.js
@@ -1,139 +1,14 @@
 'use strict';
 
-const GuildChannel = require('./GuildChannel');
-const TextBasedChannel = require('./interfaces/TextBasedChannel');
-const GuildForumThreadManager = require('../managers/GuildForumThreadManager');
-const { transformAPIGuildForumTag, transformAPIGuildDefaultReaction } = require('../util/Channels');
+const ThreadOnlyChannel = require('./ThreadOnlyChannel');
 
 /**
- * @typedef {Object} GuildForumTagEmoji
- * @property {?Snowflake} id The id of a guild's custom emoji
- * @property {?string} name The unicode character of the emoji
+ * Represents a forum channel.
+ * @extends {ThreadOnlyChannel}
  */
-
-/**
- * @typedef {Object} GuildForumTag
- * @property {Snowflake} id The id of the tag
- * @property {string} name The name of the tag
- * @property {boolean} moderated Whether this tag can only be added to or removed from threads
- * by a member with the `ManageThreads` permission
- * @property {?GuildForumTagEmoji} emoji The emoji of this tag
- */
-
-/**
- * @typedef {Object} GuildForumTagData
- * @property {Snowflake} [id] The id of the tag
- * @property {string} name The name of the tag
- * @property {boolean} [moderated] Whether this tag can only be added to or removed from threads
- * by a member with the `ManageThreads` permission
- * @property {?GuildForumTagEmoji} [emoji] The emoji of this tag
- */
-
-/**
- * @typedef {Object} DefaultReactionEmoji
- * @property {?Snowflake} id The id of a guild's custom emoji
- * @property {?string} name The unicode character of the emoji
- */
-
-/**
- * Represents a channel that only contains threads
- * @extends {GuildChannel}
- * @implements {TextBasedChannel}
- */
-class ForumChannel extends GuildChannel {
-  constructor(guild, data, client) {
-    super(guild, data, client, false);
-
-    /**
-     * A manager of the threads belonging to this channel
-     * @type {GuildForumThreadManager}
-     */
-    this.threads = new GuildForumThreadManager(this);
-
-    this._patch(data);
-  }
-
+class ForumChannel extends ThreadOnlyChannel {
   _patch(data) {
     super._patch(data);
-    if ('available_tags' in data) {
-      /**
-       * The set of tags that can be used in this channel.
-       * @type {GuildForumTag[]}
-       */
-      this.availableTags = data.available_tags.map(tag => transformAPIGuildForumTag(tag));
-    } else {
-      this.availableTags ??= [];
-    }
-
-    if ('default_reaction_emoji' in data) {
-      /**
-       * The emoji to show in the add reaction button on a thread in a guild forum channel
-       * @type {?DefaultReactionEmoji}
-       */
-      this.defaultReactionEmoji = data.default_reaction_emoji
-        ? transformAPIGuildDefaultReaction(data.default_reaction_emoji)
-        : null;
-    } else {
-      this.defaultReactionEmoji ??= null;
-    }
-
-    if ('default_thread_rate_limit_per_user' in data) {
-      /**
-       * The initial rate limit per user (slowmode) to set on newly created threads in a channel.
-       * @type {?number}
-       */
-      this.defaultThreadRateLimitPerUser = data.default_thread_rate_limit_per_user;
-    } else {
-      this.defaultThreadRateLimitPerUser ??= null;
-    }
-
-    if ('rate_limit_per_user' in data) {
-      /**
-       * The rate limit per user (slowmode) for this channel.
-       * @type {?number}
-       */
-      this.rateLimitPerUser = data.rate_limit_per_user;
-    } else {
-      this.rateLimitPerUser ??= null;
-    }
-
-    if ('default_auto_archive_duration' in data) {
-      /**
-       * The default auto archive duration for newly created threads in this channel.
-       * @type {?ThreadAutoArchiveDuration}
-       */
-      this.defaultAutoArchiveDuration = data.default_auto_archive_duration;
-    } else {
-      this.defaultAutoArchiveDuration ??= null;
-    }
-
-    if ('nsfw' in data) {
-      /**
-       * If this channel is considered NSFW.
-       * @type {boolean}
-       */
-      this.nsfw = data.nsfw;
-    } else {
-      this.nsfw ??= false;
-    }
-
-    if ('topic' in data) {
-      /**
-       * The topic of this channel.
-       * @type {?string}
-       */
-      this.topic = data.topic;
-    }
-
-    if ('default_sort_order' in data) {
-      /**
-       * The default sort order mode used to order posts
-       * @type {?SortOrderType}
-       */
-      this.defaultSortOrder = data.default_sort_order;
-    } else {
-      this.defaultSortOrder ??= null;
-    }
 
     /**
      * The default layout type used to display posts
@@ -142,95 +17,6 @@ class ForumChannel extends GuildChannel {
     this.defaultForumLayout = data.default_forum_layout;
   }
 
-  /**
-   * Sets the available tags for this forum channel
-   * @param {GuildForumTagData[]} availableTags The tags to set as available in this channel
-   * @param {string} [reason] Reason for changing the available tags
-   * @returns {Promise<ForumChannel>}
-   */
-  setAvailableTags(availableTags, reason) {
-    return this.edit({ availableTags, reason });
-  }
-
-  /**
-   * Sets the default reaction emoji for this channel
-   * @param {?DefaultReactionEmoji} defaultReactionEmoji The emoji to set as the default reaction emoji
-   * @param {string} [reason] Reason for changing the default reaction emoji
-   * @returns {Promise<ForumChannel>}
-   */
-  setDefaultReactionEmoji(defaultReactionEmoji, reason) {
-    return this.edit({ defaultReactionEmoji, reason });
-  }
-
-  /**
-   * Sets the default rate limit per user (slowmode) for new threads in this channel
-   * @param {number} defaultThreadRateLimitPerUser The rate limit to set on newly created threads in this channel
-   * @param {string} [reason] Reason for changing the default rate limit
-   * @returns {Promise<ForumChannel>}
-   */
-  setDefaultThreadRateLimitPerUser(defaultThreadRateLimitPerUser, reason) {
-    return this.edit({ defaultThreadRateLimitPerUser, reason });
-  }
-
-  /**
-   * Creates an invite to this guild channel.
-   * @param {InviteCreateOptions} [options={}] The options for creating the invite
-   * @returns {Promise<Invite>}
-   * @example
-   * // Create an invite to a channel
-   * channel.createInvite()
-   *   .then(invite => console.log(`Created an invite with a code of ${invite.code}`))
-   *   .catch(console.error);
-   */
-  createInvite(options) {
-    return this.guild.invites.create(this.id, options);
-  }
-
-  /**
-   * Fetches a collection of invites to this guild channel.
-   * Resolves with a collection mapping invites by their codes.
-   * @param {boolean} [cache=true] Whether to cache the fetched invites
-   * @returns {Promise<Collection<string, Invite>>}
-   */
-  fetchInvites(cache) {
-    return this.guild.invites.fetch({ channelId: this.id, cache });
-  }
-
-  /**
-   * Sets the default auto archive duration for all newly created threads in this channel.
-   * @param {ThreadAutoArchiveDuration} defaultAutoArchiveDuration The new default auto archive duration
-   * @param {string} [reason] Reason for changing the channel's default auto archive duration
-   * @returns {Promise<ForumChannel>}
-   */
-  setDefaultAutoArchiveDuration(defaultAutoArchiveDuration, reason) {
-    return this.edit({ defaultAutoArchiveDuration, reason });
-  }
-
-  /**
-   * Sets a new topic for the guild channel.
-   * @param {?string} topic The new topic for the guild channel
-   * @param {string} [reason] Reason for changing the guild channel's topic
-   * @returns {Promise<ForumChannel>}
-   * @example
-   * // Set a new channel topic
-   * channel.setTopic('needs more rate limiting')
-   *   .then(newChannel => console.log(`Channel's new topic is ${newChannel.topic}`))
-   *   .catch(console.error);
-   */
-  setTopic(topic, reason) {
-    return this.edit({ topic, reason });
-  }
-
-  /**
-   * Sets the default sort order mode used to order posts
-   * @param {?SortOrderType} defaultSortOrder The default sort order mode to set on this channel
-   * @param {string} [reason] Reason for changing the default sort order
-   * @returns {Promise<ForumChannel>}
-   */
-  setDefaultSortOrder(defaultSortOrder, reason) {
-    return this.edit({ defaultSortOrder, reason });
-  }
-
   /**
    * Sets the default forum layout type used to display posts
    * @param {ForumLayoutType} defaultForumLayout The default forum layout type to set on this channel
@@ -240,25 +26,6 @@ class ForumChannel extends GuildChannel {
   setDefaultForumLayout(defaultForumLayout, reason) {
     return this.edit({ defaultForumLayout, reason });
   }
-
-  // These are here only for documentation purposes - they are implemented by TextBasedChannel
-  /* eslint-disable no-empty-function */
-  createWebhook() {}
-  fetchWebhooks() {}
-  setNSFW() {}
-  setRateLimitPerUser() {}
 }
 
-TextBasedChannel.applyToClass(ForumChannel, true, [
-  'send',
-  'lastMessage',
-  'lastPinAt',
-  'bulkDelete',
-  'sendTyping',
-  'createMessageCollector',
-  'awaitMessages',
-  'createMessageComponentCollector',
-  'awaitMessageComponent',
-]);
-
 module.exports = ForumChannel;
diff --git a/packages/discord.js/src/structures/Guild.js b/packages/discord.js/src/structures/Guild.js
@@ -520,7 +520,7 @@ class Guild extends AnonymousGuild {
 
   /**
    * Widget channel for this guild
-   * @type {?(TextChannel|NewsChannel|VoiceChannel|StageChannel|ForumChannel)}
+   * @type {?(TextChannel|NewsChannel|VoiceChannel|StageChannel|ForumChannel|MediaChannel)}
    * @readonly
    */
   get widgetChannel() {
@@ -693,14 +693,15 @@ class Guild extends AnonymousGuild {
    * Data for the Guild Widget Settings object
    * @typedef {Object} GuildWidgetSettings
    * @property {boolean} enabled Whether the widget is enabled
-   * @property {?(TextChannel|NewsChannel|VoiceChannel|StageChannel|ForumChannel)} channel The widget invite channel
+   * @property {?(TextChannel|NewsChannel|VoiceChannel|StageChannel|ForumChannel|MediaChannel)} channel
+   * The widget invite channel
    */
 
   /**
    * The Guild Widget Settings object
    * @typedef {Object} GuildWidgetSettingsData
    * @property {boolean} enabled Whether the widget is enabled
-   * @property {?(TextChannel|NewsChannel|VoiceChannel|StageChannel|ForumChannel|Snowflake)} channel
+   * @property {?(TextChannel|NewsChannel|VoiceChannel|StageChannel|ForumChannel|MediaChannel|Snowflake)} channel
    * The widget invite channel
    */
 
@@ -884,7 +885,8 @@ class Guild extends AnonymousGuild {
    * Welcome channel data
    * @typedef {Object} WelcomeChannelData
    * @property {string} description The description to show for this welcome channel
-   * @property {TextChannel|NewsChannel|ForumChannel|Snowflake} channel The channel to link for this welcome channel
+   * @property {TextChannel|NewsChannel|ForumChannel|MediaChannel|Snowflake} channel
+   * The channel to link for this welcome channel
    * @property {EmojiIdentifierResolvable} [emoji] The emoji to display for this welcome channel
    */
 

diff --git a/packages/discord.js/src/structures/GuildChannel.js b/packages/discord.js/src/structures/GuildChannel.js
@@ -17,6 +17,7 @@ const { getSortableGroupTypes } = require('../util/Util');
  * - {@link NewsChannel}
  * - {@link StageChannel}
  * - {@link ForumChannel}
+ * - {@link MediaChannel}
  * @extends {BaseChannel}
  * @abstract
  */