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

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,62 +1,52 @@
 import { IAppWindow } from './appWindow';
 import { TaskInfo } from './interfaces';
+/**
+ * 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}
+ *
+ * @param err - If the task module failed, this string contains the reason for failure. If the task module succeeded, this value is the empty string.
+ * @param result - On success, this is the value passed to the `result` parameter of {@link tasks.submitTask tasks.submitTask(result?: string | object, appIds?: string | string[]): void}. On failure, this is the empty string.
+ */
+export type startTaskSubmitHandlerFunctionType = (err: string, result: string | object) => void;
+/**
+ * @deprecated
+ * As of 2.8.0:
+ * - For url-based dialogs, please use {@link dialog.url.open dialog.url.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} .
+ * - For url-based dialogs with bot interaction, please use {@link dialog.url.bot.open dialog.url.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void}
+ * - For Adaptive Card-based dialogs:
+ *   - In Teams, please continue to use this function until the new functions in {@link dialog.adaptiveCard} have been fully implemented. You can tell at runtime when they are implemented in Teams by checking
+ *     the return value of the {@link dialog.adaptiveCard.isSupported} function. This documentation line will also be removed once they have been fully implemented in Teams.
+ *   - In all other hosts, please use {@link dialog.adaptiveCard.open dialog.adaptiveCard.open(cardDialogInfo: CardDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void}
+ *
+ * Allows an app to open the task module.
+ *
+ * @param taskInfo - An object containing the parameters of the task module
+ * @param submitHandler - Handler to call when the task module is completed
+ */
+export declare function startTask(taskInfo: TaskInfo, submitHandler?: startTaskSubmitHandlerFunctionType): IAppWindow;
 /**
  * @deprecated
- * As of TeamsJS v2.0.0, please use {@link dialog} namespace instead.
+ * As of TeamsJS v2.0.0, please use {@link dialog.update.resize dialog.update.resize(dimensions: DialogSize): void} instead.
  *
- * Namespace to interact with the task module-specific part of the SDK.
- * This object is usable only on the content frame.
- * The tasks namespace will be deprecated. Please use dialog for future developments.
+ * Update height/width task info properties.
+ *
+ * @param taskInfo - An object containing width and height properties
+ */
+export declare function updateTask(taskInfo: TaskInfo): void;
+/**
+ * @deprecated
+ * As of 2.8.0, please use {@link dialog.url.submit} instead.
+ *
+ * Submit the task module.
+ *
+ * @param result - Contains the result to be sent to the bot or the app. Typically a JSON object or a serialized version of it
+ * @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.
+ */
+export declare function submitTask(result?: string | object, appIds?: string | string[]): void;
+/**
+ * Sets the height and width of the {@link TaskInfo} object to the original height and width, if initially specified,
+ * otherwise uses the height and width values corresponding to {@link DialogDimension | TaskModuleDimension.Small}
+ * @param taskInfo TaskInfo object from which to extract size info, if specified
+ * @returns TaskInfo with height and width specified
  */
-export declare namespace tasks {
-    /**
-     * 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}
-     *
-     * @param err - If the task module failed, this string contains the reason for failure. If the task module succeeded, this value is the empty string.
-     * @param result - On success, this is the value passed to the `result` parameter of {@link tasks.submitTask tasks.submitTask(result?: string | object, appIds?: string | string[]): void}. On failure, this is the empty string.
-     */
-    type startTaskSubmitHandlerFunctionType = (err: string, result: string | object) => void;
-    /**
-     * @deprecated
-     * As of 2.8.0:
-     * - For url-based dialogs, please use {@link dialog.url.open dialog.url.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} .
-     * - For url-based dialogs with bot interaction, please use {@link dialog.url.bot.open dialog.url.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void}
-     * - For Adaptive Card-based dialogs:
-     *   - In Teams, please continue to use this function until the new functions in {@link dialog.adaptiveCard} have been fully implemented. You can tell at runtime when they are implemented in Teams by checking
-     *     the return value of the {@link dialog.adaptiveCard.isSupported} function. This documentation line will also be removed once they have been fully implemented in Teams.
-     *   - In all other hosts, please use {@link dialog.adaptiveCard.open dialog.adaptiveCard.open(cardDialogInfo: CardDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void}
-     *
-     * Allows an app to open the task module.
-     *
-     * @param taskInfo - An object containing the parameters of the task module
-     * @param submitHandler - Handler to call when the task module is completed
-     */
-    function startTask(taskInfo: TaskInfo, submitHandler?: startTaskSubmitHandlerFunctionType): IAppWindow;
-    /**
-     * @deprecated
-     * As of TeamsJS v2.0.0, please use {@link dialog.update.resize dialog.update.resize(dimensions: DialogSize): void} instead.
-     *
-     * Update height/width task info properties.
-     *
-     * @param taskInfo - An object containing width and height properties
-     */
-    function updateTask(taskInfo: TaskInfo): void;
-    /**
-     * @deprecated
-     * As of 2.8.0, please use {@link dialog.url.submit} instead.
-     *
-     * Submit the task module.
-     *
-     * @param result - Contains the result to be sent to the bot or the app. Typically a JSON object or a serialized version of it
-     * @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.
-     */
-    function submitTask(result?: string | object, appIds?: string | string[]): void;
-    /**
-     * Sets the height and width of the {@link TaskInfo} object to the original height and width, if initially specified,
-     * otherwise uses the height and width values corresponding to {@link DialogDimension | TaskModuleDimension.Small}
-     * @param taskInfo TaskInfo object from which to extract size info, if specified
-     * @returns TaskInfo with height and width specified
-     */
-    function getDefaultSizeIfNotProvided(taskInfo: TaskInfo): TaskInfo;
-}
+export declare function getDefaultSizeIfNotProvided(taskInfo: TaskInfo): TaskInfo;

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

