@thoughtspot/visual-embed-sdk 1.39.2-alpha.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
@@ -1040,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
@@ -1073,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,
@@ -1564,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.
@@ -1577,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;
@@ -1619,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
@@ -1643,11 +1750,10 @@ 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' {
-    import { BaseViewConfig, RuntimeFilter, RuntimeParameter } from '@thoughtspot/visual-embed-sdk/types';
+    import { BaseViewConfig } from '@thoughtspot/visual-embed-sdk/types';
     import { TsEmbed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
     /**
         * Configuration for search options
@@ -1664,8 +1770,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
         */
     export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
             /**
-                * The ID of the data source object. For example, Model, View, or Table. Spotter uses
-                * this object to query data and generate Answers.
+                * The ID of the data source object. For example, Model, View, or Table. Spotter uses this object to query data and generate Answers.
                 */
             worksheetId: string;
             /**
@@ -1748,63 +1853,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
                 * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
                 */
             hideSampleQuestions?: boolean;
-            /**
-                * The list of runtime filters to apply to a search Answer,
-                * visualization, or Liveboard.
-                *
-                * Supported embed types: `SpotterEmbed`
-                * @example
-                * ```js
-                * const embed = new SpotterEmbed('#tsEmbed', {
-                *    ... // other embed view config
-                *    runtimeFilters: [
-                *           {
-                *             columnName: 'value',
-                *             operator: RuntimeFilterOp.EQ,
-                *             values: ['string' | 123 | true],
-                *           },
-                *       ],
-                * })
-                * ```
-                */
-            runtimeFilters?: RuntimeFilter[];
-            /**
-                * Flag to control whether runtime filters should be included in the URL.
-                * If true, filters will be passed via app initialization payload instead.
-                * If false/undefined, filters will be added to URL (default behavior).
-                *
-                * Supported embed types: `SpotterEmbed`
-                * @default false
-                */
-            excludeRuntimeFiltersfromURL?: boolean;
-            /**
-                * The list of runtime parameters to apply to the conversation.
-                *
-                * Supported embed types: `SpotterEmbed`
-                * @example
-                * ```js
-                * const embed = new SpotterEmbed('#tsEmbed', {
-                *    ... // other embed view config
-                *    runtimeParameters: [
-                *           {
-                *             name: 'Parameter Name',
-                *             value: 'Parameter Value',
-                *           },
-                *       ],
-                * })
-                * ```
-                */
-            runtimeParameters?: RuntimeParameter[];
-            /**
-                * Flag to control whether runtime parameters should be included in the URL.
-                * If true, parameters will be passed via app initialization payload instead.
-                * If false/undefined, parameters will be added to URL (default behavior).
-                *
-                * Supported embed types: `SpotterEmbed`
-                * @default false
-                *
-                */
-            excludeRuntimeParametersfromURL?: boolean;
     }
     /**
         * The configuration for the embedded spotterEmbed options.
@@ -2363,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;
     /**
@@ -3129,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.
@@ -4781,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
@@ -5863,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
@@ -5959,6 +6046,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             Query = "query",
             HideHomepageLeftNav = "hideHomepageLeftNav",
             ModularHomeExperienceEnabled = "modularHomeExperience",
+            ListPageVersion = "listpageVersion",
             PendoTrackingKey = "additionalPendoKey",
             LiveboardHeaderSticky = "isLiveboardHeaderSticky",
             IsProductTour = "isProductTour",
@@ -5996,7 +6084,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             CoverAndFilterOptionInPDF = "arePdfCoverFilterPageCheckboxesEnabled",
             PrimaryAction = "primaryAction",
             isSpotterAgentEmbed = "isSpotterAgentEmbed",
-            IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled"
+            IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled",
+            IsLazyLoadingForEmbedEnabled = "isLazyLoadingForEmbedEnabled",
+            RootMarginForLazyLoad = "rootMarginForLazyLoad"
     }
     /**
         * ThoughtSpot application pages include actions and menu commands

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.39.2-alpha.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({