@thoughtspot/visual-embed-sdk 1.37.0-temp-nav → 1.37.1-spotter-embed

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

@@ -195,6 +195,8 @@ export const SageEmbed: React.ForwardRefExoticComponent<SageEmbedProps & React.R
     * ```
     */
 export const PreRenderedSageEmbed: React.ForwardRefExoticComponent<SageEmbedProps & PreRenderProps & React.RefAttributes<_SageEmbed>>;
+interface SpotterEmbedProps extends EmbedProps, SpotterEmbedViewConfig {
+}
 interface ConversationEmbedProps extends EmbedProps, ConversationViewConfig {
 }
 /**
@@ -202,6 +204,23 @@ interface ConversationEmbedProps extends EmbedProps, ConversationViewConfig {
     * @example
     * ```tsx
     * function Sage() {
+    *  return <SpotterEmbed
+    *      worksheetId="<worksheet-id-here>"
+    *      searchOptions={{
+    *          searchQuery: "<search query to start with>"
+    *      }}
+    *      ... other view config props or event listeners.
+    *  />
+    * }
+    * ```
+    */
+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.
+    * @example
+    * ```tsx
+    * function Sage() {
     *  return <ConversationEmbed
     *      worksheetId="<worksheet-id-here>"
     *      searchOptions={{
@@ -216,7 +235,7 @@ export const ConversationEmbed: React.ForwardRefExoticComponent<ConversationEmbe
 /**
     * React component for PreRendered Conversation embed.
     *
-    * PreRenderedConversationEmbed will preRender the ConversationEmbed and will be hidden by
+    * PreRenderedConversationEmbed will preRender the SpotterEmbed and will be hidden by
     * default.
     *
     * SageEmbed with preRenderId passed will call showPreRender on the embed.
@@ -227,12 +246,12 @@ export const ConversationEmbed: React.ForwardRefExoticComponent<ConversationEmbe
     * }
     * ```
     * function MyComponent() {
-    *  return <ConversationEmbed preRenderId="someId" worksheetId="id" />
+    *  return <SpotterEmbed preRenderId="someId" worksheetId="id" />
     * }
     * ```
     */
-export const PreRenderedConversationEmbed: React.ForwardRefExoticComponent<SageEmbedProps & PreRenderProps & React.RefAttributes<_ConversationEmbed>>;
-type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmbed | typeof SearchBarEmbed | typeof SageEmbed | typeof ConversationEmbed;
+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;
 /**
     * Get a reference to the embed component to trigger events on the component.
     * @example
@@ -314,7 +333,11 @@ export declare enum AuthStatus {
             * or by the trigger button.
             * @version SDK: 1.19.0
             */
-        WAITING_FOR_POPUP = "WAITING_FOR_POPUP"
+        WAITING_FOR_POPUP = "WAITING_FOR_POPUP",
+        /**
+            * Emitted when the SAML popup is closed without authentication
+            */
+        SAML_POPUP_CLOSED_NO_AUTH = "SAML_POPUP_CLOSED_NO_AUTH"
 }
 /**
     * Event emitter returned from {@link init}.
@@ -332,10 +355,10 @@ export interface AuthEventEmitter {
             * @param event
             * @param listener
             */
-        on(event: AuthStatus.SDK_SUCCESS | AuthStatus.LOGOUT | AuthStatus.WAITING_FOR_POPUP, listener: () => void): this;
+        on(event: AuthStatus.SDK_SUCCESS | AuthStatus.LOGOUT | AuthStatus.WAITING_FOR_POPUP | AuthStatus.SAML_POPUP_CLOSED_NO_AUTH, listener: () => void): this;
         on(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this;
         once(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this;
-        once(event: AuthStatus.SDK_SUCCESS | AuthStatus.LOGOUT | AuthStatus.WAITING_FOR_POPUP, listener: () => void): this;
+        once(event: AuthStatus.SDK_SUCCESS | AuthStatus.LOGOUT | AuthStatus.WAITING_FOR_POPUP | AuthStatus.SAML_POPUP_CLOSED_NO_AUTH, listener: () => void): this;
         once(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this;
         /**
             * Trigger an event on the emitter returned from init.
@@ -1063,20 +1086,6 @@ export declare enum HomePageSearchBarMode {
         AI_ANSWER = "aiAnswer",
         NONE = "none"
 }
-export interface ModularHomeExperienceV3 {
-        /**
-            * Enabled the modular homepage version 3.
-            */
-        enabled?: boolean;
-        /**
-            * homePage values are v2/v3,
-            * v2 will show the modular homepage experience
-            * v3 will show the new modular homepage v3 experience.
-            *
-            * @default v2
-            */
-        homePage?: string;
-}
 /**
     * The view configuration for full app embedding.
     * @group Embed components
@@ -1392,14 +1401,11 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
             *    ... // other options
-            *    modularHomeExperienceV3 : {
-            *      enabled: true,
-            *      homePage: 'v2'
-            *    },
+            *    modularHomeExperienceV3 : true,
             * })
             * ```
             */
-        modularHomeExperienceV3?: ModularHomeExperienceV3;
+        modularHomeExperienceV3?: boolean;
         /**
             * Boolean to control if Liveboard header is sticky or not.
             * @example
@@ -5455,7 +5461,55 @@ export declare enum HostEvent {
             * ```
             * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
             */
-        TransformTableVizData = "TransformTableVizData"
+        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"
 }
 /**
     * The different visual modes that the data sources panel within
@@ -5586,7 +5640,8 @@ export declare enum Param {
         preAuthCache = "preAuthCache",
         ShowSpotterLimitations = "showSpotterLimitations",
         CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
-        PrimaryAction = "primaryAction"
+        PrimaryAction = "primaryAction",
+        isSpotterAgentEmbed = "isSpotterAgentEmbed"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -6991,10 +7046,10 @@ export interface SearchOptions {
         searchQuery: string;
 }
 /**
-    * The configuration for the embedded conversationEmbed options.
+    * The configuration for the embedded spotterEmbed options.
     * @group Embed components
     */
-export interface ConversationViewConfig extends ViewConfig {
+export interface SpotterEmbedViewConfig extends ViewConfig {
         /**
             * The ID of the worksheet to use for the conversation.
             */
@@ -7008,7 +7063,7 @@ export interface ConversationViewConfig extends ViewConfig {
             * but still display the selected data source.
             * @example
             * ```js
-            * const embed = new ConversationEmbed('#tsEmbed', {
+            * const embed = new SpotterEmbed('#tsEmbed', {
             *    ... // other options
             *    disableSourceSelection : true,
             * })
@@ -7020,7 +7075,7 @@ export interface ConversationViewConfig extends ViewConfig {
             * hideSourceSelection : Hide data source selection
             * @example
             * ```js
-            * const embed = new ConversationEmbed('#tsEmbed', {
+            * const embed = new SpotterEmbed('#tsEmbed', {
             *    ... // other options
             *    hideSourceSelection : true,
             * })
@@ -7047,7 +7102,7 @@ export interface ConversationViewConfig extends ViewConfig {
             * default is false.
             * @example
             * ```js
-            * const embed = new ConversationEmbed('#tsEmbed', {
+            * const embed = new SpotterEmbed('#tsEmbed', {
             *    ... // other options
             *    showSpotterLimitations : true,
             * })
@@ -7060,7 +7115,7 @@ export interface ConversationViewConfig extends ViewConfig {
             * the initial screen of the conversation.
             * @example
             * ```js
-            * const embed = new ConversationEmbed('#tsEmbed', {
+            * const embed = new SpotterEmbed('#tsEmbed', {
             *    ... // other options
             *    hideSampleQuestions : true,
             * })
@@ -7069,12 +7124,41 @@ export interface ConversationViewConfig extends ViewConfig {
             */
         hideSampleQuestions?: boolean;
 }
+/**
+    * The configuration for the embedded spotterEmbed options.
+    * @deprecated Renamed to SpotterEmbedViewConfig
+    * @group Embed components
+    */
+export interface ConversationViewConfig extends SpotterEmbedViewConfig {
+}
+/**
+    * Embed ThoughtSpot AI Conversation.
+    * @group Embed components
+    * @example
+    * ```js
+    * const conversation = new SpotterEmbed('#tsEmbed', {
+    *   worksheetId: 'worksheetId',
+    *   searchOptions: {
+    *     searchQuery: 'searchQuery',
+    *   },
+    * });
+    * conversation.render();
+    * ```
+    * @version SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
+    */
+export declare class SpotterEmbed extends TsEmbed {
+        protected viewConfig: SpotterEmbedViewConfig;
+        constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
+        getIframeSrc(): string;
+        render(): Promise<SpotterEmbed>;
+}
 /**
     * Embed ThoughtSpot AI Conversation.
+    * @deprecated Renamed to SpotterEmbed
     * @group Embed components
     * @example
     * ```js
-    * const conversation = new ConversationEmbed('#tsEmbed', {
+    * const conversation = new SpotterEmbed('#tsEmbed', {
     *   worksheetId: 'worksheetId',
     *   searchOptions: {
     *     searchQuery: 'searchQuery',
@@ -7082,13 +7166,11 @@ export interface ConversationViewConfig extends ViewConfig {
     * });
     * conversation.render();
     * ```
-    * @version SDK: 1.33.1 | ThoughtSpot: 10.5.0.cl
+    * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
     */
-export declare class ConversationEmbed extends TsEmbed {
+export declare class ConversationEmbed extends SpotterEmbed {
         protected viewConfig: ConversationViewConfig;
         constructor(container: HTMLElement, viewConfig: ConversationViewConfig);
-        getIframeSrc(): string;
-        render(): Promise<ConversationEmbed>;
 }
 
 /**
@@ -7099,7 +7181,7 @@ export declare class ConversationEmbed extends TsEmbed {
   * @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, BodylessConversation, BodylessConversationViewConfig, ConversationEmbed, ConversationViewConfig, 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, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, };
 
 /**
     * Copyright (c) 2022
@@ -8219,21 +8301,28 @@ export declare function reset(): void;
     * Configuration for bodyless conversation options.
     * @group Embed components
     */
-export interface BodylessConversationViewConfig extends ViewConfig {
+export interface SpotterAgentEmbedViewConfig extends ViewConfig {
         /**
             * The ID of the worksheet to use for the conversation.
             */
         worksheetId: string;
 }
-interface ConversationMessageViewConfig extends BodylessConversationViewConfig {
+/**
+    * 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: ConversationMessageViewConfig;
-        constructor(container: HTMLElement, viewConfig: ConversationMessageViewConfig);
+        protected viewConfig: SpotterAgentMessageViewConfig;
+        constructor(container: HTMLElement, viewConfig: SpotterAgentMessageViewConfig);
         getIframeSrc(): string;
         render(): Promise<ConversationMessage>;
 }
@@ -8242,9 +8331,9 @@ declare class ConversationMessage extends TsEmbed {
     * chatbots or other conversational interfaces.
     * @example
     * ```js
-    * import { BodylessConversation } from '@thoughtspot/visual-embed-sdk';
+    * import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
     *
-    * const conversation = new BodylessConversation({
+    * const conversation = new SpotterAgentEmbed({
     *  worksheetId: 'worksheetId',
     * });
     *
@@ -8254,10 +8343,10 @@ declare class ConversationMessage extends TsEmbed {
     * document.body.appendChild(container); // or to any other element
     * ```
     * @group Embed components
-    * @version SDK: 1.33.1 | ThoughtSpot: 10.5.0.cl
+    * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
     */
-export declare class BodylessConversation {
-        constructor(viewConfig: BodylessConversationViewConfig);
+export declare class SpotterAgentEmbed {
+        constructor(viewConfig: SpotterAgentEmbedViewConfig);
         sendMessage(userMessage: string): Promise<{
                 error: any;
                 container?: undefined;
@@ -8268,6 +8357,29 @@ export declare class BodylessConversation {
                 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 = {