@zimi/remote 0.1.0 → 0.1.1-alpha.1

package/README.md

@@ -1,10 +1,8 @@
-# @zimi/remote
-
-像调用本地函数一样调用远端的函数
+> 代码见 [@zimi/remote](https://github.com/xiaomingTang/xiaoming/tree/master/%40zimi/remote)
 
 - 本地可以是浏览器、服务器，甚至一些受限的 `js` 子集
-- 远端可以是任何语言，如 `Java`
-- 对远端响应的数据格式也不严格限制
+- 远端可以是任何终端，如 `iframe` / `Java` 服务器 等
+- 对远端响应的数据格式也不严格限制（可以集中解析）
 
 ## install
 ```
@@ -13,7 +11,22 @@ pnpm i @zimi/remote
 
 ## examples
 
-### iframe 与父级通信
+### 使用示例
+
+```ts
+
+// 远端
+remote.register('something', async (params: Whatever) => {
+  return WhatYouWant
+})
+
+// 本地
+// res === WhatYouWant
+const res = await remote._.something(xxx)
+
+```
+
+### iframe 与父级相互调用
 
 ```ts
 // 1. 声明各自能提供的函数类型
@@ -37,13 +50,14 @@ export type FuncsFromChild = {
 import { Remote, createIframeAdaptor } from '@zimi/remote'
 
 function getOpWindow() {
-  return (document.getElementById('child-iframe') as HTMLIFrameElement | null)?.contentWindow
+  return document.querySelector<HTMLIFrameElement>('#child-iframe')?.contentWindow
 }
 
 // 我们提供了生成 iframe adaptor 的工具函数
 // 你也可以参考实现自己的 adaptor, 没多少代码
 const adaptor = createIframeAdaptor({
   onEmit: (data) => {
+    // 此处仅为示意，业务场景下应当限制对方的域名
     getOpWindow()?.postMessage(data, '*')
   },
 })
@@ -70,6 +84,7 @@ function getOpWindow() {
 // 你也可以参考实现自己的 adaptor, 没多少代码
 const adaptor = createIframeAdaptor({
   onEmit: (data) => {
+    // 此处仅为示意，业务场景下应当限制对方的域名
     getOpWindow()?.postMessage(data, '*')
   },
 })
@@ -182,3 +197,16 @@ await remote._.xxx(anyData)
 ### 与其他端通信（如 websocket）略
 
 你可以看看 `iframe adaptor` / `http adaptor` 源码，包含空行也就 30 行，依葫芦画瓢很轻易就能写一个。
+
+## 与 rpc 相比的优势
+
+- 不局限于与服务端的通信，无论对方是任何端，只要能与 js 通信，就能使用该包；
+- 相互通信，不存在“主从”的概念，通信双方是平等的；
+- 类型严格；
+- 包较底层，对项目整体的侵入较小，几乎不限制对方的响应的数据格式（因为可以自由解析对方的响应，即自由 emit）；
+
+## 协议
+
+> 由于通信双方是平等的，所以 B 调用 A 的流程也是一样的
+
+![protocol.png](https://cdn.16px.cc/public/2024-12-08/fm5up4GM9UCz.png?r=1682x836)

package/dist/adaptors/http.d.ts

@@ -1,13 +1,13 @@
-import EventEmitter from 'eventemitter3';
-import type { Adaptor, AdaptorPackageData } from '../adaptor';
-declare class RemoteEventManager extends EventEmitter<{
-    [key: string]: [AdaptorPackageData];
-}> {
-    EVERY_EVENT_NAME: string;
-    onEvery(fn: (data: AdaptorPackageData) => void): void;
-}
-export declare const remoteEventManager: RemoteEventManager;
-export declare function createHttpAdaptor({ onEmit, }: {
-    onEmit: (data: AdaptorPackageData) => void;
-}): Adaptor;
-export {};
+import EventEmitter from 'eventemitter3';
+import type { Adaptor, AdaptorPackageData } from '../adaptor';
+declare class RemoteEventManager extends EventEmitter<{
+    [key: string]: [AdaptorPackageData];
+}> {
+    EVERY_EVENT_NAME: string;
+    onEvery(fn: (data: AdaptorPackageData) => void): void;
+}
+export declare const remoteEventManager: RemoteEventManager;
+export declare function createHttpAdaptor({ onEmit, }: {
+    onEmit: (data: AdaptorPackageData) => void;
+}): Adaptor;
+export {};

package/dist/adaptors/http.js

@@ -1,26 +1,27 @@
-import EventEmitter from 'eventemitter3';
-class RemoteEventManager extends EventEmitter {
-    constructor() {
-        super(...arguments);
-        Object.defineProperty(this, "EVERY_EVENT_NAME", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: '__remote_every__'
-        });
-    }
-    onEvery(fn) {
-        this.on(this.EVERY_EVENT_NAME, fn);
-    }
-}
-export const remoteEventManager = new RemoteEventManager();
-export function createHttpAdaptor({ onEmit, }) {
-    const adaptor = {
-        every: remoteEventManager.onEvery.bind(remoteEventManager),
-        once: remoteEventManager.once.bind(remoteEventManager),
-        off: remoteEventManager.off.bind(remoteEventManager),
-        emit: onEmit,
-    };
-    return adaptor;
-}
+import EventEmitter from 'eventemitter3';
+class RemoteEventManager extends EventEmitter {
+    constructor() {
+        super(...arguments);
+        Object.defineProperty(this, "EVERY_EVENT_NAME", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: '__remote_every__'
+        });
+    }
+    onEvery(fn) {
+        this.on(this.EVERY_EVENT_NAME, fn);
+    }
+}
+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,
+    };
+    return adaptor;
+}
 //# sourceMappingURL=http.js.map

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.d.ts

