realmsplus-api 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 All Realms Are Safe
+
+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,52 @@
+# realmsplus-api
+
+[![npm version](https://img.shields.io/npm/v/realmsplus-api.svg)](https://www.npmjs.com/package/realmsplus-api)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+Official SDK for the Realms+ API's public endpoints. This service maintains a database of harmful users in the Minecraft Bedrock Community.
+
+## Requirements
+
+- Node.js 22.0.0 or higher
+- A valid Realms+ API key
+
+## Get Started
+
+To use this package, you need an API key.
+
+1. Join our [Discord server](https://discord.gg/KQtxZJVgnU)
+2. Open a ticket to contact support
+3. Request API access and provide your use case
+4. Once approved, you will receive your API key
+
+## Installation
+
+```bash
+npm install realmsplus-api
+```
+
+## Usage
+
+```javascript
+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);
+```
+
+See more [examples](./examples)
+
+## Documentation
+
+- [API Reference](./docs/API.md)
+
+## License
+
+[MIT](./LICENSE)

package/index.d.ts

@@ -0,0 +1,50 @@
+export interface ReportData {
+  username: string;
+  xuid?: string | null;
+  discordName?: string | null;
+  discordId?: string | null;
+  reason: string;
+}
+
+export interface APIResponse<T = unknown> {
+  ok: boolean;
+  data?: T;
+  error?: string;
+}
+
+export interface HealthResponse {
+  status: string;
+  services: {
+    database: string;
+  }
+}
+
+export type ReportCategory = 'discordDB' | 'hackerDB';
+
+export class RealmsPlusAPI {
+  constructor(apiKey: string);
+
+  /**
+   * Gets the service health status
+   */
+  getHealth(): Promise<APIResponse<HealthResponse>>;
+
+  /**
+   * Searches the Discord database
+   * @param id - The unique ID to search for. Allowed types: `all`, `<discord-id>`, `<fingerprint-id>`
+   */
+  getDiscordDB(id: string): Promise<APIResponse>;
+
+  /**
+   * Searches the hacker database
+   * @param id - The unique ID to search for. Allowed types: `all`, `<xuid-id>`, `<discord-id>`, `<fingerprint-id>`
+   */
+  getHackerDB(id: string): Promise<APIResponse>;
+
+  /**
+   * Reports a user to the specified database
+   * @param category - The category of the report (`discordDB` or `hackerDB`)
+   * @param data - The report data. discordDB requires `discordId`, hackerDB requires `xuid`
+   */
+  reportUser(category: ReportCategory, data: ReportData): Promise<APIResponse>;
+}

package/index.js

@@ -0,0 +1,2 @@
+import { RealmsPlusAPI } from "./src/api.js";
+export { RealmsPlusAPI };

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "realmsplus-api",
+  "version": "1.0.0",
+  "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"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/All-Realms-Are-Safe/realmsplus-api.git"
+  },
+  "keywords": [
+    "realmsplus",
+    "realms",
+    "minecraft",
+    "bedrock",
+    "api",
+    "sdk"
+  ],
+  "author": "All Realms Are Safe",
+  "license": "MIT",
+  "bugs": {
+    "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

@@ -0,0 +1,79 @@
+/**
+ * Represents the public routes of the Realms+ API
+ */
+export class RealmsPlusAPI {
+    /**
+     * 
+     * @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);
+        };
+    };
+
+    /**
+     * Gets the service health
+     */
+    async getHealth() {
+        return await this.#request("GET", "/health");
+    };
+
+    /**
+     * Searches the discord database
+     * @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}`);
+    };
+
+    /**
+     * Searches the hacker database
+     * @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}`);
+    };
+
+    /**
+     * 
+     * @param {string} 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
+     */
+    async reportUser(category, data) {
+        return await this.#request("POST", `/database/report/${category}`, data);
+    };
+};