@thoughtspot/visual-embed-sdk 1.24.0-preRender.5 → 1.24.0-preRender.7

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

@@ -22,6 +22,18 @@ interface PreRenderProps {
             * });
             * embed.showPreRender();
             * ```
+            *
+            * Use PreRendered react component for pre rendering embed components.
+            * @example
+            * ```tsx
+            * function LandingPageComponent() {
+            *  return <PreRenderedLiveboardEmbed preRenderId="someId" liveboardId="libId" />
+            * }
+            * ```
+            * function MyComponent() {
+            *  return <LiveboardEmbed preRenderId="someId" liveboardId="libId" />
+            * }
+            * ```
             * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
             */
         preRenderId: string;
@@ -216,7 +228,7 @@ export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<
 /**
     * @group Embed components
     */
-export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2'> {
+export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2' | 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
         /**
             * The array of data source GUIDs to set on load.
             * Only a single dataSource supported currently.
@@ -273,7 +285,7 @@ export declare class SearchBarEmbed extends TsEmbed {
     */
 export interface SearchOptions {
         /**
-            * The tml string to load the answer
+            * The query string to pre-fill in natual language search bar
             */
         searchQuery: string;
         /**
@@ -291,15 +303,45 @@ export interface SearchOptions {
     * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
     * @group Embed components
     */
-export interface SageViewConfig extends ViewConfig {
+export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
         /**
             * If set to true, a list of liveboard and answers related
             * to the natural language search will be shown below the
             * AI generated answer.
+            *
+            * @deprecated Currently liveboard and answers related
+            * to the natural language search will not be shown for sage
+            * embed
             */
         showObjectResults?: boolean;
+        /**
+            * flag used by the TS product tour page to show the blue search bar
+            * even after the search is completed. This is different from TSE Sage Embed
+            * experience where it mimics closer to the non-embed case.
+            * The Sample questions container is collapsed when this value is set after
+            * does a search.
+            *
+            * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
+            * @hidden
+            */
+        isProductTour?: boolean;
+        /**
+            * flag to hide search bar title. default false.
+            *
+            * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
+            */
+        hideSearchBarTitle?: boolean;
+        /**
+            * flag to disable Sage Answer header(`AI Answer` title section on top of the Sage
+            * answer). default false.
+            *
+            * @version SDK: 1.26.0 | Thoughtspot: 9.9.0.cl
+            */
+        hideSageAnswerHeader?: boolean;
         /**
             * flag to disable changing worksheet. default false.
+            *
+            * @version SDK: 1.26.0 | Thoughtspot: 9.9.0.cl
             */
         disableWorksheetChange?: boolean;
         /**
@@ -307,18 +349,24 @@ export interface SageViewConfig extends ViewConfig {
             */
         hideWorksheetSelector?: boolean;
         /**
-            * If set to true, the search suggestions will contain existing
-            * liveboards and answers in addition with the autocomplete
+            * If set to true, the search bar auto complete search suggestions will not be shown.
+            * default false
             *
+            * @version SDK: 1.26.0 | Thoughtspot: 9.9.0.cl
             */
-        showObjectSuggestions?: boolean;
+        hideAutocompleteSuggestions?: boolean;
         /**
-            * The query string to pre-fill in natual language search bar
+            * If set to false, the auto complete search suggestions not be shown
+            *
+            * @deprecated currently, object suggestions will not be shown for sage embed
+            * earlier this flag was used to show Auto complete suggestions
             */
-        searchQuery?: string;
+        showObjectSuggestions?: boolean;
         /**
             * If set to true, sample questions would be hidden to user.
             * These sample questions are autogenerated based on selected datasource.
+            *
+            * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
             */
         hideSampleQuestions?: boolean;
         /**
@@ -327,6 +375,8 @@ export interface SageViewConfig extends ViewConfig {
         dataSource?: string;
         /**
             * Configuration for search options
+            *
+            * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
             */
         searchOptions?: SearchOptions;
 }
@@ -389,7 +439,7 @@ export interface SearchOptions {
     *
     * @group Embed components
     */
-export interface SearchViewConfig extends ViewConfig {
+export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
         /**
             * If set to true, the data sources panel is collapsed on load,
             * but can be expanded manually.
@@ -463,10 +513,6 @@ export interface SearchViewConfig extends ViewConfig {
             * @version: SDK: 1.24.0
             */
         useLastSelectedSources?: boolean;
-        /**
-            * The list of parameter override to apply to a search answer.
-            */
-        runtimeParameters?: RuntimeParameter[];
 }
 export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
 /**
@@ -536,7 +582,7 @@ export declare enum Page {
     *
     * @group Embed components
     */
-export interface AppViewConfig extends ViewConfig {
+export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
         /**
             * If true, the main navigation bar within the ThoughtSpot app
             * is displayed. By default, the navigation bar is hidden.
@@ -630,6 +676,27 @@ export interface AppViewConfig extends ViewConfig {
             * @hidden
             */
         dataPanelV2?: boolean;
+        /**
+            * Show or hide Liveboard header
+            *
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+            * @default false
+            */
+        hideLiveboardHeader?: boolean;
+        /**
+            * Show or hide Liveboard title
+            *
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+            * @default false
+            */
+        showLiveboardTitle?: boolean;
+        /**
+            * Show or hide Liveboard description
+            *
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+            * @default false
+            */
+        showLiveboardDescription?: boolean;
         /**
             * Flag to control new Modular Home experience
             *
@@ -637,6 +704,19 @@ export interface AppViewConfig extends ViewConfig {
             * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
             */
         modularHomeExperience?: boolean;
+        /**
+            * Boolean to control if Liveboard header is sticky or not.
+            *
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#embed', {
+            *   ... // other app view config
+            *   isLiveboardHeaderSticky: true,
+            * });
+            * ```
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        isLiveboardHeaderSticky?: boolean;
 }
 /**
     * Embeds full ThoughtSpot experience in a host application.
@@ -696,7 +776,7 @@ export declare class AppEmbed extends V1Embed {
     *
     * @group Embed components
     */
-export interface LiveboardViewConfig extends ViewConfig {
+export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'reorderedHomepageModules'> {
         /**
             * If set to true, the embedded object container dynamically resizes
             * according to the height of the Liveboard.
@@ -762,7 +842,7 @@ export interface LiveboardViewConfig extends ViewConfig {
             */
         liveboardV2?: boolean;
         /**
-            * Tab Id of the Liveboard that is supposed to be active
+            * Tab ID of the Liveboard that is supposed to be active
             *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
             */
@@ -774,9 +854,39 @@ export interface LiveboardViewConfig extends ViewConfig {
             */
         hideTabPanel?: boolean;
         /**
-            * The list of parameter override to apply to a Liveboard.
+            * Show or hide Liveboard header
+            *
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+            * @default false
+            */
+        hideLiveboardHeader?: boolean;
+        /**
+            * Show or hide Liveboard title
+            *
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+            * @default false
             */
-        runtimeParameters?: RuntimeParameter[];
+        showLiveboardTitle?: boolean;
+        /**
+            * Show or hide Liveboard description
+            *
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+            * @default false
+            */
+        showLiveboardDescription?: boolean;
+        /**
+            * Boolean for sticky Liveboard header.
+            *
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed', {
+            *   ... // other liveboard view config
+            *   isLiveboardHeaderSticky: true,
+            * });
+            * ```
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        isLiveboardHeaderSticky?: boolean;
 }
 /**
     * Embed a ThoughtSpot Liveboard or a Thoughtspot visualization. When rendered it already
@@ -853,7 +963,7 @@ export function getViewPropsAndListeners<T extends EmbedProps, U extends ViewCon
   * @summary ThoughtSpot Visual Embed SDK
   * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
   */
-export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, };
+export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, };
 
 /**
     * Copyright (c) 2023
@@ -1471,9 +1581,12 @@ export interface ViewConfig {
         /**
             * The list of parameter override to apply to a search answer,
             * visualization, or Liveboard.
+            *
+            * @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
             */
         runtimeParameters?: RuntimeParameter[];
         /**
+         /**
             * The locale/language to use for the embedded view.
             *
             * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
@@ -1541,27 +1654,6 @@ export interface ViewConfig {
             * @hidden
             */
         excludeRuntimeFiltersfromURL?: boolean;
-        /**
-            * Boolean to hide liveboard header
-            *
-            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
-            * @default false
-            */
-        hideLiveboardHeader?: boolean;
-        /**
-            * Boolean to show liveboard title
-            *
-            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
-            * @default false
-            */
-        showLiveboardTitle?: boolean;
-        /**
-            * Boolean to show liveboard description
-            *
-            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
-            * @default false
-            */
-        showLiveboardDescription?: boolean;
         /**
             * The list of tab IDs to hide from the embedded.
             * This Tabs will be hidden from their respective LBs.
@@ -1638,23 +1730,23 @@ export interface ViewConfig {
             */
         preRenderId?: string;
         /**
-            * Determines whether the PreRender component should dynamically track the size
+            * Determines whether the PreRender component should not dynamically track the size
             * of its embedding element and adjust its own size accordingly.
             * Enabling this option allows the PreRender component to automatically adapt
             * its dimensions based on changes to the size of the embedding element.
             *
             * @type {boolean}
-            * @default true
+            * @default false
             * @example
-            * // Enable tracking PreRender size in the configuration
+            * // Disable tracking PreRender size in the configuration
             * const config = {
-            *   trackPreRenderSize: true,
+            *   doNotTrackPreRenderSize: true,
             * };
             *
             * // Instantiate an object with the configuration
             * const myComponent = new MyComponent(config);
             */
-        trackPreRenderSize?: boolean;
+        doNotTrackPreRenderSize?: boolean;
 }
 /**
     * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -2357,11 +2449,11 @@ export declare enum HostEvent {
             * @param - execute - executes the existing / updated query
             * @example
             * ```js
-            * searchEmbed.trigger(HostEvent.Search, {
-            *   searchQuery: "[sales] by [item type],
-            *   dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"]
-            *   execute: true
-            * })
+            * searchembed.trigger(HostEvent.Search, {
+                 searchQuery: "[sales] by [item type]",
+                 dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
+                 execute: true
+             });
             * ```
             */
         Search = "search",
@@ -3115,6 +3207,7 @@ export declare enum Param {
         DisableWorksheetChange = "disableWorksheetChange",
         HideEurekaResults = "hideEurekaResults",
         HideEurekaSuggestions = "hideEurekaSuggestions",
+        HideAutocompleteSuggestions = "hideAutocompleteSuggestions",
         HideLiveboardHeader = "hideLiveboardHeader",
         ShowLiveboardDescription = "showLiveboardDescription",
         ShowLiveboardTitle = "showLiveboardTitle",
@@ -3126,7 +3219,11 @@ export declare enum Param {
         Query = "query",
         HideHomepageLeftNav = "hideHomepageLeftNav",
         ModularHomeExperienceEnabled = "modularHomeExperience",
-        PendoTrackingKey = "additionalPendoKey"
+        PendoTrackingKey = "additionalPendoKey",
+        LiveboardHeaderSticky = "isLiveboardHeaderSticky",
+        IsProductTour = "isProductTour",
+        HideSearchBarTitle = "hideSearchBarTitle",
+        HideSageAnswerHeader = "hideSageAnswerHeader"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -3962,7 +4059,17 @@ export declare enum Action {
             * ```
             *  @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
             */
-        PersonalisedViewsDropdown = "personalisedViewsDropdown"
+        PersonalisedViewsDropdown = "personalisedViewsDropdown",
+        /**
+            * Action ID for Liveboard Users ( Recently Visited / social proof )
+            *
+            *  @example
+            * ```js
+            * disabledActions: [Action.LiveboardUsers]
+            * ```
+            *  @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        LiveboardUsers = "liveboardUsers"
 }
 export interface AnswerServiceType {
         getAnswer?: (offset: number, batchSize: number) => any;
@@ -4991,9 +5098,10 @@ export declare class AnswerService {
             *
             * @param userLocale
             * @param omitInfo Omit the download Info on top of the CSV
+            * @param includeInfo
             * @returns Response
             */
-        fetchCSVBlob(userLocale?: string, omitInfo?: boolean): Promise<Response>;
+        fetchCSVBlob(userLocale?: string, includeInfo?: boolean): Promise<Response>;
         getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
         executeQuery(query: string, variables: any): Promise<any>;
         getSession(): SessionInterface;