@thoughtspot/visual-embed-sdk 1.35.5 → 1.35.7

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

@@ -96,6 +96,11 @@ const customisationsView = {
     },
 };
 
+const customVariablesForThirdPartyTools = {
+    key1: '!@#',
+    key2: '*%^',
+};
+
 describe('Unit test case for ts embed', () => {
     const mockMixPanelEvent = jest.spyOn(mixpanelInstance, 'uploadMixpanelEvent');
     beforeEach(() => {
@@ -148,11 +153,9 @@ describe('Unit test case for ts embed', () => {
             mockProcessTrigger.mockResolvedValue({ session: 'test' });
             await executeAfterWait(async () => {
                 const payload = { newVizName: 'test' };
-                expect(
-                    await searchEmbed.triggerUIPassThrough(
-                        UIPassthroughEvent.PinAnswerToLiveboard,
-                        payload,
-                    ),
+                await searchEmbed.triggerUIPassThrough(
+                    UIPassthroughEvent.PinAnswerToLiveboard,
+                    payload,
                 );
                 expect(mockProcessTrigger).toHaveBeenCalledWith(
                     getIFrameEl(),
@@ -166,6 +169,26 @@ describe('Unit test case for ts embed', () => {
             });
         });
 
+        test('Host event with empty param', async () => {
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                liveboardId: '123',
+                ...defaultViewConfig,
+            });
+            liveboardEmbed.render();
+            mockProcessTrigger.mockResolvedValue({ session: 'test' });
+            await executeAfterWait(async () => {
+                await liveboardEmbed.trigger(
+                    HostEvent.Save,
+                );
+                expect(mockProcessTrigger).toHaveBeenCalledWith(
+                    getIFrameEl(),
+                    HostEvent.Save,
+                    'http://tshost',
+                    {},
+                );
+            });
+        });
+
         test('should set proper height, width and min-height to iframe', async () => {
             // we dont have origin specific policies so just checking if
             // policies are ending with ;
@@ -227,6 +250,7 @@ describe('Unit test case for ts embed', () => {
                 thoughtSpotHost: 'tshost',
                 authType: AuthType.None,
                 customizations: customisations,
+                customVariablesForThirdPartyTools,
             });
         });
 
@@ -244,18 +268,21 @@ describe('Unit test case for ts embed', () => {
                 const iframe = getIFrameEl();
                 postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
             });
-            expect(mockPort.postMessage).toHaveBeenCalledWith({
-                type: EmbedEvent.APP_INIT,
-                data: {
-                    customisations,
-                    authToken: '',
-                    runtimeFilterParams: null,
-                    runtimeParameterParams: null,
-                    hiddenHomeLeftNavItems: [],
-                    hiddenHomepageModules: [],
-                    hostConfig: undefined,
-                    reorderedHomepageModules: [],
-                },
+            await executeAfterWait(() => {
+                expect(mockPort.postMessage).toHaveBeenCalledWith({
+                    type: EmbedEvent.APP_INIT,
+                    data: {
+                        customisations,
+                        authToken: '',
+                        runtimeFilterParams: null,
+                        runtimeParameterParams: null,
+                        hiddenHomeLeftNavItems: [],
+                        hiddenHomepageModules: [],
+                        hostConfig: undefined,
+                        reorderedHomepageModules: [],
+                        customVariablesForThirdPartyTools,
+                    },
+                });
             });
         });
 
@@ -276,18 +303,21 @@ describe('Unit test case for ts embed', () => {
                 const iframe = getIFrameEl();
                 postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
             });
-            expect(mockPort.postMessage).toHaveBeenCalledWith({
-                type: EmbedEvent.APP_INIT,
-                data: {
-                    customisations: customisationsView,
-                    authToken: '',
-                    runtimeFilterParams: null,
-                    runtimeParameterParams: null,
-                    hiddenHomeLeftNavItems: [],
-                    hiddenHomepageModules: [],
-                    hostConfig: undefined,
-                    reorderedHomepageModules: [],
-                },
+            await executeAfterWait(() => {
+                expect(mockPort.postMessage).toHaveBeenCalledWith({
+                    type: EmbedEvent.APP_INIT,
+                    data: {
+                        customisations: customisationsView,
+                        authToken: '',
+                        runtimeFilterParams: null,
+                        runtimeParameterParams: null,
+                        hiddenHomeLeftNavItems: [],
+                        hiddenHomepageModules: [],
+                        hostConfig: undefined,
+                        reorderedHomepageModules: [],
+                        customVariablesForThirdPartyTools,
+                    },
+                });
             });
         });
 
@@ -313,18 +343,58 @@ describe('Unit test case for ts embed', () => {
                 const iframe = getIFrameEl();
                 postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
             });
-            expect(mockPort.postMessage).toHaveBeenCalledWith({
+            await executeAfterWait(() => {
+                expect(mockPort.postMessage).toHaveBeenCalledWith({
+                    type: EmbedEvent.APP_INIT,
+                    data: {
+                        customisations,
+                        authToken: '',
+                        hostConfig: undefined,
+                        runtimeFilterParams: null,
+                        runtimeParameterParams: null,
+                        hiddenHomeLeftNavItems: [],
+                        hiddenHomepageModules: [HomepageModule.MyLibrary, HomepageModule.Learning],
+                        reorderedHomepageModules: [],
+                        customVariablesForThirdPartyTools,
+                    },
+                });
+            });
+        });
+
+        test('customVariablesForThirdPartyTools should be part of the app_init payload', async () => {
+            const mockEmbedEventPayload = {
                 type: EmbedEvent.APP_INIT,
-                data: {
-                    customisations,
-                    authToken: '',
-                    hostConfig: undefined,
-                    runtimeFilterParams: null,
-                    runtimeParameterParams: null,
-                    hiddenHomeLeftNavItems: [],
-                    hiddenHomepageModules: [HomepageModule.MyLibrary, HomepageModule.Learning],
-                    reorderedHomepageModules: [],
-                },
+                data: {},
+            };
+
+            const searchEmbed = new AppEmbed(getRootEl(), {
+                ...defaultViewConfig,
+            });
+            searchEmbed.render();
+
+            const mockPort: any = {
+                postMessage: jest.fn(),
+            };
+
+            await executeAfterWait(() => {
+                const iframe = getIFrameEl();
+                postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
+            });
+            await executeAfterWait(() => {
+                expect(mockPort.postMessage).toHaveBeenCalledWith({
+                    type: EmbedEvent.APP_INIT,
+                    data: {
+                        customisations,
+                        authToken: '',
+                        hostConfig: undefined,
+                        runtimeFilterParams: null,
+                        runtimeParameterParams: null,
+                        hiddenHomeLeftNavItems: [],
+                        hiddenHomepageModules: [],
+                        reorderedHomepageModules: [],
+                        customVariablesForThirdPartyTools,
+                    },
+                });
             });
         });
 
@@ -350,18 +420,22 @@ describe('Unit test case for ts embed', () => {
                 const iframe = getIFrameEl();
                 postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
             });
-            expect(mockPort.postMessage).toHaveBeenCalledWith({
-                type: EmbedEvent.APP_INIT,
-                data: {
-                    customisations,
-                    authToken: '',
-                    hostConfig: undefined,
-                    runtimeFilterParams: null,
-                    runtimeParameterParams: null,
-                    hiddenHomeLeftNavItems: [],
-                    hiddenHomepageModules: [],
-                    reorderedHomepageModules: [HomepageModule.MyLibrary, HomepageModule.Watchlist],
-                },
+            await executeAfterWait(() => {
+                expect(mockPort.postMessage).toHaveBeenCalledWith({
+                    type: EmbedEvent.APP_INIT,
+                    data: {
+                        customisations,
+                        authToken: '',
+                        hostConfig: undefined,
+                        runtimeFilterParams: null,
+                        runtimeParameterParams: null,
+                        hiddenHomeLeftNavItems: [],
+                        hiddenHomepageModules: [],
+                        reorderedHomepageModules:
+                            [HomepageModule.MyLibrary, HomepageModule.Watchlist],
+                        customVariablesForThirdPartyTools,
+                    },
+                });
             });
         });
 
@@ -390,18 +464,21 @@ describe('Unit test case for ts embed', () => {
                 const iframe = getIFrameEl();
                 postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
             });
-            expect(mockPort.postMessage).toHaveBeenCalledWith({
-                type: EmbedEvent.APP_INIT,
-                data: {
-                    customisations,
-                    authToken: '',
-                    runtimeFilterParams: null,
-                    runtimeParameterParams: 'param1=color&paramVal1=blue',
-                    hiddenHomeLeftNavItems: [],
-                    hiddenHomepageModules: [],
-                    hostConfig: undefined,
-                    reorderedHomepageModules: [],
-                },
+            await executeAfterWait(() => {
+                expect(mockPort.postMessage).toHaveBeenCalledWith({
+                    type: EmbedEvent.APP_INIT,
+                    data: {
+                        customisations,
+                        authToken: '',
+                        runtimeFilterParams: null,
+                        runtimeParameterParams: 'param1=color&paramVal1=blue',
+                        hiddenHomeLeftNavItems: [],
+                        hiddenHomepageModules: [],
+                        hostConfig: undefined,
+                        reorderedHomepageModules: [],
+                        customVariablesForThirdPartyTools,
+                    },
+                });
             });
         });
 
@@ -431,18 +508,21 @@ describe('Unit test case for ts embed', () => {
                 const iframe = getIFrameEl();
                 postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
             });
-            expect(mockPort.postMessage).toHaveBeenCalledWith({
-                type: EmbedEvent.APP_INIT,
-                data: {
-                    customisations,
-                    authToken: '',
-                    runtimeFilterParams: 'col1=color&op1=EQ&val1=blue',
-                    runtimeParameterParams: null,
-                    hiddenHomeLeftNavItems: [],
-                    hiddenHomepageModules: [],
-                    hostConfig: undefined,
-                    reorderedHomepageModules: [],
-                },
+            await executeAfterWait(() => {
+                expect(mockPort.postMessage).toHaveBeenCalledWith({
+                    type: EmbedEvent.APP_INIT,
+                    data: {
+                        customisations,
+                        authToken: '',
+                        runtimeFilterParams: 'col1=color&op1=EQ&val1=blue',
+                        runtimeParameterParams: null,
+                        hiddenHomeLeftNavItems: [],
+                        hiddenHomepageModules: [],
+                        hostConfig: undefined,
+                        reorderedHomepageModules: [],
+                        customVariablesForThirdPartyTools,
+                    },
+                });
             });
         });
 
@@ -471,18 +551,21 @@ describe('Unit test case for ts embed', () => {
                 const iframe = getIFrameEl();
                 postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
             });
-            expect(mockPort.postMessage).toHaveBeenCalledWith({
-                type: EmbedEvent.APP_INIT,
-                data: {
-                    customisations,
-                    authToken: '',
-                    runtimeFilterParams: null,
-                    runtimeParameterParams: null,
-                    hiddenHomeLeftNavItems: [],
-                    hiddenHomepageModules: [],
-                    hostConfig: undefined,
-                    reorderedHomepageModules: [],
-                },
+            await executeAfterWait(() => {
+                expect(mockPort.postMessage).toHaveBeenCalledWith({
+                    type: EmbedEvent.APP_INIT,
+                    data: {
+                        customisations,
+                        authToken: '',
+                        runtimeFilterParams: null,
+                        runtimeParameterParams: null,
+                        hiddenHomeLeftNavItems: [],
+                        hiddenHomepageModules: [],
+                        hostConfig: undefined,
+                        reorderedHomepageModules: [],
+                        customVariablesForThirdPartyTools,
+                    },
+                });
             });
         });
 
@@ -512,18 +595,21 @@ describe('Unit test case for ts embed', () => {
                 const iframe = getIFrameEl();
                 postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
             });
-            expect(mockPort.postMessage).toHaveBeenCalledWith({
-                type: EmbedEvent.APP_INIT,
-                data: {
-                    customisations,
-                    authToken: '',
-                    runtimeFilterParams: null,
-                    runtimeParameterParams: null,
-                    hiddenHomeLeftNavItems: [],
-                    hiddenHomepageModules: [],
-                    hostConfig: undefined,
-                    reorderedHomepageModules: [],
-                },
+            await executeAfterWait(() => {
+                expect(mockPort.postMessage).toHaveBeenCalledWith({
+                    type: EmbedEvent.APP_INIT,
+                    data: {
+                        customisations,
+                        authToken: '',
+                        runtimeFilterParams: null,
+                        runtimeParameterParams: null,
+                        hiddenHomeLeftNavItems: [],
+                        hiddenHomepageModules: [],
+                        hostConfig: undefined,
+                        reorderedHomepageModules: [],
+                        customVariablesForThirdPartyTools,
+                    },
+                });
             });
         });
 
@@ -549,19 +635,23 @@ describe('Unit test case for ts embed', () => {
                 const iframe = getIFrameEl();
                 postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
             });
-            expect(mockPort.postMessage).toHaveBeenCalledWith({
-                type: EmbedEvent.APP_INIT,
-                data: {
-                    customisations,
-                    authToken: '',
-                    hostConfig: undefined,
-                    runtimeFilterParams: null,
-                    runtimeParameterParams: null,
-                    hiddenHomeLeftNavItems:
-                        [HomeLeftNavItem.Home, HomeLeftNavItem.MonitorSubscription],
-                    hiddenHomepageModules: [],
-                    reorderedHomepageModules: [],
-                },
+
+            await executeAfterWait(() => {
+                expect(mockPort.postMessage).toHaveBeenCalledWith({
+                    type: EmbedEvent.APP_INIT,
+                    data: {
+                        customisations,
+                        authToken: '',
+                        hostConfig: undefined,
+                        runtimeFilterParams: null,
+                        runtimeParameterParams: null,
+                        hiddenHomeLeftNavItems:
+                      [HomeLeftNavItem.Home, HomeLeftNavItem.MonitorSubscription],
+                        hiddenHomepageModules: [],
+                        reorderedHomepageModules: [],
+                        customVariablesForThirdPartyTools,
+                    },
+                });
             });
         });
 
@@ -727,6 +817,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomepageModules: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
+                        customVariablesForThirdPartyTools: {},
                     },
                 });
             });
@@ -744,6 +835,7 @@ describe('Unit test case for ts embed', () => {
                 authType: AuthType.TrustedAuthTokenCookieless,
                 getAuthToken: () => Promise.reject(),
             });
+            jest.spyOn(logger, 'error').mockResolvedValue(true);
         });
 
         afterEach(() => {

package/src/embed/ts-embed.ts

@@ -60,6 +60,7 @@ import {
     FrameParams,
     ContextMenuTriggerOptions,
     RuntimeFilter,
+    DefaultAppInitData,
 } from '../types';
 import { uploadMixpanelEvent, MIXPANEL_EVENT } from '../mixpanel-service';
 import { processEventData, processAuthFailure } from '../utils/processData';
@@ -319,41 +320,62 @@ export class TsEmbed {
         });
     }
 
