@microsoft/teams-js 2.31.0-beta.1 → 2.31.0-beta.3

package/dist/esm/packages/teams-js/dts/private/videoEffectsEx.d.ts

@@ -1,244 +1,250 @@
+/**
+ * @hidden
+ * Extended video API
+ * @internal
+ * Limited to Microsoft-internal use
+ * @beta
+ * @module
+ */
 import { DefaultVideoEffectCallBack as VideoEffectCallBack } from '../internal/videoEffectsUtils';
-import { videoEffects } from '../public/videoEffects';
-export declare namespace videoEffectsEx {
-    const frameProcessingTimeoutInMs = 2000;
+import * as videoEffects from '../public/videoEffects';
+export declare const frameProcessingTimeoutInMs = 2000;
+/**
+ * @hidden
+ * Error level when notifying errors to the host, the host will decide what to do acording to the error level.
+ * @beta
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare enum ErrorLevel {
+    Fatal = "fatal",
+    Warn = "warn"
+}
+/**
+ * @hidden
+ * Video frame configuration supplied to the host to customize the generated video frame parameters
+ * @beta
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface VideoFrameConfig extends videoEffects.VideoFrameConfig {
     /**
      * @hidden
-     * Error level when notifying errors to the host, the host will decide what to do acording to the error level.
+     * Flag to indicate use camera stream to synthesize video frame or not.
+     * Default value is true.
      * @beta
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    enum ErrorLevel {
-        Fatal = "fatal",
-        Warn = "warn"
-    }
+    requireCameraStream?: boolean;
     /**
      * @hidden
-     * Video frame configuration supplied to the host to customize the generated video frame parameters
+     * Machine learning model to run in the host to do audio inference for you
      * @beta
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    interface VideoFrameConfig extends videoEffects.VideoFrameConfig {
-        /**
-         * @hidden
-         * Flag to indicate use camera stream to synthesize video frame or not.
-         * Default value is true.
-         * @beta
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        requireCameraStream?: boolean;
-        /**
-         * @hidden
-         * Machine learning model to run in the host to do audio inference for you
-         * @beta
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        audioInferenceModel?: ArrayBuffer;
-        /**
-         * @hidden
-         * Specifies additional capabilities that should be applied to the video frame
-         * @beta
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        requiredCapabilities?: string[];
-    }
+    audioInferenceModel?: ArrayBuffer;
     /**
      * @hidden
-     * Represents a video frame
+     * Specifies additional capabilities that should be applied to the video frame
      * @beta
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    interface VideoBufferData extends videoEffects.VideoBufferData {
-        /**
-         * @hidden
-         * The model output if you passed in an {@linkcode VideoFrameConfig.audioInferenceModel}
-         * @beta
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        audioInferenceResult?: Uint8Array;
-    }
+    requiredCapabilities?: string[];
+}
+/**
+ * @hidden
+ * Represents a video frame
+ * @beta
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface VideoBufferData extends videoEffects.VideoBufferData {
     /**
      * @hidden
-     * The callback will be called on every frame when running on the supported host.
-     * We require the frame rate of the video to be at least 22fps for 720p, thus the callback should process a frame timely.
-     * The video app should call `notifyVideoFrameProcessed` to notify a successfully processed video frame.
-     * The video app should call `notifyError` to notify a failure. When the failures accumulate to a certain number(determined by the host), the host will see the app is "frozen" and give the user the option to close the app.
+     * The model output if you passed in an {@linkcode VideoFrameConfig.audioInferenceModel}
      * @beta
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    type VideoBufferHandler = (videoBufferData: VideoBufferData, notifyVideoFrameProcessed: () => void, notifyError: (errorMessage: string) => void) => void;
+    audioInferenceResult?: Uint8Array;
+}
+/**
+ * @hidden
+ * The callback will be called on every frame when running on the supported host.
+ * We require the frame rate of the video to be at least 22fps for 720p, thus the callback should process a frame timely.
+ * The video app should call `notifyVideoFrameProcessed` to notify a successfully processed video frame.
+ * The video app should call `notifyError` to notify a failure. When the failures accumulate to a certain number(determined by the host), the host will see the app is "frozen" and give the user the option to close the app.
+ * @beta
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export type VideoBufferHandler = (videoBufferData: VideoBufferData, notifyVideoFrameProcessed: () => void, notifyError: (errorMessage: string) => void) => void;
+/**
+ * @hidden
+ * Video frame data extracted from the media stream. More properties may be added in the future.
+ * @beta
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export type VideoFrameData = videoEffects.VideoFrameData & {
     /**
      * @hidden
-     * Video frame data extracted from the media stream. More properties may be added in the future.
+     * The model output if you passed in an {@linkcode VideoFrameConfig.audioInferenceModel}
      * @beta
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    type VideoFrameData = videoEffects.VideoFrameData & {
-        /**
-         * @hidden
-         * The model output if you passed in an {@linkcode VideoFrameConfig.audioInferenceModel}
-         * @beta
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        audioInferenceResult?: Uint8Array;
-        /**
-         * @hidden
-         * Additional metadata determined by capabilities specified in {@linkcode VideoFrameConfig.requiredCapabilities}
-         * @beta
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        attributes?: ReadonlyMap<string, Uint8Array>;
-    };
+    audioInferenceResult?: Uint8Array;
     /**
      * @hidden
-     * The callback will be called on every frame when running on the supported host.
-     * We require the frame rate of the video to be at least 22fps for 720p, thus the callback should process a frame timely.
-     * The video app should resolve the promise to notify a successfully processed video frame.
-     * The video app should reject the promise to notify a failure. When the failures accumulate to a certain number(determined by the host), the host will see the app is "frozen" and give the user the option to close the app.
+     * Additional metadata determined by capabilities specified in {@linkcode VideoFrameConfig.requiredCapabilities}
      * @beta
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    type VideoFrameHandler = (receivedVideoFrame: VideoFrameData) => Promise<videoEffects.VideoFrame>;
-    /**
-     * @hidden
-     * @beta
-     * Callbacks and configuration supplied to the host to process the video frames.
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    type RegisterForVideoFrameParameters = {
-        /**
-         * Callback function to process the video frames extracted from a media stream.
-         */
-        videoFrameHandler: VideoFrameHandler;
-        /**
-         * Callback function to process the video frames shared by the host.
-         */
-        videoBufferHandler: VideoBufferHandler;
-        /**
-         * Video frame configuration supplied to the host to customize the generated video frame parameters, like format
-         */
-        config: VideoFrameConfig;
-    };
+    attributes?: ReadonlyMap<string, Uint8Array>;
+};
+/**
+ * @hidden
+ * The callback will be called on every frame when running on the supported host.
+ * We require the frame rate of the video to be at least 22fps for 720p, thus the callback should process a frame timely.
+ * The video app should resolve the promise to notify a successfully processed video frame.
+ * The video app should reject the promise to notify a failure. When the failures accumulate to a certain number(determined by the host), the host will see the app is "frozen" and give the user the option to close the app.
+ * @beta
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export type VideoFrameHandler = (receivedVideoFrame: VideoFrameData) => Promise<videoEffects.VideoFrame>;
+/**
+ * @hidden
+ * @beta
+ * Callbacks and configuration supplied to the host to process the video frames.
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export type RegisterForVideoFrameParameters = {
     /**
-     * @hidden
-     * Register to process video frames
-     * @beta
-     *
-     * @param parameters - Callbacks and configuration to process the video frames. A host may support either {@link VideoFrameHandler} or {@link VideoBufferHandler}, but not both.
-     * To ensure the video effect works on all supported hosts, the video app must provide both {@link VideoFrameHandler} and {@link VideoBufferHandler}.
-     * The host will choose the appropriate callback based on the host's capability.
-     *
-     * @internal
-     * Limited to Microsoft-internal use
+     * Callback function to process the video frames extracted from a media stream.
      */
