[charts] Harmonize charts TS

[alexfauquette]

Extracted from #13209

The idea is to put all TS definitions related to the series in the config interface, such that the pro package could define config for other series which will then be derived into other types.

[mui-bot]

Deploy preview: https://deploy-preview-13366--material-ui-x.netlify.app/

Generated by 🚫 dangerJS against c67ff63

[JCQuintas]

Should we have a singleton where we can register different types of cartesian series? something like

class CartesianSeriesTypes {
  _types: Set<ChartSeriesType> = new Set(['bar', 'line', 'scatter'])

  constructor() {
    if (CartesianSeriesTypes._instance) {
      return CartesianSeriesTypes._instance
    }
    CartesianSeriesTypes._instance = this;
  }

  addType(value: 'string') { _types.add(value) }
  getTypes() { return _types }
}

this would allow us to register new types from other packages. We could also make the class a bit more generic and instead allow registering full configurations, eg: SeriesTypes.register({ name: "heatmap", formatter: (v) => v.foo, isCartesian: true })

[alexfauquette]

Then you would instantiate it in the index.ts of each package.

Can be an elegant solution for the isCartesianSeriesType. I'm not fully in favor of expanding this strategy to other aspect, because one advantage of plugins is the tree shaking. Since the heatmap logic is only imported in tht src/Heatmap/ folder, if you don't import it you will not bundle its logic. Same for the tree view, radar, and other upcoming charts. Not sure it will be the same with this approach

[JCQuintas]

Technically we could only register if the user imports charts/heatmap or something like that.

I've been thinking about the plugin, and the drawback might be that we will need to pass the configuration around to everything that would need it 😅

[alexfauquette]

the drawback might be that we will need to pass the configuration around to everything that would need it 😅

We only need to add them in the single component definition:

// In src/Heatmap/heatmap.tsx
<ChartsContainer plugins={[heatmpaPlugin]} > ... 

If user do composition they will have to do the same thing when defining their component.

[alexfauquette]

I did the modification for the config. I did not used it in the pro package yet, because otherwise TS will complain that 'heatmap' is not a series type yet. Will be added in the next PR

[JCQuintas]

File name is wrong

[alexfauquette]

Which one would you recomand?

I preferred to keep a single file for both isCartesianSeries and isCartesianSeriesType so I picked the common part that is not the exact name of a function

[JCQuintas]

Oh, I don't mind much, the issue is that isCaterisan is the wrong spelling. Should be isCartesian

[alexfauquette]

Thanks 🙏

I'm somewhat insensitive to letter order, if I don't focus on a specific word

[github-actions]

This pull request has conflicts, please resolve those before we can evaluate the pull request.