mirror of
https://github.com/xtr-dev/rondevu-client.git
synced 2025-12-13 04:13:25 +00:00
Compare commits
53 Commits
b2d42fa776
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| 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 |
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)
|
||||||
724
README.md
724
README.md
@@ -2,9 +2,9 @@
|
|||||||
|
|
||||||
[](https://www.npmjs.com/package/@xtr-dev/rondevu-client)
|
[](https://www.npmjs.com/package/@xtr-dev/rondevu-client)
|
||||||
|
|
||||||
🌐 **DNS-like WebRTC client with username claiming and service discovery**
|
🌐 **Simple WebRTC signaling client with username-based discovery**
|
||||||
|
|
||||||
TypeScript/JavaScript client for Rondevu, providing cryptographic username claiming, service publishing, and privacy-preserving discovery.
|
TypeScript/JavaScript client for Rondevu, providing WebRTC signaling with username claiming, service publishing/discovery, and efficient batch polling.
|
||||||
|
|
||||||
**Related repositories:**
|
**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-client](https://github.com/xtr-dev/rondevu-client) - TypeScript client library ([npm](https://www.npmjs.com/package/@xtr-dev/rondevu-client))
|
||||||
@@ -15,15 +15,17 @@ TypeScript/JavaScript client for Rondevu, providing cryptographic username claim
|
|||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- **Username Claiming**: Cryptographic ownership with Ed25519 signatures
|
- **Username Claiming**: Secure ownership with Ed25519 signatures
|
||||||
- **Service Publishing**: Package-style naming (com.example.chat@1.0.0)
|
- **Anonymous Users**: Auto-generated anonymous usernames for quick testing
|
||||||
- **Privacy-Preserving Discovery**: UUID-based service index
|
- **Service Publishing**: Publish services with multiple offers for connection pooling
|
||||||
- **Public/Private Services**: Control service visibility
|
- **Service Discovery**: Direct lookup, random discovery, or paginated search
|
||||||
- **Complete WebRTC Signaling**: Full offer/answer and ICE candidate exchange
|
- **Efficient Batch Polling**: Single endpoint for answers and ICE candidates (50% fewer requests)
|
||||||
- **Trickle ICE**: Send ICE candidates as they're discovered
|
- **Semantic Version Matching**: Compatible version resolution (chat:1.0.0 matches any 1.x.x)
|
||||||
- **TypeScript**: Full type safety and autocomplete
|
- **TypeScript**: Full type safety and autocomplete
|
||||||
|
- **Keypair Management**: Generate or reuse Ed25519 keypairs
|
||||||
|
- **Automatic Signatures**: All authenticated requests signed automatically
|
||||||
|
|
||||||
## Install
|
## Installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install @xtr-dev/rondevu-client
|
npm install @xtr-dev/rondevu-client
|
||||||
@@ -31,662 +33,144 @@ npm install @xtr-dev/rondevu-client
|
|||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
### Publishing a Service (Alice)
|
### Publishing a Service (Offerer)
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { Rondevu } from '@xtr-dev/rondevu-client';
|
import { Rondevu } from '@xtr-dev/rondevu-client'
|
||||||
|
|
||||||
// Initialize client and register
|
// 1. Connect to Rondevu
|
||||||
const client = new Rondevu({ baseUrl: 'https://api.ronde.vu' });
|
const rondevu = await Rondevu.connect({
|
||||||
await client.register();
|
apiUrl: 'https://api.ronde.vu',
|
||||||
|
username: 'alice', // Or omit for anonymous username
|
||||||
|
iceServers: 'ipv4-turn' // Preset: 'ipv4-turn', 'hostname-turns', 'google-stun', 'relay-only'
|
||||||
|
})
|
||||||
|
|
||||||
// Step 1: Claim username (one-time)
|
// 2. Publish service with automatic offer management
|
||||||
const claim = await client.usernames.claimUsername('alice');
|
await rondevu.publishService({
|
||||||
client.usernames.saveKeypairToStorage('alice', claim.publicKey, claim.privateKey);
|
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')
|
||||||
|
|
||||||
console.log(`Username claimed: ${claim.username}`);
|
dc.addEventListener('open', () => {
|
||||||
console.log(`Expires: ${new Date(claim.expiresAt)}`);
|
console.log('Connection opened!')
|
||||||
|
dc.send('Hello from Alice!')
|
||||||
|
})
|
||||||
|
|
||||||
// Step 2: Expose service with handler
|
dc.addEventListener('message', (e) => {
|
||||||
const keypair = client.usernames.loadKeypairFromStorage('alice');
|
console.log('Received:', e.data)
|
||||||
|
})
|
||||||
|
|
||||||
const handle = await client.services.exposeService({
|
const offer = await pc.createOffer()
|
||||||
username: 'alice',
|
await pc.setLocalDescription(offer)
|
||||||
privateKey: keypair.privateKey,
|
return { pc, dc, offer }
|
||||||
serviceFqn: 'com.example.chat@1.0.0',
|
|
||||||
isPublic: true,
|
|
||||||
handler: (channel, peer) => {
|
|
||||||
console.log('📡 New connection established');
|
|
||||||
|
|
||||||
channel.onmessage = (e) => {
|
|
||||||
console.log('📥 Received:', e.data);
|
|
||||||
channel.send(`Echo: ${e.data}`);
|
|
||||||
};
|
|
||||||
|
|
||||||
channel.onopen = () => {
|
|
||||||
console.log('✅ Data channel open');
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
});
|
})
|
||||||
|
|
||||||
console.log(`Service published with UUID: ${handle.uuid}`);
|
// 3. Start accepting connections
|
||||||
console.log('Waiting for connections...');
|
await rondevu.startFilling()
|
||||||
|
|
||||||
// Later: unpublish
|
|
||||||
await handle.unpublish();
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Connecting to a Service (Bob)
|
### Connecting to a Service (Answerer)
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { Rondevu } from '@xtr-dev/rondevu-client';
|
import { Rondevu } from '@xtr-dev/rondevu-client'
|
||||||
|
|
||||||
// Initialize client and register
|
// 1. Connect to Rondevu
|
||||||
const client = new Rondevu({ baseUrl: 'https://api.ronde.vu' });
|
const rondevu = await Rondevu.connect({
|
||||||
await client.register();
|
apiUrl: 'https://api.ronde.vu',
|
||||||
|
username: 'bob',
|
||||||
|
iceServers: 'ipv4-turn'
|
||||||
|
})
|
||||||
|
|
||||||
// Option 1: Connect by username + FQN
|
// 2. Connect to service (automatic WebRTC setup)
|
||||||
const { peer, channel } = await client.discovery.connect(
|
const connection = await rondevu.connectToService({
|
||||||
'alice',
|
serviceFqn: 'chat:1.0.0@alice',
|
||||||
'com.example.chat@1.0.0'
|
onConnection: ({ dc, peerUsername }) => {
|
||||||
);
|
console.log('Connected to', peerUsername)
|
||||||
|
|
||||||
channel.onmessage = (e) => {
|
dc.addEventListener('message', (e) => {
|
||||||
console.log('📥 Received:', e.data);
|
console.log('Received:', e.data)
|
||||||
};
|
})
|
||||||
|
|
||||||
channel.onopen = () => {
|
dc.addEventListener('open', () => {
|
||||||
console.log('✅ Connected!');
|
dc.send('Hello from Bob!')
|
||||||
channel.send('Hello Alice!');
|
})
|
||||||
};
|
|
||||||
|
|
||||||
peer.on('connected', () => {
|
|
||||||
console.log('🎉 WebRTC connection established');
|
|
||||||
});
|
|
||||||
|
|
||||||
peer.on('failed', (error) => {
|
|
||||||
console.error('❌ Connection failed:', error);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Option 2: List services first, then connect
|
|
||||||
const services = await client.discovery.listServices('alice');
|
|
||||||
console.log(`Found ${services.services.length} services`);
|
|
||||||
|
|
||||||
for (const service of services.services) {
|
|
||||||
console.log(`- UUID: ${service.uuid}`);
|
|
||||||
if (service.isPublic) {
|
|
||||||
console.log(` FQN: ${service.serviceFqn}`);
|
|
||||||
}
|
}
|
||||||
}
|
})
|
||||||
|
|
||||||
// Connect by UUID
|
// Access connection
|
||||||
const { peer: peer2, channel: channel2 } = await client.discovery.connectByUuid(
|
connection.dc.send('Another message')
|
||||||
services.services[0].uuid
|
connection.pc.close() // Close when done
|
||||||
);
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## API Reference
|
## Core API
|
||||||
|
|
||||||
### Main Client
|
### Rondevu.connect()
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
const client = new Rondevu({
|
const rondevu = await Rondevu.connect({
|
||||||
baseUrl: 'https://api.ronde.vu', // optional, default shown
|
apiUrl: string, // Required: Signaling server URL
|
||||||
credentials?: { peerId, secret }, // optional, skip registration
|
username?: string, // Optional: your username (auto-generates anonymous if omitted)
|
||||||
fetch?: customFetch, // optional, for Node.js < 18
|
keypair?: Keypair, // Optional: reuse existing keypair
|
||||||
RTCPeerConnection?: RTCPeerConnection, // optional, for Node.js
|
iceServers?: IceServerPreset | RTCIceServer[], // Optional: preset or custom config
|
||||||
RTCSessionDescription?: RTCSessionDescription,
|
debug?: boolean // Optional: enable debug logging (default: false)
|
||||||
RTCIceCandidate?: RTCIceCandidate
|
})
|
||||||
});
|
|
||||||
|
|
||||||
// Register and get credentials
|
|
||||||
const creds = await client.register();
|
|
||||||
// { peerId: '...', secret: '...' }
|
|
||||||
|
|
||||||
// Check if authenticated
|
|
||||||
client.isAuthenticated(); // boolean
|
|
||||||
|
|
||||||
// Get current credentials
|
|
||||||
client.getCredentials(); // { peerId, secret } | undefined
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Username API
|
### Service Publishing
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Check username availability
|
await rondevu.publishService({
|
||||||
const check = await client.usernames.checkUsername('alice');
|
service: string, // e.g., 'chat:1.0.0' (username auto-appended)
|
||||||
// { available: true } or { available: false, expiresAt: number, publicKey: string }
|
maxOffers: number, // Maximum concurrent offers to maintain
|
||||||
|
offerFactory?: OfferFactory, // Optional: custom offer creation
|
||||||
|
ttl?: number // Optional: offer lifetime in ms (default: 300000)
|
||||||
|
})
|
||||||
|
|
||||||
// Claim username with new keypair
|
await rondevu.startFilling() // Start accepting connections
|
||||||
const claim = await client.usernames.claimUsername('alice');
|
rondevu.stopFilling() // Stop and close all connections
|
||||||
// { username, publicKey, privateKey, claimedAt, expiresAt }
|
|
||||||
|
|
||||||
// Claim with existing keypair
|
|
||||||
const keypair = await client.usernames.generateKeypair();
|
|
||||||
const claim2 = await client.usernames.claimUsername('bob', keypair);
|
|
||||||
|
|
||||||
// Save keypair to localStorage
|
|
||||||
client.usernames.saveKeypairToStorage('alice', publicKey, privateKey);
|
|
||||||
|
|
||||||
// Load keypair from localStorage
|
|
||||||
const stored = client.usernames.loadKeypairFromStorage('alice');
|
|
||||||
// { publicKey, privateKey } | null
|
|
||||||
|
|
||||||
// Export keypair for backup
|
|
||||||
const exported = client.usernames.exportKeypair('alice');
|
|
||||||
// { username, publicKey, privateKey }
|
|
||||||
|
|
||||||
// Import keypair from backup
|
|
||||||
client.usernames.importKeypair({ username: 'alice', publicKey, privateKey });
|
|
||||||
|
|
||||||
// Low-level: Generate keypair
|
|
||||||
const { publicKey, privateKey } = await client.usernames.generateKeypair();
|
|
||||||
|
|
||||||
// Low-level: Sign message
|
|
||||||
const signature = await client.usernames.signMessage(
|
|
||||||
'claim:alice:1234567890',
|
|
||||||
privateKey
|
|
||||||
);
|
|
||||||
|
|
||||||
// Low-level: Verify signature
|
|
||||||
const valid = await client.usernames.verifySignature(
|
|
||||||
'claim:alice:1234567890',
|
|
||||||
signature,
|
|
||||||
publicKey
|
|
||||||
);
|
|
||||||
```
|
```
|
||||||
|
|
||||||
**Username Rules:**
|
### Service Discovery
|
||||||
- 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
|
|
||||||
|
|
||||||
### Services API
|
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Publish service (returns UUID)
|
// Direct lookup (with username)
|
||||||
const service = await client.services.publishService({
|
await rondevu.getService('chat:1.0.0@alice')
|
||||||
username: 'alice',
|
|
||||||
privateKey: keypair.privateKey,
|
|
||||||
serviceFqn: 'com.example.chat@1.0.0',
|
|
||||||
isPublic: false, // optional, default false
|
|
||||||
metadata: { description: '...' }, // optional
|
|
||||||
ttl: 5 * 60 * 1000, // optional, default 5 minutes
|
|
||||||
rtcConfig: { ... } // optional RTCConfiguration
|
|
||||||
});
|
|
||||||
// { serviceId, uuid, offerId, expiresAt }
|
|
||||||
|
|
||||||
console.log(`Service UUID: ${service.uuid}`);
|
// Random discovery (without username)
|
||||||
console.log('Share this UUID to allow connections');
|
await rondevu.discoverService('chat:1.0.0')
|
||||||
|
|
||||||
// Expose service with automatic connection handling
|
// Paginated discovery
|
||||||
const handle = await client.services.exposeService({
|
await rondevu.discoverServices('chat:1.0.0', limit, offset)
|
||||||
username: 'alice',
|
|
||||||
privateKey: keypair.privateKey,
|
|
||||||
serviceFqn: 'com.example.echo@1.0.0',
|
|
||||||
isPublic: true,
|
|
||||||
handler: (channel, peer) => {
|
|
||||||
channel.onmessage = (e) => {
|
|
||||||
console.log('Received:', e.data);
|
|
||||||
channel.send(`Echo: ${e.data}`);
|
|
||||||
};
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// Later: unpublish
|
|
||||||
await handle.unpublish();
|
|
||||||
|
|
||||||
// Unpublish service manually
|
|
||||||
await client.services.unpublishService(serviceId, username);
|
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Multi-Connection Service Hosting (Offer Pooling)
|
### Connecting to Services
|
||||||
|
|
||||||
By default, `exposeService()` creates a single offer and can only accept one connection. To handle multiple concurrent connections, use the `poolSize` option to enable **offer pooling**:
|
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Expose service with offer pooling for multiple concurrent connections
|
const connection = await rondevu.connectToService({
|
||||||
const handle = await client.services.exposeService({
|
serviceFqn?: string, // Full FQN like 'chat:1.0.0@alice'
|
||||||
username: 'alice',
|
service?: string, // Service without username (for discovery)
|
||||||
privateKey: keypair.privateKey,
|
username?: string, // Target username (combined with service)
|
||||||
serviceFqn: 'com.example.chat@1.0.0',
|
onConnection?: (context) => void, // Called when data channel opens
|
||||||
isPublic: true,
|
rtcConfig?: RTCConfiguration // Optional: override ICE servers
|
||||||
poolSize: 5, // Maintain 5 simultaneous open offers
|
})
|
||||||
pollingInterval: 2000, // Optional: polling interval in ms (default: 2000)
|
|
||||||
handler: (channel, peer, connectionId) => {
|
|
||||||
console.log(`📡 New connection: ${connectionId}`);
|
|
||||||
|
|
||||||
channel.onmessage = (e) => {
|
|
||||||
console.log(`📥 [${connectionId}] Received:`, e.data);
|
|
||||||
channel.send(`Echo: ${e.data}`);
|
|
||||||
};
|
|
||||||
|
|
||||||
channel.onclose = () => {
|
|
||||||
console.log(`👋 [${connectionId}] Connection closed`);
|
|
||||||
};
|
|
||||||
},
|
|
||||||
onPoolStatus: (status) => {
|
|
||||||
console.log('Pool status:', {
|
|
||||||
activeOffers: status.activeOffers,
|
|
||||||
activeConnections: status.activeConnections,
|
|
||||||
totalHandled: status.totalConnectionsHandled
|
|
||||||
});
|
|
||||||
},
|
|
||||||
onError: (error, context) => {
|
|
||||||
console.error(`Pool error (${context}):`, error);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// Get current pool status
|
|
||||||
const status = handle.getStatus();
|
|
||||||
console.log(`Active offers: ${status.activeOffers}`);
|
|
||||||
console.log(`Active connections: ${status.activeConnections}`);
|
|
||||||
|
|
||||||
// Manually add more offers if needed
|
|
||||||
await handle.addOffers(3);
|
|
||||||
```
|
```
|
||||||
|
|
||||||
**How Offer Pooling Works:**
|
## Documentation
|
||||||
1. The pool maintains `poolSize` simultaneous open offers at all times
|
|
||||||
2. When an offer is answered (connection established), a new offer is automatically created
|
|
||||||
3. Polling checks for answers every `pollingInterval` milliseconds (default: 2000ms)
|
|
||||||
4. Each connection gets a unique `connectionId` passed to the handler
|
|
||||||
5. No limit on total concurrent connections - only pool size (open offers) is controlled
|
|
||||||
|
|
||||||
**Use Cases:**
|
📚 **[ADVANCED.md](./ADVANCED.md)** - Comprehensive guide including:
|
||||||
- Chat servers handling multiple clients
|
- Detailed API reference for all methods
|
||||||
- File sharing services with concurrent downloads
|
- Type definitions and interfaces
|
||||||
- Multiplayer game lobbies
|
- Platform support (Browser & Node.js)
|
||||||
- Collaborative editing sessions
|
- Advanced usage patterns
|
||||||
- Any service that needs to accept multiple simultaneous connections
|
- Username rules and service FQN format
|
||||||
|
- Examples and migration guides
|
||||||
**Pool Status Interface:**
|
|
||||||
```typescript
|
|
||||||
interface PoolStatus {
|
|
||||||
activeOffers: number; // Current number of open offers
|
|
||||||
activeConnections: number; // Current number of connected peers
|
|
||||||
totalConnectionsHandled: number; // Total connections since start
|
|
||||||
failedOfferCreations: number; // Failed offer creation attempts
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Pooled Service Handle:**
|
|
||||||
```typescript
|
|
||||||
interface PooledServiceHandle extends ServiceHandle {
|
|
||||||
getStatus: () => PoolStatus; // Get current pool status
|
|
||||||
addOffers: (count: number) => Promise<void>; // Manually add offers
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Service FQN Format:**
|
|
||||||
- Service name: Reverse domain notation (e.g., `com.example.chat`)
|
|
||||||
- Version: Semantic versioning (e.g., `1.0.0`, `2.1.3-beta`)
|
|
||||||
- Complete FQN: `service-name@version`
|
|
||||||
- Examples: `com.example.chat@1.0.0`, `io.github.alice.notes@0.1.0-beta`
|
|
||||||
|
|
||||||
**Validation Rules:**
|
|
||||||
- Service name pattern: `^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)+$`
|
|
||||||
- Length: 3-128 characters
|
|
||||||
- Minimum 2 components (at least one dot)
|
|
||||||
- Version pattern: `^[0-9]+\.[0-9]+\.[0-9]+(-[a-z0-9.-]+)?$`
|
|
||||||
|
|
||||||
### Discovery API
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// List all services for a username
|
|
||||||
const services = await client.discovery.listServices('alice');
|
|
||||||
// {
|
|
||||||
// username: 'alice',
|
|
||||||
// services: [
|
|
||||||
// { uuid: 'abc123', isPublic: false },
|
|
||||||
// { uuid: 'def456', isPublic: true, serviceFqn: '...', metadata: {...} }
|
|
||||||
// ]
|
|
||||||
// }
|
|
||||||
|
|
||||||
// Query service by FQN
|
|
||||||
const query = await client.discovery.queryService('alice', 'com.example.chat@1.0.0');
|
|
||||||
// { uuid: 'abc123', allowed: true }
|
|
||||||
|
|
||||||
// Get service details by UUID
|
|
||||||
const details = await client.discovery.getServiceDetails('abc123');
|
|
||||||
// { serviceId, username, serviceFqn, offerId, sdp, isPublic, metadata, ... }
|
|
||||||
|
|
||||||
// Connect to service by UUID
|
|
||||||
const peer = await client.discovery.connectToService('abc123', {
|
|
||||||
rtcConfig: { ... }, // optional
|
|
||||||
onConnected: () => { ... }, // optional
|
|
||||||
onData: (data) => { ... } // optional
|
|
||||||
});
|
|
||||||
|
|
||||||
// Connect by username + FQN (convenience method)
|
|
||||||
const { peer, channel } = await client.discovery.connect(
|
|
||||||
'alice',
|
|
||||||
'com.example.chat@1.0.0',
|
|
||||||
{ rtcConfig: { ... } } // optional
|
|
||||||
);
|
|
||||||
|
|
||||||
// Connect by UUID with channel
|
|
||||||
const { peer, channel } = await client.discovery.connectByUuid('abc123');
|
|
||||||
```
|
|
||||||
|
|
||||||
### Low-Level Peer Connection
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// Create peer connection
|
|
||||||
const peer = client.createPeer({
|
|
||||||
iceServers: [
|
|
||||||
{ urls: 'stun:stun.l.google.com:19302' },
|
|
||||||
{
|
|
||||||
urls: 'turn:turn.example.com:3478',
|
|
||||||
username: 'user',
|
|
||||||
credential: 'pass'
|
|
||||||
}
|
|
||||||
],
|
|
||||||
iceTransportPolicy: 'relay' // optional: force TURN relay
|
|
||||||
});
|
|
||||||
|
|
||||||
// Event listeners
|
|
||||||
peer.on('state', (state) => {
|
|
||||||
console.log('Peer state:', state);
|
|
||||||
});
|
|
||||||
|
|
||||||
peer.on('connected', () => {
|
|
||||||
console.log('✅ Connected');
|
|
||||||
});
|
|
||||||
|
|
||||||
peer.on('disconnected', () => {
|
|
||||||
console.log('🔌 Disconnected');
|
|
||||||
});
|
|
||||||
|
|
||||||
peer.on('failed', (error) => {
|
|
||||||
console.error('❌ Failed:', error);
|
|
||||||
});
|
|
||||||
|
|
||||||
peer.on('datachannel', (channel) => {
|
|
||||||
console.log('📡 Data channel ready');
|
|
||||||
});
|
|
||||||
|
|
||||||
peer.on('track', (event) => {
|
|
||||||
// Media track received
|
|
||||||
const stream = event.streams[0];
|
|
||||||
videoElement.srcObject = stream;
|
|
||||||
});
|
|
||||||
|
|
||||||
// Create offer
|
|
||||||
const offerId = await peer.createOffer({
|
|
||||||
ttl: 300000, // optional
|
|
||||||
timeouts: { // optional
|
|
||||||
iceGathering: 10000,
|
|
||||||
waitingForAnswer: 30000,
|
|
||||||
creatingAnswer: 10000,
|
|
||||||
iceConnection: 30000
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// Answer offer
|
|
||||||
await peer.answer(offerId, sdp);
|
|
||||||
|
|
||||||
// Add media tracks
|
|
||||||
const stream = await navigator.mediaDevices.getUserMedia({ video: true, audio: true });
|
|
||||||
stream.getTracks().forEach(track => {
|
|
||||||
peer.addTrack(track, stream);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Close connection
|
|
||||||
await peer.close();
|
|
||||||
|
|
||||||
// Properties
|
|
||||||
peer.stateName; // 'idle', 'creating-offer', 'connected', etc.
|
|
||||||
peer.connectionState; // RTCPeerConnectionState
|
|
||||||
peer.offerId; // string | undefined
|
|
||||||
peer.role; // 'offerer' | 'answerer' | undefined
|
|
||||||
```
|
|
||||||
|
|
||||||
## Connection Lifecycle
|
|
||||||
|
|
||||||
### Service Publisher (Offerer)
|
|
||||||
1. **idle** - Initial state
|
|
||||||
2. **creating-offer** - Creating WebRTC offer
|
|
||||||
3. **waiting-for-answer** - Polling for answer from peer
|
|
||||||
4. **exchanging-ice** - Exchanging ICE candidates
|
|
||||||
5. **connected** - Successfully connected
|
|
||||||
6. **failed** - Connection failed
|
|
||||||
7. **closed** - Connection closed
|
|
||||||
|
|
||||||
### Service Consumer (Answerer)
|
|
||||||
1. **idle** - Initial state
|
|
||||||
2. **answering** - Creating WebRTC answer
|
|
||||||
3. **exchanging-ice** - Exchanging ICE candidates
|
|
||||||
4. **connected** - Successfully connected
|
|
||||||
5. **failed** - Connection failed
|
|
||||||
6. **closed** - Connection closed
|
|
||||||
|
|
||||||
## Platform-Specific Setup
|
|
||||||
|
|
||||||
### Modern Browsers
|
|
||||||
Works out of the box - no additional setup needed.
|
|
||||||
|
|
||||||
### Node.js 18+
|
|
||||||
Native fetch is available, but you need WebRTC polyfills:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install wrtc
|
|
||||||
```
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { Rondevu } from '@xtr-dev/rondevu-client';
|
|
||||||
import { RTCPeerConnection, RTCSessionDescription, RTCIceCandidate } from 'wrtc';
|
|
||||||
|
|
||||||
const client = new Rondevu({
|
|
||||||
baseUrl: 'https://api.ronde.vu',
|
|
||||||
RTCPeerConnection,
|
|
||||||
RTCSessionDescription,
|
|
||||||
RTCIceCandidate
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
### Node.js < 18
|
|
||||||
Install both fetch and WebRTC polyfills:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install node-fetch wrtc
|
|
||||||
```
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { Rondevu } from '@xtr-dev/rondevu-client';
|
|
||||||
import fetch from 'node-fetch';
|
|
||||||
import { RTCPeerConnection, RTCSessionDescription, RTCIceCandidate } from 'wrtc';
|
|
||||||
|
|
||||||
const client = new Rondevu({
|
|
||||||
baseUrl: 'https://api.ronde.vu',
|
|
||||||
fetch: fetch as any,
|
|
||||||
RTCPeerConnection,
|
|
||||||
RTCSessionDescription,
|
|
||||||
RTCIceCandidate
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
### Deno
|
|
||||||
```typescript
|
|
||||||
import { Rondevu } from 'npm:@xtr-dev/rondevu-client';
|
|
||||||
|
|
||||||
const client = new Rondevu({
|
|
||||||
baseUrl: 'https://api.ronde.vu'
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
### Bun
|
|
||||||
Works out of the box - no additional setup needed.
|
|
||||||
|
|
||||||
### Cloudflare Workers
|
|
||||||
```typescript
|
|
||||||
import { Rondevu } from '@xtr-dev/rondevu-client';
|
|
||||||
|
|
||||||
export default {
|
|
||||||
async fetch(request: Request, env: Env) {
|
|
||||||
const client = new Rondevu({
|
|
||||||
baseUrl: 'https://api.ronde.vu'
|
|
||||||
});
|
|
||||||
|
|
||||||
const creds = await client.register();
|
|
||||||
return new Response(JSON.stringify(creds));
|
|
||||||
}
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
### Echo Service
|
- [React Demo](https://github.com/xtr-dev/rondevu-demo) - Full browser UI ([live](https://ronde.vu))
|
||||||
|
|
||||||
```typescript
|
|
||||||
// Publisher
|
|
||||||
const client1 = new Rondevu();
|
|
||||||
await client1.register();
|
|
||||||
|
|
||||||
const claim = await client1.usernames.claimUsername('alice');
|
|
||||||
client1.usernames.saveKeypairToStorage('alice', claim.publicKey, claim.privateKey);
|
|
||||||
|
|
||||||
const keypair = client1.usernames.loadKeypairFromStorage('alice');
|
|
||||||
|
|
||||||
await client1.services.exposeService({
|
|
||||||
username: 'alice',
|
|
||||||
privateKey: keypair.privateKey,
|
|
||||||
serviceFqn: 'com.example.echo@1.0.0',
|
|
||||||
isPublic: true,
|
|
||||||
handler: (channel, peer) => {
|
|
||||||
channel.onmessage = (e) => {
|
|
||||||
console.log('Received:', e.data);
|
|
||||||
channel.send(`Echo: ${e.data}`);
|
|
||||||
};
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// Consumer
|
|
||||||
const client2 = new Rondevu();
|
|
||||||
await client2.register();
|
|
||||||
|
|
||||||
const { peer, channel } = await client2.discovery.connect(
|
|
||||||
'alice',
|
|
||||||
'com.example.echo@1.0.0'
|
|
||||||
);
|
|
||||||
|
|
||||||
channel.onmessage = (e) => console.log('Received:', e.data);
|
|
||||||
channel.send('Hello!');
|
|
||||||
```
|
|
||||||
|
|
||||||
### File Transfer Service
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// Publisher
|
|
||||||
await client.services.exposeService({
|
|
||||||
username: 'alice',
|
|
||||||
privateKey: keypair.privateKey,
|
|
||||||
serviceFqn: 'com.example.files@1.0.0',
|
|
||||||
isPublic: false,
|
|
||||||
handler: (channel, peer) => {
|
|
||||||
channel.binaryType = 'arraybuffer';
|
|
||||||
|
|
||||||
channel.onmessage = (e) => {
|
|
||||||
if (typeof e.data === 'string') {
|
|
||||||
console.log('Request:', JSON.parse(e.data));
|
|
||||||
} else {
|
|
||||||
console.log('Received file chunk:', e.data.byteLength, 'bytes');
|
|
||||||
}
|
|
||||||
};
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// Consumer
|
|
||||||
const { peer, channel } = await client.discovery.connect(
|
|
||||||
'alice',
|
|
||||||
'com.example.files@1.0.0'
|
|
||||||
);
|
|
||||||
|
|
||||||
channel.binaryType = 'arraybuffer';
|
|
||||||
|
|
||||||
// Request file
|
|
||||||
channel.send(JSON.stringify({ action: 'get', path: '/readme.txt' }));
|
|
||||||
|
|
||||||
channel.onmessage = (e) => {
|
|
||||||
if (e.data instanceof ArrayBuffer) {
|
|
||||||
console.log('Received file:', e.data.byteLength, 'bytes');
|
|
||||||
}
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
### Video Chat Service
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// Publisher
|
|
||||||
const stream = await navigator.mediaDevices.getUserMedia({ video: true, audio: true });
|
|
||||||
|
|
||||||
const peer = client.createPeer();
|
|
||||||
stream.getTracks().forEach(track => peer.addTrack(track, stream));
|
|
||||||
|
|
||||||
const offerId = await peer.createOffer({ ttl: 300000 });
|
|
||||||
|
|
||||||
await client.services.publishService({
|
|
||||||
username: 'alice',
|
|
||||||
privateKey: keypair.privateKey,
|
|
||||||
serviceFqn: 'com.example.videochat@1.0.0',
|
|
||||||
isPublic: true
|
|
||||||
});
|
|
||||||
|
|
||||||
// Consumer
|
|
||||||
const { peer, channel } = await client.discovery.connect(
|
|
||||||
'alice',
|
|
||||||
'com.example.videochat@1.0.0'
|
|
||||||
);
|
|
||||||
|
|
||||||
peer.on('track', (event) => {
|
|
||||||
const remoteStream = event.streams[0];
|
|
||||||
videoElement.srcObject = remoteStream;
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
## TypeScript
|
|
||||||
|
|
||||||
All types are exported:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import type {
|
|
||||||
Credentials,
|
|
||||||
RondevuOptions,
|
|
||||||
|
|
||||||
// Username types
|
|
||||||
UsernameCheckResult,
|
|
||||||
UsernameClaimResult,
|
|
||||||
Keypair,
|
|
||||||
|
|
||||||
// Service types
|
|
||||||
ServicePublishResult,
|
|
||||||
PublishServiceOptions,
|
|
||||||
ServiceHandle,
|
|
||||||
|
|
||||||
// Discovery types
|
|
||||||
ServiceInfo,
|
|
||||||
ServiceListResult,
|
|
||||||
ServiceQueryResult,
|
|
||||||
ServiceDetails,
|
|
||||||
ConnectResult,
|
|
||||||
|
|
||||||
// Peer types
|
|
||||||
PeerOptions,
|
|
||||||
PeerEvents,
|
|
||||||
PeerTimeouts
|
|
||||||
} from '@xtr-dev/rondevu-client';
|
|
||||||
```
|
|
||||||
|
|
||||||
## Migration from V1
|
|
||||||
|
|
||||||
V2 is a **breaking change** that replaces topic-based discovery with username claiming and service publishing. See the main [MIGRATION.md](../MIGRATION.md) for detailed migration guide.
|
|
||||||
|
|
||||||
**Key Changes:**
|
|
||||||
- ❌ Removed: `offers.findByTopic()`, `offers.getTopics()`, bloom filters
|
|
||||||
- ✅ Added: `usernames.*`, `services.*`, `discovery.*` APIs
|
|
||||||
- ✅ Changed: Focus on service-based discovery instead of topics
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
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'],
|
||||||
|
},
|
||||||
|
]
|
||||||
2964
package-lock.json
generated
2964
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
20
package.json
20
package.json
@@ -1,13 +1,17 @@
|
|||||||
{
|
{
|
||||||
"name": "@xtr-dev/rondevu-client",
|
"name": "@xtr-dev/rondevu-client",
|
||||||
"version": "0.8.3",
|
"version": "0.16.0",
|
||||||
"description": "TypeScript client for Rondevu DNS-like WebRTC with username claiming and service discovery",
|
"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,7 +24,17 @@
|
|||||||
"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",
|
||||||
|
|||||||
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,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
62
src/auth.ts
62
src/auth.ts
@@ -1,62 +0,0 @@
|
|||||||
export interface Credentials {
|
|
||||||
peerId: string;
|
|
||||||
secret: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fetch-compatible function type
|
|
||||||
export type FetchFunction = (
|
|
||||||
input: RequestInfo | URL,
|
|
||||||
init?: RequestInit
|
|
||||||
) => Promise<Response>;
|
|
||||||
|
|
||||||
export class RondevuAuth {
|
|
||||||
private fetchFn: FetchFunction;
|
|
||||||
|
|
||||||
constructor(
|
|
||||||
private baseUrl: string,
|
|
||||||
fetchFn?: FetchFunction
|
|
||||||
) {
|
|
||||||
// Use provided fetch or fall back to global fetch
|
|
||||||
this.fetchFn = fetchFn || ((...args) => {
|
|
||||||
if (typeof globalThis.fetch === 'function') {
|
|
||||||
return globalThis.fetch(...args);
|
|
||||||
}
|
|
||||||
throw new Error(
|
|
||||||
'fetch is not available. Please provide a fetch implementation in the constructor options.'
|
|
||||||
);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Register a new peer and receive credentials
|
|
||||||
* Generates a cryptographically random peer ID (128-bit)
|
|
||||||
* @throws Error if registration fails
|
|
||||||
*/
|
|
||||||
async register(): Promise<Credentials> {
|
|
||||||
const response = await this.fetchFn(`${this.baseUrl}/register`, {
|
|
||||||
method: 'POST',
|
|
||||||
headers: {
|
|
||||||
'Content-Type': 'application/json',
|
|
||||||
},
|
|
||||||
body: JSON.stringify({}),
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
const error = await response.json().catch(() => ({ error: 'Unknown error' }));
|
|
||||||
throw new Error(`Registration failed: ${error.error || response.statusText}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
const data = await response.json();
|
|
||||||
return {
|
|
||||||
peerId: data.peerId,
|
|
||||||
secret: data.secret,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create Authorization header value
|
|
||||||
*/
|
|
||||||
static createAuthHeader(credentials: Credentials): string {
|
|
||||||
return `Bearer ${credentials.peerId}:${credentials.secret}`;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
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
|
||||||
|
}
|
||||||
276
src/discovery.ts
276
src/discovery.ts
@@ -1,276 +0,0 @@
|
|||||||
import RondevuPeer from './peer/index.js';
|
|
||||||
import { RondevuOffers } from './offers.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Service info from discovery
|
|
||||||
*/
|
|
||||||
export interface ServiceInfo {
|
|
||||||
uuid: string;
|
|
||||||
isPublic: boolean;
|
|
||||||
serviceFqn?: string;
|
|
||||||
metadata?: Record<string, any>;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Service list result
|
|
||||||
*/
|
|
||||||
export interface ServiceListResult {
|
|
||||||
username: string;
|
|
||||||
services: ServiceInfo[];
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Service query result
|
|
||||||
*/
|
|
||||||
export interface ServiceQueryResult {
|
|
||||||
uuid: string;
|
|
||||||
allowed: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Service details
|
|
||||||
*/
|
|
||||||
export interface ServiceDetails {
|
|
||||||
serviceId: string;
|
|
||||||
username: string;
|
|
||||||
serviceFqn: string;
|
|
||||||
offerId: string;
|
|
||||||
sdp: string;
|
|
||||||
isPublic: boolean;
|
|
||||||
metadata?: Record<string, any>;
|
|
||||||
createdAt: number;
|
|
||||||
expiresAt: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Connect result
|
|
||||||
*/
|
|
||||||
export interface ConnectResult {
|
|
||||||
peer: RondevuPeer;
|
|
||||||
channel: RTCDataChannel;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Rondevu Discovery API
|
|
||||||
* Handles service discovery and connections
|
|
||||||
*/
|
|
||||||
export class RondevuDiscovery {
|
|
||||||
private offersApi: RondevuOffers;
|
|
||||||
|
|
||||||
constructor(
|
|
||||||
private baseUrl: string,
|
|
||||||
private credentials: { peerId: string; secret: string }
|
|
||||||
) {
|
|
||||||
this.offersApi = new RondevuOffers(baseUrl, credentials);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Lists all services for a username
|
|
||||||
* Returns UUIDs only for private services, full details for public
|
|
||||||
*/
|
|
||||||
async listServices(username: string): Promise<ServiceListResult> {
|
|
||||||
const response = await fetch(`${this.baseUrl}/usernames/${username}/services`);
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
throw new Error('Failed to list services');
|
|
||||||
}
|
|
||||||
|
|
||||||
const data = await response.json();
|
|
||||||
|
|
||||||
return {
|
|
||||||
username: data.username,
|
|
||||||
services: data.services
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Queries a service by FQN
|
|
||||||
* Returns UUID if service exists and is allowed
|
|
||||||
*/
|
|
||||||
async queryService(username: string, serviceFqn: string): Promise<ServiceQueryResult> {
|
|
||||||
const response = await fetch(`${this.baseUrl}/index/${username}/query`, {
|
|
||||||
method: 'POST',
|
|
||||||
headers: { 'Content-Type': 'application/json' },
|
|
||||||
body: JSON.stringify({ serviceFqn })
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
const error = await response.json();
|
|
||||||
throw new Error(error.error || 'Service not found');
|
|
||||||
}
|
|
||||||
|
|
||||||
const data = await response.json();
|
|
||||||
|
|
||||||
return {
|
|
||||||
uuid: data.uuid,
|
|
||||||
allowed: data.allowed
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Gets service details by UUID
|
|
||||||
*/
|
|
||||||
async getServiceDetails(uuid: string): Promise<ServiceDetails> {
|
|
||||||
const response = await fetch(`${this.baseUrl}/services/${uuid}`);
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
const error = await response.json();
|
|
||||||
throw new Error(error.error || 'Service not found');
|
|
||||||
}
|
|
||||||
|
|
||||||
const data = await response.json();
|
|
||||||
|
|
||||||
return {
|
|
||||||
serviceId: data.serviceId,
|
|
||||||
username: data.username,
|
|
||||||
serviceFqn: data.serviceFqn,
|
|
||||||
offerId: data.offerId,
|
|
||||||
sdp: data.sdp,
|
|
||||||
isPublic: data.isPublic,
|
|
||||||
metadata: data.metadata,
|
|
||||||
createdAt: data.createdAt,
|
|
||||||
expiresAt: data.expiresAt
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Connects to a service by UUID
|
|
||||||
*/
|
|
||||||
async connectToService(
|
|
||||||
uuid: string,
|
|
||||||
options?: {
|
|
||||||
rtcConfig?: RTCConfiguration;
|
|
||||||
onConnected?: () => void;
|
|
||||||
onData?: (data: any) => void;
|
|
||||||
}
|
|
||||||
): Promise<RondevuPeer> {
|
|
||||||
// Get service details
|
|
||||||
const service = await this.getServiceDetails(uuid);
|
|
||||||
|
|
||||||
// Create peer with the offer
|
|
||||||
const peer = new RondevuPeer(
|
|
||||||
this.offersApi,
|
|
||||||
options?.rtcConfig || {
|
|
||||||
iceServers: [{ urls: 'stun:stun.l.google.com:19302' }]
|
|
||||||
}
|
|
||||||
);
|
|
||||||
|
|
||||||
// Set up event handlers
|
|
||||||
if (options?.onConnected) {
|
|
||||||
peer.on('connected', options.onConnected);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (options?.onData) {
|
|
||||||
peer.on('datachannel', (channel: RTCDataChannel) => {
|
|
||||||
channel.onmessage = (e) => options.onData!(e.data);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// Answer the offer
|
|
||||||
await peer.answer(service.offerId, service.sdp, {
|
|
||||||
topics: [], // V2 doesn't use topics
|
|
||||||
rtcConfig: options?.rtcConfig
|
|
||||||
});
|
|
||||||
|
|
||||||
return peer;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Convenience method: Query and connect in one call
|
|
||||||
* Returns both peer and data channel
|
|
||||||
*/
|
|
||||||
async connect(
|
|
||||||
username: string,
|
|
||||||
serviceFqn: string,
|
|
||||||
options?: {
|
|
||||||
rtcConfig?: RTCConfiguration;
|
|
||||||
}
|
|
||||||
): Promise<ConnectResult> {
|
|
||||||
// Query service
|
|
||||||
const query = await this.queryService(username, serviceFqn);
|
|
||||||
|
|
||||||
if (!query.allowed) {
|
|
||||||
throw new Error('Service access denied');
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get service details
|
|
||||||
const service = await this.getServiceDetails(query.uuid);
|
|
||||||
|
|
||||||
// Create peer
|
|
||||||
const peer = new RondevuPeer(
|
|
||||||
this.offersApi,
|
|
||||||
options?.rtcConfig || {
|
|
||||||
iceServers: [{ urls: 'stun:stun.l.google.com:19302' }]
|
|
||||||
}
|
|
||||||
);
|
|
||||||
|
|
||||||
// Answer the offer
|
|
||||||
await peer.answer(service.offerId, service.sdp, {
|
|
||||||
topics: [], // V2 doesn't use topics
|
|
||||||
rtcConfig: options?.rtcConfig
|
|
||||||
});
|
|
||||||
|
|
||||||
// Wait for data channel
|
|
||||||
const channel = await new Promise<RTCDataChannel>((resolve, reject) => {
|
|
||||||
const timeout = setTimeout(() => {
|
|
||||||
reject(new Error('Timeout waiting for data channel'));
|
|
||||||
}, 30000);
|
|
||||||
|
|
||||||
peer.on('datachannel', (ch: RTCDataChannel) => {
|
|
||||||
clearTimeout(timeout);
|
|
||||||
resolve(ch);
|
|
||||||
});
|
|
||||||
|
|
||||||
peer.on('failed', (error: Error) => {
|
|
||||||
clearTimeout(timeout);
|
|
||||||
reject(error);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
return { peer, channel };
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Convenience method: Connect to service by UUID with channel
|
|
||||||
*/
|
|
||||||
async connectByUuid(
|
|
||||||
uuid: string,
|
|
||||||
options?: { rtcConfig?: RTCConfiguration }
|
|
||||||
): Promise<ConnectResult> {
|
|
||||||
// Get service details
|
|
||||||
const service = await this.getServiceDetails(uuid);
|
|
||||||
|
|
||||||
// Create peer
|
|
||||||
const peer = new RondevuPeer(
|
|
||||||
this.offersApi,
|
|
||||||
options?.rtcConfig || {
|
|
||||||
iceServers: [{ urls: 'stun:stun.l.google.com:19302' }]
|
|
||||||
}
|
|
||||||
);
|
|
||||||
|
|
||||||
// Answer the offer
|
|
||||||
await peer.answer(service.offerId, service.sdp, {
|
|
||||||
topics: [], // V2 doesn't use topics
|
|
||||||
rtcConfig: options?.rtcConfig
|
|
||||||
});
|
|
||||||
|
|
||||||
// Wait for data channel
|
|
||||||
const channel = await new Promise<RTCDataChannel>((resolve, reject) => {
|
|
||||||
const timeout = setTimeout(() => {
|
|
||||||
reject(new Error('Timeout waiting for data channel'));
|
|
||||||
}, 30000);
|
|
||||||
|
|
||||||
peer.on('datachannel', (ch: RTCDataChannel) => {
|
|
||||||
clearTimeout(timeout);
|
|
||||||
resolve(ch);
|
|
||||||
});
|
|
||||||
|
|
||||||
peer.on('failed', (error: Error) => {
|
|
||||||
clearTimeout(timeout);
|
|
||||||
reject(error);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
return { peer, channel };
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,109 +0,0 @@
|
|||||||
/**
|
|
||||||
* Type-safe EventEmitter implementation for browser and Node.js compatibility
|
|
||||||
*
|
|
||||||
* @template EventMap - A type mapping event names to their handler signatures
|
|
||||||
*
|
|
||||||
* @example
|
|
||||||
* ```typescript
|
|
||||||
* interface MyEvents {
|
|
||||||
* 'data': (value: string) => void;
|
|
||||||
* 'error': (error: Error) => void;
|
|
||||||
* 'ready': () => void;
|
|
||||||
* }
|
|
||||||
*
|
|
||||||
* class MyClass extends EventEmitter<MyEvents> {
|
|
||||||
* doSomething() {
|
|
||||||
* this.emit('data', 'hello'); // Type-safe!
|
|
||||||
* this.emit('error', new Error('oops')); // Type-safe!
|
|
||||||
* this.emit('ready'); // Type-safe!
|
|
||||||
* }
|
|
||||||
* }
|
|
||||||
*
|
|
||||||
* const instance = new MyClass();
|
|
||||||
* instance.on('data', (value) => {
|
|
||||||
* console.log(value.toUpperCase()); // 'value' is typed as string
|
|
||||||
* });
|
|
||||||
* ```
|
|
||||||
*/
|
|
||||||
export class EventEmitter<EventMap extends Record<string, (...args: any[]) => void>> {
|
|
||||||
private events: Map<keyof EventMap, Set<Function>> = new Map();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Register an event listener
|
|
||||||
*/
|
|
||||||
on<K extends keyof EventMap>(event: K, listener: EventMap[K]): 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<K extends keyof EventMap>(event: K, listener: EventMap[K]): this {
|
|
||||||
const onceWrapper = (...args: Parameters<EventMap[K]>) => {
|
|
||||||
this.off(event, onceWrapper as EventMap[K]);
|
|
||||||
listener(...args);
|
|
||||||
};
|
|
||||||
return this.on(event, onceWrapper as EventMap[K]);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Remove an event listener
|
|
||||||
*/
|
|
||||||
off<K extends keyof EventMap>(event: K, listener: EventMap[K]): 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
|
|
||||||
*/
|
|
||||||
protected emit<K extends keyof EventMap>(
|
|
||||||
event: K,
|
|
||||||
...args: Parameters<EventMap[K]>
|
|
||||||
): boolean {
|
|
||||||
const listeners = this.events.get(event);
|
|
||||||
if (!listeners || listeners.size === 0) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
listeners.forEach(listener => {
|
|
||||||
try {
|
|
||||||
(listener as EventMap[K])(...args);
|
|
||||||
} catch (err) {
|
|
||||||
console.error(`Error in ${String(event)} event listener:`, err);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Remove all listeners for an event (or all events if not specified)
|
|
||||||
*/
|
|
||||||
removeAllListeners<K extends keyof EventMap>(event?: K): this {
|
|
||||||
if (event !== undefined) {
|
|
||||||
this.events.delete(event);
|
|
||||||
} else {
|
|
||||||
this.events.clear();
|
|
||||||
}
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get listener count for an event
|
|
||||||
*/
|
|
||||||
listenerCount<K extends keyof EventMap>(event: K): number {
|
|
||||||
const listeners = this.events.get(event);
|
|
||||||
return listeners ? listeners.size : 0;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
67
src/index.ts
67
src/index.ts
@@ -1,54 +1,39 @@
|
|||||||
/**
|
/**
|
||||||
* @xtr-dev/rondevu-client
|
* @xtr-dev/rondevu-client
|
||||||
* WebRTC peer signaling and discovery client with topic-based discovery
|
* WebRTC peer signaling client
|
||||||
*/
|
*/
|
||||||
|
|
||||||
// Export main client class
|
export { Rondevu } from './rondevu.js'
|
||||||
export { Rondevu } from './rondevu.js';
|
export { RondevuAPI } from './api.js'
|
||||||
export type { RondevuOptions } from './rondevu.js';
|
export { RpcBatcher } from './rpc-batcher.js'
|
||||||
|
|
||||||
// Export authentication
|
// Export crypto adapters
|
||||||
export { RondevuAuth } from './auth.js';
|
export { WebCryptoAdapter } from './web-crypto-adapter.js'
|
||||||
export type { Credentials, FetchFunction } from './auth.js';
|
export { NodeCryptoAdapter } from './node-crypto-adapter.js'
|
||||||
|
|
||||||
// Export offers API
|
// Export types
|
||||||
export { RondevuOffers } from './offers.js';
|
|
||||||
export type {
|
export type {
|
||||||
CreateOfferRequest,
|
Signaler,
|
||||||
Offer,
|
Binnable,
|
||||||
IceCandidate,
|
} from './types.js'
|
||||||
TopicInfo
|
|
||||||
} from './offers.js';
|
|
||||||
|
|
||||||
// Export peer manager
|
|
||||||
export { default as RondevuPeer } from './peer/index.js';
|
|
||||||
export type {
|
export type {
|
||||||
PeerOptions,
|
Keypair,
|
||||||
PeerEvents,
|
OfferRequest,
|
||||||
PeerTimeouts
|
ServiceRequest,
|
||||||
} from './peer/index.js';
|
Service,
|
||||||
|
ServiceOffer,
|
||||||
|
IceCandidate,
|
||||||
|
} from './api.js'
|
||||||
|
|
||||||
// Export username API
|
|
||||||
export { RondevuUsername } from './usernames.js';
|
|
||||||
export type { UsernameClaimResult, UsernameCheckResult } from './usernames.js';
|
|
||||||
|
|
||||||
// Export services API
|
|
||||||
export { RondevuServices } from './services.js';
|
|
||||||
export type {
|
export type {
|
||||||
ServicePublishResult,
|
RondevuOptions,
|
||||||
PublishServiceOptions,
|
PublishServiceOptions,
|
||||||
ServiceHandle
|
ConnectToServiceOptions,
|
||||||
} from './services.js';
|
ConnectionContext,
|
||||||
|
OfferContext,
|
||||||
|
OfferFactory
|
||||||
|
} from './rondevu.js'
|
||||||
|
|
||||||
// Export discovery API
|
export type { CryptoAdapter } from './crypto-adapter.js'
|
||||||
export { RondevuDiscovery } from './discovery.js';
|
|
||||||
export type {
|
|
||||||
ServiceInfo,
|
|
||||||
ServiceListResult,
|
|
||||||
ServiceQueryResult,
|
|
||||||
ServiceDetails,
|
|
||||||
ConnectResult
|
|
||||||
} from './discovery.js';
|
|
||||||
|
|
||||||
// Export pool types
|
|
||||||
export type { PoolStatus, PooledServiceHandle } from './service-pool.js';
|
|
||||||
|
|||||||
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))
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,174 +0,0 @@
|
|||||||
import { RondevuOffers, Offer } from './offers.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Represents an offer that has been answered
|
|
||||||
*/
|
|
||||||
export interface AnsweredOffer {
|
|
||||||
offerId: string;
|
|
||||||
answererId: string;
|
|
||||||
sdp: string;
|
|
||||||
answeredAt: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Configuration options for the offer pool
|
|
||||||
*/
|
|
||||||
export interface OfferPoolOptions {
|
|
||||||
/** Number of simultaneous open offers to maintain */
|
|
||||||
poolSize: number;
|
|
||||||
|
|
||||||
/** Polling interval in milliseconds (default: 2000ms) */
|
|
||||||
pollingInterval?: number;
|
|
||||||
|
|
||||||
/** Callback invoked when an offer is answered */
|
|
||||||
onAnswered: (answer: AnsweredOffer) => Promise<void>;
|
|
||||||
|
|
||||||
/** Callback to create new offers when refilling the pool */
|
|
||||||
onRefill: (count: number) => Promise<Offer[]>;
|
|
||||||
|
|
||||||
/** Error handler for pool operations */
|
|
||||||
onError: (error: Error, context: string) => void;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Manages a pool of offers with automatic polling and refill
|
|
||||||
*
|
|
||||||
* The OfferPool maintains a configurable number of simultaneous offers,
|
|
||||||
* polls for answers periodically, and automatically refills the pool
|
|
||||||
* when offers are consumed.
|
|
||||||
*/
|
|
||||||
export class OfferPool {
|
|
||||||
private offers: Map<string, Offer> = new Map();
|
|
||||||
private polling: boolean = false;
|
|
||||||
private pollingTimer?: ReturnType<typeof setInterval>;
|
|
||||||
private lastPollTime: number = 0;
|
|
||||||
private readonly pollingInterval: number;
|
|
||||||
|
|
||||||
constructor(
|
|
||||||
private offersApi: RondevuOffers,
|
|
||||||
private options: OfferPoolOptions
|
|
||||||
) {
|
|
||||||
this.pollingInterval = options.pollingInterval || 2000;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Add offers to the pool
|
|
||||||
*/
|
|
||||||
async addOffers(offers: Offer[]): Promise<void> {
|
|
||||||
for (const offer of offers) {
|
|
||||||
this.offers.set(offer.id, offer);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Start polling for answers
|
|
||||||
*/
|
|
||||||
async start(): Promise<void> {
|
|
||||||
if (this.polling) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
this.polling = true;
|
|
||||||
|
|
||||||
// Do an immediate poll
|
|
||||||
await this.poll().catch((error) => {
|
|
||||||
this.options.onError(error, 'initial-poll');
|
|
||||||
});
|
|
||||||
|
|
||||||
// Start polling interval
|
|
||||||
this.pollingTimer = setInterval(async () => {
|
|
||||||
if (this.polling) {
|
|
||||||
await this.poll().catch((error) => {
|
|
||||||
this.options.onError(error, 'poll');
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}, this.pollingInterval);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Stop polling for answers
|
|
||||||
*/
|
|
||||||
async stop(): Promise<void> {
|
|
||||||
this.polling = false;
|
|
||||||
|
|
||||||
if (this.pollingTimer) {
|
|
||||||
clearInterval(this.pollingTimer);
|
|
||||||
this.pollingTimer = undefined;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Poll for answers and refill the pool if needed
|
|
||||||
*/
|
|
||||||
private async poll(): Promise<void> {
|
|
||||||
try {
|
|
||||||
// Get all answers from server
|
|
||||||
const answers = await this.offersApi.getAnswers();
|
|
||||||
|
|
||||||
// Filter for our pool's offers
|
|
||||||
const myAnswers = answers.filter(a => this.offers.has(a.offerId));
|
|
||||||
|
|
||||||
// Process each answer
|
|
||||||
for (const answer of myAnswers) {
|
|
||||||
// Notify ServicePool
|
|
||||||
await this.options.onAnswered({
|
|
||||||
offerId: answer.offerId,
|
|
||||||
answererId: answer.answererId,
|
|
||||||
sdp: answer.sdp,
|
|
||||||
answeredAt: answer.answeredAt
|
|
||||||
});
|
|
||||||
|
|
||||||
// Remove consumed offer from pool
|
|
||||||
this.offers.delete(answer.offerId);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Immediate refill if below pool size
|
|
||||||
if (this.offers.size < this.options.poolSize) {
|
|
||||||
const needed = this.options.poolSize - this.offers.size;
|
|
||||||
|
|
||||||
try {
|
|
||||||
const newOffers = await this.options.onRefill(needed);
|
|
||||||
await this.addOffers(newOffers);
|
|
||||||
} catch (refillError) {
|
|
||||||
this.options.onError(
|
|
||||||
refillError as Error,
|
|
||||||
'refill'
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
this.lastPollTime = Date.now();
|
|
||||||
} catch (error) {
|
|
||||||
// Don't crash the pool on errors - let error handler deal with it
|
|
||||||
this.options.onError(error as Error, 'poll');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the current number of active offers in the pool
|
|
||||||
*/
|
|
||||||
getActiveOfferCount(): number {
|
|
||||||
return this.offers.size;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get all active offer IDs
|
|
||||||
*/
|
|
||||||
getActiveOfferIds(): string[] {
|
|
||||||
return Array.from(this.offers.keys());
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the last poll timestamp
|
|
||||||
*/
|
|
||||||
getLastPollTime(): number {
|
|
||||||
return this.lastPollTime;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Check if the pool is currently polling
|
|
||||||
*/
|
|
||||||
isPolling(): boolean {
|
|
||||||
return this.polling;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
321
src/offers.ts
321
src/offers.ts
@@ -1,321 +0,0 @@
|
|||||||
import { Credentials, FetchFunction } from './auth.js';
|
|
||||||
import { RondevuAuth } from './auth.js';
|
|
||||||
|
|
||||||
// Declare Buffer for Node.js compatibility
|
|
||||||
declare const Buffer: any;
|
|
||||||
|
|
||||||
export interface CreateOfferRequest {
|
|
||||||
sdp: string;
|
|
||||||
topics: string[];
|
|
||||||
ttl?: number;
|
|
||||||
secret?: string;
|
|
||||||
info?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface Offer {
|
|
||||||
id: string;
|
|
||||||
peerId: string;
|
|
||||||
sdp: string;
|
|
||||||
topics: string[];
|
|
||||||
createdAt?: number;
|
|
||||||
expiresAt: number;
|
|
||||||
lastSeen: number;
|
|
||||||
secret?: string;
|
|
||||||
hasSecret?: boolean;
|
|
||||||
info?: string;
|
|
||||||
answererPeerId?: string;
|
|
||||||
answerSdp?: string;
|
|
||||||
answeredAt?: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface IceCandidate {
|
|
||||||
candidate: any; // Full candidate object as plain JSON - don't enforce structure
|
|
||||||
peerId: string;
|
|
||||||
role: 'offerer' | 'answerer';
|
|
||||||
createdAt: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface TopicInfo {
|
|
||||||
topic: string;
|
|
||||||
activePeers: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
export class RondevuOffers {
|
|
||||||
private fetchFn: FetchFunction;
|
|
||||||
|
|
||||||
constructor(
|
|
||||||
private baseUrl: string,
|
|
||||||
private credentials: Credentials,
|
|
||||||
fetchFn?: FetchFunction
|
|
||||||
) {
|
|
||||||
// Use provided fetch or fall back to global fetch
|
|
||||||
this.fetchFn = fetchFn || ((...args) => {
|
|
||||||
if (typeof globalThis.fetch === 'function') {
|
|
||||||
return globalThis.fetch(...args);
|
|
||||||
}
|
|
||||||
throw new Error(
|
|
||||||
'fetch is not available. Please provide a fetch implementation in the constructor options.'
|
|
||||||
);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create one or more offers
|
|
||||||
*/
|
|
||||||
async create(offers: CreateOfferRequest[]): Promise<Offer[]> {
|
|
||||||
const response = await this.fetchFn(`${this.baseUrl}/offers`, {
|
|
||||||
method: 'POST',
|
|
||||||
headers: {
|
|
||||||
'Content-Type': 'application/json',
|
|
||||||
Authorization: RondevuAuth.createAuthHeader(this.credentials),
|
|
||||||
},
|
|
||||||
body: JSON.stringify({ offers }),
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
const error = await response.json().catch(() => ({ error: 'Unknown error' }));
|
|
||||||
throw new Error(`Failed to create offers: ${error.error || response.statusText}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
const data = await response.json();
|
|
||||||
return data.offers;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Find offers by topic with optional bloom filter
|
|
||||||
*/
|
|
||||||
async findByTopic(
|
|
||||||
topic: string,
|
|
||||||
options?: {
|
|
||||||
bloomFilter?: Uint8Array;
|
|
||||||
limit?: number;
|
|
||||||
}
|
|
||||||
): Promise<Offer[]> {
|
|
||||||
const params = new URLSearchParams();
|
|
||||||
|
|
||||||
if (options?.bloomFilter) {
|
|
||||||
// Convert to base64
|
|
||||||
const binaryString = String.fromCharCode(...Array.from(options.bloomFilter));
|
|
||||||
const base64 = typeof btoa !== 'undefined'
|
|
||||||
? btoa(binaryString)
|
|
||||||
: (typeof Buffer !== 'undefined' ? Buffer.from(options.bloomFilter).toString('base64') : '');
|
|
||||||
params.set('bloom', base64);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (options?.limit) {
|
|
||||||
params.set('limit', options.limit.toString());
|
|
||||||
}
|
|
||||||
|
|
||||||
const url = `${this.baseUrl}/offers/by-topic/${encodeURIComponent(topic)}${
|
|
||||||
params.toString() ? '?' + params.toString() : ''
|
|
||||||
}`;
|
|
||||||
|
|
||||||
const response = await this.fetchFn(url, {
|
|
||||||
method: 'GET',
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
const error = await response.json().catch(() => ({ error: 'Unknown error' }));
|
|
||||||
throw new Error(`Failed to find offers: ${error.error || response.statusText}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
const data = await response.json();
|
|
||||||
return data.offers;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get all offers from a specific peer
|
|
||||||
*/
|
|
||||||
async getByPeerId(peerId: string): Promise<{
|
|
||||||
offers: Offer[];
|
|
||||||
topics: string[];
|
|
||||||
}> {
|
|
||||||
const response = await this.fetchFn(`${this.baseUrl}/peers/${encodeURIComponent(peerId)}/offers`, {
|
|
||||||
method: 'GET',
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
const error = await response.json().catch(() => ({ error: 'Unknown error' }));
|
|
||||||
throw new Error(`Failed to get peer offers: ${error.error || response.statusText}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
return await response.json();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get topics with active peer counts (paginated)
|
|
||||||
*/
|
|
||||||
async getTopics(options?: {
|
|
||||||
limit?: number;
|
|
||||||
offset?: number;
|
|
||||||
startsWith?: string;
|
|
||||||
}): Promise<{
|
|
||||||
topics: TopicInfo[];
|
|
||||||
total: number;
|
|
||||||
limit: number;
|
|
||||||
offset: number;
|
|
||||||
startsWith?: string;
|
|
||||||
}> {
|
|
||||||
const params = new URLSearchParams();
|
|
||||||
|
|
||||||
if (options?.limit) {
|
|
||||||
params.set('limit', options.limit.toString());
|
|
||||||
}
|
|
||||||
|
|
||||||
if (options?.offset) {
|
|
||||||
params.set('offset', options.offset.toString());
|
|
||||||
}
|
|
||||||
|
|
||||||
if (options?.startsWith) {
|
|
||||||
params.set('startsWith', options.startsWith);
|
|
||||||
}
|
|
||||||
|
|
||||||
const url = `${this.baseUrl}/topics${
|
|
||||||
params.toString() ? '?' + params.toString() : ''
|
|
||||||
}`;
|
|
||||||
|
|
||||||
const response = await this.fetchFn(url, {
|
|
||||||
method: 'GET',
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
const error = await response.json().catch(() => ({ error: 'Unknown error' }));
|
|
||||||
throw new Error(`Failed to get topics: ${error.error || response.statusText}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
return await response.json();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get own offers
|
|
||||||
*/
|
|
||||||
async getMine(): Promise<Offer[]> {
|
|
||||||
const response = await this.fetchFn(`${this.baseUrl}/offers/mine`, {
|
|
||||||
method: 'GET',
|
|
||||||
headers: {
|
|
||||||
Authorization: RondevuAuth.createAuthHeader(this.credentials),
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
const error = await response.json().catch(() => ({ error: 'Unknown error' }));
|
|
||||||
throw new Error(`Failed to get own offers: ${error.error || response.statusText}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
const data = await response.json();
|
|
||||||
return data.offers;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Delete an offer
|
|
||||||
*/
|
|
||||||
async delete(offerId: string): Promise<void> {
|
|
||||||
const response = await this.fetchFn(`${this.baseUrl}/offers/${encodeURIComponent(offerId)}`, {
|
|
||||||
method: 'DELETE',
|
|
||||||
headers: {
|
|
||||||
Authorization: RondevuAuth.createAuthHeader(this.credentials),
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
const error = await response.json().catch(() => ({ error: 'Unknown error' }));
|
|
||||||
throw new Error(`Failed to delete offer: ${error.error || response.statusText}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Answer an offer
|
|
||||||
*/
|
|
||||||
async answer(offerId: string, sdp: string, secret?: string): Promise<void> {
|
|
||||||
const response = await this.fetchFn(`${this.baseUrl}/offers/${encodeURIComponent(offerId)}/answer`, {
|
|
||||||
method: 'POST',
|
|
||||||
headers: {
|
|
||||||
'Content-Type': 'application/json',
|
|
||||||
Authorization: RondevuAuth.createAuthHeader(this.credentials),
|
|
||||||
},
|
|
||||||
body: JSON.stringify({ sdp, secret }),
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
const error = await response.json().catch(() => ({ error: 'Unknown error' }));
|
|
||||||
throw new Error(`Failed to answer offer: ${error.error || response.statusText}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get answers to your offers
|
|
||||||
*/
|
|
||||||
async getAnswers(): Promise<Array<{
|
|
||||||
offerId: string;
|
|
||||||
answererId: string;
|
|
||||||
sdp: string;
|
|
||||||
answeredAt: number;
|
|
||||||
topics: string[];
|
|
||||||
}>> {
|
|
||||||
const response = await this.fetchFn(`${this.baseUrl}/offers/answers`, {
|
|
||||||
method: 'GET',
|
|
||||||
headers: {
|
|
||||||
Authorization: RondevuAuth.createAuthHeader(this.credentials),
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
const error = await response.json().catch(() => ({ error: 'Unknown error' }));
|
|
||||||
throw new Error(`Failed to get answers: ${error.error || response.statusText}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
const data = await response.json();
|
|
||||||
return data.answers;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Post ICE candidates for an offer
|
|
||||||
*/
|
|
||||||
async addIceCandidates(
|
|
||||||
offerId: string,
|
|
||||||
candidates: any[]
|
|
||||||
): Promise<void> {
|
|
||||||
const response = await this.fetchFn(`${this.baseUrl}/offers/${encodeURIComponent(offerId)}/ice-candidates`, {
|
|
||||||
method: 'POST',
|
|
||||||
headers: {
|
|
||||||
'Content-Type': 'application/json',
|
|
||||||
Authorization: RondevuAuth.createAuthHeader(this.credentials),
|
|
||||||
},
|
|
||||||
body: JSON.stringify({ candidates }),
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
const error = await response.json().catch(() => ({ error: 'Unknown error' }));
|
|
||||||
throw new Error(`Failed to add ICE candidates: ${error.error || response.statusText}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get ICE candidates for an offer
|
|
||||||
*/
|
|
||||||
async getIceCandidates(offerId: string, since?: number): Promise<IceCandidate[]> {
|
|
||||||
const params = new URLSearchParams();
|
|
||||||
if (since !== undefined) {
|
|
||||||
params.set('since', since.toString());
|
|
||||||
}
|
|
||||||
|
|
||||||
const url = `${this.baseUrl}/offers/${encodeURIComponent(offerId)}/ice-candidates${
|
|
||||||
params.toString() ? '?' + params.toString() : ''
|
|
||||||
}`;
|
|
||||||
|
|
||||||
const response = await this.fetchFn(url, {
|
|
||||||
method: 'GET',
|
|
||||||
headers: {
|
|
||||||
Authorization: RondevuAuth.createAuthHeader(this.credentials),
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
const error = await response.json().catch(() => ({ error: 'Unknown error' }));
|
|
||||||
throw new Error(`Failed to get ICE candidates: ${error.error || response.statusText}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
const data = await response.json();
|
|
||||||
return data.candidates;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,49 +0,0 @@
|
|||||||
import { PeerState } from './state.js';
|
|
||||||
import type { PeerOptions } from './types.js';
|
|
||||||
import type RondevuPeer from './index.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Answering an offer and sending to server
|
|
||||||
*/
|
|
||||||
export class AnsweringState extends PeerState {
|
|
||||||
constructor(peer: RondevuPeer) {
|
|
||||||
super(peer);
|
|
||||||
}
|
|
||||||
|
|
||||||
get name() { return 'answering'; }
|
|
||||||
|
|
||||||
async answer(offerId: string, offerSdp: string, options: PeerOptions): Promise<void> {
|
|
||||||
try {
|
|
||||||
this.peer.role = 'answerer';
|
|
||||||
this.peer.offerId = offerId;
|
|
||||||
|
|
||||||
// Set remote description
|
|
||||||
await this.peer.pc.setRemoteDescription({
|
|
||||||
type: 'offer',
|
|
||||||
sdp: offerSdp
|
|
||||||
});
|
|
||||||
|
|
||||||
// Create answer
|
|
||||||
const answer = await this.peer.pc.createAnswer();
|
|
||||||
|
|
||||||
// Send answer to server BEFORE setLocalDescription
|
|
||||||
// This registers us as the answerer so ICE candidates will be accepted
|
|
||||||
await this.peer.offersApi.answer(offerId, answer.sdp!, options.secret);
|
|
||||||
|
|
||||||
// Enable trickle ICE - set up handler before ICE gathering starts
|
|
||||||
this.setupIceCandidateHandler();
|
|
||||||
|
|
||||||
// Set local description - ICE gathering starts here
|
|
||||||
// Server already knows we're the answerer, so candidates will be accepted
|
|
||||||
await this.peer.pc.setLocalDescription(answer);
|
|
||||||
|
|
||||||
// Transition to exchanging ICE
|
|
||||||
const { ExchangingIceState } = await import('./exchanging-ice-state.js');
|
|
||||||
this.peer.setState(new ExchangingIceState(this.peer, offerId, options));
|
|
||||||
} catch (error) {
|
|
||||||
const { FailedState } = await import('./failed-state.js');
|
|
||||||
this.peer.setState(new FailedState(this.peer, error as Error));
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
import { PeerState } from './state.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Closed state - connection has been terminated
|
|
||||||
*/
|
|
||||||
export class ClosedState extends PeerState {
|
|
||||||
get name() { return 'closed'; }
|
|
||||||
|
|
||||||
cleanup(): void {
|
|
||||||
this.peer.pc.close();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
import { PeerState } from './state.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Connected state - peer connection is established
|
|
||||||
*/
|
|
||||||
export class ConnectedState extends PeerState {
|
|
||||||
get name() { return 'connected'; }
|
|
||||||
|
|
||||||
cleanup(): void {
|
|
||||||
// Keep connection alive, but stop any polling
|
|
||||||
// The peer connection will handle disconnects via onconnectionstatechange
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,57 +0,0 @@
|
|||||||
import { PeerState } from './state.js';
|
|
||||||
import type { PeerOptions } from './types.js';
|
|
||||||
import type RondevuPeer from './index.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Creating offer and sending to server
|
|
||||||
*/
|
|
||||||
export class CreatingOfferState extends PeerState {
|
|
||||||
constructor(peer: RondevuPeer, private options: PeerOptions) {
|
|
||||||
super(peer);
|
|
||||||
}
|
|
||||||
|
|
||||||
get name() { return 'creating-offer'; }
|
|
||||||
|
|
||||||
async createOffer(options: PeerOptions): Promise<string> {
|
|
||||||
try {
|
|
||||||
this.peer.role = 'offerer';
|
|
||||||
|
|
||||||
// Create data channel if requested
|
|
||||||
if (options.createDataChannel !== false) {
|
|
||||||
const channel = this.peer.pc.createDataChannel(
|
|
||||||
options.dataChannelLabel || 'data'
|
|
||||||
);
|
|
||||||
this.peer.emitEvent('datachannel', channel);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Enable trickle ICE - set up handler before ICE gathering starts
|
|
||||||
// Handler will check this.peer.offerId before sending
|
|
||||||
this.setupIceCandidateHandler();
|
|
||||||
|
|
||||||
// Create WebRTC offer
|
|
||||||
const offer = await this.peer.pc.createOffer();
|
|
||||||
await this.peer.pc.setLocalDescription(offer); // ICE gathering starts here
|
|
||||||
|
|
||||||
// Send offer to server immediately (don't wait for ICE)
|
|
||||||
const offers = await this.peer.offersApi.create([{
|
|
||||||
sdp: offer.sdp!,
|
|
||||||
topics: options.topics,
|
|
||||||
ttl: options.ttl || 300000,
|
|
||||||
secret: options.secret
|
|
||||||
}]);
|
|
||||||
|
|
||||||
const offerId = offers[0].id;
|
|
||||||
this.peer.offerId = offerId; // Now handler can send candidates
|
|
||||||
|
|
||||||
// Transition to waiting for answer
|
|
||||||
const { WaitingForAnswerState } = await import('./waiting-for-answer-state.js');
|
|
||||||
this.peer.setState(new WaitingForAnswerState(this.peer, offerId, options));
|
|
||||||
|
|
||||||
return offerId;
|
|
||||||
} catch (error) {
|
|
||||||
const { FailedState } = await import('./failed-state.js');
|
|
||||||
this.peer.setState(new FailedState(this.peer, error as Error));
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,74 +0,0 @@
|
|||||||
import { PeerState } from './state.js';
|
|
||||||
import type { PeerOptions } from './types.js';
|
|
||||||
import type RondevuPeer from './index.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Exchanging ICE candidates and waiting for connection
|
|
||||||
*/
|
|
||||||
export class ExchangingIceState extends PeerState {
|
|
||||||
private pollingInterval?: ReturnType<typeof setInterval>;
|
|
||||||
private timeout?: ReturnType<typeof setTimeout>;
|
|
||||||
private lastIceTimestamp = 0;
|
|
||||||
|
|
||||||
constructor(
|
|
||||||
peer: RondevuPeer,
|
|
||||||
private offerId: string,
|
|
||||||
private options: PeerOptions
|
|
||||||
) {
|
|
||||||
super(peer);
|
|
||||||
this.startPolling();
|
|
||||||
}
|
|
||||||
|
|
||||||
get name() { return 'exchanging-ice'; }
|
|
||||||
|
|
||||||
private startPolling(): void {
|
|
||||||
const connectionTimeout = this.options.timeouts?.iceConnection || 30000;
|
|
||||||
|
|
||||||
this.timeout = setTimeout(async () => {
|
|
||||||
this.cleanup();
|
|
||||||
const { FailedState } = await import('./failed-state.js');
|
|
||||||
this.peer.setState(new FailedState(
|
|
||||||
this.peer,
|
|
||||||
new Error('ICE connection timeout')
|
|
||||||
));
|
|
||||||
}, connectionTimeout);
|
|
||||||
|
|
||||||
this.pollingInterval = setInterval(async () => {
|
|
||||||
try {
|
|
||||||
const candidates = await this.peer.offersApi.getIceCandidates(
|
|
||||||
this.offerId,
|
|
||||||
this.lastIceTimestamp
|
|
||||||
);
|
|
||||||
|
|
||||||
for (const cand of candidates) {
|
|
||||||
if (cand.candidate && cand.candidate.candidate && cand.candidate.candidate !== '') {
|
|
||||||
try {
|
|
||||||
await this.peer.pc.addIceCandidate(new this.peer.RTCIceCandidate(cand.candidate));
|
|
||||||
this.lastIceTimestamp = cand.createdAt;
|
|
||||||
} catch (err) {
|
|
||||||
console.warn('Failed to add ICE candidate:', err);
|
|
||||||
this.lastIceTimestamp = cand.createdAt;
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
this.lastIceTimestamp = cand.createdAt;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} catch (err) {
|
|
||||||
console.error('Error polling for ICE candidates:', err);
|
|
||||||
if (err instanceof Error && err.message.includes('not found')) {
|
|
||||||
this.cleanup();
|
|
||||||
const { FailedState } = await import('./failed-state.js');
|
|
||||||
this.peer.setState(new FailedState(
|
|
||||||
this.peer,
|
|
||||||
new Error('Offer expired or not found')
|
|
||||||
));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}, 1000);
|
|
||||||
}
|
|
||||||
|
|
||||||
cleanup(): void {
|
|
||||||
if (this.pollingInterval) clearInterval(this.pollingInterval);
|
|
||||||
if (this.timeout) clearTimeout(this.timeout);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
import { PeerState } from './state.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Failed state - connection attempt failed
|
|
||||||
*/
|
|
||||||
export class FailedState extends PeerState {
|
|
||||||
constructor(peer: any, private error: Error) {
|
|
||||||
super(peer);
|
|
||||||
peer.emitEvent('failed', error);
|
|
||||||
}
|
|
||||||
|
|
||||||
get name() { return 'failed'; }
|
|
||||||
|
|
||||||
cleanup(): void {
|
|
||||||
// Connection is failed, clean up resources
|
|
||||||
this.peer.pc.close();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
import { PeerState } from './state.js';
|
|
||||||
import type { PeerOptions } from './types.js';
|
|
||||||
|
|
||||||
export class IdleState extends PeerState {
|
|
||||||
get name() { return 'idle'; }
|
|
||||||
|
|
||||||
async createOffer(options: PeerOptions): Promise<string> {
|
|
||||||
const { CreatingOfferState } = await import('./creating-offer-state.js');
|
|
||||||
this.peer.setState(new CreatingOfferState(this.peer, options));
|
|
||||||
return this.peer.state.createOffer(options);
|
|
||||||
}
|
|
||||||
|
|
||||||
async answer(offerId: string, offerSdp: string, options: PeerOptions): Promise<void> {
|
|
||||||
const { AnsweringState } = await import('./answering-state.js');
|
|
||||||
this.peer.setState(new AnsweringState(this.peer));
|
|
||||||
return this.peer.state.answer(offerId, offerSdp, options);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,212 +0,0 @@
|
|||||||
import { RondevuOffers } from '../offers.js';
|
|
||||||
import { EventEmitter } from '../event-emitter.js';
|
|
||||||
import type { PeerOptions, PeerEvents } from './types.js';
|
|
||||||
import { PeerState } from './state.js';
|
|
||||||
import { IdleState } from './idle-state.js';
|
|
||||||
import { CreatingOfferState } from './creating-offer-state.js';
|
|
||||||
import { WaitingForAnswerState } from './waiting-for-answer-state.js';
|
|
||||||
import { AnsweringState } from './answering-state.js';
|
|
||||||
import { ExchangingIceState } from './exchanging-ice-state.js';
|
|
||||||
import { ConnectedState } from './connected-state.js';
|
|
||||||
import { FailedState } from './failed-state.js';
|
|
||||||
import { ClosedState } from './closed-state.js';
|
|
||||||
|
|
||||||
// Re-export types for external consumers
|
|
||||||
export type { PeerTimeouts, PeerOptions, PeerEvents } from './types.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* High-level WebRTC peer connection manager with state-based lifecycle
|
|
||||||
* Handles offer/answer exchange, ICE candidates, timeouts, and error recovery
|
|
||||||
*/
|
|
||||||
export default class RondevuPeer extends EventEmitter<PeerEvents> {
|
|
||||||
pc: RTCPeerConnection;
|
|
||||||
offersApi: RondevuOffers;
|
|
||||||
offerId?: string;
|
|
||||||
role?: 'offerer' | 'answerer';
|
|
||||||
|
|
||||||
// WebRTC polyfills for Node.js compatibility
|
|
||||||
RTCPeerConnection: typeof RTCPeerConnection;
|
|
||||||
RTCSessionDescription: typeof RTCSessionDescription;
|
|
||||||
RTCIceCandidate: typeof RTCIceCandidate;
|
|
||||||
|
|
||||||
private _state: PeerState;
|
|
||||||
|
|
||||||
// Event handler references for cleanup
|
|
||||||
private connectionStateChangeHandler?: () => void;
|
|
||||||
private dataChannelHandler?: (event: RTCDataChannelEvent) => void;
|
|
||||||
private trackHandler?: (event: RTCTrackEvent) => void;
|
|
||||||
private iceCandidateErrorHandler?: (event: Event) => void;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Current connection state name
|
|
||||||
*/
|
|
||||||
get stateName(): string {
|
|
||||||
return this._state.name;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Current state object (internal use)
|
|
||||||
*/
|
|
||||||
get state(): PeerState {
|
|
||||||
return this._state;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* RTCPeerConnection state
|
|
||||||
*/
|
|
||||||
get connectionState(): RTCPeerConnectionState {
|
|
||||||
return this.pc.connectionState;
|
|
||||||
}
|
|
||||||
|
|
||||||
constructor(
|
|
||||||
offersApi: RondevuOffers,
|
|
||||||
rtcConfig: RTCConfiguration = {
|
|
||||||
iceServers: [
|
|
||||||
{ urls: 'stun:stun.l.google.com:19302' },
|
|
||||||
{ urls: 'stun:stun1.l.google.com:19302' }
|
|
||||||
]
|
|
||||||
},
|
|
||||||
rtcPeerConnection?: typeof RTCPeerConnection,
|
|
||||||
rtcSessionDescription?: typeof RTCSessionDescription,
|
|
||||||
rtcIceCandidate?: typeof RTCIceCandidate
|
|
||||||
) {
|
|
||||||
super();
|
|
||||||
this.offersApi = offersApi;
|
|
||||||
|
|
||||||
// Use provided polyfills or fall back to globals
|
|
||||||
this.RTCPeerConnection = rtcPeerConnection || (typeof globalThis.RTCPeerConnection !== 'undefined'
|
|
||||||
? globalThis.RTCPeerConnection
|
|
||||||
: (() => {
|
|
||||||
throw new Error('RTCPeerConnection is not available. Please provide it in the Rondevu constructor options for Node.js environments.');
|
|
||||||
}) as any);
|
|
||||||
|
|
||||||
this.RTCSessionDescription = rtcSessionDescription || (typeof globalThis.RTCSessionDescription !== 'undefined'
|
|
||||||
? globalThis.RTCSessionDescription
|
|
||||||
: (() => {
|
|
||||||
throw new Error('RTCSessionDescription is not available. Please provide it in the Rondevu constructor options for Node.js environments.');
|
|
||||||
}) as any);
|
|
||||||
|
|
||||||
this.RTCIceCandidate = rtcIceCandidate || (typeof globalThis.RTCIceCandidate !== 'undefined'
|
|
||||||
? globalThis.RTCIceCandidate
|
|
||||||
: (() => {
|
|
||||||
throw new Error('RTCIceCandidate is not available. Please provide it in the Rondevu constructor options for Node.js environments.');
|
|
||||||
}) as any);
|
|
||||||
|
|
||||||
this.pc = new this.RTCPeerConnection(rtcConfig);
|
|
||||||
this._state = new IdleState(this);
|
|
||||||
|
|
||||||
this.setupPeerConnection();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set up peer connection event handlers
|
|
||||||
*/
|
|
||||||
private setupPeerConnection(): void {
|
|
||||||
this.connectionStateChangeHandler = () => {
|
|
||||||
switch (this.pc.connectionState) {
|
|
||||||
case 'connected':
|
|
||||||
this.setState(new ConnectedState(this));
|
|
||||||
this.emitEvent('connected');
|
|
||||||
break;
|
|
||||||
case 'disconnected':
|
|
||||||
this.emitEvent('disconnected');
|
|
||||||
break;
|
|
||||||
case 'failed':
|
|
||||||
this.setState(new FailedState(this, new Error('Connection failed')));
|
|
||||||
break;
|
|
||||||
case 'closed':
|
|
||||||
this.setState(new ClosedState(this));
|
|
||||||
this.emitEvent('disconnected');
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
this.pc.addEventListener('connectionstatechange', this.connectionStateChangeHandler);
|
|
||||||
|
|
||||||
this.dataChannelHandler = (event: RTCDataChannelEvent) => {
|
|
||||||
this.emitEvent('datachannel', event.channel);
|
|
||||||
};
|
|
||||||
this.pc.addEventListener('datachannel', this.dataChannelHandler);
|
|
||||||
|
|
||||||
this.trackHandler = (event: RTCTrackEvent) => {
|
|
||||||
this.emitEvent('track', event);
|
|
||||||
};
|
|
||||||
this.pc.addEventListener('track', this.trackHandler);
|
|
||||||
|
|
||||||
this.iceCandidateErrorHandler = (event: Event) => {
|
|
||||||
console.error('ICE candidate error:', event);
|
|
||||||
};
|
|
||||||
this.pc.addEventListener('icecandidateerror', this.iceCandidateErrorHandler);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set new state and emit state change event
|
|
||||||
*/
|
|
||||||
setState(newState: PeerState): void {
|
|
||||||
this._state.cleanup();
|
|
||||||
this._state = newState;
|
|
||||||
this.emitEvent('state', newState.name);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Emit event (exposed for PeerState classes)
|
|
||||||
* @internal
|
|
||||||
*/
|
|
||||||
emitEvent<K extends keyof PeerEvents>(
|
|
||||||
event: K,
|
|
||||||
...args: Parameters<PeerEvents[K]>
|
|
||||||
): void {
|
|
||||||
this.emit(event, ...args);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create an offer and advertise on topics
|
|
||||||
*/
|
|
||||||
async createOffer(options: PeerOptions): Promise<string> {
|
|
||||||
return this._state.createOffer(options);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Answer an existing offer
|
|
||||||
*/
|
|
||||||
async answer(offerId: string, offerSdp: string, options: PeerOptions): Promise<void> {
|
|
||||||
return this._state.answer(offerId, offerSdp, options);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Add a media track to the connection
|
|
||||||
*/
|
|
||||||
addTrack(track: MediaStreamTrack, ...streams: MediaStream[]): RTCRtpSender {
|
|
||||||
return this.pc.addTrack(track, ...streams);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a data channel for sending and receiving arbitrary data
|
|
||||||
* This should typically be called by the offerer before creating the offer
|
|
||||||
* The answerer will receive the channel via the 'datachannel' event
|
|
||||||
*/
|
|
||||||
createDataChannel(label: string, options?: RTCDataChannelInit): RTCDataChannel {
|
|
||||||
return this.pc.createDataChannel(label, options);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Close the connection and clean up
|
|
||||||
*/
|
|
||||||
async close(): Promise<void> {
|
|
||||||
// Remove RTCPeerConnection event listeners
|
|
||||||
if (this.connectionStateChangeHandler) {
|
|
||||||
this.pc.removeEventListener('connectionstatechange', this.connectionStateChangeHandler);
|
|
||||||
}
|
|
||||||
if (this.dataChannelHandler) {
|
|
||||||
this.pc.removeEventListener('datachannel', this.dataChannelHandler);
|
|
||||||
}
|
|
||||||
if (this.trackHandler) {
|
|
||||||
this.pc.removeEventListener('track', this.trackHandler);
|
|
||||||
}
|
|
||||||
if (this.iceCandidateErrorHandler) {
|
|
||||||
this.pc.removeEventListener('icecandidateerror', this.iceCandidateErrorHandler);
|
|
||||||
}
|
|
||||||
|
|
||||||
await this._state.close();
|
|
||||||
this.removeAllListeners();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,66 +0,0 @@
|
|||||||
import type { PeerOptions } from './types.js';
|
|
||||||
import type RondevuPeer from './index.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Base class for peer connection states
|
|
||||||
* Implements the State pattern for managing WebRTC connection lifecycle
|
|
||||||
*/
|
|
||||||
export abstract class PeerState {
|
|
||||||
protected iceCandidateHandler?: (event: RTCPeerConnectionIceEvent) => void;
|
|
||||||
|
|
||||||
constructor(protected peer: RondevuPeer) {}
|
|
||||||
|
|
||||||
abstract get name(): string;
|
|
||||||
|
|
||||||
async createOffer(options: PeerOptions): Promise<string> {
|
|
||||||
throw new Error(`Cannot create offer in ${this.name} state`);
|
|
||||||
}
|
|
||||||
|
|
||||||
async answer(offerId: string, offerSdp: string, options: PeerOptions): Promise<void> {
|
|
||||||
throw new Error(`Cannot answer in ${this.name} state`);
|
|
||||||
}
|
|
||||||
|
|
||||||
async handleAnswer(sdp: string): Promise<void> {
|
|
||||||
throw new Error(`Cannot handle answer in ${this.name} state`);
|
|
||||||
}
|
|
||||||
|
|
||||||
async handleIceCandidate(candidate: any): Promise<void> {
|
|
||||||
// ICE candidates can arrive in multiple states, so default is to add them
|
|
||||||
if (this.peer.pc.remoteDescription) {
|
|
||||||
await this.peer.pc.addIceCandidate(new this.peer.RTCIceCandidate(candidate));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Setup trickle ICE candidate handler
|
|
||||||
* Sends local ICE candidates to server as they are discovered
|
|
||||||
*/
|
|
||||||
protected setupIceCandidateHandler(): void {
|
|
||||||
this.iceCandidateHandler = async (event: RTCPeerConnectionIceEvent) => {
|
|
||||||
if (event.candidate && this.peer.offerId) {
|
|
||||||
const candidateData = event.candidate.toJSON();
|
|
||||||
if (candidateData.candidate && candidateData.candidate !== '') {
|
|
||||||
try {
|
|
||||||
await this.peer.offersApi.addIceCandidates(this.peer.offerId, [candidateData]);
|
|
||||||
} catch (err) {
|
|
||||||
console.error('Error sending ICE candidate:', err);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
};
|
|
||||||
this.peer.pc.addEventListener('icecandidate', this.iceCandidateHandler);
|
|
||||||
}
|
|
||||||
|
|
||||||
cleanup(): void {
|
|
||||||
// Clean up ICE candidate handler if it exists
|
|
||||||
if (this.iceCandidateHandler) {
|
|
||||||
this.peer.pc.removeEventListener('icecandidate', this.iceCandidateHandler);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async close(): Promise<void> {
|
|
||||||
this.cleanup();
|
|
||||||
const { ClosedState } = await import('./closed-state.js');
|
|
||||||
this.peer.setState(new ClosedState(this.peer));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,45 +0,0 @@
|
|||||||
/**
|
|
||||||
* Timeout configurations for different connection phases
|
|
||||||
*/
|
|
||||||
export interface PeerTimeouts {
|
|
||||||
/** Timeout for ICE gathering (default: 10000ms) */
|
|
||||||
iceGathering?: number;
|
|
||||||
/** Timeout for waiting for answer (default: 30000ms) */
|
|
||||||
waitingForAnswer?: number;
|
|
||||||
/** Timeout for creating answer (default: 10000ms) */
|
|
||||||
creatingAnswer?: number;
|
|
||||||
/** Timeout for ICE connection (default: 30000ms) */
|
|
||||||
iceConnection?: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Options for creating a peer connection
|
|
||||||
*/
|
|
||||||
export interface PeerOptions {
|
|
||||||
/** RTCConfiguration for the peer connection */
|
|
||||||
rtcConfig?: RTCConfiguration;
|
|
||||||
/** Topics to advertise this connection under */
|
|
||||||
topics: string[];
|
|
||||||
/** How long the offer should live (milliseconds) */
|
|
||||||
ttl?: number;
|
|
||||||
/** Optional secret to protect the offer (max 128 characters) */
|
|
||||||
secret?: string;
|
|
||||||
/** Whether to create a data channel automatically (for offerer) */
|
|
||||||
createDataChannel?: boolean;
|
|
||||||
/** Label for the automatically created data channel */
|
|
||||||
dataChannelLabel?: string;
|
|
||||||
/** Timeout configurations */
|
|
||||||
timeouts?: PeerTimeouts;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Events emitted by RondevuPeer
|
|
||||||
*/
|
|
||||||
export interface PeerEvents extends Record<string, (...args: any[]) => void> {
|
|
||||||
'state': (state: string) => void;
|
|
||||||
'connected': () => void;
|
|
||||||
'disconnected': () => void;
|
|
||||||
'failed': (error: Error) => void;
|
|
||||||
'datachannel': (channel: RTCDataChannel) => void;
|
|
||||||
'track': (event: RTCTrackEvent) => void;
|
|
||||||
}
|
|
||||||
@@ -1,78 +0,0 @@
|
|||||||
import { PeerState } from './state.js';
|
|
||||||
import type { PeerOptions } from './types.js';
|
|
||||||
import type RondevuPeer from './index.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Waiting for answer from another peer
|
|
||||||
*/
|
|
||||||
export class WaitingForAnswerState extends PeerState {
|
|
||||||
private pollingInterval?: ReturnType<typeof setInterval>;
|
|
||||||
private timeout?: ReturnType<typeof setTimeout>;
|
|
||||||
|
|
||||||
constructor(
|
|
||||||
peer: RondevuPeer,
|
|
||||||
private offerId: string,
|
|
||||||
private options: PeerOptions
|
|
||||||
) {
|
|
||||||
super(peer);
|
|
||||||
this.startPolling();
|
|
||||||
}
|
|
||||||
|
|
||||||
get name() { return 'waiting-for-answer'; }
|
|
||||||
|
|
||||||
private startPolling(): void {
|
|
||||||
const answerTimeout = this.options.timeouts?.waitingForAnswer || 30000;
|
|
||||||
|
|
||||||
this.timeout = setTimeout(async () => {
|
|
||||||
this.cleanup();
|
|
||||||
const { FailedState } = await import('./failed-state.js');
|
|
||||||
this.peer.setState(new FailedState(
|
|
||||||
this.peer,
|
|
||||||
new Error('Timeout waiting for answer')
|
|
||||||
));
|
|
||||||
}, answerTimeout);
|
|
||||||
|
|
||||||
this.pollingInterval = setInterval(async () => {
|
|
||||||
try {
|
|
||||||
const answers = await this.peer.offersApi.getAnswers();
|
|
||||||
const myAnswer = answers.find((a: any) => a.offerId === this.offerId);
|
|
||||||
|
|
||||||
if (myAnswer) {
|
|
||||||
this.cleanup();
|
|
||||||
await this.handleAnswer(myAnswer.sdp);
|
|
||||||
}
|
|
||||||
} catch (err) {
|
|
||||||
console.error('Error polling for answers:', err);
|
|
||||||
if (err instanceof Error && err.message.includes('not found')) {
|
|
||||||
this.cleanup();
|
|
||||||
const { FailedState } = await import('./failed-state.js');
|
|
||||||
this.peer.setState(new FailedState(
|
|
||||||
this.peer,
|
|
||||||
new Error('Offer expired or not found')
|
|
||||||
));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}, 2000);
|
|
||||||
}
|
|
||||||
|
|
||||||
async handleAnswer(sdp: string): Promise<void> {
|
|
||||||
try {
|
|
||||||
await this.peer.pc.setRemoteDescription({
|
|
||||||
type: 'answer',
|
|
||||||
sdp
|
|
||||||
});
|
|
||||||
|
|
||||||
// Transition to exchanging ICE
|
|
||||||
const { ExchangingIceState } = await import('./exchanging-ice-state.js');
|
|
||||||
this.peer.setState(new ExchangingIceState(this.peer, this.offerId, this.options));
|
|
||||||
} catch (error) {
|
|
||||||
const { FailedState } = await import('./failed-state.js');
|
|
||||||
this.peer.setState(new FailedState(this.peer, error as Error));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
cleanup(): void {
|
|
||||||
if (this.pollingInterval) clearInterval(this.pollingInterval);
|
|
||||||
if (this.timeout) clearTimeout(this.timeout);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
1047
src/rondevu.ts
1047
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 = []
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,490 +0,0 @@
|
|||||||
import { RondevuOffers, Offer } from './offers.js';
|
|
||||||
import { RondevuUsername } from './usernames.js';
|
|
||||||
import RondevuPeer from './peer/index.js';
|
|
||||||
import { OfferPool, AnsweredOffer } from './offer-pool.js';
|
|
||||||
import { ServiceHandle } from './services.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Connection information for tracking active connections
|
|
||||||
*/
|
|
||||||
interface ConnectionInfo {
|
|
||||||
peer: RondevuPeer;
|
|
||||||
channel: RTCDataChannel;
|
|
||||||
connectedAt: number;
|
|
||||||
offerId: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Status information about the pool
|
|
||||||
*/
|
|
||||||
export interface PoolStatus {
|
|
||||||
/** Number of active offers in the pool */
|
|
||||||
activeOffers: number;
|
|
||||||
|
|
||||||
/** Number of currently connected peers */
|
|
||||||
activeConnections: number;
|
|
||||||
|
|
||||||
/** Total number of connections handled since start */
|
|
||||||
totalConnectionsHandled: number;
|
|
||||||
|
|
||||||
/** Number of failed offer creation attempts */
|
|
||||||
failedOfferCreations: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Configuration options for a pooled service
|
|
||||||
*/
|
|
||||||
export interface ServicePoolOptions {
|
|
||||||
/** Username that owns the service */
|
|
||||||
username: string;
|
|
||||||
|
|
||||||
/** Private key for signing service operations */
|
|
||||||
privateKey: string;
|
|
||||||
|
|
||||||
/** Fully qualified service name (e.g., com.example.chat@1.0.0) */
|
|
||||||
serviceFqn: string;
|
|
||||||
|
|
||||||
/** WebRTC configuration */
|
|
||||||
rtcConfig?: RTCConfiguration;
|
|
||||||
|
|
||||||
/** Whether the service is publicly discoverable */
|
|
||||||
isPublic?: boolean;
|
|
||||||
|
|
||||||
/** Optional metadata for the service */
|
|
||||||
metadata?: Record<string, any>;
|
|
||||||
|
|
||||||
/** Time-to-live for offers in milliseconds */
|
|
||||||
ttl?: number;
|
|
||||||
|
|
||||||
/** Handler invoked for each new connection */
|
|
||||||
handler: (channel: RTCDataChannel, peer: RondevuPeer, connectionId: string) => void;
|
|
||||||
|
|
||||||
/** Number of simultaneous open offers to maintain (default: 1) */
|
|
||||||
poolSize?: number;
|
|
||||||
|
|
||||||
/** Polling interval in milliseconds (default: 2000ms) */
|
|
||||||
pollingInterval?: number;
|
|
||||||
|
|
||||||
/** Callback for pool status updates */
|
|
||||||
onPoolStatus?: (status: PoolStatus) => void;
|
|
||||||
|
|
||||||
/** Error handler for pool operations */
|
|
||||||
onError?: (error: Error, context: string) => void;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Extended service handle with pool-specific methods
|
|
||||||
*/
|
|
||||||
export interface PooledServiceHandle extends ServiceHandle {
|
|
||||||
/** Get current pool status */
|
|
||||||
getStatus: () => PoolStatus;
|
|
||||||
|
|
||||||
/** Manually add offers to the pool */
|
|
||||||
addOffers: (count: number) => Promise<void>;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Manages a pooled service with multiple concurrent connections
|
|
||||||
*
|
|
||||||
* ServicePool coordinates offer creation, answer polling, and connection
|
|
||||||
* management for services that need to handle multiple simultaneous connections.
|
|
||||||
*/
|
|
||||||
export class ServicePool {
|
|
||||||
private offerPool?: OfferPool;
|
|
||||||
private connections: Map<string, ConnectionInfo> = new Map();
|
|
||||||
private status: PoolStatus = {
|
|
||||||
activeOffers: 0,
|
|
||||||
activeConnections: 0,
|
|
||||||
totalConnectionsHandled: 0,
|
|
||||||
failedOfferCreations: 0
|
|
||||||
};
|
|
||||||
private serviceId?: string;
|
|
||||||
private uuid?: string;
|
|
||||||
private offersApi: RondevuOffers;
|
|
||||||
private usernameApi: RondevuUsername;
|
|
||||||
|
|
||||||
constructor(
|
|
||||||
private baseUrl: string,
|
|
||||||
private credentials: { peerId: string; secret: string },
|
|
||||||
private options: ServicePoolOptions
|
|
||||||
) {
|
|
||||||
this.offersApi = new RondevuOffers(baseUrl, credentials);
|
|
||||||
this.usernameApi = new RondevuUsername(baseUrl);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Start the pooled service
|
|
||||||
*/
|
|
||||||
async start(): Promise<PooledServiceHandle> {
|
|
||||||
const poolSize = this.options.poolSize || 1;
|
|
||||||
|
|
||||||
// 1. Create initial service (publishes first offer)
|
|
||||||
const service = await this.publishInitialService();
|
|
||||||
this.serviceId = service.serviceId;
|
|
||||||
this.uuid = service.uuid;
|
|
||||||
|
|
||||||
// 2. Create additional offers for pool (poolSize - 1)
|
|
||||||
const additionalOffers: Offer[] = [];
|
|
||||||
if (poolSize > 1) {
|
|
||||||
try {
|
|
||||||
const offers = await this.createOffers(poolSize - 1);
|
|
||||||
additionalOffers.push(...offers);
|
|
||||||
} catch (error) {
|
|
||||||
this.handleError(error as Error, 'initial-offer-creation');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// 3. Initialize OfferPool with all offers
|
|
||||||
this.offerPool = new OfferPool(this.offersApi, {
|
|
||||||
poolSize,
|
|
||||||
pollingInterval: this.options.pollingInterval || 2000,
|
|
||||||
onAnswered: (answer) => this.handleConnection(answer),
|
|
||||||
onRefill: (count) => this.createOffers(count),
|
|
||||||
onError: (err, ctx) => this.handleError(err, ctx)
|
|
||||||
});
|
|
||||||
|
|
||||||
// Add all offers to pool
|
|
||||||
const allOffers = [
|
|
||||||
{ id: service.offerId, peerId: this.credentials.peerId, sdp: '', topics: [], expiresAt: service.expiresAt, lastSeen: Date.now() },
|
|
||||||
...additionalOffers
|
|
||||||
];
|
|
||||||
await this.offerPool.addOffers(allOffers);
|
|
||||||
|
|
||||||
// 4. Start polling
|
|
||||||
await this.offerPool.start();
|
|
||||||
|
|
||||||
// Update status
|
|
||||||
this.updateStatus();
|
|
||||||
|
|
||||||
// 5. Return handle
|
|
||||||
return {
|
|
||||||
serviceId: this.serviceId,
|
|
||||||
uuid: this.uuid,
|
|
||||||
offerId: service.offerId,
|
|
||||||
unpublish: () => this.stop(),
|
|
||||||
getStatus: () => this.getStatus(),
|
|
||||||
addOffers: (count) => this.manualRefill(count)
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Stop the pooled service and clean up
|
|
||||||
*/
|
|
||||||
async stop(): Promise<void> {
|
|
||||||
// 1. Stop accepting new connections
|
|
||||||
if (this.offerPool) {
|
|
||||||
await this.offerPool.stop();
|
|
||||||
}
|
|
||||||
|
|
||||||
// 2. Delete remaining offers
|
|
||||||
if (this.offerPool) {
|
|
||||||
const offerIds = this.offerPool.getActiveOfferIds();
|
|
||||||
await Promise.allSettled(
|
|
||||||
offerIds.map(id => this.offersApi.delete(id).catch(() => {}))
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
// 3. Close active connections
|
|
||||||
const closePromises = Array.from(this.connections.values()).map(
|
|
||||||
async (conn) => {
|
|
||||||
try {
|
|
||||||
// Give a brief moment for graceful closure
|
|
||||||
await new Promise(resolve => setTimeout(resolve, 100));
|
|
||||||
conn.peer.pc.close();
|
|
||||||
} catch {
|
|
||||||
// Ignore errors during cleanup
|
|
||||||
}
|
|
||||||
}
|
|
||||||
);
|
|
||||||
await Promise.allSettled(closePromises);
|
|
||||||
|
|
||||||
// 4. Delete service if we have a serviceId
|
|
||||||
if (this.serviceId) {
|
|
||||||
try {
|
|
||||||
const response = await fetch(`${this.baseUrl}/services/${this.serviceId}`, {
|
|
||||||
method: 'DELETE',
|
|
||||||
headers: {
|
|
||||||
'Content-Type': 'application/json',
|
|
||||||
'Authorization': `Bearer ${this.credentials.peerId}:${this.credentials.secret}`
|
|
||||||
},
|
|
||||||
body: JSON.stringify({ username: this.options.username })
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
console.error('Failed to delete service:', await response.text());
|
|
||||||
}
|
|
||||||
} catch (error) {
|
|
||||||
console.error('Error deleting service:', error);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Clear all state
|
|
||||||
this.connections.clear();
|
|
||||||
this.offerPool = undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Handle an answered offer by setting up the connection
|
|
||||||
*/
|
|
||||||
private async handleConnection(answer: AnsweredOffer): Promise<void> {
|
|
||||||
const connectionId = this.generateConnectionId();
|
|
||||||
|
|
||||||
try {
|
|
||||||
// Create peer connection
|
|
||||||
const peer = new RondevuPeer(
|
|
||||||
this.offersApi,
|
|
||||||
this.options.rtcConfig || {
|
|
||||||
iceServers: [{ urls: 'stun:stun.l.google.com:19302' }]
|
|
||||||
}
|
|
||||||
);
|
|
||||||
|
|
||||||
peer.role = 'offerer';
|
|
||||||
peer.offerId = answer.offerId;
|
|
||||||
|
|
||||||
// Set remote description (the answer)
|
|
||||||
await peer.pc.setRemoteDescription({
|
|
||||||
type: 'answer',
|
|
||||||
sdp: answer.sdp
|
|
||||||
});
|
|
||||||
|
|
||||||
// Wait for data channel (answerer creates it, we receive it)
|
|
||||||
const channel = await new Promise<RTCDataChannel>((resolve, reject) => {
|
|
||||||
const timeout = setTimeout(
|
|
||||||
() => reject(new Error('Timeout waiting for data channel')),
|
|
||||||
30000
|
|
||||||
);
|
|
||||||
|
|
||||||
peer.on('datachannel', (ch: RTCDataChannel) => {
|
|
||||||
clearTimeout(timeout);
|
|
||||||
resolve(ch);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Also check if channel already exists
|
|
||||||
if (peer.pc.ondatachannel) {
|
|
||||||
const existingHandler = peer.pc.ondatachannel;
|
|
||||||
peer.pc.ondatachannel = (event) => {
|
|
||||||
clearTimeout(timeout);
|
|
||||||
resolve(event.channel);
|
|
||||||
if (existingHandler) existingHandler.call(peer.pc, event);
|
|
||||||
};
|
|
||||||
} else {
|
|
||||||
peer.pc.ondatachannel = (event) => {
|
|
||||||
clearTimeout(timeout);
|
|
||||||
resolve(event.channel);
|
|
||||||
};
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// Register connection
|
|
||||||
this.connections.set(connectionId, {
|
|
||||||
peer,
|
|
||||||
channel,
|
|
||||||
connectedAt: Date.now(),
|
|
||||||
offerId: answer.offerId
|
|
||||||
});
|
|
||||||
|
|
||||||
this.status.activeConnections++;
|
|
||||||
this.status.totalConnectionsHandled++;
|
|
||||||
|
|
||||||
// Setup cleanup on disconnect
|
|
||||||
peer.on('disconnected', () => {
|
|
||||||
this.connections.delete(connectionId);
|
|
||||||
this.status.activeConnections--;
|
|
||||||
this.updateStatus();
|
|
||||||
});
|
|
||||||
|
|
||||||
peer.on('failed', () => {
|
|
||||||
this.connections.delete(connectionId);
|
|
||||||
this.status.activeConnections--;
|
|
||||||
this.updateStatus();
|
|
||||||
});
|
|
||||||
|
|
||||||
// Update status
|
|
||||||
this.updateStatus();
|
|
||||||
|
|
||||||
// Invoke user handler (wrapped in try-catch)
|
|
||||||
try {
|
|
||||||
this.options.handler(channel, peer, connectionId);
|
|
||||||
} catch (handlerError) {
|
|
||||||
this.handleError(handlerError as Error, 'handler');
|
|
||||||
}
|
|
||||||
|
|
||||||
} catch (error) {
|
|
||||||
this.handleError(error as Error, 'connection-setup');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create multiple offers
|
|
||||||
*/
|
|
||||||
private async createOffers(count: number): Promise<Offer[]> {
|
|
||||||
if (count <= 0) {
|
|
||||||
return [];
|
|
||||||
}
|
|
||||||
|
|
||||||
// Server supports max 10 offers per request
|
|
||||||
const batchSize = Math.min(count, 10);
|
|
||||||
const offers: Offer[] = [];
|
|
||||||
|
|
||||||
try {
|
|
||||||
// Create peer connections and generate offers
|
|
||||||
const offerRequests = [];
|
|
||||||
for (let i = 0; i < batchSize; i++) {
|
|
||||||
const pc = new RTCPeerConnection(this.options.rtcConfig || {
|
|
||||||
iceServers: [{ urls: 'stun:stun.l.google.com:19302' }]
|
|
||||||
});
|
|
||||||
|
|
||||||
// Create data channel (required for offers)
|
|
||||||
pc.createDataChannel('rondevu-service');
|
|
||||||
|
|
||||||
// Create offer
|
|
||||||
const offer = await pc.createOffer();
|
|
||||||
await pc.setLocalDescription(offer);
|
|
||||||
|
|
||||||
if (!offer.sdp) {
|
|
||||||
pc.close();
|
|
||||||
throw new Error('Failed to generate SDP');
|
|
||||||
}
|
|
||||||
|
|
||||||
offerRequests.push({
|
|
||||||
sdp: offer.sdp,
|
|
||||||
topics: [], // V2 doesn't use topics
|
|
||||||
ttl: this.options.ttl
|
|
||||||
});
|
|
||||||
|
|
||||||
// Close the PC immediately - we only needed the SDP
|
|
||||||
pc.close();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Batch create offers
|
|
||||||
const createdOffers = await this.offersApi.create(offerRequests);
|
|
||||||
offers.push(...createdOffers);
|
|
||||||
|
|
||||||
} catch (error) {
|
|
||||||
this.status.failedOfferCreations++;
|
|
||||||
this.handleError(error as Error, 'offer-creation');
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
|
|
||||||
return offers;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Publish the initial service (creates first offer)
|
|
||||||
*/
|
|
||||||
private async publishInitialService(): Promise<{
|
|
||||||
serviceId: string;
|
|
||||||
uuid: string;
|
|
||||||
offerId: string;
|
|
||||||
expiresAt: number;
|
|
||||||
}> {
|
|
||||||
const { username, privateKey, serviceFqn, rtcConfig, isPublic, metadata, ttl } = this.options;
|
|
||||||
|
|
||||||
// Create peer connection for initial offer
|
|
||||||
const pc = new RTCPeerConnection(rtcConfig || {
|
|
||||||
iceServers: [{ urls: 'stun:stun.l.google.com:19302' }]
|
|
||||||
});
|
|
||||||
|
|
||||||
pc.createDataChannel('rondevu-service');
|
|
||||||
|
|
||||||
// Create offer
|
|
||||||
const offer = await pc.createOffer();
|
|
||||||
await pc.setLocalDescription(offer);
|
|
||||||
|
|
||||||
if (!offer.sdp) {
|
|
||||||
pc.close();
|
|
||||||
throw new Error('Failed to generate SDP');
|
|
||||||
}
|
|
||||||
|
|
||||||
// Create signature
|
|
||||||
const timestamp = Date.now();
|
|
||||||
const message = `publish:${username}:${serviceFqn}:${timestamp}`;
|
|
||||||
const signature = await this.usernameApi.signMessage(message, privateKey);
|
|
||||||
|
|
||||||
// Publish service
|
|
||||||
const response = await fetch(`${this.baseUrl}/services`, {
|
|
||||||
method: 'POST',
|
|
||||||
headers: {
|
|
||||||
'Content-Type': 'application/json',
|
|
||||||
'Authorization': `Bearer ${this.credentials.peerId}:${this.credentials.secret}`
|
|
||||||
},
|
|
||||||
body: JSON.stringify({
|
|
||||||
username,
|
|
||||||
serviceFqn,
|
|
||||||
sdp: offer.sdp,
|
|
||||||
ttl,
|
|
||||||
isPublic,
|
|
||||||
metadata,
|
|
||||||
signature,
|
|
||||||
message
|
|
||||||
})
|
|
||||||
});
|
|
||||||
|
|
||||||
pc.close();
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
const error = await response.json();
|
|
||||||
throw new Error(error.error || 'Failed to publish service');
|
|
||||||
}
|
|
||||||
|
|
||||||
const data = await response.json();
|
|
||||||
|
|
||||||
return {
|
|
||||||
serviceId: data.serviceId,
|
|
||||||
uuid: data.uuid,
|
|
||||||
offerId: data.offerId,
|
|
||||||
expiresAt: data.expiresAt
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Manually add offers to the pool
|
|
||||||
*/
|
|
||||||
private async manualRefill(count: number): Promise<void> {
|
|
||||||
if (!this.offerPool) {
|
|
||||||
throw new Error('Pool not started');
|
|
||||||
}
|
|
||||||
|
|
||||||
const offers = await this.createOffers(count);
|
|
||||||
await this.offerPool.addOffers(offers);
|
|
||||||
this.updateStatus();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get current pool status
|
|
||||||
*/
|
|
||||||
private getStatus(): PoolStatus {
|
|
||||||
return { ...this.status };
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Update status and notify listeners
|
|
||||||
*/
|
|
||||||
private updateStatus(): void {
|
|
||||||
if (this.offerPool) {
|
|
||||||
this.status.activeOffers = this.offerPool.getActiveOfferCount();
|
|
||||||
}
|
|
||||||
|
|
||||||
if (this.options.onPoolStatus) {
|
|
||||||
this.options.onPoolStatus(this.getStatus());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Handle errors
|
|
||||||
*/
|
|
||||||
private handleError(error: Error, context: string): void {
|
|
||||||
if (this.options.onError) {
|
|
||||||
this.options.onError(error, context);
|
|
||||||
} else {
|
|
||||||
console.error(`ServicePool error (${context}):`, error);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Generate a unique connection ID
|
|
||||||
*/
|
|
||||||
private generateConnectionId(): string {
|
|
||||||
return `conn-${Date.now()}-${Math.random().toString(36).substr(2, 9)}`;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
308
src/services.ts
308
src/services.ts
@@ -1,308 +0,0 @@
|
|||||||
import { RondevuUsername } from './usernames.js';
|
|
||||||
import RondevuPeer from './peer/index.js';
|
|
||||||
import { RondevuOffers } from './offers.js';
|
|
||||||
import { ServicePool, ServicePoolOptions, PooledServiceHandle, PoolStatus } from './service-pool.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Service publish result
|
|
||||||
*/
|
|
||||||
export interface ServicePublishResult {
|
|
||||||
serviceId: string;
|
|
||||||
uuid: string;
|
|
||||||
offerId: string;
|
|
||||||
expiresAt: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Service publish options
|
|
||||||
*/
|
|
||||||
export interface PublishServiceOptions {
|
|
||||||
username: string;
|
|
||||||
privateKey: string;
|
|
||||||
serviceFqn: string;
|
|
||||||
rtcConfig?: RTCConfiguration;
|
|
||||||
isPublic?: boolean;
|
|
||||||
metadata?: Record<string, any>;
|
|
||||||
ttl?: number;
|
|
||||||
onConnection?: (peer: RondevuPeer) => void;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Service handle for managing an exposed service
|
|
||||||
*/
|
|
||||||
export interface ServiceHandle {
|
|
||||||
serviceId: string;
|
|
||||||
uuid: string;
|
|
||||||
offerId: string;
|
|
||||||
unpublish: () => Promise<void>;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Rondevu Services API
|
|
||||||
* Handles service publishing and management
|
|
||||||
*/
|
|
||||||
export class RondevuServices {
|
|
||||||
private usernameApi: RondevuUsername;
|
|
||||||
private offersApi: RondevuOffers;
|
|
||||||
|
|
||||||
constructor(
|
|
||||||
private baseUrl: string,
|
|
||||||
private credentials: { peerId: string; secret: string }
|
|
||||||
) {
|
|
||||||
this.usernameApi = new RondevuUsername(baseUrl);
|
|
||||||
this.offersApi = new RondevuOffers(baseUrl, credentials);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Publishes a service
|
|
||||||
*/
|
|
||||||
async publishService(options: PublishServiceOptions): Promise<ServicePublishResult> {
|
|
||||||
const {
|
|
||||||
username,
|
|
||||||
privateKey,
|
|
||||||
serviceFqn,
|
|
||||||
rtcConfig,
|
|
||||||
isPublic = false,
|
|
||||||
metadata,
|
|
||||||
ttl
|
|
||||||
} = options;
|
|
||||||
|
|
||||||
// Validate FQN format
|
|
||||||
this.validateServiceFqn(serviceFqn);
|
|
||||||
|
|
||||||
// Create WebRTC peer connection to generate offer
|
|
||||||
const pc = new RTCPeerConnection(rtcConfig || {
|
|
||||||
iceServers: [{ urls: 'stun:stun.l.google.com:19302' }]
|
|
||||||
});
|
|
||||||
|
|
||||||
// Add a data channel (required for datachannel-based services)
|
|
||||||
pc.createDataChannel('rondevu-service');
|
|
||||||
|
|
||||||
// Create offer
|
|
||||||
const offer = await pc.createOffer();
|
|
||||||
await pc.setLocalDescription(offer);
|
|
||||||
|
|
||||||
if (!offer.sdp) {
|
|
||||||
throw new Error('Failed to generate SDP');
|
|
||||||
}
|
|
||||||
|
|
||||||
// Create signature for username verification
|
|
||||||
const timestamp = Date.now();
|
|
||||||
const message = `publish:${username}:${serviceFqn}:${timestamp}`;
|
|
||||||
const signature = await this.usernameApi.signMessage(message, privateKey);
|
|
||||||
|
|
||||||
// Publish service
|
|
||||||
const response = await fetch(`${this.baseUrl}/services`, {
|
|
||||||
method: 'POST',
|
|
||||||
headers: {
|
|
||||||
'Content-Type': 'application/json',
|
|
||||||
'Authorization': `Bearer ${this.credentials.peerId}:${this.credentials.secret}`
|
|
||||||
},
|
|
||||||
body: JSON.stringify({
|
|
||||||
username,
|
|
||||||
serviceFqn,
|
|
||||||
sdp: offer.sdp,
|
|
||||||
ttl,
|
|
||||||
isPublic,
|
|
||||||
metadata,
|
|
||||||
signature,
|
|
||||||
message
|
|
||||||
})
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
const error = await response.json();
|
|
||||||
pc.close();
|
|
||||||
throw new Error(error.error || 'Failed to publish service');
|
|
||||||
}
|
|
||||||
|
|
||||||
const data = await response.json();
|
|
||||||
|
|
||||||
// Close the connection for now (would be kept open in a real implementation)
|
|
||||||
pc.close();
|
|
||||||
|
|
||||||
return {
|
|
||||||
serviceId: data.serviceId,
|
|
||||||
uuid: data.uuid,
|
|
||||||
offerId: data.offerId,
|
|
||||||
expiresAt: data.expiresAt
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Unpublishes a service
|
|
||||||
*/
|
|
||||||
async unpublishService(serviceId: string, username: string): Promise<void> {
|
|
||||||
const response = await fetch(`${this.baseUrl}/services/${serviceId}`, {
|
|
||||||
method: 'DELETE',
|
|
||||||
headers: {
|
|
||||||
'Content-Type': 'application/json',
|
|
||||||
'Authorization': `Bearer ${this.credentials.peerId}:${this.credentials.secret}`
|
|
||||||
},
|
|
||||||
body: JSON.stringify({ username })
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
const error = await response.json();
|
|
||||||
throw new Error(error.error || 'Failed to unpublish service');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Exposes a service with an automatic connection handler
|
|
||||||
* This is a convenience method that publishes the service and manages connections
|
|
||||||
*
|
|
||||||
* Set poolSize > 1 to enable offer pooling for handling multiple concurrent connections
|
|
||||||
*/
|
|
||||||
async exposeService(options: Omit<PublishServiceOptions, 'onConnection'> & {
|
|
||||||
handler: (channel: RTCDataChannel, peer: RondevuPeer, connectionId?: string) => void;
|
|
||||||
poolSize?: number;
|
|
||||||
pollingInterval?: number;
|
|
||||||
onPoolStatus?: (status: PoolStatus) => void;
|
|
||||||
onError?: (error: Error, context: string) => void;
|
|
||||||
}): Promise<ServiceHandle | PooledServiceHandle> {
|
|
||||||
const {
|
|
||||||
username,
|
|
||||||
privateKey,
|
|
||||||
serviceFqn,
|
|
||||||
rtcConfig,
|
|
||||||
isPublic,
|
|
||||||
metadata,
|
|
||||||
ttl,
|
|
||||||
handler,
|
|
||||||
poolSize,
|
|
||||||
pollingInterval,
|
|
||||||
onPoolStatus,
|
|
||||||
onError
|
|
||||||
} = options;
|
|
||||||
|
|
||||||
// If poolSize > 1, use pooled implementation
|
|
||||||
if (poolSize && poolSize > 1) {
|
|
||||||
const pool = new ServicePool(this.baseUrl, this.credentials, {
|
|
||||||
username,
|
|
||||||
privateKey,
|
|
||||||
serviceFqn,
|
|
||||||
rtcConfig,
|
|
||||||
isPublic,
|
|
||||||
metadata,
|
|
||||||
ttl,
|
|
||||||
handler: (channel, peer, connectionId) => handler(channel, peer, connectionId),
|
|
||||||
poolSize,
|
|
||||||
pollingInterval,
|
|
||||||
onPoolStatus,
|
|
||||||
onError
|
|
||||||
});
|
|
||||||
return await pool.start();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Otherwise, use existing single-offer logic (UNCHANGED)
|
|
||||||
// Validate FQN
|
|
||||||
this.validateServiceFqn(serviceFqn);
|
|
||||||
|
|
||||||
// Create peer connection
|
|
||||||
const pc = new RTCPeerConnection(rtcConfig || {
|
|
||||||
iceServers: [{ urls: 'stun:stun.l.google.com:19302' }]
|
|
||||||
});
|
|
||||||
|
|
||||||
// Create data channel
|
|
||||||
const channel = pc.createDataChannel('rondevu-service');
|
|
||||||
|
|
||||||
// Set up handler
|
|
||||||
channel.onopen = () => {
|
|
||||||
const peer = new RondevuPeer(
|
|
||||||
this.offersApi,
|
|
||||||
rtcConfig || {
|
|
||||||
iceServers: [{ urls: 'stun:stun.l.google.com:19302' }]
|
|
||||||
}
|
|
||||||
);
|
|
||||||
handler(channel, peer);
|
|
||||||
};
|
|
||||||
|
|
||||||
// Create offer
|
|
||||||
const offer = await pc.createOffer();
|
|
||||||
await pc.setLocalDescription(offer);
|
|
||||||
|
|
||||||
if (!offer.sdp) {
|
|
||||||
pc.close();
|
|
||||||
throw new Error('Failed to generate SDP');
|
|
||||||
}
|
|
||||||
|
|
||||||
// Create signature
|
|
||||||
const timestamp = Date.now();
|
|
||||||
const message = `publish:${username}:${serviceFqn}:${timestamp}`;
|
|
||||||
const signature = await this.usernameApi.signMessage(message, privateKey);
|
|
||||||
|
|
||||||
// Publish service
|
|
||||||
const response = await fetch(`${this.baseUrl}/services`, {
|
|
||||||
method: 'POST',
|
|
||||||
headers: {
|
|
||||||
'Content-Type': 'application/json',
|
|
||||||
'Authorization': `Bearer ${this.credentials.peerId}:${this.credentials.secret}`
|
|
||||||
},
|
|
||||||
body: JSON.stringify({
|
|
||||||
username,
|
|
||||||
serviceFqn,
|
|
||||||
sdp: offer.sdp,
|
|
||||||
ttl,
|
|
||||||
isPublic,
|
|
||||||
metadata,
|
|
||||||
signature,
|
|
||||||
message
|
|
||||||
})
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
const error = await response.json();
|
|
||||||
pc.close();
|
|
||||||
throw new Error(error.error || 'Failed to expose service');
|
|
||||||
}
|
|
||||||
|
|
||||||
const data = await response.json();
|
|
||||||
|
|
||||||
return {
|
|
||||||
serviceId: data.serviceId,
|
|
||||||
uuid: data.uuid,
|
|
||||||
offerId: data.offerId,
|
|
||||||
unpublish: () => this.unpublishService(data.serviceId, username)
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Validates service FQN format
|
|
||||||
*/
|
|
||||||
private validateServiceFqn(fqn: string): void {
|
|
||||||
const parts = fqn.split('@');
|
|
||||||
if (parts.length !== 2) {
|
|
||||||
throw new Error('Service FQN must be in format: service-name@version');
|
|
||||||
}
|
|
||||||
|
|
||||||
const [serviceName, version] = parts;
|
|
||||||
|
|
||||||
// Validate service name (reverse domain notation)
|
|
||||||
const serviceNameRegex = /^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)+$/;
|
|
||||||
if (!serviceNameRegex.test(serviceName)) {
|
|
||||||
throw new Error('Service name must be reverse domain notation (e.g., com.example.service)');
|
|
||||||
}
|
|
||||||
|
|
||||||
if (serviceName.length < 3 || serviceName.length > 128) {
|
|
||||||
throw new Error('Service name must be 3-128 characters');
|
|
||||||
}
|
|
||||||
|
|
||||||
// Validate version (semantic versioning)
|
|
||||||
const versionRegex = /^[0-9]+\.[0-9]+\.[0-9]+(-[a-z0-9.-]+)?$/;
|
|
||||||
if (!versionRegex.test(version)) {
|
|
||||||
throw new Error('Version must be semantic versioning (e.g., 1.0.0, 2.1.3-beta)');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Parses a service FQN into name and version
|
|
||||||
*/
|
|
||||||
parseServiceFqn(fqn: string): { name: string; version: string } {
|
|
||||||
const parts = fqn.split('@');
|
|
||||||
if (parts.length !== 2) {
|
|
||||||
throw new Error('Invalid FQN format');
|
|
||||||
}
|
|
||||||
return { name: parts[0], version: parts[1] };
|
|
||||||
}
|
|
||||||
}
|
|
||||||
20
src/types.ts
Normal file
20
src/types.ts
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
/**
|
||||||
|
* Core signaling types
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Cleanup function returned by listener methods
|
||||||
|
*/
|
||||||
|
export type Binnable = () => void
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Signaler interface for WebRTC offer/answer/ICE exchange
|
||||||
|
*/
|
||||||
|
export interface Signaler {
|
||||||
|
addIceCandidate(candidate: RTCIceCandidate): Promise<void>
|
||||||
|
addListener(callback: (candidate: RTCIceCandidate) => void): Binnable
|
||||||
|
addOfferListener(callback: (offer: RTCSessionDescriptionInit) => void): Binnable
|
||||||
|
addAnswerListener(callback: (answer: RTCSessionDescriptionInit) => void): Binnable
|
||||||
|
setOffer(offer: RTCSessionDescriptionInit): Promise<void>
|
||||||
|
setAnswer(answer: RTCSessionDescriptionInit): Promise<void>
|
||||||
|
}
|
||||||
200
src/usernames.ts
200
src/usernames.ts
@@ -1,200 +0,0 @@
|
|||||||
import * as ed25519 from '@noble/ed25519';
|
|
||||||
|
|
||||||
// Set SHA-512 hash function for ed25519 (required in @noble/ed25519 v3+)
|
|
||||||
// Uses built-in WebCrypto API which only provides async digest
|
|
||||||
// We use the async ed25519 functions (signAsync, verifyAsync, getPublicKeyAsync)
|
|
||||||
ed25519.hashes.sha512Async = async (message: Uint8Array) => {
|
|
||||||
return new Uint8Array(await crypto.subtle.digest('SHA-512', message as BufferSource));
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Username claim result
|
|
||||||
*/
|
|
||||||
export interface UsernameClaimResult {
|
|
||||||
username: string;
|
|
||||||
publicKey: string;
|
|
||||||
privateKey: string;
|
|
||||||
claimedAt: number;
|
|
||||||
expiresAt: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Username availability check result
|
|
||||||
*/
|
|
||||||
export interface UsernameCheckResult {
|
|
||||||
username: string;
|
|
||||||
available: boolean;
|
|
||||||
claimedAt?: number;
|
|
||||||
expiresAt?: number;
|
|
||||||
publicKey?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Convert Uint8Array to base64 string
|
|
||||||
*/
|
|
||||||
function bytesToBase64(bytes: Uint8Array): string {
|
|
||||||
const binString = Array.from(bytes, (byte) =>
|
|
||||||
String.fromCodePoint(byte)
|
|
||||||
).join('');
|
|
||||||
return btoa(binString);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Convert base64 string to Uint8Array
|
|
||||||
*/
|
|
||||||
function base64ToBytes(base64: string): Uint8Array {
|
|
||||||
const binString = atob(base64);
|
|
||||||
return Uint8Array.from(binString, (char) => char.codePointAt(0)!);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Rondevu Username API
|
|
||||||
* Handles username claiming with Ed25519 cryptographic proof
|
|
||||||
*/
|
|
||||||
export class RondevuUsername {
|
|
||||||
constructor(private baseUrl: string) {}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Generates an Ed25519 keypair for username claiming
|
|
||||||
*/
|
|
||||||
async generateKeypair(): Promise<{ publicKey: string; privateKey: string }> {
|
|
||||||
const privateKey = ed25519.utils.randomSecretKey();
|
|
||||||
const publicKey = await ed25519.getPublicKeyAsync(privateKey);
|
|
||||||
|
|
||||||
return {
|
|
||||||
publicKey: bytesToBase64(publicKey),
|
|
||||||
privateKey: bytesToBase64(privateKey)
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Signs a message with an Ed25519 private key
|
|
||||||
*/
|
|
||||||
async signMessage(message: string, privateKeyBase64: string): Promise<string> {
|
|
||||||
const privateKey = base64ToBytes(privateKeyBase64);
|
|
||||||
const encoder = new TextEncoder();
|
|
||||||
const messageBytes = encoder.encode(message);
|
|
||||||
|
|
||||||
const signature = await ed25519.signAsync(messageBytes, privateKey);
|
|
||||||
return bytesToBase64(signature);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Claims a username
|
|
||||||
* Generates a new keypair if one is not provided
|
|
||||||
*/
|
|
||||||
async claimUsername(
|
|
||||||
username: string,
|
|
||||||
existingKeypair?: { publicKey: string; privateKey: string }
|
|
||||||
): Promise<UsernameClaimResult> {
|
|
||||||
// Generate or use existing keypair
|
|
||||||
const keypair = existingKeypair || await this.generateKeypair();
|
|
||||||
|
|
||||||
// Create signed message
|
|
||||||
const timestamp = Date.now();
|
|
||||||
const message = `claim:${username}:${timestamp}`;
|
|
||||||
const signature = await this.signMessage(message, keypair.privateKey);
|
|
||||||
|
|
||||||
// Send claim request
|
|
||||||
const response = await fetch(`${this.baseUrl}/usernames/claim`, {
|
|
||||||
method: 'POST',
|
|
||||||
headers: { 'Content-Type': 'application/json' },
|
|
||||||
body: JSON.stringify({
|
|
||||||
username,
|
|
||||||
publicKey: keypair.publicKey,
|
|
||||||
signature,
|
|
||||||
message
|
|
||||||
})
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
const error = await response.json();
|
|
||||||
throw new Error(error.error || 'Failed to claim username');
|
|
||||||
}
|
|
||||||
|
|
||||||
const data = await response.json();
|
|
||||||
|
|
||||||
return {
|
|
||||||
username: data.username,
|
|
||||||
publicKey: keypair.publicKey,
|
|
||||||
privateKey: keypair.privateKey,
|
|
||||||
claimedAt: data.claimedAt,
|
|
||||||
expiresAt: data.expiresAt
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Checks if a username is available
|
|
||||||
*/
|
|
||||||
async checkUsername(username: string): Promise<UsernameCheckResult> {
|
|
||||||
const response = await fetch(`${this.baseUrl}/usernames/${username}`);
|
|
||||||
|
|
||||||
if (!response.ok) {
|
|
||||||
throw new Error('Failed to check username');
|
|
||||||
}
|
|
||||||
|
|
||||||
const data = await response.json();
|
|
||||||
|
|
||||||
return {
|
|
||||||
username: data.username,
|
|
||||||
available: data.available,
|
|
||||||
claimedAt: data.claimedAt,
|
|
||||||
expiresAt: data.expiresAt,
|
|
||||||
publicKey: data.publicKey
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Helper: Save keypair to localStorage
|
|
||||||
* WARNING: This stores the private key in localStorage which is not the most secure
|
|
||||||
* For production use, consider using IndexedDB with encryption or hardware security modules
|
|
||||||
*/
|
|
||||||
saveKeypairToStorage(username: string, publicKey: string, privateKey: string): void {
|
|
||||||
const data = { username, publicKey, privateKey, savedAt: Date.now() };
|
|
||||||
localStorage.setItem(`rondevu:keypair:${username}`, JSON.stringify(data));
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Helper: Load keypair from localStorage
|
|
||||||
*/
|
|
||||||
loadKeypairFromStorage(username: string): { publicKey: string; privateKey: string } | null {
|
|
||||||
const stored = localStorage.getItem(`rondevu:keypair:${username}`);
|
|
||||||
if (!stored) return null;
|
|
||||||
|
|
||||||
try {
|
|
||||||
const data = JSON.parse(stored);
|
|
||||||
return { publicKey: data.publicKey, privateKey: data.privateKey };
|
|
||||||
} catch {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Helper: Delete keypair from localStorage
|
|
||||||
*/
|
|
||||||
deleteKeypairFromStorage(username: string): void {
|
|
||||||
localStorage.removeItem(`rondevu:keypair:${username}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Export keypair as JSON string (for backup)
|
|
||||||
*/
|
|
||||||
exportKeypair(publicKey: string, privateKey: string): string {
|
|
||||||
return JSON.stringify({
|
|
||||||
publicKey,
|
|
||||||
privateKey,
|
|
||||||
exportedAt: Date.now()
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Import keypair from JSON string
|
|
||||||
*/
|
|
||||||
importKeypair(json: string): { publicKey: string; privateKey: string } {
|
|
||||||
const data = JSON.parse(json);
|
|
||||||
if (!data.publicKey || !data.privateKey) {
|
|
||||||
throw new Error('Invalid keypair format');
|
|
||||||
}
|
|
||||||
return { publicKey: data.publicKey, privateKey: data.privateKey };
|
|
||||||
}
|
|
||||||
}
|
|
||||||
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