@zimi/remote 0.2.0 → 0.2.1-alpha.3

package/README.md

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

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

@@ -3,3 +3,5 @@ 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 } from './remoteValue/remoteValue';
+export { exposeToRemote } from './remoteValue/exposeToRemote';

package/dist/index.js

@@ -2,4 +2,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 { remoteValue } from './remoteValue/remoteValue';
+export { exposeToRemote } from './remoteValue/exposeToRemote';
 //# 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,MAAM,2BAA2B,CAAA;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAA"}

package/dist/remoteValue/exposeToRemote.d.ts

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

package/dist/remoteValue/exposeToRemote.js

@@ -0,0 +1,47 @@
+import { RemoteError, response } from '../response';
+function defaultOnRequest(e) {
+    return e;
+}
+export function exposeToRemote(obj, options) {
+    const { globalName, adaptor, exposeTo, onRequest = defaultOnRequest, } = options;
+    const callback = async (e) => {
+        var _a, _b;
+        try {
+            await onRequest(e);
+            if (!exposeTo.includes(e.deviceId) && !exposeTo.includes('*')) {
+                throw new RemoteError('permission denied');
+            }
+            const { paths, args } = e.data;
+            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;AAenD,SAAS,gBAAgB,CAAC,CAAqB;IAC7C,OAAO,CAAC,CAAA;AACV,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,SAAS,CAAC,CAAC,CAAC,CAAA;YAClB,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,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,IAA4C,CAAA;YACtE,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,26 @@
+import { Adaptor, AdaptorPackageData } from '../adaptor';
+import type { ToFunc } from './type';
+type RemoteValueProps = Pick<AdaptorPackageData, 'deviceId' | 'targetDeviceId'> & {
+    globalName: string;
+    adaptor: Adaptor;
+    timeoutMs?: number;
+};
+/**
+ * @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,65 @@
+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, ...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}`;
+            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;AAWD,SAAS,SAAS,CAAmB,KAAe,EAAE,KAAuB;IAC3E,OAAO,IAAI,KAAK,CAAY,IAA4B,EAAE;QACxD,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ;YAC7B,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,GAAG,KAAK,EAAE,GAAG,SAAS,EAAE,GAAG,KAAK,CAAA;YACtE,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,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;qBACf;iBACF,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/package.json

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

package/src/adaptor.d.ts

@@ -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/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

@@ -8,3 +8,5 @@ export {
 } from './response'
 export { createIframeAdaptor } from './adaptors/iframe'
 export { createHttpAdaptor, remoteEventManager } from './adaptors/http'
+export { remoteValue } from './remoteValue/remoteValue'
+export { exposeToRemote } from './remoteValue/exposeToRemote'

package/src/remoteValue/exposeToRemote.ts

@@ -0,0 +1,64 @@
+import { Adaptor, AdaptorPackageData } from '../adaptor'
+import { RemoteError, response } from '../response'
+
+interface ExposeProps {
+  globalName: string
+  adaptor: Adaptor
+  /**
+   * ['*'] or ['device_id_1', 'device_id_2']
+   */
+  exposeTo: string[]
+  /**
+   * 你可以在该回调中抛错，以阻止远程调用
+   */
+  onRequest?: (e: AdaptorPackageData) => void | Promise<void>
+}
+
+function defaultOnRequest(e: AdaptorPackageData) {
+  return e
+}
+
+export function exposeToRemote<T extends object>(obj: T, options: ExposeProps) {
+  const {
+    globalName,
+    adaptor,
+    exposeTo,
+    onRequest = defaultOnRequest,
+  } = options
+  const callback = async (e: AdaptorPackageData) => {
+    try {
+      await onRequest(e)
+      if (!exposeTo.includes(e.deviceId) && !exposeTo.includes('*')) {
+        throw new RemoteError('permission denied')
+      }
+      const { paths, args } = e.data as { paths: string[]; args: unknown[] }
+      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,81 @@
+import { RemoteError, RemoteTimeoutError, response } from '../response'
+import { Adaptor, AdaptorCallback, AdaptorPackageData } from '../adaptor'
+import type { ToFunc } from './type'
+
+function noop() {
+  // pass
+}
+
+type RemoteValueProps = Pick<
+  AdaptorPackageData,
+  'deviceId' | 'targetDeviceId'
+> & {
+  globalName: string
+  adaptor: Adaptor
+  timeoutMs?: number
+}
+
+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, ...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}`
+
+      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,
+          },
+        })
+      })
+    },
+    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.d.ts

@@ -0,0 +1,115 @@
+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
+}
+
+// 下面的都是测试代码，用于测试 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
+>