@eleven-am/pondsocket 0.1.68 → 0.1.70

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)
@@ -116,9 +131,13 @@ const message = "Hello, PondSocket!";
 channel.broadcast('message', { text: message });
 
 // Handle received messages
-channel.onMessage((event, message) => {
+// Certain methods in the channel instance returns a subscription function, which can be used to unsubscribe from the event
+const subscription = channel.onMessage((event, message) => {
     console.log(`Received message from server: ${message.text}`);
 });
+
+// Unsubscribe from the event
+subscription();
 ```
 
 The client will now connect to the server, and the server will receive the necessary headers automatically, including any authentication tokens or cookies, as required by the browser.
@@ -183,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
@@ -233,7 +252,7 @@ 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
@@ -257,15 +276,14 @@ profanityChannel.onEvent('presence/:presence', (req, res) => {
     });
 });
 
-profanityChannel.onLeave((req, res) => {
-    const { username } = req.user.assigns;
+profanityChannel.onLeave((event) => {
+    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
 
     // perform a cleanup operation here
 });
 
-
 // Start the server
 pond.listen(3000, () => {
     console.log('PondSocket server listening on port 3000');
@@ -274,8 +292,6 @@ pond.listen(3000, () => {
 
 ## API Documentation
 
-Apologies for the confusion. Let me remove "Class" from the title of each section:
-
 ### PondSocket
 
 The `PondSocket` class is the core class that represents the socket server.
@@ -414,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`.
@@ -428,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`.
 
@@ -456,9 +476,9 @@ The `PondClient` class represents a client that connects to the PondSocket serve
 
 - `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

@@ -157,7 +157,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) {
@@ -262,6 +261,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,7 +276,10 @@ 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) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eleven-am/pondsocket",
-  "version": "0.1.68",
+  "version": "0.1.70",
   "description": "PondSocket is a fast simple socket server",
   "keywords": [
     "socket",

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;
+