@mui/x-data-grid-pro 5.17.5 → 6.0.0-alpha.1

package/utils/tree/utils.d.ts

@@ -0,0 +1,66 @@
+import { GridChildrenFromPathLookup, GridGroupNode, GridRowId, GridRowTreeConfig, GridTreeNode } from '@mui/x-data-grid';
+import { GridTreeDepths, GridRowTreeUpdatedGroupsManager } from '@mui/x-data-grid/internals';
+import { RowTreeBuilderGroupingCriterion } from './models';
+import { DataGridProProps } from '../../models/dataGridProProps';
+export declare const getGroupRowIdFromPath: (path: RowTreeBuilderGroupingCriterion[]) => string;
+export declare const getNodePathInTree: ({ id, tree, }: {
+    id: GridRowId;
+    tree: GridRowTreeConfig;
+}) => RowTreeBuilderGroupingCriterion[];
+export declare const addGroupDefaultExpansion: ({ node, isGroupExpandedByDefault, defaultGroupingExpansionDepth, }: {
+    node: GridGroupNode;
+    isGroupExpandedByDefault?: DataGridProProps['isGroupExpandedByDefault'];
+    defaultGroupingExpansionDepth: number;
+}) => {
+    childrenExpanded: boolean;
+    isAutoGenerated: true;
+    type: "group";
+    groupingKey: import("@mui/x-data-grid").GridKeyValue | null;
+    groupingField: string | null;
+    children: GridRowId[];
+    footerId?: GridRowId | null | undefined;
+    childrenFromPath: GridChildrenFromPathLookup;
+    parent: GridRowId | null;
+    isPinned?: boolean | undefined;
+    id: GridRowId;
+    depth: number;
+} | {
+    childrenExpanded: boolean;
+    isAutoGenerated: false;
+    type: "group";
+    groupingKey: import("@mui/x-data-grid").GridKeyValue | null;
+    groupingField: string | null;
+    children: GridRowId[];
+    footerId?: GridRowId | null | undefined;
+    childrenFromPath: GridChildrenFromPathLookup;
+    parent: GridRowId | null;
+    isPinned?: boolean | undefined;
+    id: GridRowId;
+    depth: number;
+};
+/**
+ * Insert a node in the tree
+ */
+export declare const insertNodeInTree: ({ node, tree, treeDepths, }: {
+    node: GridTreeNode;
+    tree: GridRowTreeConfig;
+    treeDepths: GridTreeDepths;
+}) => void;
+/**
+ * Removes a node from the tree
+ */
+export declare const removeNodeFromTree: ({ node, tree, treeDepths, }: {
+    node: GridTreeNode;
+    tree: GridRowTreeConfig;
+    treeDepths: GridTreeDepths;
+}) => void;
+/**
+ * Updates the `id` and `isAutoGenerated` properties of a group node.
+ */
+export declare const updateGroupNodeIdAndAutoGenerated: ({ node, updatedNode, tree, treeDepths, }: {
+    node: GridGroupNode;
+    updatedNode: Pick<GridGroupNode, 'id' | 'isAutoGenerated'>;
+    tree: GridRowTreeConfig;
+    treeDepths: GridTreeDepths;
+}) => void;
+export declare const createUpdatedGroupsManager: () => GridRowTreeUpdatedGroupsManager;

package/utils/tree/utils.js

