@thoughtspot/visual-embed-sdk 1.17.0-alpha.0 → 1.17.0-alpha.2

package/lib/src/visual-embed-sdk.d.ts

@@ -200,7 +200,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/base' {
         * Renders functions in a queue, resolves to next function only after the callback next is called
         * @param fn The function being registered
         */
-    export const renderInQueue: (fn: (next?: (val?: any) => void) => void) => void;
+    export const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
     export function reset(): void;
 }
 
@@ -526,23 +526,52 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * No authentication on the SDK. Passthrough to the embedded App. Alias for `Passthrough`.
                 */
             None = "None",
+            /**
+                * Passthrough SSO to the embedded App within the iframe. Requires least configuration, but may not
+                * be supported by all IDPs. This will behave like `None` if SSO is not configured on ThoughtSpot.
+                * @version: SDK: 1.15.0 | ThouhgtSpot: 8.8.0.cl
+                */
+            EmbeddedSSO = "EmbeddedSSO",
             /**
                 * SSO using SAML
-                * @deprecated Use {@link SAML} instead
+                * @deprecated Use {@link SAMLRedirect} instead
+                * @hidden
                 */
             SSO = "SSO_SAML",
             /**
                 * SSO using SAML
+                * @deprecated Use {@link SAMLRedirect} instead
+                * @hidden
                 */
             SAML = "SSO_SAML",
+            /**
+                * SSO using SAML
+                * Will make the host application redirect to the SAML Idp.
+                */
+            SAMLRedirect = "SSO_SAML",
             /**
                 * SSO using OIDC
+                * @hidden
+                * @deprecated Use {@link OIDCRedirect} instead
                 */
             OIDC = "SSO_OIDC",
+            /**
+                * SSO using OIDC
+                * Will make the host application redirect to the OIDC Idp.
+                */
+            OIDCRedirect = "SSO_OIDC",
             /**
                 * Trusted authentication server
+                * @hidden
+                * @deprecated Use {@link TrustedAuth} instead
                 */
             AuthServer = "AuthServer",
+            /**
+                * Trusted authentication server, Use you own authentication server
+                * which returns a bearer token, generated using the secret_key obtained from
+                * ThoughtSpot.
+                */
+            TrustedAuthToken = "AuthServer",
             /**
                 * Use the ThoughtSpot login API to authenticate to the cluster directly.
                 *
@@ -709,6 +738,20 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl
                 */
             customisations?: CustomisationsInterface;
+            /**
+                * For noRedirect SSO Auth, we need a button which the user
+                * click to trigger the flow. This is the containing element
+                * for that button.
+                *
+                * @version SDK: 1.17.0 | ThoughtSpot: *
+                */
+            authTriggerContainer?: string | HTMLElement;
+            /**
+                * Text to show in the button which triggers the popup auth flow.
+                * Default: "Authorize".
+                * @version SDK: 1.17.0 | ThoughtSpot: *
+                */
+            authTriggerText?: string;
     }
     /**
         * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -1135,16 +1178,25 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
     export enum HostEvent {
             /**
                 * Trigger a search
-                * @param dataSourceIds - The list of data source GUIDs
-                * @param searchQuery - The search query
+                * @param - dataSourceIds - The list of data source GUIDs
+                * @param - searchQuery - The search query
+                * @example
+                * searchEmbed.trigger(HostEvent.Search, {
+                * searchQuery: "[sales] by [item type],
+                * "dataSourceIds: ["cd252e5c-b552-49a8-821d-3eadaa049cca"]
+                * })
                 */
             Search = "search",
             /**
                 * Trigger a drill on certain points by certain column
-                * @param points - an object containing selectedPoints/clickedPoints
+                * @param - points - an object containing selectedPoints/clickedPoints
                 *              eg. { selectedPoints: []}
-                * @param columnGuid - a string guid of the column to drill by. This is optional,
+                * @param - columnGuid - a string guid of the column to drill by. This is optional,
                 *                     if not provided it will auto drill by the configured column.
+                * @example searchEmbed.trigger(HostEvent.DrillDown, {
+                * points: clickedPointData,
+                * autoDrillDown: true,
+                * })
                 * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
                 */
             DrillDown = "triggerDrillDown",
