@thoughtspot/visual-embed-sdk 1.36.9 → 1.37.0-temp-nav

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}.
@@ -1062,6 +1063,20 @@ export declare enum HomePageSearchBarMode {
         AI_ANSWER = "aiAnswer",
         NONE = "none"
 }
+export interface ModularHomeExperienceV3 {
+        /**
+            * Enabled the modular homepage version 3.
+            */
+        enabled?: boolean;
+        /**
+            * homePage values are v2/v3,
+            * v2 will show the modular homepage experience
+            * v3 will show the new modular homepage v3 experience.
+            *
+            * @default v2
+            */
+        homePage?: string;
+}
 /**
     * The view configuration for full app embedding.
     * @group Embed components
@@ -1130,6 +1145,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 +1383,23 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * ```
             */
         modularHomeExperience?: boolean;
+        /**
+            * Flag to control new navigation v3 home experience.
+            *
+            * @default false
+            * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#tsEmbed', {
+            *    ... // other options
+            *    modularHomeExperienceV3 : {
+            *      enabled: true,
+            *      homePage: 'v2'
+            *    },
+            * })
+            * ```
+            */
+        modularHomeExperienceV3?: ModularHomeExperienceV3;
         /**
             * Boolean to control if Liveboard header is sticky or not.
             * @example
@@ -1868,10 +1945,10 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
         dataSourceId?: string;
         /**
             * This flag is for show/hide checkboxes for include or exclude
-            * cover and filter pages in the Liveboard PDF
+            * cover page and filters in the Liveboard PDF.
             * @type {boolean}
             * @default true
-            * @version SDK: 1.38.0 | ThoughtSpot:10.8.0.cl
+            * @version SDK: 1.37.0 | ThoughtSpot:10.8.0.cl
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed-container', {
@@ -2134,7 +2211,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 +2704,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
@@ -3041,8 +3143,8 @@ export interface ViewConfig {
             * Hide list page columns
             * For example: hiddenListColumns = [ListPageColumns.Author]
             *
-            * **Note**: This option is appplicable only in full app embedding.
-            * @version SDK: 1.38.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
+            * **Note**: This option is available only in full app embedding.
+            * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
             * @example
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
@@ -3199,8 +3301,8 @@ export declare enum HomepageModule {
 }
 /**
     * List page columns that can be hidden.
-    * **Note**: This option is applicable only in full app embedding.
-    * @version SDK: 1.38.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
+    * **Note**: This option is applicable to full app embedding only.
+    * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
     */
 export declare enum ListPageColumns {
         /**
@@ -4283,7 +4385,7 @@ export declare enum EmbedEvent {
             *      searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
             * })
             * ```
-            * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl
+            * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
             */
         TableVizRendered = "TableVizRendered",
         /**
@@ -4296,12 +4398,12 @@ export declare enum EmbedEvent {
          *     console.log('payload', payload);
          * })
          *```
-         * @version SDK : 1.38.0 | ThoughtSpot : 10.8.0.cl
+         * @version SDK : 1.37.0 | ThoughtSpot : 10.8.0.cl
          */
         CreateLiveboard = "createLiveboard",
         /**
             * Emitted when a user creates a Model.
-            * @version SDK : 1.38.0 | ThoughtSpot : 10.8.0.cl
+            * @version SDK : 1.37.0 | ThoughtSpot : 10.8.0.cl
             */
         CreateModel = "createModel"
 }
@@ -4743,7 +4845,7 @@ export declare enum HostEvent {
             * ```js
             * liveboardEmbed.trigger(HostEvent.Remove)
             * ```
-            * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
+            * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
             */
         Remove = "delete",
         /**
@@ -5204,8 +5306,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 +5324,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
@@ -5338,7 +5453,7 @@ export declare enum HostEvent {
             *      searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
             * })
             * ```
-            * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl
+            * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
             */
         TransformTableVizData = "TransformTableVizData"
 }
@@ -5411,6 +5526,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 +5585,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
@@ -6673,7 +6793,7 @@ export declare enum Action {
             * ```js
             * hiddenAction: [Action.ColumnRename]
             * ```
-            *  @version SDK: 1.38.0 | ThoughtSpot Cloud: 10.8.0.cl
+            *  @version SDK: 1.37.0 | ThoughtSpot Cloud: 10.8.0.cl
             */
         ColumnRename = "columnRename",
         /**
@@ -6683,7 +6803,7 @@ export declare enum Action {
             * ```js
             * hiddenAction: [Action.CoverAndFilterOptionInPDF]
             * ```
-            *  @version SDK: 1.38.0 | ThoughtSpot Cloud: 10.8.0.cl
+            *  @version SDK: 1.37.0 | ThoughtSpot Cloud: 10.8.0.cl
             */
         CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF"
 }
@@ -7777,29 +7897,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
     */