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

fix(EmbedFieldBuilder): allow empty name and value (#10745)

Browse Source
This commit is contained in:
Almeida
2025-02-10 21:54:31 +00:00
committed by GitHub
parent af3ab2211a
commit 2183c5eebb
2 changed files with 21 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -341,13 +341,17 @@ 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({
...base, ...base,
fields: [ fields: [
{ name: 'foo', value: 'bar' }, { name: 'foo', value: 'bar' },
{ name: 'foo', value: 'bar' }, { name: 'foo', value: 'bar' },
{ name: '', value: '' },
], ],
}); });
}); });
@@ -395,40 +399,25 @@ describe('Embed', () => {
expect(() => embed.toJSON()).toThrowError(); expect(() => embed.toJSON()).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();
embed.addFields(...Array.from({ length: 26 }, () => ({ name: 'foo', value: 'bar' }))); embed.addFields(...Array.from({ length: 26 }, () => ({ name: 'foo', value: 'bar' })));
expect(() => embed.toJSON()).toThrowError(); expect(() => embed.toJSON()).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();
embed.addFields({ name: '', value: 'bar' }); embed.addFields({ name: 'a'.repeat(257), value: 'bar' });
expect(() => embed.toJSON()).toThrowError(); expect(() => embed.toJSON()).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();
embed.addFields({ name: 'a'.repeat(257), value: 'bar' }); embed.addFields({ name: '', value: 'a'.repeat(1_025) });
expect(() => embed.toJSON()).toThrowError(); expect(() => embed.toJSON()).toThrowError();
});
});
describe('GIVEN invalid field value length THEN throws error', () => {
test('4', () => {
const embed = new EmbedBuilder();
embed.addFields({ name: '', value: 'a'.repeat(1_025) });
expect(() => embed.toJSON()).toThrowError();
});
}); });
}); });
}); });

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

@@ -2,7 +2,7 @@ import { z } from 'zod';
import { refineURLPredicate } from '../../Assertions.js'; import { refineURLPredicate } from '../../Assertions.js';
import { embedLength } from '../../util/componentUtil.js'; import { embedLength } from '../../util/componentUtil.js';
const namePredicate = z.string().min(1).max(256); const namePredicate = z.string().max(256);
const iconURLPredicate = z const iconURLPredicate = z
.string() .string()
@@ -18,12 +18,12 @@ const URLPredicate = z
export const embedFieldPredicate = z.object({ export const embedFieldPredicate = z.object({
name: namePredicate, name: namePredicate,
value: z.string().min(1).max(1_024), value: z.string().max(1_024),
inline: z.boolean().optional(), inline: z.boolean().optional(),
}); });
export const embedAuthorPredicate = z.object({ export const embedAuthorPredicate = z.object({
name: namePredicate, name: namePredicate.min(1),
icon_url: iconURLPredicate.optional(), icon_url: iconURLPredicate.optional(),
url: URLPredicate.optional(), url: URLPredicate.optional(),
}); });
@@ -35,7 +35,7 @@ export const embedFooterPredicate = z.object({
export const embedPredicate = z export const embedPredicate = z
.object({ .object({
title: namePredicate.optional(), title: namePredicate.min(1).optional(),
description: z.string().min(1).max(4_096).optional(), description: z.string().min(1).max(4_096).optional(),
url: URLPredicate.optional(), url: URLPredicate.optional(),
timestamp: z.string().optional(), timestamp: z.string().optional(),