@thoughtspot/visual-embed-sdk 1.30.0-alpha.1 → 1.30.0

package/src/embed/liveboard.ts

@@ -4,28 +4,19 @@
  * Embed a ThoughtSpot Liveboard or visualization
  * https://developers.thoughtspot.com/docs/?pageid=embed-pinboard
  * https://developers.thoughtspot.com/docs/?pageid=embed-a-viz
- *
  * @summary Liveboard & visualization embed
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
 
 import { ERROR_MESSAGE } from '../errors';
 import {
-    EmbedEvent,
-    MessagePayload,
-    Param,
-    RuntimeFilter,
-    DOMSelector,
-    HostEvent,
-    ViewConfig,
+    DOMSelector, EmbedEvent, HostEvent, MessagePayload, Param, ViewConfig,
 } from '../types';
 import { getQueryParamString, isUndefined } from '../utils';
-import { getAuthPromise } from './base';
 import { V1Embed } from './ts-embed';
 
 /**
  * The configuration for the embedded Liveboard or visualization page view.
- *
  * @group Embed components
  */
 export interface LiveboardViewConfig
@@ -42,9 +33,7 @@ export interface LiveboardViewConfig
      * visualizations to display on the screen.
      * Setting `fullHeight` to `false` fetches visualizations
      * incrementally as users scroll the page to view the charts and tables.
-     *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
-     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed', {
@@ -58,7 +47,6 @@ export interface LiveboardViewConfig
      * This is the minimum height(in pixels) for a full-height Liveboard.
      * Setting this height helps resolve issues with empty Liveboards and
      * other screens navigable from a Liveboard.
-     *
      * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
      * @default 500
      * @example
