From 0ccc243c8ffbf852660c899cc2ad47bd5ebb65cb Mon Sep 17 00:00:00 2001 From: Suneet Tipirneni <77477100+suneettipirneni@users.noreply.github.com> Date: Sun, 5 Jun 2022 17:28:28 -0400 Subject: [PATCH] types(modal): fix `showModal()` typings (#8014) --- .../interfaces/InteractionResponses.js | 4 ++-- packages/discord.js/typings/index.d.ts | 21 ++++++++++++++++--- 2 files changed, 20 insertions(+), 5 deletions(-) diff --git a/packages/discord.js/src/structures/interfaces/InteractionResponses.js b/packages/discord.js/src/structures/interfaces/InteractionResponses.js index 981e4d424..e9e1a7907 100644 --- a/packages/discord.js/src/structures/interfaces/InteractionResponses.js +++ b/packages/discord.js/src/structures/interfaces/InteractionResponses.js @@ -8,10 +8,10 @@ const InteractionResponse = require('../InteractionResponse'); const MessagePayload = require('../MessagePayload'); /** - * @typedef {Object} ModalData + * @typedef {Object} ModalComponentData * @property {string} title The title of the modal * @property {string} customId The custom id of the modal - * @property {ActionRowData[]} components The components within this modal + * @property {ActionRow[]} components The components within this modal */ /** diff --git a/packages/discord.js/typings/index.d.ts b/packages/discord.js/typings/index.d.ts index cad5c9003..f99006ed0 100644 --- a/packages/discord.js/typings/index.d.ts +++ b/packages/discord.js/typings/index.d.ts @@ -400,7 +400,10 @@ export interface InteractionResponseFields fetchReply(): Promise; followUp(options: string | MessagePayload | InteractionReplyOptions): Promise; showModal( - modal: JSONEncodable | ModalData | APIModalInteractionResponseCallbackData, + modal: + | JSONEncodable + | ModalComponentData + | APIModalInteractionResponseCallbackData, ): Promise; awaitModalSubmit(options: AwaitModalSubmitOptions): Promise>; } @@ -448,7 +451,10 @@ export abstract class CommandInteraction e options: string | MessagePayload | InteractionReplyOptions, ): Promise>>; public showModal( - modal: JSONEncodable | ModalData | APIModalInteractionResponseCallbackData, + modal: + | JSONEncodable + | ModalComponentData + | APIModalInteractionResponseCallbackData, ): Promise; public awaitModalSubmit( options: AwaitModalSubmitOptions, @@ -1787,7 +1793,10 @@ export class MessageComponentInteraction e options: string | MessagePayload | InteractionUpdateOptions, ): Promise>>; public showModal( - modal: JSONEncodable | ModalData | APIModalInteractionResponseCallbackData, + modal: + | JSONEncodable + | ModalComponentData + | APIModalInteractionResponseCallbackData, ): Promise; public awaitModalSubmit( options: AwaitModalSubmitOptions, @@ -1882,6 +1891,12 @@ export class MessageReaction { public toJSON(): unknown; } +export interface ModalComponentData { + customId: string; + title: string; + components: (ActionRow | ActionRowData)[]; +} + export interface BaseModalData { customId: string; type: ComponentType;