bedrock-portal 0.3.0 → 0.4.0

package/README.md

@@ -64,6 +64,9 @@ Automatically adds the account's followers as friends and invites them to the ga
 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');
@@ -75,8 +78,41 @@ portal.use(Modules.autoFriendAdd);
 // or
 
 portal.use(Modules.autoFriendAdd, {
+  // When a friend is added, automatically invite them to the game
   inviteOnAdd: true,
-  conditionToMeet: (player) => player.presenceState === 'Online', // Only add friends that are online and remove friends that are offline
+  // 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: 1000ms)
+
+```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 1000ms)
+  checkInterval: 30000,
 });
 ```
 
@@ -151,6 +187,9 @@ Emitted when a player is removed as a friend. This event is only emitted when th
 **Parameters**
 - player - [Player](#player) object
 
+### portal.on('messageRecieved', (message) => {})
+Emitted when a message is recieved from a player. This event is only emitted when the `inviteOnMessage` module is enabled.
+
 ## Objects
 
 ### Player

package/examples/portal.js

@@ -23,7 +23,15 @@ const main = async () => {
 
   portal.use(Modules.autoFriendAdd, {          // Automatically adds friends to the session
     inviteOnAdd: true,
-    conditionToMeet: (player) => player.presenceState === 'Online', // Only add friends that are online and remove friends that are offline
+    // conditionToMeet: (player) => player.presenceState === 'Online', // Only add friends that are online and remove friends that are offline
+    // checkInterval: 30000,                                           // How often to check for friends to add/remove (optional - defaults to 30000ms)
+    // addInterval: 2000,                                              // How long to wait between adding friends (optional - defaults to 2000ms)
+    // removeInterval: 2000,                                           // How long to wait between removing friends (optional - defaults to 2000ms)
+  });
+
+  portal.use(Modules.inviteOnMessage, {        // Automatically invites players when they send a message with the specified command
+    command: 'invite',                         // The command to use to invite players (optional - defaults to 'invite')
+    checkInterval: 30000,                      // How often to check for messages (optional - defaults to 30000ms)
   });
 
   // Put your event listeners before portal.start() to ensure you don't miss any events
@@ -56,6 +64,10 @@ const main = async () => {
     console.log('Friend Removed: ', player);
   });
 
+  portal.on('messageRecieved', (message) => {  // Emits when a message is received. Only emitted if inviteOnMessage module is used
+    console.log('Message Received: ', message);
+  });
+
   await portal.start();                        // Starts the session
 
   await portal.invitePlayer('p3');             // gamertag or xuid to invite

package/index.js

@@ -3,6 +3,7 @@ module.exports = {
   Module : require('./src/classes/Module'),
   Modules: {
     autoFriendAdd: require('./src/modules/autoFriendAdd'),
+    inviteOnMessage: require('./src/modules/inviteOnMessage'),
   },
   Joinability: {
     InviteOnly: 'invite_only',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bedrock-portal",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Creates a joinable session in Minecraft Bedrock Edition that can route players to their a specified host",
   "main": "index.js",
   "scripts": {

package/src/modules/autoFriendAdd.js

@@ -8,6 +8,9 @@ class AutoFriendAdd extends Module {
     this.options = {
       inviteOnAdd: false,
       conditionToMeet: () => true,
+      checkInterval: 30000,
+      addInterval: 2000,
+      removeInterval: 2000,
     };
   }
 
@@ -42,7 +45,7 @@ class AutoFriendAdd extends Module {
 
           this.debug(`Added & invited ${account.gamertag}`);
 
-          await new Promise(resolve => setTimeout(resolve, 2000));
+          await new Promise(resolve => setTimeout(resolve, this.options.addInterval));
         }
 
         this.debug('Checking for friends to remove');
@@ -65,7 +68,7 @@ class AutoFriendAdd extends Module {
 
           this.debug(`Removed ${account.gamertag}`);
 
-          await new Promise(resolve => setTimeout(resolve, 2000));
+          await new Promise(resolve => setTimeout(resolve, this.options.removeInterval));
         }
 
       }
@@ -73,7 +76,7 @@ class AutoFriendAdd extends Module {
         this.debug(`Error: ${error.message}`, error);
       }
 
-      await new Promise(resolve => setTimeout(resolve, 30000));
+      await new Promise(resolve => setTimeout(resolve, this.options.checkInterval));
     }
   }
 }

package/src/modules/inviteOnMessage.js

@@ -0,0 +1,68 @@
+/* eslint-disable no-constant-condition */
+const Module = require('../classes/Module.js');
+
+class IniteOnMessage extends Module {
+  constructor() {
+    super('initeOnMessage', 'Automatically invite players to the server when they message you');
+    this.options = {
+      command: 'invite',
+      checkInterval: 30000,
+    };
+    this.cache = [];
+  }
+
+  async run(portal, { rest, rta }) {
+
+    const initeOnMessage = async () => {
+      const primaryMessages = await rest.get('https://xblmessaging.xboxlive.com/network/xbox/users/me/inbox/primary', { contractVersion: 1 });
+      const secondaryMessages = await rest.get('https://xblmessaging.xboxlive.com/network/xbox/users/me/inbox/secondary', { contractVersion: 1 });
+
+      const messages = [...primaryMessages.conversations, ...secondaryMessages.conversations];
+
+      const contentMessages = messages.filter(message => message.lastMessage.type === 'ContentMessage');
+
+      this.debug(`Found ${contentMessages.length} content message(s)`);
+
+      if (this.cache.length === 0) return this.cache = contentMessages;
+
+      // use #.lastMessage.messageId
+      const newMessages = contentMessages.filter(message => this.cache.some(cacheMessage => cacheMessage.lastMessage.messageId !== message.lastMessage.messageId && cacheMessage.conversationId === message.conversationId));
+
+      this.debug(`Found ${newMessages.length} new message(s)`);
+
+      if (newMessages.length === 0) return;
+
+      for (const message of newMessages) {
+        portal.emit('messageRecieved', message.lastMessage);
+
+        const senderXuid = message.lastMessage.sender;
+
+        if (senderXuid === '0') continue;
+
+        this.debug(`Received message from ${senderXuid}`);
+
+        const content = message.lastMessage.contentPayload.content.parts.find(part => part.contentType === 'text')?.text;
+
+        if (!content) continue;
+
+        if (content.toLowerCase() === this.options.command.toLowerCase()) {
+          await portal.invitePlayer(senderXuid);
+        }
+      }
+
+      this.cache = contentMessages;
+    };
+
+    while (!this.stopped) {
+      try {
+        await initeOnMessage();
+        await new Promise(resolve => setTimeout(resolve, this.options.checkInterval));
+      }
+      catch (error) {
+        this.debug(`Error: ${error.message}`, error);
+      }
+    }
+  }
+}
+
+module.exports = IniteOnMessage;

package/src/rest.js

@@ -81,7 +81,9 @@ module.exports = class Rest {
     const response = await this.get(`https://profile.xboxlive.com/users/${target}/profile/settings`, { params: { settings }, contractVersion: 2 });
 
     const [avatar, gamerscore, gamertag, tier, reputation, colour, realname, bio, location, modernGamertag, modernGamertagSuffix, uniqueModernGamertag, realnameOverride, tenureLevel, watermarks, isQuarantined, linkedAccounts] = response.profileUsers[0].settings.map(e=> e.value);
-    const colourData = await axios.get(colour).then(e => e.data);
+    const colourData = await axios.get(colour, { timeout: 5000 })
+      .then(e => e.data)
+      .catch(() => ({ primaryColor: '000000', secondaryColor: '000000', tertiaryColor: '000000' }));
 
     return {
       xuid: response.profileUsers[0].id,