@thoughtspot/visual-embed-sdk 1.50.0 → 1.51.0-test

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

@@ -7,6 +7,7 @@ import {
     init,
     AuthType,
     LiveboardEmbed,
+    AppEmbed,
     HostEvent,
     EmbedErrorCodes,
 } from '../index';
@@ -148,6 +149,85 @@ describe('HostEvent.OpenFilter', () => {
     });
 });
 
+// ---------------------------------------------------------------------------
+// 10b – OpenParameter
+// ---------------------------------------------------------------------------
+describe('HostEvent.OpenParameter', () => {
+    test('postMessage type is openParameter (camelCase)', async () => {
+        mockMessageChannel();
+        const { lb, iframe } = await renderLiveboard();
+        await executeAfterWait(() => {
+            lb.trigger(HostEvent.OpenParameter, { parameter: { parameterId: 'p1' } } as any);
+            expect(iframe.contentWindow.postMessage).toHaveBeenCalledWith(
+                expect.objectContaining({ type: 'openParameter' }),
+                thoughtSpotHost,
+                expect.anything(),
+            );
+        });
+    });
+
+    test('accepts a payload with only parameterName', async () => {
+        mockMessageChannel();
+        const { lb, iframe } = await renderLiveboard();
+        await executeAfterWait(() => {
+            lb.trigger(HostEvent.OpenParameter, { parameter: { parameterName: 'Param 1' } } as any);
+            expect(iframe.contentWindow.postMessage).toHaveBeenCalledWith(
+                expect.objectContaining({ type: 'openParameter' }),
+                thoughtSpotHost,
+                expect.anything(),
+            );
+        });
+    });
+});
+
+// ---------------------------------------------------------------------------
+// 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
 // ---------------------------------------------------------------------------
@@ -1633,3 +1713,165 @@ describe('context parameter forwarded in postMessage payload', () => {
         });
     });
 });
