@mui/x-data-grid-pro 8.0.0-beta.3 → 8.1.0

package/modern/typeOverloads/modules.d.ts

@@ -1,70 +0,0 @@
-import { GridRowId, GridPinnedColumnFields } from '@mui/x-data-grid';
-import type { GridRowScrollEndParams, GridRowOrderChangeParams, GridFetchRowsParams } from '../models';
-import type { GridRenderHeaderFilterProps } from '../components/headerFiltering/GridHeaderFilterCell';
-import type { GridColumnPinningInternalCache } from '../hooks/features/columnPinning/gridColumnPinningInterface';
-import type { GridCanBeReorderedPreProcessingContext } from '../hooks/features/columnReorder/columnReorderInterfaces';
-import { GridRowPinningInternalCache } from "../hooks/features/rowPinning/gridRowPinningInterface.js";
-export interface GridColDefPro {
-  /**
-   * Allows to render a component in the column header filter cell.
-   * @param {GridRenderHeaderFilterProps} params Object containing parameters for the renderer and `inputRef`.
-   * @returns {React.ReactNode} The element to be rendered.
-   */
-  renderHeaderFilter?: (params: GridRenderHeaderFilterProps) => React.ReactNode;
-}
-export interface GridControlledStateEventLookupPro {
-  /**
-   * Fired when the open detail panels are changed.
-   * @ignore - do not document.
-   */
-  detailPanelsExpandedRowIdsChange: {
-    params: Set<GridRowId>;
-  };
-  /**
-   * Fired when the pinned columns is changed.
-   * @ignore - do not document.
-   */
-  pinnedColumnsChange: {
-    params: GridPinnedColumnFields;
-  };
-}
-export interface GridEventLookupPro {
-  /**
-   * Fired when scrolling to the bottom of the grid viewport.
-   */
-  rowsScrollEnd: {
-    params: GridRowScrollEndParams;
-  };
-  /**
-   * Fired when the user ends reordering a row.
-   */
-  rowOrderChange: {
-    params: GridRowOrderChangeParams;
-  };
-  /**
-   * Fired when a new batch of rows is requested to be loaded. Called with a [[GridFetchRowsParams]] object.
-   * Used to trigger `onFetchRows`.
-   */
-  fetchRows: {
-    params: GridFetchRowsParams;
-  };
-}
-export interface GridPipeProcessingLookupPro {
-  canBeReordered: {
-    value: boolean;
-    context: GridCanBeReorderedPreProcessingContext;
-  };
-}
-export interface GridApiCachesPro {
-  columnPinning: GridColumnPinningInternalCache;
-  pinnedRows: GridRowPinningInternalCache;
-}
-declare module '@mui/x-data-grid' {
-  interface GridEventLookup extends GridEventLookupPro {}
-  interface GridControlledStateEventLookup extends GridControlledStateEventLookupPro {}
-  interface GridPipeProcessingLookup extends GridPipeProcessingLookupPro {}
-}
-declare module '@mui/x-data-grid/internals' {
-  interface GridApiCaches extends GridApiCachesPro {}
-  interface GridBaseColDef extends GridColDefPro {}
-}

package/modern/typeOverloads/modules.js

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

package/modern/typeOverloads/reexports.d.ts

@@ -1,17 +0,0 @@
-import type { GridApiPro } from '../models/gridApiPro';
-import type { GridInitialStatePro, GridStatePro } from '../models/gridStatePro';
-export { useGridApiContext } from "../hooks/utils/useGridApiContext.js";
-export { useGridApiRef } from "../hooks/utils/useGridApiRef.js";
-export { useGridRootProps } from "../hooks/utils/useGridRootProps.js";
-/**
- * The full grid API.
- */
-export type GridApi = GridApiPro;
-/**
- * The state of Data Grid Pro.
- */
-export type GridState = GridStatePro;
-/**
- * The initial state of Data Grid Pro.
- */
-export type GridInitialState = GridInitialStatePro;

package/modern/typeOverloads/reexports.js

@@ -1,15 +0,0 @@
-export { useGridApiContext } from "../hooks/utils/useGridApiContext.js";
-export { useGridApiRef } from "../hooks/utils/useGridApiRef.js";
-export { useGridRootProps } from "../hooks/utils/useGridRootProps.js";
-
-/**
- * The full grid API.
- */
-
-/**
- * The state of Data Grid Pro.
- */
-
-/**
- * The initial state of Data Grid Pro.
- */

package/modern/utils/index.d.ts

@@ -1 +0,0 @@
-export * from "./tree/index.js";

package/modern/utils/index.js

@@ -1 +0,0 @@
-export * from "./tree/index.js";

