hive-bedrock-api 0.1.0-beta.2 → 0.1.0-beta.3

package/README.md

@@ -1,6 +1,6 @@
 # Hive Bedrock API
 
-An API wrapper for the Hive Minecraft Bedrock Edition server. Which allows you to get stats for leaderboards and players.
+An API wrapper for the Hive Minecraft Bedrock Edition server. Which allows you to get stats for leaderboards, players, cosmetics and total unique player counts.
 
 ## Getting started
 
@@ -8,3 +8,92 @@ An API wrapper for the Hive Minecraft Bedrock Edition server. Which allows you t
 $ npm install hive-bedrock-api
 $ yarn add hive-bedrock-api
 ```
+
+## Usage
+
+### Fetch All-Time Player Statistics
+
+```ts
+import { getAllTimeStats, GAME } from "hive-bedrock-api";
+
+// Returns all games
+const { data, player, error } = await getAllTimeStats("ucdfiddes");
+
+// Returns multiple specific games
+const { data, player, error } = await getAllTimeStats("ucdfiddes", [
+    GAME.Deathrun,
+    GAME.TheBridge,
+]);
+
+// Returns a single game
+const { data, error } = await getAllTimeStats("ucdfiddes", GAME.HideAndSeek);
+```
+
+### Fetch Monthly Player Statistics
+
+```ts
+import { getMonthlyStats, GAME } from "hive-bedrock-api";
+
+// Returns all games
+const { data, error } = await getMonthlyStats("ucdfiddes");
+
+// Returns multiple specific games
+const { data, error } = await getMonthlyStats("ucdfiddes", [
+    GAME.Deathrun,
+    GAME.TheBridge,
+]);
+
+// Returns a single game
+const { data, error } = await getMonthlyStats("ucdfiddes", GAME.BlockDrop);
+
+// Returns a single game in a previous month (can return muliple games)
+const { data, error } = await getMonthlyStats("ucdfiddes", GAME.BlockDrop, {
+    year: 2023,
+    month: 1, // January
+});
+```
+
+### Fetch All-Time Leaderboard
+
+```ts
+import { getAllTimeLeaderboard, GAME } from "hive-bedrock-api";
+
+// Returns asingle game
+const { data, error } = await getAllTimeLeaderboard(GAME.TreasureWars);
+```
+
+### Fetch Monthly Leaderboard
+
+```ts
+import { getMonthlyLeaderboard, GAME } from "hive-bedrock-api";
+
+// Returns asingle game
+const { data, error } = await getMonthlyLeaderboard(GAME.TreasureWars);
+
+// Returns a single game from a previous month
+const { data, error } = await getMonthlyLeaderboard(GAME.BlockParty, {
+    year: 2023,
+    month: 11, // November
+    amount: 50,
+    skip: 20, // Sum of skip and amount must be <=100
+});
+```
+
+### Fetch Global Statistics
+
+```ts
+import { getGlobalStatistics } from "hive-bedrock-api";
+
+// Returns unqiue total player counts for different games
+const { data, error } = await getGlobalStatistics();
+```
+
+## API Response Changes
+
+Different API responses are edited by the wrapper to provide more data:
+
+-   Game responses have a new value "id" showing the parent game
+-   "first_played" values are converted into a Date object
+-   A new value for "losses" is provided
+-   A new value for "kdr" is provided
+-   "xp" is converted and a "level" is provided

package/lib/format/gameFormat.d.ts

@@ -7,7 +7,7 @@ interface GameFormat {
 }
 export declare const formats: {
     main: (player: SingleGameFormat) => SingleGameFormat;
-    default: (gameType: GAME, game: SingleGameFormat) => {
+    default: (gameType: GAME, game: SingleGameFormat | null) => {
         id: GAME;
     } | null;
     drop: (game: SingleGameFormat | null) => SingleGameFormat | null;

package/lib/format/gameFormat.js

@@ -41,6 +41,8 @@ exports.formats = (_a = {
             return player;
         },
         default: function (gameType, game) {
+            if (!game)
+                return null;
             if ("index" in game && game.index == 2147483646)
                 return null;
             if ("xp" in game) {
@@ -50,8 +52,10 @@ exports.formats = (_a = {
                 return null;
             if ("first_played" in game)
                 game.first_played = new Date(game.first_played * 1000);
-            if ("played" in game && "victories" in game)
+            if ("played" in game && "victories" in game) {
                 game.losses = game.played - game.victories;
+                game.win_percentage = parseFloat((game.victories / game.played).toFixed(2));
+            }
             if ("kills" in game && "deaths" in game)
                 game.kdr = parseFloat((game.kills / game.deaths).toFixed(2));
             return __assign({ id: gameType }, game);
@@ -73,12 +77,20 @@ exports.formats = (_a = {
         return game;
     },
     _a[GAME_INFO_1.GAME.HideAndSeek] = function (game) {
+        if (!game)
+            return null;
+        if ("hider_kills" in game && "deaths" in game)
+            game.kdr = parseFloat((game.hider_kills / game.deaths).toFixed(2));
         return game;
     },
     _a[GAME_INFO_1.GAME.JustBuild] = function (game) {
         return game;
     },
     _a[GAME_INFO_1.GAME.MurderMystery] = function (game) {
+        if (!game)
+            return null;
+        if ("murders" in game && "deaths" in game)
+            game.kdr = parseFloat((game.murders / game.deaths).toFixed(2));
         return game;
     },
     _a[GAME_INFO_1.GAME.Skywars] = function (game) {

package/lib/index.d.ts

@@ -3,5 +3,7 @@ import getMonthlyLeaderboard from "./methods/getMonthlyLeaderboard";
 import getAllTimeStats from "./methods/getAllTimeStats";
 import getAllTimeLeaderboard from "./methods/getAllTimeLeaderboard";
 import getGlobalStatistics from "./methods/getGlobalStatistics";
-import { GAME as GAMES } from "./types/GAME_INFO";
-export { getAllTimeStats, getAllTimeLeaderboard, getMonthlyStats, getMonthlyLeaderboard, getGlobalStatistics, GAMES, };
+import { AVATAR, RANK } from "./types/API";
+export { getAllTimeStats, getAllTimeLeaderboard, getMonthlyStats, getMonthlyLeaderboard, getGlobalStatistics, AVATAR, RANK, };
+export * from "./types/GAME_INFO";
+export * from "./types/GAMES";

package/lib/index.js

@@ -1,9 +1,23 @@
 "use strict";
+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 __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GAMES = exports.getGlobalStatistics = exports.getMonthlyLeaderboard = exports.getMonthlyStats = exports.getAllTimeLeaderboard = exports.getAllTimeStats = void 0;
+exports.getGlobalStatistics = exports.getMonthlyLeaderboard = exports.getMonthlyStats = exports.getAllTimeLeaderboard = exports.getAllTimeStats = void 0;
 var getMonthlyStats_1 = __importDefault(require("./methods/getMonthlyStats"));
 exports.getMonthlyStats = getMonthlyStats_1.default;
 var getMonthlyLeaderboard_1 = __importDefault(require("./methods/getMonthlyLeaderboard"));
@@ -14,5 +28,5 @@ var getAllTimeLeaderboard_1 = __importDefault(require("./methods/getAllTimeLeade
 exports.getAllTimeLeaderboard = getAllTimeLeaderboard_1.default;
 var getGlobalStatistics_1 = __importDefault(require("./methods/getGlobalStatistics"));
 exports.getGlobalStatistics = getGlobalStatistics_1.default;
-var GAME_INFO_1 = require("./types/GAME_INFO");
-Object.defineProperty(exports, "GAMES", { enumerable: true, get: function () { return GAME_INFO_1.GAME; } });
+__exportStar(require("./types/GAME_INFO"), exports);
+__exportStar(require("./types/GAMES"), exports);

package/lib/methods/getAllTimeLeaderboard.d.ts

@@ -1,4 +1,4 @@
 import { LB_STATS } from "../types/GAMES";
 import { GAME } from "../types/GAME_INFO";
 import { MethodResponse } from "../types/METHODS";
-export default function getAllTimeLeaderboard<G extends GAME>(game: G): Promise<MethodResponse<LB_STATS<G>>>;
+export default function getAllTimeLeaderboard<G extends GAME>(game: G): Promise<MethodResponse<LB_STATS<G>[]>>;

package/lib/methods/getMonthlyLeaderboard.d.ts

@@ -1,10 +1,11 @@
 import { LB_STATS } from "../types/GAMES";
 import { GAME } from "../types/GAME_INFO";
 import { MethodResponse } from "../types/METHODS";
-export default function getMonthlyLeaderboard<G extends GAME>(game: G): Promise<MethodResponse<LB_STATS<G>>>;
+export default function getMonthlyLeaderboard<G extends GAME>(game: G): Promise<MethodResponse<LB_STATS<G>[]>>;
 export default function getMonthlyLeaderboard<G extends GAME>(game: G, options: {
     year?: number;
     month?: number;
+    date?: Date;
     skip?: number;
     amount?: number;
-}): Promise<MethodResponse<LB_STATS<G>>>;
+}): Promise<MethodResponse<LB_STATS<G>[]>>;

package/lib/methods/getMonthlyLeaderboard.js

@@ -83,6 +83,10 @@ function getMonthlyLeaderboard(game, options) {
                     month = (_b = options.month) !== null && _b !== void 0 ? _b : new Date().getMonth() + 1;
                     amount = (_c = options.amount) !== null && _c !== void 0 ? _c : 100;
                     skip = (_d = options.skip) !== null && _d !== void 0 ? _d : 0;
+                    if (options.date) {
+                        year = options.date.getFullYear();
+                        month = options.date.getMonth() + 1;
+                    }
                     _g.label = 6;
                 case 6:
                     _g.trys.push([6, 8, , 9]);

package/lib/methods/getMonthlyStats.d.ts

@@ -6,6 +6,7 @@ export default function getMonthlyStats<G extends GAME>(playerIdentifier: string
 export default function getMonthlyStats<G extends GAME>(playerIdentifier: string, game: G, options: {
     year?: number;
     month?: number;
+    date?: Date;
 }): Promise<MethodResponse<GAME_STATS<BASE_GAME_MONTHLY>[G]>>;
 export default function getMonthlyStats<G extends GAME>(playerIdentifier: string, game: G[]): Promise<MethodResponse<{
     [M in G]: GAME_STATS_ALL<M>;

package/lib/methods/getMonthlyStats.js

@@ -72,17 +72,18 @@ var fetchData_1 = __importDefault(require("./fetchData"));
 function getMonthlyStats(playerIdentifier, game, options) {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function () {
-        var _c, data, error, gameData, filteredGamesEntries, filteredGames, err_1, year, month, _d, data, error, err_2, _e, data, error, err_3, _f, data, error, FILTER_GAMES_1, filteredGamesEntries, filteredGames, err_4;
-        return __generator(this, function (_g) {
-            switch (_g.label) {
+        var _c, data, error, gameData, filteredGamesEntries, filteredGames, err_1, year, month, _d, data, error, gameData, err_2, _e, data, error, gameData, err_3, _f, data, error, FILTER_GAMES_1, filteredGamesEntries, filteredGames, gameData, err_4;
+        var _g, _h;
+        return __generator(this, function (_j) {
+            switch (_j.label) {
                 case 0:
                     if (!!game) return [3 /*break*/, 4];
-                    _g.label = 1;
+                    _j.label = 1;
                 case 1:
-                    _g.trys.push([1, 3, , 4]);
+                    _j.trys.push([1, 3, , 4]);
                     return [4 /*yield*/, (0, fetchData_1.default)("/game/monthly/player/all/".concat(playerIdentifier))];
                 case 2:
-                    _c = _g.sent(), data = _c.data, error = _c.error;
+                    _c = _j.sent(), data = _c.data, error = _c.error;
                     if (error || !data)
                         return [2 /*return*/, {
                                 data: null,
@@ -96,55 +97,71 @@ function getMonthlyStats(playerIdentifier, game, options) {
                     filteredGames = Object.fromEntries(filteredGamesEntries);
                     return [2 /*return*/, { data: filteredGames, error: null }];
                 case 3:
-                    err_1 = _g.sent();
+                    err_1 = _j.sent();
                     console.error(err_1);
                     return [2 /*return*/, { data: null, error: { message: "Failed to fetch data." } }];
                 case 4:
                     if (!(options && typeof game === "string")) return [3 /*break*/, 8];
                     year = (_a = options.year) !== null && _a !== void 0 ? _a : new Date().getFullYear();
                     month = (_b = options.month) !== null && _b !== void 0 ? _b : new Date().getMonth() + 1;
-                    _g.label = 5;
+                    if (options.date) {
+                        year = options.date.getFullYear();
+                        month = options.date.getMonth() + 1;
+                    }
+                    _j.label = 5;
                 case 5:
-                    _g.trys.push([5, 7, , 8]);
+                    _j.trys.push([5, 7, , 8]);
                     return [4 /*yield*/, (0, fetchData_1.default)("/game/monthly/player/".concat(game, "/").concat(playerIdentifier, "/").concat(year, "/").concat(month))];
                 case 6:
-                    _d = _g.sent(), data = _d.data, error = _d.error;
+                    _d = _j.sent(), data = _d.data, error = _d.error;
                     if (error || !data)
                         return [2 /*return*/, {
                                 data: null,
                                 error: __assign({ message: "Failed to fetch data." }, error),
                             }];
-                    return [2 /*return*/, { data: data, error: null }];
+                    gameData = (0, gameFormat_1.default)((_g = {},
+                        _g[game] = data,
+                        _g), true);
+                    return [2 /*return*/, {
+                            data: gameData,
+                            error: null,
+                        }];
                 case 7:
-                    err_2 = _g.sent();
+                    err_2 = _j.sent();
                     console.error(err_2);
                     return [2 /*return*/, { data: null, error: { message: "Failed to fetch data." } }];
                 case 8:
                     if (!(typeof game === "string")) return [3 /*break*/, 12];
-                    _g.label = 9;
+                    _j.label = 9;
                 case 9:
-                    _g.trys.push([9, 11, , 12]);
+                    _j.trys.push([9, 11, , 12]);
                     return [4 /*yield*/, (0, fetchData_1.default)("/game/monthly/player/".concat(game, "/").concat(playerIdentifier))];
                 case 10:
-                    _e = _g.sent(), data = _e.data, error = _e.error;
+                    _e = _j.sent(), data = _e.data, error = _e.error;
                     if (error || !data)
                         return [2 /*return*/, {
                                 data: null,
                                 error: __assign({ message: "Failed to fetch data." }, error),
                             }];
-                    return [2 /*return*/, { data: data, error: null }];
+                    gameData = (0, gameFormat_1.default)((_h = {},
+                        _h[game] = data,
+                        _h), true);
+                    return [2 /*return*/, {
+                            data: gameData,
+                            error: null,
+                        }];
                 case 11:
-                    err_3 = _g.sent();
+                    err_3 = _j.sent();
                     console.error(err_3);
                     return [2 /*return*/, { data: null, error: { message: "Failed to fetch data." } }];
                 case 12:
                     if (!Array.isArray(game)) return [3 /*break*/, 16];
-                    _g.label = 13;
+                    _j.label = 13;
                 case 13:
-                    _g.trys.push([13, 15, , 16]);
+                    _j.trys.push([13, 15, , 16]);
                     return [4 /*yield*/, (0, fetchData_1.default)("/game/monthly/player/all/".concat(playerIdentifier))];
                 case 14:
-                    _f = _g.sent(), data = _f.data, error = _f.error;
+                    _f = _j.sent(), data = _f.data, error = _f.error;
                     if (error || !data)
                         return [2 /*return*/, {
                                 data: null,
@@ -156,9 +173,10 @@ function getMonthlyStats(playerIdentifier, game, options) {
                         return FILTER_GAMES_1.includes(key);
                     });
                     filteredGames = Object.fromEntries(filteredGamesEntries);
-                    return [2 /*return*/, { data: filteredGames, error: null }];
+                    gameData = (0, gameFormat_1.default)(filteredGames);
+                    return [2 /*return*/, { data: gameData, error: null }];
                 case 15:
-                    err_4 = _g.sent();
+                    err_4 = _j.sent();
                     console.error(err_4);
                     return [2 /*return*/, { data: null, error: { message: "Failed to fetch data." } }];
                 case 16: return [2 /*return*/, { data: null, error: { message: "Failed to detect game type." } }];

package/lib/types/GAMES.d.ts

@@ -27,12 +27,23 @@ export type LB_STATS<G extends GAME> = GAME_STATS<BASE_LB>[G];
 export type GAME_STATS_ALL<G extends GAME> = GAME_STATS<BASE_GAME_ALL>[G];
 export type GAME_STATS_MONTHLY<G extends GAME> = GAME_STATS<BASE_GAME_MONTHLY>[G];
 export interface BASE_LB extends API_BASE_LB {
+    id: GAME;
+    level: number;
+    losses: number;
+    win_percentage: number;
 }
 export interface BASE_GAME_ALL extends Omit<API_BASE_GAME_ALL, "first_played"> {
     id: GAME;
+    level: number;
+    losses: number;
     first_played: Date;
+    win_percentage: number;
 }
 export interface BASE_GAME_MONTHLY extends API_BASE_GAME_MONTHLY {
+    id: GAME;
+    level: number;
+    losses: number;
+    win_percentage: number;
 }
 export interface USER_MAIN extends Omit<API_USER_MAIN, "first_played"> {
     first_played: Date;
@@ -40,24 +51,32 @@ export interface USER_MAIN extends Omit<API_USER_MAIN, "first_played"> {
 export interface GAME_HIDE extends API_GAME_HIDE {
 }
 export interface GAME_DR extends API_GAME_DR {
+    kdr: number;
 }
 export interface GAME_WARS extends API_GAME_WARS {
+    kdr: number;
 }
 export interface GAME_MURDER extends API_GAME_MURDER {
+    kdr: number;
 }
 export interface GAME_SG extends API_GAME_SG {
+    kdr: number;
 }
 export interface GAME_SKY extends API_GAME_SKY {
+    kdr: number;
 }
 export interface GAME_CTF extends API_GAME_CTF {
+    kdr: number;
 }
 export interface GAME_DROP extends API_GAME_DROP {
 }
 export interface GAME_GROUND extends API_GAME_GROUND {
+    kdr: number;
 }
 export interface GAME_BUILD extends API_GAME_BUILD {
 }
 export interface GAME_PARTY extends API_GAME_PARTY {
 }
 export interface GAME_BRIDGE extends API_GAME_BRIDGE {
+    kdr: number;
 }

package/lib/types/GAME_INFO.d.ts

@@ -13,6 +13,7 @@ export declare enum GAME {
     TheBridge = "bridge"
 }
 interface GAME_INFO_TYPE {
+    id: string;
     maxLevel: number;
     increment: number;
     incrementCap: number | null;

package/lib/types/GAME_INFO.js

@@ -1,4 +1,5 @@
 "use strict";
+var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GAME_INFO = exports.GAME = void 0;
 var GAME;
@@ -16,77 +17,89 @@ var GAME;
     GAME["BlockParty"] = "party";
     GAME["TheBridge"] = "bridge";
 })(GAME || (exports.GAME = GAME = {}));
-exports.GAME_INFO = {
-    wars: {
+exports.GAME_INFO = (_a = {},
+    _a[GAME.TreasureWars] = {
+        id: GAME.TreasureWars,
         maxLevel: 100,
         increment: 150,
         incrementCap: 52,
         prestige: true,
     },
-    dr: {
+    _a[GAME.DeathRun] = {
+        id: GAME.DeathRun,
         maxLevel: 75,
         increment: 200,
         incrementCap: 42,
         prestige: false,
     },
-    hide: {
+    _a[GAME.HideAndSeek] = {
+        id: GAME.HideAndSeek,
         maxLevel: 50,
         increment: 100,
         incrementCap: null,
         prestige: false,
     },
-    murder: {
+    _a[GAME.MurderMystery] = {
+        id: GAME.MurderMystery,
         maxLevel: 100,
         increment: 100,
         incrementCap: 82,
         prestige: true,
     },
-    sg: {
+    _a[GAME.SurvivalGames] = {
+        id: GAME.SurvivalGames,
         maxLevel: 30,
         increment: 150,
         incrementCap: null,
         prestige: false,
     },
-    sky: {
+    _a[GAME.Skywars] = {
+        id: GAME.Skywars,
         maxLevel: 75,
         increment: 150,
         incrementCap: 52,
         prestige: false,
     },
-    build: {
+    _a[GAME.JustBuild] = {
+        id: GAME.JustBuild,
         maxLevel: 20,
         increment: 100,
         incrementCap: null,
         prestige: false,
     },
-    ground: {
+    _a[GAME.GroundWars] = {
+        id: GAME.GroundWars,
         maxLevel: 20,
         increment: 150,
         incrementCap: null,
         prestige: false,
     },
-    drop: {
+    _a[GAME.BlockDrop] = {
+        id: GAME.BlockDrop,
         maxLevel: 25,
         increment: 150,
         incrementCap: 22,
         prestige: false,
     },
-    ctf: {
+    _a[GAME.CaptureTheFlag] = {
+        id: GAME.CaptureTheFlag,
         maxLevel: 20,
         increment: 150,
         incrementCap: null,
         prestige: false,
     },
-    party: {
+    _a[GAME.BlockParty] = {
+        id: GAME.BlockParty,
         maxLevel: 25,
         increment: 150,
         incrementCap: null,
         prestige: false,
     },
-    bridge: {
+    _a[GAME.TheBridge] = {
+        id: GAME.TheBridge,
         maxLevel: 20,
         increment: 0,
         incrementCap: null,
         prestige: false,
     },
-};
+    _a);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "hive-bedrock-api",
-    "version": "0.1.0-beta.2",
+    "version": "0.1.0-beta.3",
     "description": "An API wrapper for the Hive Minecraft Bedrock Edition server.",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
@@ -12,12 +12,18 @@
     "author": "Cubeedge Studios",
     "dependencies": {},
     "scripts": {
-        "build": "tsc"
+        "build": "tsc",
+        "test": "jest"
     },
     "files": [
         "lib/**/*"
     ],
     "devDependencies": {
+        "@types/jest": "^29.5.2",
+        "jest": "^29.5.0",
+        "jest-extended": "^4.0.0",
+        "ts-jest": "^29.1.0",
+        "ts-node": "^10.9.1",
         "typescript": "^5.1.3"
     }
 }