@microsoft/teams-js 2.55.1-beta.0 → 2.56.0

package/dist/umd/MicrosoftTeams.js

@@ -1027,6 +1027,7 @@ __webpack_require__.d(__webpack_exports__, {
   call: () => (/* reexport */ call_namespaceObject),
   chat: () => (/* reexport */ chat_namespaceObject),
   clipboard: () => (/* reexport */ clipboard_namespaceObject),
+  contextualSearch: () => (/* reexport */ contextualSearch_namespaceObject),
   conversations: () => (/* reexport */ conversations_namespaceObject),
   copilot: () => (/* reexport */ copilot_namespaceObject),
   dialog: () => (/* reexport */ dialog_namespaceObject),
@@ -1342,6 +1343,17 @@ __webpack_require__.d(logs_namespaceObject, {
   registerGetLogHandler: () => (registerGetLogHandler)
 });
 
+// NAMESPACE OBJECT: ./src/private/contextualSearch.ts
+var contextualSearch_namespaceObject = {};
+__webpack_require__.r(contextualSearch_namespaceObject);
+__webpack_require__.d(contextualSearch_namespaceObject, {
+  closeContextualSearch: () => (closeContextualSearch),
+  isSupported: () => (contextualSearch_isSupported),
+  openContextualSearch: () => (openContextualSearch),
+  registerOnContextualSearchClosedHandler: () => (registerOnContextualSearchClosedHandler),
+  registerOnContextualSearchOpenedHandler: () => (registerOnContextualSearchOpenedHandler)
+});
+
 // NAMESPACE OBJECT: ./src/private/conversations.ts
 var conversations_namespaceObject = {};
 __webpack_require__.r(conversations_namespaceObject);
@@ -4201,8 +4213,8 @@ class UUID {
 }
 /**
  * @hidden
- * Checks if the incoming id is an instance of ValidatedSafeString
- * @param id An object to check if it's an instance of ValidatedSafeString
+ * Checks if the incoming id is an instance of UUID
+ * @param id An object to check if it's an instance of UUID
  * @throws Error with a message describing the violation
  * @internal
  * Limited to Microsoft-internal use
@@ -4695,7 +4707,7 @@ function isSerializable(arg) {
  * @hidden
  *  Package version.
  */
-const version = "2.55.1-beta.0";
+const version = "2.56.0";
 
 ;// ./src/public/featureFlags.ts
 // All build feature flags are defined inside this object. Any build feature flag must have its own unique getter and setter function. This pattern allows for client apps to treeshake unused code and avoid including code guarded by this feature flags in the final bundle. If this property isn't desired, use the below runtime feature flags object.
@@ -4730,8 +4742,9 @@ function resetBuildFeatureFlags() {
 const defaultFeatureFlags = {
     disableEnforceOriginMatchForChildResponses: false,
 };
-// Object that stores the current runtime feature flag state
-let runtimeFeatureFlags = defaultFeatureFlags;
+// Object that stores the current runtime feature flag state. A copy is taken so that callers of
+// getCurrentFeatureFlagsState() never receive a reference to defaultFeatureFlags itself.
+let runtimeFeatureFlags = Object.assign({}, defaultFeatureFlags);
 /**
  * @returns The current state of the runtime feature flags.
  */
@@ -4754,6 +4767,17 @@ function overwriteFeatureFlagsState(newFeatureFlags) {
     setFeatureFlagsState(Object.assign(Object.assign({}, runtimeFeatureFlags), newFeatureFlags));
     return getCurrentFeatureFlagsState();
 }
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use.
+ *
+ * Restores the runtime feature flags to their default values. This mirrors {@link resetBuildFeatureFlags}
+ * and is intended for test teardown so that a flag set by one test cannot leak into later ones.
+ */
+function resetFeatureFlagsState() {
+    setFeatureFlagsState(Object.assign({}, defaultFeatureFlags));
+}
 
 ;// ./src/internal/messageObjects.ts
 var messageObjects_rest = (undefined && undefined.__rest) || function (s, e) {
@@ -6994,18 +7018,27 @@ function getValidOriginsListFromCDN(shouldDisableCache = false) {
         }
     });
 }
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * Exported so the JSON validation can be unit tested directly.
+ */
 function isValidOriginsJSONValid(validOriginsJSON) {
-    let validOriginsCDN = JSON.parse(validOriginsJSON);
+    let validOriginsCDN;
     try {
         validOriginsCDN = JSON.parse(validOriginsJSON);
     }
     catch (_) {
         return false;
     }
-    if (!validOriginsCDN.validOrigins) {
+    if (!validOriginsCDN || !Array.isArray(validOriginsCDN.validOrigins)) {
         return false;
     }
     for (const validOrigin of validOriginsCDN.validOrigins) {
+        if (typeof validOrigin !== 'string') {
+            return false;
+        }
         try {
             new URL('https://' + validOrigin);
         }
@@ -9526,6 +9559,115 @@ function openFilePreview(filePreviewParameters) {
     sendMessageToParent(getApiVersionTag(privateAPIsTelemetryVersionNumber, "openFilePreview" /* ApiName.PrivateAPIs_OpenFilePreview */), 'openFilePreview', params);
 }
 
+;// ./src/private/contextualSearch.ts
+/**
+ * @hidden
+ * Module to interact with the Teams Contextual Search pane.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @module
+ */
+
+
+
+
+
+
+/**
+ * v1 APIs telemetry file: All APIs in this capability file should
+ * send API version v1 only.
+ */
+const contextualSearchTelemetryVersionNumber = "v1" /* ApiVersionNumber.V_1 */;
+/**
+ * Opens the contextual search pane.
+ *
+ * The returned promise resolves when the host has processed the request.
+ *
+ * @param request - Optional parameters for opening contextual search.
+ * @returns Promise resolved when the host processes the request.
+ *
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function openContextualSearch(request) {
+    ensureInitialized(runtime, FrameContexts.content);
+    if (!contextualSearch_isSupported()) {
+        throw errorNotSupportedOnPlatform;
+    }
+    const args = [request === null || request === void 0 ? void 0 : request.triggerSource];
+    return callFunctionInHost("contextualSearch.openContextualSearch" /* ApiName.ContextualSearch_OpenContextualSearch */, args, getApiVersionTag(contextualSearchTelemetryVersionNumber, "contextualSearch.openContextualSearch" /* ApiName.ContextualSearch_OpenContextualSearch */));
+}
+/**
+ * Closes the contextual search pane.
+ *
+ * The returned promise resolves when the host has processed the request.
+ *
+ * @returns Promise resolved when the host processes the request.
+ *
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function closeContextualSearch() {
+    ensureInitialized(runtime, FrameContexts.content);
+    if (!contextualSearch_isSupported()) {
+        throw errorNotSupportedOnPlatform;
+    }
+    return callFunctionInHost("contextualSearch.closeContextualSearch" /* ApiName.ContextualSearch_CloseContextualSearch */, [], getApiVersionTag(contextualSearchTelemetryVersionNumber, "contextualSearch.closeContextualSearch" /* ApiName.ContextualSearch_CloseContextualSearch */));
+}
+/**
+ * Registers a handler invoked when the contextual search pane becomes visible.
+ *
+ * This includes pane visibility changes initiated by host entry points such as
+ * keyboard shortcuts or autosuggest.
+ *
+ * @param handler - Handler invoked when contextual search becomes visible.
+ *
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function registerOnContextualSearchOpenedHandler(handler) {
+    registerHandlerHelper(getApiVersionTag(contextualSearchTelemetryVersionNumber, "contextualSearch.registerOpenContextualSearchHandler" /* ApiName.ContextualSearch_RegisterOpenContextualSearchHandler */), 'contextualSearchOpened', handler, [FrameContexts.content], () => {
+        if (!contextualSearch_isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
+    });
+}
+/**
+ * Registers a handler invoked when the contextual search pane is closed.
+ *
+ * @param handler - Handler invoked when contextual search is closed.
+ *
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function registerOnContextualSearchClosedHandler(handler) {
+    registerHandlerHelper(getApiVersionTag(contextualSearchTelemetryVersionNumber, "contextualSearch.registerCloseContextualSearchHandler" /* ApiName.ContextualSearch_RegisterCloseContextualSearchHandler */), 'contextualSearchClosed', handler, [FrameContexts.content], () => {
+        if (!contextualSearch_isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
+    });
+}
+/**
+ * Checks whether the contextual search capability is supported by the host.
+ *
+ * @returns Whether contextual search is supported.
+ *
+ * @throws Error if {@linkcode app.initialize} has not completed successfully.
+ *
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function contextualSearch_isSupported() {
+    return ensureInitialized(runtime) && !!runtime.supports.contextualSearch;
+}
+
 ;// ./src/private/conversations.ts
 /**
  * @hidden
@@ -14924,6 +15066,8 @@ class SerializableContentSizeArgs {
 
 
 
+
+
 
 
 
@@ -18310,46 +18454,46 @@ const onChangeHandlerName = 'search.queryChange';
 const onClosedHandlerName = 'search.queryClose';
 const onExecutedHandlerName = 'search.queryExecute';
 /**
-   * 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
-   */
+ * 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, onExecuteHandler, onChangeHandler) {
     ensureInitialized(runtime, FrameContexts.content);
     if (!search_isSupported()) {