hypixel-api-reborn 11.3.5 → 12.0.0-1

package/src/structures/SkyBlock/Auctions/Auction.js

@@ -1,106 +0,0 @@
-const BaseAuction = require('./BaseAuction');
-const Bid = require('./Bid');
-/**
- * Auction class
- */
-class Auction extends BaseAuction {
-  /**
-   * @param {object} data
-   * @param {boolean} includeItemBytes
-   */
-  constructor(data, includeItemBytes) {
-    super(data, includeItemBytes);
-    /**
-     * Coop members. Array of UUIDs
-     * @type {string[]}
-     */
-    this.coop = data.coop || [];
-    /**
-     * Auction start timestamp
-     * @type {number|null}
-     */
-    this.auctionStartTimestamp = data.start || null;
-    /**
-     * Auction start timestamp as Date
-     * @type {Date}
-     */
-    this.auctionStart = data.start ? new Date(data.start) : null;
-    /**
-     * Auction end timestamp as Date
-     * @type {Date}
-     */
-    this.auctionEnd = data.end ? new Date(data.end) : null;
-    /**
-     * Auction end timestamp as timestamp
-     * @type {number}
-     */
-    this.auctionEndTimestamp = data.end || null;
-    /**
-     * Auction Item Name
-     * @type {string}
-     */
-    this.item = data.item_name || null;
-    /**
-     * Auction Item lore ( plain text )
-     * @type {string}
-     */
-    this.itemLore = data.item_lore ? data.item_lore.replace(/§([1-9]|[a-l])|§/gm, '') : null;
-    /**
-     * Auctipn Item Lore as it is from the API
-     * @type {string}
-     */
-    this.itemLoreRaw = data.item_lore || null;
-    /**
-     * Rarity of Item
-     * @type {Rarity}
-     */
-    this.rarity = data.tier || null;
-    /**
-     * Auction starting bid, or price for BIN
-     * @type {number}
-     */
-    this.startingBid = data.starting_bid || 0;
-    /**
-     * Auction's highest bid, if it is bidded or price for BIN
-     * @type {number}
-     */
-    this.highestBid = this.bin ? data.starting_bid : data.highest_bid_amount || 0;
-    /**
-     * Auction bids
-     * @type {Bid[]}
-     */
-    this.bids = data.bids.length ? data.bids.map((b) => new Bid(b)) : [];
-    /**
-     * is Auction Claimed
-     * @type {boolean}
-     */
-    this.claimed = data.claimed || false;
-    /**
-     * Which bidders, if any, claimed
-     * @type {string[]}
-     */
-    this.claimedBidders = this.claimed ? data.claimed_bidders : [];
-  }
-  /**
-   * Item Name
-   * @return {string}
-   */
-  toString() {
-    return this.item;
-  }
-}
-
-/**
- * @typedef {string} Rarity
- * * `VERY_SPECIAL`
- * * `SPECIAL`
- * * `SUPREME`
- * * `MYTHIC`
- * * `LEGENDARY`
- * * `EPIC`
- * * `RARE`
- * * `UNCOMMON`
- * * `COMMON`
- */
-
-module.exports = Auction;

package/src/structures/SkyBlock/Auctions/AuctionInfo.js

@@ -1,56 +0,0 @@
-/**
- * Auction info class
- */
-class AuctionInfo {
-  /**
-   * @param {object} data Auction info data
-   */
-  constructor(data) {
-    /**
-     * Page number
-     * @type {number}
-     */
-    this.page = parseInt(data.page, 10) || 0;
-    /**
-     * Total pages
-     * @type {number}
-     */
-    this.totalPages = parseInt(data.totalPages, 10) || 1;
-    /**
-     * Total auctions
-     * @type {number}
-     */
-    this.totalAuctions = parseInt(data.totalAuctions, 10) || 0;
-    /**
-     * Last updated timestamp
-     * @type {number}
-     */
-    this.lastUpdatedTimestamp = data.lastUpdated;
-    /**
-     * Last updated timestamp as Date
-     * @type {Date}
-     */
-    this.lastUpdatedAt = new Date(data.lastUpdated);
-    /**
-     * Age
-     * @type {number}
-     */
-
-    // eslint-disable-next-line no-underscore-dangle
-    this.age = parseInt(data._headers.get('age'), 10) || 0;
-  }
-
-  _extend(name, value) {
-    this[name] = value;
-    return this;
-  }
-  /**
-   * Current Page / Total Page
-   * @return {string}
-   */
-  toString() {
-    return `${this.page} / ${this.totalPages}`;
-  }
-}
-
-module.exports = AuctionInfo;

