feat(builders): modal select menus in builders v1

packages/builders/__tests__/components/textInput.test.ts

@@ -100,7 +100,7 @@ describe('Text Input Components', () => {
 				.setPlaceholder('hello')
 				.setStyle(TextInputStyle.Paragraph)
 				.toJSON();
-		}).toThrowError();
+		}).not.toThrowError();
 	});
 
 	test('GIVEN valid input THEN valid JSON outputs are given', () => {

packages/builders/__tests__/components/v2/container.test.ts

@@ -1,8 +1,8 @@
 import { type APIContainerComponent, ComponentType, SeparatorSpacingSize } from 'discord-api-types/v10';
 import { describe, test, expect } from 'vitest';
-import { ButtonBuilder } from '../../../dist/index.mjs';
 import { ActionRowBuilder } from '../../../src/components/ActionRow.js';
 import { createComponentBuilder } from '../../../src/components/Components.js';
+import { ButtonBuilder } from '../../../src/components/button/Button.js';
 import { ContainerBuilder } from '../../../src/components/v2/Container.js';
 import { FileBuilder } from '../../../src/components/v2/File.js';
 import { MediaGalleryBuilder } from '../../../src/components/v2/MediaGallery.js';

packages/builders/package.json

@@ -68,7 +68,7 @@
 		"@discordjs/formatters": "workspace:^",
 		"@discordjs/util": "workspace:^",
 		"@sapphire/shapeshift": "^4.0.0",
-		"discord-api-types": "^0.38.16",
+		"discord-api-types": "^0.38.26",
 		"fast-deep-equal": "^3.1.3",
 		"ts-mixer": "^6.0.4",
 		"tslib": "^2.6.3"

packages/builders/src/components/Component.ts

@@ -5,6 +5,7 @@ import type {
 	APIBaseComponent,
 	ComponentType,
 	APIMessageComponent,
+	APIModalComponent,
 } from 'discord-api-types/v10';
 import { idValidator } from './Assertions';
 
@@ -14,7 +15,8 @@ import { idValidator } from './Assertions';
 export type AnyAPIActionRowComponent =
 	| APIActionRowComponent<APIComponentInActionRow>
 	| APIComponentInActionRow
-	| APIMessageComponent;
+	| APIMessageComponent
+	| APIModalComponent;
 
 /**
  * The base component builder that contains common symbols for all sorts of components.

packages/builders/src/components/Components.ts

@@ -8,6 +8,7 @@ import {
 } from './ActionRow.js';
 import { ComponentBuilder } from './Component.js';
 import { ButtonBuilder } from './button/Button.js';
+import { LabelBuilder } from './label/Label.js';
 import { ChannelSelectMenuBuilder } from './selectMenu/ChannelSelectMenu.js';
 import { MentionableSelectMenuBuilder } from './selectMenu/MentionableSelectMenu.js';
 import { RoleSelectMenuBuilder } from './selectMenu/RoleSelectMenu.js';
@@ -100,6 +101,10 @@ export interface MappedComponentTypes {
 	 * The media gallery component type is associated with a {@link MediaGalleryBuilder}.
 	 */
 	[ComponentType.MediaGallery]: MediaGalleryBuilder;
+	/**
+	 * The label component type is associated with a {@link LabelBuilder}.
+	 */
+	[ComponentType.Label]: LabelBuilder;
 }
 
 /**
@@ -161,6 +166,8 @@ export function createComponentBuilder(
 			return new ThumbnailBuilder(data);
 		case ComponentType.MediaGallery:
 			return new MediaGalleryBuilder(data);
+		case ComponentType.Label:
+			return new LabelBuilder(data);
 		default:
 			// @ts-expect-error This case can still occur if we get a newer unsupported component type
 			throw new Error(`Cannot properly serialize component type: ${data.type}`);

packages/builders/src/components/label/Assertions.ts

@@ -0,0 +1,29 @@
+import { s } from '@sapphire/shapeshift';
+import { ComponentType } from 'discord-api-types/v10';
+import { isValidationEnabled } from '../../util/validation.js';
+import { idValidator } from '../Assertions.js';
+import {
+	selectMenuChannelPredicate,
+	selectMenuMentionablePredicate,
+	selectMenuRolePredicate,
+	selectMenuStringPredicate,
+	selectMenuUserPredicate,
+} from '../selectMenu/Assertions.js';
+import { textInputPredicate } from '../textInput/Assertions.js';
+
+export const labelPredicate = s
+	.object({
+		id: idValidator,
+		type: s.literal(ComponentType.Label),
+		label: s.string().lengthGreaterThanOrEqual(1).lengthLessThanOrEqual(45),
+		description: s.string().lengthGreaterThanOrEqual(1).lengthLessThanOrEqual(100).optional(),
+		component: s.union([
+			textInputPredicate,
+			selectMenuUserPredicate,
+			selectMenuRolePredicate,
+			selectMenuMentionablePredicate,
+			selectMenuChannelPredicate,
+			selectMenuStringPredicate,
+		]),
+	})
+	.setValidationEnabled(isValidationEnabled);

packages/builders/src/components/label/Label.ts

@@ -0,0 +1,198 @@
+import type {
+	APIChannelSelectComponent,
+	APILabelComponent,
+	APIMentionableSelectComponent,
+	APIRoleSelectComponent,
+	APIStringSelectComponent,
+	APITextInputComponent,
+	APIUserSelectComponent,
+} from 'discord-api-types/v10';
+import { ComponentType } from 'discord-api-types/v10';
+import { ComponentBuilder } from '../Component.js';
+import { createComponentBuilder, resolveBuilder } from '../Components.js';
+import { ChannelSelectMenuBuilder } from '../selectMenu/ChannelSelectMenu.js';
+import { MentionableSelectMenuBuilder } from '../selectMenu/MentionableSelectMenu.js';
+import { RoleSelectMenuBuilder } from '../selectMenu/RoleSelectMenu.js';
+import { StringSelectMenuBuilder } from '../selectMenu/StringSelectMenu.js';
+import { UserSelectMenuBuilder } from '../selectMenu/UserSelectMenu.js';
+import { TextInputBuilder } from '../textInput/TextInput.js';
+import { labelPredicate } from './Assertions.js';
+
+export interface LabelBuilderData extends Partial<Omit<APILabelComponent, 'component'>> {
+	component?:
+		| ChannelSelectMenuBuilder
+		| MentionableSelectMenuBuilder
+		| RoleSelectMenuBuilder
+		| StringSelectMenuBuilder
+		| TextInputBuilder
+		| UserSelectMenuBuilder;
+}
+
+/**
+ * A builder that creates API-compatible JSON data for labels.
+ */
+export class LabelBuilder extends ComponentBuilder<LabelBuilderData> {
+	/**
+	 * @internal
+	 */
+	public override readonly data: LabelBuilderData;
+
+	/**
+	 * Creates a new label.
+	 *
+	 * @param data - The API data to create this label with
+	 * @example
+	 * Creating a label from an API data object:
+	 * ```ts
+	 * const label = new LabelBuilder({
+	 * 	label: "label",
+	 * 	component,
+	 * });
+	 * ```
+	 * @example
+	 * Creating a label using setters and API data:
+	 * ```ts
+	 * const label = new LabelBuilder({
+	 * 	label: 'label',
+	 * 	component,
+	 * }).setContent('new text');
+	 * ```
+	 */
+	public constructor(data: Partial<APILabelComponent> = {}) {
+		super({ type: ComponentType.Label });
+
+		const { component, ...rest } = data;
+
+		this.data = {
+			...rest,
+			component: component ? createComponentBuilder(component) : undefined,
+			type: ComponentType.Label,
+		};
+	}
+
+	/**
+	 * Sets the label for this label.
+	 *
+	 * @param label - The label to use
+	 */
+	public setLabel(label: string) {
+		this.data.label = label;
+		return this;
+	}
+
+	/**
+	 * Sets the description for this label.
+	 *
+	 * @param description - The description to use
+	 */
+	public setDescription(description: string) {
+		this.data.description = description;
+		return this;
+	}
+
+	/**
+	 * Clears the description for this label.
+	 */
+	public clearDescription() {
+		this.data.description = undefined;
+		return this;
+	}
+
+	/**
+	 * Sets a string select menu component to this label.
+	 *
+	 * @param input - A function that returns a component builder or an already built builder
+	 */
+	public setStringSelectMenuComponent(
+		input:
+			| APIStringSelectComponent
+			| StringSelectMenuBuilder
+			| ((builder: StringSelectMenuBuilder) => StringSelectMenuBuilder),
+	): this {
+		this.data.component = resolveBuilder(input, StringSelectMenuBuilder);
+		return this;
+	}
+
+	/**
+	 * Sets a user select menu component to this label.
+	 *
+	 * @param input - A function that returns a component builder or an already built builder
+	 */
+	public setUserSelectMenuComponent(
+		input: APIUserSelectComponent | UserSelectMenuBuilder | ((builder: UserSelectMenuBuilder) => UserSelectMenuBuilder),
+	): this {
+		this.data.component = resolveBuilder(input, UserSelectMenuBuilder);
+		return this;
+	}
+
+	/**
+	 * Sets a role select menu component to this label.
+	 *
+	 * @param input - A function that returns a component builder or an already built builder
+	 */
+	public setRoleSelectMenuComponent(
+		input: APIRoleSelectComponent | RoleSelectMenuBuilder | ((builder: RoleSelectMenuBuilder) => RoleSelectMenuBuilder),
+	): this {
+		this.data.component = resolveBuilder(input, RoleSelectMenuBuilder);
+		return this;
+	}
+
+	/**
+	 * Sets a mentionable select menu component to this label.
+	 *
+	 * @param input - A function that returns a component builder or an already built builder
+	 */
+	public setMentionableSelectMenuComponent(
+		input:
+			| APIMentionableSelectComponent
+			| MentionableSelectMenuBuilder
+			| ((builder: MentionableSelectMenuBuilder) => MentionableSelectMenuBuilder),
+	): this {
+		this.data.component = resolveBuilder(input, MentionableSelectMenuBuilder);
+		return this;
+	}
+
+	/**
+	 * Sets a channel select menu component to this label.
+	 *
+	 * @param input - A function that returns a component builder or an already built builder
+	 */
+	public setChannelSelectMenuComponent(
+		input:
+			| APIChannelSelectComponent
+			| ChannelSelectMenuBuilder
+			| ((builder: ChannelSelectMenuBuilder) => ChannelSelectMenuBuilder),
+	): this {
+		this.data.component = resolveBuilder(input, ChannelSelectMenuBuilder);
+		return this;
+	}
+
+	/**
+	 * Sets a text input component to this label.
+	 *
+	 * @param input - A function that returns a component builder or an already built builder
+	 */
+	public setTextInputComponent(
+		input: APITextInputComponent | TextInputBuilder | ((builder: TextInputBuilder) => TextInputBuilder),
+	): this {
+		this.data.component = resolveBuilder(input, TextInputBuilder);
+		return this;
+	}
+
+	/**
+	 * {@inheritDoc ComponentBuilder.toJSON}
+	 */
+	public override toJSON(): APILabelComponent {
+		const { component, ...rest } = this.data;
+
+		const data = {
+			...rest,
+			// The label predicate validates the component.
+			component: component?.toJSON(),
+		};
+
+		labelPredicate.parse(data);
+
+		return data as APILabelComponent;
+	}
+}

packages/builders/src/components/selectMenu/Assertions.ts

@@ -0,0 +1,92 @@
+import { Result, s } from '@sapphire/shapeshift';
+import { ChannelType, ComponentType, SelectMenuDefaultValueType } from 'discord-api-types/v10';
+import { isValidationEnabled } from '../../util/validation.js';
+import { customIdValidator, emojiValidator, idValidator } from '../Assertions';
+import { labelValidator } from '../textInput/Assertions.js';
+
+const selectMenuBasePredicate = s.object({
+	id: idValidator,
+	placeholder: s.string().lengthLessThanOrEqual(150).optional(),
+	min_values: s.number().greaterThanOrEqual(0).lessThanOrEqual(25).optional(),
+	max_values: s.number().greaterThanOrEqual(0).lessThanOrEqual(25).optional(),
+	custom_id: customIdValidator,
+	disabled: s.boolean().optional(),
+});
+
+export const selectMenuChannelPredicate = selectMenuBasePredicate
+	.extend({
+		type: s.literal(ComponentType.ChannelSelect),
+		channel_types: s.nativeEnum(ChannelType).array().optional(),
+		default_values: s
+			.object({ id: s.string(), type: s.literal(SelectMenuDefaultValueType.Channel) })
+			.array()
+			.lengthLessThanOrEqual(25)
+			.optional(),
+	})
+	.setValidationEnabled(isValidationEnabled);
+
+export const selectMenuMentionablePredicate = selectMenuBasePredicate
+	.extend({
+		type: s.literal(ComponentType.MentionableSelect),
+		default_values: s
+			.object({
+				id: s.string(),
+				type: s.literal([SelectMenuDefaultValueType.Role, SelectMenuDefaultValueType.User]),
+			})
+			.array()
+			.lengthLessThanOrEqual(25)
+			.optional(),
+	})
+	.setValidationEnabled(isValidationEnabled);
+
+export const selectMenuRolePredicate = selectMenuBasePredicate
+	.extend({
+		type: s.literal(ComponentType.RoleSelect),
+		default_values: s
+			.object({ id: s.string(), type: s.literal(SelectMenuDefaultValueType.Role) })
+			.array()
+			.lengthLessThanOrEqual(25)
+			.optional(),
+	})
+	.setValidationEnabled(isValidationEnabled);
+
+export const selectMenuUserPredicate = selectMenuBasePredicate
+	.extend({
+		type: s.literal(ComponentType.UserSelect),
+		default_values: s
+			.object({ id: s.string(), type: s.literal(SelectMenuDefaultValueType.User) })
+			.array()
+			.lengthLessThanOrEqual(25)
+			.optional(),
+	})
+	.setValidationEnabled(isValidationEnabled);
+
+export const selectMenuStringOptionPredicate = s
+	.object({
+		label: labelValidator,
+		value: s.string().lengthGreaterThanOrEqual(1).lengthLessThanOrEqual(100),
+		description: s.string().lengthGreaterThanOrEqual(1).lengthLessThanOrEqual(100).optional(),
+		emoji: emojiValidator.optional(),
+		default: s.boolean().optional(),
+	})
+	.setValidationEnabled(isValidationEnabled);
+
+export const selectMenuStringPredicate = selectMenuBasePredicate
+	.extend({
+		type: s.literal(ComponentType.StringSelect),
+		options: selectMenuStringOptionPredicate.array().lengthGreaterThanOrEqual(1).lengthLessThanOrEqual(25),
+	})
+	.reshape((value) => {
+		if (value.min_values !== undefined && value.options.length < value.min_values) {
+			return Result.err(new RangeError(`The number of options must be greater than or equal to min_values`));
+		}
+
+		if (value.min_values !== undefined && value.max_values !== undefined && value.min_values > value.max_values) {
+			return Result.err(
+				new RangeError(`The maximum amount of options must be greater than or equal to the minimum amount of options`),
+			);
+		}
+
+		return Result.ok(value);
+	})
+	.setValidationEnabled(isValidationEnabled);