realmsplus-api 1.0.0 → 1.0.3

package/README.md

@@ -32,13 +32,15 @@ import { RealmsPlusAPI } from "realmsplus-api";
 
 const client = new RealmsPlusAPI("your-api-key");
 
-// Check service health
-const health = await client.getHealth();
-console.log(health);
-
-// Query the hacker database
-const result = await client.getHackerDB("all");
-console.log(result);
+(async () => {
+    // Check service health
+    const health = await client.getHealth();
+    console.log(health);
+
+    // Query the hacker database
+    const result = await client.getHackerDB("all");
+    console.log(result);
+})();
 ```
 
 See more [examples](./examples)

package/index.js

@@ -1,2 +1,5 @@
-import { RealmsPlusAPI } from "./src/api.js";
-export { RealmsPlusAPI };
+const RealmsPlusAPI = require("./src/api");
+
+module.exports = {
+    RealmsPlusAPI
+};

package/package.json

@@ -1,21 +1,9 @@
 {
   "name": "realmsplus-api",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "description": "Official SDK for the Realms+ API",
   "main": "index.js",
   "types": "index.d.ts",
-  "type": "module",
-  "exports": {
-    ".": {
-      "types": "./index.d.ts",
-      "import": "./index.js"
-    }
-  },
-  "files": [
-    "index.js",
-    "index.d.ts",
-    "src/"
-  ],
   "engines": {
     "node": ">=22.0.0"
   },
@@ -40,4 +28,4 @@
     "url": "https://github.com/All-Realms-Are-Safe/realmsplus-api/issues"
   },
   "homepage": "https://github.com/All-Realms-Are-Safe/realmsplus-api#readme"
-}
+}

package/src/api.js

@@ -1,49 +1,22 @@
+const Rest = require("./libs/Rest");
+
 /**
  * Represents the public routes of the Realms+ API
  */
-export class RealmsPlusAPI {
+class RealmsPlusAPI extends Rest {
     /**
      * 
      * @param {string} apiKey - your private api key
      */
     constructor(apiKey) {
-        this.apiKey = apiKey;
-        this.baseUrl = "https://api.realmsplus.com/v1";
-        this.headers = {
-            "api-key": this.apiKey,
-            "Content-Type": "application/json"
-        };
-    };
-
-    async #request(method, url, body) {
-        try {
-            const data = {
-                method: method,
-                headers: this.headers
-            };
-
-            if (
-                method !== "GET" && 
-                method !== "DELETE" && 
-                body
-            ) {
-                data.body = JSON.stringify(body);
-            };
-
-            const res = await fetch(`${this.baseUrl}${url}`, data);
-            console.log(res.status);
-            const parsed = await res.json();
-            return parsed;
-        } catch (error) {
-            throw new Error(error);
-        };
+        super("https://api.realmsplus.com/v1", { "api-key": apiKey, "Content-Type": "application/json" });
     };
 
     /**
      * Gets the service health
      */
     async getHealth() {
-        return await this.#request("GET", "/health");
+        return await this.get("/health");
     };
 
     /**
@@ -51,7 +24,7 @@ export class RealmsPlusAPI {
      * @param {string} id - the unique id to search for. Allowed types: `all`, `<discord-id>`, `<fingerprint-id>`
      */
     async getDiscordDB(id) {
-        return await this.#request("GET", `/database/discordDB/${id}`);
+        return await this.get(`/database/discordDB/${id}`);
     };
 
     /**
@@ -59,21 +32,23 @@ export class RealmsPlusAPI {
      * @param {string} id - the unique id to search for. Allowed types: `all`, `<xuid-id>`, `<discord-id>`, `<fingerprint-id>`
      */
     async getHackerDB(id) {
-        return await this.#request("GET", `/database/hackerDB/${id}`);
+        return await this.get(`/database/hackerDB/${id}`);
     };
 
     /**
-     * 
-     * @param {string} category - the category of the report. Allowed types: `discordDB`, `hackerDB`
+     * Report a user to the ARAS team. username value can be a gamertag or discord tag
+     * @param {"discordDB" | "hackerDB"} category - the category of the report. Allowed types: `discordDB`, `hackerDB`
      * @param {{
      *     username: string,
      *     xuid: string | null,
      *     discordName: string | null,
      *     discordId: string | null,
      *     reason: string
-     * }} data - the data for the report. discordDB must have the `discordId` field, hackerDB must have the `xuid` field
+     * }} data - the data for the report.
      */
     async reportUser(category, data) {
-        return await this.#request("POST", `/database/report/${category}`, data);
+        return await this.post(`/database/report/${category}`, data);
     };
-};
+};
+
+module.exports = RealmsPlusAPI;

package/src/libs/Rest.js

@@ -0,0 +1,47 @@
+class Rest {
+    constructor(baseUrl, headers) {
+        this.base = baseUrl;
+        this.headers = headers
+    };
+
+    /**
+     * @param {Response} res 
+     */
+    async #parse(res) {
+        let data = null;
+        try {
+            data = await res.json();
+        } catch { }
+
+        const final = {
+            status: res.status,
+            ok: res.ok,
+            data
+        };
+
+        if (!res.ok) final.headers = Object.fromEntries(res.headers);
+        return final;
+    };
+
+    async get(url) {
+        const res = await fetch(`${this.base}${url}`, { headers: this.headers });
+        return await this.#parse(res);
+    };
+
+    async post(url, data) {
+        const res = await fetch(`${this.base}${url}`, { method: "POST", headers: this.headers, body: JSON.stringify(data) });
+        return await this.#parse(res);
+    };
+
+    async put(url, data) {
+        const res = await fetch(`${this.base}${url}`, { method: "PUT", headers: this.headers, body: JSON.stringify(data) });
+        return await this.#parse(res);
+    };
+
+    async delete(url) {
+        const res = await fetch(`${this.base}${url}`, { method: "DELETE", headers: this.headers });
+        return await this.#parse(res);
+    };
+};
+
+module.exports = Rest;

package/tests/main.js

@@ -0,0 +1,13 @@
+const { RealmsPlusAPI } = require("../index");
+
+const client = new RealmsPlusAPI("guhcat_is_cool");
+(async () => {
+    const health = await client.getHealth();
+    console.log(health);
+
+    const hackers = await client.getHackerDB("all");
+    console.log(hackers);
+
+    const discord = await client.getDiscordDB("all");
+    console.log(discord);
+})();