@@ -0,0 +1,186 @@
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+import _toPropertyKey from "@babel/runtime/helpers/esm/toPropertyKey";
+import _extends from "@babel/runtime/helpers/esm/extends";
+import { GRID_ROOT_GROUP_ID } from '@mui/x-data-grid';
+export const getGroupRowIdFromPath = path => {
+  const pathStr = path.map(groupingCriteria => `${groupingCriteria.field}/${groupingCriteria.key}`).join('-');
+  return `auto-generated-row-${pathStr}`;
+};
+export const getNodePathInTree = ({
+  id,
+  tree
+}) => {
+  const path = [];
+  let node = tree[id];
+
+  while (node.id !== GRID_ROOT_GROUP_ID) {
+    path.push({
+      field: node.groupingField,
+      key: node.groupingKey
+    });
+    node = tree[node.parent];
+  }
+
+  return path;
+};
+export const addGroupDefaultExpansion = ({
+  node,
+  isGroupExpandedByDefault,
+  defaultGroupingExpansionDepth
+}) => {
+  let childrenExpanded;
+
+  if (node.id === GRID_ROOT_GROUP_ID) {
+    childrenExpanded = true;
+  } else if (isGroupExpandedByDefault) {
+    childrenExpanded = isGroupExpandedByDefault(node);
+  } else {
+    childrenExpanded = defaultGroupingExpansionDepth === -1 || defaultGroupingExpansionDepth > node.depth;
+  }
+
+  return _extends({}, node, {
+    childrenExpanded
+  });
+};
+/**
+ * Insert a node in the tree
+ */
+
+export const insertNodeInTree = ({
+  node,
+  tree,
+  treeDepths
+}) => {
+  var _treeDepths$node$dept;
+
+  // 1. Insert node in the tree.
+  tree[node.id] = node; // 2. Increment the `treeDepths` object for the node's depth.
+
+  treeDepths[node.depth] = ((_treeDepths$node$dept = treeDepths[node.depth]) != null ? _treeDepths$node$dept : 0) + 1; // 3. Register the new node in its parent.
+
+  const parentNode = tree[node.parent];
+
+  if (node.type === 'footer') {
+    // For footers,
+    // Register the node from its parent `footerId` property.
+    tree[node.parent] = _extends({}, parentNode, {
+      footerId: node.id
+    });
+  } else if (node.type === 'group' || node.type === 'leaf') {
+    var _groupingField, _groupingKey, _parentNode$childrenF;
+
+    // For groups and leaves,
+    // Register the node from its parents `children` and `childrenFromPath` properties.
+    const groupingField = (_groupingField = node.groupingField) != null ? _groupingField : '__no_field__';
+    const groupingKey = (_groupingKey = node.groupingKey) != null ? _groupingKey : '__no_key__';
+    tree[node.parent] = _extends({}, parentNode, {
+      childrenFromPath: _extends({}, parentNode.childrenFromPath, {
+        [groupingField]: _extends({}, (_parentNode$childrenF = parentNode.childrenFromPath) == null ? void 0 : _parentNode$childrenF[groupingField], {
+          [groupingKey.toString()]: node.id
+        })
+      }),
+      children: [...parentNode.children, node.id]
+    });
+  }
+};
+/**
+ * Removes a node from the tree
+ */
+
+export const removeNodeFromTree = ({
+  node,
+  tree,
+  treeDepths
+}) => {
+  // 1. Remove node from the tree.
+  delete tree[node.id]; // 2. Decrement the `treeDepths` object for the node's depth.
+
+  const nodeDepth = node.depth;
+  const currentNodeCount = treeDepths[nodeDepth];
+
+  if (currentNodeCount === 1) {
+    delete treeDepths[nodeDepth];
+  } else {
+    treeDepths[nodeDepth] = currentNodeCount - 1;
+  } // 3. Unregister the new node in its parent.
+
+
+  const parentNode = tree[node.parent]; // For footers,
+  // Unregister the node from its parent `footerId` property.
+
+  if (node.type === 'footer') {
+    tree[parentNode.id] = _extends({}, parentNode, {
+      footerId: null
+    });
+  } // For groups and leaves,
+  // Unregister the node from its parents `children` and `childrenFromPath` properties.
+  else {
+    var _groupingField2, _groupingKey2, _parentNode$childrenF2, _parentNode$childrenF3;
+
+    const groupingField = (_groupingField2 = node.groupingField) != null ? _groupingField2 : '__no_field__';
+    const groupingKey = (_groupingKey2 = node.groupingKey) != null ? _groupingKey2 : '__no_key__';
+
+    const _ref = (_parentNode$childrenF2 = (_parentNode$childrenF3 = parentNode.childrenFromPath) == null ? void 0 : _parentNode$childrenF3[groupingField]) != null ? _parentNode$childrenF2 : {},
+          _groupingKey$toString = groupingKey.toString(),
+          newChildrenFromPathWithField = _objectWithoutPropertiesLoose(_ref, [_groupingKey$toString].map(_toPropertyKey)); // TODO rows v6: Can we avoid this linear complexity ?
+
+
+    const children = parentNode.children.filter(childId => childId !== node.id);
+
+    const childrenFromPath = _extends({}, parentNode.childrenFromPath);
+
+    if (Object.keys(newChildrenFromPathWithField).length === 0) {
+      delete childrenFromPath[groupingField];
+    } else {
+      childrenFromPath[groupingField] = newChildrenFromPathWithField;
+    }
+
+    tree[parentNode.id] = _extends({}, parentNode, {
+      children,
+      childrenFromPath
+    });
+  }
+};
+/**
+ * Updates the `id` and `isAutoGenerated` properties of a group node.
+ */
+
+export const updateGroupNodeIdAndAutoGenerated = ({
+  node,
+  updatedNode,
+  tree,
+  treeDepths
+}) => {
+  // 1. Set the new parent for all children from the old group
+  node.children.forEach(childId => {
+    tree[childId] = _extends({}, tree[childId], {
+      parent: updatedNode.id
+    });
+  }); // 2. Remove the old group from the tree
+
+  removeNodeFromTree({
+    node,
+    tree,
+    treeDepths
+  }); // 3. Add the new group in the tree
+
+  const groupNode = _extends({}, node, updatedNode);
+
+  insertNodeInTree({
+    node: groupNode,
+    tree,
+    treeDepths
+  });
+};
+export const createUpdatedGroupsManager = () => ({
+  value: {},
+
+  addAction(groupId, action) {
+    if (!this.value[groupId]) {
+      this.value[groupId] = {};
+    }
+
+    this.value[groupId][action] = true;
+  }
+
+});

