@mui/x-data-grid-premium 5.11.0

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

@@ -0,0 +1,201 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import * as React from 'react';
+import { gridColumnLookupSelector, gridRowIdsSelector, gridRowTreeSelector, useFirstRender } from '@mui/x-data-grid-pro';
+import { useGridRegisterPipeProcessor, useGridRegisterStrategyProcessor, sortRowTree, buildRowTree } from '@mui/x-data-grid-pro/internals';
+import { gridRowGroupingModelSelector, gridRowGroupingSanitizedModelSelector } from './gridRowGroupingSelector';
+import { createGroupingColDefForAllGroupingCriteria, createGroupingColDefForOneGroupingCriteria } from './createGroupingColDef';
+import { filterRowTreeFromGroupingColumns, getColDefOverrides, ROW_GROUPING_STRATEGY, isGroupingColumn, setStrategyAvailability } from './gridRowGroupingUtils';
+export const useGridRowGroupingPreProcessors = (apiRef, props) => {
+  const getGroupingColDefs = React.useCallback(columnsState => {
+    if (props.disableRowGrouping) {
+      return [];
+    }
+
+    const groupingColDefProp = props.groupingColDef; // We can't use `gridGroupingRowsSanitizedModelSelector` here because the new columns are not in the state yet
+
+    const rowGroupingModel = gridRowGroupingModelSelector(apiRef).filter(field => !!columnsState.lookup[field]);
+
+    if (rowGroupingModel.length === 0) {
+      return [];
+    }
+
+    switch (props.rowGroupingColumnMode) {
+      case 'single':
+        {
+          return [createGroupingColDefForAllGroupingCriteria({
+            apiRef,
+            rowGroupingModel,
+            colDefOverride: getColDefOverrides(groupingColDefProp, rowGroupingModel),
+            columnsLookup: columnsState.lookup
+          })];
+        }
+
+      case 'multiple':
+        {
+          return rowGroupingModel.map(groupingCriteria => createGroupingColDefForOneGroupingCriteria({
+            groupingCriteria,
+            colDefOverride: getColDefOverrides(groupingColDefProp, [groupingCriteria]),
+            groupedByColDef: columnsState.lookup[groupingCriteria],
+            columnsLookup: columnsState.lookup
+          }));
+        }
+
+      default:
+        {
+          return [];
+        }
+    }
+  }, [apiRef, props.groupingColDef, props.rowGroupingColumnMode, props.disableRowGrouping]);
+  const updateGroupingColumn = React.useCallback(columnsState => {
+    const groupingColDefs = getGroupingColDefs(columnsState);
+    let newColumnFields = [];
+    const newColumnsLookup = {}; // We only keep the non-grouping columns
+
+    columnsState.all.forEach(field => {
+      if (!isGroupingColumn(field)) {
+        newColumnFields.push(field);
+        newColumnsLookup[field] = columnsState.lookup[field];
+      }
+    }); // We add the grouping column
+
+    groupingColDefs.forEach(groupingColDef => {
+      const matchingGroupingColDef = columnsState.lookup[groupingColDef.field];
+
+      if (matchingGroupingColDef) {
+        groupingColDef.width = matchingGroupingColDef.width;
+        groupingColDef.flex = matchingGroupingColDef.flex;
+      }
+
+      newColumnsLookup[groupingColDef.field] = groupingColDef;
+    });
+    const startIndex = newColumnFields[0] === '__check__' ? 1 : 0;
+    newColumnFields = [...newColumnFields.slice(0, startIndex), ...groupingColDefs.map(colDef => colDef.field), ...newColumnFields.slice(startIndex)];
+    columnsState.all = newColumnFields;
+    columnsState.lookup = newColumnsLookup;
+    return columnsState;
+  }, [getGroupingColDefs]);
+  const createRowTree = React.useCallback(params => {
+    const rowGroupingModel = gridRowGroupingSanitizedModelSelector(apiRef);
+    const columnsLookup = gridColumnLookupSelector(apiRef);
+    apiRef.current.setState(state => _extends({}, state, {
+      rowGrouping: _extends({}, state.rowGrouping, {
+        unstable_sanitizedModelOnLastRowTreeCreation: rowGroupingModel
+      })
+    }));
+    const distinctValues = Object.fromEntries(rowGroupingModel.map(groupingField => [groupingField, {
+      lookup: {},
+      list: []
+    }]));
+
+    const getCellGroupingCriteria = ({
+      row,
+      id,
+      colDef
+    }) => {
+      let key;
+
+      if (colDef.groupingValueGetter) {
+        const groupingValueGetterParams = {
+          colDef,
+          field: colDef.field,
+          value: row[colDef.field],
+          id,
+          row,
+          rowNode: {
+            isAutoGenerated: false,
+            id
+          }
+        };
+        key = colDef.groupingValueGetter(groupingValueGetterParams);
+      } else {
+        key = row[colDef.field];
+      }
+
+      return {
+        key,
+        field: colDef.field
+      };
+    };
+
+    params.ids.forEach(rowId => {
+      const row = params.idRowsLookup[rowId];
+      rowGroupingModel.forEach(groupingCriteria => {
+        const {
+          key
+        } = getCellGroupingCriteria({
+          row,
+          id: rowId,
+          colDef: columnsLookup[groupingCriteria]
+        });
+        const groupingFieldsDistinctKeys = distinctValues[groupingCriteria];
+
+        if (key != null && !groupingFieldsDistinctKeys.lookup[key.toString()]) {
+          groupingFieldsDistinctKeys.lookup[key.toString()] = true;
+          groupingFieldsDistinctKeys.list.push(key);
+        }
+      });
+    });
+    const rows = params.ids.map(rowId => {
+      const row = params.idRowsLookup[rowId];
+      const parentPath = rowGroupingModel.map(groupingField => getCellGroupingCriteria({
+        row,
+        id: rowId,
+        colDef: columnsLookup[groupingField]
+      })).filter(cell => cell.key != null);
+      const leafGroupingCriteria = {
+        key: rowId.toString(),
+        field: null
+      };
+      return {
+        path: [...parentPath, leafGroupingCriteria],
+        id: rowId
+      };
+    });
+    return buildRowTree(_extends({}, params, {
+      rows,
+      defaultGroupingExpansionDepth: props.defaultGroupingExpansionDepth,
+      isGroupExpandedByDefault: props.isGroupExpandedByDefault,
+      groupingName: ROW_GROUPING_STRATEGY
+    }));
+  }, [apiRef, props.defaultGroupingExpansionDepth, props.isGroupExpandedByDefault]);
+  const filterRows = React.useCallback(params => {
+    const rowTree = gridRowTreeSelector(apiRef);
+    return filterRowTreeFromGroupingColumns({
+      rowTree,
+      isRowMatchingFilters: params.isRowMatchingFilters
+    });
+  }, [apiRef]);
+  const sortRows = React.useCallback(params => {
+    const rowTree = gridRowTreeSelector(apiRef);
+    const rowIds = gridRowIdsSelector(apiRef);
+    return sortRowTree({
+      rowTree,
+      rowIds,
+      sortRowList: params.sortRowList,
+      disableChildrenSorting: false
+    });
+  }, [apiRef]);
+  useGridRegisterPipeProcessor(apiRef, 'hydrateColumns', updateGroupingColumn);
+  useGridRegisterStrategyProcessor(apiRef, ROW_GROUPING_STRATEGY, 'rowTreeCreation', createRowTree);
+  useGridRegisterStrategyProcessor(apiRef, ROW_GROUPING_STRATEGY, 'filtering', filterRows);
+  useGridRegisterStrategyProcessor(apiRef, ROW_GROUPING_STRATEGY, 'sorting', sortRows);
+  /**
+   * 1ST RENDER
+   */
+
+  useFirstRender(() => {
+    setStrategyAvailability(apiRef, props.disableRowGrouping);
+  });
+  /**
+   * EFFECTS
+   */
+
+  const isFirstRender = React.useRef(true);
+  React.useEffect(() => {
+    if (!isFirstRender.current) {
+      setStrategyAvailability(apiRef, props.disableRowGrouping);
+    } else {
+      isFirstRender.current = false;
+    }
+  }, [apiRef, props.disableRowGrouping]);
+};

