@thoughtspot/visual-embed-sdk 1.40.1-alpha.2 → 1.40.1-alpha.3

package/src/embed/bodyless-conversation.ts

@@ -39,14 +39,6 @@ export class ConversationMessage extends TsEmbed {
         super(container, viewConfig);
     }
 
-    protected getEmbedParamsObject() {
-        const queryParams = this.getBaseQueryParams();
-
-        queryParams[Param.HideActions] = [...(queryParams[Param.HideActions] ?? [])];
-        queryParams[Param.isSpotterAgentEmbed] = true;
-        return queryParams;
-    }
-
     public getIframeSrc() {
         const {
             sessionId,
@@ -57,8 +49,10 @@ export class ConversationMessage extends TsEmbed {
             messageId,
         } = this.viewConfig;
         const path = 'conv-assist-answer';
-        const queryParams = this.getEmbedParamsObject();
+        const queryParams = this.getBaseQueryParams();
 
+        queryParams[Param.HideActions] = [...(queryParams[Param.HideActions] ?? [])];
+        queryParams[Param.isSpotterAgentEmbed] = true;
         let query = '';
         const queryParamsString = getQueryParamString(queryParams, true);
         if (queryParamsString) {

package/src/embed/conversation.spec.ts

@@ -1,10 +1,8 @@
-import {
-    SpotterEmbed,
-    SpotterEmbedViewConfig,
-} from './conversation';
+import { SpotterEmbed, SpotterEmbedViewConfig, ConversationEmbed } from './conversation';
+import { TsEmbed } from './ts-embed';
 import * as authInstance from '../auth';
 import { Action, init } from '../index';
-import { AuthType, Param } from '../types';
+import { AuthType, Param, RuntimeFilterOp } from '../types';
 import {
     getDocumentBody,
     getIFrameSrc,
@@ -180,4 +178,132 @@ describe('ConversationEmbed', () => {
             `http://${thoughtSpotHost}/v2/?${defaultParams}&${Param.DisableActions}=[%22${Action.InConversationTraining}%22]&${Param.DisableActionReason}=${disabledReason}&isSpotterExperienceEnabled=true&enableDataPanelV2=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
         );
     });
+
+    it('should render the conversation embed with runtime filters', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            runtimeFilters: [
+                {
+                    columnName: 'revenue',
+                    operator: RuntimeFilterOp.EQ,
+                    values: [1000],
+                },
+            ],
+        };
+
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&col1=revenue&op1=EQ&val1=1000#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
+
+    it('should render the conversation embed with runtime parameters', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            runtimeParameters: [
+                {
+                    name: 'Date Range',
+                    value: '30',
+                },
+            ],
+        };
+
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&param1=Date%20Range&paramVal1=30#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
+
+    it('should render the conversation embed with runtime parameters excluded from URL', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            runtimeParameters: [
+                {
+                    name: 'Date Range',
+                    value: '30',
+                },
+                {
+                    name: 'Region',
+                    value: 'North America',
+                },
+            ],
+            excludeRuntimeParametersfromURL: true,
+        };
+
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
+
+    it('should render the conversation embed with both runtime filters and parameters', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            runtimeParameters: [
+                {
+                    name: 'Date Range',
+                    value: '30',
+                },
+            ],
+            runtimeFilters: [
+                {
+                    columnName: 'revenue',
+                    operator: RuntimeFilterOp.EQ,
+                    values: [1000],
+                },
+            ],
+            excludeRuntimeParametersfromURL: false,
+            excludeRuntimeFiltersfromURL: false,
+        };
+
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&col1=revenue&op1=EQ&val1=1000&param1=Date%20Range&paramVal1=30#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
+
+    it('should ensure deprecated ConversationEmbed class maintains same functionality as SpotterEmbed', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            runtimeParameters: [
+                {
+                    name: 'Date Range',
+                    value: '30',
+                },
+            ],
+        };
+
+        // Test with deprecated class
+        const conversationEmbed = new ConversationEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+
+        // Verify it generates the same URL structure as SpotterEmbed
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&param1=Date%20Range&paramVal1=30#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
 });

package/src/embed/conversation.ts

@@ -1,10 +1,10 @@
 import isUndefined from 'lodash/isUndefined';
 import { ERROR_MESSAGE } from '../errors';
-import { Param, BaseViewConfig } from '../types';
+import { Param, BaseViewConfig, RuntimeFilter, RuntimeParameter } from '../types';
 import { TsEmbed } from './ts-embed';
-import { getQueryParamString } from '../utils';
+import { getQueryParamString, getFilterQuery, getRuntimeParameters } from '../utils';
 
-/** 
+/**
  * Configuration for search options
  */
 export interface SearchOptions {
@@ -20,7 +20,8 @@ export interface SearchOptions {
  */
 export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
     /**
-     * The ID of the data source object. For example, Model, View, or Table. Spotter uses this object to query data and generate Answers.
+     * The ID of the data source object. For example, Model, View, or Table. Spotter uses
+     * this object to query data and generate Answers.
      */
     worksheetId: string;
     /**
@@ -30,7 +31,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
     /**
      * disableSourceSelection : Disables data source selection
      * but still display the selected data source.
-     * 
+     *
      * Supported embed types: `SpotterEmbed`
      * @example
      * ```js
@@ -44,7 +45,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
     disableSourceSelection?: boolean;
     /**
      * hideSourceSelection : Hide data source selection
-     * 
+     *
      * Supported embed types: `SpotterEmbed`
      * @example
      * ```js
@@ -58,7 +59,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
     hideSourceSelection?: boolean;
     /**
      * Flag to control Data panel experience
-     * 
+     *
      * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
      * @default false
      * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.4.0.cl
@@ -76,7 +77,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      * showSpotterLimitations : show limitation text
      * of the spotter underneath the chat input.
      * default is false.
-     * 
+     *
      * Supported embed types: `SpotterEmbed`
      * @example
      * ```js
@@ -91,7 +92,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
     /**
      * hideSampleQuestions : Hide sample questions on
      * the initial screen of the conversation.
-     * 
+     *
      * Supported embed types: `SpotterEmbed`
      * @example
      * ```js
@@ -103,6 +104,66 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      */
     hideSampleQuestions?: boolean;
+    /**
+     * The list of runtime filters to apply to a search Answer,
+     * visualization, or Liveboard.
+     *
+     * Supported embed types: `SpotterEmbed`
+     * @example
+     * ```js
+     * const embed = new SpotterEmbed('#tsEmbed', {
+     *    // other embed view config
+     *    runtimeFilters: [
+     *           {
+     *             columnName: 'color',
+     *             operator: RuntimeFilterOp.EQ,
+     *             values: ['red'],
+     *           },
+     *       ],
+     * })
+     * ```
+     * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
+     */
+    runtimeFilters?: RuntimeFilter[];
+    /**
+     * Flag to control whether runtime filters should be included in the URL.
+     * If true, filters will be passed via app initialization payload instead.
+     * If false/undefined, filters will be added to URL (default behavior).
+     *
+     * Supported embed types: `SpotterEmbed`
+     * @default false
+     * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
+     */
+    excludeRuntimeFiltersfromURL?: boolean;
+    /**
+     * The list of runtime parameters to apply to the conversation.
+     *
+     * Supported embed types: `SpotterEmbed`
+     * @example
+     * ```js
+     * const embed = new SpotterEmbed('#tsEmbed', {
+     *    // other embed view config
+     *    runtimeParameters: [
+     *           {
+     *             name: 'Integer Param',
+     *             value: 10,
+     *           },
+     *       ],
+     * })
+     * ```
+     * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
+     */
+    runtimeParameters?: RuntimeParameter[];
+    /**
+     * Flag to control whether runtime parameters should be included in the URL.
+     * If true, parameters will be passed via app initialization payload instead.
+     * If false/undefined, parameters will be added to URL (default behavior).
+     *
+     * Supported embed types: `SpotterEmbed`
+     * @default false
+     * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
+     */
+    excludeRuntimeParametersfromURL?: boolean;
 }
 
 /**
@@ -135,7 +196,7 @@ export class SpotterEmbed extends TsEmbed {
         super(container, viewConfig);
     }
 
-    protected getEmbedParamsObject() {
+    public getIframeSrc(): string {
         const {
             worksheetId,
             searchOptions,
@@ -144,8 +205,12 @@ export class SpotterEmbed extends TsEmbed {
             dataPanelV2,
             showSpotterLimitations,
             hideSampleQuestions,
+            runtimeFilters,
+            excludeRuntimeFiltersfromURL,
+            runtimeParameters,
+            excludeRuntimeParametersfromURL,
         } = this.viewConfig;
-
+        const path = 'insights/conv-assist';
         if (!worksheetId) {
             this.handleError(ERROR_MESSAGE.SPOTTER_EMBED_WORKSHEED_ID_NOT_FOUND);
         }
@@ -170,27 +235,26 @@ export class SpotterEmbed extends TsEmbed {
             queryParams[Param.HideSampleQuestions] = !!hideSampleQuestions;
         }
 
-        return queryParams;
-    }
-
-    public getIframeSrc(): string {
-        const {
-            worksheetId,
-            searchOptions,
-        } = this.viewConfig;
-        const path = 'insights/conv-assist';
-        const queryParams = this.getEmbedParamsObject();
-
         let query = '';
         const queryParamsString = getQueryParamString(queryParams, true);
         if (queryParamsString) {
             query = `?${queryParamsString}`;
         }
+
+        const filterQuery = getFilterQuery(runtimeFilters || []);
+        if (filterQuery && !excludeRuntimeFiltersfromURL) {
+            query += `&${filterQuery}`;
+        }
+
+        const parameterQuery = getRuntimeParameters(runtimeParameters || []);
+        if (parameterQuery && !excludeRuntimeParametersfromURL) {
+            query += `&${parameterQuery}`;
+        }
+
         const tsPostHashParams = this.getThoughtSpotPostUrlParams({
             worksheet: worksheetId,
             query: searchOptions?.searchQuery || '',
         });
-
         return `${this.getEmbedBasePath(query)}/embed/${path}${tsPostHashParams}`;
     }