@microsoft/teams-js 2.31.0-beta.0 → 2.31.0-beta.2

package/dist/esm/packages/teams-js/dts/public/chat.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Describes information needed to start a chat
+ * @module
+ */
 interface OpenChatRequest {
     /**
      * An optional message used when initiating chat
@@ -35,32 +39,30 @@ export interface OpenGroupChatRequest extends OpenChatRequest {
 /**
  * Contains functionality to start chat with others
  */
-export declare namespace chat {
-    /**
-     * Allows the user to open a chat with a single user and allows
-     * for the user to specify the message they wish to send.
-     *
-     * @param openChatRequest: {@link OpenSingleChatRequest}- a request object that contains a user's email as well as an optional message parameter.
-     *
-     * @returns Promise resolved upon completion
-     */
-    function openChat(openChatRequest: OpenSingleChatRequest): Promise<void>;
-    /**
-     * Allows the user to create a chat with multiple users (2+) and allows
-     * for the user to specify a message and name the topic of the conversation. If
-     * only 1 user is provided into users array default back to origin openChat.
-     *
-     * @param openChatRequest: {@link OpenGroupChatRequest} - a request object that contains a list of user emails as well as optional parameters for message and topic (display name for the group chat).
-     *
-     * @returns Promise resolved upon completion
-     */
-    function openGroupChat(openChatRequest: OpenGroupChatRequest): Promise<void>;
-    /**
-     * Checks if the chat capability is supported by the host
-     * @returns boolean to represent whether the chat capability is supported
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
-     */
-    function isSupported(): boolean;
-}
+/**
+ * Allows the user to open a chat with a single user and allows
+ * for the user to specify the message they wish to send.
+ *
+ * @param openChatRequest: {@link OpenSingleChatRequest}- a request object that contains a user's email as well as an optional message parameter.
+ *
+ * @returns Promise resolved upon completion
+ */
+export declare function openChat(openChatRequest: OpenSingleChatRequest): Promise<void>;
+/**
+ * Allows the user to create a chat with multiple users (2+) and allows
+ * for the user to specify a message and name the topic of the conversation. If
+ * only 1 user is provided into users array default back to origin openChat.
+ *
+ * @param openChatRequest: {@link OpenGroupChatRequest} - a request object that contains a list of user emails as well as optional parameters for message and topic (display name for the group chat).
+ *
+ * @returns Promise resolved upon completion
+ */
+export declare function openGroupChat(openChatRequest: OpenGroupChatRequest): Promise<void>;
+/**
+ * Checks if the chat capability is supported by the host
+ * @returns boolean to represent whether the chat capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ */
+export declare function isSupported(): boolean;
 export {};

package/dist/esm/packages/teams-js/dts/public/clipboard.d.ts

@@ -2,6 +2,7 @@
  * Interact with the system clipboard
  *
  * @beta
+ * @module
  */
 /**
  * Function to copy data to clipboard.

package/dist/esm/packages/teams-js/dts/public/dialog/adaptiveCard/adaptiveCard.d.ts

@@ -0,0 +1,26 @@
+import { AdaptiveCardDialogInfo } from '../../interfaces';
+import { DialogSubmitHandler } from '../dialog';
+import * as bot from './bot';
+/**
+ * Allows app to open an adaptive card based dialog.
+ *
+ * @remarks
+ * This function cannot be called from inside of a dialog
+ *
+ * @param adaptiveCardDialogInfo - An object containing the parameters of the dialog module {@link AdaptiveCardDialogInfo}.
+ * @param submitHandler - Handler that triggers when a dialog fires an [Action.Submit](https://adaptivecards.io/explorer/Action.Submit.html) or when the user closes the dialog.
+ *
+ * @beta
+ */
+export declare function open(adaptiveCardDialogInfo: AdaptiveCardDialogInfo, submitHandler?: DialogSubmitHandler): void;
+/**
+ * Checks if dialog.adaptiveCard module is supported by the host
+ *
+ * @returns boolean to represent whether dialog.adaptiveCard module is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @beta
+ */
+export declare function isSupported(): boolean;
+export { bot };

package/dist/esm/packages/teams-js/dts/public/dialog/adaptiveCard/bot.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Module for interaction with adaptive card dialogs that need to communicate with the bot framework
+ *
+ * @beta
+ * @module
+ */
+import { BotAdaptiveCardDialogInfo } from '../../interfaces';
+import { DialogSubmitHandler } from '../dialog';
+/**
+ * Allows an app to open an adaptive card-based dialog module using bot.
+ *
+ * @param botAdaptiveCardDialogInfo - An object containing the parameters of the dialog module including completionBotId.
+ * @param submitHandler - Handler that triggers when the dialog has been submitted or closed.
+ *
+ * @beta
+ */
+export declare function open(botAdaptiveCardDialogInfo: BotAdaptiveCardDialogInfo, submitHandler?: DialogSubmitHandler): void;
+/**
+ * Checks if dialog.adaptiveCard.bot capability is supported by the host
+ *
+ * @returns boolean to represent whether dialog.adaptiveCard.bot is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @beta
+ */
+export declare function isSupported(): boolean;

package/dist/esm/packages/teams-js/dts/public/dialog/dialog.d.ts

@@ -0,0 +1,56 @@
+import * as adaptiveCard from './adaptiveCard/adaptiveCard';
+import * as update from './update';
+import * as url from './url/url';
+/**
+ * Data Structure to represent the SDK response when dialog closes
+ *
+ * @beta
+ */
+export interface ISdkResponse {
+    /**
+     * Error in case there is a failure before dialog submission
+     */
+    err?: string;
+    /**
+     * Value provided in the `result` parameter by the dialog when the {@linkcode url.submit} function
+     * was called.
+     * If the dialog was closed by the user without submitting (e.g., using a control in the corner
+     * of the dialog), this value will be `undefined` here.
+     */
+    result?: string | object;
+}
+/**
+ * Handler used to receive and process messages sent between a dialog and the app that launched it
+ * @beta
+ */
+export type PostMessageChannel = (message: any) => void;
+/**
+ * Handler used for receiving results when a dialog closes, either the value passed by {@linkcode url.submit}
+ * or an error if the dialog was closed by the user.
+ *
+ * @see {@linkcode ISdkResponse}
+ *
+ * @beta
+ */
+export type DialogSubmitHandler = (result: ISdkResponse) => void;
+/**
+ * @hidden
+ * Hide from docs because this function is only used during initialization
+ *
+ * Adds register handlers for messageForChild upon initialization and only in the tasks FrameContext. {@link FrameContexts.task}
+ * Function is called during app initialization
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @beta
+ */
+export declare function initialize(): void;
+/**
+ * This function currently serves no purpose and should not be used. All functionality that used
+ * to be covered by this method is now in subcapabilities and those isSupported methods should be
+ * used directly.
+ *
+ * @hidden
+ */
+export declare function isSupported(): boolean;
+export { adaptiveCard, url, update };

package/dist/esm/packages/teams-js/dts/public/dialog/update.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Module to update the dialog
+ *
+ * @beta
+ * @module
+ */
+import { DialogSize } from '../interfaces';
+/**
+ * Update dimensions - height/width of a dialog.
+ *
+ * @param dimensions - An object containing width and height properties.
+ *
+ * @beta
+ */
+export declare function resize(dimensions: DialogSize): void;
+/**
+ * Checks if dialog.update capability is supported by the host
+ * @returns boolean to represent whether dialog.update capabilty is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @beta
+ */
+export declare function isSupported(): boolean;

package/dist/esm/packages/teams-js/dts/public/dialog/url/bot.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Module to open a dialog that sends results to the bot framework
+ *
+ * @beta
+ * @module
+ */
+import { BotUrlDialogInfo } from '../../interfaces';
+import { DialogSubmitHandler, PostMessageChannel } from '../dialog';
+/**
+ * Allows an app to open a dialog that sends submitted data to a bot.
+ *
+ * @param botUrlDialogInfo - An object containing the parameters of the dialog module including completionBotId.
+ * @param submitHandler - Handler that triggers when the dialog has been submitted or closed.
+ * @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
+ *
+ * @returns a function that can be used to send messages to the dialog.
+ *
+ * @beta
+ */
+export declare function open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void;
+/**
+ * Checks if dialog.url.bot capability is supported by the host
+ *
+ * @returns boolean to represent whether dialog.url.bot is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @beta
+ */
+export declare function isSupported(): boolean;

package/dist/esm/packages/teams-js/dts/public/dialog/url/parentCommunication.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Subcapability that allows communication between the dialog and the parent app.
+ *
+ * @remarks
+ * Note that dialog can be invoked from parentless scenarios e.g. Search Message Extensions. The subcapability `parentCommunication` is not supported in such scenarios.
+ *
+ * @beta
+ * @module
+ */
+import { PostMessageChannel } from '../dialog';
+/**
+ *  Send message to the parent from dialog
+ *
+ * @remarks
+ * This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
+ *
+ * @param message - The message to send to the parent
+ *
+ * @beta
+ */
+export declare function sendMessageToParentFromDialog(message: any): void;
+/**
+ *  Send message to the dialog from the parent
+ *
+ * @param message - The message to send
+ *
+ * @beta
+ */
+export declare function sendMessageToDialog(message: any): void;
+/**
+ * Register a listener that will be triggered when a message is received from the app that opened the dialog.
+ *
+ * @remarks
+ * This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
+ *
+ * @param listener - The listener that will be triggered.
+ *
+ * @beta
+ */
+export declare function registerOnMessageFromParent(listener: PostMessageChannel): void;
+/**
+ * Checks if dialog.url.parentCommunication capability is supported by the host
+ *
+ * @returns boolean to represent whether dialog.url.parentCommunication capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @beta
+ */
+export declare function isSupported(): boolean;

package/dist/esm/packages/teams-js/dts/public/dialog/url/url.d.ts

@@ -0,0 +1,60 @@
+import { BotUrlDialogInfo, DialogInfo, UrlDialogInfo } from '../../interfaces';
+import { DialogSubmitHandler, PostMessageChannel } from '../dialog';
+import * as bot from './bot';
+import * as parentCommunication from './parentCommunication';
+/**
+ * Allows app to open a url based dialog.
+ *
+ * @remarks
+ * This function cannot be called from inside of a dialog
+ *
+ * @param urlDialogInfo - An object containing the parameters of the dialog module.
+ * @param submitHandler - Handler that triggers when a dialog calls the {@linkcode submit} function or when the user closes the dialog.
+ * @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
+ *
+ * @beta
+ */
+export declare function open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void;
+/**
+ * Submit the dialog module and close the dialog
+ *
+ * @remarks
+ * This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
+ *
+ * @param result - The result to be sent to the bot or the app. Typically a JSON object or a serialized version of it,
+ *  If this function is called from a dialog while {@link M365ContentAction} is set in the context object by the host, result will be ignored
+ *
+ * @param appIds - Valid application(s) that can receive the result of the submitted dialogs. Specifying this parameter helps prevent malicious apps from retrieving the dialog result. Multiple app IDs can be specified because a web app from a single underlying domain can power multiple apps across different environments and branding schemes.
+ *
+ * @beta
+ */
+export declare function submit(result?: string | object, appIds?: string | string[]): void;
+/**
+ * Checks if dialog.url module is supported by the host
+ *
+ * @returns boolean to represent whether dialog.url module is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @beta
+ */
+export declare function isSupported(): boolean;
+/**
+ * @hidden
+ *
+ * Convert UrlDialogInfo to DialogInfo to send the information to host in {@linkcode open} API.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function getDialogInfoFromUrlDialogInfo(urlDialogInfo: UrlDialogInfo): DialogInfo;
+/**
+ * @hidden
+ *
+ * Convert BotUrlDialogInfo to DialogInfo to send the information to host in {@linkcode bot.open} API.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function getDialogInfoFromBotUrlDialogInfo(botUrlDialogInfo: BotUrlDialogInfo): DialogInfo;
+export { bot, parentCommunication };

package/dist/esm/packages/teams-js/dts/public/geoLocation/geoLocation.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Module to interact with the geoLocation module-specific part of the SDK. This is the newer version of location module.
+ *
+ * @beta
+ * @module
+ */
+import * as map from './map';
+/**
+ * Data struture to represent the location information
+ *
+ * @beta
+ */
+export interface Location {
+    /**
+        Latitude of the location
+        */
+    latitude: number;
+    /**
+        Longitude of the location
+        */
+    longitude: number;
+    /**
+        Accuracy describes the maximum distance in meters from the captured coordinates to the possible actual location
+        @remarks
+        This property is only in scope for mobile
+        */
+    accuracy?: number;
+    /**
+        Time stamp when the location was captured
+        */
+    timestamp?: number;
+}
+/**
+ * Fetches current user coordinates
+ * @returns Promise that will resolve with {@link geoLocation.Location} object or reject with an error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
+ *
+ * @beta
+ */
+export declare function getCurrentLocation(): Promise<Location>;
+/**
+ * Checks whether or not location has user permission
+ *
+ * @returns Promise that will resolve with true if the user had granted the app permission to location information, or with false otherwise,
+ * In case of an error, promise will reject with the error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
+ *
+ * @beta
+ */
+export declare function hasPermission(): Promise<boolean>;
+/**
+ * Requests user permission for location
+ *
+ * @returns true if the user consented permission for location, false otherwise
+ * @returns Promise that will resolve with true if the user consented permission for location, or with false otherwise,
+ * In case of an error, promise will reject with the error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
+ *
+ * @beta
+ */
+export declare function requestPermission(): Promise<boolean>;
+/**
+ * Checks if geoLocation capability is supported by the host
+ * @returns boolean to represent whether geoLocation is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @beta
+ */
+export declare function isSupported(): boolean;
+export { map };

package/dist/esm/packages/teams-js/dts/public/geoLocation/map.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Module to interact with the location on map module-specific part of the SDK.
+ *
+ * @beta
+ * @module
+ */
+import { Location } from './geoLocation';
+/**
+ * Allows user to choose location on map
+ *
+ * @returns Promise that will resolve with {@link geoLocation.Location} object chosen by the user or reject with an error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
+ *
+ * @beta
+ */
+export declare function chooseLocation(): Promise<Location>;
+/**
+ * Shows the location on map corresponding to the given coordinates
+ *
+ * @param location - Location to be shown on the map
+ * @returns Promise that resolves when the location dialog has been closed or reject with an error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
+ *
+ * @beta
+ */
+export declare function showLocation(location: Location): Promise<void>;
+/**
+ * Checks if geoLocation.map capability is supported by the host
+ * @returns boolean to represent whether geoLocation.map is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @beta
+ */
+export declare function isSupported(): boolean;

package/dist/esm/packages/teams-js/dts/public/index.d.ts

@@ -1,44 +1,46 @@
 export * as authentication from './authentication';
 export { ChannelType, DialogDimension, FrameContexts, HostClientType, HostName, TaskModuleDimension, TeamType, UserTeamRole, } from './constants';
-export { ActionInfo, ActionObjectType, AdaptiveCardVersion, AdaptiveCardDialogInfo, BaseActionObject, BotAdaptiveCardDialogInfo, BotUrlDialogInfo, Context, DeepLinkParameters, DialogInfo, DialogSize, ErrorCode, FileOpenPreference, FrameContext, FrameInfo, LoadContext, LocaleInfo, M365ContentAction, ResumeContext, SdkError, SecondaryId, SecondaryM365ContentIdName, ShareDeepLinkParameters, TabInformation, TabInstance, TabInstanceParameters, TaskInfo, TeamInformation, UrlDialogInfo, } from './interfaces';
-export * as app from './app';
+export { ActionInfo, ActionObjectType, AdaptiveCardVersion, AdaptiveCardDialogInfo, BaseActionObject, BotAdaptiveCardDialogInfo, BotUrlDialogInfo, Context, DeepLinkParameters, DialogInfo, DialogSize, ErrorCode, FileOpenPreference, FrameContext, FrameInfo, HostToAppPerformanceMetrics, LoadContext, LocaleInfo, M365ContentAction, ResumeContext, SdkError, SecondaryId, SecondaryM365ContentIdName, ShareDeepLinkParameters, TabInformation, TabInstance, TabInstanceParameters, TaskInfo, TeamInformation, UrlDialogInfo, } from './interfaces';
+export * as app from './app/app';
 export { AppId } from './appId';
 export { EmailAddress } from './emailAddress';
 export * as appInstallDialog from './appInstallDialog';
 export * as barCode from './barCode';
-export { chat, OpenGroupChatRequest, OpenSingleChatRequest } from './chat';
+export * as chat from './chat';
+export { OpenGroupChatRequest, OpenSingleChatRequest } from './chat';
 export * as clipboard from './clipboard';
-export { dialog } from './dialog';
-export { nestedAppAuth } from './nestedAppAuth';
-export { geoLocation } from './geoLocation';
+export * as dialog from './dialog/dialog';
+export * as nestedAppAuth from './nestedAppAuth';
+export * as geoLocation from './geoLocation/geoLocation';
 export { getAdaptiveCardSchemaVersion } from './adaptiveCards';
-export { pages } from './pages';
+export * as pages from './pages/pages';
 export { addEventListnerFunctionType, ChildAppWindow, IAppWindow, onCompleteFunctionType, ParentAppWindow, } from './appWindow';
-export { menus } from './menus';
-export { media } from './media';
-export { secondaryBrowser } from './secondaryBrowser';
-export { location } from './location';
-export { meeting } from './meeting';
-export { monetization } from './monetization';
+export * as menus from './menus';
+export * as media from './media';
+export * as secondaryBrowser from './secondaryBrowser';
+export * as location from './location';
+export * as meeting from './meeting/meeting';
+export * as monetization from './monetization';
 export * as calendar from './calendar';
-export { mail } from './mail';
-export { teamsCore } from './teamsAPIs';
-export { people } from './people';
-export { profile } from './profile';
-export { videoEffects } from './videoEffects';
-export { search } from './search';
-export { sharing } from './sharing';
-export { stageView } from './stageView';
+export * as mail from './mail';
+export * as teamsCore from './teamsAPIs';
+export * as people from './people';
+export * as profile from './profile';
+export * as videoEffects from './videoEffects';
+export * as search from './search';
+export * as sharing from './sharing/sharing';
+export * as stageView from './stageView/stageView';
 export { version } from './version';
-export { visualMedia } from './visualMedia';
-export { webStorage } from './webStorage';
+export * as visualMedia from './visualMedia/visualMedia';
+export * as webStorage from './webStorage';
 export * as call from './call';
 export * as appInitialization from './appInitialization';
-export { thirdPartyCloudStorage } from './thirdPartyCloudStorage';
+export * as thirdPartyCloudStorage from './thirdPartyCloudStorage';
 export { callbackFunctionType, enablePrintCapability, executeDeepLink, executeDeepLinkOnCompleteFunctionType, getContext, getContextCallbackFunctionType, getMruTabInstances, getTabInstances, getTabInstancesCallbackFunctionType, initialize, initializeWithFrameContext, print, registerAppButtonClickHandler, registerAppButtonHoverEnterHandler, registerAppButtonHoverLeaveHandler, registerBackButtonHandler, registerBackButtonHandlerFunctionType, registerBeforeUnloadHandler, registerChangeSettingsHandler, registerFocusEnterHandler, registerFullScreenHandler, registerFullScreenHandlerFunctionType, registerOnLoadHandler, registerOnThemeChangeHandler, registerOnThemeChangeHandlerFunctionType, setFrameContext, shareDeepLink, } from './publicAPIs';
 export { navigateBack, navigateCrossDomain, navigateToTab, onCompleteHandlerFunctionType, returnFocus, } from './navigation';
 export * as settings from './settings';
-export { tasks } from './tasks';
-export { liveShare, LiveShareHost } from './liveShareHost';
-export { marketplace } from './marketplace';
+export * as tasks from './tasks';
+export * as liveShare from './liveShareHost';
+export { LiveShareHost } from './liveShareHost';
+export * as marketplace from './marketplace';
 export { ISerializable } from './serializable.interface';

package/dist/esm/packages/teams-js/dts/public/interfaces.d.ts

@@ -622,9 +622,20 @@ export interface Context {
      * @deprecated
      * As of TeamsJS v2.0.0, please use {@link app.AppInfo.userClickTime | app.Context.app.userClickTime} instead
      *
-     * Time when the user clicked on the tab
+     * Time when the user clicked on the tab using the date.
+     *
+     * For measuring elapsed time between the moment the user click the tab, use {@link app.AppInfo.userClickTimeV2 | app.Context.app.userClickTimeV2} instead as it uses the performance timer API.
      */
     userClickTime?: number;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.AppInfo.userClickTimeV2 | app.Context.app.userClickTimeV2} instead
+     *
+     * Time when the user click on the app by using the performance timer API. Useful for measuring elapsed time accurately.
+     *
+     * For displaying the time when the user clicked on the app, please use {@link app.AppInfo.userClickTime | app.Context.app.userClickTime} as it uses the date.
+     */
+    userClickTimeV2?: number;
     /**
      * @deprecated
      * As of TeamsJS v2.0.0, please use {@link app.TeamInfo.templateId | app.Context.team.templateId} instead
@@ -1131,3 +1142,14 @@ export interface ClipboardParams {
     /** Blob content in Base64 string format */
     content: string;
 }
+/**
+ * Meant for passing data to the app related to host-to-app message performance metrics.
+ */
+export interface HostToAppPerformanceMetrics {
+    /** The name of the action the host is responding to. */
+    actionName: string;
+    /** The delay the message took traveling from host to app */
+    messageDelay: number;
+    /** The time when the request was dispatched */
+    requestStartedAt: number;
+}