Merge branch 'master' of https://git.rainnny.club/Rainnny/RESTfulMC

JS-SDK/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "restfulmc-lib",
-	"version": "1.0.2",
+	"version": "1.0.3",
 	"author": "Braydon (Rainnny) <braydonrainnny@gmail.com>",
 	"description": "A simple, yet useful RESTful API for Minecraft utilizing Springboot.",
 	"keywords": [

JS-SDK/src/index.d.ts

@@ -1,6 +0,0 @@
-export * from "./types/generic";
-export * from "./types/mojang";
-export * from "./types/player";
-export * from "./types/server/bedrock-server";
-export * from "./types/server/java-server";
-export * from "./types/server/server";

JS-SDK/src/index.ts

@@ -1 +1,7 @@
 export * from "@/lib/restfulmc";
+export * from "@/types/error";
+export * from "@/types/mojang";
+export * from "@/types/player";
+export * from "@/types/server/bedrock-server";
+export * from "@/types/server/java-server";
+export * from "@/types/server/server";

JS-SDK/src/lib/restfulmc.ts

@@ -1,8 +1,8 @@
+import { WebRequest } from "@/lib/webRequest";
 import { MojangServerStatus } from "@/types/mojang";
 import { CachedPlayer, SkinPart } from "@/types/player";
 import { CachedBedrockMinecraftServer } from "@/types/server/bedrock-server";
 import { CachedJavaMinecraftServer } from "@/types/server/java-server";
-import { WebRequest } from "@/lib/webRequest";
 import { ServerPlatform } from "@/types/server/server";
 
 /**
@@ -61,9 +61,11 @@ export const getMinecraftServer = (
  * @returns the promised blocked status
  */
 export const isMojangBlocked = (hostname: string): Promise<boolean> =>
-	new WebRequest(`/server/blocked/${hostname}`).execute<{
-		blocked: boolean;
-	}>().then((res) => res.blocked);
+	new WebRequest(`/server/blocked/${hostname}`)
+		.execute<{
+			blocked: boolean;
+		}>()
+		.then((res) => res.blocked);
 
 /**
  * Get the icon of the Java Minecraft

JS-SDK/src/lib/webRequest.ts

@@ -1,4 +1,4 @@
-import { ErrorResponse } from "@/types/generic";
+import { RestfulMCAPIError } from "@/types/error";
 
 const API_ENDPOINT = "https://mc.rainnny.club"; // The API endpoint to use
 
@@ -36,7 +36,7 @@ export class WebRequest {
 				if (response.ok) {
 					resolve(json as T);
 				} else {
-					reject(json as ErrorResponse); // The request failed
+					reject(json as RestfulMCAPIError); // The request failed
 				}
 			} else {
 				// Fallback to an array buffer

JS-SDK/src/types/error.d.ts

@@ -1,7 +1,7 @@
 /**
  * A response representing an error.
  */
-export type ErrorResponse = {
+export type RestfulMCAPIError = {
 	/**
 	 * The status of this error.
 	 */

JS-SDK/test/player.test.ts

@@ -1,5 +1,5 @@
 import { getPlayer, getSkinPart } from "@/index";
-import { ErrorResponse } from "@/types/generic";
+import { RestfulMCAPIError } from "@/types/error";
 import { CachedPlayer, SkinPart } from "@/types/player";
 import { expect, test } from "bun:test";
 
@@ -20,7 +20,7 @@ test("ensurePlayerNotFound", async () => {
 	try {
 		await getPlayer("SDFSDFSDFSDFDDDG"); // Fetch the unknown player
 	} catch (err) {
-		expect((err as ErrorResponse).code).toBe(404);
+		expect((err as RestfulMCAPIError).code).toBe(404);
 	}
 });
 
@@ -32,7 +32,7 @@ test("ensureUsernameIsInvalid", async () => {
 	try {
 		await getPlayer("A"); // Fetch the invalid player
 	} catch (err) {
-		expect((err as ErrorResponse).code).toBe(400);
+		expect((err as RestfulMCAPIError).code).toBe(400);
 	}
 });
 

JS-SDK/test/server.test.ts

@@ -3,7 +3,7 @@ import {
 	getMinecraftServer,
 	isMojangBlocked,
 } from "@/index";
-import { ErrorResponse } from "@/types/generic";
+import { RestfulMCAPIError } from "@/types/error";
 import { CachedBedrockMinecraftServer } from "@/types/server/bedrock-server";
 import { CachedJavaMinecraftServer } from "@/types/server/java-server";
 import { ServerPlatform } from "@/types/server/server";
@@ -41,7 +41,7 @@ test("ensureUnknownHostname", async () => {
 	try {
 		await getMinecraftServer(ServerPlatform.JAVA, "invalid"); // Fetch the unknown server
 	} catch (err) {
-		expect((err as ErrorResponse).code).toBe(400);
+		expect((err as RestfulMCAPIError).code).toBe(400);
 	}
 });
 
@@ -53,7 +53,7 @@ test("ensureUnknownPort", async () => {
 	try {
 		await getMinecraftServer(ServerPlatform.JAVA, "hypixel.net:A"); // Fetch the invalid server
 	} catch (err) {
-		expect((err as ErrorResponse).code).toBe(400);
+		expect((err as RestfulMCAPIError).code).toBe(400);
 	}
 });