@microsoft/teams-js 2.20.0-beta.3 → 2.20.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.19.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.20.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.19.0/js/MicrosoftTeams.min.js"
-  integrity="sha384-h+MoYshcGDPMLlXjHLt2dSgsgYyWQ+yHd4Ob13htDsu8trGPea8Vooa8+tLtRzU7"
+  src="https://res.cdn.office.net/teams-js/2.20.0/js/MicrosoftTeams.min.js"
+  integrity="sha384-wBC2cOp5ArjIyhxoK1NtXvJb98SbNojaoD6hXpvxWil+g4O1M2rXNtywEcAoQ8bl"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.19.0/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.20.0/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

package/dist/MicrosoftTeams.d.ts

@@ -1829,6 +1829,57 @@ export namespace meetingRoom {
         export {};
 }
 
+/**
+    * @hidden
+    * Namespace to request message ports from the host application.
+    *
+    * @beta
+    *
+    * @internal
+    * Limited to Microsoft-internal use
+    */
+export namespace messageChannels {
+        /**
+            * @hidden
+            * @beta
+            *
+            * Fetches a MessagePort to batch telemetry through the host's telemetry worker.
+            * The port is cached once received, so subsequent calls return the same port.
+            * @returns MessagePort.
+            *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed,
+            * if the host does not support the feature, or if the port request is rejected.
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        function getTelemetryPort(): Promise<MessagePort>;
+        /**
+            * @hidden
+            *
+            * @beta
+            *
+            * Checks if the messageChannels capability is supported by the host
+            * @returns boolean to represent whether the messageChannels capability is supported
+            *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        function isSupported(): boolean;
+        /**
+            * @hidden
+            * Undocumented function used to clear state between unit tests
+            *
+            * @beta
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        function _clearTelemetryPort(): void;
+}
+
 export namespace notifications {
         /**
             * @hidden

package/dist/MicrosoftTeams.js

@@ -883,6 +883,7 @@ __webpack_require__.d(__webpack_exports__, {
   meeting: () => (/* reexport */ meeting),
   meetingRoom: () => (/* reexport */ meetingRoom),
   menus: () => (/* reexport */ menus),
+  messageChannels: () => (/* reexport */ messageChannels),
   monetization: () => (/* reexport */ monetization),
   navigateBack: () => (/* reexport */ navigateBack),
   navigateCrossDomain: () => (/* reexport */ navigateCrossDomain),
@@ -1105,6 +1106,7 @@ var ApiName;
     ApiName["Menus_SetNavBarMenu"] = "menus.setNavBarMenu";
     ApiName["Menus_SetUpViews"] = "menus.setUpViews";
     ApiName["Menus_ShowActionMenu"] = "menus.showActionMenu";
+    ApiName["MessageChannels_GetTelemetryPort"] = "messageChannels.getTelemetryPort";
     ApiName["Monetization_OpenPurchaseExperience"] = "monetization.openPurchaseExperience";
     ApiName["Navigation_NavigateBack"] = "navigation.navigateBack";
     ApiName["Navigation_NavigateCrossDomain"] = "navigation.navigateCrossDomain";
@@ -1776,7 +1778,9 @@ var ChannelType;
 /** An error object indicating that the requested operation or feature is not supported on the current platform or device.
  * @typedef {Object} SdkError
  */
-const errorNotSupportedOnPlatform = { errorCode: ErrorCode.NOT_SUPPORTED_ON_PLATFORM };
+const errorNotSupportedOnPlatform = {
+    errorCode: ErrorCode.NOT_SUPPORTED_ON_PLATFORM,
+};
 /**
  * @hidden
  *
@@ -2516,7 +2520,7 @@ const _minRuntimeConfigToUninitialize = {
  * @hidden
  *  Package version.
  */
-const version = "2.20.0-beta.3";
+const version = "2.20.0";
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -5514,6 +5518,7 @@ CommunicationPrivate.topMessageQueue = [];
 CommunicationPrivate.nextMessageId = 0;
 CommunicationPrivate.callbacks = {};
 CommunicationPrivate.promiseCallbacks = {};
