Add snowflake utils (#1064)

* snowflakes

* use proper binary for snowflake example

* fix jsdoc errors

* remove dupe

src/client/ClientDataResolver.js

@@ -32,7 +32,7 @@ class ClientDataResolver {
    * * A Message object (resolves to the message author)
    * * A Guild object (owner of the guild)
    * * A GuildMember object
-   * @typedef {User|string|Message|Guild|GuildMember} UserResolvable
+   * @typedef {User|Snowflake|Message|Guild|GuildMember} UserResolvable
    */
 
   /**
@@ -52,7 +52,7 @@ class ClientDataResolver {
   /**
    * Resolves a UserResolvable to a user ID string
    * @param {UserResolvable} user The UserResolvable to identify
-   * @returns {?string}
+   * @returns {?Snowflake}
    */
   resolveUserID(user) {
     if (user instanceof User || user instanceof GuildMember) return user.id;
@@ -66,7 +66,7 @@ class ClientDataResolver {
    * Data that resolves to give a Guild object. This can be:
    * * A Guild object
    * * A Guild ID
-   * @typedef {Guild|string} GuildResolvable
+   * @typedef {Guild|Snowflake} GuildResolvable
    */
 
   /**
@@ -107,7 +107,7 @@ class ClientDataResolver {
    * * A Message object (the channel the message was sent in)
    * * A Guild object (the #general channel)
    * * A channel ID
-   * @typedef {Channel|Guild|Message|string} ChannelResolvable
+   * @typedef {Channel|Guild|Message|Snowflake} ChannelResolvable
    */
 
   /**
@@ -126,7 +126,7 @@ class ClientDataResolver {
   /**
    * Resolves a ChannelResolvable to a Channel object
    * @param {ChannelResolvable} channel The channel resolvable to resolve
-   * @returns {?string}
+   * @returns {?Snowflake}
    */
   resolveChannelID(channel) {
     if (channel instanceof Channel) return channel.id;

src/index.js

@@ -9,6 +9,7 @@ module.exports = {
   splitMessage: require('./util/SplitMessage'),
   escapeMarkdown: require('./util/EscapeMarkdown'),
   fetchRecommendedShards: require('./util/FetchRecommendedShards'),
+  Snowflake: require('./util/Snowflake'),
 
   Channel: require('./structures/Channel'),
   ClientOAuth2Application: require('./structures/ClientOAuth2Application'),

src/structures/Channel.js

@@ -27,7 +27,7 @@ class Channel {
   setup(data) {
     /**
      * The unique ID of the channel
-     * @type {string}
+     * @type {Snowflake}
      */
     this.id = data.id;
   }

src/structures/ClientUser.js

@@ -26,21 +26,21 @@ class ClientUser extends User {
     /**
      * A Collection of friends for the logged in user.
      * <warn>This is only filled when using a user account.</warn>
-     * @type {Collection<string, User>}
+     * @type {Collection<Snowflake, User>}
      */
     this.friends = new Collection();
 
     /**
      * A Collection of blocked users for the logged in user.
      * <warn>This is only filled when using a user account.</warn>
-     * @type {Collection<string, User>}
+     * @type {Collection<Snowflake, User>}
      */
     this.blocked = new Collection();
 
     /**
      * A Collection of notes for the logged in user.
      * <warn>This is only filled when using a user account.</warn>
-     * @type {Collection<string, string>}
+     * @type {Collection<Snowflake, string>}
      */
     this.notes = new Collection();
 
@@ -229,7 +229,7 @@ class ClientUser extends User {
    * @param {number} [options.limit=25] Maximum number of mentions to retrieve
    * @param {boolean} [options.roles=true] Whether to include role mentions
    * @param {boolean} [options.everyone=true] Whether to include everyone/here mentions
-   * @param {Guild|string} [options.guild] Limit the search to a specific guild
+   * @param {Guild|Snowflake} [options.guild] Limit the search to a specific guild
    * @returns {Promise<Message[]>}
    */
   fetchMentions(options = { limit: 25, roles: true, everyone: true, guild: null }) {

src/structures/Emoji.js

@@ -26,7 +26,7 @@ class Emoji {
   setup(data) {
     /**
      * The ID of the emoji
-     * @type {string}
+     * @type {Snowflake}
      */
     this.id = data.id;
 
@@ -71,7 +71,7 @@ class Emoji {
 
   /**
    * A collection of roles this emoji is active for (empty if all), mapped by role ID.
-   * @type {Collection<string, Role>}
+   * @type {Collection<Snowflake, Role>}
    * @readonly
    */
   get roles() {

src/structures/GroupDMChannel.js

@@ -61,7 +61,7 @@ class GroupDMChannel extends Channel {
     if (!this.recipients) {
       /**
        * A collection of the recipients of this DM, mapped by their ID.
-       * @type {Collection<string, User>}
+       * @type {Collection<Snowflake, User>}
        */
       this.recipients = new Collection();
     }

src/structures/Guild.js

@@ -25,25 +25,25 @@ class Guild {
 
     /**
      * A collection of members that are in this guild. The key is the member's ID, the value is the member.
-     * @type {Collection<string, GuildMember>}
+     * @type {Collection<Snowflake, GuildMember>}
      */
     this.members = new Collection();
 
     /**
      * A collection of channels that are in this guild. The key is the channel's ID, the value is the channel.
-     * @type {Collection<string, GuildChannel>}
+     * @type {Collection<Snowflake, GuildChannel>}
      */
     this.channels = new Collection();
 
     /**
      * A collection of roles that are in this guild. The key is the role's ID, the value is the role.
-     * @type {Collection<string, Role>}
+     * @type {Collection<Snowflake, Role>}
      */
     this.roles = new Collection();
 
     /**
      * A collection of presences in this guild
-     * @type {Collection<string, Presence>}
+     * @type {Collection<Snowflake, Presence>}
      */
     this.presences = new Collection();
 
@@ -57,7 +57,7 @@ class Guild {
 
       /**
        * The Unique ID of the Guild, useful for comparisons.
-       * @type {string}
+       * @type {Snowflake}
        */
       this.id = data.id;
     } else {
@@ -116,13 +116,13 @@ class Guild {
 
     /**
      * The ID of the application that created this guild (if applicable)
-     * @type {?string}
+     * @type {?Snowflake}
      */
     this.applicationID = data.application_id;
 
     /**
      * A collection of emojis that are in this guild. The key is the emoji's ID, the value is the emoji.
-     * @type {Collection<string, Emoji>}
+     * @type {Collection<Snowflake, Emoji>}
      */
     this.emojis = new Collection();
     for (const emoji of data.emojis) this.emojis.set(emoji.id, new Emoji(this, emoji));
@@ -169,7 +169,7 @@ class Guild {
     if (data.owner_id) {
       /**
        * The user ID of this guild's owner.
-       * @type {string}
+       * @type {Snowflake}
        */
       this.ownerID = data.owner_id;
     }

src/structures/GuildChannel.js

@@ -37,7 +37,7 @@ class GuildChannel extends Channel {
 
     /**
      * A map of permission overwrites in this channel for roles and users.
-     * @type {Collection<string, PermissionOverwrites>}
+     * @type {Collection<Snowflake, PermissionOverwrites>}
      */
     this.permissionOverwrites = new Collection();
     if (data.permission_overwrites) {

src/structures/GuildMember.js

@@ -36,7 +36,7 @@ class GuildMember {
 
     /**
      * The ID of the last message sent by the member in their guild, if one was sent.
-     * @type {?string}
+     * @type {?Snowflake}
      */
     this.lastMessageID = null;
   }
@@ -68,13 +68,13 @@ class GuildMember {
 
     /**
      * The voice session ID of this member, if any
-     * @type {?string}
+     * @type {?Snowflake}
      */
     this.voiceSessionID = data.session_id;
 
     /**
      * The voice channel ID of this member, if any
-     * @type {?string}
+     * @type {?Snowflake}
      */
     this.voiceChannelID = data.channel_id;
 
@@ -120,7 +120,7 @@ class GuildMember {
 
   /**
    * A list of roles that are applied to this GuildMember, mapped by the role ID.
-   * @type {Collection<string, Role>}
+   * @type {Collection<Snowflake, Role>}
    * @readonly
    */
   get roles() {
@@ -175,7 +175,7 @@ class GuildMember {
 
   /**
    * The ID of this user
-   * @type {string}
+   * @type {Snowflake}
    * @readonly
    */
   get id() {

src/structures/Message.js

@@ -33,7 +33,7 @@ class Message {
   setup(data) { // eslint-disable-line complexity
     /**
      * The ID of the message (unique in the channel it was sent)
-     * @type {string}
+     * @type {Snowflake}
      */
     this.id = data.id;
 
@@ -75,7 +75,7 @@ class Message {
     this.tts = data.tts;
 
     /**
-     * A random number used for checking message delivery
+     * A random number or string used for checking message delivery
      * @type {string}
      */
     this.nonce = data.nonce;
@@ -94,7 +94,7 @@ class Message {
 
     /**
      * A collection of attachments in the message - e.g. Pictures - mapped by their ID.
-     * @type {Collection<string, MessageAttachment>}
+     * @type {Collection<Snowflake, MessageAttachment>}
      */
     this.attachments = new Collection();
     for (const attachment of data.attachments) this.attachments.set(attachment.id, new Attachment(this, attachment));
@@ -114,9 +114,9 @@ class Message {
     /**
      * An object containing a further users, roles or channels collections
      * @type {Object}
-     * @property {Collection<string, User>} mentions.users Mentioned users, maps their ID to the user object.
-     * @property {Collection<string, Role>} mentions.roles Mentioned roles, maps their ID to the role object.
-     * @property {Collection<string, GuildChannel>} mentions.channels Mentioned channels,
+     * @property {Collection<Snowflake, User>} mentions.users Mentioned users, maps their ID to the user object.
+     * @property {Collection<Snowflake, Role>} mentions.roles Mentioned roles, maps their ID to the role object.
+     * @property {Collection<Snowflake, GuildChannel>} mentions.channels Mentioned channels,
      * maps their ID to the channel object.
      * @property {boolean} mentions.everyone Whether or not @everyone was mentioned.
      */
@@ -156,7 +156,7 @@ class Message {
 
     /**
      * A collection of reactions to this message, mapped by the reaction "id".
-     * @type {Collection<string, MessageReaction>}
+     * @type {Collection<Snowflake|string, MessageReaction>}
      */
     this.reactions = new Collection();
 
@@ -169,7 +169,7 @@ class Message {
 
     /**
      * ID of the webhook that sent the message, if applicable
-     * @type {?string}
+     * @type {?Snowflake}
      */
     this.webhookID = data.webhook_id || null;
 

src/structures/MessageAttachment.js

@@ -23,7 +23,7 @@ class MessageAttachment {
   setup(data) {
     /**
      * The ID of this attachment
-     * @type {string}
+     * @type {Snowflake}
      */
     this.id = data.id;
 

src/structures/MessageCollector.js

@@ -61,7 +61,7 @@ class MessageCollector extends EventEmitter {
 
     /**
      * A collection of collected messages, mapped by message ID.
-     * @type {Collection<string, Message>}
+     * @type {Collection<Snowflake, Message>}
      */
     this.collected = new Collection();
 

src/structures/MessageReaction.js

@@ -27,7 +27,7 @@ class MessageReaction {
 
     /**
      * The users that have given this reaction, mapped by their ID.
-     * @type {Collection<string, User>}
+     * @type {Collection<Snowflake, User>}
      */
     this.users = new Collection();
 

src/structures/OAuth2Application.js

@@ -17,7 +17,7 @@ class OAuth2Application {
   setup(data) {
     /**
      * The ID of the app
-     * @type {string}
+     * @type {Snowflake}
      */
     this.id = data.id;
 

src/structures/PartialGuild.js

@@ -24,7 +24,7 @@ class PartialGuild {
   setup(data) {
     /**
      * The ID of this guild
-     * @type {string}
+     * @type {Snowflake}
      */
     this.id = data.id;
 

src/structures/PartialGuildChannel.js

@@ -23,7 +23,7 @@ class PartialGuildChannel {
   setup(data) {
     /**
      * The ID of this guild channel
-     * @type {string}
+     * @type {Snowflake}
      */
     this.id = data.id;
 

src/structures/PermissionOverwrites.js

@@ -17,7 +17,7 @@ class PermissionOverwrites {
   setup(data) {
     /**
      * The ID of this overwrite, either a user ID or a role ID
-     * @type {string}
+     * @type {Snowflake}
      */
     this.id = data.id;
 

src/structures/ReactionEmoji.js

@@ -19,7 +19,7 @@ class ReactionEmoji {
 
     /**
      * The ID of this reaction emoji.
-     * @type {string}
+     * @type {?Snowflake}
      */
     this.id = id;
   }

src/structures/Role.js

@@ -25,7 +25,7 @@ class Role {
   setup(data) {
     /**
      * The ID of the role (unique to the guild it is part of)
-     * @type {string}
+     * @type {Snowflake}
      */
     this.id = data.id;
 
@@ -103,7 +103,7 @@ class Role {
 
   /**
    * The cached guild members that have this role.
-   * @type {Collection<string, GuildMember>}
+   * @type {Collection<Snowflake, GuildMember>}
    * @readonly
    */
   get members() {

src/structures/TextChannel.js

@@ -29,7 +29,7 @@ class TextChannel extends GuildChannel {
 
   /**
    * A collection of members that can see this channel, mapped by their ID.
-   * @type {Collection<string, GuildMember>}
+   * @type {Collection<Snowflake, GuildMember>}
    * @readonly
    */
   get members() {

src/structures/User.js

@@ -22,7 +22,7 @@ class User {
   setup(data) {
     /**
      * The ID of the user
-     * @type {string}
+     * @type {Snowflake}
      */
     this.id = data.id;
 
@@ -52,7 +52,7 @@ class User {
 
     /**
      * The ID of the last message sent by the user, if one was sent.
-     * @type {?string}
+     * @type {?Snowflake}
      */
     this.lastMessageID = null;
   }

src/structures/VoiceChannel.js

@@ -11,7 +11,7 @@ class VoiceChannel extends GuildChannel {
 
     /**
      * The members in this voice channel.
-     * @type {Collection<string, GuildMember>}
+     * @type {Collection<Snowflake, GuildMember>}
      */
     this.members = new Collection();
 

src/structures/Webhook.js

@@ -43,19 +43,19 @@ class Webhook {
 
     /**
      * The ID of the webhook
-     * @type {string}
+     * @type {Snowflake}
      */
     this.id = data.id;
 
     /**
      * The guild the webhook belongs to
-     * @type {string}
+     * @type {Snowflake}
      */
     this.guildID = data.guild_id;
 
     /**
      * The channel the webhook belongs to
-     * @type {string}
+     * @type {Snowflake}
      */
     this.channelID = data.channel_id;
 

src/structures/interface/TextBasedChannel.js

@@ -11,13 +11,13 @@ class TextBasedChannel {
   constructor() {
     /**
      * A collection containing the messages sent to this channel.
-     * @type {Collection<string, Message>}
+     * @type {Collection<Snowflake, Message>}
      */
     this.messages = new Collection();
 
     /**
      * The ID of the last message in the channel, if one was sent.
-     * @type {?string}
+     * @type {?Snowflake}
      */
     this.lastMessageID = null;
   }

src/util/Snowflake.js

@@ -0,0 +1,62 @@
+const Long = require('long');
+
+// Discord epoch (2015-01-01T00:00:00.000Z)
+const EPOCH = 1420070400000;
+let INCREMENT = 0;
+
+function pad(v, n, c = '0') {
+  return String(v).length >= n ? String(v) : (String(c).repeat(n) + v).slice(-n);
+}
+
+ /**
+  * A deconstructed snowflake
+  * @typedef {Object} DeconstructedSnowflake
+  * @property {Date} date Date in the snowflake
+  * @property {number} workerID Worker id in the snowflake
+  * @property {number} processID Process id in the snowflake
+  * @property {number} increment Increment in the snowflake
+  * @property {string} binary Binary representation of the snowflake
+  */
+
+  /**
+   * A Twitter snowflake, except the epoch is 2015-01-01T00:00:00.000Z
+   * ```
+   * If we have a snowflake '266241948824764416' we can represent it as binary:
+   *
+   * 64                                          22     17     12          0
+   *  000000111011000111100001101001000101000000  00001  00000  000000000000
+   *       number of ms since discord epoch       worker  pid    increment
+   * ```
+   * Note: this generator hardcodes the worker id as 1 and the process id as 0
+   * @typedef {string} Snowflake
+   * @class Snowflake
+   */
+class Snowflake {
+  /**
+   * Generate a Discord snowflake
+   * @returns {Snowflake} The generated snowflake
+   */
+  static generate() {
+    if (INCREMENT >= 4095) INCREMENT = 0;
+    const BINARY = `${pad((Date.now() - EPOCH).toString(2), 42)}0000100000${pad((INCREMENT++).toString(2), 12)}`;
+    return Long.fromString(BINARY, 2).toString();
+  }
+
+  /**
+   * Deconstruct a Discord snowflake
+   * @param {Snowflake} snowflake Snowflake to deconstruct
+   * @returns {DeconstructedSnowflake} Deconstructed snowflake
+   */
+  static deconstruct(snowflake) {
+    const BINARY = pad(Long.fromString(snowflake).toString(2), 64);
+    return {
+      date: new Date(parseInt(BINARY.substring(0, 42), 2) + EPOCH),
+      workerID: parseInt(BINARY.substring(42, 47), 2),
+      processID: parseInt(BINARY.substring(47, 52), 2),
+      increment: parseInt(BINARY.substring(52, 64), 2),
+      binary: BINARY,
+    };
+  }
+}
+
+module.exports = Snowflake;