hypixel-api-reborn 11.3.5 → 12.0.0-0

package/src/structures/Guild/Guild.js

@@ -1,191 +0,0 @@
-const { getGuildLevel, ranks, calculateExpHistory } = require('../../utils/Guild');
-const GuildMember = require('./GuildMember');
-const GuildRank = require('./GuildRank');
-const Color = require('../Color');
-const Game = require('../Game');
-
-// eslint-disable-next-line jsdoc/require-jsdoc
-function members(data) {
-  return data.members.length ? data.members.map((m) => new GuildMember(m)) : [];
-}
-
-// eslint-disable-next-line jsdoc/require-jsdoc
-function totalWeeklyGexp(data) {
-  return members(data)
-    .map((m) => m.weeklyExperience)
-    .reduce((acc, cur) => acc + cur);
-}
-
-/**
- * Guild class
- */
-class Guild {
-  /**
-   * @param {data} data Guild data
-   * @param {string} [me] Player uuid u#sed to search for this guild
-   */
-  constructor(data, me = '') {
-    /**
-     * Guild ID
-     * @type {string}
-     */
-
-    // eslint-disable-next-line no-underscore-dangle
-    this.id = data._id;
-    /**
-     * Guild name
-     * @type {string}
-     */
-    this.name = data.name;
-    /**
-     * Guild description
-     * @type {string}
-     */
-    this.description = data.description ?? '';
-    /**
-     * Guild experience
-     * @type {number}
-     */
-    this.experience = data.exp || 0;
-    /**
-     * Guild level
-     * @type {number}
-     */
-    this.level = getGuildLevel(this.experience);
-    /**
-     * Guild members
-     * @type {Array<GuildMember>}
-     */
-    this.members = members(data);
-    /**
-     * Me, if a player UUID is used to get the guild
-     * @type {GuildMember|null}
-     */
-    this.me = this.members.find((member) => member.uuid === me);
-    /**
-     * Guild ranks
-     * @type {Array<GuildRank>}
-     */
-    this.ranks = ranks(data);
-    /**
-     * The total guild experience earned in the last 7 days
-     * @author linearaccelerator
-     * @type {number}
-     */
-    this.totalWeeklyGexp = totalWeeklyGexp(data);
-    /**
-     * An array containing all guild ranks sorted by newest
-     * @author linearaccelerator
-     * @return {Array<GuildRank>}
-     */
-    this.getRanksByNewest = function () {
-      return this.ranks.length
-        ? this.ranks.map((r) => new GuildRank(r)).sort((a, b) => b.createdAt - a.createdAt)
-        : null;
-    };
-    /**
-     * A map containing all guild members, keyed by their uuids
-     * @author linearaccelerator
-     * @return {Map<string, GuildMember>}
-     */
-    this.getMemberUUIDMap = function () {
-      return this.members.length ? new Map(this.members.map((m) => [m.uuid, m])) : null;
-    };
-    /**
-     * Returns a guild rank by priority
-     * @author linearaccelerator
-     * @param {number} priority - The priority of the guild rank
-     * @return {GuildRank}
-     */
-    this.getRankByPriority = function (priority) {
-      if (!this.ranks.length || !this.ranks.some((r) => r.priority === priority)) return null;
-      return new GuildRank(this.ranks.find((r) => r.priority === priority));
-    };
-    /**
-     * Date of guild creation as timestamp
-     * @type {string}
-     */
-    this.createdAtTimestamp = data.created;
-    /**
-     * Date of guild creation
-     * @type {Date}
-     */
-    this.createdAt = new Date(data.created);
-    /**
-     * Whether this guild can be joined using /g join
-     * @type {boolean}
-     */
-    this.joinable = data.joinable ?? false;
-    /**
-     * Whether this guild is listed in the Guild Finder
-     * @type {boolean}
-     */
-    this.publiclyListed = Boolean(data.publiclyListed);
-    /**
-     * Timestamp guild chat will be unmuted at.
-     * @type {number|null}
-     */
-    this.chatMuteUntilTimestamp = data.chatMute ?? null;
-    /**
-     * Timestamp guild chat will be unmuted at as Date.
-     * @type {Date|null}
-     */
-    this.chatMuteUntil = data.chatMute ? new Date(data.chatMute) : null;
-    /**
-     * Timestamp guild chat will be unmuted at.
-     * @type {Array<{ Pattern: string, Color: string }>}
-     */
-    this.banner = data.banner ?? null;
-    /**
-     * Guild tag
-     * @type {string}
-     */
-    this.tag = data.tag ?? null;
-    /**
-     * Guild tag color
-     * @type {Color}
-     */
-    this.tagColor = data.tagColor ? new Color(data.tagColor) : null;
-    /**
-     * Ranking in the number of guild coins owned in the legacy guild system. (0 - indexed)
-     * @deprecated
-     * @type {number}
-     */
-    this.legacyRank = !isNaN(data.legacyRanking) ? parseInt(data.legacyRanking + 1, 10) : 0;
-    /**
-     * Experience history per day, resets at 5 am UTC. Please remember this is only an estimation based on the sum of every guild member's daily gexp.
-     * @type {Array<ExpHistory>}
-     */
-    this.expHistory = calculateExpHistory(data);
-    /**
-     * Guild achievements
-     * @type {{winners: number, experienceKings: number, onlinePlayers: number}}
-     */
-    this.achievements = {
-      winners: data.achievements.WINNERS ?? 0,
-      experienceKings: data.achievements.EXPERIENCE_KINGS ?? 0,
-      onlinePlayers: data.achievements.ONLINE_PLAYERS ?? 0
-    };
-    /**
-     * Guild preferred games
-     * @type {Array<Game>}
-     */
-    this.preferredGames = data.preferredGames ? data.preferredGames.map((g) => new Game(g)) : [];
-  }
-  /**
-   * Guild name
-   * @return {string}
-   */
-  toString() {
-    return this.name;
-  }
-  /**
-   * The Guild Master of the guild as a GuildMember
-   * @type {GuildMember}
-   */
-  get guildMaster() {
-    return this.members.find((member) => 'Guild Master' === member.rank || 'GUILDMASTER' === member.rank);
-  }
-}
-
-module.exports = Guild;