-    function registerForVideoFrame(parameters: RegisterForVideoFrameParameters): void;
+    videoFrameHandler: VideoFrameHandler;
     /**
-     * @hidden
-     * Video extension should call this to notify host that the current selected effect parameter changed.
-     * If it's pre-meeting, host will call videoEffectCallback immediately then use the videoEffect.
-     * If it's the in-meeting scenario, we will call videoEffectCallback when apply button clicked.
-     * @beta
-     * @param effectChangeType - the effect change type.
-     * @param effectId - Newly selected effect id. {@linkcode VideoEffectCallBack}
-     * @param effectParam Variant for the newly selected effect. {@linkcode VideoEffectCallBack}
-     *
-     * @internal
-     * Limited to Microsoft-internal use
+     * Callback function to process the video frames shared by the host.
      */
-    function notifySelectedVideoEffectChanged(effectChangeType: videoEffects.EffectChangeType, effectId: string | undefined, effectParam?: string): void;
+    videoBufferHandler: VideoBufferHandler;
     /**
-     * @hidden
-     * Register the video effect callback, host uses this to notify the video extension the new video effect will by applied
-     * @beta
-     * @param callback - The VideoEffectCallback to invoke when registerForVideoEffect has completed
-     *
-     * @internal
-     * Limited to Microsoft-internal use
+     * Video frame configuration supplied to the host to customize the generated video frame parameters, like format
      */
