@mui/x-data-grid-premium 8.0.0-alpha.11 → 8.0.0-alpha.13

package/hooks/features/dataSource/models.d.ts

@@ -1,47 +1,54 @@
 import type { GridColDef, GridRowId, GridValidRowModel, GridDataSource, GridGetRowsResponse, GridGetRowsParams, GridDataSourceApiBase, GridDataSourcePrivateApi } from '@mui/x-data-grid-pro';
 import type { GridAggregationModel } from '../aggregation/gridAggregationInterfaces';
 export interface GridGetRowsResponsePremium extends GridGetRowsResponse {
-    /**
-     * Row to be used for aggregation footer row.
-     * It must provide the values for the aggregated columns passed in
-     * `GridGetRowsParams.aggregationModel`.
-     */
-    aggregateRow?: GridValidRowModel;
+  /**
+   * Row to be used for aggregation footer row.
+   * It must provide the values for the aggregated columns passed in
+   * `GridGetRowsParams.aggregationModel`.
+   */
+  aggregateRow?: GridValidRowModel;
 }
 export interface GridGetRowsParamsPremium extends GridGetRowsParams {
-    aggregationModel?: GridAggregationModel;
+  /**
+   * List of aggregated columns.
+   */
+  aggregationModel?: GridAggregationModel;
+  /**
+   * List of grouped columns (only applicable with `rowGrouping`).
+   */
+  groupFields?: GridColDef['field'][];
 }
 export interface GridDataSourcePremium extends Omit<GridDataSource, 'getRows'> {
-    /**
-     * This method will be called when the grid needs to fetch some rows.
-     * @param {GridGetRowsParamsPremium} params The parameters required to fetch the rows.
-     * @returns {Promise<GridGetRowsResponsePremium>} A promise that resolves to the data of type [GridGetRowsResponsePremium].
-     */
-    getRows(params: GridGetRowsParamsPremium): Promise<GridGetRowsResponsePremium>;
-    /**
-     * Used to get the aggregated value for a parent row.
-     * @param {GridValidRowModel} row The row to extract the aggregated value from.
-     * @param {GridColDef['field']} field The field to extract the aggregated value for.
-     * @returns {string} The aggregated value for a specific aggregated column.
-     */
-    getAggregatedValue?: (row: GridValidRowModel, field: GridColDef['field']) => string;
+  /**
+   * This method will be called when the grid needs to fetch some rows.
+   * @param {GridGetRowsParamsPremium} params The parameters required to fetch the rows.
+   * @returns {Promise<GridGetRowsResponsePremium>} A promise that resolves to the data of type [GridGetRowsResponsePremium].
+   */
+  getRows(params: GridGetRowsParamsPremium): Promise<GridGetRowsResponsePremium>;
+  /**
+   * Used to get the aggregated value for a parent row.
+   * @param {GridValidRowModel} row The row to extract the aggregated value from.
+   * @param {GridColDef['field']} field The field to extract the aggregated value for.
+   * @returns {string} The aggregated value for a specific aggregated column.
+   */
+  getAggregatedValue?: (row: GridValidRowModel, field: GridColDef['field']) => string;
 }
 export interface GridDataSourceApiBasePremium extends Omit<GridDataSourceApiBase, 'fetchRows'> {
-    /**
-     * Fetches the rows from the server.
-     * If no `parentId` option is provided, it fetches the root rows.
-     * Any missing parameter from `params` will be filled from the state (sorting, filtering, etc.).
-     * @param {GridRowId} parentId The id of the parent node (default: `GRID_ROOT_GROUP_ID`).
-     * @param {Partial<GridGetRowsParamsPremium>} params Request parameters override.
-     */
-    fetchRows: (parentId?: GridRowId, params?: Partial<GridGetRowsParamsPremium>) => void;
+  /**
+   * Fetches the rows from the server.
+   * If no `parentId` option is provided, it fetches the root rows.
+   * Any missing parameter from `params` will be filled from the state (sorting, filtering, etc.).
+   * @param {GridRowId} parentId The id of the parent node (default: `GRID_ROOT_GROUP_ID`).
+   * @param {Partial<GridGetRowsParamsPremium>} params Request parameters override.
+   */
+  fetchRows: (parentId?: GridRowId, params?: Partial<GridGetRowsParamsPremium>) => void;
 }
 export interface GridDataSourceApiPremium {
-    /**
-     * The data source API.
-     */
-    unstable_dataSource: GridDataSourceApiBasePremium;
+  /**
+   * The data source API.
+   */
+  dataSource: GridDataSourceApiBasePremium;
 }
 export interface GridDataSourcePremiumPrivateApi extends GridDataSourcePrivateApi {
-    resolveGroupAggregation: (groupId: GridRowId, field: string) => any;
-}
+  resolveGroupAggregation: (groupId: GridRowId, field: string) => any;
+}

