@thoughtspot/visual-embed-sdk 1.39.1 → 1.39.2-alpha.2

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

@@ -11,7 +11,7 @@ declare module '@thoughtspot/visual-embed-sdk' {
       * @summary ThoughtSpot Visual Embed SDK
       * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
       */
-    import { AppEmbed, Page, AppViewConfig, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, DataPanelCustomColumnGroupsAccordionState } from '@thoughtspot/visual-embed-sdk/embed/app';
+    import { AppEmbed, Page, AppViewConfig, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, ListPage, DataPanelCustomColumnGroupsAccordionState } from '@thoughtspot/visual-embed-sdk/embed/app';
     import { init, prefetch, logout, executeTML, exportTML, executeTMLInput, exportTMLInput } from '@thoughtspot/visual-embed-sdk/embed/base';
     import { PinboardEmbed, LiveboardViewConfig, LiveboardEmbed } from '@thoughtspot/visual-embed-sdk/embed/liveboard';
     import { SearchEmbed, SearchViewConfig } from '@thoughtspot/visual-embed-sdk/embed/search';
@@ -30,7 +30,7 @@ declare module '@thoughtspot/visual-embed-sdk' {
     import { getAnswerFromQuery } from '@thoughtspot/visual-embed-sdk/utils/graphql/nlsService/nls-answer-service';
     import { createLiveboardWithAnswers } from '@thoughtspot/visual-embed-sdk/utils/liveboardService/liveboardService';
     import { UIPassthroughEvent } from '@thoughtspot/visual-embed-sdk/embed/hostEventClient/contracts';
-    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, };
     export { resetCachedAuthToken } from '@thoughtspot/visual-embed-sdk/authToken';
 }
 
@@ -129,6 +129,21 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 */
             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
@@ -142,6 +157,10 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * 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.
@@ -513,21 +532,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * ```
                 */
             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
                 *
@@ -544,6 +548,46 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * ```
                 */
             isLiveboardStylingAndGroupingEnabled?: boolean;
+            /**
+                * This flag is used to enable the full height lazy load data.
+                *
+                * @example
+                * ```js
+                * const embed = new AppEmbed('#embed-container', {
+                *    // ...other options
+                *    fullHeight: true,
+                *    lazyLoadingForFullHeight: true,
+                * })
+                * ```
+                *
+                * @type {boolean}
+                * @default false
+                * @version SDK: 1.39.0 | ThoughtSpot:10.10.0.cl
+                */
+            lazyLoadingForFullHeight?: boolean;
+            /**
+                * The margin to be used for lazy loading.
+                *
+                * For example, if the margin is set to '10px',
+                * the visualization will be loaded 10px before the its top edge is visible in the
+                * viewport.
+                *
+                * The format is similar to CSS margin.
+                *
+                * @example
+                * ```js
+                * const embed = new AppEmbed('#embed-container', {
+                *    // ...other options
+                *    fullHeight: true,
+                *    lazyLoadingForFullHeight: true,
+                *   // Using 0px, the visualization will be only loaded when its visible in the viewport.
+                *    lazyLoadingMargin: '0px',
+                * })
+                * ```
+                * @type {string}
+                * @version SDK: 1.39.0 | ThoughtSpot:10.10.0.cl
+                */
+            lazyLoadingMargin?: string;
     }
     /**
         * Embeds full ThoughtSpot experience in a host application.
@@ -580,6 +624,11 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
                 */
             navigateToPage(path: string | number, noReload?: boolean): void;
+            /**
+                * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
+                * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+                */
+            destroy(): void;
             /**
                 * Renders the embedded application pages in the ThoughtSpot app.
                 * @param renderOptions An object containing the page ID
@@ -985,23 +1034,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 * })
                 */
             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.
@@ -1057,6 +1089,46 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 * ```
                 */
             isLiveboardStylingAndGroupingEnabled?: boolean;
+            /**
+                * This flag is used to enable the full height lazy load data.
+                *
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed-container', {
+                *    // ...other options
+                *    fullHeight: true,
+                *    lazyLoadingForFullHeight: true,
+                * })
+                * ```
+                *
+                * @type {boolean}
+                * @default false
+                * @version SDK: 1.39.0 | ThoughtSpot:10.10.0.cl
+                */
+            lazyLoadingForFullHeight?: boolean;
+            /**
+                * The margin to be used for lazy loading.
+                *
+                * For example, if the margin is set to '10px',
+                * the visualization will be loaded 10px before the its top edge is visible in the
+                * viewport.
+                *
+                * The format is similar to CSS margin.
+                *
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed-container', {
+                *    // ...other options
+                *    fullHeight: true,
+                *    lazyLoadingForFullHeight: true,
+                *   // Using 0px, the visualization will be only loaded when its visible in the viewport.
+                *    lazyLoadingMargin: '0px',
+                * })
+                * ```
+                * @type {string}
+                * @version SDK: 1.39.0 | ThoughtSpot:10.10.0.cl
+                */
+            lazyLoadingMargin?: string;
     }
     /**
         * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -1090,6 +1162,11 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 * @returns A promise that resolves with the response from the embedded app
                 */
             trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
