@thoughtspot/visual-embed-sdk 1.33.0 → 1.33.1-dc.3

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

@@ -195,7 +195,44 @@ export const SageEmbed: React.ForwardRefExoticComponent<SageEmbedProps & React.R
     * ```
     */
 export const PreRenderedSageEmbed: React.ForwardRefExoticComponent<SageEmbedProps & PreRenderProps & React.RefAttributes<_SageEmbed>>;
-type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmbed | typeof SearchBarEmbed | typeof SageEmbed;
+interface ConversationEmbedProps extends EmbedProps, ConversationViewConfig {
+}
+/**
+    * React component for LLM based conversation BI.
+    * @example
+    * ```tsx
+    * function Sage() {
+    *  return <ConversationEmbed
+    *      worksheetId="<worksheet-id-here>"
+    *      searchOptions={{
+    *          searchQuery: "<search query to start with>"
+    *      }}
+    *      ... other view config props or event listeners.
+    *  />
+    * }
+    * ```
+    */
+export const ConversationEmbed: React.ForwardRefExoticComponent<ConversationEmbedProps & React.RefAttributes<_ConversationEmbed>>;
+/**
+    * React component for PreRendered Conversation embed.
+    *
+    * PreRenderedConversationEmbed will preRender the ConversationEmbed and will be hidden by
+    * default.
+    *
+    * SageEmbed with preRenderId passed will call showPreRender on the embed.
+    * @example
+    * ```tsx
+    * function LandingPageComponent() {
+    *  return <PreRenderedConversationEmbed preRenderId="someId" worksheetId={"id-"} />
+    * }
+    * ```
+    * function MyComponent() {
+    *  return <ConversationEmbed 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;
 /**
     * Get a reference to the embed component to trigger events on the component.
     * @example
@@ -222,7 +259,7 @@ export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<
   * @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, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, 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, VizPoint, CustomActionPayload, };
+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, VizPoint, CustomActionPayload, };
 
 /**
     * @group Embed components
@@ -1536,6 +1573,13 @@ export declare class LiveboardEmbed extends V1Embed {
             */
         render(): Promise<LiveboardEmbed>;
         navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
+        /**
+            * Returns the full url of the liveboard/viz which can be used to open
+            * this liveboard inside the full Thoughtspot application in a new tab.
+            *
+            * @returns url string
+            */
+        getLiveboardUrl(): string;
 }
 /**
     * @hidden
@@ -1561,6 +1605,47 @@ export interface ViewConfigAndListeners<T extends ViewConfig> {
   */
 export function getViewPropsAndListeners<T extends EmbedProps, U extends ViewConfig>(props: T): ViewConfigAndListeners<U>;
 
+/**
+    * Configuration for search options
+    */
+export interface SearchOptions {
+        /**
+            * The query string to pass to start the Conversation.
+            */
+        searchQuery: string;
+}
+export interface ConversationViewConfig extends ViewConfig {
+        /**
+            * The ID of the worksheet to use for the conversation.
+            */
+        worksheetId: string;
+        /**
+            * Ability to pass a starting search query to the conversation.
+            */
+        searchOptions?: SearchOptions;
+}
+/**
+    * Embed ThoughtSpot AI Conversation.
+    * @group Embed components
+    * @example
+    * ```js
+    * const conversation = new ConversationEmbed('#tsEmbed', {
+    *   worksheetId: 'worksheetId',
+    *   searchOptions: {
+    *     searchQuery: 'searchQuery',
+    *   },
+    * });
+    * conversation.render();
+    * ```
+    * @version SDK: 1.33.1 | ThoughtSpot: 10.5.0.cl
+    */
+export declare class ConversationEmbed extends TsEmbed {
+        protected viewConfig: ConversationViewConfig;
+        constructor(container: HTMLElement, viewConfig: ConversationViewConfig);
+        getIframeSrc(): string;
+        render(): Promise<ConversationEmbed>;
+}
+
 export interface executeTMLInput {
         metadata_tmls: string[];
         import_policy?: 'PARTIAL' | 'ALL_OR_NONE' | 'VALIDATE_ONLY';
@@ -1695,6 +1780,29 @@ export declare const exportTML: (data: exportTMLInput) => Promise<any>;
     */
 export declare function reset(): void;
 
+export interface BodylessConversationViewConfig extends ViewConfig {
+        /**
+            * The ID of the worksheet to use for the conversation.
+            */
+        worksheetId: string;
+}
+/**
+    * Create a conversation embed, which can be integrated inside
+    * chatbots or other conversational interfaces.
+    * @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;
+        } | {
+                container: HTMLDivElement;
+                error?: undefined;
+        }>;
+}
+
 export declare let loggedInStatus: boolean;
 export declare let samlAuthWindow: Window;
 export declare let samlCompletionPromise: Promise<void>;
@@ -1820,7 +1928,6 @@ export declare function notifyLogout(): void;
     * Services to be called after the login is successful,
     * This should be called after the cookie is set for cookie auth or
     * after the token is set for cookieless.
-    *
     * @return {Promise<void>}
     * @example
     * ```js
