hive-bedrock-api 3.0.0-alpha.9 → 4.0.1

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,12 +5,19 @@ 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, ProcessedMonthlyGamesResponse } from "./processors/game";
 interface Options {
     resolveDynamicTitles?: boolean;
+    useModernLeaderboardSource?: boolean;
     apiBaseEndpoint?: string;
     requestInit?: RequestInit;
 }
+export * from "./processors/game";
+export * from "./processors/global_statistics";
+export * from "./processors/map";
+export * from "./processors/meta";
+export * from "./processors/player";
+export * from "./processors/player_search";
 export default class HiveAPI {
     options: Options;
     constructor(options?: Options);
@@ -41,14 +48,20 @@ export default class HiveAPI {
     getStatistics(identifier: string, timeframe: Timeframe.Monthly, options?: {
         month?: number;
         year?: number;
-    }): Promise<MethodResponse<ProcessedAllGamesResponse>>;
+    }): Promise<MethodResponse<ProcessedMonthlyGamesResponse>>;
     getStatistics<G extends Game>(identifier: string, timeframe: Timeframe.Monthly, options: {
         game: G;
         month?: number;
         year?: number;
     }): Promise<MethodResponse<ProcessedGame<Timeframe.Monthly, false>[G]>>;
+    getStatistics<G extends Game>(identifier: string, timeframe: Timeframe.Seasonal, options: {
+        game: G;
+        season: number;
+    }): Promise<MethodResponse<ProcessedMonthlyGamesResponse>>;
     private _getStatisticsAllTime;
     private _getStatisticsMonthly;
+    private _getStatisticsSeasonal;
+    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
@@ -56,7 +69,7 @@ export default class HiveAPI {
      * @param season The season to get the statistics for
      * @returns The player's seasonal statistics
      */
-    getSeasonalStatistics<G extends Game>(identifier: string, game: G, season?: number): Promise<MethodResponse<ProcessedGame<Timeframe.Monthly, true>[G] | null>>;
+    getSeasonalStatistics<G extends Game>(identifier: string, game: G, season?: number): Promise<MethodResponse<ProcessedMonthlyGamesResponse["statistics"][G] | null>>;
     /**
      * `/game/all/{game}` Gets statistics for a game
      * @param timeframe The timeframe to get the statistics for
@@ -69,8 +82,12 @@ export default class HiveAPI {
         month?: number;
         year?: number;
     }): Promise<MethodResponse<ProcessedGame<Timeframe.Monthly, true>[G][] | null>>;
+    getLeaderboard<G extends Game>(timeframe: Timeframe.Seasonal, game: G, options: {
+        season: number;
+    }): Promise<MethodResponse<ProcessedGame<Timeframe.Seasonal, true>[G][] | null>>;
     private _getLeaderboardAllTime;
     private _getLeaderboardMonthly;
+    private _getLeaderboardSeasonal;
     /**
      * `/game/season/{game}/{season}` Gets seasonal statistics for a game
      * @param game The game to get the statistics for
@@ -96,4 +113,3 @@ export default class HiveAPI {
      */
     getGameMetadata(game: Game): Promise<MethodResponse<ProcessedGameMetadata>>;
 }
-export {};

package/lib/index.js

@@ -10,6 +10,20 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -69,11 +83,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var hive_bedrock_data_1 = require("hive-bedrock-data");
 var player_1 = __importDefault(require("./processors/player"));
 var player_search_1 = __importDefault(require("./processors/player_search"));
