hypixel-api-reborn 11.1.0 → 11.2.1

package/src/structures/Static/Achievements.js

@@ -0,0 +1,30 @@
+const GameAchievements = require('./GameAchievements.js');
+
+/**
+ * Achievement class
+ */
+class Achievements {
+  /**
+   * @param {object} data data
+   */
+  constructor(data) {
+    /**
+     * Last time this resource was updated
+     * @type {number}
+     */
+    this.lastUpdatedTimestamp = parseInt(data.lastUpdated, 10);
+    /**
+     * Last time this resource was updated, as Date
+     * @type {Date|null}
+     */
+    this.lastUpdatedAt = new Date(this.lastUpdatedTimestamp);
+    /**
+     * @type {Record<StaticGameNames, GameAchievements>}
+     */
+    this.achievementsPerGame = Object.fromEntries(
+      Object.entries(data.achievements).map(([game, data]) => [game, new GameAchievements(game, data)])
+    );
+  }
+}
+
+module.exports = Achievements;

package/src/structures/Static/Challenges.js

@@ -0,0 +1,29 @@
+const GameChallenges = require('./GameChallenges.js');
+/**
+ * Achievement class
+ */
+class Challenges {
+  /**
+   * @param {object} data data
+   */
+  constructor(data) {
+    /**
+     * Last time this resource was updated
+     * @type {number}
+     */
+    this.lastUpdatedTimestamp = parseInt(data.lastUpdated, 10);
+    /**
+     * Last time this resource was updated, as Date
+     * @type {Date|null}
+     */
+    this.lastUpdatedAt = new Date(this.lastUpdatedTimestamp);
+    /**
+     * @type {Record<StaticGameNames, GameChallenges>}
+     */
+    this.challengesPerGame = Object.fromEntries(
+      Object.entries(data.challenges).map(([game, data]) => [game, new GameChallenges(game, data)])
+    );
+  }
+}
+
+module.exports = Challenges;

package/src/structures/Static/GameAchievements.js

@@ -0,0 +1,36 @@
+const Achievement = require('./Achievement');
+
+/**
+ * Game achievements class
+ */
+class GameAchievements {
+  /**
+   * @param {string} name game name
+   * @param {object} data data
+   */
+  constructor(name, data) {
+    /**
+     * Name of game/category
+     * @type {StaticGameNames}
+     */
+    this.category = name;
+    /**
+     * Total points possible from all achievements in this game
+     * @type {number}
+     */
+    this.totalPoints = parseInt(data.total_points, 10) || 0;
+    /**
+     * Total legacy points possible from all achievements in this game
+     * @type {number}
+     */
+    this.totalLegacyPoints = parseInt(data.total_legacy_points, 10) || 0;
+    /**
+     * @type {Achievement[]}
+     */
+    this.achievements = Object.entries({ ...(data.one_time || {}), ...(data.tiered || {}) }).map(
+      ([name, data]) => new Achievement(name, data)
+    );
+  }
+}
+
+module.exports = GameAchievements;

package/src/structures/Static/GameChallenges.js

@@ -0,0 +1,40 @@
+/**
+ * Game challenges class
+ */
+class GameChallenges {
+  /**
+   * @param {string} name game name
+   * @param {object} data data
+   */
+  constructor(name, data) {
+    /**
+     * Name of game/category
+     * @type {StaticGameNames}
+     */
+    this.category = name;
+    /**
+     * @type {Map<string, ChallengeData>}
+     */
+    this.challenges = new Map();
+
+    data.forEach((challenge) => {
+      const content = {
+        id: challenge.id,
+        name: challenge.name,
+        reward: parseInt(challenge.rewards[0].amount, 10) || 0,
+        rewardType: challenge.rewards[0].type
+      };
+      this.challenges.set(challenge.id, content);
+    });
+  }
+}
+
+/**
+ * @typedef {Object} ChallengeData
+ * @property {string} id String ID of the challenge
+ * @property {string} name String name of the challenge
+ * @property {number} reward Amount of XP upon challenge completion, always 3700 XP.
+ * @property {string} rewardType Type of reward. Always "MultipliedExperienceReward" here
+ */
+
+module.exports = GameChallenges;

package/src/structures/Static/GameQuests.js

@@ -0,0 +1,24 @@
+const Quest = require('./Quest');
+
+/**
+ * Game quests class
+ */
+class GameQuests {
+  /**
+   * @param {string} name game name
+   * @param {object} data data
+   */
+  constructor(name, data) {
+    /**
+     * Name of game
+     * @type {StaticGameNames}
+     */
+    this.game = name;
+    /**
+     * @type {Quest[]}
+     */
+    this.quests = (data || []).map((x) => new Quest(x));
+  }
+}
+
+module.exports = GameQuests;

