@thoughtspot/visual-embed-sdk 1.24.0 → 1.24.2

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

@@ -119,12 +119,12 @@ export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<
   * @summary ThoughtSpot Visual Embed SDK
   * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
   */
-export { init, logout, prefetch, executeTML, exportTML, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, 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, };
 
 /**
     * @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'> {
         /**
             * The array of data source GUIDs to set on load.
             * Only a single dataSource supported currently.
@@ -160,6 +160,7 @@ export declare class SearchBarEmbed extends TsEmbed {
             * The view configuration for the embedded ThoughtSpot search bar.
             */
         protected viewConfig: SearchBarViewConfig;
+        protected embedComponentType: string;
         constructor(domSelector: string, viewConfig: SearchBarViewConfig);
         /**
             * Render the embedded ThoughtSpot search
@@ -198,7 +199,7 @@ 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'> {
         /**
             * If set to true, a list of liveboard and answers related
             * to the natural language search will be shown below the
@@ -250,6 +251,7 @@ export declare class SageEmbed extends V1Embed {
             *
             */
         protected viewConfig: SageViewConfig;
+        protected embedComponentType: string;
         constructor(domSelector: DOMSelector, viewConfig: SageViewConfig);
         /**
             * Constructs a map of parameters to be passed on to the
@@ -295,7 +297,7 @@ export interface SearchOptions {
     *
     * @group Embed components
     */
