djs-selfbot-v13 3.1.6 → 3.1.7

package/src/structures/Modal.js

@@ -2,15 +2,24 @@
 
 const { setTimeout } = require('node:timers');
 const BaseMessageComponent = require('./BaseMessageComponent');
-const { InteractionTypes, Events } = require('../util/Constants');
+const User = require('./User');
 const SnowflakeUtil = require('../util/SnowflakeUtil');
+const Util = require('../util/Util');
 
 /**
  * Represents a modal (form) to be shown in response to an interaction
  */
 class Modal {
   /**
-   * @param {Object} data Modal to clone or raw data
+   * @typedef {Object} ModalOptions
+   * @property {string} [customId] A unique string to be sent in the interaction when clicked
+   * @property {string} [title] The title to be displayed on this modal
+   * @property {Array<(MessageActionRow|MessageActionRowOptions)>} [components]
+   * Action rows containing interactive components for the modal (text input components)
+   */
+
+  /**
+   * @param {Modal|ModalOptions} data Modal to clone or raw data
    * @param {Client} client The client constructing this Modal, if provided
    */
   constructor(data = {}, client = null) {
@@ -24,69 +33,106 @@ class Modal {
      * A unique string to be sent in the interaction when submitted
      * @type {?string}
      */
-    this.customId = data.custom_id;
+    this.customId = data.custom_id ?? data.customId ?? null;
 
     /**
      * The title to be displayed on this modal
      * @type {?string}
      */
-    this.title = data.title;
+    this.title = data.title ?? null;
 
     /**
      * Timestamp (Discord epoch) of when this modal was created
-     * @type {Snowflake}
+     * @type {?Snowflake}
      */
-    this.nonce = data.nonce;
+    this.nonce = data.nonce ?? null;
 
     /**
      * ID slash / button / menu when modal is displayed
-     * @type {Snowflake}
+     * @type {?Snowflake}
      */
-    this.id = data.id;
+    this.id = data.id ?? null;
 
     /**
      * Application sending the modal
-     * @type {Snowflake}
+     * @type {?Object}
      */
-    this.applicationId = data.application.id;
+    this.application = data.application
+      ? {
+          ...data.application,
+          bot: data.application.bot ? new User(client, data.application.bot, data.application) : null,
+        }
+      : null;
 
-    /**
-     * The id of the channel the message was sent in
-     * @type {Snowflake}
-     */
-    this.channelId = data.channel_id;
-
-    Object.defineProperty(this, 'client', {
-      value: client,
-      writable: false,
-    });
+    this.client = client;
   }
 
   /**
-   * The id of the guild the message was sent in, if any
-   * @type {?Snowflake}
+   * Get Interaction Response
+   * @type {?InteractionResponse}
    * @readonly
    */
-  get guildId() {
-    return this.client.channels.cache.get(this.channelId)?.guildId || null;
+  get sendFromInteraction() {
+    if (this.id && this.nonce && this.client) {
+      const cache = this.client._interactionCache.get(this.nonce);
+      const channel = cache.guildId
+        ? this.client.guilds.cache.get(cache.guildId)?.channels.cache.get(cache.channelId)
+        : this.client.channels.cache.get(cache.channelId);
+      return channel.interactions.cache.get(this.id);
+    }
+    return null;
   }
 
   /**
-   * The channel that the message was sent in
-   * @type {TextBasedChannels}
-   * @readonly
+   * Adds components to the modal.
+   * @param {...MessageActionRowResolvable[]} components The components to add
+   * @returns {Modal}
    */
-  get channel() {
-    return this.client.channels.resolve(this.channelId);
+  addComponents(...components) {
+    this.components.push(...components.flat(Infinity).map(c => BaseMessageComponent.create(c)));
+    return this;
   }
 
   /**
-   * The guild the message was sent in (if in a guild channel)
-   * @type {?Guild}
-   * @readonly
+   * Sets the components of the modal.
+   * @param {...MessageActionRowResolvable[]} components The components to set
+   * @returns {Modal}
+   */
+  setComponents(...components) {
+    this.spliceComponents(0, this.components.length, components);
+    return this;
+  }
+
+  /**
+   * Sets the custom id for this modal
+   * @param {string} customId A unique string to be sent in the interaction when submitted
+   * @returns {Modal}
+   */
+  setCustomId(customId) {
+    this.customId = Util.verifyString(customId, RangeError, 'MODAL_CUSTOM_ID');
+    return this;
+  }
+
+  /**
+   * Removes, replaces, and inserts components in the modal.
+   * @param {number} index The index to start at
+   * @param {number} deleteCount The number of components to remove
+   * @param {...MessageActionRowResolvable[]} [components] The replacing components
+   * @returns {Modal}
    */
-  get guild() {
-    return this.client.guilds.resolve(this.guildId) ?? this.channel?.guild ?? null;
+  spliceComponents(index, deleteCount, ...components) {
+    this.components.splice(index, deleteCount, ...components.flat(Infinity).map(c => BaseMessageComponent.create(c)));
+    return this;
+  }
+
+  /**
+   * Sets the title of this modal
+   * @param {string} title The title to be displayed on this modal
+   * @returns {Modal}
+   */
+  setTitle(title) {
+    this.title = Util.verifyString(title, RangeError, 'MODAL_TITLE');
+    return this;
   }
 
   toJSON() {
@@ -98,77 +144,136 @@ class Modal {
     };
   }
 
+  /**
+   * @typedef {Object} TextInputComponentReplyData
+   * @property {string} [customId] TextInputComponent custom id
+   * @property {string} [value] TextInputComponent value
+   */
+
+  /**
+   * @typedef {Object} ModalReplyData
+   * @property {?GuildResolvable} [guild] Guild to send the modal to
+   * @property {?TextChannelResolvable} [channel] User to send the modal to
+   * @property {?TextInputComponentReplyData[]} [data] Reply data
+   */
+
   /**
    * Reply to this modal with data. (Event only)
-   * @returns {Promise<Message|Modal>}
+   * @param  {ModalReplyData} data Data to send with the modal
+   * @returns {Promise<InteractionResponse>}
    * @example
    * client.on('interactionModalCreate', modal => {
-   *    // Modal > ActionRow > TextInput
-   *    modal.components[0].components[0].setValue('1+1');
-   *    modal.components[1].components[0].setValue('hello');
-   *    modal.reply();
+   * // 1.
+   *  modal.reply({
+   *     data: [
+   *         {
+   *             customId: 'code',
+   *             value: '1+1'
+   *         }, {
+   *             customId: 'message',
+   *             value: 'hello'
+   *         }
+   *     ],
+   *    channel: 'id', // optional
+   *    guild: 'id', // optional
+   *  })
+   * // or 2.
+   * modal.components[0].components[0].setValue('1+1');
+   * modal.components[1].components[0].setValue('hello');
+   * modal.reply();
    * })
    */
-  reply() {
-    if (!this.applicationId || !this.client || !this.channelId) throw new Error('Modal cannot reply');
+  async reply(data = {}) {
+    if (!this.application) throw new Error('Modal cannot reply (Missing Application)');
+    const data_cache = this.sendFromInteraction;
+    const guild = this.client.guilds.resolveId(data?.guild) || data_cache.guildId || null;
+    const channel = this.client.channels.resolveId(data?.channel) || data_cache.channelId;
+    if (!channel) throw new Error('Modal cannot reply (Missing data)');
+    // Add data to components
+    // this.components = [ MessageActionRow.components = [ TextInputComponent ] ]
+    // 5 MessageActionRow / Modal, 1 TextInputComponent / 1 MessageActionRow
+    if (Array.isArray(data?.data) && data?.data?.length > 0) {
+      for (let i = 0; i < this.components.length; i++) {
+        const value = data.data.find(d => d.customId == this.components[i].components[0].customId);
+        if (this.components[i].components[0].required == true && !value) {
+          throw new Error(
+            'MODAL_REQUIRED_FIELD_MISSING\n' +
+              `Required fieldId ${this.components[i].components[0].customId} missing value`,
+          );
+        }
+        if (value) {
+          if (value?.value?.includes('\n') && this.components[i].components[0].style == 'SHORT') {
+            throw new Error(
+              'MODAL_REPLY_DATA_INVALID\n' +
+                `value must be a single line, got multiple lines [Custom ID: ${value.customId}]`,
+            );
+          }
+          this.components[i].components[0].setValue(value.value);
+        }
+      }
+    }
     // Get Object
     const dataFinal = this.toJSON();
     dataFinal.components = dataFinal.components
       .map(c => {
-        c.components[0] = {
-          type: c.components[0].type,
-          value: c.components[0].value,
-          custom_id: c.components[0].custom_id,
-        };
+        delete c.components[0].max_length;
+        delete c.components[0].min_length;
+        delete c.components[0].required;
+        delete c.components[0].placeholder;
+        delete c.components[0].label;
+        delete c.components[0].style;
         return c;
       })
-      .filter(c => typeof c.components[0].value == 'string');
+      .filter(c => c.components[0].value && c.components[0].value !== '');
     delete dataFinal.title;
     const nonce = SnowflakeUtil.generate();
     const postData = {
-      type: InteractionTypes.MODAL_SUBMIT, // Modal
-      application_id: this.applicationId,
-      guild_id: this.guildId,
-      channel_id: this.channelId,
+      type: 5, // Modal
+      application_id: this.application.id,
+      guild_id: guild || null,
+      channel_id: channel,
       data: dataFinal,
       nonce,
-      session_id: this.client.sessionId,
+      session_id: this.client.session_id,
     };
-    this.client.api.interactions.post({
+    await this.client.api.interactions.post({
       data: postData,
     });
+    this.client._interactionCache.set(nonce, {
+      channelId: channel,
+      guildId: guild,
+      metadata: postData,
+    });
     return new Promise((resolve, reject) => {
-      const timeoutMs = 5_000;
-      // Waiting for MsgCreate / ModalCreate
       const handler = data => {
-        if (data.nonce !== nonce) return;
+        timeout.refresh();
+        if (data.metadata?.nonce !== nonce) return;
         clearTimeout(timeout);
-        this.client.removeListener(Events.MESSAGE_CREATE, handler);
-        this.client.removeListener(Events.INTERACTION_MODAL_CREATE, handler);
+        this.client.removeListener('interactionResponse', handler);
         this.client.decrementMaxListeners();
-        resolve(data);
+        if (data.status) {
+          resolve(data.metadata);
+        } else {
+          reject(
+            new Error('INTERACTION_ERROR', {
+              cause: data,
+            }),
+          );
+        }
       };
       const timeout = setTimeout(() => {
-        this.client.removeListener(Events.MESSAGE_CREATE, handler);
-        this.client.removeListener(Events.INTERACTION_MODAL_CREATE, handler);
+        this.client.removeListener('interactionResponse', handler);
         this.client.decrementMaxListeners();
-        reject(new Error('INTERACTION_FAILED'));
-      }, timeoutMs).unref();
+        reject(
+          new Error('INTERACTION_TIMEOUT', {
+            cause: postData,
+          }),
+        );
+      }, this.client.options.interactionTimeout).unref();
       this.client.incrementMaxListeners();
-      this.client.on(Events.MESSAGE_CREATE, handler);
-      this.client.on(Events.INTERACTION_MODAL_CREATE, handler);
+      this.client.on('interactionResponse', handler);
     });
   }
-
-  // TypeScript
-  /**
-   * Check data
-   * @type {boolean}
-   * @readonly
-   */
-  get isMessage() {
-    return false;
-  }
 }
 
 module.exports = Modal;