@velliajs/discord 1.0.0

package/src/client/actions/Action.js

@@ -0,0 +1,119 @@
+'use strict';
+
+const Partials = require('../../util/Partials');
+
+/*
+
+ABOUT ACTIONS
+
+Actions are similar to WebSocket Packet Handlers, but since introducing
+the REST API methods, in order to prevent rewriting code to handle data,
+"actions" have been introduced. They're basically what Packet Handlers
+used to be but they're strictly for manipulating data and making sure
+that WebSocket events don't clash with REST methods.
+
+*/
+
+class GenericAction {
+  constructor(client) {
+    this.client = client;
+  }
+
+  handle(data) {
+    return data;
+  }
+
+  getPayload(data, manager, id, partialType, cache) {
+    const existing = manager.cache.get(id);
+    if (!existing && this.client.options.partials.includes(partialType)) {
+      return manager._add(data, cache);
+    }
+    return existing;
+  }
+
+  getChannel(data) {
+    const id = data.channel_id ?? data.id;
+    return (
+      data[this.client.actions.injectedChannel] ??
+      this.getPayload(
+        {
+          id,
+          guild_id: data.guild_id,
+          recipients: [data.author ?? data.user ?? { id: data.user_id }],
+        },
+        this.client.channels,
+        id,
+        Partials.Channel,
+      )
+    );
+  }
+
+  getMessage(data, channel, cache) {
+    const id = data.message_id ?? data.id;
+    return (
+      data[this.client.actions.injectedMessage] ??
+      this.getPayload(
+        {
+          id,
+          channel_id: channel.id,
+          guild_id: data.guild_id ?? channel.guild?.id,
+        },
+        channel.messages,
+        id,
+        Partials.Message,
+        cache,
+      )
+    );
+  }
+
+  getReaction(data, message, user) {
+    const id = data.emoji.id ?? decodeURIComponent(data.emoji.name);
+    return this.getPayload(
+      {
+        emoji: data.emoji,
+        count: message.partial ? null : 0,
+        me: user?.id === this.client.user.id,
+      },
+      message.reactions,
+      id,
+      Partials.Reaction,
+    );
+  }
+
+  getMember(data, guild) {
+    return this.getPayload(data, guild.members, data.user.id, Partials.GuildMember);
+  }
+
+  getUser(data) {
+    const id = data.user_id;
+    return data[this.client.actions.injectedUser] ?? this.getPayload({ id }, this.client.users, id, Partials.User);
+  }
+
+  getUserFromMember(data) {
+    if (data.guild_id && data.member?.user) {
+      const guild = this.client.guilds.cache.get(data.guild_id);
+      if (guild) {
+        return guild.members._add(data.member).user;
+      } else {
+        return this.client.users._add(data.member.user);
+      }
+    }
+    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,
+      Partials.GuildScheduledEvent,
+    );
+  }
+
+  getThreadMember(id, manager) {
+    return this.getPayload({ user_id: id }, manager, id, Partials.ThreadMember, false);
+  }
+}
+
+module.exports = GenericAction;

package/src/client/actions/ActionsManager.js

