avke-sdk 1.0.0 → 1.0.1

package/README.md

@@ -1,267 +1,92 @@
-# AVKE - 爱客游戏外设开发者联盟
-
-[![Version](https://img.shields.io/badge/version-1.0.0-blue.svg)](https://github.com/avke/avke-sdk)
-[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://opensource.org/licenses/MIT)
-[![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue.svg)](https://www.typescriptlang.org/)
-
-> 引领游戏外设技术革新的专业SDK平台，为开发者提供企业级的硬件通信解决方案
-
-AVKE 项目是由GDE 游戏驱动引擎团队开发和维护。
-
-AVKE SDK 是专为游戏外设开发者打造的现代化JavaScript/TypeScript SDK，基于WEBHID技术实现键盘、鼠标等外设的深度硬件控制。无需额外驱动，即可在浏览器环境中实现设备连接、参数配置、灯光控制等高级功能，为游戏生态构建无限可能。
-
-## ✨ 核心特性
-
-- 🚀 **企业级架构** - 模块化设计，支持键盘和鼠标设备类型区分
-- 🌐 **现代Web技术** - 基于WEBHID标准，突破浏览器硬件访问限制
-- 📱 **跨平台支持** - Windows、macOS、Linux全平台兼容
-- 🔧 **TypeScript优先** - 完整的类型定义和智能提示
-- 📊 **性能监控** - 内置性能追踪和错误处理机制
-- 🧪 **完整测试** - 全面的单元测试和集成测试覆盖
-- 📚 **官网文档** - 体系化的API文档和开发指南
-
-## 🛠️ 技术栈
-
-- **前端框架**: Vue 3 + TypeScript
-- **构建工具**: Vite
-- **通信协议**: WEBHID
-- **文档系统**: VitePress（已集成到官网开发与构建流程）
-- **测试框架**: 自定义测试运行器
-- **包管理**: npm
-
-## Installation
-
-```bash
-npm install avke-sdk
-```
-
-## Usage
-
-### Keyboard SDK
-
-```javascript
-import { ServiceKeyboard } from 'avke-sdk';
-
-const keyboard = new ServiceKeyboard();
-
-// Get available devices
-const devices = await keyboard.getDevices();
-console.log('Devices:', devices);
-
-// Initialize a device
-const device = await keyboard.init(devices[0].id);
-
-// Get device info
-const info = await keyboard.getDevicesInfo();
-console.log('Device Info:', info);
-```
-
-### Mouse SDK
-
-```javascript
-import { ServiceMouse } from 'avke-sdk';
-
-const mouse = new ServiceMouse();
-
-// Get available devices
-const devices = await mouse.getDevices();
-console.log('Devices:', devices);
-
-// Initialize a device
-const device = await mouse.init(devices[0].id);
-
-// Get DPI setting
-const dpi = await mouse.getDPI();
-console.log('Current DPI:', dpi.value);
-```
-
-## 核心功能模块
-
-### 🔧 版本管理和兼容性
-
-SDK 内置版本管理功能，支持设备固件兼容性检查：
-
-```javascript
-import { versionManager } from 'avke-sdk';
-
-// 获取SDK版本信息
-const version = versionManager.getVersion();
-console.log('SDK Version:', version.version);
-
-// 检查设备兼容性
-const compatibility = versionManager.checkCompatibility('keyboard', '1.0.1.0');
-console.log('Compatible:', compatibility.compatible);
-```
-
-### 📊 错误处理和日志系统
-
-完整的错误处理和日志记录功能：
-
-```javascript
-import { logger } from 'avke-sdk';
-
-// 设置日志级别
-logger.setLevel('DEBUG');
-
-// 记录不同级别的日志
-logger.info('Operation completed successfully');
-logger.warn('Warning: device not responding');
-logger.error('Error: connection failed');
-
-// 获取日志记录
-const logs = logger.getLogs('ERROR');
-console.log('Error logs:', logs);
-```
-
-### 📈 性能监控
-
-实时性能监控和统计：
-
-```javascript
-import { performanceMonitor } from 'avke-sdk';
-
-// 获取性能报告
-const report = performanceMonitor.getReport();
-console.log('Total operations:', report.summary.totalOperations);
-console.log('Active connections:', report.summary.activeConnections);
-
-// 按操作类型查看性能
-console.log('Operation metrics:', report.operations);
-```
-
-## 测试工具
-
-### 运行测试
-
-```bash
-# 运行所有测试
-npm test
-
-# 在Node.js环境中运行
-npm run test:node
-
-# 在浏览器中运行（开发模式）
-npm run test:browser
-```
-
-### 测试框架
-
-SDK 包含完整的测试框架，支持：
-
-- ✅ 单元测试
-- ✅ 集成测试
-- ✅ 性能测试
-- ✅ 兼容性测试
-- ✅ 错误处理测试
-
-## 开发和调试
-
-### 开发服务器
-
-```bash
-# 启动调试工具
-npm run dev
-
-# 启动网站开发服务器
-npm run website:dev
-
-# 文档调试入口
-# 官网开发模式可直接访问 /docs/
-```
-
-### 构建
-
-```bash
-# 构建SDK
-npm run build
-
-# 构建调试版本
-npm run build:debug
-
-# 构建完整网站
-npm run website:build
-
-# 官网构建会自动构建文档并整合到 dist-website/docs
-```
-
-## 官网
-
-完整的项目官网已集成所有功能模块：
-
-```bash
-# 启动官网开发服务器
-npm run website:dev
-
-# 构建完整官网
-npm run website:build
-```
-
-官网包含：
-- 🏠 **首页**：产品介绍和特性展示
-- 📦 **SDK**：下载和使用指南
-- 🔧 **调试工具**：在线API测试
-- 📚 **文档中心**：完整的API文档
-
-## 国际化支持
-
-官网支持中英文切换：
-- 🌐 自动检测浏览器语言
-- 🔄 手动切换语言设置
-- 💾 语言偏好自动保存到本地存储
-
-## Development
-
-```bash
-# Install dependencies
-npm install
-
-# Start development server
-npm run dev
-
-# Build SDK
-npm run build
-
-# Start debug tool
-npm run dev
-
-# Website docs are available at /docs/ in website dev mode
-
-# Start website
-npm run website:dev
-```
-
-### 部署到 GitHub Pages
-
-构建后的 `dist-website` 目录可以直接部署到GitHub Pages，整个官网即可在线访问。
-
-## Development
-
-### 调试工具
-
-项目包含一个内置的网页调试工具，可以在浏览器中直接测试SDK接口。
-
-```bash
-# 启动调试服务器
-npm run dev
-
-# 访问调试界面进行接口测试
-```
-
-调试工具提供：
-- 左侧API方法列表
-- 右侧参数输入和结果显示
-- 实时调用SDK方法并查看返回结果
-
-### 构建
-
-```bash
-# 构建SDK库（发布用）
-npm run build
-
-# 构建调试应用（可选）
-npm run build:debug
-```
-
-## License
-
-MIT
+# AVKE SDK
+
+AVKE SDK 是面向游戏外设的 JavaScript 和 TypeScript SDK，基于 WebHID 提供键盘、鼠标等设备的连接、读取与配置能力。
+
+## 安装
+
+```bash
+npm install avke-sdk
+```
+
+## 使用要求
+
+- 运行环境需要支持 WebHID 的现代浏览器
+- 设备访问必须由用户手势触发
+- 建议在 HTTPS 或本地开发环境中使用
+
+## 快速开始
+
+```javascript
+import { ServiceKeyboard } from 'avke-sdk'
+
+const keyboard = new ServiceKeyboard()
+
+const devices = await keyboard.getDevices()
+if (devices.length === 0) {
+  throw new Error('No keyboard devices found')
+}
+
+await keyboard.init(devices[0].id)
+
+const info = await keyboard.getDevicesInfo()
+console.log(info)
+```
+
+## 导出内容
+
+```javascript
+import ServiceKeyboard, {
+  ServiceKeyboard,
+  ServiceMouse,
+  versionManager,
+  logger,
+  performanceMonitor
+} from 'avke-sdk'
+```
+
+- `ServiceKeyboard`: 键盘设备服务
+- `ServiceMouse`: 鼠标设备服务
+- `versionManager`: SDK 版本和兼容性检查
+- `logger`: 运行日志记录
+- `performanceMonitor`: 性能统计与错误追踪
+
+## 常见流程
+
+### 键盘设备
+
+```javascript
+import { ServiceKeyboard } from 'avke-sdk'
+
+const keyboard = new ServiceKeyboard()
+const devices = await keyboard.getDevices()
+
+await keyboard.init(devices[0].id)
+
+const protocolVersion = await keyboard.getProtocolVersion()
+const configList = await keyboard.getConfigList()
+
+console.log(protocolVersion, configList)
+```
+
+### 鼠标设备
+
+```javascript
+import { ServiceMouse } from 'avke-sdk'
+
+const mouse = new ServiceMouse()
+const devices = await mouse.getDevices()
+
+await mouse.init(devices[0].id)
+
+const dpi = await mouse.getDPI()
+console.log(dpi)
+```
+
+## TypeScript
+
+包内已经包含类型声明，安装后可直接获得类型提示。
+
+## 发布说明
+
+仓库根目录 README 用于项目总览。
+npm 发布包使用的是此文件生成的独立 README。

package/package.json

@@ -1,25 +1,11 @@
 {
   "name": "avke-sdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "type": "module",
   "description": "AVKE - 爱客游戏外设开发者联盟 SDK",
   "main": "dist/keyboard-sdk.umd.js",
   "module": "dist/keyboard-sdk.es.js",
   "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "dev": "vite --mode debug",
-    "website:dev": "vite --mode website",
-    "website:build": "vite build --mode website",
-    "build": "vite build",
-    "build:debug": "vite build --mode debug",
-    "preview": "vite preview",
-    "test": "node test/run-tests.js",
-    "test:node": "node test/sdk-tests.js",
-    "test:browser": "npm run website:dev & sleep 3 && open http://localhost:4001/test.html"
-  },
   "keywords": [
     "keyboard",
     "sdk",
@@ -27,16 +13,5 @@
     "communication"
   ],
   "author": "Your Name",
-  "license": "MIT",
-  "devDependencies": {
-    "@vitejs/plugin-vue": "^6.0.5",
-    "typescript": "^5.0.0",
-    "vite": "^8.0.0",
-    "vitepress": "^1.6.4",
-    "vue": "^3.5.30"
-  },
-  "dependencies": {
-    "vue-i18n": "^9.14.4",
-    "vue-router": "^4.6.4"
-  }
+  "license": "MIT"
 }