feat: add support for application command permissions v2 (#415)

discordjs · May 12, 2022 · d3163ca · d3163ca
1 parent 1737ade
commit d3163ca
Show file tree

Hide file tree

Showing 28 changed files with 208 additions and 30 deletions.
diff --git a/deno/gateway/v10.ts b/deno/gateway/v10.ts
@@ -195,6 +195,7 @@ export enum GatewayIntentBits {
  * https://discord.com/developers/docs/topics/gateway#commands-and-events-gateway-events
  */
 export enum GatewayDispatchEvents {
+	ApplicationCommandPermissionsUpdate = 'APPLICATION_COMMAND_PERMISSIONS_UPDATE',
 	ChannelCreate = 'CHANNEL_CREATE',
 	ChannelDelete = 'CHANNEL_DELETE',
 	ChannelPinsUpdate = 'CHANNEL_PINS_UPDATE',

diff --git a/deno/gateway/v9.ts b/deno/gateway/v9.ts
@@ -194,6 +194,7 @@ export enum GatewayIntentBits {
  * https://discord.com/developers/docs/topics/gateway#commands-and-events-gateway-events
  */
 export enum GatewayDispatchEvents {
+	ApplicationCommandPermissionsUpdate = 'APPLICATION_COMMAND_PERMISSIONS_UPDATE',
 	ChannelCreate = 'CHANNEL_CREATE',
 	ChannelDelete = 'CHANNEL_DELETE',
 	ChannelPinsUpdate = 'CHANNEL_PINS_UPDATE',

diff --git a/deno/payloads/v10/_interactions/_applicationCommands/permissions.ts b/deno/payloads/v10/_interactions/_applicationCommands/permissions.ts
@@ -27,11 +27,11 @@ export interface APIGuildApplicationCommandPermissions {
  */
 export interface APIApplicationCommandPermission {
 	/**
-	 * The id of the role or user
+	 * The id of the role, user or channel. Can also be a permission constant
 	 */
 	id: Snowflake;
 	/**
-	 * Role or user
+	 * Role, user or channel
 	 */
 	type: ApplicationCommandPermissionType;
 	/**
@@ -46,4 +46,13 @@ export interface APIApplicationCommandPermission {
 export enum ApplicationCommandPermissionType {
 	Role = 1,
 	User,
+	Channel,
 }
+
+/**
+ * https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-application-command-permissions-constants
+ */
+export const APIApplicationCommandPermissionsConstant = {
+	Everyone: (guildId: string | bigint): Snowflake => String(guildId),
+	AllChannels: (guildId: string | bigint): Snowflake => String(BigInt(guildId) - 1n),
+};
diff --git a/deno/payloads/v10/_interactions/applicationCommands.ts b/deno/payloads/v10/_interactions/applicationCommands.ts
@@ -70,10 +70,19 @@ export interface APIApplicationCommand {
 	 * The parameters for the `CHAT_INPUT` command, max 25
 	 */
 	options?: APIApplicationCommandOption[];
+	/**
+	 * Set of permissions represented as a bitset
+	 */
+	default_member_permissions?: Permissions | null;
+	/**
+	 * Indicates whether the command is available in DMs with the app, only for globally-scoped commands. By default, commands are visible
+	 */
+	dm_permission?: boolean | null;
 	/**
 	 * Whether the command is enabled by default when the app is added to a guild
 	 *
 	 * If missing, this property should be assumed as `true`
+	 * @deprecated Use `dm_permission` and/or `default_member_permissions` instead
 	 */
 	default_permission?: boolean;
 	/**

diff --git a/deno/payloads/v10/auditLog.ts b/deno/payloads/v10/auditLog.ts
@@ -16,6 +16,7 @@ import type {
 	GuildScheduledEventEntityType,
 	GuildScheduledEventStatus,
 } from './guildScheduledEvent.ts';
+import type { APIApplicationCommand } from './interactions.ts';
 import type { APIRole } from './permissions.ts';
 import type { StageInstancePrivacyLevel } from './stageInstance.ts';
 import type { StickerFormatType } from './sticker.ts';
@@ -27,6 +28,12 @@ import type { Snowflake } from '../../globals.ts';
  * https://discord.com/developers/docs/resources/audit-log#audit-log-object-audit-log-structure
  */
 export interface APIAuditLog {
+	/**
+	 * List of application commands found in the audit log
+	 *
+	 * See https://discord.com/developers/docs/interactions/application-commands#application-command-object
+	 */
+	application_commands: APIApplicationCommand[];
 	/**
 	 * Webhooks found in the audit log
 	 *
@@ -171,6 +178,8 @@ export enum AuditLogEvent {
 	ThreadCreate = 110,
 	ThreadUpdate,
 	ThreadDelete,
+
+	ApplicationCommandPermissionUpdate = 121,
 }
 
 /**
@@ -517,6 +526,12 @@ export type APIAuditLogChangeKeyPermissions = AuditLogChangeData<'permissions',
  */
 export type APIAuditLogChangeKeyColor = AuditLogChangeData<'color', number>;
 
+/**
+ * Represents a change where the key is a snowflake.
+ * Currently, the only known instance of this is returned when permissions for a command were updated (<insert name of object here>)
+ */
+export type APIAuditLogChangeKeySnowflake = AuditLogChangeData<Snowflake, unknown>;
+
 /**
  * Returned when a role's hoist status is changed
  */

diff --git a/deno/payloads/v10/oauth2.ts b/deno/payloads/v10/oauth2.ts
@@ -119,4 +119,10 @@ export enum OAuth2Scopes {
 	 * See https://discord.com/developers/docs/interactions/application-commands
 	 */
 	ApplicationsCommandsUpdate = 'applications.commands.update',
+	/**
+	 * Allows your app to update permissions for its commands using a Bearer token - client credentials grant only
+	 *
+	 * See https://discord.com/developers/docs/interactions/application-commands
+	 */
+	ApplicationCommandsPermissionsUpdate = 'applications.commands.permissions.update',
 }
diff --git a/deno/payloads/v9/_interactions/_applicationCommands/permissions.ts b/deno/payloads/v9/_interactions/_applicationCommands/permissions.ts
@@ -27,11 +27,11 @@ export interface APIGuildApplicationCommandPermissions {
  */
 export interface APIApplicationCommandPermission {
 	/**
-	 * The id of the role or user
+	 * The id of the role, user or channel. Can also be a permission constant
 	 */
 	id: Snowflake;
 	/**
-	 * Role or user
+	 * Role, user or channel
 	 */
 	type: ApplicationCommandPermissionType;
 	/**
@@ -46,4 +46,13 @@ export interface APIApplicationCommandPermission {
 export enum ApplicationCommandPermissionType {
 	Role = 1,
 	User,
+	Channel,
 }
+
+/**
+ * https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-application-command-permissions-constants
+ */
+export const APIApplicationCommandPermissionsConstant = {
+	Everyone: (guildId: string | bigint): Snowflake => String(guildId),
+	AllChannels: (guildId: string | bigint): Snowflake => String(BigInt(guildId) - 1n),
+};
diff --git a/deno/payloads/v9/_interactions/applicationCommands.ts b/deno/payloads/v9/_interactions/applicationCommands.ts
@@ -70,10 +70,19 @@ export interface APIApplicationCommand {
 	 * The parameters for the `CHAT_INPUT` command, max 25
 	 */
 	options?: APIApplicationCommandOption[];
+	/**
+	 * Set of permissions represented as a bitset
+	 */
+	default_member_permissions?: Permissions | null;
+	/**
+	 * Indicates whether the command is available in DMs with the app, only for globally-scoped commands. By default, commands are visible
+	 */
+	dm_permission?: boolean | null;
 	/**
 	 * Whether the command is enabled by default when the app is added to a guild
 	 *
 	 * If missing, this property should be assumed as `true`
+	 * @deprecated Use `dm_permission` and/or `default_member_permissions` instead
 	 */
 	default_permission?: boolean;
 	/**

diff --git a/deno/payloads/v9/auditLog.ts b/deno/payloads/v9/auditLog.ts
@@ -16,6 +16,7 @@ import type {
 	GuildScheduledEventEntityType,
 	GuildScheduledEventStatus,
 } from './guildScheduledEvent.ts';
+import type { APIApplicationCommand } from './interactions.ts';
 import type { APIRole } from './permissions.ts';
 import type { StageInstancePrivacyLevel } from './stageInstance.ts';
 import type { StickerFormatType } from './sticker.ts';
@@ -27,6 +28,12 @@ import type { Snowflake } from '../../globals.ts';
  * https://discord.com/developers/docs/resources/audit-log#audit-log-object-audit-log-structure
  */
 export interface APIAuditLog {
+	/**
+	 * List of application commands found in the audit log
+	 *
+	 * See https://discord.com/developers/docs/interactions/application-commands#application-command-object
+	 */
+	application_commands: APIApplicationCommand[];
 	/**
 	 * Webhooks found in the audit log
 	 *
@@ -171,6 +178,8 @@ export enum AuditLogEvent {
 	ThreadCreate = 110,
 	ThreadUpdate,
 	ThreadDelete,
+
+	ApplicationCommandPermissionUpdate = 121,
 }
 
 /**
@@ -517,6 +526,12 @@ export type APIAuditLogChangeKeyPermissions = AuditLogChangeData<'permissions',
  */
 export type APIAuditLogChangeKeyColor = AuditLogChangeData<'color', number>;
 
+/**
+ * Represents a change where the key is a snowflake.
+ * Currently, the only known instance of this is returned when permissions for a command were updated (<insert name of object here>)
+ */
+export type APIAuditLogChangeKeySnowflake = AuditLogChangeData<Snowflake, unknown>;
+
 /**
  * Returned when a role's hoist status is changed
  */

diff --git a/deno/payloads/v9/oauth2.ts b/deno/payloads/v9/oauth2.ts
@@ -119,4 +119,10 @@ export enum OAuth2Scopes {
 	 * See https://discord.com/developers/docs/interactions/application-commands
 	 */
 	ApplicationsCommandsUpdate = 'applications.commands.update',
+	/**
+	 * Allows your app to update permissions for its commands using a Bearer token - client credentials grant only
+	 *
+	 * See https://discord.com/developers/docs/interactions/application-commands
+	 */
+	ApplicationCommandsPermissionsUpdate = 'applications.commands.permissions.update',
 }
diff --git a/deno/rest/v10/guild.ts b/deno/rest/v10/guild.ts
@@ -49,6 +49,7 @@ export type APIGuildCreatePartialChannel = StrictPartial<
 		| 'rate_limit_per_user'
 		| 'default_auto_archive_duration'
 		| 'position'
+		| 'flags'
 	>
 > &
 	AddUndefinedToPossiblyUndefinedPropertiesOfInterface<{

diff --git a/deno/rest/v10/interactions.ts b/deno/rest/v10/interactions.ts
@@ -91,27 +91,29 @@ export type RESTPutAPIApplicationCommandsResult = APIApplicationCommand[];
 /**
  * https://discord.com/developers/docs/interactions/application-commands#get-guild-application-commands
  */
-export type RESTGetAPIApplicationGuildCommandsResult = APIApplicationCommand[];
+export type RESTGetAPIApplicationGuildCommandsResult = Omit<APIApplicationCommand, 'dm_permission'>[];
 
 /**
  * https://discord.com/developers/docs/interactions/application-commands#get-guild-application-commands
  */
-export type RESTGetAPIApplicationGuildCommandResult = APIApplicationCommand;
+export type RESTGetAPIApplicationGuildCommandResult = Omit<APIApplicationCommand, 'dm_permission'>;
 
 /**
  * https://discord.com/developers/docs/interactions/application-commands#create-guild-application-command
  */
-export type RESTPostAPIApplicationGuildCommandsJSONBody = RESTPostAPIApplicationCommandsJSONBody;
+export type RESTPostAPIApplicationGuildCommandsJSONBody = Omit<RESTPostAPIApplicationCommandsJSONBody, 'dm_permission'>;
 
 /**
  * https://discord.com/developers/docs/interactions/application-commands#create-guild-application-command
  */
-export type RESTPostAPIApplicationGuildCommandsResult = APIApplicationCommand;
+export type RESTPostAPIApplicationGuildCommandsResult = Omit<APIApplicationCommand, 'dm_permission'>;
 
 /**
  * https://discord.com/developers/docs/interactions/application-commands#edit-guild-application-command
  */
-export type RESTPatchAPIApplicationGuildCommandJSONBody = StrictPartial<RESTPostAPIApplicationCommandsJSONBody>;
+export type RESTPatchAPIApplicationGuildCommandJSONBody = StrictPartial<
+	Omit<RESTPostAPIApplicationCommandsJSONBody, 'dm_permission'>
+>;
 
 /**
  * https://discord.com/developers/docs/interactions/application-commands#edit-guild-application-command
@@ -121,7 +123,10 @@ export type RESTPatchAPIApplicationGuildCommandResult = APIApplicationCommand;
 /**
  * https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-guild-application-commands
  */
-export type RESTPutAPIApplicationGuildCommandsJSONBody = RESTPostAPIApplicationCommandsJSONBody[];
+export type RESTPutAPIApplicationGuildCommandsJSONBody = Omit<
+	RESTPostAPIApplicationCommandsJSONBody,
+	'dm_permission'
+>[];
 
 /**
  * https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-guild-application-commands

diff --git a/deno/rest/v9/guild.ts b/deno/rest/v9/guild.ts
@@ -49,6 +49,7 @@ export type APIGuildCreatePartialChannel = StrictPartial<
 		| 'rate_limit_per_user'
 		| 'default_auto_archive_duration'
 		| 'position'
+		| 'flags'
 	>
 > &
 	AddUndefinedToPossiblyUndefinedPropertiesOfInterface<{

diff --git a/deno/rest/v9/interactions.ts b/deno/rest/v9/interactions.ts
@@ -91,27 +91,29 @@ export type RESTPutAPIApplicationCommandsResult = APIApplicationCommand[];
 /**
  * https://discord.com/developers/docs/interactions/application-commands#get-guild-application-commands
  */
-export type RESTGetAPIApplicationGuildCommandsResult = APIApplicationCommand[];
+export type RESTGetAPIApplicationGuildCommandsResult = Omit<APIApplicationCommand, 'dm_permission'>[];
 
 /**
  * https://discord.com/developers/docs/interactions/application-commands#get-guild-application-commands
  */
-export type RESTGetAPIApplicationGuildCommandResult = APIApplicationCommand;
+export type RESTGetAPIApplicationGuildCommandResult = Omit<APIApplicationCommand, 'dm_permission'>;
 
 /**
  * https://discord.com/developers/docs/interactions/application-commands#create-guild-application-command
  */
-export type RESTPostAPIApplicationGuildCommandsJSONBody = RESTPostAPIApplicationCommandsJSONBody;
+export type RESTPostAPIApplicationGuildCommandsJSONBody = Omit<RESTPostAPIApplicationCommandsJSONBody, 'dm_permission'>;
 
 /**
  * https://discord.com/developers/docs/interactions/application-commands#create-guild-application-command
  */
-export type RESTPostAPIApplicationGuildCommandsResult = APIApplicationCommand;
+export type RESTPostAPIApplicationGuildCommandsResult = Omit<APIApplicationCommand, 'dm_permission'>;
 
 /**
  * https://discord.com/developers/docs/interactions/application-commands#edit-guild-application-command
  */
-export type RESTPatchAPIApplicationGuildCommandJSONBody = StrictPartial<RESTPostAPIApplicationCommandsJSONBody>;
+export type RESTPatchAPIApplicationGuildCommandJSONBody = StrictPartial<
+	Omit<RESTPostAPIApplicationCommandsJSONBody, 'dm_permission'>
+>;
 
 /**
  * https://discord.com/developers/docs/interactions/application-commands#edit-guild-application-command

diff --git a/gateway/v10.ts b/gateway/v10.ts
@@ -195,6 +195,7 @@ export enum GatewayIntentBits {
  * https://discord.com/developers/docs/topics/gateway#commands-and-events-gateway-events
  */
 export enum GatewayDispatchEvents {
+	ApplicationCommandPermissionsUpdate = 'APPLICATION_COMMAND_PERMISSIONS_UPDATE',
 	ChannelCreate = 'CHANNEL_CREATE',
 	ChannelDelete = 'CHANNEL_DELETE',
 	ChannelPinsUpdate = 'CHANNEL_PINS_UPDATE',

diff --git a/gateway/v9.ts b/gateway/v9.ts
@@ -194,6 +194,7 @@ export enum GatewayIntentBits {
  * https://discord.com/developers/docs/topics/gateway#commands-and-events-gateway-events
  */
 export enum GatewayDispatchEvents {
+	ApplicationCommandPermissionsUpdate = 'APPLICATION_COMMAND_PERMISSIONS_UPDATE',
 	ChannelCreate = 'CHANNEL_CREATE',
 	ChannelDelete = 'CHANNEL_DELETE',
 	ChannelPinsUpdate = 'CHANNEL_PINS_UPDATE',

diff --git a/payloads/v10/_interactions/_applicationCommands/permissions.ts b/payloads/v10/_interactions/_applicationCommands/permissions.ts
@@ -27,11 +27,11 @@ export interface APIGuildApplicationCommandPermissions {
  */
 export interface APIApplicationCommandPermission {
 	/**
-	 * The id of the role or user
+	 * The id of the role, user or channel. Can also be a permission constant
 	 */
 	id: Snowflake;
 	/**
-	 * Role or user
+	 * Role, user or channel
 	 */
 	type: ApplicationCommandPermissionType;
 	/**
@@ -46,4 +46,13 @@ export interface APIApplicationCommandPermission {
 export enum ApplicationCommandPermissionType {
 	Role = 1,
 	User,
+	Channel,
 }
+
+/**
+ * https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-application-command-permissions-constants
+ */
+export const APIApplicationCommandPermissionsConstant = {
+	Everyone: (guildId: string | bigint): Snowflake => String(guildId),
+	AllChannels: (guildId: string | bigint): Snowflake => String(BigInt(guildId) - 1n),
+};
diff --git a/payloads/v10/_interactions/applicationCommands.ts b/payloads/v10/_interactions/applicationCommands.ts
@@ -70,10 +70,19 @@ export interface APIApplicationCommand {
 	 * The parameters for the `CHAT_INPUT` command, max 25
 	 */
 	options?: APIApplicationCommandOption[];
+	/**
+	 * Set of permissions represented as a bitset
+	 */
+	default_member_permissions?: Permissions | null;
+	/**
+	 * Indicates whether the command is available in DMs with the app, only for globally-scoped commands. By default, commands are visible
+	 */
+	dm_permission?: boolean | null;
 	/**
 	 * Whether the command is enabled by default when the app is added to a guild
 	 *
 	 * If missing, this property should be assumed as `true`
+	 * @deprecated Use `dm_permission` and/or `default_member_permissions` instead
 	 */
 	default_permission?: boolean;
 	/**