@opencorestack/opengridx 1.2.3 → 1.3.0

package/CHANGELOG.md

@@ -5,6 +5,22 @@
 
 ---
 
+## [1.3.0] — 2026-09-08
+
+### Added
+- **Grouped export** — all five export functions (`exportToCsv`, `exportToExcel`, `exportToJson`,
+  `printGrid`, `exportToPdf`) now accept an optional `groupedRows?: GridGroupedExportRow[]` option.
+  When provided, the export preserves the row-grouping structure: group-header rows, indented leaf
+  rows, per-group subtotals, and a grand total footer. Flat behavior is unchanged when the option
+  is absent, making this a fully backward-compatible addition.
+- **`GridApi.getGroupedExportRows()`** — new method that returns a flat ordered list of
+  `GridGroupedExportRow` entries (types: `group-header | leaf | group-subtotal | grand-total`)
+  by traversing the active row-grouping tree. Returns `null` when row grouping is not active.
+- **`GridGroupedExportRow` type** — new public interface describing each entry in the grouped
+  export list (`type`, `depth`, `groupField?`, `groupValue?`, `aggregatedValues?`, `row?`).
+
+---
+
 ## [1.2.3] — 2026-09-08
 
 ### Fixed

package/dist/index.d.ts

@@ -78,6 +78,8 @@ export declare interface CsvExportOptions {
     selectedRows?: (string | number)[];
     aggregationResult?: Record<string, unknown> | null;
     aggregationModel?: GridAggregationModel | null;
+    /** When provided, emits group headers, leaf rows, subtotals, and a grand total instead of a flat row list. */
+    groupedRows?: GridGroupedExportRow[];
 }
 
 export declare const darkTheme: GridTheme;
@@ -330,6 +332,8 @@ export declare interface ExcelExportOptions {
     selectedRows?: (string | number)[];
     aggregationResult?: Record<string, unknown> | null;
     aggregationModel?: GridAggregationModel | null;
+    /** When provided, emits group headers, leaf rows, subtotals, and a grand total instead of a flat row list. */
+    groupedRows?: GridGroupedExportRow[];
 }
 
 export declare interface ExcelSheetDefinition {
@@ -404,6 +408,13 @@ export declare interface GridApi {
     getVisibleRows: () => GridRowModel[];
     /** Returns all filtered and sorted rows, ignoring pagination. Use this for full-dataset exports. */
     getAllFilteredRows: () => GridRowModel[];
+    /**
+     * Returns an ordered flat list of `GridGroupedExportRow` entries that mirrors the
+     * on-screen grouping tree: group-headers, leaf rows, per-group subtotals, and a
+     * grand-total entry at the end. Returns `null` when no `rowGroupingModel` is active.
+     * Pass the result to export functions that accept a `groupedRows` option.
+     */
+    getGroupedExportRows: () => GridGroupedExportRow[] | null;
     /** Returns the current aggregation results. */
     getAggregationResult: () => Record<string, unknown> | null;
     /** Returns the active aggregation configuration. */
@@ -697,6 +708,25 @@ export declare interface GridGetRowsResponse<R extends GridRowModel = GridRowMod
     aggregationResults?: Record<string, unknown>;
 }
 
+/**
+ * A single entry in the ordered list returned by `GridApi.getGroupedExportRows()`.
+ * Traverse in array order to reproduce the on-screen grouping structure.
+ */
+declare interface GridGroupedExportRow {
+    /** Discriminator: the kind of row this entry represents. */
+    type: 'group-header' | 'leaf' | 'group-subtotal' | 'grand-total';
+    /** Nesting depth (0 = top-level group, 1 = nested group, etc.). */
+    depth: number;
+    /** The grouping field for this level (absent on 'leaf' and 'grand-total'). */
+    groupField?: string;
+    /** The raw grouping value for this level (absent on 'leaf' and 'grand-total'). */
+    groupValue?: unknown;
+    /** Per-group aggregation results (present on 'group-subtotal' and 'grand-total'). */
+    aggregatedValues?: Record<string, unknown>;
+    /** The original data row (only present when `type === 'leaf'`). */
+    row?: GridRowModel;
+}
+
 export declare type GridInitialState = GridState;
 
 /** Column definition used exclusively in List View mode. */
@@ -1176,6 +1206,8 @@ export declare interface JsonExportOptions {
     selectedRows?: (string | number)[];
     aggregationResult?: Record<string, unknown> | null;
     aggregationModel?: GridAggregationModel | null;
+    /** When provided, emits a nested grouping tree instead of a flat array. */
+    groupedRows?: GridGroupedExportRow[];
 }
 
 /**
@@ -1234,6 +1266,13 @@ export declare interface PdfExportOptions {
      * Base font size in points for table body. Default: 9
      */
     fontSize?: number;
+    /**
+     * Pre-built grouped export rows from `apiRef.current.getGroupedExportRows()`.
+     * When provided, the PDF table reflects the grouping structure (group headers,
+     * leaf rows, per-group subtotals, grand total) instead of a flat row list.
+     * Has no effect when the grid has no active `rowGroupingModel`.
+     */
+    groupedRows?: GridGroupedExportRow[];
 }
 
 /**
@@ -1246,6 +1285,8 @@ export declare interface PrintOptions {
     selectedRows?: (string | number)[];
     aggregationResult?: Record<string, unknown> | null;
     aggregationModel?: GridAggregationModel | null;
+    /** When provided, emits group headers, leaf rows, subtotals, and a grand total instead of a flat row list. */
+    groupedRows?: GridGroupedExportRow[];
 }
 
 export declare const roseTheme: GridTheme;