uniwrtc 1.0.7 → 1.0.9

package/CLOUDFLARE_DEPLOYMENT.md

@@ -70,7 +70,7 @@ await client.connect();
 ## How It Works
 
 1. **Durable Objects** - One per room, manages peer discovery
-2. **WebSocket** - Browsers connect for signaling
+2. **HTTP polling** - Browsers connect for signaling
 3. **Signaling Only** - Offers/answers/ICE via Worker
 4. **P2P Data** - WebRTC data channels bypass Cloudflare
 5. **Free Tier** - Plenty of capacity for small deployments
@@ -109,7 +109,7 @@ const serverUrl = 'http://localhost:8787/';
 
 ## Troubleshooting
 
-**WebSocket errors**: Ensure your domain is on Cloudflare with SSL enabled
+**Connection errors**: Ensure your domain is on Cloudflare with SSL enabled
 
 **Connection refused**: Check the Worker route pattern in `wrangler.toml`
 

package/README.md

@@ -1,21 +1,53 @@
 # UniWRTC
 
-A universal WebRTC signaling service that provides a simple and flexible WebSocket-based signaling server for WebRTC applications.
+A universal WebRTC signaling service that provides a simple and flexible **HTTP polling** signaling server for WebRTC applications.
 
 Available on npm: https://www.npmjs.com/package/uniwrtc
 
 ## Features
 
-- 🚀 **Simple WebSocket-based signaling** - Easy to integrate with any WebRTC application
+- 🚀 **Simple signaling** - HTTP polling (works locally and on Cloudflare Durable Objects)
 - 🏠 **Session-based architecture** - Support for multiple sessions with isolated peer groups
 - 🔌 **Flexible client library** - Ready-to-use JavaScript client for browser and Node.js
 - 📡 **Real-time messaging** - Efficient message routing between peers
 - 🔄 **Auto-reconnection** - Built-in reconnection logic for reliable connections
 - 📊 **Health monitoring** - HTTP health check endpoint for monitoring
-- 🎯 **Minimal dependencies** - Lightweight implementation using only the `ws` package
+- 🎯 **Minimal dependencies** - Lightweight implementation with minimal runtime deps
 
 ## Quick Start
 
+## Using with `simple-peer` (SDP text-only)
+
+This repo's signaling format sends **SDP as plain text** for offers/answers.
+`simple-peer` uses `{ type, sdp }` objects, so use the adapter in [simple-peer-adapter.js](simple-peer-adapter.js).
+
+Example (browser):
+
+```js
+import Peer from 'simple-peer';
+import UniWRTCClient from './client-browser.js';
+import { sendSimplePeerSignal, attachUniWRTCToSimplePeer, chooseDeterministicInitiator } from './simple-peer-adapter.js';
+
+const client = new UniWRTCClient('https://your-signal-server', { roomId: 'my-room' });
+await client.connect();
+
+// Join a session (peers in the same session can connect)
+await client.joinSession('my-room');
+
+// Ensure exactly ONE side initiates for a given pair
+const initiator = chooseDeterministicInitiator(client.clientId, targetId);
+const peer = new Peer({ initiator, trickle: true });
+const cleanup = attachUniWRTCToSimplePeer(client, peer);
+
+peer.on('signal', (signal) => {
+  // targetId must be the other peer's UniWRTC client id
+  sendSimplePeerSignal(client, signal, targetId);
+});
+
+// When done:
+// cleanup();
+```
+
 ### Installation
 
 #### From npm (recommended)
@@ -63,7 +95,7 @@ The interactive demo is available live at **https://signal.peer.ooo/** (Cloudfla
 5. Open the P2P chat and send messages between tabs
 
 **Or run locally:**
-1. Start the server: `npm start` (signaling at `ws://localhost:8080`)
+1. Start the server: `npm start` (signaling at `http://localhost:8080`)
 2. Start the Vite dev server: `npm run dev` (demo at `http://localhost:5173/`)
 3. Open the demo in two browser tabs
 4. Enter the same session ID in both, then Connect
@@ -73,7 +105,8 @@ The interactive demo is available live at **https://signal.peer.ooo/** (Cloudfla
 
 ### Server API
 