package/modern/utils/releaseInfo.d.ts

@@ -1 +0,0 @@
-export declare const getReleaseInfo: () => any;

package/modern/utils/releaseInfo.js

@@ -1,13 +0,0 @@
-import { ponyfillGlobal } from '@mui/utils';
-export const getReleaseInfo = () => {
-  const releaseInfo = "MTc0MzYzMTIwMDAwMA==";
-  if (process.env.NODE_ENV !== 'production') {
-    // A simple hack to set the value in the test environment (has no build step).
-    // eslint-disable-next-line no-useless-concat
-    if (releaseInfo === '__RELEASE' + '_INFO__') {
-      // eslint-disable-next-line no-underscore-dangle
-      return ponyfillGlobal.__MUI_RELEASE_INFO__;
-    }
-  }
-  return releaseInfo;
-};

package/modern/utils/tree/createRowTree.d.ts

@@ -1,17 +0,0 @@
-import { GridRowTreeConfig } from '@mui/x-data-grid';
-import { GridRowTreeCreationValue } from '@mui/x-data-grid/internals';
-import { RowTreeBuilderNode, GridTreePathDuplicateHandler } from "./models.js";
-import { DataGridProProps } from "../../models/dataGridProProps.js";
-interface CreateRowTreeParams {
-  previousTree: GridRowTreeConfig | null;
-  nodes: RowTreeBuilderNode[];
-  defaultGroupingExpansionDepth: number;
-  isGroupExpandedByDefault?: DataGridProProps['isGroupExpandedByDefault'];
-  groupingName: string;
-  onDuplicatePath?: GridTreePathDuplicateHandler;
-}
-/**
- * Transform a list of rows into a tree structure where each row references its parent and children.
- */
-export declare const createRowTree: (params: CreateRowTreeParams) => GridRowTreeCreationValue;
-export {};

package/modern/utils/tree/createRowTree.js

@@ -1,37 +0,0 @@
-import { GRID_ROOT_GROUP_ID } from '@mui/x-data-grid';
-import { buildRootGroup } from '@mui/x-data-grid/internals';
-import { insertDataRowInTree } from "./insertDataRowInTree.js";
-/**
- * Transform a list of rows into a tree structure where each row references its parent and children.
- */
-export const createRowTree = params => {
-  const dataRowIds = [];
-  const tree = {
-    [GRID_ROOT_GROUP_ID]: buildRootGroup()
-  };
-  const treeDepths = {};
-  const groupsToFetch = new Set();
-  for (let i = 0; i < params.nodes.length; i += 1) {
-    const node = params.nodes[i];
-    dataRowIds.push(node.id);
-    insertDataRowInTree({
-      tree,
-      previousTree: params.previousTree,
-      id: node.id,
-      path: node.path,
-      serverChildrenCount: node.serverChildrenCount,
-      onDuplicatePath: params.onDuplicatePath,
-      treeDepths,
-      isGroupExpandedByDefault: params.isGroupExpandedByDefault,
-      defaultGroupingExpansionDepth: params.defaultGroupingExpansionDepth,
-      groupsToFetch
-    });
-  }
-  return {
-    tree,
-    treeDepths,
-    groupingName: params.groupingName,
-    dataRowIds,
-    groupsToFetch: Array.from(groupsToFetch)
-  };
-};

package/modern/utils/tree/index.d.ts

@@ -1 +0,0 @@
-export { getGroupRowIdFromPath } from "./utils.js";

package/modern/utils/tree/index.js

@@ -1 +0,0 @@
-export { getGroupRowIdFromPath } from "./utils.js";

package/modern/utils/tree/insertDataRowInTree.d.ts

