refactor: provide GuildEmoji or Emoji instance

Author: almeidx

packages/discord.js/src/structures/Guild.js

@@ -916,7 +916,7 @@ class Guild extends AnonymousGuild {
    * The roles assigned to a member when the option is selected
    * @property {string} title The title of the option
    * @property {?string} [description] The description of the option
-   * @property {?(EmojiIdentifierResolvable|GuildOnboardingPromptOptionEmoji)} [emoji] The emoji of the option
+   * @property {?(EmojiIdentifierResolvable|Emoji)} [emoji] The emoji of the option
    */
 
   /**
@@ -939,8 +939,8 @@ class Guild extends AnonymousGuild {
             const emoji = resolvePartialEmoji(option.emoji);
 
             return {
-              channel_ids: option.channels?.map(c => this.channels.resolveId(c)),
-              role_ids: option.roles?.map(r => this.roles.resolveId(r)),
+              channel_ids: option.channels?.map(channel => this.channels.resolveId(channel)),
+              role_ids: option.roles?.map(role => this.roles.resolveId(role)),
               title: option.title,
               description: option.description,
               emoji_animated: emoji?.animated,

packages/discord.js/src/structures/GuildOnboardingPromptOption.js

@@ -2,7 +2,7 @@
 
 const { Collection } = require('@discordjs/collection');
 const Base = require('./Base');
-const { resolvePartialEmoji } = require('../util/Util');
+const { Emoji } = require('./Emoji.js');
 
 /**
  * Represents the data of an option from a prompt of a guilds onboarding.
@@ -45,18 +45,11 @@ class GuildOnboardingPromptOption extends Base {
     );
 
     /**
-     * The data for an emoji of a guilds onboarding prompt option
-     * @typedef {Object} GuildOnboardingPromptOptionEmoji
-     * @property {?Snowflake} id The id of the emoji
-     * @property {string} name The name of the emoji
-     * @property {boolean} animated Whether the emoji is animated
+     * The raw emoji of the option
+     * @type {RawEmoji}
+     * @private
      */
-
-    /**
-     * The emoji of the option
-     * @type {?GuildOnboardingPromptOptionEmoji}
-     */
-    this.emoji = resolvePartialEmoji(data.emoji);
+    this._emoji = data.emoji;
 
     /**
      * The title of the option
@@ -79,6 +72,15 @@ class GuildOnboardingPromptOption extends Base {
   get guild() {
     return this.client.guilds.cache.get(this.guildId);
   }
+
+  /**
+   * The emoji of this onboarding prompt option
+   * @type {GuildEmoji|Emoji}
+   */
+  get emoji() {
+    if (!this._emoji.id && !this._emoji.name) return null;
+    return this.client.emojis.resolve(this._emoji.id) ?? new Emoji(this.client, this._emoji);
+  }
 }
 
 exports.GuildOnboardingPromptOption = GuildOnboardingPromptOption;

packages/discord.js/src/util/Util.js

@@ -96,7 +96,7 @@ function parseEmoji(text) {
 
 /**
  * Resolves a partial emoji object from an {@link EmojiIdentifierResolvable}, without checking a Client.
- * @param {EmojiIdentifierResolvable} emoji Emoji identifier to resolve
+ * @param {EmojiIdentifierResolvable|RawEmoji} emoji Emoji identifier to resolve
  * @returns {?RawEmoji}
  * @private
  */

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

@@ -1616,12 +1616,14 @@ export class GuildOnboardingPrompt extends Base {
 
 export class GuildOnboardingPromptOption extends Base {
   private constructor(client: Client, data: APIGuildOnboardingPromptOption, guildId: Snowflake);
+  private _emoji: RawEmoji;
+
   public id: Snowflake;
+  public get emoji(): Emoji | GuildEmoji | null;
   public get guild(): Guild;
   public guildId: Snowflake;
   public channels: Collection<Snowflake, GuildChannel>;
   public roles: Collection<Snowflake, Role>;
-  public emoji: GuildOnboardingPromptOptionEmoji | null;
   public title: string;
   public description: string | null;
 }
@@ -5800,10 +5802,10 @@ export interface GuildOnboardingPromptOptionData {
   roles?: readonly RoleResolvable[] | ReadonlyCollection<Snowflake, Role>;
   title: string;
   description?: string | null;
-  emoji?: EmojiIdentifierResolvable | GuildOnboardingPromptOptionEmoji | null;
+  emoji?: EmojiIdentifierResolvable | Emoji | null;
 }
 
-export interface GuildOnboardingPromptOptionEmoji {
+export interface RawEmoji {
   id: Snowflake | null;
   name: string;
   animated: boolean;

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

@@ -177,6 +177,7 @@ import {
   StringSelectMenuComponentData,
   ButtonComponentData,
   MediaChannel,
+  Emoji,
 } from '.';
 import { expectAssignable, expectNotAssignable, expectNotType, expectType } from 'tsd';
 import type { ContextMenuCommandBuilder, SlashCommandBuilder } from '@discordjs/builders';
@@ -2319,6 +2320,8 @@ client.on('guildAuditLogEntryCreate', (auditLogEntry, guild) => {
 
 expectType<Readonly<GuildMemberFlagsBitField>>(guildMember.flags);
 
+declare const emojiResolvable: GuildEmoji | Emoji | string;
+
 {
   const onboarding = await guild.fetchOnboarding();
   expectType<GuildOnboarding>(onboarding);
@@ -2337,4 +2340,6 @@ expectType<Readonly<GuildMemberFlagsBitField>>(guildMember.flags);
 
   await guild.editOnboarding({ prompts: [prompt] });
   await guild.editOnboarding({ prompts: [{ ...prompt, options: [option] }] });
+
+  await guild.editOnboarding({ prompts: [{ ...prompt, options: [{ ...option, emoji: emojiResolvable }] }] });
 }