@zimi/remote 0.2.1-alpha.10 → 0.2.1-alpha.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. package/dist/adaptor.d.ts +2 -2
  2. package/dist/index.d.ts +1 -1
  3. package/dist/remoteValue/exposeToRemote.d.ts +27 -2
  4. package/dist/remoteValue/exposeToRemote.js +15 -15
  5. package/dist/remoteValue/exposeToRemote.js.map +1 -1
  6. package/dist/remoteValue/remoteValue.js.map +1 -1
  7. package/dist/remoteValue/type.d.ts +4 -0
  8. package/package.json +1 -1
  9. package/src/adaptor.ts +2 -2
  10. package/src/index.ts +1 -1
  11. package/src/remoteValue/exposeToRemote.ts +46 -16
  12. package/src/remoteValue/remoteValue.ts +2 -2
  13. package/src/remoteValue/type.ts +5 -0
package/dist/adaptor.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- export interface AdaptorPackageData {
1
+ export interface AdaptorPackageData<D = unknown> {
2
2
  /**
3
3
  * 自身设备 id，应确保唯一性（对方能凭借该 deviceId 找到该设备）
4
4
  */
@@ -11,7 +11,7 @@ export interface AdaptorPackageData {
11
11
  * 远程调用的对方的方法名
12
12
  */
13
13
  name: string;
14
- data: unknown;
14
+ data: D;
15
15
  /**
16
16
  * 所需回调的方法名（如果需要回调的话）
17
17
  */
package/dist/index.d.ts CHANGED
@@ -3,7 +3,7 @@ export * from './adaptor';
3
3
  export * from './response';
4
4
  export * from './remoteValue/remoteValue';
5
5
  export * from './remoteValue/exposeToRemote';
6
- export type { ToFunc } from './remoteValue/type';
6
+ export type { ToFunc, RemoteCallData } from './remoteValue/type';
7
7
  export * from './adaptors/iframe';
8
8
  export * from './adaptors/http';
9
9
  export * from './adaptors/dao3/client';
package/dist/remoteValue/exposeToRemote.d.ts CHANGED
@@ -1,4 +1,6 @@
1
1
  import { Adaptor, AdaptorPackageData } from '../adaptor';
2
+ import { RemoteCallData } from './type';
3
+ type AdaptorData = AdaptorPackageData<RemoteCallData>;
2
4
  interface ExposeProps {
3
5
  globalName: string;
4
6
  adaptor: Adaptor;
@@ -7,9 +9,32 @@ interface ExposeProps {
7
9
  */
8
10
  exposeTo: string[];
9
11
  /**
10
- * 你可以在该回调中抛错，以阻止远程调用
12
+ * 你可以在该回调中抛错，以阻止远程调用，
13
+ * 也可以修改传入的 data
11
14
  */
12
- onRequest?: (e: AdaptorPackageData) => void | Promise<void>;
15
+ onRequest?: (e: AdaptorData) => RemoteCallData | Promise<RemoteCallData>;
16
+ /**
17
+ * 如果你想要自定义处理函数,
18
+ * 需要谨慎且完善地处理各种 paths, args,
19
+ * 以避免远程调用时出现未预期的错误。
20
+ *
21
+ * ---
22
+ *
23
+ * 我的默认处理程序谨供参考:
24
+ * ``` ts
25
+ * let target = obj
26
+ * for (let i = 0; i < data.paths.length; i += 1) {
27
+ * target = target[data.paths[i] as keyof typeof target] as typeof target
28
+ * }
29
+ * if (target instanceof Function) {
30
+ * return target(...data.args)
31
+ * }
32
+ * return target
33
+ * ```
34
+ *
35
+ * @returns 返回值将会被发送给远程调用方，可以是立即数，也可以是 Promise（Promise 会 await 后再返回）
36
+ */
37
+ handler?: (data: RemoteCallData) => unknown;
13
38
  }
14
39
  export declare function isRemoteValueEvent(eventName: string): boolean;
15
40
  export declare function exposeToRemote<T extends object>(obj: T, options: ExposeProps): () => void;
package/dist/remoteValue/exposeToRemote.js CHANGED
@@ -1,31 +1,31 @@
1
1
  import { RemoteError, response } from '../response';
2
2
  function defaultOnRequest(e) {
3
- return e;
3
+ return e.data;
4
4
  }
5
+ const geneDefaultHandler = (obj) => (data) => {
6
+ let target = obj;
7
+ for (let i = 0; i < data.paths.length; i += 1) {
8
+ target = target[data.paths[i]];
9
+ }
10
+ if (target instanceof Function) {
11
+ return target(...data.args);
12
+ }
13
+ return target;
14
+ };
5
15
  export function isRemoteValueEvent(eventName) {
6
16
  return eventName.startsWith('__REMOTE_VALUE_REQ__');
7
17
  }
8
18
  export function exposeToRemote(obj, options) {
9
- const { globalName, adaptor, exposeTo, onRequest = defaultOnRequest, } = options;
19
+ const { globalName, adaptor, exposeTo, handler: inputHandler, onRequest = defaultOnRequest, } = options;
10
20
  const callback = async (e) => {
11
21
  var _a, _b;
12
22
  try {
13
- await onRequest(e);
23
+ const data = await onRequest(e);
14
24
  if (!exposeTo.includes(e.deviceId) && !exposeTo.includes('*')) {
15
25
  throw new RemoteError('permission denied');
16
26
  }
17
- const { paths, args } = e.data;
18
- let target = obj;
19
- for (let i = 0; i < paths.length; i += 1) {
20
- target = target[paths[i]];
21
- }
22
- let res;
23
- if (target instanceof Function) {
24
- res = await target(...args);
25
- }
26
- else {
27
- res = target;
28
- }
27
+ const handler = inputHandler !== null && inputHandler !== void 0 ? inputHandler : geneDefaultHandler(obj);
28
+ const res = await handler(data);
29
29
  adaptor.emit({
30
30
  name: (_a = e.callbackName) !== null && _a !== void 0 ? _a : 'IMPOSSIBLE_NO_CALLBACK_NAME',
31
31
  deviceId: e.targetDeviceId,
package/dist/remoteValue/exposeToRemote.js.map CHANGED
@@ -1 +1 @@
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,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,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"}
1
+ {"version":3,"file":"exposeToRemote.js","sourceRoot":"","sources":["../../src/remoteValue/exposeToRemote.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAyCnD,SAAS,gBAAgB,CAAC,CAAc;IACtC,OAAO,CAAC,CAAC,IAAI,CAAA;AACf,CAAC;AAED,MAAM,kBAAkB,GACtB,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE;IAChB,IAAI,MAAM,GAAG,GAAG,CAAA;IAChB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9C,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAwB,CAAkB,CAAA;IACxE,CAAC;IACD,IAAI,MAAM,YAAY,QAAQ,EAAE,CAAC;QAC/B,OAAO,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAA;IAC7B,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAEH,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,OAAO,EAAE,YAAY,EACrB,SAAS,GAAG,gBAAgB,GAC7B,GAAG,OAAO,CAAA;IACX,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAqB,EAAE,EAAE;;QAC/C,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,CAAgB,CAAC,CAAA;YAC9C,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,OAAO,GAAG,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,kBAAkB,CAAC,GAAG,CAAC,CAAA;YACvD,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;YAC/B,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.js.map CHANGED
@@ -1 +1 @@
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;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"}
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 CHANGED
@@ -6,6 +6,10 @@ type HasFunc<T> = T extends (...args: unknown[]) => unknown ? true : T extends u
6
6
  export type ToFunc<T extends object> = {
7
7
  [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;
8
8
  };
9
+ export interface RemoteCallData {
10
+ paths: string[];
11
+ args: unknown[];
12
+ }
9
13
  type Assert<T extends true> = T;
10
14
  interface TestObj {
11
15
  a1: number;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@zimi/remote",
3
3
  "license": "MIT",
4
- "version": "0.2.1-alpha.10",
4
+ "version": "0.2.1-alpha.12",
5
5
  "author": "xiaomingTang",
6
6
  "description": "call remote functions as local",
7
7
  "private": false,
package/src/adaptor.ts CHANGED
@@ -1,4 +1,4 @@
1
- export interface AdaptorPackageData {
1
+ export interface AdaptorPackageData<D = unknown> {
2
2
  /**
3
3
  * 自身设备 id，应确保唯一性（对方能凭借该 deviceId 找到该设备）
4
4
  */
@@ -11,7 +11,7 @@ export interface AdaptorPackageData {
11
11
  * 远程调用的对方的方法名
12
12
  */
13
13
  name: string
14
- data: unknown
14
+ data: D
15
15
  /**
16
16
  * 所需回调的方法名（如果需要回调的话）
17
17
  */
package/src/index.ts CHANGED
@@ -4,7 +4,7 @@ export * from './response'
4
4
 
5
5
  export * from './remoteValue/remoteValue'
6
6
  export * from './remoteValue/exposeToRemote'
7
- export type { ToFunc } from './remoteValue/type'
7
+ export type { ToFunc, RemoteCallData } from './remoteValue/type'
8
8
 
9
9
  export * from './adaptors/iframe'
10
10
  export * from './adaptors/http'
package/src/remoteValue/exposeToRemote.ts CHANGED
@@ -1,5 +1,8 @@
1
1
  import { Adaptor, AdaptorPackageData } from '../adaptor'
2
2
  import { RemoteError, response } from '../response'
3
+ import { RemoteCallData } from './type'
4
+
5
+ type AdaptorData = AdaptorPackageData<RemoteCallData>
3
6
 
4
7
  interface ExposeProps {
5
8
  globalName: string
@@ -9,15 +12,50 @@ interface ExposeProps {
9
12
  */
10
13
  exposeTo: string[]
11
14
  /**
12
- * 你可以在该回调中抛错，以阻止远程调用
15
+ * 你可以在该回调中抛错，以阻止远程调用，
16
+ * 也可以修改传入的 data
17
+ */
18
+ onRequest?: (e: AdaptorData) => RemoteCallData | Promise<RemoteCallData>
19
+ /**
20
+ * 如果你想要自定义处理函数,
21
+ * 需要谨慎且完善地处理各种 paths, args,
22
+ * 以避免远程调用时出现未预期的错误。
23
+ *
24
+ * ---
25
+ *
26
+ * 我的默认处理程序谨供参考:
27
+ * ``` ts
28
+ * let target = obj
29
+ * for (let i = 0; i < data.paths.length; i += 1) {
30
+ * target = target[data.paths[i] as keyof typeof target] as typeof target
31
+ * }
32
+ * if (target instanceof Function) {
33
+ * return target(...data.args)
34
+ * }
35
+ * return target
36
+ * ```
37
+ *
38
+ * @returns 返回值将会被发送给远程调用方，可以是立即数，也可以是 Promise（Promise 会 await 后再返回）
13
39
  */
14
- onRequest?: (e: AdaptorPackageData) => void | Promise<void>
40
+ handler?: (data: RemoteCallData) => unknown
15
41
  }
16
42
 
17
- function defaultOnRequest(e: AdaptorPackageData) {
18
- return e
43
+ function defaultOnRequest(e: AdaptorData) {
44
+ return e.data
19
45
  }
20
46
 
47
+ const geneDefaultHandler: <T>(obj: T) => (data: RemoteCallData) => unknown =
48
+ (obj) => (data) => {
49
+ let target = obj
50
+ for (let i = 0; i < data.paths.length; i += 1) {
51
+ target = target[data.paths[i] as keyof typeof target] as typeof target
52
+ }
53
+ if (target instanceof Function) {
54
+ return target(...data.args)
55
+ }
56
+ return target
57
+ }
58
+
21
59
  export function isRemoteValueEvent(eventName: string) {
22
60
  return eventName.startsWith('__REMOTE_VALUE_REQ__')
23
61
  }
@@ -27,25 +65,17 @@ export function exposeToRemote<T extends object>(obj: T, options: ExposeProps) {
27
65
  globalName,
28
66
  adaptor,
29
67
  exposeTo,
68
+ handler: inputHandler,
30
69
  onRequest = defaultOnRequest,
31
70
  } = options
32
71
  const callback = async (e: AdaptorPackageData) => {
33
72
  try {
34
- await onRequest(e)
73
+ const data = await onRequest(e as AdaptorData)
35
74
  if (!exposeTo.includes(e.deviceId) && !exposeTo.includes('*')) {
36
75
  throw new RemoteError('permission denied')
37
76
  }
38
- const { paths, args } = e.data as { paths: string[]; args: unknown[] }
39
- let target = obj
40
- for (let i = 0; i < paths.length; i += 1) {
41
- target = target[paths[i] as keyof typeof target] as typeof target
42
- }
43
- let res: unknown
44
- if (target instanceof Function) {
45
- res = await target(...args)
46
- } else {
47
- res = target
48
- }
77
+ const handler = inputHandler ?? geneDefaultHandler(obj)
78
+ const res = await handler(data)
49
79
  adaptor.emit({
50
80
  name: e.callbackName ?? 'IMPOSSIBLE_NO_CALLBACK_NAME',
51
81
  deviceId: e.targetDeviceId,
package/src/remoteValue/remoteValue.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { RemoteError, RemoteTimeoutError, response } from '../response'
2
2
  import { Adaptor, AdaptorCallback, AdaptorPackageData } from '../adaptor'
3
- import type { ToFunc } from './type'
3
+ import type { RemoteCallData, ToFunc } from './type'
4
4
 
5
5
  function noop() {
6
6
  // pass
@@ -62,7 +62,7 @@ function geneProxy<T extends object>(paths: string[], props: RemoteValueProps) {
62
62
  data: {
63
63
  paths,
64
64
  args: argArray,
65
- },
65
+ } satisfies RemoteCallData,
66
66
  })
67
67
  })
68
68
  },
package/src/remoteValue/type.ts CHANGED
@@ -20,6 +20,11 @@ export type ToFunc<T extends object> = {
20
20
  : never
21
21
  }
22
22
 
23
+ export interface RemoteCallData {
24
+ paths: string[]
25
+ args: unknown[]
26
+ }
27
+
23
28
  // 下面的都是测试代码，用于测试 ToFunc
24
29
 
25
30
  type Assert<T extends true> = T