http-request-manager 18.6.0 → 18.7.0

package/README.md

@@ -422,27 +422,87 @@ This service manages the lifecycle of a WebSocket connection. It handles authent
 - **Connection Management:** Handles connecting, disconnecting, and reconnecting.
 - **Authentication:** Supports JWT-based authentication for secure connections.
 - **Channels:** Allows subscribing and unsubscribing to specific channels.
+- **Channel Management:** Create and delete channels dynamically.
 - **Messaging:** Supports sending messages to specific channels, users, or broadcasting to all.
-- **Observables:** Exposes `messages$` stream and `connectionStatus$` for reactive integration.
+- **Observables:** Exposes `messages$`, `connectionStatus$`, and `subscribedChannels$` for reactive integration.
+- **Session Persistence:** Automatically generates and persists session IDs for reconnection scenarios.
 
 **Usage:**
 
 ```typescript
 wsService = inject(WebsocketService);
 
-// Connect
-this.wsService.connect('wss://api.example.com/ws', 'jwt-token');
+// Connect with options
+this.wsService.connect({
+  id: 'my-primary-channel',
+  wsServer: 'wss://api.example.com/ws',
+  user: { ldap: 'jdoe', name: 'John Doe' },
+  channels: ['PUB-notifications', 'PUB-updates']
+}, 'jwt-token');
 
-// Subscribe to channel
-this.wsService.subscribeToChannel('my-channel');
+// Subscribe to additional channels
+this.wsService.subscribeToChannel('PUB-my-channel');
+
+// Unsubscribe from a channel
+this.wsService.unsubscribeFromChannel('PUB-my-channel');
 
 // Listen to messages
 this.wsService.messages$.subscribe(msg => console.log(msg));
 
-// Send Message
-this.wsService.sendMessageInChannel('my-channel', { text: 'hello' });
+// Send message to a channel
+this.wsService.sendChannelMessage('PUB-my-channel', { text: 'Hello!' });
+
+// Track subscribed channels
+this.wsService.subscribedChannels$.subscribe(channels => console.log([...channels]));
+
+// Create/Delete channels
+this.wsService.createChannel('PUB-new-channel');
+this.wsService.deleteChannel('PUB-old-channel');
+
+// Get all available channels
+this.wsService.getAllChannels();
+
+// Get users in a channel
+this.wsService.getUsersInChannel('PUB-my-channel');
 ```
 
+#### Channel Naming Conventions
+
+The WebSocket service supports channel prefixes for organizing communication:
+
+| Prefix | Description | Visibility |
+| :--- | :--- | :--- |
+| `PUB-` | Public channels for user messaging | Visible to users |
+| `SYS-` | System channels for internal communication | Hidden from users |
+
+**Example:**
+
+```typescript
+// Create a public channel (visible in UI)
+this.wsService.createChannel('PUB-general-chat');
+
+// Create a system channel (hidden from UI)
+this.wsService.createChannel('SYS-internal-notifications');
+```
+
+#### WebSocket Message Types
+
+| Type | Description | Direction |
+| :--- | :--- | :--- |
+| `subscribe` | Subscribe to a channel | Client → Server |
+| `unsubscribe` | Unsubscribe from a channel | Client → Server |
+| `message` | Send message to channel subscribers | Client → Server |
+| `broadcast` | Broadcast to all connected clients | Client → Server |
+| `userMessage` | Send message to specific user | Client → Server |
+| `createChannel` | Create a new channel | Client → Server |
+| `deleteChannel` | Delete an existing channel | Client → Server |
+| `getChannels` | Request list of all channels | Client → Server |
+| `getUsers` | Get users in a channel | Client → Server |
+| `channelsList` | List of available channels | Server → Client |
+| `subscribed` | Subscription confirmation | Server → Client |
+| `unsubscribed` | Unsubscription confirmation | Server → Client |
+| `incomingMessage` | Message received in a channel | Server → Client |
+
 #### WebSocket Options (`WSOptions`)
 
 | Option | Type | Description | Default |