fix: getOpenerEventChannel may return an empty object

Author: SgLy

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2025-07-15 v4.1.0
+- 修改 `getOpenerEventChannel` 的返回值的类型，使其有可能返回空对象，以正确反映实际情况。这是一个 **破坏性改动**，`getOpenerEventChannel` 的返回值上的 `emit`, `on` 等方法不再可以直接调用 ([#350](https://github.com/wechat-miniprogram/api-typings/issues/350))
+- 解决依赖安全问题
+
 ## 2025-07-15 v4.0.8
 - 更新 API 定义到 3.8.10
 

test/api-doc.test.ts

@@ -3096,12 +3096,14 @@ type TPlatform = 'ios' | 'android' | 'windows' | 'mac' | 'devtools' | 'ohos'
     onLoad(option) {
       console.log(option.query)
       const eventChannel = this.getOpenerEventChannel()
-      eventChannel.emit('acceptDataFromOpenedPage', { data: 'test' })
-      eventChannel.emit('someEvent', { data: 'test' })
-      // 监听acceptDataFromOpenerPage事件，获取上一页面通过eventChannel传送到当前页面的数据
-      eventChannel.on('acceptDataFromOpenerPage', function(data: any) {
-        console.log(data)
-      })
+      if (typeof eventChannel.emit === 'function') {
+        eventChannel.emit('acceptDataFromOpenedPage', { data: 'test' })
+        eventChannel.emit('someEvent', { data: 'test' })
+        // 监听acceptDataFromOpenerPage事件，获取上一页面通过eventChannel传送到当前页面的数据
+        eventChannel.on('acceptDataFromOpenerPage', function(data: any) {
+          console.log(data)
+        })
+      }
     },
   })
 }

test/component.test.ts

@@ -1,4 +1,4 @@
-import { expectType, expectError } from 'tsd'
+import { expectType, expectError, expectNotAssignable } from 'tsd'
 
 expectType<string>(Component({}))
 
@@ -410,10 +410,15 @@ Component({
   methods: {
     test() {
       const channel = this.getOpenerEventChannel()
-      expectType<WechatMiniprogram.EventChannel>(channel)
-      channel.emit('test', {})
-      channel.on('xxx', () => {})
-      expectError(channel.emit(1, 2))
+      // `tsd` not yet supports error `ts2722`
+      // expectError(channel.emit('test', {}))
+      expectNotAssignable<(...args: any[]) => any>(channel.emit)
+      channel.emit?.('test', {})
+      expectError(channel.emit?.(1, 2))
+      channel.on?.('xxx', () => {})
+      if (typeof channel.emit === 'function') {
+        channel.on('xxx', () => {})
+      }
     },
   },
 })

test/page.test.ts

@@ -1,4 +1,4 @@
-import { expectType, expectError } from 'tsd'
+import { expectType, expectError, expectNotAssignable } from 'tsd'
 
 expectType<void>(Page({}))
 
@@ -203,10 +203,15 @@ Page<DataType, CustomOption>({
 Page({
   test() {
     const channel = this.getOpenerEventChannel()
-    expectType<WechatMiniprogram.EventChannel>(channel)
-    channel.emit('test', {})
-    channel.on('xxx', () => {})
-    expectError(channel.emit(1, 2))
+    // `tsd` not yet supports error `ts2722`
+    // expectError(channel.emit('test', {}))
+    expectNotAssignable<(...args: any[]) => any>(channel.emit)
+    channel.emit?.('test', {})
+    expectError(channel.emit?.(1, 2))
+    channel.on?.('xxx', () => {})
+    if (typeof channel.emit === 'function') {
+      channel.on('xxx', () => {})
+    }
   },
 })
 

types/wx/lib.wx.api.d.ts

@@ -10573,7 +10573,7 @@ NFCAdapter.offDiscovered(listener) // 需传入与监听时同一个的函数对
         success?: RequestSubscribeMessageSuccessCallback
     }
     interface RequestSubscribeMessageSuccessCallbackResult {
-        /** [TEMPLATE_ID]是动态的键，即模板id，值包括'accept'、'reject'、'ban'、'filter'、'acceptWithAlert'、'acceptWithAudio'。'accept'表示用户同意订阅该条id对应的模板消息，'reject'表示用户拒绝订阅该条id对应的模板消息，'ban'表示已被后台封禁，'filter'表示该模板因为模板标题同名被后台过滤，'acceptWithAlert' 表示用户接收消息并打开提醒, 'acceptWithAudio' 表示用户接收订阅消息并开启了语音提醒, 'acceptWithForcePush' 表示用户接收订阅消息并开启了推送提醒。例如 { errMsg: "requestSubscribeMessage:ok", zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE: "accept"} 表示用户同意订阅zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE这条消息 */
+        /** [TEMPLATE_ID]是动态的键，即模板id，值包括'accept'、'reject'、'ban'、'filter'。'accept'表示用户同意订阅该条id对应的模板消息，'reject'表示用户拒绝订阅该条id对应的模板消息，'ban'表示已被后台封禁，'filter'表示该模板因为模板标题同名被后台过滤。例如 { errMsg: "requestSubscribeMessage:ok", zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE: "accept"} 表示用户同意订阅zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE这条消息 */
         [TEMPLATE_ID: string]: string
         /** 接口调用成功时errMsg值为'requestSubscribeMessage:ok' */
         errMsg: string
@@ -15916,6 +15916,40 @@ this.editorCtx.insertImage({
          * 撤销 */
         undo(option?: UndoOption): void
     }
+    interface EmptyEventChannel {
+        /** [EventChannel.emit(string eventName, any args)](https://developers.weixin.qq.com/miniprogram/dev/api/route/EventChannel.emit.html)
+         *
+         * 需要基础库： `2.7.3`
+         *
+         * 在插件中使用：支持
+         *
+         * 触发一个事件 */
+        emit: undefined
+        /** [EventChannel.off(string eventName, function fn)](https://developers.weixin.qq.com/miniprogram/dev/api/route/EventChannel.off.html)
+         *
+         * 需要基础库： `2.7.3`
+         *
+         * 在插件中使用：支持
+         *
+         * 取消监听一个事件。给出第二个参数时，只取消给出的监听函数，否则取消所有监听函数 */
+        off: undefined
+        /** [EventChannel.on(string eventName, function fn)](https://developers.weixin.qq.com/miniprogram/dev/api/route/EventChannel.on.html)
+         *
+         * 需要基础库： `2.7.3`
+         *
+         * 在插件中使用：支持
+         *
+         * 持续监听一个事件 */
+        on: undefined
+        /** [EventChannel.once(string eventName, function fn)](https://developers.weixin.qq.com/miniprogram/dev/api/route/EventChannel.once.html)
+         *
+         * 需要基础库： `2.7.3`
+         *
+         * 在插件中使用：支持
+         *
+         * 监听一个事件一次，触发后失效 */
+        once: undefined
+    }
     interface EntryList {
         /** [Array.<[PerformanceEntry](https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/PerformanceEntry.html)> EntryList.getEntries()](https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/EntryList.getEntries.html)
          *

types/wx/lib.wx.component.d.ts

@@ -325,7 +325,7 @@ declare namespace WechatMiniprogram.Component {
          *
          * 最低基础库版本：[`2.7.3`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
          */
-        getOpenerEventChannel(): EventChannel
+        getOpenerEventChannel(): EventChannel | EmptyEventChannel
         /**
          * 绑定由 worklet 驱动的样式到相应的节点，详见 [worklet 动画](https://developers.weixin.qq.com/miniprogram/dev/framework/runtime/skyline/worklet.html)
          *