@casual-simulation/aux-websocket 3.8.2-alpha.19511653187 → 3.10.2

package/README.md

@@ -1,3 +1,90 @@
-# AUX Websocket
+# @casual-simulation/aux-websocket
 
-Websocket integration with AUX services
+WebSocket integration layer for CasualOS (AUX) services, providing a high-level client for real-time communication with AUX servers.
+
+## Overview
+
+This package provides a WebSocket-based connection client specifically designed for communicating with CasualOS (AUX) services. It builds on top of `@casual-simulation/websocket` to provide a protocol-aware client with automatic message serialization, event filtering, and connection state management.
+
+## Main Export
+
+### `WebsocketConnectionClient`
+
+A WebSocket client implementation that conforms to the `ConnectionClient` interface from `@casual-simulation/aux-common`. It provides structured communication with AUX services using a standardized message protocol.
+
+**Features:**
+
+-   **Protocol-Aware**: Implements the AUX WebSocket message protocol with automatic JSON serialization
+-   **Event Filtering**: Subscribe to specific event types using the `event()` method
+-   **Connection State Management**: Track connection status via RxJS observables
+-   **Error Handling**: Dedicated error stream for handling connection and protocol errors
+-   **Request Tracking**: Automatic request ID assignment for message correlation
+-   **Type-Safe**: Built with TypeScript for full type safety
+
+**Key Methods:**
+
+-   `connect()` - Establish WebSocket connection
+-   `disconnect()` - Close WebSocket connection
+-   `send(message)` - Send a message to the server
+-   `event<T>(name)` - Subscribe to specific event types
+-   `connectionState` - Observable of connection state changes
+-   `onError` - Observable of error events
+
+**Usage:**
+
+```typescript
+import { WebsocketConnectionClient } from '@casual-simulation/aux-websocket';
+import { ReconnectableSocket } from '@casual-simulation/websocket';
+
+// Create underlying WebSocket
+const socket = new ReconnectableSocket('wss://example.com/api/ws');
+
+// Create AUX WebSocket client
+const client = new WebsocketConnectionClient(socket);
+
+// Listen for connection state changes
+client.connectionState.subscribe((state) => {
+    console.log('Connected:', state.connected);
+});
+
+// Listen for specific event types
+client.event('device').subscribe((event) => {
+    console.log('Device event:', event);
+});
+
+// Handle errors
+client.onError.subscribe((error) => {
+    console.error('WebSocket error:', error);
+});
+
+// Connect and send messages
+client.connect();
+client.send({
+    type: 'login',
+    // ... message payload
+});
+```
+
+## Message Protocol
+
+The client uses a standardized message format:
+
+```typescript
+[eventType: string, requestId: number, message: WebsocketMessage]
+```
+
+-   **eventType**: Type of the WebSocket event (e.g., 'message', 'error')
+-   **requestId**: Auto-incrementing request identifier
+-   **message**: The actual message payload
+
+## Dependencies
+
+-   **@casual-simulation/websocket**: Low-level WebSocket management
+-   **@casual-simulation/aux-common**: AUX common types and interfaces
+-   **rxjs**: Observable-based event handling
+
+## Installation
+
+```bash
+npm install @casual-simulation/aux-websocket
+```

package/package.json

@@ -1,45 +1,44 @@
 {
-    "name": "@casual-simulation/aux-websocket",
-    "version": "3.8.2-alpha.19511653187",
-    "description": "Websocket integration with AUX services",
-    "keywords": [],
-    "author": "Casual Simulation, Inc.",
-    "homepage": "https://github.com/casual-simulation/casualos",
-    "license": "AGPL-3.0-only",
-    "main": "index.js",
-    "types": "index.d.ts",
-    "module": "index",
-    "directories": {
-        "lib": "."
-    },
-    "files": [
-        "/README.md",
-        "/LICENSE.txt",
-        "**/*.js",
-        "**/*.js.map",
-        "**/*.d.ts"
-    ],
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/casual-simulation/casualos.git"
-    },
-    "scripts": {
-        "watch": "tsc --watch",
-        "watch:player": "npm run watch",
-        "build": "echo \"Nothing to do.\"",
-        "test": "jest",
-        "test:watch": "jest --watchAll"
-    },
-    "bugs": {
-        "url": "https://github.com/casual-simulation/casualos/issues"
-    },
-    "publishConfig": {
-        "access": "public"
-    },
-    "dependencies": {
-        "@casual-simulation/aux-common": "^3.8.2-alpha.19511653187",
-        "@casual-simulation/websocket": "^3.5.3",
-        "rxjs": "8.0.0-alpha.14"
-    },
-    "gitHead": "8ba1ed060b9cc71e0af79550480958ce2e930ccb"
-}
+  "name": "@casual-simulation/aux-websocket",
+  "version": "3.10.2",
+  "description": "Websocket integration with AUX services",
+  "keywords": [],
+  "author": "Casual Simulation, Inc.",
+  "homepage": "https://github.com/casual-simulation/casualos",
+  "license": "AGPL-3.0-only",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "module": "index",
+  "directories": {
+    "lib": "."
+  },
+  "files": [
+    "/README.md",
+    "/LICENSE.txt",
+    "**/*.js",
+    "**/*.js.map",
+    "**/*.d.ts"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/casual-simulation/casualos.git"
+  },
+  "bugs": {
+    "url": "https://github.com/casual-simulation/casualos/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@casual-simulation/aux-common": "^3.10.2",
+    "@casual-simulation/websocket": "^3.10.2",
+    "rxjs": "8.0.0-alpha.14"
+  },
+  "scripts": {
+    "watch": "tsc --watch",
+    "watch:player": "npm run watch",
+    "build": "echo \"Nothing to do.\"",
+    "test": "jest",
+    "test:watch": "jest --watchAll"
+  }
+}