@@ -1,4 +1,4 @@
-import type { Adaptor, AdaptorPackageData } from '../adaptor';
-export declare function createIframeAdaptor({ onEmit, }: {
-    onEmit: (data: AdaptorPackageData) => void;
-}): Adaptor;
+import type { Adaptor, AdaptorPackageData } from '../adaptor';
+export declare function createIframeAdaptor({ onEmit, }: {
+    onEmit: (data: AdaptorPackageData) => void;
+}): Adaptor;

package/dist/adaptors/iframe.js

@@ -1,38 +1,39 @@
-import EventEmitter from 'eventemitter3';
-import { isRemoteAdaptorData } from '../remote';
-class RemoteEventManager extends EventEmitter {
-    constructor() {
-        super();
-        Object.defineProperty(this, "EVERY_EVENT_NAME", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: '__remote_every__'
-        });
-        if (typeof window === 'undefined') {
-            return;
-        }
-        window.addEventListener('message', (event) => {
-            const { data } = event;
-            if (isRemoteAdaptorData(data)) {
-                this.emit(data.name, data);
-                // 一定要抛出 every 事件，remote 包基于此处理远端的响应
-                this.emit(this.EVERY_EVENT_NAME, data);
-            }
-        });
-    }
-    onEvery(fn) {
-        this.on(this.EVERY_EVENT_NAME, fn);
-    }
-}
-export function createIframeAdaptor({ onEmit, }) {
-    const remoteEventManager = new RemoteEventManager();
-    const adaptor = {
-        every: remoteEventManager.onEvery.bind(remoteEventManager),
-        once: remoteEventManager.once.bind(remoteEventManager),
-        off: remoteEventManager.off.bind(remoteEventManager),
-        emit: onEmit,
-    };
-    return adaptor;
-}
+import EventEmitter from 'eventemitter3';
+import { isRemoteAdaptorData } from '../remote';
+class RemoteEventManager extends EventEmitter {
+    constructor() {
+        super();
+        Object.defineProperty(this, "EVERY_EVENT_NAME", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: '__remote_every__'
+        });
+        if (typeof window === 'undefined') {
+            return;
+        }
+        window.addEventListener('message', (event) => {
+            const { data } = event;
+            if (isRemoteAdaptorData(data)) {
+                this.emit(data.name, data);
+                // 一定要抛出 every 事件，remote 包基于此处理远端的响应
+                this.emit(this.EVERY_EVENT_NAME, data);
+            }
+        });
+    }
+    onEvery(fn) {
+        this.on(this.EVERY_EVENT_NAME, fn);
+    }
+}
+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,
+    };
+    return adaptor;
+}
 //# sourceMappingURL=iframe.js.map

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;YACjC,OAAM;SACP;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;gBAC7B,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;aACvC;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,6 @@
-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 { 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 { remoteValue, exposeToRemote } from './remoteValue';

package/dist/index.js

@@ -1,5 +1,6 @@
-export { Remote, isRemoteAdaptorData } from './remote';
-export { RemoteError, RemoteNotFoundError, RemoteTimeoutError, response, } from './response';
-export { createIframeAdaptor } from './adaptors/iframe';
-export { createHttpAdaptor, remoteEventManager } from './adaptors/http';
+export { Remote, isRemoteAdaptorData } from './remote';
+export { RemoteError, RemoteNotFoundError, RemoteTimeoutError, response, } from './response';
+export { createIframeAdaptor } from './adaptors/iframe';
+export { createHttpAdaptor, remoteEventManager } from './adaptors/http';
+export { remoteValue, exposeToRemote } from './remoteValue';
 //# 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,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;AACvE,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA"}

package/dist/remote.d.ts

@@ -1,79 +1,79 @@
-import type { Adaptor, AdaptorPackageData } from './adaptor';
-type LogFunc = (...data: unknown[]) => void;
-type RemoteCallableFunc = (data: any) => Promise<any>;
-interface RemoteFuncRecords {
-    [key: string]: RemoteCallableFunc;
-}
-type FuncMapWithConfig<T extends RemoteFuncRecords> = {
-    [K in keyof T]: T[K] extends (data: infer Arg) => Promise<infer Ret> ? (data: Arg, config?: {
-        timeoutMs?: number;
-        targetDeviceId?: string;
-    }) => Promise<Ret> : never;
-};
-type RegisteredFunc<T extends RemoteCallableFunc> = T extends (data: infer Arg) => infer Ret ? (data: Arg, ctx: {
-    /**
-     * 对方的设备 id
-     */
-    deviceId: string;
-}) => Ret : never;
-export declare class Remote<
-/**
- * MF means my functions
- */
-MF extends RemoteFuncRecords, 
-/**
- * OF means others functions
- */
-OF extends RemoteFuncRecords> {
-    private adaptor;
-    debug: boolean;
-    private log;
-    /**
-     * （调用对方函数时的）默认超时时间，单位 ms
-     * @default 30000
-     */
-    private defaultTimeoutMs;
-    private map;
-    private deviceIdValue;
-    /**
-     * 设备 id 应该唯一，用于区分不同设备。
-     * 你可以在任何时候修改（更新）它。
-     * @default ''
-     */
-    get deviceId(): string;
-    set deviceId(deviceId: string);
-    constructor(adaptor: Adaptor, config?: {
-        /**
-         * 设备 id 应该唯一，用于区分不同设备。
-         * 你可以在任何时候修改（更新）它。
-         * @default ''
-         */
-        deviceId?: string;
-        /**
-         * （调用对方函数时的）默认超时时间，单位 ms
-         * @default 30000
-         */
-        defaultTimeoutMs?: number;
-        debug?: boolean;
-        /**
-         * 格式化 AdaptorPackageData 的函数，
-         * 用于调试时输出日志。
-         * @default JSON.stringify
-         */
-        log?: LogFunc;
-    });
-    /**
-     * 调用其他端的方法；会等待对方响应。
-     * 不能直接使用该方法，应该使用 proxy。
-     * @WARNING 不能用于响应其他端。
-     */
-    private callAsync;
-    /**
-     * 注册方法，供对方调用；
-     */
-    register<K extends keyof MF>(name: K, callback: RegisteredFunc<MF[K]>): void;
-    _: FuncMapWithConfig<OF>;
-    self: MF;
-}
-export declare function isRemoteAdaptorData(data: unknown): data is AdaptorPackageData;
-export {};
+import type { Adaptor, AdaptorPackageData } from './adaptor';
+type LogFunc = (...data: unknown[]) => void;
+type RemoteCallableFunc = (data: any) => Promise<any>;
+interface RemoteFuncRecords {
+    [key: string]: RemoteCallableFunc;
+}
+type FuncMapWithConfig<T extends RemoteFuncRecords> = {
+    [K in keyof T]: T[K] extends (data: infer Arg) => Promise<infer Ret> ? (data: Arg, config?: {
+        timeoutMs?: number;
+        targetDeviceId?: string;
+    }) => Promise<Ret> : never;
+};
+type RegisteredFunc<T extends RemoteCallableFunc> = T extends (data: infer Arg) => infer Ret ? (data: Arg, ctx: {
+    /**
+     * 对方的设备 id
+     */
+    deviceId: string;
+}) => Ret : never;
+export declare class Remote<
+/**
+ * MF means my functions
+ */
+MF extends RemoteFuncRecords, 
+/**
+ * OF means others functions
+ */
+OF extends RemoteFuncRecords> {
+    private adaptor;
+    debug: boolean;
+    private log;
+    /**
+     * （调用对方函数时的）默认超时时间，单位 ms
+     * @default 30000
+     */
+    private defaultTimeoutMs;
+    private map;
+    private deviceIdValue;
+    /**
+     * 设备 id 应该唯一，用于区分不同设备。
+     * 你可以在任何时候修改（更新）它。
+     * @default ''
+     */
+    get deviceId(): string;
+    set deviceId(deviceId: string);
+    constructor(adaptor: Adaptor, config?: {
+        /**
+         * 设备 id 应该唯一，用于区分不同设备。
+         * 你可以在任何时候修改（更新）它。
+         * @default ''
+         */
+        deviceId?: string;
+        /**
+         * （调用对方函数时的）默认超时时间，单位 ms
+         * @default 30000
+         */
+        defaultTimeoutMs?: number;
+        debug?: boolean;
+        /**
+         * 格式化 AdaptorPackageData 的函数，
+         * 用于调试时输出日志。
+         * @default JSON.stringify
+         */
+        log?: LogFunc;
+    });
+    /**
+     * 调用其他端的方法；会等待对方响应。
+     * 不能直接使用该方法，应该使用 proxy。
+     * @WARNING 不能用于响应其他端。
+     */
+    private callAsync;
+    /**
+     * 注册方法，供对方调用；
+     */
+    register<K extends keyof MF>(name: K, callback: RegisteredFunc<MF[K]>): void;
+    _: FuncMapWithConfig<OF>;
+    self: MF;
+}
+export declare function isRemoteAdaptorData(data: unknown): data is AdaptorPackageData;
+export {};