Overall Consistency Fixes & Minor Feature Additions

lib/Client.js

@@ -554,7 +554,7 @@ class Client extends EventEmitter {
     * @arg {String} channelID The ID of the channel to create the webhook in
     * @arg {Object} options Webhook options
     * @arg {String} options.name The default name
-    * @arg {String} [options.avatar] The default avatar as a base64 data URI. Note: base64 strings alone are not base64 data URI strings
+    * @arg {String?} [options.avatar] The default avatar as a base64 data URI. Note: base64 strings alone are not base64 data URI strings
     * @arg {String} [reason] The reason to be displayed in audit logs
     * @returns {Promise<Object>} Resolves with a webhook object
     */
@@ -688,7 +688,7 @@ class Client extends EventEmitter {
     /**
     * Create a guild sticker
     * @arg {Object} options Sticker options
-    * @arg {String} [options.description] The description of the sticker
+    * @arg {String} options.description The description of the sticker
     * @arg {Object} options.file A file object
     * @arg {Buffer} options.file.file A buffer containing file data
     * @arg {String} options.file.name What to name the file
@@ -699,7 +699,7 @@ class Client extends EventEmitter {
     */
     createGuildSticker(guildID, options, reason) {
         return this.requestHandler.request("POST", Endpoints.GUILD_STICKERS(guildID), true, {
-            description: options.description || "",
+            description: options.description,
             name: options.name,
             tags: options.tags,
             reason: reason
@@ -1796,7 +1796,7 @@ class Client extends EventEmitter {
     * Edit properties of the bot user
     * @arg {Object} options The properties to edit
     * @arg {String} [options.username] The new username
-    * @arg {String} [options.avatar] The new avatar as a base64 data URI. Note: base64 strings alone are not base64 data URI strings
+    * @arg {String?} [options.avatar] The new avatar as a base64 data URI. Note: base64 strings alone are not base64 data URI strings
     * @returns {Promise<ExtendedUser>}
     */
     editSelf(options) {
@@ -1939,7 +1939,7 @@ class Client extends EventEmitter {
     * @arg {String} webhookID The ID of the webhook
     * @arg {Object} options Webhook options
     * @arg {String} [options.name] The new default name
-    * @arg {String} [options.avatar] The new default avatar as a base64 data URI. Note: base64 strings alone are not base64 data URI strings
+    * @arg {String?} [options.avatar] The new default avatar as a base64 data URI. Note: base64 strings alone are not base64 data URI strings
     * @arg {String} [options.channelID] The new channel ID where webhooks should be sent to
     * @arg {String} [token] The token of the webhook, used instead of the Bot Authorization token
     * @arg {String} [reason] The reason to be displayed in audit logs
@@ -2274,8 +2274,7 @@ class Client extends EventEmitter {
             return Promise.resolve(this.privateChannels.get(this.privateChannelMap[userID]));
         }
         return this.requestHandler.request("POST", Endpoints.USER_CHANNELS("@me"), true, {
-            recipients: [userID],
-            type: 1
+            recipient_id: userID
         }).then((privateChannel) => new PrivateChannel(privateChannel, this));
     }
 
@@ -2545,11 +2544,13 @@ class Client extends EventEmitter {
     * Get info on an invite
     * @arg {String} inviteID The ID of the invite
     * @arg {Boolean} [withCounts] Whether to fetch additional invite info or not (approximate member counts, approximate presences, channel counts, etc.)
+    * @arg {Boolean} [withExpiration] Whether to fetch the expiration time or not
     * @returns {Promise<Invite>}
     */
-    getInvite(inviteID, withCounts) {
+    getInvite(inviteID, withCounts, withExpiration) {
         return this.requestHandler.request("GET", Endpoints.INVITE(inviteID), true, {
-            with_counts: withCounts
+            with_counts: withCounts,
+            with_expiration: withExpiration
         }).then((invite) => new Invite(invite, this));
     }
 
@@ -2753,7 +2754,7 @@ class Client extends EventEmitter {
     /**
     * Get a guild's channels via the REST API. REST mode is required to use this endpoint.
     * @arg {String} guildID The ID of the guild
-    * @returns {Promise<Array<CategoryChannel> | Array<TextChannel> | Array<TextVoiceChannel> | Array<NewsChannel>>}
+    * @returns {Promise<Array<CategoryChannel | TextChannel | TextVoiceChannel | NewsChannel | StageChannel>>}
     */
     getRESTGuildChannels(guildID) {
         if(!this.options.restMode) {

lib/Constants.js

@@ -3,6 +3,18 @@
 module.exports.GATEWAY_VERSION = 9;
 module.exports.REST_VERSION = 9;
 
+module.exports.ActivityFlags = {
+    INSTANCE:                    1 << 0,
+    JOIN:                        1 << 1,
+    SPECTATE:                    1 << 2,
+    JOIN_REQUEST:                1 << 3,
+    SYNC:                        1 << 4,
+    PLAY:                        1 << 5,
+    PARTY_PRIVACY_FRIENDS:       1 << 6,
+    PARTY_PRIVACY_VOICE_CHANNEL: 1 << 7,
+    EMBEDDED:                    1 << 8
+};
+
 module.exports.ActivityTypes = {
     GAME:      0,
     STREAMING: 1,
@@ -22,12 +34,14 @@ module.exports.ApplicationCommandOptionTypes = {
     CHANNEL:           7,
     ROLE:              8,
     MENTIONABLE:       9,
-    NUMBER:            10
+    NUMBER:            10,
+    ATTACHMENT:        11
 };
 
 module.exports.ApplicationCommandPermissionTypes = {
-    ROLE: 1,
-    USER: 2
+    ROLE:    1,
+    USER:    2,
+    CHANNEL: 3
 };
 
 module.exports.ApplicationCommandTypes = {
@@ -36,6 +50,21 @@ module.exports.ApplicationCommandTypes = {
     MESSAGE:    3
 };
 
+module.exports.ApplicationFlags = {
+    EMBEDDED_RELEASED:                1 << 1,
+    MANAGED_EMOJI:                    1 << 2,
+    GROUP_DM_CREATE:                  1 << 4,
+    GATEWAY_PRESENCE:                 1 << 12,
+    GATEWAY_PRESENCE_LIMITED:         1 << 13,
+    GATEWAY_GUILD_MEMBERS:            1 << 14,
+    GATEWAY_GUILD_MEMBERS_LIMITED:    1 << 15,
+    VERIFICATION_PENDING_GUILD_LIMIT: 1 << 16,
+    EMBEDDED:                         1 << 17,
+    GATEWAY_MESSAGE_CONTENT:          1 << 18,
+    GATEWAY_MESSAGE_CONTENT_LIMITED:  1 << 19,
+    EMBEDDED_FIRST_PARTY:             1 << 20
+};
+
 module.exports.AuditLogActions = {
     GUILD_UPDATE: 1,
 
@@ -97,7 +126,22 @@ module.exports.AuditLogActions = {
     THREAD_UPDATE: 111,
     THREAD_DELETE: 112,
 
-    APPLICATION_COMMAND_PERMISSION_UPDATE: 121
+    APPLICATION_COMMAND_PERMISSION_UPDATE: 121,
+
+    AUTO_MODERATION_RULE_CREATE:   140,
+    AUTO_MODERATION_RULE_UPDATE:   141,
+    AUTO_MODERATION_RULE_DELETE:   142,
+    AUTO_MODERATION_BLOCK_MESSAGE: 143,
+
+    CREATOR_MONETIZATION_REQUEST_CREATED: 150,
+    CREATOR_MONETIZATION_TERMS_ACCEPTED:  151,
+
+    ROLE_PROMPT_CREATE: 160,
+    ROLE_PROMPT_UPDATE: 161,
+    ROLE_PROMPT_DELETE: 162,
+
+    GUILD_HOME_FEATURE_ITEM: 171,
+    GUILD_HOME_REMOVE_ITEM:  172
 };
 
 module.exports.ButtonStyles = {
@@ -163,24 +207,42 @@ module.exports.GatewayOPCodes = {
 };
 
 module.exports.GuildFeatures = [
+    "ANIMATED_BANNER",
     "ANIMATED_ICON",
     "BANNER",
     "COMMERCE",
     "COMMUNITY",
+    "CREATOR_MONETIZABLE",
+    "CREATOR_MONETIZABLE_DISABLED",
     "DISCOVERABLE",
+    "DISCOVERABLE_DISABLED",
+    "ENABLED_DISCOVERABLE_BEFORE",
     "FEATURABLE",
+    "GUILD_HOME_TEST",
+    "HAS_DIRECTORY_ENTRY",
+    "HUB",
     "INVITE_SPLASH",
+    "LINKED_TO_HUB",
     "MEMBER_VERIFICATION_GATE_ENABLED",
     "MONETIZATION_ENABLED",
+    "MORE_EMOJI",
+    "MORE_EMOJIS",
     "MORE_STICKERS",
     "NEWS",
+    "NEW_THREAD_PERMISSIONS",
     "PARTNERED",
     "PREVIEW_ENABLED",
+    "PREVIOUSLY_DISCOVERABLE",
     "PRIVATE_THREADS",
     "ROLE_ICONS",
+    "ROLE_SUBSCRIPTIONS_AVAILABLE_FOR_PURCHASE",
     "ROLE_SUBSCRIPTIONS_ENABLED",
     "SEVEN_DAY_THREAD_ARCHIVE",
+    "TEXT_IN_VOICE_ENABLED",
+    "THREADS_ENABLED",
+    "THREADS_ENABLED_TESTING",
     "THREE_DAY_THREAD_ARCHIVE",
+    "THREADS_ENABLED",
     "TICKETED_EVENTS_ENABLED",
     "VANITY_URL",
     "VERIFIED",
@@ -205,6 +267,12 @@ module.exports.GuildNSFWLevels = {
     AGE_RESTRICTED: 3
 };
 
+module.exports.HubTypes = {
+    DEFAULT:     0,
+    HIGH_SCHOOL: 1,
+    COLLEGE:     2
+};
+
 module.exports.ImageFormats = [
     "jpg",
     "jpeg",
@@ -266,7 +334,8 @@ module.exports.InteractionTypes = {
     PING:                             1,
     APPLICATION_COMMAND:              2,
     MESSAGE_COMPONENT:                3,
-    APPLICATION_COMMAND_AUTOCOMPLETE: 4
+    APPLICATION_COMMAND_AUTOCOMPLETE: 4,
+    MODAL_SUBMIT:                     5
 };
 
 module.exports.InviteTargetTypes = {
@@ -279,34 +348,24 @@ module.exports.MFALevels = {
     ELEVATED: 1
 };
 
-module.exports.MessageActivityFlags = {
-    INSTANCE:                    1 << 0,
-    JOIN:                        1 << 1,
-    SPECTATE:                    1 << 2,
-    JOIN_REQUEST:                1 << 3,
-    SYNC:                        1 << 4,
-    PLAY:                        1 << 5,
-    PARTY_PRIVACY_FRIENDS:       1 << 6,
-    PARTY_PRIVACY_VOICE_CHANNEL: 1 << 7,
-    EMBEDDED:                    1 << 8
-};
-
 module.exports.MessageActivityTypes = {
     JOIN:         1,
     SPECTATE:     2,
     LISTEN:       3,
+    WATCH:        4,
     JOIN_REQUEST: 5
 };
 
 module.exports.MessageFlags = {
-    CROSSPOSTED:            1 << 0,
-    IS_CROSSPOST:           1 << 1,
-    SUPPRESS_EMBEDS:        1 << 2,
-    SOURCE_MESSAGE_DELETED: 1 << 3,
-    URGENT:                 1 << 4,
-    HAS_THREAD:             1 << 5,
-    EPHEMERAL:              1 << 6,
-    LOADING:                1 << 7
+    CROSSPOSTED:                            1 << 0,
+    IS_CROSSPOST:                           1 << 1,
+    SUPPRESS_EMBEDS:                        1 << 2,
+    SOURCE_MESSAGE_DELETED:                 1 << 3,
+    URGENT:                                 1 << 4,
+    HAS_THREAD:                             1 << 5,
+    EPHEMERAL:                              1 << 6,
+    LOADING:                                1 << 7,
+    FAILED_TO_MENTION_SOME_ROLES_IN_THREAD: 1 << 8
 };
 
 module.exports.MessageTypes = {
@@ -323,7 +382,7 @@ module.exports.MessageTypes = {
     USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_2:       10,
     USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_3:       11,
     CHANNEL_FOLLOW_ADD:                           12,
-
+    GUILD_STREAM:                                 13,
     GUILD_DISCOVERY_DISQUALIFIED:                 14,
     GUILD_DISCOVERY_REQUALIFIED:                  15,
     GUILD_DISCOVERY_GRACE_PERIOD_INITIAL_WARNING: 16,
@@ -333,7 +392,14 @@ module.exports.MessageTypes = {
     CHAT_INPUT_COMMAND:                           20,
     THREAD_STARTER_MESSAGE:                       21,
     GUILD_INVITE_REMINDER:                        22,
-    CONTEXT_MENU_COMMAND:                         23
+    CONTEXT_MENU_COMMAND:                         23,
+    AUTO_MODERATION_ACTION:                       24,
+    ROLE_SUBSCRIPTION_PURCHASE:                   25
+};
+
+module.exports.MembershipState = {
+    INVITED:  1,
+    ACCEPTED: 2
 };
 
 module.exports.PermissionOverwriteTypes = {
@@ -465,10 +531,12 @@ module.exports.StickerTypes = {
 };
 
 module.exports.SystemChannelFlags = {
-    SUPPRESS_JOIN_NOTIFICATIONS:           1 << 0,
-    SUPPRESS_PREMIUM_SUBSCRIPTIONS:        1 << 1,
-    SUPPRESS_GUILD_REMINDER_NOTIFICATIONS: 1 << 2,
-    SUPPRESS_JOIN_NOTIFICATION_REPLIES   : 1 << 3
+    SUPPRESS_JOIN_NOTIFICATIONS:                              1 << 0,
+    SUPPRESS_PREMIUM_SUBSCRIPTIONS:                           1 << 1,
+    SUPPRESS_GUILD_REMINDER_NOTIFICATIONS:                    1 << 2,
+    SUPPRESS_JOIN_NOTIFICATION_REPLIES:                       1 << 3,
+    SUPPRESS_ROLE_SUBSCRIPTION_PURCHASE_NOTIFICATIONS:        1 << 4,
+    SUPPRESS_ROLE_SUBSCRIPTION_PURCHASE_NOTIFICATION_REPLIES: 1 << 5
 };
 
 module.exports.SystemJoinMessages = [
@@ -487,6 +555,11 @@ module.exports.SystemJoinMessages = [
     "Yay you made it, %user%!"
 ];
 
+module.exports.TextComponentStyle = {
+    SMALL:     1,
+    PARAGRAPH: 2
+};
+
 module.exports.ThreadMemberFlags = {
     HAS_INTERACTED: 1 << 0,
     ALL_MESSAGES:   1 << 1,
@@ -510,7 +583,8 @@ module.exports.UserFlags = {
     VERIFIED_BOT:                 1 << 16,
     VERIFIED_DEVELOPER:           1 << 17, EARLY_VERIFIED_BOT_DEVELOPER: 1 << 17, VERIFIED_BOT_DEVELOPER: 1 << 17,
     CERTIFIED_MODERATOR:          1 << 18, DISCORD_CERTIFIED_MODERATOR: 1 << 18,
-    BOT_HTTP_INTERACTIONS:        1 << 19
+    BOT_HTTP_INTERACTIONS:        1 << 19,
+    SPAMMER:                      1 << 20
 };
 
 module.exports.VerificationLevels = {

lib/structures/CategoryChannel.js

@@ -2,13 +2,34 @@
 
 const Collection = require("../util/Collection");
 const GuildChannel = require("./GuildChannel");
+const PermissionOverwrite = require("./PermissionOverwrite");
 
 /**
 * Represents a guild category channel. See GuildChannel for more properties and methods.
 * @extends GuildChannel
 * @prop {Collection<GuildChannel>} channels A collection of guild channels that are part of this category
+* @prop {Collection<PermissionOverwrite>} permissionOverwrites Collection of PermissionOverwrites in this channel
+* @prop {Number} position The position of the channel
 */
 class CategoryChannel extends GuildChannel {
+    constructor(data, client) {
+        super(data, client);
+        this.update(data);
+    }
+
+    update(data) {
+        super.update(data);
+        if(data.permission_overwrites) {
+            this.permissionOverwrites = new Collection(PermissionOverwrite);
+            data.permission_overwrites.forEach((overwrite) => {
+                this.permissionOverwrites.add(overwrite);
+            });
+        }
+        if(data.position !== undefined) {
+            this.position = data.position;
+        }
+    }
+
     get channels() {
         const channels = new Collection(GuildChannel);
         if(this.guild && this.guild.channels) {
@@ -20,6 +41,14 @@ class CategoryChannel extends GuildChannel {
         }
         return channels;
     }
+
+    toJSON(props = []) {
+        return super.toJSON([
+            "permissionOverwrites",
+            "position",
+            ...props
+        ]);
+    }
 }
 
 module.exports = CategoryChannel;