@thoughtspot/visual-embed-sdk 1.39.0 → 1.39.2

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

@@ -652,39 +652,39 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
         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
+            * 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
+            * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl
             * @hidden
             */
         isProductTour?: boolean;
         /**
             * 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
+            * @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
+            * @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
+            * @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
+            * @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
+            * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
             */
         hideAutocompleteSuggestions?: boolean;
         /**
@@ -700,7 +700,7 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
             * selected for the search operation.
             *
             * Supported embed types: `SageEmbed`
-            * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
+            * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
             * @example
             * ```js
             * const embed = new SageEmbed('#tsEmbed', {
@@ -733,7 +733,7 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
             *    executeSearch: true,
             * }
             * ```
-            * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
+            * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
             */
         searchOptions?: SearchOptions;
 }
@@ -1019,7 +1019,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
         /**
             * 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
+            * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
             * @deprecated Use {@link collapseSearchBar} instead
             */
         collapseSearchBarInitially?: boolean;
@@ -1027,7 +1027,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
             * Flag to enable onBeforeSearchExecute Embed Event
             *
             * Supported embed types: `SearchEmbed`
-            * @version: SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
+            * @version: SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
             */
         isOnBeforeGetVizDataInterceptEnabled?: boolean;
         /**
@@ -1039,7 +1039,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
             * - EXPAND_FIRST: Expand the first accordion and collapse the rest.
             *
             * Supported embed types: `SearchEmbed`
-            * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+            * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
             * @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
             * @example
             * ```js
@@ -1056,7 +1056,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
             * lands on search embed page.
             *
             * Supported embed types: `SearchEmbed`
-            * @version SDK: 1.32.0 | Thoughtspot: 10.3.0.cl
+            * @version SDK: 1.32.0 | ThoughtSpot: 10.3.0.cl
             * @default true
             * @example
             * ```js
@@ -1220,7 +1220,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
             *
             * Supported embed types: `AppEmbed`
             * @default true
-            * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
+            * @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
             * @example
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
@@ -1242,7 +1242,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
             *
             * Supported embed types: `AppEmbed`
             * @default false
-            * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
+            * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
             * @example
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
@@ -1258,7 +1258,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
             *
             * Supported embed types: `AppEmbed`
             * @default false
-            * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
+            * @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
             * @example
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
@@ -1341,7 +1341,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
             * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
             *
             * Supported embed types: `AppEmbed`
-            * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
+            * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
             * @default false
             * @example
             * ```js
@@ -1361,7 +1361,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
             * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
             *
             * Supported embed types: `AppEmbed`
-            * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
+            * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
             * @default true
             * @example
             * ```js
@@ -1382,7 +1382,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
             * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
             *
             * Supported embed types: `AppEmbed`
-            * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
+            * @version SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl
             * @example
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
@@ -1400,7 +1400,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
             * path within the app, use the `path` attribute which is more flexible.
             *
             * Supported embed types: `AppEmbed`
-            * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
+            * @version SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl
             * @example
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
@@ -1416,7 +1416,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
             * tag.
             *
             * Supported embed types: `AppEmbed`
-            * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
+            * @version SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl
             * @example
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
@@ -1495,7 +1495,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
             *
             * Supported embed types: `AppEmbed`
             * @default false
-            * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
+            * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
             * @example
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
@@ -1525,7 +1525,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
         discoveryExperience?: DiscoveryExperience;
         /**
             * To set the initial state of the search bar in case of saved-answers.
-            * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+            * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
             * @default false
             * @deprecated Use {@link collapseSearchBar} instead
             */
@@ -1539,7 +1539,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
             * - EXPAND_FIRST: Expand the first accordion and collapse the rest.
             *
             * Supported embed types: `AppEmbed`
