@velliajs/discord 1.0.0

package/src/structures/Integration.js

@@ -0,0 +1,220 @@
+'use strict';
+
+const { Routes } = require('discord-api-types/v10');
+const Base = require('./Base');
+const IntegrationApplication = require('./IntegrationApplication');
+
+/**
+ * The information account for an integration
+ * @typedef {Object} IntegrationAccount
+ * @property {Snowflake|string} id The id of the account
+ * @property {string} name The name of the account
+ */
+
+/**
+ * The type of an {@link Integration}. This can be:
+ * * `twitch`
+ * * `youtube`
+ * * `discord`
+ * * `guild_subscription`
+ * @typedef {string} IntegrationType
+ */
+
+/**
+ * Represents a guild integration.
+ * @extends {Base}
+ */
+class Integration extends Base {
+  constructor(client, data, guild) {
+    super(client);
+
+    /**
+     * The guild this integration belongs to
+     * @type {Guild}
+     */
+    this.guild = guild;
+
+    /**
+     * The integration id
+     * @type {Snowflake|string}
+     */
+    this.id = data.id;
+
+    /**
+     * The integration name
+     * @type {string}
+     */
+    this.name = data.name;
+
+    /**
+     * The integration type
+     * @type {IntegrationType}
+     */
+    this.type = data.type;
+
+    /**
+     * Whether this integration is enabled
+     * @type {?boolean}
+     */
+    this.enabled = data.enabled ?? null;
+
+    if ('syncing' in data) {
+      /**
+       * Whether this integration is syncing
+       * @type {?boolean}
+       */
+      this.syncing = data.syncing;
+    } else {
+      this.syncing ??= null;
+    }
+
+    /**
+     * The role that this integration uses for subscribers
+     * @type {?Role}
+     */
+    this.role = this.guild.roles.resolve(data.role_id);
+
+    if ('enable_emoticons' in data) {
+      /**
+       * Whether emoticons should be synced for this integration (twitch only currently)
+       * @type {?boolean}
+       */
+      this.enableEmoticons = data.enable_emoticons;
+    } else {
+      this.enableEmoticons ??= null;
+    }
+
+    if (data.user) {
+      /**
+       * The user for this integration
+       * @type {?User}
+       */
+      this.user = this.client.users._add(data.user);
+    } else {
+      this.user ??= null;
+    }
+
+    /**
+     * The account integration information
+     * @type {IntegrationAccount}
+     */
+    this.account = data.account;
+
+    if ('synced_at' in data) {
+      /**
+       * The timestamp at which this integration was last synced at
+       * @type {?number}
+       */
+      this.syncedTimestamp = Date.parse(data.synced_at);
+    } else {
+      this.syncedTimestamp ??= null;
+    }
+
+    if ('subscriber_count' in data) {
+      /**
+       * How many subscribers this integration has
+       * @type {?number}
+       */
+      this.subscriberCount = data.subscriber_count;
+    } else {
+      this.subscriberCount ??= null;
+    }
+
+    if ('revoked' in data) {
+      /**
+       * Whether this integration has been revoked
+       * @type {?boolean}
+       */
+      this.revoked = data.revoked;
+    } else {
+      this.revoked ??= null;
+    }
+
+    this._patch(data);
+  }
+
+  /**
+   * The date at which this integration was last synced at
+   * @type {?Date}
+   * @readonly
+   */
+  get syncedAt() {
+    return this.syncedTimestamp && new Date(this.syncedTimestamp);
+  }
+
+  /**
+   * All roles that are managed by this integration
+   * @type {Collection<Snowflake, Role>}
+   * @readonly
+   */
+  get roles() {
+    const roles = this.guild.roles.cache;
+    return roles.filter(role => role.tags?.integrationId === this.id);
+  }
+
+  _patch(data) {
+    if ('expire_behavior' in data) {
+      /**
+       * The behavior of expiring subscribers
+       * @type {?IntegrationExpireBehavior}
+       */
+      this.expireBehavior = data.expire_behavior;
+    } else {
+      this.expireBehavior ??= null;
+    }
+
+    if ('expire_grace_period' in data) {
+      /**
+       * The grace period (in days) before expiring subscribers
+       * @type {?number}
+       */
+      this.expireGracePeriod = data.expire_grace_period;
+    } else {
+      this.expireGracePeriod ??= null;
+    }
+
+    if ('application' in data) {
+      if (this.application) {
+        this.application._patch(data.application);
+      } else {
+        /**
+         * The application for this integration
+         * @type {?IntegrationApplication}
+         */
+        this.application = new IntegrationApplication(this.client, data.application);
+      }
+    } else {
+      this.application ??= null;
+    }
+
+    if ('scopes' in data) {
+      /**
+       * The scopes this application has been authorized for
+       * @type {OAuth2Scopes[]}
+       */
+      this.scopes = data.scopes;
+    } else {
+      this.scopes ??= [];
+    }
+  }
+
+  /**
+   * Deletes this integration.
+   * @returns {Promise<Integration>}
+   * @param {string} [reason] Reason for deleting this integration
+   */
+  async delete(reason) {
+    await this.client.rest.delete(Routes.guildIntegration(this.guild.id, this.id), { reason });
+    return this;
+  }
+
+  toJSON() {
+    return super.toJSON({
+      role: 'roleId',
+      guild: 'guildId',
+      user: 'userId',
+    });
+  }
+}
+
+module.exports = Integration;

