@thoughtspot/visual-embed-sdk 1.39.3 → 1.40.1-alpha.1

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

@@ -548,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.40.0 | ThoughtSpot:10.12.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.40.0 | ThoughtSpot:10.12.0.cl
+                */
+            lazyLoadingMargin?: string;
     }
     /**
         * Embeds full ThoughtSpot experience in a host application.
@@ -584,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
@@ -1044,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.40.0 | ThoughtSpot:10.12.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.40.0 | ThoughtSpot:10.12.0.cl
+                */
+            lazyLoadingMargin?: string;
     }
     /**
         * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -1077,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,
@@ -1582,8 +1672,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/bodyless-conversation' {
             genNo: number;
             acSessionId: string;
             acGenNo: number;
-            convId: string;
-            messageId: string;
     }
     export class ConversationMessage extends TsEmbed {
             protected viewConfig: SpotterAgentMessageViewConfig;
@@ -1631,8 +1719,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/bodyless-conversation' {
                     data?: undefined;
             } | {
                     data: {
-                            convId: any;
-                            messageId: any;
                             sessionId: any;
                             genNo: any;
                             acSessionId: any;
@@ -4765,82 +4851,11 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             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
+                * Emitted when a user requests the full height lazy load data.
+                * @version SDK : 1.39.0 | ThoughtSpot : 10.10.0.cl
+                * @hidden
                 */
-            SpotterInit = "SpotterInit"
+            RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates"
     }
     /**
         * Event types that can be triggered by the host application
@@ -5129,7 +5144,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @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.
@@ -5177,12 +5191,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```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",
@@ -5276,12 +5284,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```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",
@@ -5354,7 +5356,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * 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)
@@ -5363,12 +5364,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * 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",
@@ -5416,16 +5411,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *   );
                 * })
                 * ```
-                * @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
                 */
@@ -5513,12 +5498,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * 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",
@@ -5536,11 +5516,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```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",
@@ -5558,11 +5533,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```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",
@@ -5582,7 +5552,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * 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)
@@ -5590,11 +5559,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```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",
@@ -5878,7 +5842,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
             /**
                 * Triggers an action to update Parameter values on embedded
-                * Answers, Liveboard and Spotter answer in Edit mode.
+                * Answers and Liveboard.
                 *
                 * @example
                 * ```js
@@ -5897,13 +5861,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *  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",
@@ -5971,64 +5928,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @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.
@@ -6040,15 +5939,18 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             ExitPresentMode = "exitPresentMode",
             /**
-                * Trigger the *Ask Sage* action for visualizations
+                * Triggers the full height lazy load data.
                 * @example
                 * ```js
-                * liveboardEmbed.trigger(HostEvent.AskSpotter,
-                * {containerId:'730496d6-6903-4601-937e-2c691821af3c'})
+                * liveboardEmbed.on(EmbedEvent.RequestVisibleEmbedCoordinates, (payload) => {
+                *      console.log(payload);
+                * });
                 * ```
-                * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+                * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+                *
+                * @hidden
                 */
-            AskSpotter = "askSpotter"
+            VisibleEmbedCoordinates = "visibleEmbedCoordinates"
     }
     /**
         * The different visual modes that the data sources panel within
@@ -6182,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.3",
+    "version": "1.40.1-alpha.1",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",
@@ -57,7 +57,6 @@
         "test": "npm run test-sdk",
         "posttest": "cat ./coverage/sdk/lcov.info | coveralls",
         "is-publish-allowed": "node scripts/is-publish-allowed.js",
-        "prepublishOnly": "npm run is-publish-allowed && npm run test && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build",
         "check-size": "npm run build && size-limit",
         "publish-dev": "npm publish --tag dev",
         "publish-prod": "npm publish --tag latest",