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

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

@@ -692,19 +692,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             * @deprecated Use {@link collapseSearchBar} instead
             */
         collapseSearchBarInitially?: boolean;
-        /**
-            * To enable custom column groups in data panel v2
-            * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
-            * @default false
-            * @example
-            * ```js
-            * const embed = new SearchEmbed('#tsEmbed', {
-            *   ... // other options
-            *   enableCustomColumnGroups: true,
-            * });
-            * ```
-            */
-        enableCustomColumnGroups?: boolean;
         /**
             * Flag to enable onBeforeSearchExecute Embed Event
             * @version: SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
@@ -1101,19 +1088,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * @deprecated Use {@link collapseSearchBar} instead
             */
         collapseSearchBarInitially?: boolean;
-        /**
-            * To enable custom column groups in data panel v2.
-            * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
-            * @default false
-            * @example
-            * ```js
-            * const embed = new AppEmbed('#embed', {
-            *   ... // other app view config
-            *   enableCustomColumnGroups: true,
-            * });
-            * ```
-            */
-        enableCustomColumnGroups?: boolean;
         /**
             * This controls the initial behaviour of custom column groups accordion.
             * It takes DataPanelCustomColumnGroupsAccordionState enum values as input.
@@ -1640,6 +1614,21 @@ export interface ConversationViewConfig extends ViewConfig {
             */
         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);
@@ -2214,7 +2203,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;
@@ -2679,6 +2667,19 @@ export interface ViewConfig {
             * ```
             */
         dataPanelV2?: boolean;
+        /**
+            * To enable custom column groups in data panel v2
+            * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+            * @default false
+            * @example
+            * ```js
+            * const embed = new SearchEmbed('#tsEmbed', {
+            *   ... // other options
+            *   enableCustomColumnGroups: true,
+            * });
+            * ```
+            */
+        enableCustomColumnGroups?: boolean;
 }
 /**
     * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -2879,7 +2880,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
     * // ...
@@ -2896,7 +2896,6 @@ export interface RuntimeParameter {
     *     );
     * };
     * ```
-    *
     * @group Events
     */
 export declare enum EmbedEvent {
@@ -3770,7 +3769,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
@@ -3781,9 +3779,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,
@@ -3869,7 +3865,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 = () => {
@@ -3887,7 +3882,6 @@ export declare enum EmbedEvent {
     *      );
     *  }
     * ```
-    *
     * @group Events
     */
 export declare enum HostEvent {
@@ -4188,28 +4182,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",
@@ -4235,7 +4224,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
@@ -4243,7 +4231,6 @@ export declare enum HostEvent {
             *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
             * })
             * ```
-            *
             * @example
             * ```js
             * searchEmbed.trigger(HostEvent.CreateMonitor)
@@ -4254,7 +4241,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
@@ -4262,12 +4248,10 @@ export declare enum HostEvent {
             *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
             * })
             * ```
-            *
             * @example
             * ```js
             * searchEmbed.trigger(HostEvent.ManageMonitor)
             * ```
-            *
             * @example
             * ```js
             * vizEmbed.trigger(HostEvent.ManageMonitor)
@@ -4597,7 +4581,6 @@ export declare enum HostEvent {
             *        }
             *    });
             * ```
-            *
             * @example
             *
             * ```js
@@ -4679,7 +4662,6 @@ export declare enum HostEvent {
         /**
             * Get the answer session for a Search or
             * Liveboard visualization.
-            *
             * @example
             * ```js
             * const {session} = await embed.trigger(
@@ -4687,12 +4669,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",
@@ -4861,7 +4841,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
@@ -5414,7 +5395,6 @@ export declare enum Action {
         /**
             * @deprecated
             * Reports errors
-            *
             * @example
             * ```js
             * disabledActions: [Action.ReportError]
@@ -5644,14 +5624,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]
@@ -5662,7 +5640,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]
@@ -5672,8 +5649,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]
@@ -5687,7 +5663,6 @@ export declare enum Action {
             * ```js
             * disabledActions: [Action.ShowSageQuery]
             * ```
-            *
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         ShowSageQuery = "showSageQuery",
@@ -5702,8 +5677,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]
@@ -5780,7 +5754,6 @@ export declare enum Action {
             * hiddenAction: [Action.CreateLiveboard]
             * disabledActions: [Action.CreateLiveboard]
             * ```
-            *
             * @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
             */
         CreateLiveboard = "createLiveboard",
@@ -5876,7 +5849,6 @@ export declare enum Action {
         UnsubscribeScheduleHomepage = "unsubscribeScheduleHomepage",
         /**
             * The **Manage Tags** action on Homepage Favourite Module.
-            *
             * @example
             * ```js
             * disabledActions: [Action.ManageTags]
@@ -6469,7 +6441,7 @@ export interface BodylessConversationViewConfig extends ViewConfig {
     * Create a conversation embed, which can be integrated inside
     * chatbots or other conversational interfaces.
     * @group Embed components
-    * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
+    * @version SDK: 1.33.1 | ThoughtSpot: 10.5.0.cl
     */
 export declare class BodylessConversation {
         constructor(viewConfig: BodylessConversationViewConfig);
@@ -7222,7 +7194,7 @@ export declare class AnswerService {
             * @param deviceScaleFactor The scale factor for the PNG
             * @return Response
             */
-        fetchPNGBlob(userLocale?: string, includeInfo?: boolean, omitBackground?: boolean, deviceScaleFactor?: number): Promise<Response>;
+        fetchPNGBlob(userLocale?: string, omitBackground?: boolean, deviceScaleFactor?: number): Promise<Response>;
         /**
             * Just get the internal URL for this answer's data
             * as a CSV blob.
@@ -7344,16 +7316,34 @@ export declare function testResetMixpanel(): void;
 export declare const tokenizedFetch: typeof fetch;
 
 /**
-  *
+  * Get answer from natural language query
   * @param query string
   * @param worksheetId string
-  * @returns answerService AnswerService
+  * @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
+  *   const lb = createLiveboardWithAnswers([
+  *      new AnswerService(session, null, 'tshost'),
+  *   ], "my-liveboard");
+  * ```
+  */
 export declare const createLiveboardWithAnswers: (answers: AnswerService[], name: string) => Promise<any>;
 
 /**