@microsoft/teams-js 2.25.0 → 2.26.0-beta.1

package/dist/MicrosoftTeams.d.ts

@@ -2756,6 +2756,15 @@ export namespace videoEffectsEx {
                     * Limited to Microsoft-internal use
                     */
                 audioInferenceModel?: ArrayBuffer;
+                /**
+                    * @hidden
+                    * Specifies additional capabilities that should be applied to the video frame
+                    * @beta
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    */
+                requiredCapabilities?: string[];
         }
         /**
             * @hidden
@@ -2806,6 +2815,15 @@ export namespace videoEffectsEx {
                     * Limited to Microsoft-internal use
                     */
                 audioInferenceResult?: Uint8Array;
+                /**
+                    * @hidden
+                    * Additional metadata determined by capabilities specified in {@linkcode VideoFrameConfig.requiredCapabilities}
+                    * @beta
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    */
+                attributes?: ReadonlyMap<string, Uint8Array>;
         };
         /**
             * @hidden
@@ -3027,6 +3045,9 @@ export namespace authentication {
             *
             * @returns Promise that resolves with the {@link UserProfile}.
             *
+            * @throws `Error` object in case of any problems, the most likely of which is that the calling app does not have appropriate permissions
+            * to call this method.
+            *
             * @internal
             * Limited to Microsoft-internal use
             */
