@microsoft/teams-js 2.3.1-beta.0 → 2.4.0-beta.1

package/dist/MicrosoftTeams.d.ts

@@ -1,4 +1,10 @@
 // Generated by dts-bundle v0.7.3
+// Dependencies for this module:
+//   ../@fluidframework/azure-client
+//   ../@fluidframework/fluid-static
+
+import type { AzureConnectionConfig, AzureContainerServices, ITelemetryBaseLogger } from '@fluidframework/azure-client';
+import type { ContainerSchema, IFluidContainer } from '@fluidframework/fluid-static';
 
 /**
     * @hidden
@@ -895,21 +901,22 @@ export namespace files {
         /**
             * @hidden
             * Object used to represent a file
+            * @beta
             *
             * @internal
             * Limited to Microsoft-internal use
             */
         export interface File extends Blob {
                 /**
-                    * Last modified timestamp
+                    * A number that represents the number of milliseconds since the Unix epoch
                     */
-                lastModified: Date;
+                lastModified: number;
                 /**
                     * Name of the file
                     */
                 name: string;
                 /**
-                    * The file path to uniquely identify it within the file hierarchy
+                    * A string containing the path of the file relative to the ancestor directory the user selected
                     */
                 webkitRelativePath?: string;
         }
@@ -2499,9 +2506,26 @@ export enum HostClientType {
         teamsDisplays = "teamsDisplays"
 }
 export enum HostName {
+        /**
+            * Office.com and Office Windows App
+            */
         office = "Office",
+        /**
+            * For "desktop" specifically, this refers to the new, pre-release version of Outlook for Windows.
+            * Also used on other platforms that map to a single Outlook client.
+            */
         outlook = "Outlook",
+        /**
+            * Outlook for Windows: the classic, native, desktop client
+            */
+        outlookWin32 = "OutlookWin32",
+        /**
+            * Microsoft-internal test Host
+            */
         orange = "Orange",
+        /**
+            * Teams
+            */
         teams = "Teams"
 }
 export enum FrameContexts {
@@ -3811,7 +3835,7 @@ export namespace app {
                     */
                 meeting?: MeetingInfo;
                 /**
-                    * SharePoint context. This is only available when hosted in SharePoint.
+                    * When hosted in SharePoint, this is the [SharePoint PageContext](https://learn.microsoft.com/en-us/javascript/api/sp-page-context/pagecontext?view=sp-typescript-latest), else `undefined`
                     */
                 sharepoint?: any;
                 /**
@@ -6149,13 +6173,6 @@ export namespace search {
             * Your application should *not* re-render inside of these callbacks, there may be a large number
             * of onChangeHandler calls if the user is typing rapidly in the search box.
             *
-            * @param onChangeHandler - This optional handler will be called when the user first starts using the
-            * host's search box and as the user types their query. Can be used to put your application into a
-            * word-wheeling state or to display suggestions as the user is typing.
-            *
-            * This handler will be called with an empty {@link SearchQuery.searchTerm} when search is beginning, and subsequently,
-            * with the current contents of the search box.
-            *
             * @param onClosedHandler - This handler will be called when the user exits or cancels their search.
             * Should be used to return your application to its most recent, non-search state. The value of {@link SearchQuery.searchTerm}
             * will be whatever the last query was before ending search.
@@ -6164,18 +6181,24 @@ export namespace search {
             * search (by pressing Enter for example). Should be used to display the full list of search results.
             * The value of {@link SearchQuery.searchTerm} is the complete query the user entered in the search box.
             *
+            * @param onChangeHandler - This optional handler will be called when the user first starts using the
+            * host's search box and as the user types their query. Can be used to put your application into a
+            * word-wheeling state or to display suggestions as the user is typing.
+            *
+            * This handler will be called with an empty {@link SearchQuery.searchTerm} when search is beginning, and subsequently,
+            * with the current contents of the search box.
             * @example
             * ``` ts
             * search.registerHandlers(
-                query => {
-                    console.log(`Update your application with the changed search query: ${query.searchTerm}`);
-                },
                 query => {
                     console.log('Update your application to handle the search experience being closed. Last query: ${query.searchTerm}');
                 },
                 query => {
                     console.log(`Update your application to handle an executed search result: ${query.searchTerm}`);
                 },
+                query => {
+                    console.log(`Update your application with the changed search query: ${query.searchTerm}`);
+                },
              );
             * ```
             *
@@ -6303,6 +6326,8 @@ export namespace stageView {
         function isSupported(): boolean;
 }
 
+export const version: string;
+
 /**
     * Contains functionality to allow web apps to store data in webview cache
     *
@@ -6830,3 +6855,281 @@ export namespace tasks {
         function getDefaultSizeIfNotProvided(taskInfo: TaskInfo): TaskInfo;
 }
 
+/**
+    * Namespace to interact with the Live Share module-specific part of the SDK.
+    *
+    * @beta
+    */
+export namespace liveShare {
+        /**
+            * Options used to configure the Live Share client.
+            *
+            * @beta
+            */
+        interface LiveShareOptions {
+                /**
+                    * Optional. Configuration to use when connecting to a custom Azure Fluid Relay instance.
+                    */
+                readonly connection?: AzureConnectionConfig;
+                /**
+                    * Optional. A logger instance to receive diagnostic messages.
+                    */
+                readonly logger?: ITelemetryBaseLogger;
+                /**
+                    * Optional. Function to lookup the ID of the container to use for local testing.
+                    *
+                    * @remarks
+                    * The default implementation attempts to retrieve the containerId from the `window.location.hash`.
+                    *
+                    * If the function returns 'undefined' a new container will be created.
+                    * @returns ID of the container to connect to or `undefined` if a new container should be created.
+                    */
+                readonly getLocalTestContainerId?: () => string | undefined;
+                /**
+                    * Optional. Function to save the ID of a newly created local test container.
+                    *
+                    * @remarks
+                    * The default implementation updates `window.location.hash` with the ID of the newly created
+                    * container.
+                    * @param containerId The ID of the container that was created.
+                    */
+                readonly setLocalTestContainerId?: (containerId: string) => void;
+        }
+        /**
+            * Initializes the Live Share client.
+            * @param options Optional. Configuration options passed to the Live Share client.
+            *
+            * @beta
+            */
+        function initialize(options?: LiveShareOptions): Promise<void>;
+        /**
+            * Connects to the fluid container for the current teams context.
+            *
+            * @remarks
+            * The first client joining the container will create the container resulting in the
+            * `onContainerFirstCreated` callback being called. This callback can be used to set the initial
+            * state of of the containers object prior to the container being attached.
+            * @param fluidContainerSchema Fluid objects to create.
+            * @param onContainerFirstCreated Optional. Callback that's called when the container is first created.
+            * @returns The fluid `container` and `services` objects to use along with a `created` flag that if true means the container had to be created.
+            *
+            * @beta
+            */
+        function joinContainer(fluidContainerSchema: ContainerSchema, onContainerFirstCreated?: (container: IFluidContainer) => void): Promise<{
+                container: IFluidContainer;
+                services: AzureContainerServices;
+                created: boolean;
+        }>;
+        /**
+            * @hidden
+            * Hide from docs
+            * ------
+            * Returns the LiveShareHost object. Called by existing apps that use the TeamsFluidClient
+            * directly. This prevents existing apps from breaking and will be removed when Live Share
+            * goes GA.
+            *
+            * @beta
+            */
+        function getHost(): LiveShareHost;
+}
+
+/**
+    * @hidden
+    * @internal
+    * Limited to Microsoft-internal use
+    * ------
+    * Allowed roles during a meeting.
+    */
+export enum UserMeetingRole {
+        guest = "Guest",
+        attendee = "Attendee",
+        presenter = "Presenter",
+        organizer = "Organizer"
+}
+/**
+    * @hidden
+    * @internal
+    * Limited to Microsoft-internal use
+    * ------
+    * State of the current Live Share sessions backing fluid container.
+    */
+export 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 and should be used
+            * when joining the sessions Fluid container.
+            */
+        alreadyExists = "AlreadyExists",
+        /**
+            * The call to `LiveShareHost.setContainerId()` failed to create the container mapping due to
+            * another client having already set the container ID for the current Live Share session.
+            */
+        conflict = "Conflict",
+        /**
+            * A container mapping for the current Live Share session doesn't exist yet.
+            */
+        notFound = "NotFound"
+}
+/**
+    * @hidden
+    * @internal
+    * Limited to Microsoft-internal use
+    * ------
+    * Returned from `LiveShareHost.get/setFluidContainerId()` to specify the container mapping 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. The local client should wait the specified amount of time and
+            * then ask for the container info again.
+            */
+        retryAfter: number;
+}
+/**
+    * @hidden
+    * @internal
+    * Limited to Microsoft-internal use
+    * ------
+    * 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
+    * @internal
+    * Limited to Microsoft-internal use
+    * ------
+    * 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;
+        /**
+            * @deprecated
+            * As of Fluid 1.0 this configuration information has been deprecated in favor of
+            * `serviceEndpoint`.
+            */
+        ordererEndpoint: string;
+        /**
+            * @deprecated
+            * As of Fluid 1.0 this configuration information has been deprecated in favor of
+            * `serviceEndpoint`.
+            */
+        storageEndpoint: string;
+}
+/**
+    * @hidden
+    * @internal
+    * Limited to Microsoft-internal use
+    * ------
+    * Interface for hosting a Live Share session within a client like Teams.
+    */
+export class LiveShareHost {
+        /**
+            * @hidden
+            * @internal
+            * Limited to Microsoft-internal use
+            * ------
+            * Returns the Fluid Tenant connection info for user's current context.
+            */
+        getFluidTenantInfo(): Promise<IFluidTenantInfo>;
+        /**
+            * @hidden
+            * @internal
+            * Limited to Microsoft-internal use
+            * ------
+            * Returns the fluid access token for mapped container Id.
+            *
+            * @param containerId Fluid's container Id for the request. Undefined for new containers.
+            * @returns token for connecting to Fluid's session.
+            */
+        getFluidToken(containerId?: string): Promise<string>;
+        /**
+            * @hidden
+            * @internal
+            * Limited to Microsoft-internal use
+            * ------
+            * Returns the ID of the fluid container associated with the user's current context.
+            */
+        getFluidContainerId(): Promise<IFluidContainerInfo>;
+        /**
+            * @hidden
+            * @internal
+            * Limited to Microsoft-internal use
+            * ------
+            * Sets the ID of the fluid container associated with the current context.
+            *
+            * @remarks
+            * If this returns false, the client should delete the container they created and then call
+            * `getFluidContainerId()` to get the ID of the container being used.
+            * @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<IFluidContainerInfo>;
+        /**
+            * @hidden
+            * @internal
+            * Limited to Microsoft-internal use
+            * ------
+            * Returns the shared clock server's current time.
+            */
+        getNtpTime(): Promise<INtpTimeInfo>;
+        /**
+            * @hidden
+            * @internal
+            * Limited to Microsoft-internal use
+            * ------
+            * Associates the fluid client ID with a set of user roles.
+            *
+            * @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<UserMeetingRole[]>;
+        /**
+            * @hidden
+            * @internal
+            * Limited to Microsoft-internal use
+            * ------
+            * Returns the roles associated with a client ID.
+            *
+            * @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<UserMeetingRole[] | undefined>;
+}
+