spice-client 1.0.0

package/COPYING.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/LICENSE

@@ -0,0 +1,14 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+Version 3, 29 June 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+
+This project is licensed under the GNU Lesser General Public License v3.0 or later.
+
+See COPYING for the full text of the GNU General Public License v3.0.
+See COPYING.LESSER for the full text of the GNU Lesser General Public License v3.0.
+
+This project is a TypeScript port of spice-html5:
+https://gitlab.freedesktop.org/spice/spice-html5.git
+
+Original authors: SPICE Project <spice-devel@lists.freedesktop.org>

package/README.cn.md

@@ -0,0 +1,143 @@
+# spice-client
+
+[English](./README.md)
+
+[spice-html5](https://gitlab.freedesktop.org/spice/spice-html5.git) 的 TypeScript 移植版 - SPICE 协议的 JavaScript 客户端。
+
+## 归属说明
+
+**本项目是原始 [spice-html5](https://gitlab.freedesktop.org/spice/spice-html5.git) 项目的 TypeScript 移植版。**
+
+- **原始项目**: https://gitlab.freedesktop.org/spice/spice-html5.git
+- **原始作者**: SPICE Project <spice-devel@lists.freedesktop.org> (https://www.spice-space.org)
+- **原始许可证**: LGPL-3.0-or-later
+
+**所有荣誉归于原始作者。** 本项目仅做了以下工作：
+- 将 JavaScript 代码转换为 TypeScript
+- 添加了单元测试
+- 使用 Vite 实现了现代化的构建流程
+- 添加了 LZ4 图像压缩支持
+
+TypeScript 转换和构建配置代码是在 Trae Solo Coder 模式下借助 GLM-5 模型辅助生成的。
+
+## 许可证
+
+本项目采用 GNU 通用公共许可证 v3.0 或更高版本授权 - 详见 [LICENSE](LICENSE) 文件。
+
+本项目包含以下文件的副本：
+- [COPYING](COPYING) - GNU 通用公共许可证 v3.0
+- [COPYING.LESSER](COPYING.LESSER) - GNU 通用公共许可证 v3.0
+
+## 安装
+
+```bash
+npm install spice-client
+```
+
+## 使用方法
+
+### ES Modules
+
+```javascript
+import { SpiceMainConn, Constants } from 'spice-client';
+
+const spice = new SpiceMainConn({
+  uri: 'ws://localhost:5959',
+  password: 'your-password',
+  onsuccess: () => console.log('已连接！'),
+  onerror: (e) => console.error('错误：', e)
+});
+```
+
+### CommonJS
+
+```javascript
+const { SpiceMainConn, Constants } = require('spice-client');
+```
+
+### 浏览器全局变量 (IIFE)
+
+引入压缩后的包：
+
+```html
+<script src="node_modules/spice-client/dist/global/spice-client.min.js"></script>
+<script>
+  const spice = new SpiceClient.SpiceMainConn({
+    uri: 'ws://localhost:5959',
+    password: 'your-password'
+  });
+</script>
+```
+
+## 环境要求
+
+1. 现代浏览器（Firefox、Chrome 或 Edge）
+2. WebSocket 代理（例如 [websockify](https://github.com/novnc/websockify)）
+3. SPICE 服务器
+
+## 快速开始
+
+1. 启动 SPICE 服务器
+2. 启动 websockify：
+   ```bash
+   websockify 5959 localhost:5900
+   ```
+3. 使用客户端连接
+
+## API
+
+### 导出
+
+| 导出 | 描述 |
+|--------|-------------|
+| `SpiceMainConn` | SPICE 主连接类 |
+| `SpiceConn` | 基础 SPICE 连接 |
+| `SpiceDisplayConn` | 显示通道连接 |
+| `SpiceInputsConn` | 输入（键盘/鼠标）通道 |
+| `SpiceCursorConn` | 光标通道连接 |
+| `SpicePlaybackConn` | 音频播放通道 |
+| `SpicePortConn` | 端口通道连接 |
+| `Constants` | SPICE 协议常量 |
+| `handle_file_dragover` | 文件拖放处理函数 |
+| `handle_file_drop` | 文件释放处理函数 |
+| `resize_helper` | 调整大小辅助函数 |
+| `handle_resize` | 调整大小处理函数 |
+| `sendCtrlAltDel` | 发送 Ctrl+Alt+Del 组合键 |
+
+## 构建
+
+```bash
+# 构建所有格式（ESM、CJS、浏览器全局压缩版）
+npm run build
+```
+
+构建输出：
+```
+dist/
+├── esm/           # ES Module 构建
+├── cjs/           # CommonJS 构建
+└── global/        # 浏览器用压缩版 IIFE
+```
+
+## 开发
+
+```bash
+# 安装依赖
+npm install
+
+# 运行测试
+npm test
+
+# 监听模式运行测试
+npm run test:watch
+
+# 运行端到端测试
+npm run test:e2e
+```
+
+## 相关项目
+
+- [spice-html5](https://gitlab.freedesktop.org/spice/spice-html5.git) - 原始 JavaScript 实现
+- [websockify](https://github.com/novnc/websockify) - WebSocket 转 TCP 代理
+- [SPICE Project](https://www.spice-space.org/) - 官方 SPICE 项目
+- [Electerm](https://github.com/electerm/electerm) - 使用此库的终端/SSH/SFTP/Spice/Telnet/Ftp/RDP/VNC/Serial 客户端

package/README.md

@@ -0,0 +1,143 @@
+# spice-client
+
+[中文](./README.cn.md)
+
+A TypeScript port of [spice-html5](https://gitlab.freedesktop.org/spice/spice-html5.git) - a JavaScript client for the SPICE protocol.
+
+## Attribution
+
+**This project is a TypeScript port of the original [spice-html5](https://gitlab.freedesktop.org/spice/spice-html5.git) project.**
+
+- **Original Project**: https://gitlab.freedesktop.org/spice/spice-html5.git
+- **Original Authors**: SPICE Project <spice-devel@lists.freedesktop.org> (https://www.spice-space.org)
+- **Original License**: LGPL-3.0-or-later
+
+**All credit goes to the original authors.** This project simply:
+- Converted the JavaScript code to TypeScript
+- Added unit tests
+- Implemented a modern build process with Vite
+- Added LZ4 image compression support
+
+The TypeScript conversion and build setup code was generated with the assistance of the GLM-5 model in Trae Solo Coder mode.
+
+## License
+
+This project is licensed under the GNU Lesser General Public License v3.0 or later - see the [LICENSE](LICENSE) file for details.
+
+This project includes copies of:
+- [COPYING](COPYING) - GNU General Public License v3.0
+- [COPYING.LESSER](COPYING.LESSER) - GNU Lesser General Public License v3.0
+
+## Installation
+
+```bash
+npm install spice-client
+```
+
+## Usage
+
+### ES Modules
+
+```javascript
+import { SpiceMainConn, Constants } from 'spice-client';
+
+const spice = new SpiceMainConn({
+  uri: 'ws://localhost:5959',
+  password: 'your-password',
+  onsuccess: () => console.log('Connected!'),
+  onerror: (e) => console.error('Error:', e)
+});
+```
+
+### CommonJS
+
+```javascript
+const { SpiceMainConn, Constants } = require('spice-client');
+```
+
+### Browser Global (IIFE)
+
+Include the minified bundle:
+
+```html
+<script src="node_modules/spice-client/dist/global/spice-client.min.js"></script>
+<script>
+  const spice = new SpiceClient.SpiceMainConn({
+    uri: 'ws://localhost:5959',
+    password: 'your-password'
+  });
+</script>
+```
+
+## Requirements
+
+1. A modern browser (Firefox, Chrome, or Edge)
+2. A WebSocket proxy (e.g., [websockify](https://github.com/novnc/websockify))
+3. A SPICE server
+
+## Quick Start
+
+1. Start your SPICE server
+2. Start websockify:
+   ```bash
+   websockify 5959 localhost:5900
+   ```
+3. Connect using the client
+
+## API
+
+### Exports
+
+| Export | Description |
+|--------|-------------|
+| `SpiceMainConn` | Main SPICE connection class |
+| `SpiceConn` | Base SPICE connection |
+| `SpiceDisplayConn` | Display channel connection |
+| `SpiceInputsConn` | Inputs (keyboard/mouse) channel |
+| `SpiceCursorConn` | Cursor channel connection |
+| `SpicePlaybackConn` | Audio playback channel |
+| `SpicePortConn` | Port channel connection |
+| `Constants` | SPICE protocol constants |
+| `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 |
+
+## Build
+
+```bash
+# Build all formats (ESM, CJS, global minified)
+npm run build
+```
+
+Build output:
+```
+dist/
+├── esm/           # ES Module build
+├── cjs/           # CommonJS build
+└── global/        # Minified IIFE for browsers
+```
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Run tests
+npm test
+
+# Run tests in watch mode
+npm run test:watch
+
+# Run e2e tests
+npm run test:e2e
+```
+
+## Related Projects
+
+- [spice-html5](https://gitlab.freedesktop.org/spice/spice-html5.git) - Original JavaScript implementation
+- [websockify](https://github.com/novnc/websockify) - WebSocket to TCP proxy
+- [SPICE Project](https://www.spice-space.org/) - Official SPICE project
+- [Electerm](https://github.com/electerm/electerm) - Terminal/SSH/SFTP/Spice/Telnet/Ftp/RDP/VNC/Serial client using this library