Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Command localizations don't use camelcase when creating a command with slashcommand builder #9084

Closed
wants to merge 1 commit into from
Closed

Command localizations don't use camelcase when creating a command with slashcommand builder #9084

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/builders/__tests__/interactions/ContextMenuCommands.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,12 +112,12 @@ describe('Context Menu Commands', () => {
});

test('GIVEN valid name localizations THEN valid data is stored', () => {
expect(getBuilder().setNameLocalization('en-US', 'foobar').name_localizations).toEqual(expectedSingleLocale);
expect(getBuilder().setNameLocalizations({ 'en-US': 'foobar', bg: 'test' }).name_localizations).toEqual(
expect(getBuilder().setNameLocalization('en-US', 'foobar').nameLocalizations).toEqual(expectedSingleLocale);
expect(getBuilder().setNameLocalizations({ 'en-US': 'foobar', bg: 'test' }).nameLocalizations).toEqual(
expectedMultipleLocales,
);
expect(getBuilder().setNameLocalizations(null).name_localizations).toBeNull();
expect(getBuilder().setNameLocalization('en-US', null).name_localizations).toEqual({
expect(getBuilder().setNameLocalizations(null).nameLocalizations).toBeNull();
expect(getBuilder().setNameLocalization('en-US', null).nameLocalizations).toEqual({
'en-US': null,
});
});
Expand Down
16 changes: 8 additions & 8 deletions packages/builders/__tests__/interactions/SlashCommands/SlashCommands.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,12 +460,12 @@ describe('Slash Commands', () => {
});

test('GIVEN valid name localizations THEN valid data is stored', () => {
expect(getBuilder().setNameLocalization('en-US', 'foobar').name_localizations).toEqual(expectedSingleLocale);
expect(getBuilder().setNameLocalizations({ 'en-US': 'foobar', bg: 'test' }).name_localizations).toEqual(
expect(getBuilder().setNameLocalization('en-US', 'foobar').nameLocalizations).toEqual(expectedSingleLocale);
expect(getBuilder().setNameLocalizations({ 'en-US': 'foobar', bg: 'test' }).nameLocalizations).toEqual(
expectedMultipleLocales,
);
expect(getBuilder().setNameLocalizations(null).name_localizations).toBeNull();
expect(getBuilder().setNameLocalization('en-US', null).name_localizations).toEqual({
expect(getBuilder().setNameLocalizations(null).nameLocalizations).toBeNull();
expect(getBuilder().setNameLocalization('en-US', null).nameLocalizations).toEqual({
'en-US': null,
});
});
Expand All @@ -483,14 +483,14 @@ describe('Slash Commands', () => {
});

test('GIVEN valid description localizations THEN valid data is stored', () => {
expect(getBuilder().setDescriptionLocalization('en-US', 'foobar').description_localizations).toEqual(
expect(getBuilder().setDescriptionLocalization('en-US', 'foobar').descriptionLocalizations).toEqual(
expectedSingleLocale,
);
expect(
getBuilder().setDescriptionLocalizations({ 'en-US': 'foobar', bg: 'test' }).description_localizations,
getBuilder().setDescriptionLocalizations({ 'en-US': 'foobar', bg: 'test' }).descriptionLocalizations,
).toEqual(expectedMultipleLocales);
expect(getBuilder().setDescriptionLocalizations(null).description_localizations).toBeNull();
expect(getBuilder().setDescriptionLocalization('en-US', null).description_localizations).toEqual({
expect(getBuilder().setDescriptionLocalizations(null).descriptionLocalizations).toBeNull();
expect(getBuilder().setDescriptionLocalization('en-US', null).descriptionLocalizations).toEqual({
'en-US': null,
});
});
Expand Down
16 changes: 8 additions & 8 deletions packages/builders/src/interactions/contextMenuCommands/ContextMenuCommandBuilder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export class ContextMenuCommandBuilder {
/**
* The localized names for this command
*/
public readonly name_localizations?: LocalizationMap;
public readonly nameLocalizations?: LocalizationMap;

/**
* The type of this context menu command
Expand Down Expand Up @@ -136,20 +136,20 @@ export class ContextMenuCommandBuilder {
* @param localizedName - The localized description for the given locale
*/
public setNameLocalization(locale: LocaleString, localizedName: string | null) {
if (!this.name_localizations) {
Reflect.set(this, 'name_localizations', {});
if (!this.nameLocalizations) {
Reflect.set(this, 'nameLocalizations', {});
}

const parsedLocale = validateLocale(locale);

if (localizedName === null) {
this.name_localizations![parsedLocale] = null;
this.nameLocalizations![parsedLocale] = null;
return this;
}

validateName(localizedName);

this.name_localizations![parsedLocale] = localizedName;
this.nameLocalizations![parsedLocale] = localizedName;
return this;
}

Expand All @@ -160,11 +160,11 @@ export class ContextMenuCommandBuilder {
*/
public setNameLocalizations(localizedNames: LocalizationMap | null) {
if (localizedNames === null) {
Reflect.set(this, 'name_localizations', null);
Reflect.set(this, 'nameLocalizations', null);
return this;
}

Reflect.set(this, 'name_localizations', {});
Reflect.set(this, 'nameLocalizations', {});

for (const args of Object.entries(localizedNames))
this.setNameLocalization(...(args as [LocaleString, string | null]));
Expand All @@ -181,7 +181,7 @@ export class ContextMenuCommandBuilder {
public toJSON(): RESTPostAPIContextMenuApplicationCommandsJSONBody {
validateRequiredParameters(this.name, this.type);

validateLocalizationMap(this.name_localizations);
validateLocalizationMap(this.nameLocalizations);

return { ...this };
}
Expand Down
8 changes: 4 additions & 4 deletions packages/builders/src/interactions/slashCommands/SlashCommandBuilder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export class SlashCommandBuilder {
/**
* The localized names for this command
*/
public readonly name_localizations?: LocalizationMap;
public readonly nameLocalizations?: LocalizationMap;

/**
* The description of this slash command
Expand All @@ -39,7 +39,7 @@ export class SlashCommandBuilder {
/**
* The localized descriptions for this command
*/
public readonly description_localizations?: LocalizationMap;
public readonly descriptionLocalizations?: LocalizationMap;

/**
* The options of this slash command
Expand Down Expand Up @@ -80,8 +80,8 @@ export class SlashCommandBuilder {
public toJSON(): RESTPostAPIChatInputApplicationCommandsJSONBody {
validateRequiredParameters(this.name, this.description, this.options);

validateLocalizationMap(this.name_localizations);
validateLocalizationMap(this.description_localizations);
validateLocalizationMap(this.nameLocalizations);
validateLocalizationMap(this.descriptionLocalizations);

return {
...this,
Expand Down
8 changes: 4 additions & 4 deletions packages/builders/src/interactions/slashCommands/SlashCommandSubcommands.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@ export class SlashCommandSubcommandGroupBuilder implements ToAPIApplicationComma
return {
type: ApplicationCommandOptionType.SubcommandGroup,
name: this.name,
name_localizations: this.name_localizations,
nameLocalizations: this.nameLocalizations,
description: this.description,
description_localizations: this.description_localizations,
descriptionLocalizations: this.descriptionLocalizations,
options: this.options.map((option) => option.toJSON()),
};
}
Expand Down Expand Up @@ -104,9 +104,9 @@ export class SlashCommandSubcommandBuilder implements ToAPIApplicationCommandOpt
return {
type: ApplicationCommandOptionType.Subcommand,
name: this.name,
name_localizations: this.name_localizations,
nameLocalizations: this.nameLocalizations,
description: this.description,
description_localizations: this.description_localizations,
descriptionLocalizations: this.descriptionLocalizations,
options: this.options.map((option) => option.toJSON()),
};
}
Expand Down
4 changes: 2 additions & 2 deletions packages/builders/src/interactions/slashCommands/mixins/ApplicationCommandOptionBase.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ export abstract class ApplicationCommandOptionBase extends SharedNameAndDescript
validateRequiredParameters(this.name, this.description, []);

// Validate localizations
validateLocalizationMap(this.name_localizations);
validateLocalizationMap(this.description_localizations);
validateLocalizationMap(this.nameLocalizations);
validateLocalizationMap(this.descriptionLocalizations);

// Assert that you actually passed a boolean
validateRequired(this.required);
Expand Down
6 changes: 3 additions & 3 deletions ...eractions/slashCommands/mixins/ApplicationCommandOptionWithChoicesAndAutocompleteMixin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const stringPredicate = s.string.lengthGreaterThanOrEqual(1).lengthLessThanOrEqu
const numberPredicate = s.number.greaterThan(Number.NEGATIVE_INFINITY).lessThan(Number.POSITIVE_INFINITY);
const choicesPredicate = s.object({
name: stringPredicate,
name_localizations: localizationMapPredicate,
nameLocalizations: localizationMapPredicate,
value: s.union(stringPredicate, numberPredicate),
}).array;
const booleanPredicate = s.boolean;
Expand Down Expand Up @@ -37,15 +37,15 @@ export class ApplicationCommandOptionWithChoicesAndAutocompleteMixin<T extends n

validateChoicesLength(choices.length, this.choices);

for (const { name, name_localizations, value } of choices) {
for (const { name, nameLocalizations, value } of choices) {
// Validate the value
if (this.type === ApplicationCommandOptionType.String) {
stringPredicate.parse(value);
} else {
numberPredicate.parse(value);
}

this.choices!.push({ name, name_localizations, value });
this.choices!.push({ name, nameLocalizations, value });
}

return this;
Expand Down
28 changes: 14 additions & 14 deletions packages/builders/src/interactions/slashCommands/mixins/NameAndDescription.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ import { validateDescription, validateLocale, validateName } from '../Assertions
export class SharedNameAndDescription {
public readonly name!: string;

public readonly name_localizations?: LocalizationMap;
public readonly nameLocalizations?: LocalizationMap;

public readonly description!: string;

public readonly description_localizations?: LocalizationMap;
public readonly descriptionLocalizations?: LocalizationMap;

/**
* Sets the name
Expand Down Expand Up @@ -45,20 +45,20 @@ export class SharedNameAndDescription {
* @param localizedName - The localized description for the given locale
*/
public setNameLocalization(locale: LocaleString, localizedName: string | null) {
if (!this.name_localizations) {
Reflect.set(this, 'name_localizations', {});
if (!this.nameLocalizations) {
Reflect.set(this, 'nameLocalizations', {});
}

const parsedLocale = validateLocale(locale);

if (localizedName === null) {
this.name_localizations![parsedLocale] = null;
this.nameLocalizations![parsedLocale] = null;
return this;
}

validateName(localizedName);

this.name_localizations![parsedLocale] = localizedName;
this.nameLocalizations![parsedLocale] = localizedName;
return this;
}

Expand All @@ -69,11 +69,11 @@ export class SharedNameAndDescription {
*/
public setNameLocalizations(localizedNames: LocalizationMap | null) {
if (localizedNames === null) {
Reflect.set(this, 'name_localizations', null);
Reflect.set(this, 'nameLocalizations', null);
return this;
}

Reflect.set(this, 'name_localizations', {});
Reflect.set(this, 'nameLocalizations', {});

for (const args of Object.entries(localizedNames)) {
this.setNameLocalization(...(args as [LocaleString, string | null]));
Expand All @@ -89,20 +89,20 @@ export class SharedNameAndDescription {
* @param localizedDescription - The localized description for the given locale
*/
public setDescriptionLocalization(locale: LocaleString, localizedDescription: string | null) {
if (!this.description_localizations) {
Reflect.set(this, 'description_localizations', {});
if (!this.descriptionLocalizations) {
Reflect.set(this, 'descriptionLocalizations', {});
}

const parsedLocale = validateLocale(locale);

if (localizedDescription === null) {
this.description_localizations![parsedLocale] = null;
this.descriptionLocalizations![parsedLocale] = null;
return this;
}

validateDescription(localizedDescription);

this.description_localizations![parsedLocale] = localizedDescription;
this.descriptionLocalizations![parsedLocale] = localizedDescription;
return this;
}

Expand All @@ -113,11 +113,11 @@ export class SharedNameAndDescription {
*/
public setDescriptionLocalizations(localizedDescriptions: LocalizationMap | null) {
if (localizedDescriptions === null) {
Reflect.set(this, 'description_localizations', null);
Reflect.set(this, 'descriptionLocalizations', null);
return this;
}

Reflect.set(this, 'description_localizations', {});
Reflect.set(this, 'descriptionLocalizations', {});
for (const args of Object.entries(localizedDescriptions)) {
this.setDescriptionLocalization(...(args as [LocaleString, string | null]));
}
Expand Down
4 changes: 2 additions & 2 deletions packages/discord.js/src/managers/ApplicationCommandManager.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,10 +250,10 @@ class ApplicationCommandManager extends CachedManager {

return {
name: command.name,
name_localizations: command.nameLocalizations ?? command.name_localizations,
nameLocalizations: command.nameLocalizations ?? command.nameLocalizations,
description: command.description,
nsfw: command.nsfw,
description_localizations: command.descriptionLocalizations ?? command.description_localizations,
descriptionLocalizations: command.descriptionLocalizations ?? command.descriptionLocalizations,
type: command.type,
options: command.options?.map(o => ApplicationCommand.transformOption(o)),
default_member_permissions,
Expand Down
28 changes: 14 additions & 14 deletions packages/discord.js/src/structures/ApplicationCommand.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,12 @@ class ApplicationCommand extends Base {
this.name = data.name;
}

if ('name_localizations' in data) {
if ('nameLocalizations' in data) {
/**
* The name localizations for this command
* @type {?Object<Locale, string>}
*/
this.nameLocalizations = data.name_localizations;
this.nameLocalizations = data.nameLocalizations;
Comment on lines +73 to +78
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Discord API data comes with camel-cased keys

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is true, I apologize.
But when you compare line 78 with line 88 you can see that the this.nameLocalized is also in correct camel case even when getting the non camel case value data.name_localized

} else {
this.nameLocalizations ??= null;
}
Expand All @@ -98,12 +98,12 @@ class ApplicationCommand extends Base {
this.description = data.description;
}

if ('description_localizations' in data) {
if ('descriptionLocalizations' in data) {
/**
* The description localizations for this command
* @type {?Object<Locale, string>}
*/
this.descriptionLocalizations = data.description_localizations;
this.descriptionLocalizations = data.descriptionLocalizations;
} else {
this.descriptionLocalizations ??= null;
}
Expand Down Expand Up @@ -390,9 +390,9 @@ class ApplicationCommand extends Base {
(command.options?.length ?? 0) !== (this.options?.length ?? 0) ||
defaultMemberPermissions !== (this.defaultMemberPermissions?.bitfield ?? null) ||
(typeof dmPermission !== 'undefined' && dmPermission !== this.dmPermission) ||
!isEqual(command.nameLocalizations ?? command.name_localizations ?? {}, this.nameLocalizations ?? {}) ||
!isEqual(command.nameLocalizations ?? command.nameLocalizations ?? {}, this.nameLocalizations ?? {}) ||
!isEqual(
command.descriptionLocalizations ?? command.description_localizations ?? {},
command.descriptionLocalizations ?? command.descriptionLocalizations ?? {},
this.descriptionLocalizations ?? {},
)
) {
Expand Down Expand Up @@ -456,9 +456,9 @@ class ApplicationCommand extends Base {
(option.maxValue ?? option.max_value) !== existing.maxValue ||
(option.minLength ?? option.min_length) !== existing.minLength ||
(option.maxLength ?? option.max_length) !== existing.maxLength ||
!isEqual(option.nameLocalizations ?? option.name_localizations ?? {}, existing.nameLocalizations ?? {}) ||
!isEqual(option.nameLocalizations ?? option.nameLocalizations ?? {}, existing.nameLocalizations ?? {}) ||
!isEqual(
option.descriptionLocalizations ?? option.description_localizations ?? {},
option.descriptionLocalizations ?? option.descriptionLocalizations ?? {},
existing.descriptionLocalizations ?? {},
)
) {
Expand All @@ -474,7 +474,7 @@ class ApplicationCommand extends Base {
choice.value === option.choices[index].value &&
isEqual(
choice.nameLocalizations ?? {},
option.choices[index].nameLocalizations ?? option.choices[index].name_localizations ?? {},
option.choices[index].nameLocalizations ?? option.choices[index].nameLocalizations ?? {},
),
)
) {
Expand Down Expand Up @@ -552,17 +552,17 @@ class ApplicationCommand extends Base {
const maxValueKey = received ? 'maxValue' : 'max_value';
const minLengthKey = received ? 'minLength' : 'min_length';
const maxLengthKey = received ? 'maxLength' : 'max_length';
const nameLocalizationsKey = received ? 'nameLocalizations' : 'name_localizations';
const nameLocalizationsKey = received ? 'nameLocalizations' : 'nameLocalizations';
const nameLocalizedKey = received ? 'nameLocalized' : 'name_localized';
const descriptionLocalizationsKey = received ? 'descriptionLocalizations' : 'description_localizations';
const descriptionLocalizationsKey = received ? 'descriptionLocalizations' : 'descriptionLocalizations';
const descriptionLocalizedKey = received ? 'descriptionLocalized' : 'description_localized';
return {
type: option.type,
name: option.name,
[nameLocalizationsKey]: option.nameLocalizations ?? option.name_localizations,
[nameLocalizationsKey]: option.nameLocalizations ?? option.nameLocalizations,
[nameLocalizedKey]: option.nameLocalized ?? option.name_localized,
description: option.description,
[descriptionLocalizationsKey]: option.descriptionLocalizations ?? option.description_localizations,
[descriptionLocalizationsKey]: option.descriptionLocalizations ?? option.descriptionLocalizations,
[descriptionLocalizedKey]: option.descriptionLocalized ?? option.description_localized,
required:
option.required ??
Expand All @@ -574,7 +574,7 @@ class ApplicationCommand extends Base {
choices: option.choices?.map(choice => ({
name: choice.name,
[nameLocalizedKey]: choice.nameLocalized ?? choice.name_localized,
[nameLocalizationsKey]: choice.nameLocalizations ?? choice.name_localizations,
[nameLocalizationsKey]: choice.nameLocalizations ?? choice.nameLocalizations,
value: choice.value,
})),
options: option.options?.map(o => this.transformOption(o, received)),
Expand Down
Loading