@microsoft/teams-js 2.17.1-beta.0 → 2.17.1-beta.2

package/dist/MicrosoftTeams.d.ts

@@ -4447,7 +4447,8 @@ interface OpenChatRequest {
     */
 export interface OpenSingleChatRequest extends OpenChatRequest {
         /**
-            * The Microsoft Entra UPN (e-mail address) of the user to chat with
+            * The [Microsoft Entra UPNs](https://learn.microsoft.com/en-us/entra/identity/hybrid/connect/plan-connect-userprincipalname) (usually but not always an e-mail address)
+            * of the user with whom to begin a chat
             */
         user: string;
 }
@@ -4460,7 +4461,8 @@ export interface OpenSingleChatRequest extends OpenChatRequest {
     */
 export interface OpenGroupChatRequest extends OpenChatRequest {
         /**
-            * Array containing Microsoft Entra UPNs (e-mail addresss) of users to open chat with
+            * Array containing [Microsoft Entra UPNs](https://learn.microsoft.com/en-us/entra/identity/hybrid/connect/plan-connect-userprincipalname) (usually but not always an e-mail address)
+            * of users with whom to begin a chat
             */
         users: string[];
         /**

package/dist/MicrosoftTeams.js

@@ -958,6 +958,14 @@ var ApiName;
     ApiName["App_OpenLink"] = "app.openLink";
     ApiName["App_RegisterOnThemeChangeHandler"] = "app.registerOnThemeChangeHandler";
     ApiName["AppEntity_SelectAppEntity"] = "appEntity.selectAppEntity";
+    ApiName["BarCode_HasPermission"] = "barCode.hasPermission";
+    ApiName["BarCode_RequestPermission"] = "barCode.requestPermission";
+    ApiName["BarCode_ScanBarCode"] = "barCode.scanBarCode";
+    ApiName["Calendar_ComposeMeeting"] = "calendar.composeMeeting";
+    ApiName["Calendar_OpenCalendarItem"] = "calendar.openCalendarItem";
+    ApiName["Call_StartCall"] = "call.startCall";
+    ApiName["Clipboard_Read"] = "clipboard.read";
+    ApiName["Clipboard_Write"] = "clipboard.write";
     ApiName["Dialog_AdaptiveCard_Bot_Open"] = "dialog.adaptiveCard.bot.open";
     ApiName["Dialog_AdaptiveCard_Open"] = "dialog.adaptiveCard.open";
     ApiName["Dialog_Update_Resize"] = "dialog.update.resize";
@@ -973,6 +981,20 @@ var ApiName;
     ApiName["GeoLocation_ShowLocation"] = "geoLocation.showLocation";
     ApiName["Location_GetLocation"] = "location.getLocation";
     ApiName["Location_ShowLocation"] = "location.showLocation";
+    ApiName["Mail_ComposeMail"] = "mail.composeMail";
+    ApiName["Mail_OpenMailItem"] = "mail.openMailItem";
+    ApiName["Marketplace_AddOrUpdateCartItems"] = "marketplace.addOrUpdateCartItems";
+    ApiName["Marketplace_GetCart"] = "marketplace.getCart";
+    ApiName["Marketplace_RemoveCardItems"] = "marketplace.removeCartItems";
+    ApiName["Marketplace_UpdateCartStatus"] = "marketplace.updateCartStatus";
+    ApiName["Media_CaptureImage"] = "media.captureImage";
+    ApiName["Media_Controller"] = "media.controller";
+    ApiName["Media_GetMedia"] = "media.getMedia";
+    ApiName["Media_HasPermission"] = "media.hasPermission";
+    ApiName["Media_RequestPermission"] = "media.requestPermission";
+    ApiName["Media_ScanBarCode"] = "media.scanBarCode";
+    ApiName["Media_SelectMedia"] = "media.selectMedia";
+    ApiName["Media_ViewImages"] = "media.viewImages";
     ApiName["Navigation_NavigateBack"] = "navigation.navigateBack";
     ApiName["Navigation_NavigateCrossDomain"] = "navigation.navigateCrossDomain";
     ApiName["Navigation_NavigateToTab"] = "navigation.navigateToTab";
@@ -1170,6 +1192,7 @@ var validOrigins = [
     'teams.cloud.microsoft',
     'outlook.cloud.microsoft',
     'm365.cloud.microsoft',
+    'copilot.microsoft.com',
 ];
 /**
  * @hidden
@@ -2405,7 +2428,7 @@ var _minRuntimeConfigToUninitialize = {
  * @hidden
  *  Package version.
  */
-var version = "2.17.1-beta.0";
+var version = "2.17.1-beta.2";
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -6301,6 +6324,10 @@ var __extends = (undefined && undefined.__extends) || (function () {
 
 
 
+/**
+ * v1 APIs telemetry file: All of APIs in this capability file should send out API version v1 ONLY
+ */
+var mediaTelemetryVersionNumber = ApiVersionNumber.V_1;
 var mediaLogger = getLogger('media');
 /**
  * Interact with media, including capturing and viewing images.
@@ -6353,7 +6380,7 @@ var media;
             callback(oldPlatformError, []);
             return;
         }
-        sendMessageToParent('captureImage', callback);
+        communication_sendMessageToParentWithVersion(getApiVersionTag(mediaTelemetryVersionNumber, ApiName.Media_CaptureImage), 'captureImage', callback);
     }
     media.captureImage = captureImage;
     /**
@@ -6371,7 +6398,7 @@ var media;
         }
         var permissions = DevicePermission.Media;
         return new Promise(function (resolve) {
-            resolve(sendAndHandleSdkError('permissions.has', permissions));
+            resolve(sendAndHandleSdkErrorWithVersion(getApiVersionTag(mediaTelemetryVersionNumber, ApiName.Media_HasPermission), 'permissions.has', permissions));
         });
     }
     media.hasPermission = hasPermission;
@@ -6390,7 +6417,7 @@ var media;
         }
         var permissions = DevicePermission.Media;
         return new Promise(function (resolve) {
-            resolve(sendAndHandleSdkError('permissions.request', permissions));
+            resolve(sendAndHandleSdkErrorWithVersion(getApiVersionTag(mediaTelemetryVersionNumber, ApiName.Media_RequestPermission), 'permissions.request', permissions));
         });
     }
     media.requestPermission = requestPermission;
@@ -6485,7 +6512,7 @@ var media;
                     }
                 }
             }
-            sendMessageToParent('getMedia', localUriId, handleGetMediaCallbackRequest);
+            communication_sendMessageToParentWithVersion(getApiVersionTag(mediaTelemetryVersionNumber, ApiName.Media_GetMedia), 'getMedia', localUriId, handleGetMediaCallbackRequest);
         };
         /** Function to retrieve media content, such as images or videos, via handler. */
         Media.prototype.getMediaViaHandler = function (callback) {
@@ -6495,7 +6522,9 @@ var media;
                 assembleAttachment: [],
             };
             var params = [actionName, this.content];
-            this.content && !isNullOrUndefined(callback) && sendMessageToParent('getMedia', params);
+            this.content &&
+                !isNullOrUndefined(callback) &&
+                communication_sendMessageToParentWithVersion(getApiVersionTag(mediaTelemetryVersionNumber, ApiName.Media_GetMedia), 'getMedia', params);
             function handleGetMediaRequest(response) {
                 if (callback) {
                     /* eslint-disable-next-line strict-null-checks/all */ /* Fix tracked by 5730662 */
@@ -6563,7 +6592,7 @@ var media;
                 return;
             }
             var params = { mediaType: this.getMediaType(), mediaControllerEvent: mediaEvent };
-            sendMessageToParent('media.controller', [params], function (err) {
+            communication_sendMessageToParentWithVersion(getApiVersionTag(mediaTelemetryVersionNumber, ApiName.Media_Controller), 'media.controller', [params], function (err) {
                 if (callback) {
                     callback(err);
                 }
@@ -6706,7 +6735,7 @@ var media;
         }
         var params = [mediaInputs];
         // What comes back from native as attachments would just be objects and will be missing getMedia method on them
-        sendMessageToParent('selectMedia', params, function (err, localAttachments, mediaEvent) {
+        communication_sendMessageToParentWithVersion(getApiVersionTag(mediaTelemetryVersionNumber, ApiName.Media_SelectMedia), 'selectMedia', params, function (err, localAttachments, mediaEvent) {
             var _a, _b;
             // MediaControllerEvent response is used to notify the app about events and is a partial response to selectMedia
             if (mediaEvent) {
@@ -6751,7 +6780,7 @@ var media;
             return;
         }
         var params = [uriList];
-        sendMessageToParent('viewImages', params, callback);
+        communication_sendMessageToParentWithVersion(getApiVersionTag(mediaTelemetryVersionNumber, ApiName.Media_ViewImages), 'viewImages', params, callback);
     }
     media.viewImages = viewImages;
     /**
@@ -6792,7 +6821,7 @@ var media;
             callback(invalidInput, '');
             return;
         }
-        sendMessageToParent('media.scanBarCode', [config], callback);
+        communication_sendMessageToParentWithVersion(getApiVersionTag(mediaTelemetryVersionNumber, ApiName.Media_ScanBarCode), 'media.scanBarCode', [config], callback);
     }
     media.scanBarCode = scanBarCode;
 })(media || (media = {}));
@@ -7021,6 +7050,11 @@ function validatePeoplePickerInput(peoplePickerInputs) {
 
 
 
+
+/**
+ * v2 APIs telemetry file: All of APIs in this capability file should send out API version v2 ONLY
+ */
+var barCodeTelemetryVersionNumber = ApiVersionNumber.V_2;
 /**
  * Namespace to interact with the barcode scanning-specific part of the SDK.
  *
@@ -7046,7 +7080,7 @@ var barCode;
             if (!validateScanBarCodeInput(barCodeConfig)) {
                 throw { errorCode: ErrorCode.INVALID_ARGUMENTS };
             }
-            resolve(sendAndHandleSdkError('media.scanBarCode', barCodeConfig));
+            resolve(sendAndHandleSdkErrorWithVersion(getApiVersionTag(barCodeTelemetryVersionNumber, ApiName.BarCode_ScanBarCode), 'media.scanBarCode', barCodeConfig));
         });
     }
     barCode.scanBarCode = scanBarCode;
@@ -7064,7 +7098,7 @@ var barCode;
         }
         var permissions = DevicePermission.Media;
         return new Promise(function (resolve) {
-            resolve(sendAndHandleSdkError('permissions.has', permissions));
+            resolve(sendAndHandleSdkErrorWithVersion(getApiVersionTag(barCodeTelemetryVersionNumber, ApiName.BarCode_HasPermission), 'permissions.has', permissions));
         });
     }
     barCode.hasPermission = hasPermission;
@@ -7082,7 +7116,7 @@ var barCode;
         }
         var permissions = DevicePermission.Media;
         return new Promise(function (resolve) {
-            resolve(sendAndHandleSdkError('permissions.request', permissions));
+            resolve(sendAndHandleSdkErrorWithVersion(getApiVersionTag(barCodeTelemetryVersionNumber, ApiName.BarCode_RequestPermission), 'permissions.request', permissions));
         });
     }
     barCode.requestPermission = requestPermission;
@@ -7134,7 +7168,7 @@ var chat;
             }
             else {
                 var sendPromise = sendAndHandleStatusAndReason('chat.openChat', {
-                    members: openChatRequest.user,
+                    members: [openChatRequest.user],
                     message: openChatRequest.message,
                 });
                 resolve(sendPromise);
@@ -7163,7 +7197,7 @@ var chat;
                     user: openChatRequest.users[0],
                     message: openChatRequest.message,
                 };
-                openChat(chatRequest);
+                resolve(openChat(chatRequest));
             }
             else {
                 internalAPIs_ensureInitialized(runtime_runtime, FrameContexts.content, FrameContexts.task);
@@ -7243,6 +7277,11 @@ var __generator = (undefined && undefined.__generator) || function (thisArg, bod
 
 
 
+
+/**
+ * v2 APIs telemetry file: All of APIs in this capability file should send out API version v2 ONLY
+ */
+var clipboardTelemetryVersionNumber = ApiVersionNumber.V_2;
 /**
  * Interact with the system clipboard
  *
@@ -7281,7 +7320,7 @@ var clipboard;
                             mimeType: blob.type,
                             content: base64StringContent,
                         };
-                        return [2 /*return*/, sendAndHandleSdkError('clipboard.writeToClipboard', writeParams)];
+                        return [2 /*return*/, sendAndHandleSdkErrorWithVersion(getApiVersionTag(clipboardTelemetryVersionNumber, ApiName.Clipboard_Write), 'clipboard.writeToClipboard', writeParams)];
                 }
             });
         });
@@ -7310,7 +7349,7 @@ var clipboard;
                     case 1:
                         response = _b.apply(_a, [_c.sent()]);
                         return [2 /*return*/, base64ToBlob(response.mimeType, response.content)];
-                    case 2: return [2 /*return*/, sendAndHandleSdkError('clipboard.readFromClipboard')];
+                    case 2: return [2 /*return*/, sendAndHandleSdkErrorWithVersion(getApiVersionTag(clipboardTelemetryVersionNumber, ApiName.Clipboard_Read), 'clipboard.readFromClipboard')];
                 }
             });
         });
@@ -8428,6 +8467,11 @@ var monetization;
 
 
 
+
+/**
+ * v2 APIs telemetry file: All of APIs in this capability file should send out API version v2 ONLY
+ */
+var calendarTelemetryVersionNumber = ApiVersionNumber.V_2;
 /**
  * Interact with the user's calendar, including opening calendar items and composing meetings.
  */
@@ -8447,7 +8491,7 @@ var calendar;
             if (!openCalendarItemParams.itemId || !openCalendarItemParams.itemId.trim()) {
                 throw new Error('Must supply an itemId to openCalendarItem');
             }
-            resolve(sendAndHandleStatusAndReason('calendar.openCalendarItem', openCalendarItemParams));
+            resolve(sendAndHandleStatusAndReasonWithVersion(getApiVersionTag(calendarTelemetryVersionNumber, ApiName.Calendar_OpenCalendarItem), 'calendar.openCalendarItem', openCalendarItemParams));
         });
     }
     calendar.openCalendarItem = openCalendarItem;