-    function registerForVideoEffect(callback: VideoEffectCallBack): void;
+    config: VideoFrameConfig;
+};
+/**
+ * @hidden
+ * Register to process video frames
+ * @beta
+ *
+ * @param parameters - Callbacks and configuration to process the video frames. A host may support either {@link VideoFrameHandler} or {@link VideoBufferHandler}, but not both.
+ * To ensure the video effect works on all supported hosts, the video app must provide both {@link VideoFrameHandler} and {@link VideoBufferHandler}.
+ * The host will choose the appropriate callback based on the host's capability.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function registerForVideoFrame(parameters: RegisterForVideoFrameParameters): void;
+/**
+ * @hidden
+ * Video extension should call this to notify host that the current selected effect parameter changed.
+ * If it's pre-meeting, host will call videoEffectCallback immediately then use the videoEffect.
+ * If it's the in-meeting scenario, we will call videoEffectCallback when apply button clicked.
+ * @beta
+ * @param effectChangeType - the effect change type.
+ * @param effectId - Newly selected effect id. {@linkcode VideoEffectCallBack}
+ * @param effectParam Variant for the newly selected effect. {@linkcode VideoEffectCallBack}
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function notifySelectedVideoEffectChanged(effectChangeType: videoEffects.EffectChangeType, effectId: string | undefined, effectParam?: string): void;
+/**
+ * @hidden
+ * Register the video effect callback, host uses this to notify the video extension the new video effect will by applied
+ * @beta
+ * @param callback - The VideoEffectCallback to invoke when registerForVideoEffect has completed
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function registerForVideoEffect(callback: VideoEffectCallBack): void;
+/**
+ * @hidden
+ * Personalized video effect
+ * @beta
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface PersonalizedEffect {
     /**
-     * @hidden
-     * Personalized video effect
-     * @beta
-     *
-     * @internal
-     * Limited to Microsoft-internal use
+     * Personalized effect id
      */
-    interface PersonalizedEffect {
-        /**
-         * Personalized effect id
-         */
-        id: string;
-        /**
-         * Display name
-         */
-        name: string;
-        /**
-         * Effect type defined by app
-         */
-        type: string;
-        /**
-         * Data URI of the thumbnail image content encoded in ASCII format using the base64 scheme
-         */
-        thumbnail: string;
-    }
+    id: string;
     /**
-     * @hidden
-     * Send personalized effects to Teams client
-     * @beta
-     *
-     * @internal
-     * Limited to Microsoft-internal use
+     * Display name
      */
