@thoughtspot/ts-chart-sdk 1.1.1 → 1.2.1

package/src/types/common.types.ts

@@ -6,6 +6,7 @@
  * Copyright: ThoughtSpot Inc. 2023
  */
 
+import { Action } from './actions.types';
 import { ChartColumn } from './answer-column.types';
 import type { ChartConfigEditorDefinition } from './configurator.types';
 import type { VisualPropEditorDefinition } from './visual-prop.types';
@@ -358,3 +359,38 @@ export interface AppConfig {
      */
     chartAppAccessToken?: string;
 }
+
+/**
+ * @description Configuration interface for controlling the visibility and behavior of actions in a custom chart.
+ * This interface allows control over which actions are disabled, hidden, or visible
+ * in the Answer Actions(3dot menu)/ context menu actions.
+ *
+ * @export
+ * @interface VisualConfig
+ */
+export interface VisualConfig {
+    /**
+     * Array of actions that should be disabled (grayed out) in the custom chart.
+     * These actions will be visible but not interactive.
+     */
+    customChartDisabledActions?: Action[];
+
+    /**
+     * Tooltip message for why certain actions are disabled.
+     *
+     */
+    customChartDisabledActionReason?: string;
+
+    /**
+     * Array of actions that should be completely hidden from the custom chart's UI.
+     * These actions will not be visible to users. Define either this or visibleActions.
+     */
+    customChartHiddenActions?: Action[];
+
+    /**
+     * Array of actions that should be explicitly visible in the custom chart.
+     * Use this to specify which actions should be shown in the UI. Define either this or Hidden
+     * Actions
+     */
+    customChartVisibleActions?: Action[];
+}

package/src/types/ts-to-chart-event.types.ts

@@ -12,6 +12,7 @@ import {
     DataPointsArray,
     QueryData,
     ValidationResponse,
+    VisualConfig,
     VisualProps,
 } from './common.types';
 import type { ChartConfigEditorDefinition } from './configurator.types';
@@ -78,6 +79,19 @@ export enum TSToChartEvent {
      * @version SDK: 0.2 | ThoughtSpot:
      */
     GetColumnData = 'GetColumnData',
+    /**
+     * @version SDK: 1.2.1 | ThoughtSpot:
+     */
+    DownloadExcelTrigger = 'DownloadExcelTrigger',
+}
+
+export interface DownloadExcelTriggerPayload {
+    answerTitle: string;
+}
+export interface DownloadExcelTriggerResponse {
+    fileName: string;
+    error: string;
+    message: string;
 }
 
 /**
@@ -94,6 +108,9 @@ export interface TSToChartEventsPayloadMap {
     [TSToChartEvent.VisualPropsUpdate]: (
         payload: VisualPropsUpdateEventPayload,
     ) => void;
+    [TSToChartEvent.DownloadExcelTrigger]: (
+        payload: DownloadExcelTriggerPayload,
+    ) => DownloadExcelTriggerResponse;
 }
 
 /**
@@ -234,6 +251,16 @@ export interface InitializeEventResponsePayload {
      * @version SDK: 0.1 | ThoughtSpot:
      */
     chartConfigParameters?: ChartConfigParameters;
+
+    /**
+     * @description
+     * Optional parameter to control certain visual elements on the chart For example visibleAction
+     * array if Passed will only show those actions in context menu/Action menu of the chart on
+     * answer page. To be passed to TS via this payload
+     * @type {VisualConfig}
+     * @memberof InitializeEventResponsePayload
+     */
+    customChartVisualConfig?: VisualConfig;
 }
 
 /**