@thoughtspot/visual-embed-sdk 1.39.2 → 1.39.3

package/dist/visual-embed-sdk.d.ts

@@ -12,7 +12,7 @@ import EventEmitter from 'eventemitter3';
   * @summary ThoughtSpot Visual Embed SDK
   * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
   */
-export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversationViewConfig, BodylessConversation, SpotterEmbed, SpotterEmbedViewConfig, ConversationViewConfig, ConversationEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, DataPanelCustomColumnGroupsAccordionState, };
+export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversationViewConfig, BodylessConversation, SpotterEmbed, SpotterEmbedViewConfig, ConversationViewConfig, ConversationEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, ListPage, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, DataPanelCustomColumnGroupsAccordionState, };
 
 /**
     * Copyright (c) 2022
@@ -106,6 +106,21 @@ 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
@@ -119,6 +134,10 @@ export interface DiscoveryExperience {
             * homePage determines the version of the home page.
             */
         homePage?: HomePage;
+        /**
+            * listPageVersion determines the version of the list page.
+            */
+        listPageVersion?: ListPage;
 }
 /**
     * The view configuration for full app embedding.
@@ -490,21 +509,6 @@ 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
             *
@@ -953,23 +957,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
             * })
             */
         dataSourceId?: string;
-        /**
-            * This flag is for show/hide checkboxes for include or exclude
-            * cover page and filters in the Liveboard PDF.
-            *
-            * Supported embed types: `LiveboardEmbed`
-            * @version SDK: 1.37.0 | ThoughtSpot:10.8.0.cl
-            * @default true
-            * Supported embed types: `LiveboardEmbed`
-            * @example
-            * ```js
-            * const embed = new LiveboardEmbed('#tsEmbed', {
-            *    ... //other embed view config
-            *    coverAndFilterOptionInPDF: false,
-            * })
-            * ```
-            */
-        coverAndFilterOptionInPDF?: boolean;
         /**
             * The list of tab IDs to hide from the embedded.
             * This Tabs will be hidden from their respective LBs.
@@ -1536,10 +1523,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;
 }
 /**
     * Configuration for conversation options.
@@ -1549,13 +1532,15 @@ export interface SpotterAgentEmbedViewConfig extends Omit<BaseViewConfig, 'prima
     */
 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 {
         protected viewConfig: SpotterAgentMessageViewConfig;
         constructor(container: HTMLElement, viewConfig: SpotterAgentMessageViewConfig);
         getIframeSrc(): string;
@@ -1591,6 +1576,25 @@ export class SpotterAgentEmbed {
                 viz: ConversationMessage;
                 error?: undefined;
         }>;
+        /**
+            * 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.
+            */
+        sendMessageData(userMessage: string): Promise<{
+                error: any;
+                data?: undefined;
+        } | {
+                data: {
+                        convId: any;
+                        messageId: any;
+                        sessionId: any;
+                        genNo: any;
+                        acSessionId: any;
+                        acGenNo: any;
+                };
+                error?: undefined;
+        }>;
 }
 /**
     * Create a conversation embed, which can be integrated inside
@@ -1615,7 +1619,6 @@ export class SpotterAgentEmbed {
 export class BodylessConversation extends SpotterAgentEmbed {
         constructor(viewConfig: BodylessConversationViewConfig);
 }
-export {};
 
 /**
     * Configuration for search options
@@ -2263,7 +2266,13 @@ export enum HomeLeftNavItem {
             * available when new navigation V3 is enabled.
             * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
             */
-        Spotter = "spotter"
+        Spotter = "spotter",
+        /**
+            * Favorites option in the insights left navigation,
+            * available when new navigation V3 is enabled.
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+            */
+        Favorites = "favorites"
 }
 export type DOMSelector = string | HTMLElement;
 /**
@@ -3029,6 +3038,20 @@ export interface BaseViewConfig {
             * @private
             */
         insertInToSlide?: boolean;
+        /**
+            * Show alert messages and toast messages in the embed.
+            * Supported embed in all embed types.
+            *
+            * @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;
 }
 /**
     * The configuration object for Home page embeds configs.
@@ -3406,6 +3429,22 @@ export interface LiveboardAppEmbedViewConfig {
             * ```
             */
         enableAskSage?: boolean;