package/legacy/utils/tree/buildRowTree.js

@@ -1,195 +0,0 @@
-import _extends from "@babel/runtime/helpers/esm/extends";
-import _toConsumableArray from "@babel/runtime/helpers/esm/toConsumableArray";
-export var getGroupRowIdFromPath = function getGroupRowIdFromPath(path) {
-  var pathStr = path.map(function (groupingCriteria) {
-    return "".concat(groupingCriteria.field, "/").concat(groupingCriteria.key);
-  }).join('-');
-  return "auto-generated-row-".concat(pathStr);
-};
-/**
- * Transform a list of rows into a tree structure where each row references its parent and children.
- * If a row have a parent which does not exist in the input rows, creates an auto generated row
- *
- ```
- params = {
-   ids: [0, 1, 2],
-   idRowsLookup: { 0: {...}, 1: {...}, 2: {...} },
-   rows: [
-     { id: 0, path: ['A'] },
-     { id: 1, path: ['B', 'A'] },
-     { id: 2, path: ['B', 'A', 'A'] }
-   ],
-   defaultGroupingExpansionDepth: 0,
- }
- Returns:
- {
-   ids: [0, 1, 2, 'auto-generated-row-B'],
-   idRowsLookup: { 0: {...}, 1: {...}, 2: {...}, 'auto-generated-row-B': {} },
-   tree: {
-     '0': { id: 0, parent: null, childrenExpanded: false, depth: 0, groupingKey: 'A' },
-     'auto-generated-row-B': { id: 'auto-generated-row-B', parent: null, childrenExpanded: false, depth: 0, groupingKey: 'B' },
-     '1': { id: 1, parent: 'auto-generated-row-B', childrenExpanded: false, depth: 1, groupingKey: 'A' },
-     '2': { id: 2, parent: 1, childrenExpanded: false, depth: 2, groupingKey: 'A' },
-   },
-   treeDepth: 3,
- }
- ```
- */
-
-export var buildRowTree = function buildRowTree(params) {
-  // During the build, we store the children as a Record to avoid linear complexity when checking if a children is already defined.
-  var tempTree = {};
-  var treeDepth = 1;
-
-  var ids = _toConsumableArray(params.ids);
-
-  var idRowsLookup = _extends({}, params.idRowsLookup);
-
-  var idToIdLookup = _extends({}, params.idToIdLookup);
-
-  var groupingCriteriaToIdTree = {};
-
-  var isGroupExpandedByDefault = function isGroupExpandedByDefault(node) {
-    var _params$previousTree, _params$previousTree$;
-
-    var previousExpansion = (_params$previousTree = params.previousTree) == null ? void 0 : (_params$previousTree$ = _params$previousTree[node.id]) == null ? void 0 : _params$previousTree$.childrenExpanded;
-
-    if (previousExpansion != null) {
-      return previousExpansion;
-    }
-
-    if (!node.children || !node.children.length) {
-      return undefined;
-    }
-
-    if (params.isGroupExpandedByDefault) {
-      return params.isGroupExpandedByDefault(node);
-    }
-
-    return params.defaultGroupingExpansionDepth === -1 || params.defaultGroupingExpansionDepth > node.depth;
-  };
-
-  for (var i = 0; i < params.rows.length; i += 1) {
-    var row = params.rows[i];
-    var keyToIdSubTree = groupingCriteriaToIdTree;
-    var parentNode = null;
-
-    for (var depth = 0; depth < row.path.length; depth += 1) {
-      var _row$path$depth = row.path[depth],
-          _key = _row$path$depth.key,
-          rawField = _row$path$depth.field;
-
-      var _field = rawField != null ? rawField : '__no_field__';
-
-      var nodeId = void 0;
-      var fieldSubTree = keyToIdSubTree[_field];
-
-      if (!fieldSubTree) {
-        fieldSubTree = {};
-        keyToIdSubTree[_field] = fieldSubTree;
-      }
-
-      var keyConfig = fieldSubTree[_key.toString()];
-
-      if (keyConfig) {
-        if (depth === row.path.length - 1) {
-          var _params$onDuplicatePa;
-
-          (_params$onDuplicatePa = params.onDuplicatePath) == null ? void 0 : _params$onDuplicatePa.call(params, keyConfig.id, row.id, row.path);
-        }
-
-        nodeId = keyConfig.id;
-      } else {
-        if (depth === row.path.length - 1) {
-          nodeId = row.id;
-        } else {
-          nodeId = getGroupRowIdFromPath(row.path.slice(0, depth + 1));
-        }
-
-        keyConfig = {
-          id: nodeId,
-          children: {}
-        };
-        fieldSubTree[_key.toString()] = keyConfig;
-      }
-
-      keyToIdSubTree = keyConfig.children;
-
-      if (!tempTree[nodeId]) {
-        var _parentNode$id, _parentNode;
-
-        var isAutoGenerated = depth < row.path.length - 1;
-        var _node = {
-          id: nodeId,
-          isAutoGenerated: isAutoGenerated,
-          parent: (_parentNode$id = (_parentNode = parentNode) == null ? void 0 : _parentNode.id) != null ? _parentNode$id : null,
-          groupingKey: _key,
-          groupingField: rawField,
-          depth: depth
-        };
-
-        if (isAutoGenerated) {
-          idRowsLookup[nodeId] = {};
-          ids.push(nodeId);
-        }
-
-        tempTree[nodeId] = _node;
-      }
-
-      if (parentNode != null) {
-        if (!parentNode.children) {
-          parentNode.children = {};
-        }
-
-        parentNode.children[nodeId] = nodeId;
-      }
-
-      parentNode = tempTree[nodeId];
-    }
-
-    treeDepth = Math.max(treeDepth, row.path.length);
-  }
-
-  var tree = {};
-
-  var _loop = function _loop(_i) {
-    var _params$previousTree2, _previousNode$childre, _node$children, _previousNode$childre2;
-
-    var rowId = ids[_i];
-    var tempNode = tempTree[rowId];
-
-    var nodeWithoutChildrenExpansion = _extends({}, tempNode, {
-      children: tempNode.children ? Object.values(tempNode.children) : undefined
-    });
-
-    var node = _extends({}, nodeWithoutChildrenExpansion, {
-      childrenExpanded: isGroupExpandedByDefault(nodeWithoutChildrenExpansion)
-    });
-
-    var previousNode = (_params$previousTree2 = params.previousTree) == null ? void 0 : _params$previousTree2[node.id];
-    var shouldReUsePreviousNode = previousNode && previousNode.isAutoGenerated === node.isAutoGenerated && previousNode.parent === node.parent && previousNode.groupingKey === node.groupingKey && previousNode.groupingField === node.groupingField && previousNode.depth === node.depth && previousNode.childrenExpanded === node.childrenExpanded && ((_previousNode$childre = previousNode.children) == null ? void 0 : _previousNode$childre.length) === ((_node$children = node.children) == null ? void 0 : _node$children.length) && ((_previousNode$childre2 = previousNode.children) == null ? void 0 : _previousNode$childre2.every(function (childId, index) {
-      var _node$children2;
-
-      return ((_node$children2 = node.children) == null ? void 0 : _node$children2[index]) === childId;
-    }));
-
-    if (shouldReUsePreviousNode) {
-      tree[rowId] = previousNode;
-    } else {
-      tree[rowId] = node;
-    }
-  };
-
-  for (var _i = 0; _i < ids.length; _i += 1) {
-    _loop(_i);
-  }
-
-  return {
-    tree: tree,
-    treeDepth: treeDepth,
-    ids: ids,
-    idRowsLookup: idRowsLookup,
-    idToIdLookup: idToIdLookup,
-    groupingName: params.groupingName
-  };
-};