package/hooks/features/dataSource/useGridDataSourcePremium.d.ts

@@ -1,4 +1,4 @@
 import { RefObject } from '@mui/x-internals/types';
-import { GridPrivateApiPremium } from '../../../models/gridApiPremium';
-import { DataGridPremiumProcessedProps } from '../../../models/dataGridPremiumProps';
-export declare const useGridDataSourcePremium: (apiRef: RefObject<GridPrivateApiPremium>, props: DataGridPremiumProcessedProps) => void;
+import { GridPrivateApiPremium } from "../../../models/gridApiPremium.js";
+import { DataGridPremiumProcessedProps } from "../../../models/dataGridPremiumProps.js";
+export declare const useGridDataSourcePremium: (apiRef: RefObject<GridPrivateApiPremium>, props: DataGridPremiumProcessedProps) => void;

package/hooks/features/dataSource/useGridDataSourcePremium.js

@@ -10,18 +10,21 @@ var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends")
 var React = _interopRequireWildcard(require("react"));
 var _xDataGridPro = require("@mui/x-data-grid-pro");
 var _internals = require("@mui/x-data-grid-pro/internals");
-var _cache = require("./cache");
+function getKeyPremium(params) {
+  return JSON.stringify([params.filterModel, params.sortModel, params.groupKeys, params.groupFields, params.start, params.end, params.aggregationModel]);
+}
 const options = {
   cacheOptions: {
-    getKey: _cache.getKeyPremium
+    getKey: getKeyPremium
   }
 };
 const useGridDataSourcePremium = (apiRef, props) => {
   const {
     api,
     strategyProcessor,
-    events
-  } = (0, _internals.useGridDataSourceBase)(apiRef, props, options);
+    events,
+    setStrategyAvailability
+  } = (0, _internals.useGridDataSourceBasePro)(apiRef, props, options);
   const aggregateRowRef = React.useRef({});
   const processDataSourceRows = React.useCallback(({
     params,
@@ -43,11 +46,11 @@ const useGridDataSourcePremium = (apiRef, props) => {
   }, [apiRef]);
   const resolveGroupAggregation = React.useCallback((groupId, field) => {
     if (groupId === _xDataGridPro.GRID_ROOT_GROUP_ID) {
-      return props.unstable_dataSource?.getAggregatedValue?.(aggregateRowRef.current, field);
+      return props.dataSource?.getAggregatedValue?.(aggregateRowRef.current, field);
     }
     const row = apiRef.current.getRow(groupId);
-    return props.unstable_dataSource?.getAggregatedValue?.(row, field);
-  }, [apiRef, props.unstable_dataSource]);
+    return props.dataSource?.getAggregatedValue?.(row, field);
+  }, [apiRef, props.dataSource]);
   const privateApi = (0, _extends2.default)({}, api.private, {
     resolveGroupAggregation
   });
@@ -58,5 +61,8 @@ const useGridDataSourcePremium = (apiRef, props) => {
   Object.entries(events).forEach(([event, handler]) => {
     (0, _xDataGridPro.useGridApiEventHandler)(apiRef, event, handler);
   });
+  React.useEffect(() => {
+    setStrategyAvailability();
+  }, [setStrategyAvailability]);
 };
 exports.useGridDataSourcePremium = useGridDataSourcePremium;

