@microsoft/teams-js 2.12.0 → 2.13.0-beta.0

package/dist/MicrosoftTeams.js

@@ -805,7 +805,6 @@ __webpack_require__.d(__webpack_exports__, {
   "ActionObjectType": () => (/* reexport */ ActionObjectType),
   "ChannelType": () => (/* reexport */ ChannelType),
   "ChildAppWindow": () => (/* reexport */ ChildAppWindow),
-  "ContainerState": () => (/* reexport */ ContainerState),
   "DialogDimension": () => (/* reexport */ DialogDimension),
   "ErrorCode": () => (/* reexport */ ErrorCode),
   "FileOpenPreference": () => (/* reexport */ FileOpenPreference),
@@ -818,7 +817,6 @@ __webpack_require__.d(__webpack_exports__, {
   "SecondaryM365ContentIdName": () => (/* reexport */ SecondaryM365ContentIdName),
   "TaskModuleDimension": () => (/* reexport */ TaskModuleDimension),
   "TeamType": () => (/* reexport */ TeamType),
-  "UserMeetingRole": () => (/* reexport */ UserMeetingRole),
   "UserSettingTypes": () => (/* reexport */ UserSettingTypes),
   "UserTeamRole": () => (/* reexport */ UserTeamRole),
   "ViewerActionTypes": () => (/* reexport */ ViewerActionTypes),
@@ -843,7 +841,7 @@ __webpack_require__.d(__webpack_exports__, {
   "getTabInstances": () => (/* reexport */ getTabInstances),
   "initialize": () => (/* reexport */ initialize),
   "initializeWithFrameContext": () => (/* reexport */ initializeWithFrameContext),
-  "isSupported": () => (/* reexport */ isSupported),
+  "liveShare": () => (/* reexport */ liveShare),
   "location": () => (/* reexport */ location_location),
   "logs": () => (/* reexport */ logs),
   "mail": () => (/* reexport */ mail),
@@ -1059,6 +1057,8 @@ var errorLibraryNotInitialized = 'The library has not yet been initialized';
 var errorRuntimeNotInitialized = 'The runtime has not yet been initialized';
 /** @hidden */
 var errorRuntimeNotSupported = 'The runtime version is not supported';
+/** @hidden */
+var errorCallNotStarted = 'The call was not properly started';
 
 ;// CONCATENATED MODULE: ./src/internal/globalVars.ts
 var GlobalVars = /** @class */ (function () {
@@ -2088,7 +2088,7 @@ var _minRuntimeConfigToUninitialize = {
  * @hidden
  *  Package version.
  */
-var version = "2.12.0";
+var version = "2.13.0-beta.0";
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -4853,8 +4853,8 @@ function sendAndHandleStatusAndReason(actionName) {
         args[_i - 1] = arguments[_i];
     }
     return sendMessageToParentAsync(actionName, args).then(function (_a) {
-        var status = _a[0], reason = _a[1];
-        if (!status) {
+        var wasSuccessful = _a[0], reason = _a[1];
+        if (!wasSuccessful) {
             throw new Error(reason);
         }
     });
@@ -4869,8 +4869,8 @@ function sendAndHandleStatusAndReasonWithDefaultError(actionName, defaultError)
         args[_i - 2] = arguments[_i];
     }
     return sendMessageToParentAsync(actionName, args).then(function (_a) {
-        var status = _a[0], reason = _a[1];
-        if (!status) {
+        var wasSuccessful = _a[0], reason = _a[1];
+        if (!wasSuccessful) {
             throw new Error(reason ? reason : defaultError);
         }
     });
@@ -8647,7 +8647,10 @@ var call;
      * Starts a call with other users
      *
      * @param startCallParams - Parameters for the call
-     * @returns If the call is accepted
+     *
+     * @throws Error if call capability is not supported
+     * @throws Error if host notifies of a failed start call attempt in a legacy Teams environment
+     * @returns always true if the host notifies of a successful call inititation
      */
     function startCall(startCallParams) {
         return new Promise(function (resolve) {
@@ -8657,7 +8660,12 @@ var call;
                 throw errorNotSupportedOnPlatform;
             }
             if (runtime.isLegacyTeams) {
-                resolve(sendAndHandleSdkError('executeDeepLink', createTeamsDeepLinkForCall(startCallParams.targets, (_a = startCallParams.requestedModalities) === null || _a === void 0 ? void 0 : _a.includes(CallModalities.Video), startCallParams.source)));
+                resolve(sendAndUnwrap('executeDeepLink', createTeamsDeepLinkForCall(startCallParams.targets, (_a = startCallParams.requestedModalities) === null || _a === void 0 ? void 0 : _a.includes(CallModalities.Video), startCallParams.source)).then(function (result) {
+                    if (!result) {
+                        throw new Error(errorCallNotStarted);
+                    }
+                    return result;
+                }));
             }
             else {
                 return sendMessageToParent('call.startCall', [startCallParams], resolve);
@@ -9357,51 +9365,88 @@ var tasks;
 
 
 /**
- * @hidden
- * Allowed roles during a meeting.
- *
- * @beta
- */
-var UserMeetingRole;
-(function (UserMeetingRole) {
-    UserMeetingRole["guest"] = "Guest";
-    UserMeetingRole["attendee"] = "Attendee";
-    UserMeetingRole["presenter"] = "Presenter";
-    UserMeetingRole["organizer"] = "Organizer";
-})(UserMeetingRole || (UserMeetingRole = {}));
-/**
- * @hidden
- * State of the current Live Share sessions backing fluid container.
+ * APIs involving Live Share, a framework for building real-time collaborative apps.
+ * For more information, visit https://aka.ms/teamsliveshare
  *
- * @beta
+ * @see LiveShareHost
  */
-var ContainerState;
-(function (ContainerState) {
-    /**
-     * The call to `LiveShareHost.setContainerId()` successfully created the container mapping
-     * for the current Live Share session.
-     */
-    ContainerState["added"] = "Added";
+var liveShare;
+(function (liveShare) {
     /**
-     * A container mapping for the current Live Share Session already exists and should be used
-     * when joining the sessions Fluid container.
+     * @hidden
+     * The meeting roles of a user.
+     * Used in Live Share for its role verification feature.
+     * For more information, visit https://learn.microsoft.com/microsoftteams/platform/apps-in-teams-meetings/teams-live-share-capabilities?tabs=javascript#role-verification-for-live-data-structures
      */
-    ContainerState["alreadyExists"] = "AlreadyExists";
+    var UserMeetingRole;
+    (function (UserMeetingRole) {
+        /**
+         * Guest role.
+         */
+        UserMeetingRole["guest"] = "Guest";
+        /**
+         * Attendee role.
+         */
+        UserMeetingRole["attendee"] = "Attendee";
+        /**
+         * Presenter role.
+         */
+        UserMeetingRole["presenter"] = "Presenter";
+        /**
+         * Organizer role.
+         */
+        UserMeetingRole["organizer"] = "Organizer";
+    })(UserMeetingRole = liveShare.UserMeetingRole || (liveShare.UserMeetingRole = {}));
     /**
-     * The call to `LiveShareHost.setContainerId()` failed to create the container mapping due to
-     * another client having already set the container ID for the current Live Share session.
+     * @hidden
+     * State of the current Live Share session's Fluid container.
+     * This is used internally by the `LiveShareClient` when joining a Live Share session.
      */
-    ContainerState["conflict"] = "Conflict";
+    var ContainerState;
+    (function (ContainerState) {
+        /**
+         * The call to `LiveShareHost.setContainerId()` successfully created the container mapping
+         * for the current Live Share session.
+         */
+        ContainerState["added"] = "Added";
+        /**
+         * A container mapping for the current Live Share session already exists.
+         * This indicates to Live Share that a new container does not need be created.
+         */
+        ContainerState["alreadyExists"] = "AlreadyExists";
+        /**
+         * The call to `LiveShareHost.setContainerId()` failed to create the container mapping.
+         * This happens when another client has already set the container ID for the session.
+         */
+        ContainerState["conflict"] = "Conflict";
+        /**
+         * A container mapping for the current Live Share session does not yet exist.
+         * This indicates to Live Share that a new container should be created.
+         */
+        ContainerState["notFound"] = "NotFound";
+    })(ContainerState = liveShare.ContainerState || (liveShare.ContainerState = {}));
     /**
-     * A container mapping for the current Live Share session doesn't exist yet.
+     * Checks if the interactive capability is supported by the host
+     * @returns boolean to represent whether the interactive capability is supported
+     *
+     * @throws Error if {@linkcode app.initialize} has not successfully completed
      */
-    ContainerState["notFound"] = "NotFound";
-})(ContainerState || (ContainerState = {}));
+    function isSupported() {
+        return ensureInitialized(runtime, FrameContexts.meetingStage, FrameContexts.sidePanel) &&
+            runtime.supports.interactive
+            ? true
+            : false;
+    }
+    liveShare.isSupported = isSupported;
+})(liveShare || (liveShare = {}));
 /**
- * @hidden
- * Live Share host implementation for O365 and Teams clients.
+ * Live Share host implementation for connecting to real-time collaborative sessions.
+ * Designed for use with the `LiveShareClient` class in the `@microsoft/live-share` package.
+ * Learn more at https://aka.ms/teamsliveshare
  *
- * @beta
+ * @remarks
+ * The `LiveShareClient` class from Live Share uses the hidden API's to join/manage the session.
+ * To create a new `LiveShareHost` instance use the static `LiveShareHost.create()` function.
  */
 var LiveShareHost = /** @class */ (function () {
     function LiveShareHost() {
@@ -9409,8 +9454,6 @@ var LiveShareHost = /** @class */ (function () {
     /**
      * @hidden
      * Returns the Fluid Tenant connection info for user's current context.
-     *
-     * @beta
      */
     LiveShareHost.prototype.getFluidTenantInfo = function () {
         ensureSupported();
@@ -9424,8 +9467,6 @@ var LiveShareHost = /** @class */ (function () {
      *
      * @param containerId Fluid's container Id for the request. Undefined for new containers.
      * @returns token for connecting to Fluid's session.
-     *
-     * @beta
      */
     LiveShareHost.prototype.getFluidToken = function (containerId) {
         ensureSupported();
@@ -9437,8 +9478,6 @@ var LiveShareHost = /** @class */ (function () {
     /**
      * @hidden
      * Returns the ID of the fluid container associated with the user's current context.
-     *
-     * @beta
      */
     LiveShareHost.prototype.getFluidContainerId = function () {
         ensureSupported();
@@ -9455,8 +9494,6 @@ var LiveShareHost = /** @class */ (function () {
      * `getFluidContainerId()` to get the ID of the container being used.
      * @param containerId ID of the fluid container the client created.
      * @returns A data structure with a `containerState` indicating the success or failure of the request.
-     *
-     * @beta
      */
     LiveShareHost.prototype.setFluidContainerId = function (containerId) {
         ensureSupported();
@@ -9467,8 +9504,6 @@ var LiveShareHost = /** @class */ (function () {
     /**
      * @hidden
      * Returns the shared clock server's current time.
-     *
-     * @beta
      */
     LiveShareHost.prototype.getNtpTime = function () {
         ensureSupported();
@@ -9482,8 +9517,6 @@ var LiveShareHost = /** @class */ (function () {
      *
      * @param clientId The ID for the current user's Fluid client. Changes on reconnects.
      * @returns The roles for the current user.
-     *
-     * @beta
      */
     LiveShareHost.prototype.registerClientId = function (clientId) {
         ensureSupported();
@@ -9497,8 +9530,6 @@ var LiveShareHost = /** @class */ (function () {
      *
      * @param clientId The Client ID the message was received from.
      * @returns The roles for a given client. Returns `undefined` if the client ID hasn't been registered yet.
-     *
-     * @beta
      */
     LiveShareHost.prototype.getClientRoles = function (clientId) {
         ensureSupported();
@@ -9512,8 +9543,6 @@ var LiveShareHost = /** @class */ (function () {
      *
      * @param clientId The Client ID the message was received from.
      * @returns The info for a given client. Returns `undefined` if the client ID hasn't been registered yet.
-     *
-     * @beta
      */
     LiveShareHost.prototype.getClientInfo = function (clientId) {
         ensureSupported();
@@ -9522,12 +9551,12 @@ var LiveShareHost = /** @class */ (function () {
         });
     };
     /**
-     * Returns a host instance for the client that can be passed to the `LiveShareClient` class.
+     * Factories a new `LiveShareHost` instance for use with the `LiveShareClient` class
+     * in the `@microsoft/live-share` package.
      *
      * @remarks
-     * The application must first be initialized and may only be called from `meetingStage` or `sidePanel` contexts.
-     *
-     * @beta
+     * `app.initialize()` must first be called before using this API.
+     * This API can only be called from `meetingStage` or `sidePanel` contexts.
      */
     LiveShareHost.create = function () {
         ensureSupported();
@@ -9536,24 +9565,8 @@ var LiveShareHost = /** @class */ (function () {
     return LiveShareHost;
 }());
 
-/**
- * @hidden
- *
- * Checks if the interactive capability is supported by the host
- * @returns boolean to represent whether the interactive capability is supported
- *
- * @throws Error if {@linkcode app.initialize} has not successfully completed
- *
- * @internal
- * Limited to Microsoft-internal use
- */
-function isSupported() {
-    return ensureInitialized(runtime, FrameContexts.meetingStage, FrameContexts.sidePanel) && runtime.supports.interactive
-        ? true
-        : false;
-}
 function ensureSupported() {
-    if (!isSupported()) {
+    if (!liveShare.isSupported()) {
         throw new Error('LiveShareHost Not supported');
     }
 }