@microsoft/teams-js 2.0.0 → 2.1.0-beta.2

package/dist/MicrosoftTeams.js

@@ -1092,6 +1092,7 @@ __webpack_require__.d(__webpack_exports__, {
   "pages": () => (/* reexport */ pages),
   "people": () => (/* reexport */ people),
   "print": () => (/* reexport */ print),
+  "profile": () => (/* reexport */ profile),
   "registerAppButtonClickHandler": () => (/* reexport */ registerAppButtonClickHandler),
   "registerAppButtonHoverEnterHandler": () => (/* reexport */ registerAppButtonHoverEnterHandler),
   "registerAppButtonHoverLeaveHandler": () => (/* reexport */ registerAppButtonHoverLeaveHandler),
@@ -1121,7 +1122,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = "2.0.0";
+var version = "2.1.0-beta.2";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -2377,6 +2378,7 @@ var runtime = {
             fullTrust: undefined,
         },
         people: undefined,
+        profile: undefined,
         remoteCamera: undefined,
         sharing: undefined,
         teams: {
@@ -4786,7 +4788,7 @@ function createTeamsDeepLinkForAppInstallDialog(appId) {
     if (!appId) {
         throw new Error('App ID must be set when creating an app install dialog deep link');
     }
-    return teamsDeepLinkProtocol + "://" + teamsDeepLinkHost + teamsDeepLinkUrlPathForAppInstall + encodeURIComponent(appId) + "/";
+    return teamsDeepLinkProtocol + "://" + teamsDeepLinkHost + teamsDeepLinkUrlPathForAppInstall + encodeURIComponent(appId);
 }
 
 ;// CONCATENATED MODULE: ./src/public/appInstallDialog.ts
@@ -5687,6 +5689,19 @@ var location_location;
 
 var meeting;
 (function (meeting) {
+    /**
+     * Different types of meeting reactions that can be sent/received
+     *
+     * @beta
+     */
+    var MeetingReactionType;
+    (function (MeetingReactionType) {
+        MeetingReactionType["like"] = "like";
+        MeetingReactionType["heart"] = "heart";
+        MeetingReactionType["laugh"] = "laugh";
+        MeetingReactionType["surprised"] = "surprised";
+        MeetingReactionType["applause"] = "applause";
+    })(MeetingReactionType = meeting.MeetingReactionType || (meeting.MeetingReactionType = {}));
     var MeetingType;
     (function (MeetingType) {
         MeetingType["Unknown"] = "Unknown";
@@ -5917,6 +5932,40 @@ var meeting;
         registerHandler('meeting.speakingStateChanged', handler);
     }
     meeting.registerSpeakingStateChangeHandler = registerSpeakingStateChangeHandler;
+    /**
+     * Registers a handler for changes to the selfParticipant's (current user's) raiseHandState. If the selfParticipant raises their hand, isHandRaised
+     * will be true. By default and if the selfParticipant hand is lowered, isHandRaised will be false. This API will return {@link RaiseHandStateChangedEventData}
+     * that will have the raiseHandState or an error object. Only one handler can be registered at a time. A subsequent registration
+     * replaces an existing registration.
+     *
+     * @param handler The handler to invoke when the selfParticipant's (current user's) raiseHandState changes.
+     *
+     * @beta
+     */
+    function registerRaiseHandStateChangedHandler(handler) {
+        if (!handler) {
+            throw new Error('[registerRaiseHandStateChangedHandler] Handler cannot be null');
+        }
+        ensureInitialized(FrameContexts.sidePanel, FrameContexts.meetingStage);
+        registerHandler('meeting.raiseHandStateChanged', handler);
+    }
+    meeting.registerRaiseHandStateChangedHandler = registerRaiseHandStateChangedHandler;
+    /**
+     * Registers a handler for receiving meeting reactions. When the selfParticipant (current user) successfully sends a meeting reaction and it is being rendered on the UI, the meetingReactionType will be populated. Only one handler can be registered
+     * at a time. A subsequent registration replaces an existing registration.
+     *
+     * @param handler The handler to invoke when the selfParticipant (current user) successfully sends a meeting reaction
+     *
+     * @beta
+     */
+    function registerMeetingReactionReceivedHandler(handler) {
+        if (!handler) {
+            throw new Error('[registerMeetingReactionReceivedHandler] Handler cannot be null');
+        }
+        ensureInitialized(FrameContexts.sidePanel, FrameContexts.meetingStage);
+        registerHandler('meeting.meetingReactionReceived', handler);
+    }
+    meeting.registerMeetingReactionReceivedHandler = registerMeetingReactionReceivedHandler;
 })(meeting || (meeting = {}));
 
 ;// CONCATENATED MODULE: ./src/public/monetization.ts
@@ -6103,6 +6152,115 @@ var people;
     people_1.isSupported = isSupported;
 })(people || (people = {}));
 
+;// CONCATENATED MODULE: ./src/internal/profileUtil.ts
+/**
+ * @hidden
+ * Validates the request parameters
+ * @param showProfileRequest The request parameters
+ * @returns true if the parameters are valid, false otherwise
+ *
+ * @internal
+ */
+function validateShowProfileRequest(showProfileRequest) {
+    if (!showProfileRequest) {
+        return [false, 'A request object is required'];
+    }
+    // Validate modality
+    if (showProfileRequest.modality && typeof showProfileRequest.modality !== 'string') {
+        return [false, 'modality must be a string'];
+    }
+    // Validate targetElementBoundingRect
+    if (!showProfileRequest.targetElementBoundingRect ||
+        typeof showProfileRequest.targetElementBoundingRect !== 'object') {
+        return [false, 'targetElementBoundingRect must be a DOMRect'];
+    }
+    // Validate triggerType
+    if (!showProfileRequest.triggerType || typeof showProfileRequest.triggerType !== 'string') {
+        return [false, 'triggerType must be a valid string'];
+    }
+    return validatePersona(showProfileRequest.persona);
+}
+/**
+ * @hidden
+ * Validates the persona that is used to resolve the profile target
+ * @param persona The persona object
+ * @returns true if the persona is valid, false otherwise
+ *
+ * @internal
+ */
+function validatePersona(persona) {
+    if (!persona) {
+        return [false, 'persona object must be provided'];
+    }
+    if (persona.displayName && typeof persona.displayName !== 'string') {
+        return [false, 'displayName must be a string'];
+    }
+    if (!persona.identifiers || typeof persona.identifiers !== 'object') {
+        return [false, 'persona identifiers object must be provided'];
+    }
+    if (!persona.identifiers.AadObjectId && !persona.identifiers.Smtp && !persona.identifiers.Upn) {
+        return [false, 'at least one valid identifier must be provided'];
+    }
+    if (persona.identifiers.AadObjectId && typeof persona.identifiers.AadObjectId !== 'string') {
+        return [false, 'AadObjectId identifier must be a string'];
+    }
+    if (persona.identifiers.Smtp && typeof persona.identifiers.Smtp !== 'string') {
+        return [false, 'Smtp identifier must be a string'];
+    }
+    if (persona.identifiers.Upn && typeof persona.identifiers.Upn !== 'string') {
+        return [false, 'Upn identifier must be a string'];
+    }
+    return [true, undefined];
+}
+
+;// CONCATENATED MODULE: ./src/public/profile.ts
+
+
+
+
+
+
+/**
+ * Namespace for profile related APIs.
+ *
+ * @beta
+ */
+var profile;
+(function (profile) {
+    /**
+     * Opens a profile card at a specified position to show profile information about a persona.
+     * @param showProfileRequest The parameters to position the card and identify the target user.
+     * @returns Promise that will be fulfilled when the operation has completed
+     */
+    function showProfile(showProfileRequest) {
+        ensureInitialized(FrameContexts.content);
+        return new Promise(function (resolve) {
+            var _a = validateShowProfileRequest(showProfileRequest), isValid = _a[0], message = _a[1];
+            if (!isValid) {
+                throw { errorCode: ErrorCode.INVALID_ARGUMENTS, message: message };
+            }
+            // Convert the app provided parameters to the form suitable for postMessage.
+            var requestInternal = {
+                modality: showProfileRequest.modality,
+                persona: showProfileRequest.persona,
+                triggerType: showProfileRequest.triggerType,
+                targetRectangle: {
+                    x: showProfileRequest.targetElementBoundingRect.x,
+                    y: showProfileRequest.targetElementBoundingRect.y,
+                    width: showProfileRequest.targetElementBoundingRect.width,
+                    height: showProfileRequest.targetElementBoundingRect.height,
+                },
+            };
+            resolve(sendAndHandleSdkError('profile.showProfile', requestInternal));
+        });
+    }
+    profile.showProfile = showProfile;
+    function isSupported() {
+        return runtime.supports.profile ? true : false;
+    }
+    profile.isSupported = isSupported;
+})(profile || (profile = {}));
+
 ;// CONCATENATED MODULE: ./src/public/video.ts
 
 
@@ -6932,7 +7090,7 @@ var settings;
     settings.setValidityState = setValidityState;
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link pages.config.getConfig pages.config.getConfig(): Promise\<Config\>} instead.
+     * As of 2.0.0, please use {@link pages.getConfig pages.getConfig(): Promise\<InstanceConfig\>} instead.
      *
      * Gets the settings for the current instance.
      *
@@ -7028,9 +7186,8 @@ var tasks;
 (function (tasks) {
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link dialog.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel} for url based dialogs
-     * and {@link dialog.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel} for bot based dialogs.
-     *
+     * As of 2.0.0, please use {@link dialog.open dialog.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} for url based dialogs
+     * and {@link dialog.bot.open dialog.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} for bot based dialogs.
      * Allows an app to open the task module.
      *
      * @param taskInfo - An object containing the parameters of the task module
@@ -7074,7 +7231,7 @@ var tasks;
     tasks.updateTask = updateTask;
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link dialog.submit dialog.submit(result?: string | object, appIds?: string | string[]): void} instead.
+     * As of 2.0.0, please use {@link dialog.submit} instead.
      *
      * Submit the task module.
      *
@@ -7085,6 +7242,11 @@ var tasks;
         dialog.submit(result, appIds);
     }
     tasks.submitTask = submitTask;
