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

fix: unsafe embed builder field normalization (#7418)

Browse Source
This commit is contained in:
Suneet Tipirneni
2022-02-07 05:52:10 -05:00
committed by GitHub
parent a921ec7dc5
commit b936103395
4 changed files with 22 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
packages/builders/src/components/Component.ts
View File

@@ -1,15 +1,12 @@
import type { APIMessageComponent, ComponentType } from 'discord-api-types/v9'; import type { APIMessageComponent, ComponentType } from 'discord-api-types/v9';
import type { JSONEncodable } from '../util/jsonEncodable';
/** /**
* Represents a discord component * Represents a discord component
*/ */
export interface Component { export interface Component extends JSONEncodable<APIMessageComponent> {
/** /**
* The type of this component * The type of this component
*/ */
readonly type: ComponentType; readonly type: ComponentType;
/**
* Converts this component to an API-compatible JSON object
*/
toJSON: () => APIMessageComponent;
} }

2
packages/builders/src/index.ts
View File

@@ -28,3 +28,5 @@ export * from './interactions/slashCommands/options/user';
export * as ContextMenuCommandAssertions from './interactions/contextMenuCommands/Assertions'; export * as ContextMenuCommandAssertions from './interactions/contextMenuCommands/Assertions';
export * from './interactions/contextMenuCommands/ContextMenuCommandBuilder'; export * from './interactions/contextMenuCommands/ContextMenuCommandBuilder';
export * from './util/jsonEncodable';

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

@@ -8,7 +8,7 @@ import type {
APIEmbedThumbnail, APIEmbedThumbnail,
APIEmbedVideo, APIEmbedVideo,
} from 'discord-api-types/v9'; } from 'discord-api-types/v9';
import { Embed } from './Embed'; import type { JSONEncodable } from '../../util/jsonEncodable';
export interface AuthorOptions { export interface AuthorOptions {
name: string; name: string;
@@ -21,7 +21,7 @@ export interface FooterOptions {
iconURL?: string; iconURL?: string;
} }
export class UnsafeEmbed implements APIEmbed { export class UnsafeEmbed implements APIEmbed, JSONEncodable<APIEmbed> {
/** /**
* An array of fields of this embed * An array of fields of this embed
*/ */
@@ -126,7 +126,7 @@ export class UnsafeEmbed implements APIEmbed {
* @param fields The fields to add * @param fields The fields to add
*/ */
public addFields(...fields: APIEmbedField[]): this { public addFields(...fields: APIEmbedField[]): this {
this.fields.push(...Embed.normalizeFields(...fields)); this.fields.push(...UnsafeEmbed.normalizeFields(...fields));
return this; return this;
} }
@@ -138,7 +138,7 @@ export class UnsafeEmbed implements APIEmbed {
* @param fields The replacing field objects * @param fields The replacing field objects
*/ */
public spliceFields(index: number, deleteCount: number, ...fields: APIEmbedField[]): this { public spliceFields(index: number, deleteCount: number, ...fields: APIEmbedField[]): this {
this.fields.splice(index, deleteCount, ...Embed.normalizeFields(...fields)); this.fields.splice(index, deleteCount, ...UnsafeEmbed.normalizeFields(...fields));
return this; return this;
} }

14
packages/builders/src/util/jsonEncodable.ts Normal file
View File

@@ -0,0 +1,14 @@
export interface JSONEncodable<T> {
/**
* Transforms this object to its JSON format
*/
toJSON: () => T;
}
/**
* Indicates if an object is encodable or not.
* @param maybeEncodable The object to check against
*/
export function isJSONEncodable(maybeEncodable: unknown): maybeEncodable is JSONEncodable<unknown> {
return maybeEncodable !== null && typeof maybeEncodable === 'object' && 'toJSON' in maybeEncodable;
}