beautiful-grid 1.0.12 → 1.0.13

package/cjs/BGrid.js

@@ -759,7 +759,8 @@ function BGrid(_a) {
     ]);
     return (React.createElement(store_1.AppStoreProvider, { initialState: initialStoreState },
         React.createElement(TreeContext_1.TreeContext.Provider, { value: treeContextValue },
-            React.createElement(Table_1.default, { ref: ref, columns: computedColumns,
+            React.createElement(Table_1.default, { ref: ref, sourceColumns: resolvedColumns,
+                columns: computedColumns,
                 columnsGroup: visibilityProjection.columnsGroup,
                 columnGroups: visibilityProjection.columnGroups,
                 onChangeColumns: resolvedOnChangeColumns, width: width, height: height, className: className, style: style, loading: loading, disabled: resolvedDisabled, spinning: spinning, scrollLeft: scrollLeft, scrollTop: scrollTop, headerHeight: headerHeight, footerHeight: footerHeight, bottomBarHeight: resolvedBottomBarHeight,

package/cjs/components/Table.js

@@ -166,6 +166,7 @@ function Table(props) {
     var _a;
     var _this = this;
     var _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6, _7, _8;
+    var store = (0, store_1.useAppStoreApi)();
     var cellSelectionOptions = props.cellSelectionOptions, onChangeData = props.onChangeData, sourceIndexByVisibleIndex = props.sourceIndexByVisibleIndex;
     var cellSelectionEnabled = (_b = cellSelectionOptions === null || cellSelectionOptions === void 0 ? void 0 : cellSelectionOptions.enabled) !== null && _b !== void 0 ? _b : true;
     var rowKeyRegistryState = (0, react_1.useRef)({
@@ -657,12 +658,46 @@ function Table(props) {
     var scrollPropsRef = (0, react_1.useRef)({ top: props.scrollTop, left: props.scrollLeft });
     var syncedDataPropRef = (0, react_1.useRef)(props.data);
     var _23 = __read(React.useState(null), 2), rowScrollRequest = _23[0], setRowScrollRequest = _23[1];
+    var sourceColumnsRef = (0, react_1.useRef)(props.sourceColumns);
+    sourceColumnsRef.current = props.sourceColumns;
+    var getCurrentExportData = (0, react_1.useCallback)(function (options) {
+        var state = store.getState();
+        return (0, utils_1.createGridExportData)({
+            options: options,
+            columns: state.columns,
+            sourceColumns: sourceColumnsRef.current,
+            data: state.data,
+            sourceData: state.sourceData,
+            sourceIndexByVisibleIndex: state.sourceIndexByVisibleIndex,
+            visibleIndexBySourceIndex: state.visibleIndexBySourceIndex,
+            checkedIndexesMap: state.checkedIndexesMap,
+            rowKey: state.rowKey,
+        });
+    }, [store]);
     React.useImperativeHandle(props.ref, function () { return ({
         scrollToRow: function (rowIndex, options) {
             var _a;
             setRowScrollRequest({ rowIndex: rowIndex, align: (_a = options === null || options === void 0 ? void 0 : options.align) !== null && _a !== void 0 ? _a : 'nearest' });
         },
-    }); }, []);
+        getExportData: function (options) {
+            return getCurrentExportData(options);
+        },
+        exportCsv: function (options) {
+            var _a;
+            var exportData = getCurrentExportData(options);
+            var csv = (0, utils_1.serializeGridExportDataToCsv)(exportData, options);
+            (0, utils_1.downloadCsv)(csv, (_a = options === null || options === void 0 ? void 0 : options.fileName) !== null && _a !== void 0 ? _a : 'export.csv');
+        },
+        exportExcel: function (options) {
+            var exportData = getCurrentExportData(options);
+            void Promise.resolve().then(function () { return __importStar(require('../utils/exportExcel')); }).then(function (_a) {
+                var _b;
+                var serializeGridExportDataToExcel = _a.serializeGridExportDataToExcel, downloadExcel = _a.downloadExcel;
+                var excelBytes = serializeGridExportDataToExcel(exportData, options);
+                downloadExcel(excelBytes, (_b = options === null || options === void 0 ? void 0 : options.fileName) !== null && _b !== void 0 ? _b : 'export.xlsx');
+            });
+        },
+    }); }, [getCurrentExportData]);
     var scrollRafRef = (0, react_1.useRef)(null);
     var scrollIdleTimerRef = (0, react_1.useRef)(null);
     var selectionAutoScrollRafRef = (0, react_1.useRef)(null);

package/cjs/utils/exportCsv.js

@@ -0,0 +1,129 @@
+"use strict";
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatCsvCellValue = formatCsvCellValue;
+exports.escapeCsvCell = escapeCsvCell;
+exports.serializeGridExportDataToCsv = serializeGridExportDataToCsv;
+exports.downloadCsv = downloadCsv;
+function formatCsvCellValue(value, preventFormulaInjection) {
+    if (preventFormulaInjection === void 0) { preventFormulaInjection = true; }
+    if (value === null || value === undefined) {
+        return '';
+    }
+    var formatted;
+    if (typeof value === 'string') {
+        formatted = value;
+        var startsWithFormula = /^[=+\-@]/.test(formatted);
+        var startsWithDangerousControl = /^[\t\r\n]/.test(formatted);
+        var hasFormulaAfterLeadingWhitespace = /^\s+[=+\-@]/.test(formatted);
+        if (preventFormulaInjection &&
+            (startsWithFormula || startsWithDangerousControl || hasFormulaAfterLeadingWhitespace)) {
+            formatted = "'".concat(formatted);
+        }
+        return formatted;
+    }
+    if (typeof value === 'number') {
+        return String(value);
+    }
+    if (typeof value === 'boolean') {
+        return value ? 'true' : 'false';
+    }
+    if (typeof value === 'bigint') {
+        return value.toString();
+    }
+    if (value instanceof Date) {
+        return isNaN(value.getTime()) ? 'Invalid Date' : value.toISOString();
+    }
+    if (typeof value === 'object') {
+        try {
+            formatted = JSON.stringify(value);
+        }
+        catch (_a) {
+            formatted = String(value);
+        }
+        return formatted;
+    }
+    return String(value);
+}
+function escapeCsvCell(cell, delimiter) {
+    if (delimiter === void 0) { delimiter = ','; }
+    var needsQuotes = cell.includes(delimiter) ||
+        cell.includes('"') ||
+        cell.includes('\r') ||
+        cell.includes('\n');
+    if (needsQuotes) {
+        return "\"".concat(cell.replace(/"/g, '""'), "\"");
+    }
+    return cell;
+}
+function serializeGridExportDataToCsv(data, options) {
+    var e_1, _a;
+    var _b, _c, _d, _e, _f;
+    var delimiter = (_b = options === null || options === void 0 ? void 0 : options.delimiter) !== null && _b !== void 0 ? _b : ',';
+    var newline = (_c = options === null || options === void 0 ? void 0 : options.newline) !== null && _c !== void 0 ? _c : '\r\n';
+    var includeHeader = (_d = options === null || options === void 0 ? void 0 : options.includeHeader) !== null && _d !== void 0 ? _d : true;
+    var bom = (_e = options === null || options === void 0 ? void 0 : options.bom) !== null && _e !== void 0 ? _e : true;
+    var preventFormulaInjection = (_f = options === null || options === void 0 ? void 0 : options.preventFormulaInjection) !== null && _f !== void 0 ? _f : true;
+    var lines = [];
+    if (includeHeader) {
+        var headerLine = data.columns
+            .map(function (col) { return escapeCsvCell(formatCsvCellValue(col.header, preventFormulaInjection), delimiter); })
+            .join(delimiter);
+        lines.push(headerLine);
+    }
+    try {
+        for (var _g = __values(data.rows), _h = _g.next(); !_h.done; _h = _g.next()) {
+            var row = _h.value;
+            var rowLine = row.cells
+                .map(function (cell) { return escapeCsvCell(formatCsvCellValue(cell, preventFormulaInjection), delimiter); })
+                .join(delimiter);
+            lines.push(rowLine);
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (_h && !_h.done && (_a = _g.return)) _a.call(_g);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    var csvText = lines.join(newline);
+    return (bom ? '\uFEFF' : '') + csvText;
+}
+function downloadCsv(csv, fileName) {
+    if (fileName === void 0) { fileName = 'export.csv'; }
+    if (typeof window === 'undefined' || typeof document === 'undefined') {
+        return;
+    }
+    var resolvedName = (fileName || '').trim();
+    if (!resolvedName) {
+        resolvedName = 'export.csv';
+    }
+    else if (!resolvedName.toLowerCase().endsWith('.csv')) {
+        resolvedName += '.csv';
+    }
+    var blob = new Blob([csv], { type: 'text/csv;charset=utf-8;' });
+    if (typeof URL !== 'undefined' && typeof URL.createObjectURL === 'function') {
+        var url = URL.createObjectURL(blob);
+        var link = document.createElement('a');
+        link.href = url;
+        link.setAttribute('download', resolvedName);
+        link.style.display = 'none';
+        document.body.appendChild(link);
+        link.click();
+        document.body.removeChild(link);
+        if (typeof URL.revokeObjectURL === 'function') {
+            URL.revokeObjectURL(url);
+        }
+    }
+}

package/cjs/utils/exportData.js

@@ -0,0 +1,230 @@
+"use strict";
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveExportColumns = resolveExportColumns;
+exports.resolveExportRows = resolveExportRows;
+exports.createGridExportData = createGridExportData;
+var getColumnId_1 = require("./getColumnId");
+var getCellValue_1 = require("./getCellValue");
+function resolveExportColumns(columns, sourceColumns, scope) {
+    var e_1, _a, e_2, _b;
+    if (scope === void 0) { scope = 'visible'; }
+    var selectedColumns;
+    if (Array.isArray(scope)) {
+        var candidatePool = sourceColumns && sourceColumns.length > 0 ? sourceColumns : columns;
+        var columnMap = new Map();
+        try {
+            for (var candidatePool_1 = __values(candidatePool), candidatePool_1_1 = candidatePool_1.next(); !candidatePool_1_1.done; candidatePool_1_1 = candidatePool_1.next()) {
+                var col = candidatePool_1_1.value;
+                columnMap.set((0, getColumnId_1.getColumnId)(col), col);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (candidatePool_1_1 && !candidatePool_1_1.done && (_a = candidatePool_1.return)) _a.call(candidatePool_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        selectedColumns = [];
+        try {
+            for (var scope_1 = __values(scope), scope_1_1 = scope_1.next(); !scope_1_1.done; scope_1_1 = scope_1.next()) {
+                var id = scope_1_1.value;
+                var col = columnMap.get(id);
+                if (col) {
+                    selectedColumns.push(col);
+                }
+            }
+        }
+        catch (e_2_1) { e_2 = { error: e_2_1 }; }
+        finally {
+            try {
+                if (scope_1_1 && !scope_1_1.done && (_b = scope_1.return)) _b.call(scope_1);
+            }
+            finally { if (e_2) throw e_2.error; }
+        }
+    }
+    else if (scope === 'all') {
+        selectedColumns = sourceColumns && sourceColumns.length > 0 ? __spreadArray([], __read(sourceColumns), false) : __spreadArray([], __read(columns), false);
+    }
+    else {
+        // 'visible'
+        selectedColumns = __spreadArray([], __read(columns), false);
+    }
+    var exportableColumns = selectedColumns.filter(function (col) { return col.exportable !== false; });
+    return exportableColumns.map(function (column, columnIndex) {
+        var columnId = (0, getColumnId_1.getColumnId)(column);
+        var header;
+        if (typeof column.exportHeader === 'function') {
+            header = column.exportHeader(column);
+        }
+        else if (typeof column.exportHeader === 'string') {
+            header = column.exportHeader;
+        }
+        else if (typeof column.label === 'string' || typeof column.label === 'number') {
+            header = String(column.label);
+        }
+        else {
+            header = columnId;
+        }
+        return {
+            columnId: columnId,
+            header: header,
+            column: column,
+            columnIndex: columnIndex,
+        };
+    });
+}
+function resolveExportRows(exportColumns, params) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+    var rowScope = (_b = (_a = params.options) === null || _a === void 0 ? void 0 : _a.rows) !== null && _b !== void 0 ? _b : 'displayed';
+    var rows = [];
+    var sourcePool = params.sourceData && params.sourceData.length > 0 ? params.sourceData : params.data;
+    var buildCells = function (item, values, sourceIndex, visibleIndex) {
+        var e_3, _a;
+        var cells = [];
+        try {
+            for (var exportColumns_1 = __values(exportColumns), exportColumns_1_1 = exportColumns_1.next(); !exportColumns_1_1.done; exportColumns_1_1 = exportColumns_1.next()) {
+                var expCol = exportColumns_1_1.value;
+                var rawValue = (0, getCellValue_1.getCellValueByRowKey)(expCol.column.key, values);
+                if (expCol.column.getExportValue) {
+                    cells.push(expCol.column.getExportValue({
+                        column: expCol.column,
+                        columnId: expCol.columnId,
+                        visibleIndex: visibleIndex,
+                        sourceIndex: sourceIndex,
+                        item: item,
+                        values: values,
+                        value: rawValue,
+                    }));
+                }
+                else {
+                    cells.push(rawValue);
+                }
+            }
+        }
+        catch (e_3_1) { e_3 = { error: e_3_1 }; }
+        finally {
+            try {
+                if (exportColumns_1_1 && !exportColumns_1_1.done && (_a = exportColumns_1.return)) _a.call(exportColumns_1);
+            }
+            finally { if (e_3) throw e_3.error; }
+        }
+        return cells;
+    };
+    var resolveRowKey = function (item, values) {
+        var rowKey;
+        if (params.rowKey !== undefined && values) {
+            var rawKey = (0, getCellValue_1.getCellValueByRowKey)(params.rowKey, values);
+            if (rawKey !== undefined && rawKey !== null) {
+                rowKey = rawKey;
+            }
+        }
+        if (rowKey === undefined && (item === null || item === void 0 ? void 0 : item.key) !== undefined) {
+            rowKey = item.key;
+        }
+        return rowKey;
+    };
+    if (rowScope === 'displayed') {
+        var displayData = params.data;
+        for (var visibleIndex = 0; visibleIndex < displayData.length; visibleIndex++) {
+            var item = (_c = displayData[visibleIndex]) !== null && _c !== void 0 ? _c : { values: {} };
+            var sourceIndex = (_e = (_d = params.sourceIndexByVisibleIndex) === null || _d === void 0 ? void 0 : _d[visibleIndex]) !== null && _e !== void 0 ? _e : visibleIndex;
+            var values = (_f = item.values) !== null && _f !== void 0 ? _f : {};
+            var rowKey = resolveRowKey(item, values);
+            var cells = buildCells(item, values, sourceIndex, visibleIndex);
+            rows.push({
+                visibleIndex: visibleIndex,
+                sourceIndex: sourceIndex,
+                rowKey: rowKey,
+                item: item,
+                values: values,
+                cells: cells,
+            });
+        }
+    }
+    else if (rowScope === 'checked') {
+        var checkedMap = params.checkedIndexesMap;
+        for (var sourceIndex = 0; sourceIndex < sourcePool.length; sourceIndex++) {
+            if (!(checkedMap === null || checkedMap === void 0 ? void 0 : checkedMap.has(sourceIndex)))
+                continue;
+            var item = (_g = sourcePool[sourceIndex]) !== null && _g !== void 0 ? _g : { values: {} };
+            var visibleIndex = (_h = params.visibleIndexBySourceIndex) === null || _h === void 0 ? void 0 : _h.get(sourceIndex);
+            var values = (_j = item.values) !== null && _j !== void 0 ? _j : {};
+            var rowKey = resolveRowKey(item, values);
+            var cells = buildCells(item, values, sourceIndex, visibleIndex);
+            rows.push({
+                visibleIndex: visibleIndex,
+                sourceIndex: sourceIndex,
+                rowKey: rowKey,
+                item: item,
+                values: values,
+                cells: cells,
+            });
+        }
+    }
+    else {
+        // 'source'
+        for (var sourceIndex = 0; sourceIndex < sourcePool.length; sourceIndex++) {
+            var item = (_k = sourcePool[sourceIndex]) !== null && _k !== void 0 ? _k : { values: {} };
+            var visibleIndex = (_l = params.visibleIndexBySourceIndex) === null || _l === void 0 ? void 0 : _l.get(sourceIndex);
+            var values = (_m = item.values) !== null && _m !== void 0 ? _m : {};
+            var rowKey = resolveRowKey(item, values);
+            var cells = buildCells(item, values, sourceIndex, visibleIndex);
+            rows.push({
+                visibleIndex: visibleIndex,
+                sourceIndex: sourceIndex,
+                rowKey: rowKey,
+                item: item,
+                values: values,
+                cells: cells,
+            });
+        }
+    }
+    return rows;
+}
+function createGridExportData(params) {
+    var _a, _b;
+    var columnScope = (_b = (_a = params.options) === null || _a === void 0 ? void 0 : _a.columns) !== null && _b !== void 0 ? _b : 'visible';
+    var columns = resolveExportColumns(params.columns, params.sourceColumns, columnScope);
+    var rows = resolveExportRows(columns, params);
+    return {
+        columns: columns,
+        rows: rows,
+    };
+}