mcutils-js-api 2.0.18 → 2.0.20

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import type { BedrockServer } from "./types/server/impl/bedrock-server";
 import type { JavaServer } from "./types/server/impl/java-server";
 import type { CachedPlayer } from "./types/cache/cached-player";
 import type { CachedPlayerName } from "./types/cache/cached-player-name";
+import type { CapeData } from "./types/player/cape/cape";
 import { ServerType } from "./types/server/server";
 export declare class McUtilsAPI {
     private readonly endpoint;
@@ -131,6 +132,15 @@ export declare class McUtilsAPI {
         image?: ArrayBuffer;
         error?: ErrorResponse;
     }>;
+    /**
+     * Fetch the list of available capes (e.g. Migrator).
+     *
+     * @returns the list of cape data or the error (if one occurred)
+     */
+    fetchCapes(): Promise<{
+        capes?: CapeData[];
+        error?: ErrorResponse;
+    }>;
     /**
      * Fetch a cape texture image.
      *

package/dist/index.js

@@ -20,7 +20,7 @@ export class McUtilsAPI {
      * @returns the server or the error (if one occurred)
      */
     async fetchServer(host, type) {
-        const response = await fetch(`${this.endpoint}/server/${type}/${host}`);
+        const response = await fetch(`${this.endpoint}/servers/${type}/${host}`);
         if (response.ok) {
             return {
                 server: (await response.json()),
@@ -37,7 +37,7 @@ export class McUtilsAPI {
      * @returns the server or the error (if one occurred)
      */
     async fetchJavaServer(host) {
-        const response = await fetch(`${this.endpoint}/server/java/${host}`);
+        const response = await fetch(`${this.endpoint}/servers/java/${host}`);
         if (response.ok) {
             return {
                 server: (await response.json()),
@@ -54,7 +54,7 @@ export class McUtilsAPI {
      * @returns the server or the error (if one occurred)
      */
     async fetchBedrockServer(host) {
-        const response = await fetch(`${this.endpoint}/server/bedrock/${host}`);
+        const response = await fetch(`${this.endpoint}/servers/bedrock/${host}`);
         if (response.ok) {
             return {
                 server: (await response.json()),
@@ -71,7 +71,7 @@ export class McUtilsAPI {
      * @returns the blocked status or the error (if one occurred)
      */
     async fetchServerBlocked(host) {
-        const response = await fetch(`${this.endpoint}/server/blocked/${host}`);
+        const response = await fetch(`${this.endpoint}/servers/blocked/${host}`);
         if (response.ok) {
             const json = (await response.json());
             return { blocked: json.blocked };
@@ -87,7 +87,7 @@ export class McUtilsAPI {
      * @returns the IP lookup response or the error (if one occurred)
      */
     async fetchIpLookup(query) {
-        const response = await fetch(`${this.endpoint}/ip/${query}`);
+        const response = await fetch(`${this.endpoint}/ips/${query}`);
         if (response.ok) {
             return { data: (await response.json()) };
         }
@@ -102,7 +102,7 @@ export class McUtilsAPI {
      * @returns the player or the error (if one occurred)
      */
     async fetchPlayer(id) {
-        const response = await fetch(`${this.endpoint}/player/${id}`);
+        const response = await fetch(`${this.endpoint}/players/${id}`);
         if (response.ok) {
             return {
                 player: (await response.json()),
@@ -119,7 +119,7 @@ export class McUtilsAPI {
      * @returns the player name data or the error (if one occurred)
      */
     async fetchPlayerUuid(id) {
-        const response = await fetch(`${this.endpoint}/player/uuid/${id}`);
+        const response = await fetch(`${this.endpoint}/players/uuid/${id}`);
         if (response.ok) {
             return {
                 playerName: (await response.json()),
@@ -136,7 +136,7 @@ export class McUtilsAPI {
      * @returns the PNG image or the error (if one occurred)
      */
     async fetchServerIcon(host) {
-        const response = await fetch(`${this.endpoint}/server/icon/${host}`);
+        const response = await fetch(`${this.endpoint}/servers/icon/${host}`);
         if (response.ok) {
             return { image: await response.arrayBuffer() };
         }
@@ -153,7 +153,7 @@ export class McUtilsAPI {
      * @returns the PNG image or the error (if one occurred)
      */
     async fetchServerPreview(platform, host, size = 768) {
-        const response = await fetch(`${this.endpoint}/server/${platform}/preview/${host}${this.buildParams({ size: String(size) })}`);
+        const response = await fetch(`${this.endpoint}/servers/${platform}/preview/${host}${this.buildParams({ size: String(size) })}`);
         if (response.ok) {
             return { image: await response.arrayBuffer() };
         }
@@ -168,7 +168,7 @@ export class McUtilsAPI {
      * @returns the skin PNG image or the error (if one occurred)
      */
     async fetchPlayerSkinTexture(id) {
-        const response = await fetch(`${this.endpoint}/skin/${id}/texture.png`);
+        const response = await fetch(`${this.endpoint}/skins/${id}/texture.png`);
         if (response.ok) {
             return { image: await response.arrayBuffer() };
         }
@@ -186,7 +186,7 @@ export class McUtilsAPI {
      * @returns the skin part PNG image or the error (if one occurred)
      */
     async fetchPlayerSkin(id, part, size = 768, overlays = true) {
-        const response = await fetch(`${this.endpoint}/skin/${id}/${part}.png${this.buildParams({ size: String(size), overlays: String(overlays) })}`);
+        const response = await fetch(`${this.endpoint}/skins/${id}/${part}.png${this.buildParams({ size: String(size), overlays: String(overlays) })}`);
         if (response.ok) {
             return { image: await response.arrayBuffer() };
         }
@@ -194,6 +194,20 @@ export class McUtilsAPI {
             error: (await response.json()),
         };
     }
+    /**
+     * Fetch the list of available capes (e.g. Migrator).
+     *
+     * @returns the list of cape data or the error (if one occurred)
+     */
+    async fetchCapes() {
+        const response = await fetch(`${this.endpoint}/capes`);
+        if (response.ok) {
+            return { capes: (await response.json()) };
+        }
+        return {
+            error: (await response.json()),
+        };
+    }
     /**
      * Fetch a cape texture image.
      *
@@ -201,7 +215,7 @@ export class McUtilsAPI {
      * @returns the cape PNG image or the error (if one occurred)
      */
     async fetchCapeTexture(query) {
-        const response = await fetch(`${this.endpoint}/cape/${query}/texture.png`);
+        const response = await fetch(`${this.endpoint}/capes/${query}/texture.png`);
         if (response.ok) {
             return { image: await response.arrayBuffer() };
         }
@@ -218,7 +232,7 @@ export class McUtilsAPI {
      * @returns the cape part PNG image or the error (if one occurred)
      */
     async fetchCapePart(query, type, size = 768) {
-        const response = await fetch(`${this.endpoint}/cape/${query}/${type}.png${this.buildParams({ size: String(size) })}`);
+        const response = await fetch(`${this.endpoint}/capes/${query}/${type}.png${this.buildParams({ size: String(size) })}`);
         if (response.ok) {
             return { image: await response.arrayBuffer() };
         }

package/dist/types/player/cape/cape-part.d.ts

@@ -0,0 +1 @@
+export type CapePart = "FRONT";

package/dist/types/player/cape/cape.d.ts

@@ -0,0 +1,9 @@
+import { CapePart } from "./cape-part";
+export type Cape = {
+    textureUrl: string;
+    parts: Record<CapePart, string>;
+};
+export type CapeData = {
+    name: string;
+    textureId: string;
+};

package/dist/types/player/cape/cape.js

@@ -0,0 +1 @@
+export {};

package/dist/types/player/player.d.ts

@@ -1,18 +1,6 @@
-import { Cape } from "../cape/cape";
-export type SkinModel = "DEFAULT" | "SLIM";
-export type SkinPart = "HEAD" | "FULLBODY_FRONT" | "FULLBODY_BACK" | "FACE" | "BODY";
-export type SkinParts = Record<SkinPart, string>;
-export type Skin = {
-    model: SkinModel;
-    legacy: boolean;
-    textureUrl: string;
-    parts: SkinParts;
-};
-export type ProfileProperty = {
-    name: string;
-    value: string;
-    signature?: string;
-};
+import { Cape } from "./cape/cape";
+import { ProfileProperty } from "./profile-property";
+import { Skin } from "./skin/skin";
 export type Player = {
     uniqueId: string;
     username: string;

package/dist/types/player/profile-property.d.ts

@@ -0,0 +1,5 @@
+export type ProfileProperty = {
+    name: string;
+    value: string;
+    signature?: string;
+};

package/dist/types/player/profile-property.js

@@ -0,0 +1 @@
+export {};

package/dist/types/player/skin/skin-model.d.ts

@@ -0,0 +1 @@
+export type SkinModel = "DEFAULT" | "SLIM";

package/dist/types/player/skin/skin-model.js

@@ -0,0 +1 @@
+export {};

package/dist/types/player/skin/skin-part.d.ts

@@ -0,0 +1 @@
+export type SkinPart = "HEAD" | "FULLBODY_FRONT" | "FULLBODY_BACK" | "FACE" | "BODY";

package/dist/types/player/skin/skin-part.js

@@ -0,0 +1 @@
+export {};

package/dist/types/player/skin/skin.d.ts

@@ -0,0 +1,8 @@
+import { SkinModel } from "./skin-model";
+import { SkinPart } from "./skin-part";
+export type Skin = {
+    model: SkinModel;
+    legacy: boolean;
+    textureUrl: string;
+    parts: Record<SkinPart, string>;
+};

package/dist/types/player/skin/skin.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mcutils-js-api",
-  "version": "2.0.18",
+  "version": "2.0.20",
   "module": "dist/index.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/types/cape/cape.d.ts

@@ -1,5 +0,0 @@
-export type CapeRendererType = "FRONT";
-export type Cape = {
-    textureUrl: string;
-    parts: Record<string, string>;
-};