hive-bedrock-api 1.0.2 → 1.0.4

package/README.md

@@ -31,10 +31,7 @@ import { getAllTimeStats, GAME } from "hive-bedrock-api";
 const { data, player, error } = await getAllTimeStats("ucdfiddes");
 
 // Returns multiple specific games
-const { data, player, error } = await getAllTimeStats("ucdfiddes", [
-    GAME.Deathrun,
-    GAME.TheBridge,
-]);
+const { data, player, error } = await getAllTimeStats("ucdfiddes", [GAME.Deathrun, GAME.TheBridge]);
 
 // Returns a single game
 const { data, error } = await getAllTimeStats("ucdfiddes", GAME.HideAndSeek);
@@ -49,25 +46,22 @@ import { getMonthlyStats, GAME } from "hive-bedrock-api";
 const { data, error } = await getMonthlyStats("ucdfiddes");
 
 // Returns multiple specific games
-const { data, error } = await getMonthlyStats("ucdfiddes", [
-    GAME.Deathrun,
-    GAME.TheBridge,
-]);
+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
+  year: 2023,
+  month: 1, // January
 });
 
 // Same as before, but with a Date object
 const previousMonth = new Date();
 previousMonth.setMonth(0); // January
 const { data, error } = await getMonthlyStats("ucdfiddes", GAME.BlockDrop, {
-    date: previousMonth,
+  date: previousMonth,
 });
 ```
 
@@ -90,10 +84,10 @@ 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
+  year: 2023,
+  month: 11, // November
+  amount: 50,
+  skip: 20, // Sum of skip and amount must be <=100
 });
 ```
 
