feat: add support for GuildScheduledEvent (#6493)

Co-authored-by: Rodry <38259440+ImRodry@users.noreply.github.com>
Co-authored-by: Sugden <28943913+NotSugden@users.noreply.github.com>
Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com>
Co-authored-by: GoldenAngel <50855202+GoldenAngel2@users.noreply.github.com>
Co-authored-by: Vlad Frangu <kingdgrizzle@gmail.com>
Co-authored-by: Antonio Román <kyradiscord@gmail.com>
Co-authored-by: SpaceEEC <spaceeec@yahoo.com>

src/client/Client.js

@@ -283,18 +283,28 @@ class Client extends BaseClient {
     this.token = null;
   }
 
+  /**
+   * Options used when fetching an invite from Discord.
+   * @typedef {Object} ClientFetchInviteOptions
+   * @property {Snowflake} [guildScheduledEventId] The id of the guild scheduled event to include with
+   * the invite
+   */
+
   /**
    * Obtains an invite from Discord.
    * @param {InviteResolvable} invite Invite code or URL
+   * @param {ClientFetchInviteOptions} [options] Options for fetching the invite
    * @returns {Promise<Invite>}
    * @example
    * client.fetchInvite('https://discord.gg/djs')
    *   .then(invite => console.log(`Obtained invite with code: ${invite.code}`))
    *   .catch(console.error);
    */
-  async fetchInvite(invite) {
+  async fetchInvite(invite, options) {
     const code = DataResolver.resolveInviteCode(invite);
-    const data = await this.api.invites(code).get({ query: { with_counts: true, with_expiration: true } });
+    const data = await this.api.invites(code).get({
+      query: { with_counts: true, with_expiration: true, guild_scheduled_event_id: options?.guildScheduledEventId },
+    });
     return new Invite(this, data);
   }
 

src/client/actions/Action.js

@@ -100,6 +100,16 @@ class GenericAction {
     }
     return this.getUser(data);
   }
+
+  getScheduledEvent(data, guild) {
+    const id = data.guild_scheduled_event_id ?? data.id;
+    return this.getPayload(
+      { id, guild_id: data.guild_id ?? guild.id },
+      guild.scheduledEvents,
+      id,
+      PartialTypes.GUILD_SCHEDULED_EVENT,
+    );
+  }
 }
 
 module.exports = GenericAction;

src/client/actions/ActionsManager.js