@@ -0,0 +1,79 @@
+'use strict';
+
+class ActionsManager {
+  // These symbols represent fully built data that we inject at times when calling actions manually.
+  // Action#getUser, for example, will return the injected data (which is assumed to be a built structure)
+  // instead of trying to make it from provided data
+  injectedUser = Symbol('djs.actions.injectedUser');
+  injectedChannel = Symbol('djs.actions.injectedChannel');
+  injectedMessage = Symbol('djs.actions.injectedMessage');
+
+  constructor(client) {
+    this.client = client;
+
+    this.register(require('./ApplicationCommandPermissionsUpdate'));
+    this.register(require('./AutoModerationActionExecution'));
+    this.register(require('./AutoModerationRuleCreate'));
+    this.register(require('./AutoModerationRuleDelete'));
+    this.register(require('./AutoModerationRuleUpdate'));
+    this.register(require('./ChannelCreate'));
+    this.register(require('./ChannelDelete'));
+    this.register(require('./ChannelUpdate'));
+    this.register(require('./GuildAuditLogEntryCreate'));
+    this.register(require('./GuildBanAdd'));
+    this.register(require('./GuildBanRemove'));
+    this.register(require('./GuildChannelsPositionUpdate'));
+    this.register(require('./GuildDelete'));
+    this.register(require('./GuildEmojiCreate'));
+    this.register(require('./GuildEmojiDelete'));
+    this.register(require('./GuildEmojiUpdate'));
+    this.register(require('./GuildEmojisUpdate'));
+    this.register(require('./GuildIntegrationsUpdate'));
+    this.register(require('./GuildMemberRemove'));
+    this.register(require('./GuildMemberUpdate'));
+    this.register(require('./GuildRoleCreate'));
+    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'));
+    this.register(require('./GuildStickersUpdate'));
+    this.register(require('./GuildUpdate'));
+    this.register(require('./InteractionCreate'));
+    this.register(require('./InviteCreate'));
+    this.register(require('./InviteDelete'));
+    this.register(require('./MessageCreate'));
+    this.register(require('./MessageDelete'));
+    this.register(require('./MessageDeleteBulk'));
+    this.register(require('./MessageReactionAdd'));
+    this.register(require('./MessageReactionRemove'));
+    this.register(require('./MessageReactionRemoveAll'));
+    this.register(require('./MessageReactionRemoveEmoji'));
+    this.register(require('./MessageUpdate'));
+    this.register(require('./PresenceUpdate'));
+    this.register(require('./StageInstanceCreate'));
+    this.register(require('./StageInstanceDelete'));
+    this.register(require('./StageInstanceUpdate'));
+    this.register(require('./ThreadCreate'));
+    this.register(require('./ThreadDelete'));
+    this.register(require('./ThreadListSync'));
+    this.register(require('./ThreadMemberUpdate'));
+    this.register(require('./ThreadMembersUpdate'));
+    this.register(require('./TypingStart'));
+    this.register(require('./UserUpdate'));
+    this.register(require('./VoiceStateUpdate'));
+    this.register(require('./WebhooksUpdate'));
+  }
+
+  register(Action) {
+    this[Action.name.replace(/Action$/, '')] = new Action(this.client);
+  }
+}
+
+module.exports = ActionsManager;

package/src/client/actions/ApplicationCommandPermissionsUpdate.js

@@ -0,0 +1,34 @@
+'use strict';
+
+const Action = require('./Action');
+const Events = require('../../util/Events');
+
+/**
+ * The data received in the {@link Client#event:applicationCommandPermissionsUpdate} event
+ * @typedef {Object} ApplicationCommandPermissionsUpdateData
+ * @property {Snowflake} id The id of the command or global entity that was updated
+ * @property {Snowflake} guildId The id of the guild in which permissions were updated
+ * @property {Snowflake} applicationId The id of the application that owns the command or entity being updated
+ * @property {ApplicationCommandPermissions[]} permissions The updated permissions
+ */
+
+class ApplicationCommandPermissionsUpdateAction extends Action {
+  handle(data) {
+    const client = this.client;
+    /**
+     * Emitted whenever permissions for an application command in a guild were updated.
+     * <warn>This includes permission updates for other applications in addition to the logged in client,
+     * check `data.applicationId` to verify which application the update is for</warn>
+     * @event Client#applicationCommandPermissionsUpdate
+     * @param {ApplicationCommandPermissionsUpdateData} data The updated permissions
+     */
+    client.emit(Events.ApplicationCommandPermissionsUpdate, {
+      permissions: data.permissions,
+      id: data.id,
+      guildId: data.guild_id,
+      applicationId: data.application_id,
+    });
+  }
+}
+
+module.exports = ApplicationCommandPermissionsUpdateAction;

package/src/client/actions/AutoModerationActionExecution.js

@@ -0,0 +1,26 @@
+'use strict';
+
+const Action = require('./Action');
+const AutoModerationActionExecution = require('../../structures/AutoModerationActionExecution');
+const Events = require('../../util/Events');
+
+class AutoModerationActionExecutionAction extends Action {
+  handle(data) {
+    const { client } = this;
+    const guild = client.guilds.cache.get(data.guild_id);
+
+    if (guild) {
+      /**
+       * Emitted whenever an auto moderation rule is triggered.
+       * <info>This event requires the {@link PermissionFlagsBits.ManageGuild} permission.</info>
+       * @event Client#autoModerationActionExecution
+       * @param {AutoModerationActionExecution} autoModerationActionExecution The data of the execution
+       */
+      client.emit(Events.AutoModerationActionExecution, new AutoModerationActionExecution(data, guild));
+    }
+
+    return {};
+  }
+}
+
+module.exports = AutoModerationActionExecutionAction;

package/src/client/actions/AutoModerationRuleCreate.js

