@thoughtspot/visual-embed-sdk 1.24.0-alpha.0 → 1.24.0-alpha.1

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

@@ -123,7 +123,7 @@ export { init, logout, prefetch, executeTML, exportTML, getEmbedConfig as getIni
 /**
     * @group Embed components
     */
-export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts'> {
+export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2'> {
         /**
             * The array of data source GUIDs to set on load.
             * Only a single dataSource supported currently.
@@ -168,6 +168,22 @@ export declare class SearchBarEmbed extends TsEmbed {
     * @summary TS Sage embed
     * @author Mourya Balabhadra <mourya.balabhadra@thoughtspot.com>
     */
+/**
+    * Configuration for search options
+    */
+export interface SearchOptions {
+        /**
+            * The tml string to load the answer
+            */
+        searchQuery: string;
+        /**
+            * Boolean to determine if the search should be executed or not.
+            * if it is executed, put the focus on the results.
+            * if it’s not executed, put the focus in the search bar - at the end of
+            * the tokens
+            */
+        executeSearch?: boolean;
+}
 /**
     * The configuration attributes for the embedded Natural language search view. Based on
     * GPT and LLM.
@@ -177,7 +193,9 @@ export declare class SearchBarEmbed extends TsEmbed {
     */
 export interface SageViewConfig extends ViewConfig {
         /**
-            * If set to true, object results are shown.
+            * If set to true, a list of liveboard and answers related
+            * to the natural language search will be shown below the
+            * AI generated answer.
             */
         showObjectResults?: boolean;
         /**
@@ -189,7 +207,8 @@ export interface SageViewConfig extends ViewConfig {
             */
         hideWorksheetSelector?: boolean;
         /**
-            * If set to true, the object search suggestions are not shown
+            * If set to true, the search suggestions will contain existing
+            * liveboards and answers in addition with the autocomplete
             *
             */
         showObjectSuggestions?: boolean;
@@ -206,6 +225,10 @@ export interface SageViewConfig extends ViewConfig {
             * The data source GUID to set on load.
             */
         dataSource?: string;
+        /**
+            * Configuration for search options
+            */
+        searchOptions?: SearchOptions;
 }
 export declare const HiddenActionItemByDefaultForSageEmbed: Action[];
 /**
@@ -326,6 +349,14 @@ export interface SearchViewConfig extends ViewConfig {
             * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
             */
         hideSearchBar?: boolean;
+        /**
+            * Flag to control Data panel experience
+            *
+            * @default false
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+            * @hidden
+            */
+        dataPanelV2?: boolean;
 }
 export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
 /**
@@ -387,7 +418,7 @@ export declare enum Page {
         /**
             * SpotIQ listing page
             */
-        SpotIQ = "spotiq"
+        SpotIQ = "insights"
 }
 /**
     * The view configuration for full app embedding.
@@ -457,6 +488,14 @@ export interface AppViewConfig extends ViewConfig {
             * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
             */
         fullHeight?: boolean;
+        /**
+            * Flag to control Data panel experience
+            *
+            * @default false
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+            * @hidden
+            */
+        dataPanelV2?: boolean;
 }
 /**
     * Embeds full ThoughtSpot experience in a host application.
@@ -969,7 +1008,17 @@ export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolea
     * @param fn The function being registered
     */
 export declare const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
+/**
+    * Imports TML representation of the metadata objects into ThoughtSpot.
+    * @param data
+    * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+    */
 export declare const executeTML: (data: executeTMLInput) => Promise<any>;
+/**
+    * Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML format.
+    * @param data
+    * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+    */
 export declare const exportTML: (data: exportTMLInput) => Promise<any>;
 /**
     *
@@ -1413,6 +1462,9 @@ export interface CustomStyles {
 export interface CustomisationsInterface {
         style?: CustomStyles;
         content?: {
+                /**
+                    * @version SDK: 1.26.0 | 9.7.0.cl
+                    */
                 strings?: Record<string, any>;
                 [key: string]: any;
         };
@@ -1820,21 +1872,21 @@ export interface ViewConfig {
         /**
             * Boolean to hide liveboard header
             *
-            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             * @default false
             */
         hideLiveboardHeader?: boolean;
         /**
             * Boolean to show liveboard title
             *
-            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             * @default false
             */
         showLiveboardTitle?: boolean;
         /**
             * Boolean to show liveboard description
             *
-            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             * @default false
             */
         showLiveboardDescription?: boolean;
@@ -1852,7 +1904,7 @@ export interface ViewConfig {
             *  'f547ec54-2a37-4516-a222-2b06719af726']
             * });
             * ```
-            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         hiddenTabs?: string[];
         /**
@@ -1871,7 +1923,7 @@ export interface ViewConfig {
             *  'f547ec54-2a37-4516-a222-2b06719af726']
             * });
             * ```
-            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         visibleTabs?: string[];
 }
