@lzpenguin/server 1.0.0 → 1.0.1

package/index.d.ts

@@ -0,0 +1,101 @@
+/**
+ * Riffle 游戏服务器 WebSocket 客户端 SDK
+ */
+
+/**
+ * RiffleServer 构造函数选项
+ */
+export interface RiffleServerOptions {
+  /** WebSocket 服务器 URL */
+  url: string;
+  /** 游戏贴文 ID */
+  postId: number;
+  /** 认证 token */
+  token: string;
+  /** 是否自动重连，默认 true */
+  autoReconnect?: boolean;
+  /** 重连间隔（毫秒），默认 3000 */
+  reconnectInterval?: number;
+}
+
+/**
+ * 玩家数据
+ */
+export interface PlayerSelfData {
+  /** 公开数据 */
+  public?: Record<string, any>;
+  /** 私有数据 */
+  private?: Record<string, any>;
+}
+
+/**
+ * 初始化数据
+ */
+export interface InitData {
+  /** 游戏版本哈希值（必需） */
+  hash: string;
+  /** 世界初始数据（可选） */
+  world?: Record<string, any>;
+  /** 玩家初始数据（可选） */
+  self?: PlayerSelfData;
+}
+
+/**
+ * 更新数据
+ */
+export interface UpdateData {
+  /** 世界数据（可选，部分更新） */
+  world?: Record<string, any>;
+  /** 玩家数据（可选，部分更新） */
+  self?: PlayerSelfData;
+}
+
+/**
+ * 服务器推送的数据
+ */
+export interface ServerData {
+  /** 世界数据 */
+  world: Record<string, any>;
+  /** 当前玩家数据 */
+  self: PlayerSelfData;
+  /** 其他玩家列表（仅公开数据） */
+  players: Array<Record<string, any>>;
+}
+
+/**
+ * RiffleServer - 游戏服务器 WebSocket 客户端
+ */
+export class RiffleServer {
+  /**
+   * 创建 RiffleServer 实例
+   * @param options 配置选项
+   */
+  constructor(options: RiffleServerOptions);
+
+  /** 是否已连接 */
+  readonly isConnected: boolean;
+  /** 是否正在连接 */
+  readonly isConnecting: boolean;
+  /** 是否已初始化 */
+  readonly isInitialized: boolean;
+
+  /**
+   * 初始化服务器（必需，连接后必须先调用）
+   * @param initData 初始化数据
+   */
+  init(initData: InitData): void;
+
+  /**
+   * 更新数据（部分更新，合并到现有数据）
+   * @param updateData 更新数据
+   */
+  update(updateData: UpdateData): void;
+
+  /**
+   * 监听服务器推送的最新数据
+   * @param callback 回调函数，接收服务器推送的数据
+   * @returns 取消监听的函数
+   */
+  onData(callback: (data: ServerData) => void): () => void;
+}
+

package/package.json

@@ -1,18 +1,21 @@
 {
   "name": "@lzpenguin/server",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Riffle 游戏服务器 WebSocket 客户端 SDK",
   "license": "ISC",
   "author": "lzpenguin",
   "type": "module",
   "main": "./index.js",
+  "types": "./index.d.ts",
   "exports": {
     ".": {
-      "import": "./index.js"
+      "import": "./index.js",
+      "types": "./index.d.ts"
     }
   },
   "files": [
     "index.js",
+    "index.d.ts",
     "README.md"
   ],
   "keywords": [
@@ -34,4 +37,3 @@
     "registry": "https://registry.npmjs.org/"
   }
 }
-