@zikeji/hypixel/src/helpers/SkyWarsLevelInfo.ts

With IntelliSense support & test coverage, this is an unopinionated async/await API wrapper for Hypixel's Public API. It is developed in TypeScript complete with documentation, typed interfaces for all API responses, built-in rate-limit handling, flexible

/**
 * This portion of code was ported from the [hypixel-php](https://github.com/Plancke/hypixel-php) library.
 *
 * Copyright (c) 2021 Zikeji
 * Copyright (c) 2017 Aäron Plancke
 *
 * For the original full copyright and license information, please view the LICENSE-HYPIXEL-PHP.md that was distributed with this source code.
 */

import type { PlayerResponse } from "../types/AugmentedTypes";
import {
  getSkyWarsPrestigeForLevel,
  SkyWarsPrestiges,
  SkyWarsPrestige,
} from "./SkyWarsPrestige";

/** @internal */
const skyWarsLevelConstants = {
  expPerLevel: 10000,
  easyLevelExp: [0, 20, 50, 80, 100, 250, 500, 1000, 1500, 2500, 4000, 5000],
};

/**
 * Interface describing the results from the {@link getSkyWarsLevelInfo} function.
 */
export interface SkyWarsLevelInfo {
  level: number;
  preciseLevel: number;
  currentExp: number;
  expToLevel: number;
  expToNextLevel: number;
  remainingExpToNextLevel: number;
}

/**
 * This interface is returned by {@link getSkyWarsLevelInfo} if you passed true as the second parameter.
 */
export interface SkyWarsLevelInfoAndPrestige extends SkyWarsLevelInfo {
  prestige: SkyWarsPrestige;
  expToPrestige: number;
  nextPrestige?: SkyWarsPrestige;
  expToNextPrestige?: number;
  remainingExpToNextPrestige?: number;
  progressToNextPrestige?: number;
}

/**
 * Returns the total amount of exp it takes to get to a certain level.
 * @param level The level of the player.
 * @category Helper
 */
export function totalExpToSkyWarsLevel(level: number): number {
  let acc = 0;
  const easyLevelCount = Math.min(
    level,
    skyWarsLevelConstants.easyLevelExp.length
  );
  for (let i = 0; i < easyLevelCount; i += 1) {
    acc += skyWarsLevelConstants.easyLevelExp[i];
  }

  return level <= skyWarsLevelConstants.easyLevelExp.length
    ? acc
    : acc +
        (level - skyWarsLevelConstants.easyLevelExp.length) *
          skyWarsLevelConstants.expPerLevel;
}

/**
 * Get SkyWars level information from a player object or raw experience value.
 * @param data A player object or the raw experience value.
 * @param includePrestige Whether or not to return the {@link SkyWarsPrestige} object.
 * @category Helper
 */
export function getSkyWarsLevelInfo(
  data: PlayerResponse["player"] | number
): SkyWarsLevelInfo;
export function getSkyWarsLevelInfo(
  data: PlayerResponse["player"] | number,
  includePrestige: true
): SkyWarsLevelInfoAndPrestige;
export function getSkyWarsLevelInfo(
  data: PlayerResponse["player"] | number,
  includePrestige: false
): SkyWarsLevelInfo;
export function getSkyWarsLevelInfo(
  data: PlayerResponse["player"] | number,
  includePrestige?: boolean
): SkyWarsLevelInfoAndPrestige | SkyWarsLevelInfo {
  const currentExp =
    typeof data === "number"
      ? data
      : (data.stats?.SkyWars?.skywars_experience as number);
  if (typeof currentExp !== "number" || Number.isNaN(currentExp)) {
    throw new TypeError(
      "Data supplied does not contain player SkyWars experience."
    );
  }

  let expAcc = 0;
  let level = -1;
  for (let i = 0; i < skyWarsLevelConstants.easyLevelExp.length; i += 1) {
    const expPerLevel = skyWarsLevelConstants.easyLevelExp[i];
    expAcc += expPerLevel;
    if (currentExp < expAcc) {
      level = i;
      expAcc -= expPerLevel;
      break;
    }
  }
  if (level === -1) {
    level =
      skyWarsLevelConstants.easyLevelExp.length +
      Math.floor((currentExp - expAcc) / skyWarsLevelConstants.expPerLevel);
    expAcc +=
      (level - skyWarsLevelConstants.easyLevelExp.length) *
      skyWarsLevelConstants.expPerLevel;
  }
  const expToLevel = expAcc;
  const nextLevelExp =
    expToLevel +
    (level < skyWarsLevelConstants.easyLevelExp.length
      ? skyWarsLevelConstants.easyLevelExp[level]
      : skyWarsLevelConstants.expPerLevel);
  const expToNextLevel = nextLevelExp - expToLevel;
  const expInCurrentLevel = currentExp - expToLevel;
  const remainingExpToNextLevel = nextLevelExp - currentExp;
  const nextLevelProgress = expInCurrentLevel / expToNextLevel;
  const preciseLevel = level + nextLevelProgress;
  const info = ({
    level,
    preciseLevel,
    currentExp,
    expToLevel,
    expToNextLevel,
    remainingExpToNextLevel,
  } as never) as SkyWarsLevelInfoAndPrestige;
  if (includePrestige !== true) {
    return info;
  }

  info.prestige = getSkyWarsPrestigeForLevel(level);
  info.expToPrestige = totalExpToSkyWarsLevel(info.prestige.minimumLevel);
  const prestigeIndex = SkyWarsPrestiges.indexOf(info.prestige);
  if (prestigeIndex + 1 === SkyWarsPrestiges.length) {
    return info;
  }
  info.nextPrestige = SkyWarsPrestiges[prestigeIndex + 1];
  info.expToNextPrestige = totalExpToSkyWarsLevel(
    info.nextPrestige.minimumLevel
  );
  info.remainingExpToNextPrestige = info.expToNextPrestige - info.currentExp;
  info.progressToNextPrestige = info.currentExp / info.expToNextPrestige;
  return info;
}