@thoughtspot/visual-embed-sdk 1.51.0 → 1.51.2

package/src/embed/base.ts

@@ -233,7 +233,7 @@ export const getIsInitCalled = (): boolean => !!getValueFromWindow(initFlagKey)?
 /**
  * Initializes the Visual Embed SDK globally and perform
  * authentication if applicable. This function needs to be called before any ThoughtSpot
- * component like Liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
+ * component like Liveboard etc can be embedded. But need not wait for AuthStatus.SUCCESS
  * to actually embed. That is handled internally.
  * @param embedConfig The configuration object containing ThoughtSpot host,
  * authentication mechanism and so on.

package/src/embed/conversation.spec.ts

@@ -537,6 +537,49 @@ describe('ConversationEmbed', () => {
         );
     });
 
+    it('should render the conversation embed with spotterAnalystConfig.analystId in the url', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            spotterAnalystConfig: {
+                analystId: 'analyst-id-1234',
+            },
+        };
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&analystId=analyst-id-1234#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
+
+    it('should not add analystId to the url when spotterAnalystConfig is not provided', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+        };
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expect(getIFrameSrc()).not.toContain('analystId');
+    });
+
+    it('should not add analystId to the url when spotterAnalystConfig is empty', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            spotterAnalystConfig: {},
+        };
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expect(getIFrameSrc()).not.toContain('analystId');
+    });
+
     describe('spotter chat hiddenActions', () => {
         it.each([
             ['SpotterChatConnectorResources', Action.SpotterChatConnectorResources],
@@ -548,6 +591,8 @@ describe('ConversationEmbed', () => {
             ['SpotterAnalystDelete', Action.SpotterAnalystDelete],
             ['SpotterAnalystMakeACopy', Action.SpotterAnalystMakeACopy],
             ['SpotterAnalystSidebar', Action.SpotterAnalystSidebar],
+            ['SpotterAnalystList', Action.SpotterAnalystList],
+            ['SpotterDefaultAnalyst', Action.SpotterDefaultAnalyst],
         ])('should render with hiddenActions for %s', async (_, action) => {
             const viewConfig: SpotterEmbedViewConfig = {
                 worksheetId: 'worksheetId',
@@ -592,6 +637,8 @@ describe('ConversationEmbed', () => {
             ['SpotterAnalystDelete', Action.SpotterAnalystDelete],
             ['SpotterAnalystMakeACopy', Action.SpotterAnalystMakeACopy],
             ['SpotterAnalystSidebar', Action.SpotterAnalystSidebar],
+            ['SpotterAnalystList', Action.SpotterAnalystList],
+            ['SpotterDefaultAnalyst', Action.SpotterDefaultAnalyst],
         ])('should render with disabledActions for %s', async (_, action) => {
             const disabledReason = 'testing disabled reason';
             const viewConfig: SpotterEmbedViewConfig = {
@@ -922,3 +969,92 @@ describe('SpotterEmbed updatedSpotterExperience', () => {
         );
     });
 });
+
+describe('SpotterEmbed APP_INIT starterPrompts', () => {
+    const mockEmbedEventPayload = { type: EmbedEvent.APP_INIT, data: {} };
+
+    async function getAppInitResponse(viewConfig: SpotterEmbedViewConfig) {
+        const embed = new SpotterEmbed(getRootEl(), viewConfig);
+        embed.render();
+        const mockPort: any = { postMessage: jest.fn() };
+        await executeAfterWait(() => {
+            postMessageToParent(getIFrameEl().contentWindow, mockEmbedEventPayload, mockPort);
+        });
+        await executeAfterWait(() => {});
+        return mockPort.postMessage.mock.calls[0]?.[0];
+    }
+
+    it('should include starterPrompts in embedParams when configured', async () => {
+        const response = await getAppInitResponse({
+            worksheetId: 'ws1',
+            spotterChatConfig: {
+                starterPrompts: {
+                    enable: true,
+                    quick: {
+                        label: 'Quick',
+                        questions: [{ label: 'Q1', prompt: 'P1' }],
+                    },
+                    research: { label: 'Research' },
+                    previewData: { label: 'Explore' },
+                },
+            },
+        });
+        expect(response.data.embedParams.starterPrompts).toEqual({
+            enable: true,
+            quick: {
+                label: 'Quick',
+                questions: [{ label: 'Q1', prompt: 'P1' }],
+            },
+            research: { label: 'Research' },
+            previewData: { label: 'Explore' },
+        });
+    });
+
+    it('should forward the config as is, the app enforces the limits', async () => {
+        const starterPrompts = {
+            quick: {
+                label: 'L'.repeat(50),
+                questions: [
+                    { label: 'Q'.repeat(100), prompt: 'P'.repeat(400) },
+                    { label: 'Q2', prompt: 'P2' },
+                    { label: 'Q3', prompt: 'P3' },
+                    { label: 'Q4', prompt: 'P4' },
+                    { label: 'Q5', prompt: 'P5' },
+                ],
+            },
+            previewData: { label: 'L'.repeat(50) },
+        };
+        const response = await getAppInitResponse({
+            worksheetId: 'ws1',
+            spotterChatConfig: { starterPrompts },
+        });
+        expect(response.data.embedParams.starterPrompts).toEqual(starterPrompts);
+    });
+
+    it('should not include starterPrompts in embedParams when not configured', async () => {
+        const response = await getAppInitResponse({ worksheetId: 'ws1' });
+        expect(response.data.embedParams?.starterPrompts).toBeUndefined();
+    });
+
+    it('exposes per-pill starter-prompt actions with the strings the app gates on', () => {
+        expect(Action.QuickSearchPill).toBe('quickSearchPill');
+        expect(Action.DeepAnalysisPill).toBe('deepAnalysisPill');
+        expect(Action.DataLiteracyPill).toBe('dataLiteracyPill');
+    });
+
+    it('forwards the enable feature flag when disabled', async () => {
+        const response = await getAppInitResponse({
+            worksheetId: 'ws1',
+            spotterChatConfig: {
+                starterPrompts: {
+                    enable: false,
+                    quick: { questions: [{ label: 'Q1', prompt: 'P1' }] },
+                },
+            },
+        });
+        expect(response.data.embedParams.starterPrompts).toEqual({
+            enable: false,
+            quick: { questions: [{ label: 'Q1', prompt: 'P1' }] },
+        });
+    });
+});

package/src/embed/conversation.ts

@@ -1,6 +1,6 @@
 import { Param, BaseViewConfig, RuntimeFilter, RuntimeParameter, ErrorDetailsTypes, EmbedErrorCodes, DefaultAppInitData, VisualizationOverrides, SpotterFileUploadFileTypes } from '../types';
 import { TsEmbed } from './ts-embed';
-import { buildSpotterSidebarAppInitData, buildSpotterShareConversationAppInitData } from './spotter-utils';
+import { buildSpotterSidebarAppInitData, buildSpotterShareConversationAppInitData, buildStarterPromptsAppInitData } from './spotter-utils';
 import { getQueryParamString, getFilterQuery, getRuntimeParameters, setParamIfDefined } from '../utils';
 
 /**
@@ -227,6 +227,91 @@ export interface SpotterShareConversationConfig {
     spotterSharedConversationExitLabel?: string;
 }
 
+/**
+ * A single starter prompt question shown under a category pill.
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+ * @group Embed components
+ */
+export interface StarterPromptQuestion {
+    /**
+     * Short label shown as a clickable suggestion. Falls back to `prompt` when
+     * omitted. ThoughtSpot truncates it beyond 80 characters.
+     */
+    label?: string;
+    /**
+     * Prompt text sent to Spotter on click. ThoughtSpot truncates it beyond
+     * 300 characters.
+     */
+    prompt: string;
+}
+
+/**
+ * Configuration for a starter prompt category with questions
+ * (`quick` and `research`).
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+ * @group Embed components
+ */
+export interface StarterPromptCategory {
+    /**
+     * Overrides the default category pill label. ThoughtSpot truncates it
+     * beyond 30 characters.
+     */
+    label?: string;
+    /**
+     * Replaces the backend-generated prompts. ThoughtSpot renders the first 4
+     * and drops any entry without a `prompt`.
+     */
+    questions?: StarterPromptQuestion[];
+}
+
+/**
+ * Configuration for the Data Literacy starter prompt category.
+ * Only the label is customizable; the prompt text comes from the backend.
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+ * @group Embed components
+ */
+export interface StarterPreviewDataCategory {
+    /**
+     * Overrides the default category pill label. ThoughtSpot truncates it
+     * beyond 30 characters.
+     */
+    label?: string;
+}
+
+/**
+ * Content configuration for the Spotter starter prompts.
+ * Keys are fixed: `quick` (Basic Search), `research` (Deep Analysis),
+ * `previewData` (Data Literacy) and `liveboard` (Liveboard chat panel).
+ *
+ * Note: this controls the Spotter chat interface only. The starter prompts on
+ * the Liveboard SpotterViz surface are configured separately through
+ * {@link SpotterVizConfig.customStarterPrompts}.
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+ * @group Embed components
+ */
+export interface StarterPromptsConfig {
+    /**
+     * Turns the starter prompts surface on. Must be set explicitly, an
+     * unset flag leaves the surface off.
+     *
+     * Either this or `enableStarterPrompts` turns the surface on, so `false`
+     * here does not switch it off while `enableStarterPrompts` is `true`.
+     * @default false
+     */
+    enable?: boolean;
+    /** Basic Search category configuration. */
+    quick?: StarterPromptCategory;
+    /** Deep Analysis category configuration. */
+    research?: StarterPromptCategory;
+    /** Data Literacy category configuration. */
+    previewData?: StarterPreviewDataCategory;
+    /**
+     * Starter prompts for the Spotter chat panel on a Liveboard.
+     * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
+     */
+    liveboard?: StarterPromptQuestion[];
+}
+
 /**
  * Configuration for customizing Spotter chat UI branding.
  * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
@@ -267,11 +352,84 @@ export interface SpotterChatViewConfig {
     /**
      * Enables starter prompts in the Spotter chat interface.
      *
-     * Supported embed types: SpotterEmbed, LiveboardEmbed, AppEmbed
+     * Either this or `starterPrompts.enable` turns the surface on, so it stays
+     * on while this is `true` even if `starterPrompts.enable` is `false`.
+     *
+     * Supported embed types: `SpotterEmbed`, `LiveboardEmbed`, `AppEmbed`
      * @version SDK: 1.51.0 | ThoughtSpot: 26.8.0.cl
      * @default false
      */
     enableStarterPrompts?: boolean;