package/hooks/features/export/gridExcelExportInterface.d.ts

@@ -3,11 +3,11 @@ import { GridFileExportOptions, GridExportFormat as GridExportFormatCommunity, G
 export type GridExportFormat = GridExportFormatCommunity | 'excel';
 export type GridExportExtension = GridExportExtensionCommunity | 'xlsx';
 export interface GridExceljsProcessInput {
-    workbook: Excel.Workbook;
-    worksheet: Excel.Worksheet;
+  workbook: Excel.Workbook;
+  worksheet: Excel.Worksheet;
 }
 export interface ColumnsStylesInterface {
-    [field: string]: Partial<Excel.Style>;
+  [field: string]: Partial<Excel.Style>;
 }
 /**
  * The options to apply on the Excel export.
@@ -15,57 +15,57 @@ export interface ColumnsStylesInterface {
  *   - [Excel export](/x/react-data-grid/export/#excel-export)
  */
 export interface GridExcelExportOptions extends GridFileExportOptions {
-    /**
-     * Function to return the Worker instance to be called.
-     * @returns {() => Worker} A Worker instance.
-     */
-    worker?: () => Worker;
-    /**
-     * Name given to the worksheet containing the columns valueOptions.
-     * valueOptions are added to this worksheet if they are provided as an array.
-     */
-    valueOptionsSheetName?: string;
-    /**
-     * Method called before adding the rows to the workbook.
-     * Not supported when `worker` is set.
-     * To use with web workers, use the option in `setupExcelExportWebWorker`.
-     * @param {GridExceljsProcessInput} processInput object containing the workbook and the worksheet.
-     * @returns {Promise<void>} A promise which resolves after processing the input.
-     * */
-    exceljsPreProcess?: (processInput: GridExceljsProcessInput) => Promise<void>;
-    /**
-     * Method called after adding the rows to the workbook.
-     * Not supported when `worker` is set.
-     * To use with web workers, use the option in `setupExcelExportWebWorker`.
-     * @param {GridExceljsProcessInput} processInput object containing the workbook and the worksheet.
-     * @returns {Promise<void>} A promise which resolves after processing the input.
-     * */
-    exceljsPostProcess?: (processInput: GridExceljsProcessInput) => Promise<void>;
-    /**
-     * Object mapping column field to Exceljs style
-     * */
-    columnsStyles?: ColumnsStylesInterface;
-    /**
-     * If `true`, the headers of the column groups will be added into the file.
-     * @default true
-     */
-    includeColumnGroupsHeaders?: boolean;
+  /**
+   * Function to return the Worker instance to be called.
+   * @returns {() => Worker} A Worker instance.
+   */
+  worker?: () => Worker;
+  /**
+   * Name given to the worksheet containing the columns valueOptions.
+   * valueOptions are added to this worksheet if they are provided as an array.
+   */
+  valueOptionsSheetName?: string;
+  /**
+   * Method called before adding the rows to the workbook.
+   * Not supported when `worker` is set.
+   * To use with web workers, use the option in `setupExcelExportWebWorker`.
+   * @param {GridExceljsProcessInput} processInput object containing the workbook and the worksheet.
+   * @returns {Promise<void>} A promise which resolves after processing the input.
+   * */
+  exceljsPreProcess?: (processInput: GridExceljsProcessInput) => Promise<void>;
+  /**
+   * Method called after adding the rows to the workbook.
+   * Not supported when `worker` is set.
+   * To use with web workers, use the option in `setupExcelExportWebWorker`.
+   * @param {GridExceljsProcessInput} processInput object containing the workbook and the worksheet.
+   * @returns {Promise<void>} A promise which resolves after processing the input.
+   * */
+  exceljsPostProcess?: (processInput: GridExceljsProcessInput) => Promise<void>;
+  /**
+   * Object mapping column field to Exceljs style
+   * */
+  columnsStyles?: ColumnsStylesInterface;
+  /**
+   * If `true`, the headers of the column groups will be added into the file.
+   * @default true
+   */
+  includeColumnGroupsHeaders?: boolean;
 }
 /**
  * The excel export API interface that is available in the grid [[apiRef]].
  */
 export interface GridExcelExportApi {
-    /**
-     * Returns the grid data as an exceljs workbook.
-     * This method is used internally by `exportDataAsExcel`.
-     * @param {GridExcelExportOptions} options The options to apply on the export.
-     * @returns {Promise<Excel.Workbook>} The data in a exceljs workbook object.
-     */
-    getDataAsExcel: (options?: GridExcelExportOptions) => Promise<Excel.Workbook> | null;
-    /**
-     * Downloads and exports an Excel file of the grid's data.
-     * @param {GridExcelExportOptions} options The options to apply on the export.
-     * @returns {Promise<void>} A promise which resolves after exporting to Excel.
-     */
-    exportDataAsExcel: (options?: GridExcelExportOptions) => Promise<void>;
-}
+  /**
+   * Returns the grid data as an exceljs workbook.
+   * This method is used internally by `exportDataAsExcel`.
+   * @param {GridExcelExportOptions} options The options to apply on the export.
+   * @returns {Promise<Excel.Workbook>} The data in a exceljs workbook object.
+   */
+  getDataAsExcel: (options?: GridExcelExportOptions) => Promise<Excel.Workbook> | null;
+  /**
+   * Downloads and exports an Excel file of the grid's data.
+   * @param {GridExcelExportOptions} options The options to apply on the export.
+   * @returns {Promise<void>} A promise which resolves after exporting to Excel.
+   */
+  exportDataAsExcel: (options?: GridExcelExportOptions) => Promise<void>;
+}

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

