Add Skyblock Government API and related structures

Author: Kathund

src/API/index.js

@@ -10,9 +10,11 @@ module.exports = {
   getStatus: require('./getStatus'),
   getWatchdogStats: require('./getWatchdogStats'),
   getEndedSkyblockAuctions: require('./skyblock/getEndedSkyblockAuctions'),
+
   getSkyblockAuctions: require('./skyblock/getSkyblockAuctions'),
   getSkyblockAuctionsByPlayer: require('./skyblock/getSkyblockAuctionsByPlayer'),
   getSkyblockBazaar: require('./skyblock/getSkyblockBazaar'),
+  getSkyblockGovernment: require('./skyblock/getSkyblockGovernment'),
   getSkyblockMember: require('./skyblock/getSkyblockMember'),
   getSkyblockNews: require('./skyblock/getSkyblockNews'),
   getSkyblockProfiles: require('./skyblock/getSkyblockProfiles')

src/API/skyblock/getSkyblockGovernment.js

@@ -0,0 +1,8 @@
+module.exports = async function () {
+  const GovernmentData = require('../../structures/Skyblock/Static/Government.js');
+
+  const res = await this._makeRequest('/resources/skyblock/election');
+  if (res.raw) return res;
+
+  return new GovernmentData(res);
+};

src/Client.js

@@ -313,6 +313,13 @@ class Client extends EventEmitter {
    * })
    * .catch(console.log);
    */
+  /**
+   * Allows you to get SB government
+   * @method
+   * @name Client#getSkyblockGovernment
+   * @param {MethodOptions} [options={}] Options
+   * @return {Promise<Government>}
+   */
   /**
    * Allows you to get skyblock news
    * @method

src/index.js

@@ -27,6 +27,8 @@ module.exports = {
   SkyblockMember: require('./structures/SkyBlock/SkyblockMember.js'),
   SkyblockInventoryItem: require('./structures/SkyBlock/SkyblockInventoryItem.js'),
   SkyblockPet: require('./structures/SkyBlock/SkyblockPet'),
+  SkyblockGovernment: require('./structures/Skyblock/Static/Government.js'),
+  SkyblockCandidate: require('./structures/Skyblock/Static/Candidate.js'),
 
   /* Skyblock Auctions */
   BaseAuction: require('./structures/SkyBlock/Auctions/BaseAuction.js'),

src/structures/SkyBlock/Static/Candidate.js

@@ -0,0 +1,39 @@
+/**
+ * Candidate class
+ */
+class Candidate {
+  /**
+   * Constructor
+   * @param {Object} data data
+   * @param {boolean} [isMayor=false] if this candidate is the current mayor
+   */
+  constructor(data, isMayor = false) {
+    /**
+     * Mayor's name
+     * @type {string}
+     */
+    this.name = data.name;
+    /**
+     * Mayor's Key Benefit (in 1 word)
+     * @type {string}
+     */
+    this.keyBenefit = data.key;
+    /**
+     * Perks
+     * @type {Record<'name'|'description',string>[]}
+     */
+    this.perks = data.perks;
+    /**
+     * If this candidate is the current mayor
+     * @type {boolean}
+     */
+    this.isMayor = isMayor || false;
+    /**
+     * The number of votes received by this candidate
+     * @type {number}
+     */
+    this.votesReceived = parseInt(data.votes, 10) || 0;
+  }
+}
+
+module.exports = Candidate;

src/structures/SkyBlock/Static/Government.js

@@ -0,0 +1,55 @@
+const Candidate = require('./Candidate');
+
+/**
+ * SB Government Class
+ */
+class GovernmentData {
+  /**
+   * constructor
+   * @param {Object} 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);
+    const lastElectionResults = data.mayor.election.candidates.map((x) => new Candidate(x, x.name === data.mayor.name));
+    /**
+     * A map of last election results for each candidate
+     * Sorted ascendingly by votes received
+     * @type {Map<string, Candidate>}
+     */
+    this.lastElectionResults = new Map(lastElectionResults.sort((a, b) => a.votes - b.votes).map((x) => [x.name, x]));
+    /**
+     * The mayor
+     * @type {Candidate}
+     */
+    this.mayor = this.lastElectionResults.get(data.mayor.name);
+    /**
+     * The year the mayor will be running for
+     * @type {number}
+     */
+    this.runningYear = parseInt(data.mayor.election.year, 10) || 0;
+    const thisElection = data.current.candidates.map((x) => new Candidate(x, x.name === data.mayor.name));
+    /**
+     * Current elections, valid for next year
+     * Sorted ascendingly by votes received
+     * RESULTS MIGHT BE TEMPORARY
+     * @type {Map<string, Candidate>}
+     */
+    this.currentElectionResults = new Map(thisElection.sort((a, b) => a.votes - b.votes).map((x) => [x.name, x]));
+    /**
+     * The year the current election will be effective for
+     * @type {number|null}
+     */
+    this.currentElectionFor = parseInt(data.current.year, 10) || null;
+  }
+}
+
+module.exports = GovernmentData;

tests/Client#getSkyblockGoverment.js

@@ -0,0 +1,19 @@
+/* eslint-disable no-undef */
+const { SkyblockGovernment } = require('../src/');
+const { client } = require('./Client.js');
+const { expect } = require('chai');
+
+describe('Client#getSkyblockMember', async () => {
+  let goverment;
+  describe('Random (1)', async () => {
+    it('expect not to throw', async () => {
+      goverment = await client.getSkyblockGoverment();
+    });
+    it('should be an objecct', () => {
+      expect(goverment).to.be.an('object');
+    });
+    it('required keys should exist', () => {
+      expect(goverment).instanceOf(SkyblockGovernment);
+    });
+  });
+});

typings/index.d.ts

@@ -861,6 +861,10 @@ declare module 'hypixel-api-reborn' {
      * @description Allows you to get list of products
      */
     getSkyblockBazaar(options?: methodOptions): Promise<Product[]>;
+    /**
+     * @description Gets data of skyblock government
+     */
+    getSkyblockGovernment(options?: methodOptions): Promise<GovernmentData>;
     /**
      * @description Allows you to get skyblock news
      */
@@ -1836,6 +1840,25 @@ declare module 'hypixel-api-reborn' {
     totalPrice: number;
     orders: number;
   }
+  class GovernmentData {
+    constructor(data: Record<string, unknown>);
+    lastUpdatedTimestamp: number;
+    lastUpdatedAt: Date | null;
+    lastElectionResults: Map<string, Candidate>;
+    mayor: Candidate;
+    runningYear: number;
+    currentElectionResults: Map<string, Candidate>;
+    currentElectionFor: number | null;
+  }
+  class Candidate {
+    constructor(data: Record<string, unknown>, isMayor?: boolean | undefined);
+    name: string;
+    keyBenefit: string;
+    perks: Record<'name' | 'description', string>[];
+    isMayor: boolean;
+    votesReceived: number;
+    toString(): string;
+  }
   class WatchdogStats {
     constructor(data: Record<string, unknown>);
     byWatchdogTotal: number;