@microsoft/teams-js 2.15.0-beta.2 → 2.15.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.14.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.15.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.14.0/js/MicrosoftTeams.min.js"
-  integrity="sha384-+DItxkmrHBjTqyGZe60m2HxjR/eDhdYpaTux8gT9/YqHSMxASoTe+Y66GvNEMT8k"
+  src="https://res.cdn.office.net/teams-js/2.15.0/js/MicrosoftTeams.min.js"
+  integrity="sha384-fTDbgjG+RKtC2IyKV3r1o0xdxY4oV1v53uPHwPJTmTddvDm2ats9JWRAbtouZx4C"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.14.0/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.15.0/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

package/dist/MicrosoftTeams.d.ts

@@ -8678,7 +8678,7 @@ export namespace marketplace {
     * @hidden
     * Create a MediaStreamTrack from the media stream with the given streamId and processed by videoFrameHandler.
     */
-export function processMediaStream(streamId: string, videoFrameHandler: video.VideoFrameHandler, notifyError: (string: any) => void, videoPerformanceMonitor?: VideoPerformanceMonitor): Promise<MediaStreamTrack>;
+export function processMediaStream(streamId: string, videoFrameHandler: video.VideoFrameHandler, notifyError: (string: any) => void, videoPerformanceMonitor?: VideoPerformanceMonitor): Promise<void>;
 /**
     * @hidden
     * Create a MediaStreamTrack from the media stream with the given streamId and processed by videoFrameHandler.
@@ -8687,7 +8687,7 @@ export function processMediaStream(streamId: string, videoFrameHandler: video.Vi
     * @internal
     * Limited to Microsoft-internal use
     */
-export function processMediaStreamWithMetadata(streamId: string, videoFrameHandler: videoEx.VideoFrameHandler, notifyError: (string: any) => void, videoPerformanceMonitor?: VideoPerformanceMonitor): Promise<MediaStreamTrack>;
+export function processMediaStreamWithMetadata(streamId: string, videoFrameHandler: videoEx.VideoFrameHandler, notifyError: (string: any) => void, videoPerformanceMonitor?: VideoPerformanceMonitor): Promise<void>;
 /**
     * @hidden
     * Video effect change call back function definition

package/dist/MicrosoftTeams.js

@@ -1478,6 +1478,7 @@ var teamsMinAdaptiveCardVersion = {
 
 
 
+
 /**
  * @param pattern - reference pattern
  * @param host - candidate string
@@ -1504,6 +1505,7 @@ function validateHostAgainstPattern(pattern, host) {
     }
     return false;
 }
+var validateOriginLogger = getLogger('validateOrigin');
 /**
  * @internal
  * Limited to Microsoft-internal use
@@ -1511,6 +1513,7 @@ function validateHostAgainstPattern(pattern, host) {
 function validateOrigin(messageOrigin) {
     // Check whether the url is in the pre-known allowlist or supplied by user
     if (!isValidHttpsURL(messageOrigin)) {
+        validateOriginLogger('Origin %s is invalid because it is not using https protocol. Protocol being used: %s', messageOrigin, messageOrigin.protocol);
         return false;
     }
     var messageOriginHost = messageOrigin.host;
@@ -1524,6 +1527,7 @@ function validateOrigin(messageOrigin) {
             return true;
         }
     }
+    validateOriginLogger('Origin %s is invalid because it is not an origin approved by this library or included in the call to app.initialize.\nOrigins approved by this library: %o\nOrigins included in app.initialize: %o', messageOrigin, validOrigins, GlobalVars.additionalValidOrigins);
     return false;
 }
 /**
@@ -1880,6 +1884,27 @@ function getBase64StringFromBlob(blob) {
         reader.readAsDataURL(blob);
     });
 }
+/**
+ *  Returns an SSR safe reference to the window object
+ * @returns Window object reference
+ */
+function ssrSafeWindow() {
+    if (!inServerSideRenderingEnvironment()) {
+        return window;
+    }
+    else {
+        // This should NEVER actually be written.
+        // If you EVER see this error in ANY log file, something has gone horribly wrong and a bug needs to be filed.
+        throw new Error('window object undefined at SSR check');
+    }
+}
+/**
+ * Checks if running in a Server Side Environment
+ * @returns True if running in a Server Side Environment
+ */
+function inServerSideRenderingEnvironment() {
+    return typeof window === 'undefined';
+}
 
 ;// CONCATENATED MODULE: ./src/public/runtime.ts
 /* eslint-disable @typescript-eslint/ban-types */
@@ -2178,7 +2203,7 @@ var _minRuntimeConfigToUninitialize = {
  * @hidden
  *  Package version.
  */
-var version = "2.15.0-beta.2";
+var version = "2.15.0";
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -2315,11 +2340,6 @@ function processAdditionalValidOrigins(validMessageOrigins) {
     GlobalVars.additionalValidOrigins = combinedOriginUrls;
 }
 
-;// CONCATENATED MODULE: ./src/private/inServerSideRenderingEnvironment.ts
-function inServerSideRenderingEnvironment() {
-    return typeof window === 'undefined';
-}
-
 ;// CONCATENATED MODULE: ./src/public/authentication.ts
 
 
@@ -2327,6 +2347,7 @@ function inServerSideRenderingEnvironment() {
 
 
 
+
 /**
  * Namespace to interact with the authentication-specific part of the SDK.
  *
@@ -2683,7 +2704,7 @@ var authentication;
             var link = document.createElement('a');
             link.href = decodeURIComponent(callbackUrl);
             if (link.host &&
-                link.host !== window.location.host &&
+                link.host !== ssrSafeWindow().location.host &&
                 link.host === 'outlook.office.com' &&
                 link.search.indexOf('client_type=Win32_Outlook') > -1) {
                 if (key && key === 'result') {
@@ -3339,6 +3360,7 @@ var menus;
 
 
 
+
 /**
  * Namespace containing the set of APIs that support Teams-specific functionalities.
  */
@@ -3370,14 +3392,7 @@ var teamsCore;
      * default print handler
      */
     function print() {
-        if (typeof window !== 'undefined') {
-            window.print();
-        }
-        else {
-            // This codepath only exists to enable compilation in a server-side redered environment. In standard usage, the window object should never be undefined so this code path should never run.
-            // If this error has actually been thrown, something has gone very wrong and it is a bug
-            throw new Error('window object undefined at print call');
-        }
+        ssrSafeWindow().print();
     }
     teamsCore.print = print;
     /**
@@ -3490,7 +3505,6 @@ var teamsCore;
 
 
 
-
 /**
  * Namespace to interact with app initialization and lifecycle.
  */
@@ -4869,7 +4883,7 @@ function initializeCommunication(validMessageOrigins) {
     CommunicationPrivate.messageListener = function (evt) { return processMessage(evt); };
     // If we are in an iframe, our parent window is the one hosting us (i.e., window.parent); otherwise,
     // it's the window that opened us (i.e., window.opener)
-    Communication.currentWindow = Communication.currentWindow || window;
+    Communication.currentWindow = Communication.currentWindow || ssrSafeWindow();
     Communication.parentWindow =
         Communication.currentWindow.parent !== Communication.currentWindow.self
             ? Communication.currentWindow.parent
@@ -5061,6 +5075,7 @@ function sendMessageToParentHelper(actionName, args) {
     }
     return request;
 }
+var processMessageLogger = communicationLogger.extend('processMessage');
 /**
  * @internal
  * Limited to Microsoft-internal use
@@ -5068,13 +5083,16 @@ function sendMessageToParentHelper(actionName, args) {
 function processMessage(evt) {
     // Process only if we received a valid message
     if (!evt || !evt.data || typeof evt.data !== 'object') {
+        processMessageLogger('Unrecognized message format received by app, message being ignored. Message: %o', evt);
         return;
     }
     // Process only if the message is coming from a different window and a valid origin
-    // valid origins are either a pre-known
+    // valid origins are either a pre-known origin or one specified by the app developer
+    // in their call to app.initialize
     var messageSource = evt.source || (evt.originalEvent && evt.originalEvent.source);
     var messageOrigin = evt.origin || (evt.originalEvent && evt.originalEvent.origin);
     if (!shouldProcessMessage(messageSource, messageOrigin)) {
+        processMessageLogger('Message being ignored by app because it is either coming from the current window or a different window with an invalid origin');
         return;
     }
     // Update our parent and child relationships based on this message
@@ -5087,6 +5105,7 @@ function processMessage(evt) {
         handleChildMessage(evt);
     }
 }
+var shouldProcessMessageLogger = communicationLogger.extend('shouldProcessMessage');
 /**
  * @hidden
  * Validates the message source and origin, if it should be processed
@@ -5098,6 +5117,7 @@ function shouldProcessMessage(messageSource, messageOrigin) {
     // Process if message source is a different window and if origin is either in
     // Teams' pre-known whitelist or supplied as valid origin by user during initialization
     if (Communication.currentWindow && messageSource === Communication.currentWindow) {
+        shouldProcessMessageLogger('Should not process message because it is coming from the current window');
         return false;
     }
     else if (Communication.currentWindow &&
@@ -5107,7 +5127,11 @@ function shouldProcessMessage(messageSource, messageOrigin) {
         return true;
     }
     else {
-        return validateOrigin(new URL(messageOrigin));
+        var isOriginValid = validateOrigin(new URL(messageOrigin));
+        if (!isOriginValid) {
+            shouldProcessMessageLogger('Message has an invalid origin of %s', messageOrigin);
+        }
+        return isOriginValid;
     }
 }
 /**
@@ -6775,6 +6799,7 @@ var __generator = (undefined && undefined.__generator) || function (thisArg, bod
 
 
 
+
 /**
  * Interact with the system clipboard
  *
@@ -6836,7 +6861,7 @@ var clipboard;
                         if (!isSupported()) {
                             throw errorNotSupportedOnPlatform;
                         }
-                        if (!isHostClientMobile()) return [3 /*break*/, 2];
+                        if (!(isHostClientMobile() || GlobalVars.hostClientType === HostClientType.macos)) return [3 /*break*/, 2];
                         _b = (_a = JSON).parse;
                         return [4 /*yield*/, sendAndHandleSdkError('clipboard.readFromClipboard')];
                     case 1:
@@ -8427,14 +8452,20 @@ var videoUtils_generator = (undefined && undefined.__generator) || function (thi
  * Create a MediaStreamTrack from the media stream with the given streamId and processed by videoFrameHandler.
  */
 function processMediaStream(streamId, videoFrameHandler, notifyError, videoPerformanceMonitor) {
+    var _a, _b;
     return videoUtils_awaiter(this, void 0, void 0, function () {
-        var _a;
-        return videoUtils_generator(this, function (_b) {
-            switch (_b.label) {
+        var generator, _c;
+        return videoUtils_generator(this, function (_d) {
+            switch (_d.label) {
                 case 0:
-                    _a = createProcessedStreamGenerator;
+                    generator = createProcessedStreamGeneratorWithoutSource();
+                    !inServerSideRenderingEnvironment() && ((_b = (_a = window['chrome']) === null || _a === void 0 ? void 0 : _a.webview) === null || _b === void 0 ? void 0 : _b.registerTextureStream(streamId, generator));
+                    _c = pipeVideoSourceToGenerator;
                     return [4 /*yield*/, getInputVideoTrack(streamId, notifyError, videoPerformanceMonitor)];
-                case 1: return [2 /*return*/, _a.apply(void 0, [_b.sent(), new DefaultTransformer(notifyError, videoFrameHandler)])];
+                case 1:
+                    _c.apply(void 0, [_d.sent(), new DefaultTransformer(notifyError, videoFrameHandler),
+                        generator.writable]);
+                    return [2 /*return*/];
             }
         });
     });
@@ -8448,14 +8479,20 @@ function processMediaStream(streamId, videoFrameHandler, notifyError, videoPerfo
  * Limited to Microsoft-internal use
  */
 function processMediaStreamWithMetadata(streamId, videoFrameHandler, notifyError, videoPerformanceMonitor) {
+    var _a, _b;
     return videoUtils_awaiter(this, void 0, void 0, function () {
-        var _a;
-        return videoUtils_generator(this, function (_b) {
-            switch (_b.label) {
+        var generator, _c;
+        return videoUtils_generator(this, function (_d) {
+            switch (_d.label) {
                 case 0:
-                    _a = createProcessedStreamGenerator;
+                    generator = createProcessedStreamGeneratorWithoutSource();
+                    !inServerSideRenderingEnvironment() && ((_b = (_a = window['chrome']) === null || _a === void 0 ? void 0 : _a.webview) === null || _b === void 0 ? void 0 : _b.registerTextureStream(streamId, generator));
+                    _c = pipeVideoSourceToGenerator;
                     return [4 /*yield*/, getInputVideoTrack(streamId, notifyError, videoPerformanceMonitor)];
-                case 1: return [2 /*return*/, _a.apply(void 0, [_b.sent(), new TransformerWithMetadata(notifyError, videoFrameHandler)])];
+                case 1:
+                    _c.apply(void 0, [_d.sent(), new TransformerWithMetadata(notifyError, videoFrameHandler),
+                        generator.writable]);
+                    return [2 /*return*/];
             }
         });
     });
@@ -8472,7 +8509,7 @@ function getInputVideoTrack(streamId, notifyError, videoPerformanceMonitor) {
                     if (inServerSideRenderingEnvironment()) {
                         throw errorNotSupportedOnPlatform;
                     }
-                    chrome = window['chrome'];
+                    chrome = ssrSafeWindow()['chrome'];
                     _a.label = 1;
                 case 1:
                     _a.trys.push([1, 3, , 4]);
@@ -8497,23 +8534,30 @@ function getInputVideoTrack(streamId, notifyError, videoPerformanceMonitor) {
     });
 }
 /**
- * The function to create a processed video track from the original video track.
- * It reads frames from the video track and pipes them to the video frame callback to process the frames.
- * The processed frames are then enqueued to the generator.
+ * The function to create a MediaStreamTrack generator.
+ * The generator can then get the processed frames as media stream source.
  * The generator can be registered back to the media stream so that the host can get the processed frames.
  */
-function createProcessedStreamGenerator(videoTrack, transformer) {
+function createProcessedStreamGeneratorWithoutSource() {
     if (inServerSideRenderingEnvironment()) {
         throw errorNotSupportedOnPlatform;
     }
-    var MediaStreamTrackProcessor = window['MediaStreamTrackProcessor'];
+    var MediaStreamTrackGenerator = window['MediaStreamTrackGenerator'];
+    if (!MediaStreamTrackGenerator) {
+        throw errorNotSupportedOnPlatform;
+    }
+    return new MediaStreamTrackGenerator({ kind: 'video' });
+}
+/**
+ * The function to create a processed video track from the original video track.
+ * It reads frames from the video track and pipes them to the video frame callback to process the frames.
+ * The processed frames are then enqueued to the generator.
+ */
+function pipeVideoSourceToGenerator(videoTrack, transformer, sink) {
+    var MediaStreamTrackProcessor = ssrSafeWindow()['MediaStreamTrackProcessor'];
     var processor = new MediaStreamTrackProcessor({ track: videoTrack });
     var source = processor.readable;
-    var MediaStreamTrackGenerator = window['MediaStreamTrackGenerator'];
-    var generator = new MediaStreamTrackGenerator({ kind: 'video' });
-    var sink = generator.writable;
     source.pipeThrough(new TransformStream(transformer)).pipeTo(sink);
-    return generator;
 }
 /**
  * @hidden
@@ -9070,18 +9114,15 @@ var video;
             throw errorNotSupportedOnPlatform;
         }
         registerHandler('video.startVideoExtensibilityVideoStream', function (mediaStreamInfo) { return video_awaiter(_this, void 0, void 0, function () {
-            var streamId, monitoredVideoFrameHandler, generator;
-            var _a, _b;
-            return video_generator(this, function (_c) {
-                switch (_c.label) {
+            var streamId, monitoredVideoFrameHandler;
+            return video_generator(this, function (_a) {
+                switch (_a.label) {
                     case 0:
                         streamId = mediaStreamInfo.streamId;
                         monitoredVideoFrameHandler = createMonitoredVideoFrameHandler(videoFrameHandler, videoPerformanceMonitor);
                         return [4 /*yield*/, processMediaStream(streamId, monitoredVideoFrameHandler, notifyError, videoPerformanceMonitor)];
                     case 1:
-                        generator = _c.sent();
-                        // register the video track with processed frames back to the stream:
-                        !inServerSideRenderingEnvironment() && ((_b = (_a = window['chrome']) === null || _a === void 0 ? void 0 : _a.webview) === null || _b === void 0 ? void 0 : _b.registerTextureStream(streamId, generator));
+                        _a.sent();
                         return [2 /*return*/];
                 }
             });
@@ -9143,8 +9184,7 @@ var video;
     }
     function isTextureStreamAvailable() {
         var _a, _b, _c, _d;
-        return (!inServerSideRenderingEnvironment() &&
-            !!(((_b = (_a = window['chrome']) === null || _a === void 0 ? void 0 : _a.webview) === null || _b === void 0 ? void 0 : _b.getTextureStream) && ((_d = (_c = window['chrome']) === null || _c === void 0 ? void 0 : _c.webview) === null || _d === void 0 ? void 0 : _d.registerTextureStream)));
+        return !!(((_b = (_a = ssrSafeWindow()['chrome']) === null || _a === void 0 ? void 0 : _a.webview) === null || _b === void 0 ? void 0 : _b.getTextureStream) && ((_d = (_c = ssrSafeWindow()['chrome']) === null || _c === void 0 ? void 0 : _c.webview) === null || _d === void 0 ? void 0 : _d.registerTextureStream));
     }
     function doesSupportSharedFrame() {
         var _a;
@@ -12200,26 +12240,25 @@ var videoEx;
             registerHandler('video.setFrameProcessTimeLimit', function (timeLimit) { return videoPerformanceMonitor === null || videoPerformanceMonitor === void 0 ? void 0 : videoPerformanceMonitor.setFrameProcessTimeLimit(timeLimit); }, false);
             if ((_a = runtime.supports.video) === null || _a === void 0 ? void 0 : _a.mediaStream) {
                 registerHandler('video.startVideoExtensibilityVideoStream', function (mediaStreamInfo) { return videoEx_awaiter(_this, void 0, void 0, function () {
-                    var streamId, metadataInTexture, generator, _a;
-                    var _b, _c;
-                    return videoEx_generator(this, function (_d) {
-                        switch (_d.label) {
+                    var streamId, metadataInTexture, handler, _a;
+                    return videoEx_generator(this, function (_b) {
+                        switch (_b.label) {
                             case 0:
                                 streamId = mediaStreamInfo.streamId, metadataInTexture = mediaStreamInfo.metadataInTexture;
+                                handler = videoPerformanceMonitor
+                                    ? createMonitoredVideoFrameHandler(parameters.videoFrameHandler, videoPerformanceMonitor)
+                                    : parameters.videoFrameHandler;
                                 if (!metadataInTexture) return [3 /*break*/, 2];
-                                return [4 /*yield*/, processMediaStreamWithMetadata(streamId, parameters.videoFrameHandler, notifyError, videoPerformanceMonitor)];
+                                return [4 /*yield*/, processMediaStreamWithMetadata(streamId, handler, notifyError, videoPerformanceMonitor)];
                             case 1:
-                                _a = _d.sent();
+                                _a = _b.sent();
                                 return [3 /*break*/, 4];
-                            case 2: return [4 /*yield*/, processMediaStream(streamId, parameters.videoFrameHandler, notifyError, videoPerformanceMonitor)];
+                            case 2: return [4 /*yield*/, processMediaStream(streamId, handler, notifyError, videoPerformanceMonitor)];
                             case 3:
-                                _a = _d.sent();
-                                _d.label = 4;
+                                _a = _b.sent();
+                                _b.label = 4;
                             case 4:
-                                generator = _a;
-                                // register the video track with processed frames back to the stream
-                                !inServerSideRenderingEnvironment() &&
-                                    ((_c = (_b = window['chrome']) === null || _b === void 0 ? void 0 : _b.webview) === null || _c === void 0 ? void 0 : _c.registerTextureStream(streamId, generator));
+                                _a;
                                 return [2 /*return*/];
                         }
                     });
@@ -12247,6 +12286,24 @@ var videoEx;
         }
     }
     videoEx.registerForVideoFrame = registerForVideoFrame;
+    function createMonitoredVideoFrameHandler(videoFrameHandler, videoPerformanceMonitor) {
+        var _this = this;
+        return function (receivedVideoFrame) { return videoEx_awaiter(_this, void 0, void 0, function () {
+            var originalFrame, processedFrame;
+            return videoEx_generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        originalFrame = receivedVideoFrame.videoFrame;
+                        videoPerformanceMonitor.reportStartFrameProcessing(originalFrame.codedWidth, originalFrame.codedHeight);
+                        return [4 /*yield*/, videoFrameHandler(receivedVideoFrame)];
+                    case 1:
+                        processedFrame = _a.sent();
+                        videoPerformanceMonitor.reportFrameProcessed();
+                        return [2 /*return*/, processedFrame];
+                }
+            });
+        }); };
+    }
     function normalizedVideoBufferData(videoBufferData) {
         videoBufferData['videoFrameBuffer'] = videoBufferData['videoFrameBuffer'] || videoBufferData['data'];
         delete videoBufferData['data'];