@microsoft/teams-js 2.12.0-beta.1 → 2.12.1-beta.0

package/README.md

@@ -24,7 +24,7 @@ To install the stable [version](https://learn.microsoft.com/javascript/api/overv
 
 ### Production
 
-You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.11.0/js/MicrosoftTeams.min.js) or point your package manager at them.
+You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.12.0/js/MicrosoftTeams.min.js) or point your package manager at them.
 
 ## Usage
 
@@ -45,13 +45,13 @@ Reference the library inside of your `.html` page using:
 ```html
 <!-- Microsoft Teams JavaScript API (via CDN) -->
 <script
-  src="https://res.cdn.office.net/teams-js/2.11.0/js/MicrosoftTeams.min.js"
-  integrity="sha384-eCh6qbZkXfEZapUgP+aGo0x6qEpGiryOoYXrQr6BLrtZ988BjkbaVyRh1rQef3q9"
+  src="https://res.cdn.office.net/teams-js/2.12.0/js/MicrosoftTeams.min.js"
+  integrity="sha384-H8/uiTqHq6b1eqm04U0wlhoD92qH4Ibgxrj4QLh8F5iomB4eqTdvi5dzPZkyKNxz"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.11.0/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.12.0/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

package/dist/MicrosoftTeams.d.ts

@@ -7311,6 +7311,12 @@ export namespace search {
             * @beta
             */
         function isSupported(): boolean;
+        /**
+            * Clear the host M365 application's search box
+            *
+            * @beta
+            */
+        function closeSearch(): Promise<void>;
 }
 
 /**
@@ -7517,7 +7523,10 @@ export namespace 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: StartCallParams): Promise<boolean>;
         /**

package/dist/MicrosoftTeams.js

@@ -1059,6 +1059,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 +2090,7 @@ var _minRuntimeConfigToUninitialize = {
  * @hidden
  *  Package version.
  */
-var version = "2.12.0-beta.1";
+var version = "2.12.1-beta.0";
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -4853,8 +4855,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 +4871,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);
         }
     });
@@ -8411,6 +8413,21 @@ var search;
         return ensureInitialized(runtime) && runtime.supports.search ? true : false;
     }
     search.isSupported = isSupported;
+    /**
+     * Clear the host M365 application's search box
+     *
+     * @beta
+     */
+    function closeSearch() {
+        return new Promise(function (resolve) {
+            ensureInitialized(runtime, FrameContexts.content);
+            if (!isSupported()) {
+                throw new Error('Not supported');
+            }
+            resolve(sendAndHandleStatusAndReason('search.closeSearch'));
+        });
+    }
+    search.closeSearch = closeSearch;
 })(search || (search = {}));
 
 ;// CONCATENATED MODULE: ./src/public/sharing.ts
@@ -8632,7 +8649,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) {
@@ -8642,7 +8662,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);