@eleven-am/pondsocket 0.1.89 → 0.1.91

package/README.md

@@ -1,521 +1,139 @@
-# PondSocket
 
-PondSocket is a high-performance, minimalist, and bidirectional socket framework designed for Node.js. It provides a seamless way to handle real-time communication between server and client applications, making it an ideal choice for building WebSocket-based projects.
+# PondSocket
 
-## Installation
+PondSocket is a fast, minimalist and bidirectional socket framework for NodeJS. Pond allows you to think of each action during a sockets lifetime as a request instead of a huge callback that exists inside the connection event.
+## Documentation
 
-To integrate PondSocket into your Node.js project, simply install it via npm:
+This is a Node.js module available through the npm registry.
 
 ```bash
-npm install @eleven-am/pondsocket
+  npm install @eleven-am/pondsocket
 ```
 
-## Overview
-
-PondSocket simplifies the complexity of handling WebSocket connections by abstracting the communication process into individual requests rather than dealing with intricate callbacks within the connection event. It offers a lightweight yet powerful solution for managing bidirectional communication channels, enabling real-time updates and collaboration between server and client components.
-
-## Server-side Usage
-
-When setting up the server, PondSocket allows you to create multiple endpoints, each serving as a gateway for sockets to connect and communicate. Each endpoint operates independently, ensuring that sockets from one endpoint cannot interact with sockets from another. This isolation enhances security and simplifies resource management.
-
-```javascript
-import PondSocket from "@eleven-am/pondsocket";
-
-const pond = new PondSocket();
-
-// Create an endpoint for handling socket connections
-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);
+PondSocket usage depends on the environment in which it is being used.
+
+#### On the server
+
+When using PondSocket, an endpoint is created. The endpoint is the gateway by which sockets actually connect to the server.
+Multiple endpoints can be created but every endpoint is independent of the other, ie sockets on one endpoint cannot communicate with sockets on another endpoint.
+
+```js
+  import { PondSocket } from "@eleven-am/pondsocket";
+  
+  const pond = new PondSocket();
+ 
+  const endpoint = pond.createEndpoint('/api/socket', (req, res, _endpoint) => {
+       const token = req.query.token;   
+       if (!token)         
+            return res.reject('No token provided');      
+       res.accept({
+            assign: {
+                token
+            }
+       });  
+  })
 ```
 
-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.
-
-```javascript
-const channel = endpoint.createChannel('/channel/:id', (req, res) => {
-    // Handle the join request, which is sent when a user attempts to join the channel
-});
+While sockets connect through the endpoint, communication between sockets cannot occur on the endpoint level. Sockets have to join a channel to communicate
+between themselves.
+
+```js
+  const channel = endpoint.createChannel(/^channel(.*?)/, (req, res, channel) => {
+       const isAdmin = req.clientAssigns.admin;
+       if (!isAdmin)       
+            return res.reject('You are not an admin');
+
+       res.accept({
+           assign: {
+               admin: true, 
+               joinedDate: new Date()
+            }, 
+            presence: {
+                state: 'online'
+            }, 
+            channelData: {
+                locked: true,
+                numberOfUsers: channel.presence.length
+            }
+        });  
+   });   
 ```
 
-## Client-side Usage
-
-On the client-side, PondSocket provides the PondClient class to establish connections with the server. Clients can easily initiate connections, join channels, and participate in real-time interactions.
-
-```javascript
-import PondClient from "@eleven-am/pondsocket/client";
-
-const socket = new PondClient('/api/socket', {});
-socket.connect();
+A user goes through the createChannel function to join a channel.
+When a user joins a channel, some private information can be assigned to the user. This assign could be viewed as a cookie that is only available serverside.
+The presence is the current state of the user. When you reassign a new presence information to a user, all other users connected to the same channel are informed of the change.
+This could be used as *user is typing*, *user is away*, etc. The channelData is information that is stored on the channel and accessible from anywhere the channel is available.
+It can be anything from a boolean to an instance of a class. This data cannot be accessed from another channel as it is private to the channel.
+
+```js
+    channel.on('hello', (req, res, channel) => {      
+       const users = channel.presence;      
+       res.assign({
+           assign: {
+               pingDate: new Date(),
+               users: users.length
+           }
+        }); 
+
+        // res.reject('curse words are not allowed on a child friendly channel') 
+        // channel.closeFromChannel(req.client.clientId);
+    })
 ```
 
-Once connected, clients can create and join channels to engage in real-time communication with other users and the server.
+When a message is sent on a channel by a user, an event is triggered. The *on* function can be used to listen for these events. If the function is specified, it is called when the message is received.
+You can choose to decline the message being sent, or you can allow the message to be sent as usual. You can also do all the normal assigns to the channel, or user.
+In case there is no *on* function, the message will be sent without any action being taken.
 
-```javascript
-const channel = socket.createChannel('/channel/123');
-channel.join();
-```
-
-### Node Client
+#### On the browser
 
-PondSocket also offers a Node.js client, which can be imported using:
+```js
+    import { PondClient } from "@eleven-am/pondsocket/client";
 
-```javascript
-import PondClient from "@eleven-am/pondsocket/node";
+    export const socket = new PondClient('/api/socket', {});
+    socket.connect();
 ```
 
