spice-client 1.0.0 → 1.1.0

package/README.cn.md

@@ -1,6 +1,6 @@
 # spice-client
 
-[English](./README.md)
+[English](./README.md) | [中文](./README.cn.md)
 
 [spice-html5](https://gitlab.freedesktop.org/spice/spice-html5.git) 的 TypeScript 移植版 - SPICE 协议的 JavaScript 客户端。
 
@@ -17,6 +17,9 @@
 - 添加了单元测试
 - 使用 Vite 实现了现代化的构建流程
 - 添加了 LZ4 图像压缩支持
+- 优化消息处理，直接处理多个 ArrayBuffer，避免缓冲区拼接开销
+- 单 ArrayBuffer 操作使用原生 DataView，仅在多缓冲区场景下使用自定义 SpiceDataView
+- 改进鼠标移动处理，采用队列+折叠策略和 requestIdleCallback 实现更流畅的输入
 
 TypeScript 转换和构建配置代码是在 Trae Solo Coder 模式下借助 GLM-5 模型辅助生成的。
 
@@ -98,12 +101,41 @@ const { SpiceMainConn, Constants } = require('spice-client');
 | `SpicePlaybackConn` | 音频播放通道 |
 | `SpicePortConn` | 端口通道连接 |
 | `Constants` | SPICE 协议常量 |
+| `SpiceEventType` | 事件类型定义 |
+| `SpiceEventHandlers` | 事件处理器类型定义 |
 | `handle_file_dragover` | 文件拖放处理函数 |
 | `handle_file_drop` | 文件释放处理函数 |
 | `resize_helper` | 调整大小辅助函数 |
 | `handle_resize` | 调整大小处理函数 |
 | `sendCtrlAltDel` | 发送 Ctrl+Alt+Del 组合键 |
 
+### 事件
+
+`SpiceMainConn` 类支持使用 `on()` 和 `off()` 方法注册事件。
+
+#### connection_status
+
+连接状态变化时触发。
+
+```javascript
+spice.on('connection_status', (status) => {
+  console.log('连接状态:', status);
+  // 可能的值: 'connecting', 'connected', 'error', 'disconnected'
+});
+```
+
+#### keyboard_modifiers
+
+键盘修饰键（NumLock、CapsLock、ScrollLock）状态变化时触发。
+
+```javascript
+spice.on('keyboard_modifiers', (modifiers) => {
+  console.log('NumLock:', modifiers.num_lock);
+  console.log('CapsLock:', modifiers.caps_lock);
+  console.log('ScrollLock:', modifiers.scroll_lock);
+});
+```
+
 ## 构建
 
 ```bash

package/README.md

@@ -1,6 +1,6 @@
 # spice-client
 
-[中文](./README.cn.md)
+[中文](./README.cn.md) | [English](./README.md)
 
 A TypeScript port of [spice-html5](https://gitlab.freedesktop.org/spice/spice-html5.git) - a JavaScript client for the SPICE protocol.
 
@@ -17,6 +17,9 @@ A TypeScript port of [spice-html5](https://gitlab.freedesktop.org/spice/spice-ht
 - Added unit tests
 - Implemented a modern build process with Vite
 - Added LZ4 image compression support
+- Optimized message processing to handle multiple ArrayBuffers directly, avoiding buffer concatenation overhead
+- Uses native DataView for single ArrayBuffer operations, falling back to custom SpiceDataView only for multi-buffer scenarios
+- Improved mouse motion handling with queue + collapse strategy and requestIdleCallback for smoother input
 
 The TypeScript conversion and build setup code was generated with the assistance of the GLM-5 model in Trae Solo Coder mode.
 
@@ -98,12 +101,41 @@ Include the minified bundle:
 | `SpicePlaybackConn` | Audio playback channel |
 | `SpicePortConn` | Port channel connection |
 | `Constants` | SPICE protocol constants |
+| `SpiceEventType` | Event type definitions |
+| `SpiceEventHandlers` | Event handler type definitions |
 | `handle_file_dragover` | File drag handler |
 | `handle_file_drop` | File drop handler |
 | `resize_helper` | Resize helper function |
 | `handle_resize` | Resize handler |
 | `sendCtrlAltDel` | Send Ctrl+Alt+Del sequence |
 
+### Events
+
+The `SpiceMainConn` class supports event registration using `on()` and `off()` methods.
+
+#### connection_status
+
+Emitted when the connection status changes.
+
+```javascript
+spice.on('connection_status', (status) => {
+  console.log('Connection status:', status);
+  // Possible values: 'connecting', 'connected', 'error', 'disconnected'
+});
+```
+
+#### keyboard_modifiers
+
+Emitted when keyboard modifier keys (NumLock, CapsLock, ScrollLock) state changes.
+
+```javascript
+spice.on('keyboard_modifiers', (modifiers) => {
+  console.log('NumLock:', modifiers.num_lock);
+  console.log('CapsLock:', modifiers.caps_lock);
+  console.log('ScrollLock:', modifiers.scroll_lock);
+});
+```
+
 ## Build
 
 ```bash