@thoughtspot/visual-embed-sdk 1.37.1-spotter-embed → 1.38.0

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

@@ -217,7 +217,8 @@ interface ConversationEmbedProps extends EmbedProps, ConversationViewConfig {
 export const SpotterEmbed: React.ForwardRefExoticComponent<SpotterEmbedProps & React.RefAttributes<_SpotterEmbed>>;
 /**
     * React component for LLM based conversation BI.
-    * @deprecated This component is renamed to SpotterEmbed. Use {@link SpotterEmbed} instead.
+    * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
+    * Use {@link SpotterEmbed} instead
     * @example
     * ```tsx
     * function Sage() {
@@ -232,6 +233,33 @@ export const SpotterEmbed: React.ForwardRefExoticComponent<SpotterEmbedProps & R
     * ```
     */
 export const ConversationEmbed: React.ForwardRefExoticComponent<ConversationEmbedProps & React.RefAttributes<_ConversationEmbed>>;
+interface SpotterAgentEmbedProps extends EmbedProps, SpotterAgentEmbedViewConfig {
+}
+/**
+    * React component for SpotterAgent embed, which can be integrated inside
+    * chatbots or other conversational interfaces.
+    * @example
+    * ```tsx
+    * function SpotterAgent() {
+    *  const ref = useRef();
+    *
+    *  const handleSendMessage = async () => {
+    *    const { container, error } = await ref.current.sendMessage('show me sales by region');
+    *    if (container) {
+    *      document.body.appendChild(container);
+    *    }
+    *  };
+    *
+    *  return (
+    *    <div>
+    *      <SpotterAgentEmbed ref={ref} worksheetId="worksheetId" />
+    *      <button onClick={handleSendMessage}>Send Message</button>
+    *    </div>
+    *  );
+    * }
+    * ```
+    */
+export const SpotterAgentEmbed: React.ForwardRefExoticComponent<SpotterAgentEmbedProps & React.RefAttributes<_SpotterAgentEmbed>>;
 /**
     * React component for PreRendered Conversation embed.
     *
@@ -251,7 +279,7 @@ export const ConversationEmbed: React.ForwardRefExoticComponent<ConversationEmbe
     * ```
     */
 export const PreRenderedConversationEmbed: React.ForwardRefExoticComponent<SpotterEmbedProps & PreRenderProps & React.RefAttributes<_SpotterEmbed>>;
-type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmbed | typeof SearchBarEmbed | typeof SageEmbed | typeof SpotterEmbed | typeof ConversationEmbed;
+type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmbed | typeof SearchBarEmbed | typeof SageEmbed | typeof SpotterAgentEmbed | typeof SpotterEmbed | typeof ConversationEmbed;
 /**
     * Get a reference to the embed component to trigger events on the component.
     * @example
@@ -292,7 +320,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, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, };
+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, };
 
 export declare let loggedInStatus: boolean;
 export declare let samlAuthWindow: Window;
@@ -1096,6 +1124,43 @@ export declare enum HomePageSearchBarMode {
         AI_ANSWER = "aiAnswer",
         NONE = "none"
 }
+/**
+    * Define the version of the primary navbar
+    * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
+    */
+export declare enum PrimaryNavbarVersion {
+        /**
+            * Sliding (v3) introduces a new left-side navigation hub featuring a tab switcher,
+            * along with updates to the top navigation bar.
+            * It serves as the foundational version of the PrimaryNavBar.
+            */
+        Sliding = "v3"
+}
+/**
+    * Define the version of the home page
+    * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
+    */
+export declare enum HomePage {
+        /**
+            * Modular (v2) introduces the updated Modular Home Experience.
+            * It serves as the foundational version of the home page.
+            */
+        Modular = "v2"
+}
+/**
+    * Define the discovery experience
+    * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
+    */
+export interface DiscoveryExperience {
+        /**
+            * primaryNavbarVersion determines the version of the navigation version.
+            */
+        primaryNavbarVersion?: PrimaryNavbarVersion;
+        /**
+            * homePage determines the version of the home page.
+            */
+        homePage?: HomePage;
+}
 /**
     * The view configuration for full app embedding.
     * @group Embed components
@@ -1403,7 +1468,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             */
         modularHomeExperience?: boolean;
         /**
-            * Flag to control new navigation v3 home experience.
+            * To configure the top-left navigation and home page experience
             *
             * @default false
             * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
@@ -1411,11 +1476,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
             *    ... // other options
-            *    modularHomeExperienceV3 : true,
+            *    discoveryExperience : {
+            *      primaryNavbarVersion: PrimaryNavbarVersion.Sliding,
+            *      homePage: HompePage.Modular,
+            *    },
             * })
             * ```
             */
-        modularHomeExperienceV3?: boolean;
+        discoveryExperience?: DiscoveryExperience;
         /**
             * Boolean to control if Liveboard header is sticky or not.
             * @example
@@ -2027,6 +2095,96 @@ export declare class LiveboardEmbed extends V1Embed {
 export declare class PinboardEmbed extends LiveboardEmbed {
 }
 
+/**
+    * Configuration for bodyless conversation options.
+    * @group Embed components
+    */
+export interface SpotterAgentEmbedViewConfig extends ViewConfig {
+        /**
+            * 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.
+    * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
+    * Use {@link SpotterAgentEmbedViewConfig} instead
+    * @group Embed components
+    */
+export interface BodylessConversationViewConfig extends SpotterAgentEmbedViewConfig {
+}
+interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConfig {
+        sessionId: string;
+        genNo: number;
+        acSessionId: string;
+        acGenNo: number;
+}
+declare class ConversationMessage extends TsEmbed {
+        protected viewConfig: SpotterAgentMessageViewConfig;
+        constructor(container: HTMLElement, viewConfig: SpotterAgentMessageViewConfig);
+        getIframeSrc(): string;
+        render(): Promise<ConversationMessage>;
+}
+/**
+    * Create a conversation embed, which can be integrated inside
+    * chatbots or other conversational interfaces.
+    * @example
+    * ```js
+    * import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
+    *
+    * const conversation = new SpotterAgentEmbed({
+    *  worksheetId: 'worksheetId',
+    * });
+    *
+    * const { container, error } = await conversation.sendMessage('show me sales by region');
+    *
+    * // append the container to the DOM
+    * document.body.appendChild(container); // or to any other element
+    * ```
+    * @group Embed components
+    * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
+    */
+export declare class SpotterAgentEmbed {
+        constructor(viewConfig: SpotterAgentEmbedViewConfig);
+        sendMessage(userMessage: string): Promise<{
+                error: any;
+                container?: undefined;
+                viz?: undefined;
+        } | {
+                container: HTMLDivElement;
+                viz: ConversationMessage;
+                error?: undefined;
+        }>;
+}
+/**
+    * Create a conversation embed, which can be integrated inside
+    * chatbots or other conversational interfaces.
+    * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
+    * Use {@link SpotterAgentEmbed} instead
+    * @example
+    * ```js
+    * import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
+    *
+    * const conversation = new SpotterAgentEmbed({
+    *  worksheetId: 'worksheetId',
+    * });
+    *
+    * const { container, error } = await conversation.sendMessage('show me sales by region');
+    *
+    * // append the container to the DOM
+    * document.body.appendChild(container); // or to any other element
+    * ```
+    * @group Embed components
+    */
+export declare class BodylessConversation extends SpotterAgentEmbed {
+        constructor(viewConfig: BodylessConversationViewConfig);
+}
+export {};
+
 /**
     * Copyright (c) 2023
     *
@@ -4652,9 +4810,12 @@ export declare enum HostEvent {
             * @example
             * ```js
             * searchEmbed.trigger(HostEvent.OpenFilter,
-            * { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'})
+            *  {column: { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'}})
+            * ```
+            * @example
+            * ```js
             * LiveboardEmbed.trigger(HostEvent.OpenFilter,
-            *  { columnId: '<column-GUID>'})
+            *   { column: {columnId: '<column-GUID>'}})
             * ```
             * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
             */
@@ -5263,6 +5424,25 @@ export declare enum HostEvent {
             *    }]
             * });
             * ```
+            * If there are multiple columns with the same name, consider
+            * using `WORKSHEET_NAME::COLUMN_NAME` format.
+            *
+            * @example
+            *
+            * ```js
+            * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
+            *  filters: [{
+            *      column: "(Sample) Retail - Apparel::city",
+            *      oper: 'IN',
+            *      values: ["atlanta"]
+            *  },
+            *  {
+            *      column: "(Sample) Retail - Apparel::Region",
+            *      oper: 'IN',
+            *      values: ["West","Midwest"]
+            *  }]
+            * });
+            * ```
             * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
             */
         UpdateFilters = "updateFilters",
@@ -5471,55 +5651,7 @@ export declare enum HostEvent {
             * ```
             * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
             */