@@ -1162,6 +1214,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * Set the visible visualizations on a Liveboard.
                 * @param - an array of ids of visualizations to show, the ids not passed
                 *          will be hidden.
+                * @example
+                * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, ['730496d6-6903-4601-937e-2c691821af3c', 'd547ec54-2a37-4516-a222-2b06719af726'])
                 * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
                 */
             SetVisibleVizs = "SetPinboardVisibleVizs",
@@ -1169,18 +1223,25 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * Update the runtime filters. The runtime filters passed here are extended
                 * on to the existing runtime filters if they exist.
                 * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
+                * @example
+                * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
+                * {columnName: "state",operator: "EQ",values: ["michigan"]},
+                * {columnName: "item type",operator: "EQ",values: ["Jackets"]}
+                * ])
                 * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
                 */
             UpdateRuntimeFilters = "UpdateRuntimeFilters",
             /**
                 * Navigate to a specific page in App embed without any reload.
                 * This is the same as calling `appEmbed.navigateToPage(path, true)`
-                * @param path - the path to navigate to (can be a number[1/-1] to go forward/back)
+                * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
+                * @example appEmbed.navigateToPage(-1)
                 * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
                 */
             Navigate = "Navigate",
             /**
                 * Gets the current pinboard content.
+                * @example liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
                 * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
                 */
             getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
@@ -1188,70 +1249,82 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * Triggers the Pin action on an embedded object
                 * @param - incase of Liveboard embed, takes in an object with vizId as a key
                 * can be left empty for search and visualization embeds
+                * @example liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             Pin = "pin",
             /**
                 * Triggers the Show Liveboard details action on a Liveboard
+                * @example liveboardEmbed.trigger(HostEvent.LiveboardInfo)
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             LiveboardInfo = "pinboardInfo",
             /**
                 * Triggers the Schedule action on a Liveboard
+                * @example liveboardEmbed.trigger(HostEvent.Schedule)
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             Schedule = "subscription",
             /**
                 * Triggers the Manage schedule action on a Liveboard
+                * @example liveboardEmbed.trigger(HostEvent.ScheduleList)
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             SchedulesList = "schedule-list",
             /**
                 * Triggers the Export TML action on a Liveboard
+                * @example liveboardEmbed.trigger(HostEvent.ExportTML)
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             ExportTML = "exportTSL",
             /**
                 * Triggers the Edit TML action on a Liveboard
+                * @example liveboardEmbed.trigger(HostEvent.EditTML)
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             EditTML = "editTSL",
             /**
                 * Triggers the Update TML action on a Liveboard
+                * @example liveboardEmbed.trigger(HostEvent.UpdateTML)
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             UpdateTML = "updateTSL",
             /**
                 * Triggers the Download PDF action on a Liveboard
+                * @example liveboardEmbed.trigger(HostEvent.DownloadAsPDF)
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             DownloadAsPdf = "downloadAsPdf",
             /**
                 * Triggers the Make a copy action on a Liveboard
+                * @example liveboardEmbed.trigger(HostEvent.MakeACopy)
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             MakeACopy = "makeACopy",
             /**
                 * Triggers the Delete action on a Liveboard
+                * @example appEmbed.trigger(HostEvent.Remove)
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             Remove = "delete",
             /**
                 * Triggers the Explore action on a visualization
                 * @param - an object with vizId as a key
-                * eg: {vizId: '730496d6-6903-4601-937e-2c691821af3c'}
+                * @example liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             Explore = "explore",
             /**
                 * Triggers the Create alert action on a visualization
                 * @param - an object with vizId as a key
+                * @example liveboardEmbed.trigger(HostEvent.CreateMonitor {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             CreateMonitor = "createMonitor",
             /**
                 * Triggers the Manage alert action on a visualization
                 * @param - an object with vizId as a key
+                * @example liveboardEmbed.trigger(HostEvent.ManageMonitor, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             ManageMonitor = "manageMonitor",
@@ -1287,9 +1360,26 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             Present = "present",
             /**
                 * Get TML for the current search.
+                * @example searchEmbed.trigger(HostEvent.GetTML)
                 * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl
                 */
