@lzpenguin/server 1.0.8 → 1.0.9

package/README.md

@@ -50,6 +50,82 @@ new RiffleServer({
 })
 ```
 
+## API 方法
+
+### 细粒度操作 API（推荐）
+
+从 v1.1.0 起，提供了更细粒度的操作 API，使代码更加语义化和易读。
+
+#### World 数据操作
+
+```javascript
+// 添加/设置单个键值对
+server.world.add('score', 100);
+server.world.update('level', 2);
+
+// 删除键（设置为 null）
+server.world.delete('oldKey');
+
+// 批量设置
+server.world.set({ 
+  score: 100, 
+  level: 2, 
+  players: 10 
+});
+```
+
+#### Self 数据操作
+
+```javascript
+// 添加/设置单个键值对
+server.self.add('x', 150);
+server.self.update('y', 250);
+
+// 删除键（设置为 null）
+server.self.delete('oldProp');
+
+// 批量设置
+server.self.set({ 
+  x: 150, 
+  y: 250, 
+  rotation: 90 
+});
+```
+
+#### 完整示例
+
+```javascript
+import { RiffleServer } from '@lzpenguin/server';
+
+const server = new RiffleServer({
+  url: 'wss://api.riffle.app',
+  postId: 123456,
+  token: 'your-token-here'
+});
+
+// 监听数据更新
+server.onData((data) => {
+  console.log('World:', data.world);
+  console.log('Self:', data.self);
+  console.log('Players:', data.players);
+});
+
+// 初始化
+server.init({
+  hash: 'v1.0.0',
+  world: { score: 0, level: 1 },
+  self: { public: { name: 'Player1', x: 0, y: 0 } }
+});
+
+// 使用细粒度 API 更新数据
+server.world.update('score', 100);       // 更新分数
+server.self.update('x', 150);            // 更新 X 坐标
+server.self.update('y', 250);            // 更新 Y 坐标
+
+// 批量更新
+server.self.set({ x: 200, y: 300, rotation: 45 });
+```
+
 ## 三种消息类型
 
 ### 1. init() - 初始化服务器
@@ -86,40 +162,7 @@ server.init({
 
 **注意：** init 成功后服务器每 0.2 秒自动推送最新数据
 
-### 2. update() - 更新数据
-
-部分更新数据（合并到现有数据，不替换）。
-
-```javascript
-// 更新世界数据
-server.update({ world: { score: 200 } });
-
-// 更新玩家数据
-server.update({
-  self: {
-    public: { x: 15, y: 25, rotation: 90 }
-  }
-});
-
-// 同时更新世界和玩家数据
-server.update({
-  world: { score: 200 },
-  self: { public: { x: 15, y: 25 } }
-});
-```
-
-**响应数据（通过 onData 接收）：**
-```json
-{
-  "world": { "score": 200, "level": 1 },
-  "self": { "name": "Player1", "x": 15, "y": 25, "rotation": 90 },
-  "players": [{ "name": "Player2", "x": 10, "y": 20 }]
-}
-```
-
-**注意：** 只更新提供的字段，未提供的字段保持不变，更新后立即推送最新数据
-
-### 3. onData() - 监听数据推送
+### 2. onData() - 监听数据推送
 
 监听服务器推送的最新数据。init 成功后每 0.2 秒自动推送，调用 init/update 后立即推送。
 
@@ -191,18 +234,12 @@ server.init({
 
 // 更新玩家位置
 function movePlayer(x, y) {
-  server.update({
-    self: {
-      public: { x, y }
-    }
-  });
+  server.self.set({ x, y });
 }
 
 // 更新分数
 function updateScore(score) {
-  server.update({
-    world: { score }
-  });
+  server.world.update('score', score);
 }
 ```
 

package/index.d.ts

@@ -63,6 +63,68 @@ export interface ServerData {
   players: Array<Record<string, any>>;
 }
 
