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

fix(EmbedBuilder): allow empty name and value on fields (#10747)

Browse Source
This commit is contained in:
Almeida
2025-02-10 21:55:17 +00:00
committed by GitHub
parent bffe8a423e
commit 49ef3a833e
2 changed files with 26 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
packages/builders/__tests__/messages/embed.test.ts
View File

@@ -324,12 +324,16 @@ describe('Embed', () => {
test('GIVEN an embed using Embed#addFields THEN returns valid toJSON data', () => { test('GIVEN an embed using Embed#addFields THEN returns valid toJSON data', () => {
const embed = new EmbedBuilder(); const embed = new EmbedBuilder();
embed.addFields({ name: 'foo', value: 'bar' }); embed.addFields({ name: 'foo', value: 'bar' });
embed.addFields([{ name: 'foo', value: 'bar' }]); embed.addFields([
{ name: 'foo', value: 'bar' },
{ name: '', value: '' },
]);
expect(embed.toJSON()).toStrictEqual({ expect(embed.toJSON()).toStrictEqual({
fields: [ fields: [
{ name: 'foo', value: 'bar' }, { name: 'foo', value: 'bar' },
{ name: 'foo', value: 'bar' }, { name: 'foo', value: 'bar' },
{ name: '', value: '' },
], ],
}); });
}); });
@@ -381,38 +385,24 @@ describe('Embed', () => {
expect(() => embed.setFields(Array.from({ length: 26 }, () => ({ name: 'foo', value: 'bar' })))).toThrowError(); expect(() => embed.setFields(Array.from({ length: 26 }, () => ({ name: 'foo', value: 'bar' })))).toThrowError();
}); });
describe('GIVEN invalid field amount THEN throws error', () => { test('GIVEN invalid field amount THEN throws error', () => {
test('1', () => { const embed = new EmbedBuilder();
const embed = new EmbedBuilder();
expect(() => expect(() =>
embed.addFields(...Array.from({ length: 26 }, () => ({ name: 'foo', value: 'bar' }))), embed.addFields(...Array.from({ length: 26 }, () => ({ name: 'foo', value: 'bar' }))),
).toThrowError(); ).toThrowError();
});
}); });
describe('GIVEN invalid field name THEN throws error', () => { test('GIVEN invalid field name length THEN throws error', () => {
test('2', () => { const embed = new EmbedBuilder();
const embed = new EmbedBuilder();
expect(() => embed.addFields({ name: '', value: 'bar' })).toThrowError(); expect(() => embed.addFields({ name: 'a'.repeat(257), value: 'bar' })).toThrowError();
});
}); });
describe('GIVEN invalid field name length THEN throws error', () => { test('GIVEN invalid field value length THEN throws error', () => {
test('3', () => { const embed = new EmbedBuilder();
const embed = new EmbedBuilder();
expect(() => embed.addFields({ name: 'a'.repeat(257), value: 'bar' })).toThrowError(); expect(() => embed.addFields({ name: '', value: 'a'.repeat(1_025) })).toThrowError();
});
});
describe('GIVEN invalid field value length THEN throws error', () => {
test('4', () => {
const embed = new EmbedBuilder();
expect(() => embed.addFields({ name: '', value: 'a'.repeat(1_025) })).toThrowError();
});
}); });
}); });
}); });

22
packages/builders/src/messages/embed/Assertions.ts
View File

@@ -2,17 +2,9 @@ import { s } from '@sapphire/shapeshift';
import type { APIEmbedField } from 'discord-api-types/v10'; import type { APIEmbedField } from 'discord-api-types/v10';
import { isValidationEnabled } from '../../util/validation.js'; import { isValidationEnabled } from '../../util/validation.js';
export const fieldNamePredicate = s export const fieldNamePredicate = s.string().lengthLessThanOrEqual(256).setValidationEnabled(isValidationEnabled);
.string()
.lengthGreaterThanOrEqual(1)
.lengthLessThanOrEqual(256)
.setValidationEnabled(isValidationEnabled);
export const fieldValuePredicate = s export const fieldValuePredicate = s.string().lengthLessThanOrEqual(1_024).setValidationEnabled(isValidationEnabled);
.string()
.lengthGreaterThanOrEqual(1)
.lengthLessThanOrEqual(1_024)
.setValidationEnabled(isValidationEnabled);
export const fieldInlinePredicate = s.boolean().optional(); export const fieldInlinePredicate = s.boolean().optional();
@@ -32,7 +24,10 @@ export function validateFieldLength(amountAdding: number, fields?: APIEmbedField
fieldLengthPredicate.parse((fields?.length ?? 0) + amountAdding); fieldLengthPredicate.parse((fields?.length ?? 0) + amountAdding);
} }
export const authorNamePredicate = fieldNamePredicate.nullable().setValidationEnabled(isValidationEnabled); export const authorNamePredicate = fieldNamePredicate
.lengthGreaterThanOrEqual(1)
.nullable()
.setValidationEnabled(isValidationEnabled);
export const imageURLPredicate = s export const imageURLPredicate = s
.string() .string()
@@ -96,4 +91,7 @@ export const embedFooterPredicate = s
export const timestampPredicate = s.union([s.number(), s.date()]).nullable().setValidationEnabled(isValidationEnabled); export const timestampPredicate = s.union([s.number(), s.date()]).nullable().setValidationEnabled(isValidationEnabled);
export const titlePredicate = fieldNamePredicate.nullable().setValidationEnabled(isValidationEnabled); export const titlePredicate = fieldNamePredicate
.lengthGreaterThanOrEqual(1)
.nullable()
.setValidationEnabled(isValidationEnabled);