@microsoft/teams-js 2.20.0-beta.1 → 2.20.0-beta.3

package/dist/MicrosoftTeams.d.ts

@@ -2797,7 +2797,7 @@ export namespace authentication {
                     */
                 silent?: boolean;
                 /**
-                    * An optional identifier of the home tenant for which to acquire the acess token for (used in cross-tenant shared channels).
+                    * An optional identifier of the home tenant for which to acquire the access token for (used in cross-tenant shared channels).
                     */
                 tenantId?: string;
         }
@@ -4128,6 +4128,10 @@ export interface ClipboardParams {
 }
 
 export function appInitializeHelper(apiVersionTag: string, validMessageOrigins?: string[]): Promise<void>;
+export function notifyAppLoadedHelper(apiVersionTag: string): void;
+export function notifyExpectedFailureHelper(apiVersionTag: string, expectedFailureRequest: app.IExpectedFailureRequest): void;
+export function notifyFailureHelper(apiVersiontag: string, appInitializationFailedRequest: app.IFailedRequest): void;
+export function notifySuccessHelper(apiVersionTag: string): void;
 export function registerOnThemeChangeHandlerHelper(apiVersionTag: string, handler: app.themeHandler): void;
 export function openLinkHelper(apiVersionTag: string, deepLink: string): Promise<void>;
 /**
@@ -4224,7 +4228,7 @@ export namespace app {
                     */
                 locale: string;
                 /**
-                    * The current UI theme of the host. Possible values: "default", "dark", or "contrast".
+                    * The current UI theme of the host. Possible values: "default", "dark", "contrast" or "glass".
                     */
                 theme: string;
                 /**
@@ -8546,10 +8550,6 @@ export namespace call {
         function isSupported(): boolean;
 }
 
-/**
-    * @deprecated
-    * As of 2.0.0, please use {@link app} namespace instead.
-    */
 export namespace appInitialization {
         /**
             * @deprecated

package/dist/MicrosoftTeams.js

@@ -990,7 +990,16 @@ var ApiName;
     ApiName["App_NotifySuccess"] = "app.notifySuccess";
     ApiName["App_OpenLink"] = "app.openLink";
     ApiName["App_RegisterOnThemeChangeHandler"] = "app.registerOnThemeChangeHandler";
+    ApiName["AppInitialization_NotifyAppLoaded"] = "appInitialization.notifyAppLoaded";
+    ApiName["AppInitialization_NotifyExpectedFailure"] = "appInitialization.notifyExpectedFailure";
+    ApiName["AppInitialization_NotifyFailure"] = "appInitialization.notifyFailure";
+    ApiName["AppInitialization_NotifySuccess"] = "appInitialization.notifySuccess";
     ApiName["AppEntity_SelectAppEntity"] = "appEntity.selectAppEntity";
+    ApiName["AppInstallDialog_OpenAppInstallDialog"] = "appInstallDialog.openAppInstallDialog";
+    ApiName["AppWindow_ChildAppWindow_AddEventListener"] = "appWindow.childAppWindow.addEventListener";
+    ApiName["AppWindow_ChildAppWindow_PostMessage"] = "appWindow.childAppWindow.postMessage";
+    ApiName["AppWindow_ParentAppWindow_AddEventListener"] = "appWindow.parentAppWindow.addEventListener";
+    ApiName["AppWindow_ParentAppWindow_PostMessage"] = "appWindow.parentAppWindow.postMessage";
     ApiName["BarCode_HasPermission"] = "barCode.hasPermission";
     ApiName["BarCode_RequestPermission"] = "barCode.requestPermission";
     ApiName["BarCode_ScanBarCode"] = "barCode.scanBarCode";
@@ -1155,6 +1164,8 @@ var ApiName;
     ApiName["PublicAPIs_SetFrameContext"] = "setFrameContext";
     ApiName["PublicAPIs_ShareDeepLink"] = "shareDeepLink";
     ApiName["RegisterHandler"] = "registerHandler";
+    ApiName["RegisterBeforeUnloadHandler"] = "registerBeforeUnloadHandler";
+    ApiName["RegisterLoadHandler"] = "registerLoadHandler";
     ApiName["RegisterOnThemeChangeHandler"] = "registerOnThemeChangeHandler";
     ApiName["RemoteCamera_GetCapableParticipants"] = "remoteCamera.getCapableParticipants";
     ApiName["RemoteCamera_RegisterOnCapableParticipantsChangeHandler"] = "remoteCamera.registerOnCapableParticipantsChangeHandler";
@@ -1208,6 +1219,9 @@ var ApiName;
     ApiName["VideoEffectsEx_RegisterSetFrameProcessTimeLimitHandler"] = "videoEffectsEX.registerSetFrameProcessTimeLimitHandler";
     ApiName["VideoEffectsEx_RegisterStartVideoExtensibilityVideoStreamHandler"] = "videoEffectsEX.registerStartVideoExtensibilityVideoStreamHandler";
     ApiName["VideoEffectsEx_UpdatePersonalizedEffects"] = "videoEffectsEx.updatePersonalizedEffects";
+    ApiName["VideoEffectsUtils_EffectFailure"] = "videoEffectsUtils.effectFailure";
+    ApiName["VideoEffectsUtils_ReportVideoEffectChanged"] = "videoEffectsUtils.reportVideoEffectChanged";
+    ApiName["VideoEffectsUtils_TransformerWithMetadata_Constructor"] = "videoEffectsUtils.transformerWithMetadata.constructor";
     ApiName["VideoPerformanceMonitor_Constructor"] = "videoPerformanceMonitor.performanceDataGenerated";
     ApiName["VideoPerformanceMonitor_ReportFrameProcessed"] = "videoPerformanceMonitor.reportFrameProcessed";
     ApiName["VideoPerformanceMonitor_ReportTextureStreamAcquired"] = "videoPerformanceMonitor.reportTextureStreamAcquired";
@@ -2502,7 +2516,7 @@ const _minRuntimeConfigToUninitialize = {
  * @hidden
  *  Package version.
  */
-const version = "2.20.0-beta.1";
+const version = "2.20.0-beta.3";
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -3808,6 +3822,24 @@ function appInitializeHelper(apiVersionTag, validMessageOrigins) {
         return Promise.resolve();
     }
 }