package/modern/hooks/index.js

@@ -0,0 +1,3 @@
+// Only export the variable and types that should be publicly exposed and re-exported from `@mui/x-data-grid-premium`
+export * from './features';
+export * from './utils';

package/modern/hooks/utils/index.js

@@ -0,0 +1 @@
+export * from './useKeepGroupedColumnsHidden';

package/modern/hooks/utils/useGridApiContext.js

@@ -0,0 +1,2 @@
+import { useGridApiContext as useCommunityGridApiContext } from '@mui/x-data-grid-pro';
+export const useGridApiContext = useCommunityGridApiContext;

package/modern/hooks/utils/useGridApiRef.js

@@ -0,0 +1,2 @@
+import { useGridApiRef as useCommunityGridApiRef } from '@mui/x-data-grid-pro';
+export const useGridApiRef = useCommunityGridApiRef;

package/modern/hooks/utils/useGridRootProps.js

@@ -0,0 +1,2 @@
+import { useGridRootProps as useCommunityGridRootProps } from '@mui/x-data-grid-pro';
+export const useGridRootProps = useCommunityGridRootProps;

package/modern/hooks/utils/useKeepGroupedColumnsHidden.js

@@ -0,0 +1,46 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import * as React from 'react';
+import { gridColumnVisibilityModelSelector, GridEvents } from '@mui/x-data-grid-pro';
+
+const updateColumnVisibilityModel = (columnVisibilityModel, rowGroupingModel, prevRowGroupingModel) => {
+  const newColumnVisibilityModel = _extends({}, columnVisibilityModel);
+
+  rowGroupingModel?.forEach(field => {
+    if (!prevRowGroupingModel?.includes(field)) {
+      newColumnVisibilityModel[field] = false;
+    }
+  });
+  prevRowGroupingModel?.forEach(field => {
+    if (!rowGroupingModel?.includes(field)) {
+      newColumnVisibilityModel[field] = true;
+    }
+  });
+  return newColumnVisibilityModel;
+};
+/**
+ * Automatically hide columns when added to the row grouping model and stop hiding them when they are removed.
+ * Handles both the `props.initialState.rowGrouping.model` and `props.rowGroupingModel`
+ * Does not work when used with the `hide` property of `GridColDef`
+ */
+
+
+export const useKeepGroupedColumnsHidden = props => {
+  const initialProps = React.useRef(props);
+  const rowGroupingModel = React.useRef(props.rowGroupingModel ?? props.initialState?.rowGrouping?.model);
+  React.useEffect(() => {
+    props.apiRef.current.subscribeEvent(GridEvents.rowGroupingModelChange, newModel => {
+      const columnVisibilityModel = updateColumnVisibilityModel(gridColumnVisibilityModelSelector(props.apiRef), newModel, rowGroupingModel.current);
+      props.apiRef.current.setColumnVisibilityModel(columnVisibilityModel);
+      rowGroupingModel.current = newModel;
+    });
+  }, [props.apiRef]);
+  return React.useMemo(() => {
+    const invariantInitialState = initialProps.current.initialState;
+    const columnVisibilityModel = updateColumnVisibilityModel(invariantInitialState?.columns?.columnVisibilityModel, rowGroupingModel.current, undefined);
+    return _extends({}, invariantInitialState, {
+      columns: _extends({}, invariantInitialState?.columns, {
+        columnVisibilityModel
+      })
+    });
+  }, []);
+};

