@eleven-am/pondsocket-client 0.0.12 → 0.0.14

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/browser/client.js

@@ -34,8 +34,8 @@ class PondClient {
         }
         this._address = address;
         __classPrivateFieldSet(this, _PondClient_channels, {}, "f");
-        this._broadcaster = new pondsocket_common_1.SimpleSubject();
-        this._connectionState = new pondsocket_common_1.SimpleBehaviorSubject(false);
+        this._broadcaster = new pondsocket_common_1.Subject();
+        this._connectionState = new pondsocket_common_1.BehaviorSubject(false);
     }
     /**
      * @desc Connects to the server and returns the socket.

package/browser/client.test.js

@@ -89,7 +89,6 @@ describe('PondClient', () => {
         const sentObject = mockWebSocket.send.mock.calls[0][0];
         expect(sentObject).toBeDefined();
         expect(JSON.parse(sentObject)).toEqual(expect.objectContaining({
-            addresses: pondsocket_common_1.ChannelReceiver.ALL_USERS,
             action: pondsocket_common_1.ClientActions.JOIN_CHANNEL,
             event: pondsocket_common_1.ClientActions.JOIN_CHANNEL,
             payload: {},

package/core/channel.js

@@ -32,8 +32,8 @@ class Channel {
         __classPrivateFieldSet(this, _Channel_joinParams, params, "f");
         __classPrivateFieldSet(this, _Channel_publisher, publisher, "f");
         __classPrivateFieldSet(this, _Channel_clientState, clientState, "f");
-        __classPrivateFieldSet(this, _Channel_receiver, new pondsocket_common_1.SimpleSubject(), "f");
-        __classPrivateFieldSet(this, _Channel_joinState, new pondsocket_common_1.SimpleBehaviorSubject(pondsocket_common_1.ChannelState.IDLE), "f");
+        __classPrivateFieldSet(this, _Channel_receiver, new pondsocket_common_1.Subject(), "f");
+        __classPrivateFieldSet(this, _Channel_joinState, new pondsocket_common_1.BehaviorSubject(pondsocket_common_1.ChannelState.IDLE), "f");
         __classPrivateFieldSet(this, _Channel_presenceSub, __classPrivateFieldGet(this, _Channel_instances, "m", _Channel_init).call(this, receiver), "f");
     }
     /**
@@ -63,7 +63,6 @@ class Channel {
      */
     leave() {
         const leaveMessage = {
-            addresses: pondsocket_common_1.ChannelReceiver.ALL_USERS,
             action: pondsocket_common_1.ClientActions.LEAVE_CHANNEL,
             event: pondsocket_common_1.ClientActions.LEAVE_CHANNEL,
             channelName: __classPrivateFieldGet(this, _Channel_name, "f"),
@@ -141,11 +140,10 @@ class Channel {
      * @desc Sends a message to specific clients in the channel.
      * @param event - The event to send.
      * @param payload - The message to send.
-     * @param recipient - The clients to send the message to.
      */
-    sendMessage(event, payload, recipient) {
+    sendMessage(event, payload) {
         const requestId = (0, pondsocket_common_1.uuid)();
-        __classPrivateFieldGet(this, _Channel_instances, "m", _Channel_send).call(this, event, requestId, payload, recipient);
+        __classPrivateFieldGet(this, _Channel_instances, "m", _Channel_send).call(this, event, requestId, payload);
     }
     /**
      * @desc Sends a message to the server and waits for a response.
@@ -164,24 +162,6 @@ class Channel {
             __classPrivateFieldGet(this, _Channel_instances, "m", _Channel_send).call(this, sentEvent, requestId, payload);
         });
     }
-    /**
-     * @desc Broadcasts a message to every other client in the channel except yourself.
-     * @param event - The event to send.
-     * @param payload - The message to send.
-     */
-    broadcastFrom(event, payload) {
-        const requestId = (0, pondsocket_common_1.uuid)();
-        __classPrivateFieldGet(this, _Channel_instances, "m", _Channel_send).call(this, event, requestId, payload, pondsocket_common_1.ChannelReceiver.ALL_EXCEPT_SENDER);
-    }
-    /**
-     * @desc Broadcasts a message to the channel, including yourself.
-     * @param event - The event to send.
-     * @param payload - The message to send.
-     */
-    broadcast(event, payload) {
-        const requestId = (0, pondsocket_common_1.uuid)();
-        __classPrivateFieldGet(this, _Channel_instances, "m", _Channel_send).call(this, event, requestId, payload);
-    }
     /**
      * @desc Gets the current presence of the channel.
      */
@@ -224,11 +204,10 @@ class Channel {
     }
 }
 exports.Channel = Channel;
-_Channel_name = new WeakMap(), _Channel_queue = new WeakMap(), _Channel_presence = new WeakMap(), _Channel_publisher = new WeakMap(), _Channel_joinParams = new WeakMap(), _Channel_presenceSub = new WeakMap(), _Channel_receiver = new WeakMap(), _Channel_clientState = new WeakMap(), _Channel_joinState = new WeakMap(), _Channel_instances = new WeakSet(), _Channel_send = function _Channel_send(event, requestId, payload, receivers = pondsocket_common_1.ChannelReceiver.ALL_USERS) {
+_Channel_name = new WeakMap(), _Channel_queue = new WeakMap(), _Channel_presence = new WeakMap(), _Channel_publisher = new WeakMap(), _Channel_joinParams = new WeakMap(), _Channel_presenceSub = new WeakMap(), _Channel_receiver = new WeakMap(), _Channel_clientState = new WeakMap(), _Channel_joinState = new WeakMap(), _Channel_instances = new WeakSet(), _Channel_send = function _Channel_send(event, requestId, payload) {
     const message = {
         action: pondsocket_common_1.ClientActions.BROADCAST,
         channelName: __classPrivateFieldGet(this, _Channel_name, "f"),
-        addresses: receivers,
         requestId,
         event,
         payload,
@@ -286,7 +265,6 @@ _Channel_name = new WeakMap(), _Channel_queue = new WeakMap(), _Channel_presence
     __classPrivateFieldSet(this, _Channel_queue, [], "f");
 }, _Channel_buildJoinMessage = function _Channel_buildJoinMessage() {
     return {
-        addresses: pondsocket_common_1.ChannelReceiver.ALL_USERS,
         action: pondsocket_common_1.ClientActions.JOIN_CHANNEL,
         event: pondsocket_common_1.ClientActions.JOIN_CHANNEL,
         payload: __classPrivateFieldGet(this, _Channel_joinParams, "f"),

package/core/channel.test.js

@@ -13,8 +13,8 @@ const pondsocket_common_1 = require("@eleven-am/pondsocket-common");
 const channel_1 = require("./channel");
 const createChannel = (params = {}) => {
     const publisher = jest.fn();
-    const state = new pondsocket_common_1.SimpleBehaviorSubject(true);
-    const receiver = new pondsocket_common_1.SimpleSubject();
+    const state = new pondsocket_common_1.BehaviorSubject(true);
+    const receiver = new pondsocket_common_1.Subject();
     const channel = new channel_1.Channel(publisher, state, 'test', receiver, params);
     return {
         channel,
@@ -32,7 +32,6 @@ describe('Channel', () => {
         expect(publisher).toHaveBeenCalledWith(expect.objectContaining({
             action: pondsocket_common_1.ClientActions.JOIN_CHANNEL,
             channelName: 'test',
-            addresses: pondsocket_common_1.ChannelReceiver.ALL_USERS,
             event: pondsocket_common_1.ClientActions.JOIN_CHANNEL,
             payload: {},
         }));
@@ -46,7 +45,6 @@ describe('Channel', () => {
         expect(publisher2).toHaveBeenCalledWith(expect.objectContaining({
             action: pondsocket_common_1.ClientActions.JOIN_CHANNEL,
             channelName: 'test',
-            addresses: pondsocket_common_1.ChannelReceiver.ALL_USERS,
             event: pondsocket_common_1.ClientActions.JOIN_CHANNEL,
             payload: {},
         }));
@@ -86,7 +84,6 @@ describe('Channel', () => {
         expect(publisher).toHaveBeenCalledWith(expect.objectContaining({
             action: pondsocket_common_1.ClientActions.LEAVE_CHANNEL,
             channelName: 'test',
-            addresses: pondsocket_common_1.ChannelReceiver.ALL_USERS,
             event: pondsocket_common_1.ClientActions.LEAVE_CHANNEL,
             payload: {},
         }));
@@ -165,7 +162,7 @@ describe('Channel', () => {
         expect(channel.channelState).toBe(pondsocket_common_1.ChannelState.IDLE);
         expect(publisher).not.toHaveBeenCalled();
         // when the socket is connected but the channel is not joined, the message would not be queued
-        channel.broadcast('test', { test: false });
+        channel.sendMessage('test', { test: false });
         expect(publisher).not.toHaveBeenCalled();
         channel.join();
         publisher.mockClear();
@@ -179,10 +176,9 @@ describe('Channel', () => {
             },
         });
         // however once the channel is joined, the message should be sent
-        channel.broadcast('test', { test: true });
+        channel.sendMessage('test', { test: true });
         expect(publisher).toHaveBeenCalledWith(expect.objectContaining({
             action: pondsocket_common_1.ClientActions.BROADCAST,
-            addresses: pondsocket_common_1.ChannelReceiver.ALL_USERS,
             channelName: 'test',
             event: 'test',
             payload: {
@@ -193,13 +189,12 @@ describe('Channel', () => {
         publisher.mockClear();
         state.publish(false);
         expect(state.value).toBe(false);
-        channel.broadcast('test', { test: true });
+        channel.sendMessage('test', { test: true });
         expect(publisher).not.toHaveBeenCalled();
         // once the socket is reconnected, a join message should be sent and the queued messages should be sent
         publisher.mockClear();
         state.publish(true);
         expect(publisher).toHaveBeenCalledWith(expect.objectContaining({
-            addresses: pondsocket_common_1.ChannelReceiver.ALL_USERS,
             action: pondsocket_common_1.ClientActions.JOIN_CHANNEL,
             channelName: 'test',
             event: pondsocket_common_1.ClientActions.JOIN_CHANNEL,
@@ -218,7 +213,6 @@ describe('Channel', () => {
         });
         expect(publisher).toHaveBeenCalledWith(expect.objectContaining({
             action: pondsocket_common_1.ClientActions.BROADCAST,
-            addresses: pondsocket_common_1.ChannelReceiver.ALL_USERS,
             channelName: 'test',
             event: 'test',
             payload: {
@@ -233,11 +227,10 @@ describe('Channel', () => {
             action: pondsocket_common_1.ClientActions.LEAVE_CHANNEL,
             channelName: 'test',
             event: pondsocket_common_1.ClientActions.LEAVE_CHANNEL,
-            addresses: pondsocket_common_1.ChannelReceiver.ALL_USERS,
             payload: {},
         }));
         expect(channel.channelState).toBe(pondsocket_common_1.ChannelState.CLOSED);
-        channel.broadcast('test', { test: true });
+        channel.sendMessage('test', { test: true });
         expect(publisher).toHaveBeenCalledTimes(1);
     });
     // The presence system tests
@@ -670,7 +663,7 @@ describe('Channel', () => {
         });
         channel.sendMessage('test', {
             test: 'test',
-        }, ['test1']);
+        });
         expect(publisher).toHaveBeenCalledWith(expect.objectContaining({
             action: pondsocket_common_1.ClientActions.BROADCAST,
             channelName: 'test',
@@ -678,10 +671,9 @@ describe('Channel', () => {
             payload: {
                 test: 'test',
             },
-            addresses: ['test1'],
         }));
         publisher.mockClear();
-        channel.broadcastFrom('test', {
+        channel.sendMessage('test', {
             test: 'test',
         });
         expect(publisher).toHaveBeenCalledWith(expect.objectContaining({
@@ -691,10 +683,9 @@ describe('Channel', () => {
             payload: {
                 test: 'test',
             },
-            addresses: pondsocket_common_1.ChannelReceiver.ALL_EXCEPT_SENDER,
         }));
         publisher.mockClear();
-        channel.broadcast('test', {
+        channel.sendMessage('test', {
             test: 'test',
         });
         expect(publisher).toHaveBeenCalledWith(expect.objectContaining({
@@ -704,12 +695,11 @@ describe('Channel', () => {
             payload: {
                 test: 'test',
             },
-            addresses: pondsocket_common_1.ChannelReceiver.ALL_USERS,
         }));
     });
     it('should be able to wait for a message', () => __awaiter(void 0, void 0, void 0, function* () {
-        const state = new pondsocket_common_1.SimpleBehaviorSubject(true);
-        const receiver = new pondsocket_common_1.SimpleSubject();
+        const state = new pondsocket_common_1.BehaviorSubject(true);
+        const receiver = new pondsocket_common_1.Subject();
         const params = {};
         const publisher = (data) => {
             if (data.event === 'WAITING') {

package/dist.d.ts

@@ -1,21 +1,20 @@
 import {
-    PondEventMap,
+    ChannelState,
+    EventWithResponse,
     JoinParams,
+    PayloadForResponse,
+    PondEventMap,
     PondPresence,
     PresencePayload,
-    PondMessage,
-    EventWithResponse,
-    PayloadForResponse,
     ResponseForEvent,
     Unsubscribe,
-    ChannelState,
 } from '@eleven-am/pondsocket-common';
 
 declare class Channel<EventMap extends PondEventMap = PondEventMap, Presence extends PondPresence = PondPresence> {
     /**
-     * @desc Gets the current connection state of the channel.
+     * @desc The current connection state of the channel.
      */
-    get channelState (): ChannelState;
+    channelState: ChannelState;
 
     /**
      * @desc Connects to the channel.
@@ -68,9 +67,8 @@ declare class Channel<EventMap extends PondEventMap = PondEventMap, Presence ext
      * @desc Sends a message to specific clients in the channel.
      * @param event - The event to send.
      * @param payload - The message to send.
-     * @param recipient - The clients to send the message to.
      */
-    sendMessage (event: string, payload: PondMessage, recipient: string[]): void;
+    sendMessage<Event extends keyof EventMap> (event: Event, payload: EventMap[Event]): void;
 
     /**
      * @desc Sends a message to the server and waits for a response.
@@ -79,20 +77,6 @@ declare class Channel<EventMap extends PondEventMap = PondEventMap, Presence ext
      */
     sendForResponse<Event extends EventWithResponse<EventMap>> (sentEvent: Event, payload: PayloadForResponse<EventMap, Event>): Promise<ResponseForEvent<EventMap, Event>>;
 
-    /**
-     * @desc Broadcasts a message to every other client in the channel except yourself.
-     * @param event - The event to send.
-     * @param payload - The message to send.
-     */
-    broadcastFrom<Event extends keyof EventMap> (event: Event, payload: EventMap[Event]): void;
-
-    /**
-     * @desc Broadcasts a message to the channel, including yourself.
-     * @param event - The event to send.
-     * @param payload - The message to send.
-     */
-    broadcast<Event extends keyof EventMap> (event: Event, payload: EventMap[Event]): void;
-
     /**
      * @desc Gets the current presence of the channel.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eleven-am/pondsocket-client",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "description": "PondSocket is a fast simple socket server",
   "keywords": [
     "socket",
@@ -29,19 +29,19 @@
     "pipeline": "npm run test && npm run build && npm run push"
   },
   "dependencies": {
-    "@eleven-am/pondsocket-common": "^0.0.10",
+    "@eleven-am/pondsocket-common": "^0.0.15",
     "websocket": "^1.0.34"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.11",
+    "@types/jest": "^29.5.12",
     "@types/websocket": "^1.0.10",
-    "@typescript-eslint/eslint-plugin": "^6.19.0",
+    "@typescript-eslint/eslint-plugin": "^7.0.2",
     "eslint-plugin-file-progress": "^1.3.0",
     "eslint-plugin-import": "^2.29.1",
     "jest": "^29.7.0",
-    "prettier": "^3.2.4",
+    "prettier": "^3.2.5",
     "supertest": "^6.3.4",
-    "ts-jest": "^29.1.1",
+    "ts-jest": "^29.1.2",
     "ts-loader": "^9.5.1",
     "ts-node": "^10.9.2",
     "typescript": "^5.3.3"