mcutils-js-api 2.0.3 → 2.0.6

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import type { ErrorResponse } from "./types/response/error-response";
+import type { IpLookupResponse } from "./types/response/ip-lookup-response";
 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";
@@ -43,6 +44,16 @@ export declare class McUtilsAPI {
         blocked?: boolean;
         error?: ErrorResponse;
     }>;
+    /**
+     * Look up IP address (geo + ASN).
+     *
+     * @param query the IP address to lookup (eg: 127.0.0.1)
+     * @returns the IP lookup response or the error (if one occurred)
+     */
+    fetchIpLookup(query: string): Promise<{
+        data?: IpLookupResponse;
+        error?: ErrorResponse;
+    }>;
     /**
      * Fetch a player by UUID or username.
      *
@@ -100,8 +111,8 @@ export declare class McUtilsAPI {
      *
      * @param id the UUID or username of the player (eg: ImFascinated)
      * @param part the skin part to fetch (eg: head)
-     * @param size the image size (default: 256)
-     * @param overlays whether to render skin overlay layers (default: false)
+     * @param size the image size (default: 768)
+     * @param overlays whether to render skin overlay layers (default: true)
      * @returns the skin part PNG image or the error (if one occurred)
      */
     fetchPlayerSkinPart(id: string, part: string, size?: number, overlays?: boolean): Promise<{
@@ -109,9 +120,9 @@ export declare class McUtilsAPI {
         error?: ErrorResponse;
     }>;
     /**
-     * Fetch a player's cape image.
+     * Fetch a cape texture image by cape texture id.
      *
-     * @param id the UUID or username of the player (eg: ImFascinated)
+     * @param id the cape texture id (eg: from player.cape or a texture hash)
      * @returns the cape PNG image or the error (if one occurred)
      */
     fetchPlayerCape(id: string): Promise<{

package/dist/index.js

@@ -62,6 +62,21 @@ export class McUtilsAPI {
             error: (await response.json()),
         };
     }
+    /**
+     * Look up IP address (geo + ASN).
+     *
+     * @param query the IP address to lookup (eg: 127.0.0.1)
+     * @returns the IP lookup response or the error (if one occurred)
+     */
+    async fetchIpLookup(query) {
+        const response = await fetch(`${this.endpoint}/ip/${query}`);
+        if (response.ok) {
+            return { data: (await response.json()) };
+        }
+        return {
+            error: (await response.json()),
+        };
+    }
     /**
      * Fetch a player by UUID or username.
      *
@@ -135,7 +150,7 @@ export class McUtilsAPI {
      * @returns the skin PNG image or the error (if one occurred)
      */
     async fetchPlayerSkin(id) {
-        const response = await fetch(`${this.endpoint}/skin/texture/${id}.png`);
+        const response = await fetch(`${this.endpoint}/skin/${id}/texture.png`);
         if (response.ok) {
             return { image: await response.arrayBuffer() };
         }
@@ -148,11 +163,11 @@ export class McUtilsAPI {
      *
      * @param id the UUID or username of the player (eg: ImFascinated)
      * @param part the skin part to fetch (eg: head)
-     * @param size the image size (default: 256)
-     * @param overlays whether to render skin overlay layers (default: false)
+     * @param size the image size (default: 768)
+     * @param overlays whether to render skin overlay layers (default: true)
      * @returns the skin part PNG image or the error (if one occurred)
      */
-    async fetchPlayerSkinPart(id, part, size = 256, overlays = false) {
+    async fetchPlayerSkinPart(id, part, size = 768, overlays = true) {
         const response = await fetch(`${this.endpoint}/skin/${id}/${part}.png${this.buildParams({ size: String(size), overlays: String(overlays) })}`);
         if (response.ok) {
             return { image: await response.arrayBuffer() };
@@ -162,13 +177,13 @@ export class McUtilsAPI {
         };
     }
     /**
-     * Fetch a player's cape image.
+     * Fetch a cape texture image by cape texture id.
      *
-     * @param id the UUID or username of the player (eg: ImFascinated)
+     * @param id the cape texture id (eg: from player.cape or a texture hash)
      * @returns the cape PNG image or the error (if one occurred)
      */
     async fetchPlayerCape(id) {
-        const response = await fetch(`${this.endpoint}/cape/texture/${id}.png`);
+        const response = await fetch(`${this.endpoint}/cape/${id}/texture.png`);
         if (response.ok) {
             return { image: await response.arrayBuffer() };
         }

package/dist/test.js

@@ -4,5 +4,5 @@ api.fetchJavaServer("aetheria.cc").then((result) => {
     console.log(result);
 });
 api.fetchPlayer("ImFascinated").then((result) => {
-    console.log(result);
+    console.log(result.player?.skin?.parts.FULLBODY_FRONT);
 });

package/dist/types/cache/cached-server.d.ts

@@ -0,0 +1,7 @@
+import type { JavaServer } from "../server/impl/java-server";
+import type { BedrockServer } from "../server/impl/bedrock-server";
+/**
+ * Cached server response (backend returns cache fields + unwrapped server).
+ * Use JavaServer or BedrockServer for typed responses.
+ */
+export type CachedMinecraftServer = JavaServer | BedrockServer;

package/dist/types/cache/cached-server.js

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

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

@@ -1,5 +1,6 @@
 export type SkinModel = "DEFAULT" | "SLIM";
-export type SkinParts = Record<string, string>;
+export type SkinPart = "HEAD" | "FULLBODY_FRONT" | "FULLBODY_BACK" | "FACE" | "BODY";
+export type SkinParts = Record<SkinPart, string>;
 export type Skin = {
     model: SkinModel;
     legacy: boolean;

package/dist/types/response/ip-lookup-response.d.ts

@@ -0,0 +1,7 @@
+import type { GeoLocation } from "../server/server";
+import type { AsnLookup } from "../server/server";
+export type IpLookupResponse = {
+    ip: string;
+    location: GeoLocation | null;
+    asn: AsnLookup | null;
+};

package/dist/types/response/ip-lookup-response.js

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

package/dist/types/response/server-blocked-response.d.ts

@@ -0,0 +1,3 @@
+export type ServerBlockedResponse = {
+    blocked: boolean;
+};

package/dist/types/response/server-blocked-response.js

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

package/dist/types/server/impl/java-server.d.ts

@@ -16,7 +16,7 @@ export type ServerVersion = {
     protocolName: string;
 };
 export type ServerFavicon = {
-    base64?: string;
+    base64: string;
     url: string;
 };
 export type ForgeModInfo = {

package/dist/types/server/server.d.ts

@@ -8,13 +8,14 @@ export interface Server extends Cache {
     players: ServerPlayers;
     records: DnsRecord[];
     location?: GeoLocation | null;
-    asn?: AsnData | null;
+    asn?: AsnLookup | null;
 }
 export type ServerMotd = {
     raw: string[];
     clean: string[];
     html: string[];
     preview: string;
+    htmlPreview: string;
 };
 export type ServerPlayerSampleName = {
     raw: string;
@@ -40,7 +41,7 @@ export type GeoLocation = {
     longitude: number;
     flagUrl: string;
 };
-export type AsnData = {
+export type AsnLookup = {
     asn: string;
     asnOrg: string;
 };

package/package.json

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