tiny-essentials/dist/legacy/firebase/discord/api/getGuildWidget.cjs

Collection of small, essential scripts designed to be used across various projects. These simple utilities are crafted for speed, ease of use, and versatility.

'use strict';

var json = require('../../../http/fetch/json.cjs');
var config = require('../config.cjs');
var errorValidator = require('../get/errorValidator.cjs');

// @ts-nocheck


/**
 * Fetches the public widget data for a Discord guild (server).
 * This includes online members, presence counts, and basic guild information,
 * but only if the widget is enabled in the server settings.
 *
 * @param {string} guildID - The ID of the guild whose widget is to be fetched.
 *
 * @returns {Promise<Record<string, any>>} Resolves with the guild widget data if successful.
 *
 * @throws {Record<string, any>} If the request fails or the widget is disabled, rejects with an object containing a `code` and `message`.
 *
 * @example
 * getGuildWidget('123456789012345678')
 *   .then((data) => console.log(data))
 *   .catch((err) => console.error('Widget error:', err));
 */
function getGuildWidget(guildID) {
  return new Promise(function (resolve, reject) {
    // API URL
    const apiURL = config.url;

    // Response
    json(`${apiURL}guilds/${encodeURIComponent(guildID)}/widget.json`, {
      method: 'GET',
      headers: {
        'Content-Type': 'application/json',
      },
    })
      .then((data) => {
        // Error Validator
        const result = errorValidator(data);
        if (!result.error) resolve(result.data);
        else reject(result.error);
      })
      .catch((err) => {
        reject({ code: err.response.status, message: err.message });
      });
  });
}

module.exports = getGuildWidget;