package/src/structures/Guild/GuildMember.js

@@ -1,66 +0,0 @@
-const { parseHistory } = require('../../utils/Guild');
-/**
- * GuildMember class
- */
-class GuildMember {
-  /**
-   * @param {data} data Guild member data
-   */
-  constructor(data) {
-    /**
-     * Guild member UUID
-     * @type {string}
-     */
-    this.uuid = data.uuid;
-    /**
-     * Timestamp this member joined at
-     * @type {number}
-     */
-    this.joinedAtTimestamp = data.joined;
-    /**
-     * Timestamp this member joined at as Date
-     * @type {Date}
-     */
-    this.joinedAt = new Date(data.joined);
-    /**
-     * The number of challenges completed that count towards the current quest
-     * @type {number}
-     */
-    this.questParticipation = data.questParticipation || 0;
-    /**
-     * Member's rank
-     * @type {string}
-     */
-    this.rank = data.rank;
-    /**
-     * Timestamp this member will be unmuted at ( if muted )
-     * @type {Number|null}
-     */
-    this.mutedUntilTimestamp = data.mutedTill ?? null;
-    /**
-     * Timestamp this member will be unmuted at as Date ( if muted )
-     * @type {Date|null}
-     */
-    this.mutedUntil = data.mutedTill ? new Date(data.mutedTill) : null;
-    const xpCheck = data.expHistory && 'number' === typeof Object.values(data.expHistory)[0];
-    /**
-     * Experience history per day, resets at 5 am UTC
-     * @type {Array<ExpHistory>}
-     */
-    this.expHistory = parseHistory(data.expHistory);
-    /**
-     * Experience per week, resets every Monday at 5 am UTC
-     * @type {number}
-     */
-    this.weeklyExperience = xpCheck ? Object.values(data.expHistory).reduce((pV, cV) => pV + cV, 0) : null;
-  }
-  /**
-   * UUID
-   * @return {string}
-   */
-  toString() {
-    return this.uuid;
-  }
-}
-
-module.exports = GuildMember;

