discord.js-seflbot-v13 1.1.0

package/src/structures/Interaction.js

@@ -0,0 +1,351 @@
+'use strict';
+
+const Base = require('./Base');
+const { InteractionTypes, MessageComponentTypes, ApplicationCommandTypes } = require('../util/Constants');
+const Permissions = require('../util/Permissions');
+const SnowflakeUtil = require('../util/SnowflakeUtil');
+
+/**
+ * Represents an interaction.
+ * @extends {Base}
+ */
+class Interaction extends Base {
+  constructor(client, data) {
+    super(client);
+
+    /**
+     * The interaction's type
+     * @type {InteractionType}
+     */
+    this.type = InteractionTypes[data.type];
+
+    /**
+     * The interaction's id
+     * @type {Snowflake}
+     */
+    this.id = data.id;
+
+    /**
+     * The interaction's token
+     * @type {string}
+     * @name Interaction#token
+     * @readonly
+     */
+    Object.defineProperty(this, 'token', { value: data.token });
+
+    /**
+     * The application's id
+     * @type {Snowflake}
+     */
+    this.applicationId = data.application_id;
+
+    /**
+     * The id of the channel this interaction was sent in
+     * @type {?Snowflake}
+     */
+    this.channelId = data.channel_id ?? null;
+
+    /**
+     * The id of the guild this interaction was sent in
+     * @type {?Snowflake}
+     */
+    this.guildId = data.guild_id ?? null;
+
+    /**
+     * The user which sent this interaction
+     * @type {User}
+     */
+    this.user = this.client.users._add(data.user ?? data.member.user);
+
+    /**
+     * If this interaction was sent in a guild, the member which sent it
+     * @type {?(GuildMember|APIGuildMember)}
+     */
+    this.member = data.member ? this.guild?.members._add(data.member) ?? data.member : null;
+
+    /**
+     * The version
+     * @type {number}
+     */
+    this.version = data.version;
+
+    /**
+     * Set of permissions the application or bot has within the channel the interaction was sent from
+     * @type {?Readonly<Permissions>}
+     */
+    this.appPermissions = data.app_permissions ? new Permissions(data.app_permissions).freeze() : null;
+
+    /**
+     * The permissions of the member, if one exists, in the channel this interaction was executed in
+     * @type {?Readonly<Permissions>}
+     */
+    this.memberPermissions = data.member?.permissions ? new Permissions(data.member.permissions).freeze() : null;
+
+    /**
+     * A Discord locale string, possible values are:
+     * * en-US (English, US)
+     * * en-GB (English, UK)
+     * * bg (Bulgarian)
+     * * zh-CN (Chinese, China)
+     * * zh-TW (Chinese, Taiwan)
+     * * hr (Croatian)
+     * * cs (Czech)
+     * * da (Danish)
+     * * nl (Dutch)
+     * * fi (Finnish)
+     * * fr (French)
+     * * de (German)
+     * * el (Greek)
+     * * hi (Hindi)
+     * * hu (Hungarian)
+     * * it (Italian)
+     * * ja (Japanese)
+     * * ko (Korean)
+     * * lt (Lithuanian)
+     * * no (Norwegian)
+     * * pl (Polish)
+     * * pt-BR (Portuguese, Brazilian)
+     * * ro (Romanian, Romania)
+     * * ru (Russian)
+     * * es-ES (Spanish)
+     * * sv-SE (Swedish)
+     * * th (Thai)
+     * * tr (Turkish)
+     * * uk (Ukrainian)
+     * * vi (Vietnamese)
+     * @see {@link https://discord.com/developers/docs/reference#locales}
+     * @typedef {string} Locale
+     */
+
+    /**
+     * The locale of the user who invoked this interaction
+     * @type {Locale}
+     */
+    this.locale = data.locale;
+
+    /**
+     * The preferred locale from the guild this interaction was sent in
+     * @type {?Locale}
+     */
+    this.guildLocale = data.guild_locale ?? null;
+  }
+
+  /**
+   * The timestamp the interaction was created at
+   * @type {number}
+   * @readonly
+   */
+  get createdTimestamp() {
+    return SnowflakeUtil.timestampFrom(this.id);
+  }
+
+  /**
+   * The time the interaction was created at
+   * @type {Date}
+   * @readonly
+   */
+  get createdAt() {
+    return new Date(this.createdTimestamp);
+  }
+
+  /**
+   * The channel this interaction was sent in
+   * @type {?TextBasedChannels}
+   * @readonly
+   */
+  get channel() {
+    return this.client.channels.cache.get(this.channelId) ?? null;
+  }
+
+  /**
+   * The guild this interaction was sent in
+   * @type {?Guild}
+   * @readonly
+   */
+  get guild() {
+    return this.client.guilds.cache.get(this.guildId) ?? null;
+  }
+
+  /**
+   * Indicates whether this interaction is received from a guild.
+   * @returns {boolean}
+   */
+  inGuild() {
+    return Boolean(this.guildId && this.member);
+  }
+
+  /**
+   * Indicates whether or not this interaction is both cached and received from a guild.
+   * @returns {boolean}
+   */
+  inCachedGuild() {
+    return Boolean(this.guild && this.member);
+  }
+
+  /**
+   * Indicates whether or not this interaction is received from an uncached guild.
+   * @returns {boolean}
+   */
+  inRawGuild() {
+    return Boolean(this.guildId && !this.guild && this.member);
+  }
+
+  /**
+   * Indicates whether this interaction is a {@link BaseCommandInteraction}.
+   * @returns {boolean}
+   */
+  isApplicationCommand() {
+    return InteractionTypes[this.type] === InteractionTypes.APPLICATION_COMMAND;
+  }
+
+  /**
+   * Indicates whether this interaction is a {@link CommandInteraction}.
+   * @returns {boolean}
+   */
+  isCommand() {
+    return InteractionTypes[this.type] === InteractionTypes.APPLICATION_COMMAND && typeof this.targetId === 'undefined';
+  }
+
+  /**
+   * Indicates whether this interaction is a {@link ContextMenuInteraction}
+   * @returns {boolean}
+   */
+  isContextMenu() {
+    return InteractionTypes[this.type] === InteractionTypes.APPLICATION_COMMAND && typeof this.targetId !== 'undefined';
+  }
+
+  /**
+   * Indicates whether this interaction is a {@link ModalSubmitInteraction}
+   * @returns {boolean}
+   */
+  isModalSubmit() {
+    return InteractionTypes[this.type] === InteractionTypes.MODAL_SUBMIT;
+  }
+
+  /**
+   * Indicates whether this interaction is a {@link UserContextMenuInteraction}
+   * @returns {boolean}
+   */
+  isUserContextMenu() {
+    return this.isContextMenu() && ApplicationCommandTypes[this.targetType] === ApplicationCommandTypes.USER;
+  }
+
+  /**
+   * Indicates whether this interaction is a {@link MessageContextMenuInteraction}
+   * @returns {boolean}
+   */
+  isMessageContextMenu() {
+    return this.isContextMenu() && ApplicationCommandTypes[this.targetType] === ApplicationCommandTypes.MESSAGE;
+  }
+
+  /**
+   * Indicates whether this interaction is an {@link AutocompleteInteraction}
+   * @returns {boolean}
+   */
+  isAutocomplete() {
+    return InteractionTypes[this.type] === InteractionTypes.APPLICATION_COMMAND_AUTOCOMPLETE;
+  }
+
+  /**
+   * Indicates whether this interaction is a {@link MessageComponentInteraction}.
+   * @returns {boolean}
+   */
+  isMessageComponent() {
+    return InteractionTypes[this.type] === InteractionTypes.MESSAGE_COMPONENT;
+  }
+
+  /**
+   * Indicates whether this interaction is a {@link ButtonInteraction}.
+   * @returns {boolean}
+   */
+  isButton() {
+    return (
+      InteractionTypes[this.type] === InteractionTypes.MESSAGE_COMPONENT &&
+      MessageComponentTypes[this.componentType] === MessageComponentTypes.BUTTON
+    );
+  }
+
+  /**
+   * Indicates whether this interaction is a {@link SelectMenuInteraction}.
+   * @returns {boolean}
+   */
+  isAnySelectMenu() {
+    return InteractionTypes[this.type] === InteractionTypes.MESSAGE_COMPONENT && typeof this.values !== 'undefined';
+  }
+
+  /**
+   * Indicates whether this interaction is a {@link SelectMenuInteraction} with a `STRING_SELECT` type.
+   * @returns {boolean}
+   * @deprecated Use {@link Interaction#isStringSelect()} instead
+   */
+  isSelectMenu() {
+    return this.isStringSelect();
+  }
+
+  /**
+   * Indicates whether this interaction is a {@link SelectMenuInteraction} with a `STRING_SELECT` type.
+   * @returns {boolean}
+   */
+  isStringSelect() {
+    return (
+      InteractionTypes[this.type] === InteractionTypes.MESSAGE_COMPONENT &&
+      MessageComponentTypes[this.componentType] === MessageComponentTypes.STRING_SELECT
+    );
+  }
+
+  /**
+   * Indicates whether this interaction is a {@link SelectMenuInteraction} with a `USER_SELECT` type.
+   * @returns {boolean}
+   */
+  isUserSelect() {
+    return (
+      InteractionTypes[this.type] === InteractionTypes.MESSAGE_COMPONENT &&
+      MessageComponentTypes[this.componentType] === MessageComponentTypes.USER_SELECT
+    );
+  }
+
+  /**
+   * Indicates whether this interaction is a {@link SelectMenuInteraction} with a `ROLE_SELECT` type.
+   * @returns {boolean}
+   */
+  isRoleSelect() {
+    return (
+      InteractionTypes[this.type] === InteractionTypes.MESSAGE_COMPONENT &&
+      MessageComponentTypes[this.componentType] === MessageComponentTypes.ROLE_SELECT
+    );
+  }
+
+  /**
+   * Indicates whether this interaction is a {@link SelectMenuInteraction} with a `MENTIONABLE_SELECT` type.
+   * @returns {boolean}
+   */
+  isMentionableSelect() {
+    return (
+      InteractionTypes[this.type] === InteractionTypes.MESSAGE_COMPONENT &&
+      MessageComponentTypes[this.componentType] === MessageComponentTypes.MENTIONABLE_SELECT
+    );
+  }
+
+  /**
+   * Indicates whether this interaction is a {@link SelectMenuInteraction} with a `CHANNEL_SELECT` type.
+   * @returns {boolean}
+   */
+  isChannelSelect() {
+    return (
+      InteractionTypes[this.type] === InteractionTypes.MESSAGE_COMPONENT &&
+      MessageComponentTypes[this.componentType] === MessageComponentTypes.CHANNEL_SELECT
+    );
+  }
+
+  /**
+   * Indicates whether this interaction can be replied to.
+   * @returns {boolean}
+   */
+  isRepliable() {
+    return ![InteractionTypes.PING, InteractionTypes.APPLICATION_COMMAND_AUTOCOMPLETE].includes(
+      InteractionTypes[this.type],
+    );
+  }
+}
+
+module.exports = Interaction;

