Discord.js v13.7

src/structures/TextInputComponent.js

@@ -0,0 +1,201 @@
+'use strict';
+
+const BaseMessageComponent = require('./BaseMessageComponent');
+const { RangeError } = require('../errors');
+const { TextInputStyles, MessageComponentTypes } = require('../util/Constants');
+const Util = require('../util/Util');
+
+/**
+ * Represents a text input component in a modal
+ * @extends {BaseMessageComponent}
+ */
+
+class TextInputComponent extends BaseMessageComponent {
+  /**
+   * @typedef {BaseMessageComponentOptions} TextInputComponentOptions
+   * @property {string} [customId] A unique string to be sent in the interaction when submitted
+   * @property {string} [label] The text to be displayed above this text input component
+   * @property {number} [maxLength] Maximum length of text that can be entered
+   * @property {number} [minLength] Minimum length of text required to be entered
+   * @property {string} [placeholder] Custom placeholder text to display when no text is entered
+   * @property {boolean} [required] Whether or not this text input component is required
+   * @property {TextInputStyleResolvable} [style] The style of this text input component
+   * @property {string} [value] Value of this text input component
+   */
+
+  /**
+   * @param {TextInputComponent|TextInputComponentOptions} [data={}] TextInputComponent to clone or raw data
+   */
+  constructor(data = {}) {
+    super({ type: 'TEXT_INPUT' });
+
+    this.setup(data);
+  }
+
+  setup(data) {
+    /**
+     * A unique string to be sent in the interaction when submitted
+     * @type {?string}
+     */
+    this.customId = data.custom_id ?? data.customId ?? null;
+
+    /**
+     * The text to be displayed above this text input component
+     * @type {?string}
+     */
+    this.label = data.label ?? null;
+
+    /**
+     * Maximum length of text that can be entered
+     * @type {?number}
+     */
+    this.maxLength = data.max_length ?? data.maxLength ?? null;
+
+    /**
+     * Minimum length of text required to be entered
+     * @type {?string}
+     */
+    this.minLength = data.min_length ?? data.minLength ?? null;
+
+    /**
+     * Custom placeholder text to display when no text is entered
+     * @type {?string}
+     */
+    this.placeholder = data.placeholder ?? null;
+
+    /**
+     * Whether or not this text input component is required
+     * @type {?boolean}
+     */
+    this.required = data.required ?? false;
+
+    /**
+     * The style of this text input component
+     * @type {?TextInputStyle}
+     */
+    this.style = data.style ? TextInputComponent.resolveStyle(data.style) : null;
+
+    /**
+     * Value of this text input component
+     * @type {?string}
+     */
+    this.value = data.value ?? null;
+  }
+
+  /**
+   * Sets the custom id of this text input component
+   * @param {string} customId A unique string to be sent in the interaction when submitted
+   * @returns {TextInputComponent}
+   */
+  setCustomId(customId) {
+    this.customId = Util.verifyString(customId, RangeError, 'TEXT_INPUT_CUSTOM_ID');
+    return this;
+  }
+
+  /**
+   * Sets the label of this text input component
+   * @param {string} label The text to be displayed above this text input component
+   * @returns {TextInputComponent}
+   */
+  setLabel(label) {
+    this.label = Util.verifyString(label, RangeError, 'TEXT_INPUT_LABEL');
+    return this;
+  }
+
+  /**
+   * Sets the text input component to be required for modal submission
+   * @param {boolean} [required=true] Whether this text input component is required
+   * @returns {TextInputComponent}
+   */
+  setRequired(required = true) {
+    this.required = required;
+    return this;
+  }
+
+  /**
+   * Sets the maximum length of text input required in this text input component
+   * @param {number} maxLength Maximum length of text to be required
+   * @returns {TextInputComponent}
+   */
+  setMaxLength(maxLength) {
+    this.maxLength = maxLength;
+    return this;
+  }
+
+  /**
+   * Sets the minimum length of text input required in this text input component
+   * @param {number} minLength Minimum length of text to be required
+   * @returns {TextInputComponent}
+   */
+  setMinLength(minLength) {
+    this.minLength = minLength;
+    return this;
+  }
+
+  /**
+   * Sets the placeholder of this text input component
+   * @param {string} placeholder Custom placeholder text to display when no text is entered
+   * @returns {TextInputComponent}
+   */
+  setPlaceholder(placeholder) {
+    this.placeholder = Util.verifyString(placeholder, RangeError, 'TEXT_INPUT_PLACEHOLDER');
+    return this;
+  }
+
+  /**
+   * Sets the style of this text input component
+   * @param {TextInputStyleResolvable} style The style of this text input component
+   * @returns {TextInputComponent}
+   */
+  setStyle(style) {
+    this.style = TextInputComponent.resolveStyle(style);
+    return this;
+  }
+
+  /**
+   * Sets the value of this text input component
+   * @param {string} value Value of this text input component
+   * @returns {TextInputComponent}
+   */
+  setValue(value) {
+    this.value = Util.verifyString(value, RangeError, 'TEXT_INPUT_VALUE');
+    return this;
+  }
+
+  /**
+   * Transforms the text input component into a plain object
+   * @returns {APITextInput} The raw data of this text input component
+   */
+  toJSON() {
+    return {
+      custom_id: this.customId,
+      label: this.label,
+      max_length: this.maxLength,
+      min_length: this.minLength,
+      placeholder: this.placeholder,
+      required: this.required,
+      style: TextInputStyles[this.style],
+      type: MessageComponentTypes[this.type],
+      value: this.value,
+    };
+  }
+
+  /**
+   * Data that can be resolved to a TextInputStyle. This can be
+   * * TextInputStyle
+   * * number
+   * @typedef {number|TextInputStyle} TextInputStyleResolvable
+   */
+
+  /**
+   * Resolves the style of a text input component
+   * @param {TextInputStyleResolvable} style The style to resolve
+   * @returns {TextInputStyle}
+   * @private
+   */
+  static resolveStyle(style) {
+    return typeof style === 'string' ? style : TextInputStyles[style];
+  }
+}
+
+module.exports = TextInputComponent;