@@ -1,77 +1,79 @@
+/**
+ * Module containing the set of APIs that support Teams-specific functionalities.
+ * @module
+ */
 import { LoadContext } from './interfaces';
-export declare namespace teamsCore {
-    /** Ready to unload function type */
-    type readyToUnloadFunctionType = () => void;
-    /** Register on load handler function type */
-    type registerOnLoadHandlerFunctionType = (context: LoadContext) => void;
-    /** Register before unload handler function type */
-    type registerBeforeUnloadHandlerFunctionType = (readyToUnload: readyToUnloadFunctionType) => boolean;
-    /**
-     * Enable print capability to support printing page using Ctrl+P and cmd+P
-     */
-    function enablePrintCapability(): void;
-    /**
-     * default print handler
-     */
-    function print(): void;
-    /**
-     * Registers a handler to be called when the page has been requested to load.
-     *
-     * @remarks Check out [App Caching in Teams](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/app-caching)
-     * for a more detailed explanation about using this API.
-     *
-     * @param handler - The handler to invoke when the page is loaded.
-     *
-     * @beta
-     */
-    function registerOnLoadHandler(handler: registerOnLoadHandlerFunctionType): void;
-    /**
-     * @hidden
-     * Undocumented helper function with shared code between deprecated version and current version of the registerOnLoadHandler API.
-     *
-     * @internal
-     * Limited to Microsoft-internal use
-     *
-     * @param apiVersionTag - The tag indicating API version number with name
-     * @param handler - The handler to invoke when the page is loaded.
-     * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
-     *
-     * @deprecated
-     */
-    function registerOnLoadHandlerHelper(apiVersionTag: string, handler: registerOnLoadHandlerFunctionType, versionSpecificHelper?: () => void): void;
-    /**
-     * Registers a handler to be called before the page is unloaded.
-     *
-     * @remarks Check out [App Caching in Teams](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/app-caching)
-     * for a more detailed explanation about using this API.
-     *
-     * @param handler - The handler to invoke before the page is unloaded. If this handler returns true the page should
-     * invoke the readyToUnload function provided to it once it's ready to be unloaded.
-     *
-     * @beta
-     */
-    function registerBeforeUnloadHandler(handler: registerBeforeUnloadHandlerFunctionType): void;
-    /**
-     * @hidden
-     * Undocumented helper function with shared code between deprecated version and current version of the registerBeforeUnloadHandler API.
-     *
-     * @internal
-     * Limited to Microsoft-internal use
-     *
-     * @param handler - - The handler to invoke before the page is unloaded. If this handler returns true the page should
-     * invoke the readyToUnload function provided to it once it's ready to be unloaded.
-     * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
-     *
-     * @deprecated
-     */
-    function registerBeforeUnloadHandlerHelper(apiVersionTag: string, handler: registerBeforeUnloadHandlerFunctionType, versionSpecificHelper?: () => void): void;
-    /**
-     * Checks if teamsCore capability is supported by the host
-     *
-     * @returns boolean to represent whether the teamsCore capability is supported
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
-     *
-     */
-    function isSupported(): boolean;
-}
+/** Ready to unload function type */
+export type readyToUnloadFunctionType = () => void;
+/** Register on load handler function type */
+export type registerOnLoadHandlerFunctionType = (context: LoadContext) => void;
+/** Register before unload handler function type */
+export type registerBeforeUnloadHandlerFunctionType = (readyToUnload: readyToUnloadFunctionType) => boolean;
+/**
+ * Enable print capability to support printing page using Ctrl+P and cmd+P
+ */
+export declare function enablePrintCapability(): void;
+/**
+ * default print handler
+ */
+export declare function print(): void;
+/**
+ * Registers a handler to be called when the page has been requested to load.
+ *
+ * @remarks Check out [App Caching in Teams](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/app-caching)
+ * for a more detailed explanation about using this API.
+ *
+ * @param handler - The handler to invoke when the page is loaded.
+ *
+ * @beta
+ */
+export declare function registerOnLoadHandler(handler: registerOnLoadHandlerFunctionType): void;
+/**
+ * @hidden
+ * Undocumented helper function with shared code between deprecated version and current version of the registerOnLoadHandler API.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @param apiVersionTag - The tag indicating API version number with name
+ * @param handler - The handler to invoke when the page is loaded.
+ * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
+ *
+ * @deprecated
+ */
+export declare function registerOnLoadHandlerHelper(apiVersionTag: string, handler: registerOnLoadHandlerFunctionType, versionSpecificHelper?: () => void): void;
+/**
+ * Registers a handler to be called before the page is unloaded.
+ *
+ * @remarks Check out [App Caching in Teams](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/app-caching)
+ * for a more detailed explanation about using this API.
+ *
+ * @param handler - The handler to invoke before the page is unloaded. If this handler returns true the page should
+ * invoke the readyToUnload function provided to it once it's ready to be unloaded.
+ *
+ * @beta
+ */
+export declare function registerBeforeUnloadHandler(handler: registerBeforeUnloadHandlerFunctionType): void;
+/**
+ * @hidden
+ * Undocumented helper function with shared code between deprecated version and current version of the registerBeforeUnloadHandler API.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @param handler - - The handler to invoke before the page is unloaded. If this handler returns true the page should
+ * invoke the readyToUnload function provided to it once it's ready to be unloaded.
+ * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
+ *
+ * @deprecated
+ */
+export declare function registerBeforeUnloadHandlerHelper(apiVersionTag: string, handler: registerBeforeUnloadHandlerFunctionType, versionSpecificHelper?: () => void): void;
+/**
+ * Checks if teamsCore capability is supported by the host
+ *
+ * @returns boolean to represent whether the teamsCore 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/thirdPartyCloudStorage.d.ts

@@ -1,119 +1,118 @@
-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
  */
