feat(Sticker): updates, sticker packs, and guild stickers

src/client/Client.js

@@ -13,6 +13,8 @@ const ShardClientUtil = require('../sharding/ShardClientUtil');
 const GuildPreview = require('../structures/GuildPreview');
 const GuildTemplate = require('../structures/GuildTemplate');
 const Invite = require('../structures/Invite');
+const Sticker = require('../structures/Sticker');
+const StickerPack = require('../structures/StickerPack');
 const VoiceRegion = require('../structures/VoiceRegion');
 const Webhook = require('../structures/Webhook');
 const Widget = require('../structures/Widget');
@@ -310,6 +312,33 @@ class Client extends BaseClient {
     });
   }
 
+  /**
+   * Obtains a sticker from Discord.
+   * @param {Snowflake} id The sticker's ID
+   * @returns {Promise<Sticker>}
+   * @example
+   * client.fetchSticker('id')
+   *   .then(sticker => console.log(`Obtained sticker with name: ${sticker.name}`))
+   *   .catch(console.error);
+   */
+  async fetchSticker(id) {
+    const data = await this.api.stickers(id).get();
+    return new Sticker(this, data);
+  }
+
+  /**
+   * Obtains the list of sticker packs available to Nitro subscribers from Discord.
+   * @returns {Promise<Collection<Snowflake, StickerPack>>}
+   * @example
+   * client.fetchPremiumStickerPacks()
+   *   .then(packs => console.log(`Available sticker packs are: ${packs.map(pack => pack.name).join(', ')}`))
+   *   .catch(console.error);
+   */
+  async fetchPremiumStickerPacks() {
+    const data = await this.api('sticker-packs').get();
+    return new Collection(data.sticker_packs.map(p => [p.id, new StickerPack(this, p)]));
+  }
+
   /**
    * Sweeps all text-based channels' messages and removes the ones older than the max message lifetime.
    * If the message has been edited, the time of the edit is used rather than the time of the original message.

src/errors/Messages.js

@@ -98,8 +98,9 @@ const Messages = {
 
   EMOJI_TYPE: 'Emoji must be a string or GuildEmoji/ReactionEmoji',
   EMOJI_MANAGED: 'Emoji is managed and has no Author.',
-  MISSING_MANAGE_EMOJIS_PERMISSION: guild =>
-    `Client must have Manage Emoji permission in guild ${guild} to see emoji authors.`,
+  MISSING_MANAGE_EMOJIS_AND_STICKERS_PERMISSION: guild =>
+    `Client must have Manage Emojis and Stickers permission in guild ${guild} to see emoji authors.`,
+  NOT_GUILD_STICKER: 'Sticker is a standard (non-guild) sticker and has no User.',
 
   REACTION_RESOLVE_USER: "Couldn't resolve the user ID to remove from the reaction.",
 

src/structures/GuildEmoji.js

@@ -59,7 +59,7 @@ class GuildEmoji extends BaseGuildEmoji {
    */
   get deletable() {
     if (!this.guild.me) throw new Error('GUILD_UNCACHED_ME');
-    return !this.managed && this.guild.me.permissions.has(Permissions.FLAGS.MANAGE_EMOJIS);
+    return !this.managed && this.guild.me.permissions.has(Permissions.FLAGS.MANAGE_EMOJIS_AND_STICKERS);
   }
 
   /**
@@ -80,8 +80,8 @@ class GuildEmoji extends BaseGuildEmoji {
       throw new Error('EMOJI_MANAGED');
     } else {
       if (!this.guild.me) throw new Error('GUILD_UNCACHED_ME');
-      if (!this.guild.me.permissions.has(Permissions.FLAGS.MANAGE_EMOJIS)) {
-        throw new Error('MISSING_MANAGE_EMOJIS_PERMISSION', this.guild);
+      if (!this.guild.me.permissions.has(Permissions.FLAGS.MANAGE_EMOJIS_AND_STICKERS)) {
+        throw new Error('MISSING_MANAGE_EMOJIS_AND_STICKERS_PERMISSION', this.guild);
       }
     }
     const data = await this.client.api.guilds(this.guild.id).emojis(this.id).get();

src/structures/Message.js

@@ -146,12 +146,7 @@ class Message extends Base {
      * A collection of stickers in the message
      * @type {Collection<Snowflake, Sticker>}
      */
