@eleven-am/pondsocket 0.1.46 → 0.1.48

package/client/channel.js

@@ -159,6 +159,12 @@ 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;
+    }
     _send(event, payload, receivers = 'all_users') {
         const message = {
             action: enums_1.ClientActions.BROADCAST,

package/package.json

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

package/types.d.ts

@@ -15,35 +15,18 @@ 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 PresenceEventTypes {
-    JOIN = 'JOIN',
-    LEAVE = 'LEAVE',
-    UPDATE = 'UPDATE'
-}
-
-declare enum ServerActions {
-    PRESENCE = 'PRESENCE',
-    SYSTEM = 'SYSTEM',
-    BROADCAST = 'BROADCAST',
-    ERROR = 'ERROR',
-}
 
 declare enum ClientActions {
     JOIN_CHANNEL = 'JOIN_CHANNEL',
     LEAVE_CHANNEL = 'LEAVE_CHANNEL',
     BROADCAST = 'BROADCAST',
 }
-
-export enum PondState {
+declare enum PondState {
     CONNECTING = 'CONNECTING',
     OPEN = 'OPEN',
     CLOSING = 'CLOSING',
     CLOSED = 'CLOSED',
 }
-
 declare enum ChannelState {
     IDLE = 'IDLE',
     JOINING = 'JOINING',
@@ -51,41 +34,6 @@ declare enum ChannelState {
     STALLED = 'STALLED',
     CLOSED = 'CLOSED',
 }
-
-declare enum ErrorTypes {
-    UNAUTHORIZED_JOIN_REQUEST = 'UNAUTHORIZED_JOIN_REQUEST',
-    UNAUTHORIZED_BROADCAST = 'UNAUTHORIZED_BROADCAST',
-    INVALID_MESSAGE = 'INVALID_MESSAGE',
-    HANDLER_NOT_FOUND = 'HANDLER_NOT_FOUND',
-    PRESENCE_LEAVE_FAILED = 'PRESENCE_LEAVE_FAILED',
-    INTERNAL_SERVER_ERROR = 'INTERNAL_SERVER_ERROR',
-}
-
-declare enum SystemSender {
-    SERVER = 'SERVER',
-    ENDPOINT = 'ENDPOINT',
-    CHANNEL = 'CHANNEL',
-}
-
-interface Event {
-    action: 'SYSTEM' | 'BROADCAST' | 'ERROR';
-    event: string;
-    payload: PondMessage;
-    channelName: string;
-}
-interface ClientMessage {
-    action: ClientActions;
-    channelName: string;
-    event: string;
-    payload: Record<string, any>;
-    addresses?: ChannelReceivers;
-}
-interface PresenceEvent {
-    action: 'PRESENCE';
-    event: PresenceEventTypes;
-    channelName: string;
-    payload: PresencePayload;
-}
 interface RequestCache {
     clientId: string;
     socket: WebSocket;
@@ -243,6 +191,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 {

package/enums.d.ts

@@ -1,48 +0,0 @@
-export enum PresenceEventTypes {
-    JOIN = 'JOIN',
-    LEAVE = 'LEAVE',
-    UPDATE = 'UPDATE'
-}
-
-export enum ServerActions {
-    PRESENCE = 'PRESENCE',
-    SYSTEM = 'SYSTEM',
-    BROADCAST = 'BROADCAST',
-    ERROR = 'ERROR',
-}
-
-export enum ClientActions {
-    JOIN_CHANNEL = 'JOIN_CHANNEL',
-    LEAVE_CHANNEL = 'LEAVE_CHANNEL',
-    BROADCAST = 'BROADCAST',
-}
-
-export enum PondState {
-    CONNECTING = 'CONNECTING',
-    OPEN = 'OPEN',
-    CLOSING = 'CLOSING',
-    CLOSED = 'CLOSED',
-}
-
-export enum ChannelState {
-    IDLE = 'IDLE',
-    JOINING = 'JOINING',
-    JOINED = 'JOINED',
-    STALLED = 'STALLED',
-    CLOSED = 'CLOSED',
-}
-
-export enum ErrorTypes {
-    UNAUTHORIZED_JOIN_REQUEST = 'UNAUTHORIZED_JOIN_REQUEST',
-    UNAUTHORIZED_BROADCAST = 'UNAUTHORIZED_BROADCAST',
-    INVALID_MESSAGE = 'INVALID_MESSAGE',
-    HANDLER_NOT_FOUND = 'HANDLER_NOT_FOUND',
-    PRESENCE_LEAVE_FAILED = 'PRESENCE_LEAVE_FAILED',
-    INTERNAL_SERVER_ERROR = 'INTERNAL_SERVER_ERROR',
-}
-
-export enum SystemSender {
-    SERVER = 'SERVER',
-    ENDPOINT = 'ENDPOINT',
-    CHANNEL = 'CHANNEL',
-}