refactor!: Invite classes (#10888)

BREAKING CHANGE: Invites are now split up into classes based on their type.

Author: Jiralite

packages/discord.js/src/client/Client.js

@@ -14,7 +14,6 @@ const { ShardClientUtil } = require('../sharding/ShardClientUtil.js');
 const { ClientPresence } = require('../structures/ClientPresence.js');
 const { GuildPreview } = require('../structures/GuildPreview.js');
 const { GuildTemplate } = require('../structures/GuildTemplate.js');
-const { Invite } = require('../structures/Invite.js');
 const { SoundboardSound } = require('../structures/SoundboardSound.js');
 const { Sticker } = require('../structures/Sticker.js');
 const { StickerPack } = require('../structures/StickerPack.js');
@@ -24,6 +23,7 @@ const { Widget } = require('../structures/Widget.js');
 const { resolveInviteCode, resolveGuildTemplateCode } = require('../util/DataResolver.js');
 const { Events } = require('../util/Events.js');
 const { IntentsBitField } = require('../util/IntentsBitField.js');
+const { createInvite } = require('../util/Invites.js');
 const { Options } = require('../util/Options.js');
 const { PermissionsBitField } = require('../util/PermissionsBitField.js');
 const { Status } = require('../util/Status.js');
@@ -459,6 +459,7 @@ class Client extends BaseClient {
    * Options used when fetching an invite from Discord.
    *
    * @typedef {Object} ClientFetchInviteOptions
+   * @property {boolean} [withCounts] Whether to include approximate member counts
    * @property {Snowflake} [guildScheduledEventId] The id of the guild scheduled event to include with
    * the invite
    */
@@ -474,14 +475,16 @@ class Client extends BaseClient {
    *   .then(invite => console.log(`Obtained invite with code: ${invite.code}`))
    *   .catch(console.error);
    */
-  async fetchInvite(invite, options) {
+  async fetchInvite(invite, { withCounts, guildScheduledEventId } = {}) {
     const code = resolveInviteCode(invite);
+
     const query = makeURLSearchParams({
-      with_counts: true,
-      guild_scheduled_event_id: options?.guildScheduledEventId,
+      with_counts: withCounts,
+      guild_scheduled_event_id: guildScheduledEventId,
     });
+
     const data = await this.rest.get(Routes.invite(code), { query });
-    return new Invite(this, data);
+    return createInvite(this, data);
   }
 
   /**

packages/discord.js/src/client/websocket/handlers/INVITE_CREATE.js

@@ -15,7 +15,7 @@ module.exports = (client, { d: data }) => {
    * <info>This event requires the {@link PermissionFlagsBits.ManageChannels} permission for the channel.</info>
    *
    * @event Client#inviteCreate
-   * @param {Invite} invite The invite that was created
+   * @param {GuildInvite} invite The invite that was created
    */
   client.emit(Events.InviteCreate, invite);
 };

packages/discord.js/src/client/websocket/handlers/INVITE_DELETE.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { Invite } = require('../../../structures/Invite.js');
+const { GuildInvite } = require('../../../structures/GuildInvite.js');
 const { Events } = require('../../../util/Events.js');
 
 module.exports = (client, { d: data }) => {
@@ -9,7 +9,7 @@ module.exports = (client, { d: data }) => {
   if (!channel) return;
 
   const inviteData = Object.assign(data, { channel, guild });
-  const invite = new Invite(client, inviteData);
+  const invite = new GuildInvite(client, inviteData);
 
   guild.invites.cache.delete(invite.code);
 
@@ -18,7 +18,7 @@ module.exports = (client, { d: data }) => {
    * <info>This event requires the {@link PermissionFlagsBits.ManageChannels} permission for the channel.</info>
    *
    * @event Client#inviteDelete
-   * @param {Invite} invite The invite that was deleted
+   * @param {GuildInvite} invite The invite that was deleted
    */
   client.emit(Events.InviteDelete, invite);
 };

packages/discord.js/src/index.js

@@ -124,6 +124,7 @@ exports.BaseGuildEmoji = require('./structures/BaseGuildEmoji.js').BaseGuildEmoj
 exports.BaseGuildTextChannel = require('./structures/BaseGuildTextChannel.js').BaseGuildTextChannel;
 exports.BaseGuildVoiceChannel = require('./structures/BaseGuildVoiceChannel.js').BaseGuildVoiceChannel;
 exports.BaseInteraction = require('./structures/BaseInteraction.js').BaseInteraction;
+exports.BaseInvite = require('./structures/BaseInvite.js').BaseInvite;
 exports.BaseSelectMenuComponent = require('./structures/BaseSelectMenuComponent.js').BaseSelectMenuComponent;
 exports.ButtonComponent = require('./structures/ButtonComponent.js').ButtonComponent;
 exports.ButtonInteraction = require('./structures/ButtonInteraction.js').ButtonInteraction;
@@ -151,12 +152,14 @@ exports.Emoji = require('./structures/Emoji.js').Emoji;
 exports.Entitlement = require('./structures/Entitlement.js').Entitlement;
 exports.FileComponent = require('./structures/FileComponent.js').FileComponent;
 exports.ForumChannel = require('./structures/ForumChannel.js').ForumChannel;
+exports.GroupDMInvite = require('./structures/GroupDMInvite.js').GroupDMInvite;
 exports.Guild = require('./structures/Guild.js').Guild;
 exports.GuildAuditLogs = require('./structures/GuildAuditLogs.js').GuildAuditLogs;
 exports.GuildAuditLogsEntry = require('./structures/GuildAuditLogsEntry.js').GuildAuditLogsEntry;
 exports.GuildBan = require('./structures/GuildBan.js').GuildBan;
 exports.GuildChannel = require('./structures/GuildChannel.js').GuildChannel;
 exports.GuildEmoji = require('./structures/GuildEmoji.js').GuildEmoji;
+exports.GuildInvite = require('./structures/GuildInvite.js').GuildInvite;
 exports.GuildMember = require('./structures/GuildMember.js').GuildMember;
 exports.GuildOnboarding = require('./structures/GuildOnboarding.js').GuildOnboarding;
 exports.GuildOnboardingPrompt = require('./structures/GuildOnboardingPrompt.js').GuildOnboardingPrompt;
@@ -175,7 +178,6 @@ exports.InteractionCallbackResponse =
   require('./structures/InteractionCallbackResponse.js').InteractionCallbackResponse;
 exports.InteractionCollector = require('./structures/InteractionCollector.js').InteractionCollector;
 exports.InteractionWebhook = require('./structures/InteractionWebhook.js').InteractionWebhook;
-exports.Invite = require('./structures/Invite.js').Invite;
 exports.InviteGuild = require('./structures/InviteGuild.js').InviteGuild;
 exports.MediaChannel = require('./structures/MediaChannel.js').MediaChannel;
 exports.MediaGalleryComponent = require('./structures/MediaGalleryComponent.js').MediaGalleryComponent;

packages/discord.js/src/managers/GuildInviteManager.js

@@ -3,7 +3,7 @@
 const { Collection } = require('@discordjs/collection');
 const { Routes } = require('discord-api-types/v10');
 const { DiscordjsError, ErrorCodes } = require('../errors/index.js');
-const { Invite } = require('../structures/Invite.js');
+const { GuildInvite } = require('../structures/GuildInvite.js');
 const { resolveInviteCode } = require('../util/DataResolver.js');
 const { CachedManager } = require('./CachedManager.js');
 
@@ -14,7 +14,7 @@ const { CachedManager } = require('./CachedManager.js');
  */
 class GuildInviteManager extends CachedManager {
   constructor(guild, iterable) {
-    super(guild.client, Invite, iterable);
+    super(guild.client, GuildInvite, iterable);
 
     /**
      * The guild this Manager belongs to
@@ -27,7 +27,7 @@ class GuildInviteManager extends CachedManager {
   /**
    * The cache of this Manager
    *
-   * @type {Collection<string, Invite>}
+   * @type {Collection<string, GuildInvite>}
    * @name GuildInviteManager#cache
    */
 
@@ -36,35 +36,44 @@ class GuildInviteManager extends CachedManager {
   }
 
   /**
-   * Data that resolves to give an Invite object. This can be:
+   * Data that resolves to give a `GuildInvite`. This can be:
+   *
    * - An invite code
    * - An invite URL
    *
-   * @typedef {string} InviteResolvable
+   * @typedef {string} GuildInviteResolvable
    */
 
   /**
-   * Data that can be resolved to a channel that an invite can be created on. This can be:
+   * A guild channel where an invite may be created on. This can be:
    * - TextChannel
    * - VoiceChannel
    * - AnnouncementChannel
    * - StageChannel
    * - ForumChannel
    * - MediaChannel
+   *
+   * @typedef {TextChannel|VoiceChannel|AnnouncementChannel|StageChannel|ForumChannel|MediaChannel}
+   * GuildInvitableChannel
+   */
+
+  /**
+   * Data that can be resolved to a guild channel where an invite may be created on. This can be:
+   * - GuildInvitableChannel
    * - Snowflake
    *
-   * @typedef {TextChannel|VoiceChannel|AnnouncementChannel|StageChannel|ForumChannel|MediaChannel|Snowflake}
+   * @typedef {GuildInvitableChannel|Snowflake}
    * GuildInvitableChannelResolvable
    */
 
   /**
-   * Resolves an InviteResolvable to an Invite object.
+   * Resolves an `GuildInviteResolvable` to a `GuildInvite` object.
    *
    * @method resolve
    * @memberof GuildInviteManager
    * @instance
-   * @param {InviteResolvable} invite The invite resolvable to resolve
-   * @returns {?Invite}
+   * @param {GuildInviteResolvable} invite The invite resolvable to resolve
+   * @returns {?GuildInvite}
    */
 
   /**
@@ -98,8 +107,9 @@ class GuildInviteManager extends CachedManager {
   /**
    * Fetches invite(s) from Discord.
    *
-   * @param {InviteResolvable|FetchInviteOptions|FetchInvitesOptions} [options] Options for fetching guild invite(s)
-   * @returns {Promise<Invite|Collection<string, Invite>>}
+   * @param {GuildInviteResolvable|FetchInviteOptions|FetchInvitesOptions} [options]
+   * Options for fetching guild invite(s)
+   * @returns {Promise<GuildInvite|Collection<string, GuildInvite>>}
    * @example
    * // Fetch all invites from a guild
    * guild.invites.fetch()
@@ -183,7 +193,7 @@ class GuildInviteManager extends CachedManager {
    *
    * @param {GuildInvitableChannelResolvable} channel The options for creating the invite from a channel.
    * @param {InviteCreateOptions} [options={}] The options for creating the invite from a channel.
-   * @returns {Promise<Invite>}
+   * @returns {Promise<GuildInvite>}
    * @example
    * // Create an invite to a selected channel
    * guild.invites.create('599942732013764608')
@@ -209,7 +219,7 @@ class GuildInviteManager extends CachedManager {
       },
       reason,
     });
-    return new Invite(this.client, invite);
+    return new GuildInvite(this.client, invite);
   }
 
   /**

packages/discord.js/src/managers/GuildManager.js

@@ -10,8 +10,8 @@ const { ShardClientUtil } = require('../sharding/ShardClientUtil.js');
 const { Guild } = require('../structures/Guild.js');
 const { GuildChannel } = require('../structures/GuildChannel.js');
 const { GuildEmoji } = require('../structures/GuildEmoji.js');
+const { GuildInvite } = require('../structures/GuildInvite.js');
 const { GuildMember } = require('../structures/GuildMember.js');
-const { Invite } = require('../structures/Invite.js');
 const { OAuth2Guild } = require('../structures/OAuth2Guild.js');
 const { Role } = require('../structures/Role.js');
 const { resolveImage } = require('../util/DataResolver.js');
@@ -119,7 +119,7 @@ class GuildManager extends CachedManager {
       guild instanceof GuildMember ||
       guild instanceof GuildEmoji ||
       guild instanceof Role ||
-      (guild instanceof Invite && guild.guild)
+      (guild instanceof GuildInvite && guild.guild)
     ) {
       return super.resolve(guild.guild);
     }
@@ -142,7 +142,7 @@ class GuildManager extends CachedManager {
       guild instanceof GuildMember ||
       guild instanceof GuildEmoji ||
       guild instanceof Role ||
-      (guild instanceof Invite && guild.guild)
+      (guild instanceof GuildInvite && guild.guild)
     ) {
       return super.resolveId(guild.guild.id);
     }