@lzpenguin/server 1.0.6 → 1.0.8

package/README.md

@@ -22,7 +22,7 @@ const server = new RiffleServer({
 // 监听数据更新
 server.onData((data) => {
   console.log('World:', data.world);
-  console.log('Self:', data.self);
+  console.log('Self:', data.self);      // self 现在直接是公开数据，与 players[i] 结构一致
   console.log('Players:', data.players);
 });
 
@@ -31,86 +31,11 @@ server.init({
   hash: 'game-version-hash-123',
   world: { score: 0, level: 1 },
   self: {
-    public: { name: 'Player1' },
-    private: { health: 100 }
+    public: { name: 'Player1', x: 100, y: 100 }
   }
 });
 ```
 
-## 新特性 🎉
-
-### 同步优化（v2.0+）
-
-我们对同步机制进行了全面优化，提供更可靠和高效的数据同步：
-
-#### 1. **时间戳和序列号**
-- ✅ 每条消息都包含服务器时间戳和序列号
-- ✅ 自动检测消息丢失和延迟警告
-- ✅ 确保数据按正确顺序处理
-- ✅ 实时显示网络延迟和序列号状态
-
-```javascript
-server.onData((data) => {
-  console.log('时间戳:', data.timestamp);
-  console.log('序列号:', data.sequence);
-  console.log('数据:', data.world);
-});
-```
-
-#### 2. **操作确认机制**
-- 支持回调确认每个更新操作
-- 自动超时检测（5秒）
-- 返回唯一操作ID用于追踪
-
-```javascript
-server.update({
-  world: { score: 100 }
-}, (error, result) => {
-  if (error) {
-    console.error('更新失败:', error);
-  } else {
-    console.log('更新已确认:', result);
-  }
-});
-```
-
-#### 3. **增量更新**
-- 只发送变化的数据，节省带宽
-- 支持数组追加操作
-- 特别适合笔画等增量数据
-
-```javascript
-server.updateDelta({
-  world: {
-    strokes: {
-      $append: [newStroke]  // 只追加新笔画
-    }
-  }
-}, (error, result) => {
-  console.log('增量更新完成');
-});
-```
-
-#### 4. **自适应推送频率**
-- 服务器根据活动情况动态调整推送频率
-- 高活动：50ms 推送一次
-- 中活动：100ms 推送一次
-- 低活动：200ms 推送一次
-- 无活动：500ms 推送一次
-
-#### 5. **统计信息**
-- 实时查看连接状态和同步统计
-- 监控消息丢失和延迟
-
-```javascript
-const stats = server.getStats();
-console.log('连接状态:', stats.connected);
-console.log('本地序列号:', stats.localSequence);
-console.log('最后接收序列号:', stats.lastReceivedSequence);
-console.log('待确认操作数:', stats.pendingOperations);
-console.log('更新次数:', stats.updateCount);
-```
-
 ## API
 
 ### 构造函数
@@ -136,8 +61,7 @@ server.init({
   hash: 'game-version-hash-123',  // 必需：游戏版本哈希值
   world: { score: 0, level: 1 },   // 可选：世界初始数据
   self: {
-    public: { name: 'Player1' },     // 可选：公开数据
-    private: { health: 100 }         // 可选：私有数据
+    public: { name: 'Player1', x: 100, y: 100 }     // 可选：公开数据
   }
 });
 ```
@@ -146,16 +70,15 @@ server.init({
 ```json
 {
   "world": { "score": 0, "level": 1 },
-  "self": {
-    "public": { "name": "Player1" },
-    "private": { "health": 100 }
-  },
+  "self": { "name": "Player1", "x": 100, "y": 100 },
   "players": [
-    { "name": "Player2", "position": { "x": 10, "y": 20 } }
+    { "name": "Player2", "x": 10, "y": 20 }
   ]
 }
 ```
 
+**注意：** `self` 和 `players[i]` 现在具有相同的结构，都只包含公开数据。
+
 **关于 hash：**
 - **hash 相同**：传入的值不生效，直接返回现有数据
 - **hash 不同**：删除旧服务器并重新创建，使用传入的值初始化数据
@@ -168,50 +91,29 @@ server.init({
 部分更新数据（合并到现有数据，不替换）。
 
 ```javascript
-// 基本更新（不带确认）
+// 更新世界数据
 server.update({ world: { score: 200 } });
 
-// 带确认回调的更新（推荐）
-server.update({
-  world: { score: 200 }
-}, (error, result) => {
-  if (error) {
-    console.error('更新失败:', error);
-  } else {
-    console.log('更新已确认');
-  }
-});
-
 // 更新玩家数据
 server.update({
   self: {
-    public: { position: { x: 15, y: 25 } },
-    private: { health: 90 }
+    public: { x: 15, y: 25, rotation: 90 }
   }
 });
 
 // 同时更新世界和玩家数据
 server.update({
   world: { score: 200 },
-  self: { public: { position: { x: 15, y: 25 } } }
+  self: { public: { x: 15, y: 25 } }
 });
 ```
 
-**参数：**
-- `updateData`: 要更新的数据对象
-- `callback` (可选): 确认回调函数 `(error, result) => {}`
-
-**返回值：** 操作ID（字符串），可用于追踪操作
-
 **响应数据（通过 onData 接收）：**
 ```json
 {
   "world": { "score": 200, "level": 1 },
-  "self": {
-    "public": { "name": "Player1", "position": { "x": 15, "y": 25 } },
-    "private": { "health": 90, "mana": 50 }
-  },
-  "players": [{ "name": "Player2", "position": { "x": 10, "y": 20 } }]
+  "self": { "name": "Player1", "x": 15, "y": 25, "rotation": 90 },
+  "players": [{ "name": "Player2", "x": 10, "y": 20 }]
 }
 ```
 
@@ -235,87 +137,16 @@ unsubscribe();
 **数据格式：**
 ```json
 {
-  "timestamp": 1705123456789,
-  "sequence": 42,
   "world": { "score": 200, "level": 1 },
-  "self": {
-    "public": { "name": "Player1", "position": { "x": 15, y: 25 } },
-    "private": { "health": 90, "mana": 50 }
-  },
+  "self": { "name": "Player1", "x": 15, "y": 25 },
   "players": [
-    { "name": "Player2", "position": { "x": 10, "y": 20 } },
-    { "name": "Player3", "position": { "x": 30, "y": 40 } }
+    { "name": "Player2", "x": 10, "y": 20 },
+    { "name": "Player3", "x": 30, "y": 40 }
   ]
 }
 ```
 
-**字段说明：**
-- `timestamp`: 服务器时间戳（毫秒）
-- `sequence`: 消息序列号（用于检测消息丢失）
-- `world`: 世界数据
-- `self`: 当前玩家数据
-- `players`: 其他玩家数据
-
-### 4. updateDelta() - 增量更新 ✨
-
-只发送变化的数据，适合频繁更新的场景（如画板笔画）。
-
-```javascript
-// 追加新笔画（不发送整个数组）
-const newStroke = {
-  id: 'stroke_123',
-  points: [{ x: 0, y: 0 }, { x: 10, y: 10 }],
-  color: '#FF0000',
-  width: 2
-};
-
-server.updateDelta({
-  world: {
-    strokes: {
-      $append: [newStroke]  // 使用 $append 标记表示追加
-    }
-  }
-}, (error, result) => {
-  if (!error) {
-    console.log('笔画已添加');
-  }
-});
-```
-
-**参数：**
-- `delta`: 增量数据对象（支持 `$append` 等特殊操作）
-- `callback` (可选): 确认回调函数
-
-**返回值：** 操作ID
-
-### 5. getStats() - 获取统计信息 ✨
-
-获取实时同步统计信息，用于监控和调试。
-
-```javascript
-const stats = server.getStats();
-console.log(stats);
-// {
-//   connected: true,
-//   initialized: true,
-//   localSequence: 10,
-//   lastReceivedSequence: 8,
-//   lastReceivedTimestamp: 1705123456789,
-//   pendingOperations: 2,
-//   updateCount: 10,
-//   lastUpdateTime: 1705123456789
-// }
-```
-
-**返回值：**
-- `connected`: 是否已连接
-- `initialized`: 是否已初始化
-- `localSequence`: 本地发送的序列号
-- `lastReceivedSequence`: 最后接收的序列号
-- `lastReceivedTimestamp`: 最后接收的时间戳
-- `pendingOperations`: 待确认的操作数量
-- `updateCount`: 总更新次数
-- `lastUpdateTime`: 最后更新时间
+**注意：** `self` 和 `players[i]` 具有相同的数据结构，都只包含公开数据。
 
 **推送时机：** init 响应、定时推送（每 0.2 秒）、init/update 后立即推送
 
@@ -334,8 +165,8 @@ const server = new RiffleServer({
 
 // 监听服务器推送，更新游戏状态
 server.onData((data) => {
-  // 更新自己的位置
-  const myPosition = data.self?.public?.position;
+  // 更新自己的位置（self 现在直接是公开数据对象）
+  const myPosition = { x: data.self.x, y: data.self.y };
   
   // 更新其他玩家列表
   const otherPlayers = data.players || [];
@@ -354,8 +185,7 @@ server.init({
   hash: 'v1.0.0',
   world: { score: 0, level: 1 },
   self: {
-    public: { name: 'Player1', position: { x: 0, y: 0 } },
-    private: { health: 100 }
+    public: { name: 'Player1', x: 0, y: 0 }
   }
 });
 
@@ -363,7 +193,7 @@ server.init({
 function movePlayer(x, y) {
   server.update({
     self: {
-      public: { position: { x, y } }
+      public: { x, y }
     }
   });
 }

package/index.d.ts

@@ -19,12 +19,13 @@ export interface RiffleServerOptions {
 }
 
 /**
- * 玩家数据
+ * 玩家数据（用于发送 init/update 请求）
+ * 注意：此格式仅用于客户端发送数据，服务端返回的 self 已不再使用此结构
  */
 export interface PlayerSelfData {
   /** 公开数据 */
   public?: Record<string, any>;
-  /** 私有数据 */
+  /** 私有数据（已弃用，服务端不再使用） */
   private?: Record<string, any>;
 }
 
@@ -56,8 +57,8 @@ export interface UpdateData {
 export interface ServerData {
   /** 世界数据 */
   world: Record<string, any>;
-  /** 当前玩家数据 */
-  self: PlayerSelfData;
+  /** 当前玩家数据（仅公开数据，与 players[i] 结构一致） */
+  self: Record<string, any>;
   /** 其他玩家列表（仅公开数据） */
   players: Array<Record<string, any>>;
 }

package/index.js

@@ -44,7 +44,7 @@ if (typeof window !== 'undefined' && window.WebSocket) {
  * // 监听服务器推送的最新数据
  * server.onData((data) => {
  *   console.log('World:', data.world);
- *   console.log('Self:', data.self);
+ *   console.log('Self:', data.self);          // self 现在直接是公开数据，与 players[i] 结构一致
  *   console.log('Players:', data.players);
  * });
  * 
@@ -53,8 +53,7 @@ if (typeof window !== 'undefined' && window.WebSocket) {
  *   hash: 'game-version-hash-123',  // 游戏版本哈希值
  *   world: { score: 0, level: 1 },   // 世界初始数据（可选）
  *   self: {
- *     public: { name: 'Player1' },   // 公开数据（可选）
- *     private: { health: 100 }      // 私有数据（可选）
+ *     public: { name: 'Player1', x: 100, y: 100 }   // 公开数据（可选）
  *   }
  * });
  * 
@@ -62,8 +61,7 @@ if (typeof window !== 'undefined' && window.WebSocket) {
  * server.update({ 
  *   world: { score: 200 },
  *   self: { 
- *     public: { position: { x: 15, y: 25 } },
- *     private: { health: 90 }
+ *     public: { x: 15, y: 25, rotation: 90 }
  *   }
  * });
  * ```
@@ -269,15 +267,25 @@ export class RiffleServer {
    * @param {string} initData.hash - 游戏版本哈希值（必需）
    * @param {Object} [initData.world] - 世界初始数据（可选）
    * @param {Object} [initData.self] - 玩家初始数据（可选）
-   * @param {Object} [initData.self.public] - 公开数据（可选）
-   * @param {Object} [initData.self.private] - 私有数据（可选）
+   * @param {Object} [initData.self.public] - 公开数据（可选，旧格式）
+   * @param {Object} [initData.self.private] - 私有数据（已弃用）
    * @example
+   * // 推荐：直接传递公开数据
    * server.init({
    *   hash: 'game-version-hash-123',
    *   world: { score: 0, level: 1 },
-   *   self: {
-   *     public: { name: 'Player1' },
-   *     private: { health: 100 }
+   *   self: { 
+   *     public: { name: 'Player1', x: 100, y: 100 }
+   *   }
+   * });
+   * 
+   * @example
+   * // 也支持直接传递对象（服务端会将其作为 public 数据处理）
+   * server.init({
+   *   hash: 'game-version-hash-123',
+   *   world: { score: 0 },
+   *   self: { 
+   *     public: { name: 'Player1' }
    *   }
    * });
    */
@@ -322,13 +330,12 @@ export class RiffleServer {
    * @param {Object} [updateData.world] - 世界数据（可选）
    * @param {Object} [updateData.self] - 玩家数据（可选）
    * @param {Object} [updateData.self.public] - 公开数据（可选）
-   * @param {Object} [updateData.self.private] - 私有数据（可选）
+   * @param {Object} [updateData.self.private] - 私有数据（已弃用）
    * @example
    * server.update({
    *   world: { score: 200 },
    *   self: {
-   *     public: { position: { x: 15, y: 25 } },
-   *     private: { health: 90 }
+   *     public: { x: 15, y: 25, rotation: 90 }
    *   }
    * });
    */
@@ -343,8 +350,11 @@ export class RiffleServer {
    * @example
    * const unsubscribe = server.onData((data) => {
    *   console.log('World:', data.world);
-   *   console.log('Self:', data.self);
+   *   console.log('Self:', data.self);          // self 现在直接是公开数据对象，与 players[i] 结构一致
    *   console.log('Players:', data.players);
+   *   
+   *   // 例如：data.self = { id: 'abc123', name: 'Player1', x: 100, y: 200 }
+   *   // 而 data.players[0] 也是相同结构：{ id: 'def456', name: 'Player2', x: 150, y: 250 }
    * });
    * 
    * // 取消监听

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lzpenguin/server",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Riffle 游戏服务器 WebSocket 客户端 SDK",
   "license": "ISC",
   "author": "lzpenguin",