@eleven-am/pondsocket 0.1.66 → 0.1.68

package/README.md

@@ -129,7 +129,6 @@ To create a PondSocket server that accepts authenticated connections and checks
 
 ```javascript
 import PondSocket from "@eleven-am/pondsocket";
-import Filter from "bad-words";
 
 // Helper functions for token validation
 function isValidToken(token) {
@@ -144,8 +143,17 @@ function getRoleFromToken(token) {
     return 'user';
 }
 
-// Create a PondChannel with profanity check
-const profanityFilter = new Filter();
+function isTextProfane(text) {
+    // Implement your profanity check logic here
+    // Return true if the text is profane, false otherwise
+    return false;
+}
+
+function getMessagesFromDatabase(channelId) {
+    // Implement your logic to retrieve messages from the database
+    // Return an array of messages
+    return [];
+}
 
 const pond = new PondSocket();
 
@@ -157,7 +165,7 @@ const endpoint = pond.createEndpoint('/api/socket', (req, res) => {
     // Perform token validation here
     if (isValidToken(token)) {
         // Extract the authenticated user's username
-        const role = getUsernameFromToken(token);
+        const role = getRoleFromToken(token);
 
         // Handle socket connection and authentication for valid users
         res.accept({ role }); // Assign the user's role to the socket
@@ -167,23 +175,39 @@ const endpoint = pond.createEndpoint('/api/socket', (req, res) => {
     }
 });
 
-const profanityChannel = endpoint.createChannel('/channel/:id', (req, res) => {
+// Create a channel, providing a callback that is called when a user attempts to join the channel
+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;
+
+    // maybe retrieve the channel from a database
+    const messages = await getMessagesFromDatabase(id);
+
     // Check if the user has the required role to join the channel
     if (role === 'admin') {
         // Accept the join request
         res.accept({ username, profanityCount: 0 })
-        // optionally you can track the presence of the user in the channel
+            // optionally you can track the presence of the user in the channel
             .trackPresence({
                 username,
                 role,
                 status: 'online',
                 onlineSince: Date.now(),
-            });
+            })
+            // and send the user the channel history
+            .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 })
+        //   .trackPresence({
+        //       username,
+        //       role,
+        //       status: 'online',
+        //       onlineSince: Date.now(),
+        //   });
     } else {
         // Reject the join request
         res.reject('You do not have the required role to join this channel', 403);
@@ -195,14 +219,14 @@ profanityChannel.onEvent('message', (req, res) => {
     const { text } = req.event.payload;
 
     // Check for profanity
-    if (profanityFilter.isProfane(text)) {
-        const profanityCount = req.user.assigns.profanityCount + 1
+    if (isTextProfane(text)) {
         // Reject the message if it contains profanity
         res.reject('Profanity is not allowed', 400, {
-            profanityCount,
+            profanityCount:  req.user.assigns.profanityCount + 1
         });
-        
-        if (profanityCount >= 3) {
+
+        // note that profanityCount is updated so req.user.assigns.profanityCount will be updated
+        if (req.user.assigns.profanityCount >= 3) {
             // Kick the user from the channel if they have used profanity more than 3 times
             res.evictUser('You have been kicked from the channel for using profanity');
         } else {
@@ -215,15 +239,15 @@ profanityChannel.onEvent('message', (req, res) => {
         // 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
-    // const channel = req.client;
+    // const channel = req.channel;
 });
 
 profanityChannel.onEvent('presence/:presence', (req, res) => {
     const { presence } = req.event.params;
     const { username } = req.user.assigns;
-    
+
     // Handle presence events
     res.updatePresence({
         username,
@@ -235,9 +259,9 @@ profanityChannel.onEvent('presence/:presence', (req, res) => {
 
 profanityChannel.onLeave((req, res) => {
     const { username } = req.user.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
 });
 

package/channel/channel.js

@@ -21,9 +21,9 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
-var _ChannelEngine_instances, _ChannelEngine_receiver, _ChannelEngine_presenceEngine, _ChannelEngine_users, _ChannelEngine_parentEngine, _ChannelEngine_subscribe, _ChannelEngine_getUsersFromRecipients, _Client_engine;
+var _ChannelEngine_instances, _ChannelEngine_receiver, _ChannelEngine_presenceEngine, _ChannelEngine_users, _ChannelEngine_parentEngine, _ChannelEngine_subscribe, _ChannelEngine_getUsersFromRecipients, _Channel_engine;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Client = exports.ChannelEngine = void 0;
+exports.Channel = exports.ChannelEngine = void 0;
 const eventRequest_1 = require("./eventRequest");
 const eventResponse_1 = require("./eventResponse");
 const enums_1 = require("../enums");
@@ -257,37 +257,37 @@ _ChannelEngine_receiver = new WeakMap(), _ChannelEngine_presenceEngine = new Wea
     }
     return users;
 };
-class Client {
+class Channel {
     constructor(engine) {
-        _Client_engine.set(this, void 0);
-        __classPrivateFieldSet(this, _Client_engine, engine, "f");
+        _Channel_engine.set(this, void 0);
+        __classPrivateFieldSet(this, _Channel_engine, engine, "f");
     }
     getAssigns() {
-        return __classPrivateFieldGet(this, _Client_engine, "f").getAssigns();
+        return __classPrivateFieldGet(this, _Channel_engine, "f").getAssigns();
     }
     getUserData(userId) {
-        return __classPrivateFieldGet(this, _Client_engine, "f").getUserData(userId);
+        return __classPrivateFieldGet(this, _Channel_engine, "f").getUserData(userId);
     }
     broadcastMessage(event, payload) {
-        __classPrivateFieldGet(this, _Client_engine, "f").sendMessage(enums_1.SystemSender.CHANNEL, enums_1.ChannelReceiver.ALL_USERS, enums_1.ServerActions.BROADCAST, event, payload);
+        __classPrivateFieldGet(this, _Channel_engine, "f").sendMessage(enums_1.SystemSender.CHANNEL, enums_1.ChannelReceiver.ALL_USERS, enums_1.ServerActions.BROADCAST, event, payload);
     }
     sendToUser(userId, event, payload) {
-        __classPrivateFieldGet(this, _Client_engine, "f").sendMessage(enums_1.SystemSender.CHANNEL, [userId], enums_1.ServerActions.BROADCAST, event, payload);
+        __classPrivateFieldGet(this, _Channel_engine, "f").sendMessage(enums_1.SystemSender.CHANNEL, [userId], enums_1.ServerActions.BROADCAST, event, payload);
     }
     banUser(userId, reason) {
-        __classPrivateFieldGet(this, _Client_engine, "f").kickUser(userId, reason !== null && reason !== void 0 ? reason : 'You have been banned from the channel');
+        __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, _Client_engine, "f").trackPresence(userId, presence);
+        __classPrivateFieldGet(this, _Channel_engine, "f").trackPresence(userId, presence);
     }
     removePresence(userId) {
         var _a;
-        (_a = __classPrivateFieldGet(this, _Client_engine, "f").presenceEngine) === null || _a === void 0 ? void 0 : _a.removePresence(userId);
+        (_a = __classPrivateFieldGet(this, _Channel_engine, "f").presenceEngine) === null || _a === void 0 ? void 0 : _a.removePresence(userId);
     }
     updatePresence(userId, presence) {
         var _a;
-        (_a = __classPrivateFieldGet(this, _Client_engine, "f").presenceEngine) === null || _a === void 0 ? void 0 : _a.updatePresence(userId, presence);
+        (_a = __classPrivateFieldGet(this, _Channel_engine, "f").presenceEngine) === null || _a === void 0 ? void 0 : _a.updatePresence(userId, presence);
     }
 }
-exports.Client = Client;
-_Client_engine = new WeakMap();
+exports.Channel = Channel;
+_Channel_engine = new WeakMap();

package/channel/eventRequest.js

@@ -18,8 +18,8 @@ class EventRequest extends abstractRequest_1.AbstractRequest {
         }
         return assigns;
     }
-    get client() {
-        return new channel_1.Client(this._engine);
+    get channel() {
+        return new channel_1.Channel(this._engine);
     }
 }
 exports.EventRequest = EventRequest;

package/lobby/joinRequest.js

@@ -35,8 +35,8 @@ class JoinRequest extends abstractRequest_1.AbstractRequest {
             presence: {},
         };
     }
-    get client() {
-        return new channel_1.Client(this._engine);
+    get channel() {
+        return new channel_1.Channel(this._engine);
     }
 }
 exports.JoinRequest = JoinRequest;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eleven-am/pondsocket",
-  "version": "0.1.66",
+  "version": "0.1.68",
   "description": "PondSocket is a fast simple socket server",
   "keywords": [
     "socket",
@@ -22,8 +22,8 @@
   },
   "author": "Roy OSSAI",
   "license": "GPL-3.0",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "index.js",
+  "types": "index.d.ts",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Eleven-am/pondSocket.git"

package/types.d.ts

@@ -111,7 +111,7 @@ declare abstract class PondResponse {
 declare class EventRequest<Path extends string> extends AbstractRequest<Path> {
     user: UserData;
 
-    client: Client;
+    channel: Channel;
 }
 
 declare class EventResponse extends PondResponse {
@@ -193,7 +193,7 @@ declare class EventResponse extends PondResponse {
     closeChannel (reason: string): void;
 }
 
-export declare class Channel {
+export declare class ClientChannel {
     channelState: ChannelState;
 
     /**
@@ -319,7 +319,7 @@ declare class Endpoint {
     closeConnection (clientIds: string | string[]): void;
 }
 
-export declare class Client {
+export declare class Channel {
     /**
      * @desc Gets the current assign data for the channel.
      */
@@ -379,7 +379,7 @@ declare class JoinRequest<Path extends string> extends AbstractRequest<Path> {
 
     user: UserData;
 
-    client: Client;
+    channel: Channel;
 }
 
 declare class JoinResponse extends PondResponse {
@@ -571,7 +571,7 @@ declare class PondClient {
      * @param name - The name of the channel.
      * @param params - The params to send to the server.
      */
-    createChannel (name: string, params?: JoinParams): Channel;
+    createChannel (name: string, params?: JoinParams): ClientChannel;
 
     /**
      * @desc Subscribes to the connection state.
@@ -581,4 +581,3 @@ declare class PondClient {
 }
 
 declare const pondSocket: (app: Express) => PondSocketExpressApp;
-