@eleven-am/pondsocket 0.1.141 → 0.1.143

package/README.md

@@ -175,7 +175,7 @@ const endpoint = pond.createEndpoint('/api/socket', (req, res) => {
         const role = getRoleFromToken(token);
 
         // Handle socket connection and authentication for valid users
-        res.accept({ role }); // Assign the user's role to the socket
+        res.accept({role}); // Assign the user's role to the socket
     } else {
         // Reject the connection for invalid users or without a token
         res.reject('Invalid token', 401);
@@ -186,9 +186,9 @@ const endpoint = pond.createEndpoint('/api/socket', (req, res) => {
 const profanityChannel = endpoint.createChannel('/channel/:id', async (req, res) => {
     // When joining the channel, any joinParams passed from the client will be available in the request payload
     // Also any previous assigns on the socket will be available in the request payload as well
-    const { role } = req.user.assigns;
-    const { username } = req.joinParams;
-    const { id } = req.event.params;
+    const {role} = req.user.assigns;
+    const {username} = req.joinParams;
+    const {id} = req.event.params;
 
     // maybe retrieve the previous messages from the database
     const messages = await getMessagesFromDatabase(id);
@@ -196,7 +196,7 @@ const profanityChannel = endpoint.createChannel('/channel/:id', async (req, res)
     // Check if the user has the required role to join the channel
     if (role === 'admin') {
         // Accept the join request
-        res.accept({ username, profanityCount: 0 })
+        res.accept({username, profanityCount: 0})
             // optionally you can track the presence of the user in the channel
             .trackPresence({
                 username,
@@ -205,7 +205,7 @@ const profanityChannel = endpoint.createChannel('/channel/:id', async (req, res)
                 onlineSince: Date.now(),
             })
             // and send the user the channel history
-            .sendToUsers('history', { messages }, [req.user.id]);
+            .sendToUsers('history', {messages}, [req.user.id]);
 
         // Alternatively, you can also send messages to the user, NOTE that the user would be automatically subscribed to the channel.
         // res.send('history', { messages }, { username, profanityCount: 0 })
@@ -217,19 +217,19 @@ const profanityChannel = endpoint.createChannel('/channel/:id', async (req, res)
         //   });
     } else {
         // Reject the join request
-        res.reject('You do not have the required role to join this channel', 403);
+        res.decline('You do not have the required role to join this channel', 403);
     }
 });
 
 // Attach message event listener to the profanityChannel
 profanityChannel.onEvent('message', (req, res) => {
-    const { text } = req.event.payload;
+    const {text} = req.event.payload;
 
     // Check for profanity
     if (isTextProfane(text)) {
         // Reject the message if it contains profanity
-        res.reject('Profanity is not allowed', 400, {
-            profanityCount:  req.user.assigns.profanityCount + 1
+        res.decline('Profanity is not allowed', 400, {
+            profanityCount: req.user.assigns.profanityCount + 1
         });
 
         // note that profanityCount is updated so req.user.assigns.profanityCount will be updated
@@ -238,9 +238,9 @@ profanityChannel.onEvent('message', (req, res) => {
             res.evictUser('You have been kicked from the channel for using profanity');
         } else {
             // you can broadcast a message to all users or In the channel that profanity is not allowed
-            res.broadcast('profanity-warning', { message: 'Profanity is not allowed' })
+            res.broadcast('profanity-warning', {message: 'Profanity is not allowed'})
                 // or you can send a message to the user that profanity is not allowed
-                .sendToUsers('profanity-warning', { message: `You have used profanity ${profanityCount} times. You will be kicked from the channel if you use profanity more than 3 times.` }, [req.user.id]);
+                .sendToUsers('profanity-warning', {message: `You have used profanity ${profanityCount} times. You will be kicked from the channel if you use profanity more than 3 times.`}, [req.user.id]);
         }
     } else {
         // Accept the message to allow broadcasting to other clients in the channel
@@ -252,8 +252,8 @@ profanityChannel.onEvent('message', (req, res) => {
 });
 
 profanityChannel.onEvent('presence/:presence', (req, res) => {
-    const { presence } = req.event.params;
-    const { username } = req.user.assigns;
+    const {presence} = req.event.params;
+    const {username} = req.user.assigns;
 
     // Handle presence events
     res.updatePresence({
@@ -265,7 +265,7 @@ profanityChannel.onEvent('presence/:presence', (req, res) => {
 });
 
 profanityChannel.onLeave((event) => {
-    const { username } = event.assigns;
+    const {username} = event.assigns;
 
     // When a user leaves the channel, PondSocket will automatically remove the user from the presence list and inform other users in the channel
 

package/abstracts/abstractRequest.js

@@ -42,8 +42,7 @@ class AbstractRequest {
         return this._engine.getAssigns();
     }
     get presence() {
-        var _a;
-        return ((_a = this._engine.presenceEngine) === null || _a === void 0 ? void 0 : _a.getPresence()) || {};
+        return this._engine.presenceEngine.getPresence();
     }
     /**
      * @desc Parses the event and returns true if the event matches the path

package/abstracts/abstractRequest.test.js

@@ -1,11 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const abstractRequest_1 = require("./abstractRequest");
-const createMockChannelEngine = () => ({
-    name: 'test',
-    getAssigns: () => ({}),
-    getPresence: () => ({}),
-});
+const eventResponse_test_1 = require("../channel/eventResponse.test");
+const createMockChannelEngine = () => (0, eventResponse_test_1.createChannelEngine)().channelEngine;
 describe('AbstractRequest', () => {
     it('should be able to be instantiated', () => {
         const request = new abstractRequest_1.AbstractRequest('/test', createMockChannelEngine(), {});

package/channel/channel.js

@@ -21,58 +21,14 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
-var _Channel_engine, _ChannelEngine_instances, _ChannelEngine_receiver, _ChannelEngine_presenceEngine, _ChannelEngine_users, _ChannelEngine_parentEngine, _ChannelEngine_subscribe, _ChannelEngine_getUsersFromRecipients;
+var _ChannelEngine_instances, _ChannelEngine_receiver, _ChannelEngine_presenceEngine, _ChannelEngine_users, _ChannelEngine_parentEngine, _ChannelEngine_subscribe, _ChannelEngine_getUsersFromRecipients, _ChannelEngine_buildSubscription, _ChannelEngine_removeUser, _Channel_engine;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChannelEngine = exports.Channel = void 0;
+exports.Channel = exports.ChannelEngine = void 0;
 const pondsocket_common_1 = require("@eleven-am/pondsocket-common");
 const eventRequest_1 = require("./eventRequest");
 const eventResponse_1 = require("./eventResponse");
 const pondError_1 = require("../errors/pondError");
 const presence_1 = require("../presence/presence");
-class Channel {
-    constructor(engine) {
-        _Channel_engine.set(this, void 0);
-        __classPrivateFieldSet(this, _Channel_engine, engine, "f");
-    }
-    get name() {
-        return __classPrivateFieldGet(this, _Channel_engine, "f").name;
-    }
-    getAssigns() {
-        return __classPrivateFieldGet(this, _Channel_engine, "f").getAssigns();
-    }
-    getPresences() {
-        return __classPrivateFieldGet(this, _Channel_engine, "f").presenceEngine.getPresence();
-    }
-    getUserData(userId) {
-        return __classPrivateFieldGet(this, _Channel_engine, "f").getUserData(userId);
-    }
-    broadcastMessage(event, payload) {
-        __classPrivateFieldGet(this, _Channel_engine, "f").sendMessage((0, pondsocket_common_1.uuid)(), pondsocket_common_1.SystemSender.CHANNEL, pondsocket_common_1.ChannelReceiver.ALL_USERS, pondsocket_common_1.ServerActions.BROADCAST, event, payload);
-    }
-    broadcastMessageFromUser(userId, event, payload) {
-        __classPrivateFieldGet(this, _Channel_engine, "f").sendMessage((0, pondsocket_common_1.uuid)(), userId, pondsocket_common_1.ChannelReceiver.ALL_EXCEPT_SENDER, pondsocket_common_1.ServerActions.BROADCAST, event, payload);
-    }
-    sendToUser(userId, event, payload) {
-        __classPrivateFieldGet(this, _Channel_engine, "f").sendMessage((0, pondsocket_common_1.uuid)(), pondsocket_common_1.SystemSender.CHANNEL, [userId], pondsocket_common_1.ServerActions.BROADCAST, event, payload);
-    }
-    sendToUsers(userIds, event, payload) {
-        __classPrivateFieldGet(this, _Channel_engine, "f").sendMessage((0, pondsocket_common_1.uuid)(), pondsocket_common_1.SystemSender.CHANNEL, userIds, pondsocket_common_1.ServerActions.BROADCAST, event, payload);
-    }
-    evictUser(userId, reason) {
-        __classPrivateFieldGet(this, _Channel_engine, "f").kickUser(userId, reason !== null && reason !== void 0 ? reason : 'You have been banned from the channel');
-    }
-    trackPresence(userId, presence) {
-        __classPrivateFieldGet(this, _Channel_engine, "f").presenceEngine.trackPresence(userId, presence);
-    }
-    removePresence(userId) {
-        __classPrivateFieldGet(this, _Channel_engine, "f").presenceEngine.removePresence(userId);
-    }
-    updatePresence(userId, presence) {
-        __classPrivateFieldGet(this, _Channel_engine, "f").presenceEngine.updatePresence(userId, presence);
-    }
-}
-exports.Channel = Channel;
-_Channel_engine = new WeakMap();
 class ChannelEngine {
     constructor(name, parent) {
         _ChannelEngine_instances.add(this);
@@ -85,6 +41,21 @@ class ChannelEngine {
         __classPrivateFieldSet(this, _ChannelEngine_users, new Map(), "f");
         __classPrivateFieldSet(this, _ChannelEngine_parentEngine, parent, "f");
     }
+    /**
+     * @desc Gets the presence engine for the channel
+     */
+    get presenceEngine() {
+        var _a;
+        const presenceEngine = (_a = __classPrivateFieldGet(this, _ChannelEngine_presenceEngine, "f")) !== null && _a !== void 0 ? _a : new presence_1.PresenceEngine(this);
+        __classPrivateFieldSet(this, _ChannelEngine_presenceEngine, presenceEngine, "f");
+        return presenceEngine;
+    }
+    /**
+     * @desc Gets the number of users in the channel
+     */
+    get size() {
+        return __classPrivateFieldGet(this, _ChannelEngine_users, "f").size;
+    }
     /**
      * @desc Adds a user to the channel
      * @param userId - The id of the user to add
@@ -101,48 +72,18 @@ class ChannelEngine {
         __classPrivateFieldGet(this, _ChannelEngine_users, "f").set(userId, assigns);
         return __classPrivateFieldGet(this, _ChannelEngine_instances, "m", _ChannelEngine_subscribe).call(this, userId, onMessage);
     }
-    /**
-     * @desc Removes a user from the channel
-     * @param userId - The id of the user to remove
-     * @param isGraceful - Whether the user is being removed gracefully
-     */
-    removeUser(userId, isGraceful) {
-        var _a;
-        const user = __classPrivateFieldGet(this, _ChannelEngine_users, "f").get(userId);
-        if (user) {
-            __classPrivateFieldGet(this, _ChannelEngine_users, "f").delete(userId);
-            __classPrivateFieldGet(this, _ChannelEngine_receiver, "f").unsubscribe(userId);
-            const userPresence = (_a = __classPrivateFieldGet(this, _ChannelEngine_presenceEngine, "f")) === null || _a === void 0 ? void 0 : _a.removePresence(userId);
-            if (__classPrivateFieldGet(this, _ChannelEngine_parentEngine, "f").leaveCallback) {
-                __classPrivateFieldGet(this, _ChannelEngine_parentEngine, "f").leaveCallback({
-                    channel: new Channel(this),
-                    user: {
-                        id: userId,
-                        presence: userPresence !== null && userPresence !== void 0 ? userPresence : {},
-                        assigns: user,
-                    },
-                });
-            }
-            if (__classPrivateFieldGet(this, _ChannelEngine_users, "f").size === 0) {
-                __classPrivateFieldGet(this, _ChannelEngine_parentEngine, "f").destroyChannel();
-            }
-        }
-        else if (!isGraceful) {
-            throw new pondError_1.ChannelError(`ChannelEngine: User with id ${userId} does not exist in channel ${this.name}`, 404, this.name);
-        }
-    }
     /**
      * @desc Kicks a user from the channel
      * @param userId - The id of the user to kick
      * @param reason - The reason for kicking the user
      */
     kickUser(userId, reason) {
-        this.sendMessage((0, pondsocket_common_1.uuid)(), pondsocket_common_1.SystemSender.CHANNEL, [userId], pondsocket_common_1.ServerActions.SYSTEM, 'kicked_out', {
+        this.sendMessage(pondsocket_common_1.SystemSender.CHANNEL, [userId], pondsocket_common_1.ServerActions.SYSTEM, 'kicked_out', {
             message: reason,
             code: 403,
         });
-        this.removeUser(userId, false);
-        this.sendMessage((0, pondsocket_common_1.uuid)(), pondsocket_common_1.SystemSender.CHANNEL, pondsocket_common_1.ChannelReceiver.ALL_USERS, pondsocket_common_1.ServerActions.SYSTEM, 'kicked', {
+        __classPrivateFieldGet(this, _ChannelEngine_instances, "m", _ChannelEngine_removeUser).call(this, userId);
+        this.sendMessage(pondsocket_common_1.SystemSender.CHANNEL, pondsocket_common_1.ChannelReceiver.ALL_USERS, pondsocket_common_1.ServerActions.SYSTEM, 'kicked', {
             userId,
             reason,
         });
@@ -152,11 +93,11 @@ class ChannelEngine {
      * @param reason - The reason for self-destructing the channel
      */
     destroy(reason) {
-        this.sendMessage((0, pondsocket_common_1.uuid)(), pondsocket_common_1.SystemSender.CHANNEL, pondsocket_common_1.ChannelReceiver.ALL_USERS, pondsocket_common_1.ServerActions.ERROR, 'destroyed', {
+        this.sendMessage(pondsocket_common_1.SystemSender.CHANNEL, pondsocket_common_1.ChannelReceiver.ALL_USERS, pondsocket_common_1.ServerActions.ERROR, 'destroyed', {
             message: reason !== null && reason !== void 0 ? reason : 'Channel has been destroyed',
         });
-        __classPrivateFieldGet(this, _ChannelEngine_parentEngine, "f").destroyChannel();
-        __classPrivateFieldGet(this, _ChannelEngine_users, "f").forEach((_, userId) => this.removeUser(userId, true));
+        __classPrivateFieldGet(this, _ChannelEngine_parentEngine, "f").destroyChannel(this.name);
+        __classPrivateFieldGet(this, _ChannelEngine_users, "f").forEach((_, userId) => __classPrivateFieldGet(this, _ChannelEngine_instances, "m", _ChannelEngine_removeUser).call(this, userId));
     }
     /**
      * @desc Updates a user's assigns
@@ -207,7 +148,7 @@ class ChannelEngine {
      * @param event - The event name
      * @param payload - The payload of the message
      */
-    sendMessage(requestId, sender, recipient, action, event, payload) {
+    sendMessage(sender, recipient, action, event, payload, requestId = (0, pondsocket_common_1.uuid)()) {
         if (!__classPrivateFieldGet(this, _ChannelEngine_users, "f").has(sender) && sender !== pondsocket_common_1.SystemSender.CHANNEL) {
             throw new pondError_1.ChannelError(`ChannelEngine: User with id ${sender} does not exist in channel ${this.name}`, 404, this.name);
         }
@@ -237,41 +178,42 @@ class ChannelEngine {
             action: pondsocket_common_1.ServerActions.BROADCAST,
             channelName: this.name,
             requestId: message.requestId,
-            recipients: __classPrivateFieldGet(this, _ChannelEngine_instances, "m", _ChannelEngine_getUsersFromRecipients).call(this, message.addresses || pondsocket_common_1.ChannelReceiver.ALL_USERS, userId),
         };
         const request = new eventRequest_1.EventRequest(responseEvent, this);
         const response = new eventResponse_1.EventResponse(responseEvent, this);
-        __classPrivateFieldGet(this, _ChannelEngine_parentEngine, "f").execute(request, response, () => {
-            this.sendMessage(responseEvent.requestId, pondsocket_common_1.SystemSender.CHANNEL, [userId], pondsocket_common_1.ServerActions.ERROR, pondsocket_common_1.ErrorTypes.HANDLER_NOT_FOUND, {
+        __classPrivateFieldGet(this, _ChannelEngine_parentEngine, "f").middleware.run(request, response, () => {
+            this.sendMessage(pondsocket_common_1.SystemSender.CHANNEL, [userId], pondsocket_common_1.ServerActions.ERROR, pondsocket_common_1.ErrorTypes.HANDLER_NOT_FOUND, {
                 message: 'A handler did not respond to the event',
                 code: 404,
-            });
+            }, message.requestId);
         });
     }
     /**
-     * @desc Gets the presence engine for the channel
+     * @desc Subscribes a user to a channel, Will join the channel if it exists or add to pending subscriptions
+     * @param userId - The id of the user to subscribe
+     * @param channel - The name of the channel to subscribe to
      */
-    get presenceEngine() {
-        var _a;
-        const presenceEngine = (_a = __classPrivateFieldGet(this, _ChannelEngine_presenceEngine, "f")) !== null && _a !== void 0 ? _a : new presence_1.PresenceEngine(this);
-        __classPrivateFieldSet(this, _ChannelEngine_presenceEngine, presenceEngine, "f");
-        return presenceEngine;
+    subscribeTo(userId, channel) {
+        __classPrivateFieldGet(this, _ChannelEngine_parentEngine, "f").parent.subscribeTo(userId, channel);
     }
     /**
-     * @desc Gets the number of users in the channel
+     * @desc Unsubscribes a user from a channel
+     * @param userId - The id of the user to unsubscribe
+     * @param channel - The name of the channel to unsubscribe from
      */
-    get size() {
-        return __classPrivateFieldGet(this, _ChannelEngine_users, "f").size;
+    unsubscribeFrom(userId, channel) {
+        __classPrivateFieldGet(this, _ChannelEngine_parentEngine, "f").parent.unsubscribeFrom(userId, channel);
     }
 }
 exports.ChannelEngine = ChannelEngine;
 _ChannelEngine_receiver = new WeakMap(), _ChannelEngine_presenceEngine = new WeakMap(), _ChannelEngine_users = new WeakMap(), _ChannelEngine_parentEngine = new WeakMap(), _ChannelEngine_instances = new WeakSet(), _ChannelEngine_subscribe = function _ChannelEngine_subscribe(userId, onMessage) {
-    return __classPrivateFieldGet(this, _ChannelEngine_receiver, "f").subscribeWith(userId, (_a) => {
+    const unsubscribe = __classPrivateFieldGet(this, _ChannelEngine_receiver, "f").subscribe((_a) => {
         var { recipients } = _a, event = __rest(_a, ["recipients"]);
         if (recipients.includes(userId)) {
             onMessage(event);
         }
     });
+    return __classPrivateFieldGet(this, _ChannelEngine_instances, "m", _ChannelEngine_buildSubscription).bind(this, userId, unsubscribe);
 }, _ChannelEngine_getUsersFromRecipients = function _ChannelEngine_getUsersFromRecipients(recipients, sender) {
     const allUsers = Array.from(__classPrivateFieldGet(this, _ChannelEngine_users, "f").keys());
     let users;
@@ -296,4 +238,83 @@ _ChannelEngine_receiver = new WeakMap(), _ChannelEngine_presenceEngine = new Wea
             break;
     }
     return users;
+}, _ChannelEngine_buildSubscription = function _ChannelEngine_buildSubscription(userId, unsubscribe) {
+    var _a;
+    const user = __classPrivateFieldGet(this, _ChannelEngine_users, "f").get(userId);
+    if (!user) {
+        throw new pondError_1.ChannelError(`ChannelEngine: User with id ${userId} does not exist in channel ${this.name}`, 404, this.name);
+    }
+    unsubscribe();
+    __classPrivateFieldGet(this, _ChannelEngine_users, "f").delete(userId);
+    const userPresence = (_a = __classPrivateFieldGet(this, _ChannelEngine_presenceEngine, "f")) === null || _a === void 0 ? void 0 : _a.removePresence(userId);
+    if (__classPrivateFieldGet(this, _ChannelEngine_parentEngine, "f").leaveCallback) {
+        __classPrivateFieldGet(this, _ChannelEngine_parentEngine, "f").leaveCallback({
+            // eslint-disable-next-line @typescript-eslint/no-use-before-define
+            channel: new Channel(this),
+            user: {
+                id: userId,
+                presence: userPresence !== null && userPresence !== void 0 ? userPresence : {},
+                assigns: user,
+            },
+        });
+    }
+    if (__classPrivateFieldGet(this, _ChannelEngine_users, "f").size === 0) {
+        __classPrivateFieldGet(this, _ChannelEngine_parentEngine, "f").destroyChannel(this.name);
+    }
+}, _ChannelEngine_removeUser = function _ChannelEngine_removeUser(userId) {
+    const cachedUser = __classPrivateFieldGet(this, _ChannelEngine_parentEngine, "f").parent.getUser(userId);
+    const unsubscribe = cachedUser.subscriptions.get(this.name);
+    if (!unsubscribe) {
+        throw new pondError_1.ChannelError(`ChannelEngine: User with id ${userId} does not exist in channel ${this.name}`, 404, this.name);
+    }
+    unsubscribe();
+    cachedUser.subscriptions.delete(this.name);
 };
+class Channel {
+    constructor(engine) {
+        _Channel_engine.set(this, void 0);
+        __classPrivateFieldSet(this, _Channel_engine, engine, "f");
+    }
+    get name() {
+        return __classPrivateFieldGet(this, _Channel_engine, "f").name;
+    }
+    getAssigns() {
+        return __classPrivateFieldGet(this, _Channel_engine, "f").getAssigns();
+    }
+    getPresences() {
+        return __classPrivateFieldGet(this, _Channel_engine, "f").presenceEngine.getPresence();
+    }
+    getUserData(userId) {
+        return __classPrivateFieldGet(this, _Channel_engine, "f").getUserData(userId);
+    }
+    broadcast(event, payload) {
+        __classPrivateFieldGet(this, _Channel_engine, "f").sendMessage(pondsocket_common_1.SystemSender.CHANNEL, pondsocket_common_1.ChannelReceiver.ALL_USERS, pondsocket_common_1.ServerActions.BROADCAST, event, payload);
+    }
+    broadcastFrom(userId, event, payload) {
+        __classPrivateFieldGet(this, _Channel_engine, "f").sendMessage(userId, pondsocket_common_1.ChannelReceiver.ALL_EXCEPT_SENDER, pondsocket_common_1.ServerActions.BROADCAST, event, payload);
+    }
+    broadcastTo(userIds, event, payload) {
+        const users = Array.isArray(userIds) ? userIds : [userIds];
+        __classPrivateFieldGet(this, _Channel_engine, "f").sendMessage(pondsocket_common_1.SystemSender.CHANNEL, users, pondsocket_common_1.ServerActions.BROADCAST, event, payload);
+    }
+    evictUser(userId, reason) {
+        __classPrivateFieldGet(this, _Channel_engine, "f").kickUser(userId, reason !== null && reason !== void 0 ? reason : 'You have been banned from the channel');
+    }
+    trackPresence(userId, presence) {
+        __classPrivateFieldGet(this, _Channel_engine, "f").presenceEngine.trackPresence(userId, presence);
+    }
+    removePresence(userId) {
+        __classPrivateFieldGet(this, _Channel_engine, "f").presenceEngine.removePresence(userId);
+    }
+    updatePresence(userId, presence) {
+        __classPrivateFieldGet(this, _Channel_engine, "f").presenceEngine.updatePresence(userId, presence);
+    }
+    subscribeTo(userId, channel) {
+        __classPrivateFieldGet(this, _Channel_engine, "f").subscribeTo(userId, channel);
+    }
+    unsubscribeFrom(userId, channel) {
+        __classPrivateFieldGet(this, _Channel_engine, "f").unsubscribeFrom(userId, channel);
+    }
+}
+exports.Channel = Channel;
+_Channel_engine = new WeakMap();