@thoughtspot/visual-embed-sdk 1.24.0-dev → 1.24.0-preRender.1

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

@@ -39,6 +39,7 @@ interface AppProps extends EmbedProps, AppViewConfig {
     * ```
     */
 export const AppEmbed: React.ForwardRefExoticComponent<AppProps & React.RefAttributes<_AppEmbed>>;
+export const PreRenderedAppEmbed: React.ForwardRefExoticComponent<AppProps & React.RefAttributes<_AppEmbed>>;
 interface LiveboardProps extends EmbedProps, LiveboardViewConfig {
 }
 /**
@@ -58,6 +59,8 @@ interface LiveboardProps extends EmbedProps, LiveboardViewConfig {
     */
 export const LiveboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<_LiveboardEmbed>>;
 export const PinboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<_LiveboardEmbed>>;
+export const PreRenderedLiveboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<_LiveboardEmbed>>;
+export const PreRenderedPinboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<_LiveboardEmbed>>;
 interface SearchBarEmbedProps extends EmbedProps, SearchBarViewConfig {
 }
 /**
@@ -74,6 +77,7 @@ interface SearchBarEmbedProps extends EmbedProps, SearchBarViewConfig {
     * ```
     */
 export const SearchBarEmbed: React.ForwardRefExoticComponent<SearchBarEmbedProps & React.RefAttributes<_SearchBarEmbed>>;
+export const PreRenderedSearchBarEmbed: React.ForwardRefExoticComponent<SearchBarEmbedProps & React.RefAttributes<_SearchBarEmbed>>;
 interface SageEmbedProps extends EmbedProps, SageViewConfig {
 }
 /**
@@ -90,6 +94,7 @@ interface SageEmbedProps extends EmbedProps, SageViewConfig {
     * ```
     */
 export const SageEmbed: React.ForwardRefExoticComponent<SageEmbedProps & React.RefAttributes<_SageEmbed>>;
+export const PreRenderedSageEmbed: React.ForwardRefExoticComponent<SageEmbedProps & React.RefAttributes<_SageEmbed>>;
 type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmbed | typeof SearchBarEmbed | typeof SageEmbed;
 /**
     * Get a reference to the embed component to trigger events on the component.
@@ -109,7 +114,6 @@ type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmb
     * @returns {React.MutableRefObject<T extends TsEmbed>} ref
     */
 export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<React.ComponentRef<T>>;
-export const PreRenderedLiveboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<_LiveboardEmbed>>;
 
 /**
     * @group Embed components
@@ -150,6 +154,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
@@ -240,6 +245,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
@@ -251,9 +257,11 @@ export declare class SageEmbed extends V1Embed {
         /**
             * Render the embedded ThoughtSpot Sage
             *
+            * @param showPreRenderByDefault
             * @returns {SageEmbed} Eureka/Sage embed
             */
-        render(): SageEmbed;
+        render(showPreRenderByDefault?: boolean): SageEmbed;
+        preRender(showPreRenderByDefault?: boolean): SageEmbed;
 }
 
 /**
@@ -375,12 +383,16 @@ 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;
         /**
             * Render the embedded ThoughtSpot search
+            *
+            * @param showPreRenderByDefault
             */
-        render(): SearchEmbed;
+        render(showPreRenderByDefault?: boolean): SearchEmbed;
+        preRender(showPreRenderByDefault?: boolean): SearchEmbed;
 }
 
 /**
@@ -540,6 +552,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
@@ -571,8 +584,10 @@ export declare class AppEmbed extends V1Embed {
             *
             * @param renderOptions An object containing the page ID
             * to be embedded.
+            * @param showPreRenderByDefault
             */
-        render(): AppEmbed;
+        render(showPreRenderByDefault?: boolean): AppEmbed;
+        preRender(showPreRenderByDefault?: boolean): AppEmbed;
 }
 
 /**
@@ -689,6 +704,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
@@ -708,8 +724,8 @@ export declare class LiveboardEmbed extends V1Embed {
             * @param renderOptions An object specifying the Liveboard ID,
             * visualization ID and the runtime filters.
             */
