bedrock-portal 0.8.2 → 0.8.4

package/README.md

@@ -133,6 +133,27 @@ portal.use(Modules.RedirectFromRealm, {
 }
 ```
 
+### UpdateMemberCount
+
+> Requires [bedrock-protocol](https://github.com/PrismarineJS/bedrock-protocol) to be installed. `npm install bedrock-protocol`
+
+Periodically updates the member count of the session. `#.use(Modules.UpdateMemberCount, options);`
+
+Options:
+- **updateInterval**: number - How often to update the member count (default: 60000ms)
+- **updateMaxMemberCount**: boolean - Whether to update the max member count (default: true)
+
+```js
+const { BedrockPortal, Modules } = require('bedrock-portal');
+
+const portal = new BedrockPortal(auth, { ... })
+
+portal.use(Modules.UpdateMemberCount, {
+  updateInterval: 60000,
+  updateMaxMemberCount: false,
+});
+```
+
 ### AutoFriendAdd
 
 Automatically adds the account's followers as friends and invites them to the game. `#.use(Modules.autoFriendAdd);`
@@ -273,8 +294,11 @@ Emitted when a player is added as a friend. This event is only emitted when the
 ### 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.
+### portal.on('messageReceived', (message) => void)
+Emitted when a message is received from a player. This event is only emitted when the `inviteOnMessage` module is enabled.
+
+### portal.on('memberCountUpdate', (memberCount) => void)
+Emitted when the member count of the session is updated. This event is only emitted when the `updateMemberCount` module is enabled.
 
 ## Debugging
 

package/dist/index.d.ts

@@ -7,10 +7,12 @@ import Host from './classes/Host';
 import Player from './classes/Player';
 import Module from './classes/Module';
 import { Joinability } from './common/constants';
-import AutoFriendAdd from './modules/autoFriendAccept';
+import AutoFriendAdd from './modules/autoFriendAdd';
 import InviteOnMessage from './modules/inviteOnMessage';
 import RedirectFromRealm from './modules/redirectFromRealm';
 import MultipleAccounts from './modules/multipleAccounts';
+import AutoFriendAccept from './modules/autoFriendAccept';
+import UpdateMemberCount from './modules/updateMemberCount';
 type BedrockPortalOptions = {
     /**
      * The ip of the server to redirect users to.
@@ -83,8 +85,14 @@ interface PortalEvents {
     playerJoin: (player: Player) => void;
     playerLeave: (player: Player) => void;
     messageRecieved: (message: Message) => void;
+    messageReceived: (message: Message) => void;
     friendRemoved: (player: Player) => void;
     friendAdded: (player: Player) => void;
+    memberCountUpdate: (data: {
+        online: number;
+        max: number;
+        cycle: number;
+    }) => void;
 }
 export declare class BedrockPortal extends TypedEmitter<PortalEvents> {
     authflow: Authflow;
@@ -117,8 +125,9 @@ export declare class BedrockPortal extends TypedEmitter<PortalEvents> {
     /**
      * Updates the current member count which is displayed in the Minecraft client.
      * @param count The new member count.
+     * @param maxCount The new max member count.
      */
-    updateMemberCount(count: number): Promise<void>;
+    updateMemberCount(count: number, maxCount?: number): Promise<void>;
     /**
      * Gets the current session of the BedrockPortal instance.
      */
@@ -149,6 +158,7 @@ declare const Modules: {
     InviteOnMessage: typeof InviteOnMessage;
     RedirectFromRealm: typeof RedirectFromRealm;
     MultipleAccounts: typeof MultipleAccounts;
-    AutoFriendAccept: typeof AutoFriendAdd;
+    AutoFriendAccept: typeof AutoFriendAccept;
+    UpdateMemberCount: typeof UpdateMemberCount;
 };
 export { Modules };

package/dist/index.js

@@ -13,11 +13,12 @@ const Module_1 = __importDefault(require("./classes/Module"));
 exports.Module = Module_1.default;
 const constants_1 = require("./common/constants");
 const Event_1 = __importDefault(require("./handlers/Event"));
-const autoFriendAccept_1 = __importDefault(require("./modules/autoFriendAccept"));
+const autoFriendAdd_1 = __importDefault(require("./modules/autoFriendAdd"));
 const inviteOnMessage_1 = __importDefault(require("./modules/inviteOnMessage"));
 const redirectFromRealm_1 = __importDefault(require("./modules/redirectFromRealm"));
 const multipleAccounts_1 = __importDefault(require("./modules/multipleAccounts"));
-const autoFriendAccept_2 = __importDefault(require("./modules/autoFriendAccept"));
+const autoFriendAccept_1 = __importDefault(require("./modules/autoFriendAccept"));
+const updateMemberCount_1 = __importDefault(require("./modules/updateMemberCount"));
 const start_game_1 = require("./common/start_game");
 const util_1 = require("./common/util");
 const debug = (0, debug_1.default)('bedrock-portal');
@@ -135,9 +136,10 @@ class BedrockPortal extends tiny_typed_emitter_1.TypedEmitter {
     /**
      * Updates the current member count which is displayed in the Minecraft client.
      * @param count The new member count.
+     * @param maxCount The new max member count.
      */
-    async updateMemberCount(count) {
-        await this.host.rest.updateMemberCount(this.session.name, count);
+    async updateMemberCount(count, maxCount) {
+        await this.host.rest.updateMemberCount(this.session.name, count, maxCount);
     }
     /**
      * Gets the current session of the BedrockPortal instance.
@@ -249,10 +251,11 @@ exports.BedrockPortal = BedrockPortal;
 var constants_2 = require("./common/constants");
 Object.defineProperty(exports, "Joinability", { enumerable: true, get: function () { return constants_2.Joinability; } });
 const Modules = {
-    AutoFriendAdd: autoFriendAccept_1.default,
+    AutoFriendAdd: autoFriendAdd_1.default,
     InviteOnMessage: inviteOnMessage_1.default,
     RedirectFromRealm: redirectFromRealm_1.default,
     MultipleAccounts: multipleAccounts_1.default,
-    AutoFriendAccept: autoFriendAccept_2.default,
+    AutoFriendAccept: autoFriendAccept_1.default,
+    UpdateMemberCount: updateMemberCount_1.default,
 };
 exports.Modules = Modules;

package/dist/modules/inviteOnMessage.js

@@ -32,7 +32,11 @@ class IniteOnMessage extends Module_1.default {
             if (newMessages.length === 0)
                 return;
             for (const message of newMessages) {
-                portal.emit('messageRecieved', message.lastMessage);
+                if (portal.listenerCount('messageRecieved') > 0) {
+                    console.warn('[Deprecation Warning]: The event \'messageRecieved\' is deprecated and will be removed in a future release. Please use \'messageReceived\' instead.');
+                    portal.emit('messageRecieved', message.lastMessage);
+                }
+                portal.emit('messageReceived', message.lastMessage);
                 const senderXuid = message.lastMessage.sender;
                 if (senderXuid === '0')
                     continue;

package/dist/modules/multipleAccounts.js

@@ -25,7 +25,6 @@ class MultipleAccounts extends Module_1.default {
             const peer = new Host_1.default(portal, account);
             await peer.connect();
             if (!peer.profile || !peer.connectionId) {
-                // @ts-expect-error - username isn't defined on Authflow
                 this.debug(`Failed to connect to ${account.username}`);
                 continue;
             }

package/dist/modules/updateMemberCount.d.ts

@@ -0,0 +1,7 @@
+import { BedrockPortal } from '..';
+import Module from '../classes/Module';
+export default class UpdateMemberCount extends Module {
+    ping: any;
+    constructor();
+    run(portal: BedrockPortal): Promise<void>;
+}

package/dist/modules/updateMemberCount.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Module_1 = __importDefault(require("../classes/Module"));
+class UpdateMemberCount extends Module_1.default {
+    ping;
+    constructor() {
+        super('updateMemberCount', 'Periodically updates the member count of the session to the amount of players online');
+        this.options = {
+            updateInterval: 60000,
+            updateMaxMemberCount: true,
+        };
+        try {
+            this.ping = require('bedrock-protocol').ping;
+        }
+        catch (e) {
+            console.trace('bedrock-protocol is not installed, please run "npm i bedrock-protocol" to use this module');
+            process.exit(1);
+        }
+    }
+    async run(portal) {
+        let cycle = 0;
+        setInterval(async () => {
+            try {
+                const data = await this.ping({ host: portal.options.ip, port: portal.options.port });
+                this.debug(`Updating member count to ${data.playersOnline} / ${data.playersMax}`);
+                await portal.updateMemberCount(data.playersOnline, this.options.updateMaxMemberCount ? data.playersMax : undefined);
+                portal.emit('memberCountUpdate', { online: Number(data.playersOnline), max: Number(data.playersMax), cycle });
+            }
+            catch (error) {
+                this.debug(`Error updating member count - ${error.message}`, error);
+            }
+            cycle++;
+        }, this.options.updateInterval);
+    }
+}
+exports.default = UpdateMemberCount;

package/dist/rest.d.ts

@@ -32,7 +32,7 @@ export default class Rest {
     sendInvite(sessionName: string, xuid: string): Promise<any>;
     getSession(sessionName: string): Promise<RESTSessionResponse>;
     updateSession(sessionName: string, payload: SessionRequest): Promise<RESTSessionResponse>;
-    updateMemberCount(sessionName: string, count: number): Promise<void>;
+    updateMemberCount(sessionName: string, count: number, maxCount?: number): Promise<void>;
     addConnection(sessionName: string, xuid: string, connectionId: string, subscriptionId: string): Promise<void>;
     updateConnection(sessionName: string, connectionId: string): Promise<void>;
     leaveSession(sessionName: string): Promise<void>;

package/dist/rest.js

@@ -86,8 +86,9 @@ class Rest {
         });
         return response;
     }
-    async updateMemberCount(sessionName, count) {
-        await this.updateSession(sessionName, { properties: { custom: { MemberCount: Number(count) } } });
+    async updateMemberCount(sessionName, count, maxCount) {
+        const payload = maxCount ? { MemberCount: count, MaxMemberCount: maxCount } : { MemberCount: count };
+        await this.updateSession(sessionName, { properties: { custom: payload } });
     }
     async addConnection(sessionName, xuid, connectionId, subscriptionId) {
         const payload = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bedrock-portal",
-  "version": "0.8.2",
+  "version": "0.8.4",
   "description": "Creates a joinable session in Minecraft Bedrock Edition that can route players to their a specified host",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",