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

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

@@ -1,127 +1,105 @@
 /**
- * Namespace for profile related APIs.
+ * Module for profile related APIs.
  *
  * @beta
+ * @module
  */
-export declare namespace profile {
+/**
+ * Opens a profile card at a specified position to show profile information about a persona.
+ * @param showProfileRequest The parameters to position the card and identify the target user.
+ * @returns Promise that will be fulfilled when the operation has completed
+ *
+ * @beta
+ */
+export declare function showProfile(showProfileRequest: ShowProfileRequest): Promise<void>;
+/**
+ * The type of modalities that are supported when showing a profile.
+ * Can be provided as an optional hint with the request and will be
+ * respected if the hosting M365 application supports it.
+ *
+ * @beta
+ */
+export type Modality = 'Card' | 'Expanded';
+/**
+ * The type of the profile trigger.
+ *  - MouseHover: The user hovered a target.
+ *  - Press: The target was pressed with either a mouse click or keyboard key press.
+ *  - AppRequest: The show profile request is happening programmatically, without direct user interaction.
+ *
+ * @beta
+ */
+export type TriggerType = 'MouseHover' | 'Press' | 'AppRequest';
+/**
+ * The set of identifiers that are supported for resolving the persona.
+ *
+ * At least one is required, and if multiple are provided then only the highest
+ * priority one will be used (AadObjectId > Upn > Smtp). AAD is now known as "Microsoft Entra ID"
+ *
+ * @beta
+ */
+export type PersonaIdentifiers = {
     /**
-     * Opens a profile card at a specified position to show profile information about a persona.
-     * @param showProfileRequest The parameters to position the card and identify the target user.
-     * @returns Promise that will be fulfilled when the operation has completed
+     * The object id in Microsoft Entra.
      *
-     * @beta
+     * This id is guaranteed to be unique for an object within a tenant,
+     * and so if provided will lead to a more performant lookup. It can
+     * be resolved via MS Graph (see https://learn.microsoft.com/graph/api/resources/users
+     * for examples).
      */
-    function showProfile(showProfileRequest: ShowProfileRequest): Promise<void>;
+    readonly AadObjectId?: string;
     /**
-     * The type of modalities that are supported when showing a profile.
-     * Can be provided as an optional hint with the request and will be
-     * respected if the hosting M365 application supports it.
-     *
-     * @beta
+     * The primary SMTP address.
      */
-    type Modality = 'Card' | 'Expanded';
+    readonly Smtp?: string;
     /**
-     * The type of the profile trigger.
-     *  - MouseHover: The user hovered a target.
-     *  - Press: The target was pressed with either a mouse click or keyboard key press.
-     *  - AppRequest: The show profile request is happening programmatically, without direct user interaction.
-     *
-     * @beta
+     * The user principle name.
      */
-    type TriggerType = 'MouseHover' | 'Press' | 'AppRequest';
+    readonly Upn?: string;
+};
+/**
+ * The persona to show the profile for.
+ *
+ * @beta
+ */
+export interface Persona {
     /**
      * The set of identifiers that are supported for resolving the persona.
-     *
-     * At least one is required, and if multiple are provided then only the highest
-     * priority one will be used (AadObjectId > Upn > Smtp). AAD is now known as "Microsoft Entra ID"
-     *
-     * @beta
      */
-    type PersonaIdentifiers = {
-        /**
-         * The object id in Microsoft Entra.
-         *
-         * This id is guaranteed to be unique for an object within a tenant,
-         * and so if provided will lead to a more performant lookup. It can
-         * be resolved via MS Graph (see https://learn.microsoft.com/graph/api/resources/users
-         * for examples).
-         */
-        readonly AadObjectId?: string;
-        /**
-         * The primary SMTP address.
-         */
-        readonly Smtp?: string;
-        /**
-         * The user principle name.
-         */
-        readonly Upn?: string;
-    };
+    identifiers: PersonaIdentifiers;
     /**
-     * The persona to show the profile for.
-     *
-     * @beta
+     * Optional display name override. If not specified the user's display name will be resolved normally.
      */
-    interface Persona {
-        /**
-         * The set of identifiers that are supported for resolving the persona.
-         */
-        identifiers: PersonaIdentifiers;
-        /**
-         * Optional display name override. If not specified the user's display name will be resolved normally.
-         */
-        displayName?: string;
-    }
+    displayName?: string;
+}
+/**
+ * Input parameters provided to the showProfile API.
+ *
+ * @beta
+ */
+export interface ShowProfileRequest {
     /**
-     * Input parameters provided to the showProfile API.
-     *
-     * @beta
+     * An optional hint to the hosting M365 application about which modality of the profile you want to show.
      */
-    interface ShowProfileRequest {
-        /**
-         * An optional hint to the hosting M365 application about which modality of the profile you want to show.
-         */
-        modality?: Modality;
-        /**
-         * The information about the persona to show the profile for.
-         */
-        persona: Persona;
-        /**
-         * The bounding rectangle of the target.
-         */
-        targetElementBoundingRect: DOMRect;
-        /**
-         * Specifies which user interaction was used to trigger the API call.
-         */
-        triggerType: TriggerType;
-    }
+    modality?: Modality;
     /**
-     * Checks if the profile capability is supported by the host
-     * @returns boolean to represent whether the profile capability is supported
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
-     *
-     * @beta
+     * The information about the persona to show the profile for.
+     */
+    persona: Persona;
+    /**
+     * The bounding rectangle of the target.
      */
-    function isSupported(): boolean;
+    targetElementBoundingRect: DOMRect;
+    /**
+     * Specifies which user interaction was used to trigger the API call.
+     */
+    triggerType: TriggerType;
 }
 /**
- * Internal representation of a DOMRect suitable for sending via postMessage.
- */
-export type Rectangle = {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-};
-/**
+ * Checks if the profile capability is supported by the host
+ * @returns boolean to represent whether the profile capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
  * @beta
- * @hidden
- * An internal representation of the showProfile parameters suitable for sending via postMessage.
- * The hub expects to receive an object of this type.
  */
-export interface ShowProfileRequestInternal {
-    modality?: profile.Modality;
-    persona: profile.Persona;
-    targetRectangle: Rectangle;
-    triggerType: profile.TriggerType;
-}
+export declare function isSupported(): boolean;

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

@@ -17,6 +17,9 @@ interface IRuntimeV4 extends IBaseRuntime {
     readonly isNAAChannelRecommended?: boolean;
     readonly isLegacyTeams?: boolean;
     readonly supports: {
+        readonly app?: {
+            readonly notifySuccessResponse?: {};
+        };
         readonly appEntity?: {};
         readonly appInstallDialog?: {};
         readonly barCode?: {};

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

@@ -1,3 +1,12 @@
+/**
+ * Allows your application to interact with the host M365 application's search box.
+ * By integrating your application with the host's search box, users can search
+ * your app using the same search box they use elsewhere in Teams, Outlook, or Office.
+ *
+ * This functionality is in Beta.
+ * @beta
+ * @module
+ */
 /**
  * This interface contains information pertaining to the contents of the host M365 application's search box
  *

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

@@ -3,6 +3,7 @@
  * For e.g., opening a URL in the host app inside a browser
  *
  * @beta
+ * @module
  */
 /**
  * Open a URL in the secondary browser.

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

@@ -1,11 +1,12 @@
-import { pages } from './pages';
 /**
  * @deprecated
- * As of TeamsJS v2.0.0, please use {@link pages.config} namespace instead.
+ * As of TeamsJS v2.0.0, please use {@link pages.config} module instead.
  *
- * Namespace to interact with the settings-specific part of the SDK.
+ * Module to interact with the settings-specific part of the SDK.
  * This object is usable only on the settings frame.
+ * @module
  */
+import * as pages from './pages/pages';
 /** Register on remove handler function type */
 export type registerOnRemoveHandlerFunctionType = (evt: RemoveEvent) => void;
 /** Register on save handler function type */

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

@@ -0,0 +1,47 @@
+/**
+ * Module to get the list of content shared in a Teams meeting
+ *
+ * @beta
+ * @module
+ */
+/**
+ * Represents the data returned when calling {@link sharing.history.getContent}
+ *
+ * @beta
+ */
+export interface IContentResponse {
+    /** Id of the app where the content was shared from */
+    appId: string;
+    /** Title of the shared content */
+    title: string;
+    /** Reference of the shared content */
+    contentReference: string;
+    /** Id of the thread where the content was shared. */
+    threadId: string;
+    /** Id of the user who shared the content. */
+    author: string;
+    /** Type of the shared content.
+     * For sharing to Teams stage scenarios, this value would be `ShareToStage`
+     * Other `contentType` values will be added and documented here over time
+     */
+    contentType: string;
+}
+/**
+ * Get the list of content shared in a Teams meeting
+ *
+ * @throws Error if call capability is not supported
+ * @throws Error if returned content details are invalid
+ * @returns Promise that will resolve with the {@link IContentResponse} objects array
+ *
+ * @beta
+ */
+export declare function getContent(): Promise<IContentResponse[]>;
+/**
+ * Checks if sharing.history capability is supported by the host
+ * @returns boolean to represent whether the sharing.history 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/sharing/sharing.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Module to open a share dialog for web content.
+ * For more info, see [Share to Teams from personal app or tab](https://learn.microsoft.com/microsoftteams/platform/concepts/build-and-test/share-to-teams-from-personal-app-or-tab)
+ * @module
+ */
+import { SdkError } from '../interfaces';
+import * as history from './history';
+/** shareWebContent callback function type */
+export type shareWebContentCallbackFunctionType = (err?: SdkError) => void;
+/** Type of message that can be sent or received by the sharing APIs */
+export declare const SharingAPIMessages: {
+    /**
+     * Share web content message.
+     * @internal
+     */
+    shareWebContent: string;
+};
+type ContentType = 'URL';
+/** Represents parameters for base shared content. */
+interface IBaseSharedContent {
+    /** Shared content type  */
+    type: ContentType;
+}
+/** IShareRequestContentType defines share request type. */
+export type IShareRequestContentType = IURLContent;
+/** Represents IShareRequest parameters interface.
+ * @typeparam T - The identity type
+ */
+export interface IShareRequest<T> {
+    /** Content of the share request. */
+    content: T[];
+}
+/** Represents IURLContent parameters. */
+export interface IURLContent extends IBaseSharedContent {
+    /** Type */
+    type: 'URL';
+    /**
+     * Required URL
+     */
+    url: string;
+    /**
+     * Default initial message text
+     */
+    message?: string;
+    /**
+     * Show URL preview, defaults to true
+     */
+    preview?: boolean;
+}
+/**
+ * Feature is under development
+ * Opens a share dialog for web content
+ *
+ * @param shareWebContentRequest - web content info
+ * @returns Promise that will be fulfilled when the operation has completed
+ */
+export declare function shareWebContent(shareWebContentRequest: IShareRequest<IShareRequestContentType>): Promise<void>;
+/**
+ * @deprecated
+ * As of TeamsJS v2.0.0, please use {@link sharing.shareWebContent sharing.shareWebContent(shareWebContentRequest: IShareRequest\<IShareRequestContentType\>): Promise\<void\>} instead.
+ *
+ * Feature is under development
+ * Opens a share dialog for web content
+ *
+ * @param shareWebContentRequest - web content info
+ * @param callback - optional callback
+ */
+export declare function shareWebContent(shareWebContentRequest: IShareRequest<IShareRequestContentType>, callback: shareWebContentCallbackFunctionType): void;
+/**
+ * Checks if the sharing capability is supported by the host
+ * @returns boolean to represent whether the sharing capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ */
+export declare function isSupported(): boolean;
+export { history };

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

@@ -0,0 +1,23 @@
+/**
+ * Module for actions that can be taken by the stage view itself.
+ *
+ * @beta
+ * @module
+ */
+/**
+ * Closes the current stage view. This function will be a no-op if called from outside of a stage view.
+ * @returns Promise that resolves or rejects with an error once the stage view is closed.
+ *
+ * @beta
+ * @throws Error if stageView.self.close is not supported in the current context or if `app.initialize()` has not resolved successfully.
+ */
+export declare function close(): Promise<void>;
+/**
+ * Checks if stageView.self capability is supported by the host
+ * @beta
+ * @returns boolean to represent whether the stageView.self capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ */
+export declare function isSupported(): boolean;

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

@@ -0,0 +1,81 @@
+/**
+ * Module to interact with the stage view specific part of the SDK.
+ *
+ * @beta
+ * @module
+ */
+import * as self from './self';
+/**
+ * Parameters to open a stage view.
+ */
+export interface StageViewParams {
+    /**
+     * The ID of the Teams application to be opened.
+     */
+    appId: string;
+    /**
+     * The URL of the content to display.
+     */
+    contentUrl: string;
+    /**
+     * The chat or channel ID.
+     */
+    threadId: string;
+    /**
+     * The messageId identifies a particular channel meeting within the channel as specified by the threadId above. This should be used only when trying to open the stage view for a channel meeting. It will be a no-op for other scenarios
+     */
+    messageId?: string;
+    /**
+     * The title to give the stage view.
+     */
+    title?: string;
+    /**
+     * The Teams application website URL.
+     */
+    websiteUrl?: string;
+    /**
+     * The entity ID of the Teams application content being opened.
+     */
+    entityId?: string;
+    /**
+     * The open mode for stage content.
+     * Optional param: if not passed, hosts can choose their default openMode.
+     * If a host does not support any specific openMode, It will fallback to StageViewOpenMode.modal.
+     */
+    openMode?: StageViewOpenMode;
+}
+/**
+ * The open mode for stage content.
+ */
+export declare enum StageViewOpenMode {
+    /**
+     * Open the content in a modal.
+     */
+    modal = "modal",
+    /**
+     * Open the content in a popped-out window.
+     */
+    popout = "popout",
+    /**
+     * Open the content in a popped-out window with chat collaboration.
+     */
+    popoutWithChat = "popoutWithChat"
+}
+/**
+ *
+ * Opens a stage view to display a Teams application
+ * @beta
+ * @param stageViewParams - The parameters to pass into the stage view.
+ * @returns Promise that resolves or rejects with an error once the stage view is closed.
+ */
+export declare function open(stageViewParams: StageViewParams): Promise<void>;
+/**
+ * Checks if stageView capability is supported by the host
+ * @beta
+ * @returns boolean to represent whether the stageView capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ */
+export declare function isSupported(): boolean;
+export { self };

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

@@ -1,13 +1,5 @@
 import { IAppWindow } from './appWindow';
 import { TaskInfo } from './interfaces';
-/**
- * @deprecated
- * As of TeamsJS v2.0.0, please use {@link dialog} namespace instead.
- *
- * Module to interact with the task module-specific part of the SDK.
- * This object is usable only on the content frame.
- * The tasks module will be deprecated. Please use dialog for future developments.
- */
 /**
  * Function type that is used to receive the result when a task module is submitted by
  * calling {@link tasks.submitTask tasks.submitTask(result?: string | object, appIds?: string | string[]): void}

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

@@ -1,3 +1,7 @@
+/**
+ * Module containing the set of APIs that support Teams-specific functionalities.
+ * @module
+ */
 import { LoadContext } from './interfaces';
 /** Ready to unload function type */
 export type readyToUnloadFunctionType = () => void;

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

@@ -1,9 +1,10 @@
-import { SdkError } from './interfaces';
 /**
  * Extended files API 3P storage providers, features like sending Blob from Teams to 3P app on user
  * actions like drag and drop to compose
  * @beta
+ * @module
  */
+import { SdkError } from './interfaces';
 /**
  * Interface to assemble file chunks
  * @beta