-            GetTML = "getTML"
+            GetTML = "getTML",
+            /**
+                * Triggers the Share action on a liveboard or answer
+                * @example
+                * liveboardEmbed.trigger(HostEvent.Share)
+                * searchEmbed.trigger(HostEvent.Share)
+                * @version SDK: 1.18.0 | Thoughtspot: 9.0.0.cl
+                */
+            Share = "share",
+            /**
+                * Trigger the Save action on a liveboard or answer
+                * @example
+                * liveboardEmbed.trigger(HostEvent.Save)
+                * searchEmbed.trigger(HostEvent.Save)
+                * @version SDK: 1.18.0 | Thoughtspot: 9.0.0.cl
+                */
+            Save = "save"
     }
     /**
         * The different visual modes that the data sources panel within
@@ -1345,7 +1435,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             LiveboardV2Enabled = "isPinboardV2Enabled",
             ShowAlerts = "showAlerts",
             Locale = "locale",
-            CustomStyle = "customStyle"
+            CustomStyle = "customStyle",
+            ForceSAMLAutoRedirect = "forceSAMLAutoRedirect",
+            AuthType = "authType"
     }
     /**
         * The list of actions that can be performed on visual ThoughtSpot
@@ -1489,7 +1581,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
-            ReportError = "reportError"
+            ReportError = "reportError",
+            SyncToSheets = "sync-to-sheets",
+            SyncToOtherApps = "sync-to-other-apps",
+            ManagePipelines = "manage-pipeline"
     }
     export interface SessionInterface {
             sessionId: string;
@@ -1664,7 +1759,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
                 * @param url
                 * @param frameOptions
                 */
-            protected renderIFrame(url: string, frameOptions?: FrameParams): void;
+            protected renderIFrame(url: string, frameOptions?: FrameParams): Promise<any>;
             /**
                 * Sets the height of the iframe
                 * @param height The height in pixels
@@ -1745,7 +1840,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
                 * Render the app in an iframe and set up event handlers
                 * @param iframeSrc
                 */
-            protected renderV1Embed(iframeSrc: string): void;
+            protected renderV1Embed(iframeSrc: string): any;
             on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions): typeof TsEmbed.prototype;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.17.0-alpha.0",
+    "version": "1.17.0-alpha.2",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",
@@ -29,7 +29,7 @@
         "watch": "rollup -cw",
         "docs-cmd": "node scripts/gatsby-commands.js",
         "docgen": "typedoc --tsconfig tsconfig.json --theme typedoc-theme",
-        "test-sdk": "jest -c jest.config.sdk.js",
+        "test-sdk": "jest -c jest.config.sdk.js --runInBand",
         "test-docs": "jest -c jest.config.docs.js",
         "test": "npm run test-sdk && npm run test-docs",
         "posttest": "cat ./coverage/sdk/lcov.info | coveralls",

package/src/auth.spec.ts

@@ -1,7 +1,7 @@
 import * as authInstance from './auth';
 import * as authService from './utils/authService';
 import * as checkReleaseVersionInBetaInstance from './utils';
-import { AuthType, EmbedConfig } from './types';
+import { AuthType, EmbedConfig, EmbedEvent } from './types';
 import { executeAfterWait } from './test/test-utils';
 
 const thoughtSpotHost = 'http://localhost:3000';
