entry point commands

DonovanDMC · DonovanDMC · commit 1a26479df44c · 2025-02-17T13:31:34.000-06:00
discord/discord-api-docs#7106
diff --git a/lib/Constants.ts b/lib/Constants.ts
@@ -1088,9 +1088,10 @@ export enum AuditLogActionTypes {
 }
 
 export enum ApplicationCommandTypes {
-    CHAT_INPUT = 1,
-    USER       = 2,
-    MESSAGE    = 3,
+    CHAT_INPUT          = 1,
+    USER                = 2,
+    MESSAGE             = 3,
+    PRIMARY_ENTRY_POINT = 4,
 }
 
 export enum ApplicationCommandOptionTypes {
@@ -1123,6 +1124,12 @@ export enum InteractionResponseTypes {
     MODAL                                   = 9,
     /** @deprecated */
     PREMIUM_REQUIRED                        = 10,
+    LAUNCH_ACTIVITY                         = 12,
+}
+
+export enum EntryPointCommandHandlerTypes {
+    APP_HANDLER             = 1,
+    DISCORD_LAUNCH_ACTIVITY = 2,
 }
 
 export enum Intents {
diff --git a/lib/routes/Applications.ts b/lib/routes/Applications.ts
@@ -31,6 +31,7 @@ import type {
     ApplicationEmoji,
     ApplicationEmojis,
     CreateApplicationEmojiOptions,
+    CreatePrimaryEntryPointApplicationCommandOptions,
     EditApplicationEmojiOptions,
     EditApplicationOptions,
     RESTApplication,
@@ -67,6 +68,7 @@ export default class Applications {
                 default_member_permissions: opt.defaultMemberPermissions,
                 description_localizations:  opt.descriptionLocalizations,
                 dm_permission:              opt.dmPermission,
+                handler:                    (opt as unknown as CreatePrimaryEntryPointApplicationCommandOptions).handler,
                 integration_types:          opt.integrationTypes,
                 name:                       opt.name,
                 name_localizations:         opt.nameLocalizations,
@@ -151,12 +153,13 @@ export default class Applications {
             json:   {
                 contexts:                   opt.contexts,
                 default_member_permissions: opt.defaultMemberPermissions,
-                description:                opt.description,
                 description_localizations:  opt.descriptionLocalizations,
+                description:                opt.description,
                 dm_permission:              opt.dmPermission,
+                handler:                    (opt as unknown as CreatePrimaryEntryPointApplicationCommandOptions).handler,
                 integration_types:          opt.integrationTypes,
-                name:                       opt.name,
                 name_localizations:         opt.nameLocalizations,
+                name:                       opt.name,
                 nsfw:                       opt.nsfw,
                 options:                    opt.options?.map(o => this._manager.client.util.optionToRaw(o)),
                 type:                       opt.type
diff --git a/lib/routes/Interactions.ts b/lib/routes/Interactions.ts
@@ -36,7 +36,9 @@ export default class Interactions {
     async createInteractionResponse(interactionID: string, interactionToken: string, options: InteractionResponse): Promise<void> {
         let data: unknown;
         switch (options.type) {
-            case InteractionResponseTypes.PONG: {
+            case InteractionResponseTypes.PONG:
+            case InteractionResponseTypes.PREMIUM_REQUIRED:
+            case InteractionResponseTypes.LAUNCH_ACTIVITY: {
                 break;
             }
             case InteractionResponseTypes.CHANNEL_MESSAGE_WITH_SOURCE:
diff --git a/lib/structures/ApplicationCommand.ts b/lib/structures/ApplicationCommand.ts
@@ -4,7 +4,7 @@ import Permission from "./Permission";
 import type Guild from "./Guild";
 import type ClientApplication from "./ClientApplication";
 import type Client from "../Client";
-import { ApplicationCommandTypes, type InteractionContextTypes, type ApplicationIntegrationTypes } from "../Constants";
+import { ApplicationCommandTypes, type InteractionContextTypes, type ApplicationIntegrationTypes, type EntryPointCommandHandlerTypes } from "../Constants";
 import type {
     ApplicationCommandOptionConversion,
     ApplicationCommandOptions,
@@ -38,6 +38,8 @@ export default class ApplicationCommand<T extends ApplicationCommandTypes = Appl
     dmPermission?: boolean;
     /** The id of the guild this command is in (guild commands only). */
     guildID: string | null;
+    /** The handler of this command. Only valid for `PRIMARY_ENTRY_POINT` commands. */
+    handler?: EntryPointCommandHandlerTypes;
     /** The installation contexts in which this command is available. */
     integrationTypes: Array<ApplicationIntegrationTypes>;
     /** The name of this command. */
@@ -65,6 +67,7 @@ export default class ApplicationCommand<T extends ApplicationCommandTypes = Appl
         this.descriptionLocalized = data.description_localized;
         this.dmPermission = data.dm_permission;
         this.guildID = data.guild_id ?? null;
+        this.handler = data.handler;
         this.integrationTypes = data.integration_types;
         this.name = data.name;
         this.nameLocalizations = data.name_localizations;
@@ -147,6 +150,7 @@ export default class ApplicationCommand<T extends ApplicationCommandTypes = Appl
             descriptionLocalizations: this.descriptionLocalizations,
             dmPermission:             this.dmPermission,
             guildID:                  this.guildID ?? undefined,
+            handler:                  this.handler,
             integrationTypes:         this.integrationTypes,
             name:                     this.name,
             nameLocalizations:        this.nameLocalizations,
diff --git a/lib/structures/CommandInteraction.ts b/lib/structures/CommandInteraction.ts
@@ -290,11 +290,28 @@ export default class CommandInteraction<T extends AnyInteractionChannel | Uncach
         return this.data.type === ApplicationCommandTypes.MESSAGE;
     }
 
+    /** A type guard, checking if this command interaction is a {@link Constants~ApplicationCommandTypes.PRIMARY_ENTRY_POINT | Primary Entry Point} command. */
+    isPrimaryEntryPointCommand(): this is CommandInteraction<T, ApplicationCommandTypes.PRIMARY_ENTRY_POINT> {
+        return this.data.type === ApplicationCommandTypes.PRIMARY_ENTRY_POINT;
+    }
+
     /** A type guard, checking if this command interaction is a {@link Constants~ApplicationCommandTypes.USER | User} command. */
     isUserCommand(): this is CommandInteraction<T, ApplicationCommandTypes.USER> {
         return this.data.type === ApplicationCommandTypes.USER;
     }
 
+    /**
+     * Launch the bot's activity. This is an initial response, and more than one initial response cannot be used.
+     */
+    async launchActivity(): Promise<void> {
+        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}.
@@ -305,7 +322,7 @@ export default class CommandInteraction<T extends AnyInteractionChannel | Uncach
         }
 
         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/types/applications.d.ts b/lib/types/applications.d.ts
@@ -13,6 +13,7 @@ import type {
     ApplicationVerificationState,
     EntitlementOwnerTypes,
     EntitlementTypes,
+    EntryPointCommandHandlerTypes,
     InteractionContextTypes,
     RPCApplicationState,
     SKUAccessTypes,
@@ -120,6 +121,7 @@ export interface RawApplicationCommand {
     description_localized?: string;
     dm_permission?: boolean;
     guild_id?: string;
+    handler?: EntryPointCommandHandlerTypes;
     id: string;
     integration_types: Array<ApplicationIntegrationTypes>;
     name: string;
@@ -173,19 +175,21 @@ export interface RawApplicationCommandOptionChoice {
     value: string | number;
 }
 
-export type AnyApplicationCommand = ChatInputApplicationCommand | UserApplicationCommand | MessageApplicationCommand;
+export type AnyApplicationCommand = ChatInputApplicationCommand | UserApplicationCommand | MessageApplicationCommand | PrimaryEntryPointApplicationCommand;
 export type ApplicationCommandOptions = ApplicationCommandOptionsWithOptions | ApplicationCommandOptionsWithValue;
 export type ApplicationCommandOptionsWithOptions = ApplicationCommandOptionsSubCommand | ApplicationCommandOptionsSubCommandGroup;
 export type ApplicationCommandOptionsWithValue = ApplicationCommandOptionsString | ApplicationCommandOptionsInteger | ApplicationCommandOptionsBoolean | ApplicationCommandOptionsUser | ApplicationCommandOptionsChannel | ApplicationCommandOptionsRole | ApplicationCommandOptionsMentionable | ApplicationCommandOptionsNumber | ApplicationCommandOptionsAttachment;
 export type ChatInputApplicationCommand = ApplicationCommand<ApplicationCommandTypes.CHAT_INPUT>;
 export type UserApplicationCommand = ApplicationCommand<ApplicationCommandTypes.USER>;
 export type MessageApplicationCommand = ApplicationCommand<ApplicationCommandTypes.MESSAGE>;
+export type PrimaryEntryPointApplicationCommand = ApplicationCommand<ApplicationCommandTypes.PRIMARY_ENTRY_POINT>;
 
 export type ApplicationCommandOptionConversion<T extends EditApplicationCommandOptions | CreateApplicationCommandOptions> =
     T extends EditChatInputApplicationCommandOptions | CreateChatInputApplicationCommandOptions ? ChatInputApplicationCommand :
         T extends EditUserApplicationCommandOptions | CreateUserApplicationCommandOptions ? UserApplicationCommand :
             T extends EditMessageApplicationCommandOptions | CreateMessageApplicationCommandOptions ? MessageApplicationCommand :
-                never;
+                T extends EditPrimaryEntryPointApplicationCommandOptions | CreatePrimaryEntryPointApplicationCommandOptions ? PrimaryEntryPointApplicationCommand :
+                    never;
 
 
 export interface ApplicationCommandOptionBase<T extends ApplicationCommandOptionTypes = ApplicationCommandOptionTypes> {
@@ -278,7 +282,7 @@ export interface CreateApplicationCommandOptionsBase<T extends ApplicationComman
     type: T;
 }
 
-export type CreateApplicationCommandOptions = CreateChatInputApplicationCommandOptions | CreateUserApplicationCommandOptions | CreateMessageApplicationCommandOptions;
+export type CreateApplicationCommandOptions = CreateChatInputApplicationCommandOptions | CreateUserApplicationCommandOptions | CreateMessageApplicationCommandOptions | CreatePrimaryEntryPointApplicationCommandOptions;
 export interface CreateGuildChatInputApplicationCommandOptions extends Omit<CreateChatInputApplicationCommandOptions, "dmPermission" | "integrationTypes" | "contexts"> {}
 export interface CreateGuildUserApplicationCommandOptions extends Omit<CreateUserApplicationCommandOptions, "dmPermission" | "integrationTypes" | "contexts"> {}
 export interface CreateGuildMessageApplicationCommandOptions extends Omit<CreateMessageApplicationCommandOptions, "dmPermission" | "integrationTypes" | "contexts"> {}
@@ -292,13 +296,17 @@ export interface CreateChatInputApplicationCommandOptions extends CreateApplicat
     options?: Array<ApplicationCommandOptions>;
 }
 
-export type CreateUserApplicationCommandOptions = CreateApplicationCommandOptionsBase<ApplicationCommandTypes.USER>;
-export type CreateMessageApplicationCommandOptions = CreateApplicationCommandOptionsBase<ApplicationCommandTypes.MESSAGE>;
+export interface CreateUserApplicationCommandOptions extends CreateApplicationCommandOptionsBase<ApplicationCommandTypes.USER> {}
+export interface CreateMessageApplicationCommandOptions extends CreateApplicationCommandOptionsBase<ApplicationCommandTypes.MESSAGE> {}
+export interface CreatePrimaryEntryPointApplicationCommandOptions extends CreateApplicationCommandOptionsBase<ApplicationCommandTypes.PRIMARY_ENTRY_POINT> {
+    handler: EntryPointCommandHandlerTypes;
+}
 
-export type EditApplicationCommandOptions = EditChatInputApplicationCommandOptions | EditUserApplicationCommandOptions | EditMessageApplicationCommandOptions;
+export type EditApplicationCommandOptions = EditChatInputApplicationCommandOptions | EditUserApplicationCommandOptions | EditMessageApplicationCommandOptions | EditPrimaryEntryPointApplicationCommandOptions;
 export interface EditChatInputApplicationCommandOptions extends Partial<Omit<CreateChatInputApplicationCommandOptions, "type">> {}
 export interface EditUserApplicationCommandOptions extends Partial<Omit<CreateUserApplicationCommandOptions, "type">> {}
 export interface EditMessageApplicationCommandOptions extends Partial<Omit<CreateMessageApplicationCommandOptions, "type">> {}
+export interface EditPrimaryEntryPointApplicationCommandOptions extends Partial<Omit<CreatePrimaryEntryPointApplicationCommandOptions, "type">> {}
 
 export type EditGuildApplicationCommandOptions = EditGuildChatInputApplicationCommandOptions | EditGuildUserApplicationCommandOptions | EditGuildMessageApplicationCommandOptions;
 export interface EditGuildChatInputApplicationCommandOptions extends Partial<Omit<CreateChatInputApplicationCommandOptions, "type" | "dmPermission" | "integrationTypes" | "contexts">> {}
diff --git a/lib/types/interactions.d.ts b/lib/types/interactions.d.ts
@@ -49,7 +49,7 @@ export interface InteractionContent extends Pick<ExecuteWebhookOptions, "tts" |
 export interface EditInteractionContent extends Pick<EditWebhookMessageOptions, "content" | "embeds" | "allowedMentions" | "components" | "attachments" | "files"> {}
 export interface InitialInteractionContent extends Omit<InteractionContent, "attachments" | "files"> {}
 
-export type InteractionResponse = PingInteractionResponse | MessageInteractionResponse | DeferredInteractionResponse | AutocompleteInteractionResponse | ModalSubmitInteractionResponse | PremiumRequiredResponse;
+export type InteractionResponse = PingInteractionResponse | MessageInteractionResponse | DeferredInteractionResponse | AutocompleteInteractionResponse | ModalSubmitInteractionResponse | PremiumRequiredResponse | LaunchActivityResponse;
 export interface PingInteractionResponse {
     type: InteractionResponseTypes.PONG;
 }
@@ -79,10 +79,13 @@ export interface ModalSubmitInteractionResponse {
 }
 
 export interface PremiumRequiredResponse {
-    data: Record<string, never>;
     type: InteractionResponseTypes.PREMIUM_REQUIRED;
 }
 
+export interface LaunchActivityResponse {
+    type: InteractionResponseTypes.LAUNCH_ACTIVITY;
+}
+
 
 export interface ModalData {
     /** The components of the modal. Each component needs its own row. `snake_case` keys should be converted to `camelCase`, or passed through {@link Util.rawModalComponents | Util#rawModalComponents}. */
diff --git a/lib/types/json.d.ts b/lib/types/json.d.ts
@@ -84,7 +84,8 @@ import type {
     ApplicationMonetizationState,
     RPCApplicationState,
     StoreApplicationState,
-    ApplicationVerificationState
+    ApplicationVerificationState,
+    EntryPointCommandHandlerTypes
 } from "../Constants";
 
 export interface JSONAnnouncementChannel extends JSONThreadableChannel {
@@ -143,6 +144,7 @@ export interface JSONApplicationCommand extends JSONBase {
     descriptionLocalizations?: LocaleMap | null;
     dmPermission?: boolean;
     guildID?: string;
+    handler?: EntryPointCommandHandlerTypes;
     integrationTypes: Array<ApplicationIntegrationTypes>;
     name: string;
     nameLocalizations?: LocaleMap | null;

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ export interface InteractionContent extends Pick<ExecuteWebhookOptions, "tts" \|`
`49`	`49`	`export interface EditInteractionContent extends Pick<EditWebhookMessageOptions, "content" \| "embeds" \| "allowedMentions" \| "components" \| "attachments" \| "files"> {}`
`50`	`50`	`export interface InitialInteractionContent extends Omit<InteractionContent, "attachments" \| "files"> {}`
`51`	`51`
`52`		`-export type InteractionResponse = PingInteractionResponse \| MessageInteractionResponse \| DeferredInteractionResponse \| AutocompleteInteractionResponse \| ModalSubmitInteractionResponse \| PremiumRequiredResponse;`
	`52`	`+export type InteractionResponse = PingInteractionResponse \| MessageInteractionResponse \| DeferredInteractionResponse \| AutocompleteInteractionResponse \| ModalSubmitInteractionResponse \| PremiumRequiredResponse \| LaunchActivityResponse;`
`53`	`53`	`export interface PingInteractionResponse {`
`54`	`54`	`type: InteractionResponseTypes.PONG;`
`55`	`55`	`}`
`@@ -79,10 +79,13 @@ export interface ModalSubmitInteractionResponse {`
`79`	`79`	`}`
`80`	`80`
`81`	`81`	`export interface PremiumRequiredResponse {`
`82`		`- data: Record<string, never>;`
`83`	`82`	`type: InteractionResponseTypes.PREMIUM_REQUIRED;`
`84`	`83`	`}`
`85`	`84`
	`85`	`+export interface LaunchActivityResponse {`
	`86`	`+ type: InteractionResponseTypes.LAUNCH_ACTIVITY;`
	`87`	`+}`
	`88`	`+`
`86`	`89`
`87`	`90`	`export interface ModalData {`
`88`	`91`	/** The components of the modal. Each component needs its own row. `snake_case` keys should be converted to `camelCase`, or passed through {@link Util.rawModalComponents \| Util#rawModalComponents}. */