-The signaling server accepts WebSocket connections and supports the following message types:
+The signaling server supports:
+- HTTP polling signaling (no WebSockets)
 
 #### Client → Server Messages
 
@@ -97,7 +130,7 @@ The signaling server accepts WebSocket connections and supports the following me
 ```json
 {
   "type": "offer",
-  "offer": { /* RTCSessionDescription */ },
+  "offer": "v=0\r\n...",
   "targetId": "peer-client-id",
   "sessionId": "session-123"
 }
@@ -107,7 +140,7 @@ The signaling server accepts WebSocket connections and supports the following me
 ```json
 {
   "type": "answer",
-  "answer": { /* RTCSessionDescription */ },
+  "answer": "v=0\r\n...",
   "targetId": "peer-client-id",
   "sessionId": "session-123"
 }
@@ -117,7 +150,7 @@ The signaling server accepts WebSocket connections and supports the following me
 ```json
 {
   "type": "ice-candidate",
-  "candidate": { /* RTCIceCandidate */ },
+  "candidate": "candidate:...|0|0",
   "targetId": "peer-client-id",
   "sessionId": "session-123"
 }
@@ -175,16 +208,13 @@ Use directly from npm:
 ```javascript
 // ESM (browser)
 import UniWRTCClient from 'uniwrtc/client-browser.js';
-
-// CommonJS (Node.js)
-const UniWRTCClient = require('uniwrtc/client.js');
 ```
 
 The `client.js` library provides a convenient wrapper for the signaling protocol:
 
 ```javascript
 // Create a client instance
