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

Co-authored-by: SpaceEEC <spaceeec@yahoo.com>
Co-authored-by: Antonio Román <kyradiscord@gmail.com>
Co-authored-by: Tiemen <ThaTiemsz@users.noreply.github.com>
Co-authored-by: Vlad Frangu <kingdgrizzle@gmail.com>
Co-authored-by: BannerBomb <BannerBomb55@gmail.com>
Co-authored-by: Noel <icrawltogo@gmail.com>
Co-authored-by: Sugden <28943913+NotSugden@users.noreply.github.com>

src/client/Client.js

@@ -14,6 +14,8 @@ const ClientPresence = require('../structures/ClientPresence');
 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');
@@ -318,6 +320,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/client/actions/GuildStickerCreate.js

@@ -0,0 +1,20 @@
+'use strict';
+
+const Action = require('./Action');
+const { Events } = require('../../util/Constants');
+
+class GuildStickerCreateAction extends Action {
+  handle(guild, createdSticker) {
+    const already = guild.stickers.cache.has(createdSticker.id);
+    const sticker = guild.stickers._add(createdSticker);
+    /**
+     * Emitted whenever a custom sticker is created in a guild.
+     * @event Client#stickerCreate
+     * @param {Sticker} sticker The sticker that was created
+     */
+    if (!already) this.client.emit(Events.GUILD_STICKER_CREATE, sticker);
+    return { sticker };
+  }
+}
+
+module.exports = GuildStickerCreateAction;

src/client/actions/GuildStickerDelete.js

@@ -0,0 +1,20 @@
+'use strict';
+
+const Action = require('./Action');
+const { Events } = require('../../util/Constants');
+
+class GuildStickerDeleteAction extends Action {
+  handle(sticker) {
+    sticker.guild.stickers.cache.delete(sticker.id);
+    sticker.deleted = true;
+    /**
+     * Emitted whenever a custom sticker is deleted in a guild.
+     * @event Client#stickerDelete
+     * @param {Sticker} sticker The sticker that was deleted
+     */
+    this.client.emit(Events.GUILD_STICKER_DELETE, sticker);
+    return { sticker };
+  }
+}
+
+module.exports = GuildStickerDeleteAction;

src/client/actions/GuildStickerUpdate.js

@@ -0,0 +1,20 @@
+'use strict';
+
+const Action = require('./Action');
+const { Events } = require('../../util/Constants');
+
+class GuildStickerUpdateAction extends Action {
+  handle(current, data) {
+    const old = current._update(data);
+    /**
+     * Emitted whenever a custom sticker is updated in a guild.
+     * @event Client#stickerUpdate
+     * @param {Sticker} oldSticker The old sticker
+     * @param {Sticker} newSticker The new sticker
+     */
+    this.client.emit(Events.GUILD_STICKER_UPDATE, old, current);
+    return { sticker: current };
+  }
+}
+
+module.exports = GuildStickerUpdateAction;

src/client/actions/GuildStickersUpdate.js

@@ -0,0 +1,34 @@
+'use strict';
+
+const Action = require('./Action');
+
+class GuildStickersUpdateAction extends Action {
+  handle(data) {
+    const guild = this.client.guilds.cache.get(data.guild_id);
+    if (!guild?.stickers) return;
+
+    const deletions = new Map(guild.stickers.cache);
+
+    for (const sticker of data.stickers) {
+      // Determine type of sticker event
+      const cachedSticker = guild.stickers.cache.get(sticker.id);
+      if (cachedSticker) {
+        deletions.delete(sticker.id);
+        if (!cachedSticker.equals(sticker)) {
+          // Sticker updated
+          this.client.actions.GuildStickerUpdate.handle(cachedSticker, sticker);
+        }
+      } else {
+        // Sticker added
+        this.client.actions.GuildStickerCreate.handle(guild, sticker);
+      }
+    }
+
+    for (const sticker of deletions.values()) {
+      // Sticker deleted
+      this.client.actions.GuildStickerDelete.handle(sticker);
+    }
+  }
+}
+
+module.exports = GuildStickersUpdateAction;

src/client/websocket/handlers/GUILD_STICKERS_UPDATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildStickersUpdate.handle(packet.d);
+};