@homebound/beam 2.364.0 → 2.365.0

package/dist/components/Table/GridTable.d.ts

@@ -131,6 +131,13 @@ export interface GridTableProps<R extends Kinded, X> {
     infiniteScroll?: InfiniteScroll;
     /** Callback for when a row is selected or unselected. */
     onRowSelect?: OnRowSelect<R>;
+    /**
+     * Custom prefix rows for any CSV output, i.e. a header like "Report X as of date Y with filter Z".
+     *
+     * We except the `string[][]` to be an array of cells, and `copyToClipboard` and `downloadToCsv` will drop them into
+     * the csv output basically unchanged, albeit we will escape any special chars like double quotes and newlines.
+     */
+    csvPrefixRows?: string[][];
     /** Drag & drop Callback. */
     onRowDrop?: (draggedRow: GridDataRow<R>, droppedRow: GridDataRow<R>, indexOffset: number) => void;
 }

package/dist/components/Table/GridTable.js

@@ -88,7 +88,7 @@ exports.setGridTableDefaults = setGridTableDefaults;
  */
 function GridTable(props) {
     var _a, _b, _c;
-    const { id = "gridTable", as = "div", columns: _columns, rows, style: maybeStyle = defaults.style, rowStyles, stickyHeader = defaults.stickyHeader, stickyOffset = 0, xss, filter, filterMaxRows, fallbackMessage = "No rows found.", infoMessage, persistCollapse, resizeTarget, activeRowId, activeCellId, visibleColumnsStorageKey, infiniteScroll, onRowSelect, onRowDrop: droppedCallback, } = props;
+    const { id = "gridTable", as = "div", columns: _columns, rows, style: maybeStyle = defaults.style, rowStyles, stickyHeader = defaults.stickyHeader, stickyOffset = 0, xss, filter, filterMaxRows, fallbackMessage = "No rows found.", infoMessage, persistCollapse, resizeTarget, activeRowId, activeCellId, visibleColumnsStorageKey, infiniteScroll, onRowSelect, onRowDrop: droppedCallback, csvPrefixRows, } = props;
     const columnsWithIds = (0, react_1.useMemo)(() => (0, columns_1.assignDefaultColumnIds)(_columns), [_columns]);
     // We only use this in as=virtual mode, but keep this here for rowLookup to use
     const virtuosoRef = (0, react_1.useRef)(null);
@@ -129,10 +129,11 @@ function GridTable(props) {
             tableState.setRows(rows);
             tableState.setColumns(columnsWithIds, visibleColumnsStorageKey);
             tableState.setSearch(filter);
+            tableState.setCsvPrefixRows(csvPrefixRows);
             tableState.activeRowId = activeRowId;
             tableState.activeCellId = activeCellId;
         });
-    }, [tableState, rows, columnsWithIds, visibleColumnsStorageKey, activeRowId, activeCellId, filter]);
+    }, [tableState, rows, columnsWithIds, visibleColumnsStorageKey, activeRowId, activeCellId, filter, csvPrefixRows]);
     const columns = (0, hooks_1.useComputed)(() => {
         return tableState.visibleColumns;
     }, [tableState]);

package/dist/components/Table/GridTableApi.js

@@ -134,8 +134,10 @@ class GridTableApiImpl {
     // ...although maybe it could be public someday, to allow getting the raw the CSV content
     // and then sending it somewhere else, like directly to a gsheet.
     generateCsvContent() {
+        var _a, _b;
+        const csvPrefixRows = (_b = (_a = this.tableState.csvPrefixRows) === null || _a === void 0 ? void 0 : _a.map((row) => row.map(escapeCsvValue).join(","))) !== null && _b !== void 0 ? _b : [];
         // Convert the array of rows into CSV format
-        return this.tableState.visibleRows.map((rs) => {
+        const dataRows = this.tableState.visibleRows.map((rs) => {
             const values = this.tableState.visibleColumns
                 .filter((c) => !c.isAction)
                 .map((c) => {
@@ -157,6 +159,7 @@ class GridTableApiImpl {
             });
             return values.map(toCsvString).map(escapeCsvValue).join(",");
         });
+        return [...csvPrefixRows, ...dataRows];
     }
 }
 exports.GridTableApiImpl = GridTableApiImpl;

package/dist/components/Table/utils/TableState.d.ts

@@ -32,6 +32,8 @@ export declare class TableState<R extends Kinded> {
     activeCellId: string | undefined;
     /** Stores the current client-side type-ahead search/filter. */
     search: string[];
+    /** Stores whether CSVs should have some prefix rows. */
+    csvPrefixRows: string[][] | undefined;
     sortConfig: GridSortConfig | undefined;
     sort: SortState;
     private initialSortState;
@@ -50,6 +52,7 @@ export declare class TableState<R extends Kinded> {
     setRows(rows: GridDataRow<R>[]): void;
     setColumns(columns: GridColumnWithId<R>[], visibleColumnsStorageKey: string | undefined): void;
     setSearch(search: string | undefined): void;
+    setCsvPrefixRows(csvPrefixRows: string[][] | undefined): void;
     get visibleRows(): RowState<R>[];
     /** Returns visible columns, i.e. those that are visible + any expanded children. */
     get visibleColumns(): GridColumnWithId<R>[];

package/dist/components/Table/utils/TableState.js

@@ -42,6 +42,8 @@ class TableState {
         this.activeCellId = undefined;
         /** Stores the current client-side type-ahead search/filter. */
         this.search = [];
+        /** Stores whether CSVs should have some prefix rows. */
+        this.csvPrefixRows = undefined;
         // Tracks the active sort column(s), so GridTable or SortHeaders can reactively
         // re-render (for GridTable, only if client-side sorting)
         this.sort = {};
@@ -143,6 +145,9 @@ class TableState {
         // Break up "foo bar" into `[foo, bar]` and a row must match both `foo` and `bar`
         this.search = (search && search.split(/ +/)) || [];
     }
+    setCsvPrefixRows(csvPrefixRows) {
+        this.csvPrefixRows = csvPrefixRows;
+    }
     get visibleRows() {
         return this.rowStates.visibleRows;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@homebound/beam",
-  "version": "2.364.0",
+  "version": "2.365.0",
   "author": "Homebound",
   "license": "MIT",
   "main": "dist/index.js",