-    this.stickers = new Collection();
-    if (data.stickers) {
-      for (const sticker of data.stickers) {
-        this.stickers.set(sticker.id, new Sticker(this.client, sticker));
-      }
-    }
+    this.stickers = new Collection(data.sticker_items?.map(s => [s.id, new Sticker(this.client, s)]));
 
     /**
      * The timestamp the message was sent at

src/structures/Sticker.js

@@ -1,33 +1,42 @@
 'use strict';
 
 const Base = require('./Base');
-const { StickerFormatTypes } = require('../util/Constants');
+const { StickerFormatTypes, StickerTypes } = require('../util/Constants');
 const SnowflakeUtil = require('../util/SnowflakeUtil');
 
 /**
  * Represents a Sticker.
  * @extends {Base}
  */
 class Sticker extends Base {
+  /**
+   * @param {Client} client The instantiating client
+   * @param {Object} sticker The data for the sticker
+   */
   constructor(client, sticker) {
     super(client);
+
+    this._patch(sticker);
+  }
+
+  _patch(sticker) {
     /**
      * The ID of the sticker
      * @type {Snowflake}
      */
     this.id = sticker.id;
 
     /**
-     * The ID of the sticker's image
-     * @type {string}
+     * The description of the sticker
+     * @type {?string}
      */
-    this.asset = sticker.asset;
+    this.description = sticker.description ?? null;
 
     /**
-     * The description of the sticker
-     * @type {string}
+     * The type of the sticker
+     * @type {?StickerType}
      */
-    this.description = sticker.description;
+    this.type = StickerTypes[sticker.type] ?? null;
 
     /**
      * The format of the sticker
@@ -42,16 +51,40 @@ class Sticker extends Base {
     this.name = sticker.name;
 
     /**
-     * The ID of the pack the sticker is from
-     * @type {Snowflake}
+     * The ID of the pack the sticker is from, for standard stickers
+     * @type {?Snowflake}
      */
-    this.packID = sticker.pack_id;
+    this.packID = sticker.pack_id ?? null;
 
     /**
-     * An array of tags for the sticker, if any
+     * An array of tags for the sticker
      * @type {string[]}
      */
-    this.tags = sticker.tags?.split(', ') ?? [];
+    this.tags = sticker.tags?.split(', ') ?? null;
+
+    /**
+     * Whether or not the guild sticker is available
+     * @type {?boolean}
+     */
+    this.available = sticker.available ?? null;
+
+    /**
+     * The ID of the guild that owns this sticker
+     * @type {?Snowflake}
+     */
+    this.guildID = sticker.guild_id ?? null;
+
+    /**
+     * The user that uploaded the guild sticker
+     * @type {?User}
+     */
+    this.user = sticker.user ? this.client.users.add(sticker.user) : null;
+
+    /**
+     * The standard sticker's sort order within its pack
+     * @type {?number}
+     */
+    this.sortValue = sticker.sort_value ?? null;
   }
 
   /**
@@ -72,16 +105,62 @@ class Sticker extends Base {
     return new Date(this.createdTimestamp);
   }
 
+  /**
+   * Whether this sticker is partial
+   * @type {boolean}
+   * @readonly
+   */
+  get partial() {
+    return 'username' in this;
+  }
+
+  /**
+   * The guild that owns this sticker
+   * @type {?Guild}
+   * @readonly
+   */
+  get guild() {
+    return this.client.guilds.resolve(this.guildID);
+  }
+
   /**
    * A link to the sticker
-   * <info>If the sticker's format is LOTTIE, it returns the URL of the Lottie json file.
-   * Lottie json files must be converted in order to be displayed in Discord.</info>
+   * <info>If the sticker's format is LOTTIE, it returns the URL of the Lottie json file.</info>
    * @type {string}
    */
   get url() {
-    return `${this.client.options.http.cdn}/stickers/${this.id}/${this.asset}.${
-      this.format === 'LOTTIE' ? 'json' : 'png'
-    }`;
+    return this.client.rest.cdn.Sticker(this.id, this.format);
+  }
+
+  /**
+   * Fetches this sticker.
+   * @returns {Promise<?Sticker>}
+   */
+  async fetch() {
+    const data = await this.client.api.stickers(this.id).get();
+    this._patch(data);
+    return this;
+  }
+
+  /**
+   * Fetches the pack this sticker is part of from Discord, if this is a Nitro sticker.
+   * @returns {Promise<?StickerPack>}
+   */
+  async fetchPack() {
+    return (this.packID && (await this.client.fetchPremiumStickerPacks()).get(this.packID)) ?? null;
+  }
+
+  /**
+   * Fetches the user who uploaded this sticker, if this is a guild sticker.
+   * @returns {Promise<?User>}
+   */
+  async fetchUser() {
+    if (this.partial) await this.fetch();
+    if (!this.guildID) throw new Error('NOT_GUILD_STICKER');
+
+    const data = await this.client.api.guilds(this.guildID).stickers(this.id).get();
+    this._patch(data);
+    return this.user;
   }
 }
 