-export interface SearchViewConfig extends ViewConfig {
+export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs'> {
         /**
             * If set to true, the data sources panel is collapsed on load,
             * but can be expanded manually.
@@ -389,6 +391,7 @@ export declare class SearchEmbed extends TsEmbed {
             * The view configuration for the embedded ThoughtSpot search.
             */
         protected viewConfig: SearchViewConfig;
+        protected embedComponentType: string;
         constructor(domSelector: DOMSelector, viewConfig: SearchViewConfig);
         protected getEmbedParams(): string;
         /**
@@ -445,7 +448,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.
@@ -539,6 +542,27 @@ export interface AppViewConfig extends ViewConfig {
             * @hidden
             */
         dataPanelV2?: boolean;
+        /**
+            * Boolean to hide liveboard header
+            *
+            * @version SDK: 1.23.0 | Thoughtspot: 9.6.0.cl
+            * @default false
+            */
+        hideLiveboardHeader?: boolean;
+        /**
+            * Boolean to show liveboard title
+            *
+            * @version SDK: 1.23.0 | Thoughtspot: 9.6.0.cl
+            * @default false
+            */
+        showLiveboardTitle?: boolean;
+        /**
+            * Boolean to show liveboard description
+            *
+            * @version SDK: 1.23.0 | Thoughtspot: 9.6.0.cl
+            * @default false
+            */
+        showLiveboardDescription?: boolean;
         /**
             * Flag to control new Modular Home experience
             *
@@ -554,6 +578,7 @@ export interface AppViewConfig extends ViewConfig {
     */
 export declare class AppEmbed extends V1Embed {
         protected viewConfig: AppViewConfig;
+        protected embedComponentType: string;
         constructor(domSelector: DOMSelector, viewConfig: AppViewConfig);
         /**
             * Constructs a map of parameters to be passed on to the
@@ -604,7 +629,7 @@ export declare class AppEmbed extends V1Embed {
     *
     * @group Embed components
     */
-export interface LiveboardViewConfig extends ViewConfig {
+export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems'> {
         /**
             * If set to true, the embedded object container dynamically resizes
             * according to the height of the Liveboard.
@@ -681,6 +706,27 @@ export interface LiveboardViewConfig extends ViewConfig {
             * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
             */
         hideTabPanel?: boolean;
+        /**
+            * Boolean to hide liveboard header
+            *
+            * @version SDK: 1.23.0 | Thoughtspot: 9.6.0.cl
+            * @default false
+            */
+        hideLiveboardHeader?: boolean;
+        /**
+            * Boolean to show liveboard title
+            *
+            * @version SDK: 1.23.0 | Thoughtspot: 9.6.0.cl
+            * @default false
+            */
+        showLiveboardTitle?: boolean;
+        /**
+            * Boolean to show liveboard description
+            *
+            * @version SDK: 1.23.0 | Thoughtspot: 9.6.0.cl
+            * @default false
+            */
+        showLiveboardDescription?: boolean;
         /**
             * The list of parameter override to apply to a Liveboard.
             */
@@ -703,6 +749,7 @@ export interface LiveboardViewConfig extends ViewConfig {
     */
 export declare class LiveboardEmbed extends V1Embed {
         protected viewConfig: LiveboardViewConfig;
+        protected embedComponentType: string;
         constructor(domSelector: DOMSelector, viewConfig: LiveboardViewConfig);
         /**
             * Construct a map of params to be passed on to the
@@ -837,17 +884,16 @@ export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolea
 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
+    * @group Global methods
     */
 export declare const executeTML: (data: executeTMLInput) => Promise<any>;
 /**
-    * Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML
-    * format.
-    *
+    * 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
+    * @group Global methods
     */
 export declare const exportTML: (data: exportTMLInput) => Promise<any>;
 /**
@@ -1724,27 +1770,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.
@@ -1769,6 +1794,12 @@ export interface ViewConfig {
             * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
             */
         hiddenHomepageModules?: HomepageModule[];
+        /**
+            * reordering the home page modules
+            * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
+            * @version SDK: 1.28.0 | Thoughtspot: 9.9.0.cl
+            */
+        reorderedHomepageModules?: HomepageModule[];
         /**
             * The list of tab IDs to show in the embedded.
             * Only this Tabs will be shown in their respective LBs.
@@ -1915,27 +1946,27 @@ export declare enum HomepageModule {
         /**
             * Search bar
             */
-        Search = "search",
+        Search = "SEARCH",
         /**
             * kPI watchlist module
             */
-        Watchlist = "watchlist",
+        Watchlist = "WATCHLIST",
         /**
             * favorite objects
             */
-        Favorite = "favorite",
+        Favorite = "FAVORITE",
         /**
             * List of answers and liveboards
             */
-        MyLibrary = "mylibrary",
+        MyLibrary = "MY_LIBRARY",
         /**
             * Trending list
             */
-        Trending = "trending",
+        Trending = "TRENDING",
         /**
             * Learning videos
             */
-        Learning = "learning"
+        Learning = "LEARNING"
 }
 /**
     * A filter that can be applied to ThoughtSpot answers, Liveboards, or
@@ -4106,18 +4137,6 @@ export declare enum Action {
             */
         PersonalisedViewsDropdown = "personalisedViewsDropdown"
 }
-export interface SessionInterface {
-        sessionId: string;
-        genNo: number;
-        acSession: {
-                sessionId: string;
-                genNo: number;
-        };
-}
-export declare enum OperationType {
-        GetChartWithData = "GetChartWithData",
-        GetTableWithHeadlineData = "GetTableWithHeadlineData"
-}
 export interface AnswerServiceType {
         getAnswer?: (offset: number, batchSize: number) => any;
 }
@@ -4134,6 +4153,39 @@ export declare enum ContextMenuTriggerOptions {
         LEFT_CLICK = "left-click",
         RIGHT_CLICK = "right-click"
 }
+export interface ColumnValue {
+        column: {
+                id: string;
+                name: string;
+                dataType: string;
+                [key: string]: any;
+        };
+        value: string | number | boolean;
+}
+export interface VizPoint {
+        selectedAttributes: ColumnValue[];
+        selectedMeasures: ColumnValue[];
+}
+export interface CustomActionPayload {
+        contextMenuPoints?: {
+                clickedPoint: VizPoint;
+                selectedPoints: VizPoint[];
+        };
+        embedAnswerData: {
+                name: string;
+                id: string;
+                sources: {
+                        header: {
+                                guid: string;
+                        };
+                };
+                columns: any[];
+                data: any[];
+                [key: string]: any;
+        };
+        session: SessionInterface;
+        vizId?: string;
+}
 
 /**
     * The list of customization css variables. These
@@ -4476,6 +4528,62 @@ export interface CustomCssVariables {
         '--ts-var-home-favorite-suggestion-card-background'?: string;
 }
 
+export interface SessionInterface {
+        sessionId: string;
+        genNo: number;
+        acSession: {
+                sessionId: string;
+                genNo: number;
+        };
+}
+export declare enum OperationType {
+        GetChartWithData = "GetChartWithData",
+        GetTableWithHeadlineData = "GetTableWithHeadlineData"
+}
+interface UnderlyingDataPoint {
+        columnId: string;
+        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.
+    *
+    * @example
+    * ```js
+    *  embed.on(EmbedEvent.CustomAction, e => {
+    *     const underlying = await e.answerService.getUnderlyingDataForPoint([
+    *       'col name 1'
+    *     ]);
+    *     const data = await underlying.fetchData(0, 100);
+    *  })
+    * ```
+    * @version
+    * ThoughtSpot: 9.9.0.cl / SDK: 1.25.0
+    */
+export declare class AnswerService {
+        constructor(session: SessionInterface, answer: any, thoughtSpotHost: string, selectedPoints?: VizPoint[]);
+        getSourceDetail(): Promise<any>;
+        removeColumns(columnIds: string[]): Promise<any>;
+        addColumns(columnIds: string[]): Promise<any>;
+        fetchData(offset?: number, size?: number): Promise<{
+                columns: any;
+                data: any;
+        }>;
+        /**
+            *
+            * @param userLocale
+            * @param omitInfo Omit the download Info on top of the CSV
+            * @returns Response
+            */
+        fetchCSVBlob(userLocale?: string, omitInfo?: boolean): Promise<Response>;
+        getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
+        executeQuery(query: string, variables: any): Promise<any>;
+        getSession(): SessionInterface;
+}
+export {};
+
 /**
     * Copyright (c) 2022
     *
@@ -4507,6 +4615,7 @@ export declare class TsEmbed {
             */
         protected thoughtSpotHost: string;
         protected thoughtSpotV2Base: string;
+        protected embedComponentType: string;
         constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
         /**
             * Handles errors within the SDK