-    function updatePersonalizedEffects(effects: PersonalizedEffect[]): void;
+    name: string;
     /**
-     * @hidden
-     *
-     * Checks if video capability is supported by the host
-     * @beta
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
-     *
-     * @returns boolean to represent whether the video capability is supported
-     *
-     * @internal
-     * Limited to Microsoft-internal use
+     * Effect type defined by app
      */
-    function isSupported(): boolean;
+    type: string;
     /**
-     * @hidden
-     * Sending fatal error notification to host. Call this function only when your app meets fatal error and can't continue.
-     * The host will stop the video pipeline and terminate this session, and optionally, show an error message to the user.
-     * @beta
-     * @param errorMessage - The error message that will be sent to the host
-     *
-     * @internal
-     * Limited to Microsoft-internal use
+     * Data URI of the thumbnail image content encoded in ASCII format using the base64 scheme
      */
-    function notifyFatalError(errorMessage: string): void;
+    thumbnail: string;
 }
+/**
+ * @hidden
+ * Send personalized effects to Teams client
+ * @beta
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function updatePersonalizedEffects(effects: PersonalizedEffect[]): void;
+/**
+ * @hidden
+ *
+ * Checks if video capability is supported by the host
+ * @beta
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @returns boolean to represent whether the video capability is supported
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function isSupported(): boolean;
+/**
+ * @hidden
+ * Sending fatal error notification to host. Call this function only when your app meets fatal error and can't continue.
+ * The host will stop the video pipeline and terminate this session, and optionally, show an error message to the user.
+ * @beta
+ * @param errorMessage - The error message that will be sent to the host
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function notifyFatalError(errorMessage: string): void;

package/dist/esm/packages/teams-js/dts/public/app/app.d.ts

@@ -1,5 +1,10 @@
+/**
+ * Module to interact with app initialization and lifecycle.
+ * @module
+ */
+import * as appHelpers from '../../internal/appHelpers';
 import { ChannelType, FrameContexts, HostClientType, HostName, TeamType, UserTeamRole } from '../constants';
