@mui/x-data-grid-premium 8.9.1 → 8.9.2

package/esm/hooks/features/aiAssistant/api.d.ts

@@ -1,4 +1,4 @@
-import { PromptResponse } from "./gridAiAssistantInterfaces.js";
+import { PromptResponse, PromptResolverOptions } from "./gridAiAssistantInterfaces.js";
 /**
  * Prompt resolver for the <DataGridPremium /> component.
  * @param {string} url The URL to send the request to.
@@ -6,7 +6,7 @@ import { PromptResponse } from "./gridAiAssistantInterfaces.js";
  * @param {string} context The prompt context containing necessary information about the current columns definition.
  * Either use the `context` parameter of the `onPrompt` callback or the return value of the `unstable_getPromptContext()` API method.
  * @param {string} conversationId The id of the conversation the prompt is part of. If not passed, prompt response will return a new conversation id that can be used to continue the newly started conversation.
- * @param {string} additionalContext Optional, additional context to make the processing results more accurate.
+ * @param {string | PromptResolverOptions} optionsOrAdditionalContext Optional, includes settings to extend and customize the prompt resolver's behaviour, or additional context string for backward compatibility.
  * @returns {Promise<PromptResponse>} The grid state updates to be applied.
  */
-export declare function gridDefaultPromptResolver(url: string, query: string, context: string, conversationId?: string, additionalContext?: string): Promise<PromptResponse>;
+export declare function gridDefaultPromptResolver(url: string, query: string, context: string, conversationId?: string, optionsOrAdditionalContext?: string | PromptResolverOptions): Promise<PromptResponse>;

package/esm/hooks/features/aiAssistant/api.js

@@ -5,10 +5,14 @@
  * @param {string} context The prompt context containing necessary information about the current columns definition.
  * Either use the `context` parameter of the `onPrompt` callback or the return value of the `unstable_getPromptContext()` API method.
  * @param {string} conversationId The id of the conversation the prompt is part of. If not passed, prompt response will return a new conversation id that can be used to continue the newly started conversation.
- * @param {string} additionalContext Optional, additional context to make the processing results more accurate.
+ * @param {string | PromptResolverOptions} optionsOrAdditionalContext Optional, includes settings to extend and customize the prompt resolver's behaviour, or additional context string for backward compatibility.
  * @returns {Promise<PromptResponse>} The grid state updates to be applied.
  */
