refactor: move to user primary guild to its own class

Author: sdanialraza

packages/discord.js/src/structures/User.js

@@ -5,6 +5,7 @@ const { calculateUserDefaultAvatarIndex } = require('@discordjs/rest');
 const { DiscordSnowflake } = require('@sapphire/snowflake');
 const { UserFlagsBitField } = require('../util/UserFlagsBitField.js');
 const { Base } = require('./Base.js');
+const { UserPrimaryGuild } = require('./UserPrimaryGuild.js');
 
 /**
  * Represents a user on Discord.
@@ -152,26 +153,13 @@ class User extends Base {
       this.avatarDecorationData = null;
     }
 
-    /**
-     * @typedef {Object} UserPrimaryGuild
-     * @property {?Snowflake} identityGuildId - The id of the user's primary guild
-     * @property {?boolean} identityEnabled - Whether the user is displaying the primary guild's tag
-     * @property {?string} tag - The user's guild tag. Limited to 4 characters
-     * @property {?string} badge - The guild tag badge hash
-     */
-
     if (data.primary_guild) {
       /**
        * The primary guild of the user
        *
        * @type {?UserPrimaryGuild}
        */
-      this.primaryGuild = {
-        identityGuildId: data.primary_guild.identity_guild_id,
-        identityEnabled: data.primary_guild.identity_enabled,
-        tag: data.primary_guild.tag,
-        badge: data.primary_guild.badge,
-      };
+      this.primaryGuild = new UserPrimaryGuild(data.primary_guild, this.client);
     } else {
       this.primaryGuild = null;
     }
@@ -270,18 +258,6 @@ class User extends Base {
     return this.banner && this.client.rest.cdn.banner(this.id, this.banner, options);
   }
 
-  /**
-   * A link to the user's guild tag badge.
-   *
-   * @param {ImageURLOptions} [options={}] Options for the image URL
-   * @returns {?string}
-   */
-  guildTagBadgeURL(options = {}) {
-    return this.primaryGuild?.badge
-      ? this.client.rest.cdn.guildTagBadge(this.primaryGuild.identityGuildId, this.primaryGuild.badge, options)
-      : null;
-  }
-
   /**
    * The tag of this user
    * <info>This user's username, or their legacy tag (e.g. `hydrabolt#0001`)

packages/discord.js/src/structures/UserPrimaryGuild.js

@@ -0,0 +1,67 @@
+'use strict';
+
+/**
+ * Represents the primary guild of a User.
+ */
+class UserPrimaryGuild {
+  constructor(data, client) {
+    /**
+     * The client that instantiated this
+     *
+     * @name UserPrimaryGuild#client
+     * @type {Client}
+     * @readonly
+     */
+    Object.defineProperty(this, 'client', { value: client });
+
+    /**
+     * The id of the user's primary guild
+     *
+     * @type {?Snowflake}
+     */
+    this.identityGuildId = data.identity_guild_id;
+
+    /**
+     * Whether the user is displaying the primary guild's tag
+     *
+     * @type {?boolean}
+     */
+    this.identityEnabled = data.identity_enabled;
+
+    /**
+     * The user's guild tag. Limited to 4 characters
+     *
+     * @type {?string}
+     */
+    this.tag = data.tag;
+
+    /**
+     * The guild tag badge hash
+     *
+     * @type {?string}
+     */
+    this.badge = data.badge;
+  }
+
+  /**
+   * The user's primary guild
+   *
+   * @type {?Guild}
+   * @readonly
+   */
+  get identityGuild() {
+    return this.client.guilds.cache.get(this.identityGuildId) ?? null;
+  }
+
+  /**
+   * A link to the user's guild tag badge.
+   *
+   * @param {ImageURLOptions} [options={}] Options for the image URL
+   * @returns {?string}
+   */
+  guildTagBadgeURL(options = {}) {
+    return this.badge ? this.client.rest.cdn.guildTagBadge(this.identityGuildId, this.badge, options) : null;
+  }
+}
+
+exports.UserPrimaryGuild = UserPrimaryGuild;

packages/discord.js/typings/index.d.ts

@@ -31,10 +31,7 @@ import {
   APIComponentInModalActionRow,
   APIContainerComponent,
   APIEmbed,
-  APIEmbedAuthor,
   APIEmbedField,
-  APIEmbedFooter,
-  APIEmbedImage,
   APIEmbedProvider,
   APIEmoji,
   APIEntitlement,
@@ -3497,11 +3494,15 @@ export interface AvatarDecorationData {
   skuId: Snowflake;
 }
 
-export interface UserPrimaryGuild {
-  badge: string | null;
-  identityEnabled: boolean | null;
-  identityGuildId: Snowflake | null;
-  tag: string | null;
+export class UserPrimaryGuild {
+  // TODO: Change to APIUserPrimaryGuild
+  private constructor(data: unknown, client: Client<true>);
+  public identityGuildId: Snowflake | null;
+  public identityEnabled: boolean | null;
+  public tag: string | null;
+  public badge: string | null;
+  public get identityGuild(): Guild | null;
+  public guildTagBadgeURL(options?: ImageURLOptions): string | null;
 }
 
 export interface UnfurledMediaItemData {
@@ -3542,7 +3543,6 @@ export class User extends Base {
   public avatarURL(options?: ImageURLOptions): string | null;
   public avatarDecorationURL(): string | null;
   public bannerURL(options?: ImageURLOptions): string | null | undefined;
-  public guildTagBadgeURL(options?: ImageURLOptions): string | null;
   public createDM(force?: boolean): Promise<DMChannel>;
   public deleteDM(): Promise<DMChannel>;
   public displayAvatarURL(options?: ImageURLOptions): string;