package/src/structures/Guild/GuildRank.js

@@ -1,48 +0,0 @@
-/**
- * GuildRank class
- */
-class GuildRank {
-  /**
-   * @param {data} data Guild rank data
-   */
-  constructor(data) {
-    /**
-     * Guild rank name
-     * @type {string}
-     */
-    this.name = data.name;
-    /**
-     * Whether this rank is the default rank a player gets when they join a guild
-     * @type {boolean}
-     */
-    this.default = data.default;
-    /**
-     * Guild rank tag that appears in guild chat. null if none
-     * @type {string|null}
-     */
-    this.tag = data.tag ?? null;
-    /**
-     * Timestamp this rank was created at
-     * @type {number}
-     */
-    this.createdAtTimestamp = data.created ? data.created : data.createdAtTimestamp;
-    /**
-     * Timestamp this rank was created at as Date
-     * @type {Date}
-     */
-    this.createdAt = new Date(data.created ? data.created : data.createdAtTimestamp);
-    /**
-     * Guild rank priority - Higher number = higher up in the hierarchy
-     * @type {number}
-     */
-    this.priority = data.priority;
-  }
-  /**
-   * Rank Name
-   * @return {string}
-   */
-  toString() {
-    return this.name;
-  }
-}
-module.exports = GuildRank;

package/src/structures/House.js

@@ -1,54 +0,0 @@
-/**
- * House class
- */
-class House {
-  /**
-   * @param {object} data data
-   */
-  constructor(data) {
-    /**
-     * Name of the house
-     * @type {string}
-     */
-    this.name = data.name || '';
-    /**
-     * UUID of the house
-     * @type {string}
-     */
-    this.uuid = data.uuid || '';
-    /**
-     * UUID of the house owner
-     * @type {string}
-     */
-    this.owner = data.owner || '';
-    /**
-     * Timestamp when the house was created
-     * @type {number}
-     */
-    this.createdAtTimestamp = data.createdAt || 0;
-    /**
-     * Date when the house was created
-     * @type {Date|null}
-     */
-    this.createdAt = new Date(this.createdAtTimestamp);
-    /**
-     * Number of players currently at the house
-     * @type {number}
-     */
-    this.players = data.players || 0;
-    /**
-     * Number of cookies the house has
-     * @type {number}
-     */
-    this.cookies = data.cookies?.current || 0;
-  }
-  /**
-   * House Nmae
-   * @return {string}
-   */
-  toString() {
-    return this.name;
-  }
-}
-
-module.exports = House;

package/src/structures/ItemBytes.js

@@ -1,33 +0,0 @@
-const { decode } = require('../utils/SkyblockUtils');
-/**
- * Item Bytes class
- */
-class ItemBytes {
-  /**
-   * @param {string} data base64 encoded bytes
-   */
-  constructor(data) {
-    /**
-     *  Item Bytes as Buffer
-     * @type {Buffer}
-     */
-    this.bytesBuffer = Buffer.from(data, 'base64');
-  }
-
-  /**
-   * Returns Item Bytes in base64 encoded
-   * @return {String}
-   */
-  base64() {
-    return this.bytesBuffer.toString('base64');
-  }
-
-  /**
-   * Returns NBT of Item Bytes
-   * @return {any[]}
-   */
-  async readNBT() {
-    return await decode(this.bytesBuffer, true);
-  }
-}
-module.exports = ItemBytes;

package/src/structures/Leaderboard.js

@@ -1,31 +0,0 @@
-/**
- * Leaderboard class
- */
-class Leaderboard {
-  /**
-   * @param {object} data Leaderboard data
-   */
-  constructor(data) {
-    /**
-     * Leaderboard name
-     * @type {string|null}
-     */
-    this.name = data.prefix || null;
-    /**
-     * Leaderboard title
-     * @type {string}
-     */
-    this.title = data.title || null;
-    /**
-     * Leaderboard player count
-     * @type {string}
-     */
-    this.playerCount = data.count || 0;
-    /**
-     * Leaderboard leaders. Array of Player UUIDs
-     * @type {string[]}
-     */
-    this.leaders = data.leaders || [];
-  }
-}
-module.exports = Leaderboard;