@@ -73,7 +61,6 @@ export interface LiveboardViewConfig
     defaultHeight?: number;
     /**
      * @Deprecated If set to true, the context menu in visualizations will be enabled.
-     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -81,14 +68,12 @@ export interface LiveboardViewConfig
      *    enableVizTransformations:true,
      * })
      * ```
-     *
      * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
      */
     enableVizTransformations?: boolean;
     /**
      * The Liveboard to display in the embedded view.
      * Use either liveboardId or pinboardId to reference the Liveboard to embed.
-     *
      * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
      * @example
      * ```js
@@ -100,15 +85,12 @@ export interface LiveboardViewConfig
     liveboardId?: string;
     /**
      * To support backward compatibility
-     *
      * @hidden
      */
     pinboardId?: string;
     /**
      * The visualization within the Liveboard to display.
-     *
      * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
-     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {
@@ -121,7 +103,6 @@ export interface LiveboardViewConfig
     /**
      * If set to true, all filter chips from a
      * Liveboard page will be read-only (no X buttons)
-     *
      * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
      * @example
      * ```js
@@ -136,9 +117,7 @@ export interface LiveboardViewConfig
      * Array of visualization IDs which should be visible when the Liveboard
      * renders. This can be changed by triggering the `SetVisibleVizs`
      * event.
-     *
      * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
-     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {
@@ -152,14 +131,12 @@ export interface LiveboardViewConfig
     visibleVizs?: string[];
     /**
      * To support backward compatibility
-     *
      * @hidden
      */
     preventPinboardFilterRemoval?: boolean;
     /**
      * Render embedded Liveboards and visualizations in the
      * new Liveboard experience mode.
-     *
      * @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
      * @example
      * ```js
@@ -173,7 +150,6 @@ export interface LiveboardViewConfig
     /**
      * Set a Liveboard tab as an active tab.
      * Specify the tab ID.
-     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -186,9 +162,7 @@ export interface LiveboardViewConfig
     activeTabId?: string;
     /**
      * Show or hide the tab panel of the embedded Liveboard.
-     *
      * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
-     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {
@@ -200,7 +174,6 @@ export interface LiveboardViewConfig
     hideTabPanel?: boolean;
     /**
      * Show or hide the Liveboard header.
-     *
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
      * @default false
      * @example
@@ -216,7 +189,6 @@ export interface LiveboardViewConfig
      * Show or hide the Liveboard title.
      * @default false
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
-     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {
@@ -230,7 +202,6 @@ export interface LiveboardViewConfig
      * Show or hide the Liveboard description.
      * @default false
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
-     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {
@@ -244,7 +215,6 @@ export interface LiveboardViewConfig
      * Control the position and visibility of
      * the Liveboard header as the users scroll down the
      * embedded Liveboard page.
-     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed', {
@@ -257,7 +227,6 @@ export interface LiveboardViewConfig
     isLiveboardHeaderSticky?: boolean;
     /**
      * enable or disable ask sage
-     *
      * @default false
      * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
      * @example
@@ -271,11 +240,9 @@ export interface LiveboardViewConfig
     enableAskSage?: boolean;
     /**
      * This flag is used to enable the 2 column layout in liveboard
-     *
      * @type {boolean}
      * @default false
      * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
-     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {
@@ -291,7 +258,6 @@ export interface LiveboardViewConfig
  * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
  * waits for the authentication to complete, so you need not wait for
  * `AuthStatus.SUCCESS`.
- *
  * @example
  * ```js
  * import { .. } from '@thoughtspot/visual-embed-sdk';
@@ -429,7 +395,6 @@ export class LiveboardEmbed extends V1Embed {
     /**
      * Set the iframe height as per the computed height received
      * from the ThoughtSpot app.
-     *
      * @param data The event payload
      */
     private updateIFrameHeight = (data: MessagePayload) => {
@@ -483,7 +448,6 @@ export class LiveboardEmbed extends V1Embed {
 
     /**
      * Triggers an event to the embedded app
-     *
      * @param messageType The event type
      * @param data The payload to send with the message
      */
@@ -501,7 +465,6 @@ export class LiveboardEmbed extends V1Embed {
 
     /**
      * Render an embedded ThoughtSpot Liveboard or visualization
-     *
      * @param renderOptions An object specifying the Liveboard ID,
      * visualization ID and the runtime filters.
      */

package/src/embed/sage.ts

@@ -2,7 +2,6 @@
  * Copyright (c) 2023
  *
  * Embed ThoughtSpot Sage
- *
  * @summary TS Sage embed
  * @author Mourya Balabhadra <mourya.balabhadra@thoughtspot.com>
  */
@@ -31,7 +30,6 @@ export interface SearchOptions {
 /**
  * The configuration attributes for the embedded Natural language search view. Based on
  * GPT and LLM.
- *
  * @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
  * @group Embed components
  */
@@ -44,7 +42,6 @@ export interface SageViewConfig
      * If set to true, a list of Liveboard and Answers related
      * to the natural language search will be shown below the
      * AI generated answer.
-     *
      * @deprecated Currently Liveboard and Answers related
      * to the natural language search will not be shown for sage
      * embed
@@ -52,11 +49,10 @@ export interface SageViewConfig
     showObjectResults?: boolean;
     /**
      * flag used by the TS product tour page to show the blue search bar
-     * even after the search is completed. This is different from Thoughtspot Embedded Sage Embed
-     * experience where it mimics closer to the non-embed case.
+     * even after the search is completed. This is different from Thoughtspot Embedded
+     * Sage Embed experience where it mimics closer to the non-embed case.
      * The Sample questions container is collapsed when this value is set after
      * does a search.
-     *
      * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
      * @hidden
      */
@@ -64,38 +60,32 @@ export interface SageViewConfig
     /**
      * Show or hide the search bar title.
      * @version SDK: 1.29.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
-     *
      * @deprecated Thoughtspot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
      */
     hideSearchBarTitle?: boolean;
     /**
      * Show or hide the Answer header, that is, the `AI Answer` title
      * at the top of the Answer page.
-     *
      * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
      */
     hideSageAnswerHeader?: boolean;
     /**
      * Disable the worksheet selection option.
-     *
      * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
      */
     disableWorksheetChange?: boolean;
     /**
      * Hide the worksheet selection panel.
-     *
      * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
      */
     hideWorksheetSelector?: boolean;
     /**
      * Show or hide autocomplete suggestions for the search query string.
-     *
      * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
      */
     hideAutocompleteSuggestions?: boolean;
     /**
      * Show or hide autocomplete suggestions for the search query string.
-     *
      * @deprecated
      * Currently, the object suggestions will not be shown for Natural Language Search.
      * You can use {@link hideAutocompleteSuggestions} instead.
@@ -105,7 +95,6 @@ export interface SageViewConfig
      * Show or hide sample questions.
      * The sample questions are autogenerated based on the worksheet
      * selected for the search operation.
-     *
      * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
      */
     hideSampleQuestions?: boolean;
@@ -123,7 +112,6 @@ export interface SageViewConfig
      * If it is executed, the focus is placed on the results.
      * If it’s not executed, the focus is placed at the end of
      * the token string in the search bar.
-     *
      * @example
      * ```js
      * searchOptions: {
@@ -137,7 +125,6 @@ export interface SageViewConfig
 }
 /**
  * Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
- *
  * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
  * @group Embed components
  */
@@ -157,7 +144,6 @@ export class SageEmbed extends V1Embed {
     /**
      * Constructs a map of parameters to be passed on to the
      * embedded Eureka or Sage search page.
-     *
      * @returns {string} query string
      */
     protected getEmbedParams(): string {
@@ -191,7 +177,6 @@ export class SageEmbed extends V1Embed {
     /**
      * Construct the URL of the embedded ThoughtSpot sage to be
      * loaded in the iframe
-     *
      * @returns {string} iframe url
      */
     public getIFrameSrc(): string {
@@ -217,7 +202,6 @@ export class SageEmbed extends V1Embed {
 
     /**
      * Render the embedded ThoughtSpot Sage
-     *
      * @returns {SageEmbed} Eureka/Sage embed
      */
     public async render(): Promise<SageEmbed> {

package/src/embed/search-bar.tsx

@@ -21,11 +21,8 @@ export interface SearchBarViewConfig
     /**
      * The array of data source GUIDs to set on load.
      * Only a single data source is supported currently.
-     *
      * @deprecated Use `dataSource` instead
-     *
      * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
-     *
      * @example
      * ```js
      * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -37,9 +34,7 @@ export interface SearchBarViewConfig
     dataSources?: string[];
     /**
      * Pass the ID of the source to be selected.
-     *
      * @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
-     *
      * @example
      * ```js
      * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -51,9 +46,7 @@ export interface SearchBarViewConfig
     dataSource?: string;
     /**
      * Boolean to define if the last selected data source should be used
-     *
      * @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
-     *
      * @example
      * ```js
      * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -73,9 +66,7 @@ export interface SearchBarViewConfig
      * If it is executed, the focus is placed on the results.
      * If it’s not executed, the focus is placed at the end of
      * the token string in the search bar.
-     *
      * @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
-     *
      * @example
      * ```js
      * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -92,7 +83,6 @@ export interface SearchBarViewConfig
 
 /**
  * Embed ThoughtSpot search bar
- *
  * @version: SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
  * @group Embed components
  */
@@ -112,7 +102,6 @@ export class SearchBarEmbed extends TsEmbed {
     /**
      * Construct the URL of the embedded ThoughtSpot search to be
      * loaded in the iframe
-     *
      * @param dataSources A list of data source GUIDs
      */
     private getIFrameSrc() {

package/src/embed/search.ts

@@ -2,7 +2,6 @@
  * Copyright (c) 2022
  *
  * Embed ThoughtSpot search or a saved answer
- *
  * @summary Search embed
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
@@ -65,7 +64,6 @@ export enum DataPanelCustomColumnGroupsAccordionState {
 
 /**
  * The configuration attributes for the embedded search view.
- *
  * @group Embed components
  */
 export interface SearchViewConfig
@@ -80,9 +78,7 @@ export interface SearchViewConfig
     /**
      * If set to true, the data sources panel is collapsed on load,
      * but can be expanded manually.
-     *
      * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
-     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -94,9 +90,7 @@ export interface SearchViewConfig
     collapseDataSources?: boolean;
     /**
      * Show or hide the data sources panel.
-     *
      * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
-     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -110,9 +104,7 @@ export interface SearchViewConfig
      * Show or hide the charts and tables in search answers.
      * This attribute can be used to create a custom visualization
      * using raw answer data.
-     *
      * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
-     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -124,9 +116,7 @@ export interface SearchViewConfig
     hideResults?: boolean;
     /**
      * If set to true, the Search Assist feature is enabled.
-     *
      * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
-     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -139,9 +129,7 @@ export interface SearchViewConfig
     /**
      * If set to true, the tabular view is set as the default
      * format for presenting search data.
-     *
      * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
-     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -153,9 +141,7 @@ export interface SearchViewConfig
     /**
      * The array of data source GUIDs to set on load.
      * Only a single data source is supported currently.
-     *
      * @deprecated Use `dataSource` instead.
-     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -167,9 +153,7 @@ export interface SearchViewConfig
     dataSources?: string[];
     /**
      * The array of data source GUIDs to set on load.
-     *
      * @version: SDK: 1.19.0
-     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -181,7 +165,6 @@ export interface SearchViewConfig
     dataSource?: string;
     /**
      * The initial search query to load the answer with.
-     *
      * @deprecated
      *
      * Use {@link searchOptions} instead.
@@ -197,7 +180,6 @@ export interface SearchViewConfig
      * If it is executed, the focus is placed on the results.
      * If it’s not executed, the focus is placed at the end of
      * the token string in the search bar.
-     *
      * @example
      * ```js
      * searchOptions: {
@@ -209,9 +191,7 @@ export interface SearchViewConfig
     searchOptions?: SearchOptions;
     /**
      * The GUID of a saved answer to load initially.
-     *
      * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
-     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -224,9 +204,7 @@ export interface SearchViewConfig
     /**
      * If set to true, the search page will render without the Search Bar
      * The chart/table should still be visible.
-     *
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
-     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -238,10 +216,8 @@ export interface SearchViewConfig
     hideSearchBar?: boolean;
     /**
      * Flag to control Data panel experience
-     *
      * @default false
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
-     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -253,23 +229,19 @@ export interface SearchViewConfig
     dataPanelV2?: boolean;
     /**
      * Flag to set if last selected dataSource should be used
-     *
      * @version: SDK: 1.24.0
      */
     useLastSelectedSources?: boolean;
     /**
      * To set the initial state of the search bar in case of saved-answers.
-     *
      * @default false
      * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
      */
     collapseSearchBarInitially?: boolean;
     /**
      * To enable custom column groups in data panel v2
-     *
      * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
      * @default false
-     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -281,7 +253,6 @@ export interface SearchViewConfig
     enableCustomColumnGroups?: boolean;
     /**
      * Flag to enable onBeforeSearchExecute Embed Event
-     *
      * @version: SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
      */
     isOnBeforeGetVizDataInterceptEnabled?: boolean;
@@ -292,10 +263,8 @@ export interface SearchViewConfig
      * - EXPAND_ALL: Expand all the accordion initially in data panel v2.
      * - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
      * - EXPAND_FIRST: Expand the first accordion and collapse the rest.
-     *
      * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
      * @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
-     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -318,7 +287,6 @@ export const HiddenActionItemByDefaultForSearchEmbed = [
 
 /**
  * Embed ThoughtSpot search
- *
  * @group Embed components
  */
 export class SearchEmbed extends TsEmbed {
@@ -451,7 +419,6 @@ export class SearchEmbed extends TsEmbed {
     /**
      * Construct the URL of the embedded ThoughtSpot search to be
      * loaded in the iframe
-     *
      * @param answerId The GUID of a saved answer
      * @param dataSources A list of data source GUIDs
      */