@@ -106,14 +100,23 @@ import { getGlobalStatistics } from "hive-bedrock-api";
 const { data, error } = await getGlobalStatistics();
 ```
 
+### Fetch Maps
+
+```ts
+import { getMaps, GAME } from "hive-bedrock-api";
+
+// Returns data for a specific game's currently active maps
+const { data, error } = await getMaps(GAME.TreasureWars);
+```
+
 ## 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
+- 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
 
 See [API.md](docs/API.md#game-statistics-types) for specific fields and their corresponding types per game.

package/lib/index.d.ts

@@ -4,7 +4,8 @@ import getAllTimeStats from "./methods/getAllTimeStats";
 import getAllTimeLeaderboard from "./methods/getAllTimeLeaderboard";
 import getGlobalStatistics from "./methods/getGlobalStatistics";
 import getPlayerInfo from "./methods/getPlayerInfo";
-import { AVATAR, RANK } from "./types/API";
-export { getAllTimeStats, getAllTimeLeaderboard, getMonthlyStats, getMonthlyLeaderboard, getGlobalStatistics, getPlayerInfo, AVATAR, RANK, };
+import getMaps from "./methods/getMaps";
+import { AVATAR, RANK, MAP_SEASON, MAP_VARIANT } from "./types/API";
+export { getAllTimeStats, getAllTimeLeaderboard, getMonthlyStats, getMonthlyLeaderboard, getGlobalStatistics, getPlayerInfo, getMaps, AVATAR, RANK, MAP_SEASON, MAP_VARIANT, };
 export * from "./types/GAME_INFO";
 export * from "./types/GAMES";

package/lib/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPlayerInfo = exports.getGlobalStatistics = exports.getMonthlyLeaderboard = exports.getMonthlyStats = exports.getAllTimeLeaderboard = exports.getAllTimeStats = void 0;
+exports.MAP_VARIANT = exports.MAP_SEASON = exports.RANK = exports.getMaps = exports.getPlayerInfo = 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"));
@@ -30,5 +30,11 @@ var getGlobalStatistics_1 = __importDefault(require("./methods/getGlobalStatisti
 exports.getGlobalStatistics = getGlobalStatistics_1.default;
 var getPlayerInfo_1 = __importDefault(require("./methods/getPlayerInfo"));
 exports.getPlayerInfo = getPlayerInfo_1.default;
+var getMaps_1 = __importDefault(require("./methods/getMaps"));
+exports.getMaps = getMaps_1.default;
+var API_1 = require("./types/API");
+Object.defineProperty(exports, "RANK", { enumerable: true, get: function () { return API_1.RANK; } });
+Object.defineProperty(exports, "MAP_SEASON", { enumerable: true, get: function () { return API_1.MAP_SEASON; } });
+Object.defineProperty(exports, "MAP_VARIANT", { enumerable: true, get: function () { return API_1.MAP_VARIANT; } });
 __exportStar(require("./types/GAME_INFO"), exports);
 __exportStar(require("./types/GAMES"), exports);

package/lib/methods/fetchData.d.ts

@@ -1,5 +1,5 @@
-import { API_BASE_GAME_ALL, API_BASE_GAME_MONTHLY, API_GAME_STATS, API_GLOBAL_STATISTICS, API_REQUEST_ALL, API_REQUEST_LB } from "../types/API";
-import { GAME_LB_ALLTIME_ENDPOINT, GAME_LB_MONTHLY_ENDPOINT, GAME_LB_SPECIFIC_MONTHLY_ENDPOINT, GLOBAL_STATISTICS_ENDPOINT, PLAYER_ALLTIME_ENDPOINT, PLAYER_LB_SPECIFIC_MONTHLY_ENDPOINT, PLAYER_MONTHLY_ENDPOINT } from "../types/ENDPOINTS";
+import { API_BASE_GAME_ALL, API_BASE_GAME_MONTHLY, API_GAME_STATS, API_GLOBAL_STATISTICS, API_MAP, API_REQUEST_ALL, API_REQUEST_LB } from "../types/API";
+import { GAME_LB_ALLTIME_ENDPOINT, GAME_LB_MONTHLY_ENDPOINT, GAME_LB_SPECIFIC_MONTHLY_ENDPOINT, GAME_MAPS_ENDPOINT, GLOBAL_STATISTICS_ENDPOINT, PLAYER_ALLTIME_ENDPOINT, PLAYER_LB_SPECIFIC_MONTHLY_ENDPOINT, PLAYER_MONTHLY_ENDPOINT } from "../types/ENDPOINTS";
 import { USER_MAIN } from "../types/GAMES";
 import { GAME } from "../types/GAME_INFO";
 import { MethodResponse } from "../types/METHODS";
@@ -21,3 +21,4 @@ export default function fetchData<G extends GAME>(endpoint: GAME_LB_MONTHLY_ENDP
 export default function fetchData<G extends GAME>(endpoint: PLAYER_LB_SPECIFIC_MONTHLY_ENDPOINT<G, string, number, number, number, number>, options?: FetchOptions): Promise<MethodResponse<API_REQUEST_LB<G>>>;
 export default function fetchData<G extends GAME>(endpoint: GAME_LB_SPECIFIC_MONTHLY_ENDPOINT<G, number, number, number, number>, options?: FetchOptions): Promise<MethodResponse<API_REQUEST_LB<G>>>;
 export default function fetchData(endpoint: GLOBAL_STATISTICS_ENDPOINT, options?: FetchOptions): Promise<MethodResponse<API_GLOBAL_STATISTICS>>;
+export default function fetchData<G extends GAME>(endpoint: GAME_MAPS_ENDPOINT<G>, options?: FetchOptions): Promise<MethodResponse<API_MAP[]>>;

package/lib/methods/getAllTimeStats.d.ts

@@ -2,7 +2,7 @@ import { Options } from "../types/API";
 import { BASE_GAME_ALL, GAME_STATS, GAME_STATS_ALL, REQUEST_ALL, USER_MAIN } from "../types/GAMES";
 import { GAME } from "../types/GAME_INFO";
 import { MethodResponse } from "../types/METHODS";
-export default function getAllTimeStats(playerIdentifier: string, options?: Options): Promise<MethodResponse<Omit<REQUEST_ALL, "main">> & {
+export default function getAllTimeStats(playerIdentifier: string): Promise<MethodResponse<Omit<REQUEST_ALL, "main">> & {
     player: USER_MAIN;
 }>;
 export default function getAllTimeStats<G extends GAME>(playerIdentifier: string, game: G, options?: Options): Promise<MethodResponse<GAME_STATS<BASE_GAME_ALL>[G]>>;

package/lib/methods/getMaps.d.ts

@@ -0,0 +1,4 @@
+import { API_MAP, Options } from "../types/API";
+import { GAME } from "../types/GAME_INFO";
+import { MethodResponse } from "../types/METHODS";
+export default function getMaps(game: GAME, options?: Options): Promise<MethodResponse<API_MAP[]>>;

package/lib/methods/getMaps.js

@@ -0,0 +1,101 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var GAME_INFO_1 = require("../types/GAME_INFO");
+var fetchData_1 = __importDefault(require("./fetchData"));
+var VALID_GAMES = [
+    GAME_INFO_1.GAME.BlockDrop,
+    GAME_INFO_1.GAME.CaptureTheFlag,
+    GAME_INFO_1.GAME.DeathRun,
+    GAME_INFO_1.GAME.Gravity,
+    GAME_INFO_1.GAME.GroundWars,
+    GAME_INFO_1.GAME.HideAndSeek,
+    GAME_INFO_1.GAME.MurderMystery,
+    GAME_INFO_1.GAME.Skywars,
+    GAME_INFO_1.GAME.SurvivalGames,
+    GAME_INFO_1.GAME.TreasureWars,
+];
+function getMaps(game, options) {
+    return __awaiter(this, void 0, void 0, function () {
+        var _a, data, error, err_1;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    if (!VALID_GAMES.includes(game))
+                        return [2 /*return*/, {
+                                data: null,
+                                error: {
+                                    message: "This game does not support this endpoint as it only has one map.",
+                                },
+                            }];
+                    _b.label = 1;
+                case 1:
+                    _b.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, (0, fetchData_1.default)("/game/map/".concat(game), options === null || options === void 0 ? void 0 : options.fetch)];
+                case 2:
+                    _a = _b.sent(), data = _a.data, error = _a.error;
+                    if (error || !data)
+                        return [2 /*return*/, {
+                                data: null,
+                                error: __assign({ message: "Failed to fetch data." }, error),
+                            }];
+                    return [2 /*return*/, { data: data, error: null }];
+                case 3:
+                    err_1 = _b.sent();
+                    console.error(err_1);
+                    return [2 /*return*/, { data: null, error: { message: "Failed to fetch data." } }];
+                case 4: return [2 /*return*/];
+            }
+        });
+    });
+}
+exports.default = getMaps;

package/lib/types/API.d.ts

@@ -14,7 +14,36 @@ export interface API_ERROR {
 export interface Options {
     fetch?: FetchOptions;
 }
-export type RANK = "REGULAR" | "PLUS" | "YOUTUBER" | "STREAMER" | "TIKTOK" | "VIP" | "HELPER" | "MODERATOR" | "HIVE_TEAM" | "STAFF_MANAGER" | "COMMUNITY_MANAGER" | "OWNER";
+export declare enum MAP_SEASON {
+    None = "NO_SEASON",
+    Winter = "WINTERFEST",
+    Spring = "SPRING",
+    Summer = "SUMMER",
+    Halloween = "HALLOWEEN",
+    Autumn = "AUTUMN"
+}
+export declare enum MAP_VARIANT {
+    Regular = "REGULAR",
+    Duos = "DUOS",
+    Trios = "TRIOS",
+    Squads = "SQUADS",
+    Mega = "MEGA",
+    Royale = "ROYALE"
+}
+export declare enum RANK {
+    Regular = "REGULAR",
+    Plus = "PLUS",
+    Youtuber = "YOUTUBER",
+    Streamer = "STREAMER",
+    Tiktok = "TIKTOK",
+    VIP = "VIP",
+    Helper = "HELPER",
+    Moderator = "MODERATOR",
+    Hive = "HIVE_TEAM",
+    StaffManager = "STAFF_MANAGER",
+    CommunityManager = "COMMUNITY_MANAGER",
+    Owner = "OWNER"
+}
 export type API_REQUEST_ALL = {
     [G in GAME]: API_GAME_STATS_ALL<G>;
 } & {
@@ -53,6 +82,12 @@ export interface API_GLOBAL_STATISTICS {
         main: number;
     };
 }
+export interface API_MAP {
+    name: string;
+    season: MAP_SEASON;
+    variant: MAP_VARIANT;
+    image: string;
+}
 export interface API_BASE_GAME_ALL {
     UUID: string;
     xp: number;
@@ -93,6 +128,9 @@ export interface API_USER_MAIN {
     equipped_avatar: AVATAR | null;
     quest_count: number;
     paid_ranks: RANK[];
+    pets: string[];
+    mounts: string[];
+    hats: string[];
 }
 export interface API_GAME_HIDE {
     deaths: number;

package/lib/types/API.js

@@ -1,3 +1,37 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.RANK = exports.MAP_VARIANT = exports.MAP_SEASON = void 0;
 var GAME_INFO_1 = require("./GAME_INFO");
+var MAP_SEASON;
+(function (MAP_SEASON) {
+    MAP_SEASON["None"] = "NO_SEASON";
+    MAP_SEASON["Winter"] = "WINTERFEST";
+    MAP_SEASON["Spring"] = "SPRING";
+    MAP_SEASON["Summer"] = "SUMMER";
+    MAP_SEASON["Halloween"] = "HALLOWEEN";
+    MAP_SEASON["Autumn"] = "AUTUMN";
+})(MAP_SEASON || (exports.MAP_SEASON = MAP_SEASON = {}));
+var MAP_VARIANT;
+(function (MAP_VARIANT) {
+    MAP_VARIANT["Regular"] = "REGULAR";
+    MAP_VARIANT["Duos"] = "DUOS";
+    MAP_VARIANT["Trios"] = "TRIOS";
+    MAP_VARIANT["Squads"] = "SQUADS";
+    MAP_VARIANT["Mega"] = "MEGA";
+    MAP_VARIANT["Royale"] = "ROYALE";
+})(MAP_VARIANT || (exports.MAP_VARIANT = MAP_VARIANT = {}));
+var RANK;
+(function (RANK) {
+    RANK["Regular"] = "REGULAR";
+    RANK["Plus"] = "PLUS";
+    RANK["Youtuber"] = "YOUTUBER";
+    RANK["Streamer"] = "STREAMER";
+    RANK["Tiktok"] = "TIKTOK";
+    RANK["VIP"] = "VIP";
+    RANK["Helper"] = "HELPER";
+    RANK["Moderator"] = "MODERATOR";
+    RANK["Hive"] = "HIVE_TEAM";
+    RANK["StaffManager"] = "STAFF_MANAGER";
+    RANK["CommunityManager"] = "COMMUNITY_MANAGER";
+    RANK["Owner"] = "OWNER";
+})(RANK || (exports.RANK = RANK = {}));

package/lib/types/ENDPOINTS.d.ts

@@ -6,4 +6,5 @@ export type GAME_LB_MONTHLY_ENDPOINT<G extends GAME> = `/game/monthly/${G}`;
 export type PLAYER_LB_SPECIFIC_MONTHLY_ENDPOINT<G extends GAME, ID extends string, Y extends number, M extends number, A extends number, S extends number> = `/game/monthly/player/${G}/${ID}/${Y}/${M}/${A}/${S}`;
 export type GAME_LB_SPECIFIC_MONTHLY_ENDPOINT<G extends GAME, Y extends number, M extends number, A extends number, S extends number> = `/game/monthly/${G}/${Y}/${M}/${A}/${S}`;
 export type GLOBAL_STATISTICS_ENDPOINT = `/global/statistics`;
-export type ENDPOINTS<G extends GAME> = PLAYER_ALLTIME_ENDPOINT<"all", string> | PLAYER_ALLTIME_ENDPOINT<G, string> | PLAYER_MONTHLY_ENDPOINT<"all", string> | PLAYER_MONTHLY_ENDPOINT<G, string> | GAME_LB_ALLTIME_ENDPOINT<G> | GAME_LB_MONTHLY_ENDPOINT<G> | PLAYER_LB_SPECIFIC_MONTHLY_ENDPOINT<G, string, number, number, number, number> | GAME_LB_SPECIFIC_MONTHLY_ENDPOINT<GAME, number, number, number, number> | GLOBAL_STATISTICS_ENDPOINT;
+export type GAME_MAPS_ENDPOINT<G extends GAME> = `/game/map/${G}`;
+export type ENDPOINTS<G extends GAME> = PLAYER_ALLTIME_ENDPOINT<"all", string> | PLAYER_ALLTIME_ENDPOINT<G, string> | PLAYER_MONTHLY_ENDPOINT<"all", string> | PLAYER_MONTHLY_ENDPOINT<G, string> | GAME_LB_ALLTIME_ENDPOINT<G> | GAME_LB_MONTHLY_ENDPOINT<G> | PLAYER_LB_SPECIFIC_MONTHLY_ENDPOINT<G, string, number, number, number, number> | GAME_LB_SPECIFIC_MONTHLY_ENDPOINT<GAME, number, number, number, number> | GLOBAL_STATISTICS_ENDPOINT | GAME_MAPS_ENDPOINT<G>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "hive-bedrock-api",
-    "version": "1.0.2",
+    "version": "1.0.4",
     "description": "An API wrapper for the Hive Minecraft Bedrock Edition server.",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",