Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: slashcommand builder type split (#10253)
- Loading branch information
Showing
6 changed files
with
135 additions
and
112 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
112 changes: 112 additions & 0 deletions
112
packages/builders/src/interactions/slashCommands/mixins/SharedSlashCommand.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| import type { | ||
| LocalizationMap, | ||
| Permissions, | ||
| RESTPostAPIChatInputApplicationCommandsJSONBody, | ||
| } from 'discord-api-types/v10'; | ||
| import { | ||
| validateDMPermission, | ||
| validateDefaultMemberPermissions, | ||
| validateDefaultPermission, | ||
| validateLocalizationMap, | ||
| validateNSFW, | ||
| validateRequiredParameters, | ||
| } from '../Assertions.js'; | ||
| import type { ToAPIApplicationCommandOptions } from '../SlashCommandBuilder.js'; | ||
|
|
||
| /** | ||
| * This mixin holds symbols that can be shared in slashcommands independent of options or subcommands. | ||
| */ | ||
| export class SharedSlashCommand { | ||
| public readonly name: string = undefined!; | ||
|
|
||
| public readonly name_localizations?: LocalizationMap; | ||
|
|
||
| public readonly description: string = undefined!; | ||
|
|
||
| public readonly description_localizations?: LocalizationMap; | ||
|
|
||
| public readonly options: ToAPIApplicationCommandOptions[] = []; | ||
|
|
||
| /** | ||
| * Sets whether the command is enabled by default when the application is added to a guild. | ||
| * | ||
| * @remarks | ||
| * If set to `false`, you will have to later `PUT` the permissions for this command. | ||
| * @param value - Whether or not to enable this command by default | ||
| * @see {@link https://discord.com/developers/docs/interactions/application-commands#permissions} | ||
| * @deprecated Use {@link SharedSlashCommand.setDefaultMemberPermissions} or {@link SharedSlashCommand.setDMPermission} instead. | ||
| */ | ||
| public setDefaultPermission(value: boolean) { | ||
| // Assert the value matches the conditions | ||
| validateDefaultPermission(value); | ||
|
|
||
| Reflect.set(this, 'default_permission', value); | ||
|
|
||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the default permissions a member should have in order to run the command. | ||
| * | ||
| * @remarks | ||
| * You can set this to `'0'` to disable the command by default. | ||
| * @param permissions - The permissions bit field to set | ||
| * @see {@link https://discord.com/developers/docs/interactions/application-commands#permissions} | ||
| */ | ||
| public setDefaultMemberPermissions(permissions: Permissions | bigint | number | null | undefined) { | ||
| // Assert the value and parse it | ||
| const permissionValue = validateDefaultMemberPermissions(permissions); | ||
|
|
||
| Reflect.set(this, 'default_member_permissions', permissionValue); | ||
|
|
||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Sets if the command is available in direct messages with the application. | ||
| * | ||
| * @remarks | ||
| * 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} | ||
| */ | ||
| public setDMPermission(enabled: boolean | null | undefined) { | ||
| // Assert the value matches the conditions | ||
| validateDMPermission(enabled); | ||
|
|
||
| Reflect.set(this, 'dm_permission', enabled); | ||
|
|
||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Sets whether this command is NSFW. | ||
| * | ||
| * @param nsfw - Whether this command is NSFW | ||
| */ | ||
| public setNSFW(nsfw = true) { | ||
| // Assert the value matches the conditions | ||
| validateNSFW(nsfw); | ||
| Reflect.set(this, 'nsfw', nsfw); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Serializes this builder to API-compatible JSON data. | ||
| * | ||
| * @remarks | ||
| * This method runs validations on the data before serializing it. | ||
| * As such, it may throw an error if the data is invalid. | ||
| */ | ||
| public toJSON(): RESTPostAPIChatInputApplicationCommandsJSONBody { | ||
| validateRequiredParameters(this.name, this.description, this.options); | ||
|
|
||
| validateLocalizationMap(this.name_localizations); | ||
| validateLocalizationMap(this.description_localizations); | ||
|
|
||
| return { | ||
| ...this, | ||
| options: this.options.map((option) => option.toJSON()), | ||
| }; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters