@thoughtspot/visual-embed-sdk 1.32.0 → 1.32.1

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

@@ -504,6 +504,19 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             * ```
             */
         collapseDataSources?: boolean;
+        /**
+            * If set to true, the data panel is collapsed on load,
+            * but can be expanded manually.
+            * @version: SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
+            * @example
+            * ```js
+            * const embed = new SearchEmbed('#tsEmbed', {
+            *    ... // other options
+            *    collapseDataPanel:true,
+            * })
+            * ```
+            */
+        collapseDataPanel?: boolean;
         /**
             * Show or hide the data sources panel.
             * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
@@ -652,6 +665,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             * 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
+            * @deprecated Use {@link collapseSearchBar} instead
             */
         collapseSearchBarInitially?: boolean;
         /**
@@ -1064,6 +1078,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * To set the initial state of the search bar in case of saved-answers.
             * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
             * @default false
+            * @deprecated Use {@link collapseSearchBar} instead
             */
         collapseSearchBarInitially?: boolean;
         /**
@@ -1696,7 +1711,11 @@ export declare enum HomeLeftNavItem {
         /**
             * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
             */
-        SpotIQAnalysis = "spotiq-analysis"
+        SpotIQAnalysis = "spotiq-analysis",
+        /**
+            * @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
+            */
+        LiveboardSchedules = "liveboard-schedules"
 }
 export type DOMSelector = string | HTMLElement;
 /**
@@ -2481,6 +2500,30 @@ export interface ViewConfig {
             * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
             */
         enableV2Shell_experimental?: boolean;
+        /**
+            * To set the initial state of the search bar in case of saved-answers.
+            * @default true
+            * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed', {
+            *   liveboardId: '123',
+            *   collapseSearchBar: true
+            * });
+            */
+        collapseSearchBar?: boolean;
+        /**
+            * This flag can be used to disable links inside the embedded app,
+            * and disables redirection of links in a new tab.
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed', {
+            *   disableRedirectionLinksInNewTab: true
+            * });
+            * ```
+            * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
+            */
+        disableRedirectionLinksInNewTab?: boolean;
 }
 /**
     * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -3225,6 +3268,7 @@ export declare enum EmbedEvent {
         /**
             * Emitted when a user clicks the **Update TML** action on
             * embedded Liveboard.
+            *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
@@ -3236,6 +3280,7 @@ export declare enum EmbedEvent {
         /**
             * Emitted when a user clicks the **Edit TML** action
             * on an embedded Liveboard.
+            *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
@@ -3843,16 +3888,20 @@ export declare enum HostEvent {
         /**
             * Trigger the **Export TML** action on an embedded Liveboard or
             * Answer.
+            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.ExportTML)
             * ```
+            *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         ExportTML = "exportTSL",
         /**
             * Trigger the **Edit TML** action on an embedded Liveboard or
             * saved Answers in the full application embedding.
+            *
+            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.EditTML)
@@ -3943,13 +3992,15 @@ export declare enum HostEvent {
             *
             * @example
             * ```js
-            * appEmbed.trigger(HostEvent.CreateMonitor)
+            * searchEmbed.trigger(HostEvent.CreateMonitor)
             * ```
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         CreateMonitor = "createMonitor",
         /**
-            * Trigger the **Manage alerts** action on a visualization
+            * Trigger the **Manage alerts** action on a KPI chart
+            * in a visualization or saved Answer.
+            *
             * @param - an object with `vizId` as a key
             * @example
             * ```js
@@ -3957,6 +4008,16 @@ export declare enum HostEvent {
             *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
             * })
             * ```
+            *
+            * @example
+            * ```js
+            * searchEmbed.trigger(HostEvent.ManageMonitor)
+            * ```
+            *
+            * @example
+            * ```js
+            * vizEmbed.trigger(HostEvent.ManageMonitor)
+            * ```
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         ManageMonitor = "manageMonitor",
@@ -3967,6 +4028,7 @@ export declare enum HostEvent {
             * This event is not supported in visualization embed and search embed.
             * @param - object - To trigger the action for a specific visualization
             * in Liveboard embed, pass in `vizId` as a key.
+            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.Edit)
@@ -4233,6 +4295,7 @@ export declare enum HostEvent {
         /**
             * Get details of filters applied on the Liveboard.
             * Returns arrays containing Liveboard filter and runtime filter elements.
+            *
             * @example
             * ```js
             * const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
@@ -4528,7 +4591,8 @@ export declare enum Param {
         Enable2ColumnLayout = "enable2ColumnLayout",
         IsFullAppEmbed = "isFullAppEmbed",
         IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled",
-        FocusSearchBarOnRender = "focusSearchBarOnRender"
+        FocusSearchBarOnRender = "focusSearchBarOnRender",
+        DisableRedirectionLinksInNewTab = "disableRedirectionLinksInNewTab"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -4578,6 +4642,7 @@ export declare enum Action {
             * The **Save as View** action on the Answer
             * page. Saves an Answer as a View object in the full
             * application embedding mode.
+            *
             * @example
             * ```js
             * disabledActions: [Action.SaveAsView]
@@ -4677,6 +4742,7 @@ export declare enum Action {
             */
         ConfigureFilter = "configureFilter",
         CollapseDataSources = "collapseDataSources",
