@eleven-am/pondsocket 0.1.69 → 0.1.71

package/README.md

@@ -27,6 +27,21 @@ const pond = new PondSocket();
 const endpoint = pond.createEndpoint('/api/socket', (req, res) => {
     // Handle socket connection and authentication
 });
+
+// Start the server
+pond.listen(3000);
+
+// Or alternatively, working with express
+import pondSocket from "@eleven-am/pondsocket/express";
+import express from "express";
+
+const app = pondSocket(express());
+
+const endpoint = app.upgrade('/api/socket', (req, res) => {
+    // Handle socket connection and authentication
+});
+
+app.listen(3000);
 ```
 
 Within each endpoint, sockets interact through channels. Channels provide an organized way to group users and manage efficient communication among them. When users join a channel, they can participate in real-time events and exchange information with other users in the same channel.
@@ -86,7 +101,7 @@ import PondClient from "@eleven-am/pondsocket/client";
 // Your server URL
 const serverUrl = 'ws://your-server-url/api/socket';
 
-// Your authenticated user's username (replace with actual username)
+// Your authenticated user's token (replace with actual token)
 const authToken = 'your-auth-token';
 
 // Your username (replace with actual username)
@@ -187,7 +202,7 @@ const profanityChannel = endpoint.createChannel('/channel/:id', async (req, res)
     const { username } = req.joinParams;
     const { id } = req.event.params;
 
-    // maybe retrieve the channel from a database
+    // maybe retrieve the previous messages from the database
     const messages = await getMessagesFromDatabase(id);
 
     // Check if the user has the required role to join the channel
@@ -237,14 +252,14 @@ profanityChannel.onEvent('message', (req, res) => {
             // 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' })
                 // or you can send a message to the user that profanity is not allowed
-                .send('profanity-warning', { message: `You have used profanity ${profanityCount} times. You will be kicked from the channel if you use profanity more than 3 times.` });
+                .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
         res.accept();
     }
 
-    // for more complete access to the channel, you can use the client object
+    // for more complete access to the channel, you can use the channel instance
     // const channel = req.channel;
 });
 
@@ -269,7 +284,6 @@ profanityChannel.onLeave((event) => {
     // perform a cleanup operation here
 });
 
-
 // Start the server
 pond.listen(3000, () => {
     console.log('PondSocket server listening on port 3000');
@@ -336,7 +350,7 @@ The `JoinRequest` class represents the request object when a client joins a chan
 
 - `user: UserData`: The user data associated with the client.
 
-- `client: Client`: The Client instance associated with the request.
+- `channel: Channel`: The Channel instance associated with the request.
 
 ### JoinResponse
 
@@ -386,7 +400,7 @@ The `EventRequest` class represents the request object when an event is received
 
 - `user: UserData`: The user data associated with the client.
 
-- `client: Client`: The Client instance associated with the request.
+- `channel: Channel`: The Channel instance associated with the request.
 
 ### EventResponse
 
@@ -416,12 +430,14 @@ The `EventResponse` class represents the response object for handling events fro
 
 - `closeChannel(reason: string): void`: Closes the channel from the server-side for all clients.
 
-### Client
+### Channel
 
-The `Client` class represents a single Channel created by the PondSocket server. Note that a PondChannel can have multiple clients.
+The `Channel` class represents a single Channel created by the PondSocket server. Note that a PondChannel can have multiple channels associated with it.
 
 **Methods:**
 
+- `name: string`: The name of the channel.
+
 - `getAssigns: UserAssigns`: Gets the current assign data for the client.
 
 - `getUserData(userId: string): UserData`: Gets the assign data for a specific user identified by the provided `userId`.
@@ -430,7 +446,9 @@ The `Client` class represents a single Channel created by the PondSocket server.
 
 - `sendToUser(userId: string, event: string, payload: PondMessage): void`: Sends a message to a specific client in the channel identified by the provided `userId`, with the specified event and payload.
 
-- `banUser(userId: string, reason?: string): void`: Bans a user from the channel identified by the provided `userId`. Optionally, you can provide a `reason` for the ban.
+- `sendToUsers(userIdS: string[], event: string, payload: PondMessage): void`: Sends a message to a specific set of clients identified by the provided `userIdS`, with the specified event and payload.
+
+- `evictUser(userId: string, reason?: string): void`: Bans a user from the channel identified by the provided `userId`. Optionally, you can provide a `reason` for the ban.
 
 - `trackPresence(userId: string, presence: PondPresence): void`: Tracks a user's presence in the channel identified by the provided `userId`.
 
@@ -454,13 +472,13 @@ The `PondClient` class represents a client that connects to the PondSocket serve
 
 - `disconnect(): void`: Disconnects the socket.
 
-- `createChannel(name: string, params?: JoinParams): Channel`: Creates a channel with the given name and optional join parameters.
+- `createChannel(name: string, params?: JoinParams): ClientChannel`: Creates a channel with the given name and optional join parameters.
 
 - `onConnectionChange(callback: (state: boolean) => void): Unsubscribe`: Subscribes to the connection state changes and calls the provided callback when the state changes.
 
-### Channel
+### ClientChannel
 
-The `Channel` class represents a channel in the PondClient.
+The `ClientChannel` class represents a channel in the PondClient.
 
 **Methods:**
 

package/channel/channel.js

@@ -91,7 +91,8 @@ class ChannelEngine {
      */
     kickUser(userId, reason) {
         this.sendMessage(enums_1.SystemSender.CHANNEL, [userId], enums_1.ServerActions.SYSTEM, 'kicked_out', {
-            message: reason !== null && reason !== void 0 ? reason : 'You have been kicked out of the channel',
+            message: reason,
+            code: 403,
         });
         this.removeUser(userId);
         this.sendMessage(enums_1.SystemSender.CHANNEL, enums_1.ChannelReceiver.ALL_USERS, enums_1.ServerActions.SYSTEM, 'kicked', {
@@ -157,7 +158,6 @@ class ChannelEngine {
      * @param action - The action of the message
      * @param event - The event name
      * @param payload - The payload of the message
-     * @private
      */
     sendMessage(sender, recipient, action, event, payload) {
         if (!__classPrivateFieldGet(this, _ChannelEngine_users, "f").has(sender) && sender !== enums_1.SystemSender.CHANNEL) {
@@ -198,24 +198,14 @@ class ChannelEngine {
             });
         });
     }
-    /**
-     * @desc Begins tracking a user's presence
-     * @param userId - The id of the user to track
-     * @param presence - The initial presence of the user
-     */
-    trackPresence(userId, presence) {
-        var _a;
-        if (!__classPrivateFieldGet(this, _ChannelEngine_users, "f").has(userId)) {
-            throw new pondError_1.ChannelError(`ChannelEngine: User with id ${userId} does not exist in channel ${this.name}`, 404, this.name);
-        }
-        __classPrivateFieldSet(this, _ChannelEngine_presenceEngine, (_a = __classPrivateFieldGet(this, _ChannelEngine_presenceEngine, "f")) !== null && _a !== void 0 ? _a : new presence_1.PresenceEngine(this), "f");
-        __classPrivateFieldGet(this, _ChannelEngine_presenceEngine, "f").trackPresence(userId, presence);
-    }
     /**
      * @desc Gets the presence engine for the channel
      */
     get presenceEngine() {
-        return __classPrivateFieldGet(this, _ChannelEngine_presenceEngine, "f");
+        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
@@ -262,6 +252,9 @@ class Channel {
         _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();
     }
@@ -274,19 +267,20 @@ class Channel {
     sendToUser(userId, event, payload) {
         __classPrivateFieldGet(this, _Channel_engine, "f").sendMessage(enums_1.SystemSender.CHANNEL, [userId], enums_1.ServerActions.BROADCAST, event, payload);
     }
-    banUser(userId, reason) {
+    sendToUsers(userIds, event, payload) {
+        __classPrivateFieldGet(this, _Channel_engine, "f").sendMessage(enums_1.SystemSender.CHANNEL, userIds, enums_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").trackPresence(userId, presence);
+        __classPrivateFieldGet(this, _Channel_engine, "f").presenceEngine.trackPresence(userId, presence);
     }
     removePresence(userId) {
-        var _a;
-        (_a = __classPrivateFieldGet(this, _Channel_engine, "f").presenceEngine) === null || _a === void 0 ? void 0 : _a.removePresence(userId);
+        __classPrivateFieldGet(this, _Channel_engine, "f").presenceEngine.removePresence(userId);
     }
     updatePresence(userId, presence) {
-        var _a;
-        (_a = __classPrivateFieldGet(this, _Channel_engine, "f").presenceEngine) === null || _a === void 0 ? void 0 : _a.updatePresence(userId, presence);
+        __classPrivateFieldGet(this, _Channel_engine, "f").presenceEngine.updatePresence(userId, presence);
     }
 }
 exports.Channel = Channel;

package/channel/eventResponse.js

@@ -94,8 +94,8 @@ class EventResponse extends abstractResponse_1.PondResponse {
      * @param presence - the initial presence data
      * @param userId - the id of the user to track
      */
-    trackPresence(presence, userId) {
-        __classPrivateFieldGet(this, _EventResponse_engine, "f").trackPresence(userId || __classPrivateFieldGet(this, _EventResponse_event, "f").sender, presence);
+    trackPresence(presence, userId = __classPrivateFieldGet(this, _EventResponse_event, "f").sender) {
+        __classPrivateFieldGet(this, _EventResponse_engine, "f").presenceEngine.trackPresence(userId, presence);
         return this;
     }
     /**
@@ -103,19 +103,16 @@ class EventResponse extends abstractResponse_1.PondResponse {
      * @param presence - the updated presence data
      * @param userId - the id of the user to update
      */
-    updatePresence(presence, userId) {
-        var _a;
-        (_a = __classPrivateFieldGet(this, _EventResponse_engine, "f").presenceEngine) === null || _a === void 0 ? void 0 : _a.updatePresence(userId || __classPrivateFieldGet(this, _EventResponse_event, "f").sender, presence);
+    updatePresence(presence, userId = __classPrivateFieldGet(this, _EventResponse_event, "f").sender) {
+        __classPrivateFieldGet(this, _EventResponse_engine, "f").presenceEngine.updatePresence(userId, presence);
         return this;
     }
     /**
      * @desc Removes a user's presence from the channel
      * @param userId - the id of the user to remove
      */
-    unTrackPresence(userId) {
-        var _a;
-        userId = userId || __classPrivateFieldGet(this, _EventResponse_event, "f").sender;
-        (_a = __classPrivateFieldGet(this, _EventResponse_engine, "f").presenceEngine) === null || _a === void 0 ? void 0 : _a.removePresence(userId);
+    unTrackPresence(userId = __classPrivateFieldGet(this, _EventResponse_event, "f").sender) {
+        __classPrivateFieldGet(this, _EventResponse_engine, "f").presenceEngine.removePresence(userId);
         return this;
     }
     /**
@@ -123,8 +120,8 @@ class EventResponse extends abstractResponse_1.PondResponse {
      * @param reason - the reason for the eviction
      * @param userId - the id of the user to evict,
      */
-    evictUser(reason, userId) {
-        __classPrivateFieldGet(this, _EventResponse_engine, "f").kickUser(userId || __classPrivateFieldGet(this, _EventResponse_event, "f").sender, reason);
+    evictUser(reason, userId = __classPrivateFieldGet(this, _EventResponse_event, "f").sender) {
+        __classPrivateFieldGet(this, _EventResponse_engine, "f").kickUser(userId, reason);
     }
     /**
      * @desc Closes the channel from the server side for all clients

package/lobby/joinResponse.js

@@ -110,7 +110,7 @@ class JoinResponse extends abstractResponse_1.PondResponse {
      * @param presence - the presence data to track
      */
     trackPresence(presence) {
-        __classPrivateFieldGet(this, _JoinResponse_engine, "f").trackPresence(__classPrivateFieldGet(this, _JoinResponse_user, "f").clientId, presence);
+        __classPrivateFieldGet(this, _JoinResponse_engine, "f").presenceEngine.trackPresence(__classPrivateFieldGet(this, _JoinResponse_user, "f").clientId, presence);
         return this;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eleven-am/pondsocket",
-  "version": "0.1.69",
+  "version": "0.1.71",
   "description": "PondSocket is a fast simple socket server",
   "keywords": [
     "socket",
@@ -30,22 +30,22 @@
   },
   "dependencies": {
     "websocket": "^1.0.34",
-    "ws": "^8.13.0"
+    "ws": "^8.15.0"
   },
   "devDependencies": {
-    "@types/express": "^4.17.17",
-    "@types/jest": "^29.5.3",
-    "@types/node": "^20.4.4",
-    "@types/websocket": "^1.0.5",
-    "@types/ws": "^8.5.5",
-    "@typescript-eslint/eslint-plugin": "^6.1.0",
-    "eslint": "^8.45.0",
+    "@types/express": "^4.17.21",
+    "@types/jest": "^29.5.11",
+    "@types/node": "^20.10.4",
+    "@types/websocket": "^1.0.10",
+    "@types/ws": "^8.5.10",
+    "@typescript-eslint/eslint-plugin": "^6.13.2",
+    "eslint": "^8.55.0",
     "eslint-plugin-file-progress": "^1.3.0",
-    "eslint-plugin-import": "^2.27.5",
-    "jest": "^29.6.1",
+    "eslint-plugin-import": "^2.29.0",
+    "jest": "^29.7.0",
     "superwstest": "^2.0.3",
     "ts-jest": "^29.1.1",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.1.6"
+    "ts-node": "^10.9.2",
+    "typescript": "^5.3.3"
   }
 }

package/types.d.ts

@@ -320,6 +320,11 @@ declare class Endpoint {
 }
 
 export declare class Channel {
+    /**
+     * The name of the channel.
+     */
+    name: string;
+
     /**
      * @desc Gets the current assign data for the channel.
      */
@@ -346,12 +351,20 @@ export declare class Channel {
      */
     sendToUser (userId: string, event: string, payload: PondMessage): void;
 
+    /**
+     * @desc Sends a message to specific clients in the channel.
+     * @param userIds - The ids of the users to send the message to.
+     * @param event - The event to send.
+     * @param payload - The message to send.
+     */
+    sendToUsers (userIds: string[], event: string, payload: PondMessage): void;
+
     /**
      * @desc Bans a user from the channel.
      * @param userId - The id of the user to ban.
      * @param reason - The reason for the ban.
      */
-    banUser (userId: string, reason?: string): void;
+    evictUser (userId: string, reason?: string): void;
 
     /**
      * @desc tracks a user's presence in the channel
@@ -581,3 +594,4 @@ declare class PondClient {
 }
 
 declare const pondSocket: (app: Express) => PondSocketExpressApp;
+