hive-bedrock-api 3.0.0-alpha.14 → 3.0.0-alpha.16

package/README.md

@@ -3,7 +3,7 @@
 An API wrapper for the Hive Minecraft Bedrock Edition server. Which allows you to get stats for leaderboards, players, cosmetics, unique player counts, maps and metadata.
 
 > [!NOTE]
-> This API responses returnded from this package will differ from the responses returned by the offical Hive API. This due to our preference and needs when using this package on [Hive Backpack](https://hivebackpack.com).
+> This API responses returned from this package will differ from the responses returned by the official Hive API. This due to our preference and needs when using this package on [Hive Backpack](https://hivebackpack.com).
 
 ## Getting started
 
@@ -16,7 +16,7 @@ You should also include `hive-bedrock-data` as it includes useful functions and
 
 ## Usage
 
-To start using this API wrapper you may construct the main class `HiveAPI`. This class can take in seperate options that will be used in every http request.
+To start using the API, construct the main class `HiveAPI`. This class takes in options that will be used in every HTTP request.
 
 ```ts
 const api = new HiveAPI({

package/lib/index.d.ts

@@ -5,15 +5,16 @@ import { ProcessedGlobalStatisticsResponse } from "./processors/global_statistic
 import { ProcessedMapResponse } from "./processors/map";
 import { ProcessedGameMetadata } from "./processors/meta";
 import { ProcessedPlayerSearchResponse } from "./processors/player_search";
-import { ProcessedAllGamesResponse, ProcessedGame } from "./processors/game";
+import { AvailableLeaderboardResponse, ProcessedAllGamesResponse, ProcessedGame } from "./processors/game";
 interface Options {
     resolveDynamicTitles?: boolean;
+    useModernLeaderboardSource?: boolean;
     apiBaseEndpoint?: string;
     requestInit?: RequestInit;
 }
 export default class HiveAPI {
     options: Options;
-    constructor(options?: Options);
+    constructor(options: Options);
     private _fetchAPI;
     /**
      * `/game/all/main/{identifier}` Gets information about a player
@@ -49,6 +50,7 @@ export default class HiveAPI {
     }): Promise<MethodResponse<ProcessedGame<Timeframe.Monthly, false>[G]>>;
     private _getStatisticsAllTime;
     private _getStatisticsMonthly;
+    getAvailableMonthlyLeaderboards<G extends Game>(game: G): Promise<MethodResponse<AvailableLeaderboardResponse>>;
     /**
      * `/game/season/player/{game}/{player}/{season}` Gets seasonal statistics for a player
      * @param identifier Username or UUID of the player

package/lib/index.js

@@ -72,8 +72,10 @@ var player_search_1 = __importDefault(require("./processors/player_search"));
 var game_1 = __importDefault(require("./processors/game"));
 var HiveAPI = /** @class */ (function () {
     function HiveAPI(options) {
-        if (options === void 0) { options = { resolveDynamicTitles: true, apiBaseEndpoint: hive_bedrock_data_1.API_BASE_ENDPOINT }; }
+        var _a;
         this.options = options;
+        this.options = options;
+        this.options.apiBaseEndpoint = (_a = this.options.apiBaseEndpoint) !== null && _a !== void 0 ? _a : hive_bedrock_data_1.API_BASE_ENDPOINT;
     }
     HiveAPI.prototype._fetchAPI = function (endpoint) {
         return __awaiter(this, void 0, void 0, function () {
@@ -87,7 +89,7 @@ var HiveAPI = /** @class */ (function () {
                     case 1:
                         _c.trys.push([1, 4, , 5]);
                         start = performance.now();
-                        return [4 /*yield*/, fetch(url, __assign(__assign({}, this.options.requestInit), { headers: __assign({ "X-Hive-Resolve-Stat-Track": ((_a = this.options.resolveDynamicTitles) !== null && _a !== void 0 ? _a : true).toString() }, (_b = this.options.requestInit) === null || _b === void 0 ? void 0 : _b.headers) }))];
+                        return [4 /*yield*/, fetch(url, __assign(__assign({}, this.options.requestInit), { headers: __assign({ "X-Hive-Resolve-Stat-Track": ((_a = this.options.resolveDynamicTitles) !== null && _a !== void 0 ? _a : true).toString(), "X-Hive-Leaderboard-Source": this.options.useModernLeaderboardSource ? "modern" : "legacy" }, (_b = this.options.requestInit) === null || _b === void 0 ? void 0 : _b.headers) }))];
                     case 2:
                         request = _c.sent();
                         if (!request.ok)
@@ -232,6 +234,21 @@ var HiveAPI = /** @class */ (function () {
             });
         });
     };
+    HiveAPI.prototype.getAvailableMonthlyLeaderboards = function (game) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, response, error, meta;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, this._fetchAPI("/game/monthly/".concat(game, "/available"))];
+                    case 1:
+                        _a = _b.sent(), response = _a.data, error = _a.error, meta = _a.meta;
+                        if (error)
+                            return [2 /*return*/, { data: null, error: error, meta: meta }];
+                        return [2 /*return*/, { data: response, error: null, meta: meta }];
+                }
+            });
+        });
+    };
     /**
      * `/game/season/player/{game}/{player}/{season}` Gets seasonal statistics for a player
      * @param identifier Username or UUID of the player

package/lib/processors/build.d.ts

@@ -1,19 +1,19 @@
 import { Game, Statistics, Timeframe } from "hive-bedrock-data";
 import { OmittedSpecialStatistics } from "../types/types";
-export interface Processed_JustBuild_AllTimeStatistics extends OmittedSpecialStatistics<Game.JustBuild, Timeframe.AllTime> {
-    id: Game.JustBuild;
+export interface Processed_BuildBattle_AllTimeStatistics extends OmittedSpecialStatistics<Game.BuildBattle, Timeframe.AllTime> {
+    id: Game.BuildBattle;
     level: number;
     losses: number;
     win_percentage: number;
     total_ratings: number;
     first_played: number | null;
 }
-export interface Processed_JustBuild_MonthlyStatistics extends Statistics<Game.JustBuild, Timeframe.Monthly> {
-    id: Game.JustBuild;
+export interface Processed_BuildBattle_MonthlyStatistics extends Statistics<Game.BuildBattle, Timeframe.Monthly> {
+    id: Game.BuildBattle;
     level: number;
     total_ratings: number;
     losses: number;
     win_percentage: number;
 }
-export declare function processAllTime_BUILD(statistics: Partial<Statistics<Game.JustBuild, Timeframe.AllTime>>): Processed_JustBuild_AllTimeStatistics | null;
-export declare function processMonthly_BUILD(statistics: Partial<Statistics<Game.JustBuild, Timeframe.Monthly>>): Processed_JustBuild_MonthlyStatistics | null;
+export declare function processAllTime_BUILD(statistics: Partial<Statistics<Game.BuildBattle, Timeframe.AllTime>>): Processed_BuildBattle_AllTimeStatistics | null;
+export declare function processMonthly_BUILD(statistics: Partial<Statistics<Game.BuildBattle, Timeframe.Monthly>>): Processed_BuildBattle_MonthlyStatistics | null;

package/lib/processors/build.js

@@ -24,12 +24,12 @@ function processAllTime_BUILD(statistics) {
     var _a;
     if (!statistics || Array.isArray(statistics))
         return null;
-    return __assign(__assign(__assign(__assign({ UUID: statistics.UUID }, (0, processGameAndXP_1.default)(hive_bedrock_data_1.Game.JustBuild, statistics.xp)), (0, processPlayedAndVictories_1.default)(statistics.played, statistics.victories)), (0, processBuildRatings_1.default)(statistics.rating_love_received, statistics.rating_great_received, statistics.rating_good_received, statistics.rating_okay_received, statistics.rating_meh_received)), { first_played: (_a = statistics.first_played) !== null && _a !== void 0 ? _a : null });
+    return __assign(__assign(__assign(__assign({ UUID: statistics.UUID }, (0, processGameAndXP_1.default)(hive_bedrock_data_1.Game.BuildBattle, statistics.xp)), (0, processPlayedAndVictories_1.default)(statistics.played, statistics.victories)), (0, processBuildRatings_1.default)(statistics.rating_love_received, statistics.rating_great_received, statistics.rating_good_received, statistics.rating_okay_received, statistics.rating_meh_received)), { first_played: (_a = statistics.first_played) !== null && _a !== void 0 ? _a : null });
 }
 function processMonthly_BUILD(statistics) {
     var _a, _b;
     if (!statistics || Array.isArray(statistics))
         return null;
     var index = (_a = statistics.index) !== null && _a !== void 0 ? _a : 0;
-    return __assign(__assign(__assign({ index: (_b = statistics.index) !== null && _b !== void 0 ? _b : 0, human_index: index + 1, username: statistics.username }, (0, processGameAndXP_1.default)(hive_bedrock_data_1.Game.JustBuild, statistics.xp)), (0, processPlayedAndVictories_1.default)(statistics.played, statistics.victories)), (0, processBuildRatings_1.default)(statistics.rating_love_received, statistics.rating_great_received, statistics.rating_good_received, statistics.rating_okay_received, statistics.rating_meh_received));
+    return __assign(__assign(__assign({ index: (_b = statistics.index) !== null && _b !== void 0 ? _b : 0, human_index: index + 1, username: statistics.username }, (0, processGameAndXP_1.default)(hive_bedrock_data_1.Game.BuildBattle, statistics.xp)), (0, processPlayedAndVictories_1.default)(statistics.played, statistics.victories)), (0, processBuildRatings_1.default)(statistics.rating_love_received, statistics.rating_great_received, statistics.rating_good_received, statistics.rating_okay_received, statistics.rating_meh_received));
 }

package/lib/processors/game.d.ts

@@ -88,7 +88,7 @@ export interface ProcessedGameGROUND {
     projectiles_fired: number;
 }
 export interface ProcessedGameBUILD {
-    id: Game.JustBuild;
+    id: Game.BuildBattle;
     xp: number;
     played: number;
     victories: number;
@@ -140,6 +140,7 @@ export interface ProcessedGameSKY {
     mystery_chests_destroyed: number;
     ores_mined: number;
     spells_used: number;
+    prestige: number;
 }
 export interface ProcessedGameSKYKITS {
     id: Game.SkyWarsKits;
@@ -254,7 +255,7 @@ export interface ProcessedGame<T extends Timeframe, L extends boolean> {
     [Game.DeathRun]: ProcessedGameDR & AdditionalStatistics<T, L>;
     [Game.Gravity]: ProcessedGameGRAV & AdditionalStatistics<T, L>;
     [Game.GroundWars]: ProcessedGameGROUND & AdditionalStatistics<T, L>;
-    [Game.JustBuild]: ProcessedGameBUILD & AdditionalStatistics<T, L>;
+    [Game.BuildBattle]: ProcessedGameBUILD & AdditionalStatistics<T, L>;
     [Game.HideAndSeek]: ProcessedGameHIDE & AdditionalStatistics<T, L>;
     [Game.MurderMystery]: ProcessedGameMURDER & AdditionalStatistics<T, L>;
     [Game.SkyWars]: ProcessedGameSKY & AdditionalStatistics<T, L>;
@@ -302,3 +303,10 @@ export interface ProcessedMonthlyGamesResponse {
         [G in Game]: ProcessedGame<Timeframe.Monthly, false>[G] | null;
     };
 }
+export interface AvailableLeaderboard {
+    month: string;
+    year: string;
+    month_number: number;
+    resource: string;
+}
+export type AvailableLeaderboardResponse = AvailableLeaderboard[];

package/lib/processors/game.js

@@ -160,10 +160,10 @@ exports.processors = (_a = {},
             projectiles_fired: (_h = response.projectiles_fired) !== null && _h !== void 0 ? _h : 0,
         });
     },
-    _a[hive_bedrock_data_1.Game.JustBuild] = function (response) {
+    _a[hive_bedrock_data_1.Game.BuildBattle] = function (response) {
         var _a, _b, _c, _d, _e, _f, _g, _h;
         return ({
-            id: hive_bedrock_data_1.Game.JustBuild,
+            id: hive_bedrock_data_1.Game.BuildBattle,
             xp: (_a = response.xp) !== null && _a !== void 0 ? _a : 0,
             played: (_b = response.played) !== null && _b !== void 0 ? _b : 0,
             victories: (_c = response.victories) !== null && _c !== void 0 ? _c : 0,
@@ -216,7 +216,7 @@ exports.processors = (_a = {},
         });
     },
     _a[hive_bedrock_data_1.Game.SkyWars] = function (response) {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         return ({
             id: hive_bedrock_data_1.Game.SkyWars,
             xp: (_a = response.xp) !== null && _a !== void 0 ? _a : 0,
@@ -230,6 +230,7 @@ exports.processors = (_a = {},
             mystery_chests_destroyed: (_f = response.mystery_chests_destroyed) !== null && _f !== void 0 ? _f : 0,
             ores_mined: (_g = response.ores_mined) !== null && _g !== void 0 ? _g : 0,
             spells_used: (_h = response.spells_used) !== null && _h !== void 0 ? _h : 0,
+            prestige: (_j = response.prestige) !== null && _j !== void 0 ? _j : 0,
         });
     },
     _a[hive_bedrock_data_1.Game.SkyWarsKits] = function (response) {

package/lib/processors/index.js

@@ -28,7 +28,7 @@ exports.AllTimeProcessors = (_a = {},
     _a[hive_bedrock_data_1.Game.Gravity] = grav_1.processAllTime_GRAV,
     _a[hive_bedrock_data_1.Game.GroundWars] = ground_1.processAllTime_GROUND,
     _a[hive_bedrock_data_1.Game.HideAndSeek] = hide_1.processAllTime_HIDE,
-    _a[hive_bedrock_data_1.Game.JustBuild] = build_1.processAllTime_BUILD,
+    _a[hive_bedrock_data_1.Game.BuildBattle] = build_1.processAllTime_BUILD,
     _a[hive_bedrock_data_1.Game.MurderMystery] = murder_1.processAllTime_MURDER,
     _a[hive_bedrock_data_1.Game.ParkourWorlds] = parkour_1.processAllTime_PARKOUR,
     _a[hive_bedrock_data_1.Game.Skywars] = sky_1.processAllTime_SKY,
@@ -45,7 +45,7 @@ exports.MonthlyProcessors = (_b = {},
     _b[hive_bedrock_data_1.Game.Gravity] = grav_1.processMonthly_GRAV,
     _b[hive_bedrock_data_1.Game.GroundWars] = ground_1.processMonthly_GROUND,
     _b[hive_bedrock_data_1.Game.HideAndSeek] = hide_1.processMonthly_HIDE,
-    _b[hive_bedrock_data_1.Game.JustBuild] = build_1.processMonthly_BUILD,
+    _b[hive_bedrock_data_1.Game.BuildBattle] = build_1.processMonthly_BUILD,
     _b[hive_bedrock_data_1.Game.MurderMystery] = murder_1.processMonthly_MURDER,
     _b[hive_bedrock_data_1.Game.Skywars] = sky_1.processMonthly_SKY,
     _b[hive_bedrock_data_1.Game.SurvivalGames] = sg_1.processMonthly_SG,
@@ -62,7 +62,7 @@ exports.LeaderboardProcessors = (_c = {},
     _c[hive_bedrock_data_1.Game.Gravity] = grav_1.processMonthly_GRAV,
     _c[hive_bedrock_data_1.Game.GroundWars] = ground_1.processMonthly_GROUND,
     _c[hive_bedrock_data_1.Game.HideAndSeek] = hide_1.processMonthly_HIDE,
-    _c[hive_bedrock_data_1.Game.JustBuild] = build_1.processMonthly_BUILD,
+    _c[hive_bedrock_data_1.Game.BuildBattle] = build_1.processMonthly_BUILD,
     _c[hive_bedrock_data_1.Game.MurderMystery] = murder_1.processMonthly_MURDER,
     _c[hive_bedrock_data_1.Game.Skywars] = sky_1.processMonthly_SKY,
     _c[hive_bedrock_data_1.Game.SurvivalGames] = sg_1.processMonthly_SG,

package/lib/processors/sky.js

@@ -21,15 +21,15 @@ var processGameAndXP_1 = __importDefault(require("./helpers/processGameAndXP"));
 var processPlayedAndVictories_1 = __importDefault(require("./helpers/processPlayedAndVictories"));
 var processKillsAndDeaths_1 = __importDefault(require("./helpers/processKillsAndDeaths"));
 function processAllTime_SKY(statistics) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e;
     if (!statistics || Array.isArray(statistics))
         return null;
-    return __assign(__assign(__assign(__assign({ UUID: statistics.UUID }, (0, processGameAndXP_1.default)(hive_bedrock_data_1.Game.Skywars, statistics.xp)), (0, processPlayedAndVictories_1.default)(statistics.played, statistics.victories)), (0, processKillsAndDeaths_1.default)(statistics.kills, statistics.deaths)), { mystery_chests_destroyed: (_a = statistics.mystery_chests_destroyed) !== null && _a !== void 0 ? _a : 0, ores_mined: (_b = statistics.ores_mined) !== null && _b !== void 0 ? _b : 0, spells_used: (_c = statistics.spells_used) !== null && _c !== void 0 ? _c : 0, first_played: (_d = statistics.first_played) !== null && _d !== void 0 ? _d : null });
+    return __assign(__assign(__assign(__assign({ UUID: statistics.UUID }, (0, processGameAndXP_1.default)(hive_bedrock_data_1.Game.Skywars, statistics.xp)), (0, processPlayedAndVictories_1.default)(statistics.played, statistics.victories)), (0, processKillsAndDeaths_1.default)(statistics.kills, statistics.deaths)), { mystery_chests_destroyed: (_a = statistics.mystery_chests_destroyed) !== null && _a !== void 0 ? _a : 0, ores_mined: (_b = statistics.ores_mined) !== null && _b !== void 0 ? _b : 0, spells_used: (_c = statistics.spells_used) !== null && _c !== void 0 ? _c : 0, prestige: (_d = statistics.prestige) !== null && _d !== void 0 ? _d : 0, first_played: (_e = statistics.first_played) !== null && _e !== void 0 ? _e : null });
 }
 function processMonthly_SKY(statistics) {
-    var _a, _b, _c, _d, _e;
+    var _a, _b, _c, _d, _e, _f;
     if (!statistics || Array.isArray(statistics))
         return null;
     var index = (_a = statistics.index) !== null && _a !== void 0 ? _a : 0;
-    return __assign(__assign(__assign(__assign({ index: (_b = statistics.index) !== null && _b !== void 0 ? _b : 0, human_index: index + 1, username: statistics.username }, (0, processGameAndXP_1.default)(hive_bedrock_data_1.Game.Skywars, statistics.xp)), (0, processPlayedAndVictories_1.default)(statistics.played, statistics.victories)), (0, processKillsAndDeaths_1.default)(statistics.kills, statistics.deaths)), { mystery_chests_destroyed: (_c = statistics.mystery_chests_destroyed) !== null && _c !== void 0 ? _c : 0, ores_mined: (_d = statistics.ores_mined) !== null && _d !== void 0 ? _d : 0, spells_used: (_e = statistics.spells_used) !== null && _e !== void 0 ? _e : 0 });
+    return __assign(__assign(__assign(__assign({ index: (_b = statistics.index) !== null && _b !== void 0 ? _b : 0, human_index: index + 1, username: statistics.username }, (0, processGameAndXP_1.default)(hive_bedrock_data_1.Game.Skywars, statistics.xp)), (0, processPlayedAndVictories_1.default)(statistics.played, statistics.victories)), (0, processKillsAndDeaths_1.default)(statistics.kills, statistics.deaths)), { mystery_chests_destroyed: (_c = statistics.mystery_chests_destroyed) !== null && _c !== void 0 ? _c : 0, ores_mined: (_d = statistics.ores_mined) !== null && _d !== void 0 ? _d : 0, spells_used: (_e = statistics.spells_used) !== null && _e !== void 0 ? _e : 0, prestige: (_f = statistics.prestige) !== null && _f !== void 0 ? _f : 0 });
 }

package/lib/types/output.d.ts

@@ -7,7 +7,7 @@ import { Processed_DeathRun_AllTimeStatistics, Processed_DeathRun_MonthlyStatist
 import { Processed_Gravity_AllTimeStatistics, Processed_Gravity_MonthlyStatistics } from "../processors/grav";
 import { Processed_GroundWars_AllTimeStatistics, Processed_GroundWars_MonthlyStatistics } from "../processors/ground";
 import { Processed_HideAndSeek_AllTimeStatistics, Processed_HideAndSeek_MonthlyStatistics } from "../processors/hide";
-import { Processed_JustBuild_AllTimeStatistics, Processed_JustBuild_MonthlyStatistics } from "../processors/build";
+import { Processed_BuildBattle_AllTimeStatistics, Processed_BuildBattle_MonthlyStatistics } from "../processors/build";
 import { Processed_MurderMystery_AllTimeStatistics, Processed_MurderMystery_MonthlyStatistics } from "../processors/murder";
 import { Processed_ParkourWorlds_AllTimeStatistics } from "../processors/parkour";
 import { Processed_Skywars_AllTimeStatistics, Processed_Skywars_MonthlyStatistics } from "../processors/sky";
@@ -26,7 +26,7 @@ export interface AllTimeProcessedStatistics {
     [Game.Gravity]: Processed_Gravity_AllTimeStatistics;
     [Game.GroundWars]: Processed_GroundWars_AllTimeStatistics;
     [Game.HideAndSeek]: Processed_HideAndSeek_AllTimeStatistics;
-    [Game.JustBuild]: Processed_JustBuild_AllTimeStatistics;
+    [Game.BuildBattle]: Processed_BuildBattle_AllTimeStatistics;
     [Game.MurderMystery]: Processed_MurderMystery_AllTimeStatistics;
     [Game.Skywars]: Processed_Skywars_AllTimeStatistics;
     [Game.SurvivalGames]: Processed_SurvivalGames_AllTimeStatistics;
@@ -49,7 +49,7 @@ export interface MonthlyProcessedStatistics {
     [Game.Gravity]: Processed_Gravity_MonthlyStatistics;
     [Game.GroundWars]: Processed_GroundWars_MonthlyStatistics;
     [Game.HideAndSeek]: Processed_HideAndSeek_MonthlyStatistics;
-    [Game.JustBuild]: Processed_JustBuild_MonthlyStatistics;
+    [Game.BuildBattle]: Processed_BuildBattle_MonthlyStatistics;
     [Game.MurderMystery]: Processed_MurderMystery_MonthlyStatistics;
     [Game.Skywars]: Processed_Skywars_MonthlyStatistics;
     [Game.SurvivalGames]: Processed_SurvivalGames_MonthlyStatistics;

package/lib/utils.d.ts

@@ -4,7 +4,6 @@ export interface MethodResponseError {
 }
 export type MethodResponse<D extends any> = {
     meta?: {
-        /** sss */
         duration: number;
         ratelimit?: {
             limit: number;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "hive-bedrock-api",
-    "version": "3.0.0-alpha.14",
+    "version": "3.0.0-alpha.16",
     "description": "An API wrapper for the Hive Minecraft Bedrock Edition server.",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
@@ -11,7 +11,7 @@
     "license": "MIT",
     "author": "Cubeedge Studios",
     "dependencies": {
-        "hive-bedrock-data": "^2.0.0-alpha.6"
+        "hive-bedrock-data": "^2.0.0-alpha.9"
     },
     "scripts": {
         "build": "tsc"