package/src/structures/IntegrationApplication.js

@@ -0,0 +1,85 @@
+'use strict';
+
+const Application = require('./interfaces/Application');
+
+/**
+ * Represents an Integration's OAuth2 Application.
+ * @extends {Application}
+ */
+class IntegrationApplication extends Application {
+  _patch(data) {
+    super._patch(data);
+
+    if ('bot' in data) {
+      /**
+       * The bot user for this application
+       * @type {?User}
+       */
+      this.bot = this.client.users._add(data.bot);
+    } else {
+      this.bot ??= null;
+    }
+
+    if ('terms_of_service_url' in data) {
+      /**
+       * The URL of the application's terms of service
+       * @type {?string}
+       */
+      this.termsOfServiceURL = data.terms_of_service_url;
+    } else {
+      this.termsOfServiceURL ??= null;
+    }
+
+    if ('privacy_policy_url' in data) {
+      /**
+       * The URL of the application's privacy policy
+       * @type {?string}
+       */
+      this.privacyPolicyURL = data.privacy_policy_url;
+    } else {
+      this.privacyPolicyURL ??= null;
+    }
+
+    if ('rpc_origins' in data) {
+      /**
+       * The Array of RPC origin URLs
+       * @type {string[]}
+       */
+      this.rpcOrigins = data.rpc_origins;
+    } else {
+      this.rpcOrigins ??= [];
+    }
+
+    if ('hook' in data) {
+      /**
+       * Whether the application can be default hooked by the client
+       * @type {?boolean}
+       */
+      this.hook = data.hook;
+    } else {
+      this.hook ??= null;
+    }
+
+    if ('cover_image' in data) {
+      /**
+       * The hash of the application's cover image
+       * @type {?string}
+       */
+      this.cover = data.cover_image;
+    } else {
+      this.cover ??= null;
+    }
+
+    if ('verify_key' in data) {
+      /**
+       * The hex-encoded key for verification in interactions and the GameSDK's GetTicket
+       * @type {?string}
+       */
+      this.verifyKey = data.verify_key;
+    } else {
+      this.verifyKey ??= null;
+    }
+  }
+}
+
+module.exports = IntegrationApplication;

package/src/structures/InteractionCollector.js

@@ -0,0 +1,263 @@
+'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 ?? 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 !== 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;

package/src/structures/InteractionResponse.js

@@ -0,0 +1,102 @@
+'use strict';
+
+const { DiscordSnowflake } = require('@sapphire/snowflake');
+const { InteractionType } = require('discord-api-types/v10');
+const { DiscordjsError, ErrorCodes } = require('../errors');
+
+/**
+ * Represents an interaction's response
+ */
+class InteractionResponse {
+  constructor(interaction, id) {
+    /**
+     * The interaction associated with the interaction response
+     * @type {BaseInteraction}
+     */
+    this.interaction = interaction;
+    /**
+     * The id of the original interaction response
+     * @type {Snowflake}
+     */
+    this.id = id ?? interaction.id;
+    this.client = interaction.client;
+  }
+
+  /**
+   * The timestamp the interaction response was created at
+   * @type {number}
+   * @readonly
+   */
+  get createdTimestamp() {
+    return DiscordSnowflake.timestampFrom(this.id);
+  }
+
+  /**
+   * The time the interaction response was created at
+   * @type {Date}
+   * @readonly
+   */
+  get createdAt() {
+    return new Date(this.createdTimestamp);
+  }
+
+  /**
+   * Collects a single component interaction that passes the filter.
+   * The Promise will reject if the time expires.
+   * @param {AwaitMessageComponentOptions} [options={}] Options to pass to the internal collector
+   * @returns {Promise<MessageComponentInteraction>}
+   */
+  awaitMessageComponent(options = {}) {
+    const _options = { ...options, max: 1 };
+    return new Promise((resolve, reject) => {
+      const collector = this.createMessageComponentCollector(_options);
+      collector.once('end', (interactions, reason) => {
+        const interaction = interactions.first();
+        if (interaction) resolve(interaction);
+        else reject(new DiscordjsError(ErrorCodes.InteractionCollectorError, reason));
+      });
+    });
+  }
+
+  /**
+   * Creates a message component interaction collector
+   * @param {MessageComponentCollectorOptions} [options={}] Options to send to the collector
+   * @returns {InteractionCollector}
+   */
+  createMessageComponentCollector(options = {}) {
+    return new InteractionCollector(this.client, {
+      ...options,
+      interactionResponse: this,
+      interactionType: InteractionType.MessageComponent,
+    });
+  }
+
+  /**
+   * Fetches the response as a {@link Message} object.
+   * @returns {Promise<Message>}
+   */
+  fetch() {
+    return this.interaction.fetchReply();
+  }
+
+  /**
+   * Deletes the response.
+   * @returns {Promise<void>}
+   */
+  delete() {
+    return this.interaction.deleteReply();
+  }
+
+  /**
+   * Edits the response.
+   * @param {string|MessagePayload|WebhookMessageEditOptions} options The new options for the response.
+   * @returns {Promise<Message>}
+   */
+  edit(options) {
+    return this.interaction.editReply(options);
+  }
+}
+
+// eslint-disable-next-line import/order
+const InteractionCollector = require('./InteractionCollector');
+module.exports = InteractionResponse;