mcutils-js-api 1.0.0

package/README.md

@@ -0,0 +1,15 @@
+# mcutils-js-api
+
+To install dependencies:
+
+```bash
+bun install
+```
+
+To run:
+
+```bash
+bun run src/index.ts
+```
+
+This project was created using `bun init` in bun v1.3.1. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+import type { ErrorResponse } from "./types/response/error-response";
+import type { JavaServer } from "./types/server/java-server";
+/**
+ * Fetch a Java Minecraft server.
+ *
+ * @param host the host to fetch the server using (eg: aetheria.cc)
+ * @returns the server or the error (if one occured)
+ */
+export declare function fetchJavaServer(host: string): Promise<{
+    server?: JavaServer;
+    error?: ErrorResponse;
+}>;

package/dist/index.js

@@ -0,0 +1,18 @@
+const API_BASE = "https://mc.fascinated.cc/api";
+/**
+ * Fetch a Java Minecraft server.
+ *
+ * @param host the host to fetch the server using (eg: aetheria.cc)
+ * @returns the server or the error (if one occured)
+ */
+export async function fetchJavaServer(host) {
+    const response = await fetch(`${API_BASE}/server/java/${host}`);
+    if (response.ok) {
+        return {
+            server: (await response.json()),
+        };
+    }
+    return {
+        error: (await response.json()),
+    };
+}

package/dist/types/cache.d.ts

@@ -0,0 +1,4 @@
+export type Cache = {
+    cached: boolean;
+    cachedTime: number;
+};

package/dist/types/cache.js

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

package/dist/types/response/error-response.d.ts

@@ -0,0 +1,6 @@
+export type ErrorResponse = {
+    status: string;
+    message: string;
+    code: number;
+    timestamp: string;
+};

package/dist/types/response/error-response.js

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

package/dist/types/server/java-server.d.ts

@@ -0,0 +1,19 @@
+import type { Server } from "./server";
+export interface JavaServer extends Server {
+    version: ServerVersion;
+    favicon: ServerFavicon;
+    preventsChatReports: boolean;
+    enforcesSecureChat: boolean;
+    previewsChat: boolean;
+    mojangBlocked: boolean;
+}
+export type ServerVersion = {
+    name: string;
+    platform: string;
+    protocol: number;
+    protocolName: string;
+};
+export type ServerFavicon = {
+    base64: string;
+    url: string;
+};

package/dist/types/server/java-server.js

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

package/dist/types/server/server.d.ts

@@ -0,0 +1,51 @@
+import type { Cache } from "../cache";
+export interface Server extends Cache {
+    hostname: string;
+    ip: string;
+    port: number;
+    motd: ServerMotd;
+    players: ServerPlayers;
+    records: Array<DnsRecord>;
+    version: ServerVersion;
+    favicon: ServerFavicon;
+    preventsChatReports: boolean;
+    enforcesSecureChat: boolean;
+    previewsChat: boolean;
+    location: ServerLocation;
+    asn: AsnData;
+    mojangBlocked: boolean;
+}
+export type ServerMotd = {
+    raw: string[];
+    clean: string[];
+    html: string[];
+};
+export type ServerPlayers = {
+    online: number;
+    max: number;
+};
+export type DnsRecord = {
+    type: string;
+    ttl: number;
+    address: string;
+};
+export type ServerVersion = {
+    name: string;
+    platform: string;
+    protocol: number;
+    protocolName: string;
+};
+export type ServerFavicon = {
+    base64: string;
+    url: string;
+};
+export type ServerLocation = {
+    country: string;
+    region: string;
+    latitude: number;
+    longitude: number;
+};
+export type AsnData = {
+    asn: string;
+    asnOrg: string;
+};

package/dist/types/server/server.js

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

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "mcutils-js-api",
+  "version": "1.0.0",
+  "module": "dist/index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "bun run build"
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "^5"
+  }
+}