feat(Chart): Save Chart State globally

superset-embedded-sdk/src/index.ts

@@ -89,7 +89,8 @@ export type EmbeddedDashboard = {
   observeDataMask: (
     callbackFn: ObserveDataMaskCallbackFn,
   ) => void;
-  getDataMask: () => Record<string, any>;
+  getDataMask: () => Promise<Record<string, any>>;
+  getChartStates: () => Promise<Record<string, any>>;
   setThemeConfig: (themeConfig: Record<string, any>) => void;
 };
 
@@ -244,6 +245,7 @@ export async function embedDashboard({
     ourPort.get<string>('getDashboardPermalink', { anchor });
   const getActiveTabs = () => ourPort.get<string[]>('getActiveTabs');
   const getDataMask = () => ourPort.get<Record<string, any>>('getDataMask');
+  const getChartStates = () => ourPort.get<Record<string, any>>('getChartStates');
   const observeDataMask = (
     callbackFn: ObserveDataMaskCallbackFn,
   ) => {
@@ -270,6 +272,7 @@ export async function embedDashboard({
     getActiveTabs,
     observeDataMask,
     getDataMask,
+    getChartStates,
     setThemeConfig
   };
 }

superset-frontend/packages/superset-ui-core/src/chart/types/Base.ts

@@ -71,6 +71,44 @@ export type SetDataMaskHook = {
   ({ filterState, extraFormData, ownState }: DataMask): void;
 };
 
+/**
+ * Backend-compatible filter clause for query execution
+ */
+export interface QueryFilterClause {
+  col: string;
+  op: string;
+  val: string | number | string[] | number[];
+}
+
+/**
+ * Backend-compatible sort specification
+ */
+export interface QuerySortBy {
+  id: string;
+  key: string;
+  desc: boolean;
+}
+
+/**
+ * Backend-compatible own state that will be sent to the chart data API.
+ * This represents the standardized format that the backend expects.
+ */
+export interface BackendOwnState {
+  sortBy?: QuerySortBy[];
+  columnOrder?: string[];
+  filters?: QueryFilterClause[];
+  [key: string]: unknown; // Allow additional properties for chart-specific needs
+}
+
+/**
+ * Converter function that transforms chart-specific state to backend format.
+ * Each chart plugin can implement this to convert its internal state representation
+ * to the standardized backend format.
+ */
+export type ChartStateConverter<TChartState = JsonObject> = (
+  chartState: TChartState,
+) => Partial<BackendOwnState>;
+
 export interface PlainObject {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   [key: string]: any;

superset-frontend/packages/superset-ui-core/src/components/ThemedAgGridReact/index.tsx

@@ -161,6 +161,7 @@ export type { CustomCellRendererProps } from 'ag-grid-react';
 export type {
   ColDef,
   Column,
+  ColumnState,
   GridOptions,
   GridState,
   GridReadyEvent,

superset-frontend/packages/superset-ui-core/src/types/AgGrid.ts

@@ -0,0 +1,82 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import type { ColumnState, SortModelItem } from 'ag-grid-community';
+
+// AG Grid filter type enums
+export enum AgGridFilterType {
+  Text = 'text',
+  Number = 'number',
+  Date = 'date',
+  Set = 'set',
+}
+
+export enum AgGridTextFilterOperator {
+  Equals = 'equals',
+  NotEqual = 'notEqual',
+  Contains = 'contains',
+  NotContains = 'notContains',
+  StartsWith = 'startsWith',
+  EndsWith = 'endsWith',
+  Blank = 'blank',
+  NotBlank = 'notBlank',
+}
+
+export enum AgGridNumberFilterOperator {
+  Equals = 'equals',
+  NotEqual = 'notEqual',
+  LessThan = 'lessThan',
+  LessThanOrEqual = 'lessThanOrEqual',
+  GreaterThan = 'greaterThan',
+  GreaterThanOrEqual = 'greaterThanOrEqual',
+  InRange = 'inRange',
+  Blank = 'blank',
+  NotBlank = 'notBlank',
+}
+
+export interface AgGridSortModel extends SortModelItem {
+  sortIndex?: number;
+}
+
+export interface AgGridFilter {
+  filterType?: string;
+  type?: string;
+  filter?: string | number;
+  filterTo?: number;
+  values?: string[];
+  dateFrom?: string;
+  dateTo?: string;
+  operator?: 'AND' | 'OR';
+  condition1?: AgGridFilter;
+  condition2?: AgGridFilter;
+  conditions?: AgGridFilter[];
+}
+
+export interface AgGridFilterModel {
+  [colId: string]: AgGridFilter;
+}
+
+export interface AgGridChartState {
+  columnState: ColumnState[];
+  sortModel: AgGridSortModel[];
+  filterModel: AgGridFilterModel;
+  columnOrder?: string[];
+  pageSize?: number;
+  currentPage?: number;
+}

superset-frontend/packages/superset-ui-core/src/types/index.ts

@@ -20,6 +20,7 @@ import { NumberFormatter } from '../number-format';
 import { CurrencyFormatter } from '../currency-format';
 
 export * from '../query/types';
+export * from './AgGrid';
 
 export type Maybe<T> = T | null;