@thoughtspot/visual-embed-sdk 1.37.0 → 1.37.1

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

@@ -279,7 +279,8 @@ export declare enum AuthFailureType {
         NO_COOKIE_ACCESS = "NO_COOKIE_ACCESS",
         EXPIRY = "EXPIRY",
         OTHER = "OTHER",
-        IDLE_SESSION_TIMEOUT = "IDLE_SESSION_TIMEOUT"
+        IDLE_SESSION_TIMEOUT = "IDLE_SESSION_TIMEOUT",
+        UNAUTHENTICATED_FAILURE = "UNAUTHENTICATED_FAILURE"
 }
 /**
     * Enum for auth status emitted by the emitter returned from {@link init}.
@@ -313,7 +314,11 @@ export declare enum AuthStatus {
             * or by the trigger button.
             * @version SDK: 1.19.0
             */
-        WAITING_FOR_POPUP = "WAITING_FOR_POPUP"
+        WAITING_FOR_POPUP = "WAITING_FOR_POPUP",
+        /**
+            * Emitted when the SAML popup is closed without authentication
+            */
+        SAML_POPUP_CLOSED_NO_AUTH = "SAML_POPUP_CLOSED_NO_AUTH"
 }
 /**
     * Event emitter returned from {@link init}.
@@ -331,10 +336,10 @@ export interface AuthEventEmitter {
             * @param event
             * @param listener
             */
