@mui/x-charts 9.0.0-alpha.2 → 9.0.0-alpha.3

package/context/ChartProvider/ChartProvider.types.d.mts

@@ -8,8 +8,8 @@ export type ChartContextValue<TSignatures extends readonly ChartAnyPluginSignatu
 /**
  * @deprecated Use `ChartsPluginParams` instead. We added S to the charts prefix to align with other components.
  */
-export type ChartPluginParams<TSeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[]> = ChartsPluginParams<TSeriesType, TSignatures>;
+export type ChartPluginParams<SeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[]> = ChartsPluginParams<SeriesType, TSignatures>;
 /**
  * @deprecated Use `ChartsProviderProps` instead. We added S to the charts prefix to align with other components.
  */
-export type ChartProviderProps<TSeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[]> = ChartsProviderProps<TSeriesType, TSignatures>;
+export type ChartProviderProps<SeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[]> = ChartsProviderProps<SeriesType, TSignatures>;

package/context/ChartProvider/ChartProvider.types.d.ts

@@ -8,8 +8,8 @@ export type ChartContextValue<TSignatures extends readonly ChartAnyPluginSignatu
 /**
  * @deprecated Use `ChartsPluginParams` instead. We added S to the charts prefix to align with other components.
  */
-export type ChartPluginParams<TSeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[]> = ChartsPluginParams<TSeriesType, TSignatures>;
+export type ChartPluginParams<SeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[]> = ChartsPluginParams<SeriesType, TSignatures>;
 /**
  * @deprecated Use `ChartsProviderProps` instead. We added S to the charts prefix to align with other components.
  */
-export type ChartProviderProps<TSeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[]> = ChartsProviderProps<TSeriesType, TSignatures>;
+export type ChartProviderProps<SeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[]> = ChartsProviderProps<SeriesType, TSignatures>;

package/context/ChartsProvider/ChartsProvider.d.mts

@@ -3,5 +3,5 @@ import type { ChartsProviderProps } from "./ChartsProvider.types.mjs";
 import { type ChartAnyPluginSignature } from "../../internals/plugins/models/index.mjs";
 import type { ChartSeriesType } from "../../models/seriesType/config.mjs";
 import type { ChartCorePluginSignatures } from "../../internals/plugins/corePlugins/index.mjs";
-declare function ChartsProvider<TSeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[] = ChartCorePluginSignatures<TSeriesType>>(props: React.PropsWithChildren<ChartsProviderProps<TSeriesType, TSignatures>>): import("react/jsx-runtime").JSX.Element;
+declare function ChartsProvider<SeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[] = ChartCorePluginSignatures<SeriesType>>(props: React.PropsWithChildren<ChartsProviderProps<SeriesType, TSignatures>>): import("react/jsx-runtime").JSX.Element;
 export { ChartsProvider };

package/context/ChartsProvider/ChartsProvider.d.ts

@@ -3,5 +3,5 @@ import type { ChartsProviderProps } from "./ChartsProvider.types.js";
 import { type ChartAnyPluginSignature } from "../../internals/plugins/models/index.js";
 import type { ChartSeriesType } from "../../models/seriesType/config.js";
 import type { ChartCorePluginSignatures } from "../../internals/plugins/corePlugins/index.js";
-declare function ChartsProvider<TSeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[] = ChartCorePluginSignatures<TSeriesType>>(props: React.PropsWithChildren<ChartsProviderProps<TSeriesType, TSignatures>>): import("react/jsx-runtime").JSX.Element;
+declare function ChartsProvider<SeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[] = ChartCorePluginSignatures<SeriesType>>(props: React.PropsWithChildren<ChartsProviderProps<SeriesType, TSignatures>>): import("react/jsx-runtime").JSX.Element;
 export { ChartsProvider };

package/context/ChartsProvider/ChartsProvider.types.d.mts

@@ -17,11 +17,11 @@ export type ChartsContextValue<TSignatures extends readonly ChartAnyPluginSignat
    */
   store: Store<ChartState<TSignatures, TOptionalSignatures>>;
 };
-export type ChartsPluginParams<TSeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[]> = UseChartBaseProps<TSignatures> & MergeSignaturesProperty<[...ChartCorePluginSignatures<TSeriesType>, ...TSignatures], 'params'>;
-export interface ChartsProviderProps<TSeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[]> {
+export type ChartsPluginParams<SeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[]> = UseChartBaseProps<TSignatures> & MergeSignaturesProperty<[...ChartCorePluginSignatures<SeriesType>, ...TSignatures], 'params'>;
+export interface ChartsProviderProps<SeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[]> {
   /**
    * Array of plugins used to add features to the chart.
    */
   plugins?: ConvertSignaturesIntoPlugins<TSignatures>;
-  pluginParams?: ChartsPluginParams<TSeriesType, TSignatures>;
+  pluginParams?: ChartsPluginParams<SeriesType, TSignatures>;
 }

package/context/ChartsProvider/ChartsProvider.types.d.ts

@@ -17,11 +17,11 @@ export type ChartsContextValue<TSignatures extends readonly ChartAnyPluginSignat
    */
   store: Store<ChartState<TSignatures, TOptionalSignatures>>;
 };