+    protected async getAuthTokenForCookielessInit() {
+        let authToken = '';
+        if (this.embedConfig.authType !== AuthType.TrustedAuthTokenCookieless) return authToken;
+
+        try {
+            authToken = await getAuthenticationToken(this.embedConfig);
+        } catch (e) {
+            processAuthFailure(e, this.isPreRendered ? this.preRenderWrapper : this.el);
+            throw e;
+        }
+
+        return authToken;
+    }
+
+    protected async getDefaultAppInitData(): Promise<DefaultAppInitData> {
+        const authToken = await this.getAuthTokenForCookielessInit();
+        return {
+            customisations: getCustomisations(this.embedConfig, this.viewConfig),
+            authToken,
+            runtimeFilterParams: this.viewConfig.excludeRuntimeFiltersfromURL
+                ? getRuntimeFilters(this.viewConfig.runtimeFilters)
+                : null,
+            runtimeParameterParams: this.viewConfig.excludeRuntimeParametersfromURL
+                ? getRuntimeParameters(this.viewConfig.runtimeParameters || [])
+                : null,
+            hiddenHomepageModules: this.viewConfig.hiddenHomepageModules || [],
+            reorderedHomepageModules: this.viewConfig.reorderedHomepageModules || [],
+            hostConfig: this.embedConfig.hostConfig,
+            hiddenHomeLeftNavItems: this.viewConfig?.hiddenHomeLeftNavItems
+                ? this.viewConfig?.hiddenHomeLeftNavItems
+                : [],
+            customVariablesForThirdPartyTools:
+            this.embedConfig.customVariablesForThirdPartyTools || {},
+        };
+    }
+
+    protected async getAppInitData() {
+        return this.getDefaultAppInitData();
+    }
+
     /**
      * Send Custom style as part of payload of APP_INIT
      * @param _
      * @param responder
      */
     private appInitCb = async (_: any, responder: any) => {
-        let authToken = '';
-        if (this.embedConfig.authType === AuthType.TrustedAuthTokenCookieless) {
-            try {
-                authToken = await getAuthenticationToken(this.embedConfig);
-            } catch (e) {
-                processAuthFailure(e, this.isPreRendered ? this.preRenderWrapper : this.el);
-                return;
-            }
+        try {
+            const appInitData = await this.getAppInitData();
+            this.isAppInitialized = true;
+            responder({
+                type: EmbedEvent.APP_INIT,
+                data: appInitData,
+            });
+        } catch (e) {
+            logger.error(`AppInit failed, Error : ${e?.message}`);
         }
-        this.isAppInitialized = true;
-        responder({
-            type: EmbedEvent.APP_INIT,
-            data: {
-                customisations: getCustomisations(this.embedConfig, this.viewConfig),
-                authToken,
-                runtimeFilterParams: this.viewConfig.excludeRuntimeFiltersfromURL
-                    ? getRuntimeFilters(this.viewConfig.runtimeFilters)
-                    : null,
-                runtimeParameterParams: this.viewConfig.excludeRuntimeParametersfromURL
-                    ? getRuntimeParameters(this.viewConfig.runtimeParameters || [])
-                    : null,
-                hiddenHomepageModules: this.viewConfig.hiddenHomepageModules || [],
-                reorderedHomepageModules: this.viewConfig.reorderedHomepageModules || [],
-                hostConfig: this.embedConfig.hostConfig,
-                hiddenHomeLeftNavItems: this.viewConfig?.hiddenHomeLeftNavItems
-                    ? this.viewConfig?.hiddenHomeLeftNavItems
-                    : [],
-            },
-        });
     };
 
     /**
@@ -1024,8 +1046,8 @@ export class TsEmbed {
             this.handleError('Host event type is undefined');
             return null;
         }
-
-        return this.hostEventClient.triggerHostEvent(messageType, data);
+        // send an empty object, this is needed for liveboard default handlers
+        return this.hostEventClient.triggerHostEvent(messageType, data || {});
     }
 
     /**

package/src/types.ts

@@ -608,6 +608,22 @@ export interface EmbedConfig {
      * @version SDK: 1.33.5 | ThoughtSpot: *
      */
     additionalFlags?: { [key: string]: string | number | boolean };
+    /**
+     * This is an object (key/val) for customVariables being
+     * used by the third party tool's script.
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   ... // other liveboard view config
+     *   customVariablesForThirdPartyTools: {
+     *        key1: 'value1',
+     *        key2: 'value2'
+     *     }
+     * });
+     * ```
+     *  @version SDK 1.37.0 | Thoughtspot: 10.7.0.cl
+     */
+    customVariablesForThirdPartyTools?: Record< string, any >;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
@@ -4608,3 +4624,15 @@ export enum LogLevel {
      */
     TRACE = 'TRACE',
 }
+
+export interface DefaultAppInitData {
+    customisations: CustomisationsInterface;
+    authToken: string;
+    runtimeFilterParams: string | null;
+    runtimeParameterParams: string | null;
+    hiddenHomepageModules: HomepageModule[];
+    reorderedHomepageModules: string[];
+    hostConfig: Record<string, any>;
+    hiddenHomeLeftNavItems: string[];
+    customVariablesForThirdPartyTools: Record<string, any>;
+}