-        render(): LiveboardEmbed;
-        preRender(): LiveboardEmbed;
+        render(showPreRenderByDefault?: boolean): LiveboardEmbed;
+        preRender(showPreRenderByDefault?: boolean): LiveboardEmbed;
         navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
 }
 /**
@@ -745,7 +761,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, 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, };
 
 /**
     * Copyright (c) 2023
@@ -1478,6 +1494,13 @@ 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.
@@ -1507,7 +1530,19 @@ export interface ViewConfig {
             */
         hiddenHomeLeftNavItems?: HomeLeftNavItem[];
         /**
-            * TBD
+            * PreRender id to be used for PreRendering the embed.
+            * Use PreRender to render the embed in the background and then
+            * show or hide the rendered embed using showPreRender or hidePreRender respectively.
+            *
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed', {
+            *   ... // other liveboard view config
+            *   preRenderId: "preRenderId-123"
+            * });
+            * embed.showPreRender();
+            * ```
+            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
             */
         preRenderId?: string;
 }
@@ -1628,27 +1663,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
@@ -3819,18 +3854,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;
 }
@@ -3847,6 +3870,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;
+}
 
 /**
     * Copyright (c) 2022
@@ -3879,6 +3935,7 @@ export declare class TsEmbed {
             */
         protected thoughtSpotHost: string;
         protected thoughtSpotV2Base: string;
+        protected embedComponentType: string;
         constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
         /**
             * Handles errors within the SDK
@@ -3911,14 +3968,15 @@ export declare class TsEmbed {
         protected getEmbedParams(): string;
         protected getRootIframeSrc(): string;
         protected createIframeEl(frameSrc: string): HTMLIFrameElement;
+        protected handleInsertionIntoDOM(child: string | Node, showPreRenderByDefault?: boolean): void;
         /**
             * Renders the embedded ThoughtSpot app in an iframe and sets up
             * event listeners.
             *
-            * @param url
-            * @param frameOptions
+            * @param url - The URL of the embedded ThoughtSpot app.
+            * @param showPreRenderByDefault - The flag to show the preRender by default.
             */
-        protected renderIFrame(url: string): Promise<any>;
+        protected renderIFrame(url: string, showPreRenderByDefault?: boolean): Promise<any>;
         getPreRenderIds(): {
                 wrapper: string;
                 shield: string;
@@ -3926,10 +3984,10 @@ export declare class TsEmbed {
         };
         protected createPreRenderWrapper(child: HTMLElement): HTMLDivElement;
         protected preRenderWrapper: HTMLElement;
-        protected preRenderShield: HTMLElement;
         protected preRenderChild: HTMLElement;
+        protected connectPreRendered(): boolean;
         protected isPreRenderAvailable(): boolean;
-        protected insertIntoDOMForPreRender(child: string | HTMLElement): void;
+        protected insertIntoDOMForPreRender(child: string | HTMLElement, showPreRenderByDefault?: boolean): void;
         hidePreRender(): void;
         showPreRender(): void;
         syncPreRenderStyle(): void;
@@ -4031,8 +4089,10 @@ export declare class TsEmbed {
         render(): TsEmbed;
         /**
             * Creates the preRender shell
+            *
+            * @param showPreRenderByDefault
             */
-        preRender(): TsEmbed;
+        preRender(showPreRenderByDefault?: boolean): TsEmbed;
         /**
             * Get the Post Url Params for THOUGHTSPOT from the current
             * host app URL.
@@ -4072,8 +4132,9 @@ export declare class V1Embed extends TsEmbed {
             * Render the app in an iframe and set up event handlers
             *
             * @param iframeSrc
+            * @param showPreRenderByDefault - if true the preRender will be shown by default
             */
-        protected renderV1Embed(iframeSrc: string): any;
+        protected renderV1Embed(iframeSrc: string, showPreRenderByDefault?: boolean): any;
         protected getRootIframeSrc(): string;
         /**
             * @inheritdoc
@@ -4186,6 +4247,7 @@ export declare const renderInQueue: (fn: (next?: (val?: any) => void) => Promise
     *
     * @param data
     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+    * @group Global methods
     */
 export declare const executeTML: (data: executeTMLInput) => Promise<any>;
 /**
@@ -4194,6 +4256,7 @@ export declare const executeTML: (data: executeTMLInput) => Promise<any>;
     *
     * @param data
     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+    * @group Global methods
     */
 export declare const exportTML: (data: exportTMLInput) => Promise<any>;
 /**
@@ -4725,3 +4788,59 @@ 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 {};
+