@mui/x-data-grid-premium 8.10.1 → 8.11.0

package/hooks/features/rows/useGridRowsOverridableMethods.js

@@ -0,0 +1,60 @@
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useGridRowsOverridableMethods = void 0;
+var React = _interopRequireWildcard(require("react"));
+var _xDataGridPro = require("@mui/x-data-grid-pro");
+var _internals = require("@mui/x-data-grid-pro/internals");
+var _reorderExecutor = require("../rowReorder/reorderExecutor");
+const useGridRowsOverridableMethods = (apiRef, props) => {
+  const {
+    processRowUpdate,
+    onProcessRowUpdateError
+  } = props;
+  const setRowIndex = React.useCallback(async (sourceRowId, targetOriginalIndex) => {
+    const sortedFilteredRowIds = (0, _xDataGridPro.gridExpandedSortedRowIdsSelector)(apiRef);
+    const sortedFilteredRowIndexLookup = (0, _internals.gridExpandedSortedRowIndexLookupSelector)(apiRef);
+    const rowTree = (0, _xDataGridPro.gridRowTreeSelector)(apiRef);
+    const sourceNode = (0, _xDataGridPro.gridRowNodeSelector)(apiRef, sourceRowId);
+    if (!sourceNode) {
+      throw new Error(`MUI X: No row with id #${sourceRowId} found.`);
+    }
+    if (sourceNode.type === 'footer') {
+      throw new Error(`MUI X: The row reordering do not support reordering of footer rows.`);
+    }
+
+    /**
+     * Row Grouping Reordering Use Cases
+     * =================================
+     *
+     * | Case | Source Node | Target Node | Parent Relationship       | Action                                                                      |
+     * | :--- | :---------- | :---------- | :------------------------ | :-------------------------------------------------------------------------- |
+     * | A ✅ | Leaf        | Leaf        | Same parent               | Swap positions (similar to flat tree structure)                             |
+     * | B ✅ | Group       | Group       | Same parent               | Swap positions (along with their descendants)                               |
+     * | C ✅ | Leaf        | Leaf        | Different parents         | Make source node a child of target's parent and update parent nodes in tree |
+     * | D ✅ | Leaf        | Group       | Different parents         | Make source a child of target, only allowed at same depth as source.parent  |
+     * | E ❌ | Leaf        | Group       | Target is source's parent | Not allowed, will have no difference                                        |
+     * | F ❌ | Group       | Leaf        | Any                       | Not allowed, will break the row grouping criteria                           |
+     * | G ✅ | Group       | Group       | Different parents         | Only allowed at same depth to preserve grouping criteria                    |
+     */
+
+    const executionContext = {
+      sourceRowId,
+      placeholderIndex: targetOriginalIndex,
+      sortedFilteredRowIds,
+      sortedFilteredRowIndexLookup,
+      rowTree,
+      apiRef,
+      processRowUpdate,
+      onProcessRowUpdateError
+    };
+    await _reorderExecutor.rowGroupingReorderExecutor.execute(executionContext);
+  }, [apiRef, processRowUpdate, onProcessRowUpdateError]);
+  return {
+    setRowIndex
+  };
+};
+exports.useGridRowsOverridableMethods = useGridRowsOverridableMethods;

package/index.js

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

package/models/gridGroupingValueSetter.d.ts

@@ -0,0 +1,14 @@
+import { RefObject } from '@mui/x-internals/types';
+import { GridValidRowModel, GridColDef, GridKeyValue } from '@mui/x-data-grid-pro';
+import { GridApiPremium } from "./gridApiPremium.js";
+/**
+ * Function signature for setting a grouping value on a row.
+ * This is the inverse operation of GridGroupingValueGetter.
+ *
+ * @param {GridKeyValue | null | undefined} groupingValue The grouping value to set
+ * @param {R} row The row to update
+ * @param {GridColDef<R>} column The column definition
+ * @param {RefObject<GridApiPremium>} apiRef Reference to the grid API
+ * @returns {R} The updated row with the new grouping value applied
+ */
+export type GridGroupingValueSetter<R extends GridValidRowModel = GridValidRowModel> = (groupingValue: GridKeyValue | null | undefined, row: R, column: GridColDef<R>, apiRef: RefObject<GridApiPremium>) => R;

package/models/gridGroupingValueSetter.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/models/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./gridApiPremium.js";
 export * from "./gridGroupingValueGetter.js";
+export * from "./gridGroupingValueSetter.js";
 export * from "./gridPremiumIconSlotsComponent.js";
 export * from "./gridPremiumSlotsComponent.js";
 export * from "./gridPastedValueParser.js";

package/models/index.js

@@ -25,6 +25,17 @@ Object.keys(_gridGroupingValueGetter).forEach(function (key) {
     }
   });
 });
+var _gridGroupingValueSetter = require("./gridGroupingValueSetter");
+Object.keys(_gridGroupingValueSetter).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _gridGroupingValueSetter[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _gridGroupingValueSetter[key];
+    }
+  });
+});
 var _gridPremiumIconSlotsComponent = require("./gridPremiumIconSlotsComponent");
 Object.keys(_gridPremiumIconSlotsComponent).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/x-data-grid-premium",
-  "version": "8.10.1",
+  "version": "8.11.0",
   "author": "MUI Team",
   "description": "The Premium plan edition of the MUI X Data Grid Components.",
   "main": "./index.js",
@@ -40,10 +40,10 @@
     "clsx": "^2.1.1",
     "exceljs": "^4.4.0",
     "prop-types": "^15.8.1",
-    "@mui/x-data-grid": "8.10.1",
-    "@mui/x-data-grid-pro": "8.10.1",
-    "@mui/x-license": "8.10.1",
-    "@mui/x-internals": "8.10.0"
+    "@mui/x-license": "8.11.0",
+    "@mui/x-internals": "8.11.0",
+    "@mui/x-data-grid-pro": "8.11.0",
+    "@mui/x-data-grid": "8.11.0"
   },
   "peerDependencies": {
     "@emotion/react": "^11.9.0",

package/typeOverloads/modules.d.ts

@@ -1,6 +1,6 @@
 import { GridExportDisplayOptions, GridValidRowModel } from '@mui/x-data-grid-pro';
 import type { GridPipeProcessingLookupPro, GridControlledStateEventLookupPro, GridApiCachesPro, GridEventLookupPro } from '@mui/x-data-grid-pro/typeOverloads';
-import type { GridGroupingValueGetter, GridPastedValueParser } from "../models/index.js";
+import type { GridGroupingValueGetter, GridGroupingValueSetter, GridPastedValueParser } from "../models/index.js";
 import type { GridRowGroupingModel, GridAggregationModel, GridAggregationCellMeta, GridAggregationHeaderMeta, GridCellSelectionModel, Conversation } from "../hooks/index.js";
 import { GridRowGroupingInternalCache } from "../hooks/features/rowGrouping/gridRowGroupingInterfaces.js";
 import { GridAggregationInternalCache } from "../hooks/features/aggregation/gridAggregationInterfaces.js";
@@ -107,6 +107,12 @@ export interface GridColDefPremium<R extends GridValidRowModel = any, V = any, F
    * @returns {GridKeyValue | null | undefined} The cell key.
    */
   groupingValueGetter?: GridGroupingValueGetter<R>;
+  /**
+   * Function that takes a grouping value and updates the row data accordingly.
+   * This is the inverse operation of `groupingValueGetter`.
+   * @returns {R} The updated row.
+   */
+  groupingValueSetter?: GridGroupingValueSetter<R>;
   /**
    * Function that takes the clipboard-pasted value and converts it to a value used internally.
    * @returns {V} The converted value.