Bug Report: Incorrect Event Name in Web Meeting SDK TypeScript Definitions (onPreviewPannel| receiveSharingChannelReady)

Meeting SDK Web
1

Description
The TypeScript definition file (index.d.ts) for the Web Meeting SDK, including the recent version 3.13.0 (released April 15, 2025), contains an incorrectly formatted and likely erroneous event name string literal: 'onPreviewPannel| receiveSharingChannelReady'.

This name appears incorrect due to several reasons:

  1. It contains an internal pipe character (|).
  2. It includes extra whitespace ( ).
  3. “Pannel” is likely a misspelling of “Panel”.

This issue is not new; it has persisted across many versions. While investigating, I examined the index.d.ts from an older version (v3.1.6) and found evidence suggesting these were intended as, or at least previously defined as, separate events (specifically 'receiveSharingChannelReady' and 'onPreviewPannel'). The persistence of the combined, malformed name in the current version (v3.13.0) causes confusion and potential issues for developers using TypeScript.

Browser Console Error
Not applicable. This issue pertains to the accuracy of the TypeScript definition file (index.d.ts) itself, not a runtime error message.

Which Web Meeting SDK version?
The issue (incorrect event name 'onPreviewPannel| receiveSharingChannelReady') is confirmed present in the latest version checked, v3.13.0.
Evidence suggesting the correct structure (separate events) was found by inspecting the index.d.ts of an older version, v3.1.6.

Meeting SDK Code Snippets

  1. Problematic definition (Observed in v3.13.0 index.d.ts):
    Within the type definitions for events, the following string literal exists:

    // In index.d.ts for v3.13.0 (and likely preceding versions)
// ... within a type union or function overload ...
| 'onPreviewPannel|  receiveSharingChannelReady' // <-- Problematic entry persists
// ...

  2. Evidence for Correct Structure (Found in v3.1.6 index.d.ts):
    The index.d.ts for v3.1.6 shows separate definitions/examples, suggesting the correct structure:

    // Snippet from v3.1.6 index.d.ts
/**
 * Listens for sharing channel readiness to receive.
 * ...
   */
function inMeetingServiceListener(event: 'receiveSharingChannelReady' , callback: Function): void; // Separate event
   /**
   * Listens for waiting room and audio or video preview page status.
   * ... Example uses 'onPreviewPannel' ...
   */
   // Example usage shown in v3.1.6 comments: ZoomMtg.inMeetingServiceListener('onPreviewPannel', ...) // Separate event (though 'Pannel' typo may exist)

To Reproduce

  1. Obtain the index.d.ts file included with Web Meeting SDK v3.13.0.
  2. Inspect the type definitions related to events (e.g., used with inMeetingServiceListener).
  3. Observe the presence of the combined string literal 'onPreviewPannel| receiveSharingChannelReady'.
  4. Obtain the index.d.ts file from Web Meeting SDK v3.1.6.
  5. Compare the event definitions, noting the separate events ('receiveSharingChannelReady', 'onPreviewPannel') defined/used in v3.1.6, which strongly suggests the combined name still present in v3.13.0 is incorrect.

Screenshots
Screenshots of the relevant lines in the index.d.ts files for v3.13.0 and v3.1.6 can be provided if necessary.

Troubleshooting Routes

  • Checked the index.d.ts file for the current version (v3.13.0) and confirmed the presence of the malformed event name 'onPreviewPannel|...'.
  • Analyzed the string literal against standard TypeScript practices and common event naming conventions (internal pipe, extra spaces are irregular).
  • Compared the v3.13.0 definition with definitions found in an older version (v3.1.6). The older version uses separate, more conventional event names ('receiveSharingChannelReady', 'onPreviewPannel'), providing strong evidence that the definition persisting in v3.13.0 is likely an error.
  • Noted the potential typo “Pannel” (likely should be “Panel”) seems to persist across different versions where related events are mentioned.

Device (please complete the following information):
(This issue is related to the SDK’s type definition file, not specific device runtime behavior)

  • Device: N/A (Issue is in code definition)
  • OS: N/A
  • Browser: N/A
  • Browser Version: N/A

Additional context
The core issue is a malformed event name ('onPreviewPannel| receiveSharingChannelReady') in the Web Meeting SDK’s TypeScript definitions (index.d.ts) that persists up to at least v3.13.0. This is not just an old, fixed bug. Evidence found in an older version (v3.1.6) strongly suggests this should be two separate events ('receiveSharingChannelReady' and 'onPreviewPanel').

We request this error be corrected in a future SDK release. Additionally, we recommend verifying and correcting the spelling of “Pannel” to “Panel” in all relevant event names for improved clarity and accuracy.