+        /**
+         * This flag is used to show or hide checkboxes for including or excluding
+         * the cover and filters pages in the Liveboard PDF.
+         *
+         * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+         * @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
+         * @example
+         * ```js
+         * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+         * const embed = new <EmbedComponent>('#tsEmbed', {
+         *    ... // other embed view config
+         *    coverAndFilterOptionInPDF: false,
+         * })
+         * ```
+         */
+        coverAndFilterOptionInPDF?: boolean;
 }
 export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {
 }
@@ -4665,7 +4704,84 @@ export enum EmbedEvent {
             * Emitted when a user exits present mode.
             * @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
             */
-        ExitPresentMode = "exitPresentMode"
+        ExitPresentMode = "exitPresentMode",
+        /**
+            * Emitted when spotter response is text data
+            * @example
+            * ```js
+            * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
+            *     console.log('payload', payload);
+            * })
+            *```
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+            */
+        SpotterData = "SpotterData",
+        /**
+            * Emitted when user opens up the worksheet preview modal in spotter embed.
+            * @example
+            * ```js
+            * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
+            *     console.log('payload', payload);
+            * })
+            *```
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+            */
+        PreviewSpotterData = "PreviewSpotterData",
+        /**
+            * Emitted when the spotter query is triggered in spotter embed.
+            * @example
+            * ```js
+            * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
+            *     console.log('payload', payload);
+            * })
+            *```
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+            */
+        SpotterQueryTriggered = "SpotterQueryTriggered",
+        /**
+            * Emitted when the last spotter query is edited in spotter embed.
+            * @example
+            * ```js
+            * spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
+            *     console.log('payload', payload);
+            * })
+            *```
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+            */
+        LastPromptEdited = "LastPromptEdited",
+        /**
+            * Emitted when the last spotter query is deleted in spotter embed.
+            * @example
+            * ```js
+            * spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
+            *     console.log('payload', payload);
+            * })
+            *```
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+            */
+        LastPromptDeleted = "LastPromptDeleted",
+        /**
+            * Emitted when the coversation is reset in spotter embed.
+            * @example
+            * ```js
+            * spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
+            *     console.log('payload', payload);
+            * })
+            *```
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+            */
+        ResetSpotterConversation = "ResetSpotterConversation",
+        /**
+            * Emitted when the *Spotter* is initialized.
+            * @example
+            * ```js
+            * spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
+            *     console.log('payload', payload);
+            * })
+            *```
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+            */
+        SpotterInit = "SpotterInit"
 }
 /**
     * Event types that can be triggered by the host application
@@ -4954,6 +5070,7 @@ export enum HostEvent {
             * @param
             * `vizId`-  GUID of the saved Answer or visualization to pin to a Liveboard.
             *  Optional when pinning a new chart or table generated from a Search query.
+            *  **Required** in Spotter Embed.
             * @param
             * `liveboardID` - GUID of the Liveboard to pin an Answer. If there is no Liveboard,
             *  specify the `newLiveboardName` parameter to create a new Liveboard.
@@ -5001,6 +5118,12 @@ export enum HostEvent {
             * ```js
             * appEmbed.trigger(HostEvent.Pin)
             * ```
+            * @example
+            * ```js
+            * const pinResponse = await spotterEmbed.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",
@@ -5094,6 +5217,12 @@ export enum HostEvent {
             * ```js
             * searchEmbed.trigger(HostEvent.MakeACopy)
             * ```
+            * @example
+            * ```js
+            * const pinResponse = await spotterEmbed.trigger(HostEvent.MakeACopy, {
+            *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
+            *  });
+            * ```
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         MakeACopy = "makeACopy",
@@ -5166,6 +5295,7 @@ export enum HostEvent {
             * This event is not supported in visualization embed and search embed.
             * @param - object - To trigger the action for a specific visualization
             * in Liveboard embed, pass in `vizId` as a key.
+            * **Required** in Spotter embed.
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.Edit)
@@ -5174,6 +5304,12 @@ export enum HostEvent {
             * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
             * '730496d6-6903-4601-937e-2c691821af3c'})
             * ```
+            * @example
+            * ```js
+            * const pinResponse = await spotterEmbed.trigger(HostEvent.Edit, {
+            *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
+            *  });
+            * ```
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         Edit = "edit",
@@ -5221,6 +5357,16 @@ export enum HostEvent {
             *   );
             * })
             * ```
+            * @example
+            * ```js
+            * spotterEmbed.trigger(HostEvent.GetTML, {
+            *   vizId: '730496d6-6903-4601-937e-2c691821af3c'
+            * }).then((tml) => {
+            *   console.log(
+            *      tml.answer.search_query // TML representation of the search query
+            *   );
+            * })
+            * ```
             * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
             * @important
             */