-const client = new UniWRTCClient('ws://localhost:8080');
+const client = new UniWRTCClient('http://localhost:8080', { roomId: 'my-room' });
 
 // Set up event handlers
 client.on('connected', (data) => {
@@ -220,7 +250,7 @@ client.on('ice-candidate', (data) => {
 await client.connect();
 
 // Join a session
-client.joinSession('my-session');
+await client.joinSession('my-session');
 
 // Send WebRTC signaling messages
 client.sendOffer(offerObject, targetPeerId);
@@ -233,7 +263,7 @@ client.sendIceCandidate(candidateObject, targetPeerId);
 Here's a complete example of creating a WebRTC peer connection:
 
 ```javascript
-const client = new UniWRTCClient('ws://localhost:8080');
+const client = new UniWRTCClient('http://localhost:8080', { roomId: 'my-room' });
 const peerConnections = new Map();
 
 // ICE server configuration
@@ -281,7 +311,7 @@ client.on('peer-joined', async (data) => {
 client.on('offer', async (data) => {
   const pc = createPeerConnection(data.peerId);
   
-  await pc.setRemoteDescription(data.offer);
+  await pc.setRemoteDescription({ type: 'offer', sdp: data.offer });
   const answer = await pc.createAnswer();
   await pc.setLocalDescription(answer);
   client.sendAnswer(answer, data.peerId);
@@ -291,7 +321,7 @@ client.on('offer', async (data) => {
 client.on('answer', async (data) => {
   const pc = peerConnections.get(data.peerId);
   if (pc) {
-    await pc.setRemoteDescription(data.answer);
+    await pc.setRemoteDescription({ type: 'answer', sdp: data.answer });
   }
 });
 
@@ -299,7 +329,12 @@ client.on('answer', async (data) => {
 client.on('ice-candidate', async (data) => {
   const pc = peerConnections.get(data.peerId);
   if (pc) {
-    await pc.addIceCandidate(data.candidate);
+    const [candidate, sdpMidRaw, sdpMLineIndexRaw] = String(data.candidate).split('|');
+    await pc.addIceCandidate(new RTCIceCandidate({
+      candidate,
+      sdpMid: sdpMidRaw || undefined,
+      sdpMLineIndex: sdpMLineIndexRaw !== undefined && sdpMLineIndexRaw !== '' ? Number(sdpMLineIndexRaw) : undefined
+    }));
   }
 });
 
@@ -307,8 +342,8 @@ client.on('ice-candidate', async (data) => {
 await client.connect();
 client.joinSession('my-video-session');
 
-// Or use Cloudflare Durable Objects deployment
-const cfClient = new UniWRTCClient('wss://signal.peer.ooo?room=my-session');
+// Or use Cloudflare Durable Objects deployment (HTTP polling; no WebSockets)
+const cfClient = new UniWRTCClient('https://signal.peer.ooo');
 await cfClient.connect();
 cfClient.joinSession('my-session');
 ```
@@ -323,7 +358,7 @@ new UniWRTCClient(serverUrl, options)
 ```
 
 **Parameters:**
-- `serverUrl` (string): WebSocket URL of the signaling server
+- `serverUrl` (string): HTTP(S) URL of the signaling server
 - `options` (object, optional):
   - `autoReconnect` (boolean): Enable automatic reconnection (default: true)
   - `reconnectDelay` (number): Delay between reconnection attempts in ms (default: 3000)
@@ -382,20 +417,25 @@ Response:
 
 ### Message Flow
 
-1. Client connects via WebSocket (or WS-over-HTTP for Cloudflare)
+1. Client connects via HTTPS (Cloudflare DO HTTP polling)
 2. Server/Durable Object assigns a unique client ID
 3. Client sends join message with session ID
 4. Server broadcasts `peer-joined` to other peers in the same session only
 5. Peers exchange WebRTC offers/answers/ICE candidates via the server
 6. Server routes signaling messages to specific peers by target ID (unicast, not broadcast)
 
+Notes:
+- Cloudflare signaling uses JSON over HTTPS requests to `/api` (polling).
+- Offers/answers are transmitted as SDP strings (text-only) in the `offer`/`answer` fields.
+- ICE candidates are transmitted as a compact text string: `candidate|sdpMid|sdpMLineIndex`.
+
 ## Security Considerations
 
 This is a basic signaling server suitable for development and testing. For production use, consider:
 
 - Adding authentication and authorization
 - Implementing rate limiting
-- Using TLS/WSS for encrypted connections
+- Using TLS/HTTPS for encrypted connections
 - Adding room access controls
 - Implementing message validation
 - Monitoring and logging

package/demo.html

@@ -270,7 +270,7 @@
             </div>
 
             <div class="connection-controls">
-                <input type="text" id="serverUrl" placeholder="wss://signal.peer.ooo" value="wss://signal.peer.ooo">
+                <input type="text" id="serverUrl" placeholder="https://signal.peer.ooo" value="https://signal.peer.ooo">
                 <input type="text" id="customPeerId" placeholder="Custom Peer ID (optional)">
                 <button class="btn-primary" id="connectBtn" onclick="connect()">Connect</button>
             </div>

package/deploy-cloudflare.sh

@@ -53,20 +53,27 @@ name = "uniwrtc"
 main = "src/index.js"
 compatibility_date = "2024-12-20"
 
+assets = { directory = "./dist", binding = "ASSETS" }
+
+[[durable_objects.bindings]]
+name = "ROOMS"
+class_name = "Room"
+
+[[migrations]]
+tag = "v1"
+new_classes = ["Room"]
+
 [env.production]
 routes = [
   { pattern = "${FULL_DOMAIN}/*", zone_name = "${DOMAIN}" }
 ]
 
-[[durable_objects.bindings]]
+assets = { directory = "./dist", binding = "ASSETS" }
+
+[[env.production.durable_objects.bindings]]
 name = "ROOMS"
 class_name = "Room"
 
-[durable_objects]
-migrations = [
-  { tag = "v1", new_classes = ["Room"] }
-]
-
 [build]
 command = "npm install"
 EOF

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "uniwrtc",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "A universal WebRTC signaling service",
   "main": "server.js",
   "type": "module",
@@ -15,15 +15,12 @@
   "keywords": [
     "webrtc",
     "signaling",
-    "websocket",
     "peer-to-peer",
     "real-time"
   ],
   "author": "",
   "license": "MIT",
-  "dependencies": {
-    "ws": "^8.17.1"
-  },
+  "dependencies": {},
   "devDependencies": {
     "@playwright/test": "^1.57.0",
     "vite": "^6.0.6"