@thoughtspot/visual-embed-sdk 1.39.2-alpha.1 → 1.39.2-alpha.2

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

@@ -233,33 +233,42 @@ export const SpotterEmbed: React.ForwardRefExoticComponent<SpotterEmbedProps & R
     * ```
     */
 export const ConversationEmbed: React.ForwardRefExoticComponent<ConversationEmbedProps & React.RefAttributes<_ConversationEmbed>>;
-interface SpotterAgentEmbedProps extends EmbedProps, SpotterAgentEmbedViewConfig {
+/**
+    * React component for individual conversation messages from SpotterAgent.
+    * This component is used internally by the useSpotterAgent hook.
+    * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
+    */
+interface ConversationMessageProps extends EmbedProps, SpotterAgentMessageViewConfig {
 }
+export const ConversationMessage: React.ForwardRefExoticComponent<ConversationMessageProps & React.RefAttributes<_ConversationMessage>>;
 /**
-    * React component for SpotterAgent embed, which can be integrated inside
-    * chatbots or other conversational interfaces.
+    * React component for displaying individual conversation messages from SpotterAgent.
+    *
+    * This component renders a single message response from your ThoughtSpot conversation,
+    * showing charts, visualizations, or text responses based on the user's query.
+    *
     * @example
     * ```tsx
-    * function SpotterAgent() {
-    *  const ref = useRef();
+    * const { sendMessage } = useSpotterAgent({ worksheetId: 'worksheetId' });
+    * const result = await sendMessage('show me sales by region');
     *
-    *  const handleSendMessage = async () => {
-    *    const { container, error } = await ref.current.sendMessage('show me sales by region');
-    *    if (container) {
-    *      document.body.appendChild(container);
-    *    }
-    *  };
+    * if (!result.error) {
+    *   // Simple usage - just pass the message data
+    *   <SpotterMessage message={result.message} />
     *
-    *  return (
-    *    <div>
-    *      <SpotterAgentEmbed ref={ref} worksheetId="worksheetId" />
-    *      <button onClick={handleSendMessage}>Send Message</button>
-    *    </div>
-    *  );
+    *   // With optional query for context
+    *   <SpotterMessage
+    *     message={result.message}
+    *     query={result.query}
+    *   />
     * }
     * ```
+    * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
     */
-export const SpotterAgentEmbed: React.ForwardRefExoticComponent<SpotterAgentEmbedProps & React.RefAttributes<_SpotterAgentEmbed>>;
+export const SpotterMessage: React.ForwardRefExoticComponent<{
+        message: SpotterAgentMessageViewConfig;
+        query?: string;
+} & Omit<EmbedProps, keyof SpotterAgentMessageViewConfig> & React.RefAttributes<_ConversationMessage>>;
 /**
     * React component for PreRendered Conversation embed.
     *
@@ -279,7 +288,7 @@ export const SpotterAgentEmbed: React.ForwardRefExoticComponent<SpotterAgentEmbe
     * ```
     */
 export const PreRenderedConversationEmbed: React.ForwardRefExoticComponent<SpotterEmbedProps & PreRenderProps & React.RefAttributes<_SpotterEmbed>>;
-type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmbed | typeof SearchBarEmbed | typeof SageEmbed | typeof SpotterAgentEmbed | typeof SpotterEmbed | typeof ConversationEmbed;
+type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmbed | typeof SearchBarEmbed | typeof SageEmbed | typeof ConversationMessage | typeof SpotterMessage | typeof SpotterEmbed | typeof ConversationEmbed;
 /**
     * Get a reference to the embed component to trigger events on the component.
     * @example
@@ -311,6 +320,48 @@ export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<
     * @version SDK: 1.36.2 | ThoughtSpot: *
     */
 export function useInit(config: EmbedConfig): React.MutableRefObject<AuthEventEmitter>;
+/**
+    * React hook for interacting with SpotterAgent AI conversations.
+    *
+    * This hook provides a sendMessage function that allows you to send natural language
+    * queries to your data and get back AI-generated responses with visualizations.
+    *
+    * @param config - Configuration object containing worksheetId and other options
+    * @returns Object with sendMessage function that returns conversation results
+    * @example
+    * ```tsx
+    * const { sendMessage } = useSpotterAgent({ worksheetId: 'worksheetId' });
+    *
+    * const handleQuery = async () => {
+    *   const result = await sendMessage('show me sales by region');
+    *
+    *   if (!result.error) {
+    *     // Display the message response
+    *     <SpotterMessage message={result.message} />
+    *   } else {
+    *     console.error('Error:', result.error);
+    *   }
+    * };
+    * ```
+    * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
+    */
+export function useSpotterAgent(config: SpotterAgentEmbedViewConfig): {
+        sendMessage: (query: string) => Promise<{
+                error: any;
+                query?: undefined;
+                message?: undefined;
+        } | {
+                query: string;
+                message: {
+                        worksheetId: string;
+                        sessionId: any;
+                        genNo: any;
+                        acSessionId: any;
+                        acGenNo: any;
+                };
+                error?: undefined;
+        }>;
+};
 
 /**
   * Copyright (c) 2023
@@ -320,7 +371,7 @@ export function useInit(config: EmbedConfig): React.MutableRefObject<AuthEventEm
   * @summary ThoughtSpot Visual Embed SDK
   * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
   */
-export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversationViewConfig, BodylessConversation, SpotterEmbed, SpotterEmbedViewConfig, ConversationViewConfig, ConversationEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, 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, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, DataPanelCustomColumnGroupsAccordionState, };
+export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversationViewConfig, BodylessConversation, SpotterEmbed, SpotterEmbedViewConfig, ConversationViewConfig, ConversationEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, 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, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, ListPage, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, DataPanelCustomColumnGroupsAccordionState, };
 
 export declare let loggedInStatus: boolean;
 export declare let samlAuthWindow: Window;
