@laplace.live/event-bridge-sdk 0.0.6 → 0.0.8

package/README.md

@@ -1,6 +1,6 @@
 # LAPLACE Event Bridge SDK
 
-A TypeScript SDK for connecting to the LAPLACE Event Bridge server. This SDK allows clients to receive and send events from/to the LAPLACE Event Bridge.
+A framework agnostic SDK for connecting to the LAPLACE Event Bridge server. This SDK allows clients to receive and send events from/to the LAPLACE Event Bridge.
 
 ## Installation
 
@@ -45,6 +45,27 @@ client.onAny(event => {
   console.log(`Received event of type: ${event.type}`)
 })
 
+// Monitor connection state changes
+client.onConnectionStateChange(state => {
+  console.log(`Connection state changed to: ${state}`)
+
+  // Handle different connection states
+  switch (state) {
+    case 'connected':
+      console.log('Connected to the server!')
+      break
+    case 'reconnecting':
+      console.log('Attempting to reconnect...')
+      break
+    case 'disconnected':
+      console.log('Disconnected from the server')
+      break
+    case 'connecting':
+      console.log('Establishing connection...')
+      break
+  }
+})
+
 // Disconnect when done
 client.disconnect()
 ```
@@ -61,6 +82,19 @@ interface ConnectionOptions {
 }
 ```
 
+### Connection States
+
+The SDK provides a `ConnectionState` enum that represents the current state of the connection:
+
+```typescript
+enum ConnectionState {
+  DISCONNECTED = 'disconnected',
+  CONNECTING = 'connecting',
+  CONNECTED = 'connected',
+  RECONNECTING = 'reconnecting',
+}
+```
+
 ### API Reference
 
 #### Methods
