feat: new select menus (#8793)

* feat(builders): new select menus * chore: better re-exporting of deprecated classes * feat: new select menus * chore: typings * chore: add missing todo comment * chore: finish updating tests * chore: add runtime deprecation warnings * chore: format deprecation warning * feat(BaseInteraction): isAnySelectMenu * chore: requested changes * fix: deprecation comments * chore: update @deprecated comments in typings * chore: add tests for select menu type narrowing * fix: bad auto imports Co-authored-by: Julian Vennen <julian@aternos.org> * fix: properly handle resolved members * fix: collectors * chore: suggested changes Co-authored-by: Almeida <almeidx@pm.me> * fix(typings): bad class extends * feat(ChannelSelectMenuBuilder): validation * chore: update todo comment * refactor(ChannelSelectMenu): better handling of channel_types state * chore: style nit * chore: suggested nits Co-authored-by: Aura Román <kyradiscord@gmail.com> Co-authored-by: Julian Vennen <julian@aternos.org> Co-authored-by: Almeida <almeidx@pm.me> Co-authored-by: Aura Román <kyradiscord@gmail.com> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
2026-03-12 01:23:31 +01:00 · 2022-11-01 19:36:05 +02:00
parent 8b400ca975
commit 5152abf728
50 changed files with 1528 additions and 469 deletions
--- a/packages/builders/src/components/selectMenu/StringSelectMenuOption.ts
+++ b/packages/builders/src/components/selectMenu/StringSelectMenuOption.ts
@@ -0,0 +1,98 @@
+import type { JSONEncodable } from '@discordjs/util';
+import type { APIMessageComponentEmoji, APISelectMenuOption } from 'discord-api-types/v10';
+import {
+	defaultValidator,
+	emojiValidator,
+	labelValueDescriptionValidator,
+	validateRequiredSelectMenuOptionParameters,
+} from '../Assertions.js';
+
+/**
+ * Represents an option within a string select menu component
+ */
+export class StringSelectMenuOptionBuilder implements JSONEncodable<APISelectMenuOption> {
+	/**
+	 * Creates a new string select menu option from API data
+	 *
+	 * @param data - The API data to create this string select menu option with
+	 * @example
+	 * Creating a string select menu option from an API data object
+	 * ```ts
+	 * const selectMenuOption = new SelectMenuOptionBuilder({
+	 * 	label: 'catchy label',
+	 * 	value: '1',
+	 * });
+	 * ```
+	 * @example
+	 * Creating a string select menu option using setters and API data
+	 * ```ts
+	 * const selectMenuOption = new SelectMenuOptionBuilder({
+	 * 	default: true,
+	 * 	value: '1',
+	 * })
+	 * 	.setLabel('woah')
+	 * ```
+	 */
+	public constructor(public data: Partial<APISelectMenuOption> = {}) {}
+
+	/**
+	 * Sets the label of this option
+	 *
+	 * @param label - The label to show on this option
+	 */
+	public setLabel(label: string) {
+		this.data.label = labelValueDescriptionValidator.parse(label);
+		return this;
+	}
+
+	/**
+	 * Sets the value of this option
+	 *
+	 * @param value - The value of this option
+	 */
+	public setValue(value: string) {
+		this.data.value = labelValueDescriptionValidator.parse(value);
+		return this;
+	}
+
+	/**
+	 * Sets the description of this option
+	 *
+	 * @param description - The description of this option
+	 */
+	public setDescription(description: string) {
+		this.data.description = labelValueDescriptionValidator.parse(description);
+		return this;
+	}
+
+	/**
+	 * Sets whether this option is selected by default
+	 *
+	 * @param isDefault - Whether this option is selected by default
+	 */
+	public setDefault(isDefault = true) {
+		this.data.default = defaultValidator.parse(isDefault);
+		return this;
+	}
+
+	/**
+	 * Sets the emoji to display on this option
+	 *
+	 * @param emoji - The emoji to display on this option
+	 */
+	public setEmoji(emoji: APIMessageComponentEmoji) {
+		this.data.emoji = emojiValidator.parse(emoji);
+		return this;
+	}
+
+	/**
+	 * {@inheritDoc ComponentBuilder.toJSON}
+	 */
+	public toJSON(): APISelectMenuOption {
+		validateRequiredSelectMenuOptionParameters(this.data.label, this.data.value);
+
+		return {
+			...this.data,
+		} as APISelectMenuOption;
+	}
+}