@zimi/remote 0.2.0 → 0.2.1-alpha.11

package/README.md

@@ -3,6 +3,8 @@
 - 本地可以是浏览器、服务器，甚至一些受限的 `js` 子集
 - 远端可以是任何终端，如 `iframe` / `Java` 服务器 等
 - 对远端响应的数据格式也不严格限制（可以集中解析）
+- 已在公司游戏前后端通信中应用，极大地降低了通信成本（简化调用）
+- ts 类型严格
 
 ## install
 ```
@@ -11,7 +13,7 @@ pnpm i @zimi/remote
 
 ## examples
 
-### 使用示例
+### 调用示意
 
 ```ts
 

package/dist/adaptor.d.ts

@@ -0,0 +1,32 @@
+export interface AdaptorPackageData<D = unknown> {
+    /**
+     * 自身设备 id，应确保唯一性（对方能凭借该 deviceId 找到该设备）
+     */
+    deviceId: string;
+    /**
+     * 对方的设备 id
+     */
+    targetDeviceId: string;
+    /**
+     * 远程调用的对方的方法名
+     */
+    name: string;
+    data: D;
+    /**
+     * 所需回调的方法名（如果需要回调的话）
+     */
+    callbackName?: string;
+}
+type Func<D = unknown, R = unknown> = (data: D) => R;
+export type AdaptorCallback = Func<AdaptorPackageData, void>;
+export interface Adaptor {
+    every: (callback: AdaptorCallback) => void;
+    /**
+     * off 用于移除 once 注册的事件，当事件超时后，需要主动 off
+     */
+    off: (name: string, callback: AdaptorCallback) => void;
+    on: (name: string, callback: AdaptorCallback) => void;
+    once: (name: string, callback: AdaptorCallback) => void;
+    emit: (data: AdaptorPackageData) => void;
+}
+export {};

package/dist/adaptor.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=adaptor.js.map

package/dist/adaptor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adaptor.js","sourceRoot":"","sources":["../src/adaptor.ts"],"names":[],"mappings":""}

package/dist/adaptors/dao3/client.d.ts

@@ -0,0 +1,37 @@
+import EventEmitter from 'eventemitter3';
+import { type AdaptorPackageData } from '../../adaptor';
+interface RemoteChannel {
+    onClientEvent(fn: (e: unknown) => void): void;
+}
+/**
+ * 这是 [dao3 游戏](https://dao3.fun/) 代码客户端适配器。
+ * ```ts
+ * const remoteManager = new ClientSideRemoteChannelEventManager(remoteChannel)
+ *
+ * export const remoteAdaptor = {
+ *   every: remoteManager.onEvery.bind(remoteManager),
+ *   off: remoteManager.off.bind(remoteManager),
+ *   on: remoteManager.on.bind(remoteManager),
+ *   once: remoteManager.once.bind(remoteManager),
+ *   emit: (e) => {
+ *     remoteChannel.sendServerEvent(e)
+ *   },
+ * } satisfies Adaptor
+ *
+ * export const remote = new Remote<RemoteFuncsFromClient, RemoteFuncsFromServer>(
+ *   remoteAdaptor,
+ *   {
+ *     deviceId: `client-${Math.random().toString(36).slice(2)}`,
+ *   }
+ * )
+ *
+ * void remote._.initConnection()
+ * ```
+ */
+export declare class ClientSideRemoteChannelEventManager extends EventEmitter<{
+    [key: string]: [AdaptorPackageData];
+}> {
+    constructor(remoteChannel: RemoteChannel);
+    onEvery(fn: (args: AdaptorPackageData) => void): void;
+}
+export {};

package/dist/adaptors/dao3/client.js

@@ -0,0 +1,45 @@
+import EventEmitter from 'eventemitter3';
+import { isRemoteAdaptorData } from '../../remote';
+/**
+ * 这是 [dao3 游戏](https://dao3.fun/) 代码客户端适配器。
+ * ```ts
+ * const remoteManager = new ClientSideRemoteChannelEventManager(remoteChannel)
+ *
+ * export const remoteAdaptor = {
+ *   every: remoteManager.onEvery.bind(remoteManager),
+ *   off: remoteManager.off.bind(remoteManager),
+ *   on: remoteManager.on.bind(remoteManager),
+ *   once: remoteManager.once.bind(remoteManager),
+ *   emit: (e) => {
+ *     remoteChannel.sendServerEvent(e)
+ *   },
+ * } satisfies Adaptor
+ *
+ * export const remote = new Remote<RemoteFuncsFromClient, RemoteFuncsFromServer>(
+ *   remoteAdaptor,
+ *   {
+ *     deviceId: `client-${Math.random().toString(36).slice(2)}`,
+ *   }
+ * )
+ *
+ * void remote._.initConnection()
+ * ```
+ */
+export class ClientSideRemoteChannelEventManager extends EventEmitter {
+    constructor(remoteChannel) {
+        super();
+        remoteChannel.onClientEvent((e) => {
+            if (!isRemoteAdaptorData(e)) {
+                return;
+            }
+            if (!e.name.startsWith('__REMOTE_VALUE_REQ__')) {
+                this.emit('__remote_every__', e);
+            }
+            this.emit(e.name, e);
+        });
+    }
+    onEvery(fn) {
+        this.on('__remote_every__', fn);
+    }
+}
+//# sourceMappingURL=client.js.map

package/dist/adaptors/dao3/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/adaptors/dao3/client.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAA;AAOlD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,OAAO,mCAAoC,SAAQ,YAEvD;IACA,YAAY,aAA4B;QACtC,KAAK,EAAE,CAAA;QACP,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,EAAE;YAChC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5B,OAAM;YACR,CAAC;YACD,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC,EAAE,CAAC;gBAC/C,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAA;YAClC,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;QACtB,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,OAAO,CAAC,EAAsC;QAC5C,IAAI,CAAC,EAAE,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAA;IACjC,CAAC;CACF"}

package/dist/adaptors/dao3/server.d.ts

