@laplace.live/event-bridge-sdk 0.0.2 → 0.0.5

package/README.md

@@ -6,13 +6,13 @@ A TypeScript SDK for connecting to the LAPLACE Event Bridge server. This SDK all
 
 ```bash
 # Using npm
-npm install @laplace.live/event-bridge
+npm install @laplace.live/event-bridge-sdk
 
 # Using Yarn
-yarn add @laplace.live/event-bridge
+yarn add @laplace.live/event-bridge-sdk
 
 # Using Bun
-bun add @laplace.live/event-bridge
+bun add @laplace.live/event-bridge-sdk
 ```
 
 ## Usage
@@ -20,49 +20,44 @@ bun add @laplace.live/event-bridge
 ### Basic Usage
 
 ```typescript
-import { LaplaceEventClient } from '@laplace.live/event-bridge';
-import type { Message, System } from '@laplace.live/event-types';
+import { LaplaceEventBridgeClient } from '@laplace.live/event-bridge-sdk'
 
 // Create a new client
-const client = new LaplaceEventClient({
+const client = new LaplaceEventBridgeClient({
   url: 'ws://localhost:9696',
   token: 'your-auth-token', // Optional
   reconnect: true,
-});
+})
 
 // Connect to the bridge
-await client.connect();
+await client.connect()
 
-// Event types are automatically inferred from the event type string!
-client.on('message', (event) => {
-  // TypeScript knows 'event' is of type 'Message' here
-  console.log(`${event.username}: ${event.message}`);
-});
+client.on('message', event => {
+  console.log(`${event.username}: ${event.message}`)
+})
 
-// No need for explicit type parameters
-client.on('system', (event) => {
-  // TypeScript knows 'event' is of type 'System' here
-  console.log(`System: ${event.message}`);
-});
+client.on('system', event => {
+  console.log(`System: ${event.message}`)
+})
 
 // Listen for any event
-client.onAny((event) => {
-  console.log(`Received event of type: ${event.type}`);
-});
+client.onAny(event => {
+  console.log(`Received event of type: ${event.type}`)
+})
 
 // Disconnect when done
-client.disconnect();
+client.disconnect()
 ```
 
 ### Connection Options
 
 ```typescript
 interface ConnectionOptions {
-  url?: string;            // WebSocket URL, default: 'ws://localhost:9696'
-  token?: string;          // Authentication token, default: ''
-  reconnect?: boolean;     // Auto reconnect on disconnect, default: true
-  reconnectInterval?: number; // Milliseconds between reconnect attempts, default: 3000
-  maxReconnectAttempts?: number; // Maximum reconnect attempts, default: 10
+  url?: string // WebSocket URL, default: 'ws://localhost:9696'
+  token?: string // Authentication token, default: ''
+  reconnect?: boolean // Auto reconnect on disconnect, default: true
+  reconnectInterval?: number // Milliseconds between reconnect attempts, default: 3000
+  maxReconnectAttempts?: number // Maximum reconnect attempts, default: 10
 }
 ```
 
@@ -88,23 +83,23 @@ For example:
 
 ```typescript
 // This will infer that 'event' is of type 'Message'
-client.on('message', (event) => {
+client.on('message', event => {
   // TypeScript knows these properties exist
-  console.log(event.username);
-  console.log(event.message);
-});
+  console.log(event.username)
+  console.log(event.message)
+})
 
 // This will infer that 'event' is of type 'Gift'
-client.on('gift', (event) => {
+client.on('gift', event => {
   // TypeScript knows these properties exist
-  console.log(event.giftName);
-  console.log(event.giftCount);
-});
+  console.log(event.giftName)
+  console.log(event.giftCount)
+})
 ```
 
 ## Event Types
 
-Event types are imported from `@laplace.live/event-types` package. See the [documentation](https://chat.laplace.live/event-types/index.html) for available event types.
+Event types are imported from `@laplace.live/event-types` package. See the [documentation](https://chat.laplace.live/event-types) for available event types.
 
 ## License
 

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 LaplaceEventClient};
+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};

package/index.ts

@@ -10,14 +10,35 @@ export type EventTypeHandler = (event: LaplaceEvent) => void
 export type AnyEventHandler = (event: LaplaceEvent) => void
 
 export interface ConnectionOptions {
+  /**
+   * The URL of the LAPLACE Event Bridge server
+   *
+   * @example 'ws://localhost:9696'
+   */
   url?: string
+  /**
+   * The authentication token for the LAPLACE Event Bridge server
+   */
   token?: string
+  /**
+   * Whether to automatically reconnect to the LAPLACE Event Bridge server
+   */
   reconnect?: boolean
+  /**
+   * The interval between reconnect attempts in milliseconds
+   *
+   * @default 3000
+   */
   reconnectInterval?: number
+  /**
+   * The maximum number of reconnect attempts
+   *
+   * @default 10
+   */
   maxReconnectAttempts?: number
 }
 
-export class LaplaceEventClient {
+export class LaplaceEventBridgeClient {
   private ws: WebSocket | null = null
   private eventHandlers = new Map<string, EventHandler<any>[]>()
   private anyEventHandlers: AnyEventHandler[] = []

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@laplace.live/event-bridge-sdk",
   "description": "LAPLACE Event Bridge SDK",
-  "version": "0.0.2",
+  "version": "0.0.5",
   "module": "index.ts",
+  "license": "MIT",
   "type": "module",
   "scripts": {
     "build": "bun build index.ts --outdir dist --target browser --minify",