mcutils-js-api 2.0.37 → 2.0.39

package/dist/index.d.ts

@@ -10,6 +10,7 @@ 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";
+import { PlayerSearchEntry } from "./types/player/player-search-entry";
 export declare class McUtilsAPI {
     private readonly endpoint;
     private readonly fetchOptions?;
@@ -205,5 +206,15 @@ export declare class McUtilsAPI {
         skins?: Page<Skin>;
         error?: ErrorResponse;
     }>;
+    /**
+     * Search for players by username.
+     *
+     * @param query the query to search for (eg: aetheria)
+     * @returns the player search entry or the error (if one occurred)
+     */
+    searchPlayers(query: string): Promise<{
+        entry?: PlayerSearchEntry;
+        error?: ErrorResponse;
+    }>;
 }
 export default McUtilsAPI;

package/dist/index.js

@@ -207,5 +207,15 @@ export class McUtilsAPI {
         const { data, error } = await this.request(`/skins${this.buildParams({ page: String(page) })}`);
         return error ? { error } : { skins: data };
     }
+    /**
+     * Search for players by username.
+     *
+     * @param query the query to search for (eg: aetheria)
+     * @returns the player search entry or the error (if one occurred)
+     */
+    async searchPlayers(query) {
+        const { data, error } = await this.request(`/players/search${this.buildParams({ query: query })}`);
+        return error ? { error } : { entry: data };
+    }
 }
 export default McUtilsAPI;

package/dist/types/player/player-search-entry.d.ts

@@ -0,0 +1,6 @@
+import { Skin } from "./skin/skin";
+export type PlayerSearchEntry = {
+    uuid: string;
+    username: string;
+    skin: Skin;
+};

package/dist/types/player/player-search-entry.js

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

package/package.json

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