+
+// ---------------------------------------------------------------------------
+// SetVisibleVizs — array vizId injection (NOT in the parametrized arrayEvents)
+// ---------------------------------------------------------------------------
+describe('HostEvent.SetVisibleVizs — array payload vizId injection', () => {
+    test('vizId is added as a non-indexed property on the array — array.length unchanged', async () => {
+        mockMessageChannel();
+        const { lb, iframe } = await renderLiveboard({ vizId });
+        const arrayPayload = ['viz1', 'viz2'];
+        await executeAfterWait(() => {
+            lb.trigger(HostEvent.SetVisibleVizs, arrayPayload as any);
+            const call = (iframe.contentWindow.postMessage as jest.Mock).mock.calls[0];
+            const sentData = call[0].data;
+            expect((sentData as any).vizId).toBe(vizId);
+            expect(sentData.length).toBe(2);
+        });
+    });
+
+    test('without viewConfig.vizId — array payload is sent as-is (no vizId property)', async () => {
+        mockMessageChannel();
+        const { lb, iframe } = await renderLiveboard(); // no vizId
+        const arrayPayload = ['viz1'];
+        await executeAfterWait(() => {
+            lb.trigger(HostEvent.SetVisibleVizs, arrayPayload as any);
+            const call = (iframe.contentWindow.postMessage as jest.Mock).mock.calls[0];
+            const sentData = call[0].data;
+            expect((sentData as any).vizId).toBeUndefined();
+        });
+    });
+
+    test('returns null and calls handleError when !isRendered', async () => {
+        const lb = unrenderedLiveboard();
+        const result = await lb.trigger(HostEvent.SetVisibleVizs, ['viz1'] as any);
+        expect(result).toBeNull();
+        expect((lb as any).handleError).toHaveBeenCalledWith(
+            expect.objectContaining({ code: EmbedErrorCodes.RENDER_NOT_CALLED }),
+        );
+    });
+});
+
+// ---------------------------------------------------------------------------
+// UpdateRuntimeFilters — AppEmbed path (no vizId injection)
+// ---------------------------------------------------------------------------
+describe('HostEvent.UpdateRuntimeFilters — AppEmbed path', () => {
+    async function renderApp() {
+        const app = new AppEmbed(getRootEl(), {
+            frameParams: { width: '100%', height: '100%' },
+        });
+        await app.render();
+        const iframe = getIFrameEl();
+        jest.spyOn(iframe.contentWindow, 'postMessage');
+        return { app, iframe };
+    }
+
+    test('AppEmbed sends payload directly without vizId injection', async () => {
+        mockMessageChannel();
+        const { app, iframe } = await renderApp();
+        const filters = [{ columnName: 'col', operator: 'EQ', values: ['v1'] }];
+        await executeAfterWait(() => {
+            app.trigger(HostEvent.UpdateRuntimeFilters, filters as any);
+            const call = (iframe.contentWindow.postMessage as jest.Mock).mock.calls[0];
+            const sentData = call[0].data;
+            // Array payload with no vizId property injected
+            expect((sentData as any).vizId).toBeUndefined();
+            expect(sentData).toEqual(filters);
+        });
+    });
+});
+
+// ---------------------------------------------------------------------------
+// Present — vizId injection on LiveboardEmbed
+// ---------------------------------------------------------------------------
+describe('HostEvent.Present — vizId injection on LiveboardEmbed', () => {
+    test('viewConfig.vizId is injected into the Present payload', async () => {
+        mockMessageChannel();
+        const { lb, iframe } = await renderLiveboard({ vizId });
+        await executeAfterWait(() => {
+            lb.trigger(HostEvent.Present, {} as any);
+            expect(iframe.contentWindow.postMessage).toHaveBeenCalledWith(
+                expect.objectContaining({
+                    data: expect.objectContaining({ vizId }),
+                }),
+                thoughtSpotHost,
+                expect.anything(),
+            );
+        });
+    });
+});
+
+// ---------------------------------------------------------------------------
+// DownloadAsCsv — additional cases
+// ---------------------------------------------------------------------------
+describe('HostEvent.DownloadAsCsv — additional cases', () => {
+    test('viewConfig.vizId overwrites an explicit payload vizId', async () => {
+        mockMessageChannel();
+        const { lb, iframe } = await renderLiveboard({ vizId });
+        await executeAfterWait(() => {
+            lb.trigger(HostEvent.DownloadAsCsv, { vizId: 'explicit-id' } as any);
+            const call = (iframe.contentWindow.postMessage as jest.Mock).mock.calls[0];
+            const sentData = call[0].data;
+            expect(sentData.vizId).toBe(vizId); // viewConfig.vizId wins
+        });
+    });
+
+    test('returns null and calls handleError when !isRendered', async () => {
+        const lb = unrenderedLiveboard();
+        const result = await lb.trigger(HostEvent.DownloadAsCsv, {} as any);
+        expect(result).toBeNull();
+        expect((lb as any).handleError).toHaveBeenCalledWith(
+            expect.objectContaining({ code: EmbedErrorCodes.RENDER_NOT_CALLED }),
+        );
+    });
+
+    test('returns null and logs debug when !iFrame', async () => {
+        const lb = new LiveboardEmbed(getRootEl(), {
+            frameParams: { width: '100%', height: '100%' },
+            liveboardId,
+        });
+        (lb as any).isRendered = true;
+        const result = await lb.trigger(HostEvent.DownloadAsCsv, {} as any);
+        expect(result).toBeNull();
+    });
+});
+
+// ---------------------------------------------------------------------------
+// Spotter share-conversation HostEvents 
+// ---------------------------------------------------------------------------
+describe('Spotter share-conversation HostEvents', () => {
+    const shareEvents: Array<[string, HostEvent, string, any]> = [
+        ['ShareSpotterConversation', HostEvent.ShareSpotterConversation, 'ShareSpotterConversation', { conversationId: 'abc' }],
+        ['CloseSpotterShareConversation', HostEvent.CloseSpotterShareConversation, 'CloseSpotterShareConversation', {}],
+        ['ExitSpotterSharedConversation', HostEvent.ExitSpotterSharedConversation, 'ExitSpotterSharedConversation', {}],
+    ];
+
+    test.each(shareEvents)(
+        '%s: postMessage type is the matching string value',
+        async (name, event, typeString, payload) => {
+            mockMessageChannel();
+            const { lb, iframe } = await renderLiveboard();
+            await executeAfterWait(() => {
+                lb.trigger(event, payload as any);
+                expect(iframe.contentWindow.postMessage).toHaveBeenCalledWith(
+                    expect.objectContaining({ type: typeString }),
+                    thoughtSpotHost,
+                    expect.anything(),
+                );
+            });
+        },
+    );
+
+    test.each(shareEvents)(
+        '%s: returns null and calls handleError when !isRendered',
+        async (name, event, typeString, payload) => {
+            const lb = unrenderedLiveboard();
+            const result = await lb.trigger(event, payload as any);
+            expect(result).toBeNull();
+            expect((lb as any).handleError).toHaveBeenCalledWith(
+                expect.objectContaining({ code: EmbedErrorCodes.RENDER_NOT_CALLED }),
+            );
+        },
+    );
+});