package/modern/utils/tree/buildRowTree.js

@@ -1,174 +0,0 @@
-import _extends from "@babel/runtime/helpers/esm/extends";
-export const getGroupRowIdFromPath = path => {
-  const pathStr = path.map(groupingCriteria => `${groupingCriteria.field}/${groupingCriteria.key}`).join('-');
-  return `auto-generated-row-${pathStr}`;
-};
-/**
- * Transform a list of rows into a tree structure where each row references its parent and children.
- * If a row have a parent which does not exist in the input rows, creates an auto generated row
- *
- ```
- params = {
-   ids: [0, 1, 2],
-   idRowsLookup: { 0: {...}, 1: {...}, 2: {...} },
-   rows: [
-     { id: 0, path: ['A'] },
-     { id: 1, path: ['B', 'A'] },
-     { id: 2, path: ['B', 'A', 'A'] }
-   ],
-   defaultGroupingExpansionDepth: 0,
- }
- Returns:
- {
-   ids: [0, 1, 2, 'auto-generated-row-B'],
-   idRowsLookup: { 0: {...}, 1: {...}, 2: {...}, 'auto-generated-row-B': {} },
-   tree: {
-     '0': { id: 0, parent: null, childrenExpanded: false, depth: 0, groupingKey: 'A' },
-     'auto-generated-row-B': { id: 'auto-generated-row-B', parent: null, childrenExpanded: false, depth: 0, groupingKey: 'B' },
-     '1': { id: 1, parent: 'auto-generated-row-B', childrenExpanded: false, depth: 1, groupingKey: 'A' },
-     '2': { id: 2, parent: 1, childrenExpanded: false, depth: 2, groupingKey: 'A' },
-   },
-   treeDepth: 3,
- }
- ```
- */
-
-export const buildRowTree = params => {
-  // During the build, we store the children as a Record to avoid linear complexity when checking if a children is already defined.
-  const tempTree = {};
-  let treeDepth = 1;
-  const ids = [...params.ids];
-
-  const idRowsLookup = _extends({}, params.idRowsLookup);
-
-  const idToIdLookup = _extends({}, params.idToIdLookup);
-
-  const groupingCriteriaToIdTree = {};
-
-  const isGroupExpandedByDefault = node => {
-    const previousExpansion = params.previousTree?.[node.id]?.childrenExpanded;
-
-    if (previousExpansion != null) {
-      return previousExpansion;
-    }
-
-    if (!node.children || !node.children.length) {
-      return undefined;
-    }
-
-    if (params.isGroupExpandedByDefault) {
-      return params.isGroupExpandedByDefault(node);
-    }
-
-    return params.defaultGroupingExpansionDepth === -1 || params.defaultGroupingExpansionDepth > node.depth;
-  };
-
-  for (let i = 0; i < params.rows.length; i += 1) {
-    const row = params.rows[i];
-    let keyToIdSubTree = groupingCriteriaToIdTree;
-    let parentNode = null;
-
-    for (let depth = 0; depth < row.path.length; depth += 1) {
-      const {
-        key,
-        field: rawField
-      } = row.path[depth];
-      const field = rawField ?? '__no_field__';
-      let nodeId;
-      let fieldSubTree = keyToIdSubTree[field];
-
-      if (!fieldSubTree) {
-        fieldSubTree = {};
-        keyToIdSubTree[field] = fieldSubTree;
-      }
-
-      let keyConfig = fieldSubTree[key.toString()];
-
-      if (keyConfig) {
-        if (depth === row.path.length - 1) {
-          params.onDuplicatePath?.(keyConfig.id, row.id, row.path);
-        }
-
-        nodeId = keyConfig.id;
-      } else {
-        if (depth === row.path.length - 1) {
-          nodeId = row.id;
-        } else {
-          nodeId = getGroupRowIdFromPath(row.path.slice(0, depth + 1));
-        }
-
-        keyConfig = {
-          id: nodeId,
-          children: {}
-        };
-        fieldSubTree[key.toString()] = keyConfig;
-      }
-
-      keyToIdSubTree = keyConfig.children;
-
-      if (!tempTree[nodeId]) {
-        const isAutoGenerated = depth < row.path.length - 1;
-        const node = {
-          id: nodeId,
-          isAutoGenerated,
-          parent: parentNode?.id ?? null,
-          groupingKey: key,
-          groupingField: rawField,
-          depth
-        };
-
-        if (isAutoGenerated) {
-          idRowsLookup[nodeId] = {};
-          ids.push(nodeId);
-        }
-
-        tempTree[nodeId] = node;
-      }
-
-      if (parentNode != null) {
-        if (!parentNode.children) {
-          parentNode.children = {};
-        }
-
-        parentNode.children[nodeId] = nodeId;
-      }
-
-      parentNode = tempTree[nodeId];
-    }
-
-    treeDepth = Math.max(treeDepth, row.path.length);
-  }
-
-  const tree = {};
-
-  for (let i = 0; i < ids.length; i += 1) {
-    const rowId = ids[i];
-    const tempNode = tempTree[rowId];
-
-    const nodeWithoutChildrenExpansion = _extends({}, tempNode, {
-      children: tempNode.children ? Object.values(tempNode.children) : undefined
-    });
-
-    const node = _extends({}, nodeWithoutChildrenExpansion, {
-      childrenExpanded: isGroupExpandedByDefault(nodeWithoutChildrenExpansion)
-    });
-
-    const previousNode = params.previousTree?.[node.id];
-    const shouldReUsePreviousNode = previousNode && previousNode.isAutoGenerated === node.isAutoGenerated && previousNode.parent === node.parent && previousNode.groupingKey === node.groupingKey && previousNode.groupingField === node.groupingField && previousNode.depth === node.depth && previousNode.childrenExpanded === node.childrenExpanded && previousNode.children?.length === node.children?.length && previousNode.children?.every((childId, index) => node.children?.[index] === childId);
-
-    if (shouldReUsePreviousNode) {
-      tree[rowId] = previousNode;
-    } else {
-      tree[rowId] = node;
-    }
-  }
-
-  return {
-    tree,
-    treeDepth,
-    ids,
-    idRowsLookup,
-    idToIdLookup,
-    groupingName: params.groupingName
-  };
-};