-        on(event: AuthStatus.SDK_SUCCESS | AuthStatus.LOGOUT | AuthStatus.WAITING_FOR_POPUP, listener: () => void): this;
+        on(event: AuthStatus.SDK_SUCCESS | AuthStatus.LOGOUT | AuthStatus.WAITING_FOR_POPUP | AuthStatus.SAML_POPUP_CLOSED_NO_AUTH, listener: () => void): this;
         on(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this;
         once(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this;
-        once(event: AuthStatus.SDK_SUCCESS | AuthStatus.LOGOUT | AuthStatus.WAITING_FOR_POPUP, listener: () => void): this;
+        once(event: AuthStatus.SDK_SUCCESS | AuthStatus.LOGOUT | AuthStatus.WAITING_FOR_POPUP | AuthStatus.SAML_POPUP_CLOSED_NO_AUTH, listener: () => void): this;
         once(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this;
         /**
             * Trigger an event on the emitter returned from init.
@@ -1062,6 +1067,43 @@ export declare enum HomePageSearchBarMode {
         AI_ANSWER = "aiAnswer",
         NONE = "none"
 }
+/**
+    * Define the version of the primary navbar
+    * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
+    */
+export declare enum PrimaryNavbarVersion {
+        /**
+            * Sliding (v3) introduces a new left-side navigation hub featuring a tab switcher,
+            * along with updates to the top navigation bar.
+            * It serves as the foundational version of the PrimaryNavBar.
+            */
+        Sliding = "v3"
+}
+/**
+    * Define the version of the home page
+    * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
+    */
+export declare enum HomePage {
+        /**
+            * Modular (v2) introduces the updated Modular Home Experience.
+            * It serves as the foundational version of the home page.
+            */
+        Modular = "v2"
+}
+/**
+    * Define the discovery experience
+    * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
+    */
+export interface DiscoveryExperience {
+        /**
+            * primaryNavbarVersion determines the version of the navigation version.
+            */
+        primaryNavbarVersion?: PrimaryNavbarVersion;
+        /**
+            * homePage determines the version of the home page.
+            */
+        homePage?: HomePage;
+}
 /**
     * The view configuration for full app embedding.
     * @group Embed components
@@ -1130,6 +1172,51 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * ```
             */
         enablePendoHelp?: boolean;
+        /**
+            * Control the visibility of the hamburger icon on the top nav bar
+            * available when new navigation V3 is enabled.
+            *
+            * @default false
+            * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#tsEmbed', {
+            *    ... // other options
+            *    hideHamburger : true,
+            * })
+            * ```
+            */
+        hideHamburger?: boolean;
+        /**
+            * Control the visibility of the Eureka search on the top nav bar
+            * this will control for both new V2 and new navigation V3.
+            *
+            * @default true
+            * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#tsEmbed', {
+            *    ... // other options
+            *    hideObjectSearch: false,
+            * })
+            * ```
+            */
+        hideObjectSearch?: boolean;
+        /**
+            * Control the visibility of the notification on the top nav bar V3,
+            * available when new navigation V3 is enabled.
+            *
+            * @default true
+            * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#tsEmbed', {
+            *    ... // other options
+            *    hideNotification: false,
+            * })
+            * ```
+            */
+        hideNotification?: boolean;
         /**
             * Control the visibility of the application switcher button on the nav-bar.
             * By default, the application switcher is shown.
@@ -1323,6 +1410,23 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * ```
             */
         modularHomeExperience?: boolean;
+        /**
+            * To configure the top-left navigation and home page experience
+            *
+            * @default false
+            * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#tsEmbed', {
+            *    ... // other options
+            *    discoveryExperience : {
+            *      primaryNavbarVersion: PrimaryNavbarVersion.Sliding,
+            *      homePage: HompePage.Modular,
+            *    },
+            * })
+            * ```
+            */
+        discoveryExperience?: DiscoveryExperience;
         /**
             * Boolean to control if Liveboard header is sticky or not.
             * @example
@@ -2134,7 +2238,19 @@ export declare enum HomeLeftNavItem {
         /**
             * @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
             */
-        LiveboardSchedules = "liveboard-schedules"
+        LiveboardSchedules = "liveboard-schedules",
+        /**
+            * Create new options in the insights left navigation,
+            * available when new navigation V3 is enabled.
+            * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+            */
+        Create = "create",
+        /**
+            * Spotter option in the insights left navigation,
+            * available when new navigation V3 is enabled.
+            * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+            */
+        Spotter = "spotter"
 }
 export type DOMSelector = string | HTMLElement;
 /**
@@ -2615,6 +2731,19 @@ export interface ViewConfig {
             * ```
             */
         disabledActions?: Action[];
+        /**
+            * The primary action to display on top of the viz for Liveboard and App Embed.
+            * Use this to set the primary action.
+            * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed', {
+            *   ... // other liveboard view config
+            *   primaryAction: Action.Download
+            * });
+            * ```
+            */
+        primaryAction?: Action | string;
         /**
             * The tooltip to display for disabled actions.
             * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
@@ -4534,9 +4663,12 @@ export declare enum HostEvent {
             * @example
             * ```js
             * searchEmbed.trigger(HostEvent.OpenFilter,
-            * { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'})
+            *  {column: { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'}})
+            * ```
+            * @example
+            * ```js
             * LiveboardEmbed.trigger(HostEvent.OpenFilter,
-            *  { columnId: '<column-GUID>'})
+            *   { column: {columnId: '<column-GUID>'}})
             * ```
             * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
             */
@@ -5145,6 +5277,25 @@ export declare enum HostEvent {
             *    }]
             * });
             * ```
+            * If there are multiple columns with the same name, consider
+            * using `WORKSHEET_NAME::COLUMN_NAME` format.
+            *
+            * @example
+            *
+            * ```js
+            * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
+            *  filters: [{
+            *      column: "(Sample) Retail - Apparel::city",
+            *      oper: 'IN',
+            *      values: ["atlanta"]
+            *  },
+            *  {
+            *      column: "(Sample) Retail - Apparel::Region",
+            *      oper: 'IN',
+            *      values: ["West","Midwest"]
+            *  }]
+            * });
+            * ```
             * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
             */
         UpdateFilters = "updateFilters",
@@ -5204,8 +5355,17 @@ export declare enum HostEvent {
         /**
             * Get the Answer session for a Search or
             * Liveboard visualization.
+            *
+            * Note: This event is not typically used directly. Instead, use the
+            * `getAnswerService()` method on the embed instance to get an AnswerService
+            * object that provides a more convenient interface for working with answers.
+            *
             * @example
             * ```js
