@thoughtspot/visual-embed-sdk 1.45.3 → 1.46.0

package/src/embed/app.ts

@@ -60,7 +60,7 @@ export enum Page {
     /**
      *  Monitor Alerts Page
      */
-    Monitor = 'monitor'
+    Monitor = 'monitor',
 }
 
 /**
@@ -230,7 +230,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
      * });
      * ```
      */
-    enablePendoHelp?: boolean
+    enablePendoHelp?: boolean;
     /**
      * Control the visibility of the hamburger icon on
      * the top navigation bar in the V3 navigation experience.
@@ -740,7 +740,6 @@ export class AppEmbed extends V1Embed {
 
     private defaultHeight = 500;
 
-
     constructor(domSelector: DOMSelector, viewConfig: AppViewConfig) {
         viewConfig.embedComponentType = 'AppEmbed';
         super(domSelector, viewConfig);
@@ -748,7 +747,10 @@ export class AppEmbed extends V1Embed {
             this.on(EmbedEvent.RouteChange, this.setIframeHeightForNonEmbedLiveboard);
             this.on(EmbedEvent.EmbedHeight, this.updateIFrameHeight);
             this.on(EmbedEvent.EmbedIframeCenter, this.embedIframeCenter);
-            this.on(EmbedEvent.RequestVisibleEmbedCoordinates, this.requestVisibleEmbedCoordinatesHandler);
+            this.on(
+                EmbedEvent.RequestVisibleEmbedCoordinates,
+                this.requestVisibleEmbedCoordinatesHandler,
+            );
         }
     }
 
@@ -942,7 +944,9 @@ export class AppEmbed extends V1Embed {
         }
 
         if (isLiveboardStylingAndGroupingEnabled !== undefined) {
-            params[Param.IsLiveboardStylingAndGroupingEnabled] = isLiveboardStylingAndGroupingEnabled;
+            params[
+                Param.IsLiveboardStylingAndGroupingEnabled
+            ] = isLiveboardStylingAndGroupingEnabled;
         }
 
         if (isPNGInScheduledEmailsEnabled !== undefined) {
@@ -996,6 +1000,10 @@ export class AppEmbed extends V1Embed {
             params[Param.DataPanelCustomGroupsAccordionInitialState] = DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL;
         }
 
+        if (modularHomeExperience !== undefined) {
+            params[Param.ModularHomeExperienceEnabled] = modularHomeExperience;
+        }
+
         // Set navigation to v2 by default to avoid problems like the app
         // switcher (9-dot menu) not showing when v3 navigation is turned on
         // at the cluster level.
@@ -1005,9 +1013,6 @@ export class AppEmbed extends V1Embed {
         // Set homePageVersion to v2 by default to reset the LD flag value
         // for the homepageVersion.
         params[Param.HomepageVersion] = 'v2';
-        // Set listpageVersion to v2 by default to reset the LD flag value
-        // for the listpageVersion.
-        params[Param.ListPageVersion] = ListPage.List;
         if (discoveryExperience) {
             // primaryNavbarVersion v3 will enabled the new left navigation
             if (discoveryExperience.primaryNavbarVersion === PrimaryNavbarVersion.Sliding) {
@@ -1029,8 +1034,8 @@ export class AppEmbed extends V1Embed {
                 params[Param.HomepageVersion] = HomePage.ModularWithStylingChanges;
             }
 
-            // listPageVersion v3 will enable the new list page
-            if (discoveryExperience.listPageVersion === ListPage.ListWithUXChanges) {
+            // listPageVersion can be changed to v2 or v3
+            if (discoveryExperience.listPageVersion !== undefined) {
                 params[Param.ListPageVersion] = discoveryExperience.listPageVersion;
             }
         }

package/src/embed/conversation.ts

@@ -162,7 +162,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      *
      * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
      * @default true
-     * @version SDK: 1.41.1 | ThoughtSpot Cloud: 10.14.0.cl
+     * @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
      * @example
      * ```js
      * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed

package/src/types.ts

@@ -1361,7 +1361,7 @@ export interface SearchLiveboardCommonViewConfig {
      *
      * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
      * @default true
-     * @version SDK: 1.41.1 | ThoughtSpot Cloud: 10.14.0.cl
+     * @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
      * @example
      * ```js
      * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -2859,65 +2859,69 @@ export enum EmbedEvent {
     Rename = 'rename',
     /**
      *
-     * This event can be emitted to intercept search execution initiated by
-     * users and implement logic to allow or restrict search execution.
-     * You can also show custom error text if the search query must be
-     * restricted due to your application or business requirements.
-
-     * Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true`
-     * for this embed event to get emitted.
-     * @param - Includes the following event listener parameters:
+     * This event allows developers to intercept search execution
+     * and implement logic that decides whether Search Data should return
+     * data or block the search operation.
+     *
+     * **Prerequisite**: Set`isOnBeforeGetVizDataInterceptEnabled` to `true`
+     * to ensure that `EmbedEvent.OnBeforeGetVizDataIntercept` is emitted
+     * when the embedding application user tries to run a search query.
+     * 
+     * This framework applies only to `AppEmbed` and `SearchEmbed`.
+     * @param - Includes the following parameters:
      * - `payload`: The payload received from the embed related to the Data API call.
      * - `responder`: Contains elements that let developers define whether ThoughtSpot
-     *   should run the search, and if not, what error message
-     *   should be shown to the user.
+     *   will run or block the search operation, and if blocked, which error message to provide.
      *
-     * `execute` - When `execute` returns `true`, the search will be run.
-     * When `execute` returns `false`, the search will not be executed.
+     * `execute` - When `execute` returns `true`, the search is run.
+     * When `execute` returns `false`, the search is not executed.
      *
-     * `error` - Developers can customize the error message text when `execute`
-     * is `false` using the `errorText` and `errorDescription` parameters in responder.
-     *
-     * `errorText` - The error message text to be shown to the user.
-     * `errorDescription (ThoughtSpot: 10.15.0.cl and above)` - The error description to be shown to the user.
+     * `error` - Developers can customize the user-facing error message when `execute`
+     * is `false` by using the `error` parameters in `responder`.
+     * `errorText` - The error message text shown to the user.
      * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
      * @example
-     *```js
-     * embed.on(EmbedEvent.OnBeforeGetVizDataIntercept,
-     * (payload, responder) => {
-     *  responder({
-     *      data: {
-     *          execute:false,
-     *          error: {
-     *          //Provide a custom error message to explain to your end user
-     *          //why their search did not run
-     *          errorText: "This search query cannot be run.
-     *          Please contact your administrator for more details."
-     *          }
-     *  }})
-     * })
+     *
+     * This example blocks search operation and returns a custom error message:
+     * ```js
+     * embed.on(EmbedEvent.OnBeforeGetVizDataIntercept, (payload, responder) => {
+     *   responder({
+     *     data: {
+     *       execute: false,
+     *       error: {
+     *         // Provide a custom error message to explain why the search did not run.
+     *         errorText: 'This search query cannot be run. Please contact your administrator for more details.',
+     *       },
+     *     },
+     *   });
+     * });
      * ```
+     * @example
      *
-     *```js
-     * embed.on(EmbedEvent.OnBeforeGetVizDataIntercept,
-     * (payload, responder) => {
-     * const query = payload.data.data.answer.search_query
-     * responder({
-     *  data: {
-     *      // returns true as long as the query does not include
-     *      // both the 'sales' AND the 'county' column
-     *      execute: !(query.includes("sales")&&query.includes("county")),
-     *      error: {
-     *      //Provide a custom error message to explain to your end user
-     *      // why their search did not run, and which searches are accepted by your custom logic.
-     *      errorText: "Error Occurred",
-     *      errorDescription: "You can't use this query :" + query + ".
-     *      The 'sales' measures can never be used at the 'county' level.
-     *      Please try another measure, or remove 'county' from your search."
-     *      }
-     *  }})
-     * })
-     *```
+     * This example allows the search operation to run
+     * unless the query contains both `sales` and `county`,
+     * and returns a custom error message if the query is rejected:
+     * ```js
+     * embed.on(EmbedEvent.OnBeforeGetVizDataIntercept, (payload, responder) => {
+     *   // Record the search query submitted by the end user.
+     *   const query = payload.data.data.answer.search_query;
+     *
+     *   responder({
+     *     data: {
+     *       // Returns true as long as the query does not include both `sales` and `county`.
+     *       execute: !(query.includes('sales') && query.includes('county')),
+     *       error: {
+     *         // Provide a custom error message when the query is blocked by your logic.
+     *         errorText:
+     *           "You can't use this query: "
+     *           + query
+     *           + ". The 'sales' measure can never be used at the 'county' level. "
+     *           + "Please try another measure or remove 'county' from your search.",
+     *       },
+     *     },
+     *   });
+     * });
+     * ```
      */
     OnBeforeGetVizDataIntercept = 'onBeforeGetVizDataIntercept',
     /**
@@ -6907,4 +6911,4 @@ export interface ContextObject {
     type: ContextType;
     objectIds: ObjectIds;
    }
-}
+}