@thoughtspot/ts-chart-sdk 1.1.1 → 1.2.1

package/src/main/custom-chart-context.ts

@@ -23,6 +23,7 @@ import {
     ChartModel,
     SuccessValidationResponse,
     ValidationResponse,
+    VisualConfig,
     VisualProps,
 } from '../types/common.types';
 import {
@@ -35,6 +36,7 @@ import {
     ChartModelUpdateEventPayload,
     ContextMenuCustomActionPayload,
     DataUpdateEventPayload,
+    DownloadExcelTriggerPayload,
     GetColumnDataPayload,
     GetColumnDataResponsePayload,
     GetDataQueryPayload,
@@ -173,6 +175,13 @@ export type ChartConfigParameters = {
      * @version SDK: 0.1 | ThoughtSpot:
      */
     batchSizeLimit?: number;
+    /**
+     * @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
+     * @type {VisualConfig}
+     */
+    customChartVisualConfig?: VisualConfig;
 };
 
 export type CustomChartContextProps = {
@@ -1024,6 +1033,23 @@ export class CustomChartContext {
                 };
             },
         );
+        /**
+         * This event is triggered when the TS app sends the download excel trigger.
+         */
+        this.on(
+            TSToChartEvent.DownloadExcelTrigger,
+            (payload: DownloadExcelTriggerPayload) => {
+                logger.log(
+                    'DownloadExcelTrigger event triggered from TS with payload:',
+                    payload,
+                );
+                return {
+                    fileName: '',
+                    error: '',
+                    message: 'Download Excel not implemented.',
+                };
+            },
+        );
     };
 
     /**

package/src/react/use-custom-chart-context.spec.tsx

@@ -488,3 +488,71 @@ describe('useChartContext on React Wrapper component', () => {
         });
     });
 });
+// ... existing code ...
+
+describe('useChartContext DownloadExcelTrigger event handler', () => {
+    let eventProcessor: any;
+    let mockInitMessage;
+    let mockPostMessageToHost;
+    const mockedChartModel = { columns: [], config: {} };
+
+    beforeEach(() => {
+        mockInitMessage = jest.spyOn(
+            PostMessageEventBridge,
+            'initMessageListener',
+        );
+        mockPostMessageToHost = jest.spyOn(
+            PostMessageEventBridge,
+            'postMessageToHostApp',
+        );
+        mockInitMessage.mockImplementation((fn: any) => {
+            eventProcessor = fn;
+            return () => null;
+        });
+
+        mockPostMessageToHost.mockImplementation(() => {
+            return global.Promise.resolve();
+        });
+    });
+
+    afterEach(() => {
+        jest.clearAllMocks();
+        PostMessageEventBridge.globalThis.isInitialized = false;
+    });
+
+    test('should handle download Excel trigger correctly', async () => {
+        const { result, waitFor } = renderHook(() =>
+            useChartContext(contextChartProps),
+        );
+
+        // Initialize context
+        await eventProcessor({
+            payload: {
+                componentId: 'COMPONENT_ID',
+                hostUrl: 'https://some.chart.app',
+                chartModel: mockedChartModel,
+            },
+            eventType: TSToChartEvent.Initialize,
+        });
+
+        await eventProcessor({
+            payload: {},
+            eventType: TSToChartEvent.InitializeComplete,
+            source: 'ts-host-app',
+        });
+
+        const response = await eventProcessor({
+            payload: {},
+            eventType: TSToChartEvent.DownloadExcelTrigger,
+            source: 'ts-host-app',
+        });
+
+        await waitFor(() => {
+            expect(response).toEqual({
+                fileName: '',
+                error: '',
+                message: 'Download Excel not implemented.',
+            });
+        });
+    });
+});

package/src/react/use-custom-chart-context.tsx

@@ -6,6 +6,7 @@
  * Copyright: ThoughtSpot Inc. 2023
  */
 
+import { error } from 'console';
 import _ from 'lodash';
 import React, { useCallback, useEffect, useState } from 'react';
 import {
@@ -17,6 +18,7 @@ import { ChartModel } from '../types/common.types';
 import {
     ChartModelUpdateEventPayload,
     DataUpdateEventPayload,
+    DownloadExcelTriggerPayload,
     VisualPropsUpdateEventPayload,
 } from '../types/ts-to-chart-event.types';
 import {
@@ -106,7 +108,16 @@ export const useChartContext = (
                 triggerRenderChart: true,
             };
         };
-
+        const defaultDownloadUpdateHandler = (
+            payload: DownloadExcelTriggerPayload,
+        ) => {
+            setChartModel(context.getChartModel());
+            return {
+                fileName: '',
+                error: '',
+                message: 'Download Excel not implemented.',
+            };
+        };
         // Register all external event listeners here
         getChartContextValues(context).setOnChartModelUpdate(
             commonUpdateHandler,
@@ -115,6 +126,9 @@ export const useChartContext = (
             commonUpdateHandler,
         );
         getChartContextValues(context).setOnDataUpdate(commonUpdateHandler);
+        getChartContextValues(context).setOnDownloadExcelTrigger(
+            defaultDownloadUpdateHandler,
+        );
     }, []);
 
     /**