+            * // Preferred way to get an AnswerService
+            * const service = await embed.getAnswerService();
+            *
+            * // Alternative direct usage (not recommended)
             * const {session} = await embed.trigger(
             *  HostEvent.GetAnswerSession, {
             *      vizId: '123', // For Liveboard Visualization.
@@ -5213,6 +5373,10 @@ export declare enum HostEvent {
             * ```
             * @example
             * ```js
+            * // Preferred way to get an AnswerService
+            * const service = await embed.getAnswerService();
+            *
+            * // Alternative direct usage (not recommended)
             * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
             * ```
             * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
@@ -5411,6 +5575,10 @@ export declare enum Param {
         ShowInsertToSlide = "insertInToSlide",
         PrimaryNavHidden = "primaryNavHidden",
         HideProfleAndHelp = "profileAndHelpInNavBarHidden",
+        NavigationVersion = "navigationVersion",
+        HideHamburger = "hideHamburger",
+        HideObjectSearch = "hideObjectSearch",
+        HideNotification = "hideNotification",
         HideApplicationSwitcher = "applicationSwitcherHidden",
         HideOrgSwitcher = "orgSwitcherHidden",
         IsSageEmbed = "isSageEmbed",
@@ -5466,7 +5634,8 @@ export declare enum Param {
         DataSourceId = "dataSourceId",
         preAuthCache = "preAuthCache",
         ShowSpotterLimitations = "showSpotterLimitations",
-        CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF"
+        CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
+        PrimaryAction = "primaryAction"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -7777,29 +7946,49 @@ export interface UnderlyingDataPoint {
         dataValue: any;
 }
 /**
-    * Class representing the answer service provided with the
-    * custom action payload. This service could be used to run
-    * graphql queries in the context of the answer on which the
-    * custom action was triggered.
+    * AnswerService provides a simple way to work with ThoughtSpot Answers.
+    *
+    * This service allows you to interact with ThoughtSpot Answers programmatically,
+    * making it easy to customize visualizations, filter data, and extract insights
+    * directly from your application.
+    *
+    * You can use this service to:
+    * - Add or remove columns from Answers (`addColumns`, `removeColumns`, `addColumnsByName`)
+    * - Apply filters to Answers (`addFilter`)
+    * - Get data from Answers in different formats (JSON, CSV, PNG) (`fetchData`, `fetchCSVBlob`, `fetchPNGBlob`)
+    * - Get data for specific points in visualizations (`getUnderlyingDataForPoint`)
+    * - Run custom queries (`executeQuery`)
+    * - Add visualizations to liveboards (`addDisplayedVizToLiveboard`)
+    *
     * @example
     * ```js
-    *  embed.on(EmbedEvent.CustomAction, e => {
-    *     const underlying = await e.answerService.getUnderlyingDataForPoint([
-    *       'col name 1'
-    *     ]);
-    *     const data = await underlying.fetchData(0, 100);
-    *  })
+    * // Get the answer service
+    * embed.on(EmbedEvent.Data, async (e) => {
+    *     const service = await embed.getAnswerService();
+    *
+    *     // Add columns to the answer
+    *     await service.addColumnsByName(["Sales", "Region"]);
+    *
+    *     // Get the data
+    *     const data = await service.fetchData();
+    *     console.log(data);
+    * });
     * ```
+    *
     * @example
     * ```js
-    * embed.on(EmbedEvent.Data, async (e) => {
-    *     const service = await embed.getAnswerService();
-    *     await service.addColumns([
-    *         "<column guid>"
+    * // Get data for a point in a visualization
+    * embed.on(EmbedEvent.CustomAction, async (e) => {
+    *     const underlying = await e.answerService.getUnderlyingDataForPoint([
+    *       'Product Name',
+    *       'Sales Amount'
     *     ]);
-    *     console.log(await service.fetchData());
+    *
+    *     const data = await underlying.fetchData(0, 100);
+    *     console.log(data);
     * });
     * ```
+    *
     * @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
     * @group Events
     */