mirror of
https://github.com/xtr-dev/rondevu-client.git
synced 2025-12-13 20:33:25 +00:00
Compare commits
119 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 0aa9921941 | |||
| 5fc20f1be9 | |||
| 54c371f451 | |||
| 5f4743e086 | |||
| 2ce3e98df0 | |||
| 800f6eaa94 | |||
| d6a9876440 | |||
| 9262043e97 | |||
| bd16798a2f | |||
| c662161cd9 | |||
| a9a0127ccf | |||
| 4345709e9c | |||
| 43dfd72c3d | |||
| ec19ce50db | |||
| e5c82b75b1 | |||
| a2c01d530f | |||
| 7223e45b98 | |||
| d55abf2b63 | |||
| 4ce5217135 | |||
| 238cc08bf5 | |||
| f4ae5dee30 | |||
| a499062e52 | |||
| b5f36d8f77 | |||
| 214f611dc2 | |||
| 1112eeefd4 | |||
| 0fe8e82858 | |||
| c9a5e0eae6 | |||
| 239563ac5c | |||
| 3327c5b219 | |||
| b4be5e9060 | |||
| b60799a712 | |||
| 8fbb76a336 | |||
| a3b4dfa15f | |||
| 5c38f8f36c | |||
| 177ee2ec2d | |||
| d06b2166c1 | |||
| cbb0cc3f83 | |||
| fbd3be57d4 | |||
| 54355323d9 | |||
| 945d5a8792 | |||
| 58cd610694 | |||
| 5e673ac993 | |||
| 511bac8033 | |||
| eb2c61bdb8 | |||
| 3139897b25 | |||
| a550641993 | |||
| 04603cfe2d | |||
| 6c2fd7952e | |||
| d6f2a10e3e | |||
| a6dc342f3b | |||
| 9486376442 | |||
| cffb092d3f | |||
| 122f211e7c | |||
| 4a6d0ee091 | |||
| b2d42fa776 | |||
| 63e14ddc5b | |||
| c9f6119148 | |||
| 15f821f08a | |||
| 895e7765f9 | |||
| 49d3984640 | |||
| 6057c3c582 | |||
| 255fe42a43 | |||
| 83fd0f84a4 | |||
| aa53d5bc3d | |||
| f5aa6e2189 | |||
| afdca83640 | |||
| c7ea1b9b8f | |||
| 660663945e | |||
| f119a42fcd | |||
| cd55072acb | |||
| 26f71e7a2b | |||
| 0ac1f94502 | |||
| 3530213870 | |||
| e052464482 | |||
| 53206d306b | |||
| c860419e66 | |||
| e22e74fb74 | |||
| 135eda73cf | |||
| 8d7075ccc4 | |||
| db8f0f4ced | |||
| 3a227a21ac | |||
| de1f3eac9c | |||
| 557cc0a838 | |||
| 6e661f69bc | |||
| 00f4da7250 | |||
| 6c344ec8e1 | |||
| 5a5da124a6 | |||
| c8b7a2913f | |||
| 6ddf7cb7f0 | |||
| 35ce051a26 | |||
| 280c8c284f | |||
| 14d3f943da | |||
| 2989326a50 | |||
| 7b82f963a3 | |||
| d25141a765 | |||
| 9d9aba2cf5 | |||
| dd64a565aa | |||
| cd78a16c66 | |||
| c202e1c627 | |||
| f6004a9bc0 | |||
| 5a47e0a397 | |||
| e1ca8e1c16 | |||
| 2f47107018 | |||
| d200d73cd9 | |||
| c8e5e4d17a | |||
| 6466a6f52a | |||
| 2e4d0d6a54 | |||
| 2b73e6ba44 | |||
| a893c7d040 | |||
| 35dc5aee36 | |||
| b6129294c4 | |||
| 649a8d5d3f | |||
| 2065aecc6a | |||
| 5e98610e30 | |||
| 2c3f8ef22b | |||
| 7831e03af1 | |||
| 9df9966381 | |||
| de6244cf24 | |||
| 33ecb9f9bc |
9
.prettierrc.json
Normal file
9
.prettierrc.json
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
{
|
||||||
|
"semi": false,
|
||||||
|
"singleQuote": true,
|
||||||
|
"tabWidth": 4,
|
||||||
|
"useTabs": false,
|
||||||
|
"trailingComma": "es5",
|
||||||
|
"printWidth": 100,
|
||||||
|
"arrowParens": "avoid"
|
||||||
|
}
|
||||||
486
ADVANCED.md
Normal file
486
ADVANCED.md
Normal file
@@ -0,0 +1,486 @@
|
|||||||
|
# Rondevu Client - Advanced Usage
|
||||||
|
|
||||||
|
Comprehensive guide for advanced features, platform support, and detailed API reference.
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
- [API Reference](#api-reference)
|
||||||
|
- [Types](#types)
|
||||||
|
- [Advanced Usage](#advanced-usage)
|
||||||
|
- [Platform Support](#platform-support)
|
||||||
|
- [Username Rules](#username-rules)
|
||||||
|
- [Service FQN Format](#service-fqn-format)
|
||||||
|
- [Examples](#examples)
|
||||||
|
- [Migration Guide](#migration-guide)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## API Reference
|
||||||
|
|
||||||
|
### Rondevu Class
|
||||||
|
|
||||||
|
Main class for all Rondevu operations.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Rondevu } from '@xtr-dev/rondevu-client'
|
||||||
|
|
||||||
|
// Create and connect to Rondevu
|
||||||
|
const rondevu = await Rondevu.connect({
|
||||||
|
apiUrl: string, // Signaling server URL
|
||||||
|
username?: string, // Optional: your username (auto-generates anonymous if omitted)
|
||||||
|
keypair?: Keypair, // Optional: reuse existing keypair
|
||||||
|
cryptoAdapter?: CryptoAdapter // Optional: platform-specific crypto (defaults to WebCryptoAdapter)
|
||||||
|
batching?: BatcherOptions | false // Optional: RPC batching configuration
|
||||||
|
iceServers?: IceServerPreset | RTCIceServer[] // Optional: preset name or custom STUN/TURN servers
|
||||||
|
debug?: boolean // Optional: enable debug logging (default: false)
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Platform Support (Browser & Node.js)
|
||||||
|
|
||||||
|
The client supports both browser and Node.js environments using crypto adapters:
|
||||||
|
|
||||||
|
**Browser (default):**
|
||||||
|
```typescript
|
||||||
|
import { Rondevu } from '@xtr-dev/rondevu-client'
|
||||||
|
|
||||||
|
// WebCryptoAdapter is used by default - no configuration needed
|
||||||
|
const rondevu = await Rondevu.connect({
|
||||||
|
apiUrl: 'https://api.ronde.vu',
|
||||||
|
username: 'alice'
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
**Node.js (19+ or 18 with --experimental-global-webcrypto):**
|
||||||
|
```typescript
|
||||||
|
import { Rondevu, NodeCryptoAdapter } from '@xtr-dev/rondevu-client'
|
||||||
|
|
||||||
|
const rondevu = await Rondevu.connect({
|
||||||
|
apiUrl: 'https://api.ronde.vu',
|
||||||
|
username: 'alice',
|
||||||
|
cryptoAdapter: new NodeCryptoAdapter()
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note:** Node.js support requires:
|
||||||
|
- Node.js 19+ (crypto.subtle available globally), OR
|
||||||
|
- Node.js 18 with `--experimental-global-webcrypto` flag
|
||||||
|
- WebRTC implementation like `wrtc` or `node-webrtc` for RTCPeerConnection
|
||||||
|
|
||||||
|
**Custom Crypto Adapter:**
|
||||||
|
```typescript
|
||||||
|
import { CryptoAdapter, Keypair } from '@xtr-dev/rondevu-client'
|
||||||
|
|
||||||
|
class CustomCryptoAdapter implements CryptoAdapter {
|
||||||
|
async generateKeypair(): Promise<Keypair> { /* ... */ }
|
||||||
|
async signMessage(message: string, privateKey: string): Promise<string> { /* ... */ }
|
||||||
|
async verifySignature(message: string, signature: string, publicKey: string): Promise<boolean> { /* ... */ }
|
||||||
|
bytesToBase64(bytes: Uint8Array): string { /* ... */ }
|
||||||
|
base64ToBytes(base64: string): Uint8Array { /* ... */ }
|
||||||
|
randomBytes(length: number): Uint8Array { /* ... */ }
|
||||||
|
}
|
||||||
|
|
||||||
|
const rondevu = await Rondevu.connect({
|
||||||
|
apiUrl: 'https://api.ronde.vu',
|
||||||
|
cryptoAdapter: new CustomCryptoAdapter()
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Username Management
|
||||||
|
|
||||||
|
Usernames are **automatically claimed** on the first authenticated request (like `publishService()`).
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Check if username is claimed (checks server)
|
||||||
|
await rondevu.isUsernameClaimed(): Promise<boolean>
|
||||||
|
|
||||||
|
// Get username
|
||||||
|
rondevu.getUsername(): string
|
||||||
|
|
||||||
|
// Get public key
|
||||||
|
rondevu.getPublicKey(): string
|
||||||
|
|
||||||
|
// Get keypair (for backup/storage)
|
||||||
|
rondevu.getKeypair(): Keypair
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Service Publishing
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Publish service with offers
|
||||||
|
await rondevu.publishService({
|
||||||
|
service: string, // e.g., 'chat:1.0.0' (username auto-appended)
|
||||||
|
maxOffers: number, // Maximum number of concurrent offers to maintain
|
||||||
|
offerFactory?: OfferFactory, // Optional: custom offer creation (defaults to simple data channel)
|
||||||
|
ttl?: number // Optional: milliseconds (default: 300000)
|
||||||
|
}): Promise<void>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Service Discovery
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Direct lookup by FQN (with username)
|
||||||
|
await rondevu.getService('chat:1.0.0@alice'): Promise<ServiceOffer>
|
||||||
|
|
||||||
|
// Random discovery (without username)
|
||||||
|
await rondevu.discoverService('chat:1.0.0'): Promise<ServiceOffer>
|
||||||
|
|
||||||
|
// Paginated discovery (returns multiple offers)
|
||||||
|
await rondevu.discoverServices(
|
||||||
|
'chat:1.0.0', // serviceVersion
|
||||||
|
10, // limit
|
||||||
|
0 // offset
|
||||||
|
): Promise<{ services: ServiceOffer[], count: number, limit: number, offset: number }>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### WebRTC Signaling
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Post answer SDP
|
||||||
|
await rondevu.postOfferAnswer(
|
||||||
|
serviceFqn: string,
|
||||||
|
offerId: string,
|
||||||
|
sdp: string
|
||||||
|
): Promise<{ success: boolean, offerId: string }>
|
||||||
|
|
||||||
|
// Get answer SDP (offerer polls this - deprecated, use pollOffers instead)
|
||||||
|
await rondevu.getOfferAnswer(
|
||||||
|
serviceFqn: string,
|
||||||
|
offerId: string
|
||||||
|
): Promise<{ sdp: string, offerId: string, answererId: string, answeredAt: number } | null>
|
||||||
|
|
||||||
|
// Combined polling for answers and ICE candidates (RECOMMENDED for offerers)
|
||||||
|
await rondevu.pollOffers(since?: number): Promise<{
|
||||||
|
answers: Array<{
|
||||||
|
offerId: string
|
||||||
|
serviceId?: string
|
||||||
|
answererId: string
|
||||||
|
sdp: string
|
||||||
|
answeredAt: number
|
||||||
|
}>
|
||||||
|
iceCandidates: Record<string, Array<{
|
||||||
|
candidate: RTCIceCandidateInit | null
|
||||||
|
role: 'offerer' | 'answerer'
|
||||||
|
peerId: string
|
||||||
|
createdAt: number
|
||||||
|
}>>
|
||||||
|
}>
|
||||||
|
|
||||||
|
// Add ICE candidates
|
||||||
|
await rondevu.addOfferIceCandidates(
|
||||||
|
serviceFqn: string,
|
||||||
|
offerId: string,
|
||||||
|
candidates: RTCIceCandidateInit[]
|
||||||
|
): Promise<{ count: number, offerId: string }>
|
||||||
|
|
||||||
|
// Get ICE candidates (with polling support)
|
||||||
|
await rondevu.getOfferIceCandidates(
|
||||||
|
serviceFqn: string,
|
||||||
|
offerId: string,
|
||||||
|
since: number = 0
|
||||||
|
): Promise<{ candidates: IceCandidate[], offerId: string }>
|
||||||
|
```
|
||||||
|
|
||||||
|
### RondevuAPI Class
|
||||||
|
|
||||||
|
Low-level HTTP API client (used internally by Rondevu class).
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { RondevuAPI } from '@xtr-dev/rondevu-client'
|
||||||
|
|
||||||
|
const api = new RondevuAPI(
|
||||||
|
baseUrl: string,
|
||||||
|
username: string,
|
||||||
|
keypair: Keypair
|
||||||
|
)
|
||||||
|
|
||||||
|
// Check username
|
||||||
|
await api.checkUsername(username: string): Promise<{
|
||||||
|
available: boolean
|
||||||
|
publicKey?: string
|
||||||
|
claimedAt?: number
|
||||||
|
expiresAt?: number
|
||||||
|
}>
|
||||||
|
|
||||||
|
// Note: Username claiming is now implicit - usernames are auto-claimed
|
||||||
|
// on first authenticated request to the server
|
||||||
|
|
||||||
|
// ... (all other HTTP endpoints)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Cryptographic Helpers
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Generate Ed25519 keypair
|
||||||
|
const keypair = await RondevuAPI.generateKeypair(): Promise<Keypair>
|
||||||
|
|
||||||
|
// Sign message
|
||||||
|
const signature = await RondevuAPI.signMessage(
|
||||||
|
message: string,
|
||||||
|
privateKey: string
|
||||||
|
): Promise<string>
|
||||||
|
|
||||||
|
// Verify signature
|
||||||
|
const valid = await RondevuAPI.verifySignature(
|
||||||
|
message: string,
|
||||||
|
signature: string,
|
||||||
|
publicKey: string
|
||||||
|
): Promise<boolean>
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Types
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
interface Keypair {
|
||||||
|
publicKey: string // Base64-encoded Ed25519 public key
|
||||||
|
privateKey: string // Base64-encoded Ed25519 private key
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Service {
|
||||||
|
serviceId: string
|
||||||
|
offers: ServiceOffer[]
|
||||||
|
username: string
|
||||||
|
serviceFqn: string
|
||||||
|
createdAt: number
|
||||||
|
expiresAt: number
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ServiceOffer {
|
||||||
|
offerId: string
|
||||||
|
sdp: string
|
||||||
|
createdAt: number
|
||||||
|
expiresAt: number
|
||||||
|
}
|
||||||
|
|
||||||
|
interface IceCandidate {
|
||||||
|
candidate: RTCIceCandidateInit | null
|
||||||
|
createdAt: number
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Advanced Usage
|
||||||
|
|
||||||
|
### Anonymous Username
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Auto-generate anonymous username (format: anon-{timestamp}-{random})
|
||||||
|
const rondevu = await Rondevu.connect({
|
||||||
|
apiUrl: 'https://api.ronde.vu'
|
||||||
|
// No username provided - will generate anonymous username
|
||||||
|
})
|
||||||
|
|
||||||
|
console.log(rondevu.getUsername()) // e.g., "anon-lx2w34-a3f501"
|
||||||
|
|
||||||
|
// Anonymous users behave exactly like regular users
|
||||||
|
await rondevu.publishService({
|
||||||
|
service: 'chat:1.0.0',
|
||||||
|
maxOffers: 5
|
||||||
|
})
|
||||||
|
|
||||||
|
await rondevu.startFilling()
|
||||||
|
```
|
||||||
|
|
||||||
|
### Persistent Keypair
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Save keypair and username to localStorage
|
||||||
|
const rondevu = await Rondevu.connect({
|
||||||
|
apiUrl: 'https://api.ronde.vu',
|
||||||
|
username: 'alice'
|
||||||
|
})
|
||||||
|
|
||||||
|
// Save for later (username will be auto-claimed on first authenticated request)
|
||||||
|
localStorage.setItem('rondevu-username', rondevu.getUsername())
|
||||||
|
localStorage.setItem('rondevu-keypair', JSON.stringify(rondevu.getKeypair()))
|
||||||
|
|
||||||
|
// Load on next session
|
||||||
|
const savedUsername = localStorage.getItem('rondevu-username')
|
||||||
|
const savedKeypair = JSON.parse(localStorage.getItem('rondevu-keypair'))
|
||||||
|
|
||||||
|
const rondevu2 = await Rondevu.connect({
|
||||||
|
apiUrl: 'https://api.ronde.vu',
|
||||||
|
username: savedUsername,
|
||||||
|
keypair: savedKeypair
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### Service Discovery
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Get a random available service
|
||||||
|
const service = await rondevu.discoverService('chat:1.0.0')
|
||||||
|
console.log('Discovered:', service.username)
|
||||||
|
|
||||||
|
// Get multiple services (paginated)
|
||||||
|
const result = await rondevu.discoverServices('chat:1.0.0', 10, 0)
|
||||||
|
console.log(`Found ${result.count} services:`)
|
||||||
|
result.services.forEach(s => console.log(` - ${s.username}`))
|
||||||
|
```
|
||||||
|
|
||||||
|
### Multiple Concurrent Offers
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Publish service with multiple offers for connection pooling
|
||||||
|
const offers = []
|
||||||
|
const connections = []
|
||||||
|
|
||||||
|
for (let i = 0; i < 5; i++) {
|
||||||
|
const pc = new RTCPeerConnection(rtcConfig)
|
||||||
|
const dc = pc.createDataChannel('chat')
|
||||||
|
const offer = await pc.createOffer()
|
||||||
|
await pc.setLocalDescription(offer)
|
||||||
|
|
||||||
|
offers.push({ sdp: offer.sdp })
|
||||||
|
connections.push({ pc, dc })
|
||||||
|
}
|
||||||
|
|
||||||
|
const service = await rondevu.publishService({
|
||||||
|
service: 'chat:1.0.0',
|
||||||
|
offers,
|
||||||
|
ttl: 300000
|
||||||
|
})
|
||||||
|
|
||||||
|
// Each offer can be answered independently
|
||||||
|
console.log(`Published ${service.offers.length} offers`)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Debug Logging
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Enable debug logging to see internal operations
|
||||||
|
const rondevu = await Rondevu.connect({
|
||||||
|
apiUrl: 'https://api.ronde.vu',
|
||||||
|
username: 'alice',
|
||||||
|
debug: true // All internal logs will be displayed with [Rondevu] prefix
|
||||||
|
})
|
||||||
|
|
||||||
|
// Debug logs include:
|
||||||
|
// - Connection establishment
|
||||||
|
// - Keypair generation
|
||||||
|
// - Service publishing
|
||||||
|
// - Offer creation
|
||||||
|
// - ICE candidate exchange
|
||||||
|
// - Connection state changes
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Platform Support
|
||||||
|
|
||||||
|
### Modern Browsers
|
||||||
|
Works out of the box - no additional setup needed.
|
||||||
|
|
||||||
|
### Node.js 18+
|
||||||
|
Native fetch is available, but WebRTC requires polyfills:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install wrtc
|
||||||
|
```
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { RTCPeerConnection, RTCSessionDescription, RTCIceCandidate } from 'wrtc'
|
||||||
|
|
||||||
|
// Use wrtc implementations
|
||||||
|
const pc = new RTCPeerConnection()
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Username Rules
|
||||||
|
|
||||||
|
- **Format**: Lowercase alphanumeric + dash (`a-z`, `0-9`, `-`)
|
||||||
|
- **Length**: 3-32 characters
|
||||||
|
- **Pattern**: `^[a-z0-9][a-z0-9-]*[a-z0-9]$`
|
||||||
|
- **Validity**: 365 days from claim/last use
|
||||||
|
- **Ownership**: Secured by Ed25519 public key signature
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Service FQN Format
|
||||||
|
|
||||||
|
- **Format**: `service:version@username`
|
||||||
|
- **Service**: Lowercase alphanumeric + dash (e.g., `chat`, `video-call`)
|
||||||
|
- **Version**: Semantic versioning (e.g., `1.0.0`, `2.1.3`)
|
||||||
|
- **Username**: Claimed username
|
||||||
|
- **Example**: `chat:1.0.0@alice`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Node.js Service Host Example
|
||||||
|
|
||||||
|
You can host WebRTC services in Node.js that browser clients can connect to:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Rondevu, NodeCryptoAdapter } from '@xtr-dev/rondevu-client'
|
||||||
|
import wrtc from 'wrtc'
|
||||||
|
|
||||||
|
const { RTCPeerConnection } = wrtc
|
||||||
|
|
||||||
|
// Initialize with Node crypto adapter
|
||||||
|
const rondevu = await Rondevu.connect({
|
||||||
|
apiUrl: 'https://api.ronde.vu',
|
||||||
|
username: 'mybot',
|
||||||
|
cryptoAdapter: new NodeCryptoAdapter()
|
||||||
|
})
|
||||||
|
|
||||||
|
// Create peer connection (offerer creates data channel)
|
||||||
|
const pc = new RTCPeerConnection(rtcConfig)
|
||||||
|
const dc = pc.createDataChannel('chat')
|
||||||
|
|
||||||
|
// Publish service (username auto-claimed on first publish)
|
||||||
|
await rondevu.publishService({
|
||||||
|
service: 'chat:1.0.0',
|
||||||
|
maxOffers: 5
|
||||||
|
})
|
||||||
|
|
||||||
|
await rondevu.startFilling()
|
||||||
|
|
||||||
|
// Browser clients can now discover and connect to chat:1.0.0@mybot
|
||||||
|
```
|
||||||
|
|
||||||
|
**See also:**
|
||||||
|
- [React Demo](https://github.com/xtr-dev/rondevu-demo) - Complete browser UI ([live](https://ronde.vu))
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Migration Guide
|
||||||
|
|
||||||
|
### Migration from v0.3.x
|
||||||
|
|
||||||
|
v0.4.0 removes high-level abstractions and uses manual WebRTC setup:
|
||||||
|
|
||||||
|
**Removed:**
|
||||||
|
- `ServiceHost` class (use manual WebRTC + `publishService()`)
|
||||||
|
- `ServiceClient` class (use manual WebRTC + `getService()`)
|
||||||
|
- `RTCDurableConnection` class (use native WebRTC APIs)
|
||||||
|
- `RondevuService` class (merged into `Rondevu`)
|
||||||
|
|
||||||
|
**Added:**
|
||||||
|
- `pollOffers()` - Combined polling for answers and ICE candidates
|
||||||
|
- `publishService()` - Automatic offer pool management
|
||||||
|
- `connectToService()` - Automatic answering side setup
|
||||||
|
|
||||||
|
**Migration Example:**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Before (v0.3.x) - ServiceHost
|
||||||
|
const host = new ServiceHost({
|
||||||
|
service: 'chat@1.0.0',
|
||||||
|
rondevuService: service
|
||||||
|
})
|
||||||
|
await host.start()
|
||||||
|
|
||||||
|
// After (v0.4.0+) - Automatic setup
|
||||||
|
await rondevu.publishService({
|
||||||
|
service: 'chat:1.0.0',
|
||||||
|
maxOffers: 5
|
||||||
|
})
|
||||||
|
|
||||||
|
await rondevu.startFilling()
|
||||||
|
```
|
||||||
547
MIGRATION.md
Normal file
547
MIGRATION.md
Normal file
@@ -0,0 +1,547 @@
|
|||||||
|
# Migration Guide: v0.8.x → v0.9.0
|
||||||
|
|
||||||
|
This guide helps you migrate from Rondevu Client v0.8.x to v0.9.0.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
v0.9.0 is a **breaking change** that completely replaces low-level APIs with high-level durable connections featuring automatic reconnection and message queuing.
|
||||||
|
|
||||||
|
### What's New
|
||||||
|
|
||||||
|
✅ **Durable Connections**: Automatic reconnection on network drops
|
||||||
|
✅ **Message Queuing**: Messages sent during disconnections are queued and flushed on reconnect
|
||||||
|
✅ **Durable Channels**: RTCDataChannel wrappers that survive connection drops
|
||||||
|
✅ **TTL Auto-Refresh**: Services automatically republish before expiration
|
||||||
|
✅ **Simplified API**: Direct methods on main client instead of nested APIs
|
||||||
|
|
||||||
|
### What's Removed
|
||||||
|
|
||||||
|
❌ **Low-level APIs**: `client.services.*`, `client.discovery.*`, `client.createPeer()` no longer exported
|
||||||
|
❌ **Manual Connection Management**: No need to handle WebRTC peer lifecycle manually
|
||||||
|
❌ **Service Handles**: Replaced with DurableService instances
|
||||||
|
|
||||||
|
## Breaking Changes
|
||||||
|
|
||||||
|
### 1. Service Exposure
|
||||||
|
|
||||||
|
#### v0.8.x (Old)
|
||||||
|
```typescript
|
||||||
|
import { Rondevu } from '@xtr-dev/rondevu-client';
|
||||||
|
|
||||||
|
const client = new Rondevu();
|
||||||
|
await client.register();
|
||||||
|
|
||||||
|
const handle = await client.services.exposeService({
|
||||||
|
username: 'alice',
|
||||||
|
privateKey: keypair.privateKey,
|
||||||
|
serviceFqn: 'chat@1.0.0',
|
||||||
|
isPublic: true,
|
||||||
|
handler: (channel, peer) => {
|
||||||
|
channel.onmessage = (e) => {
|
||||||
|
console.log('Received:', e.data);
|
||||||
|
channel.send(`Echo: ${e.data}`);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Unpublish
|
||||||
|
await handle.unpublish();
|
||||||
|
```
|
||||||
|
|
||||||
|
#### v0.9.0 (New)
|
||||||
|
```typescript
|
||||||
|
import { Rondevu } from '@xtr-dev/rondevu-client';
|
||||||
|
|
||||||
|
const client = new Rondevu();
|
||||||
|
await client.register();
|
||||||
|
|
||||||
|
const service = await client.exposeService({
|
||||||
|
username: 'alice',
|
||||||
|
privateKey: keypair.privateKey,
|
||||||
|
serviceFqn: 'chat@1.0.0',
|
||||||
|
isPublic: true,
|
||||||
|
poolSize: 10, // NEW: Handle multiple concurrent connections
|
||||||
|
handler: (channel, connectionId) => {
|
||||||
|
// NEW: DurableChannel with event emitters
|
||||||
|
channel.on('message', (data) => {
|
||||||
|
console.log('Received:', data);
|
||||||
|
channel.send(`Echo: ${data}`);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// NEW: Start the service
|
||||||
|
await service.start();
|
||||||
|
|
||||||
|
// NEW: Stop the service
|
||||||
|
await service.stop();
|
||||||
|
```
|
||||||
|
|
||||||
|
**Key Differences:**
|
||||||
|
- `client.services.exposeService()` → `client.exposeService()`
|
||||||
|
- Returns `DurableService` instead of `ServiceHandle`
|
||||||
|
- Handler receives `DurableChannel` instead of `RTCDataChannel`
|
||||||
|
- Handler receives `connectionId` string instead of `RondevuPeer`
|
||||||
|
- DurableChannel uses `.on('message', ...)` instead of `.onmessage = ...`
|
||||||
|
- Must call `service.start()` to begin accepting connections
|
||||||
|
- Use `service.stop()` instead of `handle.unpublish()`
|
||||||
|
|
||||||
|
### 2. Connecting to Services
|
||||||
|
|
||||||
|
#### v0.8.x (Old)
|
||||||
|
```typescript
|
||||||
|
// Connect by username + FQN
|
||||||
|
const { peer, channel } = await client.discovery.connect(
|
||||||
|
'alice',
|
||||||
|
'chat@1.0.0'
|
||||||
|
);
|
||||||
|
|
||||||
|
channel.onmessage = (e) => {
|
||||||
|
console.log('Received:', e.data);
|
||||||
|
};
|
||||||
|
|
||||||
|
channel.onopen = () => {
|
||||||
|
channel.send('Hello!');
|
||||||
|
};
|
||||||
|
|
||||||
|
peer.on('connected', () => {
|
||||||
|
console.log('Connected');
|
||||||
|
});
|
||||||
|
|
||||||
|
peer.on('failed', (error) => {
|
||||||
|
console.error('Failed:', error);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
#### v0.9.0 (New)
|
||||||
|
```typescript
|
||||||
|
// Connect by username + FQN
|
||||||
|
const connection = await client.connect('alice', 'chat@1.0.0', {
|
||||||
|
maxReconnectAttempts: 10 // NEW: Configurable reconnection
|
||||||
|
});
|
||||||
|
|
||||||
|
// NEW: Create durable channel
|
||||||
|
const channel = connection.createChannel('main');
|
||||||
|
|
||||||
|
channel.on('message', (data) => {
|
||||||
|
console.log('Received:', data);
|
||||||
|
});
|
||||||
|
|
||||||
|
channel.on('open', () => {
|
||||||
|
channel.send('Hello!');
|
||||||
|
});
|
||||||
|
|
||||||
|
// NEW: Connection lifecycle events
|
||||||
|
connection.on('connected', () => {
|
||||||
|
console.log('Connected');
|
||||||
|
});
|
||||||
|
|
||||||
|
connection.on('reconnecting', (attempt, max, delay) => {
|
||||||
|
console.log(`Reconnecting (${attempt}/${max})...`);
|
||||||
|
});
|
||||||
|
|
||||||
|
connection.on('failed', (error) => {
|
||||||
|
console.error('Failed permanently:', error);
|
||||||
|
});
|
||||||
|
|
||||||
|
// NEW: Must explicitly connect
|
||||||
|
await connection.connect();
|
||||||
|
```
|
||||||
|
|
||||||
|
**Key Differences:**
|
||||||
|
- `client.discovery.connect()` → `client.connect()`
|
||||||
|
- Returns `DurableConnection` instead of `{ peer, channel }`
|
||||||
|
- Must create channels with `connection.createChannel()`
|
||||||
|
- Must call `connection.connect()` to establish connection
|
||||||
|
- Automatic reconnection with configurable retry limits
|
||||||
|
- Messages sent during disconnection are automatically queued
|
||||||
|
|
||||||
|
### 3. Connecting by UUID
|
||||||
|
|
||||||
|
#### v0.8.x (Old)
|
||||||
|
```typescript
|
||||||
|
const { peer, channel } = await client.discovery.connectByUuid('service-uuid');
|
||||||
|
|
||||||
|
channel.onmessage = (e) => {
|
||||||
|
console.log('Received:', e.data);
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
#### v0.9.0 (New)
|
||||||
|
```typescript
|
||||||
|
const connection = await client.connectByUuid('service-uuid', {
|
||||||
|
maxReconnectAttempts: 5
|
||||||
|
});
|
||||||
|
|
||||||
|
const channel = connection.createChannel('main');
|
||||||
|
|
||||||
|
channel.on('message', (data) => {
|
||||||
|
console.log('Received:', data);
|
||||||
|
});
|
||||||
|
|
||||||
|
await connection.connect();
|
||||||
|
```
|
||||||
|
|
||||||
|
**Key Differences:**
|
||||||
|
- `client.discovery.connectByUuid()` → `client.connectByUuid()`
|
||||||
|
- Returns `DurableConnection` instead of `{ peer, channel }`
|
||||||
|
- Must create channels and connect explicitly
|
||||||
|
|
||||||
|
### 4. Multi-Connection Services (Offer Pooling)
|
||||||
|
|
||||||
|
#### v0.8.x (Old)
|
||||||
|
```typescript
|
||||||
|
const handle = await client.services.exposeService({
|
||||||
|
username: 'alice',
|
||||||
|
privateKey: keypair.privateKey,
|
||||||
|
serviceFqn: 'chat@1.0.0',
|
||||||
|
poolSize: 5,
|
||||||
|
pollingInterval: 2000,
|
||||||
|
handler: (channel, peer, connectionId) => {
|
||||||
|
console.log(`Connection: ${connectionId}`);
|
||||||
|
},
|
||||||
|
onPoolStatus: (status) => {
|
||||||
|
console.log('Pool status:', status);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const status = handle.getStatus();
|
||||||
|
await handle.addOffers(3);
|
||||||
|
```
|
||||||
|
|
||||||
|
#### v0.9.0 (New)
|
||||||
|
```typescript
|
||||||
|
const service = await client.exposeService({
|
||||||
|
username: 'alice',
|
||||||
|
privateKey: keypair.privateKey,
|
||||||
|
serviceFqn: 'chat@1.0.0',
|
||||||
|
poolSize: 5, // SAME: Pool size
|
||||||
|
pollingInterval: 2000, // SAME: Polling interval
|
||||||
|
handler: (channel, connectionId) => {
|
||||||
|
console.log(`Connection: ${connectionId}`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
await service.start();
|
||||||
|
|
||||||
|
// Get active connections
|
||||||
|
const connections = service.getActiveConnections();
|
||||||
|
|
||||||
|
// Listen for connection events
|
||||||
|
service.on('connection', (connectionId) => {
|
||||||
|
console.log('New connection:', connectionId);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
**Key Differences:**
|
||||||
|
- `onPoolStatus` callback removed (use `service.on('connection')` instead)
|
||||||
|
- `handle.getStatus()` replaced with `service.getActiveConnections()`
|
||||||
|
- `handle.addOffers()` removed (pool auto-manages offers)
|
||||||
|
- Handler receives `DurableChannel` instead of `RTCDataChannel`
|
||||||
|
|
||||||
|
## Feature Comparison
|
||||||
|
|
||||||
|
| Feature | v0.8.x | v0.9.0 |
|
||||||
|
|---------|--------|--------|
|
||||||
|
| Service exposure | `client.services.exposeService()` | `client.exposeService()` |
|
||||||
|
| Connection | `client.discovery.connect()` | `client.connect()` |
|
||||||
|
| Connection by UUID | `client.discovery.connectByUuid()` | `client.connectByUuid()` |
|
||||||
|
| Channel type | `RTCDataChannel` | `DurableChannel` |
|
||||||
|
| Event handling | `.onmessage`, `.onopen`, etc. | `.on('message')`, `.on('open')`, etc. |
|
||||||
|
| Automatic reconnection | ❌ No | ✅ Yes (configurable) |
|
||||||
|
| Message queuing | ❌ No | ✅ Yes (during disconnections) |
|
||||||
|
| TTL auto-refresh | ❌ No | ✅ Yes (configurable) |
|
||||||
|
| Peer lifecycle | Manual | Automatic |
|
||||||
|
| Connection pooling | ✅ Yes | ✅ Yes (same API) |
|
||||||
|
|
||||||
|
## API Mapping
|
||||||
|
|
||||||
|
### Removed Exports
|
||||||
|
|
||||||
|
These are no longer exported in v0.9.0:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ❌ Removed
|
||||||
|
import {
|
||||||
|
RondevuServices,
|
||||||
|
RondevuDiscovery,
|
||||||
|
RondevuPeer,
|
||||||
|
ServiceHandle,
|
||||||
|
PooledServiceHandle,
|
||||||
|
ConnectResult
|
||||||
|
} from '@xtr-dev/rondevu-client';
|
||||||
|
```
|
||||||
|
|
||||||
|
### New Exports
|
||||||
|
|
||||||
|
These are new in v0.9.0:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ New
|
||||||
|
import {
|
||||||
|
DurableConnection,
|
||||||
|
DurableChannel,
|
||||||
|
DurableService,
|
||||||
|
DurableConnectionState,
|
||||||
|
DurableChannelState,
|
||||||
|
DurableConnectionConfig,
|
||||||
|
DurableChannelConfig,
|
||||||
|
DurableServiceConfig,
|
||||||
|
DurableConnectionEvents,
|
||||||
|
DurableChannelEvents,
|
||||||
|
DurableServiceEvents,
|
||||||
|
ConnectionInfo,
|
||||||
|
ServiceInfo,
|
||||||
|
QueuedMessage
|
||||||
|
} from '@xtr-dev/rondevu-client';
|
||||||
|
```
|
||||||
|
|
||||||
|
### Unchanged Exports
|
||||||
|
|
||||||
|
These work the same in both versions:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Unchanged
|
||||||
|
import {
|
||||||
|
Rondevu,
|
||||||
|
RondevuAuth,
|
||||||
|
RondevuUsername,
|
||||||
|
Credentials,
|
||||||
|
UsernameClaimResult,
|
||||||
|
UsernameCheckResult
|
||||||
|
} from '@xtr-dev/rondevu-client';
|
||||||
|
```
|
||||||
|
|
||||||
|
## Configuration Options
|
||||||
|
|
||||||
|
### New Connection Options
|
||||||
|
|
||||||
|
v0.9.0 adds extensive configuration for automatic reconnection and message queuing:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const connection = await client.connect('alice', 'chat@1.0.0', {
|
||||||
|
// Reconnection
|
||||||
|
maxReconnectAttempts: 10, // default: 10
|
||||||
|
reconnectBackoffBase: 1000, // default: 1000ms
|
||||||
|
reconnectBackoffMax: 30000, // default: 30000ms (30 seconds)
|
||||||
|
reconnectJitter: 0.2, // default: 0.2 (±20%)
|
||||||
|
connectionTimeout: 30000, // default: 30000ms
|
||||||
|
|
||||||
|
// Message queuing
|
||||||
|
maxQueueSize: 1000, // default: 1000 messages
|
||||||
|
maxMessageAge: 60000, // default: 60000ms (1 minute)
|
||||||
|
|
||||||
|
// WebRTC
|
||||||
|
rtcConfig: {
|
||||||
|
iceServers: [...]
|
||||||
|
}
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### New Service Options
|
||||||
|
|
||||||
|
Services can now auto-refresh TTL:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const service = await client.exposeService({
|
||||||
|
username: 'alice',
|
||||||
|
privateKey: keypair.privateKey,
|
||||||
|
serviceFqn: 'chat@1.0.0',
|
||||||
|
|
||||||
|
// TTL auto-refresh (NEW)
|
||||||
|
ttl: 300000, // default: 300000ms (5 minutes)
|
||||||
|
ttlRefreshMargin: 0.2, // default: 0.2 (refresh at 80% of TTL)
|
||||||
|
|
||||||
|
// All connection options also apply to incoming connections
|
||||||
|
maxReconnectAttempts: 10,
|
||||||
|
maxQueueSize: 1000,
|
||||||
|
// ...
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## Migration Checklist
|
||||||
|
|
||||||
|
- [ ] Replace `client.services.exposeService()` with `client.exposeService()`
|
||||||
|
- [ ] Add `await service.start()` after creating service
|
||||||
|
- [ ] Replace `handle.unpublish()` with `service.stop()`
|
||||||
|
- [ ] Replace `client.discovery.connect()` with `client.connect()`
|
||||||
|
- [ ] Replace `client.discovery.connectByUuid()` with `client.connectByUuid()`
|
||||||
|
- [ ] Create channels with `connection.createChannel()` instead of receiving them directly
|
||||||
|
- [ ] Add `await connection.connect()` to establish connection
|
||||||
|
- [ ] Update handlers from `(channel, peer, connectionId?)` to `(channel, connectionId)`
|
||||||
|
- [ ] Replace `.onmessage` with `.on('message', ...)`
|
||||||
|
- [ ] Replace `.onopen` with `.on('open', ...)`
|
||||||
|
- [ ] Replace `.onclose` with `.on('close', ...)`
|
||||||
|
- [ ] Replace `.onerror` with `.on('error', ...)`
|
||||||
|
- [ ] Add reconnection event handlers (`connection.on('reconnecting', ...)`)
|
||||||
|
- [ ] Review and configure reconnection options if needed
|
||||||
|
- [ ] Review and configure message queue limits if needed
|
||||||
|
- [ ] Update TypeScript imports to use new types
|
||||||
|
- [ ] Test automatic reconnection behavior
|
||||||
|
- [ ] Test message queuing during disconnections
|
||||||
|
|
||||||
|
## Common Migration Patterns
|
||||||
|
|
||||||
|
### Pattern 1: Simple Echo Service
|
||||||
|
|
||||||
|
#### Before (v0.8.x)
|
||||||
|
```typescript
|
||||||
|
await client.services.exposeService({
|
||||||
|
username: 'alice',
|
||||||
|
privateKey: keypair.privateKey,
|
||||||
|
serviceFqn: 'echo@1.0.0',
|
||||||
|
handler: (channel) => {
|
||||||
|
channel.onmessage = (e) => {
|
||||||
|
channel.send(`Echo: ${e.data}`);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
#### After (v0.9.0)
|
||||||
|
```typescript
|
||||||
|
const service = await client.exposeService({
|
||||||
|
username: 'alice',
|
||||||
|
privateKey: keypair.privateKey,
|
||||||
|
serviceFqn: 'echo@1.0.0',
|
||||||
|
handler: (channel) => {
|
||||||
|
channel.on('message', (data) => {
|
||||||
|
channel.send(`Echo: ${data}`);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
await service.start();
|
||||||
|
```
|
||||||
|
|
||||||
|
### Pattern 2: Connection with Error Handling
|
||||||
|
|
||||||
|
#### Before (v0.8.x)
|
||||||
|
```typescript
|
||||||
|
try {
|
||||||
|
const { peer, channel } = await client.discovery.connect('alice', 'chat@1.0.0');
|
||||||
|
|
||||||
|
channel.onopen = () => {
|
||||||
|
channel.send('Hello!');
|
||||||
|
};
|
||||||
|
|
||||||
|
peer.on('failed', (error) => {
|
||||||
|
console.error('Connection failed:', error);
|
||||||
|
// Manual reconnection logic here
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
console.error('Failed to connect:', error);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### After (v0.9.0)
|
||||||
|
```typescript
|
||||||
|
const connection = await client.connect('alice', 'chat@1.0.0', {
|
||||||
|
maxReconnectAttempts: 5
|
||||||
|
});
|
||||||
|
|
||||||
|
const channel = connection.createChannel('main');
|
||||||
|
|
||||||
|
channel.on('open', () => {
|
||||||
|
channel.send('Hello!');
|
||||||
|
});
|
||||||
|
|
||||||
|
connection.on('reconnecting', (attempt, max, delay) => {
|
||||||
|
console.log(`Reconnecting (${attempt}/${max}) in ${delay}ms`);
|
||||||
|
});
|
||||||
|
|
||||||
|
connection.on('failed', (error) => {
|
||||||
|
console.error('Connection failed permanently:', error);
|
||||||
|
});
|
||||||
|
|
||||||
|
try {
|
||||||
|
await connection.connect();
|
||||||
|
} catch (error) {
|
||||||
|
console.error('Initial connection failed:', error);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Pattern 3: Multi-User Chat Server
|
||||||
|
|
||||||
|
#### Before (v0.8.x)
|
||||||
|
```typescript
|
||||||
|
const connections = new Map();
|
||||||
|
|
||||||
|
await client.services.exposeService({
|
||||||
|
username: 'alice',
|
||||||
|
privateKey: keypair.privateKey,
|
||||||
|
serviceFqn: 'chat@1.0.0',
|
||||||
|
poolSize: 10,
|
||||||
|
handler: (channel, peer, connectionId) => {
|
||||||
|
connections.set(connectionId, channel);
|
||||||
|
|
||||||
|
channel.onmessage = (e) => {
|
||||||
|
// Broadcast to all
|
||||||
|
for (const [id, ch] of connections) {
|
||||||
|
if (id !== connectionId) {
|
||||||
|
ch.send(e.data);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
channel.onclose = () => {
|
||||||
|
connections.delete(connectionId);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
#### After (v0.9.0)
|
||||||
|
```typescript
|
||||||
|
const channels = new Map();
|
||||||
|
|
||||||
|
const service = await client.exposeService({
|
||||||
|
username: 'alice',
|
||||||
|
privateKey: keypair.privateKey,
|
||||||
|
serviceFqn: 'chat@1.0.0',
|
||||||
|
poolSize: 10,
|
||||||
|
handler: (channel, connectionId) => {
|
||||||
|
channels.set(connectionId, channel);
|
||||||
|
|
||||||
|
channel.on('message', (data) => {
|
||||||
|
// Broadcast to all
|
||||||
|
for (const [id, ch] of channels) {
|
||||||
|
if (id !== connectionId) {
|
||||||
|
ch.send(data);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
channel.on('close', () => {
|
||||||
|
channels.delete(connectionId);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
await service.start();
|
||||||
|
|
||||||
|
// Optional: Track connections
|
||||||
|
service.on('connection', (connectionId) => {
|
||||||
|
console.log(`User ${connectionId} joined`);
|
||||||
|
});
|
||||||
|
|
||||||
|
service.on('disconnection', (connectionId) => {
|
||||||
|
console.log(`User ${connectionId} left`);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## Benefits of Migration
|
||||||
|
|
||||||
|
1. **Reliability**: Automatic reconnection handles network hiccups transparently
|
||||||
|
2. **Simplicity**: No need to manage WebRTC peer lifecycle manually
|
||||||
|
3. **Durability**: Messages sent during disconnections are queued and delivered when connection restores
|
||||||
|
4. **Uptime**: Services automatically refresh TTL before expiration
|
||||||
|
5. **Type Safety**: Better TypeScript types with DurableChannel event emitters
|
||||||
|
6. **Debugging**: Queue size monitoring, connection state tracking, and detailed events
|
||||||
|
|
||||||
|
## Getting Help
|
||||||
|
|
||||||
|
If you encounter issues during migration:
|
||||||
|
1. Check the [README](./README.md) for complete API documentation
|
||||||
|
2. Review the examples for common patterns
|
||||||
|
3. Open an issue on [GitHub](https://github.com/xtr-dev/rondevu-client/issues)
|
||||||
191
README.md
191
README.md
@@ -1,60 +1,177 @@
|
|||||||
# Rondevu
|
# Rondevu Client
|
||||||
|
|
||||||
🎯 Meet WebRTC peers by topic, by peer ID, or by connection ID.
|
|
||||||
|
|
||||||
## @xtr-dev/rondevu-client
|
|
||||||
|
|
||||||
[](https://www.npmjs.com/package/@xtr-dev/rondevu-client)
|
[](https://www.npmjs.com/package/@xtr-dev/rondevu-client)
|
||||||
|
|
||||||
TypeScript Rondevu HTTP and WebRTC client, for simple peer discovery and connection.
|
🌐 **Simple WebRTC signaling client with username-based discovery**
|
||||||
|
|
||||||
### Install
|
TypeScript/JavaScript client for Rondevu, providing WebRTC signaling with username claiming, service publishing/discovery, and efficient batch polling.
|
||||||
|
|
||||||
|
**Related repositories:**
|
||||||
|
- [@xtr-dev/rondevu-client](https://github.com/xtr-dev/rondevu-client) - TypeScript client library ([npm](https://www.npmjs.com/package/@xtr-dev/rondevu-client))
|
||||||
|
- [@xtr-dev/rondevu-server](https://github.com/xtr-dev/rondevu-server) - HTTP signaling server ([npm](https://www.npmjs.com/package/@xtr-dev/rondevu-server), [live](https://api.ronde.vu))
|
||||||
|
- [@xtr-dev/rondevu-demo](https://github.com/xtr-dev/rondevu-demo) - Interactive demo ([live](https://ronde.vu))
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- **Username Claiming**: Secure ownership with Ed25519 signatures
|
||||||
|
- **Anonymous Users**: Auto-generated anonymous usernames for quick testing
|
||||||
|
- **Service Publishing**: Publish services with multiple offers for connection pooling
|
||||||
|
- **Service Discovery**: Direct lookup, random discovery, or paginated search
|
||||||
|
- **Efficient Batch Polling**: Single endpoint for answers and ICE candidates (50% fewer requests)
|
||||||
|
- **Semantic Version Matching**: Compatible version resolution (chat:1.0.0 matches any 1.x.x)
|
||||||
|
- **TypeScript**: Full type safety and autocomplete
|
||||||
|
- **Keypair Management**: Generate or reuse Ed25519 keypairs
|
||||||
|
- **Automatic Signatures**: All authenticated requests signed automatically
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install @xtr-dev/rondevu-client
|
npm install @xtr-dev/rondevu-client
|
||||||
```
|
```
|
||||||
|
|
||||||
### Usage
|
## Quick Start
|
||||||
|
|
||||||
|
### Publishing a Service (Offerer)
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { Rondevu } from '@xtr-dev/rondevu-client';
|
import { Rondevu } from '@xtr-dev/rondevu-client'
|
||||||
|
|
||||||
const rdv = new Rondevu({ baseUrl: 'https://server.com' });
|
// 1. Connect to Rondevu
|
||||||
|
const rondevu = await Rondevu.connect({
|
||||||
|
apiUrl: 'https://api.ronde.vu',
|
||||||
|
username: 'alice', // Or omit for anonymous username
|
||||||
|
iceServers: 'ipv4-turn' // Preset: 'ipv4-turn', 'hostname-turns', 'google-stun', 'relay-only'
|
||||||
|
})
|
||||||
|
|
||||||
// Connect by topic
|
// 2. Publish service with automatic offer management
|
||||||
const conn = await rdv.join('room');
|
await rondevu.publishService({
|
||||||
|
service: 'chat:1.0.0',
|
||||||
|
maxOffers: 5, // Maintain up to 5 concurrent offers
|
||||||
|
offerFactory: async (rtcConfig) => {
|
||||||
|
const pc = new RTCPeerConnection(rtcConfig)
|
||||||
|
const dc = pc.createDataChannel('chat')
|
||||||
|
|
||||||
// Or connect by ID
|
dc.addEventListener('open', () => {
|
||||||
const conn = await rdv.connect('meeting-123');
|
console.log('Connection opened!')
|
||||||
|
dc.send('Hello from Alice!')
|
||||||
|
})
|
||||||
|
|
||||||
// Use the connection
|
dc.addEventListener('message', (e) => {
|
||||||
conn.on('connect', () => {
|
console.log('Received:', e.data)
|
||||||
const channel = conn.dataChannel('chat');
|
})
|
||||||
channel.send('Hello!');
|
|
||||||
});
|
const offer = await pc.createOffer()
|
||||||
|
await pc.setLocalDescription(offer)
|
||||||
|
return { pc, dc, offer }
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
// 3. Start accepting connections
|
||||||
|
await rondevu.startFilling()
|
||||||
```
|
```
|
||||||
|
|
||||||
### API
|
### Connecting to a Service (Answerer)
|
||||||
|
|
||||||
**Main Methods:**
|
```typescript
|
||||||
- `rdv.join(topic)` - Auto-connect to first peer in topic
|
import { Rondevu } from '@xtr-dev/rondevu-client'
|
||||||
- `rdv.join(topic, {filter})` - Connect to specific peer by ID
|
|
||||||
- `rdv.create(id, topic)` - Create connection for others to join
|
|
||||||
- `rdv.connect(id)` - Join connection by ID
|
|
||||||
|
|
||||||
**Connection Events:**
|
// 1. Connect to Rondevu
|
||||||
- `connect` - Connection established
|
const rondevu = await Rondevu.connect({
|
||||||
- `disconnect` - Connection closed
|
apiUrl: 'https://api.ronde.vu',
|
||||||
- `datachannel` - Remote peer created data channel
|
username: 'bob',
|
||||||
- `stream` - Remote media stream received
|
iceServers: 'ipv4-turn'
|
||||||
- `error` - Error occurred
|
})
|
||||||
|
|
||||||
**Connection Methods:**
|
// 2. Connect to service (automatic WebRTC setup)
|
||||||
- `conn.dataChannel(label)` - Get or create data channel
|
const connection = await rondevu.connectToService({
|
||||||
- `conn.addStream(stream)` - Add media stream
|
serviceFqn: 'chat:1.0.0@alice',
|
||||||
- `conn.getPeerConnection()` - Get underlying RTCPeerConnection
|
onConnection: ({ dc, peerUsername }) => {
|
||||||
- `conn.close()` - Close connection
|
console.log('Connected to', peerUsername)
|
||||||
|
|
||||||
### License
|
dc.addEventListener('message', (e) => {
|
||||||
|
console.log('Received:', e.data)
|
||||||
|
})
|
||||||
|
|
||||||
|
dc.addEventListener('open', () => {
|
||||||
|
dc.send('Hello from Bob!')
|
||||||
|
})
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
// Access connection
|
||||||
|
connection.dc.send('Another message')
|
||||||
|
connection.pc.close() // Close when done
|
||||||
|
```
|
||||||
|
|
||||||
|
## Core API
|
||||||
|
|
||||||
|
### Rondevu.connect()
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const rondevu = await Rondevu.connect({
|
||||||
|
apiUrl: string, // Required: Signaling server URL
|
||||||
|
username?: string, // Optional: your username (auto-generates anonymous if omitted)
|
||||||
|
keypair?: Keypair, // Optional: reuse existing keypair
|
||||||
|
iceServers?: IceServerPreset | RTCIceServer[], // Optional: preset or custom config
|
||||||
|
debug?: boolean // Optional: enable debug logging (default: false)
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### Service Publishing
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
await rondevu.publishService({
|
||||||
|
service: string, // e.g., 'chat:1.0.0' (username auto-appended)
|
||||||
|
maxOffers: number, // Maximum concurrent offers to maintain
|
||||||
|
offerFactory?: OfferFactory, // Optional: custom offer creation
|
||||||
|
ttl?: number // Optional: offer lifetime in ms (default: 300000)
|
||||||
|
})
|
||||||
|
|
||||||
|
await rondevu.startFilling() // Start accepting connections
|
||||||
|
rondevu.stopFilling() // Stop and close all connections
|
||||||
|
```
|
||||||
|
|
||||||
|
### Service Discovery
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Direct lookup (with username)
|
||||||
|
await rondevu.getService('chat:1.0.0@alice')
|
||||||
|
|
||||||
|
// Random discovery (without username)
|
||||||
|
await rondevu.discoverService('chat:1.0.0')
|
||||||
|
|
||||||
|
// Paginated discovery
|
||||||
|
await rondevu.discoverServices('chat:1.0.0', limit, offset)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Connecting to Services
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const connection = await rondevu.connectToService({
|
||||||
|
serviceFqn?: string, // Full FQN like 'chat:1.0.0@alice'
|
||||||
|
service?: string, // Service without username (for discovery)
|
||||||
|
username?: string, // Target username (combined with service)
|
||||||
|
onConnection?: (context) => void, // Called when data channel opens
|
||||||
|
rtcConfig?: RTCConfiguration // Optional: override ICE servers
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
📚 **[ADVANCED.md](./ADVANCED.md)** - Comprehensive guide including:
|
||||||
|
- Detailed API reference for all methods
|
||||||
|
- Type definitions and interfaces
|
||||||
|
- Platform support (Browser & Node.js)
|
||||||
|
- Advanced usage patterns
|
||||||
|
- Username rules and service FQN format
|
||||||
|
- Examples and migration guides
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
- [React Demo](https://github.com/xtr-dev/rondevu-demo) - Full browser UI ([live](https://ronde.vu))
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
MIT
|
MIT
|
||||||
|
|||||||
52
eslint.config.js
Normal file
52
eslint.config.js
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
import js from '@eslint/js'
|
||||||
|
import tsPlugin from '@typescript-eslint/eslint-plugin'
|
||||||
|
import tsParser from '@typescript-eslint/parser'
|
||||||
|
import prettierConfig from 'eslint-config-prettier'
|
||||||
|
import prettierPlugin from 'eslint-plugin-prettier'
|
||||||
|
import unicorn from 'eslint-plugin-unicorn'
|
||||||
|
import globals from 'globals'
|
||||||
|
|
||||||
|
export default [
|
||||||
|
js.configs.recommended,
|
||||||
|
{
|
||||||
|
files: ['**/*.ts', '**/*.tsx', '**/*.js'],
|
||||||
|
languageOptions: {
|
||||||
|
parser: tsParser,
|
||||||
|
parserOptions: {
|
||||||
|
ecmaVersion: 'latest',
|
||||||
|
sourceType: 'module',
|
||||||
|
},
|
||||||
|
globals: {
|
||||||
|
...globals.browser,
|
||||||
|
...globals.node,
|
||||||
|
RTCPeerConnection: 'readonly',
|
||||||
|
RTCIceCandidate: 'readonly',
|
||||||
|
RTCSessionDescriptionInit: 'readonly',
|
||||||
|
RTCIceCandidateInit: 'readonly',
|
||||||
|
BufferSource: 'readonly',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
plugins: {
|
||||||
|
'@typescript-eslint': tsPlugin,
|
||||||
|
prettier: prettierPlugin,
|
||||||
|
unicorn: unicorn,
|
||||||
|
},
|
||||||
|
rules: {
|
||||||
|
...tsPlugin.configs.recommended.rules,
|
||||||
|
...prettierConfig.rules,
|
||||||
|
'prettier/prettier': 'error',
|
||||||
|
'@typescript-eslint/no-explicit-any': 'off',
|
||||||
|
'@typescript-eslint/no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
|
||||||
|
'unicorn/filename-case': [
|
||||||
|
'error',
|
||||||
|
{
|
||||||
|
case: 'kebabCase',
|
||||||
|
ignore: ['^README\\.md$'],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
ignores: ['dist/**', 'node_modules/**', '*.config.js'],
|
||||||
|
},
|
||||||
|
]
|
||||||
2997
package-lock.json
generated
Normal file
2997
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
25
package.json
25
package.json
@@ -1,13 +1,17 @@
|
|||||||
{
|
{
|
||||||
"name": "@xtr-dev/rondevu-client",
|
"name": "@xtr-dev/rondevu-client",
|
||||||
"version": "0.0.4",
|
"version": "0.17.0",
|
||||||
"description": "TypeScript client for Rondevu peer signaling and discovery server",
|
"description": "TypeScript client for Rondevu with durable WebRTC connections, automatic reconnection, and message queuing",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"types": "dist/index.d.ts",
|
"types": "dist/index.d.ts",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "tsc",
|
"build": "tsc",
|
||||||
"typecheck": "tsc --noEmit",
|
"typecheck": "tsc --noEmit",
|
||||||
|
"dev": "vite",
|
||||||
|
"lint": "eslint src demo --ext .ts,.tsx,.js",
|
||||||
|
"lint:fix": "eslint src demo --ext .ts,.tsx,.js --fix",
|
||||||
|
"format": "prettier --write \"src/**/*.{ts,tsx,js}\" \"demo/**/*.{ts,tsx,js,html}\"",
|
||||||
"prepublishOnly": "npm run build"
|
"prepublishOnly": "npm run build"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
@@ -20,10 +24,23 @@
|
|||||||
"author": "",
|
"author": "",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"typescript": "^5.9.3"
|
"@eslint/js": "^9.39.1",
|
||||||
|
"@typescript-eslint/eslint-plugin": "^8.48.1",
|
||||||
|
"@typescript-eslint/parser": "^8.48.1",
|
||||||
|
"eslint": "^9.39.1",
|
||||||
|
"eslint-config-prettier": "^10.1.8",
|
||||||
|
"eslint-plugin-prettier": "^5.5.4",
|
||||||
|
"eslint-plugin-unicorn": "^62.0.0",
|
||||||
|
"globals": "^16.5.0",
|
||||||
|
"prettier": "^3.7.4",
|
||||||
|
"typescript": "^5.9.3",
|
||||||
|
"vite": "^7.2.6"
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"dist",
|
"dist",
|
||||||
"README.md"
|
"README.md"
|
||||||
]
|
],
|
||||||
|
"dependencies": {
|
||||||
|
"@noble/ed25519": "^3.0.0"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
423
src/api.ts
Normal file
423
src/api.ts
Normal file
@@ -0,0 +1,423 @@
|
|||||||
|
/**
|
||||||
|
* Rondevu API Client - RPC interface
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { CryptoAdapter, Keypair } from './crypto-adapter.js'
|
||||||
|
import { WebCryptoAdapter } from './web-crypto-adapter.js'
|
||||||
|
import { RpcBatcher, BatcherOptions } from './rpc-batcher.js'
|
||||||
|
|
||||||
|
export type { Keypair } from './crypto-adapter.js'
|
||||||
|
export type { BatcherOptions } from './rpc-batcher.js'
|
||||||
|
|
||||||
|
export interface OfferRequest {
|
||||||
|
sdp: string
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ServiceRequest {
|
||||||
|
serviceFqn: string // Must include username: service:version@username
|
||||||
|
offers: OfferRequest[]
|
||||||
|
ttl?: number
|
||||||
|
signature: string
|
||||||
|
message: string
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ServiceOffer {
|
||||||
|
offerId: string
|
||||||
|
sdp: string
|
||||||
|
createdAt: number
|
||||||
|
expiresAt: number
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Service {
|
||||||
|
serviceId: string
|
||||||
|
offers: ServiceOffer[]
|
||||||
|
username: string
|
||||||
|
serviceFqn: string
|
||||||
|
createdAt: number
|
||||||
|
expiresAt: number
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IceCandidate {
|
||||||
|
candidate: RTCIceCandidateInit | null
|
||||||
|
createdAt: number
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* RPC request format
|
||||||
|
*/
|
||||||
|
interface RpcRequest {
|
||||||
|
method: string
|
||||||
|
message: string
|
||||||
|
signature: string
|
||||||
|
publicKey?: string
|
||||||
|
params?: any
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* RPC response format
|
||||||
|
*/
|
||||||
|
interface RpcResponse {
|
||||||
|
success: boolean
|
||||||
|
result?: any
|
||||||
|
error?: string
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* RondevuAPI - RPC-based API client for Rondevu signaling server
|
||||||
|
*/
|
||||||
|
export class RondevuAPI {
|
||||||
|
private crypto: CryptoAdapter
|
||||||
|
private batcher: RpcBatcher | null = null
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
private baseUrl: string,
|
||||||
|
private username: string,
|
||||||
|
private keypair: Keypair,
|
||||||
|
cryptoAdapter?: CryptoAdapter,
|
||||||
|
batcherOptions?: BatcherOptions | false
|
||||||
|
) {
|
||||||
|
// Use WebCryptoAdapter by default (browser environment)
|
||||||
|
this.crypto = cryptoAdapter || new WebCryptoAdapter()
|
||||||
|
|
||||||
|
// Create batcher if not explicitly disabled
|
||||||
|
if (batcherOptions !== false) {
|
||||||
|
this.batcher = new RpcBatcher(
|
||||||
|
(requests) => this.rpcBatchDirect(requests),
|
||||||
|
batcherOptions
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generate authentication parameters for RPC calls
|
||||||
|
*/
|
||||||
|
private async generateAuth(method: string, params: string = ''): Promise<{
|
||||||
|
message: string
|
||||||
|
signature: string
|
||||||
|
}> {
|
||||||
|
const timestamp = Date.now()
|
||||||
|
const message = params
|
||||||
|
? `${method}:${this.username}:${params}:${timestamp}`
|
||||||
|
: `${method}:${this.username}:${timestamp}`
|
||||||
|
|
||||||
|
const signature = await this.crypto.signMessage(message, this.keypair.privateKey)
|
||||||
|
|
||||||
|
return { message, signature }
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Execute RPC call with optional batching
|
||||||
|
*/
|
||||||
|
private async rpc(request: RpcRequest): Promise<any> {
|
||||||
|
// Use batcher if enabled
|
||||||
|
if (this.batcher) {
|
||||||
|
return await this.batcher.add(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Direct call without batching
|
||||||
|
return await this.rpcDirect(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Execute single RPC call directly (bypasses batcher)
|
||||||
|
*/
|
||||||
|
private async rpcDirect(request: RpcRequest): Promise<any> {
|
||||||
|
const response = await fetch(`${this.baseUrl}/rpc`, {
|
||||||
|
method: 'POST',
|
||||||
|
headers: { 'Content-Type': 'application/json' },
|
||||||
|
body: JSON.stringify(request),
|
||||||
|
})
|
||||||
|
|
||||||
|
if (!response.ok) {
|
||||||
|
throw new Error(`HTTP ${response.status}: ${response.statusText}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
const result: RpcResponse = await response.json()
|
||||||
|
|
||||||
|
if (!result.success) {
|
||||||
|
throw new Error(result.error || 'RPC call failed')
|
||||||
|
}
|
||||||
|
|
||||||
|
return result.result
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Execute batch RPC calls directly (bypasses batcher)
|
||||||
|
*/
|
||||||
|
private async rpcBatchDirect(requests: RpcRequest[]): Promise<any[]> {
|
||||||
|
const response = await fetch(`${this.baseUrl}/rpc`, {
|
||||||
|
method: 'POST',
|
||||||
|
headers: { 'Content-Type': 'application/json' },
|
||||||
|
body: JSON.stringify(requests),
|
||||||
|
})
|
||||||
|
|
||||||
|
if (!response.ok) {
|
||||||
|
throw new Error(`HTTP ${response.status}: ${response.statusText}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
const results: RpcResponse[] = await response.json()
|
||||||
|
|
||||||
|
// Validate response is an array
|
||||||
|
if (!Array.isArray(results)) {
|
||||||
|
console.error('Invalid RPC batch response:', results)
|
||||||
|
throw new Error('Server returned invalid batch response (not an array)')
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check response length matches request length
|
||||||
|
if (results.length !== requests.length) {
|
||||||
|
console.error(`Response length mismatch: expected ${requests.length}, got ${results.length}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
return results.map((result, i) => {
|
||||||
|
if (!result || typeof result !== 'object') {
|
||||||
|
throw new Error(`Invalid response at index ${i}`)
|
||||||
|
}
|
||||||
|
if (!result.success) {
|
||||||
|
throw new Error(result.error || `RPC call ${i} failed`)
|
||||||
|
}
|
||||||
|
return result.result
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// ============================================
|
||||||
|
// Ed25519 Cryptography Helpers
|
||||||
|
// ============================================
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generate an Ed25519 keypair for username claiming and service publishing
|
||||||
|
* @param cryptoAdapter - Optional crypto adapter (defaults to WebCryptoAdapter)
|
||||||
|
*/
|
||||||
|
static async generateKeypair(cryptoAdapter?: CryptoAdapter): Promise<Keypair> {
|
||||||
|
const adapter = cryptoAdapter || new WebCryptoAdapter()
|
||||||
|
return await adapter.generateKeypair()
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sign a message with an Ed25519 private key
|
||||||
|
* @param cryptoAdapter - Optional crypto adapter (defaults to WebCryptoAdapter)
|
||||||
|
*/
|
||||||
|
static async signMessage(
|
||||||
|
message: string,
|
||||||
|
privateKeyBase64: string,
|
||||||
|
cryptoAdapter?: CryptoAdapter
|
||||||
|
): Promise<string> {
|
||||||
|
const adapter = cryptoAdapter || new WebCryptoAdapter()
|
||||||
|
return await adapter.signMessage(message, privateKeyBase64)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Verify an Ed25519 signature
|
||||||
|
* @param cryptoAdapter - Optional crypto adapter (defaults to WebCryptoAdapter)
|
||||||
|
*/
|
||||||
|
static async verifySignature(
|
||||||
|
message: string,
|
||||||
|
signatureBase64: string,
|
||||||
|
publicKeyBase64: string,
|
||||||
|
cryptoAdapter?: CryptoAdapter
|
||||||
|
): Promise<boolean> {
|
||||||
|
const adapter = cryptoAdapter || new WebCryptoAdapter()
|
||||||
|
return await adapter.verifySignature(message, signatureBase64, publicKeyBase64)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ============================================
|
||||||
|
// Username Management
|
||||||
|
// ============================================
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if a username is available
|
||||||
|
*/
|
||||||
|
async isUsernameAvailable(username: string): Promise<boolean> {
|
||||||
|
const auth = await this.generateAuth('getUser', username)
|
||||||
|
const result = await this.rpc({
|
||||||
|
method: 'getUser',
|
||||||
|
message: auth.message,
|
||||||
|
signature: auth.signature,
|
||||||
|
params: { username },
|
||||||
|
})
|
||||||
|
return result.available
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if current username is claimed
|
||||||
|
*/
|
||||||
|
async isUsernameClaimed(): Promise<boolean> {
|
||||||
|
const auth = await this.generateAuth('getUser', this.username)
|
||||||
|
const result = await this.rpc({
|
||||||
|
method: 'getUser',
|
||||||
|
message: auth.message,
|
||||||
|
signature: auth.signature,
|
||||||
|
params: { username: this.username },
|
||||||
|
})
|
||||||
|
return !result.available
|
||||||
|
}
|
||||||
|
|
||||||
|
// ============================================
|
||||||
|
// Service Management
|
||||||
|
// ============================================
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Publish a service
|
||||||
|
*/
|
||||||
|
async publishService(service: ServiceRequest): Promise<Service> {
|
||||||
|
const auth = await this.generateAuth('publishService', service.serviceFqn)
|
||||||
|
return await this.rpc({
|
||||||
|
method: 'publishService',
|
||||||
|
message: auth.message,
|
||||||
|
signature: auth.signature,
|
||||||
|
publicKey: this.keypair.publicKey,
|
||||||
|
params: {
|
||||||
|
serviceFqn: service.serviceFqn,
|
||||||
|
offers: service.offers,
|
||||||
|
ttl: service.ttl,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get service by FQN (direct lookup, random, or paginated)
|
||||||
|
*/
|
||||||
|
async getService(
|
||||||
|
serviceFqn: string,
|
||||||
|
options?: { limit?: number; offset?: number }
|
||||||
|
): Promise<any> {
|
||||||
|
const auth = await this.generateAuth('getService', serviceFqn)
|
||||||
|
return await this.rpc({
|
||||||
|
method: 'getService',
|
||||||
|
message: auth.message,
|
||||||
|
signature: auth.signature,
|
||||||
|
publicKey: this.keypair.publicKey,
|
||||||
|
params: {
|
||||||
|
serviceFqn,
|
||||||
|
...options,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Delete a service
|
||||||
|
*/
|
||||||
|
async deleteService(serviceFqn: string): Promise<void> {
|
||||||
|
const auth = await this.generateAuth('deleteService', serviceFqn)
|
||||||
|
await this.rpc({
|
||||||
|
method: 'deleteService',
|
||||||
|
message: auth.message,
|
||||||
|
signature: auth.signature,
|
||||||
|
publicKey: this.keypair.publicKey,
|
||||||
|
params: { serviceFqn },
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// ============================================
|
||||||
|
// WebRTC Signaling
|
||||||
|
// ============================================
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Answer an offer
|
||||||
|
*/
|
||||||
|
async answerOffer(serviceFqn: string, offerId: string, sdp: string): Promise<void> {
|
||||||
|
const auth = await this.generateAuth('answerOffer', offerId)
|
||||||
|
await this.rpc({
|
||||||
|
method: 'answerOffer',
|
||||||
|
message: auth.message,
|
||||||
|
signature: auth.signature,
|
||||||
|
publicKey: this.keypair.publicKey,
|
||||||
|
params: { serviceFqn, offerId, sdp },
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get answer for a specific offer (offerer polls this)
|
||||||
|
*/
|
||||||
|
async getOfferAnswer(
|
||||||
|
serviceFqn: string,
|
||||||
|
offerId: string
|
||||||
|
): Promise<{ sdp: string; offerId: string; answererId: string; answeredAt: number } | null> {
|
||||||
|
try {
|
||||||
|
const auth = await this.generateAuth('getOfferAnswer', offerId)
|
||||||
|
return await this.rpc({
|
||||||
|
method: 'getOfferAnswer',
|
||||||
|
message: auth.message,
|
||||||
|
signature: auth.signature,
|
||||||
|
publicKey: this.keypair.publicKey,
|
||||||
|
params: { serviceFqn, offerId },
|
||||||
|
})
|
||||||
|
} catch (err) {
|
||||||
|
if ((err as Error).message.includes('not yet answered')) {
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Combined polling for answers and ICE candidates
|
||||||
|
*/
|
||||||
|
async poll(since?: number): Promise<{
|
||||||
|
answers: Array<{
|
||||||
|
offerId: string
|
||||||
|
serviceId?: string
|
||||||
|
answererId: string
|
||||||
|
sdp: string
|
||||||
|
answeredAt: number
|
||||||
|
}>
|
||||||
|
iceCandidates: Record<
|
||||||
|
string,
|
||||||
|
Array<{
|
||||||
|
candidate: RTCIceCandidateInit | null
|
||||||
|
role: 'offerer' | 'answerer'
|
||||||
|
peerId: string
|
||||||
|
createdAt: number
|
||||||
|
}>
|
||||||
|
>
|
||||||
|
}> {
|
||||||
|
const auth = await this.generateAuth('poll')
|
||||||
|
return await this.rpc({
|
||||||
|
method: 'poll',
|
||||||
|
message: auth.message,
|
||||||
|
signature: auth.signature,
|
||||||
|
publicKey: this.keypair.publicKey,
|
||||||
|
params: { since },
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add ICE candidates to a specific offer
|
||||||
|
*/
|
||||||
|
async addOfferIceCandidates(
|
||||||
|
serviceFqn: string,
|
||||||
|
offerId: string,
|
||||||
|
candidates: RTCIceCandidateInit[]
|
||||||
|
): Promise<{ count: number; offerId: string }> {
|
||||||
|
const auth = await this.generateAuth('addIceCandidates', offerId)
|
||||||
|
return await this.rpc({
|
||||||
|
method: 'addIceCandidates',
|
||||||
|
message: auth.message,
|
||||||
|
signature: auth.signature,
|
||||||
|
publicKey: this.keypair.publicKey,
|
||||||
|
params: { serviceFqn, offerId, candidates },
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get ICE candidates for a specific offer
|
||||||
|
*/
|
||||||
|
async getOfferIceCandidates(
|
||||||
|
serviceFqn: string,
|
||||||
|
offerId: string,
|
||||||
|
since: number = 0
|
||||||
|
): Promise<{ candidates: IceCandidate[]; offerId: string }> {
|
||||||
|
const auth = await this.generateAuth('getIceCandidates', `${offerId}:${since}`)
|
||||||
|
const result = await this.rpc({
|
||||||
|
method: 'getIceCandidates',
|
||||||
|
message: auth.message,
|
||||||
|
signature: auth.signature,
|
||||||
|
publicKey: this.keypair.publicKey,
|
||||||
|
params: { serviceFqn, offerId, since },
|
||||||
|
})
|
||||||
|
|
||||||
|
return {
|
||||||
|
candidates: result.candidates || [],
|
||||||
|
offerId: result.offerId,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
223
src/client.ts
223
src/client.ts
@@ -1,223 +0,0 @@
|
|||||||
import {
|
|
||||||
RondevuClientOptions,
|
|
||||||
ListTopicsResponse,
|
|
||||||
ListSessionsResponse,
|
|
||||||
CreateOfferRequest,
|
|
||||||
CreateOfferResponse,
|
|
||||||
AnswerRequest,
|
|
||||||
AnswerResponse,
|
|
||||||
PollRequest,
|
|
||||||
PollOffererResponse,
|
|
||||||
PollAnswererResponse,
|
|
||||||
HealthResponse,
|
|
||||||
ErrorResponse,
|
|
||||||
Side,
|
|
||||||
} from './types';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* HTTP client for Rondevu peer signaling and discovery server
|
|
||||||
*/
|
|
||||||
export class RondevuClient {
|
|
||||||
private readonly baseUrl: string;
|
|
||||||
private readonly origin: string;
|
|
||||||
private readonly fetchImpl: typeof fetch;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Creates a new Rondevu client instance
|
|
||||||
* @param options - Client configuration options
|
|
||||||
*/
|
|
||||||
constructor(options: RondevuClientOptions) {
|
|
||||||
this.baseUrl = options.baseUrl.replace(/\/$/, ''); // Remove trailing slash
|
|
||||||
this.origin = options.origin || new URL(this.baseUrl).origin;
|
|
||||||
this.fetchImpl = options.fetch || globalThis.fetch.bind(globalThis);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Makes an HTTP request to the Rondevu server
|
|
||||||
*/
|
|
||||||
private async request<T>(
|
|
||||||
endpoint: string,
|
|
||||||
options: RequestInit = {}
|
|
||||||
): Promise<T> {
|
|
||||||
const url = `${this.baseUrl}${endpoint}`;
|
|
||||||
|
|
||||||
const headers: Record<string, string> = {
|
|
||||||
'Origin': this.origin,
|
|
||||||
...(options.headers as Record<string, string>),
|
|
||||||
};
|
|
||||||
|
|
||||||
if (options.body) {
|
|
||||||
headers['Content-Type'] = 'application/json';
|
|
||||||
}
|
|
||||||
|
|
||||||
const response = await this.fetchImpl(url, {
|
|
||||||
...options,
|
|
||||||
headers,
|
|
||||||
});
|
|
||||||
|
|
||||||
const data = await response.json();
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
const error = data as ErrorResponse;
|
|
||||||
throw new Error(error.error || `HTTP ${response.status}: ${response.statusText}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
return data as T;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Lists all topics with peer counts
|
|
||||||
*
|
|
||||||
* @param page - Page number (starting from 1)
|
|
||||||
* @param limit - Results per page (max 1000)
|
|
||||||
* @returns List of topics with pagination info
|
|
||||||
*
|
|
||||||
* @example
|
|
||||||
* ```typescript
|
|
||||||
* const client = new RondevuClient({ baseUrl: 'https://example.com' });
|
|
||||||
* const { topics, pagination } = await client.listTopics();
|
|
||||||
* console.log(`Found ${topics.length} topics`);
|
|
||||||
* ```
|
|
||||||
*/
|
|
||||||
async listTopics(page = 1, limit = 100): Promise<ListTopicsResponse> {
|
|
||||||
const params = new URLSearchParams({
|
|
||||||
page: page.toString(),
|
|
||||||
limit: limit.toString(),
|
|
||||||
});
|
|
||||||
return this.request<ListTopicsResponse>(`/?${params}`, {
|
|
||||||
method: 'GET',
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Discovers available peers for a given topic
|
|
||||||
*
|
|
||||||
* @param topic - Topic identifier
|
|
||||||
* @returns List of available sessions
|
|
||||||
*
|
|
||||||
* @example
|
|
||||||
* ```typescript
|
|
||||||
* const client = new RondevuClient({ baseUrl: 'https://example.com' });
|
|
||||||
* const { sessions } = await client.listSessions('my-room');
|
|
||||||
* const otherPeers = sessions.filter(s => s.peerId !== myPeerId);
|
|
||||||
* ```
|
|
||||||
*/
|
|
||||||
async listSessions(topic: string): Promise<ListSessionsResponse> {
|
|
||||||
return this.request<ListSessionsResponse>(`/${encodeURIComponent(topic)}/sessions`, {
|
|
||||||
method: 'GET',
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Announces peer availability and creates a new session
|
|
||||||
*
|
|
||||||
* @param topic - Topic identifier for grouping peers (max 1024 characters)
|
|
||||||
* @param request - Offer details including peer ID and signaling data
|
|
||||||
* @returns Unique session code (UUID)
|
|
||||||
*
|
|
||||||
* @example
|
|
||||||
* ```typescript
|
|
||||||
* const client = new RondevuClient({ baseUrl: 'https://example.com' });
|
|
||||||
* const { code } = await client.createOffer('my-room', {
|
|
||||||
* peerId: 'peer-123',
|
|
||||||
* offer: signalingData
|
|
||||||
* });
|
|
||||||
* console.log('Session code:', code);
|
|
||||||
* ```
|
|
||||||
*/
|
|
||||||
async createOffer(
|
|
||||||
topic: string,
|
|
||||||
request: CreateOfferRequest
|
|
||||||
): Promise<CreateOfferResponse> {
|
|
||||||
return this.request<CreateOfferResponse>(
|
|
||||||
`/${encodeURIComponent(topic)}/offer`,
|
|
||||||
{
|
|
||||||
method: 'POST',
|
|
||||||
body: JSON.stringify(request),
|
|
||||||
}
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Sends an answer or candidate to an existing session
|
|
||||||
*
|
|
||||||
* @param request - Answer details including session code and signaling data
|
|
||||||
* @returns Success confirmation
|
|
||||||
*
|
|
||||||
* @example
|
|
||||||
* ```typescript
|
|
||||||
* const client = new RondevuClient({ baseUrl: 'https://example.com' });
|
|
||||||
*
|
|
||||||
* // Send answer
|
|
||||||
* await client.sendAnswer({
|
|
||||||
* code: sessionCode,
|
|
||||||
* answer: answerData,
|
|
||||||
* side: 'answerer'
|
|
||||||
* });
|
|
||||||
*
|
|
||||||
* // Send candidate
|
|
||||||
* await client.sendAnswer({
|
|
||||||
* code: sessionCode,
|
|
||||||
* candidate: candidateData,
|
|
||||||
* side: 'offerer'
|
|
||||||
* });
|
|
||||||
* ```
|
|
||||||
*/
|
|
||||||
async sendAnswer(request: AnswerRequest): Promise<AnswerResponse> {
|
|
||||||
return this.request<AnswerResponse>('/answer', {
|
|
||||||
method: 'POST',
|
|
||||||
body: JSON.stringify(request),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Polls for session data from the other peer
|
|
||||||
*
|
|
||||||
* @param code - Session UUID
|
|
||||||
* @param side - Which side is polling ('offerer' or 'answerer')
|
|
||||||
* @returns Session data including offers, answers, and candidates
|
|
||||||
*
|
|
||||||
* @example
|
|
||||||
* ```typescript
|
|
||||||
* const client = new RondevuClient({ baseUrl: 'https://example.com' });
|
|
||||||
*
|
|
||||||
* // Offerer polls for answer
|
|
||||||
* const offererData = await client.poll(sessionCode, 'offerer');
|
|
||||||
* if (offererData.answer) {
|
|
||||||
* console.log('Received answer:', offererData.answer);
|
|
||||||
* }
|
|
||||||
*
|
|
||||||
* // Answerer polls for offer
|
|
||||||
* const answererData = await client.poll(sessionCode, 'answerer');
|
|
||||||
* console.log('Received offer:', answererData.offer);
|
|
||||||
* ```
|
|
||||||
*/
|
|
||||||
async poll(
|
|
||||||
code: string,
|
|
||||||
side: Side
|
|
||||||
): Promise<PollOffererResponse | PollAnswererResponse> {
|
|
||||||
const request: PollRequest = { code, side };
|
|
||||||
return this.request<PollOffererResponse | PollAnswererResponse>('/poll', {
|
|
||||||
method: 'POST',
|
|
||||||
body: JSON.stringify(request),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Checks server health
|
|
||||||
*
|
|
||||||
* @returns Health status and timestamp
|
|
||||||
*
|
|
||||||
* @example
|
|
||||||
* ```typescript
|
|
||||||
* const client = new RondevuClient({ baseUrl: 'https://example.com' });
|
|
||||||
* const health = await client.health();
|
|
||||||
* console.log('Server status:', health.status);
|
|
||||||
* ```
|
|
||||||
*/
|
|
||||||
async health(): Promise<HealthResponse> {
|
|
||||||
return this.request<HealthResponse>('/health', {
|
|
||||||
method: 'GET',
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,310 +0,0 @@
|
|||||||
import { EventEmitter } from './event-emitter';
|
|
||||||
import { RondevuClient } from './client';
|
|
||||||
import { RondevuConnectionParams } from './types';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Represents a WebRTC connection with automatic signaling and ICE exchange
|
|
||||||
*/
|
|
||||||
export class RondevuConnection extends EventEmitter {
|
|
||||||
readonly id: string;
|
|
||||||
readonly topic: string;
|
|
||||||
readonly role: 'offerer' | 'answerer';
|
|
||||||
readonly remotePeerId: string;
|
|
||||||
|
|
||||||
private pc: RTCPeerConnection;
|
|
||||||
private client: RondevuClient;
|
|
||||||
private localPeerId: string;
|
|
||||||
private dataChannels: Map<string, RTCDataChannel>;
|
|
||||||
private pollingInterval?: ReturnType<typeof setInterval>;
|
|
||||||
private pollingIntervalMs: number;
|
|
||||||
private connectionTimeoutMs: number;
|
|
||||||
private connectionTimer?: ReturnType<typeof setTimeout>;
|
|
||||||
private isPolling: boolean = false;
|
|
||||||
private isClosed: boolean = false;
|
|
||||||
|
|
||||||
constructor(params: RondevuConnectionParams, client: RondevuClient) {
|
|
||||||
super();
|
|
||||||
this.id = params.id;
|
|
||||||
this.topic = params.topic;
|
|
||||||
this.role = params.role;
|
|
||||||
this.pc = params.pc;
|
|
||||||
this.localPeerId = params.localPeerId;
|
|
||||||
this.remotePeerId = params.remotePeerId;
|
|
||||||
this.client = client;
|
|
||||||
this.dataChannels = new Map();
|
|
||||||
this.pollingIntervalMs = params.pollingInterval;
|
|
||||||
this.connectionTimeoutMs = params.connectionTimeout;
|
|
||||||
|
|
||||||
this.setupEventHandlers();
|
|
||||||
this.startConnectionTimeout();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Setup RTCPeerConnection event handlers
|
|
||||||
*/
|
|
||||||
private setupEventHandlers(): void {
|
|
||||||
// ICE candidate gathering
|
|
||||||
this.pc.onicecandidate = (event) => {
|
|
||||||
if (event.candidate && !this.isClosed) {
|
|
||||||
this.sendIceCandidate(event.candidate).catch((err) => {
|
|
||||||
this.emit('error', new Error(`Failed to send ICE candidate: ${err.message}`));
|
|
||||||
});
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
// Connection state changes
|
|
||||||
this.pc.onconnectionstatechange = () => {
|
|
||||||
this.handleConnectionStateChange();
|
|
||||||
};
|
|
||||||
|
|
||||||
// Remote data channels
|
|
||||||
this.pc.ondatachannel = (event) => {
|
|
||||||
this.handleRemoteDataChannel(event.channel);
|
|
||||||
};
|
|
||||||
|
|
||||||
// Remote media streams
|
|
||||||
this.pc.ontrack = (event) => {
|
|
||||||
if (event.streams && event.streams[0]) {
|
|
||||||
this.emit('stream', event.streams[0]);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
// ICE connection state changes
|
|
||||||
this.pc.oniceconnectionstatechange = () => {
|
|
||||||
const state = this.pc.iceConnectionState;
|
|
||||||
|
|
||||||
if (state === 'failed' || state === 'closed') {
|
|
||||||
this.emit('error', new Error(`ICE connection ${state}`));
|
|
||||||
if (state === 'failed') {
|
|
||||||
this.close();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Handle RTCPeerConnection state changes
|
|
||||||
*/
|
|
||||||
private handleConnectionStateChange(): void {
|
|
||||||
const state = this.pc.connectionState;
|
|
||||||
|
|
||||||
switch (state) {
|
|
||||||
case 'connected':
|
|
||||||
this.clearConnectionTimeout();
|
|
||||||
this.stopPolling();
|
|
||||||
this.emit('connect');
|
|
||||||
break;
|
|
||||||
|
|
||||||
case 'disconnected':
|
|
||||||
this.emit('disconnect');
|
|
||||||
break;
|
|
||||||
|
|
||||||
case 'failed':
|
|
||||||
this.emit('error', new Error('Connection failed'));
|
|
||||||
this.close();
|
|
||||||
break;
|
|
||||||
|
|
||||||
case 'closed':
|
|
||||||
this.emit('disconnect');
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Send an ICE candidate to the remote peer via signaling server
|
|
||||||
*/
|
|
||||||
private async sendIceCandidate(candidate: RTCIceCandidate): Promise<void> {
|
|
||||||
try {
|
|
||||||
await this.client.sendAnswer({
|
|
||||||
code: this.id,
|
|
||||||
candidate: JSON.stringify(candidate.toJSON()),
|
|
||||||
side: this.role,
|
|
||||||
});
|
|
||||||
} catch (err: any) {
|
|
||||||
throw new Error(`Failed to send ICE candidate: ${err.message}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Start polling for remote session data (answer/candidates)
|
|
||||||
*/
|
|
||||||
startPolling(): void {
|
|
||||||
if (this.isPolling || this.isClosed) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
this.isPolling = true;
|
|
||||||
|
|
||||||
// Poll immediately
|
|
||||||
this.poll().catch((err) => {
|
|
||||||
this.emit('error', new Error(`Poll error: ${err.message}`));
|
|
||||||
});
|
|
||||||
|
|
||||||
// Set up interval polling
|
|
||||||
this.pollingInterval = setInterval(() => {
|
|
||||||
this.poll().catch((err) => {
|
|
||||||
this.emit('error', new Error(`Poll error: ${err.message}`));
|
|
||||||
});
|
|
||||||
}, this.pollingIntervalMs);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Stop polling
|
|
||||||
*/
|
|
||||||
private stopPolling(): void {
|
|
||||||
this.isPolling = false;
|
|
||||||
if (this.pollingInterval) {
|
|
||||||
clearInterval(this.pollingInterval);
|
|
||||||
this.pollingInterval = undefined;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Poll the signaling server for remote data
|
|
||||||
*/
|
|
||||||
private async poll(): Promise<void> {
|
|
||||||
if (this.isClosed) {
|
|
||||||
this.stopPolling();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
const response = await this.client.poll(this.id, this.role);
|
|
||||||
|
|
||||||
if (this.role === 'offerer') {
|
|
||||||
const offererResponse = response as { answer: string | null; answerCandidates: string[] };
|
|
||||||
|
|
||||||
// Apply answer if received and not yet applied
|
|
||||||
if (offererResponse.answer && !this.pc.currentRemoteDescription) {
|
|
||||||
await this.pc.setRemoteDescription({
|
|
||||||
type: 'answer',
|
|
||||||
sdp: offererResponse.answer,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// Apply ICE candidates
|
|
||||||
if (offererResponse.answerCandidates && offererResponse.answerCandidates.length > 0) {
|
|
||||||
for (const candidateStr of offererResponse.answerCandidates) {
|
|
||||||
try {
|
|
||||||
const candidate = JSON.parse(candidateStr);
|
|
||||||
await this.pc.addIceCandidate(new RTCIceCandidate(candidate));
|
|
||||||
} catch (err) {
|
|
||||||
console.warn('Failed to add ICE candidate:', err);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
// Answerer role
|
|
||||||
const answererResponse = response as { offer: string; offerCandidates: string[] };
|
|
||||||
|
|
||||||
// Apply ICE candidates from offerer
|
|
||||||
if (answererResponse.offerCandidates && answererResponse.offerCandidates.length > 0) {
|
|
||||||
for (const candidateStr of answererResponse.offerCandidates) {
|
|
||||||
try {
|
|
||||||
const candidate = JSON.parse(candidateStr);
|
|
||||||
await this.pc.addIceCandidate(new RTCIceCandidate(candidate));
|
|
||||||
} catch (err) {
|
|
||||||
console.warn('Failed to add ICE candidate:', err);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} catch (err: any) {
|
|
||||||
// Session not found or expired
|
|
||||||
if (err.message.includes('404') || err.message.includes('not found')) {
|
|
||||||
this.emit('error', new Error('Session not found or expired'));
|
|
||||||
this.close();
|
|
||||||
}
|
|
||||||
throw err;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Handle remotely created data channel
|
|
||||||
*/
|
|
||||||
private handleRemoteDataChannel(channel: RTCDataChannel): void {
|
|
||||||
this.dataChannels.set(channel.label, channel);
|
|
||||||
this.emit('datachannel', channel);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get or create a data channel
|
|
||||||
*/
|
|
||||||
dataChannel(label: string, options?: RTCDataChannelInit): RTCDataChannel {
|
|
||||||
let channel = this.dataChannels.get(label);
|
|
||||||
|
|
||||||
if (!channel) {
|
|
||||||
channel = this.pc.createDataChannel(label, options);
|
|
||||||
this.dataChannels.set(label, channel);
|
|
||||||
}
|
|
||||||
|
|
||||||
return channel;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Add a local media stream to the connection
|
|
||||||
*/
|
|
||||||
addStream(stream: MediaStream): void {
|
|
||||||
stream.getTracks().forEach(track => {
|
|
||||||
this.pc.addTrack(track, stream);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the underlying RTCPeerConnection for advanced usage
|
|
||||||
*/
|
|
||||||
getPeerConnection(): RTCPeerConnection {
|
|
||||||
return this.pc;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Start connection timeout
|
|
||||||
*/
|
|
||||||
private startConnectionTimeout(): void {
|
|
||||||
this.connectionTimer = setTimeout(() => {
|
|
||||||
if (this.pc.connectionState !== 'connected') {
|
|
||||||
this.emit('error', new Error('Connection timeout'));
|
|
||||||
this.close();
|
|
||||||
}
|
|
||||||
}, this.connectionTimeoutMs);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Clear connection timeout
|
|
||||||
*/
|
|
||||||
private clearConnectionTimeout(): void {
|
|
||||||
if (this.connectionTimer) {
|
|
||||||
clearTimeout(this.connectionTimer);
|
|
||||||
this.connectionTimer = undefined;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Close the connection and cleanup resources
|
|
||||||
*/
|
|
||||||
close(): void {
|
|
||||||
if (this.isClosed) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
this.isClosed = true;
|
|
||||||
|
|
||||||
this.stopPolling();
|
|
||||||
this.clearConnectionTimeout();
|
|
||||||
|
|
||||||
// Close all data channels
|
|
||||||
this.dataChannels.forEach(dc => {
|
|
||||||
if (dc.readyState === 'open' || dc.readyState === 'connecting') {
|
|
||||||
dc.close();
|
|
||||||
}
|
|
||||||
});
|
|
||||||
this.dataChannels.clear();
|
|
||||||
|
|
||||||
// Close peer connection
|
|
||||||
if (this.pc.connectionState !== 'closed') {
|
|
||||||
this.pc.close();
|
|
||||||
}
|
|
||||||
|
|
||||||
this.emit('disconnect');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
48
src/crypto-adapter.ts
Normal file
48
src/crypto-adapter.ts
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
/**
|
||||||
|
* Crypto adapter interface for platform-independent cryptographic operations
|
||||||
|
*/
|
||||||
|
|
||||||
|
export interface Keypair {
|
||||||
|
publicKey: string
|
||||||
|
privateKey: string
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Platform-independent crypto adapter interface
|
||||||
|
* Implementations provide platform-specific crypto operations
|
||||||
|
*/
|
||||||
|
export interface CryptoAdapter {
|
||||||
|
/**
|
||||||
|
* Generate an Ed25519 keypair
|
||||||
|
*/
|
||||||
|
generateKeypair(): Promise<Keypair>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sign a message with an Ed25519 private key
|
||||||
|
*/
|
||||||
|
signMessage(message: string, privateKeyBase64: string): Promise<string>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Verify an Ed25519 signature
|
||||||
|
*/
|
||||||
|
verifySignature(
|
||||||
|
message: string,
|
||||||
|
signatureBase64: string,
|
||||||
|
publicKeyBase64: string
|
||||||
|
): Promise<boolean>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Convert Uint8Array to base64 string
|
||||||
|
*/
|
||||||
|
bytesToBase64(bytes: Uint8Array): string
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Convert base64 string to Uint8Array
|
||||||
|
*/
|
||||||
|
base64ToBytes(base64: string): Uint8Array
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generate random bytes
|
||||||
|
*/
|
||||||
|
randomBytes(length: number): Uint8Array
|
||||||
|
}
|
||||||
@@ -1,86 +0,0 @@
|
|||||||
/**
|
|
||||||
* Simple EventEmitter implementation for browser and Node.js compatibility
|
|
||||||
*/
|
|
||||||
export class EventEmitter {
|
|
||||||
private events: Map<string, Set<Function>>;
|
|
||||||
|
|
||||||
constructor() {
|
|
||||||
this.events = new Map();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Register an event listener
|
|
||||||
*/
|
|
||||||
on(event: string, listener: Function): this {
|
|
||||||
if (!this.events.has(event)) {
|
|
||||||
this.events.set(event, new Set());
|
|
||||||
}
|
|
||||||
this.events.get(event)!.add(listener);
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Register a one-time event listener
|
|
||||||
*/
|
|
||||||
once(event: string, listener: Function): this {
|
|
||||||
const onceWrapper = (...args: any[]) => {
|
|
||||||
this.off(event, onceWrapper);
|
|
||||||
listener.apply(this, args);
|
|
||||||
};
|
|
||||||
return this.on(event, onceWrapper);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Remove an event listener
|
|
||||||
*/
|
|
||||||
off(event: string, listener: Function): this {
|
|
||||||
const listeners = this.events.get(event);
|
|
||||||
if (listeners) {
|
|
||||||
listeners.delete(listener);
|
|
||||||
if (listeners.size === 0) {
|
|
||||||
this.events.delete(event);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Emit an event
|
|
||||||
*/
|
|
||||||
emit(event: string, ...args: any[]): boolean {
|
|
||||||
const listeners = this.events.get(event);
|
|
||||||
if (!listeners || listeners.size === 0) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
listeners.forEach(listener => {
|
|
||||||
try {
|
|
||||||
listener.apply(this, args);
|
|
||||||
} catch (err) {
|
|
||||||
console.error(`Error in ${event} event listener:`, err);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Remove all listeners for an event (or all events if not specified)
|
|
||||||
*/
|
|
||||||
removeAllListeners(event?: string): this {
|
|
||||||
if (event) {
|
|
||||||
this.events.delete(event);
|
|
||||||
} else {
|
|
||||||
this.events.clear();
|
|
||||||
}
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get listener count for an event
|
|
||||||
*/
|
|
||||||
listenerCount(event: string): number {
|
|
||||||
const listeners = this.events.get(event);
|
|
||||||
return listeners ? listeners.size : 0;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
66
src/index.ts
66
src/index.ts
@@ -1,41 +1,39 @@
|
|||||||
/**
|
/**
|
||||||
* @xtr-dev/rondevu-client
|
* @xtr-dev/rondevu-client
|
||||||
* WebRTC peer signaling and discovery client
|
* WebRTC peer signaling client
|
||||||
*/
|
*/
|
||||||
|
|
||||||
// Export main WebRTC client class
|
export { Rondevu } from './rondevu.js'
|
||||||
export { Rondevu } from './rondevu';
|
export { RondevuAPI } from './api.js'
|
||||||
|
export { RpcBatcher } from './rpc-batcher.js'
|
||||||
|
|
||||||
// Export connection class
|
// Export crypto adapters
|
||||||
export { RondevuConnection } from './connection';
|
export { WebCryptoAdapter } from './web-crypto-adapter.js'
|
||||||
|
export { NodeCryptoAdapter } from './node-crypto-adapter.js'
|
||||||
|
|
||||||
// Export low-level signaling client (for advanced usage)
|
// Export types
|
||||||
export { RondevuClient } from './client';
|
|
||||||
|
|
||||||
// Export all types
|
|
||||||
export type {
|
export type {
|
||||||
// WebRTC types
|
Signaler,
|
||||||
RondevuOptions,
|
Binnable,
|
||||||
JoinOptions,
|
} from './types.js'
|
||||||
ConnectionRole,
|
|
||||||
RondevuConnectionParams,
|
export type {
|
||||||
RondevuConnectionEvents,
|
Keypair,
|
||||||
// Signaling types
|
OfferRequest,
|
||||||
Side,
|
ServiceRequest,
|
||||||
Session,
|
Service,
|
||||||
TopicInfo,
|
ServiceOffer,
|
||||||
Pagination,
|
IceCandidate,
|
||||||
ListTopicsResponse,
|
} from './api.js'
|
||||||
ListSessionsResponse,
|
|
||||||
CreateOfferRequest,
|
export type {
|
||||||
CreateOfferResponse,
|
RondevuOptions,
|
||||||
AnswerRequest,
|
PublishServiceOptions,
|
||||||
AnswerResponse,
|
ConnectToServiceOptions,
|
||||||
PollRequest,
|
ConnectionContext,
|
||||||
PollOffererResponse,
|
OfferContext,
|
||||||
PollAnswererResponse,
|
OfferFactory
|
||||||
PollResponse,
|
} from './rondevu.js'
|
||||||
HealthResponse,
|
|
||||||
ErrorResponse,
|
export type { CryptoAdapter } from './crypto-adapter.js'
|
||||||
RondevuClientOptions,
|
|
||||||
} from './types';
|
|
||||||
|
|||||||
98
src/node-crypto-adapter.ts
Normal file
98
src/node-crypto-adapter.ts
Normal file
@@ -0,0 +1,98 @@
|
|||||||
|
/**
|
||||||
|
* Node.js Crypto adapter for Node.js environments
|
||||||
|
* Requires Node.js 19+ or Node.js 18 with --experimental-global-webcrypto flag
|
||||||
|
*/
|
||||||
|
|
||||||
|
import * as ed25519 from '@noble/ed25519'
|
||||||
|
import { CryptoAdapter, Keypair } from './crypto-adapter.js'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Node.js Crypto implementation using Node.js built-in APIs
|
||||||
|
* Uses Buffer for base64 encoding and crypto.randomBytes for random generation
|
||||||
|
*
|
||||||
|
* Requirements:
|
||||||
|
* - Node.js 19+ (crypto.subtle available globally)
|
||||||
|
* - OR Node.js 18 with --experimental-global-webcrypto flag
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* ```typescript
|
||||||
|
* import { RondevuAPI } from '@xtr-dev/rondevu-client'
|
||||||
|
* import { NodeCryptoAdapter } from '@xtr-dev/rondevu-client/node'
|
||||||
|
*
|
||||||
|
* const api = new RondevuAPI(
|
||||||
|
* 'https://signal.example.com',
|
||||||
|
* 'alice',
|
||||||
|
* keypair,
|
||||||
|
* new NodeCryptoAdapter()
|
||||||
|
* )
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
export class NodeCryptoAdapter implements CryptoAdapter {
|
||||||
|
constructor() {
|
||||||
|
// Set SHA-512 hash function for ed25519 using Node's crypto.subtle
|
||||||
|
if (typeof crypto === 'undefined' || !crypto.subtle) {
|
||||||
|
throw new Error(
|
||||||
|
'crypto.subtle is not available. ' +
|
||||||
|
'Node.js 19+ is required, or Node.js 18 with --experimental-global-webcrypto flag'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
ed25519.hashes.sha512Async = async (message: Uint8Array) => {
|
||||||
|
const hash = await crypto.subtle.digest('SHA-512', message as BufferSource)
|
||||||
|
return new Uint8Array(hash)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async generateKeypair(): Promise<Keypair> {
|
||||||
|
const privateKey = ed25519.utils.randomSecretKey()
|
||||||
|
const publicKey = await ed25519.getPublicKeyAsync(privateKey)
|
||||||
|
|
||||||
|
return {
|
||||||
|
publicKey: this.bytesToBase64(publicKey),
|
||||||
|
privateKey: this.bytesToBase64(privateKey),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async signMessage(message: string, privateKeyBase64: string): Promise<string> {
|
||||||
|
const privateKey = this.base64ToBytes(privateKeyBase64)
|
||||||
|
const encoder = new TextEncoder()
|
||||||
|
const messageBytes = encoder.encode(message)
|
||||||
|
const signature = await ed25519.signAsync(messageBytes, privateKey)
|
||||||
|
|
||||||
|
return this.bytesToBase64(signature)
|
||||||
|
}
|
||||||
|
|
||||||
|
async verifySignature(
|
||||||
|
message: string,
|
||||||
|
signatureBase64: string,
|
||||||
|
publicKeyBase64: string
|
||||||
|
): Promise<boolean> {
|
||||||
|
try {
|
||||||
|
const signature = this.base64ToBytes(signatureBase64)
|
||||||
|
const publicKey = this.base64ToBytes(publicKeyBase64)
|
||||||
|
const encoder = new TextEncoder()
|
||||||
|
const messageBytes = encoder.encode(message)
|
||||||
|
|
||||||
|
return await ed25519.verifyAsync(signature, messageBytes, publicKey)
|
||||||
|
} catch {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
bytesToBase64(bytes: Uint8Array): string {
|
||||||
|
// Node.js Buffer provides native base64 encoding
|
||||||
|
// @ts-expect-error - Buffer is available in Node.js but not in browser TypeScript definitions
|
||||||
|
return Buffer.from(bytes).toString('base64')
|
||||||
|
}
|
||||||
|
|
||||||
|
base64ToBytes(base64: string): Uint8Array {
|
||||||
|
// Node.js Buffer provides native base64 decoding
|
||||||
|
// @ts-expect-error - Buffer is available in Node.js but not in browser TypeScript definitions
|
||||||
|
return new Uint8Array(Buffer.from(base64, 'base64'))
|
||||||
|
}
|
||||||
|
|
||||||
|
randomBytes(length: number): Uint8Array {
|
||||||
|
// Use Web Crypto API's getRandomValues (available in Node 19+)
|
||||||
|
return crypto.getRandomValues(new Uint8Array(length))
|
||||||
|
}
|
||||||
|
}
|
||||||
1126
src/rondevu.ts
1126
src/rondevu.ts
File diff suppressed because it is too large
Load Diff
157
src/rpc-batcher.ts
Normal file
157
src/rpc-batcher.ts
Normal file
@@ -0,0 +1,157 @@
|
|||||||
|
/**
|
||||||
|
* RPC Batcher - Throttles and batches RPC requests to reduce HTTP overhead
|
||||||
|
*/
|
||||||
|
|
||||||
|
export interface BatcherOptions {
|
||||||
|
/**
|
||||||
|
* Maximum number of requests to batch together
|
||||||
|
* Default: 10
|
||||||
|
*/
|
||||||
|
maxBatchSize?: number
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Maximum time to wait before sending a batch (ms)
|
||||||
|
* Default: 50ms
|
||||||
|
*/
|
||||||
|
maxWaitTime?: number
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Minimum time between batches (ms)
|
||||||
|
* Default: 10ms
|
||||||
|
*/
|
||||||
|
throttleInterval?: number
|
||||||
|
}
|
||||||
|
|
||||||
|
interface QueuedRequest {
|
||||||
|
request: any
|
||||||
|
resolve: (value: any) => void
|
||||||
|
reject: (error: Error) => void
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Batches and throttles RPC requests to optimize network usage
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* ```typescript
|
||||||
|
* const batcher = new RpcBatcher(
|
||||||
|
* (requests) => api.rpcBatch(requests),
|
||||||
|
* { maxBatchSize: 10, maxWaitTime: 50 }
|
||||||
|
* )
|
||||||
|
*
|
||||||
|
* // These will be batched together if called within maxWaitTime
|
||||||
|
* const result1 = await batcher.add(request1)
|
||||||
|
* const result2 = await batcher.add(request2)
|
||||||
|
* const result3 = await batcher.add(request3)
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
export class RpcBatcher {
|
||||||
|
private queue: QueuedRequest[] = []
|
||||||
|
private batchTimeout: ReturnType<typeof setTimeout> | null = null
|
||||||
|
private lastBatchTime: number = 0
|
||||||
|
private options: Required<BatcherOptions>
|
||||||
|
private sendBatch: (requests: any[]) => Promise<any[]>
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
sendBatch: (requests: any[]) => Promise<any[]>,
|
||||||
|
options?: BatcherOptions
|
||||||
|
) {
|
||||||
|
this.sendBatch = sendBatch
|
||||||
|
this.options = {
|
||||||
|
maxBatchSize: options?.maxBatchSize ?? 10,
|
||||||
|
maxWaitTime: options?.maxWaitTime ?? 50,
|
||||||
|
throttleInterval: options?.throttleInterval ?? 10,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add an RPC request to the batch queue
|
||||||
|
* Returns a promise that resolves when the request completes
|
||||||
|
*/
|
||||||
|
async add(request: any): Promise<any> {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
this.queue.push({ request, resolve, reject })
|
||||||
|
|
||||||
|
// Send immediately if batch is full
|
||||||
|
if (this.queue.length >= this.options.maxBatchSize) {
|
||||||
|
this.flush()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Schedule batch if not already scheduled
|
||||||
|
if (!this.batchTimeout) {
|
||||||
|
this.batchTimeout = setTimeout(() => {
|
||||||
|
this.flush()
|
||||||
|
}, this.options.maxWaitTime)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Flush the queue immediately
|
||||||
|
*/
|
||||||
|
async flush(): Promise<void> {
|
||||||
|
// Clear timeout if set
|
||||||
|
if (this.batchTimeout) {
|
||||||
|
clearTimeout(this.batchTimeout)
|
||||||
|
this.batchTimeout = null
|
||||||
|
}
|
||||||
|
|
||||||
|
// Nothing to flush
|
||||||
|
if (this.queue.length === 0) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Throttle: wait if we sent a batch too recently
|
||||||
|
const now = Date.now()
|
||||||
|
const timeSinceLastBatch = now - this.lastBatchTime
|
||||||
|
if (timeSinceLastBatch < this.options.throttleInterval) {
|
||||||
|
const waitTime = this.options.throttleInterval - timeSinceLastBatch
|
||||||
|
await new Promise(resolve => setTimeout(resolve, waitTime))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Extract requests from queue
|
||||||
|
const batch = this.queue.splice(0, this.options.maxBatchSize)
|
||||||
|
const requests = batch.map(item => item.request)
|
||||||
|
|
||||||
|
this.lastBatchTime = Date.now()
|
||||||
|
|
||||||
|
try {
|
||||||
|
// Send batch request
|
||||||
|
const results = await this.sendBatch(requests)
|
||||||
|
|
||||||
|
// Resolve individual promises
|
||||||
|
for (let i = 0; i < batch.length; i++) {
|
||||||
|
batch[i].resolve(results[i])
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
// Reject all promises in batch
|
||||||
|
for (const item of batch) {
|
||||||
|
item.reject(error as Error)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get current queue size
|
||||||
|
*/
|
||||||
|
getQueueSize(): number {
|
||||||
|
return this.queue.length
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clear the queue without sending
|
||||||
|
*/
|
||||||
|
clear(): void {
|
||||||
|
if (this.batchTimeout) {
|
||||||
|
clearTimeout(this.batchTimeout)
|
||||||
|
this.batchTimeout = null
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reject all pending requests
|
||||||
|
for (const item of this.queue) {
|
||||||
|
item.reject(new Error('Batch queue cleared'))
|
||||||
|
}
|
||||||
|
|
||||||
|
this.queue = []
|
||||||
|
}
|
||||||
|
}
|
||||||
238
src/types.ts
238
src/types.ts
@@ -1,232 +1,20 @@
|
|||||||
// ============================================================================
|
/**
|
||||||
// Signaling Types
|
* Core signaling types
|
||||||
// ============================================================================
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Session side - identifies which peer in a connection
|
* Cleanup function returned by listener methods
|
||||||
*/
|
*/
|
||||||
export type Side = 'offerer' | 'answerer';
|
export type Binnable = () => void
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Session information returned from discovery endpoints
|
* Signaler interface for WebRTC offer/answer/ICE exchange
|
||||||
*/
|
*/
|
||||||
export interface Session {
|
export interface Signaler {
|
||||||
/** Unique session identifier (UUID) */
|
addIceCandidate(candidate: RTCIceCandidate): Promise<void>
|
||||||
code: string;
|
addListener(callback: (candidate: RTCIceCandidate) => void): Binnable
|
||||||
/** Peer identifier/metadata */
|
addOfferListener(callback: (offer: RTCSessionDescriptionInit) => void): Binnable
|
||||||
peerId: string;
|
addAnswerListener(callback: (answer: RTCSessionDescriptionInit) => void): Binnable
|
||||||
/** Signaling data for peer connection */
|
setOffer(offer: RTCSessionDescriptionInit): Promise<void>
|
||||||
offer: string;
|
setAnswer(answer: RTCSessionDescriptionInit): Promise<void>
|
||||||
/** Additional signaling data from offerer */
|
|
||||||
offerCandidates: string[];
|
|
||||||
/** Unix timestamp when session was created */
|
|
||||||
createdAt: number;
|
|
||||||
/** Unix timestamp when session expires */
|
|
||||||
expiresAt: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Topic information with peer count
|
|
||||||
*/
|
|
||||||
export interface TopicInfo {
|
|
||||||
/** Topic identifier */
|
|
||||||
topic: string;
|
|
||||||
/** Number of available peers in this topic */
|
|
||||||
count: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Pagination information
|
|
||||||
*/
|
|
||||||
export interface Pagination {
|
|
||||||
/** Current page number */
|
|
||||||
page: number;
|
|
||||||
/** Results per page */
|
|
||||||
limit: number;
|
|
||||||
/** Total number of results */
|
|
||||||
total: number;
|
|
||||||
/** Whether there are more results available */
|
|
||||||
hasMore: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Response from GET / - list all topics
|
|
||||||
*/
|
|
||||||
export interface ListTopicsResponse {
|
|
||||||
topics: TopicInfo[];
|
|
||||||
pagination: Pagination;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Response from GET /:topic/sessions - list sessions in a topic
|
|
||||||
*/
|
|
||||||
export interface ListSessionsResponse {
|
|
||||||
sessions: Session[];
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Request body for POST /:topic/offer
|
|
||||||
*/
|
|
||||||
export interface CreateOfferRequest {
|
|
||||||
/** Peer identifier/metadata (max 1024 characters) */
|
|
||||||
peerId: string;
|
|
||||||
/** Signaling data for peer connection */
|
|
||||||
offer: string;
|
|
||||||
/** Optional custom connection code (if not provided, server generates UUID) */
|
|
||||||
code?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Response from POST /:topic/offer
|
|
||||||
*/
|
|
||||||
export interface CreateOfferResponse {
|
|
||||||
/** Unique session identifier (UUID) */
|
|
||||||
code: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Request body for POST /answer
|
|
||||||
*/
|
|
||||||
export interface AnswerRequest {
|
|
||||||
/** Session UUID from the offer */
|
|
||||||
code: string;
|
|
||||||
/** Response signaling data (required if candidate not provided) */
|
|
||||||
answer?: string;
|
|
||||||
/** Additional signaling data (required if answer not provided) */
|
|
||||||
candidate?: string;
|
|
||||||
/** Which peer is sending the data */
|
|
||||||
side: Side;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Response from POST /answer
|
|
||||||
*/
|
|
||||||
export interface AnswerResponse {
|
|
||||||
success: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Request body for POST /poll
|
|
||||||
*/
|
|
||||||
export interface PollRequest {
|
|
||||||
/** Session UUID */
|
|
||||||
code: string;
|
|
||||||
/** Which side is polling */
|
|
||||||
side: Side;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Response from POST /poll when side=offerer
|
|
||||||
*/
|
|
||||||
export interface PollOffererResponse {
|
|
||||||
/** Answer from answerer (null if not yet received) */
|
|
||||||
answer: string | null;
|
|
||||||
/** Additional signaling data from answerer */
|
|
||||||
answerCandidates: string[];
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Response from POST /poll when side=answerer
|
|
||||||
*/
|
|
||||||
export interface PollAnswererResponse {
|
|
||||||
/** Offer from offerer */
|
|
||||||
offer: string;
|
|
||||||
/** Additional signaling data from offerer */
|
|
||||||
offerCandidates: string[];
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Response from POST /poll (union type)
|
|
||||||
*/
|
|
||||||
export type PollResponse = PollOffererResponse | PollAnswererResponse;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Response from GET /health
|
|
||||||
*/
|
|
||||||
export interface HealthResponse {
|
|
||||||
status: 'ok';
|
|
||||||
timestamp: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Error response structure
|
|
||||||
*/
|
|
||||||
export interface ErrorResponse {
|
|
||||||
error: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Client configuration options
|
|
||||||
*/
|
|
||||||
export interface RondevuClientOptions {
|
|
||||||
/** Base URL of the Rondevu server (e.g., 'https://example.com') */
|
|
||||||
baseUrl: string;
|
|
||||||
/** Origin header value for session isolation (defaults to baseUrl origin) */
|
|
||||||
origin?: string;
|
|
||||||
/** Optional fetch implementation (for Node.js environments) */
|
|
||||||
fetch?: typeof fetch;
|
|
||||||
}
|
|
||||||
|
|
||||||
// ============================================================================
|
|
||||||
// WebRTC Types
|
|
||||||
// ============================================================================
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Configuration options for Rondevu WebRTC client
|
|
||||||
*/
|
|
||||||
export interface RondevuOptions {
|
|
||||||
/** Base URL of the Rondevu server (e.g., 'https://example.com') */
|
|
||||||
baseUrl: string;
|
|
||||||
/** Peer identifier (optional, auto-generated if not provided) */
|
|
||||||
peerId?: string;
|
|
||||||
/** Origin header value for session isolation (defaults to baseUrl origin) */
|
|
||||||
origin?: string;
|
|
||||||
/** Optional fetch implementation (for Node.js environments) */
|
|
||||||
fetch?: typeof fetch;
|
|
||||||
/** WebRTC configuration (ICE servers, etc.) */
|
|
||||||
rtcConfig?: RTCConfiguration;
|
|
||||||
/** Polling interval in milliseconds (default: 1000) */
|
|
||||||
pollingInterval?: number;
|
|
||||||
/** Connection timeout in milliseconds (default: 30000) */
|
|
||||||
connectionTimeout?: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Options for joining a topic
|
|
||||||
*/
|
|
||||||
export interface JoinOptions {
|
|
||||||
/** Filter function to select specific sessions */
|
|
||||||
filter?: (session: { code: string; peerId: string }) => boolean;
|
|
||||||
/** Selection strategy for choosing a session */
|
|
||||||
select?: 'first' | 'newest' | 'oldest' | 'random';
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Connection role - whether this peer is creating or answering
|
|
||||||
*/
|
|
||||||
export type ConnectionRole = 'offerer' | 'answerer';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Parameters for creating a RondevuConnection
|
|
||||||
*/
|
|
||||||
export interface RondevuConnectionParams {
|
|
||||||
id: string;
|
|
||||||
topic: string;
|
|
||||||
role: ConnectionRole;
|
|
||||||
pc: RTCPeerConnection;
|
|
||||||
localPeerId: string;
|
|
||||||
remotePeerId: string;
|
|
||||||
pollingInterval: number;
|
|
||||||
connectionTimeout: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Event map for RondevuConnection events
|
|
||||||
*/
|
|
||||||
export interface RondevuConnectionEvents {
|
|
||||||
connect: () => void;
|
|
||||||
disconnect: () => void;
|
|
||||||
error: (error: Error) => void;
|
|
||||||
datachannel: (channel: RTCDataChannel) => void;
|
|
||||||
stream: (stream: MediaStream) => void;
|
|
||||||
}
|
}
|
||||||
|
|||||||
67
src/web-crypto-adapter.ts
Normal file
67
src/web-crypto-adapter.ts
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
/**
|
||||||
|
* Web Crypto adapter for browser environments
|
||||||
|
*/
|
||||||
|
|
||||||
|
import * as ed25519 from '@noble/ed25519'
|
||||||
|
import { CryptoAdapter, Keypair } from './crypto-adapter.js'
|
||||||
|
|
||||||
|
// Set SHA-512 hash function for ed25519 (required in @noble/ed25519 v3+)
|
||||||
|
ed25519.hashes.sha512Async = async (message: Uint8Array) => {
|
||||||
|
return new Uint8Array(await crypto.subtle.digest('SHA-512', message as BufferSource))
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Web Crypto implementation using browser APIs
|
||||||
|
* Uses btoa/atob for base64 encoding and crypto.getRandomValues for random bytes
|
||||||
|
*/
|
||||||
|
export class WebCryptoAdapter implements CryptoAdapter {
|
||||||
|
async generateKeypair(): Promise<Keypair> {
|
||||||
|
const privateKey = ed25519.utils.randomSecretKey()
|
||||||
|
const publicKey = await ed25519.getPublicKeyAsync(privateKey)
|
||||||
|
|
||||||
|
return {
|
||||||
|
publicKey: this.bytesToBase64(publicKey),
|
||||||
|
privateKey: this.bytesToBase64(privateKey),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async signMessage(message: string, privateKeyBase64: string): Promise<string> {
|
||||||
|
const privateKey = this.base64ToBytes(privateKeyBase64)
|
||||||
|
const encoder = new TextEncoder()
|
||||||
|
const messageBytes = encoder.encode(message)
|
||||||
|
const signature = await ed25519.signAsync(messageBytes, privateKey)
|
||||||
|
|
||||||
|
return this.bytesToBase64(signature)
|
||||||
|
}
|
||||||
|
|
||||||
|
async verifySignature(
|
||||||
|
message: string,
|
||||||
|
signatureBase64: string,
|
||||||
|
publicKeyBase64: string
|
||||||
|
): Promise<boolean> {
|
||||||
|
try {
|
||||||
|
const signature = this.base64ToBytes(signatureBase64)
|
||||||
|
const publicKey = this.base64ToBytes(publicKeyBase64)
|
||||||
|
const encoder = new TextEncoder()
|
||||||
|
const messageBytes = encoder.encode(message)
|
||||||
|
|
||||||
|
return await ed25519.verifyAsync(signature, messageBytes, publicKey)
|
||||||
|
} catch {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
bytesToBase64(bytes: Uint8Array): string {
|
||||||
|
const binString = Array.from(bytes, byte => String.fromCodePoint(byte)).join('')
|
||||||
|
return btoa(binString)
|
||||||
|
}
|
||||||
|
|
||||||
|
base64ToBytes(base64: string): Uint8Array {
|
||||||
|
const binString = atob(base64)
|
||||||
|
return Uint8Array.from(binString, char => char.codePointAt(0)!)
|
||||||
|
}
|
||||||
|
|
||||||
|
randomBytes(length: number): Uint8Array {
|
||||||
|
return crypto.getRandomValues(new Uint8Array(length))
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user