+    /**
+     * Customizes the labels and questions of the Spotter starter prompts.
+     * Individual pills are hidden or shown with `hiddenActions` /
+     * `visibleActions` using `Action.QuickSearchPill`,
+     * `Action.DeepAnalysisPill` and `Action.DataLiteracyPill`.
+     *
+     * Supported embed types: `SpotterEmbed`, `LiveboardEmbed`, `AppEmbed`
+     * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+     * @example
+     * ```js
+     * const embed = new SpotterEmbed('#tsEmbed', {
+     *    worksheetId: 'worksheet-id',
+     *    hiddenActions: [Action.DeepAnalysisPill],
+     *    spotterChatConfig: {
+     *        starterPrompts: {
+     *            enable: true,
+     *            quick: {
+     *                label: 'Quick questions',
+     *                questions: [
+     *                    { label: 'Top products', prompt: 'What are the top products by revenue?' },
+     *                ],
+     *            },
+     *            previewData: { label: 'Explore your data' },
+     *        },
+     *    },
+     * })
+     * ```
+     */
+    starterPrompts?: StarterPromptsConfig;
+    /**
+     * Opens the Spotter chat panel when the Liveboard loads.
+     *
+     * Supported embed types: `LiveboardEmbed`, `AppEmbed`
+     * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
+     * @default true
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#tsEmbed', {
+     *    liveboardId: 'liveboard-id',
+     *    spotterChatConfig: {
+     *        openSpotterOnLiveboardByDefault: false,
+     *    },
+     * })
+     * ```
+     */
+    openSpotterOnLiveboardByDefault?: boolean;
+}
+
+/**
+ * Configuration for the Spotter Analyst experience.
+ * Can be used in SpotterEmbed.
+ * @group Embed components
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
+ * @example
+ * ```js
+ * const embed = new SpotterEmbed('#tsEmbed', {
+ *    ... //other embed view config
+ *    spotterAnalystConfig: {
+ *        analystId: 'analyst-id-1234',
+ *    },
+ * })
+ * ```
+ */
+export interface SpotterAnalystConfig {
+    /**
+     * Pins the embed to a single spotter analyst. Implies no default Spotter
+     * and no "Show all".
+     * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
+     */
+    analystId?: string;
 }
 
 /**
@@ -303,6 +461,22 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
      */
     dataSources?: string[];