-var game_1 = __importDefault(require("./processors/game"));
+var game_1 = require("./processors/game");
+__exportStar(require("./processors/game"), exports);
+__exportStar(require("./processors/global_statistics"), exports);
+__exportStar(require("./processors/map"), exports);
+__exportStar(require("./processors/meta"), exports);
+__exportStar(require("./processors/player"), exports);
+__exportStar(require("./processors/player_search"), exports);
 var HiveAPI = /** @class */ (function () {
     function HiveAPI(options) {
-        if (options === void 0) { options = { resolveDynamicTitles: true, apiBaseEndpoint: hive_bedrock_data_1.API_BASE_ENDPOINT }; }
+        if (options === void 0) { options = {}; }
+        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 +110,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)
@@ -163,10 +186,20 @@ var HiveAPI = /** @class */ (function () {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
                 if (timeframe === hive_bedrock_data_1.Timeframe.AllTime) {
-                    if (options === null || options === void 0 ? void 0 : options.game)
+                    if (options === null || options === void 0 ? void 0 : options.game) {
+                        if (!hive_bedrock_data_1.Games[options.game].statistics)
+                            throw new Error("Statistics are not available for the game: ".concat(options.game));
                         return [2 /*return*/, this._getStatisticsAllTime(identifier, options.game)];
+                    }
                     return [2 /*return*/, this._getStatisticsAllTime(identifier)];
                 }
+                else if (timeframe === hive_bedrock_data_1.Timeframe.Seasonal) {
+                    if (!(options === null || options === void 0 ? void 0 : options.game))
+                        throw new Error("Game must be specified for seasonal statistics");
+                    if (!hive_bedrock_data_1.Games[options.game].statistics)
+                        throw new Error("Statistics are not available for the game: ".concat(options.game));
+                    return [2 /*return*/, this._getStatisticsSeasonal(identifier, options === null || options === void 0 ? void 0 : options.game, (options === null || options === void 0 ? void 0 : options.season) || 1)];
+                }
                 if (options === null || options === void 0 ? void 0 : options.game)
                     return [2 /*return*/, this._getStatisticsMonthly(identifier, options.game, options.month, options.year)];
                 return [2 /*return*/, this._getStatisticsMonthly(identifier, undefined, options === null || options === void 0 ? void 0 : options.month, options === null || options === void 0 ? void 0 : options.year)];
@@ -184,11 +217,11 @@ var HiveAPI = /** @class */ (function () {
                         if (error)
                             return [2 /*return*/, { data: null, error: error, meta: meta }];
                         if (game)
-                            return [2 /*return*/, { data: (0, game_1.default)(game, hive_bedrock_data_1.Timeframe.AllTime, false, response), error: null, meta: meta }];
+                            return [2 /*return*/, { data: (0, game_1.processGame)(game, hive_bedrock_data_1.Timeframe.AllTime, false, response), error: null, meta: meta }];
                         data = Object.fromEntries(Object.entries(response).map(function (_a) {
                             var _b;
                             var _c = __read(_a, 2), id = _c[0], res = _c[1];
-                            return [id, id === "main" ? null : (_b = (0, game_1.default)(id, hive_bedrock_data_1.Timeframe.AllTime, false, res)) !== null && _b !== void 0 ? _b : null];
+                            return [id, id === "main" ? null : (_b = (0, game_1.processGame)(id, hive_bedrock_data_1.Timeframe.AllTime, false, res)) !== null && _b !== void 0 ? _b : null];
                         }));
                         delete data.main;
                         return [2 /*return*/, {
@@ -208,17 +241,20 @@ var HiveAPI = /** @class */ (function () {
             var _a, response, error, meta, data;
             return __generator(this, function (_b) {
                 switch (_b.label) {
-                    case 0: return [4 /*yield*/, this._fetchAPI("/game/monthly/player/".concat(game !== null && game !== void 0 ? game : "all", "/").concat(identifier, "/").concat(year !== null && year !== void 0 ? year : new Date().getFullYear(), "/").concat(month !== null && month !== void 0 ? month : new Date().getMonth() + 1))];
+                    case 0:
+                        if (game && !hive_bedrock_data_1.Games[game].statistics)
+                            throw new Error("Statistics are not available for the game: ".concat(game));
+                        return [4 /*yield*/, this._fetchAPI("/game/monthly/player/".concat(game !== null && game !== void 0 ? game : "all", "/").concat(identifier, "/").concat(year !== null && year !== void 0 ? year : new Date().getFullYear(), "/").concat(month !== null && month !== void 0 ? month : new Date().getMonth() + 1))];
                     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 }];
                         if (game)
-                            return [2 /*return*/, { data: (0, game_1.default)(game, hive_bedrock_data_1.Timeframe.Monthly, false, response), error: null, meta: meta }];
+                            return [2 /*return*/, { data: (0, game_1.processGame)(game, hive_bedrock_data_1.Timeframe.Monthly, false, response), error: null, meta: meta }];
                         data = Object.fromEntries(Object.entries(response).map(function (_a) {
                             var _b;
                             var _c = __read(_a, 2), id = _c[0], res = _c[1];
-                            return [id, id === "main" ? null : (_b = (0, game_1.default)(id, hive_bedrock_data_1.Timeframe.Monthly, false, res)) !== null && _b !== void 0 ? _b : null];
+                            return [id, id === "main" ? null : (_b = (0, game_1.processGame)(id, hive_bedrock_data_1.Timeframe.Monthly, false, res)) !== null && _b !== void 0 ? _b : null];
                         }));
                         delete data.main;
                         return [2 /*return*/, {
@@ -232,6 +268,39 @@ var HiveAPI = /** @class */ (function () {
             });
         });
     };
+    HiveAPI.prototype._getStatisticsSeasonal = function (identifier, game, season) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, response, error, meta;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        if (!hive_bedrock_data_1.Games[game].statistics)
+                            throw new Error("Statistics are not available for the game: ".concat(game));
+                        return [4 /*yield*/, this._fetchAPI("/game/season/player/".concat(game, "/").concat(identifier, "/").concat(season !== null && season !== void 0 ? season : 1))];
+                    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: (0, game_1.processGame)(game, hive_bedrock_data_1.Timeframe.Seasonal, false, response), error: null, meta: meta }];
+                }
+            });
+        });
+    };
+    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
@@ -245,12 +314,15 @@ var HiveAPI = /** @class */ (function () {
             if (season === void 0) { season = 1; }
             return __generator(this, function (_b) {
                 switch (_b.label) {
-                    case 0: return [4 /*yield*/, this._fetchAPI("/game/season/player/".concat(game, "/").concat(identifier, "/").concat(season))];
+                    case 0:
+                        if (game && !hive_bedrock_data_1.Games[game].statistics)
+                            throw new Error("Statistics are not available for the game: ".concat(game));
+                        return [4 /*yield*/, this._fetchAPI("/game/season/player/".concat(game, "/").concat(identifier, "/").concat(season))];
                     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 }];
-                        data = (0, game_1.default)(game, hive_bedrock_data_1.Timeframe.Monthly, true, response);
+                        data = (0, game_1.processGame)(game, hive_bedrock_data_1.Timeframe.Monthly, true, response);
                         return [2 /*return*/, { data: data, error: null, meta: meta }];
                 }
             });
@@ -259,8 +331,12 @@ var HiveAPI = /** @class */ (function () {
     HiveAPI.prototype.getLeaderboard = function (timeframe, game, options) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
+                if (game && !hive_bedrock_data_1.Games[game].statistics)
+                    throw new Error("Statistics are not available for the game: ".concat(game));
                 if (timeframe === hive_bedrock_data_1.Timeframe.Monthly)
                     return [2 /*return*/, this._getLeaderboardMonthly(game, (options === null || options === void 0 ? void 0 : options.month) || new Date().getMonth() + 1, (options === null || options === void 0 ? void 0 : options.year) || new Date().getFullYear())];
+                if (timeframe === hive_bedrock_data_1.Timeframe.Seasonal)
+                    return [2 /*return*/, this._getLeaderboardSeasonal(game, (options === null || options === void 0 ? void 0 : options.season) || 1)];
                 return [2 /*return*/, this._getLeaderboardAllTime(game)];
             });
         });