@@ -5308,7 +5454,12 @@ export enum HostEvent {
             * vizEmbed.trigger(HostEvent.DownloadAsPng)
             *
             * searchEmbed.trigger(HostEvent.DownloadAsPng)
+            *
+            * spotterEmbed.trigger(HostEvent.DownloadAsPng, {
+            *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
+            * })
             * ```
+            *
             * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
             */
         DownloadAsPng = "downloadAsPng",
@@ -5326,6 +5477,11 @@ export enum HostEvent {
             * ```js
             * searchEmbed.trigger(HostEvent.DownloadAsCsv)
             * ```
+            * ```js
+            * spotterEmbed.trigger(HostEvent.DownloadAsCsv, {
+            *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
+            * })
+            * ```
             * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
             */
         DownloadAsCsv = "downloadAsCSV",
@@ -5343,6 +5499,11 @@ export enum HostEvent {
             * ```js
             * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
             * ```
+            * ```js
+            * spotterEmbed.trigger(HostEvent.downloadAsXLSX, {
+            *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
+            * })
+            * ```
             * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
             */
         DownloadAsXlsx = "downloadAsXLSX",
@@ -5362,6 +5523,7 @@ export enum HostEvent {
         /**
             * Trigger the **Save**  action on a Liveboard or Answer.
             * Saves the changes.
+            * @param - `vizId` is required in Spotter Embed.
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.Save)
@@ -5369,6 +5531,11 @@ export enum HostEvent {
             * ```js
             * searchEmbed.trigger(HostEvent.Save)
             * ```
+            * ```js
+            * spotterEmbed.trigger(HostEvent.Save, {
+            *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
+            * })
+            * ```
             * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
             */
         Save = "save",
@@ -5652,7 +5819,7 @@ export enum HostEvent {
         ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
         /**
             * Triggers an action to update Parameter values on embedded
-            * Answers and Liveboard.
+            * Answers, Liveboard and Spotter answer in Edit mode.
             *
             * @example
             * ```js
@@ -5671,6 +5838,13 @@ export enum HostEvent {
             *  console.log('parameters', parameter);
             * });
             *```
+            *```js
+            * spotterEmbed.trigger(HostEvent.GetParameters, {
+            *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
+            * }).then((parameter) => {
+            *  console.log('parameters', parameter);
+            * });
+            *```
             * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
             */
         GetParameters = "GetParameters",
@@ -5738,6 +5912,64 @@ export enum HostEvent {
             * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
             */
         TransformTableVizData = "TransformTableVizData",
+        /**
+            * Triggers a search operation with the search tokens specified in
+            * the search query string in spotter embed.
+            * @param - `queryString`: Text string in Natural Language format
+            * @param - `executeSearch`: Boolean to execute search and update search query
+            * @example
+            * ```js
+            * spotterEmbed.trigger(HostEvent.SpotterSearch, {
+            *  query: 'revenue per year',
+            *  executeSearch: true,
+            * })
+            * ```
+            */
+        SpotterSearch = "SpotterSearch",
+        /**
+            * Edits the last prompt in spotter embed.
+            * @param - `query`: Text string
+            * @example
+            * ```js
+            * spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year");
+            * ```
+            */
+        EditLastPrompt = "EditLastPrompt",
+        /**
+            * Opens the Worksheet preview modal in Spotter Embed.
+            * @example
+            * ```js
+            * spotterEmbed.trigger(HostEvent.PreviewSpotterData);
+            * ```
+            */
+        PreviewSpotterData = "PreviewSpotterData",
+        /**
+            * Resets the Spotter Embed Conversation.
+            * @example
+            * ```js
+            * spotterEmbed.trigger(HostEvent.ResetSpotterConversation);
+            * ```
+            */
+        ResetSpotterConversation = "ResetSpotterConversation",
+        /**
+            * Deletes the last prompt in spotter embed.
+            * @example
+            * ```js
+            * spotterEmbed.trigger(HostEvent.DeleteLastPrompt);
+            * ```
+            */
+        DeleteLastPrompt = "DeleteLastPrompt",
+        /**
+            * Toggle the visualization to chart or table view.
+            * @param - `vizId ` In Spotter Embed, vizId is required.
+            * @example
+            * ```js
+            * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, {
+            *          vizId:"'b535c760-8bbe-4e6f-bb26-af56b4129a1e'"
+            * });
+            *```
+            */
+        AnswerChartSwitcher = "answerChartSwitcher",
         /**
             * @hidden
             * Trigger exit from presentation mode when user exits fullscreen.
@@ -5747,7 +5979,17 @@ export enum HostEvent {
             *```
             * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
             */