-            * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+            * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
             * @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
             * @example
             * ```js
@@ -1553,14 +1553,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
         dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
         /**
             * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
-            * @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
+            * @version SDK : 1.29.0 | ThoughtSpot: 10.1.0.cl
             */
         isOnBeforeGetVizDataInterceptEnabled?: boolean;
         /**
             * Flag to use home page search bar mode
             *
             * Supported embed types: `AppEmbed`
-            * @version SDK : 1.33.0 | Thoughtspot : 10.3.0.cl
+            * @version SDK : 1.33.0 | ThoughtSpot: 10.3.0.cl
             */
         homePageSearchBarMode?: HomePageSearchBarMode;
         /**
@@ -1825,7 +1825,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
             * Show or hide the tab panel of the embedded Liveboard.
             *
             * Supported embed types: `LiveboardEmbed`
-            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
+            * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -2014,7 +2014,7 @@ export declare class LiveboardEmbed extends V1Embed {
         navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
         /**
             * Returns the full url of the Liveboard/visualization which can be used to open
-            * this Liveboard inside the full Thoughtspot application in a new tab.
+            * this Liveboard inside the full ThoughtSpot application in a new tab.
             * @returns url string
             */
         getLiveboardUrl(): string;
@@ -2383,7 +2383,7 @@ export interface CustomStyles {
     * Configuration to define the customization on the Embedded
     * ThoughtSpot components.
     * You can customize styles, text strings, and icons.
-    * For more information, see https://developers.thoughtspot.com/docs/custom-css.
+    * For more information, see link:https://developers.thoughtspot.com/docs/custom-css[CSS customization framework].
     * @example
     * ```js
     *  init({
@@ -4613,7 +4613,7 @@ export declare enum EmbedEvent {
             *
             * error: Developers can customize the error message text when `execute`
             * returns `false` using the error parameter in responder.
-            * @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
+            * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
             * @example
             *```js
             * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
@@ -4660,7 +4660,7 @@ export declare enum EmbedEvent {
             *     console.log('payload', payload);
             * })
             *```
-            * @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
+            * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
             */
         ParameterChanged = "parameterChanged",
         /**
@@ -4716,18 +4716,18 @@ export declare enum EmbedEvent {
          *     console.log('payload', payload);
          * })
          *```
-         * @version SDK : 1.37.0 | ThoughtSpot : 10.8.0.cl
+         * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
          */
         CreateLiveboard = "createLiveboard",
         /**
             * Emitted when a user creates a Model.
-            * @version SDK : 1.37.0 | ThoughtSpot : 10.8.0.cl
+            * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
             */
         CreateModel = "createModel",
         /**
             * @hidden
             * Emitted when a user exits present mode.
-            * @version SDK : 1.40.0 | ThoughtSpot : 10.11.0.cl
+            * @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
             */
         ExitPresentMode = "exitPresentMode"
 }
@@ -5971,6 +5971,7 @@ export declare enum Param {
     *    hiddenActions: [Action.Edit, ActionAction.Explore],
     * })
     * ```
+    * See also link:https://developers.thoughtspot.com/docs/actions[Action IDs in the SDK]
     */
 export declare enum Action {
         /**
@@ -7376,7 +7377,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
             *    disableSourceSelection : true,
             * })
             * ```
-            * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+            * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
             */
         disableSourceSelection?: boolean;
         /**
@@ -7390,7 +7391,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
             *    hideSourceSelection : true,
             * })
             * ```
-            * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+            * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
             */
         hideSourceSelection?: boolean;
         /**
@@ -7422,7 +7423,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
             *    showSpotterLimitations : true,
             * })
             * ```
-            * @version SDK: 1.36.0 | Thoughtspot: 10.5.0.cl
+            * @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
             */
         showSpotterLimitations?: boolean;
         /**
@@ -7437,7 +7438,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
             *    hideSampleQuestions : true,
             * })
             * ```
-            * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+            * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
             */
         hideSampleQuestions?: boolean;
 }
@@ -8726,9 +8727,52 @@ export declare function resetCachedSessionInfo(): void;
 export declare function resetCachedPreauthInfo(): void;
 
 /**
-    * Gets the configuration embed was initialized with.
-    * @returns {@link EmbedConfig} The configuration embed was initialized with.
-    * @version SDK: 1.19.0 | ThoughtSpot: *
+    * Gets the embed configuration settings that were used to
+    * initialize the SDK.
+    * @returns {@link EmbedConfig}
+    *
+    * @example
+    * ```js
+    * const config = getInitConfig();
+    * console.log(config);
+    * ```
+    * @example
+    *
+    * Returns the `EmbedConfig` object, which
+    * contains the configuration settings used to
+    * initialize the SDK, including the following:
+    *
+    *  - `thoughtSpotHost` - ThoughtSpot host URL
+    *  - `authType`: The authentication method used. For example,
+    * `AuthServerCookieless` for  `AuthType.TrustedAuthTokenCookieless`
+    *  - `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].
+    *
+    * ```json
+    * {
+    *   "thoughtSpotHost": "https://{ThoughtSpot-Host}",
+    *   "authType": "AuthServerCookieless",
+    *   "customizations": {
+    *    "style": {
+    *        "customCSS": {
+    *        "variables": {
+    *            "--ts-var-button--secondary-background": "#7492d5",
+    *            "--ts-var-button--secondary--hovers-background": "#aac2f8",
+    *            "--ts-var-root-background": "#f1f4f8"
+    *          }
+    *        }
+    *      }
+    *    },
+    *   "loginFailedMessage": "Login failed, please try again",
+    *   "authTriggerText": "Authorize",
+    *   "disableTokenVerification": true,
+    *   "authTriggerContainer": "#your-own-div"
+    *  }
+    * ```
+    * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.cl, and later
     * @group Global methods
     */
 export declare const getEmbedConfig: () => EmbedConfig;
@@ -8736,7 +8780,7 @@ export declare const getEmbedConfig: () => EmbedConfig;
     * Sets the configuration embed was initialized with.
     * And returns the new configuration.
     * @param newConfig The configuration to set.
-    * @version SDK: 1.27.0 | ThoughtSpot: *
+    * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.1.sw, and later
     * @group Global methods
     */
 export declare const setEmbedConfig: (newConfig: EmbedConfig) => any;