@thoughtspot/visual-embed-sdk 1.39.2 → 1.39.3

package/src/embed/app.spec.ts

@@ -6,11 +6,10 @@ import {
     HomePageSearchBarMode,
     PrimaryNavbarVersion,
     HomePage,
+    ListPage,
 } from './app';
 import { init } from '../index';
-import {
-    Action, AuthType, EmbedEvent, HostEvent, RuntimeFilterOp,
-} from '../types';
+import { Action, AuthType, EmbedEvent, HostEvent, RuntimeFilterOp } from '../types';
 import {
     executeAfterWait,
     getDocumentBody,
@@ -45,12 +44,13 @@ beforeAll(() => {
         authType: AuthType.None,
     });
     jest.spyOn(auth, 'postLoginService').mockImplementation(() => Promise.resolve({}));
-    (window as any).ResizeObserver = window.ResizeObserver
-            || jest.fn().mockImplementation(() => ({
-                disconnect: jest.fn(),
-                observe: jest.fn(),
-                unobserve: jest.fn(),
-            }));
+    (window as any).ResizeObserver =
+        window.ResizeObserver ||
+        jest.fn().mockImplementation(() => ({
+            disconnect: jest.fn(),
+            observe: jest.fn(),
+            unobserve: jest.fn(),
+        }));
 });
 
 const cleanUp = () => {
@@ -316,6 +316,20 @@ describe('App embed tests', () => {
         });
     });
 
+    test('should set coverAndFilterOptionInPDF to false in url', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            coverAndFilterOptionInPDF: false,
+        } as AppViewConfig);
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&arePdfCoverFilterPageCheckboxesEnabled=false${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
     test('should set isLiveboardStylingAndGroupingEnabled to true in url', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,
@@ -611,6 +625,59 @@ describe('App embed tests', () => {
         });
     });
 