package/src/structures/Static/GuildAchievements.js

@@ -0,0 +1,34 @@
+const Achievement = require('./Achievement.js');
+
+/**
+ * Achievement class
+ */
+class GuildAchievements {
+  /**
+   * @param {object} data data
+   */
+  constructor(data) {
+    /**
+     * Last time this resource was updated
+     * @type {number}
+     */
+    this.lastUpdatedTimestamp = parseInt(data.lastUpdated, 10);
+    /**
+     * Last time this resource was updated, as Date
+     * @type {Date|null}
+     */
+    this.lastUpdatedAt = new Date(this.lastUpdatedTimestamp);
+    /**
+     * Achievements
+     * @type {Record<string, Achievement>}
+     */
+    this.achievements = Object.fromEntries(
+      Object.entries({ ...(data.tiered || {}), ...(data.one_time || {}) }).map(([name, value]) => [
+        name,
+        new Achievement(name, value)
+      ])
+    );
+  }
+}
+
+module.exports = GuildAchievements;

package/src/structures/Static/Quest.js

@@ -0,0 +1,66 @@
+/**
+ * Quest Class
+ */
+class Quest {
+  /**
+   * constructor
+   * @param {Object} data
+   */
+  constructor(data) {
+    /**
+     * Name of quest, trimmed trailing spaces
+     * @type {string}
+     */
+    this.questName = data.name.trim();
+    /**
+     * ID of quest
+     * @type {string}
+     */
+    this.questID = data.id;
+    /**
+     * Description, trimmed trailing spaces
+     * @type {string}
+     */
+    this.description = data.description.trim();
+    /**
+     * Type of quest
+     * @type {'DAILY'|'WEEKLY'}
+     */
+    this.type = 'DailyResetQuestRequirement' === data.requirements?.[0].type ? 'DAILY' : 'WEEKLY';
+    /**
+     * Objectives
+     * @type {Objective[]}
+     */
+    this.objectives = data.objectives.map((objective) => ({
+      id: objective.id,
+      type: 'IntegerObjective' === objective.type ? 'Integer' : 'Boolean',
+      amountNeeded: parseInt(objective.integer || '1', 10)
+    }));
+    /**
+     * Rewards for this quest
+     * @type {QuestReward[]}
+     */
+    this.rewards = data.rewards || [];
+  }
+  /**
+   * As string
+   * @return {string}
+   */
+  toString() {
+    return this.questName;
+  }
+}
+
+/**
+ * @typedef {Object} Objective
+ * @property {string} id ID
+ * @property {'Integer'|'Boolean'} type Integer: a certain amount of something (i.e kills) is needed; Boolean: a condition needs to be fulfilled
+ * @property {number} amountNeeded a Boolean-typed objective will have this set to 1. (instead of null in API)
+ */
+/**
+ * @typedef {Object} QuestReward
+ * @property {string} type Types of reward.
+ * @property {number} amount Amount
+ */
+
+module.exports = Quest;

package/src/structures/Static/Quests.js

@@ -0,0 +1,31 @@
+const GameQuests = require('./GameQuests.js');
+
+/**
+ * Quest class
+ */
+class Quests {
+  /**
+   * @param {object} data data
+   */
+  constructor(data) {
+    /**
+     * Last time this resource was updated
+     * @type {number}
+     */
+    this.lastUpdatedTimestamp = parseInt(data.lastUpdated, 10);
+    /**
+     * Last time this resource was updated, as Date
+     * @type {Date|null}
+     */
+    this.lastUpdatedAt = new Date(this.lastUpdatedTimestamp);
+    /**
+     * Quests per game
+     * @type {Record<StaticGameNames, GameQuests>}
+     */
+    this.questsPerGame = Object.fromEntries(
+      Object.entries(data.quests).map(([game, data]) => [game, new GameQuests(game, data)])
+    );
+  }
+}
+
+module.exports = Quests;

package/src/structures/Status.js

@@ -23,12 +23,12 @@ class Status {
      * Game mode
      * @type {string|null}
      */
-    this.mode = data.mode ? data.mode : null;
+    this.mode = data.mode ?? null;
     /**
      * Map
      * @type {string|null}
      */
-    this.map = data.map ? data.map : null;
+    this.map = data.map ?? null;
   }
   /**
    * Online Status