@thoughtspot/visual-embed-sdk 1.32.4 → 1.32.6

package/dist/visual-embed-sdk-react-full.d.ts

@@ -1130,6 +1130,48 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * @version SDK : 1.33.0 | Thoughtspot : 10.2.0.cl
             */
         homePageSearchBarMode?: HomePageSearchBarMode;
+        /**
+            * This flag is used to enable the compact header in liveboard
+            * @type {boolean}
+            * @default false
+            * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#embed-container', {
+            *    ... // other options
+            *    isLiveboardCompactHeaderEnabled: true,
+            * })
+            * ```
+            */
+        isLiveboardCompactHeaderEnabled?: boolean;
+        /**
+            * This flag is used to show/hide verified Icon in liveboard compact header
+            * @type {boolean}
+            * @default true
+            * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#embed-container', {
+            *    ... // other options
+            *    showLiveboardVerifiedBadge: true,
+            * })
+            * ```
+            */
+        showLiveboardVerifiedBadge?: boolean;
+        /**
+            * This flag is used to show/hide re-verify banner in liveboard compact header
+            * @type {boolean}
+            * @default true
+            * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#embed-container', {
+            *    ... // other options
+            *    showLiveboardReverifyBanner: true,
+            * })
+            * ```
+            */
+        showLiveboardReverifyBanner?: boolean;
 }
 /**
     * Embeds full ThoughtSpot experience in a host application.
@@ -1439,6 +1481,48 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
             */
         showPreviewLoader?: boolean;
+        /**
+            * This flag is used to enable the compact header in liveboard
+            * @type {boolean}
+            * @default false
+            * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed-container', {
+            *    ... // other options
+            *    isLiveboardCompactHeaderEnabled: true,
+            * })
+            * ```
+            */
+        isLiveboardCompactHeaderEnabled?: boolean;
+        /**
+            * This flag is used to show/hide verified Icon in liveboard compact header
+            * @type {boolean}
+            * @default true
+            * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed-container', {
+            *    ... // other options
+            *    showLiveboardVerifiedBadge: true,
+            * })
+            * ```
+            */
+        showLiveboardVerifiedBadge?: boolean;
+        /**
+            * This flag is used to show/hide re-verify banner in liveboard compact header
+            * @type {boolean}
+            * @default true
+            * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed-container', {
+            *    ... // other options
+            *    showLiveboardReverifyBanner: true,
+            * })
+            * ```
+            */
+        showLiveboardReverifyBanner?: boolean;
 }
 /**
     * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -1595,7 +1679,7 @@ export declare const renderInQueue: (fn: (next?: (val?: any) => void) => Promise
     }).catch(error => {
         console.error(error);
     });
-    *
+    *```
     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
     * @group Global methods
     */
@@ -2425,6 +2509,12 @@ export interface EmbedConfig {
             * @version SDK: 1.28.5 | Thoughtspot: *
             */
         disableTokenVerification?: boolean;
+        /**
+            * This flag is used to disable showing the login failure page in the embedded app.
+            *
+            * @version SDK 1.32.3 | Thoughtspot: *
+            */
+        disableLoginFailurePage?: boolean;
 }
 export interface LayoutConfig {
 }