package/modern/index.js

@@ -0,0 +1,25 @@
+/** @license MUI v5.11.0
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import './typeOverloads';
+import '@mui/x-data-grid-pro/typeOverloads';
+export { LicenseInfo } from '@mui/x-license-pro';
+export * from '@mui/x-data-grid/components';
+export * from '@mui/x-data-grid-pro/components';
+export * from '@mui/x-data-grid/constants';
+export * from '@mui/x-data-grid/hooks';
+export * from '@mui/x-data-grid-pro/hooks';
+export * from '@mui/x-data-grid/locales';
+export * from '@mui/x-data-grid/models';
+export * from '@mui/x-data-grid-pro/models';
+export * from '@mui/x-data-grid/context';
+export * from '@mui/x-data-grid/colDef';
+export * from '@mui/x-data-grid/utils';
+export * from '@mui/x-data-grid-pro/utils';
+export * from './DataGridPremium';
+export * from './hooks';
+export * from './models';
+export * from './components';
+export { useGridApiContext, useGridApiRef, useGridRootProps } from './typeOverloads/reexports';

package/modern/models/dataGridPremiumProps.js

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

package/modern/models/gridApiPremium.js

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

package/modern/models/gridGroupingValueGetterParams.js

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

package/modern/models/gridStatePremium.js

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

package/modern/models/index.js

@@ -0,0 +1 @@
+export * from './gridGroupingValueGetterParams';

package/modern/typeOverloads/index.js

@@ -0,0 +1 @@
+import '@mui/x-data-grid-pro/typeOverloads';

package/modern/typeOverloads/modules.js

@@ -0,0 +1,33 @@
+// import { GridKeyValue, GridValidRowModel } from '@mui/x-data-grid-pro';
+// import type { GridControlledStateEventLookupPro } from '@mui/x-data-grid-pro/typeOverloads';
+// import type { GridGroupingValueGetterParams } from '../models';
+// import type { GridRowGroupingModel } from '../hooks';
+//
+// export interface GridControlledStateEventLookupPremium {
+//   /**
+//    * Fired when the row grouping model changes.
+//    */
+//   rowGroupingModelChange: { params: GridRowGroupingModel };
+// }
+//
+// // eslint-disable-next-line @typescript-eslint/no-unused-vars
+// export interface GridColDefPremium<R extends GridValidRowModel = any, V = any, F = V> {
+//   /**
+//    * Function that transforms a complex cell value into a key that be used for grouping the rows.
+//    * @param {GridGroupingValueGetterParams} params Object containing parameters for the getter.
+//    * @returns {GridKeyValue | null | undefined} The cell key.
+//    */
+//   groupingValueGetter?: (
+//     params: GridGroupingValueGetterParams<V, R>,
+//   ) => GridKeyValue | null | undefined;
+// }
+//
+// declare module '@mui/x-data-grid-pro' {
+//   export interface GridColDef<R extends GridValidRowModel = any, V = any, F = V>
+//     extends GridColDefPremium<R, V, F> {}
+//
+//   // TODO: Remove explicit augmentation of pro package
+//   interface GridControlledStateEventLookup
+//     extends GridControlledStateEventLookupPro,
+//       GridControlledStateEventLookupPremium {}
+// }

package/modern/typeOverloads/reexports.js

@@ -0,0 +1,6 @@
+export { useGridApiContext } from '../hooks/utils/useGridApiContext';
+export { useGridApiRef } from '../hooks/utils/useGridApiRef';
+export { useGridRootProps } from '../hooks/utils/useGridRootProps';
+/**
+ * The full grid API.
+ */

package/modern/utils/releaseInfo.js

@@ -0,0 +1,15 @@
+import { ponyfillGlobal } from '@mui/utils';
+export const getReleaseInfo = () => {
+  const releaseInfo = "MTY1MjM5MjgwMDAwMA==";
+
+  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;
+};