@@ -3039,6 +3060,10 @@ export namespace authentication {
             * Requests the decoded Microsoft Entra user identity on behalf of the app.
             *
             * @param userRequest - It passes success/failure callbacks in the userRequest object(deprecated)
+            *
+            * @throws `Error` object in case of any problems, the most likely of which is that the calling app does not have appropriate permissions
+            * to call this method.
+            *
             * @internal
             * Limited to Microsoft-internal use
             */
@@ -5791,11 +5816,11 @@ export namespace pages {
             */
         function getConfig(): Promise<InstanceConfig>;
         /**
-            * Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
-            * valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
-            * thrown. This function needs to be used only when navigating the frame to a URL in a different domain
-            * than the current one in a way that keeps the application informed of the change and allows the SDK to
-            * continue working.
+            * @deprecated
+            * As of 2.0.0, this API is deprecated and can be replaced by the standard JavaScript
+            * API, window.location.href, when navigating the app to a new cross-domain URL. Any URL
+            * that is redirected to must be listed in the validDomains block of the manifest. Please
+            * remove any calls to this API.
             * @param url - The URL to navigate the frame to.
             * @returns Promise that resolves when the navigation has completed.
             */
@@ -5856,6 +5881,11 @@ export namespace pages {
                     * For apps installed as a channel tab, this ID can be supplied to indicate in which Teams channel the app should be opened
                     */
                 channelId?: string;
+                /**
+                * Optional ID of the chat or meeting where the app should be opened
+        
+                */
+                chatId?: string;
         }
         /**
             * Provides APIs for querying and navigating between contextual tabs of an application. Unlike personal tabs,
@@ -9526,14 +9556,10 @@ export function returnFocus(navigateForward?: boolean): void;
 export function navigateToTab(tabInstance: TabInstance, onComplete?: onCompleteHandlerFunctionType): void;
 /**
     * @deprecated
-    * As of TeamsJS v2.0.0, please use {@link pages.navigateCrossDomain pages.navigateCrossDomain(url: string): Promise\<void\>} instead.
-    *
-    * Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
-    * valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
-    * thrown. This function needs to be used only when navigating the frame to a URL in a different domain
-    * than the current one in a way that keeps the app informed of the change and allows the SDK to
-    * continue working.
-    *
+    * As of 2.0.0, this API is deprecated and can be replaced by the standard JavaScript
+    * API, window.location.href, when navigating the app to a new cross-domain URL. Any URL
+    * that is redirected to must be listed in the validDomains block of the manifest. Please
+    * remove any calls to this API.
     * @param url - The URL to navigate the frame to.
     * @param onComplete - The callback to invoke when the action is complete.
     */

package/dist/MicrosoftTeams.js

@@ -169,7 +169,7 @@ function fromByteArray (uint8) {
 
 /***/ }),
 
-/***/ 46:
+/***/ 815:
 /***/ ((module, exports, __webpack_require__) => {
 
 /* eslint-env browser */
@@ -426,7 +426,7 @@ function localstorage() {
 	}
 }
 
-module.exports = __webpack_require__(601)(exports);
+module.exports = __webpack_require__(530)(exports);
 
 const {formatters} = module.exports;
 
@@ -445,7 +445,7 @@ formatters.j = function (v) {
 
 /***/ }),
 
-/***/ 601:
+/***/ 530:
 /***/ ((module, __unused_webpack_exports, __webpack_require__) => {
 
 
@@ -1090,8 +1090,8 @@ __webpack_require__.d(__webpack_exports__, {
   webStorage: () => (/* reexport */ webStorage)
 });
 
-// EXTERNAL MODULE: ../../node_modules/.pnpm/debug@4.3.4/node_modules/debug/src/browser.js
-var browser = __webpack_require__(46);
+// EXTERNAL MODULE: ../../node_modules/.pnpm/debug@4.3.5/node_modules/debug/src/browser.js
+var browser = __webpack_require__(815);
 ;// CONCATENATED MODULE: ./src/internal/telemetry.ts
 
 const topLevelLogger = (0,browser.debug)('teamsJs');
@@ -1130,7 +1130,7 @@ function isFollowingApiVersionTagFormat(apiVersionTag) {
 }
 
 ;// CONCATENATED MODULE: ./src/artifactsForCDN/validDomains.json
-const validDomains_namespaceObject = /*#__PURE__*/JSON.parse('{"validOrigins":["teams.microsoft.com","teams.microsoft.us","gov.teams.microsoft.us","dod.teams.microsoft.us","int.teams.microsoft.com","outlook.office.com","outlook-sdf.office.com","outlook.office365.com","outlook-sdf.office365.com","outlook.live.com","outlook-sdf.live.com","teams.live.com","local.teams.live.com","local.teams.live.com:8080","local.teams.office.com","local.teams.office.com:8080","devspaces.skype.com","*.www.office.com","www.office.com","word.office.com","excel.office.com","powerpoint.office.com","www.officeppe.com","*.www.microsoft365.com","www.microsoft365.com","bing.com","edgeservices.bing.com","www.bing.com","www.staging-bing-int.com","teams.cloud.microsoft","outlook.cloud.microsoft","m365.cloud.microsoft","copilot.microsoft.com","windows.msn.com","fa000000125.resources.office.net","fa000000129.resources.office.net","fa000000124.resources.office.net","fa000000128.resources.office.net"]}');
+const validDomains_namespaceObject = /*#__PURE__*/JSON.parse('{"validOrigins":["teams.microsoft.com","teams.microsoft.us","gov.teams.microsoft.us","dod.teams.microsoft.us","int.teams.microsoft.com","outlook.office.com","outlook-sdf.office.com","outlook.office365.com","outlook-sdf.office365.com","outlook.live.com","outlook-sdf.live.com","teams.live.com","local.teams.live.com","local.teams.live.com:8080","local.teams.office.com","local.teams.office.com:8080","devspaces.skype.com","*.www.office.com","www.office.com","word.office.com","excel.office.com","powerpoint.office.com","www.officeppe.com","*.www.microsoft365.com","www.microsoft365.com","bing.com","edgeservices.bing.com","www.bing.com","www.staging-bing-int.com","*.cloud.microsoft","copilot.microsoft.com","windows.msn.com","fa000000125.resources.office.net","fa000000129.resources.office.net","fa000000124.resources.office.net","fa000000128.resources.office.net","fa000000136.resources.office.net"]}');
 var artifactsForCDN_validDomains_namespaceObject = /*#__PURE__*/__webpack_require__.t(validDomains_namespaceObject, 2);
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
 
@@ -2810,8 +2810,8 @@ function createTeamsAppLink(params) {
     if (params.webUrl) {
         url.searchParams.append('webUrl', params.webUrl);
     }
-    if (params.channelId || params.subPageId) {
-        url.searchParams.append('context', JSON.stringify({ channelId: params.channelId, subEntityId: params.subPageId }));
+    if (params.chatId || params.channelId || params.subPageId) {
+        url.searchParams.append('context', JSON.stringify({ chatId: params.chatId, channelId: params.channelId, subEntityId: params.subPageId }));
     }
     return url.toString();
 }
@@ -3395,7 +3395,7 @@ const _minRuntimeConfigToUninitialize = {
  * @hidden
  *  Package version.
  */
-const version = "2.25.0";
+const version = "2.26.0-beta.1";
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -3553,11 +3553,11 @@ function prefetchOriginsFromCDN() {
     });
 }
 function isValidOriginsCacheEmpty() {
-    return validOriginsCache.length !== 0;
+    return validOriginsCache.length === 0;
 }
 function getValidOriginsListFromCDN() {
     return __awaiter(this, void 0, void 0, function* () {
-        if (isValidOriginsCacheEmpty()) {
+        if (!isValidOriginsCacheEmpty()) {
             return validOriginsCache;
         }
         if (!inServerSideRenderingEnvironment()) {
@@ -4014,11 +4014,12 @@ var authentication;
             return value;
         })
             .catch((err) => {
+            const errorMessage = `Error returned, code = ${err.errorCode}, message = ${err.message}`;
             if (userRequest && userRequest.failureCallback) {
-                userRequest.failureCallback(err.message);
+                userRequest.failureCallback(errorMessage);
                 return null;
             }
-            throw err;
+            throw new Error(errorMessage);
         });
     }
     authentication.getUser = getUser;
@@ -4030,7 +4031,7 @@ var authentication;
                 return result;
             }
             else {
-                throw new Error(result);
+                throw result;
             }
         });
     }
@@ -5596,11 +5597,11 @@ var pages;
     }
     pages.getConfig = getConfig;
     /**
-     * Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
-     * valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
-     * thrown. This function needs to be used only when navigating the frame to a URL in a different domain
-     * than the current one in a way that keeps the application informed of the change and allows the SDK to
-     * continue working.
+     * @deprecated
+     * As of 2.0.0, this API is deprecated and can be replaced by the standard JavaScript
+     * API, window.location.href, when navigating the app to a new cross-domain URL. Any URL
+     * that is redirected to must be listed in the validDomains block of the manifest. Please
+     * remove any calls to this API.
      * @param url - The URL to navigate the frame to.
      * @returns Promise that resolves when the navigation has completed.
      */