@@ -0,0 +1,80 @@
+import EventEmitter from 'eventemitter3';
+import { type AdaptorPackageData } from '../../adaptor';
+interface GamePlayerEntityLike {
+    player: {
+        userKey: string;
+    };
+}
+interface RemoteChannel<T extends GamePlayerEntityLike> {
+    onServerEvent(fn: (e: {
+        args: unknown;
+        entity: T;
+    }) => void): void;
+}
+/**
+ * 这是 [dao3 游戏](https://dao3.fun/) 代码服务端适配器。
+ * ```ts
+ * const remoteManager = new ServerSideRemoteChannelEventManager(remoteChannel)
+ *
+ * world.onPlayerLeave(
+ *   remoteManager.onPlayerLeave.bind(remoteManager)
+ * )
+ *
+ * export const remoteAdaptor = {
+ *   every: remoteManager.onEvery.bind(remoteManager),
+ *   off: remoteManager.off.bind(remoteManager),
+ *   on: remoteManager.on.bind(remoteManager),
+ *   once: remoteManager.once.bind(remoteManager),
+ *   emit: (e) => {
+ *     const entity = remoteManager.getEntity(e.targetDeviceId)
+ *     if (!entity) {
+ *       console.error('entity not found')
+ *       return
+ *     }
+ *     remoteChannel.sendClientEvent(entity, e as unknown as JSONValue)
+ *   },
+ * } satisfies Adaptor
+ *
+ * export const remote = new Remote<RemoteFuncsFromServer, RemoteFuncsFromClient>(
+ *   remoteAdaptor,
+ *   {
+ *     deviceId: 'server',
+ *   }
+ * )
+ *
+ * remote.register('initConnection', async () => {
+ *   // 什么也不干，单纯的让客户端在服务端“备案”
+ * })
+ *
+ * export const getEntity = remoteManager.getEntity.bind(remoteManager)
+ * export const getIdByEntity = remoteManager.getIdByEntity.bind(remoteManager)
+ * export const waitForRegister = remoteManager.waitForRegister.bind(remoteManager)
+ * export const remoteTo = remoteManager.remoteTo.bind(remoteManager)
+ * ```
+ */
+export declare class ServerSideRemoteChannelEventManager<T extends GamePlayerEntityLike> extends EventEmitter<{
+    [key: string]: [AdaptorPackageData];
+}> {
+    entityMap: [string, T][];
+    constructor(remoteChannel: RemoteChannel<T>);
+    onPlayerLeave(e: {
+        entity: T;
+    }): void;
+    onEvery(fn: (args: AdaptorPackageData) => void): void;
+    waitForRegister(entity: T): Promise<void>;
+    getEntity(deviceId: string): T | undefined;
+    getIdByEntity(entity: T): string | undefined;
+    remoteTo(config: {
+        target: T;
+    }): {
+        targetDeviceId: string;
+    };
+    remoteTo(config: {
+        target: T;
+        timeoutMs: number;
+    }): {
+        targetDeviceId: string;
+        timeoutMs: number;
+    };
+}
+export {};

package/dist/adaptors/dao3/server.js

@@ -0,0 +1,105 @@
+import EventEmitter from 'eventemitter3';
+import { isRemoteAdaptorData } from '../../remote';
+import { isRemoteValueEvent } from '../../remoteValue/exposeToRemote';
+/**
+ * 这是 [dao3 游戏](https://dao3.fun/) 代码服务端适配器。
+ * ```ts
+ * const remoteManager = new ServerSideRemoteChannelEventManager(remoteChannel)
+ *
+ * world.onPlayerLeave(
+ *   remoteManager.onPlayerLeave.bind(remoteManager)
+ * )
+ *
+ * export const remoteAdaptor = {
+ *   every: remoteManager.onEvery.bind(remoteManager),
+ *   off: remoteManager.off.bind(remoteManager),
+ *   on: remoteManager.on.bind(remoteManager),
+ *   once: remoteManager.once.bind(remoteManager),
+ *   emit: (e) => {
+ *     const entity = remoteManager.getEntity(e.targetDeviceId)
+ *     if (!entity) {
+ *       console.error('entity not found')
+ *       return
+ *     }
+ *     remoteChannel.sendClientEvent(entity, e as unknown as JSONValue)
+ *   },
+ * } satisfies Adaptor
+ *
+ * export const remote = new Remote<RemoteFuncsFromServer, RemoteFuncsFromClient>(
+ *   remoteAdaptor,
+ *   {
+ *     deviceId: 'server',
+ *   }
+ * )
+ *
+ * remote.register('initConnection', async () => {
+ *   // 什么也不干，单纯的让客户端在服务端“备案”
+ * })
+ *
+ * export const getEntity = remoteManager.getEntity.bind(remoteManager)
+ * export const getIdByEntity = remoteManager.getIdByEntity.bind(remoteManager)
+ * export const waitForRegister = remoteManager.waitForRegister.bind(remoteManager)
+ * export const remoteTo = remoteManager.remoteTo.bind(remoteManager)
+ * ```
+ */
+export class ServerSideRemoteChannelEventManager extends EventEmitter {
+    constructor(remoteChannel) {
+        super();
+        Object.defineProperty(this, "entityMap", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: []
+        });
+        remoteChannel.onServerEvent((e) => {
+            const { args } = e;
+            if (!isRemoteAdaptorData(args)) {
+                return;
+            }
+            const prevItem = this.entityMap.find((item) => item[1].player.userKey === e.entity.player.userKey);
+            if (prevItem) {
+                prevItem[0] = args.deviceId;
+                prevItem[1] = e.entity;
+            }
+            else {
+                this.entityMap.push([args.deviceId, e.entity]);
+            }
+            if (!isRemoteValueEvent(args.name)) {
+                this.emit('__remote_every__', args);
+            }
+            this.emit(args.name, args);
+        });
+    }
+    onPlayerLeave(e) {
+        this.entityMap = this.entityMap.filter((item) => item[1].player.userKey !== e.entity.player.userKey);
+    }
+    onEvery(fn) {
+        this.on('__remote_every__', fn);
+    }
+    waitForRegister(entity) {
+        return new Promise((resolve) => {
+            if (this.entityMap.some(([_, en]) => en.player.userKey === entity.player.userKey)) {
+                resolve();
+                return;
+            }
+            this.once('__remote_every__', () => {
+                resolve();
+            });
+        });
+    }
+    getEntity(deviceId) {
+        var _a;
+        return (_a = this.entityMap.find((item) => item[0] === deviceId)) === null || _a === void 0 ? void 0 : _a[1];
+    }
+    getIdByEntity(entity) {
+        var _a;
+        return (_a = this.entityMap.find((item) => item[1].player.userKey === entity.player.userKey)) === null || _a === void 0 ? void 0 : _a[0];
+    }
+    remoteTo({ target, ...rest }) {
+        return {
+            targetDeviceId: this.getIdByEntity(target),
+            ...rest,
+        };
+    }
+}
+//# sourceMappingURL=server.js.map

package/dist/adaptors/dao3/server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.js","sourceRoot":"","sources":["../../../src/adaptors/dao3/server.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAA;AAClD,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAA;AAarE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,OAAO,mCAEX,SAAQ,YAER;IAGA,YAAY,aAA+B;QACzC,KAAK,EAAE,CAAA;QAHT;;;;mBAA2B,EAAE;WAAA;QAI3B,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,EAAE;YAChC,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;YAClB,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC/B,OAAM;YACR,CAAC;YACD,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAClC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAC7D,CAAA;YACD,IAAI,QAAQ,EAAE,CAAC;gBACb,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAA;gBAC3B,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,CAAA;YACxB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAA;YAChD,CAAC;YACD,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnC,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAA;YACrC,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAC5B,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,aAAa,CAAC,CAAgB;QAC5B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CACpC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAC7D,CAAA;IACH,CAAC;IAED,OAAO,CAAC,EAAsC;QAC5C,IAAI,CAAC,EAAE,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAA;IACjC,CAAC;IAED,eAAe,CAAC,MAAS;QACvB,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YACnC,IACE,IAAI,CAAC,SAAS,CAAC,IAAI,CACjB,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,CACzD,EACD,CAAC;gBACD,OAAO,EAAE,CAAA;gBACT,OAAM;YACR,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,GAAG,EAAE;gBACjC,OAAO,EAAE,CAAA;YACX,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,SAAS,CAAC,QAAgB;;QACxB,OAAO,MAAA,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,0CAAG,CAAC,CAAC,CAAA;IACjE,CAAC;IAED,aAAa,CAAC,MAAS;;QACrB,OAAO,MAAA,IAAI,CAAC,SAAS,CAAC,IAAI,CACxB,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,CAC3D,0CAAG,CAAC,CAAC,CAAA;IACR,CAAC;IASD,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAqC;QAC7D,OAAO;YACL,cAAc,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC;YAC1C,GAAG,IAAI;SACR,CAAA;IACH,CAAC;CACF"}