@@ -8466,7 +8510,7 @@ var calendar;
                 resolve(sendAndHandleStatusAndReason('executeDeepLink', createTeamsDeepLinkForCalendar(composeMeetingParams.attendees, composeMeetingParams.startTime, composeMeetingParams.endTime, composeMeetingParams.subject, composeMeetingParams.content)));
             }
             else {
-                resolve(sendAndHandleStatusAndReason('calendar.composeMeeting', composeMeetingParams));
+                resolve(sendAndHandleStatusAndReasonWithVersion(getApiVersionTag(calendarTelemetryVersionNumber, ApiName.Calendar_ComposeMeeting), 'calendar.composeMeeting', composeMeetingParams));
             }
         });
     }
@@ -8488,6 +8532,11 @@ var calendar;
 
 
 
+
+/**
+ * v2 APIs telemetry file: All of APIs in this capability file should send out API version v2 ONLY
+ */
+var mailTelemetryVersionNumber = ApiVersionNumber.V_2;
 /**
  * Used to interact with mail capability, including opening and composing mail.
  */
@@ -8507,7 +8556,7 @@ var mail;
             if (!openMailItemParams.itemId || !openMailItemParams.itemId.trim()) {
                 throw new Error('Must supply an itemId to openMailItem');
             }
-            resolve(sendAndHandleStatusAndReason('mail.openMailItem', openMailItemParams));
+            resolve(sendAndHandleStatusAndReasonWithVersion(getApiVersionTag(mailTelemetryVersionNumber, ApiName.Mail_OpenMailItem), 'mail.openMailItem', openMailItemParams));
         });
     }
     mail.openMailItem = openMailItem;
