Add support for interaction callback response body

DonovanDMC · DonovanDMC · commit f337065cc36e · 2025-02-17T14:23:25.000-06:00
diff --git a/lib/routes/Interactions.ts b/lib/routes/Interactions.ts
@@ -1,11 +1,17 @@
 /** @module REST/Interactions */
-import type { EditInteractionContent, InteractionContent, InteractionResponse } from "../types/interactions";
+import type {
+    EditInteractionContent,
+    InteractionCallbackResponse,
+    InteractionContent,
+    InteractionResponse,
+    RawInteractionCallbackResponse
+} from "../types/interactions";
 import type { ExecuteWebhookWaitOptions } from "../types/webhooks";
 import * as Routes from "../util/Routes";
 import { InteractionResponseTypes } from "../Constants";
 import type RESTManager from "../rest/RESTManager";
 import type Message from "../structures/Message";
-import type { AnyTextableChannel } from "../types/channels";
+import type { AnyInteractionChannel, AnyTextableChannel } from "../types/channels";
 import type { Uncached } from "../types/shared";
 
 /** Various methods for interacting with interactions. Located at {@link Client#rest | Client#rest}{@link RESTManager#interactions | .interactions}. */
@@ -33,7 +39,7 @@ export default class Interactions {
      * @param options The options for creating the interaction response.
      * @caching This method **does not** cache its result.
      */
-    async createInteractionResponse(interactionID: string, interactionToken: string, options: InteractionResponse): Promise<void> {
+    async createInteractionResponse<CH extends AnyInteractionChannel | Uncached = AnyInteractionChannel | Uncached>(interactionID: string, interactionToken: string, options: InteractionResponse): Promise<InteractionCallbackResponse<CH>> {
         let data: unknown;
         switch (options.type) {
             case InteractionResponseTypes.PONG:
@@ -88,15 +94,29 @@ export default class Interactions {
                 break;
             }
         }
-        await this._manager.authRequest<null>({
+        return this._manager.authRequest<RawInteractionCallbackResponse>({
             method: "POST",
             path:   Routes.INTERACTION_CALLBACK(interactionID, interactionToken),
             route:  "/interactions/:id/:token/callback",
             json:   {
                 data,
                 type: options.type
             }
-        });
+        }).then(d => ({
+            interaction: {
+                activityInstanceID:       d.interaction.activity_instance_id,
+                id:                       d.interaction.id,
+                responseMessageEphemeral: d.interaction.response_message_ephemeral,
+                responseMessageID:        d.interaction.response_message_id,
+                responseMessageLoading:   d.interaction.response_message_loading,
+                type:                     d.interaction.type
+            },
+            resource: d.resource ? {
+                type:             d.resource.type,
+                activityInstance: d.resource.activity_instance,
+                message:          d.resource.message ? this._manager.client.util.updateMessage(d.resource.message) : undefined
+            } : undefined
+        }));
     }
 
     /**
diff --git a/lib/structures/AutocompleteInteraction.ts b/lib/structures/AutocompleteInteraction.ts
@@ -13,6 +13,7 @@ import type {
     AuthorizingIntegrationOwners,
     AutocompleteChoice,
     AutocompleteInteractionData,
+    InteractionCallbackResponse,
     InteractionGuild,
     RawAutocompleteInteraction
 } from "../types/interactions";
@@ -110,7 +111,7 @@ export default class AutocompleteInteraction<T extends AnyInteractionChannel | U
      * Acknowledge this interaction with a set of choices. This is an initial response, and more than one initial response cannot be used.
      * @param choices The choices to send.
      */
-    async result(choices: Array<AutocompleteChoice>): Promise<void> {
+    async result(choices: Array<AutocompleteChoice>): Promise<InteractionCallbackResponse> {
         if (this.acknowledged) {
             throw new TypeError("Interactions cannot have more than one initial response.");
         }
diff --git a/lib/structures/CommandInteraction.ts b/lib/structures/CommandInteraction.ts
@@ -23,7 +23,8 @@ import type {
     InitialInteractionContent,
     InteractionGuild,
     AuthorizingIntegrationOwners,
-    EditInteractionContent
+    EditInteractionContent,
+    InteractionCallbackResponse
 } from "../types/interactions";
 import type Client from "../Client";
 import type { RawMember } from "../types/guilds";
@@ -177,7 +178,7 @@ export default class CommandInteraction<T extends AnyInteractionChannel | Uncach
      */
     async createFollowup(options: InteractionContent): Promise<FollowupMessageInteractionResponse<this>> {
         const message = await this.client.rest.interactions.createFollowupMessage<T>(this.applicationID, this.token, options);
-        return new MessageInteractionResponse<CommandInteraction<T>>(this, message, "followup") as FollowupMessageInteractionResponse<this>;
+        return new MessageInteractionResponse<CommandInteraction<T>>(this, message, "followup", null) as FollowupMessageInteractionResponse<this>;
     }
 
     /**
@@ -195,15 +196,15 @@ export default class CommandInteraction<T extends AnyInteractionChannel | Uncach
             this.client.emit("warn", "You cannot attach files in an initial response. Defer the interaction, then use createFollowup.");
         }
         this.acknowledged = true;
-        await this.client.rest.interactions.createInteractionResponse(this.id, this.token, { type: InteractionResponseTypes.CHANNEL_MESSAGE_WITH_SOURCE, data: options });
-        return new MessageInteractionResponse<this>(this, null, "initial") as InitialMessagedInteractionResponse<this>;
+        const cb = await this.client.rest.interactions.createInteractionResponse(this.id, this.token, { type: InteractionResponseTypes.CHANNEL_MESSAGE_WITH_SOURCE, data: options });
+        return new MessageInteractionResponse<this>(this, null, "initial", cb) as InitialMessagedInteractionResponse<this>;
     }
 
     /**
      * Respond to this interaction with a modal. This is an initial response, and more than one initial response cannot be used.
      * @param options The options for the modal.
      */
-    async createModal(options: ModalData): Promise<void> {
+    async createModal(options: ModalData): Promise<InteractionCallbackResponse<T>> {
         if (this.acknowledged) {
             throw new TypeError("Interactions cannot have more than one initial response.");
         }
@@ -215,7 +216,7 @@ export default class CommandInteraction<T extends AnyInteractionChannel | Uncach
      * Defer this interaction. This is an initial response, and more than one initial response cannot be used.
      * @param flags The [flags](https://discord.com/developers/docs/resources/channel#message-object-message-flags) to respond with.
      */
-    async defer(flags?: number): Promise<void> {
+    async defer(flags?: number): Promise<InteractionCallbackResponse<T>> {
         if (this.acknowledged) {
             throw new TypeError("Interactions cannot have more than one initial response.");
         }
@@ -303,7 +304,7 @@ export default class CommandInteraction<T extends AnyInteractionChannel | Uncach
     /**
      * Launch the bot's activity. This is an initial response, and more than one initial response cannot be used.
      */
-    async launchActivity(): Promise<void> {
+    async launchActivity(): Promise<InteractionCallbackResponse<T>> {
         if (this.acknowledged) {
             throw new TypeError("Interactions cannot have more than one initial response.");
         }
@@ -316,7 +317,7 @@ export default class CommandInteraction<T extends AnyInteractionChannel | Uncach
      * Show a "premium required" response to the user. This is an initial response, and more than one initial response cannot be used.
      * @deprecated The {@link Constants~InteractionResponseTypes.PREMIUM_REQUIRED | PREMIUM_REQUIRED} interaction response type is now deprecated in favor of using {@link Types/Channels~PremiumButton | custom premium buttons}.
      */
-    async premiumRequired(): Promise<void> {
+    async premiumRequired(): Promise<InteractionCallbackResponse<T>> {
         if (this.acknowledged) {
             throw new TypeError("Interactions cannot have more than one initial response.");
         }
diff --git a/lib/structures/ComponentInteraction.ts b/lib/structures/ComponentInteraction.ts
@@ -16,6 +16,7 @@ import type {
     AuthorizingIntegrationOwners,
     EditInteractionContent,
     InitialInteractionContent,
+    InteractionCallbackResponse,
     InteractionContent,
     InteractionGuild,
     MessageComponentButtonInteractionData,
@@ -178,7 +179,7 @@ export default class ComponentInteraction<V extends ComponentTypes.BUTTON | Sele
      */
     async createFollowup(options: InteractionContent): Promise<FollowupMessageInteractionResponse<this>> {
         const message = await this.client.rest.interactions.createFollowupMessage<T>(this.applicationID, this.token, options);
-        return new MessageInteractionResponse<ComponentInteraction<V, T>>(this, message, "followup") as FollowupMessageInteractionResponse<this>;
+        return new MessageInteractionResponse<ComponentInteraction<V, T>>(this, message, "followup", null) as FollowupMessageInteractionResponse<this>;
     }
 
     /**
@@ -196,15 +197,15 @@ export default class ComponentInteraction<V extends ComponentTypes.BUTTON | Sele
             this.client.emit("warn", "You cannot attach files in an initial response. Defer the interaction, then use createFollowup.");
         }
         this.acknowledged = true;
-        await this.client.rest.interactions.createInteractionResponse(this.id, this.token, { type: InteractionResponseTypes.CHANNEL_MESSAGE_WITH_SOURCE, data: options });
-        return new MessageInteractionResponse<this>(this, null, "initial") as InitialMessagedInteractionResponse<this>;
+        const cb = await this.client.rest.interactions.createInteractionResponse(this.id, this.token, { type: InteractionResponseTypes.CHANNEL_MESSAGE_WITH_SOURCE, data: options });
+        return new MessageInteractionResponse<this>(this, null, "initial", cb) as InitialMessagedInteractionResponse<this>;
     }
 
     /**
      * Respond to this interaction with a modal. This is an initial response, and more than one initial response cannot be used.
      * @param options The options for the modal.
      */
-    async createModal(options: ModalData): Promise<void> {
+    async createModal(options: ModalData): Promise<InteractionCallbackResponse<T>> {
         if (this.acknowledged) {
             throw new TypeError("Interactions cannot have more than one initial response.");
         }
@@ -216,7 +217,7 @@ export default class ComponentInteraction<V extends ComponentTypes.BUTTON | Sele
      * Defer this interaction with a `DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE` response. This is an initial response, and more than one initial response cannot be used.
      * @param flags The [flags](https://discord.com/developers/docs/resources/channel#message-object-message-flags) to respond with.
      */
-    async defer(flags?: number): Promise<void> {
+    async defer(flags?: number): Promise<InteractionCallbackResponse<T>> {
         if (this.acknowledged) {
             throw new TypeError("Interactions cannot have more than one initial response.");
         }
@@ -228,7 +229,7 @@ export default class ComponentInteraction<V extends ComponentTypes.BUTTON | Sele
      * Defer this interaction with a `DEFERRED_UPDATE_MESSAGE` response. This is an initial response, and more than one initial response cannot be used.
      * @param flags The [flags](https://discord.com/developers/docs/resources/channel#message-object-message-flags) to respond with.
      */
-    async deferUpdate(flags?: number): Promise<void> {
+    async deferUpdate(flags?: number): Promise<InteractionCallbackResponse<T>> {
         if (this.acknowledged) {
             throw new TypeError("Interactions cannot have more than one initial response.");
         }
@@ -272,7 +273,7 @@ export default class ComponentInteraction<V extends ComponentTypes.BUTTON | Sele
      * Edit the message this interaction is from. If this interaction has already been acknowledged, use `editOriginal`.
      * @param options The options for editing the message.
      */
-    async editParent(options: InteractionContent): Promise<void> {
+    async editParent(options: InteractionContent): Promise<InteractionCallbackResponse<T>> {
         if (this.acknowledged) {
             throw new TypeError("Interactions cannot have more than one initial response.");
         }
@@ -319,17 +320,29 @@ export default class ComponentInteraction<V extends ComponentTypes.BUTTON | Sele
             || this.data.componentType === ComponentTypes.USER_SELECT;
     }
 
+    /**
+     * Launch the bot's activity. This is an initial response, and more than one initial response cannot be used.
+     */
+    async launchActivity(): Promise<InteractionCallbackResponse<T>> {
+        if (this.acknowledged) {
+            throw new TypeError("Interactions cannot have more than one initial response.");
+        }
+
+        this.acknowledged = true;
+        return this.client.rest.interactions.createInteractionResponse(this.id, this.token, { type: InteractionResponseTypes.LAUNCH_ACTIVITY });
+    }
+
     /**
      * Show a "premium required" response to the user. This is an initial response, and more than one initial response cannot be used.
      * @deprecated The {@link Constants~InteractionResponseTypes.PREMIUM_REQUIRED | PREMIUM_REQUIRED} interaction response type is now deprecated in favor of using {@link Types/Channels~PremiumButton | custom premium buttons}.
      */
-    async premiumRequired(): Promise<void> {
+    async premiumRequired(): Promise<InteractionCallbackResponse<T>> {
         if (this.acknowledged) {
             throw new TypeError("Interactions cannot have more than one initial response.");
         }
 
         this.acknowledged = true;
-        return this.client.rest.interactions.createInteractionResponse(this.id, this.token, { type: InteractionResponseTypes.PREMIUM_REQUIRED, data: {} });
+        return this.client.rest.interactions.createInteractionResponse(this.id, this.token, { type: InteractionResponseTypes.PREMIUM_REQUIRED });
     }
 
     /**
diff --git a/lib/structures/ModalSubmitInteraction.ts b/lib/structures/ModalSubmitInteraction.ts
@@ -14,6 +14,7 @@ import type {
     AuthorizingIntegrationOwners,
     EditInteractionContent,
     InitialInteractionContent,
+    InteractionCallbackResponse,
     InteractionContent,
     InteractionGuild,
     ModalSubmitInteractionData,
@@ -120,7 +121,7 @@ export default class ModalSubmitInteraction<T extends AnyInteractionChannel | Un
      */
     async createFollowup(options: InteractionContent): Promise<FollowupMessageInteractionResponse<this>> {
         const message = await this.client.rest.interactions.createFollowupMessage<T>(this.applicationID, this.token, options);
-        return new MessageInteractionResponse<ModalSubmitInteraction<T>>(this, message, "followup") as FollowupMessageInteractionResponse<this>;
+        return new MessageInteractionResponse<ModalSubmitInteraction<T>>(this, message, "followup", null) as FollowupMessageInteractionResponse<this>;
     }
 
     /**
@@ -138,15 +139,15 @@ export default class ModalSubmitInteraction<T extends AnyInteractionChannel | Un
             this.client.emit("warn", "You cannot attach files in an initial response. Defer the interaction, then use createFollowup.");
         }
         this.acknowledged = true;
-        await this.client.rest.interactions.createInteractionResponse(this.id, this.token, { type: InteractionResponseTypes.CHANNEL_MESSAGE_WITH_SOURCE, data: options });
-        return new MessageInteractionResponse<this>(this, null, "initial") as InitialMessagedInteractionResponse<this>;
+        const cb = await this.client.rest.interactions.createInteractionResponse(this.id, this.token, { type: InteractionResponseTypes.CHANNEL_MESSAGE_WITH_SOURCE, data: options });
+        return new MessageInteractionResponse<this>(this, null, "initial", cb) as InitialMessagedInteractionResponse<this>;
     }
 
     /**
      * Defer this interaction. This is an initial response, and more than one initial response cannot be used.
      * @param flags The [flags](https://discord.com/developers/docs/resources/channel#message-object-message-flags) to respond with.
      */
-    async defer(flags?: number): Promise<void> {
+    async defer(flags?: number): Promise<InteractionCallbackResponse<T>> {
         if (this.acknowledged) {
             throw new TypeError("Interactions cannot have more than one initial response.");
         }
@@ -158,7 +159,7 @@ export default class ModalSubmitInteraction<T extends AnyInteractionChannel | Un
      * Defer this interaction with a `DEFERRED_UPDATE_MESSAGE` response. This is an initial response, and more than one initial response cannot be used.
      * @param flags The [flags](https://discord.com/developers/docs/resources/channel#message-object-message-flags) to respond with.
      */
-    async deferUpdate(flags?: number): Promise<void> {
+    async deferUpdate(flags?: number): Promise<InteractionCallbackResponse<T>> {
         if (this.acknowledged) {
             throw new TypeError("Interactions cannot have more than one initial response.");
         }
@@ -202,7 +203,7 @@ export default class ModalSubmitInteraction<T extends AnyInteractionChannel | Un
      * Edit the message this interaction is from. If this interaction has already been acknowledged, use `createFollowup`.
      * @param options The options for editing the message.
      */
-    async editParent(options: InteractionContent): Promise<void> {
+    async editParent(options: InteractionContent): Promise<InteractionCallbackResponse<T>> {
         if (this.acknowledged) {
             throw new TypeError("Interactions cannot have more than one initial response.");
         }
@@ -235,17 +236,29 @@ export default class ModalSubmitInteraction<T extends AnyInteractionChannel | Un
         return this.guildID === null;
     }
 
+    /**
+     * Launch the bot's activity. This is an initial response, and more than one initial response cannot be used.
+     */
+    async launchActivity(): Promise<InteractionCallbackResponse<T>> {
+        if (this.acknowledged) {
+            throw new TypeError("Interactions cannot have more than one initial response.");
+        }
+
+        this.acknowledged = true;
+        return this.client.rest.interactions.createInteractionResponse(this.id, this.token, { type: InteractionResponseTypes.LAUNCH_ACTIVITY });
+    }
+
     /**
      * Show a "premium required" response to the user. This is an initial response, and more than one initial response cannot be used.
      * @deprecated The {@link Constants~InteractionResponseTypes.PREMIUM_REQUIRED | PREMIUM_REQUIRED} interaction response type is now deprecated in favor of using {@link Types/Channels~PremiumButton | custom premium buttons}.
      */
-    async premiumRequired(): Promise<void> {
+    async premiumRequired(): Promise<InteractionCallbackResponse<T>> {
         if (this.acknowledged) {
             throw new TypeError("Interactions cannot have more than one initial response.");
         }
 
         this.acknowledged = true;
-        return this.client.rest.interactions.createInteractionResponse(this.id, this.token, { type: InteractionResponseTypes.PREMIUM_REQUIRED, data: {} });
+        return this.client.rest.interactions.createInteractionResponse(this.id, this.token, { type: InteractionResponseTypes.PREMIUM_REQUIRED });
     }
 
     /**
diff --git a/lib/structures/PingInteraction.ts b/lib/structures/PingInteraction.ts
@@ -1,7 +1,7 @@
 /** @module PingInteraction */
 import Interaction from "./Interaction";
 import { InteractionResponseTypes, type InteractionTypes } from "../Constants";
-import type { RawPingInteraction } from "../types/interactions";
+import type { InteractionCallbackResponse, RawPingInteraction } from "../types/interactions";
 import type Client from "../Client";
 import type { JSONPingInteraction } from "../types/json";
 
@@ -15,7 +15,7 @@ export default class PingInteraction extends Interaction {
     /**
      * Responds to the interaction with a `PONG`.
      */
-    async pong(): Promise<void> {
+    async pong(): Promise<InteractionCallbackResponse> {
         return this.client.rest.interactions.createInteractionResponse(this.id, this.token, { type: InteractionResponseTypes.PONG });
     }
 
diff --git a/lib/types/interactions.d.ts b/lib/types/interactions.d.ts
diff --git a/lib/util/interactions/MessageInteractionResponse.ts b/lib/util/interactions/MessageInteractionResponse.ts
