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

package/dist/MicrosoftTeams.js

@@ -824,12 +824,12 @@ __webpack_require__.d(__webpack_exports__, {
   "appEntity": () => (/* reexport */ appEntity),
   "appInitialization": () => (/* reexport */ appInitialization),
   "appInstallDialog": () => (/* reexport */ appInstallDialog),
-  "appNotification": () => (/* reexport */ appNotification),
   "authentication": () => (/* reexport */ authentication),
   "barCode": () => (/* reexport */ barCode),
   "calendar": () => (/* reexport */ calendar),
   "call": () => (/* reexport */ call),
   "chat": () => (/* reexport */ chat),
+  "clipboard": () => (/* reexport */ clipboard),
   "conversations": () => (/* reexport */ conversations),
   "dialog": () => (/* reexport */ dialog),
   "enablePrintCapability": () => (/* reexport */ enablePrintCapability),
@@ -1288,6 +1288,16 @@ var DevicePermission;
     DevicePermission["GeoLocation"] = "geolocation";
     DevicePermission["Media"] = "media";
 })(DevicePermission || (DevicePermission = {}));
+/**
+ * Currently supported Mime type
+ */
+var ClipboardSupportedMimeType;
+(function (ClipboardSupportedMimeType) {
+    ClipboardSupportedMimeType["TextPlain"] = "text/plain";
+    ClipboardSupportedMimeType["TextHtml"] = "text/html";
+    ClipboardSupportedMimeType["ImagePNG"] = "image/png";
+    ClipboardSupportedMimeType["ImageJPEG"] = "image/jpeg";
+})(ClipboardSupportedMimeType || (ClipboardSupportedMimeType = {}));
 
 ;// CONCATENATED MODULE: ./src/public/constants.ts
 /** HostClientType represents the different client platforms on which host can be run. */
@@ -1303,6 +1313,8 @@ var HostClientType;
     HostClientType["ios"] = "ios";
     /** Represents the iPadOS client of host, which runs on iOS devices such as iPads. */
     HostClientType["ipados"] = "ipados";
+    /** The host is running on a macOS client, which runs on devices such as MacBooks. */
+    HostClientType["macos"] = "macos";
     /**
      * @deprecated
      * As of 2.0.0, please use {@link teamsRoomsWindows} instead.
@@ -1810,6 +1822,64 @@ function isHostAdaptiveCardSchemaVersionUnsupported(hostAdaptiveCardSchemaVersio
 function isValidHttpsURL(url) {
     return url.protocol === 'https:';
 }
+/**
+ * Convert base64 string to blob
+ * @param base64Data string respresenting the content
+ * @param contentType Mimetype
+ * @returns Promise
+ */
+function base64ToBlob(mimeType, base64String) {
+    return new Promise(function (resolve, reject) {
+        if (!mimeType) {
+            reject('MimeType cannot be null or empty.');
+        }
+        if (!base64String) {
+            reject('Base64 string cannot be null or empty.');
+        }
+        var byteCharacters = atob(base64String);
+        /**
+         * For images we need to convert binary data to image to achieve that:
+         *   1. A new Uint8Array is created with a length equal to the length of byteCharacters.
+         *      The byteCharacters is a string representing the base64 data decoded using atob.
+         *   2. Then loop iterates over each character in the byteCharacters string and assigns the
+         *      corresponding character code to the corresponding index in the byteArray. The purpose
+         *      of this loop is to convert the base64 string to a binary representation, as the Blob
+         *      constructor expects binary data.
+         */
+        if (mimeType.startsWith('image/')) {
+            var byteArray = new Uint8Array(byteCharacters.length);
+            for (var i = 0; i < byteCharacters.length; i++) {
+                byteArray[i] = byteCharacters.charCodeAt(i);
+            }
+            resolve(new Blob([byteArray], { type: mimeType }));
+        }
+        resolve(new Blob([byteCharacters], { type: mimeType }));
+    });
+}
+/**
+ * Converts blob to base64 string.
+ * @param blob Blob to convert to base64 string.
+ */
+function getBase64StringFromBlob(blob) {
+    return new Promise(function (resolve, reject) {
+        if (blob.size === 0) {
+            reject(new Error('Blob cannot be empty.'));
+        }
+        var reader = new FileReader();
+        reader.onloadend = function () {
+            if (reader.result) {
+                resolve(reader.result.toString().split(',')[1]);
+            }
+            else {
+                reject(new Error('Failed to read the blob'));
+            }
+        };
+        reader.onerror = function () {
+            reject(reader.error);
+        };
+        reader.readAsDataURL(blob);
+    });
+}
 
 ;// CONCATENATED MODULE: ./src/public/runtime.ts
 /* eslint-disable @typescript-eslint/ban-types */