package/dist/adaptors/http.js

@@ -17,6 +17,7 @@ export const remoteEventManager = new RemoteEventManager();
 export function createHttpAdaptor({ onEmit, }) {
     const adaptor = {
         every: remoteEventManager.onEvery.bind(remoteEventManager),
+        on: remoteEventManager.on.bind(remoteEventManager),
         once: remoteEventManager.once.bind(remoteEventManager),
         off: remoteEventManager.off.bind(remoteEventManager),
         emit: onEmit,

package/dist/adaptors/http.js.map

@@ -1 +1 @@
-{"version":3,"file":"http.js","sourceRoot":"","sources":["../../src/adaptors/http.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAA;AAIxC,MAAM,kBAAmB,SAAQ,YAE/B;IAFF;;QAGE;;;;mBAAmB,kBAAkB;WAAA;IAKvC,CAAC;IAHC,OAAO,CAAC,EAAsC;QAC5C,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAA;IACpC,CAAC;CACF;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,kBAAkB,EAAE,CAAA;AAE1D,MAAM,UAAU,iBAAiB,CAAC,EAChC,MAAM,GAGP;IACC,MAAM,OAAO,GAAY;QACvB,KAAK,EAAE,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC;QAC1D,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC;QACtD,GAAG,EAAE,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC;QACpD,IAAI,EAAE,MAAM;KACb,CAAA;IAED,OAAO,OAAO,CAAA;AAChB,CAAC"}
+{"version":3,"file":"http.js","sourceRoot":"","sources":["../../src/adaptors/http.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAA;AAIxC,MAAM,kBAAmB,SAAQ,YAE/B;IAFF;;QAGE;;;;mBAAmB,kBAAkB;WAAA;IAKvC,CAAC;IAHC,OAAO,CAAC,EAAsC;QAC5C,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAA;IACpC,CAAC;CACF;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,kBAAkB,EAAE,CAAA;AAE1D,MAAM,UAAU,iBAAiB,CAAC,EAChC,MAAM,GAGP;IACC,MAAM,OAAO,GAAY;QACvB,KAAK,EAAE,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC;QAC1D,EAAE,EAAE,kBAAkB,CAAC,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC;QAClD,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC;QACtD,GAAG,EAAE,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC;QACpD,IAAI,EAAE,MAAM;KACb,CAAA;IAED,OAAO,OAAO,CAAA;AAChB,CAAC"}

package/dist/adaptors/iframe.js

@@ -29,6 +29,7 @@ export function createIframeAdaptor({ onEmit, }) {
     const remoteEventManager = new RemoteEventManager();
     const adaptor = {
         every: remoteEventManager.onEvery.bind(remoteEventManager),
+        on: remoteEventManager.on.bind(remoteEventManager),
         once: remoteEventManager.once.bind(remoteEventManager),
         off: remoteEventManager.off.bind(remoteEventManager),
         emit: onEmit,

package/dist/adaptors/iframe.js.map

@@ -1 +1 @@
-{"version":3,"file":"iframe.js","sourceRoot":"","sources":["../../src/adaptors/iframe.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AAI/C,MAAM,kBAAmB,SAAQ,YAE/B;IAGA;QACE,KAAK,EAAE,CAAA;QAHT;;;;mBAAmB,kBAAkB;WAAA;QAInC,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;YAClC,OAAM;QACR,CAAC;QACD,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;YAC3C,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;YACtB,IAAI,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;gBAC1B,oCAAoC;gBACpC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAA;YACxC,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,OAAO,CAAC,EAAsC;QAC5C,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAA;IACpC,CAAC;CACF;AAED,MAAM,UAAU,mBAAmB,CAAC,EAClC,MAAM,GAGP;IACC,MAAM,kBAAkB,GAAG,IAAI,kBAAkB,EAAE,CAAA;IAEnD,MAAM,OAAO,GAAY;QACvB,KAAK,EAAE,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC;QAC1D,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC;QACtD,GAAG,EAAE,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC;QACpD,IAAI,EAAE,MAAM;KACb,CAAA;IAED,OAAO,OAAO,CAAA;AAChB,CAAC"}
+{"version":3,"file":"iframe.js","sourceRoot":"","sources":["../../src/adaptors/iframe.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AAI/C,MAAM,kBAAmB,SAAQ,YAE/B;IAGA;QACE,KAAK,EAAE,CAAA;QAHT;;;;mBAAmB,kBAAkB;WAAA;QAInC,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;YAClC,OAAM;QACR,CAAC;QACD,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;YAC3C,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;YACtB,IAAI,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;gBAC1B,oCAAoC;gBACpC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAA;YACxC,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,OAAO,CAAC,EAAsC;QAC5C,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAA;IACpC,CAAC;CACF;AAED,MAAM,UAAU,mBAAmB,CAAC,EAClC,MAAM,GAGP;IACC,MAAM,kBAAkB,GAAG,IAAI,kBAAkB,EAAE,CAAA;IAEnD,MAAM,OAAO,GAAY;QACvB,KAAK,EAAE,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC;QAC1D,EAAE,EAAE,kBAAkB,CAAC,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC;QAClD,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC;QACtD,GAAG,EAAE,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC;QACpD,IAAI,EAAE,MAAM;KACb,CAAA;IAED,OAAO,OAAO,CAAA;AAChB,CAAC"}

package/dist/index.d.ts

@@ -1,5 +1,10 @@
-export { Remote, isRemoteAdaptorData } from './remote';
-export type { AdaptorPackageData, Adaptor } from './adaptor';
-export { RemoteError, RemoteNotFoundError, RemoteTimeoutError, response, } from './response';
-export { createIframeAdaptor } from './adaptors/iframe';
-export { createHttpAdaptor, remoteEventManager } from './adaptors/http';
+export * from './remote';
+export * from './adaptor';
+export * from './response';
+export * from './remoteValue/remoteValue';
+export * from './remoteValue/exposeToRemote';
+export type { ToFunc, RemoteCallData } from './remoteValue/type';
+export * from './adaptors/iframe';
+export * from './adaptors/http';
+export * from './adaptors/dao3/client';
+export * from './adaptors/dao3/server';

package/dist/index.js

@@ -1,5 +1,10 @@
-export { Remote, isRemoteAdaptorData } from './remote';
-export { RemoteError, RemoteNotFoundError, RemoteTimeoutError, response, } from './response';
-export { createIframeAdaptor } from './adaptors/iframe';
-export { createHttpAdaptor, remoteEventManager } from './adaptors/http';
+export * from './remote';
+export * from './adaptor';
+export * from './response';
+export * from './remoteValue/remoteValue';
+export * from './remoteValue/exposeToRemote';
+export * from './adaptors/iframe';
+export * from './adaptors/http';
+export * from './adaptors/dao3/client';
+export * from './adaptors/dao3/server';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAA;AAEtD,OAAO,EACL,WAAW,EACX,mBAAmB,EACnB,kBAAkB,EAClB,QAAQ,GACT,MAAM,YAAY,CAAA;AACnB,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,YAAY,CAAA;AAE1B,cAAc,2BAA2B,CAAA;AACzC,cAAc,8BAA8B,CAAA;AAG5C,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,wBAAwB,CAAA;AACtC,cAAc,wBAAwB,CAAA"}

package/dist/remoteValue/exposeToRemote.d.ts

@@ -0,0 +1,19 @@
+import { Adaptor, AdaptorPackageData } from '../adaptor';
+import { RemoteCallData } from './type';
+type AdaptorData = AdaptorPackageData<RemoteCallData>;
+interface ExposeProps {
+    globalName: string;
+    adaptor: Adaptor;
+    /**
+     * ['*'] or ['device_id_1', 'device_id_2']
+     */
+    exposeTo: string[];
+    /**
+     * 你可以在该回调中抛错，以阻止远程调用，
+     * 也可以修改传入的 data
+     */
+    onRequest?: (e: AdaptorData) => RemoteCallData | Promise<RemoteCallData>;
+}
+export declare function isRemoteValueEvent(eventName: string): boolean;
+export declare function exposeToRemote<T extends object>(obj: T, options: ExposeProps): () => void;
+export {};

package/dist/remoteValue/exposeToRemote.js

@@ -0,0 +1,49 @@
+import { RemoteError, response } from '../response';
+function defaultOnRequest(e) {
+    return e.data;
+}
+export function isRemoteValueEvent(eventName) {
+    return eventName.startsWith('__REMOTE_VALUE_REQ__');
+}
+export function exposeToRemote(obj, options) {
+    const { globalName, adaptor, exposeTo, onRequest = defaultOnRequest, } = options;
+    const callback = async (e) => {
+        var _a, _b;
+        try {
+            const { paths, args } = await onRequest(e);
+            if (!exposeTo.includes(e.deviceId) && !exposeTo.includes('*')) {
+                throw new RemoteError('permission denied');
+            }
+            let target = obj;
+            for (let i = 0; i < paths.length; i += 1) {
+                target = target[paths[i]];
+            }
+            let res;
+            if (target instanceof Function) {
+                res = await target(...args);
+            }
+            else {
+                res = target;
+            }
+            adaptor.emit({
+                name: (_a = e.callbackName) !== null && _a !== void 0 ? _a : 'IMPOSSIBLE_NO_CALLBACK_NAME',
+                deviceId: e.targetDeviceId,
+                targetDeviceId: e.deviceId,
+                data: response.success(res),
+            });
+        }
+        catch (error) {
+            adaptor.emit({
+                name: (_b = e.callbackName) !== null && _b !== void 0 ? _b : 'IMPOSSIBLE_NO_CALLBACK_NAME',
+                deviceId: e.targetDeviceId,
+                targetDeviceId: e.deviceId,
+                data: response.error(RemoteError.fromError(error)),
+            });
+        }
+    };
+    adaptor.on(`__REMOTE_VALUE_REQ__${globalName}`, callback);
+    return () => {
+        adaptor.off(`__REMOTE_VALUE_REQ__${globalName}`, callback);
+    };
+}
+//# sourceMappingURL=exposeToRemote.js.map

package/dist/remoteValue/exposeToRemote.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exposeToRemote.js","sourceRoot":"","sources":["../../src/remoteValue/exposeToRemote.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAmBnD,SAAS,gBAAgB,CAAC,CAAc;IACtC,OAAO,CAAC,CAAC,IAAI,CAAA;AACf,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,SAAiB;IAClD,OAAO,SAAS,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAA;AACrD,CAAC;AAED,MAAM,UAAU,cAAc,CAAmB,GAAM,EAAE,OAAoB;IAC3E,MAAM,EACJ,UAAU,EACV,OAAO,EACP,QAAQ,EACR,SAAS,GAAG,gBAAgB,GAC7B,GAAG,OAAO,CAAA;IACX,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAqB,EAAE,EAAE;;QAC/C,IAAI,CAAC;YACH,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,SAAS,CAAC,CAAgB,CAAC,CAAA;YACzD,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC9D,MAAM,IAAI,WAAW,CAAC,mBAAmB,CAAC,CAAA;YAC5C,CAAC;YACD,IAAI,MAAM,GAAG,GAAG,CAAA;YAChB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAwB,CAAkB,CAAA;YACnE,CAAC;YACD,IAAI,GAAY,CAAA;YAChB,IAAI,MAAM,YAAY,QAAQ,EAAE,CAAC;gBAC/B,GAAG,GAAG,MAAM,MAAM,CAAC,GAAG,IAAI,CAAC,CAAA;YAC7B,CAAC;iBAAM,CAAC;gBACN,GAAG,GAAG,MAAM,CAAA;YACd,CAAC;YACD,OAAO,CAAC,IAAI,CAAC;gBACX,IAAI,EAAE,MAAA,CAAC,CAAC,YAAY,mCAAI,6BAA6B;gBACrD,QAAQ,EAAE,CAAC,CAAC,cAAc;gBAC1B,cAAc,EAAE,CAAC,CAAC,QAAQ;gBAC1B,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC;aAC5B,CAAC,CAAA;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC;gBACX,IAAI,EAAE,MAAA,CAAC,CAAC,YAAY,mCAAI,6BAA6B;gBACrD,QAAQ,EAAE,CAAC,CAAC,cAAc;gBAC1B,cAAc,EAAE,CAAC,CAAC,QAAQ;gBAC1B,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;aACnD,CAAC,CAAA;QACJ,CAAC;IACH,CAAC,CAAA;IACD,OAAO,CAAC,EAAE,CAAC,uBAAuB,UAAU,EAAE,EAAE,QAAQ,CAAC,CAAA;IACzD,OAAO,GAAG,EAAE;QACV,OAAO,CAAC,GAAG,CAAC,uBAAuB,UAAU,EAAE,EAAE,QAAQ,CAAC,CAAA;IAC5D,CAAC,CAAA;AACH,CAAC"}

package/dist/remoteValue/remoteValue.d.ts

@@ -0,0 +1,27 @@
+import { Adaptor, AdaptorPackageData } from '../adaptor';
+import type { ToFunc } from './type';
+type RemoteValueProps = Pick<AdaptorPackageData, 'deviceId' | 'targetDeviceId'> & {
+    globalName: string;
+    adaptor: Adaptor;
+    timeoutMs?: number;
+    log?: boolean;
+};
+/**
+ * @example
+ * ```
+ * const obj = remoteValue<{
+ *   a: number;
+ *   b: {
+ *     c: string;
+ *   };
+ *   funcD: () => number
+ * }>()
+ *
+ * const val_1 = await obj.a()      // number
+ * const val_2 = await obj.b()      // { c: string }
+ * const val_3 = await obj.b.c()    // string
+ * const val_4 = await obj.funcD()  // number
+ * ```
+ */
+export declare function remoteValue<T extends object>(props: RemoteValueProps): ToFunc<T>;
+export {};

package/dist/remoteValue/remoteValue.js

@@ -0,0 +1,68 @@
+import { RemoteError, RemoteTimeoutError } from '../response';
+function noop() {
+    // pass
+}
+function geneProxy(paths, props) {
+    return new Proxy(noop, {
+        apply(target, thisArg, argArray) {
+            const { adaptor, globalName, timeoutMs = 30000, log = false, ...restProps } = props;
+            const randomStr = Math.random().toString(36).slice(2);
+            const name = `__REMOTE_VALUE_REQ__${globalName}`;
+            const responseName = `__REMOTE_VALUE_RES__${[globalName, ...paths].join('.')}-${randomStr}`;
+            if (log) {
+                console.log(`[remoteValue] [${restProps.deviceId}] 正在访问远端 [${restProps.targetDeviceId}] 的变量: "${[globalName, ...paths].join('.')}"`);
+            }
+            return new Promise((resolve, reject) => {
+                let timer;
+                const callback = (e) => {
+                    var _a;
+                    clearTimeout(timer);
+                    if (RemoteError.isRemoteError(e.data)) {
+                        reject(RemoteError.fromError(e.data));
+                    }
+                    else {
+                        resolve((_a = e.data) === null || _a === void 0 ? void 0 : _a.data);
+                    }
+                };
+                adaptor.once(responseName, callback);
+                timer = setTimeout(() => {
+                    adaptor.off(responseName, callback);
+                    reject(new RemoteTimeoutError(`timeout: ${[globalName, ...paths].join('.')}`));
+                }, timeoutMs);
+                adaptor.emit({
+                    name,
+                    callbackName: responseName,
+                    ...restProps,
+                    data: {
+                        paths,
+                        args: argArray,
+                    },
+                });
+            });
+        },
+        get(target, prop) {
+            return geneProxy([...paths, prop], props);
+        },
+    });
+}
+/**
+ * @example
+ * ```
+ * const obj = remoteValue<{
+ *   a: number;
+ *   b: {
+ *     c: string;
+ *   };
+ *   funcD: () => number
+ * }>()
+ *
+ * const val_1 = await obj.a()      // number
+ * const val_2 = await obj.b()      // { c: string }
+ * const val_3 = await obj.b.c()    // string
+ * const val_4 = await obj.funcD()  // number
+ * ```
+ */
+export function remoteValue(props) {
+    return geneProxy([], props);
+}
+//# sourceMappingURL=remoteValue.js.map

package/dist/remoteValue/remoteValue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remoteValue.js","sourceRoot":"","sources":["../../src/remoteValue/remoteValue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAY,MAAM,aAAa,CAAA;AAIvE,SAAS,IAAI;IACX,OAAO;AACT,CAAC;AAYD,SAAS,SAAS,CAAmB,KAAe,EAAE,KAAuB;IAC3E,OAAO,IAAI,KAAK,CAAY,IAA4B,EAAE;QACxD,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ;YAC7B,MAAM,EACJ,OAAO,EACP,UAAU,EACV,SAAS,GAAG,KAAK,EACjB,GAAG,GAAG,KAAK,EACX,GAAG,SAAS,EACb,GAAG,KAAK,CAAA;YACT,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YACrD,MAAM,IAAI,GAAG,uBAAuB,UAAU,EAAE,CAAA;YAChD,MAAM,YAAY,GAAG,uBAAuB,CAAC,UAAU,EAAE,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,SAAS,EAAE,CAAA;YAE3F,IAAI,GAAG,EAAE,CAAC;gBACR,OAAO,CAAC,GAAG,CACT,kBAAkB,SAAS,CAAC,QAAQ,aAAa,SAAS,CAAC,cAAc,WAAW,CAAC,UAAU,EAAE,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CACxH,CAAA;YACH,CAAC;YAED,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACrC,IAAI,KAAiC,CAAA;gBACrC,MAAM,QAAQ,GAAoB,CAAC,CAAC,EAAE,EAAE;;oBACtC,YAAY,CAAC,KAAK,CAAC,CAAA;oBACnB,IAAI,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;wBACtC,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;oBACvC,CAAC;yBAAM,CAAC;wBACN,OAAO,CAAC,MAAC,CAAC,CAAC,IAA4C,0CAAE,IAAI,CAAC,CAAA;oBAChE,CAAC;gBACH,CAAC,CAAA;gBACD,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAA;gBACpC,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;oBACtB,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAA;oBACnC,MAAM,CACJ,IAAI,kBAAkB,CACpB,YAAY,CAAC,UAAU,EAAE,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAC/C,CACF,CAAA;gBACH,CAAC,EAAE,SAAS,CAAC,CAAA;gBACb,OAAO,CAAC,IAAI,CAAC;oBACX,IAAI;oBACJ,YAAY,EAAE,YAAY;oBAC1B,GAAG,SAAS;oBACZ,IAAI,EAAE;wBACJ,KAAK;wBACL,IAAI,EAAE,QAAQ;qBACU;iBAC3B,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,CAAC;QACD,GAAG,CAAC,MAAM,EAAE,IAAI;YACd,OAAO,SAAS,CAAC,CAAC,GAAG,KAAK,EAAE,IAAc,CAAC,EAAE,KAAK,CAAC,CAAA;QACrD,CAAC;KACF,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,WAAW,CAAmB,KAAuB;IACnE,OAAO,SAAS,CAAI,EAAE,EAAE,KAAK,CAAC,CAAA;AAChC,CAAC"}

package/dist/remoteValue/type.d.ts

@@ -0,0 +1,66 @@
+type HasFunc<T> = T extends (...args: unknown[]) => unknown ? true : T extends unknown[] ? {
+    [K in keyof T]: HasFunc<T[K]>;
+}[number] extends false ? false : true : T extends object ? {
+    [K in keyof T]: HasFunc<T[K]>;
+}[keyof T] extends false ? false : true : false;
+export type ToFunc<T extends object> = {
+    [K in keyof T]: T[K] extends (...args: infer Args) => infer Ret ? (...args: Args) => Promise<Awaited<Ret>> : HasFunc<T[K]> extends false ? () => Promise<T[K]> : T[K] extends object ? ToFunc<T[K]> : never;
+};
+export interface RemoteCallData {
+    paths: string[];
+    args: unknown[];
+}
+type Assert<T extends true> = T;
+interface TestObj {
+    a1: number;
+    a2: number[];
+    a3: [number, string];
+    a4: {
+        b: number;
+        c: [string];
+    };
+    a5: () => Promise<number>;
+    a6: () => Promise<number[]>;
+    a7: () => Promise<[number, string]>;
+    b: {
+        b1: number;
+        b2: number[];
+        b3: [number, string];
+        b4: () => {
+            b: number;
+            c: [string];
+        };
+        b5: () => Promise<number>;
+        b6: () => Promise<number[]>;
+        b7: () => Promise<[number, string]>;
+    };
+    f: {
+        b: number;
+        c: {
+            d: () => number;
+        };
+    };
+}
+export type TestA1 = Assert<ToFunc<TestObj>['a1'] extends () => Promise<number> ? true : false>;
+export type TestA2 = Assert<ToFunc<TestObj>['a2'] extends () => Promise<number[]> ? true : false>;
+export type TestA3 = Assert<ToFunc<TestObj>['a3'] extends () => Promise<[number, string]> ? true : false>;
+export type TestA4 = Assert<ToFunc<TestObj>['a4'] extends () => Promise<{
+    b: number;
+    c: [string];
+}> ? true : false>;
+export type TestA5 = Assert<ToFunc<TestObj>['a5'] extends () => Promise<number> ? true : false>;
+export type TestA6 = Assert<ToFunc<TestObj>['a6'] extends () => Promise<number[]> ? true : false>;
+export type TestA7 = Assert<ToFunc<TestObj>['a7'] extends () => Promise<[number, string]> ? true : false>;
+export type TestB1 = Assert<ToFunc<TestObj>['b']['b1'] extends () => Promise<number> ? true : false>;
+export type TestB2 = Assert<ToFunc<TestObj>['b']['b2'] extends () => Promise<number[]> ? true : false>;
+export type TestB3 = Assert<ToFunc<TestObj>['b']['b3'] extends () => Promise<[number, string]> ? true : false>;
+export type TestB4 = Assert<ToFunc<TestObj>['b']['b4'] extends () => Promise<{
+    b: number;
+    c: [string];
+}> ? true : false>;
+export type TestB5 = Assert<ToFunc<TestObj>['b']['b5'] extends () => Promise<number> ? true : false>;
+export type TestB6 = Assert<ToFunc<TestObj>['b']['b6'] extends () => Promise<number[]> ? true : false>;
+export type TestB7 = Assert<ToFunc<TestObj>['b']['b7'] extends () => Promise<[number, string]> ? true : false>;
+export type TestF = Assert<ToFunc<TestObj>['f']['b'] extends () => Promise<number> ? true : false>;
+export type TestF2 = Assert<ToFunc<TestObj>['f']['c']['d'] extends () => Promise<number> ? true : false>;
+export {};

package/dist/remoteValue/type.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=type.js.map

package/dist/remoteValue/type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.js","sourceRoot":"","sources":["../../src/remoteValue/type.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zimi/remote",
   "license": "MIT",
-  "version": "0.2.0",
+  "version": "0.2.1-alpha.11",
   "author": "xiaomingTang",
   "description": "call remote functions as local",
   "private": false,

package/src/{adaptor.d.ts → adaptor.ts}

@@ -1,4 +1,4 @@
-export interface AdaptorPackageData {
+export interface AdaptorPackageData<D = unknown> {
   /**
    * 自身设备 id，应确保唯一性（对方能凭借该 deviceId 找到该设备）
    */
@@ -11,7 +11,7 @@ export interface AdaptorPackageData {
    * 远程调用的对方的方法名
    */
   name: string
-  data: unknown
+  data: D
   /**
    * 所需回调的方法名（如果需要回调的话）
    */
@@ -20,7 +20,7 @@ export interface AdaptorPackageData {
 
 type Func<D = unknown, R = unknown> = (data: D) => R
 
-type AdaptorCallback = Func<AdaptorPackageData, void>
+export type AdaptorCallback = Func<AdaptorPackageData, void>
 
 export interface Adaptor {
   every: (callback: AdaptorCallback) => void
@@ -28,6 +28,7 @@ export interface Adaptor {
    * off 用于移除 once 注册的事件，当事件超时后，需要主动 off
    */
   off: (name: string, callback: AdaptorCallback) => void
+  on: (name: string, callback: AdaptorCallback) => void
   once: (name: string, callback: AdaptorCallback) => void
   emit: (data: AdaptorPackageData) => void
 }

package/src/adaptors/dao3/client.ts

@@ -0,0 +1,53 @@
+import EventEmitter from 'eventemitter3'
+import { isRemoteAdaptorData } from '../../remote'
+import { type AdaptorPackageData } from '../../adaptor'
+
+interface RemoteChannel {
+  onClientEvent(fn: (e: unknown) => void): void
+}
+
+/**
+ * 这是 [dao3 游戏](https://dao3.fun/) 代码客户端适配器。
+ * ```ts
+ * const remoteManager = new ClientSideRemoteChannelEventManager(remoteChannel)
+ *
+ * export const remoteAdaptor = {
+ *   every: remoteManager.onEvery.bind(remoteManager),
+ *   off: remoteManager.off.bind(remoteManager),
+ *   on: remoteManager.on.bind(remoteManager),
+ *   once: remoteManager.once.bind(remoteManager),
+ *   emit: (e) => {
+ *     remoteChannel.sendServerEvent(e)
+ *   },
+ * } satisfies Adaptor
+ *
+ * export const remote = new Remote<RemoteFuncsFromClient, RemoteFuncsFromServer>(
+ *   remoteAdaptor,
+ *   {
+ *     deviceId: `client-${Math.random().toString(36).slice(2)}`,
+ *   }
+ * )
+ *
+ * void remote._.initConnection()
+ * ```
+ */
+export class ClientSideRemoteChannelEventManager extends EventEmitter<{
+  [key: string]: [AdaptorPackageData]
+}> {
+  constructor(remoteChannel: RemoteChannel) {
+    super()
+    remoteChannel.onClientEvent((e) => {
+      if (!isRemoteAdaptorData(e)) {
+        return
+      }
+      if (!e.name.startsWith('__REMOTE_VALUE_REQ__')) {
+        this.emit('__remote_every__', e)
+      }
+      this.emit(e.name, e)
+    })
+  }
+
+  onEvery(fn: (args: AdaptorPackageData) => void): void {
+    this.on('__remote_every__', fn)
+  }
+}

package/src/adaptors/dao3/server.ts

@@ -0,0 +1,136 @@
+import EventEmitter from 'eventemitter3'
+import { isRemoteAdaptorData } from '../../remote'
+import { isRemoteValueEvent } from '../../remoteValue/exposeToRemote'
+import { type AdaptorPackageData } from '../../adaptor'
+
+interface GamePlayerEntityLike {
+  player: {
+    userKey: string
+  }
+}
+
+interface RemoteChannel<T extends GamePlayerEntityLike> {
+  onServerEvent(fn: (e: { args: unknown; entity: T }) => void): void
+}
+
+/**
+ * 这是 [dao3 游戏](https://dao3.fun/) 代码服务端适配器。
+ * ```ts
+ * const remoteManager = new ServerSideRemoteChannelEventManager(remoteChannel)
+ *
+ * world.onPlayerLeave(
+ *   remoteManager.onPlayerLeave.bind(remoteManager)
+ * )
+ *
+ * export const remoteAdaptor = {
+ *   every: remoteManager.onEvery.bind(remoteManager),
+ *   off: remoteManager.off.bind(remoteManager),
+ *   on: remoteManager.on.bind(remoteManager),
+ *   once: remoteManager.once.bind(remoteManager),
+ *   emit: (e) => {
+ *     const entity = remoteManager.getEntity(e.targetDeviceId)
+ *     if (!entity) {
+ *       console.error('entity not found')
+ *       return
+ *     }
+ *     remoteChannel.sendClientEvent(entity, e as unknown as JSONValue)
+ *   },
+ * } satisfies Adaptor
+ *
+ * export const remote = new Remote<RemoteFuncsFromServer, RemoteFuncsFromClient>(
+ *   remoteAdaptor,
+ *   {
+ *     deviceId: 'server',
+ *   }
+ * )
+ *
+ * remote.register('initConnection', async () => {
+ *   // 什么也不干，单纯的让客户端在服务端“备案”
+ * })
+ *
+ * export const getEntity = remoteManager.getEntity.bind(remoteManager)
+ * export const getIdByEntity = remoteManager.getIdByEntity.bind(remoteManager)
+ * export const waitForRegister = remoteManager.waitForRegister.bind(remoteManager)
+ * export const remoteTo = remoteManager.remoteTo.bind(remoteManager)
+ * ```
+ */
+export class ServerSideRemoteChannelEventManager<
+  T extends GamePlayerEntityLike,
+> extends EventEmitter<{
+  [key: string]: [AdaptorPackageData]
+}> {
+  entityMap: [string, T][] = []
+
+  constructor(remoteChannel: RemoteChannel<T>) {
+    super()
+    remoteChannel.onServerEvent((e) => {
+      const { args } = e
+      if (!isRemoteAdaptorData(args)) {
+        return
+      }
+      const prevItem = this.entityMap.find(
+        (item) => item[1].player.userKey === e.entity.player.userKey
+      )
+      if (prevItem) {
+        prevItem[0] = args.deviceId
+        prevItem[1] = e.entity
+      } else {
+        this.entityMap.push([args.deviceId, e.entity])
+      }
+      if (!isRemoteValueEvent(args.name)) {
+        this.emit('__remote_every__', args)
+      }
+      this.emit(args.name, args)
+    })
+  }
+
+  onPlayerLeave(e: { entity: T }) {
+    this.entityMap = this.entityMap.filter(
+      (item) => item[1].player.userKey !== e.entity.player.userKey
+    )
+  }
+
+  onEvery(fn: (args: AdaptorPackageData) => void): void {
+    this.on('__remote_every__', fn)
+  }
+
+  waitForRegister(entity: T) {
+    return new Promise<void>((resolve) => {
+      if (
+        this.entityMap.some(
+          ([_, en]) => en.player.userKey === entity.player.userKey
+        )
+      ) {
+        resolve()
+        return
+      }
+      this.once('__remote_every__', () => {
+        resolve()
+      })
+    })
+  }
+
+  getEntity(deviceId: string): T | undefined {
+    return this.entityMap.find((item) => item[0] === deviceId)?.[1]
+  }
+
+  getIdByEntity(entity: T): string | undefined {
+    return this.entityMap.find(
+      (item) => item[1].player.userKey === entity.player.userKey
+    )?.[0]
+  }
+
+  remoteTo(config: { target: T }): {
+    targetDeviceId: string
+  }
+  remoteTo(config: { target: T; timeoutMs: number }): {
+    targetDeviceId: string
+    timeoutMs: number
+  }
+  remoteTo({ target, ...rest }: { target: T; timeoutMs?: number }) {
+    return {
+      targetDeviceId: this.getIdByEntity(target),
+      ...rest,
+    }
+  }
+}

package/src/adaptors/http.ts

@@ -21,6 +21,7 @@ export function createHttpAdaptor({
 }) {
   const adaptor: Adaptor = {
     every: remoteEventManager.onEvery.bind(remoteEventManager),
+    on: remoteEventManager.on.bind(remoteEventManager),
     once: remoteEventManager.once.bind(remoteEventManager),
     off: remoteEventManager.off.bind(remoteEventManager),
     emit: onEmit,

package/src/adaptors/iframe.ts

@@ -37,6 +37,7 @@ export function createIframeAdaptor({
 
   const adaptor: Adaptor = {
     every: remoteEventManager.onEvery.bind(remoteEventManager),
+    on: remoteEventManager.on.bind(remoteEventManager),
     once: remoteEventManager.once.bind(remoteEventManager),
     off: remoteEventManager.off.bind(remoteEventManager),
     emit: onEmit,

package/src/index.ts

@@ -1,10 +1,12 @@
-export { Remote, isRemoteAdaptorData } from './remote'
-export type { AdaptorPackageData, Adaptor } from './adaptor'
-export {
-  RemoteError,
-  RemoteNotFoundError,
-  RemoteTimeoutError,
-  response,
-} from './response'
-export { createIframeAdaptor } from './adaptors/iframe'
-export { createHttpAdaptor, remoteEventManager } from './adaptors/http'
+export * from './remote'
+export * from './adaptor'
+export * from './response'
+
+export * from './remoteValue/remoteValue'
+export * from './remoteValue/exposeToRemote'
+export type { ToFunc, RemoteCallData } from './remoteValue/type'
+
+export * from './adaptors/iframe'
+export * from './adaptors/http'
+export * from './adaptors/dao3/client'
+export * from './adaptors/dao3/server'

package/src/remoteValue/exposeToRemote.ts

@@ -0,0 +1,71 @@
+import { Adaptor, AdaptorPackageData } from '../adaptor'
+import { RemoteError, response } from '../response'
+import { RemoteCallData } from './type'
+
+type AdaptorData = AdaptorPackageData<RemoteCallData>
+
+interface ExposeProps {
+  globalName: string
+  adaptor: Adaptor
+  /**
+   * ['*'] or ['device_id_1', 'device_id_2']
+   */
+  exposeTo: string[]
+  /**
+   * 你可以在该回调中抛错，以阻止远程调用，
+   * 也可以修改传入的 data
+   */
+  onRequest?: (e: AdaptorData) => RemoteCallData | Promise<RemoteCallData>
+}
+
+function defaultOnRequest(e: AdaptorData) {
+  return e.data
+}
+
+export function isRemoteValueEvent(eventName: string) {
+  return eventName.startsWith('__REMOTE_VALUE_REQ__')
+}
+
+export function exposeToRemote<T extends object>(obj: T, options: ExposeProps) {
+  const {
+    globalName,
+    adaptor,
+    exposeTo,
+    onRequest = defaultOnRequest,
+  } = options
+  const callback = async (e: AdaptorPackageData) => {
+    try {
+      const { paths, args } = await onRequest(e as AdaptorData)
+      if (!exposeTo.includes(e.deviceId) && !exposeTo.includes('*')) {
+        throw new RemoteError('permission denied')
+      }
+      let target = obj
+      for (let i = 0; i < paths.length; i += 1) {
+        target = target[paths[i] as keyof typeof target] as typeof target
+      }
+      let res: unknown
+      if (target instanceof Function) {
+        res = await target(...args)
+      } else {
+        res = target
+      }
+      adaptor.emit({
+        name: e.callbackName ?? 'IMPOSSIBLE_NO_CALLBACK_NAME',
+        deviceId: e.targetDeviceId,
+        targetDeviceId: e.deviceId,
+        data: response.success(res),
+      })
+    } catch (error) {
+      adaptor.emit({
+        name: e.callbackName ?? 'IMPOSSIBLE_NO_CALLBACK_NAME',
+        deviceId: e.targetDeviceId,
+        targetDeviceId: e.deviceId,
+        data: response.error(RemoteError.fromError(error)),
+      })
+    }
+  }
+  adaptor.on(`__REMOTE_VALUE_REQ__${globalName}`, callback)
+  return () => {
+    adaptor.off(`__REMOTE_VALUE_REQ__${globalName}`, callback)
+  }
+}

package/src/remoteValue/remoteValue.ts

@@ -0,0 +1,94 @@
+import { RemoteError, RemoteTimeoutError, response } from '../response'
+import { Adaptor, AdaptorCallback, AdaptorPackageData } from '../adaptor'
+import type { RemoteCallData, ToFunc } from './type'
+
+function noop() {
+  // pass
+}
+
+type RemoteValueProps = Pick<
+  AdaptorPackageData,
+  'deviceId' | 'targetDeviceId'
+> & {
+  globalName: string
+  adaptor: Adaptor
+  timeoutMs?: number
+  log?: boolean
+}
+
+function geneProxy<T extends object>(paths: string[], props: RemoteValueProps) {
+  return new Proxy<ToFunc<T>>(noop as unknown as ToFunc<T>, {
+    apply(target, thisArg, argArray) {
+      const {
+        adaptor,
+        globalName,
+        timeoutMs = 30000,
+        log = false,
+        ...restProps
+      } = props
+      const randomStr = Math.random().toString(36).slice(2)
+      const name = `__REMOTE_VALUE_REQ__${globalName}`
+      const responseName = `__REMOTE_VALUE_RES__${[globalName, ...paths].join('.')}-${randomStr}`
+
+      if (log) {
+        console.log(
+          `[remoteValue] [${restProps.deviceId}] 正在访问远端 [${restProps.targetDeviceId}] 的变量: "${[globalName, ...paths].join('.')}"`
+        )
+      }
+
+      return new Promise((resolve, reject) => {
+        let timer: NodeJS.Timeout | undefined
+        const callback: AdaptorCallback = (e) => {
+          clearTimeout(timer)
+          if (RemoteError.isRemoteError(e.data)) {
+            reject(RemoteError.fromError(e.data))
+          } else {
+            resolve((e.data as ReturnType<typeof response.success>)?.data)
+          }
+        }
+        adaptor.once(responseName, callback)
+        timer = setTimeout(() => {
+          adaptor.off(responseName, callback)
+          reject(
+            new RemoteTimeoutError(
+              `timeout: ${[globalName, ...paths].join('.')}`
+            )
+          )
+        }, timeoutMs)
+        adaptor.emit({
+          name,
+          callbackName: responseName,
+          ...restProps,
+          data: {
+            paths,
+            args: argArray,
+          } satisfies RemoteCallData,
+        })
+      })
+    },
+    get(target, prop) {
+      return geneProxy([...paths, prop as string], props)
+    },
+  })
+}
+
+/**
+ * @example
+ * ```
+ * const obj = remoteValue<{
+ *   a: number;
+ *   b: {
+ *     c: string;
+ *   };
+ *   funcD: () => number
+ * }>()
+ *
+ * const val_1 = await obj.a()      // number
+ * const val_2 = await obj.b()      // { c: string }
+ * const val_3 = await obj.b.c()    // string
+ * const val_4 = await obj.funcD()  // number
+ * ```
+ */
+export function remoteValue<T extends object>(props: RemoteValueProps) {
+  return geneProxy<T>([], props)
+}

package/src/remoteValue/type.ts

@@ -0,0 +1,124 @@
+type HasFunc<T> = T extends (...args: unknown[]) => unknown
+  ? true
+  : T extends unknown[]
+    ? { [K in keyof T]: HasFunc<T[K]> }[number] extends false
+      ? false
+      : true
+    : T extends object
+      ? { [K in keyof T]: HasFunc<T[K]> }[keyof T] extends false
+        ? false
+        : true
+      : false
+
+export type ToFunc<T extends object> = {
+  [K in keyof T]: T[K] extends (...args: infer Args) => infer Ret
+    ? (...args: Args) => Promise<Awaited<Ret>>
+    : HasFunc<T[K]> extends false
+      ? () => Promise<T[K]>
+      : T[K] extends object
+        ? ToFunc<T[K]>
+        : never
+}
+
+export interface RemoteCallData {
+  paths: string[]
+  args: unknown[]
+}
+
+// 下面的都是测试代码，用于测试 ToFunc
+
+type Assert<T extends true> = T
+
+interface TestObj {
+  a1: number
+  a2: number[]
+  a3: [number, string]
+  a4: {
+    b: number
+    c: [string]
+  }
+  a5: () => Promise<number>
+  a6: () => Promise<number[]>
+  a7: () => Promise<[number, string]>
+  b: {
+    b1: number
+    b2: number[]
+    b3: [number, string]
+    b4: () => {
+      b: number
+      c: [string]
+    }
+    b5: () => Promise<number>
+    b6: () => Promise<number[]>
+    b7: () => Promise<[number, string]>
+  }
+  f: {
+    b: number
+    c: {
+      d: () => number
+    }
+  }
+}
+
+export type TestA1 = Assert<
+  ToFunc<TestObj>['a1'] extends () => Promise<number> ? true : false
+>
+export type TestA2 = Assert<
+  ToFunc<TestObj>['a2'] extends () => Promise<number[]> ? true : false
+>
+export type TestA3 = Assert<
+  ToFunc<TestObj>['a3'] extends () => Promise<[number, string]> ? true : false
+>
+export type TestA4 = Assert<
+  ToFunc<TestObj>['a4'] extends () => Promise<{
+    b: number
+    c: [string]
+  }>
+    ? true
+    : false
+>
+export type TestA5 = Assert<
+  ToFunc<TestObj>['a5'] extends () => Promise<number> ? true : false
+>
+export type TestA6 = Assert<
+  ToFunc<TestObj>['a6'] extends () => Promise<number[]> ? true : false
+>
+export type TestA7 = Assert<
+  ToFunc<TestObj>['a7'] extends () => Promise<[number, string]> ? true : false
+>
+export type TestB1 = Assert<
+  ToFunc<TestObj>['b']['b1'] extends () => Promise<number> ? true : false
+>
+export type TestB2 = Assert<
+  ToFunc<TestObj>['b']['b2'] extends () => Promise<number[]> ? true : false
+>
+export type TestB3 = Assert<
+  ToFunc<TestObj>['b']['b3'] extends () => Promise<[number, string]>
+    ? true
+    : false
+>
+export type TestB4 = Assert<
+  ToFunc<TestObj>['b']['b4'] extends () => Promise<{
+    b: number
+    c: [string]
+  }>
+    ? true
+    : false
+>
+export type TestB5 = Assert<
+  ToFunc<TestObj>['b']['b5'] extends () => Promise<number> ? true : false
+>
+export type TestB6 = Assert<
+  ToFunc<TestObj>['b']['b6'] extends () => Promise<number[]> ? true : false
+>
+export type TestB7 = Assert<
+  ToFunc<TestObj>['b']['b7'] extends () => Promise<[number, string]>
+    ? true
+    : false
+>
+export type TestF = Assert<
+  ToFunc<TestObj>['f']['b'] extends () => Promise<number> ? true : false
+>
+export type TestF2 = Assert<
+  ToFunc<TestObj>['f']['c']['d'] extends () => Promise<number> ? true : false
+>