@thoughtspot/ts-chart-sdk 2.5.8 → 2.6.1

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

@@ -1788,6 +1788,7 @@ describe('CustomChartContext', () => {
             });
 
             expect(response).toEqual({
+                isDownloadHandled: true,
                 fileName: '',
                 error: '',
                 message: 'Download Excel not implemented.',
@@ -1796,6 +1797,7 @@ describe('CustomChartContext', () => {
 
         test('should use custom handler when provided', async () => {
             const mockDownloadHandler = jest.fn().mockReturnValue({
+                isDownloadHandled: true,
                 fileName: 'custom-report.xlsx',
                 error: '',
                 message: 'Success',
@@ -1825,6 +1827,7 @@ describe('CustomChartContext', () => {
 
             expect(mockDownloadHandler).toHaveBeenCalledWith(testPayload);
             expect(response).toEqual({
+                isDownloadHandled: true,
                 fileName: 'custom-report.xlsx',
                 error: '',
                 message: 'Success',
@@ -1833,6 +1836,7 @@ describe('CustomChartContext', () => {
 
         test('should handle errors in custom handler', async () => {
             const mockDownloadHandler = jest.fn().mockReturnValue({
+                isDownloadHandled: true,
                 fileName: '',
                 error: 'Failed to generate excel',
                 message: 'Error occurred',
@@ -1858,6 +1862,7 @@ describe('CustomChartContext', () => {
 
             expect(mockDownloadHandler).toHaveBeenCalled();
             expect(response).toEqual({
+                isDownloadHandled: true,
                 fileName: '',
                 error: 'Failed to generate excel',
                 message: 'Error occurred',
@@ -1866,6 +1871,7 @@ describe('CustomChartContext', () => {
 
         test('should pass through payload to custom handler', async () => {
             const mockDownloadHandler = jest.fn().mockReturnValue({
+                isDownloadHandled: true,
                 fileName: 'test.xlsx',
                 error: '',
                 message: 'Success',
@@ -1912,6 +1918,7 @@ describe('CustomChartContext', () => {
                             return response;
                         }
                         return {
+                            isDownloadHandled: true,
                             fileName: 'first.xlsx',
                             error: '',
                             message: 'First handler response',
@@ -1921,6 +1928,7 @@ describe('CustomChartContext', () => {
                 );
 
             const secondHandler = jest.fn().mockReturnValue({
+                isDownloadHandled: true,
                 fileName: 'second.xlsx',
                 error: '',
                 message: 'Second handler response',
@@ -1958,6 +1966,7 @@ describe('CustomChartContext', () => {
             // Verify handlers were called in correct order
             expect(secondHandler).toHaveBeenCalledWith(testPayload, undefined);
             expect(firstHandler).toHaveBeenCalledWith(testPayload, {
+                isDownloadHandled: true,
                 fileName: 'second.xlsx',
                 error: '',
                 message: 'Second handler response',
@@ -1967,6 +1976,7 @@ describe('CustomChartContext', () => {
             // Verify final result comes from first handler's return value
             // (last custom handler to execute)
             expect(result).toEqual({
+                isDownloadHandled: true,
                 fileName: 'second.xlsx',
                 error: '',
                 message: 'Second handler response',

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

@@ -59,6 +59,7 @@ import {
     VisualEditorDefinitionSetter,
     VisualPropEditorDefinition,
 } from '../types/visual-prop.types';
+import { validateAllChartConfigs } from '../utils/chart-config';
 import { setLocaleBasedStringFormats } from '../utils/number-formatting/number-formatting-utils';
 import { create } from './logger';
 import {
@@ -1185,6 +1186,7 @@ export class CustomChartContext {
                     return response;
                 }
                 return Promise.resolve({
+                    isDownloadHandled: true,
                     fileName: '',
                     error: '',
                     message: 'Download Excel not implemented.',
@@ -1275,6 +1277,7 @@ export class CustomChartContext {
                         this.appConfig,
                     );
             }
+            validateAllChartConfigs(defaultChartConfig);
             return {
                 isConfigValid: isValid,
                 defaultChartConfig,

package/src/react/mocks/custom-chart-context-mock.ts

@@ -3,6 +3,7 @@ import { CustomChartContextProps } from '../../main/custom-chart-context';
 import { ColumnType } from '../../types/answer-column.types';
 import { ChartConfig, ChartModel } from '../../types/common.types';
 import { Query } from '../../types/ts-to-chart-event.types';
+import { fetchQueryColumns } from '../../utils/chart-config';
 
 export const contextChartProps: CustomChartContextProps = {
     getDefaultChartConfig: (chartModel: ChartModel): ChartConfig[] => {
@@ -35,19 +36,9 @@ export const contextChartProps: CustomChartContextProps = {
     },
     getQueriesFromChartConfig: (chartConfig: ChartConfig[]): Array<Query> => {
         const queries = chartConfig.map(
-            (config: ChartConfig): Query =>
-                _.reduce(
-                    config.dimensions,
-                    (acc: Query, dimension) => ({
-                        queryColumns: [
-                            ...acc.queryColumns,
-                            ...dimension.columns,
-                        ],
-                    }),
-                    {
-                        queryColumns: [],
-                    } as Query,
-                ),
+            (config: ChartConfig): Query => ({
+                queryColumns: fetchQueryColumns(config),
+            }),
         );
         return queries;
     },

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

@@ -5,6 +5,7 @@ import * as PostMessageEventBridge from '../main/post-message-event-bridge';
 import { mockInitializeContextPayload } from '../test/test-utils';
 import { ColumnType } from '../types/answer-column.types';
 import { ChartToTSEvent } from '../types/chart-to-ts-event.types';
+import { AxisType, ChartConfigMode } from '../types/common.types';
 import { TSToChartEvent } from '../types/ts-to-chart-event.types';
 import { contextChartProps } from './mocks/custom-chart-context-mock';
 import { useChartContext } from './use-custom-chart-context';
@@ -71,7 +72,7 @@ describe('useChartContext initialization', () => {
         });
     });
 
-    test('should trigger getDataQuery and fetch correct query response', async () => {
+    test('should trigger getDataQuery and fetch correct query response for column driven dimension config', async () => {
         // Render the hook with the custom chart context props
         const { result, waitFor } = renderHook(() =>
             useChartContext(contextChartProps),
@@ -131,6 +132,85 @@ describe('useChartContext initialization', () => {
         });
     });
 
+    test('should trigger getDataQuery and fetch correct query response for config driven dimension config', async () => {
+        // Render the hook with the custom chart context props
+        const { result, waitFor } = renderHook(() =>
+            useChartContext(contextChartProps),
+        );
+
+        // Assert that the context is not initialized initially
+        expect(result.current.hasInitialized).toBe(false);
+        expect(result.current.chartModel).toBeUndefined();
+        await eventProcessor({
+            payload: {
+                componentId: 'COMPONENT_ID',
+                hostUrl: 'https://some.chart.app',
+                chartModel: mockedChartModel,
+            },
+            eventType: TSToChartEvent.Initialize,
+        });
+
+        const response = await eventProcessor({
+            payload: {
+                config: [
+                    {
+                        key: 'column',
+                        dimensions: [
+                            {
+                                key: 'x',
+                                mode: ChartConfigMode.AXIS_DRIVEN,
+                                axes: [
+                                    {
+                                        type: AxisType.FLAT,
+                                        column: mockedChartModel.columns[0],
+                                    },
+                                ],
+                            },
+                            {
+                                key: 'y',
+                                mode: ChartConfigMode.AXIS_DRIVEN,
+                                axes: [
+                                    {
+                                        type: AxisType.MERGED,
+                                        columns: [
+                                            mockedChartModel.columns[1],
+                                            mockedChartModel.columns[2],
+                                        ],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                ],
+            },
+            eventType: TSToChartEvent.GetDataQuery,
+            source: 'ts-host-app',
+        });
+        await eventProcessor({
+            payload: {},
+            eventType: TSToChartEvent.TriggerRenderChart,
+            source: 'ts-host-app',
+        });
+        await eventProcessor({
+            payload: {},
+            eventType: TSToChartEvent.InitializeComplete,
+            source: 'ts-host-app',
+        });
+
+        await waitFor(() => {
+            expect(response.queries[0].queryColumns[0]).toBe(
+                mockedChartModel.columns[0],
+            );
+            expect(response.queries[0].queryColumns[1]).toBe(
+                mockedChartModel.columns[1],
+            );
+            expect(response.queries[0].queryColumns[2]).toBe(
+                mockedChartModel.columns[2],
+            );
+            expect(result.current.hasInitialized).toBeTruthy();
+        });
+    });
+
     test('should make sure hasInitialized to remain false when context initialization failed', async () => {
         jest.mock('../main/custom-chart-context', () => ({
             CustomChartContext: jest.fn().mockImplementation(() => ({
@@ -549,6 +629,7 @@ describe('useChartContext DownloadExcelTrigger event handler', () => {
 
         await waitFor(() => {
             expect(response).toEqual({
+                isDownloadHandled: true,
                 fileName: '',
                 error: '',
                 message: 'Download Excel not implemented.',

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

@@ -113,6 +113,7 @@ export const useChartContext = (
         ) => {
             setChartModel(context.getChartModel());
             return Promise.resolve({
+                isDownloadHandled: true,
                 fileName: '',
                 error: '',
                 message: 'Download Excel not implemented.',

package/src/types/common.types.ts

@@ -59,14 +59,78 @@ export enum CustomizableChartFeature {
 }
 
 /**
- * List of Columns for a dimension in the Custom Chart Config.
- * Associated with the key defined in the chart config editor definition
- * Relates to ChartConfigSection
+ * Enum to indicate the type of dimension config
  *
- * @version SDK: 0.1 | ThoughtSpot:
+ * @version SDK: 2.6.0 | ThoughtSpot:
+ * @group Chart Model
+ */
+export enum AxisType {
+    FLAT = 'flat',
+    MERGED = 'merged',
+    DUAL = 'dual',
+}
+
+/**
+ * Flat axis config: single column, unmodified.
+ *
+ * @version SDK: 2.6.0 | ThoughtSpot:
  * @group Chart Model
  */
-export interface ChartConfigDimension {
+export interface FlatAxis {
+    type: AxisType.FLAT;
+    /** Single column for this axis slot */
+    column: ChartColumn;
+}
+
+/**
+ * Merged axis config: multiple columns combined into one logical series.
+ *
+ * @version SDK: 2.6.0 | ThoughtSpot:
+ * @group Chart Model
+ */
+export interface MergedAxis {
+    type: AxisType.MERGED;
+    /** Columns that are merged into one axis slot */
+    columns: ChartColumn[];
+}
+
+/**
+ * Dual axis config: primary and secondary axis, each can be flat or merged.
+ *
+ * @version SDK: 2.6.0 | ThoughtSpot:
+ * @group Chart Model
+ */
+export interface DualAxis {
+    type: AxisType.DUAL;
+    /** Primary axis config (flat or merged) */
+    primary: FlatAxis | MergedAxis;
+    /** Secondary axis config (flat or merged) */
+    secondary: FlatAxis | MergedAxis;
+}
+
+/**
+ * Union of all supported axis types for a dimension.
+ */
+export type AxisConfig = FlatAxis | MergedAxis | DualAxis;
+
+/**
+ * Enum to indicate whether dimension config uses columns or structured config
+ *
+ * @version SDK: 2.6.0 | ThoughtSpot:
+ * @group Chart Model
+ */
+export enum ChartConfigMode {
+    COLUMN_DRIVEN = 'COLUMN_DRIVEN',
+    AXIS_DRIVEN = 'AXIS_DRIVEN',
+}
+
+/**
+ * Column driven dimension config: single column or multiple columns.
+ *
+ * @version SDK: 2.6.0 | ThoughtSpot:
+ * @group Chart Model
+ */
+export interface ColumnDrivenChartConfigDimension {
     /**
      * Key for the dimension in the chart config
      *
@@ -74,13 +138,58 @@ export interface ChartConfigDimension {
      */
     key: string;
     /**
-     * List of columns added for the dimension
+     * Mode of the chart config
      *
-     * @version SDK: 0.1 | ThoughtSpot:
+     * @version SDK: 2.6.0 | ThoughtSpot:
+     */
+    mode?: ChartConfigMode.COLUMN_DRIVEN;
+    /**
+     * List of columns added for the dimension
+     * If chart config mode is COLUMN_DRIVEN, this is required
+     * @version SDK: 2.6.0 | ThoughtSpot:
      */
     columns: ChartColumn[];
 }
 
+/**
+ * Axis driven dimension config: multiple axes, each can be flat or merged.
+ *
+ * @version SDK: 2.6.0 | ThoughtSpot:
+ * @group Chart Model
+ */
+export interface AxisDrivenChartConfigDimension {
+    /**
+     * Key for the dimension in the chart config
+     *
+     * @version SDK: 2.6.0 | ThoughtSpot:
+     */
+    key: string;
+    /**
+     * Mode of the chart config
+     *
+     * @version SDK: 2.6.0 | ThoughtSpot:
+     */
+    mode: ChartConfigMode.AXIS_DRIVEN;
+    /**
+     * Axis config of the dimension
+     *
+     * @version SDK: 2.6.0 | ThoughtSpot:
+     */
+    axes: AxisConfig[];
+}
+
+/**
+ * List of Columns for a dimension in the Custom Chart Config.
+ * Associated with the key defined in the chart config editor definition
+ * Relates to ChartConfigSection
+ *
+ * @version SDK: 0.1 | ThoughtSpot:
+ * @group Chart Model
+ */
+export type ChartConfigDimension =
+    | ColumnDrivenChartConfigDimension
+    | AxisDrivenChartConfigDimension;
+
 /**
  * Custom Chart Config values stored in the metadata
  * Relates to ChartConfigEditorDefinition

package/src/types/conditional-formatting.types.ts

@@ -34,6 +34,7 @@ export type GradientBackgroundAttrs = {
     backgroundFormatMidpoint?: Maybe<Scalars['Float']>;
     backgroundFormatRange?: Maybe<Array<Maybe<Scalars['Float']>>>;
     colors?: Maybe<Array<Maybe<Scalars['String']>>>;
+    isAutoScaled?: Maybe<Scalars['Boolean']>;
 };
 export enum Operators {
     Contains = 'CONTAINS',

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

@@ -93,6 +93,15 @@ export interface DownloadExcelTriggerPayload {
     answerTitle: string;
 }
 export interface DownloadExcelTriggerResponse {
+    // This `isDownloadHandled` flag indicates whether the custom chart has
+    // handled the XLSX download. If true, the custom chart managed the
+    // download. If false, the ThoughtSpot default XLSX downloader will be used
+    // instead. For example, in Muze Studio, only pivot tables support XLSX
+    // export. For other chart types like bar or line charts, this flag should
+    // be set to false to signal that the download could not be processed by the
+    // custom chart, allowing the default ThoughtSpot downloader to handle the
+    // export.
+    isDownloadHandled: boolean;
     fileName: string;
     error: string;
     message: string;