bedrock-portal 0.6.3 → 0.7.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020
-
-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.
+MIT License
+
+Copyright (c) 2020
+
+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

@@ -1,260 +1,260 @@
-# BedrockPortal
-[![NPM version](https://img.shields.io/npm/v/bedrock-portal.svg)](http://npmjs.com/package/bedrock-portal)
-[![Discord](https://img.shields.io/badge/chat-on%20discord-brightgreen.svg)](https://discord.gg/KTyd9HWuBD)
-
-Handles and creates a Minecraft Bedrock game session which will redirect players to the specified server. Join our [Discord](https://discord.com/invite/KTyd9HWuBD) for support.
-
-## Installation
-```shell
-npm install bedrock-portal
-```
-
-### Warning
-This package is not meant to be used with your main account. It is meant to be used with alt accounts. If you use this package with your main account, you may be banned from the XSAPI. This package is not affiliated with Mojang or Microsoft.
-
-## Usage
-
-### BedrockPortal(authflow, options)
-**Parameters**
-- authflow - Takes an **Authflow** instance from [prismarine-auth](https://github.com/PrismarineJS/prismarine-auth), you can see the documentation for this [here.](https://github.com/PrismarineJS/prismarine-auth#authflow)
-- options
-  - **ip** - The IP address of the server to redirect players to (required)
-  - **port** - The port of the server to redirect players to | default: 19132
-  - **joinability** - The joinability of the session  | default: FriendsOfFriends
-  - **world** - The world config to use for the session. Changes the session card which is displayed in the Minecraft client. (optional)
-	  - **hostName** - string
-	  - **name** - string
-	  - **version** - string
-	  - **memberCount** - number
-	  - **maxMemberCount** - number
-
-### Create a session redirect to a server
-```js
-const { BedrockPortal, Joinability } = require('bedrock-portal');
-const { Authflow, Titles } = require('prismarine-auth');
-
-const main = async () => {
-  const auth = new Authflow('example', './', { authTitle: Titles.MinecraftNintendoSwitch, deviceType: 'Nintendo', flow: 'live' });
-  
-  const portal = new BedrockPortal(auth, {
-    // The server IP & port to redirect players to
-    ip: 'geyserconnect.net',
-    port: 19132,
-
-     // The joinability of the session. Joinability.FriendsOfFriends, Joinability.FriendsOnly, Joinability.InviteOnly
-    joinability: Joinability.FriendsOfFriends
-  });
-
-  await portal.start();
-	
-  // accepts a player's gamertag or xuid
-  await portal.invitePlayer('p3')
-
-};
-
-main();
-```
-
-## Modules
-
-Modules are used to extend the functionality of the BedrockPortal class.
-
-### MultipleAccounts
-
-Allows the portal to use multiple accounts to redirect players to the server. `#.use(Modules.MultipleAccounts, options);`
-
-Options:
-- **accounts**: Authflow[] - An array of authflows from [prismarine-auth](https://github.com/PrismarineJS/prismarine-auth), these accounts are automatically added to the host session and allows players to add them as a friend to join the game. (required)
-
-```js
-const { Authflow, Titles } = require('prismarine-auth')
-const { BedrockPortal, Modules } = require('bedrock-portal')
-
-const main = async () => {
-  const auth = new Authflow('example', './', { authTitle: Titles.MinecraftNintendoSwitch, deviceType: 'Nintendo', flow: 'live' })
-
-  const portal = new BedrockPortal(auth, {
-    ip: 'geyserconnect.net',
-    port: 19132,
-  })
-
-  portal.use(Modules.AutoFriendAdd, {
-    inviteOnAdd: true,
-  })
-
-  portal.use(Modules.MultipleAccounts, {
-    accounts: [
-      new Authflow('account1', './', { authTitle: Titles.MinecraftNintendoSwitch, deviceType: 'Nintendo', flow: 'live' }),
-      new Authflow('account2', './', { authTitle: Titles.MinecraftNintendoSwitch, deviceType: 'Nintendo', flow: 'live' }),
-    ],
-  })
-
-  await portal.start()
-}
-
-main()
-```
-
-
-### RedirectFromRealm
-
-> Requires [bedrock-protocol](https://github.com/PrismarineJS/bedrock-protocol) to be installed. `npm install bedrock-protocol`
-
-Invites players when they join a Realm to the specified server or if they use the chat command. `#.use(Modules.redirectFromRealm, options);`
-
-Options:
-- **clientOptions**: ClientOptions - The client options to use when connecting to the Realm. These are passed directly to a [bedrock-protocol createClient](https://github.com/PrismarineJS/bedrock-protocol/blob/master/docs/API.md#becreateclientoptions--client) function. See the documentation for more information. 
-- **chatCommand**: object - Options for the chat command
-  - **enabled**: boolean - Whether sending the command in chat should trigger an invite (default: true)
-  - **message**: string - The message to send in chat to run the command (default: 'invite')
-  - **cooldown**: number - The cooldown between being able to send the command in chat (default: 60000ms)
-
-```js
-const { BedrockPortal, Modules } = require('bedrock-portal');
-
-const portal = new BedrockPortal(auth, { ... })
-
-portal.use(Modules.RedirectFromRealm, {
-  // The client options to use when connecting to the Realm.
-  clientOptions: {
-    realms: {
-      realmInvite: ''
-    }
-  },
-  // Options for the chat command
-  chatCommand: {
-    // Whether sending the command in chat should trigger an invite (optional - defaults to true)
-    enabled: true,
-    // The message to send in chat to run the command (optional - defaults to 'invite')
-    message: 'invite',
-    // The cooldown between being able to send the command in chat (optional - defaults to 60000ms)
-    cooldown: 60000,
-  }
-}
-```
-
-### AutoFriendAdd
-
-Automatically adds the account's followers as friends and invites them to the game. `#.use(Modules.autoFriendAdd);`
-
-Options:
-- **inviteOnAdd**: boolean - Automatically invites recently added friends to the game (default: false)
-- **conditionToMeet**: (player: RawPlayer) => boolean - A function that returns a boolean. If the function returns true, followers will be added as a friend and the friends that don't will be removed (default: () => true)
-- **checkInterval**: number - How often to check for friends to add/remove (default: 30000ms)
-- **addInterval**: number - How long to wait between adding friends (default: 2000ms)
-- **removeInterval**: number - How long to wait between removing friends (default: 2000ms)
-
-```js
-const { BedrockPortal, Modules } = require('bedrock-portal');
-
-const portal = new BedrockPortal(auth, { ... })
-
-portal.use(Modules.AutoFriendAdd);
-
-// or
-
-portal.use(Modules.AutoFriendAdd, {
-  // When a friend is added, automatically invite them to the game
-  inviteOnAdd: true,
-  // Only add friends that are online and remove friends that are offline
-  conditionToMeet: (player) => player.presenceState === 'Online',
-  // How often to check for friends to add/remove (optional - defaults to 30000ms)
-  checkInterval: 30000,
-  // How long to wait between adding friends (optional - defaults to 2000ms)
-  addInterval: 2000,
-  // How long to wait between removing friends (optional - defaults to 2000ms)
-  removeInterval: 2000,
-});
-```
-
-### InviteOnMessage
-
-Automatically invites players to the game when they send a message in the chat. `#.use(Modules.inviteOnMessage);`
-
-Options:
-- **command**: string - The command to use to invite players (default: 'invite')
-- **checkInterval**: number - How often to check for messages (default: 30000ms)
-
-```js
-const { BedrockPortal, Modules } = require('bedrock-portal');
-
-const portal = new BedrockPortal(auth, { ... })
-
-portal.use(Modules.InviteOnMessage);
-
-// or
-
-portal.use(Modules.InviteOnMessage, {
-  // The command to use to invite players (optional - defaults to 'invite')
-  command: 'invite',
-  // How often to check for messages (optional - defaults to 30000ms)
-  checkInterval: 30000,
-});
-```
-
-## Modules API
-
-Creating a module is easy. You can create a module by extending the `Module` class.
-
-Note: The `stopped` property is set to `true` when the portal is stopped. You can use this to stop the module's loop (if one is present) else the process will not exit.
-
-```js
-const { Module } = require('bedrock-portal');
-
-const myModule = class MyModule extends Module {
-  constructor() {
-    super('myModule', 'Description of my module');
-    this.options = {
-      option1: true,
-    }
-  }
-
-  async run(portal) {
-    // portal - The BedrockPortal instance
-
-    // Do stuff here
-  }
-
-  async stop() {
-    super.stop();
-    // Do stuff when the module is stopped
-  }
-}
-
-portal.use(myModule, {
-  option1: false,
-});
-
-```
-
-## Events
-
-### portal.on('sessionCreated', (session) => void)
-Emitted when a session is created.
-
-### portal.on('sessionUpdated', (session) => void)
-Emitted when a session is updated.
-
-### portal.on('playerJoin', (player) => void)
-Emitted when a player joins the session.
-
-### portal.on('playerLeave', (player) => void)
-Emitted when a player leaves the session.
-
-
-### portal.on('friendAdded', (player) => void)
-Emitted when a player is added as a friend. This event is only emitted when the `autoFriendAdd` module is enabled.
-
-### portal.on('friendRemoved', (player) => void)
-Emitted when a player is removed as a friend. This event is only emitted when the `autoFriendAdd` module is enabled.
-
-### portal.on('messageRecieved', (message) => void)
-Emitted when a message is recieved from a player. This event is only emitted when the `inviteOnMessage` module is enabled.
-
-## Debugging
-
-You can enable some debugging output using the `DEBUG` enviroment variable. Through node.js, you can add `process.env.DEBUG = 'bedrock-portal*'` at the top of your code.
-
-## License
-
-[MIT](LICENSE)
+# BedrockPortal
+[![NPM version](https://img.shields.io/npm/v/bedrock-portal.svg)](http://npmjs.com/package/bedrock-portal)
+[![Discord](https://img.shields.io/badge/chat-on%20discord-brightgreen.svg)](https://discord.gg/KTyd9HWuBD)
+
+Handles and creates a Minecraft Bedrock game session which will redirect players to the specified server. Join our [Discord](https://discord.com/invite/KTyd9HWuBD) for support.
+
+## Installation
+```shell
+npm install bedrock-portal
+```
+
+### Warning
+This package is not meant to be used with your main account. It is meant to be used with alt accounts. If you use this package with your main account, you may be banned from the XSAPI. This package is not affiliated with Mojang or Microsoft.
+
+## Usage
+
+### BedrockPortal(authflow, options)
+**Parameters**
+- authflow - Takes an **Authflow** instance from [prismarine-auth](https://github.com/PrismarineJS/prismarine-auth), you can see the documentation for this [here.](https://github.com/PrismarineJS/prismarine-auth#authflow)
+- options
+  - **ip** - The IP address of the server to redirect players to (required)
+  - **port** - The port of the server to redirect players to | default: 19132
+  - **joinability** - The joinability of the session  | default: FriendsOfFriends
+  - **world** - The world config to use for the session. Changes the session card which is displayed in the Minecraft client. (optional)
+	  - **hostName** - string
+	  - **name** - string
+	  - **version** - string
+	  - **memberCount** - number
+	  - **maxMemberCount** - number
+
+### Create a session redirect to a server
+```js
+const { BedrockPortal, Joinability } = require('bedrock-portal');
+const { Authflow, Titles } = require('prismarine-auth');
+
+const main = async () => {
+  const auth = new Authflow('example', './', { authTitle: Titles.MinecraftNintendoSwitch, deviceType: 'Nintendo', flow: 'live' });
+  
+  const portal = new BedrockPortal(auth, {
+    // The server IP & port to redirect players to
+    ip: 'geyserconnect.net',
+    port: 19132,
+
+     // The joinability of the session. Joinability.FriendsOfFriends, Joinability.FriendsOnly, Joinability.InviteOnly
+    joinability: Joinability.FriendsOfFriends
+  });
+
+  await portal.start();
+	
+  // accepts a player's gamertag or xuid
+  await portal.invitePlayer('p3')
+
+};
+
+main();
+```
+
+## Modules
+
+Modules are used to extend the functionality of the BedrockPortal class.
+
+### MultipleAccounts
+
+Allows the portal to use multiple accounts to redirect players to the server. `#.use(Modules.MultipleAccounts, options);`
+
+Options:
+- **accounts**: Authflow[] - An array of authflows from [prismarine-auth](https://github.com/PrismarineJS/prismarine-auth), these accounts are automatically added to the host session and allows players to add them as a friend to join the game. (required)
+
+```js
+const { Authflow, Titles } = require('prismarine-auth')
+const { BedrockPortal, Modules } = require('bedrock-portal')
+
+const main = async () => {
+  const auth = new Authflow('example', './', { authTitle: Titles.MinecraftNintendoSwitch, deviceType: 'Nintendo', flow: 'live' })
+
+  const portal = new BedrockPortal(auth, {
+    ip: 'geyserconnect.net',
+    port: 19132,
+  })
+
+  portal.use(Modules.AutoFriendAdd, {
+    inviteOnAdd: true,
+  })
+
+  portal.use(Modules.MultipleAccounts, {
+    accounts: [
+      new Authflow('account1', './', { authTitle: Titles.MinecraftNintendoSwitch, deviceType: 'Nintendo', flow: 'live' }),
+      new Authflow('account2', './', { authTitle: Titles.MinecraftNintendoSwitch, deviceType: 'Nintendo', flow: 'live' }),
+    ],
+  })
+
+  await portal.start()
+}
+
+main()
+```
+
+
+### RedirectFromRealm
+
+> Requires [bedrock-protocol](https://github.com/PrismarineJS/bedrock-protocol) to be installed. `npm install bedrock-protocol`
+
+Invites players when they join a Realm to the specified server or if they use the chat command. `#.use(Modules.redirectFromRealm, options);`
+
+Options:
+- **clientOptions**: ClientOptions - The client options to use when connecting to the Realm. These are passed directly to a [bedrock-protocol createClient](https://github.com/PrismarineJS/bedrock-protocol/blob/master/docs/API.md#becreateclientoptions--client) function. See the documentation for more information. 
+- **chatCommand**: object - Options for the chat command
+  - **enabled**: boolean - Whether sending the command in chat should trigger an invite (default: true)
+  - **message**: string - The message to send in chat to run the command (default: 'invite')
+  - **cooldown**: number - The cooldown between being able to send the command in chat (default: 60000ms)
+
+```js
+const { BedrockPortal, Modules } = require('bedrock-portal');
+
+const portal = new BedrockPortal(auth, { ... })
+
+portal.use(Modules.RedirectFromRealm, {
+  // The client options to use when connecting to the Realm.
+  clientOptions: {
+    realms: {
+      realmInvite: ''
+    }
+  },
+  // Options for the chat command
+  chatCommand: {
+    // Whether sending the command in chat should trigger an invite (optional - defaults to true)
+    enabled: true,
+    // The message to send in chat to run the command (optional - defaults to 'invite')
+    message: 'invite',
+    // The cooldown between being able to send the command in chat (optional - defaults to 60000ms)
+    cooldown: 60000,
+  }
+}
+```
+
+### AutoFriendAdd
+
+Automatically adds the account's followers as friends and invites them to the game. `#.use(Modules.autoFriendAdd);`
+
+Options:
+- **inviteOnAdd**: boolean - Automatically invites recently added friends to the game (default: false)
+- **conditionToMeet**: (player: RawPlayer) => boolean - A function that returns a boolean. If the function returns true, followers will be added as a friend and the friends that don't will be removed (default: () => true)
+- **checkInterval**: number - How often to check for friends to add/remove (default: 30000ms)
+- **addInterval**: number - How long to wait between adding friends (default: 2000ms)
+- **removeInterval**: number - How long to wait between removing friends (default: 2000ms)
+
+```js
+const { BedrockPortal, Modules } = require('bedrock-portal');
+
+const portal = new BedrockPortal(auth, { ... })
+
+portal.use(Modules.AutoFriendAdd);
+
+// or
+
+portal.use(Modules.AutoFriendAdd, {
+  // When a friend is added, automatically invite them to the game
+  inviteOnAdd: true,
+  // Only add friends that are online and remove friends that are offline
+  conditionToMeet: (player) => player.presenceState === 'Online',
+  // How often to check for friends to add/remove (optional - defaults to 30000ms)
+  checkInterval: 30000,
+  // How long to wait between adding friends (optional - defaults to 2000ms)
+  addInterval: 2000,
+  // How long to wait between removing friends (optional - defaults to 2000ms)
+  removeInterval: 2000,
+});
+```
+
+### InviteOnMessage
+
+Automatically invites players to the game when they send a message in the chat. `#.use(Modules.inviteOnMessage);`
+
+Options:
+- **command**: string - The command to use to invite players (default: 'invite')
+- **checkInterval**: number - How often to check for messages (default: 30000ms)
+
+```js
+const { BedrockPortal, Modules } = require('bedrock-portal');
+
+const portal = new BedrockPortal(auth, { ... })
+
+portal.use(Modules.InviteOnMessage);
+
+// or
+
+portal.use(Modules.InviteOnMessage, {
+  // The command to use to invite players (optional - defaults to 'invite')
+  command: 'invite',
+  // How often to check for messages (optional - defaults to 30000ms)
+  checkInterval: 30000,
+});
+```
+
+## Modules API
+
+Creating a module is easy. You can create a module by extending the `Module` class.
+
+Note: The `stopped` property is set to `true` when the portal is stopped. You can use this to stop the module's loop (if one is present) else the process will not exit.
+
+```js
+const { Module } = require('bedrock-portal');
+
+const myModule = class MyModule extends Module {
+  constructor() {
+    super('myModule', 'Description of my module');
+    this.options = {
+      option1: true,
+    }
+  }
+
+  async run(portal) {
+    // portal - The BedrockPortal instance
+
+    // Do stuff here
+  }
+
+  async stop() {
+    super.stop();
+    // Do stuff when the module is stopped
+  }
+}
+
+portal.use(myModule, {
+  option1: false,
+});
+
+```
+
+## Events
+
+### portal.on('sessionCreated', (session) => void)
+Emitted when a session is created.
+
+### portal.on('sessionUpdated', (session) => void)
+Emitted when a session is updated.
+
+### portal.on('playerJoin', (player) => void)
+Emitted when a player joins the session.
+
+### portal.on('playerLeave', (player) => void)
+Emitted when a player leaves the session.
+
+
+### portal.on('friendAdded', (player) => void)
+Emitted when a player is added as a friend. This event is only emitted when the `autoFriendAdd` module is enabled.
+
+### portal.on('friendRemoved', (player) => void)
+Emitted when a player is removed as a friend. This event is only emitted when the `autoFriendAdd` module is enabled.
+
+### portal.on('messageRecieved', (message) => void)
+Emitted when a message is recieved from a player. This event is only emitted when the `inviteOnMessage` module is enabled.
+
+## Debugging
+
+You can enable some debugging output using the `DEBUG` enviroment variable. Through node.js, you can add `process.env.DEBUG = 'bedrock-portal*'` at the top of your code.
+
+## License
+
+[MIT](LICENSE)

package/dist/classes/Host.js

@@ -1,13 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -27,33 +18,30 @@ class Host {
         this.authflow = authflow;
         this.rest = new rest_1.default(this.authflow);
     }
-    connect() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const auth = yield this.authflow.getXboxToken();
-            this.profile = yield this.rest.getProfile(auth.userXUID);
-            this.rta = new xbox_rta_1.XboxRTA(this.authflow);
-            yield this.rta.connect();
-            const subResponse = yield this.rta.subscribe('https://sessiondirectory.xboxlive.com/connections/');
-            this.connectionId = subResponse.data.ConnectionId;
-            this.rta.on('subscribe', (event) => this.onSubscribe(event));
-        });
+    async connect() {
+        const auth = await this.authflow.getXboxToken();
+        this.profile = await this.rest.getProfile(auth.userXUID);
+        // @ts-expect-error - XboxRTA isnt using the #playfab branch
+        this.rta = new xbox_rta_1.XboxRTA(this.authflow);
+        await this.rta.connect();
+        const subResponse = await this.rta.subscribe('https://sessiondirectory.xboxlive.com/connections/');
+        this.connectionId = subResponse.data.ConnectionId;
+        this.rta.on('subscribe', (event) => this.onSubscribe(event));
     }
-    onSubscribe(event) {
-        return __awaiter(this, void 0, void 0, function* () {
-            debug('Received RTA subscribe event', event);
-            const connectionId = event.data.ConnectionId;
-            if (connectionId && typeof connectionId === 'string') {
-                try {
-                    this.connectionId = connectionId;
-                    yield this.rest.updateConnection(this.portal.session.name, connectionId);
-                    yield this.rest.setActivity(this.portal.session.name);
-                }
-                catch (e) {
-                    debug('Failed to update connection, session may have been abandoned', e);
-                    yield this.portal.end(true);
-                }
+    async onSubscribe(event) {
+        debug('Received RTA subscribe event', event);
+        const connectionId = event.data.ConnectionId;
+        if (connectionId && typeof connectionId === 'string') {
+            try {
+                this.connectionId = connectionId;
+                await this.rest.updateConnection(this.portal.session.name, connectionId);
+                await this.rest.setActivity(this.portal.session.name);
+            }
+            catch (e) {
+                debug('Failed to update connection, session may have been abandoned', e);
+                await this.portal.end(true);
             }
-        });
+        }
     }
 }
 exports.default = Host;