bedrock-portal 0.2.7 → 0.3.0

package/README.md

@@ -63,6 +63,7 @@ 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)
 
 ```js
 const { BedrockPortal, Modules } = require('bedrock-portal');
@@ -75,6 +76,7 @@ portal.use(Modules.autoFriendAdd);
 
 portal.use(Modules.autoFriendAdd, {
   inviteOnAdd: true,
+  conditionToMeet: (player) => player.presenceState === 'Online', // Only add friends that are online and remove friends that are offline
 });
 ```
 
@@ -143,6 +145,12 @@ Emitted when a player is added as a friend. This event is only emitted when the
 **Parameters**
 - player - [Player](#player) object
 
+### portal.on('friendRemoved', (player) => {})
+Emitted when a player is removed as a friend. This event is only emitted when the `autoFriendAdd` module is enabled.
+
+**Parameters**
+- player - [Player](#player) object
+
 ## Objects
 
 ### Player
@@ -258,6 +266,83 @@ Emitted when a player is added as a friend. This event is only emitted when the
 }
 ```
 
+### RawPlayer
+
+```ts
+{
+    xuid: string;
+    isFavorite: boolean;
+    isFollowingCaller: boolean;
+    isFollowedByCaller: boolean;
+    isIdentityShared: boolean;
+    addedDateTimeUtc: string;
+    displayName: string;
+    realName: string;
+    displayPicRaw: string;
+    showUserAsAvatar: string;
+    gamertag: string;
+    gamerScore: string;
+    modernGamertag: string;
+    modernGamertagSuffix: string;
+    uniqueModernGamertag: string;
+    xboxOneRep: string;
+    presenceState: string;
+    presenceText: string;
+    presenceDevices: null | any[];
+    isBroadcasting: boolean;
+    isCloaked: null | boolean;
+    isQuarantined: boolean;
+    isXbox360Gamerpic: boolean;
+    lastSeenDateTimeUtc: string;
+    suggestion: null;
+    recommendation: null;
+    search: null;
+    titleHistory: null;
+    multiplayerSummary: null;
+    recentPlayer: null;
+    follower: {
+        text: string;
+        followedDateTime: string;
+    };
+    preferredColor: {
+        primaryColor: string;
+        secondaryColor: string;
+        tertiaryColor: string;
+    };
+    presenceDetails: null;
+    titlePresence: null;
+    titleSummaries: null;
+    presenceTitleIds: null;
+    detail: {
+        accountTier: string;
+        bio: string;
+        isVerified: boolean;
+        location: string;
+        tenure: string;
+        watermarks: any[];
+        blocked: boolean;
+        mute: boolean;
+        followerCount: number;
+        followingCount: number;
+        hasGamePass: boolean;
+    };
+    communityManagerTitles: null;
+    socialManager: null;
+    broadcast: null;
+    avatar: null;
+    linkedAccounts: {
+      networkName: string;
+      displayName: string;
+      showOnProfile: boolean;
+      isFamilyFriendly: boolean;
+      deeplink: null;
+    }[];
+    colorTheme: string;
+    preferredFlag: string;
+    preferredPlatforms: string[];
+}
+```
+
 
 ## Debugging
 

package/examples/portal.js

@@ -23,6 +23,7 @@ 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
   });
 
   // Put your event listeners before portal.start() to ensure you don't miss any events
@@ -51,6 +52,10 @@ const main = async () => {
     console.log('Friend Added: ', player);
   });
 
+  portal.on('friendRemoved', (player) => {     // Emits when a friend is removed. Only emitted if autoFriendAdd module is used
+    console.log('Friend Removed: ', player);
+  });
+
   await portal.start();                        // Starts the session
 
   await portal.invitePlayer('p3');             // gamertag or xuid to invite

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bedrock-portal",
-  "version": "0.2.7",
+  "version": "0.3.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/classes/Module.js

@@ -7,7 +7,10 @@ class Module {
     this.debug = require('debug')(`bedrock-portal:${this.name}`);
   }
   applyOptions(options) {
-    this.options = options;
+    this.options = {
+      ...this.options,
+      ...options,
+    };
   }
   stop() {
     this.stopped = true;

package/src/modules/autoFriendAdd.js

@@ -7,6 +7,7 @@ class AutoFriendAdd extends Module {
     super('autoFriendAdd', 'Automatically adds followers as friends');
     this.options = {
       inviteOnAdd: false,
+      conditionToMeet: () => true,
     };
   }
 
@@ -17,24 +18,12 @@ class AutoFriendAdd extends Module {
 
         this.debug('Checking for followers to add');
 
-        const friends = await rest.getXboxFriends()
-          .then(people => people.map(e => e.xuid))
-          .catch(() => []);
-
-        this.debug(`Found ${friends.length} friend(s)`);
-
         const followers = await rest.getXboxFollowers()
           .catch(() => []);
 
         this.debug(`Found ${followers.length} follower(s)`);
 
-        const needsAdding = followers.filter(res => !friends.includes(res.xuid));
-
-        if (!needsAdding.length) {
-          this.debug('No followers to add');
-          await new Promise(resolve => setTimeout(resolve, 30000));
-          continue;
-        }
+        const needsAdding = followers.filter(res => !res.isFollowedByCaller && this.options.conditionToMeet(res));
 
         this.debug(`Adding ${needsAdding.length} account(s) [${needsAdding.map(res => res.gamertag).join(', ')}]`);
 
@@ -53,8 +42,32 @@ class AutoFriendAdd extends Module {
 
           this.debug(`Added & invited ${account.gamertag}`);
 
-          await new Promise(resolve => setTimeout(resolve, 10000));
+          await new Promise(resolve => setTimeout(resolve, 2000));
+        }
+
+        this.debug('Checking for friends to remove');
+
+        const friends = await rest.getXboxFriends()
+          .catch(() => []);
+
+        this.debug(`Found ${friends.length} friend(s)`);
+
+        const needsRemoving = friends.filter(res => !res.isFollowingCaller || !this.options.conditionToMeet(res));
+
+        this.debug(`Removing ${needsRemoving.length} account(s) [${needsRemoving.map(res => res.gamertag).join(', ')}]`);
+
+        for (const account of needsRemoving) {
+          await rest.removeXboxFriend(account.xuid).catch(err => {
+            throw Error(`Failed to remove ${account.gamertag}`, { cause: err });
+          });
+
+          portal.emit('friendRemoved', Player.fromXboxProfile(account));
+
+          this.debug(`Removed ${account.gamertag}`);
+
+          await new Promise(resolve => setTimeout(resolve, 2000));
         }
+
       }
       catch (error) {
         this.debug(`Error: ${error.message}`, error);

package/src/rest.js

@@ -114,19 +114,24 @@ module.exports = class Rest {
   }
 
   async getXboxFriends() {
-    return await this.get('https://peoplehub.xboxlive.com/users/me/people/social/decoration/detail,preferredColor', { contractVersion: 5 }).then(res => res.people.map(e => this.#parseXboxProfile(e)));
+    return await this.get('https://peoplehub.xboxlive.com/users/me/people/social/decoration/detail,preferredColor,follower', { contractVersion: 5 }).then(res => res.people.map(e => this.#parseXboxProfile(e)));
   }
 
   async getXboxFollowers() {
-    return await this.get('https://peoplehub.xboxlive.com/users/me/people/followers/decoration/detail,preferredColor', { contractVersion: 5 }).then(res => res.people.map(e => this.#parseXboxProfile(e)));
+    return await this.get('https://peoplehub.xboxlive.com/users/me/people/followers/decoration/detail,preferredColor,follower', { contractVersion: 5 }).then(res => res.people.map(e => this.#parseXboxProfile(e)));
   }
 
   async addXboxFriend(xuid) {
     return await this.put(`https://social.xboxlive.com/users/me/people/xuid(${xuid})`, { contractVersion: 2 });
   }
 
+  async removeXboxFriend(xuid) {
+    return await this.delete(`https://social.xboxlive.com/users/me/people/xuid(${xuid})`, { contractVersion: 2 });
+  }
+
   #parseXboxProfile(profile) {
     return {
+      ...profile,
       xuid: profile.xuid,
       avatar: profile.displayPicRaw,
       gamerscore: profile.gamerScore,