@microsoft/teams-js 2.0.0-beta.1 → 2.0.0-beta.2-dev.3

package/dist/MicrosoftTeams.d.ts

@@ -23,8 +23,8 @@ declare module '@microsoft/teams-js/private/index' {
 
 declare module '@microsoft/teams-js/public/index' {
     export { authentication } from '@microsoft/teams-js/public/authentication';
-    export { FrameContexts, HostClientType, DialogDimension, TaskModuleDimension, TeamType, UserTeamRole, ChannelType, } from '@microsoft/teams-js/public/constants';
-    export { Context, DeepLinkParameters, ErrorCode, LoadContext, SdkError, TabInformation, TabInstance, TabInstanceParameters, DialogInfo, TeamInformation, FileOpenPreference, OpenConversationRequest, } from '@microsoft/teams-js/public/interfaces';
+    export { FrameContexts, HostClientType, DialogDimension, TaskModuleDimension, TeamType, UserTeamRole, ChannelType, HostName, } from '@microsoft/teams-js/public/constants';
+    export { Context, DeepLinkParameters, ErrorCode, LoadContext, SdkError, TabInformation, TabInstance, TabInstanceParameters, DialogInfo, TeamInformation, FileOpenPreference, OpenConversationRequest, LocaleInfo, FrameInfo, } from '@microsoft/teams-js/public/interfaces';
     export { app, core } from '@microsoft/teams-js/public/app';
     export { appInstallDialog } from '@microsoft/teams-js/public/appInstallDialog';
     export { dialog } from '@microsoft/teams-js/public/dialog';
@@ -862,7 +862,7 @@ declare module '@microsoft/teams-js/private/meetingRoom' {
                 * ------
                 * Data structure to represent a meeting room.
                 */
-            interface MeetingRoomInfo {
+            export interface MeetingRoomInfo {
                     /**
                         * @hidden
                         * Endpoint id of the meeting room.
@@ -888,82 +888,52 @@ declare module '@microsoft/teams-js/private/meetingRoom' {
                 * @hidden
                 * Hide from docs
                 * ------
-                * Enum used to indicate meeting room capabilities.
+                * Type of Media control capabilities of a meeting room.
                 */
-            enum Capability {
-                    /**
-                        * @hidden
-                        * Media control capability: toggle mute.
-                        */
-                    toggleMute = "toggleMute",
-                    /**
-                        * @hidden
-                        * Media control capability: toggle camera.
-                        */
-                    toggleCamera = "toggleCamera",
-                    /**
-                        * @hidden
-                        * Media control capability: toggle captions.
-                        */
-                    toggleCaptions = "toggleCaptions",
-                    /**
-                        * @hidden
-                        * Media control capability: volume ajustion.
-                        */
-                    volume = "volume",
-                    /**
-                        * @hidden
-                        * Stage layout control capability: show gallery mode.
-                        */
-                    showVideoGallery = "showVideoGallery",
-                    /**
-                        * @hidden
-                        * Stage layout control capability: show content mode.
-                        */
-                    showContent = "showContent",
-                    /**
-                        * @hidden
-                        * Stage layout control capability: show content + gallery mode.
-                        */
-                    showVideoGalleryAndContent = "showVideoGalleryAndContent",
-                    /**
-                        * @hidden
-                        * Stage layout control capability: show laryge gallery mode.
-                        */
-                    showLargeGallery = "showLargeGallery",
-                    /**
-                        * @hidden
-                        * Stage layout control capability: show together mode.
-                        */
-                    showTogether = "showTogether",
-                    /**
-                        * @hidden
-                        * Meeting control capability: leave meeting.
-                        */
-                    leaveMeeting = "leaveMeeting"
-            }
+            type MediaControls = 'toggleMute' | 'toggleCamera' | 'toggleCaptions' | 'volume';
+            /**
+                * @hidden
+                * Hide from docs
+                * ------
+                * Types of Stage Layout control capabilities of a meeting room.
+                */
+            type StageLayoutControls = 'showVideoGallery' | 'showContent' | 'showContent' | 'showVideoGalleryAndContent' | 'showLargeGallery' | 'showTogether';
+            /**
+                * @hidden
+                * Hide from docs
+                * ------
+                * Types of Meeting Control capabilities of a meeting room.
+                */
+            type MeetingControls = 'leaveMeeting';
+            /**
+                * @hidden
+                * Hide from docs
+                * ------
+                * Types of Stage Layout State of a meeting room.
+                */
+            type StageLayoutStates = 'Gallery' | 'Content + gallery' | 'Content' | 'Large gallery' | 'Together mode';
             /**
                 * @hidden
                 * Hide from docs
                 * ------
                 * Data structure to represent capabilities of a meeting room.
                 */
-            interface MeetingRoomCapability {
+            export interface MeetingRoomCapability {
                     /**
                         * @hidden
                         * Media control capabilities, value can be "toggleMute", "toggleCamera", "toggleCaptions", "volume".
                         */
-                    mediaControls: string[];
+                    mediaControls: MediaControls[];
                     /**
                         * @hidden
                         * Main stage layout control capabilities, value can be "showVideoGallery", "showContent", "showVideoGalleryAndContent", "showLargeGallery", "showTogether".
                         */
-                    stageLayoutControls: string[];
+                    stageLayoutControls: StageLayoutControls[];
                     /**
                         * @hidden
                         * Meeting control capabilities, value can be "leaveMeeting".
                         */
-                    meetingControls: string[];
+                    meetingControls: MeetingControls[];
             }
             /**
                 * @hidden
@@ -971,7 +941,7 @@ declare module '@microsoft/teams-js/private/meetingRoom' {
                 * ------
                 * Data structure to represent states of a meeting room.
                 */
-            interface MeetingRoomState {
+            export interface MeetingRoomState {
                     /**
                         * @hidden
                         * Current mute state, true: mute, false: unmute.
@@ -991,7 +961,7 @@ declare module '@microsoft/teams-js/private/meetingRoom' {
                         * @hidden
                         * Current main stage layout state, value can be one of "Gallery", "Content + gallery", "Content", "Large gallery" and "Together mode".
                         */
-                    stageLayout: string;
+                    stageLayout: StageLayoutStates;
                     /**
                         * @hidden
                         * Current leaveMeeting state, true: leave, false: no-op.
@@ -1006,7 +976,7 @@ declare module '@microsoft/teams-js/private/meetingRoom' {
                 *
                 * @returns Promise resolved with meeting room info or rejected with SdkError value
                 */
-            function getPairedMeetingRoomInfo(): Promise<MeetingRoomInfo>;
+            export function getPairedMeetingRoomInfo(): Promise<MeetingRoomInfo>;
             /**
                 * @hidden
                 * Hide from docs
@@ -1016,7 +986,7 @@ declare module '@microsoft/teams-js/private/meetingRoom' {
                 * @param commandName The command name.
                 * @returns Promise resolved upon completion or rejected with SdkError value
                 */
-            function sendCommandToPairedMeetingRoom(commandName: string): Promise<void>;
+            export function sendCommandToPairedMeetingRoom(commandName: string): Promise<void>;
             /**
                 * @hidden
                 * Hide from docs
@@ -1026,7 +996,7 @@ declare module '@microsoft/teams-js/private/meetingRoom' {
                 *
                 * @param handler The handler to invoke when the capabilities of meeting room update.
                 */
-            function registerMeetingRoomCapabilitiesUpdateHandler(handler: (capabilities: MeetingRoomCapability) => void): void;
+            export function registerMeetingRoomCapabilitiesUpdateHandler(handler: (capabilities: MeetingRoomCapability) => void): void;
             /**
                 * @hidden
                 * Hide from docs
@@ -1035,8 +1005,9 @@ declare module '@microsoft/teams-js/private/meetingRoom' {
                 *
                 * @param handler The handler to invoke when the states of meeting room update.
                 */
-            function registerMeetingRoomStatesUpdateHandler(handler: (states: MeetingRoomState) => void): void;
-            function isSupported(): boolean;
+            export function registerMeetingRoomStatesUpdateHandler(handler: (states: MeetingRoomState) => void): void;
+            export function isSupported(): boolean;
+            export {};
     }
 }
 
@@ -1407,7 +1378,7 @@ declare module '@microsoft/teams-js/public/authentication' {
         * @beta
         */
     export namespace authentication {
-            export function initialize(): void;
+            function initialize(): void;
             /**
                 * @deprecated with Teams JS v2 upgrades
                 *
@@ -1415,7 +1386,7 @@ declare module '@microsoft/teams-js/public/authentication' {
                 *
                 * @param authenticateParameters - A set of values that configure the authentication pop-up.
                 */
-            export function registerAuthenticationHandlers(authenticateParameters: AuthenticateParameters): void;
+            function registerAuthenticationHandlers(authenticateParameters: AuthenticateParameters): void;
             /**
                 * @deprecated with Teams JS v2 upgrades
                 *
@@ -1424,7 +1395,7 @@ declare module '@microsoft/teams-js/public/authentication' {
                 * @param authenticateParameters - The parameters for the authentication request.
                 *
                 */
-            export function authenticate(authenticateParameters?: AuthenticateParameters): void;
+            function authenticate(authenticateParameters?: AuthenticateParameters): void;
             /**
                 * Initiates an authentication request, which opens a new window with the specified settings.
                 *
@@ -1435,7 +1406,7 @@ declare module '@microsoft/teams-js/public/authentication' {
                 * @throws if the authentication request fails or is canceled by the user.
                 *
                 */
-            export function authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise<string>;
+            function authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise<string>;
             /**
                 * @deprecated with Teams JS v2 upgrades
                 *
@@ -1445,7 +1416,7 @@ declare module '@microsoft/teams-js/public/authentication' {
                 * @param authTokenRequest - A set of values that configure the token request.
                 * It contains callbacks to call in case of success/failure
                 */
-            export function getAuthToken(authTokenRequest: AuthTokenRequest): void;
+            function getAuthToken(authTokenRequest: AuthTokenRequest): void;
             /**
                 * Requests an Azure AD token to be issued on behalf of the app. The token is acquired from the cache
                 * if it is not expired. Otherwise a request is sent to Azure AD to obtain a new token.
@@ -1454,7 +1425,7 @@ declare module '@microsoft/teams-js/public/authentication' {
                 *
                 * @returns Promise that will be fulfilled with the token if successful.
                 */
-            export function getAuthToken(authTokenRequest: AuthTokenRequestParameters): Promise<string>;
+            function getAuthToken(authTokenRequest: AuthTokenRequestParameters): Promise<string>;
             /**
                 * @hidden
                 * Hide from docs.
@@ -1465,7 +1436,7 @@ declare module '@microsoft/teams-js/public/authentication' {
                 *
                 * @internal
                 */
-            export function getUser(): Promise<UserProfile>;
+            function getUser(): Promise<UserProfile>;
             /**
                 * @deprecated with Teams JS v2 upgrades
                 *
@@ -1477,7 +1448,7 @@ declare module '@microsoft/teams-js/public/authentication' {
                 * @param userRequest - It passes success/failure callbacks in the userRequest object(deprecated)
                 * @internal
                 */
-            export function getUser(userRequest: UserRequest): void;
+            function getUser(userRequest: UserRequest): void;
             /**
                 * Notifies the frame that initiated this authentication request that the request was successful.
                 *
@@ -1488,7 +1459,7 @@ declare module '@microsoft/teams-js/public/authentication' {
                 * @param result - Specifies a result for the authentication. If specified, the frame that initiated the authentication pop-up receives this value in its callback.
                 * @param callbackUrl - Specifies the url to redirect back to if the client is Win32 Outlook.
                 */
-            export function notifySuccess(result?: string, callbackUrl?: string): void;
+            function notifySuccess(result?: string, callbackUrl?: string): void;
             /**
                 * Notifies the frame that initiated this authentication request that the request failed.
                 *
@@ -1499,7 +1470,7 @@ declare module '@microsoft/teams-js/public/authentication' {
                 * @param result - Specifies a result for the authentication. If specified, the frame that initiated the authentication pop-up receives this value in its callback.
                 * @param callbackUrl - Specifies the url to redirect back to if the client is Win32 Outlook.
                 */
-            export function notifyFailure(reason?: string, callbackUrl?: string): void;
+            function notifyFailure(reason?: string, callbackUrl?: string): void;
             /**
                 * @deprecated with TeamsJS v2 upgrades
                 */
@@ -1515,7 +1486,7 @@ declare module '@microsoft/teams-js/public/authentication' {
                         */
                     failureCallback?: (reason: string) => void;
             }
-            export interface AuthenticatePopUpParameters {
+            interface AuthenticatePopUpParameters {
                     /**
                         * The URL for the authentication pop-up.
                         */
@@ -1532,8 +1503,8 @@ declare module '@microsoft/teams-js/public/authentication' {
             /**
                 * @deprecated with TeamsJS v2 upgrades
                 */
-            export type AuthenticateParameters = AuthenticatePopUpParameters & LegacyCallBacks;
-            export interface AuthTokenRequestParameters {
+            type AuthenticateParameters = AuthenticatePopUpParameters & LegacyCallBacks;
+            interface AuthTokenRequestParameters {
                     /**
                         * An optional list of resource for which to acquire the access token; only used for full trust apps.
                         */
@@ -1550,7 +1521,7 @@ declare module '@microsoft/teams-js/public/authentication' {
             /**
                 * @deprecated with TeamsJS v2 upgrades
                 */
-            export type AuthTokenRequest = AuthTokenRequestParameters & LegacyCallBacks;
+            type AuthTokenRequest = AuthTokenRequestParameters & LegacyCallBacks;
             /**
                 * @hidden
                 * Hide from docs.
@@ -1558,7 +1529,7 @@ declare module '@microsoft/teams-js/public/authentication' {
                 *
                 * @internal
                 */
-            export interface UserProfile {
+            interface UserProfile {
                     /**
                         * @hidden
                         * The intended recipient of the token. The application that receives the token must verify that the audience
@@ -1653,7 +1624,7 @@ declare module '@microsoft/teams-js/public/authentication' {
                 * ------
                 * @internal
                 */
-            export interface UserRequest {
+            interface UserRequest {
                     /**
                         * A function that is called if the token request succeeds, with the resulting token.
                         */
@@ -1663,7 +1634,6 @@ declare module '@microsoft/teams-js/public/authentication' {
                         */
                     failureCallback?: (reason: string) => void;
             }
-            export {};
     }
 }
 
@@ -4160,7 +4130,7 @@ declare module '@microsoft/teams-js/public/video' {
             /**
                 * Represents a video frame.
                 */
-            export interface VideoFrame {
+            interface VideoFrame {
                     /**
                         * Video frame width.
                         */
@@ -4189,13 +4159,13 @@ declare module '@microsoft/teams-js/public/video' {
             /**
                 * Video frame format enum, currently only support NV12
                 */
-            export enum VideoFrameFormat {
+            enum VideoFrameFormat {
                     NV12 = 0
             }
             /**
                 * Video frame configuration supplied to Teams to customize the generated video frame parameters, like format.
                 */
-            export interface VideoFrameConfig {
+            interface VideoFrameConfig {
                     /**
                         * video format
                         */
@@ -4204,7 +4174,7 @@ declare module '@microsoft/teams-js/public/video' {
             /**
                 *  Video effect change type enum
                 */
-            export enum EffectChangeType {
+            enum EffectChangeType {
                     /**
                         * current video effect changed.
                         */
@@ -4225,7 +4195,7 @@ declare module '@microsoft/teams-js/public/video' {
             /**
                 * register to read the video frames in Permissions section.
                 */
-            export function registerForVideoFrame(frameCallback: VideoFrameCallback, config: VideoFrameConfig): void;
+            function registerForVideoFrame(frameCallback: VideoFrameCallback, config: VideoFrameConfig): void;
             /**
                 * video extension should call this to notify Teams Client current selected effect parameter changed.
                 * If it's pre-meeting, Teams client will call videoEffectCallback immediately then use the videoEffect.
@@ -4234,13 +4204,12 @@ declare module '@microsoft/teams-js/public/video' {
                 * @param effectChangeType - the effect change type.
                 * @param effectId - Newly selected effect id.
                 */
-            export function notifySelectedVideoEffectChanged(effectChangeType: EffectChangeType, effectId: string | undefined): void;
+            function notifySelectedVideoEffectChanged(effectChangeType: EffectChangeType, effectId: string | undefined): void;
             /**
                 * Register the video effect callback, Teams client uses this to notify the video extension the new video effect will by applied.
                 */
-            export function registerForVideoEffect(callback: VideoEffectCallBack): void;
-            export function isSupported(): boolean;
-            export {};
+            function registerForVideoEffect(callback: VideoEffectCallBack): void;
+            function isSupported(): boolean;
     }
 }
 
@@ -4740,8 +4709,8 @@ declare module '@microsoft/teams-js/public/tasks' {
 
 declare module '@microsoft/teams-js/public' {
     export { authentication } from '@microsoft/teams-js/public/authentication';
-    export { FrameContexts, HostClientType, DialogDimension, TaskModuleDimension, TeamType, UserTeamRole, ChannelType, } from '@microsoft/teams-js/public/constants';
-    export { Context, DeepLinkParameters, ErrorCode, LoadContext, SdkError, TabInformation, TabInstance, TabInstanceParameters, DialogInfo, TeamInformation, FileOpenPreference, OpenConversationRequest, } from '@microsoft/teams-js/public/interfaces';
+    export { FrameContexts, HostClientType, DialogDimension, TaskModuleDimension, TeamType, UserTeamRole, ChannelType, HostName, } from '@microsoft/teams-js/public/constants';
+    export { Context, DeepLinkParameters, ErrorCode, LoadContext, SdkError, TabInformation, TabInstance, TabInstanceParameters, DialogInfo, TeamInformation, FileOpenPreference, OpenConversationRequest, LocaleInfo, FrameInfo, } from '@microsoft/teams-js/public/interfaces';
     export { app, core } from '@microsoft/teams-js/public/app';
     export { appInstallDialog } from '@microsoft/teams-js/public/appInstallDialog';
     export { dialog } from '@microsoft/teams-js/public/dialog';

package/dist/MicrosoftTeams.js

@@ -324,6 +324,7 @@ __webpack_require__.d(__webpack_exports__, {
   "FileOpenPreference": () => (/* reexport */ FileOpenPreference),
   "FrameContexts": () => (/* reexport */ FrameContexts),
   "HostClientType": () => (/* reexport */ HostClientType),
+  "HostName": () => (/* reexport */ HostName),
   "NotificationTypes": () => (/* reexport */ NotificationTypes),
   "ParentAppWindow": () => (/* reexport */ ParentAppWindow),
   "TaskModuleDimension": () => (/* reexport */ TaskModuleDimension),
@@ -394,7 +395,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = '2.0.0-beta.1';
+var version = '2.0.0-beta.2-dev.3';
 /**
  * @hidden
  * The SDK version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -802,7 +803,8 @@ function ensureInitialized() {
             }
         }
         if (!found) {
-            throw new Error("This call is not allowed in the '" + GlobalVars.frameContext + "' context");
+            throw new Error("This call is only allowed in following contexts: " + JSON.stringify(expectedFrameContexts) + ". " +
+                ("Current context: \"" + GlobalVars.frameContext + "\"."));
         }
     }
 }
@@ -5578,65 +5580,6 @@ var legacy;
  */
 var meetingRoom;
 (function (meetingRoom) {
-    /**
-     * @hidden
-     * Hide from docs
-     * ------
-     * Enum used to indicate meeting room capabilities.
-     */
-    var Capability;
-    (function (Capability) {
-        /**
-         * @hidden
-         * Media control capability: toggle mute.
-         */
-        Capability["toggleMute"] = "toggleMute";
-        /**
-         * @hidden
-         * Media control capability: toggle camera.
-         */
-        Capability["toggleCamera"] = "toggleCamera";
-        /**
-         * @hidden
-         * Media control capability: toggle captions.
-         */
-        Capability["toggleCaptions"] = "toggleCaptions";
-        /**
-         * @hidden
-         * Media control capability: volume ajustion.
-         */
-        Capability["volume"] = "volume";
-        /**
-         * @hidden
-         * Stage layout control capability: show gallery mode.
-         */
-        Capability["showVideoGallery"] = "showVideoGallery";
-        /**
-         * @hidden
-         * Stage layout control capability: show content mode.
-         */
-        Capability["showContent"] = "showContent";
-        /**
-         * @hidden
-         * Stage layout control capability: show content + gallery mode.
-         */
-        Capability["showVideoGalleryAndContent"] = "showVideoGalleryAndContent";
-        /**
-         * @hidden
-         * Stage layout control capability: show laryge gallery mode.
-         */
-        Capability["showLargeGallery"] = "showLargeGallery";
-        /**
-         * @hidden
-         * Stage layout control capability: show together mode.
-         */
-        Capability["showTogether"] = "showTogether";
-        /**
-         * @hidden
-         * Meeting control capability: leave meeting.
-         */
-        Capability["leaveMeeting"] = "leaveMeeting";
-    })(Capability = meetingRoom.Capability || (meetingRoom.Capability = {}));
     /**
      * @hidden
      * Hide from docs