wse-client 1.4.1 → 1.4.3

package/README.md

@@ -33,17 +33,28 @@ Embed WSE into your existing FastAPI app on the same port:
 ```python
 from fastapi import FastAPI
 from wse_server import create_wse_router, WSEConfig
+import redis.asyncio as redis
 
 app = FastAPI()
 
+redis_client = redis.Redis(host="localhost", port=6379, decode_responses=False)
+
 wse = create_wse_router(WSEConfig(
-    redis_url="redis://localhost:6379",
+    redis_client=redis_client,
 ))
 
 app.include_router(wse, prefix="/wse")
+```
+
+Publish events from anywhere in your app via the PubSub bus:
+
+```python
+bus = app.state.pubsub_bus
 
-# Publish from anywhere in your app
-await wse.publish("notifications", {"text": "Order shipped!", "order_id": 42})
+await bus.publish(
+    topic="notifications",
+    event={"event_type": "order_shipped", "order_id": 42, "text": "Order shipped!"},
+)
 ```
 
 ### Server (Python) -- Standalone Mode
@@ -279,14 +290,69 @@ See benchmark docs for full results: [Overview](docs/BENCHMARKS.md) | [Rust Clie
 
 ## Use Cases
 
-WSE works for any real-time communication between frontend and backend:
+### Live Dashboards
+
+Push price updates, sensor data, or analytics to the browser in real time.
+
+```python
+# Server: push price updates
+await bus.publish(
+    topic="prices",
+    event={"event_type": "price_update", "symbol": "AAPL", "price": 187.42},
+)
+```
+
+```tsx
+// React: consume them
+window.addEventListener('price_update', (e: CustomEvent) => {
+  updateChart(e.detail.symbol, e.detail.price);
+});
+```
+
+### Notifications
+
+Push order updates, alerts, or system events to specific users.
+
+```python
+# Server: notify a specific user
+await bus.publish(
+    topic=f"user:{user_id}:events",
+    event={"event_type": "order_shipped", "order_id": 42, "text": "Your order shipped!"},
+)
+```
+
+```tsx
+// React: show a toast
+window.addEventListener('order_shipped', (e: CustomEvent) => {
+  showToast(e.detail.text);
+});
+```
+
+### Chat and Messaging
+
+Group chats, DMs, typing indicators, read receipts. Enable encryption for privacy.
+
+```python
+# Server: broadcast a chat message
+await bus.publish(
+    topic=f"chat:{channel_id}",
+    event={"event_type": "message_sent", "text": body.text, "author": user.name},
+)
+```
+
+```python
+# Python client: listen for messages
+async with connect("ws://localhost:5006/wse", token=jwt) as client:
+    await client.subscribe([f"chat:{channel_id}"])
+    async for event in client:
+        print(f"{event.payload['author']}: {event.payload['text']}")
+```
+
+### Other Use Cases
 
-- **Live dashboards** -- stock prices, sensor data, analytics, monitoring panels
-- **Notifications** -- order updates, alerts, system events pushed to the browser
-- **Collaborative apps** -- shared cursors, document editing, whiteboarding
-- **Chat and messaging** -- group chats, DMs, typing indicators, read receipts
-- **IoT and telemetry** -- device status, real-time metrics, command and control
-- **Gaming** -- game state sync, leaderboards, matchmaking updates
+- **Collaborative editing** -- shared cursors, document changes, conflict detection via sequence numbers
+- **IoT and telemetry** -- device status, sensor metrics, command and control. Use LOW priority for telemetry, HIGH for alerts
+- **Gaming** -- game state sync, leaderboards, matchmaking. Use msgpack binary protocol for lower latency
 
 ---
 

package/dist/constants.d.ts

@@ -1,5 +1,5 @@
 export declare const WS_PROTOCOL_VERSION = 1;
-export declare const WS_CLIENT_VERSION = "1.4.1";
+export declare const WS_CLIENT_VERSION = "1.4.3";
 export declare const HEARTBEAT_INTERVAL = 15000;
 export declare const IDLE_TIMEOUT = 40000;
 export declare const CONNECTION_TIMEOUT = 10000;

package/dist/constants.js

@@ -5,7 +5,7 @@
 // Protocol Constants
 // ---------------------------------------------------------------------------
 export const WS_PROTOCOL_VERSION = 1;
-export const WS_CLIENT_VERSION = '1.4.1';
+export const WS_CLIENT_VERSION = '1.4.3';
 // ---------------------------------------------------------------------------
 // Connection Constants
 // ---------------------------------------------------------------------------

package/dist/index.d.ts

@@ -21,5 +21,5 @@ export type { OfflineQueueConfig } from './services/OfflineQueue';
 export { EventHandlers } from './handlers/EventHandlers';
 export { registerAllHandlers } from './handlers/index';
 export * from './constants';
-export declare const WSE_VERSION = "1.4.1";
+export declare const WSE_VERSION = "1.4.3";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -44,5 +44,5 @@ export * from './constants';
 // ---------------------------------------------------------------------------
 // Version Info
 // ---------------------------------------------------------------------------
-export const WSE_VERSION = '1.4.1';
+export const WSE_VERSION = '1.4.3';
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wse-client",
-  "version": "1.4.1",
+  "version": "1.4.3",
   "description": "WSE (WebSocket Engine) React client. Type-safe hooks, auto-reconnect, offline queue, E2E encryption.",
   "main": "dist/index.js",
   "module": "dist/index.js",