package/src/structures/InteractionCollector.js

@@ -0,0 +1,248 @@
+'use strict';
+
+const { Collection } = require('@discordjs/collection');
+const Collector = require('./interfaces/Collector');
+const { Events } = require('../util/Constants');
+const { InteractionTypes, MessageComponentTypes } = require('../util/Constants');
+
+/**
+ * @typedef {CollectorOptions} InteractionCollectorOptions
+ * @property {TextBasedChannelsResolvable} [channel] The channel to listen to interactions from
+ * @property {MessageComponentType} [componentType] The type of component to listen for
+ * @property {GuildResolvable} [guild] The guild to listen to interactions from
+ * @property {InteractionType} [interactionType] The type of interaction to listen for
+ * @property {number} [max] The maximum total amount of interactions to collect
+ * @property {number} [maxComponents] The maximum number of components to collect
+ * @property {number} [maxUsers] The maximum number of users to interact
+ * @property {Message|APIMessage} [message] The message to listen to interactions from
+ */
+
+/**
+ * Collects interactions.
+ * Will automatically stop if the message ({@link Client#event:messageDelete messageDelete} or
+ * {@link Client#event:messageDeleteBulk messageDeleteBulk}),
+ * channel ({@link Client#event:channelDelete channelDelete}), or
+ * guild ({@link Client#event:guildDelete guildDelete}) is deleted.
+ * <info>Interaction collectors that do not specify `time` or `idle` may be prone to always running.
+ * Ensure your interaction collectors end via either of these options or manual cancellation.</info>
+ * @extends {Collector}
+ */
+class InteractionCollector extends Collector {
+  /**
+   * @param {Client} client The client on which to collect interactions
+   * @param {InteractionCollectorOptions} [options={}] The options to apply to this collector
+   */
+  constructor(client, options = {}) {
+    super(client, options);
+
+    /**
+     * The message from which to collect interactions, if provided
+     * @type {?Snowflake}
+     */
+    this.messageId = options.message?.id ?? null;
+
+    /**
+     * The channel from which to collect interactions, if provided
+     * @type {?Snowflake}
+     */
+    this.channelId =
+      this.client.channels.resolveId(options.message?.channel) ??
+      options.message?.channel_id ??
+      this.client.channels.resolveId(options.channel);
+
+    /**
+     * The guild from which to collect interactions, if provided
+     * @type {?Snowflake}
+     */
+    this.guildId =
+      this.client.guilds.resolveId(options.message?.guild) ??
+      options.message?.guild_id ??
+      this.client.guilds.resolveId(options.channel?.guild) ??
+      this.client.guilds.resolveId(options.guild);
+
+    /**
+     * The type of interaction to collect
+     * @type {?InteractionType}
+     */
+    this.interactionType =
+      typeof options.interactionType === 'number'
+        ? InteractionTypes[options.interactionType]
+        : options.interactionType ?? null;
+
+    /**
+     * The type of component to collect
+     * @type {?MessageComponentType}
+     */
+    this.componentType =
+      typeof options.componentType === 'number'
+        ? MessageComponentTypes[options.componentType]
+        : options.componentType ?? null;
+
+    /**
+     * The users that have interacted with this collector
+     * @type {Collection<Snowflake, User>}
+     */
+    this.users = new Collection();
+
+    /**
+     * The total number of interactions collected
+     * @type {number}
+     */
+    this.total = 0;
+
+    this.empty = this.empty.bind(this);
+    this.client.incrementMaxListeners();
+
+    const bulkDeleteListener = messages => {
+      if (messages.has(this.messageId)) this.stop('messageDelete');
+    };
+
+    if (this.messageId) {
+      this._handleMessageDeletion = this._handleMessageDeletion.bind(this);
+      this.client.on(Events.MESSAGE_DELETE, this._handleMessageDeletion);
+      this.client.on(Events.MESSAGE_BULK_DELETE, bulkDeleteListener);
+    }
+
+    if (this.channelId) {
+      this._handleChannelDeletion = this._handleChannelDeletion.bind(this);
+      this._handleThreadDeletion = this._handleThreadDeletion.bind(this);
+      this.client.on(Events.CHANNEL_DELETE, this._handleChannelDeletion);
+      this.client.on(Events.THREAD_DELETE, this._handleThreadDeletion);
+    }
+
+    if (this.guildId) {
+      this._handleGuildDeletion = this._handleGuildDeletion.bind(this);
+      this.client.on(Events.GUILD_DELETE, this._handleGuildDeletion);
+    }
+
+    this.client.on(Events.INTERACTION_CREATE, this.handleCollect);
+
+    this.once('end', () => {
+      this.client.removeListener(Events.INTERACTION_CREATE, this.handleCollect);
+      this.client.removeListener(Events.MESSAGE_DELETE, this._handleMessageDeletion);
+      this.client.removeListener(Events.MESSAGE_BULK_DELETE, bulkDeleteListener);
+      this.client.removeListener(Events.CHANNEL_DELETE, this._handleChannelDeletion);
+      this.client.removeListener(Events.THREAD_DELETE, this._handleThreadDeletion);
+      this.client.removeListener(Events.GUILD_DELETE, this._handleGuildDeletion);
+      this.client.decrementMaxListeners();
+    });
+
+    this.on('collect', interaction => {
+      this.total++;
+      this.users.set(interaction.user.id, interaction.user);
+    });
+  }
+
+  /**
+   * Handles an incoming interaction for possible collection.
+   * @param {Interaction} interaction The interaction to possibly collect
+   * @returns {?Snowflake}
+   * @private
+   */
+  collect(interaction) {
+    /**
+     * Emitted whenever an interaction is collected.
+     * @event InteractionCollector#collect
+     * @param {Interaction} interaction The interaction that was collected
+     */
+    if (this.interactionType && interaction.type !== this.interactionType) return null;
+    if (this.componentType && interaction.componentType !== this.componentType) return null;
+    if (this.messageId && interaction.message?.id !== this.messageId) return null;
+    if (this.channelId && interaction.channelId !== this.channelId) return null;
+    if (this.guildId && interaction.guildId !== this.guildId) return null;
+
+    return interaction.id;
+  }
+
+  /**
+   * Handles an interaction for possible disposal.
+   * @param {Interaction} interaction The interaction that could be disposed of
+   * @returns {?Snowflake}
+   */
+  dispose(interaction) {
+    /**
+     * Emitted whenever an interaction is disposed of.
+     * @event InteractionCollector#dispose
+     * @param {Interaction} interaction The interaction that was disposed of
+     */
+    if (this.type && interaction.type !== this.type) return null;
+    if (this.componentType && interaction.componentType !== this.componentType) return null;
+    if (this.messageId && interaction.message?.id !== this.messageId) return null;
+    if (this.channelId && interaction.channelId !== this.channelId) return null;
+    if (this.guildId && interaction.guildId !== this.guildId) return null;
+
+    return interaction.id;
+  }
+
+  /**
+   * Empties this interaction collector.
+   */
+  empty() {
+    this.total = 0;
+    this.collected.clear();
+    this.users.clear();
+    this.checkEnd();
+  }
+
+  /**
+   * The reason this collector has ended with, or null if it hasn't ended yet
+   * @type {?string}
+   * @readonly
+   */
+  get endReason() {
+    if (this.options.max && this.total >= this.options.max) return 'limit';
+    if (this.options.maxComponents && this.collected.size >= this.options.maxComponents) return 'componentLimit';
+    if (this.options.maxUsers && this.users.size >= this.options.maxUsers) return 'userLimit';
+    return null;
+  }
+
+  /**
+   * Handles checking if the message has been deleted, and if so, stops the collector with the reason 'messageDelete'.
+   * @private
+   * @param {Message} message The message that was deleted
+   * @returns {void}
+   */
+  _handleMessageDeletion(message) {
+    if (message.id === this.messageId) {
+      this.stop('messageDelete');
+    }
+  }
+
+  /**
+   * Handles checking if the channel has been deleted, and if so, stops the collector with the reason 'channelDelete'.
+   * @private
+   * @param {GuildChannel} channel The channel that was deleted
+   * @returns {void}
+   */
+  _handleChannelDeletion(channel) {
+    if (channel.id === this.channelId || channel.threads?.cache.has(this.channelId)) {
+      this.stop('channelDelete');
+    }
+  }
+
+  /**
+   * Handles checking if the thread has been deleted, and if so, stops the collector with the reason 'threadDelete'.
+   * @private
+   * @param {ThreadChannel} thread The thread that was deleted
+   * @returns {void}
+   */
+  _handleThreadDeletion(thread) {
+    if (thread.id === this.channelId) {
+      this.stop('threadDelete');
+    }
+  }
+
+  /**
+   * Handles checking if the guild has been deleted, and if so, stops the collector with the reason 'guildDelete'.
+   * @private
+   * @param {Guild} guild The guild that was deleted
+   * @returns {void}
+   */
+  _handleGuildDeletion(guild) {
+    if (guild.id === this.guildId) {
+      this.stop('guildDelete');
+    }
+  }
+}
+
+module.exports = InteractionCollector;