+function notifyAppLoadedHelper(apiVersionTag) {
+    sendMessageToParentWithVersion(apiVersionTag, app.Messages.AppLoaded, [version]);
+}
+function notifyExpectedFailureHelper(apiVersionTag, expectedFailureRequest) {
+    sendMessageToParentWithVersion(apiVersionTag, app.Messages.ExpectedFailure, [
+        expectedFailureRequest.reason,
+        expectedFailureRequest.message,
+    ]);
+}
+function notifyFailureHelper(apiVersiontag, appInitializationFailedRequest) {
+    sendMessageToParentWithVersion(apiVersiontag, app.Messages.Failure, [
+        appInitializationFailedRequest.reason,
+        appInitializationFailedRequest.message,
+    ]);
+}
+function notifySuccessHelper(apiVersionTag) {
+    sendMessageToParentWithVersion(apiVersionTag, app.Messages.Success, [version]);
+}
 const initializeHelperLogger = appLogger.extend('initializeHelper');
 function initializeHelper(apiVersionTag, validMessageOrigins) {
     return new Promise((resolve) => {
@@ -4065,7 +4097,7 @@ var app;
      */
     function notifyAppLoaded() {
         ensureInitializeCalled();
-        sendMessageToParentWithVersion(getApiVersionTag(appTelemetryVersionNumber, ApiName.App_NotifyAppLoaded), app.Messages.AppLoaded, [version]);
+        notifyAppLoadedHelper(getApiVersionTag(appTelemetryVersionNumber, ApiName.App_NotifyAppLoaded));
     }
     app.notifyAppLoaded = notifyAppLoaded;
     /**
@@ -4073,7 +4105,7 @@ var app;
      */
     function notifySuccess() {
         ensureInitializeCalled();
-        sendMessageToParentWithVersion(getApiVersionTag(appTelemetryVersionNumber, ApiName.App_NotifySuccess), app.Messages.Success, [version]);
+        notifySuccessHelper(getApiVersionTag(appTelemetryVersionNumber, ApiName.App_NotifySuccess));
     }
     app.notifySuccess = notifySuccess;
     /**
@@ -4084,7 +4116,7 @@ var app;
      */
     function notifyFailure(appInitializationFailedRequest) {
         ensureInitializeCalled();
-        sendMessageToParentWithVersion(getApiVersionTag(appTelemetryVersionNumber, ApiName.App_NotifyFailure), app.Messages.Failure, [appInitializationFailedRequest.reason, appInitializationFailedRequest.message]);
+        notifyFailureHelper(getApiVersionTag(appTelemetryVersionNumber, ApiName.App_NotifyFailure), appInitializationFailedRequest);
     }
     app.notifyFailure = notifyFailure;
     /**
@@ -4094,7 +4126,7 @@ var app;
      */
     function notifyExpectedFailure(expectedFailureRequest) {
         ensureInitializeCalled();
-        sendMessageToParentWithVersion(getApiVersionTag(appTelemetryVersionNumber, ApiName.App_NotifyExpectedFailure), app.Messages.ExpectedFailure, [expectedFailureRequest.reason, expectedFailureRequest.message]);
+        notifyExpectedFailureHelper(getApiVersionTag(appTelemetryVersionNumber, ApiName.App_NotifyExpectedFailure), expectedFailureRequest);
     }
     app.notifyExpectedFailure = notifyExpectedFailure;
     /**
@@ -5309,7 +5341,8 @@ function handleBeforeUnload() {
  */
 function handlers_registerBeforeSuspendOrTerminateHandler(handler) {
     HandlersPrivate.beforeSuspendOrTerminateHandler = handler;
-    !isNullOrUndefined(handler) && sendMessageToParent('registerHandler', ['beforeUnload']);
+    !isNullOrUndefined(handler) &&
+        sendMessageToParentWithVersion(getApiVersionTag(ApiVersionNumber.V_2, ApiName.RegisterBeforeUnloadHandler), 'registerHandler', ['beforeUnload']);
 }
 /**
  * @internal
@@ -5317,7 +5350,8 @@ function handlers_registerBeforeSuspendOrTerminateHandler(handler) {
  */
 function handlers_registerOnResumeHandler(handler) {
     HandlersPrivate.resumeHandler = handler;
-    !isNullOrUndefined(handler) && sendMessageToParent('registerHandler', ['load']);
+    !isNullOrUndefined(handler) &&
+        sendMessageToParentWithVersion(getApiVersionTag(ApiVersionNumber.V_2, ApiName.RegisterLoadHandler), 'registerHandler', ['load']);
 }
 
 ;// CONCATENATED MODULE: ./src/internal/nestedAppAuth.ts
@@ -6661,6 +6695,11 @@ function createTeamsDeepLinkForAppInstallDialog(appId) {
 
 
 
+
+/**
+ * v1 APIs telemetry file: All of APIs in this capability file should send out API version v1 ONLY
+ */
+const appInstallDialogTelemetryVersionNumber = ApiVersionNumber.V_1;
 var appInstallDialog;
 (function (appInstallDialog) {
     /**
@@ -6674,11 +6713,14 @@ var appInstallDialog;
             if (!isSupported()) {
                 throw new Error('Not supported');
             }
+            const apiVersionTag = getApiVersionTag(appInstallDialogTelemetryVersionNumber, ApiName.AppInstallDialog_OpenAppInstallDialog);
             if (runtime_runtime.isLegacyTeams) {
-                resolve(sendAndHandleStatusAndReason('executeDeepLink', createTeamsDeepLinkForAppInstallDialog(openAPPInstallDialogParams.appId)));
+                resolve(sendAndHandleStatusAndReasonWithVersion(apiVersionTag, 'executeDeepLink', createTeamsDeepLinkForAppInstallDialog(openAPPInstallDialogParams.appId)));
             }
             else {
-                sendMessageToParent('appInstallDialog.openAppInstallDialog', [openAPPInstallDialogParams]);
+                sendMessageToParentWithVersion(apiVersionTag, 'appInstallDialog.openAppInstallDialog', [
+                    openAPPInstallDialogParams,
+                ]);
                 resolve();
             }
         });
@@ -7891,6 +7933,11 @@ function getAdaptiveCardSchemaVersion() {
 
 
 
+
+/**
+ * v1 APIs telemetry file: All of APIs in this capability file should send out API version v1 ONLY
+ */
+const appWindowTelemetryVersionNumber = ApiVersionNumber.V_1;
 /**
  * An object that application can utilize to establish communication
  * with the child window it opened, which contains the corresponding task.
@@ -7904,7 +7951,7 @@ class ChildAppWindow {
      */
     postMessage(message, onComplete) {
         internalAPIs_ensureInitialized(runtime_runtime);
-        sendMessageToParent('messageForChild', [message], onComplete ? onComplete : getGenericOnCompleteHandler());
+        sendMessageToParentWithVersion(getApiVersionTag(appWindowTelemetryVersionNumber, ApiName.AppWindow_ChildAppWindow_PostMessage), 'messageForChild', [message], onComplete ? onComplete : getGenericOnCompleteHandler());
     }
     /**
      * Add a listener that will be called when an event is received from the ChildAppWindow.
@@ -7915,7 +7962,7 @@ class ChildAppWindow {
     addEventListener(type, listener) {
         internalAPIs_ensureInitialized(runtime_runtime);
         if (type === 'message') {
-            registerHandler('messageForParent', listener);
+            registerHandlerWithVersion(getApiVersionTag(appWindowTelemetryVersionNumber, ApiName.AppWindow_ChildAppWindow_AddEventListener), 'messageForParent', listener);
         }
     }
 }
@@ -7938,7 +7985,7 @@ class ParentAppWindow {
      */
     postMessage(message, onComplete) {
         internalAPIs_ensureInitialized(runtime_runtime, FrameContexts.task);
-        sendMessageToParent('messageForParent', [message], onComplete ? onComplete : getGenericOnCompleteHandler());
+        sendMessageToParentWithVersion(getApiVersionTag(appWindowTelemetryVersionNumber, ApiName.AppWindow_ParentAppWindow_PostMessage), 'messageForParent', [message], onComplete ? onComplete : getGenericOnCompleteHandler());
     }
     /**
      * Add a listener that will be called when an event is received from the ParentAppWindow.
@@ -7949,7 +7996,7 @@ class ParentAppWindow {
     addEventListener(type, listener) {
         internalAPIs_ensureInitialized(runtime_runtime, FrameContexts.task);
         if (type === 'message') {
-            registerHandler('messageForChild', listener);
+            registerHandlerWithVersion(getApiVersionTag(appWindowTelemetryVersionNumber, ApiName.AppWindow_ParentAppWindow_AddEventListener), 'messageForChild', listener);
         }
     }
 }
@@ -8854,11 +8901,12 @@ var calendar;
             if (!isSupported()) {
                 throw new Error('Not supported');
             }
+            const apiVersionTag = getApiVersionTag(calendarTelemetryVersionNumber, ApiName.Calendar_ComposeMeeting);
             if (runtime_runtime.isLegacyTeams) {
-                resolve(sendAndHandleStatusAndReason('executeDeepLink', createTeamsDeepLinkForCalendar(composeMeetingParams.attendees, composeMeetingParams.startTime, composeMeetingParams.endTime, composeMeetingParams.subject, composeMeetingParams.content)));
+                resolve(sendAndHandleStatusAndReasonWithVersion(apiVersionTag, 'executeDeepLink', createTeamsDeepLinkForCalendar(composeMeetingParams.attendees, composeMeetingParams.startTime, composeMeetingParams.endTime, composeMeetingParams.subject, composeMeetingParams.content)));
             }
             else {
-                resolve(sendAndHandleStatusAndReasonWithVersion(getApiVersionTag(calendarTelemetryVersionNumber, ApiName.Calendar_ComposeMeeting), 'calendar.composeMeeting', composeMeetingParams));
+                resolve(sendAndHandleStatusAndReasonWithVersion(apiVersionTag, 'calendar.composeMeeting', composeMeetingParams));
             }
         });
     }
@@ -9296,6 +9344,16 @@ var videoEffectsUtils_awaiter = (undefined && undefined.__awaiter) || function (
 
 
 
+
+/**
+ * @hidden
+ * Align with the W3C spec: https://www.w3.org/TR/webcodecs/
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ * v2 APIs telemetry file: All of APIs in this capability file should send out API version v2 ONLY
+ */
+const videoEffectsUtilTelemetryVersionNumber = ApiVersionNumber.V_2;
 /**
  * @hidden
  * Create a MediaStreamTrack from the media stream with the given streamId and processed by videoFrameHandler.
@@ -9606,7 +9664,7 @@ class TransformerWithMetadata {
                 },
             };
         });
-        registerHandler('video.mediaStream.audioInferenceDiscardStatusChange', ({ discardAudioInferenceResult }) => {
+        registerHandlerWithVersion(getApiVersionTag(videoEffectsUtilTelemetryVersionNumber, ApiName.VideoEffectsUtils_TransformerWithMetadata_Constructor), 'video.mediaStream.audioInferenceDiscardStatusChange', ({ discardAudioInferenceResult }) => {
             this.shouldDiscardAudioInferenceResult = discardAudioInferenceResult;
         });
     }
@@ -9620,11 +9678,11 @@ function createEffectParameterChangeCallback(callback, videoPerformanceMonitor)
         callback(effectId, effectParam)
             .then(() => {
             videoPerformanceMonitor === null || videoPerformanceMonitor === void 0 ? void 0 : videoPerformanceMonitor.reportVideoEffectChanged(effectId || '', effectParam);
-            sendMessageToParent('video.videoEffectReadiness', [true, effectId, undefined, effectParam]);
+            sendMessageToParentWithVersion(getApiVersionTag(videoEffectsUtilTelemetryVersionNumber, ApiName.VideoEffectsUtils_ReportVideoEffectChanged), 'video.videoEffectReadiness', [true, effectId, undefined, effectParam]);
         })
             .catch((reason) => {
             const validReason = reason in videoEffects.EffectFailureReason ? reason : videoEffects.EffectFailureReason.InitializationFailure;
-            sendMessageToParent('video.videoEffectReadiness', [false, effectId, validReason, effectParam]);
+            sendMessageToParentWithVersion(getApiVersionTag(videoEffectsUtilTelemetryVersionNumber, ApiName.VideoEffectsUtils_EffectFailure), 'video.videoEffectReadiness', [false, effectId, validReason, effectParam]);
         });
     };
 }
@@ -10776,10 +10834,14 @@ var call;
 
 ;// CONCATENATED MODULE: ./src/public/appInitialization.ts
 
+
 /**
  * @deprecated
  * As of 2.0.0, please use {@link app} namespace instead.
+ *
+ * v1 APIs telemetry file: All of APIs in this capability file should send out API version v1 ONLY
  */
+const appInitializationTelemetryVersionNumber = ApiVersionNumber.V_1;
 var appInitialization;
 (function (appInitialization) {
     /**
@@ -10807,7 +10869,7 @@ var appInitialization;
      * Notifies the frame that app has loaded and to hide the loading indicator if one is shown.
      */
     function notifyAppLoaded() {
-        app.notifyAppLoaded();
+        notifyAppLoadedHelper(getApiVersionTag(appInitializationTelemetryVersionNumber, ApiName.AppInitialization_NotifyAppLoaded));
     }
     appInitialization.notifyAppLoaded = notifyAppLoaded;
     /**
@@ -10817,7 +10879,7 @@ var appInitialization;
      * Notifies the frame that app initialization is successful and is ready for user interaction.
      */
     function notifySuccess() {
-        app.notifySuccess();
+        notifySuccessHelper(getApiVersionTag(appInitializationTelemetryVersionNumber, ApiName.AppInitialization_NotifySuccess));
     }
     appInitialization.notifySuccess = notifySuccess;
     /**
@@ -10829,7 +10891,7 @@ var appInitialization;
      * during initialization as well as an optional message.
      */
     function notifyFailure(appInitializationFailedRequest) {
-        app.notifyFailure(appInitializationFailedRequest);
+        notifyFailureHelper(getApiVersionTag(appInitializationTelemetryVersionNumber, ApiName.AppInitialization_NotifyFailure), appInitializationFailedRequest);
     }
     appInitialization.notifyFailure = notifyFailure;
     /**
@@ -10840,7 +10902,7 @@ var appInitialization;
      * @param expectedFailureRequest - The expected failure request containing the reason and an optional message
      */
     function notifyExpectedFailure(expectedFailureRequest) {
-        app.notifyExpectedFailure(expectedFailureRequest);
+        notifyExpectedFailureHelper(getApiVersionTag(appInitializationTelemetryVersionNumber, ApiName.AppInitialization_NotifyExpectedFailure), expectedFailureRequest);
     }
     appInitialization.notifyExpectedFailure = notifyExpectedFailure;
 })(appInitialization || (appInitialization = {}));