@@ -1,69 +0,0 @@
-import { GridRowId, GridRowTreeConfig } from '@mui/x-data-grid';
-import { GridTreeDepths, GridRowTreeUpdatedGroupsManager } from '@mui/x-data-grid/internals';
-import { GridTreePathDuplicateHandler, RowTreeBuilderGroupingCriterion } from "./models.js";
-import { DataGridProProps } from "../../models/dataGridProProps.js";
-interface InsertDataRowInTreeParams {
-  /**
-   * ID of the data row to insert in the tree.
-   */
-  id: GridRowId;
-  /**
-   * Path of the data row to insert in the tree.
-   */
-  path: RowTreeBuilderGroupingCriterion[];
-  /**
-   * Tree in which to insert the data row.
-   * This tree can be mutated but it's children should not.
-   * For instance:
-   *
-   * - `tree[nodeId] = newNode` => valid
-   * - `tree[nodeId].children.push(newNodeId)` => invalid
-   */
-  tree: GridRowTreeConfig;
-  /**
-   * Previous tree instance for comparison.
-   */
-  previousTree: GridRowTreeConfig | null;
-  /**
-   * Amount of nodes at each depth of the tree.
-   * This object can be mutated.
-   * For instance:
-   *
-   * - `treeDepths[nodeDepth] = treeDepth[nodeDepth] + 1` => valid
-   */
-  treeDepths: GridTreeDepths;
-  /**
-   * Object tracking the action performed on each group.
-   * Used to decide which groups to refresh on sorting, filtering, aggregation, ...
-   * If not defined, then the tracking will be skipped.
-   */
-  updatedGroupsManager?: GridRowTreeUpdatedGroupsManager;
-  /**
-   * Callback fired when trying to insert a data row for a path already populated by another data row.
-   */
-  onDuplicatePath?: GridTreePathDuplicateHandler;
-  isGroupExpandedByDefault?: DataGridProProps['isGroupExpandedByDefault'];
-  defaultGroupingExpansionDepth: number;
-  serverChildrenCount?: number;
-  groupsToFetch?: Set<GridRowId>;
-}
-/**
- * Inserts a data row in a tree.
- * For each steps of its path:
- * - if a node exists with the same partial path, it will register this node as the ancestor of the data row.
- * - if not, it will create an auto-generated node and register it as ancestor of the data row.
- */
-export declare const insertDataRowInTree: ({
-  id,
-  path,
-  updatedGroupsManager,
-  previousTree,
-  tree,
-  treeDepths,
-  onDuplicatePath,
-  isGroupExpandedByDefault,
-  defaultGroupingExpansionDepth,
-  serverChildrenCount,
-  groupsToFetch
-}: InsertDataRowInTreeParams) => void;
-export {};

package/modern/utils/tree/insertDataRowInTree.js

@@ -1,141 +0,0 @@
-import { GRID_ROOT_GROUP_ID } from '@mui/x-data-grid';
-import { updateGroupDefaultExpansion, checkGroupChildrenExpansion, getGroupRowIdFromPath, insertNodeInTree, updateGroupNodeIdAndAutoGenerated } from "./utils.js";
-/**
- * Inserts a data row in a tree.
- * For each steps of its path:
- * - if a node exists with the same partial path, it will register this node as the ancestor of the data row.
- * - if not, it will create an auto-generated node and register it as ancestor of the data row.
- */
-export const insertDataRowInTree = ({
-  id,
-  path,
-  updatedGroupsManager,
-  previousTree,
-  tree,
-  treeDepths,
-  onDuplicatePath,
-  isGroupExpandedByDefault,
-  defaultGroupingExpansionDepth,
-  serverChildrenCount,
-  groupsToFetch
-}) => {
-  let parentNodeId = GRID_ROOT_GROUP_ID;
-  for (let depth = 0; depth < path.length; depth += 1) {
-    const {
-      key,
-      field
-    } = path[depth];
-    const fieldWithDefaultValue = field ?? '__no_field__';
-    const keyWithDefaultValue = key ?? '__no_key__';
-    const existingNodeIdWithPartialPath = tree[parentNodeId].childrenFromPath?.[fieldWithDefaultValue]?.[keyWithDefaultValue.toString()];
-
-    // When we reach the last step of the path,
-    // We need to create a node for the row passed to `insertNodeInTree`
-    if (depth === path.length - 1) {
-      // If no node matches the full path,
-      // We create a leaf node for the data row.
-      if (existingNodeIdWithPartialPath == null) {
-        let node;
-        if (serverChildrenCount !== undefined && serverChildrenCount !== 0) {
-          node = {
-            type: 'group',
-            id,
-            parent: parentNodeId,
-            path: path.map(step => step.key),
-            depth,
-            isAutoGenerated: false,
-            groupingKey: key,
-            groupingField: field,
-            children: [],
-            childrenFromPath: {},
-            childrenExpanded: false,
-            serverChildrenCount
-          };
-          const shouldFetchChildren = checkGroupChildrenExpansion(node, defaultGroupingExpansionDepth, isGroupExpandedByDefault);
-          if (shouldFetchChildren) {
-            groupsToFetch?.add(id);
-          }
-        } else {
-          node = {
-            type: 'leaf',
-            id,
-            depth,
-            parent: parentNodeId,
-            groupingKey: key
-          };
-        }
-        updatedGroupsManager?.addAction(parentNodeId, 'insertChildren');
-        insertNodeInTree(node, tree, treeDepths, previousTree);
-      } else {
-        const existingNodeWithPartialPath = tree[existingNodeIdWithPartialPath];
-
-        // If we already have an auto-generated group matching the partial path,
-        // We replace it with the node from of data row passed to `insertNodeInTree`
-        if (existingNodeWithPartialPath.type === 'group' && existingNodeWithPartialPath.isAutoGenerated) {
-          updatedGroupsManager?.addAction(parentNodeId, 'removeChildren');
-          updatedGroupsManager?.addAction(parentNodeId, 'insertChildren');
-          updateGroupNodeIdAndAutoGenerated({
-            tree,
-            previousTree,
-            treeDepths,
-            node: existingNodeWithPartialPath,
-            updatedNode: {
-              id,
-              isAutoGenerated: false
-            }
-          });
-        } else {
-          // If we have another row matching the partial path, then there is a duplicate in the dataset.
-          // We warn the user and skip the current row.
-          onDuplicatePath?.(existingNodeIdWithPartialPath, id, path);
-        }
-      }
-    }
-    // For the intermediary steps of the path,
-    // We need to make sure that there is a node matching the partial path.
-    //
-    // If no node matches the partial path,
-    // We create an auto-generated group node.
-    else if (existingNodeIdWithPartialPath == null) {
-      const nodeId = getGroupRowIdFromPath(path.slice(0, depth + 1));
-      const autoGeneratedGroupNode = {
-        type: 'group',
-        id: nodeId,
-        parent: parentNodeId,
-        depth,
-        isAutoGenerated: true,
-        groupingKey: key,
-        groupingField: field,
-        children: [],
-        childrenFromPath: {},
-        childrenExpanded: false
-      };
-      updatedGroupsManager?.addAction(parentNodeId, 'insertChildren');
-      insertNodeInTree(updateGroupDefaultExpansion(autoGeneratedGroupNode, defaultGroupingExpansionDepth, isGroupExpandedByDefault), tree, treeDepths, previousTree);
-      parentNodeId = nodeId;
-    }
-    // For the intermediary steps of the path
-    // If a node matches the partial path, we use it as parent for the next step
-    else {
-      const currentGroupNode = tree[existingNodeIdWithPartialPath];
-
-      // If the node matching the partial path is not a group, we turn it into a group
-      if (currentGroupNode.type !== 'group') {
-        const groupNode = {
-          type: 'group',
-          id: currentGroupNode.id,
-          parent: currentGroupNode.parent,
-          depth: currentGroupNode.depth,
-          isAutoGenerated: false,
-          groupingKey: key,
-          groupingField: field,
-          children: [],
-          childrenFromPath: {},
-          childrenExpanded: false
-        };
-        tree[existingNodeIdWithPartialPath] = updateGroupDefaultExpansion(groupNode, defaultGroupingExpansionDepth, isGroupExpandedByDefault);
-      }
-      parentNodeId = currentGroupNode.id;
-    }
-  }
-};