@@ -7039,7 +7040,15 @@ function shouldProcessMessage(messageSource, messageOrigin) {
             return true;
         }
         else {
-            const isOriginValid = yield validateOrigin(new URL(messageOrigin));
+            let messageOriginURL;
+            try {
+                messageOriginURL = new URL(messageOrigin);
+            }
+            catch (_) {
+                shouldProcessMessageLogger('Message has an invalid origin of %s', messageOrigin);
+                return false;
+            }
+            const isOriginValid = yield validateOrigin(messageOriginURL);
             if (!isOriginValid) {
                 shouldProcessMessageLogger('Message has an invalid origin of %s', messageOrigin);
             }
@@ -10347,6 +10356,7 @@ class OneTextureMetadata {
         // Stream id for audio inference metadata, which is the 4-byte ASCII string "1dia" hardcoded by the host
         // (1dia stands for "audio inference data version 1")
         this.AUDIO_INFERENCE_RESULT_STREAM_ID = 0x31646961;
+        this.ATTRIBUTE_ID_MAP_STREAM_ID = 0x4d444941;
         const metadataDataView = new Uint32Array(metadataBuffer);
         for (let i = 0, index = 0; i < streamCount; i++) {
             const streamId = metadataDataView[index++];
@@ -10359,6 +10369,48 @@ class OneTextureMetadata {
     get audioInferenceResult() {
         return this.metadataMap.get(this.AUDIO_INFERENCE_RESULT_STREAM_ID);
     }
+    /**
+     * @hidden
+     * Additional attributes on the video frame are string-indexed, with their stream Id dynamically generated.
+     * The mapping of attribute Ids to their stream Ids is itself stored as frame metadata with layout:
+     *
+     * | attribute count  | attribute stream Id  | attribute id                                              | ...   |
+     * | :---:            | :---:                | :---:                                                     | :---: |
+     * | 4 bytes          | 4 bytes              | variable length string (null terminated, 4 byte aligned)  | ...   |
+     *
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    get attributes() {
+        const data = this.metadataMap.get(this.ATTRIBUTE_ID_MAP_STREAM_ID);
+        if (data === undefined) {
+            return undefined;
+        }
+        const map = new Map();
+        const textDecoder = new TextDecoder('utf-8');
+        let offset = 0;
+        const count = data[offset] + (data[++offset] << 8) + (data[++offset] << 16) + (data[++offset] << 24);
+        for (let i = 0; i < count && offset < data.length - 1; i++) {
+            const streamId = data[++offset] + (data[++offset] << 8) + (data[++offset] << 16) + (data[++offset] << 24);
+            // Find start of null-terminator for the subsequent variable-length string entry
+            const nullTerminatorStartIndex = data.findIndex((value, index, _) => {
+                return value == 0 && index > offset;
+            });
+            const attributeId = textDecoder.decode(data.slice(++offset, nullTerminatorStartIndex));
+            // Read attribute value from metadata map
+            const metadata = this.metadataMap.get(streamId);
+            if (metadata !== undefined) {
+                map.set(attributeId, metadata);
+            }
+            // Variable length attribute Id strings are null-terminated to a 4-byte alignment
+            const stringByteLength = nullTerminatorStartIndex - offset;
+            const paddingSize = 4 - (stringByteLength % 4);
+            // Set offset to index of last trailing zero
+            offset = nullTerminatorStartIndex + (paddingSize - 1);
+        }
+        return map;
+    }
 }
 class TransformerWithMetadata {
     constructor(notifyError, videoFrameHandler) {
@@ -10369,8 +10421,8 @@ class TransformerWithMetadata {
             const timestamp = originalFrame.timestamp;
             if (timestamp !== null) {
                 try {
-                    const { videoFrame, metadata: { audioInferenceResult } = {} } = yield this.extractVideoFrameAndMetadata(originalFrame);
-                    const frameProcessedByApp = yield this.videoFrameHandler({ videoFrame, audioInferenceResult });
+                    const { videoFrame, metadata: { audioInferenceResult, attributes } = {} } = yield this.extractVideoFrameAndMetadata(originalFrame);
+                    const frameProcessedByApp = yield this.videoFrameHandler({ videoFrame, audioInferenceResult, attributes });
                     // the current typescript version(4.6.4) dosn't support webcodecs API fully, we have to do type conversion here.
                     const processedFrame = new VideoFrame(frameProcessedByApp, {
                         // we need the timestamp to be unchanged from the oirginal frame, so we explicitly set it here.
@@ -10467,6 +10519,7 @@ class TransformerWithMetadata {
                 }),
                 metadata: {
                     audioInferenceResult: this.shouldDiscardAudioInferenceResult ? undefined : metadata.audioInferenceResult,
+                    attributes: metadata.attributes,
                 },
             };
         });
@@ -14836,14 +14889,10 @@ function navigateToTab(tabInstance, onComplete) {
 }
 /**
  * @deprecated
- * As of TeamsJS v2.0.0, please use {@link pages.navigateCrossDomain pages.navigateCrossDomain(url: string): Promise\<void\>} instead.
- *
- * Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
- * valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
- * thrown. This function needs to be used only when navigating the frame to a URL in a different domain
- * than the current one in a way that keeps the app informed of the change and allows the SDK to
- * continue working.
- *
+ * As of 2.0.0, this API is deprecated and can be replaced by the standard JavaScript
+ * API, window.location.href, when navigating the app to a new cross-domain URL. Any URL
+ * that is redirected to must be listed in the validDomains block of the manifest. Please
+ * remove any calls to this API.
  * @param url - The URL to navigate the frame to.
  * @param onComplete - The callback to invoke when the action is complete.
  */