+/**
+ * WorldManager - 管理 world 数据的细粒度操作
+ */
+export class WorldManager {
+  /**
+   * 添加或设置 world 中的键值对
+   * @param key 键名
+   * @param value 值
+   */
+  add(key: string, value: any): void;
+
+  /**
+   * 更新 world 中的键值对（与 add 相同，提供语义化接口）
+   * @param key 键名
+   * @param value 值
+   */
+  update(key: string, value: any): void;
+
+  /**
+   * 删除 world 中的键（通过设置为 null）
+   * @param key 键名
+   */
+  delete(key: string): void;
+
+  /**
+   * 批量设置多个键值对
+   * @param data 键值对对象
+   */
+  set(data: Record<string, any>): void;
+}
+
+/**
+ * SelfManager - 管理 self 数据的细粒度操作
+ */
+export class SelfManager {
+  /**
+   * 添加或设置 self.public 中的键值对
+   * @param key 键名
+   * @param value 值
+   */
+  add(key: string, value: any): void;
+
+  /**
+   * 更新 self.public 中的键值对（与 add 相同，提供语义化接口）
+   * @param key 键名
+   * @param value 值
+   */
+  update(key: string, value: any): void;
+
+  /**
+   * 删除 self.public 中的键（通过设置为 null）
+   * @param key 键名
+   */
+  delete(key: string): void;
+
+  /**
+   * 批量设置多个键值对
+   * @param data 键值对对象
+   */
+  set(data: Record<string, any>): void;
+}
+
 /**
  * RiffleServer - 游戏服务器 WebSocket 客户端
  */