package/src/structures/SkyBlock/Auctions/BaseAuction.js

@@ -1,46 +0,0 @@
-const ItemBytes = require('../../ItemBytes');
-/**
- * Base auction class
- */
-class BaseAuction {
-  /**
-   * @param {object} data Base auction data
-   * @param {boolean} includeItemBytes
-   */
-  constructor(data, includeItemBytes) {
-    /**
-     * Auction ID
-     * @type {string|null}
-     */
-    this.auctionId = data.uuid || data.auction_id || null;
-    /**
-     * Auctioneer UUID
-     * @type {string|null}
-     */
-    this.auctioneerUuid = data.auctioneer || data.seller || null;
-    /**
-     * Auctioneer's skyblock profile ID
-     * @type {string|null}
-     */
-    this.auctioneerProfile = data.profile_id || data.seller_profile || null;
-    /**
-     * Bin
-     * @type {boolean}
-     */
-    this.bin = data.bin || false;
-    /**
-     * Item bytes
-     * @type {ItemBytes|null}
-     */
-    this.itemBytes = includeItemBytes ? new ItemBytes(data.item_bytes) : null;
-  }
-  /**
-   * Auction ID
-   * @return {string}
-   */
-  toString() {
-    return this.auctionId;
-  }
-}
-
-module.exports = BaseAuction;

package/src/structures/SkyBlock/Auctions/Bid.js

@@ -1,49 +0,0 @@
-/**
- * Bid class
- */
-class Bid {
-  /**
-   * @param {object} data Bid data
-   */
-  constructor(data) {
-    /**
-     * Auction ID
-     * @type {string|null}
-     */
-    this.auctionId = data.auction_id || null;
-    /**
-     * Skyblock profile ID
-     * @type {string|null}
-     */
-    this.profileId = data.profile_id || null;
-    /**
-     * Amount
-     * @type {number}
-     */
-    this.amount = data.amount || 0;
-    /**
-     * Auction timestamp
-     * @type {number}
-     */
-    this.timestamp = data.timestamp || null;
-    /**
-     * Auction timestamp as Date
-     * @type {Date}
-     */
-    this.at = data.timestamp ? new Date(data.timestamp) : null;
-    /**
-     * Bidder
-     * @type {string}
-     */
-    this.bidder = data.bidder || null;
-  }
-  /**
-   * Bidder Name - Bid Amount
-   * @return {string}
-   */
-  toString() {
-    return `${this.bidder} bid ${this.amount} coins`;
-  }
-}
-
-module.exports = Bid;

package/src/structures/SkyBlock/Auctions/PartialAuction.js

@@ -1,26 +0,0 @@
-const BaseAuction = require('./BaseAuction');
-/**
- * Partial auction class
- * @extends {BaseAuction}
- */
-class PartialAuction extends BaseAuction {
-  /**
-   * @param {object} data Partial auction data
-   * @param {boolean} includeItemBytes
-   */
-  constructor(data, includeItemBytes) {
-    super(data, includeItemBytes);
-    /**
-     * Buyer UUID
-     * @type {string}
-     */
-    this.buyer = data.buyer || null;
-    /**
-     * Price
-     * @type {number}
-     */
-    this.price = parseInt(data.price, 10) || 0;
-  }
-}
-
-module.exports = PartialAuction;

package/src/structures/SkyBlock/Bazzar/Order.js

@@ -1,38 +0,0 @@
-/**
- * Order class
- */
-class Order {
-  /**
-   * @param {object} data Order data
-   */
-  constructor(data) {
-    /**
-     * Amount
-     * @type {number}
-     */
-    this.amount = data.amount || 0;
-    /**
-     * Price per unit
-     * @type {number}
-     */
-    this.pricePerUnit = data.pricePerUnit || 0;
-    /**
-     * Total price
-     * @type {number}
-     */
-    this.totalPrice = Math.round(this.amount * this.pricePerUnit * 10) / 10;
-    /**
-     * Orders
-     * @type {number}
-     */
-    this.orders = data.orders || 0;
-  }
-  /**
-   * Price as string
-   * @return {string}
-   */
-  toString() {
-    return this.totalPrice;
-  }
-}
-module.exports = Order;

package/src/structures/SkyBlock/Bazzar/Product.js