package/src/embed/hostEventClient/contracts.ts

@@ -7,6 +7,49 @@ export interface LiveboardTab {
   [key: string]: any;
 }
 
+export interface LiveboardGroup {
+  id: string;
+  name: string;
+  [key: string]: any;
+}
+
+/**
+ * Levels at which a filter or parameter can be applied.
+ */
+export enum ApplicabilityLevel {
+  Liveboard = 'LIVEBOARD',
+  Tab = 'TAB',
+  Group = 'GROUP',
+}
+
+/**
+ * Scopes a filter or parameter to a specific target.
+ * At `LIVEBOARD` level the filter applies to the whole Liveboard, so `targetId`
+ * is not required.
+ */
+export interface Applicability {
+  level: ApplicabilityLevel;
+  targetId?: string;
+}
+
+export interface FilterUpdate {
+  column: string;
+  oper: string;
+  values: string[];
+  type?: string;
+  applicability?: Applicability;
+}
+
+export interface LiveboardFilter {
+  applicability?: Applicability;
+  [key: string]: any;
+}
+
+export interface LiveboardParameter {
+  applicability?: Applicability;
+  [key: string]: any;
+}
+
 export enum UIPassthroughEvent {
   PinAnswerToLiveboard = 'addVizToPinboard',
   SaveAnswer = 'saveAnswer',
@@ -23,6 +66,7 @@ export enum UIPassthroughEvent {
   GetParameters = 'getParameters',
   GetTML = 'getTML',
   GetTabs = 'getTabs',
+  GetGroups = 'getGroups',
   GetExportRequestForCurrentPinboard = 'getExportRequestForCurrentPinboard',
 }
 
@@ -103,7 +147,7 @@ export type UIPassthroughContractBase = {
       vizId?: string;
     };
     response: {
-      liveboardFilters: Record<string, any>[];
+      liveboardFilters: LiveboardFilter[];
       runtimeFilters: RuntimeFilter[];
     };
   };
@@ -116,7 +160,7 @@ export type UIPassthroughContractBase = {
   [UIPassthroughEvent.GetParameters]: {
     request: Record<string, never>;
     response: {
-      parameters: Record<string, any>[];
+      parameters: LiveboardParameter[];
     };
   };
   [UIPassthroughEvent.GetTML]: {
@@ -134,6 +178,14 @@ export type UIPassthroughContractBase = {
       Tabs: LiveboardTab[];
     };
   };
+  [UIPassthroughEvent.GetGroups]: {
+    request: Record<string, never>;
+    response: {
+      orderedGroupIds: string[];
+      numberOfGroups: number;
+      Groups: LiveboardGroup[];
+    };
+  };
   [UIPassthroughEvent.GetExportRequestForCurrentPinboard]: {
     request: Record<string, never>;
     response: {
@@ -143,18 +195,8 @@ export type UIPassthroughContractBase = {
   };
   [UIPassthroughEvent.UpdateFilters]: {
     request: {
-      filter?: {
-        column: string;
-        oper: string;
-        values: string[];
-        type?: string;
-      };
-      filters?: {
-        column: string;
-        oper: string;
-        values: string[];
-        type?: string;
-      }[];
+      filter?: FilterUpdate;
+      filters?: FilterUpdate[];
     };
     response: unknown;
   };
@@ -198,6 +240,7 @@ export type EmbedApiHostEventMapping = {
   [HostEvent.GetParameters]: UIPassthroughEvent.GetParameters;
   [HostEvent.GetTML]: UIPassthroughEvent.GetTML;
   [HostEvent.GetTabs]: UIPassthroughEvent.GetTabs;
+  [HostEvent.GetGroups]: UIPassthroughEvent.GetGroups;
   [HostEvent.getExportRequestForCurrentPinboard]: UIPassthroughEvent.GetExportRequestForCurrentPinboard;
 }