-        ExitPresentMode = "exitPresentMode"
+        ExitPresentMode = "exitPresentMode",
+        /**
+            * Trigger the *Ask Sage* action for visualizations
+            * @example
+            * ```js
+            * liveboardEmbed.trigger(HostEvent.AskSpotter,
+            * {containerId:'730496d6-6903-4601-937e-2c691821af3c'})
+            * ```
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+            */
+        AskSpotter = "askSpotter"
 }
 /**
     * The different visual modes that the data sources panel within
@@ -5843,6 +6085,7 @@ export enum Param {
         Query = "query",
         HideHomepageLeftNav = "hideHomepageLeftNav",
         ModularHomeExperienceEnabled = "modularHomeExperience",
+        ListPageVersion = "listpageVersion",
         PendoTrackingKey = "additionalPendoKey",
         LiveboardHeaderSticky = "isLiveboardHeaderSticky",
         IsProductTour = "isProductTour",
@@ -5877,7 +6120,7 @@ export enum Param {
         DataSourceId = "dataSourceId",
         preAuthCache = "preAuthCache",
         ShowSpotterLimitations = "showSpotterLimitations",
-        CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
+        CoverAndFilterOptionInPDF = "arePdfCoverFilterPageCheckboxesEnabled",
         PrimaryAction = "primaryAction",
         isSpotterAgentEmbed = "isSpotterAgentEmbed",
         IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled"
@@ -7100,7 +7343,23 @@ export enum Action {
             * ```
             *  @version SDK: 1.37.0 | ThoughtSpot Cloud: 10.8.0.cl
             */
