@microsoft/teams-js 2.17.1-beta.2 → 2.18.0-beta.0

package/dist/MicrosoftTeams.d.ts

@@ -502,6 +502,353 @@ export namespace conversations {
         function isSupported(): boolean;
 }
 
+/**
+    * @hidden
+    * Namespace to delegate authentication and message extension requests to the host
+    * @internal
+    * Limited to Microsoft-internal use
+    */
+export namespace externalAppAuthentication {
+        /**
+            * @hidden
+            * Information about the bot request that should be resent by the host
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type IOriginalRequestInfo = IQueryMessageExtensionRequest | IActionExecuteInvokeRequest;
+        /**
+            * @hidden
+            * Information about the message extension request that should be resent by the host. Corresponds to request schema in https://learn.microsoft.com/en-us/microsoftteams/platform/resources/messaging-extension-v3/search-extensions#receive-user-requests
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        interface IQueryMessageExtensionRequest {
+                requestType: OriginalRequestType.QueryMessageExtensionRequest;
+                commandId: string;
+                parameters?: {
+                        name?: string;
+                        value?: string;
+                }[];
+                queryOptions?: {
+                        count: number;
+                        skip: number;
+                };
+        }
+        /**
+            * @hidden
+            * Information about the Action.Execute request that should be resent by the host. Corresponds to schema in https://adaptivecards.io/explorer/Action.Execute.html
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        interface IActionExecuteInvokeRequest {
+                requestType: OriginalRequestType.ActionExecuteInvokeRequest;
+                type: string;
+                id: string;
+                verb: string;
+                data: string | Record<string, unknown>;
+        }
+        /**
+            * @hidden
+            * Used to differentiate between IOriginalRequestInfo types
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        enum OriginalRequestType {
+                ActionExecuteInvokeRequest = "ActionExecuteInvokeRequest",
+                QueryMessageExtensionRequest = "QueryMessageExtensionRequest"
+        }
+        /**
+            * @hidden
+            * The response from the bot returned via the host
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type IInvokeResponse = IQueryMessageExtensionResponse | IActionExecuteResponse;
+        /**
+            * @hidden
+            * Used to differentiate between IInvokeResponse types
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        enum InvokeResponseType {
+                ActionExecuteInvokeResponse = "ActionExecuteInvokeResponse",
+                QueryMessageExtensionResponse = "QueryMessageExtensionResponse"
+        }
+        /**
+            * @hidden
+            * The response from the bot returned via the host for a message extension query request.
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        interface IQueryMessageExtensionResponse {
+                responseType: InvokeResponseType.QueryMessageExtensionResponse;
+                composeExtension?: ComposeExtensionResponse;
+        }
+        /**
+            * @hidden
+            * The response from the bot returned via the host for an Action.Execute request.
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        interface IActionExecuteResponse {
+                responseType: InvokeResponseType.ActionExecuteInvokeResponse;
+                value: Record<string, unknown>;
+                signature?: string;
+                statusCode: number;
+                type: string;
+        }
+        /**
+            * @hidden
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type ComposeExtensionResponse = {
+                attachmentLayout: AttachmentLayout;
+                type: ComposeResultTypes;
+                attachments: QueryMessageExtensionAttachment[];
+                suggestedActions?: QueryMessageExtensionSuggestedActions;
+                text?: string;
+        };
+        /**
+            * @hidden
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type QueryMessageExtensionSuggestedActions = {
+                actions?: Action[];
+        };
+        /**
+            * @hidden
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type Action = {
+                type: string;
+                title: string;
+                value: string;
+        };
+        /**
+            * @hidden
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type QueryMessageExtensionCard = {
+                contentType: string;
+                content: Record<string, unknown>;
+                fallbackHtml?: string;
+                signature?: string;
+        };
+        /**
+            * @hidden
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type QueryMessageExtensionAttachment = QueryMessageExtensionCard & {
+                preview?: QueryMessageExtensionCard;
+        };
+        /**
+            * @hidden
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type AttachmentLayout = 'grid' | 'list';
+        /**
+            * @hidden
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type ComposeResultTypes = 'auth' | 'config' | 'message' | 'result' | 'silentAuth';
+        /*********** BEGIN ERROR TYPE ***********/
+        interface InvokeError {
+                errorCode: InvokeErrorCode;
+                message?: string;
+        }
+        /**
+            * @hidden
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        enum InvokeErrorCode {
+                INTERNAL_ERROR = "INTERNAL_ERROR"
+        }
+        /**
+            * @beta
+            * @hidden
+            * Signals to the host to perform authentication using the given authentication parameters and then resend the request to the application specified by the app ID with the authentication result.
+            * @internal
+            * Limited to Microsoft-internal use
+            * @param appId ID of the application backend to which the request and authentication response should be sent
+            * @param authenticateParameters Parameters for the authentication pop-up
+            * @param originalRequestInfo Information about the original request that should be resent
+            * @returns A promise that resolves to the IInvokeResponse from the application backend and rejects with InvokeError if the host encounters an error while authenticating or resending the request
+            */
+        function authenticateAndResendRequest(appId: string, authenticateParameters: authentication.AuthenticatePopUpParameters, originalRequestInfo: IOriginalRequestInfo): Promise<IInvokeResponse>;
+        /**
+            * @beta
+            * @hidden
+            * Signals to the host to perform SSO authentication for the application specified by the app ID
+            * @internal
+            * Limited to Microsoft-internal use
+            * @param appId ID of the application backend for which the host should attempt SSO authentication
+            * @param authTokenRequest Parameters for SSO authentication
+            * @returns A promise that resolves when authentication and succeeds and rejects with InvokeError on failure
+            */
+        function authenticateWithSSO(appId: string, authTokenRequest: authentication.AuthTokenRequestParameters): Promise<void>;
+        /**
+            * @beta
+            * @hidden
+            * Signals to the host to perform SSO authentication for the application specified by the app ID and then resend the request to the application backend with the authentication result
+            * @internal
+            * Limited to Microsoft-internal use
+            * @param appId ID of the application backend for which the host should attempt SSO authentication and resend the request and authentication response
+            * @param authTokenRequest Parameters for SSO authentication
+            * @param originalRequestInfo Information about the original request that should be resent
+            * @returns A promise that resolves to the IInvokeResponse from the application backend and rejects with InvokeError if the host encounters an error while authenticating or resending the request
+            */
+        function authenticateWithSSOAndResendRequest(appId: string, authTokenRequest: authentication.AuthTokenRequestParameters, originalRequestInfo: IOriginalRequestInfo): Promise<IInvokeResponse>;
+        /**
+            * @hidden
+            * Checks if the externalAppAuthentication capability is supported by the host
+            * @returns boolean to represent whether externalAppAuthentication capability is supported
+            *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        function isSupported(): boolean;
+}
+
+/**
+    * @hidden
+    * Namespace to delegate adaptive card action execution to the host
+    * @internal
+    * Limited to Microsoft-internal use
+    */
+export namespace externalAppCardActions {
+        /**
+            * @hidden
+            * The type of deeplink action that was executed by the host
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        enum ActionOpenUrlType {
+                DeepLinkDialog = "DeepLinkDialog",
+                DeepLinkOther = "DeepLinkOther",
+                DeepLinkStageView = "DeepLinkStageView",
+                GenericUrl = "GenericUrl"
+        }
+        /**
+            * @hidden
+            * Error that can be thrown from IExternalAppCardActionService.handleActionOpenUrl
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        interface ActionOpenUrlError {
+                errorCode: ActionOpenUrlErrorCode;
+                message?: string;
+        }
+        /**
+            * @hidden
+            * Error codes that can be thrown from IExternalAppCardActionService.handleActionOpenUrl
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        enum ActionOpenUrlErrorCode {
+                INVALID_LINK = "INVALID_LINK",
+                NOT_SUPPORTED = "NOT_SUPPORTED",
+                INTERNAL_ERROR = "INTERNAL_ERROR"
+        }
+        /**
+            * @hidden
+            * The payload that is used when executing an Adaptive Card Action.Submit
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        interface IAdaptiveCardActionSubmit {
+                id: string;
+                data: Record<string, unknown>;
+        }
+        /**
+            * @hidden
+            * The configuration for Adaptive Card Action.Submit. This indicates which subtypes of actions are supported by the calling app.
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        interface ICardActionsConfig {
+                enableImback: boolean;
+                enableInvoke: boolean;
+                enableDialog: boolean;
+                enableStageView: boolean;
+                enableSignIn: boolean;
+                enableO365Submit: boolean;
+        }
+        /**
+            *
+            * @hidden
+            * Error that can be thrown from IExternalAppCardActionService.handleActionSubmit
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        interface ActionSubmitError {
+                errorCode: ActionSubmitErrorCode;
+                message?: string;
+        }
+        /**
+            * @hidden
+            * Error codes that can be thrown from IExternalAppCardActionService.handleActionSubmit
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        enum ActionSubmitErrorCode {
+                INTERNAL_ERROR = "INTERNAL_ERROR"
+        }
+        /**
+            * @beta
+            * @hidden
+            * Delegates an Adaptive Card Action.Submit request to the host for the application with the provided app ID
+            * @internal
+            * Limited to Microsoft-internal use
+            * @param appId ID of the application the request is intended for
+            * @param actionSubmitPayload The Adaptive Card Action.Submit payload
+            * @param cardActionsConfig The card actions configuration. This indicates which subtypes should be handled by this API
+            * @returns Promise that resolves when the request is completed and rejects with ActionSubmitError if the request fails
+            */
+        function processActionSubmit(appId: string, actionSubmitPayload: IAdaptiveCardActionSubmit, cardActionsConfig: ICardActionsConfig): Promise<void>;
+        /**
+            * @beta
+            * @hidden
+            * Delegates an Adaptive Card Action.OpenUrl request to the host for the application with the provided app ID
+            * @internal
+            * Limited to Microsoft-internal use
+            * @param appId ID of the application the request is intended for
+            * @param url The URL to open
+            * @returns Promise that resolves to ActionOpenUrlType indicating the type of URL that was opened on success and rejects with ActionOpenUrlError if the request fails
+            */
+        function processActionOpenUrl(appId: string, url: string): Promise<ActionOpenUrlType>;
+        /**
+            * @hidden
+            * Checks if the externalAppCardActions capability is supported by the host
+            * @returns boolean to represent whether externalAppCardActions capability is supported
+            *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        function isSupported(): boolean;
+}
+
 /**
     * @hidden
     *
@@ -3690,6 +4037,7 @@ export interface SdkError {
          */
         message?: string;
 }
+export function isSdkError(err: unknown): err is SdkError;
 /** Error codes used to identify different types of errors that can occur while developing apps. */
 export enum ErrorCode {
         /**
@@ -6484,6 +6832,51 @@ export namespace meeting {
                     * @returns A promise with the updated microphone state
                     */
                 micMuteStateChangedCallback: (micState: MicState) => Promise<MicState>;
+                /**
+                    * Callback for the host to tell the app to change its speaker selection
+                    */
+                audioDeviceSelectionChangedCallback?: (selectedDevices: AudioDeviceSelection | SdkError) => void;
+        }
+        /**
+            * Interface for AudioDeviceSelection from host selection.
+            * If the speaker or the microphone is undefined or don't have a device label, you can try to find the default devices
+            * by using
+            * ```ts
+            * const devices = await navigator.mediaDevices.enumerateDevices();
+            * const defaultSpeaker = devices.find((d) => d.deviceId === 'default' && d.kind === 'audiooutput');
+            * const defaultMic = devices.find((d) => d.deviceId === 'default' && d.kind === 'audioinput');
+            * ```
+            *
+            * @hidden
+            * Hide from docs.
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            *
+            * @beta
+            */
+        interface AudioDeviceSelection {
+                speaker?: AudioDeviceInfo;
+                microphone?: AudioDeviceInfo;
+        }
+        /**
+            * Interface for AudioDeviceInfo, includes a device label with the same format as {@link MediaDeviceInfo.label}
+            *
+            * Hosted app can use this label to compare it with the device info fetched from {@link navigator.mediaDevices.enumerateDevices()}.
+            * {@link MediaDeviceInfo} has  {@link MediaDeviceInfo.deviceId} as an unique identifier, but that id is also unique to the origin
+            * of the calling application, so {@link MediaDeviceInfo.deviceId} cannot be used here as an identifier. Notice there are some cases
+            * that devices may have the same device label, but we don't have a better way to solve this, keep this as a known limitation for now.
+            *
+            * @hidden
+            * Hide from docs.
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            *
+            * @beta
+            */
+        interface AudioDeviceInfo {
+                deviceLabel: string;
         }
         /**
             * Different types of meeting reactions that can be sent/received