@@ -1204,6 +1255,21 @@ export declare enum HomePage {
             */
         Modular = "v2"
 }
+/**
+    * Define the version of the list page
+    * @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
+    */
+export declare enum ListPage {
+        /**
+            * List (v2) is the traditional List Experience.
+            * It serves as the foundational version of the list page.
+            */
+        List = "v2",
+        /**
+            * ListWithUXChanges (v3) introduces the new updated list page with UX changes.
+            */
+        ListWithUXChanges = "v3"
+}
 /**
     * Define the discovery experience
     * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
@@ -1217,6 +1283,10 @@ export interface DiscoveryExperience {
             * homePage determines the version of the home page.
             */
         homePage?: HomePage;
+        /**
+            * listPageVersion determines the version of the list page.
+            */
+        listPageVersion?: ListPage;
 }
 /**
     * The view configuration for full app embedding.
@@ -1588,21 +1658,6 @@ export interface AppViewConfig extends AllEmbedViewConfig {
             * ```
             */
         isUnifiedSearchExperienceEnabled?: boolean;
-        /**
-         * Show alert messages and toast messages in the embedded
-         * view in full app embed.
-         *
-         * Supported embed types: `AppEmbed`
-         * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
-         * @example
-         * ```js
-         * const embed = new AppEmbed('#tsEmbed', {
-         *    ... // other embed view config
-         *    showAlerts:true,
-         * })
-         * ```
-         */
-        showAlerts?: boolean;
         /**
             * This flag is used to enable/disable the styling and grouping in a Liveboard
             *
@@ -1619,6 +1674,46 @@ export interface AppViewConfig extends AllEmbedViewConfig {
             * ```
             */
         isLiveboardStylingAndGroupingEnabled?: boolean;
+        /**
+            * This flag is used to enable the full height lazy load data.
+            *
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#embed-container', {
+            *    // ...other options
+            *    fullHeight: true,
+            *    lazyLoadingForFullHeight: true,
+            * })
+            * ```
+            *
+            * @type {boolean}
+            * @default false
+            * @version SDK: 1.39.0 | ThoughtSpot:10.10.0.cl
+            */
+        lazyLoadingForFullHeight?: boolean;
+        /**
+            * The margin to be used for lazy loading.
+            *
+            * For example, if the margin is set to '10px',
+            * the visualization will be loaded 10px before the its top edge is visible in the
+            * viewport.
+            *
+            * The format is similar to CSS margin.
+            *
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#embed-container', {
+            *    // ...other options
+            *    fullHeight: true,
+            *    lazyLoadingForFullHeight: true,
+            *   // Using 0px, the visualization will be only loaded when its visible in the viewport.
+            *    lazyLoadingMargin: '0px',
+            * })
+            * ```
+            * @type {string}
+            * @version SDK: 1.39.0 | ThoughtSpot:10.10.0.cl
+            */
+        lazyLoadingMargin?: string;
 }
 /**
     * Embeds full ThoughtSpot experience in a host application.
@@ -1655,6 +1750,11 @@ export declare class AppEmbed extends V1Embed {
             * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
             */
         navigateToPage(path: string | number, noReload?: boolean): void;