-This node client allows you to turn another server into a client, enabling easy communication between different server instances.
-
-## Key Features
-
-- **Simple and Efficient API**: PondSocket offers an easy-to-use API, making WebSocket communication straightforward and hassle-free.
-- **Organized Channels**: Channels provide a structured approach for grouping users and facilitating efficient communication.
-- **Assigns**: PondSocket allows the storage of private information for users and channels, enhancing data security.
-- **Presence**: The presence feature keeps track of users' current states and notifies other users about any changes.
-- **Broadcasting**: PondSocket enables broadcasting messages to all users or specific groups within a channel, facilitating real-time updates.
-- **Typed and Well-documented**: The codebase is thoroughly documented and typed, providing a seamless development experience with improved IDE suggestions.
-
-## Examples
+The browser compatible package can be imported from @eleven-am/pondsocket/client.
+AN url string is provided to the class along with other url params, like token.
 
-### Client-side Example with Authentication
+Multiple classes can be created, but it is advised to use a single class throughout the application.
+You can just create multiple channels and maintain the single socket connection.
 
-To connect to the PondSocket server and send messages while associating a username with the client connection, follow the steps below:
-
-```javascript
-import PondClient from "@eleven-am/pondsocket/client";
-
-// Your server URL
-const serverUrl = 'ws://your-server-url/api/socket';
-
-// Your authenticated user's token (replace with actual token)
-const authToken = 'your-auth-token';
-
-// Your username (replace with actual username)
-const username = 'user123';
-
-// Create a new PondClient instance
-const socket = new PondClient(serverUrl, { token: authToken });
-
-// Connect to the server
-socket.connect();
-
-// Add event listeners to handle various scenarios
-socket.onConnectionChange((connected) => {
-    if (connected) {
-        console.log('Connected to the server.');
-    } else {
-        console.log('Disconnected from the server.');
+```js
+    const channelTopic = 'channel:one';
+    const options = {
+        username: 'eleven-am'
     }
-});
-
-// Create a channel and join it
-const channel = socket.createChannel('/channel/123', { username });
-channel.join();
-
-// Send a message to the server
-const message = "Hello, PondSocket!";
-channel.broadcast('message', { text: message });
 
-// Handle received messages
-// 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();
+    export const channel = socket.createChannel(channelTopic, options);
+    channel.join();
 ```
 
-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.
-
-### Server-side Example with Authentication and check for profanity before broadcasting
-
-To create a PondSocket server that accepts authenticated connections and checks for profanity before broadcasting messages, follow the steps below:
-
-```javascript
-import PondSocket from "@eleven-am/pondsocket";
-
-// Helper functions for token validation
-function isValidToken(token) {
-    // Implement your token validation logic here
-    // Return true if the token is valid, false otherwise
-    return true;
-}
-
-function getRoleFromToken(token) {
-    // Implement the logic to extract the user's role from the token
-    // Return the user's role
-    return 'user';
-}
-
-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();
-
-// Create an endpoint for handling socket connections
-const endpoint = pond.createEndpoint('/api/socket', (req, res) => {
-    // Depending if the user already has cookies set, they can be accessed from the request headers or the request address
-    const token = req.query.token; // If the token is passed as a query parameter
-
-    // Perform token validation here
-    if (isValidToken(token)) {
-        // Extract the authenticated user's username
-        const role = getRoleFromToken(token);
-
-        // Handle socket connection and authentication for valid users
-        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);
-    }
-});
-
-// 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 previous messages from the 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
-            .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);
-    }
-});
-
-// Attach message event listener to the profanityChannel
-profanityChannel.onEvent('message', (req, res) => {
-    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
-        });
-
-        // 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 {
-            // 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
-                .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 channel instance
-    // const channel = req.channel;
-});
+When connected to the channel you can subscribe to the events from the channel.
 