@@ -276,7 +352,7 @@ var HiveAPI = /** @class */ (function () {
                         _a = _b.sent(), response = _a.data, error = _a.error, meta = _a.meta;
                         if (error)
                             return [2 /*return*/, { data: null, error: error, meta: meta }];
-                        data = response.map(function (res) { return (0, game_1.default)(game, hive_bedrock_data_1.Timeframe.AllTime, true, res); });
+                        data = response.map(function (res) { return (0, game_1.processGame)(game, hive_bedrock_data_1.Timeframe.AllTime, true, res); });
                         return [2 /*return*/, { data: data, error: null, meta: meta }];
                 }
             });
@@ -288,12 +364,36 @@ var HiveAPI = /** @class */ (function () {
             var _a, response, error, meta, data;
             return __generator(this, function (_b) {
                 switch (_b.label) {
-                    case 0: return [4 /*yield*/, this._fetchAPI("/game/monthly/".concat(game, "/").concat(year, "/").concat(month))];
+                    case 0:
+                        if (game && !hive_bedrock_data_1.Games[game].statistics)
+                            throw new Error("Statistics are not available for the game: ".concat(game));
+                        return [4 /*yield*/, this._fetchAPI("/game/monthly/".concat(game, "/").concat(year, "/").concat(month))];
                     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 }];
-                        data = response.map(function (res) { return (0, game_1.default)(game, hive_bedrock_data_1.Timeframe.Monthly, true, res); });
+                        data = response.map(function (res) { return (0, game_1.processGame)(game, hive_bedrock_data_1.Timeframe.Monthly, true, res); });
+                        return [2 /*return*/, { data: data, error: null, meta: meta }];
+                }
+            });
+        });
+    };
+    // /game/season/{game}/season
+    HiveAPI.prototype._getLeaderboardSeasonal = function (game_2) {
+        return __awaiter(this, arguments, void 0, function (game, season) {
+            var _a, response, error, meta, data;
+            if (season === void 0) { season = 1; }
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        if (game && !hive_bedrock_data_1.Games[game].statistics)
+                            throw new Error("Statistics are not available for the game: ".concat(game));
+                        return [4 /*yield*/, this._fetchAPI("/game/season/".concat(game, "/").concat(season))];
+                    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 }];
+                        data = response.map(function (res) { return (0, game_1.processGame)(game, hive_bedrock_data_1.Timeframe.Seasonal, true, res); });
                         return [2 /*return*/, { data: data, error: null, meta: meta }];
                 }
             });
