@xtr-dev/rondevu-client 0.7.9 → 0.7.11

package/README.md

@@ -411,7 +411,8 @@ const offers = await client.offers.create([{
   sdp: 'v=0...',  // Your WebRTC offer SDP
   topics: ['movie-xyz', 'hd-content'],
   ttl: 300000,  // 5 minutes
-  secret: 'my-secret-password'  // Optional: protect offer (max 128 chars)
+  secret: 'my-secret-password',  // Optional: protect offer (max 128 chars)
+  info: 'Looking for peers in EU region'  // Optional: public info (max 128 chars)
 }]);
 
 // Discover peers by topic
@@ -436,14 +437,26 @@ const newPeers = await client.offers.findByTopic('movie-xyz', {
 
 ### Authentication
 
-#### `client.register()`
+#### `client.register(customPeerId?)`
 Register a new peer and receive credentials.
 
 ```typescript
+// Auto-generate peer ID
 const creds = await client.register();
-// { peerId: '...', secret: '...' }
+// { peerId: 'f17c195f067255e357232e34cf0735d9', secret: '...' }
+
+// Or use a custom peer ID (1-128 characters)
+const customCreds = await client.register('my-custom-peer-id');
+// { peerId: 'my-custom-peer-id', secret: '...' }
 ```
 
+**Parameters:**
+- `customPeerId` (optional): Custom peer ID (1-128 characters). If not provided, a random ID will be generated.
+
+**Notes:**
+- Returns 409 Conflict if the custom peer ID is already in use
+- Custom peer IDs must be non-empty and between 1-128 characters
+
 ### Topics
 
 #### `client.offers.getTopics(options?)`
@@ -477,7 +490,8 @@ const offers = await client.offers.create([
     sdp: 'v=0...',
     topics: ['topic-1', 'topic-2'],
     ttl: 300000,  // optional, default 5 minutes
-    secret: 'my-secret-password'  // optional, max 128 chars
+    secret: 'my-secret-password',  // optional, max 128 chars
+    info: 'Looking for peers in EU region'  // optional, public info, max 128 chars
   }
 ]);
 ```

package/dist/auth.d.ts

@@ -9,8 +9,10 @@ export declare class RondevuAuth {
     constructor(baseUrl: string, fetchFn?: FetchFunction);
     /**
      * Register a new peer and receive credentials
+     * @param customPeerId - Optional custom peer ID (1-128 characters). If not provided, a random ID will be generated.
+     * @throws Error if registration fails (e.g., peer ID already in use)
      */
-    register(): Promise<Credentials>;
+    register(customPeerId?: string): Promise<Credentials>;
     /**
      * Create Authorization header value
      */

package/dist/auth.js

@@ -11,14 +11,20 @@ export class RondevuAuth {
     }
     /**
      * Register a new peer and receive credentials
+     * @param customPeerId - Optional custom peer ID (1-128 characters). If not provided, a random ID will be generated.
+     * @throws Error if registration fails (e.g., peer ID already in use)
      */
-    async register() {
+    async register(customPeerId) {
+        const body = {};
+        if (customPeerId !== undefined) {
+            body.peerId = customPeerId;
+        }
         const response = await this.fetchFn(`${this.baseUrl}/register`, {
             method: 'POST',
             headers: {
                 'Content-Type': 'application/json',
             },
-            body: JSON.stringify({}),
+            body: JSON.stringify(body),
         });
         if (!response.ok) {
             const error = await response.json().catch(() => ({ error: 'Unknown error' }));

package/dist/offers.d.ts

@@ -4,6 +4,7 @@ export interface CreateOfferRequest {
     topics: string[];
     ttl?: number;
     secret?: string;
+    info?: string;
 }
 export interface Offer {
     id: string;
@@ -15,6 +16,7 @@ export interface Offer {
     lastSeen: number;
     secret?: string;
     hasSecret?: boolean;
+    info?: string;
     answererPeerId?: string;
     answerSdp?: string;
     answeredAt?: number;

package/dist/rondevu.d.ts

@@ -72,8 +72,9 @@ export declare class Rondevu {
     get offers(): RondevuOffers;
     /**
      * Register and initialize authenticated client
+     * @param customPeerId - Optional custom peer ID (1-128 characters). If not provided, a random ID will be generated.
      */
-    register(): Promise<Credentials>;
+    register(customPeerId?: string): Promise<Credentials>;
     /**
      * Check if client is authenticated
      */

package/dist/rondevu.js

@@ -25,9 +25,10 @@ export class Rondevu {
     }
     /**
      * Register and initialize authenticated client
+     * @param customPeerId - Optional custom peer ID (1-128 characters). If not provided, a random ID will be generated.
      */
-    async register() {
-        this.credentials = await this.auth.register();
+    async register(customPeerId) {
+        this.credentials = await this.auth.register(customPeerId);
         // Create offers API instance
         this._offers = new RondevuOffers(this.baseUrl, this.credentials, this.fetchFn);
         return this.credentials;

package/package.json

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