diff options
Diffstat (limited to 'node_modules/discord.js/src/structures/InteractionCollector.js')
-rw-r--r-- | node_modules/discord.js/src/structures/InteractionCollector.js | 269 |
1 files changed, 269 insertions, 0 deletions
diff --git a/node_modules/discord.js/src/structures/InteractionCollector.js b/node_modules/discord.js/src/structures/InteractionCollector.js new file mode 100644 index 0000000..bb8e6c7 --- /dev/null +++ b/node_modules/discord.js/src/structures/InteractionCollector.js @@ -0,0 +1,269 @@ +'use strict'; + +const { Collection } = require('@discordjs/collection'); +const Collector = require('./interfaces/Collector'); +const Events = require('../util/Events'); + +/** + * @typedef {CollectorOptions} InteractionCollectorOptions + * @property {TextBasedChannelsResolvable} [channel] The channel to listen to interactions from + * @property {ComponentType} [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 + * @property {InteractionResponse} [interactionResponse] The interaction response to listen + * to message component 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 ?? options.interactionResponse?.interaction.message?.id ?? null; + + /** + * The message interaction id from which to collect interactions, if provided + * @type {?Snowflake} + */ + this.messageInteractionId = options.interactionResponse?.id ?? null; + + /** + * The channel from which to collect interactions, if provided + * @type {?Snowflake} + */ + this.channelId = + options.interactionResponse?.interaction.channelId ?? + options.message?.channelId ?? + options.message?.channel_id ?? + this.client.channels.resolveId(options.channel); + + /** + * The guild from which to collect interactions, if provided + * @type {?Snowflake} + */ + this.guildId = + options.interactionResponse?.interaction.guildId ?? + options.message?.guildId ?? + 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 = options.interactionType ?? null; + + /** + * The type of component to collect + * @type {?ComponentType} + */ + this.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.client.incrementMaxListeners(); + + const bulkDeleteListener = messages => { + if (messages.has(this.messageId)) this.stop('messageDelete'); + }; + + if (this.messageId || this.messageInteractionId) { + this._handleMessageDeletion = this._handleMessageDeletion.bind(this); + this.client.on(Events.MessageDelete, this._handleMessageDeletion); + this.client.on(Events.MessageBulkDelete, bulkDeleteListener); + } + + if (this.channelId) { + this._handleChannelDeletion = this._handleChannelDeletion.bind(this); + this._handleThreadDeletion = this._handleThreadDeletion.bind(this); + this.client.on(Events.ChannelDelete, this._handleChannelDeletion); + this.client.on(Events.ThreadDelete, this._handleThreadDeletion); + } + + if (this.guildId) { + this._handleGuildDeletion = this._handleGuildDeletion.bind(this); + this.client.on(Events.GuildDelete, this._handleGuildDeletion); + } + + this.client.on(Events.InteractionCreate, this.handleCollect); + + this.once('end', () => { + this.client.removeListener(Events.InteractionCreate, this.handleCollect); + this.client.removeListener(Events.MessageDelete, this._handleMessageDeletion); + this.client.removeListener(Events.MessageBulkDelete, bulkDeleteListener); + this.client.removeListener(Events.ChannelDelete, this._handleChannelDeletion); + this.client.removeListener(Events.ThreadDelete, this._handleThreadDeletion); + this.client.removeListener(Events.GuildDelete, 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 {BaseInteraction} interaction The interaction to possibly collect + * @returns {?Snowflake} + * @private + */ + collect(interaction) { + /** + * Emitted whenever an interaction is collected. + * @event InteractionCollector#collect + * @param {BaseInteraction} 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.messageInteractionId && + interaction.message?.interaction?.id && + interaction.message.interaction.id !== this.messageInteractionId + ) { + 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 {BaseInteraction} interaction The interaction that could be disposed of + * @returns {?Snowflake} + */ + dispose(interaction) { + /** + * Emitted whenever an interaction is disposed of. + * @event InteractionCollector#dispose + * @param {BaseInteraction} 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.messageInteractionId && + interaction.message?.interaction?.id && + interaction.message.interaction.id !== this.messageInteractionId + ) { + 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 super.endReason; + } + + /** + * 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'); + } + + if (message.interaction?.id === this.messageInteractionId) { + 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; |