@@ -311,12 +411,15 @@ var HiveAPI = /** @class */ (function () {
             if (season === void 0) { season = 1; }
             return __generator(this, function (_b) {
                 switch (_b.label) {
-                    case 0: return [4 /*yield*/, this._fetchAPI("/game/season/".concat(game, "/").concat(season !== null && season !== void 0 ? season : 1))];
+                    case 0:
+                        if (game && !hive_bedrock_data_1.Games[game].statistics)
+                            throw new Error("Statistics are not available for the game: ".concat(game));
+                        return [4 /*yield*/, this._fetchAPI("/game/season/".concat(game, "/").concat(season !== null && season !== void 0 ? season : 1))];
                     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 }];
-                        data = response.map(function (res) { return (0, game_1.default)(game, hive_bedrock_data_1.Timeframe.Monthly, true, res); });
+                        data = response.map(function (res) { return (0, game_1.processGame)(game, hive_bedrock_data_1.Timeframe.Monthly, true, res); });
                         return [2 /*return*/, { data: data, error: null, meta: meta }];
                 }
             });
@@ -351,7 +454,10 @@ var HiveAPI = /** @class */ (function () {
             var _a, response, error, meta;
             return __generator(this, function (_b) {
                 switch (_b.label) {
-                    case 0: return [4 /*yield*/, this._fetchAPI("/game/map/".concat(game))];
+                    case 0:
+                        if (game && !hive_bedrock_data_1.Games[game].statistics)
+                            throw new Error("Statistics are not available for the game: ".concat(game));
+                        return [4 /*yield*/, this._fetchAPI("/game/map/".concat(game))];
                     case 1:
                         _a = _b.sent(), response = _a.data, error = _a.error, meta = _a.meta;
                         if (error)
@@ -371,7 +477,10 @@ var HiveAPI = /** @class */ (function () {
             var _a, response, error, meta;
             return __generator(this, function (_b) {
                 switch (_b.label) {
-                    case 0: return [4 /*yield*/, this._fetchAPI("/game/meta/".concat(game))];
+                    case 0:
+                        if (game && !hive_bedrock_data_1.Games[game].statistics)
+                            throw new Error("Statistics are not available for the game: ".concat(game));
+                        return [4 /*yield*/, this._fetchAPI("/game/meta/".concat(game))];
                     case 1:
                         _a = _b.sent(), response = _a.data, error = _a.error, meta = _a.meta;
                         if (error)

package/lib/processors/game.d.ts

@@ -12,6 +12,7 @@ export interface ProcessedGameBED {
     kdr: number;
     final_kills: number;
     beds_destroyed: number;
+    prestige: number;
 }
 export interface ProcessedGameDROP {
     id: Game.BlockDrop;
@@ -88,7 +89,7 @@ export interface ProcessedGameGROUND {
     projectiles_fired: number;
 }
 export interface ProcessedGameBUILD {
-    id: Game.JustBuild;
+    id: Game.BuildBattle;
     xp: number;
     played: number;
     victories: number;
@@ -111,7 +112,7 @@ export interface ProcessedGameHIDE {
     deaths: number;
     hider_kills: number;
     seeker_kills: number;
-    kdr: number;
+    kpg: number;
 }
 export interface ProcessedGameMURDER {
     id: Game.MurderMystery;
@@ -122,7 +123,7 @@ export interface ProcessedGameMURDER {
     win_percentage: number;
     murders: number;
     deaths: number;
-    kdr: number;
+    edr: number;
     coins: number;
     murderer_eliminations: number;
     prestige: number;
@@ -140,6 +141,7 @@ export interface ProcessedGameSKY {
     mystery_chests_destroyed: number;
     ores_mined: number;
     spells_used: number;
+    prestige: number;
 }
 export interface ProcessedGameSKYKITS {
     id: Game.SkyWarsKits;
@@ -241,7 +243,10 @@ export type AdditionalStatistics<T extends Timeframe, L extends boolean> = (T ex
     level: number;
 } & (L extends true ? {} : {
     first_played: number;
-}) : {}) & (L extends true ? {
+}) : {
+    position: number;
+    username: string;
+}) & (L extends true ? {
     position: number;
     username: string;
     UUID: string;
@@ -254,7 +259,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>;
@@ -263,34 +268,11 @@ export interface ProcessedGame<T extends Timeframe, L extends boolean> {
     [Game.SurvivalGames]: ProcessedGameSG & AdditionalStatistics<T, L>;
     [Game.TheBridge]: ProcessedGameBRIDGE & AdditionalStatistics<T, L>;
     [Game.TreasureWars]: ProcessedGameWARS & AdditionalStatistics<T, L>;
-    [Game.ParkourWorlds]: L extends true ? never : T extends Timeframe.Monthly ? never : ProcessedGamePARKOUR;
+    [Game.ParkourWorlds]: L extends true ? never : T extends Timeframe.AllTime ? ProcessedGamePARKOUR : never;
+    [Game.MobGame]: never;
+    [Game.GhostInvasion]: never;
 }
-export default function processGame<G extends Game, T extends Timeframe, L extends boolean>(game: G, timeframe: T, isLeaderboard: L, response: any): ProcessedGame<T, L>[G] | null;
-export declare const processors: {
-    bed: (response: any) => ProcessedGameBED;
-    drop: (response: any) => ProcessedGameDROP;
-    party: (response: any) => ProcessedGamePARTY;
-    ctf: (response: any) => ProcessedGameCTF;
-    dr: (response: any) => ProcessedGameDR;
-    grav: (response: any) => ProcessedGameGRAV;
-    ground: (response: any) => ProcessedGameGROUND;
-    build: (response: any) => ProcessedGameBUILD;
-    hide: (response: any) => ProcessedGameHIDE;
-    murder: (response: any) => ProcessedGameMURDER;
-    sky: (response: any) => ProcessedGameSKY;
-    "sky-kits": (response: any) => ProcessedGameSKYKITS;
-    "sky-classic": (response: any) => ProcessedGameSKYCLASSIC;
-    sg: (response: any) => ProcessedGameSG;
-    bridge: (response: any) => ProcessedGameBRIDGE;
-    wars: (response: any) => ProcessedGameWARS;
-    parkour: (response: any) => ProcessedGamePARKOUR;
-};
-export declare function validateNumber(value: number, def?: number): number;
-export declare function calculateKDR(kills: number, deaths: number): number;
-export declare function calculateWinPercentage(victories: number, played: number): number;
-export declare function calculateLosses(played: number, victories: number): number;
-export declare function calculateTotal(values: number[]): number;
-export declare function roundTo(value: number, places?: number): number;
+export declare function processGame<G extends Game, T extends Timeframe, L extends boolean>(game: G, timeframe: T, isLeaderboard: L, response: any): ProcessedGame<T, L>[G] | null;
 export interface ProcessedAllGamesResponse {
     player: ProcessedPlayerResponse;
     statistics: {
@@ -302,3 +284,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

@@ -17,14 +17,7 @@ var __read = (this && this.__read) || function (o, n) {
 };
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.processors = void 0;
-exports.default = processGame;
-exports.validateNumber = validateNumber;
-exports.calculateKDR = calculateKDR;
-exports.calculateWinPercentage = calculateWinPercentage;
-exports.calculateLosses = calculateLosses;
-exports.calculateTotal = calculateTotal;
-exports.roundTo = roundTo;
+exports.processGame = processGame;
 var hive_bedrock_data_1 = require("hive-bedrock-data");
 function processGame(game, timeframe, isLeaderboard, response) {
     var _a;
@@ -34,24 +27,26 @@ function processGame(game, timeframe, isLeaderboard, response) {
         return null;
     if (Array.isArray(response))
         return null;
-    var data = exports.processors[game](response);
-    if ("played" in data && data.played === 0)
+    var data = processors[game](response);
+    if (!data)
+        return null;
+    if ("played" in data && data.played === 0 && "xp" in data && data.xp === 0)
         return null;
     if (timeframe === hive_bedrock_data_1.Timeframe.AllTime && "xp" in data)
         data.level = (_a = (0, hive_bedrock_data_1.calculateLevelFromXP)(data.xp, game)) !== null && _a !== void 0 ? _a : 1;
-    if (timeframe === hive_bedrock_data_1.Timeframe.AllTime && "first_played" in data)
+    if (timeframe === hive_bedrock_data_1.Timeframe.AllTime && "first_played" in response)
         data.first_played = response.first_played;
-    if (isLeaderboard && data.id !== hive_bedrock_data_1.Game.ParkourWorlds)
+    if ((isLeaderboard || timeframe !== hive_bedrock_data_1.Timeframe.AllTime) && data.id !== hive_bedrock_data_1.Game.ParkourWorlds)
         data.position = response.human_index;
-    if (isLeaderboard && data.id !== hive_bedrock_data_1.Game.ParkourWorlds)
+    if ((isLeaderboard || timeframe !== hive_bedrock_data_1.Timeframe.AllTime) && data.id !== hive_bedrock_data_1.Game.ParkourWorlds)
         data.username = response.username;
     if (isLeaderboard && data.id !== hive_bedrock_data_1.Game.ParkourWorlds)
         data.UUID = response.UUID;
     return data;
 }
-exports.processors = (_a = {},
+var processors = (_a = {},
     _a[hive_bedrock_data_1.Game.BedWars] = function (response) {
-        var _a, _b, _c, _d, _e, _f, _g;
+        var _a, _b, _c, _d, _e, _f, _g, _h;
         return ({
             id: hive_bedrock_data_1.Game.BedWars,
             xp: (_a = response.xp) !== null && _a !== void 0 ? _a : 0,
@@ -64,6 +59,7 @@ exports.processors = (_a = {},
             kdr: calculateKDR(response.kills, response.deaths),
             final_kills: (_f = response.final_kills) !== null && _f !== void 0 ? _f : 0,
             beds_destroyed: (_g = response.beds_destroyed) !== null && _g !== void 0 ? _g : 0,
+            prestige: (_h = response.prestige) !== null && _h !== void 0 ? _h : 0,
         });
     },
     _a[hive_bedrock_data_1.Game.BlockDrop] = function (response) {
@@ -158,10 +154,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,
@@ -192,7 +188,7 @@ exports.processors = (_a = {},
             win_percentage: calculateWinPercentage(response.victories, response.played),
             deaths: (_d = response.deaths) !== null && _d !== void 0 ? _d : 0,
             hider_kills: (_e = response.hider_kills) !== null && _e !== void 0 ? _e : 0,
-            kdr: calculateKDR(response.hider_kills, response.deaths),
+            kpg: calculateKPG(response.hider_kills, response.played),
             seeker_kills: (_f = response.seeker_kills) !== null && _f !== void 0 ? _f : 0,
         });
     },
@@ -207,14 +203,14 @@ exports.processors = (_a = {},
             win_percentage: calculateWinPercentage(response.victories, response.played),
             murders: (_d = response.murders) !== null && _d !== void 0 ? _d : 0,
             deaths: (_e = response.deaths) !== null && _e !== void 0 ? _e : 0,
-            kdr: calculateKDR(response.murders, response.deaths),
+            edr: calculateKDR(response.murderer_eliminations, response.deaths),
             coins: (_f = response.coins) !== null && _f !== void 0 ? _f : 0,
             murderer_eliminations: (_g = response.murderer_eliminations) !== null && _g !== void 0 ? _g : 0,
             prestige: (_h = response.prestige) !== null && _h !== void 0 ? _h : 0,
         });
     },
     _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,
@@ -228,6 +224,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) {
@@ -317,50 +314,54 @@ exports.processors = (_a = {},
     },
     _a[hive_bedrock_data_1.Game.ParkourWorlds] = function (response) {
         var _a;
-        return ({
-            id: hive_bedrock_data_1.Game.ParkourWorlds,
-            worlds: Object.entries(response.parkours)
-                .filter(function (_a) {
-                var _b = __read(_a, 2), _ = _b[0], value = _b[1];
-                return typeof value === "object";
-            })
-                .map(function (_a) {
-                var _b;
-                var _c = __read(_a, 2), key = _c[0], value = _c[1];
-                return ({
-                    name: key,
-                    parkour_stars: (_b = value.parkour_stars) !== null && _b !== void 0 ? _b : 0,
-                    courses: Object.entries(value)
-                        .filter(function (_a) {
-                        var _b = __read(_a, 2), _ = _b[0], value = _b[1];
-                        return typeof value === "object";
-                    })
-                        .map(function (_a) {
-                        var _b;
-                        var _c = __read(_a, 2), key = _c[0], value = _c[1];
-                        return ({
-                            name: key,
-                            best_run_time: value.best_run_time,
-                            best_checkpoint_times: Object.entries(value.best_checkpoint_times).map(function (_a) {
-                                var _b = __read(_a, 2), key = _b[0], value = _b[1];
-                                return ({
-                                    position: { x: Number(key.split(",")[0]), y: Number(key.split(",")[1]), z: Number(key.split(",")[2]) },
-                                    time: value,
-                                });
-                            }),
-                            collected_stars: value.collected_stars.map(function (value) { return ({
-                                x: Number(value.split(",")[0]),
-                                y: Number(value.split(",")[1]),
-                                z: Number(value.split(",")[2]),
-                            }); }),
-                            course_stars: (_b = value.course_stars) !== null && _b !== void 0 ? _b : 0,
-                        });
-                    }),
-                });
-            }),
-            total_stars: (_a = response.parkours.total_stars) !== null && _a !== void 0 ? _a : 0,
-        });
+        return response.parkours
+            ? {
+                id: hive_bedrock_data_1.Game.ParkourWorlds,
+                worlds: Object.entries(response.parkours)
+                    .filter(function (_a) {
+                    var _b = __read(_a, 2), _ = _b[0], value = _b[1];
+                    return typeof value === "object";
+                })
+                    .map(function (_a) {
+                    var _b;
+                    var _c = __read(_a, 2), key = _c[0], value = _c[1];
+                    return ({
+                        name: key,
+                        parkour_stars: (_b = value.parkour_stars) !== null && _b !== void 0 ? _b : 0,
+                        courses: Object.entries(value)
+                            .filter(function (_a) {
+                            var _b = __read(_a, 2), _ = _b[0], value = _b[1];
+                            return typeof value === "object";
+                        })
+                            .map(function (_a) {
+                            var _b;
+                            var _c = __read(_a, 2), key = _c[0], value = _c[1];
+                            return ({
+                                name: key,
+                                best_run_time: value.best_run_time,
+                                best_checkpoint_times: Object.entries(value.best_checkpoint_times).map(function (_a) {
+                                    var _b = __read(_a, 2), key = _b[0], value = _b[1];
+                                    return ({
+                                        position: { x: Number(key.split(",")[0]), y: Number(key.split(",")[1]), z: Number(key.split(",")[2]) },
+                                        time: value,
+                                    });
+                                }),
+                                collected_stars: value.collected_stars.map(function (value) { return ({
+                                    x: Number(value.split(",")[0]),
+                                    y: Number(value.split(",")[1]),
+                                    z: Number(value.split(",")[2]),
+                                }); }),
+                                course_stars: (_b = value.course_stars) !== null && _b !== void 0 ? _b : 0,
+                            });
+                        }),
+                    });
+                }),
+                total_stars: (_a = response.parkours.total_stars) !== null && _a !== void 0 ? _a : 0,
+            }
+            : null;
     },
+    _a[hive_bedrock_data_1.Game.GhostInvasion] = function (_) { return null; },
+    _a[hive_bedrock_data_1.Game.MobGame] = function (_) { return null; },
     _a);
 function validateNumber(value, def) {
     if (def === void 0) { def = 0; }
@@ -384,6 +385,11 @@ function calculateLosses(played, victories) {
 function calculateTotal(values) {
     return validateNumber(values.reduce(function (a, b) { return (a !== null && a !== void 0 ? a : 0) + (b !== null && b !== void 0 ? b : 0); }, 0));
 }
+function calculateKPG(kills, games) {
+    if (games === 0)
+        return validateNumber(kills !== null && kills !== void 0 ? kills : 0);
+    return roundTo(validateNumber((kills !== null && kills !== void 0 ? kills : 0) / (games !== null && games !== void 0 ? games : 0)), 2);
+}
 function roundTo(value, places) {
     if (places === void 0) { places = 2; }
     return validateNumber(Number(value.toFixed(places)));

package/lib/processors/player.d.ts

@@ -2,6 +2,7 @@ export interface ProcessedPlayerResponse {
     info: {
         uuid: string;
         xuid: string;
+        mcid: string;
         username: string;
         rank: string;
         first_played: number;
@@ -13,26 +14,49 @@ export interface ProcessedPlayerResponse {
         quest_count: number;
     };
     equipped_cosmetics: {
-        costume: string;
-        avatar: {
-            name: string;
-            url: string;
-        };
-        hub_title: string;
-        hat: string;
-        backbling: string;
+        costume: CosmeticResponseTypes[CosmeticType.Costume];
+        avatar: CosmeticResponseTypes[CosmeticType.Avatar];
+        hub_title: CosmeticResponseTypes[CosmeticType.HubTitle];
+        hat: CosmeticResponseTypes[CosmeticType.Hat];
+        backbling: CosmeticResponseTypes[CosmeticType.Backbling];
     };
     owned_cosmetics: {
-        costume: string[];
-        avatar: {
-            name: string;
-            url: string;
-        }[];
-        hub_title: string[];
-        hat: string[];
-        pet: string[];
-        mount: string[];
-        backbling: string[];
+        costume: CosmeticResponseTypes[CosmeticType.Costume][];
+        avatar: CosmeticResponseTypes[CosmeticType.Avatar][];
+        hub_title: CosmeticResponseTypes[CosmeticType.HubTitle][];
+        hat: CosmeticResponseTypes[CosmeticType.Hat][];
+        pet: CosmeticResponseTypes[CosmeticType.Pet][];
+        mount: CosmeticResponseTypes[CosmeticType.Mount][];
+        backbling: CosmeticResponseTypes[CosmeticType.Backbling][];
+    };
+}
+export declare enum CosmeticType {
+    Costume = "costume",
+    Avatar = "avatar",
+    HubTitle = "hub_title",
+    Hat = "hat",
+    Pet = "pet",
+    Mount = "mount",
+    Backbling = "backbling"
+}
+export interface CosmeticResponseTypes {
+    [CosmeticType.Costume]: string;
+    [CosmeticType.Avatar]: {
+        name: string;
+        url: string;
+    };
+    [CosmeticType.HubTitle]: string;
+    [CosmeticType.Hat]: {
+        name: string;
+        icon: string;
+        rarity: string;
+    };
+    [CosmeticType.Pet]: string;
+    [CosmeticType.Mount]: string;
+    [CosmeticType.Backbling]: {
+        name: string;
+        icon: string;
+        rarity: string;
     };
 }
 export default function processPlayerInfo(playerResponse: any): ProcessedPlayerResponse | null;

package/lib/processors/player.js

@@ -1,6 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CosmeticType = void 0;
 exports.default = processPlayerInfo;
+var CosmeticType;
+(function (CosmeticType) {
+    CosmeticType["Costume"] = "costume";
+    CosmeticType["Avatar"] = "avatar";
+    CosmeticType["HubTitle"] = "hub_title";
+    CosmeticType["Hat"] = "hat";
+    CosmeticType["Pet"] = "pet";
+    CosmeticType["Mount"] = "mount";
+    CosmeticType["Backbling"] = "backbling";
+})(CosmeticType || (exports.CosmeticType = CosmeticType = {}));
 function processPlayerInfo(playerResponse) {
     var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
     if (!playerResponse)
@@ -9,6 +20,7 @@ function processPlayerInfo(playerResponse) {
     var info = {
         uuid: player.UUID,
         xuid: player.xuid.toString(),
+        mcid: player.mcid,
         username: player.username_cc,
         rank: player.rank,
         first_played: player.first_played,

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,26 +1,27 @@
-{
-    "name": "hive-bedrock-api",
-    "version": "3.0.0-alpha.9",
-    "description": "An API wrapper for the Hive Minecraft Bedrock Edition server.",
-    "main": "lib/index.js",
-    "types": "lib/index.d.ts",
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/CubeEdge-Studios/hive-bedrock.git"
-    },
-    "license": "MIT",
-    "author": "Cubeedge Studios",
-    "dependencies": {
-        "hive-bedrock-data": "^2.0.0-alpha.6"
-    },
-    "scripts": {
-        "build": "tsc"
-    },
-    "files": [
-        "lib/**/*"
-    ],
-    "devDependencies": {
-        "ts-node": "^10.9.1",
-        "typescript": "^5.1.3"
-    }
-}
+{
+    "name": "hive-bedrock-api",
+    "version": "4.0.1",
+    "description": "An API wrapper for the Hive Minecraft Bedrock Edition server.",
+    "main": "lib/index.js",
+    "types": "lib/index.d.ts",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/CubeEdge-Studios/hive-bedrock.git"
+    },
+    "license": "MIT",
+    "author": "Cubeedge Studios",
+    "dependencies": {
+        "hive-bedrock-data": "^4.0.1"
+    },
+    "scripts": {
+        "build": "tsc"
+    },
+    "files": [
+        "lib/**/*"
+    ],
+    "devDependencies": {
+        "ts-node": "^10.9.1",
+        "typescript": "^5.1.3"
+    },
+    "gitHead": "f865bf66484826cd8d60885b5d5fe94469278015"
+}