@@ -1,2 +1,2 @@
-export * from './gridExcelExportInterface';
-export { setupExcelExportWebWorker } from './serializer/excelSerializer';
+export * from "./gridExcelExportInterface.js";
+export { setupExcelExportWebWorker } from "./serializer/setupExcelExportWebWorker.js";

package/hooks/features/export/index.js

@@ -9,7 +9,7 @@ var _exportNames = {
 Object.defineProperty(exports, "setupExcelExportWebWorker", {
   enumerable: true,
   get: function () {
-    return _excelSerializer.setupExcelExportWebWorker;
+    return _setupExcelExportWebWorker.setupExcelExportWebWorker;
   }
 });
 var _gridExcelExportInterface = require("./gridExcelExportInterface");
@@ -24,4 +24,4 @@ Object.keys(_gridExcelExportInterface).forEach(function (key) {
     }
   });
 });
-var _excelSerializer = require("./serializer/excelSerializer");
+var _setupExcelExportWebWorker = require("./serializer/setupExcelExportWebWorker");

package/hooks/features/export/serializer/excelSerializer.d.ts

@@ -1,18 +1,11 @@
 import type * as Excel from 'exceljs';
 import { RefObject } from '@mui/x-internals/types';
 import { GridRowId, GridColDef } from '@mui/x-data-grid-pro';
