@thoughtspot/visual-embed-sdk 1.46.0 → 1.46.2

package/src/embed/conversation.spec.ts

@@ -327,6 +327,43 @@ describe('ConversationEmbed', () => {
         );
     });
 
+    it('should render the conversation embed with deprecated standalone enablePastConversationsSidebar flag', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            enablePastConversationsSidebar: true,
+        };
+
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&enablePastConversationsSidebar=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
+
+    it('should prefer spotterSidebarConfig.enablePastConversationsSidebar over deprecated standalone flag', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            enablePastConversationsSidebar: false,
+            spotterSidebarConfig: {
+                enablePastConversationsSidebar: true,
+            },
+        };
+
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&enablePastConversationsSidebar=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
+
     it('should render the conversation embed with all boolean flags set', async () => {
         const viewConfig: SpotterEmbedViewConfig = {
             worksheetId: 'worksheetId',

package/src/embed/conversation.ts

@@ -2,7 +2,7 @@ import isUndefined from 'lodash/isUndefined';
 import { ERROR_MESSAGE } from '../errors';
 import { Param, BaseViewConfig, RuntimeFilter, RuntimeParameter, ErrorDetailsTypes, EmbedErrorCodes } from '../types';
 import { TsEmbed } from './ts-embed';
-import { getQueryParamString, getFilterQuery, getRuntimeParameters, validateHttpUrl, setParamIfDefined } from '../utils';
+import { getQueryParamString, getFilterQuery, getRuntimeParameters, validateHttpUrl, setParamIfDefined, resolveEnablePastConversationsSidebar } from '../utils';
 
 /**
  * Configuration for search options
@@ -18,82 +18,82 @@ export interface SearchOptions {
  * Configuration for the Spotter sidebar.
  * Can be used in SpotterEmbed and AppEmbed.
  * @group Embed components
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
  */
 export interface SpotterSidebarViewConfig {
     /**
      * Controls the visibility of the past conversations sidebar.
      * @default false
-     * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
+     * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
      */
     enablePastConversationsSidebar?: boolean;
     /**
      * Custom title text for the sidebar header.
      * Defaults to translated "Spotter" text.
-     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
      */
     spotterSidebarTitle?: string;
     /**
      * Boolean to set the default expanded state of the sidebar.
      * @default false
-     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
      */
     spotterSidebarDefaultExpanded?: boolean;
     /**
      * Custom label text for the rename action in the conversation edit menu.
      * Defaults to translated "Rename" text.
-     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
      */
     spotterChatRenameLabel?: string;
     /**
      * Custom label text for the delete action in the conversation edit menu.
      * Defaults to translated "DELETE" text.
-     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
      */
     spotterChatDeleteLabel?: string;
     /**
      * Custom title text for the delete conversation confirmation modal.
      * Defaults to translated "Delete chat" text.
-     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
      */
     spotterDeleteConversationModalTitle?: string;
     /**
      * Custom message text for the past conversation banner alert.
      * Defaults to translated alert message.
-     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
      */
     spotterPastConversationAlertMessage?: string;
     /**
      * Custom URL for the documentation/best practices link.
      * Defaults to ThoughtSpot docs URL based on release version.
      * Note: URL must include the protocol (e.g., `https://www.example.com`).
-     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
      */
     spotterDocumentationUrl?: string;
     /**
      * Custom label text for the best practices button in the footer.
      * Defaults to translated "Best Practices" text.
-     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
      */
     spotterBestPracticesLabel?: string;
     /**
      * Number of conversations to fetch per batch when loading conversation history.
      * @default 30
-     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
      */
     spotterConversationsBatchSize?: number;
     /**
      * Custom title text for the "New Chat" button in the sidebar.
      * Defaults to translated "New Chat" text.
-     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
      */
     spotterNewChatButtonTitle?: string;
 }
 
 /**
  * Configuration for customizing Spotter chat UI branding.
- * @group Embed components
  * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
+ * @group Embed components
  */
 export interface SpotterChatViewConfig {
     /**
@@ -133,6 +133,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      * but still display the selected data source.
      *
      * Supported embed types: `SpotterEmbed`
+     * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      * @example
      * ```js
      * const embed = new SpotterEmbed('#tsEmbed', {
@@ -140,13 +141,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      *    disableSourceSelection : true,
      * })
      * ```
-     * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      */
     disableSourceSelection?: boolean;
     /**
      * hideSourceSelection : Hide data source selection
      *
      * Supported embed types: `SpotterEmbed`
+     * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      * @example
      * ```js
      * const embed = new SpotterEmbed('#tsEmbed', {
@@ -154,15 +155,14 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      *    hideSourceSelection : true,
      * })
      * ```
-     * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      */
     hideSourceSelection?: boolean;
     /**
      * Flag to control Data panel experience
      *
      * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
+     * @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
      * @default true
-     * @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
      * @example
      * ```js
      * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -179,6 +179,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      * default is false.
      *
      * Supported embed types: `SpotterEmbed`
+     * @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
      * @example
      * ```js
      * const embed = new SpotterEmbed('#tsEmbed', {
@@ -186,7 +187,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      *    showSpotterLimitations : true,
      * })
      * ```
-     * @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
      */
     showSpotterLimitations?: boolean;
     /**
@@ -194,6 +194,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      * the initial screen of the conversation.
      *
      * Supported embed types: `SpotterEmbed`
+     * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      * @example
      * ```js
      * const embed = new SpotterEmbed('#tsEmbed', {
@@ -201,7 +202,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      *    hideSampleQuestions : true,
      * })
      * ```
-     * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      */
     hideSampleQuestions?: boolean;
     /**
@@ -209,6 +209,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      * visualization, or Liveboard.
      *
      * Supported embed types: `SpotterEmbed`
+     * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
      * @example
      * ```js
      * const embed = new SpotterEmbed('#tsEmbed', {
@@ -222,7 +223,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      *       ],
      * })
      * ```
-     * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
      */
     runtimeFilters?: RuntimeFilter[];
     /**
@@ -233,14 +233,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      * (default behavior before SDK 1.45.0).
      *
      * Supported embed types: `SpotterEmbed`
-     * @default true
      * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
+     * @default true
      */
     excludeRuntimeFiltersfromURL?: boolean;
     /**
      * The list of runtime parameters to apply to the conversation.
      *
      * Supported embed types: `SpotterEmbed`
+     * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
      * @example
      * ```js
      * const embed = new SpotterEmbed('#tsEmbed', {
@@ -253,7 +254,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      *       ],
      * })
      * ```
-     * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
      */
     runtimeParameters?: RuntimeParameter[];
     /**
@@ -264,14 +264,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      * the iframe URL instead (default behavior before SDK 1.45.0).
      *
      * Supported embed types: `SpotterEmbed`
-     * @default true
      * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
+     * @default true
      */
     excludeRuntimeParametersfromURL?: boolean;
     /**
      * updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
      *
      * Supported embed types: `SpotterEmbed`
+     * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
      * @default false
      * @example
      * ```js
@@ -280,17 +281,30 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      *    updatedSpotterChatPrompt : true,
      * })
      * ```
-     * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
      */
     updatedSpotterChatPrompt?: boolean;
+    /**
+     * Controls the visibility of the past conversations sidebar.
+     *
+     * Supported embed types: `SpotterEmbed`
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     * @deprecated from SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
+     * Use `spotterSidebarConfig.enablePastConversationsSidebar`.
+     * @default false
+     */
+    enablePastConversationsSidebar?: boolean;
     /**
      * Configuration for the Spotter sidebar UI customization.
      *
      * Supported embed types: `SpotterEmbed`, `AppEmbed`
+     * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
      * @example
      * ```js
      * const embed = new SpotterEmbed('#tsEmbed', {
-     *    ... //other embed view config
+     *    worksheetId: 'worksheet-id',
+     *    // Deprecated standalone flag (backward compatibility)
+     *    enablePastConversationsSidebar: false,
+     *    // Recommended config; this value takes precedence
      *    spotterSidebarConfig: {
      *        enablePastConversationsSidebar: true,
      *        spotterSidebarTitle: 'My Conversations',
@@ -298,7 +312,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      *    },
      * })
      * ```
-     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
      */
     spotterSidebarConfig?: SpotterSidebarViewConfig;
     /**
@@ -306,6 +319,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      * branding in tool response cards.
      *
      * Supported embed types: `SpotterEmbed`
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
      * @example
      * ```js
      * const embed = new SpotterEmbed('#tsEmbed', {
@@ -316,15 +330,14 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      *    },
      * })
      * ```
-     * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
      */
     spotterChatConfig?: SpotterChatViewConfig;
 }
 
 /**
  * The configuration for the embedded spotterEmbed options.
- * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
  * Use {@link SpotterEmbedViewConfig} instead
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
  * @group Embed components
  */
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
@@ -332,6 +345,7 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {}
 
 /**
  * Embed ThoughtSpot AI Conversation.
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
  * @group Embed components
  * @example
  * ```js
@@ -343,7 +357,6 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {}
  * });
  * conversation.render();
  * ```
- * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
  */
 export class SpotterEmbed extends TsEmbed {
     constructor(container: HTMLElement, protected viewConfig: SpotterEmbedViewConfig) {
@@ -376,7 +389,7 @@ export class SpotterEmbed extends TsEmbed {
 
         // Extract sidebar config properties
         const {
-            enablePastConversationsSidebar,
+            enablePastConversationsSidebar: sidebarEnablePastConversationsSidebar,
             spotterSidebarTitle,
             spotterSidebarDefaultExpanded,
             spotterChatRenameLabel,
@@ -388,6 +401,10 @@ export class SpotterEmbed extends TsEmbed {
             spotterConversationsBatchSize,
             spotterNewChatButtonTitle,
         } = spotterSidebarConfig || {};
+        const resolvedEnablePastConversationsSidebar = resolveEnablePastConversationsSidebar({
+            spotterSidebarConfigValue: sidebarEnablePastConversationsSidebar,
+            standaloneValue: this.viewConfig.enablePastConversationsSidebar,
+        });
 
         if (!worksheetId) {
             this.handleError({
@@ -407,6 +424,12 @@ export class SpotterEmbed extends TsEmbed {
         setParamIfDefined(queryParams, Param.ShowSpotterLimitations, showSpotterLimitations, true);
         setParamIfDefined(queryParams, Param.HideSampleQuestions, hideSampleQuestions, true);
         setParamIfDefined(queryParams, Param.UpdatedSpotterChatPrompt, updatedSpotterChatPrompt, true);
+        setParamIfDefined(
+            queryParams,
+            Param.EnablePastConversationsSidebar,
+            resolvedEnablePastConversationsSidebar,
+            true,
+        );
         setParamIfDefined(queryParams, Param.SpotterSidebarDefaultExpanded, spotterSidebarDefaultExpanded, true);
 
         // String params
@@ -456,16 +479,10 @@ export class SpotterEmbed extends TsEmbed {
             excludeRuntimeFiltersfromURL,
             runtimeParameters,
             excludeRuntimeParametersfromURL,
-            spotterSidebarConfig,
         } = this.viewConfig;
         const path = 'insights/conv-assist';
         const queryParams = this.getEmbedParamsObject();
 
-        const enablePastConversationsSidebar = spotterSidebarConfig?.enablePastConversationsSidebar;
-        if (!isUndefined(enablePastConversationsSidebar)) {
-            queryParams[Param.EnablePastConversationsSidebar] = !!enablePastConversationsSidebar;
-        }
-
         let query = '';
         const queryParamsString = getQueryParamString(queryParams, true);
         if (queryParamsString) {
@@ -500,8 +517,9 @@ export class SpotterEmbed extends TsEmbed {
 
 /**
  * Embed ThoughtSpot AI Conversation.
- * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
  * Use {@link SpotterEmbed} instead
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
  * @group Embed components
  * @example
  * ```js
@@ -513,7 +531,6 @@ export class SpotterEmbed extends TsEmbed {
  * });
  * conversation.render();
  * ```
- * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
  */
 export class ConversationEmbed extends SpotterEmbed {
     constructor(container: HTMLElement, protected viewConfig: ConversationViewConfig) {

package/src/embed/liveboard.spec.ts

@@ -169,7 +169,7 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
-    test('should set isLiveboardStylingAndGroupingEnabled to true in url', async () => {
+    test('should set isLiveboardStylingAndGroupingEnabled to true in url (deprecated, use isLiveboardMasterpiecesEnabled)', async () => {
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             isLiveboardStylingAndGroupingEnabled: true,
             ...defaultViewConfig,