@@ -3109,6 +3161,19 @@ export declare enum HostEvent {
             * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
             */
         UpdateFilters = "updateFilters",
+        /**
+            * Get Tab for the current Liveboard.
+            *
+            * @example
+            * ```js
+            * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
+            *   console.log(
+            *      tabDetails // TabDetails of current LB
+            *   );
+            * })
+            * ```
+            * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
+            */
         GetTabs = "getTabs",
         /**
             * Set the visible Tabs on a Liveboard.
@@ -3121,7 +3186,7 @@ export declare enum HostEvent {
             *  '430496d6-6903-4601-937e-2c691821af3c',
             *  'f547ec54-2a37-4516-a222-2b06719af726'])
             * ```
-            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         SetVisibleTabs = "SetPinboardVisibleTabs",
         /**
@@ -3135,9 +3200,23 @@ export declare enum HostEvent {
             *  '630496d6-6903-4601-937e-2c691821af3c',
             *  'i547ec54-2a37-4516-a222-2b06719af726'])
             * ```
-            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
-        SetHiddenTabs = "SetPinboardHiddenTabs"
+        SetHiddenTabs = "SetPinboardHiddenTabs",
+        /**
+            * Updates the search query for sage embed.
+            *
+            * @param - searchOptions: an object queryString and option to execute the query.
+            * @example
+            * ```js
+            * sageEmbed.trigger(HostEvent.UpdateSageQuery, {
+            *  queryString: 'revenue per year',
+            *  executeSearch: true,
+            * })
+            * ```
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        UpdateSageQuery = "updateSageQuery"
 }
 /**
     * The different visual modes that the data sources panel within
@@ -3192,6 +3271,7 @@ export declare enum Param {
         DisableLoginRedirect = "disableLoginRedirect",
         visibleVizs = "pinboardVisibleVizs",
         LiveboardV2Enabled = "isPinboardV2Enabled",
+        DataPanelV2Enabled = "enableDataPanelV2",
         ShowAlerts = "showAlerts",
         Locale = "locale",
         CustomStyle = "customStyle",
@@ -3219,8 +3299,8 @@ export declare enum Param {
         VisibleTabs = "visibleTabs",
         HideTabPanel = "hideTabPanel",
         HideSampleQuestions = "hideSampleQuestions",
-        WorksheetId = "worksheetId",
-        Query = "query,"
+        WorksheetId = "worksheet",
+        Query = "query"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -4005,7 +4085,7 @@ export declare enum Action {
             */
         MarkAsVerified = "markAsVerified",
         /**
-            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         AddTab = "addTab",
         /**

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

@@ -112,7 +112,7 @@ export const useEmbedRef: () => React.MutableRefObject<TsEmbed>;
 /**
     * @group Embed components
     */
-export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts'> {
+export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2'> {
         /**
             * The array of data source GUIDs to set on load.
             * Only a single dataSource supported currently.
@@ -157,6 +157,22 @@ export declare class SearchBarEmbed extends TsEmbed {
     * @summary TS Sage embed
     * @author Mourya Balabhadra <mourya.balabhadra@thoughtspot.com>
     */
+/**
+    * Configuration for search options
+    */
+export interface SearchOptions {
+        /**
+            * The tml string to load the answer
+            */
+        searchQuery: string;
+        /**
+            * Boolean to determine if the search should be executed or not.
+            * if it is executed, put the focus on the results.
+            * if it’s not executed, put the focus in the search bar - at the end of
+            * the tokens
+            */
+        executeSearch?: boolean;
+}
 /**
     * The configuration attributes for the embedded Natural language search view. Based on
     * GPT and LLM.
@@ -166,7 +182,9 @@ export declare class SearchBarEmbed extends TsEmbed {
     */
 export interface SageViewConfig extends ViewConfig {
         /**
-            * If set to true, object results are shown.
+            * If set to true, a list of liveboard and answers related
+            * to the natural language search will be shown below the
+            * AI generated answer.
             */
         showObjectResults?: boolean;
         /**
@@ -178,7 +196,8 @@ export interface SageViewConfig extends ViewConfig {
             */
         hideWorksheetSelector?: boolean;
         /**
-            * If set to true, the object search suggestions are not shown
+            * If set to true, the search suggestions will contain existing
+            * liveboards and answers in addition with the autocomplete
             *
             */
         showObjectSuggestions?: boolean;
@@ -195,6 +214,10 @@ export interface SageViewConfig extends ViewConfig {
             * The data source GUID to set on load.
             */
         dataSource?: string;
+        /**
+            * Configuration for search options
+            */
+        searchOptions?: SearchOptions;
 }
 export declare const HiddenActionItemByDefaultForSageEmbed: Action[];
 /**
@@ -315,6 +338,14 @@ export interface SearchViewConfig extends ViewConfig {
             * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
             */
         hideSearchBar?: boolean;
+        /**
+            * Flag to control Data panel experience
+            *
+            * @default false
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+            * @hidden
+            */
+        dataPanelV2?: boolean;
 }
 export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
 /**
@@ -376,7 +407,7 @@ export declare enum Page {
         /**
             * SpotIQ listing page
             */
-        SpotIQ = "spotiq"
+        SpotIQ = "insights"
 }
 /**
     * The view configuration for full app embedding.
@@ -446,6 +477,14 @@ export interface AppViewConfig extends ViewConfig {
             * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
             */
         fullHeight?: boolean;