-profanityChannel.onEvent('presence/:presence', (req, res) => {
-    const { presence } = req.event.params;
-    const { username } = req.user.assigns;
-
-    // Handle presence events
-    res.updatePresence({
-        username,
-        role,
-        onlineSince: Date.now(),
-        status: presence,
+```js
+    const subscriptionPresence = channel.onPresenceUpdate(presence => {
+        // handle the presence changes of the channel
     });
-});
-
-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
-});
+    const subscriptionMessage = channel.onMessage((event, data) => {
+        // handle the message being received 
+    });
 
-// Start the server
-pond.listen(3000, () => {
-    console.log('PondSocket server listening on port 3000');
-});
+    // When done with the channel remember to unsubscribe from these listeners
+    subscriptionPresence.unsubscribe();
+    subscriptionMessage.unsubscribe();
 ```
 
-## API Documentation
-
-### PondSocket
-
-The `PondSocket` class is the core class that represents the socket server.
-
-**Constructor:**
-
-- `constructor(server?: HTTPServer, socketServer?: WebSocketServer)`: Creates a new instance of the PondSocket with an optional HTTP server and WebSocket server.
-
-**Methods:**
-
-- `listen(...args: any[]): HTTPServer`: Specifies the port to listen on with the provided arguments.
-
-- `close(callback?: () => void): HTTPServer`: Closes the server, and an optional callback can be provided.
-
-- `createEndpoint<Path extends string>(path: PondPath<Path>, handler: (request: IncomingConnection<Path>, response: ConnectionResponse) => void | Promise<void>): Endpoint`: Accepts a new socket upgrade request on the provided endpoint using the handler function to authenticate the socket.
-
-### ConnectionResponse
-
-The `ConnectionResponse` class represents the response object for the incoming connection.
-
-**Methods:**
-
-- `accept(assigns?: PondAssigns): void`: Accepts the request and optionally assigns data to the client.
-
-- `reject(message?: string, errorCode?: number): void`: Rejects the request with the given error message and optional error code.
-
-- `send(event: string, payload: PondMessage, assigns?: PondAssigns): void`: Emits a direct message to the client with the specified event and payload.
-
-### Endpoint
-
-The `Endpoint` class represents an endpoint in the PondSocket server where channels can be created.
-
-**Methods:**
-
-- `createChannel<Path extends string>(path: PondPath<Path>, handler: (request: JoinRequest<Path>, response: JoinResponse) => void | Promise<void>): PondChannel`: Adds a new PondChannel to this path on this endpoint with the provided handler function to authenticate the client.
-
-- `broadcast(event: string, payload: PondMessage): void`: Broadcasts a message to all clients connected to this endpoint with the specified event and payload.
-
-- `closeConnection(clientIds: string | string[]): void`: Closes specific clients connected to this endpoint identified by the provided clientIds.
-
-### JoinRequest
-
-The `JoinRequest` class represents the request object when a client joins a channel.
-
-**Properties:**
-
-- `event: PondEvent<Path>`: The event associated with the request.
-
-- `channelName: string`: The name of the channel.
-
-- `assigns: UserAssigns`: The assigns data for the client.
-
-- `presence: UserPresences`: The presence data for the client.
-
-- `joinParams: JoinParams`: The join parameters for the client.
+There are many other features available on the channel object. Since the application is completely typed,
+suggestions should be provided by your IDE.
 
-- `user: UserData`: The user data associated with the client.
+```js
+    channel.broadcast('hello', {
+        name: 'eleven-am',
+        message: 'I am the man, man'
+    })
 
-- `channel: Channel`: The Channel instance associated with the request.
-
-### JoinResponse
-
-The `JoinResponse` class represents the response object for the join request.
-
-**Methods:**
-
-- `accept(assigns?: PondAssigns): JoinResponse`: Accepts the join request and optionally assigns data to the client.
-
-- `reject(message?: string, errorCode?: number): JoinResponse`: Rejects the join request with the given error message and optional error code.
-
-- `send(event: string, payload: PondMessage, assigns?: PondAssigns): JoinResponse`: Emits a direct message to the client with the specified event, payload, and optional assigns data.
-
-- `broadcast(event: string, payload: PondMessage): JoinResponse`: Emits a message to all clients in the channel with the specified event and payload.
-
-- `broadcastFromUser(event: string, payload: PondMessage): JoinResponse`: Emits a message to all clients in the channel except the sender with the specified event and payload.
-
-- `sendToUsers(event: string, payload: PondMessage, userIds: string[]): JoinResponse`: Emits a message to a specific set of clients identified by the provided userIds with the specified event and payload.
-
-- `trackPresence(presence: PondPresence): JoinResponse`: Tracks the presence of the client in the channel.
-
-### PondChannel
-
-The `PondChannel` class represents a Generic channel in the PondSocket server. It is used to create a channel whose path matches the provided PondPath.
-
-**Methods:**
-
-- `onEvent<Event extends string>(event: PondPath<Event>, handler: (request: EventRequest<Event>, response: EventResponse) => void | Promise<void>): void`: Handles an event request made by a user for the specified event with the provided handler function.
-
-- `broadcast(event: string, payload: PondMessage, channelName?: string): void`: Broadcasts a message to all users in the channel with the specified event and payload. Optionally, a specific channel name can be provided to broadcast the message only to users in that channel.
-
-- `onLeave(handler: (event: LeaveEvent) => void | Promise<void>): void`: Handles a leave event for the channel with the provided handler function when a user leaves the channel.
-
-### EventRequest
-
-The `EventRequest` class represents the request object when an event is received from a client.
-
-**Properties:**
-
-- `event: PondEvent<Path>`: The event associated with the request.
-
-- `channelName: string`: The name of the channel.
-
-- `assigns: UserAssigns`: The assigns data for the client.
-
-- `presence: UserPresences`: The presence data for the client.
-
-- `user: UserData`: The user data associated with the client.
-
-- `channel: Channel`: The Channel instance associated with the request.
-
-### EventResponse
-
-The `EventResponse` class represents the response object for handling events from clients.
-
-**Methods:**
-
-- `accept(assigns?: PondAssigns): EventResponse`: Accepts the request and optionally assigns data to the client.
-
-- `reject(message?: string, errorCode?: number, assigns?: PondAssigns): EventResponse`: Rejects the request with the given error message, optional error code, and optional assigns data.
-
-- `send(event: string, payload: PondMessage, assigns?: PondAssigns): void`: Emits a direct message to the client with the specified event, payload, and optional assigns data.
-
-- `broadcast(event: string, payload: PondMessage): EventResponse`: Sends a message to all clients in the channel with the specified event and payload.
-
-- `broadcastFromUser(event: string, payload: PondMessage): EventResponse`: Sends a message to all clients in the channel except the sender with the specified event and payload.
-
-- `sendToUsers(event: string, payload: PondMessage, userIds: string[]): EventResponse`: Sends a message to a specific set of clients identified by the provided userIds with the specified event and payload.
-
-- `trackPresence(presence: PondPresence, userId?: string): EventResponse`: Tracks a user's presence in the channel.
-
-- `updatePresence(presence: PondPresence, userId?: string): EventResponse`: Updates a user's presence in the channel.
-
-- `unTrackPresence(userId?: string): EventResponse`: Removes a user's presence from the channel.
-
-- `evictUser(reason: string, userId?: string): void`: Evicts a user from the channel.
-
-- `closeChannel(reason: string): void`: Closes the channel from the server-side for all clients.
-
-### Channel
-
-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`.
-
-- `broadcastMessage(event: string, payload: PondMessage): void`: Broadcasts a message to every client in the channel with the specified event and payload.
-
-- `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.
-
-- `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`.
-
-- `removePresence(userId: string): void`: Removes a user's presence from the channel identified by the provided `userId`.
-
-- `updatePresence(userId: string, presence: PondPresence): void`: Updates a user's presence in the channel identified by the provided `userId`.
-
-### PondClient
-
-The `PondClient` class represents a client that connects to the PondSocket server.
-
-**Constructor:**
-
-- `constructor(endpoint: string, params?: Record<string, any>)`: Creates a new instance of the PondClient with the provided endpoint URL and optional parameters.
-
-**Methods:**
-
-- `connect(backoff?: number): void`: Connects to the server with an optional backoff time.
-
-- `getState(): boolean`: Returns the current state of the socket.
-
-- `disconnect(): void`: Disconnects the socket.
-
-- `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.
-
-### ClientChannel
-
-The `ClientChannel` class represents a channel in the PondClient.
-
-**Methods:**
-
-- `join(): void`: Connects to the channel.
-
-- `leave(): void`: Disconnects from the channel.
-
-- `onMessage(callback: (event: string, message: PondMessage) => void): Unsubscribe`: Monitors the channel for messages and calls the provided callback when a message is received.
-
-- `onMessageEvent(event: string, callback: (message: PondMessage) => void): Unsubscribe`: Monitors the channel for messages with the specified event and calls the provided callback when a message is received.
-
-- `onChannelStateChange(callback: (connected: ChannelState) => void): Unsubscribe`: Monitors the channel state of the channel and calls the provided callback when the connection state changes.
-
-- `onJoin(callback: (presence: PondPresence) => void): Unsubscribe`: Detects when clients join the channel and calls the provided callback when a client joins the channel.
-
-- `onLeave(callback: (presence: PondPresence) => void): Unsubscribe`: Detects when clients leave the channel and calls the provided callback when a client leaves the channel.
-
-- `onPresenceChange(callback: (presence: PresencePayload) => void): Unsubscribe`: Detects when clients change their presence in the channel and calls the provided callback when a client changes their presence in the channel.
-
-- `sendMessage(event: string, payload: PondMessage, recipient: string[]): void`: Sends a message to specific clients in the channel with the specified event, payload, and recipient.
-
-- `broadcastFrom(event: string, payload: PondMessage): void`: Broadcasts a message to every other client in the channel except yourself with the specified event and payload.
-
-- `broadcast(event: string, payload: PondMessage): void`: Broadcasts a message to the channel, including yourself, with the specified event and payload.
-
-- `getPresence(): PondPresence[]`: Gets the current presence of the channel.
-
-- `onUsersChange(callback: (users: PondPresence[]) => void): Unsubscribe`: Monitors the presence of the channel and calls the provided callback when the presence changes.
-
-- `isConnected(): boolean`: Gets the current connection state of the channel.
-
-- `onConnectionChange(callback: (connected: boolean) => void): Unsubscribe`: Monitors the connection state of the channel and calls the provided callback when the connection state changes.
-
-## License
-
-PondSocket is released under the GPL-3.0 License. Please refer to the `LICENSE` file for detailed licensing information.
-
-## Conclusion
-
-PondSocket is a powerful and versatile solution for building real-time applications that require efficient bidirectional communication between server and client components. Its minimalist design and comprehensive feature set make it an excellent choice for WebSocket-based projects, providing developers with a straightforward and reliable tool for building real-time communication systems. With the Node.js client, it also allows for easy communication between multiple server instances, expanding its capabilities even further.
+    // channel.broadcastFrom broadcasts a message to everyone but the client that emitted the message
+    // channel.sendMessage sends a message to clients specified in the function
+```

package/lobby/lobby.js

@@ -188,6 +188,17 @@ class PondChannel {
     onLeave(callback) {
         __classPrivateFieldGet(this, _PondChannel_lobby, "f").onLeave(callback);
     }
+    /**
+     * @desc Gets a channel by name
+     * @param channelName - The name of the channel to get
+     */
+    getChannel(channelName) {
+        const channel = __classPrivateFieldGet(this, _PondChannel_lobby, "f").getChannel(channelName);
+        if (channel) {
+            return new channel_1.Channel(channel);
+        }
+        return null;
+    }
 }
 exports.PondChannel = PondChannel;
 _PondChannel_lobby = new WeakMap();

package/nest.d.ts

@@ -2,7 +2,7 @@ import  {
     OnJoinRequest,
     ChannelInstance,
     DChannel as Channel,
-    Channels, Endpoints,
+    Channels,
     OnConnectionRequest,
     DEndpoint as Endpoint,
     OnEvent, PondSocketModule,
@@ -19,9 +19,9 @@ import  {
 export {
     OnJoinRequest,
     ChannelInstance,
+    OnConnectionRequest,
     Endpoint, PondSocketModule,
-    OnConnectionRequest, OnEvent,
-    Channel, Channels, Endpoints,
+    OnEvent, Channel, Channels,
     GetEventQuery, GetJoinParams,
     GetEventParams, GetJoinResponse,
     GetEventRequest, GetJoinRequest,

package/nest.js

@@ -20,9 +20,10 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PondSocketModule = exports.Endpoints = exports.Endpoint = exports.Channel = exports.ChannelInstance = exports.OnConnectionRequest = exports.OnEvent = exports.OnJoinRequest = exports.GetConnectionQuery = exports.GetConnectionHeaders = exports.GetConnectionParams = exports.GetConnectionRequestId = exports.GetConnectionResponse = exports.GetConnectionRequest = exports.GetEventRequest = exports.GetEventResponse = exports.GetEventQuery = exports.GetEventParams = exports.GetEventPayload = exports.GetUserPresences = exports.GetInternalChannel = exports.GetUserData = exports.GetJoinParams = exports.GetJoinResponse = exports.GetJoinRequest = void 0;
+exports.PondSocketModule = exports.Endpoint = exports.Channel = exports.EndpointInstance = exports.ChannelInstance = exports.OnConnectionRequest = exports.OnEvent = exports.OnLeaveEvent = exports.OnJoinRequest = exports.GetConnectionQuery = exports.GetConnectionHeaders = exports.GetConnectionParams = exports.GetConnectionRequestId = exports.GetConnectionResponse = exports.GetConnectionRequest = exports.GetEventRequest = exports.GetEventResponse = exports.GetEventQuery = exports.GetEventParams = exports.GetEventPayload = exports.GetUserPresences = exports.GetInternalChannel = exports.GetUserData = exports.GetJoinParams = exports.GetJoinResponse = exports.GetJoinRequest = void 0;
 const http_1 = require("http");
 const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
 require("reflect-metadata");
 const pondSocket_1 = require("./server/pondSocket");
 const joinRequestKey = Symbol('joinRequestKey');
@@ -46,10 +47,10 @@ const onJoinHandlerKey = Symbol('onJoinHandlerKey');
 const onEventHandlerKey = Symbol('onEventHandlerKey');
 const onConnectionHandlerKey = Symbol('onConnectionHandlerKey');
 const channelInstanceKey = Symbol('channelInstanceKey');
+const endpointInstanceKey = Symbol('endpointInstanceKey');
 const channelClassKey = Symbol('channel');
 const endpointClassKey = Symbol('endpoint');
 const channelsClassKey = Symbol('channels');
-const endpointsClassKey = Symbol('endpoints');
 function isNotEmpty(value) {
     return value !== null &&
         value !== undefined &&
@@ -57,6 +58,7 @@ function isNotEmpty(value) {
         Object.keys(value).length !== 0;
 }
 function createClassDecorator(key, value) {
+    // eslint-disable-next-line new-cap
     return (0, common_1.applyDecorators)((0, common_1.Injectable)(), (0, common_1.SetMetadata)(key, value));
 }
 function getClassMetadata(key, target) {
@@ -107,8 +109,30 @@ function manageHandlers(key, target) {
         },
     };
 }
-function manageChannelInstance(target) {
-    return manageClassData(channelInstanceKey, target);
+function managePropertyData(key, target) {
+    function build(propertyKey, callback) {
+        Object.defineProperty(target, propertyKey, {
+            get() {
+                const value = Reflect.getMetadata(key, this);
+                if (callback) {
+                    return callback(value);
+                }
+                return value;
+            },
+            set() {
+                throw new Error(`${propertyKey} is readonly`);
+            },
+            enumerable: true,
+            configurable: true,
+        });
+    }
+    function set(value) {
+        Reflect.defineMetadata(key, value, target);
+    }
+    return {
+        build,
+        set,
+    };
 }
 function manageJoinHandlers(target) {
     return manageHandlers(onJoinHandlerKey, target);
@@ -119,6 +143,15 @@ function manageEventHandlers(target) {
 function manageConnectionHandlers(target) {
     return manageHandlers(onConnectionHandlerKey, target);
 }
+function manageOnLeaveHandlers(target) {
+    return manageHandlers(onConnectionHandlerKey, target);
+}
+function manageChannelInstance(target) {
+    return managePropertyData(channelInstanceKey, target);
+}
+function manageEndpointInstance(target) {
+    return managePropertyData(endpointInstanceKey, target);
+}
 function GetJoinRequest() {
     return createParamDecorator(joinRequestKey, 'JoinRequest decorator already applied');
 }
@@ -187,6 +220,57 @@ function GetConnectionQuery() {
     return createParamDecorator(connectionQueryKey, 'ConnectionQuery decorator already applied');
 }
 exports.GetConnectionQuery = GetConnectionQuery;
+function manageRejectedKeys(rejectedKeys, target, propertyKey) {
+    function symbolToString(symbol) {
+        switch (symbol) {
+            case joinRequestKey:
+                return 'GetJoinRequest';
+            case joinResponseKey:
+                return 'GetJoinResponse';
+            case joinParamsKey:
+                return 'GetJoinParams';
+            case userDataKey:
+                return 'GetUserData';
+            case internalChannelKey:
+                return 'GetInternalChannel';
+            case userPresenceKey:
+                return 'GetUserPresences';
+            case eventPayloadKey:
+                return 'GetEventPayload';
+            case eventParamsKey:
+                return 'GetEventParams';
+            case eventQueryKey:
+                return 'GetEventQuery';
+            case eventResponseKey:
+                return 'GetEventResponse';
+            case eventRequestKey:
+                return 'GetEventRequest';
+            case connectionRequestKey:
+                return 'GetConnectionRequest';
+            case connectionResponseKey:
+                return 'GetConnectionResponse';
+            case connectionRequestIdKey:
+                return 'GetConnectionRequestId';
+            case connectionParamsKey:
+                return 'GetConnectionParams';
+            case connectionQueryKey:
+                return 'GetConnectionQuery';
+            case connectionHeadersKey:
+                return 'GetConnectionHeaders';
+            default:
+                throw new Error('Invalid parameter decorator');
+        }
+    }
+    const rejected = rejectedKeys
+        .map((key) => ({
+        key,
+        name: symbolToString(key),
+    }))
+        .filter(({ key }) => resolveParamDecorator(key, target, propertyKey) !== null);
+    if (rejected.length) {
+        throw new Error(`Invalid parameter decorators: ${rejected.map(({ name }) => name).join(', ')}`);
+    }
+}
 function resolveJoinParameters(request, response, target, propertyKey) {
     const joinRequestIndex = resolveParamDecorator(joinRequestKey, target, propertyKey);
     const joinParamsIndex = resolveParamDecorator(joinParamsKey, target, propertyKey);
@@ -204,7 +288,7 @@ function resolveJoinParameters(request, response, target, propertyKey) {
         eventQueryIndex,
         JoinResponseIndex,
     ].filter((index) => typeof index === 'number');
-    const rejectedKeys = [
+    manageRejectedKeys([
         eventPayloadKey,
         eventRequestKey,
         eventResponseKey,
@@ -214,12 +298,7 @@ function resolveJoinParameters(request, response, target, propertyKey) {
         connectionRequestIdKey,
         connectionParamsKey,
         connectionQueryKey,
-    ]
-        .map((key) => resolveParamDecorator(key, target, propertyKey))
-        .filter((index) => typeof index === 'number');
-    if (rejectedKeys.length) {
-        throw new Error(`Invalid parameter decorators: ${rejectedKeys.join(', ')}`);
-    }
+    ], target, propertyKey);
     return array
         .sort((a, b) => a - b)
         .map((index) => {
@@ -262,7 +341,7 @@ function resolveEventParameters(request, response, target, propertyKey) {
         eventRequestIndex,
         userPresenceIndex,
     ].filter((index) => typeof index === 'number');
-    const rejectedKeys = [
+    manageRejectedKeys([
         joinRequestKey,
         joinResponseKey,
         joinParamsKey,
@@ -271,12 +350,7 @@ function resolveEventParameters(request, response, target, propertyKey) {
         connectionRequestIdKey,
         connectionParamsKey,
         connectionQueryKey,
-    ]
-        .map((key) => resolveParamDecorator(key, target, propertyKey))
-        .filter((index) => typeof index === 'number');
-    if (rejectedKeys.length) {
-        throw new Error(`Invalid parameter decorators: ${rejectedKeys.join(', ')}`);
-    }
+    ], target, propertyKey);
     return array
         .sort((a, b) => a - b)
         .map((index) => {
@@ -302,6 +376,30 @@ function resolveEventParameters(request, response, target, propertyKey) {
         }
     });
 }
+function resolveLeaveParameters(event, target, propertyKey) {
+    const userDataIndex = resolveParamDecorator(userDataKey, target, propertyKey);
+    manageRejectedKeys([
+        joinRequestKey,
+        joinResponseKey,
+        joinParamsKey,
+        connectionRequestKey,
+        connectionResponseKey,
+        connectionRequestIdKey,
+        connectionParamsKey,
+        connectionQueryKey,
+        eventParamsKey,
+        eventQueryKey,
+        eventPayloadKey,
+        eventResponseKey,
+        eventRequestKey,
+        userPresenceKey,
+        internalChannelKey,
+    ], target, propertyKey);
+    if (userDataIndex === null) {
+        return [];
+    }
+    return [event.assigns];
+}
 function resolveConnectionParameters(request, response, target, propertyKey) {
     const connectionRequestIndex = resolveParamDecorator(connectionRequestKey, target, propertyKey);
     const connectionResponseIndex = resolveParamDecorator(connectionResponseKey, target, propertyKey);
@@ -317,7 +415,7 @@ function resolveConnectionParameters(request, response, target, propertyKey) {
         connectionQueryIndex,
         connectionHeadersIndex,
     ].filter((index) => typeof index === 'number');
-    const rejectedKeys = [
+    manageRejectedKeys([
         joinRequestKey,
         joinResponseKey,
         joinParamsKey,
@@ -329,12 +427,7 @@ function resolveConnectionParameters(request, response, target, propertyKey) {
         eventResponseKey,
         userPresenceKey,
         eventRequestKey,
-    ]
-        .map((key) => resolveParamDecorator(key, target, propertyKey))
-        .filter((index) => typeof index === 'number');
-    if (rejectedKeys.length) {
-        throw new Error(`Invalid parameter decorators: ${rejectedKeys.join(', ')}`);
-    }
+    ], target, propertyKey);
     return array
         .sort((a, b) => a - b)
         .map((index) => {
@@ -390,6 +483,23 @@ function OnJoinRequest() {
     };
 }
 exports.OnJoinRequest = OnJoinRequest;
+function OnLeaveEvent() {
+    return (target, propertyKey, descriptor) => {
+        const originalMethod = descriptor.value;
+        const { set } = manageOnLeaveHandlers(target);
+        set('', (instance, event) => __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield originalMethod.apply(instance, resolveLeaveParameters(event, target, propertyKey));
+            }
+            catch (error) {
+                if (error instanceof Error) {
+                    console.error(error.message);
+                }
+            }
+        }));
+    };
+}
+exports.OnLeaveEvent = OnLeaveEvent;
 function OnEvent(event = '*') {
     return (target, propertyKey, descriptor) => {
         const originalMethod = descriptor.value;
@@ -458,20 +568,25 @@ function OnConnectionRequest() {
     };
 }
 exports.OnConnectionRequest = OnConnectionRequest;
-function ChannelInstance() {
+function ChannelInstance(name) {
     return (target, propertyKey) => {
-        const { get } = manageChannelInstance(target);
-        Object.defineProperty(target, propertyKey, {
-            get() {
-                return get();
-            },
-            set() {
-                throw new Error('ChannelInstance is readonly');
-            },
+        const { build } = manageChannelInstance(target);
+        build(propertyKey, (value) => {
+            if (name) {
+                return value.getChannel(name);
+            }
+            return value;
         });
     };
 }
 exports.ChannelInstance = ChannelInstance;
+function EndpointInstance() {
+    return (target, propertyKey) => {
+        const { build } = manageEndpointInstance(target);
+        build(propertyKey);
+    };
+}
+exports.EndpointInstance = EndpointInstance;
 const Channel = (path = '*') => createClassDecorator(channelClassKey, path);
 exports.Channel = Channel;
 const SetEndpoint = (path = '*') => createClassDecorator(endpointClassKey, path);
@@ -480,33 +595,20 @@ const getChannels = (target) => {
     var _a;
     return (_a = getClassMetadata(channelsClassKey, target)) !== null && _a !== void 0 ? _a : [];
 };
+// eslint-disable-next-line new-cap
 const Endpoint = (metadata) => (0, common_1.applyDecorators)(SetChannels(metadata.channels), SetEndpoint(metadata.path));
 exports.Endpoint = Endpoint;
-const Endpoints = ({ endpoints, providers = [], imports = [], exports = [], }) => (target) => {
-    const channels = endpoints.flatMap((endpoint) => getChannels(endpoint));
-    return (0, common_1.applyDecorators)(
-    // eslint-disable-next-line new-cap
-    (0, common_1.SetMetadata)(endpointsClassKey, endpoints), 
-    // eslint-disable-next-line new-cap
-    (0, common_1.Module)({
-        imports,
-        providers: [...providers, ...endpoints, ...channels],
-        exports: [...exports, ...channels],
-    }))(target);
-};
-exports.Endpoints = Endpoints;
-class PondSocketModule {
-    constructor(moduleRef, adapterHost) {
-        var _a;
+class PondSocketService {
+    constructor(moduleRef, adapterHost, endpoints) {
         this.moduleRef = moduleRef;
         this.adapterHost = adapterHost;
+        this.endpoints = endpoints;
         const httpAdapter = this.adapterHost.httpAdapter;
-        const endpoints = (_a = getClassMetadata(endpointsClassKey, this.constructor)) !== null && _a !== void 0 ? _a : [];
         httpAdapter.listen = (...args) => {
             const app = httpAdapter.getInstance();
             const server = (0, http_1.createServer)(app);
             const socket = new pondSocket_1.PondSocket(server);
-            endpoints.forEach((endpoint) => this.manageEndpoint(socket, endpoint));
+            this.endpoints.forEach((endpoint) => this.manageEndpoint(socket, endpoint));
             return socket.listen(...args);
         };
     }
@@ -516,6 +618,7 @@ class PondSocketModule {
             return;
         }
         const instance = this.moduleRef.get(endpoint, { strict: false });
+        const { set } = manageEndpointInstance(instance);
         const pondEndpoint = socket.createEndpoint(endpointMetadata, (request, response) => __awaiter(this, void 0, void 0, function* () {
             const { get } = manageConnectionHandlers(instance);
             const [handler] = get();
@@ -526,6 +629,7 @@ class PondSocketModule {
                 response.accept();
             }
         }));
+        set(pondEndpoint);
         getChannels(endpoint).forEach((channel) => {
             this.manageChannel(channel, pondEndpoint);
         });
@@ -547,13 +651,37 @@ class PondSocketModule {
             }
         }));
         const { get: getEventHandlers } = manageEventHandlers(instance);
+        const { get: getLeaveHandlers } = manageOnLeaveHandlers(instance);
         const { set } = manageChannelInstance(instance);
         getEventHandlers().forEach((handler) => {
             channelInstance.onEvent(handler.path, (request, response) => __awaiter(this, void 0, void 0, function* () {
                 yield handler.value(instance, request, response);
             }));
         });
+        const [leaveHandler] = getLeaveHandlers();
+        if (leaveHandler) {
+            channelInstance.onLeave((event) => __awaiter(this, void 0, void 0, function* () {
+                yield leaveHandler.value(instance, event);
+            }));
+        }
         set(channelInstance);
     }
 }
+class PondSocketModule {
+    static forRoot({ endpoints, providers = [], imports = [], exports = [], isGlobal = false, }) {
+        const channels = endpoints.flatMap((endpoint) => getChannels(endpoint));
+        const pondSocketProvider = {
+            provide: PondSocketService,
+            useFactory: (moduleRef, adapterHost) => new PondSocketService(moduleRef, adapterHost, endpoints),
+            inject: [core_1.ModuleRef, core_1.HttpAdapterHost],
+        };
+        return {
+            module: PondSocketModule,
+            imports: [...imports, ...endpoints, ...channels],
+            providers: [...providers, ...endpoints, ...channels, pondSocketProvider],
+            exports: [...exports, ...channels],
+            global: isGlobal,
+        };
+    }
+}
 exports.PondSocketModule = PondSocketModule;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eleven-am/pondsocket",
-  "version": "0.1.89",
+  "version": "0.1.91",
   "description": "PondSocket is a fast simple socket server",
   "keywords": [
     "socket",
@@ -29,13 +29,12 @@
     "url": "git+https://github.com/Eleven-am/pondSocket.git"
   },
   "dependencies": {
-    "@nestjs/common": "^10.3.0",
-    "@nestjs/core": "^10.3.0",
-    "reflect-metadata": "^0.1.14",
     "websocket": "^1.0.34",
     "ws": "^8.15.1"
   },
   "devDependencies": {
+    "@nestjs/common": "^10.3.0",
+    "@nestjs/core": "^10.3.0",
     "@types/express": "^4.17.21",
     "@types/jest": "^29.5.11",
     "@types/node": "^20.10.5",
@@ -46,6 +45,7 @@
     "eslint-plugin-file-progress": "^1.3.0",
     "eslint-plugin-import": "^2.29.1",
     "jest": "^29.7.0",
+    "reflect-metadata": "^0.1.14",
     "superwstest": "^2.0.3",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.2",

package/types.d.ts

@@ -1,7 +1,6 @@
 import { Server as HTTPServer, IncomingHttpHeaders } from 'http';
 
-import { ModuleMetadata } from '@nestjs/common';
-import type { ModuleRef, HttpAdapterHost } from '@nestjs/core';
+import { ModuleMetadata, DynamicModule } from '@nestjs/common';
 import type { Express } from 'express';
 import { WebSocketServer } from 'ws';
 
@@ -550,6 +549,12 @@ export declare class PondChannel {
      * @param callback - The callback to execute when a user leaves
      */
     public onLeave (callback: LeaveCallback): void;
+
+    /**
+     * @desc Gets a channel by name
+     * @param channelName - The name of the channel to get
+     */
+    public getChannel (channelName: string): Channel | null;
 }
 
 declare class PondSocket {
@@ -756,6 +761,11 @@ declare function OnJoinRequest(): MethodDecorator;
  */
 declare function OnEvent(event?: string): MethodDecorator;
 
+/**
+ * @desc Marks a method as a handler for Leave events. Useful for cleaning up resources when a user leaves.
+ */
+declare function OnLeaveEvent (): MethodDecorator;
+
 /**
  * @desc Marks a method as a handler for ConnectionRequest events. Throwing an error will reject the request with the error message.
  */
@@ -769,8 +779,15 @@ declare function DChannel(path?: string): ClassDecorator;
 
 /**
  * Decorator to retrieve the channel instance as a read-only property in a class.
+ * It may either return an instance of the PondChannel if no name is provided otherwise an instance of Channel or null (depending on if a client is connected)
+ * @param name - The name of the channel to return
  */
-declare function ChannelInstance(): PropertyDecorator;
+declare function ChannelInstance(name?: string): PropertyDecorator;
+
+/**
+ * Decorator to retrieve the endpoint instance as a read-only property in a class.
+ */
+declare function EndpointInstance (): PropertyDecorator;
 
 /**
  * Decorator to mark a class as having multiple channels.
@@ -784,17 +801,10 @@ declare function Channels(channels: Constructor<NonNullable<unknown>>[]): ClassD
  */
 declare function DEndpoint(metadata: EndpointMetadata): ClassDecorator;
 
-/**
- * Decorator to mark a class as having multiple endpoints.
- * @param metadata - The metadata for the endpoints.
- */
-declare function Endpoints(metadata: Metadata): ClassDecorator;
-
 declare class PondSocketModule {
     /**
-     * @desc The NestJS module for the PondSocketModule
-     * @param moduleRef - The NestJS moduleRef
-     * @param adapterHost - The NestJS adapterHost
+     * @desc Creates a new PondSocketModule
+     * @param metadata - The metadata for the module
      */
-    constructor (moduleRef: ModuleRef, adapterHost: HttpAdapterHost);
+    static forRoot (metadata: Metadata): DynamicModule;
 }