@@ -1,53 +0,0 @@
-const Order = require('./Order');
-
-/**
- * Product class
- */
-class Product {
-  /**
-   * @param {object} data Product data
-   */
-  constructor(data) {
-    /**
-     * Product ID
-     * @type {string}
-     */
-    this.productId = data.product_id;
-    /**
-     * Product sell orders
-     * @type {Order[]}
-     */
-    this.sellSummary = data.sell_summary.length ? data.sell_summary.map((sellOrder) => new Order(sellOrder)) : [];
-    /**
-     * Product buy orders
-     * @type {Order[]}
-     */
-    this.buySummary = data.buy_summary.length ? data.buy_summary.map((buyOrder) => new Order(buyOrder)) : [];
-    /**
-     * Product status
-     * @type {ProductStatus}
-     */
-    this.status = {
-      sellPrice: isNaN(data.quick_status.sellPrice) ? 0 : Math.round(data.quick_status.sellPrice * 100) / 100,
-      buyPrice: isNaN(data.quick_status.buyPrice) ? 0 : Math.round(data.quick_status.buyPrice * 100) / 100,
-      sellVolume: isNaN(data.quick_status.sellVolume) ? 0 : data.quick_status.sellVolume,
-      buyVolume: isNaN(data.quick_status.buyVolume) ? 0 : data.quick_status.buyVolume,
-      sellMovingWeek: isNaN(data.quick_status.sellMovingWeek) ? 0 : data.quick_status.sellMovingWeek,
-      buyMovingWeek: isNaN(data.quick_status.buyMovingWeek) ? 0 : data.quick_status.buyMovingWeek,
-      sellOrders: isNaN(data.quick_status.sellOrders) ? 0 : data.quick_status.sellOrders,
-      buyOrders: isNaN(data.quick_status.buyOrders) ? 0 : data.quick_status.buyOrders
-    };
-  }
-}
-/**
- * @typedef {object} ProductStatus
- * @property {number} sellPrice Sell price
- * @property {number} buyPrice Buy price
- * @property {number} sellVolume Sell volume
- * @property {number} buyVolume Buy volume
- * @property {number} sellMovingWeek Sell moving week
- * @property {number} buyMovingWeek Sell moving week
- * @property {number} sellOrders Sell orders
- * @property {number} buyOrders Buy orders
- */
-module.exports = Product;

package/src/structures/SkyBlock/News/SkyblockNews.js

@@ -1,60 +0,0 @@
-const dateRegExp = /(\d{1,2})(?:st|nd|rd|th|) ([A-Za-z]+) (\d+)/;
-const versionRegExp = /v\d+(\.\d+){1,}/;
-
-// eslint-disable-next-line jsdoc/require-jsdoc
-function parseDate(stringDate) {
-  const matched = stringDate.match(dateRegExp);
-  if (!matched) return null;
-  return new Date(matched.slice(1).join(' '));
-}
-
-// eslint-disable-next-line jsdoc/require-jsdoc
-function parseVer(stringVer) {
-  const matches = versionRegExp.exec(stringVer);
-  if (!matches?.length) return null;
-  return matches[0];
-}
-/**
- * SkyblockNews
- */
-class SkyblockNews {
-  /**
-   * @param {object} data
-   */
-  constructor(data) {
-    /**
-     * Title
-     * @type {string}
-     */
-    this.title = data.title;
-    /**
-     * Thread
-     * @type {string}
-     */
-    this.link = data.link;
-    /**
-     * Raw Date from the API Response
-     * @type {string}
-     */
-    this.rawDate = data.text;
-    /**
-     * Parsed Date
-     * @type {Date}
-     */
-    this.date = parseDate(data.text);
-    /**
-     * The version from the title (Skyblock v0.12.57673856757.327.2 => v0.12.57673856757.327.2)
-     * @author linearaccelerator
-     * @type {string | null}
-     */
-    this.version = parseVer(this.title);
-  }
-  /**
-   * News title
-   * @return {string}
-   */
-  toString() {
-    return this.title;
-  }
-}
-module.exports = SkyblockNews;

package/src/structures/SkyBlock/PlayerBingo.js