-import { GridStateColDef, GridColumnGroupLookup } from '@mui/x-data-grid/internals';
-import { ColumnsStylesInterface, GridExcelExportOptions } from '../gridExcelExportInterface';
-import { GridPrivateApiPremium } from '../../../../models/gridApiPremium';
-interface SerializedRow {
-    row: Record<string, undefined | number | boolean | string | Date>;
-    dataValidation: Record<string, Excel.DataValidation>;
-    outlineLevel: number;
-    mergedCells: {
-        leftIndex: number;
-        rightIndex: number;
-    }[];
-}
+import { GridStateColDef } from '@mui/x-data-grid/internals';
+import { ColumnsStylesInterface, GridExcelExportOptions } from "../gridExcelExportInterface.js";
+import { GridPrivateApiPremium } from "../../../../models/gridApiPremium.js";
+import { SerializedColumns, SerializedRow, ValueOptionsData } from "./utils.js";
+export type { ExcelExportInitEvent } from './utils';
 /**
  * FIXME: This function mutates the colspan info, but colspan info assumes that the columns
  * passed to it are always consistent. In this case, the exported columns may differ from the
@@ -20,49 +13,28 @@ interface SerializedRow {
  * The caller of this function MUST call `resetColSpan()` before and after usage.
  */
 export declare const serializeRowUnsafe: (id: GridRowId, columns: GridStateColDef[], apiRef: RefObject<GridPrivateApiPremium>, defaultValueOptionsFormulae: {
-    [field: string]: {
-        address: string;
-    };
+  [field: string]: {
+    address: string;
+  };
 }, options: Pick<BuildExcelOptions, "escapeFormulas">) => SerializedRow;
 export declare const serializeColumn: (column: GridColDef, columnsStyles: ColumnsStylesInterface) => {
-    key: string;
-    headerText: string;
-    width: number;
-    style: {
-        numFmt?: string | undefined;
-        font?: Partial<Excel.Font> | undefined;
-        alignment?: Partial<Excel.Alignment> | undefined;
-        protection?: Partial<Excel.Protection> | undefined;
-        border?: Partial<Excel.Borders> | undefined;
-        fill?: Excel.Fill | undefined;
-    };
+  key: string;
+  headerText: string;
+  width: number;
+  style: {
+    numFmt?: string | undefined;
+    font?: Partial<Excel.Font> | undefined;
+    alignment?: Partial<Excel.Alignment> | undefined;
+    protection?: Partial<Excel.Protection> | undefined;
+    border?: Partial<Excel.Borders> | undefined;
+    fill?: Excel.Fill | undefined;
+  };
 };
-type SerializedColumns = Array<{
-    key: string;
-    width: number;
-    style: Partial<Excel.Style>;
-    headerText: string;
-}>;
 export declare function serializeColumns(columns: GridStateColDef[], styles: ColumnsStylesInterface): SerializedColumns;
-type ValueOptionsData = Record<string, {
-    values: (string | number)[];
-    address: string;
-}>;
 export declare function getDataForValueOptionsSheet(columns: GridStateColDef[], valueOptionsSheetName: string, api: GridPrivateApiPremium): Promise<ValueOptionsData>;
 interface BuildExcelOptions extends Pick<GridExcelExportOptions, 'exceljsPreProcess' | 'exceljsPostProcess'>, Pick<Required<GridExcelExportOptions>, 'valueOptionsSheetName' | 'includeHeaders' | 'includeColumnGroupsHeaders' | 'escapeFormulas'> {
-    columns: GridStateColDef[];
-    rowIds: GridRowId[];
-    columnsStyles?: ColumnsStylesInterface;
-}
-export declare function buildExcel(options: BuildExcelOptions, apiRef: RefObject<GridPrivateApiPremium>): Promise<Excel.Workbook>;
-export interface ExcelExportInitEvent {
-    serializedColumns: SerializedColumns;
-    serializedRows: SerializedRow[];
-    valueOptionsSheetName: string;
-    columnGroupPaths: Record<string, string[]>;
-    columnGroupDetails: GridColumnGroupLookup;
-    valueOptionsData: ValueOptionsData;
-    options: Omit<GridExcelExportOptions, 'exceljsPreProcess' | 'exceljsPostProcess' | 'columnsStyles' | 'valueOptionsSheetName'>;
+  columns: GridStateColDef[];
+  rowIds: GridRowId[];
+  columnsStyles?: ColumnsStylesInterface;
 }
-export declare function setupExcelExportWebWorker(workerOptions?: Pick<GridExcelExportOptions, 'exceljsPostProcess' | 'exceljsPreProcess'>): void;
-export {};
+export declare function buildExcel(options: BuildExcelOptions, apiRef: RefObject<GridPrivateApiPremium>): Promise<Excel.Workbook>;