+        /**
+            * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
+            * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+            */
+        destroy(): void;
         /**
             * Renders the embedded application pages in the ThoughtSpot app.
             * @param renderOptions An object containing the page ID
@@ -1965,6 +2065,46 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
             * ```
             */
         isLiveboardStylingAndGroupingEnabled?: boolean;
+        /**
+            * This flag is used to enable the full height lazy load data.
+            *
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed-container', {
+            *    // ...other options
+            *    fullHeight: true,
+            *    lazyLoadingForFullHeight: true,
+            * })
+            * ```
+            *
+            * @type {boolean}
+            * @default false
+            * @version SDK: 1.39.0 | ThoughtSpot:10.10.0.cl
+            */
+        lazyLoadingForFullHeight?: boolean;
+        /**
+            * The margin to be used for lazy loading.
+            *
+            * For example, if the margin is set to '10px',
+            * the visualization will be loaded 10px before the its top edge is visible in the
+            * viewport.
+            *
+            * The format is similar to CSS margin.
+            *
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed-container', {
+            *    // ...other options
+            *    fullHeight: true,
+            *    lazyLoadingForFullHeight: true,
+            *   // Using 0px, the visualization will be only loaded when its visible in the viewport.
+            *    lazyLoadingMargin: '0px',
+            * })
+            * ```
+            * @type {string}
+            * @version SDK: 1.39.0 | ThoughtSpot:10.10.0.cl
+            */
+        lazyLoadingMargin?: string;
 }
 /**
     * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -1998,6 +2138,11 @@ export declare class LiveboardEmbed extends V1Embed {
             * @returns A promise that resolves with the response from the embedded app
             */
         trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
+        /**
+            * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
+            * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+            */
+        destroy(): void;
         /**
             * Render an embedded ThoughtSpot Liveboard or visualization
             * @param renderOptions An object specifying the Liveboard ID,
@@ -2027,10 +2172,6 @@ export interface SpotterAgentEmbedViewConfig extends Omit<BaseViewConfig, 'prima
             * The ID of the worksheet to use for the conversation.
             */
         worksheetId: string;
-        /**
-            * Optional CSS class name to add to the container div.
-            */
-        containerClassName?: string;
 }
 /**
     * Configuration for conversation options.
@@ -2040,13 +2181,13 @@ export interface SpotterAgentEmbedViewConfig extends Omit<BaseViewConfig, 'prima
     */
 export interface BodylessConversationViewConfig extends SpotterAgentEmbedViewConfig {
 }
-interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConfig {
+export interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConfig {
         sessionId: string;
         genNo: number;
         acSessionId: string;
         acGenNo: number;
 }
-declare class ConversationMessage extends TsEmbed {
+export declare class ConversationMessage extends TsEmbed {
         protected viewConfig: SpotterAgentMessageViewConfig;
         constructor(container: HTMLElement, viewConfig: SpotterAgentMessageViewConfig);
         getIframeSrc(): string;
@@ -2082,6 +2223,23 @@ export declare class SpotterAgentEmbed {
                 viz: ConversationMessage;
                 error?: undefined;
         }>;
+        /**
+            * Send a message to the conversation service and return only the data.
+            * @param userMessage - The message to send to the conversation service.
+            * @returns The data from the conversation service.
+            */
+        sendMessageData(userMessage: string): Promise<{
+                error: any;
+                data?: undefined;
+        } | {
+                data: {
+                        sessionId: any;
+                        genNo: any;
+                        acSessionId: any;
+                        acGenNo: any;
+                };
+                error?: undefined;
+        }>;
 }
 /**
     * Create a conversation embed, which can be integrated inside
@@ -2106,7 +2264,6 @@ export declare class SpotterAgentEmbed {
 export declare class BodylessConversation extends SpotterAgentEmbed {
         constructor(viewConfig: BodylessConversationViewConfig);
 }
-export {};
 
 /**
     * Copyright (c) 2023
@@ -2320,7 +2477,13 @@ export declare enum HomeLeftNavItem {
             * available when new navigation V3 is enabled.
             * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
             */
-        Spotter = "spotter"
+        Spotter = "spotter",
+        /**
+            * Favorites option in the insights left navigation,
+            * available when new navigation V3 is enabled.
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+            */
+        Favorites = "favorites"
 }
 export type DOMSelector = string | HTMLElement;
 /**
@@ -3086,6 +3249,20 @@ export interface BaseViewConfig {
             * @private
             */
         insertInToSlide?: boolean;
+        /**
+            * Show alert messages and toast messages in the embed.
+            * Supported embed in all embed types.
+            *
+            * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#tsEmbed', {
+            *    ... // other embed view config
+            *    showAlerts:true,
+            * })
+            * ```
+            */
+        showAlerts?: boolean;
 }
 /**
     * The configuration object for Home page embeds configs.
@@ -4738,7 +4915,13 @@ export declare enum EmbedEvent {
             * Emitted when a user exits present mode.
             * @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
             */