+    /**
+     * Configuration for the Spotter Analyst experience.
+     *
+     * Supported embed types: `SpotterEmbed`
+     * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
+     * @example
+     * ```js
+     * const embed = new SpotterEmbed('#tsEmbed', {
+     *    ... //other embed view config
+     *    spotterAnalystConfig: {
+     *        analystId: 'analyst-id-1234',
+     *    },
+     * })
+     * ```
+     */
+    spotterAnalystConfig?: SpotterAnalystConfig;
     /**
      * Ability to pass a starting search query to the conversation.
      */
@@ -626,6 +800,7 @@ export interface SpotterAppInitData extends DefaultAppInitData {
         spotterSidebarConfig?: SpotterSidebarViewConfig;
         spotterShareConversationConfig?: SpotterShareConversationConfig;
         visualOverridesParams?: VisualizationOverrides | null;
+        starterPrompts?: StarterPromptsConfig;
     };
 }
 
@@ -674,7 +849,8 @@ export class SpotterEmbed extends TsEmbed {
             this.viewConfig,
             this.handleError.bind(this),
         );
-        return buildSpotterShareConversationAppInitData(sidebarInitData, this.viewConfig);
+        const shareInitData = buildSpotterShareConversationAppInitData(sidebarInitData, this.viewConfig);
+        return buildStarterPromptsAppInitData(shareInitData, this.viewConfig);
     }
 
     protected getEmbedParamsObject() {
@@ -695,6 +871,7 @@ export class SpotterEmbed extends TsEmbed {
             defaultQueryMode,
             enableStopAnswerGenerationEmbed,
             spotterChatConfig,
+            spotterAnalystConfig,
         } = this.viewConfig;
 
         const queryParams = this.getBaseQueryParams();
@@ -710,6 +887,7 @@ export class SpotterEmbed extends TsEmbed {
         setParamIfDefined(queryParams, Param.ShowSpotterRadiance, showSpotterRadiance, true);
         setParamIfDefined(queryParams, Param.DefaultQueryMode, defaultQueryMode);
         setParamIfDefined(queryParams, Param.EnableStopAnswerGenerationEmbed, enableStopAnswerGenerationEmbed, true);
+        setParamIfDefined(queryParams, Param.AnalystId, spotterAnalystConfig?.analystId);
 
         // Handle spotterChatConfig params
         if (spotterChatConfig) {

package/src/embed/events.spec.ts

@@ -474,6 +474,10 @@ describe('Action enum values', () => {
     test('RemoveFromFavorites should resolve to its string value', () => {
         expect(Action.RemoveFromFavorites).toBe('removeFromFavorites');
     });
+
+    test('EditInputTable should resolve to its string value', () => {
+        expect(Action.EditInputTable).toBe('editInputTable');
+    });
 });
 
 describe('EmbedEvent basic routing', () => {

package/src/embed/host-events.spec.ts

@@ -180,6 +180,54 @@ describe('HostEvent.OpenParameter', () => {
     });
 });
 
+// ---------------------------------------------------------------------------
+// 10c – OpenAddFilterModal
+// ---------------------------------------------------------------------------
+describe('HostEvent.OpenAddFilterModal', () => {
+    test('postMessage type is openAddFilterModal (camelCase, no payload)', async () => {
+        mockMessageChannel();
+        const { lb, iframe } = await renderLiveboard();
+        await executeAfterWait(() => {
+            lb.trigger(HostEvent.OpenAddFilterModal);
+            expect(iframe.contentWindow.postMessage).toHaveBeenCalledWith(
+                expect.objectContaining({ type: 'openAddFilterModal' }),
+                thoughtSpotHost,
+                expect.anything(),
+            );
+        });
+    });
+
+    test('returns null when !isRendered', async () => {
+        const lb = unrenderedLiveboard();
+        const result = await lb.trigger(HostEvent.OpenAddFilterModal);
+        expect(result).toBeNull();
+    });
+});
+
+// ---------------------------------------------------------------------------
+// 10d – OpenAddParameterModal
+// ---------------------------------------------------------------------------
+describe('HostEvent.OpenAddParameterModal', () => {
+    test('postMessage type is openAddParameterModal (camelCase, no payload)', async () => {
+        mockMessageChannel();
+        const { lb, iframe } = await renderLiveboard();
+        await executeAfterWait(() => {
+            lb.trigger(HostEvent.OpenAddParameterModal);
+            expect(iframe.contentWindow.postMessage).toHaveBeenCalledWith(
+                expect.objectContaining({ type: 'openAddParameterModal' }),
+                thoughtSpotHost,
+                expect.anything(),
+            );
+        });
+    });
+
+    test('returns null when !isRendered', async () => {
+        const lb = unrenderedLiveboard();
+        const result = await lb.trigger(HostEvent.OpenAddParameterModal);
+        expect(result).toBeNull();
+    });
+});
+
 // ---------------------------------------------------------------------------
 // 11 – AddColumns
 // ---------------------------------------------------------------------------

package/src/embed/hostEventClient/host-event-client.spec.ts

@@ -1154,4 +1154,38 @@ describe('HostEventClient', () => {
             expect(result.answerId).toBeUndefined();
         });
     });
+
+    describe('trigger typing contracts (compile-time)', () => {
+        // These assertions are enforced by ts-jest at compile time; the runtime
+        // expect() is trivial. They lock the PayloadT default on
+        // triggerHostEvent: no-payload calls must infer the contract response
+        // instead of collapsing to `any`.
+        type IsAny<T> = 0 extends 1 & T ? true : false;
+        type Extends<A, B> = A extends B ? true : false;
+
+        it('infers typed response for no-payload contracted events and keeps any for uncontracted', () => {
+            const { client } = createHostEventClient();
+
+            // Contracted event, called with no payload — the fixed case.
+            const getTabs = () => client.triggerHostEvent(HostEvent.GetTabs);
+            type TabsResponse = Awaited<ReturnType<typeof getTabs>>;
+            const tabsIsTyped: IsAny<TabsResponse> = false;
+            const tabsHasContractFields: Extends<
+                TabsResponse,
+                { numberOfTabs: number; orderedTabIds: string[] }
+            > = true;
+            const probeUnknownField = (r: TabsResponse) =>
+                // @ts-expect-error — field not on the GetTabs contract (was silent when `any`)
+                r.tabCount;
+            void probeUnknownField;
+
+            // Uncontracted event — must remain `any` with or without payload.
+            const reload = () => client.triggerHostEvent(HostEvent.Reload);
+            type ReloadResponse = Awaited<ReturnType<typeof reload>>;
+            const reloadStaysAny: IsAny<ReloadResponse> = true;
+
+            expect([tabsIsTyped, tabsHasContractFields, reloadStaysAny])
+                .toEqual([false, true, true]);
+        });
+    });
 });

package/src/embed/hostEventClient/host-event-client.ts

@@ -281,8 +281,8 @@ export class HostEventClient {
    */
   public async triggerHostEvent<
     HostEventT extends HostEvent,
-    PayloadT,
-    ContextT extends ContextType,
+    PayloadT = HostEventRequest<HostEventT>,
+    ContextT extends ContextType = ContextType,
   >(
       hostEvent: HostEventT,
       payload?: TriggerPayload<PayloadT, HostEventT>,