-export type ChartsPluginParams<TSeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[]> = UseChartBaseProps<TSignatures> & MergeSignaturesProperty<[...ChartCorePluginSignatures<TSeriesType>, ...TSignatures], 'params'>;
-export interface ChartsProviderProps<TSeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[]> {
+export type ChartsPluginParams<SeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[]> = UseChartBaseProps<TSignatures> & MergeSignaturesProperty<[...ChartCorePluginSignatures<SeriesType>, ...TSignatures], 'params'>;
+export interface ChartsProviderProps<SeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[]> {
   /**
    * Array of plugins used to add features to the chart.
    */
   plugins?: ConvertSignaturesIntoPlugins<TSignatures>;
-  pluginParams?: ChartsPluginParams<TSeriesType, TSignatures>;
+  pluginParams?: ChartsPluginParams<SeriesType, TSignatures>;
 }

package/hooks/index.d.mts

@@ -12,8 +12,8 @@ export { type UsePieSeriesReturnValue, type UsePieSeriesContextReturnValue, useP
 export * from "./useBarSeries.mjs";
 export * from "./useLineSeries.mjs";
 export * from "./useRadarSeries.mjs";
-export * from "./useItemHighlighted.mjs";
-export * from "./useItemHighlightedGetter.mjs";
+export * from "./useItemHighlightState.mjs";
+export * from "./useItemHighlightStateGetter.mjs";
 export * from "./useLegend.mjs";
 export { useChartGradientId, useChartGradientIdObjectBound } from "./useChartGradientId.mjs";
 export * from "./animation/index.mjs";

package/hooks/index.d.ts

@@ -12,8 +12,8 @@ export { type UsePieSeriesReturnValue, type UsePieSeriesContextReturnValue, useP
 export * from "./useBarSeries.js";
 export * from "./useLineSeries.js";
 export * from "./useRadarSeries.js";
-export * from "./useItemHighlighted.js";
-export * from "./useItemHighlightedGetter.js";
+export * from "./useItemHighlightState.js";
+export * from "./useItemHighlightStateGetter.js";
 export * from "./useLegend.js";
 export { useChartGradientId, useChartGradientIdObjectBound } from "./useChartGradientId.js";
 export * from "./animation/index.js";

package/hooks/index.js

@@ -204,27 +204,27 @@ Object.keys(_useRadarSeries).forEach(function (key) {
     }
   });
 });
-var _useItemHighlighted = require("./useItemHighlighted");
-Object.keys(_useItemHighlighted).forEach(function (key) {
+var _useItemHighlightState = require("./useItemHighlightState");
+Object.keys(_useItemHighlightState).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
-  if (key in exports && exports[key] === _useItemHighlighted[key]) return;
+  if (key in exports && exports[key] === _useItemHighlightState[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {
-      return _useItemHighlighted[key];
+      return _useItemHighlightState[key];
     }
   });
 });
-var _useItemHighlightedGetter = require("./useItemHighlightedGetter");
-Object.keys(_useItemHighlightedGetter).forEach(function (key) {
+var _useItemHighlightStateGetter = require("./useItemHighlightStateGetter");
+Object.keys(_useItemHighlightStateGetter).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
-  if (key in exports && exports[key] === _useItemHighlightedGetter[key]) return;
+  if (key in exports && exports[key] === _useItemHighlightStateGetter[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {
-      return _useItemHighlightedGetter[key];
+      return _useItemHighlightStateGetter[key];
     }
   });
 });

package/hooks/index.mjs

@@ -12,8 +12,8 @@ export { usePieSeries, usePieSeriesContext } from "./usePieSeries.mjs";
 export * from "./useBarSeries.mjs";
 export * from "./useLineSeries.mjs";
 export * from "./useRadarSeries.mjs";
-export * from "./useItemHighlighted.mjs";
-export * from "./useItemHighlightedGetter.mjs";
+export * from "./useItemHighlightState.mjs";
+export * from "./useItemHighlightStateGetter.mjs";
 export * from "./useLegend.mjs";
 export { useChartGradientId, useChartGradientIdObjectBound } from "./useChartGradientId.mjs";
 export * from "./animation/index.mjs";

package/hooks/useInteractionItemProps.d.mts

@@ -1,12 +1,11 @@
 import * as React from 'react';
-import { type SeriesItemIdentifierWithData } from "../models/index.mjs";
 import type { UseChartHighlightSignature } from "../internals/plugins/featurePlugins/useChartHighlight/index.mjs";
 import type { UseChartInteractionSignature } from "../internals/plugins/featurePlugins/useChartInteraction/index.mjs";
 import type { ChartSeriesType } from "../models/seriesType/config.mjs";
 import type { SeriesItemIdentifierWithType } from "../models/seriesType/index.mjs";
 import type { ChartInstance } from "../internals/plugins/models/index.mjs";
 import type { UseChartTooltipSignature } from "../internals/plugins/featurePlugins/useChartTooltip/index.mjs";
