@thoughtspot/visual-embed-sdk 1.38.1 → 1.39.1

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

@@ -155,7 +155,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 *
                 * 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', {
@@ -177,7 +177,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 *
                 * 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', {
@@ -193,7 +193,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 *
                 * 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', {
@@ -276,7 +276,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * `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
@@ -296,7 +296,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * `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
@@ -317,7 +317,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * 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', {
@@ -335,7 +335,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * 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', {
@@ -351,7 +351,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * 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', {
@@ -430,7 +430,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 *
                 * 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', {
@@ -460,7 +460,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
             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
                 */
@@ -474,7 +474,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * - 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
@@ -488,14 +488,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
             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;
             /**
@@ -910,7 +910,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 * 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', {
@@ -1099,7 +1099,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
             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;
@@ -1363,7 +1363,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
             /**
                 * 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;
@@ -1371,7 +1371,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
                 * 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;
             /**
@@ -1383,7 +1383,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
                 * - 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
@@ -1400,7 +1400,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
                 * 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
@@ -1700,7 +1700,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
                 *    disableSourceSelection : true,
                 * })
                 * ```
-                * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+                * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
                 */
             disableSourceSelection?: boolean;
             /**
@@ -1714,7 +1714,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
                 *    hideSourceSelection : true,
                 * })
                 * ```
-                * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+                * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
                 */
             hideSourceSelection?: boolean;
             /**
@@ -1746,7 +1746,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
                 *    showSpotterLimitations : true,
                 * })
                 * ```
-                * @version SDK: 1.36.0 | Thoughtspot: 10.5.0.cl
+                * @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
                 */
             showSpotterLimitations?: boolean;
             /**
@@ -1761,7 +1761,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
                 *    hideSampleQuestions : true,
                 * })
                 * ```
-                * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+                * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
                 */
             hideSampleQuestions?: boolean;
     }
@@ -2378,7 +2378,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
         * 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({
@@ -4608,7 +4608,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *
                 * 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,
@@ -4655,7 +4655,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *     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",
             /**
@@ -4711,18 +4711,18 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
              *     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"
     }
@@ -5966,6 +5966,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
         *    hiddenActions: [Action.Edit, ActionAction.Explore],
         * })
         * ```
+        * See also link:https://developers.thoughtspot.com/docs/actions[Action IDs in the SDK]
         */
     export enum Action {
             /**
@@ -7756,39 +7757,39 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
             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;
             /**
@@ -7804,7 +7805,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
                 * 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', {
@@ -7837,7 +7838,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
                 *    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;
     }
@@ -8076,9 +8077,52 @@ declare module '@thoughtspot/visual-embed-sdk/utils/graphql/answerService/answer
 declare module '@thoughtspot/visual-embed-sdk/embed/embedConfig' {
     import { EmbedConfig } from '@thoughtspot/visual-embed-sdk/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 const getEmbedConfig: () => EmbedConfig;
@@ -8086,7 +8130,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/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/package.json

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

package/src/embed/app.ts

@@ -136,7 +136,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', {
@@ -158,7 +158,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', {
@@ -174,7 +174,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', {
@@ -257,7 +257,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
@@ -277,7 +277,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
@@ -298,7 +298,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', {
@@ -316,7 +316,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', {
@@ -332,7 +332,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', {
@@ -411,7 +411,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', {
@@ -441,7 +441,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
      */
@@ -455,7 +455,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
@@ -469,14 +469,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/src/embed/conversation.ts

@@ -39,7 +39,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;
     /**
@@ -53,7 +53,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;
     /**
@@ -85,7 +85,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;
     /**
@@ -100,7 +100,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/src/embed/embedConfig.ts

@@ -4,9 +4,52 @@ import { EmbedConfig } from '../types';
 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 = (): EmbedConfig => getValueFromWindow(configKey) || ({} as any);
@@ -15,10 +58,10 @@ export const getEmbedConfig = (): EmbedConfig => 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: EmbedConfig) => {
     storeValueInWindow(configKey, newConfig);
     return getValueFromWindow(configKey);
-};
+};

package/src/embed/liveboard.ts

@@ -192,7 +192,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', {
@@ -674,7 +674,7 @@ export class LiveboardEmbed extends V1Embed {
 
     /**
      * 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
      */
     public getLiveboardUrl(): string {