@thoughtspot/visual-embed-sdk 1.41.0-pre-render-1 → 1.41.1

package/src/types.ts

@@ -14,7 +14,7 @@ import type { SessionInterface } from './utils/graphql/answerService/answerServi
  * the embedded app
  * @group Authentication / Init
  */
-// eslint-disable-next-line no-shadow
+ 
 export enum AuthType {
     /**
      * No authentication on the SDK. Pass-through to the embedded App. Alias for
@@ -231,12 +231,12 @@ export type DOMSelector = string | HTMLElement;
  * Use {@link CustomCssVariables} or css rules.
  */
 export interface customCssInterface {
-    /**
-     * The custom css variables, which can be set.
-     * The variables are available in the {@link CustomCssVariables}
-     * interface. For more information, see
-     * link:https://developers.thoughtspot.com/docs/css-variables-reference[CSS variable reference].
-     */
+  /**
+   * The custom css variables, which can be set.
+   * The variables are available in the {@link CustomCssVariables}
+   * interface. For more information, see
+   * link:https://developers.thoughtspot.com/docs/css-variables-reference[CSS variable reference].
+   */
     variables?: CustomCssVariables;
     /**
      * Can be used to define a custom font face
@@ -262,7 +262,7 @@ export interface customCssInterface {
      *   };
      * ```
      */
-    // eslint-disable-next-line camelcase
+     
     rules_UNSTABLE?: {
         [selector: string]: {
             [declaration: string]: string;
@@ -648,7 +648,7 @@ export interface EmbedConfig {
      * ```
      *  @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
      */
-    customVariablesForThirdPartyTools?: Record<string, any>;
+    customVariablesForThirdPartyTools?: Record< string, any >;
 
     disablePreauthCache?: boolean;
 
@@ -666,10 +666,36 @@ export interface EmbedConfig {
      * ```
      */
     disableFullscreenPresentation?: boolean;
+
+    /**
+     * Custom Actions allows users to define interactive UI actions (like buttons or menu
+     * items) that appear in ThoughtSpot's visualizations, answers, and Liveboards. These
+     * actions enable users to trigger custom workflows — such as navigating to an
+     * external app, calling an API, or opening a modal — based on the data context of
+     * what they clicked can be used to trigger custom logic when the action is clicked.
+     * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
+     * @example
+     * ```js
+     * import { CustomActionPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
+     * init({
+     *   ... // other embed config options
+     *   customActions: [
+     *     {
+     *       name: 'customAction', 
+     *       id: 'customAction',
+     *       target: CustomActionTarget.VISUALIZATION,
+     *       position: CustomActionPosition.PRIMARY,
+     *       }
+     *     }    
+     *   ]
+     * })
+     * ```
+     */
+    customActions?: CustomAction[];
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
-export interface LayoutConfig { }
+export interface LayoutConfig {}
 
 /**
  * Embedded iframe configuration
@@ -731,7 +757,7 @@ export interface BaseViewConfig {
     /**
      * @hidden
      */
-    // eslint-disable-next-line camelcase
+     
     styleSheet__unstable?: string;
     /**
      * The list of actions to disable from the primary menu, more menu
@@ -931,7 +957,7 @@ export interface BaseViewConfig {
      * ```
      * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
      */
-    // eslint-disable-next-line camelcase
+     
     enableV2Shell_experimental?: boolean;
     /**
      * For internal tracking of the embed component type.
@@ -1030,6 +1056,34 @@ export interface BaseViewConfig {
      * ```
      */
     showAlerts?: boolean;
+    /**
+     * Custom Actions allows users to define interactive UI actions (like buttons or menu
+     * items) that appear in ThoughtSpot's visualizations, answers, and Liveboards. These
+     * actions enable users to trigger custom workflows — such as navigating to an
+     * external app, calling an API, or opening a modal — based on the data context of
+     * what they clicked can be used to trigger custom logic when the action is clicked.
+     * 
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterEmbed`
+     * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
+     * @example
+     * ```js
+     * import { CustomActionPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
+     * // Use supported embed types such as AppEmbed or LiveboardEmbed
+     * const embed = new LiveboardEmbed('#tsEmbed', {
+     *   ... // other embed config options
+     *   customActions: [
+     *     {
+     *       name: 'customAction', 
+     *       id: 'customAction',
+     *       target: CustomActionTarget.VISUALIZATION,
+     *       position: CustomActionPosition.PRIMARY,
+     *       }
+     *     }    
+     *   ]
+     * })
+     * ```
+     */
+    customActions?: CustomAction[];
 }
 
 /**
@@ -1040,7 +1094,8 @@ export interface HomePageConfig {
      * Hide list page columns
      * For example: hiddenListColumns = [ListPageColumns.Author]
      *
-     * **Note**: This option is available only in full app embedding. To use it, you need to import `ListPageColumns` enum.
+     * **Note**: This option is currently available only in full app embedding and requires importing the ListPageColumns enum. 
+     * At present, it can be used with Liveboard and Answer list pages, and starting with version 10.14.0.cl, it will also be supported for the Home page.
      *
      * Supported embed types: `AppEmbed`
      * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
@@ -1226,8 +1281,8 @@ export interface SearchLiveboardCommonViewConfig {
      * Flag to control Data panel experience
      *
      * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
-     * @default false
-     * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
+     * @default true
+     * @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.14.0.cl
      * @example
      * ```js
      * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -1358,7 +1413,8 @@ export interface LiveboardAppEmbedViewConfig {
      */
     isLiveboardCompactHeaderEnabled?: boolean;
     /**
-     * This flag can be used to show or hide the Liveboard verified icon in the compact header.
+     * This flag can be used to show or hide the Liveboard verified icon in the compact
+     * header.
      *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`
      * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -1375,6 +1431,8 @@ export interface LiveboardAppEmbedViewConfig {
     showLiveboardVerifiedBadge?: boolean;
     /**
      * This flag is used to enable/disable hide irrelevant filters in Liveboard tab
+     * 
+     * **Note**: This feature is supported only if compact header is enabled on your Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled` attribute.
      *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`
      * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
@@ -1385,12 +1443,14 @@ export interface LiveboardAppEmbedViewConfig {
      * const embed = new <EmbedComponent>('#tsEmbed', {
      *    ... // other embed view config
      *    hideIrrelevantChipsInLiveboardTabs: true,
+     *    isLiveboardCompactHeaderEnabled: true,
      * })
      * ```
      */
     hideIrrelevantChipsInLiveboardTabs?: boolean;
     /**
-     * This flag can be used to show or hide the re-verify banner on the Liveboard compact header
+     * This flag can be used to show or hide the re-verify banner on the Liveboard
+     * compact header
      *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`
      * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -1421,25 +1481,41 @@ export interface LiveboardAppEmbedViewConfig {
      * ```
      */
     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,
-    * })
-    * ```
-    */
+     /**
+     * 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;
+    /**
+     * This flag is used to enable or disable the XLSX/CSV download option for Liveboards.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @version SDK: 1.41.0 | ThoughtSpot: 10.14.0.cl
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    liveboardXLSXCSVDownload: true,
+     * })
+     * ```
+     */
+    liveboardXLSXCSVDownload?: boolean;
+
 }
 
-export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig { }
+export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {}
 
 /**
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -1500,7 +1576,7 @@ export type QueryParams = {
 /**
  * A map of the supported runtime filter operations
  */
-// eslint-disable-next-line no-shadow
+ 
 export enum RuntimeFilterOp {
     /**
      * Equals
@@ -1571,7 +1647,7 @@ export enum RuntimeFilterOp {
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
  */
-// eslint-disable-next-line no-shadow
+ 
 export enum HomepageModule {
     /**
      * Search bar
@@ -1604,7 +1680,7 @@ export enum HomepageModule {
  * **Note**: This option is applicable to full app embedding only.
  * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
  */
-// eslint-disable-next-line no-shadow
+ 
 export enum ListPageColumns {
     /**
      * Favourite
@@ -1702,7 +1778,7 @@ export interface RuntimeParameter {
  * ```
  * @group Events
  */
-// eslint-disable-next-line no-shadow
+ 
 export enum EmbedEvent {
     /**
      * Rendering has initialized.
@@ -2345,6 +2421,11 @@ export enum EmbedEvent {
      * @hidden
      */
     APP_INIT = 'appInit',
+    /**
+     * Internal event to clear the cached info
+     * @hidden
+     */
+    CLEAR_INFO_CACHE = 'clearInfoCache',
     /**
      * Emitted when a user clicks **Show Liveboard details** on a Liveboard
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
@@ -2693,25 +2774,25 @@ export enum EmbedEvent {
      * ```
      * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
      */
-    TableVizRendered = 'TableVizRendered',
-    /**
-    * Emitted when the liveboard is created from pin modal or Liveboard list page.
-    * You can use this event as a hook to trigger
-    * other events on liveboard creation.
-    *
-    * ```js
-    * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
-    *     console.log('payload', payload);
-    * })
-    *```
-    * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
-    */
+     TableVizRendered = 'TableVizRendered',
+     /**
+     * Emitted when the liveboard is created from pin modal or Liveboard list page.
+     * You can use this event as a hook to trigger
+     * other events on liveboard creation.
+     *
+     * ```js
+     * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
+     *     console.log('payload', payload);
+     * })
+     *```
+     * @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
      */
-    CreateModel = 'createModel',
+     CreateModel = 'createModel',
     /**
      * @hidden
      * Emitted when a user exits present mode.
@@ -2813,6 +2894,17 @@ export enum EmbedEvent {
      * ```
      */
     EmbedListenerReady = 'EmbedListenerReady',
+    /**
+     * Emitted when the organization is switched.
+     * @example
+     * ```js
+     * appEmbed.on(EmbedEvent.OrgSwitched, (payload) => {
+     *     console.log('payload', payload);
+     * })
+     * ```
+     * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+     */
+    OrgSwitched = 'orgSwitched',
 }
 
 /**
@@ -2868,7 +2960,7 @@ export enum EmbedEvent {
  * ```
  * @group Events
  */
-// eslint-disable-next-line no-shadow
+ 
 export enum HostEvent {
     /**
      * Triggers a search operation with the search tokens specified in
@@ -3731,7 +3823,7 @@ export enum HostEvent {
      *      column: "Date",
      *      oper: 'EQ',
      *      values: ["2023-07-31"],
-     *      types: "EXACT_DATE"
+     *      type: "EXACT_DATE"
      *    }]
      * });
      * ```
@@ -3923,7 +4015,7 @@ export enum HostEvent {
      *```
      * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      */
-    InfoSuccess = 'InfoSuccess',
+     InfoSuccess = 'InfoSuccess',
     /**
      * Trigger the save action for an Answer.
      * To programmatically save an answer without opening the
@@ -4077,24 +4169,13 @@ export enum HostEvent {
      * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
      */
     AskSpotter = 'AskSpotter',
-
-    /**
-     * @hidden
-     * Triggers the update of the embed params.
-     * 
-     * @example
-     * ```js
-     * liveboardEmbed.trigger(HostEvent.UpdateEmbedParams, viewConfig);
-     * ```
-     */
-    UpdateEmbedParams = 'updateEmbedParams',
 }
 
 /**
  * The different visual modes that the data sources panel within
  * search could appear in, such as hidden, collapsed, or expanded.
  */
-// eslint-disable-next-line no-shadow
+ 
 export enum DataSourceVisualMode {
     /**
      * The data source panel is hidden.
@@ -4114,7 +4195,7 @@ export enum DataSourceVisualMode {
  * The query params passed down to the embedded ThoughtSpot app
  * containing configuration and/or visual information.
  */
-// eslint-disable-next-line no-shadow
+ 
 export enum Param {
     EmbedApp = 'embedApp',
     DataSources = 'dataSources',
@@ -4193,6 +4274,7 @@ export enum Param {
     Query = 'query',
     HideHomepageLeftNav = 'hideHomepageLeftNav',
     ModularHomeExperienceEnabled = 'modularHomeExperience',
+    HomepageVersion = 'homepageVersion',
     ListPageVersion = 'listpageVersion',
     PendoTrackingKey = 'additionalPendoKey',
     LiveboardHeaderSticky = 'isLiveboardHeaderSticky',
@@ -4233,7 +4315,9 @@ export enum Param {
     isSpotterAgentEmbed = 'isSpotterAgentEmbed',
     IsLiveboardStylingAndGroupingEnabled = 'isLiveboardStylingAndGroupingEnabled',
     IsLazyLoadingForEmbedEnabled = 'isLazyLoadingForEmbedEnabled',
-    RootMarginForLazyLoad = 'rootMarginForLazyLoad'
+    RootMarginForLazyLoad = 'rootMarginForLazyLoad',
+    LiveboardXLSXCSVDownload = 'isLiveboardXLSXCSVDownloadEnabled',
+    isPNGInScheduledEmailsEnabled = 'isPNGInScheduledEmailsEnabled',
 }
 
 /**
@@ -4263,7 +4347,7 @@ export enum Param {
  * ```
  * See also link:https://developers.thoughtspot.com/docs/actions[Action IDs in the SDK]
  */
-// eslint-disable-next-line no-shadow
+ 
 export enum Action {
     /**
      * The **Save** action on an Answer or Liveboard.
@@ -4808,7 +4892,7 @@ export enum Action {
      * The Favorites icon (*) for Answers,
      * Liveboard, and data objects like Worksheet, Model,
      * Tables and Views.
-     * Allows adding an object to the user’s favorites list.
+     * Allows adding an object to the user's favorites list.
      * @example
      * ```js
      * disabledActions: [Action.AddToFavorites]
@@ -5533,6 +5617,29 @@ export enum Action {
      *  @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
      */
     SpotterTokenQuickEdit = 'SpotterTokenQuickEdit',
+    /**
+     * The **PNG screenshot in email** option in the schedule email dialog.
+     * Includes a PNG screenshot in the notification email body.
+     * @example
+     * ```js
+     * disabledActions: [Action.PngScreenshotInEmail]
+     * ```
+     * ```
+     *  @version SDK: 1.42.0 | ThoughtSpot Cloud: 10.14.0.cl
+     */
+    PngScreenshotInEmail = 'pngScreenshotInEmail',
+    /**
+     * The **Remove attachment** action in the schedule email dialog.
+     * Removes an attachment from the email configuration.
+     * @example
+     * ```js
+     * disabledActions: [Action.RemoveAttachment]
+     * ```
+     * ```
+     * ```
+     *  @version SDK: 1.42.0 | ThoughtSpot Cloud: 10.14.0.cl
+     */
+    RemoveAttachment = 'removeAttachment',
 }
 
 export interface AnswerServiceType {
@@ -5564,15 +5671,15 @@ export interface ColumnValue {
         [key: string]: any;
     };
     value:
-    | string
-    | number
-    | boolean
-    | {
-        v: {
-            s: number;
-            e: number;
-        };
-    };
+        | string
+        | number
+        | boolean
+        | {
+              v: {
+                  s: number;
+                  e: number;
+              };
+          };
 }
 
 export interface VizPoint {
@@ -5604,6 +5711,44 @@ export interface CustomActionPayload {
     vizId?: string;
 }
 
+export interface CustomAction {
+    name: string;
+    id: string;
+    position: CustomActionsPosition;
+    target: CustomActionTarget;
+    metadataIds?: {
+        answerIds?: string[];
+        liveboardIds?: string[];
+        vizIds?: string[];
+    };
+    dataModelIds?: {
+        modelIds?: string[];
+        modelColumnNames?: string[];
+    }
+    orgIds?: string[];
+    groupIds?: string[];
+}
+
+/**
+ * Enum options to show custom actions at different
+ * positions in the application.
+ */
+export enum CustomActionsPosition {
+    PRIMARY = 'PRIMARY',
+    MENU = 'MENU',
+    CONTEXTMENU = 'CONTEXTMENU',
+}
+
+/**
+ * Enum options to mention the target of the custom action.
+ */
+export enum CustomActionTarget {
+    LIVEBOARD = 'LIVEBOARD',
+    VIZ = 'VIZ',
+    ANSWER = 'ANSWER',
+    SPOTTER = 'SPOTTER',
+}
+
 /**
  * Enum options to show or suppress Visual Embed SDK and
  * ThoughtSpot application logs in the console output.
@@ -5701,4 +5846,5 @@ export interface DefaultAppInitData {
     hiddenHomeLeftNavItems: string[];
     customVariablesForThirdPartyTools: Record<string, any>;
     hiddenListColumns: ListPageColumns[];
+    customActions: CustomAction[];
 }