-export function gridDefaultPromptResolver(url, query, context, conversationId, additionalContext = '') {
+export function gridDefaultPromptResolver(url, query, context, conversationId, optionsOrAdditionalContext = '') {
+  // Handle backward compatibility: if string is passed, treat it as additionalContext
+  const options = typeof optionsOrAdditionalContext === 'string' ? {
+    additionalContext: optionsOrAdditionalContext
+  } : optionsOrAdditionalContext;
   return fetch(url, {
     mode: 'cors',
     method: 'POST',
@@ -19,8 +23,8 @@ export function gridDefaultPromptResolver(url, query, context, conversationId, a
     body: JSON.stringify({
       context,
       query,
-      additionalContext,
-      conversationId
+      conversationId,
+      options
     })
   }).then(result => result.json()).then(result => {
     if (result.ok === false) {

package/esm/hooks/features/aiAssistant/gridAiAssistantInterfaces.d.ts

@@ -49,6 +49,17 @@ export type PromptResponse = {
   grouping: Grouping[];
   pivoting: Pivoting;
 };
+export type PromptResolverOptions = {
+  /**
+   * By default, MUI's prompt resolver service stores the queries made to the service to analyze potential errors and improve the service (data is never stored). Enable private mode to make the service only keep track of the token count, without any query related data.
+   * @default false
+   */
+  privateMode?: boolean;
+  /**
+   * Additional context to make the processing results more accurate.
+   */
+  additionalContext?: string;
+};
 /**
  * The prompt API interface that is available in the grid [[apiRef]].
  */

package/esm/hooks/features/export/serializer/excelSerializer.js

@@ -47,12 +47,7 @@ export const serializeRowUnsafe = (id, columns, apiRef, defaultValueOptionsFormu
   const hasColSpan = gridHasColSpanSelector(apiRef);
   if (hasColSpan) {
     // `colSpan` is only calculated for rendered rows, so we need to calculate it during export for every row
-    apiRef.current.calculateColSpan({
-      rowId: id,
-      minFirstColumn: 0,
-      maxLastColumn: columns.length,
-      columns
-    });
+    apiRef.current.calculateColSpan(id, 0, columns.length, columns);
   }
   columns.forEach((column, colIndex) => {
     const colSpanInfo = hasColSpan ? apiRef.current.unstable_getCellColSpanInfo(id, colIndex) : undefined;

package/esm/hooks/features/index.d.ts

@@ -2,4 +2,5 @@ export * from "./aggregation/index.js";
 export * from "./rowGrouping/index.js";
 export * from "./export/index.js";
 export * from "./cellSelection/index.js";
-export * from "./aiAssistant/index.js";
+export * from "./aiAssistant/index.js";
+export * from "./sidebar/index.js";

package/esm/hooks/features/index.js

@@ -3,4 +3,5 @@ export * from "./aggregation/index.js";
 export * from "./rowGrouping/index.js";
 export * from "./export/index.js";
 export * from "./cellSelection/index.js";
-export * from "./aiAssistant/index.js";
+export * from "./aiAssistant/index.js";
+export * from "./sidebar/index.js";

package/esm/hooks/features/pivoting/gridPivotingInterfaces.d.ts

@@ -23,6 +23,10 @@ export interface GridPivotingState extends GridPivotingStatePartial {
 export interface GridPivotingInitialState {
   model?: GridPivotModel;
   enabled?: boolean;
+  /**
+   * To open the pivot sidebar on init, set sidebar's `openValue` to `GridSidebarValue.Pivot`.
+   * @deprecated Use sidebar state instead.
+   */
   panelOpen?: boolean;
 }
 export interface GridPivotModel {
@@ -55,6 +59,7 @@ export interface GridPivotingApi {
   setPivotActive: (active: boolean | ((prev: boolean) => boolean)) => void;
   /**
    * Sets whether the pivot panel is open.
+   * @deprecated Use the `showSidebar` method instead. Using this method will not trigger the `sidebarOpen` and `sidebarClose` events.
    * @param {boolean | ((prev: boolean) => boolean)} open - The new value of the pivot panel open state.
    */
   setPivotPanelOpen: (open: boolean | ((prev: boolean) => boolean)) => void;

package/esm/hooks/features/pivoting/gridPivotingSelectors.d.ts

@@ -1,8 +1,11 @@
 import type { GridStatePremium } from "../../../models/gridStatePremium.js";
+export declare const gridPivotPanelOpenSelector: (args_0: import("react").RefObject<{
+  state: GridStatePremium;
+} | null>) => boolean;
 export declare const gridPivotModelSelector: (args_0: import("react").RefObject<{
   state: GridStatePremium;
 } | null>) => import("./gridPivotingInterfaces.js").GridPivotModel;
 export declare const gridPivotPropsOverridesSelector: (args_0: import("react").RefObject<{
   state: GridStatePremium;
 } | null>) => import("./gridPivotingInterfaces.js").GridPivotingPropsOverrides | undefined;
-export { gridPivotActiveSelector, gridPivotInitialColumnsSelector, gridPivotPanelOpenSelector } from '@mui/x-data-grid/internals';
+export { gridPivotActiveSelector, gridPivotInitialColumnsSelector } from '@mui/x-data-grid/internals';

package/esm/hooks/features/pivoting/gridPivotingSelectors.js

@@ -1,5 +1,7 @@
 import { createSelector, createRootSelector } from '@mui/x-data-grid-pro/internals';
+import { gridSidebarStateSelector, GridSidebarValue } from "../sidebar/index.js";
 const gridPivotingStateSelector = createRootSelector(state => state.pivoting);
+export const gridPivotPanelOpenSelector = createSelector(gridSidebarStateSelector, sidebar => sidebar.value === GridSidebarValue.Pivot && sidebar.open);
 export const gridPivotModelSelector = createSelector(gridPivotingStateSelector, pivoting => pivoting?.model);
 export const gridPivotPropsOverridesSelector = createSelector(gridPivotingStateSelector, pivoting => pivoting?.active ? pivoting.propsOverrides : undefined);
-export { gridPivotActiveSelector, gridPivotInitialColumnsSelector, gridPivotPanelOpenSelector } from '@mui/x-data-grid/internals';
+export { gridPivotActiveSelector, gridPivotInitialColumnsSelector } from '@mui/x-data-grid/internals';

package/esm/hooks/features/pivoting/useGridPivoting.d.ts

@@ -3,6 +3,6 @@ import { RefObject } from '@mui/x-internals/types';
 import { GridStateInitializer } from '@mui/x-data-grid-pro/internals';
 import type { DataGridPremiumProcessedProps } from "../../../models/dataGridPremiumProps.js";
 import { GridPrivateApiPremium } from "../../../models/gridApiPremium.js";
-export declare const pivotingStateInitializer: GridStateInitializer<Pick<DataGridPremiumProcessedProps, 'pivotActive' | 'pivotModel' | 'pivotPanelOpen' | 'initialState' | 'disablePivoting' | 'getPivotDerivedColumns' | 'columns'>>;
+export declare const pivotingStateInitializer: GridStateInitializer<Pick<DataGridPremiumProcessedProps, 'pivotActive' | 'pivotModel' | 'pivotPanelOpen' | 'initialState' | 'disablePivoting' | 'getPivotDerivedColumns' | 'columns'>, GridPrivateApiPremium>;
 export declare const useGridPivoting: (apiRef: RefObject<GridPrivateApiPremium>, props: Pick<DataGridPremiumProcessedProps, "pivotActive" | "onPivotActiveChange" | "pivotModel" | "onPivotModelChange" | "pivotPanelOpen" | "onPivotPanelOpenChange" | "disablePivoting" | "getPivotDerivedColumns" | "pivotingColDef" | "groupingColDef" | "aggregationFunctions">, originalColumnsProp: readonly GridColDef[], originalRowsProp: readonly GridRowModel[]) => void;
 export declare const useGridPivotingExportState: (apiRef: RefObject<GridPrivateApiPremium>) => void;

package/esm/hooks/features/pivoting/useGridPivoting.js

@@ -4,9 +4,12 @@ import { gridDataRowIdsSelector, gridRowIdSelector, gridRowsLoadingSelector, gri
 import useEnhancedEffect from '@mui/utils/useEnhancedEffect';
 import useOnMount from '@mui/utils/useOnMount';
 import { useGridApiMethod, useGridRegisterPipeProcessor, useGridSelector, gridPivotInitialColumnsSelector } from '@mui/x-data-grid-pro/internals';
+import { GridPivotPanel } from "../../../components/pivotPanel/index.js";
 import { gridPivotModelSelector, gridPivotActiveSelector, gridPivotPanelOpenSelector } from "./gridPivotingSelectors.js";
 import { getInitialColumns, getPivotedData, isPivotingAvailable as isPivotingAvailableFn } from "./utils.js";
 import { getAvailableAggregationFunctions } from "../aggregation/gridAggregationUtils.js";
+import { GridSidebarValue } from "../sidebar/index.js";
+import { jsx as _jsx } from "react/jsx-runtime";
 const emptyPivotModel = {
   rows: [],
   columns: [],
@@ -25,19 +28,23 @@ export const pivotingStateInitializer = (state, props, apiRef) => {
     return _extends({}, state, {
       pivoting: {
         active: false,
-        model: emptyPivotModel,
-        panelOpen: false
+        model: emptyPivotModel
       }
     });
   }
   const initialColumns = getInitialColumns(props.columns ?? [], props.getPivotDerivedColumns, apiRef.current.getLocaleText);
+  const open = props.pivotPanelOpen ?? props.initialState?.pivoting?.panelOpen ?? false;
+  const sidebarStateUpdate = open ? {
+    open,
+    value: GridSidebarValue.Pivot
+  } : {};
   return _extends({}, state, {
     pivoting: {
       active: props.pivotActive ?? props.initialState?.pivoting?.enabled ?? false,
       model: props.pivotModel ?? props.initialState?.pivoting?.model ?? emptyPivotModel,
-      panelOpen: props.pivotPanelOpen ?? props.initialState?.pivoting?.panelOpen ?? false,
       initialColumns
-    }
+    },
+    sidebar: _extends({}, state.sidebar, sidebarStateUpdate)
   });
 };
 export const useGridPivoting = (apiRef, props, originalColumnsProp, originalRowsProp) => {
@@ -249,11 +256,16 @@ export const useGridPivoting = (apiRef, props, originalColumnsProp, originalRows
     if (!isPivotingAvailable) {
       return;
     }
-    apiRef.current.setState(state => _extends({}, state, {
-      pivoting: _extends({}, state.pivoting, {
-        panelOpen: typeof callback === 'function' ? callback(state.pivoting?.panelOpen) : callback
-      })
-    }));
+    const panelOpen = gridPivotPanelOpenSelector(apiRef);
+    const newPanelOpen = typeof callback === 'function' ? callback(panelOpen) : callback;
+    if (panelOpen === newPanelOpen) {
+      return;
+    }
+    if (newPanelOpen) {
+      apiRef.current.showSidebar(GridSidebarValue.Pivot);
+    } else {
+      apiRef.current.hideSidebar();
+    }
   }, [apiRef, isPivotingAvailable]);
   const addColumnMenuButton = React.useCallback(menuItems => {
     if (isPivotingAvailable) {
@@ -309,6 +321,13 @@ export const useGridPivoting = (apiRef, props, originalColumnsProp, originalRows
       });
     });
   }, [apiRef, computePivotingState, isPivotingAvailable, nonPivotDataRef]);
+  const addPivotingPanel = React.useCallback((initialValue, value) => {
+    if (isPivotingAvailable && value === GridSidebarValue.Pivot) {
+      return /*#__PURE__*/_jsx(GridPivotPanel, {});
+    }
+    return initialValue;
+  }, [isPivotingAvailable]);
+  useGridRegisterPipeProcessor(apiRef, 'sidebar', addPivotingPanel);
   useGridApiMethod(apiRef, {
     setPivotModel,
     setPivotActive,

package/esm/hooks/features/rowGrouping/createGroupingColDef.d.ts

@@ -1,8 +1,7 @@
 import { RefObject } from '@mui/x-internals/types';
 import { GridColDef, GridGroupingColDefOverride } from '@mui/x-data-grid-pro';
-import { GridColumnRawLookup } from '@mui/x-data-grid-pro/internals';
+import { GridColumnRawLookup, RowGroupingStrategy } from '@mui/x-data-grid-pro/internals';
 import { GridApiPremium } from "../../../models/gridApiPremium.js";
-import { RowGroupingStrategy } from "./gridRowGroupingUtils.js";
 interface CreateGroupingColDefMonoCriteriaParams {
   columnsLookup: GridColumnRawLookup;
   /**

package/esm/hooks/features/rowGrouping/createGroupingColDef.js

@@ -4,12 +4,12 @@ const _excluded = ["leafField", "mainGroupingCriteria", "hideDescendantCount"],
   _excluded2 = ["leafField", "mainGroupingCriteria", "hideDescendantCount"];
 import * as React from 'react';
 import { GRID_STRING_COL_DEF, gridRowIdSelector, gridRowNodeSelector } from '@mui/x-data-grid-pro';
-import { isSingleSelectColDef } from '@mui/x-data-grid-pro/internals';
+import { isSingleSelectColDef, RowGroupingStrategy } from '@mui/x-data-grid-pro/internals';
 import { GridGroupingColumnFooterCell } from "../../../components/GridGroupingColumnFooterCell.js";
 import { GridGroupingCriteriaCell } from "../../../components/GridGroupingCriteriaCell.js";
 import { GridDataSourceGroupingCriteriaCell } from "../../../components/GridDataSourceGroupingCriteriaCell.js";
 import { GridGroupingColumnLeafCell } from "../../../components/GridGroupingColumnLeafCell.js";
-import { getRowGroupingFieldFromGroupingCriteria, GRID_ROW_GROUPING_SINGLE_GROUPING_FIELD, RowGroupingStrategy } from "./gridRowGroupingUtils.js";
+import { getRowGroupingFieldFromGroupingCriteria, GRID_ROW_GROUPING_SINGLE_GROUPING_FIELD } from "./gridRowGroupingUtils.js";
 import { gridRowGroupingSanitizedModelSelector } from "./gridRowGroupingSelector.js";
 import { jsx as _jsx } from "react/jsx-runtime";
 const GROUPING_COL_DEF_DEFAULT_PROPERTIES = _extends({}, GRID_STRING_COL_DEF, {
@@ -65,7 +65,14 @@ const getLeafProperties = leafColDef => ({
     return groupingFieldIndexComparator(v1, v2, cellParams1, cellParams2);
   }
 });
-const groupedByColValueFormatter = groupedByColDef => (value, row, _, apiRef) => groupedByColDef.valueFormatter(value, row, groupedByColDef, apiRef);
+const groupedByColValueFormatter = groupedByColDef => (value, row, _, apiRef) => {
+  const rowId = gridRowIdSelector(apiRef, row);
+  const rowNode = gridRowNodeSelector(apiRef, rowId);
+  if (rowNode.type === 'group' && rowNode.groupingField === groupedByColDef.field) {
+    return groupedByColDef.valueFormatter(value, row, groupedByColDef, apiRef);
+  }
+  return value;
+};
 const getGroupingCriteriaProperties = (groupedByColDef, applyHeaderName) => {
   const properties = {
     sortable: groupedByColDef.sortable,

package/esm/hooks/features/rowGrouping/gridRowGroupingUtils.d.ts

@@ -1,15 +1,11 @@
 import { RefObject } from '@mui/x-internals/types';
 import { GridRowTreeConfig, GridFilterState, GridFilterModel, GridRowModel, GridColDef, GridKeyValue, GridDataSource } from '@mui/x-data-grid-pro';
-import { GridAggregatedFilterItemApplier, GridColumnRawLookup, GRID_ROW_GROUPING_SINGLE_GROUPING_FIELD, getRowGroupingCriteriaFromGroupingField, isGroupingColumn } from '@mui/x-data-grid-pro/internals';
+import { GridAggregatedFilterItemApplier, GridColumnRawLookup, GRID_ROW_GROUPING_SINGLE_GROUPING_FIELD, getRowGroupingCriteriaFromGroupingField, isGroupingColumn, RowGroupingStrategy } from '@mui/x-data-grid-pro/internals';
 import { DataGridPremiumProcessedProps } from "../../../models/dataGridPremiumProps.js";
 import { GridGroupingRule, GridGroupingRules, GridRowGroupingModel } from "./gridRowGroupingInterfaces.js";
 import { GridStatePremium } from "../../../models/gridStatePremium.js";
 import { GridPrivateApiPremium } from "../../../models/gridApiPremium.js";
 export { GRID_ROW_GROUPING_SINGLE_GROUPING_FIELD, getRowGroupingCriteriaFromGroupingField, isGroupingColumn };
-export declare enum RowGroupingStrategy {
-  Default = "grouping-columns",
-  DataSource = "grouping-columns-data-source",
-}
 export declare const getRowGroupingFieldFromGroupingCriteria: (groupingCriteria: string | null) => string;
 interface FilterRowTreeFromTreeDataParams {
   rowTree: GridRowTreeConfig;

package/esm/hooks/features/rowGrouping/gridRowGroupingUtils.js

@@ -1,12 +1,7 @@
 import _extends from "@babel/runtime/helpers/esm/extends";
-import { passFilterLogic, GRID_ROW_GROUPING_SINGLE_GROUPING_FIELD, getRowGroupingCriteriaFromGroupingField, isGroupingColumn, GridStrategyGroup, getRowValue } from '@mui/x-data-grid-pro/internals';
+import { passFilterLogic, GRID_ROW_GROUPING_SINGLE_GROUPING_FIELD, getRowGroupingCriteriaFromGroupingField, isGroupingColumn, GridStrategyGroup, getRowValue, RowGroupingStrategy } from '@mui/x-data-grid-pro/internals';
 import { gridRowGroupingSanitizedModelSelector } from "./gridRowGroupingSelector.js";
 export { GRID_ROW_GROUPING_SINGLE_GROUPING_FIELD, getRowGroupingCriteriaFromGroupingField, isGroupingColumn };
-export let RowGroupingStrategy = /*#__PURE__*/function (RowGroupingStrategy) {
-  RowGroupingStrategy["Default"] = "grouping-columns";
-  RowGroupingStrategy["DataSource"] = "grouping-columns-data-source";
-  return RowGroupingStrategy;
-}({});
 export const getRowGroupingFieldFromGroupingCriteria = groupingCriteria => {
   if (groupingCriteria === null) {
     return GRID_ROW_GROUPING_SINGLE_GROUPING_FIELD;

package/esm/hooks/features/rowGrouping/useGridDataSourceRowGroupingPreProcessors.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import { gridRowTreeSelector, gridColumnLookupSelector } from '@mui/x-data-grid-pro';
-import { useGridRegisterStrategyProcessor, createRowTree, updateRowTree, getVisibleRowsLookup, skipSorting, skipFiltering, getParentPath } from '@mui/x-data-grid-pro/internals';
-import { getGroupingRules, RowGroupingStrategy } from "./gridRowGroupingUtils.js";
+import { useGridRegisterStrategyProcessor, createRowTree, updateRowTree, getVisibleRowsLookup, skipSorting, skipFiltering, getParentPath, RowGroupingStrategy } from '@mui/x-data-grid-pro/internals';
+import { getGroupingRules } from "./gridRowGroupingUtils.js";
 import { gridRowGroupingSanitizedModelSelector } from "./gridRowGroupingSelector.js";
 export const useGridDataSourceRowGroupingPreProcessors = (apiRef, props) => {
   const createRowTreeForRowGrouping = React.useCallback(params => {

package/esm/hooks/features/rowGrouping/useGridRowGrouping.js

@@ -3,9 +3,9 @@
 import _extends from "@babel/runtime/helpers/esm/extends";
 import * as React from 'react';
 import { useGridEvent, useGridApiMethod, gridColumnLookupSelector } from '@mui/x-data-grid-pro';
-import { useGridRegisterPipeProcessor, GridStrategyGroup } from '@mui/x-data-grid-pro/internals';
+import { useGridRegisterPipeProcessor, GridStrategyGroup, RowGroupingStrategy } from '@mui/x-data-grid-pro/internals';
 import { gridRowGroupingModelSelector, gridRowGroupingSanitizedModelSelector } from "./gridRowGroupingSelector.js";
-import { getRowGroupingFieldFromGroupingCriteria, RowGroupingStrategy, isGroupingColumn, mergeStateWithRowGroupingModel, setStrategyAvailability, getGroupingRules, areGroupingRulesEqual } from "./gridRowGroupingUtils.js";
+import { getRowGroupingFieldFromGroupingCriteria, isGroupingColumn, mergeStateWithRowGroupingModel, setStrategyAvailability, getGroupingRules, areGroupingRulesEqual } from "./gridRowGroupingUtils.js";
 export const rowGroupingStateInitializer = (state, props, apiRef) => {
   apiRef.current.caches.rowGrouping = {
     rulesOnLastRowTreeCreation: []

package/esm/hooks/features/rowGrouping/useGridRowGroupingPreProcessors.js

@@ -2,10 +2,10 @@
 
 import * as React from 'react';
 import { gridColumnLookupSelector, gridRowTreeSelector, useFirstRender } from '@mui/x-data-grid-pro';
-import { useGridRegisterPipeProcessor, useGridRegisterStrategyProcessor, sortRowTree, createRowTree, updateRowTree, getVisibleRowsLookup } from '@mui/x-data-grid-pro/internals';
+import { useGridRegisterPipeProcessor, useGridRegisterStrategyProcessor, sortRowTree, createRowTree, updateRowTree, getVisibleRowsLookup, RowGroupingStrategy } from '@mui/x-data-grid-pro/internals';
 import { gridRowGroupingModelSelector, gridRowGroupingSanitizedModelSelector } from "./gridRowGroupingSelector.js";
 import { createGroupingColDefForAllGroupingCriteria, createGroupingColDefForOneGroupingCriteria } from "./createGroupingColDef.js";
-import { filterRowTreeFromGroupingColumns, getColDefOverrides, RowGroupingStrategy, isGroupingColumn, setStrategyAvailability, getCellGroupingCriteria, getGroupingRules } from "./gridRowGroupingUtils.js";
+import { filterRowTreeFromGroupingColumns, getColDefOverrides, isGroupingColumn, setStrategyAvailability, getCellGroupingCriteria, getGroupingRules } from "./gridRowGroupingUtils.js";
 export const useGridRowGroupingPreProcessors = (apiRef, props) => {
   const getGroupingColDefs = React.useCallback(columnsState => {
     if (props.disableRowGrouping) {

package/esm/hooks/features/rows/useGridRowAriaAttributes.d.ts

@@ -1 +1 @@
-export declare const useGridRowAriaAttributes: () => (rowNode: import("@mui/x-data-grid").GridTreeNode, index: number) => React.HTMLAttributes<HTMLElement>;
+export declare const useGridRowAriaAttributesPremium: () => (rowNode: import("@mui/x-data-grid").GridTreeNode, index: number) => React.HTMLAttributes<HTMLElement>;

package/esm/hooks/features/rows/useGridRowAriaAttributes.js

@@ -1,7 +1,7 @@
-import { useGridRowAriaAttributes as useGridRowAriaAttributesPro, useGridSelector } from '@mui/x-data-grid-pro/internals';
+import { useGridRowAriaAttributesPro, useGridSelector } from '@mui/x-data-grid-pro/internals';
 import { useGridPrivateApiContext } from "../../utils/useGridPrivateApiContext.js";
 import { gridRowGroupingSanitizedModelSelector } from "../rowGrouping/gridRowGroupingSelector.js";
-export const useGridRowAriaAttributes = () => {
+export const useGridRowAriaAttributesPremium = () => {
   const apiRef = useGridPrivateApiContext();
   const gridRowGroupingModel = useGridSelector(apiRef, gridRowGroupingSanitizedModelSelector);
   return useGridRowAriaAttributesPro(gridRowGroupingModel.length > 0);

package/esm/hooks/features/sidebar/gridSidebarInterfaces.d.ts

@@ -0,0 +1,16 @@
+export declare enum GridSidebarValue {
+  Pivot = "pivot",
+}
+export interface GridSidebarApi {
+  /**
+   * Displays the sidebar. The `newValue` argument controls the content of the sidebar.
+   * @param {GridSidebarValue} newValue The sidebar to open.
+   * @param {string} sidebarId The unique sidebar id
+   * @param {string} labelId The unique button id
+   */
+  showSidebar: (newValue: GridSidebarValue, sidebarId?: string, labelId?: string) => void;
+  /**
+   * Hides the sidebar.
+   */
+  hideSidebar: () => void;
+}

package/esm/hooks/features/sidebar/gridSidebarInterfaces.js

@@ -0,0 +1,4 @@
+export let GridSidebarValue = /*#__PURE__*/function (GridSidebarValue) {
+  GridSidebarValue["Pivot"] = "pivot";
+  return GridSidebarValue;
+}({});

package/esm/hooks/features/sidebar/gridSidebarSelector.d.ts

@@ -0,0 +1,12 @@
+import { GridStatePremium } from "../../../models/gridStatePremium.js";
+export declare const gridSidebarStateSelector: import("@mui/x-data-grid").OutputSelector<GridStatePremium, unknown, import("./gridSidebarState.js").GridSidebarState>;
+export declare const gridSidebarOpenSelector: (args_0: import("react").RefObject<{
+  state: GridStatePremium;
+} | null>) => boolean;
+export declare const gridSidebarContentSelector: (args_0: import("react").RefObject<{
+  state: GridStatePremium;
+} | null>) => {
+  sidebarId: string | undefined;
+  labelId: string | undefined;
+  value: import("./gridSidebarInterfaces.js").GridSidebarValue | undefined;
+};

package/esm/hooks/features/sidebar/gridSidebarSelector.js

@@ -0,0 +1,12 @@
+import { createRootSelector, createSelector } from '@mui/x-data-grid-pro/internals';
+export const gridSidebarStateSelector = createRootSelector(state => state.sidebar);
+export const gridSidebarOpenSelector = createSelector(gridSidebarStateSelector, state => state.open);
+export const gridSidebarContentSelector = createSelector(gridSidebarStateSelector, ({
+  sidebarId,
+  labelId,
+  value
+}) => ({
+  sidebarId,
+  labelId,
+  value
+}));

package/esm/hooks/features/sidebar/gridSidebarState.d.ts

@@ -0,0 +1,8 @@
+import { GridSidebarValue } from "./gridSidebarInterfaces.js";
+export interface GridSidebarState {
+  open: boolean;
+  sidebarId?: string;
+  labelId?: string;
+  value?: GridSidebarValue;
+}
+export type GridSidebarInitialState = GridSidebarState;

package/esm/hooks/features/sidebar/gridSidebarState.js

@@ -0,0 +1 @@
+export {};

package/esm/hooks/features/sidebar/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./gridSidebarInterfaces.js";
+export * from "./gridSidebarSelector.js";
+export * from "./gridSidebarState.js";

package/esm/hooks/features/sidebar/index.js

@@ -0,0 +1,3 @@
+export * from "./gridSidebarInterfaces.js";
+export * from "./gridSidebarSelector.js";
+export * from "./gridSidebarState.js";

package/esm/hooks/features/sidebar/useGridSidebar.d.ts

@@ -0,0 +1,6 @@
+import { RefObject } from '@mui/x-internals/types';
+import { GridStateInitializer } from '@mui/x-data-grid-pro/internals';
+import { DataGridPremiumProcessedProps } from "../../../models/dataGridPremiumProps.js";
+import { GridPrivateApiPremium } from "../../../models/gridApiPremium.js";
+export declare const sidebarStateInitializer: GridStateInitializer<Pick<DataGridPremiumProcessedProps, 'initialState'>>;
+export declare const useGridSidebar: (apiRef: RefObject<GridPrivateApiPremium>, props: Pick<DataGridPremiumProcessedProps, "initialState" | "onSidebarClose" | "onSidebarOpen">) => void;

package/esm/hooks/features/sidebar/useGridSidebar.js

@@ -0,0 +1,72 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import * as React from 'react';
+import { useGridApiMethod, useGridRegisterPipeProcessor, useGridEventPriority } from '@mui/x-data-grid-pro/internals';
+import { gridSidebarStateSelector } from "./gridSidebarSelector.js";
+export const sidebarStateInitializer = (state, props) => _extends({}, state, {
+  sidebar: props.initialState?.sidebar ?? {
+    open: false
+  }
+});
+export const useGridSidebar = (apiRef, props) => {
+  const hideSidebar = React.useCallback(() => {
+    apiRef.current.setState(state => {
+      if (!state.sidebar.open || !state.sidebar.value) {
+        return state;
+      }
+      apiRef.current.publishEvent('sidebarClose', {
+        value: state.sidebar.value
+      });
+      return _extends({}, state, {
+        sidebar: {
+          open: false
+        }
+      });
+    });
+  }, [apiRef]);
+  const showSidebar = React.useCallback((newValue, sidebarId, labelId) => {
+    apiRef.current.setState(state => _extends({}, state, {
+      sidebar: _extends({}, state.sidebar, {
+        open: true,
+        value: newValue,
+        sidebarId,
+        labelId
+      })
+    }));
+    apiRef.current.publishEvent('sidebarOpen', {
+      value: newValue
+    });
+  }, [apiRef]);
+  useGridApiMethod(apiRef, {
+    showSidebar,
+    hideSidebar
+  }, 'public');
+  const stateExportPreProcessing = React.useCallback((prevState, context) => {
+    const sidebarToExport = gridSidebarStateSelector(apiRef);
+    const shouldExportSidebar =
+    // Always export if the `exportOnlyDirtyModels` property is not activated
+    !context.exportOnlyDirtyModels ||
+    // Always export if the sidebar was initialized
+    props.initialState?.sidebar != null ||
+    // Always export if the sidebar is opened
+    sidebarToExport.open;
+    if (!shouldExportSidebar) {
+      return prevState;
+    }
+    return _extends({}, prevState, {
+      sidebar: sidebarToExport
+    });
+  }, [apiRef, props.initialState?.sidebar]);
+  const stateRestorePreProcessing = React.useCallback((params, context) => {
+    const sidebar = context.stateToRestore.sidebar;
+    if (sidebar != null) {
+      apiRef.current.setState(state => _extends({}, state, {
+        sidebar
+      }));
+    }
+    return params;
+  }, [apiRef]);
+  useGridRegisterPipeProcessor(apiRef, 'exportState', stateExportPreProcessing);
+  useGridRegisterPipeProcessor(apiRef, 'restoreState', stateRestorePreProcessing);
+  useGridEventPriority(apiRef, 'sidebarClose', props.onSidebarClose);
+  useGridEventPriority(apiRef, 'sidebarOpen', props.onSidebarOpen);
+};

package/esm/hooks/utils/useGridAriaAttributes.d.ts

@@ -1,2 +1,2 @@
 import * as React from 'react';
-export declare const useGridAriaAttributes: () => React.HTMLAttributes<HTMLElement>;
+export declare const useGridAriaAttributesPremium: () => React.HTMLAttributes<HTMLElement>;

package/esm/hooks/utils/useGridAriaAttributes.js

@@ -1,8 +1,8 @@
 import _extends from "@babel/runtime/helpers/esm/extends";
-import { useGridAriaAttributes as useGridAriaAttributesPro, useGridSelector } from '@mui/x-data-grid-pro/internals';
+import { useGridAriaAttributesPro, useGridSelector } from '@mui/x-data-grid-pro/internals';
 import { gridRowGroupingSanitizedModelSelector } from "../features/rowGrouping/gridRowGroupingSelector.js";
 import { useGridPrivateApiContext } from "./useGridPrivateApiContext.js";
-export const useGridAriaAttributes = () => {
+export const useGridAriaAttributesPremium = () => {
   const ariaAttributesPro = useGridAriaAttributesPro();
   const apiRef = useGridPrivateApiContext();
   const gridRowGroupingModel = useGridSelector(apiRef, gridRowGroupingSanitizedModelSelector);

package/esm/index.js

@@ -1,5 +1,5 @@
 /**
- * @mui/x-data-grid-premium v8.9.1
+ * @mui/x-data-grid-premium v8.9.2
  *
  * @license SEE LICENSE IN LICENSE
  * This source code is licensed under the SEE LICENSE IN LICENSE license found in the

package/esm/models/dataGridPremiumProps.d.ts

@@ -205,11 +205,13 @@ export interface DataGridPremiumPropsWithoutDefaultValue<R extends GridValidRowM
   /**
    * If `true`, the pivot side panel is visible.
    * @default false
+   * @deprecated Use `initialState.sidebar.open` instead.
    */
   pivotPanelOpen?: boolean;
   /**
    * Callback fired when the pivot side panel open state changes.
    * @param {boolean} pivotPanelOpen Whether the pivot side panel is visible.
+   * @deprecated Use the `sidebarOpen` and `sidebarClose` events or corresponding event handlers `onSidebarOpen()` and `onSidebarClose()` instead.
    */
   onPivotPanelOpenChange?: (pivotPanelOpen: boolean) => void;
   /**
@@ -254,4 +256,18 @@ export interface DataGridPremiumPropsWithoutDefaultValue<R extends GridValidRowM
    * @returns {Promise<PromptResponse>} The prompt response.
    */
   onPrompt?: (prompt: string, promptContext: string, conversationId?: string) => Promise<PromptResponse>;
+  /**
+   * Callback fired when the sidebar is closed.
+   * @param {GridSidebarParams} params With all properties from [[GridSidebarParams]].
+   * @param {MuiEvent<{}>} event The event object.
+   * @param {GridCallbackDetails} details Additional details for this callback.
+   */
+  onSidebarClose?: GridEventListener<'sidebarClose'>;
+  /**
+   * Callback fired when the sidebar is opened.
+   * @param {GridSidebarParams} params With all properties from [[GridSidebarParams]].
+   * @param {MuiEvent<{}>} event The event object.
+   * @param {GridCallbackDetails} details Additional details for this callback.
+   */
+  onSidebarOpen?: GridEventListener<'sidebarOpen'>;
 }

package/esm/models/gridApiPremium.d.ts

@@ -8,9 +8,10 @@ import type { GridDataSourcePremiumPrivateApi, GridDataSourceApiPremium } from "
 import type { GridAggregationPrivateApi } from "../hooks/features/aggregation/gridAggregationInterfaces.js";
 import type { GridPivotingApi, GridPivotingPrivateApi } from "../hooks/features/pivoting/gridPivotingInterfaces.js";
 import { GridAiAssistantApi } from "../hooks/features/aiAssistant/gridAiAssistantInterfaces.js";
+import { GridSidebarApi } from "../hooks/features/sidebar/gridSidebarInterfaces.js";
 /**
  * The api of Data Grid Premium.
  * TODO: Do not redefine manually the pro features
  */
-export interface GridApiPremium extends GridApiCommon<GridStatePremium, GridInitialStatePremium>, GridRowProApi, GridColumnPinningApi, GridDetailPanelApi, GridRowGroupingApi, GridExcelExportApi, GridAggregationApi, GridRowPinningApi, GridDataSourceApiPremium, GridCellSelectionApi, GridPivotingApi, GridAiAssistantApi, GridRowMultiSelectionApi, GridColumnReorderApi {}
+export interface GridApiPremium extends GridApiCommon<GridStatePremium, GridInitialStatePremium>, GridRowProApi, GridColumnPinningApi, GridDetailPanelApi, GridRowGroupingApi, GridExcelExportApi, GridAggregationApi, GridRowPinningApi, GridDataSourceApiPremium, GridCellSelectionApi, GridPivotingApi, GridAiAssistantApi, GridSidebarApi, GridRowMultiSelectionApi, GridColumnReorderApi {}
 export interface GridPrivateApiPremium extends GridApiPremium, GridPrivateOnlyApiCommon<GridApiPremium, GridPrivateApiPremium, DataGridPremiumProcessedProps>, GridDataSourcePremiumPrivateApi, GridAggregationPrivateApi, GridDetailPanelPrivateApi, GridPivotingPrivateApi {}

package/esm/models/gridStatePremium.d.ts

@@ -2,6 +2,7 @@ import { GridInitialState as GridInitialStatePro, GridState as GridStatePro } fr
 import type { GridRowGroupingState, GridRowGroupingInitialState, GridAggregationState, GridAggregationInitialState, GridCellSelectionModel } from "../hooks/index.js";
 import type { GridPivotingInitialState, GridPivotingState } from "../hooks/features/pivoting/gridPivotingInterfaces.js";
 import { GridAiAssistantInitialState, GridAiAssistantState } from "../hooks/features/aiAssistant/gridAiAssistantInterfaces.js";
+import { GridSidebarInitialState, GridSidebarState } from "../hooks/features/sidebar/gridSidebarState.js";
 /**
  * The state of Data Grid Premium.
  */
@@ -11,6 +12,7 @@ export interface GridStatePremium extends GridStatePro {
   cellSelection: GridCellSelectionModel;
   pivoting: GridPivotingState;
   aiAssistant: GridAiAssistantState;
+  sidebar: GridSidebarState;
 }
 /**
  * The initial state of Data Grid Premium.
@@ -21,4 +23,5 @@ export interface GridInitialStatePremium extends GridInitialStatePro {
   cellSelection?: GridCellSelectionModel;
   pivoting?: GridPivotingInitialState;
   aiAssistant?: GridAiAssistantInitialState;
+  sidebar?: GridSidebarInitialState;
 }