@@ -80,18 +142,17 @@ export class RiffleServer {
   /** 是否已初始化 */
   readonly isInitialized: boolean;
 
+  /** World 数据管理器 */
+  readonly world: WorldManager;
+  /** Self 数据管理器 */
+  readonly self: SelfManager;
+
   /**
    * 初始化服务器（必需，连接后必须先调用）
    * @param initData 初始化数据
    */
   init(initData: InitData): void;
 
-  /**
-   * 更新数据（部分更新，合并到现有数据）
-   * @param updateData 更新数据
-   */
-  update(updateData: UpdateData): void;
-
   /**
    * 监听服务器推送的最新数据
    * @param callback 回调函数，接收服务器推送的数据

package/index.js

@@ -28,12 +28,98 @@ if (typeof window !== 'undefined' && window.WebSocket) {
   }
 }
 
+/**
+ * WorldManager - 管理 world 数据的细粒度操作
+ */
+class WorldManager {
+  constructor(server) {
+    this._server = server;
+  }
+
+  /**
+   * 添加或设置 world 中的键值对
+   * @param {string} key - 键名
+   * @param {any} value - 值
+   */
+  add(key, value) {
+    this._server.sendUpdate({ world: { [key]: value } });
+  }
+
+  /**
+   * 更新 world 中的键值对（与 add 相同，提供语义化接口）
+   * @param {string} key - 键名
+   * @param {any} value - 值
+   */
+  update(key, value) {
+    this._server.sendUpdate({ world: { [key]: value } });
+  }
+
+  /**
+   * 删除 world 中的键（通过设置为 null）
+   * @param {string} key - 键名
+   */
+  delete(key) {
+    this._server.sendUpdate({ world: { [key]: null } });
+  }
+
+  /**
+   * 批量设置多个键值对
+   * @param {Object} data - 键值对对象
+   */
+  set(data) {
+    this._server.sendUpdate({ world: data });
+  }
+}
+
+/**
+ * SelfManager - 管理 self 数据的细粒度操作
+ */
+class SelfManager {
+  constructor(server) {
+    this._server = server;
+  }
+
+  /**
+   * 添加或设置 self.public 中的键值对
+   * @param {string} key - 键名
+   * @param {any} value - 值
+   */
+  add(key, value) {
+    this._server.sendUpdate({ self: { public: { [key]: value } } });
+  }
+
+  /**
+   * 更新 self.public 中的键值对（与 add 相同，提供语义化接口）
+   * @param {string} key - 键名
+   * @param {any} value - 值
+   */
+  update(key, value) {
+    this._server.sendUpdate({ self: { public: { [key]: value } } });
+  }
+
+  /**
+   * 删除 self.public 中的键（通过设置为 null）
+   * @param {string} key - 键名
+   */
+  delete(key) {
+    this._server.sendUpdate({ self: { public: { [key]: null } } });
+  }
+
+  /**
+   * 批量设置多个键值对
+   * @param {Object} data - 键值对对象
+   */
+  set(data) {
+    this._server.sendUpdate({ self: { public: data } });
+  }
+}
+
 /**
  * RiffleServer - 游戏服务器 WebSocket 客户端
  * 
  * @example
  * ```js
- * import { RiffleServer } from '@riffle/server';
+ * import { RiffleServer } from '@lzpenguin/server';
  * 
  * const server = new RiffleServer({
  *   url: 'wss://api.riffle.app',
@@ -44,26 +130,31 @@ if (typeof window !== 'undefined' && window.WebSocket) {
  * // 监听服务器推送的最新数据
  * server.onData((data) => {
  *   console.log('World:', data.world);
- *   console.log('Self:', data.self);          // self 现在直接是公开数据，与 players[i] 结构一致
+ *   console.log('Self:', data.self);
  *   console.log('Players:', data.players);
  * });
  * 
  * // 初始化服务器（必需，连接后必须先调用）
  * server.init({
- *   hash: 'game-version-hash-123',  // 游戏版本哈希值
- *   world: { score: 0, level: 1 },   // 世界初始数据（可选）
+ *   hash: 'game-version-hash-123',
+ *   world: { score: 0, level: 1 },
  *   self: {
- *     public: { name: 'Player1', x: 100, y: 100 }   // 公开数据（可选）
+ *     public: { name: 'Player1', x: 100, y: 100 }
  *   }
  * });
  * 
- * // 更新数据
- * server.update({ 
- *   world: { score: 200 },
- *   self: { 
- *     public: { x: 15, y: 25, rotation: 90 }
- *   }
- * });
+ * // 新的细粒度操作 API
+ * server.world.add('score', 200);           // 添加/更新 world.score
+ * server.world.update('level', 2);          // 更新 world.level
+ * server.world.delete('oldKey');            // 删除 world.oldKey
+ * 
+ * server.self.add('x', 150);                // 添加/更新 self.public.x
+ * server.self.update('y', 250);             // 更新 self.public.y
+ * server.self.delete('oldProp');            // 删除 self.public.oldProp
+ * 
+ * // 批量操作
+ * server.world.set({ score: 200, level: 2 });
+ * server.self.set({ x: 150, y: 250, rotation: 90 });
  * ```
  */
 export class RiffleServer {
@@ -105,6 +196,10 @@ export class RiffleServer {
     // 当前服务器数据缓存
     this.currentData = null;
 
+    // 创建细粒度操作管理器
+    this.world = new WorldManager(this);
+    this.self = new SelfManager(this);
+
     // 连接状态（异步调用，不阻塞构造函数）
     this.connect().catch(err => {
       console.error('[RiffleServer] Initial connection failed:', err);
@@ -324,25 +419,6 @@ export class RiffleServer {
     }
   }
 
-  /**
-   * 更新数据（部分更新）
-   * @param {Object} updateData - 更新数据
-   * @param {Object} [updateData.world] - 世界数据（可选）
-   * @param {Object} [updateData.self] - 玩家数据（可选）
-   * @param {Object} [updateData.self.public] - 公开数据（可选）
-   * @param {Object} [updateData.self.private] - 私有数据（已弃用）
-   * @example
-   * server.update({
-   *   world: { score: 200 },
-   *   self: {
-   *     public: { x: 15, y: 25, rotation: 90 }
-   *   }
-   * });
-   */
-  update(updateData) {
-    this.sendUpdate(updateData);
-  }
-
   /**
    * 监听服务器推送的最新数据
    * @param {Function} callback - 回调函数，接收服务器推送的数据

package/package.json

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