mcutils-js-api 2.0.31 → 2.0.33

package/dist/index.d.ts

@@ -8,6 +8,8 @@ import { ServerRegistryEntry } from "./types/server-registry/server-registry-ent
 import { Player } from "./types/player/player";
 import { CachedPlayerName } from "./types/cache/cached-player-name";
 import { StatisticsResponse } from "./types/response/statistics-response";
+import { Skin } from "./types/player/skin/skin";
+import { Page } from "./types/pagination/pagination";
 export declare class McUtilsAPI {
     private readonly endpoint;
     constructor(endpoint?: string);
@@ -184,5 +186,15 @@ export declare class McUtilsAPI {
         statistics?: StatisticsResponse;
         error?: ErrorResponse;
     }>;
+    /**
+     * Fetch the list of available skins.
+     *
+     * @param page the page to fetch (default: 1)
+     * @returns the list of skins or the error (if one occurred)
+     */
+    fetchSkins(page?: number): Promise<{
+        skins?: Page<Skin>;
+        error?: ErrorResponse;
+    }>;
 }
 export default McUtilsAPI;

package/dist/index.js

@@ -269,5 +269,20 @@ export class McUtilsAPI {
             error: (await response.json()),
         };
     }
+    /**
+     * Fetch the list of available skins.
+     *
+     * @param page the page to fetch (default: 1)
+     * @returns the list of skins or the error (if one occurred)
+     */
+    async fetchSkins(page = 1) {
+        const response = await fetch(`${this.endpoint}/skins${this.buildParams({ page: String(page) })}`);
+        if (response.ok) {
+            return { skins: (await response.json()) };
+        }
+        return {
+            error: (await response.json()),
+        };
+    }
 }
 export default McUtilsAPI;

package/dist/types/pagination/pagination.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Callback passed to a page fetcher: limit (items per page) and skip (offset).
+ */
+export type PageCallback = {
+    limit: number;
+    skip: number;
+};
+/**
+ * A single page of paginated results.
+ */
+export type Page<T> = {
+    items: T[];
+    totalItems: number;
+    itemsPerPage: number;
+    totalPages: number;
+};
+/**
+ * Pagination configuration (items per page and total count).
+ */
+export type PaginationConfig = {
+    itemsPerPage: number;
+    totalItems: number;
+};
+/**
+ * Fetcher used to load items for a page. Receives limit and skip via PageCallback.
+ */
+export type PageFetcher<T> = (callback: PageCallback) => T[] | Promise<T[]>;

package/dist/types/pagination/pagination.js

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

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

@@ -4,4 +4,5 @@ export type Cape = {
     textureId: string;
     textureUrl: string;
     parts: Record<CapePart, string>;
+    accountsOwned: number;
 };

package/package.json

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