@@ -3949,20 +4039,57 @@ export declare enum EmbedEvent {
             */
         Rename = "rename",
         /**
-            * Emitted when user wants to intercept the search execution
+            * Emitted if the user wants to intercept the search execution
+            * and implement logic to decide whether to run the search or not
             *
-            * Set IsOnBeforeGetVizDataInterceptEnabled : true to use
-            * this embed event
+            * Prerequisite: Set isOnBeforeGetVizDataInterceptEnabled : true
+            * for this embed event to get emitted.
+            *
+            * Parameter: payload
+            * Parameter: responder
+            * Contains elements that lets developers define whether ThoughtSpot
+            * will run the search or not, and if not, 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.
+            * error: Developers can customize the user facing message when execute is
+            * set to false using the error parameter in responder
             *
             *```js
-            * searchEmbed.on(EmbedEvent.OnBeforeGetVizDataIntercept,
+            * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
             * (payload, responder) => {
             *  responder({
             *      data: {
-            *          execute: true,
-            *   }})
+            *          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."
+            *          }
+            *  }})
+            * })
+            * ```
+            *
+            *```js
+            * .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: "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."
+            *      }
+            *  }})
             * })
             *```
+            *
             * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
             */
         OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
@@ -4081,6 +4208,15 @@ export declare enum HostEvent {
             * @hidden
             */
         Reload = "reload",
+        /**
+            * Get current iframe src
+            * @example
+            * ```js
+            * const frameUrl = AppEmbed.trigger(HostEvent.GetIframeUrl)
+            * ```
+            * @version SDK: 1.35.0 | Thoughtspot: 10.4.0.cl
+            */
+        GetIframeUrl = "GetIframeUrl",
         /**
             * Display specific visualizations on a Liveboard.
             * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
@@ -4945,7 +5081,10 @@ export declare enum Param {
         IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled",
         FocusSearchBarOnRender = "focusSearchBarOnRender",
         DisableRedirectionLinksInNewTab = "disableRedirectionLinksInNewTab",
-        HomePageSearchBarMode = "homePageSearchBarMode"
+        HomePageSearchBarMode = "homePageSearchBarMode",
+        ShowLiveboardVerifiedBadge = "showLiveboardVerifiedBadge",
+        ShowLiveboardReverifyBanner = "showLiveboardReverifyBanner",
+        LiveboardHeaderV2 = "isLiveboardHeaderV2Enabled"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -6600,6 +6739,15 @@ export declare class AnswerService {
             * @returns Response
             */
         fetchCSVBlob(userLocale?: string, includeInfo?: boolean): Promise<Response>;
+        /**
+            * Fetch the data for the answer as a PNG blob. This might be
+            * quicker for larger data.
+            * @param userLocale
+            * @param omitBackground Omit the background in the PNG
+            * @param deviceScaleFactor The scale factor for the PNG
+            * @return Response
+            */
+        fetchPNGBlob(userLocale?: string, includeInfo?: boolean, omitBackground?: boolean, deviceScaleFactor?: number): Promise<Response>;
         /**
             * Just get the internal URL for this answer's data
             * as a CSV blob.
@@ -6608,6 +6756,11 @@ export declare class AnswerService {
             * @returns
             */
         getFetchCSVBlobUrl(userLocale?: string, includeInfo?: boolean): string;
+        /**
+            * Just get the internal URL for this answer's data
+            * as a PNG blob.
+            */
+        getFetchPNGBlobUrl(userLocale?: string, omitBackground?: boolean, deviceScaleFactor?: number): string;
         /**
             * Get underlying data given a point and the output column names.
             * In case of a context menu action, the selectedPoints are
@@ -7004,7 +7157,6 @@ export declare class V1Embed extends TsEmbed {
         on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions): typeof TsEmbed.prototype;
         /**
             * Only for testing purposes.
-            *
             * @hidden
             */
         test__executeCallbacks: (eventType: EmbedEvent, data: any, eventPort?: void | MessagePort) => void;

package/dist/visual-embed-sdk-react.d.ts

@@ -1120,6 +1120,48 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * @version SDK : 1.33.0 | Thoughtspot : 10.2.0.cl
             */
         homePageSearchBarMode?: HomePageSearchBarMode;
+        /**
+            * This flag is used to enable the compact header in liveboard
+            * @type {boolean}
+            * @default false
+            * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#embed-container', {
+            *    ... // other options
+            *    isLiveboardCompactHeaderEnabled: true,
+            * })
+            * ```
+            */
+        isLiveboardCompactHeaderEnabled?: boolean;
+        /**
+            * This flag is used to show/hide verified Icon in liveboard compact header
+            * @type {boolean}
+            * @default true
+            * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#embed-container', {
+            *    ... // other options
+            *    showLiveboardVerifiedBadge: true,
+            * })
+            * ```
+            */
+        showLiveboardVerifiedBadge?: boolean;
+        /**
+            * This flag is used to show/hide re-verify banner in liveboard compact header
+            * @type {boolean}
+            * @default true
+            * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#embed-container', {
+            *    ... // other options
+            *    showLiveboardReverifyBanner: true,
+            * })
+            * ```
+            */
+        showLiveboardReverifyBanner?: boolean;
 }
 /**
     * Embeds full ThoughtSpot experience in a host application.
@@ -1429,6 +1471,48 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
             */
         showPreviewLoader?: boolean;
+        /**
+            * This flag is used to enable the compact header in liveboard
+            * @type {boolean}
+            * @default false
+            * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed-container', {
+            *    ... // other options
+            *    isLiveboardCompactHeaderEnabled: true,
+            * })
+            * ```
+            */
+        isLiveboardCompactHeaderEnabled?: boolean;
+        /**
+            * This flag is used to show/hide verified Icon in liveboard compact header
+            * @type {boolean}
+            * @default true
+            * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed-container', {
+            *    ... // other options
+            *    showLiveboardVerifiedBadge: true,
+            * })
+            * ```
+            */
+        showLiveboardVerifiedBadge?: boolean;
+        /**
+            * This flag is used to show/hide re-verify banner in liveboard compact header
+            * @type {boolean}
+            * @default true
+            * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed-container', {
+            *    ... // other options
+            *    showLiveboardReverifyBanner: true,
+            * })
+            * ```
+            */
+        showLiveboardReverifyBanner?: boolean;
 }
 /**
     * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -2057,6 +2141,12 @@ export interface EmbedConfig {
             * @version SDK: 1.28.5 | Thoughtspot: *
             */
         disableTokenVerification?: boolean;