package/modern/utils/tree/models.d.ts

@@ -1,14 +0,0 @@
-import { GridKeyValue, GridRowId } from '@mui/x-data-grid';
-export interface RowTreeBuilderGroupingCriterion {
-  field: string | null;
-  key: GridKeyValue | null;
-}
-export interface RowTreeBuilderNode {
-  id: GridRowId;
-  path: RowTreeBuilderGroupingCriterion[];
-  serverChildrenCount?: number;
-}
-/**
- * Callback called when trying to insert a data row in the tree in place of an already existing data row.
- */
-export type GridTreePathDuplicateHandler = (firstId: GridRowId, secondId: GridRowId, path: RowTreeBuilderGroupingCriterion[]) => void;

package/modern/utils/tree/models.js

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

package/modern/utils/tree/removeDataRowFromTree.d.ts

@@ -1,45 +0,0 @@
-import { GridRowId, GridRowTreeConfig } from '@mui/x-data-grid';
-import { GridTreeDepths, GridRowTreeUpdatedGroupsManager } from '@mui/x-data-grid/internals';
-interface RemoveDataRowFromTreeParams {
-  /**
-   * ID of the data row to remove from the tree.
-   */
-  id: GridRowId;
-  /**
-   * Tree from which to remove the data row.
-   * This tree can be mutated but it's children should not.
-   * For instance:
-   *
-   * - `tree[nodeId] = newNode` => valid
-   * - `tree[nodeId].children.push(newNodeId)` => invalid
-   */
-  tree: GridRowTreeConfig;
-  /**
-   * Amount of nodes at each depth of the tree.
-   * This object can be mutated.
-   * For instance:
-   *
-   * - `treeDepths[nodeDepth] = treeDepth[nodeDepth] + 1` => valid
-   */
-  treeDepths: GridTreeDepths;
-  /**
-   * Object tracking the action performed on each group.
-   * Used to decide which groups to refresh on sorting, filtering, aggregation, ...
-   * If not defined, then the tracking will be skipped.
-   */
-  updatedGroupsManager?: GridRowTreeUpdatedGroupsManager;
-}
-/**
- * Removed a data row from the tree.
- * If the node is a non-empty group, replace it with an auto-generated group to be able to keep displaying its children.
- * If not, remove it and recursively clean its parent with the following rules:
- * - An empty auto-generated should be removed from the tree
- * - An empty non-auto-generated should be turned into a leaf
- */
-export declare const removeDataRowFromTree: ({
-  id,
-  tree,
-  treeDepths,
-  updatedGroupsManager
-}: RemoveDataRowFromTreeParams) => void;
-export {};