package/src/structures/InteractionResponse.js

@@ -0,0 +1,114 @@
+'use strict';
+
+const { setTimeout } = require('node:timers');
+const Base = require('./Base');
+const { Events } = require('../util/Constants');
+const SnowflakeUtil = require('../util/SnowflakeUtil');
+
+/**
+ * Represents a interaction on Discord.
+ * @extends {Base}
+ */
+class InteractionResponse extends Base {
+  constructor(client, data) {
+    super(client);
+    /**
+     * The id of the channel the interaction was sent in
+     * @type {Snowflake}
+     */
+    this.channelId = data.channelId;
+
+    /**
+     * The id of the guild the interaction was sent in, if any
+     * @type {?Snowflake}
+     */
+    this.guildId = data.guildId ?? this.channel?.guild?.id ?? null;
+
+    /**
+     * The interaction data was sent in
+     * @type {Object}
+     */
+    this.sendData = data.metadata;
+    this._patch(data);
+  }
+
+  _patch(data) {
+    if ('id' in data) {
+      /**
+       * The interaction response's ID
+       * @type {Snowflake}
+       */
+      this.id = data.id;
+    }
+    if ('nonce' in data) {
+      /**
+       * The interaction response's nonce
+       * @type {Snowflake}
+       */
+      this.nonce = data.nonce;
+    }
+  }
+  /**
+   * The timestamp the interaction response was created at
+   * @type {number}
+   * @readonly
+   */
+  get createdTimestamp() {
+    return SnowflakeUtil.timestampFrom(this.id);
+  }
+
+  /**
+   * The time the interaction response was created at
+   * @type {Date}
+   * @readonly
+   */
+  get createdAt() {
+    return new Date(this.createdTimestamp);
+  }
+
+  /**
+   * The channel that the interaction was sent in
+   * @type {TextBasedChannels}
+   * @readonly
+   */
+  get channel() {
+    return this.client.channels.resolve(this.channelId);
+  }
+
+  /**
+   * The guild the inteaaction was sent in (if in a guild channel)
+   * @type {?Guild}
+   * @readonly
+   */
+  get guild() {
+    return this.client.guilds.resolve(this.guildId) ?? this.channel?.guild ?? null;
+  }
+
+  /**
+   * Get Modal send from interaction
+   * @param {number} time Time to wait for modal
+   * @returns {Modal}
+   */
+  awaitModal(time) {
+    if (!time || typeof time !== 'number' || time < 0) throw new Error('INVALID_TIME');
+    return new Promise((resolve, reject) => {
+      const handler = modal => {
+        timeout.refresh();
+        if (modal.nonce != this.nonce || modal.id != this.id) return;
+        clearTimeout(timeout);
+        this.client.removeListener(Events.INTERACTION_MODAL_CREATE, handler);
+        this.client.decrementMaxListeners();
+        resolve(modal);
+      };
+      const timeout = setTimeout(() => {
+        this.client.removeListener(Events.INTERACTION_MODAL_CREATE, handler);
+        this.client.decrementMaxListeners();
+        reject(new Error('MODAL_TIMEOUT'));
+      }, time).unref();
+      this.client.incrementMaxListeners();
+      this.client.on(Events.INTERACTION_MODAL_CREATE, handler);
+    });
+  }
+}
+
+module.exports = InteractionResponse;