feat: RoleColorsResolvable

Author: sdanialraza

packages/discord.js/src/managers/RoleManager.js

@@ -110,11 +110,11 @@ class RoleManager extends CachedManager {
    */
 
   /**
-   * @typedef {Object} RoleColors
-   * @property {number} primaryColor The primary color of the role
-   * @property {?number} secondaryColor The secondary color of the role.
+   * @typedef {Object} RoleColorsResolvable
+   * @property {ColorResolvable} primaryColor The primary color of the role
+   * @property {ColorResolvable} [secondaryColor] The secondary color of the role.
    * This will make the role a gradient between the other provided colors
-   * @property {?number} tertiaryColor The tertiary color of the role.
+   * @property {ColorResolvable} [tertiaryColor] The tertiary color of the role.
    * When sending `tertiaryColor` the API enforces the role color to be a holographic style with values of `primaryColor = 11127295`, `secondaryColor = 16759788`, and `tertiaryColor = 16761760`
    */
 
@@ -123,7 +123,7 @@ class RoleManager extends CachedManager {
    *
    * @typedef {Object} RoleCreateOptions
    * @property {string} [name] The name of the new role
-   * @property {RoleColors} [colors] The colors to create the role with
+   * @property {RoleColorsResolvable} [colors] The colors to create the role with
    * @property {boolean} [hoist] Whether or not the new role should be hoisted
    * @property {PermissionResolvable} [permissions] The permissions for the new role
    * @property {number} [position] The position of the new role

packages/discord.js/src/structures/Role.js

@@ -57,6 +57,15 @@ class Role extends Base {
       this.name = data.name;
     }
 
+    /**
+     * @typedef {Object} RoleColors
+     * @property {number} primaryColor The primary color of the role
+     * @property {?number} secondaryColor The secondary color of the role.
+     * This will make the role a gradient between the other provided colors
+     * @property {?number} tertiaryColor The tertiary color of the role.
+     * When sending `tertiaryColor` the API enforces the role color to be a holographic style with values of `primaryColor = 11127295`, `secondaryColor = 16759788`, and `tertiaryColor = 16761760`
+     */
+
     if ('colors' in data) {
       /**
        * The colors of the role
@@ -261,7 +270,7 @@ class Role extends Base {
    *
    * @typedef {Object} RoleData
    * @property {string} [name] The name of the role
-   * @property {RoleColors} [colors] The colors of the role
+   * @property {RoleColorsResolvable} [colors] The colors of the role
    * @property {boolean} [hoist] Whether or not the role should be hoisted
    * @property {number} [position] The position of the role
    * @property {PermissionResolvable} [permissions] The permissions of the role
@@ -321,7 +330,7 @@ class Role extends Base {
   /**
    * Sets new colors for the role.
    *
-   * @param {RoleColors} colors The colors of the role
+   * @param {RoleColorsResolvable} colors The colors of the role
    * @param {string} [reason] Reason for changing the role's colors
    * @returns {Promise<Role>}
    * @example

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

@@ -2840,6 +2840,12 @@ export interface RoleColors {
   tertiaryColor: number | null;
 }
 
+export interface RoleColorsResolvable {
+  primaryColor: ColorResolvable;
+  secondaryColor?: ColorResolvable;
+  tertiaryColor?: ColorResolvable;
+}
+
 export class Role extends Base {
   private constructor(client: Client<true>, data: APIRole, guild: Guild);
   public colors: RoleColors;
@@ -2870,7 +2876,7 @@ export class Role extends Base {
     channel: NonThreadGuildBasedChannel | Snowflake,
     checkAdmin?: boolean,
   ): Readonly<PermissionsBitField>;
-  public setColors(colors: RoleColors, reason?: string): Promise<Role>;
+  public setColors(colors: RoleColorsResolvable, reason?: string): Promise<Role>;
   public setHoist(hoist?: boolean, reason?: string): Promise<Role>;
   public setMentionable(mentionable?: boolean, reason?: string): Promise<Role>;
   public setName(name: string, reason?: string): Promise<Role>;
@@ -6803,7 +6809,7 @@ export interface ResolvedOverwriteOptions {
 }
 
 export interface RoleData {
-  colors?: RoleColors;
+  colors?: RoleColorsResolvable;
   hoist?: boolean;
   icon?: Base64Resolvable | BufferResolvable | EmojiResolvable | null;
   mentionable?: boolean;