package/modern/utils/tree/removeDataRowFromTree.js

@@ -1,94 +0,0 @@
-import { GRID_ROOT_GROUP_ID } from '@mui/x-data-grid';
-import { getNodePathInTree, getGroupRowIdFromPath, removeNodeFromTree, updateGroupNodeIdAndAutoGenerated } from "./utils.js";
-const removeNodeAndCleanParent = ({
-  node,
-  tree,
-  treeDepths,
-  updatedGroupsManager
-}) => {
-  removeNodeFromTree({
-    node,
-    tree,
-    treeDepths
-  });
-  if (node.type === 'group' && node.footerId != null) {
-    removeNodeFromTree({
-      node: tree[node.footerId],
-      tree,
-      treeDepths
-    });
-  }
-  const parentNode = tree[node.parent];
-  updatedGroupsManager?.addAction(parentNode.id, 'removeChildren');
-  const shouldDeleteGroup = parentNode.id !== GRID_ROOT_GROUP_ID && parentNode.children.length === 0;
-  if (shouldDeleteGroup) {
-    if (parentNode.isAutoGenerated) {
-      removeNodeAndCleanParent({
-        node: parentNode,
-        tree,
-        treeDepths
-      });
-    } else {
-      tree[parentNode.id] = {
-        type: 'leaf',
-        id: parentNode.id,
-        depth: parentNode.depth,
-        parent: parentNode.parent,
-        groupingKey: parentNode.groupingKey
-      };
-    }
-  }
-};
-const replaceDataGroupWithAutoGeneratedGroup = ({
-  node,
-  tree,
-  treeDepths,
-  updatedGroupsManager
-}) => {
-  updatedGroupsManager?.addAction(node.parent, 'removeChildren');
-  updatedGroupsManager?.addAction(node.parent, 'insertChildren');
-  updateGroupNodeIdAndAutoGenerated({
-    previousTree: null,
-    tree,
-    treeDepths,
-    node,
-    updatedNode: {
-      id: getGroupRowIdFromPath(getNodePathInTree({
-        id: node.id,
-        tree
-      })),
-      isAutoGenerated: true
-    }
-  });
-};
-
-/**
- * Removed a data row from the tree.
- * If the node is a non-empty group, replace it with an auto-generated group to be able to keep displaying its children.
- * If not, remove it and recursively clean its parent with the following rules:
- * - An empty auto-generated should be removed from the tree
- * - An empty non-auto-generated should be turned into a leaf
- */
-export const removeDataRowFromTree = ({
-  id,
-  tree,
-  treeDepths,
-  updatedGroupsManager
-}) => {
-  const node = tree[id];
-  if (node.type === 'group' && node.children.length > 0) {
-    replaceDataGroupWithAutoGeneratedGroup({
-      node,
-      tree,
-      treeDepths,
-      updatedGroupsManager
-    });
-  } else {
-    removeNodeAndCleanParent({
-      node,
-      tree,
-      treeDepths,
-      updatedGroupsManager
-    });
-  }
-};

package/modern/utils/tree/sortRowTree.d.ts

@@ -1,15 +0,0 @@
-import { GridRowId, GridRowTreeConfig } from '@mui/x-data-grid';
-import { GridSortingModelApplier } from '@mui/x-data-grid/internals';
-interface SortRowTreeParams {
-  rowTree: GridRowTreeConfig;
-  disableChildrenSorting: boolean;
-  sortRowList: GridSortingModelApplier | null;
-  /**
-   * Defines where the groups are placed relative to the leaves of same depth when no sorting rule is applied.
-   * If `true` the groups will be rendered below the leaves.
-   * If `false`, the groups will be rendered on their creation order.
-   */
-  shouldRenderGroupBelowLeaves: boolean;
-}
-export declare const sortRowTree: (params: SortRowTreeParams) => GridRowId[];
-export {};