@jhh96/light-app-bridge 1.0.3 → 1.0.4

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.
@@ -12,9 +12,10 @@
12
12
  *
13
13
  * 收消息不强依赖 waltz,按以下优先级自动选择监听后端:
14
14
  * 1. window.waltz.event.on('native-call-js') —— 有 waltz 的环境(推荐)
15
- * 2. window.handleMessageFromNative —— 无 waltz 时 hook 此全局方法
16
- * (waltzBridge 投递消息的统一入口,sendMessageToPluginLightAppById 最终会调它)
17
- * 两者都不可用则抛异常。
15
+ * 2. window.handleMessageFromNative —— 无 waltz 时由本 SDK 定义此方法
16
+ * (该方法由 waltz.min.js 注册;无 waltz 时为 undefined,renderer 投递消息前
17
+ * 会检查其类型,没人定义则消息被丢弃。故由本 SDK 照 waltz.min.js 方式定义,
18
+ * renderer 收到消息后主动调用它传入消息)
18
19
  *
19
20
  * 消息信封:
20
21
  * { __sdk: 'LightAppBridge', v: 1, id, type, data }
@@ -77,7 +78,7 @@ export default class LightAppBridge {
77
78
  constructor(role?: BridgeRole, options?: BridgeOptions);
78
79
  /** 校验依赖是否就绪,缺失抛出明确异常 */
79
80
  private _checkDeps;
80
- /** 异步绑定消息监听:优先 waltz,回退 hook handleMessageFromNative(可能需等待其注入) */
81
+ /** 绑定消息监听:优先 waltz;无 waltz 时定义/包装 window.handleMessageFromNative */
81
82
  private _startListener;
82
83
  /** 构造消息信封 */
83
84
  private _envelope;
@@ -12,9 +12,10 @@
12
12
  *
13
13
  * 收消息不强依赖 waltz,按以下优先级自动选择监听后端:
14
14
  * 1. window.waltz.event.on('native-call-js') —— 有 waltz 的环境(推荐)
15
- * 2. window.handleMessageFromNative —— 无 waltz 时 hook 此全局方法
16
- * (waltzBridge 投递消息的统一入口,sendMessageToPluginLightAppById 最终会调它)
17
- * 两者都不可用则抛异常。
15
+ * 2. window.handleMessageFromNative —— 无 waltz 时由本 SDK 定义此方法
16
+ * (该方法由 waltz.min.js 注册;无 waltz 时为 undefined,renderer 投递消息前
17
+ * 会检查其类型,没人定义则消息被丢弃。故由本 SDK 照 waltz.min.js 方式定义,
18
+ * renderer 收到消息后主动调用它传入消息)
18
19
  *
19
20
  * 消息信封:
20
21
  * { __sdk: 'LightAppBridge', v: 1, id, type, data }
@@ -52,38 +53,19 @@ function getInvoke() {
52
53
  }
53
54
  return null;
54
55
  }
55
- /** 等待 handleMessageFromNative 出现的轮询间隔(ms) */
56
- const BACKEND_POLL_INTERVAL = 100;
57
- /** 等待监听后端就绪的超时(ms) */
58
- const BACKEND_POLL_TIMEOUT = 10000;
59
56
  /** waltz 路径是否可用 */
60
57
  function hasWaltz() {
61
58
  const w = window.waltz;
62
59
  return !!(w && w.event && typeof w.event.on === 'function');
63
60
  }
64
- /** handleMessageFromNative 是否可用 */
65
- function hasHandleMessageFromNative() {
66
- return typeof window.handleMessageFromNative === 'function';
67
- }
68
- /** 轮询等待条件成立 */
69
- function waitFor(check, timeout) {
70
- return new Promise((resolve, reject) => {
71
- const start = Date.now();
72
- const tick = () => {
73
- if (check())
74
- return resolve();
75
- if (Date.now() - start > timeout) {
76
- return reject(new Error(`等待超时 (${timeout}ms)`));
77
- }
78
- setTimeout(tick, BACKEND_POLL_INTERVAL);
79
- };
80
- tick();
81
- });
82
- }
83
61
  /**
84
- * 异步解析可用的监听后端并绑定:优先 waltz,回退 hook window.handleMessageFromNative。
85
- * 无 waltz 且 handleMessageFromNative 尚未注入时,轮询等待其出现(上限 BACKEND_POLL_TIMEOUT)。
86
- * 两者始终不可用则 reject。
62
+ * 解析可用的监听后端并绑定:优先 waltz,回退定义 window.handleMessageFromNative。
63
+ *
64
+ * 说明:handleMessageFromNative 由 waltz.min.js 注册(参考其实现)。
65
+ * 无 waltz 的环境里它是 undefined,且 renderer(waltzBridge preload)投递消息前
66
+ * 会检查 typeof window.handleMessageFromNative === 'function'——
67
+ * 没人定义它消息就会被丢弃。因此无 waltz 时由本 SDK 定义此方法,
68
+ * renderer 收到消息后会主动调用它传入消息。
87
69
  */
88
70
  function bindMessageBackend(cb) {
89
71
  const w = window;
@@ -104,24 +86,35 @@ function bindMessageBackend(cb) {
104
86
  ev.removeListener('native-call-js', handler);
105
87
  });
106
88
  }
