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

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

@@ -149,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
 // ---------------------------------------------------------------------------
@@ -1757,3 +1836,42 @@ describe('HostEvent.DownloadAsCsv — additional cases', () => {
         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,12 @@ 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.
  */
@@ -60,6 +66,7 @@ export enum UIPassthroughEvent {
   GetParameters = 'getParameters',
   GetTML = 'getTML',
   GetTabs = 'getTabs',
+  GetGroups = 'getGroups',
   GetExportRequestForCurrentPinboard = 'getExportRequestForCurrentPinboard',
 }
 
@@ -171,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: {
@@ -225,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;
 }
 

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

@@ -375,6 +375,18 @@ describe('HostEventClient', () => {
             );
         });
 
+        it('should route GetGroups through passthrough and return data', async () => {
+            const { client } = createHostEventClient();
+            const mockResponse = [{ value: { orderedGroupIds: ['g1', 'g2'], numberOfGroups: 2, Groups: [] as any[] } }];
+            mockProcessTrigger
+                .mockResolvedValueOnce(mockGetAvailablePassthroughs())
+                .mockResolvedValueOnce(mockResponse);
+
+            const result = await client.triggerHostEvent(HostEvent.GetGroups, {});
+
+            expect(result).toEqual({ orderedGroupIds: ['g1', 'g2'], numberOfGroups: 2, Groups: [] });
+        });
+
         it('should throw when DrillDown payload has no valid points', async () => {
             const { client } = createHostEventClient();
             const invalidPayload = {} as any;
@@ -1142,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

@@ -38,6 +38,7 @@ const PASSTHROUGH_MAP: Partial<Record<HostEvent, UIPassthroughEvent>> = {
     [HostEvent.GetParameters]: UIPassthroughEvent.GetParameters,
     [HostEvent.GetTML]: UIPassthroughEvent.GetTML,
     [HostEvent.GetTabs]: UIPassthroughEvent.GetTabs,
+    [HostEvent.GetGroups]: UIPassthroughEvent.GetGroups,
     [HostEvent.getExportRequestForCurrentPinboard]: UIPassthroughEvent.GetExportRequestForCurrentPinboard,
 };
 
@@ -280,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>,