@thoughtspot/visual-embed-sdk 1.39.0 → 1.39.2-alpha.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', {
@@ -985,23 +985,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 * })
                 */
             dataSourceId?: string;
-            /**
-                * This flag is for show/hide checkboxes for include or exclude
-                * cover page and filters in the Liveboard PDF.
-                *
-                * Supported embed types: `LiveboardEmbed`
-                * @version SDK: 1.37.0 | ThoughtSpot:10.8.0.cl
-                * @default true
-                * Supported embed types: `LiveboardEmbed`
-                * @example
-                * ```js
-                * const embed = new LiveboardEmbed('#tsEmbed', {
-                *    ... //other embed view config
-                *    coverAndFilterOptionInPDF: false,
-                * })
-                * ```
-                */
-            coverAndFilterOptionInPDF?: boolean;
             /**
                 * The list of tab IDs to hide from the embedded.
                 * This Tabs will be hidden from their respective LBs.
@@ -1099,7 +1082,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 +1346,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 +1354,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 +1366,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 +1383,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
@@ -1664,7 +1647,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/bodyless-conversation' {
 }
 
 declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
-    import { BaseViewConfig } from '@thoughtspot/visual-embed-sdk/types';
+    import { BaseViewConfig, RuntimeFilter, RuntimeParameter } from '@thoughtspot/visual-embed-sdk/types';
     import { TsEmbed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
     /**
         * Configuration for search options
@@ -1681,7 +1664,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
         */
     export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
             /**
-                * The ID of the data source object. For example, Model, View, or Table. Spotter uses this object to query data and generate Answers.
+                * The ID of the data source object. For example, Model, View, or Table. Spotter uses
+                * this object to query data and generate Answers.
                 */
             worksheetId: string;
             /**
@@ -1700,7 +1684,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 +1698,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 +1730,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,9 +1745,66 @@ 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;
+            /**
+                * The list of runtime filters to apply to a search Answer,
+                * visualization, or Liveboard.
+                *
+                * Supported embed types: `SpotterEmbed`
+                * @example
+                * ```js
+                * const embed = new SpotterEmbed('#tsEmbed', {
+                *    ... // other embed view config
+                *    runtimeFilters: [
+                *           {
+                *             columnName: 'value',
+                *             operator: RuntimeFilterOp.EQ,
+                *             values: ['string' | 123 | true],
+                *           },
+                *       ],
+                * })
+                * ```
+                */
+            runtimeFilters?: RuntimeFilter[];
+            /**
+                * Flag to control whether runtime filters should be included in the URL.
+                * If true, filters will be passed via app initialization payload instead.
+                * If false/undefined, filters will be added to URL (default behavior).
+                *
+                * Supported embed types: `SpotterEmbed`
+                * @default false
+                */
+            excludeRuntimeFiltersfromURL?: boolean;
+            /**
+                * The list of runtime parameters to apply to the conversation.
+                *
+                * Supported embed types: `SpotterEmbed`
+                * @example
+                * ```js
+                * const embed = new SpotterEmbed('#tsEmbed', {
+                *    ... // other embed view config
+                *    runtimeParameters: [
+                *           {
+                *             name: 'Parameter Name',
+                *             value: 'Parameter Value',
+                *           },
+                *       ],
+                * })
+                * ```
+                */
+            runtimeParameters?: RuntimeParameter[];
+            /**
+                * Flag to control whether runtime parameters should be included in the URL.
+                * If true, parameters will be passed via app initialization payload instead.
+                * If false/undefined, parameters will be added to URL (default behavior).
+                *
+                * Supported embed types: `SpotterEmbed`
+                * @default false
+                *
+                */
+            excludeRuntimeParametersfromURL?: boolean;
     }
     /**
         * The configuration for the embedded spotterEmbed options.
@@ -2378,7 +2419,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({
@@ -3465,6 +3506,22 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```
                 */
             enableAskSage?: boolean;
+            /**
+             * This flag is used to show or hide checkboxes for including or excluding
+             * the cover and filters pages in the Liveboard PDF.
+             *
+             * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+             * @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
+             * @example
+             * ```js
+             * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+             * const embed = new <EmbedComponent>('#tsEmbed', {
+             *    ... // other embed view config
+             *    coverAndFilterOptionInPDF: false,
+             * })
+             * ```
+             */
+            coverAndFilterOptionInPDF?: boolean;
     }
     export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {
     }
@@ -4608,7 +4665,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 +4712,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 +4768,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"
     }
@@ -5936,7 +5993,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             DataSourceId = "dataSourceId",
             preAuthCache = "preAuthCache",
             ShowSpotterLimitations = "showSpotterLimitations",
-            CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
+            CoverAndFilterOptionInPDF = "arePdfCoverFilterPageCheckboxesEnabled",
             PrimaryAction = "primaryAction",
             isSpotterAgentEmbed = "isSpotterAgentEmbed",
             IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled"
