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

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

@@ -1,91 +1,81 @@
 /**
- * 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 interface contains information pertaining to the contents of the host M365 application's search box
  *
- * This functionality is in Beta.
  * @beta
  */
-export declare namespace search {
-    /**
-     * This interface contains information pertaining to the contents of the host M365 application's search box
-     *
-     * @beta
-     */
-    interface SearchQuery {
-        /** The current search term in the host search experience */
-        searchTerm: string;
-        /** Timestamp sequence value to ensure messages are processed in correct order / combine them. */
-        timestamp: number;
-    }
-    /**
-     * This type will store the SearchQuery and allow other logic to be made inside the handler.
-     *
-     * @beta
-     */
-    type SearchQueryHandler = (query: SearchQuery) => void;
-    /**
-     * Allows the caller to register for various events fired by the host search experience.
-     * Calling this function indicates that your application intends to plug into the host's search box and handle search events,
-     * when the user is actively using your page/tab.
-     *
-     * The host may visually update its search box, e.g. with the name or icon of your application.
-     *
-     * 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 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.
-     *
-     * @param onExecuteHandler - The handler will be called when the user executes their
-     * 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 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}`);
-        },
-       );
-     * ```
-     *
-     * @beta
-     */
-    function registerHandlers(onClosedHandler: SearchQueryHandler, onExecuteHandler: SearchQueryHandler, onChangeHandler?: SearchQueryHandler): void;
-    /**
-     * Allows the caller to unregister for all events fired by the host search experience. Calling
-     * this function will cause your app to stop appearing in the set of search scopes in the hosts
-     *
-     * @beta
-     */
-    function unregisterHandlers(): void;
-    /**
-     * Checks if search capability is supported by the host
-     * @returns boolean to represent whether the search capability is supported
-     *
-     * @throws Error if {@link app.initialize} has not successfully completed
-     *
-     * @beta
-     */
-    function isSupported(): boolean;
-    /**
-     * Clear the host M365 application's search box
-     *
-     * @beta
-     */
-    function closeSearch(): Promise<void>;
+export interface SearchQuery {
+    /** The current search term in the host search experience */
+    searchTerm: string;
+    /** Timestamp sequence value to ensure messages are processed in correct order / combine them. */
+    timestamp: number;
 }
+/**
+ * This type will store the SearchQuery and allow other logic to be made inside the handler.
+ *
+ * @beta
+ */
+export type SearchQueryHandler = (query: SearchQuery) => void;
+/**
+   * Allows the caller to register for various events fired by the host search experience.
+   * Calling this function indicates that your application intends to plug into the host's search box and handle search events,
+   * when the user is actively using your page/tab.
+   *
+   * The host may visually update its search box, e.g. with the name or icon of your application.
+   *
+   * 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 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.
+   *
+   * @param onExecuteHandler - The handler will be called when the user executes their
+   * 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 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}`);
+      },
+     );
+   * ```
+   *
+   * @beta
+   */
+export declare function registerHandlers(onClosedHandler: SearchQueryHandler, onExecuteHandler: SearchQueryHandler, onChangeHandler?: SearchQueryHandler): void;
+/**
+ * Allows the caller to unregister for all events fired by the host search experience. Calling
+ * this function will cause your app to stop appearing in the set of search scopes in the hosts
+ *
+ * @beta
+ */
+export declare function unregisterHandlers(): void;
+/**
+ * Checks if search capability is supported by the host
+ * @returns boolean to represent whether the search capability is supported
+ *
+ * @throws Error if {@link app.initialize} has not successfully completed
+ *
+ * @beta
+ */
+export declare function isSupported(): boolean;
+/**
+ * Clear the host M365 application's search box
+ *
+ * @beta
+ */
+export declare function closeSearch(): Promise<void>;

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

@@ -1,32 +1,30 @@
 /**
- * Namespace to power up the in-app browser experiences in the host app.
+ * Module to power up the in-app browser experiences in the host app.
  * For e.g., opening a URL in the host app inside a browser
  *
  * @beta
  */
-export declare namespace secondaryBrowser {
-    /**
-     * Open a URL in the secondary browser.
-     *
-     * On mobile, this is the in-app browser.
-     *
-     * On web and desktop, please use the `window.open()` method or other native external browser methods.
-     *
-     * @param url Url to open in the browser
-     * @returns Promise that successfully resolves if the URL  opens in the secondaryBrowser
-     * or throws an error {@link SdkError} incase of failure before starting navigation
-     *
-     * @remarks Any error that happens after navigation begins is handled by the platform browser component and not returned from this function.
-     * @beta
-     */
-    function open(url: URL): Promise<void>;
-    /**
-     * Checks if secondaryBrowser capability is supported by the host
-     * @returns boolean to represent whether secondaryBrowser is supported
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
-     *
-     * @beta
-     */
-    function isSupported(): boolean;
-}
+/**
+ * Open a URL in the secondary browser.
+ *
+ * On mobile, this is the in-app browser.
+ *
+ * On web and desktop, please use the `window.open()` method or other native external browser methods.
+ *
+ * @param url Url to open in the browser
+ * @returns Promise that successfully resolves if the URL  opens in the secondaryBrowser
+ * or throws an error {@link SdkError} incase of failure before starting navigation
+ *
+ * @remarks Any error that happens after navigation begins is handled by the platform browser component and not returned from this function.
+ * @beta
+ */
+export declare function open(url: URL): Promise<void>;
+/**
+ * Checks if secondaryBrowser capability is supported by the host
+ * @returns boolean to represent whether secondaryBrowser 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/tasks.d.ts

@@ -4,59 +4,57 @@ import { TaskInfo } from './interfaces';
  * @deprecated
  * As of TeamsJS v2.0.0, please use {@link dialog} namespace instead.
  *
- * Namespace to interact with the task module-specific part of the SDK.
+ * Module 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.
+ * The tasks module will be deprecated. Please use dialog for future developments.
  */
-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;
-}
+/**
+ * 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.update.resize dialog.update.resize(dimensions: DialogSize): void} instead.
+ *
+ * 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 function getDefaultSizeIfNotProvided(taskInfo: TaskInfo): TaskInfo;

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

@@ -1,77 +1,75 @@
 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;