@thoughtspot/visual-embed-sdk 1.30.0 → 1.31.0

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

@@ -3797,18 +3797,30 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             DownloadAsPdf = "downloadAsPdf",
             /**
-                * Trigger the **Make a copy** action on a Liveboard, Search, or
-                * visualization page.
+                * Trigger the **Make a copy** action on a Liveboard,
+                * visualization, or Answer page.
+                *
                 * @example
                 * ```js
-                * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+                * liveboardEmbed.trigger(HostEvent.MakeACopy)
                 * ```
+                *
+                * @example
+                * ```js
+                * liveboardEmbed.trigger(HostEvent.MakeACopy, {
+                * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+                * ```
+                *
+                * @example
                 * ```js
                 * vizEmbed.trigger(HostEvent.MakeACopy)
                 * ```
+                *
+                * @example
                 * ```js
                 * searchEmbed.trigger(HostEvent.MakeACopy)
                 * ```
+                *
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
                 */
             MakeACopy = "makeACopy",
@@ -3832,7 +3844,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             Explore = "explore",
             /**
-                * Trigger the **Create alert** action on a visualization
+                * Trigger the **Create alert** action on a KPI chart
+                * in a Liveboard or saved Answer.
+                *
                 * @param - an object with `vizId` as a key
                 * @example
                 * ```js
@@ -3840,6 +3854,11 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
                 * })
                 * ```
+                *
+                * @example
+                * ```js
+                * appEmbed.trigger(HostEvent.CreateMonitor)
+                * ```
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
                 */
             CreateMonitor = "createMonitor",
@@ -4243,7 +4262,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             UpdateSageQuery = "updateSageQuery",
             /**
-                * Get the answer session for a Search / Visualization.
+                * Get the answer session for a Search or
+                * Liveboard visualization.
+                *
                 * @example
                 * ```js
                 * const {session} = await embed.trigger(
@@ -4251,6 +4272,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *      vizId: '123', // For Liveboard Visualization.
                 *  })
                 * ```
+                *
+                * @example
+                * ```js
+                * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
+                * ```
+                *
                 * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
                 */
             GetAnswerSession = "getAnswerSession",
@@ -6202,8 +6229,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
         * @summary Base classes
         * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
         */