@@ -8523,7 +8572,7 @@ var mail;
             if (!isSupported()) {
                 throw new Error('Not supported');
             }
-            resolve(sendAndHandleStatusAndReason('mail.composeMail', composeMailParams));
+            resolve(sendAndHandleStatusAndReasonWithVersion(getApiVersionTag(mailTelemetryVersionNumber, ApiName.Mail_ComposeMail), 'mail.composeMail', composeMailParams));
         });
     }
     mail.composeMail = composeMail;
@@ -10499,6 +10548,11 @@ var webStorage;
 
 
 
+
+/**
+ * v2 APIs telemetry file: All of APIs in this capability file should send out API version v2 ONLY
+ */
+var callTelemetryVersionNumber = ApiVersionNumber.V_2;
 /**
  * Used to interact with call functionality, including starting calls with other users.
  */
@@ -10528,6 +10582,7 @@ var call;
      * @returns always true if the host notifies of a successful call inititation
      */
     function startCall(startCallParams) {
+        var apiVersionTag = getApiVersionTag(callTelemetryVersionNumber, ApiName.Call_StartCall);
         return new Promise(function (resolve) {
             var _a;
             internalAPIs_ensureInitialized(runtime_runtime, FrameContexts.content, FrameContexts.task);
@@ -10535,7 +10590,7 @@ var call;
                 throw errorNotSupportedOnPlatform;
             }
             if (runtime_runtime.isLegacyTeams) {
-                resolve(sendAndUnwrap('executeDeepLink', createTeamsDeepLinkForCall(startCallParams.targets, (_a = startCallParams.requestedModalities) === null || _a === void 0 ? void 0 : _a.includes(CallModalities.Video), startCallParams.source)).then(function (result) {
+                resolve(sendAndUnwrapWithVersion(apiVersionTag, '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);
                     }
@@ -10543,7 +10598,7 @@ var call;
                 }));
             }
             else {
-                return sendMessageToParent('call.startCall', [startCallParams], resolve);
+                return communication_sendMessageToParentWithVersion(apiVersionTag, 'call.startCall', [startCallParams], resolve);
             }
         });
     }
