feat: user-installable apps

packages/builders/src/interactions/contextMenuCommands/ContextMenuCommandBuilder.ts

@@ -67,6 +67,8 @@ export class ContextMenuCommandBuilder {
 	 *
 	 * @remarks
 	 * By default, commands are visible. This property is only for global commands.
+	 * @deprecated
+	 * Use {@link ContextMenuCommandBuilder.contexts} instead.
 	 */
 	public readonly dm_permission: boolean | undefined = undefined;
 
@@ -167,6 +169,7 @@ export class ContextMenuCommandBuilder {
 	 * By default, commands are visible. This method is only for global commands.
 	 * @param enabled - Whether the command should be enabled in direct messages
 	 * @see {@link https://discord.com/developers/docs/interactions/application-commands#permissions}
+	 * @deprecated Use {@link ContextMenuCommandBuilder.setContexts} instead.
 	 */
 	public setDMPermission(enabled: boolean | null | undefined) {
 		// Assert the value matches the conditions

packages/builders/src/interactions/slashCommands/SlashCommandBuilder.ts

@@ -63,6 +63,8 @@ export class SlashCommandBuilder {
 	 *
 	 * @remarks
 	 * By default, commands are visible. This property is only for global commands.
+	 * @deprecated
+	 * Use {@link SlashCommandBuilder.contexts} instead.
 	 */
 	public readonly dm_permission: boolean | undefined = undefined;
 

packages/builders/src/interactions/slashCommands/mixins/SharedSlashCommand.ts

@@ -42,6 +42,9 @@ export class SharedSlashCommand {
 
 	public readonly default_member_permissions: Permissions | null | undefined = undefined;
 
+	/**
+	 * @deprecated Use {@link SharedSlashCommand.contexts} instead.
+	 */
 	public readonly dm_permission: boolean | undefined = undefined;
 
 	public readonly integration_types?: ApplicationIntegrationType[];
@@ -112,6 +115,8 @@ export class SharedSlashCommand {
 	 * By default, commands are visible. This method is only for global commands.
 	 * @param enabled - Whether the command should be enabled in direct messages
 	 * @see {@link https://discord.com/developers/docs/interactions/application-commands#permissions}
+	 * @deprecated
+	 * Use {@link SharedSlashCommand.setContexts} instead.
 	 */
 	public setDMPermission(enabled: boolean | null | undefined) {
 		// Assert the value matches the conditions

packages/discord.js/src/managers/ApplicationCommandManager.js

@@ -259,6 +259,8 @@ class ApplicationCommandManager extends CachedManager {
       options: command.options?.map(option => ApplicationCommand.transformOption(option)),
       default_member_permissions,
       dm_permission: command.dmPermission ?? command.dm_permission,
+      integration_types: command.integrationTypes ?? command.integration_types,
+      contexts: command.contexts,
     };
   }
 }

packages/discord.js/src/managers/PartialGroupDMMessageManager.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const MessageManager = require('./MessageManager');
+
+/**
+ * Manages API methods for messages in group direct message channels and holds their cache.
+ * @extends {MessageManager}
+ */
+class PartialGroupDMMessageManager extends MessageManager {
+  /**
+   * The channel that the messages belong to
+   * @name PartialGroupDMMessageManager#channel
+   * @type {PartialGroupDMChannel}
+   */
+}
+
+module.exports = PartialGroupDMMessageManager;

packages/discord.js/src/structures/ApplicationCommand.js

@@ -145,12 +145,35 @@ class ApplicationCommand extends Base {
        * Whether the command can be used in DMs
        * <info>This property is always `null` on guild commands</info>
        * @type {?boolean}
+       * @deprecated Use {@link ApplicationCommand#contexts} instead.
        */
       this.dmPermission = data.dm_permission;
     } else {
       this.dmPermission ??= null;
     }
 
+    if ('integration_types' in data) {
+      /**
+       * Installation context(s) where the command is available
+       * <info>Only for globally-scoped commands</info>
+       * @type {?ApplicationIntegrationType[]}
+       */
+      this.integrationTypes = data.integration_types;
+    } else {
+      this.integrationTypes ??= null;
+    }
+
+    if ('contexts' in data) {
+      /**
+       * Interaction context(s) where the command can be used
+       * <info>Only for globally-scoped commands</info>
+       * @type {?InteractionContextType[]}
+       */
+      this.contexts = data.contexts;
+    } else {
+      this.contexts ??= null;
+    }
+
     if ('version' in data) {
       /**
        * Autoincrementing version identifier updated during substantial record changes
@@ -394,7 +417,9 @@ class ApplicationCommand extends Base {
       !isEqual(
         command.descriptionLocalizations ?? command.description_localizations ?? {},
         this.descriptionLocalizations ?? {},
-      )
+      ) ||
+      !isEqual(command.integrationTypes ?? command.integration_types ?? [], this.integrationTypes ?? {}) ||
+      !isEqual(command.contexts ?? [], this.contexts ?? [])
     ) {
       return false;
     }

packages/discord.js/src/structures/BaseInteraction.js

@@ -75,9 +75,9 @@ class BaseInteraction extends Base {
 
     /**
      * Set of permissions the application or bot has within the channel the interaction was sent from
-     * @type {?Readonly<PermissionsBitField>}
+     * @type {Readonly<PermissionsBitField>}
      */
-    this.appPermissions = data.app_permissions ? new PermissionsBitField(data.app_permissions).freeze() : null;
+    this.appPermissions = new PermissionsBitField(data.app_permissions).freeze();
 
     /**
      * The permissions of the member, if one exists, in the channel this interaction was executed in

packages/discord.js/src/structures/ClientApplication.js

@@ -14,8 +14,8 @@ const PermissionsBitField = require('../util/PermissionsBitField');
 
 /**
  * @typedef {Object} ClientApplicationInstallParams
- * @property {OAuth2Scopes[]} scopes The scopes to add the application to the server with
- * @property {Readonly<PermissionsBitField>} permissions The permissions this bot will request upon joining
+ * @property {OAuth2Scopes[]} scopes Scopes that will be set upon adding this application
+ * @property {Readonly<PermissionsBitField>} permissions Permissions that will be requested for the integrated role
  */
 
 /**
@@ -61,6 +61,52 @@ class ClientApplication extends Application {
       this.installParams ??= null;
     }
 
+    /**
+     * OAuth2 installation paremeters.
+     * @typedef {Object} IntegrationTypesConfigurationParameters
+     * @property {?string[]} scopes Scopes that will be set upon adding this application
+     * @property {?Readonly<PermissionsBitField>} permissions Permissions that will be requested for the integrated role
+     */
+
+    /**
+     * The application's supported installation context data.
+     * @typedef {Object} IntegrationTypesConfigurationContext
+     * @property {?IntegrationTypesConfigurationParameters} oauth2InstallParams
+     * Scopes and permissions regarding the installation context
+     */
+
+    /**
+     * The application's supported installation context data.
+     * @typedef {Object} IntegrationTypesConfiguration
+     * @property {?IntegrationTypesConfigurationContext} 0 Scopes and permissions
+     * regarding the guild-installation context
+     * @property {?IntegrationTypesConfigurationContext} 1 Scopes and permissions
+     * regarding the user-installation context
+     */
+
+    if ('integration_types_config' in data) {
+      /**
+       * Default scopes and permissions for each supported installation context.
+       * The keys are stringified variants of {@link ApplicationIntegrationType}.
+       * @type {IntegrationTypesConfiguration}
+       */
+      this.integrationTypesConfig = Object.fromEntries(
+        Object.entries(data.integration_types_config).map(([key, config]) => {
+          const context = {
+            oauth2InstallParams: {
+              scopes: config.oauth2_install_params?.scopes ?? null,
+              permissions: config.oauth2_install_params
+                ? new PermissionsBitField(config.oauth2_install_params.permissions).freeze()
+                : null,
+            },
+          };
+          return [parseInt(key), context];
+        }),
+      );
+    } else {
+      this.integrationTypesConfig ??= null;
+    }
+
     if ('custom_install_url' in data) {
       /**
        * This application's custom installation URL
@@ -89,6 +135,16 @@ class ClientApplication extends Application {
       this.approximateGuildCount ??= null;
     }
 
+    if ('approximate_user_install_count' in data) {
+      /**
+       * An approximate amount of users that have installed this application.
+       * @type {?number}
+       */
+      this.approximateUserInstallCount = data.approximate_user_install_count;
+    } else {
+      this.approximateUserInstallCount ??= null;
+    }
+
     if ('guild_id' in data) {
       /**
        * The id of the guild associated with this application.

packages/discord.js/src/structures/CommandInteraction.js

@@ -4,6 +4,7 @@ const Attachment = require('./Attachment');
 const BaseInteraction = require('./BaseInteraction');
 const InteractionWebhook = require('./InteractionWebhook');
 const InteractionResponses = require('./interfaces/InteractionResponses');
+const { _transformAPIAuthorizingIntegrationOwners } = require('../util/Transformers');
 
 /**
  * Represents a command interaction.
@@ -45,6 +46,25 @@ class CommandInteraction extends BaseInteraction {
      */
     this.commandGuildId = data.data.guild_id ?? null;
 
+    /**
+     * Owner IDs the integration is installed on.
+     * @typedef {Object} AuthorizingIntegrationOwners
+     * @property {?Snowflake} 0 The guild id the integration is installed on
+     * @property {?Snowflake} 1 The user id the integration is installed on
+     */
+
+    /**
+     * Mapping of installation contexts that the interaction was authorized for the related user or guild ids
+     * @type {AuthorizingIntegrationOwners}
+     */
+    this.authorizingIntegrationOwners = _transformAPIAuthorizingIntegrationOwners(data.authorizingIntegrationOwners);
+
+    /**
+     * Context where the interaction was triggered from
+     * @type {?InteractionContextType}
+     */
+    this.context = data.context ?? null;
+
     /**
      * Whether the reply to this interaction has been deferred
      * @type {boolean}

packages/discord.js/src/structures/Message.js

@@ -26,6 +26,7 @@ const { createComponent } = require('../util/Components');
 const { NonSystemMessageTypes, MaxBulkDeletableMessageAge, UndeletableMessageTypes } = require('../util/Constants');
 const MessageFlagsBitField = require('../util/MessageFlagsBitField');
 const PermissionsBitField = require('../util/PermissionsBitField');
+const { _transformAPIAuthorizingIntegrationOwners } = require('../util/Transformers.js');
 const { cleanContent, resolvePartialEmoji, transformResolved } = require('../util/Util');
 
 /**
@@ -383,6 +384,38 @@ class Message extends Base {
       this.channel?.messages._add({ guild_id: data.message_reference?.guild_id, ...data.referenced_message });
     }
 
+    if (data.interaction_metadata) {
+      /**
+       * Partial data of the interaction that this message is a result of
+       * @typedef {Object} MessageInteractionMetadata
+       * @property {Snowflake} id The interaction's id
+       * @property {InteractionType} type The type of the interaction
+       * @property {User} user The user that invoked the interaction
+       * @property {AuthorizingIntegrationOwners} authorizingIntegrationOwners
+       * Ids for installation context(s) related to an interaction
+       * @property {?Snowflake} originalResponseMessageId
+       * Id of the original response message. Present only on follow-up messages
+       * @property {?Snowflake} interactedMessageId
+       * Id of the message that contained interactive component.
+       * Present only on messages created from component interactions
+       * @property {?MessageInteractionMetadata} triggeringInteractionMetadata
+       * Metadata for the interaction that was used to open the modal. Present only on modal submit interactions
+       */
+      this.interactionMetadata = {
+        id: data.interaction_metadata.id,
+        type: data.interaction_metadata.type,
+        user: this.client.users._add(data.interaction_metadata.user),
+        authorizingIntegrationOwners: _transformAPIAuthorizingIntegrationOwners(
+          data.interaction_metadata.authorizing_integration_owners,
+        ),
+        originalResponseMessageId: data.interaction_metadata.original_response_message_id ?? null,
+        interactedMessageId: data.interaction_metadata.interacted_message_id ?? null,
+        triggeringInteractionMetadata: data.interaction_metadata.triggering_interaction_metadata ?? null,
+      };
+    } else {
+      this.interactionMetadata ??= null;
+    }
+
     /**
      * Partial data of the interaction that a message is a reply to
      * @typedef {Object} MessageInteraction
@@ -391,6 +424,7 @@ class Message extends Base {
      * @property {string} commandName The name of the interaction's application command,
      * as well as the subcommand and subcommand group, where applicable
      * @property {User} user The user that invoked the interaction
+     * @deprecated Use {@link Message#interactionMetadata} instead.
      */
 
     if (data.interaction) {

packages/discord.js/src/structures/PartialGroupDMChannel.js

@@ -2,6 +2,7 @@
 
 const { BaseChannel } = require('./BaseChannel');
 const { DiscordjsError, ErrorCodes } = require('../errors');
+const PartialGroupDMMessageManager = require('../managers/PartialGroupDMMessageManager');
 
 /**
  * Represents a Partial Group DM Channel on Discord.
@@ -37,6 +38,12 @@ class PartialGroupDMChannel extends BaseChannel {
      * @type {PartialRecipient[]}
      */
     this.recipients = data.recipients;
+
+    /**
+     * A manager of the messages belonging to this channel
+     * @type {PartialGroupDMMessageManager}
+     */
+    this.messages = new PartialGroupDMMessageManager(this);
   }
 
   /**

packages/discord.js/src/util/Transformers.js

@@ -33,4 +33,14 @@ function _transformAPIAutoModerationAction(autoModerationAction) {
   };
 }
 
-module.exports = { toSnakeCase, _transformAPIAutoModerationAction };
+/**
+ * Transforms an API authorizing integration owners map to keyed by enum.
+ * @param {APIAuthorizingIntegrationOwnersMap} authorizingIntegrationOwners The data to transform
+ * @returns {AuthorizingIntegrationOwners}
+ * @ignore
+ */
+function _transformAPIAuthorizingIntegrationOwners(authorizingIntegrationOwners) {
+  return Object.fromEntries(Object.entries(authorizingIntegrationOwners).map(([key, owner]) => [parseInt(key), owner]));
+}
+
+module.exports = { toSnakeCase, _transformAPIAutoModerationAction, _transformAPIAuthorizingIntegrationOwners };