+        /**
+            * This flag is used to disable showing the login failure page in the embedded app.
+            *
+            * @version SDK 1.32.3 | Thoughtspot: *
+            */
+        disableLoginFailurePage?: boolean;
 }
 export interface LayoutConfig {
 }
@@ -3581,20 +3671,57 @@ export declare enum EmbedEvent {
             */
         Rename = "rename",
         /**
-            * Emitted when user wants to intercept the search execution
+            * Emitted if the user wants to intercept the search execution
+            * and implement logic to decide whether to run the search or not
+            *
+            * Prerequisite: Set isOnBeforeGetVizDataInterceptEnabled : true
+            * for this embed event to get emitted.
             *
-            * Set IsOnBeforeGetVizDataInterceptEnabled : true to use
-            * this embed event
+            * Parameter: payload
+            * Parameter: responder
+            * Contains elements that lets developers define whether ThoughtSpot
+            * will run the search or not, and if not, 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.
+            * error: Developers can customize the user facing message when execute is
+            * set to false using the error parameter in responder
             *
             *```js
-            * searchEmbed.on(EmbedEvent.OnBeforeGetVizDataIntercept,
+            * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
             * (payload, responder) => {
             *  responder({
             *      data: {
-            *          execute: true,
-            *   }})
+            *          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."
+            *          }
+            *  }})
+            * })
+            * ```
+            *
+            *```js
+            * .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: "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."
+            *      }
+            *  }})
             * })
             *```
+            *
             * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
             */
         OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
@@ -3713,6 +3840,15 @@ export declare enum HostEvent {
             * @hidden
             */
         Reload = "reload",
+        /**
+            * Get current iframe src
+            * @example
+            * ```js
+            * const frameUrl = AppEmbed.trigger(HostEvent.GetIframeUrl)
+            * ```
+            * @version SDK: 1.35.0 | Thoughtspot: 10.4.0.cl
+            */
+        GetIframeUrl = "GetIframeUrl",
         /**
             * Display specific visualizations on a Liveboard.
             * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
@@ -4577,7 +4713,10 @@ export declare enum Param {
         IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled",
         FocusSearchBarOnRender = "focusSearchBarOnRender",
         DisableRedirectionLinksInNewTab = "disableRedirectionLinksInNewTab",
-        HomePageSearchBarMode = "homePageSearchBarMode"
+        HomePageSearchBarMode = "homePageSearchBarMode",
+        ShowLiveboardVerifiedBadge = "showLiveboardVerifiedBadge",
+        ShowLiveboardReverifyBanner = "showLiveboardReverifyBanner",
+        LiveboardHeaderV2 = "isLiveboardHeaderV2Enabled"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -6034,7 +6173,6 @@ export declare class V1Embed extends TsEmbed {
         on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions): typeof TsEmbed.prototype;
         /**
             * Only for testing purposes.
-            *
             * @hidden
             */
         test__executeCallbacks: (eventType: EmbedEvent, data: any, eventPort?: void | MessagePort) => void;
@@ -6132,7 +6270,7 @@ export declare const renderInQueue: (fn: (next?: (val?: any) => void) => Promise
     }).catch(error => {
         console.error(error);
     });
-    *
+    *```
     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
     * @group Global methods
     */
@@ -6889,6 +7027,15 @@ export declare class AnswerService {
             * @returns Response
             */
         fetchCSVBlob(userLocale?: string, includeInfo?: boolean): Promise<Response>;
+        /**
+            * Fetch the data for the answer as a PNG blob. This might be
+            * quicker for larger data.
+            * @param userLocale
+            * @param omitBackground Omit the background in the PNG
+            * @param deviceScaleFactor The scale factor for the PNG
+            * @return Response
+            */
+        fetchPNGBlob(userLocale?: string, includeInfo?: boolean, omitBackground?: boolean, deviceScaleFactor?: number): Promise<Response>;
         /**
             * Just get the internal URL for this answer's data
             * as a CSV blob.
@@ -6897,6 +7044,11 @@ export declare class AnswerService {
             * @returns
             */
         getFetchCSVBlobUrl(userLocale?: string, includeInfo?: boolean): string;
+        /**
+            * Just get the internal URL for this answer's data
+            * as a PNG blob.
+            */
+        getFetchPNGBlobUrl(userLocale?: string, omitBackground?: boolean, deviceScaleFactor?: number): string;
         /**
             * Get underlying data given a point and the output column names.
             * In case of a context menu action, the selectedPoints are