feat(Widget): wrapper for widget.json

esm/discord.mjs

@@ -103,5 +103,6 @@ export const {
   VoiceRegion,
   VoiceState,
   Webhook,
-  WebSocket
+  WebSocket,
+  Widget
 } = Discord;

src/client/Client.js

@@ -15,6 +15,7 @@ const GuildTemplate = require('../structures/GuildTemplate');
 const Invite = require('../structures/Invite');
 const VoiceRegion = require('../structures/VoiceRegion');
 const Webhook = require('../structures/Webhook');
+const Widget = require('../structures/Widget');
 const Collection = require('../util/Collection');
 const { Events, DefaultOptions, InviteScopes } = require('../util/Constants');
 const DataResolver = require('../util/DataResolver');
@@ -365,6 +366,19 @@ class Client extends BaseClient {
       .then(data => new GuildPreview(this, data));
   }
 
+  /**
+   * Obtains the widget of a guild from Discord, available for guilds with the widget enabled.
+   * @param {GuildResolvable} guild The guild to fetch the widget for
+   * @returns {Promise<Widget>}
+   */
+  async fetchWidget(guild) {
+    const id = this.guilds.resolveID(guild);
+    if (!id) throw new TypeError('INVALID_TYPE', 'guild', 'GuildResolvable');
+    const data = await this.api.guilds(id, 'widget.json').get();
+    if (data.code) throw new Error('WIDGET_DISABLED');
+    return new Widget(this, data);
+  }
+
   /**
    * Options for {@link Client#generateInvite}.
    * @typedef {Object} InviteGenerationOptions

src/index.js

@@ -115,6 +115,7 @@ module.exports = {
   VoiceRegion: require('./structures/VoiceRegion'),
   VoiceState: require('./structures/VoiceState'),
   Webhook: require('./structures/Webhook'),
+  Widget: require('./structures/Widget'),
 
   WebSocket: require('./WebSocket'),
 };

src/structures/Widget.js

@@ -0,0 +1,79 @@
+'use strict';
+
+const Base = require('./Base');
+const Collection = require('../util/Collection');
+
+/**
+ * Represents a Widget.
+ */
+class Widget extends Base {
+  /**
+   * @param {Client} client - The instantiating client
+   * @param {Object} data - The raw data
+   */
+  constructor(client, data) {
+    super(client);
+    this._patch(data);
+  }
+  /**
+   * Builds the widget with the provided data.
+   * @param {*} data The raw data of the widget
+   * @private
+   */
+  _patch(data) {
+    /**
+     * The id of the guild.
+     * @type {string}
+     */
+    this.id = data.id;
+
+    /**
+     * The name of the guild.
+     * @type {string}
+     */
+    this.name = data.name;
+
+    /**
+     * The invite of the guild.
+     * @type {?string}
+     */
+    this.instantInvite = data.instant_invite;
+
+    /**
+     * The list of channels in the guild.
+     * @type {Collection<string, WidgetChannel>}
+     */
+    this.channels = new Collection();
+    for (const channel of data.channels) {
+      this.channels.set(channel.id, channel);
+    }
+
+    /**
+     * The list of members in the guild.
+     * @type {Collection<string, WidgetMember>}
+     */
+    this.members = new Collection();
+    for (const member of data.members) {
+      this.members.set(member.id, member);
+    }
+
+    /**
+     * The number of the members online.
+     * @type {number}
+     */
+    this.presenceCount = data.presence_count;
+  }
+
+  /**
+   * Update the Widget.
+   * @returns {Promise<Widget>}
+   */
+  async fetch() {
+    const data = await this.client.api.guilds(this.id, 'widget.json').get();
+    if (data.code) throw new Error('WIDGET_DISABLED');
+    this._patch(data);
+    return this;
+  }
+}
+
+module.exports = Widget;

typings/index.d.ts

@@ -2029,6 +2029,17 @@ declare module 'discord.js' {
     public once(event: string, listener: (...args: any[]) => void): this;
   }
 
+  export class Widget extends Base {
+    constructor(client: Client, data: object);
+    private _patch(data: object): void;
+    public fetch(): Promise<Widget>;
+    public id: string;
+    public instant_invite: string | null;
+    public channels: Collection<string, WidgetChannel>;
+    public members: Collection<string, WidgetMember>;
+    public presence_count: number;
+  }
+
   //#endregion
 
   //#region Collections
@@ -3661,6 +3672,30 @@ declare module 'discord.js' {
     $device?: string;
   }
 
+  interface WidgetMember {
+    id: string;
+    username: string;
+    discriminator: string;
+    avatar: null;
+    status: PresenceStatus;
+    deaf?: boolean;
+    mute?: boolean;
+    self_deaf?: boolean;
+    self_mute?: boolean;
+    suppress?: boolean;
+    channel_id?: string;
+    avatar_url: string;
+    activity?: {
+      name: string;
+    };
+  }
+
+  interface WidgetChannel {
+    id: string;
+    name: string;
+    position: number;
+  }
+
   type WSEventType =
     | 'READY'
     | 'RESUMED'