+        CollapseDataPanel = "collapseDataPanel",
         /**
             * The **Choose sources** button on Search page.
             * Allows selecting data sources for search queries.
@@ -5034,6 +5100,7 @@ export declare enum Action {
         /**
             * The **Delete** action for Answers in the full application
             * embedding mode.
+            *
             * @example
             * ```js
             * disabledActions: [Action.AnswerDelete]
@@ -5072,12 +5139,15 @@ export declare enum Action {
             * The Create alert action on KPI charts.
             * @example
             * ```js
-            * disabledActions: [Action.CreateMonitor ]
+            * disabledActions: [Action.CreateMonitor]
             * ```
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             */
         CreateMonitor = "createMonitor",
         /**
+            * @deprecated
+            * Reports errors
+            *
             * @example
             * ```js
             * disabledActions: [Action.ReportError]
@@ -5302,35 +5372,87 @@ export declare enum Action {
             */
         RenameModalTitleDescription = "renameModalTitleDescription",
         /**
+            *
+            * The **Request Verification** action on the Liveboard.
+            * Triggers a Liveboard verification request.
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.RequestVerification]
+            * ```
             *
             * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
             */
         RequestVerification = "requestVerification",
         /**
+            *
+            * Allows users to mark a Liveboard as verified.
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.MarkAsVerified]
+            * ```
             * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
             */
         MarkAsVerified = "markAsVerified",
         /**
+            * The **Add Tab** action on a Liveboard.
+            * Allows adding a new tab to a Liveboard view.
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.AddTab]
+            * ```
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         AddTab = "addTab",
         /**
+            *
+            * Initiates contextual change analysis on KPI charts.
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.EnableContextualChangeAnalysis]
+            * ```
             * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
             */
         EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
         /**
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.ShowSageQuery]
+            * ```
+            *
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         ShowSageQuery = "showSageQuery",
         /**
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.EditSageAnswer]
+            * ```
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         EditSageAnswer = "editSageAnswer",
         /**
+            *
+            * This action allows users to send feedback on AI-generated Answers.
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.SageAnswerFeedback]
+            * ```
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         SageAnswerFeedback = "sageAnswerFeedback",
         /**
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.ModifySageAnswer]
+            * ```
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         ModifySageAnswer = "modifySageAnswer",
@@ -5451,7 +5573,61 @@ export declare enum Action {
             * ```
             *  @version SDK: 1.27.10 | Thoughtspot: 9.12.5.cl
             */
-        AIHighlights = "AIHighlights"
+        AIHighlights = "AIHighlights",
+        /**
+            * Action ID for edit schedule action on schedule on homepage
+            * @example
+            * ```js
+            * disabledActions: [Action.EditScheduleHomepage]
+            * ```
+            *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+            */
+        EditScheduleHomepage = "editScheduleHomepage",
+        /**
+            * Action ID for pause schedule action on schedule on homepage
+            * @example
+            * ```js
+            * disabledActions: [Action.PauseScheduleHomepage]
+            * ```
+            *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+            */
+        PauseScheduleHomepage = "pauseScheduleHomepage",
+        /**
+            * Action ID for view schedule run action on schedule on homepage
+            * @example
+            * ```js
+            * disabledActions: [Action.ViewScheduleRunHomepage]
+            * ```
+            *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+            */
+        ViewScheduleRunHomepage = "viewScheduleRunHomepage",
+        /**
+            * Action ID for unsubscribe schedule action on schedule on homepage
+            * @example
+            * ```js
+            * disabledActions: [Action.UnsubscribeScheduleHomepage]
+            * ```
+            *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+            */
+        UnsubscribeScheduleHomepage = "unsubscribeScheduleHomepage",
+        /**
+            * Action ID for delete schedule action on schedule on homepage
+            * @example
+            * ```js
+            * disabledActions: [Action.DeleteScheduleHomepage]
+            * ```
+            *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+            */
+        DeleteScheduleHomepage = "deleteScheduleHomepage",
+        /**
+            * The **Analyze CTA** action on KPI chart.
+            * @example
+            * ```js
+            * disabledActions: [Action.KPIAnalysisCTA]
+            * ```
+            *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+            */
+        KPIAnalysisCTA = "kpiAnalysisCTA"
 }
 export interface AnswerServiceType {
         getAnswer?: (offset: number, batchSize: number) => any;
@@ -5650,7 +5826,7 @@ export declare class TsEmbed {
             * @param queryParams
             * @returns queryParams
             */
-        protected getBaseQueryParams(queryParams?: {}): {};
+        protected getBaseQueryParams(queryParams?: Record<any, any>): Record<any, any>;
         /**
             * Constructs the base URL string to load v1 of the ThoughtSpot app.
             * This is used for embedding Liveboards, visualizations, and full application.