-        CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF"
+        CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
+        /**
+            * Action ID for hide or disable the
+            * Spotter in conversation training widget.
+            * The Add to Coaching feature is currently in beta
+            * and is disabled by default on embed deployments.
+            * To enable this feature on your instance,
+            * contact ThoughtSpot Support.
+            *  @example
+            * ```js
+            * hiddenAction: [Action.InConversationTraining]
+            * disabledActions: [Action.InConversationTraining]
+            *
+            * ```
+            *  @version SDK: 1.39.0 | ThoughtSpot Cloud: 10.10.0.cl
+            */
+        InConversationTraining = "InConversationTraining"
 }
 export interface AnswerServiceType {
         getAnswer?: (offset: number, batchSize: number) => any;
@@ -8012,13 +8271,14 @@ export class AnswerService {
     *
     * @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
@@ -8027,9 +8287,10 @@ export class AnswerService {
     *  - `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}",
@@ -8051,7 +8312,7 @@ export class AnswerService {
     *   "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;

package/lib/package.json

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

package/lib/src/config.spec.js

@@ -16,6 +16,15 @@ describe('getThoughtSpotHost', () => {
         };
         expect(testFn).toThrow(Error);
     });
+    test('invalid URL format', () => {
+        const testFn = () => {
+            getThoughtSpotHost({
+                ...embedConfig,
+                thoughtSpotHost: '',
+            });
+        };
+        expect(testFn).toThrow('Error parsing ThoughtSpot host. Please provide a valid URL.');
+    });
     test('IP address/hostname only', () => {
         expect(getThoughtSpotHost({
             ...embedConfig,

package/lib/src/config.spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.spec.js","sourceRoot":"","sources":["../../src/config.spec.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC,MAAM,WAAW,GAAG;IAChB,QAAQ,EAAE,QAAQ,CAAC,GAAG;CACzB,CAAC;AAEF,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAChC,IAAI,CAAC,gBAAgB,EAAE,GAAG,EAAE;QACxB,MAAM,MAAM,GAAG,GAAG,EAAE;YAChB,kBAAkB,CAAC;gBACf,GAAG,WAAW;gBACd,eAAe,EAAE,IAAI;aACxB,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0BAA0B,EAAE,GAAG,EAAE;QAClC,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,eAAe,EAAE,SAAS;SAC7B,CAAC,CACL,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAE1B,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,eAAe,EAAE,QAAQ;SAC5B,CAAC,CACL,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wBAAwB,EAAE,GAAG,EAAE;QAChC,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,eAAe,EAAE,eAAe;SACnC,CAAC,CACL,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,eAAe,EAAE,qBAAqB;SACzC,CAAC,CACL,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAC1B,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,eAAe,EAAE,+CAA+C;SACnE,CAAC,CACL,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,QAAQ,EAAE,QAAQ,CAAC,IAAI;YACvB,eAAe,EAAE,+CAA+C;SACnE,CAAC,CACL,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACpC,MAAM,QAAQ,GAAG,aAAa,CAAC;YAC3B,QAAQ,EAAE,MAAM;YAChB,eAAe,EAAE,EAAE;YACnB,QAAQ,EAAE,QAAQ,CAAC,IAAI;SAC1B,CAAC,CAAC;QACH,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
+{"version":3,"file":"config.spec.js","sourceRoot":"","sources":["../../src/config.spec.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC,MAAM,WAAW,GAAG;IAChB,QAAQ,EAAE,QAAQ,CAAC,GAAG;CACzB,CAAC;AAEF,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAChC,IAAI,CAAC,gBAAgB,EAAE,GAAG,EAAE;QACxB,MAAM,MAAM,GAAG,GAAG,EAAE;YAChB,kBAAkB,CAAC;gBACf,GAAG,WAAW;gBACd,eAAe,EAAE,IAAI;aACxB,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAC5B,MAAM,MAAM,GAAG,GAAG,EAAE;YAChB,kBAAkB,CAAC;gBACf,GAAG,WAAW;gBACd,eAAe,EAAE,EAAE;aACtB,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,6DAA6D,CAAC,CAAC;IAC1F,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0BAA0B,EAAE,GAAG,EAAE;QAClC,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,eAAe,EAAE,SAAS;SAC7B,CAAC,CACL,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAE1B,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,eAAe,EAAE,QAAQ;SAC5B,CAAC,CACL,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wBAAwB,EAAE,GAAG,EAAE;QAChC,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,eAAe,EAAE,eAAe;SACnC,CAAC,CACL,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,eAAe,EAAE,qBAAqB;SACzC,CAAC,CACL,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAC1B,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,eAAe,EAAE,+CAA+C;SACnE,CAAC,CACL,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,QAAQ,EAAE,QAAQ,CAAC,IAAI;YACvB,eAAe,EAAE,+CAA+C;SACnE,CAAC,CACL,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACpC,MAAM,QAAQ,GAAG,aAAa,CAAC;YAC3B,QAAQ,EAAE,MAAM;YAChB,eAAe,EAAE,EAAE;YACnB,QAAQ,EAAE,QAAQ,CAAC,IAAI;SAC1B,CAAC,CAAC;QACH,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}