pixelheads 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 jojomatik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,45 @@
+# pixelheads
+A library that makes it easy to retrieve skins and faces of minecraft players based on their uuid.
+
+## Usage
+1. Run `npm install pixelheads`
+2. Use one of the functions to retrieve the skin or the face as a base64-encoded string.
+   ```ts
+     import pixelheads from "pixelheads";
+     
+     // Returns the entire skin of the player as a base64-encoded string. 
+     const playerSkin = pixelheads.getSkinAsBase64("uuid"); 
+   
+     // Returns the face of the player as a base64-encoded string.
+     const playerFace = pixelheads.getFaceAsBase64("uuid"); 
+   ```
+3. Use one of the return values, e.g. in an `img`-tag:
+   ```
+   <img src="'data:image/png;base64,' + playerFace" alt="face of player"></img>
+   ```
+
+## Building
+Prerequisites:
+- Git
+- Node.js and npm
+- TypeScript installed globally (`npm install -g typescript`)
+
+Run the following commands:
+```sh
+git clone https://github.com/jojomatik/pixelheads
+cd pixelheads
+npm install
+```
+
+To build, run the following commands:
+```sh
+tsc
+```
+
+To pack the project as a tarball, run the following commands:
+```sh
+npm pack
+```
+
+## Licensing
+This project is licensed under the MIT License (MIT). See also [`LICENSE`](LICENSE).

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Uses the Mojang-API to retrieve a players skin based on the players uuid and returns the skin as a base64 encoded string.
+ * @param uuid the uuid of the player
+ * @return the skin of the player encoded as a base64-string.
+ */
+export declare function getSkinAsBase64(uuid: string): Promise<string>;
+/**
+ * Uses the Mojang-API to retrieve a players skin based on the players uuid and returns the extracted face as a base64 encoded string.
+ * @param uuid the uuid of the player
+ * @return the face of the player encoded as a base64-string.
+ */
+export declare function getFaceAsBase64(uuid: string): Promise<string>;

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,wBAAsB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAWnE;AAED,wBAAsB,2BAA2B,CAC/C,IAAI,EAAE;IACJ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAChD,EACD,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,MAAM,CAAC,CAsBjB"}

package/dist/index.js

