exaroton 1.6.1 → 1.7.2

package/README.md

@@ -2,7 +2,7 @@
 
 ## About
 The exaroton API allows automated access to some basic functionalities of your game servers, such as starting or stopping 
-the server. You can read the API documentation here: https://support.exaroton.com/hc/en-us/articles/360011926177
+the server. You can read the API documentation here: https://developers.exaroton.com
 
 This is the official Node.js implementation of this API.
 
@@ -32,7 +32,7 @@ let account = await client.getAccount();
 console.log("My account is " + account.name + " and I have " + account.credits + " credits.");
 ````
 
-The account object contains the fields and information as listed in the [documentation](https://support.exaroton.com/hc/en-us/articles/360011926177#account).
+The account object contains the fields and information as listed in the [documentation](https://developers.exaroton.com/#account-get).
 
 #### List servers
 ```js
@@ -43,7 +43,7 @@ for(let server of servers) {
 }
 ```
 
-Each server object contains the fields and information as listed in the [documentation](https://support.exaroton.com/hc/en-us/articles/360011926177#servers).
+Each server object contains the fields and information as listed in the [documentation](https://developers.exaroton.com/#servers-get).
 
 #### Create a server object by ID
 ```js
@@ -68,7 +68,7 @@ if (server.hasStatus(server.STATUS.ONLINE)) {
     console.log("Server is offline.");
 }
 ```
-The server status is an `integer` as described in the [documentation](https://support.exaroton.com/hc/en-us/articles/360011926177#servers). You can use
+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
 shorthand `server.STATUS` property.
 
@@ -136,6 +136,25 @@ try {
 ```
 The RAM is set in full GiB and has to be between 2 and 16.
 
+#### Get the server MOTD
+```js
+try {
+    let motd = await server.getMOTD();
+    console.log(motd);
+} catch (e) {
+    console.error(e.message);
+}
+```
+
+#### Set the server MOTD
+```js
+try {
+    await server.setMOTD("Hello world!");
+} catch (e) {
+    console.error(e.message);
+}
+```
+
 #### Player lists
 A player list is a list of players such as the whitelist, ops or bans.
 Player list entries are usually usernames, but might be something else, e.g. IPs in the banned-ips list.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "exaroton",
-  "version": "1.6.1",
+  "version": "1.7.2",
   "description": "exaroton API client",
   "homepage": "https://exaroton.com",
   "main": "index.js",

package/src/Client.js

@@ -136,7 +136,7 @@ class Client {
     /**
      * Get a list of all servers
      *
-     * @return {Response}
+     * @return {Promise<Server[]>}
      * @throws {RequestError}
      */
     async getServers() {

package/src/Server/Server.js

@@ -236,6 +236,24 @@ class Server extends EventEmitter {
         return this.setOption("ram", ram);
     }
 
+    /**
+     * Get the server MOTD
+     *
+     * @returns {Promise<string>}
+     */
+    getMOTD() {
+        return this.getOption("motd");
+    }
+
+    /**
+     * Set the server MOTD
+     *
+     * @param {string} motd
+     * @returns {Promise<Response>}
+     */
+    setMOTD(motd) {
+        return this.setOption("motd", motd);
+    }
 
     /**
      * Get a server option
@@ -326,7 +344,7 @@ class Server extends EventEmitter {
      * Subscribe to one or multiple streams
      *
      * @return {boolean}
-     * @param {string[]|string} streams
+     * @param {string[]|string} [streams]
      */
     subscribe(streams) {
         let websocketClient = this.getWebsocketClient();
@@ -354,7 +372,7 @@ class Server extends EventEmitter {
     /**
      * Unsubscribe from one, multiple or all streams
      *
-     * @param {string[]|string} streams
+     * @param {string[]|string} [streams]
      */
     unsubscribe(streams) {
         let websocketClient = this.getWebsocketClient();
@@ -403,6 +421,28 @@ class Server extends EventEmitter {
         }
         return this;
     }
+
+    /**
+     * Only return intended public fields for JSON serialization
+     *
+     * Otherwise, fields inherited from EventEmitter would be serialized as well
+     *
+     * @returns {{}}
+     */
+    toJSON() {
+        return {
+            id: this.id,
+            name: this.name,
+            address: this.address,
+            motd: this.motd,
+            status: this.status,
+            host: this.host,
+            port: this.port,
+            shared: this.shared,
+            software: this.software,
+            players: this.players
+        }
+    }
 }
 
 module.exports = Server;