@thoughtspot/visual-embed-sdk 1.37.1 → 1.38.0-alpha.1

package/dist/visual-embed-sdk-react-full.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,24 @@ 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 from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
+    * Use {@link SpotterEmbed} instead
+    * @example
+    * ```tsx
+    * function Sage() {
     *  return <ConversationEmbed
     *      worksheetId="<worksheet-id-here>"
     *      searchOptions={{
@@ -213,10 +233,37 @@ interface ConversationEmbedProps extends EmbedProps, ConversationViewConfig {
     * ```
     */
 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.
     *
-    * 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 +274,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 SpotterAgentEmbed | typeof SpotterEmbed | typeof ConversationEmbed;
 /**
     * Get a reference to the embed component to trigger events on the component.
     * @example
@@ -273,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, 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, PrimaryNavbarVersion, HomePage, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, };
 
 export declare let loggedInStatus: boolean;
 export declare let samlAuthWindow: Window;
@@ -2048,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
     *
@@ -5645,7 +5782,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
@@ -7050,10 +7188,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.
             */
@@ -7067,7 +7205,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,
             * })
@@ -7079,7 +7217,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,
             * })
@@ -7106,7 +7244,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,
             * })
@@ -7119,7 +7257,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,
             * })
@@ -7128,12 +7266,20 @@ export interface ConversationViewConfig extends ViewConfig {
             */
         hideSampleQuestions?: boolean;
 }
+/**
+    * The configuration for the embedded spotterEmbed options.
+    * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
+    * Use {@link SpotterEmbedViewConfig} instead
+    * @group Embed components
+    */
+export interface ConversationViewConfig extends SpotterEmbedViewConfig {
+}
 /**
     * Embed ThoughtSpot AI Conversation.
     * @group Embed components
     * @example
     * ```js
-    * const conversation = new ConversationEmbed('#tsEmbed', {
+    * const conversation = new SpotterEmbed('#tsEmbed', {
     *   worksheetId: 'worksheetId',
     *   searchOptions: {
     *     searchQuery: 'searchQuery',
@@ -7141,13 +7287,34 @@ 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 SpotterEmbed extends TsEmbed {
+        protected viewConfig: SpotterEmbedViewConfig;
+        constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
+        getIframeSrc(): string;
+        render(): Promise<SpotterEmbed>;
+}
+/**
+    * Embed ThoughtSpot AI Conversation.
+    * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
+    * Use {@link SpotterEmbed} instead
+    * @group Embed components
+    * @example
+    * ```js
+    * const conversation = new SpotterEmbed('#tsEmbed', {
+    *   worksheetId: 'worksheetId',
+    *   searchOptions: {
+    *     searchQuery: 'searchQuery',
+    *   },
+    * });
+    * conversation.render();
+    * ```
+    * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
+    */
+export declare class ConversationEmbed extends SpotterEmbed {
         protected viewConfig: ConversationViewConfig;
         constructor(container: HTMLElement, viewConfig: ConversationViewConfig);
-        getIframeSrc(): string;
-        render(): Promise<ConversationEmbed>;
 }
 
 import '../utils/with-resolvers-polyfill';
@@ -7291,61 +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 BodylessConversationViewConfig extends ViewConfig {
-        /**
-            * The ID of the worksheet to use for the conversation.
-            */
-        worksheetId: string;
-}
-interface ConversationMessageViewConfig extends BodylessConversationViewConfig {
-        sessionId: string;
-        genNo: number;
-        acSessionId: string;
-        acGenNo: number;
-}
-declare class ConversationMessage extends TsEmbed {
-        protected viewConfig: ConversationMessageViewConfig;
-        constructor(container: HTMLElement, viewConfig: ConversationMessageViewConfig);
-        getIframeSrc(): string;
-        render(): Promise<ConversationMessage>;
-}
-/**
-    * Create a conversation embed, which can be integrated inside
-    * chatbots or other conversational interfaces.
-    * @example
-    * ```js
-    * import { BodylessConversation } from '@thoughtspot/visual-embed-sdk';
-    *
-    * const conversation = new BodylessConversation({
-    *  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.33.1 | ThoughtSpot: 10.5.0.cl
-    */
-export declare class BodylessConversation {
-        constructor(viewConfig: BodylessConversationViewConfig);
-        sendMessage(userMessage: string): Promise<{
-                error: any;
-                container?: undefined;
-                viz?: undefined;
-        } | {
-                container: HTMLDivElement;
-                viz: ConversationMessage;
-                error?: undefined;
-        }>;
-}
-export {};
-
 export type SessionInfo = {
         releaseVersion: string;
         userGUID: string;