@thoughtspot/visual-embed-sdk 1.44.5 → 1.45.0

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

@@ -2150,6 +2150,22 @@ export interface SearchLiveboardCommonViewConfig {
 	 * ```
 	 */
 	enableCustomColumnGroups?: boolean;
+	/**
+	 * To enable **Include current period** checkbox for date filters.
+	 * Controls the visibility of the option to include
+	 * the current time period in filter results.
+	 *
+	 * Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
+	 * @example
+	 * ```js
+	 * const embed = new <EmbedComponent>('#tsEmbed', {
+	 *    ... // other embed view config
+	 *    isThisPeriodInDateFiltersEnabled: true,
+	 * })
+	 * ```
+	 * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
+	 */
+	isThisPeriodInDateFiltersEnabled?: boolean;
 }
 /**
  * The configuration object for common Liveboard and App embeds configs.
@@ -2159,7 +2175,7 @@ export interface LiveboardAppEmbedViewConfig {
 	 * Show or hide Liveboard header
 	 *
 	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
-	 * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+	 * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
 	 * @default false
 	 * @example
 	 * ```js
@@ -2175,7 +2191,7 @@ export interface LiveboardAppEmbedViewConfig {
 	 * Show or hide Liveboard title
 	 *
 	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
-	 * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+	 * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
 	 * @default false
 	 * @example
 	 * ```js
@@ -2191,7 +2207,7 @@ export interface LiveboardAppEmbedViewConfig {
 	 * Show or hide Liveboard description
 	 *
 	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
-	 * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+	 * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
 	 * @default false
 	 * @example
 	 * ```js
@@ -2215,7 +2231,7 @@ export interface LiveboardAppEmbedViewConfig {
 	 *   isLiveboardHeaderSticky: true,
 	 * });
 	 * ```
-	 * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+	 * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
 	 */
 	isLiveboardHeaderSticky?: boolean;
 	/**
@@ -2309,7 +2325,7 @@ export interface LiveboardAppEmbedViewConfig {
 	 * enable or disable ask sage
 	 *
 	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
-	 * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
+	 * @version SDK: 1.29.0 | ThoughtSpot: 9.12.0.cl
 	 * @default false
 	 * @example
 	 * ```js
@@ -2389,7 +2405,7 @@ export interface LiveboardAppEmbedViewConfig {
 	 * Show or hide masked filter chips
 	 *
 	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
-	 * @version SDK: 1.45.0 | Thoughtspot: 26.2.0.cl
+	 * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
 	 * @default false
 	 * @example
 	 * ```js
@@ -2405,7 +2421,7 @@ export interface LiveboardAppEmbedViewConfig {
 	 * Enable or disable Liveboard styling and grouping
 	 *
 	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
-	 * @version SDK: 1.45.0 | Thoughtspot: 26.2.0.cl
+	 * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
 	 * @default false
 	 * @example
 	 * ```js
@@ -5306,7 +5322,7 @@ export declare enum DataSourceVisualMode {
  * ```js
  * const embed = new LiveboardEmbed('#tsEmbed', {
  *    ... //other embed view config
- *    visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
+ *    visibleActions: [Action.Save, Action.Edit, Action.Present, Action.Explore],
  *    disabledActions: [Action.Download],
  *    //hiddenActions: [], // Set either this or visibleActions
  * })
@@ -5317,7 +5333,7 @@ export declare enum DataSourceVisualMode {
  *    ... //other embed view config
  *    //visibleActions: [],
  *    disabledActions: [Action.Download],
- *    hiddenActions: [Action.Edit, ActionAction.Explore],
+ *    hiddenActions: [Action.Edit, Action.Explore],
  * })
  * ```
  * See also link:https://developers.thoughtspot.com/docs/actions[Developer Documentation].
@@ -5836,13 +5852,15 @@ export declare enum Action {
 	 */
 	RequestAccess = "requestAccess",
 	/**
-	 * The **Query visualizer** and **Query SQL** buttons in
-	 * Query details panel of the Answer page.
+	 * Controls the display and availability of the **Query visualizer** and
+	 * **Query SQL** buttons in the Query details panel on the Answer page.
+	 *
+	 * **Query visualizer** - Displays the tables and filters used in the search query.
+	 * **Query SQL** - Displays the SQL statements used to retrieve data for the query.
 	 *
-	 * **Query visualizer** - Displays the tables
-	 * and filters used in a search query.
-	 * **Query SQL** - Displays the SQL statements used
-	 * in a search query to fetch data.
+	 * Note: This action ID only affects the visibility of the buttons within the
+	 * Query details panel. It does not control the visibility
+	 * of the query details icon on the Answer page.
 	 * @example
 	 * ```js
 	 * disabledActions: [Action.QueryDetailsButtons]
@@ -6547,12 +6565,11 @@ export declare enum Action {
 	 */
 	CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
 	/**
-	 * Action ID to hide or disable the Spotter in the conversation training widget.
-	 * When disabled, users cannot access **Add to Coaching**, which allows adding reference
-	 * questions and business terms to improve Spotter’s responses.
-	 * The **Add to Coaching** feature is generally available from version 26.2.0.cl and
-	 * enabled by default on embed deployments.
-
+	* Action ID to hide or disable the Coaching workflow in Spotter conversations.
+	* When disabled, users cannot access **Add to Coaching** workflow in conversation.
+	* The **Add to Coaching** feature allows adding reference questions and
+	* business terms to improve Spotter’s responses. This feature is generally available
+	* (GA) from version 26.2.0.cl and enabled by default on embed deployments.
 	 *  @example
 	 * ```js
 	 * hiddenAction: [Action.InConversationTraining]
@@ -6628,6 +6645,55 @@ export declare enum Action {
 	 * @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.15.0.cl
 	 */
 	LiveboardStylePanel = "liveboardStylePanel",
+	/**
+	* The **Publish** action for Liveboards, Answers and Models.
+	* Opens the publishing modal. It's a parent action for the
+	* **Manage Publishing** and **Unpublish** actions if the object
+	* is already published, otherwise appears standalone.
+	* @example
+	* ```js
+	* hiddenActions: [Action.Publish]
+	* disabledActions: [Action.Publish]
+	* ```
+	* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
+	*/
+	Publish = "publish",
+	/**
+	 * The **Manage Publishing** action for Liveboards, Answers and Models.
+	 * Opens the same publishing modal as the **Publish** action.
+	 * Appears as a child action to the **Publish** action if the
+	 * object is already published.
+	 * @example
+	 * ```js
+	 * hiddenActions: [Action.ManagePublishing]
+	 * disabledActions: [Action.ManagePublishing]
+	 * ```
+	 * @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
+	 */
+	ManagePublishing = "managePublishing",
+	/**
+	 * The **Unpublish** action for Liveboards, Answers and Models.
+	 * Opens the unpublishing modal. Appears as a child action to
+	 * the **Publish** action if the object is already published.
+	 * @example
+	 * ```js
+	 * hiddenActions: [Action.Unpublish]
+	 * disabledActions: [Action.Unpublish]
+	 * ```
+	 * @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
+	 */
+	Unpublish = "unpublish",
+	/**
+	 * The **Parameterize** action for Tables and Connections.
+	 * Opens the parameterization modal.
+	 * @example
+	 * ```js
+	 * hiddenActions: [Action.Parameterize]
+	 * disabledActions: [Action.Parameterize]
+	 * ```
+	 * @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
+	 */
+	Parameterize = "parameterise",
 	/**
 	 * The **Move to Group** menu action on a Liveboard.
 	 * Allows moving a visualization to a different group.
@@ -6667,7 +6733,19 @@ export declare enum Action {
 	 * ```
 	 * @version SDK: 1.44.0 | ThoughtSpot Cloud: 26.2.0.cl
 	 */
-	UngroupLiveboardGroup = "ungroupLiveboardGroup"
+	UngroupLiveboardGroup = "ungroupLiveboardGroup",
+	/**
+	 * The **Include current period** checkbox for date filters.
+	 * Controls the visibility and availability of the option to include
+	 * the current time period in filter results.
+	 * @example
+	 * ```js
+	 * hiddenActions: [Action.IncludeCurrentPeriod]
+	 * disabledActions: [Action.IncludeCurrentPeriod]
+	 * ```
+	 * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
+	 */
+	IncludeCurrentPeriod = "includeCurrentPeriod"
 }
 export declare enum PrefetchFeatures {
 	FullApp = "FullApp",
@@ -7773,6 +7851,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
 	 *    ... // other embed view config
 	 *    forceTable:true,
 	 * })
+	 * ```
 	 */
 	forceTable?: boolean;
 	/**
@@ -8542,7 +8621,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 	 * ```js
 	 * const embed = new AppEmbed('#tsEmbed', {
 	 *    ... // other embed view config
-	 *    pageId : Page.Answers | Page.Data,
+	 *    pageId: Page.Answers, // or Page.Data
 	 * })
 	 * ```
 	 */

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

@@ -2150,6 +2150,22 @@ export interface SearchLiveboardCommonViewConfig {
 	 * ```
 	 */
 	enableCustomColumnGroups?: boolean;
+	/**
+	 * To enable **Include current period** checkbox for date filters.
+	 * Controls the visibility of the option to include
+	 * the current time period in filter results.
+	 *
+	 * Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
+	 * @example
+	 * ```js
+	 * const embed = new <EmbedComponent>('#tsEmbed', {
+	 *    ... // other embed view config
+	 *    isThisPeriodInDateFiltersEnabled: true,
+	 * })
+	 * ```
+	 * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
+	 */
+	isThisPeriodInDateFiltersEnabled?: boolean;
 }
 /**
  * The configuration object for common Liveboard and App embeds configs.
@@ -2159,7 +2175,7 @@ export interface LiveboardAppEmbedViewConfig {
 	 * Show or hide Liveboard header
 	 *
 	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
-	 * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+	 * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
 	 * @default false
 	 * @example
 	 * ```js
@@ -2175,7 +2191,7 @@ export interface LiveboardAppEmbedViewConfig {
 	 * Show or hide Liveboard title
 	 *
 	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
-	 * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+	 * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
 	 * @default false
 	 * @example
 	 * ```js
@@ -2191,7 +2207,7 @@ export interface LiveboardAppEmbedViewConfig {
 	 * Show or hide Liveboard description
 	 *
 	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
-	 * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+	 * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
 	 * @default false
 	 * @example
 	 * ```js
@@ -2215,7 +2231,7 @@ export interface LiveboardAppEmbedViewConfig {
 	 *   isLiveboardHeaderSticky: true,
 	 * });
 	 * ```
-	 * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+	 * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
 	 */
 	isLiveboardHeaderSticky?: boolean;
 	/**
@@ -2309,7 +2325,7 @@ export interface LiveboardAppEmbedViewConfig {
 	 * enable or disable ask sage
 	 *
 	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
-	 * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
+	 * @version SDK: 1.29.0 | ThoughtSpot: 9.12.0.cl
 	 * @default false
 	 * @example
 	 * ```js
@@ -2389,7 +2405,7 @@ export interface LiveboardAppEmbedViewConfig {
 	 * Show or hide masked filter chips
 	 *
 	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
-	 * @version SDK: 1.45.0 | Thoughtspot: 26.2.0.cl
+	 * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
 	 * @default false
 	 * @example
 	 * ```js
@@ -2405,7 +2421,7 @@ export interface LiveboardAppEmbedViewConfig {
 	 * Enable or disable Liveboard styling and grouping
 	 *
 	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
-	 * @version SDK: 1.45.0 | Thoughtspot: 26.2.0.cl
+	 * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
 	 * @default false
 	 * @example
 	 * ```js
@@ -5301,7 +5317,7 @@ export declare enum HostEvent {
  * ```js
  * const embed = new LiveboardEmbed('#tsEmbed', {
  *    ... //other embed view config
- *    visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
+ *    visibleActions: [Action.Save, Action.Edit, Action.Present, Action.Explore],
  *    disabledActions: [Action.Download],
  *    //hiddenActions: [], // Set either this or visibleActions
  * })
@@ -5312,7 +5328,7 @@ export declare enum HostEvent {
  *    ... //other embed view config
  *    //visibleActions: [],
  *    disabledActions: [Action.Download],
- *    hiddenActions: [Action.Edit, ActionAction.Explore],
+ *    hiddenActions: [Action.Edit, Action.Explore],
  * })
  * ```
  * See also link:https://developers.thoughtspot.com/docs/actions[Developer Documentation].
@@ -5831,13 +5847,15 @@ export declare enum Action {
 	 */
 	RequestAccess = "requestAccess",
 	/**
-	 * The **Query visualizer** and **Query SQL** buttons in
-	 * Query details panel of the Answer page.
+	 * Controls the display and availability of the **Query visualizer** and
+	 * **Query SQL** buttons in the Query details panel on the Answer page.
+	 *
+	 * **Query visualizer** - Displays the tables and filters used in the search query.
+	 * **Query SQL** - Displays the SQL statements used to retrieve data for the query.
 	 *
-	 * **Query visualizer** - Displays the tables
-	 * and filters used in a search query.
-	 * **Query SQL** - Displays the SQL statements used
-	 * in a search query to fetch data.
+	 * Note: This action ID only affects the visibility of the buttons within the
+	 * Query details panel. It does not control the visibility
+	 * of the query details icon on the Answer page.
 	 * @example
 	 * ```js
 	 * disabledActions: [Action.QueryDetailsButtons]
@@ -6542,12 +6560,11 @@ export declare enum Action {
 	 */
 	CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
 	/**
-	 * Action ID to hide or disable the Spotter in the conversation training widget.
-	 * When disabled, users cannot access **Add to Coaching**, which allows adding reference
-	 * questions and business terms to improve Spotter’s responses.
-	 * The **Add to Coaching** feature is generally available from version 26.2.0.cl and
-	 * enabled by default on embed deployments.
-
+	* Action ID to hide or disable the Coaching workflow in Spotter conversations.
+	* When disabled, users cannot access **Add to Coaching** workflow in conversation.
+	* The **Add to Coaching** feature allows adding reference questions and
+	* business terms to improve Spotter’s responses. This feature is generally available
+	* (GA) from version 26.2.0.cl and enabled by default on embed deployments.
 	 *  @example
 	 * ```js
 	 * hiddenAction: [Action.InConversationTraining]
@@ -6623,6 +6640,55 @@ export declare enum Action {
 	 * @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.15.0.cl
 	 */
 	LiveboardStylePanel = "liveboardStylePanel",
+	/**
+	* The **Publish** action for Liveboards, Answers and Models.
+	* Opens the publishing modal. It's a parent action for the
+	* **Manage Publishing** and **Unpublish** actions if the object
+	* is already published, otherwise appears standalone.
+	* @example
+	* ```js
+	* hiddenActions: [Action.Publish]
+	* disabledActions: [Action.Publish]
+	* ```
+	* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
+	*/
+	Publish = "publish",
+	/**
+	 * The **Manage Publishing** action for Liveboards, Answers and Models.
+	 * Opens the same publishing modal as the **Publish** action.
+	 * Appears as a child action to the **Publish** action if the
+	 * object is already published.
+	 * @example
+	 * ```js
+	 * hiddenActions: [Action.ManagePublishing]
+	 * disabledActions: [Action.ManagePublishing]
+	 * ```
+	 * @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
+	 */
+	ManagePublishing = "managePublishing",
+	/**
+	 * The **Unpublish** action for Liveboards, Answers and Models.
+	 * Opens the unpublishing modal. Appears as a child action to
+	 * the **Publish** action if the object is already published.
+	 * @example
+	 * ```js
+	 * hiddenActions: [Action.Unpublish]
+	 * disabledActions: [Action.Unpublish]
+	 * ```
+	 * @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
+	 */
+	Unpublish = "unpublish",
+	/**
+	 * The **Parameterize** action for Tables and Connections.
+	 * Opens the parameterization modal.
+	 * @example
+	 * ```js
+	 * hiddenActions: [Action.Parameterize]
+	 * disabledActions: [Action.Parameterize]
+	 * ```
+	 * @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
+	 */
+	Parameterize = "parameterise",
 	/**
 	 * The **Move to Group** menu action on a Liveboard.
 	 * Allows moving a visualization to a different group.
@@ -6662,7 +6728,19 @@ export declare enum Action {
 	 * ```
 	 * @version SDK: 1.44.0 | ThoughtSpot Cloud: 26.2.0.cl
 	 */
-	UngroupLiveboardGroup = "ungroupLiveboardGroup"
+	UngroupLiveboardGroup = "ungroupLiveboardGroup",
+	/**
+	 * The **Include current period** checkbox for date filters.
+	 * Controls the visibility and availability of the option to include
+	 * the current time period in filter results.
+	 * @example
+	 * ```js
+	 * hiddenActions: [Action.IncludeCurrentPeriod]
+	 * disabledActions: [Action.IncludeCurrentPeriod]
+	 * ```
+	 * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
+	 */
+	IncludeCurrentPeriod = "includeCurrentPeriod"
 }
 declare enum ContextMenuTriggerOptions {
 	LEFT_CLICK = "left-click",
@@ -7749,6 +7827,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
 	 *    ... // other embed view config
 	 *    forceTable:true,
 	 * })
+	 * ```
 	 */
 	forceTable?: boolean;
 	/**
@@ -8514,7 +8593,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 	 * ```js
 	 * const embed = new AppEmbed('#tsEmbed', {
 	 *    ... // other embed view config
-	 *    pageId : Page.Answers | Page.Data,
+	 *    pageId: Page.Answers, // or Page.Data
 	 * })
 	 * ```
 	 */