src/structures/StickerPack.js

@@ -0,0 +1,99 @@
+'use strict';
+
+const Base = require('./Base');
+const Sticker = require('./Sticker');
+const Collection = require('../util/Collection');
+const SnowflakeUtil = require('../util/SnowflakeUtil');
+
+/**
+ * Represents a pack of standard stickers.
+ * @extends {Base}
+ */
+class StickerPack extends Base {
+  /**
+   * @param {Client} client The instantiating client
+   * @param {Object} pack The data for the sticker pack
+   */
+  constructor(client, pack) {
+    super(client);
+    /**
+     * The ID of the sticker pack
+     * @type {Snowflake}
+     */
+    this.id = pack.id;
+
+    /**
+     * The stickers in the pack
+     * @type {Collection<Snowflake, Sticker>}
+     */
+    this.stickers = new Collection(pack.stickers.map(s => [s.id, new Sticker(client, s)]));
+
+    /**
+     * The name of the sticker pack
+     * @type {string}
+     */
+    this.name = pack.name;
+
+    /**
+     * The ID of the pack's SKU
+     * @type {Snowflake}
+     */
+    this.skuID = pack.sku_id;
+
+    /**
+     * The ID of a sticker in the pack which is shown as the pack's icon
+     * @type {?Snowflake}
+     */
+    this.coverStickerID = pack.cover_sticker_id ?? null;
+
+    /**
+     * The description of the sticker pack
+     * @type {string}
+     */
+    this.description = pack.description;
+
+    /**
+     * The ID of the sticker pack's banner image
+     * @type {Snowflake}
+     */
+    this.bannerID = pack.banner_asset_id;
+  }
+
+  /**
+   * The timestamp the sticker was created at
+   * @type {number}
+   * @readonly
+   */
+  get createdTimestamp() {
+    return SnowflakeUtil.deconstruct(this.id).timestamp;
+  }
+
+  /**
+   * The time the sticker was created at
+   * @type {Date}
+   * @readonly
+   */
+  get createdAt() {
+    return new Date(this.createdTimestamp);
+  }
+
+  /**
+   * The sticker which is shown as the pack's icon
+   * @type {?Sticker}
+   * @readonly
+   */
+  get coverSticker() {
+    return this.coverStickerID && this.stickers.get(this.coverStickerID);
+  }
+
+  /**
+   * The URL to this sticker pack's banner.
+   * @param {StaticImageURLOptions} [options={}] Options for the Image URL
+   * @returns {string}
+   */
+  bannerURL({ format, size } = {}) {
+    return this.client.rest.cdn.StickerPackBanner(this.bannerID, format, size);
+  }
+}
+
+module.exports = StickerPack;

src/util/Constants.js

@@ -169,6 +169,8 @@ exports.Endpoints = {
         makeImageUrl(`${root}/app-icons/${clientID}/${hash}`, { size, format }),
       AppAsset: (clientID, hash, { format = 'webp', size } = {}) =>
         makeImageUrl(`${root}/app-assets/${clientID}/${hash}`, { size, format }),
+      StickerPackBanner: (bannerID, format = 'webp', size) =>
+        makeImageUrl(`${root}/app-assets/710982414301790216/store/${bannerID}`, { size, format }),
       GDMIcon: (channelID, hash, format = 'webp', size) =>
         makeImageUrl(`${root}/channel-icons/${channelID}/${hash}`, { size, format }),
       Splash: (guildID, hash, format = 'webp', size) =>
@@ -177,6 +179,8 @@ exports.Endpoints = {
         makeImageUrl(`${root}/discovery-splashes/${guildID}/${hash}`, { size, format }),
       TeamIcon: (teamID, hash, { format = 'webp', size } = {}) =>
         makeImageUrl(`${root}/team-icons/${teamID}/${hash}`, { size, format }),
+      Sticker: (stickerID, stickerFormat) =>
+        `${root}/stickers/${stickerID}.${stickerFormat === 'LOTTIE' ? 'json' : 'png'}`,
     };
   },
   invite: (root, code) => `${root}/${code}`,
@@ -742,6 +746,14 @@ exports.WebhookTypes = createEnum([null, 'Incoming', 'Channel Follower']);
 
 /**
  * The value set for a sticker's type:
+ * * STANDARD
+ * * GUILD
+ * @typedef {string} StickerFormatType
+ */
+exports.StickerTypes = createEnum([null, 'STANDARD', 'GUILD']);
+
+/**
+ * The value set for a sticker's format type:
  * * PNG
  * * APNG
  * * LOTTIE