-export declare namespace thirdPartyCloudStorage {
+export interface AssembleAttachment {
+    /** A number representing the sequence of the attachment in the file chunks. */
+    sequence: number;
+    /** A Blob object representing the data of the file chunks. */
+    file: Blob;
+}
+/**
+ * Object used to represent a file
+ * @beta
+ *
+ */
+export interface FilesFor3PStorage extends Blob {
     /**
-     * Interface to assemble file chunks
-     * @beta
+     * A number that represents the number of milliseconds since the Unix epoch
      */
-    interface AssembleAttachment {
-        /** A number representing the sequence of the attachment in the file chunks. */
-        sequence: number;
-        /** A Blob object representing the data of the file chunks. */
-        file: Blob;
-    }
+    lastModified: number;
     /**
-     * Object used to represent a file
-     * @beta
-     *
+     * Name of the file
      */
-    interface FilesFor3PStorage extends Blob {
-        /**
-         * A number that represents the number of milliseconds since the Unix epoch
-         */
-        lastModified: number;
-        /**
-         * Name of the file
-         */
-        name: string;
-        /**
-         * file type
-         */
-        type: string;
-        /**
-         * A string containing the path of the file relative to the ancestor directory the user selected
-         */
-        webkitRelativePath?: string;
-    }
+    name: string;
     /**
-     * File chunks an output of getDragAndDropFiles API from platform
-     * @beta
+     * file type
      */
-    interface FileChunk {
-        /**
-         * Base 64 data for the requested uri
-         */
-        chunk: string;
-        /**
-         * chunk sequence number
-         */
-        chunkSequence: number;
-        /**
-         * Indicates whether this chunk is the final segment of a file
-         */
-        endOfFile: boolean;
-    }
+    type: string;
     /**
-     * Output of getDragAndDropFiles API from platform
-     * @beta
+     * A string containing the path of the file relative to the ancestor directory the user selected
      */
-    interface FileResult {
-        /**
-         * Error encountered in getDragAndDropFiles API
-         */
-        error?: SdkError;
-        /**
-         * File chunk which will be assemebled and converted into a blob
-         */
-        fileChunk: FileChunk;
-        /**
-         * File index of the file for which chunk data is getting recieved
-         */
-        fileIndex: number;
-        /**
-         * File type/MIME type which is getting recieved
-         */
-        fileType: string;
-        /**
-         * Indicates whether this file is the last one in a sequence.
-         */
-        isLastFile: boolean;
-        /**
-         * The name of the file.
-         */
-        fileName: string;
-    }
+    webkitRelativePath?: string;
+}
+/**
+ * File chunks an output of getDragAndDropFiles API from platform
+ * @beta
+ */
+export interface FileChunk {
     /**
-     * Defines the callback function received from Third Party App
-     * @beta
+     * Base 64 data for the requested uri
      */
-    interface DragAndDropFileCallback {
-        /**
-         * Definition of the callback which is received from third party app when calling {@link thirdPartyCloudStorage.getDragAndDropFiles}
-         * An array of drag and dropped files {@link thirdPartyCloudStorage.FilesFor3PStorage}
-         * Error encountered during the API call {@link SdkError}
-         */
-        (files: FilesFor3PStorage[], error?: SdkError): void;
-    }
+    chunk: string;
     /**
-     * Get drag-and-drop files using a callback.
-     *
-     * @param {string} dragAndDropInput - unique id which is a combination of replyToId + threadId of teams chat and channel.
-     *   Both replyToId and threadId can be fetched from application context.
-     * @param {DragAndDropFileCallback} dragAndDropFileCallback - callback
-     *   A callback function to handle the result of the operation
-     * @beta
+     * chunk sequence number
      */
-    function getDragAndDropFiles(dragAndDropInput: string, dragAndDropFileCallback: DragAndDropFileCallback): void;
+    chunkSequence: number;
     /**
-     * Checks if the thirdPartyCloudStorage capability is supported by the host
-     * @returns boolean to represent whether the thirdPartyCloudStorage capability is supported
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
-     * @beta
+     * Indicates whether this chunk is the final segment of a file
      */
-    function isSupported(): boolean;
+    endOfFile: boolean;
 }
+/**
+ * Output of getDragAndDropFiles API from platform
+ * @beta
+ */
+export interface FileResult {
+    /**
+     * Error encountered in getDragAndDropFiles API
+     */
+    error?: SdkError;
+    /**
+     * File chunk which will be assemebled and converted into a blob
+     */
+    fileChunk: FileChunk;
+    /**
+     * File index of the file for which chunk data is getting recieved
+     */
+    fileIndex: number;
+    /**
+     * File type/MIME type which is getting recieved
+     */
+    fileType: string;
+    /**
+     * Indicates whether this file is the last one in a sequence.
+     */
+    isLastFile: boolean;
+    /**
+     * The name of the file.
+     */
+    fileName: string;
+}
+/**
+ * Defines the callback function received from Third Party App
+ * @beta
+ */
+export interface DragAndDropFileCallback {
+    /**
+     * Definition of the callback which is received from third party app when calling {@link thirdPartyCloudStorage.getDragAndDropFiles}
+     * An array of drag and dropped files {@link thirdPartyCloudStorage.FilesFor3PStorage}
+     * Error encountered during the API call {@link SdkError}
+     */
+    (files: FilesFor3PStorage[], error?: SdkError): void;
+}
+/**
+ * Get drag-and-drop files using a callback.
+ *
+ * @param {string} dragAndDropInput - unique id which is a combination of replyToId + threadId of teams chat and channel.
+ *   Both replyToId and threadId can be fetched from application context.
+ * @param {DragAndDropFileCallback} dragAndDropFileCallback - callback
+ *   A callback function to handle the result of the operation
+ * @beta
+ */
+export declare function getDragAndDropFiles(dragAndDropInput: string, dragAndDropFileCallback: DragAndDropFileCallback): void;
+/**
+ * Checks if the thirdPartyCloudStorage capability is supported by the host
+ * @returns boolean to represent whether the thirdPartyCloudStorage capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ * @beta
+ */
+export declare function isSupported(): boolean;