exaroton 1.12.0 → 2.0.0

package/README.md

@@ -6,6 +6,9 @@ the server. You can read the API documentation here: https://developers.exaroton
 
 This is the official Node.js implementation of this API.
 
+### Requirements
+- Node 22 or later
+
 ### Installation
 
 ```
@@ -18,7 +21,7 @@ To use the API and this client you have to get your API key, which you can gener
 
 ### Create a client object
 ```js
-const {Client} = require('exaroton');
+import {Client} from 'exaroton'
 
 const client = new Client(token);
 ```
@@ -69,7 +72,7 @@ if (server.hasStatus(server.STATUS.ONLINE)) {
 }
 ```
 The server status is an `integer` as described in the [documentation](https://developers.exaroton.com/#header-server-status). You can use
-the [ServerStatus](./src/Server/ServerStatus.js) object, which you can require on its own `const {ServerStatus} = require('exaroton')` or via the
+the [ServerStatus](./src/Server/ServerStatus.js) object, which you can require on its own `import {ServerStatus} from 'exaroton'` or via the
 shorthand `server.STATUS` property.
 
 #### Start/stop/restart the server
@@ -93,6 +96,15 @@ try {
 }
 ```
 
+#### Extend the server stop timer
+```js
+try {
+    await server.extendStopTime(60);
+} catch (e) {
+    console.error(e.message);
+}
+```
+
 #### Get the server logs
 ```js
 try {
@@ -448,6 +460,32 @@ server.on("heap:heap", function(data) {
 });
 ```
 
+### Management Protocol
+The Minecraft server management protocol introduced in 1.21.9 allows controlling various server settings without
+restarting the server and receiving events from the server. This API client supports proxying this protocol through the
+exaroton websocket connection and using it with the [`mc-server-management`](https://github.com/aternosorg/mc-server-management)
+library.
+
+```js
+// To use it, first subscribe to the `management` stream:
+server.subscribe("management");
+// Then get a connection object from the stream:
+const connection = server.getWebsocketClient().getStream("management").getProxyConnection();
+// And create an object from the management library:
+import {MinecraftServer} from "mc-server-management";
+const mcServer = new MinecraftServer(stream.getProxyConnection());
+
+// Now you can perform requests such as getting the server status:
+let status = await mcServer.getStatus();
+
+// And subscribe to notifications:
+import {Notifications} from "mc-server-management";
+mcServer.on(Notifications.ALLOWLIST_ADDED, data => {
+    console.log("Allowlist added", data);
+});
+```
+
+
 #### Unsubscribe
 You can unsubscribe from one, multiple or all streams using the `server.unsubscribe()` function.
 

package/index.js

@@ -1,11 +1,21 @@
-module.exports = {
-    Client: require('./src/Client'),
-    Server: require('./src/Server/Server'),
-    Software: require('./src/Server/Software'),
-    ServerStatus: require('./src/Server/ServerStatus'),
-    Request: require('./src/Request/Request'),
-    Response: require('./src/Response/Response'),
-    ConfigOptionType: require('./src/Server/Config/ConfigOptionType'),
-    Pool: require('./src/Billing/Pool/Pool'),
-    PoolMember: require('./src/Billing/Pool/PoolMember')
+import Client from "./src/Client.js";
+import Server from "./src/Server/Server.js";
+import Software from "./src/Server/Software.js";
+import ServerStatus from "./src/Server/ServerStatus.js";
+import Request from "./src/Request/Request.js";
+import Response from "./src/Response/Response.js";
+import ConfigOptionType from "./src/Server/Config/ConfigOptionType.js";
+import Pool from "./src/Billing/Pool/Pool.js";
+import PoolMember from "./src/Billing/Pool/PoolMember.js";
+
+export {
+    Client,
+    Server,
+    Software,
+    ServerStatus,
+    Request,
+    Response,
+    ConfigOptionType,
+    Pool,
+    PoolMember,
 }

package/package.json

@@ -1,17 +1,21 @@
 {
-  "name": "exaroton",
-  "version": "1.12.0",
-  "description": "exaroton API client",
-  "homepage": "https://exaroton.com",
-  "main": "index.js",
-  "repository": "github:exaroton/node-exaroton-api",
-  "author": "Matthias Neid",
-  "license": "MIT",
-  "engines": {
-    "node": ">=12.0.0"
-  },
-  "dependencies": {
-    "got": "^11.8.2",
-    "ws": "^7.4.5"
-  }
+    "name": "exaroton",
+    "version": "2.0.0",
+    "description": "exaroton API client",
+    "homepage": "https://exaroton.com",
+    "main": "index.js",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/exaroton/node-exaroton-api.git"
+    },
+    "author": "Matthias Neid",
+    "license": "MIT",
+    "type": "module",
+    "engines": {
+        "node": ">=22.0.0"
+    },
+    "dependencies": {
+        "mc-server-management": "^3.0.0",
+        "ws": "^8.18.3"
+    }
 }

package/src/Account/Account.js

@@ -1,6 +1,6 @@
-const GetAccountRequest = require('../Request/Account/GetAccountRequest');
+import GetAccountRequest from '../Request/Account/GetAccountRequest.js'
 
-class Account {
+export default class Account {
     /**
      * @type {Client}
      * @private
@@ -70,5 +70,3 @@ class Account {
         return this;
     }
 }
-
-module.exports = Account;

package/src/Billing/Pool/Pool.js

@@ -1,8 +1,8 @@
-const GetPoolRequest = require("../../Request/Billing/Pool/GetPoolRequest.js");
-const GetPoolMembersRequest = require("../../Request/Billing/Pool/GetPoolMembersRequest.js");
-const GetPoolServersRequest = require("../../Request/Billing/Pool/GetPoolServersRequest.js");
+import GetPoolRequest from '../../Request/Billing/Pool/GetPoolRequest.js'
+import GetPoolMembersRequest from '../../Request/Billing/Pool/GetPoolMembersRequest.js'
+import GetPoolServersRequest from '../../Request/Billing/Pool/GetPoolServersRequest.js'
 
-class Pool {
+export default class Pool {
     /**
      * @type {Client}
      * @private
@@ -133,5 +133,3 @@ class Pool {
         return response.getData();
     }
 }
-
-module.exports = Pool;

package/src/Billing/Pool/PoolMember.js

@@ -1,5 +1,5 @@
 
-class PoolMember {
+export default class PoolMember {
     /**
      * Pool member account ID
      *
@@ -48,5 +48,3 @@ class PoolMember {
         this.isOwner = typeof poolMemberObject.isOwner !== "undefined" ? poolMemberObject.isOwner : null;
     }
 }
-
-module.exports = PoolMember;

package/src/Client.js

@@ -1,17 +1,18 @@
-const got = require('got');
-const fs = require("fs").promises;
+import {unlink} from 'fs/promises'
 
-const Server = require('./Server/Server');
-const Account = require('./Account/Account');
-const RequestStatusError = require('./Error/RequestStatusError');
-const RequestBodyError = require('./Error/RequestBodyError');
-const GetServersRequest = require('./Request/GetServersRequest');
-const GetPoolsRequest = require('./Request/Billing/Pool/GetPoolsRequest');
+import Server from './Server/Server.js'
+import Account from './Account/Account.js'
+import RequestStatusError from './Error/RequestStatusError.js'
+import RequestBodyError from './Error/RequestBodyError.js'
+import GetServersRequest from './Request/GetServersRequest.js'
+import GetPoolsRequest from './Request/Billing/Pool/GetPoolsRequest.js'
 
-const packageConfig = require('../package.json');
-const Pool = require("./Billing/Pool/Pool.js");
+import packageConfig from '../package.json' with { type: 'json' }
+import Pool from './Billing/Pool/Pool.js'
+import * as stream from "node:stream";
+import RequestError from "./Error/RequestError.js";
 
-class Client {
+export default class Client {
     /**
      * @type {string}
      */
@@ -109,62 +110,58 @@ class Client {
         request.client = this;
         const url = this.baseURL + request.getEndpoint();
 
-        let gotOptions = {
+        /** @type {RequestInit} */
+        const options = {
             method: request.method,
-            retry: 0,
-            responseType: request.responseType
-        };
+            headers: Object.assign({
+                "authorization": "Bearer " + this.#apiToken,
+                "user-agent": this.#userAgent
+            }, request.headers)
+        }
 
         if (request.hasBody()) {
-            gotOptions.body = request.getBody();
+            options.body = request.getBody();
         }
 
-        gotOptions.headers = Object.assign({
-            "authorization": "Bearer " + this.#apiToken,
-            "user-agent": this.#userAgent
-        }, request.headers);
-
         let response;
         try {
+            response = await fetch(url, options);
+            if (!response.ok) {
+                let data = null;
+                try {
+                    data = await response.json();
+                } catch (e) { }
+                throw new RequestStatusError(response, data)
+            }
             if (request.hasOutputStream()) {
-                await this.streamResponse(url, gotOptions, request.getOutputStream());
+                await response.body.pipeTo(stream.Writable.toWeb(request.getOutputStream()))
                 return request.createResponse();
-            } else {
-                response = await got(url, gotOptions);
             }
         } catch (e) {
             if (request.outputPath !== null) {
                 try {
-                    await fs.unlink(request.outputPath);
+                    await unlink(request.outputPath);
                 } catch (e) {
                     // ignore
                 }
             }
-            throw new RequestStatusError(e);
+
+            if (e instanceof RequestError) {
+                throw e;
+            }
+            throw new RequestError(e);
         }
 
-        if (!request.expectsJsonResponse() || response.body.success) {
-            return request.createResponse(response.body);
-        } else {
-            throw new RequestBodyError(response);
+        if (request.expectsJsonResponse()) {
+            const data = await response.json();
+            if (data.success) {
+                return request.createResponse(data);
+            }
+
+            throw new RequestBodyError(response, data);
         }
-    }
 
-    /**
-     * @param {string} url
-     * @param {{}} gotOptions
-     * @param {stream.Writable} outputStream
-     * @return {Promise<unknown>}
-     */
-    streamResponse(url, gotOptions, outputStream) {
-        return new Promise((resolve, reject) => {
-            let stream = got.stream(url, gotOptions);
-            stream.pipe(outputStream);
-            stream.on("error", async (error) => {
-                reject(error);
-            });
-            stream.on("end", resolve);
-        });
+        return request.createResponse(await response.text());
     }
 
     /**
@@ -217,5 +214,3 @@ class Client {
         return new Pool(this, id);
     }
 }
-
-module.exports = Client;

package/src/Error/RequestBodyError.js

@@ -1,10 +1,12 @@
-const RequestError = require('./RequestError');
+import RequestError from './RequestError.js'
 
-class RequestBodyError extends RequestError {
-    constructor(response) {
+export default class RequestBodyError extends RequestError {
+    /**
+     * @param {Response} response fetch response object
+     * @param {any} data response data
+     */
+    constructor(response, data) {
         super();
-        this.setErrorFromResponseBody(response);
+        this.setErrorFromResponseBody(response, data);
     }
 }
-
-module.exports = RequestBodyError;

package/src/Error/RequestError.js

@@ -1,25 +1,33 @@
-class RequestError extends Error {
-    statusCode;
-    error;
+export default class RequestError extends Error {
+    statusCode = 0;
+    /**
+     * @type {Response|null} Response object that caused the error (if any)
+     */
     response;
 
+    /**
+     * @param {Error|null} error
+     */
+    constructor(error = null) {
+        super();
+        if (error instanceof Error) {
+            this.message = error.toString();
+        }
+    }
+
     /**
      * Set error and status code from response object
      *
      * Returns if an error message was found
      *
-     * @param {{}} response
-     * @return {boolean}
+     * @param {Response} response fetch response object
+     * @param {any} data response data
      */
-    setErrorFromResponseBody(response) {
+    setErrorFromResponseBody(response, data) {
         this.response = response;
-        this.statusCode = typeof response.statusCode === "number" ? response.statusCode : 0;
-        if (typeof response.body === "object" && typeof response.body.success === "boolean" && !response.body.success && typeof response.body.error === "string") {
-            this.message = response.body.error;
-            return true;
+        this.statusCode = response.status;
+        if (typeof data === "object" && typeof data.success === "boolean" && !data.success && typeof data.error === "string") {
+            this.message = data.error;
         }
-        return false;
     }
 }
-
-module.exports = RequestError;

package/src/Error/RequestStatusError.js

@@ -1,12 +1,12 @@
-const RequestError = require('./RequestError');
+import RequestError from './RequestError.js'
 
-class RequestStatusError extends RequestError {
-    constructor(error) {
+export default class RequestStatusError extends RequestError {
+    /**
+     * @param {Response} response fetch response object
+     * @param {any} data response data
+     */
+    constructor(response, data) {
         super();
-        if (!error.response || !this.setErrorFromResponseBody(error.response)) {
-            this.message = error.toString();
-        }
+        this.setErrorFromResponseBody(response, data);
     }
 }
-
-module.exports = RequestStatusError;

package/src/Request/Account/GetAccountRequest.js

@@ -1,7 +1,5 @@
-const Request = require('../Request');
+import Request from '../Request.js'
 
-class GetAccountRequest extends Request {
+export default class GetAccountRequest extends Request {
     endpoint = "account/";
 }
-
-module.exports = GetAccountRequest;

package/src/Request/Billing/Pool/GetPoolMembersRequest.js

@@ -1,9 +1,7 @@
-const PoolRequest = require("./PoolRequest.js");
-const PoolMembersResponse = require("../../../Response/PoolMembersResponse.js");
+import PoolRequest from './PoolRequest.js'
+import PoolMembersResponse from '../../../Response/PoolMembersResponse.js'
 
-class GetPoolMembersRequest extends PoolRequest {
+export default class GetPoolMembersRequest extends PoolRequest {
     endpoint = "billing/pools/{id}/members";
     responseClass = PoolMembersResponse;
 }
-
-module.exports = GetPoolMembersRequest;

package/src/Request/Billing/Pool/GetPoolRequest.js

@@ -1,7 +1,5 @@
-const PoolRequest = require("./PoolRequest.js");
+import PoolRequest from './PoolRequest.js'
 
-class GetPoolRequest extends PoolRequest {
+export default class GetPoolRequest extends PoolRequest {
     endpoint = "billing/pools/{id}";
 }
-
-module.exports = GetPoolRequest;

package/src/Request/Billing/Pool/GetPoolServersRequest.js

@@ -1,9 +1,7 @@
-const PoolRequest = require("./PoolRequest.js");
-const ServersResponse = require("../../../Response/ServersResponse.js");
+import PoolRequest from './PoolRequest.js'
+import ServersResponse from '../../../Response/ServersResponse.js'
 
-class GetPoolServersRequest extends PoolRequest {
+export default class GetPoolServersRequest extends PoolRequest {
     endpoint = "billing/pools/{id}/servers";
     responseClass = ServersResponse;
 }
-
-module.exports = GetPoolServersRequest;

package/src/Request/Billing/Pool/GetPoolsRequest.js

@@ -1,9 +1,7 @@
-const Request = require('../../Request');
-const PoolsResponse = require("../../../Response/PoolsResponse.js");
+import Request from '../../Request.js'
+import PoolsResponse from '../../../Response/PoolsResponse.js'
 
-class GetPoolsRequest extends Request {
+export default class GetPoolsRequest extends Request {
     endpoint = "billing/pools";
     responseClass = PoolsResponse;
 }
-
-module.exports = GetPoolsRequest;

package/src/Request/Billing/Pool/PoolRequest.js

@@ -1,6 +1,6 @@
-const Request = require('../../Request.js');
+import Request from '../../Request.js'
 
-class PoolRequest extends Request {
+export default class PoolRequest extends Request {
     /**
      * Pool request constructor
      *
@@ -11,5 +11,3 @@ class PoolRequest extends Request {
         this.setParameter("id", id);
     }
 }
-
-module.exports = PoolRequest;

package/src/Request/GetServersRequest.js

@@ -1,10 +1,8 @@
-const Request = require('./Request');
-const ServersResponse = require('../Response/ServersResponse');
+import Request from './Request.js'
+import ServersResponse from '../Response/ServersResponse.js'
 
-class GetServersRequest extends Request {
+export default class GetServersRequest extends Request {
     endpoint = "servers";
     responseClass = ServersResponse;
 
 }
-
-module.exports = GetServersRequest;

package/src/Request/Request.js

@@ -1,9 +1,10 @@
-const {createReadStream} = require('fs');
-const {createWriteStream} = require("fs");
+import {createReadStream} from 'fs'
+import {createWriteStream} from 'fs'
 
-const Response = require('../Response/Response');
+import Response from '../Response/Response.js'
+import * as stream from "node:stream";
 
-class Request {
+export default class Request {
     /**
      * Request method, e.g. "GET" or "POST"
      *
@@ -63,7 +64,7 @@ class Request {
     /**
      * Optional stream to stream the response body to
      *
-     * @type {stream.Writable|null}
+     * @type {import('stream').Writable|null}
      */
     outputStream = null;
 
@@ -77,7 +78,7 @@ class Request {
     /**
      * Optional stream to read the request body from
      *
-     * @type {stream.Readable|null}
+     * @type {import('stream').Readable|null}
      */
     inputStream = null;
 
@@ -137,11 +138,11 @@ class Request {
     /**
      * Get body for request
      *
-     * @return {FormData|string|ReadStream}
+     * @return {BodyInit}
      */
     getBody() {
         if (this.hasInputStream()) {
-            return this.getInputStream();
+            return stream.Readable.toWeb(this.getInputStream());
         }
 
         if (typeof this.data === "string") {
@@ -172,7 +173,7 @@ class Request {
     }
 
     /**
-     * @return {null|stream.Writable}
+     * @return {null|import('stream').Writable}
      */
     getOutputStream() {
         if (this.outputStream !== null) {
@@ -192,7 +193,7 @@ class Request {
     }
 
     /**
-     * @return {null|stream.Readable}
+     * @return {null|import('stream').Readable}
      */
     getInputStream() {
         if (this.inputStream !== null) {
@@ -266,5 +267,3 @@ class Request {
         return this;
     }
 }
-
-module.exports = Request;

package/src/Request/Server/ExecuteServerCommandRequest.js

@@ -1,6 +1,6 @@
-const ServerRequest = require('./ServerRequest');
+import ServerRequest from './ServerRequest.js'
 
-class ExecuteServerCommandRequest extends ServerRequest {
+export default class ExecuteServerCommandRequest extends ServerRequest {
     endpoint = "servers/{id}/command";
     method = "POST";
 
@@ -16,5 +16,3 @@ class ExecuteServerCommandRequest extends ServerRequest {
         this.data = {command: command};
     }
 }
-
-module.exports = ExecuteServerCommandRequest;

package/src/Request/Server/ExtendServerStopTimeRequest.js

@@ -1,6 +1,6 @@
-const ServerRequest = require('./ServerRequest');
+import ServerRequest from './ServerRequest.js'
 
-class ExtendServerStopTimeRequest extends ServerRequest {
+export default class ExtendServerStopTimeRequest extends ServerRequest {
     endpoint = "servers/{id}/extend-time";
     method = "POST";
 
@@ -16,5 +16,3 @@ class ExtendServerStopTimeRequest extends ServerRequest {
         this.data = {time: time};
     }
 }
-
-module.exports = ExtendServerStopTimeRequest;

package/src/Request/Server/Files/Config/GetConfigFileOptionsRequest.js

@@ -1,7 +1,5 @@
-const FileRequest = require("../FileRequest");
+import FileRequest from '../FileRequest.js'
 
-class GetConfigFileOptionsRequest extends FileRequest {
+export default class GetConfigFileOptionsRequest extends FileRequest {
     endpoint = "servers/{id}/files/config/{path}";
 }
-
-module.exports = GetConfigFileOptionsRequest;

package/src/Request/Server/Files/Config/UpdateConfigFileOptionsRequest.js

@@ -1,6 +1,6 @@
-const FileRequest = require("../FileRequest");
+import FileRequest from '../FileRequest.js'
 
-class UpdateConfigFileOptionsRequest extends FileRequest {
+export default class UpdateConfigFileOptionsRequest extends FileRequest {
     endpoint = "servers/{id}/files/config/{path}";
     method = "POST";
 
@@ -17,5 +17,3 @@ class UpdateConfigFileOptionsRequest extends FileRequest {
         this.data = options;
     }
 }
-
-module.exports = UpdateConfigFileOptionsRequest;

package/src/Request/Server/Files/CreateDirectoryRequest.js

@@ -1,9 +1,7 @@
-const PutFileDataRequest = require("./PutFileDataRequest");
+import PutFileDataRequest from './PutFileDataRequest.js'
 
-class CreateDirectoryRequest extends PutFileDataRequest {
+export default class CreateDirectoryRequest extends PutFileDataRequest {
     headers = {
         "Content-Type": "inode/directory"
     }
 }
-
-module.exports = CreateDirectoryRequest;