@@ -69,9 +103,12 @@ interface ConnectionOptions {
 - `disconnect()`: Disconnect from the event bridge.
 - `on(eventType, handler)`: Register an event handler for a specific event type with automatic type inference.
 - `onAny(handler)`: Register a handler for all events.
+- `onConnectionStateChange(handler)`: Register a handler for connection state changes.
 - `off(eventType, handler)`: Remove an event handler for a specific event type.
 - `offAny(handler)`: Remove a handler for all events.
-- `isConnectedToBridge()`: Check if the client is connected to the bridge.
+- `offConnectionStateChange(handler)`: Remove a connection state change handler.
+- `isConnectedToBridge()`: Check if the client is connected to the bridge. (Deprecated: use `getConnectionState()` instead)
+- `getConnectionState()`: Get the current connection state.
 - `getClientId()`: Get the client ID assigned by the bridge.
 - `send(event)`: Send an event to the bridge.
 

package/dist/index.js

@@ -1 +1 @@
-class A{ws=null;eventHandlers=new Map;anyEventHandlers=[];reconnectTimer=null;reconnectAttempts=0;clientId=null;isConnected=!1;options={url:"ws://localhost:9696",token:"",reconnect:!0,reconnectInterval:3000,maxReconnectAttempts:10};constructor(k={}){this.options={...this.options,...k}}connect(){return new Promise((k,q)=>{try{if(this.ws)this.ws.close();let u=[];if(this.options.token)u.push("laplace-event-bridge-role-client",this.options.token);this.ws=new WebSocket(this.options.url,u),this.ws.onopen=()=>{this.isConnected=!0,this.reconnectAttempts=0,console.log("Connected to LAPLACE Event Bridge"),k()},this.ws.onmessage=(w)=>{try{let z=JSON.parse(w.data);if(z.type==="established"&&z.clientId)this.clientId=z.clientId,console.log(`Connection established with client ID: ${this.clientId}`);this.processEvent(z)}catch(z){console.error("Failed to parse event data:",z)}},this.ws.onerror=(w)=>{console.error("WebSocket error:",w),q(w)},this.ws.onclose=()=>{if(this.isConnected=!1,console.log("Disconnected from LAPLACE Event Bridge"),this.options.reconnect&&this.reconnectAttempts<this.options.maxReconnectAttempts)this.reconnectAttempts++,console.log(`Attempting to reconnect (${this.reconnectAttempts}/${this.options.maxReconnectAttempts})...`),this.reconnectTimer=setTimeout(()=>{this.connect().catch((w)=>{console.error("Reconnection failed:",w)})},this.options.reconnectInterval)}}catch(u){q(u)}})}disconnect(){if(this.reconnectTimer)clearTimeout(this.reconnectTimer),this.reconnectTimer=null;if(this.ws)this.ws.close(),this.ws=null;this.isConnected=!1,this.clientId=null}on(k,q){if(!this.eventHandlers.has(k))this.eventHandlers.set(k,[]);this.eventHandlers.get(k).push(q)}onAny(k){this.anyEventHandlers.push(k)}off(k,q){if(!this.eventHandlers.has(k))return;let u=this.eventHandlers.get(k),w=u.indexOf(q);if(w!==-1)u.splice(w,1);if(u.length===0)this.eventHandlers.delete(k)}offAny(k){let q=this.anyEventHandlers.indexOf(k);if(q!==-1)this.anyEventHandlers.splice(q,1)}isConnectedToBridge(){return this.isConnected}getClientId(){return this.clientId}send(k){if(!this.ws||this.ws.readyState!==WebSocket.OPEN)throw new Error("Not connected to LAPLACE Event Bridge");this.ws.send(JSON.stringify(k))}processEvent(k){if(this.eventHandlers.has(k.type))for(let q of this.eventHandlers.get(k.type))try{q(k)}catch(u){console.error(`Error in event handler for type ${k.type}:`,u)}for(let q of this.anyEventHandlers)try{q(k)}catch(u){console.error("Error in any event handler:",u)}}}export{A as LaplaceEventBridgeClient};
+var w;((q)=>{q.DISCONNECTED="disconnected";q.CONNECTING="connecting";q.CONNECTED="connected";q.RECONNECTING="reconnecting"})(w||={});class z{ws=null;eventHandlers=new Map;anyEventHandlers=[];connectionStateHandlers=[];reconnectTimer=null;reconnectAttempts=0;clientId=null;connectionState="disconnected";options={url:"ws://localhost:9696",token:"",reconnect:!0,reconnectInterval:3000,maxReconnectAttempts:10};constructor(b={}){this.options={...this.options,...b}}connect(){return new Promise((b,k)=>{try{if(this.ws)this.ws.close();this.setConnectionState("connecting");let m=[];if(this.options.token)m.push("laplace-event-bridge-role-client",this.options.token);this.ws=new WebSocket(this.options.url,m),this.ws.onopen=()=>{this.setConnectionState("connected"),this.reconnectAttempts=0,console.log("Connected to LAPLACE Event Bridge"),b()},this.ws.onmessage=(u)=>{try{let q=JSON.parse(u.data);if(q.type==="established"&&q.clientId)this.clientId=q.clientId,console.log(`Connection established with client ID: ${this.clientId}`);this.processEvent(q)}catch(q){console.error("Failed to parse event data:",q)}},this.ws.onerror=(u)=>{console.error("WebSocket error:",u),k(u)},this.ws.onclose=()=>{if(console.log("Disconnected from LAPLACE Event Bridge"),this.options.reconnect&&this.reconnectAttempts<this.options.maxReconnectAttempts)this.reconnectAttempts++,this.setConnectionState("reconnecting"),console.log(`Attempting to reconnect (${this.reconnectAttempts}/${this.options.maxReconnectAttempts})...`),this.reconnectTimer=setTimeout(()=>{this.connect().catch((u)=>{console.error("Reconnection failed:",u)})},this.options.reconnectInterval);else this.setConnectionState("disconnected")}}catch(m){this.setConnectionState("disconnected"),k(m)}})}disconnect(){if(this.reconnectTimer)clearTimeout(this.reconnectTimer),this.reconnectTimer=null;if(this.ws)this.ws.close(),this.ws=null;this.setConnectionState("disconnected"),this.clientId=null}on(b,k){if(!this.eventHandlers.has(b))this.eventHandlers.set(b,[]);this.eventHandlers.get(b).push(k)}onAny(b){this.anyEventHandlers.push(b)}onConnectionStateChange(b){this.connectionStateHandlers.push(b),b(this.connectionState)}off(b,k){if(!this.eventHandlers.has(b))return;let m=this.eventHandlers.get(b),u=m.indexOf(k);if(u!==-1)m.splice(u,1);if(m.length===0)this.eventHandlers.delete(b)}offAny(b){let k=this.anyEventHandlers.indexOf(b);if(k!==-1)this.anyEventHandlers.splice(k,1)}offConnectionStateChange(b){let k=this.connectionStateHandlers.indexOf(b);if(k!==-1)this.connectionStateHandlers.splice(k,1)}isConnectedToBridge(){return this.connectionState==="connected"}getConnectionState(){return this.connectionState}getClientId(){return this.clientId}send(b){if(!this.ws||this.ws.readyState!==WebSocket.OPEN)throw new Error("Not connected to LAPLACE Event Bridge");this.ws.send(JSON.stringify(b))}setConnectionState(b){if(this.connectionState!==b){this.connectionState=b;for(let k of this.connectionStateHandlers)try{k(b)}catch(m){console.error("Error in connection state change handler:",m)}}}processEvent(b){if(this.eventHandlers.has(b.type))for(let k of this.eventHandlers.get(b.type))try{k(b)}catch(m){console.error(`Error in event handler for type ${b.type}:`,m)}for(let k of this.anyEventHandlers)try{k(b)}catch(m){console.error("Error in any event handler:",m)}}}export{z as LaplaceEventBridgeClient,w as ConnectionState};

package/index.ts

@@ -1,5 +1,13 @@
 import type { LaplaceEvent, LaplaceEventTypes } from '@laplace.live/event-types'
 
+// Connection state enum to represent the current state of the connection
+export enum ConnectionState {
+  DISCONNECTED = 'disconnected',
+  CONNECTING = 'connecting',
+  CONNECTED = 'connected',
+  RECONNECTING = 'reconnecting',
+}
+
 // Create a conditional type that maps from event type string to event object type
 export type EventTypeMap = {
   [K in LaplaceEventTypes]: Extract<LaplaceEvent, { type: K }>
@@ -8,6 +16,7 @@ export type EventTypeMap = {
 export type EventHandler<T extends LaplaceEvent> = (event: T) => void
 export type EventTypeHandler = (event: LaplaceEvent) => void
 export type AnyEventHandler = (event: LaplaceEvent) => void
+export type ConnectionStateChangeHandler = (state: ConnectionState) => void
 
 export interface ConnectionOptions {
   /**
@@ -42,10 +51,11 @@ export class LaplaceEventBridgeClient {
   private ws: WebSocket | null = null
   private eventHandlers = new Map<string, EventHandler<any>[]>()
   private anyEventHandlers: AnyEventHandler[] = []
+  private connectionStateHandlers: ConnectionStateChangeHandler[] = []
   private reconnectTimer: number | null = null
   private reconnectAttempts = 0
   private clientId: string | null = null
-  private isConnected = false
+  private connectionState: ConnectionState = ConnectionState.DISCONNECTED
 
   private options: Required<ConnectionOptions> = {
     url: 'ws://localhost:9696',
@@ -70,6 +80,8 @@ export class LaplaceEventBridgeClient {
           this.ws.close()
         }
 
+        this.setConnectionState(ConnectionState.CONNECTING)
+
         const protocols: string[] = []
         if (this.options.token) {
           // Add the token as the second protocol parameter
@@ -79,7 +91,7 @@ export class LaplaceEventBridgeClient {
         this.ws = new WebSocket(this.options.url, protocols)
 
         this.ws.onopen = () => {
-          this.isConnected = true
+          this.setConnectionState(ConnectionState.CONNECTED)
           this.reconnectAttempts = 0
           console.log('Connected to LAPLACE Event Bridge')
           resolve()
@@ -108,20 +120,23 @@ export class LaplaceEventBridgeClient {
         }
 
         this.ws.onclose = () => {
-          this.isConnected = false
           console.log('Disconnected from LAPLACE Event Bridge')
 
           if (this.options.reconnect && this.reconnectAttempts < this.options.maxReconnectAttempts) {
             this.reconnectAttempts++
+            this.setConnectionState(ConnectionState.RECONNECTING)
             console.log(`Attempting to reconnect (${this.reconnectAttempts}/${this.options.maxReconnectAttempts})...`)
             this.reconnectTimer = setTimeout(() => {
               this.connect().catch(err => {
                 console.error('Reconnection failed:', err)
               })
             }, this.options.reconnectInterval) as unknown as number
+          } else {
+            this.setConnectionState(ConnectionState.DISCONNECTED)
           }
         }
       } catch (err) {
+        this.setConnectionState(ConnectionState.DISCONNECTED)
         reject(err)
       }
     })
@@ -141,7 +156,7 @@ export class LaplaceEventBridgeClient {
       this.ws = null
     }
 
-    this.isConnected = false
+    this.setConnectionState(ConnectionState.DISCONNECTED)
     this.clientId = null
   }
 
@@ -165,6 +180,16 @@ export class LaplaceEventBridgeClient {
     this.anyEventHandlers.push(handler)
   }
 
+  /**
+   * Register a handler for connection state changes
+   * @param handler The handler function to call when the connection state changes
+   */
+  public onConnectionStateChange(handler: ConnectionStateChangeHandler): void {
+    this.connectionStateHandlers.push(handler)
+    // Immediately call with current state to initialize
+    handler(this.connectionState)
+  }
+
   /**
    * Remove an event handler for a specific event type
    * @param eventType The event type to remove the handler for
@@ -198,11 +223,30 @@ export class LaplaceEventBridgeClient {
     }
   }
 
+  /**
+   * Remove a connection state change handler
+   * @param handler The handler function to remove
+   */
+  public offConnectionStateChange(handler: ConnectionStateChangeHandler): void {
+    const index = this.connectionStateHandlers.indexOf(handler)
+    if (index !== -1) {
+      this.connectionStateHandlers.splice(index, 1)
+    }
+  }
+
   /**
    * Check if the client is connected to the bridge
+   * @deprecated Use getConnectionState() instead for more detailed state information
    */
   public isConnectedToBridge(): boolean {
-    return this.isConnected
+    return this.connectionState === ConnectionState.CONNECTED
+  }
+
+  /**
+   * Get the current connection state
+   */
+  public getConnectionState(): ConnectionState {
+    return this.connectionState
   }
 
   /**
@@ -224,6 +268,20 @@ export class LaplaceEventBridgeClient {
     this.ws.send(JSON.stringify(event))
   }
 
+  private setConnectionState(state: ConnectionState): void {
+    if (this.connectionState !== state) {
+      this.connectionState = state
+      // Notify all connection state change handlers
+      for (const handler of this.connectionStateHandlers) {
+        try {
+          handler(state)
+        } catch (err) {
+          console.error('Error in connection state change handler:', err)
+        }
+      }
+    }
+  }
+
   private processEvent(event: LaplaceEvent): void {
     // Call specific event handlers
     if (this.eventHandlers.has(event.type)) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@laplace.live/event-bridge-sdk",
   "description": "LAPLACE Event Bridge SDK",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "module": "index.ts",
   "license": "MIT",
   "type": "module",