feat: support new username system (#765)

discordjs · Jun 15, 2023 · 5af7147 · 5af7147 · vercel · Jun 15, 2023
1 parent e01cf7c
commit 5af7147
Show file tree

Hide file tree

Showing 8 changed files with 44 additions and 20 deletions.
diff --git a/deno/payloads/v10/user.ts b/deno/payloads/v10/user.ts
@@ -18,9 +18,13 @@ export interface APIUser {
 	 */
 	username: string;
 	/**
-	 * The user's 4-digit discord-tag
+	 * The user's Discord-tag
 	 */
 	discriminator: string;
+	/**
+	 * The user's display name, if it is set. For bots, this is the application name
+	 */
+	global_name: string | null;
 	/**
 	 * The user's avatar hash
 	 *

diff --git a/deno/payloads/v9/user.ts b/deno/payloads/v9/user.ts
@@ -18,9 +18,13 @@ export interface APIUser {
 	 */
 	username: string;
 	/**
-	 * The user's 4-digit discord-tag
+	 * The user's Discord-tag
 	 */
 	discriminator: string;
+	/**
+	 * The user's display name, if it is set. For bots, this is the application name
+	 */
+	global_name: string | null;
 	/**
 	 * The user's avatar hash
 	 *

diff --git a/deno/rest/v10/mod.ts b/deno/rest/v10/mod.ts
@@ -962,14 +962,16 @@ export const CDNRoutes = {
 
 	/**
 	 * Route for:
-	 * - GET `/embed/avatars/{user.discriminator % 5}.png`
+	 * - GET `/embed/avatars/{index}.png`
 	 *
-	 * The `userDiscriminator` parameter should be the user discriminator modulo 5 (e.g. 1337 % 5 = 2)
+	 * The value for `index` parameter depends on whether the user is [migrated to the new username system](https://discord.com/developers/docs/change-log#unique-usernames-on-discord).
+	 * For users on the new username system, `index` will be `(user.id >> 22) % 6`.
+	 * For users on the legacy username system, `index` will be `user.discriminator % 5`.
 	 *
 	 * This route supports the extension: PNG
 	 */
-	defaultUserAvatar(userDiscriminator: DefaultUserAvatarAssets) {
-		return `/embed/avatars/${userDiscriminator}.png` as const;
+	defaultUserAvatar(index: DefaultUserAvatarAssets) {
+		return `/embed/avatars/${index}.png` as const;
 	},
 
 	/**

diff --git a/deno/rest/v9/mod.ts b/deno/rest/v9/mod.ts
@@ -971,14 +971,16 @@ export const CDNRoutes = {
 
 	/**
 	 * Route for:
-	 * - GET `/embed/avatars/{user.discriminator % 5}.png`
+	 * - GET `/embed/avatars/{index}.png`
 	 *
-	 * The `userDiscriminator` parameter should be the user discriminator modulo 5 (e.g. 1337 % 5 = 2)
+	 * The value for `index` parameter depends on whether the user is [migrated to the new username system](https://discord.com/developers/docs/change-log#unique-usernames-on-discord).
+	 * For users on the new username system, `index` will be `(user.id >> 22) % 6`.
+	 * For users on the legacy username system, `index` will be `user.discriminator % 5`.
 	 *
 	 * This route supports the extension: PNG
 	 */
-	defaultUserAvatar(userDiscriminator: DefaultUserAvatarAssets) {
-		return `/embed/avatars/${userDiscriminator}.png` as const;
+	defaultUserAvatar(index: DefaultUserAvatarAssets) {
+		return `/embed/avatars/${index}.png` as const;
 	},
 
 	/**

diff --git a/payloads/v10/user.ts b/payloads/v10/user.ts
@@ -18,9 +18,13 @@ export interface APIUser {
 	 */
 	username: string;
 	/**
-	 * The user's 4-digit discord-tag
+	 * The user's Discord-tag
 	 */
 	discriminator: string;
+	/**
+	 * The user's display name, if it is set. For bots, this is the application name
+	 */
+	global_name: string | null;
 	/**
 	 * The user's avatar hash
 	 *

diff --git a/payloads/v9/user.ts b/payloads/v9/user.ts
@@ -18,9 +18,13 @@ export interface APIUser {
 	 */
 	username: string;
 	/**
-	 * The user's 4-digit discord-tag
+	 * The user's Discord-tag
 	 */
 	discriminator: string;
+	/**
+	 * The user's display name, if it is set. For bots, this is the application name
+	 */
+	global_name: string | null;
 	/**
 	 * The user's avatar hash
 	 *

diff --git a/rest/v10/index.ts b/rest/v10/index.ts
@@ -962,14 +962,16 @@ export const CDNRoutes = {
 
 	/**
 	 * Route for:
-	 * - GET `/embed/avatars/{user.discriminator % 5}.png`
+	 * - GET `/embed/avatars/{index}.png`
 	 *
-	 * The `userDiscriminator` parameter should be the user discriminator modulo 5 (e.g. 1337 % 5 = 2)
+	 * The value for `index` parameter depends on whether the user is [migrated to the new username system](https://discord.com/developers/docs/change-log#unique-usernames-on-discord).
+	 * For users on the new username system, `index` will be `(user.id >> 22) % 6`.
+	 * For users on the legacy username system, `index` will be `user.discriminator % 5`.
 	 *
 	 * This route supports the extension: PNG
 	 */
-	defaultUserAvatar(userDiscriminator: DefaultUserAvatarAssets) {
-		return `/embed/avatars/${userDiscriminator}.png` as const;
+	defaultUserAvatar(index: DefaultUserAvatarAssets) {
+		return `/embed/avatars/${index}.png` as const;
 	},
 
 	/**

diff --git a/rest/v9/index.ts b/rest/v9/index.ts
@@ -971,14 +971,16 @@ export const CDNRoutes = {
 
 	/**
 	 * Route for:
-	 * - GET `/embed/avatars/{user.discriminator % 5}.png`
+	 * - GET `/embed/avatars/{index}.png`
 	 *
-	 * The `userDiscriminator` parameter should be the user discriminator modulo 5 (e.g. 1337 % 5 = 2)
+	 * The value for `index` parameter depends on whether the user is [migrated to the new username system](https://discord.com/developers/docs/change-log#unique-usernames-on-discord).
+	 * For users on the new username system, `index` will be `(user.id >> 22) % 6`.
+	 * For users on the legacy username system, `index` will be `user.discriminator % 5`.
 	 *
 	 * This route supports the extension: PNG
 	 */
-	defaultUserAvatar(userDiscriminator: DefaultUserAvatarAssets) {
-		return `/embed/avatars/${userDiscriminator}.png` as const;
+	defaultUserAvatar(index: DefaultUserAvatarAssets) {
+		return `/embed/avatars/${index}.png` as const;
 	},
 
 	/**