@@ -0,0 +1,27 @@
+'use strict';
+
+const Action = require('./Action');
+const Events = require('../../util/Events');
+
+class AutoModerationRuleCreateAction extends Action {
+  handle(data) {
+    const { client } = this;
+    const guild = client.guilds.cache.get(data.guild_id);
+
+    if (guild) {
+      const autoModerationRule = guild.autoModerationRules._add(data);
+
+      /**
+       * Emitted whenever an auto moderation rule is created.
+       * <info>This event requires the {@link PermissionFlagsBits.ManageGuild} permission.</info>
+       * @event Client#autoModerationRuleCreate
+       * @param {AutoModerationRule} autoModerationRule The created auto moderation rule
+       */
+      client.emit(Events.AutoModerationRuleCreate, autoModerationRule);
+    }
+
+    return {};
+  }
+}
+
+module.exports = AutoModerationRuleCreateAction;

package/src/client/actions/AutoModerationRuleDelete.js

@@ -0,0 +1,31 @@
+'use strict';
+
+const Action = require('./Action');
+const Events = require('../../util/Events');
+
+class AutoModerationRuleDeleteAction extends Action {
+  handle(data) {
+    const { client } = this;
+    const guild = client.guilds.cache.get(data.guild_id);
+
+    if (guild) {
+      const autoModerationRule = guild.autoModerationRules.cache.get(data.id);
+
+      if (autoModerationRule) {
+        guild.autoModerationRules.cache.delete(autoModerationRule.id);
+
+        /**
+         * Emitted whenever an auto moderation rule is deleted.
+         * <info>This event requires the {@link PermissionFlagsBits.ManageGuild} permission.</info>
+         * @event Client#autoModerationRuleDelete
+         * @param {AutoModerationRule} autoModerationRule The deleted auto moderation rule
+         */
+        client.emit(Events.AutoModerationRuleDelete, autoModerationRule);
+      }
+    }
+
+    return {};
+  }
+}
+
+module.exports = AutoModerationRuleDeleteAction;

package/src/client/actions/AutoModerationRuleUpdate.js

@@ -0,0 +1,29 @@
+'use strict';
+
+const Action = require('./Action');
+const Events = require('../../util/Events');
+
+class AutoModerationRuleUpdateAction extends Action {
+  handle(data) {
+    const { client } = this;
+    const guild = client.guilds.cache.get(data.guild_id);
+
+    if (guild) {
+      const oldAutoModerationRule = guild.autoModerationRules.cache.get(data.id)?._clone() ?? null;
+      const newAutoModerationRule = guild.autoModerationRules._add(data);
+
+      /**
+       * Emitted whenever an auto moderation rule gets updated.
+       * <info>This event requires the {@link PermissionFlagsBits.ManageGuild} permission.</info>
+       * @event Client#autoModerationRuleUpdate
+       * @param {?AutoModerationRule} oldAutoModerationRule The auto moderation rule before the update
+       * @param {AutoModerationRule} newAutoModerationRule The auto moderation rule after the update
+       */
+      client.emit(Events.AutoModerationRuleUpdate, oldAutoModerationRule, newAutoModerationRule);
+    }
+
+    return {};
+  }
+}
+
+module.exports = AutoModerationRuleUpdateAction;

package/src/client/actions/ChannelCreate.js

@@ -0,0 +1,23 @@
+'use strict';
+
+const Action = require('./Action');
+const Events = require('../../util/Events');
+
+class ChannelCreateAction extends Action {
+  handle(data) {
+    const client = this.client;
+    const existing = client.channels.cache.has(data.id);
+    const channel = client.channels._add(data);
+    if (!existing && channel) {
+      /**
+       * Emitted whenever a guild channel is created.
+       * @event Client#channelCreate
+       * @param {GuildChannel} channel The channel that was created
+       */
+      client.emit(Events.ChannelCreate, channel);
+    }
+    return { channel };
+  }
+}
+
+module.exports = ChannelCreateAction;

package/src/client/actions/ChannelDelete.js

@@ -0,0 +1,23 @@
+'use strict';
+
+const Action = require('./Action');
+const Events = require('../../util/Events');
+
+class ChannelDeleteAction extends Action {
+  handle(data) {
+    const client = this.client;
+    const channel = client.channels.cache.get(data.id);
+
+    if (channel) {
+      client.channels._remove(channel.id);
+      /**
+       * Emitted whenever a channel is deleted.
+       * @event Client#channelDelete
+       * @param {DMChannel|GuildChannel} channel The channel that was deleted
+       */
+      client.emit(Events.ChannelDelete, channel);
+    }
+  }
+}
+
+module.exports = ChannelDeleteAction;

