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

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

@@ -1,32 +1,33 @@
 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 * 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 { addEventListnerFunctionType, ChildAppWindow, IAppWindow, onCompleteFunctionType, ParentAppWindow, } from './appWindow';
-export { menus } from './menus';
-export { media } from './media';
-export { secondaryBrowser } from './secondaryBrowser';
-export { location } from './location';
+export * as menus from './menus';
+export * as media from './media';
+export * as secondaryBrowser from './secondaryBrowser';
+export * as location from './location';
 export { meeting } from './meeting';
-export { monetization } from './monetization';
+export * as monetization from './monetization';
 export * as calendar from './calendar';
-export { mail } from './mail';
-export { teamsCore } from './teamsAPIs';
-export { people } from './people';
+export * as mail from './mail';
+export * as teamsCore from './teamsAPIs';
+export * as people from './people';
 export { profile } from './profile';
 export { videoEffects } from './videoEffects';
-export { search } from './search';
+export * as search from './search';
 export { sharing } from './sharing';
 export { stageView } from './stageView';
 export { version } from './version';
@@ -34,11 +35,12 @@ export { visualMedia } from './visualMedia';
 export { 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

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

@@ -4,143 +4,141 @@
  *
  * @see LiveShareHost
  */
-export declare namespace liveShare {
+/**
+ * @hidden
+ * The meeting roles of a user.
+ * Used in Live Share for its role verification feature.
+ * For more information, visit https://learn.microsoft.com/microsoftteams/platform/apps-in-teams-meetings/teams-live-share-capabilities?tabs=javascript#role-verification-for-live-data-structures
+ */
+export declare enum UserMeetingRole {
     /**
-     * @hidden
-     * The meeting roles of a user.
-     * Used in Live Share for its role verification feature.
-     * For more information, visit https://learn.microsoft.com/microsoftteams/platform/apps-in-teams-meetings/teams-live-share-capabilities?tabs=javascript#role-verification-for-live-data-structures
-     */
-    enum UserMeetingRole {
-        /**
-         * Guest role.
-         */
-        guest = "Guest",
-        /**
-         * Attendee role.
-         */
-        attendee = "Attendee",
-        /**
-         * Presenter role.
-         */
-        presenter = "Presenter",
-        /**
-         * Organizer role.
-         */
-        organizer = "Organizer"
-    }
+     * Guest role.
+     */
+    guest = "Guest",
     /**
-     * @hidden
-     * State of the current Live Share session's Fluid container.
-     * This is used internally by the `LiveShareClient` when joining a Live Share session.
-     */
-    enum ContainerState {
-        /**
-         * The call to `LiveShareHost.setContainerId()` successfully created the container mapping
-         * for the current Live Share session.
-         */
-        added = "Added",
-        /**
-         * A container mapping for the current Live Share session already exists.
-         * This indicates to Live Share that a new container does not need be created.
-         */
-        alreadyExists = "AlreadyExists",
-        /**
-         * The call to `LiveShareHost.setContainerId()` failed to create the container mapping.
-         * This happens when another client has already set the container ID for the session.
-         */
-        conflict = "Conflict",
-        /**
-         * A container mapping for the current Live Share session does not yet exist.
-         * This indicates to Live Share that a new container should be created.
-         */
-        notFound = "NotFound"
-    }
+     * Attendee role.
+     */
+    attendee = "Attendee",
     /**
-     * @hidden
-     * Returned from `LiveShareHost.getFluidContainerId()` and `LiveShareHost.setFluidContainerId`.
-     * This response specifies the container mapping information for the current Live Share session.
-     */
-    interface IFluidContainerInfo {
-        /**
-         * State of the containerId mapping.
-         */
-        containerState: ContainerState;
-        /**
-         * ID of the container to join for the meeting. Undefined if the container hasn't been
-         * created yet.
-         */
-        containerId: string | undefined;
-        /**
-         * If true, the local client should create the container and then save the created containers
-         * ID to the mapping service.
-         */
-        shouldCreate: boolean;
-        /**
-         * If `containerId` is undefined and `shouldCreate` is false, the container isn't ready
-         * but another client is creating it. In this case, the local client should wait the specified
-         * amount of time before calling `LiveShareHost.getFluidContainerId()` again.
-         */
-        retryAfter: number;
-    }
+     * Presenter role.
+     */
+    presenter = "Presenter",
     /**
-     * @hidden
-     * Returned from `LiveShareHost.getNtpTime()` to specify the global timestamp for the current
-     * Live Share session.
-     */
-    interface INtpTimeInfo {
-        /**
-         * ISO 8601 formatted server time. For example: '2019-09-07T15:50-04:00'
-         */
-        ntpTime: string;
-        /**
-         * Server time expressed as the number of milliseconds since the ECMAScript epoch.
-         */
-        ntpTimeInUTC: number;
-    }
+     * Organizer role.
+     */
+    organizer = "Organizer"
+}
+/**
+ * @hidden
+ * State of the current Live Share session's Fluid container.
+ * This is used internally by the `LiveShareClient` when joining a Live Share session.
+ */
+export declare enum ContainerState {
     /**
-     * @hidden
-     * Returned from `LiveShareHost.getFluidTenantInfo()` to specify the Fluid service to use for the
-     * current Live Share session.
-     */
-    interface IFluidTenantInfo {
-        /**
-         * The Fluid Tenant ID Live Share should use.
-         */
-        tenantId: string;
-        /**
-         * The Fluid service endpoint Live Share should use.
-         */
-        serviceEndpoint: string;
-    }
+     * The call to `LiveShareHost.setContainerId()` successfully created the container mapping
+     * for the current Live Share session.
+     */
+    added = "Added",
     /**
-     * @hidden
-     * Returned from `LiveShareHost.getClientInfo()` to specify the client info for a
-     * particular client in a Live Share session.
-     */
-    interface IClientInfo {
-        /**
-         * The host user's `userId` associated with a given `clientId`
-         */
-        userId: string;
-        /**
-         * User's meeting roles associated with a given `clientId`
-         */
-        roles: UserMeetingRole[];
-        /**
-         * The user's display name associated with a given `clientId`.
-         * If this returns as `undefined`, the user may need to update their host client.
-         */
-        displayName?: string;
-    }
-    /**
-     * Checks if the interactive capability is supported by the host
-     * @returns boolean to represent whether the interactive capability is supported
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
+     * A container mapping for the current Live Share session already exists.
+     * This indicates to Live Share that a new container does not need be created.
+     */
+    alreadyExists = "AlreadyExists",
+    /**
+     * The call to `LiveShareHost.setContainerId()` failed to create the container mapping.
+     * This happens when another client has already set the container ID for the session.
+     */
+    conflict = "Conflict",
+    /**
+     * A container mapping for the current Live Share session does not yet exist.
+     * This indicates to Live Share that a new container should be created.
+     */
+    notFound = "NotFound"
+}
+/**
+ * @hidden
+ * Returned from `LiveShareHost.getFluidContainerId()` and `LiveShareHost.setFluidContainerId`.
+ * This response specifies the container mapping information for the current Live Share session.
+ */
+export interface IFluidContainerInfo {
+    /**
+     * State of the containerId mapping.
+     */
+    containerState: ContainerState;
+    /**
+     * ID of the container to join for the meeting. Undefined if the container hasn't been
+     * created yet.
+     */
+    containerId: string | undefined;
+    /**
+     * If true, the local client should create the container and then save the created containers
+     * ID to the mapping service.
+     */
+    shouldCreate: boolean;
+    /**
+     * If `containerId` is undefined and `shouldCreate` is false, the container isn't ready
+     * but another client is creating it. In this case, the local client should wait the specified
+     * amount of time before calling `LiveShareHost.getFluidContainerId()` again.
      */
-    function isSupported(): boolean;
+    retryAfter: number;
 }
+/**
+ * @hidden
+ * Returned from `LiveShareHost.getNtpTime()` to specify the global timestamp for the current
+ * Live Share session.
+ */
+export interface INtpTimeInfo {
+    /**
+     * ISO 8601 formatted server time. For example: '2019-09-07T15:50-04:00'
+     */
+    ntpTime: string;
+    /**
+     * Server time expressed as the number of milliseconds since the ECMAScript epoch.
+     */
+    ntpTimeInUTC: number;
+}
+/**
+ * @hidden
+ * Returned from `LiveShareHost.getFluidTenantInfo()` to specify the Fluid service to use for the
+ * current Live Share session.
+ */
+export interface IFluidTenantInfo {
+    /**
+     * The Fluid Tenant ID Live Share should use.
+     */
+    tenantId: string;
+    /**
+     * The Fluid service endpoint Live Share should use.
+     */
+    serviceEndpoint: string;
+}
+/**
+ * @hidden
+ * Returned from `LiveShareHost.getClientInfo()` to specify the client info for a
+ * particular client in a Live Share session.
+ */
+export interface IClientInfo {
+    /**
+     * The host user's `userId` associated with a given `clientId`
+     */
+    userId: string;
+    /**
+     * User's meeting roles associated with a given `clientId`
+     */
+    roles: UserMeetingRole[];
+    /**
+     * The user's display name associated with a given `clientId`.
+     * If this returns as `undefined`, the user may need to update their host client.
+     */
+    displayName?: string;
+}
+/**
+ * Checks if the interactive capability is supported by the host
+ * @returns boolean to represent whether the interactive capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ */
+export declare function isSupported(): boolean;
 /**
  * Live Share host implementation for connecting to real-time collaborative sessions.
  * Designed for use with the `LiveShareClient` class in the `@microsoft/live-share` package.
@@ -155,7 +153,7 @@ export declare class LiveShareHost {
      * @hidden
      * Returns the Fluid Tenant connection info for user's current context.
      */
-    getFluidTenantInfo(): Promise<liveShare.IFluidTenantInfo>;
+    getFluidTenantInfo(): Promise<IFluidTenantInfo>;
     /**
      * @hidden
      * Returns the fluid access token for mapped container Id.
@@ -168,7 +166,7 @@ export declare class LiveShareHost {
      * @hidden
      * Returns the ID of the fluid container associated with the user's current context.
      */
-    getFluidContainerId(): Promise<liveShare.IFluidContainerInfo>;
+    getFluidContainerId(): Promise<IFluidContainerInfo>;
     /**
      * @hidden
      * Sets the ID of the fluid container associated with the current context.
@@ -179,12 +177,12 @@ export declare class LiveShareHost {
      * @param containerId ID of the fluid container the client created.
      * @returns A data structure with a `containerState` indicating the success or failure of the request.
      */
-    setFluidContainerId(containerId: string): Promise<liveShare.IFluidContainerInfo>;
+    setFluidContainerId(containerId: string): Promise<IFluidContainerInfo>;
     /**
      * @hidden
      * Returns the shared clock server's current time.
      */
-    getNtpTime(): Promise<liveShare.INtpTimeInfo>;
+    getNtpTime(): Promise<INtpTimeInfo>;
     /**
      * @hidden
      * Associates the fluid client ID with a set of user roles.
@@ -192,7 +190,7 @@ export declare class LiveShareHost {
      * @param clientId The ID for the current user's Fluid client. Changes on reconnects.
      * @returns The roles for the current user.
      */
-    registerClientId(clientId: string): Promise<liveShare.UserMeetingRole[]>;
+    registerClientId(clientId: string): Promise<UserMeetingRole[]>;
     /**
      * @hidden
      * Returns the roles associated with a client ID.
@@ -200,7 +198,7 @@ export declare class LiveShareHost {
      * @param clientId The Client ID the message was received from.
      * @returns The roles for a given client. Returns `undefined` if the client ID hasn't been registered yet.
      */
-    getClientRoles(clientId: string): Promise<liveShare.UserMeetingRole[] | undefined>;
+    getClientRoles(clientId: string): Promise<UserMeetingRole[] | undefined>;
     /**
      * @hidden
      * Returns the `IClientInfo` associated with a client ID.
@@ -208,7 +206,7 @@ export declare class LiveShareHost {
      * @param clientId The Client ID the message was received from.
      * @returns The info for a given client. Returns `undefined` if the client ID hasn't been registered yet.
      */
-    getClientInfo(clientId: string): Promise<liveShare.IClientInfo | undefined>;
+    getClientInfo(clientId: string): Promise<IClientInfo | undefined>;
     /**
      * Factories a new `LiveShareHost` instance for use with the `LiveShareClient` class
      * in the `@microsoft/live-share` package.

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

@@ -3,84 +3,82 @@ import { SdkError } from './interfaces';
  * @deprecated
  * As of 2.1.0, please use geoLocation namespace.
  *
- * Namespace to interact with the location module-specific part of the SDK.
+ * Module to interact with the location module-specific part of the SDK.
  */
-export declare namespace location {
-    /** Get location callback function type */
-    type getLocationCallbackFunctionType = (error: SdkError, location: Location) => void;
-    /** Show location callback function type */
-    type showLocationCallbackFunctionType = (error: SdkError, status: boolean) => void;
+/** Get location callback function type */
+export type getLocationCallbackFunctionType = (error: SdkError, location: Location) => void;
+/** Show location callback function type */
+export type showLocationCallbackFunctionType = (error: SdkError, status: boolean) => void;
+/**
+ * @deprecated
+ * Data Structure to set the location properties in getLocation call.
+ */
+export interface LocationProps {
     /**
-     * @deprecated
-     * Data Structure to set the location properties in getLocation call.
-     */
-    interface LocationProps {
-        /**
-        whether user can alter location or not
-        if false, user will be shown current location
-        and wouldn't be allowed to alter it
-        */
-        allowChooseLocation: boolean;
-        /**
-        whether selected location should be shown to user on map or not.
-        If allowChooseLocation is true, this parameter will be ignored by platform.
-        If allowChooseLocation is false, and this parameter is not provided, default
-        value will be false.
-        */
-        showMap?: boolean;
-    }
+      whether user can alter location or not
+      if false, user will be shown current location
+      and wouldn't be allowed to alter it
+      */
+    allowChooseLocation: boolean;
+    /**
+      whether selected location should be shown to user on map or not.
+      If allowChooseLocation is true, this parameter will be ignored by platform.
+      If allowChooseLocation is false, and this parameter is not provided, default
+      value will be false.
+      */
+    showMap?: boolean;
+}
+/**
+ * @deprecated
+ * Data struture to represent the location information
+ */
+export interface Location {
     /**
-     * @deprecated
-     * Data struture to represent the location information
-     */
-    interface Location {
-        /**
-        Latitude of the location
-        */
-        latitude: number;
-        /**
-        Longitude of the location
-        */
-        longitude: number;
-        /**
-        Accuracy of the coordinates captured
-        */
-        accuracy?: number;
-        /**
-        Time stamp when the location was captured
-        */
-        timestamp?: number;
-    }
+      Latitude of the location
+      */
+    latitude: number;
     /**
-     * @deprecated
-     * As of 2.1.0, please use one of the following functions:
-     * - {@link geoLocation.getCurrentLocation geoLocation.getCurrentLocation(): Promise\<Location\>} to get the current location.
-     * - {@link geoLocation.map.chooseLocation geoLocation.map.chooseLocation(): Promise\<Location\>} to choose location on map.
-     *
-     * Fetches user location
-     * @param props {@link LocationProps} - Specifying how the location request is handled
-     * @param callback - Callback to invoke when current user location is fetched
-     */
-    function getLocation(props: LocationProps, callback: getLocationCallbackFunctionType): void;
+      Longitude of the location
+      */
+    longitude: number;
     /**
-     * @deprecated
-     * As of 2.1.0, please use {@link geoLocation.map.showLocation geoLocation.map.showLocation(location: Location): Promise\<void\>} instead.
-     *
-     * Shows the location on map corresponding to the given coordinates
-     *
-     * @param location - Location to be shown on the map
-     * @param callback - Callback to invoke when the location is opened on map
-     */
-    function showLocation(location: Location, callback: showLocationCallbackFunctionType): void;
+      Accuracy of the coordinates captured
+      */
+    accuracy?: number;
     /**
-     * @deprecated
-     * As of 2.1.0, please use geoLocation namespace, and use {@link geoLocation.isSupported geoLocation.isSupported: boolean} to check if geoLocation is supported.
-     *
-     * Checks if Location capability is supported by the host
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
-     *
-     * @returns boolean to represent whether Location is supported
-     */
-    function isSupported(): boolean;
+      Time stamp when the location was captured
+      */
+    timestamp?: number;
 }
+/**
+ * @deprecated
+ * As of 2.1.0, please use one of the following functions:
+ * - {@link geoLocation.getCurrentLocation geoLocation.getCurrentLocation(): Promise\<Location\>} to get the current location.
+ * - {@link geoLocation.map.chooseLocation geoLocation.map.chooseLocation(): Promise\<Location\>} to choose location on map.
+ *
+ * Fetches user location
+ * @param props {@link LocationProps} - Specifying how the location request is handled
+ * @param callback - Callback to invoke when current user location is fetched
+ */
+export declare function getLocation(props: LocationProps, callback: getLocationCallbackFunctionType): void;
+/**
+ * @deprecated
+ * As of 2.1.0, please use {@link geoLocation.map.showLocation geoLocation.map.showLocation(location: Location): Promise\<void\>} instead.
+ *
+ * Shows the location on map corresponding to the given coordinates
+ *
+ * @param location - Location to be shown on the map
+ * @param callback - Callback to invoke when the location is opened on map
+ */
+export declare function showLocation(location: Location, callback: showLocationCallbackFunctionType): void;
+/**
+ * @deprecated
+ * As of 2.1.0, please use geoLocation namespace, and use {@link geoLocation.isSupported geoLocation.isSupported: boolean} to check if geoLocation is supported.
+ *
+ * Checks if Location capability is supported by the host
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @returns boolean to represent whether Location is supported
+ */
+export declare function isSupported(): boolean;