+            /**
+                * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
+                * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+                */
+            destroy(): void;
             /**
                 * Render an embedded ThoughtSpot Liveboard or visualization
                 * @param renderOptions An object specifying the Liveboard ID,
@@ -1581,10 +1658,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/bodyless-conversation' {
                 * 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.
@@ -1594,13 +1667,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/bodyless-conversation' {
         */
     export interface BodylessConversationViewConfig extends SpotterAgentEmbedViewConfig {
     }
-    interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConfig {
+    export interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConfig {
             sessionId: string;
             genNo: number;
             acSessionId: string;
             acGenNo: number;
     }
-    class ConversationMessage extends TsEmbed {
+    export class ConversationMessage extends TsEmbed {
             protected viewConfig: SpotterAgentMessageViewConfig;
             constructor(container: HTMLElement, viewConfig: SpotterAgentMessageViewConfig);
             getIframeSrc(): string;
@@ -1636,6 +1709,23 @@ declare module '@thoughtspot/visual-embed-sdk/embed/bodyless-conversation' {
                     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: {
+                            sessionId: any;
+                            genNo: any;
+                            acSessionId: any;
+                            acGenNo: any;
+                    };
+                    error?: undefined;
+            }>;
     }
     /**
         * Create a conversation embed, which can be integrated inside
@@ -1660,7 +1750,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/bodyless-conversation' {
     export class BodylessConversation extends SpotterAgentEmbed {
             constructor(viewConfig: BodylessConversationViewConfig);
     }
-    export {};
 }
 
 declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
@@ -2322,7 +2411,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * 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;
     /**
@@ -3088,6 +3183,20 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @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.
@@ -3465,6 +3574,22 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```
                 */
             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 {
     }
@@ -4724,7 +4849,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * Emitted when a user exits present mode.
                 * @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
                 */
-            ExitPresentMode = "exitPresentMode"
+            ExitPresentMode = "exitPresentMode",
+            /**
+                * Emitted when a user requests the full height lazy load data.
+                * @version SDK : 1.39.0 | ThoughtSpot : 10.10.0.cl
+                * @hidden
+                */
+            RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates"
     }
     /**
         * Event types that can be triggered by the host application
@@ -5806,7 +5937,20 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *```
                 * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
                 */
-            ExitPresentMode = "exitPresentMode"
+            ExitPresentMode = "exitPresentMode",
+            /**
+                * Triggers the full height lazy load data.
+                * @example
+                * ```js
+                * liveboardEmbed.on(EmbedEvent.RequestVisibleEmbedCoordinates, (payload) => {
+                *      console.log(payload);
+                * });
+                * ```
+                * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+                *
+                * @hidden
+                */
+            VisibleEmbedCoordinates = "visibleEmbedCoordinates"
     }
     /**
         * The different visual modes that the data sources panel within
@@ -5902,6 +6046,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             Query = "query",
             HideHomepageLeftNav = "hideHomepageLeftNav",
             ModularHomeExperienceEnabled = "modularHomeExperience",
+            ListPageVersion = "listpageVersion",
             PendoTrackingKey = "additionalPendoKey",
             LiveboardHeaderSticky = "isLiveboardHeaderSticky",
             IsProductTour = "isProductTour",
@@ -5936,10 +6081,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             DataSourceId = "dataSourceId",
             preAuthCache = "preAuthCache",
             ShowSpotterLimitations = "showSpotterLimitations",
-            CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
+            CoverAndFilterOptionInPDF = "arePdfCoverFilterPageCheckboxesEnabled",
             PrimaryAction = "primaryAction",
             isSpotterAgentEmbed = "isSpotterAgentEmbed",
-            IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled"
+            IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled",
+            IsLazyLoadingForEmbedEnabled = "isLazyLoadingForEmbedEnabled",
+            RootMarginForLazyLoad = "rootMarginForLazyLoad"
     }
     /**
         * ThoughtSpot application pages include actions and menu commands
@@ -7159,7 +7306,23 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```
                 *  @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;
@@ -8083,13 +8246,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/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
@@ -8098,9 +8262,10 @@ declare module '@thoughtspot/visual-embed-sdk/embed/embedConfig' {
         *  - `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}",
@@ -8122,7 +8287,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/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;

package/package.json

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

package/src/config.spec.ts

@@ -21,6 +21,17 @@ 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({