@esengine/network 1.0.0 → 2.1.0

package/dist/NetworkPlugin.d.ts

@@ -1,99 +1,113 @@
+/**
+ * @zh 网络插件
+ * @en Network Plugin
+ */
 import { type IPlugin, Core, type ServiceContainer } from '@esengine/ecs-framework';
-import { NetworkService } from './services/NetworkService';
+import { GameNetworkService, type NetworkServiceOptions } from './services/NetworkService';
 import { NetworkSyncSystem } from './systems/NetworkSyncSystem';
 import { NetworkSpawnSystem, type PrefabFactory } from './systems/NetworkSpawnSystem';
 import { NetworkInputSystem } from './systems/NetworkInputSystem';
 /**
- * 网络插件
- * Network plugin
+ * @zh 网络插件
+ * @en Network plugin
  *
- * 提供基于 TSRPC 的网络同步功能。
- * Provides TSRPC-based network synchronization.
+ * @zh 提供基于 @esengine/rpc 的网络同步功能
+ * @en Provides @esengine/rpc based network synchronization
  *
  * @example
  * ```typescript
- * import { Core } from '@esengine/ecs-framework';
- * import { NetworkPlugin } from '@esengine/network';
+ * import { Core } from '@esengine/ecs-framework'
+ * import { NetworkPlugin } from '@esengine/network'
  *
- * const networkPlugin = new NetworkPlugin();
- * await Core.installPlugin(networkPlugin);
+ * const networkPlugin = new NetworkPlugin()
+ * await Core.installPlugin(networkPlugin)
  *
- * // 连接到服务器 | Connect to server
- * await networkPlugin.connect('ws://localhost:3000', 'Player1');
+ * // 连接到服务器
+ * await networkPlugin.connect({ url: 'ws://localhost:3000', playerName: 'Player1' })
  *
- * // 注册预制体 | Register prefab
+ * // 注册预制体
  * networkPlugin.registerPrefab('player', (scene, spawn) => {
- *     const entity = scene.createEntity('Player');
- *     return entity;
- * });
+ *     const entity = scene.createEntity('Player')
+ *     return entity
+ * })
  * ```
  */
 export declare class NetworkPlugin implements IPlugin {
     readonly name = "@esengine/network";
-    readonly version = "1.0.0";
+    readonly version = "2.0.0";
     private _networkService;
     private _syncSystem;
     private _spawnSystem;
     private _inputSystem;
+    private _localPlayerId;
     /**
-     * 网络服务
-     * Network service
+     * @zh 网络服务
+     * @en Network service
      */
-    get networkService(): NetworkService;
+    get networkService(): GameNetworkService;
     /**
-     * 同步系统
-     * Sync system
+     * @zh 同步系统
+     * @en Sync system
      */
     get syncSystem(): NetworkSyncSystem;
     /**
-     * 生成系统
-     * Spawn system
+     * @zh 生成系统
+     * @en Spawn system
      */
     get spawnSystem(): NetworkSpawnSystem;
     /**
-     * 输入系统
-     * Input system
+     * @zh 输入系统
+     * @en Input system
      */
     get inputSystem(): NetworkInputSystem;
     /**
-     * 是否已连接
-     * Is connected
+     * @zh 本地玩家 ID
+     * @en Local player ID
+     */
+    get localPlayerId(): number;
+    /**
+     * @zh 是否已连接
+     * @en Is connected
      */
     get isConnected(): boolean;
     /**
-     * 安装插件
-     * Install plugin
+     * @zh 安装插件
+     * @en Install plugin
      */
     install(_core: Core, _services: ServiceContainer): void;
     /**
-     * 卸载插件
-     * Uninstall plugin
+     * @zh 卸载插件
+     * @en Uninstall plugin
      */
     uninstall(): void;
     private _setupSystems;
+    private _setupMessageHandlers;
     /**
-     * 连接到服务器
-     * Connect to server
+     * @zh 连接到服务器
+     * @en Connect to server
      */
-    connect(serverUrl: string, playerName: string, roomId?: string): Promise<boolean>;
+    connect(options: NetworkServiceOptions & {
+        playerName: string;
+        roomId?: string;
+    }): Promise<boolean>;
     /**
-     * 断开连接
-     * Disconnect
+     * @zh 断开连接
+     * @en Disconnect
      */
     disconnect(): Promise<void>;
     /**
-     * 注册预制体工厂
-     * Register prefab factory
+     * @zh 注册预制体工厂
+     * @en Register prefab factory
      */
     registerPrefab(prefabType: string, factory: PrefabFactory): void;
     /**
-     * 发送移动输入
-     * Send move input
+     * @zh 发送移动输入
+     * @en Send move input
      */
     sendMoveInput(x: number, y: number): void;
     /**
-     * 发送动作输入
-     * Send action input
+     * @zh 发送动作输入
+     * @en Send action input
      */
     sendActionInput(action: string): void;
 }