-    import { DOMSelector, EmbedConfig, EmbedEvent, HostEvent, MessageCallback, MessageOptions, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
     import { AnswerService } from '@thoughtspot/visual-embed-sdk/utils/graphql/answerService/answerService';
+    import { DOMSelector, HostEvent, EmbedEvent, MessageCallback, EmbedConfig, MessageOptions, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
     /**
         * Global prefix for all Thoughtspot postHash Params.
         */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.30.0",
+    "version": "1.31.0",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",

package/src/auth.ts

@@ -1,18 +1,18 @@
 import EventEmitter from 'eventemitter3';
-import { getAuthenticationToken, resetCachedAuthToken } from './authToken';
 import { initMixpanel } from './mixpanel-service';
 import {
-    AuthType, DOMSelector, EmbedConfig, EmbedEvent,
+    AuthType, DOMSelector, EmbedConfig, EmbedEvent, Param,
 } from './types';
 import { getDOMNode, getRedirectUrl } from './utils';
 import {
-    EndPoints,
-    fetchAuthPostService,
+    fetchSessionInfoService,
     fetchAuthService,
     fetchBasicAuthService,
     fetchLogoutService,
-    fetchSessionInfoService,
+    fetchAuthPostService,
+    EndPoints,
 } from './utils/authService';
+import { getAuthenticationToken, resetCachedAuthToken } from './authToken';
 import { logger } from './utils/logger';
 import { getEmbedConfig } from './embed/embedConfig';
 
@@ -476,7 +476,7 @@ export const logout = async (embedConfig: EmbedConfig): Promise<boolean> => {
     const { thoughtSpotHost } = embedConfig;
     await fetchLogoutService(thoughtSpotHost);
     resetCachedAuthToken();
-    const thoughtspotIframes = document.querySelectorAll("[data-ts-iframe='true']");
+    const thoughtspotIframes = document.querySelectorAll('[data-ts-iframe=\'true\']');
     if (thoughtspotIframes?.length) {
         thoughtspotIframes.forEach((el) => {
             el.parentElement.innerHTML = embedConfig.loginFailedMessage;

package/src/embed/base.spec.ts

@@ -1,11 +1,11 @@
 /* eslint-disable no-console */
 /* eslint-disable @typescript-eslint/no-shadow */
 import EventEmitter from 'eventemitter3';
+import { EmbedConfig } from '../index';
 import * as auth from '../auth';
+import * as authService from '../utils/authService/authService';
 import * as authTokenService from '../authToken';
 import * as index from '../index';
-import { EmbedConfig } from '../index';
-import * as authService from '../utils/authService/authService';
 import * as base from './base';
 import * as embedConfigInstance from './embedConfig';
 
@@ -13,8 +13,8 @@ import {
     executeAfterWait,
     getAllIframeEl,
     getDocumentBody,
-    getIFrameSrc,
     getRootEl,
+    getIFrameSrc,
 } from '../test/test-utils';
 import * as tokenizedFetchInstance from '../tokenizedFetch';
 import { logger } from '../utils/logger';

package/src/embed/liveboard.ts

@@ -10,9 +10,16 @@
 
 import { ERROR_MESSAGE } from '../errors';
 import {
-    DOMSelector, EmbedEvent, HostEvent, MessagePayload, Param, ViewConfig,
+    EmbedEvent,
+    MessagePayload,
+    Param,
+    RuntimeFilter,
+    DOMSelector,
+    HostEvent,
+    ViewConfig,
 } from '../types';
 import { getQueryParamString, isUndefined } from '../utils';
+import { getAuthPromise } from './base';
 import { V1Embed } from './ts-embed';
 
 /**

package/src/embed/ts-embed.ts

@@ -7,54 +7,57 @@
  */
 
 import isEqual from 'lodash/isEqual';
-import pkgInfo from '../../package.json';
-import { AuthFailureType } from '../auth';
+import { logger } from '../utils/logger';
 import { getAuthenticationToken } from '../authToken';
+import { AnswerService } from '../utils/graphql/answerService/answerService';
+import {
+    getEncodedQueryParamsString,
+    getCssDimension,
+    getOffsetTop,
+    embedEventStatus,
+    setAttributes,
+    getCustomisations,
+    getRuntimeFilters,
+    getDOMNode,
+    getFilterQuery,
+    getQueryParamString,
+    getRuntimeParameters,
+    setStyleProperties,
+    removeStyleProperties,
+    isUndefined,
+} from '../utils';
 import {
-    DEFAULT_EMBED_HEIGHT,
-    DEFAULT_EMBED_WIDTH,
-    URL_MAX_LENGTH,
     getThoughtSpotHost,
+    URL_MAX_LENGTH,
+    DEFAULT_EMBED_WIDTH,
+    DEFAULT_EMBED_HEIGHT,
     getV2BasePath,
 } from '../config';
-import { MIXPANEL_EVENT, uploadMixpanelEvent } from '../mixpanel-service';
 import {
-    Action,
     AuthType,
-    ContextMenuTriggerOptions,
     DOMSelector,
-    EmbedConfig,
-    EmbedEvent,
     HostEvent,
+    EmbedEvent,
     MessageCallback,
-    MessageCallbackObj,
-    MessageOptions,
+    Action,
     Param,
+    EmbedConfig,
+    MessageOptions,
+    MessagePayload,
+    MessageCallbackObj,
     ViewConfig,
+    FrameParams,
+    ContextMenuTriggerOptions,
+    RuntimeFilter,
 } from '../types';
-import {
-    embedEventStatus,
-    getCssDimension,
-    getCustomisations,
-    getDOMNode,
-    getEncodedQueryParamsString,
-    getFilterQuery,
-    getOffsetTop,
-    getQueryParamString,
-    getRuntimeFilters,
-    getRuntimeParameters,
-    isUndefined,
-    removeStyleProperties,
-    setAttributes,
-    setStyleProperties,
-} from '../utils';
-import { AnswerService } from '../utils/graphql/answerService/answerService';
-import { logger } from '../utils/logger';
-import { processAuthFailure, processEventData } from '../utils/processData';
+import { uploadMixpanelEvent, MIXPANEL_EVENT } from '../mixpanel-service';
+import { processEventData, processAuthFailure } from '../utils/processData';
 import { processTrigger } from '../utils/processTrigger';
+import pkgInfo from '../../package.json';
 import {
-    getAuthPromise, handleAuth, notifyAuthFailure, renderInQueue,
+    getAuthPromise, renderInQueue, handleAuth, notifyAuthFailure,
 } from './base';
+import { AuthFailureType } from '../auth';
 import { getEmbedConfig } from './embedConfig';
 
 const { version } = pkgInfo;
@@ -588,7 +591,6 @@ export class TsEmbed {
      * @param url - The URL of the embedded ThoughtSpot app.
      */
     protected async renderIFrame(url: string): Promise<any> {
-        console.log('here 7');
         if (this.isError) {
             return null;
         }
@@ -598,10 +600,8 @@ export class TsEmbed {
         if (url.length > URL_MAX_LENGTH) {
             // warn: The URL is too long
         }
-        console.log('here 8');
 
         return renderInQueue((nextInQueue) => {
-            console.log('here 6');
             const initTimestamp = Date.now();
 
             this.executeCallbacks(EmbedEvent.Init, {
@@ -614,7 +614,6 @@ export class TsEmbed {
             uploadMixpanelEvent(MIXPANEL_EVENT.VISUAL_SDK_RENDER_START);
             return getAuthPromise()
                 ?.then((isLoggedIn: boolean) => {
-                    console.log('here 9', isLoggedIn);
                     if (!isLoggedIn) {
                         this.handleInsertionIntoDOM(this.embedConfig.loginFailedMessage);
                         return;
@@ -639,9 +638,7 @@ export class TsEmbed {
                     this.iFrame.addEventListener('error', () => {
                         nextInQueue();
                     });
-                    console.log('here 10', this.iFrame);
                     this.handleInsertionIntoDOM(this.iFrame);
-                    console.log('here 11', document.body.innerHTML);
                     const prefetchIframe = document.querySelectorAll('.prefetchIframe');
                     if (prefetchIframe.length) {
                         prefetchIframe.forEach((el) => {
@@ -685,7 +682,7 @@ export class TsEmbed {
     protected connectPreRendered(): boolean {
         const preRenderIds = this.getPreRenderIds();
         this.preRenderWrapper = this.preRenderWrapper
-          || document.getElementById(preRenderIds.wrapper);
+            || document.getElementById(preRenderIds.wrapper);
 
         this.preRenderChild = this.preRenderChild || document.getElementById(preRenderIds.child);
 
@@ -1090,11 +1087,11 @@ export class TsEmbed {
                 ) {
                     logger.warn(
                         `${viewConfig.embedComponentType || 'Component'} was pre-rendered with `
-                            + `"${key}" as "${JSON.stringify(preRenderedObject.viewConfig[key])}" `
-                            + `but a different value "${JSON.stringify(viewConfig[key])}" `
-                            + 'was passed to the Embed component. '
-                            + 'The new value provided is ignored, the value provided during '
-                            + 'preRender is used.',
+                        + `"${key}" as "${JSON.stringify(preRenderedObject.viewConfig[key])}" `
+                        + `but a different value "${JSON.stringify(viewConfig[key])}" `
+                        + 'was passed to the Embed component. '
+                        + 'The new value provided is ignored, the value provided during '
+                        + 'preRender is used.',
                     );
                 }
             });

package/src/react/index.spec.tsx

@@ -15,15 +15,12 @@ import {
     mockMessageChannel,
 } from '../test/test-utils';
 import {
-    SearchEmbed,
-    AppEmbed,
-    LiveboardEmbed,
-    useEmbedRef,
-    SearchBarEmbed,
-    PreRenderedLiveboardEmbed,
+    SearchEmbed, AppEmbed, LiveboardEmbed, useEmbedRef, SearchBarEmbed, PreRenderedLiveboardEmbed,
 } from './index';
 import * as allExports from './index';
-import { AuthType, init } from '../index';
+import {
+    AuthType, init,
+} from '../index';
 
 import { version } from '../../package.json';
 
@@ -46,9 +43,11 @@ describe('React Components', () => {
 
             await waitFor(() => getIFrameEl(container));
 
-            expect(getIFrameEl(container).parentElement.classList.contains('embedClass')).toBe(
-                true,
-            );
+            expect(
+                getIFrameEl(container).parentElement.classList.contains(
+                    'embedClass',
+                ),
+            ).toBe(true);
             expect(getIFrameSrc(container)).toBe(
                 `http://${thoughtSpotHost}/?hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}&authType=None&blockNonEmbedFullAppAccess=true&hideAction=[%22${Action.ReportError}%22,%22editACopy%22,%22saveAsView%22,%22updateTSL%22,%22editTSL%22,%22onDeleteAnswer%22]&overrideConsoleLogs=true&clientLogLevel=ERROR&enableDataPanelV2=false&dataSourceMode=hide&useLastSelectedSources=false&isSearchEmbed=true&collapseSearchBarInitially=false&enableCustomColumnGroups=false&dataPanelCustomGroupsAccordionInitialState=EXPAND_ALL#/embed/answer`,
             );
@@ -145,53 +144,60 @@ describe('React Components', () => {
         });
 
         it('Should have the correct container element', async () => {
-            const { container } = render(<LiveboardEmbed liveboardId="abcd" className="def" />);
-
-            await waitFor(() => getIFrameEl(container));
-            expect(container.querySelector('div')).not.toBe(null);
-            expect(container.querySelector('div').classList.contains('def')).toBe(true);
-
-            const { container: containerSibling } = render(
-                <LiveboardEmbed liveboardId="abcd" className="def" insertAsSibling={true} />,
+            const { container } = render(
+                <LiveboardEmbed liveboardId="abcd" className="def" />,
             );
-            await waitFor(() => getIFrameEl(containerSibling));
-            expect(containerSibling.querySelector('span')).not.toBe(null);
-            expect(containerSibling.querySelector('span').style.position).toBe('absolute');
-            expect(getIFrameEl(containerSibling).classList.contains('def')).toBe(true);
-            expect(containerSibling.querySelector('div')).toBe(null);
-        });
-
-        it('Should have the correct container element', async () => {
-            const { container } = render(<LiveboardEmbed liveboardId="abcd" className="def" />);
 
             await waitFor(() => getIFrameEl(container));
             expect(container.querySelector('div')).not.toBe(null);
-            expect(container.querySelector('div').classList.contains('def')).toBe(true);
+            expect(
+                container.querySelector('div').classList.contains('def'),
+            ).toBe(true);
 
             const { container: containerSibling } = render(
-                <LiveboardEmbed liveboardId="abcd" className="def" insertAsSibling={true} />,
+                <LiveboardEmbed
+                    liveboardId="abcd"
+                    className="def"
+                    insertAsSibling={true}
+                />,
             );
             await waitFor(() => getIFrameEl(containerSibling));
             expect(containerSibling.querySelector('span')).not.toBe(null);
-            expect(containerSibling.querySelector('span').style.position).toBe('absolute');
-            expect(getIFrameEl(containerSibling).classList.contains('def')).toBe(true);
+            expect(containerSibling.querySelector('span').style.position).toBe(
+                'absolute',
+            );
+            expect(
+                getIFrameEl(containerSibling).classList.contains('def'),
+            ).toBe(true);
             expect(containerSibling.querySelector('div')).toBe(null);
         });
 
         it('Should have the correct container element', async () => {
-            const { container } = render(<LiveboardEmbed liveboardId="abcd" className="def" />);
+            const { container } = render(
+                <LiveboardEmbed liveboardId="abcd" className="def" />,
+            );
 
             await waitFor(() => getIFrameEl(container));
             expect(container.querySelector('div')).not.toBe(null);
-            expect(container.querySelector('div').classList.contains('def')).toBe(true);
+            expect(
+                container.querySelector('div').classList.contains('def'),
+            ).toBe(true);
 
             const { container: containerSibling } = render(
-                <LiveboardEmbed liveboardId="abcd" className="def" insertAsSibling={true} />,
+                <LiveboardEmbed
+                    liveboardId="abcd"
+                    className="def"
+                    insertAsSibling={true}
+                />,
             );
             await waitFor(() => getIFrameEl(containerSibling));
             expect(containerSibling.querySelector('span')).not.toBe(null);
-            expect(containerSibling.querySelector('span').style.position).toBe('absolute');
-            expect(getIFrameEl(containerSibling).classList.contains('def')).toBe(true);
+            expect(containerSibling.querySelector('span').style.position).toBe(
+                'absolute',
+            );
+            expect(
+                getIFrameEl(containerSibling).classList.contains('def'),
+            ).toBe(true);
             expect(containerSibling.querySelector('div')).toBe(null);
         });
     });
@@ -211,9 +217,11 @@ describe('React Components', () => {
 
             await waitFor(() => getIFrameEl(container));
 
-            expect(getIFrameEl(container).parentElement.classList.contains('embedClass')).toBe(
-                true,
-            );
+            expect(
+                getIFrameEl(container).parentElement.classList.contains(
+                    'embedClass',
+                ),
+            ).toBe(true);
             expect(getIFrameSrc(container)).toBe(
                 `http://${thoughtSpotHost}/?hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}&authType=None&blockNonEmbedFullAppAccess=true&hideAction=[%22${Action.ReportError}%22]&overrideConsoleLogs=true&clientLogLevel=ERROR&dataSources=[%22test%22]&searchTokenString=%5Brevenue%5D&executeSearch=true&useLastSelectedSources=false&isSearchEmbed=true#/embed/search-bar-embed`,
             );
@@ -233,9 +241,7 @@ describe('React Components', () => {
             );
 
             await waitFor(() => getIFrameEl());
-            const preRenderWrapper = document.body.querySelector(
-                `#${preRenderId}`,
-            ) as HTMLDivElement;
+            const preRenderWrapper = document.body.querySelector(`#${preRenderId}`) as HTMLDivElement;
 
             expect(preRenderWrapper).toBeInstanceOf(HTMLDivElement);
             expect((preRenderWrapper as HTMLDivElement).childElementCount).toBe(1);
@@ -250,7 +256,11 @@ describe('React Components', () => {
                 unobserve: jest.fn(),
             }));
             const { container: libContainer } = render(
-                <LiveboardEmbed className="embedClass" preRenderId="test" liveboardId="libId" />,
+                <LiveboardEmbed
+                    className="embedClass"
+                    preRenderId="test"
+                    liveboardId="libId"
+                />,
             );
 
             expect(preRenderWrapper.style.opacity).toBe('');
@@ -266,9 +276,11 @@ describe('allExports', () => {
     });
 
     it('should not have undefined exports', () => {
-        Object.keys(allExports)
-            .forEach(
-                (exportKey) => expect(Boolean(allExports[exportKey])).toBe(true),
-            );
+        Object.keys(allExports).forEach(
+            (exportKey) => expect(
+                Boolean(allExports[exportKey]),
+            )
+                .toBe(true),
+        );
     });
 });

package/src/types.ts

@@ -2417,18 +2417,30 @@ export enum HostEvent {
      */
     DownloadAsPdf = 'downloadAsPdf',
     /**
-     * Trigger the **Make a copy** action on a Liveboard, Search, or
-     * visualization page.
+     * Trigger the **Make a copy** action on a Liveboard,
+     * visualization, or Answer page.
+     *
      * @example
      * ```js
-     * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * liveboardEmbed.trigger(HostEvent.MakeACopy)
      * ```
+     *
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.MakeACopy, {
+     * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * ```
+     *
+     * @example
      * ```js
      * vizEmbed.trigger(HostEvent.MakeACopy)
      * ```
+     *
+     * @example
      * ```js
      * searchEmbed.trigger(HostEvent.MakeACopy)
      * ```
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     MakeACopy = 'makeACopy',
@@ -2452,7 +2464,9 @@ export enum HostEvent {
      */
     Explore = 'explore',
     /**
-     * Trigger the **Create alert** action on a visualization
+     * Trigger the **Create alert** action on a KPI chart
+     * in a Liveboard or saved Answer.
+     *
      * @param - an object with `vizId` as a key
      * @example
      * ```js
@@ -2460,6 +2474,11 @@ export enum HostEvent {
      *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
      * })
      * ```
+     *
+     * @example
+     * ```js
+     * appEmbed.trigger(HostEvent.CreateMonitor)
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     CreateMonitor = 'createMonitor',
@@ -2863,7 +2882,9 @@ export enum HostEvent {
      */
     UpdateSageQuery = 'updateSageQuery',
     /**
-     * Get the answer session for a Search / Visualization.
+     * Get the answer session for a Search or
+     * Liveboard visualization.
+     *
      * @example
      * ```js
      * const {session} = await embed.trigger(
@@ -2871,6 +2892,12 @@ export enum HostEvent {
      *      vizId: '123', // For Liveboard Visualization.
      *  })
      * ```
+     *
+     * @example
+     * ```js
+     * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
+     * ```
+     *
      * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
      */
     GetAnswerSession = 'getAnswerSession',

package/src/utils/authService/authService.spec.ts

@@ -1,11 +1,11 @@
 import {
-    EndPoints,
-    fetchAuthPostService,
-    fetchAuthService,
+    fetchSessionInfoService,
     fetchAuthTokenService,
+    fetchAuthService,
     fetchBasicAuthService,
-    fetchSessionInfoService,
+    fetchAuthPostService,
     verifyTokenService,
+    EndPoints,
 } from '.';
 import { logger } from '../logger';