Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-09 16:13:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

fix: Adjust label predicates and fix buttons emoji/label behaviour (#11317)

Browse Source 
* fix: buttons with custom id

* fix: button labels

* fix: also add refinement to link buttons

---------

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
Jiralite
2025-11-30 16:17:50 +00:00
committed by GitHub
parent d59857e901
commit ace834b274
3 changed files with 59 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
packages/builders/__tests__/components/button.test.ts
View File

@@ -5,7 +5,13 @@ import {
type APIButtonComponentWithURL,
} from 'discord-api-types/v10';
import { describe, test, expect } from 'vitest';
import { PrimaryButtonBuilder, PremiumButtonBuilder, LinkButtonBuilder } from '../../src/index.js';
import {
PrimaryButtonBuilder,
PremiumButtonBuilder,
LinkButtonBuilder,
DangerButtonBuilder,
SecondaryButtonBuilder,
} from '../../src/index.js';
const longStr =
'looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong';
@@ -25,6 +31,26 @@ describe('Button Components', () => {
button.toJSON();
}).not.toThrowError();
expect(() => {
const button = new SecondaryButtonBuilder().setCustomId('custom').setLabel('a'.repeat(80));
button.toJSON();
}).not.toThrowError();
expect(() => {
const button = new DangerButtonBuilder().setCustomId('custom').setEmoji({ name: 'ok' });
button.toJSON();
}).not.toThrowError();
expect(() => {
const button = new LinkButtonBuilder().setURL('https://discord.js.org').setLabel('a'.repeat(80));
button.toJSON();
}).not.toThrowError();
expect(() => {
const button = new LinkButtonBuilder().setURL('https://discord.js.org').setEmoji({ name: 'ok' });
button.toJSON();
}).not.toThrowError();
expect(() => {
const button = new PremiumButtonBuilder().setSKUId('123456789012345678');
button.toJSON();

9
packages/builders/__tests__/components/selectMenu.test.ts
View File

@@ -7,6 +7,9 @@ const selectMenuWithId = () => new StringSelectMenuBuilder({ custom_id: 'hi' });
const selectMenuOption = () => new StringSelectMenuOptionBuilder();
const longStr = 'a'.repeat(256);
const selectMenuOptionLabelAboveLimit = 'a'.repeat(101);
const selectMenuOptionValueAboveLimit = 'a'.repeat(101);
const selectMenuOptionDescriptionAboveLimit = 'a'.repeat(101);
const selectMenuOptionData: APISelectMenuOption = {
label: 'test',
@@ -196,13 +199,13 @@ describe('Select Menu Components', () => {
expect(() => {
selectMenuOption()
.setLabel(longStr)
.setValue(longStr)
.setLabel(selectMenuOptionLabelAboveLimit)
.setValue(selectMenuOptionValueAboveLimit)
// @ts-expect-error: Invalid default value
.setDefault(-1)
// @ts-expect-error: Invalid emoji
.setEmoji({ name: 1 })
.setDescription(longStr)
.setDescription(selectMenuOptionDescriptionAboveLimit)
.toJSON();
}).toThrowError();
});

30
packages/builders/src/components/Assertions.ts
View File

@@ -2,8 +2,6 @@ import { ButtonStyle, ChannelType, ComponentType, SelectMenuDefaultValueType } f
import { z } from 'zod';
import { idPredicate, customIdPredicate, snowflakePredicate } from '../Assertions.js';
const labelPredicate = z.string().min(1).max(80);
export const emojiPredicate = z
.strictObject({
id: snowflakePredicate.optional(),
@@ -19,22 +17,32 @@ const buttonPredicateBase = z.strictObject({
disabled: z.boolean().optional(),
});
const buttonCustomIdPredicateBase = buttonPredicateBase.extend({
const buttonLabelPredicate = z.string().min(1).max(80);
const buttonCustomIdPredicateBase = buttonPredicateBase
.extend({
custom_id: customIdPredicate,
emoji: emojiPredicate.optional(),
label: labelPredicate,
label: buttonLabelPredicate.optional(),
})
.refine((data) => data.emoji !== undefined || data.label !== undefined, {
message: 'Buttons with a custom id must have either an emoji or a label.',
});
const buttonPrimaryPredicate = buttonCustomIdPredicateBase.extend({ style: z.literal(ButtonStyle.Primary) });
const buttonSecondaryPredicate = buttonCustomIdPredicateBase.extend({ style: z.literal(ButtonStyle.Secondary) });
const buttonSuccessPredicate = buttonCustomIdPredicateBase.extend({ style: z.literal(ButtonStyle.Success) });
const buttonDangerPredicate = buttonCustomIdPredicateBase.extend({ style: z.literal(ButtonStyle.Danger) });
const buttonPrimaryPredicate = buttonCustomIdPredicateBase.safeExtend({ style: z.literal(ButtonStyle.Primary) });
const buttonSecondaryPredicate = buttonCustomIdPredicateBase.safeExtend({ style: z.literal(ButtonStyle.Secondary) });
const buttonSuccessPredicate = buttonCustomIdPredicateBase.safeExtend({ style: z.literal(ButtonStyle.Success) });
const buttonDangerPredicate = buttonCustomIdPredicateBase.safeExtend({ style: z.literal(ButtonStyle.Danger) });
const buttonLinkPredicate = buttonPredicateBase.extend({
const buttonLinkPredicate = buttonPredicateBase
.extend({
style: z.literal(ButtonStyle.Link),
url: z.url({ protocol: /^(?:https?|discord)$/ }).max(512),
emoji: emojiPredicate.optional(),
label: labelPredicate,
label: buttonLabelPredicate.optional(),
})
.refine((data) => data.emoji !== undefined || data.label !== undefined, {
message: 'Link buttons must have either an emoji or a label.',
});
const buttonPremiumPredicate = buttonPredicateBase.extend({
@@ -92,7 +100,7 @@ export const selectMenuRolePredicate = selectMenuBasePredicate.extend({
});
export const selectMenuStringOptionPredicate = z.object({
label: labelPredicate,
label: z.string().min(1).max(100),
value: z.string().min(1).max(100),
description: z.string().min(1).max(100).optional(),
emoji: emojiPredicate.optional(),