-        TransformTableVizData = "TransformTableVizData",
-        /**
-            * Triggers the table visualization re-render with the updated data.
-            * Includes the following properties:
-            * @param - `columnDataLite` - an array of object containing the
-            * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
-            * payload.For example, { columnDataLite: []}`.
-            */
-        SpotterSearch = "SpotterSearch",
-        /**
-            * Triggers the table visualization re-render with the updated data.
-            * Includes the following properties:
-            * @param - `columnDataLite` - an array of object containing the
-            * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
-            * payload.For example, { columnDataLite: []}`.
-            */
-        EditLastPrompt = "EditLastPrompt",
-        /**
-            * Triggers the table visualization re-render with the updated data.
-            * Includes the following properties:
-            * @param - `columnDataLite` - an array of object containing the
-            * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
-            * payload.For example, { columnDataLite: []}`.
-            */
-        PreviewSpotterData = "PreviewSpotterData",
-        /**
-            * Triggers the table visualization re-render with the updated data.
-            * Includes the following properties:
-            * @param - `columnDataLite` - an array of object containing the
-            * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
-            * payload.For example, { columnDataLite: []}`.
-            */
-        ResetSpotterConversation = "ResetSpotterConversation",
-        /**
-            * Triggers the table visualization re-render with the updated data.
-            * Includes the following properties:
-            * @param - `columnDataLite` - an array of object containing the
-            * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
-            * payload.For example, { columnDataLite: []}`.
-            */
-        DeleteLastPrompt = "DeleteLastPrompt",
-        /**
-            * Triggers the table visualization re-render with the updated data.
-            * Includes the following properties:
-            * @param - `columnDataLite` - an array of object containing the
-            * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
-            * payload.For example, { columnDataLite: []}`.
-            */
-        AnswerChartSwitcher = "answerChartSwitcher"
+        TransformTableVizData = "TransformTableVizData"
 }
 /**
     * The different visual modes that the data sources panel within
@@ -7136,7 +7268,8 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
 }
 /**
     * The configuration for the embedded spotterEmbed options.
-    * @deprecated Renamed to SpotterEmbedViewConfig
+    * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
+    * Use {@link SpotterEmbedViewConfig} instead
     * @group Embed components
     */
 export interface ConversationViewConfig extends SpotterEmbedViewConfig {
@@ -7154,7 +7287,7 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
     * });
     * conversation.render();
     * ```
-    * @version SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
+    * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
     */
 export declare class SpotterEmbed extends TsEmbed {
         protected viewConfig: SpotterEmbedViewConfig;
@@ -7164,7 +7297,8 @@ export declare class SpotterEmbed extends TsEmbed {
 }
 /**
     * Embed ThoughtSpot AI Conversation.
-    * @deprecated Renamed to SpotterEmbed
+    * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
+    * Use {@link SpotterEmbed} instead
     * @group Embed components
     * @example
     * ```js
