[charts] Simplify plugin types (#13396)

Signed-off-by: Jose C Quintas Jr <juniorquintas@gmail.com> Signed-off-by: Alexandre Fauquette <45398769+alexfauquette@users.noreply.github.com> Co-authored-by: Alexandre Fauquette <45398769+alexfauquette@users.noreply.github.com>
mui · Jun 6, 2024 · 02aa2f1 · 02aa2f1
1 parent 3247869
commit 02aa2f1
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 18 deletions.
diff --git a/packages/x-charts/src/ChartContainer/ChartContainer.tsx b/packages/x-charts/src/ChartContainer/ChartContainer.tsx
@@ -15,11 +15,11 @@ import {
 } from '../context/CartesianContextProvider';
 import { ChartsAxesGradients } from '../internals/components/ChartsAxesGradients';
 import { HighlightedProvider, HighlightedProviderProps } from '../context';
-import { ChartsPluginTypes } from '../models/plugin';
+import { ChartsPluginType } from '../models/plugin';
 import { ChartSeriesType } from '../models/seriesType/config';
 import { usePluginsMerge } from './usePluginsMerge';
 
-export type ChartContainerProps<T extends ChartSeriesType = ChartSeriesType> = Omit<
+export type ChartContainerProps = Omit<
   ChartsSurfaceProps &
     Omit<SeriesContextProviderProps, 'seriesFormatters'> &
     Omit<DrawingProviderProps, 'svgRef'> &
@@ -32,7 +32,7 @@ export type ChartContainerProps<T extends ChartSeriesType = ChartSeriesType> = O
    * An array of plugins defining how to preprocess data.
    * If not provided, the container supports line, bar, scatter and pie charts.
    */
-  plugins?: ChartsPluginTypes<T>[];
+  plugins?: ChartsPluginType<ChartSeriesType>[];
 };
 
 const ChartContainer = React.forwardRef(function ChartContainer(props: ChartContainerProps, ref) {

diff --git a/packages/x-charts/src/ChartContainer/defaultPlugins.ts b/packages/x-charts/src/ChartContainer/defaultPlugins.ts
@@ -2,5 +2,11 @@ import { plugin as barPlugin } from '../BarChart/plugin';
 import { plugin as scatterPlugin } from '../ScatterChart/plugin';
 import { plugin as linePlugin } from '../LineChart/plugin';
 import { plugin as piePlugin } from '../PieChart/plugin';
+import { ChartsPluginType } from '../models';
 
-export const defaultPlugins = [barPlugin, scatterPlugin, linePlugin, piePlugin];
+export const defaultPlugins: ChartsPluginType<'bar' | 'scatter' | 'line' | 'pie'>[] = [
+  barPlugin,
+  scatterPlugin,
+  linePlugin,
+  piePlugin,
+];
diff --git a/packages/x-charts/src/ChartContainer/usePluginsMerge.ts b/packages/x-charts/src/ChartContainer/usePluginsMerge.ts
@@ -1,11 +1,11 @@
 import * as React from 'react';
-import { ChartsPluginTypes, ColorProcessorsConfig } from '../models';
+import { ChartsPluginType, ColorProcessorsConfig } from '../models';
 import { ChartSeriesType } from '../models/seriesType/config';
 import { ExtremumGettersConfig } from '../context/CartesianContextProvider';
 import { SeriesFormatterConfig } from '../context/SeriesContextProvider';
 import { defaultPlugins } from './defaultPlugins';
 
-export function usePluginsMerge<T extends ChartSeriesType>(plugins?: ChartsPluginTypes<T>[]) {
+export function usePluginsMerge<T extends ChartSeriesType>(plugins?: ChartsPluginType<T>[]) {
   const defaultizedPlugins = plugins ?? defaultPlugins;
 
   return React.useMemo(() => {

diff --git a/packages/x-charts/src/models/plugin.ts b/packages/x-charts/src/models/plugin.ts
@@ -14,14 +14,12 @@ export type ColorProcessorsConfig<T extends ChartSeriesType> = {
   [Key in T]?: ColorProcessor<Key>;
 };
 
-export type ChartsPluginType<T extends ChartSeriesType> = {
-  seriesType: T;
-  seriesFormatter: Formatter<T>;
-  colorProcessor: ColorProcessor<T>;
-  xExtremumGetter?: ExtremumGetter<T>;
-  yExtremumGetter?: ExtremumGetter<T>;
-};
-
-export type ChartsPluginTypes<T extends ChartSeriesType> = {
-  [Key in T]: ChartsPluginType<Key>;
-}[T];
+export type ChartsPluginType<T> = T extends ChartSeriesType
+  ? {
+      seriesType: T;
+      seriesFormatter: Formatter<T>;
+      colorProcessor: ColorProcessor<T>;
+      xExtremumGetter?: ExtremumGetter<T>;
+      yExtremumGetter?: ExtremumGetter<T>;
+    }
+  : never;
diff --git a/scripts/x-charts.exports.json b/scripts/x-charts.exports.json
@@ -93,7 +93,6 @@
   { "name": "ChartsOnAxisClickHandlerProps", "kind": "Interface" },
   { "name": "ChartsPieSorting", "kind": "TypeAlias" },
   { "name": "ChartsPluginType", "kind": "TypeAlias" },
-  { "name": "ChartsPluginTypes", "kind": "TypeAlias" },
   { "name": "ChartsReferenceLine", "kind": "Function" },
   { "name": "ChartsReferenceLineClasses", "kind": "Interface" },
   { "name": "ChartsReferenceLineClassKey", "kind": "TypeAlias" },