+        /**
+            * Flag to control Data panel experience
+            *
+            * @default false
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+            * @hidden
+            */
+        dataPanelV2?: boolean;
 }
 /**
     * Embeds full ThoughtSpot experience in a host application.
@@ -1137,6 +1176,9 @@ export interface CustomStyles {
 export interface CustomisationsInterface {
         style?: CustomStyles;
         content?: {
+                /**
+                    * @version SDK: 1.26.0 | 9.7.0.cl
+                    */
                 strings?: Record<string, any>;
                 [key: string]: any;
         };
@@ -1544,21 +1586,21 @@ export interface ViewConfig {
         /**
             * Boolean to hide liveboard header
             *
-            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             * @default false
             */
         hideLiveboardHeader?: boolean;
         /**
             * Boolean to show liveboard title
             *
-            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             * @default false
             */
         showLiveboardTitle?: boolean;
         /**
             * Boolean to show liveboard description
             *
-            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             * @default false
             */
         showLiveboardDescription?: boolean;
@@ -1576,7 +1618,7 @@ export interface ViewConfig {
             *  'f547ec54-2a37-4516-a222-2b06719af726']
             * });
             * ```
-            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         hiddenTabs?: string[];
         /**
@@ -1595,7 +1637,7 @@ export interface ViewConfig {
             *  'f547ec54-2a37-4516-a222-2b06719af726']
             * });
             * ```
-            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         visibleTabs?: string[];
 }
@@ -2833,6 +2875,19 @@ export declare enum HostEvent {
             * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
             */
         UpdateFilters = "updateFilters",
+        /**
+            * Get Tab for the current Liveboard.
+            *
+            * @example
+            * ```js
+            * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
+            *   console.log(
+            *      tabDetails // TabDetails of current LB
+            *   );
+            * })
+            * ```
+            * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
+            */
         GetTabs = "getTabs",
         /**
             * Set the visible Tabs on a Liveboard.
@@ -2845,7 +2900,7 @@ export declare enum HostEvent {
             *  '430496d6-6903-4601-937e-2c691821af3c',
             *  'f547ec54-2a37-4516-a222-2b06719af726'])
             * ```
-            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         SetVisibleTabs = "SetPinboardVisibleTabs",
         /**
@@ -2859,9 +2914,23 @@ export declare enum HostEvent {
             *  '630496d6-6903-4601-937e-2c691821af3c',
             *  'i547ec54-2a37-4516-a222-2b06719af726'])
             * ```
-            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
-        SetHiddenTabs = "SetPinboardHiddenTabs"
+        SetHiddenTabs = "SetPinboardHiddenTabs",
+        /**
+            * Updates the search query for sage embed.
+            *
+            * @param - searchOptions: an object queryString and option to execute the query.
+            * @example
+            * ```js
+            * sageEmbed.trigger(HostEvent.UpdateSageQuery, {
+            *  queryString: 'revenue per year',
+            *  executeSearch: true,
+            * })
+            * ```
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        UpdateSageQuery = "updateSageQuery"
 }
 /**
     * The different visual modes that the data sources panel within
@@ -2916,6 +2985,7 @@ export declare enum Param {
         DisableLoginRedirect = "disableLoginRedirect",
         visibleVizs = "pinboardVisibleVizs",
         LiveboardV2Enabled = "isPinboardV2Enabled",
+        DataPanelV2Enabled = "enableDataPanelV2",
         ShowAlerts = "showAlerts",
         Locale = "locale",
         CustomStyle = "customStyle",
@@ -2943,8 +3013,8 @@ export declare enum Param {
         VisibleTabs = "visibleTabs",
         HideTabPanel = "hideTabPanel",
         HideSampleQuestions = "hideSampleQuestions",
-        WorksheetId = "worksheetId",
-        Query = "query,"
+        WorksheetId = "worksheet",
+        Query = "query"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -3729,7 +3799,7 @@ export declare enum Action {
             */
         MarkAsVerified = "markAsVerified",
         /**
-            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         AddTab = "addTab",
         /**
@@ -3868,7 +3938,17 @@ export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolea
     * @param fn The function being registered
     */
 export declare const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
+/**
+    * Imports TML representation of the metadata objects into ThoughtSpot.
+    * @param data
+    * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+    */
 export declare const executeTML: (data: executeTMLInput) => Promise<any>;
+/**
+    * Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML format.
+    * @param data
+    * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+    */
 export declare const exportTML: (data: exportTMLInput) => Promise<any>;
 /**
     *