@thoughtspot/visual-embed-sdk 1.39.0 → 1.39.2

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

@@ -132,7 +132,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', {
@@ -154,7 +154,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', {
@@ -170,7 +170,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', {
@@ -253,7 +253,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
@@ -273,7 +273,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
@@ -294,7 +294,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', {
@@ -312,7 +312,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', {
@@ -328,7 +328,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', {
@@ -407,7 +407,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', {
@@ -437,7 +437,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
             */
@@ -451,7 +451,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
@@ -465,14 +465,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;
         /**
@@ -878,7 +878,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', {
@@ -1067,7 +1067,7 @@ export 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;
@@ -1327,7 +1327,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;
@@ -1335,7 +1335,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;
         /**
@@ -1347,7 +1347,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
@@ -1364,7 +1364,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
@@ -1651,7 +1651,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;
         /**
@@ -1665,7 +1665,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;
         /**
@@ -1697,7 +1697,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;
         /**
@@ -1712,7 +1712,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;
 }
@@ -2319,7 +2319,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({
@@ -4549,7 +4549,7 @@ export 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,
@@ -4596,7 +4596,7 @@ export 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",
         /**
@@ -4652,18 +4652,18 @@ export 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"
 }
@@ -5907,6 +5907,7 @@ export enum Param {
     *    hiddenActions: [Action.Edit, ActionAction.Explore],
     * })
     * ```
+    * See also link:https://developers.thoughtspot.com/docs/actions[Action IDs in the SDK]
     */
 export enum Action {
         /**
@@ -7691,39 +7692,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;
         /**
@@ -7739,7 +7740,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', {
@@ -7772,7 +7773,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;
 }
@@ -8005,9 +8006,52 @@ export class AnswerService {
 }
 
 /**
-    * 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 const getEmbedConfig: () => EmbedConfig;
@@ -8015,7 +8059,7 @@ export 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 const setEmbedConfig: (newConfig: EmbedConfig) => any;

package/lib/package.json

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

package/lib/src/embed/app.d.ts

@@ -118,7 +118,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', {
@@ -140,7 +140,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', {
@@ -156,7 +156,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', {
@@ -239,7 +239,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
@@ -259,7 +259,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
@@ -280,7 +280,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', {
@@ -298,7 +298,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', {
@@ -314,7 +314,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', {
@@ -393,7 +393,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', {
@@ -423,7 +423,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
      */
@@ -437,7 +437,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
@@ -451,14 +451,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;
     /**

package/lib/src/embed/conversation.d.ts

@@ -34,7 +34,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;
     /**
@@ -48,7 +48,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;
     /**
@@ -80,7 +80,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;
     /**
@@ -95,7 +95,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;
 }

package/lib/src/embed/embedConfig.d.ts

@@ -1,8 +1,51 @@
 import { EmbedConfig } from '../types';
 /**
- * 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;
@@ -10,7 +53,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;

package/lib/src/embed/embedConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"embedConfig.d.ts","sourceRoot":"","sources":["../../../src/embed/embedConfig.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAIvC;;;;;GAKG;AACH,eAAO,MAAM,cAAc,QAAO,WAA2D,CAAC;AAE9F;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,cAAe,WAAW,QAGpD,CAAC"}
+{"version":3,"file":"embedConfig.d.ts","sourceRoot":"","sources":["../../../src/embed/embedConfig.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAIvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,eAAO,MAAM,cAAc,QAAO,WAA2D,CAAC;AAE9F;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,cAAe,WAAW,QAGpD,CAAC"}

package/lib/src/embed/embedConfig.js

@@ -1,9 +1,52 @@
 import { getValueFromWindow, storeValueInWindow } from '../utils';
 const configKey = 'embedConfig';
 /**
- * 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 const getEmbedConfig = () => getValueFromWindow(configKey) || {};
@@ -11,7 +54,7 @@ export const getEmbedConfig = () => getValueFromWindow(configKey) || {};
  * 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 const setEmbedConfig = (newConfig) => {