107
- // 2. hook handleMessageFromNative 路径:无 waltz 时。
108
- // 它可能晚于本 SDK 构造才被 preload/waltzBridge 注册,故轮询等待。
109
- return waitFor(hasHandleMessageFromNative, BACKEND_POLL_TIMEOUT).then(() => {
110
- const prev = w.handleMessageFromNative;
111
- const wrapped = function (raw) {
89
+ // 2. 定义 handleMessageFromNative 路径:无 waltz 时。
90
+ // renderer(waltzBridge)投递:handleMessageFromNative(JSON.stringify({responseId, responseData})),
91
+ // 其中 responseData = {code, body:{eventName, params:{message, fromWebContentsId}}, msg}
92
+ if (typeof w.handleMessageFromNative !== 'function') {
93
+ // 尚未定义(无 waltz 的正常情况):由本 SDK 定义,renderer 主动调它传消息
94
+ const handler = function (raw) {
112
95
  const msg = parseHandleMessageFromNative(raw);
113
96
  if (msg)
114
97
  cb(msg);
115
- // 透传给原 handler(若存在),保持 waltz/业务自身逻辑不被破坏
116
- if (typeof prev === 'function')
117
- return prev.apply(this, arguments);
118
- };
119
- w.handleMessageFromNative = wrapped;
120
- return () => {
121
- // 还原:仅当仍为自身 wrapped 时才还原,避免覆盖后续可能的重新赋值
122
- if (w.handleMessageFromNative === wrapped)
123
- w.handleMessageFromNative = prev;
124
98
  };
99
+ w.handleMessageFromNative = handler;
100
+ return Promise.resolve(() => {
101
+ // 清理:仅当仍为自身 handler 时才删除,避免误删后续重新赋值
102
+ if (w.handleMessageFromNative === handler)
103
+ delete w.handleMessageFromNative;
104
+ });
105
+ }
106
+ // 已存在(如 waltz 晚于本 SDK 加载、或其它实例已定义):包装透传,不破坏原逻辑
107
+ const prev = w.handleMessageFromNative;
108
+ const wrapped = function (raw) {
109
+ const msg = parseHandleMessageFromNative(raw);
110
+ if (msg)
111
+ cb(msg);
112
+ return prev.apply(this, arguments);
113
+ };
114
+ w.handleMessageFromNative = wrapped;
115
+ return Promise.resolve(() => {
116
+ if (w.handleMessageFromNative === wrapped)
117
+ w.handleMessageFromNative = prev;
125
118
  });
126
119
  }
127
120
  /**
@@ -185,7 +178,7 @@ export default class LightAppBridge {
185
178
  return peerId;
186
179
  });
187
180
  this._checkDeps(); // 依赖校验,缺失直接抛异常
188
- this._startListener(); // 异步绑定消息监听(waltz 或 handleMessageFromNative)
181
+ this._startListener(); // 绑定消息监听(waltz 或定义 handleMessageFromNative)
189
182
  this.connect(); // 构造即自动发起握手(内部会等监听就绪)
190
183
  }
191
184
  /** 校验依赖是否就绪,缺失抛出明确异常 */
@@ -197,10 +190,10 @@ export default class LightAppBridge {
197
190
  if (this.role === 'plugin' && typeof (w.worklink.plugin && w.worklink.plugin.getContentContext) !== 'function') {
198
191
  throw new Error('LightAppBridge(plugin) 依赖 window.worklink.plugin.getContentContext,当前环境不可用');
199
192
  }
200
- // 监听后端(waltz / handleMessageFromNative)允许稍后出现,由 _startListener 异步等待,
201
- // 不在构造时强校验;两者始终未出现时 connect()/ready() 会 reject。
193
+ // 监听后端不强校验:有 waltz 走 waltz;无 waltz 由 _startListener 定义
194
+ // window.handleMessageFromNative(renderer 会主动调用它传入消息)。
202
195
  }
203
- /** 异步绑定消息监听:优先 waltz,回退 hook handleMessageFromNative(可能需等待其注入) */
196
+ /** 绑定消息监听:优先 waltz;无 waltz 时定义/包装 window.handleMessageFromNative */
204
197
  _startListener() {
205
198
  if (this._started)
206
199
  return;
@@ -210,8 +203,8 @@ export default class LightAppBridge {
210
203
  this._unlisten = unlisten;
211
204
  })
212
205
  .catch((e) => {
213
- // 监听后端不可用:让连接失败并给出明确原因
214
- this._connectDeferred.reject(new Error('LightAppBridge 无可用监听后端:window.waltz.event 与 window.handleMessageFromNative 均不可用 (' +
206
+ // 理论上不会发生(无 waltz 时必走定义路径),保险起见让连接失败并给出原因
207
+ this._connectDeferred.reject(new Error('LightAppBridge 监听后端绑定失败 (' +
215
208
  (e && e.message ? e.message : String(e)) + ')'));
216
209
  });
217
210
  }
@@ -254,10 +247,9 @@ export default class LightAppBridge {
254
247
  if (this._connectStarted)
255
248
  return this._connectPromise;
256
249
  this._connectStarted = true;
257
- // 等监听后端就绪(handleMessageFromNative 可能需等待注入)后再握手,
258
- // 避免对端的 ack/hello 在监听绑定前到达而丢失
250
+ // 等监听后端绑定完成后再握手,避免对端的 ack/hello 在监听绑定前到达而丢失
259
251
  const listenerReady = (_a = this._listenerReady) !== null && _a !== void 0 ? _a : Promise.resolve();
260
- // 握手超时保护(含监听等待时间)
252
+ // 握手超时保护
261
253
  this._handshakeTimer = setTimeout(() => {
262
254
  if (!this._connected) {
263
255
  this._connectDeferred.reject(new Error(`握手超时 (${this.handshakeTimeout}ms),对端未响应`));
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jhh96/light-app-bridge",
3
- "version": "1.0.3",
3
+ "version": "1.0.4",
4
4
  "type": "module",
5
5
  "description": "招商随行(WorkLink)插件窗口(plugin)与轻应用窗口(lightapp)之间的双向通信 SDK",
6
6
  "main": "./dist/index.js",