@@ -11709,6 +11764,11 @@ var marketplace_assign = (undefined && undefined.__assign) || function () {
 
 
 
+
+/**
+ * v2 APIs telemetry file: All of APIs in this capability file should send out API version v2 ONLY
+ */
+var marketplaceTelemetryVersionNumber = ApiVersionNumber.V_2;
 /**
  * @hidden
  * Namespace for an app to support a checkout flow by interacting with the marketplace cart in the host.
@@ -11807,7 +11867,7 @@ var marketplace;
         if (!isSupported()) {
             throw errorNotSupportedOnPlatform;
         }
-        return sendAndHandleSdkError('marketplace.getCart', marketplace.cartVersion).then(deserializeCart);
+        return sendAndHandleSdkErrorWithVersion(getApiVersionTag(marketplaceTelemetryVersionNumber, ApiName.Marketplace_GetCart), 'marketplace.getCart', marketplace.cartVersion).then(deserializeCart);
     }
     marketplace.getCart = getCart;
     /**
@@ -11827,7 +11887,7 @@ var marketplace;
         }
         validateUuid(addOrUpdateCartItemsParams === null || addOrUpdateCartItemsParams === void 0 ? void 0 : addOrUpdateCartItemsParams.cartId);
         validateCartItems(addOrUpdateCartItemsParams === null || addOrUpdateCartItemsParams === void 0 ? void 0 : addOrUpdateCartItemsParams.cartItems);
-        return sendAndHandleSdkError('marketplace.addOrUpdateCartItems', marketplace_assign(marketplace_assign({}, addOrUpdateCartItemsParams), { cartItems: serializeCartItems(addOrUpdateCartItemsParams.cartItems), cartVersion: marketplace.cartVersion })).then(deserializeCart);
+        return sendAndHandleSdkErrorWithVersion(getApiVersionTag(marketplaceTelemetryVersionNumber, ApiName.Marketplace_AddOrUpdateCartItems), 'marketplace.addOrUpdateCartItems', marketplace_assign(marketplace_assign({}, addOrUpdateCartItemsParams), { cartItems: serializeCartItems(addOrUpdateCartItemsParams.cartItems), cartVersion: marketplace.cartVersion })).then(deserializeCart);
     }
     marketplace.addOrUpdateCartItems = addOrUpdateCartItems;
     /**
@@ -11849,7 +11909,7 @@ var marketplace;
         if (!Array.isArray(removeCartItemsParams === null || removeCartItemsParams === void 0 ? void 0 : removeCartItemsParams.cartItemIds) || (removeCartItemsParams === null || removeCartItemsParams === void 0 ? void 0 : removeCartItemsParams.cartItemIds.length) === 0) {
             throw new Error('cartItemIds must be a non-empty array');
         }
-        return sendAndHandleSdkError('marketplace.removeCartItems', marketplace_assign(marketplace_assign({}, removeCartItemsParams), { cartVersion: marketplace.cartVersion })).then(deserializeCart);
+        return sendAndHandleSdkErrorWithVersion(getApiVersionTag(marketplaceTelemetryVersionNumber, ApiName.Marketplace_RemoveCardItems), 'marketplace.removeCartItems', marketplace_assign(marketplace_assign({}, removeCartItemsParams), { cartVersion: marketplace.cartVersion })).then(deserializeCart);
     }
     marketplace.removeCartItems = removeCartItems;
     /**
@@ -11869,7 +11929,7 @@ var marketplace;
         }
         validateUuid(updateCartStatusParams === null || updateCartStatusParams === void 0 ? void 0 : updateCartStatusParams.cartId);
         validateCartStatus(updateCartStatusParams === null || updateCartStatusParams === void 0 ? void 0 : updateCartStatusParams.cartStatus);
-        return sendAndHandleSdkError('marketplace.updateCartStatus', marketplace_assign(marketplace_assign({}, updateCartStatusParams), { cartVersion: marketplace.cartVersion })).then(deserializeCart);
+        return sendAndHandleSdkErrorWithVersion(getApiVersionTag(marketplaceTelemetryVersionNumber, ApiName.Marketplace_UpdateCartStatus), 'marketplace.updateCartStatus', marketplace_assign(marketplace_assign({}, updateCartStatusParams), { cartVersion: marketplace.cartVersion })).then(deserializeCart);
     }
     marketplace.updateCartStatus = updateCartStatus;
     /**