@eleven-am/pondsocket 0.1.47 → 0.1.49

package/client/channel.js

@@ -74,10 +74,10 @@ class Channel {
         });
     }
     /**
-     * @desc Monitors the connection state of the channel.
+     * @desc Monitors the channel state of the channel.
      * @param callback - The callback to call when the connection state changes.
      */
-    onConnectionChange(callback) {
+    onChannelStateChange(callback) {
         return this._joinState.subscribe((data) => {
             callback(data);
         });
@@ -159,6 +159,21 @@ class Channel {
     onUsersChange(callback) {
         return this._subscribeToPresence((_event, payload) => callback(payload.presence));
     }
+    /**
+     * @desc Gets the current connection state of the channel.
+     */
+    isConnected() {
+        return this._joinState.value === enums_1.ChannelState.JOINED || this._joinState.value === enums_1.ChannelState.JOINING;
+    }
+    /**
+     * @desc Monitors the connection state of the channel.
+     * @param callback - The callback to call when the connection state changes.
+     */
+    onConnectionChange(callback) {
+        return this.onChannelStateChange((state) => {
+            callback(state === enums_1.ChannelState.JOINED || state === enums_1.ChannelState.JOINING);
+        });
+    }
     _send(event, payload, receivers = 'all_users') {
         const message = {
             action: enums_1.ClientActions.BROADCAST,

package/client/channel.test.js

@@ -83,7 +83,7 @@ describe('Channel', () => {
     it('should notify subscribers when the channel state changes', () => {
         const { channel, receiver } = createChannel();
         const stateListener = jest.fn();
-        channel.onConnectionChange(stateListener);
+        channel.onChannelStateChange(stateListener);
         expect(stateListener).toHaveBeenCalledWith(enums_1.ChannelState.IDLE);
         channel.join();
         receiver.next({
@@ -98,6 +98,24 @@ describe('Channel', () => {
         channel.leave();
         expect(stateListener).toHaveBeenCalledWith(enums_1.ChannelState.CLOSED);
     });
+    it('should notify subscribers when state changes BOOLEAN', () => {
+        const { channel, receiver } = createChannel();
+        const stateListener = jest.fn();
+        channel.onConnectionChange(stateListener);
+        expect(stateListener).toHaveBeenCalledWith(false);
+        channel.join();
+        receiver.next({
+            action: 'SYSTEM',
+            channelName: 'test',
+            event: 'SYSTEM',
+            payload: {
+                event: 'JOIN',
+            },
+        });
+        expect(stateListener).toHaveBeenCalledWith(true);
+        channel.leave();
+        expect(stateListener).toHaveBeenCalledWith(false);
+    });
     it('should correctly send a message', () => {
         const { channel, publisher, state } = createChannel();
         expect(channel.channelState).toBe(enums_1.ChannelState.IDLE);

package/package.json

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

package/types.d.ts

@@ -5,6 +5,8 @@ import internal from 'stream';
 import { Express } from 'express';
 import { WebSocketServer, WebSocket } from 'ws';
 
+import { ClientActions, PresenceEventTypes, ChannelState } from './enums';
+
 export type PondPath = string | RegExp;
 type NextFunction = () => void;
 export type JoinParams = Record<string, any>;
@@ -15,24 +17,27 @@ export type EndpointHandler = (req: IncomingConnection, res: ConnectionResponse)
 type SocketCache = Pick<RequestCache, 'socket' | 'clientId' | 'assigns'>;
 type AuthorizeMiddleware = (request: JoinRequest, response: JoinResponse) => void | Promise<void>;
 type SocketMiddlewareFunction = (req: IncomingMessage, socket: internal.Duplex, head: Buffer, next: NextFunction) => void;
+export type ChannelReceivers = 'all_users' | 'all_except_sender' | string[];
+export type ChannelEvent = Event | PresenceEvent;
 
-declare enum ClientActions {
-    JOIN_CHANNEL = 'JOIN_CHANNEL',
-    LEAVE_CHANNEL = 'LEAVE_CHANNEL',
-    BROADCAST = 'BROADCAST',
+interface Event {
+    action: 'SYSTEM' | 'BROADCAST' | 'ERROR';
+    event: string;
+    payload: PondMessage;
+    channelName: string;
 }
-declare enum PondState {
-    CONNECTING = 'CONNECTING',
-    OPEN = 'OPEN',
-    CLOSING = 'CLOSING',
-    CLOSED = 'CLOSED',
+export interface ClientMessage {
+    action: ClientActions;
+    channelName: string;
+    event: string;
+    payload: Record<string, any>;
+    addresses?: ChannelReceivers;
 }
-declare enum ChannelState {
-    IDLE = 'IDLE',
-    JOINING = 'JOINING',
-    JOINED = 'JOINED',
-    STALLED = 'STALLED',
-    CLOSED = 'CLOSED',
+interface PresenceEvent {
+    action: 'PRESENCE';
+    event: PresenceEventTypes;
+    channelName: string;
+    payload: PresencePayload;
 }
 interface RequestCache {
     clientId: string;
@@ -99,6 +104,7 @@ interface PondSocketExpressApp extends Express {
      */
     upgrade(path: PondPath, handler: EndpointHandler): Endpoint;
 }
+export type PondState = 'CONNECTING' | 'OPEN' | 'CLOSING' | 'CLOSED';
 type Unsubscribe = () => void;
 
 export interface PresencePayload {
@@ -134,7 +140,13 @@ export declare class Channel {
      * @desc Monitors the connection state of the channel.
      * @param callback - The callback to call when the connection state changes.
      */
-    public onConnectionChange(callback: (connected: ChannelState) => void): Unsubscribe;
+    public onConnectionChange(callback: (connected: boolean) => void): Unsubscribe;
+
+    /**
+     * @desc Monitors the channel state of the channel.
+     * @param callback - The callback to call when the connection state changes.
+     */
+    public onChannelStateChange (callback: (connected: ChannelState) => void): Unsubscribe;
 
     /**
      * @desc Detects when clients join the channel.
@@ -191,6 +203,11 @@ export declare class Channel {
      * @param callback - The callback to call when the presence changes.
      */
     public onUsersChange(callback: (users: PondPresence[]) => void): Unsubscribe;
+
+    /**
+     * @desc Gets the current connection state of the channel.
+     */
+    public isConnected (): boolean;
 }
 
 declare class PondSocketClient {