@mui/x-data-grid 7.5.0 → 7.5.1

package/node/components/toolbar/GridToolbarQuickFilter.js

@@ -136,7 +136,7 @@ function GridToolbarQuickFilter(props) {
 process.env.NODE_ENV !== "production" ? GridToolbarQuickFilter.propTypes = {
   // ----------------------------- Warning --------------------------------
   // | These PropTypes are generated from the TypeScript type definitions |
-  // | To update them edit the TypeScript types and run "yarn proptypes"  |
+  // | To update them edit the TypeScript types and run "pnpm proptypes"  |
   // ----------------------------------------------------------------------
   /**
    * The debounce time in milliseconds.

package/node/hooks/features/clipboard/useGridClipboard.js

@@ -74,18 +74,21 @@ const useGridClipboard = (apiRef, props) => {
     if (selectedRows.size > 0) {
       textToCopy = apiRef.current.getDataAsCsv({
         includeHeaders: false,
-        // TODO: make it configurable
         delimiter: clipboardCopyCellDelimiter,
-        shouldAppendQuotes: false
+        shouldAppendQuotes: false,
+        escapeFormulas: false
       });
     } else {
       const focusedCell = (0, _gridFocusStateSelector.gridFocusCellSelector)(apiRef);
       if (focusedCell) {
         const cellParams = apiRef.current.getCellParams(focusedCell.id, focusedCell.field);
         textToCopy = (0, _csvSerializer.serializeCellValue)(cellParams, {
-          delimiterCharacter: clipboardCopyCellDelimiter,
-          ignoreValueFormatter,
-          shouldAppendQuotes: false
+          csvOptions: {
+            delimiter: clipboardCopyCellDelimiter,
+            shouldAppendQuotes: false,
+            escapeFormulas: false
+          },
+          ignoreValueFormatter
         });
       }
     }

package/node/hooks/features/export/serializers/csvSerializer.js

@@ -7,14 +7,20 @@ exports.buildCSV = buildCSV;
 exports.serializeCellValue = void 0;
 var _colDef = require("../../../../colDef");
 var _warning = require("../../../../utils/warning");
-function sanitizeCellValue(value, delimiterCharacter, shouldAppendQuotes) {
+function sanitizeCellValue(value, csvOptions) {
   if (typeof value === 'string') {
-    if (shouldAppendQuotes) {
+    if (csvOptions.shouldAppendQuotes || csvOptions.escapeFormulas) {
       const escapedValue = value.replace(/"/g, '""');
-      // Make sure value containing delimiter or line break won't be split into multiple rows
-      if ([delimiterCharacter, '\n', '\r', '"'].some(delimiter => value.includes(delimiter))) {
+      // Make sure value containing delimiter or line break won't be split into multiple cells
+      if ([csvOptions.delimiter, '\n', '\r', '"'].some(delimiter => value.includes(delimiter))) {
         return `"${escapedValue}"`;
       }
+      if (csvOptions.escapeFormulas) {
+        // See https://owasp.org/www-community/attacks/CSV_Injection
+        if (['=', '+', '-', '@', '\t', '\r'].includes(escapedValue[0])) {
+          return `'${escapedValue}`;
+        }
+      }
       return escapedValue;
     }
     return value;
@@ -23,9 +29,8 @@ function sanitizeCellValue(value, delimiterCharacter, shouldAppendQuotes) {
 }
 const serializeCellValue = (cellParams, options) => {
   const {
-    delimiterCharacter,
-    ignoreValueFormatter,
-    shouldAppendQuotes
+    csvOptions,
+    ignoreValueFormatter
   } = options;
   let value;
   if (ignoreValueFormatter) {
@@ -42,7 +47,7 @@ const serializeCellValue = (cellParams, options) => {
   } else {
     value = cellParams.formattedValue;
   }
-  return sanitizeCellValue(value, delimiterCharacter, shouldAppendQuotes);
+  return sanitizeCellValue(value, csvOptions);
 };
 exports.serializeCellValue = serializeCellValue;
 const objectFormattedValueWarning = (0, _warning.buildWarning)(['MUI X: When the value of a field is an object or a `renderCell` is provided, the CSV export might not display the value correctly.', 'You can provide a `valueFormatter` with a string representation to be used.']);
@@ -55,12 +60,12 @@ class CSVRow {
   }
   addValue(value) {
     if (!this.isEmpty) {
-      this.rowString += this.options.delimiterCharacter;
+      this.rowString += this.options.csvOptions.delimiter;
     }
     if (value === null || value === undefined) {
       this.rowString += '';
     } else if (typeof this.options.sanitizeCellValue === 'function') {
-      this.rowString += this.options.sanitizeCellValue(value, this.options.delimiterCharacter, this.options.shouldAppendQuotes);
+      this.rowString += this.options.sanitizeCellValue(value, this.options.csvOptions);
     } else {
       this.rowString += value;
     }
@@ -74,13 +79,11 @@ const serializeRow = ({
   id,
   columns,
   getCellParams,
-  delimiterCharacter,
-  ignoreValueFormatter,
-  shouldAppendQuotes
+  csvOptions,
+  ignoreValueFormatter
 }) => {
   const row = new CSVRow({
-    delimiterCharacter,
-    shouldAppendQuotes
+    csvOptions
   });
   columns.forEach(column => {
     const cellParams = getCellParams(id, column.field);
@@ -90,9 +93,8 @@ const serializeRow = ({
       }
     }
     row.addValue(serializeCellValue(cellParams, {
-      delimiterCharacter,
       ignoreValueFormatter,
-      shouldAppendQuotes
+      csvOptions
     }));
   });
   return row.getRowString();
@@ -101,27 +103,23 @@ function buildCSV(options) {
   const {
     columns,
     rowIds,
-    delimiterCharacter,
-    includeHeaders,
-    includeColumnGroupsHeaders,
+    csvOptions,
     ignoreValueFormatter,
-    apiRef,
-    shouldAppendQuotes
+    apiRef
   } = options;
   const CSVBody = rowIds.reduce((acc, id) => `${acc}${serializeRow({
     id,
     columns,
     getCellParams: apiRef.current.getCellParams,
-    delimiterCharacter,
     ignoreValueFormatter,
-    shouldAppendQuotes
+    csvOptions
   })}\r\n`, '').trim();
-  if (!includeHeaders) {
+  if (!csvOptions.includeHeaders) {
     return CSVBody;
   }
   const filteredColumns = columns.filter(column => column.field !== _colDef.GRID_CHECKBOX_SELECTION_COL_DEF.field);
   const headerRows = [];
-  if (includeColumnGroupsHeaders) {
+  if (csvOptions.includeColumnGroupsHeaders) {
     const columnGroupLookup = apiRef.current.getAllGroupDetails();
     let maxColumnGroupsDepth = 0;
     const columnGroupPathsLookup = filteredColumns.reduce((acc, column) => {
@@ -132,9 +130,8 @@ function buildCSV(options) {
     }, {});
     for (let i = 0; i < maxColumnGroupsDepth; i += 1) {
       const headerGroupRow = new CSVRow({
-        delimiterCharacter,
-        sanitizeCellValue,
-        shouldAppendQuotes
+        csvOptions,
+        sanitizeCellValue
       });
       headerRows.push(headerGroupRow);
       filteredColumns.forEach(column => {
@@ -145,9 +142,8 @@ function buildCSV(options) {
     }
   }
   const mainHeaderRow = new CSVRow({
-    delimiterCharacter,
-    sanitizeCellValue,
-    shouldAppendQuotes
+    csvOptions,
+    sanitizeCellValue
   });
   filteredColumns.forEach(column => {
     mainHeaderRow.addValue(column.headerName || column.field);

package/node/hooks/features/export/useGridCsvExport.js

@@ -39,12 +39,15 @@ const useGridCsvExport = (apiRef, props) => {
     return (0, _csvSerializer.buildCSV)({
       columns: exportedColumns,
       rowIds: exportedRowIds,
-      delimiterCharacter: options.delimiter || ',',
-      includeHeaders: options.includeHeaders ?? true,
-      includeColumnGroupsHeaders: options.includeColumnGroupsHeaders ?? true,
+      csvOptions: {
+        delimiter: options.delimiter || ',',
+        shouldAppendQuotes: options.shouldAppendQuotes ?? true,
+        includeHeaders: options.includeHeaders ?? true,
+        includeColumnGroupsHeaders: options.includeColumnGroupsHeaders ?? true,
+        escapeFormulas: options.escapeFormulas ?? true
+      },
       ignoreValueFormatter,
-      apiRef,
-      shouldAppendQuotes: options.shouldAppendQuotes ?? true
+      apiRef
     });
   }, [logger, apiRef, ignoreValueFormatter]);
   const exportDataAsCsv = React.useCallback(options => {

package/node/index.js

@@ -1,5 +1,5 @@
 /**
- * @mui/x-data-grid v7.5.0
+ * @mui/x-data-grid v7.5.1
  *
  * @license MIT
  * This source code is licensed under the MIT license found in the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/x-data-grid",
-  "version": "7.5.0",
+  "version": "7.5.1",
   "description": "The Community plan edition of the Data Grid components (MUI X).",
   "author": "MUI Team",
   "main": "./node/index.js",