hive-bedrock-api 2.1.8 → 2.1.10-alpha.0

package/README.md

@@ -1,136 +1,136 @@
-# Hive Bedrock API
-
-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.
-
-## Getting started
-
-```bash
-$ npm install hive-bedrock-api
-$ yarn add hive-bedrock-api
-```
-
-## Usage
-
-See [API.md](docs/API.md) for detailed documentation.
-
-### Fetch Player Infomation
-
-```ts
-import { getPlayerInformation } from "hive-bedrock-api";
-
-// Returns player, cosmetics, server statistics and profile infomation
-const { data, error } = await getPlayerInformation("player");
-```
-
-### Fetch All-Time Player Statistics
-
-```ts
-import { getAllTimeStatistics, Game } from "hive-bedrock-api";
-
-// Returns all games
-const { data, error } = await getAllTimeStats("player");
-
-// Returns a single game
-const { data, error } = await getAllTimeStats("player", Game.HideAndSeek);
-```
-
-### Fetch Season Player Statistics
-
-```ts
-import { getSeasonStatistics, Game } from "hive-bedrock-api";
-
-// Returns a game statistics
-const { data, error } = await getSeasonStatistics("player", Game.BedWars);
-```
-
-### Fetch Monthly Player Statistics
-
-```ts
-import { getMonthlyStatistics, Game } from "hive-bedrock-api";
-
-// Returns all games
-const { data, error } = await getMonthlyStats("player");
-
-// Returns a single game
-const { data, error } = await getMonthlyStats("player", Game.BlockDrop);
-
-// Returns a single game in a previous month (can return muliple games)
-const { data, error } = await getMonthlyStats("player", Game.BlockDrop, {
-    year: 2023,
-    month: 1, // January
-});
-```
-
-### Fetch All-Time Leaderboard
-
-```ts
-import { getAllTimeLeaderboard, Game } from "hive-bedrock-api";
-
-// Returns a single game
-const { data, error } = await getAllTimeLeaderboard(Game.TreasureWars);
-```
-
-### Fetch Season Leaderboard
-
-```ts
-import { getSeasonLeaderboard, Game } from "hive-bedrock-api";
-
-// Returns a single game
-const { data, error } = await getSeasonLeaderboard(Game.BedWars);
-```
-
-### Fetch Monthly Leaderboard
-
-```ts
-import { getMonthlyLeaderboard, Game } from "hive-bedrock-api";
-
-// Returns a single 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();
-```
-
-### 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);
-```
-
-### Fetch Metadata
-
-```ts
-import { getMetadata, Game } from "hive-bedrock-api";
-
-// Returns data for a specific game's currently active maps
-const { data, error } = await getMetadata(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
--   A new value for "losses" is provided
--   A new value for "kdr" is provided
--   "xp" is converted and a "level" is provided
--   "total_ratings" for just build is provided
-
-See [API.md](docs/API.md#game-statistics-types) for specific fields and their corresponding types per game.
+# Hive Bedrock API
+
+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.
+
+## Getting started
+
+```bash
+$ npm install hive-bedrock-api
+$ yarn add hive-bedrock-api
+```
+
+## Usage
+
+See [API.md](docs/API.md) for detailed documentation.
+
+### Fetch Player Infomation
+
+```ts
+import { getPlayerInformation } from "hive-bedrock-api";
+
+// Returns player, cosmetics, server statistics and profile infomation
+const { data, error } = await getPlayerInformation("player");
+```
+
+### Fetch All-Time Player Statistics
+
+```ts
+import { getAllTimeStatistics, Game } from "hive-bedrock-api";
+
+// Returns all games
+const { data, error } = await getAllTimeStats("player");
+
+// Returns a single game
+const { data, error } = await getAllTimeStats("player", Game.HideAndSeek);
+```
+
+### Fetch Season Player Statistics
+
+```ts
+import { getSeasonStatistics, Game } from "hive-bedrock-api";
+
+// Returns a game statistics
+const { data, error } = await getSeasonStatistics("player", Game.BedWars);
+```
+
+### Fetch Monthly Player Statistics
+
+```ts
+import { getMonthlyStatistics, Game } from "hive-bedrock-api";
+
+// Returns all games
+const { data, error } = await getMonthlyStats("player");
+
+// Returns a single game
+const { data, error } = await getMonthlyStats("player", Game.BlockDrop);
+
+// Returns a single game in a previous month (can return muliple games)
+const { data, error } = await getMonthlyStats("player", Game.BlockDrop, {
+    year: 2023,
+    month: 1, // January
+});
+```
+
+### Fetch All-Time Leaderboard
+
+```ts
+import { getAllTimeLeaderboard, Game } from "hive-bedrock-api";
+
+// Returns a single game
+const { data, error } = await getAllTimeLeaderboard(Game.TreasureWars);
+```
+
+### Fetch Season Leaderboard
+
+```ts
+import { getSeasonLeaderboard, Game } from "hive-bedrock-api";
+
+// Returns a single game
+const { data, error } = await getSeasonLeaderboard(Game.BedWars);
+```
+
+### Fetch Monthly Leaderboard
+
+```ts
+import { getMonthlyLeaderboard, Game } from "hive-bedrock-api";
+
+// Returns a single 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();
+```
+
+### 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);
+```
+
+### Fetch Metadata
+
+```ts
+import { getMetadata, Game } from "hive-bedrock-api";
+
+// Returns data for a specific game's currently active maps
+const { data, error } = await getMetadata(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
+-   A new value for "losses" is provided
+-   A new value for "kdr" is provided
+-   "xp" is converted and a "level" is provided
+-   "total_ratings" for just build is provided
+
+See [API.md](docs/API.md#game-statistics-types) for specific fields and their corresponding types per game.

package/lib/helpers/fetchEndpoint.js

@@ -9,8 +9,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 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;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["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.");

package/lib/methods/getAllTimeLeaderboard.js

@@ -20,8 +20,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 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;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["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.");

package/lib/methods/getAllTimeStatistics.js

@@ -20,8 +20,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 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;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["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.");

package/lib/methods/getGlobalStatistics.js

@@ -9,8 +9,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 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;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["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.");

package/lib/methods/getMaps.js

@@ -20,8 +20,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 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;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["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.");

package/lib/methods/getMetadata.js

@@ -20,8 +20,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 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;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["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.");

package/lib/methods/getMonthlyLeaderboard.js

@@ -20,8 +20,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 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;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["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.");

package/lib/methods/getMonthlyStatistics.js

@@ -20,8 +20,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 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;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["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.");

package/lib/methods/getPlayerInfomation.js

@@ -20,8 +20,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 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;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["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.");

package/lib/methods/getSeasonLeaderboard.js

@@ -20,8 +20,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 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;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["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.");

package/lib/methods/getSeasonStatistics.js

@@ -20,8 +20,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 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;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["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.");

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "hive-bedrock-api",
-    "version": "2.1.8",
+    "version": "2.1.10-alpha.0",
     "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": "^1.2.5"
+        "hive-bedrock-data": "^1.2.6-alpha.0"
     },
     "scripts": {
         "build": "tsc"
@@ -22,5 +22,6 @@
     "devDependencies": {
         "ts-node": "^10.9.1",
         "typescript": "^5.1.3"
-    }
+    },
+    "gitHead": "ff428fe165eb3035cb801ffc9613d669c5437437"
 }