feat(Sticker): added Sticker

src/structures/Message.js

@@ -7,6 +7,7 @@ const MessageAttachment = require('./MessageAttachment');
 const Embed = require('./MessageEmbed');
 const Mentions = require('./MessageMentions');
 const ReactionCollector = require('./ReactionCollector');
+const Sticker = require('./Sticker');
 const { Error, TypeError } = require('../errors');
 const ReactionManager = require('../managers/ReactionManager');
 const Collection = require('../util/Collection');
@@ -133,6 +134,17 @@ 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));
+      }
+    }
+
     /**
      * The timestamp the message was sent at
      * @type {number}

src/structures/Sticker.js

@@ -0,0 +1,102 @@
+'use strict';
+
+const Base = require('./Base');
+const { StickerFormatTypes } = require('../util/Constants');
+const Snowflake = require('../util/Snowflake');
+
+class Sticker extends Base {
+  constructor(client, sticker) {
+    super(client);
+    /**
+     * The ID of the sticker
+     * @type {Snowflake}
+     */
+    this.id = sticker.id;
+
+    /**
+     * The ID of the sticker's image
+     * @type {string}
+     */
+    this.asset = sticker.asset;
+
+    /**
+     * The description of the sticker
+     * @type {string}
+     */
+    this.description = sticker.description;
+
+    /**
+     * The format of the sticker
+     * @type {string}
+     */
+    this.format = StickerFormatTypes[sticker.format_type];
+
+    /**
+     * The name of the sticker
+     * @type {string}
+     */
+    this.name = sticker.name;
+
+    /**
+     * The ID of the pack the sticker is from
+     * @type {Snowflake}
+     */
+    this.packID = sticker.pack_id;
+
+    /**
+     * The ID of sticker preview image
+     * @type {?string}
+     */
+    this.previewAsset = sticker.preview_asset;
+
+    /**
+     * A comma-separated list of tags for the sticker
+     * @type {?string}
+     */
+    this.tags = sticker.tags;
+  }
+
+  /**
+   * A link to the sticker.
+   * <warn>If format is "LOTTIE" it would return URL of Lottie json file</warn>
+   * @param {StickerURLOptions} [options={}] Options for the Image URL
+   * @returns {?string}
+   */
+  stickerURL({ size } = {}) {
+    if (!this.id || !this.asset) return null;
+    return this.client.rest.cdn.Sticker(this.id, this.asset, this.format, size);
+  }
+
+  /**
+   * A link to the sticker preview image.
+   * <warn>If format is "LOTTIE" it would return URL of Lottie json file</warn>
+   * @param {StickerURLOptions} [options={}] Options for the Image URL
+   * @returns {?string}
+   */
+  stickerPreviewURL({ size } = {}) {
+    if (!this.id || !this.asset) return null;
+    return this.client.rest.cdn.Sticker(this.id, this.previewAsset, this.format, size);
+  }
+
+  /**
+   * The timestamp the sticker was created at, or null if unicode
+   * @type {?number}
+   * @readonly
+   */
+  get createdTimestamp() {
+    if (!this.id) return null;
+    return Snowflake.deconstruct(this.id).timestamp;
+  }
+
+  /**
+   * The time the stikcer was created at, or null if unicode
+   * @type {?Date}
+   * @readonly
+   */
+  get createdAt() {
+    if (!this.id) return null;
+    return new Date(this.createdTimestamp);
+  }
+}
+
+module.exports = Sticker;

src/util/Constants.js

@@ -119,10 +119,18 @@ function makeImageUrl(root, { format = 'webp', size } = {}) {
  * @property {number} [size] One of `16`, `32`, `64`, `128`, `256`, `512`, `1024`, `2048`, `4096`
  */
 
+/**
+ * Options for Sticker Image URL.
+ * @typedef {Object} StickerURLOptions
+ * @property {number} [size] One of `16`, `32`, `64`, `128`, `256`, `512`, `1024`, `2048`, `4096`
+ */
+
 exports.Endpoints = {
   CDN(root) {
     return {
       Emoji: (emojiID, format = 'png') => `${root}/emojis/${emojiID}.${format}`,
+      Sticker: (stickerID, hash, format, size) =>
+        makeImageUrl(`${root}/stickers/${stickerID}/${hash}`, { format: format !== 'LOTTIE' ? 'png' : 'json', size }),
       Asset: name => `${root}/assets/${name}`,
       DefaultAvatar: discriminator => `${root}/embed/avatars/${discriminator}.png`,
       Avatar: (userID, hash, format = 'webp', size, dynamic = false) => {
@@ -644,6 +652,21 @@ exports.WebhookTypes = [
   'Channel Follower',
 ];
 
+/**
+ * The type for sticker format
+ * * PNG
+ * * APNG
+ * * LOTTIE
+ * @typedef {string} StickerFormatTypes
+ */
+exports.StickerFormatTypes = [
+  // They start at 1
+  null,
+  'PNG',
+  'APNG',
+  'LOTTIE',
+];
+
 function keyMirror(arr) {
   let tmp = Object.create(null);
   for (const value of arr) tmp[value] = value;

typings/index.d.ts

@@ -3114,6 +3114,28 @@ declare module 'discord.js' {
 
   type Status = number;
 
+  export class Sticker extends Base {
+    constructor(client: Client, data: object);
+    public asset: string;
+    public readonly createdTimestamp: number;
+    public readonly createdAt: Date;
+    public description: string;
+    public format: StickerFormatTypes;
+    public id: Snowflake;
+    public name: string;
+    public packID: Snowflake;
+    public previewAsset?: string;
+    public tags: string;
+    public stickerURL(options?: StickerURLOptions): string | null;
+    public stickerPreviewURL(options?: StickerURLOptions): string | null;
+  }
+
+  interface StickerURLOptions {
+    size: ImageSize;
+  }
+
+  type StickerFormatTypes = 'PNG' | 'APNG' | 'LOTTIE';
+
   interface StreamOptions {
     type?: StreamType;
     seek?: number;