@@ -43,6 +43,12 @@ export const embedConfig: any = {
     doSamlAuth: {
         thoughtSpotHost,
     },
+    doSamlAuthNoRedirect: {
+        thoughtSpotHost,
+        noRedirect: true,
+        authTriggerContainer: document.body,
+        authTriggerText: 'auth',
+    },
     doOidcAuth: {
         thoughtSpotHost,
     },
@@ -393,10 +399,12 @@ describe('Unit test for auth', () => {
             expect(await authInstance.samlCompletionPromise).not.toBe(null);
             expect(
                 await authInstance.doSamlAuth({
-                    ...embedConfig.doSamlAuth,
-                    noRedirect: true,
+                    ...embedConfig.doSamlAuthNoRedirect,
                 }),
             ).toBe(true);
+            document.getElementById('ts-auth-btn').click();
+            window.postMessage({ type: EmbedEvent.SAMLComplete }, '*');
+            await authInstance.samlCompletionPromise;
             expect(authService.fetchSessionInfoService).toBeCalled();
         });
     });

package/src/auth.ts

@@ -1,6 +1,6 @@
 import { initMixpanel } from './mixpanel-service';
-import { AuthType, EmbedConfig, EmbedEvent } from './types';
-import { getRedirectUrl } from './utils';
+import { AuthType, DOMSelector, EmbedConfig, EmbedEvent, Param } from './types';
+import { getDOMNode, getRedirectUrl } from './utils';
 // eslint-disable-next-line import/no-cycle
 import {
     fetchSessionInfoService,
@@ -208,12 +208,16 @@ export const doBasicAuth = async (
     return loggedInStatus;
 };
 
-async function samlPopupFlow(ssoURL: string) {
-    document.body.insertAdjacentHTML(
-        'beforeend',
-        '<div id="ts-saml-auth"></div>',
-    );
-    const authElem = document.getElementById('ts-saml-auth');
+async function samlPopupFlow(
+    ssoURL: string,
+    triggerContainer: DOMSelector,
+    triggerText: string,
+) {
+    const containerEl = getDOMNode(triggerContainer);
+    containerEl.innerHTML =
+        '<button id="ts-auth-btn" class="ts-auth-btn" style="margin: auto;"></button>';
+    const authElem = document.getElementById('ts-auth-btn');
+    authElem.textContent = triggerText;
     samlCompletionPromise =
         samlCompletionPromise ||
         new Promise<void>((resolve, reject) => {
@@ -239,7 +243,6 @@ async function samlPopupFlow(ssoURL: string) {
         },
         { once: true },
     );
-    authElem.click();
     return samlCompletionPromise;
 }
 
@@ -271,7 +274,11 @@ const doSSOAuth = async (
 
     const ssoURL = `${thoughtSpotHost}${ssoEndPoint}`;
     if (embedConfig.noRedirect) {
-        await samlPopupFlow(ssoURL);
+        await samlPopupFlow(
+            ssoURL,
+            embedConfig.authTriggerContainer,
+            embedConfig.authTriggerText,
+        );
         loggedInStatus = true;
         return;
     }
@@ -338,11 +345,14 @@ export const authenticate = async (
     const { authType } = embedConfig;
     switch (authType) {
         case AuthType.SSO:
+        case AuthType.SAMLRedirect:
         case AuthType.SAML:
             return doSamlAuth(embedConfig);
         case AuthType.OIDC:
+        case AuthType.OIDCRedirect:
             return doOIDCAuth(embedConfig);
         case AuthType.AuthServer:
+        case AuthType.TrustedAuthToken:
             return doTokenAuth(embedConfig);
         case AuthType.Basic:
             return doBasicAuth(embedConfig);

package/src/embed/app.spec.ts

@@ -8,6 +8,9 @@ import {
     getRootEl,
     getIFrameEl,
     mockMessageChannel,
+    defaultParams,
+    defaultParamsForPinboardEmbed,
+    defaultParamsWithoutHiddenActions,
 } from '../test/test-utils';
 import { version } from '../../package.json';
 import * as config from '../config';
@@ -19,9 +22,6 @@ const defaultViewConfig = {
     },
 };
 const thoughtSpotHost = 'tshost';
-const defaultParamsWithoutHiddenActions = `&hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}`;
-const defaultParams = `${defaultParamsWithoutHiddenActions}&hideAction=[%22${Action.ReportError}%22]`;
-const defaultParamsForPinboardEmbed = `hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}&hideAction=[%22${Action.ReportError}%22]`;
 const defaultParamsPost = '';
 
 beforeAll(() => {
@@ -156,7 +156,7 @@ describe('App embed tests', () => {
         appEmbed.render();
         await executeAfterWait(() => {
             expect(getIFrameSrc()).toBe(
-                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=false&profileAndHelpInNavBarHidden=false${defaultParamsWithoutHiddenActions}&disableAction=[%22save%22,%22update%22]&disableHint=Access%20denied&hideAction=[%22${Action.ReportError}%22,%22download%22]${defaultParamsPost}#/home`,
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=false&profileAndHelpInNavBarHidden=false&${defaultParamsWithoutHiddenActions}&disableAction=[%22save%22,%22update%22]&disableHint=Access%20denied&hideAction=[%22${Action.ReportError}%22,%22download%22]${defaultParamsPost}#/home`,
             );
         });
     });

package/src/embed/base.spec.ts

@@ -1,4 +1,5 @@
 import EventEmitter from 'eventemitter3';
+import { EmbedConfig } from '../index';
 import * as auth from '../auth';
 import * as index from '../index';
 import * as base from './base';
@@ -176,6 +177,43 @@ describe('Base TS Embed', () => {
         );
         expect(base.getEmbedConfig().autoLogin).toBe(false);
     });
+
+    test('config sanity, no ts host', () => {
+        expect(() => {
+            index.init({
+                authType: index.AuthType.None,
+            } as EmbedConfig);
+        }).toThrowError();
+    });
+
+    test('config sanity, no username in trusted auth', () => {
+        expect(() => {
+            index.init({
+                authType: index.AuthType.TrustedAuthToken,
+                thoughtSpotHost,
+            } as EmbedConfig);
+        }).toThrowError();
+    });
+
+    test('config sanity, no authEndpoint and getAuthToken', () => {
+        expect(() => {
+            index.init({
+                authType: index.AuthType.TrustedAuthToken,
+                thoughtSpotHost,
+                username: 'test',
+            });
+        }).toThrowError();
+    });
+
+    test('config sanity, pass triggerContainer with noRedirect', () => {
+        expect(() => {
+            index.init({
+                thoughtSpotHost,
+                authType: index.AuthType.SAMLRedirect,
+                noRedirect: true,
+            });
+        }).toThrowError();
+    });
 });
 
 describe('Base without init', () => {

package/src/embed/base.ts

@@ -8,7 +8,7 @@
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
 import EventEmitter from 'eventemitter3';
-import _ from 'lodash';
+import uniq from 'lodash/uniq';
 import { getThoughtSpotHost } from '../config';
 import { AuthType, EmbedConfig, PrefetchFeatures } from '../types';
 import {
@@ -22,6 +22,7 @@ import { uploadMixpanelEvent, MIXPANEL_EVENT } from '../mixpanel-service';
 let config = {} as EmbedConfig;
 const CONFIG_DEFAULTS: Partial<EmbedConfig> = {
     loginFailedMessage: 'Not logged in',
+    authTriggerText: 'Authorize',
     authType: AuthType.None,
 };
 
@@ -108,7 +109,7 @@ export const prefetch = (
         const features = prefetchFeatures || [PrefetchFeatures.FullApp];
         let hostUrl = url || config.thoughtSpotHost;
         hostUrl = hostUrl[hostUrl.length - 1] === '/' ? hostUrl : `${hostUrl}/`;
-        _.uniq(
+        uniq(
             features.map((feature) => hostUrlToFeatureUrl[feature](hostUrl)),
         ).forEach((prefetchUrl, index) => {
             const iFrame = document.createElement('iframe');
@@ -123,6 +124,29 @@ export const prefetch = (
     }
 };
 
+function sanity(embedConfig: EmbedConfig) {
+    if (embedConfig.thoughtSpotHost === undefined) {
+        throw new Error('ThoughtSpot host not provided');
+    }
+    if (embedConfig.authType === AuthType.TrustedAuthToken) {
+        if (!embedConfig.username) {
+            throw new Error('Username not provided with Trusted auth');
+        }
+
+        if (
+            !embedConfig.authEndpoint ||
+            typeof embedConfig.getAuthToken !== 'function'
+        ) {
+            throw new Error(
+                'Trusted auth should provide either authEndpoint or getAuthToken',
+            );
+        }
+    }
+    if (embedConfig.noRedirect && !embedConfig.authTriggerContainer) {
+        throw new Error('authTriggerContainer not provided with noRedirect');
+    }
+}
+
 /**
  * Initializes the Visual Embed SDK globally and perform
  * authentication if applicable.
@@ -134,6 +158,7 @@ export const prefetch = (
  * @version SDK: 1.0.0 | ThoughtSpot ts7.april.cl, 7.2.1
  */
 export const init = (embedConfig: EmbedConfig): EventEmitter => {
+    sanity(embedConfig);
     config = {
         ...CONFIG_DEFAULTS,
         ...embedConfig,
@@ -191,14 +216,16 @@ let renderQueue: Promise<any> = Promise.resolve();
  * Renders functions in a queue, resolves to next function only after the callback next is called
  * @param fn The function being registered
  */
-export const renderInQueue = (fn: (next?: (val?: any) => void) => void) => {
+export const renderInQueue = (
+    fn: (next?: (val?: any) => void) => Promise<any>,
+): Promise<any> => {
     const { queueMultiRenders = false } = config;
     if (queueMultiRenders) {
         renderQueue = renderQueue.then(() => new Promise((res) => fn(res)));
-    } else {
-        // Sending an empty function to keep it consistent with the above usage.
-        fn(() => {}); // eslint-disable-line @typescript-eslint/no-empty-function
+        return renderQueue;
     }
+    // Sending an empty function to keep it consistent with the above usage.
+    return fn(() => {}); // eslint-disable-line @typescript-eslint/no-empty-function
 };
 
 // For testing purposes only

package/src/embed/liveboard.spec.ts

@@ -12,6 +12,8 @@ import {
     getDocumentBody,
     getIFrameSrc,
     getRootEl,
+    defaultParams,
+    defaultParamsWithoutHiddenActions,
 } from '../test/test-utils';
 import { version } from '../../package.json';
 import * as processTriggerInstance from '../utils/processTrigger';
@@ -26,8 +28,6 @@ const liveboardId = 'eca215d4-0d2c-4a55-90e3-d81ef6848ae0';
 const activeTabId = '502693ba-9818-4e71-8ecd-d1a194e46861';
 const vizId = '6e73f724-660e-11eb-ae93-0242ac130002';
 const thoughtSpotHost = 'tshost';
-const defaultParamsSansHideAction = `&hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}`;
-const defaultParams = `${defaultParamsSansHideAction}&hideAction=[%22${Action.ReportError}%22]`;
 const prefixParams = '&isLiveboardEmbed=true';
 const prefixParamsVizEmbed = '&isLiveboardEmbed=true&isVizEmbed=true';
 
@@ -70,7 +70,7 @@ describe('Liveboard/viz embed tests', () => {
         liveboardEmbed.render();
         await executeAfterWait(() => {
             expect(getIFrameSrc()).toBe(
-                `http://${thoughtSpotHost}/?embedApp=true${defaultParamsSansHideAction}&disableAction=[%22${Action.DownloadAsCsv}%22,%22${Action.DownloadAsPdf}%22,%22${Action.DownloadAsXlsx}%22]&disableHint=Action%20denied&hideAction=[%22${Action.ReportError}%22]${prefixParams}#/embed/viz/${liveboardId}`,
+                `http://${thoughtSpotHost}/?embedApp=true&${defaultParamsWithoutHiddenActions}&disableAction=[%22${Action.DownloadAsCsv}%22,%22${Action.DownloadAsPdf}%22,%22${Action.DownloadAsXlsx}%22]&disableHint=Action%20denied&hideAction=[%22${Action.ReportError}%22]${prefixParams}#/embed/viz/${liveboardId}`,
             );
         });
     });
@@ -88,7 +88,7 @@ describe('Liveboard/viz embed tests', () => {
         liveboardEmbed.render();
         await executeAfterWait(() => {
             expect(getIFrameSrc()).toBe(
-                `http://${thoughtSpotHost}/?embedApp=true${defaultParamsSansHideAction}&hideAction=[%22${Action.ReportError}%22,%22${Action.DownloadAsCsv}%22,%22${Action.DownloadAsPdf}%22,%22${Action.DownloadAsXlsx}%22]${prefixParams}#/embed/viz/${liveboardId}`,
+                `http://${thoughtSpotHost}/?embedApp=true&${defaultParamsWithoutHiddenActions}&hideAction=[%22${Action.ReportError}%22,%22${Action.DownloadAsCsv}%22,%22${Action.DownloadAsPdf}%22,%22${Action.DownloadAsXlsx}%22]${prefixParams}#/embed/viz/${liveboardId}`,
             );
         });
     });

package/src/embed/pinboard.spec.ts

@@ -6,6 +6,8 @@ import {
     getDocumentBody,
     getIFrameSrc,
     getRootEl,
+    defaultParams,
+    defaultParamsWithoutHiddenActions,
 } from '../test/test-utils';
 import { version } from '../../package.json';
 
@@ -18,8 +20,6 @@ const defaultViewConfig = {
 const pinboardId = 'eca215d4-0d2c-4a55-90e3-d81ef6848ae0';
 const vizId = '6e73f724-660e-11eb-ae93-0242ac130002';
 const thoughtSpotHost = 'tshost';
-const defaultParamsWithoutHideActions = `&hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}`;
-const defaultParams = `${defaultParamsWithoutHideActions}&hideAction=[%22${Action.ReportError}%22]`;
 const prefixParams = '&isLiveboardEmbed=true';
 const prefixParamsVizEmbed = '&isLiveboardEmbed=true&isVizEmbed=true';
 beforeAll(() => {
@@ -61,7 +61,7 @@ describe('Pinboard/viz embed tests', () => {
         pinboardEmbed.render();
         await executeAfterWait(() => {
             expect(getIFrameSrc()).toBe(
-                `http://${thoughtSpotHost}/?embedApp=true${defaultParamsWithoutHideActions}&disableAction=[%22${Action.DownloadAsCsv}%22,%22${Action.DownloadAsPdf}%22,%22${Action.DownloadAsXlsx}%22]&disableHint=Action%20denied&hideAction=[%22${Action.ReportError}%22]${prefixParams}#/embed/viz/${pinboardId}`,
+                `http://${thoughtSpotHost}/?embedApp=true&${defaultParamsWithoutHiddenActions}&disableAction=[%22${Action.DownloadAsCsv}%22,%22${Action.DownloadAsPdf}%22,%22${Action.DownloadAsXlsx}%22]&disableHint=Action%20denied&hideAction=[%22${Action.ReportError}%22]${prefixParams}#/embed/viz/${pinboardId}`,
             );
         });
     });
@@ -79,7 +79,7 @@ describe('Pinboard/viz embed tests', () => {
         pinboardEmbed.render();
         await executeAfterWait(() => {
             expect(getIFrameSrc()).toBe(
-                `http://${thoughtSpotHost}/?embedApp=true${defaultParamsWithoutHideActions}&hideAction=[%22${Action.ReportError}%22,%22${Action.DownloadAsCsv}%22,%22${Action.DownloadAsPdf}%22,%22${Action.DownloadAsXlsx}%22]${prefixParams}#/embed/viz/${pinboardId}`,
+                `http://${thoughtSpotHost}/?embedApp=true&${defaultParamsWithoutHiddenActions}&hideAction=[%22${Action.ReportError}%22,%22${Action.DownloadAsCsv}%22,%22${Action.DownloadAsPdf}%22,%22${Action.DownloadAsXlsx}%22]${prefixParams}#/embed/viz/${pinboardId}`,
             );
         });
     });