@@ -1824,13 +1894,24 @@ var __assign = (undefined && undefined.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+var __rest = (undefined && undefined.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 
 
 
 
 
 var runtimeLogger = getLogger('runtime');
-var latestRuntimeApiVersion = 2;
+var latestRuntimeApiVersion = 3;
 function isLatestRuntimeVersion(runtime) {
     return runtime.apiVersion === latestRuntimeApiVersion;
 }
@@ -1862,7 +1943,7 @@ function isRuntimeInitialized(runtime) {
 }
 var runtime = _uninitializedRuntime;
 var teamsRuntimeConfig = {
-    apiVersion: 2,
+    apiVersion: 3,
     hostVersionsInfo: teamsMinAdaptiveCardVersion,
     isLegacyTeams: true,
     supports: {
@@ -1951,7 +2032,6 @@ function fastForwardRuntime(outdatedRuntime) {
  * Limited to Microsoft-internal use
  */
 var upgradeChain = [
-    // This upgrade has been included for testing, it may be removed when there is a real upgrade implemented
     {
         versionToUpgradeFrom: 1,
         upgradeToNextVersion: function (previousVersionRuntime) {
@@ -1970,6 +2050,14 @@ var upgradeChain = [
             };
         },
     },
+    {
+        versionToUpgradeFrom: 2,
+        upgradeToNextVersion: function (previousVersionRuntime) {
+            /* eslint-disable-next-line @typescript-eslint/no-unused-vars */ /* Intentionally assigned to unused variable to delete propery when destructuring */
+            var _a = previousVersionRuntime.supports, _ = _a.appNotification, newSupports = __rest(_a, ["appNotification"]);
+            return __assign(__assign({}, previousVersionRuntime), { apiVersion: 3, supports: newSupports });
+        },
+    },
 ];
 var versionConstants = {
     '1.9.0': [
@@ -2039,7 +2127,7 @@ function generateBackCompatRuntimeConfig(highestSupportedVersion) {
         }
     });
     var backCompatRuntimeConfig = {
-        apiVersion: 2,
+        apiVersion: latestRuntimeApiVersion,
         hostVersionsInfo: teamsMinAdaptiveCardVersion,
         isLegacyTeams: true,
         supports: newSupports,
@@ -2071,7 +2159,7 @@ function setUnitializedRuntime() {
  * Limited to Microsoft-internal use
  */
 var _minRuntimeConfigToUninitialize = {
-    apiVersion: 2,
+    apiVersion: latestRuntimeApiVersion,
     supports: {
         pages: {
             appButton: {},
@@ -2090,7 +2178,7 @@ var _minRuntimeConfigToUninitialize = {
  * @hidden
  *  Package version.
  */
-var version = "2.15.0-beta.0";
+var version = "2.15.0-beta.2";
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -2317,11 +2405,13 @@ var authentication;
                 GlobalVars.hostClientType === HostClientType.android ||
                 GlobalVars.hostClientType === HostClientType.ios ||
                 GlobalVars.hostClientType === HostClientType.ipados ||
+                GlobalVars.hostClientType === HostClientType.macos ||
                 GlobalVars.hostClientType === HostClientType.rigel ||
                 GlobalVars.hostClientType === HostClientType.teamsRoomsWindows ||
                 GlobalVars.hostClientType === HostClientType.teamsRoomsAndroid ||
                 GlobalVars.hostClientType === HostClientType.teamsPhones ||
-                GlobalVars.hostClientType === HostClientType.teamsDisplays) {
+                GlobalVars.hostClientType === HostClientType.teamsDisplays ||
+                GlobalVars.hostClientType === HostClientType.surfaceHub) {
                 // Convert any relative URLs into absolute URLs before sending them over to the parent window.
                 var link = document.createElement('a');
                 link.href = authenticateParameters.url;
@@ -3954,7 +4044,7 @@ var pages;
     pages.navigateToApp = navigateToApp;
     /**
      * Shares a deep link that a user can use to navigate back to a specific state in this page.
-     * Please note that this method does yet work on mobile hosts.
+     * Please note that this method does not yet work on mobile hosts.
      *
      * @param deepLinkParameters - ID and label for the link and fallback URL.
      */
@@ -5710,135 +5800,6 @@ var appInstallDialog;
     appInstallDialog.isSupported = isSupported;
 })(appInstallDialog || (appInstallDialog = {}));
 
-;// CONCATENATED MODULE: ./src/public/appNotification.ts
-
-
-
-
-/**
- * Namespace to interact with the appNotification specific part of the SDK
- * @beta
- */
-var appNotification;
-(function (appNotification) {
-    /**
-     * @internal
-     *
-     * @hidden
-     *
-     * @beta
-     *
-     * This converts the notifcationActionUrl from a URL type to a string type for proper flow across the iframe
-     * @param notificationDisplayParam - appNotification display parameter with the notificationActionUrl as a URL type
-     * @returns a serialized object that can be sent to the host SDK
-     */
-    function serializeParam(notificationDisplayParam) {
-        var _a;
-        return {
-            title: notificationDisplayParam.title,
-            content: notificationDisplayParam.content,
-            notificationIconAsString: (_a = notificationDisplayParam.icon) === null || _a === void 0 ? void 0 : _a.href,
-            displayDurationInSeconds: notificationDisplayParam.displayDurationInSeconds,
-            notificationActionUrlAsString: notificationDisplayParam.notificationActionUrl.href,
-        };
-    }
-    /**
-     * Checks the valididty of the URL passed
-     *
-     * @param url
-     * @returns True if a valid url was passed
-     *
-     * @beta
-     */
-    function isValidUrl(url) {
-        var validProtocols = ['https:'];
-        return validProtocols.includes(url.protocol);
-    }
-    /**
-     * Validates that the input string is of property length
-     *
-     * @param inputString and maximumLength
-     * @returns True if string length is within specified limit
-     *
-     * @beta
-     */
-    function isValidLength(inputString, maxLength) {
-        return inputString.length <= maxLength;
-    }
-    /**
-     * Validates that all the required appNotification display parameters are either supplied or satisfy the required checks
-     * @param notificationDisplayParam
-     * @throws Error if any of the required parameters aren't supplied
-     * @throws Error if content or title length is beyond specific limit
-     * @throws Error if invalid url is passed
-     * @returns void
-     *
-     * @beta
-     */
-    function validateNotificationDisplayParams(notificationDisplayParam) {
-        var maxTitleLength = 75;
-        var maxContentLength = 1500;
-        if (!notificationDisplayParam.title) {
-            throw new Error('Must supply notification title');
-        }
-        if (!isValidLength(notificationDisplayParam.title, maxTitleLength)) {
-            throw new Error("Invalid notification title length: Maximum title length ".concat(maxTitleLength, ", title length supplied ").concat(notificationDisplayParam.title.length));
-        }
-        if (!notificationDisplayParam.content) {
-            throw new Error('Must supply notification content');
-        }
-        if (!isValidLength(notificationDisplayParam.content, maxContentLength)) {
-            throw new Error("Invalid notification content length: Maximum content length ".concat(maxContentLength, ", content length supplied ").concat(notificationDisplayParam.content.length));
-        }
-        if (!notificationDisplayParam.notificationActionUrl) {
-            throw new Error('Must supply notification url');
-        }
-        if (!isValidUrl(notificationDisplayParam.notificationActionUrl)) {
-            throw new Error('Invalid notificationAction url');
-        }
-        if ((notificationDisplayParam === null || notificationDisplayParam === void 0 ? void 0 : notificationDisplayParam.icon) !== undefined && !isValidUrl(notificationDisplayParam === null || notificationDisplayParam === void 0 ? void 0 : notificationDisplayParam.icon)) {
-            throw new Error('Invalid icon url');
-        }
-        if (!notificationDisplayParam.displayDurationInSeconds) {
-            throw new Error('Must supply notification display duration in seconds');
-        }
-        if (notificationDisplayParam.displayDurationInSeconds < 0) {
-            throw new Error('Notification display time must be greater than zero');
-        }
-    }
-    /**
-     * Displays appNotification after making a validiity check on all of the required parameters, by calling the validateNotificationDisplayParams helper function
-     * An interface object containing all the required parameters to be displayed on the notification would be passed in here
-     * The notificationDisplayParam would be serialized before passing across to the message handler to ensure all objects passed contain simple parameters that would properly pass across the Iframe
-     * @param notificationdisplayparam - Interface object with all the parameters required to display an appNotificiation
-     * @returns a promise resolution upon conclusion
-     * @throws Error if appNotification capability is not supported
-     * @throws Error if notficationDisplayParam was not validated successfully
-     *
-     * @beta
-     */
-    function displayInAppNotification(notificationDisplayParam) {
-        ensureInitialized(runtime, FrameContexts.content, FrameContexts.stage, FrameContexts.sidePanel, FrameContexts.meetingStage);
-        if (!isSupported()) {
-            throw errorNotSupportedOnPlatform;
-        }
-        validateNotificationDisplayParams(notificationDisplayParam);
-        return sendAndHandleSdkError('appNotification.displayInAppNotification', serializeParam(notificationDisplayParam));
-    }
-    appNotification.displayInAppNotification = displayInAppNotification;
-    /**
-     * Checks if appNotification is supported by the host
-     * @returns boolean to represent whether the appNotification capability is supported
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
-     *
-     * @beta
-     */
-    function isSupported() {
-        return ensureInitialized(runtime) && runtime.supports.appNotification ? true : false;
-    }
-    appNotification.isSupported = isSupported;
-})(appNotification || (appNotification = {}));
-
 ;// CONCATENATED MODULE: ./src/public/media.ts
 /* eslint-disable @typescript-eslint/explicit-member-accessibility */
 var __extends = (undefined && undefined.__extends) || (function () {
@@ -6771,6 +6732,136 @@ var chat;
     chat.isSupported = isSupported;
 })(chat || (chat = {}));
 
+;// CONCATENATED MODULE: ./src/public/clipboard.ts
+var __awaiter = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (undefined && undefined.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+
+
+
+
+
+
+/**
+ * Interact with the system clipboard
+ *
+ * @beta
+ */
+var clipboard;
+(function (clipboard) {
+    /**
+     * Function to copy data to clipboard.
+     * @remarks
+     * Note: clipboard.write only supports Text, HTML, PNG, and JPEG data format.
+     *       MIME type for Text -> `text/plain`, HTML -> `text/html`, PNG/JPEG -> `image/(png | jpeg)`
+     *       Also, JPEG will be converted to PNG image when copying to clipboard.
+     *
+     * @param blob - A Blob object representing the data to be copied to clipboard.
+     * @returns A string promise which resolves to success message from the clipboard or
+     *          rejects with error stating the reason for failure.
+     */
+    function write(blob) {
+        return __awaiter(this, void 0, void 0, function () {
+            var base64StringContent, writeParams;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        ensureInitialized(runtime, FrameContexts.content, FrameContexts.task, FrameContexts.stage, FrameContexts.sidePanel);
+                        if (!isSupported()) {
+                            throw errorNotSupportedOnPlatform;
+                        }
+                        if (!(blob.type && Object.values(ClipboardSupportedMimeType).includes(blob.type))) {
+                            throw new Error("Blob type ".concat(blob.type, " is not supported. Supported blob types are ").concat(Object.values(ClipboardSupportedMimeType)));
+                        }
+                        return [4 /*yield*/, getBase64StringFromBlob(blob)];
+                    case 1:
+                        base64StringContent = _a.sent();
+                        writeParams = {
+                            mimeType: blob.type,
+                            content: base64StringContent,
+                        };
+                        return [2 /*return*/, sendAndHandleSdkError('clipboard.writeToClipboard', writeParams)];
+                }
+            });
+        });
+    }
+    clipboard.write = write;
+    /**
+     * Function to read data from clipboard.
+     *
+     * @returns A promise blob which resolves to the data read from the clipboard or
+     *          rejects stating the reason for failure.
+     *          Note: Returned blob type will contain one of the MIME type `image/png`, `text/plain` or `text/html`.
+     */
+    function read() {
+        return __awaiter(this, void 0, void 0, function () {
+            var response, _a, _b;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        ensureInitialized(runtime, FrameContexts.content, FrameContexts.task, FrameContexts.stage, FrameContexts.sidePanel);
+                        if (!isSupported()) {
+                            throw errorNotSupportedOnPlatform;
+                        }
+                        if (!isHostClientMobile()) return [3 /*break*/, 2];
+                        _b = (_a = JSON).parse;
+                        return [4 /*yield*/, sendAndHandleSdkError('clipboard.readFromClipboard')];
+                    case 1:
+                        response = _b.apply(_a, [_c.sent()]);
+                        return [2 /*return*/, base64ToBlob(response.mimeType, response.content)];
+                    case 2: return [2 /*return*/, sendAndHandleSdkError('clipboard.readFromClipboard')];
+                }
+            });
+        });
+    }
+    clipboard.read = read;
+    /**
+     * Checks if clipboard capability is supported by the host
+     * @returns boolean to represent whether the clipboard capability is supported
+     *
+     * @throws Error if {@linkcode app.initialize} has not successfully completed
+     *
+     * @beta
+     */
+    function isSupported() {
+        return ensureInitialized(runtime) && navigator && navigator.clipboard && runtime.supports.clipboard ? true : false;
+    }
+    clipboard.isSupported = isSupported;
+})(clipboard || (clipboard = {}));
+
 ;// CONCATENATED MODULE: ./src/public/geoLocation.ts
 
 
@@ -7145,7 +7236,7 @@ var location_location;
 })(location_location || (location_location = {}));
 
 ;// CONCATENATED MODULE: ./src/public/meeting.ts
-var __awaiter = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
+var meeting_awaiter = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
         function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
@@ -7154,7 +7245,7 @@ var __awaiter = (undefined && undefined.__awaiter) || function (thisArg, _argume
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __generator = (undefined && undefined.__generator) || function (thisArg, body) {
+var meeting_generator = (undefined && undefined.__generator) || function (thisArg, body) {
     var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
     return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
     function verb(n) { return function (v) { return step([n, v]); }; }
@@ -7587,9 +7678,9 @@ var meeting;
             if (typeof isHostAudioless !== 'boolean') {
                 throw new Error('[requestAppAudioHandling] Callback response - isHostAudioless must be a boolean');
             }
-            var micStateChangedCallback = function (micState) { return __awaiter(_this, void 0, void 0, function () {
+            var micStateChangedCallback = function (micState) { return meeting_awaiter(_this, void 0, void 0, function () {
                 var newMicState, micStateDidUpdate, _a;
-                return __generator(this, function (_b) {
+                return meeting_generator(this, function (_b) {
                     switch (_b.label) {
                         case 0:
                             _b.trys.push([0, 2, , 3]);
@@ -8782,7 +8873,7 @@ var video_generator = (undefined && undefined.__generator) || function (thisArg,
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
-var __rest = (undefined && undefined.__rest) || function (s, e) {
+var video_rest = (undefined && undefined.__rest) || function (s, e) {
     var t = {};
     for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
         t[p] = s[p];
@@ -9040,7 +9131,7 @@ var video;
         }
         else {
             // The host may pass the VideoFrame with the old definition which has `data` instead of `videoFrameBuffer`
-            var data = videoBufferData.data, newVideoBufferData = __rest(videoBufferData, ["data"]);
+            var data = videoBufferData.data, newVideoBufferData = video_rest(videoBufferData, ["data"]);
             return video_assign(video_assign({}, newVideoBufferData), { videoFrameBuffer: data });
         }
     }