Files
discordeno/helpers/interactions/commands/createApplicationCommand.ts
LTS20050703 453fd45ef7 localization updates (#2206)
* localization updates

Upstream: 2f854d3fd6

Types: DiscordApplicationCommmand and DiscordApplicationCommandOption: Update documentation

Types: DiscordActivityButton: Add documentation link

Helper: upsertApplicationCommand: All fields are optional, but any fields provided will entirely overwrite the existing values of those fields.

* revert unrelated changes

* update SLASH_COMMANDS_NAME_REGEX

* createApplicationCommand options: AtLeastOne instead of Partial

Co-authored-by: ITOH <to@itoh.at>
Co-authored-by: Skillz4Killz <23035000+Skillz4Killz@users.noreply.github.com>
2022-05-13 09:25:57 -04:00

97 lines
4.5 KiB
TypeScript

import type { Bot } from "../../../bot.ts";
import { ApplicationCommandOption, ApplicationCommandTypes, Localization } from "../../../mod.ts";
import { DiscordApplicationCommand, DiscordApplicationCommandOption } from "../../../types/discord.ts";
import { AtLeastOne } from "../../../types/shared.ts";
/**
* There are two kinds of Application Commands: global commands and guild commands. Global commands are available for every guild that adds your app; guild commands are specific to the guild you specify when making them. Command names are unique per application within each scope (global and guild). That means:
*
* - Your app **cannot** have two global commands with the same name
* - Your app **cannot** have two guild commands within the same name **on the same guild**
* - Your app **can** have a global and guild command with the same name
* - Multiple apps **can** have commands with the same names
*
* Global commands are cached for **1 hour**. That means that new global commands will fan out slowly across all guilds, and will be guaranteed to be updated in an hour.
* Guild commands update **instantly**. We recommend you use guild commands for quick testing, and global commands when they're ready for public use.
*/
export async function createApplicationCommand(
bot: Bot,
options: CreateApplicationCommand | CreateContextApplicationCommand,
guildId?: bigint,
) {
const result = await bot.rest.runMethod<DiscordApplicationCommand>(
bot.rest,
"post",
guildId
? bot.constants.endpoints.COMMANDS_GUILD(bot.applicationId, guildId)
: bot.constants.endpoints.COMMANDS(bot.applicationId),
isContextApplicationCommand(options)
? { name: options.name, name_localizations: options.nameLocalizations, type: options.type }
: {
name: options.name,
name_localizations: options.nameLocalizations,
description: options.description,
description_localizations: options.descriptionLocalizations,
type: options.type,
options: options.options ? makeOptionsForCommand(options.options) : undefined,
},
);
return bot.transformers.applicationCommand(bot, result);
}
export function makeOptionsForCommand(options: ApplicationCommandOption[]): DiscordApplicationCommandOption[] {
return options.map((option) => ({
type: option.type,
name: option.name,
name_localizations: option.nameLocalizations,
description: option.description,
description_localizations: option.descriptionLocalizations,
required: option.required,
choices: option.choices?.map((choice) => ({
name: choice.name,
name_localizations: choice.nameLocalizations,
value: choice.value,
})),
options: option.options ? makeOptionsForCommand(option.options) : undefined,
channel_types: option.channelTypes,
autocomplete: option.autocomplete,
min_value: option.minValue,
max_value: option.maxValue,
}));
}
/** https://discord.com/developers/docs/interactions/application-commands#endpoints-json-params */
export interface CreateApplicationCommand {
/** 1-31 character name matching lowercase `^[\w-]{1,32}$` */
name: string;
/** Localization object for the `name` field. Values follow the same restrictions as `name` */
nameLocalizations?: Localization;
/** 1-100 character description */
description: string;
/** Localization object for the `description` field. Values follow the same restrictions as `description` */
descriptionLocalizations?: Localization;
/** The type of the command */
type?: ApplicationCommandTypes;
/** The parameters for the command */
options?: ApplicationCommandOption[];
/** Whether the command is enabled by default when the app is added to a guild. Default: true */
defaultPermission?: boolean;
}
/** https://discord.com/developers/docs/interactions/application-commands#endpoints-json-params */
export interface CreateContextApplicationCommand {
/** 1-31 character name matching lowercase `^[\w-]{1,32}$` */
name: string;
/** Localization object for the `name` field. Values follow the same restrictions as `name` */
nameLocalizations?: Localization;
/** The type of the command */
type: ApplicationCommandTypes.Message | ApplicationCommandTypes.User;
}
export function isContextApplicationCommand(
cmd: AtLeastOne<CreateContextApplicationCommand> | AtLeastOne<CreateApplicationCommand>,
): cmd is AtLeastOne<CreateContextApplicationCommand> {
return cmd.type === ApplicationCommandTypes.Message || cmd.type === ApplicationCommandTypes.User;
}