@xtr-dev/rondevu-client 0.1.0 → 0.1.1

package/README.md

@@ -1,12 +1,20 @@
 # Rondevu
 
-🎯 Meet WebRTC peers by topic, by peer ID, or by connection ID.
+🎯 **Simple WebRTC peer signaling and discovery**
+
+Meet peers by topic, by peer ID, or by connection ID.
+
+**Related repositories:**
+- [rondevu-server](https://github.com/xtr-dev/rondevu-server) - HTTP signaling server
+- [rondevu-demo](https://github.com/xtr-dev/rondevu-demo) - Interactive demo
+
+---
 
 ## @xtr-dev/rondevu-client
 
 [![npm version](https://img.shields.io/npm/v/@xtr-dev/rondevu-client)](https://www.npmjs.com/package/@xtr-dev/rondevu-client)
 
-TypeScript Rondevu HTTP and WebRTC client, for simple peer discovery and connection.
+TypeScript client library for Rondevu peer signaling and WebRTC connection management. Handles automatic signaling, ICE candidate exchange, and connection establishment.
 
 ### Install
 
@@ -19,7 +27,21 @@ npm install @xtr-dev/rondevu-client
 ```typescript
 import { Rondevu } from '@xtr-dev/rondevu-client';
 
-const rdv = new Rondevu({ baseUrl: 'https://server.com' });
+const rdv = new Rondevu({ 
+  baseUrl: 'https://server.com',
+  rtcConfig: {
+    iceServers: [
+      // your ICE servers here
+      { urls: 'stun:stun.l.google.com:19302' },
+      { urls: 'stun:stun1.l.google.com:19302' },
+      {
+        urls: 'turn:relay1.example.com:3480',
+        username: 'example',
+        credential: 'example'
+      }
+    ]
+  }
+});
 
 // Connect by topic
 const conn = await rdv.join('room');

package/dist/client.d.ts

@@ -1,10 +1,9 @@
-import { RondevuClientOptions, ListTopicsResponse, ListSessionsResponse, CreateOfferRequest, CreateOfferResponse, AnswerRequest, AnswerResponse, PollOffererResponse, PollAnswererResponse, HealthResponse, Side } from './types';
+import { RondevuClientOptions, ListTopicsResponse, ListSessionsResponse, CreateOfferRequest, CreateOfferResponse, AnswerRequest, AnswerResponse, PollOffererResponse, PollAnswererResponse, VersionResponse, HealthResponse, Side } from './types';
 /**
  * HTTP client for Rondevu peer signaling and discovery server
  */
 export declare class RondevuClient {
     private readonly baseUrl;
-    private readonly origin;
     private readonly fetchImpl;
     /**
      * Creates a new Rondevu client instance
@@ -15,6 +14,19 @@ export declare class RondevuClient {
      * Makes an HTTP request to the Rondevu server
      */
     private request;
+    /**
+     * Gets server version information
+     *
+     * @returns Server version (git commit hash)
+     *
+     * @example
+     * ```typescript
+     * const client = new RondevuClient({ baseUrl: 'https://example.com' });
+     * const { version } = await client.getVersion();
+     * console.log('Server version:', version);
+     * ```
+     */
+    getVersion(): Promise<VersionResponse>;
     /**
      * Lists all topics with peer counts
      *
@@ -66,7 +78,6 @@ export declare class RondevuClient {
      * Sends an answer or candidate to an existing session
      *
      * @param request - Answer details including session code and signaling data
-     * @param customHeaders - Optional custom headers to send with the request
      * @returns Success confirmation
      *
      * @example
@@ -88,13 +99,12 @@ export declare class RondevuClient {
      * });
      * ```
      */
-    sendAnswer(request: AnswerRequest, customHeaders?: Record<string, string>): Promise<AnswerResponse>;
+    sendAnswer(request: AnswerRequest): Promise<AnswerResponse>;
     /**
      * Polls for session data from the other peer
      *
      * @param code - Session UUID
      * @param side - Which side is polling ('offerer' or 'answerer')
-     * @param customHeaders - Optional custom headers to send with the request
      * @returns Session data including offers, answers, and candidates
      *
      * @example
@@ -112,7 +122,7 @@ export declare class RondevuClient {
      * console.log('Received offer:', answererData.offer);
      * ```
      */
-    poll(code: string, side: Side, customHeaders?: Record<string, string>): Promise<PollOffererResponse | PollAnswererResponse>;
+    poll(code: string, side: Side): Promise<PollOffererResponse | PollAnswererResponse>;
     /**
      * Checks server health
      *

package/dist/client.js

@@ -8,18 +8,15 @@ export class RondevuClient {
      */
     constructor(options) {
         this.baseUrl = options.baseUrl.replace(/\/$/, ''); // Remove trailing slash
-        this.origin = options.origin || new URL(this.baseUrl).origin;
         this.fetchImpl = options.fetch || globalThis.fetch.bind(globalThis);
     }
     /**
      * Makes an HTTP request to the Rondevu server
      */
-    async request(endpoint, options = {}, customHeaders) {
+    async request(endpoint, options = {}) {
         const url = `${this.baseUrl}${endpoint}`;
         const headers = {
-            'Origin': this.origin,
             ...options.headers,
-            ...(customHeaders || {}),
         };
         if (options.body) {
             headers['Content-Type'] = 'application/json';
@@ -35,6 +32,23 @@ export class RondevuClient {
         }
         return data;
     }
+    /**
+     * Gets server version information
+     *
+     * @returns Server version (git commit hash)
+     *
+     * @example
+     * ```typescript
+     * const client = new RondevuClient({ baseUrl: 'https://example.com' });
+     * const { version } = await client.getVersion();
+     * console.log('Server version:', version);
+     * ```
+     */
+    async getVersion() {
+        return this.request('/', {
+            method: 'GET',
+        });
+    }
     /**
      * Lists all topics with peer counts
      *
@@ -54,7 +68,7 @@ export class RondevuClient {
             page: page.toString(),
             limit: limit.toString(),
         });
-        return this.request(`/?${params}`, {
+        return this.request(`/topics?${params}`, {
             method: 'GET',
         });
     }
@@ -103,7 +117,6 @@ export class RondevuClient {
      * Sends an answer or candidate to an existing session
      *
      * @param request - Answer details including session code and signaling data
-     * @param customHeaders - Optional custom headers to send with the request
      * @returns Success confirmation
      *
      * @example
@@ -125,18 +138,17 @@ export class RondevuClient {
      * });
      * ```
      */
-    async sendAnswer(request, customHeaders) {
+    async sendAnswer(request) {
         return this.request('/answer', {
             method: 'POST',
             body: JSON.stringify(request),
-        }, customHeaders);
+        });
     }
     /**
      * Polls for session data from the other peer
      *
      * @param code - Session UUID
      * @param side - Which side is polling ('offerer' or 'answerer')
-     * @param customHeaders - Optional custom headers to send with the request
      * @returns Session data including offers, answers, and candidates
      *
      * @example
@@ -154,12 +166,12 @@ export class RondevuClient {
      * console.log('Received offer:', answererData.offer);
      * ```
      */
-    async poll(code, side, customHeaders) {
+    async poll(code, side) {
         const request = { code, side };
         return this.request('/poll', {
             method: 'POST',
             body: JSON.stringify(request),
-        }, customHeaders);
+        });
     }
     /**
      * Checks server health

package/dist/connection.d.ts

@@ -19,8 +19,7 @@ export declare class RondevuConnection extends EventEmitter {
     private connectionTimer?;
     private isPolling;
     private isClosed;
-    private customHeaders?;
-    constructor(params: RondevuConnectionParams, client: RondevuClient, customHeaders?: Record<string, string>);
+    constructor(params: RondevuConnectionParams, client: RondevuClient);
     /**
      * Setup RTCPeerConnection event handlers
      */

package/dist/connection.js

@@ -3,7 +3,7 @@ import { EventEmitter } from './event-emitter';
  * Represents a WebRTC connection with automatic signaling and ICE exchange
  */
 export class RondevuConnection extends EventEmitter {
-    constructor(params, client, customHeaders) {
+    constructor(params, client) {
         super();
         this.isPolling = false;
         this.isClosed = false;
@@ -17,7 +17,6 @@ export class RondevuConnection extends EventEmitter {
         this.dataChannels = new Map();
         this.pollingIntervalMs = params.pollingInterval;
         this.connectionTimeoutMs = params.connectionTimeout;
-        this.customHeaders = customHeaders;
         this.setupEventHandlers();
         this.startConnectionTimeout();
     }
@@ -90,7 +89,7 @@ export class RondevuConnection extends EventEmitter {
                 code: this.id,
                 candidate: JSON.stringify(candidate.toJSON()),
                 side: this.role,
-            }, this.customHeaders);
+            });
         }
         catch (err) {
             throw new Error(`Failed to send ICE candidate: ${err.message}`);
@@ -134,7 +133,7 @@ export class RondevuConnection extends EventEmitter {
             return;
         }
         try {
-            const response = await this.client.poll(this.id, this.role, this.customHeaders);
+            const response = await this.client.poll(this.id, this.role);
             if (this.role === 'offerer') {
                 const offererResponse = response;
                 // Apply answer if received and not yet applied

package/dist/index.d.ts

@@ -5,4 +5,4 @@
 export { Rondevu } from './rondevu';
 export { RondevuConnection } from './connection';
 export { RondevuClient } from './client';
-export type { RondevuOptions, JoinOptions, ConnectionRole, RondevuConnectionParams, RondevuConnectionEvents, Side, Session, TopicInfo, Pagination, ListTopicsResponse, ListSessionsResponse, CreateOfferRequest, CreateOfferResponse, AnswerRequest, AnswerResponse, PollRequest, PollOffererResponse, PollAnswererResponse, PollResponse, HealthResponse, ErrorResponse, RondevuClientOptions, } from './types';
+export type { RondevuOptions, JoinOptions, ConnectionRole, RondevuConnectionParams, RondevuConnectionEvents, Side, Session, TopicInfo, Pagination, ListTopicsResponse, ListSessionsResponse, CreateOfferRequest, CreateOfferResponse, AnswerRequest, AnswerResponse, PollRequest, PollOffererResponse, PollAnswererResponse, PollResponse, VersionResponse, HealthResponse, ErrorResponse, RondevuClientOptions, } from './types';

package/dist/rondevu.d.ts

@@ -1,5 +1,5 @@
 import { RondevuConnection } from './connection';
-import { RondevuOptions, JoinOptions, ConnectOptions } from './types';
+import { RondevuOptions, JoinOptions } from './types';
 /**
  * Main Rondevu WebRTC client with automatic connection management
  */
@@ -34,10 +34,9 @@ export declare class Rondevu {
     /**
      * Connect to an existing connection by ID (answerer role)
      * @param id - Connection identifier
-     * @param options - Optional connection options (e.g., { global: true } for global origin)
      * @returns Promise that resolves to RondevuConnection
      */
-    connect(id: string, options?: ConnectOptions): Promise<RondevuConnection>;
+    connect(id: string): Promise<RondevuConnection>;
     /**
      * Join a topic and discover available peers (answerer role)
      * @param topic - Topic name

package/dist/rondevu.js

@@ -13,7 +13,6 @@ export class Rondevu {
         this.fetchImpl = options.fetch;
         this.client = new RondevuClient({
             baseUrl: this.baseUrl,
-            origin: options.origin,
             fetch: options.fetch,
         });
         // Auto-generate peer ID if not provided
@@ -75,16 +74,11 @@ export class Rondevu {
     /**
      * Connect to an existing connection by ID (answerer role)
      * @param id - Connection identifier
-     * @param options - Optional connection options (e.g., { global: true } for global origin)
      * @returns Promise that resolves to RondevuConnection
      */
-    async connect(id, options) {
-        // Build custom headers if global option is set
-        const customHeaders = options?.global
-            ? { 'X-Rondevu-Global': 'true' }
-            : undefined;
+    async connect(id) {
         // Poll server to get session by ID
-        const sessionData = await this.findSessionByIdWithClient(id, this.client, customHeaders);
+        const sessionData = await this.findSessionByIdWithClient(id, this.client);
         if (!sessionData) {
             throw new Error(`Connection ${id} not found or expired`);
         }
@@ -105,7 +99,7 @@ export class Rondevu {
             code: id,
             answer: pc.localDescription.sdp,
             side: 'answerer',
-        }, customHeaders);
+        });
         // Create connection object
         const connectionParams = {
             id,
@@ -117,7 +111,7 @@ export class Rondevu {
             pollingInterval: this.pollingInterval,
             connectionTimeout: this.connectionTimeout,
         };
-        const connection = new RondevuConnection(connectionParams, this.client, customHeaders);
+        const connection = new RondevuConnection(connectionParams, this.client);
         // Start polling for ICE candidates
         connection.startPolling();
         return connection;
@@ -188,11 +182,11 @@ export class Rondevu {
      * Find a session by connection ID
      * This requires polling since we don't know which topic it's in
      */
-    async findSessionByIdWithClient(id, client, customHeaders) {
+    async findSessionByIdWithClient(id, client) {
         try {
             // Try to poll for the session directly
             // The poll endpoint should return the session data
-            const response = await client.poll(id, 'answerer', customHeaders);
+            const response = await client.poll(id, 'answerer');
             const answererResponse = response;
             if (answererResponse.offer) {
                 return {

package/dist/types.d.ts

@@ -122,6 +122,13 @@ export interface PollAnswererResponse {
  * Response from POST /poll (union type)
  */
 export type PollResponse = PollOffererResponse | PollAnswererResponse;
+/**
+ * Response from GET / - server version information
+ */
+export interface VersionResponse {
+    /** Git commit hash or version identifier */
+    version: string;
+}
 /**
  * Response from GET /health
  */
@@ -141,8 +148,6 @@ export interface ErrorResponse {
 export interface RondevuClientOptions {
     /** Base URL of the Rondevu server (e.g., 'https://example.com') */
     baseUrl: string;
-    /** Origin header value for session isolation (defaults to baseUrl origin) */
-    origin?: string;
     /** Optional fetch implementation (for Node.js environments) */
     fetch?: typeof fetch;
 }
@@ -154,8 +159,6 @@ export interface RondevuOptions {
     baseUrl?: string;
     /** Peer identifier (optional, auto-generated if not provided) */
     peerId?: string;
-    /** Origin header value for session isolation (defaults to baseUrl origin) */
-    origin?: string;
     /** Optional fetch implementation (for Node.js environments) */
     fetch?: typeof fetch;
     /** WebRTC configuration (ICE servers, etc.) */
@@ -165,13 +168,6 @@ export interface RondevuOptions {
     /** Connection timeout in milliseconds (default: 30000) */
     connectionTimeout?: number;
 }
-/**
- * Options for connecting to a session
- */
-export interface ConnectOptions {
-    /** Use global origin (https://ronde.vu) instead of request origin for session isolation */
-    global?: boolean;
-}
 /**
  * Options for joining a topic
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xtr-dev/rondevu-client",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "TypeScript client for Rondevu peer signaling and discovery server",
   "type": "module",
   "main": "dist/index.js",