-export declare const useInteractionItemProps: <SeriesType extends ChartSeriesType>(data: SeriesItemIdentifierWithData<SeriesType>, skip?: boolean) => {
+export declare const useInteractionItemProps: <SeriesType extends ChartSeriesType>(data: SeriesItemIdentifierWithType<SeriesType>, skip?: boolean) => {
   onPointerEnter?: () => void;
   onPointerLeave?: () => void;
   onPointerDown?: (event: React.PointerEvent) => void;

package/hooks/useInteractionItemProps.d.ts

@@ -1,12 +1,11 @@
 import * as React from 'react';
-import { type SeriesItemIdentifierWithData } from "../models/index.js";
 import type { UseChartHighlightSignature } from "../internals/plugins/featurePlugins/useChartHighlight/index.js";
 import type { UseChartInteractionSignature } from "../internals/plugins/featurePlugins/useChartInteraction/index.js";
 import type { ChartSeriesType } from "../models/seriesType/config.js";
 import type { SeriesItemIdentifierWithType } from "../models/seriesType/index.js";
 import type { ChartInstance } from "../internals/plugins/models/index.js";
 import type { UseChartTooltipSignature } from "../internals/plugins/featurePlugins/useChartTooltip/index.js";
-export declare const useInteractionItemProps: <SeriesType extends ChartSeriesType>(data: SeriesItemIdentifierWithData<SeriesType>, skip?: boolean) => {
+export declare const useInteractionItemProps: <SeriesType extends ChartSeriesType>(data: SeriesItemIdentifierWithType<SeriesType>, skip?: boolean) => {
   onPointerEnter?: () => void;
   onPointerLeave?: () => void;
   onPointerDown?: (event: React.PointerEvent) => void;

package/hooks/{useItemHighlighted.d.mts → useItemHighlightState.d.mts}

@@ -1,24 +1,16 @@
 import type { HighlightItemIdentifierWithType } from "../models/seriesType/index.mjs";
 import type { ChartSeriesType } from "../models/seriesType/config.mjs";
-type UseItemHighlightedReturnType = {
-  /**
-   * Whether the item is highlighted.
-   */
-  isHighlighted: boolean;
-  /**
-   * Whether the item is faded.
-   */
-  isFaded: boolean;
-};
+export type HighlightState = 'highlighted' | 'faded' | 'none';
+type UseItemHighlightedReturnType = HighlightState;
 type UseItemHighlightedParams<SeriesType extends ChartSeriesType = ChartSeriesType> = HighlightItemIdentifierWithType<SeriesType> | null;
 /**
  * A hook to check the highlighted state of the item.
  * This function already calculates that an item is not faded if it is highlighted.
  *
- * If you need fine control over the state, use the `useItemHighlightedGetter` hook instead.
+ * If you need fine control over the state, use the `useItemHighlightStateGetter` hook instead.
  *
  * @param {HighlightItemIdentifierWithType<SeriesType> | null} item is the item to check
- * @returns {UseItemHighlightedReturnType} the state of the item
+ * @returns {HighlightState} the state of the item
  */
-export declare function useItemHighlighted<SeriesType extends ChartSeriesType = ChartSeriesType>(item: UseItemHighlightedParams<SeriesType>): UseItemHighlightedReturnType;
+export declare function useItemHighlightState<SeriesType extends ChartSeriesType = ChartSeriesType>(item: UseItemHighlightedParams<SeriesType>): UseItemHighlightedReturnType;
 export {};

package/hooks/{useItemHighlighted.d.ts → useItemHighlightState.d.ts}

@@ -1,24 +1,16 @@
 import type { HighlightItemIdentifierWithType } from "../models/seriesType/index.js";
 import type { ChartSeriesType } from "../models/seriesType/config.js";
-type UseItemHighlightedReturnType = {
-  /**
-   * Whether the item is highlighted.
-   */
-  isHighlighted: boolean;
-  /**
-   * Whether the item is faded.
-   */
-  isFaded: boolean;
-};
+export type HighlightState = 'highlighted' | 'faded' | 'none';
+type UseItemHighlightedReturnType = HighlightState;
 type UseItemHighlightedParams<SeriesType extends ChartSeriesType = ChartSeriesType> = HighlightItemIdentifierWithType<SeriesType> | null;
 /**
  * A hook to check the highlighted state of the item.
  * This function already calculates that an item is not faded if it is highlighted.
  *
- * If you need fine control over the state, use the `useItemHighlightedGetter` hook instead.
+ * If you need fine control over the state, use the `useItemHighlightStateGetter` hook instead.
  *
  * @param {HighlightItemIdentifierWithType<SeriesType> | null} item is the item to check
- * @returns {UseItemHighlightedReturnType} the state of the item
+ * @returns {HighlightState} the state of the item
  */
-export declare function useItemHighlighted<SeriesType extends ChartSeriesType = ChartSeriesType>(item: UseItemHighlightedParams<SeriesType>): UseItemHighlightedReturnType;
+export declare function useItemHighlightState<SeriesType extends ChartSeriesType = ChartSeriesType>(item: UseItemHighlightedParams<SeriesType>): UseItemHighlightedReturnType;
 export {};

package/hooks/{useItemHighlighted.js → useItemHighlightState.js}

@@ -4,24 +4,19 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.useItemHighlighted = useItemHighlighted;
+exports.useItemHighlightState = useItemHighlightState;
 var _useStore = require("../internals/store/useStore");
 var _useChartHighlight = require("../internals/plugins/featurePlugins/useChartHighlight");
 /**
  * A hook to check the highlighted state of the item.
  * This function already calculates that an item is not faded if it is highlighted.
  *
- * If you need fine control over the state, use the `useItemHighlightedGetter` hook instead.
+ * If you need fine control over the state, use the `useItemHighlightStateGetter` hook instead.
  *
  * @param {HighlightItemIdentifierWithType<SeriesType> | null} item is the item to check
- * @returns {UseItemHighlightedReturnType} the state of the item
+ * @returns {HighlightState} the state of the item
  */
-function useItemHighlighted(item) {
+function useItemHighlightState(item) {
   const store = (0, _useStore.useStore)();
-  const isHighlighted = store.use(_useChartHighlight.selectorChartsIsHighlighted, item);
-  const isFaded = store.use(_useChartHighlight.selectorChartsIsFaded, item);
-  return {
-    isHighlighted,
-    isFaded: !isHighlighted && isFaded
-  };
+  return store.use(_useChartHighlight.selectorChartsHighlightState, item);
 }

package/hooks/useItemHighlightState.mjs

@@ -0,0 +1,17 @@
+'use client';
+
+import { useStore } from "../internals/store/useStore.mjs";
+import { selectorChartsHighlightState } from "../internals/plugins/featurePlugins/useChartHighlight/index.mjs";
+/**
+ * A hook to check the highlighted state of the item.
+ * This function already calculates that an item is not faded if it is highlighted.
+ *
+ * If you need fine control over the state, use the `useItemHighlightStateGetter` hook instead.
+ *
+ * @param {HighlightItemIdentifierWithType<SeriesType> | null} item is the item to check
+ * @returns {HighlightState} the state of the item
+ */
+export function useItemHighlightState(item) {
+  const store = useStore();
+  return store.use(selectorChartsHighlightState, item);
+}

package/hooks/useItemHighlightStateGetter.d.mts

@@ -0,0 +1,9 @@
+import { type ChartSeriesType } from "../models/seriesType/config.mjs";
+/**
+ * A hook to get a callback that returns the highlight state of an item.
+ *
+ * If you're interested by a single item, consider using `useItemHighlightState`.
+ *
+ * @returns {(item: HighlightItemIdentifierWithType | null) => HighlightState} callback to get the highlight state of an item.
+ */
+export declare function useItemHighlightStateGetter<SeriesType extends ChartSeriesType>(): (item: import("../index.mjs").HighlightItemIdentifierWithType<import("../internals/index.mjs").ComposableChartSeriesType<keyof import("../internals/index.mjs").ChartsSeriesConfig>> | null) => import("./useItemHighlightState.mjs").HighlightState;

package/hooks/useItemHighlightStateGetter.d.ts

@@ -0,0 +1,9 @@
+import { type ChartSeriesType } from "../models/seriesType/config.js";
+/**
+ * A hook to get a callback that returns the highlight state of an item.
+ *
+ * If you're interested by a single item, consider using `useItemHighlightState`.
+ *
+ * @returns {(item: HighlightItemIdentifierWithType | null) => HighlightState} callback to get the highlight state of an item.
+ */
+export declare function useItemHighlightStateGetter<SeriesType extends ChartSeriesType>(): (item: import("../index.js").HighlightItemIdentifierWithType<import("../internals/index.js").ComposableChartSeriesType<keyof import("../internals/index.js").ChartsSeriesConfig>> | null) => import("./useItemHighlightState.js").HighlightState;

package/hooks/useItemHighlightStateGetter.js

@@ -0,0 +1,21 @@
+"use strict";
+'use client';
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useItemHighlightStateGetter = useItemHighlightStateGetter;
+var _useStore = require("../internals/store/useStore");
+var _useChartHighlight = require("../internals/plugins/featurePlugins/useChartHighlight/useChartHighlight.selectors");
+/**
+ * A hook to get a callback that returns the highlight state of an item.
+ *
+ * If you're interested by a single item, consider using `useItemHighlightState`.
+ *
+ * @returns {(item: HighlightItemIdentifierWithType | null) => HighlightState} callback to get the highlight state of an item.
+ */
+function useItemHighlightStateGetter() {
+  const store = (0, _useStore.useStore)();
+  const getHighlightState = store.use(_useChartHighlight.selectorChartsHighlightStateCallback);
+  return getHighlightState;
+}

package/hooks/useItemHighlightStateGetter.mjs

@@ -0,0 +1,16 @@
+'use client';
+
+import { useStore } from "../internals/store/useStore.mjs";
+import { selectorChartsHighlightStateCallback } from "../internals/plugins/featurePlugins/useChartHighlight/useChartHighlight.selectors.mjs";
+/**
+ * A hook to get a callback that returns the highlight state of an item.
+ *
+ * If you're interested by a single item, consider using `useItemHighlightState`.
+ *
+ * @returns {(item: HighlightItemIdentifierWithType | null) => HighlightState} callback to get the highlight state of an item.
+ */
+export function useItemHighlightStateGetter() {
+  const store = useStore();
+  const getHighlightState = store.use(selectorChartsHighlightStateCallback);
+  return getHighlightState;
+}

package/index.js

@@ -1,5 +1,5 @@
 /**
- * @mui/x-charts v9.0.0-alpha.2
+ * @mui/x-charts v9.0.0-alpha.3
  *
  * @license MIT
  * This source code is licensed under the MIT license found in the

package/index.mjs

@@ -1,5 +1,5 @@
 /**
- * @mui/x-charts v9.0.0-alpha.2
+ * @mui/x-charts v9.0.0-alpha.3
  *
  * @license MIT
  * This source code is licensed under the MIT license found in the

package/internals/commonNextFocusItem.d.mts

@@ -7,8 +7,8 @@ type ReturnedItem<OutSeriesType extends ChartSeriesType> = {
   seriesId: SeriesId;
   dataIndex: number;
 } | null;
-type StateParameters<TSeriesType extends ChartSeriesType> = Pick<ChartState<[UseChartKeyboardNavigationSignature], [], TSeriesType>, 'series'>;
-export declare function createGetNextIndexFocusedItem<InSeriesType extends Exclude<ChartSeriesType, 'sankey'>, OutSeriesType extends Exclude<ChartSeriesType, 'sankey'> = InSeriesType>(
+type StateParameters<SeriesType extends ChartSeriesType> = Pick<ChartState<[UseChartKeyboardNavigationSignature], [], SeriesType>, 'series'>;
+export declare function createGetNextIndexFocusedItem<InSeriesType extends Exclude<ChartSeriesType, 'sankey' | 'heatmap'>, OutSeriesType extends Exclude<ChartSeriesType, 'sankey' | 'heatmap'> = InSeriesType>(
 /**
  * The set of series types compatible with this navigation action.
  */
@@ -17,7 +17,7 @@ compatibleSeriesTypes: Set<OutSeriesType>,
  * If true, allows cycling from the last item to the first one.
  */
 allowCycles?: boolean): (currentItem: FocusedItemIdentifier<InSeriesType> | null, state: StateParameters<InSeriesType>) => ReturnedItem<OutSeriesType>;
-export declare function createGetPreviousIndexFocusedItem<InSeriesType extends Exclude<ChartSeriesType, 'sankey'>, OutSeriesType extends Exclude<ChartSeriesType, 'sankey'> = InSeriesType>(
+export declare function createGetPreviousIndexFocusedItem<InSeriesType extends Exclude<ChartSeriesType, 'sankey' | 'heatmap'>, OutSeriesType extends Exclude<ChartSeriesType, 'sankey' | 'heatmap'> = InSeriesType>(
 /**
  * The set of series types compatible with this navigation action.
  */
@@ -26,12 +26,12 @@ compatibleSeriesTypes: Set<OutSeriesType>,
  * If true, allows cycling from the last item to the first one.
  */
 allowCycles?: boolean): (currentItem: FocusedItemIdentifier<InSeriesType> | null, state: StateParameters<InSeriesType>) => ReturnedItem<OutSeriesType>;
-export declare function createGetNextSeriesFocusedItem<InSeriesType extends Exclude<ChartSeriesType, 'sankey'>, OutSeriesType extends Exclude<ChartSeriesType, 'sankey'> = InSeriesType>(
+export declare function createGetNextSeriesFocusedItem<InSeriesType extends Exclude<ChartSeriesType, 'sankey' | 'heatmap'>, OutSeriesType extends Exclude<ChartSeriesType, 'sankey' | 'heatmap'> = InSeriesType>(
 /**
  * The set of series types compatible with this navigation action.
  */
 compatibleSeriesTypes: Set<OutSeriesType>): (currentItem: FocusedItemIdentifier<InSeriesType> | null, state: StateParameters<InSeriesType>) => ReturnedItem<OutSeriesType>;
-export declare function createGetPreviousSeriesFocusedItem<InSeriesType extends Exclude<ChartSeriesType, 'sankey'>, OutSeriesType extends Exclude<ChartSeriesType, 'sankey'> = InSeriesType>(
+export declare function createGetPreviousSeriesFocusedItem<InSeriesType extends Exclude<ChartSeriesType, 'sankey' | 'heatmap'>, OutSeriesType extends Exclude<ChartSeriesType, 'sankey' | 'heatmap'> = InSeriesType>(
 /**
  * The set of series types compatible with this navigation action.
  */

package/internals/commonNextFocusItem.d.ts

@@ -7,8 +7,8 @@ type ReturnedItem<OutSeriesType extends ChartSeriesType> = {
   seriesId: SeriesId;
   dataIndex: number;
 } | null;
-type StateParameters<TSeriesType extends ChartSeriesType> = Pick<ChartState<[UseChartKeyboardNavigationSignature], [], TSeriesType>, 'series'>;
-export declare function createGetNextIndexFocusedItem<InSeriesType extends Exclude<ChartSeriesType, 'sankey'>, OutSeriesType extends Exclude<ChartSeriesType, 'sankey'> = InSeriesType>(
+type StateParameters<SeriesType extends ChartSeriesType> = Pick<ChartState<[UseChartKeyboardNavigationSignature], [], SeriesType>, 'series'>;
+export declare function createGetNextIndexFocusedItem<InSeriesType extends Exclude<ChartSeriesType, 'sankey' | 'heatmap'>, OutSeriesType extends Exclude<ChartSeriesType, 'sankey' | 'heatmap'> = InSeriesType>(
 /**
  * The set of series types compatible with this navigation action.
  */
@@ -17,7 +17,7 @@ compatibleSeriesTypes: Set<OutSeriesType>,
  * If true, allows cycling from the last item to the first one.
  */
 allowCycles?: boolean): (currentItem: FocusedItemIdentifier<InSeriesType> | null, state: StateParameters<InSeriesType>) => ReturnedItem<OutSeriesType>;
-export declare function createGetPreviousIndexFocusedItem<InSeriesType extends Exclude<ChartSeriesType, 'sankey'>, OutSeriesType extends Exclude<ChartSeriesType, 'sankey'> = InSeriesType>(
+export declare function createGetPreviousIndexFocusedItem<InSeriesType extends Exclude<ChartSeriesType, 'sankey' | 'heatmap'>, OutSeriesType extends Exclude<ChartSeriesType, 'sankey' | 'heatmap'> = InSeriesType>(
 /**
  * The set of series types compatible with this navigation action.
  */
@@ -26,12 +26,12 @@ compatibleSeriesTypes: Set<OutSeriesType>,
  * If true, allows cycling from the last item to the first one.
  */
 allowCycles?: boolean): (currentItem: FocusedItemIdentifier<InSeriesType> | null, state: StateParameters<InSeriesType>) => ReturnedItem<OutSeriesType>;
-export declare function createGetNextSeriesFocusedItem<InSeriesType extends Exclude<ChartSeriesType, 'sankey'>, OutSeriesType extends Exclude<ChartSeriesType, 'sankey'> = InSeriesType>(
+export declare function createGetNextSeriesFocusedItem<InSeriesType extends Exclude<ChartSeriesType, 'sankey' | 'heatmap'>, OutSeriesType extends Exclude<ChartSeriesType, 'sankey' | 'heatmap'> = InSeriesType>(
 /**
  * The set of series types compatible with this navigation action.
  */
 compatibleSeriesTypes: Set<OutSeriesType>): (currentItem: FocusedItemIdentifier<InSeriesType> | null, state: StateParameters<InSeriesType>) => ReturnedItem<OutSeriesType>;
-export declare function createGetPreviousSeriesFocusedItem<InSeriesType extends Exclude<ChartSeriesType, 'sankey'>, OutSeriesType extends Exclude<ChartSeriesType, 'sankey'> = InSeriesType>(
+export declare function createGetPreviousSeriesFocusedItem<InSeriesType extends Exclude<ChartSeriesType, 'sankey' | 'heatmap'>, OutSeriesType extends Exclude<ChartSeriesType, 'sankey' | 'heatmap'> = InSeriesType>(
 /**
  * The set of series types compatible with this navigation action.
  */

package/internals/createCommonKeyboardFocusHandler.d.mts

@@ -2,14 +2,14 @@ import type { ChartSeriesType } from "../models/seriesType/config.mjs";
 /**
  * Create a keyboard focus handler for common use cases where focused item are defined by the series is and data index.
  */
-export declare function createCommonKeyboardFocusHandler<TSeriesType extends Exclude<ChartSeriesType, 'sankey'>, TInputSeriesType extends Exclude<ChartSeriesType, 'sankey'> = TSeriesType>(outSeriesTypes: Set<TSeriesType>, allowCycles?: boolean): (event: KeyboardEvent) => ((currentItem: import("../index.mjs").FocusedItemIdentifier<TInputSeriesType> | null, state: {
+export declare function createCommonKeyboardFocusHandler<SeriesType extends Exclude<ChartSeriesType, 'sankey' | 'heatmap'>, TInputSeriesType extends Exclude<ChartSeriesType, 'sankey' | 'heatmap'> = SeriesType>(outSeriesTypes: Set<SeriesType>, allowCycles?: boolean): (event: KeyboardEvent) => ((currentItem: import("../index.mjs").FocusedItemIdentifier<TInputSeriesType> | null, state: {
   series: {
     defaultizedSeries: import("./plugins/corePlugins/useChartSeries/useChartSeries.types.mjs").DefaultizedSeriesGroups<TInputSeriesType>;
     idToType: import("./index.mjs").SeriesIdToType;
     dataset?: Readonly<import("./index.mjs").DatasetType>;
   };
 }) => {
-  type: TSeriesType;
+  type: SeriesType;
   seriesId: import("../index.mjs").SeriesId;
   dataIndex: number;
 } | null) | null;

package/internals/createCommonKeyboardFocusHandler.d.ts

@@ -2,14 +2,14 @@ import type { ChartSeriesType } from "../models/seriesType/config.js";
 /**
  * Create a keyboard focus handler for common use cases where focused item are defined by the series is and data index.
  */
-export declare function createCommonKeyboardFocusHandler<TSeriesType extends Exclude<ChartSeriesType, 'sankey'>, TInputSeriesType extends Exclude<ChartSeriesType, 'sankey'> = TSeriesType>(outSeriesTypes: Set<TSeriesType>, allowCycles?: boolean): (event: KeyboardEvent) => ((currentItem: import("../index.js").FocusedItemIdentifier<TInputSeriesType> | null, state: {
+export declare function createCommonKeyboardFocusHandler<SeriesType extends Exclude<ChartSeriesType, 'sankey' | 'heatmap'>, TInputSeriesType extends Exclude<ChartSeriesType, 'sankey' | 'heatmap'> = SeriesType>(outSeriesTypes: Set<SeriesType>, allowCycles?: boolean): (event: KeyboardEvent) => ((currentItem: import("../index.js").FocusedItemIdentifier<TInputSeriesType> | null, state: {
   series: {
     defaultizedSeries: import("./plugins/corePlugins/useChartSeries/useChartSeries.types.js").DefaultizedSeriesGroups<TInputSeriesType>;
     idToType: import("./index.js").SeriesIdToType;
     dataset?: Readonly<import("./index.js").DatasetType>;
   };
 }) => {
-  type: TSeriesType;
+  type: SeriesType;
   seriesId: import("../index.js").SeriesId;
   dataIndex: number;
 } | null) | null;

package/internals/identifierCleaner.d.mts

@@ -1,11 +1,15 @@
 import type { SeriesId, SeriesItemIdentifierWithType } from "../models/index.mjs";
-import type { ChartSeriesType } from "../models/seriesType/config.mjs";
+import type { SeriesTypeWithDataIndex } from "../models/seriesType/config.mjs";
 /**
  * Cleans an identifier by extracting only type, seriesId, and dataIndex properties.
  * This is the common cleaner for most series types (bar, line, pie, scatter, radar, etc.).
+ *
+ * The generic constraint ensures this can only be used for series types whose
+ * identifier actually includes `dataIndex`. Series types with different identifier
+ * properties (like heatmap's xIndex/yIndex) must provide their own cleaner.
  */
-export declare const identifierCleanerSeriesIdDataIndex: <T extends ChartSeriesType>(identifier: {
-  type: T;
+export declare const identifierCleanerSeriesIdDataIndex: <SeriesType extends SeriesTypeWithDataIndex>(identifier: {
+  type: SeriesType;
   seriesId: SeriesId;
   dataIndex?: number;
-}) => SeriesItemIdentifierWithType<T>;
+}) => SeriesItemIdentifierWithType<SeriesType>;

package/internals/identifierCleaner.d.ts

@@ -1,11 +1,15 @@
 import type { SeriesId, SeriesItemIdentifierWithType } from "../models/index.js";
-import type { ChartSeriesType } from "../models/seriesType/config.js";
+import type { SeriesTypeWithDataIndex } from "../models/seriesType/config.js";
 /**
  * Cleans an identifier by extracting only type, seriesId, and dataIndex properties.
  * This is the common cleaner for most series types (bar, line, pie, scatter, radar, etc.).
+ *
+ * The generic constraint ensures this can only be used for series types whose
+ * identifier actually includes `dataIndex`. Series types with different identifier
+ * properties (like heatmap's xIndex/yIndex) must provide their own cleaner.
  */
-export declare const identifierCleanerSeriesIdDataIndex: <T extends ChartSeriesType>(identifier: {
-  type: T;
+export declare const identifierCleanerSeriesIdDataIndex: <SeriesType extends SeriesTypeWithDataIndex>(identifier: {
+  type: SeriesType;
   seriesId: SeriesId;
   dataIndex?: number;
-}) => SeriesItemIdentifierWithType<T>;
+}) => SeriesItemIdentifierWithType<SeriesType>;

package/internals/identifierCleaner.js

@@ -7,9 +7,13 @@ exports.identifierCleanerSeriesIdDataIndex = void 0;
 /**
  * Cleans an identifier by extracting only type, seriesId, and dataIndex properties.
  * This is the common cleaner for most series types (bar, line, pie, scatter, radar, etc.).
+ *
+ * The generic constraint ensures this can only be used for series types whose
+ * identifier actually includes `dataIndex`. Series types with different identifier
+ * properties (like heatmap's xIndex/yIndex) must provide their own cleaner.
  */
 const identifierCleanerSeriesIdDataIndex = identifier => {
-  // @ts-expect-error we need to trust the output type here, since T is generic
+  // @ts-expect-error we need to trust the output type here, since SeriesType is generic
   return {
     type: identifier.type,
     seriesId: identifier.seriesId,

package/internals/identifierCleaner.mjs

@@ -1,9 +1,13 @@
 /**
  * Cleans an identifier by extracting only type, seriesId, and dataIndex properties.
  * This is the common cleaner for most series types (bar, line, pie, scatter, radar, etc.).
+ *
+ * The generic constraint ensures this can only be used for series types whose
+ * identifier actually includes `dataIndex`. Series types with different identifier
+ * properties (like heatmap's xIndex/yIndex) must provide their own cleaner.
  */
 export const identifierCleanerSeriesIdDataIndex = identifier => {
-  // @ts-expect-error we need to trust the output type here, since T is generic
+  // @ts-expect-error we need to trust the output type here, since SeriesType is generic
   return {
     type: identifier.type,
     seriesId: identifier.seriesId,

package/internals/identifierSerializer.d.mts

@@ -1,9 +1,17 @@
 import type { SeriesId } from "../models/index.mjs";
+import type { SeriesTypeWithDataIndex } from "../models/seriesType/config.mjs";
 export declare const typeSerializer: (type: string) => string;
 export declare const seriesIdSerializer: (id: SeriesId) => string;
 export declare const dataIndexSerializer: (dataIndex?: number) => string;
-export declare const identifierSerializerSeriesIdDataIndex: (identifier: {
-  type: string;
+/**
+ * Serializes an identifier using type, seriesId, and dataIndex properties.
+ *
+ * The generic constraint ensures this can only be used for series types whose
+ * identifier actually includes `dataIndex`. Series types with different identifier
+ * properties (like heatmap's xIndex/yIndex) must provide their own serializer.
+ */
+export declare const identifierSerializerSeriesIdDataIndex: <SeriesType extends SeriesTypeWithDataIndex>(identifier: {
+  type: SeriesType;
   seriesId: SeriesId;
   dataIndex?: number;
 }) => string;

package/internals/identifierSerializer.d.ts

@@ -1,9 +1,17 @@
 import type { SeriesId } from "../models/index.js";
+import type { SeriesTypeWithDataIndex } from "../models/seriesType/config.js";
 export declare const typeSerializer: (type: string) => string;
 export declare const seriesIdSerializer: (id: SeriesId) => string;
 export declare const dataIndexSerializer: (dataIndex?: number) => string;
-export declare const identifierSerializerSeriesIdDataIndex: (identifier: {
-  type: string;
+/**
+ * Serializes an identifier using type, seriesId, and dataIndex properties.
+ *
+ * The generic constraint ensures this can only be used for series types whose
+ * identifier actually includes `dataIndex`. Series types with different identifier
+ * properties (like heatmap's xIndex/yIndex) must provide their own serializer.
+ */
+export declare const identifierSerializerSeriesIdDataIndex: <SeriesType extends SeriesTypeWithDataIndex>(identifier: {
+  type: SeriesType;
   seriesId: SeriesId;
   dataIndex?: number;
 }) => string;

package/internals/identifierSerializer.js

@@ -9,6 +9,14 @@ exports.typeSerializer = typeSerializer;
 const seriesIdSerializer = id => `Series(${id})`;
 exports.seriesIdSerializer = seriesIdSerializer;
 const dataIndexSerializer = dataIndex => dataIndex === undefined ? '' : `Index(${dataIndex})`;
+
+/**
+ * Serializes an identifier using type, seriesId, and dataIndex properties.
+ *
+ * The generic constraint ensures this can only be used for series types whose
+ * identifier actually includes `dataIndex`. Series types with different identifier
+ * properties (like heatmap's xIndex/yIndex) must provide their own serializer.
+ */
 exports.dataIndexSerializer = dataIndexSerializer;
 const identifierSerializerSeriesIdDataIndex = identifier => {
   return `${typeSerializer(identifier.type)}${seriesIdSerializer(identifier.seriesId)}${dataIndexSerializer(identifier.dataIndex)}`;