Skip to content

feat(User): Support avatar decorations #1471

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

Merged
merged 7 commits into from
Jan 28, 2024
Merged

feat(User): Support avatar decorations #1471

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0a44011
Avatar decorations
conorwastakenwastaken Jan 14, 2024
4efacf5
Merge remote-tracking branch 'upstream/dev' into avatardecorations
conorwastakenwastaken Jan 17, 2024
8a6da91
Merge remote-tracking branch 'upstream/dev' into avatardecorations
conorwastakenwastaken Jan 21, 2024
4f2a615
Fix jsdocs
conorwastakenwastaken Jan 21, 2024
29077d5
Include in JSON
conorwastakenwastaken Jan 23, 2024
d9bf022
Merge branch 'dev' into avatardecorations
conorwastakenwastaken Jan 23, 2024
2ef8bf3
Merge branch 'dev' of https://github.com/abalabahaha/eris into avatar…
bsian03 Jan 28, 2024
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
10 changes: 10 additions & 0 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -751,6 +751,7 @@ declare namespace Eris {
}
interface OldMember {
avatar: string | null;
avatarDecorationData?: AvatarDecorationData | null;
communicationDisabledUntil?: number | null;
nick: string | null;
pending?: boolean;
Expand Down Expand Up @@ -1332,6 +1333,10 @@ declare namespace Eris {
}

// Member/User
interface AvatarDecorationData {
asset: string;
sku_id: string;
}
interface MemberOptions {
channelID?: string | null;
communicationDisabledUntil?: Date | null;
Expand All @@ -1351,6 +1356,7 @@ declare namespace Eris {
interface PartialUser {
accentColor?: number | null;
avatar: string | null;
avatarDecorationData?: AvatarDecorationData | null;
banner?: string | null;
discriminator: string;
id: string;
Expand Down Expand Up @@ -3454,6 +3460,8 @@ declare namespace Eris {
accentColor?: number | null;
activities?: Activity[];
avatar: string | null;
avatarDecorationData?: AvatarDecorationData | null;
avatarDecorationURL: string | null;
avatarURL: string;
banner?: string | null;
bannerURL: string | null;
Expand Down Expand Up @@ -3994,6 +4002,8 @@ declare namespace Eris {
export class User extends Base {
accentColor?: number | null;
avatar: string | null;
avatarDecorationData?: AvatarDecorationData | null;
avatarDecorationURL: string | null;
avatarURL: string;
banner?: string | null;
bannerURL: string | null;
Expand Down
16 changes: 10 additions & 6 deletions lib/gateway/Shard.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -751,22 +751,24 @@ class Shard extends EventEmitter {
if(packet.d.user.username !== undefined) {
let user = this.client.users.get(packet.d.user.id);
let oldUser = null;
if(user && (user.username !== packet.d.user.username || user.globalName !== packet.d.user.global_name || user.discriminator !== packet.d.user.discriminator || user.avatar !== packet.d.user.avatar)) {
if(user && (user.username !== packet.d.user.username || user.globalName !== packet.d.user.global_name || user.discriminator !== packet.d.user.discriminator || user.avatar !== packet.d.user.avatar || (packet.d.user.avatar_decoration_data && user.avatarDecorationData && user.avatarDecorationData.asset !== packet.d.user.avatar_decoration_data.asset))) {
oldUser = {
username: user.username,
globalName: user.globalName,
discriminator: user.discriminator,
avatar: user.avatar
avatar: user.avatar,
avatarDecorationData: user.avatarDecorationData
};
}
if(!user || oldUser) {
user = this.client.users.update(packet.d.user, this.client);
/**
* Fired when a user's avatar, discriminator, display name or username changes
* Fired when a user's avatar, avatar decoration, discriminator, display name or username changes
* @event Client#userUpdate
* @prop {User} user The updated user
* @prop {Object?} oldUser The old user data. If the user was uncached, this will be null
* @prop {String?} oldUser.avatar The hash of the user's avatar, or null if no avatar
* @prop {Object?} oldUser.avatarDecorationData The data of the user's avatar decoration, including the asset and sku ID, or null if no avatar decoration
* @prop {String} oldUser.discriminator The discriminator of the user
* @prop {String?} oldUser.globalName The user's display name, if it is set. For bots, this is the application name
* @prop {String} oldUser.username The username of the user
Expand Down Expand Up @@ -1268,12 +1270,13 @@ class Shard extends EventEmitter {
if(!(this.client.options.intents & Constants.Intents.guildPresences) && packet.d.user.username !== undefined) {
let user = this.client.users.get(packet.d.user.id);
let oldUser = null;
if(user && (user.username !== packet.d.user.username || user.globalName !== packet.d.user.global_name || user.discriminator !== packet.d.user.discriminator || user.avatar !== packet.d.user.avatar)) {
if(user && (user.username !== packet.d.user.username || user.globalName !== packet.d.user.global_name || user.discriminator !== packet.d.user.discriminator || user.avatar !== packet.d.user.avatar || (packet.d.user.avatar_decoration_data && user.avatarDecorationData && user.avatarDecorationData.asset !== packet.d.user.avatar_decoration_data.asset))) {
oldUser = {
username: user.username,
globalName: user.globalName,
discriminator: user.discriminator,
avatar: user.avatar
avatar: user.avatar,
avatarDecorationData: user.avatarDecorationData
};
}
if(!user || oldUser) {
Expand Down Expand Up @@ -2136,7 +2139,8 @@ class Shard extends EventEmitter {
oldUser = {
username: user.username,
discriminator: user.discriminator,
avatar: user.avatar
avatar: user.avatar,
avatarDecorationData: user.avatarDecorationData
};
}
user = this.client.users.update(packet.d, this.client);
Expand Down
1 change: 1 addition & 0 deletions lib/rest/Endpoints.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions lib/structures/Member.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ const VoiceState = require("./VoiceState");
* @prop {Number?} accentColor The user's banner color, or null if no banner color (REST only)
* @prop {Array<Object>?} activities The member's current activities
* @prop {String?} avatar The hash of the member's guild avatar, or null if no guild avatar
* @prop {Object?} avatarDecorationData The data of the user's avatar decoration, including the asset and sku ID, or null if no avatar decoration
* @prop {String?} avatarDecorationURL The URL of the user's avatar decoration
* @prop {String} avatarURL The URL of the user's avatar which can be either a JPG or GIF
* @prop {String?} banner The hash of the user's banner, or null if no banner (REST only)
* @prop {String?} bannerURL The URL of the user's banner
Expand Down Expand Up @@ -129,6 +131,14 @@ class Member extends Base {
return this.user.accentColor;
}

get avatarDecorationData() {
return this.user.avatarDecorationData;
}

get avatarDecorationURL() {
return this.user.avatarDecorationURL;
}

get avatarURL() {
return this.avatar ? this.guild.shard.client._formatImage(Endpoints.GUILD_AVATAR(this.guild.id, this.id, this.avatar)) : this.user.avatarURL;
}
Expand Down
16 changes: 16 additions & 0 deletions lib/structures/User.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ const Endpoints = require("../rest/Endpoints");
* Represents a user
* @prop {Number?} accentColor The user's banner color, or null if no banner color (REST only)
* @prop {String?} avatar The hash of the user's avatar, or null if no avatar
* @prop {Object?} avatarDecorationData The data of the user's avatar decoration, including the asset and sku ID, or null if no avatar decoration
* @prop {String?} avatarDecorationURL The URL of the user's avatar decoration
* @prop {String} avatarURL The URL of the user's avatar which can be either a JPG or GIF
* @prop {String?} banner The hash of the user's banner, or null if no banner (REST only)
* @prop {String?} bannerURL The URL of the user's banner
Expand Down Expand Up @@ -57,6 +59,19 @@ class User extends Base {
if(data.accent_color !== undefined) {
this.accentColor = data.accent_color;
}
if(data.avatar_decoration_data !== undefined) {
this.avatarDecorationData = data.avatar_decoration_data;
}
}

get avatarDecorationURL() {
if(!this.avatarDecorationData) {
return null;
}
if(this._missingClientError) {
throw this._missingClientError;
}
return this._client._formatImage(Endpoints.USER_AVATAR_DECORATION(this.avatarDecorationData.asset));
}

get avatarURL() {
Expand Down Expand Up @@ -180,6 +195,7 @@ class User extends Base {
return super.toJSON([
"accentColor",
"avatar",
"avatarDecorationData",
"banner",
"bot",
"discriminator",
Expand Down