-import { ActionInfo, FileOpenPreference, LocaleInfo } from '../interfaces';
+import { ActionInfo, FileOpenPreference, HostToAppPerformanceMetrics, LocaleInfo } from '../interfaces';
 import * as lifecycle from './lifecycle';
 /** App Initialization Messages */
 export declare const Messages: {
@@ -451,6 +456,10 @@ export interface Context {
  * This function is passed to registerOnThemeHandler. It is called every time the user changes their theme.
  */
 export type themeHandler = (theme: string) => void;
+/**
+ * This function is passed to registerHostToAppPerformanceMetricsHandler. It is called every time a response is received from the host with metrics for analyzing message delay. See {@link HostToAppPerformanceMetrics} to see which metrics are passed to the handler.
+ */
+export type HostToAppPerformanceMetricsHandler = (metrics: HostToAppPerformanceMetrics) => void;
 /**
  * Checks whether the Teams client SDK has been initialized.
  * @returns whether the Teams client SDK has been initialized.
@@ -503,7 +512,7 @@ export declare function notifyAppLoaded(): void;
 /**
  * Notifies the frame that app initialization is successful and is ready for user interaction.
  */
-export declare function notifySuccess(): void;
+export declare function notifySuccess(): Promise<appHelpers.NotifySuccessResponse>;
 /**
  * Notifies the frame that app initialization has failed and to show an error page in its place.
  *
@@ -526,6 +535,15 @@ export declare function notifyExpectedFailure(expectedFailureRequest: IExpectedF
  * @param handler - The handler to invoke when the user changes their theme.
  */
 export declare function registerOnThemeChangeHandler(handler: themeHandler): void;
+/**
+ * Registers a function for handling data of host to app message delay.
+ *
+ * @remarks
+ * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+ *
+ * @param handler - The handler to invoke when the metrics are available on each function response.
+ */
+export declare function registerHostToAppPerformanceMetricsHandler(handler: HostToAppPerformanceMetricsHandler): void;
 /**
  * This function opens deep links to other modules in the host such as chats or channels or
  * general-purpose links (to external websites). It should not be used for navigating to your
@@ -559,3 +577,4 @@ export declare function registerOnThemeChangeHandler(handler: themeHandler): voi
  */
 export declare function openLink(deepLink: string): Promise<void>;
 export { lifecycle };
+export { NotifySuccessResponse } from '../../internal/appHelpers';

package/dist/esm/packages/teams-js/dts/public/app/lifecycle.d.ts

@@ -1,13 +1,14 @@
-import { ResumeContext } from '../interfaces';
 /**
- * A namespace for enabling the suspension or delayed termination of an app when the user navigates away.
+ * A module for enabling the suspension or delayed termination of an app when the user navigates away.
  * When an app registers for the registerBeforeSuspendOrTerminateHandler, it chooses to delay termination.
  * When an app registers for both registerBeforeSuspendOrTerminateHandler and registerOnResumeHandler, it chooses the suspension of the app .
  * Please note that selecting suspension doesn't guarantee prevention of background termination.
  * The outcome is influenced by factors such as available memory and the number of suspended apps.
  *
  * @beta
+ * @module
  */
+import { ResumeContext } from '../interfaces';
 /**
  * Register on resume handler function type
  *

package/dist/esm/packages/teams-js/dts/public/appInitialization.d.ts

@@ -33,7 +33,7 @@ export { IExpectedFailureRequest };
 export declare function notifyAppLoaded(): void;
 /**
  * @deprecated
- * As of TeamsJS v2.0.0, please use {@link app.notifySuccess app.notifySuccess(): void} instead.
+ * As of TeamsJS v2.0.0, please use {@link app.notifySuccess app.notifySuccess(): Promise<NotifySuccessResponse>} instead.
  *
  * Notifies the frame that app initialization is successful and is ready for user interaction.
  */

package/dist/esm/packages/teams-js/dts/public/authentication.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Module to interact with the authentication-specific part of the SDK.
+ *
+ * This object is used for starting or completing authentication flows.
+ * @module
+ */
 /**
  * @hidden
  * @internal

package/dist/esm/packages/teams-js/dts/public/barCode.d.ts

@@ -1,7 +1,8 @@
 /**
- * Namespace to interact with the barcode scanning-specific part of the SDK.
+ * Module to interact with the barcode scanning-specific part of the SDK.
  *
  * @beta
+ * @module
  */
 /**
  * Data structure to customize the barcode scanning experience in scanBarCode API.

package/dist/esm/packages/teams-js/dts/public/calendar.d.ts

@@ -1,5 +1,6 @@
 /**
  * Interact with the user's calendar, including opening calendar items and composing meetings.
+ * @module
  */
 /**
  * Opens a calendar item.

package/dist/esm/packages/teams-js/dts/public/call.d.ts

@@ -1,5 +1,6 @@
 /**
  * Used to interact with call functionality, including starting calls with other users.
+ * @module
  */
 /** Modalities that can be associated with a call. */
 export declare enum CallModalities {

package/dist/esm/packages/teams-js/dts/public/chat.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Describes information needed to start a chat
+ * @module
+ */
 interface OpenChatRequest {
     /**
      * An optional message used when initiating chat

package/dist/esm/packages/teams-js/dts/public/clipboard.d.ts

@@ -2,6 +2,7 @@
  * Interact with the system clipboard
  *
  * @beta
+ * @module
  */
 /**
  * Function to copy data to clipboard.

package/dist/esm/packages/teams-js/dts/public/dialog/adaptiveCard/adaptiveCard.d.ts

@@ -1,10 +1,6 @@
 import { AdaptiveCardDialogInfo } from '../../interfaces';
 import { DialogSubmitHandler } from '../dialog';
 import * as bot from './bot';
-/**
- * Subcapability for interacting with adaptive card dialogs
- * @beta
- */
 /**
  * Allows app to open an adaptive card based dialog.
  *

package/dist/esm/packages/teams-js/dts/public/dialog/adaptiveCard/bot.d.ts

@@ -1,10 +1,11 @@
-import { BotAdaptiveCardDialogInfo } from '../../interfaces';
-import { DialogSubmitHandler } from '../dialog';
 /**
  * Module for interaction with adaptive card dialogs that need to communicate with the bot framework
  *
  * @beta
+ * @module
  */
+import { BotAdaptiveCardDialogInfo } from '../../interfaces';
+import { DialogSubmitHandler } from '../dialog';
 /**
  * Allows an app to open an adaptive card-based dialog module using bot.
  *

package/dist/esm/packages/teams-js/dts/public/dialog/dialog.d.ts

@@ -1,19 +1,6 @@
 import * as adaptiveCard from './adaptiveCard/adaptiveCard';
 import * as update from './update';
 import * as url from './url/url';
-/**
- * This group of capabilities enables apps to show modal dialogs. There are two primary types of dialogs: URL-based dialogs and [Adaptive Card](https://learn.microsoft.com/adaptive-cards/) dialogs.
- * Both types of dialogs are shown on top of your app, preventing interaction with your app while they are displayed.
- * - URL-based dialogs allow you to specify a URL from which the contents will be shown inside the dialog.
- *   - For URL dialogs, use the functions and interfaces in the {@link url} module.
- * - Adaptive Card-based dialogs allow you to provide JSON describing an Adaptive Card that will be shown inside the dialog.
- *   - For Adaptive Card dialogs, use the functions and interfaces in the {@link adaptiveCard} module.
- *
- * @remarks Note that dialogs were previously called "task modules". While they have been renamed for clarity, the functionality has been maintained.
- * For more details, see [Dialogs](https://learn.microsoft.com/microsoftteams/platform/task-modules-and-cards/what-are-task-modules)
- *
- * @beta
- */
 /**
  * Data Structure to represent the SDK response when dialog closes
  *

package/dist/esm/packages/teams-js/dts/public/dialog/update.d.ts

@@ -1,9 +1,10 @@
-import { DialogSize } from '../interfaces';
 /**
  * Module to update the dialog
  *
  * @beta
+ * @module
  */
+import { DialogSize } from '../interfaces';
 /**
  * Update dimensions - height/width of a dialog.
  *

package/dist/esm/packages/teams-js/dts/public/dialog/url/bot.d.ts

@@ -1,10 +1,11 @@
-import { BotUrlDialogInfo } from '../../interfaces';
-import { DialogSubmitHandler, PostMessageChannel } from '../dialog';
 /**
  * Module to open a dialog that sends results to the bot framework
  *
  * @beta
+ * @module
  */
+import { BotUrlDialogInfo } from '../../interfaces';
+import { DialogSubmitHandler, PostMessageChannel } from '../dialog';
 /**
  * Allows an app to open a dialog that sends submitted data to a bot.
  *

package/dist/esm/packages/teams-js/dts/public/dialog/url/parentCommunication.d.ts

@@ -1,4 +1,3 @@
-import { PostMessageChannel } from '../dialog';
 /**
  * Subcapability that allows communication between the dialog and the parent app.
  *
@@ -6,7 +5,9 @@ import { PostMessageChannel } from '../dialog';
  * Note that dialog can be invoked from parentless scenarios e.g. Search Message Extensions. The subcapability `parentCommunication` is not supported in such scenarios.
  *
  * @beta
+ * @module
  */
+import { PostMessageChannel } from '../dialog';
 /**
  *  Send message to the parent from dialog
  *