@@ -22,6 +22,11 @@ class ActionsManager {
     this.register(require('./GuildRoleDelete'));
     this.register(require('./GuildRoleUpdate'));
     this.register(require('./GuildRolesPositionUpdate'));
+    this.register(require('./GuildScheduledEventCreate'));
+    this.register(require('./GuildScheduledEventDelete'));
+    this.register(require('./GuildScheduledEventUpdate'));
+    this.register(require('./GuildScheduledEventUserAdd'));
+    this.register(require('./GuildScheduledEventUserRemove'));
     this.register(require('./GuildStickerCreate'));
     this.register(require('./GuildStickerDelete'));
     this.register(require('./GuildStickerUpdate'));

src/client/actions/GuildScheduledEventCreate.js

@@ -0,0 +1,27 @@
+'use strict';
+
+const Action = require('./Action');
+const { Events } = require('../../util/Constants');
+
+class GuildScheduledEventCreateAction extends Action {
+  handle(data) {
+    const client = this.client;
+    const guild = client.guilds.cache.get(data.guild_id);
+    if (guild) {
+      const guildScheduledEvent = guild.scheduledEvents._add(data);
+
+      /**
+       * Emitted whenever a guild scheduled event is created.
+       * @event Client#guildScheduledEventCreate
+       * @param {GuildScheduledEvent} guildScheduledEvent The created guild scheduled event
+       */
+      client.emit(Events.GUILD_SCHEDULED_EVENT_CREATE, guildScheduledEvent);
+
+      return { guildScheduledEvent };
+    }
+
+    return {};
+  }
+}
+
+module.exports = GuildScheduledEventCreateAction;

src/client/actions/GuildScheduledEventDelete.js

@@ -0,0 +1,31 @@
+'use strict';
+
+const Action = require('./Action');
+const { Events } = require('../../util/Constants');
+
+class GuildScheduledEventDeleteAction extends Action {
+  handle(data) {
+    const client = this.client;
+    const guild = client.guilds.cache.get(data.guild_id);
+
+    if (guild) {
+      const guildScheduledEvent = this.getScheduledEvent(data, guild);
+      if (guildScheduledEvent) {
+        guild.scheduledEvents.cache.delete(guildScheduledEvent.id);
+
+        /**
+         * Emitted whenever a guild scheduled event is deleted.
+         * @event Client#guildScheduledEventDelete
+         * @param {GuildScheduledEvent} guildScheduledEvent The deleted guild scheduled event
+         */
+        client.emit(Events.GUILD_SCHEDULED_EVENT_DELETE, guildScheduledEvent);
+
+        return { guildScheduledEvent };
+      }
+    }
+
+    return {};
+  }
+}
+
+module.exports = GuildScheduledEventDeleteAction;

src/client/actions/GuildScheduledEventUpdate.js

@@ -0,0 +1,30 @@
+'use strict';
+
+const Action = require('./Action');
+const { Events } = require('../../util/Constants');
+
+class GuildScheduledEventUpdateAction extends Action {
+  handle(data) {
+    const client = this.client;
+    const guild = client.guilds.cache.get(data.guild_id);
+
+    if (guild) {
+      const oldGuildScheduledEvent = guild.scheduledEvents.cache.get(data.id)?._clone() ?? null;
+      const newGuildScheduledEvent = guild.scheduledEvents._add(data);
+
+      /**
+       * Emitted whenever a guild scheduled event gets updated.
+       * @event Client#guildScheduledEventUpdate
+       * @param {?GuildScheduledEvent} oldGuildScheduledEvent The guild scheduled event object before the update
+       * @param {GuildScheduledEvent} newGuildScheduledEvent The guild scheduled event object after the update
+       */
+      client.emit(Events.GUILD_SCHEDULED_EVENT_UPDATE, oldGuildScheduledEvent, newGuildScheduledEvent);
+
+      return { oldGuildScheduledEvent, newGuildScheduledEvent };
+    }
+
+    return {};
+  }
+}
+
+module.exports = GuildScheduledEventUpdateAction;

src/client/actions/GuildScheduledEventUserAdd.js

@@ -0,0 +1,32 @@
+'use strict';
+
+const Action = require('./Action');
+const { Events } = require('../../util/Constants');
+
+class GuildScheduledEventUserAddAction extends Action {
+  handle(data) {
+    const client = this.client;
+    const guild = client.guilds.cache.get(data.guild_id);
+
+    if (guild) {
+      const guildScheduledEvent = this.getScheduledEvent(data, guild);
+      const user = this.getUser(data);
+
+      if (guildScheduledEvent && user) {
+        /**
+         * Emitted whenever a user subscribes to a guild scheduled event
+         * @event Client#guildScheduledEventUserAdd
+         * @param {GuildScheduledEvent} guildScheduledEvent The guild scheduled event
+         * @param {User} user The user who subscribed
+         */
+        client.emit(Events.GUILD_SCHEDULED_EVENT_USER_ADD, guildScheduledEvent, user);
+
+        return { guildScheduledEvent, user };
+      }
+    }
+
+    return {};
+  }
+}
+
+module.exports = GuildScheduledEventUserAddAction;

src/client/actions/GuildScheduledEventUserRemove.js

@@ -0,0 +1,32 @@
+'use strict';
+
+const Action = require('./Action');
+const { Events } = require('../../util/Constants');
+
+class GuildScheduledEventUserRemoveAction extends Action {
+  handle(data) {
+    const client = this.client;
+    const guild = client.guilds.cache.get(data.guild_id);
+
+    if (guild) {
+      const guildScheduledEvent = this.getScheduledEvent(data, guild);
+      const user = this.getUser(data);
+
+      if (guildScheduledEvent && user) {
+        /**
+         * Emitted whenever a user unsubscribes from a guild scheduled event
+         * @event Client#guildScheduledEventUserRemove
+         * @param {GuildScheduledEvent} guildScheduledEvent The guild scheduled event
+         * @param {User} user The user who unsubscribed
+         */
+        client.emit(Events.GUILD_SCHEDULED_EVENT_USER_REMOVE, guildScheduledEvent, user);
+
+        return { guildScheduledEvent, user };
+      }
+    }
+
+    return {};
+  }
+}
+
+module.exports = GuildScheduledEventUserRemoveAction;

src/client/websocket/handlers/GUILD_SCHEDULED_EVENT_CREATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildScheduledEventCreate.handle(packet.d);
+};

src/client/websocket/handlers/GUILD_SCHEDULED_EVENT_DELETE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildScheduledEventDelete.handle(packet.d);
+};

src/client/websocket/handlers/GUILD_SCHEDULED_EVENT_UPDATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildScheduledEventUpdate.handle(packet.d);
+};

src/client/websocket/handlers/GUILD_SCHEDULED_EVENT_USER_ADD.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildScheduledEventUserAdd.handle(packet.d);
+};

src/client/websocket/handlers/GUILD_SCHEDULED_EVENT_USER_REMOVE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildScheduledEventUserRemove.handle(packet.d);
+};

src/client/websocket/handlers/index.js

@@ -51,6 +51,11 @@ const handlers = Object.fromEntries([
   ['STAGE_INSTANCE_UPDATE', require('./STAGE_INSTANCE_UPDATE')],
   ['STAGE_INSTANCE_DELETE', require('./STAGE_INSTANCE_DELETE')],
   ['GUILD_STICKERS_UPDATE', require('./GUILD_STICKERS_UPDATE')],
+  ['GUILD_SCHEDULED_EVENT_CREATE', require('./GUILD_SCHEDULED_EVENT_CREATE')],
+  ['GUILD_SCHEDULED_EVENT_UPDATE', require('./GUILD_SCHEDULED_EVENT_UPDATE')],
+  ['GUILD_SCHEDULED_EVENT_DELETE', require('./GUILD_SCHEDULED_EVENT_DELETE')],
+  ['GUILD_SCHEDULED_EVENT_USER_ADD', require('./GUILD_SCHEDULED_EVENT_USER_ADD')],
+  ['GUILD_SCHEDULED_EVENT_USER_REMOVE', require('./GUILD_SCHEDULED_EVENT_USER_REMOVE')],
 ]);
 
 module.exports = handlers;