Files
discordeno/transformers/applicationCommandOption.ts
Skillz4Killz bbbe21ebf2 BREAKING: add docs (#2442)
* refactor(helpers): Organise functions. (#2425)

* refactor: Move stage instance helper functions into `/stages` subdirectory.

* refactor: Move `followChannel.ts` to `/announcements` subdirectory.

* refactor: Move `updateVoiceState.ts` to `/guilds` directory.

* refactor: Move `getPins.ts` to `/messages` directory.

* refactor: Move voice-related helper functions into `/voice` subdirectory.

* refactor: Rename `/scheduledEvents` to `/events`.

* refactor: Move widget-related helper functions into `/widgets` subdirectory.

* refactor: Make `/integrations` a subdirectory of `/guilds`.

* refactor: Move helper functions related to interaction responses into the `/responses` subdirectory.

* refactor: Move `verifySignature.ts` to `/util` directory.

* refactor: Move `getChannelInvites.ts` to `/channels` directory.

* refactor: Make `/invites` a subdirectory of `/guilds`.

* refactor: Move reaction-related helper functions into the /reactions subdirectory.

* refactor: Move `getApplicationInfo.ts` into the `/misc` directory.

* refactor: Move voice-related helper functions from `/voice` to `/guilds/voice`.

* fix: Update and simplify type imports.

* refactor!(helpers): Rename helpers to match Discord API. Create a 1:1 helper-to-endpoint correspondence. (#2427)

* refactor: Move stage instance helper functions into `/stages` subdirectory.

* refactor: Move `followChannel.ts` to `/announcements` subdirectory.

* refactor: Move `updateVoiceState.ts` to `/guilds` directory.

* refactor: Move `getPins.ts` to `/messages` directory.

* refactor: Move voice-related helper functions into `/voice` subdirectory.

* refactor: Rename `/scheduledEvents` to `/events`.

* refactor: Move widget-related helper functions into `/widgets` subdirectory.

* refactor: Make `/integrations` a subdirectory of `/guilds`.

* refactor: Move helper functions related to interaction responses into the `/responses` subdirectory.

* refactor: Move `verifySignature.ts` to `/util` directory.

* refactor: Move `getChannelInvites.ts` to `/channels` directory.

* refactor: Make `/invites` a subdirectory of `/guilds`.

* refactor: Move reaction-related helper functions into the /reactions subdirectory.

* refactor: Move `getApplicationInfo.ts` into the `/misc` directory.

* refactor: Move voice-related helper functions from `/voice` to `/guilds/voice`.

* fix: Update and simplify type imports.

* refactor: Rename `followChannel` -> `followAnnouncementChannel`.

* refactor: Rename `createForumPost` -> `startForumThread`.

* refactor: Normalise keyword `update` -> `edit`.

* refactor: Rename `addToThread` -> `addThreadMember`.

* refactor: Rename `ChannelOverwrite` -> `ChannelPermissions`.

* refactor: Rename `startTyping` -> `triggerTypingIndicator`.

* refactor: Rename `swapChannels` -> `editChannelPositions`.

* refactor: Rename `getPins` -> `getPinnedMessages`.

* refactor: Rename `publish` -> `crosspost`.

* refactor: Normalise keyword `modify` -> `edit`.

* refactor: Normalise naming.

* fix: Imports.

* style: Remove empty object.

* refactor: Split `getArchivedThreads` into three files for public, private and private joined threads.

* refactor: Split `getApplicationCommands` into two files, for guild and global commands respectively.

* refactor: Split `getApplicationCommand` into two files, for guild and global commands respectively.

* fmt: Organise imports.

* misc: Include application command reverse transformer.

* misc: Make ordering of fields match up with the Discord API.

* fix: Add missing payload properties.

* refactor: Split `createApplicationCommand` into two files, for guild and global commands respectively.

* refactor: Split `upsertApplicationCommand` into two files, for guild and global commands respectively.

* refactor: Split `upsertApplicationCommands` into two files, for guild and global commands respectively.

* fix: Update exports.

* refactor: Split `deleteApplicationCommand` into two files, for guild and global commands respectively.

* fix: Add missing exports.

* refactor: Separate file into two to make 1 file correspond to 1 endpoint.

* refactor: Separate file into two to make 1 file correspond to 1 endpoint.

* feat: Create `getInteractionResponse.ts`.

* refactor: Matching API: `InteractionResponse` -> `FollowupMessage`.

* refactor: Separate file into two to make 1 file correspond to 1 endpoint.

* refactor: Remove `/followups` directory in favour of newly created files in `/responses`.

* refactor: Rename `bot`/`self` -> `own`, `others` -> `user`.

* refactor: Split function into `deleteOwnReaction` and `deleteUserReaction`.

* refactor: Reduce code duplication in processing reaction string.

* refactor: Separate file into two to make 1 file correspond to 1 endpoint.

* refactor: Rename function name.

* misc: Add aliases to functions to reduce breakage.

* refactor: Rename `startForumThread` -> `createForumThread`.

* misc: Move types from helper file to `/types` and create transformer.

* fix: Imports.

* style: Rename parameter `command` -> `payload`.

* feat: Create interaction response transformer.

* misc: Adapt code to use the interaction response transformer.

* misc: Adapt code to use interaction response transformer.

* refactor: Re-include the keyword `Override` in the file + function names.

* refactor: Rename `updateVoiceState` -> `editVoiceState` for consistency reasons.

Co-authored-by: Skillz4Killz <23035000+Skillz4Killz@users.noreply.github.com>

* BREAKING: docs(helpers): Document helper functions. (#2437)

* refactor: Move stage instance helper functions into `/stages` subdirectory.

* refactor: Move `followChannel.ts` to `/announcements` subdirectory.

* refactor: Move `updateVoiceState.ts` to `/guilds` directory.

* refactor: Move `getPins.ts` to `/messages` directory.

* refactor: Move voice-related helper functions into `/voice` subdirectory.

* refactor: Rename `/scheduledEvents` to `/events`.

* refactor: Move widget-related helper functions into `/widgets` subdirectory.

* refactor: Make `/integrations` a subdirectory of `/guilds`.

* refactor: Move helper functions related to interaction responses into the `/responses` subdirectory.

* refactor: Move `verifySignature.ts` to `/util` directory.

* refactor: Move `getChannelInvites.ts` to `/channels` directory.

* refactor: Make `/invites` a subdirectory of `/guilds`.

* refactor: Move reaction-related helper functions into the /reactions subdirectory.

* refactor: Move `getApplicationInfo.ts` into the `/misc` directory.

* refactor: Move voice-related helper functions from `/voice` to `/guilds/voice`.

* fix: Update and simplify type imports.

* refactor: Rename `followChannel` -> `followAnnouncementChannel`.

* refactor: Rename `createForumPost` -> `startForumThread`.

* refactor: Normalise keyword `update` -> `edit`.

* refactor: Rename `addToThread` -> `addThreadMember`.

* refactor: Rename `ChannelOverwrite` -> `ChannelPermissions`.

* refactor: Rename `startTyping` -> `triggerTypingIndicator`.

* refactor: Rename `swapChannels` -> `editChannelPositions`.

* refactor: Rename `getPins` -> `getPinnedMessages`.

* refactor: Rename `publish` -> `crosspost`.

* refactor: Normalise keyword `modify` -> `edit`.

* refactor: Normalise naming.

* fix: Imports.

* style: Remove empty object.

* refactor: Split `getArchivedThreads` into three files for public, private and private joined threads.

* refactor: Split `getApplicationCommands` into two files, for guild and global commands respectively.

* refactor: Split `getApplicationCommand` into two files, for guild and global commands respectively.

* fmt: Organise imports.

* misc: Include application command reverse transformer.

* misc: Make ordering of fields match up with the Discord API.

* fix: Add missing payload properties.

* refactor: Split `createApplicationCommand` into two files, for guild and global commands respectively.

* refactor: Split `upsertApplicationCommand` into two files, for guild and global commands respectively.

* refactor: Split `upsertApplicationCommands` into two files, for guild and global commands respectively.

* fix: Update exports.

* refactor: Split `deleteApplicationCommand` into two files, for guild and global commands respectively.

* fix: Add missing exports.

* refactor: Separate file into two to make 1 file correspond to 1 endpoint.

* refactor: Separate file into two to make 1 file correspond to 1 endpoint.

* feat: Create `getInteractionResponse.ts`.

* refactor: Matching API: `InteractionResponse` -> `FollowupMessage`.

* refactor: Separate file into two to make 1 file correspond to 1 endpoint.

* refactor: Remove `/followups` directory in favour of newly created files in `/responses`.

* refactor: Rename `bot`/`self` -> `own`, `others` -> `user`.

* refactor: Split function into `deleteOwnReaction` and `deleteUserReaction`.

* refactor: Reduce code duplication in processing reaction string.

* refactor: Separate file into two to make 1 file correspond to 1 endpoint.

* refactor: Rename function name.

* misc: Add aliases to functions to reduce breakage.

* refactor: Rename `startForumThread` -> `createForumThread`.

* misc: Move types from helper file to `/types` and create transformer.

* fix: Imports.

* style: Rename parameter `command` -> `payload`.

* feat: Create interaction response transformer.

* misc: Adapt code to use the interaction response transformer.

* misc: Adapt code to use interaction response transformer.

* docs: Document announcement channel helpers.

* docs: Document forum channel helpers.

* docs: Document stage instance helpers.

* misc: Update wording.

* docs: Document thread channel helpers.

* refactor: Re-include the keyword `Override` in the file + function names.

* refactor: Rename `updateVoiceState` -> `editVoiceState` for consistency reasons.

* docs: Document channel helpers.

* docs: Use `parameters` instead of `options` for descriptions.

* docs: Document guild discovery helpers.

* docs: Document emoji helpers.

* docs: Add missing information about which gateway events are fired.

* docs: Document auto moderation helpers.

* docs: Document scheduled event helpers.

* docs: Document integration helpers.

* docs: Document invite helpers.

* refactor: Rename `editWidget` -> `editWidgetSettings`.

* docs: Document guild widget helpers.

* docs: 'event' -> 'gateway event'.

* refactor: Rename `getAuditLogs` -> `getAuditLog`.

* docs: Document guild helpers.

* refactor: Rename `upsert*ApplicationCommand` -> `edit*ApplicationCommand`.

* docs: Document application command helpers.

* docs: Improve consistency in indentation.

* docs: Document interaction response + follow-up message helpers.

* docs: Document gateway event firings for endpoints.

* refactor: Delete `editBotNickname` due to being a subset of `editMember`.

* docs: Fix inconsistency.

* docs: Document member helpers.

* docs: Document reaction helpers.

* docs: Improve consistency.

* docs: Document message helpers.

* docs: Document role helpers.

* docs: Document guild template helpers.

* docs: Fix incorrect gateway event.

* refactor: Rename `sendWebhookMessage` -> `executeWebhook`.

* docs: Document webhook helpers.

* docs: Document voice helpers.

* fmt: Run Deno formatter.

* docs: Improve consistency.

* refactor: Rename the `/widgets` directory to `/widget`.

* fmt: Run Deno formatter.

* misc: Re-add the deleted `editBotNickname()` helper. (#2443)

* refactor: Move stage instance helper functions into `/stages` subdirectory.

* refactor: Move `followChannel.ts` to `/announcements` subdirectory.

* refactor: Move `updateVoiceState.ts` to `/guilds` directory.

* refactor: Move `getPins.ts` to `/messages` directory.

* refactor: Move voice-related helper functions into `/voice` subdirectory.

* refactor: Rename `/scheduledEvents` to `/events`.

* refactor: Move widget-related helper functions into `/widgets` subdirectory.

* refactor: Make `/integrations` a subdirectory of `/guilds`.

* refactor: Move helper functions related to interaction responses into the `/responses` subdirectory.

* refactor: Move `verifySignature.ts` to `/util` directory.

* refactor: Move `getChannelInvites.ts` to `/channels` directory.

* refactor: Make `/invites` a subdirectory of `/guilds`.

* refactor: Move reaction-related helper functions into the /reactions subdirectory.

* refactor: Move `getApplicationInfo.ts` into the `/misc` directory.

* refactor: Move voice-related helper functions from `/voice` to `/guilds/voice`.

* fix: Update and simplify type imports.

* refactor: Rename `followChannel` -> `followAnnouncementChannel`.

* refactor: Rename `createForumPost` -> `startForumThread`.

* refactor: Normalise keyword `update` -> `edit`.

* refactor: Rename `addToThread` -> `addThreadMember`.

* refactor: Rename `ChannelOverwrite` -> `ChannelPermissions`.

* refactor: Rename `startTyping` -> `triggerTypingIndicator`.

* refactor: Rename `swapChannels` -> `editChannelPositions`.

* refactor: Rename `getPins` -> `getPinnedMessages`.

* refactor: Rename `publish` -> `crosspost`.

* refactor: Normalise keyword `modify` -> `edit`.

* refactor: Normalise naming.

* fix: Imports.

* style: Remove empty object.

* refactor: Split `getArchivedThreads` into three files for public, private and private joined threads.

* refactor: Split `getApplicationCommands` into two files, for guild and global commands respectively.

* refactor: Split `getApplicationCommand` into two files, for guild and global commands respectively.

* fmt: Organise imports.

* misc: Include application command reverse transformer.

* misc: Make ordering of fields match up with the Discord API.

* fix: Add missing payload properties.

* refactor: Split `createApplicationCommand` into two files, for guild and global commands respectively.

* refactor: Split `upsertApplicationCommand` into two files, for guild and global commands respectively.

* refactor: Split `upsertApplicationCommands` into two files, for guild and global commands respectively.

* fix: Update exports.

* refactor: Split `deleteApplicationCommand` into two files, for guild and global commands respectively.

* fix: Add missing exports.

* refactor: Separate file into two to make 1 file correspond to 1 endpoint.

* refactor: Separate file into two to make 1 file correspond to 1 endpoint.

* feat: Create `getInteractionResponse.ts`.

* refactor: Matching API: `InteractionResponse` -> `FollowupMessage`.

* refactor: Separate file into two to make 1 file correspond to 1 endpoint.

* refactor: Remove `/followups` directory in favour of newly created files in `/responses`.

* refactor: Rename `bot`/`self` -> `own`, `others` -> `user`.

* refactor: Split function into `deleteOwnReaction` and `deleteUserReaction`.

* refactor: Reduce code duplication in processing reaction string.

* refactor: Separate file into two to make 1 file correspond to 1 endpoint.

* refactor: Rename function name.

* misc: Add aliases to functions to reduce breakage.

* refactor: Rename `startForumThread` -> `createForumThread`.

* misc: Move types from helper file to `/types` and create transformer.

* fix: Imports.

* style: Rename parameter `command` -> `payload`.

* feat: Create interaction response transformer.

* misc: Adapt code to use the interaction response transformer.

* misc: Adapt code to use interaction response transformer.

* docs: Document announcement channel helpers.

* docs: Document forum channel helpers.

* docs: Document stage instance helpers.

* misc: Update wording.

* docs: Document thread channel helpers.

* refactor: Re-include the keyword `Override` in the file + function names.

* refactor: Rename `updateVoiceState` -> `editVoiceState` for consistency reasons.

* docs: Document channel helpers.

* docs: Use `parameters` instead of `options` for descriptions.

* docs: Document guild discovery helpers.

* docs: Document emoji helpers.

* docs: Add missing information about which gateway events are fired.

* docs: Document auto moderation helpers.

* docs: Document scheduled event helpers.

* docs: Document integration helpers.

* docs: Document invite helpers.

* refactor: Rename `editWidget` -> `editWidgetSettings`.

* docs: Document guild widget helpers.

* docs: 'event' -> 'gateway event'.

* refactor: Rename `getAuditLogs` -> `getAuditLog`.

* docs: Document guild helpers.

* refactor: Rename `upsert*ApplicationCommand` -> `edit*ApplicationCommand`.

* docs: Document application command helpers.

* docs: Improve consistency in indentation.

* docs: Document interaction response + follow-up message helpers.

* docs: Document gateway event firings for endpoints.

* refactor: Delete `editBotNickname` due to being a subset of `editMember`.

* docs: Fix inconsistency.

* docs: Document member helpers.

* docs: Document reaction helpers.

* docs: Improve consistency.

* docs: Document message helpers.

* docs: Document role helpers.

* docs: Document guild template helpers.

* docs: Fix incorrect gateway event.

* refactor: Rename `sendWebhookMessage` -> `executeWebhook`.

* docs: Document webhook helpers.

* docs: Document voice helpers.

* fmt: Run Deno formatter.

* docs: Improve consistency.

* refactor: Rename the `/widgets` directory to `/widget`.

* fmt: Run Deno formatter.

* feat: Re-add `editBotNickname.ts`.

* Update helpers/members/editBotNickname.ts

Co-authored-by: Skillz4Killz <23035000+Skillz4Killz@users.noreply.github.com>

* fix: tests

* fix: bot member tests

* fix: remove submode

* fix: edit bot member returns full member

Co-authored-by: Dorian Oszczęda <vxern@wordcollector.co.uk>
2022-09-08 20:12:34 -05:00

61 lines
2.7 KiB
TypeScript

import { Bot } from "../bot.ts";
import { DiscordApplicationCommandOption, DiscordApplicationCommandOptionChoice } from "../types/discord.ts";
import { ApplicationCommandOptionTypes, ChannelTypes, Localization } from "../types/shared.ts";
import { Optionalize } from "../types/shared.ts";
import { ApplicationCommandOptionChoice } from "./applicationCommandOptionChoice.ts";
export function transformApplicationCommandOption(
bot: Bot,
payload: DiscordApplicationCommandOption,
): ApplicationCommandOption {
return {
type: payload.type,
name: payload.name,
nameLocalizations: payload.name_localizations ?? undefined,
description: payload.description,
descriptionLocalizations: payload.description_localizations ?? undefined,
required: payload.required ?? false,
choices: payload.choices?.map((choice) => bot.transformers.applicationCommandOptionChoice(bot, choice)),
autocomplete: payload.autocomplete,
channelTypes: payload.channel_types,
minValue: payload.min_value,
maxValue: payload.max_value,
minLength: payload.min_length,
maxLength: payload.max_length,
options: payload.options?.map((option) => bot.transformers.applicationCommandOption(bot, option)),
};
}
// THIS TRANSFORMER HAS A CIRCULAR REFERENCE TO CALL ITSELF FOR OPTIONS SO AN AUTOMATED TYPE CAN NOT BE CREATED!
export interface ApplicationCommandOption {
/** Value of Application Command Option Type */
type: ApplicationCommandOptionTypes;
/** 1-32 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;
/** If the parameter is required or optional--default `false` */
required?: boolean;
/** Choices for `string` and `int` types for the user to pick from */
choices?: ApplicationCommandOptionChoice[];
/** If the option is a subcommand or subcommand group type, this nested options will be the parameters */
options?: ApplicationCommandOption[];
/** If the option is a channel type, the channels shown will be restricted to these types */
channelTypes?: ChannelTypes[];
/** Minimum number desired. */
minValue?: number;
/** Maximum number desired. */
maxValue?: number;
/** Minimum length desired. */
minLength?: number;
/** Maximum length desired. */
maxLength?: number;
/** if autocomplete interactions are enabled for this `String`, `Integer`, or `Number` type option */
autocomplete?: boolean;
}