+    /**
+     * Converts {@link TaskInfo} to {@link UrlDialogInfo}
+     * @param taskInfo - TaskInfo object to convert
+     * @returns - Converted UrlDialogInfo object
+     */
     function getUrlDialogInfoFromTaskInfo(taskInfo) {
         var urldialogInfo = {
             url: taskInfo.url,
@@ -7098,6 +7260,11 @@ var tasks;
         return urldialogInfo;
     }
     tasks.getUrlDialogInfoFromTaskInfo = getUrlDialogInfoFromTaskInfo;
+    /**
+     * Converts {@link TaskInfo} to {@link BotUrlDialogInfo}
+     * @param taskInfo - TaskInfo object to convert
+     * @returns - converted BotUrlDialogInfo object
+     */
     function getBotUrlDialogInfoFromTaskInfo(taskInfo) {
         var botUrldialogInfo = {
             url: taskInfo.url,
@@ -7112,6 +7279,12 @@ var tasks;
         return botUrldialogInfo;
     }
     tasks.getBotUrlDialogInfoFromTaskInfo = getBotUrlDialogInfoFromTaskInfo;
+    /**
+     * Sets the height and width of the {@link TaskInfo} object to the original height and width, if initially specified,
+     * otherwise uses the height and width values corresponding to {@link TaskModuleDimension.Small}
+     * @param taskInfo TaskInfo object from which to extract size info, if specified
+     * @returns TaskInfo with height and width specified
+     */
     function getDefaultSizeIfNotProvided(taskInfo) {
         taskInfo.height = taskInfo.height ? taskInfo.height : TaskModuleDimension.Small;
         taskInfo.width = taskInfo.width ? taskInfo.width : TaskModuleDimension.Small;
@@ -7146,6 +7319,7 @@ var tasks;
 
 
 
+
 
 
 
@@ -7153,6 +7327,7 @@ var tasks;
 
 
 
+
 /**
  * @hidden
  * Hide from docs
@@ -7227,6 +7402,18 @@ var files;
         FileDownloadStatus["Downloading"] = "Downloading";
         FileDownloadStatus["Failed"] = "Failed";
     })(FileDownloadStatus = files_1.FileDownloadStatus || (files_1.FileDownloadStatus = {}));
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Actions specific to 3P cloud storage provider file and / or account
+     */
+    var CloudStorageProviderFileAction;
+    (function (CloudStorageProviderFileAction) {
+        CloudStorageProviderFileAction["Download"] = "DOWNLOAD";
+        CloudStorageProviderFileAction["Upload"] = "UPLOAD";
+        CloudStorageProviderFileAction["Delete"] = "DELETE";
+    })(CloudStorageProviderFileAction = files_1.CloudStorageProviderFileAction || (files_1.CloudStorageProviderFileAction = {}));
     /**
      * @hidden
      * Hide from docs
@@ -7413,6 +7600,153 @@ var files;
         sendMessageToParent('files.openDownloadFolder', [fileObjectId], callback);
     }
     files_1.openDownloadFolder = openDownloadFolder;
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Initiates add 3P cloud storage provider flow, where a pop up window opens for user to select required
+     * 3P provider from the configured policy supported 3P provider list, following which user authentication
+     * for selected 3P provider is performed on success of which the selected 3P provider support is added for user
+     *
+     * @param callback Callback that will be triggered post add 3P cloud storage provider action
+     */
+    function addCloudStorageProvider(callback) {
+        ensureInitialized(FrameContexts.content);
+        if (!callback) {
+            throw getSdkError(ErrorCode.INVALID_ARGUMENTS, '[files.addCloudStorageProvider] callback cannot be null');
+        }
+        sendMessageToParent('files.addCloudStorageProvider', [], callback);
+    }
+    files_1.addCloudStorageProvider = addCloudStorageProvider;
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Initiates signout of 3P cloud storage provider flow, which will remove the selected
+     * 3P cloud storage provider from the list of added providers. No other user input and / or action
+     * is required except the 3P cloud storage provider to signout from
+     *
+     * @param logoutRequest 3P cloud storage provider remove action request content
+     * @param callback Callback that will be triggered post signout of 3P cloud storage provider action
+     */
+    function removeCloudStorageProvider(logoutRequest, callback) {
+        ensureInitialized(FrameContexts.content);
+        if (!callback) {
+            throw getSdkError(ErrorCode.INVALID_ARGUMENTS, '[files.removeCloudStorageProvider] callback cannot be null');
+        }
+        if (!(logoutRequest && logoutRequest.content)) {
+            throw getSdkError(ErrorCode.INVALID_ARGUMENTS, '[files.removeCloudStorageProvider] 3P cloud storage provider request content is missing');
+        }
+        sendMessageToParent('files.removeCloudStorageProvider', [logoutRequest], callback);
+    }
+    files_1.removeCloudStorageProvider = removeCloudStorageProvider;
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Initiates the add 3P cloud storage file flow, which will add a new file for the given 3P provider
+     *
+     * @param addNewFileRequest 3P cloud storage provider add action request content
+     * @param callback Callback that will be triggered post adding a new file flow is finished
+     */
+    function addCloudStorageProviderFile(addNewFileRequest, callback) {
+        ensureInitialized(FrameContexts.content);
+        if (!callback) {
+            throw getSdkError(ErrorCode.INVALID_ARGUMENTS, '[files.addCloudStorageProviderFile] callback cannot be null');
+        }
+        if (!(addNewFileRequest && addNewFileRequest.content)) {
+            throw getSdkError(ErrorCode.INVALID_ARGUMENTS, '[files.addCloudStorageProviderFile] 3P cloud storage provider request content is missing');
+        }
+        sendMessageToParent('files.addCloudStorageProviderFile', [addNewFileRequest], callback);
+    }
+    files_1.addCloudStorageProviderFile = addCloudStorageProviderFile;
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Initiates the rename 3P cloud storage file flow, which will rename an existing file in the given 3P provider
+     *
+     * @param renameFileRequest 3P cloud storage provider rename action request content
+     * @param callback Callback that will be triggered post renaming an existing file flow is finished
+     */
+    function renameCloudStorageProviderFile(renameFileRequest, callback) {
+        ensureInitialized(FrameContexts.content);
+        if (!callback) {
+            throw getSdkError(ErrorCode.INVALID_ARGUMENTS, '[files.renameCloudStorageProviderFile] callback cannot be null');
+        }
+        if (!(renameFileRequest && renameFileRequest.content)) {
+            throw getSdkError(ErrorCode.INVALID_ARGUMENTS, '[files.renameCloudStorageProviderFile] 3P cloud storage provider request content is missing');
+        }
+        sendMessageToParent('files.renameCloudStorageProviderFile', [renameFileRequest], callback);
+    }
+    files_1.renameCloudStorageProviderFile = renameCloudStorageProviderFile;
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Initiates the 3P cloud storage provider file action (Upload / Download / Delete) flow
+     *
+     * Upload Action : Allows uploading file(s) to the given 3P cloud storage provider
+     * Download Action : Allows downloading file(s) from the given 3P cloud storage provider
+     * Delete Action : Allows deleting file(s) from the given 3P cloud storage provider
+     *
+     * @param cloudStorageProviderFileActionRequest 3P cloud storage provider file action (Upload / Download / Delete) request content
+     * @param callback Callback that will be triggered post 3P cloud storage action
+     */
+    function performCloudStorageProviderFileAction(cloudStorageProviderFileActionRequest, callback) {
+        ensureInitialized(FrameContexts.content);
+        if (!callback) {
+            throw getSdkError(ErrorCode.INVALID_ARGUMENTS, '[files.performCloudStorageProviderFileAction] callback cannot be null');
+        }
+        if (!(cloudStorageProviderFileActionRequest && cloudStorageProviderFileActionRequest.content)) {
+            throw getSdkError(ErrorCode.INVALID_ARGUMENTS, '[files.performCloudStorageProviderFileAction] 3P cloud storage provider request content is missing');
+        }
+        sendMessageToParent('files.performCloudStorageProviderFileAction', [cloudStorageProviderFileActionRequest], callback);
+    }
+    files_1.performCloudStorageProviderFileAction = performCloudStorageProviderFileAction;
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Register a handler to be called when a user's 3P cloud storage provider list changes i.e.
+     * post adding / removing a 3P provider, list is updated
+     *
+     * @param handler - When 3P cloud storage provider list is updated this handler is called
+     *
+     */
+    function registerCloudStorageProviderListChangeHandler(handler) {
+        ensureInitialized();
+        if (!handler) {
+            throw new Error('[registerCloudStorageProviderListChangeHandler] Handler cannot be null');
+        }
+        registerHandler('files.cloudStorageProviderList', handler);
+    }
+    files_1.registerCloudStorageProviderListChangeHandler = registerCloudStorageProviderListChangeHandler;
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Register a handler to be called when a user's 3P cloud storage provider content changes i.e.
+     * when file(s) is/are added / renamed / deleted / uploaded, the list of files is updated
+     *
+     * @param handler - When 3P cloud storage provider content is updated this handler is called
+     *
+     */
+    function registerCloudStorageProviderContentChangeHandler(handler) {
+        ensureInitialized();
+        if (!handler) {
+            throw new Error('[registerCloudStorageProviderContentChangeHandler] Handler cannot be null');
+        }
+        registerHandler('files.cloudStorageProviderContent', handler);
+    }
+    files_1.registerCloudStorageProviderContentChangeHandler = registerCloudStorageProviderContentChangeHandler;
+    function getSdkError(errorCode, message) {
+        var sdkError = {
+            errorCode: errorCode,
+            message: message,
+        };
+        return sdkError;
+    }
 })(files || (files = {}));
 
 ;// CONCATENATED MODULE: ./src/private/meetingRoom.ts