@@ -5966,6 +6023,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 {
             /**
@@ -7158,7 +7216,23 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```
                 *  @version SDK: 1.37.0 | ThoughtSpot Cloud: 10.8.0.cl
                 */
-            CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF"
+            CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
+            /**
+                * Action ID for hide or disable the
+                * Spotter in conversation training widget.
+                * The Add to Coaching feature is currently in beta
+                * and is disabled by default on embed deployments.
+                * To enable this feature on your instance,
+                * contact ThoughtSpot Support.
+                *  @example
+                * ```js
+                * hiddenAction: [Action.InConversationTraining]
+                * disabledActions: [Action.InConversationTraining]
+                *
+                * ```
+                *  @version SDK: 1.39.0 | ThoughtSpot Cloud: 10.10.0.cl
+                */
+            InConversationTraining = "InConversationTraining"
     }
     export interface AnswerServiceType {
             getAnswer?: (offset: number, batchSize: number) => any;
@@ -7756,39 +7830,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 +7878,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 +7911,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 +8150,54 @@ 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
+        * import { getInitConfig } from '@thoughtspot/visual-embed-sdk';
+        * // Call the getInitConfig method to retrieve the embed configuration
+        * const config = getInitConfig();
+        * // Log the configuration settings
+        * console.log(config);
+        * ```
+        * Returns the link:https://developers.thoughtspot.com/docs/Interface_EmbedConfig[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.
+        *
+        * The following JSON output shows the embed configuration
+        * settings returned from the code in the previous example:
+        *
+        * @example
+        * ```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.sw, and later
         * @group Global methods
         */
     export const getEmbedConfig: () => EmbedConfig;
@@ -8086,7 +8205,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.39.0",
+    "version": "1.39.2-alpha.1",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",

package/src/embed/app.spec.ts

@@ -8,9 +8,7 @@ import {
     HomePage,
 } from './app';
 import { init } from '../index';
-import {
-    Action, AuthType, EmbedEvent, HostEvent, RuntimeFilterOp,
-} from '../types';
+import { Action, AuthType, EmbedEvent, HostEvent, RuntimeFilterOp } from '../types';
 import {
     executeAfterWait,
     getDocumentBody,
@@ -45,12 +43,13 @@ beforeAll(() => {
         authType: AuthType.None,
     });
     jest.spyOn(auth, 'postLoginService').mockImplementation(() => Promise.resolve({}));
-    (window as any).ResizeObserver = window.ResizeObserver
-            || jest.fn().mockImplementation(() => ({
-                disconnect: jest.fn(),
-                observe: jest.fn(),
-                unobserve: jest.fn(),
-            }));
+    (window as any).ResizeObserver =
+        window.ResizeObserver ||
+        jest.fn().mockImplementation(() => ({
+            disconnect: jest.fn(),
+            observe: jest.fn(),
+            unobserve: jest.fn(),
+        }));
 });
 
 const cleanUp = () => {
@@ -316,6 +315,20 @@ describe('App embed tests', () => {
         });
     });
 
+    test('should set coverAndFilterOptionInPDF to false in url', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            coverAndFilterOptionInPDF: false,
+        } as AppViewConfig);
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&arePdfCoverFilterPageCheckboxesEnabled=false${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
     test('should set isLiveboardStylingAndGroupingEnabled to true in url', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,
@@ -687,7 +700,8 @@ describe('App embed tests', () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,
             // eslint-disable-next-line max-len
-            dataPanelCustomGroupsAccordionInitialState: DataPanelCustomColumnGroupsAccordionState.EXPAND_FIRST,
+            dataPanelCustomGroupsAccordionInitialState:
+                DataPanelCustomColumnGroupsAccordionState.EXPAND_FIRST,
         } as AppViewConfig);
 
         appEmbed.render();
@@ -700,19 +714,18 @@ describe('App embed tests', () => {
     });
 
     test('should register event handlers to adjust iframe height', async () => {
-        const onSpy = jest.spyOn(AppEmbed.prototype, 'on')
-            .mockImplementation((event, callback) => {
-                if (event === EmbedEvent.RouteChange) {
-                    callback({ data: { currentPath: '/answers' } }, jest.fn());
-                }
-                if (event === EmbedEvent.EmbedHeight) {
-                    callback({ data: '100%' });
-                }
-                if (event === EmbedEvent.EmbedIframeCenter) {
-                    callback({}, jest.fn());
-                }
-                return null;
-            });
+        const onSpy = jest.spyOn(AppEmbed.prototype, 'on').mockImplementation((event, callback) => {
+            if (event === EmbedEvent.RouteChange) {
+                callback({ data: { currentPath: '/answers' } }, jest.fn());
+            }
+            if (event === EmbedEvent.EmbedHeight) {
+                callback({ data: '100%' });
+            }
+            if (event === EmbedEvent.EmbedIframeCenter) {
+                callback({}, jest.fn());
+            }
+            return null;
+        });
         jest.spyOn(TsEmbed.prototype as any, 'getIframeCenter').mockReturnValue({});
         jest.spyOn(TsEmbed.prototype as any, 'setIFrameHeight').mockReturnValue({});
         const appEmbed = new AppEmbed(getRootEl(), {