@@ -7324,91 +7458,6 @@ export declare const exportTML: (data: exportTMLInput) => Promise<any>;
     */
 export declare function reset(): void;
 
-/**
-    * Configuration for bodyless conversation options.
-    * @group Embed components
-    */
-export interface SpotterAgentEmbedViewConfig extends ViewConfig {
-        /**
-            * The ID of the worksheet to use for the conversation.
-            */
-        worksheetId: string;
-}
-/**
-    * Configuration for conversation options.
-    * @deprecated Renamed to SpotterAgentEmbedViewConfig
-    * @group Embed components
-    */
-export interface BodylessConversationViewConfig extends SpotterAgentEmbedViewConfig {
-}
-interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConfig {
-        sessionId: string;
-        genNo: number;
-        acSessionId: string;
-        acGenNo: number;
-}
-declare class ConversationMessage extends TsEmbed {
-        protected viewConfig: SpotterAgentMessageViewConfig;
-        constructor(container: HTMLElement, viewConfig: SpotterAgentMessageViewConfig);
-        getIframeSrc(): string;
-        render(): Promise<ConversationMessage>;
-}
-/**
-    * Create a conversation embed, which can be integrated inside
-    * chatbots or other conversational interfaces.
-    * @example
-    * ```js
-    * import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
-    *
-    * const conversation = new SpotterAgentEmbed({
-    *  worksheetId: 'worksheetId',
-    * });
-    *
-    * const { container, error } = await conversation.sendMessage('show me sales by region');
-    *
-    * // append the container to the DOM
-    * document.body.appendChild(container); // or to any other element
-    * ```
-    * @group Embed components
-    * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
-    */
-export declare class SpotterAgentEmbed {
-        constructor(viewConfig: SpotterAgentEmbedViewConfig);
-        sendMessage(userMessage: string): Promise<{
-                error: any;
-                container?: undefined;
-                viz?: undefined;
-        } | {
-                container: HTMLDivElement;
-                viz: ConversationMessage;
-                error?: undefined;
-        }>;
-}
-/**
-    * Create a conversation embed, which can be integrated inside
-    * chatbots or other conversational interfaces.
-    * @deprecated Renamed to SpotterAgentEmbed
-    * @example
-    * ```js
-    * import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
-    *
-    * const conversation = new SpotterAgentEmbed({
-    *  worksheetId: 'worksheetId',
-    * });
-    *
-    * const { container, error } = await conversation.sendMessage('show me sales by region');
-    *
-    * // append the container to the DOM
-    * document.body.appendChild(container); // or to any other element
-    * ```
-    * @group Embed components
-    * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
-    */
-export declare class BodylessConversation extends SpotterAgentEmbed {
-        constructor(viewConfig: BodylessConversationViewConfig);
-}
-export {};
-
 export type SessionInfo = {
         releaseVersion: string;
         userGUID: string;