mirror of
https://github.com/discordeno/discordeno.git
synced 2026-07-21 21:52:52 +00:00
refactor(rest)!: rename rest.editBotMember() to rest.editCurrentMember() to be consistent with rest.getCurrentMember() (#5104)
* refactor(rest)!: rename rest.editBotMember() to rest.editCurrentMember() to be consistent with rest.getCurrentMember() * refactor(type)!: rename ModifyCurrentMemberOptions to ModifyCurrentMember to be consistent with other types
This commit is contained in:
@@ -50,7 +50,6 @@ import type {
|
|||||||
DiscordVanityUrl,
|
DiscordVanityUrl,
|
||||||
EditApplication,
|
EditApplication,
|
||||||
EditAutoModerationRuleOptions,
|
EditAutoModerationRuleOptions,
|
||||||
EditBotMemberOptions,
|
|
||||||
EditChannelPermissionOverridesOptions,
|
EditChannelPermissionOverridesOptions,
|
||||||
EditGuildOnboarding,
|
EditGuildOnboarding,
|
||||||
EditGuildRole,
|
EditGuildRole,
|
||||||
@@ -87,6 +86,7 @@ import type {
|
|||||||
ListThreadMembers,
|
ListThreadMembers,
|
||||||
ModifyApplicationEmoji,
|
ModifyApplicationEmoji,
|
||||||
ModifyChannel,
|
ModifyChannel,
|
||||||
|
ModifyCurrentMember,
|
||||||
ModifyGuild,
|
ModifyGuild,
|
||||||
ModifyGuildChannelPositions,
|
ModifyGuildChannelPositions,
|
||||||
ModifyGuildEmoji,
|
ModifyGuildEmoji,
|
||||||
@@ -564,19 +564,19 @@ export function createBotHelpers<TProps extends TransformersDesiredProperties, T
|
|||||||
bot.transformers.applicationCommand(bot, snakelize(res)),
|
bot.transformers.applicationCommand(bot, snakelize(res)),
|
||||||
);
|
);
|
||||||
},
|
},
|
||||||
editBotMember: async (guildId, options, reason) => {
|
editCurrentMember: async (guildId, options, reason) => {
|
||||||
return bot.transformers.member(bot, snakelize(await bot.rest.editBotMember(guildId, options, reason)), { guildId, userId: bot.id });
|
return bot.transformers.member(bot, snakelize(await bot.rest.editCurrentMember(guildId, options, reason)), { guildId, userId: bot.id });
|
||||||
},
|
},
|
||||||
editMember: async (guildId, userId, options, reason) => {
|
editMember: async (guildId, userId, options, reason) => {
|
||||||
return bot.transformers.member(bot, snakelize(await bot.rest.editMember(guildId, userId, options, reason)), { guildId, userId });
|
return bot.transformers.member(bot, snakelize(await bot.rest.editMember(guildId, userId, options, reason)), { guildId, userId });
|
||||||
},
|
},
|
||||||
getMember: async (guildId, userId) => {
|
|
||||||
return bot.transformers.member(bot, snakelize(await bot.rest.getMember(guildId, userId)), { guildId, userId });
|
|
||||||
},
|
|
||||||
getCurrentMember: async (guildId, bearerToken) => {
|
getCurrentMember: async (guildId, bearerToken) => {
|
||||||
const res = await bot.rest.getCurrentMember(guildId, bearerToken);
|
const res = await bot.rest.getCurrentMember(guildId, bearerToken);
|
||||||
return bot.transformers.member(bot, snakelize(res), { guildId, userId: bot.transformers.snowflake(res.user.id) });
|
return bot.transformers.member(bot, snakelize(res), { guildId, userId: bot.transformers.snowflake(res.user.id) });
|
||||||
},
|
},
|
||||||
|
getMember: async (guildId, userId) => {
|
||||||
|
return bot.transformers.member(bot, snakelize(await bot.rest.getMember(guildId, userId)), { guildId, userId });
|
||||||
|
},
|
||||||
getMembers: async (guildId, options) => {
|
getMembers: async (guildId, options) => {
|
||||||
return (await bot.rest.getMembers(guildId, options)).map((res) =>
|
return (await bot.rest.getMembers(guildId, options)).map((res) =>
|
||||||
bot.transformers.member(bot, snakelize(res), { guildId, userId: bot.transformers.snowflake(res.user.id) }),
|
bot.transformers.member(bot, snakelize(res), { guildId, userId: bot.transformers.snowflake(res.user.id) }),
|
||||||
@@ -1135,15 +1135,15 @@ export type BotHelpers<TProps extends TransformersDesiredProperties, TBehavior e
|
|||||||
commands: CreateApplicationCommand[],
|
commands: CreateApplicationCommand[],
|
||||||
options?: UpsertGuildApplicationCommandOptions,
|
options?: UpsertGuildApplicationCommandOptions,
|
||||||
) => Promise<SetupDesiredProps<ApplicationCommand, TProps, TBehavior>[]>;
|
) => Promise<SetupDesiredProps<ApplicationCommand, TProps, TBehavior>[]>;
|
||||||
editBotMember: (guildId: BigString, options: EditBotMemberOptions, reason?: string) => Promise<SetupDesiredProps<Member, TProps, TBehavior>>;
|
editCurrentMember: (guildId: BigString, options: ModifyCurrentMember, reason?: string) => Promise<SetupDesiredProps<Member, TProps, TBehavior>>;
|
||||||
editMember: (
|
editMember: (
|
||||||
guildId: BigString,
|
guildId: BigString,
|
||||||
userId: BigString,
|
userId: BigString,
|
||||||
options: ModifyGuildMember,
|
options: ModifyGuildMember,
|
||||||
reason?: string,
|
reason?: string,
|
||||||
) => Promise<SetupDesiredProps<Member, TProps, TBehavior>>;
|
) => Promise<SetupDesiredProps<Member, TProps, TBehavior>>;
|
||||||
getMember: (guildId: BigString, userId: BigString) => Promise<SetupDesiredProps<Member, TProps, TBehavior>>;
|
|
||||||
getCurrentMember: (guildId: BigString, bearerToken: string) => Promise<SetupDesiredProps<Member, TProps, TBehavior>>;
|
getCurrentMember: (guildId: BigString, bearerToken: string) => Promise<SetupDesiredProps<Member, TProps, TBehavior>>;
|
||||||
|
getMember: (guildId: BigString, userId: BigString) => Promise<SetupDesiredProps<Member, TProps, TBehavior>>;
|
||||||
getMembers: (guildId: BigString, options: ListGuildMembers) => Promise<SetupDesiredProps<Member, TProps, TBehavior>[]>;
|
getMembers: (guildId: BigString, options: ListGuildMembers) => Promise<SetupDesiredProps<Member, TProps, TBehavior>[]>;
|
||||||
pruneMembers: (guildId: BigString, options: BeginGuildPrune, reason?: string) => Promise<{ pruned: number | null }>;
|
pruneMembers: (guildId: BigString, options: BeginGuildPrune, reason?: string) => Promise<{ pruned: number | null }>;
|
||||||
searchMembers: (
|
searchMembers: (
|
||||||
|
|||||||
@@ -1671,7 +1671,7 @@ export function createRestManager(options: CreateRestManagerOptions): RestManage
|
|||||||
return await rest.post<DiscordBulkBan>(rest.routes.guilds.members.bulkBan(guildId), { body: options, reason });
|
return await rest.post<DiscordBulkBan>(rest.routes.guilds.members.bulkBan(guildId), { body: options, reason });
|
||||||
},
|
},
|
||||||
|
|
||||||
async editBotMember(guildId, body, reason) {
|
async editCurrentMember(guildId, body, reason) {
|
||||||
return await rest.patch<DiscordMember>(rest.routes.guilds.members.bot(guildId), { body, reason });
|
return await rest.patch<DiscordMember>(rest.routes.guilds.members.bot(guildId), { body, reason });
|
||||||
},
|
},
|
||||||
|
|
||||||
@@ -1679,10 +1679,6 @@ export function createRestManager(options: CreateRestManagerOptions): RestManage
|
|||||||
return await rest.patch<DiscordMemberWithUser>(rest.routes.guilds.members.member(guildId, userId), { body, reason });
|
return await rest.patch<DiscordMemberWithUser>(rest.routes.guilds.members.member(guildId, userId), { body, reason });
|
||||||
},
|
},
|
||||||
|
|
||||||
async getMember(guildId, userId) {
|
|
||||||
return await rest.get<DiscordMemberWithUser>(rest.routes.guilds.members.member(guildId, userId));
|
|
||||||
},
|
|
||||||
|
|
||||||
async getCurrentMember(guildId, token) {
|
async getCurrentMember(guildId, token) {
|
||||||
return await rest.get<DiscordMemberWithUser>(rest.routes.guilds.members.currentMember(guildId), {
|
return await rest.get<DiscordMemberWithUser>(rest.routes.guilds.members.currentMember(guildId), {
|
||||||
headers: {
|
headers: {
|
||||||
@@ -1692,6 +1688,10 @@ export function createRestManager(options: CreateRestManagerOptions): RestManage
|
|||||||
});
|
});
|
||||||
},
|
},
|
||||||
|
|
||||||
|
async getMember(guildId, userId) {
|
||||||
|
return await rest.get<DiscordMemberWithUser>(rest.routes.guilds.members.member(guildId, userId));
|
||||||
|
},
|
||||||
|
|
||||||
async getMembers(guildId, options) {
|
async getMembers(guildId, options) {
|
||||||
return await rest.get<DiscordMemberWithUser[]>(rest.routes.guilds.members.members(guildId, options));
|
return await rest.get<DiscordMemberWithUser[]>(rest.routes.guilds.members.members(guildId, options));
|
||||||
},
|
},
|
||||||
|
|||||||
+13
-13
@@ -92,7 +92,6 @@ import type {
|
|||||||
DiscordWelcomeScreen,
|
DiscordWelcomeScreen,
|
||||||
EditApplication,
|
EditApplication,
|
||||||
EditAutoModerationRuleOptions,
|
EditAutoModerationRuleOptions,
|
||||||
EditBotMemberOptions,
|
|
||||||
EditChannelPermissionOverridesOptions,
|
EditChannelPermissionOverridesOptions,
|
||||||
EditGuildOnboarding,
|
EditGuildOnboarding,
|
||||||
EditGuildRole,
|
EditGuildRole,
|
||||||
@@ -132,6 +131,7 @@ import type {
|
|||||||
ListThreadMembers,
|
ListThreadMembers,
|
||||||
ModifyApplicationEmoji,
|
ModifyApplicationEmoji,
|
||||||
ModifyChannel,
|
ModifyChannel,
|
||||||
|
ModifyCurrentMember,
|
||||||
ModifyGuild,
|
ModifyGuild,
|
||||||
ModifyGuildChannelPositions,
|
ModifyGuildChannelPositions,
|
||||||
ModifyGuildEmoji,
|
ModifyGuildEmoji,
|
||||||
@@ -2843,7 +2843,7 @@ export interface RestManager {
|
|||||||
*
|
*
|
||||||
* @see {@link https://docs.discord.com/developers/resources/guild#modify-current-member}
|
* @see {@link https://docs.discord.com/developers/resources/guild#modify-current-member}
|
||||||
*/
|
*/
|
||||||
editBotMember: (guildId: BigString, options: EditBotMemberOptions, reason?: string) => Promise<Camelize<DiscordMember>>;
|
editCurrentMember: (guildId: BigString, options: ModifyCurrentMember, reason?: string) => Promise<Camelize<DiscordMember>>;
|
||||||
/**
|
/**
|
||||||
* Edits a member's properties.
|
* Edits a member's properties.
|
||||||
*
|
*
|
||||||
@@ -2861,17 +2861,6 @@ export interface RestManager {
|
|||||||
* @see {@link https://docs.discord.com/developers/resources/guild#modify-guild-member}
|
* @see {@link https://docs.discord.com/developers/resources/guild#modify-guild-member}
|
||||||
*/
|
*/
|
||||||
editMember: (guildId: BigString, userId: BigString, options: ModifyGuildMember, reason?: string) => Promise<Camelize<DiscordMember>>;
|
editMember: (guildId: BigString, userId: BigString, options: ModifyGuildMember, reason?: string) => Promise<Camelize<DiscordMember>>;
|
||||||
/**
|
|
||||||
* Gets the member object by user ID.
|
|
||||||
*
|
|
||||||
|
|
||||||
* @param guildId - The ID of the guild to get the member object for.
|
|
||||||
* @param userId - The ID of the user to get the member object for.
|
|
||||||
* @returns An instance of {@link DiscordMemberWithUser}.
|
|
||||||
*
|
|
||||||
* @see {@link https://docs.discord.com/developers/resources/guild#get-guild-member}
|
|
||||||
*/
|
|
||||||
getMember: (guildId: BigString, userId: BigString) => Promise<Camelize<DiscordMemberWithUser>>;
|
|
||||||
/**
|
/**
|
||||||
* Gets the current member object.
|
* Gets the current member object.
|
||||||
*
|
*
|
||||||
@@ -2885,6 +2874,17 @@ export interface RestManager {
|
|||||||
* @see {@link https://docs.discord.com/developers/resources/user#get-current-user-guild-member}
|
* @see {@link https://docs.discord.com/developers/resources/user#get-current-user-guild-member}
|
||||||
*/
|
*/
|
||||||
getCurrentMember: (guildId: BigString, bearerToken: string) => Promise<Camelize<DiscordMemberWithUser>>;
|
getCurrentMember: (guildId: BigString, bearerToken: string) => Promise<Camelize<DiscordMemberWithUser>>;
|
||||||
|
/**
|
||||||
|
* Gets the member object by user ID.
|
||||||
|
*
|
||||||
|
|
||||||
|
* @param guildId - The ID of the guild to get the member object for.
|
||||||
|
* @param userId - The ID of the user to get the member object for.
|
||||||
|
* @returns An instance of {@link DiscordMemberWithUser}.
|
||||||
|
*
|
||||||
|
* @see {@link https://docs.discord.com/developers/resources/guild#get-guild-member}
|
||||||
|
*/
|
||||||
|
getMember: (guildId: BigString, userId: BigString) => Promise<Camelize<DiscordMemberWithUser>>;
|
||||||
/**
|
/**
|
||||||
* Gets the list of members for a guild.
|
* Gets the list of members for a guild.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -28,11 +28,11 @@ describe('Member tests', () => {
|
|||||||
|
|
||||||
it("Edit a bot's nickname", async () => {
|
it("Edit a bot's nickname", async () => {
|
||||||
const nick = 'lts20050703';
|
const nick = 'lts20050703';
|
||||||
const member = await rest.editBotMember(e2eCache.guildId, { nick });
|
const member = await rest.editCurrentMember(e2eCache.guildId, { nick });
|
||||||
expect(member.nick).to.equal(nick);
|
expect(member.nick).to.equal(nick);
|
||||||
|
|
||||||
// Change nickname back
|
// Change nickname back
|
||||||
const member2 = await rest.editBotMember(e2eCache.guildId, { nick: null });
|
const member2 = await rest.editCurrentMember(e2eCache.guildId, { nick: null });
|
||||||
expect(member2.nick).to.null;
|
expect(member2.nick).to.null;
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -167,7 +167,7 @@ export interface ModifyGuildMember {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/** https://docs.discord.com/developers/resources/guild#modify-current-member-json-params */
|
/** https://docs.discord.com/developers/resources/guild#modify-current-member-json-params */
|
||||||
export interface EditBotMemberOptions {
|
export interface ModifyCurrentMember {
|
||||||
/** Value to set user's nickname to */
|
/** Value to set user's nickname to */
|
||||||
nick?: string | null;
|
nick?: string | null;
|
||||||
/** Data URI base64 encoded banner image */
|
/** Data URI base64 encoded banner image */
|
||||||
|
|||||||
Reference in New Issue
Block a user