@mui/x-data-grid-generator 8.0.0-alpha.10 → 8.0.0-alpha.12

package/esm/columns/index.js

@@ -0,0 +1,2 @@
+export * from "./commodities.columns.js";
+export * from "./employees.columns.js";

package/esm/constants/prompts.d.ts

@@ -0,0 +1,2 @@
+import { unstable_PromptResponse as PromptResponse } from '@mui/x-data-grid-premium';
+export declare const mockPrompts: Map<string, PromptResponse>;

package/{node → esm}/constants/prompts.js

@@ -1,10 +1,4 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.mockPrompts = void 0;
-const mockPrompts = exports.mockPrompts = new Map([['sort by name', {
+export const mockPrompts = new Map([['sort by name', {
   select: -1,
   filters: [],
   aggregation: {},

package/esm/hooks/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./useDemoData.js";
+export * from "./useBasicDemoData.js";
+export { useMovieData } from "./useMovieData.js";
+export type { Movie } from './useMovieData';
+export * from "./useQuery.js";
+export * from "./useMockServer.js";
+export { loadServerRows } from "./serverUtils.js";
+export type { QueryOptions } from './serverUtils';

package/esm/hooks/index.js

@@ -0,0 +1,6 @@
+export * from "./useDemoData.js";
+export * from "./useBasicDemoData.js";
+export { useMovieData } from "./useMovieData.js";
+export * from "./useQuery.js";
+export * from "./useMockServer.js";
+export { loadServerRows } from "./serverUtils.js";

package/esm/hooks/serverUtils.d.ts

@@ -0,0 +1,61 @@
+import { GridRowModel, GridFilterModel, GridSortModel, GridColDef, GridRowId, GridPaginationModel, GridValidRowModel, GridAggregationModel } from '@mui/x-data-grid-premium';
+export interface FakeServerResponse {
+  returnedRows: GridRowModel[];
+  aggregateRow?: GridValidRowModel;
+  nextCursor?: string;
+  hasNextPage?: boolean;
+  totalRowCount: number;
+}
+export interface PageInfo {
+  totalRowCount?: number;
+  nextCursor?: string;
+  hasNextPage?: boolean;
+  pageSize?: number;
+}
+export interface DefaultServerOptions {
+  minDelay: number;
+  maxDelay: number;
+  useCursorPagination?: boolean;
+}
+export type ServerOptions = Partial<DefaultServerOptions>;
+export interface QueryOptions {
+  cursor?: GridRowId;
+  page?: number;
+  pageSize?: number;
+  filterModel?: GridFilterModel;
+  aggregationModel?: GridAggregationModel;
+  sortModel?: GridSortModel;
+  start?: number;
+  end?: number;
+}
+export interface ServerSideQueryOptions {
+  cursor?: GridRowId;
+  paginationModel?: GridPaginationModel;
+  groupKeys?: string[];
+  filterModel?: GridFilterModel;
+  sortModel?: GridSortModel;
+  aggregationModel?: GridAggregationModel;
+  start?: number;
+  end?: number;
+  groupFields?: string[];
+}
+export declare const disableDelay: any;
+export declare const DEFAULT_SERVER_OPTIONS: DefaultServerOptions;
+/**
+ * Simulates server data loading
+ */
+export declare const loadServerRows: (rows: GridRowModel[], queryOptions: QueryOptions, serverOptions: ServerOptions, columnsWithDefaultColDef: GridColDef[]) => Promise<FakeServerResponse>;
+interface NestedDataRowsResponse {
+  rows: GridRowModel[];
+  rootRowCount: number;
+  aggregateRow?: GridRowModel;
+}
+/**
+ * Simulates server data for tree-data feature
+ */
+export declare const processTreeDataRows: (rows: GridRowModel[], queryOptions: ServerSideQueryOptions, serverOptions: ServerOptions, columnsWithDefaultColDef: GridColDef[]) => Promise<NestedDataRowsResponse>;
+/**
+ * Simulates server data for row grouping feature
+ */
+export declare const processRowGroupingRows: (rows: GridValidRowModel[], queryOptions: ServerSideQueryOptions, serverOptions: ServerOptions, columnsWithDefaultColDef: GridColDef[]) => Promise<NestedDataRowsResponse>;
+export {};

package/{node → esm}/hooks/serverUtils.js

@@ -1,25 +1,18 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.processTreeDataRows = exports.processRowGroupingRows = exports.loadServerRows = exports.disableDelay = exports.DEFAULT_SERVER_OPTIONS = void 0;
-var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
-var _xDataGridPremium = require("@mui/x-data-grid-premium");
-var _randomGenerator = require("../services/random-generator");
+import _extends from "@babel/runtime/helpers/esm/extends";
+import { GridLogicOperator, GRID_AGGREGATION_FUNCTIONS } from '@mui/x-data-grid-premium';
+import { randomInt } from "../services/random-generator.js";
 const getAvailableAggregationFunctions = columnType => {
   const availableAggregationFunctions = new Map();
-  Object.keys(_xDataGridPremium.GRID_AGGREGATION_FUNCTIONS).forEach(functionName => {
-    const columnTypes = _xDataGridPremium.GRID_AGGREGATION_FUNCTIONS[functionName].columnTypes;
+  Object.keys(GRID_AGGREGATION_FUNCTIONS).forEach(functionName => {
+    const columnTypes = GRID_AGGREGATION_FUNCTIONS[functionName].columnTypes;
     if (!columnTypes || columnTypes.includes(columnType ?? 'string')) {
-      availableAggregationFunctions.set(functionName, _xDataGridPremium.GRID_AGGREGATION_FUNCTIONS[functionName]);
+      availableAggregationFunctions.set(functionName, GRID_AGGREGATION_FUNCTIONS[functionName]);
     }
   });
   return availableAggregationFunctions;
 };
-const disableDelay = exports.disableDelay = typeof DISABLE_CHANCE_RANDOM !== 'undefined' && DISABLE_CHANCE_RANDOM;
-const DEFAULT_SERVER_OPTIONS = exports.DEFAULT_SERVER_OPTIONS = {
+export const disableDelay = typeof DISABLE_CHANCE_RANDOM !== 'undefined' && DISABLE_CHANCE_RANDOM;
+export const DEFAULT_SERVER_OPTIONS = {
   minDelay: disableDelay ? 0 : 100,
   maxDelay: disableDelay ? 0 : 300,
   useCursorPagination: true
@@ -38,7 +31,7 @@ const getRowComparator = (sortModel, columnsWithDefaultColDef) => {
     const colDef = columnsWithDefaultColDef.find(({
       field
     }) => field === columnField);
-    return (0, _extends2.default)({}, sortItem, {
+    return _extends({}, sortItem, {
       valueGetter: simplifiedValueGetter(columnField, colDef),
       sortComparator: colDef.sortComparator
     });
@@ -127,7 +120,7 @@ const getQuicklyFilteredRows = (rows, filterModel, columnsWithDefaultColDef) =>
   if (isRowMatchingQuickFilter) {
     return rows.filter(row => {
       const result = isRowMatchingQuickFilter(row);
-      return filterModel.quickFilterLogicOperator === _xDataGridPremium.GridLogicOperator.And ? Object.values(result).every(Boolean) : Object.values(result).some(Boolean);
+      return filterModel.quickFilterLogicOperator === GridLogicOperator.And ? Object.values(result).every(Boolean) : Object.values(result).some(Boolean);
     });
   }
   return rows;
@@ -161,7 +154,7 @@ const getFilteredRows = (rows, filterModel, columnsWithDefaultColDef) => {
       value: parsedValue
     }, colDef);
   });
-  if (filterModel.logicOperator === _xDataGridPremium.GridLogicOperator.Or) {
+  if (filterModel.logicOperator === GridLogicOperator.Or) {
     return rows.filter(row => filterModel.items.some((_, index) => {
       const value = valueGetters[index](row);
       return filterFunctions[index] === null ? true : filterFunctions[index](value);
@@ -206,7 +199,7 @@ const applyAggregation = (aggregationModel, colDefs, rows, groupId = 'root') =>
 /**
  * Simulates server data loading
  */
-const loadServerRows = (rows, queryOptions, serverOptions, columnsWithDefaultColDef) => {
+export const loadServerRows = (rows, queryOptions, serverOptions, columnsWithDefaultColDef) => {
   const {
     minDelay = 100,
     maxDelay = 300,
@@ -215,7 +208,7 @@ const loadServerRows = (rows, queryOptions, serverOptions, columnsWithDefaultCol
   if (maxDelay < minDelay) {
     throw new Error('serverOptions.minDelay is larger than serverOptions.maxDelay ');
   }
-  const delay = (0, _randomGenerator.randomInt)(minDelay, maxDelay);
+  const delay = randomInt(minDelay, maxDelay);
   const {
     cursor,
     page = 0,
@@ -252,7 +245,7 @@ const loadServerRows = (rows, queryOptions, serverOptions, columnsWithDefaultCol
     lastRowIndex = (page + 1) * pageSize - 1;
   }
   const hasNextPage = lastRowIndex < filteredRows.length - 1;
-  const response = (0, _extends2.default)({
+  const response = _extends({
     returnedRows: filteredRows.slice(firstRowIndex, lastRowIndex + 1),
     hasNextPage,
     nextCursor,
@@ -266,7 +259,6 @@ const loadServerRows = (rows, queryOptions, serverOptions, columnsWithDefaultCol
     }, delay); // simulate network latency
   });
 };
-exports.loadServerRows = loadServerRows;
 const findTreeDataRowChildren = (allRows, parentPath, pathKey = 'path', depth = 1, rowQualifier) => {
   const parentDepth = parentPath.length;
   const children = [];
@@ -344,7 +336,7 @@ const getTreeDataFilteredRows = (rows, filterModel, columnsWithDefaultColDef) =>
 /**
  * Simulates server data for tree-data feature
  */
-const processTreeDataRows = (rows, queryOptions, serverOptions, columnsWithDefaultColDef) => {
+export const processTreeDataRows = (rows, queryOptions, serverOptions, columnsWithDefaultColDef) => {
   const {
     minDelay = 100,
     maxDelay = 300
@@ -357,7 +349,7 @@ const processTreeDataRows = (rows, queryOptions, serverOptions, columnsWithDefau
   if (queryOptions.groupKeys == null) {
     throw new Error('serverOptions.groupKeys must be defined to compute tree data ');
   }
-  const delay = (0, _randomGenerator.randomInt)(minDelay, maxDelay);
+  const delay = randomInt(minDelay, maxDelay);
 
   // apply plain filtering
   const filteredRows = getTreeDataFilteredRows(rows, queryOptions.filterModel, columnsWithDefaultColDef);
@@ -372,11 +364,11 @@ const processTreeDataRows = (rows, queryOptions, serverOptions, columnsWithDefau
     const descendantCount = descendants.length;
     if (descendantCount > 0 && queryOptions.aggregationModel) {
       // Parent row, compute aggregation
-      return (0, _extends2.default)({}, row, {
+      return _extends({}, row, {
         descendantCount
       }, applyAggregation(queryOptions.aggregationModel, columnsWithDefaultColDef, descendants, row.id));
     }
-    return (0, _extends2.default)({}, row, {
+    return _extends({}, row, {
       descendantCount
     });
   });
@@ -413,8 +405,7 @@ const processTreeDataRows = (rows, queryOptions, serverOptions, columnsWithDefau
 /**
  * Simulates server data for row grouping feature
  */
-exports.processTreeDataRows = processTreeDataRows;
-const processRowGroupingRows = (rows, queryOptions, serverOptions, columnsWithDefaultColDef) => {
+export const processRowGroupingRows = (rows, queryOptions, serverOptions, columnsWithDefaultColDef) => {
   const {
     minDelay = 100,
     maxDelay = 300
@@ -429,7 +420,7 @@ const processRowGroupingRows = (rows, queryOptions, serverOptions, columnsWithDe
   if (queryOptions.groupFields == null) {
     throw new Error('serverOptions.groupFields must be defined to compute row grouping data');
   }
-  const delay = (0, _randomGenerator.randomInt)(minDelay, maxDelay);
+  const delay = randomInt(minDelay, maxDelay);
   const pathsToAutogenerate = new Set();
   let rowsWithPaths = rows;
   const rowsWithMissingGroups = [];
@@ -443,7 +434,7 @@ const processRowGroupingRows = (rows, queryOptions, serverOptions, columnsWithDe
         const value = partialPath[index];
         if (value === undefined) {
           if (index === 0) {
-            rowsWithMissingGroups.push((0, _extends2.default)({}, row, {
+            rowsWithMissingGroups.push(_extends({}, row, {
               group: false
             }));
           }
@@ -455,13 +446,13 @@ const processRowGroupingRows = (rows, queryOptions, serverOptions, columnsWithDe
           pathsToAutogenerate.add(strigifiedPath);
         }
       }
-      acc.push((0, _extends2.default)({}, row, {
+      acc.push(_extends({}, row, {
         path: [...partialPath, '']
       }));
       return acc;
     }, []);
   } else {
-    rowsWithPaths = rows.map(row => (0, _extends2.default)({}, row, {
+    rowsWithPaths = rows.map(row => _extends({}, row, {
       path: ['']
     }));
   }
@@ -496,11 +487,11 @@ const processRowGroupingRows = (rows, queryOptions, serverOptions, columnsWithDe
     const descendantCount = descendants.length;
     if (descendantCount > 0 && queryOptions.aggregationModel) {
       // Parent row, compute aggregation
-      return (0, _extends2.default)({}, row, {
+      return _extends({}, row, {
         descendantCount
       }, applyAggregation(queryOptions.aggregationModel, columnsWithDefaultColDef, descendants, row.id));
     }
-    return (0, _extends2.default)({}, row, {
+    return _extends({}, row, {
       descendantCount
     });
   });
@@ -533,5 +524,4 @@ const processRowGroupingRows = (rows, queryOptions, serverOptions, columnsWithDe
       });
     }, delay); // simulate network latency
   });
-};
-exports.processRowGroupingRows = processRowGroupingRows;
+};

package/esm/hooks/useBasicDemoData.d.ts

@@ -0,0 +1,2 @@
+import { GridBasicData } from "../services/index.js";
+export declare const useBasicDemoData: (nbRows: number, nbCols: number) => GridBasicData;

package/esm/hooks/useBasicDemoData.js

@@ -0,0 +1,5 @@
+import * as React from 'react';
+import { getBasicGridData } from "../services/index.js";
+export const useBasicDemoData = (nbRows, nbCols) => {
+  return React.useMemo(() => getBasicGridData(nbRows, nbCols), [nbRows, nbCols]);
+};

package/esm/hooks/useDemoData.d.ts

@@ -0,0 +1,30 @@
+import { GridColumnVisibilityModel } from '@mui/x-data-grid-premium';
+import { GridDemoData } from "../services/real-data-service.js";
+import { GridColDefGenerator } from "../services/gridColDefGenerator.js";
+import { AddPathToDemoDataOptions, DemoTreeDataValue } from "../services/tree-data-generator.js";
+export type DemoDataReturnType = {
+  data: DemoTreeDataValue;
+  loading: boolean;
+  setRowLength: (count: number) => void;
+  loadNewData: () => void;
+};
+type DataSet = 'Commodity' | 'Employee';
+export interface UseDemoDataOptions {
+  dataSet: DataSet;
+  rowLength: number;
+  maxColumns?: number;
+  visibleFields?: string[];
+  editable?: boolean;
+  treeData?: AddPathToDemoDataOptions;
+}
+export declare function extrapolateSeed(rowLength: number, data: GridDemoData): Promise<GridDemoData>;
+export declare const deepFreeze: <T>(object: T) => T;
+export interface ColumnsOptions extends Pick<UseDemoDataOptions, 'dataSet' | 'editable' | 'maxColumns' | 'visibleFields'> {}
+export declare const getColumnsFromOptions: (options: ColumnsOptions) => GridColDefGenerator[];
+export declare const getInitialState: (options: UseDemoDataOptions, columns: GridColDefGenerator[]) => {
+  columns: {
+    columnVisibilityModel: GridColumnVisibilityModel;
+  };
+};
+export declare const useDemoData: (options: UseDemoDataOptions) => DemoDataReturnType;
+export {};

package/{node → esm}/hooks/useDemoData.js

@@ -1,29 +1,20 @@
-"use strict";
 'use client';
 
-var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.deepFreeze = void 0;
-exports.extrapolateSeed = extrapolateSeed;
-exports.useDemoData = exports.getInitialState = exports.getColumnsFromOptions = void 0;
-var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
-var React = _interopRequireWildcard(require("react"));
-var _lruCache = require("lru-cache");
-var _realDataService = require("../services/real-data-service");
-var _commodities = require("../columns/commodities.columns");
-var _employees = require("../columns/employees.columns");
-var _asyncWorker = _interopRequireDefault(require("../services/asyncWorker"));
-var _treeDataGenerator = require("../services/tree-data-generator");
-const dataCache = new _lruCache.LRUCache({
+import _extends from "@babel/runtime/helpers/esm/extends";
+import * as React from 'react';
+import { LRUCache } from 'lru-cache';
+import { getRealGridData } from "../services/real-data-service.js";
+import { getCommodityColumns } from "../columns/commodities.columns.js";
+import { getEmployeeColumns } from "../columns/employees.columns.js";
+import asyncWorker from "../services/asyncWorker.js";
+import { addTreeDataOptionsToDemoData } from "../services/tree-data-generator.js";
+const dataCache = new LRUCache({
   max: 10,
   ttl: 60 * 5 * 1e3 // 5 minutes
 });
 // Generate fake data from a seed.
 // It's about x20 faster than getRealData.
-async function extrapolateSeed(rowLength, data) {
+export async function extrapolateSeed(rowLength, data) {
   return new Promise(resolve => {
     const seed = data.rows;
     const rows = data.rows.slice();
@@ -44,16 +35,16 @@ async function extrapolateSeed(rowLength, data) {
       rows.push(row);
       tasks.current -= 1;
     }
-    (0, _asyncWorker.default)({
+    asyncWorker({
       work,
-      done: () => resolve((0, _extends2.default)({}, data, {
+      done: () => resolve(_extends({}, data, {
         rows
       })),
       tasks
     });
   });
 }
-const deepFreeze = object => {
+export const deepFreeze = object => {
   // Retrieve the property names defined on object
   const propNames = Object.getOwnPropertyNames(object);
 
@@ -67,11 +58,10 @@ const deepFreeze = object => {
   }
   return Object.freeze(object);
 };
-exports.deepFreeze = deepFreeze;
-const getColumnsFromOptions = options => {
-  let columns = options.dataSet === 'Commodity' ? (0, _commodities.getCommodityColumns)(options.editable) : (0, _employees.getEmployeeColumns)();
+export const getColumnsFromOptions = options => {
+  let columns = options.dataSet === 'Commodity' ? getCommodityColumns(options.editable) : getEmployeeColumns();
   if (options.visibleFields) {
-    columns = columns.map(col => options.visibleFields?.includes(col.field) ? col : (0, _extends2.default)({}, col, {
+    columns = columns.map(col => options.visibleFields?.includes(col.field) ? col : _extends({}, col, {
       hide: true
     }));
   }
@@ -80,8 +70,7 @@ const getColumnsFromOptions = options => {
   }
   return columns;
 };
-exports.getColumnsFromOptions = getColumnsFromOptions;
-const getInitialState = (options, columns) => {
+export const getInitialState = (options, columns) => {
   const columnVisibilityModel = {};
   columns.forEach(col => {
     if (col.hide) {
@@ -98,8 +87,7 @@ const getInitialState = (options, columns) => {
     }
   };
 };
-exports.getInitialState = getInitialState;
-const useDemoData = options => {
+export const useDemoData = options => {
   const [rowLength, setRowLength] = React.useState(options.rowLength);
   const [index, setIndex] = React.useState(0);
   const [loading, setLoading] = React.useState(true);
@@ -112,7 +100,7 @@ const useDemoData = options => {
     });
   }, [options.dataSet, options.editable, options.maxColumns, options.visibleFields]);
   const [data, setData] = React.useState(() => {
-    return (0, _treeDataGenerator.addTreeDataOptionsToDemoData)({
+    return addTreeDataOptionsToDemoData({
       columns,
       rows: [],
       initialState: getInitialState(options, columns)
@@ -134,15 +122,15 @@ const useDemoData = options => {
       setLoading(true);
       let newData;
       if (rowLength > 1000) {
-        newData = await (0, _realDataService.getRealGridData)(1000, columns);
+        newData = await getRealGridData(1000, columns);
         newData = await extrapolateSeed(rowLength, newData);
       } else {
-        newData = await (0, _realDataService.getRealGridData)(rowLength, columns);
+        newData = await getRealGridData(rowLength, columns);
       }
       if (!active) {
         return;
       }
-      newData = (0, _treeDataGenerator.addTreeDataOptionsToDemoData)(newData, {
+      newData = addTreeDataOptionsToDemoData(newData, {
         maxDepth: options.treeData?.maxDepth,
         groupingField: options.treeData?.groupingField,
         averageChildren: options.treeData?.averageChildren
@@ -168,5 +156,4 @@ const useDemoData = options => {
       setIndex(oldIndex => oldIndex + 1);
     }
   };
-};
-exports.useDemoData = useDemoData;
+};

package/esm/hooks/useMockServer.d.ts

@@ -0,0 +1,31 @@
+import type { GridGetRowsResponse } from '@mui/x-data-grid';
+import { type GridRowModel, type GridColDef, type GridInitialState } from '@mui/x-data-grid-premium';
+import { AddPathToDemoDataOptions } from "../services/tree-data-generator.js";
+import type { ServerOptions } from './serverUtils';
+export declare const BASE_URL = "https://mui.com/x/api/data-grid";
+type UseMockServerResponse<T> = {
+  columns: GridColDef[];
+  initialState: GridInitialState;
+  getGroupKey?: (row: GridRowModel) => string;
+  getChildrenCount?: (row: GridRowModel) => number;
+  fetchRows: (url: string) => Promise<T>;
+  loadNewData: () => void;
+  isReady: boolean;
+};
+type DataSet = 'Commodity' | 'Employee' | 'Movies';
+interface UseMockServerOptions {
+  dataSet: DataSet;
+  /**
+   * Has no effect when DataSet='Movies'
+   */
+  rowLength: number;
+  maxColumns?: number;
+  visibleFields?: string[];
+  editable?: boolean;
+  treeData?: AddPathToDemoDataOptions;
+  rowGrouping?: boolean;
+}
+export declare const useMockServer: <T extends GridGetRowsResponse>(dataSetOptions?: Partial<UseMockServerOptions>, serverOptions?: ServerOptions & {
+  verbose?: boolean;
+}, shouldRequestsFail?: boolean) => UseMockServerResponse<T>;
+export {};