package/dist/NetworkPlugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NetworkPlugin.d.ts","sourceRoot":"","sources":["../src/NetworkPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,IAAI,EAAE,KAAK,gBAAgB,EAAc,MAAM,yBAAyB,CAAC;AAChG,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,KAAK,aAAa,EAAE,MAAM,8BAA8B,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAElE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,aAAc,YAAW,OAAO;IACzC,SAAgB,IAAI,uBAAuB;IAC3C,SAAgB,OAAO,WAAW;IAElC,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,WAAW,CAAqB;IACxC,OAAO,CAAC,YAAY,CAAsB;IAC1C,OAAO,CAAC,YAAY,CAAsB;IAE1C;;;OAGG;IACH,IAAI,cAAc,IAAI,cAAc,CAEnC;IAED;;;OAGG;IACH,IAAI,UAAU,IAAI,iBAAiB,CAElC;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,kBAAkB,CAEpC;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,kBAAkB,CAEpC;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;;OAGG;IACH,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,gBAAgB,GAAG,IAAI;IAWvD;;;OAGG;IACH,SAAS,IAAI,IAAI;IAIjB,OAAO,CAAC,aAAa;IAUrB;;;OAGG;IACU,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI9F;;;OAGG;IACU,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxC;;;OAGG;IACI,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,IAAI;IAIvE;;;OAGG;IACI,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI;IAIhD;;;OAGG;IACI,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;CAG/C"}
+{"version":3,"file":"NetworkPlugin.d.ts","sourceRoot":"","sources":["../src/NetworkPlugin.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,OAAO,EAAE,IAAI,EAAE,KAAK,gBAAgB,EAAc,MAAM,yBAAyB,CAAA;AAC/F,OAAO,EAAE,kBAAkB,EAAE,KAAK,qBAAqB,EAAE,MAAM,2BAA2B,CAAA;AAC1F,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAA;AAC/D,OAAO,EAAE,kBAAkB,EAAE,KAAK,aAAa,EAAE,MAAM,8BAA8B,CAAA;AACrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAA;AAEjE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,aAAc,YAAW,OAAO;IACzC,SAAgB,IAAI,uBAAsB;IAC1C,SAAgB,OAAO,WAAU;IAEjC,OAAO,CAAC,eAAe,CAAqB;IAC5C,OAAO,CAAC,WAAW,CAAoB;IACvC,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,cAAc,CAAY;IAElC;;;OAGG;IACH,IAAI,cAAc,IAAI,kBAAkB,CAEvC;IAED;;;OAGG;IACH,IAAI,UAAU,IAAI,iBAAiB,CAElC;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,kBAAkB,CAEpC;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,kBAAkB,CAEpC;IAED;;;OAGG;IACH,IAAI,aAAa,IAAI,MAAM,CAE1B;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;;OAGG;IACH,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,gBAAgB,GAAG,IAAI;IASvD;;;OAGG;IACH,SAAS,IAAI,IAAI;IAIjB,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,qBAAqB;IAa7B;;;OAGG;IACU,OAAO,CAAC,OAAO,EAAE,qBAAqB,GAAG;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAkBhH;;;OAGG;IACU,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IASxC;;;OAGG;IACI,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,IAAI;IAIvE;;;OAGG;IACI,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI;IAIhD;;;OAGG;IACI,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;CAG/C"}

package/dist/index.d.ts

@@ -1,23 +1,26 @@
 /**
- * @esengine/network
+ * @zh @esengine/network 网络同步模块
+ * @en @esengine/network Network synchronization module
  *
- * 基于 TSRPC 的网络同步模块（客户端）
- * TSRPC-based network synchronization module (client)
+ * @zh 基于 @esengine/rpc 的网络同步模块，提供类型安全的多人游戏网络通信
+ * @en Network synchronization module based on @esengine/rpc for type-safe multiplayer game communication
  */
-export type { ServiceType, Vec2, IEntityState, IPlayerInput, MsgSync, MsgInput, MsgSpawn, MsgDespawn, ReqJoin, ResJoin } from '@esengine/network-protocols';
-export { serviceProto } from '@esengine/network-protocols';
-export { NetworkServiceToken, NetworkSyncSystemToken, NetworkSpawnSystemToken, NetworkInputSystemToken } from './tokens';
+export { rpc } from '@esengine/rpc';
+export type { ProtocolDef, ApiDef, MsgDef, ApiInput, ApiOutput, MsgData, ApiNames, MsgNames, RpcError, } from '@esengine/rpc';
+export { gameProtocol, type GameProtocol, type PlayerInput, type EntitySyncState, type SyncData, type SpawnData, type DespawnData, type JoinRequest, type JoinResponse, } from './protocol';
+export { NetworkServiceToken, NetworkSyncSystemToken, NetworkSpawnSystemToken, NetworkInputSystemToken, } from './tokens';
 export { NetworkPlugin } from './NetworkPlugin';
-export { NetworkService, ENetworkState } from './services/NetworkService';
-export type { INetworkCallbacks } from './services/NetworkService';
+export { RpcService, GameNetworkService, NetworkService, NetworkState, createNetworkService, } from './services/NetworkService';
+export type { NetworkServiceOptions } from './services/NetworkService';
 export { NetworkIdentity } from './components/NetworkIdentity';
 export { NetworkTransform } from './components/NetworkTransform';
 export { NetworkSyncSystem } from './systems/NetworkSyncSystem';
+export type { SyncMessage } from './systems/NetworkSyncSystem';
 export { NetworkSpawnSystem } from './systems/NetworkSpawnSystem';
-export type { PrefabFactory } from './systems/NetworkSpawnSystem';
+export type { PrefabFactory, SpawnMessage, DespawnMessage } from './systems/NetworkSpawnSystem';
 export { NetworkInputSystem } from './systems/NetworkInputSystem';
-export type { IStateSnapshot, ITransformState, ITransformStateWithVelocity, ISnapshotBufferConfig, ISnapshotBuffer } from './sync';
-export type { IInterpolator, IExtrapolator, IInputSnapshot, IPredictedState, IPredictor, ClientPredictionConfig } from './sync';
-export { lerp, lerpAngle, smoothDamp, SnapshotBuffer, createSnapshotBuffer, TransformInterpolator, HermiteTransformInterpolator, createTransformInterpolator, createHermiteTransformInterpolator, ClientPrediction, createClientPrediction } from './sync';
-export { IsLocalPlayerTemplate, IsServerTemplate, HasAuthorityTemplate, GetNetworkIdTemplate, GetLocalPlayerIdTemplate, IsLocalPlayerExecutor, IsServerExecutor, HasAuthorityExecutor, GetNetworkIdExecutor, GetLocalPlayerIdExecutor, NetworkNodeDefinitions } from './nodes';
+export type { IStateSnapshot, ITransformState, ITransformStateWithVelocity, ISnapshotBufferConfig, ISnapshotBuffer, } from './sync';
+export type { IInterpolator, IExtrapolator, IInputSnapshot, IPredictedState, IPredictor, ClientPredictionConfig, } from './sync';
+export { lerp, lerpAngle, smoothDamp, SnapshotBuffer, createSnapshotBuffer, TransformInterpolator, HermiteTransformInterpolator, createTransformInterpolator, createHermiteTransformInterpolator, ClientPrediction, createClientPrediction, } from './sync';
+export { IsLocalPlayerTemplate, IsServerTemplate, HasAuthorityTemplate, GetNetworkIdTemplate, GetLocalPlayerIdTemplate, IsLocalPlayerExecutor, IsServerExecutor, HasAuthorityExecutor, GetNetworkIdExecutor, GetLocalPlayerIdExecutor, NetworkNodeDefinitions, } from './nodes';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,YAAY,EACR,WAAW,EACX,IAAI,EACJ,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,QAAQ,EACR,QAAQ,EACR,UAAU,EACV,OAAO,EACP,OAAO,EACV,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAM3D,OAAO,EACH,mBAAmB,EACnB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EAC1B,MAAM,UAAU,CAAC;AAMlB,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAMhD,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1E,YAAY,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAMnE,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAMjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,YAAY,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAMlE,YAAY,EACR,cAAc,EACd,eAAe,EACf,2BAA2B,EAC3B,qBAAqB,EACrB,eAAe,EAClB,MAAM,QAAQ,CAAC;AAEhB,YAAY,EACR,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,UAAU,EACV,sBAAsB,EACzB,MAAM,QAAQ,CAAC;AAEhB,OAAO,EACH,IAAI,EACJ,SAAS,EACT,UAAU,EACV,cAAc,EACd,oBAAoB,EACpB,qBAAqB,EACrB,4BAA4B,EAC5B,2BAA2B,EAC3B,kCAAkC,EAClC,gBAAgB,EAChB,sBAAsB,EACzB,MAAM,QAAQ,CAAC;AAMhB,OAAO,EACH,qBAAqB,EACrB,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,wBAAwB,EACxB,qBAAqB,EACrB,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,wBAAwB,EACxB,sBAAsB,EACzB,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAMH,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAA;AACnC,YAAY,EACR,WAAW,EACX,MAAM,EACN,MAAM,EACN,QAAQ,EACR,SAAS,EACT,OAAO,EACP,QAAQ,EACR,QAAQ,EACR,QAAQ,GACX,MAAM,eAAe,CAAA;AAMtB,OAAO,EACH,YAAY,EACZ,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,QAAQ,EACb,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,YAAY,GACpB,MAAM,YAAY,CAAA;AAMnB,OAAO,EACH,mBAAmB,EACnB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,UAAU,CAAA;AAMjB,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAM/C,OAAO,EACH,UAAU,EACV,kBAAkB,EAClB,cAAc,EACd,YAAY,EACZ,oBAAoB,GACvB,MAAM,2BAA2B,CAAA;AAClC,YAAY,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAA;AAMtE,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAMhE,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAA;AAC/D,YAAY,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAA;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAA;AACjE,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAA;AAC/F,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAA;AAMjE,YAAY,EACR,cAAc,EACd,eAAe,EACf,2BAA2B,EAC3B,qBAAqB,EACrB,eAAe,GAClB,MAAM,QAAQ,CAAA;AAEf,YAAY,EACR,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,UAAU,EACV,sBAAsB,GACzB,MAAM,QAAQ,CAAA;AAEf,OAAO,EACH,IAAI,EACJ,SAAS,EACT,UAAU,EACV,cAAc,EACd,oBAAoB,EACpB,qBAAqB,EACrB,4BAA4B,EAC5B,2BAA2B,EAC3B,kCAAkC,EAClC,gBAAgB,EAChB,sBAAsB,GACzB,MAAM,QAAQ,CAAA;AAMf,OAAO,EACH,qBAAqB,EACrB,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,wBAAwB,EACxB,qBAAqB,EACrB,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,wBAAwB,EACxB,sBAAsB,GACzB,MAAM,SAAS,CAAA"}