@thoughtspot/visual-embed-sdk 1.39.0 → 1.39.1

package/src/embed/sage.ts

@@ -48,39 +48,39 @@ export interface SageViewConfig
     showObjectResults?: boolean;
     /**
      * flag used by the TS product tour page to show the blue search bar
-     * even after the search is completed. This is different from Thoughtspot Embedded
+     * 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;
     /**
@@ -96,7 +96,7 @@ export interface SageViewConfig
      * 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', {
@@ -129,7 +129,7 @@ export interface SageViewConfig
      *    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;
 }

package/src/embed/search.ts

@@ -272,7 +272,7 @@ export interface SearchViewConfig
     /**
      * 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;
@@ -280,7 +280,7 @@ export interface SearchViewConfig
      * 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;
     /**
@@ -292,7 +292,7 @@ export interface SearchViewConfig
      * - 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
@@ -309,7 +309,7 @@ export interface SearchViewConfig
      * 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

package/src/types.ts

@@ -275,7 +275,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({
@@ -2554,7 +2554,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,
@@ -2601,7 +2601,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',
     /**
@@ -2657,18 +2657,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',
 }
@@ -3925,6 +3925,7 @@ export enum Param {
  *    hiddenActions: [Action.Edit, ActionAction.Explore],
  * })
  * ```
+ * See also link:https://developers.thoughtspot.com/docs/actions[Action IDs in the SDK]
  */
 // eslint-disable-next-line no-shadow
 export enum Action {