@@ -1,49 +0,0 @@
-const { populateGoals } = require('../../utils/SkyblockUtils');
-// eslint-disable-next-line no-unused-vars
-const BingoDataType = require('./Static/BingoData.js');
-// eslint-disable-next-line no-unused-vars
-const BingoType = require('./Static/Bingo.js');
-/**
- * @typedef {BingoDataType} BingoData
- * @typedef {BingoType} Bingo
- */
-
-/**
- * Player Bingo Class
- */
-class PlayerBingo {
-  /**
-   * Constructor
-   * @param {Object} data data
-   * @param {BingoData|null} bingoData bingo data
-   */
-  constructor(data, bingoData) {
-    const events = data.success && Array.isArray(data.events) ? data.events : [];
-    /**
-     * Data per event
-     * @type {PlayerBingoDataPerEvent}
-     */
-    this.dataPerEvent = events.map((eventData) => {
-      let doneGoals = eventData.completed_goals;
-      if (!Array.isArray(doneGoals)) doneGoals = [];
-      const enrichable = parseInt(eventData.key, 10) === bingoData?.id;
-      if (enrichable) doneGoals = populateGoals(doneGoals, bingoData.goals);
-      return {
-        eventId: parseInt(eventData.key, 10) || null,
-        points: parseInt(eventData.points, 10) || 0,
-        goalsCompleted: doneGoals,
-        enrichedGoals: enrichable
-      };
-    });
-  }
-}
-
-/**
- * @typedef {Object} PlayerBingoDataPerEvent
- * @property {number} eventId ID of event
- * @property {number} points Points acquired
- * @property {boolean} enrichedGoals Whether the goals are enriched (populated with data from static skyblock bingp data)
- * @property {Bingo[]|string[]} goalsCompleted Special Bingo Array if enrichedGoals is true. You can however always treat SpecialBingoArray as string[]
- */
-
-module.exports = PlayerBingo;

package/src/structures/SkyBlock/SkyblockGarden.js

