xtr.dev/rondevu-client
1
0
Fork 0
mirror of https://github.com/xtr-dev/rondevu-client.git synced 2025-12-13 04:13:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove RondevuSignaler documentation and outdated files

Browse Source 
- Remove entire RondevuSignaler class documentation section
- Remove PollingConfig interface from Types section
- Delete obsolete USAGE.md file (completely outdated)
- Update all examples to use new automatic API
- Fix migration examples to show current publishService() format
This commit is contained in:
Bas van den Aakster
2025-12-12 22:43:48 +01:00
parent 43dfd72c3d
commit 4345709e9c
2 changed files with 13 additions and 388 deletions
Download Patch File Download Diff File Expand all files Collapse all files

120
README.md
View File

@@ -273,74 +273,6 @@ await rondevu.getOfferIceCandidates(
): Promise<{ candidates: IceCandidate[], offerId: string }> ): Promise<{ candidates: IceCandidate[], offerId: string }>
``` ```
### RondevuSignaler Class
Higher-level signaling abstraction with automatic polling and event listeners.
```typescript
import { RondevuSignaler } from '@xtr-dev/rondevu-client'
const signaler = new RondevuSignaler(
rondevu: Rondevu,
service: string, // Service FQN without username (e.g., 'chat:1.0.0')
host?: string, // Optional: target username for answerer
pollingConfig?: {
initialInterval?: number // Default: 500ms
maxInterval?: number // Default: 5000ms
backoffMultiplier?: number // Default: 1.5
maxRetries?: number // Default: 50
jitter?: boolean // Default: true
}
)
```
#### Offerer Side
```typescript
// Set offer (automatically starts polling for answer and ICE)
await signaler.setOffer(offer: RTCSessionDescriptionInit): Promise<void>
// Listen for answer
const unbind = signaler.addAnswerListener((answer) => {
console.log('Received answer:', answer)
})
// Listen for ICE candidates
signaler.addListener((candidate) => {
console.log('Received ICE candidate:', candidate)
})
// Send ICE candidate
await signaler.addIceCandidate(candidate: RTCIceCandidate): Promise<void>
```
#### Answerer Side
```typescript
// Listen for offer (automatically searches for service)
const unbind = signaler.addOfferListener((offer) => {
console.log('Received offer:', offer)
})
// Set answer (automatically starts polling for ICE)
await signaler.setAnswer(answer: RTCSessionDescriptionInit): Promise<void>
// Send ICE candidate
await signaler.addIceCandidate(candidate: RTCIceCandidate): Promise<void>
// Listen for ICE candidates
signaler.addListener((candidate) => {
console.log('Received ICE candidate:', candidate)
})
```
#### Cleanup
```typescript
// Stop all polling and cleanup
signaler.dispose(): void
```
### RondevuAPI Class ### RondevuAPI Class
Low-level HTTP API client (used internally by Rondevu class). Low-level HTTP API client (used internally by Rondevu class).
@@ -416,14 +348,6 @@ interface IceCandidate {
candidate: RTCIceCandidateInit candidate: RTCIceCandidateInit
createdAt: number createdAt: number
} }
interface PollingConfig {
initialInterval?: number // Default: 500ms
maxInterval?: number // Default: 5000ms
backoffMultiplier?: number // Default: 1.5
maxRetries?: number // Default: 50
jitter?: boolean // Default: true
}
``` ```
## Advanced Usage ## Advanced Usage
@@ -442,8 +366,10 @@ console.log(rondevu.getUsername()) // e.g., "anon-lx2w34-a3f501"
// Anonymous users behave exactly like regular users // Anonymous users behave exactly like regular users
await rondevu.publishService({ await rondevu.publishService({
service: 'chat:1.0.0', service: 'chat:1.0.0',
offers: [{ sdp: offerSdp }] maxOffers: 5
}) })
await rondevu.startFilling()
``` ```
### Persistent Keypair ### Persistent Keypair
@@ -510,23 +436,6 @@ const service = await rondevu.publishService({
console.log(`Published ${service.offers.length} offers`) console.log(`Published ${service.offers.length} offers`)
``` ```
### Custom Polling Configuration
```typescript
const signaler = new RondevuSignaler(
rondevu,
'chat:1.0.0',
'alice',
{
initialInterval: 1000, // Start at 1 second
maxInterval: 10000, // Max 10 seconds
backoffMultiplier: 2, // Double each time
maxRetries: 30, // Stop after 30 retries
jitter: true // Add randomness
}
)
```
## Platform Support ## Platform Support
### Modern Browsers ### Modern Browsers
@@ -588,14 +497,13 @@ const pc = new RTCPeerConnection(rtcConfig)
const dc = pc.createDataChannel('chat') const dc = pc.createDataChannel('chat')
// Publish service (username auto-claimed on first publish) // Publish service (username auto-claimed on first publish)
const offer = await pc.createOffer()
await pc.setLocalDescription(offer)
await rondevu.publishService({ await rondevu.publishService({
service: 'chat:1.0.0', service: 'chat:1.0.0',
offers: [{ sdp: offer.sdp }] maxOffers: 5
}) })
await rondevu.startFilling()
// Browser clients can now discover and connect to chat:1.0.0@mybot // Browser clients can now discover and connect to chat:1.0.0@mybot
``` ```
@@ -616,7 +524,8 @@ v0.4.0 removes high-level abstractions and uses manual WebRTC setup:
**Added:** **Added:**
- `pollOffers()` - Combined polling for answers and ICE candidates - `pollOffers()` - Combined polling for answers and ICE candidates
- `RondevuSignaler` - Simplified signaling with automatic polling - `publishService()` - Automatic offer pool management
- `connectToService()` - Automatic answering side setup
**Migration Example:** **Migration Example:**
@@ -628,16 +537,13 @@ const host = new ServiceHost({
}) })
await host.start() await host.start()
// After (v0.4.0) - Manual setup // After (v0.4.0+) - Automatic setup
const pc = new RTCPeerConnection()
const dc = pc.createDataChannel('chat')
const offer = await pc.createOffer()
await pc.setLocalDescription(offer)
await rondevu.publishService({ await rondevu.publishService({
serviceFqn: 'chat:1.0.0@alice', service: 'chat:1.0.0',
offers: [{ sdp: offer.sdp }] maxOffers: 5
}) })
await rondevu.startFilling()
``` ```
## License ## License

