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

types: cleanup *Data type definitions (#7716)

Browse Source
This commit is contained in:
Suneet Tipirneni
2022-04-19 10:00:55 -04:00
committed by GitHub
parent ec8d87f932
commit 585169f2f0
2 changed files with 51 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
packages/discord.js/typings/index.d.ts vendored
View File

@@ -216,27 +216,29 @@ export class Activity {
export type ActivityFlagsString = keyof typeof ActivityFlags;
export interface BaseComponentData {
type?: ComponentType;
type: ComponentType;
}
export type MessageActionRowComponentData = ButtonComponentData | SelectMenuComponentData;
export type MessageActionRowComponentData =
| JSONEncodable<APIMessageActionRowComponent>
| ButtonComponentData
| SelectMenuComponentData;
export type ModalActionRowComponentData = TextInputComponentData;
export type ModalActionRowComponentData = JSONEncodable<APIModalActionRowComponent> | TextInputComponentData;
export type ActionRowComponentData = MessageActionRowComponentData | ModalActionRowComponentData;
export type ActionRowComponent = MessageActionRowComponent | ModalActionRowComponent;
export type ActionRowComponentBuilder = MessageActionRowComponentBuilder | ModalActionRowComponentBuilder;
export interface ActionRowData<T extends ActionRowComponentBuilder | ActionRowComponentData> extends BaseComponentData {
export interface ActionRowData<T extends JSONEncodable<APIActionRowComponentTypes> | ActionRowComponentData>
extends BaseComponentData {
components: T[];
}
export class ActionRowBuilder<T extends AnyComponentBuilder = AnyComponentBuilder> extends BuilderActionRow<T> {
constructor(
data?: Partial<
| ActionRowData<ActionRowComponentData | ActionRowComponentBuilder>
| ActionRowData<ActionRowComponentData | JSONEncodable<APIActionRowComponentTypes>>
| APIActionRowComponent<APIMessageActionRowComponent | APIModalActionRowComponent>
>,
);
@@ -587,7 +589,7 @@ export class ButtonComponent extends Component<APIButtonComponent> {
export type ComponentEmojiResolvable = APIMessageComponentEmoji | string;
export class ButtonBuilder extends BuilderButtonComponent {
public constructor(data?: ButtonComponentData | (Omit<APIButtonComponent, 'type'> & { type?: ComponentType.Button }));
public constructor(data?: Partial<ButtonComponentData> | Partial<APIButtonComponent>);
public static from(other: JSONEncodable<APIButtonComponent> | APIButtonComponent): ButtonBuilder;
public override setEmoji(emoji: ComponentEmojiResolvable): this;
}
@@ -4736,9 +4738,9 @@ export interface MakeErrorOptions {
stack: string;
}
export type ActionRowComponentOptions =
| (Required<BaseComponentData> & ButtonComponentData)
| (Required<BaseComponentData> & SelectMenuComponentData);
export type MemberMention = UserMention | `<@!${Snowflake}>`;
export type ActionRowComponentOptions = ButtonComponentData | SelectMenuComponentData;
export type MessageActionRowComponentResolvable = MessageActionRowComponent | ActionRowComponentOptions;
@@ -4748,6 +4750,7 @@ export interface MessageActivity {
}
export interface BaseButtonComponentData extends BaseComponentData {
style: ButtonStyle;
disabled?: boolean;
emoji?: ComponentEmojiResolvable;
label?: string;
@@ -4795,7 +4798,8 @@ export interface MessageEditOptions {
allowedMentions?: MessageMentionOptions;
components?: (
| JSONEncodable<APIActionRowComponent<APIMessageActionRowComponent>>
| (Required<BaseComponentData> & ActionRowData<MessageActionRowComponentData | MessageActionRowComponentBuilder>)
| ActionRow<MessageActionRowComponent>
| ActionRowData<MessageActionRowComponentData | MessageActionRowComponentBuilder>
| APIActionRowComponent<APIMessageActionRowComponent>
)[];
}
@@ -4836,7 +4840,7 @@ export interface MessageOptions {
embeds?: (JSONEncodable<APIEmbed> | APIEmbed)[];
components?: (
| JSONEncodable<APIActionRowComponent<APIMessageActionRowComponent>>
| (Required<BaseComponentData> & ActionRowData<MessageActionRowComponentData | MessageActionRowComponentBuilder>)
| ActionRowData<MessageActionRowComponentData | MessageActionRowComponentBuilder>
| APIActionRowComponent<APIMessageActionRowComponent>
)[];
allowedMentions?: MessageMentionOptions;
@@ -4864,6 +4868,7 @@ export interface MessageReference {
export type MessageResolvable = Message | Snowflake;
export interface SelectMenuComponentData extends BaseComponentData {
type: ComponentType.SelectMenu;
customId: string;
disabled?: boolean;
maxValues?: number;
@@ -4889,6 +4894,7 @@ export interface SelectMenuComponentOptionData {
}
export interface TextInputComponentData extends BaseComponentData {
type: ComponentType.TextInput;
customId: string;
style: TextInputStyle;
label: string;

35
packages/discord.js/typings/index.test-d.ts
View File

@@ -526,6 +526,34 @@ client.on('guildCreate', async g => {
const channel = g.channels.cache.random();
if (!channel) return;
if (channel.isText()) {
const row: ActionRowData<MessageActionRowComponentData> = {
type: ComponentType.ActionRow,
components: [
new ButtonBuilder(),
{ type: ComponentType.Button, style: ButtonStyle.Primary, label: 'string', customId: 'foo' },
{ type: ComponentType.Button, style: ButtonStyle.Link, label: 'test', url: 'test' },
{ type: ComponentType.SelectMenu, customId: 'foo' },
new SelectMenuBuilder(),
// @ts-expect-error
{ type: ComponentType.TextInput, style: TextInputStyle.Paragraph, customId: 'foo', label: 'test' },
// @ts-expect-error
new TextInputBuilder(),
],
};
const row2 = new ActionRowBuilder<MessageActionRowComponentBuilder>({
type: ComponentType.ActionRow,
components: [
{ type: ComponentType.Button, style: ButtonStyle.Primary, label: 'string', customId: 'foo' },
{ type: ComponentType.Button, style: ButtonStyle.Link, label: 'test', url: 'test' },
{ type: ComponentType.SelectMenu, customId: 'foo' },
],
});
channel.send({ components: [row, row2] });
}
if (channel.isThread()) {
const fetchedMember = await channel.members.fetch({ member: '12345678' });
expectType<ThreadMember>(fetchedMember);
@@ -738,7 +766,7 @@ client.on('messageCreate', async message => {
// Check that both builders and builder data can be sent in messages
const row = new ActionRowBuilder<MessageActionRowComponentBuilder>();
const buttonsRow = {
const buttonsRow: ActionRowData<MessageActionRowComponentData> = {
type: ComponentType.ActionRow,
components: [
new ButtonBuilder(),
@@ -747,12 +775,12 @@ client.on('messageCreate', async message => {
{
type: ComponentType.Button,
label: 'another test',
style: ButtonStyle.Link as const,
style: ButtonStyle.Link,
url: 'https://discord.js.org',
},
],
};
const selectsRow = {
const selectsRow: ActionRowData<MessageActionRowComponentData> = {
type: ComponentType.ActionRow,
components: [
new SelectMenuBuilder(),
@@ -765,6 +793,7 @@ client.on('messageCreate', async message => {
},
],
};
const buildersEmbed = new UnsafeEmbedBuilder();
const embedData = { description: 'test', color: 0xff0000 };
channel.send({ components: [row, buttonsRow, selectsRow], embeds: [embed, buildersEmbed, embedData] });