@@ -0,0 +1,91 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFaceAsBase64 = exports.getSkinAsBase64 = void 0;
+const axios_1 = __importDefault(require("axios"));
+const sharp_1 = __importDefault(require("sharp"));
+/**
+ * Uses the Mojang-API to retrieve a players skin based on the players uuid and returns the skin as a base64 encoded string.
+ * @param uuid the uuid of the player
+ * @return the skin of the player encoded as a base64-string.
+ */
+function getSkinAsBase64(uuid) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield axios_1.default.get("https://sessionserver.mojang.com/session/minecraft/profile/" + uuid);
+        // Fetch profile.
+        const data = response.data;
+        // Define error prefix.
+        const errorMessage = "Couldn't retrieve skin for uuid " + uuid + ". Reason: ";
+        if (data.error) {
+            throw new Error(errorMessage + data.error + ": " + JSON.stringify(data));
+        }
+        if (!data.properties) {
+            throw new Error(errorMessage + "No properties in response: " + JSON.stringify(data));
+        }
+        // Loop through properties and find 'textures' property.
+        for (const property of data.properties) {
+            if (property.name === "textures") {
+                // Find object containing the skin URL.
+                const response = JSON.parse(Buffer.from(property.value, "base64").toString());
+                let skinURL;
+                // Check if skin URL exists and retrieve it.
+                if (response.textures &&
+                    response.textures.SKIN &&
+                    (skinURL = response.textures.SKIN.url)) {
+                    // Fetch skin URL and returns as base64.
+                    const b64 = yield axios_1.default
+                        .get(skinURL, { responseType: "arraybuffer" })
+                        .then((response) => response.data)
+                        .then((buffer) => {
+                        return Buffer.from(buffer).toString("base64");
+                    })
+                        .catch((error) => console.error(errorMessage + "Could not load buffer for URL " + skinURL, error));
+                    if (b64)
+                        return b64;
+                    else
+                        throw new Error(errorMessage + "No skin returned for URL " + skinURL);
+                }
+                else
+                    throw new Error(errorMessage +
+                        "No url to skin in response: " +
+                        JSON.stringify(response));
+            }
+        }
+        throw new Error(errorMessage + "No textures object in response: " + JSON.stringify(data));
+    });
+}
+exports.getSkinAsBase64 = getSkinAsBase64;
+/**
+ * Uses the Mojang-API to retrieve a players skin based on the players uuid and returns the extracted face as a base64 encoded string.
+ * @param uuid the uuid of the player
+ * @return the face of the player encoded as a base64-string.
+ */
+function getFaceAsBase64(uuid) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const skin = yield getSkinAsBase64(uuid);
+        const buffer = Buffer.from(skin, "base64");
+        const sharpSkin = (0, sharp_1.default)(buffer);
+        const sharpHead = sharpSkin.extract({ left: 8, top: 8, width: 8, height: 8 });
+        return sharpHead
+            .toBuffer()
+            .then((data) => {
+            return data.toString("base64");
+        })
+            .catch((error) => {
+            throw new Error("Couldn't extract head of skin for uuid " + uuid + ". Reason: " + error);
+        });
+    });
+}
+exports.getFaceAsBase64 = getFaceAsBase64;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,kDAA0B;AAC1B,kDAA0B;AAE1B;;;;GAIG;AACH,SAAsB,eAAe,CAAC,IAAY;;QAChD,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,GAAG,CAC9B,6DAA6D,GAAG,IAAI,CACrE,CAAC;QAEF,iBAAiB;QACjB,MAAM,IAAI,GAGN,QAAQ,CAAC,IAAI,CAAC;QAElB,uBAAuB;QACvB,MAAM,YAAY,GAChB,kCAAkC,GAAG,IAAI,GAAG,YAAY,CAAC;QAE3D,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;SAC1E;QAED,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,MAAM,IAAI,KAAK,CACb,YAAY,GAAG,6BAA6B,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CACpE,CAAC;SACH;QAED,wDAAwD;QACxD,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE;YACtC,IAAI,QAAQ,CAAC,IAAI,KAAK,UAAU,EAAE;gBAChC,uCAAuC;gBACvC,MAAM,QAAQ,GAA4C,IAAI,CAAC,KAAK,CAClE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,QAAQ,EAAE,CACjD,CAAC;gBAEF,IAAI,OAAe,CAAC;gBAEpB,4CAA4C;gBAC5C,IACE,QAAQ,CAAC,QAAQ;oBACjB,QAAQ,CAAC,QAAQ,CAAC,IAAI;oBACtB,CAAC,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EACtC;oBACA,wCAAwC;oBACxC,MAAM,GAAG,GAAG,MAAM,eAAK;yBACpB,GAAG,CAAC,OAAO,EAAE,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC;yBAC7C,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;yBACjC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;wBACf,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;oBAChD,CAAC,CAAC;yBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CACf,OAAO,CAAC,KAAK,CACX,YAAY,GAAG,gCAAgC,GAAG,OAAO,EACzD,KAAK,CACN,CACF,CAAC;oBAEJ,IAAI,GAAG;wBAAE,OAAO,GAAG,CAAC;;wBAElB,MAAM,IAAI,KAAK,CAAC,YAAY,GAAG,2BAA2B,GAAG,OAAO,CAAC,CAAC;iBACzE;;oBACC,MAAM,IAAI,KAAK,CACb,YAAY;wBACV,8BAA8B;wBAC9B,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAC3B,CAAC;aACL;SACF;QAED,MAAM,IAAI,KAAK,CACb,YAAY,GAAG,kCAAkC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CACzE,CAAC;IACJ,CAAC;CAAA;AAtED,0CAsEC;AAED;;;;GAIG;AACH,SAAsB,eAAe,CAAC,IAAY;;QAChD,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC3C,MAAM,SAAS,GAAG,IAAA,eAAK,EAAC,MAAM,CAAC,CAAC;QAChC,MAAM,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;QAC9E,OAAO,SAAS;aACb,QAAQ,EAAE;aACV,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACb,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,MAAM,IAAI,KAAK,CACb,yCAAyC,GAAG,IAAI,GAAG,YAAY,GAAG,KAAK,CACxE,CAAC;QACJ,CAAC,CAAC,CAAC;IACP,CAAC;CAAA;AAfD,0CAeC"}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "pixelheads",
+  "version": "1.0.1",
+  "description": "A library that makes it easy to retrieve skins and faces of minecraft players based on their uuid.",
+  "keywords": [
+    "minecraft",
+    "skin",
+    "mojang",
+    "API",
+    "face"
+  ],
+  "scripts": {
+    "prepublish": "tsc",
+    "semantic-release": "semantic-release"
+  },
+  "files": [
+    "dist/*",
+    "package.json",
+    "README.md"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "dependencies": {
+    "axios": "^0.25.0",
+    "sharp": "^0.29.3"
+  },
+  "devDependencies": {
+    "@types/sharp": "^0.29.5",
+    "@types/uuid": "^8.3.3",
+    "@typescript-eslint/eslint-plugin": "^5.7.0",
+    "@typescript-eslint/parser": "^5.7.0",
+    "eslint": "^8.5.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "prettier": "^2.5.1",
+    "typescript": "^4.5.4"
+  },
+  "author": {
+    "name": "jojomatik",
+    "email": "dev@jojomatik.de"
+  },
+  "bugs": {
+    "url": "https://github.com/jojomatik/pixelheads/issues",
+    "email": "dev@jojomatik.de"
+  },
+  "homepage": "https://github.com/jojomatik/pixelheads",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jojomatik/pixelheads.git"
+  }
+}