+    test('Should add listpageVersion=v3 when listPageVersion is ListWithUXChanges to the iframe src', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            discoveryExperience: {
+                listPageVersion: ListPage.ListWithUXChanges,
+            },
+        } as AppViewConfig);
+
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false&listpageVersion=v3${defaultParams}${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
+    test('Should not add listpageVersion when listPageVersion is List (v2) to the iframe src', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            discoveryExperience: {
+                listPageVersion: ListPage.List,
+            },
+        } as AppViewConfig);
+
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false${defaultParams}${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
+    test('Should add listpageVersion=v3 combined with other discoveryExperience options to the iframe src', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            discoveryExperience: {
+                primaryNavbarVersion: PrimaryNavbarVersion.Sliding,
+                homePage: HomePage.Modular,
+                listPageVersion: ListPage.ListWithUXChanges,
+            },
+        } as AppViewConfig);
+
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=true&navigationVersion=v3&listpageVersion=v3${defaultParams}${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
     test('Should add enablePendoHelp flag to the iframe src conditional on navbar', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,
@@ -687,7 +754,8 @@ describe('App embed tests', () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,
             // eslint-disable-next-line max-len
-            dataPanelCustomGroupsAccordionInitialState: DataPanelCustomColumnGroupsAccordionState.EXPAND_FIRST,
+            dataPanelCustomGroupsAccordionInitialState:
+                DataPanelCustomColumnGroupsAccordionState.EXPAND_FIRST,
         } as AppViewConfig);
 
         appEmbed.render();
@@ -700,19 +768,18 @@ describe('App embed tests', () => {
     });
 
     test('should register event handlers to adjust iframe height', async () => {
-        const onSpy = jest.spyOn(AppEmbed.prototype, 'on')
-            .mockImplementation((event, callback) => {
-                if (event === EmbedEvent.RouteChange) {
-                    callback({ data: { currentPath: '/answers' } }, jest.fn());
-                }
-                if (event === EmbedEvent.EmbedHeight) {
-                    callback({ data: '100%' });
-                }
-                if (event === EmbedEvent.EmbedIframeCenter) {
-                    callback({}, jest.fn());
-                }
-                return null;
-            });
+        const onSpy = jest.spyOn(AppEmbed.prototype, 'on').mockImplementation((event, callback) => {
+            if (event === EmbedEvent.RouteChange) {
+                callback({ data: { currentPath: '/answers' } }, jest.fn());
+            }
+            if (event === EmbedEvent.EmbedHeight) {
+                callback({ data: '100%' });
+            }
+            if (event === EmbedEvent.EmbedIframeCenter) {
+                callback({}, jest.fn());
+            }
+            return null;
+        });
         jest.spyOn(TsEmbed.prototype as any, 'getIframeCenter').mockReturnValue({});
         jest.spyOn(TsEmbed.prototype as any, 'setIFrameHeight').mockReturnValue({});
         const appEmbed = new AppEmbed(getRootEl(), {

package/src/embed/app.ts

@@ -109,6 +109,22 @@ export enum HomePage {
     Modular = 'v2',
 }
 
+/**
+ * Define the version of the list page
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
+ */
+export enum ListPage {
+    /**
+     * List (v2) is the traditional List Experience.
+     * It serves as the foundational version of the list page.
+     */
+    List = 'v2',
+    /**
+     * ListWithUXChanges (v3) introduces the new updated list page with UX changes.
+     */
+    ListWithUXChanges = 'v3',
+}
+
 /**
  * Define the discovery experience
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
@@ -122,6 +138,10 @@ export interface DiscoveryExperience {
      * homePage determines the version of the home page.
      */
     homePage?: HomePage;
+    /**
+     * listPageVersion determines the version of the list page.
+     */
+    listPageVersion?: ListPage;
 }
 
 /**
@@ -494,21 +514,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
      * ```
      */
     isUnifiedSearchExperienceEnabled?: boolean;
-     /**
-     * Show alert messages and toast messages in the embedded
-     * view in full app embed.
-     * 
-     * Supported embed types: `AppEmbed`
-     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
-     * @example
-     * ```js
-     * const embed = new AppEmbed('#tsEmbed', {
-     *    ... // other embed view config
-     *    showAlerts:true,
-     * })
-     * ```
-     */
-     showAlerts?: boolean;
+
     /**
      * This flag is used to enable/disable the styling and grouping in a Liveboard
      * 
@@ -588,6 +594,7 @@ export class AppEmbed extends V1Embed {
             isUnifiedSearchExperienceEnabled = true,
             enablePendoHelp = true,
             discoveryExperience,
+            coverAndFilterOptionInPDF = false,
             isLiveboardStylingAndGroupingEnabled,
         } = this.viewConfig;
 
@@ -606,6 +613,7 @@ export class AppEmbed extends V1Embed {
         params[Param.ShowLiveboardReverifyBanner] = showLiveboardReverifyBanner;
         params[Param.HideIrrelevantFiltersInTab] = hideIrrelevantChipsInLiveboardTabs;
         params[Param.IsUnifiedSearchExperienceEnabled] = isUnifiedSearchExperienceEnabled;
+        params[Param.CoverAndFilterOptionInPDF] = !!coverAndFilterOptionInPDF;
 
         params = this.getBaseQueryParams(params);
 
@@ -696,6 +704,10 @@ export class AppEmbed extends V1Embed {
             if (discoveryExperience.homePage === HomePage.Modular) {
                 params[Param.ModularHomeExperienceEnabled] = true;
             }
+            // listPageVersion v3 will enable the new list page
+            if (discoveryExperience.listPageVersion === ListPage.ListWithUXChanges) {
+                params[Param.ListPageVersion] = discoveryExperience.listPageVersion;
+            }
         }
 
         const queryParams = getQueryParamString(params, true);

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

@@ -1,5 +1,5 @@
 import 'jest-fetch-mock';
-import { SpotterAgentEmbed, SpotterAgentEmbedViewConfig } from './bodyless-conversation';
+import { SpotterAgentEmbed, SpotterAgentEmbedViewConfig, ConversationMessage } from './bodyless-conversation';
 import * as authInstance from '../auth';
 import { init } from '../index';
 import { Action, AuthType, RuntimeFilterOp } from '../types';
@@ -138,7 +138,7 @@ describe('SpotterAgentEmbed', () => {
         expect(errorResult.error instanceof Error).toBeTruthy();
     });
 
-    test('should apply containerClassName to the container element', async () => {
+    test('should handle hideActions parameter correctly', async () => {
         fetchMock.mockResponses(
             JSON.stringify({
                 data: {
@@ -227,221 +227,27 @@ describe('SpotterAgentEmbed', () => {
 
         const viewConfig: SpotterAgentEmbedViewConfig = {
             worksheetId: 'worksheetId',
-            containerClassName: 'custom-conversation-container',
+            hiddenActions: [Action.Download, Action.Save], // This should trigger the HideActions branch
         };
 
         const spotterAgentEmbed = new SpotterAgentEmbed(viewConfig);
         const result = await spotterAgentEmbed.sendMessage('userMessage');
         
-        // Verify that the container has the custom class name
-        expect(result.container.className).toBe('custom-conversation-container');
-        
-        // Also verify the iframe src is correct
+        // Verify the iframe src contains the hideActions parameter
         const iframeSrc = getIFrameSrc(result.container);
-        expectUrlToHaveParamsWithValues(iframeSrc, {
-            sessionId: 'sessionId',
-            genNo: 2,
-            acSessionId: 'transactionId',
-            acGenNo: 1,
-        });
+        expect(iframeSrc).toContain('hideAction');
     });
 
-    test('should not set className when containerClassName is not provided', async () => {
-        fetchMock.mockResponses(
-            JSON.stringify({
-                data: {
-                    ConvAssist__createConversation: {
-                        convId: 'conversationId',
-                        initialCtx: {
-                            type: 'TS_ANSWER',
-                            tsAnsCtx: {
-                                sessionId: 'sessionId',
-                                genNo: 1,
-                                stateKey: {
-                                    transactionId: 'transactionId',
-                                    generationNumber: 1,
-                                },
-                                worksheet: {
-                                    worksheetId: 'worksheetId',
-                                    worksheetName: 'GTM',
-                                },
-                            },
-                        },
-                    },
-                },
-            }),
-            JSON.stringify({
-                data: {
-                    ConvAssist__sendMessage: {
-                        responses: [
-                            {
-                                msgId: 'msgId',
-                                data: {
-                                    asstRespData: {
-                                        tool: 'TS_NLS',
-                                        asstRespText: '',
-                                        nlsAnsData: {
-                                            sageQuerySuggestions: [
-                                                {
-                                                    llmReasoning: {
-                                                        assumptions: 'You want the total [COL|sales] for [COL|item_type] [VAL|jackets] for [VAL|this year].',
-                                                        clarifications: '',
-                                                        interpretation: '',
-                                                        __typename: 'eureka_SageQuerySuggestion_LLMReasoning',
-                                                    },
-                                                    tokens: [
-                                                        'sum sales',
-                                                        "item type = 'jackets'",
-                                                        "date = 'this year'",
-                                                    ],
-                                                    tmlTokens: [
-                                                        'sum [sales]',
-                                                        "[date] = [date].'this year'",
-                                                        "[item type] = [item type].'jackets'",
-                                                    ],
-                                                    worksheetId: 'worksheetId',
-                                                    description: '',
-                                                    title: '',
-                                                    cached: false,
-                                                    sqlQuery: "SELECT SUM(sales) FROM __Sample_Retail_Apparel WHERE item_type = 'jackets' AND date = _this_year();",
-                                                    sessionId: 'sessionId',
-                                                    genNo: 2,
-                                                    formulaInfo: [],
-                                                    tmlPhrases: [],
-                                                    stateKey: {
-                                                        transactionId: 'transactionId',
-                                                        generationNumber: 1,
-                                                        __typename: 'sage_auto_complete_v2_ACStateKey',
-                                                    },
-                                                    __typename: 'eureka_SageQuerySuggestion',
-                                                },
-                                            ],
-                                            responseType: 'ANSWER',
-                                            __typename: 'convassist_nls_tool_NLSToolAsstRespData',
-                                        },
-                                        __typename: 'convassist_AsstResponseData',
-                                    },
-                                    __typename: 'convassist_MessageData',
-                                },
-                                type: 'ASST_RESPONSE',
-                                __typename: 'convassist_MessagePayload',
-                            },
-                        ],
-                        __typename: 'convassist_SendMessageResponse',
-                    },
-                },
-            }),
-        );
-
+    test('should have sendMessageData method', () => {
         const viewConfig: SpotterAgentEmbedViewConfig = {
             worksheetId: 'worksheetId',
-            // No containerClassName provided
         };
 
         const spotterAgentEmbed = new SpotterAgentEmbed(viewConfig);
-        const result = await spotterAgentEmbed.sendMessage('userMessage');
-        
-        // Verify that the container has no class name (empty string)
-        expect(result.container.className).toBe('');
+        expect(typeof spotterAgentEmbed.sendMessageData).toBe('function');
     });
 
-    test('should handle hideActions parameter correctly', async () => {
-        fetchMock.mockResponses(
-            JSON.stringify({
-                data: {
-                    ConvAssist__createConversation: {
-                        convId: 'conversationId',
-                        initialCtx: {
-                            type: 'TS_ANSWER',
-                            tsAnsCtx: {
-                                sessionId: 'sessionId',
-                                genNo: 1,
-                                stateKey: {
-                                    transactionId: 'transactionId',
-                                    generationNumber: 1,
-                                },
-                                worksheet: {
-                                    worksheetId: 'worksheetId',
-                                    worksheetName: 'GTM',
-                                },
-                            },
-                        },
-                    },
-                },
-            }),
-            JSON.stringify({
-                data: {
-                    ConvAssist__sendMessage: {
-                        responses: [
-                            {
-                                msgId: 'msgId',
-                                data: {
-                                    asstRespData: {
-                                        tool: 'TS_NLS',
-                                        asstRespText: '',
-                                        nlsAnsData: {
-                                            sageQuerySuggestions: [
-                                                {
-                                                    llmReasoning: {
-                                                        assumptions: 'You want the total [COL|sales] for [COL|item_type] [VAL|jackets] for [VAL|this year].',
-                                                        clarifications: '',
-                                                        interpretation: '',
-                                                        __typename: 'eureka_SageQuerySuggestion_LLMReasoning',
-                                                    },
-                                                    tokens: [
-                                                        'sum sales',
-                                                        "item type = 'jackets'",
-                                                        "date = 'this year'",
-                                                    ],
-                                                    tmlTokens: [
-                                                        'sum [sales]',
-                                                        "[date] = [date].'this year'",
-                                                        "[item type] = [item type].'jackets'",
-                                                    ],
-                                                    worksheetId: 'worksheetId',
-                                                    description: '',
-                                                    title: '',
-                                                    cached: false,
-                                                    sqlQuery: "SELECT SUM(sales) FROM __Sample_Retail_Apparel WHERE item_type = 'jackets' AND date = _this_year();",
-                                                    sessionId: 'sessionId',
-                                                    genNo: 2,
-                                                    formulaInfo: [],
-                                                    tmlPhrases: [],
-                                                    stateKey: {
-                                                        transactionId: 'transactionId',
-                                                        generationNumber: 1,
-                                                        __typename: 'sage_auto_complete_v2_ACStateKey',
-                                                    },
-                                                    __typename: 'eureka_SageQuerySuggestion',
-                                                },
-                                            ],
-                                            responseType: 'ANSWER',
-                                            __typename: 'convassist_nls_tool_NLSToolAsstRespData',
-                                        },
-                                        __typename: 'convassist_AsstResponseData',
-                                    },
-                                    __typename: 'convassist_MessageData',
-                                },
-                                type: 'ASST_RESPONSE',
-                                __typename: 'convassist_MessagePayload',
-                            },
-                        ],
-                        __typename: 'convassist_SendMessageResponse',
-                    },
-                },
-            }),
-        );
-
-        const viewConfig: SpotterAgentEmbedViewConfig = {
-            worksheetId: 'worksheetId',
-            hiddenActions: [Action.Download, Action.Save], // This should trigger the HideActions branch
-        };
-
-        const spotterAgentEmbed = new SpotterAgentEmbed(viewConfig);
-        const result = await spotterAgentEmbed.sendMessage('userMessage');
-        
-        // Verify the iframe src contains the hideActions parameter
-        const iframeSrc = getIFrameSrc(result.container);
-        expect(iframeSrc).toContain('hideAction');
+    test('should export ConversationMessage class', () => {
+        expect(typeof ConversationMessage).toBe('function');
     });
 });

package/src/embed/bodyless-conversation.ts

@@ -13,11 +13,6 @@ export interface SpotterAgentEmbedViewConfig extends Omit<BaseViewConfig, 'prima
      * The ID of the worksheet to use for the conversation.
      */
     worksheetId: string;
-    
-    /**
-     * Optional CSS class name to add to the container div.
-     */
-    containerClassName?: string;
 }
 
 /**
@@ -29,14 +24,16 @@ export interface SpotterAgentEmbedViewConfig extends Omit<BaseViewConfig, 'prima
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface BodylessConversationViewConfig extends SpotterAgentEmbedViewConfig {}
 
-interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConfig {
+export interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConfig {
     sessionId: string;
     genNo: number;
     acSessionId: string;
     acGenNo: number;
+    convId: string;
+    messageId: string;
 }
 
-class ConversationMessage extends TsEmbed {
+export class ConversationMessage extends TsEmbed {
     constructor(container: HTMLElement, protected viewConfig: SpotterAgentMessageViewConfig) {
         viewConfig.embedComponentType = 'bodyless-conversation';
         super(container, viewConfig);
@@ -48,6 +45,8 @@ class ConversationMessage extends TsEmbed {
             genNo,
             acSessionId,
             acGenNo,
+            convId,
+            messageId,
         } = this.viewConfig;
         const path = 'conv-assist-answer';
         const queryParams = this.getBaseQueryParams();
@@ -64,6 +63,8 @@ class ConversationMessage extends TsEmbed {
             genNo,
             acSessionId,
             acGenNo,
+            convId,
+            messageId,
         });
 
         return `${this.getEmbedBasePath(query)}/embed/${path}${tsPostHashParams}`;
@@ -116,12 +117,11 @@ export class SpotterAgentEmbed {
         }
 
         const container = document.createElement('div');
-        if (this.viewConfig.containerClassName) {
-            container.className = this.viewConfig.containerClassName;
-        }
 
         const embed = new ConversationMessage(container, {
             ...this.viewConfig,
+            convId: data.convId,
+            messageId: data.messageId,
             sessionId: data.sessionId,
             genNo: data.genNo,
             acSessionId: data.stateKey.transactionId,
@@ -130,6 +130,30 @@ export class SpotterAgentEmbed {
         await embed.render();
         return { container, viz: embed };
     }
+
+    /**
+     * Send a message to the conversation service and return only the data.
+     * @param userMessage - The message to send to the conversation service.
+     * @returns The data from the conversation service.
+     */
+    public async sendMessageData(userMessage: string) {
+        try {
+            const { data, error } = await this.conversationService.sendMessage(userMessage);
+            if (error) {
+                return { error };
+            }
+            return { data: {
+                convId: data.convId,
+                messageId: data.messageId,
+                sessionId: data.sessionId,
+                genNo: data.genNo,
+                acSessionId: data.stateKey.transactionId,
+                acGenNo: data.stateKey.generationNumber,
+            } };
+        } catch (error) {
+            return { error: error as Error };
+        }
+    }
 }
 
 /**

package/src/embed/conversation.spec.ts

@@ -3,8 +3,8 @@ import {
     SpotterEmbedViewConfig,
 } from './conversation';
 import * as authInstance from '../auth';
-import { init } from '../index';
-import { AuthType } from '../types';
+import { Action, init } from '../index';
+import { AuthType, Param } from '../types';
 import {
     getDocumentBody,
     getIFrameSrc,
@@ -142,4 +142,42 @@ describe('ConversationEmbed', () => {
             `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&enableDataPanelV2=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
         );
     });
+
+    it('should render the conversation embed with hidden actions of InConversationTraining if set', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            dataPanelV2: true,
+            hiddenActions: [Action.InConversationTraining]
+        };
+
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&hideAction=[%22${Action.ReportError}%22,%22${Action.InConversationTraining}%22]&isSpotterExperienceEnabled=true&enableDataPanelV2=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
+
+    it('should render the conversation embed with disabled actions of InConversationTraining if set', async () => {
+        const disabledReason = 'testing disabled reason';
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            dataPanelV2: true,
+            disabledActions: [Action.InConversationTraining],
+            disabledActionReason: disabledReason,
+        };
+
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&${Param.DisableActions}=[%22${Action.InConversationTraining}%22]&${Param.DisableActionReason}=${disabledReason}&isSpotterExperienceEnabled=true&enableDataPanelV2=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
 });

package/src/embed/embedConfig.ts

@@ -10,13 +10,14 @@ const configKey = 'embedConfig';
  *
  * @example
  * ```js
+ * import { getInitConfig } from '@thoughtspot/visual-embed-sdk';
+ * // Call the getInitConfig method to retrieve the embed configuration
  * const config = getInitConfig();
+ * // Log the configuration settings
  * console.log(config);
  * ```
- * @example
- *
- * Returns the `EmbedConfig` object, which
- * contains the configuration settings used to
+ * Returns the link:https://developers.thoughtspot.com/docs/Interface_EmbedConfig[EmbedConfig]
+ * object, which contains the configuration settings used to
  * initialize the SDK, including the following:
  *
  *  - `thoughtSpotHost` - ThoughtSpot host URL
@@ -24,10 +25,11 @@ const configKey = 'embedConfig';
  * `AuthServerCookieless` for  `AuthType.TrustedAuthTokenCookieless`
  *  - `customizations` - Style, text, and icon customization settings
  *  that were applied during the SDK initialization.
- * 
- * For a comprehensive list of embed configuration settings,
- * see link:https://developers.thoughtspot.com/docs/Interface_EmbedConfig[Developer Documentation].
  *
+ * The following JSON output shows the embed configuration
+ * settings returned from the code in the previous example:
+ *
+ * @example
  * ```json
  * {
  *   "thoughtSpotHost": "https://{ThoughtSpot-Host}",
@@ -49,7 +51,7 @@ const configKey = 'embedConfig';
  *   "authTriggerContainer": "#your-own-div"
  *  }
  * ```
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.cl, and later
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw, and later
  * @group Global methods
  */
 export const getEmbedConfig = (): EmbedConfig => getValueFromWindow(configKey) || ({} as any);