package/src/client/actions/ChannelUpdate.js

@@ -0,0 +1,33 @@
+'use strict';
+
+const Action = require('./Action');
+const { createChannel } = require('../../util/Channels');
+
+class ChannelUpdateAction extends Action {
+  handle(data) {
+    const client = this.client;
+
+    let channel = client.channels.cache.get(data.id);
+    if (channel) {
+      const old = channel._update(data);
+
+      if (channel.type !== data.type) {
+        const newChannel = createChannel(this.client, data, channel.guild);
+        for (const [id, message] of channel.messages.cache) newChannel.messages.cache.set(id, message);
+        channel = newChannel;
+        this.client.channels.cache.set(channel.id, channel);
+      }
+
+      return {
+        old,
+        updated: channel,
+      };
+    } else {
+      client.channels._add(data);
+    }
+
+    return {};
+  }
+}
+
+module.exports = ChannelUpdateAction;

package/src/client/actions/GuildAuditLogEntryCreate.js

@@ -0,0 +1,29 @@
+'use strict';
+
+const Action = require('./Action');
+const GuildAuditLogsEntry = require('../../structures/GuildAuditLogsEntry');
+const Events = require('../../util/Events');
+
+class GuildAuditLogEntryCreateAction extends Action {
+  handle(data) {
+    const client = this.client;
+    const guild = client.guilds.cache.get(data.guild_id);
+    let auditLogEntry;
+
+    if (guild) {
+      auditLogEntry = new GuildAuditLogsEntry(guild, data);
+
+      /**
+       * Emitted whenever a guild audit log entry is created.
+       * @event Client#guildAuditLogEntryCreate
+       * @param {GuildAuditLogsEntry} auditLogEntry The entry that was created
+       * @param {Guild} guild The guild where the entry was created
+       */
+      client.emit(Events.GuildAuditLogEntryCreate, auditLogEntry, guild);
+    }
+
+    return { auditLogEntry };
+  }
+}
+
+module.exports = GuildAuditLogEntryCreateAction;

package/src/client/actions/GuildBanAdd.js

@@ -0,0 +1,20 @@
+'use strict';
+
+const Action = require('./Action');
+const Events = require('../../util/Events');
+
+class GuildBanAdd extends Action {
+  handle(data) {
+    const client = this.client;
+    const guild = client.guilds.cache.get(data.guild_id);
+
+    /**
+     * Emitted whenever a member is banned from a guild.
+     * @event Client#guildBanAdd
+     * @param {GuildBan} ban The ban that occurred
+     */
+    if (guild) client.emit(Events.GuildBanAdd, guild.bans._add(data));
+  }
+}
+
+module.exports = GuildBanAdd;

package/src/client/actions/GuildBanRemove.js

@@ -0,0 +1,25 @@
+'use strict';
+
+const Action = require('./Action');
+const GuildBan = require('../../structures/GuildBan');
+const Events = require('../../util/Events');
+
+class GuildBanRemove extends Action {
+  handle(data) {
+    const client = this.client;
+    const guild = client.guilds.cache.get(data.guild_id);
+
+    /**
+     * Emitted whenever a member is unbanned from a guild.
+     * @event Client#guildBanRemove
+     * @param {GuildBan} ban The ban that was removed
+     */
+    if (guild) {
+      const ban = guild.bans.cache.get(data.user.id) ?? new GuildBan(client, data, guild);
+      guild.bans.cache.delete(ban.user.id);
+      client.emit(Events.GuildBanRemove, ban);
+    }
+  }
+}
+
+module.exports = GuildBanRemove;

package/src/client/actions/GuildChannelsPositionUpdate.js

@@ -0,0 +1,21 @@
+'use strict';
+
+const Action = require('./Action');
+
+class GuildChannelsPositionUpdate extends Action {
+  handle(data) {
+    const client = this.client;
+
+    const guild = client.guilds.cache.get(data.guild_id);
+    if (guild) {
+      for (const partialChannel of data.channels) {
+        const channel = guild.channels.cache.get(partialChannel.id);
+        if (channel) channel.rawPosition = partialChannel.position;
+      }
+    }
+
+    return { guild };
+  }
+}
+
+module.exports = GuildChannelsPositionUpdate;

package/src/client/actions/GuildDelete.js