@@ -2488,7 +2595,6 @@ export interface EmbedConfig {
         disableTokenVerification?: boolean;
         /**
             * This flag is used to disable showing the login failure page in the embedded app.
-            *
             * @version SDK 1.32.3 | Thoughtspot: *
             */
         disableLoginFailurePage?: boolean;
@@ -3166,7 +3272,6 @@ export interface RuntimeParameter {
     * If you are using React components for embedding, you can register to any
     * events from the `EmbedEvent` list by using the `on<EventName>` convention.
     * For example,`onAlert`, `onCopyToClipboard` and so on.
-    *
     *  @example
     * ```js
     * // ...
@@ -3183,7 +3288,6 @@ export interface RuntimeParameter {
     *     );
     * };
     * ```
-    *
     * @group Events
     */
 export declare enum EmbedEvent {
@@ -4057,7 +4161,6 @@ export declare enum EmbedEvent {
             *
             * Prerequisite: Set isOnBeforeGetVizDataInterceptEnabled : true
             * for this embed event to get emitted.
-            *
             * @param: payload
             * @param: responder
             * Contains elements that lets developers define whether ThoughtSpot
@@ -4068,9 +4171,7 @@ export declare enum EmbedEvent {
             *
             * error: Developers can customize the user facing message when execute is
             * set to false using the error parameter in responder
-            *
             * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
-            *
             * @example
             *```js
             * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
@@ -4156,7 +4257,6 @@ export declare enum EmbedEvent {
     *
     * You can also attach an Embed event to a Host event to trigger
     * a specific action as shown in this example:
-    *
     * @example
     * ```js
     *  const EmbeddedComponent = () => {
@@ -4174,7 +4274,6 @@ export declare enum EmbedEvent {
     *      );
     *  }
     * ```
-    *
     * @group Events
     */
 export declare enum HostEvent {
@@ -4475,28 +4574,23 @@ export declare enum HostEvent {
         /**
             * Trigger the **Make a copy** action on a Liveboard,
             * visualization, or Answer page.
-            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.MakeACopy)
             * ```
-            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.MakeACopy, {
             * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
             * ```
-            *
             * @example
             * ```js
             * vizEmbed.trigger(HostEvent.MakeACopy)
             * ```
-            *
             * @example
             * ```js
             * searchEmbed.trigger(HostEvent.MakeACopy)
             * ```
-            *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         MakeACopy = "makeACopy",
@@ -4522,7 +4616,6 @@ export declare enum HostEvent {
         /**
             * Trigger the **Create alert** action on a KPI chart
             * in a Liveboard or saved Answer.
-            *
             * @param - an object with `vizId` as a key
             * @example
             * ```js
@@ -4530,7 +4623,6 @@ export declare enum HostEvent {
             *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
             * })
             * ```
-            *
             * @example
             * ```js
             * searchEmbed.trigger(HostEvent.CreateMonitor)
@@ -4541,7 +4633,6 @@ export declare enum HostEvent {
         /**
             * Trigger the **Manage alerts** action on a KPI chart
             * in a visualization or saved Answer.
-            *
             * @param - an object with `vizId` as a key
             * @example
             * ```js
@@ -4549,12 +4640,10 @@ export declare enum HostEvent {
             *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
             * })
             * ```
-            *
             * @example
             * ```js
             * searchEmbed.trigger(HostEvent.ManageMonitor)
             * ```
-            *
             * @example
             * ```js
             * vizEmbed.trigger(HostEvent.ManageMonitor)
@@ -4884,7 +4973,6 @@ export declare enum HostEvent {
             *        }
             *    });
             * ```
-            *
             * @example
             *
             * ```js
@@ -4966,7 +5054,6 @@ export declare enum HostEvent {
         /**
             * Get the answer session for a Search or
             * Liveboard visualization.
-            *
             * @example
             * ```js
             * const {session} = await embed.trigger(
@@ -4974,12 +5061,10 @@ export declare enum HostEvent {
             *      vizId: '123', // For Liveboard Visualization.
             *  })
             * ```
-            *
             * @example
             * ```js
             * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
             * ```
-            *
             * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
             */
         GetAnswerSession = "getAnswerSession",
@@ -5148,7 +5233,8 @@ export declare enum Param {
         HomePageSearchBarMode = "homePageSearchBarMode",
         ShowLiveboardVerifiedBadge = "showLiveboardVerifiedBadge",
         ShowLiveboardReverifyBanner = "showLiveboardReverifyBanner",
-        LiveboardHeaderV2 = "isLiveboardHeaderV2Enabled"
+        LiveboardHeaderV2 = "isLiveboardHeaderV2Enabled",
+        SpotterEnabled = "isSpotterExperienceEnabled"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -5701,7 +5787,6 @@ export declare enum Action {
         /**
             * @deprecated
             * Reports errors
-            *
             * @example
             * ```js
             * disabledActions: [Action.ReportError]
@@ -5931,14 +6016,12 @@ export declare enum Action {
             * ```js
             * disabledActions: [Action.RequestVerification]
             * ```
-            *
             * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
             */
         RequestVerification = "requestVerification",
         /**
             *
-            * Allows users to mark a Liveboard as verified.
-            *
+            *Allows users to mark a Liveboard as verified.
             * @example
             * ```js
             * disabledActions: [Action.MarkAsVerified]
@@ -5949,7 +6032,6 @@ export declare enum Action {
         /**
             * The **Add Tab** action on a Liveboard.
             * Allows adding a new tab to a Liveboard view.
-            *
             * @example
             * ```js
             * disabledActions: [Action.AddTab]
@@ -5959,8 +6041,7 @@ export declare enum Action {
         AddTab = "addTab",
         /**
             *
-            * Initiates contextual change analysis on KPI charts.
-            *
+            *Initiates contextual change analysis on KPI charts.
             * @example
             * ```js
             * disabledActions: [Action.EnableContextualChangeAnalysis]
@@ -5974,7 +6055,6 @@ export declare enum Action {
             * ```js
             * disabledActions: [Action.ShowSageQuery]
             * ```
-            *
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         ShowSageQuery = "showSageQuery",
@@ -5989,8 +6069,7 @@ export declare enum Action {
         EditSageAnswer = "editSageAnswer",
         /**
             *
-            * This action allows users to send feedback on AI-generated Answers.
-            *
+            *This action allows users to send feedback on AI-generated Answers.
             * @example
             * ```js
             * disabledActions: [Action.SageAnswerFeedback]
@@ -6067,7 +6146,6 @@ export declare enum Action {
             * hiddenAction: [Action.CreateLiveboard]
             * disabledActions: [Action.CreateLiveboard]
             * ```
-            *
             * @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
             */
         CreateLiveboard = "createLiveboard",
@@ -6163,7 +6241,6 @@ export declare enum Action {
         UnsubscribeScheduleHomepage = "unsubscribeScheduleHomepage",
         /**
             * The **Manage Tags** action on Homepage Favourite Module.
-            *
             * @example
             * ```js
             * disabledActions: [Action.ManageTags]
@@ -6822,6 +6899,7 @@ export declare class AnswerService {
             * Fetch the data for the answer as a PNG blob. This might be
             * quicker for larger data.
             * @param userLocale
+            * @param includeInfo
             * @param omitBackground Omit the background in the PNG
             * @param deviceScaleFactor The scale factor for the PNG
             * @return Response
@@ -6838,6 +6916,9 @@ export declare class AnswerService {
         /**
             * Just get the internal URL for this answer's data
             * as a PNG blob.
+            * @param userLocale
+            * @param omitBackground
+            * @param deviceScaleFactor
             */
         getFetchPNGBlobUrl(userLocale?: string, omitBackground?: boolean, deviceScaleFactor?: number): string;
         /**
@@ -6871,6 +6952,9 @@ export declare class AnswerService {
             */
         getSession(): SessionInterface;
         getAnswer(): Promise<any>;
+        getTML(): Promise<any>;
+        addDisplayedVizToLiveboard(liveboardId: string): Promise<any>;
+        setTMLOverride(override: any): void;
 }
 
 /**
@@ -6941,16 +7025,51 @@ export declare function testResetMixpanel(): void;
   */
 export declare const tokenizedFetch: typeof fetch;
 
-export declare function getAuthenticationToken(embedConfig: EmbedConfig): Promise<string>;
 /**
-  * Resets the auth token and a new token will be fetched on the next request.
+  * Get answer from natural language query
+  * @param query string
+  * @param worksheetId string
+  * @returns AnswerService and the suggestion response.
+  * @version SDK: 1.33.1 | ThoughtSpot: 10.3.0.cl
+  * @example
+  * ```js
+  * const { answer } = await getAnswerFromQuery('revenue', 'worksheetId');
+  * ```
+  */
+export declare const getAnswerFromQuery: (query: string, worksheetId: string) => Promise<{
+    answer: AnswerService;
+    suggestion: any;
+}>;
+
+/**
+  * Create a liveboard with the given answers
+  * @param answers AnswerService[]
+  * @param name string
+  * @returns result Promise
+  * @version SDK: 1.33.1 | ThoughtSpot: *
   * @example
   * ```js
-  * resetCachedAuthToken();
+  *   const lb = createLiveboardWithAnswers([
+  *      new AnswerService(session, null, 'tshost'),
+  *   ], "my-liveboard");
   * ```
-  * @version SDK: 1.28.0 | ThoughtSpot: *
-  * @group Authentication / Init
   */
+export declare const createLiveboardWithAnswers: (answers: AnswerService[], name: string) => Promise<any>;
+
+/**
+    *
+    * @param embedConfig
+    */
+export declare function getAuthenticationToken(embedConfig: EmbedConfig): Promise<string>;
+/**
+    * Resets the auth token and a new token will be fetched on the next request.
+    * @example
+    * ```js
+    * resetCachedAuthToken();
+    * ```
+    * @version SDK: 1.28.0 | ThoughtSpot: *
+    * @group Authentication / Init
+    */
 export declare const resetCachedAuthToken: () => void;
 
 /**
@@ -7145,7 +7264,9 @@ export declare class TsEmbed {
             * THOUGHTSPOT URL params starts with a prefix "ts-"
             * @version SDK: 1.14.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
             */
-        getThoughtSpotPostUrlParams(): string;
+        getThoughtSpotPostUrlParams(additionalParams?: {
+                [key: string]: string | number;
+        }): string;
         /**
             * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
             * @version SDK: 1.19.1 | ThoughtSpot: *