281
USAGE.md
View File

@@ -1,281 +0,0 @@
# Rondevu Client Usage Guide
## Installation
```bash
npm install @xtr-dev/rondevu-client
```
## Quick Start
### 1. Register and Create Connection
```typescript
import { RondevuAPI, RondevuSignaler, WebRTCRondevuConnection } from '@xtr-dev/rondevu-client';
const API_URL = 'https://api.ronde.vu';
// Register to get credentials
const api = new RondevuAPI(API_URL);
const credentials = await api.register();
// Create authenticated API client
const authenticatedApi = new RondevuAPI(API_URL, credentials);
```
### 2. Create an Offer (Offerer Side)
```typescript
// Create a connection
const connection = new WebRTCRondevuConnection(
'connection-id',
'host-username',
'service-name'
);
// Wait for local description
await connection.ready;
// Create offer on server
const offers = await authenticatedApi.createOffers([{
sdp: connection.connection.localDescription!.sdp!,
ttl: 300000 // 5 minutes
}]);
const offerId = offers[0].id;
// Set up signaler for ICE candidate exchange
const signaler = new RondevuSignaler(authenticatedApi, offerId);
connection.setSignaler(signaler);
// Poll for answer
const checkAnswer = setInterval(async () => {
const answer = await authenticatedApi.getAnswer(offerId);
if (answer) {
clearInterval(checkAnswer);
await connection.connection.setRemoteDescription({
type: 'answer',
sdp: answer.sdp
});
console.log('Connection established!');
}
}, 1000);
```
### 3. Answer an Offer (Answerer Side)
```typescript
// Get the offer
const offer = await authenticatedApi.getOffer(offerId);
// Create connection with remote offer
const connection = new WebRTCRondevuConnection(
'connection-id',
'peer-username',
'service-name',
{
type: 'offer',
sdp: offer.sdp
}
);
// Wait for local description (answer)
await connection.ready;
// Send answer to server
await authenticatedApi.answerOffer(
offerId,
connection.connection.localDescription!.sdp!
);
// Set up signaler for ICE candidate exchange
const signaler = new RondevuSignaler(authenticatedApi, offerId);
connection.setSignaler(signaler);
console.log('Connection established!');
```
## Using Services
### Publish a Service
```typescript
import { RondevuAPI } from '@xtr-dev/rondevu-client';
const api = new RondevuAPI(API_URL, credentials);
const service = await api.publishService({
username: 'my-username',
serviceFqn: 'chat.app@1.0.0',
sdp: localDescription.sdp,
ttl: 300000,
isPublic: true,
metadata: { description: 'My chat service' },
signature: '...', // Ed25519 signature
message: '...' // Signed message
});
console.log('Service UUID:', service.uuid);
```
### Connect to a Service
```typescript
// Search for services
const services = await api.searchServices('username', 'chat.app@1.0.0');
if (services.length > 0) {
// Get service details with offer
const service = await api.getService(services[0].uuid);
// Create connection with service offer
const connection = new WebRTCRondevuConnection(
service.serviceId,
service.username,
service.serviceFqn,
{
type: 'offer',
sdp: service.sdp
}
);
await connection.ready;
// Answer the service offer
await api.answerOffer(
service.offerId,
connection.connection.localDescription!.sdp!
);
// Set up signaler
const signaler = new RondevuSignaler(api, service.offerId);
connection.setSignaler(signaler);
}
```
## Event Handling
```typescript
import { EventBus } from '@xtr-dev/rondevu-client';
// Connection events
connection.events.on('state-change', (state) => {
console.log('Connection state:', state);
});
connection.events.on('message', (message) => {
console.log('Received message:', message);
});
// Custom events with EventBus
interface MyEvents {
'user:connected': { userId: string; timestamp: number };
'message:sent': string;
}
const events = new EventBus<MyEvents>();
events.on('user:connected', (data) => {
console.log(`User ${data.userId} connected at ${data.timestamp}`);
});
events.emit('user:connected', {
userId: '123',
timestamp: Date.now()
});
```
## Cleanup
```typescript
import { createBin } from '@xtr-dev/rondevu-client';
const bin = createBin();
// Add cleanup functions
bin(
() => console.log('Cleanup 1'),
() => console.log('Cleanup 2')
);
// Clean all
bin.clean();
```
## API Reference
### RondevuAPI
Complete API client for Rondevu signaling server.
**Methods:**
- `register()` - Register new peer
- `createOffers(offers)` - Create offers
- `getOffer(offerId)` - Get offer by ID
- `answerOffer(offerId, sdp)` - Answer an offer
- `getAnswer(offerId)` - Poll for answer
- `searchOffers(topic)` - Search by topic
- `addIceCandidates(offerId, candidates)` - Add ICE candidates
- `getIceCandidates(offerId, since)` - Get ICE candidates (polling)
- `publishService(service)` - Publish service
- `getService(uuid)` - Get service by UUID
- `searchServices(username, serviceFqn)` - Search services
- `checkUsername(username)` - Check availability
- `claimUsername(username, publicKey, signature, message)` - Claim username
### RondevuSignaler
Handles ICE candidate exchange via polling.
**Constructor:**
```typescript
new RondevuSignaler(api: RondevuAPI, offerId: string)
```
**Methods:**
- `addIceCandidate(candidate)` - Send local candidate
- `addListener(callback)` - Poll for remote candidates (returns cleanup function)
### WebRTCRondevuConnection
WebRTC connection wrapper with type-safe events.
**Constructor:**
```typescript
new WebRTCRondevuConnection(
id: string,
host: string,
service: string,
offer?: RTCSessionDescriptionInit
)
```
**Properties:**
- `id` - Connection ID
- `host` - Host username
- `service` - Service FQN
- `state` - Connection state
- `events` - EventBus for state changes and messages
- `ready` - Promise that resolves when local description is set
**Methods:**
- `setSignaler(signaler)` - Set signaler for ICE exchange
- `queueMessage(message, options)` - Queue message for sending
- `sendMessage(message)` - Send message immediately
### EventBus<TEvents>
Type-safe event emitter with inferred types.
**Methods:**
- `on(event, handler)` - Subscribe
- `once(event, handler)` - Subscribe once
- `off(event, handler)` - Unsubscribe
- `emit(event, data)` - Emit event
- `clear(event?)` - Clear handlers
- `listenerCount(event)` - Get listener count
- `eventNames()` - Get event names
## Examples
See the demo application at https://github.com/xtr-dev/rondevu-demo for a complete working example.