@@ -0,0 +1,44 @@
+'use strict';
+
+const Action = require('./Action');
+const Events = require('../../util/Events');
+
+class GuildDeleteAction extends Action {
+  handle(data) {
+    const client = this.client;
+
+    let guild = client.guilds.cache.get(data.id);
+    if (guild) {
+      if (data.unavailable) {
+        // Guild is unavailable
+        guild.available = false;
+
+        /**
+         * Emitted whenever a guild becomes unavailable, likely due to a server outage.
+         * @event Client#guildUnavailable
+         * @param {Guild} guild The guild that has become unavailable
+         */
+        client.emit(Events.GuildUnavailable, guild);
+
+        // Stops the GuildDelete packet thinking a guild was actually deleted,
+        // handles emitting of event itself
+        return;
+      }
+
+      for (const channel of guild.channels.cache.values()) this.client.channels._remove(channel.id);
+      client.voice.adapters.get(data.id)?.destroy();
+
+      // Delete guild
+      client.guilds.cache.delete(guild.id);
+
+      /**
+       * Emitted whenever a guild kicks the client or the guild is deleted/left.
+       * @event Client#guildDelete
+       * @param {Guild} guild The guild that was deleted
+       */
+      client.emit(Events.GuildDelete, guild);
+    }
+  }
+}
+
+module.exports = GuildDeleteAction;

package/src/client/actions/GuildEmojiCreate.js

@@ -0,0 +1,20 @@
+'use strict';
+
+const Action = require('./Action');
+const Events = require('../../util/Events');
+
+class GuildEmojiCreateAction extends Action {
+  handle(guild, createdEmoji) {
+    const already = guild.emojis.cache.has(createdEmoji.id);
+    const emoji = guild.emojis._add(createdEmoji);
+    /**
+     * Emitted whenever a custom emoji is created in a guild.
+     * @event Client#emojiCreate
+     * @param {GuildEmoji} emoji The emoji that was created
+     */
+    if (!already) this.client.emit(Events.GuildEmojiCreate, emoji);
+    return { emoji };
+  }
+}
+
+module.exports = GuildEmojiCreateAction;

package/src/client/actions/GuildEmojiDelete.js

@@ -0,0 +1,19 @@
+'use strict';
+
+const Action = require('./Action');
+const Events = require('../../util/Events');
+
+class GuildEmojiDeleteAction extends Action {
+  handle(emoji) {
+    emoji.guild.emojis.cache.delete(emoji.id);
+    /**
+     * Emitted whenever a custom emoji is deleted in a guild.
+     * @event Client#emojiDelete
+     * @param {GuildEmoji} emoji The emoji that was deleted
+     */
+    this.client.emit(Events.GuildEmojiDelete, emoji);
+    return { emoji };
+  }
+}
+
+module.exports = GuildEmojiDeleteAction;

package/src/client/actions/GuildEmojiUpdate.js

@@ -0,0 +1,20 @@
+'use strict';
+
+const Action = require('./Action');
+const Events = require('../../util/Events');
+
+class GuildEmojiUpdateAction extends Action {
+  handle(current, data) {
+    const old = current._update(data);
+    /**
+     * Emitted whenever a custom emoji is updated in a guild.
+     * @event Client#emojiUpdate
+     * @param {GuildEmoji} oldEmoji The old emoji
+     * @param {GuildEmoji} newEmoji The new emoji
+     */
+    this.client.emit(Events.GuildEmojiUpdate, old, current);
+    return { emoji: current };
+  }
+}
+
+module.exports = GuildEmojiUpdateAction;

package/src/client/actions/GuildEmojisUpdate.js

@@ -0,0 +1,34 @@
+'use strict';
+
+const Action = require('./Action');
+
+class GuildEmojisUpdateAction extends Action {
+  handle(data) {
+    const guild = this.client.guilds.cache.get(data.guild_id);
+    if (!guild?.emojis) return;
+
+    const deletions = new Map(guild.emojis.cache);
+
+    for (const emoji of data.emojis) {
+      // Determine type of emoji event
+      const cachedEmoji = guild.emojis.cache.get(emoji.id);
+      if (cachedEmoji) {
+        deletions.delete(emoji.id);
+        if (!cachedEmoji.equals(emoji)) {
+          // Emoji updated
+          this.client.actions.GuildEmojiUpdate.handle(cachedEmoji, emoji);
+        }
+      } else {
+        // Emoji added
+        this.client.actions.GuildEmojiCreate.handle(guild, emoji);
+      }
+    }
+
+    for (const emoji of deletions.values()) {
+      // Emoji deleted
+      this.client.actions.GuildEmojiDelete.handle(emoji);
+    }
+  }
+}
+
+module.exports = GuildEmojisUpdateAction;