-        ExitPresentMode = "exitPresentMode"
+        ExitPresentMode = "exitPresentMode",
+        /**
+            * Emitted when a user requests the full height lazy load data.
+            * @version SDK : 1.39.0 | ThoughtSpot : 10.10.0.cl
+            * @hidden
+            */
+        RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates"
 }
 /**
     * Event types that can be triggered by the host application
@@ -5820,7 +6003,20 @@ export declare enum HostEvent {
             *```
             * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
             */
-        ExitPresentMode = "exitPresentMode"
+        ExitPresentMode = "exitPresentMode",
+        /**
+            * Triggers the full height lazy load data.
+            * @example
+            * ```js
+            * liveboardEmbed.on(EmbedEvent.RequestVisibleEmbedCoordinates, (payload) => {
+            *      console.log(payload);
+            * });
+            * ```
+            * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+            *
+            * @hidden
+            */
+        VisibleEmbedCoordinates = "visibleEmbedCoordinates"
 }
 /**
     * The different visual modes that the data sources panel within
@@ -5916,6 +6112,7 @@ export declare enum Param {
         Query = "query",
         HideHomepageLeftNav = "hideHomepageLeftNav",
         ModularHomeExperienceEnabled = "modularHomeExperience",
+        ListPageVersion = "listpageVersion",
         PendoTrackingKey = "additionalPendoKey",
         LiveboardHeaderSticky = "isLiveboardHeaderSticky",
         IsProductTour = "isProductTour",
@@ -5953,7 +6150,9 @@ export declare enum Param {
         CoverAndFilterOptionInPDF = "arePdfCoverFilterPageCheckboxesEnabled",
         PrimaryAction = "primaryAction",
         isSpotterAgentEmbed = "isSpotterAgentEmbed",
-        IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled"
+        IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled",
+        IsLazyLoadingForEmbedEnabled = "isLazyLoadingForEmbedEnabled",
+        RootMarginForLazyLoad = "rootMarginForLazyLoad"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -7383,8 +7582,7 @@ export interface SearchOptions {
     */
 export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
         /**
-            * The ID of the data source object. For example, Model, View, or Table. Spotter uses
-            * this object to query data and generate Answers.
+            * The ID of the data source object. For example, Model, View, or Table. Spotter uses this object to query data and generate Answers.
             */
         worksheetId: string;
         /**
@@ -7467,63 +7665,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
             * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
             */
         hideSampleQuestions?: boolean;
-        /**
-            * The list of runtime filters to apply to a search Answer,
-            * visualization, or Liveboard.
-            *
-            * Supported embed types: `SpotterEmbed`
-            * @example
-            * ```js
-            * const embed = new SpotterEmbed('#tsEmbed', {
-            *    ... // other embed view config
-            *    runtimeFilters: [
-            *           {
-            *             columnName: 'value',
-            *             operator: RuntimeFilterOp.EQ,
-            *             values: ['string' | 123 | true],
-            *           },
-            *       ],
-            * })
-            * ```
-            */
-        runtimeFilters?: RuntimeFilter[];
-        /**
-            * Flag to control whether runtime filters should be included in the URL.
-            * If true, filters will be passed via app initialization payload instead.
-            * If false/undefined, filters will be added to URL (default behavior).
-            *
-            * Supported embed types: `SpotterEmbed`
-            * @default false
-            */
-        excludeRuntimeFiltersfromURL?: boolean;
-        /**
-            * The list of runtime parameters to apply to the conversation.
-            *
-            * Supported embed types: `SpotterEmbed`
-            * @example
-            * ```js
-            * const embed = new SpotterEmbed('#tsEmbed', {
-            *    ... // other embed view config
-            *    runtimeParameters: [
-            *           {
-            *             name: 'Parameter Name',
-            *             value: 'Parameter Value',
-            *           },
-            *       ],
-            * })
-            * ```
-            */
-        runtimeParameters?: RuntimeParameter[];
-        /**
-            * Flag to control whether runtime parameters should be included in the URL.
-            * If true, parameters will be passed via app initialization payload instead.
-            * If false/undefined, parameters will be added to URL (default behavior).
-            *
-            * Supported embed types: `SpotterEmbed`
-            * @default false
-            *
-            */
-        excludeRuntimeParametersfromURL?: boolean;
 }
 /**
     * The configuration for the embedded spotterEmbed options.