+CommunicationPrivate.portCallbacks = {};
 /**
  * @internal
  * Limited to Microsoft-internal use
@@ -5582,6 +5587,7 @@ function uninitializeCommunication() {
     CommunicationPrivate.nextMessageId = 0;
     CommunicationPrivate.callbacks = {};
     CommunicationPrivate.promiseCallbacks = {};
+    CommunicationPrivate.portCallbacks = {};
 }
 /**
  * @hidden
@@ -5716,6 +5722,36 @@ function sendMessageToParentAsync(actionName, args = undefined) {
         resolve(waitForResponse(request.id));
     });
 }
+/**
+ * @hidden
+ * Send a message to parent requesting a MessageChannel Port.
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function requestPortFromParentWithVersion(apiVersionTag, actionName, args = undefined) {
+    if (!isFollowingApiVersionTagFormat(apiVersionTag)) {
+        throw Error(`apiVersionTag: ${apiVersionTag} passed in doesn't follow the pattern starting with 'v' followed by digits, then underscore with words, please check.`);
+    }
+    const request = sendMessageToParentHelper(apiVersionTag, actionName, args);
+    return waitForPort(request.id);
+}
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function waitForPort(requestId) {
+    return new Promise((resolve, reject) => {
+        CommunicationPrivate.portCallbacks[requestId] = (port, args) => {
+            if (port instanceof MessagePort) {
+                resolve(port);
+            }
+            else {
+                // First arg is the error message, if present
+                reject(args && args.length > 0 ? args[0] : new Error('Host responded without port or error details.'));
+            }
+        };
+    });
+}
 /**
  * @internal
  * Limited to Microsoft-internal use
@@ -6016,6 +6052,17 @@ function handleParentMessage(evt) {
             logger('Removing registered promise callback for message %i', message.id);
             delete CommunicationPrivate.promiseCallbacks[message.id];
         }
+        const portCallback = CommunicationPrivate.portCallbacks[message.id];
+        if (portCallback) {
+            logger('Invoking the registered port callback for message %i with arguments %o', message.id, message.args);
+            let port;
+            if (evt.ports && evt.ports[0] instanceof MessagePort) {
+                port = evt.ports[0];
+            }
+            portCallback(port, message.args);
+            logger('Removing registered port callback for message %i', message.id);
+            delete CommunicationPrivate.portCallbacks[message.id];
+        }
     }
     else if ('func' in evt.data && typeof evt.data.func === 'string') {
         // Delegate the request to the proper handler
@@ -13332,6 +13379,97 @@ var meetingRoom;
     meetingRoom.isSupported = isSupported;
 })(meetingRoom || (meetingRoom = {}));
 
+;// CONCATENATED MODULE: ./src/private/messageChannels.ts
+var messageChannels_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());
+    });
+};
+
+
+
+
+
+/**
+ * @hidden
+ * Namespace to request message ports from the host application.
+ *
+ * @beta
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+var messageChannels;
+(function (messageChannels) {
+    let telemetryPort;
+    const messageChannelsTelemetryVersionNumber = ApiVersionNumber.V_1;
+    const logger = getLogger('messageChannels');
+    /**
+     * @hidden
+     * @beta
+     *
+     * Fetches a MessagePort to batch telemetry through the host's telemetry worker.
+     * The port is cached once received, so subsequent calls return the same port.
+     * @returns MessagePort.
+     *
+     * @throws Error if {@linkcode app.initialize} has not successfully completed,
+     * if the host does not support the feature, or if the port request is rejected.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    function getTelemetryPort() {
+        return messageChannels_awaiter(this, void 0, void 0, function* () {
+            // If the port has already been initialized, return it.
+            if (telemetryPort) {
+                logger('Returning telemetry port from cache');
+                return telemetryPort;
+            }
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
+            // Send request for telemetry port, will throw if the request is rejected
+            telemetryPort = yield requestPortFromParentWithVersion(getApiVersionTag(messageChannelsTelemetryVersionNumber, ApiName.MessageChannels_GetTelemetryPort), 'messageChannels.getTelemetryPort');
+            return telemetryPort;
+        });
+    }
+    messageChannels.getTelemetryPort = getTelemetryPort;
+    /**
+     * @hidden
+     *
+     * @beta
+     *
+     * Checks if the messageChannels capability is supported by the host
+     * @returns boolean to represent whether the messageChannels capability is supported
+     *
+     * @throws Error if {@linkcode app.initialize} has not successfully completed
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    function isSupported() {
+        return internalAPIs_ensureInitialized(runtime_runtime) && runtime_runtime.supports.messageChannels ? true : false;
+    }
+    messageChannels.isSupported = isSupported;
+    /**
+     * @hidden
+     * Undocumented function used to clear state between unit tests
+     *
+     * @beta
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    function _clearTelemetryPort() {
+        telemetryPort = undefined;
+    }
+    messageChannels._clearTelemetryPort = _clearTelemetryPort;
+})(messageChannels || (messageChannels = {}));
+
 ;// CONCATENATED MODULE: ./src/private/notifications.ts
 
 
@@ -14183,6 +14321,7 @@ var videoEffectsEx;
 
 
 
+
 
 ;// CONCATENATED MODULE: ./src/index.ts