@@ -1,146 +0,0 @@
-const { getLevelByXp } = require('../../utils/SkyblockUtils');
-
-/**
- * Skyblock Garden class
- */
-class SkyblockGarden {
-  /**
-   * @param {object} data Skyblock member data
-   */
-  constructor(data) {
-    /**
-     * level
-     * @type {SkyblockSkillLevel}
-     */
-    this.level = getLevelByXp(data?.garden?.garden_experience || 0, 'garden');
-    /**
-     * Current Barn Skin
-     * @type {string}
-     */
-    this.barnSkin = data?.garden?.selected_barn_skin || '';
-    /**
-     * Unlocked Plots
-     * @type {string[]}
-     */
-    this.unlockedPlots = data?.garden?.unlocked_plots_ids || [];
-    /**
-     * Visitor Stats
-     * @type {SkyblockGardenVisitor}
-     */
-    this.visitors = {
-      visited: data?.garden?.commission_data?.visits || {},
-      completed: data?.garden?.commission_data?.completed || {},
-      served: {
-        total: data?.garden?.commission_data?.total_completed || 0,
-        unique: data?.garden?.commission_data?.unique_npcs_served || 0
-      }
-    };
-    /**
-     * Crop Milestones
-     * @type {SkyblockGarenCropMilestones}
-     */
-    this.cropMilestones = {
-      wheat: getLevelByXp(data?.garden?.resources_collected?.WHEAT || 0, 'wheat'),
-      carrot: getLevelByXp(data?.garden?.resources_collected?.CARROT_ITEM || 0, 'carrot'),
-      sugarCane: getLevelByXp(data?.garden?.resources_collected?.SUGAR_CANE || 0, 'sugarCane'),
-      potato: getLevelByXp(data?.garden?.resources_collected?.POTATO_ITEM || 0, 'potato'),
-      pumpkin: getLevelByXp(data?.garden?.resources_collected?.PUMPKIN || 0, 'pumpkin'),
-      melon: getLevelByXp(data?.garden?.resources_collected?.MELON || 0, 'melon'),
-      cactus: getLevelByXp(data?.garden?.resources_collected?.CACTUS || 0, 'cactus'),
-      cocoaBeans: getLevelByXp(data?.garden?.resources_collected?.['INK_SACK:3'] || 0, 'cocoaBeans'),
-      mushroom: getLevelByXp(data?.garden?.resources_collected?.MUSHROOM_COLLECTION || 0, 'mushroom'),
-      netherWart: getLevelByXp(data?.garden?.resources_collected?.NETHER_STALK || 0, 'netherWart')
-    };
-    /**
-     * Composter
-     * @type {SkyblockGardenComposter}
-     */
-    this.composter = {
-      organicMatter: data?.garden?.composter_data?.organic_matter || 0,
-      fuelUnits: data?.garden?.composter_data?.fuel_units || 0,
-      compostUnits: data?.garden?.composter_data?.compost_units || 0,
-      compostItems: data?.garden?.composter_data?.compost_items || 0,
-      conversionTicks: data?.garden?.composter_data?.conversion_ticks || 0,
-      upgrades: {
-        speed: data?.garden?.composter_data?.upgrades?.speed || 0,
-        multiDrop: data?.garden?.composter_data?.upgrades?.multi_drop || 0,
-        fuelCap: data?.garden?.composter_data?.upgrades?.fuel_cap || 0,
-        organicMatterCap: data?.garden?.composter_data?.upgrades?.organic_matter_cap || 0,
-        costReduction: data?.garden?.composter_data?.upgrades?.cost_reduction || 0
-      }
-    };
-    /**
-     * Crop Upgrades
-     * @type {SkyblockGarenCrops}
-     */
-    this.cropUpgrades = {
-      wheat: data?.garden?.crop_upgrade_levels?.WHEAT || 0,
-      carrot: data?.garden?.crop_upgrade_levels?.CARROT_ITEM || 0,
-      sugarCane: data?.garden?.crop_upgrade_levels?.SUGAR_CANE || 0,
-      potato: data?.garden?.crop_upgrade_levels?.POTATO_ITEM || 0,
-      pumpkin: data?.garden?.crop_upgrade_levels?.PUMPKIN || 0,
-      melon: data?.garden?.crop_upgrade_levels?.MELON || 0,
-      cactus: data?.garden?.crop_upgrade_levels?.CACTUS || 0,
-      cocoaBeans: data?.garden?.crop_upgrade_levels?.['INK_SACK:3'] || 0,
-      mushroom: data?.garden?.crop_upgrade_levels?.MUSHROOM_COLLECTION || 0,
-      netherWart: data?.garden?.crop_upgrade_levels?.NETHER_STALK || 0
-    };
-  }
-}
-
-/**
- * @typedef {object} SkyblockGardenVisitor
- * @property {Record<string, number>} visited Visited
- * @property {Record<string, number>} completed Completed
- * @property {SkyblockGardenVisitorServed} served served
- */
-/**
- * @typedef {object} SkyblockGardenVisitorServed
- * @property {number} total total
- * @property {number} unique unique
- */
-/**
- * @typedef {object} SkyblockGardenComposter
- * @property {number} organicMatter Organic Matter
- * @property {number} fuelUnits Fuel Units
- * @property {number} compostUnits Compost Units
- * @property {number} compostItems Compost Items
- * @property {number} conversionTicks Conversion Ticks
- * @property {SkyblockGardenComposterUpgrades} upgrades upgrades
- */
-/**
- * @typedef {object} SkyblockGardenComposterUpgrades
- * @property {number} speed Speed
- * @property {number} multiDrop Multi Drop
- * @property {number} fuelCap Fuel Cap
- * @property {number} organicMatterCap Organic Matter Cap
- * @property {number} costReduction Cost Reduction
- */
-/**
- * @typedef {object} SkyblockGarenCrops
- * @property {number} wheat Wheat
- * @property {number} carrot Carrot
- * @property {number} sugarCane Sugar Cane
- * @property {number} potato Potato
- * @property {number} pumpkin Pumpkin
- * @property {number} melon Melon
- * @property {number} cactus Cactus
- * @property {number} cocoaBeans Cocoa Beans
- * @property {number} mushroom Mushroom
- * @property {number} netherWart Nether Wart
- */
-/**
- * @typedef {object} SkyblockGarenCropMilestones
- * @property {SkyblockSkillLevel} wheat Wheat
- * @property {SkyblockSkillLevel} carrot Carrot
- * @property {SkyblockSkillLevel} sugarCane Sugar Cane
- * @property {SkyblockSkillLevel} potato Potato
- * @property {SkyblockSkillLevel} pumpkin Pumpkin
- * @property {SkyblockSkillLevel} melon Melon
- * @property {SkyblockSkillLevel} cactus Cactus
- * @property {SkyblockSkillLevel} cocoaBeans Cocoa Beans
- * @property {SkyblockSkillLevel} mushroom Mushroom
- * @property {SkyblockSkillLevel} netherWart Nether Wart
- */
-
-module.exports = SkyblockGarden;