@zikeji/hypixel/src/helpers/NetworkLevel.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) 2020 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";

/**
 * Describes the results from a {@link getNetworkLevel} function call.
 */
export interface NetworkLevel {
  level: number;
  preciseLevel: number;
  currentExp: number;
  expToLevel: number;
  expToNextLevel: number;
  remainingExpToNextLevel: number;
}

/** @internal */
enum NETWORK_LEVEL_CONSTANTS {
  START = 10000,
  GROWTH = 2500,
  RPQP = ((): number =>
    -(NETWORK_LEVEL_CONSTANTS.START - 0.5 * NETWORK_LEVEL_CONSTANTS.GROWTH) /
    NETWORK_LEVEL_CONSTANTS.GROWTH)(),
  IPQP = ((): number =>
    NETWORK_LEVEL_CONSTANTS.RPQP * NETWORK_LEVEL_CONSTANTS.RPQP)(),
}

/**
 * Calculates the total EXP required for a specific network level.
 * @param level Level you're getting the EXP required for. Can be a float or an integer.
 * @category Helper
 */
export function getExpFromNetworkLevel(level: number): number {
  const flooredLevel = Math.floor(level);
  const expToFlooredLevel =
    (NETWORK_LEVEL_CONSTANTS.GROWTH * 0.5 * (flooredLevel - 2) +
      NETWORK_LEVEL_CONSTANTS.START) *
    (flooredLevel - 1);
  if (flooredLevel === level) {
    return expToFlooredLevel;
  }
  return (
    (getExpFromNetworkLevel(flooredLevel + 1) - expToFlooredLevel) *
      (level % 1) +
    expToFlooredLevel
  );
}

/**
 * Calculates the network level and returns a {@link NetworkLevel} interface.
 * @param data The player object or the raw EXP number.
 * @category Helper
 */
export function getNetworkLevel(
  data: PlayerResponse["player"] | number
): NetworkLevel {
  let currentExp = 0;
  if (typeof data === "number") {
    currentExp = data;
  } else {
    currentExp = typeof data.networkExp === "number" ? data.networkExp : 0;
  }
  if (currentExp < 0) currentExp = 0;
  const level = Math.floor(
    1 +
      NETWORK_LEVEL_CONSTANTS.RPQP +
      Math.sqrt(
        NETWORK_LEVEL_CONSTANTS.IPQP +
          (2 / NETWORK_LEVEL_CONSTANTS.GROWTH) * currentExp
      )
  );
  const expToLevel = getExpFromNetworkLevel(level);
  const nextLevelExp = getExpFromNetworkLevel(level + 1);
  const expToNextLevel = nextLevelExp - expToLevel;
  const expInCurrentLevel = currentExp - expToLevel;
  const remainingExpToNextLevel = nextLevelExp - currentExp;
  const nextLevelProgress = expInCurrentLevel / expToNextLevel;
  const preciseLevel = level + nextLevelProgress;
  return {
    level,
    preciseLevel,
    currentExp,
    expToLevel,
    expToNextLevel,
    remainingExpToNextLevel,
  };
}